diff --git a/.github/workflows/generate-types.yaml b/.github/workflows/generate-types.yaml index 2f80f553..d0156f08 100644 --- a/.github/workflows/generate-types.yaml +++ b/.github/workflows/generate-types.yaml @@ -61,6 +61,17 @@ uses: actions/setup-node@v2 with: node-version: '18' + + - name: Init bicep-types submodule + run: | + git submodule update --init --recursive + + - name: Build bicep-types + run: | + pushd ./bicep-types/src/bicep-types + npm ci + npm run build + popd - name: Download AWS types run: | diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 00000000..f96ac88e --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "bicep-types"] + path = bicep-types + url = https://github.com/Azure/bicep-types diff --git a/artifacts/bicep/aws/aws.accessanalyzer/default/types.json b/artifacts/bicep/aws/aws.accessanalyzer/default/types.json index 6d4776c1..725f8a99 100644 --- a/artifacts/bicep/aws/aws.accessanalyzer/default/types.json +++ b/artifacts/bicep/aws/aws.accessanalyzer/default/types.json @@ -1 +1,234 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"ArchiveRule","Properties":{"Filter":{"Type":12,"Flags":1},"RuleName":{"Type":4,"Flags":1,"Description":"The archive rule name"}}}},{"2":{"Name":"Filter","Properties":{"Contains":{"Type":13,"Flags":0},"Eq":{"Type":14,"Flags":0},"Exists":{"Type":2,"Flags":0},"Neq":{"Type":15,"Flags":0},"Property":{"Type":4,"Flags":1}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}}}},{"2":{"Name":"UnusedAccessConfiguration","Properties":{"UnusedAccessAge":{"Type":3,"Flags":0,"Description":"The specified access age in days for which to generate findings for unused access. For example, if you specify 90 days, the analyzer will generate findings for IAM entities within the accounts of the selected organization for any access that hasn't been used in 90 or more days since the analyzer's last scan. You can choose a value between 1 and 180 days."}}}},{"3":{"ItemType":9}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.AccessAnalyzer/AnalyzerProperties","Properties":{"AnalyzerConfiguration":{"Type":17,"Flags":0,"Description":"The configuration for the analyzer"},"AnalyzerName":{"Type":4,"Flags":0,"Description":"Analyzer name"},"ArchiveRules":{"Type":18,"Flags":0},"Arn":{"Type":4,"Flags":18,"Description":"Amazon Resource Name (ARN) of the analyzer"},"Tags":{"Type":19,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."},"Type":{"Type":4,"Flags":1,"Description":"The type of the analyzer, must be one of ACCOUNT, ORGANIZATION, ACCOUNT_UNUSED_ACCESS or ORGANIZATION_UNUSED_ACCESS"}}}},{"2":{"Name":"Analyzer_AnalyzerConfiguration","Properties":{"UnusedAccessConfiguration":{"Type":11,"Flags":0}}}},{"3":{"ItemType":8}},{"3":{"ItemType":10}},{"2":{"Name":"AWS.AccessAnalyzer/Analyzer","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":16,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.AccessAnalyzer/Analyzer@default","ScopeType":0,"Body":20}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "ArchiveRule", + "properties": { + "Filter": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + }, + "RuleName": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The archive rule name" + } + } + }, + { + "$type": "ObjectType", + "name": "Filter", + "properties": { + "Contains": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "Eq": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "Exists": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "Neq": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "Property": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + } + } + }, + { + "$type": "ObjectType", + "name": "UnusedAccessConfiguration", + "properties": { + "UnusedAccessAge": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The specified access age in days for which to generate findings for unused access. For example, if you specify 90 days, the analyzer will generate findings for IAM entities within the accounts of the selected organization for any access that hasn't been used in 90 or more days since the analyzer's last scan. You can choose a value between 1 and 180 days." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.AccessAnalyzer/AnalyzerProperties" + }, + { + "$type": "ObjectType", + "name": "Analyzer_AnalyzerConfiguration", + "properties": { + "UnusedAccessConfiguration": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ObjectType", + "name": "AWS.AccessAnalyzer/AnalyzerProperties", + "properties": { + "AnalyzerConfiguration": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "The configuration for the analyzer" + }, + "AnalyzerName": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "Analyzer name" + }, + "ArchiveRules": { + "type": { + "$ref": "#/13" + }, + "flags": 0 + }, + "Arn": { + "type": { + "$ref": "#/5" + }, + "flags": 18, + "description": "Amazon Resource Name (ARN) of the analyzer" + }, + "Tags": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + }, + "Type": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The type of the analyzer, must be one of ACCOUNT, ORGANIZATION, ACCOUNT_UNUSED_ACCESS or ORGANIZATION_UNUSED_ACCESS" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.AccessAnalyzer/Analyzer", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/15" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.AccessAnalyzer/Analyzer@default", + "scopeType": 0, + "body": { + "$ref": "#/16" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.accessanalyzer/default/types.md b/artifacts/bicep/aws/aws.accessanalyzer/default/types.md index e6bd611e..c23b9b09 100644 --- a/artifacts/bicep/aws/aws.accessanalyzer/default/types.md +++ b/artifacts/bicep/aws/aws.accessanalyzer/default/types.md @@ -3,32 +3,28 @@ ## Resource AWS.AccessAnalyzer/Analyzer@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.AccessAnalyzer/AnalyzerProperties](#awsaccessanalyzeranalyzerproperties) (Required): properties of the resource - -## AWS.AccessAnalyzer/AnalyzerProperties -### Properties -* **AnalyzerConfiguration**: [Analyzer_AnalyzerConfiguration](#analyzeranalyzerconfiguration): The configuration for the analyzer -* **AnalyzerName**: string: Analyzer name -* **ArchiveRules**: [ArchiveRule](#archiverule)[] -* **Arn**: string (ReadOnly, Identifier): Amazon Resource Name (ARN) of the analyzer -* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. -* **Type**: string (Required): The type of the analyzer, must be one of ACCOUNT, ORGANIZATION, ACCOUNT_UNUSED_ACCESS or ORGANIZATION_UNUSED_ACCESS +* **properties**: [AWS.AccessAnalyzer/AnalyzerProperties](#awsaccessanalyzeranalyzerproperties) (Required, Identifier): properties of the resource ## Analyzer_AnalyzerConfiguration ### Properties * **UnusedAccessConfiguration**: [UnusedAccessConfiguration](#unusedaccessconfiguration) -## UnusedAccessConfiguration -### Properties -* **UnusedAccessAge**: int: The specified access age in days for which to generate findings for unused access. For example, if you specify 90 days, the analyzer will generate findings for IAM entities within the accounts of the selected organization for any access that hasn't been used in 90 or more days since the analyzer's last scan. You can choose a value between 1 and 180 days. - ## ArchiveRule ### Properties * **Filter**: [Filter](#filter)[] (Required) * **RuleName**: string (Required): The archive rule name +## AWS.AccessAnalyzer/AnalyzerProperties +### Properties +* **AnalyzerConfiguration**: [Analyzer_AnalyzerConfiguration](#analyzeranalyzerconfiguration): The configuration for the analyzer +* **AnalyzerName**: string: Analyzer name +* **ArchiveRules**: [ArchiveRule](#archiverule)[] +* **Arn**: string (ReadOnly, Identifier): Amazon Resource Name (ARN) of the analyzer +* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. +* **Type**: string (Required): The type of the analyzer, must be one of ACCOUNT, ORGANIZATION, ACCOUNT_UNUSED_ACCESS or ORGANIZATION_UNUSED_ACCESS + ## Filter ### Properties * **Contains**: string[] @@ -42,3 +38,7 @@ * **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. * **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +## UnusedAccessConfiguration +### Properties +* **UnusedAccessAge**: int: The specified access age in days for which to generate findings for unused access. For example, if you specify 90 days, the analyzer will generate findings for IAM entities within the accounts of the selected organization for any access that hasn't been used in 90 or more days since the analyzer's last scan. You can choose a value between 1 and 180 days. + diff --git a/artifacts/bicep/aws/aws.acmpca/default/types.json b/artifacts/bicep/aws/aws.acmpca/default/types.json index 08e92bf6..725f57df 100644 --- a/artifacts/bicep/aws/aws.acmpca/default/types.json +++ b/artifacts/bicep/aws/aws.acmpca/default/types.json @@ -1 +1,715 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"ApiPassthrough","Properties":{"Extensions":{"Type":20,"Flags":0},"Subject":{"Type":31,"Flags":0}}}},{"2":{"Name":"Arn"}},{"2":{"Name":"CertificatePolicyList"}},{"2":{"Name":"CustomAttribute","Properties":{"ObjectIdentifier":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"CustomAttributeList"}},{"2":{"Name":"CustomExtension","Properties":{"Critical":{"Type":2,"Flags":0},"ObjectIdentifier":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"CustomExtensionList"}},{"2":{"Name":"CustomObjectIdentifier"}},{"2":{"Name":"DnsName"}},{"2":{"Name":"EdiPartyName","Properties":{"NameAssigner":{"Type":4,"Flags":1},"PartyName":{"Type":4,"Flags":1}}}},{"2":{"Name":"ExtendedKeyUsage","Properties":{"ExtendedKeyUsageObjectIdentifier":{"Type":4,"Flags":0},"ExtendedKeyUsageType":{"Type":4,"Flags":0}}}},{"2":{"Name":"ExtendedKeyUsageList"}},{"2":{"Name":"Extensions","Properties":{"CertificatePolicies":{"Type":38,"Flags":0},"CustomExtensions":{"Type":39,"Flags":0},"ExtendedKeyUsage":{"Type":40,"Flags":0},"KeyUsage":{"Type":24,"Flags":0},"SubjectAlternativeNames":{"Type":41,"Flags":0}}}},{"2":{"Name":"GeneralName","Properties":{"DirectoryName":{"Type":31,"Flags":0},"DnsName":{"Type":4,"Flags":0},"EdiPartyName":{"Type":17,"Flags":0},"IpAddress":{"Type":4,"Flags":0},"OtherName":{"Type":25,"Flags":0},"RegisteredId":{"Type":4,"Flags":0},"Rfc822Name":{"Type":4,"Flags":0},"UniformResourceIdentifier":{"Type":4,"Flags":0}}}},{"2":{"Name":"GeneralNameList"}},{"2":{"Name":"IpAddress"}},{"2":{"Name":"KeyUsage","Properties":{"CRLSign":{"Type":2,"Flags":0},"DataEncipherment":{"Type":2,"Flags":0},"DecipherOnly":{"Type":2,"Flags":0},"DigitalSignature":{"Type":2,"Flags":0},"EncipherOnly":{"Type":2,"Flags":0},"KeyAgreement":{"Type":2,"Flags":0},"KeyCertSign":{"Type":2,"Flags":0},"KeyEncipherment":{"Type":2,"Flags":0},"NonRepudiation":{"Type":2,"Flags":0}}}},{"2":{"Name":"OtherName","Properties":{"TypeId":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"PolicyInformation","Properties":{"CertPolicyId":{"Type":4,"Flags":1},"PolicyQualifiers":{"Type":43,"Flags":0}}}},{"2":{"Name":"PolicyQualifierInfo","Properties":{"PolicyQualifierId":{"Type":4,"Flags":1},"Qualifier":{"Type":29,"Flags":1}}}},{"2":{"Name":"PolicyQualifierInfoList"}},{"2":{"Name":"Qualifier","Properties":{"CpsUri":{"Type":4,"Flags":1}}}},{"2":{"Name":"Rfc822Name"}},{"2":{"Name":"Subject","Properties":{"CommonName":{"Type":4,"Flags":0},"Country":{"Type":4,"Flags":0},"CustomAttributes":{"Type":45,"Flags":0},"DistinguishedNameQualifier":{"Type":4,"Flags":0},"GenerationQualifier":{"Type":4,"Flags":0},"GivenName":{"Type":4,"Flags":0},"Initials":{"Type":4,"Flags":0},"Locality":{"Type":4,"Flags":0},"Organization":{"Type":4,"Flags":0},"OrganizationalUnit":{"Type":4,"Flags":0},"Pseudonym":{"Type":4,"Flags":0},"SerialNumber":{"Type":4,"Flags":0},"State":{"Type":4,"Flags":0},"Surname":{"Type":4,"Flags":0},"Title":{"Type":4,"Flags":0}}}},{"2":{"Name":"UniformResourceIdentifier"}},{"2":{"Name":"Validity","Properties":{"Type":{"Type":4,"Flags":1},"Value":{"Type":3,"Flags":1}}}},{"3":{"ItemType":26}},{"3":{"ItemType":11}},{"3":{"ItemType":13}},{"3":{"ItemType":18}},{"3":{"ItemType":26}},{"3":{"ItemType":13}},{"3":{"ItemType":18}},{"3":{"ItemType":21}},{"3":{"ItemType":21}},{"3":{"ItemType":27}},{"3":{"ItemType":27}},{"3":{"ItemType":11}},{"2":{"Name":"AWS.ACMPCA/CertificateProperties","Properties":{"ApiPassthrough":{"Type":8,"Flags":4,"Description":"These are fields to be overridden in a certificate at the time of issuance. These requires an API_Passthrough template be used or they will be ignored."},"Arn":{"Type":4,"Flags":18,"Description":"The ARN of the issued certificate."},"Certificate":{"Type":4,"Flags":2,"Description":"The issued certificate in base 64 PEM-encoded format."},"CertificateAuthorityArn":{"Type":4,"Flags":17,"Description":"The Amazon Resource Name (ARN) for the private CA to issue the certificate."},"CertificateSigningRequest":{"Type":4,"Flags":5,"Description":"The certificate signing request (CSR) for the Certificate."},"SigningAlgorithm":{"Type":4,"Flags":1,"Description":"The name of the algorithm that will be used to sign the Certificate."},"TemplateArn":{"Type":4,"Flags":0,"Description":"Specifies a custom configuration template to use when issuing a certificate. If this parameter is not provided, ACM Private CA defaults to the EndEntityCertificate/V1 template."},"Validity":{"Type":33,"Flags":1,"Description":"The time before which the Certificate will be valid."},"ValidityNotBefore":{"Type":33,"Flags":0,"Description":"The time after which the Certificate will be valid."}}}},{"2":{"Name":"AWS.ACMPCA/Certificate","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":46,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ACMPCA/Certificate@default","ScopeType":0,"Body":47}},{"2":{"Name":"AccessDescription","Properties":{"AccessLocation":{"Type":60,"Flags":1},"AccessMethod":{"Type":50,"Flags":1}}}},{"2":{"Name":"AccessMethod","Properties":{"AccessMethodType":{"Type":4,"Flags":0},"CustomObjectIdentifier":{"Type":4,"Flags":0}}}},{"2":{"Name":"AccessMethodType"}},{"2":{"Name":"Arn"}},{"2":{"Name":"CrlConfiguration","Properties":{"CustomCname":{"Type":4,"Flags":0},"Enabled":{"Type":2,"Flags":0},"ExpirationInDays":{"Type":3,"Flags":0},"S3BucketName":{"Type":4,"Flags":0},"S3ObjectAcl":{"Type":4,"Flags":0}}}},{"2":{"Name":"CsrExtensions","Properties":{"KeyUsage":{"Type":62,"Flags":0},"SubjectInformationAccess":{"Type":71,"Flags":0}}}},{"2":{"Name":"CustomAttribute","Properties":{"ObjectIdentifier":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"CustomAttributeList"}},{"2":{"Name":"CustomObjectIdentifier"}},{"2":{"Name":"DnsName"}},{"2":{"Name":"EdiPartyName","Properties":{"NameAssigner":{"Type":4,"Flags":1},"PartyName":{"Type":4,"Flags":1}}}},{"2":{"Name":"GeneralName","Properties":{"DirectoryName":{"Type":67,"Flags":0},"DnsName":{"Type":4,"Flags":0},"EdiPartyName":{"Type":59,"Flags":0},"IpAddress":{"Type":4,"Flags":0},"OtherName":{"Type":64,"Flags":0},"RegisteredId":{"Type":4,"Flags":0},"Rfc822Name":{"Type":4,"Flags":0},"UniformResourceIdentifier":{"Type":4,"Flags":0}}}},{"2":{"Name":"IpAddress"}},{"2":{"Name":"KeyUsage","Properties":{"CRLSign":{"Type":2,"Flags":0},"DataEncipherment":{"Type":2,"Flags":0},"DecipherOnly":{"Type":2,"Flags":0},"DigitalSignature":{"Type":2,"Flags":0},"EncipherOnly":{"Type":2,"Flags":0},"KeyAgreement":{"Type":2,"Flags":0},"KeyCertSign":{"Type":2,"Flags":0},"KeyEncipherment":{"Type":2,"Flags":0},"NonRepudiation":{"Type":2,"Flags":0}}}},{"2":{"Name":"OcspConfiguration","Properties":{"Enabled":{"Type":2,"Flags":0},"OcspCustomCname":{"Type":4,"Flags":0}}}},{"2":{"Name":"OtherName","Properties":{"TypeId":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"RevocationConfiguration","Properties":{"CrlConfiguration":{"Type":53,"Flags":0},"OcspConfiguration":{"Type":63,"Flags":0}}}},{"2":{"Name":"Rfc822Name"}},{"2":{"Name":"Subject","Properties":{"CommonName":{"Type":4,"Flags":0},"Country":{"Type":4,"Flags":0},"CustomAttributes":{"Type":73,"Flags":0},"DistinguishedNameQualifier":{"Type":4,"Flags":0},"GenerationQualifier":{"Type":4,"Flags":0},"GivenName":{"Type":4,"Flags":0},"Initials":{"Type":4,"Flags":0},"Locality":{"Type":4,"Flags":0},"Organization":{"Type":4,"Flags":0},"OrganizationalUnit":{"Type":4,"Flags":0},"Pseudonym":{"Type":4,"Flags":0},"SerialNumber":{"Type":4,"Flags":0},"State":{"Type":4,"Flags":0},"Surname":{"Type":4,"Flags":0},"Title":{"Type":4,"Flags":0}}}},{"2":{"Name":"SubjectInformationAccess"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":0},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"UniformResourceIdentifier"}},{"3":{"ItemType":49}},{"3":{"ItemType":55}},{"3":{"ItemType":55}},{"3":{"ItemType":49}},{"2":{"Name":"AWS.ACMPCA/CertificateAuthorityProperties","Properties":{"Arn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN) of the certificate authority."},"CertificateSigningRequest":{"Type":4,"Flags":2,"Description":"The base64 PEM-encoded certificate signing request (CSR) for your certificate authority certificate."},"CsrExtensions":{"Type":54,"Flags":0,"Description":"Structure that contains CSR pass through extension information used by the CreateCertificateAuthority action."},"KeyAlgorithm":{"Type":4,"Flags":1,"Description":"Public key algorithm and size, in bits, of the key pair that your CA creates when it issues a certificate."},"KeyStorageSecurityStandard":{"Type":4,"Flags":0,"Description":"KeyStorageSecurityStadard defines a cryptographic key management compliance standard used for handling CA keys."},"RevocationConfiguration":{"Type":65,"Flags":0,"Description":"Certificate revocation information used by the CreateCertificateAuthority and UpdateCertificateAuthority actions."},"SigningAlgorithm":{"Type":4,"Flags":1,"Description":"Algorithm your CA uses to sign certificate requests."},"Subject":{"Type":67,"Flags":5,"Description":"Structure that contains X.500 distinguished name information for your CA."},"Tags":{"Type":76,"Flags":0},"Type":{"Type":4,"Flags":1,"Description":"The type of the certificate authority."},"UsageMode":{"Type":4,"Flags":0,"Description":"Usage mode of the ceritificate authority."}}}},{"3":{"ItemType":69}},{"2":{"Name":"AWS.ACMPCA/CertificateAuthority","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":75,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ACMPCA/CertificateAuthority@default","ScopeType":0,"Body":77}},{"2":{"Name":"AWS.ACMPCA/CertificateAuthorityActivationProperties","Properties":{"Certificate":{"Type":4,"Flags":5,"Description":"Certificate Authority certificate that will be installed in the Certificate Authority."},"CertificateAuthorityArn":{"Type":4,"Flags":17,"Description":"Arn of the Certificate Authority."},"CertificateChain":{"Type":4,"Flags":4,"Description":"Certificate chain for the Certificate Authority certificate."},"CompleteCertificateChain":{"Type":4,"Flags":2,"Description":"The complete certificate chain, including the Certificate Authority certificate."},"Status":{"Type":4,"Flags":0,"Description":"The status of the Certificate Authority."}}}},{"2":{"Name":"AWS.ACMPCA/CertificateAuthorityActivation","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":79,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ACMPCA/CertificateAuthorityActivation@default","ScopeType":0,"Body":80}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "AccessDescription", + "properties": { + "AccessLocation": { + "type": { + "$ref": "#/12" + }, + "flags": 1 + }, + "AccessMethod": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AccessMethod", + "properties": { + "AccessMethodType": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "CustomObjectIdentifier": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AccessMethodType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Arn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CrlConfiguration", + "properties": { + "CrlDistributionPointExtensionConfiguration": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "CustomCname": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "Enabled": { + "type": { + "$ref": "#/24" + }, + "flags": 1 + }, + "ExpirationInDays": { + "type": { + "$ref": "#/25" + }, + "flags": 0 + }, + "S3BucketName": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "S3ObjectAcl": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CrlDistributionPointExtensionConfiguration", + "properties": { + "OmitExtension": { + "type": { + "$ref": "#/24" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CsrExtensions", + "properties": { + "KeyUsage": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + }, + "SubjectInformationAccess": { + "type": { + "$ref": "#/26" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomAttribute", + "properties": { + "ObjectIdentifier": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomAttributeList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CustomObjectIdentifier", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DnsName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "EdiPartyName", + "properties": { + "NameAssigner": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "PartyName": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "GeneralName", + "properties": { + "DirectoryName": { + "type": { + "$ref": "#/19" + }, + "flags": 0 + }, + "DnsName": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "EdiPartyName": { + "type": { + "$ref": "#/11" + }, + "flags": 0 + }, + "IpAddress": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "OtherName": { + "type": { + "$ref": "#/16" + }, + "flags": 0 + }, + "RegisteredId": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "Rfc822Name": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "UniformResourceIdentifier": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "IpAddress", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "KeyUsage", + "properties": { + "CRLSign": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "DataEncipherment": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "DecipherOnly": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "DigitalSignature": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "EncipherOnly": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "KeyAgreement": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "KeyCertSign": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "KeyEncipherment": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "NonRepudiation": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "OcspConfiguration", + "properties": { + "Enabled": { + "type": { + "$ref": "#/24" + }, + "flags": 1 + }, + "OcspCustomCname": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "OtherName", + "properties": { + "TypeId": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "RevocationConfiguration", + "properties": { + "CrlConfiguration": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "OcspConfiguration": { + "type": { + "$ref": "#/15" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Rfc822Name", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Subject", + "properties": { + "CommonName": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "Country": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "CustomAttributes": { + "type": { + "$ref": "#/28" + }, + "flags": 0 + }, + "DistinguishedNameQualifier": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "GenerationQualifier": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "GivenName": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "Initials": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "Locality": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "Organization": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "OrganizationalUnit": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "Pseudonym": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "SerialNumber": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "State": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "Surname": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SubjectInformationAccess", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "UniformResourceIdentifier", + "properties": {} + }, + { + "$type": "StringType" + }, + { + "$type": "BooleanType" + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/7" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/7" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.ACMPCA/CertificateAuthorityProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/21" + } + }, + { + "$type": "ObjectType", + "name": "AWS.ACMPCA/CertificateAuthorityProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/23" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) of the certificate authority." + }, + "CertificateSigningRequest": { + "type": { + "$ref": "#/23" + }, + "flags": 2, + "description": "The base64 PEM-encoded certificate signing request (CSR) for your certificate authority certificate." + }, + "CsrExtensions": { + "type": { + "$ref": "#/6" + }, + "flags": 4, + "description": "Structure that contains CSR pass through extension information used by the CreateCertificateAuthority action." + }, + "KeyAlgorithm": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "Public key algorithm and size, in bits, of the key pair that your CA creates when it issues a certificate." + }, + "KeyStorageSecurityStandard": { + "type": { + "$ref": "#/23" + }, + "flags": 4, + "description": "KeyStorageSecurityStadard defines a cryptographic key management compliance standard used for handling CA keys." + }, + "RevocationConfiguration": { + "type": { + "$ref": "#/17" + }, + "flags": 4, + "description": "Certificate revocation information used by the CreateCertificateAuthority and UpdateCertificateAuthority actions." + }, + "SigningAlgorithm": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "Algorithm your CA uses to sign certificate requests." + }, + "Subject": { + "type": { + "$ref": "#/19" + }, + "flags": 5, + "description": "Structure that contains X.500 distinguished name information for your CA." + }, + "Tags": { + "type": { + "$ref": "#/31" + }, + "flags": 4 + }, + "Type": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "The type of the certificate authority." + }, + "UsageMode": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "Usage mode of the ceritificate authority." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ACMPCA/CertificateAuthority", + "properties": { + "name": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/23" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/32" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ACMPCA/CertificateAuthority@default", + "scopeType": 0, + "body": { + "$ref": "#/33" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.ACMPCA/CertificateAuthorityActivationProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.ACMPCA/CertificateAuthorityActivationProperties", + "properties": { + "Certificate": { + "type": { + "$ref": "#/23" + }, + "flags": 5, + "description": "Certificate Authority certificate that will be installed in the Certificate Authority." + }, + "CertificateAuthorityArn": { + "type": { + "$ref": "#/23" + }, + "flags": 17, + "description": "Arn of the Certificate Authority." + }, + "CertificateChain": { + "type": { + "$ref": "#/23" + }, + "flags": 4, + "description": "Certificate chain for the Certificate Authority certificate." + }, + "CompleteCertificateChain": { + "type": { + "$ref": "#/23" + }, + "flags": 2, + "description": "The complete certificate chain, including the Certificate Authority certificate." + }, + "Status": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "The status of the Certificate Authority." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ACMPCA/CertificateAuthorityActivation", + "properties": { + "name": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/23" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/36" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ACMPCA/CertificateAuthorityActivation@default", + "scopeType": 0, + "body": { + "$ref": "#/37" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.acmpca/default/types.md b/artifacts/bicep/aws/aws.acmpca/default/types.md index aa19376e..e02463d4 100644 --- a/artifacts/bicep/aws/aws.acmpca/default/types.md +++ b/artifacts/bicep/aws/aws.acmpca/default/types.md @@ -1,87 +1,78 @@ # AWS.ACMPCA @ default -## Resource AWS.ACMPCA/Certificate@default -* **Valid Scope(s)**: Unknown -### Properties -* **alias**: string (Required): the resource alias -* **name**: string: the resource name -* **properties**: [AWS.ACMPCA/CertificateProperties](#awsacmpcacertificateproperties) (Required): properties of the resource - ## Resource AWS.ACMPCA/CertificateAuthority@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ACMPCA/CertificateAuthorityProperties](#awsacmpcacertificateauthorityproperties) (Required): properties of the resource +* **properties**: [AWS.ACMPCA/CertificateAuthorityProperties](#awsacmpcacertificateauthorityproperties) (Required, Identifier): properties of the resource ## Resource AWS.ACMPCA/CertificateAuthorityActivation@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ACMPCA/CertificateAuthorityActivationProperties](#awsacmpcacertificateauthorityactivationproperties) (Required): properties of the resource +* **properties**: [AWS.ACMPCA/CertificateAuthorityActivationProperties](#awsacmpcacertificateauthorityactivationproperties) (Required, Identifier): properties of the resource -## AWS.ACMPCA/CertificateProperties +## AccessDescription ### Properties -* **ApiPassthrough**: [ApiPassthrough](#apipassthrough) (WriteOnly): These are fields to be overridden in a certificate at the time of issuance. These requires an API_Passthrough template be used or they will be ignored. -* **Arn**: string (ReadOnly, Identifier): The ARN of the issued certificate. -* **Certificate**: string (ReadOnly): The issued certificate in base 64 PEM-encoded format. -* **CertificateAuthorityArn**: string (Required, Identifier): The Amazon Resource Name (ARN) for the private CA to issue the certificate. -* **CertificateSigningRequest**: string (Required, WriteOnly): The certificate signing request (CSR) for the Certificate. -* **SigningAlgorithm**: string (Required): The name of the algorithm that will be used to sign the Certificate. -* **TemplateArn**: string: Specifies a custom configuration template to use when issuing a certificate. If this parameter is not provided, ACM Private CA defaults to the EndEntityCertificate/V1 template. -* **Validity**: [Validity](#validity) (Required): The time before which the Certificate will be valid. -* **ValidityNotBefore**: [Validity](#validity): The time after which the Certificate will be valid. +* **AccessLocation**: [GeneralName](#generalname) (Required) +* **AccessMethod**: [AccessMethod](#accessmethod) (Required) -## ApiPassthrough +## AccessMethod ### Properties -* **Extensions**: [Extensions](#extensions) -* **Subject**: [Subject](#subject) +* **AccessMethodType**: string +* **CustomObjectIdentifier**: string -## Extensions +## AWS.ACMPCA/CertificateAuthorityActivationProperties ### Properties -* **CertificatePolicies**: [PolicyInformation](#policyinformation)[] -* **CustomExtensions**: [CustomExtension](#customextension)[] -* **ExtendedKeyUsage**: [ExtendedKeyUsage](#extendedkeyusage)[] -* **KeyUsage**: [KeyUsage](#keyusage) -* **SubjectAlternativeNames**: [GeneralName](#generalname)[] +* **Certificate**: string (Required, WriteOnly): Certificate Authority certificate that will be installed in the Certificate Authority. +* **CertificateAuthorityArn**: string (Required, Identifier): Arn of the Certificate Authority. +* **CertificateChain**: string (WriteOnly): Certificate chain for the Certificate Authority certificate. +* **CompleteCertificateChain**: string (ReadOnly): The complete certificate chain, including the Certificate Authority certificate. +* **Status**: string: The status of the Certificate Authority. -## PolicyInformation +## AWS.ACMPCA/CertificateAuthorityProperties ### Properties -* **CertPolicyId**: string (Required) -* **PolicyQualifiers**: [PolicyQualifierInfo](#policyqualifierinfo)[] +* **Arn**: string (ReadOnly, Identifier): The Amazon Resource Name (ARN) of the certificate authority. +* **CertificateSigningRequest**: string (ReadOnly): The base64 PEM-encoded certificate signing request (CSR) for your certificate authority certificate. +* **CsrExtensions**: [CsrExtensions](#csrextensions) (WriteOnly): Structure that contains CSR pass through extension information used by the CreateCertificateAuthority action. +* **KeyAlgorithm**: string (Required): Public key algorithm and size, in bits, of the key pair that your CA creates when it issues a certificate. +* **KeyStorageSecurityStandard**: string (WriteOnly): KeyStorageSecurityStadard defines a cryptographic key management compliance standard used for handling CA keys. +* **RevocationConfiguration**: [RevocationConfiguration](#revocationconfiguration) (WriteOnly): Certificate revocation information used by the CreateCertificateAuthority and UpdateCertificateAuthority actions. +* **SigningAlgorithm**: string (Required): Algorithm your CA uses to sign certificate requests. +* **Subject**: [Subject](#subject) (Required, WriteOnly): Structure that contains X.500 distinguished name information for your CA. +* **Tags**: [Tag](#tag)[] (WriteOnly) +* **Type**: string (Required): The type of the certificate authority. +* **UsageMode**: string: Usage mode of the ceritificate authority. + +## CrlConfiguration +### Properties +* **CrlDistributionPointExtensionConfiguration**: [CrlDistributionPointExtensionConfiguration](#crldistributionpointextensionconfiguration) +* **CustomCname**: string +* **Enabled**: bool (Required) +* **ExpirationInDays**: int +* **S3BucketName**: string +* **S3ObjectAcl**: string -## PolicyQualifierInfo +## CrlDistributionPointExtensionConfiguration ### Properties -* **PolicyQualifierId**: string (Required) -* **Qualifier**: [Qualifier](#qualifier) (Required) +* **OmitExtension**: bool (Required) -## Qualifier +## CsrExtensions ### Properties -* **CpsUri**: string (Required) +* **KeyUsage**: [KeyUsage](#keyusage) +* **SubjectInformationAccess**: [AccessDescription](#accessdescription)[] -## CustomExtension +## CustomAttribute ### Properties -* **Critical**: bool * **ObjectIdentifier**: string (Required) * **Value**: string (Required) -## ExtendedKeyUsage -### Properties -* **ExtendedKeyUsageObjectIdentifier**: string -* **ExtendedKeyUsageType**: string - -## KeyUsage +## EdiPartyName ### Properties -* **CRLSign**: bool -* **DataEncipherment**: bool -* **DecipherOnly**: bool -* **DigitalSignature**: bool -* **EncipherOnly**: bool -* **KeyAgreement**: bool -* **KeyCertSign**: bool -* **KeyEncipherment**: bool -* **NonRepudiation**: bool +* **NameAssigner**: string +* **PartyName**: string (Required) ## GeneralName ### Properties @@ -94,63 +85,6 @@ * **Rfc822Name**: string * **UniformResourceIdentifier**: string -## Subject -### Properties -* **CommonName**: string -* **Country**: string -* **CustomAttributes**: [CustomAttribute](#customattribute)[] -* **DistinguishedNameQualifier**: string -* **GenerationQualifier**: string -* **GivenName**: string -* **Initials**: string -* **Locality**: string -* **Organization**: string -* **OrganizationalUnit**: string -* **Pseudonym**: string -* **SerialNumber**: string -* **State**: string -* **Surname**: string -* **Title**: string - -## CustomAttribute -### Properties -* **ObjectIdentifier**: string (Required) -* **Value**: string (Required) - -## EdiPartyName -### Properties -* **NameAssigner**: string (Required) -* **PartyName**: string (Required) - -## OtherName -### Properties -* **TypeId**: string (Required) -* **Value**: string (Required) - -## Validity -### Properties -* **Type**: string (Required) -* **Value**: int (Required) - -## AWS.ACMPCA/CertificateAuthorityProperties -### Properties -* **Arn**: string (ReadOnly, Identifier): The Amazon Resource Name (ARN) of the certificate authority. -* **CertificateSigningRequest**: string (ReadOnly): The base64 PEM-encoded certificate signing request (CSR) for your certificate authority certificate. -* **CsrExtensions**: [CsrExtensions](#csrextensions): Structure that contains CSR pass through extension information used by the CreateCertificateAuthority action. -* **KeyAlgorithm**: string (Required): Public key algorithm and size, in bits, of the key pair that your CA creates when it issues a certificate. -* **KeyStorageSecurityStandard**: string: KeyStorageSecurityStadard defines a cryptographic key management compliance standard used for handling CA keys. -* **RevocationConfiguration**: [RevocationConfiguration](#revocationconfiguration): Certificate revocation information used by the CreateCertificateAuthority and UpdateCertificateAuthority actions. -* **SigningAlgorithm**: string (Required): Algorithm your CA uses to sign certificate requests. -* **Subject**: [Subject](#subject) (Required, WriteOnly): Structure that contains X.500 distinguished name information for your CA. -* **Tags**: [Tag](#tag)[] -* **Type**: string (Required): The type of the certificate authority. -* **UsageMode**: string: Usage mode of the ceritificate authority. - -## CsrExtensions -### Properties -* **KeyUsage**: [KeyUsage](#keyusage) -* **SubjectInformationAccess**: [AccessDescription](#accessdescription)[] - ## KeyUsage ### Properties * **CRLSign**: bool @@ -163,21 +97,20 @@ * **KeyEncipherment**: bool * **NonRepudiation**: bool -## AccessDescription +## OcspConfiguration ### Properties -* **AccessLocation**: [GeneralName](#generalname) (Required) -* **AccessMethod**: [AccessMethod](#accessmethod) (Required) +* **Enabled**: bool (Required) +* **OcspCustomCname**: string -## GeneralName +## OtherName ### Properties -* **DirectoryName**: [Subject](#subject) -* **DnsName**: string -* **EdiPartyName**: [EdiPartyName](#edipartyname) -* **IpAddress**: string -* **OtherName**: [OtherName](#othername) -* **RegisteredId**: string -* **Rfc822Name**: string -* **UniformResourceIdentifier**: string +* **TypeId**: string (Required) +* **Value**: string (Required) + +## RevocationConfiguration +### Properties +* **CrlConfiguration**: [CrlConfiguration](#crlconfiguration) +* **OcspConfiguration**: [OcspConfiguration](#ocspconfiguration) ## Subject ### Properties @@ -197,54 +130,8 @@ * **Surname**: string * **Title**: string -## CustomAttribute -### Properties -* **ObjectIdentifier**: string (Required) -* **Value**: string (Required) - -## EdiPartyName -### Properties -* **NameAssigner**: string (Required) -* **PartyName**: string (Required) - -## OtherName -### Properties -* **TypeId**: string (Required) -* **Value**: string (Required) - -## AccessMethod -### Properties -* **AccessMethodType**: string -* **CustomObjectIdentifier**: string - -## RevocationConfiguration -### Properties -* **CrlConfiguration**: [CrlConfiguration](#crlconfiguration) -* **OcspConfiguration**: [OcspConfiguration](#ocspconfiguration) - -## CrlConfiguration -### Properties -* **CustomCname**: string -* **Enabled**: bool -* **ExpirationInDays**: int -* **S3BucketName**: string -* **S3ObjectAcl**: string - -## OcspConfiguration -### Properties -* **Enabled**: bool -* **OcspCustomCname**: string - ## Tag ### Properties -* **Key**: string +* **Key**: string (Required) * **Value**: string -## AWS.ACMPCA/CertificateAuthorityActivationProperties -### Properties -* **Certificate**: string (Required, WriteOnly): Certificate Authority certificate that will be installed in the Certificate Authority. -* **CertificateAuthorityArn**: string (Required, Identifier): Arn of the Certificate Authority. -* **CertificateChain**: string (WriteOnly): Certificate chain for the Certificate Authority certificate. -* **CompleteCertificateChain**: string (ReadOnly): The complete certificate chain, including the Certificate Authority certificate. -* **Status**: string: The status of the Certificate Authority. - diff --git a/artifacts/bicep/aws/aws.amplify/default/types.json b/artifacts/bicep/aws/aws.amplify/default/types.json index b90db116..0cd1c834 100644 --- a/artifacts/bicep/aws/aws.amplify/default/types.json +++ b/artifacts/bicep/aws/aws.amplify/default/types.json @@ -1 +1,776 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"AutoBranchCreationConfig","Properties":{"AutoBranchCreationPatterns":{"Type":13,"Flags":0},"BasicAuthConfig":{"Type":9,"Flags":0},"BuildSpec":{"Type":4,"Flags":0},"EnableAutoBranchCreation":{"Type":2,"Flags":0},"EnableAutoBuild":{"Type":2,"Flags":0},"EnablePerformanceMode":{"Type":2,"Flags":0},"EnablePullRequestPreview":{"Type":2,"Flags":0},"EnvironmentVariables":{"Type":14,"Flags":0},"Framework":{"Type":4,"Flags":0},"PullRequestEnvironmentName":{"Type":4,"Flags":0},"Stage":{"Type":4,"Flags":0}}}},{"2":{"Name":"BasicAuthConfig","Properties":{"EnableBasicAuth":{"Type":2,"Flags":0},"Password":{"Type":4,"Flags":0},"Username":{"Type":4,"Flags":0}}}},{"2":{"Name":"CustomRule","Properties":{"Condition":{"Type":4,"Flags":0},"Source":{"Type":4,"Flags":1},"Status":{"Type":4,"Flags":0},"Target":{"Type":4,"Flags":1}}}},{"2":{"Name":"EnvironmentVariable","Properties":{"Name":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"3":{"ItemType":4}},{"3":{"ItemType":11}},{"2":{"Name":"AWS.Amplify/AppProperties","Properties":{"AccessToken":{"Type":4,"Flags":4},"AppId":{"Type":4,"Flags":2},"AppName":{"Type":4,"Flags":2},"Arn":{"Type":4,"Flags":18},"AutoBranchCreationConfig":{"Type":8,"Flags":4},"BasicAuthConfig":{"Type":9,"Flags":4},"BuildSpec":{"Type":4,"Flags":0},"CustomHeaders":{"Type":4,"Flags":0},"CustomRules":{"Type":16,"Flags":0},"DefaultDomain":{"Type":4,"Flags":2},"Description":{"Type":4,"Flags":0},"EnableBranchAutoDeletion":{"Type":2,"Flags":0},"EnvironmentVariables":{"Type":17,"Flags":0},"IAMServiceRole":{"Type":4,"Flags":0},"Name":{"Type":4,"Flags":1},"OauthToken":{"Type":4,"Flags":4},"Platform":{"Type":4,"Flags":0},"Repository":{"Type":4,"Flags":0},"Tags":{"Type":18,"Flags":0}}}},{"3":{"ItemType":10}},{"3":{"ItemType":11}},{"3":{"ItemType":12}},{"2":{"Name":"AWS.Amplify/App","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":15,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Amplify/App@default","ScopeType":0,"Body":19}},{"2":{"Name":"Backend","Properties":{"StackArn":{"Type":4,"Flags":0}}}},{"2":{"Name":"BasicAuthConfig","Properties":{"EnableBasicAuth":{"Type":2,"Flags":0},"Password":{"Type":4,"Flags":1},"Username":{"Type":4,"Flags":1}}}},{"2":{"Name":"EnvironmentVariable","Properties":{"Name":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.Amplify/BranchProperties","Properties":{"AppId":{"Type":4,"Flags":1},"Arn":{"Type":4,"Flags":18},"Backend":{"Type":21,"Flags":0},"BasicAuthConfig":{"Type":22,"Flags":4},"BranchName":{"Type":4,"Flags":1},"BuildSpec":{"Type":4,"Flags":0},"Description":{"Type":4,"Flags":0},"EnableAutoBuild":{"Type":2,"Flags":0},"EnablePerformanceMode":{"Type":2,"Flags":0},"EnablePullRequestPreview":{"Type":2,"Flags":0},"EnvironmentVariables":{"Type":26,"Flags":0},"Framework":{"Type":4,"Flags":0},"PullRequestEnvironmentName":{"Type":4,"Flags":0},"Stage":{"Type":4,"Flags":0},"Tags":{"Type":27,"Flags":0}}}},{"3":{"ItemType":23}},{"3":{"ItemType":24}},{"2":{"Name":"AWS.Amplify/Branch","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":25,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Amplify/Branch@default","ScopeType":0,"Body":28}},{"2":{"Name":"SubDomainSetting","Properties":{"BranchName":{"Type":4,"Flags":1},"Prefix":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.Amplify/DomainProperties","Properties":{"AppId":{"Type":4,"Flags":1},"Arn":{"Type":4,"Flags":18},"AutoSubDomainCreationPatterns":{"Type":32,"Flags":0},"AutoSubDomainIAMRole":{"Type":4,"Flags":0},"CertificateRecord":{"Type":4,"Flags":2},"DomainName":{"Type":4,"Flags":1},"DomainStatus":{"Type":4,"Flags":2},"EnableAutoSubDomain":{"Type":2,"Flags":0},"StatusReason":{"Type":4,"Flags":2},"SubDomainSettings":{"Type":33,"Flags":1}}}},{"3":{"ItemType":4}},{"3":{"ItemType":30}},{"2":{"Name":"AWS.Amplify/Domain","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":31,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Amplify/Domain@default","ScopeType":0,"Body":34}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "AutoBranchCreationConfig", + "properties": { + "AutoBranchCreationPatterns": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "BasicAuthConfig": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "BuildSpec": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "EnableAutoBranchCreation": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "EnableAutoBuild": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "EnablePerformanceMode": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "EnablePullRequestPreview": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "EnvironmentVariables": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "Framework": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "PullRequestEnvironmentName": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Stage": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BasicAuthConfig", + "properties": { + "EnableBasicAuth": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "Password": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Username": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomRule", + "properties": { + "Condition": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Source": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Status": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Target": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "EnvironmentVariable", + "properties": { + "Name": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Amplify/AppProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Amplify/AppProperties", + "properties": { + "AccessToken": { + "type": { + "$ref": "#/5" + }, + "flags": 4 + }, + "AppId": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "AppName": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "Arn": { + "type": { + "$ref": "#/5" + }, + "flags": 18 + }, + "AutoBranchCreationConfig": { + "type": { + "$ref": "#/0" + }, + "flags": 4 + }, + "BasicAuthConfig": { + "type": { + "$ref": "#/1" + }, + "flags": 4 + }, + "BuildSpec": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "CustomHeaders": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "CustomRules": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "DefaultDomain": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "Description": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "EnableBranchAutoDeletion": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "EnvironmentVariables": { + "type": { + "$ref": "#/11" + }, + "flags": 0 + }, + "IAMServiceRole": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "OauthToken": { + "type": { + "$ref": "#/5" + }, + "flags": 4 + }, + "Platform": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Repository": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Amplify/App", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/13" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Amplify/App@default", + "scopeType": 0, + "body": { + "$ref": "#/14" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Backend", + "properties": { + "StackArn": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BasicAuthConfig", + "properties": { + "EnableBasicAuth": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "Password": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Username": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "EnvironmentVariable", + "properties": { + "Name": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Amplify/BranchProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/18" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/19" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Amplify/BranchProperties", + "properties": { + "AppId": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Arn": { + "type": { + "$ref": "#/5" + }, + "flags": 18 + }, + "Backend": { + "type": { + "$ref": "#/16" + }, + "flags": 0 + }, + "BasicAuthConfig": { + "type": { + "$ref": "#/17" + }, + "flags": 4 + }, + "BranchName": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "BuildSpec": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Description": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "EnableAutoBuild": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "EnablePerformanceMode": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "EnablePullRequestPreview": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "EnvironmentVariables": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "Framework": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "PullRequestEnvironmentName": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Stage": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/22" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Amplify/Branch", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/23" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Amplify/Branch@default", + "scopeType": 0, + "body": { + "$ref": "#/24" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Certificate", + "properties": { + "CertificateArn": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "CertificateType": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "CertificateVerificationDNSRecord": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CertificateSettings", + "properties": { + "CertificateType": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "CustomCertificateArn": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SubDomainSetting", + "properties": { + "BranchName": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Prefix": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Amplify/DomainProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/28" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Amplify/DomainProperties", + "properties": { + "AppId": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Arn": { + "type": { + "$ref": "#/5" + }, + "flags": 18 + }, + "AutoSubDomainCreationPatterns": { + "type": { + "$ref": "#/30" + }, + "flags": 0 + }, + "AutoSubDomainIAMRole": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Certificate": { + "type": { + "$ref": "#/26" + }, + "flags": 2 + }, + "CertificateRecord": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "CertificateSettings": { + "type": { + "$ref": "#/27" + }, + "flags": 4 + }, + "DomainName": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "DomainStatus": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "EnableAutoSubDomain": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "StatusReason": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "SubDomainSettings": { + "type": { + "$ref": "#/31" + }, + "flags": 1 + }, + "UpdateStatus": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Amplify/Domain", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/32" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Amplify/Domain@default", + "scopeType": 0, + "body": { + "$ref": "#/33" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.amplify/default/types.md b/artifacts/bicep/aws/aws.amplify/default/types.md index b87b8dc2..0552c86d 100644 --- a/artifacts/bicep/aws/aws.amplify/default/types.md +++ b/artifacts/bicep/aws/aws.amplify/default/types.md @@ -3,23 +3,37 @@ ## Resource AWS.Amplify/App@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Amplify/AppProperties](#awsamplifyappproperties) (Required): properties of the resource +* **properties**: [AWS.Amplify/AppProperties](#awsamplifyappproperties) (Required, Identifier): properties of the resource ## Resource AWS.Amplify/Branch@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Amplify/BranchProperties](#awsamplifybranchproperties) (Required): properties of the resource +* **properties**: [AWS.Amplify/BranchProperties](#awsamplifybranchproperties) (Required, Identifier): properties of the resource ## Resource AWS.Amplify/Domain@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Amplify/DomainProperties](#awsamplifydomainproperties) (Required): properties of the resource +* **properties**: [AWS.Amplify/DomainProperties](#awsamplifydomainproperties) (Required, Identifier): properties of the resource + +## AutoBranchCreationConfig +### Properties +* **AutoBranchCreationPatterns**: string[] +* **BasicAuthConfig**: [BasicAuthConfig](#basicauthconfig) +* **BuildSpec**: string +* **EnableAutoBranchCreation**: bool +* **EnableAutoBuild**: bool +* **EnablePerformanceMode**: bool +* **EnablePullRequestPreview**: bool +* **EnvironmentVariables**: [EnvironmentVariable](#environmentvariable)[] +* **Framework**: string +* **PullRequestEnvironmentName**: string +* **Stage**: string ## AWS.Amplify/AppProperties ### Properties @@ -43,43 +57,6 @@ * **Repository**: string * **Tags**: [Tag](#tag)[] -## AutoBranchCreationConfig -### Properties -* **AutoBranchCreationPatterns**: string[] -* **BasicAuthConfig**: [BasicAuthConfig](#basicauthconfig) -* **BuildSpec**: string -* **EnableAutoBranchCreation**: bool -* **EnableAutoBuild**: bool -* **EnablePerformanceMode**: bool -* **EnablePullRequestPreview**: bool -* **EnvironmentVariables**: [EnvironmentVariable](#environmentvariable)[] -* **Framework**: string -* **PullRequestEnvironmentName**: string -* **Stage**: string - -## BasicAuthConfig -### Properties -* **EnableBasicAuth**: bool -* **Password**: string -* **Username**: string - -## EnvironmentVariable -### Properties -* **Name**: string (Required) -* **Value**: string (Required) - -## CustomRule -### Properties -* **Condition**: string -* **Source**: string (Required) -* **Status**: string -* **Target**: string (Required) - -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - ## AWS.Amplify/BranchProperties ### Properties * **AppId**: string (Required) @@ -98,41 +75,78 @@ * **Stage**: string * **Tags**: [Tag](#tag)[] +## AWS.Amplify/DomainProperties +### Properties +* **AppId**: string (Required) +* **Arn**: string (ReadOnly, Identifier) +* **AutoSubDomainCreationPatterns**: string[] +* **AutoSubDomainIAMRole**: string +* **Certificate**: [Certificate](#certificate) (ReadOnly) +* **CertificateRecord**: string (ReadOnly) +* **CertificateSettings**: [CertificateSettings](#certificatesettings) (WriteOnly) +* **DomainName**: string (Required) +* **DomainStatus**: string (ReadOnly) +* **EnableAutoSubDomain**: bool +* **StatusReason**: string (ReadOnly) +* **SubDomainSettings**: [SubDomainSetting](#subdomainsetting)[] (Required) +* **UpdateStatus**: string (ReadOnly) + ## Backend ### Properties * **StackArn**: string +## BasicAuthConfig +### Properties +* **EnableBasicAuth**: bool +* **Password**: string +* **Username**: string + ## BasicAuthConfig ### Properties * **EnableBasicAuth**: bool * **Password**: string (Required) * **Username**: string (Required) +## Certificate +### Properties +* **CertificateArn**: string +* **CertificateType**: string +* **CertificateVerificationDNSRecord**: string + +## CertificateSettings +### Properties +* **CertificateType**: string +* **CustomCertificateArn**: string + +## CustomRule +### Properties +* **Condition**: string +* **Source**: string (Required) +* **Status**: string +* **Target**: string (Required) + ## EnvironmentVariable ### Properties * **Name**: string (Required) * **Value**: string (Required) -## Tag +## EnvironmentVariable ### Properties -* **Key**: string (Required) +* **Name**: string (Required) * **Value**: string (Required) -## AWS.Amplify/DomainProperties -### Properties -* **AppId**: string (Required) -* **Arn**: string (ReadOnly, Identifier) -* **AutoSubDomainCreationPatterns**: string[] -* **AutoSubDomainIAMRole**: string -* **CertificateRecord**: string (ReadOnly) -* **DomainName**: string (Required) -* **DomainStatus**: string (ReadOnly) -* **EnableAutoSubDomain**: bool -* **StatusReason**: string (ReadOnly) -* **SubDomainSettings**: [SubDomainSetting](#subdomainsetting)[] (Required) - ## SubDomainSetting ### Properties * **BranchName**: string (Required) * **Prefix**: string (Required) +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + diff --git a/artifacts/bicep/aws/aws.amplifyuibuilder/default/types.json b/artifacts/bicep/aws/aws.amplifyuibuilder/default/types.json index 6a99fcbc..9d2c00fd 100644 --- a/artifacts/bicep/aws/aws.amplifyuibuilder/default/types.json +++ b/artifacts/bicep/aws/aws.amplifyuibuilder/default/types.json @@ -1 +1,1634 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"ActionParameters","Properties":{"Anchor":{"Type":21,"Flags":0},"Fields":{"Type":20,"Flags":0},"Global":{"Type":21,"Flags":0},"Id":{"Type":21,"Flags":16},"Model":{"Type":4,"Flags":0},"State":{"Type":27,"Flags":0},"Target":{"Type":21,"Flags":0},"Type":{"Type":21,"Flags":0},"Url":{"Type":21,"Flags":0}}}},{"2":{"Name":"ComponentBindingProperties","Properties":{}}},{"2":{"Name":"ComponentBindingPropertiesValue","Properties":{"BindingProperties":{"Type":11,"Flags":0},"DefaultValue":{"Type":4,"Flags":0},"Type":{"Type":4,"Flags":0}}}},{"2":{"Name":"ComponentBindingPropertiesValueProperties","Properties":{"Bucket":{"Type":4,"Flags":0},"DefaultValue":{"Type":4,"Flags":0},"Field":{"Type":4,"Flags":0},"Key":{"Type":4,"Flags":0},"Model":{"Type":4,"Flags":0},"Predicates":{"Type":32,"Flags":0},"UserAttribute":{"Type":4,"Flags":0}}}},{"2":{"Name":"ComponentChild","Properties":{"Children":{"Type":33,"Flags":0},"ComponentType":{"Type":4,"Flags":1},"Events":{"Type":17,"Flags":0},"Name":{"Type":4,"Flags":1},"Properties":{"Type":20,"Flags":1}}}},{"2":{"Name":"ComponentCollectionProperties","Properties":{}}},{"2":{"Name":"ComponentConditionProperty","Properties":{"Else":{"Type":21,"Flags":0},"Field":{"Type":4,"Flags":0},"Operand":{"Type":4,"Flags":0},"OperandType":{"Type":4,"Flags":0},"Operator":{"Type":4,"Flags":0},"Property":{"Type":4,"Flags":0},"Then":{"Type":21,"Flags":0}}}},{"2":{"Name":"ComponentDataConfiguration","Properties":{"Identifiers":{"Type":34,"Flags":0},"Model":{"Type":4,"Flags":1},"Predicate":{"Type":28,"Flags":0},"Sort":{"Type":35,"Flags":0}}}},{"2":{"Name":"ComponentEvent","Properties":{"Action":{"Type":4,"Flags":0},"Parameters":{"Type":8,"Flags":0}}}},{"2":{"Name":"ComponentEvents","Properties":{}}},{"2":{"Name":"ComponentOverrides","Properties":{}}},{"2":{"Name":"ComponentOverridesValue","Properties":{}}},{"2":{"Name":"ComponentProperties","Properties":{}}},{"2":{"Name":"ComponentProperty","Properties":{"BindingProperties":{"Type":22,"Flags":0},"Bindings":{"Type":26,"Flags":0},"CollectionBindingProperties":{"Type":22,"Flags":0},"ComponentName":{"Type":4,"Flags":0},"Concat":{"Type":36,"Flags":0},"Condition":{"Type":14,"Flags":0},"Configured":{"Type":2,"Flags":0},"DefaultValue":{"Type":4,"Flags":0},"Event":{"Type":4,"Flags":0},"ImportedValue":{"Type":4,"Flags":0},"Model":{"Type":4,"Flags":0},"Property":{"Type":4,"Flags":0},"Type":{"Type":4,"Flags":0},"UserAttribute":{"Type":4,"Flags":0},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"ComponentPropertyBindingProperties","Properties":{"Field":{"Type":4,"Flags":0},"Property":{"Type":4,"Flags":1}}}},{"2":{"Name":"ComponentVariant","Properties":{"Overrides":{"Type":18,"Flags":0},"VariantValues":{"Type":24,"Flags":0}}}},{"2":{"Name":"ComponentVariantValues","Properties":{}}},{"2":{"Name":"FormBindingElement","Properties":{"Element":{"Type":4,"Flags":1},"Property":{"Type":4,"Flags":1}}}},{"2":{"Name":"FormBindings","Properties":{}}},{"2":{"Name":"MutationActionSetStateParameter","Properties":{"ComponentName":{"Type":4,"Flags":1},"Property":{"Type":4,"Flags":1},"Set":{"Type":21,"Flags":1}}}},{"2":{"Name":"Predicate","Properties":{"And":{"Type":37,"Flags":0},"Field":{"Type":4,"Flags":0},"Operand":{"Type":4,"Flags":0},"Operator":{"Type":4,"Flags":0},"Or":{"Type":38,"Flags":0}}}},{"2":{"Name":"SortDirection"}},{"2":{"Name":"SortProperty","Properties":{"Direction":{"Type":4,"Flags":1},"Field":{"Type":4,"Flags":1}}}},{"2":{"Name":"Tags","Properties":{}}},{"3":{"ItemType":28}},{"3":{"ItemType":12}},{"3":{"ItemType":4}},{"3":{"ItemType":30}},{"3":{"ItemType":21}},{"3":{"ItemType":28}},{"3":{"ItemType":28}},{"2":{"Name":"AWS.AmplifyUIBuilder/ComponentProperties","Properties":{"AppId":{"Type":4,"Flags":16},"BindingProperties":{"Type":9,"Flags":1},"Children":{"Type":40,"Flags":0},"CollectionProperties":{"Type":13,"Flags":0},"ComponentType":{"Type":4,"Flags":1},"EnvironmentName":{"Type":4,"Flags":16},"Events":{"Type":17,"Flags":0},"Id":{"Type":4,"Flags":18},"Name":{"Type":4,"Flags":1},"Overrides":{"Type":18,"Flags":1},"Properties":{"Type":20,"Flags":1},"SchemaVersion":{"Type":4,"Flags":0},"SourceId":{"Type":4,"Flags":0},"Tags":{"Type":31,"Flags":0},"Variants":{"Type":41,"Flags":1}}}},{"3":{"ItemType":12}},{"3":{"ItemType":23}},{"2":{"Name":"AWS.AmplifyUIBuilder/Component","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":39,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.AmplifyUIBuilder/Component@default","ScopeType":0,"Body":42}},{"2":{"Name":"FieldConfig","Properties":{"Excluded":{"Type":2,"Flags":0},"InputType":{"Type":45,"Flags":0},"Label":{"Type":4,"Flags":0},"Position":{"Type":67,"Flags":0},"Validations":{"Type":68,"Flags":0}}}},{"2":{"Name":"FieldInputConfig","Properties":{"DefaultChecked":{"Type":2,"Flags":0},"DefaultCountryCode":{"Type":4,"Flags":0},"DefaultValue":{"Type":4,"Flags":0},"DescriptiveText":{"Type":4,"Flags":0},"FileUploaderConfig":{"Type":49,"Flags":0},"IsArray":{"Type":2,"Flags":0},"MaxValue":{"Type":3,"Flags":0},"MinValue":{"Type":3,"Flags":0},"Name":{"Type":4,"Flags":0},"Placeholder":{"Type":4,"Flags":0},"ReadOnly":{"Type":2,"Flags":0},"Required":{"Type":2,"Flags":0},"Step":{"Type":3,"Flags":0},"Type":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":0},"ValueMappings":{"Type":66,"Flags":0}}}},{"2":{"Name":"FieldPosition","Properties":{}}},{"2":{"Name":"FieldValidationConfiguration","Properties":{"NumValues":{"Type":69,"Flags":0},"StrValues":{"Type":70,"Flags":0},"Type":{"Type":4,"Flags":1},"ValidationMessage":{"Type":4,"Flags":0}}}},{"2":{"Name":"FieldsMap","Properties":{}}},{"2":{"Name":"FileUploaderFieldConfig","Properties":{"AcceptedFileTypes":{"Type":71,"Flags":1},"AccessLevel":{"Type":4,"Flags":1},"IsResumable":{"Type":2,"Flags":0},"MaxFileCount":{"Type":3,"Flags":0},"MaxSize":{"Type":3,"Flags":0},"ShowThumbnails":{"Type":2,"Flags":0}}}},{"2":{"Name":"FixedPosition"}},{"2":{"Name":"FormActionType"}},{"2":{"Name":"FormButton","Properties":{"Children":{"Type":4,"Flags":0},"Excluded":{"Type":2,"Flags":0},"Position":{"Type":46,"Flags":0}}}},{"2":{"Name":"FormButtonsPosition"}},{"2":{"Name":"FormCTA","Properties":{"Cancel":{"Type":52,"Flags":0},"Clear":{"Type":52,"Flags":0},"Position":{"Type":4,"Flags":0},"Submit":{"Type":52,"Flags":0}}}},{"2":{"Name":"FormDataSourceType"}},{"2":{"Name":"FormDataTypeConfig","Properties":{"DataSourceType":{"Type":4,"Flags":1},"DataTypeName":{"Type":4,"Flags":1}}}},{"2":{"Name":"FormInputValueProperty","Properties":{"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"FormStyle","Properties":{"HorizontalGap":{"Type":72,"Flags":0},"OuterPadding":{"Type":73,"Flags":0},"VerticalGap":{"Type":74,"Flags":0}}}},{"2":{"Name":"FormStyleConfig","Properties":{}}},{"2":{"Name":"LabelDecorator"}},{"2":{"Name":"SectionalElement","Properties":{"Excluded":{"Type":2,"Flags":0},"Level":{"Type":3,"Flags":0},"Orientation":{"Type":4,"Flags":0},"Position":{"Type":46,"Flags":0},"Text":{"Type":4,"Flags":0},"Type":{"Type":4,"Flags":1}}}},{"2":{"Name":"SectionalElementMap","Properties":{}}},{"2":{"Name":"StorageAccessLevel"}},{"2":{"Name":"Tags","Properties":{}}},{"2":{"Name":"ValueMapping","Properties":{"DisplayValue":{"Type":57,"Flags":0},"Value":{"Type":57,"Flags":1}}}},{"2":{"Name":"ValueMappings","Properties":{"Values":{"Type":75,"Flags":1}}}},{"2":{"Name":"Form_FieldPosition","Properties":{}}},{"3":{"ItemType":47}},{"3":{"ItemType":3}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"Form_FormStyleConfig","Properties":{}}},{"2":{"Name":"Form_FormStyleConfig","Properties":{}}},{"2":{"Name":"Form_FormStyleConfig","Properties":{}}},{"3":{"ItemType":65}},{"2":{"Name":"AWS.AmplifyUIBuilder/FormProperties","Properties":{"AppId":{"Type":4,"Flags":16},"Cta":{"Type":54,"Flags":0},"DataType":{"Type":56,"Flags":1},"EnvironmentName":{"Type":4,"Flags":16},"Fields":{"Type":48,"Flags":1},"FormActionType":{"Type":4,"Flags":1},"Id":{"Type":4,"Flags":18},"LabelDecorator":{"Type":4,"Flags":0},"Name":{"Type":4,"Flags":1},"SchemaVersion":{"Type":4,"Flags":1},"SectionalElements":{"Type":62,"Flags":1},"Style":{"Type":58,"Flags":1},"Tags":{"Type":64,"Flags":0}}}},{"2":{"Name":"AWS.AmplifyUIBuilder/Form","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":76,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.AmplifyUIBuilder/Form@default","ScopeType":0,"Body":77}},{"2":{"Name":"Tags","Properties":{}}},{"2":{"Name":"ThemeValue","Properties":{"Children":{"Type":82,"Flags":0},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"ThemeValues","Properties":{"Key":{"Type":4,"Flags":0},"Value":{"Type":80,"Flags":0}}}},{"3":{"ItemType":81}},{"2":{"Name":"AWS.AmplifyUIBuilder/ThemeProperties","Properties":{"AppId":{"Type":4,"Flags":16},"EnvironmentName":{"Type":4,"Flags":16},"Id":{"Type":4,"Flags":18},"Name":{"Type":4,"Flags":1},"Overrides":{"Type":84,"Flags":0},"Tags":{"Type":79,"Flags":0},"Values":{"Type":85,"Flags":1}}}},{"3":{"ItemType":81}},{"3":{"ItemType":81}},{"2":{"Name":"AWS.AmplifyUIBuilder/Theme","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":83,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.AmplifyUIBuilder/Theme@default","ScopeType":0,"Body":86}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "ActionParameters", + "properties": { + "Anchor": { + "type": { + "$ref": "#/13" + }, + "flags": 0 + }, + "Fields": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + }, + "Global": { + "type": { + "$ref": "#/13" + }, + "flags": 0 + }, + "Id": { + "type": { + "$ref": "#/13" + }, + "flags": 16 + }, + "Model": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "State": { + "type": { + "$ref": "#/19" + }, + "flags": 0 + }, + "Target": { + "type": { + "$ref": "#/13" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/13" + }, + "flags": 0 + }, + "Url": { + "type": { + "$ref": "#/13" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ComponentBindingProperties", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ComponentBindingPropertiesValue", + "properties": { + "BindingProperties": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "DefaultValue": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ComponentBindingPropertiesValueProperties", + "properties": { + "Bucket": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "DefaultValue": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "Field": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "Key": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "Model": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "Predicates": { + "type": { + "$ref": "#/25" + }, + "flags": 0 + }, + "SlotName": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "UserAttribute": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ComponentChild", + "properties": { + "Children": { + "type": { + "$ref": "#/26" + }, + "flags": 0 + }, + "ComponentType": { + "type": { + "$ref": "#/24" + }, + "flags": 1 + }, + "Events": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/24" + }, + "flags": 1 + }, + "Properties": { + "type": { + "$ref": "#/12" + }, + "flags": 1 + }, + "SourceId": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ComponentCollectionProperties", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ComponentConditionProperty", + "properties": { + "Else": { + "type": { + "$ref": "#/13" + }, + "flags": 0 + }, + "Field": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "Operand": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "OperandType": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "Operator": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "Property": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "Then": { + "type": { + "$ref": "#/13" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ComponentDataConfiguration", + "properties": { + "Identifiers": { + "type": { + "$ref": "#/27" + }, + "flags": 0 + }, + "Model": { + "type": { + "$ref": "#/24" + }, + "flags": 1 + }, + "Predicate": { + "type": { + "$ref": "#/20" + }, + "flags": 0 + }, + "Sort": { + "type": { + "$ref": "#/28" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ComponentEvent", + "properties": { + "Action": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "BindingEvent": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "Parameters": { + "type": { + "$ref": "#/0" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ComponentEvents", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ComponentOverrides", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ComponentOverridesValue", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ComponentProperties", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ComponentProperty", + "properties": { + "BindingProperties": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + }, + "Bindings": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "CollectionBindingProperties": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + }, + "ComponentName": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "Concat": { + "type": { + "$ref": "#/29" + }, + "flags": 0 + }, + "Condition": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "Configured": { + "type": { + "$ref": "#/30" + }, + "flags": 0 + }, + "DefaultValue": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "Event": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "ImportedValue": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "Model": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "Property": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "UserAttribute": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ComponentPropertyBindingProperties", + "properties": { + "Field": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "Property": { + "type": { + "$ref": "#/24" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ComponentVariant", + "properties": { + "Overrides": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "VariantValues": { + "type": { + "$ref": "#/16" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ComponentVariantValues", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "FormBindingElement", + "properties": { + "Element": { + "type": { + "$ref": "#/24" + }, + "flags": 1 + }, + "Property": { + "type": { + "$ref": "#/24" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "FormBindings", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MutationActionSetStateParameter", + "properties": { + "ComponentName": { + "type": { + "$ref": "#/24" + }, + "flags": 1 + }, + "Property": { + "type": { + "$ref": "#/24" + }, + "flags": 1 + }, + "Set": { + "type": { + "$ref": "#/13" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Predicate", + "properties": { + "And": { + "type": { + "$ref": "#/31" + }, + "flags": 0 + }, + "Field": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "Operand": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "OperandType": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "Operator": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "Or": { + "type": { + "$ref": "#/32" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SortDirection", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SortProperty", + "properties": { + "Direction": { + "type": { + "$ref": "#/24" + }, + "flags": 1 + }, + "Field": { + "type": { + "$ref": "#/24" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Tags", + "properties": {} + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/20" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/24" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/22" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/20" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/20" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.AmplifyUIBuilder/ComponentProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/15" + } + }, + { + "$type": "ObjectType", + "name": "AWS.AmplifyUIBuilder/ComponentProperties", + "properties": { + "AppId": { + "type": { + "$ref": "#/24" + }, + "flags": 16 + }, + "BindingProperties": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "Children": { + "type": { + "$ref": "#/34" + }, + "flags": 0 + }, + "CollectionProperties": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "ComponentType": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "CreatedAt": { + "type": { + "$ref": "#/24" + }, + "flags": 2 + }, + "EnvironmentName": { + "type": { + "$ref": "#/24" + }, + "flags": 16 + }, + "Events": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "Id": { + "type": { + "$ref": "#/24" + }, + "flags": 18 + }, + "ModifiedAt": { + "type": { + "$ref": "#/24" + }, + "flags": 2 + }, + "Name": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "Overrides": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "Properties": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + }, + "SchemaVersion": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "SourceId": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "Variants": { + "type": { + "$ref": "#/35" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.AmplifyUIBuilder/Component", + "properties": { + "name": { + "type": { + "$ref": "#/24" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/24" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/36" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.AmplifyUIBuilder/Component@default", + "scopeType": 0, + "body": { + "$ref": "#/37" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "FieldConfig", + "properties": { + "Excluded": { + "type": { + "$ref": "#/30" + }, + "flags": 0 + }, + "InputType": { + "type": { + "$ref": "#/40" + }, + "flags": 0 + }, + "Label": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "Position": { + "type": { + "$ref": "#/66" + }, + "flags": 0 + }, + "Validations": { + "type": { + "$ref": "#/67" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FieldInputConfig", + "properties": { + "DefaultChecked": { + "type": { + "$ref": "#/30" + }, + "flags": 0 + }, + "DefaultCountryCode": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "DefaultValue": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "DescriptiveText": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "FileUploaderConfig": { + "type": { + "$ref": "#/44" + }, + "flags": 0 + }, + "IsArray": { + "type": { + "$ref": "#/30" + }, + "flags": 0 + }, + "MaxValue": { + "type": { + "$ref": "#/68" + }, + "flags": 0 + }, + "MinValue": { + "type": { + "$ref": "#/68" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "Placeholder": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "ReadOnly": { + "type": { + "$ref": "#/30" + }, + "flags": 0 + }, + "Required": { + "type": { + "$ref": "#/30" + }, + "flags": 0 + }, + "Step": { + "type": { + "$ref": "#/68" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/24" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "ValueMappings": { + "type": { + "$ref": "#/65" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FieldPosition", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "FieldValidationConfiguration", + "properties": { + "NumValues": { + "type": { + "$ref": "#/69" + }, + "flags": 0 + }, + "StrValues": { + "type": { + "$ref": "#/70" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/24" + }, + "flags": 1 + }, + "ValidationMessage": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FieldsMap", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "FileUploaderFieldConfig", + "properties": { + "AcceptedFileTypes": { + "type": { + "$ref": "#/71" + }, + "flags": 1 + }, + "AccessLevel": { + "type": { + "$ref": "#/24" + }, + "flags": 1 + }, + "IsResumable": { + "type": { + "$ref": "#/30" + }, + "flags": 0 + }, + "MaxFileCount": { + "type": { + "$ref": "#/68" + }, + "flags": 0 + }, + "MaxSize": { + "type": { + "$ref": "#/68" + }, + "flags": 0 + }, + "ShowThumbnails": { + "type": { + "$ref": "#/30" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FixedPosition", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "FormActionType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "FormButton", + "properties": { + "Children": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "Excluded": { + "type": { + "$ref": "#/30" + }, + "flags": 0 + }, + "Position": { + "type": { + "$ref": "#/41" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FormButtonsPosition", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "FormCTA", + "properties": { + "Cancel": { + "type": { + "$ref": "#/47" + }, + "flags": 0 + }, + "Clear": { + "type": { + "$ref": "#/47" + }, + "flags": 0 + }, + "Position": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "Submit": { + "type": { + "$ref": "#/47" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FormDataSourceType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "FormDataTypeConfig", + "properties": { + "DataSourceType": { + "type": { + "$ref": "#/24" + }, + "flags": 1 + }, + "DataTypeName": { + "type": { + "$ref": "#/24" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "FormInputBindingProperties", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "FormInputBindingPropertiesValue", + "properties": { + "BindingProperties": { + "type": { + "$ref": "#/54" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FormInputBindingPropertiesValueProperties", + "properties": { + "Model": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FormInputValueProperty", + "properties": { + "BindingProperties": { + "type": { + "$ref": "#/56" + }, + "flags": 0 + }, + "Concat": { + "type": { + "$ref": "#/72" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FormInputValuePropertyBindingProperties", + "properties": { + "Field": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "Property": { + "type": { + "$ref": "#/24" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "FormStyle", + "properties": { + "HorizontalGap": { + "type": { + "$ref": "#/73" + }, + "flags": 0 + }, + "OuterPadding": { + "type": { + "$ref": "#/74" + }, + "flags": 0 + }, + "VerticalGap": { + "type": { + "$ref": "#/75" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FormStyleConfig", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LabelDecorator", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SectionalElement", + "properties": { + "Excluded": { + "type": { + "$ref": "#/30" + }, + "flags": 0 + }, + "Level": { + "type": { + "$ref": "#/68" + }, + "flags": 0 + }, + "Orientation": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "Position": { + "type": { + "$ref": "#/41" + }, + "flags": 0 + }, + "Text": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/24" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "SectionalElementMap", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "StorageAccessLevel", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tags", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ValueMapping", + "properties": { + "DisplayValue": { + "type": { + "$ref": "#/55" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/55" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ValueMappings", + "properties": { + "BindingProperties": { + "type": { + "$ref": "#/52" + }, + "flags": 0 + }, + "Values": { + "type": { + "$ref": "#/76" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Form_FieldPosition", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/42" + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/68" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/24" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/24" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/55" + } + }, + { + "$type": "ObjectType", + "name": "Form_FormStyleConfig", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Form_FormStyleConfig", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Form_FormStyleConfig", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/64" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.AmplifyUIBuilder/FormProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.AmplifyUIBuilder/FormProperties", + "properties": { + "AppId": { + "type": { + "$ref": "#/24" + }, + "flags": 16 + }, + "Cta": { + "type": { + "$ref": "#/49" + }, + "flags": 0 + }, + "DataType": { + "type": { + "$ref": "#/51" + }, + "flags": 0 + }, + "EnvironmentName": { + "type": { + "$ref": "#/24" + }, + "flags": 16 + }, + "Fields": { + "type": { + "$ref": "#/43" + }, + "flags": 0 + }, + "FormActionType": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "Id": { + "type": { + "$ref": "#/24" + }, + "flags": 18 + }, + "LabelDecorator": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "SchemaVersion": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "SectionalElements": { + "type": { + "$ref": "#/61" + }, + "flags": 0 + }, + "Style": { + "type": { + "$ref": "#/57" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/63" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.AmplifyUIBuilder/Form", + "properties": { + "name": { + "type": { + "$ref": "#/24" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/24" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/78" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.AmplifyUIBuilder/Form@default", + "scopeType": 0, + "body": { + "$ref": "#/79" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tags", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ThemeValue", + "properties": { + "Children": { + "type": { + "$ref": "#/84" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ThemeValues", + "properties": { + "Key": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/82" + }, + "flags": 0 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/83" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.AmplifyUIBuilder/ThemeProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/83" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/83" + } + }, + { + "$type": "ObjectType", + "name": "AWS.AmplifyUIBuilder/ThemeProperties", + "properties": { + "AppId": { + "type": { + "$ref": "#/24" + }, + "flags": 16 + }, + "CreatedAt": { + "type": { + "$ref": "#/24" + }, + "flags": 2 + }, + "EnvironmentName": { + "type": { + "$ref": "#/24" + }, + "flags": 16 + }, + "Id": { + "type": { + "$ref": "#/24" + }, + "flags": 18 + }, + "ModifiedAt": { + "type": { + "$ref": "#/24" + }, + "flags": 2 + }, + "Name": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "Overrides": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/81" + }, + "flags": 0 + }, + "Values": { + "type": { + "$ref": "#/87" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.AmplifyUIBuilder/Theme", + "properties": { + "name": { + "type": { + "$ref": "#/24" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/24" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/88" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.AmplifyUIBuilder/Theme@default", + "scopeType": 0, + "body": { + "$ref": "#/89" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.amplifyuibuilder/default/types.md b/artifacts/bicep/aws/aws.amplifyuibuilder/default/types.md index 277e6b3a..edc86980 100644 --- a/artifacts/bicep/aws/aws.amplifyuibuilder/default/types.md +++ b/artifacts/bicep/aws/aws.amplifyuibuilder/default/types.md @@ -3,41 +3,71 @@ ## Resource AWS.AmplifyUIBuilder/Component@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.AmplifyUIBuilder/ComponentProperties](#awsamplifyuibuildercomponentproperties) (Required): properties of the resource +* **properties**: [AWS.AmplifyUIBuilder/ComponentProperties](#awsamplifyuibuildercomponentproperties) (Identifier): properties of the resource ## Resource AWS.AmplifyUIBuilder/Form@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.AmplifyUIBuilder/FormProperties](#awsamplifyuibuilderformproperties) (Required): properties of the resource +* **properties**: [AWS.AmplifyUIBuilder/FormProperties](#awsamplifyuibuilderformproperties) (Identifier): properties of the resource ## Resource AWS.AmplifyUIBuilder/Theme@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.AmplifyUIBuilder/ThemeProperties](#awsamplifyuibuilderthemeproperties) (Required): properties of the resource +* **properties**: [AWS.AmplifyUIBuilder/ThemeProperties](#awsamplifyuibuilderthemeproperties) (Identifier): properties of the resource ## AWS.AmplifyUIBuilder/ComponentProperties ### Properties * **AppId**: string (Identifier) -* **BindingProperties**: [ComponentBindingProperties](#componentbindingproperties) (Required) +* **BindingProperties**: [ComponentBindingProperties](#componentbindingproperties) * **Children**: [ComponentChild](#componentchild)[] * **CollectionProperties**: [ComponentCollectionProperties](#componentcollectionproperties) -* **ComponentType**: string (Required) +* **ComponentType**: string +* **CreatedAt**: string (ReadOnly) * **EnvironmentName**: string (Identifier) * **Events**: [ComponentEvents](#componentevents) * **Id**: string (ReadOnly, Identifier) -* **Name**: string (Required) -* **Overrides**: [ComponentOverrides](#componentoverrides) (Required) -* **Properties**: [ComponentProperties](#componentproperties) (Required) +* **ModifiedAt**: string (ReadOnly) +* **Name**: string +* **Overrides**: [ComponentOverrides](#componentoverrides) +* **Properties**: [ComponentProperties](#componentproperties) * **SchemaVersion**: string * **SourceId**: string * **Tags**: [Tags](#tags) -* **Variants**: [ComponentVariant](#componentvariant)[] (Required) +* **Variants**: [ComponentVariant](#componentvariant)[] + +## AWS.AmplifyUIBuilder/FormProperties +### Properties +* **AppId**: string (Identifier) +* **Cta**: [FormCTA](#formcta) +* **DataType**: [FormDataTypeConfig](#formdatatypeconfig) +* **EnvironmentName**: string (Identifier) +* **Fields**: [FieldsMap](#fieldsmap) +* **FormActionType**: string +* **Id**: string (ReadOnly, Identifier) +* **LabelDecorator**: string +* **Name**: string +* **SchemaVersion**: string +* **SectionalElements**: [SectionalElementMap](#sectionalelementmap) +* **Style**: [FormStyle](#formstyle) +* **Tags**: [Tags](#tags) + +## AWS.AmplifyUIBuilder/ThemeProperties +### Properties +* **AppId**: string (Identifier) +* **CreatedAt**: string (ReadOnly) +* **EnvironmentName**: string (Identifier) +* **Id**: string (ReadOnly, Identifier) +* **ModifiedAt**: string (ReadOnly) +* **Name**: string +* **Overrides**: [ThemeValues](#themevalues)[] +* **Tags**: [Tags](#tags) +* **Values**: [ThemeValues](#themevalues)[] ## ComponentBindingProperties ### Properties @@ -49,20 +79,18 @@ * **Events**: [ComponentEvents](#componentevents) * **Name**: string (Required) * **Properties**: [ComponentProperties](#componentproperties) (Required) +* **SourceId**: string -## ComponentEvents -### Properties - -## ComponentProperties +## ComponentCollectionProperties ### Properties -## ComponentCollectionProperties +## ComponentEvents ### Properties ## ComponentOverrides ### Properties -## Tags +## ComponentProperties ### Properties ## ComponentVariant @@ -73,28 +101,20 @@ ## ComponentVariantValues ### Properties -## AWS.AmplifyUIBuilder/FormProperties +## FieldPosition ### Properties -* **AppId**: string (Identifier) -* **Cta**: [FormCTA](#formcta) -* **DataType**: [FormDataTypeConfig](#formdatatypeconfig) (Required) -* **EnvironmentName**: string (Identifier) -* **Fields**: [FieldsMap](#fieldsmap) (Required) -* **FormActionType**: string (Required) -* **Id**: string (ReadOnly, Identifier) -* **LabelDecorator**: string -* **Name**: string (Required) -* **SchemaVersion**: string (Required) -* **SectionalElements**: [SectionalElementMap](#sectionalelementmap) (Required) -* **Style**: [FormStyle](#formstyle) (Required) -* **Tags**: [Tags](#tags) -## FormCTA +## FieldsMap +### Properties + +## Form_FormStyleConfig +### Properties + +## Form_FormStyleConfig +### Properties + +## Form_FormStyleConfig ### Properties -* **Cancel**: [FormButton](#formbutton) -* **Clear**: [FormButton](#formbutton) -* **Position**: string -* **Submit**: [FormButton](#formbutton) ## FormButton ### Properties @@ -102,58 +122,43 @@ * **Excluded**: bool * **Position**: [FieldPosition](#fieldposition) -## FieldPosition +## FormCTA ### Properties +* **Cancel**: [FormButton](#formbutton) +* **Clear**: [FormButton](#formbutton) +* **Position**: string +* **Submit**: [FormButton](#formbutton) ## FormDataTypeConfig ### Properties * **DataSourceType**: string (Required) * **DataTypeName**: string (Required) -## FieldsMap -### Properties - -## SectionalElementMap -### Properties - ## FormStyle ### Properties * **HorizontalGap**: [Form_FormStyleConfig](#formformstyleconfig) * **OuterPadding**: [Form_FormStyleConfig](#formformstyleconfig) * **VerticalGap**: [Form_FormStyleConfig](#formformstyleconfig) -## Form_FormStyleConfig -### Properties - -## Form_FormStyleConfig +## SectionalElementMap ### Properties -## Form_FormStyleConfig +## Tags ### Properties ## Tags ### Properties -## AWS.AmplifyUIBuilder/ThemeProperties -### Properties -* **AppId**: string (Identifier) -* **EnvironmentName**: string (Identifier) -* **Id**: string (ReadOnly, Identifier) -* **Name**: string (Required) -* **Overrides**: [ThemeValues](#themevalues)[] -* **Tags**: [Tags](#tags) -* **Values**: [ThemeValues](#themevalues)[] (Required) - -## ThemeValues +## Tags ### Properties -* **Key**: string -* **Value**: [ThemeValue](#themevalue) ## ThemeValue ### Properties * **Children**: [ThemeValues](#themevalues)[] * **Value**: string -## Tags +## ThemeValues ### Properties +* **Key**: string +* **Value**: [ThemeValue](#themevalue) diff --git a/artifacts/bicep/aws/aws.apigateway/default/types.json b/artifacts/bicep/aws/aws.apigateway/default/types.json index da322102..f444e331 100644 --- a/artifacts/bicep/aws/aws.apigateway/default/types.json +++ b/artifacts/bicep/aws/aws.apigateway/default/types.json @@ -1 +1,2975 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"AWS.ApiGateway/AccountProperties","Properties":{"CloudWatchRoleArn":{"Type":4,"Flags":0,"Description":"The ARN of an Amazon CloudWatch role for the current Account."},"Id":{"Type":4,"Flags":18,"Description":""}}}},{"2":{"Name":"AWS.ApiGateway/Account","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":8,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ApiGateway/Account@default","ScopeType":0,"Body":9}},{"2":{"Name":"StageKey","Properties":{"RestApiId":{"Type":4,"Flags":0,"Description":"The string identifier of the associated RestApi."},"StageName":{"Type":4,"Flags":0,"Description":"The stage name associated with the stage key."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}}}},{"2":{"Name":"AWS.ApiGateway/ApiKeyProperties","Properties":{"APIKeyId":{"Type":4,"Flags":18,"Description":""},"CustomerId":{"Type":4,"Flags":0,"Description":"An MKT customer identifier, when integrating with the AWS SaaS Marketplace."},"Description":{"Type":4,"Flags":0,"Description":"The description of the ApiKey."},"Enabled":{"Type":2,"Flags":0,"Description":"Specifies whether the ApiKey can be used by callers."},"GenerateDistinctId":{"Type":2,"Flags":4,"Description":"Specifies whether (``true``) or not (``false``) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used."},"Name":{"Type":4,"Flags":0,"Description":"A name for the API key. If you don't specify a name, CFN 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 If 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."},"StageKeys":{"Type":14,"Flags":0,"Description":"DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key."},"Tags":{"Type":15,"Flags":0,"Description":"The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with ``aws:``. The tag value can be up to 256 characters."},"Value":{"Type":4,"Flags":0,"Description":"Specifies a value of the API key."}}}},{"3":{"ItemType":11}},{"3":{"ItemType":12}},{"2":{"Name":"AWS.ApiGateway/ApiKey","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":13,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ApiGateway/ApiKey@default","ScopeType":0,"Body":16}},{"2":{"Name":"AWS.ApiGateway/AuthorizerProperties","Properties":{"AuthType":{"Type":4,"Flags":0,"Description":"Optional customer-defined field, used in OpenAPI imports and exports without functional impact."},"AuthorizerCredentials":{"Type":4,"Flags":0,"Description":"Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null."},"AuthorizerId":{"Type":4,"Flags":18,"Description":""},"AuthorizerResultTtlInSeconds":{"Type":3,"Flags":0,"Description":"The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour."},"AuthorizerUri":{"Type":4,"Flags":0,"Description":"Specifies the authorizer's Uniform Resource Identifier (URI). For ``TOKEN`` or ``REQUEST`` authorizers, this must be a well-formed Lambda function URI, for example, ``arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations``. In general, the URI has this form ``arn:aws:apigateway:{region}:lambda:path/{service_api}``, where ``{region}`` is the same as the region hosting the Lambda function, ``path`` indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial ``/``. For Lambda functions, this is usually of the form ``/2015-03-31/functions/[FunctionARN]/invocations``."},"IdentitySource":{"Type":4,"Flags":0,"Description":"The identity source for which authorization is requested. For a ``TOKEN`` or ``COGNITO_USER_POOLS`` authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is ``Auth``, the header mapping expression is ``method.request.header.Auth``. For the ``REQUEST`` authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an ``Auth`` header, a ``Name`` query string parameter are defined as identity sources, this value is ``method.request.header.Auth, method.request.querystring.Name``. These parameters will be used to derive the authorization caching key and to perform runtime validation of the ``REQUEST`` authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional."},"IdentityValidationExpression":{"Type":4,"Flags":0,"Description":"A validation expression for the incoming identity token. For ``TOKEN`` authorizers, this value is a regular expression. For ``COGNITO_USER_POOLS`` authorizers, API Gateway will match the ``aud`` field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the ``REQUEST`` authorizer."},"Name":{"Type":4,"Flags":1,"Description":"The name of the authorizer."},"ProviderARNs":{"Type":19,"Flags":0,"Description":"A list of the Amazon Cognito user pool ARNs for the ``COGNITO_USER_POOLS`` authorizer. Each element is of this format: ``arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}``. For a ``TOKEN`` or ``REQUEST`` authorizer, this is not defined."},"RestApiId":{"Type":4,"Flags":17,"Description":"The string identifier of the associated RestApi."},"Type":{"Type":4,"Flags":1,"Description":"The authorizer type. Valid values are ``TOKEN`` for a Lambda function using a single authorization token submitted in a custom header, ``REQUEST`` for a Lambda function using incoming request parameters, and ``COGNITO_USER_POOLS`` for using an Amazon Cognito user pool."}}}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.ApiGateway/Authorizer","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":18,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ApiGateway/Authorizer@default","ScopeType":0,"Body":20}},{"2":{"Name":"AWS.ApiGateway/BasePathMappingProperties","Properties":{"BasePath":{"Type":4,"Flags":16,"Description":"The base path name that callers of the API must provide as part of the URL after the domain name."},"DomainName":{"Type":4,"Flags":17,"Description":"The domain name of the BasePathMapping resource to be described."},"RestApiId":{"Type":4,"Flags":0,"Description":"The string identifier of the associated RestApi."},"Stage":{"Type":4,"Flags":0,"Description":"The name of the associated stage."}}}},{"2":{"Name":"AWS.ApiGateway/BasePathMapping","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":22,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ApiGateway/BasePathMapping@default","ScopeType":0,"Body":23}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.ApiGateway/ClientCertificateProperties","Properties":{"ClientCertificateId":{"Type":4,"Flags":18,"Description":""},"Description":{"Type":4,"Flags":0,"Description":"The description of the client certificate."},"Tags":{"Type":27,"Flags":0,"Description":"The collection of tags. Each tag element is associated with a given resource."}}}},{"3":{"ItemType":25}},{"2":{"Name":"AWS.ApiGateway/ClientCertificate","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":26,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ApiGateway/ClientCertificate@default","ScopeType":0,"Body":28}},{"2":{"Name":"AccessLogSetting","Properties":{"DestinationArn":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with ``amazon-apigateway-``."},"Format":{"Type":4,"Flags":0,"Description":"A single line format of the access logs of data, as specified by selected $context variables. The format must include at least ``$context.requestId``."}}}},{"2":{"Name":"CanarySetting","Properties":{"PercentTraffic":{"Type":3,"Flags":0,"Description":"The percent (0-100) of traffic diverted to a canary deployment."},"StageVariableOverrides":{"Type":36,"Flags":0,"Description":"Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values."},"UseStageCache":{"Type":2,"Flags":0,"Description":"A Boolean flag to indicate whether the canary deployment uses the stage cache or not."}}}},{"2":{"Name":"DeploymentCanarySettings","Properties":{"PercentTraffic":{"Type":3,"Flags":0,"Description":"The percentage (0.0-100.0) of traffic routed to the canary deployment."},"StageVariableOverrides":{"Type":37,"Flags":0,"Description":"A stage variable overrides used for the canary release deployment. They can override existing stage variables or add new stage variables for the canary release deployment. These stage variables are represented as a string-to-string map between stage variable names and their values."},"UseStageCache":{"Type":2,"Flags":0,"Description":"A Boolean flag to indicate whether the canary release deployment uses the stage cache or not."}}}},{"2":{"Name":"MethodSetting","Properties":{"CacheDataEncrypted":{"Type":2,"Flags":0,"Description":"Specifies whether the cached responses are encrypted."},"CacheTtlInSeconds":{"Type":3,"Flags":0,"Description":"Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached."},"CachingEnabled":{"Type":2,"Flags":0,"Description":"Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached."},"DataTraceEnabled":{"Type":2,"Flags":0,"Description":"Specifies 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."},"HttpMethod":{"Type":4,"Flags":0,"Description":"The HTTP method."},"LoggingLevel":{"Type":4,"Flags":0,"Description":"Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. Valid values are ``OFF``, ``ERROR``, and ``INFO``. Choose ``ERROR`` to write only error-level entries to CloudWatch Logs, or choose ``INFO`` to include all ``ERROR`` events as well as extra informational events."},"MetricsEnabled":{"Type":2,"Flags":0,"Description":"Specifies whether Amazon CloudWatch metrics are enabled for this method."},"ResourcePath":{"Type":4,"Flags":0,"Description":"The resource path for this method. Forward slashes (``/``) are encoded as ``~1`` and the initial slash must include a forward slash. For example, the path value ``/resource/subresource`` must be encoded as ``/~1resource~1subresource``. To specify the root path, use only a slash (``/``)."},"ThrottlingBurstLimit":{"Type":3,"Flags":0,"Description":"Specifies the throttling burst limit."},"ThrottlingRateLimit":{"Type":3,"Flags":0,"Description":"Specifies the throttling rate limit."}}}},{"2":{"Name":"StageDescription","Properties":{"AccessLogSetting":{"Type":30,"Flags":0,"Description":"Specifies settings for logging access in this stage."},"CacheClusterEnabled":{"Type":2,"Flags":0,"Description":"Specifies whether a cache cluster is enabled for the stage."},"CacheClusterSize":{"Type":4,"Flags":0,"Description":"The size of the stage's cache cluster. For more information, see [cacheClusterSize](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateStage.html#apigw-CreateStage-request-cacheClusterSize) in the *API Gateway API Reference*."},"CacheDataEncrypted":{"Type":2,"Flags":0,"Description":"Indicates whether the cached responses are encrypted."},"CacheTtlInSeconds":{"Type":3,"Flags":0,"Description":"The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses."},"CachingEnabled":{"Type":2,"Flags":0,"Description":"Indicates whether responses are cached and returned for requests. You must enable a cache cluster on the stage to cache responses. For more information, see [Enable API Gateway Caching in a Stage to Enhance API Performance](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html) in the *API Gateway Developer Guide*."},"CanarySetting":{"Type":31,"Flags":0,"Description":"Specifies settings for the canary deployment in this stage."},"ClientCertificateId":{"Type":4,"Flags":0,"Description":"The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage."},"DataTraceEnabled":{"Type":2,"Flags":0,"Description":"Indicates whether data trace logging is enabled for methods in the stage. API Gateway pushes these logs to Amazon CloudWatch Logs."},"Description":{"Type":4,"Flags":0,"Description":"A description of the purpose of the stage."},"DocumentationVersion":{"Type":4,"Flags":0,"Description":"The version identifier of the API documentation snapshot."},"LoggingLevel":{"Type":4,"Flags":0,"Description":"The logging level for this method. For valid values, see the ``loggingLevel`` property of the [MethodSetting](https://docs.aws.amazon.com/apigateway/latest/api/API_MethodSetting.html) resource in the *Amazon API Gateway API Reference*."},"MethodSettings":{"Type":38,"Flags":0,"Description":"Configures settings for all of the stage's methods."},"MetricsEnabled":{"Type":2,"Flags":0,"Description":"Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage."},"Tags":{"Type":39,"Flags":0,"Description":"An array of arbitrary tags (key-value pairs) to associate with the stage."},"ThrottlingBurstLimit":{"Type":3,"Flags":0,"Description":"The target request burst rate limit. This allows more requests through for a period of time than the target rate limit. For more information, see [Manage API Request Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html) in the *API Gateway Developer Guide*."},"ThrottlingRateLimit":{"Type":3,"Flags":0,"Description":"The target request steady-state rate limit. For more information, see [Manage API Request Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html) in the *API Gateway Developer Guide*."},"TracingEnabled":{"Type":2,"Flags":0,"Description":"Specifies whether active tracing with X-ray is enabled for this stage.\n For more information, see [Trace API Gateway API Execution with X-Ray](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-xray.html) in the *API Gateway Developer Guide*."},"Variables":{"Type":40,"Flags":0,"Description":"A map that defines the stage variables. Variable names must consist of alphanumeric characters, and the values must match the following regular expression: ``[A-Za-z0-9-._~:/?#&=,]+``."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag"},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag"}}}},{"2":{"Name":"Deployment_StageVariableOverrides","Properties":{}}},{"2":{"Name":"Deployment_StageVariableOverrides","Properties":{}}},{"3":{"ItemType":33}},{"3":{"ItemType":35}},{"2":{"Name":"Deployment_Variables","Properties":{}}},{"2":{"Name":"AWS.ApiGateway/DeploymentProperties","Properties":{"DeploymentCanarySettings":{"Type":32,"Flags":4,"Description":"The input configuration for a canary deployment."},"DeploymentId":{"Type":4,"Flags":18,"Description":""},"Description":{"Type":4,"Flags":0,"Description":"The description for the Deployment resource to create."},"RestApiId":{"Type":4,"Flags":17,"Description":"The string identifier of the associated RestApi."},"StageDescription":{"Type":34,"Flags":4,"Description":"The description of the Stage resource for the Deployment resource to create. To specify a stage description, you must also provide a stage name."},"StageName":{"Type":4,"Flags":4,"Description":"The name of the Stage resource for the Deployment resource to create."}}}},{"2":{"Name":"AWS.ApiGateway/Deployment","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":41,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ApiGateway/Deployment@default","ScopeType":0,"Body":42}},{"2":{"Name":"Location","Properties":{"Method":{"Type":4,"Flags":0,"Description":"The HTTP verb of a method. It is a valid field for the API entity types of ``METHOD``, ``PATH_PARAMETER``, ``QUERY_PARAMETER``, ``REQUEST_HEADER``, ``REQUEST_BODY``, ``RESPONSE``, ``RESPONSE_HEADER``, and ``RESPONSE_BODY``. The default value is ``*`` for any method. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other ``location`` attributes, the child entity's ``method`` attribute must match that of the parent entity exactly."},"Name":{"Type":4,"Flags":0,"Description":"The name of the targeted API entity. It is a valid and required field for the API entity types of ``AUTHORIZER``, ``MODEL``, ``PATH_PARAMETER``, ``QUERY_PARAMETER``, ``REQUEST_HEADER``, ``REQUEST_BODY`` and ``RESPONSE_HEADER``. It is an invalid field for any other entity type."},"Path":{"Type":4,"Flags":0,"Description":"The URL path of the target. It is a valid field for the API entity types of ``RESOURCE``, ``METHOD``, ``PATH_PARAMETER``, ``QUERY_PARAMETER``, ``REQUEST_HEADER``, ``REQUEST_BODY``, ``RESPONSE``, ``RESPONSE_HEADER``, and ``RESPONSE_BODY``. The default value is ``/`` for the root resource. When an applicable child entity inherits the content of another entity of the same type with more general specifications of the other ``location`` attributes, the child entity's ``path`` attribute must match that of the parent entity as a prefix."},"StatusCode":{"Type":4,"Flags":0,"Description":"The HTTP status code of a response. It is a valid field for the API entity types of ``RESPONSE``, ``RESPONSE_HEADER``, and ``RESPONSE_BODY``. The default value is ``*`` for any status code. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other ``location`` attributes, the child entity's ``statusCode`` attribute must match that of the parent entity exactly."},"Type":{"Type":4,"Flags":0,"Description":"The type of API entity to which the documentation content applies. Valid values are ``API``, ``AUTHORIZER``, ``MODEL``, ``RESOURCE``, ``METHOD``, ``PATH_PARAMETER``, ``QUERY_PARAMETER``, ``REQUEST_HEADER``, ``REQUEST_BODY``, ``RESPONSE``, ``RESPONSE_HEADER``, and ``RESPONSE_BODY``. Content inheritance does not apply to any entity of the ``API``, ``AUTHORIZER``, ``METHOD``, ``MODEL``, ``REQUEST_BODY``, or ``RESOURCE`` type."}}}},{"2":{"Name":"AWS.ApiGateway/DocumentationPartProperties","Properties":{"DocumentationPartId":{"Type":4,"Flags":18,"Description":""},"Location":{"Type":44,"Flags":1,"Description":"The location of the targeted API entity of the to-be-created documentation part."},"Properties":{"Type":4,"Flags":1,"Description":"The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published."},"RestApiId":{"Type":4,"Flags":17,"Description":"The string identifier of the associated RestApi."}}}},{"2":{"Name":"AWS.ApiGateway/DocumentationPart","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":45,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ApiGateway/DocumentationPart@default","ScopeType":0,"Body":46}},{"2":{"Name":"AWS.ApiGateway/DocumentationVersionProperties","Properties":{"Description":{"Type":4,"Flags":0,"Description":"A description about the new documentation snapshot."},"DocumentationVersion":{"Type":4,"Flags":17,"Description":"The version identifier of the to-be-updated documentation version."},"RestApiId":{"Type":4,"Flags":17,"Description":"The string identifier of the associated RestApi."}}}},{"2":{"Name":"AWS.ApiGateway/DocumentationVersion","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":48,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ApiGateway/DocumentationVersion@default","ScopeType":0,"Body":49}},{"2":{"Name":"EndpointConfiguration","Properties":{"Types":{"Type":54,"Flags":0}}}},{"2":{"Name":"MutualTlsAuthentication","Properties":{"TruststoreUri":{"Type":4,"Flags":0},"TruststoreVersion":{"Type":4,"Flags":0}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":0},"Value":{"Type":4,"Flags":0}}}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.ApiGateway/DomainNameProperties","Properties":{"CertificateArn":{"Type":4,"Flags":0},"DistributionDomainName":{"Type":4,"Flags":2},"DistributionHostedZoneId":{"Type":4,"Flags":2},"DomainName":{"Type":4,"Flags":16},"EndpointConfiguration":{"Type":51,"Flags":0},"MutualTlsAuthentication":{"Type":52,"Flags":0},"OwnershipVerificationCertificateArn":{"Type":4,"Flags":0},"RegionalCertificateArn":{"Type":4,"Flags":0},"RegionalDomainName":{"Type":4,"Flags":2},"RegionalHostedZoneId":{"Type":4,"Flags":2},"SecurityPolicy":{"Type":4,"Flags":0},"Tags":{"Type":56,"Flags":0}}}},{"3":{"ItemType":53}},{"2":{"Name":"AWS.ApiGateway/DomainName","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":55,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ApiGateway/DomainName@default","ScopeType":0,"Body":57}},{"2":{"Name":"Integration","Properties":{"CacheKeyParameters":{"Type":62,"Flags":0,"Description":"A list of request parameters whose values API Gateway caches. To be valid values for ``cacheKeyParameters``, these parameters must also be specified for Method ``requestParameters``."},"CacheNamespace":{"Type":4,"Flags":0,"Description":"Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the ``cacheNamespace``. You can specify the same ``cacheNamespace`` across resources to return the same cached data for requests to different resources."},"ConnectionId":{"Type":4,"Flags":0,"Description":"The ID of the VpcLink used for the integration when ``connectionType=VPC_LINK`` and undefined, otherwise."},"ConnectionType":{"Type":4,"Flags":0,"Description":"The type of the network connection to the integration endpoint. The valid value is ``INTERNET`` for connections through the public routable internet or ``VPC_LINK`` for private connections between API Gateway and a network load balancer in a VPC. The default value is ``INTERNET``."},"ContentHandling":{"Type":4,"Flags":0,"Description":"Specifies how to handle request payload content type conversions. Supported values are ``CONVERT_TO_BINARY`` and ``CONVERT_TO_TEXT``, with the following behaviors:\n If 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."},"Credentials":{"Type":4,"Flags":0,"Description":"Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string ``arn:aws:iam::\\*:user/\\*``. To use resource-based permissions on supported AWS services, specify null."},"IntegrationHttpMethod":{"Type":4,"Flags":0,"Description":"Specifies the integration's HTTP method type. For the Type property, if you specify ``MOCK``, this property is optional. For Lambda integrations, you must set the integration method to ``POST``. For all other types, you must specify this property."},"IntegrationResponses":{"Type":63,"Flags":0,"Description":"Specifies the integration's responses."},"PassthroughBehavior":{"Type":4,"Flags":0,"Description":"Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in ``requestTemplates``. The valid value is one of the following: ``WHEN_NO_MATCH``: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request. ``WHEN_NO_TEMPLATES``: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response. ``NEVER``: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request."},"RequestParameters":{"Type":64,"Flags":0,"Description":"A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of ``method.request.{location}.{name}``, where ``location`` is ``querystring``, ``path``, or ``header`` and ``name`` must be a valid and unique method request parameter name."},"RequestTemplates":{"Type":65,"Flags":0,"Description":"Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value."},"TimeoutInMillis":{"Type":3,"Flags":0,"Description":"Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds."},"Type":{"Type":4,"Flags":1,"Description":"Specifies an API method integration type. The valid value is one of the following:\n For 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."},"Uri":{"Type":4,"Flags":0,"Description":"Specifies Uniform Resource Identifier (URI) of the integration endpoint.\n For ``HTTP`` or ``HTTP_PROXY`` integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification for standard integrations. If ``connectionType`` is ``VPC_LINK`` specify the Network Load Balancer DNS name. For ``AWS`` or ``AWS_PROXY`` integrations, the URI is of the form ``arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}``. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either ``arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}`` or ``arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}``"}}}},{"2":{"Name":"IntegrationResponse","Properties":{"ContentHandling":{"Type":4,"Flags":0,"Description":"Specifies how to handle response payload content type conversions. Supported values are ``CONVERT_TO_BINARY`` and ``CONVERT_TO_TEXT``, with the following behaviors:\n If this property is not defined, the response payload will be passed through from the integration response to the method response without modification."},"ResponseParameters":{"Type":66,"Flags":0,"Description":"A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of ``method.response.header.{name}``, where ``name`` is a valid and unique header name. The mapped non-static value must match the pattern of ``integration.response.header.{name}`` or ``integration.response.body.{JSON-expression}``, where ``name`` is a valid and unique response header name and ``JSON-expression`` is a valid JSON expression without the ``$`` prefix."},"ResponseTemplates":{"Type":67,"Flags":0,"Description":"Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value."},"SelectionPattern":{"Type":4,"Flags":0,"Description":"Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the ``.+`` regex to match error response. However, make sure that the error response does not contain any newline (``\\n``) character in such cases. If the back end is an LAMlong function, the LAMlong function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched."},"StatusCode":{"Type":4,"Flags":1,"Description":"Specifies the status code that is used to map the integration response to an existing MethodResponse."}}}},{"2":{"Name":"MethodResponse","Properties":{"ResponseModels":{"Type":68,"Flags":0,"Description":"Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value."},"ResponseParameters":{"Type":69,"Flags":0,"Description":"A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern ``method.response.header.{name}``, where ``name`` is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in ``integration.response.header.{name}``, a static value enclosed within a pair of single quotes (e.g., ``'application/json'``), or a JSON expression from the back-end response payload in the form of ``integration.response.body.{JSON-expression}``, where ``JSON-expression`` is a valid JSON expression without the ``$`` prefix.)"},"StatusCode":{"Type":4,"Flags":1,"Description":"The method response's status code."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":60}},{"2":{"Name":"Method_RequestParameters","Properties":{}}},{"2":{"Name":"Method_RequestTemplates","Properties":{}}},{"2":{"Name":"Method_ResponseParameters","Properties":{}}},{"2":{"Name":"Method_ResponseTemplates","Properties":{}}},{"2":{"Name":"Method_ResponseModels","Properties":{}}},{"2":{"Name":"Method_ResponseParameters","Properties":{}}},{"2":{"Name":"AWS.ApiGateway/MethodProperties","Properties":{"ApiKeyRequired":{"Type":2,"Flags":0,"Description":"A boolean flag specifying whether a valid ApiKey is required to invoke this method."},"AuthorizationScopes":{"Type":71,"Flags":0,"Description":"A list of authorization scopes configured on the method. The scopes are used with a ``COGNITO_USER_POOLS`` authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes."},"AuthorizationType":{"Type":4,"Flags":0,"Description":"The method's authorization type. This parameter is required. For valid values, see [Method](https://docs.aws.amazon.com/apigateway/latest/api/API_Method.html) in the *API Gateway API Reference*.\n If you specify the ``AuthorizerId`` property, specify ``CUSTOM`` or ``COGNITO_USER_POOLS`` for this property."},"AuthorizerId":{"Type":4,"Flags":0,"Description":"The identifier of an authorizer to use on this method. The method's authorization type must be ``CUSTOM`` or ``COGNITO_USER_POOLS``."},"HttpMethod":{"Type":4,"Flags":17,"Description":"The method's HTTP verb."},"Integration":{"Type":59,"Flags":0,"Description":"Represents an ``HTTP``, ``HTTP_PROXY``, ``AWS``, ``AWS_PROXY``, or Mock integration."},"MethodResponses":{"Type":72,"Flags":0,"Description":"Gets a method response associated with a given HTTP status code."},"OperationName":{"Type":4,"Flags":0,"Description":"A human-friendly operation identifier for the method. For example, you can assign the ``operationName`` of ``ListPets`` for the ``GET /pets`` method in the ``PetStore`` example."},"RequestModels":{"Type":73,"Flags":0,"Description":"A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key)."},"RequestParameters":{"Type":74,"Flags":0,"Description":"A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of ``method.request.{location}.{name}``, where ``location`` is ``querystring``, ``path``, or ``header`` and ``name`` is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (``true``) or optional (``false``). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates."},"RequestValidatorId":{"Type":4,"Flags":0,"Description":"The identifier of a RequestValidator for request validation."},"ResourceId":{"Type":4,"Flags":17,"Description":"The Resource identifier for the MethodResponse resource."},"RestApiId":{"Type":4,"Flags":17,"Description":"The string identifier of the associated RestApi."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":61}},{"2":{"Name":"Method_RequestModels","Properties":{}}},{"2":{"Name":"Method_RequestParameters","Properties":{}}},{"2":{"Name":"AWS.ApiGateway/Method","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":70,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ApiGateway/Method@default","ScopeType":0,"Body":75}},{"2":{"Name":"AWS.ApiGateway/ModelProperties","Properties":{"ContentType":{"Type":4,"Flags":0,"Description":"The content-type for the model."},"Description":{"Type":4,"Flags":0,"Description":"The description of the model."},"Name":{"Type":4,"Flags":16,"Description":"A name for the model. If you don't specify a name, CFN 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 If 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."},"RestApiId":{"Type":4,"Flags":17,"Description":"The string identifier of the associated RestApi."},"Schema":{"Type":79,"Flags":0,"Description":"The schema for the model. For ``application/json`` models, this should be JSON schema draft 4 model. Do not include \"\\*/\" characters in the description of any properties because such \"\\*/\" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail."}}}},{"2":{"Name":"Model_Schema","Properties":{}}},{"5":{"Elements":[78,4]}},{"2":{"Name":"AWS.ApiGateway/Model","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":77,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ApiGateway/Model@default","ScopeType":0,"Body":80}},{"2":{"Name":"AWS.ApiGateway/RequestValidatorProperties","Properties":{"Name":{"Type":4,"Flags":0,"Description":"The name of this RequestValidator"},"RequestValidatorId":{"Type":4,"Flags":18,"Description":""},"RestApiId":{"Type":4,"Flags":17,"Description":"The string identifier of the associated RestApi."},"ValidateRequestBody":{"Type":2,"Flags":0,"Description":"A Boolean flag to indicate whether to validate a request body according to the configured Model schema."},"ValidateRequestParameters":{"Type":2,"Flags":0,"Description":"A Boolean flag to indicate whether to validate request parameters (``true``) or not (``false``)."}}}},{"2":{"Name":"AWS.ApiGateway/RequestValidator","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":82,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ApiGateway/RequestValidator@default","ScopeType":0,"Body":83}},{"2":{"Name":"AWS.ApiGateway/ResourceProperties","Properties":{"ParentId":{"Type":4,"Flags":1,"Description":"The parent resource's identifier."},"PathPart":{"Type":4,"Flags":1,"Description":"The last path segment for this resource."},"ResourceId":{"Type":4,"Flags":18,"Description":""},"RestApiId":{"Type":4,"Flags":17,"Description":"The string identifier of the associated RestApi."}}}},{"2":{"Name":"AWS.ApiGateway/Resource","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":85,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ApiGateway/Resource@default","ScopeType":0,"Body":86}},{"2":{"Name":"EndpointConfiguration","Properties":{"Types":{"Type":91,"Flags":0,"Description":"A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is ``\"EDGE\"``. For a regional API and its custom domain name, the endpoint type is ``REGIONAL``. For a private API, the endpoint type is ``PRIVATE``."},"VpcEndpointIds":{"Type":92,"Flags":0,"Description":"A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for ``PRIVATE`` endpoint type."}}}},{"2":{"Name":"S3Location","Properties":{"Bucket":{"Type":4,"Flags":0,"Description":"The name of the S3 bucket where the OpenAPI file is stored."},"ETag":{"Type":4,"Flags":0,"Description":"The 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."},"Key":{"Type":4,"Flags":0,"Description":"The file name of the OpenAPI file (Amazon S3 object name)."},"Version":{"Type":4,"Flags":0,"Description":"For versioning-enabled buckets, a specific version of the OpenAPI file."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.ApiGateway/RestApiProperties","Properties":{"ApiKeySourceType":{"Type":4,"Flags":0,"Description":"The source of the API key for metering requests according to a usage plan. Valid values are: ``HEADER`` to read the API key from the ``X-API-Key`` header of a request. ``AUTHORIZER`` to read the API key from the ``UsageIdentifierKey`` from a custom authorizer."},"BinaryMediaTypes":{"Type":94,"Flags":0,"Description":"The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads."},"Body":{"Type":96,"Flags":4,"Description":"An OpenAPI specification that defines a set of RESTful APIs in JSON format. For YAML templates, you can also provide the specification in YAML format."},"BodyS3Location":{"Type":89,"Flags":4,"Description":"The Amazon Simple Storage Service (Amazon S3) location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format."},"CloneFrom":{"Type":4,"Flags":4,"Description":"The ID of the RestApi that you want to clone from."},"Description":{"Type":4,"Flags":0,"Description":"The description of the RestApi."},"DisableExecuteApiEndpoint":{"Type":2,"Flags":0,"Description":"Specifies whether clients can invoke your API by using the default ``execute-api`` endpoint. By default, clients can invoke your API with the default ``https://{api_id}.execute-api.{region}.amazonaws.com`` endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint"},"EndpointConfiguration":{"Type":88,"Flags":0,"Description":"A list of the endpoint types of the API. Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the ``Parameters`` property."},"FailOnWarnings":{"Type":2,"Flags":4,"Description":"A query parameter to indicate whether to rollback the API update (``true``) or not (``false``) when a warning is encountered. The default value is ``false``."},"MinimumCompressionSize":{"Type":3,"Flags":0,"Description":"A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size."},"Mode":{"Type":4,"Flags":4,"Description":"This property applies only when you use OpenAPI to define your REST API. The ``Mode`` determines how API Gateway handles resource updates.\n Valid values are ``overwrite`` or ``merge``. \n For ``overwrite``, the new API definition replaces the existing one. The existing API identifier remains unchanged.\n For ``merge``, the new API definition is merged with the existing API.\n If you don't specify this property, a default value is chosen. For REST APIs created before March 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. \n Use 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."},"Name":{"Type":4,"Flags":0,"Description":"The name of the RestApi. A name is required if the REST API is not based on an OpenAPI specification."},"Parameters":{"Type":98,"Flags":4,"Description":"Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ``ignore=documentation`` as a ``parameters`` value, as in the AWS CLI command of ``aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'``."},"Policy":{"Type":100,"Flags":0,"Description":"A policy document that contains the permissions for the ``RestApi`` resource. To set the ARN for the policy, use the ``!Join`` intrinsic function with ``\"\"`` as delimiter and values of ``\"execute-api:/\"`` and ``\"*\"``."},"RestApiId":{"Type":4,"Flags":18,"Description":""},"RootResourceId":{"Type":4,"Flags":2,"Description":""},"Tags":{"Type":101,"Flags":0,"Description":"The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with ``aws:``. The tag value can be up to 256 characters."}}}},{"3":{"ItemType":4}},{"2":{"Name":"RestApi_Body","Properties":{}}},{"5":{"Elements":[95,4]}},{"2":{"Name":"RestApi_Parameters","Properties":{}}},{"5":{"Elements":[97,4]}},{"2":{"Name":"RestApi_Policy","Properties":{}}},{"5":{"Elements":[99,4]}},{"3":{"ItemType":90}},{"2":{"Name":"AWS.ApiGateway/RestApi","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":93,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ApiGateway/RestApi@default","ScopeType":0,"Body":102}},{"2":{"Name":"AccessLogSetting","Properties":{"DestinationArn":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with ``amazon-apigateway-``. This parameter is required to enable access logging."},"Format":{"Type":4,"Flags":0,"Description":"A single line format of the access logs of data, as specified by selected [$context variables](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference). The format must include at least ``$context.requestId``. This parameter is required to enable access logging."}}}},{"2":{"Name":"CanarySetting","Properties":{"DeploymentId":{"Type":4,"Flags":0,"Description":"The ID of the canary deployment."},"PercentTraffic":{"Type":3,"Flags":0,"Description":"The percent (0-100) of traffic diverted to a canary deployment."},"StageVariableOverrides":{"Type":108,"Flags":0,"Description":"Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values."},"UseStageCache":{"Type":2,"Flags":0,"Description":"A Boolean flag to indicate whether the canary deployment uses the stage cache or not."}}}},{"2":{"Name":"MethodSetting","Properties":{"CacheDataEncrypted":{"Type":2,"Flags":0,"Description":"Specifies whether the cached responses are encrypted."},"CacheTtlInSeconds":{"Type":3,"Flags":0,"Description":"Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached."},"CachingEnabled":{"Type":2,"Flags":0,"Description":"Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached."},"DataTraceEnabled":{"Type":2,"Flags":0,"Description":"Specifies 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."},"HttpMethod":{"Type":4,"Flags":0,"Description":"The HTTP method. To apply settings to multiple resources and methods, specify an asterisk (``*``) for the ``HttpMethod`` and ``/*`` for the ``ResourcePath``. This parameter is required when you specify a ``MethodSetting``."},"LoggingLevel":{"Type":4,"Flags":0,"Description":"Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. Valid values are ``OFF``, ``ERROR``, and ``INFO``. Choose ``ERROR`` to write only error-level entries to CloudWatch Logs, or choose ``INFO`` to include all ``ERROR`` events as well as extra informational events."},"MetricsEnabled":{"Type":2,"Flags":0,"Description":"Specifies whether Amazon CloudWatch metrics are enabled for this method."},"ResourcePath":{"Type":4,"Flags":0,"Description":"The resource path for this method. Forward slashes (``/``) are encoded as ``~1`` and the initial slash must include a forward slash. For example, the path value ``/resource/subresource`` must be encoded as ``/~1resource~1subresource``. To specify the root path, use only a slash (``/``). To apply settings to multiple resources and methods, specify an asterisk (``*``) for the ``HttpMethod`` and ``/*`` for the ``ResourcePath``. This parameter is required when you specify a ``MethodSetting``."},"ThrottlingBurstLimit":{"Type":3,"Flags":0,"Description":"Specifies the throttling burst limit."},"ThrottlingRateLimit":{"Type":3,"Flags":0,"Description":"Specifies the throttling rate limit."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:."}}}},{"2":{"Name":"Stage_StageVariableOverrides","Properties":{}}},{"2":{"Name":"AWS.ApiGateway/StageProperties","Properties":{"AccessLogSetting":{"Type":104,"Flags":0,"Description":"Access log settings, including the access log format and access log destination ARN."},"CacheClusterEnabled":{"Type":2,"Flags":0,"Description":"Specifies whether a cache cluster is enabled for the stage."},"CacheClusterSize":{"Type":4,"Flags":0,"Description":"The stage's cache capacity in GB. For more information about choosing a cache size, see [Enabling API caching to enhance responsiveness](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html)."},"CanarySetting":{"Type":105,"Flags":0,"Description":"Settings for the canary deployment in this stage."},"ClientCertificateId":{"Type":4,"Flags":0,"Description":"The identifier of a client certificate for an API stage."},"DeploymentId":{"Type":4,"Flags":0,"Description":"The identifier of the Deployment that the stage points to."},"Description":{"Type":4,"Flags":0,"Description":"The stage's description."},"DocumentationVersion":{"Type":4,"Flags":0,"Description":"The version of the associated API documentation."},"MethodSettings":{"Type":110,"Flags":0,"Description":"A map that defines the method settings for a Stage resource. Keys (designated as ``/{method_setting_key`` below) are method paths defined as ``{resource_path}/{http_method}`` for an individual method override, or ``/\\*/\\*`` for overriding all methods in the stage."},"RestApiId":{"Type":4,"Flags":17,"Description":"The string identifier of the associated RestApi."},"StageName":{"Type":4,"Flags":16,"Description":"The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters."},"Tags":{"Type":111,"Flags":0,"Description":"The collection of tags. Each tag element is associated with a given resource."},"TracingEnabled":{"Type":2,"Flags":0,"Description":"Specifies whether active tracing with X-ray is enabled for the Stage."},"Variables":{"Type":112,"Flags":0,"Description":"A map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value. Variable names are limited to alphanumeric characters. Values must match the following regular expression: ``[A-Za-z0-9-._~:/?#&=,]+``."}}}},{"3":{"ItemType":106}},{"3":{"ItemType":107}},{"2":{"Name":"Stage_Variables","Properties":{}}},{"2":{"Name":"AWS.ApiGateway/Stage","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":109,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ApiGateway/Stage@default","ScopeType":0,"Body":113}},{"2":{"Name":"ApiStage","Properties":{"ApiId":{"Type":4,"Flags":0,"Description":"API Id of the associated API stage in a usage plan."},"Stage":{"Type":4,"Flags":0,"Description":"API stage name of the associated API stage in a usage plan."},"Throttle":{"Type":119,"Flags":0,"Description":"Map containing method level throttling information for API stage in a usage plan."}}}},{"2":{"Name":"QuotaSettings","Properties":{"Limit":{"Type":3,"Flags":0,"Description":"The target maximum number of requests that can be made in a given time period."},"Offset":{"Type":3,"Flags":0,"Description":"The number of requests subtracted from the given limit in the initial time period."},"Period":{"Type":4,"Flags":0,"Description":"The time period in which the limit applies. Valid values are \"DAY\", \"WEEK\" or \"MONTH\"."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"ThrottleSettings","Properties":{"BurstLimit":{"Type":3,"Flags":0,"Description":"The API target request burst rate limit. This allows more requests through for a period of time than the target rate limit."},"RateLimit":{"Type":3,"Flags":0,"Description":"The API target request rate limit."}}}},{"2":{"Name":"UsagePlan_Throttle","Properties":{}}},{"2":{"Name":"AWS.ApiGateway/UsagePlanProperties","Properties":{"ApiStages":{"Type":121,"Flags":0,"Description":"The associated API stages of a usage plan."},"Description":{"Type":4,"Flags":0,"Description":"The description of a usage plan."},"Id":{"Type":4,"Flags":18,"Description":""},"Quota":{"Type":116,"Flags":0,"Description":"The target maximum number of permitted requests per a given unit time interval."},"Tags":{"Type":122,"Flags":0,"Description":"The collection of tags. Each tag element is associated with a given resource."},"Throttle":{"Type":118,"Flags":0,"Description":"A map containing method level throttling information for API stage in a usage plan."},"UsagePlanName":{"Type":4,"Flags":0,"Description":"The name of a usage plan."}}}},{"3":{"ItemType":115}},{"3":{"ItemType":117}},{"2":{"Name":"AWS.ApiGateway/UsagePlan","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":120,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ApiGateway/UsagePlan@default","ScopeType":0,"Body":123}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.ApiGateway/VpcLinkProperties","Properties":{"Description":{"Type":4,"Flags":0,"Description":"A description of the VPC link."},"Name":{"Type":4,"Flags":1,"Description":"A name for the VPC link."},"Tags":{"Type":127,"Flags":0,"Description":"An array of arbitrary tags (key-value pairs) to associate with the stage."},"TargetArns":{"Type":128,"Flags":1,"Description":"The ARN of network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner."},"VpcLinkId":{"Type":4,"Flags":18,"Description":"The ID of the instance that backs VPC link."}}}},{"3":{"ItemType":125}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.ApiGateway/VpcLink","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":126,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ApiGateway/VpcLink@default","ScopeType":0,"Body":129}}] \ No newline at end of file +[ + { + "$type": "StringLiteralType", + "value": "AWS.ApiGateway/AccountProperties" + }, + { + "$type": "StringType" + }, + { + "$type": "ObjectType", + "name": "AWS.ApiGateway/AccountProperties", + "properties": { + "CloudWatchRoleArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The ARN of an Amazon CloudWatch role for the current Account." + }, + "Id": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ApiGateway/Account", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/2" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ApiGateway/Account@default", + "scopeType": 0, + "body": { + "$ref": "#/3" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "StageKey", + "properties": { + "RestApiId": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The string identifier of the associated RestApi." + }, + "StageName": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The stage name associated with the stage key." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.ApiGateway/ApiKeyProperties" + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ObjectType", + "name": "AWS.ApiGateway/ApiKeyProperties", + "properties": { + "APIKeyId": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "" + }, + "CustomerId": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "An MKT customer identifier, when integrating with the AWS SaaS Marketplace." + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The description of the ApiKey." + }, + "Enabled": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "Specifies whether the ApiKey can be used by callers." + }, + "GenerateDistinctId": { + "type": { + "$ref": "#/8" + }, + "flags": 4, + "description": "Specifies whether (``true``) or not (``false``) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used." + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A name for the API key. If you don't specify a name, CFN 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 If 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." + }, + "StageKeys": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key." + }, + "Tags": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with ``aws:``. The tag value can be up to 256 characters." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Specifies a value of the API key." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ApiGateway/ApiKey", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/11" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ApiGateway/ApiKey@default", + "scopeType": 0, + "body": { + "$ref": "#/12" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.ApiGateway/AuthorizerProperties" + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "AWS.ApiGateway/AuthorizerProperties", + "properties": { + "AuthType": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Optional customer-defined field, used in OpenAPI imports and exports without functional impact." + }, + "AuthorizerCredentials": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null." + }, + "AuthorizerId": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "" + }, + "AuthorizerResultTtlInSeconds": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour." + }, + "AuthorizerUri": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Specifies the authorizer's Uniform Resource Identifier (URI). For ``TOKEN`` or ``REQUEST`` authorizers, this must be a well-formed Lambda function URI, for example, ``arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations``. In general, the URI has this form ``arn:aws:apigateway:{region}:lambda:path/{service_api}``, where ``{region}`` is the same as the region hosting the Lambda function, ``path`` indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial ``/``. For Lambda functions, this is usually of the form ``/2015-03-31/functions/[FunctionARN]/invocations``." + }, + "IdentitySource": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The identity source for which authorization is requested. For a ``TOKEN`` or ``COGNITO_USER_POOLS`` authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is ``Auth``, the header mapping expression is ``method.request.header.Auth``. For the ``REQUEST`` authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an ``Auth`` header, a ``Name`` query string parameter are defined as identity sources, this value is ``method.request.header.Auth, method.request.querystring.Name``. These parameters will be used to derive the authorization caching key and to perform runtime validation of the ``REQUEST`` authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional." + }, + "IdentityValidationExpression": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A validation expression for the incoming identity token. For ``TOKEN`` authorizers, this value is a regular expression. For ``COGNITO_USER_POOLS`` authorizers, API Gateway will match the ``aud`` field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the ``REQUEST`` authorizer." + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The name of the authorizer." + }, + "ProviderARNs": { + "type": { + "$ref": "#/16" + }, + "flags": 0, + "description": "A list of the Amazon Cognito user pool ARNs for the ``COGNITO_USER_POOLS`` authorizer. Each element is of this format: ``arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}``. For a ``TOKEN`` or ``REQUEST`` authorizer, this is not defined." + }, + "RestApiId": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The string identifier of the associated RestApi." + }, + "Type": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The authorizer type. Valid values are ``TOKEN`` for a Lambda function using a single authorization token submitted in a custom header, ``REQUEST`` for a Lambda function using incoming request parameters, and ``COGNITO_USER_POOLS`` for using an Amazon Cognito user pool." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ApiGateway/Authorizer", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/17" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ApiGateway/Authorizer@default", + "scopeType": 0, + "body": { + "$ref": "#/18" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.ApiGateway/BasePathMappingProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.ApiGateway/BasePathMappingProperties", + "properties": { + "BasePath": { + "type": { + "$ref": "#/1" + }, + "flags": 16, + "description": "The base path name that callers of the API must provide as part of the URL after the domain name." + }, + "DomainName": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The domain name of the BasePathMapping resource to be described." + }, + "RestApiId": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The string identifier of the associated RestApi." + }, + "Stage": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The name of the associated stage." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ApiGateway/BasePathMapping", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/21" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ApiGateway/BasePathMapping@default", + "scopeType": 0, + "body": { + "$ref": "#/22" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.ApiGateway/ClientCertificateProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/24" + } + }, + { + "$type": "ObjectType", + "name": "AWS.ApiGateway/ClientCertificateProperties", + "properties": { + "ClientCertificateId": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "" + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The description of the client certificate." + }, + "Tags": { + "type": { + "$ref": "#/26" + }, + "flags": 0, + "description": "The collection of tags. Each tag element is associated with a given resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ApiGateway/ClientCertificate", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/27" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ApiGateway/ClientCertificate@default", + "scopeType": 0, + "body": { + "$ref": "#/28" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AccessLogSetting", + "properties": { + "DestinationArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with ``amazon-apigateway-``." + }, + "Format": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A single line format of the access logs of data, as specified by selected $context variables. The format must include at least ``$context.requestId``." + } + } + }, + { + "$type": "ObjectType", + "name": "CanarySetting", + "properties": { + "PercentTraffic": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "The percent (0-100) of traffic diverted to a canary deployment." + }, + "StageVariableOverrides": { + "type": { + "$ref": "#/36" + }, + "flags": 0, + "description": "Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values." + }, + "UseStageCache": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "A Boolean flag to indicate whether the canary deployment uses the stage cache or not." + } + } + }, + { + "$type": "ObjectType", + "name": "DeploymentCanarySettings", + "properties": { + "PercentTraffic": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "The percentage (0.0-100.0) of traffic routed to the canary deployment." + }, + "StageVariableOverrides": { + "type": { + "$ref": "#/37" + }, + "flags": 0, + "description": "A stage variable overrides used for the canary release deployment. They can override existing stage variables or add new stage variables for the canary release deployment. These stage variables are represented as a string-to-string map between stage variable names and their values." + }, + "UseStageCache": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "A Boolean flag to indicate whether the canary release deployment uses the stage cache or not." + } + } + }, + { + "$type": "ObjectType", + "name": "MethodSetting", + "properties": { + "CacheDataEncrypted": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "Specifies whether the cached responses are encrypted." + }, + "CacheTtlInSeconds": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached." + }, + "CachingEnabled": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached." + }, + "DataTraceEnabled": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "Specifies 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." + }, + "HttpMethod": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The HTTP method." + }, + "LoggingLevel": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. Valid values are ``OFF``, ``ERROR``, and ``INFO``. Choose ``ERROR`` to write only error-level entries to CloudWatch Logs, or choose ``INFO`` to include all ``ERROR`` events as well as extra informational events." + }, + "MetricsEnabled": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "Specifies whether Amazon CloudWatch metrics are enabled for this method." + }, + "ResourcePath": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The resource path for this method. Forward slashes (``/``) are encoded as ``~1`` and the initial slash must include a forward slash. For example, the path value ``/resource/subresource`` must be encoded as ``/~1resource~1subresource``. To specify the root path, use only a slash (``/``)." + }, + "ThrottlingBurstLimit": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "Specifies the throttling burst limit." + }, + "ThrottlingRateLimit": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "Specifies the throttling rate limit." + } + } + }, + { + "$type": "ObjectType", + "name": "StageDescription", + "properties": { + "AccessLogSetting": { + "type": { + "$ref": "#/30" + }, + "flags": 0, + "description": "Specifies settings for logging access in this stage." + }, + "CacheClusterEnabled": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "Specifies whether a cache cluster is enabled for the stage." + }, + "CacheClusterSize": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The size of the stage's cache cluster. For more information, see [cacheClusterSize](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateStage.html#apigw-CreateStage-request-cacheClusterSize) in the *API Gateway API Reference*." + }, + "CacheDataEncrypted": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "Indicates whether the cached responses are encrypted." + }, + "CacheTtlInSeconds": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses." + }, + "CachingEnabled": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "Indicates whether responses are cached and returned for requests. You must enable a cache cluster on the stage to cache responses. For more information, see [Enable API Gateway Caching in a Stage to Enhance API Performance](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html) in the *API Gateway Developer Guide*." + }, + "CanarySetting": { + "type": { + "$ref": "#/31" + }, + "flags": 0, + "description": "Specifies settings for the canary deployment in this stage." + }, + "ClientCertificateId": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage." + }, + "DataTraceEnabled": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "Indicates whether data trace logging is enabled for methods in the stage. API Gateway pushes these logs to Amazon CloudWatch Logs." + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A description of the purpose of the stage." + }, + "DocumentationVersion": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The version identifier of the API documentation snapshot." + }, + "LoggingLevel": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The logging level for this method. For valid values, see the ``loggingLevel`` property of the [MethodSetting](https://docs.aws.amazon.com/apigateway/latest/api/API_MethodSetting.html) resource in the *Amazon API Gateway API Reference*." + }, + "MethodSettings": { + "type": { + "$ref": "#/38" + }, + "flags": 0, + "description": "Configures settings for all of the stage's methods." + }, + "MetricsEnabled": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage." + }, + "Tags": { + "type": { + "$ref": "#/39" + }, + "flags": 0, + "description": "An array of arbitrary tags (key-value pairs) to associate with the stage." + }, + "ThrottlingBurstLimit": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "The target request burst rate limit. This allows more requests through for a period of time than the target rate limit. For more information, see [Manage API Request Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html) in the *API Gateway Developer Guide*." + }, + "ThrottlingRateLimit": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "The target request steady-state rate limit. For more information, see [Manage API Request Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html) in the *API Gateway Developer Guide*." + }, + "TracingEnabled": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "Specifies whether active tracing with X-ray is enabled for this stage.\n For more information, see [Trace API Gateway API Execution with X-Ray](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-xray.html) in the *API Gateway Developer Guide*." + }, + "Variables": { + "type": { + "$ref": "#/40" + }, + "flags": 0, + "description": "A map that defines the stage variables. Variable names must consist of alphanumeric characters, and the values must match the following regular expression: ``[A-Za-z0-9-._~:/?#&=,]+``." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag" + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for the tag" + } + } + }, + { + "$type": "ObjectType", + "name": "Deployment_StageVariableOverrides", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Deployment_StageVariableOverrides", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/33" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/35" + } + }, + { + "$type": "ObjectType", + "name": "Deployment_Variables", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.ApiGateway/DeploymentProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.ApiGateway/DeploymentProperties", + "properties": { + "DeploymentCanarySettings": { + "type": { + "$ref": "#/32" + }, + "flags": 4, + "description": "The input configuration for a canary deployment." + }, + "DeploymentId": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "" + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The description for the Deployment resource to create." + }, + "RestApiId": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The string identifier of the associated RestApi." + }, + "StageDescription": { + "type": { + "$ref": "#/34" + }, + "flags": 4, + "description": "The description of the Stage resource for the Deployment resource to create. To specify a stage description, you must also provide a stage name." + }, + "StageName": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The name of the Stage resource for the Deployment resource to create." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ApiGateway/Deployment", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/42" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ApiGateway/Deployment@default", + "scopeType": 0, + "body": { + "$ref": "#/43" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Location", + "properties": { + "Method": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The HTTP verb of a method. It is a valid field for the API entity types of ``METHOD``, ``PATH_PARAMETER``, ``QUERY_PARAMETER``, ``REQUEST_HEADER``, ``REQUEST_BODY``, ``RESPONSE``, ``RESPONSE_HEADER``, and ``RESPONSE_BODY``. The default value is ``*`` for any method. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other ``location`` attributes, the child entity's ``method`` attribute must match that of the parent entity exactly." + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The name of the targeted API entity. It is a valid and required field for the API entity types of ``AUTHORIZER``, ``MODEL``, ``PATH_PARAMETER``, ``QUERY_PARAMETER``, ``REQUEST_HEADER``, ``REQUEST_BODY`` and ``RESPONSE_HEADER``. It is an invalid field for any other entity type." + }, + "Path": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The URL path of the target. It is a valid field for the API entity types of ``RESOURCE``, ``METHOD``, ``PATH_PARAMETER``, ``QUERY_PARAMETER``, ``REQUEST_HEADER``, ``REQUEST_BODY``, ``RESPONSE``, ``RESPONSE_HEADER``, and ``RESPONSE_BODY``. The default value is ``/`` for the root resource. When an applicable child entity inherits the content of another entity of the same type with more general specifications of the other ``location`` attributes, the child entity's ``path`` attribute must match that of the parent entity as a prefix." + }, + "StatusCode": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The HTTP status code of a response. It is a valid field for the API entity types of ``RESPONSE``, ``RESPONSE_HEADER``, and ``RESPONSE_BODY``. The default value is ``*`` for any status code. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other ``location`` attributes, the child entity's ``statusCode`` attribute must match that of the parent entity exactly." + }, + "Type": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The type of API entity to which the documentation content applies. Valid values are ``API``, ``AUTHORIZER``, ``MODEL``, ``RESOURCE``, ``METHOD``, ``PATH_PARAMETER``, ``QUERY_PARAMETER``, ``REQUEST_HEADER``, ``REQUEST_BODY``, ``RESPONSE``, ``RESPONSE_HEADER``, and ``RESPONSE_BODY``. Content inheritance does not apply to any entity of the ``API``, ``AUTHORIZER``, ``METHOD``, ``MODEL``, ``REQUEST_BODY``, or ``RESOURCE`` type." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.ApiGateway/DocumentationPartProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.ApiGateway/DocumentationPartProperties", + "properties": { + "DocumentationPartId": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "" + }, + "Location": { + "type": { + "$ref": "#/45" + }, + "flags": 1, + "description": "The location of the targeted API entity of the to-be-created documentation part." + }, + "Properties": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published." + }, + "RestApiId": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The string identifier of the associated RestApi." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ApiGateway/DocumentationPart", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/47" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ApiGateway/DocumentationPart@default", + "scopeType": 0, + "body": { + "$ref": "#/48" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.ApiGateway/DocumentationVersionProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.ApiGateway/DocumentationVersionProperties", + "properties": { + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A description about the new documentation snapshot." + }, + "DocumentationVersion": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The version identifier of the to-be-updated documentation version." + }, + "RestApiId": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The string identifier of the associated RestApi." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ApiGateway/DocumentationVersion", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/51" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ApiGateway/DocumentationVersion@default", + "scopeType": 0, + "body": { + "$ref": "#/52" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "EndpointConfiguration", + "properties": { + "Types": { + "type": { + "$ref": "#/57" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "MutualTlsAuthentication", + "properties": { + "TruststoreUri": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "TruststoreVersion": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.ApiGateway/DomainNameProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/56" + } + }, + { + "$type": "ObjectType", + "name": "AWS.ApiGateway/DomainNameProperties", + "properties": { + "CertificateArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "DistributionDomainName": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "DistributionHostedZoneId": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "DomainName": { + "type": { + "$ref": "#/1" + }, + "flags": 16 + }, + "EndpointConfiguration": { + "type": { + "$ref": "#/54" + }, + "flags": 0 + }, + "MutualTlsAuthentication": { + "type": { + "$ref": "#/55" + }, + "flags": 0 + }, + "OwnershipVerificationCertificateArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "RegionalCertificateArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "RegionalDomainName": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "RegionalHostedZoneId": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "SecurityPolicy": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/59" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ApiGateway/DomainName", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/60" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ApiGateway/DomainName@default", + "scopeType": 0, + "body": { + "$ref": "#/61" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.ApiGateway/GatewayResponseProperties" + }, + { + "$type": "ObjectType", + "name": "GatewayResponse_ResponseParameters", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "GatewayResponse_ResponseTemplates", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AWS.ApiGateway/GatewayResponseProperties", + "properties": { + "Id": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "" + }, + "ResponseParameters": { + "type": { + "$ref": "#/64" + }, + "flags": 0, + "description": "Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs." + }, + "ResponseTemplates": { + "type": { + "$ref": "#/65" + }, + "flags": 0, + "description": "Response templates of the GatewayResponse as a string-to-string map of key-value pairs." + }, + "ResponseType": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The response type of the associated GatewayResponse." + }, + "RestApiId": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The string identifier of the associated RestApi." + }, + "StatusCode": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The HTTP status code for this GatewayResponse." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ApiGateway/GatewayResponse", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/66" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ApiGateway/GatewayResponse@default", + "scopeType": 0, + "body": { + "$ref": "#/67" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Integration", + "properties": { + "CacheKeyParameters": { + "type": { + "$ref": "#/72" + }, + "flags": 0, + "description": "A list of request parameters whose values API Gateway caches. To be valid values for ``cacheKeyParameters``, these parameters must also be specified for Method ``requestParameters``." + }, + "CacheNamespace": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the ``cacheNamespace``. You can specify the same ``cacheNamespace`` across resources to return the same cached data for requests to different resources." + }, + "ConnectionId": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The ID of the VpcLink used for the integration when ``connectionType=VPC_LINK`` and undefined, otherwise." + }, + "ConnectionType": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The type of the network connection to the integration endpoint. The valid value is ``INTERNET`` for connections through the public routable internet or ``VPC_LINK`` for private connections between API Gateway and a network load balancer in a VPC. The default value is ``INTERNET``." + }, + "ContentHandling": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Specifies how to handle request payload content type conversions. Supported values are ``CONVERT_TO_BINARY`` and ``CONVERT_TO_TEXT``, with the following behaviors:\n If 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." + }, + "Credentials": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string ``arn:aws:iam::\\*:user/\\*``. To use resource-based permissions on supported AWS services, specify null." + }, + "IntegrationHttpMethod": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Specifies the integration's HTTP method type. For the Type property, if you specify ``MOCK``, this property is optional. For Lambda integrations, you must set the integration method to ``POST``. For all other types, you must specify this property." + }, + "IntegrationResponses": { + "type": { + "$ref": "#/73" + }, + "flags": 0, + "description": "Specifies the integration's responses." + }, + "PassthroughBehavior": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in ``requestTemplates``. The valid value is one of the following: ``WHEN_NO_MATCH``: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request. ``WHEN_NO_TEMPLATES``: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response. ``NEVER``: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request." + }, + "RequestParameters": { + "type": { + "$ref": "#/74" + }, + "flags": 0, + "description": "A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of ``method.request.{location}.{name}``, where ``location`` is ``querystring``, ``path``, or ``header`` and ``name`` must be a valid and unique method request parameter name." + }, + "RequestTemplates": { + "type": { + "$ref": "#/75" + }, + "flags": 0, + "description": "Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value." + }, + "TimeoutInMillis": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds." + }, + "Type": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Specifies an API method integration type. The valid value is one of the following:\n For 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." + }, + "Uri": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Specifies Uniform Resource Identifier (URI) of the integration endpoint.\n For ``HTTP`` or ``HTTP_PROXY`` integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification for standard integrations. If ``connectionType`` is ``VPC_LINK`` specify the Network Load Balancer DNS name. For ``AWS`` or ``AWS_PROXY`` integrations, the URI is of the form ``arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}``. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either ``arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}`` or ``arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}``" + } + } + }, + { + "$type": "ObjectType", + "name": "IntegrationResponse", + "properties": { + "ContentHandling": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Specifies how to handle response payload content type conversions. Supported values are ``CONVERT_TO_BINARY`` and ``CONVERT_TO_TEXT``, with the following behaviors:\n If this property is not defined, the response payload will be passed through from the integration response to the method response without modification." + }, + "ResponseParameters": { + "type": { + "$ref": "#/76" + }, + "flags": 0, + "description": "A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of ``method.response.header.{name}``, where ``name`` is a valid and unique header name. The mapped non-static value must match the pattern of ``integration.response.header.{name}`` or ``integration.response.body.{JSON-expression}``, where ``name`` is a valid and unique response header name and ``JSON-expression`` is a valid JSON expression without the ``$`` prefix." + }, + "ResponseTemplates": { + "type": { + "$ref": "#/77" + }, + "flags": 0, + "description": "Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value." + }, + "SelectionPattern": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the ``.+`` regex to match error response. However, make sure that the error response does not contain any newline (``\\n``) character in such cases. If the back end is an LAMlong function, the LAMlong function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched." + }, + "StatusCode": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Specifies the status code that is used to map the integration response to an existing MethodResponse." + } + } + }, + { + "$type": "ObjectType", + "name": "MethodResponse", + "properties": { + "ResponseModels": { + "type": { + "$ref": "#/78" + }, + "flags": 0, + "description": "Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value." + }, + "ResponseParameters": { + "type": { + "$ref": "#/79" + }, + "flags": 0, + "description": "A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern ``method.response.header.{name}``, where ``name`` is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in ``integration.response.header.{name}``, a static value enclosed within a pair of single quotes (e.g., ``'application/json'``), or a JSON expression from the back-end response payload in the form of ``integration.response.body.{JSON-expression}``, where ``JSON-expression`` is a valid JSON expression without the ``$`` prefix.)" + }, + "StatusCode": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The method response's status code." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/70" + } + }, + { + "$type": "ObjectType", + "name": "Method_RequestParameters", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Method_RequestTemplates", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Method_ResponseParameters", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Method_ResponseTemplates", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Method_ResponseModels", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Method_ResponseParameters", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.ApiGateway/MethodProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/71" + } + }, + { + "$type": "ObjectType", + "name": "Method_RequestModels", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Method_RequestParameters", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AWS.ApiGateway/MethodProperties", + "properties": { + "ApiKeyRequired": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "A boolean flag specifying whether a valid ApiKey is required to invoke this method." + }, + "AuthorizationScopes": { + "type": { + "$ref": "#/81" + }, + "flags": 0, + "description": "A list of authorization scopes configured on the method. The scopes are used with a ``COGNITO_USER_POOLS`` authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes." + }, + "AuthorizationType": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The method's authorization type. This parameter is required. For valid values, see [Method](https://docs.aws.amazon.com/apigateway/latest/api/API_Method.html) in the *API Gateway API Reference*.\n If you specify the ``AuthorizerId`` property, specify ``CUSTOM`` or ``COGNITO_USER_POOLS`` for this property." + }, + "AuthorizerId": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The identifier of an authorizer to use on this method. The method's authorization type must be ``CUSTOM`` or ``COGNITO_USER_POOLS``." + }, + "HttpMethod": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The method's HTTP verb." + }, + "Integration": { + "type": { + "$ref": "#/69" + }, + "flags": 0, + "description": "Represents an ``HTTP``, ``HTTP_PROXY``, ``AWS``, ``AWS_PROXY``, or Mock integration." + }, + "MethodResponses": { + "type": { + "$ref": "#/82" + }, + "flags": 0, + "description": "Gets a method response associated with a given HTTP status code." + }, + "OperationName": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A human-friendly operation identifier for the method. For example, you can assign the ``operationName`` of ``ListPets`` for the ``GET /pets`` method in the ``PetStore`` example." + }, + "RequestModels": { + "type": { + "$ref": "#/83" + }, + "flags": 0, + "description": "A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key)." + }, + "RequestParameters": { + "type": { + "$ref": "#/84" + }, + "flags": 0, + "description": "A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of ``method.request.{location}.{name}``, where ``location`` is ``querystring``, ``path``, or ``header`` and ``name`` is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (``true``) or optional (``false``). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates." + }, + "RequestValidatorId": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The identifier of a RequestValidator for request validation." + }, + "ResourceId": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The Resource identifier for the MethodResponse resource." + }, + "RestApiId": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The string identifier of the associated RestApi." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ApiGateway/Method", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/85" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ApiGateway/Method@default", + "scopeType": 0, + "body": { + "$ref": "#/86" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.ApiGateway/ModelProperties" + }, + { + "$type": "ObjectType", + "name": "Model_Schema", + "properties": {} + }, + { + "$type": "UnionType", + "elements": [ + { + "$ref": "#/89" + }, + { + "$ref": "#/1" + } + ] + }, + { + "$type": "ObjectType", + "name": "AWS.ApiGateway/ModelProperties", + "properties": { + "ContentType": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The content-type for the model." + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The description of the model." + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 16, + "description": "A name for the model. If you don't specify a name, CFN 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 If 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." + }, + "RestApiId": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The string identifier of the associated RestApi." + }, + "Schema": { + "type": { + "$ref": "#/90" + }, + "flags": 0, + "description": "The schema for the model. For ``application/json`` models, this should be JSON schema draft 4 model. Do not include \"\\*/\" characters in the description of any properties because such \"\\*/\" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ApiGateway/Model", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/91" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ApiGateway/Model@default", + "scopeType": 0, + "body": { + "$ref": "#/92" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.ApiGateway/RequestValidatorProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.ApiGateway/RequestValidatorProperties", + "properties": { + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The name of this RequestValidator" + }, + "RequestValidatorId": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "" + }, + "RestApiId": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The string identifier of the associated RestApi." + }, + "ValidateRequestBody": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "A Boolean flag to indicate whether to validate a request body according to the configured Model schema." + }, + "ValidateRequestParameters": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "A Boolean flag to indicate whether to validate request parameters (``true``) or not (``false``)." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ApiGateway/RequestValidator", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/95" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ApiGateway/RequestValidator@default", + "scopeType": 0, + "body": { + "$ref": "#/96" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.ApiGateway/ResourceProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.ApiGateway/ResourceProperties", + "properties": { + "ParentId": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The parent resource's identifier." + }, + "PathPart": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The last path segment for this resource." + }, + "ResourceId": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "" + }, + "RestApiId": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The string identifier of the associated RestApi." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ApiGateway/Resource", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/99" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ApiGateway/Resource@default", + "scopeType": 0, + "body": { + "$ref": "#/100" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "EndpointConfiguration", + "properties": { + "Types": { + "type": { + "$ref": "#/105" + }, + "flags": 0, + "description": "A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is ``\"EDGE\"``. For a regional API and its custom domain name, the endpoint type is ``REGIONAL``. For a private API, the endpoint type is ``PRIVATE``." + }, + "VpcEndpointIds": { + "type": { + "$ref": "#/106" + }, + "flags": 0, + "description": "A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for ``PRIVATE`` endpoint type." + } + } + }, + { + "$type": "ObjectType", + "name": "S3Location", + "properties": { + "Bucket": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The name of the S3 bucket where the OpenAPI file is stored." + }, + "ETag": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The 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." + }, + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The file name of the OpenAPI file (Amazon S3 object name)." + }, + "Version": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "For versioning-enabled buckets, a specific version of the OpenAPI file." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.ApiGateway/RestApiProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "RestApi_Body", + "properties": {} + }, + { + "$type": "UnionType", + "elements": [ + { + "$ref": "#/109" + }, + { + "$ref": "#/1" + } + ] + }, + { + "$type": "ObjectType", + "name": "RestApi_Parameters", + "properties": {} + }, + { + "$type": "UnionType", + "elements": [ + { + "$ref": "#/111" + }, + { + "$ref": "#/1" + } + ] + }, + { + "$type": "ObjectType", + "name": "RestApi_Policy", + "properties": {} + }, + { + "$type": "UnionType", + "elements": [ + { + "$ref": "#/113" + }, + { + "$ref": "#/1" + } + ] + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/104" + } + }, + { + "$type": "ObjectType", + "name": "AWS.ApiGateway/RestApiProperties", + "properties": { + "ApiKeySourceType": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The source of the API key for metering requests according to a usage plan. Valid values are: ``HEADER`` to read the API key from the ``X-API-Key`` header of a request. ``AUTHORIZER`` to read the API key from the ``UsageIdentifierKey`` from a custom authorizer." + }, + "BinaryMediaTypes": { + "type": { + "$ref": "#/108" + }, + "flags": 0, + "description": "The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads." + }, + "Body": { + "type": { + "$ref": "#/110" + }, + "flags": 4, + "description": "An OpenAPI specification that defines a set of RESTful APIs in JSON format. For YAML templates, you can also provide the specification in YAML format." + }, + "BodyS3Location": { + "type": { + "$ref": "#/103" + }, + "flags": 4, + "description": "The Amazon Simple Storage Service (Amazon S3) location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format." + }, + "CloneFrom": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The ID of the RestApi that you want to clone from." + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The description of the RestApi." + }, + "DisableExecuteApiEndpoint": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "Specifies whether clients can invoke your API by using the default ``execute-api`` endpoint. By default, clients can invoke your API with the default ``https://{api_id}.execute-api.{region}.amazonaws.com`` endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint" + }, + "EndpointConfiguration": { + "type": { + "$ref": "#/102" + }, + "flags": 0, + "description": "A list of the endpoint types of the API. Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the ``Parameters`` property." + }, + "FailOnWarnings": { + "type": { + "$ref": "#/8" + }, + "flags": 4, + "description": "A query parameter to indicate whether to rollback the API update (``true``) or not (``false``) when a warning is encountered. The default value is ``false``." + }, + "MinimumCompressionSize": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size." + }, + "Mode": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "This property applies only when you use OpenAPI to define your REST API. The ``Mode`` determines how API Gateway handles resource updates.\n Valid values are ``overwrite`` or ``merge``. \n For ``overwrite``, the new API definition replaces the existing one. The existing API identifier remains unchanged.\n For ``merge``, the new API definition is merged with the existing API.\n If you don't specify this property, a default value is chosen. For REST APIs created before March 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. \n Use 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." + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The name of the RestApi. A name is required if the REST API is not based on an OpenAPI specification." + }, + "Parameters": { + "type": { + "$ref": "#/112" + }, + "flags": 4, + "description": "Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ``ignore=documentation`` as a ``parameters`` value, as in the AWS CLI command of ``aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'``." + }, + "Policy": { + "type": { + "$ref": "#/114" + }, + "flags": 0, + "description": "A policy document that contains the permissions for the ``RestApi`` resource. To set the ARN for the policy, use the ``!Join`` intrinsic function with ``\"\"`` as delimiter and values of ``\"execute-api:/\"`` and ``\"*\"``." + }, + "RestApiId": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "" + }, + "RootResourceId": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "" + }, + "Tags": { + "type": { + "$ref": "#/115" + }, + "flags": 0, + "description": "The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with ``aws:``. The tag value can be up to 256 characters." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ApiGateway/RestApi", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/116" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ApiGateway/RestApi@default", + "scopeType": 0, + "body": { + "$ref": "#/117" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AccessLogSetting", + "properties": { + "DestinationArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with ``amazon-apigateway-``. This parameter is required to enable access logging." + }, + "Format": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A single line format of the access logs of data, as specified by selected [$context variables](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference). The format must include at least ``$context.requestId``. This parameter is required to enable access logging." + } + } + }, + { + "$type": "ObjectType", + "name": "CanarySetting", + "properties": { + "DeploymentId": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The ID of the canary deployment." + }, + "PercentTraffic": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "The percent (0-100) of traffic diverted to a canary deployment." + }, + "StageVariableOverrides": { + "type": { + "$ref": "#/123" + }, + "flags": 0, + "description": "Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values." + }, + "UseStageCache": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "A Boolean flag to indicate whether the canary deployment uses the stage cache or not." + } + } + }, + { + "$type": "ObjectType", + "name": "MethodSetting", + "properties": { + "CacheDataEncrypted": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "Specifies whether the cached responses are encrypted." + }, + "CacheTtlInSeconds": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached." + }, + "CachingEnabled": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached." + }, + "DataTraceEnabled": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "Specifies 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." + }, + "HttpMethod": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The HTTP method. To apply settings to multiple resources and methods, specify an asterisk (``*``) for the ``HttpMethod`` and ``/*`` for the ``ResourcePath``. This parameter is required when you specify a ``MethodSetting``." + }, + "LoggingLevel": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. Valid values are ``OFF``, ``ERROR``, and ``INFO``. Choose ``ERROR`` to write only error-level entries to CloudWatch Logs, or choose ``INFO`` to include all ``ERROR`` events as well as extra informational events." + }, + "MetricsEnabled": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "Specifies whether Amazon CloudWatch metrics are enabled for this method." + }, + "ResourcePath": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The resource path for this method. Forward slashes (``/``) are encoded as ``~1`` and the initial slash must include a forward slash. For example, the path value ``/resource/subresource`` must be encoded as ``/~1resource~1subresource``. To specify the root path, use only a slash (``/``). To apply settings to multiple resources and methods, specify an asterisk (``*``) for the ``HttpMethod`` and ``/*`` for the ``ResourcePath``. This parameter is required when you specify a ``MethodSetting``." + }, + "ThrottlingBurstLimit": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "Specifies the throttling burst limit." + }, + "ThrottlingRateLimit": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "Specifies the throttling rate limit." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:." + } + } + }, + { + "$type": "ObjectType", + "name": "Stage_StageVariableOverrides", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.ApiGateway/StageProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/121" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/122" + } + }, + { + "$type": "ObjectType", + "name": "Stage_Variables", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AWS.ApiGateway/StageProperties", + "properties": { + "AccessLogSetting": { + "type": { + "$ref": "#/119" + }, + "flags": 0, + "description": "Access log settings, including the access log format and access log destination ARN." + }, + "CacheClusterEnabled": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "Specifies whether a cache cluster is enabled for the stage." + }, + "CacheClusterSize": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The stage's cache capacity in GB. For more information about choosing a cache size, see [Enabling API caching to enhance responsiveness](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html)." + }, + "CanarySetting": { + "type": { + "$ref": "#/120" + }, + "flags": 0, + "description": "Settings for the canary deployment in this stage." + }, + "ClientCertificateId": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The identifier of a client certificate for an API stage." + }, + "DeploymentId": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The identifier of the Deployment that the stage points to." + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The stage's description." + }, + "DocumentationVersion": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The version of the associated API documentation." + }, + "MethodSettings": { + "type": { + "$ref": "#/125" + }, + "flags": 0, + "description": "A map that defines the method settings for a Stage resource. Keys (designated as ``/{method_setting_key`` below) are method paths defined as ``{resource_path}/{http_method}`` for an individual method override, or ``/\\*/\\*`` for overriding all methods in the stage." + }, + "RestApiId": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The string identifier of the associated RestApi." + }, + "StageName": { + "type": { + "$ref": "#/1" + }, + "flags": 16, + "description": "The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters." + }, + "Tags": { + "type": { + "$ref": "#/126" + }, + "flags": 0, + "description": "The collection of tags. Each tag element is associated with a given resource." + }, + "TracingEnabled": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "Specifies whether active tracing with X-ray is enabled for the Stage." + }, + "Variables": { + "type": { + "$ref": "#/127" + }, + "flags": 0, + "description": "A map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value. Variable names are limited to alphanumeric characters. Values must match the following regular expression: ``[A-Za-z0-9-._~:/?#&=,]+``." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ApiGateway/Stage", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/128" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ApiGateway/Stage@default", + "scopeType": 0, + "body": { + "$ref": "#/129" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "ApiStage", + "properties": { + "ApiId": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "API Id of the associated API stage in a usage plan." + }, + "Stage": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "API stage name of the associated API stage in a usage plan." + }, + "Throttle": { + "type": { + "$ref": "#/135" + }, + "flags": 0, + "description": "Map containing method level throttling information for API stage in a usage plan." + } + } + }, + { + "$type": "ObjectType", + "name": "QuotaSettings", + "properties": { + "Limit": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "The target maximum number of requests that can be made in a given time period." + }, + "Offset": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "The number of requests subtracted from the given limit in the initial time period." + }, + "Period": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The time period in which the limit applies. Valid values are \"DAY\", \"WEEK\" or \"MONTH\"." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "ObjectType", + "name": "ThrottleSettings", + "properties": { + "BurstLimit": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "The API target request burst rate limit. This allows more requests through for a period of time than the target rate limit." + }, + "RateLimit": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "The API target request rate limit." + } + } + }, + { + "$type": "ObjectType", + "name": "UsagePlan_Throttle", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.ApiGateway/UsagePlanProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/131" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/133" + } + }, + { + "$type": "ObjectType", + "name": "AWS.ApiGateway/UsagePlanProperties", + "properties": { + "ApiStages": { + "type": { + "$ref": "#/137" + }, + "flags": 0, + "description": "The associated API stages of a usage plan." + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The description of a usage plan." + }, + "Id": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "" + }, + "Quota": { + "type": { + "$ref": "#/132" + }, + "flags": 0, + "description": "The target maximum number of permitted requests per a given unit time interval." + }, + "Tags": { + "type": { + "$ref": "#/138" + }, + "flags": 0, + "description": "The collection of tags. Each tag element is associated with a given resource." + }, + "Throttle": { + "type": { + "$ref": "#/134" + }, + "flags": 0, + "description": "A map containing method level throttling information for API stage in a usage plan." + }, + "UsagePlanName": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The name of a usage plan." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ApiGateway/UsagePlan", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/139" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ApiGateway/UsagePlan@default", + "scopeType": 0, + "body": { + "$ref": "#/140" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.ApiGateway/VpcLinkProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/142" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "AWS.ApiGateway/VpcLinkProperties", + "properties": { + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The description of the VPC link." + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The name used to label and identify the VPC link." + }, + "Tags": { + "type": { + "$ref": "#/144" + }, + "flags": 0, + "description": "An array of arbitrary tags (key-value pairs) to associate with the VPC link." + }, + "TargetArns": { + "type": { + "$ref": "#/145" + }, + "flags": 1, + "description": "The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS-account of the API owner." + }, + "VpcLinkId": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ApiGateway/VpcLink", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/146" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ApiGateway/VpcLink@default", + "scopeType": 0, + "body": { + "$ref": "#/147" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.apigateway/default/types.md b/artifacts/bicep/aws/aws.apigateway/default/types.md index 9d29ff19..0d13f645 100644 --- a/artifacts/bicep/aws/aws.apigateway/default/types.md +++ b/artifacts/bicep/aws/aws.apigateway/default/types.md @@ -3,121 +3,144 @@ ## Resource AWS.ApiGateway/Account@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ApiGateway/AccountProperties](#awsapigatewayaccountproperties): properties of the resource +* **properties**: [AWS.ApiGateway/AccountProperties](#awsapigatewayaccountproperties) (Identifier): properties of the resource ## Resource AWS.ApiGateway/ApiKey@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ApiGateway/ApiKeyProperties](#awsapigatewayapikeyproperties): properties of the resource +* **properties**: [AWS.ApiGateway/ApiKeyProperties](#awsapigatewayapikeyproperties) (Identifier): properties of the resource ## Resource AWS.ApiGateway/Authorizer@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ApiGateway/AuthorizerProperties](#awsapigatewayauthorizerproperties) (Required): properties of the resource +* **properties**: [AWS.ApiGateway/AuthorizerProperties](#awsapigatewayauthorizerproperties) (Required, Identifier): properties of the resource ## Resource AWS.ApiGateway/BasePathMapping@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ApiGateway/BasePathMappingProperties](#awsapigatewaybasepathmappingproperties) (Required): properties of the resource +* **properties**: [AWS.ApiGateway/BasePathMappingProperties](#awsapigatewaybasepathmappingproperties) (Required, Identifier): properties of the resource ## Resource AWS.ApiGateway/ClientCertificate@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ApiGateway/ClientCertificateProperties](#awsapigatewayclientcertificateproperties): properties of the resource +* **properties**: [AWS.ApiGateway/ClientCertificateProperties](#awsapigatewayclientcertificateproperties) (Identifier): properties of the resource ## Resource AWS.ApiGateway/Deployment@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ApiGateway/DeploymentProperties](#awsapigatewaydeploymentproperties) (Required): properties of the resource +* **properties**: [AWS.ApiGateway/DeploymentProperties](#awsapigatewaydeploymentproperties) (Required, Identifier): properties of the resource ## Resource AWS.ApiGateway/DocumentationPart@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ApiGateway/DocumentationPartProperties](#awsapigatewaydocumentationpartproperties) (Required): properties of the resource +* **properties**: [AWS.ApiGateway/DocumentationPartProperties](#awsapigatewaydocumentationpartproperties) (Required, Identifier): properties of the resource ## Resource AWS.ApiGateway/DocumentationVersion@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ApiGateway/DocumentationVersionProperties](#awsapigatewaydocumentationversionproperties) (Required): properties of the resource +* **properties**: [AWS.ApiGateway/DocumentationVersionProperties](#awsapigatewaydocumentationversionproperties) (Required, Identifier): properties of the resource ## Resource AWS.ApiGateway/DomainName@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ApiGateway/DomainNameProperties](#awsapigatewaydomainnameproperties): properties of the resource +* **properties**: [AWS.ApiGateway/DomainNameProperties](#awsapigatewaydomainnameproperties) (Identifier): properties of the resource + +## Resource AWS.ApiGateway/GatewayResponse@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.ApiGateway/GatewayResponseProperties](#awsapigatewaygatewayresponseproperties) (Required, Identifier): properties of the resource ## Resource AWS.ApiGateway/Method@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ApiGateway/MethodProperties](#awsapigatewaymethodproperties) (Required): properties of the resource +* **properties**: [AWS.ApiGateway/MethodProperties](#awsapigatewaymethodproperties) (Required, Identifier): properties of the resource ## Resource AWS.ApiGateway/Model@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ApiGateway/ModelProperties](#awsapigatewaymodelproperties) (Required): properties of the resource +* **properties**: [AWS.ApiGateway/ModelProperties](#awsapigatewaymodelproperties) (Required, Identifier): properties of the resource ## Resource AWS.ApiGateway/RequestValidator@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ApiGateway/RequestValidatorProperties](#awsapigatewayrequestvalidatorproperties) (Required): properties of the resource +* **properties**: [AWS.ApiGateway/RequestValidatorProperties](#awsapigatewayrequestvalidatorproperties) (Required, Identifier): properties of the resource ## Resource AWS.ApiGateway/Resource@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ApiGateway/ResourceProperties](#awsapigatewayresourceproperties) (Required): properties of the resource +* **properties**: [AWS.ApiGateway/ResourceProperties](#awsapigatewayresourceproperties) (Required, Identifier): properties of the resource ## Resource AWS.ApiGateway/RestApi@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ApiGateway/RestApiProperties](#awsapigatewayrestapiproperties): properties of the resource +* **properties**: [AWS.ApiGateway/RestApiProperties](#awsapigatewayrestapiproperties) (Identifier): properties of the resource ## Resource AWS.ApiGateway/Stage@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ApiGateway/StageProperties](#awsapigatewaystageproperties) (Required): properties of the resource +* **properties**: [AWS.ApiGateway/StageProperties](#awsapigatewaystageproperties) (Required, Identifier): properties of the resource ## Resource AWS.ApiGateway/UsagePlan@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ApiGateway/UsagePlanProperties](#awsapigatewayusageplanproperties): properties of the resource +* **properties**: [AWS.ApiGateway/UsagePlanProperties](#awsapigatewayusageplanproperties) (Identifier): properties of the resource ## Resource AWS.ApiGateway/VpcLink@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ApiGateway/VpcLinkProperties](#awsapigatewayvpclinkproperties) (Required): properties of the resource +* **properties**: [AWS.ApiGateway/VpcLinkProperties](#awsapigatewayvpclinkproperties) (Required, Identifier): properties of the resource + +## AccessLogSetting +### Properties +* **DestinationArn**: string: The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with ``amazon-apigateway-``. +* **Format**: string: A single line format of the access logs of data, as specified by selected $context variables. The format must include at least ``$context.requestId``. + +## AccessLogSetting +### Properties +* **DestinationArn**: string: The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with ``amazon-apigateway-``. This parameter is required to enable access logging. +* **Format**: string: A single line format of the access logs of data, as specified by selected [$context variables](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference). The format must include at least ``$context.requestId``. This parameter is required to enable access logging. + +## ApiStage +### Properties +* **ApiId**: string: API Id of the associated API stage in a usage plan. +* **Stage**: string: API stage name of the associated API stage in a usage plan. +* **Throttle**: [UsagePlan_Throttle](#usageplanthrottle): Map containing method level throttling information for API stage in a usage plan. ## AWS.ApiGateway/AccountProperties ### Properties @@ -137,16 +160,6 @@ * **Tags**: [Tag](#tag)[]: The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with ``aws:``. The tag value can be up to 256 characters. * **Value**: string: Specifies a value of the API key. -## StageKey -### Properties -* **RestApiId**: string: The string identifier of the associated RestApi. -* **StageName**: string: The stage name associated with the stage key. - -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## AWS.ApiGateway/AuthorizerProperties ### Properties * **AuthorizerCredentials**: string: Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null. @@ -174,11 +187,6 @@ * **Description**: string: The description of the client certificate. * **Tags**: [Tag](#tag)[]: The collection of tags. Each tag element is associated with a given resource. -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - ## AWS.ApiGateway/DeploymentProperties ### Properties * **DeploymentCanarySettings**: [DeploymentCanarySettings](#deploymentcanarysettings) (WriteOnly): The input configuration for a canary deployment. @@ -188,73 +196,6 @@ * **StageDescription**: [StageDescription](#stagedescription) (WriteOnly): The description of the Stage resource for the Deployment resource to create. To specify a stage description, you must also provide a stage name. * **StageName**: string (WriteOnly): The name of the Stage resource for the Deployment resource to create. -## DeploymentCanarySettings -### Properties -* **PercentTraffic**: int: The percentage (0.0-100.0) of traffic routed to the canary deployment. -* **StageVariableOverrides**: [Deployment_StageVariableOverrides](#deploymentstagevariableoverrides): A stage variable overrides used for the canary release deployment. They can override existing stage variables or add new stage variables for the canary release deployment. These stage variables are represented as a string-to-string map between stage variable names and their values. -* **UseStageCache**: bool: A Boolean flag to indicate whether the canary release deployment uses the stage cache or not. - -## Deployment_StageVariableOverrides -### Properties - -## StageDescription -### Properties -* **AccessLogSetting**: [AccessLogSetting](#accesslogsetting): Specifies settings for logging access in this stage. -* **CacheClusterEnabled**: bool: Specifies whether a cache cluster is enabled for the stage. -* **CacheClusterSize**: string: The size of the stage's cache cluster. For more information, see [cacheClusterSize](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateStage.html#apigw-CreateStage-request-cacheClusterSize) in the *API Gateway API Reference*. -* **CacheDataEncrypted**: bool: Indicates whether the cached responses are encrypted. -* **CacheTtlInSeconds**: int: The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses. -* **CachingEnabled**: bool: Indicates whether responses are cached and returned for requests. You must enable a cache cluster on the stage to cache responses. For more information, see [Enable API Gateway Caching in a Stage to Enhance API Performance](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html) in the *API Gateway Developer Guide*. -* **CanarySetting**: [CanarySetting](#canarysetting): Specifies settings for the canary deployment in this stage. -* **ClientCertificateId**: string: The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage. -* **DataTraceEnabled**: bool: Indicates whether data trace logging is enabled for methods in the stage. API Gateway pushes these logs to Amazon CloudWatch Logs. -* **Description**: string: A description of the purpose of the stage. -* **DocumentationVersion**: string: The version identifier of the API documentation snapshot. -* **LoggingLevel**: string: The logging level for this method. For valid values, see the ``loggingLevel`` property of the [MethodSetting](https://docs.aws.amazon.com/apigateway/latest/api/API_MethodSetting.html) resource in the *Amazon API Gateway API Reference*. -* **MethodSettings**: [MethodSetting](#methodsetting)[]: Configures settings for all of the stage's methods. -* **MetricsEnabled**: bool: Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage. -* **Tags**: [Tag](#tag)[]: An array of arbitrary tags (key-value pairs) to associate with the stage. -* **ThrottlingBurstLimit**: int: The target request burst rate limit. This allows more requests through for a period of time than the target rate limit. For more information, see [Manage API Request Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html) in the *API Gateway Developer Guide*. -* **ThrottlingRateLimit**: int: The target request steady-state rate limit. For more information, see [Manage API Request Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html) in the *API Gateway Developer Guide*. -* **TracingEnabled**: bool: Specifies whether active tracing with X-ray is enabled for this stage. - For more information, see [Trace API Gateway API Execution with X-Ray](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-xray.html) in the *API Gateway Developer Guide*. -* **Variables**: [Deployment_Variables](#deploymentvariables): A map that defines the stage variables. Variable names must consist of alphanumeric characters, and the values must match the following regular expression: ``[A-Za-z0-9-._~:/?#&=,]+``. - -## AccessLogSetting -### Properties -* **DestinationArn**: string: The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with ``amazon-apigateway-``. -* **Format**: string: A single line format of the access logs of data, as specified by selected $context variables. The format must include at least ``$context.requestId``. - -## CanarySetting -### Properties -* **PercentTraffic**: int: The percent (0-100) of traffic diverted to a canary deployment. -* **StageVariableOverrides**: [Deployment_StageVariableOverrides](#deploymentstagevariableoverrides): Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values. -* **UseStageCache**: bool: A Boolean flag to indicate whether the canary deployment uses the stage cache or not. - -## Deployment_StageVariableOverrides -### Properties - -## MethodSetting -### Properties -* **CacheDataEncrypted**: bool: Specifies whether the cached responses are encrypted. -* **CacheTtlInSeconds**: int: Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached. -* **CachingEnabled**: bool: Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached. -* **DataTraceEnabled**: bool: Specifies 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. -* **HttpMethod**: string: The HTTP method. -* **LoggingLevel**: string: Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. Valid values are ``OFF``, ``ERROR``, and ``INFO``. Choose ``ERROR`` to write only error-level entries to CloudWatch Logs, or choose ``INFO`` to include all ``ERROR`` events as well as extra informational events. -* **MetricsEnabled**: bool: Specifies whether Amazon CloudWatch metrics are enabled for this method. -* **ResourcePath**: string: The resource path for this method. Forward slashes (``/``) are encoded as ``~1`` and the initial slash must include a forward slash. For example, the path value ``/resource/subresource`` must be encoded as ``/~1resource~1subresource``. To specify the root path, use only a slash (``/``). -* **ThrottlingBurstLimit**: int: Specifies the throttling burst limit. -* **ThrottlingRateLimit**: int: Specifies the throttling rate limit. - -## Tag -### Properties -* **Key**: string (Required): The key name of the tag -* **Value**: string (Required): The value for the tag - -## Deployment_Variables -### Properties - ## AWS.ApiGateway/DocumentationPartProperties ### Properties * **DocumentationPartId**: string (ReadOnly, Identifier) @@ -262,14 +203,6 @@ * **Properties**: string (Required): The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published. * **RestApiId**: string (Required, Identifier): The string identifier of the associated RestApi. -## Location -### Properties -* **Method**: string: The HTTP verb of a method. It is a valid field for the API entity types of ``METHOD``, ``PATH_PARAMETER``, ``QUERY_PARAMETER``, ``REQUEST_HEADER``, ``REQUEST_BODY``, ``RESPONSE``, ``RESPONSE_HEADER``, and ``RESPONSE_BODY``. The default value is ``*`` for any method. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other ``location`` attributes, the child entity's ``method`` attribute must match that of the parent entity exactly. -* **Name**: string: The name of the targeted API entity. It is a valid and required field for the API entity types of ``AUTHORIZER``, ``MODEL``, ``PATH_PARAMETER``, ``QUERY_PARAMETER``, ``REQUEST_HEADER``, ``REQUEST_BODY`` and ``RESPONSE_HEADER``. It is an invalid field for any other entity type. -* **Path**: string: The URL path of the target. It is a valid field for the API entity types of ``RESOURCE``, ``METHOD``, ``PATH_PARAMETER``, ``QUERY_PARAMETER``, ``REQUEST_HEADER``, ``REQUEST_BODY``, ``RESPONSE``, ``RESPONSE_HEADER``, and ``RESPONSE_BODY``. The default value is ``/`` for the root resource. When an applicable child entity inherits the content of another entity of the same type with more general specifications of the other ``location`` attributes, the child entity's ``path`` attribute must match that of the parent entity as a prefix. -* **StatusCode**: string: The HTTP status code of a response. It is a valid field for the API entity types of ``RESPONSE``, ``RESPONSE_HEADER``, and ``RESPONSE_BODY``. The default value is ``*`` for any status code. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other ``location`` attributes, the child entity's ``statusCode`` attribute must match that of the parent entity exactly. -* **Type**: string: The type of API entity to which the documentation content applies. Valid values are ``API``, ``AUTHORIZER``, ``MODEL``, ``RESOURCE``, ``METHOD``, ``PATH_PARAMETER``, ``QUERY_PARAMETER``, ``REQUEST_HEADER``, ``REQUEST_BODY``, ``RESPONSE``, ``RESPONSE_HEADER``, and ``RESPONSE_BODY``. Content inheritance does not apply to any entity of the ``API``, ``AUTHORIZER``, ``METHOD``, ``MODEL``, ``REQUEST_BODY``, or ``RESOURCE`` type. - ## AWS.ApiGateway/DocumentationVersionProperties ### Properties * **Description**: string: A description about the new documentation snapshot. @@ -291,19 +224,14 @@ * **SecurityPolicy**: string * **Tags**: [Tag](#tag)[] -## EndpointConfiguration -### Properties -* **Types**: string[] - -## MutualTlsAuthentication +## AWS.ApiGateway/GatewayResponseProperties ### Properties -* **TruststoreUri**: string -* **TruststoreVersion**: string - -## Tag -### Properties -* **Key**: string -* **Value**: string +* **Id**: string (ReadOnly, Identifier) +* **ResponseParameters**: [GatewayResponse_ResponseParameters](#gatewayresponseresponseparameters): Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs. +* **ResponseTemplates**: [GatewayResponse_ResponseTemplates](#gatewayresponseresponsetemplates): Response templates of the GatewayResponse as a string-to-string map of key-value pairs. +* **ResponseType**: string (Required): The response type of the associated GatewayResponse. +* **RestApiId**: string (Required): The string identifier of the associated RestApi. +* **StatusCode**: string: The HTTP status code for this GatewayResponse. ## AWS.ApiGateway/MethodProperties ### Properties @@ -322,65 +250,6 @@ * **ResourceId**: string (Required, Identifier): The Resource identifier for the MethodResponse resource. * **RestApiId**: string (Required, Identifier): The string identifier of the associated RestApi. -## Integration -### Properties -* **CacheKeyParameters**: string[]: A list of request parameters whose values API Gateway caches. To be valid values for ``cacheKeyParameters``, these parameters must also be specified for Method ``requestParameters``. -* **CacheNamespace**: string: Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the ``cacheNamespace``. You can specify the same ``cacheNamespace`` across resources to return the same cached data for requests to different resources. -* **ConnectionId**: string: The ID of the VpcLink used for the integration when ``connectionType=VPC_LINK`` and undefined, otherwise. -* **ConnectionType**: string: The type of the network connection to the integration endpoint. The valid value is ``INTERNET`` for connections through the public routable internet or ``VPC_LINK`` for private connections between API Gateway and a network load balancer in a VPC. The default value is ``INTERNET``. -* **ContentHandling**: string: Specifies how to handle request payload content type conversions. Supported values are ``CONVERT_TO_BINARY`` and ``CONVERT_TO_TEXT``, with the following behaviors: - If 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. -* **Credentials**: string: Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string ``arn:aws:iam::\*:user/\*``. To use resource-based permissions on supported AWS services, specify null. -* **IntegrationHttpMethod**: string: Specifies the integration's HTTP method type. For the Type property, if you specify ``MOCK``, this property is optional. For Lambda integrations, you must set the integration method to ``POST``. For all other types, you must specify this property. -* **IntegrationResponses**: [IntegrationResponse](#integrationresponse)[]: Specifies the integration's responses. -* **PassthroughBehavior**: string: Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in ``requestTemplates``. The valid value is one of the following: ``WHEN_NO_MATCH``: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request. ``WHEN_NO_TEMPLATES``: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response. ``NEVER``: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request. -* **RequestParameters**: [Method_RequestParameters](#methodrequestparameters): A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of ``method.request.{location}.{name}``, where ``location`` is ``querystring``, ``path``, or ``header`` and ``name`` must be a valid and unique method request parameter name. -* **RequestTemplates**: [Method_RequestTemplates](#methodrequesttemplates): Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. -* **TimeoutInMillis**: int: Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds. -* **Type**: string (Required): Specifies an API method integration type. The valid value is one of the following: - For 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. -* **Uri**: string: Specifies Uniform Resource Identifier (URI) of the integration endpoint. - For ``HTTP`` or ``HTTP_PROXY`` integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification for standard integrations. If ``connectionType`` is ``VPC_LINK`` specify the Network Load Balancer DNS name. For ``AWS`` or ``AWS_PROXY`` integrations, the URI is of the form ``arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}``. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either ``arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}`` or ``arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}`` - -## IntegrationResponse -### Properties -* **ContentHandling**: string: Specifies how to handle response payload content type conversions. Supported values are ``CONVERT_TO_BINARY`` and ``CONVERT_TO_TEXT``, with the following behaviors: - If this property is not defined, the response payload will be passed through from the integration response to the method response without modification. -* **ResponseParameters**: [Method_ResponseParameters](#methodresponseparameters): A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of ``method.response.header.{name}``, where ``name`` is a valid and unique header name. The mapped non-static value must match the pattern of ``integration.response.header.{name}`` or ``integration.response.body.{JSON-expression}``, where ``name`` is a valid and unique response header name and ``JSON-expression`` is a valid JSON expression without the ``$`` prefix. -* **ResponseTemplates**: [Method_ResponseTemplates](#methodresponsetemplates): Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value. -* **SelectionPattern**: string: Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the ``.+`` regex to match error response. However, make sure that the error response does not contain any newline (``\n``) character in such cases. If the back end is an LAMlong function, the LAMlong function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched. -* **StatusCode**: string (Required): Specifies the status code that is used to map the integration response to an existing MethodResponse. - -## Method_ResponseParameters -### Properties - -## Method_ResponseTemplates -### Properties - -## Method_RequestParameters -### Properties - -## Method_RequestTemplates -### Properties - -## MethodResponse -### Properties -* **ResponseModels**: [Method_ResponseModels](#methodresponsemodels): Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value. -* **ResponseParameters**: [Method_ResponseParameters](#methodresponseparameters): A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern ``method.response.header.{name}``, where ``name`` is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in ``integration.response.header.{name}``, a static value enclosed within a pair of single quotes (e.g., ``'application/json'``), or a JSON expression from the back-end response payload in the form of ``integration.response.body.{JSON-expression}``, where ``JSON-expression`` is a valid JSON expression without the ``$`` prefix.) -* **StatusCode**: string (Required): The method response's status code. - -## Method_ResponseModels -### Properties - -## Method_ResponseParameters -### Properties - -## Method_RequestModels -### Properties - -## Method_RequestParameters -### Properties - ## AWS.ApiGateway/ModelProperties ### Properties * **ContentType**: string: The content-type for the model. @@ -430,23 +299,6 @@ * **RootResourceId**: string (ReadOnly) * **Tags**: [Tag](#tag)[]: The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with ``aws:``. The tag value can be up to 256 characters. -## S3Location -### Properties -* **Bucket**: string: The name of the S3 bucket where the OpenAPI file is stored. -* **ETag**: string: The 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. -* **Key**: string: The file name of the OpenAPI file (Amazon S3 object name). -* **Version**: string: For versioning-enabled buckets, a specific version of the OpenAPI file. - -## EndpointConfiguration -### Properties -* **Types**: string[]: A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is ``"EDGE"``. For a regional API and its custom domain name, the endpoint type is ``REGIONAL``. For a private API, the endpoint type is ``PRIVATE``. -* **VpcEndpointIds**: string[]: A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for ``PRIVATE`` endpoint type. - -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - ## AWS.ApiGateway/StageProperties ### Properties * **AccessLogSetting**: [AccessLogSetting](#accesslogsetting): Access log settings, including the access log format and access log destination ARN. @@ -464,10 +316,29 @@ * **TracingEnabled**: bool: Specifies whether active tracing with X-ray is enabled for the Stage. * **Variables**: [Stage_Variables](#stagevariables): A map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value. Variable names are limited to alphanumeric characters. Values must match the following regular expression: ``[A-Za-z0-9-._~:/?#&=,]+``. -## AccessLogSetting +## AWS.ApiGateway/UsagePlanProperties ### Properties -* **DestinationArn**: string: The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with ``amazon-apigateway-``. This parameter is required to enable access logging. -* **Format**: string: A single line format of the access logs of data, as specified by selected [$context variables](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference). The format must include at least ``$context.requestId``. This parameter is required to enable access logging. +* **ApiStages**: [ApiStage](#apistage)[]: The associated API stages of a usage plan. +* **Description**: string: The description of a usage plan. +* **Id**: string (ReadOnly, Identifier) +* **Quota**: [QuotaSettings](#quotasettings): The target maximum number of permitted requests per a given unit time interval. +* **Tags**: [Tag](#tag)[]: The collection of tags. Each tag element is associated with a given resource. +* **Throttle**: [ThrottleSettings](#throttlesettings): A map containing method level throttling information for API stage in a usage plan. +* **UsagePlanName**: string: The name of a usage plan. + +## AWS.ApiGateway/VpcLinkProperties +### Properties +* **Description**: string: The description of the VPC link. +* **Name**: string (Required): The name used to label and identify the VPC link. +* **Tags**: [Tag](#tag)[]: An array of arbitrary tags (key-value pairs) to associate with the VPC link. +* **TargetArns**: string[] (Required): The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS-account of the API owner. +* **VpcLinkId**: string (ReadOnly, Identifier) + +## CanarySetting +### Properties +* **PercentTraffic**: int: The percent (0-100) of traffic diverted to a canary deployment. +* **StageVariableOverrides**: [Deployment_StageVariableOverrides](#deploymentstagevariableoverrides): Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values. +* **UseStageCache**: bool: A Boolean flag to indicate whether the canary deployment uses the stage cache or not. ## CanarySetting ### Properties @@ -476,8 +347,115 @@ * **StageVariableOverrides**: [Stage_StageVariableOverrides](#stagestagevariableoverrides): Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values. * **UseStageCache**: bool: A Boolean flag to indicate whether the canary deployment uses the stage cache or not. -## Stage_StageVariableOverrides +## Deployment_StageVariableOverrides +### Properties + +## Deployment_StageVariableOverrides +### Properties + +## Deployment_Variables +### Properties + +## DeploymentCanarySettings +### Properties +* **PercentTraffic**: int: The percentage (0.0-100.0) of traffic routed to the canary deployment. +* **StageVariableOverrides**: [Deployment_StageVariableOverrides](#deploymentstagevariableoverrides): A stage variable overrides used for the canary release deployment. They can override existing stage variables or add new stage variables for the canary release deployment. These stage variables are represented as a string-to-string map between stage variable names and their values. +* **UseStageCache**: bool: A Boolean flag to indicate whether the canary release deployment uses the stage cache or not. + +## EndpointConfiguration +### Properties +* **Types**: string[] + +## EndpointConfiguration +### Properties +* **Types**: string[]: A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is ``"EDGE"``. For a regional API and its custom domain name, the endpoint type is ``REGIONAL``. For a private API, the endpoint type is ``PRIVATE``. +* **VpcEndpointIds**: string[]: A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for ``PRIVATE`` endpoint type. + +## GatewayResponse_ResponseParameters +### Properties + +## GatewayResponse_ResponseTemplates +### Properties + +## Integration ### Properties +* **CacheKeyParameters**: string[]: A list of request parameters whose values API Gateway caches. To be valid values for ``cacheKeyParameters``, these parameters must also be specified for Method ``requestParameters``. +* **CacheNamespace**: string: Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the ``cacheNamespace``. You can specify the same ``cacheNamespace`` across resources to return the same cached data for requests to different resources. +* **ConnectionId**: string: The ID of the VpcLink used for the integration when ``connectionType=VPC_LINK`` and undefined, otherwise. +* **ConnectionType**: string: The type of the network connection to the integration endpoint. The valid value is ``INTERNET`` for connections through the public routable internet or ``VPC_LINK`` for private connections between API Gateway and a network load balancer in a VPC. The default value is ``INTERNET``. +* **ContentHandling**: string: Specifies how to handle request payload content type conversions. Supported values are ``CONVERT_TO_BINARY`` and ``CONVERT_TO_TEXT``, with the following behaviors: + If 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. +* **Credentials**: string: Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string ``arn:aws:iam::\*:user/\*``. To use resource-based permissions on supported AWS services, specify null. +* **IntegrationHttpMethod**: string: Specifies the integration's HTTP method type. For the Type property, if you specify ``MOCK``, this property is optional. For Lambda integrations, you must set the integration method to ``POST``. For all other types, you must specify this property. +* **IntegrationResponses**: [IntegrationResponse](#integrationresponse)[]: Specifies the integration's responses. +* **PassthroughBehavior**: string: Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in ``requestTemplates``. The valid value is one of the following: ``WHEN_NO_MATCH``: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request. ``WHEN_NO_TEMPLATES``: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response. ``NEVER``: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request. +* **RequestParameters**: [Method_RequestParameters](#methodrequestparameters): A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of ``method.request.{location}.{name}``, where ``location`` is ``querystring``, ``path``, or ``header`` and ``name`` must be a valid and unique method request parameter name. +* **RequestTemplates**: [Method_RequestTemplates](#methodrequesttemplates): Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. +* **TimeoutInMillis**: int: Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds. +* **Type**: string (Required): Specifies an API method integration type. The valid value is one of the following: + For 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. +* **Uri**: string: Specifies Uniform Resource Identifier (URI) of the integration endpoint. + For ``HTTP`` or ``HTTP_PROXY`` integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification for standard integrations. If ``connectionType`` is ``VPC_LINK`` specify the Network Load Balancer DNS name. For ``AWS`` or ``AWS_PROXY`` integrations, the URI is of the form ``arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}``. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either ``arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}`` or ``arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}`` + +## IntegrationResponse +### Properties +* **ContentHandling**: string: Specifies how to handle response payload content type conversions. Supported values are ``CONVERT_TO_BINARY`` and ``CONVERT_TO_TEXT``, with the following behaviors: + If this property is not defined, the response payload will be passed through from the integration response to the method response without modification. +* **ResponseParameters**: [Method_ResponseParameters](#methodresponseparameters): A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of ``method.response.header.{name}``, where ``name`` is a valid and unique header name. The mapped non-static value must match the pattern of ``integration.response.header.{name}`` or ``integration.response.body.{JSON-expression}``, where ``name`` is a valid and unique response header name and ``JSON-expression`` is a valid JSON expression without the ``$`` prefix. +* **ResponseTemplates**: [Method_ResponseTemplates](#methodresponsetemplates): Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value. +* **SelectionPattern**: string: Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the ``.+`` regex to match error response. However, make sure that the error response does not contain any newline (``\n``) character in such cases. If the back end is an LAMlong function, the LAMlong function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched. +* **StatusCode**: string (Required): Specifies the status code that is used to map the integration response to an existing MethodResponse. + +## Location +### Properties +* **Method**: string: The HTTP verb of a method. It is a valid field for the API entity types of ``METHOD``, ``PATH_PARAMETER``, ``QUERY_PARAMETER``, ``REQUEST_HEADER``, ``REQUEST_BODY``, ``RESPONSE``, ``RESPONSE_HEADER``, and ``RESPONSE_BODY``. The default value is ``*`` for any method. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other ``location`` attributes, the child entity's ``method`` attribute must match that of the parent entity exactly. +* **Name**: string: The name of the targeted API entity. It is a valid and required field for the API entity types of ``AUTHORIZER``, ``MODEL``, ``PATH_PARAMETER``, ``QUERY_PARAMETER``, ``REQUEST_HEADER``, ``REQUEST_BODY`` and ``RESPONSE_HEADER``. It is an invalid field for any other entity type. +* **Path**: string: The URL path of the target. It is a valid field for the API entity types of ``RESOURCE``, ``METHOD``, ``PATH_PARAMETER``, ``QUERY_PARAMETER``, ``REQUEST_HEADER``, ``REQUEST_BODY``, ``RESPONSE``, ``RESPONSE_HEADER``, and ``RESPONSE_BODY``. The default value is ``/`` for the root resource. When an applicable child entity inherits the content of another entity of the same type with more general specifications of the other ``location`` attributes, the child entity's ``path`` attribute must match that of the parent entity as a prefix. +* **StatusCode**: string: The HTTP status code of a response. It is a valid field for the API entity types of ``RESPONSE``, ``RESPONSE_HEADER``, and ``RESPONSE_BODY``. The default value is ``*`` for any status code. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other ``location`` attributes, the child entity's ``statusCode`` attribute must match that of the parent entity exactly. +* **Type**: string: The type of API entity to which the documentation content applies. Valid values are ``API``, ``AUTHORIZER``, ``MODEL``, ``RESOURCE``, ``METHOD``, ``PATH_PARAMETER``, ``QUERY_PARAMETER``, ``REQUEST_HEADER``, ``REQUEST_BODY``, ``RESPONSE``, ``RESPONSE_HEADER``, and ``RESPONSE_BODY``. Content inheritance does not apply to any entity of the ``API``, ``AUTHORIZER``, ``METHOD``, ``MODEL``, ``REQUEST_BODY``, or ``RESOURCE`` type. + +## Method_RequestModels +### Properties + +## Method_RequestParameters +### Properties + +## Method_RequestParameters +### Properties + +## Method_RequestTemplates +### Properties + +## Method_ResponseModels +### Properties + +## Method_ResponseParameters +### Properties + +## Method_ResponseParameters +### Properties + +## Method_ResponseTemplates +### Properties + +## MethodResponse +### Properties +* **ResponseModels**: [Method_ResponseModels](#methodresponsemodels): Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value. +* **ResponseParameters**: [Method_ResponseParameters](#methodresponseparameters): A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern ``method.response.header.{name}``, where ``name`` is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in ``integration.response.header.{name}``, a static value enclosed within a pair of single quotes (e.g., ``'application/json'``), or a JSON expression from the back-end response payload in the form of ``integration.response.body.{JSON-expression}``, where ``JSON-expression`` is a valid JSON expression without the ``$`` prefix.) +* **StatusCode**: string (Required): The method response's status code. + +## MethodSetting +### Properties +* **CacheDataEncrypted**: bool: Specifies whether the cached responses are encrypted. +* **CacheTtlInSeconds**: int: Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached. +* **CachingEnabled**: bool: Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached. +* **DataTraceEnabled**: bool: Specifies 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. +* **HttpMethod**: string: The HTTP method. +* **LoggingLevel**: string: Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. Valid values are ``OFF``, ``ERROR``, and ``INFO``. Choose ``ERROR`` to write only error-level entries to CloudWatch Logs, or choose ``INFO`` to include all ``ERROR`` events as well as extra informational events. +* **MetricsEnabled**: bool: Specifies whether Amazon CloudWatch metrics are enabled for this method. +* **ResourcePath**: string: The resource path for this method. Forward slashes (``/``) are encoded as ``~1`` and the initial slash must include a forward slash. For example, the path value ``/resource/subresource`` must be encoded as ``/~1resource~1subresource``. To specify the root path, use only a slash (``/``). +* **ThrottlingBurstLimit**: int: Specifies the throttling burst limit. +* **ThrottlingRateLimit**: int: Specifies the throttling rate limit. ## MethodSetting ### Properties @@ -492,59 +470,103 @@ * **ThrottlingBurstLimit**: int: Specifies the throttling burst limit. * **ThrottlingRateLimit**: int: Specifies the throttling rate limit. -## Tag +## MutualTlsAuthentication ### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. +* **TruststoreUri**: string +* **TruststoreVersion**: string -## Stage_Variables +## QuotaSettings ### Properties +* **Limit**: int: The target maximum number of requests that can be made in a given time period. +* **Offset**: int: The number of requests subtracted from the given limit in the initial time period. +* **Period**: string: The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH". -## AWS.ApiGateway/UsagePlanProperties +## S3Location ### Properties -* **ApiStages**: [ApiStage](#apistage)[]: The associated API stages of a usage plan. -* **Description**: string: The description of a usage plan. -* **Id**: string (ReadOnly, Identifier) -* **Quota**: [QuotaSettings](#quotasettings): The target maximum number of permitted requests per a given unit time interval. -* **Tags**: [Tag](#tag)[]: The collection of tags. Each tag element is associated with a given resource. -* **Throttle**: [ThrottleSettings](#throttlesettings): A map containing method level throttling information for API stage in a usage plan. -* **UsagePlanName**: string: The name of a usage plan. +* **Bucket**: string: The name of the S3 bucket where the OpenAPI file is stored. +* **ETag**: string: The 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. +* **Key**: string: The file name of the OpenAPI file (Amazon S3 object name). +* **Version**: string: For versioning-enabled buckets, a specific version of the OpenAPI file. -## ApiStage +## Stage_StageVariableOverrides ### Properties -* **ApiId**: string: API Id of the associated API stage in a usage plan. -* **Stage**: string: API stage name of the associated API stage in a usage plan. -* **Throttle**: [UsagePlan_Throttle](#usageplanthrottle): Map containing method level throttling information for API stage in a usage plan. -## UsagePlan_Throttle +## Stage_Variables ### Properties -## QuotaSettings +## StageDescription ### Properties -* **Limit**: int: The target maximum number of requests that can be made in a given time period. -* **Offset**: int: The number of requests subtracted from the given limit in the initial time period. -* **Period**: string: The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH". +* **AccessLogSetting**: [AccessLogSetting](#accesslogsetting): Specifies settings for logging access in this stage. +* **CacheClusterEnabled**: bool: Specifies whether a cache cluster is enabled for the stage. +* **CacheClusterSize**: string: The size of the stage's cache cluster. For more information, see [cacheClusterSize](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateStage.html#apigw-CreateStage-request-cacheClusterSize) in the *API Gateway API Reference*. +* **CacheDataEncrypted**: bool: Indicates whether the cached responses are encrypted. +* **CacheTtlInSeconds**: int: The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses. +* **CachingEnabled**: bool: Indicates whether responses are cached and returned for requests. You must enable a cache cluster on the stage to cache responses. For more information, see [Enable API Gateway Caching in a Stage to Enhance API Performance](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html) in the *API Gateway Developer Guide*. +* **CanarySetting**: [CanarySetting](#canarysetting): Specifies settings for the canary deployment in this stage. +* **ClientCertificateId**: string: The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage. +* **DataTraceEnabled**: bool: Indicates whether data trace logging is enabled for methods in the stage. API Gateway pushes these logs to Amazon CloudWatch Logs. +* **Description**: string: A description of the purpose of the stage. +* **DocumentationVersion**: string: The version identifier of the API documentation snapshot. +* **LoggingLevel**: string: The logging level for this method. For valid values, see the ``loggingLevel`` property of the [MethodSetting](https://docs.aws.amazon.com/apigateway/latest/api/API_MethodSetting.html) resource in the *Amazon API Gateway API Reference*. +* **MethodSettings**: [MethodSetting](#methodsetting)[]: Configures settings for all of the stage's methods. +* **MetricsEnabled**: bool: Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage. +* **Tags**: [Tag](#tag)[]: An array of arbitrary tags (key-value pairs) to associate with the stage. +* **ThrottlingBurstLimit**: int: The target request burst rate limit. This allows more requests through for a period of time than the target rate limit. For more information, see [Manage API Request Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html) in the *API Gateway Developer Guide*. +* **ThrottlingRateLimit**: int: The target request steady-state rate limit. For more information, see [Manage API Request Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html) in the *API Gateway Developer Guide*. +* **TracingEnabled**: bool: Specifies whether active tracing with X-ray is enabled for this stage. + For more information, see [Trace API Gateway API Execution with X-Ray](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-xray.html) in the *API Gateway Developer Guide*. +* **Variables**: [Deployment_Variables](#deploymentvariables): A map that defines the stage variables. Variable names must consist of alphanumeric characters, and the values must match the following regular expression: ``[A-Za-z0-9-._~:/?#&=,]+``. + +## StageKey +### Properties +* **RestApiId**: string: The string identifier of the associated RestApi. +* **StageName**: string: The stage name associated with the stage key. ## Tag ### Properties * **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -## ThrottleSettings +## Tag ### Properties -* **BurstLimit**: int: The API target request burst rate limit. This allows more requests through for a period of time than the target rate limit. -* **RateLimit**: int: The API target request rate limit. +* **Key**: string (Required) +* **Value**: string (Required) -## AWS.ApiGateway/VpcLinkProperties +## Tag ### Properties -* **Description**: string: A description of the VPC link. -* **Name**: string (Required): A name for the VPC link. -* **Tags**: [Tag](#tag)[]: An array of arbitrary tags (key-value pairs) to associate with the stage. -* **TargetArns**: string[] (Required): The ARN of network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner. -* **VpcLinkId**: string (ReadOnly, Identifier): The ID of the instance that backs VPC link. +* **Key**: string (Required): The key name of the tag +* **Value**: string (Required): The value for the tag + +## Tag +### Properties +* **Key**: string +* **Value**: string + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ## Tag ### Properties * **Key**: string (Required) * **Value**: string (Required) +## ThrottleSettings +### Properties +* **BurstLimit**: int: The API target request burst rate limit. This allows more requests through for a period of time than the target rate limit. +* **RateLimit**: int: The API target request rate limit. + +## UsagePlan_Throttle +### Properties + diff --git a/artifacts/bicep/aws/aws.apigatewayv2/default/types.json b/artifacts/bicep/aws/aws.apigatewayv2/default/types.json index 2e4ffe35..ac994af2 100644 --- a/artifacts/bicep/aws/aws.apigatewayv2/default/types.json +++ b/artifacts/bicep/aws/aws.apigatewayv2/default/types.json @@ -1 +1,1552 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"BodyS3Location","Properties":{"Bucket":{"Type":4,"Flags":4,"Description":"The S3 bucket that contains the OpenAPI definition to import. Required if you specify a ``BodyS3Location`` for an API."},"Etag":{"Type":4,"Flags":4,"Description":"The Etag of the S3 object."},"Key":{"Type":4,"Flags":4,"Description":"The key of the S3 object. Required if you specify a ``BodyS3Location`` for an API."},"Version":{"Type":4,"Flags":4,"Description":"The version of the S3 object."}}}},{"2":{"Name":"Cors","Properties":{"AllowCredentials":{"Type":2,"Flags":0,"Description":"Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs."},"AllowHeaders":{"Type":10,"Flags":0,"Description":"Represents a collection of allowed headers. Supported only for HTTP APIs."},"AllowMethods":{"Type":11,"Flags":0,"Description":"Represents a collection of allowed HTTP methods. Supported only for HTTP APIs."},"AllowOrigins":{"Type":12,"Flags":0,"Description":"Represents a collection of allowed origins. Supported only for HTTP APIs."},"ExposeHeaders":{"Type":13,"Flags":0,"Description":"Represents a collection of exposed headers. Supported only for HTTP APIs."},"MaxAge":{"Type":3,"Flags":0,"Description":"The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.ApiGatewayV2/ApiProperties","Properties":{"ApiEndpoint":{"Type":4,"Flags":2,"Description":""},"ApiId":{"Type":4,"Flags":18,"Description":""},"ApiKeySelectionExpression":{"Type":4,"Flags":0,"Description":"An API key selection expression. Supported only for WebSocket APIs. See [API Key Selection Expressions](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions)."},"BasePath":{"Type":4,"Flags":4,"Description":"Specifies how to interpret the base path of the API during import. Valid values are ``ignore``, ``prepend``, and ``split``. The default value is ``ignore``. To learn more, see [Set the OpenAPI basePath Property](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api-basePath.html). Supported only for HTTP APIs."},"Body":{"Type":15,"Flags":4,"Description":"The OpenAPI definition. Supported only for HTTP APIs. To import an HTTP API, you must specify a ``Body`` or ``BodyS3Location``. If you specify a ``Body`` or ``BodyS3Location``, don't specify CloudFormation resources such as ``AWS::ApiGatewayV2::Authorizer`` or ``AWS::ApiGatewayV2::Route``. API Gateway doesn't support the combination of OpenAPI and CloudFormation resources."},"BodyS3Location":{"Type":8,"Flags":4,"Description":"The 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 a ``Body`` or ``BodyS3Location``, don't specify CloudFormation resources such as ``AWS::ApiGatewayV2::Authorizer`` or ``AWS::ApiGatewayV2::Route``. API Gateway doesn't support the combination of OpenAPI and CloudFormation resources."},"CorsConfiguration":{"Type":9,"Flags":0,"Description":"A 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."},"CredentialsArn":{"Type":4,"Flags":4,"Description":"This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, 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 ``arn:aws:iam::*:user/*``. To use resource-based permissions on supported AWS services, specify ``null``. Currently, this property is not used for HTTP integrations. Supported only for HTTP APIs."},"Description":{"Type":4,"Flags":0,"Description":"The description of the API."},"DisableExecuteApiEndpoint":{"Type":2,"Flags":0,"Description":"Specifies whether clients can invoke your API by using the default ``execute-api`` endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint."},"DisableSchemaValidation":{"Type":2,"Flags":4,"Description":"Avoid validating models when creating a deployment. Supported only for WebSocket APIs."},"FailOnWarnings":{"Type":2,"Flags":4,"Description":"Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered."},"Name":{"Type":4,"Flags":0,"Description":"The name of the API. Required unless you specify an OpenAPI definition for ``Body`` or ``S3BodyLocation``."},"ProtocolType":{"Type":4,"Flags":0,"Description":"The API protocol. Valid values are ``WEBSOCKET`` or ``HTTP``. Required unless you specify an OpenAPI definition for ``Body`` or ``S3BodyLocation``."},"RouteKey":{"Type":4,"Flags":4,"Description":"This property is part of quick create. If you don't specify a ``routeKey``, a default route of ``$default`` is created. The ``$default`` route acts as a catch-all for any request made to your API, for a particular stage. The ``$default`` route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs."},"RouteSelectionExpression":{"Type":4,"Flags":0,"Description":"The route selection expression for the API. For HTTP APIs, the ``routeSelectionExpression`` must be ``${request.method} ${request.path}``. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs."},"Tags":{"Type":16,"Flags":0,"Description":"The collection of tags. Each tag element is associated with a given resource."},"Target":{"Type":4,"Flags":4,"Description":"This property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for HTTP APIs."},"Version":{"Type":4,"Flags":0,"Description":"A version identifier for the API."}}}},{"2":{"Name":"Api_Body","Properties":{}}},{"2":{"Name":"Api_Tags","Properties":{}}},{"2":{"Name":"AWS.ApiGatewayV2/Api","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":14,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ApiGatewayV2/Api@default","ScopeType":0,"Body":17}},{"2":{"Name":"AWS.ApiGatewayV2/ApiMappingProperties","Properties":{"ApiId":{"Type":4,"Flags":1,"Description":"The identifier of the API."},"ApiMappingId":{"Type":4,"Flags":18,"Description":""},"ApiMappingKey":{"Type":4,"Flags":0,"Description":"The API mapping key."},"DomainName":{"Type":4,"Flags":17,"Description":"The domain name."},"Stage":{"Type":4,"Flags":1,"Description":"The API stage."}}}},{"2":{"Name":"AWS.ApiGatewayV2/ApiMapping","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":19,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ApiGatewayV2/ApiMapping@default","ScopeType":0,"Body":20}},{"2":{"Name":"JWTConfiguration","Properties":{"Audience":{"Type":23,"Flags":0},"Issuer":{"Type":4,"Flags":0}}}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.ApiGatewayV2/AuthorizerProperties","Properties":{"ApiId":{"Type":4,"Flags":17},"AuthorizerCredentialsArn":{"Type":4,"Flags":0},"AuthorizerId":{"Type":4,"Flags":18},"AuthorizerPayloadFormatVersion":{"Type":4,"Flags":0},"AuthorizerResultTtlInSeconds":{"Type":3,"Flags":0},"AuthorizerType":{"Type":4,"Flags":1},"AuthorizerUri":{"Type":4,"Flags":0},"EnableSimpleResponses":{"Type":2,"Flags":0},"IdentitySource":{"Type":25,"Flags":0},"IdentityValidationExpression":{"Type":4,"Flags":0},"JwtConfiguration":{"Type":22,"Flags":0},"Name":{"Type":4,"Flags":1}}}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.ApiGatewayV2/Authorizer","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":24,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ApiGatewayV2/Authorizer@default","ScopeType":0,"Body":26}},{"2":{"Name":"AWS.ApiGatewayV2/DeploymentProperties","Properties":{"ApiId":{"Type":4,"Flags":17,"Description":"The API identifier."},"DeploymentId":{"Type":4,"Flags":18,"Description":""},"Description":{"Type":4,"Flags":0,"Description":"The description for the deployment resource."},"StageName":{"Type":4,"Flags":4,"Description":"The name of an existing stage to associate with the deployment."}}}},{"2":{"Name":"AWS.ApiGatewayV2/Deployment","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":28,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ApiGatewayV2/Deployment@default","ScopeType":0,"Body":29}},{"2":{"Name":"DomainNameConfiguration","Properties":{"CertificateArn":{"Type":4,"Flags":0,"Description":"An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source."},"CertificateName":{"Type":4,"Flags":0,"Description":"The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name."},"EndpointType":{"Type":4,"Flags":0,"Description":"The endpoint type."},"OwnershipVerificationCertificateArn":{"Type":4,"Flags":0,"Description":"The Amazon resource name (ARN) for the public certificate issued by ACMlong. 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."},"SecurityPolicy":{"Type":4,"Flags":0,"Description":"The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are ``TLS_1_0`` and ``TLS_1_2``."}}}},{"2":{"Name":"MutualTlsAuthentication","Properties":{"TruststoreUri":{"Type":4,"Flags":0,"Description":"An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, ``s3://bucket-name/key-name``. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object."},"TruststoreVersion":{"Type":4,"Flags":0,"Description":"The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket."}}}},{"2":{"Name":"AWS.ApiGatewayV2/DomainNameProperties","Properties":{"DomainName":{"Type":4,"Flags":17,"Description":"The custom domain name for your API in Amazon API Gateway. Uppercase letters are not supported."},"DomainNameConfigurations":{"Type":34,"Flags":0,"Description":"The domain name configurations."},"MutualTlsAuthentication":{"Type":32,"Flags":0,"Description":"The mutual TLS authentication configuration for a custom domain name."},"RegionalDomainName":{"Type":4,"Flags":2,"Description":""},"RegionalHostedZoneId":{"Type":4,"Flags":2,"Description":""},"Tags":{"Type":35,"Flags":0,"Description":"The collection of tags associated with a domain name."}}}},{"3":{"ItemType":31}},{"2":{"Name":"DomainName_Tags","Properties":{}}},{"2":{"Name":"AWS.ApiGatewayV2/DomainName","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":33,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ApiGatewayV2/DomainName@default","ScopeType":0,"Body":36}},{"2":{"Name":"AWS.ApiGatewayV2/IntegrationResponseProperties","Properties":{"ApiId":{"Type":4,"Flags":17,"Description":"The API identifier."},"ContentHandlingStrategy":{"Type":4,"Flags":0,"Description":"Supported 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.\n If 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."},"IntegrationId":{"Type":4,"Flags":17,"Description":"The integration ID."},"IntegrationResponseId":{"Type":4,"Flags":18,"Description":""},"IntegrationResponseKey":{"Type":4,"Flags":1,"Description":"The integration response key."},"ResponseParameters":{"Type":39,"Flags":0,"Description":"A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of ``method.response.header.{name}``, where name is a valid and unique header name. The mapped non-static value must match the pattern of ``integration.response.header.{name}`` or ``integration.response.body.{JSON-expression}``, where ``{name}`` is a valid and unique response header name and ``{JSON-expression}`` is a valid JSON expression without the ``$`` prefix."},"ResponseTemplates":{"Type":40,"Flags":0,"Description":"The 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."},"TemplateSelectionExpression":{"Type":4,"Flags":0,"Description":"The template selection expression for the integration response. Supported only for WebSocket APIs."}}}},{"2":{"Name":"IntegrationResponse_ResponseParameters","Properties":{}}},{"2":{"Name":"IntegrationResponse_ResponseTemplates","Properties":{}}},{"2":{"Name":"AWS.ApiGatewayV2/IntegrationResponse","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":38,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ApiGatewayV2/IntegrationResponse@default","ScopeType":0,"Body":41}},{"2":{"Name":"AWS.ApiGatewayV2/ModelProperties","Properties":{"ApiId":{"Type":4,"Flags":17,"Description":"The API identifier."},"ContentType":{"Type":4,"Flags":0,"Description":"The content-type for the model, for example, \"application/json\"."},"Description":{"Type":4,"Flags":0,"Description":"The description of the model."},"ModelId":{"Type":4,"Flags":18,"Description":""},"Name":{"Type":4,"Flags":1,"Description":"The name of the model."},"Schema":{"Type":44,"Flags":1,"Description":"The schema for the model. For application/json models, this should be JSON schema draft 4 model."}}}},{"2":{"Name":"Model_Schema","Properties":{}}},{"2":{"Name":"AWS.ApiGatewayV2/Model","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":43,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ApiGatewayV2/Model@default","ScopeType":0,"Body":45}},{"2":{"Name":"ParameterConstraints","Properties":{"Required":{"Type":2,"Flags":1}}}},{"2":{"Name":"AWS.ApiGatewayV2/RouteProperties","Properties":{"ApiId":{"Type":4,"Flags":17,"Description":"The API identifier."},"ApiKeyRequired":{"Type":2,"Flags":0,"Description":"Specifies whether an API key is required for the route. Supported only for WebSocket APIs."},"AuthorizationScopes":{"Type":49,"Flags":0,"Description":"The authorization scopes supported by this route."},"AuthorizationType":{"Type":4,"Flags":0,"Description":"The authorization type for the route. For WebSocket APIs, valid values are ``NONE`` for open access, ``AWS_IAM`` for using AWS IAM permissions, and ``CUSTOM`` for using a Lambda authorizer. For HTTP APIs, valid values are ``NONE`` for open access, ``JWT`` for using JSON Web Tokens, ``AWS_IAM`` for using AWS IAM permissions, and ``CUSTOM`` for using a Lambda authorizer."},"AuthorizerId":{"Type":4,"Flags":4,"Description":"The identifier of the ``Authorizer`` resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer."},"ModelSelectionExpression":{"Type":4,"Flags":0,"Description":"The model selection expression for the route. Supported only for WebSocket APIs."},"OperationName":{"Type":4,"Flags":0,"Description":"The operation name for the route."},"RequestModels":{"Type":50,"Flags":0,"Description":"The request models for the route. Supported only for WebSocket APIs."},"RequestParameters":{"Type":51,"Flags":4,"Description":"The request parameters for the route. Supported only for WebSocket APIs."},"RouteId":{"Type":4,"Flags":18,"Description":""},"RouteKey":{"Type":4,"Flags":1,"Description":"The 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``."},"RouteResponseSelectionExpression":{"Type":4,"Flags":0,"Description":"The route response selection expression for the route. Supported only for WebSocket APIs."},"Target":{"Type":4,"Flags":0,"Description":"The target for the route."}}}},{"3":{"ItemType":4}},{"2":{"Name":"Route_RequestModels","Properties":{}}},{"2":{"Name":"Route_RequestParameters","Properties":{}}},{"2":{"Name":"AWS.ApiGatewayV2/Route","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":48,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ApiGatewayV2/Route@default","ScopeType":0,"Body":52}},{"2":{"Name":"ParameterConstraints","Properties":{"Required":{"Type":2,"Flags":1,"Description":"Specifies whether the parameter is required."}}}},{"2":{"Name":"RouteParameters","Properties":{}}},{"2":{"Name":"AWS.ApiGatewayV2/RouteResponseProperties","Properties":{"ApiId":{"Type":4,"Flags":17,"Description":"The API identifier."},"ModelSelectionExpression":{"Type":4,"Flags":0,"Description":"The model selection expression for the route response. Supported only for WebSocket APIs."},"ResponseModels":{"Type":57,"Flags":0,"Description":"The response models for the route response."},"ResponseParameters":{"Type":55,"Flags":0,"Description":"The route response parameters."},"RouteId":{"Type":4,"Flags":17,"Description":"The route ID."},"RouteResponseId":{"Type":4,"Flags":18,"Description":""},"RouteResponseKey":{"Type":4,"Flags":1,"Description":"The route response key."}}}},{"2":{"Name":"RouteResponse_ResponseModels","Properties":{}}},{"2":{"Name":"AWS.ApiGatewayV2/RouteResponse","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":56,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ApiGatewayV2/RouteResponse@default","ScopeType":0,"Body":58}},{"2":{"Name":"AWS.ApiGatewayV2/VpcLinkProperties","Properties":{"Name":{"Type":4,"Flags":1},"SecurityGroupIds":{"Type":61,"Flags":0},"SubnetIds":{"Type":62,"Flags":1},"Tags":{"Type":63,"Flags":0,"Description":"This resource type use map for Tags, suggest to use List of Tag"},"VpcLinkId":{"Type":4,"Flags":18}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"VpcLink_Tags","Properties":{}}},{"2":{"Name":"AWS.ApiGatewayV2/VpcLink","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":60,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ApiGatewayV2/VpcLink@default","ScopeType":0,"Body":64}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "BodyS3Location", + "properties": { + "Bucket": { + "type": { + "$ref": "#/2" + }, + "flags": 4, + "description": "The S3 bucket that contains the OpenAPI definition to import. Required if you specify a ``BodyS3Location`` for an API." + }, + "Etag": { + "type": { + "$ref": "#/2" + }, + "flags": 4, + "description": "The Etag of the S3 object." + }, + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 4, + "description": "The key of the S3 object. Required if you specify a ``BodyS3Location`` for an API." + }, + "Version": { + "type": { + "$ref": "#/2" + }, + "flags": 4, + "description": "The version of the S3 object." + } + } + }, + { + "$type": "ObjectType", + "name": "Cors", + "properties": { + "AllowCredentials": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs." + }, + "AllowHeaders": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Represents a collection of allowed headers. Supported only for HTTP APIs." + }, + "AllowMethods": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "Represents a collection of allowed HTTP methods. Supported only for HTTP APIs." + }, + "AllowOrigins": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Represents a collection of allowed origins. Supported only for HTTP APIs." + }, + "ExposeHeaders": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "Represents a collection of exposed headers. Supported only for HTTP APIs." + }, + "MaxAge": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs." + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.ApiGatewayV2/ApiProperties" + }, + { + "$type": "ObjectType", + "name": "Api_Body", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Api_Tags", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AWS.ApiGatewayV2/ApiProperties", + "properties": { + "ApiEndpoint": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "" + }, + "ApiId": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "" + }, + "ApiKeySelectionExpression": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "An API key selection expression. Supported only for WebSocket APIs. See [API Key Selection Expressions](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions)." + }, + "BasePath": { + "type": { + "$ref": "#/2" + }, + "flags": 4, + "description": "Specifies how to interpret the base path of the API during import. Valid values are ``ignore``, ``prepend``, and ``split``. The default value is ``ignore``. To learn more, see [Set the OpenAPI basePath Property](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api-basePath.html). Supported only for HTTP APIs." + }, + "Body": { + "type": { + "$ref": "#/10" + }, + "flags": 4, + "description": "The OpenAPI definition. Supported only for HTTP APIs. To import an HTTP API, you must specify a ``Body`` or ``BodyS3Location``. If you specify a ``Body`` or ``BodyS3Location``, don't specify CloudFormation resources such as ``AWS::ApiGatewayV2::Authorizer`` or ``AWS::ApiGatewayV2::Route``. API Gateway doesn't support the combination of OpenAPI and CloudFormation resources." + }, + "BodyS3Location": { + "type": { + "$ref": "#/0" + }, + "flags": 4, + "description": "The 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 a ``Body`` or ``BodyS3Location``, don't specify CloudFormation resources such as ``AWS::ApiGatewayV2::Authorizer`` or ``AWS::ApiGatewayV2::Route``. API Gateway doesn't support the combination of OpenAPI and CloudFormation resources." + }, + "CorsConfiguration": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A 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." + }, + "CredentialsArn": { + "type": { + "$ref": "#/2" + }, + "flags": 4, + "description": "This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, 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 ``arn:aws:iam::*:user/*``. To use resource-based permissions on supported AWS services, specify ``null``. Currently, this property is not used for HTTP integrations. Supported only for HTTP APIs." + }, + "Description": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The description of the API." + }, + "DisableExecuteApiEndpoint": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "Specifies whether clients can invoke your API by using the default ``execute-api`` endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint." + }, + "DisableSchemaValidation": { + "type": { + "$ref": "#/3" + }, + "flags": 4, + "description": "Avoid validating models when creating a deployment. Supported only for WebSocket APIs." + }, + "FailOnWarnings": { + "type": { + "$ref": "#/3" + }, + "flags": 4, + "description": "Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered." + }, + "Name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The name of the API. Required unless you specify an OpenAPI definition for ``Body`` or ``S3BodyLocation``." + }, + "ProtocolType": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The API protocol. Valid values are ``WEBSOCKET`` or ``HTTP``. Required unless you specify an OpenAPI definition for ``Body`` or ``S3BodyLocation``." + }, + "RouteKey": { + "type": { + "$ref": "#/2" + }, + "flags": 4, + "description": "This property is part of quick create. If you don't specify a ``routeKey``, a default route of ``$default`` is created. The ``$default`` route acts as a catch-all for any request made to your API, for a particular stage. The ``$default`` route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs." + }, + "RouteSelectionExpression": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The route selection expression for the API. For HTTP APIs, the ``routeSelectionExpression`` must be ``${request.method} ${request.path}``. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs." + }, + "Tags": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The collection of tags. Each tag element is associated with a given resource." + }, + "Target": { + "type": { + "$ref": "#/2" + }, + "flags": 4, + "description": "This property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for HTTP APIs." + }, + "Version": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "A version identifier for the API." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ApiGatewayV2/Api", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/12" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ApiGatewayV2/Api@default", + "scopeType": 0, + "body": { + "$ref": "#/13" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.ApiGatewayV2/ApiMappingProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.ApiGatewayV2/ApiMappingProperties", + "properties": { + "ApiId": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The identifier of the API." + }, + "ApiMappingId": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "" + }, + "ApiMappingKey": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The API mapping key." + }, + "DomainName": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "The domain name." + }, + "Stage": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The API stage." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ApiGatewayV2/ApiMapping", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/16" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ApiGatewayV2/ApiMapping@default", + "scopeType": 0, + "body": { + "$ref": "#/17" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "JWTConfiguration", + "properties": { + "Audience": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "A list of the intended recipients of the JWT. A valid JWT must provide an ``aud`` that matches at least one entry in this list. See [RFC 7519](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc7519#section-4.1.3). Required for the ``JWT`` authorizer type. Supported only for HTTP APIs." + }, + "Issuer": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The base domain of the identity provider that issues JSON Web Tokens. For example, an Amazon Cognito user pool has the following format: ``https://cognito-idp.{region}.amazonaws.com/{userPoolId}``. Required for the ``JWT`` authorizer type. Supported only for HTTP APIs." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.ApiGatewayV2/AuthorizerProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ObjectType", + "name": "AWS.ApiGatewayV2/AuthorizerProperties", + "properties": { + "ApiId": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "The API identifier." + }, + "AuthorizerCredentialsArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null. Supported only for ``REQUEST`` authorizers." + }, + "AuthorizerId": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "" + }, + "AuthorizerPayloadFormatVersion": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "Specifies 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 Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html)." + }, + "AuthorizerResultTtlInSeconds": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers." + }, + "AuthorizerType": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The authorizer type. Specify ``REQUEST`` for a Lambda function using incoming request parameters. Specify ``JWT`` to use JSON Web Tokens (supported only for HTTP APIs)." + }, + "AuthorizerUri": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The authorizer's Uniform Resource Identifier (URI). For ``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``." + }, + "EnableSimpleResponses": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "Specifies 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 Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html)." + }, + "IdentitySource": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "The identity source for which authorization is requested.\n For a ``REQUEST`` authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with ``$``, for example, ``$request.header.Auth``, ``$request.querystring.Name``. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see [Working with Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html).\n For ``JWT``, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example ``$request.header.Authorization``." + }, + "IdentityValidationExpression": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "This parameter is not used." + }, + "JwtConfiguration": { + "type": { + "$ref": "#/19" + }, + "flags": 0, + "description": "The ``JWTConfiguration`` property specifies the configuration of a JWT authorizer. Required for the ``JWT`` authorizer type. Supported only for HTTP APIs." + }, + "Name": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The name of the authorizer." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ApiGatewayV2/Authorizer", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/23" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ApiGatewayV2/Authorizer@default", + "scopeType": 0, + "body": { + "$ref": "#/24" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.ApiGatewayV2/DeploymentProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.ApiGatewayV2/DeploymentProperties", + "properties": { + "ApiId": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "The API identifier." + }, + "DeploymentId": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "" + }, + "Description": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The description for the deployment resource." + }, + "StageName": { + "type": { + "$ref": "#/2" + }, + "flags": 4, + "description": "The name of an existing stage to associate with the deployment." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ApiGatewayV2/Deployment", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/27" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ApiGatewayV2/Deployment@default", + "scopeType": 0, + "body": { + "$ref": "#/28" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "DomainNameConfiguration", + "properties": { + "CertificateArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source." + }, + "CertificateName": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name." + }, + "EndpointType": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The endpoint type." + }, + "OwnershipVerificationCertificateArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The Amazon resource name (ARN) for the public certificate issued by ACMlong. 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." + }, + "SecurityPolicy": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are ``TLS_1_0`` and ``TLS_1_2``." + } + } + }, + { + "$type": "ObjectType", + "name": "MutualTlsAuthentication", + "properties": { + "TruststoreUri": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, ``s3://bucket-name/key-name``. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object." + }, + "TruststoreVersion": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.ApiGatewayV2/DomainNameProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/30" + } + }, + { + "$type": "ObjectType", + "name": "DomainName_Tags", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AWS.ApiGatewayV2/DomainNameProperties", + "properties": { + "DomainName": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "The custom domain name for your API in Amazon API Gateway. Uppercase letters are not supported." + }, + "DomainNameConfigurations": { + "type": { + "$ref": "#/33" + }, + "flags": 0, + "description": "The domain name configurations." + }, + "MutualTlsAuthentication": { + "type": { + "$ref": "#/31" + }, + "flags": 0, + "description": "The mutual TLS authentication configuration for a custom domain name." + }, + "RegionalDomainName": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "" + }, + "RegionalHostedZoneId": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "" + }, + "Tags": { + "type": { + "$ref": "#/34" + }, + "flags": 0, + "description": "The collection of tags associated with a domain name." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ApiGatewayV2/DomainName", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/35" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ApiGatewayV2/DomainName@default", + "scopeType": 0, + "body": { + "$ref": "#/36" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "TlsConfig", + "properties": { + "ServerNameToVerify": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.ApiGatewayV2/IntegrationProperties" + }, + { + "$type": "ObjectType", + "name": "Integration_RequestParameters", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Integration_RequestTemplates", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Integration_ResponseParameters", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AWS.ApiGatewayV2/IntegrationProperties", + "properties": { + "ApiId": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "ConnectionId": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "ConnectionType": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "ContentHandlingStrategy": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "CredentialsArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Description": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Id": { + "type": { + "$ref": "#/2" + }, + "flags": 18 + }, + "IntegrationMethod": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "IntegrationSubtype": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "IntegrationType": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "IntegrationUri": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "PassthroughBehavior": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "PayloadFormatVersion": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "RequestParameters": { + "type": { + "$ref": "#/40" + }, + "flags": 0 + }, + "RequestTemplates": { + "type": { + "$ref": "#/41" + }, + "flags": 0 + }, + "ResponseParameters": { + "type": { + "$ref": "#/42" + }, + "flags": 0 + }, + "TemplateSelectionExpression": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "TimeoutInMillis": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "TlsConfig": { + "type": { + "$ref": "#/38" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ApiGatewayV2/Integration", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/43" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ApiGatewayV2/Integration@default", + "scopeType": 0, + "body": { + "$ref": "#/44" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.ApiGatewayV2/IntegrationResponseProperties" + }, + { + "$type": "ObjectType", + "name": "IntegrationResponse_ResponseParameters", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "IntegrationResponse_ResponseTemplates", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AWS.ApiGatewayV2/IntegrationResponseProperties", + "properties": { + "ApiId": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "The API identifier." + }, + "ContentHandlingStrategy": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "Supported 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.\n If 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." + }, + "IntegrationId": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "The integration ID." + }, + "IntegrationResponseId": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "" + }, + "IntegrationResponseKey": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The integration response key." + }, + "ResponseParameters": { + "type": { + "$ref": "#/47" + }, + "flags": 0, + "description": "A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of ``method.response.header.{name}``, where name is a valid and unique header name. The mapped non-static value must match the pattern of ``integration.response.header.{name}`` or ``integration.response.body.{JSON-expression}``, where ``{name}`` is a valid and unique response header name and ``{JSON-expression}`` is a valid JSON expression without the ``$`` prefix." + }, + "ResponseTemplates": { + "type": { + "$ref": "#/48" + }, + "flags": 0, + "description": "The 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." + }, + "TemplateSelectionExpression": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The template selection expression for the integration response. Supported only for WebSocket APIs." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ApiGatewayV2/IntegrationResponse", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/49" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ApiGatewayV2/IntegrationResponse@default", + "scopeType": 0, + "body": { + "$ref": "#/50" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.ApiGatewayV2/ModelProperties" + }, + { + "$type": "ObjectType", + "name": "Model_Schema", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AWS.ApiGatewayV2/ModelProperties", + "properties": { + "ApiId": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "The API identifier." + }, + "ContentType": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The content-type for the model, for example, \"application/json\"." + }, + "Description": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The description of the model." + }, + "ModelId": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "" + }, + "Name": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The name of the model." + }, + "Schema": { + "type": { + "$ref": "#/53" + }, + "flags": 1, + "description": "The schema for the model. For application/json models, this should be JSON schema draft 4 model." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ApiGatewayV2/Model", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/54" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ApiGatewayV2/Model@default", + "scopeType": 0, + "body": { + "$ref": "#/55" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "ParameterConstraints", + "properties": { + "Required": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.ApiGatewayV2/RouteProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ObjectType", + "name": "Route_RequestModels", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Route_RequestParameters", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AWS.ApiGatewayV2/RouteProperties", + "properties": { + "ApiId": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "The API identifier." + }, + "ApiKeyRequired": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "Specifies whether an API key is required for the route. Supported only for WebSocket APIs." + }, + "AuthorizationScopes": { + "type": { + "$ref": "#/59" + }, + "flags": 0, + "description": "The authorization scopes supported by this route." + }, + "AuthorizationType": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The authorization type for the route. For WebSocket APIs, valid values are ``NONE`` for open access, ``AWS_IAM`` for using AWS IAM permissions, and ``CUSTOM`` for using a Lambda authorizer. For HTTP APIs, valid values are ``NONE`` for open access, ``JWT`` for using JSON Web Tokens, ``AWS_IAM`` for using AWS IAM permissions, and ``CUSTOM`` for using a Lambda authorizer." + }, + "AuthorizerId": { + "type": { + "$ref": "#/2" + }, + "flags": 4, + "description": "The identifier of the ``Authorizer`` resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer." + }, + "ModelSelectionExpression": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The model selection expression for the route. Supported only for WebSocket APIs." + }, + "OperationName": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The operation name for the route." + }, + "RequestModels": { + "type": { + "$ref": "#/60" + }, + "flags": 0, + "description": "The request models for the route. Supported only for WebSocket APIs." + }, + "RequestParameters": { + "type": { + "$ref": "#/61" + }, + "flags": 4, + "description": "The request parameters for the route. Supported only for WebSocket APIs." + }, + "RouteId": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "" + }, + "RouteKey": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The 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``." + }, + "RouteResponseSelectionExpression": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The route response selection expression for the route. Supported only for WebSocket APIs." + }, + "Target": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The target for the route." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ApiGatewayV2/Route", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/62" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ApiGatewayV2/Route@default", + "scopeType": 0, + "body": { + "$ref": "#/63" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "ParameterConstraints", + "properties": { + "Required": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "Specifies whether the parameter is required." + } + } + }, + { + "$type": "ObjectType", + "name": "RouteParameters", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.ApiGatewayV2/RouteResponseProperties" + }, + { + "$type": "ObjectType", + "name": "RouteResponse_ResponseModels", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AWS.ApiGatewayV2/RouteResponseProperties", + "properties": { + "ApiId": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "The API identifier." + }, + "ModelSelectionExpression": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The model selection expression for the route response. Supported only for WebSocket APIs." + }, + "ResponseModels": { + "type": { + "$ref": "#/68" + }, + "flags": 0, + "description": "The response models for the route response." + }, + "ResponseParameters": { + "type": { + "$ref": "#/66" + }, + "flags": 0, + "description": "The route response parameters." + }, + "RouteId": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "The route ID." + }, + "RouteResponseId": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "" + }, + "RouteResponseKey": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The route response key." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ApiGatewayV2/RouteResponse", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/69" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ApiGatewayV2/RouteResponse@default", + "scopeType": 0, + "body": { + "$ref": "#/70" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.ApiGatewayV2/VpcLinkProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ObjectType", + "name": "VpcLink_Tags", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AWS.ApiGatewayV2/VpcLinkProperties", + "properties": { + "Name": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "SecurityGroupIds": { + "type": { + "$ref": "#/73" + }, + "flags": 0 + }, + "SubnetIds": { + "type": { + "$ref": "#/74" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/75" + }, + "flags": 0, + "description": "This resource type use map for Tags, suggest to use List of Tag" + }, + "VpcLinkId": { + "type": { + "$ref": "#/2" + }, + "flags": 18 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ApiGatewayV2/VpcLink", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/76" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ApiGatewayV2/VpcLink@default", + "scopeType": 0, + "body": { + "$ref": "#/77" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.apigatewayv2/default/types.md b/artifacts/bicep/aws/aws.apigatewayv2/default/types.md index 5afdd5fb..f536e891 100644 --- a/artifacts/bicep/aws/aws.apigatewayv2/default/types.md +++ b/artifacts/bicep/aws/aws.apigatewayv2/default/types.md @@ -3,72 +3,93 @@ ## Resource AWS.ApiGatewayV2/Api@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ApiGatewayV2/ApiProperties](#awsapigatewayv2apiproperties): properties of the resource +* **properties**: [AWS.ApiGatewayV2/ApiProperties](#awsapigatewayv2apiproperties) (Identifier): properties of the resource ## Resource AWS.ApiGatewayV2/ApiMapping@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ApiGatewayV2/ApiMappingProperties](#awsapigatewayv2apimappingproperties) (Required): properties of the resource +* **properties**: [AWS.ApiGatewayV2/ApiMappingProperties](#awsapigatewayv2apimappingproperties) (Required, Identifier): properties of the resource ## Resource AWS.ApiGatewayV2/Authorizer@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ApiGatewayV2/AuthorizerProperties](#awsapigatewayv2authorizerproperties) (Required): properties of the resource +* **properties**: [AWS.ApiGatewayV2/AuthorizerProperties](#awsapigatewayv2authorizerproperties) (Required, Identifier): properties of the resource ## Resource AWS.ApiGatewayV2/Deployment@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ApiGatewayV2/DeploymentProperties](#awsapigatewayv2deploymentproperties) (Required): properties of the resource +* **properties**: [AWS.ApiGatewayV2/DeploymentProperties](#awsapigatewayv2deploymentproperties) (Required, Identifier): properties of the resource ## Resource AWS.ApiGatewayV2/DomainName@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ApiGatewayV2/DomainNameProperties](#awsapigatewayv2domainnameproperties) (Required): properties of the resource +* **properties**: [AWS.ApiGatewayV2/DomainNameProperties](#awsapigatewayv2domainnameproperties) (Required, Identifier): properties of the resource + +## Resource AWS.ApiGatewayV2/Integration@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.ApiGatewayV2/IntegrationProperties](#awsapigatewayv2integrationproperties) (Required, Identifier): properties of the resource ## Resource AWS.ApiGatewayV2/IntegrationResponse@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ApiGatewayV2/IntegrationResponseProperties](#awsapigatewayv2integrationresponseproperties) (Required): properties of the resource +* **properties**: [AWS.ApiGatewayV2/IntegrationResponseProperties](#awsapigatewayv2integrationresponseproperties) (Required, Identifier): properties of the resource ## Resource AWS.ApiGatewayV2/Model@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ApiGatewayV2/ModelProperties](#awsapigatewayv2modelproperties) (Required): properties of the resource +* **properties**: [AWS.ApiGatewayV2/ModelProperties](#awsapigatewayv2modelproperties) (Required, Identifier): properties of the resource ## Resource AWS.ApiGatewayV2/Route@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ApiGatewayV2/RouteProperties](#awsapigatewayv2routeproperties) (Required): properties of the resource +* **properties**: [AWS.ApiGatewayV2/RouteProperties](#awsapigatewayv2routeproperties) (Required, Identifier): properties of the resource ## Resource AWS.ApiGatewayV2/RouteResponse@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ApiGatewayV2/RouteResponseProperties](#awsapigatewayv2routeresponseproperties) (Required): properties of the resource +* **properties**: [AWS.ApiGatewayV2/RouteResponseProperties](#awsapigatewayv2routeresponseproperties) (Required, Identifier): properties of the resource ## Resource AWS.ApiGatewayV2/VpcLink@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ApiGatewayV2/VpcLinkProperties](#awsapigatewayv2vpclinkproperties) (Required): properties of the resource +* **properties**: [AWS.ApiGatewayV2/VpcLinkProperties](#awsapigatewayv2vpclinkproperties) (Required, Identifier): properties of the resource + +## Api_Body +### Properties + +## Api_Tags +### Properties + +## AWS.ApiGatewayV2/ApiMappingProperties +### Properties +* **ApiId**: string (Required): The identifier of the API. +* **ApiMappingId**: string (ReadOnly, Identifier) +* **ApiMappingKey**: string: The API mapping key. +* **DomainName**: string (Required, Identifier): The domain name. +* **Stage**: string (Required): The API stage. ## AWS.ApiGatewayV2/ApiProperties ### Properties @@ -92,55 +113,22 @@ * **Target**: string (WriteOnly): This property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for HTTP APIs. * **Version**: string: A version identifier for the API. -## Api_Body -### Properties - -## BodyS3Location -### Properties -* **Bucket**: string (WriteOnly): The S3 bucket that contains the OpenAPI definition to import. Required if you specify a ``BodyS3Location`` for an API. -* **Etag**: string (WriteOnly): The Etag of the S3 object. -* **Key**: string (WriteOnly): The key of the S3 object. Required if you specify a ``BodyS3Location`` for an API. -* **Version**: string (WriteOnly): The version of the S3 object. - -## Cors -### Properties -* **AllowCredentials**: bool: Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs. -* **AllowHeaders**: string[]: Represents a collection of allowed headers. Supported only for HTTP APIs. -* **AllowMethods**: string[]: Represents a collection of allowed HTTP methods. Supported only for HTTP APIs. -* **AllowOrigins**: string[]: Represents a collection of allowed origins. Supported only for HTTP APIs. -* **ExposeHeaders**: string[]: Represents a collection of exposed headers. Supported only for HTTP APIs. -* **MaxAge**: int: The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs. - -## Api_Tags -### Properties - -## AWS.ApiGatewayV2/ApiMappingProperties -### Properties -* **ApiId**: string (Required): The identifier of the API. -* **ApiMappingId**: string (ReadOnly, Identifier) -* **ApiMappingKey**: string: The API mapping key. -* **DomainName**: string (Required, Identifier): The domain name. -* **Stage**: string (Required): The API stage. - ## AWS.ApiGatewayV2/AuthorizerProperties ### Properties -* **ApiId**: string (Required, Identifier) -* **AuthorizerCredentialsArn**: string +* **ApiId**: string (Required, Identifier): The API identifier. +* **AuthorizerCredentialsArn**: string: Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null. Supported only for ``REQUEST`` authorizers. * **AuthorizerId**: string (ReadOnly, Identifier) -* **AuthorizerPayloadFormatVersion**: string -* **AuthorizerResultTtlInSeconds**: int -* **AuthorizerType**: string (Required) -* **AuthorizerUri**: string -* **EnableSimpleResponses**: bool -* **IdentitySource**: string[] -* **IdentityValidationExpression**: string -* **JwtConfiguration**: [JWTConfiguration](#jwtconfiguration) -* **Name**: string (Required) - -## JWTConfiguration -### Properties -* **Audience**: string[] -* **Issuer**: string +* **AuthorizerPayloadFormatVersion**: string: Specifies 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 Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html). +* **AuthorizerResultTtlInSeconds**: int: The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers. +* **AuthorizerType**: string (Required): The authorizer type. Specify ``REQUEST`` for a Lambda function using incoming request parameters. Specify ``JWT`` to use JSON Web Tokens (supported only for HTTP APIs). +* **AuthorizerUri**: string: The authorizer's Uniform Resource Identifier (URI). For ``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``. +* **EnableSimpleResponses**: bool: Specifies 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 Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html). +* **IdentitySource**: string[]: The identity source for which authorization is requested. + For a ``REQUEST`` authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with ``$``, for example, ``$request.header.Auth``, ``$request.querystring.Name``. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see [Working with Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html). + For ``JWT``, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example ``$request.header.Authorization``. +* **IdentityValidationExpression**: string: This parameter is not used. +* **JwtConfiguration**: [JWTConfiguration](#jwtconfiguration): The ``JWTConfiguration`` property specifies the configuration of a JWT authorizer. Required for the ``JWT`` authorizer type. Supported only for HTTP APIs. +* **Name**: string (Required): The name of the authorizer. ## AWS.ApiGatewayV2/DeploymentProperties ### Properties @@ -158,21 +146,27 @@ * **RegionalHostedZoneId**: string (ReadOnly) * **Tags**: [DomainName_Tags](#domainnametags): The collection of tags associated with a domain name. -## DomainNameConfiguration -### Properties -* **CertificateArn**: string: An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source. -* **CertificateName**: string: The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name. -* **EndpointType**: string: The endpoint type. -* **OwnershipVerificationCertificateArn**: string: The Amazon resource name (ARN) for the public certificate issued by ACMlong. 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. -* **SecurityPolicy**: string: The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are ``TLS_1_0`` and ``TLS_1_2``. - -## MutualTlsAuthentication -### Properties -* **TruststoreUri**: string: An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, ``s3://bucket-name/key-name``. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object. -* **TruststoreVersion**: string: The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket. - -## DomainName_Tags -### Properties +## AWS.ApiGatewayV2/IntegrationProperties +### Properties +* **ApiId**: string (Required) +* **ConnectionId**: string +* **ConnectionType**: string +* **ContentHandlingStrategy**: string +* **CredentialsArn**: string +* **Description**: string +* **Id**: string (ReadOnly, Identifier) +* **IntegrationMethod**: string +* **IntegrationSubtype**: string +* **IntegrationType**: string (Required) +* **IntegrationUri**: string +* **PassthroughBehavior**: string +* **PayloadFormatVersion**: string +* **RequestParameters**: [Integration_RequestParameters](#integrationrequestparameters) +* **RequestTemplates**: [Integration_RequestTemplates](#integrationrequesttemplates) +* **ResponseParameters**: [Integration_ResponseParameters](#integrationresponseparameters) +* **TemplateSelectionExpression**: string +* **TimeoutInMillis**: int +* **TlsConfig**: [TlsConfig](#tlsconfig) ## AWS.ApiGatewayV2/IntegrationResponseProperties ### Properties @@ -188,12 +182,6 @@ * **ResponseTemplates**: [IntegrationResponse_ResponseTemplates](#integrationresponseresponsetemplates): The 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. * **TemplateSelectionExpression**: string: The template selection expression for the integration response. Supported only for WebSocket APIs. -## IntegrationResponse_ResponseParameters -### Properties - -## IntegrationResponse_ResponseTemplates -### Properties - ## AWS.ApiGatewayV2/ModelProperties ### Properties * **ApiId**: string (Required, Identifier): The API identifier. @@ -203,9 +191,6 @@ * **Name**: string (Required): The name of the model. * **Schema**: [Model_Schema](#modelschema) (Required): The schema for the model. For application/json models, this should be JSON schema draft 4 model. -## Model_Schema -### Properties - ## AWS.ApiGatewayV2/RouteProperties ### Properties * **ApiId**: string (Required, Identifier): The API identifier. @@ -222,12 +207,6 @@ * **RouteResponseSelectionExpression**: string: The route response selection expression for the route. Supported only for WebSocket APIs. * **Target**: string: The target for the route. -## Route_RequestModels -### Properties - -## Route_RequestParameters -### Properties - ## AWS.ApiGatewayV2/RouteResponseProperties ### Properties * **ApiId**: string (Required, Identifier): The API identifier. @@ -238,12 +217,6 @@ * **RouteResponseId**: string (ReadOnly, Identifier) * **RouteResponseKey**: string (Required): The route response key. -## RouteResponse_ResponseModels -### Properties - -## RouteParameters -### Properties - ## AWS.ApiGatewayV2/VpcLinkProperties ### Properties * **Name**: string (Required) @@ -252,6 +225,77 @@ * **Tags**: [VpcLink_Tags](#vpclinktags): This resource type use map for Tags, suggest to use List of Tag * **VpcLinkId**: string (ReadOnly, Identifier) +## BodyS3Location +### Properties +* **Bucket**: string (WriteOnly): The S3 bucket that contains the OpenAPI definition to import. Required if you specify a ``BodyS3Location`` for an API. +* **Etag**: string (WriteOnly): The Etag of the S3 object. +* **Key**: string (WriteOnly): The key of the S3 object. Required if you specify a ``BodyS3Location`` for an API. +* **Version**: string (WriteOnly): The version of the S3 object. + +## Cors +### Properties +* **AllowCredentials**: bool: Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs. +* **AllowHeaders**: string[]: Represents a collection of allowed headers. Supported only for HTTP APIs. +* **AllowMethods**: string[]: Represents a collection of allowed HTTP methods. Supported only for HTTP APIs. +* **AllowOrigins**: string[]: Represents a collection of allowed origins. Supported only for HTTP APIs. +* **ExposeHeaders**: string[]: Represents a collection of exposed headers. Supported only for HTTP APIs. +* **MaxAge**: int: The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs. + +## DomainName_Tags +### Properties + +## DomainNameConfiguration +### Properties +* **CertificateArn**: string: An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source. +* **CertificateName**: string: The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name. +* **EndpointType**: string: The endpoint type. +* **OwnershipVerificationCertificateArn**: string: The Amazon resource name (ARN) for the public certificate issued by ACMlong. 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. +* **SecurityPolicy**: string: The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are ``TLS_1_0`` and ``TLS_1_2``. + +## Integration_RequestParameters +### Properties + +## Integration_RequestTemplates +### Properties + +## Integration_ResponseParameters +### Properties + +## IntegrationResponse_ResponseParameters +### Properties + +## IntegrationResponse_ResponseTemplates +### Properties + +## JWTConfiguration +### Properties +* **Audience**: string[]: A list of the intended recipients of the JWT. A valid JWT must provide an ``aud`` that matches at least one entry in this list. See [RFC 7519](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc7519#section-4.1.3). Required for the ``JWT`` authorizer type. Supported only for HTTP APIs. +* **Issuer**: string: The base domain of the identity provider that issues JSON Web Tokens. For example, an Amazon Cognito user pool has the following format: ``https://cognito-idp.{region}.amazonaws.com/{userPoolId}``. Required for the ``JWT`` authorizer type. Supported only for HTTP APIs. + +## Model_Schema +### Properties + +## MutualTlsAuthentication +### Properties +* **TruststoreUri**: string: An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, ``s3://bucket-name/key-name``. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object. +* **TruststoreVersion**: string: The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket. + +## Route_RequestModels +### Properties + +## Route_RequestParameters +### Properties + +## RouteParameters +### Properties + +## RouteResponse_ResponseModels +### Properties + +## TlsConfig +### Properties +* **ServerNameToVerify**: string + ## VpcLink_Tags ### Properties diff --git a/artifacts/bicep/aws/aws.appconfig/default/types.json b/artifacts/bicep/aws/aws.appconfig/default/types.json index 4dd0ce0a..69e81013 100644 --- a/artifacts/bicep/aws/aws.appconfig/default/types.json +++ b/artifacts/bicep/aws/aws.appconfig/default/types.json @@ -1 +1,767 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"Tags","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key-value string map. The valid character set is [a-zA-Z1-9 +-=._:/-]. The tag key can be up to 128 characters and must not start with aws:."},"Value":{"Type":4,"Flags":1,"Description":"The tag value can be up to 256 characters."}}}},{"2":{"Name":"AWS.AppConfig/ApplicationProperties","Properties":{"ApplicationId":{"Type":4,"Flags":18,"Description":"The application Id"},"Description":{"Type":4,"Flags":0,"Description":"A description of the application."},"Name":{"Type":4,"Flags":1,"Description":"A name for the application."},"Tags":{"Type":10,"Flags":0,"Description":"Metadata 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 you define."}}}},{"3":{"ItemType":8}},{"2":{"Name":"AWS.AppConfig/Application","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":9,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.AppConfig/Application@default","ScopeType":0,"Body":11}},{"2":{"Name":"Tags","Properties":{"Key":{"Type":4,"Flags":0,"Description":"The key-value string map. The tag key can be up to 128 characters and must not start with aws:."},"Value":{"Type":4,"Flags":0,"Description":"The tag value can be up to 256 characters."}}}},{"2":{"Name":"Validators","Properties":{"Content":{"Type":4,"Flags":0,"Description":"Either the JSON Schema content or the Amazon Resource Name (ARN) of an Lambda function."},"Type":{"Type":4,"Flags":0,"Description":"AWS AppConfig supports validators of type JSON_SCHEMA and LAMBDA."}}}},{"2":{"Name":"AWS.AppConfig/ConfigurationProfileProperties","Properties":{"ApplicationId":{"Type":4,"Flags":17,"Description":"The application ID."},"ConfigurationProfileId":{"Type":4,"Flags":18,"Description":"The configuration profile ID"},"Description":{"Type":4,"Flags":0,"Description":"A description of the configuration profile."},"KmsKeyArn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name of the AWS Key Management Service key to encrypt new configuration data versions in the AWS AppConfig hosted configuration store. This attribute is only used for hosted configuration types. To encrypt data managed in other configuration stores, see the documentation for how to specify an AWS KMS key for that particular service."},"KmsKeyIdentifier":{"Type":4,"Flags":0,"Description":"The AWS Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated."},"LocationUri":{"Type":4,"Flags":1,"Description":"A URI to locate the configuration. You can specify the AWS AppConfig hosted configuration store, Systems Manager (SSM) document, an SSM Parameter Store parameter, or an Amazon S3 object."},"Name":{"Type":4,"Flags":1,"Description":"A name for the configuration profile."},"RetrievalRoleArn":{"Type":4,"Flags":0,"Description":"The ARN of an IAM role with permission to access the configuration at the specified LocationUri."},"Tags":{"Type":16,"Flags":0,"Description":"Metadata to assign to the configuration profile. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define."},"Type":{"Type":4,"Flags":0,"Description":"The type of configurations contained in the profile. When calling this API, enter one of the following values for Type: AWS.AppConfig.FeatureFlags, AWS.Freeform"},"Validators":{"Type":17,"Flags":0,"Description":"A list of methods for validating the configuration."}}}},{"3":{"ItemType":13}},{"3":{"ItemType":14}},{"2":{"Name":"AWS.AppConfig/ConfigurationProfile","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":15,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.AppConfig/ConfigurationProfile@default","ScopeType":0,"Body":18}},{"2":{"Name":"Action","Properties":{"Description":{"Type":4,"Flags":0,"Description":"The description of the extension Action."},"Name":{"Type":4,"Flags":1,"Description":"The name of the extension action."},"RoleArn":{"Type":4,"Flags":0,"Description":"The ARN of the role for invoking the extension action."},"Uri":{"Type":4,"Flags":1,"Description":"The URI of the extension action."}}}},{"2":{"Name":"Actions"}},{"2":{"Name":"Parameter","Properties":{"Description":{"Type":4,"Flags":0,"Description":"The description of the extension Parameter."},"Required":{"Type":2,"Flags":1}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"3":{"ItemType":20}},{"2":{"Name":"AWS.AppConfig/ExtensionProperties","Properties":{"Actions":{"Type":26,"Flags":1},"Arn":{"Type":4,"Flags":2},"Description":{"Type":4,"Flags":0,"Description":"Description of the extension."},"Id":{"Type":4,"Flags":18},"LatestVersionNumber":{"Type":3,"Flags":4},"Name":{"Type":4,"Flags":1,"Description":"Name of the extension."},"Parameters":{"Type":27,"Flags":0},"Tags":{"Type":28,"Flags":4,"Description":"An array of key-value tags to apply to this resource."},"VersionNumber":{"Type":3,"Flags":2}}}},{"2":{"Name":"Extension_Actions","Properties":{}}},{"2":{"Name":"Extension_Parameters","Properties":{}}},{"3":{"ItemType":23}},{"2":{"Name":"AWS.AppConfig/Extension","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":25,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.AppConfig/Extension@default","ScopeType":0,"Body":29}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.AppConfig/ExtensionAssociationProperties","Properties":{"Arn":{"Type":4,"Flags":2},"ExtensionArn":{"Type":4,"Flags":2},"ExtensionIdentifier":{"Type":4,"Flags":4},"ExtensionVersionNumber":{"Type":3,"Flags":0},"Id":{"Type":4,"Flags":18},"Parameters":{"Type":33,"Flags":0},"ResourceArn":{"Type":4,"Flags":2},"ResourceIdentifier":{"Type":4,"Flags":4},"Tags":{"Type":34,"Flags":4,"Description":"An array of key-value pairs to apply to this resource."}}}},{"2":{"Name":"ExtensionAssociation_Parameters","Properties":{}}},{"3":{"ItemType":31}},{"2":{"Name":"AWS.AppConfig/ExtensionAssociation","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":32,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.AppConfig/ExtensionAssociation@default","ScopeType":0,"Body":35}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Tags", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key-value string map. The valid character set is [a-zA-Z1-9 +-=._:/-]. The tag key can be up to 128 characters and must not start with aws:." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The tag value can be up to 256 characters." + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.AppConfig/ApplicationProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ObjectType", + "name": "AWS.AppConfig/ApplicationProperties", + "properties": { + "ApplicationId": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The application Id" + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A description of the application." + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "A name for the application." + }, + "Tags": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "Metadata 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 you define." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.AppConfig/Application", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.AppConfig/Application@default", + "scopeType": 0, + "body": { + "$ref": "#/5" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tags", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The key-value string map. The tag key can be up to 128 characters and must not start with aws:." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The tag value can be up to 256 characters." + } + } + }, + { + "$type": "ObjectType", + "name": "Validators", + "properties": { + "Content": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Either the JSON Schema content or the Amazon Resource Name (ARN) of an Lambda function." + }, + "Type": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "AWS AppConfig supports validators of type JSON_SCHEMA and LAMBDA." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.AppConfig/ConfigurationProfileProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/7" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/8" + } + }, + { + "$type": "ObjectType", + "name": "AWS.AppConfig/ConfigurationProfileProperties", + "properties": { + "ApplicationId": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The application ID." + }, + "ConfigurationProfileId": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The configuration profile ID" + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A description of the configuration profile." + }, + "KmsKeyArn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The Amazon Resource Name of the AWS Key Management Service key to encrypt new configuration data versions in the AWS AppConfig hosted configuration store. This attribute is only used for hosted configuration types. To encrypt data managed in other configuration stores, see the documentation for how to specify an AWS KMS key for that particular service." + }, + "KmsKeyIdentifier": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The AWS Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated." + }, + "LocationUri": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "A URI to locate the configuration. You can specify the AWS AppConfig hosted configuration store, Systems Manager (SSM) document, an SSM Parameter Store parameter, or an Amazon S3 object." + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "A name for the configuration profile." + }, + "RetrievalRoleArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The ARN of an IAM role with permission to access the configuration at the specified LocationUri." + }, + "Tags": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "Metadata to assign to the configuration profile. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define." + }, + "Type": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The type of configurations contained in the profile. When calling this API, enter one of the following values for Type: AWS.AppConfig.FeatureFlags, AWS.Freeform" + }, + "Validators": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "A list of methods for validating the configuration." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.AppConfig/ConfigurationProfile", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/12" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.AppConfig/ConfigurationProfile@default", + "scopeType": 0, + "body": { + "$ref": "#/13" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Monitor", + "properties": { + "AlarmArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Amazon Resource Name (ARN) of the Amazon CloudWatch alarm." + }, + "AlarmRoleArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "ARN of an AWS Identity and Access Management (IAM) role for AWS AppConfig to monitor AlarmArn." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key-value string map. The valid character set is [a-zA-Z1-9+-=._:/]. The tag key can be up to 128 characters and must not start with aws:." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The tag value can be up to 256 characters." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.AppConfig/EnvironmentProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/15" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/16" + } + }, + { + "$type": "ObjectType", + "name": "AWS.AppConfig/EnvironmentProperties", + "properties": { + "ApplicationId": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The application ID." + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A description of the environment." + }, + "EnvironmentId": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The environment ID." + }, + "Monitors": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "Amazon CloudWatch alarms to monitor during the deployment process." + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "A name for the environment." + }, + "Tags": { + "type": { + "$ref": "#/19" + }, + "flags": 0, + "description": "Metadata 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 you define." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.AppConfig/Environment", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/20" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.AppConfig/Environment@default", + "scopeType": 0, + "body": { + "$ref": "#/21" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Action", + "properties": { + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The description of the extension Action." + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The name of the extension action." + }, + "RoleArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The ARN of the role for invoking the extension action." + }, + "Uri": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The URI of the extension action." + } + } + }, + { + "$type": "ObjectType", + "name": "Actions", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Parameter", + "properties": { + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The description of the extension Parameter." + }, + "Dynamic": { + "type": { + "$ref": "#/28" + }, + "flags": 0 + }, + "Required": { + "type": { + "$ref": "#/28" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/23" + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.AppConfig/ExtensionProperties" + }, + { + "$type": "ObjectType", + "name": "Extension_Actions", + "properties": {} + }, + { + "$type": "IntegerType" + }, + { + "$type": "ObjectType", + "name": "Extension_Parameters", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/26" + } + }, + { + "$type": "ObjectType", + "name": "AWS.AppConfig/ExtensionProperties", + "properties": { + "Actions": { + "type": { + "$ref": "#/30" + }, + "flags": 1 + }, + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Description of the extension." + }, + "Id": { + "type": { + "$ref": "#/1" + }, + "flags": 18 + }, + "LatestVersionNumber": { + "type": { + "$ref": "#/31" + }, + "flags": 4 + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Name of the extension." + }, + "Parameters": { + "type": { + "$ref": "#/32" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/33" + }, + "flags": 4, + "description": "An array of key-value tags to apply to this resource." + }, + "VersionNumber": { + "type": { + "$ref": "#/31" + }, + "flags": 2 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.AppConfig/Extension", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/34" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.AppConfig/Extension@default", + "scopeType": 0, + "body": { + "$ref": "#/35" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.AppConfig/ExtensionAssociationProperties" + }, + { + "$type": "ObjectType", + "name": "ExtensionAssociation_Parameters", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/37" + } + }, + { + "$type": "ObjectType", + "name": "AWS.AppConfig/ExtensionAssociationProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "ExtensionArn": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "ExtensionIdentifier": { + "type": { + "$ref": "#/1" + }, + "flags": 4 + }, + "ExtensionVersionNumber": { + "type": { + "$ref": "#/31" + }, + "flags": 0 + }, + "Id": { + "type": { + "$ref": "#/1" + }, + "flags": 18 + }, + "Parameters": { + "type": { + "$ref": "#/39" + }, + "flags": 0 + }, + "ResourceArn": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "ResourceIdentifier": { + "type": { + "$ref": "#/1" + }, + "flags": 4 + }, + "Tags": { + "type": { + "$ref": "#/40" + }, + "flags": 4, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.AppConfig/ExtensionAssociation", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/41" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.AppConfig/ExtensionAssociation@default", + "scopeType": 0, + "body": { + "$ref": "#/42" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.appconfig/default/types.md b/artifacts/bicep/aws/aws.appconfig/default/types.md index 15ff26f4..5ee4519f 100644 --- a/artifacts/bicep/aws/aws.appconfig/default/types.md +++ b/artifacts/bicep/aws/aws.appconfig/default/types.md @@ -3,30 +3,37 @@ ## Resource AWS.AppConfig/Application@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.AppConfig/ApplicationProperties](#awsappconfigapplicationproperties) (Required): properties of the resource +* **properties**: [AWS.AppConfig/ApplicationProperties](#awsappconfigapplicationproperties) (Required, Identifier): properties of the resource ## Resource AWS.AppConfig/ConfigurationProfile@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.AppConfig/ConfigurationProfileProperties](#awsappconfigconfigurationprofileproperties) (Required): properties of the resource +* **properties**: [AWS.AppConfig/ConfigurationProfileProperties](#awsappconfigconfigurationprofileproperties) (Required, Identifier): properties of the resource + +## Resource AWS.AppConfig/Environment@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.AppConfig/EnvironmentProperties](#awsappconfigenvironmentproperties) (Required, Identifier): properties of the resource ## Resource AWS.AppConfig/Extension@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.AppConfig/ExtensionProperties](#awsappconfigextensionproperties) (Required): properties of the resource +* **properties**: [AWS.AppConfig/ExtensionProperties](#awsappconfigextensionproperties) (Required, Identifier): properties of the resource ## Resource AWS.AppConfig/ExtensionAssociation@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.AppConfig/ExtensionAssociationProperties](#awsappconfigextensionassociationproperties): properties of the resource +* **properties**: [AWS.AppConfig/ExtensionAssociationProperties](#awsappconfigextensionassociationproperties) (Identifier): properties of the resource ## AWS.AppConfig/ApplicationProperties ### Properties @@ -35,11 +42,6 @@ * **Name**: string (Required): A name for the application. * **Tags**: [Tags](#tags)[]: Metadata 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 you define. -## Tags -### Properties -* **Key**: string (Required): The key-value string map. The valid character set is [a-zA-Z1-9 +-=._:/-]. The tag key can be up to 128 characters and must not start with aws:. -* **Value**: string (Required): The tag value can be up to 256 characters. - ## AWS.AppConfig/ConfigurationProfileProperties ### Properties * **ApplicationId**: string (Required, Identifier): The application ID. @@ -54,15 +56,26 @@ * **Type**: string: The type of configurations contained in the profile. When calling this API, enter one of the following values for Type: AWS.AppConfig.FeatureFlags, AWS.Freeform * **Validators**: [Validators](#validators)[]: A list of methods for validating the configuration. -## Tags +## AWS.AppConfig/EnvironmentProperties ### Properties -* **Key**: string: The key-value string map. The tag key can be up to 128 characters and must not start with aws:. -* **Value**: string: The tag value can be up to 256 characters. +* **ApplicationId**: string (Required, Identifier): The application ID. +* **Description**: string: A description of the environment. +* **EnvironmentId**: string (ReadOnly, Identifier): The environment ID. +* **Monitors**: [Monitor](#monitor)[]: Amazon CloudWatch alarms to monitor during the deployment process. +* **Name**: string (Required): A name for the environment. +* **Tags**: [Tag](#tag)[]: Metadata 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 you define. -## Validators +## AWS.AppConfig/ExtensionAssociationProperties ### Properties -* **Content**: string: Either the JSON Schema content or the Amazon Resource Name (ARN) of an Lambda function. -* **Type**: string: AWS AppConfig supports validators of type JSON_SCHEMA and LAMBDA. +* **Arn**: string (ReadOnly) +* **ExtensionArn**: string (ReadOnly) +* **ExtensionIdentifier**: string (WriteOnly) +* **ExtensionVersionNumber**: int +* **Id**: string (ReadOnly, Identifier) +* **Parameters**: [ExtensionAssociation_Parameters](#extensionassociationparameters) +* **ResourceArn**: string (ReadOnly) +* **ResourceIdentifier**: string (WriteOnly) +* **Tags**: [Tag](#tag)[] (WriteOnly): An array of key-value pairs to apply to this resource. ## AWS.AppConfig/ExtensionProperties ### Properties @@ -82,28 +95,41 @@ ## Extension_Parameters ### Properties -## Tag +## ExtensionAssociation_Parameters ### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -## AWS.AppConfig/ExtensionAssociationProperties +## Monitor ### Properties -* **Arn**: string (ReadOnly) -* **ExtensionArn**: string (ReadOnly) -* **ExtensionIdentifier**: string (WriteOnly) -* **ExtensionVersionNumber**: int -* **Id**: string (ReadOnly, Identifier) -* **Parameters**: [ExtensionAssociation_Parameters](#extensionassociationparameters) -* **ResourceArn**: string (ReadOnly) -* **ResourceIdentifier**: string (WriteOnly) -* **Tags**: [Tag](#tag)[] (WriteOnly): An array of key-value pairs to apply to this resource. +* **AlarmArn**: string (Required): Amazon Resource Name (ARN) of the Amazon CloudWatch alarm. +* **AlarmRoleArn**: string: ARN of an AWS Identity and Access Management (IAM) role for AWS AppConfig to monitor AlarmArn. -## ExtensionAssociation_Parameters +## Tag +### Properties +* **Key**: string (Required): The key-value string map. The valid character set is [a-zA-Z1-9+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. +* **Value**: string (Required): The tag value can be up to 256 characters. + +## Tag ### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ## Tag ### Properties * **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. * **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +## Tags +### Properties +* **Key**: string (Required): The key-value string map. The valid character set is [a-zA-Z1-9 +-=._:/-]. The tag key can be up to 128 characters and must not start with aws:. +* **Value**: string (Required): The tag value can be up to 256 characters. + +## Tags +### Properties +* **Key**: string: The key-value string map. The tag key can be up to 128 characters and must not start with aws:. +* **Value**: string: The tag value can be up to 256 characters. + +## Validators +### Properties +* **Content**: string: Either the JSON Schema content or the Amazon Resource Name (ARN) of an Lambda function. +* **Type**: string: AWS AppConfig supports validators of type JSON_SCHEMA and LAMBDA. + diff --git a/artifacts/bicep/aws/aws.appflow/default/types.json b/artifacts/bicep/aws/aws.appflow/default/types.json index 6c9edcb4..2fe65cda 100644 --- a/artifacts/bicep/aws/aws.appflow/default/types.json +++ b/artifacts/bicep/aws/aws.appflow/default/types.json @@ -1 +1,3469 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"ConnectorProvisioningConfig","Properties":{"Lambda":{"Type":9,"Flags":0,"Description":"Contains information about the configuration of the lambda which is being registered as the connector."}}}},{"2":{"Name":"LambdaConnectorProvisioningConfig","Properties":{"LambdaArn":{"Type":4,"Flags":1,"Description":"Lambda ARN of the connector being registered."}}}},{"2":{"Name":"AWS.AppFlow/ConnectorProperties","Properties":{"ConnectorArn":{"Type":4,"Flags":2,"Description":" The arn of the connector. The arn is unique for each ConnectorRegistration in your AWS account."},"ConnectorLabel":{"Type":4,"Flags":16,"Description":" The name of the connector. The name is unique for each ConnectorRegistration in your AWS account."},"ConnectorProvisioningConfig":{"Type":8,"Flags":1,"Description":"Contains information about the configuration of the connector being registered."},"ConnectorProvisioningType":{"Type":4,"Flags":1,"Description":"The provisioning type of the connector. Currently the only supported value is LAMBDA. "},"Description":{"Type":4,"Flags":0,"Description":"A description about the connector that's being registered."}}}},{"2":{"Name":"AWS.AppFlow/Connector","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":10,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.AppFlow/Connector@default","ScopeType":0,"Body":11}},{"2":{"Name":"AccessKeyId"}},{"2":{"Name":"AccessToken"}},{"2":{"Name":"AccountName"}},{"2":{"Name":"AmplitudeConnectorProfileCredentials","Properties":{"ApiKey":{"Type":4,"Flags":1,"Description":"A unique alphanumeric identi?er used to authenticate a user, developer, or calling program to your API."},"SecretKey":{"Type":4,"Flags":1}}}},{"2":{"Name":"ApiKey"}},{"2":{"Name":"ApiKeyCredentials","Properties":{"ApiKey":{"Type":4,"Flags":1},"ApiSecretKey":{"Type":4,"Flags":0}}}},{"2":{"Name":"ApiSecretKey"}},{"2":{"Name":"ApiToken"}},{"2":{"Name":"ApplicationHostUrl"}},{"2":{"Name":"ApplicationKey"}},{"2":{"Name":"ApplicationServicePath"}},{"2":{"Name":"AuthCode"}},{"2":{"Name":"AuthenticationType"}},{"2":{"Name":"BasicAuthCredentials","Properties":{"Password":{"Type":4,"Flags":1},"Username":{"Type":4,"Flags":1}}}},{"2":{"Name":"BucketName"}},{"2":{"Name":"BucketPrefix"}},{"2":{"Name":"BusinessUnitId"}},{"2":{"Name":"ClientCredentialsArn"}},{"2":{"Name":"ClientId"}},{"2":{"Name":"ClientNumber"}},{"2":{"Name":"ClientSecret"}},{"2":{"Name":"ClusterIdentifier"}},{"2":{"Name":"ConnectorOAuthRequest","Properties":{"AuthCode":{"Type":4,"Flags":0,"Description":"The code provided by the connector when it has been authenticated via the connected app."},"RedirectUri":{"Type":4,"Flags":0,"Description":"The URL to which the authentication server redirects the browser after authorization has been\ngranted."}}}},{"2":{"Name":"ConnectorProfileConfig","Properties":{"ConnectorProfileCredentials":{"Type":37,"Flags":0},"ConnectorProfileProperties":{"Type":38,"Flags":0}}}},{"2":{"Name":"ConnectorProfileCredentials","Properties":{"Amplitude":{"Type":16,"Flags":0},"CustomConnector":{"Type":43,"Flags":0},"Datadog":{"Type":48,"Flags":0},"Dynatrace":{"Type":50,"Flags":0},"GoogleAnalytics":{"Type":52,"Flags":0},"InforNexus":{"Type":53,"Flags":0},"Marketo":{"Type":59,"Flags":0},"Pardot":{"Type":65,"Flags":0},"Redshift":{"Type":71,"Flags":0},"SAPOData":{"Type":76,"Flags":0},"Salesforce":{"Type":78,"Flags":0},"ServiceNow":{"Type":81,"Flags":0},"Singular":{"Type":83,"Flags":0},"Slack":{"Type":84,"Flags":0},"Snowflake":{"Type":86,"Flags":0},"Trendmicro":{"Type":90,"Flags":0},"Veeva":{"Type":92,"Flags":0},"Zendesk":{"Type":96,"Flags":0}}}},{"2":{"Name":"ConnectorProfileProperties","Properties":{"CustomConnector":{"Type":44,"Flags":0},"Datadog":{"Type":49,"Flags":0},"Dynatrace":{"Type":51,"Flags":0},"InforNexus":{"Type":54,"Flags":0},"Marketo":{"Type":60,"Flags":0},"Pardot":{"Type":66,"Flags":0},"Redshift":{"Type":72,"Flags":0},"SAPOData":{"Type":77,"Flags":0},"Salesforce":{"Type":79,"Flags":0},"ServiceNow":{"Type":82,"Flags":0},"Slack":{"Type":85,"Flags":0},"Snowflake":{"Type":87,"Flags":0},"Veeva":{"Type":93,"Flags":0},"Zendesk":{"Type":97,"Flags":0}}}},{"2":{"Name":"ConnectorType"}},{"2":{"Name":"CredentialsMap","Properties":{}}},{"2":{"Name":"CustomAuthCredentials","Properties":{"CredentialsMap":{"Type":40,"Flags":0},"CustomAuthenticationType":{"Type":4,"Flags":1}}}},{"2":{"Name":"CustomAuthenticationType"}},{"2":{"Name":"CustomConnectorProfileCredentials","Properties":{"ApiKey":{"Type":18,"Flags":0},"AuthenticationType":{"Type":4,"Flags":1},"Basic":{"Type":26,"Flags":0},"Custom":{"Type":41,"Flags":0},"Oauth2":{"Type":61,"Flags":0}}}},{"2":{"Name":"CustomConnectorProfileProperties","Properties":{"OAuth2Properties":{"Type":63,"Flags":0},"ProfileProperties":{"Type":70,"Flags":0}}}},{"2":{"Name":"DataApiRoleArn"}},{"2":{"Name":"DatabaseName"}},{"2":{"Name":"DatabaseUrl"}},{"2":{"Name":"DatadogConnectorProfileCredentials","Properties":{"ApiKey":{"Type":4,"Flags":1,"Description":"A unique alphanumeric identi?er used to authenticate a user, developer, or calling program to your API."},"ApplicationKey":{"Type":4,"Flags":1,"Description":"Application keys, in conjunction with your API key, give you full access to Datadog?s programmatic API. Application keys are associated with the user account that created them. The application key is used to log all requests made to the API."}}}},{"2":{"Name":"DatadogConnectorProfileProperties","Properties":{"InstanceUrl":{"Type":4,"Flags":1,"Description":"The location of the Datadog resource"}}}},{"2":{"Name":"DynatraceConnectorProfileCredentials","Properties":{"ApiToken":{"Type":4,"Flags":1,"Description":"The API tokens used by Dynatrace API to authenticate various API calls."}}}},{"2":{"Name":"DynatraceConnectorProfileProperties","Properties":{"InstanceUrl":{"Type":4,"Flags":1,"Description":"The location of the Dynatrace resource"}}}},{"2":{"Name":"GoogleAnalyticsConnectorProfileCredentials","Properties":{"AccessToken":{"Type":4,"Flags":0,"Description":"The credentials used to access protected resources."},"ClientId":{"Type":4,"Flags":1,"Description":"The identi?er for the desired client."},"ClientSecret":{"Type":4,"Flags":1,"Description":"The client secret used by the oauth client to authenticate to the authorization server."},"ConnectorOAuthRequest":{"Type":35,"Flags":0,"Description":"The oauth needed to request security tokens from the connector endpoint."},"RefreshToken":{"Type":4,"Flags":0,"Description":"The credentials used to acquire new access tokens."}}}},{"2":{"Name":"InforNexusConnectorProfileCredentials","Properties":{"AccessKeyId":{"Type":4,"Flags":1,"Description":"The Access Key portion of the credentials."},"Datakey":{"Type":4,"Flags":1,"Description":"The encryption keys used to encrypt data."},"SecretAccessKey":{"Type":4,"Flags":1,"Description":"The secret key used to sign requests."},"UserId":{"Type":4,"Flags":1,"Description":"The identi?er for the user."}}}},{"2":{"Name":"InforNexusConnectorProfileProperties","Properties":{"InstanceUrl":{"Type":4,"Flags":1,"Description":"The location of the InforNexus resource"}}}},{"2":{"Name":"InstanceUrl"}},{"2":{"Name":"JwtToken"}},{"2":{"Name":"Key"}},{"2":{"Name":"LogonLanguage"}},{"2":{"Name":"MarketoConnectorProfileCredentials","Properties":{"AccessToken":{"Type":4,"Flags":0,"Description":"The credentials used to access protected resources."},"ClientId":{"Type":4,"Flags":1,"Description":"The identi?er for the desired client."},"ClientSecret":{"Type":4,"Flags":1,"Description":"The client secret used by the oauth client to authenticate to the authorization server."},"ConnectorOAuthRequest":{"Type":35,"Flags":0,"Description":"The oauth needed to request security tokens from the connector endpoint."}}}},{"2":{"Name":"MarketoConnectorProfileProperties","Properties":{"InstanceUrl":{"Type":4,"Flags":1,"Description":"The location of the Marketo resource"}}}},{"2":{"Name":"OAuth2Credentials","Properties":{"AccessToken":{"Type":4,"Flags":0},"ClientId":{"Type":4,"Flags":0},"ClientSecret":{"Type":4,"Flags":0},"OAuthRequest":{"Type":35,"Flags":0},"RefreshToken":{"Type":4,"Flags":0}}}},{"2":{"Name":"OAuth2GrantType"}},{"2":{"Name":"OAuth2Properties","Properties":{"OAuth2GrantType":{"Type":4,"Flags":0},"TokenUrl":{"Type":4,"Flags":0},"TokenUrlCustomProperties":{"Type":89,"Flags":0}}}},{"2":{"Name":"OAuthProperties","Properties":{"AuthCodeUrl":{"Type":4,"Flags":0},"OAuthScopes":{"Type":98,"Flags":0},"TokenUrl":{"Type":4,"Flags":0}}}},{"2":{"Name":"PardotConnectorProfileCredentials","Properties":{"AccessToken":{"Type":4,"Flags":0,"Description":"The credentials used to access protected resources."},"ClientCredentialsArn":{"Type":4,"Flags":0,"Description":"The client credentials to fetch access token and refresh token."},"ConnectorOAuthRequest":{"Type":35,"Flags":0,"Description":"The oauth needed to request security tokens from the connector endpoint."},"RefreshToken":{"Type":4,"Flags":0,"Description":"The credentials used to acquire new access tokens."}}}},{"2":{"Name":"PardotConnectorProfileProperties","Properties":{"BusinessUnitId":{"Type":4,"Flags":1,"Description":"The Business unit id of Salesforce Pardot instance to be connected"},"InstanceUrl":{"Type":4,"Flags":0,"Description":"The location of the Salesforce Pardot resource"},"IsSandboxEnvironment":{"Type":2,"Flags":0,"Description":"Indicates whether the connector profile applies to a demo or production environment"}}}},{"2":{"Name":"Password"}},{"2":{"Name":"PortNumber"}},{"2":{"Name":"PrivateLinkServiceName"}},{"2":{"Name":"ProfileProperties","Properties":{}}},{"2":{"Name":"RedshiftConnectorProfileCredentials","Properties":{"Password":{"Type":4,"Flags":0,"Description":"The password that corresponds to the username."},"Username":{"Type":4,"Flags":0,"Description":"The name of the user."}}}},{"2":{"Name":"RedshiftConnectorProfileProperties","Properties":{"BucketName":{"Type":4,"Flags":1,"Description":"The name of the Amazon S3 bucket associated with Redshift."},"BucketPrefix":{"Type":4,"Flags":0,"Description":"The object key for the destination bucket in which Amazon AppFlow will place the ?les."},"ClusterIdentifier":{"Type":4,"Flags":0,"Description":"The unique identifier of the Amazon Redshift cluster."},"DataApiRoleArn":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) of the IAM role that grants Amazon AppFlow access to the data through the Amazon Redshift Data API."},"DatabaseName":{"Type":4,"Flags":0,"Description":"The name of the Amazon Redshift database that will store the transferred data."},"DatabaseUrl":{"Type":4,"Flags":0,"Description":"The JDBC URL of the Amazon Redshift cluster."},"IsRedshiftServerless":{"Type":2,"Flags":0,"Description":"If Amazon AppFlow will connect to Amazon Redshift Serverless or Amazon Redshift cluster."},"RoleArn":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) of the IAM role."},"WorkgroupName":{"Type":4,"Flags":0,"Description":"The name of the Amazon Redshift serverless workgroup"}}}},{"2":{"Name":"RefreshToken"}},{"2":{"Name":"Region"}},{"2":{"Name":"RoleArn"}},{"2":{"Name":"SAPODataConnectorProfileCredentials","Properties":{"BasicAuthCredentials":{"Type":26,"Flags":0},"OAuthCredentials":{"Type":99,"Flags":0}}}},{"2":{"Name":"SAPODataConnectorProfileProperties","Properties":{"ApplicationHostUrl":{"Type":4,"Flags":0},"ApplicationServicePath":{"Type":4,"Flags":0},"ClientNumber":{"Type":4,"Flags":0},"DisableSSO":{"Type":2,"Flags":0,"Description":"If you set this parameter to true, Amazon AppFlow bypasses the single sign-on (SSO) settings in your SAP account when it accesses your SAP OData instance."},"LogonLanguage":{"Type":4,"Flags":0},"OAuthProperties":{"Type":64,"Flags":0},"PortNumber":{"Type":3,"Flags":0},"PrivateLinkServiceName":{"Type":4,"Flags":0}}}},{"2":{"Name":"SalesforceConnectorProfileCredentials","Properties":{"AccessToken":{"Type":4,"Flags":0,"Description":"The credentials used to access protected resources."},"ClientCredentialsArn":{"Type":4,"Flags":0,"Description":"The client credentials to fetch access token and refresh token."},"ConnectorOAuthRequest":{"Type":35,"Flags":0,"Description":"The oauth needed to request security tokens from the connector endpoint."},"JwtToken":{"Type":4,"Flags":0,"Description":"The credentials used to access your Salesforce records"},"OAuth2GrantType":{"Type":4,"Flags":0,"Description":"The grant types to fetch an access token"},"RefreshToken":{"Type":4,"Flags":0,"Description":"The credentials used to acquire new access tokens."}}}},{"2":{"Name":"SalesforceConnectorProfileProperties","Properties":{"InstanceUrl":{"Type":4,"Flags":0,"Description":"The location of the Salesforce resource"},"isSandboxEnvironment":{"Type":2,"Flags":0,"Description":"Indicates whether the connector profile applies to a sandbox or production environment"},"usePrivateLinkForMetadataAndAuthorization":{"Type":2,"Flags":0,"Description":"Indicates whether to make Metadata And Authorization calls over Pivate Network"}}}},{"2":{"Name":"SecretKey"}},{"2":{"Name":"ServiceNowConnectorProfileCredentials","Properties":{"OAuth2Credentials":{"Type":61,"Flags":0,"Description":"The OAuth 2.0 credentials required to authenticate the user."},"Password":{"Type":4,"Flags":0,"Description":"The password that corresponds to the username."},"Username":{"Type":4,"Flags":0,"Description":"The name of the user."}}}},{"2":{"Name":"ServiceNowConnectorProfileProperties","Properties":{"InstanceUrl":{"Type":4,"Flags":1,"Description":"The location of the ServiceNow resource"}}}},{"2":{"Name":"SingularConnectorProfileCredentials","Properties":{"ApiKey":{"Type":4,"Flags":1,"Description":"A unique alphanumeric identi?er used to authenticate a user, developer, or calling program to your API."}}}},{"2":{"Name":"SlackConnectorProfileCredentials","Properties":{"AccessToken":{"Type":4,"Flags":0,"Description":"The credentials used to access protected resources."},"ClientId":{"Type":4,"Flags":1,"Description":"The identi?er for the desired client."},"ClientSecret":{"Type":4,"Flags":1,"Description":"The client secret used by the oauth client to authenticate to the authorization server."},"ConnectorOAuthRequest":{"Type":35,"Flags":0,"Description":"The oauth needed to request security tokens from the connector endpoint."}}}},{"2":{"Name":"SlackConnectorProfileProperties","Properties":{"InstanceUrl":{"Type":4,"Flags":1,"Description":"The location of the Slack resource"}}}},{"2":{"Name":"SnowflakeConnectorProfileCredentials","Properties":{"Password":{"Type":4,"Flags":1,"Description":"The password that corresponds to the username."},"Username":{"Type":4,"Flags":1,"Description":"The name of the user."}}}},{"2":{"Name":"SnowflakeConnectorProfileProperties","Properties":{"AccountName":{"Type":4,"Flags":0,"Description":"The name of the account."},"BucketName":{"Type":4,"Flags":1,"Description":"The name of the Amazon S3 bucket associated with Snow?ake."},"BucketPrefix":{"Type":4,"Flags":0,"Description":"The bucket prefix that refers to the Amazon S3 bucket associated with Snow?ake."},"PrivateLinkServiceName":{"Type":4,"Flags":0,"Description":"The Snow?ake Private Link service name to be used for private data transfers."},"Region":{"Type":4,"Flags":0,"Description":"The region of the Snow?ake account."},"Stage":{"Type":4,"Flags":1,"Description":"The name of the Amazon S3 stage that was created while setting up an Amazon S3 stage in the\nSnow?ake account. This is written in the following format: < Database>< Schema>."},"Warehouse":{"Type":4,"Flags":1,"Description":"The name of the Snow?ake warehouse."}}}},{"2":{"Name":"Stage"}},{"2":{"Name":"TokenUrlCustomProperties","Properties":{}}},{"2":{"Name":"TrendmicroConnectorProfileCredentials","Properties":{"ApiSecretKey":{"Type":4,"Flags":1,"Description":"The Secret Access Key portion of the credentials."}}}},{"2":{"Name":"Username"}},{"2":{"Name":"VeevaConnectorProfileCredentials","Properties":{"Password":{"Type":4,"Flags":1,"Description":"The password that corresponds to the username."},"Username":{"Type":4,"Flags":1,"Description":"The name of the user."}}}},{"2":{"Name":"VeevaConnectorProfileProperties","Properties":{"InstanceUrl":{"Type":4,"Flags":1,"Description":"The location of the Veeva resource"}}}},{"2":{"Name":"Warehouse"}},{"2":{"Name":"WorkgroupName"}},{"2":{"Name":"ZendeskConnectorProfileCredentials","Properties":{"AccessToken":{"Type":4,"Flags":0,"Description":"The credentials used to access protected resources."},"ClientId":{"Type":4,"Flags":1,"Description":"The identi?er for the desired client."},"ClientSecret":{"Type":4,"Flags":1,"Description":"The client secret used by the oauth client to authenticate to the authorization server."},"ConnectorOAuthRequest":{"Type":35,"Flags":0,"Description":"The oauth needed to request security tokens from the connector endpoint."}}}},{"2":{"Name":"ZendeskConnectorProfileProperties","Properties":{"InstanceUrl":{"Type":4,"Flags":1,"Description":"The location of the Zendesk resource"}}}},{"3":{"ItemType":4}},{"2":{"Name":"ConnectorProfile_OAuthCredentials","Properties":{"AccessToken":{"Type":4,"Flags":0},"ClientId":{"Type":4,"Flags":0},"ClientSecret":{"Type":4,"Flags":0},"ConnectorOAuthRequest":{"Type":35,"Flags":0},"RefreshToken":{"Type":4,"Flags":0}}}},{"2":{"Name":"AWS.AppFlow/ConnectorProfileProperties","Properties":{"ConnectionMode":{"Type":4,"Flags":1,"Description":"Mode in which data transfer should be enabled. Private connection mode is currently enabled for Salesforce, Snowflake, Trendmicro and Singular"},"ConnectorLabel":{"Type":4,"Flags":0,"Description":"The label of the connector. The label is unique for each ConnectorRegistration in your AWS account. Only needed if calling for CUSTOMCONNECTOR connector type/."},"ConnectorProfileArn":{"Type":4,"Flags":2,"Description":"Unique identifier for connector profile resources"},"ConnectorProfileConfig":{"Type":36,"Flags":4,"Description":"Connector specific configurations needed to create connector profile"},"ConnectorProfileName":{"Type":4,"Flags":17,"Description":"The maximum number of items to retrieve in a single batch."},"ConnectorType":{"Type":4,"Flags":1,"Description":"List of Saas providers that need connector profile to be created"},"CredentialsArn":{"Type":4,"Flags":2,"Description":"A unique Arn for Connector-Profile resource"},"KMSArn":{"Type":4,"Flags":4,"Description":"The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment variables. If it's not provided, AWS Lambda uses a default service key."}}}},{"2":{"Name":"AWS.AppFlow/ConnectorProfile","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":100,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.AppFlow/ConnectorProfile@default","ScopeType":0,"Body":101}},{"2":{"Name":"AggregationConfig","Properties":{"AggregationType":{"Type":4,"Flags":0},"TargetFileSize":{"Type":3,"Flags":0}}}},{"2":{"Name":"AggregationType"}},{"2":{"Name":"AmplitudeConnectorOperator"}},{"2":{"Name":"AmplitudeSourceProperties","Properties":{"Object":{"Type":4,"Flags":1}}}},{"2":{"Name":"ApiVersion"}},{"2":{"Name":"BucketName"}},{"2":{"Name":"BucketPrefix"}},{"2":{"Name":"ConnectorOperator","Properties":{"Amplitude":{"Type":4,"Flags":0},"CustomConnector":{"Type":4,"Flags":0},"Datadog":{"Type":4,"Flags":0},"Dynatrace":{"Type":4,"Flags":0},"GoogleAnalytics":{"Type":4,"Flags":0},"InforNexus":{"Type":4,"Flags":0},"Marketo":{"Type":4,"Flags":0},"Pardot":{"Type":4,"Flags":0},"S3":{"Type":4,"Flags":0},"SAPOData":{"Type":4,"Flags":0},"Salesforce":{"Type":4,"Flags":0},"ServiceNow":{"Type":4,"Flags":0},"Singular":{"Type":4,"Flags":0},"Slack":{"Type":4,"Flags":0},"Trendmicro":{"Type":4,"Flags":0},"Veeva":{"Type":4,"Flags":0},"Zendesk":{"Type":4,"Flags":0}}}},{"2":{"Name":"ConnectorProfileName"}},{"2":{"Name":"ConnectorType"}},{"2":{"Name":"CustomConnectorDestinationProperties","Properties":{"CustomProperties":{"Type":115,"Flags":0},"EntityName":{"Type":4,"Flags":1},"ErrorHandlingConfig":{"Type":127,"Flags":0},"IdFieldNames":{"Type":203,"Flags":0,"Description":"List of fields used as ID when performing a write operation."},"WriteOperationType":{"Type":4,"Flags":0}}}},{"2":{"Name":"CustomConnectorSourceProperties","Properties":{"CustomProperties":{"Type":115,"Flags":0},"DataTransferApi":{"Type":204,"Flags":0},"EntityName":{"Type":4,"Flags":1}}}},{"2":{"Name":"CustomProperties","Properties":{}}},{"2":{"Name":"DataTransferApi"}},{"2":{"Name":"DatadogConnectorOperator"}},{"2":{"Name":"DatadogSourceProperties","Properties":{"Object":{"Type":4,"Flags":1}}}},{"2":{"Name":"DatetimeTypeFieldName"}},{"2":{"Name":"DestinationConnectorProperties","Properties":{"CustomConnector":{"Type":113,"Flags":0},"EventBridge":{"Type":128,"Flags":0},"LookoutMetrics":{"Type":140,"Flags":0},"Marketo":{"Type":142,"Flags":0},"Redshift":{"Type":157,"Flags":0},"S3":{"Type":159,"Flags":0},"SAPOData":{"Type":164,"Flags":0},"Salesforce":{"Type":171,"Flags":0},"Snowflake":{"Type":180,"Flags":0},"Upsolver":{"Type":195,"Flags":0},"Zendesk":{"Type":201,"Flags":0}}}},{"2":{"Name":"DestinationFlowConfig","Properties":{"ApiVersion":{"Type":4,"Flags":0,"Description":"The API version that the destination connector uses."},"ConnectorProfileName":{"Type":4,"Flags":0,"Description":"Name of destination connector profile"},"ConnectorType":{"Type":4,"Flags":1,"Description":"Destination connector type"},"DestinationConnectorProperties":{"Type":120,"Flags":1,"Description":"Destination connector details"}}}},{"2":{"Name":"DocumentType"}},{"2":{"Name":"DynatraceConnectorOperator"}},{"2":{"Name":"DynatraceSourceProperties","Properties":{"Object":{"Type":4,"Flags":1}}}},{"2":{"Name":"EnableDynamicFieldUpdate"}},{"2":{"Name":"EntityName"}},{"2":{"Name":"ErrorHandlingConfig","Properties":{"BucketName":{"Type":4,"Flags":0},"BucketPrefix":{"Type":4,"Flags":0},"FailOnFirstError":{"Type":2,"Flags":0}}}},{"2":{"Name":"EventBridgeDestinationProperties","Properties":{"ErrorHandlingConfig":{"Type":127,"Flags":0},"Object":{"Type":4,"Flags":1}}}},{"2":{"Name":"FileType"}},{"2":{"Name":"GlueDataCatalog","Properties":{"DatabaseName":{"Type":4,"Flags":1,"Description":"A string containing the value for the tag"},"RoleArn":{"Type":4,"Flags":1,"Description":"A string containing the value for the tag"},"TablePrefix":{"Type":4,"Flags":1,"Description":"A string containing the value for the tag"}}}},{"2":{"Name":"GoogleAnalyticsConnectorOperator"}},{"2":{"Name":"GoogleAnalyticsSourceProperties","Properties":{"Object":{"Type":4,"Flags":1}}}},{"2":{"Name":"IncludeAllVersions"}},{"2":{"Name":"IncludeDeletedRecords"}},{"2":{"Name":"IncludeRenditions"}},{"2":{"Name":"IncludeSourceFiles"}},{"2":{"Name":"IncrementalPullConfig","Properties":{"DatetimeTypeFieldName":{"Type":4,"Flags":0}}}},{"2":{"Name":"InforNexusConnectorOperator"}},{"2":{"Name":"InforNexusSourceProperties","Properties":{"Object":{"Type":4,"Flags":1}}}},{"2":{"Name":"LookoutMetricsDestinationProperties","Properties":{"Object":{"Type":4,"Flags":0}}}},{"2":{"Name":"MarketoConnectorOperator"}},{"2":{"Name":"MarketoDestinationProperties","Properties":{"ErrorHandlingConfig":{"Type":127,"Flags":0},"Object":{"Type":4,"Flags":1}}}},{"2":{"Name":"MarketoSourceProperties","Properties":{"Object":{"Type":4,"Flags":1}}}},{"2":{"Name":"MetadataCatalogConfig","Properties":{"GlueDataCatalog":{"Type":130,"Flags":0,"Description":"Configurations of glue data catalog of the flow."}}}},{"2":{"Name":"Name"}},{"2":{"Name":"Object"}},{"2":{"Name":"Operator"}},{"2":{"Name":"OperatorPropertiesKeys"}},{"2":{"Name":"PardotConnectorOperator"}},{"2":{"Name":"PardotSourceProperties","Properties":{"Object":{"Type":4,"Flags":1}}}},{"2":{"Name":"PathPrefix"}},{"2":{"Name":"PathPrefixHierarchy"}},{"2":{"Name":"PrefixConfig","Properties":{"PathPrefixHierarchy":{"Type":206,"Flags":0},"PrefixFormat":{"Type":4,"Flags":0},"PrefixType":{"Type":4,"Flags":0}}}},{"2":{"Name":"PrefixFormat"}},{"2":{"Name":"PrefixType"}},{"2":{"Name":"PreserveSourceDataTyping"}},{"2":{"Name":"RedshiftDestinationProperties","Properties":{"BucketPrefix":{"Type":4,"Flags":0},"ErrorHandlingConfig":{"Type":127,"Flags":0},"IntermediateBucketName":{"Type":4,"Flags":1},"Object":{"Type":4,"Flags":1}}}},{"2":{"Name":"S3ConnectorOperator"}},{"2":{"Name":"S3DestinationProperties","Properties":{"BucketName":{"Type":4,"Flags":1},"BucketPrefix":{"Type":4,"Flags":0},"S3OutputFormatConfig":{"Type":161,"Flags":0}}}},{"2":{"Name":"S3InputFormatConfig","Properties":{"S3InputFileType":{"Type":4,"Flags":0}}}},{"2":{"Name":"S3OutputFormatConfig","Properties":{"AggregationConfig":{"Type":103,"Flags":0},"FileType":{"Type":4,"Flags":0},"PrefixConfig":{"Type":153,"Flags":0},"PreserveSourceDataTyping":{"Type":2,"Flags":0}}}},{"2":{"Name":"S3SourceProperties","Properties":{"BucketName":{"Type":4,"Flags":1},"BucketPrefix":{"Type":4,"Flags":1},"S3InputFormatConfig":{"Type":160,"Flags":0}}}},{"2":{"Name":"SAPODataConnectorOperator"}},{"2":{"Name":"SAPODataDestinationProperties","Properties":{"ErrorHandlingConfig":{"Type":127,"Flags":0},"IdFieldNames":{"Type":207,"Flags":0,"Description":"List of fields used as ID when performing a write operation."},"ObjectPath":{"Type":4,"Flags":1},"SuccessResponseHandlingConfig":{"Type":184,"Flags":0},"WriteOperationType":{"Type":4,"Flags":0}}}},{"2":{"Name":"SAPODataMaxPageSize"}},{"2":{"Name":"SAPODataMaxParallelism"}},{"2":{"Name":"SAPODataPaginationConfig","Properties":{"maxPageSize":{"Type":3,"Flags":1}}}},{"2":{"Name":"SAPODataParallelismConfig","Properties":{"maxParallelism":{"Type":3,"Flags":1}}}},{"2":{"Name":"SAPODataSourceProperties","Properties":{"ObjectPath":{"Type":4,"Flags":1},"paginationConfig":{"Type":167,"Flags":0},"parallelismConfig":{"Type":168,"Flags":0}}}},{"2":{"Name":"SalesforceConnectorOperator"}},{"2":{"Name":"SalesforceDestinationProperties","Properties":{"DataTransferApi":{"Type":4,"Flags":0},"ErrorHandlingConfig":{"Type":127,"Flags":0},"IdFieldNames":{"Type":208,"Flags":0,"Description":"List of fields used as ID when performing a write operation."},"Object":{"Type":4,"Flags":1},"WriteOperationType":{"Type":4,"Flags":0}}}},{"2":{"Name":"SalesforceSourceProperties","Properties":{"DataTransferApi":{"Type":4,"Flags":0},"EnableDynamicFieldUpdate":{"Type":2,"Flags":0},"IncludeDeletedRecords":{"Type":2,"Flags":0},"Object":{"Type":4,"Flags":1}}}},{"2":{"Name":"ScheduledTriggerProperties","Properties":{"DataPullMode":{"Type":4,"Flags":0},"FirstExecutionFrom":{"Type":3,"Flags":0},"FlowErrorDeactivationThreshold":{"Type":3,"Flags":0},"ScheduleEndTime":{"Type":3,"Flags":0},"ScheduleExpression":{"Type":4,"Flags":1},"ScheduleOffset":{"Type":3,"Flags":0},"ScheduleStartTime":{"Type":3,"Flags":0},"TimeZone":{"Type":4,"Flags":0}}}},{"2":{"Name":"ServiceNowConnectorOperator"}},{"2":{"Name":"ServiceNowSourceProperties","Properties":{"Object":{"Type":4,"Flags":1}}}},{"2":{"Name":"SingularConnectorOperator"}},{"2":{"Name":"SingularSourceProperties","Properties":{"Object":{"Type":4,"Flags":1}}}},{"2":{"Name":"SlackConnectorOperator"}},{"2":{"Name":"SlackSourceProperties","Properties":{"Object":{"Type":4,"Flags":1}}}},{"2":{"Name":"SnowflakeDestinationProperties","Properties":{"BucketPrefix":{"Type":4,"Flags":0},"ErrorHandlingConfig":{"Type":127,"Flags":0},"IntermediateBucketName":{"Type":4,"Flags":1},"Object":{"Type":4,"Flags":1}}}},{"2":{"Name":"SourceConnectorProperties","Properties":{"Amplitude":{"Type":106,"Flags":0},"CustomConnector":{"Type":114,"Flags":0},"Datadog":{"Type":118,"Flags":0},"Dynatrace":{"Type":124,"Flags":0},"GoogleAnalytics":{"Type":132,"Flags":0},"InforNexus":{"Type":139,"Flags":0},"Marketo":{"Type":143,"Flags":0},"Pardot":{"Type":150,"Flags":0},"S3":{"Type":162,"Flags":0},"SAPOData":{"Type":169,"Flags":0},"Salesforce":{"Type":172,"Flags":0},"ServiceNow":{"Type":175,"Flags":0},"Singular":{"Type":177,"Flags":0},"Slack":{"Type":179,"Flags":0},"Trendmicro":{"Type":191,"Flags":0},"Veeva":{"Type":198,"Flags":0},"Zendesk":{"Type":202,"Flags":0}}}},{"2":{"Name":"SourceFlowConfig","Properties":{"ApiVersion":{"Type":4,"Flags":0,"Description":"The API version that the destination connector uses."},"ConnectorProfileName":{"Type":4,"Flags":0,"Description":"Name of source connector profile"},"ConnectorType":{"Type":4,"Flags":1,"Description":"Type of source connector"},"IncrementalPullConfig":{"Type":137,"Flags":0,"Description":"Configuration for scheduled incremental data pull"},"SourceConnectorProperties":{"Type":181,"Flags":1,"Description":"Source connector details required to query a connector"}}}},{"2":{"Name":"Status"}},{"2":{"Name":"SuccessResponseHandlingConfig","Properties":{"BucketName":{"Type":4,"Flags":0},"BucketPrefix":{"Type":4,"Flags":0}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"A string used to identify this tag"},"Value":{"Type":4,"Flags":1,"Description":"A string containing the value for the tag"}}}},{"2":{"Name":"TargetFileSize"}},{"2":{"Name":"Task","Properties":{"ConnectorOperator":{"Type":110,"Flags":0,"Description":"Operation to be performed on provided source fields"},"DestinationField":{"Type":4,"Flags":0,"Description":"A field value on which source field should be validated"},"SourceFields":{"Type":209,"Flags":1,"Description":"Source fields on which particular task will be applied"},"TaskProperties":{"Type":210,"Flags":0,"Description":"A Map used to store task related info"},"TaskType":{"Type":4,"Flags":1,"Description":"Type of task"}}}},{"2":{"Name":"TaskPropertiesObject","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"TaskType"}},{"2":{"Name":"TrendmicroConnectorOperator"}},{"2":{"Name":"TrendmicroSourceProperties","Properties":{"Object":{"Type":4,"Flags":1}}}},{"2":{"Name":"TriggerConfig","Properties":{"TriggerProperties":{"Type":173,"Flags":0,"Description":"Details required based on the type of trigger"},"TriggerType":{"Type":4,"Flags":1,"Description":"Trigger type of the flow"}}}},{"2":{"Name":"TriggerType"}},{"2":{"Name":"UpsolverBucketName"}},{"2":{"Name":"UpsolverDestinationProperties","Properties":{"BucketName":{"Type":4,"Flags":1},"BucketPrefix":{"Type":4,"Flags":0},"S3OutputFormatConfig":{"Type":196,"Flags":1}}}},{"2":{"Name":"UpsolverS3OutputFormatConfig","Properties":{"AggregationConfig":{"Type":103,"Flags":0},"FileType":{"Type":4,"Flags":0},"PrefixConfig":{"Type":153,"Flags":1}}}},{"2":{"Name":"VeevaConnectorOperator"}},{"2":{"Name":"VeevaSourceProperties","Properties":{"DocumentType":{"Type":4,"Flags":0},"IncludeAllVersions":{"Type":2,"Flags":0},"IncludeRenditions":{"Type":2,"Flags":0},"IncludeSourceFiles":{"Type":2,"Flags":0},"Object":{"Type":4,"Flags":1}}}},{"2":{"Name":"WriteOperationType"}},{"2":{"Name":"ZendeskConnectorOperator"}},{"2":{"Name":"ZendeskDestinationProperties","Properties":{"ErrorHandlingConfig":{"Type":127,"Flags":0},"IdFieldNames":{"Type":211,"Flags":0,"Description":"List of fields used as ID when performing a write operation."},"Object":{"Type":4,"Flags":1},"WriteOperationType":{"Type":4,"Flags":0}}}},{"2":{"Name":"ZendeskSourceProperties","Properties":{"Object":{"Type":4,"Flags":1}}}},{"3":{"ItemType":4}},{"2":{"Name":"Flow_DataTransferApi","Properties":{"Name":{"Type":4,"Flags":1},"Type":{"Type":4,"Flags":1}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":188}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.AppFlow/FlowProperties","Properties":{"Description":{"Type":4,"Flags":0,"Description":"Description of the flow."},"DestinationFlowConfigList":{"Type":213,"Flags":1,"Description":"List of Destination connectors of the flow."},"FlowArn":{"Type":4,"Flags":2,"Description":"ARN identifier of the flow."},"FlowName":{"Type":4,"Flags":17,"Description":"Name of the flow."},"FlowStatus":{"Type":4,"Flags":0,"Description":"Flow activation status for Scheduled- and Event-triggered flows"},"KMSArn":{"Type":4,"Flags":0,"Description":"The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment variables. If it's not provided, AWS Lambda uses a default service key."},"MetadataCatalogConfig":{"Type":144,"Flags":0,"Description":"Configurations of metadata catalog of the flow."},"SourceFlowConfig":{"Type":182,"Flags":1,"Description":"Configurations of Source connector of the flow."},"Tags":{"Type":214,"Flags":0,"Description":"List of Tags."},"Tasks":{"Type":215,"Flags":1,"Description":"List of tasks for the flow."},"TriggerConfig":{"Type":192,"Flags":1,"Description":"Trigger settings of the flow."}}}},{"3":{"ItemType":121}},{"3":{"ItemType":185}},{"3":{"ItemType":187}},{"2":{"Name":"AWS.AppFlow/Flow","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":212,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.AppFlow/Flow@default","ScopeType":0,"Body":216}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "ConnectorProvisioningConfig", + "properties": { + "Lambda": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Contains information about the configuration of the lambda which is being registered as the connector." + } + } + }, + { + "$type": "ObjectType", + "name": "LambdaConnectorProvisioningConfig", + "properties": { + "LambdaArn": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "Lambda ARN of the connector being registered." + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.AppFlow/ConnectorProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.AppFlow/ConnectorProperties", + "properties": { + "ConnectorArn": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": " The arn of the connector. The arn is unique for each ConnectorRegistration in your AWS account." + }, + "ConnectorLabel": { + "type": { + "$ref": "#/2" + }, + "flags": 16, + "description": " The name of the connector. The name is unique for each ConnectorRegistration in your AWS account." + }, + "ConnectorProvisioningConfig": { + "type": { + "$ref": "#/0" + }, + "flags": 1, + "description": "Contains information about the configuration of the connector being registered." + }, + "ConnectorProvisioningType": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The provisioning type of the connector. Currently the only supported value is LAMBDA. " + }, + "Description": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "A description about the connector that's being registered." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.AppFlow/Connector", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.AppFlow/Connector@default", + "scopeType": 0, + "body": { + "$ref": "#/5" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AccessKeyId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AccessToken", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AccountName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AmplitudeConnectorProfileCredentials", + "properties": { + "ApiKey": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "A unique alphanumeric identi?er used to authenticate a user, developer, or calling program to your API." + }, + "SecretKey": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ApiKey", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ApiKeyCredentials", + "properties": { + "ApiKey": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "ApiSecretKey": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ApiSecretKey", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ApiToken", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ApplicationHostUrl", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ApplicationKey", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ApplicationServicePath", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AuthCode", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AuthenticationType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "BasicAuthCredentials", + "properties": { + "Password": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Username": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "BucketName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "BucketPrefix", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "BusinessUnitId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ClientCredentialsArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ClientId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ClientNumber", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ClientSecret", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ClusterIdentifier", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ConnectorOAuthRequest", + "properties": { + "AuthCode": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The code provided by the connector when it has been authenticated via the connected app." + }, + "RedirectUri": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The URL to which the authentication server redirects the browser after authorization has been\ngranted." + } + } + }, + { + "$type": "ObjectType", + "name": "ConnectorProfileConfig", + "properties": { + "ConnectorProfileCredentials": { + "type": { + "$ref": "#/31" + }, + "flags": 0 + }, + "ConnectorProfileProperties": { + "type": { + "$ref": "#/32" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ConnectorProfileCredentials", + "properties": { + "Amplitude": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "CustomConnector": { + "type": { + "$ref": "#/37" + }, + "flags": 0 + }, + "Datadog": { + "type": { + "$ref": "#/42" + }, + "flags": 0 + }, + "Dynatrace": { + "type": { + "$ref": "#/44" + }, + "flags": 0 + }, + "GoogleAnalytics": { + "type": { + "$ref": "#/46" + }, + "flags": 0 + }, + "InforNexus": { + "type": { + "$ref": "#/47" + }, + "flags": 0 + }, + "Marketo": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "Pardot": { + "type": { + "$ref": "#/59" + }, + "flags": 0 + }, + "Redshift": { + "type": { + "$ref": "#/65" + }, + "flags": 0 + }, + "SAPOData": { + "type": { + "$ref": "#/70" + }, + "flags": 0 + }, + "Salesforce": { + "type": { + "$ref": "#/72" + }, + "flags": 0 + }, + "ServiceNow": { + "type": { + "$ref": "#/75" + }, + "flags": 0 + }, + "Singular": { + "type": { + "$ref": "#/77" + }, + "flags": 0 + }, + "Slack": { + "type": { + "$ref": "#/78" + }, + "flags": 0 + }, + "Snowflake": { + "type": { + "$ref": "#/80" + }, + "flags": 0 + }, + "Trendmicro": { + "type": { + "$ref": "#/84" + }, + "flags": 0 + }, + "Veeva": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + }, + "Zendesk": { + "type": { + "$ref": "#/90" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ConnectorProfileProperties", + "properties": { + "CustomConnector": { + "type": { + "$ref": "#/38" + }, + "flags": 0 + }, + "Datadog": { + "type": { + "$ref": "#/43" + }, + "flags": 0 + }, + "Dynatrace": { + "type": { + "$ref": "#/45" + }, + "flags": 0 + }, + "InforNexus": { + "type": { + "$ref": "#/48" + }, + "flags": 0 + }, + "Marketo": { + "type": { + "$ref": "#/54" + }, + "flags": 0 + }, + "Pardot": { + "type": { + "$ref": "#/60" + }, + "flags": 0 + }, + "Redshift": { + "type": { + "$ref": "#/66" + }, + "flags": 0 + }, + "SAPOData": { + "type": { + "$ref": "#/71" + }, + "flags": 0 + }, + "Salesforce": { + "type": { + "$ref": "#/73" + }, + "flags": 0 + }, + "ServiceNow": { + "type": { + "$ref": "#/76" + }, + "flags": 0 + }, + "Slack": { + "type": { + "$ref": "#/79" + }, + "flags": 0 + }, + "Snowflake": { + "type": { + "$ref": "#/81" + }, + "flags": 0 + }, + "Veeva": { + "type": { + "$ref": "#/87" + }, + "flags": 0 + }, + "Zendesk": { + "type": { + "$ref": "#/91" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ConnectorType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CredentialsMap", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CustomAuthCredentials", + "properties": { + "CredentialsMap": { + "type": { + "$ref": "#/34" + }, + "flags": 0 + }, + "CustomAuthenticationType": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomAuthenticationType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CustomConnectorProfileCredentials", + "properties": { + "ApiKey": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + }, + "AuthenticationType": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Basic": { + "type": { + "$ref": "#/20" + }, + "flags": 0 + }, + "Custom": { + "type": { + "$ref": "#/35" + }, + "flags": 0 + }, + "Oauth2": { + "type": { + "$ref": "#/55" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomConnectorProfileProperties", + "properties": { + "OAuth2Properties": { + "type": { + "$ref": "#/57" + }, + "flags": 0 + }, + "ProfileProperties": { + "type": { + "$ref": "#/64" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DataApiRoleArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DatabaseName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DatabaseUrl", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DatadogConnectorProfileCredentials", + "properties": { + "ApiKey": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "A unique alphanumeric identi?er used to authenticate a user, developer, or calling program to your API." + }, + "ApplicationKey": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "Application keys, in conjunction with your API key, give you full access to Datadog?s programmatic API. Application keys are associated with the user account that created them. The application key is used to log all requests made to the API." + } + } + }, + { + "$type": "ObjectType", + "name": "DatadogConnectorProfileProperties", + "properties": { + "InstanceUrl": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The location of the Datadog resource" + } + } + }, + { + "$type": "ObjectType", + "name": "DynatraceConnectorProfileCredentials", + "properties": { + "ApiToken": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The API tokens used by Dynatrace API to authenticate various API calls." + } + } + }, + { + "$type": "ObjectType", + "name": "DynatraceConnectorProfileProperties", + "properties": { + "InstanceUrl": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The location of the Dynatrace resource" + } + } + }, + { + "$type": "ObjectType", + "name": "GoogleAnalyticsConnectorProfileCredentials", + "properties": { + "AccessToken": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The credentials used to access protected resources." + }, + "ClientId": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The identi?er for the desired client." + }, + "ClientSecret": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The client secret used by the oauth client to authenticate to the authorization server." + }, + "ConnectorOAuthRequest": { + "type": { + "$ref": "#/29" + }, + "flags": 0, + "description": "The oauth needed to request security tokens from the connector endpoint." + }, + "RefreshToken": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The credentials used to acquire new access tokens." + } + } + }, + { + "$type": "ObjectType", + "name": "InforNexusConnectorProfileCredentials", + "properties": { + "AccessKeyId": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The Access Key portion of the credentials." + }, + "Datakey": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The encryption keys used to encrypt data." + }, + "SecretAccessKey": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The secret key used to sign requests." + }, + "UserId": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The identi?er for the user." + } + } + }, + { + "$type": "ObjectType", + "name": "InforNexusConnectorProfileProperties", + "properties": { + "InstanceUrl": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The location of the InforNexus resource" + } + } + }, + { + "$type": "ObjectType", + "name": "InstanceUrl", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "JwtToken", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Key", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LogonLanguage", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MarketoConnectorProfileCredentials", + "properties": { + "AccessToken": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The credentials used to access protected resources." + }, + "ClientId": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The identi?er for the desired client." + }, + "ClientSecret": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The client secret used by the oauth client to authenticate to the authorization server." + }, + "ConnectorOAuthRequest": { + "type": { + "$ref": "#/29" + }, + "flags": 0, + "description": "The oauth needed to request security tokens from the connector endpoint." + } + } + }, + { + "$type": "ObjectType", + "name": "MarketoConnectorProfileProperties", + "properties": { + "InstanceUrl": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The location of the Marketo resource" + } + } + }, + { + "$type": "ObjectType", + "name": "OAuth2Credentials", + "properties": { + "AccessToken": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "ClientId": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "ClientSecret": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "OAuthRequest": { + "type": { + "$ref": "#/29" + }, + "flags": 0 + }, + "RefreshToken": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "OAuth2GrantType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "OAuth2Properties", + "properties": { + "OAuth2GrantType": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "TokenUrl": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "TokenUrlCustomProperties": { + "type": { + "$ref": "#/83" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "OAuthProperties", + "properties": { + "AuthCodeUrl": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "OAuthScopes": { + "type": { + "$ref": "#/92" + }, + "flags": 0 + }, + "TokenUrl": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PardotConnectorProfileCredentials", + "properties": { + "AccessToken": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The credentials used to access protected resources." + }, + "ClientCredentialsArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The client credentials to fetch access token and refresh token." + }, + "ConnectorOAuthRequest": { + "type": { + "$ref": "#/29" + }, + "flags": 0, + "description": "The oauth needed to request security tokens from the connector endpoint." + }, + "RefreshToken": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The credentials used to acquire new access tokens." + } + } + }, + { + "$type": "ObjectType", + "name": "PardotConnectorProfileProperties", + "properties": { + "BusinessUnitId": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The Business unit id of Salesforce Pardot instance to be connected" + }, + "InstanceUrl": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The location of the Salesforce Pardot resource" + }, + "IsSandboxEnvironment": { + "type": { + "$ref": "#/93" + }, + "flags": 0, + "description": "Indicates whether the connector profile applies to a demo or production environment" + } + } + }, + { + "$type": "ObjectType", + "name": "Password", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PortNumber", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PrivateLinkServiceName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ProfileProperties", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RedshiftConnectorProfileCredentials", + "properties": { + "Password": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The password that corresponds to the username." + }, + "Username": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The name of the user." + } + } + }, + { + "$type": "ObjectType", + "name": "RedshiftConnectorProfileProperties", + "properties": { + "BucketName": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The name of the Amazon S3 bucket associated with Redshift." + }, + "BucketPrefix": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The object key for the destination bucket in which Amazon AppFlow will place the ?les." + }, + "ClusterIdentifier": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The unique identifier of the Amazon Redshift cluster." + }, + "DataApiRoleArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the IAM role that grants Amazon AppFlow access to the data through the Amazon Redshift Data API." + }, + "DatabaseName": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The name of the Amazon Redshift database that will store the transferred data." + }, + "DatabaseUrl": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The JDBC URL of the Amazon Redshift cluster." + }, + "IsRedshiftServerless": { + "type": { + "$ref": "#/93" + }, + "flags": 0, + "description": "If Amazon AppFlow will connect to Amazon Redshift Serverless or Amazon Redshift cluster." + }, + "RoleArn": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of the IAM role." + }, + "WorkgroupName": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The name of the Amazon Redshift serverless workgroup" + } + } + }, + { + "$type": "ObjectType", + "name": "RefreshToken", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Region", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RoleArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SAPODataConnectorProfileCredentials", + "properties": { + "BasicAuthCredentials": { + "type": { + "$ref": "#/20" + }, + "flags": 0 + }, + "OAuthCredentials": { + "type": { + "$ref": "#/95" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SAPODataConnectorProfileProperties", + "properties": { + "ApplicationHostUrl": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "ApplicationServicePath": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "ClientNumber": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "DisableSSO": { + "type": { + "$ref": "#/93" + }, + "flags": 0, + "description": "If you set this parameter to true, Amazon AppFlow bypasses the single sign-on (SSO) settings in your SAP account when it accesses your SAP OData instance." + }, + "LogonLanguage": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "OAuthProperties": { + "type": { + "$ref": "#/58" + }, + "flags": 0 + }, + "PortNumber": { + "type": { + "$ref": "#/94" + }, + "flags": 0 + }, + "PrivateLinkServiceName": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SalesforceConnectorProfileCredentials", + "properties": { + "AccessToken": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The credentials used to access protected resources." + }, + "ClientCredentialsArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The client credentials to fetch access token and refresh token." + }, + "ConnectorOAuthRequest": { + "type": { + "$ref": "#/29" + }, + "flags": 0, + "description": "The oauth needed to request security tokens from the connector endpoint." + }, + "JwtToken": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The credentials used to access your Salesforce records" + }, + "OAuth2GrantType": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The grant types to fetch an access token" + }, + "RefreshToken": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The credentials used to acquire new access tokens." + } + } + }, + { + "$type": "ObjectType", + "name": "SalesforceConnectorProfileProperties", + "properties": { + "InstanceUrl": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The location of the Salesforce resource" + }, + "isSandboxEnvironment": { + "type": { + "$ref": "#/93" + }, + "flags": 0, + "description": "Indicates whether the connector profile applies to a sandbox or production environment" + }, + "usePrivateLinkForMetadataAndAuthorization": { + "type": { + "$ref": "#/93" + }, + "flags": 0, + "description": "Indicates whether to make Metadata And Authorization calls over Pivate Network" + } + } + }, + { + "$type": "ObjectType", + "name": "SecretKey", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ServiceNowConnectorProfileCredentials", + "properties": { + "OAuth2Credentials": { + "type": { + "$ref": "#/55" + }, + "flags": 0, + "description": "The OAuth 2.0 credentials required to authenticate the user." + }, + "Password": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The password that corresponds to the username." + }, + "Username": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The name of the user." + } + } + }, + { + "$type": "ObjectType", + "name": "ServiceNowConnectorProfileProperties", + "properties": { + "InstanceUrl": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The location of the ServiceNow resource" + } + } + }, + { + "$type": "ObjectType", + "name": "SingularConnectorProfileCredentials", + "properties": { + "ApiKey": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "A unique alphanumeric identi?er used to authenticate a user, developer, or calling program to your API." + } + } + }, + { + "$type": "ObjectType", + "name": "SlackConnectorProfileCredentials", + "properties": { + "AccessToken": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The credentials used to access protected resources." + }, + "ClientId": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The identi?er for the desired client." + }, + "ClientSecret": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The client secret used by the oauth client to authenticate to the authorization server." + }, + "ConnectorOAuthRequest": { + "type": { + "$ref": "#/29" + }, + "flags": 0, + "description": "The oauth needed to request security tokens from the connector endpoint." + } + } + }, + { + "$type": "ObjectType", + "name": "SlackConnectorProfileProperties", + "properties": { + "InstanceUrl": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The location of the Slack resource" + } + } + }, + { + "$type": "ObjectType", + "name": "SnowflakeConnectorProfileCredentials", + "properties": { + "Password": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The password that corresponds to the username." + }, + "Username": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The name of the user." + } + } + }, + { + "$type": "ObjectType", + "name": "SnowflakeConnectorProfileProperties", + "properties": { + "AccountName": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The name of the account." + }, + "BucketName": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The name of the Amazon S3 bucket associated with Snow?ake." + }, + "BucketPrefix": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The bucket prefix that refers to the Amazon S3 bucket associated with Snow?ake." + }, + "PrivateLinkServiceName": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The Snow?ake Private Link service name to be used for private data transfers." + }, + "Region": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The region of the Snow?ake account." + }, + "Stage": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The name of the Amazon S3 stage that was created while setting up an Amazon S3 stage in the\nSnow?ake account. This is written in the following format: < Database>< Schema>." + }, + "Warehouse": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The name of the Snow?ake warehouse." + } + } + }, + { + "$type": "ObjectType", + "name": "Stage", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TokenUrlCustomProperties", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TrendmicroConnectorProfileCredentials", + "properties": { + "ApiSecretKey": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The Secret Access Key portion of the credentials." + } + } + }, + { + "$type": "ObjectType", + "name": "Username", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "VeevaConnectorProfileCredentials", + "properties": { + "Password": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The password that corresponds to the username." + }, + "Username": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The name of the user." + } + } + }, + { + "$type": "ObjectType", + "name": "VeevaConnectorProfileProperties", + "properties": { + "InstanceUrl": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The location of the Veeva resource" + } + } + }, + { + "$type": "ObjectType", + "name": "Warehouse", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "WorkgroupName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ZendeskConnectorProfileCredentials", + "properties": { + "AccessToken": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The credentials used to access protected resources." + }, + "ClientId": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The identi?er for the desired client." + }, + "ClientSecret": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The client secret used by the oauth client to authenticate to the authorization server." + }, + "ConnectorOAuthRequest": { + "type": { + "$ref": "#/29" + }, + "flags": 0, + "description": "The oauth needed to request security tokens from the connector endpoint." + } + } + }, + { + "$type": "ObjectType", + "name": "ZendeskConnectorProfileProperties", + "properties": { + "InstanceUrl": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The location of the Zendesk resource" + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "IntegerType" + }, + { + "$type": "ObjectType", + "name": "ConnectorProfile_OAuthCredentials", + "properties": { + "AccessToken": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "ClientId": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "ClientSecret": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "ConnectorOAuthRequest": { + "type": { + "$ref": "#/29" + }, + "flags": 0 + }, + "RefreshToken": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.AppFlow/ConnectorProfileProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.AppFlow/ConnectorProfileProperties", + "properties": { + "ConnectionMode": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "Mode in which data transfer should be enabled. Private connection mode is currently enabled for Salesforce, Snowflake, Trendmicro and Singular" + }, + "ConnectorLabel": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The label of the connector. The label is unique for each ConnectorRegistration in your AWS account. Only needed if calling for CUSTOMCONNECTOR connector type/." + }, + "ConnectorProfileArn": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "Unique identifier for connector profile resources" + }, + "ConnectorProfileConfig": { + "type": { + "$ref": "#/30" + }, + "flags": 4, + "description": "Connector specific configurations needed to create connector profile" + }, + "ConnectorProfileName": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "The maximum number of items to retrieve in a single batch." + }, + "ConnectorType": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "List of Saas providers that need connector profile to be created" + }, + "CredentialsArn": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "A unique Arn for Connector-Profile resource" + }, + "KMSArn": { + "type": { + "$ref": "#/2" + }, + "flags": 4, + "description": "The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment variables. If it's not provided, AWS Lambda uses a default service key." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.AppFlow/ConnectorProfile", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/97" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.AppFlow/ConnectorProfile@default", + "scopeType": 0, + "body": { + "$ref": "#/98" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AggregationConfig", + "properties": { + "AggregationType": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "TargetFileSize": { + "type": { + "$ref": "#/94" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AggregationType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AmplitudeConnectorOperator", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AmplitudeSourceProperties", + "properties": { + "Object": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ApiVersion", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "BucketName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "BucketPrefix", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ConnectorOperator", + "properties": { + "Amplitude": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "CustomConnector": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Datadog": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Dynatrace": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "GoogleAnalytics": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "InforNexus": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Marketo": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Pardot": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "S3": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "SAPOData": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Salesforce": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "ServiceNow": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Singular": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Slack": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Trendmicro": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Veeva": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Zendesk": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ConnectorProfileName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ConnectorType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CustomConnectorDestinationProperties", + "properties": { + "CustomProperties": { + "type": { + "$ref": "#/112" + }, + "flags": 0 + }, + "EntityName": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "ErrorHandlingConfig": { + "type": { + "$ref": "#/124" + }, + "flags": 0 + }, + "IdFieldNames": { + "type": { + "$ref": "#/200" + }, + "flags": 0, + "description": "List of fields used as ID when performing a write operation." + }, + "WriteOperationType": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomConnectorSourceProperties", + "properties": { + "CustomProperties": { + "type": { + "$ref": "#/112" + }, + "flags": 0 + }, + "DataTransferApi": { + "type": { + "$ref": "#/201" + }, + "flags": 0 + }, + "EntityName": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomProperties", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DataTransferApi", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DatadogConnectorOperator", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DatadogSourceProperties", + "properties": { + "Object": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DatetimeTypeFieldName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DestinationConnectorProperties", + "properties": { + "CustomConnector": { + "type": { + "$ref": "#/110" + }, + "flags": 0 + }, + "EventBridge": { + "type": { + "$ref": "#/125" + }, + "flags": 0 + }, + "LookoutMetrics": { + "type": { + "$ref": "#/137" + }, + "flags": 0 + }, + "Marketo": { + "type": { + "$ref": "#/139" + }, + "flags": 0 + }, + "Redshift": { + "type": { + "$ref": "#/154" + }, + "flags": 0 + }, + "S3": { + "type": { + "$ref": "#/156" + }, + "flags": 0 + }, + "SAPOData": { + "type": { + "$ref": "#/161" + }, + "flags": 0 + }, + "Salesforce": { + "type": { + "$ref": "#/168" + }, + "flags": 0 + }, + "Snowflake": { + "type": { + "$ref": "#/177" + }, + "flags": 0 + }, + "Upsolver": { + "type": { + "$ref": "#/192" + }, + "flags": 0 + }, + "Zendesk": { + "type": { + "$ref": "#/198" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DestinationFlowConfig", + "properties": { + "ApiVersion": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The API version that the destination connector uses." + }, + "ConnectorProfileName": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "Name of destination connector profile" + }, + "ConnectorType": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "Destination connector type" + }, + "DestinationConnectorProperties": { + "type": { + "$ref": "#/117" + }, + "flags": 1, + "description": "Destination connector details" + } + } + }, + { + "$type": "ObjectType", + "name": "DocumentType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DynatraceConnectorOperator", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DynatraceSourceProperties", + "properties": { + "Object": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "EnableDynamicFieldUpdate", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "EntityName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ErrorHandlingConfig", + "properties": { + "BucketName": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "BucketPrefix": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "FailOnFirstError": { + "type": { + "$ref": "#/93" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "EventBridgeDestinationProperties", + "properties": { + "ErrorHandlingConfig": { + "type": { + "$ref": "#/124" + }, + "flags": 0 + }, + "Object": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "FileType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "GlueDataCatalog", + "properties": { + "DatabaseName": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "A string containing the value for the tag" + }, + "RoleArn": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "A string containing the value for the tag" + }, + "TablePrefix": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "A string containing the value for the tag" + } + } + }, + { + "$type": "ObjectType", + "name": "GoogleAnalyticsConnectorOperator", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "GoogleAnalyticsSourceProperties", + "properties": { + "Object": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "IncludeAllVersions", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "IncludeDeletedRecords", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "IncludeRenditions", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "IncludeSourceFiles", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "IncrementalPullConfig", + "properties": { + "DatetimeTypeFieldName": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "InforNexusConnectorOperator", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "InforNexusSourceProperties", + "properties": { + "Object": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "LookoutMetricsDestinationProperties", + "properties": { + "Object": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "MarketoConnectorOperator", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MarketoDestinationProperties", + "properties": { + "ErrorHandlingConfig": { + "type": { + "$ref": "#/124" + }, + "flags": 0 + }, + "Object": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "MarketoSourceProperties", + "properties": { + "Object": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "MetadataCatalogConfig", + "properties": { + "GlueDataCatalog": { + "type": { + "$ref": "#/127" + }, + "flags": 0, + "description": "Configurations of glue data catalog of the flow." + } + } + }, + { + "$type": "ObjectType", + "name": "Name", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Object", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Operator", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "OperatorPropertiesKeys", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PardotConnectorOperator", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PardotSourceProperties", + "properties": { + "Object": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "PathPrefix", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PathPrefixHierarchy", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PrefixConfig", + "properties": { + "PathPrefixHierarchy": { + "type": { + "$ref": "#/203" + }, + "flags": 0 + }, + "PrefixFormat": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "PrefixType": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PrefixFormat", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PrefixType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PreserveSourceDataTyping", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RedshiftDestinationProperties", + "properties": { + "BucketPrefix": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "ErrorHandlingConfig": { + "type": { + "$ref": "#/124" + }, + "flags": 0 + }, + "IntermediateBucketName": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Object": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "S3ConnectorOperator", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "S3DestinationProperties", + "properties": { + "BucketName": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "BucketPrefix": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "S3OutputFormatConfig": { + "type": { + "$ref": "#/158" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "S3InputFormatConfig", + "properties": { + "S3InputFileType": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "S3OutputFormatConfig", + "properties": { + "AggregationConfig": { + "type": { + "$ref": "#/100" + }, + "flags": 0 + }, + "FileType": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "PrefixConfig": { + "type": { + "$ref": "#/150" + }, + "flags": 0 + }, + "PreserveSourceDataTyping": { + "type": { + "$ref": "#/93" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "S3SourceProperties", + "properties": { + "BucketName": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "BucketPrefix": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "S3InputFormatConfig": { + "type": { + "$ref": "#/157" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SAPODataConnectorOperator", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SAPODataDestinationProperties", + "properties": { + "ErrorHandlingConfig": { + "type": { + "$ref": "#/124" + }, + "flags": 0 + }, + "IdFieldNames": { + "type": { + "$ref": "#/204" + }, + "flags": 0, + "description": "List of fields used as ID when performing a write operation." + }, + "ObjectPath": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "SuccessResponseHandlingConfig": { + "type": { + "$ref": "#/181" + }, + "flags": 0 + }, + "WriteOperationType": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SAPODataMaxPageSize", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SAPODataMaxParallelism", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SAPODataPaginationConfig", + "properties": { + "maxPageSize": { + "type": { + "$ref": "#/94" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "SAPODataParallelismConfig", + "properties": { + "maxParallelism": { + "type": { + "$ref": "#/94" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "SAPODataSourceProperties", + "properties": { + "ObjectPath": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "paginationConfig": { + "type": { + "$ref": "#/164" + }, + "flags": 0 + }, + "parallelismConfig": { + "type": { + "$ref": "#/165" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SalesforceConnectorOperator", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SalesforceDestinationProperties", + "properties": { + "DataTransferApi": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "ErrorHandlingConfig": { + "type": { + "$ref": "#/124" + }, + "flags": 0 + }, + "IdFieldNames": { + "type": { + "$ref": "#/205" + }, + "flags": 0, + "description": "List of fields used as ID when performing a write operation." + }, + "Object": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "WriteOperationType": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SalesforceSourceProperties", + "properties": { + "DataTransferApi": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "EnableDynamicFieldUpdate": { + "type": { + "$ref": "#/93" + }, + "flags": 0 + }, + "IncludeDeletedRecords": { + "type": { + "$ref": "#/93" + }, + "flags": 0 + }, + "Object": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ScheduledTriggerProperties", + "properties": { + "DataPullMode": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "FirstExecutionFrom": { + "type": { + "$ref": "#/94" + }, + "flags": 0 + }, + "FlowErrorDeactivationThreshold": { + "type": { + "$ref": "#/94" + }, + "flags": 0 + }, + "ScheduleEndTime": { + "type": { + "$ref": "#/94" + }, + "flags": 0 + }, + "ScheduleExpression": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "ScheduleOffset": { + "type": { + "$ref": "#/94" + }, + "flags": 0 + }, + "ScheduleStartTime": { + "type": { + "$ref": "#/94" + }, + "flags": 0 + }, + "TimeZone": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ServiceNowConnectorOperator", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ServiceNowSourceProperties", + "properties": { + "Object": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "SingularConnectorOperator", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SingularSourceProperties", + "properties": { + "Object": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "SlackConnectorOperator", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SlackSourceProperties", + "properties": { + "Object": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "SnowflakeDestinationProperties", + "properties": { + "BucketPrefix": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "ErrorHandlingConfig": { + "type": { + "$ref": "#/124" + }, + "flags": 0 + }, + "IntermediateBucketName": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Object": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "SourceConnectorProperties", + "properties": { + "Amplitude": { + "type": { + "$ref": "#/103" + }, + "flags": 0 + }, + "CustomConnector": { + "type": { + "$ref": "#/111" + }, + "flags": 0 + }, + "Datadog": { + "type": { + "$ref": "#/115" + }, + "flags": 0 + }, + "Dynatrace": { + "type": { + "$ref": "#/121" + }, + "flags": 0 + }, + "GoogleAnalytics": { + "type": { + "$ref": "#/129" + }, + "flags": 0 + }, + "InforNexus": { + "type": { + "$ref": "#/136" + }, + "flags": 0 + }, + "Marketo": { + "type": { + "$ref": "#/140" + }, + "flags": 0 + }, + "Pardot": { + "type": { + "$ref": "#/147" + }, + "flags": 0 + }, + "S3": { + "type": { + "$ref": "#/159" + }, + "flags": 0 + }, + "SAPOData": { + "type": { + "$ref": "#/166" + }, + "flags": 0 + }, + "Salesforce": { + "type": { + "$ref": "#/169" + }, + "flags": 0 + }, + "ServiceNow": { + "type": { + "$ref": "#/172" + }, + "flags": 0 + }, + "Singular": { + "type": { + "$ref": "#/174" + }, + "flags": 0 + }, + "Slack": { + "type": { + "$ref": "#/176" + }, + "flags": 0 + }, + "Trendmicro": { + "type": { + "$ref": "#/188" + }, + "flags": 0 + }, + "Veeva": { + "type": { + "$ref": "#/195" + }, + "flags": 0 + }, + "Zendesk": { + "type": { + "$ref": "#/199" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SourceFlowConfig", + "properties": { + "ApiVersion": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The API version that the destination connector uses." + }, + "ConnectorProfileName": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "Name of source connector profile" + }, + "ConnectorType": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "Type of source connector" + }, + "IncrementalPullConfig": { + "type": { + "$ref": "#/134" + }, + "flags": 0, + "description": "Configuration for scheduled incremental data pull" + }, + "SourceConnectorProperties": { + "type": { + "$ref": "#/178" + }, + "flags": 1, + "description": "Source connector details required to query a connector" + } + } + }, + { + "$type": "ObjectType", + "name": "Status", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SuccessResponseHandlingConfig", + "properties": { + "BucketName": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "BucketPrefix": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "A string used to identify this tag" + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "A string containing the value for the tag" + } + } + }, + { + "$type": "ObjectType", + "name": "TargetFileSize", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Task", + "properties": { + "ConnectorOperator": { + "type": { + "$ref": "#/107" + }, + "flags": 0, + "description": "Operation to be performed on provided source fields" + }, + "DestinationField": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "A field value on which source field should be validated" + }, + "SourceFields": { + "type": { + "$ref": "#/206" + }, + "flags": 1, + "description": "Source fields on which particular task will be applied" + }, + "TaskProperties": { + "type": { + "$ref": "#/207" + }, + "flags": 0, + "description": "A Map used to store task related info" + }, + "TaskType": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "Type of task" + } + } + }, + { + "$type": "ObjectType", + "name": "TaskPropertiesObject", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TaskType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TrendmicroConnectorOperator", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TrendmicroSourceProperties", + "properties": { + "Object": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TriggerConfig", + "properties": { + "TriggerProperties": { + "type": { + "$ref": "#/170" + }, + "flags": 0, + "description": "Details required based on the type of trigger" + }, + "TriggerType": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "Trigger type of the flow" + } + } + }, + { + "$type": "ObjectType", + "name": "TriggerType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "UpsolverBucketName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "UpsolverDestinationProperties", + "properties": { + "BucketName": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "BucketPrefix": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "S3OutputFormatConfig": { + "type": { + "$ref": "#/193" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "UpsolverS3OutputFormatConfig", + "properties": { + "AggregationConfig": { + "type": { + "$ref": "#/100" + }, + "flags": 0 + }, + "FileType": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "PrefixConfig": { + "type": { + "$ref": "#/150" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "VeevaConnectorOperator", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "VeevaSourceProperties", + "properties": { + "DocumentType": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "IncludeAllVersions": { + "type": { + "$ref": "#/93" + }, + "flags": 0 + }, + "IncludeRenditions": { + "type": { + "$ref": "#/93" + }, + "flags": 0 + }, + "IncludeSourceFiles": { + "type": { + "$ref": "#/93" + }, + "flags": 0 + }, + "Object": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "WriteOperationType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ZendeskConnectorOperator", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ZendeskDestinationProperties", + "properties": { + "ErrorHandlingConfig": { + "type": { + "$ref": "#/124" + }, + "flags": 0 + }, + "IdFieldNames": { + "type": { + "$ref": "#/208" + }, + "flags": 0, + "description": "List of fields used as ID when performing a write operation." + }, + "Object": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "WriteOperationType": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ZendeskSourceProperties", + "properties": { + "Object": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ObjectType", + "name": "Flow_DataTransferApi", + "properties": { + "Name": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Type": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/185" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.AppFlow/FlowProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/118" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/182" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/184" + } + }, + { + "$type": "ObjectType", + "name": "AWS.AppFlow/FlowProperties", + "properties": { + "Description": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "Description of the flow." + }, + "DestinationFlowConfigList": { + "type": { + "$ref": "#/210" + }, + "flags": 1, + "description": "List of Destination connectors of the flow." + }, + "FlowArn": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "ARN identifier of the flow." + }, + "FlowName": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "Name of the flow." + }, + "FlowStatus": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "Flow activation status for Scheduled- and Event-triggered flows" + }, + "KMSArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment variables. If it's not provided, AWS Lambda uses a default service key." + }, + "MetadataCatalogConfig": { + "type": { + "$ref": "#/141" + }, + "flags": 0, + "description": "Configurations of metadata catalog of the flow." + }, + "SourceFlowConfig": { + "type": { + "$ref": "#/179" + }, + "flags": 1, + "description": "Configurations of Source connector of the flow." + }, + "Tags": { + "type": { + "$ref": "#/211" + }, + "flags": 0, + "description": "List of Tags." + }, + "Tasks": { + "type": { + "$ref": "#/212" + }, + "flags": 1, + "description": "List of tasks for the flow." + }, + "TriggerConfig": { + "type": { + "$ref": "#/189" + }, + "flags": 1, + "description": "Trigger settings of the flow." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.AppFlow/Flow", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/213" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.AppFlow/Flow@default", + "scopeType": 0, + "body": { + "$ref": "#/214" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.appflow/default/types.md b/artifacts/bicep/aws/aws.appflow/default/types.md index a5d58a45..edf767a8 100644 --- a/artifacts/bicep/aws/aws.appflow/default/types.md +++ b/artifacts/bicep/aws/aws.appflow/default/types.md @@ -3,39 +3,42 @@ ## Resource AWS.AppFlow/Connector@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.AppFlow/ConnectorProperties](#awsappflowconnectorproperties) (Required): properties of the resource +* **properties**: [AWS.AppFlow/ConnectorProperties](#awsappflowconnectorproperties) (Required, Identifier): properties of the resource ## Resource AWS.AppFlow/ConnectorProfile@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.AppFlow/ConnectorProfileProperties](#awsappflowconnectorprofileproperties) (Required): properties of the resource +* **properties**: [AWS.AppFlow/ConnectorProfileProperties](#awsappflowconnectorprofileproperties) (Required, Identifier): properties of the resource ## Resource AWS.AppFlow/Flow@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.AppFlow/FlowProperties](#awsappflowflowproperties) (Required): properties of the resource +* **properties**: [AWS.AppFlow/FlowProperties](#awsappflowflowproperties) (Required, Identifier): properties of the resource -## AWS.AppFlow/ConnectorProperties +## AggregationConfig ### Properties -* **ConnectorArn**: string (ReadOnly): The arn of the connector. The arn is unique for each ConnectorRegistration in your AWS account. -* **ConnectorLabel**: string (Identifier): The name of the connector. The name is unique for each ConnectorRegistration in your AWS account. -* **ConnectorProvisioningConfig**: [ConnectorProvisioningConfig](#connectorprovisioningconfig) (Required): Contains information about the configuration of the connector being registered. -* **ConnectorProvisioningType**: string (Required): The provisioning type of the connector. Currently the only supported value is LAMBDA. -* **Description**: string: A description about the connector that's being registered. +* **AggregationType**: string +* **TargetFileSize**: int -## ConnectorProvisioningConfig +## AmplitudeConnectorProfileCredentials ### Properties -* **Lambda**: [LambdaConnectorProvisioningConfig](#lambdaconnectorprovisioningconfig): Contains information about the configuration of the lambda which is being registered as the connector. +* **ApiKey**: string (Required): A unique alphanumeric identi?er used to authenticate a user, developer, or calling program to your API. +* **SecretKey**: string (Required) -## LambdaConnectorProvisioningConfig +## AmplitudeSourceProperties ### Properties -* **LambdaArn**: string (Required): Lambda ARN of the connector being registered. +* **Object**: string (Required) + +## ApiKeyCredentials +### Properties +* **ApiKey**: string (Required) +* **ApiSecretKey**: string ## AWS.AppFlow/ConnectorProfileProperties ### Properties @@ -48,6 +51,67 @@ * **CredentialsArn**: string (ReadOnly): A unique Arn for Connector-Profile resource * **KMSArn**: string (WriteOnly): The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment variables. If it's not provided, AWS Lambda uses a default service key. +## AWS.AppFlow/ConnectorProperties +### Properties +* **ConnectorArn**: string (ReadOnly): The arn of the connector. The arn is unique for each ConnectorRegistration in your AWS account. +* **ConnectorLabel**: string (Identifier): The name of the connector. The name is unique for each ConnectorRegistration in your AWS account. +* **ConnectorProvisioningConfig**: [ConnectorProvisioningConfig](#connectorprovisioningconfig) (Required): Contains information about the configuration of the connector being registered. +* **ConnectorProvisioningType**: string (Required): The provisioning type of the connector. Currently the only supported value is LAMBDA. +* **Description**: string: A description about the connector that's being registered. + +## AWS.AppFlow/FlowProperties +### Properties +* **Description**: string: Description of the flow. +* **DestinationFlowConfigList**: [DestinationFlowConfig](#destinationflowconfig)[] (Required): List of Destination connectors of the flow. +* **FlowArn**: string (ReadOnly): ARN identifier of the flow. +* **FlowName**: string (Required, Identifier): Name of the flow. +* **FlowStatus**: string: Flow activation status for Scheduled- and Event-triggered flows +* **KMSArn**: string: The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment variables. If it's not provided, AWS Lambda uses a default service key. +* **MetadataCatalogConfig**: [MetadataCatalogConfig](#metadatacatalogconfig): Configurations of metadata catalog of the flow. +* **SourceFlowConfig**: [SourceFlowConfig](#sourceflowconfig) (Required): Configurations of Source connector of the flow. +* **Tags**: [Tag](#tag)[]: List of Tags. +* **Tasks**: [Task](#task)[] (Required): List of tasks for the flow. +* **TriggerConfig**: [TriggerConfig](#triggerconfig) (Required): Trigger settings of the flow. + +## BasicAuthCredentials +### Properties +* **Password**: string (Required) +* **Username**: string (Required) + +## ConnectorOAuthRequest +### Properties +* **AuthCode**: string: The code provided by the connector when it has been authenticated via the connected app. +* **RedirectUri**: string: The URL to which the authentication server redirects the browser after authorization has been +granted. + +## ConnectorOperator +### Properties +* **Amplitude**: string +* **CustomConnector**: string +* **Datadog**: string +* **Dynatrace**: string +* **GoogleAnalytics**: string +* **InforNexus**: string +* **Marketo**: string +* **Pardot**: string +* **S3**: string +* **Salesforce**: string +* **SAPOData**: string +* **ServiceNow**: string +* **Singular**: string +* **Slack**: string +* **Trendmicro**: string +* **Veeva**: string +* **Zendesk**: string + +## ConnectorProfile_OAuthCredentials +### Properties +* **AccessToken**: string +* **ClientId**: string +* **ClientSecret**: string +* **ConnectorOAuthRequest**: [ConnectorOAuthRequest](#connectoroauthrequest) +* **RefreshToken**: string + ## ConnectorProfileConfig ### Properties * **ConnectorProfileCredentials**: [ConnectorProfileCredentials](#connectorprofilecredentials) @@ -74,10 +138,42 @@ * **Veeva**: [VeevaConnectorProfileCredentials](#veevaconnectorprofilecredentials) * **Zendesk**: [ZendeskConnectorProfileCredentials](#zendeskconnectorprofilecredentials) -## AmplitudeConnectorProfileCredentials +## ConnectorProfileProperties ### Properties -* **ApiKey**: string (Required): A unique alphanumeric identi?er used to authenticate a user, developer, or calling program to your API. -* **SecretKey**: string (Required) +* **CustomConnector**: [CustomConnectorProfileProperties](#customconnectorprofileproperties) +* **Datadog**: [DatadogConnectorProfileProperties](#datadogconnectorprofileproperties) +* **Dynatrace**: [DynatraceConnectorProfileProperties](#dynatraceconnectorprofileproperties) +* **InforNexus**: [InforNexusConnectorProfileProperties](#infornexusconnectorprofileproperties) +* **Marketo**: [MarketoConnectorProfileProperties](#marketoconnectorprofileproperties) +* **Pardot**: [PardotConnectorProfileProperties](#pardotconnectorprofileproperties) +* **Redshift**: [RedshiftConnectorProfileProperties](#redshiftconnectorprofileproperties) +* **Salesforce**: [SalesforceConnectorProfileProperties](#salesforceconnectorprofileproperties) +* **SAPOData**: [SAPODataConnectorProfileProperties](#sapodataconnectorprofileproperties) +* **ServiceNow**: [ServiceNowConnectorProfileProperties](#servicenowconnectorprofileproperties) +* **Slack**: [SlackConnectorProfileProperties](#slackconnectorprofileproperties) +* **Snowflake**: [SnowflakeConnectorProfileProperties](#snowflakeconnectorprofileproperties) +* **Veeva**: [VeevaConnectorProfileProperties](#veevaconnectorprofileproperties) +* **Zendesk**: [ZendeskConnectorProfileProperties](#zendeskconnectorprofileproperties) + +## ConnectorProvisioningConfig +### Properties +* **Lambda**: [LambdaConnectorProvisioningConfig](#lambdaconnectorprovisioningconfig): Contains information about the configuration of the lambda which is being registered as the connector. + +## CredentialsMap +### Properties + +## CustomAuthCredentials +### Properties +* **CredentialsMap**: [CredentialsMap](#credentialsmap) +* **CustomAuthenticationType**: string (Required) + +## CustomConnectorDestinationProperties +### Properties +* **CustomProperties**: [CustomProperties](#customproperties) +* **EntityName**: string (Required) +* **ErrorHandlingConfig**: [ErrorHandlingConfig](#errorhandlingconfig) +* **IdFieldNames**: string[]: List of fields used as ID when performing a write operation. +* **WriteOperationType**: string ## CustomConnectorProfileCredentials ### Properties @@ -87,47 +183,88 @@ * **Custom**: [CustomAuthCredentials](#customauthcredentials) * **Oauth2**: [OAuth2Credentials](#oauth2credentials) -## ApiKeyCredentials +## CustomConnectorProfileProperties ### Properties -* **ApiKey**: string (Required) -* **ApiSecretKey**: string +* **OAuth2Properties**: [OAuth2Properties](#oauth2properties) +* **ProfileProperties**: [ProfileProperties](#profileproperties) -## BasicAuthCredentials +## CustomConnectorSourceProperties ### Properties -* **Password**: string (Required) -* **Username**: string (Required) +* **CustomProperties**: [CustomProperties](#customproperties) +* **DataTransferApi**: [Flow_DataTransferApi](#flowdatatransferapi) +* **EntityName**: string (Required) -## CustomAuthCredentials +## CustomProperties ### Properties -* **CredentialsMap**: [CredentialsMap](#credentialsmap) -* **CustomAuthenticationType**: string (Required) -## CredentialsMap +## DatadogConnectorProfileCredentials ### Properties +* **ApiKey**: string (Required): A unique alphanumeric identi?er used to authenticate a user, developer, or calling program to your API. +* **ApplicationKey**: string (Required): Application keys, in conjunction with your API key, give you full access to Datadog?s programmatic API. Application keys are associated with the user account that created them. The application key is used to log all requests made to the API. -## OAuth2Credentials +## DatadogConnectorProfileProperties ### Properties -* **AccessToken**: string -* **ClientId**: string -* **ClientSecret**: string -* **OAuthRequest**: [ConnectorOAuthRequest](#connectoroauthrequest) -* **RefreshToken**: string +* **InstanceUrl**: string (Required): The location of the Datadog resource -## ConnectorOAuthRequest +## DatadogSourceProperties ### Properties -* **AuthCode**: string: The code provided by the connector when it has been authenticated via the connected app. -* **RedirectUri**: string: The URL to which the authentication server redirects the browser after authorization has been -granted. +* **Object**: string (Required) -## DatadogConnectorProfileCredentials +## DestinationConnectorProperties ### Properties -* **ApiKey**: string (Required): A unique alphanumeric identi?er used to authenticate a user, developer, or calling program to your API. -* **ApplicationKey**: string (Required): Application keys, in conjunction with your API key, give you full access to Datadog?s programmatic API. Application keys are associated with the user account that created them. The application key is used to log all requests made to the API. +* **CustomConnector**: [CustomConnectorDestinationProperties](#customconnectordestinationproperties) +* **EventBridge**: [EventBridgeDestinationProperties](#eventbridgedestinationproperties) +* **LookoutMetrics**: [LookoutMetricsDestinationProperties](#lookoutmetricsdestinationproperties) +* **Marketo**: [MarketoDestinationProperties](#marketodestinationproperties) +* **Redshift**: [RedshiftDestinationProperties](#redshiftdestinationproperties) +* **S3**: [S3DestinationProperties](#s3destinationproperties) +* **Salesforce**: [SalesforceDestinationProperties](#salesforcedestinationproperties) +* **SAPOData**: [SAPODataDestinationProperties](#sapodatadestinationproperties) +* **Snowflake**: [SnowflakeDestinationProperties](#snowflakedestinationproperties) +* **Upsolver**: [UpsolverDestinationProperties](#upsolverdestinationproperties) +* **Zendesk**: [ZendeskDestinationProperties](#zendeskdestinationproperties) + +## DestinationFlowConfig +### Properties +* **ApiVersion**: string: The API version that the destination connector uses. +* **ConnectorProfileName**: string: Name of destination connector profile +* **ConnectorType**: string (Required): Destination connector type +* **DestinationConnectorProperties**: [DestinationConnectorProperties](#destinationconnectorproperties) (Required): Destination connector details ## DynatraceConnectorProfileCredentials ### Properties * **ApiToken**: string (Required): The API tokens used by Dynatrace API to authenticate various API calls. +## DynatraceConnectorProfileProperties +### Properties +* **InstanceUrl**: string (Required): The location of the Dynatrace resource + +## DynatraceSourceProperties +### Properties +* **Object**: string (Required) + +## ErrorHandlingConfig +### Properties +* **BucketName**: string +* **BucketPrefix**: string +* **FailOnFirstError**: bool + +## EventBridgeDestinationProperties +### Properties +* **ErrorHandlingConfig**: [ErrorHandlingConfig](#errorhandlingconfig) +* **Object**: string (Required) + +## Flow_DataTransferApi +### Properties +* **Name**: string (Required) +* **Type**: string (Required) + +## GlueDataCatalog +### Properties +* **DatabaseName**: string (Required): A string containing the value for the tag +* **RoleArn**: string (Required): A string containing the value for the tag +* **TablePrefix**: string (Required): A string containing the value for the tag + ## GoogleAnalyticsConnectorProfileCredentials ### Properties * **AccessToken**: string: The credentials used to access protected resources. @@ -136,6 +273,14 @@ granted. * **ConnectorOAuthRequest**: [ConnectorOAuthRequest](#connectoroauthrequest): The oauth needed to request security tokens from the connector endpoint. * **RefreshToken**: string: The credentials used to acquire new access tokens. +## GoogleAnalyticsSourceProperties +### Properties +* **Object**: string (Required) + +## IncrementalPullConfig +### Properties +* **DatetimeTypeFieldName**: string + ## InforNexusConnectorProfileCredentials ### Properties * **AccessKeyId**: string (Required): The Access Key portion of the credentials. @@ -143,106 +288,53 @@ granted. * **SecretAccessKey**: string (Required): The secret key used to sign requests. * **UserId**: string (Required): The identi?er for the user. -## MarketoConnectorProfileCredentials +## InforNexusConnectorProfileProperties ### Properties -* **AccessToken**: string: The credentials used to access protected resources. -* **ClientId**: string (Required): The identi?er for the desired client. -* **ClientSecret**: string (Required): The client secret used by the oauth client to authenticate to the authorization server. -* **ConnectorOAuthRequest**: [ConnectorOAuthRequest](#connectoroauthrequest): The oauth needed to request security tokens from the connector endpoint. +* **InstanceUrl**: string (Required): The location of the InforNexus resource -## PardotConnectorProfileCredentials +## InforNexusSourceProperties ### Properties -* **AccessToken**: string: The credentials used to access protected resources. -* **ClientCredentialsArn**: string: The client credentials to fetch access token and refresh token. -* **ConnectorOAuthRequest**: [ConnectorOAuthRequest](#connectoroauthrequest): The oauth needed to request security tokens from the connector endpoint. -* **RefreshToken**: string: The credentials used to acquire new access tokens. +* **Object**: string (Required) -## RedshiftConnectorProfileCredentials +## LambdaConnectorProvisioningConfig ### Properties -* **Password**: string: The password that corresponds to the username. -* **Username**: string: The name of the user. +* **LambdaArn**: string (Required): Lambda ARN of the connector being registered. -## SalesforceConnectorProfileCredentials +## LookoutMetricsDestinationProperties +### Properties +* **Object**: string + +## MarketoConnectorProfileCredentials ### Properties * **AccessToken**: string: The credentials used to access protected resources. -* **ClientCredentialsArn**: string: The client credentials to fetch access token and refresh token. +* **ClientId**: string (Required): The identi?er for the desired client. +* **ClientSecret**: string (Required): The client secret used by the oauth client to authenticate to the authorization server. * **ConnectorOAuthRequest**: [ConnectorOAuthRequest](#connectoroauthrequest): The oauth needed to request security tokens from the connector endpoint. -* **JwtToken**: string: The credentials used to access your Salesforce records -* **OAuth2GrantType**: string: The grant types to fetch an access token -* **RefreshToken**: string: The credentials used to acquire new access tokens. -## SAPODataConnectorProfileCredentials +## MarketoConnectorProfileProperties ### Properties -* **BasicAuthCredentials**: [BasicAuthCredentials](#basicauthcredentials) -* **OAuthCredentials**: [ConnectorProfile_OAuthCredentials](#connectorprofileoauthcredentials) +* **InstanceUrl**: string (Required): The location of the Marketo resource -## ConnectorProfile_OAuthCredentials +## MarketoDestinationProperties ### Properties -* **AccessToken**: string -* **ClientId**: string -* **ClientSecret**: string -* **ConnectorOAuthRequest**: [ConnectorOAuthRequest](#connectoroauthrequest) -* **RefreshToken**: string - -## ServiceNowConnectorProfileCredentials -### Properties -* **OAuth2Credentials**: [OAuth2Credentials](#oauth2credentials): The OAuth 2.0 credentials required to authenticate the user. -* **Password**: string: The password that corresponds to the username. -* **Username**: string: The name of the user. - -## SingularConnectorProfileCredentials -### Properties -* **ApiKey**: string (Required): A unique alphanumeric identi?er used to authenticate a user, developer, or calling program to your API. - -## SlackConnectorProfileCredentials -### Properties -* **AccessToken**: string: The credentials used to access protected resources. -* **ClientId**: string (Required): The identi?er for the desired client. -* **ClientSecret**: string (Required): The client secret used by the oauth client to authenticate to the authorization server. -* **ConnectorOAuthRequest**: [ConnectorOAuthRequest](#connectoroauthrequest): The oauth needed to request security tokens from the connector endpoint. - -## SnowflakeConnectorProfileCredentials -### Properties -* **Password**: string (Required): The password that corresponds to the username. -* **Username**: string (Required): The name of the user. - -## TrendmicroConnectorProfileCredentials -### Properties -* **ApiSecretKey**: string (Required): The Secret Access Key portion of the credentials. - -## VeevaConnectorProfileCredentials -### Properties -* **Password**: string (Required): The password that corresponds to the username. -* **Username**: string (Required): The name of the user. +* **ErrorHandlingConfig**: [ErrorHandlingConfig](#errorhandlingconfig) +* **Object**: string (Required) -## ZendeskConnectorProfileCredentials +## MarketoSourceProperties ### Properties -* **AccessToken**: string: The credentials used to access protected resources. -* **ClientId**: string (Required): The identi?er for the desired client. -* **ClientSecret**: string (Required): The client secret used by the oauth client to authenticate to the authorization server. -* **ConnectorOAuthRequest**: [ConnectorOAuthRequest](#connectoroauthrequest): The oauth needed to request security tokens from the connector endpoint. +* **Object**: string (Required) -## ConnectorProfileProperties +## MetadataCatalogConfig ### Properties -* **CustomConnector**: [CustomConnectorProfileProperties](#customconnectorprofileproperties) -* **Datadog**: [DatadogConnectorProfileProperties](#datadogconnectorprofileproperties) -* **Dynatrace**: [DynatraceConnectorProfileProperties](#dynatraceconnectorprofileproperties) -* **InforNexus**: [InforNexusConnectorProfileProperties](#infornexusconnectorprofileproperties) -* **Marketo**: [MarketoConnectorProfileProperties](#marketoconnectorprofileproperties) -* **Pardot**: [PardotConnectorProfileProperties](#pardotconnectorprofileproperties) -* **Redshift**: [RedshiftConnectorProfileProperties](#redshiftconnectorprofileproperties) -* **Salesforce**: [SalesforceConnectorProfileProperties](#salesforceconnectorprofileproperties) -* **SAPOData**: [SAPODataConnectorProfileProperties](#sapodataconnectorprofileproperties) -* **ServiceNow**: [ServiceNowConnectorProfileProperties](#servicenowconnectorprofileproperties) -* **Slack**: [SlackConnectorProfileProperties](#slackconnectorprofileproperties) -* **Snowflake**: [SnowflakeConnectorProfileProperties](#snowflakeconnectorprofileproperties) -* **Veeva**: [VeevaConnectorProfileProperties](#veevaconnectorprofileproperties) -* **Zendesk**: [ZendeskConnectorProfileProperties](#zendeskconnectorprofileproperties) +* **GlueDataCatalog**: [GlueDataCatalog](#gluedatacatalog): Configurations of glue data catalog of the flow. -## CustomConnectorProfileProperties +## OAuth2Credentials ### Properties -* **OAuth2Properties**: [OAuth2Properties](#oauth2properties) -* **ProfileProperties**: [ProfileProperties](#profileproperties) +* **AccessToken**: string +* **ClientId**: string +* **ClientSecret**: string +* **OAuthRequest**: [ConnectorOAuthRequest](#connectoroauthrequest) +* **RefreshToken**: string ## OAuth2Properties ### Properties @@ -250,33 +342,42 @@ granted. * **TokenUrl**: string * **TokenUrlCustomProperties**: [TokenUrlCustomProperties](#tokenurlcustomproperties) -## TokenUrlCustomProperties +## OAuthProperties ### Properties +* **AuthCodeUrl**: string +* **OAuthScopes**: string[] +* **TokenUrl**: string -## ProfileProperties +## PardotConnectorProfileCredentials ### Properties +* **AccessToken**: string: The credentials used to access protected resources. +* **ClientCredentialsArn**: string: The client credentials to fetch access token and refresh token. +* **ConnectorOAuthRequest**: [ConnectorOAuthRequest](#connectoroauthrequest): The oauth needed to request security tokens from the connector endpoint. +* **RefreshToken**: string: The credentials used to acquire new access tokens. -## DatadogConnectorProfileProperties +## PardotConnectorProfileProperties ### Properties -* **InstanceUrl**: string (Required): The location of the Datadog resource +* **BusinessUnitId**: string (Required): The Business unit id of Salesforce Pardot instance to be connected +* **InstanceUrl**: string: The location of the Salesforce Pardot resource +* **IsSandboxEnvironment**: bool: Indicates whether the connector profile applies to a demo or production environment -## DynatraceConnectorProfileProperties +## PardotSourceProperties ### Properties -* **InstanceUrl**: string (Required): The location of the Dynatrace resource +* **Object**: string (Required) -## InforNexusConnectorProfileProperties +## PrefixConfig ### Properties -* **InstanceUrl**: string (Required): The location of the InforNexus resource +* **PathPrefixHierarchy**: string[] +* **PrefixFormat**: string +* **PrefixType**: string -## MarketoConnectorProfileProperties +## ProfileProperties ### Properties -* **InstanceUrl**: string (Required): The location of the Marketo resource -## PardotConnectorProfileProperties +## RedshiftConnectorProfileCredentials ### Properties -* **BusinessUnitId**: string (Required): The Business unit id of Salesforce Pardot instance to be connected -* **InstanceUrl**: string: The location of the Salesforce Pardot resource -* **IsSandboxEnvironment**: bool: Indicates whether the connector profile applies to a demo or production environment +* **Password**: string: The password that corresponds to the username. +* **Username**: string: The name of the user. ## RedshiftConnectorProfileProperties ### Properties @@ -290,221 +391,174 @@ granted. * **RoleArn**: string (Required): The Amazon Resource Name (ARN) of the IAM role. * **WorkgroupName**: string: The name of the Amazon Redshift serverless workgroup -## SalesforceConnectorProfileProperties -### Properties -* **InstanceUrl**: string: The location of the Salesforce resource -* **isSandboxEnvironment**: bool: Indicates whether the connector profile applies to a sandbox or production environment -* **usePrivateLinkForMetadataAndAuthorization**: bool: Indicates whether to make Metadata And Authorization calls over Pivate Network - -## SAPODataConnectorProfileProperties -### Properties -* **ApplicationHostUrl**: string -* **ApplicationServicePath**: string -* **ClientNumber**: string -* **DisableSSO**: bool: If you set this parameter to true, Amazon AppFlow bypasses the single sign-on (SSO) settings in your SAP account when it accesses your SAP OData instance. -* **LogonLanguage**: string -* **OAuthProperties**: [OAuthProperties](#oauthproperties) -* **PortNumber**: int -* **PrivateLinkServiceName**: string - -## OAuthProperties -### Properties -* **AuthCodeUrl**: string -* **OAuthScopes**: string[] -* **TokenUrl**: string - -## ServiceNowConnectorProfileProperties -### Properties -* **InstanceUrl**: string (Required): The location of the ServiceNow resource - -## SlackConnectorProfileProperties +## RedshiftDestinationProperties ### Properties -* **InstanceUrl**: string (Required): The location of the Slack resource +* **BucketPrefix**: string +* **ErrorHandlingConfig**: [ErrorHandlingConfig](#errorhandlingconfig) +* **IntermediateBucketName**: string (Required) +* **Object**: string (Required) -## SnowflakeConnectorProfileProperties +## S3DestinationProperties ### Properties -* **AccountName**: string: The name of the account. -* **BucketName**: string (Required): The name of the Amazon S3 bucket associated with Snow?ake. -* **BucketPrefix**: string: The bucket prefix that refers to the Amazon S3 bucket associated with Snow?ake. -* **PrivateLinkServiceName**: string: The Snow?ake Private Link service name to be used for private data transfers. -* **Region**: string: The region of the Snow?ake account. -* **Stage**: string (Required): The name of the Amazon S3 stage that was created while setting up an Amazon S3 stage in the -Snow?ake account. This is written in the following format: < Database>< Schema>. -* **Warehouse**: string (Required): The name of the Snow?ake warehouse. +* **BucketName**: string (Required) +* **BucketPrefix**: string +* **S3OutputFormatConfig**: [S3OutputFormatConfig](#s3outputformatconfig) -## VeevaConnectorProfileProperties +## S3InputFormatConfig ### Properties -* **InstanceUrl**: string (Required): The location of the Veeva resource +* **S3InputFileType**: string -## ZendeskConnectorProfileProperties +## S3OutputFormatConfig ### Properties -* **InstanceUrl**: string (Required): The location of the Zendesk resource +* **AggregationConfig**: [AggregationConfig](#aggregationconfig) +* **FileType**: string +* **PrefixConfig**: [PrefixConfig](#prefixconfig) +* **PreserveSourceDataTyping**: bool -## AWS.AppFlow/FlowProperties +## S3SourceProperties ### Properties -* **Description**: string: Description of the flow. -* **DestinationFlowConfigList**: [DestinationFlowConfig](#destinationflowconfig)[] (Required): List of Destination connectors of the flow. -* **FlowArn**: string (ReadOnly): ARN identifier of the flow. -* **FlowName**: string (Required, Identifier): Name of the flow. -* **FlowStatus**: string: Flow activation status for Scheduled- and Event-triggered flows -* **KMSArn**: string: The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment variables. If it's not provided, AWS Lambda uses a default service key. -* **MetadataCatalogConfig**: [MetadataCatalogConfig](#metadatacatalogconfig): Configurations of metadata catalog of the flow. -* **SourceFlowConfig**: [SourceFlowConfig](#sourceflowconfig) (Required): Configurations of Source connector of the flow. -* **Tags**: [Tag](#tag)[]: List of Tags. -* **Tasks**: [Task](#task)[] (Required): List of tasks for the flow. -* **TriggerConfig**: [TriggerConfig](#triggerconfig) (Required): Trigger settings of the flow. +* **BucketName**: string (Required) +* **BucketPrefix**: string (Required) +* **S3InputFormatConfig**: [S3InputFormatConfig](#s3inputformatconfig) -## DestinationFlowConfig +## SalesforceConnectorProfileCredentials ### Properties -* **ApiVersion**: string: The API version that the destination connector uses. -* **ConnectorProfileName**: string: Name of destination connector profile -* **ConnectorType**: string (Required): Destination connector type -* **DestinationConnectorProperties**: [DestinationConnectorProperties](#destinationconnectorproperties) (Required): Destination connector details +* **AccessToken**: string: The credentials used to access protected resources. +* **ClientCredentialsArn**: string: The client credentials to fetch access token and refresh token. +* **ConnectorOAuthRequest**: [ConnectorOAuthRequest](#connectoroauthrequest): The oauth needed to request security tokens from the connector endpoint. +* **JwtToken**: string: The credentials used to access your Salesforce records +* **OAuth2GrantType**: string: The grant types to fetch an access token +* **RefreshToken**: string: The credentials used to acquire new access tokens. -## DestinationConnectorProperties +## SalesforceConnectorProfileProperties ### Properties -* **CustomConnector**: [CustomConnectorDestinationProperties](#customconnectordestinationproperties) -* **EventBridge**: [EventBridgeDestinationProperties](#eventbridgedestinationproperties) -* **LookoutMetrics**: [LookoutMetricsDestinationProperties](#lookoutmetricsdestinationproperties) -* **Marketo**: [MarketoDestinationProperties](#marketodestinationproperties) -* **Redshift**: [RedshiftDestinationProperties](#redshiftdestinationproperties) -* **S3**: [S3DestinationProperties](#s3destinationproperties) -* **Salesforce**: [SalesforceDestinationProperties](#salesforcedestinationproperties) -* **SAPOData**: [SAPODataDestinationProperties](#sapodatadestinationproperties) -* **Snowflake**: [SnowflakeDestinationProperties](#snowflakedestinationproperties) -* **Upsolver**: [UpsolverDestinationProperties](#upsolverdestinationproperties) -* **Zendesk**: [ZendeskDestinationProperties](#zendeskdestinationproperties) +* **InstanceUrl**: string: The location of the Salesforce resource +* **isSandboxEnvironment**: bool: Indicates whether the connector profile applies to a sandbox or production environment +* **usePrivateLinkForMetadataAndAuthorization**: bool: Indicates whether to make Metadata And Authorization calls over Pivate Network -## CustomConnectorDestinationProperties +## SalesforceDestinationProperties ### Properties -* **CustomProperties**: [CustomProperties](#customproperties) -* **EntityName**: string (Required) +* **DataTransferApi**: string * **ErrorHandlingConfig**: [ErrorHandlingConfig](#errorhandlingconfig) * **IdFieldNames**: string[]: List of fields used as ID when performing a write operation. +* **Object**: string (Required) * **WriteOperationType**: string -## CustomProperties +## SalesforceSourceProperties ### Properties +* **DataTransferApi**: string +* **EnableDynamicFieldUpdate**: bool +* **IncludeDeletedRecords**: bool +* **Object**: string (Required) -## ErrorHandlingConfig +## SAPODataConnectorProfileCredentials ### Properties -* **BucketName**: string -* **BucketPrefix**: string -* **FailOnFirstError**: bool +* **BasicAuthCredentials**: [BasicAuthCredentials](#basicauthcredentials) +* **OAuthCredentials**: [ConnectorProfile_OAuthCredentials](#connectorprofileoauthcredentials) -## EventBridgeDestinationProperties +## SAPODataConnectorProfileProperties ### Properties -* **ErrorHandlingConfig**: [ErrorHandlingConfig](#errorhandlingconfig) -* **Object**: string (Required) +* **ApplicationHostUrl**: string +* **ApplicationServicePath**: string +* **ClientNumber**: string +* **DisableSSO**: bool: If you set this parameter to true, Amazon AppFlow bypasses the single sign-on (SSO) settings in your SAP account when it accesses your SAP OData instance. +* **LogonLanguage**: string +* **OAuthProperties**: [OAuthProperties](#oauthproperties) +* **PortNumber**: int +* **PrivateLinkServiceName**: string -## LookoutMetricsDestinationProperties +## SAPODataDestinationProperties ### Properties -* **Object**: string +* **ErrorHandlingConfig**: [ErrorHandlingConfig](#errorhandlingconfig) +* **IdFieldNames**: string[]: List of fields used as ID when performing a write operation. +* **ObjectPath**: string (Required) +* **SuccessResponseHandlingConfig**: [SuccessResponseHandlingConfig](#successresponsehandlingconfig) +* **WriteOperationType**: string -## MarketoDestinationProperties +## SAPODataPaginationConfig ### Properties -* **ErrorHandlingConfig**: [ErrorHandlingConfig](#errorhandlingconfig) -* **Object**: string (Required) +* **maxPageSize**: int (Required) -## RedshiftDestinationProperties +## SAPODataParallelismConfig ### Properties -* **BucketPrefix**: string -* **ErrorHandlingConfig**: [ErrorHandlingConfig](#errorhandlingconfig) -* **IntermediateBucketName**: string (Required) -* **Object**: string (Required) +* **maxParallelism**: int (Required) -## S3DestinationProperties +## SAPODataSourceProperties ### Properties -* **BucketName**: string (Required) -* **BucketPrefix**: string -* **S3OutputFormatConfig**: [S3OutputFormatConfig](#s3outputformatconfig) +* **ObjectPath**: string (Required) +* **paginationConfig**: [SAPODataPaginationConfig](#sapodatapaginationconfig) +* **parallelismConfig**: [SAPODataParallelismConfig](#sapodataparallelismconfig) -## S3OutputFormatConfig +## ScheduledTriggerProperties ### Properties -* **AggregationConfig**: [AggregationConfig](#aggregationconfig) -* **FileType**: string -* **PrefixConfig**: [PrefixConfig](#prefixconfig) -* **PreserveSourceDataTyping**: bool +* **DataPullMode**: string +* **FirstExecutionFrom**: int +* **FlowErrorDeactivationThreshold**: int +* **ScheduleEndTime**: int +* **ScheduleExpression**: string (Required) +* **ScheduleOffset**: int +* **ScheduleStartTime**: int +* **TimeZone**: string -## AggregationConfig +## ServiceNowConnectorProfileCredentials ### Properties -* **AggregationType**: string -* **TargetFileSize**: int +* **OAuth2Credentials**: [OAuth2Credentials](#oauth2credentials): The OAuth 2.0 credentials required to authenticate the user. +* **Password**: string: The password that corresponds to the username. +* **Username**: string: The name of the user. -## PrefixConfig +## ServiceNowConnectorProfileProperties ### Properties -* **PathPrefixHierarchy**: string[] -* **PrefixFormat**: string -* **PrefixType**: string +* **InstanceUrl**: string (Required): The location of the ServiceNow resource -## SalesforceDestinationProperties +## ServiceNowSourceProperties ### Properties -* **DataTransferApi**: string -* **ErrorHandlingConfig**: [ErrorHandlingConfig](#errorhandlingconfig) -* **IdFieldNames**: string[]: List of fields used as ID when performing a write operation. * **Object**: string (Required) -* **WriteOperationType**: string - -## SAPODataDestinationProperties -### Properties -* **ErrorHandlingConfig**: [ErrorHandlingConfig](#errorhandlingconfig) -* **IdFieldNames**: string[]: List of fields used as ID when performing a write operation. -* **ObjectPath**: string (Required) -* **SuccessResponseHandlingConfig**: [SuccessResponseHandlingConfig](#successresponsehandlingconfig) -* **WriteOperationType**: string -## SuccessResponseHandlingConfig +## SingularConnectorProfileCredentials ### Properties -* **BucketName**: string -* **BucketPrefix**: string +* **ApiKey**: string (Required): A unique alphanumeric identi?er used to authenticate a user, developer, or calling program to your API. -## SnowflakeDestinationProperties +## SingularSourceProperties ### Properties -* **BucketPrefix**: string -* **ErrorHandlingConfig**: [ErrorHandlingConfig](#errorhandlingconfig) -* **IntermediateBucketName**: string (Required) * **Object**: string (Required) -## UpsolverDestinationProperties +## SlackConnectorProfileCredentials ### Properties -* **BucketName**: string (Required) -* **BucketPrefix**: string -* **S3OutputFormatConfig**: [UpsolverS3OutputFormatConfig](#upsolvers3outputformatconfig) (Required) +* **AccessToken**: string: The credentials used to access protected resources. +* **ClientId**: string (Required): The identi?er for the desired client. +* **ClientSecret**: string (Required): The client secret used by the oauth client to authenticate to the authorization server. +* **ConnectorOAuthRequest**: [ConnectorOAuthRequest](#connectoroauthrequest): The oauth needed to request security tokens from the connector endpoint. -## UpsolverS3OutputFormatConfig +## SlackConnectorProfileProperties ### Properties -* **AggregationConfig**: [AggregationConfig](#aggregationconfig) -* **FileType**: string -* **PrefixConfig**: [PrefixConfig](#prefixconfig) (Required) +* **InstanceUrl**: string (Required): The location of the Slack resource -## ZendeskDestinationProperties +## SlackSourceProperties ### Properties -* **ErrorHandlingConfig**: [ErrorHandlingConfig](#errorhandlingconfig) -* **IdFieldNames**: string[]: List of fields used as ID when performing a write operation. * **Object**: string (Required) -* **WriteOperationType**: string - -## MetadataCatalogConfig -### Properties -* **GlueDataCatalog**: [GlueDataCatalog](#gluedatacatalog): Configurations of glue data catalog of the flow. -## GlueDataCatalog +## SnowflakeConnectorProfileCredentials ### Properties -* **DatabaseName**: string (Required): A string containing the value for the tag -* **RoleArn**: string (Required): A string containing the value for the tag -* **TablePrefix**: string (Required): A string containing the value for the tag +* **Password**: string (Required): The password that corresponds to the username. +* **Username**: string (Required): The name of the user. -## SourceFlowConfig +## SnowflakeConnectorProfileProperties ### Properties -* **ApiVersion**: string: The API version that the destination connector uses. -* **ConnectorProfileName**: string: Name of source connector profile -* **ConnectorType**: string (Required): Type of source connector -* **IncrementalPullConfig**: [IncrementalPullConfig](#incrementalpullconfig): Configuration for scheduled incremental data pull -* **SourceConnectorProperties**: [SourceConnectorProperties](#sourceconnectorproperties) (Required): Source connector details required to query a connector +* **AccountName**: string: The name of the account. +* **BucketName**: string (Required): The name of the Amazon S3 bucket associated with Snow?ake. +* **BucketPrefix**: string: The bucket prefix that refers to the Amazon S3 bucket associated with Snow?ake. +* **PrivateLinkServiceName**: string: The Snow?ake Private Link service name to be used for private data transfers. +* **Region**: string: The region of the Snow?ake account. +* **Stage**: string (Required): The name of the Amazon S3 stage that was created while setting up an Amazon S3 stage in the +Snow?ake account. This is written in the following format: < Database>< Schema>. +* **Warehouse**: string (Required): The name of the Snow?ake warehouse. -## IncrementalPullConfig +## SnowflakeDestinationProperties ### Properties -* **DatetimeTypeFieldName**: string +* **BucketPrefix**: string +* **ErrorHandlingConfig**: [ErrorHandlingConfig](#errorhandlingconfig) +* **IntermediateBucketName**: string (Required) +* **Object**: string (Required) ## SourceConnectorProperties ### Properties @@ -526,91 +580,73 @@ Snow?ake account. This is written in the following format: < Database>< Schema>< * **Veeva**: [VeevaSourceProperties](#veevasourceproperties) * **Zendesk**: [ZendeskSourceProperties](#zendesksourceproperties) -## AmplitudeSourceProperties +## SourceFlowConfig ### Properties -* **Object**: string (Required) +* **ApiVersion**: string: The API version that the destination connector uses. +* **ConnectorProfileName**: string: Name of source connector profile +* **ConnectorType**: string (Required): Type of source connector +* **IncrementalPullConfig**: [IncrementalPullConfig](#incrementalpullconfig): Configuration for scheduled incremental data pull +* **SourceConnectorProperties**: [SourceConnectorProperties](#sourceconnectorproperties) (Required): Source connector details required to query a connector -## CustomConnectorSourceProperties +## SuccessResponseHandlingConfig ### Properties -* **CustomProperties**: [CustomProperties](#customproperties) -* **DataTransferApi**: [Flow_DataTransferApi](#flowdatatransferapi) -* **EntityName**: string (Required) +* **BucketName**: string +* **BucketPrefix**: string -## Flow_DataTransferApi +## Tag ### Properties -* **Name**: string (Required) -* **Type**: string (Required) +* **Key**: string (Required): A string used to identify this tag +* **Value**: string (Required): A string containing the value for the tag -## DatadogSourceProperties +## Task ### Properties -* **Object**: string (Required) +* **ConnectorOperator**: [ConnectorOperator](#connectoroperator): Operation to be performed on provided source fields +* **DestinationField**: string: A field value on which source field should be validated +* **SourceFields**: string[] (Required): Source fields on which particular task will be applied +* **TaskProperties**: [TaskPropertiesObject](#taskpropertiesobject)[]: A Map used to store task related info +* **TaskType**: string (Required): Type of task -## DynatraceSourceProperties +## TaskPropertiesObject ### Properties -* **Object**: string (Required) +* **Key**: string (Required) +* **Value**: string (Required) -## GoogleAnalyticsSourceProperties +## TokenUrlCustomProperties ### Properties -* **Object**: string (Required) -## InforNexusSourceProperties +## TrendmicroConnectorProfileCredentials ### Properties -* **Object**: string (Required) +* **ApiSecretKey**: string (Required): The Secret Access Key portion of the credentials. -## MarketoSourceProperties +## TrendmicroSourceProperties ### Properties * **Object**: string (Required) -## PardotSourceProperties +## TriggerConfig ### Properties -* **Object**: string (Required) +* **TriggerProperties**: [ScheduledTriggerProperties](#scheduledtriggerproperties): Details required based on the type of trigger +* **TriggerType**: string (Required): Trigger type of the flow -## S3SourceProperties +## UpsolverDestinationProperties ### Properties * **BucketName**: string (Required) -* **BucketPrefix**: string (Required) -* **S3InputFormatConfig**: [S3InputFormatConfig](#s3inputformatconfig) - -## S3InputFormatConfig -### Properties -* **S3InputFileType**: string - -## SalesforceSourceProperties -### Properties -* **DataTransferApi**: string -* **EnableDynamicFieldUpdate**: bool -* **IncludeDeletedRecords**: bool -* **Object**: string (Required) - -## SAPODataSourceProperties -### Properties -* **ObjectPath**: string (Required) -* **paginationConfig**: [SAPODataPaginationConfig](#sapodatapaginationconfig) -* **parallelismConfig**: [SAPODataParallelismConfig](#sapodataparallelismconfig) - -## SAPODataPaginationConfig -### Properties -* **maxPageSize**: int (Required) - -## SAPODataParallelismConfig -### Properties -* **maxParallelism**: int (Required) - -## ServiceNowSourceProperties -### Properties -* **Object**: string (Required) +* **BucketPrefix**: string +* **S3OutputFormatConfig**: [UpsolverS3OutputFormatConfig](#upsolvers3outputformatconfig) (Required) -## SingularSourceProperties +## UpsolverS3OutputFormatConfig ### Properties -* **Object**: string (Required) +* **AggregationConfig**: [AggregationConfig](#aggregationconfig) +* **FileType**: string +* **PrefixConfig**: [PrefixConfig](#prefixconfig) (Required) -## SlackSourceProperties +## VeevaConnectorProfileCredentials ### Properties -* **Object**: string (Required) +* **Password**: string (Required): The password that corresponds to the username. +* **Username**: string (Required): The name of the user. -## TrendmicroSourceProperties +## VeevaConnectorProfileProperties ### Properties -* **Object**: string (Required) +* **InstanceUrl**: string (Required): The location of the Veeva resource ## VeevaSourceProperties ### Properties @@ -620,61 +656,25 @@ Snow?ake account. This is written in the following format: < Database>< Schema>< * **IncludeSourceFiles**: bool * **Object**: string (Required) -## ZendeskSourceProperties -### Properties -* **Object**: string (Required) - -## Tag -### Properties -* **Key**: string (Required): A string used to identify this tag -* **Value**: string (Required): A string containing the value for the tag - -## Task -### Properties -* **ConnectorOperator**: [ConnectorOperator](#connectoroperator): Operation to be performed on provided source fields -* **DestinationField**: string: A field value on which source field should be validated -* **SourceFields**: string[] (Required): Source fields on which particular task will be applied -* **TaskProperties**: [TaskPropertiesObject](#taskpropertiesobject)[]: A Map used to store task related info -* **TaskType**: string (Required): Type of task - -## ConnectorOperator +## ZendeskConnectorProfileCredentials ### Properties -* **Amplitude**: string -* **CustomConnector**: string -* **Datadog**: string -* **Dynatrace**: string -* **GoogleAnalytics**: string -* **InforNexus**: string -* **Marketo**: string -* **Pardot**: string -* **S3**: string -* **Salesforce**: string -* **SAPOData**: string -* **ServiceNow**: string -* **Singular**: string -* **Slack**: string -* **Trendmicro**: string -* **Veeva**: string -* **Zendesk**: string +* **AccessToken**: string: The credentials used to access protected resources. +* **ClientId**: string (Required): The identi?er for the desired client. +* **ClientSecret**: string (Required): The client secret used by the oauth client to authenticate to the authorization server. +* **ConnectorOAuthRequest**: [ConnectorOAuthRequest](#connectoroauthrequest): The oauth needed to request security tokens from the connector endpoint. -## TaskPropertiesObject +## ZendeskConnectorProfileProperties ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **InstanceUrl**: string (Required): The location of the Zendesk resource -## TriggerConfig +## ZendeskDestinationProperties ### Properties -* **TriggerProperties**: [ScheduledTriggerProperties](#scheduledtriggerproperties): Details required based on the type of trigger -* **TriggerType**: string (Required): Trigger type of the flow +* **ErrorHandlingConfig**: [ErrorHandlingConfig](#errorhandlingconfig) +* **IdFieldNames**: string[]: List of fields used as ID when performing a write operation. +* **Object**: string (Required) +* **WriteOperationType**: string -## ScheduledTriggerProperties +## ZendeskSourceProperties ### Properties -* **DataPullMode**: string -* **FirstExecutionFrom**: int -* **FlowErrorDeactivationThreshold**: int -* **ScheduleEndTime**: int -* **ScheduleExpression**: string (Required) -* **ScheduleOffset**: int -* **ScheduleStartTime**: int -* **TimeZone**: string +* **Object**: string (Required) diff --git a/artifacts/bicep/aws/aws.appintegrations/default/types.json b/artifacts/bicep/aws/aws.appintegrations/default/types.json index db5d6640..f45faf90 100644 --- a/artifacts/bicep/aws/aws.appintegrations/default/types.json +++ b/artifacts/bicep/aws/aws.appintegrations/default/types.json @@ -1 +1,537 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"FileConfiguration","Properties":{"Filters":{"Type":12,"Flags":0,"Description":"Restrictions for what files should be pulled from the source."},"Folders":{"Type":13,"Flags":1,"Description":"Identifiers for the source folders to pull all files from recursively."}}}},{"2":{"Name":"ObjectConfiguration","Properties":{}}},{"2":{"Name":"ScheduleConfig","Properties":{"FirstExecutionFrom":{"Type":4,"Flags":0,"Description":"The start date for objects to import in the first flow run. Epoch or ISO timestamp format is supported."},"Object":{"Type":4,"Flags":0,"Description":"The name of the object to pull from the data source."},"ScheduleExpression":{"Type":4,"Flags":1,"Description":"How often the data should be pulled from data source."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"A key to identify the tag."},"Value":{"Type":4,"Flags":1,"Description":"Corresponding tag value for the key."}}}},{"2":{"Name":"DataIntegration_Filters","Properties":{}}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.AppIntegrations/DataIntegrationProperties","Properties":{"DataIntegrationArn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) of the data integration."},"Description":{"Type":4,"Flags":0,"Description":"The data integration description."},"FileConfiguration":{"Type":8,"Flags":0,"Description":"The configuration for what files should be pulled from the source."},"Id":{"Type":4,"Flags":18,"Description":"The unique identifer of the data integration."},"KmsKey":{"Type":4,"Flags":1,"Description":"The KMS key of the data integration."},"Name":{"Type":4,"Flags":1,"Description":"The name of the data integration."},"ObjectConfiguration":{"Type":9,"Flags":0,"Description":"The configuration for what data should be pulled from the source."},"ScheduleConfig":{"Type":10,"Flags":0,"Description":"The name of the data and how often it should be pulled from the source."},"SourceURI":{"Type":4,"Flags":1,"Description":"The URI of the data source."},"Tags":{"Type":15,"Flags":0,"Description":"The tags (keys and values) associated with the data integration."}}}},{"3":{"ItemType":11}},{"2":{"Name":"AWS.AppIntegrations/DataIntegration","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":14,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.AppIntegrations/DataIntegration@default","ScopeType":0,"Body":16}},{"2":{"Name":"EventFilter","Properties":{"Source":{"Type":4,"Flags":1,"Description":"The source of the events."}}}},{"2":{"Name":"Metadata","Properties":{"Key":{"Type":4,"Flags":1,"Description":"A key to identify the metadata."},"Value":{"Type":4,"Flags":1,"Description":"Corresponding metadata value for the key."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"A key to identify the tag."},"Value":{"Type":4,"Flags":1,"Description":"Corresponding tag value for the key."}}}},{"2":{"Name":"AWS.AppIntegrations/EventIntegrationProperties","Properties":{"Description":{"Type":4,"Flags":0,"Description":"The event integration description."},"EventBridgeBus":{"Type":4,"Flags":1,"Description":"The Amazon Eventbridge bus for the event integration."},"EventFilter":{"Type":18,"Flags":1,"Description":"The EventFilter (source) associated with the event integration."},"EventIntegrationArn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) of the event integration."},"Name":{"Type":4,"Flags":17,"Description":"The name of the event integration."},"Tags":{"Type":22,"Flags":0,"Description":"The tags (keys and values) associated with the event integration."}}}},{"3":{"ItemType":20}},{"2":{"Name":"AWS.AppIntegrations/EventIntegration","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":21,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.AppIntegrations/EventIntegration@default","ScopeType":0,"Body":23}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "ApprovedOrigins", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ExternalUrlConfig", + "properties": { + "AccessUrl": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + }, + "ApprovedOrigins": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Permissions", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "A key to identify the tag." + }, + "Value": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "Corresponding tag value for the key." + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.AppIntegrations/ApplicationProperties" + }, + { + "$type": "ObjectType", + "name": "Application_ApplicationSourceConfig", + "properties": { + "ExternalUrlConfig": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ObjectType", + "name": "AWS.AppIntegrations/ApplicationProperties", + "properties": { + "ApplicationArn": { + "type": { + "$ref": "#/4" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) of the application." + }, + "ApplicationSourceConfig": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "Application source config" + }, + "Description": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The application description." + }, + "Id": { + "type": { + "$ref": "#/4" + }, + "flags": 2, + "description": "The id of the application." + }, + "Name": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The name of the application." + }, + "Namespace": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The namespace of the application." + }, + "Permissions": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The configuration of events or requests that the application has access to." + }, + "Tags": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "The tags (keys and values) associated with the application." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.AppIntegrations/Application", + "properties": { + "name": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/10" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.AppIntegrations/Application@default", + "scopeType": 0, + "body": { + "$ref": "#/11" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "FileConfiguration", + "properties": { + "Filters": { + "type": { + "$ref": "#/17" + }, + "flags": 0, + "description": "Restrictions for what files should be pulled from the source." + }, + "Folders": { + "type": { + "$ref": "#/18" + }, + "flags": 1, + "description": "Identifiers for the source folders to pull all files from recursively." + } + } + }, + { + "$type": "ObjectType", + "name": "ObjectConfiguration", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ScheduleConfig", + "properties": { + "FirstExecutionFrom": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The start date for objects to import in the first flow run. Epoch or ISO timestamp format is supported." + }, + "Object": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The name of the object to pull from the data source." + }, + "ScheduleExpression": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "How often the data should be pulled from data source." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "A key to identify the tag." + }, + "Value": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "Corresponding tag value for the key." + } + } + }, + { + "$type": "ObjectType", + "name": "DataIntegration_Filters", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.AppIntegrations/DataIntegrationProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/16" + } + }, + { + "$type": "ObjectType", + "name": "AWS.AppIntegrations/DataIntegrationProperties", + "properties": { + "DataIntegrationArn": { + "type": { + "$ref": "#/4" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) of the data integration." + }, + "Description": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The data integration description." + }, + "FileConfiguration": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "The configuration for what files should be pulled from the source." + }, + "Id": { + "type": { + "$ref": "#/4" + }, + "flags": 18, + "description": "The unique identifer of the data integration." + }, + "KmsKey": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The KMS key of the data integration." + }, + "Name": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The name of the data integration." + }, + "ObjectConfiguration": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The configuration for what data should be pulled from the source." + }, + "ScheduleConfig": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "The name of the data and how often it should be pulled from the source." + }, + "SourceURI": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The URI of the data source." + }, + "Tags": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "The tags (keys and values) associated with the data integration." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.AppIntegrations/DataIntegration", + "properties": { + "name": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/21" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.AppIntegrations/DataIntegration@default", + "scopeType": 0, + "body": { + "$ref": "#/22" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "EventFilter", + "properties": { + "Source": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The source of the events." + } + } + }, + { + "$type": "ObjectType", + "name": "Metadata", + "properties": { + "Key": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "A key to identify the metadata." + }, + "Value": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "Corresponding metadata value for the key." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "A key to identify the tag." + }, + "Value": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "Corresponding tag value for the key." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.AppIntegrations/EventIntegrationProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/26" + } + }, + { + "$type": "ObjectType", + "name": "AWS.AppIntegrations/EventIntegrationProperties", + "properties": { + "Description": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The event integration description." + }, + "EventBridgeBus": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The Amazon Eventbridge bus for the event integration." + }, + "EventFilter": { + "type": { + "$ref": "#/24" + }, + "flags": 1, + "description": "The EventFilter (source) associated with the event integration." + }, + "EventIntegrationArn": { + "type": { + "$ref": "#/4" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) of the event integration." + }, + "Name": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "The name of the event integration." + }, + "Tags": { + "type": { + "$ref": "#/28" + }, + "flags": 0, + "description": "The tags (keys and values) associated with the event integration." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.AppIntegrations/EventIntegration", + "properties": { + "name": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/29" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.AppIntegrations/EventIntegration@default", + "scopeType": 0, + "body": { + "$ref": "#/30" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.appintegrations/default/types.md b/artifacts/bicep/aws/aws.appintegrations/default/types.md index e3d286dd..9f2a4b1e 100644 --- a/artifacts/bicep/aws/aws.appintegrations/default/types.md +++ b/artifacts/bicep/aws/aws.appintegrations/default/types.md @@ -1,18 +1,40 @@ # AWS.AppIntegrations @ default +## Resource AWS.AppIntegrations/Application@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.AppIntegrations/ApplicationProperties](#awsappintegrationsapplicationproperties) (Required, Identifier): properties of the resource + ## Resource AWS.AppIntegrations/DataIntegration@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.AppIntegrations/DataIntegrationProperties](#awsappintegrationsdataintegrationproperties) (Required): properties of the resource +* **properties**: [AWS.AppIntegrations/DataIntegrationProperties](#awsappintegrationsdataintegrationproperties) (Required, Identifier): properties of the resource ## Resource AWS.AppIntegrations/EventIntegration@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.AppIntegrations/EventIntegrationProperties](#awsappintegrationseventintegrationproperties) (Required): properties of the resource +* **properties**: [AWS.AppIntegrations/EventIntegrationProperties](#awsappintegrationseventintegrationproperties) (Required, Identifier): properties of the resource + +## Application_ApplicationSourceConfig +### Properties +* **ExternalUrlConfig**: [ExternalUrlConfig](#externalurlconfig) (Required) + +## AWS.AppIntegrations/ApplicationProperties +### Properties +* **ApplicationArn**: string (ReadOnly, Identifier): The Amazon Resource Name (ARN) of the application. +* **ApplicationSourceConfig**: [Application_ApplicationSourceConfig](#applicationapplicationsourceconfig) (Required): Application source config +* **Description**: string (Required): The application description. +* **Id**: string (ReadOnly): The id of the application. +* **Name**: string (Required): The name of the application. +* **Namespace**: string: The namespace of the application. +* **Permissions**: string[]: The configuration of events or requests that the application has access to. +* **Tags**: [Tag](#tag)[]: The tags (keys and values) associated with the application. ## AWS.AppIntegrations/DataIntegrationProperties ### Properties @@ -27,14 +49,32 @@ * **SourceURI**: string (Required): The URI of the data source. * **Tags**: [Tag](#tag)[]: The tags (keys and values) associated with the data integration. -## FileConfiguration +## AWS.AppIntegrations/EventIntegrationProperties ### Properties -* **Filters**: [DataIntegration_Filters](#dataintegrationfilters): Restrictions for what files should be pulled from the source. -* **Folders**: string[] (Required): Identifiers for the source folders to pull all files from recursively. +* **Description**: string: The event integration description. +* **EventBridgeBus**: string (Required): The Amazon Eventbridge bus for the event integration. +* **EventFilter**: [EventFilter](#eventfilter) (Required): The EventFilter (source) associated with the event integration. +* **EventIntegrationArn**: string (ReadOnly): The Amazon Resource Name (ARN) of the event integration. +* **Name**: string (Required, Identifier): The name of the event integration. +* **Tags**: [Tag](#tag)[]: The tags (keys and values) associated with the event integration. ## DataIntegration_Filters ### Properties +## EventFilter +### Properties +* **Source**: string (Required): The source of the events. + +## ExternalUrlConfig +### Properties +* **AccessUrl**: string (Required) +* **ApprovedOrigins**: string[] + +## FileConfiguration +### Properties +* **Filters**: [DataIntegration_Filters](#dataintegrationfilters): Restrictions for what files should be pulled from the source. +* **Folders**: string[] (Required): Identifiers for the source folders to pull all files from recursively. + ## ObjectConfiguration ### Properties @@ -49,18 +89,10 @@ * **Key**: string (Required): A key to identify the tag. * **Value**: string (Required): Corresponding tag value for the key. -## AWS.AppIntegrations/EventIntegrationProperties -### Properties -* **Description**: string: The event integration description. -* **EventBridgeBus**: string (Required): The Amazon Eventbridge bus for the event integration. -* **EventFilter**: [EventFilter](#eventfilter) (Required): The EventFilter (source) associated with the event integration. -* **EventIntegrationArn**: string (ReadOnly): The Amazon Resource Name (ARN) of the event integration. -* **Name**: string (Required, Identifier): The name of the event integration. -* **Tags**: [Tag](#tag)[]: The tags (keys and values) associated with the event integration. - -## EventFilter +## Tag ### Properties -* **Source**: string (Required): The source of the events. +* **Key**: string (Required): A key to identify the tag. +* **Value**: string (Required): Corresponding tag value for the key. ## Tag ### Properties diff --git a/artifacts/bicep/aws/aws.applicationautoscaling/default/types.json b/artifacts/bicep/aws/aws.applicationautoscaling/default/types.json index 0ae9cda1..8d0d3359 100644 --- a/artifacts/bicep/aws/aws.applicationautoscaling/default/types.json +++ b/artifacts/bicep/aws/aws.applicationautoscaling/default/types.json @@ -1 +1,673 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"ScalableTargetAction","Properties":{"MaxCapacity":{"Type":3,"Flags":0},"MinCapacity":{"Type":3,"Flags":0}}}},{"2":{"Name":"ScheduledAction","Properties":{"EndTime":{"Type":4,"Flags":0},"ScalableTargetAction":{"Type":8,"Flags":0},"Schedule":{"Type":4,"Flags":1},"ScheduledActionName":{"Type":4,"Flags":1},"StartTime":{"Type":4,"Flags":0},"Timezone":{"Type":4,"Flags":0}}}},{"2":{"Name":"SuspendedState","Properties":{"DynamicScalingInSuspended":{"Type":2,"Flags":0},"DynamicScalingOutSuspended":{"Type":2,"Flags":0},"ScheduledScalingSuspended":{"Type":2,"Flags":0}}}},{"2":{"Name":"AWS.ApplicationAutoScaling/ScalableTargetProperties","Properties":{"Id":{"Type":4,"Flags":2,"Description":"This value can be returned by using the Ref function. Ref returns the Cloudformation generated ID of the resource in format - ResourceId|ScalableDimension|ServiceNamespace"},"MaxCapacity":{"Type":3,"Flags":1,"Description":"The maximum value that you plan to scale in to. When a scaling policy is in effect, Application Auto Scaling can scale in (contract) as needed to the minimum capacity limit in response to changing demand"},"MinCapacity":{"Type":3,"Flags":1,"Description":"The minimum value that you plan to scale in to. When a scaling policy is in effect, Application Auto Scaling can scale in (contract) as needed to the minimum capacity limit in response to changing demand"},"ResourceId":{"Type":4,"Flags":17,"Description":"The identifier of the resource associated with the scalable target"},"RoleARN":{"Type":4,"Flags":4,"Description":"Specify the Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that allows Application Auto Scaling to modify the scalable target on your behalf. "},"ScalableDimension":{"Type":4,"Flags":17,"Description":"The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property"},"ScheduledActions":{"Type":12,"Flags":0,"Description":"The scheduled actions for the scalable target. Duplicates aren't allowed."},"ServiceNamespace":{"Type":4,"Flags":17,"Description":"The namespace of the AWS service that provides the resource, or a custom-resource"},"SuspendedState":{"Type":10,"Flags":0,"Description":"An embedded object that contains attributes and attribute values that are used to suspend and resume automatic scaling. Setting the value of an attribute to true suspends the specified scaling activities. Setting it to false (default) resumes the specified scaling activities."}}}},{"3":{"ItemType":9}},{"2":{"Name":"AWS.ApplicationAutoScaling/ScalableTarget","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":11,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ApplicationAutoScaling/ScalableTarget@default","ScopeType":0,"Body":13}},{"2":{"Name":"CustomizedMetricSpecification","Properties":{"Dimensions":{"Type":25,"Flags":0,"Description":"The dimensions of the metric."},"MetricName":{"Type":4,"Flags":0,"Description":"The name of the metric. To get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics."},"Metrics":{"Type":26,"Flags":0,"Description":"The metrics to include in the target tracking scaling policy, as a metric data query. This can include both raw metric and metric math expressions."},"Namespace":{"Type":4,"Flags":0,"Description":"The namespace of the metric."},"Statistic":{"Type":4,"Flags":0,"Description":"The statistic of the metric."},"Unit":{"Type":4,"Flags":0,"Description":"The unit of the metric. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference."}}}},{"2":{"Name":"MetricDimension","Properties":{"Name":{"Type":4,"Flags":1,"Description":"The name of the dimension."},"Value":{"Type":4,"Flags":1,"Description":"The value of the dimension."}}}},{"2":{"Name":"PredefinedMetricSpecification","Properties":{"PredefinedMetricType":{"Type":4,"Flags":1,"Description":"The metric type. The ALBRequestCountPerTarget metric type applies only to Spot Fleets and ECS services."},"ResourceLabel":{"Type":4,"Flags":4,"Description":"Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group attached to the Spot Fleet or ECS service."}}}},{"2":{"Name":"StepAdjustment","Properties":{"MetricIntervalLowerBound":{"Type":3,"Flags":0,"Description":"The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity."},"MetricIntervalUpperBound":{"Type":3,"Flags":0,"Description":"The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity."},"ScalingAdjustment":{"Type":3,"Flags":1,"Description":"The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity. For exact capacity, you must specify a positive value."}}}},{"2":{"Name":"StepScalingPolicyConfiguration","Properties":{"AdjustmentType":{"Type":4,"Flags":0,"Description":"Specifies how the ScalingAdjustment value in a StepAdjustment is interpreted."},"Cooldown":{"Type":3,"Flags":0,"Description":"The amount of time, in seconds, to wait for a previous scaling activity to take effect."},"MetricAggregationType":{"Type":4,"Flags":0,"Description":"The aggregation type for the CloudWatch metrics. Valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average"},"MinAdjustmentMagnitude":{"Type":3,"Flags":0,"Description":"The minimum value to scale by when the adjustment type is PercentChangeInCapacity."},"StepAdjustments":{"Type":27,"Flags":0,"Description":"A set of adjustments that enable you to scale based on the size of the alarm breach."}}}},{"2":{"Name":"TargetTrackingMetric","Properties":{"Dimensions":{"Type":28,"Flags":0,"Description":"The dimensions for the metric."},"MetricName":{"Type":4,"Flags":0,"Description":"The name of the metric."},"Namespace":{"Type":4,"Flags":0,"Description":"The namespace of the metric."}}}},{"2":{"Name":"TargetTrackingMetricDataQuery","Properties":{"Expression":{"Type":4,"Flags":0,"Description":"The math expression to perform on the returned data, if this object is performing a math expression."},"Id":{"Type":4,"Flags":0,"Description":"A short name that identifies the object's results in the response."},"Label":{"Type":4,"Flags":0,"Description":"A human-readable label for this metric or expression. This is especially useful if this is a math expression, so that you know what the value represents."},"MetricStat":{"Type":23,"Flags":0,"Description":"Information about the metric data to return."},"ReturnData":{"Type":2,"Flags":0,"Description":"Indicates whether to return the timestamps and raw data values of this metric."}}}},{"2":{"Name":"TargetTrackingMetricDimension","Properties":{"Name":{"Type":4,"Flags":0,"Description":"The name of the dimension."},"Value":{"Type":4,"Flags":0,"Description":"The value of the dimension."}}}},{"2":{"Name":"TargetTrackingMetricStat","Properties":{"Metric":{"Type":20,"Flags":0,"Description":"The CloudWatch metric to return, including the metric name, namespace, and dimensions. "},"Stat":{"Type":4,"Flags":0,"Description":"The statistic to return. It can include any CloudWatch statistic or extended statistic."},"Unit":{"Type":4,"Flags":0,"Description":"The unit to use for the returned data points."}}}},{"2":{"Name":"TargetTrackingScalingPolicyConfiguration","Properties":{"CustomizedMetricSpecification":{"Type":15,"Flags":0,"Description":"A customized metric. You can specify either a predefined metric or a customized metric."},"DisableScaleIn":{"Type":2,"Flags":0,"Description":"Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true, scale in is disabled and the target tracking scaling policy won't remove capacity from the scalable target. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable target. The default value is false."},"PredefinedMetricSpecification":{"Type":17,"Flags":0,"Description":"A predefined metric. You can specify either a predefined metric or a customized metric."},"ScaleInCooldown":{"Type":3,"Flags":0,"Description":"The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start."},"ScaleOutCooldown":{"Type":3,"Flags":0,"Description":"The amount of time, in seconds, to wait for a previous scale-out activity to take effect."},"TargetValue":{"Type":3,"Flags":1,"Description":"The target value for the metric. Although this property accepts numbers of type Double, it won't accept values that are either too small or too large. Values must be in the range of -2^360 to 2^360. The value must be a valid number based on the choice of metric. For example, if the metric is CPU utilization, then the target value is a percent value that represents how much of the CPU can be used before scaling out."}}}},{"3":{"ItemType":16}},{"3":{"ItemType":21}},{"3":{"ItemType":18}},{"3":{"ItemType":22}},{"2":{"Name":"AWS.ApplicationAutoScaling/ScalingPolicyProperties","Properties":{"Arn":{"Type":4,"Flags":18,"Description":"ARN is a read only property for the resource."},"PolicyName":{"Type":4,"Flags":1,"Description":"The name of the scaling policy.\n\nUpdates to the name of a target tracking scaling policy are not supported, unless you also update the metric used for scaling. To change only a target tracking scaling policy's name, first delete the policy by removing the existing AWS::ApplicationAutoScaling::ScalingPolicy resource from the template and updating the stack. Then, recreate the resource with the same settings and a different name."},"PolicyType":{"Type":4,"Flags":1,"Description":"The scaling policy type.\n\nThe following policy types are supported:\n\nTargetTrackingScaling Not supported for Amazon EMR\n\nStepScaling Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or Neptune."},"ResourceId":{"Type":4,"Flags":0,"Description":"The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier."},"ScalableDimension":{"Type":4,"Flags":16,"Description":"The scalable dimension. This string consists of the service namespace, resource type, and scaling property."},"ScalingTargetId":{"Type":4,"Flags":4,"Description":"The CloudFormation-generated ID of an Application Auto Scaling scalable target. For more information about the ID, see the Return Value section of the AWS::ApplicationAutoScaling::ScalableTarget resource."},"ServiceNamespace":{"Type":4,"Flags":0,"Description":"The namespace of the AWS service that provides the resource, or a custom-resource."},"StepScalingPolicyConfiguration":{"Type":19,"Flags":0,"Description":"A step scaling policy."},"TargetTrackingScalingPolicyConfiguration":{"Type":24,"Flags":0,"Description":"A target tracking scaling policy."}}}},{"2":{"Name":"AWS.ApplicationAutoScaling/ScalingPolicy","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":29,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ApplicationAutoScaling/ScalingPolicy@default","ScopeType":0,"Body":30}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "ScalableTargetAction", + "properties": { + "MaxCapacity": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The maximum capacity." + }, + "MinCapacity": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The minimum capacity." + } + } + }, + { + "$type": "ObjectType", + "name": "ScheduledAction", + "properties": { + "EndTime": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The date and time that the action is scheduled to end, in UTC." + }, + "ScalableTargetAction": { + "type": { + "$ref": "#/0" + }, + "flags": 0, + "description": "The new minimum and maximum capacity. You can set both values or just one. At the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity." + }, + "Schedule": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The schedule for this action. The following formats are supported:\n + At expressions - \"``at(yyyy-mm-ddThh:mm:ss)``\"\n + Rate expressions - \"``rate(value unit)``\"\n + Cron expressions - \"``cron(fields)``\"\n \n At expressions are useful for one-time schedules. Cron expressions are useful for scheduled actions that run periodically at a specified date and time, and rate expressions are useful for scheduled actions that run at a regular interval.\n At and cron expressions use Universal Coordinated Time (UTC) by default.\n The cron format consists of six fields separated by white spaces: [Minutes] [Hours] [Day_of_Month] [Month] [Day_of_Week] [Year].\n For rate expressions, *value* is a positive integer and *unit* is ``minute`` | ``minutes`` | ``hour`` | ``hours`` | ``day`` | ``days``." + }, + "ScheduledActionName": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The name of the scheduled action. This name must be unique among all other scheduled actions on the specified scalable target." + }, + "StartTime": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The date and time that the action is scheduled to begin, in UTC." + }, + "Timezone": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The time zone used when referring to the date and time of a scheduled action, when the scheduled action uses an at or cron expression." + } + } + }, + { + "$type": "ObjectType", + "name": "SuspendedState", + "properties": { + "DynamicScalingInSuspended": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "Whether scale in by a target tracking scaling policy or a step scaling policy is suspended. Set the value to ``true`` if you don't want Application Auto Scaling to remove capacity when a scaling policy is triggered. The default is ``false``." + }, + "DynamicScalingOutSuspended": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "Whether scale out by a target tracking scaling policy or a step scaling policy is suspended. Set the value to ``true`` if you don't want Application Auto Scaling to add capacity when a scaling policy is triggered. The default is ``false``." + }, + "ScheduledScalingSuspended": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "Whether scheduled scaling is suspended. Set the value to ``true`` if you don't want Application Auto Scaling to add or remove capacity by initiating scheduled actions. The default is ``false``." + } + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "StringType" + }, + { + "$type": "BooleanType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.ApplicationAutoScaling/ScalableTargetProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "AWS.ApplicationAutoScaling/ScalableTargetProperties", + "properties": { + "Id": { + "type": { + "$ref": "#/4" + }, + "flags": 2, + "description": "" + }, + "MaxCapacity": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The maximum value that you plan to scale out to. When a scaling policy is in effect, Application Auto Scaling can scale out (expand) as needed to the maximum capacity limit in response to changing demand." + }, + "MinCapacity": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The minimum value that you plan to scale in to. When a scaling policy is in effect, Application Auto Scaling can scale in (contract) as needed to the minimum capacity limit in response to changing demand." + }, + "ResourceId": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "The identifier of the resource associated with the scalable target. This 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 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 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. Example: ``instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0``.\n + AppStream 2.0 fleet - The resource type is ``fleet`` and the unique identifier is the fleet name. Example: ``fleet/sample-fleet``.\n + DynamoDB table - The resource type is ``table`` and the unique identifier is the table name. Example: ``table/my-table``.\n + DynamoDB global secondary index - The resource type is ``index`` and the unique identifier is the index name. 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. Example: ``cluster:my-db-cluster``.\n + SageMaker endpoint variant - The resource type is ``variant`` and the unique identifier is the resource ID. 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 is available in our [GitHub repository](https://docs.aws.amazon.com/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``. 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. Example: ``keyspace/mykeyspace/table/mytable``.\n + Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. 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. Example: ``replication-group/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. 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. Example: ``inference-component/my-inference-component``." + }, + "RoleARN": { + "type": { + "$ref": "#/4" + }, + "flags": 4, + "description": "Specify the Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that allows Application Auto Scaling to modify the scalable target on your behalf. This can be either an IAM service role that Application Auto Scaling can assume to make calls to other AWS resources on your behalf, or a service-linked role for the specified service. For more information, see [How Application Auto Scaling works with IAM](https://docs.aws.amazon.com/autoscaling/application/userguide/security_iam_service-with-iam.html) in the *Application Auto Scaling User Guide*.\n To automatically create a service-linked role (recommended), specify the full ARN of the service-linked role in your stack template. To find the exact ARN of the service-linked role for 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 Guide*. Look for the ARN in the table at the bottom of the page." + }, + "ScalableDimension": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.\n + ``ecs:service:DesiredCount`` - The desired 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 desired 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: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." + }, + "ScheduledActions": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "The scheduled actions for the scalable target. Duplicates aren't allowed." + }, + "ServiceNamespace": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "The namespace of the AWS service that provides the resource, or a ``custom-resource``." + }, + "SuspendedState": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "An embedded object that contains attributes and attribute values that are used to suspend and resume automatic scaling. Setting the value of an attribute to ``true`` suspends the specified scaling activities. Setting it to ``false`` (default) resumes the specified scaling activities. \n *Suspension Outcomes* \n + For ``DynamicScalingInSuspended``, while a suspension is in effect, all scale-in activities that are triggered by a scaling policy are suspended.\n + For ``DynamicScalingOutSuspended``, while a suspension is in effect, all scale-out activities that are triggered by a scaling policy are suspended.\n + For ``ScheduledScalingSuspended``, while a suspension is in effect, all scaling activities that involve scheduled actions are suspended." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ApplicationAutoScaling/ScalableTarget", + "properties": { + "name": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/8" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ApplicationAutoScaling/ScalableTarget@default", + "scopeType": 0, + "body": { + "$ref": "#/9" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "CustomizedMetricSpecification", + "properties": { + "Dimensions": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "The dimensions of the metric." + }, + "MetricName": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The name of the metric. To get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics." + }, + "Metrics": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "The metrics to include in the target tracking scaling policy, as a metric data query. This can include both raw metric and metric math expressions." + }, + "Namespace": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The namespace of the metric." + }, + "Statistic": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The statistic of the metric." + }, + "Unit": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The unit of the metric. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference." + } + } + }, + { + "$type": "ObjectType", + "name": "MetricDimension", + "properties": { + "Name": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The name of the dimension." + }, + "Value": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The value of the dimension." + } + } + }, + { + "$type": "ObjectType", + "name": "PredefinedMetricSpecification", + "properties": { + "PredefinedMetricType": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The metric type. The ALBRequestCountPerTarget metric type applies only to Spot Fleets and ECS services." + }, + "ResourceLabel": { + "type": { + "$ref": "#/4" + }, + "flags": 4, + "description": "Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group attached to the Spot Fleet or ECS service." + } + } + }, + { + "$type": "ObjectType", + "name": "StepAdjustment", + "properties": { + "MetricIntervalLowerBound": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity." + }, + "MetricIntervalUpperBound": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity." + }, + "ScalingAdjustment": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity. For exact capacity, you must specify a positive value." + } + } + }, + { + "$type": "ObjectType", + "name": "StepScalingPolicyConfiguration", + "properties": { + "AdjustmentType": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Specifies how the ScalingAdjustment value in a StepAdjustment is interpreted." + }, + "Cooldown": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The amount of time, in seconds, to wait for a previous scaling activity to take effect." + }, + "MetricAggregationType": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The aggregation type for the CloudWatch metrics. Valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average" + }, + "MinAdjustmentMagnitude": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The minimum value to scale by when the adjustment type is PercentChangeInCapacity." + }, + "StepAdjustments": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "A set of adjustments that enable you to scale based on the size of the alarm breach." + } + } + }, + { + "$type": "ObjectType", + "name": "TargetTrackingMetric", + "properties": { + "Dimensions": { + "type": { + "$ref": "#/24" + }, + "flags": 0, + "description": "The dimensions for the metric." + }, + "MetricName": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The name of the metric." + }, + "Namespace": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The namespace of the metric." + } + } + }, + { + "$type": "ObjectType", + "name": "TargetTrackingMetricDataQuery", + "properties": { + "Expression": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The math expression to perform on the returned data, if this object is performing a math expression." + }, + "Id": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "A short name that identifies the object's results in the response." + }, + "Label": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "A human-readable label for this metric or expression. This is especially useful if this is a math expression, so that you know what the value represents." + }, + "MetricStat": { + "type": { + "$ref": "#/19" + }, + "flags": 0, + "description": "Information about the metric data to return." + }, + "ReturnData": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "Indicates whether to return the timestamps and raw data values of this metric." + } + } + }, + { + "$type": "ObjectType", + "name": "TargetTrackingMetricDimension", + "properties": { + "Name": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The name of the dimension." + }, + "Value": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The value of the dimension." + } + } + }, + { + "$type": "ObjectType", + "name": "TargetTrackingMetricStat", + "properties": { + "Metric": { + "type": { + "$ref": "#/16" + }, + "flags": 0, + "description": "The CloudWatch metric to return, including the metric name, namespace, and dimensions. " + }, + "Stat": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The statistic to return. It can include any CloudWatch statistic or extended statistic." + }, + "Unit": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The unit to use for the returned data points." + } + } + }, + { + "$type": "ObjectType", + "name": "TargetTrackingScalingPolicyConfiguration", + "properties": { + "CustomizedMetricSpecification": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "A customized metric. You can specify either a predefined metric or a customized metric." + }, + "DisableScaleIn": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true, scale in is disabled and the target tracking scaling policy won't remove capacity from the scalable target. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable target. The default value is false." + }, + "PredefinedMetricSpecification": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "A predefined metric. You can specify either a predefined metric or a customized metric." + }, + "ScaleInCooldown": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start." + }, + "ScaleOutCooldown": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The amount of time, in seconds, to wait for a previous scale-out activity to take effect." + }, + "TargetValue": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The target value for the metric. Although this property accepts numbers of type Double, it won't accept values that are either too small or too large. Values must be in the range of -2^360 to 2^360. The value must be a valid number based on the choice of metric. For example, if the metric is CPU utilization, then the target value is a percent value that represents how much of the CPU can be used before scaling out." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/12" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/17" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/14" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/18" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.ApplicationAutoScaling/ScalingPolicyProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.ApplicationAutoScaling/ScalingPolicyProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/4" + }, + "flags": 18, + "description": "ARN is a read only property for the resource." + }, + "PolicyName": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The name of the scaling policy.\n\nUpdates to the name of a target tracking scaling policy are not supported, unless you also update the metric used for scaling. To change only a target tracking scaling policy's name, first delete the policy by removing the existing AWS::ApplicationAutoScaling::ScalingPolicy resource from the template and updating the stack. Then, recreate the resource with the same settings and a different name." + }, + "PolicyType": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The scaling policy type.\n\nThe following policy types are supported:\n\nTargetTrackingScaling Not supported for Amazon EMR\n\nStepScaling Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or Neptune." + }, + "ResourceId": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier." + }, + "ScalableDimension": { + "type": { + "$ref": "#/4" + }, + "flags": 16, + "description": "The scalable dimension. This string consists of the service namespace, resource type, and scaling property." + }, + "ScalingTargetId": { + "type": { + "$ref": "#/4" + }, + "flags": 4, + "description": "The CloudFormation-generated ID of an Application Auto Scaling scalable target. For more information about the ID, see the Return Value section of the AWS::ApplicationAutoScaling::ScalableTarget resource." + }, + "ServiceNamespace": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The namespace of the AWS service that provides the resource, or a custom-resource." + }, + "StepScalingPolicyConfiguration": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "A step scaling policy." + }, + "TargetTrackingScalingPolicyConfiguration": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "A target tracking scaling policy." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ApplicationAutoScaling/ScalingPolicy", + "properties": { + "name": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/26" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ApplicationAutoScaling/ScalingPolicy@default", + "scopeType": 0, + "body": { + "$ref": "#/27" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.applicationautoscaling/default/types.md b/artifacts/bicep/aws/aws.applicationautoscaling/default/types.md index 9c82ef5f..66bfde24 100644 --- a/artifacts/bicep/aws/aws.applicationautoscaling/default/types.md +++ b/artifacts/bicep/aws/aws.applicationautoscaling/default/types.md @@ -3,48 +3,73 @@ ## Resource AWS.ApplicationAutoScaling/ScalableTarget@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ApplicationAutoScaling/ScalableTargetProperties](#awsapplicationautoscalingscalabletargetproperties) (Required): properties of the resource +* **properties**: [AWS.ApplicationAutoScaling/ScalableTargetProperties](#awsapplicationautoscalingscalabletargetproperties) (Required, Identifier): properties of the resource ## Resource AWS.ApplicationAutoScaling/ScalingPolicy@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ApplicationAutoScaling/ScalingPolicyProperties](#awsapplicationautoscalingscalingpolicyproperties) (Required): properties of the resource +* **properties**: [AWS.ApplicationAutoScaling/ScalingPolicyProperties](#awsapplicationautoscalingscalingpolicyproperties) (Required, Identifier): properties of the resource ## AWS.ApplicationAutoScaling/ScalableTargetProperties ### Properties -* **Id**: string (ReadOnly): This value can be returned by using the Ref function. Ref returns the Cloudformation generated ID of the resource in format - ResourceId|ScalableDimension|ServiceNamespace -* **MaxCapacity**: int (Required): The maximum value that you plan to scale in to. When a scaling policy is in effect, Application Auto Scaling can scale in (contract) as needed to the minimum capacity limit in response to changing demand -* **MinCapacity**: int (Required): The minimum value that you plan to scale in to. When a scaling policy is in effect, Application Auto Scaling can scale in (contract) as needed to the minimum capacity limit in response to changing demand -* **ResourceId**: string (Required, Identifier): The identifier of the resource associated with the scalable target -* **RoleARN**: string (WriteOnly): Specify the Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that allows Application Auto Scaling to modify the scalable target on your behalf. -* **ScalableDimension**: string (Required, Identifier): The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property +* **Id**: string (ReadOnly) +* **MaxCapacity**: int (Required): The maximum value that you plan to scale out to. When a scaling policy is in effect, Application Auto Scaling can scale out (expand) as needed to the maximum capacity limit in response to changing demand. +* **MinCapacity**: int (Required): The minimum value that you plan to scale in to. When a scaling policy is in effect, Application Auto Scaling can scale in (contract) as needed to the minimum capacity limit in response to changing demand. +* **ResourceId**: string (Required, Identifier): The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier. + + ECS service - The resource type is ``service`` and the unique identifier is the cluster name and service name. Example: ``service/my-cluster/my-service``. + + Spot Fleet - The resource type is ``spot-fleet-request`` and the unique identifier is the Spot Fleet request ID. Example: ``spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE``. + + EMR cluster - The resource type is ``instancegroup`` and the unique identifier is the cluster ID and instance group ID. Example: ``instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0``. + + AppStream 2.0 fleet - The resource type is ``fleet`` and the unique identifier is the fleet name. Example: ``fleet/sample-fleet``. + + DynamoDB table - The resource type is ``table`` and the unique identifier is the table name. Example: ``table/my-table``. + + DynamoDB global secondary index - The resource type is ``index`` and the unique identifier is the index name. Example: ``table/my-table/index/my-table-index``. + + Aurora DB cluster - The resource type is ``cluster`` and the unique identifier is the cluster name. Example: ``cluster:my-db-cluster``. + + SageMaker endpoint variant - The resource type is ``variant`` and the unique identifier is the resource ID. Example: ``endpoint/my-end-point/variant/KMeansClustering``. + + 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 is available in our [GitHub repository](https://docs.aws.amazon.com/https://github.com/aws/aws-auto-scaling-custom-resource). + + 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``. + + 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``. + + 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``. Example: ``function:my-function:prod`` or ``function:my-function:1``. + + Amazon Keyspaces table - The resource type is ``table`` and the unique identifier is the table name. Example: ``keyspace/mykeyspace/table/mytable``. + + Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: ``arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5``. + + Amazon ElastiCache replication group - The resource type is ``replication-group`` and the unique identifier is the replication group name. Example: ``replication-group/mycluster``. + + Neptune cluster - The resource type is ``cluster`` and the unique identifier is the cluster name. Example: ``cluster:mycluster``. + + SageMaker serverless endpoint - The resource type is ``variant`` and the unique identifier is the resource ID. Example: ``endpoint/my-end-point/variant/KMeansClustering``. + + SageMaker inference component - The resource type is ``inference-component`` and the unique identifier is the resource ID. Example: ``inference-component/my-inference-component``. +* **RoleARN**: string (WriteOnly): Specify the Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that allows Application Auto Scaling to modify the scalable target on your behalf. This can be either an IAM service role that Application Auto Scaling can assume to make calls to other AWS resources on your behalf, or a service-linked role for the specified service. For more information, see [How Application Auto Scaling works with IAM](https://docs.aws.amazon.com/autoscaling/application/userguide/security_iam_service-with-iam.html) in the *Application Auto Scaling User Guide*. + To automatically create a service-linked role (recommended), specify the full ARN of the service-linked role in your stack template. To find the exact ARN of the service-linked role for 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 Guide*. Look for the ARN in the table at the bottom of the page. +* **ScalableDimension**: string (Required, Identifier): The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property. + + ``ecs:service:DesiredCount`` - The desired task count of an ECS service. + + ``elasticmapreduce:instancegroup:InstanceCount`` - The instance count of an EMR Instance Group. + + ``ec2:spot-fleet-request:TargetCapacity`` - The target capacity of a Spot Fleet. + + ``appstream:fleet:DesiredCapacity`` - The desired capacity of an AppStream 2.0 fleet. + + ``dynamodb:table:ReadCapacityUnits`` - The provisioned read capacity for a DynamoDB table. + + ``dynamodb:table:WriteCapacityUnits`` - The provisioned write capacity for a DynamoDB table. + + ``dynamodb:index:ReadCapacityUnits`` - The provisioned read capacity for a DynamoDB global secondary index. + + ``dynamodb:index:WriteCapacityUnits`` - The provisioned write capacity for a DynamoDB global secondary index. + + ``rds:cluster:ReadReplicaCount`` - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition. + + ``sagemaker:variant:DesiredInstanceCount`` - The number of EC2 instances for a SageMaker model endpoint variant. + + ``custom-resource:ResourceType:Property`` - The scalable dimension for a custom resource provided by your own application or service. + + ``comprehend:document-classifier-endpoint:DesiredInferenceUnits`` - The number of inference units for an Amazon Comprehend document classification endpoint. + + ``comprehend:entity-recognizer-endpoint:DesiredInferenceUnits`` - The number of inference units for an Amazon Comprehend entity recognizer endpoint. + + ``lambda:function:ProvisionedConcurrency`` - The provisioned concurrency for a Lambda function. + + ``cassandra:table:ReadCapacityUnits`` - The provisioned read capacity for an Amazon Keyspaces table. + + ``cassandra:table:WriteCapacityUnits`` - The provisioned write capacity for an Amazon Keyspaces table. + + ``kafka:broker-storage:VolumeSize`` - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster. + + ``elasticache:replication-group:NodeGroups`` - The number of node groups for an Amazon ElastiCache replication group. + + ``elasticache:replication-group:Replicas`` - The number of replicas per node group for an Amazon ElastiCache replication group. + + ``neptune:cluster:ReadReplicaCount`` - The count of read replicas in an Amazon Neptune DB cluster. + + ``sagemaker:variant:DesiredProvisionedConcurrency`` - The provisioned concurrency for a SageMaker serverless endpoint. + + ``sagemaker:inference-component:DesiredCopyCount`` - The number of copies across an endpoint for a SageMaker inference component. * **ScheduledActions**: [ScheduledAction](#scheduledaction)[]: The scheduled actions for the scalable target. Duplicates aren't allowed. -* **ServiceNamespace**: string (Required, Identifier): The namespace of the AWS service that provides the resource, or a custom-resource -* **SuspendedState**: [SuspendedState](#suspendedstate): An embedded object that contains attributes and attribute values that are used to suspend and resume automatic scaling. Setting the value of an attribute to true suspends the specified scaling activities. Setting it to false (default) resumes the specified scaling activities. - -## ScheduledAction -### Properties -* **EndTime**: string -* **ScalableTargetAction**: [ScalableTargetAction](#scalabletargetaction) -* **Schedule**: string (Required) -* **ScheduledActionName**: string (Required) -* **StartTime**: string -* **Timezone**: string - -## ScalableTargetAction -### Properties -* **MaxCapacity**: int -* **MinCapacity**: int - -## SuspendedState -### Properties -* **DynamicScalingInSuspended**: bool -* **DynamicScalingOutSuspended**: bool -* **ScheduledScalingSuspended**: bool +* **ServiceNamespace**: string (Required, Identifier): The namespace of the AWS service that provides the resource, or a ``custom-resource``. +* **SuspendedState**: [SuspendedState](#suspendedstate): An embedded object that contains attributes and attribute values that are used to suspend and resume automatic scaling. Setting the value of an attribute to ``true`` suspends the specified scaling activities. Setting it to ``false`` (default) resumes the specified scaling activities. + *Suspension Outcomes* + + For ``DynamicScalingInSuspended``, while a suspension is in effect, all scale-in activities that are triggered by a scaling policy are suspended. + + For ``DynamicScalingOutSuspended``, while a suspension is in effect, all scale-out activities that are triggered by a scaling policy are suspended. + + For ``ScheduledScalingSuspended``, while a suspension is in effect, all scaling activities that involve scheduled actions are suspended. ## AWS.ApplicationAutoScaling/ScalingPolicyProperties ### Properties @@ -66,29 +91,6 @@ StepScaling Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspa * **StepScalingPolicyConfiguration**: [StepScalingPolicyConfiguration](#stepscalingpolicyconfiguration): A step scaling policy. * **TargetTrackingScalingPolicyConfiguration**: [TargetTrackingScalingPolicyConfiguration](#targettrackingscalingpolicyconfiguration): A target tracking scaling policy. -## StepScalingPolicyConfiguration -### Properties -* **AdjustmentType**: string: Specifies how the ScalingAdjustment value in a StepAdjustment is interpreted. -* **Cooldown**: int: The amount of time, in seconds, to wait for a previous scaling activity to take effect. -* **MetricAggregationType**: string: The aggregation type for the CloudWatch metrics. Valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average -* **MinAdjustmentMagnitude**: int: The minimum value to scale by when the adjustment type is PercentChangeInCapacity. -* **StepAdjustments**: [StepAdjustment](#stepadjustment)[]: A set of adjustments that enable you to scale based on the size of the alarm breach. - -## StepAdjustment -### Properties -* **MetricIntervalLowerBound**: int: The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity. -* **MetricIntervalUpperBound**: int: The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity. -* **ScalingAdjustment**: int (Required): The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity. For exact capacity, you must specify a positive value. - -## TargetTrackingScalingPolicyConfiguration -### Properties -* **CustomizedMetricSpecification**: [CustomizedMetricSpecification](#customizedmetricspecification): A customized metric. You can specify either a predefined metric or a customized metric. -* **DisableScaleIn**: bool: Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true, scale in is disabled and the target tracking scaling policy won't remove capacity from the scalable target. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable target. The default value is false. -* **PredefinedMetricSpecification**: [PredefinedMetricSpecification](#predefinedmetricspecification): A predefined metric. You can specify either a predefined metric or a customized metric. -* **ScaleInCooldown**: int: The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start. -* **ScaleOutCooldown**: int: The amount of time, in seconds, to wait for a previous scale-out activity to take effect. -* **TargetValue**: int (Required): The target value for the metric. Although this property accepts numbers of type Double, it won't accept values that are either too small or too large. Values must be in the range of -2^360 to 2^360. The value must be a valid number based on the choice of metric. For example, if the metric is CPU utilization, then the target value is a percent value that represents how much of the CPU can be used before scaling out. - ## CustomizedMetricSpecification ### Properties * **Dimensions**: [MetricDimension](#metricdimension)[]: The dimensions of the metric. @@ -103,19 +105,52 @@ StepScaling Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspa * **Name**: string (Required): The name of the dimension. * **Value**: string (Required): The value of the dimension. -## TargetTrackingMetricDataQuery +## PredefinedMetricSpecification ### Properties -* **Expression**: string: The math expression to perform on the returned data, if this object is performing a math expression. -* **Id**: string: A short name that identifies the object's results in the response. -* **Label**: string: A human-readable label for this metric or expression. This is especially useful if this is a math expression, so that you know what the value represents. -* **MetricStat**: [TargetTrackingMetricStat](#targettrackingmetricstat): Information about the metric data to return. -* **ReturnData**: bool: Indicates whether to return the timestamps and raw data values of this metric. +* **PredefinedMetricType**: string (Required): The metric type. The ALBRequestCountPerTarget metric type applies only to Spot Fleets and ECS services. +* **ResourceLabel**: string (WriteOnly): Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group attached to the Spot Fleet or ECS service. -## TargetTrackingMetricStat +## ScalableTargetAction ### Properties -* **Metric**: [TargetTrackingMetric](#targettrackingmetric): The CloudWatch metric to return, including the metric name, namespace, and dimensions. -* **Stat**: string: The statistic to return. It can include any CloudWatch statistic or extended statistic. -* **Unit**: string: The unit to use for the returned data points. +* **MaxCapacity**: int: The maximum capacity. +* **MinCapacity**: int: The minimum capacity. + +## ScheduledAction +### Properties +* **EndTime**: string: The date and time that the action is scheduled to end, in UTC. +* **ScalableTargetAction**: [ScalableTargetAction](#scalabletargetaction): The new minimum and maximum capacity. You can set both values or just one. At the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity. +* **Schedule**: string (Required): The schedule for this action. The following formats are supported: + + At expressions - "``at(yyyy-mm-ddThh:mm:ss)``" + + Rate expressions - "``rate(value unit)``" + + Cron expressions - "``cron(fields)``" + + At expressions are useful for one-time schedules. Cron expressions are useful for scheduled actions that run periodically at a specified date and time, and rate expressions are useful for scheduled actions that run at a regular interval. + At and cron expressions use Universal Coordinated Time (UTC) by default. + The cron format consists of six fields separated by white spaces: [Minutes] [Hours] [Day_of_Month] [Month] [Day_of_Week] [Year]. + For rate expressions, *value* is a positive integer and *unit* is ``minute`` | ``minutes`` | ``hour`` | ``hours`` | ``day`` | ``days``. +* **ScheduledActionName**: string (Required): The name of the scheduled action. This name must be unique among all other scheduled actions on the specified scalable target. +* **StartTime**: string: The date and time that the action is scheduled to begin, in UTC. +* **Timezone**: string: The time zone used when referring to the date and time of a scheduled action, when the scheduled action uses an at or cron expression. + +## StepAdjustment +### Properties +* **MetricIntervalLowerBound**: int: The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity. +* **MetricIntervalUpperBound**: int: The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity. +* **ScalingAdjustment**: int (Required): The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity. For exact capacity, you must specify a positive value. + +## StepScalingPolicyConfiguration +### Properties +* **AdjustmentType**: string: Specifies how the ScalingAdjustment value in a StepAdjustment is interpreted. +* **Cooldown**: int: The amount of time, in seconds, to wait for a previous scaling activity to take effect. +* **MetricAggregationType**: string: The aggregation type for the CloudWatch metrics. Valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average +* **MinAdjustmentMagnitude**: int: The minimum value to scale by when the adjustment type is PercentChangeInCapacity. +* **StepAdjustments**: [StepAdjustment](#stepadjustment)[]: A set of adjustments that enable you to scale based on the size of the alarm breach. + +## SuspendedState +### Properties +* **DynamicScalingInSuspended**: bool: Whether scale in by a target tracking scaling policy or a step scaling policy is suspended. Set the value to ``true`` if you don't want Application Auto Scaling to remove capacity when a scaling policy is triggered. The default is ``false``. +* **DynamicScalingOutSuspended**: bool: Whether scale out by a target tracking scaling policy or a step scaling policy is suspended. Set the value to ``true`` if you don't want Application Auto Scaling to add capacity when a scaling policy is triggered. The default is ``false``. +* **ScheduledScalingSuspended**: bool: Whether scheduled scaling is suspended. Set the value to ``true`` if you don't want Application Auto Scaling to add or remove capacity by initiating scheduled actions. The default is ``false``. ## TargetTrackingMetric ### Properties @@ -123,13 +158,31 @@ StepScaling Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspa * **MetricName**: string: The name of the metric. * **Namespace**: string: The namespace of the metric. +## TargetTrackingMetricDataQuery +### Properties +* **Expression**: string: The math expression to perform on the returned data, if this object is performing a math expression. +* **Id**: string: A short name that identifies the object's results in the response. +* **Label**: string: A human-readable label for this metric or expression. This is especially useful if this is a math expression, so that you know what the value represents. +* **MetricStat**: [TargetTrackingMetricStat](#targettrackingmetricstat): Information about the metric data to return. +* **ReturnData**: bool: Indicates whether to return the timestamps and raw data values of this metric. + ## TargetTrackingMetricDimension ### Properties * **Name**: string: The name of the dimension. * **Value**: string: The value of the dimension. -## PredefinedMetricSpecification +## TargetTrackingMetricStat ### Properties -* **PredefinedMetricType**: string (Required): The metric type. The ALBRequestCountPerTarget metric type applies only to Spot Fleets and ECS services. -* **ResourceLabel**: string (WriteOnly): Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group attached to the Spot Fleet or ECS service. +* **Metric**: [TargetTrackingMetric](#targettrackingmetric): The CloudWatch metric to return, including the metric name, namespace, and dimensions. +* **Stat**: string: The statistic to return. It can include any CloudWatch statistic or extended statistic. +* **Unit**: string: The unit to use for the returned data points. + +## TargetTrackingScalingPolicyConfiguration +### Properties +* **CustomizedMetricSpecification**: [CustomizedMetricSpecification](#customizedmetricspecification): A customized metric. You can specify either a predefined metric or a customized metric. +* **DisableScaleIn**: bool: Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true, scale in is disabled and the target tracking scaling policy won't remove capacity from the scalable target. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable target. The default value is false. +* **PredefinedMetricSpecification**: [PredefinedMetricSpecification](#predefinedmetricspecification): A predefined metric. You can specify either a predefined metric or a customized metric. +* **ScaleInCooldown**: int: The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start. +* **ScaleOutCooldown**: int: The amount of time, in seconds, to wait for a previous scale-out activity to take effect. +* **TargetValue**: int (Required): The target value for the metric. Although this property accepts numbers of type Double, it won't accept values that are either too small or too large. Values must be in the range of -2^360 to 2^360. The value must be a valid number based on the choice of metric. For example, if the metric is CPU utilization, then the target value is a percent value that represents how much of the CPU can be used before scaling out. diff --git a/artifacts/bicep/aws/aws.applicationinsights/default/types.json b/artifacts/bicep/aws/aws.applicationinsights/default/types.json index 0f3e0e45..d309fe28 100644 --- a/artifacts/bicep/aws/aws.applicationinsights/default/types.json +++ b/artifacts/bicep/aws/aws.applicationinsights/default/types.json @@ -1 +1,801 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"Alarm","Properties":{"AlarmName":{"Type":4,"Flags":1,"Description":"The name of the CloudWatch alarm to be monitored for the component."},"Severity":{"Type":4,"Flags":0,"Description":"Indicates the degree of outage when the alarm goes off."}}}},{"2":{"Name":"AlarmMetric","Properties":{"AlarmMetricName":{"Type":4,"Flags":1,"Description":"The name of the metric to be monitored for the component."}}}},{"2":{"Name":"ComponentConfiguration","Properties":{"ConfigurationDetails":{"Type":12,"Flags":0,"Description":"The configuration settings"},"SubComponentTypeConfigurations":{"Type":25,"Flags":0,"Description":"Sub component configurations of the component."}}}},{"2":{"Name":"ComponentMonitoringSetting","Properties":{"ComponentARN":{"Type":4,"Flags":0,"Description":"The ARN of the compnonent."},"ComponentConfigurationMode":{"Type":4,"Flags":1,"Description":"The component monitoring configuration mode."},"ComponentName":{"Type":4,"Flags":0,"Description":"The name of the component."},"CustomComponentConfiguration":{"Type":10,"Flags":0,"Description":"The monitoring configuration of the component."},"DefaultOverwriteComponentConfiguration":{"Type":10,"Flags":0,"Description":"The overwritten settings on default component monitoring configuration."},"Tier":{"Type":4,"Flags":1,"Description":"The tier of the application component."}}}},{"2":{"Name":"ConfigurationDetails","Properties":{"AlarmMetrics":{"Type":26,"Flags":0,"Description":"A list of metrics to monitor for the component."},"Alarms":{"Type":27,"Flags":0,"Description":"A list of alarms to monitor for the component."},"HAClusterPrometheusExporter":{"Type":15,"Flags":0,"Description":"The HA cluster Prometheus Exporter settings."},"HANAPrometheusExporter":{"Type":16,"Flags":0,"Description":"The HANA DB Prometheus Exporter settings."},"JMXPrometheusExporter":{"Type":17,"Flags":0,"Description":"The JMX Prometheus Exporter settings."},"Logs":{"Type":28,"Flags":0,"Description":"A list of logs to monitor for the component."},"WindowsEvents":{"Type":29,"Flags":0,"Description":"A list of Windows Events to log."}}}},{"2":{"Name":"CustomComponent","Properties":{"ComponentName":{"Type":4,"Flags":1,"Description":"The name of the component."},"ResourceList":{"Type":30,"Flags":1,"Description":"The list of resource ARNs that belong to the component."}}}},{"2":{"Name":"EventLevel"}},{"2":{"Name":"HAClusterPrometheusExporter","Properties":{"PrometheusPort":{"Type":4,"Flags":0,"Description":"Prometheus exporter port."}}}},{"2":{"Name":"HANAPrometheusExporter","Properties":{"AgreeToInstallHANADBClient":{"Type":2,"Flags":1,"Description":"A flag which indicates agreeing to install SAP HANA DB client."},"HANAPort":{"Type":4,"Flags":1,"Description":"The HANA DB port."},"HANASID":{"Type":4,"Flags":1,"Description":"HANA DB SID."},"HANASecretName":{"Type":4,"Flags":1,"Description":"The secret name which manages the HANA DB credentials e.g. {\n \"username\": \"<>\",\n \"password\": \"<>\"\n}."},"PrometheusPort":{"Type":4,"Flags":0,"Description":"Prometheus exporter port."}}}},{"2":{"Name":"JMXPrometheusExporter","Properties":{"HostPort":{"Type":4,"Flags":0,"Description":"Java agent host port"},"JMXURL":{"Type":4,"Flags":0,"Description":"JMX service URL."},"PrometheusPort":{"Type":4,"Flags":0,"Description":"Prometheus exporter port."}}}},{"2":{"Name":"Log","Properties":{"Encoding":{"Type":4,"Flags":0,"Description":"The type of encoding of the logs to be monitored."},"LogGroupName":{"Type":4,"Flags":0,"Description":"The CloudWatch log group name to be associated to the monitored log."},"LogPath":{"Type":4,"Flags":0,"Description":"The path of the logs to be monitored."},"LogType":{"Type":4,"Flags":1,"Description":"The log type decides the log patterns against which Application Insights analyzes the log."},"PatternSet":{"Type":4,"Flags":0,"Description":"The name of the log pattern set."}}}},{"2":{"Name":"LogPattern","Properties":{"Pattern":{"Type":4,"Flags":1,"Description":"The log pattern."},"PatternName":{"Type":4,"Flags":1,"Description":"The name of the log pattern."},"Rank":{"Type":3,"Flags":1,"Description":"Rank of the log pattern."}}}},{"2":{"Name":"LogPatternSet","Properties":{"LogPatterns":{"Type":31,"Flags":1,"Description":"The log patterns of a set."},"PatternSetName":{"Type":4,"Flags":1,"Description":"The name of the log pattern set."}}}},{"2":{"Name":"SubComponentConfigurationDetails","Properties":{"AlarmMetrics":{"Type":32,"Flags":0,"Description":"A list of metrics to monitor for the component."},"Logs":{"Type":33,"Flags":0,"Description":"A list of logs to monitor for the component."},"WindowsEvents":{"Type":34,"Flags":0,"Description":"A list of Windows Events to log."}}}},{"2":{"Name":"SubComponentTypeConfiguration","Properties":{"SubComponentConfigurationDetails":{"Type":21,"Flags":1,"Description":"The configuration settings of sub components."},"SubComponentType":{"Type":4,"Flags":1,"Description":"The sub component type."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}}}},{"2":{"Name":"WindowsEvent","Properties":{"EventLevels":{"Type":35,"Flags":1,"Description":"The levels of event to log. "},"EventName":{"Type":4,"Flags":1,"Description":"The type of Windows Events to log."},"LogGroupName":{"Type":4,"Flags":1,"Description":"The CloudWatch log group name to be associated to the monitored log."},"PatternSet":{"Type":4,"Flags":0,"Description":"The name of the log pattern set."}}}},{"3":{"ItemType":22}},{"3":{"ItemType":9}},{"3":{"ItemType":8}},{"3":{"ItemType":18}},{"3":{"ItemType":24}},{"3":{"ItemType":4}},{"3":{"ItemType":19}},{"3":{"ItemType":9}},{"3":{"ItemType":18}},{"3":{"ItemType":24}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.ApplicationInsights/ApplicationProperties","Properties":{"ApplicationARN":{"Type":4,"Flags":18,"Description":"The ARN of the ApplicationInsights application."},"AutoConfigurationEnabled":{"Type":2,"Flags":0,"Description":"If set to true, application will be configured with recommended monitoring configuration."},"CWEMonitorEnabled":{"Type":2,"Flags":0,"Description":"Indicates whether Application Insights can listen to CloudWatch events for the application resources."},"ComponentMonitoringSettings":{"Type":37,"Flags":4,"Description":"The monitoring settings of the components."},"CustomComponents":{"Type":38,"Flags":4,"Description":"The custom grouped components."},"GroupingType":{"Type":4,"Flags":4,"Description":"The grouping type of the application"},"LogPatternSets":{"Type":39,"Flags":4,"Description":"The log pattern sets."},"OpsCenterEnabled":{"Type":2,"Flags":0,"Description":"When set to true, creates opsItems for any problems detected on an application."},"OpsItemSNSTopicArn":{"Type":4,"Flags":4,"Description":"The SNS topic provided to Application Insights that is associated to the created opsItem."},"ResourceGroupName":{"Type":4,"Flags":1,"Description":"The name of the resource group."},"Tags":{"Type":40,"Flags":0,"Description":"The tags of Application Insights application."}}}},{"3":{"ItemType":11}},{"3":{"ItemType":13}},{"3":{"ItemType":20}},{"3":{"ItemType":23}},{"2":{"Name":"AWS.ApplicationInsights/Application","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":36,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ApplicationInsights/Application@default","ScopeType":0,"Body":41}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Alarm", + "properties": { + "AlarmName": { + "type": { + "$ref": "#/20" + }, + "flags": 1, + "description": "The name of the CloudWatch alarm to be monitored for the component." + }, + "Severity": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "Indicates the degree of outage when the alarm goes off." + } + } + }, + { + "$type": "ObjectType", + "name": "AlarmMetric", + "properties": { + "AlarmMetricName": { + "type": { + "$ref": "#/20" + }, + "flags": 1, + "description": "The name of the metric to be monitored for the component." + } + } + }, + { + "$type": "ObjectType", + "name": "ComponentConfiguration", + "properties": { + "ConfigurationDetails": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The configuration settings" + }, + "SubComponentTypeConfigurations": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "Sub component configurations of the component." + } + } + }, + { + "$type": "ObjectType", + "name": "ComponentMonitoringSetting", + "properties": { + "ComponentARN": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "The ARN of the compnonent." + }, + "ComponentConfigurationMode": { + "type": { + "$ref": "#/20" + }, + "flags": 1, + "description": "The component monitoring configuration mode." + }, + "ComponentName": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "The name of the component." + }, + "CustomComponentConfiguration": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The monitoring configuration of the component." + }, + "DefaultOverwriteComponentConfiguration": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The overwritten settings on default component monitoring configuration." + }, + "Tier": { + "type": { + "$ref": "#/20" + }, + "flags": 1, + "description": "The tier of the application component." + } + } + }, + { + "$type": "ObjectType", + "name": "ConfigurationDetails", + "properties": { + "AlarmMetrics": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "A list of metrics to monitor for the component." + }, + "Alarms": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "A list of alarms to monitor for the component." + }, + "HAClusterPrometheusExporter": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "The HA cluster Prometheus Exporter settings." + }, + "HANAPrometheusExporter": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The HANA DB Prometheus Exporter settings." + }, + "JMXPrometheusExporter": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "The JMX Prometheus Exporter settings." + }, + "Logs": { + "type": { + "$ref": "#/24" + }, + "flags": 0, + "description": "A list of logs to monitor for the component." + }, + "NetWeaverPrometheusExporter": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "The NetWeaver Prometheus Exporter settings." + }, + "Processes": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "A list of processes to monitor for the component. Only Windows EC2 instances can have a processes section." + }, + "SQLServerPrometheusExporter": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "The SQL Prometheus Exporter settings." + }, + "WindowsEvents": { + "type": { + "$ref": "#/26" + }, + "flags": 0, + "description": "A list of Windows Events to log." + } + } + }, + { + "$type": "ObjectType", + "name": "CustomComponent", + "properties": { + "ComponentName": { + "type": { + "$ref": "#/20" + }, + "flags": 1, + "description": "The name of the component." + }, + "ResourceList": { + "type": { + "$ref": "#/27" + }, + "flags": 1, + "description": "The list of resource ARNs that belong to the component." + } + } + }, + { + "$type": "ObjectType", + "name": "EventLevel", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "HAClusterPrometheusExporter", + "properties": { + "PrometheusPort": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "Prometheus exporter port." + } + } + }, + { + "$type": "ObjectType", + "name": "HANAPrometheusExporter", + "properties": { + "AgreeToInstallHANADBClient": { + "type": { + "$ref": "#/28" + }, + "flags": 1, + "description": "A flag which indicates agreeing to install SAP HANA DB client." + }, + "HANAPort": { + "type": { + "$ref": "#/20" + }, + "flags": 1, + "description": "The HANA DB port." + }, + "HANASID": { + "type": { + "$ref": "#/20" + }, + "flags": 1, + "description": "HANA DB SID." + }, + "HANASecretName": { + "type": { + "$ref": "#/20" + }, + "flags": 1, + "description": "The secret name which manages the HANA DB credentials e.g. {\n \"username\": \"<>\",\n \"password\": \"<>\"\n}." + }, + "PrometheusPort": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "Prometheus exporter port." + } + } + }, + { + "$type": "ObjectType", + "name": "JMXPrometheusExporter", + "properties": { + "HostPort": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "Java agent host port" + }, + "JMXURL": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "JMX service URL." + }, + "PrometheusPort": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "Prometheus exporter port." + } + } + }, + { + "$type": "ObjectType", + "name": "Log", + "properties": { + "Encoding": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "The type of encoding of the logs to be monitored." + }, + "LogGroupName": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "The CloudWatch log group name to be associated to the monitored log." + }, + "LogPath": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "The path of the logs to be monitored." + }, + "LogType": { + "type": { + "$ref": "#/20" + }, + "flags": 1, + "description": "The log type decides the log patterns against which Application Insights analyzes the log." + }, + "PatternSet": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "The name of the log pattern set." + } + } + }, + { + "$type": "ObjectType", + "name": "LogPattern", + "properties": { + "Pattern": { + "type": { + "$ref": "#/20" + }, + "flags": 1, + "description": "The log pattern." + }, + "PatternName": { + "type": { + "$ref": "#/20" + }, + "flags": 1, + "description": "The name of the log pattern." + }, + "Rank": { + "type": { + "$ref": "#/29" + }, + "flags": 1, + "description": "Rank of the log pattern." + } + } + }, + { + "$type": "ObjectType", + "name": "LogPatternSet", + "properties": { + "LogPatterns": { + "type": { + "$ref": "#/30" + }, + "flags": 1, + "description": "The log patterns of a set." + }, + "PatternSetName": { + "type": { + "$ref": "#/20" + }, + "flags": 1, + "description": "The name of the log pattern set." + } + } + }, + { + "$type": "ObjectType", + "name": "NetWeaverPrometheusExporter", + "properties": { + "InstanceNumbers": { + "type": { + "$ref": "#/31" + }, + "flags": 1, + "description": "SAP instance numbers for ASCS, ERS, and App Servers." + }, + "PrometheusPort": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "Prometheus exporter port." + }, + "SAPSID": { + "type": { + "$ref": "#/20" + }, + "flags": 1, + "description": "SAP NetWeaver SID." + } + } + }, + { + "$type": "ObjectType", + "name": "Process", + "properties": { + "AlarmMetrics": { + "type": { + "$ref": "#/32" + }, + "flags": 1, + "description": "A list of metrics to monitor for the component." + }, + "ProcessName": { + "type": { + "$ref": "#/20" + }, + "flags": 1, + "description": "The name of the process to be monitored for the component." + } + } + }, + { + "$type": "ObjectType", + "name": "SQLServerPrometheusExporter", + "properties": { + "PrometheusPort": { + "type": { + "$ref": "#/20" + }, + "flags": 1, + "description": "Prometheus exporter port." + }, + "SQLSecretName": { + "type": { + "$ref": "#/20" + }, + "flags": 1, + "description": "Secret name which managers SQL exporter connection. e.g. {\"data_source_name\": \"sqlserver://:@localhost:1433\"}" + } + } + }, + { + "$type": "ObjectType", + "name": "SubComponentConfigurationDetails", + "properties": { + "AlarmMetrics": { + "type": { + "$ref": "#/33" + }, + "flags": 0, + "description": "A list of metrics to monitor for the component." + }, + "Logs": { + "type": { + "$ref": "#/34" + }, + "flags": 0, + "description": "A list of logs to monitor for the component." + }, + "Processes": { + "type": { + "$ref": "#/35" + }, + "flags": 0, + "description": "A list of processes to monitor for the component. Only Windows EC2 instances can have a processes section." + }, + "WindowsEvents": { + "type": { + "$ref": "#/36" + }, + "flags": 0, + "description": "A list of Windows Events to log." + } + } + }, + { + "$type": "ObjectType", + "name": "SubComponentTypeConfiguration", + "properties": { + "SubComponentConfigurationDetails": { + "type": { + "$ref": "#/16" + }, + "flags": 1, + "description": "The configuration settings of sub components." + }, + "SubComponentType": { + "type": { + "$ref": "#/20" + }, + "flags": 1, + "description": "The sub component type." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/20" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + }, + "Value": { + "type": { + "$ref": "#/20" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + } + } + }, + { + "$type": "ObjectType", + "name": "WindowsEvent", + "properties": { + "EventLevels": { + "type": { + "$ref": "#/37" + }, + "flags": 1, + "description": "The levels of event to log. " + }, + "EventName": { + "type": { + "$ref": "#/20" + }, + "flags": 1, + "description": "The type of Windows Events to log." + }, + "LogGroupName": { + "type": { + "$ref": "#/20" + }, + "flags": 1, + "description": "The CloudWatch log group name to be associated to the monitored log." + }, + "PatternSet": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "The name of the log pattern set." + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/17" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/10" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/14" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/19" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/20" + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/11" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/20" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/10" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/14" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/19" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/20" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.ApplicationInsights/ApplicationProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/12" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/18" + } + }, + { + "$type": "ObjectType", + "name": "AWS.ApplicationInsights/ApplicationProperties", + "properties": { + "ApplicationARN": { + "type": { + "$ref": "#/20" + }, + "flags": 18, + "description": "The ARN of the ApplicationInsights application." + }, + "AttachMissingPermission": { + "type": { + "$ref": "#/28" + }, + "flags": 4, + "description": "If set to true, the managed policies for SSM and CW will be attached to the instance roles if they are missing" + }, + "AutoConfigurationEnabled": { + "type": { + "$ref": "#/28" + }, + "flags": 0, + "description": "If set to true, application will be configured with recommended monitoring configuration." + }, + "CWEMonitorEnabled": { + "type": { + "$ref": "#/28" + }, + "flags": 0, + "description": "Indicates whether Application Insights can listen to CloudWatch events for the application resources." + }, + "ComponentMonitoringSettings": { + "type": { + "$ref": "#/39" + }, + "flags": 4, + "description": "The monitoring settings of the components." + }, + "CustomComponents": { + "type": { + "$ref": "#/40" + }, + "flags": 4, + "description": "The custom grouped components." + }, + "GroupingType": { + "type": { + "$ref": "#/20" + }, + "flags": 4, + "description": "The grouping type of the application" + }, + "LogPatternSets": { + "type": { + "$ref": "#/41" + }, + "flags": 4, + "description": "The log pattern sets." + }, + "OpsCenterEnabled": { + "type": { + "$ref": "#/28" + }, + "flags": 0, + "description": "When set to true, creates opsItems for any problems detected on an application." + }, + "OpsItemSNSTopicArn": { + "type": { + "$ref": "#/20" + }, + "flags": 4, + "description": "The SNS topic provided to Application Insights that is associated to the created opsItem." + }, + "ResourceGroupName": { + "type": { + "$ref": "#/20" + }, + "flags": 1, + "description": "The name of the resource group." + }, + "Tags": { + "type": { + "$ref": "#/42" + }, + "flags": 0, + "description": "The tags of Application Insights application." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ApplicationInsights/Application", + "properties": { + "name": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/20" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/43" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ApplicationInsights/Application@default", + "scopeType": 0, + "body": { + "$ref": "#/44" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.applicationinsights/default/types.md b/artifacts/bicep/aws/aws.applicationinsights/default/types.md index a73e0708..da82676b 100644 --- a/artifacts/bicep/aws/aws.applicationinsights/default/types.md +++ b/artifacts/bicep/aws/aws.applicationinsights/default/types.md @@ -3,13 +3,23 @@ ## Resource AWS.ApplicationInsights/Application@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ApplicationInsights/ApplicationProperties](#awsapplicationinsightsapplicationproperties) (Required): properties of the resource +* **properties**: [AWS.ApplicationInsights/ApplicationProperties](#awsapplicationinsightsapplicationproperties) (Required, Identifier): properties of the resource + +## Alarm +### Properties +* **AlarmName**: string (Required): The name of the CloudWatch alarm to be monitored for the component. +* **Severity**: string: Indicates the degree of outage when the alarm goes off. + +## AlarmMetric +### Properties +* **AlarmMetricName**: string (Required): The name of the metric to be monitored for the component. ## AWS.ApplicationInsights/ApplicationProperties ### Properties * **ApplicationARN**: string (ReadOnly, Identifier): The ARN of the ApplicationInsights application. +* **AttachMissingPermission**: bool (WriteOnly): If set to true, the managed policies for SSM and CW will be attached to the instance roles if they are missing * **AutoConfigurationEnabled**: bool: If set to true, application will be configured with recommended monitoring configuration. * **ComponentMonitoringSettings**: [ComponentMonitoringSetting](#componentmonitoringsetting)[] (WriteOnly): The monitoring settings of the components. * **CustomComponents**: [CustomComponent](#customcomponent)[] (WriteOnly): The custom grouped components. @@ -21,6 +31,11 @@ * **ResourceGroupName**: string (Required): The name of the resource group. * **Tags**: [Tag](#tag)[]: The tags of Application Insights application. +## ComponentConfiguration +### Properties +* **ConfigurationDetails**: [ConfigurationDetails](#configurationdetails): The configuration settings +* **SubComponentTypeConfigurations**: [SubComponentTypeConfiguration](#subcomponenttypeconfiguration)[]: Sub component configurations of the component. + ## ComponentMonitoringSetting ### Properties * **ComponentARN**: string: The ARN of the compnonent. @@ -30,11 +45,6 @@ * **DefaultOverwriteComponentConfiguration**: [ComponentConfiguration](#componentconfiguration): The overwritten settings on default component monitoring configuration. * **Tier**: string (Required): The tier of the application component. -## ComponentConfiguration -### Properties -* **ConfigurationDetails**: [ConfigurationDetails](#configurationdetails): The configuration settings -* **SubComponentTypeConfigurations**: [SubComponentTypeConfiguration](#subcomponenttypeconfiguration)[]: Sub component configurations of the component. - ## ConfigurationDetails ### Properties * **AlarmMetrics**: [AlarmMetric](#alarmmetric)[]: A list of metrics to monitor for the component. @@ -43,16 +53,15 @@ * **HANAPrometheusExporter**: [HANAPrometheusExporter](#hanaprometheusexporter): The HANA DB Prometheus Exporter settings. * **JMXPrometheusExporter**: [JMXPrometheusExporter](#jmxprometheusexporter): The JMX Prometheus Exporter settings. * **Logs**: [Log](#log)[]: A list of logs to monitor for the component. +* **NetWeaverPrometheusExporter**: [NetWeaverPrometheusExporter](#netweaverprometheusexporter): The NetWeaver Prometheus Exporter settings. +* **Processes**: [Process](#process)[]: A list of processes to monitor for the component. Only Windows EC2 instances can have a processes section. +* **SQLServerPrometheusExporter**: [SQLServerPrometheusExporter](#sqlserverprometheusexporter): The SQL Prometheus Exporter settings. * **WindowsEvents**: [WindowsEvent](#windowsevent)[]: A list of Windows Events to log. -## AlarmMetric -### Properties -* **AlarmMetricName**: string (Required): The name of the metric to be monitored for the component. - -## Alarm +## CustomComponent ### Properties -* **AlarmName**: string (Required): The name of the CloudWatch alarm to be monitored for the component. -* **Severity**: string: Indicates the degree of outage when the alarm goes off. +* **ComponentName**: string (Required): The name of the component. +* **ResourceList**: string[] (Required): The list of resource ARNs that belong to the component. ## HAClusterPrometheusExporter ### Properties @@ -83,42 +92,54 @@ * **LogType**: string (Required): The log type decides the log patterns against which Application Insights analyzes the log. * **PatternSet**: string: The name of the log pattern set. -## WindowsEvent +## LogPattern ### Properties -* **EventLevels**: string[] (Required): The levels of event to log. -* **EventName**: string (Required): The type of Windows Events to log. -* **LogGroupName**: string (Required): The CloudWatch log group name to be associated to the monitored log. -* **PatternSet**: string: The name of the log pattern set. +* **Pattern**: string (Required): The log pattern. +* **PatternName**: string (Required): The name of the log pattern. +* **Rank**: int (Required): Rank of the log pattern. -## SubComponentTypeConfiguration +## LogPatternSet ### Properties -* **SubComponentConfigurationDetails**: [SubComponentConfigurationDetails](#subcomponentconfigurationdetails) (Required): The configuration settings of sub components. -* **SubComponentType**: string (Required): The sub component type. +* **LogPatterns**: [LogPattern](#logpattern)[] (Required): The log patterns of a set. +* **PatternSetName**: string (Required): The name of the log pattern set. -## SubComponentConfigurationDetails +## NetWeaverPrometheusExporter ### Properties -* **AlarmMetrics**: [AlarmMetric](#alarmmetric)[]: A list of metrics to monitor for the component. -* **Logs**: [Log](#log)[]: A list of logs to monitor for the component. -* **WindowsEvents**: [WindowsEvent](#windowsevent)[]: A list of Windows Events to log. +* **InstanceNumbers**: string[] (Required): SAP instance numbers for ASCS, ERS, and App Servers. +* **PrometheusPort**: string: Prometheus exporter port. +* **SAPSID**: string (Required): SAP NetWeaver SID. -## CustomComponent +## Process ### Properties -* **ComponentName**: string (Required): The name of the component. -* **ResourceList**: string[] (Required): The list of resource ARNs that belong to the component. +* **AlarmMetrics**: [AlarmMetric](#alarmmetric)[] (Required): A list of metrics to monitor for the component. +* **ProcessName**: string (Required): The name of the process to be monitored for the component. -## LogPatternSet +## SQLServerPrometheusExporter ### Properties -* **LogPatterns**: [LogPattern](#logpattern)[] (Required): The log patterns of a set. -* **PatternSetName**: string (Required): The name of the log pattern set. +* **PrometheusPort**: string (Required): Prometheus exporter port. +* **SQLSecretName**: string (Required): Secret name which managers SQL exporter connection. e.g. {"data_source_name": "sqlserver://:@localhost:1433"} -## LogPattern +## SubComponentConfigurationDetails ### Properties -* **Pattern**: string (Required): The log pattern. -* **PatternName**: string (Required): The name of the log pattern. -* **Rank**: int (Required): Rank of the log pattern. +* **AlarmMetrics**: [AlarmMetric](#alarmmetric)[]: A list of metrics to monitor for the component. +* **Logs**: [Log](#log)[]: A list of logs to monitor for the component. +* **Processes**: [Process](#process)[]: A list of processes to monitor for the component. Only Windows EC2 instances can have a processes section. +* **WindowsEvents**: [WindowsEvent](#windowsevent)[]: A list of Windows Events to log. + +## SubComponentTypeConfiguration +### Properties +* **SubComponentConfigurationDetails**: [SubComponentConfigurationDetails](#subcomponentconfigurationdetails) (Required): The configuration settings of sub components. +* **SubComponentType**: string (Required): The sub component type. ## Tag ### Properties * **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. * **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +## WindowsEvent +### Properties +* **EventLevels**: string[] (Required): The levels of event to log. +* **EventName**: string (Required): The type of Windows Events to log. +* **LogGroupName**: string (Required): The CloudWatch log group name to be associated to the monitored log. +* **PatternSet**: string: The name of the log pattern set. + diff --git a/artifacts/bicep/aws/aws.applicationsignals/default/types.json b/artifacts/bicep/aws/aws.applicationsignals/default/types.json new file mode 100644 index 00000000..ed4d8d34 --- /dev/null +++ b/artifacts/bicep/aws/aws.applicationsignals/default/types.json @@ -0,0 +1,465 @@ +[ + { + "$type": "ObjectType", + "name": "CalendarInterval", + "properties": { + "Duration": { + "type": { + "$ref": "#/16" + }, + "flags": 1 + }, + "DurationUnit": { + "type": { + "$ref": "#/17" + }, + "flags": 1 + }, + "StartTime": { + "type": { + "$ref": "#/16" + }, + "flags": 1, + "description": "Epoch time in seconds you want the first interval to start. Be sure to choose a time that configures the intervals the way that you want. For example, if you want weekly intervals starting on Mondays at 6 a.m., be sure to specify a start time that is a Monday at 6 a.m.\nAs soon as one calendar interval ends, another automatically begins." + } + } + }, + { + "$type": "ObjectType", + "name": "Dimension", + "properties": { + "Name": { + "type": { + "$ref": "#/17" + }, + "flags": 1, + "description": "The name of the dimension. Dimension names must contain only ASCII characters, must include at least one non-whitespace character, and cannot start with a colon (:). ASCII control characters are not supported as part of dimension names." + }, + "Value": { + "type": { + "$ref": "#/17" + }, + "flags": 1, + "description": "The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character. ASCII control characters are not supported as part of dimension values" + } + } + }, + { + "$type": "ObjectType", + "name": "Duration", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DurationUnit", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Goal", + "properties": { + "AttainmentGoal": { + "type": { + "$ref": "#/16" + }, + "flags": 0, + "description": "The threshold that determines if the goal is being met. An attainment goal is the ratio of good periods that meet the threshold requirements to the total periods within the interval. For example, an attainment goal of 99.9% means that within your interval, you are targeting 99.9% of the periods to be in healthy state.\nIf you omit this parameter, 99 is used to represent 99% as the attainment goal." + }, + "Interval": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "WarningThreshold": { + "type": { + "$ref": "#/16" + }, + "flags": 0, + "description": "The percentage of remaining budget over total budget that you want to get warnings for. If you omit this parameter, the default of 50.0 is used." + } + } + }, + { + "$type": "ObjectType", + "name": "Interval", + "properties": { + "CalendarInterval": { + "type": { + "$ref": "#/0" + }, + "flags": 0 + }, + "RollingInterval": { + "type": { + "$ref": "#/11" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "KeyAttributes", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Metric", + "properties": { + "Dimensions": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "An array of one or more dimensions to use to define the metric that you want to use." + }, + "MetricName": { + "type": { + "$ref": "#/17" + }, + "flags": 0, + "description": "The name of the metric to use." + }, + "Namespace": { + "type": { + "$ref": "#/17" + }, + "flags": 0, + "description": "The namespace of the metric." + } + } + }, + { + "$type": "ObjectType", + "name": "MetricDataQueries", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MetricDataQuery", + "properties": { + "AccountId": { + "type": { + "$ref": "#/17" + }, + "flags": 0, + "description": "The ID of the account where the metrics are located, if this is a cross-account alarm." + }, + "Expression": { + "type": { + "$ref": "#/17" + }, + "flags": 0, + "description": "The math expression to be performed on the returned data." + }, + "Id": { + "type": { + "$ref": "#/17" + }, + "flags": 1, + "description": "A short name used to tie this object to the results in the response." + }, + "MetricStat": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO. Within one MetricDataQuery, you must specify either Expression or MetricStat but not both." + }, + "ReturnData": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "This option indicates whether to return the timestamps and raw data values of this metric." + } + } + }, + { + "$type": "ObjectType", + "name": "MetricStat", + "properties": { + "Metric": { + "type": { + "$ref": "#/7" + }, + "flags": 1 + }, + "Period": { + "type": { + "$ref": "#/16" + }, + "flags": 1, + "description": "The granularity, in seconds, to be used for the metric." + }, + "Stat": { + "type": { + "$ref": "#/17" + }, + "flags": 1, + "description": "The statistic to use for comparison to the threshold. It can be any CloudWatch statistic or extended statistic." + }, + "Unit": { + "type": { + "$ref": "#/17" + }, + "flags": 0, + "description": "If you omit Unit then all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions." + } + } + }, + { + "$type": "ObjectType", + "name": "RollingInterval", + "properties": { + "Duration": { + "type": { + "$ref": "#/16" + }, + "flags": 1 + }, + "DurationUnit": { + "type": { + "$ref": "#/17" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Sli", + "properties": { + "ComparisonOperator": { + "type": { + "$ref": "#/17" + }, + "flags": 1, + "description": "The arithmetic operation used when comparing the specified metric to the threshold." + }, + "MetricThreshold": { + "type": { + "$ref": "#/16" + }, + "flags": 1, + "description": "The value that the SLI metric is compared to." + }, + "SliMetric": { + "type": { + "$ref": "#/13" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "SliMetric", + "properties": { + "KeyAttributes": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "MetricDataQueries": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "MetricType": { + "type": { + "$ref": "#/17" + }, + "flags": 0, + "description": "If the SLO monitors either the LATENCY or AVAILABILITY metric that Application Signals collects, this field displays which of those metrics is used." + }, + "OperationName": { + "type": { + "$ref": "#/17" + }, + "flags": 0, + "description": "If the SLO monitors a specific operation of the service, this field displays that operation name." + }, + "PeriodSeconds": { + "type": { + "$ref": "#/16" + }, + "flags": 0, + "description": "The 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." + }, + "Statistic": { + "type": { + "$ref": "#/17" + }, + "flags": 0, + "description": "The statistic to use for comparison to the threshold. It can be any CloudWatch statistic or extended statistic" + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/17" + }, + "flags": 1, + "description": "A string that you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources." + }, + "Value": { + "type": { + "$ref": "#/17" + }, + "flags": 1, + "description": "The value for the specified tag key." + } + } + }, + { + "$type": "ObjectType", + "name": "Tags", + "properties": {} + }, + { + "$type": "IntegerType" + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/9" + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/9" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/14" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.ApplicationSignals/ServiceLevelObjectiveProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/14" + } + }, + { + "$type": "ObjectType", + "name": "AWS.ApplicationSignals/ServiceLevelObjectiveProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/17" + }, + "flags": 18, + "description": "The ARN of this SLO." + }, + "CreatedTime": { + "type": { + "$ref": "#/16" + }, + "flags": 2, + "description": "Epoch time in seconds of the time that this SLO was created" + }, + "Description": { + "type": { + "$ref": "#/17" + }, + "flags": 0, + "description": "An optional description for this SLO. Default is 'No description'" + }, + "Goal": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "LastUpdatedTime": { + "type": { + "$ref": "#/16" + }, + "flags": 2, + "description": "Epoch time in seconds of the time that this SLO was most recently updated" + }, + "Name": { + "type": { + "$ref": "#/17" + }, + "flags": 1, + "description": "The name of this SLO." + }, + "Sli": { + "type": { + "$ref": "#/12" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ApplicationSignals/ServiceLevelObjective", + "properties": { + "name": { + "type": { + "$ref": "#/17" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/17" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/25" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ApplicationSignals/ServiceLevelObjective@default", + "scopeType": 0, + "body": { + "$ref": "#/26" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.applicationsignals/default/types.md b/artifacts/bicep/aws/aws.applicationsignals/default/types.md new file mode 100644 index 00000000..a4299e18 --- /dev/null +++ b/artifacts/bicep/aws/aws.applicationsignals/default/types.md @@ -0,0 +1,93 @@ +# AWS.ApplicationSignals @ default + +## Resource AWS.ApplicationSignals/ServiceLevelObjective@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.ApplicationSignals/ServiceLevelObjectiveProperties](#awsapplicationsignalsservicelevelobjectiveproperties) (Required, Identifier): properties of the resource + +## AWS.ApplicationSignals/ServiceLevelObjectiveProperties +### Properties +* **Arn**: string (ReadOnly, Identifier): The ARN of this SLO. +* **CreatedTime**: int (ReadOnly): Epoch time in seconds of the time that this SLO was created +* **Description**: string: An optional description for this SLO. Default is 'No description' +* **Goal**: [Goal](#goal) +* **LastUpdatedTime**: int (ReadOnly): Epoch time in seconds of the time that this SLO was most recently updated +* **Name**: string (Required): The name of this SLO. +* **Sli**: [Sli](#sli) (Required) +* **Tags**: [Tag](#tag)[] + +## CalendarInterval +### Properties +* **Duration**: int (Required) +* **DurationUnit**: string (Required) +* **StartTime**: int (Required): Epoch time in seconds you want the first interval to start. Be sure to choose a time that configures the intervals the way that you want. For example, if you want weekly intervals starting on Mondays at 6 a.m., be sure to specify a start time that is a Monday at 6 a.m. +As soon as one calendar interval ends, another automatically begins. + +## Dimension +### Properties +* **Name**: string (Required): The name of the dimension. Dimension names must contain only ASCII characters, must include at least one non-whitespace character, and cannot start with a colon (:). ASCII control characters are not supported as part of dimension names. +* **Value**: string (Required): The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character. ASCII control characters are not supported as part of dimension values + +## Goal +### Properties +* **AttainmentGoal**: int: The threshold that determines if the goal is being met. An attainment goal is the ratio of good periods that meet the threshold requirements to the total periods within the interval. For example, an attainment goal of 99.9% means that within your interval, you are targeting 99.9% of the periods to be in healthy state. +If you omit this parameter, 99 is used to represent 99% as the attainment goal. +* **Interval**: [Interval](#interval) +* **WarningThreshold**: int: The percentage of remaining budget over total budget that you want to get warnings for. If you omit this parameter, the default of 50.0 is used. + +## Interval +### Properties +* **CalendarInterval**: [CalendarInterval](#calendarinterval) +* **RollingInterval**: [RollingInterval](#rollinginterval) + +## KeyAttributes +### Properties + +## Metric +### Properties +* **Dimensions**: [Dimension](#dimension)[]: An array of one or more dimensions to use to define the metric that you want to use. +* **MetricName**: string: The name of the metric to use. +* **Namespace**: string: The namespace of the metric. + +## MetricDataQuery +### Properties +* **AccountId**: string: The ID of the account where the metrics are located, if this is a cross-account alarm. +* **Expression**: string: The math expression to be performed on the returned data. +* **Id**: string (Required): A short name used to tie this object to the results in the response. +* **MetricStat**: [MetricStat](#metricstat): A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO. Within one MetricDataQuery, you must specify either Expression or MetricStat but not both. +* **ReturnData**: bool: This option indicates whether to return the timestamps and raw data values of this metric. + +## MetricStat +### Properties +* **Metric**: [Metric](#metric) (Required) +* **Period**: int (Required): The granularity, in seconds, to be used for the metric. +* **Stat**: string (Required): The statistic to use for comparison to the threshold. It can be any CloudWatch statistic or extended statistic. +* **Unit**: string: If you omit Unit then all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions. + +## RollingInterval +### Properties +* **Duration**: int (Required) +* **DurationUnit**: string (Required) + +## Sli +### Properties +* **ComparisonOperator**: string (Required): The arithmetic operation used when comparing the specified metric to the threshold. +* **MetricThreshold**: int (Required): The value that the SLI metric is compared to. +* **SliMetric**: [SliMetric](#slimetric) (Required) + +## SliMetric +### Properties +* **KeyAttributes**: [KeyAttributes](#keyattributes) +* **MetricDataQueries**: [MetricDataQuery](#metricdataquery)[] +* **MetricType**: string: If the SLO monitors either the LATENCY or AVAILABILITY metric that Application Signals collects, this field displays which of those metrics is used. +* **OperationName**: string: If the SLO monitors a specific operation of the service, this field displays that operation name. +* **PeriodSeconds**: int: The 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. +* **Statistic**: string: The statistic to use for comparison to the threshold. It can be any CloudWatch statistic or extended statistic + +## Tag +### Properties +* **Key**: string (Required): A string that you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources. +* **Value**: string (Required): The value for the specified tag key. + diff --git a/artifacts/bicep/aws/aws.apprunner/default/types.json b/artifacts/bicep/aws/aws.apprunner/default/types.json index 45f15b6c..ddc12b9b 100644 --- a/artifacts/bicep/aws/aws.apprunner/default/types.json +++ b/artifacts/bicep/aws/aws.apprunner/default/types.json @@ -1 +1,743 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"AuthenticationConfiguration","Properties":{"AccessRoleArn":{"Type":4,"Flags":0,"Description":"Access Role Arn"},"ConnectionArn":{"Type":4,"Flags":0,"Description":"Connection Arn"}}}},{"2":{"Name":"CodeConfiguration","Properties":{"CodeConfigurationValues":{"Type":10,"Flags":0},"ConfigurationSource":{"Type":4,"Flags":1,"Description":"Configuration Source"}}}},{"2":{"Name":"CodeConfigurationValues","Properties":{"BuildCommand":{"Type":4,"Flags":0,"Description":"Build Command"},"Port":{"Type":4,"Flags":0,"Description":"Port"},"Runtime":{"Type":4,"Flags":1,"Description":"Runtime"},"RuntimeEnvironmentSecrets":{"Type":26,"Flags":0,"Description":"The secrets and parameters that get referenced by your service as environment variables"},"RuntimeEnvironmentVariables":{"Type":27,"Flags":0},"StartCommand":{"Type":4,"Flags":0,"Description":"Start Command"}}}},{"2":{"Name":"CodeRepository","Properties":{"CodeConfiguration":{"Type":9,"Flags":0},"RepositoryUrl":{"Type":4,"Flags":1,"Description":"Repository Url"},"SourceCodeVersion":{"Type":23,"Flags":1},"SourceDirectory":{"Type":4,"Flags":0,"Description":"Source Directory"}}}},{"2":{"Name":"EgressConfiguration","Properties":{"EgressType":{"Type":4,"Flags":1,"Description":"Network egress type."},"VpcConnectorArn":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) of the App Runner VpcConnector."}}}},{"2":{"Name":"EncryptionConfiguration","Properties":{"KmsKey":{"Type":4,"Flags":1,"Description":"The KMS Key"}}}},{"2":{"Name":"HealthCheckConfiguration","Properties":{"HealthyThreshold":{"Type":3,"Flags":0,"Description":"Health check Healthy Threshold"},"Interval":{"Type":3,"Flags":0,"Description":"Health check Interval"},"Path":{"Type":4,"Flags":0,"Description":"Health check Path"},"Protocol":{"Type":4,"Flags":0,"Description":"Health Check Protocol"},"Timeout":{"Type":3,"Flags":0,"Description":"Health check Timeout"},"UnhealthyThreshold":{"Type":3,"Flags":0,"Description":"Health check Unhealthy Threshold"}}}},{"2":{"Name":"ImageConfiguration","Properties":{"Port":{"Type":4,"Flags":0,"Description":"Port"},"RuntimeEnvironmentSecrets":{"Type":28,"Flags":0,"Description":"The secrets and parameters that get referenced by your service as environment variables"},"RuntimeEnvironmentVariables":{"Type":29,"Flags":0},"StartCommand":{"Type":4,"Flags":0,"Description":"Start Command"}}}},{"2":{"Name":"ImageRepository","Properties":{"ImageConfiguration":{"Type":15,"Flags":0},"ImageIdentifier":{"Type":4,"Flags":1,"Description":"Image Identifier"},"ImageRepositoryType":{"Type":4,"Flags":1,"Description":"Image Repository Type"}}}},{"2":{"Name":"IngressConfiguration","Properties":{"IsPubliclyAccessible":{"Type":2,"Flags":1,"Description":"It's set to true if the Apprunner service is publicly accessible. It's set to false otherwise."}}}},{"2":{"Name":"InstanceConfiguration","Properties":{"Cpu":{"Type":4,"Flags":0,"Description":"CPU"},"InstanceRoleArn":{"Type":4,"Flags":0,"Description":"Instance Role Arn"},"Memory":{"Type":4,"Flags":0,"Description":"Memory"}}}},{"2":{"Name":"KeyValuePair","Properties":{"Name":{"Type":4,"Flags":0},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"NetworkConfiguration","Properties":{"EgressConfiguration":{"Type":12,"Flags":0},"IngressConfiguration":{"Type":17,"Flags":0},"IpAddressType":{"Type":4,"Flags":0,"Description":"App Runner service endpoint IP address type"}}}},{"2":{"Name":"RoleArn"}},{"2":{"Name":"ServiceObservabilityConfiguration","Properties":{"ObservabilityConfigurationArn":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) of the App Runner ObservabilityConfiguration."},"ObservabilityEnabled":{"Type":2,"Flags":1,"Description":"Observability enabled"}}}},{"2":{"Name":"SourceCodeVersion","Properties":{"Type":{"Type":4,"Flags":1,"Description":"Source Code Version Type"},"Value":{"Type":4,"Flags":1,"Description":"Source Code Version Value"}}}},{"2":{"Name":"SourceConfiguration","Properties":{"AuthenticationConfiguration":{"Type":8,"Flags":0},"AutoDeploymentsEnabled":{"Type":2,"Flags":0,"Description":"Auto Deployment enabled"},"CodeRepository":{"Type":11,"Flags":0},"ImageRepository":{"Type":16,"Flags":0}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":0},"Value":{"Type":4,"Flags":0}}}},{"3":{"ItemType":19}},{"3":{"ItemType":19}},{"3":{"ItemType":19}},{"3":{"ItemType":19}},{"2":{"Name":"AWS.AppRunner/ServiceProperties","Properties":{"AutoScalingConfigurationArn":{"Type":4,"Flags":4,"Description":"Autoscaling configuration ARN"},"EncryptionConfiguration":{"Type":13,"Flags":0},"HealthCheckConfiguration":{"Type":14,"Flags":0},"InstanceConfiguration":{"Type":18,"Flags":0},"NetworkConfiguration":{"Type":20,"Flags":0},"ObservabilityConfiguration":{"Type":22,"Flags":0},"ServiceArn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN) of the AppRunner Service."},"ServiceId":{"Type":4,"Flags":2,"Description":"The AppRunner Service Id"},"ServiceName":{"Type":4,"Flags":0,"Description":"The AppRunner Service Name."},"ServiceUrl":{"Type":4,"Flags":2,"Description":"The Service Url of the AppRunner Service."},"SourceConfiguration":{"Type":24,"Flags":1},"Status":{"Type":4,"Flags":2,"Description":"AppRunner Service status."},"Tags":{"Type":31,"Flags":4}}}},{"3":{"ItemType":25}},{"2":{"Name":"AWS.AppRunner/Service","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":30,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.AppRunner/Service@default","ScopeType":0,"Body":32}},{"2":{"Name":"IngressVpcConfiguration","Properties":{"VpcEndpointId":{"Type":4,"Flags":1,"Description":"The ID of the VPC endpoint that your App Runner service connects to."},"VpcId":{"Type":4,"Flags":1,"Description":"The ID of the VPC that the VPC endpoint is used in."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":0},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"AWS.AppRunner/VpcIngressConnectionProperties","Properties":{"DomainName":{"Type":4,"Flags":2,"Description":"The Domain name associated with the VPC Ingress Connection."},"IngressVpcConfiguration":{"Type":34,"Flags":1},"ServiceArn":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) of the service."},"Status":{"Type":4,"Flags":2,"Description":"The current status of the VpcIngressConnection."},"Tags":{"Type":37,"Flags":4},"VpcIngressConnectionArn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN) of the VpcIngressConnection."},"VpcIngressConnectionName":{"Type":4,"Flags":0,"Description":"The customer-provided Vpc Ingress Connection name."}}}},{"3":{"ItemType":35}},{"2":{"Name":"AWS.AppRunner/VpcIngressConnection","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":36,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.AppRunner/VpcIngressConnection@default","ScopeType":0,"Body":38}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "AuthenticationConfiguration", + "properties": { + "AccessRoleArn": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "Access Role Arn" + }, + "ConnectionArn": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "Connection Arn" + } + } + }, + { + "$type": "ObjectType", + "name": "CodeConfiguration", + "properties": { + "CodeConfigurationValues": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "ConfigurationSource": { + "type": { + "$ref": "#/18" + }, + "flags": 1, + "description": "Configuration Source" + } + } + }, + { + "$type": "ObjectType", + "name": "CodeConfigurationValues", + "properties": { + "BuildCommand": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "Build Command" + }, + "Port": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "Port" + }, + "Runtime": { + "type": { + "$ref": "#/18" + }, + "flags": 1, + "description": "Runtime" + }, + "RuntimeEnvironmentSecrets": { + "type": { + "$ref": "#/19" + }, + "flags": 0, + "description": "The secrets and parameters that get referenced by your service as environment variables" + }, + "RuntimeEnvironmentVariables": { + "type": { + "$ref": "#/20" + }, + "flags": 0 + }, + "StartCommand": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "Start Command" + } + } + }, + { + "$type": "ObjectType", + "name": "CodeRepository", + "properties": { + "CodeConfiguration": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "RepositoryUrl": { + "type": { + "$ref": "#/18" + }, + "flags": 1, + "description": "Repository Url" + }, + "SourceCodeVersion": { + "type": { + "$ref": "#/15" + }, + "flags": 1 + }, + "SourceDirectory": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "Source Directory" + } + } + }, + { + "$type": "ObjectType", + "name": "EgressConfiguration", + "properties": { + "EgressType": { + "type": { + "$ref": "#/18" + }, + "flags": 1, + "description": "Network egress type." + }, + "VpcConnectorArn": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the App Runner VpcConnector." + } + } + }, + { + "$type": "ObjectType", + "name": "EncryptionConfiguration", + "properties": { + "KmsKey": { + "type": { + "$ref": "#/18" + }, + "flags": 1, + "description": "The KMS Key" + } + } + }, + { + "$type": "ObjectType", + "name": "HealthCheckConfiguration", + "properties": { + "HealthyThreshold": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "Health check Healthy Threshold" + }, + "Interval": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "Health check Interval" + }, + "Path": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "Health check Path" + }, + "Protocol": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "Health Check Protocol" + }, + "Timeout": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "Health check Timeout" + }, + "UnhealthyThreshold": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "Health check Unhealthy Threshold" + } + } + }, + { + "$type": "ObjectType", + "name": "ImageConfiguration", + "properties": { + "Port": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "Port" + }, + "RuntimeEnvironmentSecrets": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "The secrets and parameters that get referenced by your service as environment variables" + }, + "RuntimeEnvironmentVariables": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "StartCommand": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "Start Command" + } + } + }, + { + "$type": "ObjectType", + "name": "ImageRepository", + "properties": { + "ImageConfiguration": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "ImageIdentifier": { + "type": { + "$ref": "#/18" + }, + "flags": 1, + "description": "Image Identifier" + }, + "ImageRepositoryType": { + "type": { + "$ref": "#/18" + }, + "flags": 1, + "description": "Image Repository Type" + } + } + }, + { + "$type": "ObjectType", + "name": "IngressConfiguration", + "properties": { + "IsPubliclyAccessible": { + "type": { + "$ref": "#/24" + }, + "flags": 1, + "description": "It's set to true if the Apprunner service is publicly accessible. It's set to false otherwise." + } + } + }, + { + "$type": "ObjectType", + "name": "InstanceConfiguration", + "properties": { + "Cpu": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "CPU" + }, + "InstanceRoleArn": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "Instance Role Arn" + }, + "Memory": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "Memory" + } + } + }, + { + "$type": "ObjectType", + "name": "KeyValuePair", + "properties": { + "Name": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "NetworkConfiguration", + "properties": { + "EgressConfiguration": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "IngressConfiguration": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "IpAddressType": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "App Runner service endpoint IP address type" + } + } + }, + { + "$type": "ObjectType", + "name": "RoleArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ServiceObservabilityConfiguration", + "properties": { + "ObservabilityConfigurationArn": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the App Runner ObservabilityConfiguration." + }, + "ObservabilityEnabled": { + "type": { + "$ref": "#/24" + }, + "flags": 1, + "description": "Observability enabled" + } + } + }, + { + "$type": "ObjectType", + "name": "SourceCodeVersion", + "properties": { + "Type": { + "type": { + "$ref": "#/18" + }, + "flags": 1, + "description": "Source Code Version Type" + }, + "Value": { + "type": { + "$ref": "#/18" + }, + "flags": 1, + "description": "Source Code Version Value" + } + } + }, + { + "$type": "ObjectType", + "name": "SourceConfiguration", + "properties": { + "AuthenticationConfiguration": { + "type": { + "$ref": "#/0" + }, + "flags": 0 + }, + "AutoDeploymentsEnabled": { + "type": { + "$ref": "#/24" + }, + "flags": 0, + "description": "Auto Deployment enabled" + }, + "CodeRepository": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "ImageRepository": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/11" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/11" + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/11" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/11" + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.AppRunner/ServiceProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/17" + } + }, + { + "$type": "ObjectType", + "name": "AWS.AppRunner/ServiceProperties", + "properties": { + "AutoScalingConfigurationArn": { + "type": { + "$ref": "#/18" + }, + "flags": 4, + "description": "Autoscaling configuration ARN" + }, + "EncryptionConfiguration": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "HealthCheckConfiguration": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "InstanceConfiguration": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "NetworkConfiguration": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + }, + "ObservabilityConfiguration": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + }, + "ServiceArn": { + "type": { + "$ref": "#/18" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) of the AppRunner Service." + }, + "ServiceId": { + "type": { + "$ref": "#/18" + }, + "flags": 2, + "description": "The AppRunner Service Id" + }, + "ServiceName": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "The AppRunner Service Name." + }, + "ServiceUrl": { + "type": { + "$ref": "#/18" + }, + "flags": 2, + "description": "The Service Url of the AppRunner Service." + }, + "SourceConfiguration": { + "type": { + "$ref": "#/16" + }, + "flags": 1 + }, + "Status": { + "type": { + "$ref": "#/18" + }, + "flags": 2, + "description": "AppRunner Service status." + }, + "Tags": { + "type": { + "$ref": "#/26" + }, + "flags": 4 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.AppRunner/Service", + "properties": { + "name": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/18" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/27" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.AppRunner/Service@default", + "scopeType": 0, + "body": { + "$ref": "#/28" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "IngressVpcConfiguration", + "properties": { + "VpcEndpointId": { + "type": { + "$ref": "#/18" + }, + "flags": 1, + "description": "The ID of the VPC endpoint that your App Runner service connects to." + }, + "VpcId": { + "type": { + "$ref": "#/18" + }, + "flags": 1, + "description": "The ID of the VPC that the VPC endpoint is used in." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.AppRunner/VpcIngressConnectionProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/31" + } + }, + { + "$type": "ObjectType", + "name": "AWS.AppRunner/VpcIngressConnectionProperties", + "properties": { + "DomainName": { + "type": { + "$ref": "#/18" + }, + "flags": 2, + "description": "The Domain name associated with the VPC Ingress Connection." + }, + "IngressVpcConfiguration": { + "type": { + "$ref": "#/30" + }, + "flags": 1 + }, + "ServiceArn": { + "type": { + "$ref": "#/18" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of the service." + }, + "Status": { + "type": { + "$ref": "#/18" + }, + "flags": 2, + "description": "The current status of the VpcIngressConnection." + }, + "Tags": { + "type": { + "$ref": "#/33" + }, + "flags": 4 + }, + "VpcIngressConnectionArn": { + "type": { + "$ref": "#/18" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) of the VpcIngressConnection." + }, + "VpcIngressConnectionName": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "The customer-provided Vpc Ingress Connection name." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.AppRunner/VpcIngressConnection", + "properties": { + "name": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/18" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/34" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.AppRunner/VpcIngressConnection@default", + "scopeType": 0, + "body": { + "$ref": "#/35" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.apprunner/default/types.md b/artifacts/bicep/aws/aws.apprunner/default/types.md index 6c6945cd..949748d9 100644 --- a/artifacts/bicep/aws/aws.apprunner/default/types.md +++ b/artifacts/bicep/aws/aws.apprunner/default/types.md @@ -3,16 +3,21 @@ ## Resource AWS.AppRunner/Service@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.AppRunner/ServiceProperties](#awsapprunnerserviceproperties) (Required): properties of the resource +* **properties**: [AWS.AppRunner/ServiceProperties](#awsapprunnerserviceproperties) (Required, Identifier): properties of the resource ## Resource AWS.AppRunner/VpcIngressConnection@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.AppRunner/VpcIngressConnectionProperties](#awsapprunnervpcingressconnectionproperties) (Required): properties of the resource +* **properties**: [AWS.AppRunner/VpcIngressConnectionProperties](#awsapprunnervpcingressconnectionproperties) (Required, Identifier): properties of the resource + +## AuthenticationConfiguration +### Properties +* **AccessRoleArn**: string: Access Role Arn +* **ConnectionArn**: string: Connection Arn ## AWS.AppRunner/ServiceProperties ### Properties @@ -30,121 +35,116 @@ * **Status**: string (ReadOnly): AppRunner Service status. * **Tags**: [Tag](#tag)[] (WriteOnly) -## EncryptionConfiguration +## AWS.AppRunner/VpcIngressConnectionProperties ### Properties -* **KmsKey**: string (Required): The KMS Key +* **DomainName**: string (ReadOnly): The Domain name associated with the VPC Ingress Connection. +* **IngressVpcConfiguration**: [IngressVpcConfiguration](#ingressvpcconfiguration) (Required) +* **ServiceArn**: string (Required): The Amazon Resource Name (ARN) of the service. +* **Status**: string (ReadOnly): The current status of the VpcIngressConnection. +* **Tags**: [Tag](#tag)[] (WriteOnly) +* **VpcIngressConnectionArn**: string (ReadOnly, Identifier): The Amazon Resource Name (ARN) of the VpcIngressConnection. +* **VpcIngressConnectionName**: string: The customer-provided Vpc Ingress Connection name. -## HealthCheckConfiguration +## CodeConfiguration ### Properties -* **HealthyThreshold**: int: Health check Healthy Threshold -* **Interval**: int: Health check Interval -* **Path**: string: Health check Path -* **Protocol**: string: Health Check Protocol -* **Timeout**: int: Health check Timeout -* **UnhealthyThreshold**: int: Health check Unhealthy Threshold +* **CodeConfigurationValues**: [CodeConfigurationValues](#codeconfigurationvalues) +* **ConfigurationSource**: string (Required): Configuration Source -## InstanceConfiguration +## CodeConfigurationValues ### Properties -* **Cpu**: string: CPU -* **InstanceRoleArn**: string: Instance Role Arn -* **Memory**: string: Memory +* **BuildCommand**: string: Build Command +* **Port**: string: Port +* **Runtime**: string (Required): Runtime +* **RuntimeEnvironmentSecrets**: [KeyValuePair](#keyvaluepair)[]: The secrets and parameters that get referenced by your service as environment variables +* **RuntimeEnvironmentVariables**: [KeyValuePair](#keyvaluepair)[] +* **StartCommand**: string: Start Command -## NetworkConfiguration +## CodeRepository ### Properties -* **EgressConfiguration**: [EgressConfiguration](#egressconfiguration) -* **IngressConfiguration**: [IngressConfiguration](#ingressconfiguration) -* **IpAddressType**: string: App Runner service endpoint IP address type +* **CodeConfiguration**: [CodeConfiguration](#codeconfiguration) +* **RepositoryUrl**: string (Required): Repository Url +* **SourceCodeVersion**: [SourceCodeVersion](#sourcecodeversion) (Required) +* **SourceDirectory**: string: Source Directory ## EgressConfiguration ### Properties * **EgressType**: string (Required): Network egress type. * **VpcConnectorArn**: string: The Amazon Resource Name (ARN) of the App Runner VpcConnector. -## IngressConfiguration +## EncryptionConfiguration ### Properties -* **IsPubliclyAccessible**: bool (Required): It's set to true if the Apprunner service is publicly accessible. It's set to false otherwise. +* **KmsKey**: string (Required): The KMS Key -## ServiceObservabilityConfiguration +## HealthCheckConfiguration ### Properties -* **ObservabilityConfigurationArn**: string: The Amazon Resource Name (ARN) of the App Runner ObservabilityConfiguration. -* **ObservabilityEnabled**: bool (Required): Observability enabled +* **HealthyThreshold**: int: Health check Healthy Threshold +* **Interval**: int: Health check Interval +* **Path**: string: Health check Path +* **Protocol**: string: Health Check Protocol +* **Timeout**: int: Health check Timeout +* **UnhealthyThreshold**: int: Health check Unhealthy Threshold -## SourceConfiguration +## ImageConfiguration ### Properties -* **AuthenticationConfiguration**: [AuthenticationConfiguration](#authenticationconfiguration) -* **AutoDeploymentsEnabled**: bool: Auto Deployment enabled -* **CodeRepository**: [CodeRepository](#coderepository) -* **ImageRepository**: [ImageRepository](#imagerepository) +* **Port**: string: Port +* **RuntimeEnvironmentSecrets**: [KeyValuePair](#keyvaluepair)[]: The secrets and parameters that get referenced by your service as environment variables +* **RuntimeEnvironmentVariables**: [KeyValuePair](#keyvaluepair)[] +* **StartCommand**: string: Start Command -## AuthenticationConfiguration +## ImageRepository ### Properties -* **AccessRoleArn**: string: Access Role Arn -* **ConnectionArn**: string: Connection Arn +* **ImageConfiguration**: [ImageConfiguration](#imageconfiguration) +* **ImageIdentifier**: string (Required): Image Identifier +* **ImageRepositoryType**: string (Required): Image Repository Type -## CodeRepository +## IngressConfiguration ### Properties -* **CodeConfiguration**: [CodeConfiguration](#codeconfiguration) -* **RepositoryUrl**: string (Required): Repository Url -* **SourceCodeVersion**: [SourceCodeVersion](#sourcecodeversion) (Required) -* **SourceDirectory**: string: Source Directory +* **IsPubliclyAccessible**: bool (Required): It's set to true if the Apprunner service is publicly accessible. It's set to false otherwise. -## CodeConfiguration +## IngressVpcConfiguration ### Properties -* **CodeConfigurationValues**: [CodeConfigurationValues](#codeconfigurationvalues) -* **ConfigurationSource**: string (Required): Configuration Source +* **VpcEndpointId**: string (Required): The ID of the VPC endpoint that your App Runner service connects to. +* **VpcId**: string (Required): The ID of the VPC that the VPC endpoint is used in. -## CodeConfigurationValues +## InstanceConfiguration ### Properties -* **BuildCommand**: string: Build Command -* **Port**: string: Port -* **Runtime**: string (Required): Runtime -* **RuntimeEnvironmentSecrets**: [KeyValuePair](#keyvaluepair)[]: The secrets and parameters that get referenced by your service as environment variables -* **RuntimeEnvironmentVariables**: [KeyValuePair](#keyvaluepair)[] -* **StartCommand**: string: Start Command +* **Cpu**: string: CPU +* **InstanceRoleArn**: string: Instance Role Arn +* **Memory**: string: Memory ## KeyValuePair ### Properties * **Name**: string * **Value**: string +## NetworkConfiguration +### Properties +* **EgressConfiguration**: [EgressConfiguration](#egressconfiguration) +* **IngressConfiguration**: [IngressConfiguration](#ingressconfiguration) +* **IpAddressType**: string: App Runner service endpoint IP address type + +## ServiceObservabilityConfiguration +### Properties +* **ObservabilityConfigurationArn**: string: The Amazon Resource Name (ARN) of the App Runner ObservabilityConfiguration. +* **ObservabilityEnabled**: bool (Required): Observability enabled + ## SourceCodeVersion ### Properties * **Type**: string (Required): Source Code Version Type * **Value**: string (Required): Source Code Version Value -## ImageRepository -### Properties -* **ImageConfiguration**: [ImageConfiguration](#imageconfiguration) -* **ImageIdentifier**: string (Required): Image Identifier -* **ImageRepositoryType**: string (Required): Image Repository Type - -## ImageConfiguration +## SourceConfiguration ### Properties -* **Port**: string: Port -* **RuntimeEnvironmentSecrets**: [KeyValuePair](#keyvaluepair)[]: The secrets and parameters that get referenced by your service as environment variables -* **RuntimeEnvironmentVariables**: [KeyValuePair](#keyvaluepair)[] -* **StartCommand**: string: Start Command +* **AuthenticationConfiguration**: [AuthenticationConfiguration](#authenticationconfiguration) +* **AutoDeploymentsEnabled**: bool: Auto Deployment enabled +* **CodeRepository**: [CodeRepository](#coderepository) +* **ImageRepository**: [ImageRepository](#imagerepository) ## Tag ### Properties * **Key**: string * **Value**: string -## AWS.AppRunner/VpcIngressConnectionProperties -### Properties -* **DomainName**: string (ReadOnly): The Domain name associated with the VPC Ingress Connection. -* **IngressVpcConfiguration**: [IngressVpcConfiguration](#ingressvpcconfiguration) (Required) -* **ServiceArn**: string (Required): The Amazon Resource Name (ARN) of the service. -* **Status**: string (ReadOnly): The current status of the VpcIngressConnection. -* **Tags**: [Tag](#tag)[] (WriteOnly) -* **VpcIngressConnectionArn**: string (ReadOnly, Identifier): The Amazon Resource Name (ARN) of the VpcIngressConnection. -* **VpcIngressConnectionName**: string: The customer-provided Vpc Ingress Connection name. - -## IngressVpcConfiguration -### Properties -* **VpcEndpointId**: string (Required): The ID of the VPC endpoint that your App Runner service connects to. -* **VpcId**: string (Required): The ID of the VPC that the VPC endpoint is used in. - ## Tag ### Properties * **Key**: string diff --git a/artifacts/bicep/aws/aws.appstream/default/types.json b/artifacts/bicep/aws/aws.appstream/default/types.json index 112bfc33..9b78940c 100644 --- a/artifacts/bicep/aws/aws.appstream/default/types.json +++ b/artifacts/bicep/aws/aws.appstream/default/types.json @@ -1 +1,642 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"AccessEndpoint","Properties":{"EndpointType":{"Type":4,"Flags":1},"VpceId":{"Type":4,"Flags":1}}}},{"2":{"Name":"Arn"}},{"2":{"Name":"PlatformType"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"VpcConfig","Properties":{"SecurityGroupIds":{"Type":13,"Flags":0},"SubnetIds":{"Type":14,"Flags":0}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.AppStream/AppBlockBuilderProperties","Properties":{"AccessEndpoints":{"Type":16,"Flags":0},"AppBlockArns":{"Type":17,"Flags":4},"Arn":{"Type":4,"Flags":2},"CreatedTime":{"Type":4,"Flags":2},"Description":{"Type":4,"Flags":0},"DisplayName":{"Type":4,"Flags":0},"EnableDefaultInternetAccess":{"Type":2,"Flags":0},"IamRoleArn":{"Type":4,"Flags":0},"InstanceType":{"Type":4,"Flags":1},"Name":{"Type":4,"Flags":17},"Platform":{"Type":4,"Flags":1},"Tags":{"Type":18,"Flags":4},"VpcConfig":{"Type":12,"Flags":1}}}},{"3":{"ItemType":8}},{"3":{"ItemType":4}},{"3":{"ItemType":11}},{"2":{"Name":"AWS.AppStream/AppBlockBuilder","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":15,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.AppStream/AppBlockBuilder@default","ScopeType":0,"Body":19}},{"2":{"Name":"ApplicationAttribute"}},{"2":{"Name":"Arn"}},{"2":{"Name":"PlatformType"}},{"2":{"Name":"S3Location","Properties":{"S3Bucket":{"Type":4,"Flags":1},"S3Key":{"Type":4,"Flags":1}}}},{"2":{"Name":"Tag","Properties":{}}},{"2":{"Name":"AWS.AppStream/ApplicationProperties","Properties":{"AppBlockArn":{"Type":4,"Flags":1},"Arn":{"Type":4,"Flags":18},"AttributesToDelete":{"Type":27,"Flags":4},"CreatedTime":{"Type":4,"Flags":2},"Description":{"Type":4,"Flags":0},"DisplayName":{"Type":4,"Flags":0},"IconS3Location":{"Type":24,"Flags":1},"InstanceFamilies":{"Type":28,"Flags":1},"LaunchParameters":{"Type":4,"Flags":0},"LaunchPath":{"Type":4,"Flags":1},"Name":{"Type":4,"Flags":1},"Platforms":{"Type":29,"Flags":1},"Tags":{"Type":30,"Flags":4},"WorkingDirectory":{"Type":4,"Flags":0}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":25}},{"2":{"Name":"AWS.AppStream/Application","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":26,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.AppStream/Application@default","ScopeType":0,"Body":31}},{"2":{"Name":"CertificateBasedAuthProperties","Properties":{"CertificateAuthorityArn":{"Type":4,"Flags":0},"Status":{"Type":4,"Flags":0}}}},{"2":{"Name":"ServiceAccountCredentials","Properties":{"AccountName":{"Type":4,"Flags":1},"AccountPassword":{"Type":4,"Flags":5}}}},{"2":{"Name":"AWS.AppStream/DirectoryConfigProperties","Properties":{"CertificateBasedAuthProperties":{"Type":33,"Flags":0},"DirectoryName":{"Type":4,"Flags":17},"OrganizationalUnitDistinguishedNames":{"Type":36,"Flags":1},"ServiceAccountCredentials":{"Type":34,"Flags":1}}}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.AppStream/DirectoryConfig","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":35,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.AppStream/DirectoryConfig@default","ScopeType":0,"Body":37}},{"2":{"Name":"Attribute","Properties":{"Name":{"Type":4,"Flags":17},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.AppStream/EntitlementProperties","Properties":{"AppVisibility":{"Type":4,"Flags":1},"Attributes":{"Type":41,"Flags":1},"CreatedTime":{"Type":4,"Flags":2},"Description":{"Type":4,"Flags":0},"LastModifiedTime":{"Type":4,"Flags":2},"Name":{"Type":4,"Flags":17},"StackName":{"Type":4,"Flags":17}}}},{"3":{"ItemType":39}},{"2":{"Name":"AWS.AppStream/Entitlement","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":40,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.AppStream/Entitlement@default","ScopeType":0,"Body":42}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "AccessEndpoint", + "properties": { + "EndpointType": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "VpceId": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Arn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PlatformType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "VpcConfig", + "properties": { + "SecurityGroupIds": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "SubnetIds": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.AppStream/AppBlockBuilderProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ObjectType", + "name": "AWS.AppStream/AppBlockBuilderProperties", + "properties": { + "AccessEndpoints": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "AppBlockArns": { + "type": { + "$ref": "#/10" + }, + "flags": 4 + }, + "Arn": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "CreatedTime": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "Description": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "DisplayName": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "EnableDefaultInternetAccess": { + "type": { + "$ref": "#/11" + }, + "flags": 0 + }, + "IamRoleArn": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "InstanceType": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/5" + }, + "flags": 17 + }, + "Platform": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/12" + }, + "flags": 4 + }, + "VpcConfig": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.AppStream/AppBlockBuilder", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/13" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.AppStream/AppBlockBuilder@default", + "scopeType": 0, + "body": { + "$ref": "#/14" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "ApplicationAttribute", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Arn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PlatformType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "S3Location", + "properties": { + "S3Bucket": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "S3Key": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.AppStream/ApplicationProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/20" + } + }, + { + "$type": "ObjectType", + "name": "AWS.AppStream/ApplicationProperties", + "properties": { + "AppBlockArn": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Arn": { + "type": { + "$ref": "#/5" + }, + "flags": 18 + }, + "AttributesToDelete": { + "type": { + "$ref": "#/22" + }, + "flags": 4 + }, + "CreatedTime": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "Description": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "DisplayName": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "IconS3Location": { + "type": { + "$ref": "#/19" + }, + "flags": 1 + }, + "InstanceFamilies": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + }, + "LaunchParameters": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "LaunchPath": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Platforms": { + "type": { + "$ref": "#/24" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/25" + }, + "flags": 4 + }, + "WorkingDirectory": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.AppStream/Application", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/26" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.AppStream/Application@default", + "scopeType": 0, + "body": { + "$ref": "#/27" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "CertificateBasedAuthProperties", + "properties": { + "CertificateAuthorityArn": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Status": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ServiceAccountCredentials", + "properties": { + "AccountName": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "AccountPassword": { + "type": { + "$ref": "#/5" + }, + "flags": 5 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.AppStream/DirectoryConfigProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ObjectType", + "name": "AWS.AppStream/DirectoryConfigProperties", + "properties": { + "CertificateBasedAuthProperties": { + "type": { + "$ref": "#/29" + }, + "flags": 0 + }, + "DirectoryName": { + "type": { + "$ref": "#/5" + }, + "flags": 17 + }, + "OrganizationalUnitDistinguishedNames": { + "type": { + "$ref": "#/32" + }, + "flags": 1 + }, + "ServiceAccountCredentials": { + "type": { + "$ref": "#/30" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.AppStream/DirectoryConfig", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/33" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.AppStream/DirectoryConfig@default", + "scopeType": 0, + "body": { + "$ref": "#/34" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Attribute", + "properties": { + "Name": { + "type": { + "$ref": "#/5" + }, + "flags": 17 + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.AppStream/EntitlementProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/36" + } + }, + { + "$type": "ObjectType", + "name": "AWS.AppStream/EntitlementProperties", + "properties": { + "AppVisibility": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Attributes": { + "type": { + "$ref": "#/38" + }, + "flags": 1 + }, + "CreatedTime": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "Description": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "LastModifiedTime": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "Name": { + "type": { + "$ref": "#/5" + }, + "flags": 17 + }, + "StackName": { + "type": { + "$ref": "#/5" + }, + "flags": 17 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.AppStream/Entitlement", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/39" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.AppStream/Entitlement@default", + "scopeType": 0, + "body": { + "$ref": "#/40" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.appstream/default/types.md b/artifacts/bicep/aws/aws.appstream/default/types.md index 0e66a8f3..0a7fd1fe 100644 --- a/artifacts/bicep/aws/aws.appstream/default/types.md +++ b/artifacts/bicep/aws/aws.appstream/default/types.md @@ -3,30 +3,40 @@ ## Resource AWS.AppStream/AppBlockBuilder@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.AppStream/AppBlockBuilderProperties](#awsappstreamappblockbuilderproperties) (Required): properties of the resource +* **properties**: [AWS.AppStream/AppBlockBuilderProperties](#awsappstreamappblockbuilderproperties) (Required, Identifier): properties of the resource ## Resource AWS.AppStream/Application@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.AppStream/ApplicationProperties](#awsappstreamapplicationproperties) (Required): properties of the resource +* **properties**: [AWS.AppStream/ApplicationProperties](#awsappstreamapplicationproperties) (Required, Identifier): properties of the resource ## Resource AWS.AppStream/DirectoryConfig@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.AppStream/DirectoryConfigProperties](#awsappstreamdirectoryconfigproperties) (Required): properties of the resource +* **properties**: [AWS.AppStream/DirectoryConfigProperties](#awsappstreamdirectoryconfigproperties) (Required, Identifier): properties of the resource ## Resource AWS.AppStream/Entitlement@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.AppStream/EntitlementProperties](#awsappstreamentitlementproperties) (Required): properties of the resource +* **properties**: [AWS.AppStream/EntitlementProperties](#awsappstreamentitlementproperties) (Required, Identifier): properties of the resource + +## AccessEndpoint +### Properties +* **EndpointType**: string (Required) +* **VpceId**: string (Required) + +## Attribute +### Properties +* **Name**: string (Required, Identifier) +* **Value**: string (Required) ## AWS.AppStream/AppBlockBuilderProperties ### Properties @@ -44,21 +54,6 @@ * **Tags**: [Tag](#tag)[] (WriteOnly) * **VpcConfig**: [VpcConfig](#vpcconfig) (Required) -## AccessEndpoint -### Properties -* **EndpointType**: string (Required) -* **VpceId**: string (Required) - -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - -## VpcConfig -### Properties -* **SecurityGroupIds**: string[] -* **SubnetIds**: string[] - ## AWS.AppStream/ApplicationProperties ### Properties * **AppBlockArn**: string (Required) @@ -76,14 +71,6 @@ * **Tags**: [Tag](#tag)[] (WriteOnly) * **WorkingDirectory**: string -## S3Location -### Properties -* **S3Bucket**: string (Required) -* **S3Key**: string (Required) - -## Tag -### Properties - ## AWS.AppStream/DirectoryConfigProperties ### Properties * **CertificateBasedAuthProperties**: [CertificateBasedAuthProperties](#certificatebasedauthproperties) @@ -91,28 +78,41 @@ * **OrganizationalUnitDistinguishedNames**: string[] (Required) * **ServiceAccountCredentials**: [ServiceAccountCredentials](#serviceaccountcredentials) (Required) +## AWS.AppStream/EntitlementProperties +### Properties +* **AppVisibility**: string (Required) +* **Attributes**: [Attribute](#attribute)[] (Required) +* **CreatedTime**: string (ReadOnly) +* **Description**: string +* **LastModifiedTime**: string (ReadOnly) +* **Name**: string (Required, Identifier) +* **StackName**: string (Required, Identifier) + ## CertificateBasedAuthProperties ### Properties * **CertificateAuthorityArn**: string * **Status**: string +## S3Location +### Properties +* **S3Bucket**: string (Required) +* **S3Key**: string (Required) + ## ServiceAccountCredentials ### Properties * **AccountName**: string (Required) * **AccountPassword**: string (Required, WriteOnly) -## AWS.AppStream/EntitlementProperties +## Tag ### Properties -* **AppVisibility**: string (Required) -* **Attributes**: [Attribute](#attribute)[] (Required) -* **CreatedTime**: string (ReadOnly) -* **Description**: string -* **LastModifiedTime**: string (ReadOnly) -* **Name**: string (Required, Identifier) -* **StackName**: string (Required, Identifier) +* **Key**: string (Required) +* **Value**: string (Required) -## Attribute +## Tag ### Properties -* **Name**: string (Required, Identifier) -* **Value**: string (Required) + +## VpcConfig +### Properties +* **SecurityGroupIds**: string[] +* **SubnetIds**: string[] diff --git a/artifacts/bicep/aws/aws.appsync/default/types.json b/artifacts/bicep/aws/aws.appsync/default/types.json index 99752d99..03cd3cae 100644 --- a/artifacts/bicep/aws/aws.appsync/default/types.json +++ b/artifacts/bicep/aws/aws.appsync/default/types.json @@ -1 +1,792 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"AWS.AppSync/DomainNameProperties","Properties":{"AppSyncDomainName":{"Type":4,"Flags":2},"CertificateArn":{"Type":4,"Flags":1},"Description":{"Type":4,"Flags":0},"DomainName":{"Type":4,"Flags":17},"HostedZoneId":{"Type":4,"Flags":2}}}},{"2":{"Name":"AWS.AppSync/DomainName","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":8,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.AppSync/DomainName@default","ScopeType":0,"Body":9}},{"2":{"Name":"AWS.AppSync/DomainNameApiAssociationProperties","Properties":{"ApiAssociationIdentifier":{"Type":4,"Flags":18},"ApiId":{"Type":4,"Flags":1},"DomainName":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.AppSync/DomainNameApiAssociation","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":11,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.AppSync/DomainNameApiAssociation@default","ScopeType":0,"Body":12}},{"2":{"Name":"AppSyncRuntime","Properties":{"Name":{"Type":4,"Flags":1,"Description":"The name of the runtime to use. Currently, the only allowed value is APPSYNC_JS."},"RuntimeVersion":{"Type":4,"Flags":1,"Description":"The version of the runtime to use. Currently, the only allowed version is 1.0.0."}}}},{"2":{"Name":"LambdaConflictHandlerConfig","Properties":{"LambdaConflictHandlerArn":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) for the Lambda function to use as the Conflict Handler."}}}},{"2":{"Name":"SyncConfig","Properties":{"ConflictDetection":{"Type":4,"Flags":1,"Description":"The Conflict Detection strategy to use."},"ConflictHandler":{"Type":4,"Flags":0,"Description":"The Conflict Resolution strategy to perform in the event of a conflict."},"LambdaConflictHandlerConfig":{"Type":15,"Flags":0}}}},{"2":{"Name":"AWS.AppSync/FunctionConfigurationProperties","Properties":{"ApiId":{"Type":4,"Flags":1,"Description":"The AWS AppSync GraphQL API that you want to attach using this function."},"Code":{"Type":4,"Flags":0,"Description":"The resolver code that contains the request and response functions. When code is used, the runtime is required. The runtime value must be APPSYNC_JS."},"CodeS3Location":{"Type":4,"Flags":4,"Description":"The Amazon S3 endpoint (where the code is located??)."},"DataSourceName":{"Type":4,"Flags":1,"Description":"The name of data source this function will attach."},"Description":{"Type":4,"Flags":0,"Description":"The function description."},"FunctionArn":{"Type":4,"Flags":18,"Description":"The ARN for the function generated by the service"},"FunctionId":{"Type":4,"Flags":2,"Description":"The unique identifier for the function generated by the service"},"FunctionVersion":{"Type":4,"Flags":0,"Description":"The version of the request mapping template. Currently, only the 2018-05-29 version of the template is supported."},"MaxBatchSize":{"Type":3,"Flags":0,"Description":"The maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a BatchInvoke operation."},"Name":{"Type":4,"Flags":1,"Description":"The name of the function."},"RequestMappingTemplate":{"Type":4,"Flags":0,"Description":"The Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template."},"RequestMappingTemplateS3Location":{"Type":4,"Flags":4,"Description":"Describes a Sync configuration for a resolver. Contains information on which Conflict Detection, as well as Resolution strategy, should be performed when the resolver is invoked."},"ResponseMappingTemplate":{"Type":4,"Flags":0,"Description":"The Function response mapping template."},"ResponseMappingTemplateS3Location":{"Type":4,"Flags":4,"Description":"The location of a response mapping template in an Amazon S3 bucket. Use this if you want to provision with a template file in Amazon S3 rather than embedding it in your CloudFormation template."},"Runtime":{"Type":14,"Flags":0,"Description":"Describes a runtime used by an AWS AppSync pipeline resolver or AWS AppSync function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified."},"SyncConfig":{"Type":16,"Flags":0,"Description":"Describes a Sync configuration for a resolver. Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is invoked."}}}},{"2":{"Name":"AWS.AppSync/FunctionConfiguration","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":17,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.AppSync/FunctionConfiguration@default","ScopeType":0,"Body":18}},{"2":{"Name":"AppSyncRuntime","Properties":{"Name":{"Type":4,"Flags":1,"Description":"The name of the runtime to use."},"RuntimeVersion":{"Type":4,"Flags":1,"Description":"The version of the runtime to use."}}}},{"2":{"Name":"CachingConfig","Properties":{"CachingKeys":{"Type":25,"Flags":0,"Description":"The caching keys for a resolver that has caching activated. Valid values are entries from the $context.arguments, $context.source, and $context.identity maps."},"Ttl":{"Type":3,"Flags":1,"Description":"The TTL in seconds for a resolver that has caching activated. Valid values are 1-36.00 seconds."}}}},{"2":{"Name":"LambdaConflictHandlerConfig","Properties":{"LambdaConflictHandlerArn":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) for the Lambda function to use as the Conflict Handler."}}}},{"2":{"Name":"PipelineConfig","Properties":{"Functions":{"Type":26,"Flags":0,"Description":"A list of Function objects."}}}},{"2":{"Name":"SyncConfig","Properties":{"ConflictDetection":{"Type":4,"Flags":1,"Description":"The Conflict Detection strategy to use."},"ConflictHandler":{"Type":4,"Flags":0,"Description":"The Conflict Resolution strategy to perform in the event of a conflict."},"LambdaConflictHandlerConfig":{"Type":22,"Flags":0}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.AppSync/ResolverProperties","Properties":{"ApiId":{"Type":4,"Flags":1,"Description":"The AWS AppSync GraphQL API to which you want to attach this resolver."},"CachingConfig":{"Type":21,"Flags":0,"Description":"The caching configuration for the resolver."},"Code":{"Type":4,"Flags":0,"Description":"The resolver code that contains the request and response functions. When code is used, the runtime is required."},"CodeS3Location":{"Type":4,"Flags":4,"Description":"The Amazon S3 endpoint."},"DataSourceName":{"Type":4,"Flags":0,"Description":"The resolver data source name."},"FieldName":{"Type":4,"Flags":1,"Description":"The GraphQL field on a type that invokes the resolver."},"Kind":{"Type":4,"Flags":0,"Description":"The resolver type."},"MaxBatchSize":{"Type":3,"Flags":0,"Description":"The maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a BatchInvoke operation."},"PipelineConfig":{"Type":23,"Flags":0,"Description":"Functions linked with the pipeline resolver."},"RequestMappingTemplate":{"Type":4,"Flags":0,"Description":"Request mapping templates are optional when using a Lambda data source. For all other data sources, a request mapping template is required."},"RequestMappingTemplateS3Location":{"Type":4,"Flags":4,"Description":"The location of a request mapping template in an Amazon S3 bucket. Use this if you want to provision with a template file in Amazon S3 rather than embedding it in your CloudFormation template."},"ResolverArn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN) for the resolver."},"ResponseMappingTemplate":{"Type":4,"Flags":0,"Description":"The response mapping template."},"ResponseMappingTemplateS3Location":{"Type":4,"Flags":4,"Description":"The location of a response mapping template in an Amazon S3 bucket. Use this if you want to provision with a template file in Amazon S3 rather than embedding it in your CloudFormation template."},"Runtime":{"Type":20,"Flags":0,"Description":"Describes a runtime used by an AWS AppSync pipeline resolver or AWS AppSync function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified."},"SyncConfig":{"Type":24,"Flags":0,"Description":"The SyncConfig for a resolver attached to a versioned data source."},"TypeName":{"Type":4,"Flags":1,"Description":"The GraphQL type that invokes this resolver."}}}},{"2":{"Name":"AWS.AppSync/Resolver","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":27,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.AppSync/Resolver@default","ScopeType":0,"Body":28}},{"2":{"Name":"SourceApiAssociationConfig","Properties":{"MergeType":{"Type":4,"Flags":0,"Description":"Configuration of the merged behavior for the association. For example when it could be auto or has to be manual."}}}},{"2":{"Name":"AWS.AppSync/SourceApiAssociationProperties","Properties":{"AssociationArn":{"Type":4,"Flags":18,"Description":"ARN of the SourceApiAssociation."},"AssociationId":{"Type":4,"Flags":2,"Description":"Id of the SourceApiAssociation."},"Description":{"Type":4,"Flags":0,"Description":"Description of the SourceApiAssociation."},"LastSuccessfulMergeDate":{"Type":4,"Flags":2,"Description":"Date of last schema successful merge."},"MergedApiArn":{"Type":4,"Flags":2,"Description":"ARN of the Merged API in the association."},"MergedApiId":{"Type":4,"Flags":2,"Description":"GraphQLApiId of the Merged API in the association."},"MergedApiIdentifier":{"Type":4,"Flags":4,"Description":"Identifier of the Merged GraphQLApi to associate. It could be either GraphQLApi ApiId or ARN"},"SourceApiArn":{"Type":4,"Flags":2,"Description":"ARN of the source API in the association."},"SourceApiAssociationConfig":{"Type":30,"Flags":0,"Description":"Customized configuration for SourceApiAssociation."},"SourceApiAssociationStatus":{"Type":4,"Flags":2,"Description":"Current status of SourceApiAssociation."},"SourceApiAssociationStatusDetail":{"Type":4,"Flags":2,"Description":"Current SourceApiAssociation status details."},"SourceApiId":{"Type":4,"Flags":2,"Description":"GraphQLApiId of the source API in the association."},"SourceApiIdentifier":{"Type":4,"Flags":4,"Description":"Identifier of the Source GraphQLApi to associate. It could be either GraphQLApi ApiId or ARN"}}}},{"2":{"Name":"AWS.AppSync/SourceApiAssociation","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":31,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.AppSync/SourceApiAssociation@default","ScopeType":0,"Body":32}}] \ No newline at end of file +[ + { + "$type": "StringLiteralType", + "value": "AWS.AppSync/DomainNameProperties" + }, + { + "$type": "StringType" + }, + { + "$type": "ObjectType", + "name": "AWS.AppSync/DomainNameProperties", + "properties": { + "AppSyncDomainName": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "CertificateArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "DomainName": { + "type": { + "$ref": "#/1" + }, + "flags": 17 + }, + "HostedZoneId": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.AppSync/DomainName", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.AppSync/DomainName@default", + "scopeType": 0, + "body": { + "$ref": "#/3" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.AppSync/DomainNameApiAssociationProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.AppSync/DomainNameApiAssociationProperties", + "properties": { + "ApiAssociationIdentifier": { + "type": { + "$ref": "#/1" + }, + "flags": 18 + }, + "ApiId": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "DomainName": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.AppSync/DomainNameApiAssociation", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/6" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.AppSync/DomainNameApiAssociation@default", + "scopeType": 0, + "body": { + "$ref": "#/7" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AppSyncRuntime", + "properties": { + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The name of the runtime to use. Currently, the only allowed value is APPSYNC_JS." + }, + "RuntimeVersion": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The version of the runtime to use. Currently, the only allowed version is 1.0.0." + } + } + }, + { + "$type": "ObjectType", + "name": "LambdaConflictHandlerConfig", + "properties": { + "LambdaConflictHandlerArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) for the Lambda function to use as the Conflict Handler." + } + } + }, + { + "$type": "ObjectType", + "name": "SyncConfig", + "properties": { + "ConflictDetection": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The Conflict Detection strategy to use." + }, + "ConflictHandler": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The Conflict Resolution strategy to perform in the event of a conflict." + }, + "LambdaConflictHandlerConfig": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.AppSync/FunctionConfigurationProperties" + }, + { + "$type": "IntegerType" + }, + { + "$type": "ObjectType", + "name": "AWS.AppSync/FunctionConfigurationProperties", + "properties": { + "ApiId": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The AWS AppSync GraphQL API that you want to attach using this function." + }, + "Code": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The resolver code that contains the request and response functions. When code is used, the runtime is required. The runtime value must be APPSYNC_JS." + }, + "CodeS3Location": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The Amazon S3 endpoint (where the code is located??)." + }, + "DataSourceName": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The name of data source this function will attach." + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The function description." + }, + "FunctionArn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The ARN for the function generated by the service" + }, + "FunctionId": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The unique identifier for the function generated by the service" + }, + "FunctionVersion": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The version of the request mapping template. Currently, only the 2018-05-29 version of the template is supported." + }, + "MaxBatchSize": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "The maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a BatchInvoke operation." + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The name of the function." + }, + "RequestMappingTemplate": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template." + }, + "RequestMappingTemplateS3Location": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "Describes a Sync configuration for a resolver. Contains information on which Conflict Detection, as well as Resolution strategy, should be performed when the resolver is invoked." + }, + "ResponseMappingTemplate": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The Function response mapping template." + }, + "ResponseMappingTemplateS3Location": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The location of a response mapping template in an Amazon S3 bucket. Use this if you want to provision with a template file in Amazon S3 rather than embedding it in your CloudFormation template." + }, + "Runtime": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "Describes a runtime used by an AWS AppSync pipeline resolver or AWS AppSync function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified." + }, + "SyncConfig": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "Describes a Sync configuration for a resolver. Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is invoked." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.AppSync/FunctionConfiguration", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/14" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.AppSync/FunctionConfiguration@default", + "scopeType": 0, + "body": { + "$ref": "#/15" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AppSyncRuntime", + "properties": { + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The ``name`` of the runtime to use. Currently, the only allowed value is ``APPSYNC_JS``." + }, + "RuntimeVersion": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The ``version`` of the runtime to use. Currently, the only allowed version is ``1.0.0``." + } + } + }, + { + "$type": "ObjectType", + "name": "CachingConfig", + "properties": { + "CachingKeys": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "The caching keys for a resolver that has caching activated.\n Valid values are entries from the ``$context.arguments``, ``$context.source``, and ``$context.identity`` maps." + }, + "Ttl": { + "type": { + "$ref": "#/13" + }, + "flags": 1, + "description": "The TTL in seconds for a resolver that has caching activated.\n Valid values are 1?3,600 seconds." + } + } + }, + { + "$type": "ObjectType", + "name": "LambdaConflictHandlerConfig", + "properties": { + "LambdaConflictHandlerArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) for the Lambda function to use as the Conflict Handler." + } + } + }, + { + "$type": "ObjectType", + "name": "PipelineConfig", + "properties": { + "Functions": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "A list of ``Function`` objects." + } + } + }, + { + "$type": "ObjectType", + "name": "SyncConfig", + "properties": { + "ConflictDetection": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The Conflict Detection strategy to use.\n + *VERSION*: Detect conflicts based on object versions for this resolver.\n + *NONE*: Do not detect conflicts when invoking this resolver." + }, + "ConflictHandler": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The Conflict Resolution strategy to perform in the event of a conflict.\n + *OPTIMISTIC_CONCURRENCY*: Resolve conflicts by rejecting mutations when versions don't match the latest version at the server.\n + *AUTOMERGE*: Resolve conflicts with the Automerge conflict resolution strategy.\n + *LAMBDA*: Resolve conflicts with an LAMlong function supplied in the ``LambdaConflictHandlerConfig``." + }, + "LambdaConflictHandlerConfig": { + "type": { + "$ref": "#/19" + }, + "flags": 0, + "description": "The ``LambdaConflictHandlerConfig`` when configuring ``LAMBDA`` as the Conflict Handler." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.AppSync/ResolverProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.AppSync/ResolverProperties", + "properties": { + "ApiId": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The APSYlong GraphQL API to which you want to attach this resolver." + }, + "CachingConfig": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "The caching configuration for the resolver." + }, + "Code": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The ``resolver`` code that contains the request and response functions. When code is used, the ``runtime`` is required. The runtime value must be ``APPSYNC_JS``." + }, + "CodeS3Location": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The Amazon S3 endpoint." + }, + "DataSourceName": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The resolver data source name." + }, + "FieldName": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The GraphQL field on a type that invokes the resolver." + }, + "Kind": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The resolver type.\n + *UNIT*: A UNIT resolver type. A UNIT resolver is the default resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source.\n + *PIPELINE*: A PIPELINE resolver type. You can use a PIPELINE resolver to invoke a series of ``Function`` objects in a serial manner. You can use a pipeline resolver to run a GraphQL query against multiple data sources." + }, + "MaxBatchSize": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "The maximum number of resolver request inputs that will be sent to a single LAMlong function in a ``BatchInvoke`` operation." + }, + "MetricsConfig": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Enables or disables enhanced resolver metrics for specified resolvers. Note that ``MetricsConfig`` won't be used unless the ``resolverLevelMetricsBehavior`` value is set to ``PER_RESOLVER_METRICS``. If the ``resolverLevelMetricsBehavior`` is set to ``FULL_REQUEST_RESOLVER_METRICS`` instead, ``MetricsConfig`` will be ignored. However, you can still set its value." + }, + "PipelineConfig": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "Functions linked with the pipeline resolver." + }, + "RequestMappingTemplate": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The request mapping template.\n Request mapping templates are optional when using a Lambda data source. For all other data sources, a request mapping template is required." + }, + "RequestMappingTemplateS3Location": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The location of a request mapping template in an S3 bucket. Use this if you want to provision with a template file in S3 rather than embedding it in your CFNshort template." + }, + "ResolverArn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "" + }, + "ResponseMappingTemplate": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The response mapping template." + }, + "ResponseMappingTemplateS3Location": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The location of a response mapping template in an S3 bucket. Use this if you want to provision with a template file in S3 rather than embedding it in your CFNshort template." + }, + "Runtime": { + "type": { + "$ref": "#/17" + }, + "flags": 0, + "description": "Describes a runtime used by an APSYlong resolver or APSYlong function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified." + }, + "SyncConfig": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "The ``SyncConfig`` for a resolver attached to a versioned data source." + }, + "TypeName": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The GraphQL type that invokes this resolver." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.AppSync/Resolver", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/25" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.AppSync/Resolver@default", + "scopeType": 0, + "body": { + "$ref": "#/26" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "SourceApiAssociationConfig", + "properties": { + "MergeType": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Configuration of the merged behavior for the association. For example when it could be auto or has to be manual." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.AppSync/SourceApiAssociationProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.AppSync/SourceApiAssociationProperties", + "properties": { + "AssociationArn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "ARN of the SourceApiAssociation." + }, + "AssociationId": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "Id of the SourceApiAssociation." + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Description of the SourceApiAssociation." + }, + "LastSuccessfulMergeDate": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "Date of last schema successful merge." + }, + "MergedApiArn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "ARN of the Merged API in the association." + }, + "MergedApiId": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "GraphQLApiId of the Merged API in the association." + }, + "MergedApiIdentifier": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "Identifier of the Merged GraphQLApi to associate. It could be either GraphQLApi ApiId or ARN" + }, + "SourceApiArn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "ARN of the source API in the association." + }, + "SourceApiAssociationConfig": { + "type": { + "$ref": "#/28" + }, + "flags": 0, + "description": "Customized configuration for SourceApiAssociation." + }, + "SourceApiAssociationStatus": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "Current status of SourceApiAssociation." + }, + "SourceApiAssociationStatusDetail": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "Current SourceApiAssociation status details." + }, + "SourceApiId": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "GraphQLApiId of the source API in the association." + }, + "SourceApiIdentifier": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "Identifier of the Source GraphQLApi to associate. It could be either GraphQLApi ApiId or ARN" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.AppSync/SourceApiAssociation", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/30" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.AppSync/SourceApiAssociation@default", + "scopeType": 0, + "body": { + "$ref": "#/31" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.appsync/default/types.md b/artifacts/bicep/aws/aws.appsync/default/types.md index 60edc791..f47b6de2 100644 --- a/artifacts/bicep/aws/aws.appsync/default/types.md +++ b/artifacts/bicep/aws/aws.appsync/default/types.md @@ -3,45 +3,47 @@ ## Resource AWS.AppSync/DomainName@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.AppSync/DomainNameProperties](#awsappsyncdomainnameproperties) (Required): properties of the resource +* **properties**: [AWS.AppSync/DomainNameProperties](#awsappsyncdomainnameproperties) (Required, Identifier): properties of the resource ## Resource AWS.AppSync/DomainNameApiAssociation@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.AppSync/DomainNameApiAssociationProperties](#awsappsyncdomainnameapiassociationproperties) (Required): properties of the resource +* **properties**: [AWS.AppSync/DomainNameApiAssociationProperties](#awsappsyncdomainnameapiassociationproperties) (Required, Identifier): properties of the resource ## Resource AWS.AppSync/FunctionConfiguration@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.AppSync/FunctionConfigurationProperties](#awsappsyncfunctionconfigurationproperties) (Required): properties of the resource +* **properties**: [AWS.AppSync/FunctionConfigurationProperties](#awsappsyncfunctionconfigurationproperties) (Required, Identifier): properties of the resource ## Resource AWS.AppSync/Resolver@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.AppSync/ResolverProperties](#awsappsyncresolverproperties) (Required): properties of the resource +* **properties**: [AWS.AppSync/ResolverProperties](#awsappsyncresolverproperties) (Required, Identifier): properties of the resource ## Resource AWS.AppSync/SourceApiAssociation@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.AppSync/SourceApiAssociationProperties](#awsappsyncsourceapiassociationproperties): properties of the resource +* **properties**: [AWS.AppSync/SourceApiAssociationProperties](#awsappsyncsourceapiassociationproperties) (Identifier): properties of the resource -## AWS.AppSync/DomainNameProperties +## AppSyncRuntime ### Properties -* **AppSyncDomainName**: string (ReadOnly) -* **CertificateArn**: string (Required) -* **Description**: string -* **DomainName**: string (Required, Identifier) -* **HostedZoneId**: string (ReadOnly) +* **Name**: string (Required): The name of the runtime to use. Currently, the only allowed value is APPSYNC_JS. +* **RuntimeVersion**: string (Required): The version of the runtime to use. Currently, the only allowed version is 1.0.0. + +## AppSyncRuntime +### Properties +* **Name**: string (Required): The ``name`` of the runtime to use. Currently, the only allowed value is ``APPSYNC_JS``. +* **RuntimeVersion**: string (Required): The ``version`` of the runtime to use. Currently, the only allowed version is ``1.0.0``. ## AWS.AppSync/DomainNameApiAssociationProperties ### Properties @@ -49,6 +51,14 @@ * **ApiId**: string (Required) * **DomainName**: string (Required) +## AWS.AppSync/DomainNameProperties +### Properties +* **AppSyncDomainName**: string (ReadOnly) +* **CertificateArn**: string (Required) +* **Description**: string +* **DomainName**: string (Required, Identifier) +* **HostedZoneId**: string (ReadOnly) + ## AWS.AppSync/FunctionConfigurationProperties ### Properties * **ApiId**: string (Required): The AWS AppSync GraphQL API that you want to attach using this function. @@ -68,65 +78,30 @@ * **Runtime**: [AppSyncRuntime](#appsyncruntime): Describes a runtime used by an AWS AppSync pipeline resolver or AWS AppSync function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified. * **SyncConfig**: [SyncConfig](#syncconfig): Describes a Sync configuration for a resolver. Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is invoked. -## AppSyncRuntime -### Properties -* **Name**: string (Required): The name of the runtime to use. Currently, the only allowed value is APPSYNC_JS. -* **RuntimeVersion**: string (Required): The version of the runtime to use. Currently, the only allowed version is 1.0.0. - -## SyncConfig -### Properties -* **ConflictDetection**: string (Required): The Conflict Detection strategy to use. -* **ConflictHandler**: string: The Conflict Resolution strategy to perform in the event of a conflict. -* **LambdaConflictHandlerConfig**: [LambdaConflictHandlerConfig](#lambdaconflicthandlerconfig) - -## LambdaConflictHandlerConfig -### Properties -* **LambdaConflictHandlerArn**: string: The Amazon Resource Name (ARN) for the Lambda function to use as the Conflict Handler. - ## AWS.AppSync/ResolverProperties ### Properties -* **ApiId**: string (Required): The AWS AppSync GraphQL API to which you want to attach this resolver. +* **ApiId**: string (Required): The APSYlong GraphQL API to which you want to attach this resolver. * **CachingConfig**: [CachingConfig](#cachingconfig): The caching configuration for the resolver. -* **Code**: string: The resolver code that contains the request and response functions. When code is used, the runtime is required. +* **Code**: string: The ``resolver`` code that contains the request and response functions. When code is used, the ``runtime`` is required. The runtime value must be ``APPSYNC_JS``. * **CodeS3Location**: string (WriteOnly): The Amazon S3 endpoint. * **DataSourceName**: string: The resolver data source name. * **FieldName**: string (Required): The GraphQL field on a type that invokes the resolver. * **Kind**: string: The resolver type. -* **MaxBatchSize**: int: The maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a BatchInvoke operation. + + *UNIT*: A UNIT resolver type. A UNIT resolver is the default resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source. + + *PIPELINE*: A PIPELINE resolver type. You can use a PIPELINE resolver to invoke a series of ``Function`` objects in a serial manner. You can use a pipeline resolver to run a GraphQL query against multiple data sources. +* **MaxBatchSize**: int: The maximum number of resolver request inputs that will be sent to a single LAMlong function in a ``BatchInvoke`` operation. +* **MetricsConfig**: string: Enables or disables enhanced resolver metrics for specified resolvers. Note that ``MetricsConfig`` won't be used unless the ``resolverLevelMetricsBehavior`` value is set to ``PER_RESOLVER_METRICS``. If the ``resolverLevelMetricsBehavior`` is set to ``FULL_REQUEST_RESOLVER_METRICS`` instead, ``MetricsConfig`` will be ignored. However, you can still set its value. * **PipelineConfig**: [PipelineConfig](#pipelineconfig): Functions linked with the pipeline resolver. -* **RequestMappingTemplate**: string: Request mapping templates are optional when using a Lambda data source. For all other data sources, a request mapping template is required. -* **RequestMappingTemplateS3Location**: string (WriteOnly): The location of a request mapping template in an Amazon S3 bucket. Use this if you want to provision with a template file in Amazon S3 rather than embedding it in your CloudFormation template. -* **ResolverArn**: string (ReadOnly, Identifier): The Amazon Resource Name (ARN) for the resolver. +* **RequestMappingTemplate**: string: The request mapping template. + Request mapping templates are optional when using a Lambda data source. For all other data sources, a request mapping template is required. +* **RequestMappingTemplateS3Location**: string (WriteOnly): The location of a request mapping template in an S3 bucket. Use this if you want to provision with a template file in S3 rather than embedding it in your CFNshort template. +* **ResolverArn**: string (ReadOnly, Identifier) * **ResponseMappingTemplate**: string: The response mapping template. -* **ResponseMappingTemplateS3Location**: string (WriteOnly): The location of a response mapping template in an Amazon S3 bucket. Use this if you want to provision with a template file in Amazon S3 rather than embedding it in your CloudFormation template. -* **Runtime**: [AppSyncRuntime](#appsyncruntime): Describes a runtime used by an AWS AppSync pipeline resolver or AWS AppSync function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified. -* **SyncConfig**: [SyncConfig](#syncconfig): The SyncConfig for a resolver attached to a versioned data source. +* **ResponseMappingTemplateS3Location**: string (WriteOnly): The location of a response mapping template in an S3 bucket. Use this if you want to provision with a template file in S3 rather than embedding it in your CFNshort template. +* **Runtime**: [AppSyncRuntime](#appsyncruntime): Describes a runtime used by an APSYlong resolver or APSYlong function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified. +* **SyncConfig**: [SyncConfig](#syncconfig): The ``SyncConfig`` for a resolver attached to a versioned data source. * **TypeName**: string (Required): The GraphQL type that invokes this resolver. -## CachingConfig -### Properties -* **CachingKeys**: string[]: The caching keys for a resolver that has caching activated. Valid values are entries from the $context.arguments, $context.source, and $context.identity maps. -* **Ttl**: int (Required): The TTL in seconds for a resolver that has caching activated. Valid values are 1-36.00 seconds. - -## PipelineConfig -### Properties -* **Functions**: string[]: A list of Function objects. - -## AppSyncRuntime -### Properties -* **Name**: string (Required): The name of the runtime to use. -* **RuntimeVersion**: string (Required): The version of the runtime to use. - -## SyncConfig -### Properties -* **ConflictDetection**: string (Required): The Conflict Detection strategy to use. -* **ConflictHandler**: string: The Conflict Resolution strategy to perform in the event of a conflict. -* **LambdaConflictHandlerConfig**: [LambdaConflictHandlerConfig](#lambdaconflicthandlerconfig) - -## LambdaConflictHandlerConfig -### Properties -* **LambdaConflictHandlerArn**: string: The Amazon Resource Name (ARN) for the Lambda function to use as the Conflict Handler. - ## AWS.AppSync/SourceApiAssociationProperties ### Properties * **AssociationArn**: string (ReadOnly, Identifier): ARN of the SourceApiAssociation. @@ -143,7 +118,43 @@ * **SourceApiId**: string (ReadOnly): GraphQLApiId of the source API in the association. * **SourceApiIdentifier**: string (WriteOnly): Identifier of the Source GraphQLApi to associate. It could be either GraphQLApi ApiId or ARN +## CachingConfig +### Properties +* **CachingKeys**: string[]: The caching keys for a resolver that has caching activated. + Valid values are entries from the ``$context.arguments``, ``$context.source``, and ``$context.identity`` maps. +* **Ttl**: int (Required): The TTL in seconds for a resolver that has caching activated. + Valid values are 1?3,600 seconds. + +## LambdaConflictHandlerConfig +### Properties +* **LambdaConflictHandlerArn**: string: The Amazon Resource Name (ARN) for the Lambda function to use as the Conflict Handler. + +## LambdaConflictHandlerConfig +### Properties +* **LambdaConflictHandlerArn**: string: The Amazon Resource Name (ARN) for the Lambda function to use as the Conflict Handler. + +## PipelineConfig +### Properties +* **Functions**: string[]: A list of ``Function`` objects. + ## SourceApiAssociationConfig ### Properties * **MergeType**: string: Configuration of the merged behavior for the association. For example when it could be auto or has to be manual. +## SyncConfig +### Properties +* **ConflictDetection**: string (Required): The Conflict Detection strategy to use. +* **ConflictHandler**: string: The Conflict Resolution strategy to perform in the event of a conflict. +* **LambdaConflictHandlerConfig**: [LambdaConflictHandlerConfig](#lambdaconflicthandlerconfig) + +## SyncConfig +### Properties +* **ConflictDetection**: string (Required): The Conflict Detection strategy to use. + + *VERSION*: Detect conflicts based on object versions for this resolver. + + *NONE*: Do not detect conflicts when invoking this resolver. +* **ConflictHandler**: string: The Conflict Resolution strategy to perform in the event of a conflict. + + *OPTIMISTIC_CONCURRENCY*: Resolve conflicts by rejecting mutations when versions don't match the latest version at the server. + + *AUTOMERGE*: Resolve conflicts with the Automerge conflict resolution strategy. + + *LAMBDA*: Resolve conflicts with an LAMlong function supplied in the ``LambdaConflictHandlerConfig``. +* **LambdaConflictHandlerConfig**: [LambdaConflictHandlerConfig](#lambdaconflicthandlerconfig): The ``LambdaConflictHandlerConfig`` when configuring ``LAMBDA`` as the Conflict Handler. + diff --git a/artifacts/bicep/aws/aws.aps/default/types.json b/artifacts/bicep/aws/aws.aps/default/types.json index ef8adb82..3322d7d6 100644 --- a/artifacts/bicep/aws/aws.aps/default/types.json +++ b/artifacts/bicep/aws/aws.aps/default/types.json @@ -1 +1,478 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.APS/RuleGroupsNamespaceProperties","Properties":{"Arn":{"Type":4,"Flags":18,"Description":"The RuleGroupsNamespace ARN."},"Data":{"Type":4,"Flags":1,"Description":"The RuleGroupsNamespace data."},"Name":{"Type":4,"Flags":1,"Description":"The RuleGroupsNamespace name."},"Tags":{"Type":10,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."},"Workspace":{"Type":4,"Flags":1,"Description":"Required to identify a specific APS Workspace associated with this RuleGroupsNamespace."}}}},{"3":{"ItemType":8}},{"2":{"Name":"AWS.APS/RuleGroupsNamespace","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":9,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.APS/RuleGroupsNamespace@default","ScopeType":0,"Body":11}},{"2":{"Name":"LoggingConfiguration","Properties":{"LogGroupArn":{"Type":4,"Flags":0,"Description":"CloudWatch log group ARN"}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.APS/WorkspaceProperties","Properties":{"AlertManagerDefinition":{"Type":4,"Flags":0,"Description":"The AMP Workspace alert manager definition data"},"Alias":{"Type":4,"Flags":0,"Description":"AMP Workspace alias."},"Arn":{"Type":4,"Flags":18,"Description":"Workspace arn."},"LoggingConfiguration":{"Type":13,"Flags":0},"PrometheusEndpoint":{"Type":4,"Flags":2,"Description":"AMP Workspace prometheus endpoint"},"Tags":{"Type":16,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."},"WorkspaceId":{"Type":4,"Flags":2,"Description":"Required to identify a specific APS Workspace."}}}},{"3":{"ItemType":14}},{"2":{"Name":"AWS.APS/Workspace","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":15,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.APS/Workspace@default","ScopeType":0,"Body":17}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.APS/RuleGroupsNamespaceProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ObjectType", + "name": "AWS.APS/RuleGroupsNamespaceProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The RuleGroupsNamespace ARN." + }, + "Data": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The RuleGroupsNamespace data." + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The RuleGroupsNamespace name." + }, + "Tags": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + }, + "Workspace": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Required to identify a specific APS Workspace associated with this RuleGroupsNamespace." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.APS/RuleGroupsNamespace", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.APS/RuleGroupsNamespace@default", + "scopeType": 0, + "body": { + "$ref": "#/5" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Destination", + "properties": { + "AmpConfiguration": { + "type": { + "$ref": "#/13" + }, + "flags": 1, + "description": "Configuration for Amazon Managed Prometheus metrics destination" + } + } + }, + { + "$type": "ObjectType", + "name": "ScrapeConfiguration", + "properties": { + "ConfigurationBlob": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Prometheus compatible scrape configuration in base64 encoded blob format" + } + } + }, + { + "$type": "ObjectType", + "name": "SecurityGroupId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Source", + "properties": { + "EksConfiguration": { + "type": { + "$ref": "#/16" + }, + "flags": 1, + "description": "Configuration for EKS metrics source" + } + } + }, + { + "$type": "ObjectType", + "name": "SubnetId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "ObjectType", + "name": "Scraper_AmpConfiguration", + "properties": { + "WorkspaceArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "ARN of an Amazon Managed Prometheus workspace" + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "Scraper_EksConfiguration", + "properties": { + "ClusterArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "ARN of an EKS cluster" + }, + "SecurityGroupIds": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "List of security group IDs" + }, + "SubnetIds": { + "type": { + "$ref": "#/15" + }, + "flags": 1, + "description": "List of subnet IDs" + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.APS/ScraperProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/12" + } + }, + { + "$type": "ObjectType", + "name": "AWS.APS/ScraperProperties", + "properties": { + "Alias": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Scraper alias." + }, + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "Scraper ARN." + }, + "Destination": { + "type": { + "$ref": "#/7" + }, + "flags": 1 + }, + "RoleArn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "IAM role ARN for the scraper." + }, + "ScrapeConfiguration": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + }, + "ScraperId": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "Required to identify a specific scraper." + }, + "Source": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.APS/Scraper", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/19" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.APS/Scraper@default", + "scopeType": 0, + "body": { + "$ref": "#/20" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "LoggingConfiguration", + "properties": { + "LogGroupArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "CloudWatch log group ARN" + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.APS/WorkspaceProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/23" + } + }, + { + "$type": "ObjectType", + "name": "AWS.APS/WorkspaceProperties", + "properties": { + "AlertManagerDefinition": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The AMP Workspace alert manager definition data" + }, + "Alias": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "AMP Workspace alias." + }, + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "Workspace arn." + }, + "KmsKeyArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "KMS Key ARN used to encrypt and decrypt AMP workspace data." + }, + "LoggingConfiguration": { + "type": { + "$ref": "#/22" + }, + "flags": 0 + }, + "PrometheusEndpoint": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "AMP Workspace prometheus endpoint" + }, + "Tags": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + }, + "WorkspaceId": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "Required to identify a specific APS Workspace." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.APS/Workspace", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/26" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.APS/Workspace@default", + "scopeType": 0, + "body": { + "$ref": "#/27" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.aps/default/types.md b/artifacts/bicep/aws/aws.aps/default/types.md index 24741a0e..c4953e34 100644 --- a/artifacts/bicep/aws/aws.aps/default/types.md +++ b/artifacts/bicep/aws/aws.aps/default/types.md @@ -3,16 +3,23 @@ ## Resource AWS.APS/RuleGroupsNamespace@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.APS/RuleGroupsNamespaceProperties](#awsapsrulegroupsnamespaceproperties) (Required): properties of the resource +* **properties**: [AWS.APS/RuleGroupsNamespaceProperties](#awsapsrulegroupsnamespaceproperties) (Required, Identifier): properties of the resource + +## Resource AWS.APS/Scraper@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.APS/ScraperProperties](#awsapsscraperproperties) (Required, Identifier): properties of the resource ## Resource AWS.APS/Workspace@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.APS/WorkspaceProperties](#awsapsworkspaceproperties): properties of the resource +* **properties**: [AWS.APS/WorkspaceProperties](#awsapsworkspaceproperties) (Identifier): properties of the resource ## AWS.APS/RuleGroupsNamespaceProperties ### Properties @@ -22,25 +29,64 @@ * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. * **Workspace**: string (Required): Required to identify a specific APS Workspace associated with this RuleGroupsNamespace. -## Tag +## AWS.APS/ScraperProperties ### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Alias**: string: Scraper alias. +* **Arn**: string (ReadOnly, Identifier): Scraper ARN. +* **Destination**: [Destination](#destination) (Required) +* **RoleArn**: string (ReadOnly): IAM role ARN for the scraper. +* **ScrapeConfiguration**: [ScrapeConfiguration](#scrapeconfiguration) (Required) +* **ScraperId**: string (ReadOnly): Required to identify a specific scraper. +* **Source**: [Source](#source) (Required) +* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. ## AWS.APS/WorkspaceProperties ### Properties * **AlertManagerDefinition**: string: The AMP Workspace alert manager definition data * **Alias**: string: AMP Workspace alias. * **Arn**: string (ReadOnly, Identifier): Workspace arn. +* **KmsKeyArn**: string: KMS Key ARN used to encrypt and decrypt AMP workspace data. * **LoggingConfiguration**: [LoggingConfiguration](#loggingconfiguration) * **PrometheusEndpoint**: string (ReadOnly): AMP Workspace prometheus endpoint * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. * **WorkspaceId**: string (ReadOnly): Required to identify a specific APS Workspace. +## Destination +### Properties +* **AmpConfiguration**: [Scraper_AmpConfiguration](#scraperampconfiguration) (Required): Configuration for Amazon Managed Prometheus metrics destination + ## LoggingConfiguration ### Properties * **LogGroupArn**: string: CloudWatch log group ARN +## ScrapeConfiguration +### Properties +* **ConfigurationBlob**: string (Required): Prometheus compatible scrape configuration in base64 encoded blob format + +## Scraper_AmpConfiguration +### Properties +* **WorkspaceArn**: string (Required): ARN of an Amazon Managed Prometheus workspace + +## Scraper_EksConfiguration +### Properties +* **ClusterArn**: string (Required): ARN of an EKS cluster +* **SecurityGroupIds**: string[]: List of security group IDs +* **SubnetIds**: string[] (Required): List of subnet IDs + +## Source +### Properties +* **EksConfiguration**: [Scraper_EksConfiguration](#scrapereksconfiguration) (Required): Configuration for EKS metrics source + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + ## Tag ### Properties * **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. diff --git a/artifacts/bicep/aws/aws.arczonalshift/default/types.json b/artifacts/bicep/aws/aws.arczonalshift/default/types.json index 6431b3b1..18dce170 100644 --- a/artifacts/bicep/aws/aws.arczonalshift/default/types.json +++ b/artifacts/bicep/aws/aws.arczonalshift/default/types.json @@ -1 +1,151 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"ControlCondition","Properties":{"AlarmIdentifier":{"Type":4,"Flags":1},"Type":{"Type":4,"Flags":1}}}},{"2":{"Name":"ControlConditionType"}},{"2":{"Name":"PracticeRunConfiguration","Properties":{"BlockedDates":{"Type":12,"Flags":0},"BlockedWindows":{"Type":13,"Flags":0},"BlockingAlarms":{"Type":14,"Flags":0},"OutcomeAlarms":{"Type":15,"Flags":1}}}},{"2":{"Name":"ZonalAutoshiftStatus"}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":8}},{"3":{"ItemType":8}},{"2":{"Name":"AWS.ARCZonalShift/ZonalAutoshiftConfigurationProperties","Properties":{"PracticeRunConfiguration":{"Type":10,"Flags":0},"ResourceIdentifier":{"Type":4,"Flags":16},"ZonalAutoshiftStatus":{"Type":4,"Flags":0}}}},{"2":{"Name":"AWS.ARCZonalShift/ZonalAutoshiftConfiguration","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":16,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ARCZonalShift/ZonalAutoshiftConfiguration@default","ScopeType":0,"Body":17}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "ControlCondition", + "properties": { + "AlarmIdentifier": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + }, + "Type": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ControlConditionType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PracticeRunConfiguration", + "properties": { + "BlockedDates": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "BlockedWindows": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "BlockingAlarms": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "OutcomeAlarms": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ZonalAutoshiftStatus", + "properties": {} + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.ARCZonalShift/ZonalAutoshiftConfigurationProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.ARCZonalShift/ZonalAutoshiftConfigurationProperties", + "properties": { + "PracticeRunConfiguration": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "ResourceIdentifier": { + "type": { + "$ref": "#/4" + }, + "flags": 16 + }, + "ZonalAutoshiftStatus": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ARCZonalShift/ZonalAutoshiftConfiguration", + "properties": { + "name": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/10" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ARCZonalShift/ZonalAutoshiftConfiguration@default", + "scopeType": 0, + "body": { + "$ref": "#/11" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.arczonalshift/default/types.md b/artifacts/bicep/aws/aws.arczonalshift/default/types.md index 7fbf4f51..0ae29f7e 100644 --- a/artifacts/bicep/aws/aws.arczonalshift/default/types.md +++ b/artifacts/bicep/aws/aws.arczonalshift/default/types.md @@ -3,9 +3,9 @@ ## Resource AWS.ARCZonalShift/ZonalAutoshiftConfiguration@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ARCZonalShift/ZonalAutoshiftConfigurationProperties](#awsarczonalshiftzonalautoshiftconfigurationproperties): properties of the resource +* **properties**: [AWS.ARCZonalShift/ZonalAutoshiftConfigurationProperties](#awsarczonalshiftzonalautoshiftconfigurationproperties) (Identifier): properties of the resource ## AWS.ARCZonalShift/ZonalAutoshiftConfigurationProperties ### Properties @@ -13,6 +13,11 @@ * **ResourceIdentifier**: string (Identifier) * **ZonalAutoshiftStatus**: string +## ControlCondition +### Properties +* **AlarmIdentifier**: string (Required) +* **Type**: string (Required) + ## PracticeRunConfiguration ### Properties * **BlockedDates**: string[] @@ -20,8 +25,3 @@ * **BlockingAlarms**: [ControlCondition](#controlcondition)[] * **OutcomeAlarms**: [ControlCondition](#controlcondition)[] (Required) -## ControlCondition -### Properties -* **AlarmIdentifier**: string (Required) -* **Type**: string (Required) - diff --git a/artifacts/bicep/aws/aws.athena/default/types.json b/artifacts/bicep/aws/aws.athena/default/types.json index 7ed79c23..43ad3fe6 100644 --- a/artifacts/bicep/aws/aws.athena/default/types.json +++ b/artifacts/bicep/aws/aws.athena/default/types.json @@ -1 +1,918 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"Arn"}},{"2":{"Name":"CapacityAssignment","Properties":{"WorkgroupNames":{"Type":16,"Flags":1}}}},{"2":{"Name":"CapacityAssignmentConfiguration","Properties":{"CapacityAssignments":{"Type":17,"Flags":1}}}},{"2":{"Name":"CapacityAssignments"}},{"2":{"Name":"CapacityReservationStatus"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"WorkgroupName"}},{"2":{"Name":"WorkgroupNames"}},{"3":{"ItemType":4}},{"3":{"ItemType":9}},{"3":{"ItemType":9}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.Athena/CapacityReservationProperties","Properties":{"AllocatedDpus":{"Type":3,"Flags":2,"Description":"The number of DPUs Athena has provisioned and allocated for the reservation"},"Arn":{"Type":4,"Flags":18},"CapacityAssignmentConfiguration":{"Type":10,"Flags":0},"CreationTime":{"Type":4,"Flags":2,"Description":"The date and time the reservation was created."},"LastSuccessfulAllocationTime":{"Type":4,"Flags":2,"Description":"The timestamp when the last successful allocated was made"},"Name":{"Type":4,"Flags":1,"Description":"The reservation name."},"Status":{"Type":4,"Flags":2,"Description":"The status of the reservation."},"Tags":{"Type":21,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."},"TargetDpus":{"Type":3,"Flags":1,"Description":"The number of DPUs to request to be allocated to the reservation."}}}},{"3":{"ItemType":13}},{"2":{"Name":"AWS.Athena/CapacityReservation","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":20,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Athena/CapacityReservation@default","ScopeType":0,"Body":22}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"Tags"}},{"3":{"ItemType":24}},{"2":{"Name":"AWS.Athena/DataCatalogProperties","Properties":{"Description":{"Type":4,"Flags":0,"Description":"A description of the data catalog to be created. "},"Name":{"Type":4,"Flags":17,"Description":"The name of the data catalog to create. The catalog name must be unique for the AWS account and can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen characters. "},"Parameters":{"Type":28,"Flags":0,"Description":"Specifies the Lambda function or functions to use for creating the data catalog. This is a mapping whose values depend on the catalog type. "},"Tags":{"Type":29,"Flags":0,"Description":"A list of comma separated tags to add to the data catalog that is created. "},"Type":{"Type":4,"Flags":1,"Description":"The type of data catalog to create: LAMBDA for a federated catalog, GLUE for AWS Glue Catalog, or HIVE for an external hive metastore. "}}}},{"2":{"Name":"DataCatalog_Parameters","Properties":{}}},{"3":{"ItemType":24}},{"2":{"Name":"AWS.Athena/DataCatalog","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":27,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Athena/DataCatalog@default","ScopeType":0,"Body":30}},{"2":{"Name":"AWS.Athena/PreparedStatementProperties","Properties":{"Description":{"Type":4,"Flags":0,"Description":"The description of the prepared statement."},"QueryStatement":{"Type":4,"Flags":1,"Description":"The query string for the prepared statement."},"StatementName":{"Type":4,"Flags":17,"Description":"The name of the prepared statement."},"WorkGroup":{"Type":4,"Flags":17,"Description":"The name of the workgroup to which the prepared statement belongs."}}}},{"2":{"Name":"AWS.Athena/PreparedStatement","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":32,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Athena/PreparedStatement@default","ScopeType":0,"Body":33}},{"2":{"Name":"AclConfiguration","Properties":{"S3AclOption":{"Type":4,"Flags":1}}}},{"2":{"Name":"AdditionalConfiguration"}},{"2":{"Name":"BytesScannedCutoffPerQuery"}},{"2":{"Name":"CustomerContentEncryptionConfiguration","Properties":{"KmsKey":{"Type":4,"Flags":1}}}},{"2":{"Name":"EffectiveEngineVersion"}},{"2":{"Name":"EncryptionConfiguration","Properties":{"EncryptionOption":{"Type":4,"Flags":1},"KmsKey":{"Type":4,"Flags":0}}}},{"2":{"Name":"EncryptionOption"}},{"2":{"Name":"EnforceWorkGroupConfiguration"}},{"2":{"Name":"EngineVersion","Properties":{"EffectiveEngineVersion":{"Type":4,"Flags":2},"SelectedEngineVersion":{"Type":4,"Flags":0}}}},{"2":{"Name":"ExecutionRole"}},{"2":{"Name":"ExpectedBucketOwner"}},{"2":{"Name":"KmsKey"}},{"2":{"Name":"OutputLocation"}},{"2":{"Name":"PublishCloudWatchMetricsEnabled"}},{"2":{"Name":"RemoveAclConfiguration"}},{"2":{"Name":"RemoveBytesScannedCutoffPerQuery"}},{"2":{"Name":"RemoveCustomerContentEncryptionConfiguration"}},{"2":{"Name":"RemoveEncryptionConfiguration"}},{"2":{"Name":"RemoveExpectedBucketOwner"}},{"2":{"Name":"RemoveOutputLocation"}},{"2":{"Name":"RequesterPaysEnabled"}},{"2":{"Name":"ResultConfiguration","Properties":{"AclConfiguration":{"Type":35,"Flags":0},"EncryptionConfiguration":{"Type":40,"Flags":0},"ExpectedBucketOwner":{"Type":4,"Flags":0},"OutputLocation":{"Type":4,"Flags":0}}}},{"2":{"Name":"ResultConfigurationUpdates","Properties":{"AclConfiguration":{"Type":35,"Flags":0},"EncryptionConfiguration":{"Type":40,"Flags":0},"ExpectedBucketOwner":{"Type":4,"Flags":0},"OutputLocation":{"Type":4,"Flags":0},"RemoveAclConfiguration":{"Type":2,"Flags":0},"RemoveEncryptionConfiguration":{"Type":2,"Flags":0},"RemoveExpectedBucketOwner":{"Type":2,"Flags":0},"RemoveOutputLocation":{"Type":2,"Flags":0}}}},{"2":{"Name":"S3AclOption"}},{"2":{"Name":"SelectedEngineVersion"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"Tags"}},{"2":{"Name":"WorkGroupConfiguration","Properties":{"AdditionalConfiguration":{"Type":4,"Flags":4},"BytesScannedCutoffPerQuery":{"Type":3,"Flags":0},"CustomerContentEncryptionConfiguration":{"Type":38,"Flags":0},"EnforceWorkGroupConfiguration":{"Type":2,"Flags":0},"EngineVersion":{"Type":43,"Flags":0},"ExecutionRole":{"Type":4,"Flags":0},"PublishCloudWatchMetricsEnabled":{"Type":2,"Flags":0},"RequesterPaysEnabled":{"Type":2,"Flags":0},"ResultConfiguration":{"Type":56,"Flags":0}}}},{"2":{"Name":"WorkGroupConfigurationUpdates","Properties":{"AdditionalConfiguration":{"Type":4,"Flags":0},"BytesScannedCutoffPerQuery":{"Type":3,"Flags":0},"CustomerContentEncryptionConfiguration":{"Type":38,"Flags":0},"EnforceWorkGroupConfiguration":{"Type":2,"Flags":0},"EngineVersion":{"Type":43,"Flags":0},"ExecutionRole":{"Type":4,"Flags":0},"PublishCloudWatchMetricsEnabled":{"Type":2,"Flags":0},"RemoveBytesScannedCutoffPerQuery":{"Type":2,"Flags":0},"RemoveCustomerContentEncryptionConfiguration":{"Type":2,"Flags":0},"RequesterPaysEnabled":{"Type":2,"Flags":0},"ResultConfigurationUpdates":{"Type":57,"Flags":0}}}},{"3":{"ItemType":60}},{"2":{"Name":"AWS.Athena/WorkGroupProperties","Properties":{"CreationTime":{"Type":4,"Flags":2,"Description":"The date and time the workgroup was created."},"Description":{"Type":4,"Flags":0,"Description":"The workgroup description."},"Name":{"Type":4,"Flags":17,"Description":"The workGroup name."},"RecursiveDeleteOption":{"Type":2,"Flags":4,"Description":"The option to delete the workgroup and its contents even if the workgroup contains any named queries."},"State":{"Type":4,"Flags":0,"Description":"The state of the workgroup: ENABLED or DISABLED."},"Tags":{"Type":66,"Flags":0,"Description":"One or more tags, separated by commas, that you want to attach to the workgroup as you create it"},"WorkGroupConfiguration":{"Type":62,"Flags":0,"Description":"The workgroup configuration"},"WorkGroupConfigurationUpdates":{"Type":63,"Flags":4,"Description":"The workgroup configuration update object"}}}},{"3":{"ItemType":60}},{"2":{"Name":"AWS.Athena/WorkGroup","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":65,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Athena/WorkGroup@default","ScopeType":0,"Body":67}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Arn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CapacityAssignment", + "properties": { + "WorkgroupNames": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CapacityAssignmentConfiguration", + "properties": { + "CapacityAssignments": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CapacityAssignments", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CapacityReservationStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "WorkgroupName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "WorkgroupNames", + "properties": {} + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/8" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/8" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Athena/CapacityReservationProperties" + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Athena/CapacityReservationProperties", + "properties": { + "AllocatedDpus": { + "type": { + "$ref": "#/14" + }, + "flags": 2, + "description": "The number of DPUs Athena has provisioned and allocated for the reservation" + }, + "Arn": { + "type": { + "$ref": "#/8" + }, + "flags": 18 + }, + "CapacityAssignmentConfiguration": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "CreationTime": { + "type": { + "$ref": "#/8" + }, + "flags": 2, + "description": "The date and time the reservation was created." + }, + "LastSuccessfulAllocationTime": { + "type": { + "$ref": "#/8" + }, + "flags": 2, + "description": "The timestamp when the last successful allocated was made" + }, + "Name": { + "type": { + "$ref": "#/8" + }, + "flags": 1, + "description": "The reservation name." + }, + "Status": { + "type": { + "$ref": "#/8" + }, + "flags": 2, + "description": "The status of the reservation." + }, + "Tags": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + }, + "TargetDpus": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The number of DPUs to request to be allocated to the reservation." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Athena/CapacityReservation", + "properties": { + "name": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/8" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/16" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Athena/CapacityReservation@default", + "scopeType": 0, + "body": { + "$ref": "#/17" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Tags", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/19" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Athena/DataCatalogProperties" + }, + { + "$type": "ObjectType", + "name": "DataCatalog_Parameters", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/19" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Athena/DataCatalogProperties", + "properties": { + "Description": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "A description of the data catalog to be created. " + }, + "Name": { + "type": { + "$ref": "#/8" + }, + "flags": 17, + "description": "The name of the data catalog to create. The catalog name must be unique for the AWS account and can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen characters. " + }, + "Parameters": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "Specifies the Lambda function or functions to use for creating the data catalog. This is a mapping whose values depend on the catalog type. " + }, + "Tags": { + "type": { + "$ref": "#/24" + }, + "flags": 0, + "description": "A list of comma separated tags to add to the data catalog that is created. " + }, + "Type": { + "type": { + "$ref": "#/8" + }, + "flags": 1, + "description": "The type of data catalog to create: LAMBDA for a federated catalog, GLUE for AWS Glue Catalog, or HIVE for an external hive metastore. " + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Athena/DataCatalog", + "properties": { + "name": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/8" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/25" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Athena/DataCatalog@default", + "scopeType": 0, + "body": { + "$ref": "#/26" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.Athena/PreparedStatementProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.Athena/PreparedStatementProperties", + "properties": { + "Description": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The description of the prepared statement." + }, + "QueryStatement": { + "type": { + "$ref": "#/8" + }, + "flags": 1, + "description": "The query string for the prepared statement." + }, + "StatementName": { + "type": { + "$ref": "#/8" + }, + "flags": 17, + "description": "The name of the prepared statement." + }, + "WorkGroup": { + "type": { + "$ref": "#/8" + }, + "flags": 17, + "description": "The name of the workgroup to which the prepared statement belongs." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Athena/PreparedStatement", + "properties": { + "name": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/8" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/29" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Athena/PreparedStatement@default", + "scopeType": 0, + "body": { + "$ref": "#/30" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AclConfiguration", + "properties": { + "S3AclOption": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AdditionalConfiguration", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "BytesScannedCutoffPerQuery", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CustomerContentEncryptionConfiguration", + "properties": { + "KmsKey": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "EffectiveEngineVersion", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "EncryptionConfiguration", + "properties": { + "EncryptionOption": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + }, + "KmsKey": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "EncryptionOption", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "EnforceWorkGroupConfiguration", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "EngineVersion", + "properties": { + "EffectiveEngineVersion": { + "type": { + "$ref": "#/8" + }, + "flags": 2 + }, + "SelectedEngineVersion": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ExecutionRole", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ExpectedBucketOwner", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "KmsKey", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "OutputLocation", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PublishCloudWatchMetricsEnabled", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RemoveAclConfiguration", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RemoveBytesScannedCutoffPerQuery", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RemoveCustomerContentEncryptionConfiguration", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RemoveEncryptionConfiguration", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RemoveExpectedBucketOwner", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RemoveOutputLocation", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RequesterPaysEnabled", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ResultConfiguration", + "properties": { + "AclConfiguration": { + "type": { + "$ref": "#/32" + }, + "flags": 0 + }, + "EncryptionConfiguration": { + "type": { + "$ref": "#/37" + }, + "flags": 0 + }, + "ExpectedBucketOwner": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "OutputLocation": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ResultConfigurationUpdates", + "properties": { + "AclConfiguration": { + "type": { + "$ref": "#/32" + }, + "flags": 0 + }, + "EncryptionConfiguration": { + "type": { + "$ref": "#/37" + }, + "flags": 0 + }, + "ExpectedBucketOwner": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "OutputLocation": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "RemoveAclConfiguration": { + "type": { + "$ref": "#/61" + }, + "flags": 0 + }, + "RemoveEncryptionConfiguration": { + "type": { + "$ref": "#/61" + }, + "flags": 0 + }, + "RemoveExpectedBucketOwner": { + "type": { + "$ref": "#/61" + }, + "flags": 0 + }, + "RemoveOutputLocation": { + "type": { + "$ref": "#/61" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "S3AclOption", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SelectedEngineVersion", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Tags", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "WorkGroupConfiguration", + "properties": { + "AdditionalConfiguration": { + "type": { + "$ref": "#/8" + }, + "flags": 4 + }, + "BytesScannedCutoffPerQuery": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + }, + "CustomerContentEncryptionConfiguration": { + "type": { + "$ref": "#/35" + }, + "flags": 0 + }, + "EnforceWorkGroupConfiguration": { + "type": { + "$ref": "#/61" + }, + "flags": 0 + }, + "EngineVersion": { + "type": { + "$ref": "#/40" + }, + "flags": 0 + }, + "ExecutionRole": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "PublishCloudWatchMetricsEnabled": { + "type": { + "$ref": "#/61" + }, + "flags": 0 + }, + "RequesterPaysEnabled": { + "type": { + "$ref": "#/61" + }, + "flags": 0 + }, + "ResultConfiguration": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "WorkGroupConfigurationUpdates", + "properties": { + "AdditionalConfiguration": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "BytesScannedCutoffPerQuery": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + }, + "CustomerContentEncryptionConfiguration": { + "type": { + "$ref": "#/35" + }, + "flags": 0 + }, + "EnforceWorkGroupConfiguration": { + "type": { + "$ref": "#/61" + }, + "flags": 0 + }, + "EngineVersion": { + "type": { + "$ref": "#/40" + }, + "flags": 0 + }, + "ExecutionRole": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "PublishCloudWatchMetricsEnabled": { + "type": { + "$ref": "#/61" + }, + "flags": 0 + }, + "RemoveBytesScannedCutoffPerQuery": { + "type": { + "$ref": "#/61" + }, + "flags": 0 + }, + "RemoveCustomerContentEncryptionConfiguration": { + "type": { + "$ref": "#/61" + }, + "flags": 0 + }, + "RequesterPaysEnabled": { + "type": { + "$ref": "#/61" + }, + "flags": 0 + }, + "ResultConfigurationUpdates": { + "type": { + "$ref": "#/54" + }, + "flags": 0 + } + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/57" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Athena/WorkGroupProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/57" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Athena/WorkGroupProperties", + "properties": { + "CreationTime": { + "type": { + "$ref": "#/8" + }, + "flags": 2, + "description": "The date and time the workgroup was created." + }, + "Description": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The workgroup description." + }, + "Name": { + "type": { + "$ref": "#/8" + }, + "flags": 17, + "description": "The workGroup name." + }, + "RecursiveDeleteOption": { + "type": { + "$ref": "#/61" + }, + "flags": 4, + "description": "The option to delete the workgroup and its contents even if the workgroup contains any named queries." + }, + "State": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The state of the workgroup: ENABLED or DISABLED." + }, + "Tags": { + "type": { + "$ref": "#/64" + }, + "flags": 0, + "description": "One or more tags, separated by commas, that you want to attach to the workgroup as you create it" + }, + "WorkGroupConfiguration": { + "type": { + "$ref": "#/59" + }, + "flags": 0, + "description": "The workgroup configuration" + }, + "WorkGroupConfigurationUpdates": { + "type": { + "$ref": "#/60" + }, + "flags": 4, + "description": "The workgroup configuration update object" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Athena/WorkGroup", + "properties": { + "name": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/8" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/65" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Athena/WorkGroup@default", + "scopeType": 0, + "body": { + "$ref": "#/66" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.athena/default/types.md b/artifacts/bicep/aws/aws.athena/default/types.md index 0a0b23aa..851dd755 100644 --- a/artifacts/bicep/aws/aws.athena/default/types.md +++ b/artifacts/bicep/aws/aws.athena/default/types.md @@ -3,30 +3,34 @@ ## Resource AWS.Athena/CapacityReservation@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Athena/CapacityReservationProperties](#awsathenacapacityreservationproperties) (Required): properties of the resource +* **properties**: [AWS.Athena/CapacityReservationProperties](#awsathenacapacityreservationproperties) (Required, Identifier): properties of the resource ## Resource AWS.Athena/DataCatalog@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Athena/DataCatalogProperties](#awsathenadatacatalogproperties) (Required): properties of the resource +* **properties**: [AWS.Athena/DataCatalogProperties](#awsathenadatacatalogproperties) (Required, Identifier): properties of the resource ## Resource AWS.Athena/PreparedStatement@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Athena/PreparedStatementProperties](#awsathenapreparedstatementproperties) (Required): properties of the resource +* **properties**: [AWS.Athena/PreparedStatementProperties](#awsathenapreparedstatementproperties) (Required, Identifier): properties of the resource ## Resource AWS.Athena/WorkGroup@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Athena/WorkGroupProperties](#awsathenaworkgroupproperties) (Required): properties of the resource +* **properties**: [AWS.Athena/WorkGroupProperties](#awsathenaworkgroupproperties) (Required, Identifier): properties of the resource + +## AclConfiguration +### Properties +* **S3AclOption**: string (Required) ## AWS.Athena/CapacityReservationProperties ### Properties @@ -40,19 +44,6 @@ * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. * **TargetDpus**: int (Required): The number of DPUs to request to be allocated to the reservation. -## CapacityAssignmentConfiguration -### Properties -* **CapacityAssignments**: [CapacityAssignment](#capacityassignment)[] (Required) - -## CapacityAssignment -### Properties -* **WorkgroupNames**: string[] (Required) - -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - ## AWS.Athena/DataCatalogProperties ### Properties * **Description**: string: A description of the data catalog to be created. @@ -61,14 +52,6 @@ * **Tags**: [Tag](#tag)[]: A list of comma separated tags to add to the data catalog that is created. * **Type**: string (Required): The type of data catalog to create: LAMBDA for a federated catalog, GLUE for AWS Glue Catalog, or HIVE for an external hive metastore. -## DataCatalog_Parameters -### Properties - -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - ## AWS.Athena/PreparedStatementProperties ### Properties * **Description**: string: The description of the prepared statement. @@ -87,27 +70,26 @@ * **WorkGroupConfiguration**: [WorkGroupConfiguration](#workgroupconfiguration): The workgroup configuration * **WorkGroupConfigurationUpdates**: [WorkGroupConfigurationUpdates](#workgroupconfigurationupdates) (WriteOnly): The workgroup configuration update object -## Tag +## CapacityAssignment ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **WorkgroupNames**: string[] (Required) -## WorkGroupConfiguration +## CapacityAssignmentConfiguration ### Properties -* **AdditionalConfiguration**: string (WriteOnly) -* **BytesScannedCutoffPerQuery**: int -* **CustomerContentEncryptionConfiguration**: [CustomerContentEncryptionConfiguration](#customercontentencryptionconfiguration) -* **EnforceWorkGroupConfiguration**: bool -* **EngineVersion**: [EngineVersion](#engineversion) -* **ExecutionRole**: string -* **PublishCloudWatchMetricsEnabled**: bool -* **RequesterPaysEnabled**: bool -* **ResultConfiguration**: [ResultConfiguration](#resultconfiguration) +* **CapacityAssignments**: [CapacityAssignment](#capacityassignment)[] (Required) ## CustomerContentEncryptionConfiguration ### Properties * **KmsKey**: string (Required) +## DataCatalog_Parameters +### Properties + +## EncryptionConfiguration +### Properties +* **EncryptionOption**: string (Required) +* **KmsKey**: string + ## EngineVersion ### Properties * **EffectiveEngineVersion**: string (ReadOnly) @@ -120,14 +102,43 @@ * **ExpectedBucketOwner**: string * **OutputLocation**: string -## AclConfiguration +## ResultConfigurationUpdates ### Properties -* **S3AclOption**: string (Required) +* **AclConfiguration**: [AclConfiguration](#aclconfiguration) +* **EncryptionConfiguration**: [EncryptionConfiguration](#encryptionconfiguration) +* **ExpectedBucketOwner**: string +* **OutputLocation**: string +* **RemoveAclConfiguration**: bool +* **RemoveEncryptionConfiguration**: bool +* **RemoveExpectedBucketOwner**: bool +* **RemoveOutputLocation**: bool -## EncryptionConfiguration +## Tag ### Properties -* **EncryptionOption**: string (Required) -* **KmsKey**: string +* **Key**: string (Required) +* **Value**: string (Required) + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + +## WorkGroupConfiguration +### Properties +* **AdditionalConfiguration**: string (WriteOnly) +* **BytesScannedCutoffPerQuery**: int +* **CustomerContentEncryptionConfiguration**: [CustomerContentEncryptionConfiguration](#customercontentencryptionconfiguration) +* **EnforceWorkGroupConfiguration**: bool +* **EngineVersion**: [EngineVersion](#engineversion) +* **ExecutionRole**: string +* **PublishCloudWatchMetricsEnabled**: bool +* **RequesterPaysEnabled**: bool +* **ResultConfiguration**: [ResultConfiguration](#resultconfiguration) ## WorkGroupConfigurationUpdates ### Properties @@ -143,14 +154,3 @@ * **RequesterPaysEnabled**: bool * **ResultConfigurationUpdates**: [ResultConfigurationUpdates](#resultconfigurationupdates) -## ResultConfigurationUpdates -### Properties -* **AclConfiguration**: [AclConfiguration](#aclconfiguration) -* **EncryptionConfiguration**: [EncryptionConfiguration](#encryptionconfiguration) -* **ExpectedBucketOwner**: string -* **OutputLocation**: string -* **RemoveAclConfiguration**: bool -* **RemoveEncryptionConfiguration**: bool -* **RemoveExpectedBucketOwner**: bool -* **RemoveOutputLocation**: bool - diff --git a/artifacts/bicep/aws/aws.auditmanager/default/types.json b/artifacts/bicep/aws/aws.auditmanager/default/types.json index 149c8cb8..55b16886 100644 --- a/artifacts/bicep/aws/aws.auditmanager/default/types.json +++ b/artifacts/bicep/aws/aws.auditmanager/default/types.json @@ -1 +1,444 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"AWSAccount","Properties":{"EmailAddress":{"Type":4,"Flags":0},"Id":{"Type":4,"Flags":0},"Name":{"Type":4,"Flags":0}}}},{"2":{"Name":"AWSService","Properties":{"ServiceName":{"Type":4,"Flags":0}}}},{"2":{"Name":"AWSServiceName"}},{"2":{"Name":"AccountId"}},{"2":{"Name":"AccountName"}},{"2":{"Name":"AssessmentArn"}},{"2":{"Name":"AssessmentDescription"}},{"2":{"Name":"AssessmentName"}},{"2":{"Name":"AssessmentReportDestinationType"}},{"2":{"Name":"AssessmentReportsDestination","Properties":{"Destination":{"Type":4,"Flags":0},"DestinationType":{"Type":4,"Flags":0}}}},{"2":{"Name":"AssessmentStatus"}},{"2":{"Name":"ControlSetId"}},{"2":{"Name":"CreatedBy"}},{"2":{"Name":"Delegation","Properties":{"AssessmentId":{"Type":4,"Flags":16},"AssessmentName":{"Type":4,"Flags":0},"Comment":{"Type":4,"Flags":0},"ControlSetId":{"Type":4,"Flags":0},"CreatedBy":{"Type":4,"Flags":0},"CreationTime":{"Type":3,"Flags":0},"Id":{"Type":4,"Flags":0},"LastUpdated":{"Type":3,"Flags":0},"RoleArn":{"Type":4,"Flags":0},"RoleType":{"Type":4,"Flags":0},"Status":{"Type":4,"Flags":0}}}},{"2":{"Name":"DelegationComment"}},{"2":{"Name":"DelegationStatus"}},{"2":{"Name":"EmailAddress"}},{"2":{"Name":"FrameworkId"}},{"2":{"Name":"IamArn"}},{"2":{"Name":"Role","Properties":{"RoleArn":{"Type":4,"Flags":0},"RoleType":{"Type":4,"Flags":0}}}},{"2":{"Name":"RoleType"}},{"2":{"Name":"S3Url"}},{"2":{"Name":"Scope","Properties":{"AwsAccounts":{"Type":34,"Flags":0,"Description":"The AWS accounts included in scope."},"AwsServices":{"Type":35,"Flags":0,"Description":"The AWS services included in scope."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}}}},{"2":{"Name":"Timestamp"}},{"2":{"Name":"UUID"}},{"3":{"ItemType":8}},{"3":{"ItemType":9}},{"2":{"Name":"AWS.AuditManager/AssessmentProperties","Properties":{"Arn":{"Type":4,"Flags":2},"AssessmentId":{"Type":4,"Flags":18},"AssessmentReportsDestination":{"Type":17,"Flags":0},"AwsAccount":{"Type":8,"Flags":0},"CreationTime":{"Type":3,"Flags":2},"Delegations":{"Type":37,"Flags":0,"Description":"The list of delegations."},"Description":{"Type":4,"Flags":4},"FrameworkId":{"Type":4,"Flags":0},"Name":{"Type":4,"Flags":4},"Roles":{"Type":38,"Flags":0,"Description":"The list of roles for the specified assessment."},"Scope":{"Type":30,"Flags":0},"Status":{"Type":4,"Flags":0},"Tags":{"Type":39,"Flags":0,"Description":"The tags associated with the assessment."}}}},{"3":{"ItemType":21}},{"3":{"ItemType":27}},{"3":{"ItemType":31}},{"2":{"Name":"AWS.AuditManager/Assessment","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":36,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.AuditManager/Assessment@default","ScopeType":0,"Body":40}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "AWSAccount", + "properties": { + "EmailAddress": { + "type": { + "$ref": "#/26" + }, + "flags": 0 + }, + "Id": { + "type": { + "$ref": "#/26" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/26" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWSService", + "properties": { + "ServiceName": { + "type": { + "$ref": "#/26" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWSServiceName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AccountId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AccountName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AssessmentArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AssessmentDescription", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AssessmentName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AssessmentReportDestinationType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AssessmentReportsDestination", + "properties": { + "Destination": { + "type": { + "$ref": "#/26" + }, + "flags": 0 + }, + "DestinationType": { + "type": { + "$ref": "#/26" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AssessmentStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ControlSetId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CreatedBy", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Delegation", + "properties": { + "AssessmentId": { + "type": { + "$ref": "#/26" + }, + "flags": 16 + }, + "AssessmentName": { + "type": { + "$ref": "#/26" + }, + "flags": 0 + }, + "Comment": { + "type": { + "$ref": "#/26" + }, + "flags": 0 + }, + "ControlSetId": { + "type": { + "$ref": "#/26" + }, + "flags": 0 + }, + "CreatedBy": { + "type": { + "$ref": "#/26" + }, + "flags": 0 + }, + "CreationTime": { + "type": { + "$ref": "#/27" + }, + "flags": 0 + }, + "Id": { + "type": { + "$ref": "#/26" + }, + "flags": 0 + }, + "LastUpdated": { + "type": { + "$ref": "#/27" + }, + "flags": 0 + }, + "RoleArn": { + "type": { + "$ref": "#/26" + }, + "flags": 0 + }, + "RoleType": { + "type": { + "$ref": "#/26" + }, + "flags": 0 + }, + "Status": { + "type": { + "$ref": "#/26" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DelegationComment", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DelegationStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "EmailAddress", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "FrameworkId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "IamArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Role", + "properties": { + "RoleArn": { + "type": { + "$ref": "#/26" + }, + "flags": 0 + }, + "RoleType": { + "type": { + "$ref": "#/26" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "RoleType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "S3Url", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Scope", + "properties": { + "AwsAccounts": { + "type": { + "$ref": "#/28" + }, + "flags": 0, + "description": "The AWS accounts included in scope." + }, + "AwsServices": { + "type": { + "$ref": "#/29" + }, + "flags": 0, + "description": "The AWS services included in scope." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/26" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + }, + "Value": { + "type": { + "$ref": "#/26" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + } + } + }, + { + "$type": "ObjectType", + "name": "Timestamp", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "UUID", + "properties": {} + }, + { + "$type": "StringType" + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.AuditManager/AssessmentProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/19" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/23" + } + }, + { + "$type": "ObjectType", + "name": "AWS.AuditManager/AssessmentProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/26" + }, + "flags": 2 + }, + "AssessmentId": { + "type": { + "$ref": "#/26" + }, + "flags": 18 + }, + "AssessmentReportsDestination": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "AwsAccount": { + "type": { + "$ref": "#/0" + }, + "flags": 0 + }, + "CreationTime": { + "type": { + "$ref": "#/27" + }, + "flags": 2 + }, + "Delegations": { + "type": { + "$ref": "#/31" + }, + "flags": 0, + "description": "The list of delegations." + }, + "Description": { + "type": { + "$ref": "#/26" + }, + "flags": 4 + }, + "FrameworkId": { + "type": { + "$ref": "#/26" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/26" + }, + "flags": 4 + }, + "Roles": { + "type": { + "$ref": "#/32" + }, + "flags": 0, + "description": "The list of roles for the specified assessment." + }, + "Scope": { + "type": { + "$ref": "#/22" + }, + "flags": 0 + }, + "Status": { + "type": { + "$ref": "#/26" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/33" + }, + "flags": 0, + "description": "The tags associated with the assessment." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.AuditManager/Assessment", + "properties": { + "name": { + "type": { + "$ref": "#/26" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/26" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/34" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.AuditManager/Assessment@default", + "scopeType": 0, + "body": { + "$ref": "#/35" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.auditmanager/default/types.md b/artifacts/bicep/aws/aws.auditmanager/default/types.md index 3138e9aa..c6e97d92 100644 --- a/artifacts/bicep/aws/aws.auditmanager/default/types.md +++ b/artifacts/bicep/aws/aws.auditmanager/default/types.md @@ -3,9 +3,14 @@ ## Resource AWS.AuditManager/Assessment@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.AuditManager/AssessmentProperties](#awsauditmanagerassessmentproperties): properties of the resource +* **properties**: [AWS.AuditManager/AssessmentProperties](#awsauditmanagerassessmentproperties) (Identifier): properties of the resource + +## AssessmentReportsDestination +### Properties +* **Destination**: string +* **DestinationType**: string ## AWS.AuditManager/AssessmentProperties ### Properties @@ -23,17 +28,16 @@ * **Status**: string * **Tags**: [Tag](#tag)[]: The tags associated with the assessment. -## AssessmentReportsDestination -### Properties -* **Destination**: string -* **DestinationType**: string - ## AWSAccount ### Properties * **EmailAddress**: string * **Id**: string * **Name**: string +## AWSService +### Properties +* **ServiceName**: string + ## Delegation ### Properties * **AssessmentId**: string (Identifier) @@ -58,10 +62,6 @@ * **AwsAccounts**: [AWSAccount](#awsaccount)[]: The AWS accounts included in scope. * **AwsServices**: [AWSService](#awsservice)[]: The AWS services included in scope. -## AWSService -### Properties -* **ServiceName**: string - ## Tag ### Properties * **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. diff --git a/artifacts/bicep/aws/aws.autoscaling/default/types.json b/artifacts/bicep/aws/aws.autoscaling/default/types.json index 5134b6b5..07edbb16 100644 --- a/artifacts/bicep/aws/aws.autoscaling/default/types.json +++ b/artifacts/bicep/aws/aws.autoscaling/default/types.json @@ -1 +1,1982 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"AcceleratorCountRequest","Properties":{"Max":{"Type":3,"Flags":0},"Min":{"Type":3,"Flags":0}}}},{"2":{"Name":"AcceleratorTotalMemoryMiBRequest","Properties":{"Max":{"Type":3,"Flags":0},"Min":{"Type":3,"Flags":0}}}},{"2":{"Name":"BaselineEbsBandwidthMbpsRequest","Properties":{"Max":{"Type":3,"Flags":0},"Min":{"Type":3,"Flags":0}}}},{"2":{"Name":"InstanceMaintenancePolicy","Properties":{"MaxHealthyPercentage":{"Type":3,"Flags":0},"MinHealthyPercentage":{"Type":3,"Flags":0}}}},{"2":{"Name":"InstanceRequirements","Properties":{"AcceleratorCount":{"Type":8,"Flags":0},"AcceleratorManufacturers":{"Type":28,"Flags":0},"AcceleratorNames":{"Type":29,"Flags":0},"AcceleratorTotalMemoryMiB":{"Type":9,"Flags":0},"AcceleratorTypes":{"Type":30,"Flags":0},"AllowedInstanceTypes":{"Type":31,"Flags":0},"BareMetal":{"Type":4,"Flags":0},"BaselineEbsBandwidthMbps":{"Type":10,"Flags":0},"BurstablePerformance":{"Type":4,"Flags":0},"CpuManufacturers":{"Type":32,"Flags":0},"ExcludedInstanceTypes":{"Type":33,"Flags":0},"InstanceGenerations":{"Type":34,"Flags":0},"LocalStorage":{"Type":4,"Flags":0},"LocalStorageTypes":{"Type":35,"Flags":0},"MemoryGiBPerVCpu":{"Type":18,"Flags":0},"MemoryMiB":{"Type":19,"Flags":1},"NetworkBandwidthGbps":{"Type":22,"Flags":0},"NetworkInterfaceCount":{"Type":23,"Flags":0},"OnDemandMaxPricePercentageOverLowestPrice":{"Type":3,"Flags":0},"RequireHibernateSupport":{"Type":2,"Flags":0},"SpotMaxPricePercentageOverLowestPrice":{"Type":3,"Flags":0},"TotalLocalStorageGB":{"Type":26,"Flags":0},"VCpuCount":{"Type":27,"Flags":1}}}},{"2":{"Name":"InstancesDistribution","Properties":{"OnDemandAllocationStrategy":{"Type":4,"Flags":0},"OnDemandBaseCapacity":{"Type":3,"Flags":0},"OnDemandPercentageAboveBaseCapacity":{"Type":3,"Flags":0},"SpotAllocationStrategy":{"Type":4,"Flags":0},"SpotInstancePools":{"Type":3,"Flags":0},"SpotMaxPrice":{"Type":4,"Flags":0}}}},{"2":{"Name":"LaunchTemplate","Properties":{"LaunchTemplateSpecification":{"Type":16,"Flags":1},"Overrides":{"Type":36,"Flags":0}}}},{"2":{"Name":"LaunchTemplateOverrides","Properties":{"InstanceRequirements":{"Type":12,"Flags":0},"InstanceType":{"Type":4,"Flags":0},"LaunchTemplateSpecification":{"Type":16,"Flags":0},"WeightedCapacity":{"Type":4,"Flags":0}}}},{"2":{"Name":"LaunchTemplateSpecification","Properties":{"LaunchTemplateId":{"Type":4,"Flags":0},"LaunchTemplateName":{"Type":4,"Flags":0},"Version":{"Type":4,"Flags":1}}}},{"2":{"Name":"LifecycleHookSpecification","Properties":{"DefaultResult":{"Type":4,"Flags":0},"HeartbeatTimeout":{"Type":3,"Flags":0},"LifecycleHookName":{"Type":4,"Flags":1},"LifecycleTransition":{"Type":4,"Flags":1},"NotificationMetadata":{"Type":4,"Flags":0},"NotificationTargetARN":{"Type":4,"Flags":0},"RoleARN":{"Type":4,"Flags":0}}}},{"2":{"Name":"MemoryGiBPerVCpuRequest","Properties":{"Max":{"Type":3,"Flags":0},"Min":{"Type":3,"Flags":0}}}},{"2":{"Name":"MemoryMiBRequest","Properties":{"Max":{"Type":3,"Flags":0},"Min":{"Type":3,"Flags":0}}}},{"2":{"Name":"MetricsCollection","Properties":{"Granularity":{"Type":4,"Flags":1},"Metrics":{"Type":37,"Flags":0}}}},{"2":{"Name":"MixedInstancesPolicy","Properties":{"InstancesDistribution":{"Type":13,"Flags":0},"LaunchTemplate":{"Type":14,"Flags":1}}}},{"2":{"Name":"NetworkBandwidthGbpsRequest","Properties":{"Max":{"Type":3,"Flags":0},"Min":{"Type":3,"Flags":0}}}},{"2":{"Name":"NetworkInterfaceCountRequest","Properties":{"Max":{"Type":3,"Flags":0},"Min":{"Type":3,"Flags":0}}}},{"2":{"Name":"NotificationConfiguration","Properties":{"NotificationTypes":{"Type":38,"Flags":0},"TopicARN":{"Type":40,"Flags":1}}}},{"2":{"Name":"TagProperty","Properties":{"Key":{"Type":4,"Flags":1},"PropagateAtLaunch":{"Type":2,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"TotalLocalStorageGBRequest","Properties":{"Max":{"Type":3,"Flags":0},"Min":{"Type":3,"Flags":0}}}},{"2":{"Name":"VCpuCountRequest","Properties":{"Max":{"Type":3,"Flags":0},"Min":{"Type":3,"Flags":0}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":15}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"5":{"Elements":[4,39]}},{"2":{"Name":"AWS.AutoScaling/AutoScalingGroupProperties","Properties":{"AutoScalingGroupName":{"Type":4,"Flags":16},"AvailabilityZones":{"Type":42,"Flags":0},"CapacityRebalance":{"Type":2,"Flags":0},"Context":{"Type":4,"Flags":0},"Cooldown":{"Type":4,"Flags":0},"DefaultInstanceWarmup":{"Type":3,"Flags":0},"DesiredCapacity":{"Type":4,"Flags":0},"DesiredCapacityType":{"Type":4,"Flags":0},"HealthCheckGracePeriod":{"Type":3,"Flags":0},"HealthCheckType":{"Type":4,"Flags":0},"InstanceId":{"Type":4,"Flags":4},"InstanceMaintenancePolicy":{"Type":11,"Flags":0},"LaunchConfigurationName":{"Type":4,"Flags":0},"LaunchTemplate":{"Type":16,"Flags":0},"LifecycleHookSpecificationList":{"Type":43,"Flags":0},"LoadBalancerNames":{"Type":44,"Flags":0},"MaxInstanceLifetime":{"Type":3,"Flags":0},"MaxSize":{"Type":4,"Flags":1},"MetricsCollection":{"Type":45,"Flags":0},"MinSize":{"Type":4,"Flags":1},"MixedInstancesPolicy":{"Type":21,"Flags":0},"NewInstancesProtectedFromScaleIn":{"Type":2,"Flags":0},"NotificationConfiguration":{"Type":24,"Flags":0},"NotificationConfigurations":{"Type":46,"Flags":0},"PlacementGroup":{"Type":4,"Flags":0},"ServiceLinkedRoleARN":{"Type":4,"Flags":0},"Tags":{"Type":47,"Flags":0},"TargetGroupARNs":{"Type":48,"Flags":0},"TerminationPolicies":{"Type":49,"Flags":0},"VPCZoneIdentifier":{"Type":50,"Flags":0}}}},{"3":{"ItemType":4}},{"3":{"ItemType":17}},{"3":{"ItemType":4}},{"3":{"ItemType":20}},{"3":{"ItemType":24}},{"3":{"ItemType":25}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.AutoScaling/AutoScalingGroup","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":41,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.AutoScaling/AutoScalingGroup@default","ScopeType":0,"Body":51}},{"2":{"Name":"AWS.AutoScaling/LifecycleHookProperties","Properties":{"AutoScalingGroupName":{"Type":4,"Flags":17,"Description":"The name of the Auto Scaling group for the lifecycle hook."},"DefaultResult":{"Type":4,"Flags":0,"Description":"The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. The valid values are CONTINUE and ABANDON (default)."},"HeartbeatTimeout":{"Type":3,"Flags":0,"Description":"The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from 30 to 7200 seconds. The default value is 3600 seconds (1 hour). If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult property."},"LifecycleHookName":{"Type":4,"Flags":16,"Description":"The name of the lifecycle hook."},"LifecycleTransition":{"Type":4,"Flags":1,"Description":"The instance state to which you want to attach the lifecycle hook."},"NotificationMetadata":{"Type":4,"Flags":0,"Description":"Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the notification target."},"NotificationTargetARN":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. You can specify an Amazon SQS queue or an Amazon SNS topic. The notification message includes the following information: lifecycle action token, user account ID, Auto Scaling group name, lifecycle hook name, instance ID, lifecycle transition, and notification metadata."},"RoleARN":{"Type":4,"Flags":0,"Description":"The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue."}}}},{"2":{"Name":"AWS.AutoScaling/LifecycleHook","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":53,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.AutoScaling/LifecycleHook@default","ScopeType":0,"Body":54}},{"2":{"Name":"CustomizedMetricSpecification","Properties":{"Dimensions":{"Type":72,"Flags":0},"MetricName":{"Type":4,"Flags":1},"Namespace":{"Type":4,"Flags":1},"Statistic":{"Type":4,"Flags":1},"Unit":{"Type":4,"Flags":0}}}},{"2":{"Name":"Metric","Properties":{"Dimensions":{"Type":73,"Flags":0},"MetricName":{"Type":4,"Flags":1},"Namespace":{"Type":4,"Flags":1}}}},{"2":{"Name":"MetricDataQuery","Properties":{"Expression":{"Type":4,"Flags":0},"Id":{"Type":4,"Flags":1},"Label":{"Type":4,"Flags":0},"MetricStat":{"Type":60,"Flags":0},"ReturnData":{"Type":2,"Flags":0}}}},{"2":{"Name":"MetricDimension","Properties":{"Name":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"MetricStat","Properties":{"Metric":{"Type":57,"Flags":1},"Stat":{"Type":4,"Flags":1},"Unit":{"Type":4,"Flags":0}}}},{"2":{"Name":"PredefinedMetricSpecification","Properties":{"PredefinedMetricType":{"Type":4,"Flags":1},"ResourceLabel":{"Type":4,"Flags":0}}}},{"2":{"Name":"PredictiveScalingConfiguration","Properties":{"MaxCapacityBreachBehavior":{"Type":4,"Flags":0},"MaxCapacityBuffer":{"Type":3,"Flags":0},"MetricSpecifications":{"Type":74,"Flags":1},"Mode":{"Type":4,"Flags":0},"SchedulingBufferTime":{"Type":3,"Flags":0}}}},{"2":{"Name":"PredictiveScalingCustomizedCapacityMetric","Properties":{"MetricDataQueries":{"Type":75,"Flags":1}}}},{"2":{"Name":"PredictiveScalingCustomizedLoadMetric","Properties":{"MetricDataQueries":{"Type":76,"Flags":1}}}},{"2":{"Name":"PredictiveScalingCustomizedScalingMetric","Properties":{"MetricDataQueries":{"Type":77,"Flags":1}}}},{"2":{"Name":"PredictiveScalingMetricSpecification","Properties":{"CustomizedCapacityMetricSpecification":{"Type":63,"Flags":0},"CustomizedLoadMetricSpecification":{"Type":64,"Flags":0},"CustomizedScalingMetricSpecification":{"Type":65,"Flags":0},"PredefinedLoadMetricSpecification":{"Type":67,"Flags":0},"PredefinedMetricPairSpecification":{"Type":68,"Flags":0},"PredefinedScalingMetricSpecification":{"Type":69,"Flags":0},"TargetValue":{"Type":3,"Flags":1}}}},{"2":{"Name":"PredictiveScalingPredefinedLoadMetric","Properties":{"PredefinedMetricType":{"Type":4,"Flags":1},"ResourceLabel":{"Type":4,"Flags":0}}}},{"2":{"Name":"PredictiveScalingPredefinedMetricPair","Properties":{"PredefinedMetricType":{"Type":4,"Flags":1},"ResourceLabel":{"Type":4,"Flags":0}}}},{"2":{"Name":"PredictiveScalingPredefinedScalingMetric","Properties":{"PredefinedMetricType":{"Type":4,"Flags":1},"ResourceLabel":{"Type":4,"Flags":0}}}},{"2":{"Name":"StepAdjustment","Properties":{"MetricIntervalLowerBound":{"Type":3,"Flags":0},"MetricIntervalUpperBound":{"Type":3,"Flags":0},"ScalingAdjustment":{"Type":3,"Flags":1}}}},{"2":{"Name":"TargetTrackingConfiguration","Properties":{"CustomizedMetricSpecification":{"Type":56,"Flags":0},"DisableScaleIn":{"Type":2,"Flags":0},"PredefinedMetricSpecification":{"Type":61,"Flags":0},"TargetValue":{"Type":3,"Flags":1}}}},{"3":{"ItemType":59}},{"3":{"ItemType":59}},{"3":{"ItemType":66}},{"3":{"ItemType":58}},{"3":{"ItemType":58}},{"3":{"ItemType":58}},{"2":{"Name":"AWS.AutoScaling/ScalingPolicyProperties","Properties":{"AdjustmentType":{"Type":4,"Flags":0,"Description":"Specifies how the scaling adjustment is interpreted. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity."},"Arn":{"Type":4,"Flags":18,"Description":"The ARN of the AutoScaling scaling policy"},"AutoScalingGroupName":{"Type":4,"Flags":1,"Description":"The name of the Auto Scaling group."},"Cooldown":{"Type":4,"Flags":0,"Description":"The duration of the policy's cooldown period, in seconds. When a cooldown period is specified here, it overrides the default cooldown period defined for the Auto Scaling group."},"EstimatedInstanceWarmup":{"Type":3,"Flags":0,"Description":"The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. If not provided, the default is to use the value from the default cooldown period for the Auto Scaling group. Valid only if the policy type is TargetTrackingScaling or StepScaling."},"MetricAggregationType":{"Type":4,"Flags":0,"Description":"The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average. Valid only if the policy type is StepScaling."},"MinAdjustmentMagnitude":{"Type":3,"Flags":0,"Description":"The minimum value to scale by when the adjustment type is PercentChangeInCapacity. For example, suppose that you create a step scaling policy to scale out an Auto Scaling group by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the group has 4 instances and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Amazon EC2 Auto Scaling scales out the group by 2 instances."},"PolicyName":{"Type":4,"Flags":2},"PolicyType":{"Type":4,"Flags":0,"Description":"One of the following policy types: TargetTrackingScaling, StepScaling, SimpleScaling (default), PredictiveScaling"},"PredictiveScalingConfiguration":{"Type":62,"Flags":0,"Description":"A predictive scaling policy. Includes support for predefined metrics only."},"ScalingAdjustment":{"Type":3,"Flags":0,"Description":"The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity. For exact capacity, you must specify a positive value. Required if the policy type is SimpleScaling. (Not used with any other policy type.)"},"StepAdjustments":{"Type":79,"Flags":0,"Description":"A set of adjustments that enable you to scale based on the size of the alarm breach. Required if the policy type is StepScaling. (Not used with any other policy type.)"},"TargetTrackingConfiguration":{"Type":71,"Flags":0,"Description":"A target tracking scaling policy. Includes support for predefined or customized metrics."}}}},{"3":{"ItemType":70}},{"2":{"Name":"AWS.AutoScaling/ScalingPolicy","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":78,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.AutoScaling/ScalingPolicy@default","ScopeType":0,"Body":80}},{"2":{"Name":"AWS.AutoScaling/ScheduledActionProperties","Properties":{"AutoScalingGroupName":{"Type":4,"Flags":17,"Description":"The name of the Auto Scaling group."},"DesiredCapacity":{"Type":3,"Flags":0,"Description":"The desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain."},"EndTime":{"Type":4,"Flags":0,"Description":"The latest scheduled start time to return. If scheduled action names are provided, this parameter is ignored."},"MaxSize":{"Type":3,"Flags":0,"Description":"The minimum size of the Auto Scaling group."},"MinSize":{"Type":3,"Flags":0,"Description":"The minimum size of the Auto Scaling group."},"Recurrence":{"Type":4,"Flags":0,"Description":"The recurring schedule for the action, in Unix cron syntax format. When StartTime and EndTime are specified with Recurrence , they form the boundaries of when the recurring action starts and stops."},"ScheduledActionName":{"Type":4,"Flags":18,"Description":"Auto-generated unique identifier"},"StartTime":{"Type":4,"Flags":0,"Description":"The earliest scheduled start time to return. If scheduled action names are provided, this parameter is ignored."},"TimeZone":{"Type":4,"Flags":0,"Description":"The time zone for the cron expression."}}}},{"2":{"Name":"AWS.AutoScaling/ScheduledAction","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":82,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.AutoScaling/ScheduledAction@default","ScopeType":0,"Body":83}},{"2":{"Name":"InstanceReusePolicy","Properties":{"ReuseOnScaleIn":{"Type":2,"Flags":0}}}},{"2":{"Name":"AWS.AutoScaling/WarmPoolProperties","Properties":{"AutoScalingGroupName":{"Type":4,"Flags":17},"InstanceReusePolicy":{"Type":85,"Flags":0},"MaxGroupPreparedCapacity":{"Type":3,"Flags":0},"MinSize":{"Type":3,"Flags":0},"PoolState":{"Type":4,"Flags":0}}}},{"2":{"Name":"AWS.AutoScaling/WarmPool","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":86,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.AutoScaling/WarmPool@default","ScopeType":0,"Body":87}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "AcceleratorCountRequest", + "properties": { + "Max": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "The maximum value." + }, + "Min": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "The minimum value." + } + } + }, + { + "$type": "ObjectType", + "name": "AcceleratorTotalMemoryMiBRequest", + "properties": { + "Max": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "The memory maximum in MiB." + }, + "Min": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "The memory minimum in MiB." + } + } + }, + { + "$type": "ObjectType", + "name": "BaselineEbsBandwidthMbpsRequest", + "properties": { + "Max": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "The maximum value in Mbps." + }, + "Min": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "The minimum value in Mbps." + } + } + }, + { + "$type": "ObjectType", + "name": "InstanceMaintenancePolicy", + "properties": { + "MaxHealthyPercentage": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "Specifies the upper threshold as a percentage of the desired capacity of the Auto Scaling group. It represents the maximum percentage of the group that can be in service and healthy, or pending, to support your workload when replacing instances. Value range is 100 to 200. To clear a previously set value, specify a value of ``-1``.\n Both ``MinHealthyPercentage`` and ``MaxHealthyPercentage`` must be specified, and the difference between them cannot be greater than 100. A large range increases the number of instances that can be replaced at the same time." + }, + "MinHealthyPercentage": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "Specifies the lower threshold as a percentage of the desired capacity of the Auto Scaling group. It represents the minimum percentage of the group to keep in service, healthy, and ready to use to support your workload when replacing instances. Value range is 0 to 100. To clear a previously set value, specify a value of ``-1``." + } + } + }, + { + "$type": "ObjectType", + "name": "InstanceRequirements", + "properties": { + "AcceleratorCount": { + "type": { + "$ref": "#/0" + }, + "flags": 0, + "description": "The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) for an instance type.\n To exclude accelerator-enabled instance types, set ``Max`` to ``0``.\n Default: No minimum or maximum limits" + }, + "AcceleratorManufacturers": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "Indicates whether instance types must have accelerators by specific manufacturers.\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 ``amazon-web-services``.\n + For instance types with Xilinx devices, specify ``xilinx``.\n \n Default: Any manufacturer" + }, + "AcceleratorNames": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "Lists 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 ``radeon-pro-v520``.\n + For instance types with Xilinx VU9P FPGAs, specify ``vu9p``.\n \n Default: Any accelerator" + }, + "AcceleratorTotalMemoryMiB": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The minimum and maximum total memory size for the accelerators on an instance type, in MiB.\n Default: No minimum or maximum limits" + }, + "AcceleratorTypes": { + "type": { + "$ref": "#/24" + }, + "flags": 0, + "description": "Lists 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 ``inference``.\n \n Default: Any accelerator type" + }, + "AllowedInstanceTypes": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes.\n You can use strings with one or more wild cards, represented by an asterisk (``*``), to allow an instance type, size, or generation. The following are examples: ``m5.8xlarge``, ``c5*.*``, ``m5a.*``, ``r*``, ``*3*``.\n For example, if you specify ``c5*``, Amazon EC2 Auto Scaling will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify ``m5a.*``, Amazon EC2 Auto Scaling will allow all the M5a instance types, but not the M5n instance types.\n If you specify ``AllowedInstanceTypes``, you can't specify ``ExcludedInstanceTypes``.\n Default: All instance types" + }, + "BareMetal": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "Indicates whether bare metal instance types are included, excluded, or required.\n Default: ``excluded``" + }, + "BaselineEbsBandwidthMbps": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The minimum and maximum baseline bandwidth performance for an instance type, in Mbps. For more information, see [Amazon EBS–optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the *Amazon EC2 User Guide for Linux Instances*.\n Default: No minimum or maximum limits" + }, + "BurstablePerformance": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "Indicates whether burstable performance instance types are included, excluded, or required. For more information, see [Burstable performance instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) in the *Amazon EC2 User Guide for Linux Instances*.\n Default: ``excluded``" + }, + "CpuManufacturers": { + "type": { + "$ref": "#/26" + }, + "flags": 0, + "description": "Lists 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 ``amazon-web-services``.\n \n Don't confuse the CPU hardware manufacturer with the CPU hardware architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template. \n Default: Any manufacturer" + }, + "ExcludedInstanceTypes": { + "type": { + "$ref": "#/27" + }, + "flags": 0, + "description": "The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk (``*``), to exclude an instance family, type, size, or generation. The following are examples: ``m5.8xlarge``, ``c5*.*``, ``m5a.*``, ``r*``, ``*3*``. \n For example, if you specify ``c5*``, you are excluding the entire C5 instance family, which includes all C5a and C5n instance types. If you specify ``m5a.*``, Amazon EC2 Auto Scaling will exclude all the M5a instance types, but not the M5n instance types.\n If you specify ``ExcludedInstanceTypes``, you can't specify ``AllowedInstanceTypes``.\n Default: No excluded instance types" + }, + "InstanceGenerations": { + "type": { + "$ref": "#/28" + }, + "flags": 0, + "description": "Indicates whether current or previous generation instance types are included.\n + For current generation instance types, specify ``current``. The current generation includes EC2 instance types currently recommended for use. This typically includes the latest two to three generations in each instance family. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide for Linux Instances*.\n + For previous generation instance types, specify ``previous``.\n \n Default: Any current or previous generation" + }, + "LocalStorage": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, see [Amazon EC2 instance store](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html) in the *Amazon EC2 User Guide for Linux Instances*.\n Default: ``included``" + }, + "LocalStorageTypes": { + "type": { + "$ref": "#/29" + }, + "flags": 0, + "description": "Indicates the 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 ``ssd``.\n \n Default: Any local storage type" + }, + "MaxSpotPriceAsPercentageOfOptimalOnDemandPrice": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "[Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold.\n The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.\n If you set ``DesiredCapacityType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is based on the per-vCPU or per-memory price instead of the per instance price. \n Only one of ``SpotMaxPricePercentageOverLowestPrice`` or ``MaxSpotPriceAsPercentageOfOptimalOnDemandPrice`` can be specified. If you don't specify either, Amazon EC2 Auto Scaling will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as ``999999``." + }, + "MemoryGiBPerVCpu": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The minimum and maximum amount of memory per vCPU for an instance type, in GiB.\n Default: No minimum or maximum limits" + }, + "MemoryMiB": { + "type": { + "$ref": "#/11" + }, + "flags": 1, + "description": "The minimum and maximum instance memory size for an instance type, in MiB." + }, + "NetworkBandwidthGbps": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).\n Default: No minimum or maximum limits" + }, + "NetworkInterfaceCount": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "The minimum and maximum number of network interfaces for an instance type.\n Default: No minimum or maximum limits" + }, + "OnDemandMaxPricePercentageOverLowestPrice": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "[Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold. \n The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.\n To turn off price protection, specify a high value, such as ``999999``. \n If you set ``DesiredCapacityType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per instance price. \n Default: ``20``" + }, + "RequireHibernateSupport": { + "type": { + "$ref": "#/30" + }, + "flags": 0, + "description": "Indicates whether instance types must provide On-Demand Instance hibernation support.\n Default: ``false``" + }, + "SpotMaxPricePercentageOverLowestPrice": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "[Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold.\n The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage. \n If you set ``DesiredCapacityType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is based on the per-vCPU or per-memory price instead of the per instance price. \n Only one of ``SpotMaxPricePercentageOverLowestPrice`` or ``MaxSpotPriceAsPercentageOfOptimalOnDemandPrice`` can be specified. If you don't specify either, Amazon EC2 Auto Scaling will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as ``999999``." + }, + "TotalLocalStorageGB": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "The minimum and maximum total local storage size for an instance type, in GB.\n Default: No minimum or maximum limits" + }, + "VCpuCount": { + "type": { + "$ref": "#/19" + }, + "flags": 1, + "description": "The minimum and maximum number of vCPUs for an instance type." + } + } + }, + { + "$type": "ObjectType", + "name": "InstancesDistribution", + "properties": { + "OnDemandAllocationStrategy": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "The allocation strategy to apply to your On-Demand Instances when they are launched. Possible instance types are determined by the launch template overrides that you specify.\n The following lists the valid values:\n + lowest-price Uses price to determine which instance types are the highest priority, launching the lowest priced instance types within an Availability Zone first. This is the default value for Auto Scaling groups that specify InstanceRequirements. + prioritized You set the order of instance types for the launch template overrides from highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling launches your highest priority instance types first. If all your On-Demand capacity cannot be fulfilled using your highest priority instance type, then Amazon EC2 Auto Scaling launches the remaining capacity using the second priority instance type, and so on. This is the default value for Auto Scaling groups that don't specify InstanceRequirements and cannot be used for groups that do." + }, + "OnDemandBaseCapacity": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand Instances. This base portion is launched first as your group scales.\n This number has the same unit of measurement as the group's desired capacity. If you change the default unit of measurement (number of instances) by specifying weighted capacity values in your launch template overrides list, or by changing the default desired capacity type setting of the group, you must specify this number using the same unit of measurement.\n Default: 0\n An update to this setting means a gradual replacement of instances to adjust the current On-Demand Instance levels. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the previous ones." + }, + "OnDemandPercentageAboveBaseCapacity": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond ``OnDemandBaseCapacity``. Expressed as a number (for example, 20 specifies 20% On-Demand Instances, 80% Spot Instances). If set to 100, only On-Demand Instances are used.\n Default: 100\n An update to this setting means a gradual replacement of instances to adjust the current On-Demand and Spot Instance levels for your additional capacity higher than the base capacity. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the previous ones." + }, + "SpotAllocationStrategy": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "The allocation strategy to apply to your Spot Instances when they are launched. Possible instance types are determined by the launch template overrides that you specify.\n The following lists the valid values:\n + capacity-optimized Requests Spot Instances using pools that are optimally chosen based on the available Spot capacity. This strategy has the lowest risk of interruption. To give certain instance types a higher chance of launching first, use capacity-optimized-prioritized. + capacity-optimized-prioritized You set the order of instance types for the launch template overrides from highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling honors the instance type priorities on a best effort basis but optimizes for capacity first. Note that if the On-Demand allocation strategy is set to prioritized, the same priority is applied when fulfilling On-Demand capacity. This is not a valid value for Auto Scaling groups that specify InstanceRequirements. + lowest-price Requests Spot Instances using the lowest priced pools within an Availability Zone, across the number of Spot pools that you specify for the SpotInstancePools property. To ensure that your desired capacity is met, you might receive Spot Instances from several pools. This is the default value, but it might lead to high interruption rates because this strategy only considers instance price and not available capacity. + price-capacity-optimized (recommended) The price and capacity optimized allocation strategy looks at both price and capacity to select the Spot Instance pools that are the least likely to be interrupted and have the lowest possible price." + }, + "SpotInstancePools": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "The number of Spot Instance pools across which to allocate your Spot Instances. The Spot pools are determined from the different instance types in the overrides. Valid only when the ``SpotAllocationStrategy`` is ``lowest-price``. Value must be in the range of 1–20.\n Default: 2" + }, + "SpotMaxPrice": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "The maximum price per unit hour that you are willing to pay for a Spot Instance. If your maximum price is lower than the Spot price for the instance types that you selected, your Spot Instances are not launched. We do not recommend specifying a maximum price because it can lead to increased interruptions. When Spot Instances launch, you pay the current Spot price. To remove a maximum price that you previously set, include the property but specify an empty string (\"\") for the value.\n If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify one.\n Valid Range: Minimum value of 0.001" + } + } + }, + { + "$type": "ObjectType", + "name": "LaunchTemplate", + "properties": { + "LaunchTemplateSpecification": { + "type": { + "$ref": "#/8" + }, + "flags": 1, + "description": "The launch template." + }, + "Overrides": { + "type": { + "$ref": "#/31" + }, + "flags": 0, + "description": "Any properties that you specify override the same properties in the launch template." + } + } + }, + { + "$type": "ObjectType", + "name": "LaunchTemplateOverrides", + "properties": { + "InstanceRequirements": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The instance requirements. Amazon EC2 Auto Scaling uses your specified requirements to identify instance types. Then, it uses your On-Demand and Spot allocation strategies to launch instances from these instance types.\n You can specify up to four separate sets of instance requirements per Auto Scaling group. This is useful for provisioning instances from different Amazon Machine Images (AMIs) in the same Auto Scaling group. To do this, create the AMIs and create a new launch template for each AMI. Then, create a compatible set of instance requirements for each launch template. \n If you specify ``InstanceRequirements``, you can't specify ``InstanceType``." + }, + "InstanceType": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "The instance type, such as ``m3.xlarge``. You must specify an instance type that is supported in your requested Region and Availability Zones. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide for Linux Instances*.\n You can specify up to 40 instance types per Auto Scaling group." + }, + "LaunchTemplateSpecification": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "Provides a launch template for the specified instance type or set of instance requirements. For example, some instance types might require a launch template with a different AMI. If not provided, Amazon EC2 Auto Scaling uses the launch template that's specified in the ``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 *Amazon EC2 Auto Scaling User Guide*. \n You can specify up to 20 launch templates per Auto Scaling group. The launch templates specified in the overrides and in the ``LaunchTemplate`` definition count towards this limit." + }, + "WeightedCapacity": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "If you provide a list of instance types to use, you can specify the number of capacity units provided by each instance type in terms of virtual CPUs, memory, storage, throughput, or other relative performance characteristic. When a Spot or On-Demand Instance is launched, the capacity units count toward the desired capacity. Amazon EC2 Auto Scaling launches instances until the desired capacity is totally fulfilled, even if this results in an overage. For example, if there are two units remaining to fulfill capacity, and Amazon EC2 Auto Scaling can only launch an instance with a ``WeightedCapacity`` of five units, the instance is launched, and the desired capacity is exceeded by three units. For more information, see [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 EC2 Auto Scaling User Guide*. Value must be in the range of 1-999. \n If you specify a value for ``WeightedCapacity`` for one instance type, you must specify a value for ``WeightedCapacity`` for all of them.\n Every Auto Scaling group has three size parameters (``DesiredCapacity``, ``MaxSize``, and ``MinSize``). Usually, you set these sizes based on a specific number of instances. However, if you configure a mixed instances policy that defines weights for the instance types, you must specify these sizes with the same units that you use for weighting instances." + } + } + }, + { + "$type": "ObjectType", + "name": "LaunchTemplateSpecification", + "properties": { + "LaunchTemplateId": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "The ID of the launch template.\n You must specify the ``LaunchTemplateID`` or the ``LaunchTemplateName``, but not both." + }, + "LaunchTemplateName": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "The name of the launch template.\n You must specify the ``LaunchTemplateName`` or the ``LaunchTemplateID``, but not both." + }, + "Version": { + "type": { + "$ref": "#/21" + }, + "flags": 1, + "description": "The version number of the launch template.\n Specifying ``$Latest`` or ``$Default`` for the template version number is not supported. However, you can specify ``LatestVersionNumber`` or ``DefaultVersionNumber`` using the ``Fn::GetAtt`` intrinsic function. For more information, see [Fn::GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html).\n For 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`` resource." + } + } + }, + { + "$type": "ObjectType", + "name": "LifecycleHookSpecification", + "properties": { + "DefaultResult": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. The default value is ``ABANDON``.\n Valid values: ``CONTINUE`` | ``ABANDON``" + }, + "HeartbeatTimeout": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from ``30`` to ``7200`` seconds. The default value is ``3600`` seconds (1 hour)." + }, + "LifecycleHookName": { + "type": { + "$ref": "#/21" + }, + "flags": 1, + "description": "The name of the lifecycle hook." + }, + "LifecycleTransition": { + "type": { + "$ref": "#/21" + }, + "flags": 1, + "description": "The lifecycle transition. For Auto Scaling groups, there are two major lifecycle transitions.\n + To create a lifecycle hook for scale-out events, specify ``autoscaling:EC2_INSTANCE_LAUNCHING``.\n + To create a lifecycle hook for scale-in events, specify ``autoscaling:EC2_INSTANCE_TERMINATING``." + }, + "NotificationMetadata": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target." + }, + "NotificationTargetARN": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling sends notifications to when an instance is in a wait state for the lifecycle hook. You can specify an Amazon SNS topic or an Amazon SQS queue." + }, + "RoleARN": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target. For information about creating this role, see [Prepare to add a lifecycle hook to your Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/prepare-for-lifecycle-notifications.html) in the *Amazon EC2 Auto Scaling User Guide*.\n Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue." + } + } + }, + { + "$type": "ObjectType", + "name": "MemoryGiBPerVCpuRequest", + "properties": { + "Max": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "The memory maximum in GiB." + }, + "Min": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "The memory minimum in GiB." + } + } + }, + { + "$type": "ObjectType", + "name": "MemoryMiBRequest", + "properties": { + "Max": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "The memory maximum in MiB." + }, + "Min": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "The memory minimum in MiB." + } + } + }, + { + "$type": "ObjectType", + "name": "MetricsCollection", + "properties": { + "Granularity": { + "type": { + "$ref": "#/21" + }, + "flags": 1, + "description": "The frequency at which Amazon EC2 Auto Scaling sends aggregated data to CloudWatch. The only valid value is ``1Minute``." + }, + "Metrics": { + "type": { + "$ref": "#/32" + }, + "flags": 0, + "description": "Identifies the metrics to enable.\n You 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`` \n \n If you specify ``Granularity`` and don't specify any metrics, all metrics are enabled.\n For more information, see [Amazon CloudWatch metrics for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-metrics.html) in the *Amazon EC2 Auto Scaling User Guide*." + } + } + }, + { + "$type": "ObjectType", + "name": "MixedInstancesPolicy", + "properties": { + "InstancesDistribution": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The instances distribution." + }, + "LaunchTemplate": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "One or more launch templates and the instance types (overrides) that are used to launch EC2 instances to fulfill On-Demand and Spot capacities." + } + } + }, + { + "$type": "ObjectType", + "name": "NetworkBandwidthGbpsRequest", + "properties": { + "Max": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "The maximum amount of network bandwidth, in gigabits per second (Gbps)." + }, + "Min": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "The minimum amount of network bandwidth, in gigabits per second (Gbps)." + } + } + }, + { + "$type": "ObjectType", + "name": "NetworkInterfaceCountRequest", + "properties": { + "Max": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "The maximum number of network interfaces." + }, + "Min": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "The minimum number of network interfaces." + } + } + }, + { + "$type": "ObjectType", + "name": "NotificationConfiguration", + "properties": { + "NotificationTypes": { + "type": { + "$ref": "#/33" + }, + "flags": 0, + "description": "A list of event types that send a notification. Event types can include any of the following 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``" + }, + "TopicARN": { + "type": { + "$ref": "#/35" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of the Amazon SNS topic." + } + } + }, + { + "$type": "ObjectType", + "name": "TagProperty", + "properties": { + "Key": { + "type": { + "$ref": "#/21" + }, + "flags": 1, + "description": "The tag key." + }, + "PropagateAtLaunch": { + "type": { + "$ref": "#/30" + }, + "flags": 1, + "description": "Set to ``true`` if you want CloudFormation to copy the tag to EC2 instances that are launched as part of the Auto Scaling group. Set to ``false`` if you want the tag attached only to the Auto Scaling group and not copied to any instances launched as part of the Auto Scaling group." + }, + "Value": { + "type": { + "$ref": "#/21" + }, + "flags": 1, + "description": "The tag value." + } + } + }, + { + "$type": "ObjectType", + "name": "TotalLocalStorageGBRequest", + "properties": { + "Max": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "The storage maximum in GB." + }, + "Min": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "The storage minimum in GB." + } + } + }, + { + "$type": "ObjectType", + "name": "VCpuCountRequest", + "properties": { + "Max": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "The maximum number of vCPUs." + }, + "Min": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "The minimum number of vCPUs." + } + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/21" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/21" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/21" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/21" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/21" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/21" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/21" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/21" + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/7" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/21" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/21" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/21" + } + }, + { + "$type": "UnionType", + "elements": [ + { + "$ref": "#/21" + }, + { + "$ref": "#/34" + } + ] + }, + { + "$type": "StringLiteralType", + "value": "AWS.AutoScaling/AutoScalingGroupProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/21" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/9" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/21" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/12" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/16" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/17" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/21" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/21" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/21" + } + }, + { + "$type": "ObjectType", + "name": "AWS.AutoScaling/AutoScalingGroupProperties", + "properties": { + "AutoScalingGroupName": { + "type": { + "$ref": "#/21" + }, + "flags": 16, + "description": "The name of the Auto Scaling group. This name must be unique per Region per account.\n The name can contain any ASCII character 33 to 126 including most punctuation characters, digits, and upper and lowercased letters.\n You cannot use a colon (:) in the name." + }, + "AvailabilityZones": { + "type": { + "$ref": "#/37" + }, + "flags": 0, + "description": "A list of Availability Zones where instances in the Auto Scaling group can be created. Used for launching into the default VPC subnet in each Availability Zone when not using the ``VPCZoneIdentifier`` property, or for attaching a network interface when an existing network interface ID is specified in a launch template." + }, + "CapacityRebalance": { + "type": { + "$ref": "#/30" + }, + "flags": 0, + "description": "Indicates whether Capacity Rebalancing is enabled. Otherwise, Capacity Rebalancing is disabled. When you turn on Capacity Rebalancing, Amazon EC2 Auto Scaling attempts to launch a Spot Instance whenever Amazon EC2 notifies that a Spot Instance is at an elevated risk of interruption. After launching a new instance, it then terminates an old instance. For more information, see [Use Capacity Rebalancing 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*." + }, + "Context": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "Reserved." + }, + "Cooldown": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "*Only needed if you use simple scaling policies.* \n The amount of time, in seconds, between one scaling activity ending and another one starting due to simple scaling policies. For more information, see [Scaling cooldowns 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*.\n Default: ``300`` seconds" + }, + "DefaultInstanceWarmup": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "The amount of time, in seconds, until a new instance is considered to have finished initializing and resource consumption to become stable after it enters the ``InService`` state. \n During an instance refresh, Amazon EC2 Auto Scaling waits for the warm-up period after it replaces an instance before it moves on to replacing the next instance. Amazon EC2 Auto Scaling also waits for the warm-up period before aggregating the metrics for new instances with existing instances in the Amazon CloudWatch metrics that are used for scaling, resulting in more reliable usage data. For more information, see [Set the 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 *Amazon EC2 Auto Scaling User Guide*.\n To manage various warm-up settings at the group level, we recommend that you set the default instance warmup, *even if it is set to 0 seconds*. To remove a value that you previously set, include the property but specify ``-1`` for the value. However, we strongly recommend keeping the default instance warmup enabled by specifying a value of ``0`` or other nominal value.\n Default: None" + }, + "DesiredCapacity": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "The desired capacity is the initial capacity of the Auto Scaling group at the time of its creation and the capacity it attempts to maintain. It can scale beyond this capacity if you configure automatic scaling.\n The number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group. If you do not specify a desired capacity when creating the stack, the default is the minimum size of the group.\n CloudFormation marks the Auto Scaling group as successful (by setting its status to CREATE_COMPLETE) when the desired capacity is reached. However, if a maximum Spot price is set in the launch template or launch configuration that you specified, then desired capacity is not used as a criteria for success. Whether your request is fulfilled depends on Spot Instance capacity and your maximum price." + }, + "DesiredCapacityType": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports ``DesiredCapacityType`` for attribute-based instance type selection only. For more information, see [Create a mixed instances group using attribute-based instance type selection](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*.\n By default, Amazon EC2 Auto Scaling specifies ``units``, which translates into number of instances.\n Valid values: ``units`` | ``vcpu`` | ``memory-mib``" + }, + "HealthCheckGracePeriod": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service and marking it unhealthy due to a failed health check. This is useful if your instances do not immediately pass their health checks after they enter the ``InService`` state. For more information, see [Set the health check grace period for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/health-check-grace-period.html) in the *Amazon EC2 Auto Scaling User Guide*.\n Default: ``0`` seconds" + }, + "HealthCheckType": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "A comma-separated value string of one or more health check types.\n The valid values are ``EC2``, ``ELB``, and ``VPC_LATTICE``. ``EC2`` is the default health check and cannot be disabled. For more information, see [Health checks for instances in an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-health-checks.html) in the *Amazon EC2 Auto Scaling User Guide*.\n Only specify ``EC2`` if you must clear a value that was previously set." + }, + "InstanceId": { + "type": { + "$ref": "#/21" + }, + "flags": 4, + "description": "The ID of the instance used to base the launch configuration on. For more information, see [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 Scaling User Guide*.\n If you specify ``LaunchTemplate``, ``MixedInstancesPolicy``, or ``LaunchConfigurationName``, don't specify ``InstanceId``." + }, + "InstanceMaintenancePolicy": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "An 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 *Amazon EC2 Auto Scaling User Guide*." + }, + "LaunchConfigurationName": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "The name of the launch configuration to use to launch instances.\n Required only if you don't specify ``LaunchTemplate``, ``MixedInstancesPolicy``, or ``InstanceId``." + }, + "LaunchTemplate": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "Information used to specify the launch template and version to use to launch instances. You can alternatively associate a launch template to the Auto Scaling group by specifying a ``MixedInstancesPolicy``. For more information about creating launch templates, see [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 Scaling User Guide*.\n If you omit this property, you must specify ``MixedInstancesPolicy``, ``LaunchConfigurationName``, or ``InstanceId``." + }, + "LifecycleHookSpecificationList": { + "type": { + "$ref": "#/38" + }, + "flags": 0, + "description": "One or more lifecycle hooks to add to the Auto Scaling group before instances are launched." + }, + "LoadBalancerNames": { + "type": { + "$ref": "#/39" + }, + "flags": 0, + "description": "A list of Classic Load Balancers associated with this Auto Scaling group. For Application Load Balancers, Network Load Balancers, and Gateway Load Balancers, specify the ``TargetGroupARNs`` property instead." + }, + "MaxInstanceLifetime": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "The maximum amount of time, in seconds, that an instance can be in service. The default is null. If specified, the value must be either 0 or a number equal to or greater 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 *Amazon EC2 Auto Scaling User Guide*." + }, + "MaxSize": { + "type": { + "$ref": "#/21" + }, + "flags": 1, + "description": "The maximum size of the group.\n With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to go above ``MaxSize`` to meet your capacity requirements. In this event, Amazon EC2 Auto Scaling will never go above ``MaxSize`` by more than your largest instance weight (weights that define how many units each instance contributes to the desired capacity of the group)." + }, + "MetricsCollection": { + "type": { + "$ref": "#/40" + }, + "flags": 0, + "description": "Enables the monitoring of group metrics of an Auto Scaling group. By default, these metrics are disabled." + }, + "MinSize": { + "type": { + "$ref": "#/21" + }, + "flags": 1, + "description": "The minimum size of the group." + }, + "MixedInstancesPolicy": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "An embedded object that specifies a mixed instances policy.\n The policy includes properties that not only define the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances (optional), and how the Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacities, but also the properties that specify the instance configuration information—the launch template and instance types. The policy can also include a weight for each instance type and different launch templates for individual instance types.\n For more information, see [Auto Scaling groups 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 Auto Scaling User Guide*." + }, + "NewInstancesProtectedFromScaleIn": { + "type": { + "$ref": "#/30" + }, + "flags": 0, + "description": "Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. For more information about preventing instances from terminating on scale in, see [Use instance scale-in protection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-protection.html) in the *Amazon EC2 Auto Scaling User Guide*." + }, + "NotificationConfiguration": { + "type": { + "$ref": "#/16" + }, + "flags": 0, + "description": "" + }, + "NotificationConfigurations": { + "type": { + "$ref": "#/41" + }, + "flags": 0, + "description": "Configures an Auto Scaling group to send notifications when specified events take place." + }, + "PlacementGroup": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "The name of the placement group into which to launch your instances. For more information, see [Placement groups](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) in the *Amazon EC2 User Guide for Linux Instances*.\n A *cluster* placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a cluster placement group." + }, + "ServiceLinkedRoleARN": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS service on your behalf. By default, Amazon EC2 Auto Scaling uses a service-linked role named ``AWSServiceRoleForAutoScaling``, which it creates if it does not exist. For more information, see [Service-linked roles](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-service-linked-role.html) in the *Amazon EC2 Auto Scaling User Guide*." + }, + "Tags": { + "type": { + "$ref": "#/42" + }, + "flags": 0, + "description": "One or more tags. You can tag your Auto Scaling group and propagate the tags to the Amazon EC2 instances it launches. Tags are not propagated to Amazon EBS volumes. To add tags to Amazon EBS volumes, specify the tags in a launch template but use caution. If the launch template specifies an instance tag with a key that is also specified for the Auto Scaling group, Amazon EC2 Auto Scaling overrides the value of that instance tag with the value specified by the Auto Scaling group. For more information, see [Tag Auto Scaling groups and instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-tagging.html) in the *Amazon EC2 Auto Scaling User Guide*." + }, + "TargetGroupARNs": { + "type": { + "$ref": "#/43" + }, + "flags": 0, + "description": "The Amazon Resource Names (ARN) of the Elastic Load Balancing target groups to associate with the Auto Scaling group. Instances are registered as targets with the target groups. The target groups receive incoming traffic and route requests to one or more registered targets. For more information, see [Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html) in the *Amazon EC2 Auto Scaling User Guide*." + }, + "TerminationPolicies": { + "type": { + "$ref": "#/44" + }, + "flags": 0, + "description": "A policy or a list of policies that are used to select the instance to terminate. These policies are executed in the order that you list them. For more information, see [Configure termination policies for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-termination-policies.html) in the *Amazon EC2 Auto Scaling User Guide*.\n Valid values: ``Default`` | ``AllocationStrategy`` | ``ClosestToNextInstanceHour`` | ``NewestInstance`` | ``OldestInstance`` | ``OldestLaunchConfiguration`` | ``OldestLaunchTemplate`` | ``arn:aws:lambda:region:account-id:function:my-function:my-alias``" + }, + "VPCZoneIdentifier": { + "type": { + "$ref": "#/45" + }, + "flags": 0, + "description": "A list of subnet IDs for a virtual private cloud (VPC) where instances in the Auto Scaling group can be created.\n If this resource specifies public subnets and is also in a VPC that is defined in the same stack template, you must use the [DependsOn attribute](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 When you update ``VPCZoneIdentifier``, this retains the same Auto Scaling group and replaces old instances with new ones, according to the specified subnets. You can optionally specify how CloudFormation handles these updates by using an [UpdatePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html).\n Required to launch instances into a nondefault VPC. If you specify ``VPCZoneIdentifier`` with ``AvailabilityZones``, the subnets that you specify for this property must reside in those Availability Zones." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.AutoScaling/AutoScalingGroup", + "properties": { + "name": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/21" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/46" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.AutoScaling/AutoScalingGroup@default", + "scopeType": 0, + "body": { + "$ref": "#/47" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.AutoScaling/LifecycleHookProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.AutoScaling/LifecycleHookProperties", + "properties": { + "AutoScalingGroupName": { + "type": { + "$ref": "#/21" + }, + "flags": 17, + "description": "The name of the Auto Scaling group for the lifecycle hook." + }, + "DefaultResult": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. The valid values are CONTINUE and ABANDON (default)." + }, + "HeartbeatTimeout": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from 30 to 7200 seconds. The default value is 3600 seconds (1 hour). If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult property." + }, + "LifecycleHookName": { + "type": { + "$ref": "#/21" + }, + "flags": 16, + "description": "The name of the lifecycle hook." + }, + "LifecycleTransition": { + "type": { + "$ref": "#/21" + }, + "flags": 1, + "description": "The instance state to which you want to attach the lifecycle hook." + }, + "NotificationMetadata": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the notification target." + }, + "NotificationTargetARN": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. You can specify an Amazon SQS queue or an Amazon SNS topic. The notification message includes the following information: lifecycle action token, user account ID, Auto Scaling group name, lifecycle hook name, instance ID, lifecycle transition, and notification metadata." + }, + "RoleARN": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.AutoScaling/LifecycleHook", + "properties": { + "name": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/21" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/50" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.AutoScaling/LifecycleHook@default", + "scopeType": 0, + "body": { + "$ref": "#/51" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "CustomizedMetricSpecification", + "properties": { + "Dimensions": { + "type": { + "$ref": "#/71" + }, + "flags": 0 + }, + "MetricName": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "Metrics": { + "type": { + "$ref": "#/72" + }, + "flags": 0 + }, + "Namespace": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "Statistic": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "Unit": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Metric", + "properties": { + "Dimensions": { + "type": { + "$ref": "#/73" + }, + "flags": 0 + }, + "MetricName": { + "type": { + "$ref": "#/21" + }, + "flags": 1 + }, + "Namespace": { + "type": { + "$ref": "#/21" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "MetricDataQuery", + "properties": { + "Expression": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "Id": { + "type": { + "$ref": "#/21" + }, + "flags": 1 + }, + "Label": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "MetricStat": { + "type": { + "$ref": "#/57" + }, + "flags": 0 + }, + "ReturnData": { + "type": { + "$ref": "#/30" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "MetricDimension", + "properties": { + "Name": { + "type": { + "$ref": "#/21" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/21" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "MetricStat", + "properties": { + "Metric": { + "type": { + "$ref": "#/54" + }, + "flags": 1 + }, + "Stat": { + "type": { + "$ref": "#/21" + }, + "flags": 1 + }, + "Unit": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PredefinedMetricSpecification", + "properties": { + "PredefinedMetricType": { + "type": { + "$ref": "#/21" + }, + "flags": 1 + }, + "ResourceLabel": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PredictiveScalingConfiguration", + "properties": { + "MaxCapacityBreachBehavior": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "MaxCapacityBuffer": { + "type": { + "$ref": "#/20" + }, + "flags": 0 + }, + "MetricSpecifications": { + "type": { + "$ref": "#/74" + }, + "flags": 1 + }, + "Mode": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "SchedulingBufferTime": { + "type": { + "$ref": "#/20" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PredictiveScalingCustomizedCapacityMetric", + "properties": { + "MetricDataQueries": { + "type": { + "$ref": "#/75" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "PredictiveScalingCustomizedLoadMetric", + "properties": { + "MetricDataQueries": { + "type": { + "$ref": "#/76" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "PredictiveScalingCustomizedScalingMetric", + "properties": { + "MetricDataQueries": { + "type": { + "$ref": "#/77" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "PredictiveScalingMetricSpecification", + "properties": { + "CustomizedCapacityMetricSpecification": { + "type": { + "$ref": "#/60" + }, + "flags": 0 + }, + "CustomizedLoadMetricSpecification": { + "type": { + "$ref": "#/61" + }, + "flags": 0 + }, + "CustomizedScalingMetricSpecification": { + "type": { + "$ref": "#/62" + }, + "flags": 0 + }, + "PredefinedLoadMetricSpecification": { + "type": { + "$ref": "#/64" + }, + "flags": 0 + }, + "PredefinedMetricPairSpecification": { + "type": { + "$ref": "#/65" + }, + "flags": 0 + }, + "PredefinedScalingMetricSpecification": { + "type": { + "$ref": "#/66" + }, + "flags": 0 + }, + "TargetValue": { + "type": { + "$ref": "#/20" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "PredictiveScalingPredefinedLoadMetric", + "properties": { + "PredefinedMetricType": { + "type": { + "$ref": "#/21" + }, + "flags": 1 + }, + "ResourceLabel": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PredictiveScalingPredefinedMetricPair", + "properties": { + "PredefinedMetricType": { + "type": { + "$ref": "#/21" + }, + "flags": 1 + }, + "ResourceLabel": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PredictiveScalingPredefinedScalingMetric", + "properties": { + "PredefinedMetricType": { + "type": { + "$ref": "#/21" + }, + "flags": 1 + }, + "ResourceLabel": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "StepAdjustment", + "properties": { + "MetricIntervalLowerBound": { + "type": { + "$ref": "#/20" + }, + "flags": 0 + }, + "MetricIntervalUpperBound": { + "type": { + "$ref": "#/20" + }, + "flags": 0 + }, + "ScalingAdjustment": { + "type": { + "$ref": "#/20" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TargetTrackingConfiguration", + "properties": { + "CustomizedMetricSpecification": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "DisableScaleIn": { + "type": { + "$ref": "#/30" + }, + "flags": 0 + }, + "PredefinedMetricSpecification": { + "type": { + "$ref": "#/58" + }, + "flags": 0 + }, + "TargetValue": { + "type": { + "$ref": "#/20" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TargetTrackingMetricDataQuery", + "properties": { + "Expression": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "Id": { + "type": { + "$ref": "#/21" + }, + "flags": 1 + }, + "Label": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "MetricStat": { + "type": { + "$ref": "#/70" + }, + "flags": 0 + }, + "ReturnData": { + "type": { + "$ref": "#/30" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TargetTrackingMetricStat", + "properties": { + "Metric": { + "type": { + "$ref": "#/54" + }, + "flags": 1 + }, + "Stat": { + "type": { + "$ref": "#/21" + }, + "flags": 1 + }, + "Unit": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/56" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/69" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/56" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/63" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/55" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/55" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/55" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.AutoScaling/ScalingPolicyProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/67" + } + }, + { + "$type": "ObjectType", + "name": "AWS.AutoScaling/ScalingPolicyProperties", + "properties": { + "AdjustmentType": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "Specifies how the scaling adjustment is interpreted. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity." + }, + "Arn": { + "type": { + "$ref": "#/21" + }, + "flags": 18, + "description": "The ARN of the AutoScaling scaling policy" + }, + "AutoScalingGroupName": { + "type": { + "$ref": "#/21" + }, + "flags": 1, + "description": "The name of the Auto Scaling group." + }, + "Cooldown": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "The duration of the policy's cooldown period, in seconds. When a cooldown period is specified here, it overrides the default cooldown period defined for the Auto Scaling group." + }, + "EstimatedInstanceWarmup": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. If not provided, the default is to use the value from the default cooldown period for the Auto Scaling group. Valid only if the policy type is TargetTrackingScaling or StepScaling." + }, + "MetricAggregationType": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average. Valid only if the policy type is StepScaling." + }, + "MinAdjustmentMagnitude": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "The minimum value to scale by when the adjustment type is PercentChangeInCapacity. For example, suppose that you create a step scaling policy to scale out an Auto Scaling group by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the group has 4 instances and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Amazon EC2 Auto Scaling scales out the group by 2 instances." + }, + "PolicyName": { + "type": { + "$ref": "#/21" + }, + "flags": 2 + }, + "PolicyType": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "One of the following policy types: TargetTrackingScaling, StepScaling, SimpleScaling (default), PredictiveScaling" + }, + "PredictiveScalingConfiguration": { + "type": { + "$ref": "#/59" + }, + "flags": 0, + "description": "A predictive scaling policy. Includes support for predefined metrics only." + }, + "ScalingAdjustment": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity. For exact capacity, you must specify a positive value. Required if the policy type is SimpleScaling. (Not used with any other policy type.)" + }, + "StepAdjustments": { + "type": { + "$ref": "#/79" + }, + "flags": 0, + "description": "A set of adjustments that enable you to scale based on the size of the alarm breach. Required if the policy type is StepScaling. (Not used with any other policy type.)" + }, + "TargetTrackingConfiguration": { + "type": { + "$ref": "#/68" + }, + "flags": 0, + "description": "A target tracking scaling policy. Includes support for predefined or customized metrics." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.AutoScaling/ScalingPolicy", + "properties": { + "name": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/21" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/80" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.AutoScaling/ScalingPolicy@default", + "scopeType": 0, + "body": { + "$ref": "#/81" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.AutoScaling/ScheduledActionProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.AutoScaling/ScheduledActionProperties", + "properties": { + "AutoScalingGroupName": { + "type": { + "$ref": "#/21" + }, + "flags": 17, + "description": "The name of the Auto Scaling group." + }, + "DesiredCapacity": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "The desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain." + }, + "EndTime": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "The latest scheduled start time to return. If scheduled action names are provided, this parameter is ignored." + }, + "MaxSize": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "The minimum size of the Auto Scaling group." + }, + "MinSize": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "The minimum size of the Auto Scaling group." + }, + "Recurrence": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "The recurring schedule for the action, in Unix cron syntax format. When StartTime and EndTime are specified with Recurrence , they form the boundaries of when the recurring action starts and stops." + }, + "ScheduledActionName": { + "type": { + "$ref": "#/21" + }, + "flags": 18, + "description": "Auto-generated unique identifier" + }, + "StartTime": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "The earliest scheduled start time to return. If scheduled action names are provided, this parameter is ignored." + }, + "TimeZone": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "The time zone for the cron expression." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.AutoScaling/ScheduledAction", + "properties": { + "name": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/21" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/84" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.AutoScaling/ScheduledAction@default", + "scopeType": 0, + "body": { + "$ref": "#/85" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "InstanceReusePolicy", + "properties": { + "ReuseOnScaleIn": { + "type": { + "$ref": "#/30" + }, + "flags": 0 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.AutoScaling/WarmPoolProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.AutoScaling/WarmPoolProperties", + "properties": { + "AutoScalingGroupName": { + "type": { + "$ref": "#/21" + }, + "flags": 17 + }, + "InstanceReusePolicy": { + "type": { + "$ref": "#/87" + }, + "flags": 0 + }, + "MaxGroupPreparedCapacity": { + "type": { + "$ref": "#/20" + }, + "flags": 0 + }, + "MinSize": { + "type": { + "$ref": "#/20" + }, + "flags": 0 + }, + "PoolState": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.AutoScaling/WarmPool", + "properties": { + "name": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/21" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/89" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.AutoScaling/WarmPool@default", + "scopeType": 0, + "body": { + "$ref": "#/90" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.autoscaling/default/types.md b/artifacts/bicep/aws/aws.autoscaling/default/types.md index 14b2facd..8a57f7e0 100644 --- a/artifacts/bicep/aws/aws.autoscaling/default/types.md +++ b/artifacts/bicep/aws/aws.autoscaling/default/types.md @@ -3,231 +3,424 @@ ## Resource AWS.AutoScaling/AutoScalingGroup@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.AutoScaling/AutoScalingGroupProperties](#awsautoscalingautoscalinggroupproperties) (Required): properties of the resource +* **properties**: [AWS.AutoScaling/AutoScalingGroupProperties](#awsautoscalingautoscalinggroupproperties) (Required, Identifier): properties of the resource ## Resource AWS.AutoScaling/LifecycleHook@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.AutoScaling/LifecycleHookProperties](#awsautoscalinglifecyclehookproperties) (Required): properties of the resource +* **properties**: [AWS.AutoScaling/LifecycleHookProperties](#awsautoscalinglifecyclehookproperties) (Required, Identifier): properties of the resource ## Resource AWS.AutoScaling/ScalingPolicy@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.AutoScaling/ScalingPolicyProperties](#awsautoscalingscalingpolicyproperties) (Required): properties of the resource +* **properties**: [AWS.AutoScaling/ScalingPolicyProperties](#awsautoscalingscalingpolicyproperties) (Required, Identifier): properties of the resource ## Resource AWS.AutoScaling/ScheduledAction@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.AutoScaling/ScheduledActionProperties](#awsautoscalingscheduledactionproperties) (Required): properties of the resource +* **properties**: [AWS.AutoScaling/ScheduledActionProperties](#awsautoscalingscheduledactionproperties) (Required, Identifier): properties of the resource ## Resource AWS.AutoScaling/WarmPool@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.AutoScaling/WarmPoolProperties](#awsautoscalingwarmpoolproperties) (Required): properties of the resource +* **properties**: [AWS.AutoScaling/WarmPoolProperties](#awsautoscalingwarmpoolproperties) (Required, Identifier): properties of the resource + +## AcceleratorCountRequest +### Properties +* **Max**: int: The maximum value. +* **Min**: int: The minimum value. + +## AcceleratorTotalMemoryMiBRequest +### Properties +* **Max**: int: The memory maximum in MiB. +* **Min**: int: The memory minimum in MiB. ## AWS.AutoScaling/AutoScalingGroupProperties ### Properties -* **AutoScalingGroupName**: string (Identifier) -* **AvailabilityZones**: string[] -* **CapacityRebalance**: bool -* **Context**: string -* **Cooldown**: string -* **DefaultInstanceWarmup**: int -* **DesiredCapacity**: string -* **DesiredCapacityType**: string -* **HealthCheckGracePeriod**: int -* **HealthCheckType**: string -* **InstanceId**: string (WriteOnly) -* **InstanceMaintenancePolicy**: [InstanceMaintenancePolicy](#instancemaintenancepolicy) -* **LaunchConfigurationName**: string -* **LaunchTemplate**: [LaunchTemplateSpecification](#launchtemplatespecification) -* **LifecycleHookSpecificationList**: [LifecycleHookSpecification](#lifecyclehookspecification)[] -* **LoadBalancerNames**: string[] -* **MaxInstanceLifetime**: int -* **MaxSize**: string (Required) -* **MetricsCollection**: [MetricsCollection](#metricscollection)[] -* **MinSize**: string (Required) -* **MixedInstancesPolicy**: [MixedInstancesPolicy](#mixedinstancespolicy) -* **NewInstancesProtectedFromScaleIn**: bool +* **AutoScalingGroupName**: string (Identifier): The name of the Auto Scaling group. This name must be unique per Region per account. + The name can contain any ASCII character 33 to 126 including most punctuation characters, digits, and upper and lowercased letters. + You cannot use a colon (:) in the name. +* **AvailabilityZones**: string[]: A list of Availability Zones where instances in the Auto Scaling group can be created. Used for launching into the default VPC subnet in each Availability Zone when not using the ``VPCZoneIdentifier`` property, or for attaching a network interface when an existing network interface ID is specified in a launch template. +* **CapacityRebalance**: bool: Indicates whether Capacity Rebalancing is enabled. Otherwise, Capacity Rebalancing is disabled. When you turn on Capacity Rebalancing, Amazon EC2 Auto Scaling attempts to launch a Spot Instance whenever Amazon EC2 notifies that a Spot Instance is at an elevated risk of interruption. After launching a new instance, it then terminates an old instance. For more information, see [Use Capacity Rebalancing 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*. +* **Context**: string: Reserved. +* **Cooldown**: string: *Only needed if you use simple scaling policies.* + The amount of time, in seconds, between one scaling activity ending and another one starting due to simple scaling policies. For more information, see [Scaling cooldowns 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*. + Default: ``300`` seconds +* **DefaultInstanceWarmup**: int: The amount of time, in seconds, until a new instance is considered to have finished initializing and resource consumption to become stable after it enters the ``InService`` state. + During an instance refresh, Amazon EC2 Auto Scaling waits for the warm-up period after it replaces an instance before it moves on to replacing the next instance. Amazon EC2 Auto Scaling also waits for the warm-up period before aggregating the metrics for new instances with existing instances in the Amazon CloudWatch metrics that are used for scaling, resulting in more reliable usage data. For more information, see [Set the 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 *Amazon EC2 Auto Scaling User Guide*. + To manage various warm-up settings at the group level, we recommend that you set the default instance warmup, *even if it is set to 0 seconds*. To remove a value that you previously set, include the property but specify ``-1`` for the value. However, we strongly recommend keeping the default instance warmup enabled by specifying a value of ``0`` or other nominal value. + Default: None +* **DesiredCapacity**: string: The desired capacity is the initial capacity of the Auto Scaling group at the time of its creation and the capacity it attempts to maintain. It can scale beyond this capacity if you configure automatic scaling. + The number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group. If you do not specify a desired capacity when creating the stack, the default is the minimum size of the group. + CloudFormation marks the Auto Scaling group as successful (by setting its status to CREATE_COMPLETE) when the desired capacity is reached. However, if a maximum Spot price is set in the launch template or launch configuration that you specified, then desired capacity is not used as a criteria for success. Whether your request is fulfilled depends on Spot Instance capacity and your maximum price. +* **DesiredCapacityType**: string: The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports ``DesiredCapacityType`` for attribute-based instance type selection only. For more information, see [Create a mixed instances group using attribute-based instance type selection](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*. + By default, Amazon EC2 Auto Scaling specifies ``units``, which translates into number of instances. + Valid values: ``units`` | ``vcpu`` | ``memory-mib`` +* **HealthCheckGracePeriod**: int: The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service and marking it unhealthy due to a failed health check. This is useful if your instances do not immediately pass their health checks after they enter the ``InService`` state. For more information, see [Set the health check grace period for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/health-check-grace-period.html) in the *Amazon EC2 Auto Scaling User Guide*. + Default: ``0`` seconds +* **HealthCheckType**: string: A comma-separated value string of one or more health check types. + The valid values are ``EC2``, ``ELB``, and ``VPC_LATTICE``. ``EC2`` is the default health check and cannot be disabled. For more information, see [Health checks for instances in an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-health-checks.html) in the *Amazon EC2 Auto Scaling User Guide*. + Only specify ``EC2`` if you must clear a value that was previously set. +* **InstanceId**: string (WriteOnly): The ID of the instance used to base the launch configuration on. For more information, see [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 Scaling User Guide*. + If you specify ``LaunchTemplate``, ``MixedInstancesPolicy``, or ``LaunchConfigurationName``, don't specify ``InstanceId``. +* **InstanceMaintenancePolicy**: [InstanceMaintenancePolicy](#instancemaintenancepolicy): An 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 *Amazon EC2 Auto Scaling User Guide*. +* **LaunchConfigurationName**: string: The name of the launch configuration to use to launch instances. + Required only if you don't specify ``LaunchTemplate``, ``MixedInstancesPolicy``, or ``InstanceId``. +* **LaunchTemplate**: [LaunchTemplateSpecification](#launchtemplatespecification): Information used to specify the launch template and version to use to launch instances. You can alternatively associate a launch template to the Auto Scaling group by specifying a ``MixedInstancesPolicy``. For more information about creating launch templates, see [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 Scaling User Guide*. + If you omit this property, you must specify ``MixedInstancesPolicy``, ``LaunchConfigurationName``, or ``InstanceId``. +* **LifecycleHookSpecificationList**: [LifecycleHookSpecification](#lifecyclehookspecification)[]: One or more lifecycle hooks to add to the Auto Scaling group before instances are launched. +* **LoadBalancerNames**: string[]: A list of Classic Load Balancers associated with this Auto Scaling group. For Application Load Balancers, Network Load Balancers, and Gateway Load Balancers, specify the ``TargetGroupARNs`` property instead. +* **MaxInstanceLifetime**: int: The maximum amount of time, in seconds, that an instance can be in service. The default is null. If specified, the value must be either 0 or a number equal to or greater 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 *Amazon EC2 Auto Scaling User Guide*. +* **MaxSize**: string (Required): The maximum size of the group. + With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to go above ``MaxSize`` to meet your capacity requirements. In this event, Amazon EC2 Auto Scaling will never go above ``MaxSize`` by more than your largest instance weight (weights that define how many units each instance contributes to the desired capacity of the group). +* **MetricsCollection**: [MetricsCollection](#metricscollection)[]: Enables the monitoring of group metrics of an Auto Scaling group. By default, these metrics are disabled. +* **MinSize**: string (Required): The minimum size of the group. +* **MixedInstancesPolicy**: [MixedInstancesPolicy](#mixedinstancespolicy): An embedded object that specifies a mixed instances policy. + The policy includes properties that not only define the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances (optional), and how the Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacities, but also the properties that specify the instance configuration information—the launch template and instance types. The policy can also include a weight for each instance type and different launch templates for individual instance types. + For more information, see [Auto Scaling groups 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 Auto Scaling User Guide*. +* **NewInstancesProtectedFromScaleIn**: bool: Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. For more information about preventing instances from terminating on scale in, see [Use instance scale-in protection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-protection.html) in the *Amazon EC2 Auto Scaling User Guide*. * **NotificationConfiguration**: [NotificationConfiguration](#notificationconfiguration) -* **NotificationConfigurations**: [NotificationConfiguration](#notificationconfiguration)[] -* **PlacementGroup**: string -* **ServiceLinkedRoleARN**: string -* **Tags**: [TagProperty](#tagproperty)[] -* **TargetGroupARNs**: string[] -* **TerminationPolicies**: string[] -* **VPCZoneIdentifier**: string[] +* **NotificationConfigurations**: [NotificationConfiguration](#notificationconfiguration)[]: Configures an Auto Scaling group to send notifications when specified events take place. +* **PlacementGroup**: string: The name of the placement group into which to launch your instances. For more information, see [Placement groups](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) in the *Amazon EC2 User Guide for Linux Instances*. + A *cluster* placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a cluster placement group. +* **ServiceLinkedRoleARN**: string: The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS service on your behalf. By default, Amazon EC2 Auto Scaling uses a service-linked role named ``AWSServiceRoleForAutoScaling``, which it creates if it does not exist. For more information, see [Service-linked roles](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-service-linked-role.html) in the *Amazon EC2 Auto Scaling User Guide*. +* **Tags**: [TagProperty](#tagproperty)[]: One or more tags. You can tag your Auto Scaling group and propagate the tags to the Amazon EC2 instances it launches. Tags are not propagated to Amazon EBS volumes. To add tags to Amazon EBS volumes, specify the tags in a launch template but use caution. If the launch template specifies an instance tag with a key that is also specified for the Auto Scaling group, Amazon EC2 Auto Scaling overrides the value of that instance tag with the value specified by the Auto Scaling group. For more information, see [Tag Auto Scaling groups and instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-tagging.html) in the *Amazon EC2 Auto Scaling User Guide*. +* **TargetGroupARNs**: string[]: The Amazon Resource Names (ARN) of the Elastic Load Balancing target groups to associate with the Auto Scaling group. Instances are registered as targets with the target groups. The target groups receive incoming traffic and route requests to one or more registered targets. For more information, see [Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html) in the *Amazon EC2 Auto Scaling User Guide*. +* **TerminationPolicies**: string[]: A policy or a list of policies that are used to select the instance to terminate. These policies are executed in the order that you list them. For more information, see [Configure termination policies for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-termination-policies.html) in the *Amazon EC2 Auto Scaling User Guide*. + Valid values: ``Default`` | ``AllocationStrategy`` | ``ClosestToNextInstanceHour`` | ``NewestInstance`` | ``OldestInstance`` | ``OldestLaunchConfiguration`` | ``OldestLaunchTemplate`` | ``arn:aws:lambda:region:account-id:function:my-function:my-alias`` +* **VPCZoneIdentifier**: string[]: A list of subnet IDs for a virtual private cloud (VPC) where instances in the Auto Scaling group can be created. + If this resource specifies public subnets and is also in a VPC that is defined in the same stack template, you must use the [DependsOn attribute](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). + When you update ``VPCZoneIdentifier``, this retains the same Auto Scaling group and replaces old instances with new ones, according to the specified subnets. You can optionally specify how CloudFormation handles these updates by using an [UpdatePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html). + Required to launch instances into a nondefault VPC. If you specify ``VPCZoneIdentifier`` with ``AvailabilityZones``, the subnets that you specify for this property must reside in those Availability Zones. -## InstanceMaintenancePolicy +## AWS.AutoScaling/LifecycleHookProperties ### Properties -* **MaxHealthyPercentage**: int -* **MinHealthyPercentage**: int +* **AutoScalingGroupName**: string (Required, Identifier): The name of the Auto Scaling group for the lifecycle hook. +* **DefaultResult**: string: The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. The valid values are CONTINUE and ABANDON (default). +* **HeartbeatTimeout**: int: The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from 30 to 7200 seconds. The default value is 3600 seconds (1 hour). If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult property. +* **LifecycleHookName**: string (Identifier): The name of the lifecycle hook. +* **LifecycleTransition**: string (Required): The instance state to which you want to attach the lifecycle hook. +* **NotificationMetadata**: string: Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the notification target. +* **NotificationTargetARN**: string: The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. You can specify an Amazon SQS queue or an Amazon SNS topic. The notification message includes the following information: lifecycle action token, user account ID, Auto Scaling group name, lifecycle hook name, instance ID, lifecycle transition, and notification metadata. +* **RoleARN**: string: The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue. -## LaunchTemplateSpecification +## AWS.AutoScaling/ScalingPolicyProperties +### Properties +* **AdjustmentType**: string: Specifies how the scaling adjustment is interpreted. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity. +* **Arn**: string (ReadOnly, Identifier): The ARN of the AutoScaling scaling policy +* **AutoScalingGroupName**: string (Required): The name of the Auto Scaling group. +* **Cooldown**: string: The duration of the policy's cooldown period, in seconds. When a cooldown period is specified here, it overrides the default cooldown period defined for the Auto Scaling group. +* **EstimatedInstanceWarmup**: int: The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. If not provided, the default is to use the value from the default cooldown period for the Auto Scaling group. Valid only if the policy type is TargetTrackingScaling or StepScaling. +* **MetricAggregationType**: string: The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average. Valid only if the policy type is StepScaling. +* **MinAdjustmentMagnitude**: int: The minimum value to scale by when the adjustment type is PercentChangeInCapacity. For example, suppose that you create a step scaling policy to scale out an Auto Scaling group by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the group has 4 instances and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Amazon EC2 Auto Scaling scales out the group by 2 instances. +* **PolicyName**: string (ReadOnly) +* **PolicyType**: string: One of the following policy types: TargetTrackingScaling, StepScaling, SimpleScaling (default), PredictiveScaling +* **PredictiveScalingConfiguration**: [PredictiveScalingConfiguration](#predictivescalingconfiguration): A predictive scaling policy. Includes support for predefined metrics only. +* **ScalingAdjustment**: int: The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity. For exact capacity, you must specify a positive value. Required if the policy type is SimpleScaling. (Not used with any other policy type.) +* **StepAdjustments**: [StepAdjustment](#stepadjustment)[]: A set of adjustments that enable you to scale based on the size of the alarm breach. Required if the policy type is StepScaling. (Not used with any other policy type.) +* **TargetTrackingConfiguration**: [TargetTrackingConfiguration](#targettrackingconfiguration): A target tracking scaling policy. Includes support for predefined or customized metrics. + +## AWS.AutoScaling/ScheduledActionProperties ### Properties -* **LaunchTemplateId**: string -* **LaunchTemplateName**: string -* **Version**: string (Required) +* **AutoScalingGroupName**: string (Required, Identifier): The name of the Auto Scaling group. +* **DesiredCapacity**: int: The desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain. +* **EndTime**: string: The latest scheduled start time to return. If scheduled action names are provided, this parameter is ignored. +* **MaxSize**: int: The minimum size of the Auto Scaling group. +* **MinSize**: int: The minimum size of the Auto Scaling group. +* **Recurrence**: string: The recurring schedule for the action, in Unix cron syntax format. When StartTime and EndTime are specified with Recurrence , they form the boundaries of when the recurring action starts and stops. +* **ScheduledActionName**: string (ReadOnly, Identifier): Auto-generated unique identifier +* **StartTime**: string: The earliest scheduled start time to return. If scheduled action names are provided, this parameter is ignored. +* **TimeZone**: string: The time zone for the cron expression. -## LifecycleHookSpecification +## AWS.AutoScaling/WarmPoolProperties ### Properties -* **DefaultResult**: string -* **HeartbeatTimeout**: int -* **LifecycleHookName**: string (Required) -* **LifecycleTransition**: string (Required) -* **NotificationMetadata**: string -* **NotificationTargetARN**: string -* **RoleARN**: string +* **AutoScalingGroupName**: string (Required, Identifier) +* **InstanceReusePolicy**: [InstanceReusePolicy](#instancereusepolicy) +* **MaxGroupPreparedCapacity**: int +* **MinSize**: int +* **PoolState**: string -## MetricsCollection +## BaselineEbsBandwidthMbpsRequest ### Properties -* **Granularity**: string (Required) -* **Metrics**: string[] +* **Max**: int: The maximum value in Mbps. +* **Min**: int: The minimum value in Mbps. -## MixedInstancesPolicy +## CustomizedMetricSpecification ### Properties -* **InstancesDistribution**: [InstancesDistribution](#instancesdistribution) -* **LaunchTemplate**: [LaunchTemplate](#launchtemplate) (Required) +* **Dimensions**: [MetricDimension](#metricdimension)[] +* **MetricName**: string +* **Metrics**: [TargetTrackingMetricDataQuery](#targettrackingmetricdataquery)[] +* **Namespace**: string +* **Statistic**: string +* **Unit**: string + +## InstanceMaintenancePolicy +### Properties +* **MaxHealthyPercentage**: int: Specifies the upper threshold as a percentage of the desired capacity of the Auto Scaling group. It represents the maximum percentage of the group that can be in service and healthy, or pending, to support your workload when replacing instances. Value range is 100 to 200. To clear a previously set value, specify a value of ``-1``. + Both ``MinHealthyPercentage`` and ``MaxHealthyPercentage`` must be specified, and the difference between them cannot be greater than 100. A large range increases the number of instances that can be replaced at the same time. +* **MinHealthyPercentage**: int: Specifies the lower threshold as a percentage of the desired capacity of the Auto Scaling group. It represents the minimum percentage of the group to keep in service, healthy, and ready to use to support your workload when replacing instances. Value range is 0 to 100. To clear a previously set value, specify a value of ``-1``. + +## InstanceRequirements +### Properties +* **AcceleratorCount**: [AcceleratorCountRequest](#acceleratorcountrequest): The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) for an instance type. + To exclude accelerator-enabled instance types, set ``Max`` to ``0``. + Default: No minimum or maximum limits +* **AcceleratorManufacturers**: string[]: Indicates whether instance types must have accelerators by specific manufacturers. + + For instance types with NVIDIA devices, specify ``nvidia``. + + For instance types with AMD devices, specify ``amd``. + + For instance types with AWS devices, specify ``amazon-web-services``. + + For instance types with Xilinx devices, specify ``xilinx``. + + Default: Any manufacturer +* **AcceleratorNames**: string[]: Lists the accelerators that must be on an instance type. + + For instance types with NVIDIA A100 GPUs, specify ``a100``. + + For instance types with NVIDIA V100 GPUs, specify ``v100``. + + For instance types with NVIDIA K80 GPUs, specify ``k80``. + + For instance types with NVIDIA T4 GPUs, specify ``t4``. + + For instance types with NVIDIA M60 GPUs, specify ``m60``. + + For instance types with AMD Radeon Pro V520 GPUs, specify ``radeon-pro-v520``. + + For instance types with Xilinx VU9P FPGAs, specify ``vu9p``. + + Default: Any accelerator +* **AcceleratorTotalMemoryMiB**: [AcceleratorTotalMemoryMiBRequest](#acceleratortotalmemorymibrequest): The minimum and maximum total memory size for the accelerators on an instance type, in MiB. + Default: No minimum or maximum limits +* **AcceleratorTypes**: string[]: Lists the accelerator types that must be on an instance type. + + For instance types with GPU accelerators, specify ``gpu``. + + For instance types with FPGA accelerators, specify ``fpga``. + + For instance types with inference accelerators, specify ``inference``. + + Default: Any accelerator type +* **AllowedInstanceTypes**: string[]: The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes. + You can use strings with one or more wild cards, represented by an asterisk (``*``), to allow an instance type, size, or generation. The following are examples: ``m5.8xlarge``, ``c5*.*``, ``m5a.*``, ``r*``, ``*3*``. + For example, if you specify ``c5*``, Amazon EC2 Auto Scaling will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify ``m5a.*``, Amazon EC2 Auto Scaling will allow all the M5a instance types, but not the M5n instance types. + If you specify ``AllowedInstanceTypes``, you can't specify ``ExcludedInstanceTypes``. + Default: All instance types +* **BareMetal**: string: Indicates whether bare metal instance types are included, excluded, or required. + Default: ``excluded`` +* **BaselineEbsBandwidthMbps**: [BaselineEbsBandwidthMbpsRequest](#baselineebsbandwidthmbpsrequest): The minimum and maximum baseline bandwidth performance for an instance type, in Mbps. For more information, see [Amazon EBS–optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the *Amazon EC2 User Guide for Linux Instances*. + Default: No minimum or maximum limits +* **BurstablePerformance**: string: Indicates whether burstable performance instance types are included, excluded, or required. For more information, see [Burstable performance instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) in the *Amazon EC2 User Guide for Linux Instances*. + Default: ``excluded`` +* **CpuManufacturers**: string[]: Lists which specific CPU manufacturers to include. + + For instance types with Intel CPUs, specify ``intel``. + + For instance types with AMD CPUs, specify ``amd``. + + For instance types with AWS CPUs, specify ``amazon-web-services``. + + Don't confuse the CPU hardware manufacturer with the CPU hardware architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template. + Default: Any manufacturer +* **ExcludedInstanceTypes**: string[]: The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk (``*``), to exclude an instance family, type, size, or generation. The following are examples: ``m5.8xlarge``, ``c5*.*``, ``m5a.*``, ``r*``, ``*3*``. + For example, if you specify ``c5*``, you are excluding the entire C5 instance family, which includes all C5a and C5n instance types. If you specify ``m5a.*``, Amazon EC2 Auto Scaling will exclude all the M5a instance types, but not the M5n instance types. + If you specify ``ExcludedInstanceTypes``, you can't specify ``AllowedInstanceTypes``. + Default: No excluded instance types +* **InstanceGenerations**: string[]: Indicates whether current or previous generation instance types are included. + + For current generation instance types, specify ``current``. The current generation includes EC2 instance types currently recommended for use. This typically includes the latest two to three generations in each instance family. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide for Linux Instances*. + + For previous generation instance types, specify ``previous``. + + Default: Any current or previous generation +* **LocalStorage**: string: Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, see [Amazon EC2 instance store](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html) in the *Amazon EC2 User Guide for Linux Instances*. + Default: ``included`` +* **LocalStorageTypes**: string[]: Indicates the type of local storage that is required. + + For instance types with hard disk drive (HDD) storage, specify ``hdd``. + + For instance types with solid state drive (SSD) storage, specify ``ssd``. + + Default: Any local storage type +* **MaxSpotPriceAsPercentageOfOptimalOnDemandPrice**: int: [Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold. + The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage. + If you set ``DesiredCapacityType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is based on the per-vCPU or per-memory price instead of the per instance price. + Only one of ``SpotMaxPricePercentageOverLowestPrice`` or ``MaxSpotPriceAsPercentageOfOptimalOnDemandPrice`` can be specified. If you don't specify either, Amazon EC2 Auto Scaling will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as ``999999``. +* **MemoryGiBPerVCpu**: [MemoryGiBPerVCpuRequest](#memorygibpervcpurequest): The minimum and maximum amount of memory per vCPU for an instance type, in GiB. + Default: No minimum or maximum limits +* **MemoryMiB**: [MemoryMiBRequest](#memorymibrequest) (Required): The minimum and maximum instance memory size for an instance type, in MiB. +* **NetworkBandwidthGbps**: [NetworkBandwidthGbpsRequest](#networkbandwidthgbpsrequest): The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps). + Default: No minimum or maximum limits +* **NetworkInterfaceCount**: [NetworkInterfaceCountRequest](#networkinterfacecountrequest): The minimum and maximum number of network interfaces for an instance type. + Default: No minimum or maximum limits +* **OnDemandMaxPricePercentageOverLowestPrice**: int: [Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold. + The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage. + To turn off price protection, specify a high value, such as ``999999``. + If you set ``DesiredCapacityType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per instance price. + Default: ``20`` +* **RequireHibernateSupport**: bool: Indicates whether instance types must provide On-Demand Instance hibernation support. + Default: ``false`` +* **SpotMaxPricePercentageOverLowestPrice**: int: [Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold. + The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage. + If you set ``DesiredCapacityType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is based on the per-vCPU or per-memory price instead of the per instance price. + Only one of ``SpotMaxPricePercentageOverLowestPrice`` or ``MaxSpotPriceAsPercentageOfOptimalOnDemandPrice`` can be specified. If you don't specify either, Amazon EC2 Auto Scaling will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as ``999999``. +* **TotalLocalStorageGB**: [TotalLocalStorageGBRequest](#totallocalstoragegbrequest): The minimum and maximum total local storage size for an instance type, in GB. + Default: No minimum or maximum limits +* **VCpuCount**: [VCpuCountRequest](#vcpucountrequest) (Required): The minimum and maximum number of vCPUs for an instance type. + +## InstanceReusePolicy +### Properties +* **ReuseOnScaleIn**: bool ## InstancesDistribution ### Properties -* **OnDemandAllocationStrategy**: string -* **OnDemandBaseCapacity**: int -* **OnDemandPercentageAboveBaseCapacity**: int -* **SpotAllocationStrategy**: string -* **SpotInstancePools**: int -* **SpotMaxPrice**: string +* **OnDemandAllocationStrategy**: string: The allocation strategy to apply to your On-Demand Instances when they are launched. Possible instance types are determined by the launch template overrides that you specify. + The following lists the valid values: + + lowest-price Uses price to determine which instance types are the highest priority, launching the lowest priced instance types within an Availability Zone first. This is the default value for Auto Scaling groups that specify InstanceRequirements. + prioritized You set the order of instance types for the launch template overrides from highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling launches your highest priority instance types first. If all your On-Demand capacity cannot be fulfilled using your highest priority instance type, then Amazon EC2 Auto Scaling launches the remaining capacity using the second priority instance type, and so on. This is the default value for Auto Scaling groups that don't specify InstanceRequirements and cannot be used for groups that do. +* **OnDemandBaseCapacity**: int: The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand Instances. This base portion is launched first as your group scales. + This number has the same unit of measurement as the group's desired capacity. If you change the default unit of measurement (number of instances) by specifying weighted capacity values in your launch template overrides list, or by changing the default desired capacity type setting of the group, you must specify this number using the same unit of measurement. + Default: 0 + An update to this setting means a gradual replacement of instances to adjust the current On-Demand Instance levels. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the previous ones. +* **OnDemandPercentageAboveBaseCapacity**: int: Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond ``OnDemandBaseCapacity``. Expressed as a number (for example, 20 specifies 20% On-Demand Instances, 80% Spot Instances). If set to 100, only On-Demand Instances are used. + Default: 100 + An update to this setting means a gradual replacement of instances to adjust the current On-Demand and Spot Instance levels for your additional capacity higher than the base capacity. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the previous ones. +* **SpotAllocationStrategy**: string: The allocation strategy to apply to your Spot Instances when they are launched. Possible instance types are determined by the launch template overrides that you specify. + The following lists the valid values: + + capacity-optimized Requests Spot Instances using pools that are optimally chosen based on the available Spot capacity. This strategy has the lowest risk of interruption. To give certain instance types a higher chance of launching first, use capacity-optimized-prioritized. + capacity-optimized-prioritized You set the order of instance types for the launch template overrides from highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling honors the instance type priorities on a best effort basis but optimizes for capacity first. Note that if the On-Demand allocation strategy is set to prioritized, the same priority is applied when fulfilling On-Demand capacity. This is not a valid value for Auto Scaling groups that specify InstanceRequirements. + lowest-price Requests Spot Instances using the lowest priced pools within an Availability Zone, across the number of Spot pools that you specify for the SpotInstancePools property. To ensure that your desired capacity is met, you might receive Spot Instances from several pools. This is the default value, but it might lead to high interruption rates because this strategy only considers instance price and not available capacity. + price-capacity-optimized (recommended) The price and capacity optimized allocation strategy looks at both price and capacity to select the Spot Instance pools that are the least likely to be interrupted and have the lowest possible price. +* **SpotInstancePools**: int: The number of Spot Instance pools across which to allocate your Spot Instances. The Spot pools are determined from the different instance types in the overrides. Valid only when the ``SpotAllocationStrategy`` is ``lowest-price``. Value must be in the range of 1–20. + Default: 2 +* **SpotMaxPrice**: string: The maximum price per unit hour that you are willing to pay for a Spot Instance. If your maximum price is lower than the Spot price for the instance types that you selected, your Spot Instances are not launched. We do not recommend specifying a maximum price because it can lead to increased interruptions. When Spot Instances launch, you pay the current Spot price. To remove a maximum price that you previously set, include the property but specify an empty string ("") for the value. + If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify one. + Valid Range: Minimum value of 0.001 ## LaunchTemplate ### Properties -* **LaunchTemplateSpecification**: [LaunchTemplateSpecification](#launchtemplatespecification) (Required) -* **Overrides**: [LaunchTemplateOverrides](#launchtemplateoverrides)[] +* **LaunchTemplateSpecification**: [LaunchTemplateSpecification](#launchtemplatespecification) (Required): The launch template. +* **Overrides**: [LaunchTemplateOverrides](#launchtemplateoverrides)[]: Any properties that you specify override the same properties in the launch template. ## LaunchTemplateOverrides ### Properties -* **InstanceRequirements**: [InstanceRequirements](#instancerequirements) -* **InstanceType**: string -* **LaunchTemplateSpecification**: [LaunchTemplateSpecification](#launchtemplatespecification) -* **WeightedCapacity**: string +* **InstanceRequirements**: [InstanceRequirements](#instancerequirements): The instance requirements. Amazon EC2 Auto Scaling uses your specified requirements to identify instance types. Then, it uses your On-Demand and Spot allocation strategies to launch instances from these instance types. + You can specify up to four separate sets of instance requirements per Auto Scaling group. This is useful for provisioning instances from different Amazon Machine Images (AMIs) in the same Auto Scaling group. To do this, create the AMIs and create a new launch template for each AMI. Then, create a compatible set of instance requirements for each launch template. + If you specify ``InstanceRequirements``, you can't specify ``InstanceType``. +* **InstanceType**: string: The instance type, such as ``m3.xlarge``. You must specify an instance type that is supported in your requested Region and Availability Zones. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide for Linux Instances*. + You can specify up to 40 instance types per Auto Scaling group. +* **LaunchTemplateSpecification**: [LaunchTemplateSpecification](#launchtemplatespecification): Provides a launch template for the specified instance type or set of instance requirements. For example, some instance types might require a launch template with a different AMI. If not provided, Amazon EC2 Auto Scaling uses the launch template that's specified in the ``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 *Amazon EC2 Auto Scaling User Guide*. + You can specify up to 20 launch templates per Auto Scaling group. The launch templates specified in the overrides and in the ``LaunchTemplate`` definition count towards this limit. +* **WeightedCapacity**: string: If you provide a list of instance types to use, you can specify the number of capacity units provided by each instance type in terms of virtual CPUs, memory, storage, throughput, or other relative performance characteristic. When a Spot or On-Demand Instance is launched, the capacity units count toward the desired capacity. Amazon EC2 Auto Scaling launches instances until the desired capacity is totally fulfilled, even if this results in an overage. For example, if there are two units remaining to fulfill capacity, and Amazon EC2 Auto Scaling can only launch an instance with a ``WeightedCapacity`` of five units, the instance is launched, and the desired capacity is exceeded by three units. For more information, see [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 EC2 Auto Scaling User Guide*. Value must be in the range of 1-999. + If you specify a value for ``WeightedCapacity`` for one instance type, you must specify a value for ``WeightedCapacity`` for all of them. + Every Auto Scaling group has three size parameters (``DesiredCapacity``, ``MaxSize``, and ``MinSize``). Usually, you set these sizes based on a specific number of instances. However, if you configure a mixed instances policy that defines weights for the instance types, you must specify these sizes with the same units that you use for weighting instances. -## InstanceRequirements +## LaunchTemplateSpecification ### Properties -* **AcceleratorCount**: [AcceleratorCountRequest](#acceleratorcountrequest) -* **AcceleratorManufacturers**: string[] -* **AcceleratorNames**: string[] -* **AcceleratorTotalMemoryMiB**: [AcceleratorTotalMemoryMiBRequest](#acceleratortotalmemorymibrequest) -* **AcceleratorTypes**: string[] -* **AllowedInstanceTypes**: string[] -* **BareMetal**: string -* **BaselineEbsBandwidthMbps**: [BaselineEbsBandwidthMbpsRequest](#baselineebsbandwidthmbpsrequest) -* **BurstablePerformance**: string -* **CpuManufacturers**: string[] -* **ExcludedInstanceTypes**: string[] -* **InstanceGenerations**: string[] -* **LocalStorage**: string -* **LocalStorageTypes**: string[] -* **MemoryGiBPerVCpu**: [MemoryGiBPerVCpuRequest](#memorygibpervcpurequest) -* **MemoryMiB**: [MemoryMiBRequest](#memorymibrequest) (Required) -* **NetworkBandwidthGbps**: [NetworkBandwidthGbpsRequest](#networkbandwidthgbpsrequest) -* **NetworkInterfaceCount**: [NetworkInterfaceCountRequest](#networkinterfacecountrequest) -* **OnDemandMaxPricePercentageOverLowestPrice**: int -* **RequireHibernateSupport**: bool -* **SpotMaxPricePercentageOverLowestPrice**: int -* **TotalLocalStorageGB**: [TotalLocalStorageGBRequest](#totallocalstoragegbrequest) -* **VCpuCount**: [VCpuCountRequest](#vcpucountrequest) (Required) +* **LaunchTemplateId**: string: The ID of the launch template. + You must specify the ``LaunchTemplateID`` or the ``LaunchTemplateName``, but not both. +* **LaunchTemplateName**: string: The name of the launch template. + You must specify the ``LaunchTemplateName`` or the ``LaunchTemplateID``, but not both. +* **Version**: string (Required): The version number of the launch template. + Specifying ``$Latest`` or ``$Default`` for the template version number is not supported. However, you can specify ``LatestVersionNumber`` or ``DefaultVersionNumber`` using the ``Fn::GetAtt`` intrinsic function. For more information, see [Fn::GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html). + For 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`` resource. -## AcceleratorCountRequest +## LifecycleHookSpecification ### Properties -* **Max**: int -* **Min**: int +* **DefaultResult**: string: The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. The default value is ``ABANDON``. + Valid values: ``CONTINUE`` | ``ABANDON`` +* **HeartbeatTimeout**: int: The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from ``30`` to ``7200`` seconds. The default value is ``3600`` seconds (1 hour). +* **LifecycleHookName**: string (Required): The name of the lifecycle hook. +* **LifecycleTransition**: string (Required): The lifecycle transition. For Auto Scaling groups, there are two major lifecycle transitions. + + To create a lifecycle hook for scale-out events, specify ``autoscaling:EC2_INSTANCE_LAUNCHING``. + + To create a lifecycle hook for scale-in events, specify ``autoscaling:EC2_INSTANCE_TERMINATING``. +* **NotificationMetadata**: string: Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target. +* **NotificationTargetARN**: string: The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling sends notifications to when an instance is in a wait state for the lifecycle hook. You can specify an Amazon SNS topic or an Amazon SQS queue. +* **RoleARN**: string: The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target. For information about creating this role, see [Prepare to add a lifecycle hook to your Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/prepare-for-lifecycle-notifications.html) in the *Amazon EC2 Auto Scaling User Guide*. + Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue. -## AcceleratorTotalMemoryMiBRequest +## MemoryGiBPerVCpuRequest ### Properties -* **Max**: int -* **Min**: int +* **Max**: int: The memory maximum in GiB. +* **Min**: int: The memory minimum in GiB. -## BaselineEbsBandwidthMbpsRequest +## MemoryMiBRequest ### Properties -* **Max**: int -* **Min**: int +* **Max**: int: The memory maximum in MiB. +* **Min**: int: The memory minimum in MiB. -## MemoryGiBPerVCpuRequest +## Metric ### Properties -* **Max**: int -* **Min**: int +* **Dimensions**: [MetricDimension](#metricdimension)[] +* **MetricName**: string (Required) +* **Namespace**: string (Required) -## MemoryMiBRequest +## MetricDataQuery ### Properties -* **Max**: int -* **Min**: int +* **Expression**: string +* **Id**: string (Required) +* **Label**: string +* **MetricStat**: [MetricStat](#metricstat) +* **ReturnData**: bool -## NetworkBandwidthGbpsRequest +## MetricDimension ### Properties -* **Max**: int -* **Min**: int +* **Name**: string (Required) +* **Value**: string (Required) -## NetworkInterfaceCountRequest +## MetricsCollection ### Properties -* **Max**: int -* **Min**: int +* **Granularity**: string (Required): The frequency at which Amazon EC2 Auto Scaling sends aggregated data to CloudWatch. The only valid value is ``1Minute``. +* **Metrics**: string[]: Identifies the metrics to enable. + You can specify one or more of the following metrics: + + ``GroupMinSize`` + + ``GroupMaxSize`` + + ``GroupDesiredCapacity`` + + ``GroupInServiceInstances`` + + ``GroupPendingInstances`` + + ``GroupStandbyInstances`` + + ``GroupTerminatingInstances`` + + ``GroupTotalInstances`` + + ``GroupInServiceCapacity`` + + ``GroupPendingCapacity`` + + ``GroupStandbyCapacity`` + + ``GroupTerminatingCapacity`` + + ``GroupTotalCapacity`` + + ``WarmPoolDesiredCapacity`` + + ``WarmPoolWarmedCapacity`` + + ``WarmPoolPendingCapacity`` + + ``WarmPoolTerminatingCapacity`` + + ``WarmPoolTotalCapacity`` + + ``GroupAndWarmPoolDesiredCapacity`` + + ``GroupAndWarmPoolTotalCapacity`` + + If you specify ``Granularity`` and don't specify any metrics, all metrics are enabled. + For more information, see [Amazon CloudWatch metrics for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-metrics.html) in the *Amazon EC2 Auto Scaling User Guide*. -## TotalLocalStorageGBRequest +## MetricStat ### Properties -* **Max**: int -* **Min**: int +* **Metric**: [Metric](#metric) (Required) +* **Stat**: string (Required) +* **Unit**: string -## VCpuCountRequest +## MixedInstancesPolicy ### Properties -* **Max**: int -* **Min**: int +* **InstancesDistribution**: [InstancesDistribution](#instancesdistribution): The instances distribution. +* **LaunchTemplate**: [LaunchTemplate](#launchtemplate) (Required): One or more launch templates and the instance types (overrides) that are used to launch EC2 instances to fulfill On-Demand and Spot capacities. -## NotificationConfiguration +## NetworkBandwidthGbpsRequest ### Properties -* **NotificationTypes**: string[] -* **TopicARN**: string | string[] (Required) +* **Max**: int: The maximum amount of network bandwidth, in gigabits per second (Gbps). +* **Min**: int: The minimum amount of network bandwidth, in gigabits per second (Gbps). -## TagProperty +## NetworkInterfaceCountRequest ### Properties -* **Key**: string (Required) -* **PropagateAtLaunch**: bool (Required) -* **Value**: string (Required) +* **Max**: int: The maximum number of network interfaces. +* **Min**: int: The minimum number of network interfaces. -## AWS.AutoScaling/LifecycleHookProperties +## NotificationConfiguration ### Properties -* **AutoScalingGroupName**: string (Required, Identifier): The name of the Auto Scaling group for the lifecycle hook. -* **DefaultResult**: string: The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. The valid values are CONTINUE and ABANDON (default). -* **HeartbeatTimeout**: int: The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from 30 to 7200 seconds. The default value is 3600 seconds (1 hour). If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult property. -* **LifecycleHookName**: string (Identifier): The name of the lifecycle hook. -* **LifecycleTransition**: string (Required): The instance state to which you want to attach the lifecycle hook. -* **NotificationMetadata**: string: Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the notification target. -* **NotificationTargetARN**: string: The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. You can specify an Amazon SQS queue or an Amazon SNS topic. The notification message includes the following information: lifecycle action token, user account ID, Auto Scaling group name, lifecycle hook name, instance ID, lifecycle transition, and notification metadata. -* **RoleARN**: string: The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue. +* **NotificationTypes**: string[]: A list of event types that send a notification. Event types can include any of the following types. + *Allowed values*: + + ``autoscaling:EC2_INSTANCE_LAUNCH`` + + ``autoscaling:EC2_INSTANCE_LAUNCH_ERROR`` + + ``autoscaling:EC2_INSTANCE_TERMINATE`` + + ``autoscaling:EC2_INSTANCE_TERMINATE_ERROR`` + + ``autoscaling:TEST_NOTIFICATION`` +* **TopicARN**: string | string[] (Required): The Amazon Resource Name (ARN) of the Amazon SNS topic. -## AWS.AutoScaling/ScalingPolicyProperties +## PredefinedMetricSpecification ### Properties -* **AdjustmentType**: string: Specifies how the scaling adjustment is interpreted. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity. -* **Arn**: string (ReadOnly, Identifier): The ARN of the AutoScaling scaling policy -* **AutoScalingGroupName**: string (Required): The name of the Auto Scaling group. -* **Cooldown**: string: The duration of the policy's cooldown period, in seconds. When a cooldown period is specified here, it overrides the default cooldown period defined for the Auto Scaling group. -* **EstimatedInstanceWarmup**: int: The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. If not provided, the default is to use the value from the default cooldown period for the Auto Scaling group. Valid only if the policy type is TargetTrackingScaling or StepScaling. -* **MetricAggregationType**: string: The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average. Valid only if the policy type is StepScaling. -* **MinAdjustmentMagnitude**: int: The minimum value to scale by when the adjustment type is PercentChangeInCapacity. For example, suppose that you create a step scaling policy to scale out an Auto Scaling group by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the group has 4 instances and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Amazon EC2 Auto Scaling scales out the group by 2 instances. -* **PolicyName**: string (ReadOnly) -* **PolicyType**: string: One of the following policy types: TargetTrackingScaling, StepScaling, SimpleScaling (default), PredictiveScaling -* **PredictiveScalingConfiguration**: [PredictiveScalingConfiguration](#predictivescalingconfiguration): A predictive scaling policy. Includes support for predefined metrics only. -* **ScalingAdjustment**: int: The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity. For exact capacity, you must specify a positive value. Required if the policy type is SimpleScaling. (Not used with any other policy type.) -* **StepAdjustments**: [StepAdjustment](#stepadjustment)[]: A set of adjustments that enable you to scale based on the size of the alarm breach. Required if the policy type is StepScaling. (Not used with any other policy type.) -* **TargetTrackingConfiguration**: [TargetTrackingConfiguration](#targettrackingconfiguration): A target tracking scaling policy. Includes support for predefined or customized metrics. +* **PredefinedMetricType**: string (Required) +* **ResourceLabel**: string ## PredictiveScalingConfiguration ### Properties @@ -237,45 +430,10 @@ * **Mode**: string * **SchedulingBufferTime**: int -## PredictiveScalingMetricSpecification -### Properties -* **CustomizedCapacityMetricSpecification**: [PredictiveScalingCustomizedCapacityMetric](#predictivescalingcustomizedcapacitymetric) -* **CustomizedLoadMetricSpecification**: [PredictiveScalingCustomizedLoadMetric](#predictivescalingcustomizedloadmetric) -* **CustomizedScalingMetricSpecification**: [PredictiveScalingCustomizedScalingMetric](#predictivescalingcustomizedscalingmetric) -* **PredefinedLoadMetricSpecification**: [PredictiveScalingPredefinedLoadMetric](#predictivescalingpredefinedloadmetric) -* **PredefinedMetricPairSpecification**: [PredictiveScalingPredefinedMetricPair](#predictivescalingpredefinedmetricpair) -* **PredefinedScalingMetricSpecification**: [PredictiveScalingPredefinedScalingMetric](#predictivescalingpredefinedscalingmetric) -* **TargetValue**: int (Required) - ## PredictiveScalingCustomizedCapacityMetric ### Properties * **MetricDataQueries**: [MetricDataQuery](#metricdataquery)[] (Required) -## MetricDataQuery -### Properties -* **Expression**: string -* **Id**: string (Required) -* **Label**: string -* **MetricStat**: [MetricStat](#metricstat) -* **ReturnData**: bool - -## MetricStat -### Properties -* **Metric**: [Metric](#metric) (Required) -* **Stat**: string (Required) -* **Unit**: string - -## Metric -### Properties -* **Dimensions**: [MetricDimension](#metricdimension)[] -* **MetricName**: string (Required) -* **Namespace**: string (Required) - -## MetricDimension -### Properties -* **Name**: string (Required) -* **Value**: string (Required) - ## PredictiveScalingCustomizedLoadMetric ### Properties * **MetricDataQueries**: [MetricDataQuery](#metricdataquery)[] (Required) @@ -284,6 +442,16 @@ ### Properties * **MetricDataQueries**: [MetricDataQuery](#metricdataquery)[] (Required) +## PredictiveScalingMetricSpecification +### Properties +* **CustomizedCapacityMetricSpecification**: [PredictiveScalingCustomizedCapacityMetric](#predictivescalingcustomizedcapacitymetric) +* **CustomizedLoadMetricSpecification**: [PredictiveScalingCustomizedLoadMetric](#predictivescalingcustomizedloadmetric) +* **CustomizedScalingMetricSpecification**: [PredictiveScalingCustomizedScalingMetric](#predictivescalingcustomizedscalingmetric) +* **PredefinedLoadMetricSpecification**: [PredictiveScalingPredefinedLoadMetric](#predictivescalingpredefinedloadmetric) +* **PredefinedMetricPairSpecification**: [PredictiveScalingPredefinedMetricPair](#predictivescalingpredefinedmetricpair) +* **PredefinedScalingMetricSpecification**: [PredictiveScalingPredefinedScalingMetric](#predictivescalingpredefinedscalingmetric) +* **TargetValue**: int (Required) + ## PredictiveScalingPredefinedLoadMetric ### Properties * **PredefinedMetricType**: string (Required) @@ -305,6 +473,12 @@ * **MetricIntervalUpperBound**: int * **ScalingAdjustment**: int (Required) +## TagProperty +### Properties +* **Key**: string (Required): The tag key. +* **PropagateAtLaunch**: bool (Required): Set to ``true`` if you want CloudFormation to copy the tag to EC2 instances that are launched as part of the Auto Scaling group. Set to ``false`` if you want the tag attached only to the Auto Scaling group and not copied to any instances launched as part of the Auto Scaling group. +* **Value**: string (Required): The tag value. + ## TargetTrackingConfiguration ### Properties * **CustomizedMetricSpecification**: [CustomizedMetricSpecification](#customizedmetricspecification) @@ -312,40 +486,27 @@ * **PredefinedMetricSpecification**: [PredefinedMetricSpecification](#predefinedmetricspecification) * **TargetValue**: int (Required) -## CustomizedMetricSpecification +## TargetTrackingMetricDataQuery ### Properties -* **Dimensions**: [MetricDimension](#metricdimension)[] -* **MetricName**: string (Required) -* **Namespace**: string (Required) -* **Statistic**: string (Required) -* **Unit**: string - -## PredefinedMetricSpecification -### Properties -* **PredefinedMetricType**: string (Required) -* **ResourceLabel**: string +* **Expression**: string +* **Id**: string (Required) +* **Label**: string +* **MetricStat**: [TargetTrackingMetricStat](#targettrackingmetricstat) +* **ReturnData**: bool -## AWS.AutoScaling/ScheduledActionProperties +## TargetTrackingMetricStat ### Properties -* **AutoScalingGroupName**: string (Required, Identifier): The name of the Auto Scaling group. -* **DesiredCapacity**: int: The desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain. -* **EndTime**: string: The latest scheduled start time to return. If scheduled action names are provided, this parameter is ignored. -* **MaxSize**: int: The minimum size of the Auto Scaling group. -* **MinSize**: int: The minimum size of the Auto Scaling group. -* **Recurrence**: string: The recurring schedule for the action, in Unix cron syntax format. When StartTime and EndTime are specified with Recurrence , they form the boundaries of when the recurring action starts and stops. -* **ScheduledActionName**: string (ReadOnly, Identifier): Auto-generated unique identifier -* **StartTime**: string: The earliest scheduled start time to return. If scheduled action names are provided, this parameter is ignored. -* **TimeZone**: string: The time zone for the cron expression. +* **Metric**: [Metric](#metric) (Required) +* **Stat**: string (Required) +* **Unit**: string -## AWS.AutoScaling/WarmPoolProperties +## TotalLocalStorageGBRequest ### Properties -* **AutoScalingGroupName**: string (Required, Identifier) -* **InstanceReusePolicy**: [InstanceReusePolicy](#instancereusepolicy) -* **MaxGroupPreparedCapacity**: int -* **MinSize**: int -* **PoolState**: string +* **Max**: int: The storage maximum in GB. +* **Min**: int: The storage minimum in GB. -## InstanceReusePolicy +## VCpuCountRequest ### Properties -* **ReuseOnScaleIn**: bool +* **Max**: int: The maximum number of vCPUs. +* **Min**: int: The minimum number of vCPUs. diff --git a/artifacts/bicep/aws/aws.b2bi/default/types.json b/artifacts/bicep/aws/aws.b2bi/default/types.json index 664593c6..66a1d8e3 100644 --- a/artifacts/bicep/aws/aws.b2bi/default/types.json +++ b/artifacts/bicep/aws/aws.b2bi/default/types.json @@ -1 +1,693 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"CapabilityConfiguration","Properties":{}}},{"2":{"Name":"CapabilityType"}},{"2":{"Name":"EdiConfiguration","Properties":{"InputLocation":{"Type":12,"Flags":1},"OutputLocation":{"Type":12,"Flags":1},"TransformerId":{"Type":4,"Flags":1},"Type":{"Type":17,"Flags":1}}}},{"2":{"Name":"EdiType","Properties":{}}},{"2":{"Name":"S3Location","Properties":{"BucketName":{"Type":4,"Flags":0},"Key":{"Type":4,"Flags":0}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"X12Details","Properties":{"TransactionSet":{"Type":4,"Flags":0},"Version":{"Type":4,"Flags":0}}}},{"2":{"Name":"X12TransactionSet"}},{"2":{"Name":"X12Version"}},{"2":{"Name":"Capability_EdiType","Properties":{}}},{"2":{"Name":"AWS.B2BI/CapabilityProperties","Properties":{"CapabilityArn":{"Type":4,"Flags":2},"CapabilityId":{"Type":4,"Flags":18},"Configuration":{"Type":8,"Flags":1},"CreatedAt":{"Type":4,"Flags":2},"InstructionsDocuments":{"Type":19,"Flags":0},"ModifiedAt":{"Type":4,"Flags":2},"Name":{"Type":4,"Flags":1},"Tags":{"Type":20,"Flags":0},"Type":{"Type":4,"Flags":1}}}},{"3":{"ItemType":12}},{"3":{"ItemType":13}},{"2":{"Name":"AWS.B2BI/Capability","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":18,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.B2BI/Capability@default","ScopeType":0,"Body":21}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.B2BI/PartnershipProperties","Properties":{"Capabilities":{"Type":25,"Flags":0},"CreatedAt":{"Type":4,"Flags":2},"Email":{"Type":4,"Flags":1},"ModifiedAt":{"Type":4,"Flags":2},"Name":{"Type":4,"Flags":1},"PartnershipArn":{"Type":4,"Flags":2},"PartnershipId":{"Type":4,"Flags":18},"Phone":{"Type":4,"Flags":0},"ProfileId":{"Type":4,"Flags":1},"Tags":{"Type":26,"Flags":0},"TradingPartnerId":{"Type":4,"Flags":2}}}},{"3":{"ItemType":4}},{"3":{"ItemType":23}},{"2":{"Name":"AWS.B2BI/Partnership","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":24,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.B2BI/Partnership@default","ScopeType":0,"Body":27}},{"2":{"Name":"Logging"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.B2BI/ProfileProperties","Properties":{"BusinessName":{"Type":4,"Flags":1},"CreatedAt":{"Type":4,"Flags":2},"Email":{"Type":4,"Flags":0},"LogGroupName":{"Type":4,"Flags":2},"Logging":{"Type":4,"Flags":1},"ModifiedAt":{"Type":4,"Flags":2},"Name":{"Type":4,"Flags":1},"Phone":{"Type":4,"Flags":1},"ProfileArn":{"Type":4,"Flags":2},"ProfileId":{"Type":4,"Flags":18},"Tags":{"Type":32,"Flags":0}}}},{"3":{"ItemType":30}},{"2":{"Name":"AWS.B2BI/Profile","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":31,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.B2BI/Profile@default","ScopeType":0,"Body":33}},{"2":{"Name":"EdiType","Properties":{}}},{"2":{"Name":"FileFormat"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"TransformerStatus"}},{"2":{"Name":"X12Details","Properties":{"TransactionSet":{"Type":4,"Flags":0},"Version":{"Type":4,"Flags":0}}}},{"2":{"Name":"X12TransactionSet"}},{"2":{"Name":"X12Version"}},{"2":{"Name":"AWS.B2BI/TransformerProperties","Properties":{"CreatedAt":{"Type":4,"Flags":2},"EdiType":{"Type":35,"Flags":1},"FileFormat":{"Type":4,"Flags":1},"MappingTemplate":{"Type":4,"Flags":1},"ModifiedAt":{"Type":4,"Flags":0},"Name":{"Type":4,"Flags":1},"SampleDocument":{"Type":4,"Flags":0},"Status":{"Type":4,"Flags":1},"Tags":{"Type":43,"Flags":0},"TransformerArn":{"Type":4,"Flags":2},"TransformerId":{"Type":4,"Flags":18}}}},{"3":{"ItemType":37}},{"2":{"Name":"AWS.B2BI/Transformer","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":42,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.B2BI/Transformer@default","ScopeType":0,"Body":44}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "CapabilityConfiguration", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CapabilityType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "EdiConfiguration", + "properties": { + "InputLocation": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + }, + "OutputLocation": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + }, + "TransformerId": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + }, + "Type": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "EdiType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "S3Location", + "properties": { + "BucketName": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "Key": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "X12Details", + "properties": { + "TransactionSet": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "Version": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "X12TransactionSet", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "X12Version", + "properties": {} + }, + { + "$type": "StringType" + }, + { + "$type": "ObjectType", + "name": "Capability_EdiType", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.B2BI/CapabilityProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ObjectType", + "name": "AWS.B2BI/CapabilityProperties", + "properties": { + "CapabilityArn": { + "type": { + "$ref": "#/9" + }, + "flags": 2 + }, + "CapabilityId": { + "type": { + "$ref": "#/9" + }, + "flags": 18 + }, + "Configuration": { + "type": { + "$ref": "#/0" + }, + "flags": 1 + }, + "CreatedAt": { + "type": { + "$ref": "#/9" + }, + "flags": 2 + }, + "InstructionsDocuments": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + }, + "ModifiedAt": { + "type": { + "$ref": "#/9" + }, + "flags": 2 + }, + "Name": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/13" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.B2BI/Capability", + "properties": { + "name": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/9" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/14" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.B2BI/Capability@default", + "scopeType": 0, + "body": { + "$ref": "#/15" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.B2BI/PartnershipProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/9" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/17" + } + }, + { + "$type": "ObjectType", + "name": "AWS.B2BI/PartnershipProperties", + "properties": { + "Capabilities": { + "type": { + "$ref": "#/19" + }, + "flags": 0 + }, + "CreatedAt": { + "type": { + "$ref": "#/9" + }, + "flags": 2 + }, + "Email": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + }, + "ModifiedAt": { + "type": { + "$ref": "#/9" + }, + "flags": 2 + }, + "Name": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + }, + "PartnershipArn": { + "type": { + "$ref": "#/9" + }, + "flags": 2 + }, + "PartnershipId": { + "type": { + "$ref": "#/9" + }, + "flags": 18 + }, + "Phone": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "ProfileId": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/20" + }, + "flags": 0 + }, + "TradingPartnerId": { + "type": { + "$ref": "#/9" + }, + "flags": 2 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.B2BI/Partnership", + "properties": { + "name": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/9" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/21" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.B2BI/Partnership@default", + "scopeType": 0, + "body": { + "$ref": "#/22" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Logging", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.B2BI/ProfileProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/25" + } + }, + { + "$type": "ObjectType", + "name": "AWS.B2BI/ProfileProperties", + "properties": { + "BusinessName": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + }, + "CreatedAt": { + "type": { + "$ref": "#/9" + }, + "flags": 2 + }, + "Email": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "LogGroupName": { + "type": { + "$ref": "#/9" + }, + "flags": 2 + }, + "Logging": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + }, + "ModifiedAt": { + "type": { + "$ref": "#/9" + }, + "flags": 2 + }, + "Name": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + }, + "Phone": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + }, + "ProfileArn": { + "type": { + "$ref": "#/9" + }, + "flags": 2 + }, + "ProfileId": { + "type": { + "$ref": "#/9" + }, + "flags": 18 + }, + "Tags": { + "type": { + "$ref": "#/27" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.B2BI/Profile", + "properties": { + "name": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/9" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/28" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.B2BI/Profile@default", + "scopeType": 0, + "body": { + "$ref": "#/29" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "EdiType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "FileFormat", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TransformerStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "X12Details", + "properties": { + "TransactionSet": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "Version": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "X12TransactionSet", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "X12Version", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.B2BI/TransformerProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/33" + } + }, + { + "$type": "ObjectType", + "name": "AWS.B2BI/TransformerProperties", + "properties": { + "CreatedAt": { + "type": { + "$ref": "#/9" + }, + "flags": 2 + }, + "EdiType": { + "type": { + "$ref": "#/31" + }, + "flags": 1 + }, + "FileFormat": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + }, + "MappingTemplate": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + }, + "ModifiedAt": { + "type": { + "$ref": "#/9" + }, + "flags": 2 + }, + "Name": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + }, + "SampleDocument": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "Status": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/39" + }, + "flags": 0 + }, + "TransformerArn": { + "type": { + "$ref": "#/9" + }, + "flags": 2 + }, + "TransformerId": { + "type": { + "$ref": "#/9" + }, + "flags": 18 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.B2BI/Transformer", + "properties": { + "name": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/9" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/40" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.B2BI/Transformer@default", + "scopeType": 0, + "body": { + "$ref": "#/41" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.b2bi/default/types.md b/artifacts/bicep/aws/aws.b2bi/default/types.md index 32647bd2..dd445cb7 100644 --- a/artifacts/bicep/aws/aws.b2bi/default/types.md +++ b/artifacts/bicep/aws/aws.b2bi/default/types.md @@ -3,30 +3,30 @@ ## Resource AWS.B2BI/Capability@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.B2BI/CapabilityProperties](#awsb2bicapabilityproperties) (Required): properties of the resource +* **properties**: [AWS.B2BI/CapabilityProperties](#awsb2bicapabilityproperties) (Required, Identifier): properties of the resource ## Resource AWS.B2BI/Partnership@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.B2BI/PartnershipProperties](#awsb2bipartnershipproperties) (Required): properties of the resource +* **properties**: [AWS.B2BI/PartnershipProperties](#awsb2bipartnershipproperties) (Required, Identifier): properties of the resource ## Resource AWS.B2BI/Profile@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.B2BI/ProfileProperties](#awsb2biprofileproperties) (Required): properties of the resource +* **properties**: [AWS.B2BI/ProfileProperties](#awsb2biprofileproperties) (Required, Identifier): properties of the resource ## Resource AWS.B2BI/Transformer@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.B2BI/TransformerProperties](#awsb2bitransformerproperties) (Required): properties of the resource +* **properties**: [AWS.B2BI/TransformerProperties](#awsb2bitransformerproperties) (Required, Identifier): properties of the resource ## AWS.B2BI/CapabilityProperties ### Properties @@ -40,19 +40,6 @@ * **Tags**: [Tag](#tag)[] * **Type**: string (Required) -## CapabilityConfiguration -### Properties - -## S3Location -### Properties -* **BucketName**: string -* **Key**: string - -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - ## AWS.B2BI/PartnershipProperties ### Properties * **Capabilities**: string[] @@ -67,11 +54,6 @@ * **Tags**: [Tag](#tag)[] * **TradingPartnerId**: string (ReadOnly) -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - ## AWS.B2BI/ProfileProperties ### Properties * **BusinessName**: string (Required) @@ -86,18 +68,13 @@ * **ProfileId**: string (ReadOnly, Identifier) * **Tags**: [Tag](#tag)[] -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - ## AWS.B2BI/TransformerProperties ### Properties * **CreatedAt**: string (ReadOnly) * **EdiType**: [EdiType](#editype) (Required) * **FileFormat**: string (Required) * **MappingTemplate**: string (Required) -* **ModifiedAt**: string +* **ModifiedAt**: string (ReadOnly) * **Name**: string (Required) * **SampleDocument**: string * **Status**: string (Required) @@ -105,9 +82,32 @@ * **TransformerArn**: string (ReadOnly) * **TransformerId**: string (ReadOnly, Identifier) +## CapabilityConfiguration +### Properties + ## EdiType ### Properties +## S3Location +### Properties +* **BucketName**: string +* **Key**: string + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + ## Tag ### Properties * **Key**: string (Required) diff --git a/artifacts/bicep/aws/aws.backup/default/types.json b/artifacts/bicep/aws/aws.backup/default/types.json index 1b714d01..2b4a6727 100644 --- a/artifacts/bicep/aws/aws.backup/default/types.json +++ b/artifacts/bicep/aws/aws.backup/default/types.json @@ -1 +1,1205 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"AdvancedBackupSettingResourceType","Properties":{"BackupOptions":{"Type":13,"Flags":1},"ResourceType":{"Type":4,"Flags":1}}}},{"2":{"Name":"BackupPlanResourceType","Properties":{"AdvancedBackupSettings":{"Type":14,"Flags":0},"BackupPlanName":{"Type":4,"Flags":1},"BackupPlanRule":{"Type":15,"Flags":1}}}},{"2":{"Name":"BackupRuleResourceType","Properties":{"CompletionWindowMinutes":{"Type":3,"Flags":0},"CopyActions":{"Type":16,"Flags":0},"EnableContinuousBackup":{"Type":2,"Flags":0},"Lifecycle":{"Type":12,"Flags":0},"RecoveryPointTags":{"Type":17,"Flags":0},"RuleName":{"Type":4,"Flags":1},"ScheduleExpression":{"Type":4,"Flags":0},"ScheduleExpressionTimezone":{"Type":4,"Flags":0},"StartWindowMinutes":{"Type":3,"Flags":0},"TargetBackupVault":{"Type":4,"Flags":1}}}},{"2":{"Name":"CopyActionResourceType","Properties":{"DestinationBackupVaultArn":{"Type":4,"Flags":1},"Lifecycle":{"Type":12,"Flags":0}}}},{"2":{"Name":"LifecycleResourceType","Properties":{"DeleteAfterDays":{"Type":3,"Flags":0},"MoveToColdStorageAfterDays":{"Type":3,"Flags":0}}}},{"2":{"Name":"BackupPlan_BackupOptions","Properties":{}}},{"3":{"ItemType":8}},{"3":{"ItemType":10}},{"3":{"ItemType":11}},{"2":{"Name":"BackupPlan_RecoveryPointTags","Properties":{}}},{"2":{"Name":"AWS.Backup/BackupPlanProperties","Properties":{"BackupPlan":{"Type":9,"Flags":1},"BackupPlanArn":{"Type":4,"Flags":2},"BackupPlanId":{"Type":4,"Flags":18},"BackupPlanTags":{"Type":19,"Flags":0},"VersionId":{"Type":4,"Flags":2}}}},{"2":{"Name":"BackupPlan_BackupPlanTags","Properties":{}}},{"2":{"Name":"AWS.Backup/BackupPlan","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":18,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Backup/BackupPlan@default","ScopeType":0,"Body":20}},{"2":{"Name":"BackupVaultNamePattern"}},{"2":{"Name":"LockConfigurationType","Properties":{"ChangeableForDays":{"Type":3,"Flags":4},"MaxRetentionDays":{"Type":3,"Flags":0},"MinRetentionDays":{"Type":3,"Flags":1}}}},{"2":{"Name":"NotificationObjectType","Properties":{"BackupVaultEvents":{"Type":25,"Flags":1},"SNSTopicArn":{"Type":4,"Flags":1}}}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.Backup/BackupVaultProperties","Properties":{"AccessPolicy":{"Type":28,"Flags":0},"BackupVaultArn":{"Type":4,"Flags":2},"BackupVaultName":{"Type":4,"Flags":17},"BackupVaultTags":{"Type":29,"Flags":0},"EncryptionKeyArn":{"Type":4,"Flags":0},"LockConfiguration":{"Type":23,"Flags":0},"Notifications":{"Type":24,"Flags":0}}}},{"2":{"Name":"BackupVault_AccessPolicy","Properties":{}}},{"5":{"Elements":[27,4]}},{"2":{"Name":"BackupVault_BackupVaultTags","Properties":{}}},{"2":{"Name":"AWS.Backup/BackupVault","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":26,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Backup/BackupVault@default","ScopeType":0,"Body":30}},{"2":{"Name":"ControlInputParameter","Properties":{"ParameterName":{"Type":4,"Flags":1},"ParameterValue":{"Type":4,"Flags":1}}}},{"2":{"Name":"FrameworkControl","Properties":{"ControlInputParameters":{"Type":35,"Flags":0,"Description":"A list of ParameterName and ParameterValue pairs."},"ControlName":{"Type":4,"Flags":1,"Description":"The name of a control. This name is between 1 and 256 characters."},"ControlScope":{"Type":39,"Flags":0,"Description":"The scope of a control. The control scope defines what the control will evaluate. Three examples of control scopes are: a specific backup plan, all backup plans with a specific tag, or all backup plans."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":0,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":0,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"3":{"ItemType":32}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":34}},{"2":{"Name":"Framework_ControlScope","Properties":{"ComplianceResourceIds":{"Type":36,"Flags":0,"Description":"The ID of the only AWS resource that you want your control scope to contain."},"ComplianceResourceTypes":{"Type":37,"Flags":0,"Description":"Describes whether the control scope includes one or more types of resources, such as `EFS` or `RDS`."},"Tags":{"Type":38,"Flags":0,"Description":"Describes whether the control scope includes resources with one or more tags. Each tag is a key-value pair."}}}},{"2":{"Name":"AWS.Backup/FrameworkProperties","Properties":{"CreationTime":{"Type":4,"Flags":2,"Description":"The date and time that a framework is created, in ISO 8601 representation. The value of CreationTime is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC."},"DeploymentStatus":{"Type":4,"Flags":2,"Description":"The deployment status of a framework. The statuses are: `CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED`"},"FrameworkArn":{"Type":4,"Flags":18,"Description":"An Amazon Resource Name (ARN) that uniquely identifies Framework as a resource"},"FrameworkControls":{"Type":41,"Flags":1,"Description":"Contains detailed information about all of the controls of a framework. Each framework must contain at least one control."},"FrameworkDescription":{"Type":4,"Flags":0,"Description":"An optional description of the framework with a maximum 1,024 characters."},"FrameworkName":{"Type":4,"Flags":0,"Description":"The unique name of a framework. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_)."},"FrameworkStatus":{"Type":4,"Flags":2,"Description":"A framework consists of one or more controls. Each control governs a resource, such as backup plans, backup selections, backup vaults, or recovery points. You can also turn AWS Config recording on or off for each resource. The statuses are:\n\n`ACTIVE` when recording is turned on for all resources governed by the framework.\n\n`PARTIALLY_ACTIVE` when recording is turned off for at least one resource governed by the framework.\n\n`INACTIVE` when recording is turned off for all resources governed by the framework.\n\n`UNAVAILABLE` when AWS Backup is unable to validate recording status at this time."},"FrameworkTags":{"Type":42,"Flags":0,"Description":"Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair."}}}},{"3":{"ItemType":33}},{"3":{"ItemType":34}},{"2":{"Name":"AWS.Backup/Framework","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":40,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Backup/Framework@default","ScopeType":0,"Body":43}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":0,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":0,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.Backup/ReportPlanProperties","Properties":{"ReportDeliveryChannel":{"Type":48,"Flags":1,"Description":"A structure that contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports."},"ReportPlanArn":{"Type":4,"Flags":18,"Description":"An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type."},"ReportPlanDescription":{"Type":4,"Flags":0,"Description":"An optional description of the report plan with a maximum of 1,024 characters."},"ReportPlanName":{"Type":4,"Flags":0,"Description":"The unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_)."},"ReportPlanTags":{"Type":49,"Flags":0,"Description":"Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair."},"ReportSetting":{"Type":54,"Flags":1,"Description":"Identifies the report template for the report. Reports are built using a report template."}}}},{"3":{"ItemType":4}},{"2":{"Name":"ReportPlan_ReportDeliveryChannel","Properties":{"Formats":{"Type":47,"Flags":0,"Description":"A list of the format of your reports: CSV, JSON, or both. If not specified, the default format is CSV."},"S3BucketName":{"Type":4,"Flags":1,"Description":"The unique name of the S3 bucket that receives your reports."},"S3KeyPrefix":{"Type":4,"Flags":0,"Description":"The prefix for where AWS Backup Audit Manager delivers your reports to Amazon S3. The prefix is this part of the following path: s3://your-bucket-name/prefix/Backup/us-west-2/year/month/day/report-name. If not specified, there is no prefix."}}}},{"3":{"ItemType":45}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"ReportPlan_ReportSetting","Properties":{"Accounts":{"Type":50,"Flags":0,"Description":"The list of AWS accounts that a report covers."},"FrameworkArns":{"Type":51,"Flags":0,"Description":"The Amazon Resource Names (ARNs) of the frameworks a report covers."},"OrganizationUnits":{"Type":52,"Flags":0,"Description":"The list of AWS organization units that a report covers."},"Regions":{"Type":53,"Flags":0,"Description":"The list of AWS regions that a report covers."},"ReportTemplate":{"Type":4,"Flags":1,"Description":"Identifies the report template for the report. Reports are built using a report template. The report templates are: `BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT`"}}}},{"2":{"Name":"AWS.Backup/ReportPlan","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":46,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Backup/ReportPlan@default","ScopeType":0,"Body":55}},{"2":{"Name":"RestoreTestingRecoveryPointSelection","Properties":{"Algorithm":{"Type":4,"Flags":1},"ExcludeVaults":{"Type":61,"Flags":0},"IncludeVaults":{"Type":62,"Flags":1},"RecoveryPointTypes":{"Type":63,"Flags":1},"SelectionWindowDays":{"Type":3,"Flags":0}}}},{"2":{"Name":"RestoreTestingRecoveryPointSelectionAlgorithm"}},{"2":{"Name":"RestoreTestingRecoveryPointType"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.Backup/RestoreTestingPlanProperties","Properties":{"RecoveryPointSelection":{"Type":57,"Flags":1},"RestoreTestingPlanArn":{"Type":4,"Flags":2},"RestoreTestingPlanName":{"Type":4,"Flags":17},"ScheduleExpression":{"Type":4,"Flags":1},"ScheduleExpressionTimezone":{"Type":4,"Flags":0},"StartWindowHours":{"Type":3,"Flags":0},"Tags":{"Type":65,"Flags":0}}}},{"3":{"ItemType":60}},{"2":{"Name":"AWS.Backup/RestoreTestingPlan","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":64,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Backup/RestoreTestingPlan@default","ScopeType":0,"Body":66}},{"2":{"Name":"KeyValue","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"ProtectedResourceConditions","Properties":{"StringEquals":{"Type":71,"Flags":0},"StringNotEquals":{"Type":72,"Flags":0}}}},{"2":{"Name":"SensitiveStringMap","Properties":{}}},{"3":{"ItemType":68}},{"3":{"ItemType":68}},{"2":{"Name":"AWS.Backup/RestoreTestingSelectionProperties","Properties":{"IamRoleArn":{"Type":4,"Flags":1},"ProtectedResourceArns":{"Type":74,"Flags":0},"ProtectedResourceConditions":{"Type":69,"Flags":0},"ProtectedResourceType":{"Type":4,"Flags":1},"RestoreMetadataOverrides":{"Type":70,"Flags":0},"RestoreTestingPlanName":{"Type":4,"Flags":17},"RestoreTestingSelectionName":{"Type":4,"Flags":17},"ValidationWindowHours":{"Type":3,"Flags":0}}}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.Backup/RestoreTestingSelection","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":73,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Backup/RestoreTestingSelection@default","ScopeType":0,"Body":75}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "AdvancedBackupSettingResourceType", + "properties": { + "BackupOptions": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "ResourceType": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "BackupPlanResourceType", + "properties": { + "AdvancedBackupSettings": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "BackupPlanName": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "BackupPlanRule": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "BackupRuleResourceType", + "properties": { + "CompletionWindowMinutes": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "CopyActions": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "EnableContinuousBackup": { + "type": { + "$ref": "#/11" + }, + "flags": 0 + }, + "Lifecycle": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "RecoveryPointTags": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + }, + "RuleName": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "ScheduleExpression": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "ScheduleExpressionTimezone": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "StartWindowMinutes": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "TargetBackupVault": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CopyActionResourceType", + "properties": { + "DestinationBackupVaultArn": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "Lifecycle": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "LifecycleResourceType", + "properties": { + "DeleteAfterDays": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "MoveToColdStorageAfterDays": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "OptInToArchiveForSupportedResources": { + "type": { + "$ref": "#/11" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BackupPlan_BackupOptions", + "properties": {} + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "ObjectType", + "name": "BackupPlan_RecoveryPointTags", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.Backup/BackupPlanProperties" + }, + { + "$type": "ObjectType", + "name": "BackupPlan_BackupPlanTags", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AWS.Backup/BackupPlanProperties", + "properties": { + "BackupPlan": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "BackupPlanArn": { + "type": { + "$ref": "#/6" + }, + "flags": 2 + }, + "BackupPlanId": { + "type": { + "$ref": "#/6" + }, + "flags": 18 + }, + "BackupPlanTags": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + }, + "VersionId": { + "type": { + "$ref": "#/6" + }, + "flags": 2 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Backup/BackupPlan", + "properties": { + "name": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/6" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/15" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Backup/BackupPlan@default", + "scopeType": 0, + "body": { + "$ref": "#/16" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "BackupVaultNamePattern", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LockConfigurationType", + "properties": { + "ChangeableForDays": { + "type": { + "$ref": "#/9" + }, + "flags": 4 + }, + "MaxRetentionDays": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "MinRetentionDays": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "NotificationObjectType", + "properties": { + "BackupVaultEvents": { + "type": { + "$ref": "#/21" + }, + "flags": 1 + }, + "SNSTopicArn": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Backup/BackupVaultProperties" + }, + { + "$type": "ObjectType", + "name": "BackupVault_AccessPolicy", + "properties": {} + }, + { + "$type": "UnionType", + "elements": [ + { + "$ref": "#/23" + }, + { + "$ref": "#/6" + } + ] + }, + { + "$type": "ObjectType", + "name": "BackupVault_BackupVaultTags", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AWS.Backup/BackupVaultProperties", + "properties": { + "AccessPolicy": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "BackupVaultArn": { + "type": { + "$ref": "#/6" + }, + "flags": 2 + }, + "BackupVaultName": { + "type": { + "$ref": "#/6" + }, + "flags": 17 + }, + "BackupVaultTags": { + "type": { + "$ref": "#/25" + }, + "flags": 0 + }, + "EncryptionKeyArn": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "LockConfiguration": { + "type": { + "$ref": "#/19" + }, + "flags": 0 + }, + "Notifications": { + "type": { + "$ref": "#/20" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Backup/BackupVault", + "properties": { + "name": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/6" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/26" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Backup/BackupVault@default", + "scopeType": 0, + "body": { + "$ref": "#/27" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "ControlInputParameter", + "properties": { + "ParameterName": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "ParameterValue": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "FrameworkControl", + "properties": { + "ControlInputParameters": { + "type": { + "$ref": "#/32" + }, + "flags": 0, + "description": "A list of ParameterName and ParameterValue pairs." + }, + "ControlName": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "The name of a control. This name is between 1 and 256 characters." + }, + "ControlScope": { + "type": { + "$ref": "#/36" + }, + "flags": 0, + "description": "The scope of a control. The control scope defines what the control will evaluate. Three examples of control scopes are: a specific backup plan, all backup plans with a specific tag, or all backup plans." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/29" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/31" + } + }, + { + "$type": "ObjectType", + "name": "Framework_ControlScope", + "properties": { + "ComplianceResourceIds": { + "type": { + "$ref": "#/33" + }, + "flags": 0, + "description": "The ID of the only AWS resource that you want your control scope to contain." + }, + "ComplianceResourceTypes": { + "type": { + "$ref": "#/34" + }, + "flags": 0, + "description": "Describes whether the control scope includes one or more types of resources, such as `EFS` or `RDS`." + }, + "Tags": { + "type": { + "$ref": "#/35" + }, + "flags": 0, + "description": "Describes whether the control scope includes resources with one or more tags. Each tag is a key-value pair." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Backup/FrameworkProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/30" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/31" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Backup/FrameworkProperties", + "properties": { + "CreationTime": { + "type": { + "$ref": "#/6" + }, + "flags": 2, + "description": "The date and time that a framework is created, in ISO 8601 representation. The value of CreationTime is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC." + }, + "DeploymentStatus": { + "type": { + "$ref": "#/6" + }, + "flags": 2, + "description": "The deployment status of a framework. The statuses are: `CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED`" + }, + "FrameworkArn": { + "type": { + "$ref": "#/6" + }, + "flags": 18, + "description": "An Amazon Resource Name (ARN) that uniquely identifies Framework as a resource" + }, + "FrameworkControls": { + "type": { + "$ref": "#/38" + }, + "flags": 1, + "description": "Contains detailed information about all of the controls of a framework. Each framework must contain at least one control." + }, + "FrameworkDescription": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "An optional description of the framework with a maximum 1,024 characters." + }, + "FrameworkName": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "The unique name of a framework. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_)." + }, + "FrameworkStatus": { + "type": { + "$ref": "#/6" + }, + "flags": 2, + "description": "A framework consists of one or more controls. Each control governs a resource, such as backup plans, backup selections, backup vaults, or recovery points. You can also turn AWS Config recording on or off for each resource. The statuses are:\n\n`ACTIVE` when recording is turned on for all resources governed by the framework.\n\n`PARTIALLY_ACTIVE` when recording is turned off for at least one resource governed by the framework.\n\n`INACTIVE` when recording is turned off for all resources governed by the framework.\n\n`UNAVAILABLE` when AWS Backup is unable to validate recording status at this time." + }, + "FrameworkTags": { + "type": { + "$ref": "#/39" + }, + "flags": 0, + "description": "Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Backup/Framework", + "properties": { + "name": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/6" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/40" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Backup/Framework@default", + "scopeType": 0, + "body": { + "$ref": "#/41" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Backup/ReportPlanProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ObjectType", + "name": "ReportPlan_ReportDeliveryChannel", + "properties": { + "Formats": { + "type": { + "$ref": "#/45" + }, + "flags": 0, + "description": "A list of the format of your reports: CSV, JSON, or both. If not specified, the default format is CSV." + }, + "S3BucketName": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "The unique name of the S3 bucket that receives your reports." + }, + "S3KeyPrefix": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "The prefix for where AWS Backup Audit Manager delivers your reports to Amazon S3. The prefix is this part of the following path: s3://your-bucket-name/prefix/Backup/us-west-2/year/month/day/report-name. If not specified, there is no prefix." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/43" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ObjectType", + "name": "ReportPlan_ReportSetting", + "properties": { + "Accounts": { + "type": { + "$ref": "#/48" + }, + "flags": 0, + "description": "The list of AWS accounts that a report covers." + }, + "FrameworkArns": { + "type": { + "$ref": "#/49" + }, + "flags": 0, + "description": "The Amazon Resource Names (ARNs) of the frameworks a report covers." + }, + "OrganizationUnits": { + "type": { + "$ref": "#/50" + }, + "flags": 0, + "description": "The list of AWS organization units that a report covers." + }, + "Regions": { + "type": { + "$ref": "#/51" + }, + "flags": 0, + "description": "The list of AWS regions that a report covers." + }, + "ReportTemplate": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "Identifies the report template for the report. Reports are built using a report template. The report templates are: `BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT`" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Backup/ReportPlanProperties", + "properties": { + "ReportDeliveryChannel": { + "type": { + "$ref": "#/46" + }, + "flags": 1, + "description": "A structure that contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports." + }, + "ReportPlanArn": { + "type": { + "$ref": "#/6" + }, + "flags": 18, + "description": "An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type." + }, + "ReportPlanDescription": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "An optional description of the report plan with a maximum of 1,024 characters." + }, + "ReportPlanName": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "The unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_)." + }, + "ReportPlanTags": { + "type": { + "$ref": "#/47" + }, + "flags": 0, + "description": "Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair." + }, + "ReportSetting": { + "type": { + "$ref": "#/52" + }, + "flags": 1, + "description": "Identifies the report template for the report. Reports are built using a report template." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Backup/ReportPlan", + "properties": { + "name": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/6" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/53" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Backup/ReportPlan@default", + "scopeType": 0, + "body": { + "$ref": "#/54" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "RestoreTestingRecoveryPointSelection", + "properties": { + "Algorithm": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "ExcludeVaults": { + "type": { + "$ref": "#/60" + }, + "flags": 0 + }, + "IncludeVaults": { + "type": { + "$ref": "#/61" + }, + "flags": 1 + }, + "RecoveryPointTypes": { + "type": { + "$ref": "#/62" + }, + "flags": 1 + }, + "SelectionWindowDays": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "RestoreTestingRecoveryPointSelectionAlgorithm", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RestoreTestingRecoveryPointType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Backup/RestoreTestingPlanProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/59" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Backup/RestoreTestingPlanProperties", + "properties": { + "RecoveryPointSelection": { + "type": { + "$ref": "#/56" + }, + "flags": 1 + }, + "RestoreTestingPlanArn": { + "type": { + "$ref": "#/6" + }, + "flags": 2 + }, + "RestoreTestingPlanName": { + "type": { + "$ref": "#/6" + }, + "flags": 17 + }, + "ScheduleExpression": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "ScheduleExpressionTimezone": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "StartWindowHours": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/64" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Backup/RestoreTestingPlan", + "properties": { + "name": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/6" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/65" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Backup/RestoreTestingPlan@default", + "scopeType": 0, + "body": { + "$ref": "#/66" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "KeyValue", + "properties": { + "Key": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ProtectedResourceConditions", + "properties": { + "StringEquals": { + "type": { + "$ref": "#/71" + }, + "flags": 0 + }, + "StringNotEquals": { + "type": { + "$ref": "#/72" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SensitiveStringMap", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/68" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/68" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Backup/RestoreTestingSelectionProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Backup/RestoreTestingSelectionProperties", + "properties": { + "IamRoleArn": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "ProtectedResourceArns": { + "type": { + "$ref": "#/74" + }, + "flags": 0 + }, + "ProtectedResourceConditions": { + "type": { + "$ref": "#/69" + }, + "flags": 0 + }, + "ProtectedResourceType": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "RestoreMetadataOverrides": { + "type": { + "$ref": "#/70" + }, + "flags": 0 + }, + "RestoreTestingPlanName": { + "type": { + "$ref": "#/6" + }, + "flags": 17 + }, + "RestoreTestingSelectionName": { + "type": { + "$ref": "#/6" + }, + "flags": 17 + }, + "ValidationWindowHours": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Backup/RestoreTestingSelection", + "properties": { + "name": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/6" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/75" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Backup/RestoreTestingSelection@default", + "scopeType": 0, + "body": { + "$ref": "#/76" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.backup/default/types.md b/artifacts/bicep/aws/aws.backup/default/types.md index c7feda1f..f55909ad 100644 --- a/artifacts/bicep/aws/aws.backup/default/types.md +++ b/artifacts/bicep/aws/aws.backup/default/types.md @@ -3,44 +3,49 @@ ## Resource AWS.Backup/BackupPlan@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Backup/BackupPlanProperties](#awsbackupbackupplanproperties) (Required): properties of the resource +* **properties**: [AWS.Backup/BackupPlanProperties](#awsbackupbackupplanproperties) (Required, Identifier): properties of the resource ## Resource AWS.Backup/BackupVault@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Backup/BackupVaultProperties](#awsbackupbackupvaultproperties) (Required): properties of the resource +* **properties**: [AWS.Backup/BackupVaultProperties](#awsbackupbackupvaultproperties) (Required, Identifier): properties of the resource ## Resource AWS.Backup/Framework@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Backup/FrameworkProperties](#awsbackupframeworkproperties) (Required): properties of the resource +* **properties**: [AWS.Backup/FrameworkProperties](#awsbackupframeworkproperties) (Required, Identifier): properties of the resource ## Resource AWS.Backup/ReportPlan@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Backup/ReportPlanProperties](#awsbackupreportplanproperties) (Required): properties of the resource +* **properties**: [AWS.Backup/ReportPlanProperties](#awsbackupreportplanproperties) (Required, Identifier): properties of the resource ## Resource AWS.Backup/RestoreTestingPlan@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Backup/RestoreTestingPlanProperties](#awsbackuprestoretestingplanproperties) (Required): properties of the resource +* **properties**: [AWS.Backup/RestoreTestingPlanProperties](#awsbackuprestoretestingplanproperties) (Required, Identifier): properties of the resource ## Resource AWS.Backup/RestoreTestingSelection@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Backup/RestoreTestingSelectionProperties](#awsbackuprestoretestingselectionproperties) (Required): properties of the resource +* **properties**: [AWS.Backup/RestoreTestingSelectionProperties](#awsbackuprestoretestingselectionproperties) (Required, Identifier): properties of the resource + +## AdvancedBackupSettingResourceType +### Properties +* **BackupOptions**: [BackupPlan_BackupOptions](#backupplanbackupoptions) (Required) +* **ResourceType**: string (Required) ## AWS.Backup/BackupPlanProperties ### Properties @@ -50,49 +55,6 @@ * **BackupPlanTags**: [BackupPlan_BackupPlanTags](#backupplanbackupplantags) * **VersionId**: string (ReadOnly) -## BackupPlanResourceType -### Properties -* **AdvancedBackupSettings**: [AdvancedBackupSettingResourceType](#advancedbackupsettingresourcetype)[] -* **BackupPlanName**: string (Required) -* **BackupPlanRule**: [BackupRuleResourceType](#backupruleresourcetype)[] (Required) - -## AdvancedBackupSettingResourceType -### Properties -* **BackupOptions**: [BackupPlan_BackupOptions](#backupplanbackupoptions) (Required) -* **ResourceType**: string (Required) - -## BackupPlan_BackupOptions -### Properties - -## BackupRuleResourceType -### Properties -* **CompletionWindowMinutes**: int -* **CopyActions**: [CopyActionResourceType](#copyactionresourcetype)[] -* **EnableContinuousBackup**: bool -* **Lifecycle**: [LifecycleResourceType](#lifecycleresourcetype) -* **RecoveryPointTags**: [BackupPlan_RecoveryPointTags](#backupplanrecoverypointtags) -* **RuleName**: string (Required) -* **ScheduleExpression**: string -* **ScheduleExpressionTimezone**: string -* **StartWindowMinutes**: int -* **TargetBackupVault**: string (Required) - -## CopyActionResourceType -### Properties -* **DestinationBackupVaultArn**: string (Required) -* **Lifecycle**: [LifecycleResourceType](#lifecycleresourcetype) - -## LifecycleResourceType -### Properties -* **DeleteAfterDays**: int -* **MoveToColdStorageAfterDays**: int - -## BackupPlan_RecoveryPointTags -### Properties - -## BackupPlan_BackupPlanTags -### Properties - ## AWS.Backup/BackupVaultProperties ### Properties * **AccessPolicy**: [BackupVault_AccessPolicy](#backupvaultaccesspolicy) | string @@ -103,20 +65,6 @@ * **LockConfiguration**: [LockConfigurationType](#lockconfigurationtype) * **Notifications**: [NotificationObjectType](#notificationobjecttype) -## BackupVault_BackupVaultTags -### Properties - -## LockConfigurationType -### Properties -* **ChangeableForDays**: int (WriteOnly) -* **MaxRetentionDays**: int -* **MinRetentionDays**: int (Required) - -## NotificationObjectType -### Properties -* **BackupVaultEvents**: string[] (Required) -* **SNSTopicArn**: string (Required) - ## AWS.Backup/FrameworkProperties ### Properties * **CreationTime**: string (ReadOnly): The date and time that a framework is created, in ISO 8601 representation. The value of CreationTime is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC. @@ -136,36 +84,115 @@ `UNAVAILABLE` when AWS Backup is unable to validate recording status at this time. * **FrameworkTags**: [Tag](#tag)[]: Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair. -## FrameworkControl +## AWS.Backup/ReportPlanProperties +### Properties +* **ReportDeliveryChannel**: [ReportPlan_ReportDeliveryChannel](#reportplanreportdeliverychannel) (Required): A structure that contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports. +* **ReportPlanArn**: string (ReadOnly, Identifier): An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type. +* **ReportPlanDescription**: string: An optional description of the report plan with a maximum of 1,024 characters. +* **ReportPlanName**: string: The unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_). +* **ReportPlanTags**: [Tag](#tag)[]: Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair. +* **ReportSetting**: [ReportPlan_ReportSetting](#reportplanreportsetting) (Required): Identifies the report template for the report. Reports are built using a report template. + +## AWS.Backup/RestoreTestingPlanProperties +### Properties +* **RecoveryPointSelection**: [RestoreTestingRecoveryPointSelection](#restoretestingrecoverypointselection) (Required) +* **RestoreTestingPlanArn**: string (ReadOnly) +* **RestoreTestingPlanName**: string (Required, Identifier) +* **ScheduleExpression**: string (Required) +* **ScheduleExpressionTimezone**: string +* **StartWindowHours**: int +* **Tags**: [Tag](#tag)[] + +## AWS.Backup/RestoreTestingSelectionProperties +### Properties +* **IamRoleArn**: string (Required) +* **ProtectedResourceArns**: string[] +* **ProtectedResourceConditions**: [ProtectedResourceConditions](#protectedresourceconditions) +* **ProtectedResourceType**: string (Required) +* **RestoreMetadataOverrides**: [SensitiveStringMap](#sensitivestringmap) +* **RestoreTestingPlanName**: string (Required, Identifier) +* **RestoreTestingSelectionName**: string (Required, Identifier) +* **ValidationWindowHours**: int + +## BackupPlan_BackupOptions +### Properties + +## BackupPlan_BackupPlanTags +### Properties + +## BackupPlan_RecoveryPointTags +### Properties + +## BackupPlanResourceType +### Properties +* **AdvancedBackupSettings**: [AdvancedBackupSettingResourceType](#advancedbackupsettingresourcetype)[] +* **BackupPlanName**: string (Required) +* **BackupPlanRule**: [BackupRuleResourceType](#backupruleresourcetype)[] (Required) + +## BackupRuleResourceType +### Properties +* **CompletionWindowMinutes**: int +* **CopyActions**: [CopyActionResourceType](#copyactionresourcetype)[] +* **EnableContinuousBackup**: bool +* **Lifecycle**: [LifecycleResourceType](#lifecycleresourcetype) +* **RecoveryPointTags**: [BackupPlan_RecoveryPointTags](#backupplanrecoverypointtags) +* **RuleName**: string (Required) +* **ScheduleExpression**: string +* **ScheduleExpressionTimezone**: string +* **StartWindowMinutes**: int +* **TargetBackupVault**: string (Required) + +## BackupVault_BackupVaultTags ### Properties -* **ControlInputParameters**: [ControlInputParameter](#controlinputparameter)[]: A list of ParameterName and ParameterValue pairs. -* **ControlName**: string (Required): The name of a control. This name is between 1 and 256 characters. -* **ControlScope**: [Framework_ControlScope](#frameworkcontrolscope): The scope of a control. The control scope defines what the control will evaluate. Three examples of control scopes are: a specific backup plan, all backup plans with a specific tag, or all backup plans. ## ControlInputParameter ### Properties * **ParameterName**: string (Required) * **ParameterValue**: string (Required) +## CopyActionResourceType +### Properties +* **DestinationBackupVaultArn**: string (Required) +* **Lifecycle**: [LifecycleResourceType](#lifecycleresourcetype) + ## Framework_ControlScope ### Properties * **ComplianceResourceIds**: string[]: The ID of the only AWS resource that you want your control scope to contain. * **ComplianceResourceTypes**: string[]: Describes whether the control scope includes one or more types of resources, such as `EFS` or `RDS`. * **Tags**: [Tag](#tag)[]: Describes whether the control scope includes resources with one or more tags. Each tag is a key-value pair. -## Tag +## FrameworkControl ### Properties -* **Key**: string: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **ControlInputParameters**: [ControlInputParameter](#controlinputparameter)[]: A list of ParameterName and ParameterValue pairs. +* **ControlName**: string (Required): The name of a control. This name is between 1 and 256 characters. +* **ControlScope**: [Framework_ControlScope](#frameworkcontrolscope): The scope of a control. The control scope defines what the control will evaluate. Three examples of control scopes are: a specific backup plan, all backup plans with a specific tag, or all backup plans. -## AWS.Backup/ReportPlanProperties +## KeyValue ### Properties -* **ReportDeliveryChannel**: [ReportPlan_ReportDeliveryChannel](#reportplanreportdeliverychannel) (Required): A structure that contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports. -* **ReportPlanArn**: string (ReadOnly, Identifier): An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type. -* **ReportPlanDescription**: string: An optional description of the report plan with a maximum of 1,024 characters. -* **ReportPlanName**: string: The unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_). -* **ReportPlanTags**: [Tag](#tag)[]: Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair. -* **ReportSetting**: [ReportPlan_ReportSetting](#reportplanreportsetting) (Required): Identifies the report template for the report. Reports are built using a report template. +* **Key**: string (Required) +* **Value**: string (Required) + +## LifecycleResourceType +### Properties +* **DeleteAfterDays**: int +* **MoveToColdStorageAfterDays**: int +* **OptInToArchiveForSupportedResources**: bool + +## LockConfigurationType +### Properties +* **ChangeableForDays**: int (WriteOnly) +* **MaxRetentionDays**: int +* **MinRetentionDays**: int (Required) + +## NotificationObjectType +### Properties +* **BackupVaultEvents**: string[] (Required) +* **SNSTopicArn**: string (Required) + +## ProtectedResourceConditions +### Properties +* **StringEquals**: [KeyValue](#keyvalue)[] +* **StringNotEquals**: [KeyValue](#keyvalue)[] ## ReportPlan_ReportDeliveryChannel ### Properties @@ -173,11 +200,6 @@ * **S3BucketName**: string (Required): The unique name of the S3 bucket that receives your reports. * **S3KeyPrefix**: string: The prefix for where AWS Backup Audit Manager delivers your reports to Amazon S3. The prefix is this part of the following path: s3://your-bucket-name/prefix/Backup/us-west-2/year/month/day/report-name. If not specified, there is no prefix. -## Tag -### Properties -* **Key**: string: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## ReportPlan_ReportSetting ### Properties * **Accounts**: string[]: The list of AWS accounts that a report covers. @@ -186,16 +208,6 @@ * **Regions**: string[]: The list of AWS regions that a report covers. * **ReportTemplate**: string (Required): Identifies the report template for the report. Reports are built using a report template. The report templates are: `BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT` -## AWS.Backup/RestoreTestingPlanProperties -### Properties -* **RecoveryPointSelection**: [RestoreTestingRecoveryPointSelection](#restoretestingrecoverypointselection) (Required) -* **RestoreTestingPlanArn**: string (ReadOnly) -* **RestoreTestingPlanName**: string (Required, Identifier) -* **ScheduleExpression**: string (Required) -* **ScheduleExpressionTimezone**: string -* **StartWindowHours**: int -* **Tags**: [Tag](#tag)[] - ## RestoreTestingRecoveryPointSelection ### Properties * **Algorithm**: string (Required) @@ -204,32 +216,21 @@ * **RecoveryPointTypes**: string[] (Required) * **SelectionWindowDays**: int -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - -## AWS.Backup/RestoreTestingSelectionProperties +## SensitiveStringMap ### Properties -* **IamRoleArn**: string (Required) -* **ProtectedResourceArns**: string[] -* **ProtectedResourceConditions**: [ProtectedResourceConditions](#protectedresourceconditions) -* **ProtectedResourceType**: string (Required) -* **RestoreMetadataOverrides**: [SensitiveStringMap](#sensitivestringmap) -* **RestoreTestingPlanName**: string (Required, Identifier) -* **RestoreTestingSelectionName**: string (Required, Identifier) -* **ValidationWindowHours**: int -## ProtectedResourceConditions +## Tag ### Properties -* **StringEquals**: [KeyValue](#keyvalue)[] -* **StringNotEquals**: [KeyValue](#keyvalue)[] +* **Key**: string: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -## KeyValue +## Tag ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **Key**: string: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -## SensitiveStringMap +## Tag ### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. diff --git a/artifacts/bicep/aws/aws.backupgateway/default/types.json b/artifacts/bicep/aws/aws.backupgateway/default/types.json index 61cf7935..e22af965 100644 --- a/artifacts/bicep/aws/aws.backupgateway/default/types.json +++ b/artifacts/bicep/aws/aws.backupgateway/default/types.json @@ -1 +1,133 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"HypervisorState"}},{"2":{"Name":"SyncMetadataStatus"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.BackupGateway/HypervisorProperties","Properties":{"Host":{"Type":4,"Flags":0},"HypervisorArn":{"Type":4,"Flags":18},"KmsKeyArn":{"Type":4,"Flags":4},"LogGroupArn":{"Type":4,"Flags":4},"Name":{"Type":4,"Flags":4},"Password":{"Type":4,"Flags":4},"Tags":{"Type":12,"Flags":4},"Username":{"Type":4,"Flags":4}}}},{"3":{"ItemType":10}},{"2":{"Name":"AWS.BackupGateway/Hypervisor","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":11,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.BackupGateway/Hypervisor@default","ScopeType":0,"Body":13}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "HypervisorState", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SyncMetadataStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.BackupGateway/HypervisorProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ObjectType", + "name": "AWS.BackupGateway/HypervisorProperties", + "properties": { + "Host": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "HypervisorArn": { + "type": { + "$ref": "#/3" + }, + "flags": 18 + }, + "KmsKeyArn": { + "type": { + "$ref": "#/3" + }, + "flags": 4 + }, + "LogGroupArn": { + "type": { + "$ref": "#/3" + }, + "flags": 4 + }, + "Name": { + "type": { + "$ref": "#/3" + }, + "flags": 4 + }, + "Password": { + "type": { + "$ref": "#/3" + }, + "flags": 4 + }, + "Tags": { + "type": { + "$ref": "#/5" + }, + "flags": 4 + }, + "Username": { + "type": { + "$ref": "#/3" + }, + "flags": 4 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.BackupGateway/Hypervisor", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/6" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.BackupGateway/Hypervisor@default", + "scopeType": 0, + "body": { + "$ref": "#/7" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.backupgateway/default/types.md b/artifacts/bicep/aws/aws.backupgateway/default/types.md index db3fe76c..ba9dd566 100644 --- a/artifacts/bicep/aws/aws.backupgateway/default/types.md +++ b/artifacts/bicep/aws/aws.backupgateway/default/types.md @@ -3,9 +3,9 @@ ## Resource AWS.BackupGateway/Hypervisor@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.BackupGateway/HypervisorProperties](#awsbackupgatewayhypervisorproperties): properties of the resource +* **properties**: [AWS.BackupGateway/HypervisorProperties](#awsbackupgatewayhypervisorproperties) (Identifier): properties of the resource ## AWS.BackupGateway/HypervisorProperties ### Properties diff --git a/artifacts/bicep/aws/aws.batch/default/types.json b/artifacts/bicep/aws/aws.batch/default/types.json index cfced0ad..1c7ba310 100644 --- a/artifacts/bicep/aws/aws.batch/default/types.json +++ b/artifacts/bicep/aws/aws.batch/default/types.json @@ -1 +1,653 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"ComputeResources","Properties":{"AllocationStrategy":{"Type":4,"Flags":0},"BidPercentage":{"Type":3,"Flags":0},"DesiredvCpus":{"Type":3,"Flags":0},"Ec2Configuration":{"Type":13,"Flags":0},"Ec2KeyPair":{"Type":4,"Flags":0},"ImageId":{"Type":4,"Flags":0},"InstanceRole":{"Type":4,"Flags":0},"InstanceTypes":{"Type":14,"Flags":0},"LaunchTemplate":{"Type":11,"Flags":0},"MaxvCpus":{"Type":3,"Flags":1},"MinvCpus":{"Type":3,"Flags":0},"PlacementGroup":{"Type":4,"Flags":0},"SecurityGroupIds":{"Type":15,"Flags":0},"SpotIamFleetRole":{"Type":4,"Flags":0},"Subnets":{"Type":16,"Flags":1},"Tags":{"Type":17,"Flags":0,"Description":"A key-value pair to associate with a resource."},"Type":{"Type":4,"Flags":1},"UpdateToLatestImageVersion":{"Type":2,"Flags":4}}}},{"2":{"Name":"Ec2ConfigurationObject","Properties":{"ImageIdOverride":{"Type":4,"Flags":0},"ImageKubernetesVersion":{"Type":4,"Flags":0},"ImageType":{"Type":4,"Flags":1}}}},{"2":{"Name":"EksConfiguration","Properties":{"EksClusterArn":{"Type":4,"Flags":1},"KubernetesNamespace":{"Type":4,"Flags":1}}}},{"2":{"Name":"LaunchTemplateSpecification","Properties":{"LaunchTemplateId":{"Type":4,"Flags":0},"LaunchTemplateName":{"Type":4,"Flags":0},"Version":{"Type":4,"Flags":0}}}},{"2":{"Name":"UpdatePolicy","Properties":{"JobExecutionTimeoutMinutes":{"Type":3,"Flags":0},"TerminateJobsOnUpdate":{"Type":2,"Flags":0}}}},{"3":{"ItemType":9}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"ComputeEnvironment_Tags","Properties":{}}},{"2":{"Name":"AWS.Batch/ComputeEnvironmentProperties","Properties":{"ComputeEnvironmentArn":{"Type":4,"Flags":18},"ComputeEnvironmentName":{"Type":4,"Flags":0},"ComputeResources":{"Type":8,"Flags":0},"EksConfiguration":{"Type":10,"Flags":0},"ReplaceComputeEnvironment":{"Type":2,"Flags":4},"ServiceRole":{"Type":4,"Flags":0},"State":{"Type":4,"Flags":0},"Tags":{"Type":19,"Flags":0,"Description":"A key-value pair to associate with a resource."},"Type":{"Type":4,"Flags":1},"UnmanagedvCpus":{"Type":3,"Flags":0},"UpdatePolicy":{"Type":12,"Flags":4}}}},{"2":{"Name":"ComputeEnvironment_Tags","Properties":{}}},{"2":{"Name":"AWS.Batch/ComputeEnvironment","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":18,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Batch/ComputeEnvironment@default","ScopeType":0,"Body":20}},{"2":{"Name":"ContainerProperties","Properties":{"Command":{"Type":51,"Flags":0},"Environment":{"Type":52,"Flags":0},"EphemeralStorage":{"Type":53,"Flags":0},"ExecutionRoleArn":{"Type":4,"Flags":0},"FargatePlatformConfiguration":{"Type":54,"Flags":0},"Image":{"Type":4,"Flags":1},"InstanceType":{"Type":4,"Flags":4},"JobRoleArn":{"Type":4,"Flags":0},"LinuxParameters":{"Type":57,"Flags":0},"LogConfiguration":{"Type":60,"Flags":0},"Memory":{"Type":3,"Flags":0},"MountPoints":{"Type":61,"Flags":0},"NetworkConfiguration":{"Type":62,"Flags":0},"Privileged":{"Type":2,"Flags":0},"ReadonlyRootFilesystem":{"Type":2,"Flags":0},"ResourceRequirements":{"Type":63,"Flags":0},"RuntimePlatform":{"Type":64,"Flags":0},"Secrets":{"Type":65,"Flags":0},"Ulimits":{"Type":66,"Flags":0},"User":{"Type":4,"Flags":0},"Vcpus":{"Type":3,"Flags":0},"Volumes":{"Type":67,"Flags":0}}}},{"2":{"Name":"Device","Properties":{"ContainerPath":{"Type":4,"Flags":0},"HostPath":{"Type":4,"Flags":0},"Permissions":{"Type":68,"Flags":0}}}},{"2":{"Name":"EFSAuthorizationConfig","Properties":{"AccessPointId":{"Type":4,"Flags":0},"Iam":{"Type":4,"Flags":0}}}},{"2":{"Name":"EFSVolumeConfiguration","Properties":{"AuthorizationConfig":{"Type":24,"Flags":0},"FileSystemId":{"Type":4,"Flags":1},"RootDirectory":{"Type":4,"Flags":0},"TransitEncryption":{"Type":4,"Flags":0},"TransitEncryptionPort":{"Type":3,"Flags":0}}}},{"2":{"Name":"EksContainer","Properties":{"Args":{"Type":69,"Flags":0},"Command":{"Type":70,"Flags":0},"Env":{"Type":71,"Flags":0},"Image":{"Type":4,"Flags":1},"ImagePullPolicy":{"Type":4,"Flags":0},"Name":{"Type":4,"Flags":0},"Resources":{"Type":28,"Flags":0},"SecurityContext":{"Type":29,"Flags":0},"VolumeMounts":{"Type":72,"Flags":0}}}},{"2":{"Name":"EksContainerEnvironmentVariable","Properties":{"Name":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"EksContainerResourceRequirements","Properties":{"Limits":{"Type":73,"Flags":0},"Requests":{"Type":74,"Flags":0}}}},{"2":{"Name":"EksContainerSecurityContext","Properties":{"Privileged":{"Type":2,"Flags":0},"ReadOnlyRootFilesystem":{"Type":2,"Flags":0},"RunAsGroup":{"Type":3,"Flags":0},"RunAsNonRoot":{"Type":2,"Flags":0},"RunAsUser":{"Type":3,"Flags":0}}}},{"2":{"Name":"EksContainerVolumeMount","Properties":{"MountPath":{"Type":4,"Flags":0},"Name":{"Type":4,"Flags":0},"ReadOnly":{"Type":2,"Flags":0}}}},{"2":{"Name":"EksEmptyDir","Properties":{"Medium":{"Type":4,"Flags":0},"SizeLimit":{"Type":4,"Flags":0}}}},{"2":{"Name":"EksHostPath","Properties":{"Path":{"Type":4,"Flags":0}}}},{"2":{"Name":"EksMetadata","Properties":{"Labels":{"Type":75,"Flags":0}}}},{"2":{"Name":"EksPodProperties","Properties":{"Containers":{"Type":76,"Flags":0},"DnsPolicy":{"Type":4,"Flags":0},"HostNetwork":{"Type":2,"Flags":0},"Metadata":{"Type":33,"Flags":0},"ServiceAccountName":{"Type":4,"Flags":0},"Volumes":{"Type":77,"Flags":0}}}},{"2":{"Name":"EksProperties","Properties":{"PodProperties":{"Type":34,"Flags":0}}}},{"2":{"Name":"EksSecret","Properties":{"Optional":{"Type":2,"Flags":0},"SecretName":{"Type":4,"Flags":1}}}},{"2":{"Name":"EksVolume","Properties":{"EmptyDir":{"Type":31,"Flags":0},"HostPath":{"Type":32,"Flags":0},"Name":{"Type":4,"Flags":1},"Secret":{"Type":36,"Flags":0}}}},{"2":{"Name":"Environment","Properties":{"Name":{"Type":4,"Flags":0},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"EvaluateOnExit","Properties":{"Action":{"Type":4,"Flags":1},"OnExitCode":{"Type":4,"Flags":0},"OnReason":{"Type":4,"Flags":0},"OnStatusReason":{"Type":4,"Flags":0}}}},{"2":{"Name":"Host","Properties":{"SourcePath":{"Type":4,"Flags":0}}}},{"2":{"Name":"JobTimeout","Properties":{"AttemptDurationSeconds":{"Type":3,"Flags":0}}}},{"2":{"Name":"MountPoint","Properties":{"ContainerPath":{"Type":4,"Flags":0},"ReadOnly":{"Type":2,"Flags":0},"SourceVolume":{"Type":4,"Flags":0}}}},{"2":{"Name":"NodeProperties","Properties":{"MainNode":{"Type":3,"Flags":1},"NodeRangeProperties":{"Type":78,"Flags":5},"NumNodes":{"Type":3,"Flags":1}}}},{"2":{"Name":"NodeRangeProperty","Properties":{"Container":{"Type":22,"Flags":0},"TargetNodes":{"Type":4,"Flags":1}}}},{"2":{"Name":"ResourceRequirement","Properties":{"Type":{"Type":4,"Flags":0},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"RetryStrategy","Properties":{"Attempts":{"Type":3,"Flags":0},"EvaluateOnExit":{"Type":79,"Flags":0}}}},{"2":{"Name":"Secret","Properties":{"Name":{"Type":4,"Flags":1},"ValueFrom":{"Type":4,"Flags":1}}}},{"2":{"Name":"Tmpfs","Properties":{"ContainerPath":{"Type":4,"Flags":1},"MountOptions":{"Type":80,"Flags":0},"Size":{"Type":3,"Flags":1}}}},{"2":{"Name":"Ulimit","Properties":{"HardLimit":{"Type":3,"Flags":1},"Name":{"Type":4,"Flags":1},"SoftLimit":{"Type":3,"Flags":1}}}},{"2":{"Name":"Volume","Properties":{"EfsVolumeConfiguration":{"Type":25,"Flags":0},"Host":{"Type":40,"Flags":0},"Name":{"Type":4,"Flags":0}}}},{"3":{"ItemType":4}},{"3":{"ItemType":38}},{"2":{"Name":"JobDefinition_EphemeralStorage","Properties":{"SizeInGiB":{"Type":3,"Flags":1}}}},{"2":{"Name":"JobDefinition_FargatePlatformConfiguration","Properties":{"PlatformVersion":{"Type":4,"Flags":0}}}},{"3":{"ItemType":23}},{"3":{"ItemType":48}},{"2":{"Name":"JobDefinition_LinuxParameters","Properties":{"Devices":{"Type":55,"Flags":0},"InitProcessEnabled":{"Type":2,"Flags":0},"MaxSwap":{"Type":3,"Flags":0},"SharedMemorySize":{"Type":3,"Flags":0},"Swappiness":{"Type":3,"Flags":0},"Tmpfs":{"Type":56,"Flags":0}}}},{"2":{"Name":"JobDefinition_LogConfiguration_Options","Properties":{}}},{"3":{"ItemType":47}},{"2":{"Name":"JobDefinition_LogConfiguration","Properties":{"LogDriver":{"Type":4,"Flags":1},"Options":{"Type":58,"Flags":0},"SecretOptions":{"Type":59,"Flags":0}}}},{"3":{"ItemType":42}},{"2":{"Name":"JobDefinition_NetworkConfiguration","Properties":{"AssignPublicIp":{"Type":4,"Flags":0}}}},{"3":{"ItemType":45}},{"2":{"Name":"JobDefinition_RuntimePlatform","Properties":{"CpuArchitecture":{"Type":4,"Flags":0},"OperatingSystemFamily":{"Type":4,"Flags":0}}}},{"3":{"ItemType":47}},{"3":{"ItemType":49}},{"3":{"ItemType":50}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":27}},{"3":{"ItemType":30}},{"2":{"Name":"JobDefinition_Limits","Properties":{}}},{"2":{"Name":"JobDefinition_Requests","Properties":{}}},{"2":{"Name":"JobDefinition_Labels","Properties":{}}},{"3":{"ItemType":26}},{"3":{"ItemType":37}},{"3":{"ItemType":44}},{"3":{"ItemType":39}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.Batch/JobDefinitionProperties","Properties":{"ContainerOrchestrationType":{"Type":4,"Flags":2},"ContainerProperties":{"Type":22,"Flags":0},"EksProperties":{"Type":35,"Flags":0},"JobDefinitionArn":{"Type":4,"Flags":18},"JobDefinitionName":{"Type":4,"Flags":0},"NodeProperties":{"Type":43,"Flags":0},"Parameters":{"Type":82,"Flags":0},"PlatformCapabilities":{"Type":83,"Flags":0},"PropagateTags":{"Type":2,"Flags":0},"RetryStrategy":{"Type":46,"Flags":0},"Revision":{"Type":3,"Flags":2},"SchedulingPriority":{"Type":3,"Flags":0},"Status":{"Type":4,"Flags":2},"Tags":{"Type":84,"Flags":0,"Description":"A key-value pair to associate with a resource."},"Timeout":{"Type":41,"Flags":0},"Type":{"Type":4,"Flags":1}}}},{"2":{"Name":"JobDefinition_Parameters","Properties":{}}},{"3":{"ItemType":4}},{"2":{"Name":"JobDefinition_Tags","Properties":{}}},{"2":{"Name":"AWS.Batch/JobDefinition","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":81,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Batch/JobDefinition@default","ScopeType":0,"Body":85}},{"2":{"Name":"ComputeEnvironmentOrder","Properties":{"ComputeEnvironment":{"Type":4,"Flags":1},"Order":{"Type":3,"Flags":1}}}},{"2":{"Name":"ResourceArn"}},{"2":{"Name":"AWS.Batch/JobQueueProperties","Properties":{"ComputeEnvironmentOrder":{"Type":90,"Flags":1},"JobQueueArn":{"Type":4,"Flags":18},"JobQueueName":{"Type":4,"Flags":0},"Priority":{"Type":3,"Flags":1},"SchedulingPolicyArn":{"Type":4,"Flags":0},"State":{"Type":4,"Flags":0},"Tags":{"Type":91,"Flags":0,"Description":"A key-value pair to associate with a resource."}}}},{"3":{"ItemType":87}},{"2":{"Name":"JobQueue_Tags","Properties":{}}},{"2":{"Name":"AWS.Batch/JobQueue","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":89,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Batch/JobQueue@default","ScopeType":0,"Body":92}},{"2":{"Name":"FairsharePolicy","Properties":{"ComputeReservation":{"Type":3,"Flags":0},"ShareDecaySeconds":{"Type":3,"Flags":0},"ShareDistribution":{"Type":97,"Flags":0,"Description":"List of Share Attributes"}}}},{"2":{"Name":"ResourceArn"}},{"2":{"Name":"ShareAttributes","Properties":{"ShareIdentifier":{"Type":4,"Flags":0},"WeightFactor":{"Type":3,"Flags":0}}}},{"3":{"ItemType":96}},{"2":{"Name":"AWS.Batch/SchedulingPolicyProperties","Properties":{"Arn":{"Type":4,"Flags":18},"FairsharePolicy":{"Type":94,"Flags":0},"Name":{"Type":4,"Flags":0,"Description":"Name of Scheduling Policy."},"Tags":{"Type":99,"Flags":0,"Description":"A key-value pair to associate with a resource."}}}},{"2":{"Name":"SchedulingPolicy_Tags","Properties":{}}},{"2":{"Name":"AWS.Batch/SchedulingPolicy","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":98,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Batch/SchedulingPolicy@default","ScopeType":0,"Body":100}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "ComputeResources", + "properties": { + "AllocationStrategy": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "BidPercentage": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "DesiredvCpus": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "Ec2Configuration": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "Ec2KeyPair": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "ImageId": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "InstanceRole": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "InstanceTypes": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "LaunchTemplate": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "MaxvCpus": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "MinvCpus": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "PlacementGroup": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "SecurityGroupIds": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "SpotIamFleetRole": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Subnets": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "A key-value pair to associate with a resource." + }, + "Type": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "UpdateToLatestImageVersion": { + "type": { + "$ref": "#/12" + }, + "flags": 4 + } + } + }, + { + "$type": "ObjectType", + "name": "Ec2ConfigurationObject", + "properties": { + "ImageIdOverride": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "ImageKubernetesVersion": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "ImageType": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "EksConfiguration", + "properties": { + "EksClusterArn": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "KubernetesNamespace": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "LaunchTemplateSpecification", + "properties": { + "LaunchTemplateId": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "LaunchTemplateName": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Version": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "UpdatePolicy", + "properties": { + "JobExecutionTimeoutMinutes": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "TerminateJobsOnUpdate": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ObjectType", + "name": "ComputeEnvironment_Tags", + "properties": {} + }, + { + "$type": "BooleanType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.Batch/ComputeEnvironmentProperties" + }, + { + "$type": "ObjectType", + "name": "ComputeEnvironment_Tags", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AWS.Batch/ComputeEnvironmentProperties", + "properties": { + "ComputeEnvironmentArn": { + "type": { + "$ref": "#/5" + }, + "flags": 18 + }, + "ComputeEnvironmentName": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "ComputeResources": { + "type": { + "$ref": "#/0" + }, + "flags": 0 + }, + "EksConfiguration": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "ReplaceComputeEnvironment": { + "type": { + "$ref": "#/12" + }, + "flags": 4 + }, + "ServiceRole": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "State": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "A key-value pair to associate with a resource." + }, + "Type": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "UnmanagedvCpus": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "UpdatePolicy": { + "type": { + "$ref": "#/4" + }, + "flags": 4 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Batch/ComputeEnvironment", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/15" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Batch/ComputeEnvironment@default", + "scopeType": 0, + "body": { + "$ref": "#/16" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "ComputeEnvironmentOrder", + "properties": { + "ComputeEnvironment": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Order": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "JobStateTimeLimitAction", + "properties": { + "Action": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "MaxTimeSeconds": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "Reason": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "State": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ResourceArn", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.Batch/JobQueueProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/18" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/19" + } + }, + { + "$type": "ObjectType", + "name": "JobQueue_Tags", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AWS.Batch/JobQueueProperties", + "properties": { + "ComputeEnvironmentOrder": { + "type": { + "$ref": "#/22" + }, + "flags": 1 + }, + "JobQueueArn": { + "type": { + "$ref": "#/5" + }, + "flags": 18 + }, + "JobQueueName": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "JobStateTimeLimitActions": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "Priority": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "SchedulingPolicyArn": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "State": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/24" + }, + "flags": 0, + "description": "A key-value pair to associate with a resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Batch/JobQueue", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/25" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Batch/JobQueue@default", + "scopeType": 0, + "body": { + "$ref": "#/26" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "FairsharePolicy", + "properties": { + "ComputeReservation": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "ShareDecaySeconds": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "ShareDistribution": { + "type": { + "$ref": "#/31" + }, + "flags": 0, + "description": "List of Share Attributes" + } + } + }, + { + "$type": "ObjectType", + "name": "ResourceArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ShareAttributes", + "properties": { + "ShareIdentifier": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "WeightFactor": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/30" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Batch/SchedulingPolicyProperties" + }, + { + "$type": "ObjectType", + "name": "SchedulingPolicy_Tags", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AWS.Batch/SchedulingPolicyProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/5" + }, + "flags": 18 + }, + "FairsharePolicy": { + "type": { + "$ref": "#/28" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "Name of Scheduling Policy." + }, + "Tags": { + "type": { + "$ref": "#/33" + }, + "flags": 0, + "description": "A key-value pair to associate with a resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Batch/SchedulingPolicy", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/34" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Batch/SchedulingPolicy@default", + "scopeType": 0, + "body": { + "$ref": "#/35" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.batch/default/types.md b/artifacts/bicep/aws/aws.batch/default/types.md index 19d20d0e..5740775f 100644 --- a/artifacts/bicep/aws/aws.batch/default/types.md +++ b/artifacts/bicep/aws/aws.batch/default/types.md @@ -3,30 +3,23 @@ ## Resource AWS.Batch/ComputeEnvironment@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Batch/ComputeEnvironmentProperties](#awsbatchcomputeenvironmentproperties) (Required): properties of the resource - -## Resource AWS.Batch/JobDefinition@default -* **Valid Scope(s)**: Unknown -### Properties -* **alias**: string (Required): the resource alias -* **name**: string: the resource name -* **properties**: [AWS.Batch/JobDefinitionProperties](#awsbatchjobdefinitionproperties) (Required): properties of the resource +* **properties**: [AWS.Batch/ComputeEnvironmentProperties](#awsbatchcomputeenvironmentproperties) (Required, Identifier): properties of the resource ## Resource AWS.Batch/JobQueue@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Batch/JobQueueProperties](#awsbatchjobqueueproperties) (Required): properties of the resource +* **properties**: [AWS.Batch/JobQueueProperties](#awsbatchjobqueueproperties) (Required, Identifier): properties of the resource ## Resource AWS.Batch/SchedulingPolicy@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Batch/SchedulingPolicyProperties](#awsbatchschedulingpolicyproperties): properties of the resource +* **properties**: [AWS.Batch/SchedulingPolicyProperties](#awsbatchschedulingpolicyproperties) (Identifier): properties of the resource ## AWS.Batch/ComputeEnvironmentProperties ### Properties @@ -42,6 +35,35 @@ * **UnmanagedvCpus**: int * **UpdatePolicy**: [UpdatePolicy](#updatepolicy) (WriteOnly) +## AWS.Batch/JobQueueProperties +### Properties +* **ComputeEnvironmentOrder**: [ComputeEnvironmentOrder](#computeenvironmentorder)[] (Required) +* **JobQueueArn**: string (ReadOnly, Identifier) +* **JobQueueName**: string +* **JobStateTimeLimitActions**: [JobStateTimeLimitAction](#jobstatetimelimitaction)[] +* **Priority**: int (Required) +* **SchedulingPolicyArn**: string +* **State**: string +* **Tags**: [JobQueue_Tags](#jobqueuetags): A key-value pair to associate with a resource. + +## AWS.Batch/SchedulingPolicyProperties +### Properties +* **Arn**: string (ReadOnly, Identifier) +* **FairsharePolicy**: [FairsharePolicy](#fairsharepolicy) +* **Name**: string: Name of Scheduling Policy. +* **Tags**: [SchedulingPolicy_Tags](#schedulingpolicytags): A key-value pair to associate with a resource. + +## ComputeEnvironment_Tags +### Properties + +## ComputeEnvironment_Tags +### Properties + +## ComputeEnvironmentOrder +### Properties +* **ComputeEnvironment**: string (Required) +* **Order**: int (Required) + ## ComputeResources ### Properties * **AllocationStrategy**: string @@ -69,321 +91,43 @@ * **ImageKubernetesVersion**: string * **ImageType**: string (Required) -## LaunchTemplateSpecification -### Properties -* **LaunchTemplateId**: string -* **LaunchTemplateName**: string -* **Version**: string - -## ComputeEnvironment_Tags -### Properties - ## EksConfiguration ### Properties * **EksClusterArn**: string (Required) * **KubernetesNamespace**: string (Required) -## ComputeEnvironment_Tags -### Properties - -## UpdatePolicy -### Properties -* **JobExecutionTimeoutMinutes**: int -* **TerminateJobsOnUpdate**: bool - -## AWS.Batch/JobDefinitionProperties -### Properties -* **ContainerOrchestrationType**: string (ReadOnly) -* **ContainerProperties**: [ContainerProperties](#containerproperties) -* **EksProperties**: [EksProperties](#eksproperties) -* **JobDefinitionArn**: string (ReadOnly, Identifier) -* **JobDefinitionName**: string -* **NodeProperties**: [NodeProperties](#nodeproperties) -* **Parameters**: [JobDefinition_Parameters](#jobdefinitionparameters) -* **PlatformCapabilities**: string[] -* **PropagateTags**: bool -* **RetryStrategy**: [RetryStrategy](#retrystrategy) -* **Revision**: int (ReadOnly) -* **SchedulingPriority**: int -* **Status**: string (ReadOnly) -* **Tags**: [JobDefinition_Tags](#jobdefinitiontags): A key-value pair to associate with a resource. -* **Timeout**: [JobTimeout](#jobtimeout) -* **Type**: string (Required) - -## ContainerProperties -### Properties -* **Command**: string[] -* **Environment**: [Environment](#environment)[] -* **EphemeralStorage**: [JobDefinition_EphemeralStorage](#jobdefinitionephemeralstorage) -* **ExecutionRoleArn**: string -* **FargatePlatformConfiguration**: [JobDefinition_FargatePlatformConfiguration](#jobdefinitionfargateplatformconfiguration) -* **Image**: string (Required) -* **InstanceType**: string (WriteOnly) -* **JobRoleArn**: string -* **LinuxParameters**: [JobDefinition_LinuxParameters](#jobdefinitionlinuxparameters) -* **LogConfiguration**: [JobDefinition_LogConfiguration](#jobdefinitionlogconfiguration) -* **Memory**: int -* **MountPoints**: [MountPoint](#mountpoint)[] -* **NetworkConfiguration**: [JobDefinition_NetworkConfiguration](#jobdefinitionnetworkconfiguration) -* **Privileged**: bool -* **ReadonlyRootFilesystem**: bool -* **ResourceRequirements**: [ResourceRequirement](#resourcerequirement)[] -* **RuntimePlatform**: [JobDefinition_RuntimePlatform](#jobdefinitionruntimeplatform) -* **Secrets**: [Secret](#secret)[] -* **Ulimits**: [Ulimit](#ulimit)[] -* **User**: string -* **Vcpus**: int -* **Volumes**: [Volume](#volume)[] - -## Environment -### Properties -* **Name**: string -* **Value**: string - -## JobDefinition_EphemeralStorage -### Properties -* **SizeInGiB**: int (Required) - -## JobDefinition_FargatePlatformConfiguration -### Properties -* **PlatformVersion**: string - -## JobDefinition_LinuxParameters -### Properties -* **Devices**: [Device](#device)[] -* **InitProcessEnabled**: bool -* **MaxSwap**: int -* **SharedMemorySize**: int -* **Swappiness**: int -* **Tmpfs**: [Tmpfs](#tmpfs)[] - -## Device -### Properties -* **ContainerPath**: string -* **HostPath**: string -* **Permissions**: string[] - -## Tmpfs -### Properties -* **ContainerPath**: string (Required) -* **MountOptions**: string[] -* **Size**: int (Required) - -## JobDefinition_LogConfiguration -### Properties -* **LogDriver**: string (Required) -* **Options**: [JobDefinition_LogConfiguration_Options](#jobdefinitionlogconfigurationoptions) -* **SecretOptions**: [Secret](#secret)[] - -## JobDefinition_LogConfiguration_Options -### Properties - -## Secret -### Properties -* **Name**: string (Required) -* **ValueFrom**: string (Required) - -## MountPoint -### Properties -* **ContainerPath**: string -* **ReadOnly**: bool -* **SourceVolume**: string - -## JobDefinition_NetworkConfiguration -### Properties -* **AssignPublicIp**: string - -## ResourceRequirement -### Properties -* **Type**: string -* **Value**: string - -## JobDefinition_RuntimePlatform -### Properties -* **CpuArchitecture**: string -* **OperatingSystemFamily**: string - -## Ulimit -### Properties -* **HardLimit**: int (Required) -* **Name**: string (Required) -* **SoftLimit**: int (Required) - -## Volume -### Properties -* **EfsVolumeConfiguration**: [EFSVolumeConfiguration](#efsvolumeconfiguration) -* **Host**: [Host](#host) -* **Name**: string - -## EFSVolumeConfiguration -### Properties -* **AuthorizationConfig**: [EFSAuthorizationConfig](#efsauthorizationconfig) -* **FileSystemId**: string (Required) -* **RootDirectory**: string -* **TransitEncryption**: string -* **TransitEncryptionPort**: int - -## EFSAuthorizationConfig -### Properties -* **AccessPointId**: string -* **Iam**: string - -## Host -### Properties -* **SourcePath**: string - -## EksProperties -### Properties -* **PodProperties**: [EksPodProperties](#ekspodproperties) - -## EksPodProperties -### Properties -* **Containers**: [EksContainer](#ekscontainer)[] -* **DnsPolicy**: string -* **HostNetwork**: bool -* **Metadata**: [EksMetadata](#eksmetadata) -* **ServiceAccountName**: string -* **Volumes**: [EksVolume](#eksvolume)[] - -## EksContainer -### Properties -* **Args**: string[] -* **Command**: string[] -* **Env**: [EksContainerEnvironmentVariable](#ekscontainerenvironmentvariable)[] -* **Image**: string (Required) -* **ImagePullPolicy**: string -* **Name**: string -* **Resources**: [EksContainerResourceRequirements](#ekscontainerresourcerequirements) -* **SecurityContext**: [EksContainerSecurityContext](#ekscontainersecuritycontext) -* **VolumeMounts**: [EksContainerVolumeMount](#ekscontainervolumemount)[] - -## EksContainerEnvironmentVariable -### Properties -* **Name**: string (Required) -* **Value**: string - -## EksContainerResourceRequirements -### Properties -* **Limits**: [JobDefinition_Limits](#jobdefinitionlimits) -* **Requests**: [JobDefinition_Requests](#jobdefinitionrequests) - -## JobDefinition_Limits -### Properties - -## JobDefinition_Requests -### Properties - -## EksContainerSecurityContext -### Properties -* **Privileged**: bool -* **ReadOnlyRootFilesystem**: bool -* **RunAsGroup**: int -* **RunAsNonRoot**: bool -* **RunAsUser**: int - -## EksContainerVolumeMount -### Properties -* **MountPath**: string -* **Name**: string -* **ReadOnly**: bool - -## EksMetadata -### Properties -* **Labels**: [JobDefinition_Labels](#jobdefinitionlabels) - -## JobDefinition_Labels -### Properties - -## EksVolume -### Properties -* **EmptyDir**: [EksEmptyDir](#eksemptydir) -* **HostPath**: [EksHostPath](#ekshostpath) -* **Name**: string (Required) -* **Secret**: [EksSecret](#ekssecret) - -## EksEmptyDir -### Properties -* **Medium**: string -* **SizeLimit**: string - -## EksHostPath -### Properties -* **Path**: string - -## EksSecret -### Properties -* **Optional**: bool -* **SecretName**: string (Required) - -## NodeProperties -### Properties -* **MainNode**: int (Required) -* **NodeRangeProperties**: [NodeRangeProperty](#noderangeproperty)[] (Required, WriteOnly) -* **NumNodes**: int (Required) - -## NodeRangeProperty -### Properties -* **Container**: [ContainerProperties](#containerproperties) -* **TargetNodes**: string (Required) - -## JobDefinition_Parameters +## FairsharePolicy ### Properties +* **ComputeReservation**: int +* **ShareDecaySeconds**: int +* **ShareDistribution**: [ShareAttributes](#shareattributes)[]: List of Share Attributes -## RetryStrategy +## JobQueue_Tags ### Properties -* **Attempts**: int -* **EvaluateOnExit**: [EvaluateOnExit](#evaluateonexit)[] -## EvaluateOnExit +## JobStateTimeLimitAction ### Properties * **Action**: string (Required) -* **OnExitCode**: string -* **OnReason**: string -* **OnStatusReason**: string - -## JobDefinition_Tags -### Properties - -## JobTimeout -### Properties -* **AttemptDurationSeconds**: int - -## AWS.Batch/JobQueueProperties -### Properties -* **ComputeEnvironmentOrder**: [ComputeEnvironmentOrder](#computeenvironmentorder)[] (Required) -* **JobQueueArn**: string (ReadOnly, Identifier) -* **JobQueueName**: string -* **Priority**: int (Required) -* **SchedulingPolicyArn**: string -* **State**: string -* **Tags**: [JobQueue_Tags](#jobqueuetags): A key-value pair to associate with a resource. - -## ComputeEnvironmentOrder -### Properties -* **ComputeEnvironment**: string (Required) -* **Order**: int (Required) +* **MaxTimeSeconds**: int (Required) +* **Reason**: string (Required) +* **State**: string (Required) -## JobQueue_Tags -### Properties - -## AWS.Batch/SchedulingPolicyProperties +## LaunchTemplateSpecification ### Properties -* **Arn**: string (ReadOnly, Identifier) -* **FairsharePolicy**: [FairsharePolicy](#fairsharepolicy) -* **Name**: string: Name of Scheduling Policy. -* **Tags**: [SchedulingPolicy_Tags](#schedulingpolicytags): A key-value pair to associate with a resource. +* **LaunchTemplateId**: string +* **LaunchTemplateName**: string +* **Version**: string -## FairsharePolicy +## SchedulingPolicy_Tags ### Properties -* **ComputeReservation**: int -* **ShareDecaySeconds**: int -* **ShareDistribution**: [ShareAttributes](#shareattributes)[]: List of Share Attributes ## ShareAttributes ### Properties * **ShareIdentifier**: string * **WeightFactor**: int -## SchedulingPolicy_Tags +## UpdatePolicy ### Properties +* **JobExecutionTimeoutMinutes**: int +* **TerminateJobsOnUpdate**: bool diff --git a/artifacts/bicep/aws/aws.bedrock/default/types.json b/artifacts/bicep/aws/aws.bedrock/default/types.json new file mode 100644 index 00000000..b03ae296 --- /dev/null +++ b/artifacts/bicep/aws/aws.bedrock/default/types.json @@ -0,0 +1,2100 @@ +[ + { + "$type": "ObjectType", + "name": "APISchema", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ActionGroupExecutor", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ActionGroupSignature", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ActionGroupState", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AgentActionGroup", + "properties": { + "ActionGroupExecutor": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "ActionGroupName": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "Name of the action group" + }, + "ActionGroupState": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "ApiSchema": { + "type": { + "$ref": "#/0" + }, + "flags": 0 + }, + "Description": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "Description of action group" + }, + "FunctionSchema": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "ParentActionGroupSignature": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "SkipResourceInUseCheckOnDelete": { + "type": { + "$ref": "#/24" + }, + "flags": 0, + "description": "Specifies whether to allow deleting action group while it is in use." + } + } + }, + { + "$type": "ObjectType", + "name": "AgentKnowledgeBase", + "properties": { + "Description": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "Description of the Resource." + }, + "KnowledgeBaseId": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "Identifier for a resource." + }, + "KnowledgeBaseState": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AgentStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CreationMode", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CustomControlMethod", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Function", + "properties": { + "Description": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "Description of function" + }, + "Name": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "Name for a resource." + }, + "Parameters": { + "type": { + "$ref": "#/15" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FunctionSchema", + "properties": { + "Functions": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "List of Function definitions" + } + } + }, + { + "$type": "ObjectType", + "name": "GuardrailConfiguration", + "properties": { + "GuardrailIdentifier": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "Identifier for the guardrail, could be the id or the arn" + }, + "GuardrailVersion": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "Version of the guardrail" + } + } + }, + { + "$type": "ObjectType", + "name": "InferenceConfiguration", + "properties": { + "MaximumLength": { + "type": { + "$ref": "#/26" + }, + "flags": 0, + "description": "Maximum length of output" + }, + "StopSequences": { + "type": { + "$ref": "#/27" + }, + "flags": 0, + "description": "List of stop sequences" + }, + "Temperature": { + "type": { + "$ref": "#/26" + }, + "flags": 0, + "description": "Controls randomness, higher values increase diversity" + }, + "TopK": { + "type": { + "$ref": "#/26" + }, + "flags": 0, + "description": "Sample from the k most likely next tokens" + }, + "TopP": { + "type": { + "$ref": "#/26" + }, + "flags": 0, + "description": "Cumulative probability cutoff for token selection" + } + } + }, + { + "$type": "ObjectType", + "name": "KnowledgeBaseState", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ParameterDetail", + "properties": { + "Description": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "Description of function parameter." + }, + "Required": { + "type": { + "$ref": "#/24" + }, + "flags": 0, + "description": "Information about if a parameter is required for function call. Default to false." + }, + "Type": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ParameterMap", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PromptConfiguration", + "properties": { + "BasePromptTemplate": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "Base Prompt Template." + }, + "InferenceConfiguration": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + }, + "ParserMode": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "PromptCreationMode": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "PromptState": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "PromptType": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PromptOverrideConfiguration", + "properties": { + "OverrideLambda": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "ARN of a Lambda." + }, + "PromptConfigurations": { + "type": { + "$ref": "#/28" + }, + "flags": 1, + "description": "List of BasePromptConfiguration" + } + } + }, + { + "$type": "ObjectType", + "name": "PromptState", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PromptType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "S3Identifier", + "properties": { + "S3BucketName": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "A bucket in S3." + }, + "S3ObjectKey": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "A object key in S3." + } + } + }, + { + "$type": "ObjectType", + "name": "TagsMap", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Type", + "properties": {} + }, + { + "$type": "StringType" + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/9" + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/23" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/16" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Bedrock/AgentProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/23" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/23" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Bedrock/AgentProperties", + "properties": { + "ActionGroups": { + "type": { + "$ref": "#/30" + }, + "flags": 4, + "description": "List of ActionGroups" + }, + "AgentArn": { + "type": { + "$ref": "#/23" + }, + "flags": 2, + "description": "Arn representation of the Agent." + }, + "AgentId": { + "type": { + "$ref": "#/23" + }, + "flags": 18, + "description": "Identifier for a resource." + }, + "AgentName": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "Name for a resource." + }, + "AgentResourceRoleArn": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "ARN of a IAM role." + }, + "AgentStatus": { + "type": { + "$ref": "#/23" + }, + "flags": 2 + }, + "AgentVersion": { + "type": { + "$ref": "#/23" + }, + "flags": 2, + "description": "Draft Agent Version." + }, + "AutoPrepare": { + "type": { + "$ref": "#/24" + }, + "flags": 4, + "description": "Specifies whether to automatically prepare after creating or updating the agent." + }, + "CreatedAt": { + "type": { + "$ref": "#/23" + }, + "flags": 2, + "description": "Time Stamp." + }, + "CustomerEncryptionKeyArn": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "A KMS key ARN" + }, + "Description": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "Description of the Resource." + }, + "FailureReasons": { + "type": { + "$ref": "#/31" + }, + "flags": 2, + "description": "Failure Reasons for Error." + }, + "FoundationModel": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "ARN or name of a Bedrock model." + }, + "GuardrailConfiguration": { + "type": { + "$ref": "#/11" + }, + "flags": 0 + }, + "IdleSessionTTLInSeconds": { + "type": { + "$ref": "#/26" + }, + "flags": 0, + "description": "Max Session Time." + }, + "Instruction": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "Instruction for the agent." + }, + "KnowledgeBases": { + "type": { + "$ref": "#/32" + }, + "flags": 0, + "description": "List of Agent Knowledge Bases" + }, + "PreparedAt": { + "type": { + "$ref": "#/23" + }, + "flags": 2, + "description": "Time Stamp." + }, + "PromptOverrideConfiguration": { + "type": { + "$ref": "#/17" + }, + "flags": 0 + }, + "RecommendedActions": { + "type": { + "$ref": "#/33" + }, + "flags": 2, + "description": "The recommended actions users can take to resolve an error in failureReasons." + }, + "SkipResourceInUseCheckOnDelete": { + "type": { + "$ref": "#/24" + }, + "flags": 4, + "description": "Specifies whether to allow deleting agent while it is in use." + }, + "Tags": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "TestAliasTags": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "UpdatedAt": { + "type": { + "$ref": "#/23" + }, + "flags": 2, + "description": "Time Stamp." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Bedrock/Agent", + "properties": { + "name": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/23" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/34" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Bedrock/Agent@default", + "scopeType": 0, + "body": { + "$ref": "#/35" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AgentAliasHistoryEvent", + "properties": { + "EndDate": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "Time Stamp." + }, + "RoutingConfiguration": { + "type": { + "$ref": "#/41" + }, + "flags": 0, + "description": "Routing configuration for an Agent alias." + }, + "StartDate": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "Time Stamp." + } + } + }, + { + "$type": "ObjectType", + "name": "AgentAliasRoutingConfigurationListItem", + "properties": { + "AgentVersion": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "Agent Version." + } + } + }, + { + "$type": "ObjectType", + "name": "AgentAliasStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TagsMap", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/38" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Bedrock/AgentAliasProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/37" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/38" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Bedrock/AgentAliasProperties", + "properties": { + "AgentAliasArn": { + "type": { + "$ref": "#/23" + }, + "flags": 2, + "description": "Arn representation of the Agent Alias." + }, + "AgentAliasHistoryEvents": { + "type": { + "$ref": "#/43" + }, + "flags": 2, + "description": "The list of history events for an alias for an Agent." + }, + "AgentAliasId": { + "type": { + "$ref": "#/23" + }, + "flags": 18, + "description": "Id for an Agent Alias generated at the server side." + }, + "AgentAliasName": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "Name for a resource." + }, + "AgentAliasStatus": { + "type": { + "$ref": "#/23" + }, + "flags": 2 + }, + "AgentId": { + "type": { + "$ref": "#/23" + }, + "flags": 17, + "description": "Identifier for a resource." + }, + "CreatedAt": { + "type": { + "$ref": "#/23" + }, + "flags": 2, + "description": "Time Stamp." + }, + "Description": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "Description of the Resource." + }, + "RoutingConfiguration": { + "type": { + "$ref": "#/44" + }, + "flags": 0, + "description": "Routing configuration for an Agent alias." + }, + "Tags": { + "type": { + "$ref": "#/40" + }, + "flags": 0 + }, + "UpdatedAt": { + "type": { + "$ref": "#/23" + }, + "flags": 2, + "description": "Time Stamp." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Bedrock/AgentAlias", + "properties": { + "name": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/23" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/45" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Bedrock/AgentAlias@default", + "scopeType": 0, + "body": { + "$ref": "#/46" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "ChunkingConfiguration", + "properties": { + "ChunkingStrategy": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + }, + "FixedSizeChunkingConfiguration": { + "type": { + "$ref": "#/54" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ChunkingStrategy", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DataDeletionPolicy", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DataSourceConfiguration", + "properties": { + "S3Configuration": { + "type": { + "$ref": "#/55" + }, + "flags": 1 + }, + "Type": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DataSourceStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DataSourceType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "FixedSizeChunkingConfiguration", + "properties": { + "MaxTokens": { + "type": { + "$ref": "#/26" + }, + "flags": 1, + "description": "The maximum number of tokens to include in a chunk." + }, + "OverlapPercentage": { + "type": { + "$ref": "#/26" + }, + "flags": 1, + "description": "The percentage of overlap between adjacent chunks of a data source." + } + } + }, + { + "$type": "ObjectType", + "name": "S3DataSourceConfiguration", + "properties": { + "BucketArn": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "The ARN of the bucket that contains the data source." + }, + "BucketOwnerAccountId": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "The account ID for the owner of the S3 bucket." + }, + "InclusionPrefixes": { + "type": { + "$ref": "#/58" + }, + "flags": 0, + "description": "A list of S3 prefixes that define the object containing the data sources." + } + } + }, + { + "$type": "ObjectType", + "name": "ServerSideEncryptionConfiguration", + "properties": { + "KmsKeyArn": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "The ARN of the AWS KMS key used to encrypt the resource." + } + } + }, + { + "$type": "ObjectType", + "name": "VectorIngestionConfiguration", + "properties": { + "ChunkingConfiguration": { + "type": { + "$ref": "#/48" + }, + "flags": 0 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/23" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Bedrock/DataSourceProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/23" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Bedrock/DataSourceProperties", + "properties": { + "CreatedAt": { + "type": { + "$ref": "#/23" + }, + "flags": 2, + "description": "The time at which the data source was created." + }, + "DataDeletionPolicy": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "DataSourceConfiguration": { + "type": { + "$ref": "#/51" + }, + "flags": 1 + }, + "DataSourceId": { + "type": { + "$ref": "#/23" + }, + "flags": 18, + "description": "Identifier for a resource." + }, + "DataSourceStatus": { + "type": { + "$ref": "#/23" + }, + "flags": 2 + }, + "Description": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "Description of the Resource." + }, + "FailureReasons": { + "type": { + "$ref": "#/60" + }, + "flags": 2, + "description": "The details of the failure reasons related to the data source." + }, + "KnowledgeBaseId": { + "type": { + "$ref": "#/23" + }, + "flags": 17, + "description": "The unique identifier of the knowledge base to which to add the data source." + }, + "Name": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "The name of the data source." + }, + "ServerSideEncryptionConfiguration": { + "type": { + "$ref": "#/56" + }, + "flags": 0 + }, + "UpdatedAt": { + "type": { + "$ref": "#/23" + }, + "flags": 2, + "description": "The time at which the knowledge base was last updated." + }, + "VectorIngestionConfiguration": { + "type": { + "$ref": "#/57" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Bedrock/DataSource", + "properties": { + "name": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/23" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/61" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Bedrock/DataSource@default", + "scopeType": 0, + "body": { + "$ref": "#/62" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "ContentFilter", + "properties": { + "InputStrength": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + }, + "OutputStrength": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + }, + "Type": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ContentFilterConfig", + "properties": { + "InputStrength": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + }, + "OutputStrength": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + }, + "Type": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ContentFilterType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ContentPolicyConfig", + "properties": { + "FiltersConfig": { + "type": { + "$ref": "#/86" + }, + "flags": 1, + "description": "List of content filter configs in content policy." + } + } + }, + { + "$type": "ObjectType", + "name": "FilterStrength", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "GuardrailStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ManagedWords", + "properties": { + "Type": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ManagedWordsConfig", + "properties": { + "Type": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ManagedWordsType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PiiEntity", + "properties": { + "Action": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + }, + "Type": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "PiiEntityConfig", + "properties": { + "Action": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + }, + "Type": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "PiiEntityType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RegexConfig", + "properties": { + "Action": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + }, + "Description": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "The regex description." + }, + "Name": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "The regex name." + }, + "Pattern": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "The regex pattern." + } + } + }, + { + "$type": "ObjectType", + "name": "SensitiveInformationAction", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SensitiveInformationPolicyConfig", + "properties": { + "PiiEntitiesConfig": { + "type": { + "$ref": "#/87" + }, + "flags": 0, + "description": "List of entities." + }, + "RegexesConfig": { + "type": { + "$ref": "#/88" + }, + "flags": 0, + "description": "List of regex." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "Tag Key" + }, + "Value": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "Tag Value" + } + } + }, + { + "$type": "ObjectType", + "name": "Topic", + "properties": { + "Definition": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "Definition of topic in topic policy" + }, + "Examples": { + "type": { + "$ref": "#/89" + }, + "flags": 0, + "description": "List of text examples" + }, + "Name": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "Name of topic in topic policy" + }, + "Type": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TopicConfig", + "properties": { + "Definition": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "Definition of topic in topic policy" + }, + "Examples": { + "type": { + "$ref": "#/90" + }, + "flags": 0, + "description": "List of text examples" + }, + "Name": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "Name of topic in topic policy" + }, + "Type": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TopicPolicyConfig", + "properties": { + "TopicsConfig": { + "type": { + "$ref": "#/91" + }, + "flags": 1, + "description": "List of topic configs in topic policy." + } + } + }, + { + "$type": "ObjectType", + "name": "TopicType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "WordConfig", + "properties": { + "Text": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "The custom word text." + } + } + }, + { + "$type": "ObjectType", + "name": "WordPolicyConfig", + "properties": { + "ManagedWordListsConfig": { + "type": { + "$ref": "#/92" + }, + "flags": 0, + "description": "A config for the list of managed words." + }, + "WordsConfig": { + "type": { + "$ref": "#/93" + }, + "flags": 0, + "description": "List of custom word configs." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/65" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/74" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/76" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/23" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/23" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/81" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/71" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/84" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Bedrock/GuardrailProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/23" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/23" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/79" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Bedrock/GuardrailProperties", + "properties": { + "BlockedInputMessaging": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "Messaging for when violations are detected in text" + }, + "BlockedOutputsMessaging": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "Messaging for when violations are detected in text" + }, + "ContentPolicyConfig": { + "type": { + "$ref": "#/67" + }, + "flags": 0 + }, + "CreatedAt": { + "type": { + "$ref": "#/23" + }, + "flags": 2, + "description": "Time Stamp" + }, + "Description": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "Description of the guardrail or its version" + }, + "FailureRecommendations": { + "type": { + "$ref": "#/95" + }, + "flags": 2, + "description": "List of failure recommendations" + }, + "GuardrailArn": { + "type": { + "$ref": "#/23" + }, + "flags": 18, + "description": "Arn representation for the guardrail" + }, + "GuardrailId": { + "type": { + "$ref": "#/23" + }, + "flags": 2, + "description": "Unique id for the guardrail" + }, + "KmsKeyArn": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "The KMS key with which the guardrail was encrypted at rest" + }, + "Name": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "Name of the guardrail" + }, + "SensitiveInformationPolicyConfig": { + "type": { + "$ref": "#/78" + }, + "flags": 0 + }, + "Status": { + "type": { + "$ref": "#/23" + }, + "flags": 2 + }, + "StatusReasons": { + "type": { + "$ref": "#/96" + }, + "flags": 2, + "description": "List of status reasons" + }, + "Tags": { + "type": { + "$ref": "#/97" + }, + "flags": 0, + "description": "List of Tags" + }, + "TopicPolicyConfig": { + "type": { + "$ref": "#/82" + }, + "flags": 0 + }, + "UpdatedAt": { + "type": { + "$ref": "#/23" + }, + "flags": 2, + "description": "Time Stamp" + }, + "Version": { + "type": { + "$ref": "#/23" + }, + "flags": 2, + "description": "Guardrail version" + }, + "WordPolicyConfig": { + "type": { + "$ref": "#/85" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Bedrock/Guardrail", + "properties": { + "name": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/23" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/98" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Bedrock/Guardrail@default", + "scopeType": 0, + "body": { + "$ref": "#/99" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "KnowledgeBaseConfiguration", + "properties": { + "Type": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + }, + "VectorKnowledgeBaseConfiguration": { + "type": { + "$ref": "#/115" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "KnowledgeBaseStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "KnowledgeBaseStorageType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "KnowledgeBaseType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "OpenSearchServerlessConfiguration", + "properties": { + "CollectionArn": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "The ARN of the OpenSearch Service vector store." + }, + "FieldMapping": { + "type": { + "$ref": "#/106" + }, + "flags": 1 + }, + "VectorIndexName": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "The name of the vector store." + } + } + }, + { + "$type": "ObjectType", + "name": "OpenSearchServerlessFieldMapping", + "properties": { + "MetadataField": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "The name of the field in which Amazon Bedrock stores metadata about the vector store." + }, + "TextField": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "The 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." + }, + "VectorField": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources." + } + } + }, + { + "$type": "ObjectType", + "name": "PineconeConfiguration", + "properties": { + "ConnectionString": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "The endpoint URL for your index management page." + }, + "CredentialsSecretArn": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "The ARN of the secret that you created in AWS Secrets Manager that is linked to your Pinecone API key." + }, + "FieldMapping": { + "type": { + "$ref": "#/108" + }, + "flags": 1 + }, + "Namespace": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "The namespace to be used to write new data to your database." + } + } + }, + { + "$type": "ObjectType", + "name": "PineconeFieldMapping", + "properties": { + "MetadataField": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "The name of the field in which Amazon Bedrock stores metadata about the vector store." + }, + "TextField": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "The 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." + } + } + }, + { + "$type": "ObjectType", + "name": "RdsConfiguration", + "properties": { + "CredentialsSecretArn": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "The ARN of the secret that you created in AWS Secrets Manager that is linked to your Amazon RDS database." + }, + "DatabaseName": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "The name of your Amazon RDS database." + }, + "FieldMapping": { + "type": { + "$ref": "#/110" + }, + "flags": 1 + }, + "ResourceArn": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "The ARN of the vector store." + }, + "TableName": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "The name of the table in the database." + } + } + }, + { + "$type": "ObjectType", + "name": "RdsFieldMapping", + "properties": { + "MetadataField": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "The name of the field in which Amazon Bedrock stores metadata about the vector store." + }, + "PrimaryKeyField": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "The name of the field in which Amazon Bedrock stores the ID for each entry." + }, + "TextField": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "The 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." + }, + "VectorField": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources." + } + } + }, + { + "$type": "ObjectType", + "name": "RedisEnterpriseCloudConfiguration", + "properties": { + "CredentialsSecretArn": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "The ARN of the secret that you created in AWS Secrets Manager that is linked to your Redis Enterprise Cloud database." + }, + "Endpoint": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "The endpoint URL of the Redis Enterprise Cloud database." + }, + "FieldMapping": { + "type": { + "$ref": "#/112" + }, + "flags": 1 + }, + "VectorIndexName": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "The name of the vector index." + } + } + }, + { + "$type": "ObjectType", + "name": "RedisEnterpriseCloudFieldMapping", + "properties": { + "MetadataField": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "The name of the field in which Amazon Bedrock stores metadata about the vector store." + }, + "TextField": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "The 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." + }, + "VectorField": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources." + } + } + }, + { + "$type": "ObjectType", + "name": "StorageConfiguration", + "properties": { + "OpensearchServerlessConfiguration": { + "type": { + "$ref": "#/105" + }, + "flags": 0 + }, + "PineconeConfiguration": { + "type": { + "$ref": "#/107" + }, + "flags": 0 + }, + "RdsConfiguration": { + "type": { + "$ref": "#/109" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TagsMap", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "VectorKnowledgeBaseConfiguration", + "properties": { + "EmbeddingModelArn": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "The ARN of the model used to create vector embeddings for the knowledge base." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Bedrock/KnowledgeBaseProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/23" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Bedrock/KnowledgeBaseProperties", + "properties": { + "CreatedAt": { + "type": { + "$ref": "#/23" + }, + "flags": 2, + "description": "The time at which the knowledge base was created." + }, + "Description": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "Description of the Resource." + }, + "FailureReasons": { + "type": { + "$ref": "#/117" + }, + "flags": 2, + "description": "A list of reasons that the API operation on the knowledge base failed." + }, + "KnowledgeBaseArn": { + "type": { + "$ref": "#/23" + }, + "flags": 2, + "description": "The ARN of the knowledge base." + }, + "KnowledgeBaseConfiguration": { + "type": { + "$ref": "#/101" + }, + "flags": 1 + }, + "KnowledgeBaseId": { + "type": { + "$ref": "#/23" + }, + "flags": 18, + "description": "The unique identifier of the knowledge base." + }, + "Name": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "The name of the knowledge base." + }, + "RoleArn": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "The ARN of the IAM role with permissions to invoke API operations on the knowledge base. The ARN must begin with AmazonBedrockExecutionRoleForKnowledgeBase_" + }, + "Status": { + "type": { + "$ref": "#/23" + }, + "flags": 2 + }, + "StorageConfiguration": { + "type": { + "$ref": "#/113" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/114" + }, + "flags": 0 + }, + "UpdatedAt": { + "type": { + "$ref": "#/23" + }, + "flags": 2, + "description": "The time at which the knowledge base was last updated." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Bedrock/KnowledgeBase", + "properties": { + "name": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/23" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/118" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Bedrock/KnowledgeBase@default", + "scopeType": 0, + "body": { + "$ref": "#/119" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.bedrock/default/types.md b/artifacts/bicep/aws/aws.bedrock/default/types.md new file mode 100644 index 00000000..b133231b --- /dev/null +++ b/artifacts/bicep/aws/aws.bedrock/default/types.md @@ -0,0 +1,351 @@ +# AWS.Bedrock @ default + +## Resource AWS.Bedrock/Agent@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.Bedrock/AgentProperties](#awsbedrockagentproperties) (Required, Identifier): properties of the resource + +## Resource AWS.Bedrock/AgentAlias@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.Bedrock/AgentAliasProperties](#awsbedrockagentaliasproperties) (Required, Identifier): properties of the resource + +## Resource AWS.Bedrock/DataSource@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.Bedrock/DataSourceProperties](#awsbedrockdatasourceproperties) (Required, Identifier): properties of the resource + +## Resource AWS.Bedrock/Guardrail@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.Bedrock/GuardrailProperties](#awsbedrockguardrailproperties) (Required, Identifier): properties of the resource + +## Resource AWS.Bedrock/KnowledgeBase@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.Bedrock/KnowledgeBaseProperties](#awsbedrockknowledgebaseproperties) (Required, Identifier): properties of the resource + +## ActionGroupExecutor +### Properties + +## AgentActionGroup +### Properties +* **ActionGroupExecutor**: [ActionGroupExecutor](#actiongroupexecutor) +* **ActionGroupName**: string (Required): Name of the action group +* **ActionGroupState**: string +* **ApiSchema**: [APISchema](#apischema) +* **Description**: string: Description of action group +* **FunctionSchema**: [FunctionSchema](#functionschema) +* **ParentActionGroupSignature**: string +* **SkipResourceInUseCheckOnDelete**: bool: Specifies whether to allow deleting action group while it is in use. + +## AgentAliasHistoryEvent +### Properties +* **EndDate**: string: Time Stamp. +* **RoutingConfiguration**: [AgentAliasRoutingConfigurationListItem](#agentaliasroutingconfigurationlistitem)[]: Routing configuration for an Agent alias. +* **StartDate**: string: Time Stamp. + +## AgentAliasRoutingConfigurationListItem +### Properties +* **AgentVersion**: string (Required): Agent Version. + +## AgentKnowledgeBase +### Properties +* **Description**: string (Required): Description of the Resource. +* **KnowledgeBaseId**: string (Required): Identifier for a resource. +* **KnowledgeBaseState**: string + +## APISchema +### Properties + +## AWS.Bedrock/AgentAliasProperties +### Properties +* **AgentAliasArn**: string (ReadOnly): Arn representation of the Agent Alias. +* **AgentAliasHistoryEvents**: [AgentAliasHistoryEvent](#agentaliashistoryevent)[] (ReadOnly): The list of history events for an alias for an Agent. +* **AgentAliasId**: string (ReadOnly, Identifier): Id for an Agent Alias generated at the server side. +* **AgentAliasName**: string (Required): Name for a resource. +* **AgentAliasStatus**: string (ReadOnly) +* **AgentId**: string (Required, Identifier): Identifier for a resource. +* **CreatedAt**: string (ReadOnly): Time Stamp. +* **Description**: string: Description of the Resource. +* **RoutingConfiguration**: [AgentAliasRoutingConfigurationListItem](#agentaliasroutingconfigurationlistitem)[]: Routing configuration for an Agent alias. +* **Tags**: [TagsMap](#tagsmap) +* **UpdatedAt**: string (ReadOnly): Time Stamp. + +## AWS.Bedrock/AgentProperties +### Properties +* **ActionGroups**: [AgentActionGroup](#agentactiongroup)[] (WriteOnly): List of ActionGroups +* **AgentArn**: string (ReadOnly): Arn representation of the Agent. +* **AgentId**: string (ReadOnly, Identifier): Identifier for a resource. +* **AgentName**: string (Required): Name for a resource. +* **AgentResourceRoleArn**: string: ARN of a IAM role. +* **AgentStatus**: string (ReadOnly) +* **AgentVersion**: string (ReadOnly): Draft Agent Version. +* **AutoPrepare**: bool (WriteOnly): Specifies whether to automatically prepare after creating or updating the agent. +* **CreatedAt**: string (ReadOnly): Time Stamp. +* **CustomerEncryptionKeyArn**: string: A KMS key ARN +* **Description**: string: Description of the Resource. +* **FailureReasons**: string[] (ReadOnly): Failure Reasons for Error. +* **FoundationModel**: string: ARN or name of a Bedrock model. +* **GuardrailConfiguration**: [GuardrailConfiguration](#guardrailconfiguration) +* **IdleSessionTTLInSeconds**: int: Max Session Time. +* **Instruction**: string: Instruction for the agent. +* **KnowledgeBases**: [AgentKnowledgeBase](#agentknowledgebase)[]: List of Agent Knowledge Bases +* **PreparedAt**: string (ReadOnly): Time Stamp. +* **PromptOverrideConfiguration**: [PromptOverrideConfiguration](#promptoverrideconfiguration) +* **RecommendedActions**: string[] (ReadOnly): The recommended actions users can take to resolve an error in failureReasons. +* **SkipResourceInUseCheckOnDelete**: bool (WriteOnly): Specifies whether to allow deleting agent while it is in use. +* **Tags**: [TagsMap](#tagsmap) +* **TestAliasTags**: [TagsMap](#tagsmap) +* **UpdatedAt**: string (ReadOnly): Time Stamp. + +## AWS.Bedrock/DataSourceProperties +### Properties +* **CreatedAt**: string (ReadOnly): The time at which the data source was created. +* **DataDeletionPolicy**: string +* **DataSourceConfiguration**: [DataSourceConfiguration](#datasourceconfiguration) (Required) +* **DataSourceId**: string (ReadOnly, Identifier): Identifier for a resource. +* **DataSourceStatus**: string (ReadOnly) +* **Description**: string: Description of the Resource. +* **FailureReasons**: string[] (ReadOnly): The details of the failure reasons related to the data source. +* **KnowledgeBaseId**: string (Required, Identifier): The unique identifier of the knowledge base to which to add the data source. +* **Name**: string (Required): The name of the data source. +* **ServerSideEncryptionConfiguration**: [ServerSideEncryptionConfiguration](#serversideencryptionconfiguration) +* **UpdatedAt**: string (ReadOnly): The time at which the knowledge base was last updated. +* **VectorIngestionConfiguration**: [VectorIngestionConfiguration](#vectoringestionconfiguration) + +## AWS.Bedrock/GuardrailProperties +### Properties +* **BlockedInputMessaging**: string (Required): Messaging for when violations are detected in text +* **BlockedOutputsMessaging**: string (Required): Messaging for when violations are detected in text +* **ContentPolicyConfig**: [ContentPolicyConfig](#contentpolicyconfig) +* **CreatedAt**: string (ReadOnly): Time Stamp +* **Description**: string: Description of the guardrail or its version +* **FailureRecommendations**: string[] (ReadOnly): List of failure recommendations +* **GuardrailArn**: string (ReadOnly, Identifier): Arn representation for the guardrail +* **GuardrailId**: string (ReadOnly): Unique id for the guardrail +* **KmsKeyArn**: string: The KMS key with which the guardrail was encrypted at rest +* **Name**: string (Required): Name of the guardrail +* **SensitiveInformationPolicyConfig**: [SensitiveInformationPolicyConfig](#sensitiveinformationpolicyconfig) +* **Status**: string (ReadOnly) +* **StatusReasons**: string[] (ReadOnly): List of status reasons +* **Tags**: [Tag](#tag)[]: List of Tags +* **TopicPolicyConfig**: [TopicPolicyConfig](#topicpolicyconfig) +* **UpdatedAt**: string (ReadOnly): Time Stamp +* **Version**: string (ReadOnly): Guardrail version +* **WordPolicyConfig**: [WordPolicyConfig](#wordpolicyconfig) + +## AWS.Bedrock/KnowledgeBaseProperties +### Properties +* **CreatedAt**: string (ReadOnly): The time at which the knowledge base was created. +* **Description**: string: Description of the Resource. +* **FailureReasons**: string[] (ReadOnly): A list of reasons that the API operation on the knowledge base failed. +* **KnowledgeBaseArn**: string (ReadOnly): The ARN of the knowledge base. +* **KnowledgeBaseConfiguration**: [KnowledgeBaseConfiguration](#knowledgebaseconfiguration) (Required) +* **KnowledgeBaseId**: string (ReadOnly, Identifier): The unique identifier of the knowledge base. +* **Name**: string (Required): The name of the knowledge base. +* **RoleArn**: string (Required): The ARN of the IAM role with permissions to invoke API operations on the knowledge base. The ARN must begin with AmazonBedrockExecutionRoleForKnowledgeBase_ +* **Status**: string (ReadOnly) +* **StorageConfiguration**: [StorageConfiguration](#storageconfiguration) (Required) +* **Tags**: [TagsMap](#tagsmap) +* **UpdatedAt**: string (ReadOnly): The time at which the knowledge base was last updated. + +## ChunkingConfiguration +### Properties +* **ChunkingStrategy**: string (Required) +* **FixedSizeChunkingConfiguration**: [FixedSizeChunkingConfiguration](#fixedsizechunkingconfiguration) + +## ContentFilterConfig +### Properties +* **InputStrength**: string (Required) +* **OutputStrength**: string (Required) +* **Type**: string (Required) + +## ContentPolicyConfig +### Properties +* **FiltersConfig**: [ContentFilterConfig](#contentfilterconfig)[] (Required): List of content filter configs in content policy. + +## DataSourceConfiguration +### Properties +* **S3Configuration**: [S3DataSourceConfiguration](#s3datasourceconfiguration) (Required) +* **Type**: string (Required) + +## FixedSizeChunkingConfiguration +### Properties +* **MaxTokens**: int (Required): The maximum number of tokens to include in a chunk. +* **OverlapPercentage**: int (Required): The percentage of overlap between adjacent chunks of a data source. + +## Function +### Properties +* **Description**: string: Description of function +* **Name**: string (Required): Name for a resource. +* **Parameters**: [ParameterMap](#parametermap) + +## FunctionSchema +### Properties +* **Functions**: [Function](#function)[] (Required): List of Function definitions + +## GuardrailConfiguration +### Properties +* **GuardrailIdentifier**: string: Identifier for the guardrail, could be the id or the arn +* **GuardrailVersion**: string: Version of the guardrail + +## InferenceConfiguration +### Properties +* **MaximumLength**: int: Maximum length of output +* **StopSequences**: string[]: List of stop sequences +* **Temperature**: int: Controls randomness, higher values increase diversity +* **TopK**: int: Sample from the k most likely next tokens +* **TopP**: int: Cumulative probability cutoff for token selection + +## KnowledgeBaseConfiguration +### Properties +* **Type**: string (Required) +* **VectorKnowledgeBaseConfiguration**: [VectorKnowledgeBaseConfiguration](#vectorknowledgebaseconfiguration) (Required) + +## ManagedWordsConfig +### Properties +* **Type**: string (Required) + +## OpenSearchServerlessConfiguration +### Properties +* **CollectionArn**: string (Required): The ARN of the OpenSearch Service vector store. +* **FieldMapping**: [OpenSearchServerlessFieldMapping](#opensearchserverlessfieldmapping) (Required) +* **VectorIndexName**: string (Required): The name of the vector store. + +## OpenSearchServerlessFieldMapping +### Properties +* **MetadataField**: string (Required): The name of the field in which Amazon Bedrock stores metadata about the vector store. +* **TextField**: string (Required): The 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. +* **VectorField**: string (Required): The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources. + +## ParameterMap +### Properties + +## PiiEntityConfig +### Properties +* **Action**: string (Required) +* **Type**: string (Required) + +## PineconeConfiguration +### Properties +* **ConnectionString**: string (Required): The endpoint URL for your index management page. +* **CredentialsSecretArn**: string (Required): The ARN of the secret that you created in AWS Secrets Manager that is linked to your Pinecone API key. +* **FieldMapping**: [PineconeFieldMapping](#pineconefieldmapping) (Required) +* **Namespace**: string: The namespace to be used to write new data to your database. + +## PineconeFieldMapping +### Properties +* **MetadataField**: string (Required): The name of the field in which Amazon Bedrock stores metadata about the vector store. +* **TextField**: string (Required): The 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. + +## PromptConfiguration +### Properties +* **BasePromptTemplate**: string: Base Prompt Template. +* **InferenceConfiguration**: [InferenceConfiguration](#inferenceconfiguration) +* **ParserMode**: string +* **PromptCreationMode**: string +* **PromptState**: string +* **PromptType**: string + +## PromptOverrideConfiguration +### Properties +* **OverrideLambda**: string: ARN of a Lambda. +* **PromptConfigurations**: [PromptConfiguration](#promptconfiguration)[] (Required): List of BasePromptConfiguration + +## RdsConfiguration +### Properties +* **CredentialsSecretArn**: string (Required): The ARN of the secret that you created in AWS Secrets Manager that is linked to your Amazon RDS database. +* **DatabaseName**: string (Required): The name of your Amazon RDS database. +* **FieldMapping**: [RdsFieldMapping](#rdsfieldmapping) (Required) +* **ResourceArn**: string (Required): The ARN of the vector store. +* **TableName**: string (Required): The name of the table in the database. + +## RdsFieldMapping +### Properties +* **MetadataField**: string (Required): The name of the field in which Amazon Bedrock stores metadata about the vector store. +* **PrimaryKeyField**: string (Required): The name of the field in which Amazon Bedrock stores the ID for each entry. +* **TextField**: string (Required): The 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. +* **VectorField**: string (Required): The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources. + +## RegexConfig +### Properties +* **Action**: string (Required) +* **Description**: string: The regex description. +* **Name**: string (Required): The regex name. +* **Pattern**: string (Required): The regex pattern. + +## S3DataSourceConfiguration +### Properties +* **BucketArn**: string (Required): The ARN of the bucket that contains the data source. +* **BucketOwnerAccountId**: string: The account ID for the owner of the S3 bucket. +* **InclusionPrefixes**: string[]: A list of S3 prefixes that define the object containing the data sources. + +## SensitiveInformationPolicyConfig +### Properties +* **PiiEntitiesConfig**: [PiiEntityConfig](#piientityconfig)[]: List of entities. +* **RegexesConfig**: [RegexConfig](#regexconfig)[]: List of regex. + +## ServerSideEncryptionConfiguration +### Properties +* **KmsKeyArn**: string: The ARN of the AWS KMS key used to encrypt the resource. + +## StorageConfiguration +### Properties +* **OpensearchServerlessConfiguration**: [OpenSearchServerlessConfiguration](#opensearchserverlessconfiguration) +* **PineconeConfiguration**: [PineconeConfiguration](#pineconeconfiguration) +* **RdsConfiguration**: [RdsConfiguration](#rdsconfiguration) +* **Type**: string (Required) + +## Tag +### Properties +* **Key**: string (Required): Tag Key +* **Value**: string (Required): Tag Value + +## TagsMap +### Properties + +## TagsMap +### Properties + +## TagsMap +### Properties + +## TopicConfig +### Properties +* **Definition**: string (Required): Definition of topic in topic policy +* **Examples**: string[]: List of text examples +* **Name**: string (Required): Name of topic in topic policy +* **Type**: string (Required) + +## TopicPolicyConfig +### Properties +* **TopicsConfig**: [TopicConfig](#topicconfig)[] (Required): List of topic configs in topic policy. + +## VectorIngestionConfiguration +### Properties +* **ChunkingConfiguration**: [ChunkingConfiguration](#chunkingconfiguration) + +## VectorKnowledgeBaseConfiguration +### Properties +* **EmbeddingModelArn**: string (Required): The ARN of the model used to create vector embeddings for the knowledge base. + +## WordConfig +### Properties +* **Text**: string (Required): The custom word text. + +## WordPolicyConfig +### Properties +* **ManagedWordListsConfig**: [ManagedWordsConfig](#managedwordsconfig)[]: A config for the list of managed words. +* **WordsConfig**: [WordConfig](#wordconfig)[]: List of custom word configs. + diff --git a/artifacts/bicep/aws/aws.budgets/default/types.json b/artifacts/bicep/aws/aws.budgets/default/types.json index 518a6f90..abeda744 100644 --- a/artifacts/bicep/aws/aws.budgets/default/types.json +++ b/artifacts/bicep/aws/aws.budgets/default/types.json @@ -1 +1,306 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"ActionThreshold","Properties":{"Type":{"Type":4,"Flags":1},"Value":{"Type":3,"Flags":1}}}},{"2":{"Name":"Definition","Properties":{"IamActionDefinition":{"Type":10,"Flags":0},"ScpActionDefinition":{"Type":11,"Flags":0},"SsmActionDefinition":{"Type":12,"Flags":0}}}},{"2":{"Name":"IamActionDefinition","Properties":{"Groups":{"Type":14,"Flags":0},"PolicyArn":{"Type":4,"Flags":1},"Roles":{"Type":15,"Flags":0},"Users":{"Type":16,"Flags":0}}}},{"2":{"Name":"ScpActionDefinition","Properties":{"PolicyId":{"Type":4,"Flags":1},"TargetIds":{"Type":17,"Flags":1}}}},{"2":{"Name":"SsmActionDefinition","Properties":{"InstanceIds":{"Type":18,"Flags":1},"Region":{"Type":4,"Flags":1},"Subtype":{"Type":4,"Flags":1}}}},{"2":{"Name":"Subscriber","Properties":{"Address":{"Type":4,"Flags":1},"Type":{"Type":4,"Flags":1}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.Budgets/BudgetsActionProperties","Properties":{"ActionId":{"Type":4,"Flags":18},"ActionThreshold":{"Type":8,"Flags":1},"ActionType":{"Type":4,"Flags":1},"ApprovalModel":{"Type":4,"Flags":0},"BudgetName":{"Type":4,"Flags":17},"Definition":{"Type":9,"Flags":1},"ExecutionRoleArn":{"Type":4,"Flags":1},"NotificationType":{"Type":4,"Flags":1},"Subscribers":{"Type":20,"Flags":1}}}},{"3":{"ItemType":13}},{"2":{"Name":"AWS.Budgets/BudgetsAction","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":19,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Budgets/BudgetsAction@default","ScopeType":0,"Body":21}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "ActionThreshold", + "properties": { + "Type": { + "type": { + "$ref": "#/7" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Definition", + "properties": { + "IamActionDefinition": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "ScpActionDefinition": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "SsmActionDefinition": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "IamActionDefinition", + "properties": { + "Groups": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "PolicyArn": { + "type": { + "$ref": "#/7" + }, + "flags": 1 + }, + "Roles": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "Users": { + "type": { + "$ref": "#/11" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ResourceTag", + "properties": { + "Key": { + "type": { + "$ref": "#/7" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/7" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ScpActionDefinition", + "properties": { + "PolicyId": { + "type": { + "$ref": "#/7" + }, + "flags": 1 + }, + "TargetIds": { + "type": { + "$ref": "#/12" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "SsmActionDefinition", + "properties": { + "InstanceIds": { + "type": { + "$ref": "#/13" + }, + "flags": 1 + }, + "Region": { + "type": { + "$ref": "#/7" + }, + "flags": 1 + }, + "Subtype": { + "type": { + "$ref": "#/7" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Subscriber", + "properties": { + "Address": { + "type": { + "$ref": "#/7" + }, + "flags": 1 + }, + "Type": { + "type": { + "$ref": "#/7" + }, + "flags": 1 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/7" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/7" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/7" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/7" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/7" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Budgets/BudgetsActionProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Budgets/BudgetsActionProperties", + "properties": { + "ActionId": { + "type": { + "$ref": "#/7" + }, + "flags": 18 + }, + "ActionThreshold": { + "type": { + "$ref": "#/0" + }, + "flags": 1 + }, + "ActionType": { + "type": { + "$ref": "#/7" + }, + "flags": 1 + }, + "ApprovalModel": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "BudgetName": { + "type": { + "$ref": "#/7" + }, + "flags": 17 + }, + "Definition": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "ExecutionRoleArn": { + "type": { + "$ref": "#/7" + }, + "flags": 1 + }, + "NotificationType": { + "type": { + "$ref": "#/7" + }, + "flags": 1 + }, + "ResourceTags": { + "type": { + "$ref": "#/15" + }, + "flags": 0 + }, + "Subscribers": { + "type": { + "$ref": "#/16" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Budgets/BudgetsAction", + "properties": { + "name": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/7" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/17" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Budgets/BudgetsAction@default", + "scopeType": 0, + "body": { + "$ref": "#/18" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.budgets/default/types.md b/artifacts/bicep/aws/aws.budgets/default/types.md index a4832dbe..a5944a84 100644 --- a/artifacts/bicep/aws/aws.budgets/default/types.md +++ b/artifacts/bicep/aws/aws.budgets/default/types.md @@ -3,9 +3,14 @@ ## Resource AWS.Budgets/BudgetsAction@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Budgets/BudgetsActionProperties](#awsbudgetsbudgetsactionproperties) (Required): properties of the resource +* **properties**: [AWS.Budgets/BudgetsActionProperties](#awsbudgetsbudgetsactionproperties) (Required, Identifier): properties of the resource + +## ActionThreshold +### Properties +* **Type**: string (Required) +* **Value**: int (Required) ## AWS.Budgets/BudgetsActionProperties ### Properties @@ -17,13 +22,9 @@ * **Definition**: [Definition](#definition) (Required) * **ExecutionRoleArn**: string (Required) * **NotificationType**: string (Required) +* **ResourceTags**: [ResourceTag](#resourcetag)[] * **Subscribers**: [Subscriber](#subscriber)[] (Required) -## ActionThreshold -### Properties -* **Type**: string (Required) -* **Value**: int (Required) - ## Definition ### Properties * **IamActionDefinition**: [IamActionDefinition](#iamactiondefinition) @@ -37,6 +38,11 @@ * **Roles**: string[] * **Users**: string[] +## ResourceTag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + ## ScpActionDefinition ### Properties * **PolicyId**: string (Required) diff --git a/artifacts/bicep/aws/aws.cassandra/default/types.json b/artifacts/bicep/aws/aws.cassandra/default/types.json index 33bbc35c..00a55d14 100644 --- a/artifacts/bicep/aws/aws.cassandra/default/types.json +++ b/artifacts/bicep/aws/aws.cassandra/default/types.json @@ -1 +1,535 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"RegionList"}},{"2":{"Name":"ReplicationSpecification","Properties":{"RegionList":{"Type":12,"Flags":0},"ReplicationStrategy":{"Type":4,"Flags":0}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.Cassandra/KeyspaceProperties","Properties":{"KeyspaceName":{"Type":4,"Flags":16,"Description":"Name for Cassandra keyspace"},"ReplicationSpecification":{"Type":9,"Flags":0},"Tags":{"Type":14,"Flags":0}}}},{"3":{"ItemType":10}},{"2":{"Name":"AWS.Cassandra/Keyspace","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":13,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Cassandra/Keyspace@default","ScopeType":0,"Body":15}},{"2":{"Name":"BillingMode","Properties":{"Mode":{"Type":4,"Flags":1},"ProvisionedThroughput":{"Type":24,"Flags":0}}}},{"2":{"Name":"ClusteringKeyColumn","Properties":{"Column":{"Type":19,"Flags":1},"OrderBy":{"Type":4,"Flags":0}}}},{"2":{"Name":"Column","Properties":{"ColumnName":{"Type":4,"Flags":1},"ColumnType":{"Type":4,"Flags":1}}}},{"2":{"Name":"EncryptionSpecification","Properties":{"EncryptionType":{"Type":4,"Flags":1},"KmsKeyIdentifier":{"Type":4,"Flags":0}}}},{"2":{"Name":"EncryptionType"}},{"2":{"Name":"KmsKeyIdentifier"}},{"2":{"Name":"Mode"}},{"2":{"Name":"ProvisionedThroughput","Properties":{"ReadCapacityUnits":{"Type":3,"Flags":1},"WriteCapacityUnits":{"Type":3,"Flags":1}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.Cassandra/TableProperties","Properties":{"BillingMode":{"Type":17,"Flags":0},"ClientSideTimestampsEnabled":{"Type":2,"Flags":0,"Description":"Indicates whether client side timestamps are enabled (true) or disabled (false) on the table. False by default, once it is enabled it cannot be disabled again."},"ClusteringKeyColumns":{"Type":27,"Flags":0,"Description":"Clustering key columns of the table"},"DefaultTimeToLive":{"Type":3,"Flags":0,"Description":"Default TTL (Time To Live) in seconds, where zero is disabled. If the value is greater than zero, TTL is enabled for the entire table and an expiration timestamp is added to each column."},"EncryptionSpecification":{"Type":20,"Flags":0},"KeyspaceName":{"Type":4,"Flags":17,"Description":"Name for Cassandra keyspace"},"PartitionKeyColumns":{"Type":28,"Flags":1,"Description":"Partition key columns of the table"},"PointInTimeRecoveryEnabled":{"Type":2,"Flags":0,"Description":"Indicates whether point in time recovery is enabled (true) or disabled (false) on the table"},"RegularColumns":{"Type":29,"Flags":0,"Description":"Non-key columns of the table"},"TableName":{"Type":4,"Flags":16,"Description":"Name for Cassandra table"},"Tags":{"Type":30,"Flags":0,"Description":"An array of key-value pairs to apply to this resource"}}}},{"3":{"ItemType":18}},{"3":{"ItemType":19}},{"3":{"ItemType":19}},{"3":{"ItemType":25}},{"2":{"Name":"AWS.Cassandra/Table","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":26,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Cassandra/Table@default","ScopeType":0,"Body":31}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "RegionList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ReplicationSpecification", + "properties": { + "RegionList": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "ReplicationStrategy": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Cassandra/KeyspaceProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Cassandra/KeyspaceProperties", + "properties": { + "KeyspaceName": { + "type": { + "$ref": "#/3" + }, + "flags": 16, + "description": "Name for Cassandra keyspace" + }, + "ReplicationSpecification": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Cassandra/Keyspace", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/8" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Cassandra/Keyspace@default", + "scopeType": 0, + "body": { + "$ref": "#/9" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AutoScalingSetting", + "properties": { + "AutoScalingDisabled": { + "type": { + "$ref": "#/25" + }, + "flags": 0 + }, + "MaximumUnits": { + "type": { + "$ref": "#/26" + }, + "flags": 0 + }, + "MinimumUnits": { + "type": { + "$ref": "#/26" + }, + "flags": 0 + }, + "ScalingPolicy": { + "type": { + "$ref": "#/22" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AutoScalingSpecification", + "properties": { + "ReadCapacityAutoScaling": { + "type": { + "$ref": "#/11" + }, + "flags": 0 + }, + "WriteCapacityAutoScaling": { + "type": { + "$ref": "#/11" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BillingMode", + "properties": { + "Mode": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + }, + "ProvisionedThroughput": { + "type": { + "$ref": "#/20" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ClusteringKeyColumn", + "properties": { + "Column": { + "type": { + "$ref": "#/15" + }, + "flags": 1 + }, + "OrderBy": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Column", + "properties": { + "ColumnName": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + }, + "ColumnType": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "EncryptionSpecification", + "properties": { + "EncryptionType": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + }, + "KmsKeyIdentifier": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "EncryptionType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "KmsKeyIdentifier", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Mode", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ProvisionedThroughput", + "properties": { + "ReadCapacityUnits": { + "type": { + "$ref": "#/26" + }, + "flags": 1 + }, + "WriteCapacityUnits": { + "type": { + "$ref": "#/26" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ReplicaSpecification", + "properties": { + "ReadCapacityAutoScaling": { + "type": { + "$ref": "#/11" + }, + "flags": 0 + }, + "ReadCapacityUnits": { + "type": { + "$ref": "#/26" + }, + "flags": 0 + }, + "Region": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ScalingPolicy", + "properties": { + "TargetTrackingScalingPolicyConfiguration": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TargetTrackingScalingPolicyConfiguration", + "properties": { + "DisableScaleIn": { + "type": { + "$ref": "#/25" + }, + "flags": 0 + }, + "ScaleInCooldown": { + "type": { + "$ref": "#/26" + }, + "flags": 0 + }, + "ScaleOutCooldown": { + "type": { + "$ref": "#/26" + }, + "flags": 0 + }, + "TargetValue": { + "type": { + "$ref": "#/26" + }, + "flags": 1 + } + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "IntegerType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.Cassandra/TableProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/14" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/15" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/15" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/21" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/23" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Cassandra/TableProperties", + "properties": { + "AutoScalingSpecifications": { + "type": { + "$ref": "#/12" + }, + "flags": 4 + }, + "BillingMode": { + "type": { + "$ref": "#/13" + }, + "flags": 0 + }, + "ClientSideTimestampsEnabled": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "Indicates whether client side timestamps are enabled (true) or disabled (false) on the table. False by default, once it is enabled it cannot be disabled again." + }, + "ClusteringKeyColumns": { + "type": { + "$ref": "#/28" + }, + "flags": 0, + "description": "Clustering key columns of the table" + }, + "DefaultTimeToLive": { + "type": { + "$ref": "#/26" + }, + "flags": 0, + "description": "Default TTL (Time To Live) in seconds, where zero is disabled. If the value is greater than zero, TTL is enabled for the entire table and an expiration timestamp is added to each column." + }, + "EncryptionSpecification": { + "type": { + "$ref": "#/16" + }, + "flags": 0 + }, + "KeyspaceName": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "Name for Cassandra keyspace" + }, + "PartitionKeyColumns": { + "type": { + "$ref": "#/29" + }, + "flags": 1, + "description": "Partition key columns of the table" + }, + "PointInTimeRecoveryEnabled": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "Indicates whether point in time recovery is enabled (true) or disabled (false) on the table" + }, + "RegularColumns": { + "type": { + "$ref": "#/30" + }, + "flags": 0, + "description": "Non-key columns of the table" + }, + "ReplicaSpecifications": { + "type": { + "$ref": "#/31" + }, + "flags": 4 + }, + "TableName": { + "type": { + "$ref": "#/3" + }, + "flags": 16, + "description": "Name for Cassandra table" + }, + "Tags": { + "type": { + "$ref": "#/32" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Cassandra/Table", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/33" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Cassandra/Table@default", + "scopeType": 0, + "body": { + "$ref": "#/34" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.cassandra/default/types.md b/artifacts/bicep/aws/aws.cassandra/default/types.md index 36b97010..cb3d0d08 100644 --- a/artifacts/bicep/aws/aws.cassandra/default/types.md +++ b/artifacts/bicep/aws/aws.cassandra/default/types.md @@ -3,35 +3,38 @@ ## Resource AWS.Cassandra/Keyspace@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Cassandra/KeyspaceProperties](#awscassandrakeyspaceproperties): properties of the resource +* **properties**: [AWS.Cassandra/KeyspaceProperties](#awscassandrakeyspaceproperties) (Identifier): properties of the resource ## Resource AWS.Cassandra/Table@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Cassandra/TableProperties](#awscassandratableproperties) (Required): properties of the resource +* **properties**: [AWS.Cassandra/TableProperties](#awscassandratableproperties) (Required, Identifier): properties of the resource -## AWS.Cassandra/KeyspaceProperties +## AutoScalingSetting ### Properties -* **KeyspaceName**: string (Identifier): Name for Cassandra keyspace -* **ReplicationSpecification**: [ReplicationSpecification](#replicationspecification) -* **Tags**: [Tag](#tag)[] +* **AutoScalingDisabled**: bool +* **MaximumUnits**: int +* **MinimumUnits**: int +* **ScalingPolicy**: [ScalingPolicy](#scalingpolicy) -## ReplicationSpecification +## AutoScalingSpecification ### Properties -* **RegionList**: string[] -* **ReplicationStrategy**: string +* **ReadCapacityAutoScaling**: [AutoScalingSetting](#autoscalingsetting) +* **WriteCapacityAutoScaling**: [AutoScalingSetting](#autoscalingsetting) -## Tag +## AWS.Cassandra/KeyspaceProperties ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **KeyspaceName**: string (Identifier): Name for Cassandra keyspace +* **ReplicationSpecification**: [ReplicationSpecification](#replicationspecification) +* **Tags**: [Tag](#tag)[] ## AWS.Cassandra/TableProperties ### Properties +* **AutoScalingSpecifications**: [AutoScalingSpecification](#autoscalingspecification) (WriteOnly) * **BillingMode**: [BillingMode](#billingmode) * **ClientSideTimestampsEnabled**: bool: Indicates whether client side timestamps are enabled (true) or disabled (false) on the table. False by default, once it is enabled it cannot be disabled again. * **ClusteringKeyColumns**: [ClusteringKeyColumn](#clusteringkeycolumn)[]: Clustering key columns of the table @@ -41,6 +44,7 @@ * **PartitionKeyColumns**: [Column](#column)[] (Required): Partition key columns of the table * **PointInTimeRecoveryEnabled**: bool: Indicates whether point in time recovery is enabled (true) or disabled (false) on the table * **RegularColumns**: [Column](#column)[]: Non-key columns of the table +* **ReplicaSpecifications**: [ReplicaSpecification](#replicaspecification)[] (WriteOnly) * **TableName**: string (Identifier): Name for Cassandra table * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource @@ -49,11 +53,6 @@ * **Mode**: string (Required) * **ProvisionedThroughput**: [ProvisionedThroughput](#provisionedthroughput) -## ProvisionedThroughput -### Properties -* **ReadCapacityUnits**: int (Required) -* **WriteCapacityUnits**: int (Required) - ## ClusteringKeyColumn ### Properties * **Column**: [Column](#column) (Required) @@ -69,8 +68,40 @@ * **EncryptionType**: string (Required) * **KmsKeyIdentifier**: string +## ProvisionedThroughput +### Properties +* **ReadCapacityUnits**: int (Required) +* **WriteCapacityUnits**: int (Required) + +## ReplicaSpecification +### Properties +* **ReadCapacityAutoScaling**: [AutoScalingSetting](#autoscalingsetting) +* **ReadCapacityUnits**: int +* **Region**: string (Required) + +## ReplicationSpecification +### Properties +* **RegionList**: string[] +* **ReplicationStrategy**: string + +## ScalingPolicy +### Properties +* **TargetTrackingScalingPolicyConfiguration**: [TargetTrackingScalingPolicyConfiguration](#targettrackingscalingpolicyconfiguration) + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + ## Tag ### Properties * **Key**: string (Required) * **Value**: string (Required) +## TargetTrackingScalingPolicyConfiguration +### Properties +* **DisableScaleIn**: bool +* **ScaleInCooldown**: int +* **ScaleOutCooldown**: int +* **TargetValue**: int (Required) + diff --git a/artifacts/bicep/aws/aws.ce/default/types.json b/artifacts/bicep/aws/aws.ce/default/types.json index 01ef9a53..3fbb5051 100644 --- a/artifacts/bicep/aws/aws.ce/default/types.json +++ b/artifacts/bicep/aws/aws.ce/default/types.json @@ -1 +1,424 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"Arn"}},{"2":{"Name":"ResourceTag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name for the tag."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag."}}}},{"2":{"Name":"AWS.CE/AnomalyMonitorProperties","Properties":{"CreationDate":{"Type":4,"Flags":2,"Description":"The date when the monitor was created. "},"DimensionalValueCount":{"Type":3,"Flags":2,"Description":"The value for evaluated dimensions."},"LastEvaluatedDate":{"Type":4,"Flags":2,"Description":"The date when the monitor last evaluated for anomalies."},"LastUpdatedDate":{"Type":4,"Flags":2,"Description":"The date when the monitor was last updated."},"MonitorArn":{"Type":4,"Flags":18},"MonitorDimension":{"Type":4,"Flags":0,"Description":"The dimensions to evaluate"},"MonitorName":{"Type":4,"Flags":1,"Description":"The name of the monitor."},"MonitorSpecification":{"Type":4,"Flags":0},"MonitorType":{"Type":4,"Flags":1},"ResourceTags":{"Type":11,"Flags":4,"Description":"Tags to assign to monitor."}}}},{"3":{"ItemType":9}},{"2":{"Name":"AWS.CE/AnomalyMonitor","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":10,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.CE/AnomalyMonitor@default","ScopeType":0,"Body":12}},{"2":{"Name":"Arn"}},{"2":{"Name":"ResourceTag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name for the tag."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag."}}}},{"2":{"Name":"Subscriber","Properties":{"Address":{"Type":4,"Flags":1},"Status":{"Type":4,"Flags":0},"Type":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.CE/AnomalySubscriptionProperties","Properties":{"AccountId":{"Type":4,"Flags":2,"Description":"The accountId"},"Frequency":{"Type":4,"Flags":1,"Description":"The frequency at which anomaly reports are sent over email. "},"MonitorArnList":{"Type":18,"Flags":1,"Description":"A list of cost anomaly monitors."},"ResourceTags":{"Type":19,"Flags":4,"Description":"Tags to assign to subscription."},"Subscribers":{"Type":20,"Flags":3,"Description":"A list of subscriber"},"SubscriptionArn":{"Type":4,"Flags":18},"SubscriptionName":{"Type":4,"Flags":1,"Description":"The name of the subscription."},"Threshold":{"Type":3,"Flags":0,"Description":"The dollar value that triggers a notification if the threshold is exceeded. "},"ThresholdExpression":{"Type":4,"Flags":0,"Description":"An Expression object in JSON String format used to specify the anomalies that you want to generate alerts for."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":15}},{"3":{"ItemType":16}},{"2":{"Name":"AWS.CE/AnomalySubscription","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":17,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.CE/AnomalySubscription@default","ScopeType":0,"Body":21}},{"2":{"Name":"ZonedDateTime"}},{"2":{"Name":"AWS.CE/CostCategoryProperties","Properties":{"Arn":{"Type":4,"Flags":18,"Description":"Cost category ARN"},"DefaultValue":{"Type":4,"Flags":0,"Description":"The default value for the cost category"},"EffectiveStart":{"Type":4,"Flags":2},"Name":{"Type":4,"Flags":1},"RuleVersion":{"Type":4,"Flags":1},"Rules":{"Type":4,"Flags":1,"Description":"JSON array format of Expression in Billing and Cost Management API"},"SplitChargeRules":{"Type":4,"Flags":0,"Description":"Json array format of CostCategorySplitChargeRule in Billing and Cost Management API"}}}},{"2":{"Name":"AWS.CE/CostCategory","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":24,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.CE/CostCategory@default","ScopeType":0,"Body":25}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Arn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ResourceTag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The key name for the tag." + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The value for the tag." + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.CE/AnomalyMonitorProperties" + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "AWS.CE/AnomalyMonitorProperties", + "properties": { + "CreationDate": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The date when the monitor was created. " + }, + "DimensionalValueCount": { + "type": { + "$ref": "#/4" + }, + "flags": 2, + "description": "The value for evaluated dimensions." + }, + "LastEvaluatedDate": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The date when the monitor last evaluated for anomalies." + }, + "LastUpdatedDate": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The date when the monitor was last updated." + }, + "MonitorArn": { + "type": { + "$ref": "#/2" + }, + "flags": 18 + }, + "MonitorDimension": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The dimensions to evaluate" + }, + "MonitorName": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The name of the monitor." + }, + "MonitorSpecification": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "MonitorType": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "ResourceTags": { + "type": { + "$ref": "#/5" + }, + "flags": 4, + "description": "Tags to assign to monitor." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.CE/AnomalyMonitor", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/6" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.CE/AnomalyMonitor@default", + "scopeType": 0, + "body": { + "$ref": "#/7" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Arn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ResourceTag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The key name for the tag." + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The value for the tag." + } + } + }, + { + "$type": "ObjectType", + "name": "Subscriber", + "properties": { + "Address": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Status": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.CE/AnomalySubscriptionProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/10" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/11" + } + }, + { + "$type": "ObjectType", + "name": "AWS.CE/AnomalySubscriptionProperties", + "properties": { + "AccountId": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The accountId" + }, + "Frequency": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The frequency at which anomaly reports are sent over email. " + }, + "MonitorArnList": { + "type": { + "$ref": "#/13" + }, + "flags": 1, + "description": "A list of cost anomaly monitors." + }, + "ResourceTags": { + "type": { + "$ref": "#/14" + }, + "flags": 4, + "description": "Tags to assign to subscription." + }, + "Subscribers": { + "type": { + "$ref": "#/15" + }, + "flags": 3, + "description": "A list of subscriber" + }, + "SubscriptionArn": { + "type": { + "$ref": "#/2" + }, + "flags": 18 + }, + "SubscriptionName": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The name of the subscription." + }, + "Threshold": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The dollar value that triggers a notification if the threshold is exceeded. " + }, + "ThresholdExpression": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "An Expression object in JSON String format used to specify the anomalies that you want to generate alerts for." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.CE/AnomalySubscription", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/16" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.CE/AnomalySubscription@default", + "scopeType": 0, + "body": { + "$ref": "#/17" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "ZonedDateTime", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.CE/CostCategoryProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.CE/CostCategoryProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "Cost category ARN" + }, + "DefaultValue": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The default value for the cost category" + }, + "EffectiveStart": { + "type": { + "$ref": "#/2" + }, + "flags": 2 + }, + "Name": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "RuleVersion": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Rules": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "JSON array format of Expression in Billing and Cost Management API" + }, + "SplitChargeRules": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "Json array format of CostCategorySplitChargeRule in Billing and Cost Management API" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.CE/CostCategory", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/21" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.CE/CostCategory@default", + "scopeType": 0, + "body": { + "$ref": "#/22" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.ce/default/types.md b/artifacts/bicep/aws/aws.ce/default/types.md index 8e53219d..9aab3197 100644 --- a/artifacts/bicep/aws/aws.ce/default/types.md +++ b/artifacts/bicep/aws/aws.ce/default/types.md @@ -3,23 +3,23 @@ ## Resource AWS.CE/AnomalyMonitor@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.CE/AnomalyMonitorProperties](#awsceanomalymonitorproperties) (Required): properties of the resource +* **properties**: [AWS.CE/AnomalyMonitorProperties](#awsceanomalymonitorproperties) (Required, Identifier): properties of the resource ## Resource AWS.CE/AnomalySubscription@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.CE/AnomalySubscriptionProperties](#awsceanomalysubscriptionproperties) (Required): properties of the resource +* **properties**: [AWS.CE/AnomalySubscriptionProperties](#awsceanomalysubscriptionproperties) (Required, Identifier): properties of the resource ## Resource AWS.CE/CostCategory@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.CE/CostCategoryProperties](#awscecostcategoryproperties) (Required): properties of the resource +* **properties**: [AWS.CE/CostCategoryProperties](#awscecostcategoryproperties) (Required, Identifier): properties of the resource ## AWS.CE/AnomalyMonitorProperties ### Properties @@ -34,11 +34,6 @@ * **MonitorType**: string (Required) * **ResourceTags**: [ResourceTag](#resourcetag)[] (WriteOnly): Tags to assign to monitor. -## ResourceTag -### Properties -* **Key**: string (Required): The key name for the tag. -* **Value**: string (Required): The value for the tag. - ## AWS.CE/AnomalySubscriptionProperties ### Properties * **AccountId**: string (ReadOnly): The accountId @@ -51,6 +46,21 @@ * **Threshold**: int: The dollar value that triggers a notification if the threshold is exceeded. * **ThresholdExpression**: string: An Expression object in JSON String format used to specify the anomalies that you want to generate alerts for. +## AWS.CE/CostCategoryProperties +### Properties +* **Arn**: string (ReadOnly, Identifier): Cost category ARN +* **DefaultValue**: string: The default value for the cost category +* **EffectiveStart**: string (ReadOnly) +* **Name**: string (Required) +* **Rules**: string (Required): JSON array format of Expression in Billing and Cost Management API +* **RuleVersion**: string (Required) +* **SplitChargeRules**: string: Json array format of CostCategorySplitChargeRule in Billing and Cost Management API + +## ResourceTag +### Properties +* **Key**: string (Required): The key name for the tag. +* **Value**: string (Required): The value for the tag. + ## ResourceTag ### Properties * **Key**: string (Required): The key name for the tag. @@ -62,13 +72,3 @@ * **Status**: string * **Type**: string (Required) -## AWS.CE/CostCategoryProperties -### Properties -* **Arn**: string (ReadOnly, Identifier): Cost category ARN -* **DefaultValue**: string: The default value for the cost category -* **EffectiveStart**: string (ReadOnly) -* **Name**: string (Required) -* **Rules**: string (Required): JSON array format of Expression in Billing and Cost Management API -* **RuleVersion**: string (Required) -* **SplitChargeRules**: string: Json array format of CostCategorySplitChargeRule in Billing and Cost Management API - diff --git a/artifacts/bicep/aws/aws.certificatemanager/default/types.json b/artifacts/bicep/aws/aws.certificatemanager/default/types.json index 952eeb63..844e8dc2 100644 --- a/artifacts/bicep/aws/aws.certificatemanager/default/types.json +++ b/artifacts/bicep/aws/aws.certificatemanager/default/types.json @@ -1 +1,83 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"AccountId"}},{"2":{"Name":"ExpiryEventsConfiguration","Properties":{"DaysBeforeExpiry":{"Type":3,"Flags":0}}}},{"2":{"Name":"AWS.CertificateManager/AccountProperties","Properties":{"AccountId":{"Type":4,"Flags":18},"ExpiryEventsConfiguration":{"Type":9,"Flags":1}}}},{"2":{"Name":"AWS.CertificateManager/Account","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":10,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.CertificateManager/Account@default","ScopeType":0,"Body":11}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "AccountId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ExpiryEventsConfiguration", + "properties": { + "DaysBeforeExpiry": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "IntegerType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.CertificateManager/AccountProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.CertificateManager/AccountProperties", + "properties": { + "AccountId": { + "type": { + "$ref": "#/2" + }, + "flags": 18 + }, + "ExpiryEventsConfiguration": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.CertificateManager/Account", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.CertificateManager/Account@default", + "scopeType": 0, + "body": { + "$ref": "#/6" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.certificatemanager/default/types.md b/artifacts/bicep/aws/aws.certificatemanager/default/types.md index c20c510a..01a02802 100644 --- a/artifacts/bicep/aws/aws.certificatemanager/default/types.md +++ b/artifacts/bicep/aws/aws.certificatemanager/default/types.md @@ -3,9 +3,9 @@ ## Resource AWS.CertificateManager/Account@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.CertificateManager/AccountProperties](#awscertificatemanageraccountproperties) (Required): properties of the resource +* **properties**: [AWS.CertificateManager/AccountProperties](#awscertificatemanageraccountproperties) (Required, Identifier): properties of the resource ## AWS.CertificateManager/AccountProperties ### Properties diff --git a/artifacts/bicep/aws/aws.chatbot/default/types.json b/artifacts/bicep/aws/aws.chatbot/default/types.json index 6902b000..0a9f1c7c 100644 --- a/artifacts/bicep/aws/aws.chatbot/default/types.json +++ b/artifacts/bicep/aws/aws.chatbot/default/types.json @@ -1 +1,319 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"AWS.Chatbot/MicrosoftTeamsChannelConfigurationProperties","Properties":{"Arn":{"Type":4,"Flags":18,"Description":"Amazon Resource Name (ARN) of the configuration"},"ConfigurationName":{"Type":4,"Flags":1,"Description":"The name of the configuration"},"GuardrailPolicies":{"Type":9,"Flags":0,"Description":"The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied as a default if this is not set."},"IamRoleArn":{"Type":4,"Flags":1,"Description":"The ARN of the IAM role that defines the permissions for AWS Chatbot"},"LoggingLevel":{"Type":4,"Flags":0,"Description":"Specifies the logging level for this configuration:ERROR,INFO or NONE. This property affects the log entries pushed to Amazon CloudWatch logs"},"SnsTopicArns":{"Type":10,"Flags":0,"Description":"ARNs of SNS topics which delivers notifications to AWS Chatbot, for example CloudWatch alarm notifications."},"TeamId":{"Type":4,"Flags":1,"Description":"The id of the Microsoft Teams team"},"TeamsChannelId":{"Type":4,"Flags":1,"Description":"The id of the Microsoft Teams channel"},"TeamsTenantId":{"Type":4,"Flags":1,"Description":"The id of the Microsoft Teams tenant"},"UserRoleRequired":{"Type":2,"Flags":0,"Description":"Enables use of a user role requirement in your chat configuration"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.Chatbot/MicrosoftTeamsChannelConfiguration","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":8,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Chatbot/MicrosoftTeamsChannelConfiguration@default","ScopeType":0,"Body":11}},{"2":{"Name":"AWS.Chatbot/SlackChannelConfigurationProperties","Properties":{"Arn":{"Type":4,"Flags":18,"Description":"Amazon Resource Name (ARN) of the configuration"},"ConfigurationName":{"Type":4,"Flags":1,"Description":"The name of the configuration"},"GuardrailPolicies":{"Type":14,"Flags":0,"Description":"The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied as a default if this is not set."},"IamRoleArn":{"Type":4,"Flags":1,"Description":"The ARN of the IAM role that defines the permissions for AWS Chatbot"},"LoggingLevel":{"Type":4,"Flags":0,"Description":"Specifies the logging level for this configuration:ERROR,INFO or NONE. This property affects the log entries pushed to Amazon CloudWatch logs"},"SlackChannelId":{"Type":4,"Flags":1,"Description":"The id of the Slack channel"},"SlackWorkspaceId":{"Type":4,"Flags":1,"Description":"The id of the Slack workspace"},"SnsTopicArns":{"Type":15,"Flags":0,"Description":"ARNs of SNS topics which delivers notifications to AWS Chatbot, for example CloudWatch alarm notifications."},"UserRoleRequired":{"Type":2,"Flags":0,"Description":"Enables use of a user role requirement in your chat configuration"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.Chatbot/SlackChannelConfiguration","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":13,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Chatbot/SlackChannelConfiguration@default","ScopeType":0,"Body":16}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.Chatbot/MicrosoftTeamsChannelConfigurationProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "ObjectType", + "name": "AWS.Chatbot/MicrosoftTeamsChannelConfigurationProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "Amazon Resource Name (ARN) of the configuration" + }, + "ConfigurationName": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The name of the configuration" + }, + "GuardrailPolicies": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied as a default if this is not set." + }, + "IamRoleArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The ARN of the IAM role that defines the permissions for AWS Chatbot" + }, + "LoggingLevel": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Specifies the logging level for this configuration:ERROR,INFO or NONE. This property affects the log entries pushed to Amazon CloudWatch logs" + }, + "SnsTopicArns": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "ARNs of SNS topics which delivers notifications to AWS Chatbot, for example CloudWatch alarm notifications." + }, + "Tags": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The tags to add to the configuration" + }, + "TeamId": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The id of the Microsoft Teams team" + }, + "TeamsChannelId": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The id of the Microsoft Teams channel" + }, + "TeamsTenantId": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The id of the Microsoft Teams tenant" + }, + "UserRoleRequired": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Enables use of a user role requirement in your chat configuration" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Chatbot/MicrosoftTeamsChannelConfiguration", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/7" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Chatbot/MicrosoftTeamsChannelConfiguration@default", + "scopeType": 0, + "body": { + "$ref": "#/8" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Chatbot/SlackChannelConfigurationProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/10" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Chatbot/SlackChannelConfigurationProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "Amazon Resource Name (ARN) of the configuration" + }, + "ConfigurationName": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The name of the configuration" + }, + "GuardrailPolicies": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied as a default if this is not set." + }, + "IamRoleArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The ARN of the IAM role that defines the permissions for AWS Chatbot" + }, + "LoggingLevel": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Specifies the logging level for this configuration:ERROR,INFO or NONE. This property affects the log entries pushed to Amazon CloudWatch logs" + }, + "SlackChannelId": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The id of the Slack channel" + }, + "SlackWorkspaceId": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The id of the Slack workspace" + }, + "SnsTopicArns": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "ARNs of SNS topics which delivers notifications to AWS Chatbot, for example CloudWatch alarm notifications." + }, + "Tags": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The tags to add to the configuration" + }, + "UserRoleRequired": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Enables use of a user role requirement in your chat configuration" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Chatbot/SlackChannelConfiguration", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/15" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Chatbot/SlackChannelConfiguration@default", + "scopeType": 0, + "body": { + "$ref": "#/16" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.chatbot/default/types.md b/artifacts/bicep/aws/aws.chatbot/default/types.md index 2981fff3..8f83237d 100644 --- a/artifacts/bicep/aws/aws.chatbot/default/types.md +++ b/artifacts/bicep/aws/aws.chatbot/default/types.md @@ -3,16 +3,16 @@ ## Resource AWS.Chatbot/MicrosoftTeamsChannelConfiguration@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Chatbot/MicrosoftTeamsChannelConfigurationProperties](#awschatbotmicrosoftteamschannelconfigurationproperties) (Required): properties of the resource +* **properties**: [AWS.Chatbot/MicrosoftTeamsChannelConfigurationProperties](#awschatbotmicrosoftteamschannelconfigurationproperties) (Required, Identifier): properties of the resource ## Resource AWS.Chatbot/SlackChannelConfiguration@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Chatbot/SlackChannelConfigurationProperties](#awschatbotslackchannelconfigurationproperties) (Required): properties of the resource +* **properties**: [AWS.Chatbot/SlackChannelConfigurationProperties](#awschatbotslackchannelconfigurationproperties) (Required, Identifier): properties of the resource ## AWS.Chatbot/MicrosoftTeamsChannelConfigurationProperties ### Properties @@ -22,6 +22,7 @@ * **IamRoleArn**: string (Required): The ARN of the IAM role that defines the permissions for AWS Chatbot * **LoggingLevel**: string: Specifies the logging level for this configuration:ERROR,INFO or NONE. This property affects the log entries pushed to Amazon CloudWatch logs * **SnsTopicArns**: string[]: ARNs of SNS topics which delivers notifications to AWS Chatbot, for example CloudWatch alarm notifications. +* **Tags**: [Tag](#tag)[]: The tags to add to the configuration * **TeamId**: string (Required): The id of the Microsoft Teams team * **TeamsChannelId**: string (Required): The id of the Microsoft Teams channel * **TeamsTenantId**: string (Required): The id of the Microsoft Teams tenant @@ -37,5 +38,16 @@ * **SlackChannelId**: string (Required): The id of the Slack channel * **SlackWorkspaceId**: string (Required): The id of the Slack workspace * **SnsTopicArns**: string[]: ARNs of SNS topics which delivers notifications to AWS Chatbot, for example CloudWatch alarm notifications. +* **Tags**: [Tag](#tag)[]: The tags to add to the configuration * **UserRoleRequired**: bool: Enables use of a user role requirement in your chat configuration +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + diff --git a/artifacts/bicep/aws/aws.cleanrooms/default/types.json b/artifacts/bicep/aws/aws.cleanrooms/default/types.json index 8325c484..6fa0f29a 100644 --- a/artifacts/bicep/aws/aws.cleanrooms/default/types.json +++ b/artifacts/bicep/aws/aws.cleanrooms/default/types.json @@ -1 +1,1512 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"AnalysisParameter","Properties":{"DefaultValue":{"Type":4,"Flags":0},"Name":{"Type":4,"Flags":1},"Type":{"Type":4,"Flags":1}}}},{"2":{"Name":"AnalysisSchema","Properties":{"ReferencedTables":{"Type":14,"Flags":1}}}},{"2":{"Name":"AnalysisSource","Properties":{"Text":{"Type":4,"Flags":1}}}},{"2":{"Name":"ReferencedTables"}},{"2":{"Name":"TableName"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.CleanRooms/AnalysisTemplateProperties","Properties":{"AnalysisParameters":{"Type":17,"Flags":0,"Description":"The member who can query can provide this placeholder for a literal data value in an analysis template"},"AnalysisTemplateIdentifier":{"Type":4,"Flags":18},"Arn":{"Type":4,"Flags":2},"CollaborationArn":{"Type":4,"Flags":2},"CollaborationIdentifier":{"Type":4,"Flags":2},"Description":{"Type":4,"Flags":0},"Format":{"Type":4,"Flags":1},"MembershipArn":{"Type":4,"Flags":2},"MembershipIdentifier":{"Type":4,"Flags":17},"Name":{"Type":4,"Flags":1},"Schema":{"Type":9,"Flags":2},"Source":{"Type":10,"Flags":1},"Tags":{"Type":18,"Flags":0,"Description":"An arbitrary set of tags (key-value pairs) for this cleanrooms analysis template."}}}},{"3":{"ItemType":8}},{"3":{"ItemType":13}},{"2":{"Name":"AWS.CleanRooms/AnalysisTemplate","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":16,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.CleanRooms/AnalysisTemplate@default","ScopeType":0,"Body":19}},{"2":{"Name":"CollaborationQueryLogStatus"}},{"2":{"Name":"DataEncryptionMetadata","Properties":{"AllowCleartext":{"Type":2,"Flags":1},"AllowDuplicates":{"Type":2,"Flags":1},"AllowJoinsOnColumnsWithDifferentNames":{"Type":2,"Flags":1},"PreserveNulls":{"Type":2,"Flags":1}}}},{"2":{"Name":"MemberAbilities"}},{"2":{"Name":"MemberAbility"}},{"2":{"Name":"MemberSpecification","Properties":{"AccountId":{"Type":4,"Flags":1},"DisplayName":{"Type":4,"Flags":1},"MemberAbilities":{"Type":32,"Flags":1},"PaymentConfiguration":{"Type":28,"Flags":0}}}},{"2":{"Name":"MemberStatus"}},{"2":{"Name":"Name"}},{"2":{"Name":"PaymentConfiguration","Properties":{"QueryCompute":{"Type":29,"Flags":1}}}},{"2":{"Name":"QueryComputePaymentConfig","Properties":{"IsResponsible":{"Type":2,"Flags":1}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.CleanRooms/CollaborationProperties","Properties":{"Arn":{"Type":4,"Flags":2},"CollaborationIdentifier":{"Type":4,"Flags":18},"CreatorDisplayName":{"Type":4,"Flags":1},"CreatorMemberAbilities":{"Type":34,"Flags":1},"CreatorPaymentConfiguration":{"Type":28,"Flags":0},"DataEncryptionMetadata":{"Type":22,"Flags":0},"Description":{"Type":4,"Flags":1},"Members":{"Type":35,"Flags":1},"Name":{"Type":4,"Flags":1},"QueryLogStatus":{"Type":4,"Flags":1},"Tags":{"Type":36,"Flags":0,"Description":"An arbitrary set of tags (key-value pairs) for this cleanrooms collaboration."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":25}},{"3":{"ItemType":30}},{"2":{"Name":"AWS.CleanRooms/Collaboration","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":33,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.CleanRooms/Collaboration@default","ScopeType":0,"Body":37}},{"2":{"Name":"AggregateColumn","Properties":{"ColumnNames":{"Type":62,"Flags":1},"Function":{"Type":4,"Flags":1}}}},{"2":{"Name":"AggregateFunctionName"}},{"2":{"Name":"AggregationConstraint","Properties":{"ColumnName":{"Type":4,"Flags":1},"Minimum":{"Type":3,"Flags":1},"Type":{"Type":4,"Flags":1}}}},{"2":{"Name":"AggregationType"}},{"2":{"Name":"AllowedAnalyses"}},{"2":{"Name":"AllowedAnalysis"}},{"2":{"Name":"AllowedAnalysisProvider"}},{"2":{"Name":"AllowedAnalysisProviders"}},{"2":{"Name":"AnalysisMethod"}},{"2":{"Name":"AnalysisRule","Properties":{"Policy":{"Type":53,"Flags":1},"Type":{"Type":4,"Flags":1}}}},{"2":{"Name":"AnalysisRuleAggregation","Properties":{"AggregateColumns":{"Type":65,"Flags":1},"AllowedJoinOperators":{"Type":66,"Flags":0},"DimensionColumns":{"Type":67,"Flags":1},"JoinColumns":{"Type":68,"Flags":1},"JoinRequired":{"Type":4,"Flags":0},"OutputConstraints":{"Type":69,"Flags":1},"ScalarFunctions":{"Type":70,"Flags":1}}}},{"2":{"Name":"AnalysisRuleColumnName"}},{"2":{"Name":"AnalysisRuleCustom","Properties":{"AllowedAnalyses":{"Type":71,"Flags":1},"AllowedAnalysisProviders":{"Type":72,"Flags":0}}}},{"2":{"Name":"AnalysisRuleList","Properties":{"AllowedJoinOperators":{"Type":73,"Flags":0},"JoinColumns":{"Type":74,"Flags":1},"ListColumns":{"Type":75,"Flags":1}}}},{"2":{"Name":"ConfiguredTableAnalysisRulePolicy","Properties":{"V1":{"Type":76,"Flags":1}}}},{"2":{"Name":"ConfiguredTableAnalysisRulePolicyV1","Properties":{}}},{"2":{"Name":"ConfiguredTableAnalysisRuleType"}},{"2":{"Name":"GlueTableReference","Properties":{"DatabaseName":{"Type":4,"Flags":1},"TableName":{"Type":4,"Flags":1}}}},{"2":{"Name":"JoinOperator"}},{"2":{"Name":"JoinRequiredOption"}},{"2":{"Name":"ScalarFunctions"}},{"2":{"Name":"TableReference","Properties":{"Glue":{"Type":56,"Flags":1}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":39}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":41}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"ConfiguredTable_ConfiguredTableAnalysisRulePolicyV1","Properties":{}}},{"2":{"Name":"AWS.CleanRooms/ConfiguredTableProperties","Properties":{"AllowedColumns":{"Type":78,"Flags":1},"AnalysisMethod":{"Type":4,"Flags":1},"AnalysisRules":{"Type":79,"Flags":0},"Arn":{"Type":4,"Flags":2},"ConfiguredTableIdentifier":{"Type":4,"Flags":18},"Description":{"Type":4,"Flags":0},"Name":{"Type":4,"Flags":1},"TableReference":{"Type":60,"Flags":1},"Tags":{"Type":80,"Flags":0,"Description":"An arbitrary set of tags (key-value pairs) for this cleanrooms collaboration."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":48}},{"3":{"ItemType":61}},{"2":{"Name":"AWS.CleanRooms/ConfiguredTable","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":77,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.CleanRooms/ConfiguredTable@default","ScopeType":0,"Body":81}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.CleanRooms/ConfiguredTableAssociationProperties","Properties":{"Arn":{"Type":4,"Flags":2},"ConfiguredTableAssociationIdentifier":{"Type":4,"Flags":18},"ConfiguredTableIdentifier":{"Type":4,"Flags":1},"Description":{"Type":4,"Flags":0},"MembershipIdentifier":{"Type":4,"Flags":17},"Name":{"Type":4,"Flags":1},"RoleArn":{"Type":4,"Flags":1},"Tags":{"Type":85,"Flags":0,"Description":"An arbitrary set of tags (key-value pairs) for this cleanrooms collaboration."}}}},{"3":{"ItemType":83}},{"2":{"Name":"AWS.CleanRooms/ConfiguredTableAssociation","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":84,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.CleanRooms/ConfiguredTableAssociation@default","ScopeType":0,"Body":86}},{"2":{"Name":"MembershipPaymentConfiguration","Properties":{"QueryCompute":{"Type":91,"Flags":1}}}},{"2":{"Name":"MembershipProtectedQueryOutputConfiguration","Properties":{"S3":{"Type":94,"Flags":1}}}},{"2":{"Name":"MembershipProtectedQueryResultConfiguration","Properties":{"OutputConfiguration":{"Type":89,"Flags":1},"RoleArn":{"Type":4,"Flags":0}}}},{"2":{"Name":"MembershipQueryComputePaymentConfig","Properties":{"IsResponsible":{"Type":2,"Flags":1}}}},{"2":{"Name":"MembershipQueryLogStatus"}},{"2":{"Name":"MembershipStatus"}},{"2":{"Name":"ProtectedQueryS3OutputConfiguration","Properties":{"Bucket":{"Type":4,"Flags":1},"KeyPrefix":{"Type":4,"Flags":0},"ResultFormat":{"Type":4,"Flags":1}}}},{"2":{"Name":"ResultFormat"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.CleanRooms/MembershipProperties","Properties":{"Arn":{"Type":4,"Flags":2},"CollaborationArn":{"Type":4,"Flags":2},"CollaborationCreatorAccountId":{"Type":4,"Flags":2},"CollaborationIdentifier":{"Type":4,"Flags":1},"DefaultResultConfiguration":{"Type":90,"Flags":0},"MembershipIdentifier":{"Type":4,"Flags":18},"PaymentConfiguration":{"Type":88,"Flags":0},"QueryLogStatus":{"Type":4,"Flags":1},"Tags":{"Type":98,"Flags":0,"Description":"An arbitrary set of tags (key-value pairs) for this cleanrooms membership."}}}},{"3":{"ItemType":96}},{"2":{"Name":"AWS.CleanRooms/Membership","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":97,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.CleanRooms/Membership@default","ScopeType":0,"Body":99}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "AnalysisParameter", + "properties": { + "DefaultValue": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "Type": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AnalysisSchema", + "properties": { + "ReferencedTables": { + "type": { + "$ref": "#/7" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AnalysisSource", + "properties": { + "Text": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ReferencedTables", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TableName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.CleanRooms/AnalysisTemplateProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ObjectType", + "name": "AWS.CleanRooms/AnalysisTemplateProperties", + "properties": { + "AnalysisParameters": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The member who can query can provide this placeholder for a literal data value in an analysis template" + }, + "AnalysisTemplateIdentifier": { + "type": { + "$ref": "#/6" + }, + "flags": 18 + }, + "Arn": { + "type": { + "$ref": "#/6" + }, + "flags": 2 + }, + "CollaborationArn": { + "type": { + "$ref": "#/6" + }, + "flags": 2 + }, + "CollaborationIdentifier": { + "type": { + "$ref": "#/6" + }, + "flags": 2 + }, + "Description": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "Format": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "MembershipArn": { + "type": { + "$ref": "#/6" + }, + "flags": 2 + }, + "MembershipIdentifier": { + "type": { + "$ref": "#/6" + }, + "flags": 17 + }, + "Name": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "Schema": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "Source": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "An arbitrary set of tags (key-value pairs) for this cleanrooms analysis template." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.CleanRooms/AnalysisTemplate", + "properties": { + "name": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/6" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/12" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.CleanRooms/AnalysisTemplate@default", + "scopeType": 0, + "body": { + "$ref": "#/13" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "CollaborationQueryLogStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DataEncryptionMetadata", + "properties": { + "AllowCleartext": { + "type": { + "$ref": "#/25" + }, + "flags": 1 + }, + "AllowDuplicates": { + "type": { + "$ref": "#/25" + }, + "flags": 1 + }, + "AllowJoinsOnColumnsWithDifferentNames": { + "type": { + "$ref": "#/25" + }, + "flags": 1 + }, + "PreserveNulls": { + "type": { + "$ref": "#/25" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "MemberAbilities", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MemberAbility", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MemberSpecification", + "properties": { + "AccountId": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "DisplayName": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "MemberAbilities": { + "type": { + "$ref": "#/27" + }, + "flags": 1 + }, + "PaymentConfiguration": { + "type": { + "$ref": "#/22" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "MemberStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Name", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PaymentConfiguration", + "properties": { + "QueryCompute": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "QueryComputePaymentConfig", + "properties": { + "IsResponsible": { + "type": { + "$ref": "#/25" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + } + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.CleanRooms/CollaborationProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/19" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/24" + } + }, + { + "$type": "ObjectType", + "name": "AWS.CleanRooms/CollaborationProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/6" + }, + "flags": 2 + }, + "CollaborationIdentifier": { + "type": { + "$ref": "#/6" + }, + "flags": 18 + }, + "CreatorDisplayName": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "CreatorMemberAbilities": { + "type": { + "$ref": "#/29" + }, + "flags": 1 + }, + "CreatorPaymentConfiguration": { + "type": { + "$ref": "#/22" + }, + "flags": 0 + }, + "DataEncryptionMetadata": { + "type": { + "$ref": "#/16" + }, + "flags": 0 + }, + "Description": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "Members": { + "type": { + "$ref": "#/30" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "QueryLogStatus": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/31" + }, + "flags": 0, + "description": "An arbitrary set of tags (key-value pairs) for this cleanrooms collaboration." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.CleanRooms/Collaboration", + "properties": { + "name": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/6" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/32" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.CleanRooms/Collaboration@default", + "scopeType": 0, + "body": { + "$ref": "#/33" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AggregateColumn", + "properties": { + "ColumnNames": { + "type": { + "$ref": "#/60" + }, + "flags": 1 + }, + "Function": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AggregateFunctionName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AggregationConstraint", + "properties": { + "ColumnName": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "Minimum": { + "type": { + "$ref": "#/61" + }, + "flags": 1 + }, + "Type": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AggregationType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AllowedAnalyses", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AllowedAnalysis", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AllowedAnalysisProvider", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AllowedAnalysisProviders", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AnalysisMethod", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AnalysisRule", + "properties": { + "Policy": { + "type": { + "$ref": "#/49" + }, + "flags": 1 + }, + "Type": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AnalysisRuleAggregation", + "properties": { + "AggregateColumns": { + "type": { + "$ref": "#/64" + }, + "flags": 1 + }, + "AllowedJoinOperators": { + "type": { + "$ref": "#/65" + }, + "flags": 0 + }, + "DimensionColumns": { + "type": { + "$ref": "#/66" + }, + "flags": 1 + }, + "JoinColumns": { + "type": { + "$ref": "#/67" + }, + "flags": 1 + }, + "JoinRequired": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "OutputConstraints": { + "type": { + "$ref": "#/68" + }, + "flags": 1 + }, + "ScalarFunctions": { + "type": { + "$ref": "#/69" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AnalysisRuleColumnName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AnalysisRuleCustom", + "properties": { + "AllowedAnalyses": { + "type": { + "$ref": "#/70" + }, + "flags": 1 + }, + "AllowedAnalysisProviders": { + "type": { + "$ref": "#/71" + }, + "flags": 0 + }, + "DifferentialPrivacy": { + "type": { + "$ref": "#/52" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AnalysisRuleList", + "properties": { + "AllowedJoinOperators": { + "type": { + "$ref": "#/72" + }, + "flags": 0 + }, + "JoinColumns": { + "type": { + "$ref": "#/73" + }, + "flags": 1 + }, + "ListColumns": { + "type": { + "$ref": "#/74" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ConfiguredTableAnalysisRulePolicy", + "properties": { + "V1": { + "type": { + "$ref": "#/75" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ConfiguredTableAnalysisRulePolicyV1", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ConfiguredTableAnalysisRuleType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DifferentialPrivacy", + "properties": { + "Columns": { + "type": { + "$ref": "#/76" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DifferentialPrivacyColumn", + "properties": { + "Name": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "GlueTableReference", + "properties": { + "DatabaseName": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "TableName": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "JoinOperator", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "JoinRequiredOption", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ScalarFunctions", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TableReference", + "properties": { + "Glue": { + "type": { + "$ref": "#/54" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/35" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/37" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ObjectType", + "name": "ConfiguredTable_ConfiguredTableAnalysisRulePolicyV1", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/53" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.CleanRooms/ConfiguredTableProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/44" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/59" + } + }, + { + "$type": "ObjectType", + "name": "AWS.CleanRooms/ConfiguredTableProperties", + "properties": { + "AllowedColumns": { + "type": { + "$ref": "#/78" + }, + "flags": 1 + }, + "AnalysisMethod": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "AnalysisRules": { + "type": { + "$ref": "#/79" + }, + "flags": 0 + }, + "Arn": { + "type": { + "$ref": "#/6" + }, + "flags": 2 + }, + "ConfiguredTableIdentifier": { + "type": { + "$ref": "#/6" + }, + "flags": 18 + }, + "Description": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "TableReference": { + "type": { + "$ref": "#/58" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/80" + }, + "flags": 0, + "description": "An arbitrary set of tags (key-value pairs) for this cleanrooms collaboration." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.CleanRooms/ConfiguredTable", + "properties": { + "name": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/6" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/81" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.CleanRooms/ConfiguredTable@default", + "scopeType": 0, + "body": { + "$ref": "#/82" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.CleanRooms/ConfiguredTableAssociationProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/84" + } + }, + { + "$type": "ObjectType", + "name": "AWS.CleanRooms/ConfiguredTableAssociationProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/6" + }, + "flags": 2 + }, + "ConfiguredTableAssociationIdentifier": { + "type": { + "$ref": "#/6" + }, + "flags": 18 + }, + "ConfiguredTableIdentifier": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "Description": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "MembershipIdentifier": { + "type": { + "$ref": "#/6" + }, + "flags": 17 + }, + "Name": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "RoleArn": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/86" + }, + "flags": 0, + "description": "An arbitrary set of tags (key-value pairs) for this cleanrooms collaboration." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.CleanRooms/ConfiguredTableAssociation", + "properties": { + "name": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/6" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/87" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.CleanRooms/ConfiguredTableAssociation@default", + "scopeType": 0, + "body": { + "$ref": "#/88" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "MembershipPaymentConfiguration", + "properties": { + "QueryCompute": { + "type": { + "$ref": "#/93" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "MembershipProtectedQueryOutputConfiguration", + "properties": { + "S3": { + "type": { + "$ref": "#/96" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "MembershipProtectedQueryResultConfiguration", + "properties": { + "OutputConfiguration": { + "type": { + "$ref": "#/91" + }, + "flags": 1 + }, + "RoleArn": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "MembershipQueryComputePaymentConfig", + "properties": { + "IsResponsible": { + "type": { + "$ref": "#/25" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "MembershipQueryLogStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MembershipStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ProtectedQueryS3OutputConfiguration", + "properties": { + "Bucket": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "KeyPrefix": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "ResultFormat": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ResultFormat", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.CleanRooms/MembershipProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/98" + } + }, + { + "$type": "ObjectType", + "name": "AWS.CleanRooms/MembershipProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/6" + }, + "flags": 2 + }, + "CollaborationArn": { + "type": { + "$ref": "#/6" + }, + "flags": 2 + }, + "CollaborationCreatorAccountId": { + "type": { + "$ref": "#/6" + }, + "flags": 2 + }, + "CollaborationIdentifier": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "DefaultResultConfiguration": { + "type": { + "$ref": "#/92" + }, + "flags": 0 + }, + "MembershipIdentifier": { + "type": { + "$ref": "#/6" + }, + "flags": 18 + }, + "PaymentConfiguration": { + "type": { + "$ref": "#/90" + }, + "flags": 0 + }, + "QueryLogStatus": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/100" + }, + "flags": 0, + "description": "An arbitrary set of tags (key-value pairs) for this cleanrooms membership." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.CleanRooms/Membership", + "properties": { + "name": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/6" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/101" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.CleanRooms/Membership@default", + "scopeType": 0, + "body": { + "$ref": "#/102" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.CleanRooms/PrivacyBudgetTemplateProperties" + }, + { + "$type": "ObjectType", + "name": "PrivacyBudgetTemplate_Parameters", + "properties": { + "Epsilon": { + "type": { + "$ref": "#/61" + }, + "flags": 1 + }, + "UsersNoisePerQuery": { + "type": { + "$ref": "#/61" + }, + "flags": 1 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/104" + } + }, + { + "$type": "ObjectType", + "name": "AWS.CleanRooms/PrivacyBudgetTemplateProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/6" + }, + "flags": 2 + }, + "AutoRefresh": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "CollaborationArn": { + "type": { + "$ref": "#/6" + }, + "flags": 2 + }, + "CollaborationIdentifier": { + "type": { + "$ref": "#/6" + }, + "flags": 2 + }, + "MembershipArn": { + "type": { + "$ref": "#/6" + }, + "flags": 2 + }, + "MembershipIdentifier": { + "type": { + "$ref": "#/6" + }, + "flags": 17 + }, + "Parameters": { + "type": { + "$ref": "#/106" + }, + "flags": 1 + }, + "PrivacyBudgetTemplateIdentifier": { + "type": { + "$ref": "#/6" + }, + "flags": 18 + }, + "PrivacyBudgetType": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/107" + }, + "flags": 0, + "description": "An arbitrary set of tags (key-value pairs) for this cleanrooms privacy budget template." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.CleanRooms/PrivacyBudgetTemplate", + "properties": { + "name": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/6" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/108" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.CleanRooms/PrivacyBudgetTemplate@default", + "scopeType": 0, + "body": { + "$ref": "#/109" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.cleanrooms/default/types.md b/artifacts/bicep/aws/aws.cleanrooms/default/types.md index 6b1c4001..508a082c 100644 --- a/artifacts/bicep/aws/aws.cleanrooms/default/types.md +++ b/artifacts/bicep/aws/aws.cleanrooms/default/types.md @@ -3,53 +3,44 @@ ## Resource AWS.CleanRooms/AnalysisTemplate@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.CleanRooms/AnalysisTemplateProperties](#awscleanroomsanalysistemplateproperties) (Required): properties of the resource +* **properties**: [AWS.CleanRooms/AnalysisTemplateProperties](#awscleanroomsanalysistemplateproperties) (Required, Identifier): properties of the resource ## Resource AWS.CleanRooms/Collaboration@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.CleanRooms/CollaborationProperties](#awscleanroomscollaborationproperties) (Required): properties of the resource +* **properties**: [AWS.CleanRooms/CollaborationProperties](#awscleanroomscollaborationproperties) (Required, Identifier): properties of the resource ## Resource AWS.CleanRooms/ConfiguredTable@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.CleanRooms/ConfiguredTableProperties](#awscleanroomsconfiguredtableproperties) (Required): properties of the resource +* **properties**: [AWS.CleanRooms/ConfiguredTableProperties](#awscleanroomsconfiguredtableproperties) (Required, Identifier): properties of the resource ## Resource AWS.CleanRooms/ConfiguredTableAssociation@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.CleanRooms/ConfiguredTableAssociationProperties](#awscleanroomsconfiguredtableassociationproperties) (Required): properties of the resource +* **properties**: [AWS.CleanRooms/ConfiguredTableAssociationProperties](#awscleanroomsconfiguredtableassociationproperties) (Required, Identifier): properties of the resource ## Resource AWS.CleanRooms/Membership@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.CleanRooms/MembershipProperties](#awscleanroomsmembershipproperties) (Required): properties of the resource +* **properties**: [AWS.CleanRooms/MembershipProperties](#awscleanroomsmembershipproperties) (Required, Identifier): properties of the resource -## AWS.CleanRooms/AnalysisTemplateProperties +## Resource AWS.CleanRooms/PrivacyBudgetTemplate@default +* **Valid Scope(s)**: Unknown ### Properties -* **AnalysisParameters**: [AnalysisParameter](#analysisparameter)[]: The member who can query can provide this placeholder for a literal data value in an analysis template -* **AnalysisTemplateIdentifier**: string (ReadOnly, Identifier) -* **Arn**: string (ReadOnly) -* **CollaborationArn**: string (ReadOnly) -* **CollaborationIdentifier**: string (ReadOnly) -* **Description**: string -* **Format**: string (Required) -* **MembershipArn**: string (ReadOnly) -* **MembershipIdentifier**: string (Required, Identifier) -* **Name**: string (Required) -* **Schema**: [AnalysisSchema](#analysisschema) (ReadOnly) -* **Source**: [AnalysisSource](#analysissource) (Required) -* **Tags**: [Tag](#tag)[]: An arbitrary set of tags (key-value pairs) for this cleanrooms analysis template. +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.CleanRooms/PrivacyBudgetTemplateProperties](#awscleanroomsprivacybudgettemplateproperties) (Required, Identifier): properties of the resource ## AnalysisParameter ### Properties @@ -57,6 +48,11 @@ * **Name**: string (Required) * **Type**: string (Required) +## AnalysisRule +### Properties +* **Policy**: [ConfiguredTableAnalysisRulePolicy](#configuredtableanalysisrulepolicy) (Required) +* **Type**: string (Required) + ## AnalysisSchema ### Properties * **ReferencedTables**: string[] (Required) @@ -65,10 +61,21 @@ ### Properties * **Text**: string (Required) -## Tag +## AWS.CleanRooms/AnalysisTemplateProperties ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **AnalysisParameters**: [AnalysisParameter](#analysisparameter)[]: The member who can query can provide this placeholder for a literal data value in an analysis template +* **AnalysisTemplateIdentifier**: string (ReadOnly, Identifier) +* **Arn**: string (ReadOnly) +* **CollaborationArn**: string (ReadOnly) +* **CollaborationIdentifier**: string (ReadOnly) +* **Description**: string +* **Format**: string (Required) +* **MembershipArn**: string (ReadOnly) +* **MembershipIdentifier**: string (Required, Identifier) +* **Name**: string (Required) +* **Schema**: [AnalysisSchema](#analysisschema) (ReadOnly) +* **Source**: [AnalysisSource](#analysissource) (Required) +* **Tags**: [Tag](#tag)[]: An arbitrary set of tags (key-value pairs) for this cleanrooms analysis template. ## AWS.CleanRooms/CollaborationProperties ### Properties @@ -84,32 +91,16 @@ * **QueryLogStatus**: string (Required) * **Tags**: [Tag](#tag)[]: An arbitrary set of tags (key-value pairs) for this cleanrooms collaboration. -## PaymentConfiguration -### Properties -* **QueryCompute**: [QueryComputePaymentConfig](#querycomputepaymentconfig) (Required) - -## QueryComputePaymentConfig -### Properties -* **IsResponsible**: bool (Required) - -## DataEncryptionMetadata -### Properties -* **AllowCleartext**: bool (Required) -* **AllowDuplicates**: bool (Required) -* **AllowJoinsOnColumnsWithDifferentNames**: bool (Required) -* **PreserveNulls**: bool (Required) - -## MemberSpecification -### Properties -* **AccountId**: string (Required) -* **DisplayName**: string (Required) -* **MemberAbilities**: string[] (Required) -* **PaymentConfiguration**: [PaymentConfiguration](#paymentconfiguration) - -## Tag +## AWS.CleanRooms/ConfiguredTableAssociationProperties ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **Arn**: string (ReadOnly) +* **ConfiguredTableAssociationIdentifier**: string (ReadOnly, Identifier) +* **ConfiguredTableIdentifier**: string (Required) +* **Description**: string +* **MembershipIdentifier**: string (Required, Identifier) +* **Name**: string (Required) +* **RoleArn**: string (Required) +* **Tags**: [Tag](#tag)[]: An arbitrary set of tags (key-value pairs) for this cleanrooms collaboration. ## AWS.CleanRooms/ConfiguredTableProperties ### Properties @@ -123,68 +114,82 @@ * **TableReference**: [TableReference](#tablereference) (Required) * **Tags**: [Tag](#tag)[]: An arbitrary set of tags (key-value pairs) for this cleanrooms collaboration. -## AnalysisRule +## AWS.CleanRooms/MembershipProperties ### Properties -* **Policy**: [ConfiguredTableAnalysisRulePolicy](#configuredtableanalysisrulepolicy) (Required) -* **Type**: string (Required) +* **Arn**: string (ReadOnly) +* **CollaborationArn**: string (ReadOnly) +* **CollaborationCreatorAccountId**: string (ReadOnly) +* **CollaborationIdentifier**: string (Required) +* **DefaultResultConfiguration**: [MembershipProtectedQueryResultConfiguration](#membershipprotectedqueryresultconfiguration) +* **MembershipIdentifier**: string (ReadOnly, Identifier) +* **PaymentConfiguration**: [MembershipPaymentConfiguration](#membershippaymentconfiguration) +* **QueryLogStatus**: string (Required) +* **Tags**: [Tag](#tag)[]: An arbitrary set of tags (key-value pairs) for this cleanrooms membership. -## ConfiguredTableAnalysisRulePolicy +## AWS.CleanRooms/PrivacyBudgetTemplateProperties ### Properties -* **V1**: [ConfiguredTable_ConfiguredTableAnalysisRulePolicyV1](#configuredtableconfiguredtableanalysisrulepolicyv1) (Required) +* **Arn**: string (ReadOnly) +* **AutoRefresh**: string (Required) +* **CollaborationArn**: string (ReadOnly) +* **CollaborationIdentifier**: string (ReadOnly) +* **MembershipArn**: string (ReadOnly) +* **MembershipIdentifier**: string (Required, Identifier) +* **Parameters**: [PrivacyBudgetTemplate_Parameters](#privacybudgettemplateparameters) (Required) +* **PrivacyBudgetTemplateIdentifier**: string (ReadOnly, Identifier) +* **PrivacyBudgetType**: string (Required) +* **Tags**: [Tag](#tag)[]: An arbitrary set of tags (key-value pairs) for this cleanrooms privacy budget template. ## ConfiguredTable_ConfiguredTableAnalysisRulePolicyV1 ### Properties -## TableReference +## ConfiguredTableAnalysisRulePolicy ### Properties -* **Glue**: [GlueTableReference](#gluetablereference) (Required) +* **V1**: [ConfiguredTable_ConfiguredTableAnalysisRulePolicyV1](#configuredtableconfiguredtableanalysisrulepolicyv1) (Required) + +## DataEncryptionMetadata +### Properties +* **AllowCleartext**: bool (Required) +* **AllowDuplicates**: bool (Required) +* **AllowJoinsOnColumnsWithDifferentNames**: bool (Required) +* **PreserveNulls**: bool (Required) ## GlueTableReference ### Properties * **DatabaseName**: string (Required) * **TableName**: string (Required) -## Tag +## MembershipPaymentConfiguration ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **QueryCompute**: [MembershipQueryComputePaymentConfig](#membershipquerycomputepaymentconfig) (Required) -## AWS.CleanRooms/ConfiguredTableAssociationProperties +## MembershipProtectedQueryOutputConfiguration ### Properties -* **Arn**: string (ReadOnly) -* **ConfiguredTableAssociationIdentifier**: string (ReadOnly, Identifier) -* **ConfiguredTableIdentifier**: string (Required) -* **Description**: string -* **MembershipIdentifier**: string (Required, Identifier) -* **Name**: string (Required) -* **RoleArn**: string (Required) -* **Tags**: [Tag](#tag)[]: An arbitrary set of tags (key-value pairs) for this cleanrooms collaboration. +* **S3**: [ProtectedQueryS3OutputConfiguration](#protectedquerys3outputconfiguration) (Required) -## Tag +## MembershipProtectedQueryResultConfiguration ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **OutputConfiguration**: [MembershipProtectedQueryOutputConfiguration](#membershipprotectedqueryoutputconfiguration) (Required) +* **RoleArn**: string -## AWS.CleanRooms/MembershipProperties +## MembershipQueryComputePaymentConfig ### Properties -* **Arn**: string (ReadOnly) -* **CollaborationArn**: string (ReadOnly) -* **CollaborationCreatorAccountId**: string (ReadOnly) -* **CollaborationIdentifier**: string (Required) -* **DefaultResultConfiguration**: [MembershipProtectedQueryResultConfiguration](#membershipprotectedqueryresultconfiguration) -* **MembershipIdentifier**: string (ReadOnly, Identifier) -* **PaymentConfiguration**: [MembershipPaymentConfiguration](#membershippaymentconfiguration) -* **QueryLogStatus**: string (Required) -* **Tags**: [Tag](#tag)[]: An arbitrary set of tags (key-value pairs) for this cleanrooms membership. +* **IsResponsible**: bool (Required) -## MembershipProtectedQueryResultConfiguration +## MemberSpecification ### Properties -* **OutputConfiguration**: [MembershipProtectedQueryOutputConfiguration](#membershipprotectedqueryoutputconfiguration) (Required) -* **RoleArn**: string +* **AccountId**: string (Required) +* **DisplayName**: string (Required) +* **MemberAbilities**: string[] (Required) +* **PaymentConfiguration**: [PaymentConfiguration](#paymentconfiguration) -## MembershipProtectedQueryOutputConfiguration +## PaymentConfiguration ### Properties -* **S3**: [ProtectedQueryS3OutputConfiguration](#protectedquerys3outputconfiguration) (Required) +* **QueryCompute**: [QueryComputePaymentConfig](#querycomputepaymentconfig) (Required) + +## PrivacyBudgetTemplate_Parameters +### Properties +* **Epsilon**: int (Required) +* **UsersNoisePerQuery**: int (Required) ## ProtectedQueryS3OutputConfiguration ### Properties @@ -192,13 +197,38 @@ * **KeyPrefix**: string * **ResultFormat**: string (Required) -## MembershipPaymentConfiguration +## QueryComputePaymentConfig ### Properties -* **QueryCompute**: [MembershipQueryComputePaymentConfig](#membershipquerycomputepaymentconfig) (Required) +* **IsResponsible**: bool (Required) -## MembershipQueryComputePaymentConfig +## TableReference ### Properties -* **IsResponsible**: bool (Required) +* **Glue**: [GlueTableReference](#gluetablereference) (Required) + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) ## Tag ### Properties diff --git a/artifacts/bicep/aws/aws.cleanroomsml/default/types.json b/artifacts/bicep/aws/aws.cleanroomsml/default/types.json new file mode 100644 index 00000000..a491b6d5 --- /dev/null +++ b/artifacts/bicep/aws/aws.cleanroomsml/default/types.json @@ -0,0 +1,246 @@ +[ + { + "$type": "ObjectType", + "name": "ColumnSchema", + "properties": { + "ColumnName": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + }, + "ColumnTypes": { + "type": { + "$ref": "#/11" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ColumnType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DataSource", + "properties": { + "GlueDataSource": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Dataset", + "properties": { + "InputConfig": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + }, + "Type": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DatasetInputConfig", + "properties": { + "DataSource": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Schema": { + "type": { + "$ref": "#/12" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DatasetType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "GlueDataSource", + "properties": { + "CatalogId": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "DatabaseName": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + }, + "TableName": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TrainingDatasetStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Unit", + "properties": {} + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/10" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.CleanRoomsML/TrainingDatasetProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/7" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ObjectType", + "name": "AWS.CleanRoomsML/TrainingDatasetProperties", + "properties": { + "Description": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + }, + "RoleArn": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + }, + "Status": { + "type": { + "$ref": "#/10" + }, + "flags": 2 + }, + "Tags": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "An arbitrary set of tags (key-value pairs) for this cleanrooms-ml training dataset." + }, + "TrainingData": { + "type": { + "$ref": "#/15" + }, + "flags": 1 + }, + "TrainingDatasetArn": { + "type": { + "$ref": "#/10" + }, + "flags": 18 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.CleanRoomsML/TrainingDataset", + "properties": { + "name": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/10" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/16" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.CleanRoomsML/TrainingDataset@default", + "scopeType": 0, + "body": { + "$ref": "#/17" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.cleanroomsml/default/types.md b/artifacts/bicep/aws/aws.cleanroomsml/default/types.md new file mode 100644 index 00000000..31c97e52 --- /dev/null +++ b/artifacts/bicep/aws/aws.cleanroomsml/default/types.md @@ -0,0 +1,49 @@ +# AWS.CleanRoomsML @ default + +## Resource AWS.CleanRoomsML/TrainingDataset@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.CleanRoomsML/TrainingDatasetProperties](#awscleanroomsmltrainingdatasetproperties) (Required, Identifier): properties of the resource + +## AWS.CleanRoomsML/TrainingDatasetProperties +### Properties +* **Description**: string +* **Name**: string (Required) +* **RoleArn**: string (Required) +* **Status**: string (ReadOnly) +* **Tags**: [Tag](#tag)[]: An arbitrary set of tags (key-value pairs) for this cleanrooms-ml training dataset. +* **TrainingData**: [Dataset](#dataset)[] (Required) +* **TrainingDatasetArn**: string (ReadOnly, Identifier) + +## ColumnSchema +### Properties +* **ColumnName**: string (Required) +* **ColumnTypes**: string[] (Required) + +## Dataset +### Properties +* **InputConfig**: [DatasetInputConfig](#datasetinputconfig) (Required) +* **Type**: string (Required) + +## DatasetInputConfig +### Properties +* **DataSource**: [DataSource](#datasource) (Required) +* **Schema**: [ColumnSchema](#columnschema)[] (Required) + +## DataSource +### Properties +* **GlueDataSource**: [GlueDataSource](#gluedatasource) (Required) + +## GlueDataSource +### Properties +* **CatalogId**: string +* **DatabaseName**: string (Required) +* **TableName**: string (Required) + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + diff --git a/artifacts/bicep/aws/aws.cloudformation/default/types.json b/artifacts/bicep/aws/aws.cloudformation/default/types.json index d97c6e7d..3e97ae06 100644 --- a/artifacts/bicep/aws/aws.cloudformation/default/types.json +++ b/artifacts/bicep/aws/aws.cloudformation/default/types.json @@ -1 +1,1069 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"AWS.CloudFormation/HookDefaultVersionProperties","Properties":{"Arn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN) of the type. This is used to uniquely identify a HookDefaultVersion"},"TypeName":{"Type":4,"Flags":0,"Description":"The name of the type being registered.\n\nWe recommend that type names adhere to the following pattern: company_or_organization::service::type."},"TypeVersionArn":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) of the type version."},"VersionId":{"Type":4,"Flags":0,"Description":"The ID of an existing version of the hook to set as the default."}}}},{"2":{"Name":"AWS.CloudFormation/HookDefaultVersion","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":8,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.CloudFormation/HookDefaultVersion@default","ScopeType":0,"Body":9}},{"2":{"Name":"AWS.CloudFormation/HookTypeConfigProperties","Properties":{"Configuration":{"Type":4,"Flags":1,"Description":"The configuration data for the extension, in this account and region."},"ConfigurationAlias":{"Type":4,"Flags":0,"Description":"An alias by which to refer to this extension configuration data."},"ConfigurationArn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN) for the configuration data, in this account and region."},"TypeArn":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) of the type without version number."},"TypeName":{"Type":4,"Flags":0,"Description":"The name of the type being registered.\n\nWe recommend that type names adhere to the following pattern: company_or_organization::service::type."}}}},{"2":{"Name":"AWS.CloudFormation/HookTypeConfig","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":11,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.CloudFormation/HookTypeConfig@default","ScopeType":0,"Body":12}},{"2":{"Name":"AWS.CloudFormation/ResourceDefaultVersionProperties","Properties":{"Arn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN) of the type. This is used to uniquely identify a ResourceDefaultVersion"},"TypeName":{"Type":4,"Flags":0,"Description":"The name of the type being registered.\n\nWe recommend that type names adhere to the following pattern: company_or_organization::service::type."},"TypeVersionArn":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) of the type version."},"VersionId":{"Type":4,"Flags":0,"Description":"The ID of an existing version of the resource to set as the default."}}}},{"2":{"Name":"AWS.CloudFormation/ResourceDefaultVersion","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":14,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.CloudFormation/ResourceDefaultVersion@default","ScopeType":0,"Body":15}},{"2":{"Name":"Output","Properties":{"Description":{"Type":4,"Flags":0},"ExportName":{"Type":4,"Flags":0},"OutputKey":{"Type":4,"Flags":0},"OutputValue":{"Type":4,"Flags":0}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.CloudFormation/StackProperties","Properties":{"Capabilities":{"Type":20,"Flags":0},"ChangeSetId":{"Type":4,"Flags":2},"CreationTime":{"Type":4,"Flags":2},"Description":{"Type":4,"Flags":0},"DisableRollback":{"Type":2,"Flags":0},"EnableTerminationProtection":{"Type":2,"Flags":0},"LastUpdateTime":{"Type":4,"Flags":2},"NotificationARNs":{"Type":21,"Flags":0},"Outputs":{"Type":22,"Flags":2},"Parameters":{"Type":23,"Flags":0},"ParentId":{"Type":4,"Flags":2},"RoleARN":{"Type":4,"Flags":0},"RootId":{"Type":4,"Flags":2},"StackId":{"Type":4,"Flags":18},"StackName":{"Type":4,"Flags":1},"StackPolicyBody":{"Type":24,"Flags":0},"StackPolicyURL":{"Type":4,"Flags":4},"StackStatus":{"Type":4,"Flags":2},"StackStatusReason":{"Type":4,"Flags":0},"Tags":{"Type":25,"Flags":0},"TemplateBody":{"Type":26,"Flags":0},"TemplateURL":{"Type":4,"Flags":4},"TimeoutInMinutes":{"Type":3,"Flags":0}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":17}},{"2":{"Name":"Stack_Parameters","Properties":{}}},{"2":{"Name":"Stack_StackPolicyBody","Properties":{}}},{"3":{"ItemType":18}},{"2":{"Name":"Stack_TemplateBody","Properties":{}}},{"2":{"Name":"AWS.CloudFormation/Stack","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":19,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.CloudFormation/Stack@default","ScopeType":0,"Body":27}},{"2":{"Name":"Account"}},{"2":{"Name":"Active"}},{"2":{"Name":"AutoDeployment","Properties":{"Enabled":{"Type":2,"Flags":0,"Description":"If set to true, StackSets automatically deploys additional stack instances to AWS Organizations accounts that are added to a target organization or organizational unit (OU) in the specified Regions. If an account is removed from a target organization or OU, StackSets deletes stack instances from the account in the specified Regions."},"RetainStacksOnAccountRemoval":{"Type":2,"Flags":0,"Description":"If set to true, stack resources are retained when an account is removed from a target organization or OU. If set to false, stack resources are deleted. Specify only if Enabled is set to True."}}}},{"2":{"Name":"Capability"}},{"2":{"Name":"DeploymentTargets","Properties":{"AccountFilterType":{"Type":4,"Flags":0,"Description":"The filter type you want to apply on organizational units and accounts."},"Accounts":{"Type":41,"Flags":0,"Description":"AWS accounts that you want to create stack instances in the specified Region(s) for."},"AccountsUrl":{"Type":4,"Flags":0,"Description":"Returns the value of the AccountsUrl property."},"OrganizationalUnitIds":{"Type":42,"Flags":0,"Description":"The organization root ID or organizational unit (OU) IDs to which StackSets deploys."}}}},{"2":{"Name":"OperationPreferences","Properties":{"FailureToleranceCount":{"Type":3,"Flags":0},"FailureTolerancePercentage":{"Type":3,"Flags":0},"MaxConcurrentCount":{"Type":3,"Flags":0},"MaxConcurrentPercentage":{"Type":3,"Flags":0},"RegionConcurrencyType":{"Type":4,"Flags":0},"RegionOrder":{"Type":43,"Flags":0}}}},{"2":{"Name":"OrganizationalUnitId"}},{"2":{"Name":"Parameter","Properties":{"ParameterKey":{"Type":4,"Flags":1,"Description":"The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS CloudFormation uses the default value that is specified in your template."},"ParameterValue":{"Type":4,"Flags":1,"Description":"The input value associated with the parameter."}}}},{"2":{"Name":"Region"}},{"2":{"Name":"RegionConcurrencyType"}},{"2":{"Name":"StackInstances","Properties":{"DeploymentTargets":{"Type":33,"Flags":1},"ParameterOverrides":{"Type":44,"Flags":0,"Description":"A list of stack set parameters whose values you want to override in the selected stack instances."},"Regions":{"Type":45,"Flags":1,"Description":"The names of one or more Regions where you want to create stack instances using the specified AWS account(s)."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"A string used to identify this tag. You can specify a maximum of 127 characters for a tag key."},"Value":{"Type":4,"Flags":1,"Description":"A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":36}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.CloudFormation/StackSetProperties","Properties":{"AdministrationRoleARN":{"Type":4,"Flags":0,"Description":"The Amazon Resource Number (ARN) of the IAM role to use to create this stack set. Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account."},"AutoDeployment":{"Type":31,"Flags":0,"Description":"Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to the target organization or organizational unit (OU). Specify only if PermissionModel is SERVICE_MANAGED."},"CallAs":{"Type":4,"Flags":4,"Description":"Specifies the AWS account that you are acting from. By default, SELF is specified. For self-managed permissions, specify SELF; for service-managed permissions, if you are signed in to the organization's management account, specify SELF. If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN."},"Capabilities":{"Type":47,"Flags":0,"Description":"In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for AWS CloudFormation to create the stack set and related stack instances."},"Description":{"Type":4,"Flags":0,"Description":"A description of the stack set. You can use the description to identify the stack set's purpose or other important information."},"ExecutionRoleName":{"Type":4,"Flags":0,"Description":"The name of the IAM execution role to use to create the stack set. If you do not specify an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation."},"ManagedExecution":{"Type":48,"Flags":0,"Description":"Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations."},"OperationPreferences":{"Type":34,"Flags":4},"Parameters":{"Type":49,"Flags":0,"Description":"The input parameters for the stack set template."},"PermissionModel":{"Type":4,"Flags":1,"Description":"Describes how the IAM roles required for stack set operations are created. By default, SELF-MANAGED is specified."},"StackInstancesGroup":{"Type":50,"Flags":4,"Description":"A group of stack instances with parameters in some specific accounts and regions."},"StackSetId":{"Type":4,"Flags":18,"Description":"The ID of the stack set that you're creating."},"StackSetName":{"Type":4,"Flags":1,"Description":"The name to associate with the stack set. The name must be unique in the Region where you create your stack set."},"Tags":{"Type":51,"Flags":0,"Description":"The key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. A maximum number of 50 tags can be specified."},"TemplateBody":{"Type":4,"Flags":0,"Description":"The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes."},"TemplateURL":{"Type":4,"Flags":4,"Description":"Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket."}}}},{"3":{"ItemType":4}},{"2":{"Name":"StackSet_ManagedExecution","Properties":{"Active":{"Type":2,"Flags":0}}}},{"3":{"ItemType":36}},{"3":{"ItemType":39}},{"3":{"ItemType":40}},{"2":{"Name":"AWS.CloudFormation/StackSet","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":46,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.CloudFormation/StackSet@default","ScopeType":0,"Body":52}},{"2":{"Name":"LoggingConfig","Properties":{"LogGroupName":{"Type":4,"Flags":0,"Description":"The Amazon CloudWatch log group to which CloudFormation sends error logging information when invoking the type's handlers."},"LogRoleArn":{"Type":4,"Flags":0,"Description":"The ARN of the role that CloudFormation should assume when sending log entries to CloudWatch logs."}}}},{"2":{"Name":"AWS.CloudFormation/TypeActivationProperties","Properties":{"Arn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN) of the extension."},"AutoUpdate":{"Type":2,"Flags":4,"Description":"Whether to automatically update the extension in this account and region when a new minor version is published by the extension publisher. Major versions released by the publisher must be manually updated."},"ExecutionRoleArn":{"Type":4,"Flags":4,"Description":"The Amazon Resource Name (ARN) of the IAM execution role to use to register the type. If your resource type calls AWS APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. CloudFormation then assumes that execution role to provide your resource type with the appropriate credentials."},"LoggingConfig":{"Type":54,"Flags":4,"Description":"Specifies logging configuration information for a type."},"MajorVersion":{"Type":4,"Flags":4,"Description":"The Major Version of the type you want to enable"},"PublicTypeArn":{"Type":4,"Flags":0,"Description":"The Amazon Resource Number (ARN) assigned to the public extension upon publication"},"PublisherId":{"Type":4,"Flags":0,"Description":"The publisher id assigned by CloudFormation for publishing in this region."},"Type":{"Type":4,"Flags":4,"Description":"The kind of extension"},"TypeName":{"Type":4,"Flags":0,"Description":"The name of the type being registered.\n\nWe recommend that type names adhere to the following pattern: company_or_organization::service::type."},"TypeNameAlias":{"Type":4,"Flags":0,"Description":"An alias to assign to the public extension in this account and region. If you specify an alias for the extension, you must then use the alias to refer to the extension in your templates."},"VersionBump":{"Type":4,"Flags":4,"Description":"Manually updates a previously-enabled type to a new major or minor version, if available. You can also use this parameter to update the value of AutoUpdateEnabled"}}}},{"2":{"Name":"AWS.CloudFormation/TypeActivation","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":55,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.CloudFormation/TypeActivation@default","ScopeType":0,"Body":56}}] \ No newline at end of file +[ + { + "$type": "StringLiteralType", + "value": "AWS.CloudFormation/HookDefaultVersionProperties" + }, + { + "$type": "StringType" + }, + { + "$type": "ObjectType", + "name": "AWS.CloudFormation/HookDefaultVersionProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) of the type. This is used to uniquely identify a HookDefaultVersion" + }, + "TypeName": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The name of the type being registered.\n\nWe recommend that type names adhere to the following pattern: company_or_organization::service::type." + }, + "TypeVersionArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the type version." + }, + "VersionId": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The ID of an existing version of the hook to set as the default." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.CloudFormation/HookDefaultVersion", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/2" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.CloudFormation/HookDefaultVersion@default", + "scopeType": 0, + "body": { + "$ref": "#/3" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.CloudFormation/HookTypeConfigProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.CloudFormation/HookTypeConfigProperties", + "properties": { + "Configuration": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The configuration data for the extension, in this account and region." + }, + "ConfigurationAlias": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "An alias by which to refer to this extension configuration data." + }, + "ConfigurationArn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) for the configuration data, in this account and region." + }, + "TypeArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the type without version number." + }, + "TypeName": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The name of the type being registered.\n\nWe recommend that type names adhere to the following pattern: company_or_organization::service::type." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.CloudFormation/HookTypeConfig", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/6" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.CloudFormation/HookTypeConfig@default", + "scopeType": 0, + "body": { + "$ref": "#/7" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.CloudFormation/ResourceDefaultVersionProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.CloudFormation/ResourceDefaultVersionProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) of the type. This is used to uniquely identify a ResourceDefaultVersion" + }, + "TypeName": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The name of the type being registered.\n\nWe recommend that type names adhere to the following pattern: company_or_organization::service::type." + }, + "TypeVersionArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the type version." + }, + "VersionId": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The ID of an existing version of the resource to set as the default." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.CloudFormation/ResourceDefaultVersion", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/10" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.CloudFormation/ResourceDefaultVersion@default", + "scopeType": 0, + "body": { + "$ref": "#/11" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Output", + "properties": { + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "ExportName": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "OutputKey": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "OutputValue": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.CloudFormation/StackProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "ObjectType", + "name": "Stack_Parameters", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Stack_StackPolicyBody", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/14" + } + }, + { + "$type": "ObjectType", + "name": "Stack_TemplateBody", + "properties": {} + }, + { + "$type": "IntegerType" + }, + { + "$type": "ObjectType", + "name": "AWS.CloudFormation/StackProperties", + "properties": { + "Capabilities": { + "type": { + "$ref": "#/16" + }, + "flags": 0 + }, + "ChangeSetId": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "CreationTime": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "DisableRollback": { + "type": { + "$ref": "#/17" + }, + "flags": 0 + }, + "EnableTerminationProtection": { + "type": { + "$ref": "#/17" + }, + "flags": 0 + }, + "LastUpdateTime": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "NotificationARNs": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "Outputs": { + "type": { + "$ref": "#/19" + }, + "flags": 2 + }, + "Parameters": { + "type": { + "$ref": "#/20" + }, + "flags": 0 + }, + "ParentId": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "RoleARN": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "RootId": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "StackId": { + "type": { + "$ref": "#/1" + }, + "flags": 18 + }, + "StackName": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "StackPolicyBody": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "StackPolicyURL": { + "type": { + "$ref": "#/1" + }, + "flags": 4 + }, + "StackStatus": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "StackStatusReason": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/22" + }, + "flags": 0 + }, + "TemplateBody": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "TemplateURL": { + "type": { + "$ref": "#/1" + }, + "flags": 4 + }, + "TimeoutInMinutes": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.CloudFormation/Stack", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/25" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.CloudFormation/Stack@default", + "scopeType": 0, + "body": { + "$ref": "#/26" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Account", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Active", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AutoDeployment", + "properties": { + "Enabled": { + "type": { + "$ref": "#/17" + }, + "flags": 0, + "description": "If set to true, StackSets automatically deploys additional stack instances to AWS Organizations accounts that are added to a target organization or organizational unit (OU) in the specified Regions. If an account is removed from a target organization or OU, StackSets deletes stack instances from the account in the specified Regions." + }, + "RetainStacksOnAccountRemoval": { + "type": { + "$ref": "#/17" + }, + "flags": 0, + "description": "If set to true, stack resources are retained when an account is removed from a target organization or OU. If set to false, stack resources are deleted. Specify only if Enabled is set to True." + } + } + }, + { + "$type": "ObjectType", + "name": "Capability", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DeploymentTargets", + "properties": { + "AccountFilterType": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The filter type you want to apply on organizational units and accounts." + }, + "Accounts": { + "type": { + "$ref": "#/40" + }, + "flags": 0, + "description": "AWS accounts that you want to create stack instances in the specified Region(s) for." + }, + "AccountsUrl": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Returns the value of the AccountsUrl property." + }, + "OrganizationalUnitIds": { + "type": { + "$ref": "#/41" + }, + "flags": 0, + "description": "The organization root ID or organizational unit (OU) IDs to which StackSets deploys." + } + } + }, + { + "$type": "ObjectType", + "name": "OperationPreferences", + "properties": { + "FailureToleranceCount": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "FailureTolerancePercentage": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "MaxConcurrentCount": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "MaxConcurrentPercentage": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "RegionConcurrencyType": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "RegionOrder": { + "type": { + "$ref": "#/42" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "OrganizationalUnitId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Parameter", + "properties": { + "ParameterKey": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS CloudFormation uses the default value that is specified in your template." + }, + "ParameterValue": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The input value associated with the parameter." + } + } + }, + { + "$type": "ObjectType", + "name": "Region", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RegionConcurrencyType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "StackInstances", + "properties": { + "DeploymentTargets": { + "type": { + "$ref": "#/32" + }, + "flags": 1 + }, + "ParameterOverrides": { + "type": { + "$ref": "#/43" + }, + "flags": 0, + "description": "A list of stack set parameters whose values you want to override in the selected stack instances." + }, + "Regions": { + "type": { + "$ref": "#/44" + }, + "flags": 1, + "description": "The names of one or more Regions where you want to create stack instances using the specified AWS account(s)." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "A string used to identify this tag. You can specify a maximum of 127 characters for a tag key." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/35" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.CloudFormation/StackSetProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "StackSet_ManagedExecution", + "properties": { + "Active": { + "type": { + "$ref": "#/17" + }, + "flags": 0 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/35" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/38" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/39" + } + }, + { + "$type": "ObjectType", + "name": "AWS.CloudFormation/StackSetProperties", + "properties": { + "AdministrationRoleARN": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The Amazon Resource Number (ARN) of the IAM role to use to create this stack set. Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account." + }, + "AutoDeployment": { + "type": { + "$ref": "#/30" + }, + "flags": 0, + "description": "Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to the target organization or organizational unit (OU). Specify only if PermissionModel is SERVICE_MANAGED." + }, + "CallAs": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "Specifies the AWS account that you are acting from. By default, SELF is specified. For self-managed permissions, specify SELF; for service-managed permissions, if you are signed in to the organization's management account, specify SELF. If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN." + }, + "Capabilities": { + "type": { + "$ref": "#/46" + }, + "flags": 0, + "description": "In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for AWS CloudFormation to create the stack set and related stack instances." + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A description of the stack set. You can use the description to identify the stack set's purpose or other important information." + }, + "ExecutionRoleName": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The name of the IAM execution role to use to create the stack set. If you do not specify an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation." + }, + "ManagedExecution": { + "type": { + "$ref": "#/47" + }, + "flags": 0, + "description": "Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations." + }, + "OperationPreferences": { + "type": { + "$ref": "#/33" + }, + "flags": 4 + }, + "Parameters": { + "type": { + "$ref": "#/48" + }, + "flags": 0, + "description": "The input parameters for the stack set template." + }, + "PermissionModel": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Describes how the IAM roles required for stack set operations are created. By default, SELF-MANAGED is specified." + }, + "StackInstancesGroup": { + "type": { + "$ref": "#/49" + }, + "flags": 4, + "description": "A group of stack instances with parameters in some specific accounts and regions." + }, + "StackSetId": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The ID of the stack set that you're creating." + }, + "StackSetName": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The name to associate with the stack set. The name must be unique in the Region where you create your stack set." + }, + "Tags": { + "type": { + "$ref": "#/50" + }, + "flags": 0, + "description": "The key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. A maximum number of 50 tags can be specified." + }, + "TemplateBody": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes." + }, + "TemplateURL": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.CloudFormation/StackSet", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/51" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.CloudFormation/StackSet@default", + "scopeType": 0, + "body": { + "$ref": "#/52" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "LoggingConfig", + "properties": { + "LogGroupName": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The Amazon CloudWatch log group to which CloudFormation sends error logging information when invoking the type's handlers." + }, + "LogRoleArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The ARN of the role that CloudFormation should assume when sending log entries to CloudWatch logs." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.CloudFormation/TypeActivationProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.CloudFormation/TypeActivationProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) of the extension." + }, + "AutoUpdate": { + "type": { + "$ref": "#/17" + }, + "flags": 4, + "description": "Whether to automatically update the extension in this account and region when a new minor version is published by the extension publisher. Major versions released by the publisher must be manually updated." + }, + "ExecutionRoleArn": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The Amazon Resource Name (ARN) of the IAM execution role to use to register the type. If your resource type calls AWS APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. CloudFormation then assumes that execution role to provide your resource type with the appropriate credentials." + }, + "LoggingConfig": { + "type": { + "$ref": "#/54" + }, + "flags": 4, + "description": "Specifies logging configuration information for a type." + }, + "MajorVersion": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The Major Version of the type you want to enable" + }, + "PublicTypeArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The Amazon Resource Number (ARN) assigned to the public extension upon publication" + }, + "PublisherId": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The publisher id assigned by CloudFormation for publishing in this region." + }, + "Type": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The kind of extension" + }, + "TypeName": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The name of the type being registered.\n\nWe recommend that type names adhere to the following pattern: company_or_organization::service::type." + }, + "TypeNameAlias": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "An alias to assign to the public extension in this account and region. If you specify an alias for the extension, you must then use the alias to refer to the extension in your templates." + }, + "VersionBump": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "Manually updates a previously-enabled type to a new major or minor version, if available. You can also use this parameter to update the value of AutoUpdateEnabled" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.CloudFormation/TypeActivation", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/56" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.CloudFormation/TypeActivation@default", + "scopeType": 0, + "body": { + "$ref": "#/57" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.cloudformation/default/types.md b/artifacts/bicep/aws/aws.cloudformation/default/types.md index dd5c2d26..5e09910e 100644 --- a/artifacts/bicep/aws/aws.cloudformation/default/types.md +++ b/artifacts/bicep/aws/aws.cloudformation/default/types.md @@ -3,44 +3,49 @@ ## Resource AWS.CloudFormation/HookDefaultVersion@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.CloudFormation/HookDefaultVersionProperties](#awscloudformationhookdefaultversionproperties): properties of the resource +* **properties**: [AWS.CloudFormation/HookDefaultVersionProperties](#awscloudformationhookdefaultversionproperties) (Identifier): properties of the resource ## Resource AWS.CloudFormation/HookTypeConfig@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.CloudFormation/HookTypeConfigProperties](#awscloudformationhooktypeconfigproperties) (Required): properties of the resource +* **properties**: [AWS.CloudFormation/HookTypeConfigProperties](#awscloudformationhooktypeconfigproperties) (Required, Identifier): properties of the resource ## Resource AWS.CloudFormation/ResourceDefaultVersion@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.CloudFormation/ResourceDefaultVersionProperties](#awscloudformationresourcedefaultversionproperties): properties of the resource +* **properties**: [AWS.CloudFormation/ResourceDefaultVersionProperties](#awscloudformationresourcedefaultversionproperties) (Identifier): properties of the resource ## Resource AWS.CloudFormation/Stack@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.CloudFormation/StackProperties](#awscloudformationstackproperties) (Required): properties of the resource +* **properties**: [AWS.CloudFormation/StackProperties](#awscloudformationstackproperties) (Required, Identifier): properties of the resource ## Resource AWS.CloudFormation/StackSet@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.CloudFormation/StackSetProperties](#awscloudformationstacksetproperties) (Required): properties of the resource +* **properties**: [AWS.CloudFormation/StackSetProperties](#awscloudformationstacksetproperties) (Required, Identifier): properties of the resource ## Resource AWS.CloudFormation/TypeActivation@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.CloudFormation/TypeActivationProperties](#awscloudformationtypeactivationproperties): properties of the resource +* **properties**: [AWS.CloudFormation/TypeActivationProperties](#awscloudformationtypeactivationproperties) (Identifier): properties of the resource + +## AutoDeployment +### Properties +* **Enabled**: bool: If set to true, StackSets automatically deploys additional stack instances to AWS Organizations accounts that are added to a target organization or organizational unit (OU) in the specified Regions. If an account is removed from a target organization or OU, StackSets deletes stack instances from the account in the specified Regions. +* **RetainStacksOnAccountRemoval**: bool: If set to true, stack resources are retained when an account is removed from a target organization or OU. If set to false, stack resources are deleted. Specify only if Enabled is set to True. ## AWS.CloudFormation/HookDefaultVersionProperties ### Properties @@ -96,27 +101,6 @@ We recommend that type names adhere to the following pattern: company_or_organiz * **TemplateURL**: string (WriteOnly) * **TimeoutInMinutes**: int -## Output -### Properties -* **Description**: string -* **ExportName**: string -* **OutputKey**: string -* **OutputValue**: string - -## Stack_Parameters -### Properties - -## Stack_StackPolicyBody -### Properties - -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - -## Stack_TemplateBody -### Properties - ## AWS.CloudFormation/StackSetProperties ### Properties * **AdministrationRoleARN**: string: The Amazon Resource Number (ARN) of the IAM role to use to create this stack set. Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. @@ -136,14 +120,33 @@ We recommend that type names adhere to the following pattern: company_or_organiz * **TemplateBody**: string: The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. * **TemplateURL**: string (WriteOnly): Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. -## AutoDeployment +## AWS.CloudFormation/TypeActivationProperties ### Properties -* **Enabled**: bool: If set to true, StackSets automatically deploys additional stack instances to AWS Organizations accounts that are added to a target organization or organizational unit (OU) in the specified Regions. If an account is removed from a target organization or OU, StackSets deletes stack instances from the account in the specified Regions. -* **RetainStacksOnAccountRemoval**: bool: If set to true, stack resources are retained when an account is removed from a target organization or OU. If set to false, stack resources are deleted. Specify only if Enabled is set to True. +* **Arn**: string (ReadOnly, Identifier): The Amazon Resource Name (ARN) of the extension. +* **AutoUpdate**: bool (WriteOnly): Whether to automatically update the extension in this account and region when a new minor version is published by the extension publisher. Major versions released by the publisher must be manually updated. +* **ExecutionRoleArn**: string (WriteOnly): The Amazon Resource Name (ARN) of the IAM execution role to use to register the type. If your resource type calls AWS APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. CloudFormation then assumes that execution role to provide your resource type with the appropriate credentials. +* **LoggingConfig**: [LoggingConfig](#loggingconfig) (WriteOnly): Specifies logging configuration information for a type. +* **MajorVersion**: string (WriteOnly): The Major Version of the type you want to enable +* **PublicTypeArn**: string: The Amazon Resource Number (ARN) assigned to the public extension upon publication +* **PublisherId**: string: The publisher id assigned by CloudFormation for publishing in this region. +* **Type**: string (WriteOnly): The kind of extension +* **TypeName**: string: The name of the type being registered. -## StackSet_ManagedExecution +We recommend that type names adhere to the following pattern: company_or_organization::service::type. +* **TypeNameAlias**: string: An alias to assign to the public extension in this account and region. If you specify an alias for the extension, you must then use the alias to refer to the extension in your templates. +* **VersionBump**: string (WriteOnly): Manually updates a previously-enabled type to a new major or minor version, if available. You can also use this parameter to update the value of AutoUpdateEnabled + +## DeploymentTargets ### Properties -* **Active**: bool +* **AccountFilterType**: string: The filter type you want to apply on organizational units and accounts. +* **Accounts**: string[]: AWS accounts that you want to create stack instances in the specified Region(s) for. +* **AccountsUrl**: string: Returns the value of the AccountsUrl property. +* **OrganizationalUnitIds**: string[]: The organization root ID or organizational unit (OU) IDs to which StackSets deploys. + +## LoggingConfig +### Properties +* **LogGroupName**: string: The Amazon CloudWatch log group to which CloudFormation sends error logging information when invoking the type's handlers. +* **LogRoleArn**: string: The ARN of the role that CloudFormation should assume when sending log entries to CloudWatch logs. ## OperationPreferences ### Properties @@ -154,47 +157,44 @@ We recommend that type names adhere to the following pattern: company_or_organiz * **RegionConcurrencyType**: string * **RegionOrder**: string[] +## Output +### Properties +* **Description**: string +* **ExportName**: string +* **OutputKey**: string +* **OutputValue**: string + ## Parameter ### Properties * **ParameterKey**: string (Required): The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS CloudFormation uses the default value that is specified in your template. * **ParameterValue**: string (Required): The input value associated with the parameter. +## Stack_Parameters +### Properties + +## Stack_StackPolicyBody +### Properties + +## Stack_TemplateBody +### Properties + ## StackInstances ### Properties * **DeploymentTargets**: [DeploymentTargets](#deploymenttargets) (Required) * **ParameterOverrides**: [Parameter](#parameter)[]: A list of stack set parameters whose values you want to override in the selected stack instances. * **Regions**: string[] (Required): The names of one or more Regions where you want to create stack instances using the specified AWS account(s). -## DeploymentTargets +## StackSet_ManagedExecution ### Properties -* **AccountFilterType**: string: The filter type you want to apply on organizational units and accounts. -* **Accounts**: string[]: AWS accounts that you want to create stack instances in the specified Region(s) for. -* **AccountsUrl**: string: Returns the value of the AccountsUrl property. -* **OrganizationalUnitIds**: string[]: The organization root ID or organizational unit (OU) IDs to which StackSets deploys. +* **Active**: bool ## Tag ### Properties -* **Key**: string (Required): A string used to identify this tag. You can specify a maximum of 127 characters for a tag key. -* **Value**: string (Required): A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value. - -## AWS.CloudFormation/TypeActivationProperties -### Properties -* **Arn**: string (ReadOnly, Identifier): The Amazon Resource Name (ARN) of the extension. -* **AutoUpdate**: bool (WriteOnly): Whether to automatically update the extension in this account and region when a new minor version is published by the extension publisher. Major versions released by the publisher must be manually updated. -* **ExecutionRoleArn**: string (WriteOnly): The Amazon Resource Name (ARN) of the IAM execution role to use to register the type. If your resource type calls AWS APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. CloudFormation then assumes that execution role to provide your resource type with the appropriate credentials. -* **LoggingConfig**: [LoggingConfig](#loggingconfig) (WriteOnly): Specifies logging configuration information for a type. -* **MajorVersion**: string (WriteOnly): The Major Version of the type you want to enable -* **PublicTypeArn**: string: The Amazon Resource Number (ARN) assigned to the public extension upon publication -* **PublisherId**: string: The publisher id assigned by CloudFormation for publishing in this region. -* **Type**: string (WriteOnly): The kind of extension -* **TypeName**: string: The name of the type being registered. - -We recommend that type names adhere to the following pattern: company_or_organization::service::type. -* **TypeNameAlias**: string: An alias to assign to the public extension in this account and region. If you specify an alias for the extension, you must then use the alias to refer to the extension in your templates. -* **VersionBump**: string (WriteOnly): Manually updates a previously-enabled type to a new major or minor version, if available. You can also use this parameter to update the value of AutoUpdateEnabled +* **Key**: string (Required) +* **Value**: string (Required) -## LoggingConfig +## Tag ### Properties -* **LogGroupName**: string: The Amazon CloudWatch log group to which CloudFormation sends error logging information when invoking the type's handlers. -* **LogRoleArn**: string: The ARN of the role that CloudFormation should assume when sending log entries to CloudWatch logs. +* **Key**: string (Required): A string used to identify this tag. You can specify a maximum of 127 characters for a tag key. +* **Value**: string (Required): A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value. diff --git a/artifacts/bicep/aws/aws.cloudfront/default/types.json b/artifacts/bicep/aws/aws.cloudfront/default/types.json index 990bff4e..845c8495 100644 --- a/artifacts/bicep/aws/aws.cloudfront/default/types.json +++ b/artifacts/bicep/aws/aws.cloudfront/default/types.json @@ -1 +1,3124 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"CachePolicyConfig","Properties":{"Comment":{"Type":4,"Flags":0},"DefaultTTL":{"Type":3,"Flags":1},"MaxTTL":{"Type":3,"Flags":1},"MinTTL":{"Type":3,"Flags":1},"Name":{"Type":4,"Flags":1},"ParametersInCacheKeyAndForwardedToOrigin":{"Type":11,"Flags":1}}}},{"2":{"Name":"CookiesConfig","Properties":{"CookieBehavior":{"Type":4,"Flags":1},"Cookies":{"Type":13,"Flags":0}}}},{"2":{"Name":"HeadersConfig","Properties":{"HeaderBehavior":{"Type":4,"Flags":1},"Headers":{"Type":14,"Flags":0}}}},{"2":{"Name":"ParametersInCacheKeyAndForwardedToOrigin","Properties":{"CookiesConfig":{"Type":9,"Flags":1},"EnableAcceptEncodingBrotli":{"Type":2,"Flags":0},"EnableAcceptEncodingGzip":{"Type":2,"Flags":1},"HeadersConfig":{"Type":10,"Flags":1},"QueryStringsConfig":{"Type":12,"Flags":1}}}},{"2":{"Name":"QueryStringsConfig","Properties":{"QueryStringBehavior":{"Type":4,"Flags":1},"QueryStrings":{"Type":15,"Flags":0}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.CloudFront/CachePolicyProperties","Properties":{"CachePolicyConfig":{"Type":8,"Flags":1},"Id":{"Type":4,"Flags":18},"LastModifiedTime":{"Type":4,"Flags":2}}}},{"2":{"Name":"AWS.CloudFront/CachePolicy","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":16,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.CloudFront/CachePolicy@default","ScopeType":0,"Body":17}},{"2":{"Name":"CloudFrontOriginAccessIdentityConfig","Properties":{"Comment":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.CloudFront/CloudFrontOriginAccessIdentityProperties","Properties":{"CloudFrontOriginAccessIdentityConfig":{"Type":19,"Flags":1},"Id":{"Type":4,"Flags":18},"S3CanonicalUserId":{"Type":4,"Flags":2}}}},{"2":{"Name":"AWS.CloudFront/CloudFrontOriginAccessIdentity","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":20,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.CloudFront/CloudFrontOriginAccessIdentity@default","ScopeType":0,"Body":21}},{"2":{"Name":"ContinuousDeploymentPolicyConfig","Properties":{"Enabled":{"Type":2,"Flags":1},"SingleHeaderPolicyConfig":{"Type":28,"Flags":0},"SingleWeightPolicyConfig":{"Type":29,"Flags":0},"StagingDistributionDnsNames":{"Type":30,"Flags":1},"TrafficConfig":{"Type":27,"Flags":0},"Type":{"Type":4,"Flags":0}}}},{"2":{"Name":"SessionStickinessConfig","Properties":{"IdleTTL":{"Type":3,"Flags":1},"MaximumTTL":{"Type":3,"Flags":1}}}},{"2":{"Name":"SingleHeaderConfig","Properties":{"Header":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"SingleWeightConfig","Properties":{"SessionStickinessConfig":{"Type":24,"Flags":0},"Weight":{"Type":3,"Flags":1}}}},{"2":{"Name":"TrafficConfig","Properties":{"SingleHeaderConfig":{"Type":25,"Flags":0},"SingleWeightConfig":{"Type":26,"Flags":0},"Type":{"Type":4,"Flags":1}}}},{"2":{"Name":"ContinuousDeploymentPolicy_SingleHeaderPolicyConfig","Properties":{"Header":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"ContinuousDeploymentPolicy_SingleWeightPolicyConfig","Properties":{"SessionStickinessConfig":{"Type":24,"Flags":0},"Weight":{"Type":3,"Flags":1}}}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.CloudFront/ContinuousDeploymentPolicyProperties","Properties":{"ContinuousDeploymentPolicyConfig":{"Type":23,"Flags":1},"Id":{"Type":4,"Flags":18},"LastModifiedTime":{"Type":4,"Flags":2}}}},{"2":{"Name":"AWS.CloudFront/ContinuousDeploymentPolicy","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":31,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.CloudFront/ContinuousDeploymentPolicy@default","ScopeType":0,"Body":32}},{"2":{"Name":"CacheBehavior","Properties":{"AllowedMethods":{"Type":60,"Flags":0},"CachePolicyId":{"Type":4,"Flags":0},"CachedMethods":{"Type":61,"Flags":0},"Compress":{"Type":2,"Flags":0},"DefaultTTL":{"Type":3,"Flags":0},"FieldLevelEncryptionId":{"Type":4,"Flags":0},"ForwardedValues":{"Type":40,"Flags":0},"FunctionAssociations":{"Type":62,"Flags":0},"LambdaFunctionAssociations":{"Type":63,"Flags":0},"MaxTTL":{"Type":3,"Flags":0},"MinTTL":{"Type":3,"Flags":0},"OriginRequestPolicyId":{"Type":4,"Flags":0},"PathPattern":{"Type":4,"Flags":1},"RealtimeLogConfigArn":{"Type":4,"Flags":0},"ResponseHeadersPolicyId":{"Type":4,"Flags":0},"SmoothStreaming":{"Type":2,"Flags":0},"TargetOriginId":{"Type":4,"Flags":1},"TrustedKeyGroups":{"Type":64,"Flags":0},"TrustedSigners":{"Type":65,"Flags":0},"ViewerProtocolPolicy":{"Type":4,"Flags":1}}}},{"2":{"Name":"Cookies","Properties":{"Forward":{"Type":4,"Flags":1},"WhitelistedNames":{"Type":66,"Flags":0}}}},{"2":{"Name":"CustomErrorResponse","Properties":{"ErrorCachingMinTTL":{"Type":3,"Flags":0},"ErrorCode":{"Type":3,"Flags":1},"ResponseCode":{"Type":3,"Flags":0},"ResponsePagePath":{"Type":4,"Flags":0}}}},{"2":{"Name":"CustomOriginConfig","Properties":{"HTTPPort":{"Type":3,"Flags":0},"HTTPSPort":{"Type":3,"Flags":0},"OriginKeepaliveTimeout":{"Type":3,"Flags":0},"OriginProtocolPolicy":{"Type":4,"Flags":1},"OriginReadTimeout":{"Type":3,"Flags":0},"OriginSSLProtocols":{"Type":67,"Flags":0}}}},{"2":{"Name":"DefaultCacheBehavior","Properties":{"AllowedMethods":{"Type":68,"Flags":0},"CachePolicyId":{"Type":4,"Flags":0},"CachedMethods":{"Type":69,"Flags":0},"Compress":{"Type":2,"Flags":0},"DefaultTTL":{"Type":3,"Flags":0},"FieldLevelEncryptionId":{"Type":4,"Flags":0},"ForwardedValues":{"Type":40,"Flags":0},"FunctionAssociations":{"Type":70,"Flags":0},"LambdaFunctionAssociations":{"Type":71,"Flags":0},"MaxTTL":{"Type":3,"Flags":0},"MinTTL":{"Type":3,"Flags":0},"OriginRequestPolicyId":{"Type":4,"Flags":0},"RealtimeLogConfigArn":{"Type":4,"Flags":0},"ResponseHeadersPolicyId":{"Type":4,"Flags":0},"SmoothStreaming":{"Type":2,"Flags":0},"TargetOriginId":{"Type":4,"Flags":1},"TrustedKeyGroups":{"Type":72,"Flags":0},"TrustedSigners":{"Type":73,"Flags":0},"ViewerProtocolPolicy":{"Type":4,"Flags":1}}}},{"2":{"Name":"DistributionConfig","Properties":{"Aliases":{"Type":74,"Flags":0},"CNAMEs":{"Type":75,"Flags":0},"CacheBehaviors":{"Type":76,"Flags":0},"Comment":{"Type":4,"Flags":0},"ContinuousDeploymentPolicyId":{"Type":4,"Flags":0},"CustomErrorResponses":{"Type":77,"Flags":0},"CustomOrigin":{"Type":44,"Flags":0},"DefaultCacheBehavior":{"Type":38,"Flags":1},"DefaultRootObject":{"Type":4,"Flags":0},"Enabled":{"Type":2,"Flags":1},"HttpVersion":{"Type":4,"Flags":0},"IPV6Enabled":{"Type":2,"Flags":0},"Logging":{"Type":46,"Flags":0},"OriginGroups":{"Type":53,"Flags":0},"Origins":{"Type":78,"Flags":0},"PriceClass":{"Type":4,"Flags":0},"Restrictions":{"Type":55,"Flags":0},"S3Origin":{"Type":45,"Flags":0},"Staging":{"Type":2,"Flags":0},"ViewerCertificate":{"Type":59,"Flags":0},"WebACLId":{"Type":4,"Flags":0}}}},{"2":{"Name":"ForwardedValues","Properties":{"Cookies":{"Type":35,"Flags":0},"Headers":{"Type":79,"Flags":0},"QueryString":{"Type":2,"Flags":1},"QueryStringCacheKeys":{"Type":80,"Flags":0}}}},{"2":{"Name":"FunctionAssociation","Properties":{"EventType":{"Type":4,"Flags":0},"FunctionARN":{"Type":4,"Flags":0}}}},{"2":{"Name":"GeoRestriction","Properties":{"Locations":{"Type":81,"Flags":0},"RestrictionType":{"Type":4,"Flags":1}}}},{"2":{"Name":"LambdaFunctionAssociation","Properties":{"EventType":{"Type":4,"Flags":0},"IncludeBody":{"Type":2,"Flags":0},"LambdaFunctionARN":{"Type":4,"Flags":0}}}},{"2":{"Name":"LegacyCustomOrigin","Properties":{"DNSName":{"Type":4,"Flags":1},"HTTPPort":{"Type":3,"Flags":0},"HTTPSPort":{"Type":3,"Flags":0},"OriginProtocolPolicy":{"Type":4,"Flags":1},"OriginSSLProtocols":{"Type":82,"Flags":1}}}},{"2":{"Name":"LegacyS3Origin","Properties":{"DNSName":{"Type":4,"Flags":1},"OriginAccessIdentity":{"Type":4,"Flags":0}}}},{"2":{"Name":"Logging","Properties":{"Bucket":{"Type":4,"Flags":1},"IncludeCookies":{"Type":2,"Flags":0},"Prefix":{"Type":4,"Flags":0}}}},{"2":{"Name":"Origin","Properties":{"ConnectionAttempts":{"Type":3,"Flags":0},"ConnectionTimeout":{"Type":3,"Flags":0},"CustomOriginConfig":{"Type":37,"Flags":0},"DomainName":{"Type":4,"Flags":1},"Id":{"Type":4,"Flags":17},"OriginAccessControlId":{"Type":4,"Flags":0},"OriginCustomHeaders":{"Type":83,"Flags":0},"OriginPath":{"Type":4,"Flags":0},"OriginShield":{"Type":54,"Flags":0},"S3OriginConfig":{"Type":56,"Flags":0}}}},{"2":{"Name":"OriginCustomHeader","Properties":{"HeaderName":{"Type":4,"Flags":1},"HeaderValue":{"Type":4,"Flags":1}}}},{"2":{"Name":"OriginGroup","Properties":{"FailoverCriteria":{"Type":50,"Flags":1},"Id":{"Type":4,"Flags":17},"Members":{"Type":52,"Flags":1}}}},{"2":{"Name":"OriginGroupFailoverCriteria","Properties":{"StatusCodes":{"Type":57,"Flags":1}}}},{"2":{"Name":"OriginGroupMember","Properties":{"OriginId":{"Type":4,"Flags":1}}}},{"2":{"Name":"OriginGroupMembers","Properties":{"Items":{"Type":84,"Flags":1},"Quantity":{"Type":3,"Flags":1}}}},{"2":{"Name":"OriginGroups","Properties":{"Items":{"Type":85,"Flags":0},"Quantity":{"Type":3,"Flags":1}}}},{"2":{"Name":"OriginShield","Properties":{"Enabled":{"Type":2,"Flags":0},"OriginShieldRegion":{"Type":4,"Flags":0}}}},{"2":{"Name":"Restrictions","Properties":{"GeoRestriction":{"Type":42,"Flags":1}}}},{"2":{"Name":"S3OriginConfig","Properties":{"OriginAccessIdentity":{"Type":4,"Flags":0}}}},{"2":{"Name":"StatusCodes","Properties":{"Items":{"Type":86,"Flags":1},"Quantity":{"Type":3,"Flags":1}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"ViewerCertificate","Properties":{"AcmCertificateArn":{"Type":4,"Flags":0},"CloudFrontDefaultCertificate":{"Type":2,"Flags":0},"IamCertificateId":{"Type":4,"Flags":0},"MinimumProtocolVersion":{"Type":4,"Flags":0},"SslSupportMethod":{"Type":4,"Flags":0}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":41}},{"3":{"ItemType":43}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":41}},{"3":{"ItemType":43}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":34}},{"3":{"ItemType":36}},{"3":{"ItemType":47}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":48}},{"3":{"ItemType":51}},{"3":{"ItemType":49}},{"3":{"ItemType":3}},{"2":{"Name":"AWS.CloudFront/DistributionProperties","Properties":{"DistributionConfig":{"Type":39,"Flags":1},"DomainName":{"Type":4,"Flags":2},"Id":{"Type":4,"Flags":18},"Tags":{"Type":88,"Flags":0}}}},{"3":{"ItemType":58}},{"2":{"Name":"AWS.CloudFront/Distribution","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":87,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.CloudFront/Distribution@default","ScopeType":0,"Body":89}},{"2":{"Name":"FunctionConfig","Properties":{"Comment":{"Type":4,"Flags":1},"KeyValueStoreAssociations":{"Type":94,"Flags":0},"Runtime":{"Type":4,"Flags":1}}}},{"2":{"Name":"FunctionMetadata","Properties":{"FunctionARN":{"Type":4,"Flags":18}}}},{"2":{"Name":"KeyValueStoreAssociation","Properties":{"KeyValueStoreARN":{"Type":4,"Flags":1}}}},{"3":{"ItemType":93}},{"2":{"Name":"AWS.CloudFront/FunctionProperties","Properties":{"AutoPublish":{"Type":2,"Flags":4},"FunctionARN":{"Type":4,"Flags":18},"FunctionCode":{"Type":4,"Flags":1},"FunctionConfig":{"Type":91,"Flags":1},"FunctionMetadata":{"Type":92,"Flags":0},"Name":{"Type":4,"Flags":1},"Stage":{"Type":4,"Flags":2}}}},{"2":{"Name":"AWS.CloudFront/Function","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":95,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.CloudFront/Function@default","ScopeType":0,"Body":96}},{"2":{"Name":"KeyGroupConfig","Properties":{"Comment":{"Type":4,"Flags":0},"Items":{"Type":99,"Flags":1},"Name":{"Type":4,"Flags":1}}}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.CloudFront/KeyGroupProperties","Properties":{"Id":{"Type":4,"Flags":18},"KeyGroupConfig":{"Type":98,"Flags":1},"LastModifiedTime":{"Type":4,"Flags":2}}}},{"2":{"Name":"AWS.CloudFront/KeyGroup","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":100,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.CloudFront/KeyGroup@default","ScopeType":0,"Body":101}},{"2":{"Name":"ImportSource","Properties":{"SourceArn":{"Type":4,"Flags":1},"SourceType":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.CloudFront/KeyValueStoreProperties","Properties":{"Arn":{"Type":4,"Flags":2},"Comment":{"Type":4,"Flags":0},"Id":{"Type":4,"Flags":2},"ImportSource":{"Type":103,"Flags":4},"Name":{"Type":4,"Flags":17},"Status":{"Type":4,"Flags":2}}}},{"2":{"Name":"AWS.CloudFront/KeyValueStore","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":104,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.CloudFront/KeyValueStore@default","ScopeType":0,"Body":105}},{"2":{"Name":"OriginAccessControlConfig","Properties":{"Description":{"Type":4,"Flags":0},"Name":{"Type":4,"Flags":1},"OriginAccessControlOriginType":{"Type":4,"Flags":1},"SigningBehavior":{"Type":4,"Flags":1},"SigningProtocol":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.CloudFront/OriginAccessControlProperties","Properties":{"Id":{"Type":4,"Flags":18},"OriginAccessControlConfig":{"Type":107,"Flags":1}}}},{"2":{"Name":"AWS.CloudFront/OriginAccessControl","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":108,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.CloudFront/OriginAccessControl@default","ScopeType":0,"Body":109}},{"2":{"Name":"CookiesConfig","Properties":{"CookieBehavior":{"Type":4,"Flags":1},"Cookies":{"Type":115,"Flags":0}}}},{"2":{"Name":"HeadersConfig","Properties":{"HeaderBehavior":{"Type":4,"Flags":1},"Headers":{"Type":116,"Flags":0}}}},{"2":{"Name":"OriginRequestPolicyConfig","Properties":{"Comment":{"Type":4,"Flags":0},"CookiesConfig":{"Type":111,"Flags":1},"HeadersConfig":{"Type":112,"Flags":1},"Name":{"Type":4,"Flags":1},"QueryStringsConfig":{"Type":114,"Flags":1}}}},{"2":{"Name":"QueryStringsConfig","Properties":{"QueryStringBehavior":{"Type":4,"Flags":1},"QueryStrings":{"Type":117,"Flags":0}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.CloudFront/OriginRequestPolicyProperties","Properties":{"Id":{"Type":4,"Flags":18},"LastModifiedTime":{"Type":4,"Flags":2},"OriginRequestPolicyConfig":{"Type":113,"Flags":1}}}},{"2":{"Name":"AWS.CloudFront/OriginRequestPolicy","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":118,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.CloudFront/OriginRequestPolicy@default","ScopeType":0,"Body":119}},{"2":{"Name":"PublicKeyConfig","Properties":{"CallerReference":{"Type":4,"Flags":1},"Comment":{"Type":4,"Flags":0},"EncodedKey":{"Type":4,"Flags":1},"Name":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.CloudFront/PublicKeyProperties","Properties":{"CreatedTime":{"Type":4,"Flags":2},"Id":{"Type":4,"Flags":18},"PublicKeyConfig":{"Type":121,"Flags":1}}}},{"2":{"Name":"AWS.CloudFront/PublicKey","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":122,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.CloudFront/PublicKey@default","ScopeType":0,"Body":123}},{"2":{"Name":"EndPoint","Properties":{"KinesisStreamConfig":{"Type":126,"Flags":1},"StreamType":{"Type":4,"Flags":1}}}},{"2":{"Name":"KinesisStreamConfig","Properties":{"RoleArn":{"Type":4,"Flags":1},"StreamArn":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.CloudFront/RealtimeLogConfigProperties","Properties":{"Arn":{"Type":4,"Flags":18},"EndPoints":{"Type":128,"Flags":1},"Fields":{"Type":129,"Flags":1},"Name":{"Type":4,"Flags":1},"SamplingRate":{"Type":3,"Flags":1}}}},{"3":{"ItemType":125}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.CloudFront/RealtimeLogConfig","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":127,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.CloudFront/RealtimeLogConfig@default","ScopeType":0,"Body":130}},{"2":{"Name":"AccessControlAllowHeaders","Properties":{"Items":{"Type":150,"Flags":1}}}},{"2":{"Name":"AccessControlAllowMethods","Properties":{"Items":{"Type":151,"Flags":1}}}},{"2":{"Name":"AccessControlAllowOrigins","Properties":{"Items":{"Type":152,"Flags":1}}}},{"2":{"Name":"AccessControlExposeHeaders","Properties":{"Items":{"Type":153,"Flags":1}}}},{"2":{"Name":"ContentSecurityPolicy","Properties":{"ContentSecurityPolicy":{"Type":4,"Flags":1},"Override":{"Type":2,"Flags":1}}}},{"2":{"Name":"ContentTypeOptions","Properties":{"Override":{"Type":2,"Flags":1}}}},{"2":{"Name":"CorsConfig","Properties":{"AccessControlAllowCredentials":{"Type":2,"Flags":1},"AccessControlAllowHeaders":{"Type":132,"Flags":1},"AccessControlAllowMethods":{"Type":133,"Flags":1},"AccessControlAllowOrigins":{"Type":134,"Flags":1},"AccessControlExposeHeaders":{"Type":135,"Flags":0},"AccessControlMaxAgeSec":{"Type":3,"Flags":0},"OriginOverride":{"Type":2,"Flags":1}}}},{"2":{"Name":"CustomHeader","Properties":{"Header":{"Type":4,"Flags":1},"Override":{"Type":2,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"CustomHeadersConfig","Properties":{"Items":{"Type":154,"Flags":1}}}},{"2":{"Name":"FrameOptions","Properties":{"FrameOption":{"Type":4,"Flags":1},"Override":{"Type":2,"Flags":1}}}},{"2":{"Name":"ReferrerPolicy","Properties":{"Override":{"Type":2,"Flags":1},"ReferrerPolicy":{"Type":4,"Flags":1}}}},{"2":{"Name":"RemoveHeader","Properties":{"Header":{"Type":4,"Flags":1}}}},{"2":{"Name":"RemoveHeadersConfig","Properties":{"Items":{"Type":155,"Flags":1}}}},{"2":{"Name":"ResponseHeadersPolicyConfig","Properties":{"Comment":{"Type":4,"Flags":0},"CorsConfig":{"Type":138,"Flags":0},"CustomHeadersConfig":{"Type":140,"Flags":0},"Name":{"Type":4,"Flags":1},"RemoveHeadersConfig":{"Type":144,"Flags":0},"SecurityHeadersConfig":{"Type":146,"Flags":0},"ServerTimingHeadersConfig":{"Type":147,"Flags":0}}}},{"2":{"Name":"SecurityHeadersConfig","Properties":{"ContentSecurityPolicy":{"Type":136,"Flags":0},"ContentTypeOptions":{"Type":137,"Flags":0},"FrameOptions":{"Type":141,"Flags":0},"ReferrerPolicy":{"Type":142,"Flags":0},"StrictTransportSecurity":{"Type":148,"Flags":0},"XSSProtection":{"Type":149,"Flags":0}}}},{"2":{"Name":"ServerTimingHeadersConfig","Properties":{"Enabled":{"Type":2,"Flags":1},"SamplingRate":{"Type":3,"Flags":0}}}},{"2":{"Name":"StrictTransportSecurity","Properties":{"AccessControlMaxAgeSec":{"Type":3,"Flags":1},"IncludeSubdomains":{"Type":2,"Flags":0},"Override":{"Type":2,"Flags":1},"Preload":{"Type":2,"Flags":0}}}},{"2":{"Name":"XSSProtection","Properties":{"ModeBlock":{"Type":2,"Flags":0},"Override":{"Type":2,"Flags":1},"Protection":{"Type":2,"Flags":1},"ReportUri":{"Type":4,"Flags":0}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":139}},{"3":{"ItemType":143}},{"2":{"Name":"AWS.CloudFront/ResponseHeadersPolicyProperties","Properties":{"Id":{"Type":4,"Flags":18},"LastModifiedTime":{"Type":4,"Flags":2},"ResponseHeadersPolicyConfig":{"Type":145,"Flags":1}}}},{"2":{"Name":"AWS.CloudFront/ResponseHeadersPolicy","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":156,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.CloudFront/ResponseHeadersPolicy@default","ScopeType":0,"Body":157}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "CachePolicyConfig", + "properties": { + "Comment": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "DefaultTTL": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "MaxTTL": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "MinTTL": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "ParametersInCacheKeyAndForwardedToOrigin": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CookiesConfig", + "properties": { + "CookieBehavior": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Cookies": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "HeadersConfig", + "properties": { + "HeaderBehavior": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Headers": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ParametersInCacheKeyAndForwardedToOrigin", + "properties": { + "CookiesConfig": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "EnableAcceptEncodingBrotli": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "EnableAcceptEncodingGzip": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + }, + "HeadersConfig": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "QueryStringsConfig": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "QueryStringsConfig", + "properties": { + "QueryStringBehavior": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "QueryStrings": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.CloudFront/CachePolicyProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.CloudFront/CachePolicyProperties", + "properties": { + "CachePolicyConfig": { + "type": { + "$ref": "#/0" + }, + "flags": 1 + }, + "Id": { + "type": { + "$ref": "#/5" + }, + "flags": 18 + }, + "LastModifiedTime": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.CloudFront/CachePolicy", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/12" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.CloudFront/CachePolicy@default", + "scopeType": 0, + "body": { + "$ref": "#/13" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "CloudFrontOriginAccessIdentityConfig", + "properties": { + "Comment": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.CloudFront/CloudFrontOriginAccessIdentityProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.CloudFront/CloudFrontOriginAccessIdentityProperties", + "properties": { + "CloudFrontOriginAccessIdentityConfig": { + "type": { + "$ref": "#/15" + }, + "flags": 1 + }, + "Id": { + "type": { + "$ref": "#/5" + }, + "flags": 18 + }, + "S3CanonicalUserId": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.CloudFront/CloudFrontOriginAccessIdentity", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/17" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.CloudFront/CloudFrontOriginAccessIdentity@default", + "scopeType": 0, + "body": { + "$ref": "#/18" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "ContinuousDeploymentPolicyConfig", + "properties": { + "Enabled": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + }, + "SingleHeaderPolicyConfig": { + "type": { + "$ref": "#/25" + }, + "flags": 0 + }, + "SingleWeightPolicyConfig": { + "type": { + "$ref": "#/26" + }, + "flags": 0 + }, + "StagingDistributionDnsNames": { + "type": { + "$ref": "#/27" + }, + "flags": 1 + }, + "TrafficConfig": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SessionStickinessConfig", + "properties": { + "IdleTTL": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "MaximumTTL": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "SingleHeaderConfig", + "properties": { + "Header": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "SingleWeightConfig", + "properties": { + "SessionStickinessConfig": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "Weight": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TrafficConfig", + "properties": { + "SingleHeaderConfig": { + "type": { + "$ref": "#/22" + }, + "flags": 0 + }, + "SingleWeightConfig": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ContinuousDeploymentPolicy_SingleHeaderPolicyConfig", + "properties": { + "Header": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ContinuousDeploymentPolicy_SingleWeightPolicyConfig", + "properties": { + "SessionStickinessConfig": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "Weight": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.CloudFront/ContinuousDeploymentPolicyProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.CloudFront/ContinuousDeploymentPolicyProperties", + "properties": { + "ContinuousDeploymentPolicyConfig": { + "type": { + "$ref": "#/20" + }, + "flags": 1 + }, + "Id": { + "type": { + "$ref": "#/5" + }, + "flags": 18 + }, + "LastModifiedTime": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.CloudFront/ContinuousDeploymentPolicy", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/29" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.CloudFront/ContinuousDeploymentPolicy@default", + "scopeType": 0, + "body": { + "$ref": "#/30" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "CacheBehavior", + "properties": { + "AllowedMethods": { + "type": { + "$ref": "#/58" + }, + "flags": 0, + "description": "A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices:\n + CloudFront forwards only ``GET`` and ``HEAD`` requests.\n + CloudFront forwards only ``GET``, ``HEAD``, and ``OPTIONS`` requests.\n + CloudFront forwards ``GET, HEAD, OPTIONS, PUT, PATCH, POST``, and ``DELETE`` requests.\n \n If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin." + }, + "CachePolicyId": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The unique identifier of the cache policy that is attached to this cache behavior. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*.\n A ``CacheBehavior`` must include either a ``CachePolicyId`` or ``ForwardedValues``. We recommend that you use a ``CachePolicyId``." + }, + "CachedMethods": { + "type": { + "$ref": "#/59" + }, + "flags": 0, + "description": "A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:\n + CloudFront caches responses to ``GET`` and ``HEAD`` requests.\n + CloudFront caches responses to ``GET``, ``HEAD``, and ``OPTIONS`` requests.\n \n If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly." + }, + "Compress": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see [Serving Compressed Files](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/ServingCompressedFiles.html) in the *Amazon CloudFront Developer Guide*." + }, + "DefaultTTL": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "This field is deprecated. We recommend that you use the ``DefaultTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*.\n The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as ``Cache-Control max-age``, ``Cache-Control s-maxage``, and ``Expires`` to objects. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*." + }, + "FieldLevelEncryptionId": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The value of ``ID`` for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for this cache behavior." + }, + "ForwardedValues": { + "type": { + "$ref": "#/38" + }, + "flags": 0, + "description": "This field is deprecated. We recommend that you use a cache policy or an origin request 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 *Amazon CloudFront Developer Guide*.\n If you want to include values in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*.\n If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) or [Using the managed origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) in the *Amazon CloudFront Developer Guide*.\n A ``CacheBehavior`` must include either a ``CachePolicyId`` or ``ForwardedValues``. We recommend that you use a ``CachePolicyId``.\n A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers." + }, + "FunctionAssociations": { + "type": { + "$ref": "#/60" + }, + "flags": 0, + "description": "A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the ``LIVE`` stage to associate them with a cache behavior." + }, + "LambdaFunctionAssociations": { + "type": { + "$ref": "#/61" + }, + "flags": 0, + "description": "A complex type that contains zero or more Lambda@Edge function associations for a cache behavior." + }, + "MaxTTL": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "This field is deprecated. We recommend that you use the ``MaxTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*.\n The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as ``Cache-Control max-age``, ``Cache-Control s-maxage``, and ``Expires`` to objects. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*." + }, + "MinTTL": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "This field is deprecated. We recommend that you use the ``MinTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*.\n The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.\n You must specify ``0`` for ``MinTTL`` if you configure CloudFront to forward all headers to your origin (under ``Headers``, if you specify ``1`` for ``Quantity`` and ``*`` for ``Name``)." + }, + "OriginRequestPolicyId": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The unique identifier of the origin request policy that is attached to this cache behavior. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) or [Using the managed origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) in the *Amazon CloudFront Developer Guide*." + }, + "PathPattern": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The pattern (for example, ``images/*.jpg``) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution.\n You can optionally include a slash (``/``) at the beginning of the path pattern. For example, ``/images/*.jpg``. CloudFront behavior is the same with or without the leading ``/``.\n The path pattern for the default cache behavior is ``*`` and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior.\n For 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*." + }, + "RealtimeLogConfigArn": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see [Real-time logs](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html) in the *Amazon CloudFront Developer Guide*." + }, + "ResponseHeadersPolicyId": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The identifier for a response headers policy." + }, + "SmoothStreaming": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify ``true``; if not, specify ``false``. If you specify ``true`` for ``SmoothStreaming``, you can still distribute other content using this cache behavior if the content matches the value of ``PathPattern``." + }, + "TargetOriginId": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The value of ``ID`` for the origin that you want CloudFront to route requests to when they match this cache behavior." + }, + "TrustedKeyGroups": { + "type": { + "$ref": "#/62" + }, + "flags": 0, + "description": "A list of key groups that CloudFront can use to validate signed URLs or signed cookies.\n When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*." + }, + "TrustedSigners": { + "type": { + "$ref": "#/63" + }, + "flags": 0, + "description": "We recommend using ``TrustedKeyGroups`` instead of ``TrustedSigners``.\n A list of AWS-account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.\n When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer's AWS-account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*." + }, + "ViewerProtocolPolicy": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The protocol that viewers can use to access the files in the origin specified by ``TargetOriginId`` when a request matches the path pattern in ``PathPattern``. You can specify the following options:\n + ``allow-all``: Viewers can use HTTP or HTTPS.\n + ``redirect-to-https``: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.\n + ``https-only``: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).\n \n For more information about requiring the HTTPS protocol, see [Requiring HTTPS Between Viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-viewers-to-cloudfront.html) in the *Amazon CloudFront Developer Guide*.\n The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see [Managing Cache Expiration](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*." + } + } + }, + { + "$type": "ObjectType", + "name": "Cookies", + "properties": { + "Forward": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.\n If you want to include cookies in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*.\n If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*.\n Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the ``WhitelistedNames`` complex type.\n Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the ``Forward`` element." + }, + "WhitelistedNames": { + "type": { + "$ref": "#/64" + }, + "flags": 0, + "description": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.\n If you want to include cookies in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*.\n If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*.\n Required if you specify ``whitelist`` for the value of ``Forward``. A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies.\n If you specify ``all`` or ``none`` for the value of ``Forward``, omit ``WhitelistedNames``. If you change the value of ``Forward`` from ``whitelist`` to ``all`` or ``none`` and you don't delete the ``WhitelistedNames`` element and its child elements, CloudFront deletes them automatically.\n For the current limit on the number of cookie names that you can whitelist for each cache behavior, see [CloudFront Limits](https://docs.aws.amazon.com/general/latest/gr/xrefaws_service_limits.html#limits_cloudfront) in the *General Reference*." + } + } + }, + { + "$type": "ObjectType", + "name": "CustomErrorResponse", + "properties": { + "ErrorCachingMinTTL": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in ``ErrorCode``. When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available.\n For more information, see [Customizing Error Responses](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html) in the *Amazon CloudFront Developer Guide*." + }, + "ErrorCode": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "The HTTP status code for which you want to specify a custom error page and/or a caching duration." + }, + "ResponseCode": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example:\n + Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute ``200``, the response typically won't be intercepted.\n + If you don't care about distinguishing among different client errors or server errors, you can specify ``400`` or ``500`` as the ``ResponseCode`` for all 4xx or 5xx errors.\n + You might want to return a ``200`` status code (OK) and static website so your customers don't know that your website is down.\n \n If you specify a value for ``ResponseCode``, you must also specify a value for ``ResponsePagePath``." + }, + "ResponsePagePath": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by ``ErrorCode``, for example, ``/4xx-errors/403-forbidden.html``. If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true:\n + The value of ``PathPattern`` matches the path to your custom error messages. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named ``/4xx-errors``. Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example, ``/4xx-errors/*``.\n + The value of ``TargetOriginId`` specifies the value of the ``ID`` element for the origin that contains your custom error pages.\n \n If you specify a value for ``ResponsePagePath``, you must also specify a value for ``ResponseCode``.\n We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable." + } + } + }, + { + "$type": "ObjectType", + "name": "CustomOriginConfig", + "properties": { + "HTTPPort": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on." + }, + "HTTPSPort": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on." + }, + "OriginKeepaliveTimeout": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 5 seconds.\n For more information, see [Origin Keep-alive Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginKeepaliveTimeout) in the *Amazon CloudFront Developer Guide*." + }, + "OriginProtocolPolicy": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid values are:\n + ``http-only`` ? CloudFront always uses HTTP to connect to the origin.\n + ``match-viewer`` ? CloudFront connects to the origin using the same protocol that the viewer used to connect to CloudFront.\n + ``https-only`` ? CloudFront always uses HTTPS to connect to the origin." + }, + "OriginReadTimeout": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the *origin response timeout*. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 30 seconds.\n For more information, see [Origin Response Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginResponseTimeout) in the *Amazon CloudFront Developer Guide*." + }, + "OriginSSLProtocols": { + "type": { + "$ref": "#/65" + }, + "flags": 0, + "description": "Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS. Valid values include ``SSLv3``, ``TLSv1``, ``TLSv1.1``, and ``TLSv1.2``.\n For more information, see [Minimum Origin SSL Protocol](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginSSLProtocols) in the *Amazon CloudFront Developer Guide*." + } + } + }, + { + "$type": "ObjectType", + "name": "DefaultCacheBehavior", + "properties": { + "AllowedMethods": { + "type": { + "$ref": "#/66" + }, + "flags": 0, + "description": "A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices:\n + CloudFront forwards only ``GET`` and ``HEAD`` requests.\n + CloudFront forwards only ``GET``, ``HEAD``, and ``OPTIONS`` requests.\n + CloudFront forwards ``GET, HEAD, OPTIONS, PUT, PATCH, POST``, and ``DELETE`` requests.\n \n If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin." + }, + "CachePolicyId": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The unique identifier of the cache policy that is attached to the default cache behavior. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*.\n A ``DefaultCacheBehavior`` must include either a ``CachePolicyId`` or ``ForwardedValues``. We recommend that you use a ``CachePolicyId``." + }, + "CachedMethods": { + "type": { + "$ref": "#/67" + }, + "flags": 0, + "description": "A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:\n + CloudFront caches responses to ``GET`` and ``HEAD`` requests.\n + CloudFront caches responses to ``GET``, ``HEAD``, and ``OPTIONS`` requests.\n \n If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly." + }, + "Compress": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify ``true``; if not, specify ``false``. For more information, see [Serving Compressed Files](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/ServingCompressedFiles.html) in the *Amazon CloudFront Developer Guide*." + }, + "DefaultTTL": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "This field is deprecated. We recommend that you use the ``DefaultTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*.\n The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as ``Cache-Control max-age``, ``Cache-Control s-maxage``, and ``Expires`` to objects. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*." + }, + "FieldLevelEncryptionId": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The value of ``ID`` for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for the default cache behavior." + }, + "ForwardedValues": { + "type": { + "$ref": "#/38" + }, + "flags": 0, + "description": "This field is deprecated. We recommend that you use a cache policy or an origin request 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 *Amazon CloudFront Developer Guide*.\n If you want to include values in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*.\n If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) or [Using the managed origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) in the *Amazon CloudFront Developer Guide*.\n A ``DefaultCacheBehavior`` must include either a ``CachePolicyId`` or ``ForwardedValues``. We recommend that you use a ``CachePolicyId``.\n A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers." + }, + "FunctionAssociations": { + "type": { + "$ref": "#/68" + }, + "flags": 0, + "description": "A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the ``LIVE`` stage to associate them with a cache behavior." + }, + "LambdaFunctionAssociations": { + "type": { + "$ref": "#/69" + }, + "flags": 0, + "description": "A complex type that contains zero or more Lambda@Edge function associations for a cache behavior." + }, + "MaxTTL": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "This field is deprecated. We recommend that you use the ``MaxTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*.\n The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as ``Cache-Control max-age``, ``Cache-Control s-maxage``, and ``Expires`` to objects. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*." + }, + "MinTTL": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "This field is deprecated. We recommend that you use the ``MinTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*.\n The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.\n You must specify ``0`` for ``MinTTL`` if you configure CloudFront to forward all headers to your origin (under ``Headers``, if you specify ``1`` for ``Quantity`` and ``*`` for ``Name``)." + }, + "OriginRequestPolicyId": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The unique identifier of the origin request policy that is attached to the default cache behavior. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) or [Using the managed origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) in the *Amazon CloudFront Developer Guide*." + }, + "RealtimeLogConfigArn": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see [Real-time logs](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html) in the *Amazon CloudFront Developer Guide*." + }, + "ResponseHeadersPolicyId": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The identifier for a response headers policy." + }, + "SmoothStreaming": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify ``true``; if not, specify ``false``. If you specify ``true`` for ``SmoothStreaming``, you can still distribute other content using this cache behavior if the content matches the value of ``PathPattern``." + }, + "TargetOriginId": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The value of ``ID`` for the origin that you want CloudFront to route requests to when they use the default cache behavior." + }, + "TrustedKeyGroups": { + "type": { + "$ref": "#/70" + }, + "flags": 0, + "description": "A list of key groups that CloudFront can use to validate signed URLs or signed cookies.\n When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*." + }, + "TrustedSigners": { + "type": { + "$ref": "#/71" + }, + "flags": 0, + "description": "We recommend using ``TrustedKeyGroups`` instead of ``TrustedSigners``.\n A list of AWS-account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.\n When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer's AWS-account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*." + }, + "ViewerProtocolPolicy": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The protocol that viewers can use to access the files in the origin specified by ``TargetOriginId`` when a request matches the path pattern in ``PathPattern``. You can specify the following options:\n + ``allow-all``: Viewers can use HTTP or HTTPS.\n + ``redirect-to-https``: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.\n + ``https-only``: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).\n \n For more information about requiring the HTTPS protocol, see [Requiring HTTPS Between Viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-viewers-to-cloudfront.html) in the *Amazon CloudFront Developer Guide*.\n The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see [Managing Cache Expiration](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*." + } + } + }, + { + "$type": "ObjectType", + "name": "DistributionConfig", + "properties": { + "Aliases": { + "type": { + "$ref": "#/72" + }, + "flags": 0, + "description": "A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." + }, + "CNAMEs": { + "type": { + "$ref": "#/73" + }, + "flags": 0, + "description": "" + }, + "CacheBehaviors": { + "type": { + "$ref": "#/74" + }, + "flags": 0, + "description": "A complex type that contains zero or more ``CacheBehavior`` elements." + }, + "Comment": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "A comment to describe the distribution. The comment cannot be longer than 128 characters." + }, + "ContinuousDeploymentPolicyId": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The identifier of a continuous deployment policy. For more information, see ``CreateContinuousDeploymentPolicy``." + }, + "CustomErrorResponses": { + "type": { + "$ref": "#/75" + }, + "flags": 0, + "description": "A complex type that controls the following:\n + Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.\n + How long CloudFront caches HTTP status codes in the 4xx and 5xx range.\n \n For more information about custom error pages, see [Customizing Error Responses](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html) in the *Amazon CloudFront Developer Guide*." + }, + "CustomOrigin": { + "type": { + "$ref": "#/42" + }, + "flags": 0, + "description": "" + }, + "DefaultCacheBehavior": { + "type": { + "$ref": "#/36" + }, + "flags": 1, + "description": "A complex type that describes the default cache behavior if you don't specify a ``CacheBehavior`` element or if files don't match any of the values of ``PathPattern`` in ``CacheBehavior`` elements. You must create exactly one default cache behavior." + }, + "DefaultRootObject": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The object that you want CloudFront to request from your origin (for example, ``index.html``) when a viewer requests the root URL for your distribution (``https://www.example.com``) instead of an object in your distribution (``https://www.example.com/product-description.html``). Specifying a default root object avoids exposing the contents of your distribution.\n Specify only the object name, for example, ``index.html``. Don't add a ``/`` before the object name.\n If you don't want to specify a default root object when you create a distribution, include an empty ``DefaultRootObject`` element.\n To delete the default root object from an existing distribution, update the distribution configuration and include an empty ``DefaultRootObject`` element.\n To replace the default root object, update the distribution configuration and specify the new object.\n For more information about the default root object, see [Creating a Default Root Object](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DefaultRootObject.html) in the *Amazon CloudFront Developer Guide*." + }, + "Enabled": { + "type": { + "$ref": "#/9" + }, + "flags": 1, + "description": "From this field, you can enable or disable the selected distribution." + }, + "HttpVersion": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "(Optional) Specify the maximum HTTP version(s) that you want viewers to use to communicate with CF. The default value for new distributions is ``http1.1``.\n For viewers and CF to use HTTP/2, viewers must support TLSv1.2 or later, and must support Server Name Indication (SNI).\n For viewers and CF to use HTTP/3, viewers must support TLSv1.3 and Server Name Indication (SNI). CF supports HTTP/3 connection migration to allow the viewer to switch networks without losing connection. For more information about connection migration, see [Connection Migration](https://docs.aws.amazon.com/https://www.rfc-editor.org/rfc/rfc9000.html#name-connection-migration) at RFC 9000. For more information about supported TLSv1.3 ciphers, see [Supported protocols and ciphers between viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html)." + }, + "IPV6Enabled": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify ``true``. If you specify ``false``, CloudFront responds to IPv6 DNS requests with the DNS response code ``NOERROR`` and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution.\n In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the ``IpAddress`` parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see [Creating a Signed URL Using a Custom Policy](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-creating-signed-url-custom-policy.html) in the *Amazon CloudFront Developer Guide*.\n If you're using an R53AWSIntlong alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true:\n + You enable IPv6 for the distribution\n + You're using alternate domain names in the URLs for your objects\n \n For more information, see [Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-to-cloudfront-distribution.html) in the *Developer Guide*.\n If you created a CNAME resource record set, either with R53AWSIntlong or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request." + }, + "Logging": { + "type": { + "$ref": "#/44" + }, + "flags": 0, + "description": "A complex type that controls whether access logs are written for the distribution.\n For more information about logging, see [Access Logs](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/AccessLogs.html) in the *Amazon CloudFront Developer Guide*." + }, + "OriginGroups": { + "type": { + "$ref": "#/51" + }, + "flags": 0, + "description": "A complex type that contains information about origin groups for this distribution." + }, + "Origins": { + "type": { + "$ref": "#/76" + }, + "flags": 0, + "description": "A complex type that contains information about origins for this distribution." + }, + "PriceClass": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify ``PriceClass_All``, CloudFront responds to requests for your objects from all CloudFront edge locations.\n If you specify a price class other than ``PriceClass_All``, CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance.\n For more information about price classes, see [Choosing the Price Class for a CloudFront Distribution](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PriceClass.html) in the *Amazon CloudFront Developer Guide*. For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see [Amazon CloudFront Pricing](https://docs.aws.amazon.com/cloudfront/pricing/)." + }, + "Restrictions": { + "type": { + "$ref": "#/53" + }, + "flags": 0, + "description": "A complex type that identifies ways in which you want to restrict distribution of your content." + }, + "S3Origin": { + "type": { + "$ref": "#/43" + }, + "flags": 0, + "description": "" + }, + "Staging": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "A Boolean that indicates whether this is a staging distribution. When this value is ``true``, this is a staging distribution. When this value is ``false``, this is not a staging distribution." + }, + "ViewerCertificate": { + "type": { + "$ref": "#/57" + }, + "flags": 0, + "description": "A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers." + }, + "WebACLId": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "A unique identifier that specifies the WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of WAF, use the ACL ARN, for example ``arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a``. To specify a web ACL created using WAF Classic, use the ACL ID, for example ``473e64fd-f30b-4765-81a0-62ad96dd167a``.\n WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about WAF, see the [Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/what-is-aws-waf.html)." + } + } + }, + { + "$type": "ObjectType", + "name": "ForwardedValues", + "properties": { + "Cookies": { + "type": { + "$ref": "#/33" + }, + "flags": 0, + "description": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.\n If you want to include cookies in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*.\n If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*.\n A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see [How CloudFront Forwards, Caches, and Logs Cookies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html) in the *Amazon CloudFront Developer Guide*." + }, + "Headers": { + "type": { + "$ref": "#/77" + }, + "flags": 0, + "description": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.\n If you want to include headers in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*.\n If you want to send headers to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*.\n A complex type that specifies the ``Headers``, if any, that you want CloudFront to forward to the origin for this cache behavior (whitelisted headers). For the headers that you specify, CloudFront also caches separate versions of a specified object that is based on the header values in viewer requests.\n For more information, see [Caching Content Based on Request Headers](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/header-caching.html) in the *Amazon CloudFront Developer Guide*." + }, + "QueryString": { + "type": { + "$ref": "#/9" + }, + "flags": 1, + "description": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.\n If you want to include query strings in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*.\n If you want to send query strings to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*.\n Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of ``QueryString`` and on the values that you specify for ``QueryStringCacheKeys``, if any:\n If you specify true for ``QueryString`` and you don't specify any values for ``QueryStringCacheKeys``, CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.\n If you specify true for ``QueryString`` and you specify one or more values for ``QueryStringCacheKeys``, CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.\n If you specify false for ``QueryString``, CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.\n For more information, see [Configuring CloudFront to Cache Based on Query String Parameters](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/QueryStringParameters.html) in the *Amazon CloudFront Developer Guide*." + }, + "QueryStringCacheKeys": { + "type": { + "$ref": "#/78" + }, + "flags": 0, + "description": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.\n If you want to include query strings in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*.\n If you want to send query strings to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*.\n A complex type that contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior." + } + } + }, + { + "$type": "ObjectType", + "name": "FunctionAssociation", + "properties": { + "EventType": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The event type of the function, either ``viewer-request`` or ``viewer-response``. You cannot use origin-facing event types (``origin-request`` and ``origin-response``) with a CloudFront function." + }, + "FunctionARN": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the function." + } + } + }, + { + "$type": "ObjectType", + "name": "GeoRestriction", + "properties": { + "Locations": { + "type": { + "$ref": "#/79" + }, + "flags": 0, + "description": "A complex type that contains a ``Location`` element for each country in which you want CloudFront either to distribute your content (``whitelist``) or not distribute your content (``blacklist``).\n The ``Location`` element is a two-letter, uppercase country code for a country that you want to include in your ``blacklist`` or ``whitelist``. Include one ``Location`` element for each country.\n CloudFront and ``MaxMind`` both use ``ISO 3166`` country codes. For the current list of countries and the corresponding codes, see ``ISO 3166-1-alpha-2`` code on the *International Organization for Standardization* website. You can also refer to the country list on the CloudFront console, which includes both country names and codes." + }, + "RestrictionType": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The method that you want to use to restrict distribution of your content by country:\n + ``none``: No geo restriction is enabled, meaning access to content is not restricted by client geo location.\n + ``blacklist``: The ``Location`` elements specify the countries in which you don't want CloudFront to distribute your content.\n + ``whitelist``: The ``Location`` elements specify the countries in which you want CloudFront to distribute your content." + } + } + }, + { + "$type": "ObjectType", + "name": "LambdaFunctionAssociation", + "properties": { + "EventType": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "Specifies the event type that triggers a Lambda@Edge function invocation. You can specify the following values:\n + ``viewer-request``: The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache.\n + ``origin-request``: The function executes only when CloudFront sends a request to your origin. When the requested object is in the edge cache, the function doesn't execute.\n + ``origin-response``: The function executes after CloudFront receives a response from the origin and before it caches the object in the response. When the requested object is in the edge cache, the function doesn't execute.\n + ``viewer-response``: The function executes before CloudFront returns the requested object to the viewer. The function executes regardless of whether the object was already in the edge cache.\n If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute." + }, + "IncludeBody": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "A flag that allows a Lambda@Edge function to have read access to the body content. For more information, see [Accessing the Request Body by Choosing the Include Body Option](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/lambda-include-body-access.html) in the Amazon CloudFront Developer Guide." + }, + "LambdaFunctionARN": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The ARN of the Lambda@Edge function. You must specify the ARN of a function version; you can't specify an alias or $LATEST." + } + } + }, + { + "$type": "ObjectType", + "name": "LegacyCustomOrigin", + "properties": { + "DNSName": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "" + }, + "HTTPPort": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "" + }, + "HTTPSPort": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "" + }, + "OriginProtocolPolicy": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "" + }, + "OriginSSLProtocols": { + "type": { + "$ref": "#/80" + }, + "flags": 1, + "description": "" + } + } + }, + { + "$type": "ObjectType", + "name": "LegacyS3Origin", + "properties": { + "DNSName": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "" + }, + "OriginAccessIdentity": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "" + } + } + }, + { + "$type": "ObjectType", + "name": "Logging", + "properties": { + "Bucket": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The Amazon S3 bucket to store the access logs in, for example, ``myawslogbucket.s3.amazonaws.com``." + }, + "IncludeCookies": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "Specifies whether you want CloudFront to include cookies in access logs, specify ``true`` for ``IncludeCookies``. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you don't want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify ``false`` for ``IncludeCookies``." + }, + "Prefix": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "An optional string that you want CloudFront to prefix to the access log ``filenames`` for this distribution, for example, ``myprefix/``. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty ``Prefix`` element in the ``Logging`` element." + } + } + }, + { + "$type": "ObjectType", + "name": "Origin", + "properties": { + "ConnectionAttempts": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "The number of times that CloudFront attempts to connect to the origin. The minimum number is 1, the maximum is 3, and the default (if you don't specify otherwise) is 3.\n For a custom origin (including an Amazon S3 bucket that's configured with static website hosting), this value also specifies the number of times that CloudFront attempts to get a response from the origin, in the case of an [Origin Response Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginResponseTimeout).\n For more information, see [Origin Connection Attempts](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#origin-connection-attempts) in the *Amazon CloudFront Developer Guide*." + }, + "ConnectionTimeout": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "The number of seconds that CloudFront waits when trying to establish a connection to the origin. The minimum timeout is 1 second, the maximum is 10 seconds, and the default (if you don't specify otherwise) is 10 seconds.\n For more information, see [Origin Connection Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#origin-connection-timeout) in the *Amazon CloudFront Developer Guide*." + }, + "CustomOriginConfig": { + "type": { + "$ref": "#/35" + }, + "flags": 0, + "description": "Use this type to specify an origin that is not an Amazon S3 bucket, with one exception. If the Amazon S3 bucket is configured with static website hosting, use this type. If the Amazon S3 bucket is not configured with static website hosting, use the ``S3OriginConfig`` type instead." + }, + "DomainName": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The domain name for the origin.\n For 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*." + }, + "Id": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "A unique identifier for the origin. This value must be unique within the distribution.\n Use this value to specify the ``TargetOriginId`` in a ``CacheBehavior`` or ``DefaultCacheBehavior``." + }, + "OriginAccessControlId": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The unique identifier of an origin access control for this origin.\n For more information, see [Restricting access to an Amazon S3 origin](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html) in the *Amazon CloudFront Developer Guide*." + }, + "OriginCustomHeaders": { + "type": { + "$ref": "#/81" + }, + "flags": 0, + "description": "A list of HTTP header names and values that CloudFront adds to the requests that it sends to the origin.\n For more information, see [Adding Custom Headers to Origin Requests](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/add-origin-custom-headers.html) in the *Amazon CloudFront Developer Guide*." + }, + "OriginPath": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin.\n For more information, see [Origin Path](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginPath) in the *Amazon CloudFront Developer Guide*." + }, + "OriginShield": { + "type": { + "$ref": "#/52" + }, + "flags": 0, + "description": "CloudFront Origin Shield. Using Origin Shield can help reduce the load on your origin.\n For more information, see [Using Origin Shield](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html) in the *Amazon CloudFront Developer Guide*." + }, + "S3OriginConfig": { + "type": { + "$ref": "#/54" + }, + "flags": 0, + "description": "Use this type to specify an origin that is an Amazon S3 bucket that is not configured with static website hosting. To specify any other type of origin, including an Amazon S3 bucket that is configured with static website hosting, use the ``CustomOriginConfig`` type instead." + } + } + }, + { + "$type": "ObjectType", + "name": "OriginCustomHeader", + "properties": { + "HeaderName": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The name of a header that you want CloudFront to send to your origin. For more information, see [Adding Custom Headers to Origin Requests](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/forward-custom-headers.html) in the *Amazon CloudFront Developer Guide*." + }, + "HeaderValue": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The value for the header that you specified in the ``HeaderName`` field." + } + } + }, + { + "$type": "ObjectType", + "name": "OriginGroup", + "properties": { + "FailoverCriteria": { + "type": { + "$ref": "#/48" + }, + "flags": 1, + "description": "A complex type that contains information about the failover criteria for an origin group." + }, + "Id": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "The origin group's ID." + }, + "Members": { + "type": { + "$ref": "#/50" + }, + "flags": 1, + "description": "A complex type that contains information about the origins in an origin group." + } + } + }, + { + "$type": "ObjectType", + "name": "OriginGroupFailoverCriteria", + "properties": { + "StatusCodes": { + "type": { + "$ref": "#/55" + }, + "flags": 1, + "description": "The status codes that, when returned from the primary origin, will trigger CloudFront to failover to the second origin." + } + } + }, + { + "$type": "ObjectType", + "name": "OriginGroupMember", + "properties": { + "OriginId": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The ID for an origin in an origin group." + } + } + }, + { + "$type": "ObjectType", + "name": "OriginGroupMembers", + "properties": { + "Items": { + "type": { + "$ref": "#/82" + }, + "flags": 1, + "description": "Items (origins) in an origin group." + }, + "Quantity": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "The number of origins in an origin group." + } + } + }, + { + "$type": "ObjectType", + "name": "OriginGroups", + "properties": { + "Items": { + "type": { + "$ref": "#/83" + }, + "flags": 0, + "description": "The items (origin groups) in a distribution." + }, + "Quantity": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "The number of origin groups." + } + } + }, + { + "$type": "ObjectType", + "name": "OriginShield", + "properties": { + "Enabled": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "A flag that specifies whether Origin Shield is enabled.\n When it's enabled, CloudFront routes all requests through Origin Shield, which can help protect your origin. When it's disabled, CloudFront might send requests directly to your origin from multiple edge locations or regional edge caches." + }, + "OriginShieldRegion": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The AWS-Region for Origin Shield.\n Specify the AWS-Region that has the lowest latency to your origin. To specify a region, use the region code, not the region name. For example, specify the US East (Ohio) region as ``us-east-2``.\n When you enable CloudFront Origin Shield, you must specify the AWS-Region for Origin Shield. For the list of AWS-Regions that you can specify, and for help choosing the best Region for your origin, see [Choosing the for Origin Shield](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html#choose-origin-shield-region) in the *Amazon CloudFront Developer Guide*." + } + } + }, + { + "$type": "ObjectType", + "name": "Restrictions", + "properties": { + "GeoRestriction": { + "type": { + "$ref": "#/40" + }, + "flags": 1, + "description": "A complex type that controls the countries in which your content is distributed. CF determines the location of your users using ``MaxMind`` GeoIP databases. To disable geo restriction, remove the [Restrictions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-restrictions) property from your stack template." + } + } + }, + { + "$type": "ObjectType", + "name": "S3OriginConfig", + "properties": { + "OriginAccessIdentity": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can *only* access objects in an Amazon S3 bucket through CloudFront. The format of the value is:\n origin-access-identity/cloudfront/*ID-of-origin-access-identity* \n where ``ID-of-origin-access-identity`` is the value that CloudFront returned in the ``ID`` element when you created the origin access identity.\n If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty ``OriginAccessIdentity`` element.\n To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty ``OriginAccessIdentity`` element.\n To replace the origin access identity, update the distribution configuration and specify the new origin access identity.\n For more information about the origin access identity, see [Serving Private Content through CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*." + } + } + }, + { + "$type": "ObjectType", + "name": "StatusCodes", + "properties": { + "Items": { + "type": { + "$ref": "#/84" + }, + "flags": 1, + "description": "The items (status codes) for an origin group." + }, + "Quantity": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "The number of status codes." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "A string that contains ``Tag`` key.\n The string length should be between 1 and 128 characters. Valid characters include ``a-z``, ``A-Z``, ``0-9``, space, and the special characters ``_ - . : / = + @``." + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "A string that contains an optional ``Tag`` value.\n The string length should be between 0 and 256 characters. Valid characters include ``a-z``, ``A-Z``, ``0-9``, space, and the special characters ``_ - . : / = + @``." + } + } + }, + { + "$type": "ObjectType", + "name": "ViewerCertificate", + "properties": { + "AcmCertificateArn": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "In CloudFormation, this field name is ``AcmCertificateArn``. Note the different capitalization.\n If the distribution uses ``Aliases`` (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in [(ACM)](https://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html), provide the Amazon Resource Name (ARN) of the ACM certificate. CloudFront only supports ACM certificates in the US East (N. Virginia) Region (``us-east-1``).\n If you specify an ACM certificate ARN, you must also specify values for ``MinimumProtocolVersion`` and ``SSLSupportMethod``. (In CloudFormation, the field name is ``SslSupportMethod``. Note the different capitalization.)" + }, + "CloudFrontDefaultCertificate": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "If the distribution uses the CloudFront domain name such as ``d111111abcdef8.cloudfront.net``, set this field to ``true``.\n If 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 value for one, not both) \n + ``MinimumProtocolVersion`` \n + ``SslSupportMethod``" + }, + "IamCertificateId": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "In CloudFormation, this field name is ``IamCertificateId``. Note the different capitalization.\n If the distribution uses ``Aliases`` (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in [(IAM)](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html), provide the ID of the IAM certificate.\n If you specify an IAM certificate ID, you must also specify values for ``MinimumProtocolVersion`` and ``SSLSupportMethod``. (In CloudFormation, the field name is ``SslSupportMethod``. Note the different capitalization.)" + }, + "MinimumProtocolVersion": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "If the distribution uses ``Aliases`` (alternate domain names or CNAMEs), specify the security policy that you want CloudFront to use for HTTPS connections with viewers. The security policy determines two settings:\n + The minimum SSL/TLS protocol that CloudFront can use to communicate with viewers.\n + The ciphers that CloudFront can use to encrypt the content that it returns to viewers.\n \n For more information, see [Security Policy](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValues-security-policy) and [Supported Protocols and Ciphers Between Viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html#secure-connections-supported-ciphers) in the *Amazon CloudFront Developer Guide*.\n On the CloudFront console, this setting is called *Security Policy*.\n When you're using SNI only (you set ``SSLSupportMethod`` to ``sni-only``), you must specify ``TLSv1`` or higher. (In CloudFormation, the field name is ``SslSupportMethod``. Note the different capitalization.)\n If the distribution uses the CloudFront domain name such as ``d111111abcdef8.cloudfront.net`` (you set ``CloudFrontDefaultCertificate`` to ``true``), CloudFront automatically sets the security policy to ``TLSv1`` regardless of the value that you set here." + }, + "SslSupportMethod": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "In CloudFormation, this field name is ``SslSupportMethod``. Note the different capitalization.\n If the distribution uses ``Aliases`` (alternate domain names or CNAMEs), specify which viewers the distribution accepts HTTPS connections from.\n + ``sni-only`` ? The distribution accepts HTTPS connections from only viewers that support [server name indication (SNI)](https://docs.aws.amazon.com/https://en.wikipedia.org/wiki/Server_Name_Indication). This is recommended. Most browsers and clients support SNI.\n + ``vip`` ? The distribution accepts HTTPS connections from all viewers including those that don't support SNI. This is not recommended, and results in additional monthly charges from CloudFront.\n + ``static-ip`` - Do not specify this value unless your distribution has been enabled for this feature by the CloudFront team. If you have a use case that requires static IP addresses for a distribution, contact CloudFront through the [Center](https://docs.aws.amazon.com/support/home).\n \n If the distribution uses the CloudFront domain name such as ``d111111abcdef8.cloudfront.net``, don't set a value for this field." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/39" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/41" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/39" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/41" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/32" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/34" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/45" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/46" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/49" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/47" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.CloudFront/DistributionProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/56" + } + }, + { + "$type": "ObjectType", + "name": "AWS.CloudFront/DistributionProperties", + "properties": { + "DistributionConfig": { + "type": { + "$ref": "#/37" + }, + "flags": 1, + "description": "The distribution's configuration." + }, + "DomainName": { + "type": { + "$ref": "#/5" + }, + "flags": 2, + "description": "" + }, + "Id": { + "type": { + "$ref": "#/5" + }, + "flags": 18, + "description": "" + }, + "Tags": { + "type": { + "$ref": "#/86" + }, + "flags": 0, + "description": "A complex type that contains zero or more ``Tag`` elements." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.CloudFront/Distribution", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/87" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.CloudFront/Distribution@default", + "scopeType": 0, + "body": { + "$ref": "#/88" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "FunctionConfig", + "properties": { + "Comment": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "KeyValueStoreAssociations": { + "type": { + "$ref": "#/93" + }, + "flags": 0 + }, + "Runtime": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "FunctionMetadata", + "properties": { + "FunctionARN": { + "type": { + "$ref": "#/5" + }, + "flags": 18 + } + } + }, + { + "$type": "ObjectType", + "name": "KeyValueStoreAssociation", + "properties": { + "KeyValueStoreARN": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/92" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.CloudFront/FunctionProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.CloudFront/FunctionProperties", + "properties": { + "AutoPublish": { + "type": { + "$ref": "#/9" + }, + "flags": 4 + }, + "FunctionARN": { + "type": { + "$ref": "#/5" + }, + "flags": 18 + }, + "FunctionCode": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "FunctionConfig": { + "type": { + "$ref": "#/90" + }, + "flags": 1 + }, + "FunctionMetadata": { + "type": { + "$ref": "#/91" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Stage": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.CloudFront/Function", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/95" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.CloudFront/Function@default", + "scopeType": 0, + "body": { + "$ref": "#/96" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "KeyGroupConfig", + "properties": { + "Comment": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Items": { + "type": { + "$ref": "#/99" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.CloudFront/KeyGroupProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.CloudFront/KeyGroupProperties", + "properties": { + "Id": { + "type": { + "$ref": "#/5" + }, + "flags": 18 + }, + "KeyGroupConfig": { + "type": { + "$ref": "#/98" + }, + "flags": 1 + }, + "LastModifiedTime": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.CloudFront/KeyGroup", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/101" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.CloudFront/KeyGroup@default", + "scopeType": 0, + "body": { + "$ref": "#/102" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "ImportSource", + "properties": { + "SourceArn": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "SourceType": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.CloudFront/KeyValueStoreProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.CloudFront/KeyValueStoreProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "Comment": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Id": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "ImportSource": { + "type": { + "$ref": "#/104" + }, + "flags": 4 + }, + "Name": { + "type": { + "$ref": "#/5" + }, + "flags": 17 + }, + "Status": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.CloudFront/KeyValueStore", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/106" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.CloudFront/KeyValueStore@default", + "scopeType": 0, + "body": { + "$ref": "#/107" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "OriginAccessControlConfig", + "properties": { + "Description": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "OriginAccessControlOriginType": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "SigningBehavior": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "SigningProtocol": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.CloudFront/OriginAccessControlProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.CloudFront/OriginAccessControlProperties", + "properties": { + "Id": { + "type": { + "$ref": "#/5" + }, + "flags": 18 + }, + "OriginAccessControlConfig": { + "type": { + "$ref": "#/109" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.CloudFront/OriginAccessControl", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/111" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.CloudFront/OriginAccessControl@default", + "scopeType": 0, + "body": { + "$ref": "#/112" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "CookiesConfig", + "properties": { + "CookieBehavior": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Cookies": { + "type": { + "$ref": "#/118" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "HeadersConfig", + "properties": { + "HeaderBehavior": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Headers": { + "type": { + "$ref": "#/119" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "OriginRequestPolicyConfig", + "properties": { + "Comment": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "CookiesConfig": { + "type": { + "$ref": "#/114" + }, + "flags": 1 + }, + "HeadersConfig": { + "type": { + "$ref": "#/115" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "QueryStringsConfig": { + "type": { + "$ref": "#/117" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "QueryStringsConfig", + "properties": { + "QueryStringBehavior": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "QueryStrings": { + "type": { + "$ref": "#/120" + }, + "flags": 0 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.CloudFront/OriginRequestPolicyProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.CloudFront/OriginRequestPolicyProperties", + "properties": { + "Id": { + "type": { + "$ref": "#/5" + }, + "flags": 18 + }, + "LastModifiedTime": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "OriginRequestPolicyConfig": { + "type": { + "$ref": "#/116" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.CloudFront/OriginRequestPolicy", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/122" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.CloudFront/OriginRequestPolicy@default", + "scopeType": 0, + "body": { + "$ref": "#/123" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "PublicKeyConfig", + "properties": { + "CallerReference": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Comment": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "EncodedKey": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.CloudFront/PublicKeyProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.CloudFront/PublicKeyProperties", + "properties": { + "CreatedTime": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "Id": { + "type": { + "$ref": "#/5" + }, + "flags": 18 + }, + "PublicKeyConfig": { + "type": { + "$ref": "#/125" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.CloudFront/PublicKey", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/127" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.CloudFront/PublicKey@default", + "scopeType": 0, + "body": { + "$ref": "#/128" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "EndPoint", + "properties": { + "KinesisStreamConfig": { + "type": { + "$ref": "#/131" + }, + "flags": 1 + }, + "StreamType": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "KinesisStreamConfig", + "properties": { + "RoleArn": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "StreamArn": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.CloudFront/RealtimeLogConfigProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/130" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ObjectType", + "name": "AWS.CloudFront/RealtimeLogConfigProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/5" + }, + "flags": 18 + }, + "EndPoints": { + "type": { + "$ref": "#/133" + }, + "flags": 1 + }, + "Fields": { + "type": { + "$ref": "#/134" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "SamplingRate": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.CloudFront/RealtimeLogConfig", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/135" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.CloudFront/RealtimeLogConfig@default", + "scopeType": 0, + "body": { + "$ref": "#/136" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AccessControlAllowHeaders", + "properties": { + "Items": { + "type": { + "$ref": "#/156" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AccessControlAllowMethods", + "properties": { + "Items": { + "type": { + "$ref": "#/157" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AccessControlAllowOrigins", + "properties": { + "Items": { + "type": { + "$ref": "#/158" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AccessControlExposeHeaders", + "properties": { + "Items": { + "type": { + "$ref": "#/159" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ContentSecurityPolicy", + "properties": { + "ContentSecurityPolicy": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Override": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ContentTypeOptions", + "properties": { + "Override": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CorsConfig", + "properties": { + "AccessControlAllowCredentials": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + }, + "AccessControlAllowHeaders": { + "type": { + "$ref": "#/138" + }, + "flags": 1 + }, + "AccessControlAllowMethods": { + "type": { + "$ref": "#/139" + }, + "flags": 1 + }, + "AccessControlAllowOrigins": { + "type": { + "$ref": "#/140" + }, + "flags": 1 + }, + "AccessControlExposeHeaders": { + "type": { + "$ref": "#/141" + }, + "flags": 0 + }, + "AccessControlMaxAgeSec": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "OriginOverride": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomHeader", + "properties": { + "Header": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Override": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomHeadersConfig", + "properties": { + "Items": { + "type": { + "$ref": "#/160" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "FrameOptions", + "properties": { + "FrameOption": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Override": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ReferrerPolicy", + "properties": { + "Override": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + }, + "ReferrerPolicy": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "RemoveHeader", + "properties": { + "Header": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "RemoveHeadersConfig", + "properties": { + "Items": { + "type": { + "$ref": "#/161" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ResponseHeadersPolicyConfig", + "properties": { + "Comment": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "CorsConfig": { + "type": { + "$ref": "#/144" + }, + "flags": 0 + }, + "CustomHeadersConfig": { + "type": { + "$ref": "#/146" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "RemoveHeadersConfig": { + "type": { + "$ref": "#/150" + }, + "flags": 0 + }, + "SecurityHeadersConfig": { + "type": { + "$ref": "#/152" + }, + "flags": 0 + }, + "ServerTimingHeadersConfig": { + "type": { + "$ref": "#/153" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SecurityHeadersConfig", + "properties": { + "ContentSecurityPolicy": { + "type": { + "$ref": "#/142" + }, + "flags": 0 + }, + "ContentTypeOptions": { + "type": { + "$ref": "#/143" + }, + "flags": 0 + }, + "FrameOptions": { + "type": { + "$ref": "#/147" + }, + "flags": 0 + }, + "ReferrerPolicy": { + "type": { + "$ref": "#/148" + }, + "flags": 0 + }, + "StrictTransportSecurity": { + "type": { + "$ref": "#/154" + }, + "flags": 0 + }, + "XSSProtection": { + "type": { + "$ref": "#/155" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ServerTimingHeadersConfig", + "properties": { + "Enabled": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + }, + "SamplingRate": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "StrictTransportSecurity", + "properties": { + "AccessControlMaxAgeSec": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "IncludeSubdomains": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "Override": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + }, + "Preload": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "XSSProtection", + "properties": { + "ModeBlock": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "Override": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + }, + "Protection": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + }, + "ReportUri": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/145" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/149" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.CloudFront/ResponseHeadersPolicyProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.CloudFront/ResponseHeadersPolicyProperties", + "properties": { + "Id": { + "type": { + "$ref": "#/5" + }, + "flags": 18 + }, + "LastModifiedTime": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "ResponseHeadersPolicyConfig": { + "type": { + "$ref": "#/151" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.CloudFront/ResponseHeadersPolicy", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/163" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.CloudFront/ResponseHeadersPolicy@default", + "scopeType": 0, + "body": { + "$ref": "#/164" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.cloudfront/default/types.md b/artifacts/bicep/aws/aws.cloudfront/default/types.md index b0b38d73..414ce47d 100644 --- a/artifacts/bicep/aws/aws.cloudfront/default/types.md +++ b/artifacts/bicep/aws/aws.cloudfront/default/types.md @@ -3,124 +3,108 @@ ## Resource AWS.CloudFront/CachePolicy@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.CloudFront/CachePolicyProperties](#awscloudfrontcachepolicyproperties) (Required): properties of the resource +* **properties**: [AWS.CloudFront/CachePolicyProperties](#awscloudfrontcachepolicyproperties) (Required, Identifier): properties of the resource ## Resource AWS.CloudFront/CloudFrontOriginAccessIdentity@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.CloudFront/CloudFrontOriginAccessIdentityProperties](#awscloudfrontcloudfrontoriginaccessidentityproperties) (Required): properties of the resource +* **properties**: [AWS.CloudFront/CloudFrontOriginAccessIdentityProperties](#awscloudfrontcloudfrontoriginaccessidentityproperties) (Required, Identifier): properties of the resource ## Resource AWS.CloudFront/ContinuousDeploymentPolicy@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.CloudFront/ContinuousDeploymentPolicyProperties](#awscloudfrontcontinuousdeploymentpolicyproperties) (Required): properties of the resource +* **properties**: [AWS.CloudFront/ContinuousDeploymentPolicyProperties](#awscloudfrontcontinuousdeploymentpolicyproperties) (Required, Identifier): properties of the resource ## Resource AWS.CloudFront/Distribution@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.CloudFront/DistributionProperties](#awscloudfrontdistributionproperties) (Required): properties of the resource +* **properties**: [AWS.CloudFront/DistributionProperties](#awscloudfrontdistributionproperties) (Required, Identifier): properties of the resource ## Resource AWS.CloudFront/Function@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.CloudFront/FunctionProperties](#awscloudfrontfunctionproperties) (Required): properties of the resource +* **properties**: [AWS.CloudFront/FunctionProperties](#awscloudfrontfunctionproperties) (Required, Identifier): properties of the resource ## Resource AWS.CloudFront/KeyGroup@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.CloudFront/KeyGroupProperties](#awscloudfrontkeygroupproperties) (Required): properties of the resource +* **properties**: [AWS.CloudFront/KeyGroupProperties](#awscloudfrontkeygroupproperties) (Required, Identifier): properties of the resource ## Resource AWS.CloudFront/KeyValueStore@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.CloudFront/KeyValueStoreProperties](#awscloudfrontkeyvaluestoreproperties) (Required): properties of the resource +* **properties**: [AWS.CloudFront/KeyValueStoreProperties](#awscloudfrontkeyvaluestoreproperties) (Required, Identifier): properties of the resource ## Resource AWS.CloudFront/OriginAccessControl@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.CloudFront/OriginAccessControlProperties](#awscloudfrontoriginaccesscontrolproperties) (Required): properties of the resource +* **properties**: [AWS.CloudFront/OriginAccessControlProperties](#awscloudfrontoriginaccesscontrolproperties) (Required, Identifier): properties of the resource ## Resource AWS.CloudFront/OriginRequestPolicy@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.CloudFront/OriginRequestPolicyProperties](#awscloudfrontoriginrequestpolicyproperties) (Required): properties of the resource +* **properties**: [AWS.CloudFront/OriginRequestPolicyProperties](#awscloudfrontoriginrequestpolicyproperties) (Required, Identifier): properties of the resource ## Resource AWS.CloudFront/PublicKey@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.CloudFront/PublicKeyProperties](#awscloudfrontpublickeyproperties) (Required): properties of the resource +* **properties**: [AWS.CloudFront/PublicKeyProperties](#awscloudfrontpublickeyproperties) (Required, Identifier): properties of the resource ## Resource AWS.CloudFront/RealtimeLogConfig@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.CloudFront/RealtimeLogConfigProperties](#awscloudfrontrealtimelogconfigproperties) (Required): properties of the resource +* **properties**: [AWS.CloudFront/RealtimeLogConfigProperties](#awscloudfrontrealtimelogconfigproperties) (Required, Identifier): properties of the resource ## Resource AWS.CloudFront/ResponseHeadersPolicy@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.CloudFront/ResponseHeadersPolicyProperties](#awscloudfrontresponseheaderspolicyproperties) (Required): properties of the resource +* **properties**: [AWS.CloudFront/ResponseHeadersPolicyProperties](#awscloudfrontresponseheaderspolicyproperties) (Required, Identifier): properties of the resource -## AWS.CloudFront/CachePolicyProperties -### Properties -* **CachePolicyConfig**: [CachePolicyConfig](#cachepolicyconfig) (Required) -* **Id**: string (ReadOnly, Identifier) -* **LastModifiedTime**: string (ReadOnly) - -## CachePolicyConfig +## AccessControlAllowHeaders ### Properties -* **Comment**: string -* **DefaultTTL**: int (Required) -* **MaxTTL**: int (Required) -* **MinTTL**: int (Required) -* **Name**: string (Required) -* **ParametersInCacheKeyAndForwardedToOrigin**: [ParametersInCacheKeyAndForwardedToOrigin](#parametersincachekeyandforwardedtoorigin) (Required) +* **Items**: string[] (Required) -## ParametersInCacheKeyAndForwardedToOrigin +## AccessControlAllowMethods ### Properties -* **CookiesConfig**: [CookiesConfig](#cookiesconfig) (Required) -* **EnableAcceptEncodingBrotli**: bool -* **EnableAcceptEncodingGzip**: bool (Required) -* **HeadersConfig**: [HeadersConfig](#headersconfig) (Required) -* **QueryStringsConfig**: [QueryStringsConfig](#querystringsconfig) (Required) +* **Items**: string[] (Required) -## CookiesConfig +## AccessControlAllowOrigins ### Properties -* **CookieBehavior**: string (Required) -* **Cookies**: string[] +* **Items**: string[] (Required) -## HeadersConfig +## AccessControlExposeHeaders ### Properties -* **HeaderBehavior**: string (Required) -* **Headers**: string[] +* **Items**: string[] (Required) -## QueryStringsConfig +## AWS.CloudFront/CachePolicyProperties ### Properties -* **QueryStringBehavior**: string (Required) -* **QueryStrings**: string[] +* **CachePolicyConfig**: [CachePolicyConfig](#cachepolicyconfig) (Required) +* **Id**: string (ReadOnly, Identifier) +* **LastModifiedTime**: string (ReadOnly) ## AWS.CloudFront/CloudFrontOriginAccessIdentityProperties ### Properties @@ -128,322 +112,481 @@ * **Id**: string (ReadOnly, Identifier) * **S3CanonicalUserId**: string (ReadOnly) -## CloudFrontOriginAccessIdentityConfig -### Properties -* **Comment**: string (Required) - ## AWS.CloudFront/ContinuousDeploymentPolicyProperties ### Properties * **ContinuousDeploymentPolicyConfig**: [ContinuousDeploymentPolicyConfig](#continuousdeploymentpolicyconfig) (Required) * **Id**: string (ReadOnly, Identifier) * **LastModifiedTime**: string (ReadOnly) -## ContinuousDeploymentPolicyConfig +## AWS.CloudFront/DistributionProperties ### Properties -* **Enabled**: bool (Required) -* **SingleHeaderPolicyConfig**: [ContinuousDeploymentPolicy_SingleHeaderPolicyConfig](#continuousdeploymentpolicysingleheaderpolicyconfig) -* **SingleWeightPolicyConfig**: [ContinuousDeploymentPolicy_SingleWeightPolicyConfig](#continuousdeploymentpolicysingleweightpolicyconfig) -* **StagingDistributionDnsNames**: string[] (Required) -* **TrafficConfig**: [TrafficConfig](#trafficconfig) -* **Type**: string +* **DistributionConfig**: [DistributionConfig](#distributionconfig) (Required): The distribution's configuration. +* **DomainName**: string (ReadOnly) +* **Id**: string (ReadOnly, Identifier) +* **Tags**: [Tag](#tag)[]: A complex type that contains zero or more ``Tag`` elements. -## ContinuousDeploymentPolicy_SingleHeaderPolicyConfig +## AWS.CloudFront/FunctionProperties ### Properties -* **Header**: string (Required) -* **Value**: string (Required) +* **AutoPublish**: bool (WriteOnly) +* **FunctionARN**: string (ReadOnly, Identifier) +* **FunctionCode**: string (Required) +* **FunctionConfig**: [FunctionConfig](#functionconfig) (Required) +* **FunctionMetadata**: [FunctionMetadata](#functionmetadata) +* **Name**: string (Required) +* **Stage**: string (ReadOnly) -## ContinuousDeploymentPolicy_SingleWeightPolicyConfig +## AWS.CloudFront/KeyGroupProperties ### Properties -* **SessionStickinessConfig**: [SessionStickinessConfig](#sessionstickinessconfig) -* **Weight**: int (Required) +* **Id**: string (ReadOnly, Identifier) +* **KeyGroupConfig**: [KeyGroupConfig](#keygroupconfig) (Required) +* **LastModifiedTime**: string (ReadOnly) -## SessionStickinessConfig +## AWS.CloudFront/KeyValueStoreProperties ### Properties -* **IdleTTL**: int (Required) -* **MaximumTTL**: int (Required) +* **Arn**: string (ReadOnly) +* **Comment**: string +* **Id**: string (ReadOnly) +* **ImportSource**: [ImportSource](#importsource) (WriteOnly) +* **Name**: string (Required, Identifier) +* **Status**: string (ReadOnly) -## TrafficConfig +## AWS.CloudFront/OriginAccessControlProperties ### Properties -* **SingleHeaderConfig**: [SingleHeaderConfig](#singleheaderconfig) -* **SingleWeightConfig**: [SingleWeightConfig](#singleweightconfig) -* **Type**: string (Required) +* **Id**: string (ReadOnly, Identifier) +* **OriginAccessControlConfig**: [OriginAccessControlConfig](#originaccesscontrolconfig) (Required) -## SingleHeaderConfig +## AWS.CloudFront/OriginRequestPolicyProperties ### Properties -* **Header**: string (Required) -* **Value**: string (Required) +* **Id**: string (ReadOnly, Identifier) +* **LastModifiedTime**: string (ReadOnly) +* **OriginRequestPolicyConfig**: [OriginRequestPolicyConfig](#originrequestpolicyconfig) (Required) -## SingleWeightConfig +## AWS.CloudFront/PublicKeyProperties ### Properties -* **SessionStickinessConfig**: [SessionStickinessConfig](#sessionstickinessconfig) -* **Weight**: int (Required) +* **CreatedTime**: string (ReadOnly) +* **Id**: string (ReadOnly, Identifier) +* **PublicKeyConfig**: [PublicKeyConfig](#publickeyconfig) (Required) -## AWS.CloudFront/DistributionProperties +## AWS.CloudFront/RealtimeLogConfigProperties +### Properties +* **Arn**: string (ReadOnly, Identifier) +* **EndPoints**: [EndPoint](#endpoint)[] (Required) +* **Fields**: string[] (Required) +* **Name**: string (Required) +* **SamplingRate**: int (Required) + +## AWS.CloudFront/ResponseHeadersPolicyProperties ### Properties -* **DistributionConfig**: [DistributionConfig](#distributionconfig) (Required) -* **DomainName**: string (ReadOnly) * **Id**: string (ReadOnly, Identifier) -* **Tags**: [Tag](#tag)[] +* **LastModifiedTime**: string (ReadOnly) +* **ResponseHeadersPolicyConfig**: [ResponseHeadersPolicyConfig](#responseheaderspolicyconfig) (Required) -## DistributionConfig +## CacheBehavior +### Properties +* **AllowedMethods**: string[]: A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: + + CloudFront forwards only ``GET`` and ``HEAD`` requests. + + CloudFront forwards only ``GET``, ``HEAD``, and ``OPTIONS`` requests. + + CloudFront forwards ``GET, HEAD, OPTIONS, PUT, PATCH, POST``, and ``DELETE`` requests. + + If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. +* **CachedMethods**: string[]: A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: + + CloudFront caches responses to ``GET`` and ``HEAD`` requests. + + CloudFront caches responses to ``GET``, ``HEAD``, and ``OPTIONS`` requests. + + If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly. +* **CachePolicyId**: string: The unique identifier of the cache policy that is attached to this cache behavior. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. + A ``CacheBehavior`` must include either a ``CachePolicyId`` or ``ForwardedValues``. We recommend that you use a ``CachePolicyId``. +* **Compress**: bool: Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see [Serving Compressed Files](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/ServingCompressedFiles.html) in the *Amazon CloudFront Developer Guide*. +* **DefaultTTL**: int: This field is deprecated. We recommend that you use the ``DefaultTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. + The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as ``Cache-Control max-age``, ``Cache-Control s-maxage``, and ``Expires`` to objects. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*. +* **FieldLevelEncryptionId**: string: The value of ``ID`` for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for this cache behavior. +* **ForwardedValues**: [ForwardedValues](#forwardedvalues): This field is deprecated. We recommend that you use a cache policy or an origin request 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 *Amazon CloudFront Developer Guide*. + If you want to include values in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. + If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) or [Using the managed origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) in the *Amazon CloudFront Developer Guide*. + A ``CacheBehavior`` must include either a ``CachePolicyId`` or ``ForwardedValues``. We recommend that you use a ``CachePolicyId``. + A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. +* **FunctionAssociations**: [FunctionAssociation](#functionassociation)[]: A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the ``LIVE`` stage to associate them with a cache behavior. +* **LambdaFunctionAssociations**: [LambdaFunctionAssociation](#lambdafunctionassociation)[]: A complex type that contains zero or more Lambda@Edge function associations for a cache behavior. +* **MaxTTL**: int: This field is deprecated. We recommend that you use the ``MaxTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. + The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as ``Cache-Control max-age``, ``Cache-Control s-maxage``, and ``Expires`` to objects. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*. +* **MinTTL**: int: This field is deprecated. We recommend that you use the ``MinTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. + The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*. + You must specify ``0`` for ``MinTTL`` if you configure CloudFront to forward all headers to your origin (under ``Headers``, if you specify ``1`` for ``Quantity`` and ``*`` for ``Name``). +* **OriginRequestPolicyId**: string: The unique identifier of the origin request policy that is attached to this cache behavior. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) or [Using the managed origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) in the *Amazon CloudFront Developer Guide*. +* **PathPattern**: string (Required): The pattern (for example, ``images/*.jpg``) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution. + You can optionally include a slash (``/``) at the beginning of the path pattern. For example, ``/images/*.jpg``. CloudFront behavior is the same with or without the leading ``/``. + The path pattern for the default cache behavior is ``*`` and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior. + For 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*. +* **RealtimeLogConfigArn**: string: The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see [Real-time logs](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html) in the *Amazon CloudFront Developer Guide*. +* **ResponseHeadersPolicyId**: string: The identifier for a response headers policy. +* **SmoothStreaming**: bool: Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify ``true``; if not, specify ``false``. If you specify ``true`` for ``SmoothStreaming``, you can still distribute other content using this cache behavior if the content matches the value of ``PathPattern``. +* **TargetOriginId**: string (Required): The value of ``ID`` for the origin that you want CloudFront to route requests to when they match this cache behavior. +* **TrustedKeyGroups**: string[]: A list of key groups that CloudFront can use to validate signed URLs or signed cookies. + When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*. +* **TrustedSigners**: string[]: We recommend using ``TrustedKeyGroups`` instead of ``TrustedSigners``. + A list of AWS-account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies. + When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer's AWS-account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*. +* **ViewerProtocolPolicy**: string (Required): The protocol that viewers can use to access the files in the origin specified by ``TargetOriginId`` when a request matches the path pattern in ``PathPattern``. You can specify the following options: + + ``allow-all``: Viewers can use HTTP or HTTPS. + + ``redirect-to-https``: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL. + + ``https-only``: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden). + + For more information about requiring the HTTPS protocol, see [Requiring HTTPS Between Viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-viewers-to-cloudfront.html) in the *Amazon CloudFront Developer Guide*. + The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see [Managing Cache Expiration](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*. + +## CachePolicyConfig ### Properties -* **Aliases**: string[] -* **CacheBehaviors**: [CacheBehavior](#cachebehavior)[] -* **CNAMEs**: string[] * **Comment**: string -* **ContinuousDeploymentPolicyId**: string -* **CustomErrorResponses**: [CustomErrorResponse](#customerrorresponse)[] -* **CustomOrigin**: [LegacyCustomOrigin](#legacycustomorigin) -* **DefaultCacheBehavior**: [DefaultCacheBehavior](#defaultcachebehavior) (Required) -* **DefaultRootObject**: string -* **Enabled**: bool (Required) -* **HttpVersion**: string -* **IPV6Enabled**: bool -* **Logging**: [Logging](#logging) -* **OriginGroups**: [OriginGroups](#origingroups) -* **Origins**: [Origin](#origin)[] -* **PriceClass**: string -* **Restrictions**: [Restrictions](#restrictions) -* **S3Origin**: [LegacyS3Origin](#legacys3origin) -* **Staging**: bool -* **ViewerCertificate**: [ViewerCertificate](#viewercertificate) -* **WebACLId**: string +* **DefaultTTL**: int (Required) +* **MaxTTL**: int (Required) +* **MinTTL**: int (Required) +* **Name**: string (Required) +* **ParametersInCacheKeyAndForwardedToOrigin**: [ParametersInCacheKeyAndForwardedToOrigin](#parametersincachekeyandforwardedtoorigin) (Required) -## CacheBehavior +## CloudFrontOriginAccessIdentityConfig ### Properties -* **AllowedMethods**: string[] -* **CachedMethods**: string[] -* **CachePolicyId**: string -* **Compress**: bool -* **DefaultTTL**: int -* **FieldLevelEncryptionId**: string -* **ForwardedValues**: [ForwardedValues](#forwardedvalues) -* **FunctionAssociations**: [FunctionAssociation](#functionassociation)[] -* **LambdaFunctionAssociations**: [LambdaFunctionAssociation](#lambdafunctionassociation)[] -* **MaxTTL**: int -* **MinTTL**: int -* **OriginRequestPolicyId**: string -* **PathPattern**: string (Required) -* **RealtimeLogConfigArn**: string -* **ResponseHeadersPolicyId**: string -* **SmoothStreaming**: bool -* **TargetOriginId**: string (Required) -* **TrustedKeyGroups**: string[] -* **TrustedSigners**: string[] -* **ViewerProtocolPolicy**: string (Required) +* **Comment**: string (Required) -## ForwardedValues +## ContentSecurityPolicy ### Properties -* **Cookies**: [Cookies](#cookies) -* **Headers**: string[] -* **QueryString**: bool (Required) -* **QueryStringCacheKeys**: string[] +* **ContentSecurityPolicy**: string (Required) +* **Override**: bool (Required) -## Cookies +## ContentTypeOptions ### Properties -* **Forward**: string (Required) -* **WhitelistedNames**: string[] +* **Override**: bool (Required) -## FunctionAssociation +## ContinuousDeploymentPolicy_SingleHeaderPolicyConfig ### Properties -* **EventType**: string -* **FunctionARN**: string +* **Header**: string (Required) +* **Value**: string (Required) -## LambdaFunctionAssociation +## ContinuousDeploymentPolicy_SingleWeightPolicyConfig ### Properties -* **EventType**: string -* **IncludeBody**: bool -* **LambdaFunctionARN**: string +* **SessionStickinessConfig**: [SessionStickinessConfig](#sessionstickinessconfig) +* **Weight**: int (Required) -## CustomErrorResponse +## ContinuousDeploymentPolicyConfig ### Properties -* **ErrorCachingMinTTL**: int -* **ErrorCode**: int (Required) -* **ResponseCode**: int -* **ResponsePagePath**: string +* **Enabled**: bool (Required) +* **SingleHeaderPolicyConfig**: [ContinuousDeploymentPolicy_SingleHeaderPolicyConfig](#continuousdeploymentpolicysingleheaderpolicyconfig) +* **SingleWeightPolicyConfig**: [ContinuousDeploymentPolicy_SingleWeightPolicyConfig](#continuousdeploymentpolicysingleweightpolicyconfig) +* **StagingDistributionDnsNames**: string[] (Required) +* **TrafficConfig**: [TrafficConfig](#trafficconfig) +* **Type**: string -## LegacyCustomOrigin +## Cookies ### Properties -* **DNSName**: string (Required) -* **HTTPPort**: int -* **HTTPSPort**: int -* **OriginProtocolPolicy**: string (Required) -* **OriginSSLProtocols**: string[] (Required) +* **Forward**: string (Required): This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. + If you want to include cookies in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*. + If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*. + Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the ``WhitelistedNames`` complex type. + Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the ``Forward`` element. +* **WhitelistedNames**: string[]: This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. + If you want to include cookies in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*. + If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*. + Required if you specify ``whitelist`` for the value of ``Forward``. A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies. + If you specify ``all`` or ``none`` for the value of ``Forward``, omit ``WhitelistedNames``. If you change the value of ``Forward`` from ``whitelist`` to ``all`` or ``none`` and you don't delete the ``WhitelistedNames`` element and its child elements, CloudFront deletes them automatically. + For the current limit on the number of cookie names that you can whitelist for each cache behavior, see [CloudFront Limits](https://docs.aws.amazon.com/general/latest/gr/xrefaws_service_limits.html#limits_cloudfront) in the *General Reference*. -## DefaultCacheBehavior +## CookiesConfig ### Properties -* **AllowedMethods**: string[] -* **CachedMethods**: string[] -* **CachePolicyId**: string -* **Compress**: bool -* **DefaultTTL**: int -* **FieldLevelEncryptionId**: string -* **ForwardedValues**: [ForwardedValues](#forwardedvalues) -* **FunctionAssociations**: [FunctionAssociation](#functionassociation)[] -* **LambdaFunctionAssociations**: [LambdaFunctionAssociation](#lambdafunctionassociation)[] -* **MaxTTL**: int -* **MinTTL**: int -* **OriginRequestPolicyId**: string -* **RealtimeLogConfigArn**: string -* **ResponseHeadersPolicyId**: string -* **SmoothStreaming**: bool -* **TargetOriginId**: string (Required) -* **TrustedKeyGroups**: string[] -* **TrustedSigners**: string[] -* **ViewerProtocolPolicy**: string (Required) +* **CookieBehavior**: string (Required) +* **Cookies**: string[] -## Logging +## CookiesConfig ### Properties -* **Bucket**: string (Required) -* **IncludeCookies**: bool -* **Prefix**: string +* **CookieBehavior**: string (Required) +* **Cookies**: string[] -## OriginGroups +## CorsConfig ### Properties -* **Items**: [OriginGroup](#origingroup)[] -* **Quantity**: int (Required) +* **AccessControlAllowCredentials**: bool (Required) +* **AccessControlAllowHeaders**: [AccessControlAllowHeaders](#accesscontrolallowheaders) (Required) +* **AccessControlAllowMethods**: [AccessControlAllowMethods](#accesscontrolallowmethods) (Required) +* **AccessControlAllowOrigins**: [AccessControlAllowOrigins](#accesscontrolalloworigins) (Required) +* **AccessControlExposeHeaders**: [AccessControlExposeHeaders](#accesscontrolexposeheaders) +* **AccessControlMaxAgeSec**: int +* **OriginOverride**: bool (Required) -## OriginGroup +## CustomErrorResponse ### Properties -* **FailoverCriteria**: [OriginGroupFailoverCriteria](#origingroupfailovercriteria) (Required) -* **Id**: string (Required, Identifier) -* **Members**: [OriginGroupMembers](#origingroupmembers) (Required) +* **ErrorCachingMinTTL**: int: The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in ``ErrorCode``. When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available. + For more information, see [Customizing Error Responses](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html) in the *Amazon CloudFront Developer Guide*. +* **ErrorCode**: int (Required): The HTTP status code for which you want to specify a custom error page and/or a caching duration. +* **ResponseCode**: int: The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example: + + Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute ``200``, the response typically won't be intercepted. + + If you don't care about distinguishing among different client errors or server errors, you can specify ``400`` or ``500`` as the ``ResponseCode`` for all 4xx or 5xx errors. + + You might want to return a ``200`` status code (OK) and static website so your customers don't know that your website is down. + + If you specify a value for ``ResponseCode``, you must also specify a value for ``ResponsePagePath``. +* **ResponsePagePath**: string: The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by ``ErrorCode``, for example, ``/4xx-errors/403-forbidden.html``. If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true: + + The value of ``PathPattern`` matches the path to your custom error messages. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named ``/4xx-errors``. Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example, ``/4xx-errors/*``. + + The value of ``TargetOriginId`` specifies the value of the ``ID`` element for the origin that contains your custom error pages. + + If you specify a value for ``ResponsePagePath``, you must also specify a value for ``ResponseCode``. + We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable. -## OriginGroupFailoverCriteria +## CustomHeader ### Properties -* **StatusCodes**: [StatusCodes](#statuscodes) (Required) +* **Header**: string (Required) +* **Override**: bool (Required) +* **Value**: string (Required) -## StatusCodes +## CustomHeadersConfig ### Properties -* **Items**: int[] (Required) -* **Quantity**: int (Required) +* **Items**: [CustomHeader](#customheader)[] (Required) -## OriginGroupMembers +## CustomOriginConfig ### Properties -* **Items**: [OriginGroupMember](#origingroupmember)[] (Required) -* **Quantity**: int (Required) +* **HTTPPort**: int: The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on. +* **HTTPSPort**: int: The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on. +* **OriginKeepaliveTimeout**: int: Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 5 seconds. + For more information, see [Origin Keep-alive Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginKeepaliveTimeout) in the *Amazon CloudFront Developer Guide*. +* **OriginProtocolPolicy**: string (Required): Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid values are: + + ``http-only`` ? CloudFront always uses HTTP to connect to the origin. + + ``match-viewer`` ? CloudFront connects to the origin using the same protocol that the viewer used to connect to CloudFront. + + ``https-only`` ? CloudFront always uses HTTPS to connect to the origin. +* **OriginReadTimeout**: int: Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the *origin response timeout*. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 30 seconds. + For more information, see [Origin Response Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginResponseTimeout) in the *Amazon CloudFront Developer Guide*. +* **OriginSSLProtocols**: string[]: Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS. Valid values include ``SSLv3``, ``TLSv1``, ``TLSv1.1``, and ``TLSv1.2``. + For more information, see [Minimum Origin SSL Protocol](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginSSLProtocols) in the *Amazon CloudFront Developer Guide*. -## OriginGroupMember +## DefaultCacheBehavior ### Properties -* **OriginId**: string (Required) +* **AllowedMethods**: string[]: A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: + + CloudFront forwards only ``GET`` and ``HEAD`` requests. + + CloudFront forwards only ``GET``, ``HEAD``, and ``OPTIONS`` requests. + + CloudFront forwards ``GET, HEAD, OPTIONS, PUT, PATCH, POST``, and ``DELETE`` requests. + + If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. +* **CachedMethods**: string[]: A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: + + CloudFront caches responses to ``GET`` and ``HEAD`` requests. + + CloudFront caches responses to ``GET``, ``HEAD``, and ``OPTIONS`` requests. + + If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly. +* **CachePolicyId**: string: The unique identifier of the cache policy that is attached to the default cache behavior. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. + A ``DefaultCacheBehavior`` must include either a ``CachePolicyId`` or ``ForwardedValues``. We recommend that you use a ``CachePolicyId``. +* **Compress**: bool: Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify ``true``; if not, specify ``false``. For more information, see [Serving Compressed Files](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/ServingCompressedFiles.html) in the *Amazon CloudFront Developer Guide*. +* **DefaultTTL**: int: This field is deprecated. We recommend that you use the ``DefaultTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. + The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as ``Cache-Control max-age``, ``Cache-Control s-maxage``, and ``Expires`` to objects. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*. +* **FieldLevelEncryptionId**: string: The value of ``ID`` for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for the default cache behavior. +* **ForwardedValues**: [ForwardedValues](#forwardedvalues): This field is deprecated. We recommend that you use a cache policy or an origin request 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 *Amazon CloudFront Developer Guide*. + If you want to include values in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. + If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) or [Using the managed origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) in the *Amazon CloudFront Developer Guide*. + A ``DefaultCacheBehavior`` must include either a ``CachePolicyId`` or ``ForwardedValues``. We recommend that you use a ``CachePolicyId``. + A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. +* **FunctionAssociations**: [FunctionAssociation](#functionassociation)[]: A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the ``LIVE`` stage to associate them with a cache behavior. +* **LambdaFunctionAssociations**: [LambdaFunctionAssociation](#lambdafunctionassociation)[]: A complex type that contains zero or more Lambda@Edge function associations for a cache behavior. +* **MaxTTL**: int: This field is deprecated. We recommend that you use the ``MaxTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. + The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as ``Cache-Control max-age``, ``Cache-Control s-maxage``, and ``Expires`` to objects. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*. +* **MinTTL**: int: This field is deprecated. We recommend that you use the ``MinTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. + The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*. + You must specify ``0`` for ``MinTTL`` if you configure CloudFront to forward all headers to your origin (under ``Headers``, if you specify ``1`` for ``Quantity`` and ``*`` for ``Name``). +* **OriginRequestPolicyId**: string: The unique identifier of the origin request policy that is attached to the default cache behavior. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) or [Using the managed origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) in the *Amazon CloudFront Developer Guide*. +* **RealtimeLogConfigArn**: string: The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see [Real-time logs](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html) in the *Amazon CloudFront Developer Guide*. +* **ResponseHeadersPolicyId**: string: The identifier for a response headers policy. +* **SmoothStreaming**: bool: Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify ``true``; if not, specify ``false``. If you specify ``true`` for ``SmoothStreaming``, you can still distribute other content using this cache behavior if the content matches the value of ``PathPattern``. +* **TargetOriginId**: string (Required): The value of ``ID`` for the origin that you want CloudFront to route requests to when they use the default cache behavior. +* **TrustedKeyGroups**: string[]: A list of key groups that CloudFront can use to validate signed URLs or signed cookies. + When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*. +* **TrustedSigners**: string[]: We recommend using ``TrustedKeyGroups`` instead of ``TrustedSigners``. + A list of AWS-account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies. + When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer's AWS-account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*. +* **ViewerProtocolPolicy**: string (Required): The protocol that viewers can use to access the files in the origin specified by ``TargetOriginId`` when a request matches the path pattern in ``PathPattern``. You can specify the following options: + + ``allow-all``: Viewers can use HTTP or HTTPS. + + ``redirect-to-https``: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL. + + ``https-only``: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden). + + For more information about requiring the HTTPS protocol, see [Requiring HTTPS Between Viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-viewers-to-cloudfront.html) in the *Amazon CloudFront Developer Guide*. + The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see [Managing Cache Expiration](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*. -## Origin +## DistributionConfig ### Properties -* **ConnectionAttempts**: int -* **ConnectionTimeout**: int -* **CustomOriginConfig**: [CustomOriginConfig](#customoriginconfig) -* **DomainName**: string (Required) -* **Id**: string (Required, Identifier) -* **OriginAccessControlId**: string -* **OriginCustomHeaders**: [OriginCustomHeader](#origincustomheader)[] -* **OriginPath**: string -* **OriginShield**: [OriginShield](#originshield) -* **S3OriginConfig**: [S3OriginConfig](#s3originconfig) +* **Aliases**: string[]: A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution. +* **CacheBehaviors**: [CacheBehavior](#cachebehavior)[]: A complex type that contains zero or more ``CacheBehavior`` elements. +* **CNAMEs**: string[] +* **Comment**: string: A comment to describe the distribution. The comment cannot be longer than 128 characters. +* **ContinuousDeploymentPolicyId**: string: The identifier of a continuous deployment policy. For more information, see ``CreateContinuousDeploymentPolicy``. +* **CustomErrorResponses**: [CustomErrorResponse](#customerrorresponse)[]: A complex type that controls the following: + + Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer. + + How long CloudFront caches HTTP status codes in the 4xx and 5xx range. + + For more information about custom error pages, see [Customizing Error Responses](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html) in the *Amazon CloudFront Developer Guide*. +* **CustomOrigin**: [LegacyCustomOrigin](#legacycustomorigin) +* **DefaultCacheBehavior**: [DefaultCacheBehavior](#defaultcachebehavior) (Required): A complex type that describes the default cache behavior if you don't specify a ``CacheBehavior`` element or if files don't match any of the values of ``PathPattern`` in ``CacheBehavior`` elements. You must create exactly one default cache behavior. +* **DefaultRootObject**: string: The object that you want CloudFront to request from your origin (for example, ``index.html``) when a viewer requests the root URL for your distribution (``https://www.example.com``) instead of an object in your distribution (``https://www.example.com/product-description.html``). Specifying a default root object avoids exposing the contents of your distribution. + Specify only the object name, for example, ``index.html``. Don't add a ``/`` before the object name. + If you don't want to specify a default root object when you create a distribution, include an empty ``DefaultRootObject`` element. + To delete the default root object from an existing distribution, update the distribution configuration and include an empty ``DefaultRootObject`` element. + To replace the default root object, update the distribution configuration and specify the new object. + For more information about the default root object, see [Creating a Default Root Object](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DefaultRootObject.html) in the *Amazon CloudFront Developer Guide*. +* **Enabled**: bool (Required): From this field, you can enable or disable the selected distribution. +* **HttpVersion**: string: (Optional) Specify the maximum HTTP version(s) that you want viewers to use to communicate with CF. The default value for new distributions is ``http1.1``. + For viewers and CF to use HTTP/2, viewers must support TLSv1.2 or later, and must support Server Name Indication (SNI). + For viewers and CF to use HTTP/3, viewers must support TLSv1.3 and Server Name Indication (SNI). CF supports HTTP/3 connection migration to allow the viewer to switch networks without losing connection. For more information about connection migration, see [Connection Migration](https://docs.aws.amazon.com/https://www.rfc-editor.org/rfc/rfc9000.html#name-connection-migration) at RFC 9000. For more information about supported TLSv1.3 ciphers, see [Supported protocols and ciphers between viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html). +* **IPV6Enabled**: bool: If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify ``true``. If you specify ``false``, CloudFront responds to IPv6 DNS requests with the DNS response code ``NOERROR`` and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution. + In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the ``IpAddress`` parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see [Creating a Signed URL Using a Custom Policy](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-creating-signed-url-custom-policy.html) in the *Amazon CloudFront Developer Guide*. + If you're using an R53AWSIntlong alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true: + + You enable IPv6 for the distribution + + You're using alternate domain names in the URLs for your objects + + For more information, see [Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-to-cloudfront-distribution.html) in the *Developer Guide*. + If you created a CNAME resource record set, either with R53AWSIntlong or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request. +* **Logging**: [Logging](#logging): A complex type that controls whether access logs are written for the distribution. + For more information about logging, see [Access Logs](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/AccessLogs.html) in the *Amazon CloudFront Developer Guide*. +* **OriginGroups**: [OriginGroups](#origingroups): A complex type that contains information about origin groups for this distribution. +* **Origins**: [Origin](#origin)[]: A complex type that contains information about origins for this distribution. +* **PriceClass**: string: The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify ``PriceClass_All``, CloudFront responds to requests for your objects from all CloudFront edge locations. + If you specify a price class other than ``PriceClass_All``, CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance. + For more information about price classes, see [Choosing the Price Class for a CloudFront Distribution](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PriceClass.html) in the *Amazon CloudFront Developer Guide*. For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see [Amazon CloudFront Pricing](https://docs.aws.amazon.com/cloudfront/pricing/). +* **Restrictions**: [Restrictions](#restrictions): A complex type that identifies ways in which you want to restrict distribution of your content. +* **S3Origin**: [LegacyS3Origin](#legacys3origin) +* **Staging**: bool: A Boolean that indicates whether this is a staging distribution. When this value is ``true``, this is a staging distribution. When this value is ``false``, this is not a staging distribution. +* **ViewerCertificate**: [ViewerCertificate](#viewercertificate): A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers. +* **WebACLId**: string: A unique identifier that specifies the WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of WAF, use the ACL ARN, for example ``arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a``. To specify a web ACL created using WAF Classic, use the ACL ID, for example ``473e64fd-f30b-4765-81a0-62ad96dd167a``. + WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about WAF, see the [Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/what-is-aws-waf.html). -## CustomOriginConfig +## EndPoint ### Properties -* **HTTPPort**: int -* **HTTPSPort**: int -* **OriginKeepaliveTimeout**: int -* **OriginProtocolPolicy**: string (Required) -* **OriginReadTimeout**: int -* **OriginSSLProtocols**: string[] +* **KinesisStreamConfig**: [KinesisStreamConfig](#kinesisstreamconfig) (Required) +* **StreamType**: string (Required) -## OriginCustomHeader +## ForwardedValues ### Properties -* **HeaderName**: string (Required) -* **HeaderValue**: string (Required) +* **Cookies**: [Cookies](#cookies): This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. + If you want to include cookies in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*. + If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*. + A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see [How CloudFront Forwards, Caches, and Logs Cookies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html) in the *Amazon CloudFront Developer Guide*. +* **Headers**: string[]: This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. + If you want to include headers in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*. + If you want to send headers to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*. + A complex type that specifies the ``Headers``, if any, that you want CloudFront to forward to the origin for this cache behavior (whitelisted headers). For the headers that you specify, CloudFront also caches separate versions of a specified object that is based on the header values in viewer requests. + For more information, see [Caching Content Based on Request Headers](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/header-caching.html) in the *Amazon CloudFront Developer Guide*. +* **QueryString**: bool (Required): This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. + If you want to include query strings in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*. + If you want to send query strings to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*. + Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of ``QueryString`` and on the values that you specify for ``QueryStringCacheKeys``, if any: + If you specify true for ``QueryString`` and you don't specify any values for ``QueryStringCacheKeys``, CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin. + If you specify true for ``QueryString`` and you specify one or more values for ``QueryStringCacheKeys``, CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify. + If you specify false for ``QueryString``, CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters. + For more information, see [Configuring CloudFront to Cache Based on Query String Parameters](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/QueryStringParameters.html) in the *Amazon CloudFront Developer Guide*. +* **QueryStringCacheKeys**: string[]: This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. + If you want to include query strings in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*. + If you want to send query strings to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*. + A complex type that contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior. -## OriginShield +## FrameOptions ### Properties -* **Enabled**: bool -* **OriginShieldRegion**: string +* **FrameOption**: string (Required) +* **Override**: bool (Required) -## S3OriginConfig +## FunctionAssociation ### Properties -* **OriginAccessIdentity**: string +* **EventType**: string: The event type of the function, either ``viewer-request`` or ``viewer-response``. You cannot use origin-facing event types (``origin-request`` and ``origin-response``) with a CloudFront function. +* **FunctionARN**: string: The Amazon Resource Name (ARN) of the function. -## Restrictions +## FunctionConfig ### Properties -* **GeoRestriction**: [GeoRestriction](#georestriction) (Required) +* **Comment**: string (Required) +* **KeyValueStoreAssociations**: [KeyValueStoreAssociation](#keyvaluestoreassociation)[] +* **Runtime**: string (Required) -## GeoRestriction +## FunctionMetadata ### Properties -* **Locations**: string[] -* **RestrictionType**: string (Required) +* **FunctionARN**: string (ReadOnly, Identifier) -## LegacyS3Origin +## GeoRestriction ### Properties -* **DNSName**: string (Required) -* **OriginAccessIdentity**: string +* **Locations**: string[]: A complex type that contains a ``Location`` element for each country in which you want CloudFront either to distribute your content (``whitelist``) or not distribute your content (``blacklist``). + The ``Location`` element is a two-letter, uppercase country code for a country that you want to include in your ``blacklist`` or ``whitelist``. Include one ``Location`` element for each country. + CloudFront and ``MaxMind`` both use ``ISO 3166`` country codes. For the current list of countries and the corresponding codes, see ``ISO 3166-1-alpha-2`` code on the *International Organization for Standardization* website. You can also refer to the country list on the CloudFront console, which includes both country names and codes. +* **RestrictionType**: string (Required): The method that you want to use to restrict distribution of your content by country: + + ``none``: No geo restriction is enabled, meaning access to content is not restricted by client geo location. + + ``blacklist``: The ``Location`` elements specify the countries in which you don't want CloudFront to distribute your content. + + ``whitelist``: The ``Location`` elements specify the countries in which you want CloudFront to distribute your content. -## ViewerCertificate +## HeadersConfig ### Properties -* **AcmCertificateArn**: string -* **CloudFrontDefaultCertificate**: bool -* **IamCertificateId**: string -* **MinimumProtocolVersion**: string -* **SslSupportMethod**: string +* **HeaderBehavior**: string (Required) +* **Headers**: string[] -## Tag +## HeadersConfig ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **HeaderBehavior**: string (Required) +* **Headers**: string[] -## AWS.CloudFront/FunctionProperties +## ImportSource ### Properties -* **AutoPublish**: bool (WriteOnly) -* **FunctionARN**: string (ReadOnly, Identifier) -* **FunctionCode**: string (Required) -* **FunctionConfig**: [FunctionConfig](#functionconfig) (Required) -* **FunctionMetadata**: [FunctionMetadata](#functionmetadata) -* **Name**: string (Required) -* **Stage**: string (ReadOnly) +* **SourceArn**: string (Required) +* **SourceType**: string (Required) -## FunctionConfig +## KeyGroupConfig ### Properties -* **Comment**: string (Required) -* **KeyValueStoreAssociations**: [KeyValueStoreAssociation](#keyvaluestoreassociation)[] -* **Runtime**: string (Required) +* **Comment**: string +* **Items**: string[] (Required) +* **Name**: string (Required) ## KeyValueStoreAssociation ### Properties * **KeyValueStoreARN**: string (Required) -## FunctionMetadata +## KinesisStreamConfig ### Properties -* **FunctionARN**: string (ReadOnly, Identifier) +* **RoleArn**: string (Required) +* **StreamArn**: string (Required) -## AWS.CloudFront/KeyGroupProperties +## LambdaFunctionAssociation ### Properties -* **Id**: string (ReadOnly, Identifier) -* **KeyGroupConfig**: [KeyGroupConfig](#keygroupconfig) (Required) -* **LastModifiedTime**: string (ReadOnly) +* **EventType**: string: Specifies the event type that triggers a Lambda@Edge function invocation. You can specify the following values: + + ``viewer-request``: The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache. + + ``origin-request``: The function executes only when CloudFront sends a request to your origin. When the requested object is in the edge cache, the function doesn't execute. + + ``origin-response``: The function executes after CloudFront receives a response from the origin and before it caches the object in the response. When the requested object is in the edge cache, the function doesn't execute. + + ``viewer-response``: The function executes before CloudFront returns the requested object to the viewer. The function executes regardless of whether the object was already in the edge cache. + If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute. +* **IncludeBody**: bool: A flag that allows a Lambda@Edge function to have read access to the body content. For more information, see [Accessing the Request Body by Choosing the Include Body Option](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/lambda-include-body-access.html) in the Amazon CloudFront Developer Guide. +* **LambdaFunctionARN**: string: The ARN of the Lambda@Edge function. You must specify the ARN of a function version; you can't specify an alias or $LATEST. -## KeyGroupConfig +## LegacyCustomOrigin ### Properties -* **Comment**: string -* **Items**: string[] (Required) -* **Name**: string (Required) +* **DNSName**: string (Required) +* **HTTPPort**: int +* **HTTPSPort**: int +* **OriginProtocolPolicy**: string (Required) +* **OriginSSLProtocols**: string[] (Required) -## AWS.CloudFront/KeyValueStoreProperties +## LegacyS3Origin ### Properties -* **Arn**: string (ReadOnly) -* **Comment**: string -* **Id**: string (ReadOnly) -* **ImportSource**: [ImportSource](#importsource) (WriteOnly) -* **Name**: string (Required, Identifier) -* **Status**: string (ReadOnly) +* **DNSName**: string (Required) +* **OriginAccessIdentity**: string -## ImportSource +## Logging ### Properties -* **SourceArn**: string (Required) -* **SourceType**: string (Required) +* **Bucket**: string (Required): The Amazon S3 bucket to store the access logs in, for example, ``myawslogbucket.s3.amazonaws.com``. +* **IncludeCookies**: bool: Specifies whether you want CloudFront to include cookies in access logs, specify ``true`` for ``IncludeCookies``. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you don't want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify ``false`` for ``IncludeCookies``. +* **Prefix**: string: An optional string that you want CloudFront to prefix to the access log ``filenames`` for this distribution, for example, ``myprefix/``. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty ``Prefix`` element in the ``Logging`` element. -## AWS.CloudFront/OriginAccessControlProperties +## Origin ### Properties -* **Id**: string (ReadOnly, Identifier) -* **OriginAccessControlConfig**: [OriginAccessControlConfig](#originaccesscontrolconfig) (Required) +* **ConnectionAttempts**: int: The number of times that CloudFront attempts to connect to the origin. The minimum number is 1, the maximum is 3, and the default (if you don't specify otherwise) is 3. + For a custom origin (including an Amazon S3 bucket that's configured with static website hosting), this value also specifies the number of times that CloudFront attempts to get a response from the origin, in the case of an [Origin Response Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginResponseTimeout). + For more information, see [Origin Connection Attempts](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#origin-connection-attempts) in the *Amazon CloudFront Developer Guide*. +* **ConnectionTimeout**: int: The number of seconds that CloudFront waits when trying to establish a connection to the origin. The minimum timeout is 1 second, the maximum is 10 seconds, and the default (if you don't specify otherwise) is 10 seconds. + For more information, see [Origin Connection Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#origin-connection-timeout) in the *Amazon CloudFront Developer Guide*. +* **CustomOriginConfig**: [CustomOriginConfig](#customoriginconfig): Use this type to specify an origin that is not an Amazon S3 bucket, with one exception. If the Amazon S3 bucket is configured with static website hosting, use this type. If the Amazon S3 bucket is not configured with static website hosting, use the ``S3OriginConfig`` type instead. +* **DomainName**: string (Required): The domain name for the origin. + For 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*. +* **Id**: string (Required, Identifier): A unique identifier for the origin. This value must be unique within the distribution. + Use this value to specify the ``TargetOriginId`` in a ``CacheBehavior`` or ``DefaultCacheBehavior``. +* **OriginAccessControlId**: string: The unique identifier of an origin access control for this origin. + For more information, see [Restricting access to an Amazon S3 origin](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html) in the *Amazon CloudFront Developer Guide*. +* **OriginCustomHeaders**: [OriginCustomHeader](#origincustomheader)[]: A list of HTTP header names and values that CloudFront adds to the requests that it sends to the origin. + For more information, see [Adding Custom Headers to Origin Requests](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/add-origin-custom-headers.html) in the *Amazon CloudFront Developer Guide*. +* **OriginPath**: string: An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin. + For more information, see [Origin Path](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginPath) in the *Amazon CloudFront Developer Guide*. +* **OriginShield**: [OriginShield](#originshield): CloudFront Origin Shield. Using Origin Shield can help reduce the load on your origin. + For more information, see [Using Origin Shield](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html) in the *Amazon CloudFront Developer Guide*. +* **S3OriginConfig**: [S3OriginConfig](#s3originconfig): Use this type to specify an origin that is an Amazon S3 bucket that is not configured with static website hosting. To specify any other type of origin, including an Amazon S3 bucket that is configured with static website hosting, use the ``CustomOriginConfig`` type instead. ## OriginAccessControlConfig ### Properties @@ -453,11 +596,34 @@ * **SigningBehavior**: string (Required) * **SigningProtocol**: string (Required) -## AWS.CloudFront/OriginRequestPolicyProperties +## OriginCustomHeader ### Properties -* **Id**: string (ReadOnly, Identifier) -* **LastModifiedTime**: string (ReadOnly) -* **OriginRequestPolicyConfig**: [OriginRequestPolicyConfig](#originrequestpolicyconfig) (Required) +* **HeaderName**: string (Required): The name of a header that you want CloudFront to send to your origin. For more information, see [Adding Custom Headers to Origin Requests](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/forward-custom-headers.html) in the *Amazon CloudFront Developer Guide*. +* **HeaderValue**: string (Required): The value for the header that you specified in the ``HeaderName`` field. + +## OriginGroup +### Properties +* **FailoverCriteria**: [OriginGroupFailoverCriteria](#origingroupfailovercriteria) (Required): A complex type that contains information about the failover criteria for an origin group. +* **Id**: string (Required, Identifier): The origin group's ID. +* **Members**: [OriginGroupMembers](#origingroupmembers) (Required): A complex type that contains information about the origins in an origin group. + +## OriginGroupFailoverCriteria +### Properties +* **StatusCodes**: [StatusCodes](#statuscodes) (Required): The status codes that, when returned from the primary origin, will trigger CloudFront to failover to the second origin. + +## OriginGroupMember +### Properties +* **OriginId**: string (Required): The ID for an origin in an origin group. + +## OriginGroupMembers +### Properties +* **Items**: [OriginGroupMember](#origingroupmember)[] (Required): Items (origins) in an origin group. +* **Quantity**: int (Required): The number of origins in an origin group. + +## OriginGroups +### Properties +* **Items**: [OriginGroup](#origingroup)[]: The items (origin groups) in a distribution. +* **Quantity**: int (Required): The number of origin groups. ## OriginRequestPolicyConfig ### Properties @@ -467,26 +633,21 @@ * **Name**: string (Required) * **QueryStringsConfig**: [QueryStringsConfig](#querystringsconfig) (Required) -## CookiesConfig -### Properties -* **CookieBehavior**: string (Required) -* **Cookies**: string[] - -## HeadersConfig -### Properties -* **HeaderBehavior**: string (Required) -* **Headers**: string[] - -## QueryStringsConfig +## OriginShield ### Properties -* **QueryStringBehavior**: string (Required) -* **QueryStrings**: string[] +* **Enabled**: bool: A flag that specifies whether Origin Shield is enabled. + When it's enabled, CloudFront routes all requests through Origin Shield, which can help protect your origin. When it's disabled, CloudFront might send requests directly to your origin from multiple edge locations or regional edge caches. +* **OriginShieldRegion**: string: The AWS-Region for Origin Shield. + Specify the AWS-Region that has the lowest latency to your origin. To specify a region, use the region code, not the region name. For example, specify the US East (Ohio) region as ``us-east-2``. + When you enable CloudFront Origin Shield, you must specify the AWS-Region for Origin Shield. For the list of AWS-Regions that you can specify, and for help choosing the best Region for your origin, see [Choosing the for Origin Shield](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html#choose-origin-shield-region) in the *Amazon CloudFront Developer Guide*. -## AWS.CloudFront/PublicKeyProperties +## ParametersInCacheKeyAndForwardedToOrigin ### Properties -* **CreatedTime**: string (ReadOnly) -* **Id**: string (ReadOnly, Identifier) -* **PublicKeyConfig**: [PublicKeyConfig](#publickeyconfig) (Required) +* **CookiesConfig**: [CookiesConfig](#cookiesconfig) (Required) +* **EnableAcceptEncodingBrotli**: bool +* **EnableAcceptEncodingGzip**: bool (Required) +* **HeadersConfig**: [HeadersConfig](#headersconfig) (Required) +* **QueryStringsConfig**: [QueryStringsConfig](#querystringsconfig) (Required) ## PublicKeyConfig ### Properties @@ -495,29 +656,28 @@ * **EncodedKey**: string (Required) * **Name**: string (Required) -## AWS.CloudFront/RealtimeLogConfigProperties +## QueryStringsConfig ### Properties -* **Arn**: string (ReadOnly, Identifier) -* **EndPoints**: [EndPoint](#endpoint)[] (Required) -* **Fields**: string[] (Required) -* **Name**: string (Required) -* **SamplingRate**: int (Required) +* **QueryStringBehavior**: string (Required) +* **QueryStrings**: string[] -## EndPoint +## QueryStringsConfig ### Properties -* **KinesisStreamConfig**: [KinesisStreamConfig](#kinesisstreamconfig) (Required) -* **StreamType**: string (Required) +* **QueryStringBehavior**: string (Required) +* **QueryStrings**: string[] -## KinesisStreamConfig +## ReferrerPolicy ### Properties -* **RoleArn**: string (Required) -* **StreamArn**: string (Required) +* **Override**: bool (Required) +* **ReferrerPolicy**: string (Required) -## AWS.CloudFront/ResponseHeadersPolicyProperties +## RemoveHeader ### Properties -* **Id**: string (ReadOnly, Identifier) -* **LastModifiedTime**: string (ReadOnly) -* **ResponseHeadersPolicyConfig**: [ResponseHeadersPolicyConfig](#responseheaderspolicyconfig) (Required) +* **Header**: string (Required) + +## RemoveHeadersConfig +### Properties +* **Items**: [RemoveHeader](#removeheader)[] (Required) ## ResponseHeadersPolicyConfig ### Properties @@ -529,49 +689,19 @@ * **SecurityHeadersConfig**: [SecurityHeadersConfig](#securityheadersconfig) * **ServerTimingHeadersConfig**: [ServerTimingHeadersConfig](#servertimingheadersconfig) -## CorsConfig -### Properties -* **AccessControlAllowCredentials**: bool (Required) -* **AccessControlAllowHeaders**: [AccessControlAllowHeaders](#accesscontrolallowheaders) (Required) -* **AccessControlAllowMethods**: [AccessControlAllowMethods](#accesscontrolallowmethods) (Required) -* **AccessControlAllowOrigins**: [AccessControlAllowOrigins](#accesscontrolalloworigins) (Required) -* **AccessControlExposeHeaders**: [AccessControlExposeHeaders](#accesscontrolexposeheaders) -* **AccessControlMaxAgeSec**: int -* **OriginOverride**: bool (Required) - -## AccessControlAllowHeaders -### Properties -* **Items**: string[] (Required) - -## AccessControlAllowMethods -### Properties -* **Items**: string[] (Required) - -## AccessControlAllowOrigins -### Properties -* **Items**: string[] (Required) - -## AccessControlExposeHeaders -### Properties -* **Items**: string[] (Required) - -## CustomHeadersConfig -### Properties -* **Items**: [CustomHeader](#customheader)[] (Required) - -## CustomHeader -### Properties -* **Header**: string (Required) -* **Override**: bool (Required) -* **Value**: string (Required) - -## RemoveHeadersConfig +## Restrictions ### Properties -* **Items**: [RemoveHeader](#removeheader)[] (Required) +* **GeoRestriction**: [GeoRestriction](#georestriction) (Required): A complex type that controls the countries in which your content is distributed. CF determines the location of your users using ``MaxMind`` GeoIP databases. To disable geo restriction, remove the [Restrictions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-restrictions) property from your stack template. -## RemoveHeader +## S3OriginConfig ### Properties -* **Header**: string (Required) +* **OriginAccessIdentity**: string: The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can *only* access objects in an Amazon S3 bucket through CloudFront. The format of the value is: + origin-access-identity/cloudfront/*ID-of-origin-access-identity* + where ``ID-of-origin-access-identity`` is the value that CloudFront returned in the ``ID`` element when you created the origin access identity. + If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty ``OriginAccessIdentity`` element. + To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty ``OriginAccessIdentity`` element. + To replace the origin access identity, update the distribution configuration and specify the new origin access identity. + For more information about the origin access identity, see [Serving Private Content through CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*. ## SecurityHeadersConfig ### Properties @@ -582,24 +712,30 @@ * **StrictTransportSecurity**: [StrictTransportSecurity](#stricttransportsecurity) * **XSSProtection**: [XSSProtection](#xssprotection) -## ContentSecurityPolicy +## ServerTimingHeadersConfig ### Properties -* **ContentSecurityPolicy**: string (Required) -* **Override**: bool (Required) +* **Enabled**: bool (Required) +* **SamplingRate**: int -## ContentTypeOptions +## SessionStickinessConfig ### Properties -* **Override**: bool (Required) +* **IdleTTL**: int (Required) +* **MaximumTTL**: int (Required) -## FrameOptions +## SingleHeaderConfig ### Properties -* **FrameOption**: string (Required) -* **Override**: bool (Required) +* **Header**: string (Required) +* **Value**: string (Required) -## ReferrerPolicy +## SingleWeightConfig ### Properties -* **Override**: bool (Required) -* **ReferrerPolicy**: string (Required) +* **SessionStickinessConfig**: [SessionStickinessConfig](#sessionstickinessconfig) +* **Weight**: int (Required) + +## StatusCodes +### Properties +* **Items**: int[] (Required): The items (status codes) for an origin group. +* **Quantity**: int (Required): The number of status codes. ## StrictTransportSecurity ### Properties @@ -608,6 +744,48 @@ * **Override**: bool (Required) * **Preload**: bool +## Tag +### Properties +* **Key**: string (Required): A string that contains ``Tag`` key. + The string length should be between 1 and 128 characters. Valid characters include ``a-z``, ``A-Z``, ``0-9``, space, and the special characters ``_ - . : / = + @``. +* **Value**: string (Required): A string that contains an optional ``Tag`` value. + The string length should be between 0 and 256 characters. Valid characters include ``a-z``, ``A-Z``, ``0-9``, space, and the special characters ``_ - . : / = + @``. + +## TrafficConfig +### Properties +* **SingleHeaderConfig**: [SingleHeaderConfig](#singleheaderconfig) +* **SingleWeightConfig**: [SingleWeightConfig](#singleweightconfig) +* **Type**: string (Required) + +## ViewerCertificate +### Properties +* **AcmCertificateArn**: string: In CloudFormation, this field name is ``AcmCertificateArn``. Note the different capitalization. + If the distribution uses ``Aliases`` (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in [(ACM)](https://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html), provide the Amazon Resource Name (ARN) of the ACM certificate. CloudFront only supports ACM certificates in the US East (N. Virginia) Region (``us-east-1``). + If you specify an ACM certificate ARN, you must also specify values for ``MinimumProtocolVersion`` and ``SSLSupportMethod``. (In CloudFormation, the field name is ``SslSupportMethod``. Note the different capitalization.) +* **CloudFrontDefaultCertificate**: bool: If the distribution uses the CloudFront domain name such as ``d111111abcdef8.cloudfront.net``, set this field to ``true``. + If the distribution uses ``Aliases`` (alternate domain names or CNAMEs), omit this field and specify values for the following fields: + + ``AcmCertificateArn`` or ``IamCertificateId`` (specify a value for one, not both) + + ``MinimumProtocolVersion`` + + ``SslSupportMethod`` +* **IamCertificateId**: string: In CloudFormation, this field name is ``IamCertificateId``. Note the different capitalization. + If the distribution uses ``Aliases`` (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in [(IAM)](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html), provide the ID of the IAM certificate. + If you specify an IAM certificate ID, you must also specify values for ``MinimumProtocolVersion`` and ``SSLSupportMethod``. (In CloudFormation, the field name is ``SslSupportMethod``. Note the different capitalization.) +* **MinimumProtocolVersion**: string: If the distribution uses ``Aliases`` (alternate domain names or CNAMEs), specify the security policy that you want CloudFront to use for HTTPS connections with viewers. The security policy determines two settings: + + The minimum SSL/TLS protocol that CloudFront can use to communicate with viewers. + + The ciphers that CloudFront can use to encrypt the content that it returns to viewers. + + For more information, see [Security Policy](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValues-security-policy) and [Supported Protocols and Ciphers Between Viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html#secure-connections-supported-ciphers) in the *Amazon CloudFront Developer Guide*. + On the CloudFront console, this setting is called *Security Policy*. + When you're using SNI only (you set ``SSLSupportMethod`` to ``sni-only``), you must specify ``TLSv1`` or higher. (In CloudFormation, the field name is ``SslSupportMethod``. Note the different capitalization.) + If the distribution uses the CloudFront domain name such as ``d111111abcdef8.cloudfront.net`` (you set ``CloudFrontDefaultCertificate`` to ``true``), CloudFront automatically sets the security policy to ``TLSv1`` regardless of the value that you set here. +* **SslSupportMethod**: string: In CloudFormation, this field name is ``SslSupportMethod``. Note the different capitalization. + If the distribution uses ``Aliases`` (alternate domain names or CNAMEs), specify which viewers the distribution accepts HTTPS connections from. + + ``sni-only`` ? The distribution accepts HTTPS connections from only viewers that support [server name indication (SNI)](https://docs.aws.amazon.com/https://en.wikipedia.org/wiki/Server_Name_Indication). This is recommended. Most browsers and clients support SNI. + + ``vip`` ? The distribution accepts HTTPS connections from all viewers including those that don't support SNI. This is not recommended, and results in additional monthly charges from CloudFront. + + ``static-ip`` - Do not specify this value unless your distribution has been enabled for this feature by the CloudFront team. If you have a use case that requires static IP addresses for a distribution, contact CloudFront through the [Center](https://docs.aws.amazon.com/support/home). + + If the distribution uses the CloudFront domain name such as ``d111111abcdef8.cloudfront.net``, don't set a value for this field. + ## XSSProtection ### Properties * **ModeBlock**: bool @@ -615,8 +793,3 @@ * **Protection**: bool (Required) * **ReportUri**: string -## ServerTimingHeadersConfig -### Properties -* **Enabled**: bool (Required) -* **SamplingRate**: int - diff --git a/artifacts/bicep/aws/aws.cloudtrail/default/types.json b/artifacts/bicep/aws/aws.cloudtrail/default/types.json index 993a42ad..fd0fbdf6 100644 --- a/artifacts/bicep/aws/aws.cloudtrail/default/types.json +++ b/artifacts/bicep/aws/aws.cloudtrail/default/types.json @@ -1 +1,995 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"ChannelArn"}},{"2":{"Name":"ChannelName"}},{"2":{"Name":"Destination","Properties":{"Location":{"Type":4,"Flags":1,"Description":"The ARN of a resource that receives events from a channel."},"Type":{"Type":4,"Flags":1,"Description":"The type of destination for events arriving from a channel."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"Timestamp"}},{"2":{"Name":"UUID"}},{"2":{"Name":"AWS.CloudTrail/ChannelProperties","Properties":{"ChannelArn":{"Type":4,"Flags":18},"Destinations":{"Type":15,"Flags":0,"Description":"One or more resources to which events arriving through a channel are logged and stored."},"Name":{"Type":4,"Flags":0},"Source":{"Type":4,"Flags":0,"Description":"The ARN of an on-premises storage solution or application, or a partner event source."},"Tags":{"Type":16,"Flags":4,"Description":"An array of key-value pairs to apply to this resource."}}}},{"3":{"ItemType":10}},{"3":{"ItemType":11}},{"2":{"Name":"AWS.CloudTrail/Channel","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":14,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.CloudTrail/Channel@default","ScopeType":0,"Body":17}},{"2":{"Name":"AdvancedEventSelector","Properties":{"FieldSelectors":{"Type":24,"Flags":1,"Description":"Contains all selector statements in an advanced event selector."},"Name":{"Type":4,"Flags":0,"Description":"An optional, descriptive name for an advanced event selector, such as \"Log data events for only two S3 buckets\"."}}}},{"2":{"Name":"AdvancedFieldSelector","Properties":{"EndsWith":{"Type":25,"Flags":0,"Description":"An operator that includes events that match the last few characters of the event record field specified as the value of Field."},"Equals":{"Type":26,"Flags":0,"Description":"An operator that includes events that match the exact value of the event record field specified as the value of Field. This is the only valid operator that you can use with the readOnly, eventCategory, and resources.type fields."},"Field":{"Type":4,"Flags":1,"Description":"A field in an event record on which to filter events to be logged. Supported fields include readOnly, eventCategory, eventSource (for management events), eventName, resources.type, and resources.ARN."},"NotEndsWith":{"Type":27,"Flags":0,"Description":"An operator that excludes events that match the last few characters of the event record field specified as the value of Field."},"NotEquals":{"Type":28,"Flags":0,"Description":"An operator that excludes events that match the exact value of the event record field specified as the value of Field."},"NotStartsWith":{"Type":29,"Flags":0,"Description":"An operator that excludes events that match the first few characters of the event record field specified as the value of Field."},"StartsWith":{"Type":30,"Flags":0,"Description":"An operator that includes events that match the first few characters of the event record field specified as the value of Field."}}}},{"2":{"Name":"InsightSelector","Properties":{"InsightType":{"Type":4,"Flags":0,"Description":"The type of Insights to log on an event data store."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"Timestamp"}},{"3":{"ItemType":20}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.CloudTrail/EventDataStoreProperties","Properties":{"AdvancedEventSelectors":{"Type":32,"Flags":0,"Description":"The advanced event selectors that were used to select events for the data store."},"BillingMode":{"Type":4,"Flags":0,"Description":"The mode that the event data store will use to charge for event storage."},"CreatedTimestamp":{"Type":4,"Flags":2,"Description":"The timestamp of the event data store's creation."},"EventDataStoreArn":{"Type":4,"Flags":18,"Description":"The ARN of the event data store."},"FederationEnabled":{"Type":2,"Flags":0,"Description":"Indicates whether federation is enabled on an event data store."},"FederationRoleArn":{"Type":4,"Flags":0,"Description":"The ARN of the role used for event data store federation."},"IngestionEnabled":{"Type":2,"Flags":0,"Description":"Indicates whether the event data store is ingesting events."},"InsightSelectors":{"Type":33,"Flags":0,"Description":"Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing event data store. Both InsightSelectors and InsightsDestination need to have a value in order to enable Insights events on an event data store."},"InsightsDestination":{"Type":4,"Flags":0,"Description":"Specifies the ARN of the event data store that will collect Insights events. Both InsightSelectors and InsightsDestination need to have a value in order to enable Insights events on an event data store"},"KmsKeyId":{"Type":4,"Flags":0,"Description":"Specifies the KMS key ID to use to encrypt the events delivered by CloudTrail. The value can be an alias name prefixed by 'alias/', a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier."},"MultiRegionEnabled":{"Type":2,"Flags":0,"Description":"Indicates whether the event data store includes events from all regions, or only from the region in which it was created."},"Name":{"Type":4,"Flags":0,"Description":"The name of the event data store."},"OrganizationEnabled":{"Type":2,"Flags":0,"Description":"Indicates that an event data store is collecting logged events for an organization."},"RetentionPeriod":{"Type":3,"Flags":0,"Description":"The retention period, in days."},"Status":{"Type":4,"Flags":2,"Description":"The status of an event data store. Values are STARTING_INGESTION, ENABLED, STOPPING_INGESTION, STOPPED_INGESTION and PENDING_DELETION."},"Tags":{"Type":34,"Flags":0},"TerminationProtectionEnabled":{"Type":2,"Flags":0,"Description":"Indicates whether the event data store is protected from termination."},"UpdatedTimestamp":{"Type":4,"Flags":2,"Description":"The timestamp showing when an event data store was updated, if applicable. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp."}}}},{"3":{"ItemType":19}},{"3":{"ItemType":21}},{"3":{"ItemType":22}},{"2":{"Name":"AWS.CloudTrail/EventDataStore","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":31,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.CloudTrail/EventDataStore@default","ScopeType":0,"Body":35}},{"2":{"Name":"AWS.CloudTrail/ResourcePolicyProperties","Properties":{"ResourceArn":{"Type":4,"Flags":17,"Description":"The ARN of the AWS CloudTrail resource to which the policy applies."},"ResourcePolicy":{"Type":39,"Flags":1,"Description":"A policy document containing permissions to add to the specified resource. 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."}}}},{"2":{"Name":"ResourcePolicy_ResourcePolicy","Properties":{}}},{"5":{"Elements":[38,4]}},{"2":{"Name":"AWS.CloudTrail/ResourcePolicy","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":37,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.CloudTrail/ResourcePolicy@default","ScopeType":0,"Body":40}},{"2":{"Name":"AdvancedEventSelector","Properties":{"FieldSelectors":{"Type":48,"Flags":1,"Description":"Contains all selector statements in an advanced event selector."},"Name":{"Type":4,"Flags":0,"Description":"An optional, descriptive name for an advanced event selector, such as \"Log data events for only two S3 buckets\"."}}}},{"2":{"Name":"AdvancedFieldSelector","Properties":{"EndsWith":{"Type":49,"Flags":0,"Description":"An operator that includes events that match the last few characters of the event record field specified as the value of Field."},"Equals":{"Type":50,"Flags":0,"Description":"An operator that includes events that match the exact value of the event record field specified as the value of Field. This is the only valid operator that you can use with the readOnly, eventCategory, and resources.type fields."},"Field":{"Type":4,"Flags":1,"Description":"A field in an event record on which to filter events to be logged. Supported fields include readOnly, eventCategory, eventSource (for management events), eventName, resources.type, and resources.ARN."},"NotEndsWith":{"Type":51,"Flags":0,"Description":"An operator that excludes events that match the last few characters of the event record field specified as the value of Field."},"NotEquals":{"Type":52,"Flags":0,"Description":"An operator that excludes events that match the exact value of the event record field specified as the value of Field."},"NotStartsWith":{"Type":53,"Flags":0,"Description":"An operator that excludes events that match the first few characters of the event record field specified as the value of Field."},"StartsWith":{"Type":54,"Flags":0,"Description":"An operator that includes events that match the first few characters of the event record field specified as the value of Field."}}}},{"2":{"Name":"DataResource","Properties":{"Type":{"Type":4,"Flags":1,"Description":"The resource type in which you want to log data events. You can specify AWS::S3::Object or AWS::Lambda::Function resources."},"Values":{"Type":55,"Flags":0,"Description":"An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified objects."}}}},{"2":{"Name":"EventSelector","Properties":{"DataResources":{"Type":56,"Flags":0},"ExcludeManagementEventSources":{"Type":57,"Flags":0,"Description":"An optional list of service event sources from which you do not want management events to be logged on your trail. In this release, the list can be empty (disables the filter), or it can filter out AWS Key Management Service events by containing \"kms.amazonaws.com\". By default, ExcludeManagementEventSources is empty, and AWS KMS events are included in events that are logged to your trail."},"IncludeManagementEvents":{"Type":2,"Flags":0,"Description":"Specify if you want your event selector to include management events for your trail."},"ReadWriteType":{"Type":4,"Flags":0,"Description":"Specify if you want your trail to log read-only events, write-only events, or all. For example, the EC2 GetConsoleOutput is a read-only API operation and RunInstances is a write-only API operation."}}}},{"2":{"Name":"InsightSelector","Properties":{"InsightType":{"Type":4,"Flags":0,"Description":"The type of insight to log on a trail."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"3":{"ItemType":43}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":44}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.CloudTrail/TrailProperties","Properties":{"AdvancedEventSelectors":{"Type":59,"Flags":0,"Description":"The advanced event selectors that were used to select events for the data store."},"Arn":{"Type":4,"Flags":2},"CloudWatchLogsLogGroupArn":{"Type":4,"Flags":0,"Description":"Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn."},"CloudWatchLogsRoleArn":{"Type":4,"Flags":0,"Description":"Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group."},"EnableLogFileValidation":{"Type":2,"Flags":0,"Description":"Specifies whether log file validation is enabled. The default is false."},"EventSelectors":{"Type":60,"Flags":0,"Description":"Use event selectors to further specify the management and data event settings for your trail. By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events. When an event occurs in your account, CloudTrail evaluates the event selector for all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event. You can configure up to five event selectors for a trail."},"IncludeGlobalServiceEvents":{"Type":2,"Flags":0,"Description":"Specifies whether the trail is publishing events from global services such as IAM to the log files."},"InsightSelectors":{"Type":61,"Flags":0,"Description":"Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing trail."},"IsLogging":{"Type":2,"Flags":1,"Description":"Whether the CloudTrail is currently logging AWS API calls."},"IsMultiRegionTrail":{"Type":2,"Flags":0,"Description":"Specifies whether the trail applies only to the current region or to all regions. The default is false. If the trail exists only in the current region and this value is set to true, shadow trails (replications of the trail) will be created in the other regions. If the trail exists in all regions and this value is set to false, the trail will remain in the region where it was created, and its shadow trails in other regions will be deleted. As a best practice, consider using trails that log events in all regions."},"IsOrganizationTrail":{"Type":2,"Flags":0,"Description":"Specifies whether the trail is created for all accounts in an organization in AWS Organizations, or only for the current AWS account. The default is false, and cannot be true unless the call is made on behalf of an AWS account that is the master account for an organization in AWS Organizations."},"KMSKeyId":{"Type":4,"Flags":0,"Description":"Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be an alias name prefixed by 'alias/', a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier."},"S3BucketName":{"Type":4,"Flags":1,"Description":"Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements."},"S3KeyPrefix":{"Type":4,"Flags":0,"Description":"Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200 characters."},"SnsTopicArn":{"Type":4,"Flags":2},"SnsTopicName":{"Type":4,"Flags":0,"Description":"Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters."},"Tags":{"Type":62,"Flags":0},"TrailName":{"Type":4,"Flags":16}}}},{"3":{"ItemType":42}},{"3":{"ItemType":45}},{"3":{"ItemType":46}},{"3":{"ItemType":47}},{"2":{"Name":"AWS.CloudTrail/Trail","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":58,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.CloudTrail/Trail@default","ScopeType":0,"Body":63}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "ChannelArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ChannelName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Destination", + "properties": { + "Location": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "The ARN of a resource that receives events from a channel." + }, + "Type": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "The type of destination for events arriving from a channel." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "ObjectType", + "name": "Timestamp", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "UUID", + "properties": {} + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.CloudTrail/ChannelProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ObjectType", + "name": "AWS.CloudTrail/ChannelProperties", + "properties": { + "ChannelArn": { + "type": { + "$ref": "#/6" + }, + "flags": 18 + }, + "Destinations": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "One or more resources to which events arriving through a channel are logged and stored." + }, + "Name": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "Source": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "The ARN of an on-premises storage solution or application, or a partner event source." + }, + "Tags": { + "type": { + "$ref": "#/9" + }, + "flags": 4, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.CloudTrail/Channel", + "properties": { + "name": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/6" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/10" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.CloudTrail/Channel@default", + "scopeType": 0, + "body": { + "$ref": "#/11" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AdvancedEventSelector", + "properties": { + "FieldSelectors": { + "type": { + "$ref": "#/18" + }, + "flags": 1, + "description": "Contains all selector statements in an advanced event selector." + }, + "Name": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "An optional, descriptive name for an advanced event selector, such as \"Log data events for only two S3 buckets\"." + } + } + }, + { + "$type": "ObjectType", + "name": "AdvancedFieldSelector", + "properties": { + "EndsWith": { + "type": { + "$ref": "#/19" + }, + "flags": 0, + "description": "An operator that includes events that match the last few characters of the event record field specified as the value of Field." + }, + "Equals": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "An operator that includes events that match the exact value of the event record field specified as the value of Field. This is the only valid operator that you can use with the readOnly, eventCategory, and resources.type fields." + }, + "Field": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "A field in an event record on which to filter events to be logged. Supported fields include readOnly, eventCategory, eventSource (for management events), eventName, resources.type, and resources.ARN." + }, + "NotEndsWith": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "An operator that excludes events that match the last few characters of the event record field specified as the value of Field." + }, + "NotEquals": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "An operator that excludes events that match the exact value of the event record field specified as the value of Field." + }, + "NotStartsWith": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "An operator that excludes events that match the first few characters of the event record field specified as the value of Field." + }, + "StartsWith": { + "type": { + "$ref": "#/24" + }, + "flags": 0, + "description": "An operator that includes events that match the first few characters of the event record field specified as the value of Field." + } + } + }, + { + "$type": "ObjectType", + "name": "InsightSelector", + "properties": { + "InsightType": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "The type of Insights to log on an event data store." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "ObjectType", + "name": "Timestamp", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/14" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.CloudTrail/EventDataStoreProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/15" + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/16" + } + }, + { + "$type": "ObjectType", + "name": "AWS.CloudTrail/EventDataStoreProperties", + "properties": { + "AdvancedEventSelectors": { + "type": { + "$ref": "#/26" + }, + "flags": 0, + "description": "The advanced event selectors that were used to select events for the data store." + }, + "BillingMode": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "The mode that the event data store will use to charge for event storage." + }, + "CreatedTimestamp": { + "type": { + "$ref": "#/6" + }, + "flags": 2, + "description": "The timestamp of the event data store's creation." + }, + "EventDataStoreArn": { + "type": { + "$ref": "#/6" + }, + "flags": 18, + "description": "The ARN of the event data store." + }, + "FederationEnabled": { + "type": { + "$ref": "#/27" + }, + "flags": 0, + "description": "Indicates whether federation is enabled on an event data store." + }, + "FederationRoleArn": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "The ARN of the role used for event data store federation." + }, + "IngestionEnabled": { + "type": { + "$ref": "#/27" + }, + "flags": 0, + "description": "Indicates whether the event data store is ingesting events." + }, + "InsightSelectors": { + "type": { + "$ref": "#/28" + }, + "flags": 0, + "description": "Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing event data store. Both InsightSelectors and InsightsDestination need to have a value in order to enable Insights events on an event data store." + }, + "InsightsDestination": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Specifies the ARN of the event data store that will collect Insights events. Both InsightSelectors and InsightsDestination need to have a value in order to enable Insights events on an event data store" + }, + "KmsKeyId": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Specifies the KMS key ID to use to encrypt the events delivered by CloudTrail. The value can be an alias name prefixed by 'alias/', a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier." + }, + "MultiRegionEnabled": { + "type": { + "$ref": "#/27" + }, + "flags": 0, + "description": "Indicates whether the event data store includes events from all regions, or only from the region in which it was created." + }, + "Name": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "The name of the event data store." + }, + "OrganizationEnabled": { + "type": { + "$ref": "#/27" + }, + "flags": 0, + "description": "Indicates that an event data store is collecting logged events for an organization." + }, + "RetentionPeriod": { + "type": { + "$ref": "#/29" + }, + "flags": 0, + "description": "The retention period, in days." + }, + "Status": { + "type": { + "$ref": "#/6" + }, + "flags": 2, + "description": "The status of an event data store. Values are STARTING_INGESTION, ENABLED, STOPPING_INGESTION, STOPPED_INGESTION and PENDING_DELETION." + }, + "Tags": { + "type": { + "$ref": "#/30" + }, + "flags": 0 + }, + "TerminationProtectionEnabled": { + "type": { + "$ref": "#/27" + }, + "flags": 0, + "description": "Indicates whether the event data store is protected from termination." + }, + "UpdatedTimestamp": { + "type": { + "$ref": "#/6" + }, + "flags": 2, + "description": "The timestamp showing when an event data store was updated, if applicable. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.CloudTrail/EventDataStore", + "properties": { + "name": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/6" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/31" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.CloudTrail/EventDataStore@default", + "scopeType": 0, + "body": { + "$ref": "#/32" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.CloudTrail/ResourcePolicyProperties" + }, + { + "$type": "ObjectType", + "name": "ResourcePolicy_ResourcePolicy", + "properties": {} + }, + { + "$type": "UnionType", + "elements": [ + { + "$ref": "#/35" + }, + { + "$ref": "#/6" + } + ] + }, + { + "$type": "ObjectType", + "name": "AWS.CloudTrail/ResourcePolicyProperties", + "properties": { + "ResourceArn": { + "type": { + "$ref": "#/6" + }, + "flags": 17, + "description": "The ARN of the AWS CloudTrail resource to which the policy applies." + }, + "ResourcePolicy": { + "type": { + "$ref": "#/36" + }, + "flags": 1, + "description": "A policy document containing permissions to add to the specified resource. 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." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.CloudTrail/ResourcePolicy", + "properties": { + "name": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/6" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/37" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.CloudTrail/ResourcePolicy@default", + "scopeType": 0, + "body": { + "$ref": "#/38" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AdvancedEventSelector", + "properties": { + "FieldSelectors": { + "type": { + "$ref": "#/46" + }, + "flags": 1, + "description": "Contains all selector statements in an advanced event selector." + }, + "Name": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "An optional, descriptive name for an advanced event selector, such as \"Log data events for only two S3 buckets\"." + } + } + }, + { + "$type": "ObjectType", + "name": "AdvancedFieldSelector", + "properties": { + "EndsWith": { + "type": { + "$ref": "#/47" + }, + "flags": 0, + "description": "An operator that includes events that match the last few characters of the event record field specified as the value of Field." + }, + "Equals": { + "type": { + "$ref": "#/48" + }, + "flags": 0, + "description": "An operator that includes events that match the exact value of the event record field specified as the value of Field. This is the only valid operator that you can use with the readOnly, eventCategory, and resources.type fields." + }, + "Field": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "A field in an event record on which to filter events to be logged. Supported fields include readOnly, eventCategory, eventSource (for management events), eventName, resources.type, and resources.ARN." + }, + "NotEndsWith": { + "type": { + "$ref": "#/49" + }, + "flags": 0, + "description": "An operator that excludes events that match the last few characters of the event record field specified as the value of Field." + }, + "NotEquals": { + "type": { + "$ref": "#/50" + }, + "flags": 0, + "description": "An operator that excludes events that match the exact value of the event record field specified as the value of Field." + }, + "NotStartsWith": { + "type": { + "$ref": "#/51" + }, + "flags": 0, + "description": "An operator that excludes events that match the first few characters of the event record field specified as the value of Field." + }, + "StartsWith": { + "type": { + "$ref": "#/52" + }, + "flags": 0, + "description": "An operator that includes events that match the first few characters of the event record field specified as the value of Field." + } + } + }, + { + "$type": "ObjectType", + "name": "DataResource", + "properties": { + "Type": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "The resource type in which you want to log data events. You can specify AWS::S3::Object or AWS::Lambda::Function resources." + }, + "Values": { + "type": { + "$ref": "#/53" + }, + "flags": 0, + "description": "An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified objects." + } + } + }, + { + "$type": "ObjectType", + "name": "EventSelector", + "properties": { + "DataResources": { + "type": { + "$ref": "#/54" + }, + "flags": 0 + }, + "ExcludeManagementEventSources": { + "type": { + "$ref": "#/55" + }, + "flags": 0, + "description": "An optional list of service event sources from which you do not want management events to be logged on your trail. In this release, the list can be empty (disables the filter), or it can filter out AWS Key Management Service events by containing \"kms.amazonaws.com\". By default, ExcludeManagementEventSources is empty, and AWS KMS events are included in events that are logged to your trail." + }, + "IncludeManagementEvents": { + "type": { + "$ref": "#/27" + }, + "flags": 0, + "description": "Specify if you want your event selector to include management events for your trail." + }, + "ReadWriteType": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Specify if you want your trail to log read-only events, write-only events, or all. For example, the EC2 GetConsoleOutput is a read-only API operation and RunInstances is a write-only API operation." + } + } + }, + { + "$type": "ObjectType", + "name": "InsightSelector", + "properties": { + "InsightType": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "The type of insight to log on a trail." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/41" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/42" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.CloudTrail/TrailProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/40" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/43" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/44" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/45" + } + }, + { + "$type": "ObjectType", + "name": "AWS.CloudTrail/TrailProperties", + "properties": { + "AdvancedEventSelectors": { + "type": { + "$ref": "#/57" + }, + "flags": 0, + "description": "The advanced event selectors that were used to select events for the data store." + }, + "Arn": { + "type": { + "$ref": "#/6" + }, + "flags": 2 + }, + "CloudWatchLogsLogGroupArn": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn." + }, + "CloudWatchLogsRoleArn": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group." + }, + "EnableLogFileValidation": { + "type": { + "$ref": "#/27" + }, + "flags": 0, + "description": "Specifies whether log file validation is enabled. The default is false." + }, + "EventSelectors": { + "type": { + "$ref": "#/58" + }, + "flags": 0, + "description": "Use event selectors to further specify the management and data event settings for your trail. By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events. When an event occurs in your account, CloudTrail evaluates the event selector for all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event. You can configure up to five event selectors for a trail." + }, + "IncludeGlobalServiceEvents": { + "type": { + "$ref": "#/27" + }, + "flags": 0, + "description": "Specifies whether the trail is publishing events from global services such as IAM to the log files." + }, + "InsightSelectors": { + "type": { + "$ref": "#/59" + }, + "flags": 0, + "description": "Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing trail." + }, + "IsLogging": { + "type": { + "$ref": "#/27" + }, + "flags": 1, + "description": "Whether the CloudTrail is currently logging AWS API calls." + }, + "IsMultiRegionTrail": { + "type": { + "$ref": "#/27" + }, + "flags": 0, + "description": "Specifies whether the trail applies only to the current region or to all regions. The default is false. If the trail exists only in the current region and this value is set to true, shadow trails (replications of the trail) will be created in the other regions. If the trail exists in all regions and this value is set to false, the trail will remain in the region where it was created, and its shadow trails in other regions will be deleted. As a best practice, consider using trails that log events in all regions." + }, + "IsOrganizationTrail": { + "type": { + "$ref": "#/27" + }, + "flags": 0, + "description": "Specifies whether the trail is created for all accounts in an organization in AWS Organizations, or only for the current AWS account. The default is false, and cannot be true unless the call is made on behalf of an AWS account that is the master account for an organization in AWS Organizations." + }, + "KMSKeyId": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be an alias name prefixed by 'alias/', a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier." + }, + "S3BucketName": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements." + }, + "S3KeyPrefix": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200 characters." + }, + "SnsTopicArn": { + "type": { + "$ref": "#/6" + }, + "flags": 2 + }, + "SnsTopicName": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters." + }, + "Tags": { + "type": { + "$ref": "#/60" + }, + "flags": 0 + }, + "TrailName": { + "type": { + "$ref": "#/6" + }, + "flags": 16 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.CloudTrail/Trail", + "properties": { + "name": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/6" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/61" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.CloudTrail/Trail@default", + "scopeType": 0, + "body": { + "$ref": "#/62" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.cloudtrail/default/types.md b/artifacts/bicep/aws/aws.cloudtrail/default/types.md index e2ed0096..8f331e83 100644 --- a/artifacts/bicep/aws/aws.cloudtrail/default/types.md +++ b/artifacts/bicep/aws/aws.cloudtrail/default/types.md @@ -3,30 +3,60 @@ ## Resource AWS.CloudTrail/Channel@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.CloudTrail/ChannelProperties](#awscloudtrailchannelproperties): properties of the resource +* **properties**: [AWS.CloudTrail/ChannelProperties](#awscloudtrailchannelproperties) (Identifier): properties of the resource ## Resource AWS.CloudTrail/EventDataStore@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.CloudTrail/EventDataStoreProperties](#awscloudtraileventdatastoreproperties): properties of the resource +* **properties**: [AWS.CloudTrail/EventDataStoreProperties](#awscloudtraileventdatastoreproperties) (Identifier): properties of the resource ## Resource AWS.CloudTrail/ResourcePolicy@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.CloudTrail/ResourcePolicyProperties](#awscloudtrailresourcepolicyproperties) (Required): properties of the resource +* **properties**: [AWS.CloudTrail/ResourcePolicyProperties](#awscloudtrailresourcepolicyproperties) (Required, Identifier): properties of the resource ## Resource AWS.CloudTrail/Trail@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.CloudTrail/TrailProperties](#awscloudtrailtrailproperties) (Required): properties of the resource +* **properties**: [AWS.CloudTrail/TrailProperties](#awscloudtrailtrailproperties) (Required, Identifier): properties of the resource + +## AdvancedEventSelector +### Properties +* **FieldSelectors**: [AdvancedFieldSelector](#advancedfieldselector)[] (Required): Contains all selector statements in an advanced event selector. +* **Name**: string: An optional, descriptive name for an advanced event selector, such as "Log data events for only two S3 buckets". + +## AdvancedEventSelector +### Properties +* **FieldSelectors**: [AdvancedFieldSelector](#advancedfieldselector)[] (Required): Contains all selector statements in an advanced event selector. +* **Name**: string: An optional, descriptive name for an advanced event selector, such as "Log data events for only two S3 buckets". + +## AdvancedFieldSelector +### Properties +* **EndsWith**: string[]: An operator that includes events that match the last few characters of the event record field specified as the value of Field. +* **Equals**: string[]: An operator that includes events that match the exact value of the event record field specified as the value of Field. This is the only valid operator that you can use with the readOnly, eventCategory, and resources.type fields. +* **Field**: string (Required): A field in an event record on which to filter events to be logged. Supported fields include readOnly, eventCategory, eventSource (for management events), eventName, resources.type, and resources.ARN. +* **NotEndsWith**: string[]: An operator that excludes events that match the last few characters of the event record field specified as the value of Field. +* **NotEquals**: string[]: An operator that excludes events that match the exact value of the event record field specified as the value of Field. +* **NotStartsWith**: string[]: An operator that excludes events that match the first few characters of the event record field specified as the value of Field. +* **StartsWith**: string[]: An operator that includes events that match the first few characters of the event record field specified as the value of Field. + +## AdvancedFieldSelector +### Properties +* **EndsWith**: string[]: An operator that includes events that match the last few characters of the event record field specified as the value of Field. +* **Equals**: string[]: An operator that includes events that match the exact value of the event record field specified as the value of Field. This is the only valid operator that you can use with the readOnly, eventCategory, and resources.type fields. +* **Field**: string (Required): A field in an event record on which to filter events to be logged. Supported fields include readOnly, eventCategory, eventSource (for management events), eventName, resources.type, and resources.ARN. +* **NotEndsWith**: string[]: An operator that excludes events that match the last few characters of the event record field specified as the value of Field. +* **NotEquals**: string[]: An operator that excludes events that match the exact value of the event record field specified as the value of Field. +* **NotStartsWith**: string[]: An operator that excludes events that match the first few characters of the event record field specified as the value of Field. +* **StartsWith**: string[]: An operator that includes events that match the first few characters of the event record field specified as the value of Field. ## AWS.CloudTrail/ChannelProperties ### Properties @@ -36,16 +66,6 @@ * **Source**: string: The ARN of an on-premises storage solution or application, or a partner event source. * **Tags**: [Tag](#tag)[] (WriteOnly): An array of key-value pairs to apply to this resource. -## Destination -### Properties -* **Location**: string (Required): The ARN of a resource that receives events from a channel. -* **Type**: string (Required): The type of destination for events arriving from a channel. - -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## AWS.CloudTrail/EventDataStoreProperties ### Properties * **AdvancedEventSelectors**: [AdvancedEventSelector](#advancedeventselector)[]: The advanced event selectors that were used to select events for the data store. @@ -67,30 +87,6 @@ * **TerminationProtectionEnabled**: bool: Indicates whether the event data store is protected from termination. * **UpdatedTimestamp**: string (ReadOnly): The timestamp showing when an event data store was updated, if applicable. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp. -## AdvancedEventSelector -### Properties -* **FieldSelectors**: [AdvancedFieldSelector](#advancedfieldselector)[] (Required): Contains all selector statements in an advanced event selector. -* **Name**: string: An optional, descriptive name for an advanced event selector, such as "Log data events for only two S3 buckets". - -## AdvancedFieldSelector -### Properties -* **EndsWith**: string[]: An operator that includes events that match the last few characters of the event record field specified as the value of Field. -* **Equals**: string[]: An operator that includes events that match the exact value of the event record field specified as the value of Field. This is the only valid operator that you can use with the readOnly, eventCategory, and resources.type fields. -* **Field**: string (Required): A field in an event record on which to filter events to be logged. Supported fields include readOnly, eventCategory, eventSource (for management events), eventName, resources.type, and resources.ARN. -* **NotEndsWith**: string[]: An operator that excludes events that match the last few characters of the event record field specified as the value of Field. -* **NotEquals**: string[]: An operator that excludes events that match the exact value of the event record field specified as the value of Field. -* **NotStartsWith**: string[]: An operator that excludes events that match the first few characters of the event record field specified as the value of Field. -* **StartsWith**: string[]: An operator that includes events that match the first few characters of the event record field specified as the value of Field. - -## InsightSelector -### Properties -* **InsightType**: string: The type of Insights to log on an event data store. - -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## AWS.CloudTrail/ResourcePolicyProperties ### Properties * **ResourceArn**: string (Required, Identifier): The ARN of the AWS CloudTrail resource to which the policy applies. @@ -117,20 +113,15 @@ * **Tags**: [Tag](#tag)[] * **TrailName**: string (Identifier) -## AdvancedEventSelector +## DataResource ### Properties -* **FieldSelectors**: [AdvancedFieldSelector](#advancedfieldselector)[] (Required): Contains all selector statements in an advanced event selector. -* **Name**: string: An optional, descriptive name for an advanced event selector, such as "Log data events for only two S3 buckets". +* **Type**: string (Required): The resource type in which you want to log data events. You can specify AWS::S3::Object or AWS::Lambda::Function resources. +* **Values**: string[]: An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified objects. -## AdvancedFieldSelector +## Destination ### Properties -* **EndsWith**: string[]: An operator that includes events that match the last few characters of the event record field specified as the value of Field. -* **Equals**: string[]: An operator that includes events that match the exact value of the event record field specified as the value of Field. This is the only valid operator that you can use with the readOnly, eventCategory, and resources.type fields. -* **Field**: string (Required): A field in an event record on which to filter events to be logged. Supported fields include readOnly, eventCategory, eventSource (for management events), eventName, resources.type, and resources.ARN. -* **NotEndsWith**: string[]: An operator that excludes events that match the last few characters of the event record field specified as the value of Field. -* **NotEquals**: string[]: An operator that excludes events that match the exact value of the event record field specified as the value of Field. -* **NotStartsWith**: string[]: An operator that excludes events that match the first few characters of the event record field specified as the value of Field. -* **StartsWith**: string[]: An operator that includes events that match the first few characters of the event record field specified as the value of Field. +* **Location**: string (Required): The ARN of a resource that receives events from a channel. +* **Type**: string (Required): The type of destination for events arriving from a channel. ## EventSelector ### Properties @@ -139,15 +130,24 @@ * **IncludeManagementEvents**: bool: Specify if you want your event selector to include management events for your trail. * **ReadWriteType**: string: Specify if you want your trail to log read-only events, write-only events, or all. For example, the EC2 GetConsoleOutput is a read-only API operation and RunInstances is a write-only API operation. -## DataResource +## InsightSelector ### Properties -* **Type**: string (Required): The resource type in which you want to log data events. You can specify AWS::S3::Object or AWS::Lambda::Function resources. -* **Values**: string[]: An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified objects. +* **InsightType**: string: The type of Insights to log on an event data store. ## InsightSelector ### Properties * **InsightType**: string: The type of insight to log on a trail. +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + ## Tag ### Properties * **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. diff --git a/artifacts/bicep/aws/aws.cloudwatch/default/types.json b/artifacts/bicep/aws/aws.cloudwatch/default/types.json index 8e4c75b1..b0a20921 100644 --- a/artifacts/bicep/aws/aws.cloudwatch/default/types.json +++ b/artifacts/bicep/aws/aws.cloudwatch/default/types.json @@ -1 +1,854 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"Dimension","Properties":{"Name":{"Type":4,"Flags":1,"Description":"The name of the dimension."},"Value":{"Type":4,"Flags":1,"Description":"The value for the dimension."}}}},{"2":{"Name":"Metric","Properties":{"Dimensions":{"Type":12,"Flags":0,"Description":"The dimensions for the metric."},"MetricName":{"Type":4,"Flags":0,"Description":"The name of the metric."},"Namespace":{"Type":4,"Flags":0,"Description":"The namespace of the metric."}}}},{"2":{"Name":"MetricDataQuery","Properties":{"AccountId":{"Type":4,"Flags":0,"Description":"The ID of the account where the metrics are located, if this is a cross-account alarm."},"Expression":{"Type":4,"Flags":0,"Description":"The math expression to be performed on the returned data."},"Id":{"Type":4,"Flags":1,"Description":"A short name used to tie this object to the results in the response."},"Label":{"Type":4,"Flags":0,"Description":"A human-readable label for this metric or expression."},"MetricStat":{"Type":11,"Flags":0,"Description":"The metric to be returned, along with statistics, period, and units."},"Period":{"Type":3,"Flags":0,"Description":"The period in seconds, over which the statistic is applied."},"ReturnData":{"Type":2,"Flags":0,"Description":"This option indicates whether to return the timestamps and raw data values of this metric."}}}},{"2":{"Name":"MetricStat","Properties":{"Metric":{"Type":9,"Flags":1,"Description":"The metric to return, including the metric name, namespace, and dimensions."},"Period":{"Type":3,"Flags":1,"Description":"The granularity, in seconds, of the returned data points."},"Stat":{"Type":4,"Flags":1,"Description":"The statistic to return."},"Unit":{"Type":4,"Flags":0,"Description":"The unit to use for the returned data points."}}}},{"3":{"ItemType":8}},{"2":{"Name":"AWS.CloudWatch/AlarmProperties","Properties":{"ActionsEnabled":{"Type":2,"Flags":0,"Description":"Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE."},"AlarmActions":{"Type":14,"Flags":0,"Description":"The list of actions to execute when this alarm transitions into an ALARM state from any other state."},"AlarmDescription":{"Type":4,"Flags":0,"Description":"The description of the alarm."},"AlarmName":{"Type":4,"Flags":16,"Description":"The name of the alarm."},"Arn":{"Type":4,"Flags":2,"Description":"Amazon Resource Name is a unique name for each resource."},"ComparisonOperator":{"Type":4,"Flags":1,"Description":"The arithmetic operation to use when comparing the specified statistic and threshold."},"DatapointsToAlarm":{"Type":3,"Flags":0,"Description":"The number of datapoints that must be breaching to trigger the alarm."},"Dimensions":{"Type":15,"Flags":0,"Description":"The dimensions for the metric associated with the alarm. For an alarm based on a math expression, you can't specify Dimensions. Instead, you use Metrics."},"EvaluateLowSampleCountPercentile":{"Type":4,"Flags":0,"Description":"Used only for alarms based on percentiles."},"EvaluationPeriods":{"Type":3,"Flags":1,"Description":"The number of periods over which data is compared to the specified threshold."},"ExtendedStatistic":{"Type":4,"Flags":0,"Description":"The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100."},"InsufficientDataActions":{"Type":16,"Flags":0,"Description":"The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state."},"MetricName":{"Type":4,"Flags":0,"Description":"The name of the metric associated with the alarm."},"Metrics":{"Type":17,"Flags":0,"Description":"An array that enables you to create an alarm based on the result of a metric math expression."},"Namespace":{"Type":4,"Flags":0,"Description":"The namespace of the metric associated with the alarm."},"OKActions":{"Type":18,"Flags":0,"Description":"The actions to execute when this alarm transitions to the OK state from any other state."},"Period":{"Type":3,"Flags":0,"Description":"The period in seconds, over which the statistic is applied."},"Statistic":{"Type":4,"Flags":0,"Description":"The statistic for the metric associated with the alarm, other than percentile."},"Threshold":{"Type":3,"Flags":0,"Description":"In an alarm based on an anomaly detection model, this is the ID of the ANOMALY_DETECTION_BAND function used as the threshold for the alarm."},"ThresholdMetricId":{"Type":4,"Flags":0,"Description":"In an alarm based on an anomaly detection model, this is the ID of the ANOMALY_DETECTION_BAND function used as the threshold for the alarm."},"TreatMissingData":{"Type":4,"Flags":0,"Description":"Sets how this alarm is to handle missing data points. Valid values are breaching, notBreaching, ignore, and missing."},"Unit":{"Type":4,"Flags":0,"Description":"The unit of the metric associated with the alarm."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":8}},{"3":{"ItemType":4}},{"3":{"ItemType":10}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.CloudWatch/Alarm","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":13,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.CloudWatch/Alarm@default","ScopeType":0,"Body":19}},{"2":{"Name":"AWS.CloudWatch/CompositeAlarmProperties","Properties":{"ActionsEnabled":{"Type":2,"Flags":0,"Description":"Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE."},"ActionsSuppressor":{"Type":4,"Flags":0,"Description":"Actions will be suppressed if the suppressor alarm is in the ALARM state. ActionsSuppressor can be an AlarmName or an Amazon Resource Name (ARN) from an existing alarm. "},"ActionsSuppressorExtensionPeriod":{"Type":3,"Flags":0,"Description":"Actions will be suppressed if WaitPeriod is active. The length of time that actions are suppressed is in seconds."},"ActionsSuppressorWaitPeriod":{"Type":3,"Flags":0,"Description":"Actions will be suppressed if ExtensionPeriod is active. The length of time that actions are suppressed is in seconds."},"AlarmActions":{"Type":22,"Flags":0,"Description":"The list of actions to execute when this alarm transitions into an ALARM state from any other state. Specify each action as an Amazon Resource Name (ARN)."},"AlarmDescription":{"Type":4,"Flags":0,"Description":"The description of the alarm"},"AlarmName":{"Type":4,"Flags":16,"Description":"The name of the Composite Alarm"},"AlarmRule":{"Type":4,"Flags":1,"Description":"Expression which aggregates the state of other Alarms (Metric or Composite Alarms)"},"Arn":{"Type":4,"Flags":2,"Description":"Amazon Resource Name (ARN) of the alarm"},"InsufficientDataActions":{"Type":23,"Flags":0,"Description":"The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN)."},"OKActions":{"Type":24,"Flags":0,"Description":"The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN)."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.CloudWatch/CompositeAlarm","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":21,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.CloudWatch/CompositeAlarm@default","ScopeType":0,"Body":25}},{"2":{"Name":"MetricStreamFilter","Properties":{"MetricNames":{"Type":31,"Flags":0,"Description":"Only metrics with MetricNames matching these values will be streamed. Must be set together with Namespace."},"Namespace":{"Type":4,"Flags":1,"Description":"Only metrics with Namespace matching this value will be streamed."}}}},{"2":{"Name":"MetricStreamStatisticsConfiguration","Properties":{"AdditionalStatistics":{"Type":32,"Flags":1,"Description":"The additional statistics to stream for the metrics listed in IncludeMetrics."},"IncludeMetrics":{"Type":33,"Flags":1,"Description":"An array that defines the metrics that are to have additional statistics streamed."}}}},{"2":{"Name":"MetricStreamStatisticsMetric","Properties":{"MetricName":{"Type":4,"Flags":1,"Description":"The name of the metric."},"Namespace":{"Type":4,"Flags":1,"Description":"The namespace of the metric."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"A unique identifier for the tag."},"Value":{"Type":4,"Flags":1,"Description":"String which you can use to describe or define the tag."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":29}},{"2":{"Name":"AWS.CloudWatch/MetricStreamProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"Amazon Resource Name of the metric stream."},"CreationDate":{"Type":4,"Flags":2,"Description":"The date of creation of the metric stream."},"ExcludeFilters":{"Type":35,"Flags":0,"Description":"Define which metrics will be not streamed. Metrics matched by multiple instances of MetricStreamFilter are joined with an OR operation by default. If both IncludeFilters and ExcludeFilters are omitted, all metrics in the account will be streamed. IncludeFilters and ExcludeFilters are mutually exclusive. Default to null."},"FirehoseArn":{"Type":4,"Flags":1,"Description":"The ARN of the Kinesis Firehose where to stream the data."},"IncludeFilters":{"Type":36,"Flags":0,"Description":"Define which metrics will be streamed. Metrics matched by multiple instances of MetricStreamFilter are joined with an OR operation by default. If both IncludeFilters and ExcludeFilters are omitted, all metrics in the account will be streamed. IncludeFilters and ExcludeFilters are mutually exclusive. Default to null."},"IncludeLinkedAccountsMetrics":{"Type":2,"Flags":0,"Description":"If you are creating a metric stream in a monitoring account, specify true to include metrics from source accounts that are linked to this monitoring account, in the metric stream. The default is false."},"LastUpdateDate":{"Type":4,"Flags":2,"Description":"The date of the last update of the metric stream."},"Name":{"Type":4,"Flags":16,"Description":"Name of the metric stream."},"OutputFormat":{"Type":4,"Flags":1,"Description":"The output format of the data streamed to the Kinesis Firehose."},"RoleArn":{"Type":4,"Flags":1,"Description":"The ARN of the role that provides access to the Kinesis Firehose."},"State":{"Type":4,"Flags":2,"Description":"Displays the state of the Metric Stream."},"StatisticsConfigurations":{"Type":37,"Flags":0,"Description":"By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed. You can use this parameter to have the metric stream also send additional statistics in the stream. This array can have up to 100 members."},"Tags":{"Type":38,"Flags":4,"Description":"A set of tags to assign to the delivery stream."}}}},{"3":{"ItemType":27}},{"3":{"ItemType":27}},{"3":{"ItemType":28}},{"3":{"ItemType":30}},{"2":{"Name":"AWS.CloudWatch/MetricStream","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":34,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.CloudWatch/MetricStream@default","ScopeType":0,"Body":39}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Dimension", + "properties": { + "Name": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The name of the dimension, from 1?255 characters in length. This dimension name must have been included when the metric was published." + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The value for the dimension, from 1?255 characters in length." + } + } + }, + { + "$type": "ObjectType", + "name": "Metric", + "properties": { + "Dimensions": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "The metric dimensions that you want to be used for the metric that the alarm will watch." + }, + "MetricName": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The name of the metric that you want the alarm to watch. This is a required field." + }, + "Namespace": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The namespace of the metric that the alarm will watch." + } + } + }, + { + "$type": "ObjectType", + "name": "MetricDataQuery", + "properties": { + "AccountId": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The ID of the account where the metrics are located, if this is a cross-account alarm." + }, + "Expression": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The math expression to be performed on the returned data, if this object is performing a math expression. This expression can use the ``Id`` of the other metrics to refer to those metrics, and can also use the ``Id`` of other expressions to use the result of those expressions. For more information about metric math expressions, see [Metric Math Syntax and Functions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) in the *User Guide*.\n Within each MetricDataQuery object, you must specify either ``Expression`` or ``MetricStat`` but not both." + }, + "Id": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "A short name used to tie this object to the results in the response. This name must be unique within a single call to ``GetMetricData``. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter." + }, + "Label": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "A human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know what the value represents. If the metric or expression is shown in a CW dashboard widget, the label is shown. If ``Label`` is omitted, CW generates a default." + }, + "MetricStat": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data.\n Within one MetricDataQuery object, you must specify either ``Expression`` or ``MetricStat`` but not both." + }, + "Period": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a ``PutMetricData`` operation that includes a ``StorageResolution of 1 second``." + }, + "ReturnData": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "This option indicates whether to return the timestamps and raw data values of this metric.\n When you create an alarm based on a metric math expression, specify ``True`` for this value for only the one math expression that the alarm is based on. You must specify ``False`` for ``ReturnData`` for all the other metrics and expressions used in the alarm.\n This field is required." + } + } + }, + { + "$type": "ObjectType", + "name": "MetricStat", + "properties": { + "Metric": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The metric to return, including the metric name, namespace, and dimensions." + }, + "Period": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a ``PutMetricData`` call that includes a ``StorageResolution`` of 1 second.\n If the ``StartTime`` parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:\n + Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).\n + Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).\n + Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour)." + }, + "Stat": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The statistic to return. It can include any CW statistic or extended statistic. For a list of valid values, see the table in [Statistics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic) in the *User Guide*." + }, + "Unit": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The unit to use for the returned data points. \n Valid values are: 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, or None." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "A unique identifier for the tag. The combination of tag keys and values can help you organize and categorize your resources." + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The value for the specified tag key." + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "BooleanType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.CloudWatch/AlarmProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ObjectType", + "name": "AWS.CloudWatch/AlarmProperties", + "properties": { + "ActionsEnabled": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE." + }, + "AlarmActions": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The list of actions to execute when this alarm transitions into an ALARM state from any other state. Specify each action as an Amazon Resource Name (ARN). For more information about creating alarms and the actions that you can specify, see [PutMetricAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutMetricAlarm.html) in the *API Reference*." + }, + "AlarmDescription": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The description of the alarm." + }, + "AlarmName": { + "type": { + "$ref": "#/5" + }, + "flags": 16, + "description": "The name of the alarm. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the alarm name. \n If 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." + }, + "Arn": { + "type": { + "$ref": "#/5" + }, + "flags": 2, + "description": "" + }, + "ComparisonOperator": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand." + }, + "DatapointsToAlarm": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "The number of datapoints that must be breaching to trigger the alarm. This is used only if you are setting an \"M out of N\" alarm. In that case, this value is the M, and the value that you set for ``EvaluationPeriods`` is the N value. For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *User Guide*.\n If you omit this parameter, CW uses the same value here that you set for ``EvaluationPeriods``, and the alarm goes to alarm state if that many consecutive periods are breaching." + }, + "Dimensions": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The dimensions for the metric associated with the alarm. For an alarm based on a math expression, you can't specify ``Dimensions``. Instead, you use ``Metrics``." + }, + "EvaluateLowSampleCountPercentile": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "Used only for alarms based on percentiles. If ``ignore``, the alarm state does not change during periods with too few data points to be statistically significant. If ``evaluate`` or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available." + }, + "EvaluationPeriods": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "The number of periods over which data is compared to the specified threshold. If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies that number. If you are setting an \"M out of N\" alarm, this value is the N, and ``DatapointsToAlarm`` is the M.\n For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *User Guide*." + }, + "ExtendedStatistic": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.\n For an alarm based on a metric, you must specify either ``Statistic`` or ``ExtendedStatistic`` but not both.\n For an alarm based on a math expression, you can't specify ``ExtendedStatistic``. Instead, you use ``Metrics``." + }, + "InsufficientDataActions": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "The actions to execute when this alarm transitions to the ``INSUFFICIENT_DATA`` state from any other state. Each action is specified as an Amazon Resource Name (ARN)." + }, + "MetricName": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The name of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you use ``Metrics`` instead and you can't specify ``MetricName``." + }, + "Metrics": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "An array that enables you to create an alarm based on the result of a metric math expression. Each item in the array either retrieves a metric or performs a math expression.\n If you specify the ``Metrics`` parameter, you cannot specify ``MetricName``, ``Dimensions``, ``Period``, ``Namespace``, ``Statistic``, ``ExtendedStatistic``, or ``Unit``." + }, + "Namespace": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The namespace of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you can't specify ``Namespace`` and you use ``Metrics`` instead.\n For a list of namespaces for metrics from AWS services, see [Services That Publish Metrics.](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html)" + }, + "OKActions": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The actions to execute when this alarm transitions to the ``OK`` state from any other state. Each action is specified as an Amazon Resource Name (ARN)." + }, + "Period": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "The period, in seconds, over which the statistic is applied. This is required for an alarm based on a metric. Valid values are 10, 30, 60, and any multiple of 60.\n For an alarm based on a math expression, you can't specify ``Period``, and instead you use the ``Metrics`` parameter.\n *Minimum:* 10" + }, + "Statistic": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ``ExtendedStatistic``.\n For an alarm based on a metric, you must specify either ``Statistic`` or ``ExtendedStatistic`` but not both.\n For an alarm based on a math expression, you can't specify ``Statistic``. Instead, you use ``Metrics``." + }, + "Tags": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "" + }, + "Threshold": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "The value to compare with the specified statistic." + }, + "ThresholdMetricId": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "In an alarm based on an anomaly detection model, this is the ID of the ``ANOMALY_DETECTION_BAND`` function used as the threshold for the alarm." + }, + "TreatMissingData": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "Sets how this alarm is to handle missing data points. Valid values are ``breaching``, ``notBreaching``, ``ignore``, and ``missing``. For more information, see [Configuring How Alarms Treat Missing Data](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data) in the *Amazon User Guide*.\n If you omit this parameter, the default behavior of ``missing`` is used." + }, + "Unit": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The unit of the metric associated with the alarm. Specify this only if you are creating an alarm based on a single metric. Do not specify this if you are specifying a ``Metrics`` array.\n You can specify the following values: 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, or None." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.CloudWatch/Alarm", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/16" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.CloudWatch/Alarm@default", + "scopeType": 0, + "body": { + "$ref": "#/17" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AlarmActionARN", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "A unique identifier for the tag. The combination of tag keys and values can help you organize and categorize your resources." + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The value for the specified tag key." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.CloudWatch/CompositeAlarmProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/20" + } + }, + { + "$type": "ObjectType", + "name": "AWS.CloudWatch/CompositeAlarmProperties", + "properties": { + "ActionsEnabled": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE." + }, + "ActionsSuppressor": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "Actions will be suppressed if the suppressor alarm is in the ALARM state. ActionsSuppressor can be an AlarmName or an Amazon Resource Name (ARN) from an existing alarm. " + }, + "ActionsSuppressorExtensionPeriod": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "Actions will be suppressed if WaitPeriod is active. The length of time that actions are suppressed is in seconds." + }, + "ActionsSuppressorWaitPeriod": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "Actions will be suppressed if ExtensionPeriod is active. The length of time that actions are suppressed is in seconds." + }, + "AlarmActions": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "The list of actions to execute when this alarm transitions into an ALARM state from any other state. Specify each action as an Amazon Resource Name (ARN)." + }, + "AlarmDescription": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The description of the alarm" + }, + "AlarmName": { + "type": { + "$ref": "#/5" + }, + "flags": 16, + "description": "The name of the Composite Alarm" + }, + "AlarmRule": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "Expression which aggregates the state of other Alarms (Metric or Composite Alarms)" + }, + "Arn": { + "type": { + "$ref": "#/5" + }, + "flags": 2, + "description": "Amazon Resource Name (ARN) of the alarm" + }, + "InsufficientDataActions": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN)." + }, + "OKActions": { + "type": { + "$ref": "#/24" + }, + "flags": 0, + "description": "The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN)." + }, + "Tags": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "A list of key-value pairs to associate with the composite alarm. You can associate as many as 50 tags with an alarm." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.CloudWatch/CompositeAlarm", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/26" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.CloudWatch/CompositeAlarm@default", + "scopeType": 0, + "body": { + "$ref": "#/27" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "MetricStreamFilter", + "properties": { + "MetricNames": { + "type": { + "$ref": "#/33" + }, + "flags": 0, + "description": "Only metrics with MetricNames matching these values will be streamed. Must be set together with Namespace." + }, + "Namespace": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "Only metrics with Namespace matching this value will be streamed." + } + } + }, + { + "$type": "ObjectType", + "name": "MetricStreamStatisticsConfiguration", + "properties": { + "AdditionalStatistics": { + "type": { + "$ref": "#/34" + }, + "flags": 1, + "description": "The additional statistics to stream for the metrics listed in IncludeMetrics." + }, + "IncludeMetrics": { + "type": { + "$ref": "#/35" + }, + "flags": 1, + "description": "An array that defines the metrics that are to have additional statistics streamed." + } + } + }, + { + "$type": "ObjectType", + "name": "MetricStreamStatisticsMetric", + "properties": { + "MetricName": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The name of the metric." + }, + "Namespace": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The namespace of the metric." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "A unique identifier for the tag." + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "String which you can use to describe or define the tag." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/31" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.CloudWatch/MetricStreamProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/29" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/29" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/30" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/32" + } + }, + { + "$type": "ObjectType", + "name": "AWS.CloudWatch/MetricStreamProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/5" + }, + "flags": 2, + "description": "Amazon Resource Name of the metric stream." + }, + "CreationDate": { + "type": { + "$ref": "#/5" + }, + "flags": 2, + "description": "The date of creation of the metric stream." + }, + "ExcludeFilters": { + "type": { + "$ref": "#/37" + }, + "flags": 0, + "description": "Define which metrics will be not streamed. Metrics matched by multiple instances of MetricStreamFilter are joined with an OR operation by default. If both IncludeFilters and ExcludeFilters are omitted, all metrics in the account will be streamed. IncludeFilters and ExcludeFilters are mutually exclusive. Default to null." + }, + "FirehoseArn": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The ARN of the Kinesis Firehose where to stream the data." + }, + "IncludeFilters": { + "type": { + "$ref": "#/38" + }, + "flags": 0, + "description": "Define which metrics will be streamed. Metrics matched by multiple instances of MetricStreamFilter are joined with an OR operation by default. If both IncludeFilters and ExcludeFilters are omitted, all metrics in the account will be streamed. IncludeFilters and ExcludeFilters are mutually exclusive. Default to null." + }, + "IncludeLinkedAccountsMetrics": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "If you are creating a metric stream in a monitoring account, specify true to include metrics from source accounts that are linked to this monitoring account, in the metric stream. The default is false." + }, + "LastUpdateDate": { + "type": { + "$ref": "#/5" + }, + "flags": 2, + "description": "The date of the last update of the metric stream." + }, + "Name": { + "type": { + "$ref": "#/5" + }, + "flags": 16, + "description": "Name of the metric stream." + }, + "OutputFormat": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The output format of the data streamed to the Kinesis Firehose." + }, + "RoleArn": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The ARN of the role that provides access to the Kinesis Firehose." + }, + "State": { + "type": { + "$ref": "#/5" + }, + "flags": 2, + "description": "Displays the state of the Metric Stream." + }, + "StatisticsConfigurations": { + "type": { + "$ref": "#/39" + }, + "flags": 0, + "description": "By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed. You can use this parameter to have the metric stream also send additional statistics in the stream. This array can have up to 100 members." + }, + "Tags": { + "type": { + "$ref": "#/40" + }, + "flags": 4, + "description": "A set of tags to assign to the delivery stream." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.CloudWatch/MetricStream", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/41" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.CloudWatch/MetricStream@default", + "scopeType": 0, + "body": { + "$ref": "#/42" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.cloudwatch/default/types.md b/artifacts/bicep/aws/aws.cloudwatch/default/types.md index a501c929..07f1edaf 100644 --- a/artifacts/bicep/aws/aws.cloudwatch/default/types.md +++ b/artifacts/bicep/aws/aws.cloudwatch/default/types.md @@ -3,76 +3,62 @@ ## Resource AWS.CloudWatch/Alarm@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.CloudWatch/AlarmProperties](#awscloudwatchalarmproperties) (Required): properties of the resource +* **properties**: [AWS.CloudWatch/AlarmProperties](#awscloudwatchalarmproperties) (Required, Identifier): properties of the resource ## Resource AWS.CloudWatch/CompositeAlarm@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.CloudWatch/CompositeAlarmProperties](#awscloudwatchcompositealarmproperties) (Required): properties of the resource +* **properties**: [AWS.CloudWatch/CompositeAlarmProperties](#awscloudwatchcompositealarmproperties) (Required, Identifier): properties of the resource ## Resource AWS.CloudWatch/MetricStream@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.CloudWatch/MetricStreamProperties](#awscloudwatchmetricstreamproperties) (Required): properties of the resource +* **properties**: [AWS.CloudWatch/MetricStreamProperties](#awscloudwatchmetricstreamproperties) (Identifier): properties of the resource ## AWS.CloudWatch/AlarmProperties ### Properties * **ActionsEnabled**: bool: Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE. -* **AlarmActions**: string[]: The list of actions to execute when this alarm transitions into an ALARM state from any other state. +* **AlarmActions**: string[]: The list of actions to execute when this alarm transitions into an ALARM state from any other state. Specify each action as an Amazon Resource Name (ARN). For more information about creating alarms and the actions that you can specify, see [PutMetricAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutMetricAlarm.html) in the *API Reference*. * **AlarmDescription**: string: The description of the alarm. -* **AlarmName**: string (Identifier): The name of the alarm. -* **Arn**: string (ReadOnly): Amazon Resource Name is a unique name for each resource. -* **ComparisonOperator**: string (Required): The arithmetic operation to use when comparing the specified statistic and threshold. -* **DatapointsToAlarm**: int: The number of datapoints that must be breaching to trigger the alarm. -* **Dimensions**: [Dimension](#dimension)[]: The dimensions for the metric associated with the alarm. For an alarm based on a math expression, you can't specify Dimensions. Instead, you use Metrics. -* **EvaluateLowSampleCountPercentile**: string: Used only for alarms based on percentiles. -* **EvaluationPeriods**: int (Required): The number of periods over which data is compared to the specified threshold. +* **AlarmName**: string (Identifier): The name of the alarm. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the alarm name. + If 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. +* **Arn**: string (ReadOnly) +* **ComparisonOperator**: string (Required): The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand. +* **DatapointsToAlarm**: int: The number of datapoints that must be breaching to trigger the alarm. This is used only if you are setting an "M out of N" alarm. In that case, this value is the M, and the value that you set for ``EvaluationPeriods`` is the N value. For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *User Guide*. + If you omit this parameter, CW uses the same value here that you set for ``EvaluationPeriods``, and the alarm goes to alarm state if that many consecutive periods are breaching. +* **Dimensions**: [Dimension](#dimension)[]: The dimensions for the metric associated with the alarm. For an alarm based on a math expression, you can't specify ``Dimensions``. Instead, you use ``Metrics``. +* **EvaluateLowSampleCountPercentile**: string: Used only for alarms based on percentiles. If ``ignore``, the alarm state does not change during periods with too few data points to be statistically significant. If ``evaluate`` or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available. +* **EvaluationPeriods**: int (Required): The number of periods over which data is compared to the specified threshold. If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies that number. If you are setting an "M out of N" alarm, this value is the N, and ``DatapointsToAlarm`` is the M. + For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *User Guide*. * **ExtendedStatistic**: string: The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100. -* **InsufficientDataActions**: string[]: The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. -* **MetricName**: string: The name of the metric associated with the alarm. -* **Metrics**: [MetricDataQuery](#metricdataquery)[]: An array that enables you to create an alarm based on the result of a metric math expression. -* **Namespace**: string: The namespace of the metric associated with the alarm. -* **OKActions**: string[]: The actions to execute when this alarm transitions to the OK state from any other state. -* **Period**: int: The period in seconds, over which the statistic is applied. -* **Statistic**: string: The statistic for the metric associated with the alarm, other than percentile. -* **Threshold**: int: In an alarm based on an anomaly detection model, this is the ID of the ANOMALY_DETECTION_BAND function used as the threshold for the alarm. -* **ThresholdMetricId**: string: In an alarm based on an anomaly detection model, this is the ID of the ANOMALY_DETECTION_BAND function used as the threshold for the alarm. -* **TreatMissingData**: string: Sets how this alarm is to handle missing data points. Valid values are breaching, notBreaching, ignore, and missing. -* **Unit**: string: The unit of the metric associated with the alarm. - -## Dimension -### Properties -* **Name**: string (Required): The name of the dimension. -* **Value**: string (Required): The value for the dimension. - -## MetricDataQuery -### Properties -* **AccountId**: string: The ID of the account where the metrics are located, if this is a cross-account alarm. -* **Expression**: string: The math expression to be performed on the returned data. -* **Id**: string (Required): A short name used to tie this object to the results in the response. -* **Label**: string: A human-readable label for this metric or expression. -* **MetricStat**: [MetricStat](#metricstat): The metric to be returned, along with statistics, period, and units. -* **Period**: int: The period in seconds, over which the statistic is applied. -* **ReturnData**: bool: This option indicates whether to return the timestamps and raw data values of this metric. - -## MetricStat -### Properties -* **Metric**: [Metric](#metric) (Required): The metric to return, including the metric name, namespace, and dimensions. -* **Period**: int (Required): The granularity, in seconds, of the returned data points. -* **Stat**: string (Required): The statistic to return. -* **Unit**: string: The unit to use for the returned data points. - -## Metric -### Properties -* **Dimensions**: [Dimension](#dimension)[]: The dimensions for the metric. -* **MetricName**: string: The name of the metric. -* **Namespace**: string: The namespace of the metric. + For an alarm based on a metric, you must specify either ``Statistic`` or ``ExtendedStatistic`` but not both. + For an alarm based on a math expression, you can't specify ``ExtendedStatistic``. Instead, you use ``Metrics``. +* **InsufficientDataActions**: string[]: The actions to execute when this alarm transitions to the ``INSUFFICIENT_DATA`` state from any other state. Each action is specified as an Amazon Resource Name (ARN). +* **MetricName**: string: The name of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you use ``Metrics`` instead and you can't specify ``MetricName``. +* **Metrics**: [MetricDataQuery](#metricdataquery)[]: An array that enables you to create an alarm based on the result of a metric math expression. Each item in the array either retrieves a metric or performs a math expression. + If you specify the ``Metrics`` parameter, you cannot specify ``MetricName``, ``Dimensions``, ``Period``, ``Namespace``, ``Statistic``, ``ExtendedStatistic``, or ``Unit``. +* **Namespace**: string: The namespace of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you can't specify ``Namespace`` and you use ``Metrics`` instead. + For a list of namespaces for metrics from AWS services, see [Services That Publish Metrics.](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html) +* **OKActions**: string[]: The actions to execute when this alarm transitions to the ``OK`` state from any other state. Each action is specified as an Amazon Resource Name (ARN). +* **Period**: int: The period, in seconds, over which the statistic is applied. This is required for an alarm based on a metric. Valid values are 10, 30, 60, and any multiple of 60. + For an alarm based on a math expression, you can't specify ``Period``, and instead you use the ``Metrics`` parameter. + *Minimum:* 10 +* **Statistic**: string: The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ``ExtendedStatistic``. + For an alarm based on a metric, you must specify either ``Statistic`` or ``ExtendedStatistic`` but not both. + For an alarm based on a math expression, you can't specify ``Statistic``. Instead, you use ``Metrics``. +* **Tags**: [Tag](#tag)[] +* **Threshold**: int: The value to compare with the specified statistic. +* **ThresholdMetricId**: string: In an alarm based on an anomaly detection model, this is the ID of the ``ANOMALY_DETECTION_BAND`` function used as the threshold for the alarm. +* **TreatMissingData**: string: Sets how this alarm is to handle missing data points. Valid values are ``breaching``, ``notBreaching``, ``ignore``, and ``missing``. For more information, see [Configuring How Alarms Treat Missing Data](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data) in the *Amazon User Guide*. + If you omit this parameter, the default behavior of ``missing`` is used. +* **Unit**: string: The unit of the metric associated with the alarm. Specify this only if you are creating an alarm based on a single metric. Do not specify this if you are specifying a ``Metrics`` array. + You can specify the following values: 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, or None. ## AWS.CloudWatch/CompositeAlarmProperties ### Properties @@ -87,23 +73,61 @@ * **Arn**: string (ReadOnly): Amazon Resource Name (ARN) of the alarm * **InsufficientDataActions**: string[]: The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN). * **OKActions**: string[]: The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN). +* **Tags**: [Tag](#tag)[]: A list of key-value pairs to associate with the composite alarm. You can associate as many as 50 tags with an alarm. ## AWS.CloudWatch/MetricStreamProperties ### Properties * **Arn**: string (ReadOnly): Amazon Resource Name of the metric stream. * **CreationDate**: string (ReadOnly): The date of creation of the metric stream. * **ExcludeFilters**: [MetricStreamFilter](#metricstreamfilter)[]: Define which metrics will be not streamed. Metrics matched by multiple instances of MetricStreamFilter are joined with an OR operation by default. If both IncludeFilters and ExcludeFilters are omitted, all metrics in the account will be streamed. IncludeFilters and ExcludeFilters are mutually exclusive. Default to null. -* **FirehoseArn**: string (Required): The ARN of the Kinesis Firehose where to stream the data. +* **FirehoseArn**: string: The ARN of the Kinesis Firehose where to stream the data. * **IncludeFilters**: [MetricStreamFilter](#metricstreamfilter)[]: Define which metrics will be streamed. Metrics matched by multiple instances of MetricStreamFilter are joined with an OR operation by default. If both IncludeFilters and ExcludeFilters are omitted, all metrics in the account will be streamed. IncludeFilters and ExcludeFilters are mutually exclusive. Default to null. * **IncludeLinkedAccountsMetrics**: bool: If you are creating a metric stream in a monitoring account, specify true to include metrics from source accounts that are linked to this monitoring account, in the metric stream. The default is false. * **LastUpdateDate**: string (ReadOnly): The date of the last update of the metric stream. * **Name**: string (Identifier): Name of the metric stream. -* **OutputFormat**: string (Required): The output format of the data streamed to the Kinesis Firehose. -* **RoleArn**: string (Required): The ARN of the role that provides access to the Kinesis Firehose. +* **OutputFormat**: string: The output format of the data streamed to the Kinesis Firehose. +* **RoleArn**: string: The ARN of the role that provides access to the Kinesis Firehose. * **State**: string (ReadOnly): Displays the state of the Metric Stream. * **StatisticsConfigurations**: [MetricStreamStatisticsConfiguration](#metricstreamstatisticsconfiguration)[]: By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed. You can use this parameter to have the metric stream also send additional statistics in the stream. This array can have up to 100 members. * **Tags**: [Tag](#tag)[] (WriteOnly): A set of tags to assign to the delivery stream. +## Dimension +### Properties +* **Name**: string (Required): The name of the dimension, from 1?255 characters in length. This dimension name must have been included when the metric was published. +* **Value**: string (Required): The value for the dimension, from 1?255 characters in length. + +## Metric +### Properties +* **Dimensions**: [Dimension](#dimension)[]: The metric dimensions that you want to be used for the metric that the alarm will watch. +* **MetricName**: string: The name of the metric that you want the alarm to watch. This is a required field. +* **Namespace**: string: The namespace of the metric that the alarm will watch. + +## MetricDataQuery +### Properties +* **AccountId**: string: The ID of the account where the metrics are located, if this is a cross-account alarm. +* **Expression**: string: The math expression to be performed on the returned data, if this object is performing a math expression. This expression can use the ``Id`` of the other metrics to refer to those metrics, and can also use the ``Id`` of other expressions to use the result of those expressions. For more information about metric math expressions, see [Metric Math Syntax and Functions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) in the *User Guide*. + Within each MetricDataQuery object, you must specify either ``Expression`` or ``MetricStat`` but not both. +* **Id**: string (Required): A short name used to tie this object to the results in the response. This name must be unique within a single call to ``GetMetricData``. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter. +* **Label**: string: A human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know what the value represents. If the metric or expression is shown in a CW dashboard widget, the label is shown. If ``Label`` is omitted, CW generates a default. +* **MetricStat**: [MetricStat](#metricstat): The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data. + Within one MetricDataQuery object, you must specify either ``Expression`` or ``MetricStat`` but not both. +* **Period**: int: The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a ``PutMetricData`` operation that includes a ``StorageResolution of 1 second``. +* **ReturnData**: bool: This option indicates whether to return the timestamps and raw data values of this metric. + When you create an alarm based on a metric math expression, specify ``True`` for this value for only the one math expression that the alarm is based on. You must specify ``False`` for ``ReturnData`` for all the other metrics and expressions used in the alarm. + This field is required. + +## MetricStat +### Properties +* **Metric**: [Metric](#metric) (Required): The metric to return, including the metric name, namespace, and dimensions. +* **Period**: int (Required): The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a ``PutMetricData`` call that includes a ``StorageResolution`` of 1 second. + If the ``StartTime`` parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned: + + Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute). + + Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes). + + Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour). +* **Stat**: string (Required): The statistic to return. It can include any CW statistic or extended statistic. For a list of valid values, see the table in [Statistics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic) in the *User Guide*. +* **Unit**: string: The unit to use for the returned data points. + Valid values are: 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, or None. + ## MetricStreamFilter ### Properties * **MetricNames**: string[]: Only metrics with MetricNames matching these values will be streamed. Must be set together with Namespace. @@ -119,6 +143,16 @@ * **MetricName**: string (Required): The name of the metric. * **Namespace**: string (Required): The namespace of the metric. +## Tag +### Properties +* **Key**: string (Required): A unique identifier for the tag. The combination of tag keys and values can help you organize and categorize your resources. +* **Value**: string (Required): The value for the specified tag key. + +## Tag +### Properties +* **Key**: string (Required): A unique identifier for the tag. The combination of tag keys and values can help you organize and categorize your resources. +* **Value**: string (Required): The value for the specified tag key. + ## Tag ### Properties * **Key**: string (Required): A unique identifier for the tag. diff --git a/artifacts/bicep/aws/aws.codeartifact/default/types.json b/artifacts/bicep/aws/aws.codeartifact/default/types.json index 62f5ec02..023439f1 100644 --- a/artifacts/bicep/aws/aws.codeartifact/default/types.json +++ b/artifacts/bicep/aws/aws.codeartifact/default/types.json @@ -1 +1,765 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}}}},{"2":{"Name":"AWS.CodeArtifact/DomainProperties","Properties":{"Arn":{"Type":4,"Flags":18,"Description":"The ARN of the domain."},"DomainName":{"Type":4,"Flags":1,"Description":"The name of the domain."},"EncryptionKey":{"Type":4,"Flags":2,"Description":"The ARN of an AWS Key Management Service (AWS KMS) key associated with a domain."},"Name":{"Type":4,"Flags":2,"Description":"The name of the domain. This field is used for GetAtt"},"Owner":{"Type":4,"Flags":2,"Description":"The 12-digit account ID of the AWS account that owns the domain. This field is used for GetAtt"},"PermissionsPolicyDocument":{"Type":10,"Flags":0,"Description":"The access control resource policy on the provided domain."},"Tags":{"Type":11,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."}}}},{"2":{"Name":"Domain_PermissionsPolicyDocument","Properties":{}}},{"3":{"ItemType":8}},{"2":{"Name":"AWS.CodeArtifact/Domain","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":9,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.CodeArtifact/Domain@default","ScopeType":0,"Body":12}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}}}},{"2":{"Name":"AWS.CodeArtifact/RepositoryProperties","Properties":{"Arn":{"Type":4,"Flags":18,"Description":"The ARN of the repository."},"Description":{"Type":4,"Flags":0,"Description":"A text description of the repository."},"DomainName":{"Type":4,"Flags":1,"Description":"The name of the domain that contains the repository."},"DomainOwner":{"Type":4,"Flags":2,"Description":"The 12-digit account ID of the AWS account that owns the domain."},"ExternalConnections":{"Type":16,"Flags":0,"Description":"A list of external connections associated with the repository."},"Name":{"Type":4,"Flags":2,"Description":"The name of the repository. This is used for GetAtt"},"PermissionsPolicyDocument":{"Type":17,"Flags":0,"Description":"The access control resource policy on the provided repository."},"RepositoryName":{"Type":4,"Flags":1,"Description":"The name of the repository."},"Tags":{"Type":18,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."},"Upstreams":{"Type":19,"Flags":0,"Description":"A list of upstream repositories associated with the repository."}}}},{"3":{"ItemType":4}},{"2":{"Name":"Repository_PermissionsPolicyDocument","Properties":{}}},{"3":{"ItemType":14}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.CodeArtifact/Repository","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":15,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.CodeArtifact/Repository@default","ScopeType":0,"Body":20}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.CodeArtifact/DomainProperties" + }, + { + "$type": "ObjectType", + "name": "Domain_PermissionsPolicyDocument", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ObjectType", + "name": "AWS.CodeArtifact/DomainProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The ARN of the domain." + }, + "DomainName": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The name of the domain." + }, + "EncryptionKey": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The ARN of an AWS Key Management Service (AWS KMS) key associated with a domain." + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The name of the domain. This field is used for GetAtt" + }, + "Owner": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The 12-digit account ID of the AWS account that owns the domain. This field is used for GetAtt" + }, + "PermissionsPolicyDocument": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The access control resource policy on the provided domain." + }, + "Tags": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.CodeArtifact/Domain", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.CodeArtifact/Domain@default", + "scopeType": 0, + "body": { + "$ref": "#/6" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "OriginConfiguration", + "properties": { + "Restrictions": { + "type": { + "$ref": "#/18" + }, + "flags": 1, + "description": "The origin configuration that is applied to the package group." + } + } + }, + { + "$type": "ObjectType", + "name": "RestrictionType", + "properties": { + "Repositories": { + "type": { + "$ref": "#/19" + }, + "flags": 0 + }, + "RestrictionMode": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Restrictions", + "properties": { + "ExternalUpstream": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "The external upstream restriction determines if new package versions can be ingested or retained from external connections." + }, + "InternalUpstream": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "The internal upstream restriction determines if new package versions can be ingested or retained from upstream repositories." + }, + "Publish": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "The publish restriction determines if new package versions can be published." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "PackageGroup_RestrictionType", + "properties": { + "Repositories": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + }, + "RestrictionMode": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "PackageGroup_RestrictionType", + "properties": { + "Repositories": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + }, + "RestrictionMode": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "PackageGroup_RestrictionType", + "properties": { + "Repositories": { + "type": { + "$ref": "#/16" + }, + "flags": 0 + }, + "RestrictionMode": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "PackageGroup_Restrictions", + "properties": { + "ExternalUpstream": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "The external upstream restriction determines if new package versions can be ingested or retained from external connections." + }, + "InternalUpstream": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "The internal upstream restriction determines if new package versions can be ingested or retained from upstream repositories." + }, + "Publish": { + "type": { + "$ref": "#/17" + }, + "flags": 0, + "description": "The publish restriction determines if new package versions can be published." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "PackageGroup_RestrictionType", + "properties": { + "Repositories": { + "type": { + "$ref": "#/20" + }, + "flags": 0 + }, + "RestrictionMode": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "PackageGroup_RestrictionType", + "properties": { + "Repositories": { + "type": { + "$ref": "#/22" + }, + "flags": 0 + }, + "RestrictionMode": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "PackageGroup_RestrictionType", + "properties": { + "Repositories": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "RestrictionMode": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.CodeArtifact/PackageGroupProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "PackageGroup_RestrictionType", + "properties": { + "Repositories": { + "type": { + "$ref": "#/27" + }, + "flags": 0 + }, + "RestrictionMode": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "PackageGroup_RestrictionType", + "properties": { + "Repositories": { + "type": { + "$ref": "#/29" + }, + "flags": 0 + }, + "RestrictionMode": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "PackageGroup_RestrictionType", + "properties": { + "Repositories": { + "type": { + "$ref": "#/31" + }, + "flags": 0 + }, + "RestrictionMode": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "PackageGroup_Restrictions", + "properties": { + "ExternalUpstream": { + "type": { + "$ref": "#/28" + }, + "flags": 0, + "description": "The external upstream restriction determines if new package versions can be ingested or retained from external connections." + }, + "InternalUpstream": { + "type": { + "$ref": "#/30" + }, + "flags": 0, + "description": "The internal upstream restriction determines if new package versions can be ingested or retained from upstream repositories." + }, + "Publish": { + "type": { + "$ref": "#/32" + }, + "flags": 0, + "description": "The publish restriction determines if new package versions can be published." + } + } + }, + { + "$type": "ObjectType", + "name": "PackageGroup_OriginConfiguration", + "properties": { + "Restrictions": { + "type": { + "$ref": "#/33" + }, + "flags": 1, + "description": "The origin configuration that is applied to the package group." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/11" + } + }, + { + "$type": "ObjectType", + "name": "AWS.CodeArtifact/PackageGroupProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The ARN of the package group." + }, + "ContactInfo": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The contact info of the package group." + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The text description of the package group." + }, + "DomainName": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The name of the domain that contains the package group." + }, + "DomainOwner": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The 12-digit account ID of the AWS account that owns the domain." + }, + "OriginConfiguration": { + "type": { + "$ref": "#/34" + }, + "flags": 0, + "description": "The package origin configuration of the package group." + }, + "Pattern": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The package group pattern that is used to gather packages." + }, + "Tags": { + "type": { + "$ref": "#/35" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to the package group." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.CodeArtifact/PackageGroup", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/36" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.CodeArtifact/PackageGroup@default", + "scopeType": 0, + "body": { + "$ref": "#/37" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.CodeArtifact/RepositoryProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "Repository_PermissionsPolicyDocument", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/39" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "AWS.CodeArtifact/RepositoryProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The ARN of the repository." + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A text description of the repository." + }, + "DomainName": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The name of the domain that contains the repository." + }, + "DomainOwner": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The 12-digit account ID of the AWS account that owns the domain." + }, + "ExternalConnections": { + "type": { + "$ref": "#/41" + }, + "flags": 0, + "description": "A list of external connections associated with the repository." + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The name of the repository. This is used for GetAtt" + }, + "PermissionsPolicyDocument": { + "type": { + "$ref": "#/42" + }, + "flags": 0, + "description": "The access control resource policy on the provided repository." + }, + "RepositoryName": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The name of the repository." + }, + "Tags": { + "type": { + "$ref": "#/43" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + }, + "Upstreams": { + "type": { + "$ref": "#/44" + }, + "flags": 0, + "description": "A list of upstream repositories associated with the repository." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.CodeArtifact/Repository", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/45" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.CodeArtifact/Repository@default", + "scopeType": 0, + "body": { + "$ref": "#/46" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.codeartifact/default/types.md b/artifacts/bicep/aws/aws.codeartifact/default/types.md index 133a5398..801c44ce 100644 --- a/artifacts/bicep/aws/aws.codeartifact/default/types.md +++ b/artifacts/bicep/aws/aws.codeartifact/default/types.md @@ -3,16 +3,23 @@ ## Resource AWS.CodeArtifact/Domain@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.CodeArtifact/DomainProperties](#awscodeartifactdomainproperties) (Required): properties of the resource +* **properties**: [AWS.CodeArtifact/DomainProperties](#awscodeartifactdomainproperties) (Required, Identifier): properties of the resource + +## Resource AWS.CodeArtifact/PackageGroup@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.CodeArtifact/PackageGroupProperties](#awscodeartifactpackagegroupproperties) (Required, Identifier): properties of the resource ## Resource AWS.CodeArtifact/Repository@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.CodeArtifact/RepositoryProperties](#awscodeartifactrepositoryproperties) (Required): properties of the resource +* **properties**: [AWS.CodeArtifact/RepositoryProperties](#awscodeartifactrepositoryproperties) (Required, Identifier): properties of the resource ## AWS.CodeArtifact/DomainProperties ### Properties @@ -24,13 +31,16 @@ * **PermissionsPolicyDocument**: [Domain_PermissionsPolicyDocument](#domainpermissionspolicydocument): The access control resource policy on the provided domain. * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. -## Domain_PermissionsPolicyDocument -### Properties - -## Tag +## AWS.CodeArtifact/PackageGroupProperties ### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Arn**: string (ReadOnly, Identifier): The ARN of the package group. +* **ContactInfo**: string: The contact info of the package group. +* **Description**: string: The text description of the package group. +* **DomainName**: string (Required): The name of the domain that contains the package group. +* **DomainOwner**: string: The 12-digit account ID of the AWS account that owns the domain. +* **OriginConfiguration**: [PackageGroup_OriginConfiguration](#packagegrouporiginconfiguration): The package origin configuration of the package group. +* **Pattern**: string (Required): The package group pattern that is used to gather packages. +* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to the package group. ## AWS.CodeArtifact/RepositoryProperties ### Properties @@ -45,11 +55,49 @@ * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. * **Upstreams**: string[]: A list of upstream repositories associated with the repository. +## Domain_PermissionsPolicyDocument +### Properties + +## PackageGroup_OriginConfiguration +### Properties +* **Restrictions**: [PackageGroup_Restrictions](#packagegrouprestrictions) (Required): The origin configuration that is applied to the package group. + +## PackageGroup_Restrictions +### Properties +* **ExternalUpstream**: [PackageGroup_RestrictionType](#packagegrouprestrictiontype): The external upstream restriction determines if new package versions can be ingested or retained from external connections. +* **InternalUpstream**: [PackageGroup_RestrictionType](#packagegrouprestrictiontype): The internal upstream restriction determines if new package versions can be ingested or retained from upstream repositories. +* **Publish**: [PackageGroup_RestrictionType](#packagegrouprestrictiontype): The publish restriction determines if new package versions can be published. + +## PackageGroup_RestrictionType +### Properties +* **Repositories**: string[] +* **RestrictionMode**: string (Required) + +## PackageGroup_RestrictionType +### Properties +* **Repositories**: string[] +* **RestrictionMode**: string (Required) + +## PackageGroup_RestrictionType +### Properties +* **Repositories**: string[] +* **RestrictionMode**: string (Required) + ## Repository_PermissionsPolicyDocument ### Properties ## Tag ### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. diff --git a/artifacts/bicep/aws/aws.codebuild/default/types.json b/artifacts/bicep/aws/aws.codebuild/default/types.json new file mode 100644 index 00000000..4cc06fad --- /dev/null +++ b/artifacts/bicep/aws/aws.codebuild/default/types.json @@ -0,0 +1,170 @@ +[ + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 255 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + } + } + }, + { + "$type": "ObjectType", + "name": "VpcConfig", + "properties": { + "SecurityGroupIds": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "Subnets": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "VpcId": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.CodeBuild/FleetProperties" + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ObjectType", + "name": "AWS.CodeBuild/FleetProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/2" + }, + "flags": 18 + }, + "BaseCapacity": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "ComputeType": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "EnvironmentType": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "FleetServiceRole": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "FleetVpcConfig": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "OverflowBehavior": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.CodeBuild/Fleet", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/8" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.CodeBuild/Fleet@default", + "scopeType": 0, + "body": { + "$ref": "#/9" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.codebuild/default/types.md b/artifacts/bicep/aws/aws.codebuild/default/types.md new file mode 100644 index 00000000..5af1b792 --- /dev/null +++ b/artifacts/bicep/aws/aws.codebuild/default/types.md @@ -0,0 +1,32 @@ +# AWS.CodeBuild @ default + +## Resource AWS.CodeBuild/Fleet@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.CodeBuild/FleetProperties](#awscodebuildfleetproperties) (Identifier): properties of the resource + +## AWS.CodeBuild/FleetProperties +### Properties +* **Arn**: string (ReadOnly, Identifier) +* **BaseCapacity**: int +* **ComputeType**: string +* **EnvironmentType**: string +* **FleetServiceRole**: string +* **FleetVpcConfig**: [VpcConfig](#vpcconfig) +* **Name**: string +* **OverflowBehavior**: string +* **Tags**: [Tag](#tag)[] + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 255 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## VpcConfig +### Properties +* **SecurityGroupIds**: string[] +* **Subnets**: string[] +* **VpcId**: string + diff --git a/artifacts/bicep/aws/aws.codeconnections/default/types.json b/artifacts/bicep/aws/aws.codeconnections/default/types.json new file mode 100644 index 00000000..573139da --- /dev/null +++ b/artifacts/bicep/aws/aws.codeconnections/default/types.json @@ -0,0 +1,126 @@ +[ + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.CodeConnections/ConnectionProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ObjectType", + "name": "AWS.CodeConnections/ConnectionProperties", + "properties": { + "ConnectionArn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) of the connection. The ARN is used as the connection reference when the connection is shared between AWS services." + }, + "ConnectionName": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The name of the connection. Connection names must be unique in an AWS user account." + }, + "ConnectionStatus": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The current status of the connection." + }, + "HostArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The host arn configured to represent the infrastructure where your third-party provider is installed. You must specify either a ProviderType or a HostArn." + }, + "OwnerAccountId": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The name of the external provider where your third-party code repository is configured. For Bitbucket, this is the account ID of the owner of the Bitbucket repository." + }, + "ProviderType": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The name of the external provider where your third-party code repository is configured. You must specify either a ProviderType or a HostArn." + }, + "Tags": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "Specifies the tags applied to a connection." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.CodeConnections/Connection", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.CodeConnections/Connection@default", + "scopeType": 0, + "body": { + "$ref": "#/5" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.codeconnections/default/types.md b/artifacts/bicep/aws/aws.codeconnections/default/types.md new file mode 100644 index 00000000..5acdec44 --- /dev/null +++ b/artifacts/bicep/aws/aws.codeconnections/default/types.md @@ -0,0 +1,24 @@ +# AWS.CodeConnections @ default + +## Resource AWS.CodeConnections/Connection@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.CodeConnections/ConnectionProperties](#awscodeconnectionsconnectionproperties) (Required, Identifier): properties of the resource + +## AWS.CodeConnections/ConnectionProperties +### Properties +* **ConnectionArn**: string (ReadOnly, Identifier): The Amazon Resource Name (ARN) of the connection. The ARN is used as the connection reference when the connection is shared between AWS services. +* **ConnectionName**: string (Required): The name of the connection. Connection names must be unique in an AWS user account. +* **ConnectionStatus**: string (ReadOnly): The current status of the connection. +* **HostArn**: string: The host arn configured to represent the infrastructure where your third-party provider is installed. You must specify either a ProviderType or a HostArn. +* **OwnerAccountId**: string (ReadOnly): The name of the external provider where your third-party code repository is configured. For Bitbucket, this is the account ID of the owner of the Bitbucket repository. +* **ProviderType**: string: The name of the external provider where your third-party code repository is configured. You must specify either a ProviderType or a HostArn. +* **Tags**: [Tag](#tag)[]: Specifies the tags applied to a connection. + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + diff --git a/artifacts/bicep/aws/aws.codedeploy/default/types.json b/artifacts/bicep/aws/aws.codedeploy/default/types.json index feb4d9c8..5d88b418 100644 --- a/artifacts/bicep/aws/aws.codedeploy/default/types.json +++ b/artifacts/bicep/aws/aws.codedeploy/default/types.json @@ -1 +1,96 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.CodeDeploy/ApplicationProperties","Properties":{"ApplicationName":{"Type":4,"Flags":16,"Description":"A name for the application. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the application name."},"ComputePlatform":{"Type":4,"Flags":0,"Description":"The compute platform that CodeDeploy deploys the application to."},"Tags":{"Type":10,"Flags":0,"Description":"The metadata that you apply to CodeDeploy applications to help you organize and categorize them. Each tag consists of a key and an optional value, both of which you define. "}}}},{"3":{"ItemType":8}},{"2":{"Name":"AWS.CodeDeploy/Application","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":9,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.CodeDeploy/Application@default","ScopeType":0,"Body":11}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.CodeDeploy/ApplicationProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ObjectType", + "name": "AWS.CodeDeploy/ApplicationProperties", + "properties": { + "ApplicationName": { + "type": { + "$ref": "#/1" + }, + "flags": 16, + "description": "A name for the application. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the application name." + }, + "ComputePlatform": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The compute platform that CodeDeploy deploys the application to." + }, + "Tags": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The metadata that you apply to CodeDeploy applications to help you organize and categorize them. Each tag consists of a key and an optional value, both of which you define. " + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.CodeDeploy/Application", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/4" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.CodeDeploy/Application@default", + "scopeType": 0, + "body": { + "$ref": "#/5" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.codedeploy/default/types.md b/artifacts/bicep/aws/aws.codedeploy/default/types.md index 6021684b..c7fd6fe4 100644 --- a/artifacts/bicep/aws/aws.codedeploy/default/types.md +++ b/artifacts/bicep/aws/aws.codedeploy/default/types.md @@ -3,9 +3,9 @@ ## Resource AWS.CodeDeploy/Application@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.CodeDeploy/ApplicationProperties](#awscodedeployapplicationproperties): properties of the resource +* **properties**: [AWS.CodeDeploy/ApplicationProperties](#awscodedeployapplicationproperties) (Identifier): properties of the resource ## AWS.CodeDeploy/ApplicationProperties ### Properties diff --git a/artifacts/bicep/aws/aws.codeguruprofiler/default/types.json b/artifacts/bicep/aws/aws.codeguruprofiler/default/types.json index 84e795db..e5ad09fe 100644 --- a/artifacts/bicep/aws/aws.codeguruprofiler/default/types.json +++ b/artifacts/bicep/aws/aws.codeguruprofiler/default/types.json @@ -1 +1,182 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"Channel","Properties":{"channelId":{"Type":4,"Flags":0},"channelUri":{"Type":4,"Flags":1}}}},{"2":{"Name":"ChannelId"}},{"2":{"Name":"ChannelUri"}},{"2":{"Name":"IamArn"}},{"2":{"Name":"ProfilingGroupArn"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. The allowed characters across services are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. The allowed characters across services are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @."}}}},{"2":{"Name":"AWS.CodeGuruProfiler/ProfilingGroupProperties","Properties":{"AgentPermissions":{"Type":16,"Flags":0,"Description":"The agent permissions attached to this profiling group."},"AnomalyDetectionNotificationConfiguration":{"Type":17,"Flags":0,"Description":"Configuration for Notification Channels for Anomaly Detection feature in CodeGuru Profiler which enables customers to detect anomalies in the application profile for those methods that represent the highest proportion of CPU time or latency"},"Arn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) of the specified profiling group."},"ComputePlatform":{"Type":4,"Flags":0,"Description":"The compute platform of the profiling group."},"ProfilingGroupName":{"Type":4,"Flags":17,"Description":"The name of the profiling group."},"Tags":{"Type":18,"Flags":0,"Description":"The tags associated with a profiling group."}}}},{"3":{"ItemType":4}},{"2":{"Name":"ProfilingGroup_AgentPermissions","Properties":{"Principals":{"Type":15,"Flags":1,"Description":"The principals for the agent permissions."}}}},{"3":{"ItemType":8}},{"3":{"ItemType":13}},{"2":{"Name":"AWS.CodeGuruProfiler/ProfilingGroup","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":14,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.CodeGuruProfiler/ProfilingGroup@default","ScopeType":0,"Body":19}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Channel", + "properties": { + "channelId": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "channelUri": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ChannelId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ChannelUri", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "IamArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ProfilingGroupArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. The allowed characters across services are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @." + }, + "Value": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. The allowed characters across services are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @." + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.CodeGuruProfiler/ProfilingGroupProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ObjectType", + "name": "ProfilingGroup_AgentPermissions", + "properties": { + "Principals": { + "type": { + "$ref": "#/8" + }, + "flags": 1, + "description": "The principals for the agent permissions." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ObjectType", + "name": "AWS.CodeGuruProfiler/ProfilingGroupProperties", + "properties": { + "AgentPermissions": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "The agent permissions attached to this profiling group." + }, + "AnomalyDetectionNotificationConfiguration": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "Configuration for Notification Channels for Anomaly Detection feature in CodeGuru Profiler which enables customers to detect anomalies in the application profile for those methods that represent the highest proportion of CPU time or latency" + }, + "Arn": { + "type": { + "$ref": "#/6" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) of the specified profiling group." + }, + "ComputePlatform": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "The compute platform of the profiling group." + }, + "ProfilingGroupName": { + "type": { + "$ref": "#/6" + }, + "flags": 17, + "description": "The name of the profiling group." + }, + "Tags": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The tags associated with a profiling group." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.CodeGuruProfiler/ProfilingGroup", + "properties": { + "name": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/6" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/12" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.CodeGuruProfiler/ProfilingGroup@default", + "scopeType": 0, + "body": { + "$ref": "#/13" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.codeguruprofiler/default/types.md b/artifacts/bicep/aws/aws.codeguruprofiler/default/types.md index 35f8a71c..6770b710 100644 --- a/artifacts/bicep/aws/aws.codeguruprofiler/default/types.md +++ b/artifacts/bicep/aws/aws.codeguruprofiler/default/types.md @@ -3,9 +3,9 @@ ## Resource AWS.CodeGuruProfiler/ProfilingGroup@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.CodeGuruProfiler/ProfilingGroupProperties](#awscodeguruprofilerprofilinggroupproperties) (Required): properties of the resource +* **properties**: [AWS.CodeGuruProfiler/ProfilingGroupProperties](#awscodeguruprofilerprofilinggroupproperties) (Required, Identifier): properties of the resource ## AWS.CodeGuruProfiler/ProfilingGroupProperties ### Properties @@ -16,15 +16,15 @@ * **ProfilingGroupName**: string (Required, Identifier): The name of the profiling group. * **Tags**: [Tag](#tag)[]: The tags associated with a profiling group. -## ProfilingGroup_AgentPermissions -### Properties -* **Principals**: string[] (Required): The principals for the agent permissions. - ## Channel ### Properties * **channelId**: string * **channelUri**: string (Required) +## ProfilingGroup_AgentPermissions +### Properties +* **Principals**: string[] (Required): The principals for the agent permissions. + ## Tag ### Properties * **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. The allowed characters across services are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @. diff --git a/artifacts/bicep/aws/aws.codepipeline/default/types.json b/artifacts/bicep/aws/aws.codepipeline/default/types.json index 72146f19..e182d082 100644 --- a/artifacts/bicep/aws/aws.codepipeline/default/types.json +++ b/artifacts/bicep/aws/aws.codepipeline/default/types.json @@ -1 +1,258 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"ArtifactDetails","Properties":{"MaximumCount":{"Type":3,"Flags":1,"Description":"The maximum number of artifacts allowed for the action type."},"MinimumCount":{"Type":3,"Flags":1,"Description":"The minimum number of artifacts allowed for the action type."}}}},{"2":{"Name":"ConfigurationProperties","Properties":{"Description":{"Type":4,"Flags":0,"Description":"The description of the action configuration property that is displayed to users. "},"Key":{"Type":2,"Flags":1,"Description":"Whether the configuration property is a key."},"Name":{"Type":4,"Flags":1,"Description":"The name of the action configuration property."},"Queryable":{"Type":2,"Flags":0,"Description":"Indicates that the property is used with PollForJobs. When creating a custom action, an action can have up to one queryable property. If it has one, that property must be both required and not secret.If you create a pipeline with a custom action type, and that custom action contains a queryable property, the value for that configuration property is subject to other restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens. "},"Required":{"Type":2,"Flags":1,"Description":"Whether the configuration property is a required value."},"Secret":{"Type":2,"Flags":1,"Description":"Whether the configuration property is secret. Secrets are hidden from all calls except for GetJobDetails, GetThirdPartyJobDetails, PollForJobs, and PollForThirdPartyJobs."},"Type":{"Type":4,"Flags":0,"Description":"The type of the configuration property."}}}},{"2":{"Name":"Settings","Properties":{"EntityUrlTemplate":{"Type":4,"Flags":0,"Description":"The URL returned to the AWS CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for an AWS CodeDeploy deployment group. This link is provided as part of the action display in the pipeline. "},"ExecutionUrlTemplate":{"Type":4,"Flags":0,"Description":"The URL returned to the AWS CodePipeline console that contains a link to the top-level landing page for the external system, such as the console page for AWS CodeDeploy. This link is shown on the pipeline view page in the AWS CodePipeline console and provides a link to the execution entity of the external action. "},"RevisionUrlTemplate":{"Type":4,"Flags":0,"Description":"The URL returned to the AWS CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action. "},"ThirdPartyConfigurationUrl":{"Type":4,"Flags":0,"Description":"The URL of a sign-up page where users can sign up for an external service and perform initial configuration of the action provided by that service."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.CodePipeline/CustomActionTypeProperties","Properties":{"Category":{"Type":4,"Flags":17,"Description":"The category of the custom action, such as a build action or a test action."},"ConfigurationProperties":{"Type":13,"Flags":4,"Description":"The configuration properties for the custom action."},"Id":{"Type":4,"Flags":2},"InputArtifactDetails":{"Type":8,"Flags":1,"Description":"The details of the input artifact for the action, such as its commit ID."},"OutputArtifactDetails":{"Type":8,"Flags":1,"Description":"The details of the output artifact of the action, such as its commit ID."},"Provider":{"Type":4,"Flags":17,"Description":"The provider of the service used in the custom action, such as AWS CodeDeploy."},"Settings":{"Type":10,"Flags":0,"Description":"URLs that provide users information about this custom action."},"Tags":{"Type":14,"Flags":0,"Description":"Any tags assigned to the custom action."},"Version":{"Type":4,"Flags":17,"Description":"The version identifier of the custom action."}}}},{"3":{"ItemType":9}},{"3":{"ItemType":11}},{"2":{"Name":"AWS.CodePipeline/CustomActionType","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":12,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.CodePipeline/CustomActionType@default","ScopeType":0,"Body":15}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "ArtifactDetails", + "properties": { + "MaximumCount": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The maximum number of artifacts allowed for the action type." + }, + "MinimumCount": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The minimum number of artifacts allowed for the action type." + } + } + }, + { + "$type": "ObjectType", + "name": "ConfigurationProperties", + "properties": { + "Description": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The description of the action configuration property that is displayed to users. " + }, + "Key": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "Whether the configuration property is a key." + }, + "Name": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The name of the action configuration property." + }, + "Queryable": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Indicates that the property is used with PollForJobs. When creating a custom action, an action can have up to one queryable property. If it has one, that property must be both required and not secret.If you create a pipeline with a custom action type, and that custom action contains a queryable property, the value for that configuration property is subject to other restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens. " + }, + "Required": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "Whether the configuration property is a required value." + }, + "Secret": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "Whether the configuration property is secret. Secrets are hidden from all calls except for GetJobDetails, GetThirdPartyJobDetails, PollForJobs, and PollForThirdPartyJobs." + }, + "Type": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The type of the configuration property." + } + } + }, + { + "$type": "ObjectType", + "name": "Settings", + "properties": { + "EntityUrlTemplate": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The URL returned to the AWS CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for an AWS CodeDeploy deployment group. This link is provided as part of the action display in the pipeline. " + }, + "ExecutionUrlTemplate": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The URL returned to the AWS CodePipeline console that contains a link to the top-level landing page for the external system, such as the console page for AWS CodeDeploy. This link is shown on the pipeline view page in the AWS CodePipeline console and provides a link to the execution entity of the external action. " + }, + "RevisionUrlTemplate": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The URL returned to the AWS CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action. " + }, + "ThirdPartyConfigurationUrl": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The URL of a sign-up page where users can sign up for an external service and perform initial configuration of the action provided by that service." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "StringType" + }, + { + "$type": "BooleanType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.CodePipeline/CustomActionTypeProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ObjectType", + "name": "AWS.CodePipeline/CustomActionTypeProperties", + "properties": { + "Category": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "The category of the custom action, such as a build action or a test action." + }, + "ConfigurationProperties": { + "type": { + "$ref": "#/8" + }, + "flags": 4, + "description": "The configuration properties for the custom action." + }, + "Id": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "InputArtifactDetails": { + "type": { + "$ref": "#/0" + }, + "flags": 1, + "description": "The details of the input artifact for the action, such as its commit ID." + }, + "OutputArtifactDetails": { + "type": { + "$ref": "#/0" + }, + "flags": 1, + "description": "The details of the output artifact of the action, such as its commit ID." + }, + "Provider": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "The provider of the service used in the custom action, such as AWS CodeDeploy." + }, + "Settings": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "URLs that provide users information about this custom action." + }, + "Tags": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "Any tags assigned to the custom action." + }, + "Version": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "The version identifier of the custom action." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.CodePipeline/CustomActionType", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/10" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.CodePipeline/CustomActionType@default", + "scopeType": 0, + "body": { + "$ref": "#/11" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.codepipeline/default/types.md b/artifacts/bicep/aws/aws.codepipeline/default/types.md index c3ff30ff..610651f4 100644 --- a/artifacts/bicep/aws/aws.codepipeline/default/types.md +++ b/artifacts/bicep/aws/aws.codepipeline/default/types.md @@ -3,9 +3,14 @@ ## Resource AWS.CodePipeline/CustomActionType@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.CodePipeline/CustomActionTypeProperties](#awscodepipelinecustomactiontypeproperties) (Required): properties of the resource +* **properties**: [AWS.CodePipeline/CustomActionTypeProperties](#awscodepipelinecustomactiontypeproperties) (Required, Identifier): properties of the resource + +## ArtifactDetails +### Properties +* **MaximumCount**: int (Required): The maximum number of artifacts allowed for the action type. +* **MinimumCount**: int (Required): The minimum number of artifacts allowed for the action type. ## AWS.CodePipeline/CustomActionTypeProperties ### Properties @@ -29,11 +34,6 @@ * **Secret**: bool (Required): Whether the configuration property is secret. Secrets are hidden from all calls except for GetJobDetails, GetThirdPartyJobDetails, PollForJobs, and PollForThirdPartyJobs. * **Type**: string: The type of the configuration property. -## ArtifactDetails -### Properties -* **MaximumCount**: int (Required): The maximum number of artifacts allowed for the action type. -* **MinimumCount**: int (Required): The minimum number of artifacts allowed for the action type. - ## Settings ### Properties * **EntityUrlTemplate**: string: The URL returned to the AWS CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for an AWS CodeDeploy deployment group. This link is provided as part of the action display in the pipeline. diff --git a/artifacts/bicep/aws/aws.codestarconnections/default/types.json b/artifacts/bicep/aws/aws.codestarconnections/default/types.json index 0065d61b..762e654c 100644 --- a/artifacts/bicep/aws/aws.codestarconnections/default/types.json +++ b/artifacts/bicep/aws/aws.codestarconnections/default/types.json @@ -1 +1,377 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}}}},{"2":{"Name":"AWS.CodeStarConnections/ConnectionProperties","Properties":{"ConnectionArn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN) of the connection. The ARN is used as the connection reference when the connection is shared between AWS services."},"ConnectionName":{"Type":4,"Flags":1,"Description":"The name of the connection. Connection names must be unique in an AWS user account."},"ConnectionStatus":{"Type":4,"Flags":2,"Description":"The current status of the connection."},"HostArn":{"Type":4,"Flags":0,"Description":"The host arn configured to represent the infrastructure where your third-party provider is installed. You must specify either a ProviderType or a HostArn."},"OwnerAccountId":{"Type":4,"Flags":2,"Description":"The name of the external provider where your third-party code repository is configured. For Bitbucket, this is the account ID of the owner of the Bitbucket repository."},"ProviderType":{"Type":4,"Flags":0,"Description":"The name of the external provider where your third-party code repository is configured. You must specify either a ProviderType or a HostArn."},"Tags":{"Type":10,"Flags":0,"Description":"Specifies the tags applied to a connection."}}}},{"3":{"ItemType":8}},{"2":{"Name":"AWS.CodeStarConnections/Connection","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":9,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.CodeStarConnections/Connection@default","ScopeType":0,"Body":11}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, , ., /, =, +, and -. "},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, , ., /, =, +, and -. "}}}},{"2":{"Name":"AWS.CodeStarConnections/RepositoryLinkProperties","Properties":{"ConnectionArn":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) of the CodeStarConnection. The ARN is used as the connection reference when the connection is shared between AWS services."},"EncryptionKeyArn":{"Type":4,"Flags":0,"Description":"The ARN of the KMS key that the customer can optionally specify to use to encrypt RepositoryLink properties. If not specified, a default key will be used."},"OwnerId":{"Type":4,"Flags":1,"Description":"the ID of the entity that owns the repository."},"ProviderType":{"Type":4,"Flags":2,"Description":"The name of the external provider where your third-party code repository is configured."},"RepositoryLinkArn":{"Type":4,"Flags":18,"Description":"A unique Amazon Resource Name (ARN) to designate the repository link."},"RepositoryLinkId":{"Type":4,"Flags":2,"Description":"A UUID that uniquely identifies the RepositoryLink."},"RepositoryName":{"Type":4,"Flags":1,"Description":"The repository for which the link is being created."},"Tags":{"Type":15,"Flags":0,"Description":"Specifies the tags applied to a RepositoryLink."}}}},{"3":{"ItemType":13}},{"2":{"Name":"AWS.CodeStarConnections/RepositoryLink","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":14,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.CodeStarConnections/RepositoryLink@default","ScopeType":0,"Body":16}},{"2":{"Name":"AWS.CodeStarConnections/SyncConfigurationProperties","Properties":{"Branch":{"Type":4,"Flags":1,"Description":"The name of the branch of the repository from which resources are to be synchronized,"},"ConfigFile":{"Type":4,"Flags":1,"Description":"The source provider repository path of the sync configuration file of the respective SyncType."},"OwnerId":{"Type":4,"Flags":2,"Description":"the ID of the entity that owns the repository."},"ProviderType":{"Type":4,"Flags":2,"Description":"The name of the external provider where your third-party code repository is configured."},"RepositoryLinkId":{"Type":4,"Flags":1,"Description":"A UUID that uniquely identifies the RepositoryLink that the SyncConfig is associated with."},"RepositoryName":{"Type":4,"Flags":2,"Description":"The name of the repository that is being synced to."},"ResourceName":{"Type":4,"Flags":17,"Description":"The name of the resource that is being synchronized to the repository."},"RoleArn":{"Type":4,"Flags":1,"Description":"The IAM Role that allows AWS to update CloudFormation stacks based on content in the specified repository."},"SyncType":{"Type":4,"Flags":17,"Description":"The type of resource synchronization service that is to be configured, for example, CFN_STACK_SYNC."}}}},{"2":{"Name":"AWS.CodeStarConnections/SyncConfiguration","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":18,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.CodeStarConnections/SyncConfiguration@default","ScopeType":0,"Body":19}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.CodeStarConnections/ConnectionProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ObjectType", + "name": "AWS.CodeStarConnections/ConnectionProperties", + "properties": { + "ConnectionArn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) of the connection. The ARN is used as the connection reference when the connection is shared between AWS services." + }, + "ConnectionName": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The name of the connection. Connection names must be unique in an AWS user account." + }, + "ConnectionStatus": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The current status of the connection." + }, + "HostArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The host arn configured to represent the infrastructure where your third-party provider is installed. You must specify either a ProviderType or a HostArn." + }, + "OwnerAccountId": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The name of the external provider where your third-party code repository is configured. For Bitbucket, this is the account ID of the owner of the Bitbucket repository." + }, + "ProviderType": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The name of the external provider where your third-party code repository is configured. You must specify either a ProviderType or a HostArn." + }, + "Tags": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "Specifies the tags applied to a connection." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.CodeStarConnections/Connection", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.CodeStarConnections/Connection@default", + "scopeType": 0, + "body": { + "$ref": "#/5" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, , ., /, =, +, and -. " + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, , ., /, =, +, and -. " + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.CodeStarConnections/RepositoryLinkProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/7" + } + }, + { + "$type": "ObjectType", + "name": "AWS.CodeStarConnections/RepositoryLinkProperties", + "properties": { + "ConnectionArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of the CodeStarConnection. The ARN is used as the connection reference when the connection is shared between AWS services." + }, + "EncryptionKeyArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The ARN of the KMS key that the customer can optionally specify to use to encrypt RepositoryLink properties. If not specified, a default key will be used." + }, + "OwnerId": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "the ID of the entity that owns the repository." + }, + "ProviderType": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The name of the external provider where your third-party code repository is configured." + }, + "RepositoryLinkArn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "A unique Amazon Resource Name (ARN) to designate the repository link." + }, + "RepositoryLinkId": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "A UUID that uniquely identifies the RepositoryLink." + }, + "RepositoryName": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The repository for which the link is being created." + }, + "Tags": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "Specifies the tags applied to a RepositoryLink." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.CodeStarConnections/RepositoryLink", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/10" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.CodeStarConnections/RepositoryLink@default", + "scopeType": 0, + "body": { + "$ref": "#/11" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.CodeStarConnections/SyncConfigurationProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.CodeStarConnections/SyncConfigurationProperties", + "properties": { + "Branch": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The name of the branch of the repository from which resources are to be synchronized," + }, + "ConfigFile": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The source provider repository path of the sync configuration file of the respective SyncType." + }, + "OwnerId": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "the ID of the entity that owns the repository." + }, + "ProviderType": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The name of the external provider where your third-party code repository is configured." + }, + "PublishDeploymentStatus": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Whether to enable or disable publishing of deployment status to source providers." + }, + "RepositoryLinkId": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "A UUID that uniquely identifies the RepositoryLink that the SyncConfig is associated with." + }, + "RepositoryName": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The name of the repository that is being synced to." + }, + "ResourceName": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The name of the resource that is being synchronized to the repository." + }, + "RoleArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The IAM Role that allows AWS to update CloudFormation stacks based on content in the specified repository." + }, + "SyncType": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The type of resource synchronization service that is to be configured, for example, CFN_STACK_SYNC." + }, + "TriggerResourceUpdateOn": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "When to trigger Git sync to begin the stack update." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.CodeStarConnections/SyncConfiguration", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/14" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.CodeStarConnections/SyncConfiguration@default", + "scopeType": 0, + "body": { + "$ref": "#/15" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.codestarconnections/default/types.md b/artifacts/bicep/aws/aws.codestarconnections/default/types.md index 8c0b4462..03bf9ddf 100644 --- a/artifacts/bicep/aws/aws.codestarconnections/default/types.md +++ b/artifacts/bicep/aws/aws.codestarconnections/default/types.md @@ -3,23 +3,23 @@ ## Resource AWS.CodeStarConnections/Connection@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.CodeStarConnections/ConnectionProperties](#awscodestarconnectionsconnectionproperties) (Required): properties of the resource +* **properties**: [AWS.CodeStarConnections/ConnectionProperties](#awscodestarconnectionsconnectionproperties) (Required, Identifier): properties of the resource ## Resource AWS.CodeStarConnections/RepositoryLink@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.CodeStarConnections/RepositoryLinkProperties](#awscodestarconnectionsrepositorylinkproperties) (Required): properties of the resource +* **properties**: [AWS.CodeStarConnections/RepositoryLinkProperties](#awscodestarconnectionsrepositorylinkproperties) (Required, Identifier): properties of the resource ## Resource AWS.CodeStarConnections/SyncConfiguration@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.CodeStarConnections/SyncConfigurationProperties](#awscodestarconnectionssyncconfigurationproperties) (Required): properties of the resource +* **properties**: [AWS.CodeStarConnections/SyncConfigurationProperties](#awscodestarconnectionssyncconfigurationproperties) (Required, Identifier): properties of the resource ## AWS.CodeStarConnections/ConnectionProperties ### Properties @@ -31,11 +31,6 @@ * **ProviderType**: string: The name of the external provider where your third-party code repository is configured. You must specify either a ProviderType or a HostArn. * **Tags**: [Tag](#tag)[]: Specifies the tags applied to a connection. -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## AWS.CodeStarConnections/RepositoryLinkProperties ### Properties * **ConnectionArn**: string (Required): The Amazon Resource Name (ARN) of the CodeStarConnection. The ARN is used as the connection reference when the connection is shared between AWS services. @@ -47,20 +42,27 @@ * **RepositoryName**: string (Required): The repository for which the link is being created. * **Tags**: [Tag](#tag)[]: Specifies the tags applied to a RepositoryLink. -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, , ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, , ., /, =, +, and -. - ## AWS.CodeStarConnections/SyncConfigurationProperties ### Properties * **Branch**: string (Required): The name of the branch of the repository from which resources are to be synchronized, * **ConfigFile**: string (Required): The source provider repository path of the sync configuration file of the respective SyncType. * **OwnerId**: string (ReadOnly): the ID of the entity that owns the repository. * **ProviderType**: string (ReadOnly): The name of the external provider where your third-party code repository is configured. +* **PublishDeploymentStatus**: string: Whether to enable or disable publishing of deployment status to source providers. * **RepositoryLinkId**: string (Required): A UUID that uniquely identifies the RepositoryLink that the SyncConfig is associated with. * **RepositoryName**: string (ReadOnly): The name of the repository that is being synced to. * **ResourceName**: string (Required, Identifier): The name of the resource that is being synchronized to the repository. * **RoleArn**: string (Required): The IAM Role that allows AWS to update CloudFormation stacks based on content in the specified repository. * **SyncType**: string (Required, Identifier): The type of resource synchronization service that is to be configured, for example, CFN_STACK_SYNC. +* **TriggerResourceUpdateOn**: string: When to trigger Git sync to begin the stack update. + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, , ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, , ., /, =, +, and -. diff --git a/artifacts/bicep/aws/aws.codestarnotifications/default/types.json b/artifacts/bicep/aws/aws.codestarnotifications/default/types.json index f720e338..6713e104 100644 --- a/artifacts/bicep/aws/aws.codestarnotifications/default/types.json +++ b/artifacts/bicep/aws/aws.codestarnotifications/default/types.json @@ -1 +1,152 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"Target","Properties":{"TargetAddress":{"Type":4,"Flags":1},"TargetType":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.CodeStarNotifications/NotificationRuleProperties","Properties":{"Arn":{"Type":4,"Flags":18},"CreatedBy":{"Type":4,"Flags":0},"DetailType":{"Type":4,"Flags":1},"EventTypeId":{"Type":4,"Flags":4},"EventTypeIds":{"Type":10,"Flags":1},"Name":{"Type":4,"Flags":1},"Resource":{"Type":4,"Flags":1},"Status":{"Type":4,"Flags":0},"Tags":{"Type":11,"Flags":0},"TargetAddress":{"Type":4,"Flags":4},"Targets":{"Type":12,"Flags":1}}}},{"3":{"ItemType":4}},{"2":{"Name":"NotificationRule_Tags","Properties":{}}},{"3":{"ItemType":8}},{"2":{"Name":"AWS.CodeStarNotifications/NotificationRule","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":9,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.CodeStarNotifications/NotificationRule@default","ScopeType":0,"Body":13}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Target", + "properties": { + "TargetAddress": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "TargetType": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.CodeStarNotifications/NotificationRuleProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "NotificationRule_Tags", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ObjectType", + "name": "AWS.CodeStarNotifications/NotificationRuleProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 18 + }, + "CreatedBy": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "DetailType": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "EventTypeId": { + "type": { + "$ref": "#/1" + }, + "flags": 4 + }, + "EventTypeIds": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Resource": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Status": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "TargetAddress": { + "type": { + "$ref": "#/1" + }, + "flags": 4 + }, + "Targets": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.CodeStarNotifications/NotificationRule", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/6" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.CodeStarNotifications/NotificationRule@default", + "scopeType": 0, + "body": { + "$ref": "#/7" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.codestarnotifications/default/types.md b/artifacts/bicep/aws/aws.codestarnotifications/default/types.md index f3755469..b3d2dd06 100644 --- a/artifacts/bicep/aws/aws.codestarnotifications/default/types.md +++ b/artifacts/bicep/aws/aws.codestarnotifications/default/types.md @@ -3,9 +3,9 @@ ## Resource AWS.CodeStarNotifications/NotificationRule@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.CodeStarNotifications/NotificationRuleProperties](#awscodestarnotificationsnotificationruleproperties) (Required): properties of the resource +* **properties**: [AWS.CodeStarNotifications/NotificationRuleProperties](#awscodestarnotificationsnotificationruleproperties) (Required, Identifier): properties of the resource ## AWS.CodeStarNotifications/NotificationRuleProperties ### Properties diff --git a/artifacts/bicep/aws/aws.cognito/default/types.json b/artifacts/bicep/aws/aws.cognito/default/types.json index 6b4edba8..617e8b13 100644 --- a/artifacts/bicep/aws/aws.cognito/default/types.json +++ b/artifacts/bicep/aws/aws.cognito/default/types.json @@ -1 +1,2104 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"AWS.Cognito/IdentityPoolPrincipalTagProperties","Properties":{"IdentityPoolId":{"Type":4,"Flags":17},"IdentityProviderName":{"Type":4,"Flags":17},"PrincipalTags":{"Type":9,"Flags":0},"UseDefaults":{"Type":2,"Flags":0}}}},{"2":{"Name":"IdentityPoolPrincipalTag_PrincipalTags","Properties":{}}},{"2":{"Name":"AWS.Cognito/IdentityPoolPrincipalTag","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":8,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Cognito/IdentityPoolPrincipalTag@default","ScopeType":0,"Body":10}},{"2":{"Name":"CloudWatchLogsConfiguration","Properties":{"LogGroupArn":{"Type":4,"Flags":0}}}},{"2":{"Name":"LogConfiguration","Properties":{"CloudWatchLogsConfiguration":{"Type":12,"Flags":0},"EventSource":{"Type":4,"Flags":0},"LogLevel":{"Type":4,"Flags":0}}}},{"2":{"Name":"LogConfigurations"}},{"3":{"ItemType":13}},{"2":{"Name":"AWS.Cognito/LogDeliveryConfigurationProperties","Properties":{"Id":{"Type":4,"Flags":18},"LogConfigurations":{"Type":17,"Flags":0},"UserPoolId":{"Type":4,"Flags":1}}}},{"3":{"ItemType":13}},{"2":{"Name":"AWS.Cognito/LogDeliveryConfiguration","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":16,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Cognito/LogDeliveryConfiguration@default","ScopeType":0,"Body":18}},{"2":{"Name":"AccountRecoverySetting","Properties":{"RecoveryMechanisms":{"Type":40,"Flags":0}}}},{"2":{"Name":"AdminCreateUserConfig","Properties":{"AllowAdminCreateUserOnly":{"Type":2,"Flags":0},"InviteMessageTemplate":{"Type":26,"Flags":0},"UnusedAccountValidityDays":{"Type":3,"Flags":0}}}},{"2":{"Name":"CustomEmailSender","Properties":{"LambdaArn":{"Type":4,"Flags":0},"LambdaVersion":{"Type":4,"Flags":0}}}},{"2":{"Name":"CustomSMSSender","Properties":{"LambdaArn":{"Type":4,"Flags":0},"LambdaVersion":{"Type":4,"Flags":0}}}},{"2":{"Name":"DeviceConfiguration","Properties":{"ChallengeRequiredOnNewDevice":{"Type":2,"Flags":0},"DeviceOnlyRememberedOnUserPrompt":{"Type":2,"Flags":0}}}},{"2":{"Name":"EmailConfiguration","Properties":{"ConfigurationSet":{"Type":4,"Flags":0},"EmailSendingAccount":{"Type":4,"Flags":0},"From":{"Type":4,"Flags":0},"ReplyToEmailAddress":{"Type":4,"Flags":0},"SourceArn":{"Type":4,"Flags":0}}}},{"2":{"Name":"InviteMessageTemplate","Properties":{"EmailMessage":{"Type":4,"Flags":0},"EmailSubject":{"Type":4,"Flags":0},"SMSMessage":{"Type":4,"Flags":0}}}},{"2":{"Name":"LambdaConfig","Properties":{"CreateAuthChallenge":{"Type":4,"Flags":0},"CustomEmailSender":{"Type":22,"Flags":0},"CustomMessage":{"Type":4,"Flags":0},"CustomSMSSender":{"Type":23,"Flags":0},"DefineAuthChallenge":{"Type":4,"Flags":0},"KMSKeyID":{"Type":4,"Flags":0},"PostAuthentication":{"Type":4,"Flags":0},"PostConfirmation":{"Type":4,"Flags":0},"PreAuthentication":{"Type":4,"Flags":0},"PreSignUp":{"Type":4,"Flags":0},"PreTokenGeneration":{"Type":4,"Flags":0},"PreTokenGenerationConfig":{"Type":31,"Flags":0},"UserMigration":{"Type":4,"Flags":0},"VerifyAuthChallengeResponse":{"Type":4,"Flags":0}}}},{"2":{"Name":"NumberAttributeConstraints","Properties":{"MaxValue":{"Type":4,"Flags":0},"MinValue":{"Type":4,"Flags":0}}}},{"2":{"Name":"PasswordPolicy","Properties":{"MinimumLength":{"Type":3,"Flags":0},"RequireLowercase":{"Type":2,"Flags":0},"RequireNumbers":{"Type":2,"Flags":0},"RequireSymbols":{"Type":2,"Flags":0},"RequireUppercase":{"Type":2,"Flags":0},"TemporaryPasswordValidityDays":{"Type":3,"Flags":0}}}},{"2":{"Name":"Policies","Properties":{"PasswordPolicy":{"Type":29,"Flags":0}}}},{"2":{"Name":"PreTokenGenerationConfig","Properties":{"LambdaArn":{"Type":4,"Flags":0},"LambdaVersion":{"Type":4,"Flags":0}}}},{"2":{"Name":"RecoveryOption","Properties":{"Name":{"Type":4,"Flags":0},"Priority":{"Type":3,"Flags":0}}}},{"2":{"Name":"SchemaAttribute","Properties":{"AttributeDataType":{"Type":4,"Flags":0},"DeveloperOnlyAttribute":{"Type":2,"Flags":0},"Mutable":{"Type":2,"Flags":0},"Name":{"Type":4,"Flags":0},"NumberAttributeConstraints":{"Type":28,"Flags":0},"Required":{"Type":2,"Flags":0},"StringAttributeConstraints":{"Type":35,"Flags":0}}}},{"2":{"Name":"SmsConfiguration","Properties":{"ExternalId":{"Type":4,"Flags":0},"SnsCallerArn":{"Type":4,"Flags":0},"SnsRegion":{"Type":4,"Flags":0}}}},{"2":{"Name":"StringAttributeConstraints","Properties":{"MaxLength":{"Type":4,"Flags":0},"MinLength":{"Type":4,"Flags":0}}}},{"2":{"Name":"UserAttributeUpdateSettings","Properties":{"AttributesRequireVerificationBeforeUpdate":{"Type":41,"Flags":1}}}},{"2":{"Name":"UserPoolAddOns","Properties":{"AdvancedSecurityMode":{"Type":4,"Flags":0}}}},{"2":{"Name":"UsernameConfiguration","Properties":{"CaseSensitive":{"Type":2,"Flags":0}}}},{"2":{"Name":"VerificationMessageTemplate","Properties":{"DefaultEmailOption":{"Type":4,"Flags":0},"EmailMessage":{"Type":4,"Flags":0},"EmailMessageByLink":{"Type":4,"Flags":0},"EmailSubject":{"Type":4,"Flags":0},"EmailSubjectByLink":{"Type":4,"Flags":0},"SmsMessage":{"Type":4,"Flags":0}}}},{"3":{"ItemType":32}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.Cognito/UserPoolProperties","Properties":{"AccountRecoverySetting":{"Type":20,"Flags":0},"AdminCreateUserConfig":{"Type":21,"Flags":0},"AliasAttributes":{"Type":43,"Flags":0},"Arn":{"Type":4,"Flags":2},"AutoVerifiedAttributes":{"Type":44,"Flags":0},"DeletionProtection":{"Type":4,"Flags":0},"DeviceConfiguration":{"Type":24,"Flags":0},"EmailConfiguration":{"Type":25,"Flags":0},"EmailVerificationMessage":{"Type":4,"Flags":0},"EmailVerificationSubject":{"Type":4,"Flags":0},"EnabledMfas":{"Type":45,"Flags":4},"LambdaConfig":{"Type":27,"Flags":0},"MfaConfiguration":{"Type":4,"Flags":0},"Policies":{"Type":30,"Flags":0},"ProviderName":{"Type":4,"Flags":2},"ProviderURL":{"Type":4,"Flags":2},"Schema":{"Type":46,"Flags":0},"SmsAuthenticationMessage":{"Type":4,"Flags":0},"SmsConfiguration":{"Type":34,"Flags":0},"SmsVerificationMessage":{"Type":4,"Flags":0},"UserAttributeUpdateSettings":{"Type":36,"Flags":0},"UserPoolAddOns":{"Type":37,"Flags":0},"UserPoolId":{"Type":4,"Flags":18},"UserPoolName":{"Type":4,"Flags":0},"UserPoolTags":{"Type":47,"Flags":0},"UsernameAttributes":{"Type":48,"Flags":0},"UsernameConfiguration":{"Type":38,"Flags":0},"VerificationMessageTemplate":{"Type":39,"Flags":0}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":33}},{"2":{"Name":"UserPool_UserPoolTags","Properties":{}}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.Cognito/UserPool","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":42,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Cognito/UserPool@default","ScopeType":0,"Body":49}},{"2":{"Name":"AnalyticsConfiguration","Properties":{"ApplicationArn":{"Type":4,"Flags":0},"ApplicationId":{"Type":4,"Flags":0},"ExternalId":{"Type":4,"Flags":0},"RoleArn":{"Type":4,"Flags":0},"UserDataShared":{"Type":2,"Flags":0}}}},{"2":{"Name":"TokenValidityUnits","Properties":{"AccessToken":{"Type":4,"Flags":0},"IdToken":{"Type":4,"Flags":0},"RefreshToken":{"Type":4,"Flags":0}}}},{"2":{"Name":"AWS.Cognito/UserPoolClientProperties","Properties":{"AccessTokenValidity":{"Type":3,"Flags":0},"AllowedOAuthFlows":{"Type":54,"Flags":0},"AllowedOAuthFlowsUserPoolClient":{"Type":2,"Flags":0},"AllowedOAuthScopes":{"Type":55,"Flags":0},"AnalyticsConfiguration":{"Type":51,"Flags":0},"AuthSessionValidity":{"Type":3,"Flags":0},"CallbackURLs":{"Type":56,"Flags":0},"ClientId":{"Type":4,"Flags":18},"ClientName":{"Type":4,"Flags":0},"ClientSecret":{"Type":4,"Flags":2},"DefaultRedirectURI":{"Type":4,"Flags":0},"EnablePropagateAdditionalUserContextData":{"Type":2,"Flags":0},"EnableTokenRevocation":{"Type":2,"Flags":0},"ExplicitAuthFlows":{"Type":57,"Flags":0},"GenerateSecret":{"Type":2,"Flags":0},"IdTokenValidity":{"Type":3,"Flags":0},"LogoutURLs":{"Type":58,"Flags":0},"Name":{"Type":4,"Flags":2},"PreventUserExistenceErrors":{"Type":4,"Flags":0},"ReadAttributes":{"Type":59,"Flags":0},"RefreshTokenValidity":{"Type":3,"Flags":0},"SupportedIdentityProviders":{"Type":60,"Flags":0},"TokenValidityUnits":{"Type":52,"Flags":0},"UserPoolId":{"Type":4,"Flags":17},"WriteAttributes":{"Type":61,"Flags":0}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.Cognito/UserPoolClient","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":53,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Cognito/UserPoolClient@default","ScopeType":0,"Body":62}},{"2":{"Name":"AWS.Cognito/UserPoolGroupProperties","Properties":{"Description":{"Type":4,"Flags":0},"GroupName":{"Type":4,"Flags":16},"Precedence":{"Type":3,"Flags":0},"RoleArn":{"Type":4,"Flags":0},"UserPoolId":{"Type":4,"Flags":17}}}},{"2":{"Name":"AWS.Cognito/UserPoolGroup","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":64,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Cognito/UserPoolGroup@default","ScopeType":0,"Body":65}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "CognitoIdentityProvider", + "properties": { + "ClientId": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + }, + "ProviderName": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + }, + "ServerSideTokenCheck": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CognitoStreams", + "properties": { + "RoleArn": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "StreamName": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "StreamingStatus": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PushSync", + "properties": { + "ApplicationArns": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "RoleArn": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Cognito/IdentityPoolProperties" + }, + { + "$type": "ObjectType", + "name": "IdentityPool_CognitoEvents", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ObjectType", + "name": "IdentityPool_SupportedLoginProviders", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AWS.Cognito/IdentityPoolProperties", + "properties": { + "AllowClassicFlow": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "AllowUnauthenticatedIdentities": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + }, + "CognitoEvents": { + "type": { + "$ref": "#/7" + }, + "flags": 4 + }, + "CognitoIdentityProviders": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "CognitoStreams": { + "type": { + "$ref": "#/1" + }, + "flags": 4 + }, + "DeveloperProviderName": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "Id": { + "type": { + "$ref": "#/3" + }, + "flags": 18 + }, + "IdentityPoolName": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/3" + }, + "flags": 2 + }, + "OpenIdConnectProviderARNs": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "PushSync": { + "type": { + "$ref": "#/2" + }, + "flags": 4 + }, + "SamlProviderARNs": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "SupportedLoginProviders": { + "type": { + "$ref": "#/11" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Cognito/IdentityPool", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/12" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Cognito/IdentityPool@default", + "scopeType": 0, + "body": { + "$ref": "#/13" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.Cognito/IdentityPoolPrincipalTagProperties" + }, + { + "$type": "ObjectType", + "name": "IdentityPoolPrincipalTag_PrincipalTags", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AWS.Cognito/IdentityPoolPrincipalTagProperties", + "properties": { + "IdentityPoolId": { + "type": { + "$ref": "#/3" + }, + "flags": 17 + }, + "IdentityProviderName": { + "type": { + "$ref": "#/3" + }, + "flags": 17 + }, + "PrincipalTags": { + "type": { + "$ref": "#/16" + }, + "flags": 0 + }, + "UseDefaults": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Cognito/IdentityPoolPrincipalTag", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/17" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Cognito/IdentityPoolPrincipalTag@default", + "scopeType": 0, + "body": { + "$ref": "#/18" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "MappingRule", + "properties": { + "Claim": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + }, + "MatchType": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + }, + "RoleARN": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "RoleMapping", + "properties": { + "AmbiguousRoleResolution": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "IdentityProvider": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "RulesConfiguration": { + "type": { + "$ref": "#/22" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "RulesConfigurationType", + "properties": { + "Rules": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/20" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Cognito/IdentityPoolRoleAttachmentProperties" + }, + { + "$type": "ObjectType", + "name": "IdentityPoolRoleAttachment_RoleMappings", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "IdentityPoolRoleAttachment_Roles", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AWS.Cognito/IdentityPoolRoleAttachmentProperties", + "properties": { + "Id": { + "type": { + "$ref": "#/3" + }, + "flags": 18 + }, + "IdentityPoolId": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + }, + "RoleMappings": { + "type": { + "$ref": "#/25" + }, + "flags": 0 + }, + "Roles": { + "type": { + "$ref": "#/26" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Cognito/IdentityPoolRoleAttachment", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/27" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Cognito/IdentityPoolRoleAttachment@default", + "scopeType": 0, + "body": { + "$ref": "#/28" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "CloudWatchLogsConfiguration", + "properties": { + "LogGroupArn": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "LogConfiguration", + "properties": { + "CloudWatchLogsConfiguration": { + "type": { + "$ref": "#/30" + }, + "flags": 0 + }, + "EventSource": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "LogLevel": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "LogConfigurations", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/31" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Cognito/LogDeliveryConfigurationProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/31" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Cognito/LogDeliveryConfigurationProperties", + "properties": { + "Id": { + "type": { + "$ref": "#/3" + }, + "flags": 18 + }, + "LogConfigurations": { + "type": { + "$ref": "#/35" + }, + "flags": 0 + }, + "UserPoolId": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Cognito/LogDeliveryConfiguration", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/36" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Cognito/LogDeliveryConfiguration@default", + "scopeType": 0, + "body": { + "$ref": "#/37" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AccountRecoverySetting", + "properties": { + "RecoveryMechanisms": { + "type": { + "$ref": "#/59" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AdminCreateUserConfig", + "properties": { + "AllowAdminCreateUserOnly": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "InviteMessageTemplate": { + "type": { + "$ref": "#/45" + }, + "flags": 0 + }, + "UnusedAccountValidityDays": { + "type": { + "$ref": "#/60" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomEmailSender", + "properties": { + "LambdaArn": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "LambdaVersion": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomSMSSender", + "properties": { + "LambdaArn": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "LambdaVersion": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DeviceConfiguration", + "properties": { + "ChallengeRequiredOnNewDevice": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "DeviceOnlyRememberedOnUserPrompt": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "EmailConfiguration", + "properties": { + "ConfigurationSet": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "EmailSendingAccount": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "From": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "ReplyToEmailAddress": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "SourceArn": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "InviteMessageTemplate", + "properties": { + "EmailMessage": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "EmailSubject": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "SMSMessage": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "LambdaConfig", + "properties": { + "CreateAuthChallenge": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "CustomEmailSender": { + "type": { + "$ref": "#/41" + }, + "flags": 0 + }, + "CustomMessage": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "CustomSMSSender": { + "type": { + "$ref": "#/42" + }, + "flags": 0 + }, + "DefineAuthChallenge": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "KMSKeyID": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "PostAuthentication": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "PostConfirmation": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "PreAuthentication": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "PreSignUp": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "PreTokenGeneration": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "PreTokenGenerationConfig": { + "type": { + "$ref": "#/50" + }, + "flags": 0 + }, + "UserMigration": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "VerifyAuthChallengeResponse": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "NumberAttributeConstraints", + "properties": { + "MaxValue": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "MinValue": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PasswordPolicy", + "properties": { + "MinimumLength": { + "type": { + "$ref": "#/60" + }, + "flags": 0 + }, + "RequireLowercase": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "RequireNumbers": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "RequireSymbols": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "RequireUppercase": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "TemporaryPasswordValidityDays": { + "type": { + "$ref": "#/60" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Policies", + "properties": { + "PasswordPolicy": { + "type": { + "$ref": "#/48" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PreTokenGenerationConfig", + "properties": { + "LambdaArn": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "LambdaVersion": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "RecoveryOption", + "properties": { + "Name": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "Priority": { + "type": { + "$ref": "#/60" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SchemaAttribute", + "properties": { + "AttributeDataType": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "DeveloperOnlyAttribute": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "Mutable": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "NumberAttributeConstraints": { + "type": { + "$ref": "#/47" + }, + "flags": 0 + }, + "Required": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "StringAttributeConstraints": { + "type": { + "$ref": "#/54" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SmsConfiguration", + "properties": { + "ExternalId": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "SnsCallerArn": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "SnsRegion": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "StringAttributeConstraints", + "properties": { + "MaxLength": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "MinLength": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "UserAttributeUpdateSettings", + "properties": { + "AttributesRequireVerificationBeforeUpdate": { + "type": { + "$ref": "#/61" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "UserPoolAddOns", + "properties": { + "AdvancedSecurityMode": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "UsernameConfiguration", + "properties": { + "CaseSensitive": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "VerificationMessageTemplate", + "properties": { + "DefaultEmailOption": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "EmailMessage": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "EmailMessageByLink": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "EmailSubject": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "EmailSubjectByLink": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "SmsMessage": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/51" + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Cognito/UserPoolProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/52" + } + }, + { + "$type": "ObjectType", + "name": "UserPool_UserPoolTags", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Cognito/UserPoolProperties", + "properties": { + "AccountRecoverySetting": { + "type": { + "$ref": "#/39" + }, + "flags": 0 + }, + "AdminCreateUserConfig": { + "type": { + "$ref": "#/40" + }, + "flags": 0 + }, + "AliasAttributes": { + "type": { + "$ref": "#/63" + }, + "flags": 0 + }, + "Arn": { + "type": { + "$ref": "#/3" + }, + "flags": 2 + }, + "AutoVerifiedAttributes": { + "type": { + "$ref": "#/64" + }, + "flags": 0 + }, + "DeletionProtection": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "DeviceConfiguration": { + "type": { + "$ref": "#/43" + }, + "flags": 0 + }, + "EmailConfiguration": { + "type": { + "$ref": "#/44" + }, + "flags": 0 + }, + "EmailVerificationMessage": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "EmailVerificationSubject": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "EnabledMfas": { + "type": { + "$ref": "#/65" + }, + "flags": 4 + }, + "LambdaConfig": { + "type": { + "$ref": "#/46" + }, + "flags": 0 + }, + "MfaConfiguration": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "Policies": { + "type": { + "$ref": "#/49" + }, + "flags": 0 + }, + "ProviderName": { + "type": { + "$ref": "#/3" + }, + "flags": 2 + }, + "ProviderURL": { + "type": { + "$ref": "#/3" + }, + "flags": 2 + }, + "Schema": { + "type": { + "$ref": "#/66" + }, + "flags": 0 + }, + "SmsAuthenticationMessage": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "SmsConfiguration": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "SmsVerificationMessage": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "UserAttributeUpdateSettings": { + "type": { + "$ref": "#/55" + }, + "flags": 0 + }, + "UserPoolAddOns": { + "type": { + "$ref": "#/56" + }, + "flags": 0 + }, + "UserPoolId": { + "type": { + "$ref": "#/3" + }, + "flags": 18 + }, + "UserPoolName": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "UserPoolTags": { + "type": { + "$ref": "#/67" + }, + "flags": 0 + }, + "UsernameAttributes": { + "type": { + "$ref": "#/68" + }, + "flags": 0 + }, + "UsernameConfiguration": { + "type": { + "$ref": "#/57" + }, + "flags": 0 + }, + "VerificationMessageTemplate": { + "type": { + "$ref": "#/58" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Cognito/UserPool", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/69" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Cognito/UserPool@default", + "scopeType": 0, + "body": { + "$ref": "#/70" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AnalyticsConfiguration", + "properties": { + "ApplicationArn": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "ApplicationId": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "ExternalId": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "RoleArn": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "UserDataShared": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TokenValidityUnits", + "properties": { + "AccessToken": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "IdToken": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "RefreshToken": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Cognito/UserPoolClientProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Cognito/UserPoolClientProperties", + "properties": { + "AccessTokenValidity": { + "type": { + "$ref": "#/60" + }, + "flags": 0 + }, + "AllowedOAuthFlows": { + "type": { + "$ref": "#/75" + }, + "flags": 0 + }, + "AllowedOAuthFlowsUserPoolClient": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "AllowedOAuthScopes": { + "type": { + "$ref": "#/76" + }, + "flags": 0 + }, + "AnalyticsConfiguration": { + "type": { + "$ref": "#/72" + }, + "flags": 0 + }, + "AuthSessionValidity": { + "type": { + "$ref": "#/60" + }, + "flags": 0 + }, + "CallbackURLs": { + "type": { + "$ref": "#/77" + }, + "flags": 0 + }, + "ClientId": { + "type": { + "$ref": "#/3" + }, + "flags": 18 + }, + "ClientName": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "ClientSecret": { + "type": { + "$ref": "#/3" + }, + "flags": 2 + }, + "DefaultRedirectURI": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "EnablePropagateAdditionalUserContextData": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "EnableTokenRevocation": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "ExplicitAuthFlows": { + "type": { + "$ref": "#/78" + }, + "flags": 0 + }, + "GenerateSecret": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "IdTokenValidity": { + "type": { + "$ref": "#/60" + }, + "flags": 0 + }, + "LogoutURLs": { + "type": { + "$ref": "#/79" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/3" + }, + "flags": 2 + }, + "PreventUserExistenceErrors": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "ReadAttributes": { + "type": { + "$ref": "#/80" + }, + "flags": 0 + }, + "RefreshTokenValidity": { + "type": { + "$ref": "#/60" + }, + "flags": 0 + }, + "SupportedIdentityProviders": { + "type": { + "$ref": "#/81" + }, + "flags": 0 + }, + "TokenValidityUnits": { + "type": { + "$ref": "#/73" + }, + "flags": 0 + }, + "UserPoolId": { + "type": { + "$ref": "#/3" + }, + "flags": 17 + }, + "WriteAttributes": { + "type": { + "$ref": "#/82" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Cognito/UserPoolClient", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/83" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Cognito/UserPoolClient@default", + "scopeType": 0, + "body": { + "$ref": "#/84" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.Cognito/UserPoolGroupProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.Cognito/UserPoolGroupProperties", + "properties": { + "Description": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "GroupName": { + "type": { + "$ref": "#/3" + }, + "flags": 16 + }, + "Precedence": { + "type": { + "$ref": "#/60" + }, + "flags": 0 + }, + "RoleArn": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "UserPoolId": { + "type": { + "$ref": "#/3" + }, + "flags": 17 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Cognito/UserPoolGroup", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/87" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Cognito/UserPoolGroup@default", + "scopeType": 0, + "body": { + "$ref": "#/88" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "ResourceServerScopeType", + "properties": { + "ScopeDescription": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + }, + "ScopeName": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Cognito/UserPoolResourceServerProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/90" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Cognito/UserPoolResourceServerProperties", + "properties": { + "Identifier": { + "type": { + "$ref": "#/3" + }, + "flags": 17 + }, + "Name": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + }, + "Scopes": { + "type": { + "$ref": "#/92" + }, + "flags": 0 + }, + "UserPoolId": { + "type": { + "$ref": "#/3" + }, + "flags": 17 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Cognito/UserPoolResourceServer", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/93" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Cognito/UserPoolResourceServer@default", + "scopeType": 0, + "body": { + "$ref": "#/94" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AccountTakeoverActionType", + "properties": { + "EventAction": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + }, + "Notify": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AccountTakeoverActionsType", + "properties": { + "HighAction": { + "type": { + "$ref": "#/96" + }, + "flags": 0 + }, + "LowAction": { + "type": { + "$ref": "#/96" + }, + "flags": 0 + }, + "MediumAction": { + "type": { + "$ref": "#/96" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AccountTakeoverRiskConfigurationType", + "properties": { + "Actions": { + "type": { + "$ref": "#/97" + }, + "flags": 1 + }, + "NotifyConfiguration": { + "type": { + "$ref": "#/101" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CompromisedCredentialsActionsType", + "properties": { + "EventAction": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CompromisedCredentialsRiskConfigurationType", + "properties": { + "Actions": { + "type": { + "$ref": "#/99" + }, + "flags": 1 + }, + "EventFilter": { + "type": { + "$ref": "#/104" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "NotifyConfigurationType", + "properties": { + "BlockEmail": { + "type": { + "$ref": "#/102" + }, + "flags": 0 + }, + "From": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "MfaEmail": { + "type": { + "$ref": "#/102" + }, + "flags": 0 + }, + "NoActionEmail": { + "type": { + "$ref": "#/102" + }, + "flags": 0 + }, + "ReplyTo": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "SourceArn": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "NotifyEmailType", + "properties": { + "HtmlBody": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "Subject": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + }, + "TextBody": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "RiskExceptionConfigurationType", + "properties": { + "BlockedIPRangeList": { + "type": { + "$ref": "#/105" + }, + "flags": 0 + }, + "SkippedIPRangeList": { + "type": { + "$ref": "#/106" + }, + "flags": 0 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Cognito/UserPoolRiskConfigurationAttachmentProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.Cognito/UserPoolRiskConfigurationAttachmentProperties", + "properties": { + "AccountTakeoverRiskConfiguration": { + "type": { + "$ref": "#/98" + }, + "flags": 0 + }, + "ClientId": { + "type": { + "$ref": "#/3" + }, + "flags": 17 + }, + "CompromisedCredentialsRiskConfiguration": { + "type": { + "$ref": "#/100" + }, + "flags": 0 + }, + "RiskExceptionConfiguration": { + "type": { + "$ref": "#/103" + }, + "flags": 0 + }, + "UserPoolId": { + "type": { + "$ref": "#/3" + }, + "flags": 17 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Cognito/UserPoolRiskConfigurationAttachment", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/108" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Cognito/UserPoolRiskConfigurationAttachment@default", + "scopeType": 0, + "body": { + "$ref": "#/109" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.cognito/default/types.md b/artifacts/bicep/aws/aws.cognito/default/types.md index 296ec7ba..10599605 100644 --- a/artifacts/bicep/aws/aws.cognito/default/types.md +++ b/artifacts/bicep/aws/aws.cognito/default/types.md @@ -1,39 +1,101 @@ # AWS.Cognito @ default +## Resource AWS.Cognito/IdentityPool@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.Cognito/IdentityPoolProperties](#awscognitoidentitypoolproperties) (Required, Identifier): properties of the resource + ## Resource AWS.Cognito/IdentityPoolPrincipalTag@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.Cognito/IdentityPoolPrincipalTagProperties](#awscognitoidentitypoolprincipaltagproperties) (Required, Identifier): properties of the resource + +## Resource AWS.Cognito/IdentityPoolRoleAttachment@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Cognito/IdentityPoolPrincipalTagProperties](#awscognitoidentitypoolprincipaltagproperties) (Required): properties of the resource +* **properties**: [AWS.Cognito/IdentityPoolRoleAttachmentProperties](#awscognitoidentitypoolroleattachmentproperties) (Required, Identifier): properties of the resource ## Resource AWS.Cognito/LogDeliveryConfiguration@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Cognito/LogDeliveryConfigurationProperties](#awscognitologdeliveryconfigurationproperties) (Required): properties of the resource +* **properties**: [AWS.Cognito/LogDeliveryConfigurationProperties](#awscognitologdeliveryconfigurationproperties) (Required, Identifier): properties of the resource ## Resource AWS.Cognito/UserPool@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Cognito/UserPoolProperties](#awscognitouserpoolproperties): properties of the resource +* **properties**: [AWS.Cognito/UserPoolProperties](#awscognitouserpoolproperties) (Identifier): properties of the resource ## Resource AWS.Cognito/UserPoolClient@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Cognito/UserPoolClientProperties](#awscognitouserpoolclientproperties) (Required): properties of the resource +* **properties**: [AWS.Cognito/UserPoolClientProperties](#awscognitouserpoolclientproperties) (Required, Identifier): properties of the resource ## Resource AWS.Cognito/UserPoolGroup@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.Cognito/UserPoolGroupProperties](#awscognitouserpoolgroupproperties) (Required, Identifier): properties of the resource + +## Resource AWS.Cognito/UserPoolResourceServer@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.Cognito/UserPoolResourceServerProperties](#awscognitouserpoolresourceserverproperties) (Required, Identifier): properties of the resource + +## Resource AWS.Cognito/UserPoolRiskConfigurationAttachment@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Cognito/UserPoolGroupProperties](#awscognitouserpoolgroupproperties) (Required): properties of the resource +* **properties**: [AWS.Cognito/UserPoolRiskConfigurationAttachmentProperties](#awscognitouserpoolriskconfigurationattachmentproperties) (Required, Identifier): properties of the resource + +## AccountRecoverySetting +### Properties +* **RecoveryMechanisms**: [RecoveryOption](#recoveryoption)[] + +## AccountTakeoverActionsType +### Properties +* **HighAction**: [AccountTakeoverActionType](#accounttakeoveractiontype) +* **LowAction**: [AccountTakeoverActionType](#accounttakeoveractiontype) +* **MediumAction**: [AccountTakeoverActionType](#accounttakeoveractiontype) + +## AccountTakeoverActionType +### Properties +* **EventAction**: string (Required) +* **Notify**: bool (Required) + +## AccountTakeoverRiskConfigurationType +### Properties +* **Actions**: [AccountTakeoverActionsType](#accounttakeoveractionstype) (Required) +* **NotifyConfiguration**: [NotifyConfigurationType](#notifyconfigurationtype) + +## AdminCreateUserConfig +### Properties +* **AllowAdminCreateUserOnly**: bool +* **InviteMessageTemplate**: [InviteMessageTemplate](#invitemessagetemplate) +* **UnusedAccountValidityDays**: int + +## AnalyticsConfiguration +### Properties +* **ApplicationArn**: string +* **ApplicationId**: string +* **ExternalId**: string +* **RoleArn**: string +* **UserDataShared**: bool ## AWS.Cognito/IdentityPoolPrincipalTagProperties ### Properties @@ -42,8 +104,28 @@ * **PrincipalTags**: [IdentityPoolPrincipalTag_PrincipalTags](#identitypoolprincipaltagprincipaltags) * **UseDefaults**: bool -## IdentityPoolPrincipalTag_PrincipalTags +## AWS.Cognito/IdentityPoolProperties +### Properties +* **AllowClassicFlow**: bool +* **AllowUnauthenticatedIdentities**: bool (Required) +* **CognitoEvents**: [IdentityPool_CognitoEvents](#identitypoolcognitoevents) (WriteOnly) +* **CognitoIdentityProviders**: [CognitoIdentityProvider](#cognitoidentityprovider)[] +* **CognitoStreams**: [CognitoStreams](#cognitostreams) (WriteOnly) +* **DeveloperProviderName**: string +* **Id**: string (ReadOnly, Identifier) +* **IdentityPoolName**: string +* **Name**: string (ReadOnly) +* **OpenIdConnectProviderARNs**: string[] +* **PushSync**: [PushSync](#pushsync) (WriteOnly) +* **SamlProviderARNs**: string[] +* **SupportedLoginProviders**: [IdentityPool_SupportedLoginProviders](#identitypoolsupportedloginproviders) + +## AWS.Cognito/IdentityPoolRoleAttachmentProperties ### Properties +* **Id**: string (ReadOnly, Identifier) +* **IdentityPoolId**: string (Required) +* **RoleMappings**: [IdentityPoolRoleAttachment_RoleMappings](#identitypoolroleattachmentrolemappings) +* **Roles**: [IdentityPoolRoleAttachment_Roles](#identitypoolroleattachmentroles) ## AWS.Cognito/LogDeliveryConfigurationProperties ### Properties @@ -51,15 +133,41 @@ * **LogConfigurations**: [LogConfiguration](#logconfiguration)[] * **UserPoolId**: string (Required) -## LogConfiguration +## AWS.Cognito/UserPoolClientProperties ### Properties -* **CloudWatchLogsConfiguration**: [CloudWatchLogsConfiguration](#cloudwatchlogsconfiguration) -* **EventSource**: string -* **LogLevel**: string +* **AccessTokenValidity**: int +* **AllowedOAuthFlows**: string[] +* **AllowedOAuthFlowsUserPoolClient**: bool +* **AllowedOAuthScopes**: string[] +* **AnalyticsConfiguration**: [AnalyticsConfiguration](#analyticsconfiguration) +* **AuthSessionValidity**: int +* **CallbackURLs**: string[] +* **ClientId**: string (ReadOnly, Identifier) +* **ClientName**: string +* **ClientSecret**: string (ReadOnly) +* **DefaultRedirectURI**: string +* **EnablePropagateAdditionalUserContextData**: bool +* **EnableTokenRevocation**: bool +* **ExplicitAuthFlows**: string[] +* **GenerateSecret**: bool +* **IdTokenValidity**: int +* **LogoutURLs**: string[] +* **Name**: string (ReadOnly) +* **PreventUserExistenceErrors**: string +* **ReadAttributes**: string[] +* **RefreshTokenValidity**: int +* **SupportedIdentityProviders**: string[] +* **TokenValidityUnits**: [TokenValidityUnits](#tokenvalidityunits) +* **UserPoolId**: string (Required, Identifier) +* **WriteAttributes**: string[] -## CloudWatchLogsConfiguration +## AWS.Cognito/UserPoolGroupProperties ### Properties -* **LogGroupArn**: string +* **Description**: string +* **GroupName**: string (Identifier) +* **Precedence**: int +* **RoleArn**: string +* **UserPoolId**: string (Required, Identifier) ## AWS.Cognito/UserPoolProperties ### Properties @@ -92,26 +200,55 @@ * **UserPoolTags**: [UserPool_UserPoolTags](#userpooluserpooltags) * **VerificationMessageTemplate**: [VerificationMessageTemplate](#verificationmessagetemplate) -## AccountRecoverySetting +## AWS.Cognito/UserPoolResourceServerProperties ### Properties -* **RecoveryMechanisms**: [RecoveryOption](#recoveryoption)[] +* **Identifier**: string (Required, Identifier) +* **Name**: string (Required) +* **Scopes**: [ResourceServerScopeType](#resourceserverscopetype)[] +* **UserPoolId**: string (Required, Identifier) -## RecoveryOption +## AWS.Cognito/UserPoolRiskConfigurationAttachmentProperties ### Properties -* **Name**: string -* **Priority**: int +* **AccountTakeoverRiskConfiguration**: [AccountTakeoverRiskConfigurationType](#accounttakeoverriskconfigurationtype) +* **ClientId**: string (Required, Identifier) +* **CompromisedCredentialsRiskConfiguration**: [CompromisedCredentialsRiskConfigurationType](#compromisedcredentialsriskconfigurationtype) +* **RiskExceptionConfiguration**: [RiskExceptionConfigurationType](#riskexceptionconfigurationtype) +* **UserPoolId**: string (Required, Identifier) -## AdminCreateUserConfig +## CloudWatchLogsConfiguration ### Properties -* **AllowAdminCreateUserOnly**: bool -* **InviteMessageTemplate**: [InviteMessageTemplate](#invitemessagetemplate) -* **UnusedAccountValidityDays**: int +* **LogGroupArn**: string -## InviteMessageTemplate +## CognitoIdentityProvider ### Properties -* **EmailMessage**: string -* **EmailSubject**: string -* **SMSMessage**: string +* **ClientId**: string (Required) +* **ProviderName**: string (Required) +* **ServerSideTokenCheck**: bool + +## CognitoStreams +### Properties +* **RoleArn**: string +* **StreamingStatus**: string +* **StreamName**: string + +## CompromisedCredentialsActionsType +### Properties +* **EventAction**: string (Required) + +## CompromisedCredentialsRiskConfigurationType +### Properties +* **Actions**: [CompromisedCredentialsActionsType](#compromisedcredentialsactionstype) (Required) +* **EventFilter**: string[] + +## CustomEmailSender +### Properties +* **LambdaArn**: string +* **LambdaVersion**: string + +## CustomSMSSender +### Properties +* **LambdaArn**: string +* **LambdaVersion**: string ## DeviceConfiguration ### Properties @@ -126,6 +263,27 @@ * **ReplyToEmailAddress**: string * **SourceArn**: string +## IdentityPool_CognitoEvents +### Properties + +## IdentityPool_SupportedLoginProviders +### Properties + +## IdentityPoolPrincipalTag_PrincipalTags +### Properties + +## IdentityPoolRoleAttachment_RoleMappings +### Properties + +## IdentityPoolRoleAttachment_Roles +### Properties + +## InviteMessageTemplate +### Properties +* **EmailMessage**: string +* **EmailSubject**: string +* **SMSMessage**: string + ## LambdaConfig ### Properties * **CreateAuthChallenge**: string @@ -143,24 +301,31 @@ * **UserMigration**: string * **VerifyAuthChallengeResponse**: string -## CustomEmailSender +## LogConfiguration ### Properties -* **LambdaArn**: string -* **LambdaVersion**: string +* **CloudWatchLogsConfiguration**: [CloudWatchLogsConfiguration](#cloudwatchlogsconfiguration) +* **EventSource**: string +* **LogLevel**: string -## CustomSMSSender +## NotifyConfigurationType ### Properties -* **LambdaArn**: string -* **LambdaVersion**: string +* **BlockEmail**: [NotifyEmailType](#notifyemailtype) +* **From**: string +* **MfaEmail**: [NotifyEmailType](#notifyemailtype) +* **NoActionEmail**: [NotifyEmailType](#notifyemailtype) +* **ReplyTo**: string +* **SourceArn**: string (Required) -## PreTokenGenerationConfig +## NotifyEmailType ### Properties -* **LambdaArn**: string -* **LambdaVersion**: string +* **HtmlBody**: string +* **Subject**: string (Required) +* **TextBody**: string -## Policies +## NumberAttributeConstraints ### Properties -* **PasswordPolicy**: [PasswordPolicy](#passwordpolicy) +* **MaxValue**: string +* **MinValue**: string ## PasswordPolicy ### Properties @@ -171,6 +336,35 @@ * **RequireUppercase**: bool * **TemporaryPasswordValidityDays**: int +## Policies +### Properties +* **PasswordPolicy**: [PasswordPolicy](#passwordpolicy) + +## PreTokenGenerationConfig +### Properties +* **LambdaArn**: string +* **LambdaVersion**: string + +## PushSync +### Properties +* **ApplicationArns**: string[] +* **RoleArn**: string + +## RecoveryOption +### Properties +* **Name**: string +* **Priority**: int + +## ResourceServerScopeType +### Properties +* **ScopeDescription**: string (Required) +* **ScopeName**: string (Required) + +## RiskExceptionConfigurationType +### Properties +* **BlockedIPRangeList**: string[] +* **SkippedIPRangeList**: string[] + ## SchemaAttribute ### Properties * **AttributeDataType**: string @@ -181,21 +375,22 @@ * **Required**: bool * **StringAttributeConstraints**: [StringAttributeConstraints](#stringattributeconstraints) -## NumberAttributeConstraints +## SmsConfiguration ### Properties -* **MaxValue**: string -* **MinValue**: string +* **ExternalId**: string +* **SnsCallerArn**: string +* **SnsRegion**: string ## StringAttributeConstraints ### Properties * **MaxLength**: string * **MinLength**: string -## SmsConfiguration +## TokenValidityUnits ### Properties -* **ExternalId**: string -* **SnsCallerArn**: string -* **SnsRegion**: string +* **AccessToken**: string +* **IdToken**: string +* **RefreshToken**: string ## UserAttributeUpdateSettings ### Properties @@ -205,12 +400,12 @@ ### Properties * **CaseSensitive**: bool -## UserPoolAddOns +## UserPool_UserPoolTags ### Properties -* **AdvancedSecurityMode**: string -## UserPool_UserPoolTags +## UserPoolAddOns ### Properties +* **AdvancedSecurityMode**: string ## VerificationMessageTemplate ### Properties @@ -221,53 +416,3 @@ * **EmailSubjectByLink**: string * **SmsMessage**: string -## AWS.Cognito/UserPoolClientProperties -### Properties -* **AccessTokenValidity**: int -* **AllowedOAuthFlows**: string[] -* **AllowedOAuthFlowsUserPoolClient**: bool -* **AllowedOAuthScopes**: string[] -* **AnalyticsConfiguration**: [AnalyticsConfiguration](#analyticsconfiguration) -* **AuthSessionValidity**: int -* **CallbackURLs**: string[] -* **ClientId**: string (ReadOnly, Identifier) -* **ClientName**: string -* **ClientSecret**: string (ReadOnly) -* **DefaultRedirectURI**: string -* **EnablePropagateAdditionalUserContextData**: bool -* **EnableTokenRevocation**: bool -* **ExplicitAuthFlows**: string[] -* **GenerateSecret**: bool -* **IdTokenValidity**: int -* **LogoutURLs**: string[] -* **Name**: string (ReadOnly) -* **PreventUserExistenceErrors**: string -* **ReadAttributes**: string[] -* **RefreshTokenValidity**: int -* **SupportedIdentityProviders**: string[] -* **TokenValidityUnits**: [TokenValidityUnits](#tokenvalidityunits) -* **UserPoolId**: string (Required, Identifier) -* **WriteAttributes**: string[] - -## AnalyticsConfiguration -### Properties -* **ApplicationArn**: string -* **ApplicationId**: string -* **ExternalId**: string -* **RoleArn**: string -* **UserDataShared**: bool - -## TokenValidityUnits -### Properties -* **AccessToken**: string -* **IdToken**: string -* **RefreshToken**: string - -## AWS.Cognito/UserPoolGroupProperties -### Properties -* **Description**: string -* **GroupName**: string (Identifier) -* **Precedence**: int -* **RoleArn**: string -* **UserPoolId**: string (Required, Identifier) - diff --git a/artifacts/bicep/aws/aws.comprehend/default/types.json b/artifacts/bicep/aws/aws.comprehend/default/types.json index f94b1f35..0d4cdca4 100644 --- a/artifacts/bicep/aws/aws.comprehend/default/types.json +++ b/artifacts/bicep/aws/aws.comprehend/default/types.json @@ -1 +1,616 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"AugmentedManifestsListItem","Properties":{"AttributeNames":{"Type":17,"Flags":1},"S3Uri":{"Type":4,"Flags":1},"Split":{"Type":4,"Flags":0}}}},{"2":{"Name":"DocumentClassifierDocuments","Properties":{"S3Uri":{"Type":4,"Flags":1},"TestS3Uri":{"Type":4,"Flags":0}}}},{"2":{"Name":"DocumentClassifierInputDataConfig","Properties":{"AugmentedManifests":{"Type":18,"Flags":0},"DataFormat":{"Type":4,"Flags":0},"DocumentReaderConfig":{"Type":12,"Flags":0},"DocumentType":{"Type":4,"Flags":0},"Documents":{"Type":9,"Flags":0},"LabelDelimiter":{"Type":4,"Flags":0},"S3Uri":{"Type":4,"Flags":0},"TestS3Uri":{"Type":4,"Flags":0}}}},{"2":{"Name":"DocumentClassifierOutputDataConfig","Properties":{"KmsKeyId":{"Type":4,"Flags":0},"S3Uri":{"Type":4,"Flags":0}}}},{"2":{"Name":"DocumentReaderConfig","Properties":{"DocumentReadAction":{"Type":4,"Flags":1},"DocumentReadMode":{"Type":4,"Flags":0},"FeatureTypes":{"Type":19,"Flags":0}}}},{"2":{"Name":"KmsKeyId"}},{"2":{"Name":"S3Uri"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"VpcConfig","Properties":{"SecurityGroupIds":{"Type":20,"Flags":1},"Subnets":{"Type":21,"Flags":1}}}},{"3":{"ItemType":4}},{"3":{"ItemType":8}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.Comprehend/DocumentClassifierProperties","Properties":{"Arn":{"Type":4,"Flags":18},"DataAccessRoleArn":{"Type":4,"Flags":1},"DocumentClassifierName":{"Type":4,"Flags":1},"InputDataConfig":{"Type":10,"Flags":1},"LanguageCode":{"Type":4,"Flags":1},"Mode":{"Type":4,"Flags":0},"ModelKmsKeyId":{"Type":4,"Flags":0},"ModelPolicy":{"Type":4,"Flags":0},"OutputDataConfig":{"Type":11,"Flags":0},"Tags":{"Type":23,"Flags":0},"VersionName":{"Type":4,"Flags":0},"VolumeKmsKeyId":{"Type":4,"Flags":0},"VpcConfig":{"Type":16,"Flags":0}}}},{"3":{"ItemType":15}},{"2":{"Name":"AWS.Comprehend/DocumentClassifier","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":22,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Comprehend/DocumentClassifier@default","ScopeType":0,"Body":24}},{"2":{"Name":"DataSecurityConfig","Properties":{"DataLakeKmsKeyId":{"Type":4,"Flags":0},"ModelKmsKeyId":{"Type":4,"Flags":0},"VolumeKmsKeyId":{"Type":4,"Flags":0},"VpcConfig":{"Type":33,"Flags":0}}}},{"2":{"Name":"DocumentClassificationConfig","Properties":{"Labels":{"Type":34,"Flags":0},"Mode":{"Type":4,"Flags":1}}}},{"2":{"Name":"EntityRecognitionConfig","Properties":{"EntityTypes":{"Type":35,"Flags":0}}}},{"2":{"Name":"EntityTypesListItem","Properties":{"Type":{"Type":4,"Flags":1}}}},{"2":{"Name":"KmsKeyId"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"TaskConfig","Properties":{"DocumentClassificationConfig":{"Type":27,"Flags":0},"EntityRecognitionConfig":{"Type":28,"Flags":0},"LanguageCode":{"Type":4,"Flags":1}}}},{"2":{"Name":"VpcConfig","Properties":{"SecurityGroupIds":{"Type":36,"Flags":1},"Subnets":{"Type":37,"Flags":1}}}},{"3":{"ItemType":4}},{"3":{"ItemType":29}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.Comprehend/FlywheelProperties","Properties":{"ActiveModelArn":{"Type":4,"Flags":0},"Arn":{"Type":4,"Flags":18},"DataAccessRoleArn":{"Type":4,"Flags":1},"DataLakeS3Uri":{"Type":4,"Flags":1},"DataSecurityConfig":{"Type":26,"Flags":0},"FlywheelName":{"Type":4,"Flags":1},"ModelType":{"Type":4,"Flags":0},"Tags":{"Type":39,"Flags":0},"TaskConfig":{"Type":32,"Flags":0}}}},{"3":{"ItemType":31}},{"2":{"Name":"AWS.Comprehend/Flywheel","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":38,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Comprehend/Flywheel@default","ScopeType":0,"Body":40}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "AugmentedManifestsListItem", + "properties": { + "AttributeNames": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + }, + "S3Uri": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + }, + "Split": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DocumentClassifierDocuments", + "properties": { + "S3Uri": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + }, + "TestS3Uri": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DocumentClassifierInputDataConfig", + "properties": { + "AugmentedManifests": { + "type": { + "$ref": "#/11" + }, + "flags": 0 + }, + "DataFormat": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "DocumentReaderConfig": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "DocumentType": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "Documents": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "LabelDelimiter": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "S3Uri": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "TestS3Uri": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DocumentClassifierOutputDataConfig", + "properties": { + "KmsKeyId": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "S3Uri": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DocumentReaderConfig", + "properties": { + "DocumentReadAction": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + }, + "DocumentReadMode": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "FeatureTypes": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "KmsKeyId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "S3Uri", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "VpcConfig", + "properties": { + "SecurityGroupIds": { + "type": { + "$ref": "#/13" + }, + "flags": 1 + }, + "Subnets": { + "type": { + "$ref": "#/14" + }, + "flags": 1 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/9" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/9" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/9" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/9" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Comprehend/DocumentClassifierProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/7" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Comprehend/DocumentClassifierProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/9" + }, + "flags": 18 + }, + "DataAccessRoleArn": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + }, + "DocumentClassifierName": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + }, + "InputDataConfig": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "LanguageCode": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + }, + "Mode": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "ModelKmsKeyId": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "ModelPolicy": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "OutputDataConfig": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/16" + }, + "flags": 0 + }, + "VersionName": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "VolumeKmsKeyId": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "VpcConfig": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Comprehend/DocumentClassifier", + "properties": { + "name": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/9" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/17" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Comprehend/DocumentClassifier@default", + "scopeType": 0, + "body": { + "$ref": "#/18" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "DataSecurityConfig", + "properties": { + "DataLakeKmsKeyId": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "ModelKmsKeyId": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "VolumeKmsKeyId": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "VpcConfig": { + "type": { + "$ref": "#/27" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DocumentClassificationConfig", + "properties": { + "Labels": { + "type": { + "$ref": "#/28" + }, + "flags": 0 + }, + "Mode": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "EntityRecognitionConfig", + "properties": { + "EntityTypes": { + "type": { + "$ref": "#/29" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "EntityTypesListItem", + "properties": { + "Type": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "KmsKeyId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TaskConfig", + "properties": { + "DocumentClassificationConfig": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "EntityRecognitionConfig": { + "type": { + "$ref": "#/22" + }, + "flags": 0 + }, + "LanguageCode": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "VpcConfig", + "properties": { + "SecurityGroupIds": { + "type": { + "$ref": "#/30" + }, + "flags": 1 + }, + "Subnets": { + "type": { + "$ref": "#/31" + }, + "flags": 1 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/9" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/23" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/9" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/9" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Comprehend/FlywheelProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/25" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Comprehend/FlywheelProperties", + "properties": { + "ActiveModelArn": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "Arn": { + "type": { + "$ref": "#/9" + }, + "flags": 18 + }, + "DataAccessRoleArn": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + }, + "DataLakeS3Uri": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + }, + "DataSecurityConfig": { + "type": { + "$ref": "#/20" + }, + "flags": 0 + }, + "FlywheelName": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + }, + "ModelType": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/33" + }, + "flags": 0 + }, + "TaskConfig": { + "type": { + "$ref": "#/26" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Comprehend/Flywheel", + "properties": { + "name": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/9" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/34" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Comprehend/Flywheel@default", + "scopeType": 0, + "body": { + "$ref": "#/35" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.comprehend/default/types.md b/artifacts/bicep/aws/aws.comprehend/default/types.md index 6190d802..576d7802 100644 --- a/artifacts/bicep/aws/aws.comprehend/default/types.md +++ b/artifacts/bicep/aws/aws.comprehend/default/types.md @@ -3,16 +3,22 @@ ## Resource AWS.Comprehend/DocumentClassifier@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Comprehend/DocumentClassifierProperties](#awscomprehenddocumentclassifierproperties) (Required): properties of the resource +* **properties**: [AWS.Comprehend/DocumentClassifierProperties](#awscomprehenddocumentclassifierproperties) (Required, Identifier): properties of the resource ## Resource AWS.Comprehend/Flywheel@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Comprehend/FlywheelProperties](#awscomprehendflywheelproperties) (Required): properties of the resource +* **properties**: [AWS.Comprehend/FlywheelProperties](#awscomprehendflywheelproperties) (Required, Identifier): properties of the resource + +## AugmentedManifestsListItem +### Properties +* **AttributeNames**: string[] (Required) +* **S3Uri**: string (Required) +* **Split**: string ## AWS.Comprehend/DocumentClassifierProperties ### Properties @@ -30,6 +36,35 @@ * **VolumeKmsKeyId**: string * **VpcConfig**: [VpcConfig](#vpcconfig) +## AWS.Comprehend/FlywheelProperties +### Properties +* **ActiveModelArn**: string +* **Arn**: string (ReadOnly, Identifier) +* **DataAccessRoleArn**: string (Required) +* **DataLakeS3Uri**: string (Required) +* **DataSecurityConfig**: [DataSecurityConfig](#datasecurityconfig) +* **FlywheelName**: string (Required) +* **ModelType**: string +* **Tags**: [Tag](#tag)[] +* **TaskConfig**: [TaskConfig](#taskconfig) + +## DataSecurityConfig +### Properties +* **DataLakeKmsKeyId**: string +* **ModelKmsKeyId**: string +* **VolumeKmsKeyId**: string +* **VpcConfig**: [VpcConfig](#vpcconfig) + +## DocumentClassificationConfig +### Properties +* **Labels**: string[] +* **Mode**: string (Required) + +## DocumentClassifierDocuments +### Properties +* **S3Uri**: string (Required) +* **TestS3Uri**: string + ## DocumentClassifierInputDataConfig ### Properties * **AugmentedManifests**: [AugmentedManifestsListItem](#augmentedmanifestslistitem)[] @@ -41,11 +76,10 @@ * **S3Uri**: string * **TestS3Uri**: string -## AugmentedManifestsListItem +## DocumentClassifierOutputDataConfig ### Properties -* **AttributeNames**: string[] (Required) -* **S3Uri**: string (Required) -* **Split**: string +* **KmsKeyId**: string +* **S3Uri**: string ## DocumentReaderConfig ### Properties @@ -53,50 +87,19 @@ * **DocumentReadMode**: string * **FeatureTypes**: string[] -## DocumentClassifierDocuments +## EntityRecognitionConfig ### Properties -* **S3Uri**: string (Required) -* **TestS3Uri**: string +* **EntityTypes**: [EntityTypesListItem](#entitytypeslistitem)[] -## DocumentClassifierOutputDataConfig +## EntityTypesListItem ### Properties -* **KmsKeyId**: string -* **S3Uri**: string +* **Type**: string (Required) ## Tag ### Properties * **Key**: string (Required) * **Value**: string (Required) -## VpcConfig -### Properties -* **SecurityGroupIds**: string[] (Required) -* **Subnets**: string[] (Required) - -## AWS.Comprehend/FlywheelProperties -### Properties -* **ActiveModelArn**: string -* **Arn**: string (ReadOnly, Identifier) -* **DataAccessRoleArn**: string (Required) -* **DataLakeS3Uri**: string (Required) -* **DataSecurityConfig**: [DataSecurityConfig](#datasecurityconfig) -* **FlywheelName**: string (Required) -* **ModelType**: string -* **Tags**: [Tag](#tag)[] -* **TaskConfig**: [TaskConfig](#taskconfig) - -## DataSecurityConfig -### Properties -* **DataLakeKmsKeyId**: string -* **ModelKmsKeyId**: string -* **VolumeKmsKeyId**: string -* **VpcConfig**: [VpcConfig](#vpcconfig) - -## VpcConfig -### Properties -* **SecurityGroupIds**: string[] (Required) -* **Subnets**: string[] (Required) - ## Tag ### Properties * **Key**: string (Required) @@ -108,16 +111,13 @@ * **EntityRecognitionConfig**: [EntityRecognitionConfig](#entityrecognitionconfig) * **LanguageCode**: string (Required) -## DocumentClassificationConfig -### Properties -* **Labels**: string[] -* **Mode**: string (Required) - -## EntityRecognitionConfig +## VpcConfig ### Properties -* **EntityTypes**: [EntityTypesListItem](#entitytypeslistitem)[] +* **SecurityGroupIds**: string[] (Required) +* **Subnets**: string[] (Required) -## EntityTypesListItem +## VpcConfig ### Properties -* **Type**: string (Required) +* **SecurityGroupIds**: string[] (Required) +* **Subnets**: string[] (Required) diff --git a/artifacts/bicep/aws/aws.config/default/types.json b/artifacts/bicep/aws/aws.config/default/types.json index 68a7fb49..f003ad11 100644 --- a/artifacts/bicep/aws/aws.config/default/types.json +++ b/artifacts/bicep/aws/aws.config/default/types.json @@ -1 +1,979 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}}}},{"2":{"Name":"AWS.Config/AggregationAuthorizationProperties","Properties":{"AggregationAuthorizationArn":{"Type":4,"Flags":2,"Description":"The ARN of the AggregationAuthorization."},"AuthorizedAccountId":{"Type":4,"Flags":17,"Description":"The 12-digit account ID of the account authorized to aggregate data."},"AuthorizedAwsRegion":{"Type":4,"Flags":17,"Description":"The region authorized to collect aggregated data."},"Tags":{"Type":10,"Flags":0,"Description":"The tags for the AggregationAuthorization."}}}},{"3":{"ItemType":8}},{"2":{"Name":"AWS.Config/AggregationAuthorization","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":9,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Config/AggregationAuthorization@default","ScopeType":0,"Body":11}},{"2":{"Name":"CustomPolicyDetails","Properties":{"EnableDebugLogDelivery":{"Type":2,"Flags":0,"Description":"Logging toggle for custom policy rule"},"PolicyRuntime":{"Type":4,"Flags":0,"Description":"Runtime system for custom policy rule"},"PolicyText":{"Type":4,"Flags":4,"Description":"Policy definition containing logic for custom policy rule"}}}},{"2":{"Name":"EvaluationModeConfiguration","Properties":{"Mode":{"Type":4,"Flags":0,"Description":"Mode of evaluation of AWS Config rule"}}}},{"2":{"Name":"Scope","Properties":{"ComplianceResourceId":{"Type":4,"Flags":0,"Description":"ID of the only one resource which we want to trigger the rule"},"ComplianceResourceTypes":{"Type":18,"Flags":0,"Description":"Resource types of resources which we want to trigger the rule"},"TagKey":{"Type":4,"Flags":0,"Description":"Tag key applied only to resources which we want to trigger the rule"},"TagValue":{"Type":4,"Flags":0,"Description":"Tag value applied only to resources which we want to trigger the rule"}}}},{"2":{"Name":"Source","Properties":{"CustomPolicyDetails":{"Type":13,"Flags":0,"Description":"Custom policy details when rule is custom owned"},"Owner":{"Type":4,"Flags":1,"Description":"Owner of the config rule"},"SourceDetails":{"Type":19,"Flags":0,"Description":"List of message types that can trigger the rule"},"SourceIdentifier":{"Type":4,"Flags":0,"Description":"Identifier for the source of events"}}}},{"2":{"Name":"SourceDetail","Properties":{"EventSource":{"Type":4,"Flags":1,"Description":"Source of event that can trigger the rule"},"MaximumExecutionFrequency":{"Type":4,"Flags":0,"Description":"Frequency at which the rule has to be evaluated"},"MessageType":{"Type":4,"Flags":1,"Description":"Notification type that can trigger the rule"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":17}},{"2":{"Name":"AWS.Config/ConfigRuleProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"ARN generated for the AWS Config rule "},"Compliance":{"Type":21,"Flags":0,"Description":"Compliance details of the Config rule"},"ConfigRuleId":{"Type":4,"Flags":2,"Description":"ID of the config rule"},"ConfigRuleName":{"Type":4,"Flags":16,"Description":"Name for the AWS Config rule"},"Description":{"Type":4,"Flags":0,"Description":"Description provided for the AWS Config rule"},"EvaluationModes":{"Type":22,"Flags":0,"Description":"List of EvaluationModeConfiguration objects"},"InputParameters":{"Type":24,"Flags":0,"Description":"JSON string passed the Lambda function"},"MaximumExecutionFrequency":{"Type":4,"Flags":0,"Description":"Maximum frequency at which the rule has to be evaluated"},"Scope":{"Type":15,"Flags":0,"Description":"Scope to constrain which resources can trigger the AWS Config rule"},"Source":{"Type":16,"Flags":1,"Description":"Source of events for the AWS Config rule"}}}},{"2":{"Name":"ConfigRule_Compliance","Properties":{"Type":{"Type":4,"Flags":2,"Description":"Compliance type determined by the Config rule"}}}},{"3":{"ItemType":14}},{"2":{"Name":"ConfigRule_InputParameters","Properties":{}}},{"5":{"Elements":[4,23]}},{"2":{"Name":"AWS.Config/ConfigRule","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":20,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Config/ConfigRule@default","ScopeType":0,"Body":25}},{"2":{"Name":"AccountAggregationSource","Properties":{"AccountIds":{"Type":30,"Flags":1},"AllAwsRegions":{"Type":2,"Flags":0},"AwsRegions":{"Type":31,"Flags":0}}}},{"2":{"Name":"OrganizationAggregationSource","Properties":{"AllAwsRegions":{"Type":2,"Flags":0},"AwsRegions":{"Type":32,"Flags":0},"RoleArn":{"Type":4,"Flags":1}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.Config/ConfigurationAggregatorProperties","Properties":{"AccountAggregationSources":{"Type":34,"Flags":0},"ConfigurationAggregatorArn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) of the aggregator."},"ConfigurationAggregatorName":{"Type":4,"Flags":16,"Description":"The name of the aggregator."},"OrganizationAggregationSource":{"Type":28,"Flags":0},"Tags":{"Type":35,"Flags":0,"Description":"The tags for the configuration aggregator."}}}},{"3":{"ItemType":27}},{"3":{"ItemType":29}},{"2":{"Name":"AWS.Config/ConfigurationAggregator","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":33,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Config/ConfigurationAggregator@default","ScopeType":0,"Body":36}},{"2":{"Name":"ConformancePackInputParameter","Properties":{"ParameterName":{"Type":4,"Flags":1},"ParameterValue":{"Type":4,"Flags":1}}}},{"2":{"Name":"ParameterName"}},{"2":{"Name":"ParameterValue"}},{"2":{"Name":"AWS.Config/ConformancePackProperties","Properties":{"ConformancePackInputParameters":{"Type":42,"Flags":0,"Description":"A list of ConformancePackInputParameter objects."},"ConformancePackName":{"Type":4,"Flags":17,"Description":"Name of the conformance pack which will be assigned as the unique identifier."},"DeliveryS3Bucket":{"Type":4,"Flags":0,"Description":"AWS Config stores intermediate files while processing conformance pack template."},"DeliveryS3KeyPrefix":{"Type":4,"Flags":0,"Description":"The prefix for delivery S3 bucket."},"TemplateBody":{"Type":4,"Flags":4,"Description":"A string containing full conformance pack template body. You can only specify one of the template body or template S3Uri fields."},"TemplateS3Uri":{"Type":4,"Flags":4,"Description":"Location of file containing the template body which points to the conformance pack template that is located in an Amazon S3 bucket. You can only specify one of the template body or template S3Uri fields."},"TemplateSSMDocumentDetails":{"Type":43,"Flags":4,"Description":"The TemplateSSMDocumentDetails object contains the name of the SSM document and the version of the SSM document."}}}},{"3":{"ItemType":38}},{"2":{"Name":"ConformancePack_TemplateSSMDocumentDetails","Properties":{"DocumentName":{"Type":4,"Flags":0},"DocumentVersion":{"Type":4,"Flags":0}}}},{"2":{"Name":"AWS.Config/ConformancePack","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":41,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Config/ConformancePack@default","ScopeType":0,"Body":44}},{"2":{"Name":"AccountId"}},{"2":{"Name":"ConformancePackInputParameter","Properties":{"ParameterName":{"Type":4,"Flags":1},"ParameterValue":{"Type":4,"Flags":1}}}},{"2":{"Name":"ParameterName"}},{"2":{"Name":"ParameterValue"}},{"2":{"Name":"AWS.Config/OrganizationConformancePackProperties","Properties":{"ConformancePackInputParameters":{"Type":51,"Flags":0,"Description":"A list of ConformancePackInputParameter objects."},"DeliveryS3Bucket":{"Type":4,"Flags":0,"Description":"AWS Config stores intermediate files while processing conformance pack template."},"DeliveryS3KeyPrefix":{"Type":4,"Flags":0,"Description":"The prefix for the delivery S3 bucket."},"ExcludedAccounts":{"Type":52,"Flags":0,"Description":"A list of AWS accounts to be excluded from an organization conformance pack while deploying a conformance pack."},"OrganizationConformancePackName":{"Type":4,"Flags":17,"Description":"The name of the organization conformance pack."},"TemplateBody":{"Type":4,"Flags":4,"Description":"A string containing full conformance pack template body."},"TemplateS3Uri":{"Type":4,"Flags":4,"Description":"Location of file containing the template body."}}}},{"3":{"ItemType":47}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.Config/OrganizationConformancePack","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":50,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Config/OrganizationConformancePack@default","ScopeType":0,"Body":53}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}}}},{"2":{"Name":"AWS.Config/StoredQueryProperties","Properties":{"QueryArn":{"Type":4,"Flags":2},"QueryDescription":{"Type":4,"Flags":0},"QueryExpression":{"Type":4,"Flags":1},"QueryId":{"Type":4,"Flags":2},"QueryName":{"Type":4,"Flags":17},"Tags":{"Type":57,"Flags":0,"Description":"The tags for the stored query."}}}},{"3":{"ItemType":55}},{"2":{"Name":"AWS.Config/StoredQuery","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":56,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Config/StoredQuery@default","ScopeType":0,"Body":58}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.Config/AggregationAuthorizationProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Config/AggregationAuthorizationProperties", + "properties": { + "AggregationAuthorizationArn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The ARN of the AggregationAuthorization." + }, + "AuthorizedAccountId": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The 12-digit account ID of the account authorized to aggregate data." + }, + "AuthorizedAwsRegion": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The region authorized to collect aggregated data." + }, + "Tags": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The tags for the AggregationAuthorization." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Config/AggregationAuthorization", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Config/AggregationAuthorization@default", + "scopeType": 0, + "body": { + "$ref": "#/5" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "CustomPolicyDetails", + "properties": { + "EnableDebugLogDelivery": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "The boolean expression for enabling debug logging for your CC Custom Policy rule. The default value is ``false``." + }, + "PolicyRuntime": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The runtime system for your CC Custom Policy rule. Guard is a policy-as-code language that allows you to write policies that are enforced by CC Custom Policy rules. For more information about Guard, see the [Guard GitHub Repository](https://docs.aws.amazon.com/https://github.com/aws-cloudformation/cloudformation-guard)." + }, + "PolicyText": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The policy definition containing the logic for your CC Custom Policy rule." + } + } + }, + { + "$type": "ObjectType", + "name": "EvaluationModeConfiguration", + "properties": { + "Mode": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The mode of an evaluation. The valid values are Detective or Proactive." + } + } + }, + { + "$type": "ObjectType", + "name": "Scope", + "properties": { + "ComplianceResourceId": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The ID of the only AWS resource that you want to trigger an evaluation for the rule. If you specify a resource ID, you must specify one resource type for ``ComplianceResourceTypes``." + }, + "ComplianceResourceTypes": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "The resource types of only those AWS resources that you want to trigger an evaluation for the rule. You can only specify one type if you also specify a resource ID for ``ComplianceResourceId``." + }, + "TagKey": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The tag key that is applied to only those AWS resources that you want to trigger an evaluation for the rule." + }, + "TagValue": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The tag value applied to only those AWS resources that you want to trigger an evaluation for the rule. If you specify a value for ``TagValue``, you must also specify a value for ``TagKey``." + } + } + }, + { + "$type": "ObjectType", + "name": "Source", + "properties": { + "CustomPolicyDetails": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "Provides the runtime system, policy definition, and whether debug logging is enabled. Required when owner is set to ``CUSTOM_POLICY``." + }, + "Owner": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Indicates whether AWS or the customer owns and manages the CC rule.\n CC Managed Rules are predefined rules owned by AWS. For more information, see [Managed Rules](https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html) in the *developer guide*.\n CC Custom Rules are rules that you can develop either with Guard (``CUSTOM_POLICY``) or LAMlong (``CUSTOM_LAMBDA``). For more information, see [Custom Rules](https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_develop-rules.html) in the *developer guide*." + }, + "SourceDetails": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "Provides the source and the message types that cause CC to evaluate your AWS resources against a rule. It also provides the frequency with which you want CC to run evaluations for the rule if the trigger type is periodic.\n If the owner is set to ``CUSTOM_POLICY``, the only acceptable values for the CC rule trigger message type are ``ConfigurationItemChangeNotification`` and ``OversizedConfigurationItemChangeNotification``." + }, + "SourceIdentifier": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "For CC Managed rules, a predefined identifier from a list. For example, ``IAM_PASSWORD_POLICY`` is a managed rule. To reference a managed rule, see [List of Managed Rules](https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html).\n For CC Custom Lambda rules, the identifier is the Amazon Resource Name (ARN) of the rule's LAMlong function, such as ``arn:aws:lambda:us-east-2:123456789012:function:custom_rule_name``.\n For CC Custom Policy rules, this field will be ignored." + } + } + }, + { + "$type": "ObjectType", + "name": "SourceDetail", + "properties": { + "EventSource": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The source of the event, such as an AWS service, that triggers CC to evaluate your AWS resources." + }, + "MaximumExecutionFrequency": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The frequency at which you want CC to run evaluations for a custom rule with a periodic trigger. If you specify a value for ``MaximumExecutionFrequency``, then ``MessageType`` must use the ``ScheduledNotification`` value.\n By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the ``MaximumExecutionFrequency`` parameter.\n Based on the valid value you choose, CC runs evaluations once for each valid value. For example, if you choose ``Three_Hours``, CC runs evaluations once every three hours. In this case, ``Three_Hours`` is the frequency of this rule." + }, + "MessageType": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The type of notification that triggers CC to run an evaluation for a rule. You can specify the following notification types:\n + ``ConfigurationItemChangeNotification`` - Triggers an evaluation when CC delivers a configuration item as a result of a resource change.\n + ``OversizedConfigurationItemChangeNotification`` - Triggers an evaluation when CC delivers an oversized configuration item. CC 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 + ``ConfigurationSnapshotDeliveryCompleted`` - Triggers a periodic evaluation when CC delivers a configuration snapshot.\n \n If you want your custom rule to be triggered by configuration changes, specify two SourceDetail objects, one for ``ConfigurationItemChangeNotification`` and one for ``OversizedConfigurationItemChangeNotification``." + } + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/11" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Config/ConfigRuleProperties" + }, + { + "$type": "ObjectType", + "name": "ConfigRule_Compliance", + "properties": { + "Type": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "Compliance type determined by the Config rule" + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/8" + } + }, + { + "$type": "ObjectType", + "name": "ConfigRule_InputParameters", + "properties": {} + }, + { + "$type": "UnionType", + "elements": [ + { + "$ref": "#/1" + }, + { + "$ref": "#/18" + } + ] + }, + { + "$type": "ObjectType", + "name": "AWS.Config/ConfigRuleProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "" + }, + "Compliance": { + "type": { + "$ref": "#/16" + }, + "flags": 0, + "description": "Indicates whether an AWS resource or CC rule is compliant and provides the number of contributors that affect the compliance." + }, + "ConfigRuleId": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "" + }, + "ConfigRuleName": { + "type": { + "$ref": "#/1" + }, + "flags": 16, + "description": "A name for the CC rule. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the rule name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html)." + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The description that you provide for the CC rule." + }, + "EvaluationModes": { + "type": { + "$ref": "#/17" + }, + "flags": 0, + "description": "The modes the CC rule can be evaluated in. The valid values are distinct objects. By default, the value is Detective evaluation mode only." + }, + "InputParameters": { + "type": { + "$ref": "#/19" + }, + "flags": 0, + "description": "A string, in JSON format, that is passed to the CC rule Lambda function." + }, + "MaximumExecutionFrequency": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The maximum frequency with which CC runs evaluations for a rule. You can specify a value for ``MaximumExecutionFrequency`` when:\n + You are using an AWS managed rule that is triggered at a periodic frequency.\n + Your custom rule is triggered when CC delivers the configuration snapshot. For more information, see [ConfigSnapshotDeliveryProperties](https://docs.aws.amazon.com/config/latest/APIReference/API_ConfigSnapshotDeliveryProperties.html).\n \n By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the ``MaximumExecutionFrequency`` parameter." + }, + "Scope": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "Defines which resources can trigger an evaluation for the rule. The scope can include one or more resource types, a combination of one resource type and one resource ID, or a combination of a tag key and value. Specify a scope to constrain the resources that can trigger an evaluation for the rule. If you do not specify a scope, evaluations are triggered when any resource in the recording group changes.\n The scope can be empty." + }, + "Source": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "Provides the rule owner (```` for managed rules, ``CUSTOM_POLICY`` for Custom Policy rules, and ``CUSTOM_LAMBDA`` for Custom Lambda rules), the rule identifier, and the notifications that cause the function to evaluate your AWS resources." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Config/ConfigRule", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/20" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Config/ConfigRule@default", + "scopeType": 0, + "body": { + "$ref": "#/21" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AccountAggregationSource", + "properties": { + "AccountIds": { + "type": { + "$ref": "#/26" + }, + "flags": 1 + }, + "AllAwsRegions": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + }, + "AwsRegions": { + "type": { + "$ref": "#/27" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "OrganizationAggregationSource", + "properties": { + "AllAwsRegions": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + }, + "AwsRegions": { + "type": { + "$ref": "#/28" + }, + "flags": 0 + }, + "RoleArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Config/ConfigurationAggregatorProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/23" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/25" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Config/ConfigurationAggregatorProperties", + "properties": { + "AccountAggregationSources": { + "type": { + "$ref": "#/30" + }, + "flags": 0 + }, + "ConfigurationAggregatorArn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) of the aggregator." + }, + "ConfigurationAggregatorName": { + "type": { + "$ref": "#/1" + }, + "flags": 16, + "description": "The name of the aggregator." + }, + "OrganizationAggregationSource": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/31" + }, + "flags": 0, + "description": "The tags for the configuration aggregator." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Config/ConfigurationAggregator", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/32" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Config/ConfigurationAggregator@default", + "scopeType": 0, + "body": { + "$ref": "#/33" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "ConformancePackInputParameter", + "properties": { + "ParameterName": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "ParameterValue": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ParameterName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ParameterValue", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.Config/ConformancePackProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/35" + } + }, + { + "$type": "ObjectType", + "name": "ConformancePack_TemplateSSMDocumentDetails", + "properties": { + "DocumentName": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "DocumentVersion": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Config/ConformancePackProperties", + "properties": { + "ConformancePackInputParameters": { + "type": { + "$ref": "#/39" + }, + "flags": 0, + "description": "A list of ConformancePackInputParameter objects." + }, + "ConformancePackName": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "Name of the conformance pack which will be assigned as the unique identifier." + }, + "DeliveryS3Bucket": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "AWS Config stores intermediate files while processing conformance pack template." + }, + "DeliveryS3KeyPrefix": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The prefix for delivery S3 bucket." + }, + "TemplateBody": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "A string containing full conformance pack template body. You can only specify one of the template body or template S3Uri fields." + }, + "TemplateS3Uri": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "Location of file containing the template body which points to the conformance pack template that is located in an Amazon S3 bucket. You can only specify one of the template body or template S3Uri fields." + }, + "TemplateSSMDocumentDetails": { + "type": { + "$ref": "#/40" + }, + "flags": 4, + "description": "The TemplateSSMDocumentDetails object contains the name of the SSM document and the version of the SSM document." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Config/ConformancePack", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/41" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Config/ConformancePack@default", + "scopeType": 0, + "body": { + "$ref": "#/42" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AccountId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ConformancePackInputParameter", + "properties": { + "ParameterName": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "ParameterValue": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ParameterName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ParameterValue", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.Config/OrganizationConformancePackProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/45" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Config/OrganizationConformancePackProperties", + "properties": { + "ConformancePackInputParameters": { + "type": { + "$ref": "#/49" + }, + "flags": 0, + "description": "A list of ConformancePackInputParameter objects." + }, + "DeliveryS3Bucket": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "AWS Config stores intermediate files while processing conformance pack template." + }, + "DeliveryS3KeyPrefix": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The prefix for the delivery S3 bucket." + }, + "ExcludedAccounts": { + "type": { + "$ref": "#/50" + }, + "flags": 0, + "description": "A list of AWS accounts to be excluded from an organization conformance pack while deploying a conformance pack." + }, + "OrganizationConformancePackName": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The name of the organization conformance pack." + }, + "TemplateBody": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "A string containing full conformance pack template body." + }, + "TemplateS3Uri": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "Location of file containing the template body." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Config/OrganizationConformancePack", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/51" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Config/OrganizationConformancePack@default", + "scopeType": 0, + "body": { + "$ref": "#/52" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Config/StoredQueryProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/54" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Config/StoredQueryProperties", + "properties": { + "QueryArn": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "QueryDescription": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "QueryExpression": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "QueryId": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "QueryName": { + "type": { + "$ref": "#/1" + }, + "flags": 17 + }, + "Tags": { + "type": { + "$ref": "#/56" + }, + "flags": 0, + "description": "The tags for the stored query." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Config/StoredQuery", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/57" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Config/StoredQuery@default", + "scopeType": 0, + "body": { + "$ref": "#/58" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.config/default/types.md b/artifacts/bicep/aws/aws.config/default/types.md index df317fda..f2adb5bf 100644 --- a/artifacts/bicep/aws/aws.config/default/types.md +++ b/artifacts/bicep/aws/aws.config/default/types.md @@ -3,44 +3,50 @@ ## Resource AWS.Config/AggregationAuthorization@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Config/AggregationAuthorizationProperties](#awsconfigaggregationauthorizationproperties) (Required): properties of the resource +* **properties**: [AWS.Config/AggregationAuthorizationProperties](#awsconfigaggregationauthorizationproperties) (Required, Identifier): properties of the resource ## Resource AWS.Config/ConfigRule@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Config/ConfigRuleProperties](#awsconfigconfigruleproperties) (Required): properties of the resource +* **properties**: [AWS.Config/ConfigRuleProperties](#awsconfigconfigruleproperties) (Required, Identifier): properties of the resource ## Resource AWS.Config/ConfigurationAggregator@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Config/ConfigurationAggregatorProperties](#awsconfigconfigurationaggregatorproperties): properties of the resource +* **properties**: [AWS.Config/ConfigurationAggregatorProperties](#awsconfigconfigurationaggregatorproperties) (Identifier): properties of the resource ## Resource AWS.Config/ConformancePack@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Config/ConformancePackProperties](#awsconfigconformancepackproperties) (Required): properties of the resource +* **properties**: [AWS.Config/ConformancePackProperties](#awsconfigconformancepackproperties) (Required, Identifier): properties of the resource ## Resource AWS.Config/OrganizationConformancePack@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Config/OrganizationConformancePackProperties](#awsconfigorganizationconformancepackproperties) (Required): properties of the resource +* **properties**: [AWS.Config/OrganizationConformancePackProperties](#awsconfigorganizationconformancepackproperties) (Required, Identifier): properties of the resource ## Resource AWS.Config/StoredQuery@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Config/StoredQueryProperties](#awsconfigstoredqueryproperties) (Required): properties of the resource +* **properties**: [AWS.Config/StoredQueryProperties](#awsconfigstoredqueryproperties) (Required, Identifier): properties of the resource + +## AccountAggregationSource +### Properties +* **AccountIds**: string[] (Required) +* **AllAwsRegions**: bool +* **AwsRegions**: string[] ## AWS.Config/AggregationAuthorizationProperties ### Properties @@ -49,57 +55,23 @@ * **AuthorizedAwsRegion**: string (Required, Identifier): The region authorized to collect aggregated data. * **Tags**: [Tag](#tag)[]: The tags for the AggregationAuthorization. -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## AWS.Config/ConfigRuleProperties ### Properties -* **Arn**: string (ReadOnly): ARN generated for the AWS Config rule -* **Compliance**: [ConfigRule_Compliance](#configrulecompliance): Compliance details of the Config rule -* **ConfigRuleId**: string (ReadOnly): ID of the config rule -* **ConfigRuleName**: string (Identifier): Name for the AWS Config rule -* **Description**: string: Description provided for the AWS Config rule -* **EvaluationModes**: [EvaluationModeConfiguration](#evaluationmodeconfiguration)[]: List of EvaluationModeConfiguration objects -* **InputParameters**: [ConfigRule_InputParameters](#configruleinputparameters) | string: JSON string passed the Lambda function -* **MaximumExecutionFrequency**: string: Maximum frequency at which the rule has to be evaluated -* **Scope**: [Scope](#scope): Scope to constrain which resources can trigger the AWS Config rule -* **Source**: [Source](#source) (Required): Source of events for the AWS Config rule - -## ConfigRule_Compliance -### Properties -* **Type**: string (ReadOnly): Compliance type determined by the Config rule - -## EvaluationModeConfiguration -### Properties -* **Mode**: string: Mode of evaluation of AWS Config rule - -## Scope -### Properties -* **ComplianceResourceId**: string: ID of the only one resource which we want to trigger the rule -* **ComplianceResourceTypes**: string[]: Resource types of resources which we want to trigger the rule -* **TagKey**: string: Tag key applied only to resources which we want to trigger the rule -* **TagValue**: string: Tag value applied only to resources which we want to trigger the rule - -## Source -### Properties -* **CustomPolicyDetails**: [CustomPolicyDetails](#custompolicydetails): Custom policy details when rule is custom owned -* **Owner**: string (Required): Owner of the config rule -* **SourceDetails**: [SourceDetail](#sourcedetail)[]: List of message types that can trigger the rule -* **SourceIdentifier**: string: Identifier for the source of events - -## CustomPolicyDetails -### Properties -* **EnableDebugLogDelivery**: bool: Logging toggle for custom policy rule -* **PolicyRuntime**: string: Runtime system for custom policy rule -* **PolicyText**: string (WriteOnly): Policy definition containing logic for custom policy rule - -## SourceDetail -### Properties -* **EventSource**: string (Required): Source of event that can trigger the rule -* **MaximumExecutionFrequency**: string: Frequency at which the rule has to be evaluated -* **MessageType**: string (Required): Notification type that can trigger the rule +* **Arn**: string (ReadOnly) +* **Compliance**: [ConfigRule_Compliance](#configrulecompliance): Indicates whether an AWS resource or CC rule is compliant and provides the number of contributors that affect the compliance. +* **ConfigRuleId**: string (ReadOnly) +* **ConfigRuleName**: string (Identifier): A name for the CC rule. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the rule name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html). +* **Description**: string: The description that you provide for the CC rule. +* **EvaluationModes**: [EvaluationModeConfiguration](#evaluationmodeconfiguration)[]: The modes the CC rule can be evaluated in. The valid values are distinct objects. By default, the value is Detective evaluation mode only. +* **InputParameters**: [ConfigRule_InputParameters](#configruleinputparameters) | string: A string, in JSON format, that is passed to the CC rule Lambda function. +* **MaximumExecutionFrequency**: string: The maximum frequency with which CC runs evaluations for a rule. You can specify a value for ``MaximumExecutionFrequency`` when: + + You are using an AWS managed rule that is triggered at a periodic frequency. + + Your custom rule is triggered when CC delivers the configuration snapshot. For more information, see [ConfigSnapshotDeliveryProperties](https://docs.aws.amazon.com/config/latest/APIReference/API_ConfigSnapshotDeliveryProperties.html). + + By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the ``MaximumExecutionFrequency`` parameter. +* **Scope**: [Scope](#scope): Defines which resources can trigger an evaluation for the rule. The scope can include one or more resource types, a combination of one resource type and one resource ID, or a combination of a tag key and value. Specify a scope to constrain the resources that can trigger an evaluation for the rule. If you do not specify a scope, evaluations are triggered when any resource in the recording group changes. + The scope can be empty. +* **Source**: [Source](#source) (Required): Provides the rule owner (```` for managed rules, ``CUSTOM_POLICY`` for Custom Policy rules, and ``CUSTOM_LAMBDA`` for Custom Lambda rules), the rule identifier, and the notifications that cause the function to evaluate your AWS resources. ## AWS.Config/ConfigurationAggregatorProperties ### Properties @@ -109,23 +81,6 @@ * **OrganizationAggregationSource**: [OrganizationAggregationSource](#organizationaggregationsource) * **Tags**: [Tag](#tag)[]: The tags for the configuration aggregator. -## AccountAggregationSource -### Properties -* **AccountIds**: string[] (Required) -* **AllAwsRegions**: bool -* **AwsRegions**: string[] - -## OrganizationAggregationSource -### Properties -* **AllAwsRegions**: bool -* **AwsRegions**: string[] -* **RoleArn**: string (Required) - -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## AWS.Config/ConformancePackProperties ### Properties * **ConformancePackInputParameters**: [ConformancePackInputParameter](#conformancepackinputparameter)[]: A list of ConformancePackInputParameter objects. @@ -136,16 +91,6 @@ * **TemplateS3Uri**: string (WriteOnly): Location of file containing the template body which points to the conformance pack template that is located in an Amazon S3 bucket. You can only specify one of the template body or template S3Uri fields. * **TemplateSSMDocumentDetails**: [ConformancePack_TemplateSSMDocumentDetails](#conformancepacktemplatessmdocumentdetails) (WriteOnly): The TemplateSSMDocumentDetails object contains the name of the SSM document and the version of the SSM document. -## ConformancePackInputParameter -### Properties -* **ParameterName**: string (Required) -* **ParameterValue**: string (Required) - -## ConformancePack_TemplateSSMDocumentDetails -### Properties -* **DocumentName**: string -* **DocumentVersion**: string - ## AWS.Config/OrganizationConformancePackProperties ### Properties * **ConformancePackInputParameters**: [ConformancePackInputParameter](#conformancepackinputparameter)[]: A list of ConformancePackInputParameter objects. @@ -156,11 +101,6 @@ * **TemplateBody**: string (WriteOnly): A string containing full conformance pack template body. * **TemplateS3Uri**: string (WriteOnly): Location of file containing the template body. -## ConformancePackInputParameter -### Properties -* **ParameterName**: string (Required) -* **ParameterValue**: string (Required) - ## AWS.Config/StoredQueryProperties ### Properties * **QueryArn**: string (ReadOnly) @@ -170,6 +110,84 @@ * **QueryName**: string (Required, Identifier) * **Tags**: [Tag](#tag)[]: The tags for the stored query. +## ConfigRule_Compliance +### Properties +* **Type**: string (ReadOnly): Compliance type determined by the Config rule + +## ConformancePack_TemplateSSMDocumentDetails +### Properties +* **DocumentName**: string +* **DocumentVersion**: string + +## ConformancePackInputParameter +### Properties +* **ParameterName**: string (Required) +* **ParameterValue**: string (Required) + +## ConformancePackInputParameter +### Properties +* **ParameterName**: string (Required) +* **ParameterValue**: string (Required) + +## CustomPolicyDetails +### Properties +* **EnableDebugLogDelivery**: bool: The boolean expression for enabling debug logging for your CC Custom Policy rule. The default value is ``false``. +* **PolicyRuntime**: string: The runtime system for your CC Custom Policy rule. Guard is a policy-as-code language that allows you to write policies that are enforced by CC Custom Policy rules. For more information about Guard, see the [Guard GitHub Repository](https://docs.aws.amazon.com/https://github.com/aws-cloudformation/cloudformation-guard). +* **PolicyText**: string (WriteOnly): The policy definition containing the logic for your CC Custom Policy rule. + +## EvaluationModeConfiguration +### Properties +* **Mode**: string: The mode of an evaluation. The valid values are Detective or Proactive. + +## OrganizationAggregationSource +### Properties +* **AllAwsRegions**: bool +* **AwsRegions**: string[] +* **RoleArn**: string (Required) + +## Scope +### Properties +* **ComplianceResourceId**: string: The ID of the only AWS resource that you want to trigger an evaluation for the rule. If you specify a resource ID, you must specify one resource type for ``ComplianceResourceTypes``. +* **ComplianceResourceTypes**: string[]: The resource types of only those AWS resources that you want to trigger an evaluation for the rule. You can only specify one type if you also specify a resource ID for ``ComplianceResourceId``. +* **TagKey**: string: The tag key that is applied to only those AWS resources that you want to trigger an evaluation for the rule. +* **TagValue**: string: The tag value applied to only those AWS resources that you want to trigger an evaluation for the rule. If you specify a value for ``TagValue``, you must also specify a value for ``TagKey``. + +## Source +### Properties +* **CustomPolicyDetails**: [CustomPolicyDetails](#custompolicydetails): Provides the runtime system, policy definition, and whether debug logging is enabled. Required when owner is set to ``CUSTOM_POLICY``. +* **Owner**: string (Required): Indicates whether AWS or the customer owns and manages the CC rule. + CC Managed Rules are predefined rules owned by AWS. For more information, see [Managed Rules](https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html) in the *developer guide*. + CC Custom Rules are rules that you can develop either with Guard (``CUSTOM_POLICY``) or LAMlong (``CUSTOM_LAMBDA``). For more information, see [Custom Rules](https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_develop-rules.html) in the *developer guide*. +* **SourceDetails**: [SourceDetail](#sourcedetail)[]: Provides the source and the message types that cause CC to evaluate your AWS resources against a rule. It also provides the frequency with which you want CC to run evaluations for the rule if the trigger type is periodic. + If the owner is set to ``CUSTOM_POLICY``, the only acceptable values for the CC rule trigger message type are ``ConfigurationItemChangeNotification`` and ``OversizedConfigurationItemChangeNotification``. +* **SourceIdentifier**: string: For CC Managed rules, a predefined identifier from a list. For example, ``IAM_PASSWORD_POLICY`` is a managed rule. To reference a managed rule, see [List of Managed Rules](https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html). + For CC Custom Lambda rules, the identifier is the Amazon Resource Name (ARN) of the rule's LAMlong function, such as ``arn:aws:lambda:us-east-2:123456789012:function:custom_rule_name``. + For CC Custom Policy rules, this field will be ignored. + +## SourceDetail +### Properties +* **EventSource**: string (Required): The source of the event, such as an AWS service, that triggers CC to evaluate your AWS resources. +* **MaximumExecutionFrequency**: string: The frequency at which you want CC to run evaluations for a custom rule with a periodic trigger. If you specify a value for ``MaximumExecutionFrequency``, then ``MessageType`` must use the ``ScheduledNotification`` value. + By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the ``MaximumExecutionFrequency`` parameter. + Based on the valid value you choose, CC runs evaluations once for each valid value. For example, if you choose ``Three_Hours``, CC runs evaluations once every three hours. In this case, ``Three_Hours`` is the frequency of this rule. +* **MessageType**: string (Required): The type of notification that triggers CC to run an evaluation for a rule. You can specify the following notification types: + + ``ConfigurationItemChangeNotification`` - Triggers an evaluation when CC delivers a configuration item as a result of a resource change. + + ``OversizedConfigurationItemChangeNotification`` - Triggers an evaluation when CC delivers an oversized configuration item. CC may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS. + + ``ScheduledNotification`` - Triggers a periodic evaluation at the frequency specified for ``MaximumExecutionFrequency``. + + ``ConfigurationSnapshotDeliveryCompleted`` - Triggers a periodic evaluation when CC delivers a configuration snapshot. + + If you want your custom rule to be triggered by configuration changes, specify two SourceDetail objects, one for ``ConfigurationItemChangeNotification`` and one for ``OversizedConfigurationItemChangeNotification``. + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + ## Tag ### Properties * **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. diff --git a/artifacts/bicep/aws/aws.connect/default/types.json b/artifacts/bicep/aws/aws.connect/default/types.json index a028fde8..21a1f49d 100644 --- a/artifacts/bicep/aws/aws.connect/default/types.json +++ b/artifacts/bicep/aws/aws.connect/default/types.json @@ -1 +1,4741 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"InstanceId"}},{"2":{"Name":"Origin"}},{"2":{"Name":"AWS.Connect/ApprovedOriginProperties","Properties":{"InstanceId":{"Type":4,"Flags":17},"Origin":{"Type":4,"Flags":17}}}},{"2":{"Name":"AWS.Connect/ApprovedOrigin","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":10,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Connect/ApprovedOrigin@default","ScopeType":0,"Body":11}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. . You can specify a value that is maximum of 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.Connect/ContactFlowProperties","Properties":{"ContactFlowArn":{"Type":4,"Flags":18,"Description":"The identifier of the contact flow (ARN)."},"Content":{"Type":4,"Flags":1,"Description":"The content of the contact flow in JSON format."},"Description":{"Type":4,"Flags":0,"Description":"The description of the contact flow."},"InstanceArn":{"Type":4,"Flags":1,"Description":"The identifier of the Amazon Connect instance (ARN)."},"Name":{"Type":4,"Flags":1,"Description":"The name of the contact flow."},"State":{"Type":4,"Flags":0,"Description":"The state of the contact flow."},"Tags":{"Type":15,"Flags":0,"Description":"One or more tags."},"Type":{"Type":4,"Flags":1,"Description":"The type of the contact flow."}}}},{"3":{"ItemType":13}},{"2":{"Name":"AWS.Connect/ContactFlow","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":14,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Connect/ContactFlow@default","ScopeType":0,"Body":16}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is maximum of 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.Connect/ContactFlowModuleProperties","Properties":{"ContactFlowModuleArn":{"Type":4,"Flags":18,"Description":"The identifier of the contact flow module (ARN)."},"Content":{"Type":4,"Flags":1,"Description":"The content of the contact flow module in JSON format."},"Description":{"Type":4,"Flags":0,"Description":"The description of the contact flow module."},"InstanceArn":{"Type":4,"Flags":1,"Description":"The identifier of the Amazon Connect instance (ARN)."},"Name":{"Type":4,"Flags":1,"Description":"The name of the contact flow module."},"State":{"Type":4,"Flags":0,"Description":"The state of the contact flow module."},"Status":{"Type":4,"Flags":2,"Description":"The status of the contact flow module."},"Tags":{"Type":20,"Flags":0,"Description":"One or more tags."}}}},{"3":{"ItemType":18}},{"2":{"Name":"AWS.Connect/ContactFlowModule","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":19,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Connect/ContactFlowModule@default","ScopeType":0,"Body":21}},{"2":{"Name":"EvaluationFormBaseItem","Properties":{"Section":{"Type":30,"Flags":1,"Description":"The evaluation form section item"}}}},{"2":{"Name":"EvaluationFormItem","Properties":{"Question":{"Type":28,"Flags":0,"Description":"The evaluation form question item"},"Section":{"Type":30,"Flags":0,"Description":"The evaluation form section item"}}}},{"2":{"Name":"EvaluationFormNumericQuestionAutomation","Properties":{"PropertyValue":{"Type":35,"Flags":1,"Description":"The automation property name of the question."}}}},{"2":{"Name":"EvaluationFormNumericQuestionOption","Properties":{"AutomaticFail":{"Type":2,"Flags":0,"Description":"The flag to mark the option as automatic fail."},"MaxValue":{"Type":3,"Flags":1,"Description":"The maximum value of the option range."},"MinValue":{"Type":3,"Flags":1,"Description":"The minimum value of the option range."},"Score":{"Type":3,"Flags":0,"Description":"The score of the option range."}}}},{"2":{"Name":"EvaluationFormNumericQuestionProperties","Properties":{"Automation":{"Type":25,"Flags":0,"Description":"The automation properties for the numeric question."},"MaxValue":{"Type":3,"Flags":1,"Description":"The maximum value for answers of the question."},"MinValue":{"Type":3,"Flags":1,"Description":"The minimum value for answers of the question."},"Options":{"Type":42,"Flags":0,"Description":"The list of option ranges used for scoring."}}}},{"2":{"Name":"EvaluationFormQuestion","Properties":{"Instructions":{"Type":4,"Flags":0,"Description":"The instructions for the question."},"NotApplicableEnabled":{"Type":2,"Flags":0,"Description":"The flag to enable not applicable answers to the question."},"QuestionType":{"Type":4,"Flags":1,"Description":"The type of the question."},"QuestionTypeProperties":{"Type":29,"Flags":0,"Description":"The properties of the question"},"RefId":{"Type":4,"Flags":1,"Description":"The identifier used to reference the question."},"Title":{"Type":4,"Flags":1,"Description":"The title of the question."},"Weight":{"Type":3,"Flags":0,"Description":"The question weight used for scoring."}}}},{"2":{"Name":"EvaluationFormQuestionTypeProperties","Properties":{"Numeric":{"Type":27,"Flags":0,"Description":"The properties of the numeric question."},"SingleSelect":{"Type":34,"Flags":0,"Description":"The properties of the single-select question."}}}},{"2":{"Name":"EvaluationFormSection","Properties":{"Instructions":{"Type":4,"Flags":0,"Description":"The instructions for the section."},"Items":{"Type":43,"Flags":0,"Description":"The list of section items."},"RefId":{"Type":4,"Flags":1,"Description":"The identifier to reference the section."},"Title":{"Type":4,"Flags":1,"Description":"The title of the section."},"Weight":{"Type":3,"Flags":0,"Description":"The item weight used for scoring."}}}},{"2":{"Name":"EvaluationFormSingleSelectQuestionAutomation","Properties":{"DefaultOptionRefId":{"Type":4,"Flags":0,"Description":"The option reference identifier of the default answer."},"Options":{"Type":44,"Flags":1,"Description":"The answer options for the automation."}}}},{"2":{"Name":"EvaluationFormSingleSelectQuestionAutomationOption","Properties":{"RuleCategory":{"Type":39,"Flags":1,"Description":"The automation option based on Rules categories."}}}},{"2":{"Name":"EvaluationFormSingleSelectQuestionOption","Properties":{"AutomaticFail":{"Type":2,"Flags":0,"Description":"The flag to mark the option as automatic fail."},"RefId":{"Type":4,"Flags":1,"Description":"The identifier used to reference the option."},"Score":{"Type":3,"Flags":0,"Description":"The score of the option."},"Text":{"Type":4,"Flags":1,"Description":"The title of the option."}}}},{"2":{"Name":"EvaluationFormSingleSelectQuestionProperties","Properties":{"Automation":{"Type":31,"Flags":0,"Description":"The automation properties for the single-select question."},"DisplayAs":{"Type":4,"Flags":0,"Description":"The display mode of the single-select question."},"Options":{"Type":45,"Flags":1,"Description":"The list of options for the question."}}}},{"2":{"Name":"NumericQuestionPropertyValueAutomation","Properties":{"Label":{"Type":4,"Flags":1,"Description":"The automation property label."}}}},{"2":{"Name":"RefId"}},{"2":{"Name":"Score"}},{"2":{"Name":"ScoringStrategy","Properties":{"Mode":{"Type":4,"Flags":1,"Description":"The scoring mode."},"Status":{"Type":4,"Flags":1,"Description":"The scoring status."}}}},{"2":{"Name":"SingleSelectQuestionRuleCategoryAutomation","Properties":{"Category":{"Type":4,"Flags":1,"Description":"The category name as defined in Rules."},"Condition":{"Type":4,"Flags":1,"Description":"The automation condition applied on contact categories."},"OptionRefId":{"Type":4,"Flags":1,"Description":"The option identifier referencing the option to be selected when the automation option is triggered."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that's 1 to 256 characters in length."}}}},{"2":{"Name":"Weight"}},{"3":{"ItemType":26}},{"3":{"ItemType":24}},{"3":{"ItemType":32}},{"3":{"ItemType":33}},{"2":{"Name":"AWS.Connect/EvaluationFormProperties","Properties":{"Description":{"Type":4,"Flags":0,"Description":"The description of the evaluation form."},"EvaluationFormArn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN) for the evaluation form."},"InstanceArn":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) of the instance."},"Items":{"Type":47,"Flags":1,"Description":"The list of evaluation form items."},"ScoringStrategy":{"Type":38,"Flags":0,"Description":"The scoring strategy."},"Status":{"Type":4,"Flags":1,"Description":"The status of the evaluation form."},"Tags":{"Type":48,"Flags":0,"Description":"One or more tags."},"Title":{"Type":4,"Flags":1,"Description":"The title of the evaluation form."}}}},{"3":{"ItemType":23}},{"3":{"ItemType":40}},{"2":{"Name":"AWS.Connect/EvaluationForm","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":46,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Connect/EvaluationForm@default","ScopeType":0,"Body":49}},{"2":{"Name":"HoursOfOperationConfig","Properties":{"Day":{"Type":4,"Flags":1,"Description":"The day that the hours of operation applies to."},"EndTime":{"Type":52,"Flags":1,"Description":"The end time that your contact center closes."},"StartTime":{"Type":52,"Flags":1,"Description":"The start time that your contact center opens."}}}},{"2":{"Name":"HoursOfOperationTimeSlice","Properties":{"Hours":{"Type":3,"Flags":1,"Description":"The hours."},"Minutes":{"Type":3,"Flags":1,"Description":"The minutes."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is maximum of 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}}}},{"2":{"Name":"AWS.Connect/HoursOfOperationProperties","Properties":{"Config":{"Type":55,"Flags":1,"Description":"Configuration information for the hours of operation: day, start time, and end time."},"Description":{"Type":4,"Flags":0,"Description":"The description of the hours of operation."},"HoursOfOperationArn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN) for the hours of operation."},"InstanceArn":{"Type":4,"Flags":1,"Description":"The identifier of the Amazon Connect instance."},"Name":{"Type":4,"Flags":1,"Description":"The name of the hours of operation."},"Tags":{"Type":56,"Flags":0,"Description":"One or more tags."},"TimeZone":{"Type":4,"Flags":1,"Description":"The time zone of the hours of operation."}}}},{"3":{"ItemType":51}},{"3":{"ItemType":53}},{"2":{"Name":"AWS.Connect/HoursOfOperation","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":54,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Connect/HoursOfOperation@default","ScopeType":0,"Body":57}},{"2":{"Name":"Attributes","Properties":{"AutoResolveBestVoices":{"Type":2,"Flags":0},"ContactLens":{"Type":2,"Flags":0},"ContactflowLogs":{"Type":2,"Flags":0},"EarlyMedia":{"Type":2,"Flags":0},"InboundCalls":{"Type":2,"Flags":1},"OutboundCalls":{"Type":2,"Flags":1},"UseCustomTTSVoices":{"Type":2,"Flags":0}}}},{"2":{"Name":"AutoResolveBestVoices"}},{"2":{"Name":"ContactLens"}},{"2":{"Name":"ContactflowLogs"}},{"2":{"Name":"EarlyMedia"}},{"2":{"Name":"InboundCalls"}},{"2":{"Name":"OutboundCalls"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"UseCustomTTSVoices"}},{"2":{"Name":"AWS.Connect/InstanceProperties","Properties":{"Arn":{"Type":4,"Flags":18,"Description":"An instanceArn is automatically generated on creation based on instanceId."},"Attributes":{"Type":59,"Flags":1,"Description":"The attributes for the instance."},"CreatedTime":{"Type":4,"Flags":2,"Description":"Timestamp of instance creation logged as part of instance creation."},"DirectoryId":{"Type":4,"Flags":4,"Description":"Existing directoryId user wants to map to the new Connect instance."},"Id":{"Type":4,"Flags":2,"Description":"An instanceId is automatically generated on creation and assigned as the unique identifier."},"IdentityManagementType":{"Type":4,"Flags":1,"Description":"Specifies the type of directory integration for new instance."},"InstanceAlias":{"Type":4,"Flags":0,"Description":"Alias of the new directory created as part of new instance creation."},"InstanceStatus":{"Type":4,"Flags":2,"Description":"Specifies the creation status of new instance."},"ServiceRole":{"Type":4,"Flags":2,"Description":"Service linked role created as part of instance creation."},"Tags":{"Type":69,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."}}}},{"3":{"ItemType":66}},{"2":{"Name":"AWS.Connect/Instance","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":68,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Connect/Instance@default","ScopeType":0,"Body":70}},{"2":{"Name":"AssociationId"}},{"2":{"Name":"BucketName"}},{"2":{"Name":"EncryptionConfig","Properties":{"EncryptionType":{"Type":4,"Flags":1},"KeyId":{"Type":4,"Flags":1}}}},{"2":{"Name":"EncryptionType"}},{"2":{"Name":"FirehoseDeliveryStreamArn"}},{"2":{"Name":"Hours"}},{"2":{"Name":"InstanceStorageResourceType"}},{"2":{"Name":"KeyId"}},{"2":{"Name":"KinesisFirehoseConfig","Properties":{"FirehoseArn":{"Type":4,"Flags":1}}}},{"2":{"Name":"KinesisStreamArn"}},{"2":{"Name":"KinesisStreamConfig","Properties":{"StreamArn":{"Type":4,"Flags":1}}}},{"2":{"Name":"KinesisVideoStreamConfig","Properties":{"EncryptionConfig":{"Type":74,"Flags":1},"Prefix":{"Type":4,"Flags":1},"RetentionPeriodHours":{"Type":3,"Flags":1}}}},{"2":{"Name":"Prefix"}},{"2":{"Name":"S3Config","Properties":{"BucketName":{"Type":4,"Flags":1},"BucketPrefix":{"Type":4,"Flags":1},"EncryptionConfig":{"Type":74,"Flags":0}}}},{"2":{"Name":"StorageType"}},{"2":{"Name":"AWS.Connect/InstanceStorageConfigProperties","Properties":{"AssociationId":{"Type":4,"Flags":18},"InstanceArn":{"Type":4,"Flags":17,"Description":"Connect Instance ID with which the storage config will be associated"},"KinesisFirehoseConfig":{"Type":80,"Flags":0},"KinesisStreamConfig":{"Type":82,"Flags":0},"KinesisVideoStreamConfig":{"Type":83,"Flags":0},"ResourceType":{"Type":4,"Flags":17},"S3Config":{"Type":85,"Flags":0},"StorageType":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.Connect/InstanceStorageConfig","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":87,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Connect/InstanceStorageConfig@default","ScopeType":0,"Body":88}},{"2":{"Name":"InstanceId"}},{"2":{"Name":"IntegrationArn"}},{"2":{"Name":"IntegrationAssociationId"}},{"2":{"Name":"IntegrationType"}},{"2":{"Name":"AWS.Connect/IntegrationAssociationProperties","Properties":{"InstanceId":{"Type":4,"Flags":17},"IntegrationArn":{"Type":4,"Flags":17},"IntegrationAssociationId":{"Type":4,"Flags":2},"IntegrationType":{"Type":4,"Flags":17}}}},{"2":{"Name":"AWS.Connect/IntegrationAssociation","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":94,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Connect/IntegrationAssociation@default","ScopeType":0,"Body":95}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}}}},{"2":{"Name":"AWS.Connect/PhoneNumberProperties","Properties":{"Address":{"Type":4,"Flags":2,"Description":"The phone number e164 address."},"CountryCode":{"Type":4,"Flags":0,"Description":"The phone number country code."},"Description":{"Type":4,"Flags":0,"Description":"The description of the phone number."},"PhoneNumberArn":{"Type":4,"Flags":18,"Description":"The phone number ARN"},"Prefix":{"Type":4,"Flags":4,"Description":"The phone number prefix."},"SourcePhoneNumberArn":{"Type":4,"Flags":0,"Description":"The source phone number arn."},"Tags":{"Type":99,"Flags":0,"Description":"One or more tags."},"TargetArn":{"Type":4,"Flags":1,"Description":"The ARN of the target the phone number is claimed to."},"Type":{"Type":4,"Flags":0,"Description":"The phone number type"}}}},{"3":{"ItemType":97}},{"2":{"Name":"AWS.Connect/PhoneNumber","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":98,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Connect/PhoneNumber@default","ScopeType":0,"Body":100}},{"2":{"Name":"StringList"}},{"2":{"Name":"Value"}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.Connect/PredefinedAttributeProperties","Properties":{"InstanceArn":{"Type":4,"Flags":17,"Description":"The identifier of the Amazon Connect instance."},"Name":{"Type":4,"Flags":17,"Description":"The name of the predefined attribute."},"Values":{"Type":107,"Flags":1,"Description":"The values of a predefined attribute."}}}},{"3":{"ItemType":4}},{"2":{"Name":"PredefinedAttribute_Values","Properties":{"StringList":{"Type":106,"Flags":0}}}},{"2":{"Name":"AWS.Connect/PredefinedAttribute","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":105,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Connect/PredefinedAttribute@default","ScopeType":0,"Body":108}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.Connect/PromptProperties","Properties":{"Description":{"Type":4,"Flags":0,"Description":"The description of the prompt."},"InstanceArn":{"Type":4,"Flags":1,"Description":"The identifier of the Amazon Connect instance."},"Name":{"Type":4,"Flags":1,"Description":"The name of the prompt."},"PromptArn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN) for the prompt."},"S3Uri":{"Type":4,"Flags":4,"Description":"S3 URI of the customer's audio file for creating prompts resource.."},"Tags":{"Type":112,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."}}}},{"3":{"ItemType":110}},{"2":{"Name":"AWS.Connect/Prompt","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":111,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Connect/Prompt@default","ScopeType":0,"Body":113}},{"2":{"Name":"Key"}},{"2":{"Name":"OutboundCallerConfig","Properties":{"OutboundCallerIdName":{"Type":4,"Flags":0},"OutboundCallerIdNumberArn":{"Type":4,"Flags":0},"OutboundFlowArn":{"Type":4,"Flags":0}}}},{"2":{"Name":"OutboundCallerIdName"}},{"2":{"Name":"OutboundCallerIdNumberArn"}},{"2":{"Name":"OutboundFlowArn"}},{"2":{"Name":"QuickConnectArn"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"Value"}},{"2":{"Name":"AWS.Connect/QueueProperties","Properties":{"Description":{"Type":4,"Flags":0,"Description":"The description of the queue."},"HoursOfOperationArn":{"Type":4,"Flags":1,"Description":"The identifier for the hours of operation."},"InstanceArn":{"Type":4,"Flags":1,"Description":"The identifier of the Amazon Connect instance."},"MaxContacts":{"Type":3,"Flags":0,"Description":"The maximum number of contacts that can be in the queue before it is considered full."},"Name":{"Type":4,"Flags":1,"Description":"The name of the queue."},"OutboundCallerConfig":{"Type":116,"Flags":0,"Description":"The outbound caller ID name, number, and outbound whisper flow."},"QueueArn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN) for the queue."},"QuickConnectArns":{"Type":124,"Flags":0,"Description":"The quick connects available to agents who are working the queue."},"Status":{"Type":4,"Flags":0,"Description":"The status of the queue."},"Tags":{"Type":125,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."},"Type":{"Type":4,"Flags":2,"Description":"The type of queue."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":121}},{"2":{"Name":"AWS.Connect/Queue","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":123,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Connect/Queue@default","ScopeType":0,"Body":126}},{"2":{"Name":"ContactFlowArn"}},{"2":{"Name":"PhoneNumber"}},{"2":{"Name":"PhoneNumberQuickConnectConfig","Properties":{"PhoneNumber":{"Type":4,"Flags":1}}}},{"2":{"Name":"QueueArn"}},{"2":{"Name":"QueueQuickConnectConfig","Properties":{"ContactFlowArn":{"Type":4,"Flags":1},"QueueArn":{"Type":4,"Flags":1}}}},{"2":{"Name":"QuickConnectConfig","Properties":{"PhoneConfig":{"Type":130,"Flags":0},"QueueConfig":{"Type":132,"Flags":0},"QuickConnectType":{"Type":4,"Flags":1},"UserConfig":{"Type":137,"Flags":0}}}},{"2":{"Name":"QuickConnectType"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is maximum of 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}}}},{"2":{"Name":"UserArn"}},{"2":{"Name":"UserQuickConnectConfig","Properties":{"ContactFlowArn":{"Type":4,"Flags":1},"UserArn":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.Connect/QuickConnectProperties","Properties":{"Description":{"Type":4,"Flags":0,"Description":"The description of the quick connect."},"InstanceArn":{"Type":4,"Flags":1,"Description":"The identifier of the Amazon Connect instance."},"Name":{"Type":4,"Flags":1,"Description":"The name of the quick connect."},"QuickConnectArn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN) for the quick connect."},"QuickConnectConfig":{"Type":133,"Flags":1,"Description":"Configuration settings for the quick connect."},"QuickConnectType":{"Type":4,"Flags":2,"Description":"The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE)."},"Tags":{"Type":139,"Flags":0,"Description":"One or more tags."}}}},{"3":{"ItemType":135}},{"2":{"Name":"AWS.Connect/QuickConnect","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":138,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Connect/QuickConnect@default","ScopeType":0,"Body":140}},{"2":{"Name":"BehaviorType"}},{"2":{"Name":"Channel"}},{"2":{"Name":"Concurrency"}},{"2":{"Name":"CrossChannelBehavior","Properties":{"BehaviorType":{"Type":4,"Flags":1}}}},{"2":{"Name":"Delay"}},{"2":{"Name":"MediaConcurrency","Properties":{"Channel":{"Type":4,"Flags":1},"Concurrency":{"Type":3,"Flags":1},"CrossChannelBehavior":{"Type":145,"Flags":0}}}},{"2":{"Name":"Priority"}},{"2":{"Name":"QueueArn"}},{"2":{"Name":"RoutingProfileQueueConfig","Properties":{"Delay":{"Type":3,"Flags":1},"Priority":{"Type":3,"Flags":1},"QueueReference":{"Type":151,"Flags":1}}}},{"2":{"Name":"RoutingProfileQueueReference","Properties":{"Channel":{"Type":4,"Flags":1},"QueueArn":{"Type":4,"Flags":1}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.Connect/RoutingProfileProperties","Properties":{"AgentAvailabilityTimer":{"Type":4,"Flags":0,"Description":"Whether agents with this routing profile will have their routing order calculated based on longest idle time or time since their last inbound contact."},"DefaultOutboundQueueArn":{"Type":4,"Flags":1,"Description":"The identifier of the default outbound queue for this routing profile."},"Description":{"Type":4,"Flags":1,"Description":"The description of the routing profile."},"InstanceArn":{"Type":4,"Flags":1,"Description":"The identifier of the Amazon Connect instance."},"MediaConcurrencies":{"Type":154,"Flags":1,"Description":"The channels agents can handle in the Contact Control Panel (CCP) for this routing profile."},"Name":{"Type":4,"Flags":1,"Description":"The name of the routing profile."},"QueueConfigs":{"Type":155,"Flags":0,"Description":"The queues to associate with this routing profile."},"RoutingProfileArn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN) of the routing profile."},"Tags":{"Type":156,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."}}}},{"3":{"ItemType":147}},{"3":{"ItemType":150}},{"3":{"ItemType":152}},{"2":{"Name":"AWS.Connect/RoutingProfile","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":153,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Connect/RoutingProfile@default","ScopeType":0,"Body":157}},{"2":{"Name":"Actions","Properties":{"AssignContactCategoryActions":{"Type":182,"Flags":0},"CreateCaseActions":{"Type":183,"Flags":0},"EndAssociatedTaskActions":{"Type":184,"Flags":0},"EventBridgeActions":{"Type":185,"Flags":0},"SendNotificationActions":{"Type":186,"Flags":0},"TaskActions":{"Type":187,"Flags":0},"UpdateCaseActions":{"Type":188,"Flags":0}}}},{"2":{"Name":"AssignContactCategoryAction","Properties":{}}},{"2":{"Name":"AssignContactCategoryActions"}},{"2":{"Name":"CreateCaseAction","Properties":{"Fields":{"Type":190,"Flags":1},"TemplateId":{"Type":4,"Flags":1,"Description":"The Id of template."}}}},{"2":{"Name":"CreateCaseActions"}},{"2":{"Name":"EndAssociatedTasksAction","Properties":{}}},{"2":{"Name":"EndAssociatedTasksActions"}},{"2":{"Name":"EventBridgeAction","Properties":{"Name":{"Type":4,"Flags":1,"Description":"The name of the event bridge action."}}}},{"2":{"Name":"EventBridgeActions"}},{"2":{"Name":"Field","Properties":{"Id":{"Type":4,"Flags":1,"Description":"The Id of the field"},"Value":{"Type":169,"Flags":1}}}},{"2":{"Name":"FieldValue","Properties":{"BooleanValue":{"Type":2,"Flags":0},"DoubleValue":{"Type":3,"Flags":0},"EmptyValue":{"Type":194,"Flags":0},"StringValue":{"Type":4,"Flags":0}}}},{"2":{"Name":"Fields"}},{"2":{"Name":"NotificationRecipientType","Properties":{"UserArns":{"Type":196,"Flags":0,"Description":"The list of recipients by user arns."},"UserTags":{"Type":197,"Flags":0,"Description":"The collection of recipients who are identified by user tags"}}}},{"2":{"Name":"Reference","Properties":{"Type":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"RuleTriggerEventSource","Properties":{"EventSourceName":{"Type":4,"Flags":1,"Description":"The name of event source."},"IntegrationAssociationArn":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) for the AppIntegration association."}}}},{"2":{"Name":"SendNotificationAction","Properties":{"Content":{"Type":4,"Flags":1,"Description":"The content of notification."},"ContentType":{"Type":4,"Flags":1,"Description":"The type of content."},"DeliveryMethod":{"Type":4,"Flags":1,"Description":"The means of delivery."},"Recipient":{"Type":171,"Flags":1},"Subject":{"Type":4,"Flags":0,"Description":"The subject of notification."}}}},{"2":{"Name":"SendNotificationActions"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that's 1 to 256 characters in length."}}}},{"2":{"Name":"TaskAction","Properties":{"ContactFlowArn":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) of the contact flow."},"Description":{"Type":4,"Flags":0,"Description":"The description which appears in the agent's Contact Control Panel (CCP)."},"Name":{"Type":4,"Flags":1,"Description":"The name which appears in the agent's Contact Control Panel (CCP)."},"References":{"Type":199,"Flags":0,"Description":"A formatted URL that is shown to an agent in the Contact Control Panel (CCP)."}}}},{"2":{"Name":"TaskActions"}},{"2":{"Name":"UpdateCaseAction","Properties":{"Fields":{"Type":201,"Flags":1}}}},{"2":{"Name":"UpdateCaseActions"}},{"2":{"Name":"UserArn"}},{"3":{"ItemType":160}},{"3":{"ItemType":162}},{"3":{"ItemType":164}},{"3":{"ItemType":166}},{"3":{"ItemType":174}},{"3":{"ItemType":177}},{"3":{"ItemType":179}},{"3":{"ItemType":160}},{"3":{"ItemType":168}},{"3":{"ItemType":162}},{"3":{"ItemType":164}},{"3":{"ItemType":166}},{"2":{"Name":"Rule_EmptyValue","Properties":{}}},{"3":{"ItemType":168}},{"3":{"ItemType":4}},{"2":{"Name":"Rule_UserTags","Properties":{}}},{"3":{"ItemType":174}},{"2":{"Name":"Rule_References","Properties":{}}},{"3":{"ItemType":177}},{"3":{"ItemType":168}},{"3":{"ItemType":179}},{"2":{"Name":"AWS.Connect/RuleProperties","Properties":{"Actions":{"Type":159,"Flags":1,"Description":"The list of actions that will be executed when a rule is triggered."},"Function":{"Type":4,"Flags":1,"Description":"The conditions of a rule."},"InstanceArn":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) of the instance."},"Name":{"Type":4,"Flags":1,"Description":"The name of the rule."},"PublishStatus":{"Type":4,"Flags":1,"Description":"The publish status of a rule, either draft or published."},"RuleArn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN) of the rule."},"Tags":{"Type":204,"Flags":0,"Description":"One or more tags."},"TriggerEventSource":{"Type":173,"Flags":1,"Description":"The event source that triggers the rule."}}}},{"3":{"ItemType":176}},{"2":{"Name":"AWS.Connect/Rule","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":203,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Connect/Rule@default","ScopeType":0,"Body":205}},{"2":{"Name":"AssociationId"}},{"2":{"Name":"InstanceId"}},{"2":{"Name":"Key"}},{"2":{"Name":"AWS.Connect/SecurityKeyProperties","Properties":{"AssociationId":{"Type":4,"Flags":18},"InstanceId":{"Type":4,"Flags":17},"Key":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.Connect/SecurityKey","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":210,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Connect/SecurityKey@default","ScopeType":0,"Body":211}},{"2":{"Name":"Permission"}},{"2":{"Name":"ResourceName"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.Connect/SecurityProfileProperties","Properties":{"AllowedAccessControlTags":{"Type":217,"Flags":0,"Description":"The list of tags that a security profile uses to restrict access to resources in Amazon Connect."},"Description":{"Type":4,"Flags":0,"Description":"The description of the security profile."},"InstanceArn":{"Type":4,"Flags":1,"Description":"The identifier of the Amazon Connect instance."},"Permissions":{"Type":218,"Flags":0,"Description":"Permissions assigned to the security profile."},"SecurityProfileArn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN) for the security profile."},"SecurityProfileName":{"Type":4,"Flags":1,"Description":"The name of the security profile."},"TagRestrictedResources":{"Type":219,"Flags":0,"Description":"The list of resources that a security profile applies tag restrictions to in Amazon Connect."},"Tags":{"Type":220,"Flags":0,"Description":"The tags used to organize, track, or control access for this resource."}}}},{"3":{"ItemType":215}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":215}},{"2":{"Name":"AWS.Connect/SecurityProfile","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":216,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Connect/SecurityProfile@default","ScopeType":0,"Body":221}},{"2":{"Name":"ClientToken"}},{"2":{"Name":"DefaultFieldValue","Properties":{"DefaultValue":{"Type":4,"Flags":1},"Id":{"Type":226,"Flags":1}}}},{"2":{"Name":"Field","Properties":{"Description":{"Type":4,"Flags":0,"Description":"The description of the task template's field"},"Id":{"Type":226,"Flags":1},"SingleSelectOptions":{"Type":238,"Flags":0,"Description":"list of field options to be used with single select"},"Type":{"Type":4,"Flags":1}}}},{"2":{"Name":"FieldIdentifier","Properties":{"Name":{"Type":4,"Flags":1,"Description":"The name of the task template field"}}}},{"2":{"Name":"FieldOption"}},{"2":{"Name":"FieldType"}},{"2":{"Name":"FieldValue"}},{"2":{"Name":"InvisibleFieldInfo","Properties":{"Id":{"Type":226,"Flags":1}}}},{"2":{"Name":"InvisibleTaskTemplateFields"}},{"2":{"Name":"ReadOnlyFieldInfo","Properties":{"Id":{"Type":226,"Flags":1}}}},{"2":{"Name":"ReadOnlyTaskTemplateFields"}},{"2":{"Name":"RequiredFieldInfo","Properties":{"Id":{"Type":226,"Flags":1}}}},{"2":{"Name":"RequiredTaskTemplateFields"}},{"2":{"Name":"Status"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. . You can specify a value that is maximum of 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":230}},{"3":{"ItemType":232}},{"3":{"ItemType":234}},{"2":{"Name":"AWS.Connect/TaskTemplateProperties","Properties":{"Arn":{"Type":4,"Flags":18,"Description":"The identifier (arn) of the task template."},"ClientToken":{"Type":4,"Flags":0},"Constraints":{"Type":246,"Flags":0,"Description":"The constraints for the task template"},"ContactFlowArn":{"Type":4,"Flags":0,"Description":"The identifier of the contact flow."},"Defaults":{"Type":247,"Flags":0,"Description":""},"Description":{"Type":4,"Flags":0,"Description":"The description of the task template."},"Fields":{"Type":248,"Flags":0,"Description":"The list of task template's fields"},"InstanceArn":{"Type":4,"Flags":1,"Description":"The identifier (arn) of the instance."},"Name":{"Type":4,"Flags":0,"Description":"The name of the task template."},"Status":{"Type":4,"Flags":0},"Tags":{"Type":249,"Flags":0,"Description":"One or more tags."}}}},{"3":{"ItemType":230}},{"3":{"ItemType":232}},{"3":{"ItemType":234}},{"2":{"Name":"TaskTemplate_Constraints","Properties":{"InvisibleFields":{"Type":243,"Flags":0},"ReadOnlyFields":{"Type":244,"Flags":0},"RequiredFields":{"Type":245,"Flags":0}}}},{"3":{"ItemType":224}},{"3":{"ItemType":225}},{"3":{"ItemType":237}},{"2":{"Name":"AWS.Connect/TaskTemplate","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":242,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Connect/TaskTemplate@default","ScopeType":0,"Body":250}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.Connect/TrafficDistributionGroupProperties","Properties":{"Description":{"Type":4,"Flags":0,"Description":"A description for the traffic distribution group."},"InstanceArn":{"Type":4,"Flags":1,"Description":"The identifier of the Amazon Connect instance that has been replicated."},"IsDefault":{"Type":2,"Flags":2,"Description":"If this is the default traffic distribution group."},"Name":{"Type":4,"Flags":1,"Description":"The name for the traffic distribution group."},"Status":{"Type":4,"Flags":2,"Description":"The status of the traffic distribution group."},"Tags":{"Type":254,"Flags":0,"Description":"One or more tags."},"TrafficDistributionGroupArn":{"Type":4,"Flags":18,"Description":"The identifier of the traffic distribution group."}}}},{"3":{"ItemType":252}},{"2":{"Name":"AWS.Connect/TrafficDistributionGroup","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":253,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Connect/TrafficDistributionGroup@default","ScopeType":0,"Body":255}},{"2":{"Name":"AfterContactWorkTimeLimit"}},{"2":{"Name":"AttributeName"}},{"2":{"Name":"AttributeValue"}},{"2":{"Name":"AutoAccept"}},{"2":{"Name":"DeskPhoneNumber"}},{"2":{"Name":"Email"}},{"2":{"Name":"FirstName"}},{"2":{"Name":"LastName"}},{"2":{"Name":"Level"}},{"2":{"Name":"Mobile"}},{"2":{"Name":"PhoneType"}},{"2":{"Name":"SecondaryEmail"}},{"2":{"Name":"SecurityProfileArn"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is maximum of 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}}}},{"2":{"Name":"UserIdentityInfo","Properties":{"Email":{"Type":4,"Flags":0},"FirstName":{"Type":4,"Flags":0},"LastName":{"Type":4,"Flags":0},"Mobile":{"Type":4,"Flags":0},"SecondaryEmail":{"Type":4,"Flags":0}}}},{"2":{"Name":"UserPhoneConfig","Properties":{"AfterContactWorkTimeLimit":{"Type":3,"Flags":0},"AutoAccept":{"Type":2,"Flags":0},"DeskPhoneNumber":{"Type":4,"Flags":0},"PhoneType":{"Type":4,"Flags":1}}}},{"2":{"Name":"UserProficiency","Properties":{"AttributeName":{"Type":4,"Flags":1},"AttributeValue":{"Type":4,"Flags":1},"Level":{"Type":3,"Flags":1}}}},{"2":{"Name":"AWS.Connect/UserProperties","Properties":{"DirectoryUserId":{"Type":4,"Flags":0,"Description":"The identifier of the user account in the directory used for identity management."},"HierarchyGroupArn":{"Type":4,"Flags":0,"Description":"The identifier of the hierarchy group for the user."},"IdentityInfo":{"Type":271,"Flags":0,"Description":"The information about the identity of the user."},"InstanceArn":{"Type":4,"Flags":1,"Description":"The identifier of the Amazon Connect instance."},"Password":{"Type":4,"Flags":4,"Description":"The password for the user account. A password is required if you are using Amazon Connect for identity management. Otherwise, it is an error to include a password."},"PhoneConfig":{"Type":272,"Flags":1,"Description":"The phone settings for the user."},"RoutingProfileArn":{"Type":4,"Flags":1,"Description":"The identifier of the routing profile for the user."},"SecurityProfileArns":{"Type":275,"Flags":1,"Description":"One or more security profile arns for the user"},"Tags":{"Type":276,"Flags":0,"Description":"One or more tags."},"UserArn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN) for the user."},"UserProficiencies":{"Type":277,"Flags":0,"Description":"One or more predefined attributes assigned to a user, with a level that indicates how skilled they are."},"Username":{"Type":4,"Flags":1,"Description":"The user name for the account."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":270}},{"3":{"ItemType":273}},{"2":{"Name":"AWS.Connect/User","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":274,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Connect/User@default","ScopeType":0,"Body":278}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is maximum of 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}}}},{"2":{"Name":"UserHierarchyGroupArn"}},{"2":{"Name":"AWS.Connect/UserHierarchyGroupProperties","Properties":{"InstanceArn":{"Type":4,"Flags":1,"Description":"The identifier of the Amazon Connect instance."},"Name":{"Type":4,"Flags":1,"Description":"The name of the user hierarchy group."},"ParentGroupArn":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) for the parent user hierarchy group."},"Tags":{"Type":283,"Flags":0,"Description":"One or more tags."},"UserHierarchyGroupArn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN) for the user hierarchy group."}}}},{"3":{"ItemType":280}},{"2":{"Name":"AWS.Connect/UserHierarchyGroup","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":282,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Connect/UserHierarchyGroup@default","ScopeType":0,"Body":284}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters"},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. . You can specify a value that is maximum of 256 Unicode characters"}}}},{"2":{"Name":"AWS.Connect/ViewProperties","Properties":{"Actions":{"Type":288,"Flags":1,"Description":"The actions of the view in an array."},"Description":{"Type":4,"Flags":0,"Description":"The description of the view."},"InstanceArn":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) of the instance."},"Name":{"Type":4,"Flags":1,"Description":"The name of the view."},"Tags":{"Type":289,"Flags":0,"Description":"One or more tags."},"Template":{"Type":290,"Flags":1,"Description":"The template of the view as JSON."},"ViewArn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN) of the view."},"ViewContentSha256":{"Type":4,"Flags":2,"Description":"The view content hash."},"ViewId":{"Type":4,"Flags":2,"Description":"The view id of the view."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":286}},{"2":{"Name":"View_Template","Properties":{}}},{"2":{"Name":"AWS.Connect/View","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":287,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Connect/View@default","ScopeType":0,"Body":291}},{"2":{"Name":"AWS.Connect/ViewVersionProperties","Properties":{"Version":{"Type":3,"Flags":2,"Description":"The version of the view."},"VersionDescription":{"Type":4,"Flags":0,"Description":"The description for the view version."},"ViewArn":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) of the view for which a version is being created."},"ViewContentSha256":{"Type":4,"Flags":0,"Description":"The view content hash to be checked."},"ViewVersionArn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN) of the created view version."}}}},{"2":{"Name":"AWS.Connect/ViewVersion","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":293,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Connect/ViewVersion@default","ScopeType":0,"Body":294}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "InstanceId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Origin", + "properties": {} + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.Connect/ApprovedOriginProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.Connect/ApprovedOriginProperties", + "properties": { + "InstanceId": { + "type": { + "$ref": "#/2" + }, + "flags": 17 + }, + "Origin": { + "type": { + "$ref": "#/2" + }, + "flags": 17 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Connect/ApprovedOrigin", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Connect/ApprovedOrigin@default", + "scopeType": 0, + "body": { + "$ref": "#/5" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The value for the tag. . You can specify a value that is maximum of 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Connect/ContactFlowProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/7" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Connect/ContactFlowProperties", + "properties": { + "ContactFlowArn": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "The identifier of the contact flow (ARN)." + }, + "Content": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The content of the contact flow in JSON format." + }, + "Description": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The description of the contact flow." + }, + "InstanceArn": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The identifier of the Amazon Connect instance (ARN)." + }, + "Name": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The name of the contact flow." + }, + "State": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The state of the contact flow." + }, + "Tags": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "One or more tags." + }, + "Type": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The type of the contact flow." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Connect/ContactFlow", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/10" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Connect/ContactFlow@default", + "scopeType": 0, + "body": { + "$ref": "#/11" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is maximum of 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Connect/ContactFlowModuleProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Connect/ContactFlowModuleProperties", + "properties": { + "ContactFlowModuleArn": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "The identifier of the contact flow module (ARN)." + }, + "Content": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The content of the contact flow module in JSON format." + }, + "Description": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The description of the contact flow module." + }, + "InstanceArn": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The identifier of the Amazon Connect instance (ARN)." + }, + "Name": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The name of the contact flow module." + }, + "State": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The state of the contact flow module." + }, + "Status": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The status of the contact flow module." + }, + "Tags": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "One or more tags." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Connect/ContactFlowModule", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/16" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Connect/ContactFlowModule@default", + "scopeType": 0, + "body": { + "$ref": "#/17" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "EvaluationFormBaseItem", + "properties": { + "Section": { + "type": { + "$ref": "#/26" + }, + "flags": 1, + "description": "A subsection or inner section of an item." + } + } + }, + { + "$type": "ObjectType", + "name": "EvaluationFormItem", + "properties": { + "Question": { + "type": { + "$ref": "#/24" + }, + "flags": 0, + "description": "The information of the question." + }, + "Section": { + "type": { + "$ref": "#/26" + }, + "flags": 0, + "description": "The information of the section." + } + } + }, + { + "$type": "ObjectType", + "name": "EvaluationFormNumericQuestionAutomation", + "properties": { + "PropertyValue": { + "type": { + "$ref": "#/31" + }, + "flags": 1, + "description": "The property value of the automation." + } + } + }, + { + "$type": "ObjectType", + "name": "EvaluationFormNumericQuestionOption", + "properties": { + "AutomaticFail": { + "type": { + "$ref": "#/38" + }, + "flags": 0, + "description": "The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0." + }, + "MaxValue": { + "type": { + "$ref": "#/39" + }, + "flags": 1, + "description": "The maximum answer value of the range option." + }, + "MinValue": { + "type": { + "$ref": "#/39" + }, + "flags": 1, + "description": "The minimum answer value of the range option." + }, + "Score": { + "type": { + "$ref": "#/39" + }, + "flags": 0, + "description": "The score assigned to answer values within the range option.\n *Minimum*: 0\n *Maximum*: 10" + } + } + }, + { + "$type": "ObjectType", + "name": "EvaluationFormNumericQuestionProperties", + "properties": { + "Automation": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "The automation properties of the numeric question." + }, + "MaxValue": { + "type": { + "$ref": "#/39" + }, + "flags": 1, + "description": "The maximum answer value." + }, + "MinValue": { + "type": { + "$ref": "#/39" + }, + "flags": 1, + "description": "The minimum answer value." + }, + "Options": { + "type": { + "$ref": "#/40" + }, + "flags": 0, + "description": "The scoring options of the numeric question." + } + } + }, + { + "$type": "ObjectType", + "name": "EvaluationFormQuestion", + "properties": { + "Instructions": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The instructions of the section.\n *Length Constraints*: Minimum length of 0. Maximum length of 1024." + }, + "NotApplicableEnabled": { + "type": { + "$ref": "#/38" + }, + "flags": 0, + "description": "The flag to enable not applicable answers to the question." + }, + "QuestionType": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The type of the question.\n *Allowed values*: ``NUMERIC`` | ``SINGLESELECT`` | ``TEXT``" + }, + "QuestionTypeProperties": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "The properties of the type of question. Text questions do not have to define question type properties." + }, + "RefId": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The identifier of the question. An identifier must be unique within the evaluation form.\n *Length Constraints*: Minimum length of 1. Maximum length of 40." + }, + "Title": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The title of the question.\n *Length Constraints*: Minimum length of 1. Maximum length of 350." + }, + "Weight": { + "type": { + "$ref": "#/39" + }, + "flags": 0, + "description": "The scoring weight of the section.\n *Minimum*: 0\n *Maximum*: 100" + } + } + }, + { + "$type": "ObjectType", + "name": "EvaluationFormQuestionTypeProperties", + "properties": { + "Numeric": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "The properties of the numeric question." + }, + "SingleSelect": { + "type": { + "$ref": "#/30" + }, + "flags": 0, + "description": "The properties of the numeric question." + } + } + }, + { + "$type": "ObjectType", + "name": "EvaluationFormSection", + "properties": { + "Instructions": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The instructions of the section." + }, + "Items": { + "type": { + "$ref": "#/41" + }, + "flags": 0, + "description": "The items of the section.\n *Minimum*: 1" + }, + "RefId": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The identifier of the section. An identifier must be unique within the evaluation form.\n *Length Constraints*: Minimum length of 1. Maximum length of 40." + }, + "Title": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The title of the section.\n *Length Constraints*: Minimum length of 1. Maximum length of 128." + }, + "Weight": { + "type": { + "$ref": "#/39" + }, + "flags": 0, + "description": "The scoring weight of the section.\n *Minimum*: 0 \n *Maximum*: 100" + } + } + }, + { + "$type": "ObjectType", + "name": "EvaluationFormSingleSelectQuestionAutomation", + "properties": { + "DefaultOptionRefId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The identifier of the default answer option, when none of the automation options match the criteria.\n *Length Constraints*: Minimum length of 1. Maximum length of 40." + }, + "Options": { + "type": { + "$ref": "#/42" + }, + "flags": 1, + "description": "The automation options of the single select question.\n *Minimum*: 1\n *Maximum*: 20" + } + } + }, + { + "$type": "ObjectType", + "name": "EvaluationFormSingleSelectQuestionAutomationOption", + "properties": { + "RuleCategory": { + "type": { + "$ref": "#/35" + }, + "flags": 1, + "description": "The automation option based on a rule category for the single select question." + } + } + }, + { + "$type": "ObjectType", + "name": "EvaluationFormSingleSelectQuestionOption", + "properties": { + "AutomaticFail": { + "type": { + "$ref": "#/38" + }, + "flags": 0, + "description": "The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0." + }, + "RefId": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The identifier of the answer option. An identifier must be unique within the question.\n *Length Constraints*: Minimum length of 1. Maximum length of 40." + }, + "Score": { + "type": { + "$ref": "#/39" + }, + "flags": 0, + "description": "The score assigned to the answer option.\n *Minimum*: 0\n *Maximum*: 10" + }, + "Text": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The title of the answer option.\n *Length Constraints*: Minimum length of 1. Maximum length of 128." + } + } + }, + { + "$type": "ObjectType", + "name": "EvaluationFormSingleSelectQuestionProperties", + "properties": { + "Automation": { + "type": { + "$ref": "#/27" + }, + "flags": 0, + "description": "The display mode of the single select question." + }, + "DisplayAs": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The display mode of the single select question.\n *Allowed values*: ``DROPDOWN`` | ``RADIO``" + }, + "Options": { + "type": { + "$ref": "#/43" + }, + "flags": 1, + "description": "The answer options of the single select question.\n *Minimum*: 2\n *Maximum*: 256" + } + } + }, + { + "$type": "ObjectType", + "name": "NumericQuestionPropertyValueAutomation", + "properties": { + "Label": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The property label of the automation." + } + } + }, + { + "$type": "ObjectType", + "name": "RefId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Score", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ScoringStrategy", + "properties": { + "Mode": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The scoring mode of the evaluation form.\n *Allowed values*: ``QUESTION_ONLY`` | ``SECTION_ONLY``" + }, + "Status": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The scoring status of the evaluation form.\n *Allowed values*: ``ENABLED`` | ``DISABLED``" + } + } + }, + { + "$type": "ObjectType", + "name": "SingleSelectQuestionRuleCategoryAutomation", + "properties": { + "Category": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The category name, as defined in Rules.\n *Minimum*: 1\n *Maximum*: 50" + }, + "Condition": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The condition to apply for the automation option. If the condition is PRESENT, then the option is applied when the contact data includes the category. Similarly, if the condition is NOT_PRESENT, then the option is applied when the contact data does not include the category.\n *Allowed values*: ``PRESENT`` | ``NOT_PRESENT`` \n *Maximum*: 50" + }, + "OptionRefId": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The identifier of the answer option. An identifier must be unique within the question.\n *Length Constraints*: Minimum length of 1. Maximum length of 40." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -" + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -" + } + } + }, + { + "$type": "ObjectType", + "name": "Weight", + "properties": {} + }, + { + "$type": "BooleanType" + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/22" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/20" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/28" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/29" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Connect/EvaluationFormProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/19" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/36" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Connect/EvaluationFormProperties", + "properties": { + "Description": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The description of the evaluation form.\n *Length Constraints*: Minimum length of 0. Maximum length of 1024." + }, + "EvaluationFormArn": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "" + }, + "InstanceArn": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The identifier of the Amazon Connect instance." + }, + "Items": { + "type": { + "$ref": "#/45" + }, + "flags": 1, + "description": "Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.\n *Minimum size*: 1\n *Maximum size*: 100" + }, + "ScoringStrategy": { + "type": { + "$ref": "#/34" + }, + "flags": 0, + "description": "A scoring strategy of the evaluation form." + }, + "Status": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The status of the evaluation form.\n *Allowed values*: ``DRAFT`` | ``ACTIVE``" + }, + "Tags": { + "type": { + "$ref": "#/46" + }, + "flags": 0, + "description": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }." + }, + "Title": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "A title of the evaluation form." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Connect/EvaluationForm", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/47" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Connect/EvaluationForm@default", + "scopeType": 0, + "body": { + "$ref": "#/48" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "HoursOfOperationConfig", + "properties": { + "Day": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The day that the hours of operation applies to." + }, + "EndTime": { + "type": { + "$ref": "#/51" + }, + "flags": 1, + "description": "The end time that your contact center closes." + }, + "StartTime": { + "type": { + "$ref": "#/51" + }, + "flags": 1, + "description": "The start time that your contact center opens." + } + } + }, + { + "$type": "ObjectType", + "name": "HoursOfOperationTimeSlice", + "properties": { + "Hours": { + "type": { + "$ref": "#/39" + }, + "flags": 1, + "description": "The hours." + }, + "Minutes": { + "type": { + "$ref": "#/39" + }, + "flags": 1, + "description": "The minutes." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is maximum of 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Connect/HoursOfOperationProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/50" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/52" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Connect/HoursOfOperationProperties", + "properties": { + "Config": { + "type": { + "$ref": "#/54" + }, + "flags": 1, + "description": "Configuration information for the hours of operation: day, start time, and end time." + }, + "Description": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The description of the hours of operation." + }, + "HoursOfOperationArn": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) for the hours of operation." + }, + "InstanceArn": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The identifier of the Amazon Connect instance." + }, + "Name": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The name of the hours of operation." + }, + "Tags": { + "type": { + "$ref": "#/55" + }, + "flags": 0, + "description": "One or more tags." + }, + "TimeZone": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The time zone of the hours of operation." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Connect/HoursOfOperation", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/56" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Connect/HoursOfOperation@default", + "scopeType": 0, + "body": { + "$ref": "#/57" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Attributes", + "properties": { + "AutoResolveBestVoices": { + "type": { + "$ref": "#/38" + }, + "flags": 0 + }, + "ContactLens": { + "type": { + "$ref": "#/38" + }, + "flags": 0 + }, + "ContactflowLogs": { + "type": { + "$ref": "#/38" + }, + "flags": 0 + }, + "EarlyMedia": { + "type": { + "$ref": "#/38" + }, + "flags": 0 + }, + "InboundCalls": { + "type": { + "$ref": "#/38" + }, + "flags": 1 + }, + "OutboundCalls": { + "type": { + "$ref": "#/38" + }, + "flags": 1 + }, + "UseCustomTTSVoices": { + "type": { + "$ref": "#/38" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AutoResolveBestVoices", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ContactLens", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ContactflowLogs", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "EarlyMedia", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "InboundCalls", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "OutboundCalls", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "ObjectType", + "name": "UseCustomTTSVoices", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.Connect/InstanceProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/66" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Connect/InstanceProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "An instanceArn is automatically generated on creation based on instanceId." + }, + "Attributes": { + "type": { + "$ref": "#/59" + }, + "flags": 1, + "description": "The attributes for the instance." + }, + "CreatedTime": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "Timestamp of instance creation logged as part of instance creation." + }, + "DirectoryId": { + "type": { + "$ref": "#/2" + }, + "flags": 4, + "description": "Existing directoryId user wants to map to the new Connect instance." + }, + "Id": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "An instanceId is automatically generated on creation and assigned as the unique identifier." + }, + "IdentityManagementType": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "Specifies the type of directory integration for new instance." + }, + "InstanceAlias": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "Alias of the new directory created as part of new instance creation." + }, + "InstanceStatus": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "Specifies the creation status of new instance." + }, + "ServiceRole": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "Service linked role created as part of instance creation." + }, + "Tags": { + "type": { + "$ref": "#/69" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Connect/Instance", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/70" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Connect/Instance@default", + "scopeType": 0, + "body": { + "$ref": "#/71" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AssociationId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "BucketName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "EncryptionConfig", + "properties": { + "EncryptionType": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "KeyId": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "EncryptionType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "FirehoseDeliveryStreamArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Hours", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "InstanceStorageResourceType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "KeyId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "KinesisFirehoseConfig", + "properties": { + "FirehoseArn": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "KinesisStreamArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "KinesisStreamConfig", + "properties": { + "StreamArn": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "KinesisVideoStreamConfig", + "properties": { + "EncryptionConfig": { + "type": { + "$ref": "#/75" + }, + "flags": 1 + }, + "Prefix": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "RetentionPeriodHours": { + "type": { + "$ref": "#/39" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Prefix", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "S3Config", + "properties": { + "BucketName": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "BucketPrefix": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "EncryptionConfig": { + "type": { + "$ref": "#/75" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "StorageType", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.Connect/InstanceStorageConfigProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.Connect/InstanceStorageConfigProperties", + "properties": { + "AssociationId": { + "type": { + "$ref": "#/2" + }, + "flags": 18 + }, + "InstanceArn": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "Connect Instance ID with which the storage config will be associated" + }, + "KinesisFirehoseConfig": { + "type": { + "$ref": "#/81" + }, + "flags": 0 + }, + "KinesisStreamConfig": { + "type": { + "$ref": "#/83" + }, + "flags": 0 + }, + "KinesisVideoStreamConfig": { + "type": { + "$ref": "#/84" + }, + "flags": 0 + }, + "ResourceType": { + "type": { + "$ref": "#/2" + }, + "flags": 17 + }, + "S3Config": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + }, + "StorageType": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Connect/InstanceStorageConfig", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/89" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Connect/InstanceStorageConfig@default", + "scopeType": 0, + "body": { + "$ref": "#/90" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "InstanceId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "IntegrationArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "IntegrationAssociationId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "IntegrationType", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.Connect/IntegrationAssociationProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.Connect/IntegrationAssociationProperties", + "properties": { + "InstanceId": { + "type": { + "$ref": "#/2" + }, + "flags": 17 + }, + "IntegrationArn": { + "type": { + "$ref": "#/2" + }, + "flags": 17 + }, + "IntegrationAssociationId": { + "type": { + "$ref": "#/2" + }, + "flags": 2 + }, + "IntegrationType": { + "type": { + "$ref": "#/2" + }, + "flags": 17 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Connect/IntegrationAssociation", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/97" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Connect/IntegrationAssociation@default", + "scopeType": 0, + "body": { + "$ref": "#/98" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Connect/PhoneNumberProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/100" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Connect/PhoneNumberProperties", + "properties": { + "Address": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The phone number e164 address." + }, + "CountryCode": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The phone number country code." + }, + "Description": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The description of the phone number." + }, + "PhoneNumberArn": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "The phone number ARN" + }, + "Prefix": { + "type": { + "$ref": "#/2" + }, + "flags": 4, + "description": "The phone number prefix." + }, + "SourcePhoneNumberArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The source phone number arn." + }, + "Tags": { + "type": { + "$ref": "#/102" + }, + "flags": 0, + "description": "One or more tags." + }, + "TargetArn": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The ARN of the target the phone number is claimed to." + }, + "Type": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The phone number type" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Connect/PhoneNumber", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/103" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Connect/PhoneNumber@default", + "scopeType": 0, + "body": { + "$ref": "#/104" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "StringList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Value", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Connect/PredefinedAttributeProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ObjectType", + "name": "PredefinedAttribute_Values", + "properties": { + "StringList": { + "type": { + "$ref": "#/110" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Connect/PredefinedAttributeProperties", + "properties": { + "InstanceArn": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "The identifier of the Amazon Connect instance." + }, + "LastModifiedRegion": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "Last modified region." + }, + "LastModifiedTime": { + "type": { + "$ref": "#/39" + }, + "flags": 2, + "description": "Last modified time." + }, + "Name": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "The name of the predefined attribute." + }, + "Values": { + "type": { + "$ref": "#/111" + }, + "flags": 1, + "description": "The values of a predefined attribute." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Connect/PredefinedAttribute", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/112" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Connect/PredefinedAttribute@default", + "scopeType": 0, + "body": { + "$ref": "#/113" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Connect/PromptProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/115" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Connect/PromptProperties", + "properties": { + "Description": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The description of the prompt." + }, + "InstanceArn": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The identifier of the Amazon Connect instance." + }, + "Name": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The name of the prompt." + }, + "PromptArn": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) for the prompt." + }, + "S3Uri": { + "type": { + "$ref": "#/2" + }, + "flags": 4, + "description": "S3 URI of the customer's audio file for creating prompts resource.." + }, + "Tags": { + "type": { + "$ref": "#/117" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Connect/Prompt", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/118" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Connect/Prompt@default", + "scopeType": 0, + "body": { + "$ref": "#/119" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Key", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "OutboundCallerConfig", + "properties": { + "OutboundCallerIdName": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "OutboundCallerIdNumberArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "OutboundFlowArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "OutboundCallerIdName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "OutboundCallerIdNumberArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "OutboundFlowArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "QuickConnectArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Value", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.Connect/QueueProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/127" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Connect/QueueProperties", + "properties": { + "Description": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The description of the queue." + }, + "HoursOfOperationArn": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The identifier for the hours of operation." + }, + "InstanceArn": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The identifier of the Amazon Connect instance." + }, + "MaxContacts": { + "type": { + "$ref": "#/39" + }, + "flags": 0, + "description": "The maximum number of contacts that can be in the queue before it is considered full." + }, + "Name": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The name of the queue." + }, + "OutboundCallerConfig": { + "type": { + "$ref": "#/122" + }, + "flags": 0, + "description": "The outbound caller ID name, number, and outbound whisper flow." + }, + "QueueArn": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) for the queue." + }, + "QuickConnectArns": { + "type": { + "$ref": "#/130" + }, + "flags": 0, + "description": "The quick connects available to agents who are working the queue." + }, + "Status": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The status of the queue." + }, + "Tags": { + "type": { + "$ref": "#/131" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + }, + "Type": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The type of queue." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Connect/Queue", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/132" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Connect/Queue@default", + "scopeType": 0, + "body": { + "$ref": "#/133" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "ContactFlowArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PhoneNumber", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PhoneNumberQuickConnectConfig", + "properties": { + "PhoneNumber": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "QueueArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "QueueQuickConnectConfig", + "properties": { + "ContactFlowArn": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "QueueArn": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "QuickConnectConfig", + "properties": { + "PhoneConfig": { + "type": { + "$ref": "#/137" + }, + "flags": 0 + }, + "QueueConfig": { + "type": { + "$ref": "#/139" + }, + "flags": 0 + }, + "QuickConnectType": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "UserConfig": { + "type": { + "$ref": "#/144" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "QuickConnectType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is maximum of 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + } + } + }, + { + "$type": "ObjectType", + "name": "UserArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "UserQuickConnectConfig", + "properties": { + "ContactFlowArn": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "UserArn": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Connect/QuickConnectProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/142" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Connect/QuickConnectProperties", + "properties": { + "Description": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The description of the quick connect." + }, + "InstanceArn": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The identifier of the Amazon Connect instance." + }, + "Name": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The name of the quick connect." + }, + "QuickConnectArn": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) for the quick connect." + }, + "QuickConnectConfig": { + "type": { + "$ref": "#/140" + }, + "flags": 1, + "description": "Configuration settings for the quick connect." + }, + "QuickConnectType": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE)." + }, + "Tags": { + "type": { + "$ref": "#/146" + }, + "flags": 0, + "description": "One or more tags." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Connect/QuickConnect", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/147" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Connect/QuickConnect@default", + "scopeType": 0, + "body": { + "$ref": "#/148" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "BehaviorType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Channel", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Concurrency", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CrossChannelBehavior", + "properties": { + "BehaviorType": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Delay", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MediaConcurrency", + "properties": { + "Channel": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Concurrency": { + "type": { + "$ref": "#/39" + }, + "flags": 1 + }, + "CrossChannelBehavior": { + "type": { + "$ref": "#/153" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Priority", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "QueueArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RoutingProfileQueueConfig", + "properties": { + "Delay": { + "type": { + "$ref": "#/39" + }, + "flags": 1 + }, + "Priority": { + "type": { + "$ref": "#/39" + }, + "flags": 1 + }, + "QueueReference": { + "type": { + "$ref": "#/159" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "RoutingProfileQueueReference", + "properties": { + "Channel": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "QueueArn": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Connect/RoutingProfileProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/155" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/158" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/160" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Connect/RoutingProfileProperties", + "properties": { + "AgentAvailabilityTimer": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "Whether agents with this routing profile will have their routing order calculated based on longest idle time or time since their last inbound contact." + }, + "DefaultOutboundQueueArn": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The identifier of the default outbound queue for this routing profile." + }, + "Description": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The description of the routing profile." + }, + "InstanceArn": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The identifier of the Amazon Connect instance." + }, + "MediaConcurrencies": { + "type": { + "$ref": "#/162" + }, + "flags": 1, + "description": "The channels agents can handle in the Contact Control Panel (CCP) for this routing profile." + }, + "Name": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The name of the routing profile." + }, + "QueueConfigs": { + "type": { + "$ref": "#/163" + }, + "flags": 0, + "description": "The queues to associate with this routing profile." + }, + "RoutingProfileArn": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) of the routing profile." + }, + "Tags": { + "type": { + "$ref": "#/164" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Connect/RoutingProfile", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/165" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Connect/RoutingProfile@default", + "scopeType": 0, + "body": { + "$ref": "#/166" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Actions", + "properties": { + "AssignContactCategoryActions": { + "type": { + "$ref": "#/193" + }, + "flags": 0 + }, + "CreateCaseActions": { + "type": { + "$ref": "#/194" + }, + "flags": 0 + }, + "EndAssociatedTasksActions": { + "type": { + "$ref": "#/195" + }, + "flags": 0 + }, + "EventBridgeActions": { + "type": { + "$ref": "#/196" + }, + "flags": 0 + }, + "SendNotificationActions": { + "type": { + "$ref": "#/197" + }, + "flags": 0 + }, + "SubmitAutoEvaluationActions": { + "type": { + "$ref": "#/198" + }, + "flags": 0 + }, + "TaskActions": { + "type": { + "$ref": "#/199" + }, + "flags": 0 + }, + "UpdateCaseActions": { + "type": { + "$ref": "#/200" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AssignContactCategoryAction", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AssignContactCategoryActions", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CreateCaseAction", + "properties": { + "Fields": { + "type": { + "$ref": "#/202" + }, + "flags": 1 + }, + "TemplateId": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The Id of template." + } + } + }, + { + "$type": "ObjectType", + "name": "CreateCaseActions", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "EndAssociatedTasksAction", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "EndAssociatedTasksActions", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "EventBridgeAction", + "properties": { + "Name": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The name of the event bridge action." + } + } + }, + { + "$type": "ObjectType", + "name": "EventBridgeActions", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Field", + "properties": { + "Id": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The Id of the field" + }, + "Value": { + "type": { + "$ref": "#/178" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "FieldValue", + "properties": { + "BooleanValue": { + "type": { + "$ref": "#/38" + }, + "flags": 0 + }, + "DoubleValue": { + "type": { + "$ref": "#/39" + }, + "flags": 0 + }, + "EmptyValue": { + "type": { + "$ref": "#/206" + }, + "flags": 0 + }, + "StringValue": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Fields", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "NotificationRecipientType", + "properties": { + "UserArns": { + "type": { + "$ref": "#/208" + }, + "flags": 0, + "description": "The list of recipients by user arns." + }, + "UserTags": { + "type": { + "$ref": "#/209" + }, + "flags": 0, + "description": "The collection of recipients who are identified by user tags" + } + } + }, + { + "$type": "ObjectType", + "name": "Reference", + "properties": { + "Type": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "RuleTriggerEventSource", + "properties": { + "EventSourceName": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The name of event source." + }, + "IntegrationAssociationArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) for the AppIntegration association." + } + } + }, + { + "$type": "ObjectType", + "name": "SendNotificationAction", + "properties": { + "Content": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The content of notification." + }, + "ContentType": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The type of content." + }, + "DeliveryMethod": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The means of delivery." + }, + "Recipient": { + "type": { + "$ref": "#/180" + }, + "flags": 1 + }, + "Subject": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The subject of notification." + } + } + }, + { + "$type": "ObjectType", + "name": "SendNotificationActions", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SubmitAutoEvaluationAction", + "properties": { + "EvaluationFormArn": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of the evaluation form." + } + } + }, + { + "$type": "ObjectType", + "name": "SubmitAutoEvaluationActions", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that's 1 to 256 characters in length." + } + } + }, + { + "$type": "ObjectType", + "name": "TaskAction", + "properties": { + "ContactFlowArn": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of the contact flow." + }, + "Description": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The description which appears in the agent's Contact Control Panel (CCP)." + }, + "Name": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The name which appears in the agent's Contact Control Panel (CCP)." + }, + "References": { + "type": { + "$ref": "#/212" + }, + "flags": 0, + "description": "A formatted URL that is shown to an agent in the Contact Control Panel (CCP)." + } + } + }, + { + "$type": "ObjectType", + "name": "TaskActions", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "UpdateCaseAction", + "properties": { + "Fields": { + "type": { + "$ref": "#/214" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "UpdateCaseActions", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "UserArn", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/169" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/171" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/173" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/175" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/183" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/185" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/188" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/190" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/169" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/177" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/171" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/173" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/175" + } + }, + { + "$type": "ObjectType", + "name": "Rule_EmptyValue", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/177" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ObjectType", + "name": "Rule_UserTags", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/183" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/185" + } + }, + { + "$type": "ObjectType", + "name": "Rule_References", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/188" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/177" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/190" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Connect/RuleProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/187" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Connect/RuleProperties", + "properties": { + "Actions": { + "type": { + "$ref": "#/168" + }, + "flags": 1, + "description": "The list of actions that will be executed when a rule is triggered." + }, + "Function": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The conditions of a rule." + }, + "InstanceArn": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of the instance." + }, + "Name": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The name of the rule." + }, + "PublishStatus": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The publish status of a rule, either draft or published." + }, + "RuleArn": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) of the rule." + }, + "Tags": { + "type": { + "$ref": "#/217" + }, + "flags": 0, + "description": "One or more tags." + }, + "TriggerEventSource": { + "type": { + "$ref": "#/182" + }, + "flags": 1, + "description": "The event source that triggers the rule." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Connect/Rule", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/218" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Connect/Rule@default", + "scopeType": 0, + "body": { + "$ref": "#/219" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AssociationId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "InstanceId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Key", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.Connect/SecurityKeyProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.Connect/SecurityKeyProperties", + "properties": { + "AssociationId": { + "type": { + "$ref": "#/2" + }, + "flags": 18 + }, + "InstanceId": { + "type": { + "$ref": "#/2" + }, + "flags": 17 + }, + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Connect/SecurityKey", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/225" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Connect/SecurityKey@default", + "scopeType": 0, + "body": { + "$ref": "#/226" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Application", + "properties": { + "ApplicationPermissions": { + "type": { + "$ref": "#/233" + }, + "flags": 1, + "description": "The permissions that the agent is granted on the application" + }, + "Namespace": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "Namespace of the application that you want to give access to." + } + } + }, + { + "$type": "ObjectType", + "name": "ApplicationPermission", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Permission", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ResourceName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Connect/SecurityProfileProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/232" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/228" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/232" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Connect/SecurityProfileProperties", + "properties": { + "AllowedAccessControlHierarchyGroupId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The identifier of the hierarchy group that a security profile uses to restrict access to resources in Amazon Connect." + }, + "AllowedAccessControlTags": { + "type": { + "$ref": "#/235" + }, + "flags": 0, + "description": "The list of tags that a security profile uses to restrict access to resources in Amazon Connect." + }, + "Applications": { + "type": { + "$ref": "#/236" + }, + "flags": 0, + "description": "A list of third-party applications that the security profile will give access to." + }, + "Description": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The description of the security profile." + }, + "HierarchyRestrictedResources": { + "type": { + "$ref": "#/237" + }, + "flags": 0, + "description": "The list of resources that a security profile applies hierarchy restrictions to in Amazon Connect." + }, + "InstanceArn": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The identifier of the Amazon Connect instance." + }, + "LastModifiedRegion": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The AWS Region where this resource was last modified." + }, + "LastModifiedTime": { + "type": { + "$ref": "#/39" + }, + "flags": 2, + "description": "The timestamp when this resource was last modified." + }, + "Permissions": { + "type": { + "$ref": "#/238" + }, + "flags": 0, + "description": "Permissions assigned to the security profile." + }, + "SecurityProfileArn": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) for the security profile." + }, + "SecurityProfileName": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The name of the security profile." + }, + "TagRestrictedResources": { + "type": { + "$ref": "#/239" + }, + "flags": 0, + "description": "The list of resources that a security profile applies tag restrictions to in Amazon Connect." + }, + "Tags": { + "type": { + "$ref": "#/240" + }, + "flags": 0, + "description": "The tags used to organize, track, or control access for this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Connect/SecurityProfile", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/241" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Connect/SecurityProfile@default", + "scopeType": 0, + "body": { + "$ref": "#/242" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "ClientToken", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DefaultFieldValue", + "properties": { + "DefaultValue": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Id": { + "type": { + "$ref": "#/247" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Field", + "properties": { + "Description": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The description of the task template's field" + }, + "Id": { + "type": { + "$ref": "#/247" + }, + "flags": 1 + }, + "SingleSelectOptions": { + "type": { + "$ref": "#/259" + }, + "flags": 0, + "description": "list of field options to be used with single select" + }, + "Type": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "FieldIdentifier", + "properties": { + "Name": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The name of the task template field" + } + } + }, + { + "$type": "ObjectType", + "name": "FieldOption", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "FieldType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "FieldValue", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "InvisibleFieldInfo", + "properties": { + "Id": { + "type": { + "$ref": "#/247" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "InvisibleTaskTemplateFields", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ReadOnlyFieldInfo", + "properties": { + "Id": { + "type": { + "$ref": "#/247" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ReadOnlyTaskTemplateFields", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RequiredFieldInfo", + "properties": { + "Id": { + "type": { + "$ref": "#/247" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "RequiredTaskTemplateFields", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Status", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The value for the tag. . You can specify a value that is maximum of 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/251" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/253" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/255" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Connect/TaskTemplateProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/251" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/253" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/255" + } + }, + { + "$type": "ObjectType", + "name": "TaskTemplate_Constraints", + "properties": { + "InvisibleFields": { + "type": { + "$ref": "#/264" + }, + "flags": 0 + }, + "ReadOnlyFields": { + "type": { + "$ref": "#/265" + }, + "flags": 0 + }, + "RequiredFields": { + "type": { + "$ref": "#/266" + }, + "flags": 0 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/245" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/246" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/258" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Connect/TaskTemplateProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "The identifier (arn) of the task template." + }, + "ClientToken": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Constraints": { + "type": { + "$ref": "#/267" + }, + "flags": 0, + "description": "The constraints for the task template" + }, + "ContactFlowArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The identifier of the contact flow." + }, + "Defaults": { + "type": { + "$ref": "#/268" + }, + "flags": 0, + "description": "" + }, + "Description": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The description of the task template." + }, + "Fields": { + "type": { + "$ref": "#/269" + }, + "flags": 0, + "description": "The list of task template's fields" + }, + "InstanceArn": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The identifier (arn) of the instance." + }, + "Name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The name of the task template." + }, + "Status": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/270" + }, + "flags": 0, + "description": "One or more tags." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Connect/TaskTemplate", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/271" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Connect/TaskTemplate@default", + "scopeType": 0, + "body": { + "$ref": "#/272" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Connect/TrafficDistributionGroupProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/274" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Connect/TrafficDistributionGroupProperties", + "properties": { + "Description": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "A description for the traffic distribution group." + }, + "InstanceArn": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The identifier of the Amazon Connect instance that has been replicated." + }, + "IsDefault": { + "type": { + "$ref": "#/38" + }, + "flags": 2, + "description": "If this is the default traffic distribution group." + }, + "Name": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The name for the traffic distribution group." + }, + "Status": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The status of the traffic distribution group." + }, + "Tags": { + "type": { + "$ref": "#/276" + }, + "flags": 0, + "description": "One or more tags." + }, + "TrafficDistributionGroupArn": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "The identifier of the traffic distribution group." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Connect/TrafficDistributionGroup", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/277" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Connect/TrafficDistributionGroup@default", + "scopeType": 0, + "body": { + "$ref": "#/278" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AfterContactWorkTimeLimit", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AttributeName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AttributeValue", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AutoAccept", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DeskPhoneNumber", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Email", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "FirstName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LastName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Level", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Mobile", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PhoneType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SecondaryEmail", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SecurityProfileArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is maximum of 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + } + } + }, + { + "$type": "ObjectType", + "name": "UserIdentityInfo", + "properties": { + "Email": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "FirstName": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "LastName": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Mobile": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "SecondaryEmail": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "UserPhoneConfig", + "properties": { + "AfterContactWorkTimeLimit": { + "type": { + "$ref": "#/39" + }, + "flags": 0 + }, + "AutoAccept": { + "type": { + "$ref": "#/38" + }, + "flags": 0 + }, + "DeskPhoneNumber": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "PhoneType": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "UserProficiency", + "properties": { + "AttributeName": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "AttributeValue": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Level": { + "type": { + "$ref": "#/39" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Connect/UserProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/293" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/296" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Connect/UserProperties", + "properties": { + "DirectoryUserId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The identifier of the user account in the directory used for identity management." + }, + "HierarchyGroupArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The identifier of the hierarchy group for the user." + }, + "IdentityInfo": { + "type": { + "$ref": "#/294" + }, + "flags": 0, + "description": "The information about the identity of the user." + }, + "InstanceArn": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The identifier of the Amazon Connect instance." + }, + "Password": { + "type": { + "$ref": "#/2" + }, + "flags": 4, + "description": "The password for the user account. A password is required if you are using Amazon Connect for identity management. Otherwise, it is an error to include a password." + }, + "PhoneConfig": { + "type": { + "$ref": "#/295" + }, + "flags": 1, + "description": "The phone settings for the user." + }, + "RoutingProfileArn": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The identifier of the routing profile for the user." + }, + "SecurityProfileArns": { + "type": { + "$ref": "#/298" + }, + "flags": 1, + "description": "One or more security profile arns for the user" + }, + "Tags": { + "type": { + "$ref": "#/299" + }, + "flags": 0, + "description": "One or more tags." + }, + "UserArn": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) for the user." + }, + "UserProficiencies": { + "type": { + "$ref": "#/300" + }, + "flags": 0, + "description": "One or more predefined attributes assigned to a user, with a level that indicates how skilled they are." + }, + "Username": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The user name for the account." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Connect/User", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/301" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Connect/User@default", + "scopeType": 0, + "body": { + "$ref": "#/302" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is maximum of 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + } + } + }, + { + "$type": "ObjectType", + "name": "UserHierarchyGroupArn", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.Connect/UserHierarchyGroupProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/304" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Connect/UserHierarchyGroupProperties", + "properties": { + "InstanceArn": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The identifier of the Amazon Connect instance." + }, + "Name": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The name of the user hierarchy group." + }, + "ParentGroupArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) for the parent user hierarchy group." + }, + "Tags": { + "type": { + "$ref": "#/307" + }, + "flags": 0, + "description": "One or more tags." + }, + "UserHierarchyGroupArn": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) for the user hierarchy group." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Connect/UserHierarchyGroup", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/308" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Connect/UserHierarchyGroup@default", + "scopeType": 0, + "body": { + "$ref": "#/309" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters" + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The value for the tag. . You can specify a value that is maximum of 256 Unicode characters" + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Connect/ViewProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/311" + } + }, + { + "$type": "ObjectType", + "name": "View_Template", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AWS.Connect/ViewProperties", + "properties": { + "Actions": { + "type": { + "$ref": "#/313" + }, + "flags": 1, + "description": "The actions of the view in an array." + }, + "Description": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The description of the view." + }, + "InstanceArn": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of the instance." + }, + "Name": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The name of the view." + }, + "Tags": { + "type": { + "$ref": "#/314" + }, + "flags": 0, + "description": "One or more tags." + }, + "Template": { + "type": { + "$ref": "#/315" + }, + "flags": 1, + "description": "The template of the view as JSON." + }, + "ViewArn": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) of the view." + }, + "ViewContentSha256": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The view content hash." + }, + "ViewId": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The view id of the view." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Connect/View", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/316" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Connect/View@default", + "scopeType": 0, + "body": { + "$ref": "#/317" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.Connect/ViewVersionProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.Connect/ViewVersionProperties", + "properties": { + "Version": { + "type": { + "$ref": "#/39" + }, + "flags": 2, + "description": "The version of the view." + }, + "VersionDescription": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The description for the view version." + }, + "ViewArn": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of the view for which a version is being created." + }, + "ViewContentSha256": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The view content hash to be checked." + }, + "ViewVersionArn": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) of the created view version." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Connect/ViewVersion", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/320" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Connect/ViewVersion@default", + "scopeType": 0, + "body": { + "$ref": "#/321" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.connect/default/types.md b/artifacts/bicep/aws/aws.connect/default/types.md index 00b13b3d..7d6896b8 100644 --- a/artifacts/bicep/aws/aws.connect/default/types.md +++ b/artifacts/bicep/aws/aws.connect/default/types.md @@ -3,184 +3,197 @@ ## Resource AWS.Connect/ApprovedOrigin@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Connect/ApprovedOriginProperties](#awsconnectapprovedoriginproperties) (Required): properties of the resource +* **properties**: [AWS.Connect/ApprovedOriginProperties](#awsconnectapprovedoriginproperties) (Required, Identifier): properties of the resource ## Resource AWS.Connect/ContactFlow@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Connect/ContactFlowProperties](#awsconnectcontactflowproperties) (Required): properties of the resource +* **properties**: [AWS.Connect/ContactFlowProperties](#awsconnectcontactflowproperties) (Required, Identifier): properties of the resource ## Resource AWS.Connect/ContactFlowModule@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Connect/ContactFlowModuleProperties](#awsconnectcontactflowmoduleproperties) (Required): properties of the resource +* **properties**: [AWS.Connect/ContactFlowModuleProperties](#awsconnectcontactflowmoduleproperties) (Required, Identifier): properties of the resource ## Resource AWS.Connect/EvaluationForm@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Connect/EvaluationFormProperties](#awsconnectevaluationformproperties) (Required): properties of the resource +* **properties**: [AWS.Connect/EvaluationFormProperties](#awsconnectevaluationformproperties) (Required, Identifier): properties of the resource ## Resource AWS.Connect/HoursOfOperation@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Connect/HoursOfOperationProperties](#awsconnecthoursofoperationproperties) (Required): properties of the resource +* **properties**: [AWS.Connect/HoursOfOperationProperties](#awsconnecthoursofoperationproperties) (Required, Identifier): properties of the resource ## Resource AWS.Connect/Instance@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Connect/InstanceProperties](#awsconnectinstanceproperties) (Required): properties of the resource +* **properties**: [AWS.Connect/InstanceProperties](#awsconnectinstanceproperties) (Required, Identifier): properties of the resource ## Resource AWS.Connect/InstanceStorageConfig@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Connect/InstanceStorageConfigProperties](#awsconnectinstancestorageconfigproperties) (Required): properties of the resource +* **properties**: [AWS.Connect/InstanceStorageConfigProperties](#awsconnectinstancestorageconfigproperties) (Required, Identifier): properties of the resource ## Resource AWS.Connect/IntegrationAssociation@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Connect/IntegrationAssociationProperties](#awsconnectintegrationassociationproperties) (Required): properties of the resource +* **properties**: [AWS.Connect/IntegrationAssociationProperties](#awsconnectintegrationassociationproperties) (Required, Identifier): properties of the resource ## Resource AWS.Connect/PhoneNumber@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Connect/PhoneNumberProperties](#awsconnectphonenumberproperties) (Required): properties of the resource +* **properties**: [AWS.Connect/PhoneNumberProperties](#awsconnectphonenumberproperties) (Required, Identifier): properties of the resource ## Resource AWS.Connect/PredefinedAttribute@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Connect/PredefinedAttributeProperties](#awsconnectpredefinedattributeproperties) (Required): properties of the resource +* **properties**: [AWS.Connect/PredefinedAttributeProperties](#awsconnectpredefinedattributeproperties) (Required, Identifier): properties of the resource ## Resource AWS.Connect/Prompt@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Connect/PromptProperties](#awsconnectpromptproperties) (Required): properties of the resource +* **properties**: [AWS.Connect/PromptProperties](#awsconnectpromptproperties) (Required, Identifier): properties of the resource ## Resource AWS.Connect/Queue@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Connect/QueueProperties](#awsconnectqueueproperties) (Required): properties of the resource +* **properties**: [AWS.Connect/QueueProperties](#awsconnectqueueproperties) (Required, Identifier): properties of the resource ## Resource AWS.Connect/QuickConnect@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Connect/QuickConnectProperties](#awsconnectquickconnectproperties) (Required): properties of the resource +* **properties**: [AWS.Connect/QuickConnectProperties](#awsconnectquickconnectproperties) (Required, Identifier): properties of the resource ## Resource AWS.Connect/RoutingProfile@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Connect/RoutingProfileProperties](#awsconnectroutingprofileproperties) (Required): properties of the resource +* **properties**: [AWS.Connect/RoutingProfileProperties](#awsconnectroutingprofileproperties) (Required, Identifier): properties of the resource ## Resource AWS.Connect/Rule@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Connect/RuleProperties](#awsconnectruleproperties) (Required): properties of the resource +* **properties**: [AWS.Connect/RuleProperties](#awsconnectruleproperties) (Required, Identifier): properties of the resource ## Resource AWS.Connect/SecurityKey@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Connect/SecurityKeyProperties](#awsconnectsecuritykeyproperties) (Required): properties of the resource +* **properties**: [AWS.Connect/SecurityKeyProperties](#awsconnectsecuritykeyproperties) (Required, Identifier): properties of the resource ## Resource AWS.Connect/SecurityProfile@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Connect/SecurityProfileProperties](#awsconnectsecurityprofileproperties) (Required): properties of the resource +* **properties**: [AWS.Connect/SecurityProfileProperties](#awsconnectsecurityprofileproperties) (Required, Identifier): properties of the resource ## Resource AWS.Connect/TaskTemplate@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Connect/TaskTemplateProperties](#awsconnecttasktemplateproperties) (Required): properties of the resource +* **properties**: [AWS.Connect/TaskTemplateProperties](#awsconnecttasktemplateproperties) (Required, Identifier): properties of the resource ## Resource AWS.Connect/TrafficDistributionGroup@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Connect/TrafficDistributionGroupProperties](#awsconnecttrafficdistributiongroupproperties) (Required): properties of the resource +* **properties**: [AWS.Connect/TrafficDistributionGroupProperties](#awsconnecttrafficdistributiongroupproperties) (Required, Identifier): properties of the resource ## Resource AWS.Connect/User@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Connect/UserProperties](#awsconnectuserproperties) (Required): properties of the resource +* **properties**: [AWS.Connect/UserProperties](#awsconnectuserproperties) (Required, Identifier): properties of the resource ## Resource AWS.Connect/UserHierarchyGroup@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Connect/UserHierarchyGroupProperties](#awsconnectuserhierarchygroupproperties) (Required): properties of the resource +* **properties**: [AWS.Connect/UserHierarchyGroupProperties](#awsconnectuserhierarchygroupproperties) (Required, Identifier): properties of the resource ## Resource AWS.Connect/View@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Connect/ViewProperties](#awsconnectviewproperties) (Required): properties of the resource +* **properties**: [AWS.Connect/ViewProperties](#awsconnectviewproperties) (Required, Identifier): properties of the resource ## Resource AWS.Connect/ViewVersion@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Connect/ViewVersionProperties](#awsconnectviewversionproperties) (Required): properties of the resource +* **properties**: [AWS.Connect/ViewVersionProperties](#awsconnectviewversionproperties) (Required, Identifier): properties of the resource -## AWS.Connect/ApprovedOriginProperties +## Actions ### Properties -* **InstanceId**: string (Required, Identifier) -* **Origin**: string (Required, Identifier) +* **AssignContactCategoryActions**: [AssignContactCategoryAction](#assigncontactcategoryaction)[] +* **CreateCaseActions**: [CreateCaseAction](#createcaseaction)[] +* **EndAssociatedTasksActions**: [EndAssociatedTasksAction](#endassociatedtasksaction)[] +* **EventBridgeActions**: [EventBridgeAction](#eventbridgeaction)[] +* **SendNotificationActions**: [SendNotificationAction](#sendnotificationaction)[] +* **SubmitAutoEvaluationActions**: [SubmitAutoEvaluationAction](#submitautoevaluationaction)[] +* **TaskActions**: [TaskAction](#taskaction)[] +* **UpdateCaseActions**: [UpdateCaseAction](#updatecaseaction)[] -## AWS.Connect/ContactFlowProperties +## Application ### Properties -* **ContactFlowArn**: string (ReadOnly, Identifier): The identifier of the contact flow (ARN). -* **Content**: string (Required): The content of the contact flow in JSON format. -* **Description**: string: The description of the contact flow. -* **InstanceArn**: string (Required): The identifier of the Amazon Connect instance (ARN). -* **Name**: string (Required): The name of the contact flow. -* **State**: string: The state of the contact flow. -* **Tags**: [Tag](#tag)[]: One or more tags. -* **Type**: string (Required): The type of the contact flow. +* **ApplicationPermissions**: string[] (Required): The permissions that the agent is granted on the application +* **Namespace**: string (Required): Namespace of the application that you want to give access to. -## Tag +## AssignContactCategoryAction ### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. . You can specify a value that is maximum of 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## Attributes +### Properties +* **AutoResolveBestVoices**: bool +* **ContactflowLogs**: bool +* **ContactLens**: bool +* **EarlyMedia**: bool +* **InboundCalls**: bool (Required) +* **OutboundCalls**: bool (Required) +* **UseCustomTTSVoices**: bool + +## AWS.Connect/ApprovedOriginProperties +### Properties +* **InstanceId**: string (Required, Identifier) +* **Origin**: string (Required, Identifier) ## AWS.Connect/ContactFlowModuleProperties ### Properties @@ -193,113 +206,31 @@ * **Status**: string (ReadOnly): The status of the contact flow module. * **Tags**: [Tag](#tag)[]: One or more tags. -## Tag +## AWS.Connect/ContactFlowProperties ### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is maximum of 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **ContactFlowArn**: string (ReadOnly, Identifier): The identifier of the contact flow (ARN). +* **Content**: string (Required): The content of the contact flow in JSON format. +* **Description**: string: The description of the contact flow. +* **InstanceArn**: string (Required): The identifier of the Amazon Connect instance (ARN). +* **Name**: string (Required): The name of the contact flow. +* **State**: string: The state of the contact flow. +* **Tags**: [Tag](#tag)[]: One or more tags. +* **Type**: string (Required): The type of the contact flow. ## AWS.Connect/EvaluationFormProperties ### Properties * **Description**: string: The description of the evaluation form. -* **EvaluationFormArn**: string (ReadOnly, Identifier): The Amazon Resource Name (ARN) for the evaluation form. -* **InstanceArn**: string (Required): The Amazon Resource Name (ARN) of the instance. -* **Items**: [EvaluationFormBaseItem](#evaluationformbaseitem)[] (Required): The list of evaluation form items. -* **ScoringStrategy**: [ScoringStrategy](#scoringstrategy): The scoring strategy. + *Length Constraints*: Minimum length of 0. Maximum length of 1024. +* **EvaluationFormArn**: string (ReadOnly, Identifier) +* **InstanceArn**: string (Required): The identifier of the Amazon Connect instance. +* **Items**: [EvaluationFormBaseItem](#evaluationformbaseitem)[] (Required): Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section. + *Minimum size*: 1 + *Maximum size*: 100 +* **ScoringStrategy**: [ScoringStrategy](#scoringstrategy): A scoring strategy of the evaluation form. * **Status**: string (Required): The status of the evaluation form. -* **Tags**: [Tag](#tag)[]: One or more tags. -* **Title**: string (Required): The title of the evaluation form. - -## EvaluationFormBaseItem -### Properties -* **Section**: [EvaluationFormSection](#evaluationformsection) (Required): The evaluation form section item - -## EvaluationFormSection -### Properties -* **Instructions**: string: The instructions for the section. -* **Items**: [EvaluationFormItem](#evaluationformitem)[]: The list of section items. -* **RefId**: string (Required): The identifier to reference the section. -* **Title**: string (Required): The title of the section. -* **Weight**: int: The item weight used for scoring. - -## EvaluationFormItem -### Properties -* **Question**: [EvaluationFormQuestion](#evaluationformquestion): The evaluation form question item -* **Section**: [EvaluationFormSection](#evaluationformsection): The evaluation form section item - -## EvaluationFormQuestion -### Properties -* **Instructions**: string: The instructions for the question. -* **NotApplicableEnabled**: bool: The flag to enable not applicable answers to the question. -* **QuestionType**: string (Required): The type of the question. -* **QuestionTypeProperties**: [EvaluationFormQuestionTypeProperties](#evaluationformquestiontypeproperties): The properties of the question -* **RefId**: string (Required): The identifier used to reference the question. -* **Title**: string (Required): The title of the question. -* **Weight**: int: The question weight used for scoring. - -## EvaluationFormQuestionTypeProperties -### Properties -* **Numeric**: [EvaluationFormNumericQuestionProperties](#evaluationformnumericquestionproperties): The properties of the numeric question. -* **SingleSelect**: [EvaluationFormSingleSelectQuestionProperties](#evaluationformsingleselectquestionproperties): The properties of the single-select question. - -## EvaluationFormNumericQuestionProperties -### Properties -* **Automation**: [EvaluationFormNumericQuestionAutomation](#evaluationformnumericquestionautomation): The automation properties for the numeric question. -* **MaxValue**: int (Required): The maximum value for answers of the question. -* **MinValue**: int (Required): The minimum value for answers of the question. -* **Options**: [EvaluationFormNumericQuestionOption](#evaluationformnumericquestionoption)[]: The list of option ranges used for scoring. - -## EvaluationFormNumericQuestionAutomation -### Properties -* **PropertyValue**: [NumericQuestionPropertyValueAutomation](#numericquestionpropertyvalueautomation) (Required): The automation property name of the question. - -## NumericQuestionPropertyValueAutomation -### Properties -* **Label**: string (Required): The automation property label. - -## EvaluationFormNumericQuestionOption -### Properties -* **AutomaticFail**: bool: The flag to mark the option as automatic fail. -* **MaxValue**: int (Required): The maximum value of the option range. -* **MinValue**: int (Required): The minimum value of the option range. -* **Score**: int: The score of the option range. - -## EvaluationFormSingleSelectQuestionProperties -### Properties -* **Automation**: [EvaluationFormSingleSelectQuestionAutomation](#evaluationformsingleselectquestionautomation): The automation properties for the single-select question. -* **DisplayAs**: string: The display mode of the single-select question. -* **Options**: [EvaluationFormSingleSelectQuestionOption](#evaluationformsingleselectquestionoption)[] (Required): The list of options for the question. - -## EvaluationFormSingleSelectQuestionAutomation -### Properties -* **DefaultOptionRefId**: string: The option reference identifier of the default answer. -* **Options**: [EvaluationFormSingleSelectQuestionAutomationOption](#evaluationformsingleselectquestionautomationoption)[] (Required): The answer options for the automation. - -## EvaluationFormSingleSelectQuestionAutomationOption -### Properties -* **RuleCategory**: [SingleSelectQuestionRuleCategoryAutomation](#singleselectquestionrulecategoryautomation) (Required): The automation option based on Rules categories. - -## SingleSelectQuestionRuleCategoryAutomation -### Properties -* **Category**: string (Required): The category name as defined in Rules. -* **Condition**: string (Required): The automation condition applied on contact categories. -* **OptionRefId**: string (Required): The option identifier referencing the option to be selected when the automation option is triggered. - -## EvaluationFormSingleSelectQuestionOption -### Properties -* **AutomaticFail**: bool: The flag to mark the option as automatic fail. -* **RefId**: string (Required): The identifier used to reference the option. -* **Score**: int: The score of the option. -* **Text**: string (Required): The title of the option. - -## ScoringStrategy -### Properties -* **Mode**: string (Required): The scoring mode. -* **Status**: string (Required): The scoring status. - -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that's 1 to 256 characters in length. + *Allowed values*: ``DRAFT`` | ``ACTIVE`` +* **Tags**: [Tag](#tag)[]: The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }. +* **Title**: string (Required): A title of the evaluation form. ## AWS.Connect/HoursOfOperationProperties ### Properties @@ -311,22 +242,6 @@ * **Tags**: [Tag](#tag)[]: One or more tags. * **TimeZone**: string (Required): The time zone of the hours of operation. -## HoursOfOperationConfig -### Properties -* **Day**: string (Required): The day that the hours of operation applies to. -* **EndTime**: [HoursOfOperationTimeSlice](#hoursofoperationtimeslice) (Required): The end time that your contact center closes. -* **StartTime**: [HoursOfOperationTimeSlice](#hoursofoperationtimeslice) (Required): The start time that your contact center opens. - -## HoursOfOperationTimeSlice -### Properties -* **Hours**: int (Required): The hours. -* **Minutes**: int (Required): The minutes. - -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is maximum of 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## AWS.Connect/InstanceProperties ### Properties * **Arn**: string (ReadOnly, Identifier): An instanceArn is automatically generated on creation based on instanceId. @@ -340,21 +255,6 @@ * **ServiceRole**: string (ReadOnly): Service linked role created as part of instance creation. * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. -## Attributes -### Properties -* **AutoResolveBestVoices**: bool -* **ContactflowLogs**: bool -* **ContactLens**: bool -* **EarlyMedia**: bool -* **InboundCalls**: bool (Required) -* **OutboundCalls**: bool (Required) -* **UseCustomTTSVoices**: bool - -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## AWS.Connect/InstanceStorageConfigProperties ### Properties * **AssociationId**: string (ReadOnly, Identifier) @@ -366,31 +266,6 @@ * **S3Config**: [S3Config](#s3config) * **StorageType**: string (Required) -## KinesisFirehoseConfig -### Properties -* **FirehoseArn**: string (Required) - -## KinesisStreamConfig -### Properties -* **StreamArn**: string (Required) - -## KinesisVideoStreamConfig -### Properties -* **EncryptionConfig**: [EncryptionConfig](#encryptionconfig) (Required) -* **Prefix**: string (Required) -* **RetentionPeriodHours**: int (Required) - -## EncryptionConfig -### Properties -* **EncryptionType**: string (Required) -* **KeyId**: string (Required) - -## S3Config -### Properties -* **BucketName**: string (Required) -* **BucketPrefix**: string (Required) -* **EncryptionConfig**: [EncryptionConfig](#encryptionconfig) - ## AWS.Connect/IntegrationAssociationProperties ### Properties * **InstanceId**: string (Required, Identifier) @@ -410,21 +285,14 @@ * **TargetArn**: string (Required): The ARN of the target the phone number is claimed to. * **Type**: string: The phone number type -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## AWS.Connect/PredefinedAttributeProperties ### Properties * **InstanceArn**: string (Required, Identifier): The identifier of the Amazon Connect instance. +* **LastModifiedRegion**: string (ReadOnly): Last modified region. +* **LastModifiedTime**: int (ReadOnly): Last modified time. * **Name**: string (Required, Identifier): The name of the predefined attribute. * **Values**: [PredefinedAttribute_Values](#predefinedattributevalues) (Required): The values of a predefined attribute. -## PredefinedAttribute_Values -### Properties -* **StringList**: string[] - ## AWS.Connect/PromptProperties ### Properties * **Description**: string: The description of the prompt. @@ -434,11 +302,6 @@ * **S3Uri**: string (WriteOnly): S3 URI of the customer's audio file for creating prompts resource.. * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## AWS.Connect/QueueProperties ### Properties * **Description**: string: The description of the queue. @@ -453,17 +316,6 @@ * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. * **Type**: string (ReadOnly): The type of queue. -## OutboundCallerConfig -### Properties -* **OutboundCallerIdName**: string -* **OutboundCallerIdNumberArn**: string -* **OutboundFlowArn**: string - -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - ## AWS.Connect/QuickConnectProperties ### Properties * **Description**: string: The description of the quick connect. @@ -474,32 +326,6 @@ * **QuickConnectType**: string (ReadOnly): The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE). * **Tags**: [Tag](#tag)[]: One or more tags. -## QuickConnectConfig -### Properties -* **PhoneConfig**: [PhoneNumberQuickConnectConfig](#phonenumberquickconnectconfig) -* **QueueConfig**: [QueueQuickConnectConfig](#queuequickconnectconfig) -* **QuickConnectType**: string (Required) -* **UserConfig**: [UserQuickConnectConfig](#userquickconnectconfig) - -## PhoneNumberQuickConnectConfig -### Properties -* **PhoneNumber**: string (Required) - -## QueueQuickConnectConfig -### Properties -* **ContactFlowArn**: string (Required) -* **QueueArn**: string (Required) - -## UserQuickConnectConfig -### Properties -* **ContactFlowArn**: string (Required) -* **UserArn**: string (Required) - -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is maximum of 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## AWS.Connect/RoutingProfileProperties ### Properties * **AgentAvailabilityTimer**: string: Whether agents with this routing profile will have their routing order calculated based on longest idle time or time since their last inbound contact. @@ -512,32 +338,6 @@ * **RoutingProfileArn**: string (ReadOnly, Identifier): The Amazon Resource Name (ARN) of the routing profile. * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. -## MediaConcurrency -### Properties -* **Channel**: string (Required) -* **Concurrency**: int (Required) -* **CrossChannelBehavior**: [CrossChannelBehavior](#crosschannelbehavior) - -## CrossChannelBehavior -### Properties -* **BehaviorType**: string (Required) - -## RoutingProfileQueueConfig -### Properties -* **Delay**: int (Required) -* **Priority**: int (Required) -* **QueueReference**: [RoutingProfileQueueReference](#routingprofilequeuereference) (Required) - -## RoutingProfileQueueReference -### Properties -* **Channel**: string (Required) -* **QueueArn**: string (Required) - -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## AWS.Connect/RuleProperties ### Properties * **Actions**: [Actions](#actions) (Required): The list of actions that will be executed when a rule is triggered. @@ -549,29 +349,232 @@ * **Tags**: [Tag](#tag)[]: One or more tags. * **TriggerEventSource**: [RuleTriggerEventSource](#ruletriggereventsource) (Required): The event source that triggers the rule. -## Actions +## AWS.Connect/SecurityKeyProperties ### Properties -* **AssignContactCategoryActions**: [AssignContactCategoryAction](#assigncontactcategoryaction)[] -* **CreateCaseActions**: [CreateCaseAction](#createcaseaction)[] -* **EndAssociatedTaskActions**: [EndAssociatedTasksAction](#endassociatedtasksaction)[] -* **EventBridgeActions**: [EventBridgeAction](#eventbridgeaction)[] -* **SendNotificationActions**: [SendNotificationAction](#sendnotificationaction)[] -* **TaskActions**: [TaskAction](#taskaction)[] -* **UpdateCaseActions**: [UpdateCaseAction](#updatecaseaction)[] +* **AssociationId**: string (ReadOnly, Identifier) +* **InstanceId**: string (Required, Identifier) +* **Key**: string (Required) -## AssignContactCategoryAction +## AWS.Connect/SecurityProfileProperties ### Properties - -## CreateCaseAction +* **AllowedAccessControlHierarchyGroupId**: string: The identifier of the hierarchy group that a security profile uses to restrict access to resources in Amazon Connect. +* **AllowedAccessControlTags**: [Tag](#tag)[]: The list of tags that a security profile uses to restrict access to resources in Amazon Connect. +* **Applications**: [Application](#application)[]: A list of third-party applications that the security profile will give access to. +* **Description**: string: The description of the security profile. +* **HierarchyRestrictedResources**: string[]: The list of resources that a security profile applies hierarchy restrictions to in Amazon Connect. +* **InstanceArn**: string (Required): The identifier of the Amazon Connect instance. +* **LastModifiedRegion**: string (ReadOnly): The AWS Region where this resource was last modified. +* **LastModifiedTime**: int (ReadOnly): The timestamp when this resource was last modified. +* **Permissions**: string[]: Permissions assigned to the security profile. +* **SecurityProfileArn**: string (ReadOnly, Identifier): The Amazon Resource Name (ARN) for the security profile. +* **SecurityProfileName**: string (Required): The name of the security profile. +* **TagRestrictedResources**: string[]: The list of resources that a security profile applies tag restrictions to in Amazon Connect. +* **Tags**: [Tag](#tag)[]: The tags used to organize, track, or control access for this resource. + +## AWS.Connect/TaskTemplateProperties +### Properties +* **Arn**: string (ReadOnly, Identifier): The identifier (arn) of the task template. +* **ClientToken**: string +* **Constraints**: [TaskTemplate_Constraints](#tasktemplateconstraints): The constraints for the task template +* **ContactFlowArn**: string: The identifier of the contact flow. +* **Defaults**: [DefaultFieldValue](#defaultfieldvalue)[] +* **Description**: string: The description of the task template. +* **Fields**: [Field](#field)[]: The list of task template's fields +* **InstanceArn**: string (Required): The identifier (arn) of the instance. +* **Name**: string: The name of the task template. +* **Status**: string +* **Tags**: [Tag](#tag)[]: One or more tags. + +## AWS.Connect/TrafficDistributionGroupProperties +### Properties +* **Description**: string: A description for the traffic distribution group. +* **InstanceArn**: string (Required): The identifier of the Amazon Connect instance that has been replicated. +* **IsDefault**: bool (ReadOnly): If this is the default traffic distribution group. +* **Name**: string (Required): The name for the traffic distribution group. +* **Status**: string (ReadOnly): The status of the traffic distribution group. +* **Tags**: [Tag](#tag)[]: One or more tags. +* **TrafficDistributionGroupArn**: string (ReadOnly, Identifier): The identifier of the traffic distribution group. + +## AWS.Connect/UserHierarchyGroupProperties +### Properties +* **InstanceArn**: string (Required): The identifier of the Amazon Connect instance. +* **Name**: string (Required): The name of the user hierarchy group. +* **ParentGroupArn**: string: The Amazon Resource Name (ARN) for the parent user hierarchy group. +* **Tags**: [Tag](#tag)[]: One or more tags. +* **UserHierarchyGroupArn**: string (ReadOnly, Identifier): The Amazon Resource Name (ARN) for the user hierarchy group. + +## AWS.Connect/UserProperties +### Properties +* **DirectoryUserId**: string: The identifier of the user account in the directory used for identity management. +* **HierarchyGroupArn**: string: The identifier of the hierarchy group for the user. +* **IdentityInfo**: [UserIdentityInfo](#useridentityinfo): The information about the identity of the user. +* **InstanceArn**: string (Required): The identifier of the Amazon Connect instance. +* **Password**: string (WriteOnly): The password for the user account. A password is required if you are using Amazon Connect for identity management. Otherwise, it is an error to include a password. +* **PhoneConfig**: [UserPhoneConfig](#userphoneconfig) (Required): The phone settings for the user. +* **RoutingProfileArn**: string (Required): The identifier of the routing profile for the user. +* **SecurityProfileArns**: string[] (Required): One or more security profile arns for the user +* **Tags**: [Tag](#tag)[]: One or more tags. +* **UserArn**: string (ReadOnly, Identifier): The Amazon Resource Name (ARN) for the user. +* **Username**: string (Required): The user name for the account. +* **UserProficiencies**: [UserProficiency](#userproficiency)[]: One or more predefined attributes assigned to a user, with a level that indicates how skilled they are. + +## AWS.Connect/ViewProperties +### Properties +* **Actions**: string[] (Required): The actions of the view in an array. +* **Description**: string: The description of the view. +* **InstanceArn**: string (Required): The Amazon Resource Name (ARN) of the instance. +* **Name**: string (Required): The name of the view. +* **Tags**: [Tag](#tag)[]: One or more tags. +* **Template**: [View_Template](#viewtemplate) (Required): The template of the view as JSON. +* **ViewArn**: string (ReadOnly, Identifier): The Amazon Resource Name (ARN) of the view. +* **ViewContentSha256**: string (ReadOnly): The view content hash. +* **ViewId**: string (ReadOnly): The view id of the view. + +## AWS.Connect/ViewVersionProperties +### Properties +* **Version**: int (ReadOnly): The version of the view. +* **VersionDescription**: string: The description for the view version. +* **ViewArn**: string (Required): The Amazon Resource Name (ARN) of the view for which a version is being created. +* **ViewContentSha256**: string: The view content hash to be checked. +* **ViewVersionArn**: string (ReadOnly, Identifier): The Amazon Resource Name (ARN) of the created view version. + +## CreateCaseAction ### Properties * **Fields**: [Field](#field)[] (Required) * **TemplateId**: string (Required): The Id of template. +## CrossChannelBehavior +### Properties +* **BehaviorType**: string (Required) + +## DefaultFieldValue +### Properties +* **DefaultValue**: string (Required) +* **Id**: [FieldIdentifier](#fieldidentifier) (Required) + +## EncryptionConfig +### Properties +* **EncryptionType**: string (Required) +* **KeyId**: string (Required) + +## EndAssociatedTasksAction +### Properties + +## EvaluationFormBaseItem +### Properties +* **Section**: [EvaluationFormSection](#evaluationformsection) (Required): A subsection or inner section of an item. + +## EvaluationFormItem +### Properties +* **Question**: [EvaluationFormQuestion](#evaluationformquestion): The information of the question. +* **Section**: [EvaluationFormSection](#evaluationformsection): The information of the section. + +## EvaluationFormNumericQuestionAutomation +### Properties +* **PropertyValue**: [NumericQuestionPropertyValueAutomation](#numericquestionpropertyvalueautomation) (Required): The property value of the automation. + +## EvaluationFormNumericQuestionOption +### Properties +* **AutomaticFail**: bool: The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0. +* **MaxValue**: int (Required): The maximum answer value of the range option. +* **MinValue**: int (Required): The minimum answer value of the range option. +* **Score**: int: The score assigned to answer values within the range option. + *Minimum*: 0 + *Maximum*: 10 + +## EvaluationFormNumericQuestionProperties +### Properties +* **Automation**: [EvaluationFormNumericQuestionAutomation](#evaluationformnumericquestionautomation): The automation properties of the numeric question. +* **MaxValue**: int (Required): The maximum answer value. +* **MinValue**: int (Required): The minimum answer value. +* **Options**: [EvaluationFormNumericQuestionOption](#evaluationformnumericquestionoption)[]: The scoring options of the numeric question. + +## EvaluationFormQuestion +### Properties +* **Instructions**: string: The instructions of the section. + *Length Constraints*: Minimum length of 0. Maximum length of 1024. +* **NotApplicableEnabled**: bool: The flag to enable not applicable answers to the question. +* **QuestionType**: string (Required): The type of the question. + *Allowed values*: ``NUMERIC`` | ``SINGLESELECT`` | ``TEXT`` +* **QuestionTypeProperties**: [EvaluationFormQuestionTypeProperties](#evaluationformquestiontypeproperties): The properties of the type of question. Text questions do not have to define question type properties. +* **RefId**: string (Required): The identifier of the question. An identifier must be unique within the evaluation form. + *Length Constraints*: Minimum length of 1. Maximum length of 40. +* **Title**: string (Required): The title of the question. + *Length Constraints*: Minimum length of 1. Maximum length of 350. +* **Weight**: int: The scoring weight of the section. + *Minimum*: 0 + *Maximum*: 100 + +## EvaluationFormQuestionTypeProperties +### Properties +* **Numeric**: [EvaluationFormNumericQuestionProperties](#evaluationformnumericquestionproperties): The properties of the numeric question. +* **SingleSelect**: [EvaluationFormSingleSelectQuestionProperties](#evaluationformsingleselectquestionproperties): The properties of the numeric question. + +## EvaluationFormSection +### Properties +* **Instructions**: string: The instructions of the section. +* **Items**: [EvaluationFormItem](#evaluationformitem)[]: The items of the section. + *Minimum*: 1 +* **RefId**: string (Required): The identifier of the section. An identifier must be unique within the evaluation form. + *Length Constraints*: Minimum length of 1. Maximum length of 40. +* **Title**: string (Required): The title of the section. + *Length Constraints*: Minimum length of 1. Maximum length of 128. +* **Weight**: int: The scoring weight of the section. + *Minimum*: 0 + *Maximum*: 100 + +## EvaluationFormSingleSelectQuestionAutomation +### Properties +* **DefaultOptionRefId**: string: The identifier of the default answer option, when none of the automation options match the criteria. + *Length Constraints*: Minimum length of 1. Maximum length of 40. +* **Options**: [EvaluationFormSingleSelectQuestionAutomationOption](#evaluationformsingleselectquestionautomationoption)[] (Required): The automation options of the single select question. + *Minimum*: 1 + *Maximum*: 20 + +## EvaluationFormSingleSelectQuestionAutomationOption +### Properties +* **RuleCategory**: [SingleSelectQuestionRuleCategoryAutomation](#singleselectquestionrulecategoryautomation) (Required): The automation option based on a rule category for the single select question. + +## EvaluationFormSingleSelectQuestionOption +### Properties +* **AutomaticFail**: bool: The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0. +* **RefId**: string (Required): The identifier of the answer option. An identifier must be unique within the question. + *Length Constraints*: Minimum length of 1. Maximum length of 40. +* **Score**: int: The score assigned to the answer option. + *Minimum*: 0 + *Maximum*: 10 +* **Text**: string (Required): The title of the answer option. + *Length Constraints*: Minimum length of 1. Maximum length of 128. + +## EvaluationFormSingleSelectQuestionProperties +### Properties +* **Automation**: [EvaluationFormSingleSelectQuestionAutomation](#evaluationformsingleselectquestionautomation): The display mode of the single select question. +* **DisplayAs**: string: The display mode of the single select question. + *Allowed values*: ``DROPDOWN`` | ``RADIO`` +* **Options**: [EvaluationFormSingleSelectQuestionOption](#evaluationformsingleselectquestionoption)[] (Required): The answer options of the single select question. + *Minimum*: 2 + *Maximum*: 256 + +## EventBridgeAction +### Properties +* **Name**: string (Required): The name of the event bridge action. + ## Field ### Properties * **Id**: string (Required): The Id of the field * **Value**: [FieldValue](#fieldvalue) (Required) +## Field +### Properties +* **Description**: string: The description of the task template's field +* **Id**: [FieldIdentifier](#fieldidentifier) (Required) +* **SingleSelectOptions**: string[]: list of field options to be used with single select +* **Type**: string (Required) + +## FieldIdentifier +### Properties +* **Name**: string (Required): The name of the task template field + ## FieldValue ### Properties * **BooleanValue**: bool @@ -579,160 +582,246 @@ * **EmptyValue**: [Rule_EmptyValue](#ruleemptyvalue) * **StringValue**: string -## Rule_EmptyValue +## HoursOfOperationConfig ### Properties +* **Day**: string (Required): The day that the hours of operation applies to. +* **EndTime**: [HoursOfOperationTimeSlice](#hoursofoperationtimeslice) (Required): The end time that your contact center closes. +* **StartTime**: [HoursOfOperationTimeSlice](#hoursofoperationtimeslice) (Required): The start time that your contact center opens. -## EndAssociatedTasksAction +## HoursOfOperationTimeSlice ### Properties +* **Hours**: int (Required): The hours. +* **Minutes**: int (Required): The minutes. -## EventBridgeAction +## InvisibleFieldInfo ### Properties -* **Name**: string (Required): The name of the event bridge action. +* **Id**: [FieldIdentifier](#fieldidentifier) (Required) -## SendNotificationAction +## KinesisFirehoseConfig ### Properties -* **Content**: string (Required): The content of notification. -* **ContentType**: string (Required): The type of content. -* **DeliveryMethod**: string (Required): The means of delivery. -* **Recipient**: [NotificationRecipientType](#notificationrecipienttype) (Required) -* **Subject**: string: The subject of notification. +* **FirehoseArn**: string (Required) + +## KinesisStreamConfig +### Properties +* **StreamArn**: string (Required) + +## KinesisVideoStreamConfig +### Properties +* **EncryptionConfig**: [EncryptionConfig](#encryptionconfig) (Required) +* **Prefix**: string (Required) +* **RetentionPeriodHours**: int (Required) + +## MediaConcurrency +### Properties +* **Channel**: string (Required) +* **Concurrency**: int (Required) +* **CrossChannelBehavior**: [CrossChannelBehavior](#crosschannelbehavior) ## NotificationRecipientType ### Properties * **UserArns**: string[]: The list of recipients by user arns. * **UserTags**: [Rule_UserTags](#ruleusertags): The collection of recipients who are identified by user tags -## Rule_UserTags +## NumericQuestionPropertyValueAutomation ### Properties +* **Label**: string (Required): The property label of the automation. -## TaskAction +## OutboundCallerConfig ### Properties -* **ContactFlowArn**: string (Required): The Amazon Resource Name (ARN) of the contact flow. -* **Description**: string: The description which appears in the agent's Contact Control Panel (CCP). -* **Name**: string (Required): The name which appears in the agent's Contact Control Panel (CCP). -* **References**: [Rule_References](#rulereferences): A formatted URL that is shown to an agent in the Contact Control Panel (CCP). +* **OutboundCallerIdName**: string +* **OutboundCallerIdNumberArn**: string +* **OutboundFlowArn**: string -## Rule_References +## PhoneNumberQuickConnectConfig ### Properties +* **PhoneNumber**: string (Required) -## UpdateCaseAction +## PredefinedAttribute_Values ### Properties -* **Fields**: [Field](#field)[] (Required) +* **StringList**: string[] -## Tag +## QueueQuickConnectConfig +### Properties +* **ContactFlowArn**: string (Required) +* **QueueArn**: string (Required) + +## QuickConnectConfig +### Properties +* **PhoneConfig**: [PhoneNumberQuickConnectConfig](#phonenumberquickconnectconfig) +* **QueueConfig**: [QueueQuickConnectConfig](#queuequickconnectconfig) +* **QuickConnectType**: string (Required) +* **UserConfig**: [UserQuickConnectConfig](#userquickconnectconfig) + +## ReadOnlyFieldInfo +### Properties +* **Id**: [FieldIdentifier](#fieldidentifier) (Required) + +## RequiredFieldInfo +### Properties +* **Id**: [FieldIdentifier](#fieldidentifier) (Required) + +## RoutingProfileQueueConfig +### Properties +* **Delay**: int (Required) +* **Priority**: int (Required) +* **QueueReference**: [RoutingProfileQueueReference](#routingprofilequeuereference) (Required) + +## RoutingProfileQueueReference +### Properties +* **Channel**: string (Required) +* **QueueArn**: string (Required) + +## Rule_EmptyValue +### Properties + +## Rule_References +### Properties + +## Rule_UserTags ### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that's 1 to 256 characters in length. ## RuleTriggerEventSource ### Properties * **EventSourceName**: string (Required): The name of event source. * **IntegrationAssociationArn**: string: The Amazon Resource Name (ARN) for the AppIntegration association. -## AWS.Connect/SecurityKeyProperties +## S3Config ### Properties -* **AssociationId**: string (ReadOnly, Identifier) -* **InstanceId**: string (Required, Identifier) -* **Key**: string (Required) +* **BucketName**: string (Required) +* **BucketPrefix**: string (Required) +* **EncryptionConfig**: [EncryptionConfig](#encryptionconfig) -## AWS.Connect/SecurityProfileProperties +## ScoringStrategy ### Properties -* **AllowedAccessControlTags**: [Tag](#tag)[]: The list of tags that a security profile uses to restrict access to resources in Amazon Connect. -* **Description**: string: The description of the security profile. -* **InstanceArn**: string (Required): The identifier of the Amazon Connect instance. -* **Permissions**: string[]: Permissions assigned to the security profile. -* **SecurityProfileArn**: string (ReadOnly, Identifier): The Amazon Resource Name (ARN) for the security profile. -* **SecurityProfileName**: string (Required): The name of the security profile. -* **TagRestrictedResources**: string[]: The list of resources that a security profile applies tag restrictions to in Amazon Connect. -* **Tags**: [Tag](#tag)[]: The tags used to organize, track, or control access for this resource. +* **Mode**: string (Required): The scoring mode of the evaluation form. + *Allowed values*: ``QUESTION_ONLY`` | ``SECTION_ONLY`` +* **Status**: string (Required): The scoring status of the evaluation form. + *Allowed values*: ``ENABLED`` | ``DISABLED`` + +## SendNotificationAction +### Properties +* **Content**: string (Required): The content of notification. +* **ContentType**: string (Required): The type of content. +* **DeliveryMethod**: string (Required): The means of delivery. +* **Recipient**: [NotificationRecipientType](#notificationrecipienttype) (Required) +* **Subject**: string: The subject of notification. + +## SingleSelectQuestionRuleCategoryAutomation +### Properties +* **Category**: string (Required): The category name, as defined in Rules. + *Minimum*: 1 + *Maximum*: 50 +* **Condition**: string (Required): The condition to apply for the automation option. If the condition is PRESENT, then the option is applied when the contact data includes the category. Similarly, if the condition is NOT_PRESENT, then the option is applied when the contact data does not include the category. + *Allowed values*: ``PRESENT`` | ``NOT_PRESENT`` + *Maximum*: 50 +* **OptionRefId**: string (Required): The identifier of the answer option. An identifier must be unique within the question. + *Length Constraints*: Minimum length of 1. Maximum length of 40. + +## SubmitAutoEvaluationAction +### Properties +* **EvaluationFormArn**: string (Required): The Amazon Resource Name (ARN) of the evaluation form. + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. . You can specify a value that is maximum of 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ## Tag ### Properties * **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is maximum of 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -## AWS.Connect/TaskTemplateProperties +## Tag ### Properties -* **Arn**: string (ReadOnly, Identifier): The identifier (arn) of the task template. -* **ClientToken**: string -* **Constraints**: [TaskTemplate_Constraints](#tasktemplateconstraints): The constraints for the task template -* **ContactFlowArn**: string: The identifier of the contact flow. -* **Defaults**: [DefaultFieldValue](#defaultfieldvalue)[] -* **Description**: string: The description of the task template. -* **Fields**: [Field](#field)[]: The list of task template's fields -* **InstanceArn**: string (Required): The identifier (arn) of the instance. -* **Name**: string: The name of the task template. -* **Status**: string -* **Tags**: [Tag](#tag)[]: One or more tags. +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and - +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and - -## TaskTemplate_Constraints +## Tag ### Properties -* **InvisibleFields**: [InvisibleFieldInfo](#invisiblefieldinfo)[] -* **ReadOnlyFields**: [ReadOnlyFieldInfo](#readonlyfieldinfo)[] -* **RequiredFields**: [RequiredFieldInfo](#requiredfieldinfo)[] +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is maximum of 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -## InvisibleFieldInfo +## Tag ### Properties -* **Id**: [FieldIdentifier](#fieldidentifier) (Required) +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -## FieldIdentifier +## Tag ### Properties -* **Name**: string (Required): The name of the task template field +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -## ReadOnlyFieldInfo +## Tag ### Properties -* **Id**: [FieldIdentifier](#fieldidentifier) (Required) +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -## RequiredFieldInfo +## Tag ### Properties -* **Id**: [FieldIdentifier](#fieldidentifier) (Required) +* **Key**: string (Required) +* **Value**: string (Required) -## DefaultFieldValue +## Tag ### Properties -* **DefaultValue**: string (Required) -* **Id**: [FieldIdentifier](#fieldidentifier) (Required) +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is maximum of 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -## Field +## Tag ### Properties -* **Description**: string: The description of the task template's field -* **Id**: [FieldIdentifier](#fieldidentifier) (Required) -* **SingleSelectOptions**: string[]: list of field options to be used with single select -* **Type**: string (Required) +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ## Tag ### Properties * **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. . You can specify a value that is maximum of 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that's 1 to 256 characters in length. -## AWS.Connect/TrafficDistributionGroupProperties +## Tag ### Properties -* **Description**: string: A description for the traffic distribution group. -* **InstanceArn**: string (Required): The identifier of the Amazon Connect instance that has been replicated. -* **IsDefault**: bool (ReadOnly): If this is the default traffic distribution group. -* **Name**: string (Required): The name for the traffic distribution group. -* **Status**: string (ReadOnly): The status of the traffic distribution group. -* **Tags**: [Tag](#tag)[]: One or more tags. -* **TrafficDistributionGroupArn**: string (ReadOnly, Identifier): The identifier of the traffic distribution group. +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. . You can specify a value that is maximum of 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ## Tag ### Properties * **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. * **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -## AWS.Connect/UserProperties +## Tag ### Properties -* **DirectoryUserId**: string: The identifier of the user account in the directory used for identity management. -* **HierarchyGroupArn**: string: The identifier of the hierarchy group for the user. -* **IdentityInfo**: [UserIdentityInfo](#useridentityinfo): The information about the identity of the user. -* **InstanceArn**: string (Required): The identifier of the Amazon Connect instance. -* **Password**: string (WriteOnly): The password for the user account. A password is required if you are using Amazon Connect for identity management. Otherwise, it is an error to include a password. -* **PhoneConfig**: [UserPhoneConfig](#userphoneconfig) (Required): The phone settings for the user. -* **RoutingProfileArn**: string (Required): The identifier of the routing profile for the user. -* **SecurityProfileArns**: string[] (Required): One or more security profile arns for the user -* **Tags**: [Tag](#tag)[]: One or more tags. -* **UserArn**: string (ReadOnly, Identifier): The Amazon Resource Name (ARN) for the user. -* **Username**: string (Required): The user name for the account. -* **UserProficiencies**: [UserProficiency](#userproficiency)[]: One or more predefined attributes assigned to a user, with a level that indicates how skilled they are. +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is maximum of 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is maximum of 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters +* **Value**: string (Required): The value for the tag. . You can specify a value that is maximum of 256 Unicode characters + +## TaskAction +### Properties +* **ContactFlowArn**: string (Required): The Amazon Resource Name (ARN) of the contact flow. +* **Description**: string: The description which appears in the agent's Contact Control Panel (CCP). +* **Name**: string (Required): The name which appears in the agent's Contact Control Panel (CCP). +* **References**: [Rule_References](#rulereferences): A formatted URL that is shown to an agent in the Contact Control Panel (CCP). + +## TaskTemplate_Constraints +### Properties +* **InvisibleFields**: [InvisibleFieldInfo](#invisiblefieldinfo)[] +* **ReadOnlyFields**: [ReadOnlyFieldInfo](#readonlyfieldinfo)[] +* **RequiredFields**: [RequiredFieldInfo](#requiredfieldinfo)[] + +## UpdateCaseAction +### Properties +* **Fields**: [Field](#field)[] (Required) ## UserIdentityInfo ### Properties @@ -749,55 +838,17 @@ * **DeskPhoneNumber**: string * **PhoneType**: string (Required) -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is maximum of 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## UserProficiency ### Properties * **AttributeName**: string (Required) * **AttributeValue**: string (Required) * **Level**: int (Required) -## AWS.Connect/UserHierarchyGroupProperties -### Properties -* **InstanceArn**: string (Required): The identifier of the Amazon Connect instance. -* **Name**: string (Required): The name of the user hierarchy group. -* **ParentGroupArn**: string: The Amazon Resource Name (ARN) for the parent user hierarchy group. -* **Tags**: [Tag](#tag)[]: One or more tags. -* **UserHierarchyGroupArn**: string (ReadOnly, Identifier): The Amazon Resource Name (ARN) for the user hierarchy group. - -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is maximum of 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - -## AWS.Connect/ViewProperties -### Properties -* **Actions**: string[] (Required): The actions of the view in an array. -* **Description**: string: The description of the view. -* **InstanceArn**: string (Required): The Amazon Resource Name (ARN) of the instance. -* **Name**: string (Required): The name of the view. -* **Tags**: [Tag](#tag)[]: One or more tags. -* **Template**: [View_Template](#viewtemplate) (Required): The template of the view as JSON. -* **ViewArn**: string (ReadOnly, Identifier): The Amazon Resource Name (ARN) of the view. -* **ViewContentSha256**: string (ReadOnly): The view content hash. -* **ViewId**: string (ReadOnly): The view id of the view. - -## Tag +## UserQuickConnectConfig ### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters -* **Value**: string (Required): The value for the tag. . You can specify a value that is maximum of 256 Unicode characters +* **ContactFlowArn**: string (Required) +* **UserArn**: string (Required) ## View_Template ### Properties -## AWS.Connect/ViewVersionProperties -### Properties -* **Version**: int (ReadOnly): The version of the view. -* **VersionDescription**: string: The description for the view version. -* **ViewArn**: string (Required): The Amazon Resource Name (ARN) of the view for which a version is being created. -* **ViewContentSha256**: string: The view content hash to be checked. -* **ViewVersionArn**: string (ReadOnly, Identifier): The Amazon Resource Name (ARN) of the created view version. - diff --git a/artifacts/bicep/aws/aws.connectcampaigns/default/types.json b/artifacts/bicep/aws/aws.connectcampaigns/default/types.json index d0ad4081..7e9bb4d5 100644 --- a/artifacts/bicep/aws/aws.connectcampaigns/default/types.json +++ b/artifacts/bicep/aws/aws.connectcampaigns/default/types.json @@ -1 +1,253 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"AgentlessDialerConfig","Properties":{"DialingCapacity":{"Type":3,"Flags":0,"Description":"Allocates dialing capacity for this campaign between multiple active campaigns."}}}},{"2":{"Name":"AnswerMachineDetectionConfig","Properties":{"EnableAnswerMachineDetection":{"Type":2,"Flags":1,"Description":"Flag to decided whether outbound calls should have answering machine detection enabled or not"}}}},{"2":{"Name":"DialerConfig","Properties":{"AgentlessDialerConfig":{"Type":8,"Flags":0},"PredictiveDialerConfig":{"Type":12,"Flags":0},"ProgressiveDialerConfig":{"Type":13,"Flags":0}}}},{"2":{"Name":"OutboundCallConfig","Properties":{"AnswerMachineDetectionConfig":{"Type":9,"Flags":0},"ConnectContactFlowArn":{"Type":4,"Flags":1,"Description":"The identifier of the contact flow for the outbound call."},"ConnectQueueArn":{"Type":4,"Flags":0,"Description":"The queue for the call. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue defined in the contact flow is used. If you do not specify a queue, you must specify a source phone number."},"ConnectSourcePhoneNumber":{"Type":4,"Flags":0,"Description":"The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify a source phone number, you must specify a queue."}}}},{"2":{"Name":"PredictiveDialerConfig","Properties":{"BandwidthAllocation":{"Type":3,"Flags":1,"Description":"The bandwidth allocation of a queue resource."},"DialingCapacity":{"Type":3,"Flags":0,"Description":"Allocates dialing capacity for this campaign between multiple active campaigns."}}}},{"2":{"Name":"ProgressiveDialerConfig","Properties":{"BandwidthAllocation":{"Type":3,"Flags":1,"Description":"The bandwidth allocation of a queue resource."},"DialingCapacity":{"Type":3,"Flags":0,"Description":"Allocates dialing capacity for this campaign between multiple active campaigns."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that's 1 to 256 characters in length."}}}},{"2":{"Name":"AWS.ConnectCampaigns/CampaignProperties","Properties":{"Arn":{"Type":4,"Flags":18,"Description":"Amazon Connect Campaign Arn"},"ConnectInstanceArn":{"Type":4,"Flags":1,"Description":"Amazon Connect Instance Arn"},"DialerConfig":{"Type":10,"Flags":1},"Name":{"Type":4,"Flags":1,"Description":"Amazon Connect Campaign Name"},"OutboundCallConfig":{"Type":11,"Flags":1},"Tags":{"Type":16,"Flags":0,"Description":"One or more tags."}}}},{"3":{"ItemType":14}},{"2":{"Name":"AWS.ConnectCampaigns/Campaign","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":15,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ConnectCampaigns/Campaign@default","ScopeType":0,"Body":17}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "AgentlessDialerConfig", + "properties": { + "DialingCapacity": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "Allocates dialing capacity for this campaign between multiple active campaigns." + } + } + }, + { + "$type": "ObjectType", + "name": "AnswerMachineDetectionConfig", + "properties": { + "AwaitAnswerMachinePrompt": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "Enables detection of prompts (e.g., beep after after a voicemail greeting)" + }, + "EnableAnswerMachineDetection": { + "type": { + "$ref": "#/8" + }, + "flags": 1, + "description": "Flag to decided whether outbound calls should have answering machine detection enabled or not" + } + } + }, + { + "$type": "ObjectType", + "name": "DialerConfig", + "properties": { + "AgentlessDialerConfig": { + "type": { + "$ref": "#/0" + }, + "flags": 0 + }, + "PredictiveDialerConfig": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "ProgressiveDialerConfig": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "OutboundCallConfig", + "properties": { + "AnswerMachineDetectionConfig": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "ConnectContactFlowArn": { + "type": { + "$ref": "#/9" + }, + "flags": 1, + "description": "The identifier of the contact flow for the outbound call." + }, + "ConnectQueueArn": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "The queue for the call. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue defined in the contact flow is used. If you do not specify a queue, you must specify a source phone number." + }, + "ConnectSourcePhoneNumber": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify a source phone number, you must specify a queue." + } + } + }, + { + "$type": "ObjectType", + "name": "PredictiveDialerConfig", + "properties": { + "BandwidthAllocation": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "The bandwidth allocation of a queue resource." + }, + "DialingCapacity": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "Allocates dialing capacity for this campaign between multiple active campaigns." + } + } + }, + { + "$type": "ObjectType", + "name": "ProgressiveDialerConfig", + "properties": { + "BandwidthAllocation": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "The bandwidth allocation of a queue resource." + }, + "DialingCapacity": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "Allocates dialing capacity for this campaign between multiple active campaigns." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/9" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + }, + "Value": { + "type": { + "$ref": "#/9" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that's 1 to 256 characters in length." + } + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "BooleanType" + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.ConnectCampaigns/CampaignProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ObjectType", + "name": "AWS.ConnectCampaigns/CampaignProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/9" + }, + "flags": 18, + "description": "Amazon Connect Campaign Arn" + }, + "ConnectInstanceArn": { + "type": { + "$ref": "#/9" + }, + "flags": 1, + "description": "Amazon Connect Instance Arn" + }, + "DialerConfig": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/9" + }, + "flags": 1, + "description": "Amazon Connect Campaign Name" + }, + "OutboundCallConfig": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "One or more tags." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ConnectCampaigns/Campaign", + "properties": { + "name": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/9" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/12" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ConnectCampaigns/Campaign@default", + "scopeType": 0, + "body": { + "$ref": "#/13" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.connectcampaigns/default/types.md b/artifacts/bicep/aws/aws.connectcampaigns/default/types.md index d50015da..d0c0e9ec 100644 --- a/artifacts/bicep/aws/aws.connectcampaigns/default/types.md +++ b/artifacts/bicep/aws/aws.connectcampaigns/default/types.md @@ -3,9 +3,18 @@ ## Resource AWS.ConnectCampaigns/Campaign@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ConnectCampaigns/CampaignProperties](#awsconnectcampaignscampaignproperties) (Required): properties of the resource +* **properties**: [AWS.ConnectCampaigns/CampaignProperties](#awsconnectcampaignscampaignproperties) (Required, Identifier): properties of the resource + +## AgentlessDialerConfig +### Properties +* **DialingCapacity**: int: Allocates dialing capacity for this campaign between multiple active campaigns. + +## AnswerMachineDetectionConfig +### Properties +* **AwaitAnswerMachinePrompt**: bool: Enables detection of prompts (e.g., beep after after a voicemail greeting) +* **EnableAnswerMachineDetection**: bool (Required): Flag to decided whether outbound calls should have answering machine detection enabled or not ## AWS.ConnectCampaigns/CampaignProperties ### Properties @@ -22,9 +31,12 @@ * **PredictiveDialerConfig**: [PredictiveDialerConfig](#predictivedialerconfig) * **ProgressiveDialerConfig**: [ProgressiveDialerConfig](#progressivedialerconfig) -## AgentlessDialerConfig +## OutboundCallConfig ### Properties -* **DialingCapacity**: int: Allocates dialing capacity for this campaign between multiple active campaigns. +* **AnswerMachineDetectionConfig**: [AnswerMachineDetectionConfig](#answermachinedetectionconfig) +* **ConnectContactFlowArn**: string (Required): The identifier of the contact flow for the outbound call. +* **ConnectQueueArn**: string: The queue for the call. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue defined in the contact flow is used. If you do not specify a queue, you must specify a source phone number. +* **ConnectSourcePhoneNumber**: string: The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify a source phone number, you must specify a queue. ## PredictiveDialerConfig ### Properties @@ -36,17 +48,6 @@ * **BandwidthAllocation**: int (Required): The bandwidth allocation of a queue resource. * **DialingCapacity**: int: Allocates dialing capacity for this campaign between multiple active campaigns. -## OutboundCallConfig -### Properties -* **AnswerMachineDetectionConfig**: [AnswerMachineDetectionConfig](#answermachinedetectionconfig) -* **ConnectContactFlowArn**: string (Required): The identifier of the contact flow for the outbound call. -* **ConnectQueueArn**: string: The queue for the call. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue defined in the contact flow is used. If you do not specify a queue, you must specify a source phone number. -* **ConnectSourcePhoneNumber**: string: The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify a source phone number, you must specify a queue. - -## AnswerMachineDetectionConfig -### Properties -* **EnableAnswerMachineDetection**: bool (Required): Flag to decided whether outbound calls should have answering machine detection enabled or not - ## Tag ### Properties * **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. diff --git a/artifacts/bicep/aws/aws.controltower/default/types.json b/artifacts/bicep/aws/aws.controltower/default/types.json index 80a14832..b1572e15 100644 --- a/artifacts/bicep/aws/aws.controltower/default/types.json +++ b/artifacts/bicep/aws/aws.controltower/default/types.json @@ -1 +1,402 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"EnabledControlParameter","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":9,"Flags":1}}}},{"2":{"Name":"EnabledControl_Value","Properties":{}}},{"2":{"Name":"AWS.ControlTower/EnabledControlProperties","Properties":{"ControlIdentifier":{"Type":4,"Flags":17,"Description":"Arn of the control."},"Parameters":{"Type":11,"Flags":0,"Description":"Parameters to configure the enabled control behavior."},"TargetIdentifier":{"Type":4,"Flags":17,"Description":"Arn for Organizational unit to which the control needs to be applied"}}}},{"3":{"ItemType":8}},{"2":{"Name":"AWS.ControlTower/EnabledControl","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":10,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ControlTower/EnabledControl@default","ScopeType":0,"Body":12}},{"2":{"Name":"LandingZoneDriftStatus"}},{"2":{"Name":"LandingZoneStatus"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":0},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"AWS.ControlTower/LandingZoneProperties","Properties":{"Arn":{"Type":4,"Flags":2},"DriftStatus":{"Type":4,"Flags":2},"LandingZoneIdentifier":{"Type":4,"Flags":18},"LatestAvailableVersion":{"Type":4,"Flags":2},"Manifest":{"Type":18,"Flags":1},"Status":{"Type":4,"Flags":2},"Tags":{"Type":19,"Flags":0},"Version":{"Type":4,"Flags":1}}}},{"2":{"Name":"LandingZone_Manifest","Properties":{}}},{"3":{"ItemType":16}},{"2":{"Name":"AWS.ControlTower/LandingZone","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":17,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ControlTower/LandingZone@default","ScopeType":0,"Body":20}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "AnyType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Parameter", + "properties": { + "Key": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/0" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.ControlTower/EnabledBaselineProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ObjectType", + "name": "AWS.ControlTower/EnabledBaselineProperties", + "properties": { + "BaselineIdentifier": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + }, + "BaselineVersion": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + }, + "EnabledBaselineIdentifier": { + "type": { + "$ref": "#/3" + }, + "flags": 18 + }, + "Parameters": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "TargetIdentifier": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ControlTower/EnabledBaseline", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/7" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ControlTower/EnabledBaseline@default", + "scopeType": 0, + "body": { + "$ref": "#/8" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "EnabledControlParameter", + "properties": { + "Key": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/12" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:." + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:." + } + } + }, + { + "$type": "ObjectType", + "name": "EnabledControl_Value", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.ControlTower/EnabledControlProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/10" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/11" + } + }, + { + "$type": "ObjectType", + "name": "AWS.ControlTower/EnabledControlProperties", + "properties": { + "ControlIdentifier": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "Arn of the control." + }, + "Parameters": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "Parameters to configure the enabled control behavior." + }, + "Tags": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "A set of tags to assign to the enabled control." + }, + "TargetIdentifier": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "Arn for Organizational unit to which the control needs to be applied" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ControlTower/EnabledControl", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/16" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ControlTower/EnabledControl@default", + "scopeType": 0, + "body": { + "$ref": "#/17" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "LandingZoneDriftStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LandingZoneStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.ControlTower/LandingZoneProperties" + }, + { + "$type": "ObjectType", + "name": "LandingZone_Manifest", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/21" + } + }, + { + "$type": "ObjectType", + "name": "AWS.ControlTower/LandingZoneProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/3" + }, + "flags": 2 + }, + "DriftStatus": { + "type": { + "$ref": "#/3" + }, + "flags": 2 + }, + "LandingZoneIdentifier": { + "type": { + "$ref": "#/3" + }, + "flags": 18 + }, + "LatestAvailableVersion": { + "type": { + "$ref": "#/3" + }, + "flags": 2 + }, + "Manifest": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + }, + "Status": { + "type": { + "$ref": "#/3" + }, + "flags": 2 + }, + "Tags": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "Version": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ControlTower/LandingZone", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/25" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ControlTower/LandingZone@default", + "scopeType": 0, + "body": { + "$ref": "#/26" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.controltower/default/types.md b/artifacts/bicep/aws/aws.controltower/default/types.md index dd04fe8f..20dddaa9 100644 --- a/artifacts/bicep/aws/aws.controltower/default/types.md +++ b/artifacts/bicep/aws/aws.controltower/default/types.md @@ -1,32 +1,44 @@ # AWS.ControlTower @ default +## Resource AWS.ControlTower/EnabledBaseline@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.ControlTower/EnabledBaselineProperties](#awscontroltowerenabledbaselineproperties) (Required, Identifier): properties of the resource + ## Resource AWS.ControlTower/EnabledControl@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ControlTower/EnabledControlProperties](#awscontroltowerenabledcontrolproperties) (Required): properties of the resource +* **properties**: [AWS.ControlTower/EnabledControlProperties](#awscontroltowerenabledcontrolproperties) (Required, Identifier): properties of the resource ## Resource AWS.ControlTower/LandingZone@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ControlTower/LandingZoneProperties](#awscontroltowerlandingzoneproperties) (Required): properties of the resource +* **properties**: [AWS.ControlTower/LandingZoneProperties](#awscontroltowerlandingzoneproperties) (Required, Identifier): properties of the resource -## AWS.ControlTower/EnabledControlProperties +## AnyType ### Properties -* **ControlIdentifier**: string (Required, Identifier): Arn of the control. -* **Parameters**: [EnabledControlParameter](#enabledcontrolparameter)[]: Parameters to configure the enabled control behavior. -* **TargetIdentifier**: string (Required, Identifier): Arn for Organizational unit to which the control needs to be applied -## EnabledControlParameter +## AWS.ControlTower/EnabledBaselineProperties ### Properties -* **Key**: string (Required) -* **Value**: [EnabledControl_Value](#enabledcontrolvalue) (Required) +* **BaselineIdentifier**: string (Required) +* **BaselineVersion**: string (Required) +* **EnabledBaselineIdentifier**: string (ReadOnly, Identifier) +* **Parameters**: [Parameter](#parameter)[] +* **Tags**: [Tag](#tag)[] +* **TargetIdentifier**: string (Required) -## EnabledControl_Value +## AWS.ControlTower/EnabledControlProperties ### Properties +* **ControlIdentifier**: string (Required, Identifier): Arn of the control. +* **Parameters**: [EnabledControlParameter](#enabledcontrolparameter)[]: Parameters to configure the enabled control behavior. +* **Tags**: [Tag](#tag)[]: A set of tags to assign to the enabled control. +* **TargetIdentifier**: string (Required, Identifier): Arn for Organizational unit to which the control needs to be applied ## AWS.ControlTower/LandingZoneProperties ### Properties @@ -39,9 +51,32 @@ * **Tags**: [Tag](#tag)[] * **Version**: string (Required) +## EnabledControl_Value +### Properties + +## EnabledControlParameter +### Properties +* **Key**: string (Required) +* **Value**: [EnabledControl_Value](#enabledcontrolvalue) (Required) + ## LandingZone_Manifest ### Properties +## Parameter +### Properties +* **Key**: string +* **Value**: [AnyType](#anytype) + +## Tag +### Properties +* **Key**: string +* **Value**: string + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. + ## Tag ### Properties * **Key**: string diff --git a/artifacts/bicep/aws/aws.customerprofiles/default/types.json b/artifacts/bicep/aws/aws.customerprofiles/default/types.json index 8d06def9..dcb91432 100644 --- a/artifacts/bicep/aws/aws.customerprofiles/default/types.json +++ b/artifacts/bicep/aws/aws.customerprofiles/default/types.json @@ -1 +1,1837 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"AttributeDetails","Properties":{"Attributes":{"Type":28,"Flags":1},"Expression":{"Type":4,"Flags":1}}}},{"2":{"Name":"AttributeItem","Properties":{"Name":{"Type":4,"Flags":1}}}},{"2":{"Name":"AttributeList"}},{"2":{"Name":"AttributeName"}},{"2":{"Name":"CalculatedAttributeName"}},{"2":{"Name":"Conditions","Properties":{"ObjectCount":{"Type":3,"Flags":0},"Range":{"Type":19,"Flags":0},"Threshold":{"Type":25,"Flags":0}}}},{"2":{"Name":"Description"}},{"2":{"Name":"DisplayName"}},{"2":{"Name":"DomainName"}},{"2":{"Name":"Expression"}},{"2":{"Name":"ObjectCount"}},{"2":{"Name":"Range","Properties":{"Unit":{"Type":4,"Flags":1},"Value":{"Type":3,"Flags":1}}}},{"2":{"Name":"RangeUnit"}},{"2":{"Name":"RangeValue"}},{"2":{"Name":"Statistic"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"Tags"}},{"2":{"Name":"Threshold","Properties":{"Operator":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"ThresholdOperator"}},{"2":{"Name":"ThresholdValue"}},{"3":{"ItemType":9}},{"3":{"ItemType":9}},{"3":{"ItemType":23}},{"2":{"Name":"AWS.CustomerProfiles/CalculatedAttributeDefinitionProperties","Properties":{"AttributeDetails":{"Type":8,"Flags":1},"CalculatedAttributeName":{"Type":4,"Flags":17},"Conditions":{"Type":13,"Flags":0},"CreatedAt":{"Type":4,"Flags":2,"Description":"The timestamp of when the calculated attribute definition was created."},"Description":{"Type":4,"Flags":0},"DisplayName":{"Type":4,"Flags":0},"DomainName":{"Type":4,"Flags":17},"LastUpdatedAt":{"Type":4,"Flags":2,"Description":"The timestamp of when the calculated attribute definition was most recently edited."},"Statistic":{"Type":4,"Flags":1},"Tags":{"Type":32,"Flags":0}}}},{"3":{"ItemType":23}},{"2":{"Name":"AWS.CustomerProfiles/CalculatedAttributeDefinition","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":31,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.CustomerProfiles/CalculatedAttributeDefinition@default","ScopeType":0,"Body":33}},{"2":{"Name":"AttributeTypesSelector","Properties":{"Address":{"Type":49,"Flags":0,"Description":"The Address type. You can choose from Address, BusinessAddress, MaillingAddress, and ShippingAddress. You only can use the Address type in the MatchingRule. For example, if you want to match profile based on BusinessAddress.City or MaillingAddress.City, you need to choose the BusinessAddress and the MaillingAddress to represent the Address type and specify the Address.City on the matching rule."},"AttributeMatchingModel":{"Type":4,"Flags":1,"Description":"Configures the AttributeMatchingModel, you can either choose ONE_TO_ONE or MANY_TO_MANY."},"EmailAddress":{"Type":50,"Flags":0,"Description":"The Email type. You can choose from EmailAddress, BusinessEmailAddress and PersonalEmailAddress. You only can use the EmailAddress type in the MatchingRule. For example, if you want to match profile based on PersonalEmailAddress or BusinessEmailAddress, you need to choose the PersonalEmailAddress and the BusinessEmailAddress to represent the EmailAddress type and only specify the EmailAddress on the matching rule."},"PhoneNumber":{"Type":51,"Flags":0,"Description":"The PhoneNumber type. You can choose from PhoneNumber, HomePhoneNumber, and MobilePhoneNumber. You only can use the PhoneNumber type in the MatchingRule. For example, if you want to match a profile based on Phone or HomePhone, you need to choose the Phone and the HomePhone to represent the PhoneNumber type and only specify the PhoneNumber on the matching rule."}}}},{"2":{"Name":"AutoMerging","Properties":{"ConflictResolution":{"Type":37,"Flags":0},"Consolidation":{"Type":38,"Flags":0},"Enabled":{"Type":2,"Flags":1,"Description":"The flag that enables the auto-merging of duplicate profiles."},"MinAllowedConfidenceScoreForMerging":{"Type":3,"Flags":0,"Description":"A number between 0 and 1 that represents the minimum confidence score required for profiles within a matching group to be merged during the auto-merge process. A higher score means higher similarity required to merge profiles."}}}},{"2":{"Name":"ConflictResolution","Properties":{"ConflictResolvingModel":{"Type":4,"Flags":1,"Description":"How the auto-merging process should resolve conflicts between different profiles."},"SourceName":{"Type":4,"Flags":0,"Description":"The ObjectType name that is used to resolve profile merging conflicts when choosing SOURCE as the ConflictResolvingModel."}}}},{"2":{"Name":"Consolidation","Properties":{"MatchingAttributesList":{"Type":53,"Flags":1,"Description":"A list of matching criteria."}}}},{"2":{"Name":"DomainStats","Properties":{"MeteringProfileCount":{"Type":3,"Flags":0,"Description":"The number of profiles that you are currently paying for in the domain. If you have more than 100 objects associated with a single profile, that profile counts as two profiles. If you have more than 200 objects, that profile counts as three, and so on."},"ObjectCount":{"Type":3,"Flags":0,"Description":"The total number of objects in domain."},"ProfileCount":{"Type":3,"Flags":0,"Description":"The total number of profiles currently in the domain."},"TotalSize":{"Type":3,"Flags":0,"Description":"The total size, in bytes, of all objects in the domain."}}}},{"2":{"Name":"ExportingConfig","Properties":{"S3Exporting":{"Type":47,"Flags":0}}}},{"2":{"Name":"JobSchedule","Properties":{"DayOfTheWeek":{"Type":4,"Flags":1,"Description":"The day when the Identity Resolution Job should run every week."},"Time":{"Type":4,"Flags":1,"Description":"The time when the Identity Resolution Job should run every week."}}}},{"2":{"Name":"Matching","Properties":{"AutoMerging":{"Type":36,"Flags":0},"Enabled":{"Type":2,"Flags":1,"Description":"The flag that enables the matching process of duplicate profiles."},"ExportingConfig":{"Type":40,"Flags":0},"JobSchedule":{"Type":41,"Flags":0}}}},{"2":{"Name":"MatchingAttributes"}},{"2":{"Name":"MatchingRule","Properties":{"Rule":{"Type":55,"Flags":1}}}},{"2":{"Name":"MatchingRuleAttributeList"}},{"2":{"Name":"RuleBasedMatching","Properties":{"AttributeTypesSelector":{"Type":35,"Flags":0},"ConflictResolution":{"Type":37,"Flags":0},"Enabled":{"Type":2,"Flags":1,"Description":"The flag that enables the rule-based matching process of duplicate profiles."},"ExportingConfig":{"Type":40,"Flags":0},"MatchingRules":{"Type":57,"Flags":0,"Description":"Configures how the rule-based matching process should match profiles. You can have up to 15 MatchingRule in the MatchingRules."},"MaxAllowedRuleLevelForMatching":{"Type":3,"Flags":0,"Description":"Indicates the maximum allowed rule level for matching."},"MaxAllowedRuleLevelForMerging":{"Type":3,"Flags":0,"Description":"Indicates the maximum allowed rule level for merging."},"Status":{"Type":4,"Flags":2}}}},{"2":{"Name":"S3ExportingConfig","Properties":{"S3BucketName":{"Type":4,"Flags":1,"Description":"The name of the S3 bucket where Identity Resolution Jobs write result files."},"S3KeyName":{"Type":4,"Flags":0,"Description":"The S3 key name of the location where Identity Resolution Jobs write result files."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":52}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":44}},{"2":{"Name":"AWS.CustomerProfiles/DomainProperties","Properties":{"CreatedAt":{"Type":4,"Flags":2,"Description":"The time of this integration got created"},"DeadLetterQueueUrl":{"Type":4,"Flags":0,"Description":"The URL of the SQS dead letter queue"},"DefaultEncryptionKey":{"Type":4,"Flags":0,"Description":"The default encryption key"},"DefaultExpirationDays":{"Type":3,"Flags":0,"Description":"The default number of days until the data within the domain expires."},"DomainName":{"Type":4,"Flags":17,"Description":"The unique name of the domain."},"LastUpdatedAt":{"Type":4,"Flags":2,"Description":"The time of this integration got last updated at"},"Matching":{"Type":42,"Flags":0},"RuleBasedMatching":{"Type":46,"Flags":0},"Stats":{"Type":39,"Flags":2},"Tags":{"Type":59,"Flags":0,"Description":"The tags (keys and values) associated with the domain"}}}},{"3":{"ItemType":48}},{"2":{"Name":"AWS.CustomerProfiles/Domain","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":58,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.CustomerProfiles/Domain@default","ScopeType":0,"Body":60}},{"2":{"Name":"Status"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"Uri"}},{"2":{"Name":"AWS.CustomerProfiles/EventStreamProperties","Properties":{"CreatedAt":{"Type":4,"Flags":2,"Description":"The timestamp of when the export was created."},"DestinationDetails":{"Type":66,"Flags":2,"Description":"Details regarding the Kinesis stream."},"DomainName":{"Type":4,"Flags":17,"Description":"The unique name of the domain."},"EventStreamArn":{"Type":4,"Flags":2,"Description":"A unique identifier for the event stream."},"EventStreamName":{"Type":4,"Flags":17,"Description":"The name of the event stream."},"State":{"Type":4,"Flags":2,"Description":"The operational state of destination stream for export."},"Tags":{"Type":67,"Flags":0,"Description":"The tags used to organize, track, or control access for this resource."},"Uri":{"Type":4,"Flags":1}}}},{"2":{"Name":"EventStream_DestinationDetails","Properties":{"Status":{"Type":4,"Flags":1},"Uri":{"Type":4,"Flags":1}}}},{"3":{"ItemType":63}},{"2":{"Name":"AWS.CustomerProfiles/EventStream","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":65,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.CustomerProfiles/EventStream@default","ScopeType":0,"Body":68}},{"2":{"Name":"ConnectorOperator","Properties":{"Marketo":{"Type":4,"Flags":0},"S3":{"Type":4,"Flags":0},"Salesforce":{"Type":4,"Flags":0},"ServiceNow":{"Type":4,"Flags":0},"Zendesk":{"Type":4,"Flags":0}}}},{"2":{"Name":"ConnectorType"}},{"2":{"Name":"Date"}},{"2":{"Name":"DestinationField"}},{"2":{"Name":"FlowDefinition","Properties":{"Description":{"Type":4,"Flags":0},"FlowName":{"Type":4,"Flags":1},"KmsArn":{"Type":4,"Flags":1},"SourceFlowConfig":{"Type":90,"Flags":1},"Tasks":{"Type":100,"Flags":1},"TriggerConfig":{"Type":95,"Flags":1}}}},{"2":{"Name":"IncrementalPullConfig","Properties":{"DatetimeTypeFieldName":{"Type":4,"Flags":0}}}},{"2":{"Name":"MarketoConnectorOperator"}},{"2":{"Name":"MarketoSourceProperties","Properties":{"Object":{"Type":4,"Flags":1}}}},{"2":{"Name":"Object"}},{"2":{"Name":"ObjectTypeMapping","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"Operator"}},{"2":{"Name":"OperatorPropertiesKeys"}},{"2":{"Name":"S3ConnectorOperator"}},{"2":{"Name":"S3SourceProperties","Properties":{"BucketName":{"Type":4,"Flags":1},"BucketPrefix":{"Type":4,"Flags":0}}}},{"2":{"Name":"SalesforceConnectorOperator"}},{"2":{"Name":"SalesforceSourceProperties","Properties":{"EnableDynamicFieldUpdate":{"Type":2,"Flags":0},"IncludeDeletedRecords":{"Type":2,"Flags":0},"Object":{"Type":4,"Flags":1}}}},{"2":{"Name":"ScheduledTriggerProperties","Properties":{"DataPullMode":{"Type":4,"Flags":0},"FirstExecutionFrom":{"Type":3,"Flags":0},"ScheduleEndTime":{"Type":3,"Flags":0},"ScheduleExpression":{"Type":4,"Flags":1},"ScheduleOffset":{"Type":3,"Flags":0},"ScheduleStartTime":{"Type":3,"Flags":0},"Timezone":{"Type":4,"Flags":0}}}},{"2":{"Name":"ServiceNowConnectorOperator"}},{"2":{"Name":"ServiceNowSourceProperties","Properties":{"Object":{"Type":4,"Flags":1}}}},{"2":{"Name":"SourceConnectorProperties","Properties":{"Marketo":{"Type":77,"Flags":0},"S3":{"Type":83,"Flags":0},"Salesforce":{"Type":85,"Flags":0},"ServiceNow":{"Type":88,"Flags":0},"Zendesk":{"Type":99,"Flags":0}}}},{"2":{"Name":"SourceFlowConfig","Properties":{"ConnectorProfileName":{"Type":4,"Flags":0},"ConnectorType":{"Type":4,"Flags":1},"IncrementalPullConfig":{"Type":75,"Flags":0},"SourceConnectorProperties":{"Type":89,"Flags":1}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"Task","Properties":{"ConnectorOperator":{"Type":70,"Flags":0},"DestinationField":{"Type":4,"Flags":0},"SourceFields":{"Type":101,"Flags":1},"TaskProperties":{"Type":102,"Flags":0},"TaskType":{"Type":4,"Flags":1}}}},{"2":{"Name":"TaskPropertiesMap","Properties":{"OperatorPropertyKey":{"Type":4,"Flags":1},"Property":{"Type":4,"Flags":1}}}},{"2":{"Name":"TaskType"}},{"2":{"Name":"TriggerConfig","Properties":{"TriggerProperties":{"Type":96,"Flags":0},"TriggerType":{"Type":4,"Flags":1}}}},{"2":{"Name":"TriggerProperties","Properties":{"Scheduled":{"Type":86,"Flags":0}}}},{"2":{"Name":"TriggerType"}},{"2":{"Name":"ZendeskConnectorOperator"}},{"2":{"Name":"ZendeskSourceProperties","Properties":{"Object":{"Type":4,"Flags":1}}}},{"3":{"ItemType":92}},{"3":{"ItemType":4}},{"3":{"ItemType":93}},{"2":{"Name":"AWS.CustomerProfiles/IntegrationProperties","Properties":{"CreatedAt":{"Type":4,"Flags":2,"Description":"The time of this integration got created"},"DomainName":{"Type":4,"Flags":17,"Description":"The unique name of the domain."},"FlowDefinition":{"Type":74,"Flags":4},"LastUpdatedAt":{"Type":4,"Flags":2,"Description":"The time of this integration got last updated at"},"ObjectTypeName":{"Type":4,"Flags":0,"Description":"The name of the ObjectType defined for the 3rd party data in Profile Service"},"ObjectTypeNames":{"Type":104,"Flags":0,"Description":"The mapping between 3rd party event types and ObjectType names"},"Tags":{"Type":105,"Flags":0,"Description":"The tags (keys and values) associated with the integration"},"Uri":{"Type":4,"Flags":16,"Description":"The URI of the S3 bucket or any other type of data source."}}}},{"3":{"ItemType":79}},{"3":{"ItemType":91}},{"2":{"Name":"AWS.CustomerProfiles/Integration","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":103,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.CustomerProfiles/Integration@default","ScopeType":0,"Body":106}},{"2":{"Name":"FieldMap","Properties":{"Name":{"Type":4,"Flags":0},"ObjectTypeField":{"Type":110,"Flags":0}}}},{"2":{"Name":"KeyMap","Properties":{"Name":{"Type":4,"Flags":0},"ObjectTypeKeyList":{"Type":113,"Flags":0}}}},{"2":{"Name":"ObjectTypeField","Properties":{"ContentType":{"Type":4,"Flags":0,"Description":"The content type of the field. Used for determining equality when searching."},"Source":{"Type":4,"Flags":0,"Description":"A field of a ProfileObject. For example: _source.FirstName, where \"_source\" is a ProfileObjectType of a Zendesk user and \"FirstName\" is a field in that ObjectType."},"Target":{"Type":4,"Flags":0,"Description":"The location of the data in the standard ProfileObject model. For example: _profile.Address.PostalCode."}}}},{"2":{"Name":"ObjectTypeKey","Properties":{"FieldNames":{"Type":114,"Flags":0,"Description":"The reference for the key name of the fields map. "},"StandardIdentifiers":{"Type":115,"Flags":0,"Description":"The types of keys that a ProfileObject can have. Each ProfileObject can have only 1 UNIQUE key but multiple PROFILE keys. PROFILE means that this key can be used to tie an object to a PROFILE. UNIQUE means that it can be used to uniquely identify an object. If a key a is marked as SECONDARY, it will be used to search for profiles after all other PROFILE keys have been searched. A LOOKUP_ONLY key is only used to match a profile but is not persisted to be used for searching of the profile. A NEW_ONLY key is only used if the profile does not already exist before the object is ingested, otherwise it is only used for matching objects to profiles."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"3":{"ItemType":111}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.CustomerProfiles/ObjectTypeProperties","Properties":{"AllowProfileCreation":{"Type":2,"Flags":0,"Description":"Indicates whether a profile should be created when data is received."},"CreatedAt":{"Type":4,"Flags":2,"Description":"The time of this integration got created."},"Description":{"Type":4,"Flags":0,"Description":"Description of the profile object type."},"DomainName":{"Type":4,"Flags":17,"Description":"The unique name of the domain."},"EncryptionKey":{"Type":4,"Flags":0,"Description":"The default encryption key"},"ExpirationDays":{"Type":3,"Flags":0,"Description":"The default number of days until the data within the domain expires."},"Fields":{"Type":117,"Flags":0,"Description":"A list of the name and ObjectType field."},"Keys":{"Type":118,"Flags":0,"Description":"A list of unique keys that can be used to map data to the profile."},"LastUpdatedAt":{"Type":4,"Flags":2,"Description":"The time of this integration got last updated at."},"ObjectTypeName":{"Type":4,"Flags":16,"Description":"The name of the profile object type."},"SourceLastUpdatedTimestampFormat":{"Type":4,"Flags":0,"Description":"The format of your sourceLastUpdatedTimestamp that was previously set up."},"Tags":{"Type":119,"Flags":0,"Description":"The tags (keys and values) associated with the integration."},"TemplateId":{"Type":4,"Flags":0,"Description":"A unique identifier for the object template."}}}},{"3":{"ItemType":108}},{"3":{"ItemType":109}},{"3":{"ItemType":112}},{"2":{"Name":"AWS.CustomerProfiles/ObjectType","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":116,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.CustomerProfiles/ObjectType@default","ScopeType":0,"Body":120}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "AttributeDetails", + "properties": { + "Attributes": { + "type": { + "$ref": "#/20" + }, + "flags": 1 + }, + "Expression": { + "type": { + "$ref": "#/21" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AttributeItem", + "properties": { + "Name": { + "type": { + "$ref": "#/21" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AttributeList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AttributeName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CalculatedAttributeName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Conditions", + "properties": { + "ObjectCount": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "Range": { + "type": { + "$ref": "#/11" + }, + "flags": 0 + }, + "Threshold": { + "type": { + "$ref": "#/17" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Description", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DisplayName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DomainName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Expression", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ObjectCount", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Range", + "properties": { + "Unit": { + "type": { + "$ref": "#/21" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "RangeUnit", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RangeValue", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Statistic", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/21" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/21" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "ObjectType", + "name": "Tags", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Threshold", + "properties": { + "Operator": { + "type": { + "$ref": "#/21" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/21" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ThresholdOperator", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ThresholdValue", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/15" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.CustomerProfiles/CalculatedAttributeDefinitionProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/15" + } + }, + { + "$type": "ObjectType", + "name": "AWS.CustomerProfiles/CalculatedAttributeDefinitionProperties", + "properties": { + "AttributeDetails": { + "type": { + "$ref": "#/0" + }, + "flags": 1 + }, + "CalculatedAttributeName": { + "type": { + "$ref": "#/21" + }, + "flags": 17 + }, + "Conditions": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "CreatedAt": { + "type": { + "$ref": "#/21" + }, + "flags": 2, + "description": "The timestamp of when the calculated attribute definition was created." + }, + "Description": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "DisplayName": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "DomainName": { + "type": { + "$ref": "#/21" + }, + "flags": 17 + }, + "LastUpdatedAt": { + "type": { + "$ref": "#/21" + }, + "flags": 2, + "description": "The timestamp of when the calculated attribute definition was most recently edited." + }, + "Statistic": { + "type": { + "$ref": "#/21" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/26" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.CustomerProfiles/CalculatedAttributeDefinition", + "properties": { + "name": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/21" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/27" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.CustomerProfiles/CalculatedAttributeDefinition@default", + "scopeType": 0, + "body": { + "$ref": "#/28" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AttributeTypesSelector", + "properties": { + "Address": { + "type": { + "$ref": "#/44" + }, + "flags": 0, + "description": "The Address type. You can choose from Address, BusinessAddress, MaillingAddress, and ShippingAddress. You only can use the Address type in the MatchingRule. For example, if you want to match profile based on BusinessAddress.City or MaillingAddress.City, you need to choose the BusinessAddress and the MaillingAddress to represent the Address type and specify the Address.City on the matching rule." + }, + "AttributeMatchingModel": { + "type": { + "$ref": "#/21" + }, + "flags": 1, + "description": "Configures the AttributeMatchingModel, you can either choose ONE_TO_ONE or MANY_TO_MANY." + }, + "EmailAddress": { + "type": { + "$ref": "#/45" + }, + "flags": 0, + "description": "The Email type. You can choose from EmailAddress, BusinessEmailAddress and PersonalEmailAddress. You only can use the EmailAddress type in the MatchingRule. For example, if you want to match profile based on PersonalEmailAddress or BusinessEmailAddress, you need to choose the PersonalEmailAddress and the BusinessEmailAddress to represent the EmailAddress type and only specify the EmailAddress on the matching rule." + }, + "PhoneNumber": { + "type": { + "$ref": "#/46" + }, + "flags": 0, + "description": "The PhoneNumber type. You can choose from PhoneNumber, HomePhoneNumber, and MobilePhoneNumber. You only can use the PhoneNumber type in the MatchingRule. For example, if you want to match a profile based on Phone or HomePhone, you need to choose the Phone and the HomePhone to represent the PhoneNumber type and only specify the PhoneNumber on the matching rule." + } + } + }, + { + "$type": "ObjectType", + "name": "AutoMerging", + "properties": { + "ConflictResolution": { + "type": { + "$ref": "#/32" + }, + "flags": 0 + }, + "Consolidation": { + "type": { + "$ref": "#/33" + }, + "flags": 0 + }, + "Enabled": { + "type": { + "$ref": "#/47" + }, + "flags": 1, + "description": "The flag that enables the auto-merging of duplicate profiles." + }, + "MinAllowedConfidenceScoreForMerging": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "A number between 0 and 1 that represents the minimum confidence score required for profiles within a matching group to be merged during the auto-merge process. A higher score means higher similarity required to merge profiles." + } + } + }, + { + "$type": "ObjectType", + "name": "ConflictResolution", + "properties": { + "ConflictResolvingModel": { + "type": { + "$ref": "#/21" + }, + "flags": 1, + "description": "How the auto-merging process should resolve conflicts between different profiles." + }, + "SourceName": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "The ObjectType name that is used to resolve profile merging conflicts when choosing SOURCE as the ConflictResolvingModel." + } + } + }, + { + "$type": "ObjectType", + "name": "Consolidation", + "properties": { + "MatchingAttributesList": { + "type": { + "$ref": "#/49" + }, + "flags": 1, + "description": "A list of matching criteria." + } + } + }, + { + "$type": "ObjectType", + "name": "DomainStats", + "properties": { + "MeteringProfileCount": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "The number of profiles that you are currently paying for in the domain. If you have more than 100 objects associated with a single profile, that profile counts as two profiles. If you have more than 200 objects, that profile counts as three, and so on." + }, + "ObjectCount": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "The total number of objects in domain." + }, + "ProfileCount": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "The total number of profiles currently in the domain." + }, + "TotalSize": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "The total size, in bytes, of all objects in the domain." + } + } + }, + { + "$type": "ObjectType", + "name": "ExportingConfig", + "properties": { + "S3Exporting": { + "type": { + "$ref": "#/42" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "JobSchedule", + "properties": { + "DayOfTheWeek": { + "type": { + "$ref": "#/21" + }, + "flags": 1, + "description": "The day when the Identity Resolution Job should run every week." + }, + "Time": { + "type": { + "$ref": "#/21" + }, + "flags": 1, + "description": "The time when the Identity Resolution Job should run every week." + } + } + }, + { + "$type": "ObjectType", + "name": "Matching", + "properties": { + "AutoMerging": { + "type": { + "$ref": "#/31" + }, + "flags": 0 + }, + "Enabled": { + "type": { + "$ref": "#/47" + }, + "flags": 1, + "description": "The flag that enables the matching process of duplicate profiles." + }, + "ExportingConfig": { + "type": { + "$ref": "#/35" + }, + "flags": 0 + }, + "JobSchedule": { + "type": { + "$ref": "#/36" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "MatchingAttributes", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MatchingRule", + "properties": { + "Rule": { + "type": { + "$ref": "#/51" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "MatchingRuleAttributeList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RuleBasedMatching", + "properties": { + "AttributeTypesSelector": { + "type": { + "$ref": "#/30" + }, + "flags": 0 + }, + "ConflictResolution": { + "type": { + "$ref": "#/32" + }, + "flags": 0 + }, + "Enabled": { + "type": { + "$ref": "#/47" + }, + "flags": 1, + "description": "The flag that enables the rule-based matching process of duplicate profiles." + }, + "ExportingConfig": { + "type": { + "$ref": "#/35" + }, + "flags": 0 + }, + "MatchingRules": { + "type": { + "$ref": "#/53" + }, + "flags": 0, + "description": "Configures how the rule-based matching process should match profiles. You can have up to 15 MatchingRule in the MatchingRules." + }, + "MaxAllowedRuleLevelForMatching": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "Indicates the maximum allowed rule level for matching." + }, + "MaxAllowedRuleLevelForMerging": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "Indicates the maximum allowed rule level for merging." + }, + "Status": { + "type": { + "$ref": "#/21" + }, + "flags": 2 + } + } + }, + { + "$type": "ObjectType", + "name": "S3ExportingConfig", + "properties": { + "S3BucketName": { + "type": { + "$ref": "#/21" + }, + "flags": 1, + "description": "The name of the S3 bucket where Identity Resolution Jobs write result files." + }, + "S3KeyName": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "The S3 key name of the location where Identity Resolution Jobs write result files." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/21" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/21" + }, + "flags": 1 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/21" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/21" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/21" + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/21" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/48" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/21" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/21" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/21" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/39" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.CustomerProfiles/DomainProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/43" + } + }, + { + "$type": "ObjectType", + "name": "AWS.CustomerProfiles/DomainProperties", + "properties": { + "CreatedAt": { + "type": { + "$ref": "#/21" + }, + "flags": 2, + "description": "The time of this integration got created" + }, + "DeadLetterQueueUrl": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "The URL of the SQS dead letter queue" + }, + "DefaultEncryptionKey": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "The default encryption key" + }, + "DefaultExpirationDays": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "The default number of days until the data within the domain expires." + }, + "DomainName": { + "type": { + "$ref": "#/21" + }, + "flags": 17, + "description": "The unique name of the domain." + }, + "LastUpdatedAt": { + "type": { + "$ref": "#/21" + }, + "flags": 2, + "description": "The time of this integration got last updated at" + }, + "Matching": { + "type": { + "$ref": "#/37" + }, + "flags": 0 + }, + "RuleBasedMatching": { + "type": { + "$ref": "#/41" + }, + "flags": 0 + }, + "Stats": { + "type": { + "$ref": "#/34" + }, + "flags": 2 + }, + "Tags": { + "type": { + "$ref": "#/55" + }, + "flags": 0, + "description": "The tags (keys and values) associated with the domain" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.CustomerProfiles/Domain", + "properties": { + "name": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/21" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/56" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.CustomerProfiles/Domain@default", + "scopeType": 0, + "body": { + "$ref": "#/57" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Status", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/21" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/21" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "ObjectType", + "name": "Uri", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.CustomerProfiles/EventStreamProperties" + }, + { + "$type": "ObjectType", + "name": "EventStream_DestinationDetails", + "properties": { + "Status": { + "type": { + "$ref": "#/21" + }, + "flags": 1 + }, + "Uri": { + "type": { + "$ref": "#/21" + }, + "flags": 1 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/60" + } + }, + { + "$type": "ObjectType", + "name": "AWS.CustomerProfiles/EventStreamProperties", + "properties": { + "CreatedAt": { + "type": { + "$ref": "#/21" + }, + "flags": 2, + "description": "The timestamp of when the export was created." + }, + "DestinationDetails": { + "type": { + "$ref": "#/63" + }, + "flags": 2, + "description": "Details regarding the Kinesis stream." + }, + "DomainName": { + "type": { + "$ref": "#/21" + }, + "flags": 17, + "description": "The unique name of the domain." + }, + "EventStreamArn": { + "type": { + "$ref": "#/21" + }, + "flags": 2, + "description": "A unique identifier for the event stream." + }, + "EventStreamName": { + "type": { + "$ref": "#/21" + }, + "flags": 17, + "description": "The name of the event stream." + }, + "State": { + "type": { + "$ref": "#/21" + }, + "flags": 2, + "description": "The operational state of destination stream for export." + }, + "Tags": { + "type": { + "$ref": "#/64" + }, + "flags": 0, + "description": "The tags used to organize, track, or control access for this resource." + }, + "Uri": { + "type": { + "$ref": "#/21" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.CustomerProfiles/EventStream", + "properties": { + "name": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/21" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/65" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.CustomerProfiles/EventStream@default", + "scopeType": 0, + "body": { + "$ref": "#/66" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "ConnectorOperator", + "properties": { + "Marketo": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "S3": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "Salesforce": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "ServiceNow": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "Zendesk": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ConnectorType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Date", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DestinationField", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "FlowDefinition", + "properties": { + "Description": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "FlowName": { + "type": { + "$ref": "#/21" + }, + "flags": 1 + }, + "KmsArn": { + "type": { + "$ref": "#/21" + }, + "flags": 1 + }, + "SourceFlowConfig": { + "type": { + "$ref": "#/88" + }, + "flags": 1 + }, + "Tasks": { + "type": { + "$ref": "#/98" + }, + "flags": 1 + }, + "TriggerConfig": { + "type": { + "$ref": "#/93" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "IncrementalPullConfig", + "properties": { + "DatetimeTypeFieldName": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "MarketoConnectorOperator", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MarketoSourceProperties", + "properties": { + "Object": { + "type": { + "$ref": "#/21" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Object", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ObjectTypeMapping", + "properties": { + "Key": { + "type": { + "$ref": "#/21" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/21" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Operator", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "OperatorPropertiesKeys", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "S3ConnectorOperator", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "S3SourceProperties", + "properties": { + "BucketName": { + "type": { + "$ref": "#/21" + }, + "flags": 1 + }, + "BucketPrefix": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SalesforceConnectorOperator", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SalesforceSourceProperties", + "properties": { + "EnableDynamicFieldUpdate": { + "type": { + "$ref": "#/47" + }, + "flags": 0 + }, + "IncludeDeletedRecords": { + "type": { + "$ref": "#/47" + }, + "flags": 0 + }, + "Object": { + "type": { + "$ref": "#/21" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ScheduledTriggerProperties", + "properties": { + "DataPullMode": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "FirstExecutionFrom": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "ScheduleEndTime": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "ScheduleExpression": { + "type": { + "$ref": "#/21" + }, + "flags": 1 + }, + "ScheduleOffset": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "ScheduleStartTime": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "Timezone": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ServiceNowConnectorOperator", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ServiceNowSourceProperties", + "properties": { + "Object": { + "type": { + "$ref": "#/21" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "SourceConnectorProperties", + "properties": { + "Marketo": { + "type": { + "$ref": "#/75" + }, + "flags": 0 + }, + "S3": { + "type": { + "$ref": "#/81" + }, + "flags": 0 + }, + "Salesforce": { + "type": { + "$ref": "#/83" + }, + "flags": 0 + }, + "ServiceNow": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + }, + "Zendesk": { + "type": { + "$ref": "#/97" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SourceFlowConfig", + "properties": { + "ConnectorProfileName": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "ConnectorType": { + "type": { + "$ref": "#/21" + }, + "flags": 1 + }, + "IncrementalPullConfig": { + "type": { + "$ref": "#/73" + }, + "flags": 0 + }, + "SourceConnectorProperties": { + "type": { + "$ref": "#/87" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/21" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/21" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Task", + "properties": { + "ConnectorOperator": { + "type": { + "$ref": "#/68" + }, + "flags": 0 + }, + "DestinationField": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "SourceFields": { + "type": { + "$ref": "#/99" + }, + "flags": 1 + }, + "TaskProperties": { + "type": { + "$ref": "#/100" + }, + "flags": 0 + }, + "TaskType": { + "type": { + "$ref": "#/21" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TaskPropertiesMap", + "properties": { + "OperatorPropertyKey": { + "type": { + "$ref": "#/21" + }, + "flags": 1 + }, + "Property": { + "type": { + "$ref": "#/21" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TaskType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TriggerConfig", + "properties": { + "TriggerProperties": { + "type": { + "$ref": "#/94" + }, + "flags": 0 + }, + "TriggerType": { + "type": { + "$ref": "#/21" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TriggerProperties", + "properties": { + "Scheduled": { + "type": { + "$ref": "#/84" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TriggerType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ZendeskConnectorOperator", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ZendeskSourceProperties", + "properties": { + "Object": { + "type": { + "$ref": "#/21" + }, + "flags": 1 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/90" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/21" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/91" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.CustomerProfiles/IntegrationProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/77" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/89" + } + }, + { + "$type": "ObjectType", + "name": "AWS.CustomerProfiles/IntegrationProperties", + "properties": { + "CreatedAt": { + "type": { + "$ref": "#/21" + }, + "flags": 2, + "description": "The time of this integration got created" + }, + "DomainName": { + "type": { + "$ref": "#/21" + }, + "flags": 17, + "description": "The unique name of the domain." + }, + "FlowDefinition": { + "type": { + "$ref": "#/72" + }, + "flags": 4 + }, + "LastUpdatedAt": { + "type": { + "$ref": "#/21" + }, + "flags": 2, + "description": "The time of this integration got last updated at" + }, + "ObjectTypeName": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "The name of the ObjectType defined for the 3rd party data in Profile Service" + }, + "ObjectTypeNames": { + "type": { + "$ref": "#/102" + }, + "flags": 0, + "description": "The mapping between 3rd party event types and ObjectType names" + }, + "Tags": { + "type": { + "$ref": "#/103" + }, + "flags": 0, + "description": "The tags (keys and values) associated with the integration" + }, + "Uri": { + "type": { + "$ref": "#/21" + }, + "flags": 16, + "description": "The URI of the S3 bucket or any other type of data source." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.CustomerProfiles/Integration", + "properties": { + "name": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/21" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/104" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.CustomerProfiles/Integration@default", + "scopeType": 0, + "body": { + "$ref": "#/105" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "FieldMap", + "properties": { + "Name": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "ObjectTypeField": { + "type": { + "$ref": "#/109" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "KeyMap", + "properties": { + "Name": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "ObjectTypeKeyList": { + "type": { + "$ref": "#/112" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ObjectTypeField", + "properties": { + "ContentType": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "The content type of the field. Used for determining equality when searching." + }, + "Source": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "A field of a ProfileObject. For example: _source.FirstName, where \"_source\" is a ProfileObjectType of a Zendesk user and \"FirstName\" is a field in that ObjectType." + }, + "Target": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "The location of the data in the standard ProfileObject model. For example: _profile.Address.PostalCode." + } + } + }, + { + "$type": "ObjectType", + "name": "ObjectTypeKey", + "properties": { + "FieldNames": { + "type": { + "$ref": "#/113" + }, + "flags": 0, + "description": "The reference for the key name of the fields map. " + }, + "StandardIdentifiers": { + "type": { + "$ref": "#/114" + }, + "flags": 0, + "description": "The types of keys that a ProfileObject can have. Each ProfileObject can have only 1 UNIQUE key but multiple PROFILE keys. PROFILE means that this key can be used to tie an object to a PROFILE. UNIQUE means that it can be used to uniquely identify an object. If a key a is marked as SECONDARY, it will be used to search for profiles after all other PROFILE keys have been searched. A LOOKUP_ONLY key is only used to match a profile but is not persisted to be used for searching of the profile. A NEW_ONLY key is only used if the profile does not already exist before the object is ingested, otherwise it is only used for matching objects to profiles." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/21" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/21" + }, + "flags": 1 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/110" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/21" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/21" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.CustomerProfiles/ObjectTypeProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/107" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/108" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/111" + } + }, + { + "$type": "ObjectType", + "name": "AWS.CustomerProfiles/ObjectTypeProperties", + "properties": { + "AllowProfileCreation": { + "type": { + "$ref": "#/47" + }, + "flags": 0, + "description": "Indicates whether a profile should be created when data is received." + }, + "CreatedAt": { + "type": { + "$ref": "#/21" + }, + "flags": 2, + "description": "The time of this integration got created." + }, + "Description": { + "type": { + "$ref": "#/21" + }, + "flags": 1, + "description": "Description of the profile object type." + }, + "DomainName": { + "type": { + "$ref": "#/21" + }, + "flags": 17, + "description": "The unique name of the domain." + }, + "EncryptionKey": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "The default encryption key" + }, + "ExpirationDays": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "The default number of days until the data within the domain expires." + }, + "Fields": { + "type": { + "$ref": "#/116" + }, + "flags": 0, + "description": "A list of the name and ObjectType field." + }, + "Keys": { + "type": { + "$ref": "#/117" + }, + "flags": 0, + "description": "A list of unique keys that can be used to map data to the profile." + }, + "LastUpdatedAt": { + "type": { + "$ref": "#/21" + }, + "flags": 2, + "description": "The time of this integration got last updated at." + }, + "ObjectTypeName": { + "type": { + "$ref": "#/21" + }, + "flags": 17, + "description": "The name of the profile object type." + }, + "SourceLastUpdatedTimestampFormat": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "The format of your sourceLastUpdatedTimestamp that was previously set up." + }, + "Tags": { + "type": { + "$ref": "#/118" + }, + "flags": 0, + "description": "The tags (keys and values) associated with the integration." + }, + "TemplateId": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "A unique identifier for the object template." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.CustomerProfiles/ObjectType", + "properties": { + "name": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/21" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/119" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.CustomerProfiles/ObjectType@default", + "scopeType": 0, + "body": { + "$ref": "#/120" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.customerprofiles/default/types.md b/artifacts/bicep/aws/aws.customerprofiles/default/types.md index ef67eb77..cb3bfe27 100644 --- a/artifacts/bicep/aws/aws.customerprofiles/default/types.md +++ b/artifacts/bicep/aws/aws.customerprofiles/default/types.md @@ -3,50 +3,37 @@ ## Resource AWS.CustomerProfiles/CalculatedAttributeDefinition@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.CustomerProfiles/CalculatedAttributeDefinitionProperties](#awscustomerprofilescalculatedattributedefinitionproperties) (Required): properties of the resource +* **properties**: [AWS.CustomerProfiles/CalculatedAttributeDefinitionProperties](#awscustomerprofilescalculatedattributedefinitionproperties) (Required, Identifier): properties of the resource ## Resource AWS.CustomerProfiles/Domain@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.CustomerProfiles/DomainProperties](#awscustomerprofilesdomainproperties) (Required): properties of the resource +* **properties**: [AWS.CustomerProfiles/DomainProperties](#awscustomerprofilesdomainproperties) (Required, Identifier): properties of the resource ## Resource AWS.CustomerProfiles/EventStream@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.CustomerProfiles/EventStreamProperties](#awscustomerprofileseventstreamproperties) (Required): properties of the resource +* **properties**: [AWS.CustomerProfiles/EventStreamProperties](#awscustomerprofileseventstreamproperties) (Required, Identifier): properties of the resource ## Resource AWS.CustomerProfiles/Integration@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.CustomerProfiles/IntegrationProperties](#awscustomerprofilesintegrationproperties) (Required): properties of the resource +* **properties**: [AWS.CustomerProfiles/IntegrationProperties](#awscustomerprofilesintegrationproperties) (Required, Identifier): properties of the resource ## Resource AWS.CustomerProfiles/ObjectType@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.CustomerProfiles/ObjectTypeProperties](#awscustomerprofilesobjecttypeproperties) (Required): properties of the resource - -## AWS.CustomerProfiles/CalculatedAttributeDefinitionProperties -### Properties -* **AttributeDetails**: [AttributeDetails](#attributedetails) (Required) -* **CalculatedAttributeName**: string (Required, Identifier) -* **Conditions**: [Conditions](#conditions) -* **CreatedAt**: string (ReadOnly): The timestamp of when the calculated attribute definition was created. -* **Description**: string -* **DisplayName**: string -* **DomainName**: string (Required, Identifier) -* **LastUpdatedAt**: string (ReadOnly): The timestamp of when the calculated attribute definition was most recently edited. -* **Statistic**: string (Required) -* **Tags**: [Tag](#tag)[] +* **properties**: [AWS.CustomerProfiles/ObjectTypeProperties](#awscustomerprofilesobjecttypeproperties) (Required, Identifier): properties of the resource ## AttributeDetails ### Properties @@ -57,33 +44,39 @@ ### Properties * **Name**: string (Required) -## Conditions -### Properties -* **ObjectCount**: int -* **Range**: [Range](#range) -* **Threshold**: [Threshold](#threshold) - -## Range +## AttributeTypesSelector ### Properties -* **Unit**: string (Required) -* **Value**: int (Required) +* **Address**: string[]: The Address type. You can choose from Address, BusinessAddress, MaillingAddress, and ShippingAddress. You only can use the Address type in the MatchingRule. For example, if you want to match profile based on BusinessAddress.City or MaillingAddress.City, you need to choose the BusinessAddress and the MaillingAddress to represent the Address type and specify the Address.City on the matching rule. +* **AttributeMatchingModel**: string (Required): Configures the AttributeMatchingModel, you can either choose ONE_TO_ONE or MANY_TO_MANY. +* **EmailAddress**: string[]: The Email type. You can choose from EmailAddress, BusinessEmailAddress and PersonalEmailAddress. You only can use the EmailAddress type in the MatchingRule. For example, if you want to match profile based on PersonalEmailAddress or BusinessEmailAddress, you need to choose the PersonalEmailAddress and the BusinessEmailAddress to represent the EmailAddress type and only specify the EmailAddress on the matching rule. +* **PhoneNumber**: string[]: The PhoneNumber type. You can choose from PhoneNumber, HomePhoneNumber, and MobilePhoneNumber. You only can use the PhoneNumber type in the MatchingRule. For example, if you want to match a profile based on Phone or HomePhone, you need to choose the Phone and the HomePhone to represent the PhoneNumber type and only specify the PhoneNumber on the matching rule. -## Threshold +## AutoMerging ### Properties -* **Operator**: string (Required) -* **Value**: string (Required) +* **ConflictResolution**: [ConflictResolution](#conflictresolution) +* **Consolidation**: [Consolidation](#consolidation) +* **Enabled**: bool (Required): The flag that enables the auto-merging of duplicate profiles. +* **MinAllowedConfidenceScoreForMerging**: int: A number between 0 and 1 that represents the minimum confidence score required for profiles within a matching group to be merged during the auto-merge process. A higher score means higher similarity required to merge profiles. -## Tag +## AWS.CustomerProfiles/CalculatedAttributeDefinitionProperties ### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **AttributeDetails**: [AttributeDetails](#attributedetails) (Required) +* **CalculatedAttributeName**: string (Required, Identifier) +* **Conditions**: [Conditions](#conditions) +* **CreatedAt**: string (ReadOnly): The timestamp of when the calculated attribute definition was created. +* **Description**: string +* **DisplayName**: string +* **DomainName**: string (Required, Identifier) +* **LastUpdatedAt**: string (ReadOnly): The timestamp of when the calculated attribute definition was most recently edited. +* **Statistic**: string (Required) +* **Tags**: [Tag](#tag)[] ## AWS.CustomerProfiles/DomainProperties ### Properties * **CreatedAt**: string (ReadOnly): The time of this integration got created * **DeadLetterQueueUrl**: string: The URL of the SQS dead letter queue * **DefaultEncryptionKey**: string: The default encryption key -* **DefaultExpirationDays**: int: The default number of days until the data within the domain expires. +* **DefaultExpirationDays**: int (Required): The default number of days until the data within the domain expires. * **DomainName**: string (Required, Identifier): The unique name of the domain. * **LastUpdatedAt**: string (ReadOnly): The time of this integration got last updated at * **Matching**: [Matching](#matching) @@ -91,64 +84,66 @@ * **Stats**: [DomainStats](#domainstats) (ReadOnly) * **Tags**: [Tag](#tag)[]: The tags (keys and values) associated with the domain -## Matching -### Properties -* **AutoMerging**: [AutoMerging](#automerging) -* **Enabled**: bool (Required): The flag that enables the matching process of duplicate profiles. -* **ExportingConfig**: [ExportingConfig](#exportingconfig) -* **JobSchedule**: [JobSchedule](#jobschedule) - -## AutoMerging -### Properties -* **ConflictResolution**: [ConflictResolution](#conflictresolution) -* **Consolidation**: [Consolidation](#consolidation) -* **Enabled**: bool (Required): The flag that enables the auto-merging of duplicate profiles. -* **MinAllowedConfidenceScoreForMerging**: int: A number between 0 and 1 that represents the minimum confidence score required for profiles within a matching group to be merged during the auto-merge process. A higher score means higher similarity required to merge profiles. - -## ConflictResolution -### Properties -* **ConflictResolvingModel**: string (Required): How the auto-merging process should resolve conflicts between different profiles. -* **SourceName**: string: The ObjectType name that is used to resolve profile merging conflicts when choosing SOURCE as the ConflictResolvingModel. - -## Consolidation +## AWS.CustomerProfiles/EventStreamProperties ### Properties -* **MatchingAttributesList**: string[][] (Required): A list of matching criteria. +* **CreatedAt**: string (ReadOnly): The timestamp of when the export was created. +* **DestinationDetails**: [EventStream_DestinationDetails](#eventstreamdestinationdetails) (ReadOnly): Details regarding the Kinesis stream. +* **DomainName**: string (Required, Identifier): The unique name of the domain. +* **EventStreamArn**: string (ReadOnly): A unique identifier for the event stream. +* **EventStreamName**: string (Required, Identifier): The name of the event stream. +* **State**: string (ReadOnly): The operational state of destination stream for export. +* **Tags**: [Tag](#tag)[]: The tags used to organize, track, or control access for this resource. +* **Uri**: string (Required) -## ExportingConfig +## AWS.CustomerProfiles/IntegrationProperties ### Properties -* **S3Exporting**: [S3ExportingConfig](#s3exportingconfig) +* **CreatedAt**: string (ReadOnly): The time of this integration got created +* **DomainName**: string (Required, Identifier): The unique name of the domain. +* **FlowDefinition**: [FlowDefinition](#flowdefinition) (WriteOnly) +* **LastUpdatedAt**: string (ReadOnly): The time of this integration got last updated at +* **ObjectTypeName**: string: The name of the ObjectType defined for the 3rd party data in Profile Service +* **ObjectTypeNames**: [ObjectTypeMapping](#objecttypemapping)[]: The mapping between 3rd party event types and ObjectType names +* **Tags**: [Tag](#tag)[]: The tags (keys and values) associated with the integration +* **Uri**: string (Identifier): The URI of the S3 bucket or any other type of data source. -## S3ExportingConfig +## AWS.CustomerProfiles/ObjectTypeProperties ### Properties -* **S3BucketName**: string (Required): The name of the S3 bucket where Identity Resolution Jobs write result files. -* **S3KeyName**: string: The S3 key name of the location where Identity Resolution Jobs write result files. +* **AllowProfileCreation**: bool: Indicates whether a profile should be created when data is received. +* **CreatedAt**: string (ReadOnly): The time of this integration got created. +* **Description**: string (Required): Description of the profile object type. +* **DomainName**: string (Required, Identifier): The unique name of the domain. +* **EncryptionKey**: string: The default encryption key +* **ExpirationDays**: int: The default number of days until the data within the domain expires. +* **Fields**: [FieldMap](#fieldmap)[]: A list of the name and ObjectType field. +* **Keys**: [KeyMap](#keymap)[]: A list of unique keys that can be used to map data to the profile. +* **LastUpdatedAt**: string (ReadOnly): The time of this integration got last updated at. +* **ObjectTypeName**: string (Required, Identifier): The name of the profile object type. +* **SourceLastUpdatedTimestampFormat**: string: The format of your sourceLastUpdatedTimestamp that was previously set up. +* **Tags**: [Tag](#tag)[]: The tags (keys and values) associated with the integration. +* **TemplateId**: string: A unique identifier for the object template. -## JobSchedule +## Conditions ### Properties -* **DayOfTheWeek**: string (Required): The day when the Identity Resolution Job should run every week. -* **Time**: string (Required): The time when the Identity Resolution Job should run every week. +* **ObjectCount**: int +* **Range**: [Range](#range) +* **Threshold**: [Threshold](#threshold) -## RuleBasedMatching +## ConflictResolution ### Properties -* **AttributeTypesSelector**: [AttributeTypesSelector](#attributetypesselector) -* **ConflictResolution**: [ConflictResolution](#conflictresolution) -* **Enabled**: bool (Required): The flag that enables the rule-based matching process of duplicate profiles. -* **ExportingConfig**: [ExportingConfig](#exportingconfig) -* **MatchingRules**: [MatchingRule](#matchingrule)[]: Configures how the rule-based matching process should match profiles. You can have up to 15 MatchingRule in the MatchingRules. -* **MaxAllowedRuleLevelForMatching**: int: Indicates the maximum allowed rule level for matching. -* **MaxAllowedRuleLevelForMerging**: int: Indicates the maximum allowed rule level for merging. -* **Status**: string (ReadOnly) +* **ConflictResolvingModel**: string (Required): How the auto-merging process should resolve conflicts between different profiles. +* **SourceName**: string: The ObjectType name that is used to resolve profile merging conflicts when choosing SOURCE as the ConflictResolvingModel. -## AttributeTypesSelector +## ConnectorOperator ### Properties -* **Address**: string[]: The Address type. You can choose from Address, BusinessAddress, MaillingAddress, and ShippingAddress. You only can use the Address type in the MatchingRule. For example, if you want to match profile based on BusinessAddress.City or MaillingAddress.City, you need to choose the BusinessAddress and the MaillingAddress to represent the Address type and specify the Address.City on the matching rule. -* **AttributeMatchingModel**: string (Required): Configures the AttributeMatchingModel, you can either choose ONE_TO_ONE or MANY_TO_MANY. -* **EmailAddress**: string[]: The Email type. You can choose from EmailAddress, BusinessEmailAddress and PersonalEmailAddress. You only can use the EmailAddress type in the MatchingRule. For example, if you want to match profile based on PersonalEmailAddress or BusinessEmailAddress, you need to choose the PersonalEmailAddress and the BusinessEmailAddress to represent the EmailAddress type and only specify the EmailAddress on the matching rule. -* **PhoneNumber**: string[]: The PhoneNumber type. You can choose from PhoneNumber, HomePhoneNumber, and MobilePhoneNumber. You only can use the PhoneNumber type in the MatchingRule. For example, if you want to match a profile based on Phone or HomePhone, you need to choose the Phone and the HomePhone to represent the PhoneNumber type and only specify the PhoneNumber on the matching rule. +* **Marketo**: string +* **S3**: string +* **Salesforce**: string +* **ServiceNow**: string +* **Zendesk**: string -## MatchingRule +## Consolidation ### Properties -* **Rule**: string[] (Required) +* **MatchingAttributesList**: string[][] (Required): A list of matching criteria. ## DomainStats ### Properties @@ -157,42 +152,19 @@ * **ProfileCount**: int: The total number of profiles currently in the domain. * **TotalSize**: int: The total size, in bytes, of all objects in the domain. -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - -## AWS.CustomerProfiles/EventStreamProperties -### Properties -* **CreatedAt**: string (ReadOnly): The timestamp of when the export was created. -* **DestinationDetails**: [EventStream_DestinationDetails](#eventstreamdestinationdetails) (ReadOnly): Details regarding the Kinesis stream. -* **DomainName**: string (Required, Identifier): The unique name of the domain. -* **EventStreamArn**: string (ReadOnly): A unique identifier for the event stream. -* **EventStreamName**: string (Required, Identifier): The name of the event stream. -* **State**: string (ReadOnly): The operational state of destination stream for export. -* **Tags**: [Tag](#tag)[]: The tags used to organize, track, or control access for this resource. -* **Uri**: string (Required) - ## EventStream_DestinationDetails ### Properties * **Status**: string (Required) * **Uri**: string (Required) -## Tag +## ExportingConfig ### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **S3Exporting**: [S3ExportingConfig](#s3exportingconfig) -## AWS.CustomerProfiles/IntegrationProperties +## FieldMap ### Properties -* **CreatedAt**: string (ReadOnly): The time of this integration got created -* **DomainName**: string (Required, Identifier): The unique name of the domain. -* **FlowDefinition**: [FlowDefinition](#flowdefinition) (WriteOnly) -* **LastUpdatedAt**: string (ReadOnly): The time of this integration got last updated at -* **ObjectTypeName**: string: The name of the ObjectType defined for the 3rd party data in Profile Service -* **ObjectTypeNames**: [ObjectTypeMapping](#objecttypemapping)[]: The mapping between 3rd party event types and ObjectType names -* **Tags**: [Tag](#tag)[]: The tags (keys and values) associated with the integration -* **Uri**: string (Identifier): The URI of the S3 bucket or any other type of data source. +* **Name**: string +* **ObjectTypeField**: [ObjectTypeField](#objecttypefield) ## FlowDefinition ### Properties @@ -203,77 +175,82 @@ * **Tasks**: [Task](#task)[] (Required) * **TriggerConfig**: [TriggerConfig](#triggerconfig) (Required) -## SourceFlowConfig -### Properties -* **ConnectorProfileName**: string -* **ConnectorType**: string (Required) -* **IncrementalPullConfig**: [IncrementalPullConfig](#incrementalpullconfig) -* **SourceConnectorProperties**: [SourceConnectorProperties](#sourceconnectorproperties) (Required) - ## IncrementalPullConfig ### Properties * **DatetimeTypeFieldName**: string -## SourceConnectorProperties +## JobSchedule ### Properties -* **Marketo**: [MarketoSourceProperties](#marketosourceproperties) -* **S3**: [S3SourceProperties](#s3sourceproperties) -* **Salesforce**: [SalesforceSourceProperties](#salesforcesourceproperties) -* **ServiceNow**: [ServiceNowSourceProperties](#servicenowsourceproperties) -* **Zendesk**: [ZendeskSourceProperties](#zendesksourceproperties) +* **DayOfTheWeek**: string (Required): The day when the Identity Resolution Job should run every week. +* **Time**: string (Required): The time when the Identity Resolution Job should run every week. + +## KeyMap +### Properties +* **Name**: string +* **ObjectTypeKeyList**: [ObjectTypeKey](#objecttypekey)[] ## MarketoSourceProperties ### Properties * **Object**: string (Required) -## S3SourceProperties +## Matching ### Properties -* **BucketName**: string (Required) -* **BucketPrefix**: string +* **AutoMerging**: [AutoMerging](#automerging) +* **Enabled**: bool (Required): The flag that enables the matching process of duplicate profiles. +* **ExportingConfig**: [ExportingConfig](#exportingconfig) +* **JobSchedule**: [JobSchedule](#jobschedule) -## SalesforceSourceProperties +## MatchingRule ### Properties -* **EnableDynamicFieldUpdate**: bool -* **IncludeDeletedRecords**: bool -* **Object**: string (Required) +* **Rule**: string[] (Required) -## ServiceNowSourceProperties +## ObjectTypeField ### Properties -* **Object**: string (Required) +* **ContentType**: string: The content type of the field. Used for determining equality when searching. +* **Source**: string: A field of a ProfileObject. For example: _source.FirstName, where "_source" is a ProfileObjectType of a Zendesk user and "FirstName" is a field in that ObjectType. +* **Target**: string: The location of the data in the standard ProfileObject model. For example: _profile.Address.PostalCode. -## ZendeskSourceProperties +## ObjectTypeKey ### Properties -* **Object**: string (Required) +* **FieldNames**: string[]: The reference for the key name of the fields map. +* **StandardIdentifiers**: string[]: The types of keys that a ProfileObject can have. Each ProfileObject can have only 1 UNIQUE key but multiple PROFILE keys. PROFILE means that this key can be used to tie an object to a PROFILE. UNIQUE means that it can be used to uniquely identify an object. If a key a is marked as SECONDARY, it will be used to search for profiles after all other PROFILE keys have been searched. A LOOKUP_ONLY key is only used to match a profile but is not persisted to be used for searching of the profile. A NEW_ONLY key is only used if the profile does not already exist before the object is ingested, otherwise it is only used for matching objects to profiles. -## Task +## ObjectTypeMapping ### Properties -* **ConnectorOperator**: [ConnectorOperator](#connectoroperator) -* **DestinationField**: string -* **SourceFields**: string[] (Required) -* **TaskProperties**: [TaskPropertiesMap](#taskpropertiesmap)[] -* **TaskType**: string (Required) +* **Key**: string (Required) +* **Value**: string (Required) -## ConnectorOperator +## Range ### Properties -* **Marketo**: string -* **S3**: string -* **Salesforce**: string -* **ServiceNow**: string -* **Zendesk**: string +* **Unit**: string (Required) +* **Value**: int (Required) -## TaskPropertiesMap +## RuleBasedMatching ### Properties -* **OperatorPropertyKey**: string (Required) -* **Property**: string (Required) +* **AttributeTypesSelector**: [AttributeTypesSelector](#attributetypesselector) +* **ConflictResolution**: [ConflictResolution](#conflictresolution) +* **Enabled**: bool (Required): The flag that enables the rule-based matching process of duplicate profiles. +* **ExportingConfig**: [ExportingConfig](#exportingconfig) +* **MatchingRules**: [MatchingRule](#matchingrule)[]: Configures how the rule-based matching process should match profiles. You can have up to 15 MatchingRule in the MatchingRules. +* **MaxAllowedRuleLevelForMatching**: int: Indicates the maximum allowed rule level for matching. +* **MaxAllowedRuleLevelForMerging**: int: Indicates the maximum allowed rule level for merging. +* **Status**: string (ReadOnly) -## TriggerConfig +## S3ExportingConfig ### Properties -* **TriggerProperties**: [TriggerProperties](#triggerproperties) -* **TriggerType**: string (Required) +* **S3BucketName**: string (Required): The name of the S3 bucket where Identity Resolution Jobs write result files. +* **S3KeyName**: string: The S3 key name of the location where Identity Resolution Jobs write result files. -## TriggerProperties +## S3SourceProperties ### Properties -* **Scheduled**: [ScheduledTriggerProperties](#scheduledtriggerproperties) +* **BucketName**: string (Required) +* **BucketPrefix**: string + +## SalesforceSourceProperties +### Properties +* **EnableDynamicFieldUpdate**: bool +* **IncludeDeletedRecords**: bool +* **Object**: string (Required) ## ScheduledTriggerProperties ### Properties @@ -285,55 +262,78 @@ * **ScheduleStartTime**: int * **Timezone**: string -## ObjectTypeMapping +## ServiceNowSourceProperties +### Properties +* **Object**: string (Required) + +## SourceConnectorProperties +### Properties +* **Marketo**: [MarketoSourceProperties](#marketosourceproperties) +* **S3**: [S3SourceProperties](#s3sourceproperties) +* **Salesforce**: [SalesforceSourceProperties](#salesforcesourceproperties) +* **ServiceNow**: [ServiceNowSourceProperties](#servicenowsourceproperties) +* **Zendesk**: [ZendeskSourceProperties](#zendesksourceproperties) + +## SourceFlowConfig +### Properties +* **ConnectorProfileName**: string +* **ConnectorType**: string (Required) +* **IncrementalPullConfig**: [IncrementalPullConfig](#incrementalpullconfig) +* **SourceConnectorProperties**: [SourceConnectorProperties](#sourceconnectorproperties) (Required) + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## Tag ### Properties * **Key**: string (Required) * **Value**: string (Required) +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + ## Tag ### Properties * **Key**: string (Required) * **Value**: string (Required) -## AWS.CustomerProfiles/ObjectTypeProperties +## Tag ### Properties -* **AllowProfileCreation**: bool: Indicates whether a profile should be created when data is received. -* **CreatedAt**: string (ReadOnly): The time of this integration got created. -* **Description**: string: Description of the profile object type. -* **DomainName**: string (Required, Identifier): The unique name of the domain. -* **EncryptionKey**: string: The default encryption key -* **ExpirationDays**: int: The default number of days until the data within the domain expires. -* **Fields**: [FieldMap](#fieldmap)[]: A list of the name and ObjectType field. -* **Keys**: [KeyMap](#keymap)[]: A list of unique keys that can be used to map data to the profile. -* **LastUpdatedAt**: string (ReadOnly): The time of this integration got last updated at. -* **ObjectTypeName**: string (Identifier): The name of the profile object type. -* **SourceLastUpdatedTimestampFormat**: string: The format of your sourceLastUpdatedTimestamp that was previously set up. -* **Tags**: [Tag](#tag)[]: The tags (keys and values) associated with the integration. -* **TemplateId**: string: A unique identifier for the object template. +* **Key**: string (Required) +* **Value**: string (Required) -## FieldMap +## Task ### Properties -* **Name**: string -* **ObjectTypeField**: [ObjectTypeField](#objecttypefield) +* **ConnectorOperator**: [ConnectorOperator](#connectoroperator) +* **DestinationField**: string +* **SourceFields**: string[] (Required) +* **TaskProperties**: [TaskPropertiesMap](#taskpropertiesmap)[] +* **TaskType**: string (Required) -## ObjectTypeField +## TaskPropertiesMap ### Properties -* **ContentType**: string: The content type of the field. Used for determining equality when searching. -* **Source**: string: A field of a ProfileObject. For example: _source.FirstName, where "_source" is a ProfileObjectType of a Zendesk user and "FirstName" is a field in that ObjectType. -* **Target**: string: The location of the data in the standard ProfileObject model. For example: _profile.Address.PostalCode. +* **OperatorPropertyKey**: string (Required) +* **Property**: string (Required) -## KeyMap +## Threshold ### Properties -* **Name**: string -* **ObjectTypeKeyList**: [ObjectTypeKey](#objecttypekey)[] +* **Operator**: string (Required) +* **Value**: string (Required) -## ObjectTypeKey +## TriggerConfig ### Properties -* **FieldNames**: string[]: The reference for the key name of the fields map. -* **StandardIdentifiers**: string[]: The types of keys that a ProfileObject can have. Each ProfileObject can have only 1 UNIQUE key but multiple PROFILE keys. PROFILE means that this key can be used to tie an object to a PROFILE. UNIQUE means that it can be used to uniquely identify an object. If a key a is marked as SECONDARY, it will be used to search for profiles after all other PROFILE keys have been searched. A LOOKUP_ONLY key is only used to match a profile but is not persisted to be used for searching of the profile. A NEW_ONLY key is only used if the profile does not already exist before the object is ingested, otherwise it is only used for matching objects to profiles. +* **TriggerProperties**: [TriggerProperties](#triggerproperties) +* **TriggerType**: string (Required) -## Tag +## TriggerProperties ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **Scheduled**: [ScheduledTriggerProperties](#scheduledtriggerproperties) + +## ZendeskSourceProperties +### Properties +* **Object**: string (Required) diff --git a/artifacts/bicep/aws/aws.databrew/default/types.json b/artifacts/bicep/aws/aws.databrew/default/types.json index 943271e7..6c22c629 100644 --- a/artifacts/bicep/aws/aws.databrew/default/types.json +++ b/artifacts/bicep/aws/aws.databrew/default/types.json @@ -1 +1,2666 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"CsvOptions","Properties":{"Delimiter":{"Type":4,"Flags":0},"HeaderRow":{"Type":2,"Flags":0}}}},{"2":{"Name":"DataCatalogInputDefinition","Properties":{"CatalogId":{"Type":4,"Flags":0,"Description":"Catalog id"},"DatabaseName":{"Type":4,"Flags":0,"Description":"Database name"},"TableName":{"Type":4,"Flags":0,"Description":"Table name"},"TempDirectory":{"Type":24,"Flags":0}}}},{"2":{"Name":"DatabaseInputDefinition","Properties":{"DatabaseTableName":{"Type":4,"Flags":0,"Description":"Database table name"},"GlueConnectionName":{"Type":4,"Flags":1,"Description":"Glue connection name"},"QueryString":{"Type":4,"Flags":0,"Description":"Custom SQL to run against the provided AWS Glue connection. This SQL will be used as the input for DataBrew projects and jobs."},"TempDirectory":{"Type":24,"Flags":0}}}},{"2":{"Name":"DatasetParameter","Properties":{"CreateColumn":{"Type":2,"Flags":0,"Description":"Add the value of this parameter as a column in a dataset."},"DatetimeOptions":{"Type":12,"Flags":0},"Filter":{"Type":15,"Flags":0},"Name":{"Type":4,"Flags":17},"Type":{"Type":4,"Flags":1,"Description":"Parameter type"}}}},{"2":{"Name":"DatetimeOptions","Properties":{"Format":{"Type":4,"Flags":1,"Description":"Date/time format of a date parameter"},"LocaleCode":{"Type":4,"Flags":0,"Description":"Locale code for a date parameter"},"TimezoneOffset":{"Type":4,"Flags":0,"Description":"Timezone offset"}}}},{"2":{"Name":"ExcelOptions","Properties":{"HeaderRow":{"Type":2,"Flags":0},"SheetIndexes":{"Type":26,"Flags":0},"SheetNames":{"Type":27,"Flags":0}}}},{"2":{"Name":"FilesLimit","Properties":{"MaxFiles":{"Type":3,"Flags":1,"Description":"Maximum number of files"},"Order":{"Type":4,"Flags":0,"Description":"Order"},"OrderedBy":{"Type":4,"Flags":0,"Description":"Ordered by"}}}},{"2":{"Name":"FilterExpression","Properties":{"Expression":{"Type":4,"Flags":1,"Description":"Filtering expression for a parameter"},"ValuesMap":{"Type":28,"Flags":1}}}},{"2":{"Name":"FilterValue","Properties":{"Value":{"Type":4,"Flags":1},"ValueReference":{"Type":4,"Flags":1,"Description":"Variable name"}}}},{"2":{"Name":"FormatOptions","Properties":{"Csv":{"Type":8,"Flags":0},"Excel":{"Type":13,"Flags":0},"Json":{"Type":19,"Flags":0}}}},{"2":{"Name":"Input","Properties":{"DataCatalogInputDefinition":{"Type":9,"Flags":0},"DatabaseInputDefinition":{"Type":10,"Flags":0},"Metadata":{"Type":20,"Flags":0},"S3InputDefinition":{"Type":24,"Flags":0}}}},{"2":{"Name":"JsonOptions","Properties":{"MultiLine":{"Type":2,"Flags":0}}}},{"2":{"Name":"Metadata","Properties":{"SourceArn":{"Type":4,"Flags":0,"Description":"Arn of the source of the dataset. For e.g.: AppFlow Flow ARN."}}}},{"2":{"Name":"PathOptions","Properties":{"FilesLimit":{"Type":14,"Flags":0},"LastModifiedDateCondition":{"Type":15,"Flags":0},"Parameters":{"Type":29,"Flags":0}}}},{"2":{"Name":"PathParameter","Properties":{"DatasetParameter":{"Type":11,"Flags":1},"PathParameterName":{"Type":4,"Flags":1}}}},{"2":{"Name":"PathParameterName"}},{"2":{"Name":"S3Location","Properties":{"Bucket":{"Type":4,"Flags":1},"Key":{"Type":4,"Flags":0}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"3":{"ItemType":3}},{"3":{"ItemType":4}},{"3":{"ItemType":16}},{"3":{"ItemType":22}},{"2":{"Name":"AWS.DataBrew/DatasetProperties","Properties":{"Format":{"Type":4,"Flags":0,"Description":"Dataset format"},"FormatOptions":{"Type":17,"Flags":0,"Description":"Format options for dataset"},"Input":{"Type":18,"Flags":1,"Description":"Input"},"Name":{"Type":4,"Flags":17,"Description":"Dataset name"},"PathOptions":{"Type":21,"Flags":0,"Description":"PathOptions"},"Tags":{"Type":31,"Flags":0}}}},{"3":{"ItemType":25}},{"2":{"Name":"AWS.DataBrew/Dataset","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":30,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.DataBrew/Dataset@default","ScopeType":0,"Body":32}},{"2":{"Name":"AllowedStatistics","Properties":{"Statistics":{"Type":59,"Flags":1}}}},{"2":{"Name":"ColumnSelector","Properties":{"Name":{"Type":4,"Flags":16},"Regex":{"Type":4,"Flags":0}}}},{"2":{"Name":"ColumnStatisticsConfiguration","Properties":{"Selectors":{"Type":60,"Flags":0},"Statistics":{"Type":55,"Flags":1}}}},{"2":{"Name":"CsvOutputOptions","Properties":{"Delimiter":{"Type":4,"Flags":0}}}},{"2":{"Name":"DataCatalogOutput","Properties":{"CatalogId":{"Type":4,"Flags":0},"DatabaseName":{"Type":4,"Flags":1},"DatabaseOptions":{"Type":40,"Flags":0},"Overwrite":{"Type":2,"Flags":0},"S3Options":{"Type":51,"Flags":0},"TableName":{"Type":4,"Flags":1}}}},{"2":{"Name":"DatabaseOutput","Properties":{"DatabaseOptions":{"Type":40,"Flags":1},"DatabaseOutputMode":{"Type":4,"Flags":0,"Description":"Database table name"},"GlueConnectionName":{"Type":4,"Flags":1,"Description":"Glue connection name"}}}},{"2":{"Name":"DatabaseTableOutputOptions","Properties":{"TableName":{"Type":4,"Flags":1},"TempDirectory":{"Type":50,"Flags":0}}}},{"2":{"Name":"EntityDetectorConfiguration","Properties":{"AllowedStatistics":{"Type":34,"Flags":0},"EntityTypes":{"Type":61,"Flags":1}}}},{"2":{"Name":"JobSample","Properties":{"Mode":{"Type":4,"Flags":0},"Size":{"Type":3,"Flags":0}}}},{"2":{"Name":"JobSize"}},{"2":{"Name":"Output","Properties":{"CompressionFormat":{"Type":4,"Flags":0},"Format":{"Type":4,"Flags":0},"FormatOptions":{"Type":45,"Flags":0},"Location":{"Type":50,"Flags":1},"MaxOutputFiles":{"Type":3,"Flags":0},"Overwrite":{"Type":2,"Flags":0},"PartitionColumns":{"Type":62,"Flags":0}}}},{"2":{"Name":"OutputFormatOptions","Properties":{"Csv":{"Type":37,"Flags":0}}}},{"2":{"Name":"OutputLocation","Properties":{"Bucket":{"Type":4,"Flags":1},"BucketOwner":{"Type":4,"Flags":0},"Key":{"Type":4,"Flags":0}}}},{"2":{"Name":"ParameterMap","Properties":{}}},{"2":{"Name":"ProfileConfiguration","Properties":{"ColumnStatisticsConfigurations":{"Type":63,"Flags":0},"DatasetStatisticsConfiguration":{"Type":55,"Flags":0},"EntityDetectorConfiguration":{"Type":41,"Flags":0},"ProfileColumns":{"Type":64,"Flags":0}}}},{"2":{"Name":"Recipe","Properties":{"Name":{"Type":4,"Flags":17,"Description":"Recipe name"},"Version":{"Type":4,"Flags":0,"Description":"Recipe version"}}}},{"2":{"Name":"S3Location","Properties":{"Bucket":{"Type":4,"Flags":1},"BucketOwner":{"Type":4,"Flags":0},"Key":{"Type":4,"Flags":0}}}},{"2":{"Name":"S3TableOutputOptions","Properties":{"Location":{"Type":50,"Flags":1}}}},{"2":{"Name":"SampleMode"}},{"2":{"Name":"Statistic"}},{"2":{"Name":"StatisticOverride","Properties":{"Parameters":{"Type":47,"Flags":1},"Statistic":{"Type":4,"Flags":1}}}},{"2":{"Name":"StatisticsConfiguration","Properties":{"IncludedStatistics":{"Type":65,"Flags":0},"Overrides":{"Type":66,"Flags":0}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"ValidationConfiguration","Properties":{"RulesetArn":{"Type":4,"Flags":1,"Description":"Arn of the Ruleset"},"ValidationMode":{"Type":4,"Flags":0}}}},{"2":{"Name":"ValidationMode"}},{"3":{"ItemType":4}},{"3":{"ItemType":35}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":36}},{"3":{"ItemType":35}},{"3":{"ItemType":4}},{"3":{"ItemType":54}},{"2":{"Name":"AWS.DataBrew/JobProperties","Properties":{"DataCatalogOutputs":{"Type":68,"Flags":0},"DatabaseOutputs":{"Type":69,"Flags":0},"DatasetName":{"Type":4,"Flags":0,"Description":"Dataset name"},"EncryptionKeyArn":{"Type":4,"Flags":0,"Description":"Encryption Key Arn"},"EncryptionMode":{"Type":4,"Flags":0,"Description":"Encryption mode"},"JobSample":{"Type":42,"Flags":0,"Description":"Job Sample"},"LogSubscription":{"Type":4,"Flags":0,"Description":"Log subscription"},"MaxCapacity":{"Type":3,"Flags":0,"Description":"Max capacity"},"MaxRetries":{"Type":3,"Flags":0,"Description":"Max retries"},"Name":{"Type":4,"Flags":17,"Description":"Job name"},"OutputLocation":{"Type":46,"Flags":0,"Description":"Output location"},"Outputs":{"Type":70,"Flags":0},"ProfileConfiguration":{"Type":48,"Flags":0,"Description":"Profile Job configuration"},"ProjectName":{"Type":4,"Flags":0,"Description":"Project name"},"Recipe":{"Type":49,"Flags":0},"RoleArn":{"Type":4,"Flags":1,"Description":"Role arn"},"Tags":{"Type":71,"Flags":0},"Timeout":{"Type":3,"Flags":0,"Description":"Timeout"},"Type":{"Type":4,"Flags":1,"Description":"Job type"},"ValidationConfigurations":{"Type":72,"Flags":0,"Description":"Data quality rules configuration"}}}},{"3":{"ItemType":38}},{"3":{"ItemType":39}},{"3":{"ItemType":44}},{"3":{"ItemType":56}},{"3":{"ItemType":57}},{"2":{"Name":"AWS.DataBrew/Job","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":67,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.DataBrew/Job@default","ScopeType":0,"Body":73}},{"2":{"Name":"Sample","Properties":{"Size":{"Type":3,"Flags":0,"Description":"Sample size"},"Type":{"Type":4,"Flags":1,"Description":"Sample type"}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.DataBrew/ProjectProperties","Properties":{"DatasetName":{"Type":4,"Flags":1,"Description":"Dataset name"},"Name":{"Type":4,"Flags":17,"Description":"Project name"},"RecipeName":{"Type":4,"Flags":1,"Description":"Recipe name"},"RoleArn":{"Type":4,"Flags":1,"Description":"Role arn"},"Sample":{"Type":75,"Flags":0,"Description":"Sample"},"Tags":{"Type":78,"Flags":0}}}},{"3":{"ItemType":76}},{"2":{"Name":"AWS.DataBrew/Project","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":77,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.DataBrew/Project@default","ScopeType":0,"Body":79}},{"2":{"Name":"Action","Properties":{"Operation":{"Type":4,"Flags":1,"Description":"Step action operation"},"Parameters":{"Type":90,"Flags":0}}}},{"2":{"Name":"ConditionExpression","Properties":{"Condition":{"Type":4,"Flags":1,"Description":"Input condition to be applied to the target column"},"TargetColumn":{"Type":4,"Flags":1,"Description":"Name of the target column"},"Value":{"Type":4,"Flags":0,"Description":"Value of the condition"}}}},{"2":{"Name":"DataCatalogInputDefinition","Properties":{"CatalogId":{"Type":4,"Flags":0,"Description":"Catalog id"},"DatabaseName":{"Type":4,"Flags":0,"Description":"Database name"},"TableName":{"Type":4,"Flags":0,"Description":"Table name"},"TempDirectory":{"Type":87,"Flags":0}}}},{"2":{"Name":"ParameterMap","Properties":{}}},{"2":{"Name":"RecipeParameters","Properties":{"AggregateFunction":{"Type":4,"Flags":0},"Base":{"Type":4,"Flags":0},"CaseStatement":{"Type":4,"Flags":0},"CategoryMap":{"Type":4,"Flags":0},"CharsToRemove":{"Type":4,"Flags":0},"CollapseConsecutiveWhitespace":{"Type":4,"Flags":0},"ColumnDataType":{"Type":4,"Flags":0},"ColumnRange":{"Type":4,"Flags":0},"Count":{"Type":4,"Flags":0},"CustomCharacters":{"Type":4,"Flags":0},"CustomStopWords":{"Type":4,"Flags":0},"CustomValue":{"Type":4,"Flags":0},"DatasetsColumns":{"Type":4,"Flags":0},"DateAddValue":{"Type":4,"Flags":0},"DateTimeFormat":{"Type":4,"Flags":0},"DateTimeParameters":{"Type":4,"Flags":0},"DeleteOtherRows":{"Type":4,"Flags":0},"Delimiter":{"Type":4,"Flags":0},"EndPattern":{"Type":4,"Flags":0},"EndPosition":{"Type":4,"Flags":0},"EndValue":{"Type":4,"Flags":0},"ExpandContractions":{"Type":4,"Flags":0},"Exponent":{"Type":4,"Flags":0},"FalseString":{"Type":4,"Flags":0},"GroupByAggFunctionOptions":{"Type":4,"Flags":0},"GroupByColumns":{"Type":4,"Flags":0},"HiddenColumns":{"Type":4,"Flags":0},"IgnoreCase":{"Type":4,"Flags":0},"IncludeInSplit":{"Type":4,"Flags":0},"Input":{"Type":91,"Flags":0,"Description":"Input"},"Interval":{"Type":4,"Flags":0},"IsText":{"Type":4,"Flags":0},"JoinKeys":{"Type":4,"Flags":0},"JoinType":{"Type":4,"Flags":0},"LeftColumns":{"Type":4,"Flags":0},"Limit":{"Type":4,"Flags":0},"LowerBound":{"Type":4,"Flags":0},"MapType":{"Type":4,"Flags":0},"ModeType":{"Type":4,"Flags":0},"MultiLine":{"Type":2,"Flags":0},"NumRows":{"Type":4,"Flags":0},"NumRowsAfter":{"Type":4,"Flags":0},"NumRowsBefore":{"Type":4,"Flags":0},"OrderByColumn":{"Type":4,"Flags":0},"OrderByColumns":{"Type":4,"Flags":0},"Other":{"Type":4,"Flags":0},"Pattern":{"Type":4,"Flags":0},"PatternOption1":{"Type":4,"Flags":0},"PatternOption2":{"Type":4,"Flags":0},"PatternOptions":{"Type":4,"Flags":0},"Period":{"Type":4,"Flags":0},"Position":{"Type":4,"Flags":0},"RemoveAllPunctuation":{"Type":4,"Flags":0},"RemoveAllQuotes":{"Type":4,"Flags":0},"RemoveAllWhitespace":{"Type":4,"Flags":0},"RemoveCustomCharacters":{"Type":4,"Flags":0},"RemoveCustomValue":{"Type":4,"Flags":0},"RemoveLeadingAndTrailingPunctuation":{"Type":4,"Flags":0},"RemoveLeadingAndTrailingQuotes":{"Type":4,"Flags":0},"RemoveLeadingAndTrailingWhitespace":{"Type":4,"Flags":0},"RemoveLetters":{"Type":4,"Flags":0},"RemoveNumbers":{"Type":4,"Flags":0},"RemoveSourceColumn":{"Type":4,"Flags":0},"RemoveSpecialCharacters":{"Type":4,"Flags":0},"RightColumns":{"Type":4,"Flags":0},"SampleSize":{"Type":4,"Flags":0},"SampleType":{"Type":4,"Flags":0},"SecondInput":{"Type":4,"Flags":0},"SecondaryInputs":{"Type":92,"Flags":0},"SheetIndexes":{"Type":93,"Flags":0},"SheetNames":{"Type":94,"Flags":0},"SourceColumn":{"Type":4,"Flags":0},"SourceColumn1":{"Type":4,"Flags":0},"SourceColumn2":{"Type":4,"Flags":0},"SourceColumns":{"Type":4,"Flags":0},"StartColumnIndex":{"Type":4,"Flags":0},"StartPattern":{"Type":4,"Flags":0},"StartPosition":{"Type":4,"Flags":0},"StartValue":{"Type":4,"Flags":0},"StemmingMode":{"Type":4,"Flags":0},"StepCount":{"Type":4,"Flags":0},"StepIndex":{"Type":4,"Flags":0},"StopWordsMode":{"Type":4,"Flags":0},"Strategy":{"Type":4,"Flags":0},"TargetColumn":{"Type":4,"Flags":0},"TargetColumnNames":{"Type":4,"Flags":0},"TargetDateFormat":{"Type":4,"Flags":0},"TargetIndex":{"Type":4,"Flags":0},"TimeZone":{"Type":4,"Flags":0},"TokenizerPattern":{"Type":4,"Flags":0},"TrueString":{"Type":4,"Flags":0},"UdfLang":{"Type":4,"Flags":0},"Units":{"Type":4,"Flags":0},"UnpivotColumn":{"Type":4,"Flags":0},"UpperBound":{"Type":4,"Flags":0},"UseNewDataFrame":{"Type":4,"Flags":0},"Value":{"Type":4,"Flags":0},"Value1":{"Type":4,"Flags":0},"Value2":{"Type":4,"Flags":0},"ValueColumn":{"Type":4,"Flags":0},"ViewFrame":{"Type":4,"Flags":0}}}},{"2":{"Name":"RecipeStep","Properties":{"Action":{"Type":81,"Flags":1},"ConditionExpressions":{"Type":95,"Flags":0,"Description":"Condition expressions applied to the step action"}}}},{"2":{"Name":"S3Location","Properties":{"Bucket":{"Type":4,"Flags":1},"Key":{"Type":4,"Flags":0}}}},{"2":{"Name":"SecondaryInput","Properties":{"DataCatalogInputDefinition":{"Type":83,"Flags":0},"S3InputDefinition":{"Type":87,"Flags":0}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"Recipe_Parameters","Properties":{}}},{"2":{"Name":"Recipe_Input","Properties":{"DataCatalogInputDefinition":{"Type":83,"Flags":0},"S3InputDefinition":{"Type":87,"Flags":0}}}},{"3":{"ItemType":88}},{"3":{"ItemType":3}},{"3":{"ItemType":4}},{"3":{"ItemType":82}},{"2":{"Name":"AWS.DataBrew/RecipeProperties","Properties":{"Description":{"Type":4,"Flags":0,"Description":"Description of the recipe"},"Name":{"Type":4,"Flags":17,"Description":"Recipe name"},"Steps":{"Type":99,"Flags":1},"Tags":{"Type":100,"Flags":0}}}},{"3":{"ItemType":82}},{"2":{"Name":"Recipe_RecipeStep","Properties":{"Action":{"Type":81,"Flags":1},"ConditionExpressions":{"Type":97,"Flags":0,"Description":"Condition expressions applied to the step action"}}}},{"3":{"ItemType":98}},{"3":{"ItemType":89}},{"2":{"Name":"AWS.DataBrew/Recipe","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":96,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.DataBrew/Recipe@default","ScopeType":0,"Body":101}},{"2":{"Name":"ColumnSelector","Properties":{"Name":{"Type":4,"Flags":16,"Description":"The name of a column from a dataset"},"Regex":{"Type":4,"Flags":0,"Description":"A regular expression for selecting a column from a dataset"}}}},{"2":{"Name":"Disabled"}},{"2":{"Name":"Expression"}},{"2":{"Name":"Rule","Properties":{"CheckExpression":{"Type":4,"Flags":1},"ColumnSelectors":{"Type":114,"Flags":0},"Disabled":{"Type":2,"Flags":0},"Name":{"Type":4,"Flags":17,"Description":"Name of the rule"},"SubstitutionMap":{"Type":115,"Flags":0},"Threshold":{"Type":109,"Flags":0}}}},{"2":{"Name":"SubstitutionValue","Properties":{"Value":{"Type":4,"Flags":1,"Description":"Value or column name"},"ValueReference":{"Type":4,"Flags":1,"Description":"Variable name"}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"Threshold","Properties":{"Type":{"Type":4,"Flags":0},"Unit":{"Type":4,"Flags":0},"Value":{"Type":3,"Flags":1}}}},{"2":{"Name":"ThresholdType"}},{"2":{"Name":"ThresholdUnit"}},{"2":{"Name":"ThresholdValue"}},{"2":{"Name":"ValuesMap"}},{"3":{"ItemType":103}},{"3":{"ItemType":107}},{"3":{"ItemType":107}},{"2":{"Name":"AWS.DataBrew/RulesetProperties","Properties":{"Description":{"Type":4,"Flags":0,"Description":"Description of the Ruleset"},"Name":{"Type":4,"Flags":17,"Description":"Name of the Ruleset"},"Rules":{"Type":118,"Flags":1,"Description":"List of the data quality rules in the ruleset"},"Tags":{"Type":119,"Flags":0},"TargetArn":{"Type":4,"Flags":1,"Description":"Arn of the target resource (dataset) to apply the ruleset to"}}}},{"3":{"ItemType":106}},{"3":{"ItemType":108}},{"2":{"Name":"AWS.DataBrew/Ruleset","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":117,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.DataBrew/Ruleset@default","ScopeType":0,"Body":120}},{"2":{"Name":"JobName"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.DataBrew/ScheduleProperties","Properties":{"CronExpression":{"Type":4,"Flags":1,"Description":"Schedule cron"},"JobNames":{"Type":125,"Flags":0},"Name":{"Type":4,"Flags":17,"Description":"Schedule Name"},"Tags":{"Type":126,"Flags":0}}}},{"3":{"ItemType":4}},{"3":{"ItemType":123}},{"2":{"Name":"AWS.DataBrew/Schedule","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":124,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.DataBrew/Schedule@default","ScopeType":0,"Body":127}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "CsvOptions", + "properties": { + "Delimiter": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "HeaderRow": { + "type": { + "$ref": "#/19" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DataCatalogInputDefinition", + "properties": { + "CatalogId": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "Catalog id" + }, + "DatabaseName": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "Database name" + }, + "TableName": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "Table name" + }, + "TempDirectory": { + "type": { + "$ref": "#/16" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DatabaseInputDefinition", + "properties": { + "DatabaseTableName": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "Database table name" + }, + "GlueConnectionName": { + "type": { + "$ref": "#/18" + }, + "flags": 1, + "description": "Glue connection name" + }, + "QueryString": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "Custom SQL to run against the provided AWS Glue connection. This SQL will be used as the input for DataBrew projects and jobs." + }, + "TempDirectory": { + "type": { + "$ref": "#/16" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DatasetParameter", + "properties": { + "CreateColumn": { + "type": { + "$ref": "#/19" + }, + "flags": 0, + "description": "Add the value of this parameter as a column in a dataset." + }, + "DatetimeOptions": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "Filter": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/18" + }, + "flags": 17 + }, + "Type": { + "type": { + "$ref": "#/18" + }, + "flags": 1, + "description": "Parameter type" + } + } + }, + { + "$type": "ObjectType", + "name": "DatetimeOptions", + "properties": { + "Format": { + "type": { + "$ref": "#/18" + }, + "flags": 1, + "description": "Date/time format of a date parameter" + }, + "LocaleCode": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "Locale code for a date parameter" + }, + "TimezoneOffset": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "Timezone offset" + } + } + }, + { + "$type": "ObjectType", + "name": "ExcelOptions", + "properties": { + "HeaderRow": { + "type": { + "$ref": "#/19" + }, + "flags": 0 + }, + "SheetIndexes": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "SheetNames": { + "type": { + "$ref": "#/22" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FilesLimit", + "properties": { + "MaxFiles": { + "type": { + "$ref": "#/20" + }, + "flags": 1, + "description": "Maximum number of files" + }, + "Order": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "Order" + }, + "OrderedBy": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "Ordered by" + } + } + }, + { + "$type": "ObjectType", + "name": "FilterExpression", + "properties": { + "Expression": { + "type": { + "$ref": "#/18" + }, + "flags": 1, + "description": "Filtering expression for a parameter" + }, + "ValuesMap": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "FilterValue", + "properties": { + "Value": { + "type": { + "$ref": "#/18" + }, + "flags": 1 + }, + "ValueReference": { + "type": { + "$ref": "#/18" + }, + "flags": 1, + "description": "Variable name" + } + } + }, + { + "$type": "ObjectType", + "name": "FormatOptions", + "properties": { + "Csv": { + "type": { + "$ref": "#/0" + }, + "flags": 0 + }, + "Excel": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Json": { + "type": { + "$ref": "#/11" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Input", + "properties": { + "DataCatalogInputDefinition": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "DatabaseInputDefinition": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Metadata": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + }, + "S3InputDefinition": { + "type": { + "$ref": "#/16" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "JsonOptions", + "properties": { + "MultiLine": { + "type": { + "$ref": "#/19" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Metadata", + "properties": { + "SourceArn": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "Arn of the source of the dataset. For e.g.: AppFlow Flow ARN." + } + } + }, + { + "$type": "ObjectType", + "name": "PathOptions", + "properties": { + "FilesLimit": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "LastModifiedDateCondition": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "Parameters": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PathParameter", + "properties": { + "DatasetParameter": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + }, + "PathParameterName": { + "type": { + "$ref": "#/18" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "PathParameterName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "S3Location", + "properties": { + "Bucket": { + "type": { + "$ref": "#/18" + }, + "flags": 1 + }, + "Key": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/18" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/18" + }, + "flags": 1 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "BooleanType" + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/20" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/18" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/8" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/14" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.DataBrew/DatasetProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/17" + } + }, + { + "$type": "ObjectType", + "name": "AWS.DataBrew/DatasetProperties", + "properties": { + "Format": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "Dataset format" + }, + "FormatOptions": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "Format options for dataset" + }, + "Input": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "Input" + }, + "Name": { + "type": { + "$ref": "#/18" + }, + "flags": 17, + "description": "Dataset name" + }, + "PathOptions": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "PathOptions" + }, + "Tags": { + "type": { + "$ref": "#/26" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.DataBrew/Dataset", + "properties": { + "name": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/18" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/27" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.DataBrew/Dataset@default", + "scopeType": 0, + "body": { + "$ref": "#/28" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AllowedStatistics", + "properties": { + "Statistics": { + "type": { + "$ref": "#/55" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ColumnSelector", + "properties": { + "Name": { + "type": { + "$ref": "#/18" + }, + "flags": 16 + }, + "Regex": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ColumnStatisticsConfiguration", + "properties": { + "Selectors": { + "type": { + "$ref": "#/56" + }, + "flags": 0 + }, + "Statistics": { + "type": { + "$ref": "#/51" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CsvOutputOptions", + "properties": { + "Delimiter": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DataCatalogOutput", + "properties": { + "CatalogId": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "DatabaseName": { + "type": { + "$ref": "#/18" + }, + "flags": 1 + }, + "DatabaseOptions": { + "type": { + "$ref": "#/36" + }, + "flags": 0 + }, + "Overwrite": { + "type": { + "$ref": "#/19" + }, + "flags": 0 + }, + "S3Options": { + "type": { + "$ref": "#/47" + }, + "flags": 0 + }, + "TableName": { + "type": { + "$ref": "#/18" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DatabaseOutput", + "properties": { + "DatabaseOptions": { + "type": { + "$ref": "#/36" + }, + "flags": 1 + }, + "DatabaseOutputMode": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "Database table name" + }, + "GlueConnectionName": { + "type": { + "$ref": "#/18" + }, + "flags": 1, + "description": "Glue connection name" + } + } + }, + { + "$type": "ObjectType", + "name": "DatabaseTableOutputOptions", + "properties": { + "TableName": { + "type": { + "$ref": "#/18" + }, + "flags": 1 + }, + "TempDirectory": { + "type": { + "$ref": "#/46" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "EntityDetectorConfiguration", + "properties": { + "AllowedStatistics": { + "type": { + "$ref": "#/30" + }, + "flags": 0 + }, + "EntityTypes": { + "type": { + "$ref": "#/57" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "JobSample", + "properties": { + "Mode": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "Size": { + "type": { + "$ref": "#/20" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "JobSize", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Output", + "properties": { + "CompressionFormat": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "Format": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "FormatOptions": { + "type": { + "$ref": "#/41" + }, + "flags": 0 + }, + "Location": { + "type": { + "$ref": "#/46" + }, + "flags": 1 + }, + "MaxOutputFiles": { + "type": { + "$ref": "#/20" + }, + "flags": 0 + }, + "Overwrite": { + "type": { + "$ref": "#/19" + }, + "flags": 0 + }, + "PartitionColumns": { + "type": { + "$ref": "#/58" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "OutputFormatOptions", + "properties": { + "Csv": { + "type": { + "$ref": "#/33" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "OutputLocation", + "properties": { + "Bucket": { + "type": { + "$ref": "#/18" + }, + "flags": 1 + }, + "BucketOwner": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "Key": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ParameterMap", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ProfileConfiguration", + "properties": { + "ColumnStatisticsConfigurations": { + "type": { + "$ref": "#/59" + }, + "flags": 0 + }, + "DatasetStatisticsConfiguration": { + "type": { + "$ref": "#/51" + }, + "flags": 0 + }, + "EntityDetectorConfiguration": { + "type": { + "$ref": "#/37" + }, + "flags": 0 + }, + "ProfileColumns": { + "type": { + "$ref": "#/60" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Recipe", + "properties": { + "Name": { + "type": { + "$ref": "#/18" + }, + "flags": 17, + "description": "Recipe name" + }, + "Version": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "Recipe version" + } + } + }, + { + "$type": "ObjectType", + "name": "S3Location", + "properties": { + "Bucket": { + "type": { + "$ref": "#/18" + }, + "flags": 1 + }, + "BucketOwner": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "Key": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "S3TableOutputOptions", + "properties": { + "Location": { + "type": { + "$ref": "#/46" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "SampleMode", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Statistic", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "StatisticOverride", + "properties": { + "Parameters": { + "type": { + "$ref": "#/43" + }, + "flags": 1 + }, + "Statistic": { + "type": { + "$ref": "#/18" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "StatisticsConfiguration", + "properties": { + "IncludedStatistics": { + "type": { + "$ref": "#/61" + }, + "flags": 0 + }, + "Overrides": { + "type": { + "$ref": "#/62" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/18" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/18" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ValidationConfiguration", + "properties": { + "RulesetArn": { + "type": { + "$ref": "#/18" + }, + "flags": 1, + "description": "Arn of the Ruleset" + }, + "ValidationMode": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ValidationMode", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/18" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/31" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/18" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/18" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/32" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/31" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/18" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/50" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.DataBrew/JobProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/34" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/35" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/40" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/52" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/53" + } + }, + { + "$type": "ObjectType", + "name": "AWS.DataBrew/JobProperties", + "properties": { + "DataCatalogOutputs": { + "type": { + "$ref": "#/64" + }, + "flags": 0 + }, + "DatabaseOutputs": { + "type": { + "$ref": "#/65" + }, + "flags": 0 + }, + "DatasetName": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "Dataset name" + }, + "EncryptionKeyArn": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "Encryption Key Arn" + }, + "EncryptionMode": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "Encryption mode" + }, + "JobSample": { + "type": { + "$ref": "#/38" + }, + "flags": 0, + "description": "Job Sample" + }, + "LogSubscription": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "Log subscription" + }, + "MaxCapacity": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "Max capacity" + }, + "MaxRetries": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "Max retries" + }, + "Name": { + "type": { + "$ref": "#/18" + }, + "flags": 17, + "description": "Job name" + }, + "OutputLocation": { + "type": { + "$ref": "#/42" + }, + "flags": 0, + "description": "Output location" + }, + "Outputs": { + "type": { + "$ref": "#/66" + }, + "flags": 0 + }, + "ProfileConfiguration": { + "type": { + "$ref": "#/44" + }, + "flags": 0, + "description": "Profile Job configuration" + }, + "ProjectName": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "Project name" + }, + "Recipe": { + "type": { + "$ref": "#/45" + }, + "flags": 0 + }, + "RoleArn": { + "type": { + "$ref": "#/18" + }, + "flags": 1, + "description": "Role arn" + }, + "Tags": { + "type": { + "$ref": "#/67" + }, + "flags": 0 + }, + "Timeout": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "Timeout" + }, + "Type": { + "type": { + "$ref": "#/18" + }, + "flags": 1, + "description": "Job type" + }, + "ValidationConfigurations": { + "type": { + "$ref": "#/68" + }, + "flags": 0, + "description": "Data quality rules configuration" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.DataBrew/Job", + "properties": { + "name": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/18" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/69" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.DataBrew/Job@default", + "scopeType": 0, + "body": { + "$ref": "#/70" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Sample", + "properties": { + "Size": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "Sample size" + }, + "Type": { + "type": { + "$ref": "#/18" + }, + "flags": 1, + "description": "Sample type" + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/18" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/18" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.DataBrew/ProjectProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/73" + } + }, + { + "$type": "ObjectType", + "name": "AWS.DataBrew/ProjectProperties", + "properties": { + "DatasetName": { + "type": { + "$ref": "#/18" + }, + "flags": 1, + "description": "Dataset name" + }, + "Name": { + "type": { + "$ref": "#/18" + }, + "flags": 17, + "description": "Project name" + }, + "RecipeName": { + "type": { + "$ref": "#/18" + }, + "flags": 1, + "description": "Recipe name" + }, + "RoleArn": { + "type": { + "$ref": "#/18" + }, + "flags": 1, + "description": "Role arn" + }, + "Sample": { + "type": { + "$ref": "#/72" + }, + "flags": 0, + "description": "Sample" + }, + "Tags": { + "type": { + "$ref": "#/75" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.DataBrew/Project", + "properties": { + "name": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/18" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/76" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.DataBrew/Project@default", + "scopeType": 0, + "body": { + "$ref": "#/77" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Action", + "properties": { + "Operation": { + "type": { + "$ref": "#/18" + }, + "flags": 1, + "description": "Step action operation" + }, + "Parameters": { + "type": { + "$ref": "#/88" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ConditionExpression", + "properties": { + "Condition": { + "type": { + "$ref": "#/18" + }, + "flags": 1, + "description": "Input condition to be applied to the target column" + }, + "TargetColumn": { + "type": { + "$ref": "#/18" + }, + "flags": 1, + "description": "Name of the target column" + }, + "Value": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "Value of the condition" + } + } + }, + { + "$type": "ObjectType", + "name": "DataCatalogInputDefinition", + "properties": { + "CatalogId": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "Catalog id" + }, + "DatabaseName": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "Database name" + }, + "TableName": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "Table name" + }, + "TempDirectory": { + "type": { + "$ref": "#/85" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ParameterMap", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RecipeParameters", + "properties": { + "AggregateFunction": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "Base": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "CaseStatement": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "CategoryMap": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "CharsToRemove": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "CollapseConsecutiveWhitespace": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "ColumnDataType": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "ColumnRange": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "Count": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "CustomCharacters": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "CustomStopWords": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "CustomValue": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "DatasetsColumns": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "DateAddValue": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "DateTimeFormat": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "DateTimeParameters": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "DeleteOtherRows": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "Delimiter": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "EndPattern": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "EndPosition": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "EndValue": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "ExpandContractions": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "Exponent": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "FalseString": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "GroupByAggFunctionOptions": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "GroupByColumns": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "HiddenColumns": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "IgnoreCase": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "IncludeInSplit": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "Input": { + "type": { + "$ref": "#/89" + }, + "flags": 0, + "description": "Input" + }, + "Interval": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "IsText": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "JoinKeys": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "JoinType": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "LeftColumns": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "Limit": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "LowerBound": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "MapType": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "ModeType": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "MultiLine": { + "type": { + "$ref": "#/19" + }, + "flags": 0 + }, + "NumRows": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "NumRowsAfter": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "NumRowsBefore": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "OrderByColumn": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "OrderByColumns": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "Other": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "Pattern": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "PatternOption1": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "PatternOption2": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "PatternOptions": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "Period": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "Position": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "RemoveAllPunctuation": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "RemoveAllQuotes": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "RemoveAllWhitespace": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "RemoveCustomCharacters": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "RemoveCustomValue": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "RemoveLeadingAndTrailingPunctuation": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "RemoveLeadingAndTrailingQuotes": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "RemoveLeadingAndTrailingWhitespace": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "RemoveLetters": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "RemoveNumbers": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "RemoveSourceColumn": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "RemoveSpecialCharacters": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "RightColumns": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "SampleSize": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "SampleType": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "SecondInput": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "SecondaryInputs": { + "type": { + "$ref": "#/90" + }, + "flags": 0 + }, + "SheetIndexes": { + "type": { + "$ref": "#/91" + }, + "flags": 0 + }, + "SheetNames": { + "type": { + "$ref": "#/92" + }, + "flags": 0 + }, + "SourceColumn": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "SourceColumn1": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "SourceColumn2": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "SourceColumns": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "StartColumnIndex": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "StartPattern": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "StartPosition": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "StartValue": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "StemmingMode": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "StepCount": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "StepIndex": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "StopWordsMode": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "Strategy": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "TargetColumn": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "TargetColumnNames": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "TargetDateFormat": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "TargetIndex": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "TimeZone": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "TokenizerPattern": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "TrueString": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "UdfLang": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "Units": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "UnpivotColumn": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "UpperBound": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "UseNewDataFrame": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "Value1": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "Value2": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "ValueColumn": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "ViewFrame": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "RecipeStep", + "properties": { + "Action": { + "type": { + "$ref": "#/79" + }, + "flags": 1 + }, + "ConditionExpressions": { + "type": { + "$ref": "#/93" + }, + "flags": 0, + "description": "Condition expressions applied to the step action" + } + } + }, + { + "$type": "ObjectType", + "name": "S3Location", + "properties": { + "Bucket": { + "type": { + "$ref": "#/18" + }, + "flags": 1 + }, + "Key": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SecondaryInput", + "properties": { + "DataCatalogInputDefinition": { + "type": { + "$ref": "#/81" + }, + "flags": 0 + }, + "S3InputDefinition": { + "type": { + "$ref": "#/85" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/18" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/18" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Recipe_Parameters", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Recipe_Input", + "properties": { + "DataCatalogInputDefinition": { + "type": { + "$ref": "#/81" + }, + "flags": 0 + }, + "S3InputDefinition": { + "type": { + "$ref": "#/85" + }, + "flags": 0 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/86" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/20" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/18" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/80" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.DataBrew/RecipeProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/80" + } + }, + { + "$type": "ObjectType", + "name": "Recipe_RecipeStep", + "properties": { + "Action": { + "type": { + "$ref": "#/79" + }, + "flags": 1 + }, + "ConditionExpressions": { + "type": { + "$ref": "#/95" + }, + "flags": 0, + "description": "Condition expressions applied to the step action" + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/96" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/87" + } + }, + { + "$type": "ObjectType", + "name": "AWS.DataBrew/RecipeProperties", + "properties": { + "Description": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "Description of the recipe" + }, + "Name": { + "type": { + "$ref": "#/18" + }, + "flags": 17, + "description": "Recipe name" + }, + "Steps": { + "type": { + "$ref": "#/97" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/98" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.DataBrew/Recipe", + "properties": { + "name": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/18" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/99" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.DataBrew/Recipe@default", + "scopeType": 0, + "body": { + "$ref": "#/100" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "ColumnSelector", + "properties": { + "Name": { + "type": { + "$ref": "#/18" + }, + "flags": 16, + "description": "The name of a column from a dataset" + }, + "Regex": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "A regular expression for selecting a column from a dataset" + } + } + }, + { + "$type": "ObjectType", + "name": "Disabled", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Expression", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Rule", + "properties": { + "CheckExpression": { + "type": { + "$ref": "#/18" + }, + "flags": 1 + }, + "ColumnSelectors": { + "type": { + "$ref": "#/113" + }, + "flags": 0 + }, + "Disabled": { + "type": { + "$ref": "#/19" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/18" + }, + "flags": 17, + "description": "Name of the rule" + }, + "SubstitutionMap": { + "type": { + "$ref": "#/114" + }, + "flags": 0 + }, + "Threshold": { + "type": { + "$ref": "#/108" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SubstitutionValue", + "properties": { + "Value": { + "type": { + "$ref": "#/18" + }, + "flags": 1, + "description": "Value or column name" + }, + "ValueReference": { + "type": { + "$ref": "#/18" + }, + "flags": 1, + "description": "Variable name" + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/18" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/18" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Threshold", + "properties": { + "Type": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "Unit": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/20" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ThresholdType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ThresholdUnit", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ThresholdValue", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ValuesMap", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/102" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/106" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/106" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.DataBrew/RulesetProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/105" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/107" + } + }, + { + "$type": "ObjectType", + "name": "AWS.DataBrew/RulesetProperties", + "properties": { + "Description": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "Description of the Ruleset" + }, + "Name": { + "type": { + "$ref": "#/18" + }, + "flags": 17, + "description": "Name of the Ruleset" + }, + "Rules": { + "type": { + "$ref": "#/117" + }, + "flags": 1, + "description": "List of the data quality rules in the ruleset" + }, + "Tags": { + "type": { + "$ref": "#/118" + }, + "flags": 0 + }, + "TargetArn": { + "type": { + "$ref": "#/18" + }, + "flags": 1, + "description": "Arn of the target resource (dataset) to apply the ruleset to" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.DataBrew/Ruleset", + "properties": { + "name": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/18" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/119" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.DataBrew/Ruleset@default", + "scopeType": 0, + "body": { + "$ref": "#/120" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "JobName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/18" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/18" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.DataBrew/ScheduleProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/18" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/123" + } + }, + { + "$type": "ObjectType", + "name": "AWS.DataBrew/ScheduleProperties", + "properties": { + "CronExpression": { + "type": { + "$ref": "#/18" + }, + "flags": 1, + "description": "Schedule cron" + }, + "JobNames": { + "type": { + "$ref": "#/125" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/18" + }, + "flags": 17, + "description": "Schedule Name" + }, + "Tags": { + "type": { + "$ref": "#/126" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.DataBrew/Schedule", + "properties": { + "name": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/18" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/127" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.DataBrew/Schedule@default", + "scopeType": 0, + "body": { + "$ref": "#/128" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.databrew/default/types.md b/artifacts/bicep/aws/aws.databrew/default/types.md index 0b80ed70..ded49598 100644 --- a/artifacts/bicep/aws/aws.databrew/default/types.md +++ b/artifacts/bicep/aws/aws.databrew/default/types.md @@ -3,44 +3,53 @@ ## Resource AWS.DataBrew/Dataset@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.DataBrew/DatasetProperties](#awsdatabrewdatasetproperties) (Required): properties of the resource +* **properties**: [AWS.DataBrew/DatasetProperties](#awsdatabrewdatasetproperties) (Required, Identifier): properties of the resource ## Resource AWS.DataBrew/Job@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.DataBrew/JobProperties](#awsdatabrewjobproperties) (Required): properties of the resource +* **properties**: [AWS.DataBrew/JobProperties](#awsdatabrewjobproperties) (Required, Identifier): properties of the resource ## Resource AWS.DataBrew/Project@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.DataBrew/ProjectProperties](#awsdatabrewprojectproperties) (Required): properties of the resource +* **properties**: [AWS.DataBrew/ProjectProperties](#awsdatabrewprojectproperties) (Required, Identifier): properties of the resource ## Resource AWS.DataBrew/Recipe@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.DataBrew/RecipeProperties](#awsdatabrewrecipeproperties) (Required): properties of the resource +* **properties**: [AWS.DataBrew/RecipeProperties](#awsdatabrewrecipeproperties) (Required, Identifier): properties of the resource ## Resource AWS.DataBrew/Ruleset@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.DataBrew/RulesetProperties](#awsdatabrewrulesetproperties) (Required): properties of the resource +* **properties**: [AWS.DataBrew/RulesetProperties](#awsdatabrewrulesetproperties) (Required, Identifier): properties of the resource ## Resource AWS.DataBrew/Schedule@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.DataBrew/ScheduleProperties](#awsdatabrewscheduleproperties) (Required): properties of the resource +* **properties**: [AWS.DataBrew/ScheduleProperties](#awsdatabrewscheduleproperties) (Required, Identifier): properties of the resource + +## Action +### Properties +* **Operation**: string (Required): Step action operation +* **Parameters**: [Recipe_Parameters](#recipeparameters) + +## AllowedStatistics +### Properties +* **Statistics**: string[] (Required) ## AWS.DataBrew/DatasetProperties ### Properties @@ -51,83 +60,123 @@ * **PathOptions**: [PathOptions](#pathoptions): PathOptions * **Tags**: [Tag](#tag)[] -## FormatOptions +## AWS.DataBrew/JobProperties ### Properties -* **Csv**: [CsvOptions](#csvoptions) -* **Excel**: [ExcelOptions](#exceloptions) -* **Json**: [JsonOptions](#jsonoptions) +* **DatabaseOutputs**: [DatabaseOutput](#databaseoutput)[] +* **DataCatalogOutputs**: [DataCatalogOutput](#datacatalogoutput)[] +* **DatasetName**: string: Dataset name +* **EncryptionKeyArn**: string: Encryption Key Arn +* **EncryptionMode**: string: Encryption mode +* **JobSample**: [JobSample](#jobsample): Job Sample +* **LogSubscription**: string: Log subscription +* **MaxCapacity**: int: Max capacity +* **MaxRetries**: int: Max retries +* **Name**: string (Required, Identifier): Job name +* **OutputLocation**: [OutputLocation](#outputlocation): Output location +* **Outputs**: [Output](#output)[] +* **ProfileConfiguration**: [ProfileConfiguration](#profileconfiguration): Profile Job configuration +* **ProjectName**: string: Project name +* **Recipe**: [Recipe](#recipe) +* **RoleArn**: string (Required): Role arn +* **Tags**: [Tag](#tag)[] +* **Timeout**: int: Timeout +* **Type**: string (Required): Job type +* **ValidationConfigurations**: [ValidationConfiguration](#validationconfiguration)[]: Data quality rules configuration -## CsvOptions +## AWS.DataBrew/ProjectProperties ### Properties -* **Delimiter**: string -* **HeaderRow**: bool +* **DatasetName**: string (Required): Dataset name +* **Name**: string (Required, Identifier): Project name +* **RecipeName**: string (Required): Recipe name +* **RoleArn**: string (Required): Role arn +* **Sample**: [Sample](#sample): Sample +* **Tags**: [Tag](#tag)[] -## ExcelOptions +## AWS.DataBrew/RecipeProperties ### Properties -* **HeaderRow**: bool -* **SheetIndexes**: int[] -* **SheetNames**: string[] +* **Description**: string: Description of the recipe +* **Name**: string (Required, Identifier): Recipe name +* **Steps**: [Recipe_RecipeStep](#reciperecipestep)[] (Required) +* **Tags**: [Tag](#tag)[] -## JsonOptions +## AWS.DataBrew/RulesetProperties ### Properties -* **MultiLine**: bool +* **Description**: string: Description of the Ruleset +* **Name**: string (Required, Identifier): Name of the Ruleset +* **Rules**: [Rule](#rule)[] (Required): List of the data quality rules in the ruleset +* **Tags**: [Tag](#tag)[] +* **TargetArn**: string (Required): Arn of the target resource (dataset) to apply the ruleset to -## Input +## AWS.DataBrew/ScheduleProperties ### Properties -* **DatabaseInputDefinition**: [DatabaseInputDefinition](#databaseinputdefinition) -* **DataCatalogInputDefinition**: [DataCatalogInputDefinition](#datacataloginputdefinition) -* **Metadata**: [Metadata](#metadata) -* **S3InputDefinition**: [S3Location](#s3location) +* **CronExpression**: string (Required): Schedule cron +* **JobNames**: string[] +* **Name**: string (Required, Identifier): Schedule Name +* **Tags**: [Tag](#tag)[] -## DatabaseInputDefinition +## ColumnSelector ### Properties -* **DatabaseTableName**: string: Database table name -* **GlueConnectionName**: string (Required): Glue connection name -* **QueryString**: string: Custom SQL to run against the provided AWS Glue connection. This SQL will be used as the input for DataBrew projects and jobs. -* **TempDirectory**: [S3Location](#s3location) +* **Name**: string (Identifier) +* **Regex**: string -## S3Location +## ColumnSelector ### Properties -* **Bucket**: string (Required) -* **Key**: string +* **Name**: string (Identifier): The name of a column from a dataset +* **Regex**: string: A regular expression for selecting a column from a dataset -## DataCatalogInputDefinition +## ColumnStatisticsConfiguration ### Properties -* **CatalogId**: string: Catalog id -* **DatabaseName**: string: Database name -* **TableName**: string: Table name -* **TempDirectory**: [S3Location](#s3location) +* **Selectors**: [ColumnSelector](#columnselector)[] +* **Statistics**: [StatisticsConfiguration](#statisticsconfiguration) (Required) -## Metadata +## ConditionExpression ### Properties -* **SourceArn**: string: Arn of the source of the dataset. For e.g.: AppFlow Flow ARN. +* **Condition**: string (Required): Input condition to be applied to the target column +* **TargetColumn**: string (Required): Name of the target column +* **Value**: string: Value of the condition -## PathOptions +## CsvOptions ### Properties -* **FilesLimit**: [FilesLimit](#fileslimit) -* **LastModifiedDateCondition**: [FilterExpression](#filterexpression) -* **Parameters**: [PathParameter](#pathparameter)[] +* **Delimiter**: string +* **HeaderRow**: bool -## FilesLimit +## CsvOutputOptions ### Properties -* **MaxFiles**: int (Required): Maximum number of files -* **Order**: string: Order -* **OrderedBy**: string: Ordered by +* **Delimiter**: string -## FilterExpression +## DatabaseInputDefinition ### Properties -* **Expression**: string (Required): Filtering expression for a parameter -* **ValuesMap**: [FilterValue](#filtervalue)[] (Required) +* **DatabaseTableName**: string: Database table name +* **GlueConnectionName**: string (Required): Glue connection name +* **QueryString**: string: Custom SQL to run against the provided AWS Glue connection. This SQL will be used as the input for DataBrew projects and jobs. +* **TempDirectory**: [S3Location](#s3location) -## FilterValue +## DatabaseOutput ### Properties -* **Value**: string (Required) -* **ValueReference**: string (Required): Variable name +* **DatabaseOptions**: [DatabaseTableOutputOptions](#databasetableoutputoptions) (Required) +* **DatabaseOutputMode**: string: Database table name +* **GlueConnectionName**: string (Required): Glue connection name -## PathParameter +## DatabaseTableOutputOptions ### Properties -* **DatasetParameter**: [DatasetParameter](#datasetparameter) (Required) -* **PathParameterName**: string (Required) +* **TableName**: string (Required) +* **TempDirectory**: [S3Location](#s3location) + +## DataCatalogInputDefinition +### Properties +* **CatalogId**: string: Catalog id +* **DatabaseName**: string: Database name +* **TableName**: string: Table name +* **TempDirectory**: [S3Location](#s3location) + +## DataCatalogOutput +### Properties +* **CatalogId**: string +* **DatabaseName**: string (Required) +* **DatabaseOptions**: [DatabaseTableOutputOptions](#databasetableoutputoptions) +* **Overwrite**: bool +* **S3Options**: [S3TableOutputOptions](#s3tableoutputoptions) +* **TableName**: string (Required) ## DatasetParameter ### Properties @@ -143,74 +192,58 @@ * **LocaleCode**: string: Locale code for a date parameter * **TimezoneOffset**: string: Timezone offset -## Tag +## EntityDetectorConfiguration ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **AllowedStatistics**: [AllowedStatistics](#allowedstatistics) +* **EntityTypes**: string[] (Required) -## AWS.DataBrew/JobProperties +## ExcelOptions ### Properties -* **DatabaseOutputs**: [DatabaseOutput](#databaseoutput)[] -* **DataCatalogOutputs**: [DataCatalogOutput](#datacatalogoutput)[] -* **DatasetName**: string: Dataset name -* **EncryptionKeyArn**: string: Encryption Key Arn -* **EncryptionMode**: string: Encryption mode -* **JobSample**: [JobSample](#jobsample): Job Sample -* **LogSubscription**: string: Log subscription -* **MaxCapacity**: int: Max capacity -* **MaxRetries**: int: Max retries -* **Name**: string (Required, Identifier): Job name -* **OutputLocation**: [OutputLocation](#outputlocation): Output location -* **Outputs**: [Output](#output)[] -* **ProfileConfiguration**: [ProfileConfiguration](#profileconfiguration): Profile Job configuration -* **ProjectName**: string: Project name -* **Recipe**: [Recipe](#recipe) -* **RoleArn**: string (Required): Role arn -* **Tags**: [Tag](#tag)[] -* **Timeout**: int: Timeout -* **Type**: string (Required): Job type -* **ValidationConfigurations**: [ValidationConfiguration](#validationconfiguration)[]: Data quality rules configuration +* **HeaderRow**: bool +* **SheetIndexes**: int[] +* **SheetNames**: string[] -## DatabaseOutput +## FilesLimit ### Properties -* **DatabaseOptions**: [DatabaseTableOutputOptions](#databasetableoutputoptions) (Required) -* **DatabaseOutputMode**: string: Database table name -* **GlueConnectionName**: string (Required): Glue connection name +* **MaxFiles**: int (Required): Maximum number of files +* **Order**: string: Order +* **OrderedBy**: string: Ordered by -## DatabaseTableOutputOptions +## FilterExpression ### Properties -* **TableName**: string (Required) -* **TempDirectory**: [S3Location](#s3location) +* **Expression**: string (Required): Filtering expression for a parameter +* **ValuesMap**: [FilterValue](#filtervalue)[] (Required) -## S3Location +## FilterValue ### Properties -* **Bucket**: string (Required) -* **BucketOwner**: string -* **Key**: string +* **Value**: string (Required) +* **ValueReference**: string (Required): Variable name -## DataCatalogOutput +## FormatOptions ### Properties -* **CatalogId**: string -* **DatabaseName**: string (Required) -* **DatabaseOptions**: [DatabaseTableOutputOptions](#databasetableoutputoptions) -* **Overwrite**: bool -* **S3Options**: [S3TableOutputOptions](#s3tableoutputoptions) -* **TableName**: string (Required) +* **Csv**: [CsvOptions](#csvoptions) +* **Excel**: [ExcelOptions](#exceloptions) +* **Json**: [JsonOptions](#jsonoptions) -## S3TableOutputOptions +## Input ### Properties -* **Location**: [S3Location](#s3location) (Required) +* **DatabaseInputDefinition**: [DatabaseInputDefinition](#databaseinputdefinition) +* **DataCatalogInputDefinition**: [DataCatalogInputDefinition](#datacataloginputdefinition) +* **Metadata**: [Metadata](#metadata) +* **S3InputDefinition**: [S3Location](#s3location) ## JobSample ### Properties * **Mode**: string * **Size**: int -## OutputLocation +## JsonOptions ### Properties -* **Bucket**: string (Required) -* **BucketOwner**: string -* **Key**: string +* **MultiLine**: bool + +## Metadata +### Properties +* **SourceArn**: string: Arn of the source of the dataset. For e.g.: AppFlow Flow ARN. ## Output ### Properties @@ -226,140 +259,119 @@ ### Properties * **Csv**: [CsvOutputOptions](#csvoutputoptions) -## CsvOutputOptions -### Properties -* **Delimiter**: string - -## ProfileConfiguration +## OutputLocation ### Properties -* **ColumnStatisticsConfigurations**: [ColumnStatisticsConfiguration](#columnstatisticsconfiguration)[] -* **DatasetStatisticsConfiguration**: [StatisticsConfiguration](#statisticsconfiguration) -* **EntityDetectorConfiguration**: [EntityDetectorConfiguration](#entitydetectorconfiguration) -* **ProfileColumns**: [ColumnSelector](#columnselector)[] +* **Bucket**: string (Required) +* **BucketOwner**: string +* **Key**: string -## ColumnStatisticsConfiguration +## ParameterMap ### Properties -* **Selectors**: [ColumnSelector](#columnselector)[] -* **Statistics**: [StatisticsConfiguration](#statisticsconfiguration) (Required) -## ColumnSelector +## PathOptions ### Properties -* **Name**: string (Identifier) -* **Regex**: string +* **FilesLimit**: [FilesLimit](#fileslimit) +* **LastModifiedDateCondition**: [FilterExpression](#filterexpression) +* **Parameters**: [PathParameter](#pathparameter)[] -## StatisticsConfiguration +## PathParameter ### Properties -* **IncludedStatistics**: string[] -* **Overrides**: [StatisticOverride](#statisticoverride)[] +* **DatasetParameter**: [DatasetParameter](#datasetparameter) (Required) +* **PathParameterName**: string (Required) -## StatisticOverride +## ProfileConfiguration ### Properties -* **Parameters**: [ParameterMap](#parametermap) (Required) -* **Statistic**: string (Required) +* **ColumnStatisticsConfigurations**: [ColumnStatisticsConfiguration](#columnstatisticsconfiguration)[] +* **DatasetStatisticsConfiguration**: [StatisticsConfiguration](#statisticsconfiguration) +* **EntityDetectorConfiguration**: [EntityDetectorConfiguration](#entitydetectorconfiguration) +* **ProfileColumns**: [ColumnSelector](#columnselector)[] -## ParameterMap +## Recipe ### Properties +* **Name**: string (Required, Identifier): Recipe name +* **Version**: string: Recipe version -## EntityDetectorConfiguration +## Recipe_Parameters ### Properties -* **AllowedStatistics**: [AllowedStatistics](#allowedstatistics) -* **EntityTypes**: string[] (Required) -## AllowedStatistics +## Recipe_RecipeStep ### Properties -* **Statistics**: string[] (Required) +* **Action**: [Action](#action) (Required) +* **ConditionExpressions**: [ConditionExpression](#conditionexpression)[]: Condition expressions applied to the step action -## Recipe +## Rule ### Properties -* **Name**: string (Required, Identifier): Recipe name -* **Version**: string: Recipe version +* **CheckExpression**: string (Required) +* **ColumnSelectors**: [ColumnSelector](#columnselector)[] +* **Disabled**: bool +* **Name**: string (Required, Identifier): Name of the rule +* **SubstitutionMap**: [SubstitutionValue](#substitutionvalue)[] +* **Threshold**: [Threshold](#threshold) -## Tag +## S3Location ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **Bucket**: string (Required) +* **Key**: string -## ValidationConfiguration +## S3Location ### Properties -* **RulesetArn**: string (Required): Arn of the Ruleset -* **ValidationMode**: string +* **Bucket**: string (Required) +* **BucketOwner**: string +* **Key**: string -## AWS.DataBrew/ProjectProperties +## S3TableOutputOptions ### Properties -* **DatasetName**: string (Required): Dataset name -* **Name**: string (Required, Identifier): Project name -* **RecipeName**: string (Required): Recipe name -* **RoleArn**: string (Required): Role arn -* **Sample**: [Sample](#sample): Sample -* **Tags**: [Tag](#tag)[] +* **Location**: [S3Location](#s3location) (Required) ## Sample ### Properties * **Size**: int: Sample size * **Type**: string (Required): Sample type -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - -## AWS.DataBrew/RecipeProperties -### Properties -* **Description**: string: Description of the recipe -* **Name**: string (Required, Identifier): Recipe name -* **Steps**: [Recipe_RecipeStep](#reciperecipestep)[] (Required) -* **Tags**: [Tag](#tag)[] - -## Recipe_RecipeStep +## StatisticOverride ### Properties -* **Action**: [Action](#action) (Required) -* **ConditionExpressions**: [ConditionExpression](#conditionexpression)[]: Condition expressions applied to the step action +* **Parameters**: [ParameterMap](#parametermap) (Required) +* **Statistic**: string (Required) -## Action +## StatisticsConfiguration ### Properties -* **Operation**: string (Required): Step action operation -* **Parameters**: [Recipe_Parameters](#recipeparameters) +* **IncludedStatistics**: string[] +* **Overrides**: [StatisticOverride](#statisticoverride)[] -## Recipe_Parameters +## SubstitutionValue ### Properties +* **Value**: string (Required): Value or column name +* **ValueReference**: string (Required): Variable name -## ConditionExpression +## Tag ### Properties -* **Condition**: string (Required): Input condition to be applied to the target column -* **TargetColumn**: string (Required): Name of the target column -* **Value**: string: Value of the condition +* **Key**: string (Required) +* **Value**: string (Required) ## Tag ### Properties * **Key**: string (Required) * **Value**: string (Required) -## AWS.DataBrew/RulesetProperties +## Tag ### Properties -* **Description**: string: Description of the Ruleset -* **Name**: string (Required, Identifier): Name of the Ruleset -* **Rules**: [Rule](#rule)[] (Required): List of the data quality rules in the ruleset -* **Tags**: [Tag](#tag)[] -* **TargetArn**: string (Required): Arn of the target resource (dataset) to apply the ruleset to +* **Key**: string (Required) +* **Value**: string (Required) -## Rule +## Tag ### Properties -* **CheckExpression**: string (Required) -* **ColumnSelectors**: [ColumnSelector](#columnselector)[] -* **Disabled**: bool -* **Name**: string (Required, Identifier): Name of the rule -* **SubstitutionMap**: [SubstitutionValue](#substitutionvalue)[] -* **Threshold**: [Threshold](#threshold) +* **Key**: string (Required) +* **Value**: string (Required) -## ColumnSelector +## Tag ### Properties -* **Name**: string (Identifier): The name of a column from a dataset -* **Regex**: string: A regular expression for selecting a column from a dataset +* **Key**: string (Required) +* **Value**: string (Required) -## SubstitutionValue +## Tag ### Properties -* **Value**: string (Required): Value or column name -* **ValueReference**: string (Required): Variable name +* **Key**: string (Required) +* **Value**: string (Required) ## Threshold ### Properties @@ -367,20 +379,8 @@ * **Unit**: string * **Value**: int (Required) -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - -## AWS.DataBrew/ScheduleProperties -### Properties -* **CronExpression**: string (Required): Schedule cron -* **JobNames**: string[] -* **Name**: string (Required, Identifier): Schedule Name -* **Tags**: [Tag](#tag)[] - -## Tag +## ValidationConfiguration ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **RulesetArn**: string (Required): Arn of the Ruleset +* **ValidationMode**: string diff --git a/artifacts/bicep/aws/aws.datapipeline/default/types.json b/artifacts/bicep/aws/aws.datapipeline/default/types.json index 6df8fd14..ebcfe259 100644 --- a/artifacts/bicep/aws/aws.datapipeline/default/types.json +++ b/artifacts/bicep/aws/aws.datapipeline/default/types.json @@ -1 +1,279 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"Field","Properties":{"Key":{"Type":4,"Flags":1,"Description":"Specifies the name of a field for a particular object. To view valid values for a particular field, see Pipeline Object Reference in the AWS Data Pipeline Developer Guide."},"RefValue":{"Type":4,"Flags":0,"Description":"A field value that you specify as an identifier of another object in the same pipeline definition."},"StringValue":{"Type":4,"Flags":0,"Description":"A field value that you specify as a string. To view valid values for a particular field, see Pipeline Object Reference in the AWS Data Pipeline Developer Guide."}}}},{"2":{"Name":"ParameterAttribute","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The field identifier."},"StringValue":{"Type":4,"Flags":1,"Description":"The field value, expressed as a String."}}}},{"2":{"Name":"ParameterObject","Properties":{"Attributes":{"Type":14,"Flags":1,"Description":"The attributes of the parameter object."},"Id":{"Type":4,"Flags":1,"Description":"The ID of the parameter object."}}}},{"2":{"Name":"ParameterValue","Properties":{"Id":{"Type":4,"Flags":1,"Description":"The ID of the parameter value."},"StringValue":{"Type":4,"Flags":1,"Description":"The field value, expressed as a String."}}}},{"2":{"Name":"PipelineObject","Properties":{"Fields":{"Type":15,"Flags":1,"Description":"Key-value pairs that define the properties of the object."},"Id":{"Type":4,"Flags":1,"Description":"The ID of the object."},"Name":{"Type":4,"Flags":1,"Description":"The name of the object."}}}},{"2":{"Name":"PipelineTag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of a tag."},"Value":{"Type":4,"Flags":1,"Description":"The value to associate with the key name."}}}},{"3":{"ItemType":9}},{"3":{"ItemType":8}},{"2":{"Name":"AWS.DataPipeline/PipelineProperties","Properties":{"Activate":{"Type":2,"Flags":0,"Description":"Indicates whether to validate and start the pipeline or stop an active pipeline. By default, the value is set to true."},"Description":{"Type":4,"Flags":0,"Description":"A description of the pipeline."},"Name":{"Type":4,"Flags":1,"Description":"The name of the pipeline."},"ParameterObjects":{"Type":17,"Flags":0,"Description":"The parameter objects used with the pipeline."},"ParameterValues":{"Type":18,"Flags":0,"Description":"The parameter values used with the pipeline."},"PipelineId":{"Type":4,"Flags":18},"PipelineObjects":{"Type":19,"Flags":0,"Description":"The objects that define the pipeline. These objects overwrite the existing pipeline definition. Not all objects, fields, and values can be updated. For information about restrictions, see Editing Your Pipeline in the AWS Data Pipeline Developer Guide."},"PipelineTags":{"Type":20,"Flags":0,"Description":"A list of arbitrary tags (key-value pairs) to associate with the pipeline, which you can use to control permissions. For more information, see Controlling Access to Pipelines and Resources in the AWS Data Pipeline Developer Guide."}}}},{"3":{"ItemType":10}},{"3":{"ItemType":11}},{"3":{"ItemType":12}},{"3":{"ItemType":13}},{"2":{"Name":"AWS.DataPipeline/Pipeline","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":16,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.DataPipeline/Pipeline@default","ScopeType":0,"Body":21}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Field", + "properties": { + "Key": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "Specifies the name of a field for a particular object. To view valid values for a particular field, see Pipeline Object Reference in the AWS Data Pipeline Developer Guide." + }, + "RefValue": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "A field value that you specify as an identifier of another object in the same pipeline definition." + }, + "StringValue": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "A field value that you specify as a string. To view valid values for a particular field, see Pipeline Object Reference in the AWS Data Pipeline Developer Guide." + } + } + }, + { + "$type": "ObjectType", + "name": "ParameterAttribute", + "properties": { + "Key": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "The field identifier." + }, + "StringValue": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "The field value, expressed as a String." + } + } + }, + { + "$type": "ObjectType", + "name": "ParameterObject", + "properties": { + "Attributes": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "The attributes of the parameter object." + }, + "Id": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "The ID of the parameter object." + } + } + }, + { + "$type": "ObjectType", + "name": "ParameterValue", + "properties": { + "Id": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "The ID of the parameter value." + }, + "StringValue": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "The field value, expressed as a String." + } + } + }, + { + "$type": "ObjectType", + "name": "PipelineObject", + "properties": { + "Fields": { + "type": { + "$ref": "#/8" + }, + "flags": 1, + "description": "Key-value pairs that define the properties of the object." + }, + "Id": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "The ID of the object." + }, + "Name": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "The name of the object." + } + } + }, + { + "$type": "ObjectType", + "name": "PipelineTag", + "properties": { + "Key": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "The key name of a tag." + }, + "Value": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "The value to associate with the key name." + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.DataPipeline/PipelineProperties" + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ObjectType", + "name": "AWS.DataPipeline/PipelineProperties", + "properties": { + "Activate": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "Indicates whether to validate and start the pipeline or stop an active pipeline. By default, the value is set to true." + }, + "Description": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "A description of the pipeline." + }, + "Name": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "The name of the pipeline." + }, + "ParameterObjects": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The parameter objects used with the pipeline." + }, + "ParameterValues": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "The parameter values used with the pipeline." + }, + "PipelineId": { + "type": { + "$ref": "#/6" + }, + "flags": 18 + }, + "PipelineObjects": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "The objects that define the pipeline. These objects overwrite the existing pipeline definition. Not all objects, fields, and values can be updated. For information about restrictions, see Editing Your Pipeline in the AWS Data Pipeline Developer Guide." + }, + "PipelineTags": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "A list of arbitrary tags (key-value pairs) to associate with the pipeline, which you can use to control permissions. For more information, see Controlling Access to Pipelines and Resources in the AWS Data Pipeline Developer Guide." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.DataPipeline/Pipeline", + "properties": { + "name": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/6" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/15" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.DataPipeline/Pipeline@default", + "scopeType": 0, + "body": { + "$ref": "#/16" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.datapipeline/default/types.md b/artifacts/bicep/aws/aws.datapipeline/default/types.md index 18939f89..1ca5d16b 100644 --- a/artifacts/bicep/aws/aws.datapipeline/default/types.md +++ b/artifacts/bicep/aws/aws.datapipeline/default/types.md @@ -3,9 +3,9 @@ ## Resource AWS.DataPipeline/Pipeline@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.DataPipeline/PipelineProperties](#awsdatapipelinepipelineproperties) (Required): properties of the resource +* **properties**: [AWS.DataPipeline/PipelineProperties](#awsdatapipelinepipelineproperties) (Required, Identifier): properties of the resource ## AWS.DataPipeline/PipelineProperties ### Properties @@ -18,16 +18,22 @@ * **PipelineObjects**: [PipelineObject](#pipelineobject)[]: The objects that define the pipeline. These objects overwrite the existing pipeline definition. Not all objects, fields, and values can be updated. For information about restrictions, see Editing Your Pipeline in the AWS Data Pipeline Developer Guide. * **PipelineTags**: [PipelineTag](#pipelinetag)[]: A list of arbitrary tags (key-value pairs) to associate with the pipeline, which you can use to control permissions. For more information, see Controlling Access to Pipelines and Resources in the AWS Data Pipeline Developer Guide. -## ParameterObject +## Field ### Properties -* **Attributes**: [ParameterAttribute](#parameterattribute)[] (Required): The attributes of the parameter object. -* **Id**: string (Required): The ID of the parameter object. +* **Key**: string (Required): Specifies the name of a field for a particular object. To view valid values for a particular field, see Pipeline Object Reference in the AWS Data Pipeline Developer Guide. +* **RefValue**: string: A field value that you specify as an identifier of another object in the same pipeline definition. +* **StringValue**: string: A field value that you specify as a string. To view valid values for a particular field, see Pipeline Object Reference in the AWS Data Pipeline Developer Guide. ## ParameterAttribute ### Properties * **Key**: string (Required): The field identifier. * **StringValue**: string (Required): The field value, expressed as a String. +## ParameterObject +### Properties +* **Attributes**: [ParameterAttribute](#parameterattribute)[] (Required): The attributes of the parameter object. +* **Id**: string (Required): The ID of the parameter object. + ## ParameterValue ### Properties * **Id**: string (Required): The ID of the parameter value. @@ -39,12 +45,6 @@ * **Id**: string (Required): The ID of the object. * **Name**: string (Required): The name of the object. -## Field -### Properties -* **Key**: string (Required): Specifies the name of a field for a particular object. To view valid values for a particular field, see Pipeline Object Reference in the AWS Data Pipeline Developer Guide. -* **RefValue**: string: A field value that you specify as an identifier of another object in the same pipeline definition. -* **StringValue**: string: A field value that you specify as a string. To view valid values for a particular field, see Pipeline Object Reference in the AWS Data Pipeline Developer Guide. - ## PipelineTag ### Properties * **Key**: string (Required): The key name of a tag. diff --git a/artifacts/bicep/aws/aws.datasync/default/types.json b/artifacts/bicep/aws/aws.datasync/default/types.json index 430b4098..9c216b64 100644 --- a/artifacts/bicep/aws/aws.datasync/default/types.json +++ b/artifacts/bicep/aws/aws.datasync/default/types.json @@ -1 +1,2739 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key for an AWS resource tag."},"Value":{"Type":4,"Flags":1,"Description":"The value for an AWS resource tag."}}}},{"2":{"Name":"AWS.DataSync/AgentProperties","Properties":{"ActivationKey":{"Type":4,"Flags":4,"Description":"Activation key of the Agent."},"AgentArn":{"Type":4,"Flags":18,"Description":"The DataSync Agent ARN."},"AgentName":{"Type":4,"Flags":0,"Description":"The name configured for the agent. Text reference used to identify the agent in the console."},"EndpointType":{"Type":4,"Flags":2,"Description":"The service endpoints that the agent will connect to."},"SecurityGroupArns":{"Type":10,"Flags":0,"Description":"The ARNs of the security group used to protect your data transfer task subnets."},"SubnetArns":{"Type":11,"Flags":0,"Description":"The ARNs of the subnets in which DataSync will create elastic network interfaces for each data transfer task."},"Tags":{"Type":12,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."},"VpcEndpointId":{"Type":4,"Flags":0,"Description":"The ID of the VPC endpoint that the agent has access to."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":8}},{"2":{"Name":"AWS.DataSync/Agent","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":9,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.DataSync/Agent@default","ScopeType":0,"Body":13}},{"2":{"Name":"AzureBlobSasConfiguration","Properties":{"AzureBlobSasToken":{"Type":4,"Flags":1,"Description":"Specifies the shared access signature (SAS) token, which indicates the permissions DataSync needs to access your Azure Blob Storage container."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key for an AWS resource tag."},"Value":{"Type":4,"Flags":1,"Description":"The value for an AWS resource tag."}}}},{"2":{"Name":"AWS.DataSync/LocationAzureBlobProperties","Properties":{"AgentArns":{"Type":18,"Flags":1,"Description":"The Amazon Resource Names (ARNs) of agents to use for an Azure Blob Location."},"AzureAccessTier":{"Type":4,"Flags":0,"Description":"Specifies an access tier for the objects you're transferring into your Azure Blob Storage container."},"AzureBlobAuthenticationType":{"Type":4,"Flags":1,"Description":"The specific authentication type that you want DataSync to use to access your Azure Blob Container."},"AzureBlobContainerUrl":{"Type":4,"Flags":4,"Description":"The URL of the Azure Blob container that was described."},"AzureBlobSasConfiguration":{"Type":15,"Flags":4},"AzureBlobType":{"Type":4,"Flags":0,"Description":"Specifies a blob type for the objects you're transferring into your Azure Blob Storage container."},"LocationArn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN) of the Azure Blob Location that is created."},"LocationUri":{"Type":4,"Flags":2,"Description":"The URL of the Azure Blob Location that was described."},"Subdirectory":{"Type":4,"Flags":4,"Description":"The subdirectory in the Azure Blob Container that is used to read data from the Azure Blob Source Location."},"Tags":{"Type":19,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":16}},{"2":{"Name":"AWS.DataSync/LocationAzureBlob","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":17,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.DataSync/LocationAzureBlob@default","ScopeType":0,"Body":20}},{"2":{"Name":"Ec2Config","Properties":{"SecurityGroupArns":{"Type":24,"Flags":1,"Description":"The Amazon Resource Names (ARNs) of the security groups that are configured for the Amazon EC2 resource."},"SubnetArn":{"Type":4,"Flags":1,"Description":"The ARN of the subnet that DataSync uses to access the target EFS file system."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key for an AWS resource tag."},"Value":{"Type":4,"Flags":1,"Description":"The value for an AWS resource tag."}}}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.DataSync/LocationEFSProperties","Properties":{"AccessPointArn":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) for the Amazon EFS Access point that DataSync uses when accessing the EFS file system."},"Ec2Config":{"Type":22,"Flags":1},"EfsFilesystemArn":{"Type":4,"Flags":4,"Description":"The Amazon Resource Name (ARN) for the Amazon EFS file system."},"FileSystemAccessRoleArn":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) of the AWS IAM role that the DataSync will assume when mounting the EFS file system."},"InTransitEncryption":{"Type":4,"Flags":0,"Description":"Protocol that is used for encrypting the traffic exchanged between the DataSync Agent and the EFS file system."},"LocationArn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN) of the Amazon EFS file system location that is created."},"LocationUri":{"Type":4,"Flags":2,"Description":"The URL of the EFS location that was described."},"Subdirectory":{"Type":4,"Flags":4,"Description":"A subdirectory in the location's path. This subdirectory in the EFS file system is used to read data from the EFS source location or write data to the EFS destination."},"Tags":{"Type":26,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."}}}},{"3":{"ItemType":23}},{"2":{"Name":"AWS.DataSync/LocationEFS","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":25,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.DataSync/LocationEFS@default","ScopeType":0,"Body":27}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key for an AWS resource tag."},"Value":{"Type":4,"Flags":1,"Description":"The value for an AWS resource tag."}}}},{"2":{"Name":"AWS.DataSync/LocationFSxLustreProperties","Properties":{"FsxFilesystemArn":{"Type":4,"Flags":4,"Description":"The Amazon Resource Name (ARN) for the FSx for Lustre file system."},"LocationArn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN) of the Amazon FSx for Lustre file system location that is created."},"LocationUri":{"Type":4,"Flags":2,"Description":"The URL of the FSx for Lustre location that was described."},"SecurityGroupArns":{"Type":31,"Flags":1,"Description":"The ARNs of the security groups that are to use to configure the FSx for Lustre file system."},"Subdirectory":{"Type":4,"Flags":4,"Description":"A subdirectory in the location's path."},"Tags":{"Type":32,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":29}},{"2":{"Name":"AWS.DataSync/LocationFSxLustre","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":30,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.DataSync/LocationFSxLustre@default","ScopeType":0,"Body":33}},{"2":{"Name":"NFS","Properties":{"MountOptions":{"Type":36,"Flags":1}}}},{"2":{"Name":"NfsMountOptions","Properties":{"Version":{"Type":4,"Flags":0,"Description":"The specific NFS version that you want DataSync to use to mount your NFS share."}}}},{"2":{"Name":"Protocol","Properties":{"NFS":{"Type":35,"Flags":0},"SMB":{"Type":38,"Flags":0}}}},{"2":{"Name":"SMB","Properties":{"Domain":{"Type":4,"Flags":0,"Description":"The name of the Windows domain that the SMB server belongs to."},"MountOptions":{"Type":39,"Flags":1},"Password":{"Type":4,"Flags":1,"Description":"The password of the user who can mount the share and has the permissions to access files and folders in the SMB share."},"User":{"Type":4,"Flags":1,"Description":"The user who can mount the share, has the permissions to access files and folders in the SMB share."}}}},{"2":{"Name":"SmbMountOptions","Properties":{"Version":{"Type":4,"Flags":0,"Description":"The specific SMB version that you want DataSync to use to mount your SMB share."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key for an AWS resource tag."},"Value":{"Type":4,"Flags":1,"Description":"The value for an AWS resource tag."}}}},{"2":{"Name":"AWS.DataSync/LocationFSxONTAPProperties","Properties":{"FsxFilesystemArn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) for the FSx ONAP file system."},"LocationArn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN) of the Amazon FSx ONTAP file system location that is created."},"LocationUri":{"Type":4,"Flags":2,"Description":"The URL of the FSx ONTAP file system that was described."},"Protocol":{"Type":37,"Flags":4},"SecurityGroupArns":{"Type":42,"Flags":1,"Description":"The ARNs of the security groups that are to use to configure the FSx ONTAP file system."},"StorageVirtualMachineArn":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) for the FSx ONTAP SVM."},"Subdirectory":{"Type":4,"Flags":4,"Description":"A subdirectory in the location's path."},"Tags":{"Type":43,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":40}},{"2":{"Name":"AWS.DataSync/LocationFSxONTAP","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":41,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.DataSync/LocationFSxONTAP@default","ScopeType":0,"Body":44}},{"2":{"Name":"MountOptions","Properties":{"Version":{"Type":4,"Flags":0,"Description":"The specific NFS version that you want DataSync to use to mount your NFS share."}}}},{"2":{"Name":"NFS","Properties":{"MountOptions":{"Type":46,"Flags":1}}}},{"2":{"Name":"Protocol","Properties":{"NFS":{"Type":47,"Flags":0}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key for an AWS resource tag."},"Value":{"Type":4,"Flags":1,"Description":"The value for an AWS resource tag."}}}},{"2":{"Name":"AWS.DataSync/LocationFSxOpenZFSProperties","Properties":{"FsxFilesystemArn":{"Type":4,"Flags":4,"Description":"The Amazon Resource Name (ARN) for the FSx OpenZFS file system."},"LocationArn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN) of the Amazon FSx OpenZFS file system location that is created."},"LocationUri":{"Type":4,"Flags":2,"Description":"The URL of the FSx OpenZFS that was described."},"Protocol":{"Type":48,"Flags":1},"SecurityGroupArns":{"Type":51,"Flags":1,"Description":"The ARNs of the security groups that are to use to configure the FSx OpenZFS file system."},"Subdirectory":{"Type":4,"Flags":4,"Description":"A subdirectory in the location's path."},"Tags":{"Type":52,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":49}},{"2":{"Name":"AWS.DataSync/LocationFSxOpenZFS","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":50,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.DataSync/LocationFSxOpenZFS@default","ScopeType":0,"Body":53}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key for an AWS resource tag."},"Value":{"Type":4,"Flags":1,"Description":"The value for an AWS resource tag."}}}},{"2":{"Name":"AWS.DataSync/LocationFSxWindowsProperties","Properties":{"Domain":{"Type":4,"Flags":0,"Description":"The name of the Windows domain that the FSx for Windows server belongs to."},"FsxFilesystemArn":{"Type":4,"Flags":4,"Description":"The Amazon Resource Name (ARN) for the FSx for Windows file system."},"LocationArn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN) of the Amazon FSx for Windows file system location that is created."},"LocationUri":{"Type":4,"Flags":2,"Description":"The URL of the FSx for Windows location that was described."},"Password":{"Type":4,"Flags":4,"Description":"The password of the user who has the permissions to access files and folders in the FSx for Windows file system."},"SecurityGroupArns":{"Type":57,"Flags":1,"Description":"The ARNs of the security groups that are to use to configure the FSx for Windows file system."},"Subdirectory":{"Type":4,"Flags":4,"Description":"A subdirectory in the location's path."},"Tags":{"Type":58,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."},"User":{"Type":4,"Flags":1,"Description":"The user who has the permissions to access files and folders in the FSx for Windows file system."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":55}},{"2":{"Name":"AWS.DataSync/LocationFSxWindows","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":56,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.DataSync/LocationFSxWindows@default","ScopeType":0,"Body":59}},{"2":{"Name":"NameNode","Properties":{"Hostname":{"Type":4,"Flags":1,"Description":"The DNS name or IP address of the Name Node in the customer's on premises HDFS cluster."},"Port":{"Type":3,"Flags":1,"Description":"The port on which the Name Node is listening on for client requests."}}}},{"2":{"Name":"QopConfiguration","Properties":{"DataTransferProtection":{"Type":4,"Flags":0,"Description":"Configuration for Data Transfer Protection."},"RpcProtection":{"Type":4,"Flags":0,"Description":"Configuration for RPC Protection."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.DataSync/LocationHDFSProperties","Properties":{"AgentArns":{"Type":65,"Flags":1,"Description":"ARN(s) of the agent(s) to use for an HDFS location."},"AuthenticationType":{"Type":4,"Flags":1,"Description":"The authentication mode used to determine identity of user."},"BlockSize":{"Type":3,"Flags":0,"Description":"Size of chunks (blocks) in bytes that the data is divided into when stored in the HDFS cluster."},"KerberosKeytab":{"Type":4,"Flags":4,"Description":"The Base64 string representation of the Keytab file."},"KerberosKrb5Conf":{"Type":4,"Flags":4,"Description":"The string representation of the Krb5Conf file, or the presigned URL to access the Krb5.conf file within an S3 bucket."},"KerberosPrincipal":{"Type":4,"Flags":0,"Description":"The unique identity, or principal, to which Kerberos can assign tickets."},"KmsKeyProviderUri":{"Type":4,"Flags":0,"Description":"The identifier for the Key Management Server where the encryption keys that encrypt data inside HDFS clusters are stored."},"LocationArn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN) of the HDFS location."},"LocationUri":{"Type":4,"Flags":2,"Description":"The URL of the HDFS location that was described."},"NameNodes":{"Type":66,"Flags":1,"Description":"An array of Name Node(s) of the HDFS location."},"QopConfiguration":{"Type":62,"Flags":0},"ReplicationFactor":{"Type":3,"Flags":0,"Description":"Number of copies of each block that exists inside the HDFS cluster."},"SimpleUser":{"Type":4,"Flags":0,"Description":"The user name that has read and write permissions on the specified HDFS cluster."},"Subdirectory":{"Type":4,"Flags":4,"Description":"The subdirectory in HDFS that is used to read data from the HDFS source location or write data to the HDFS destination."},"Tags":{"Type":67,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":61}},{"3":{"ItemType":63}},{"2":{"Name":"AWS.DataSync/LocationHDFS","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":64,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.DataSync/LocationHDFS@default","ScopeType":0,"Body":68}},{"2":{"Name":"MountOptions","Properties":{"Version":{"Type":4,"Flags":0,"Description":"The specific NFS version that you want DataSync to use to mount your NFS share."}}}},{"2":{"Name":"OnPremConfig","Properties":{"AgentArns":{"Type":73,"Flags":1,"Description":"ARN(s) of the agent(s) to use for an NFS location."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key for an AWS resource tag."},"Value":{"Type":4,"Flags":1,"Description":"The value for an AWS resource tag."}}}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.DataSync/LocationNFSProperties","Properties":{"LocationArn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN) of the NFS location."},"LocationUri":{"Type":4,"Flags":2,"Description":"The URL of the NFS location that was described."},"MountOptions":{"Type":70,"Flags":0},"OnPremConfig":{"Type":71,"Flags":1},"ServerHostname":{"Type":4,"Flags":4,"Description":"The name of the NFS server. This value is the IP address or DNS name of the NFS server."},"Subdirectory":{"Type":4,"Flags":4,"Description":"The subdirectory in the NFS file system that is used to read data from the NFS source location or write data to the NFS destination."},"Tags":{"Type":75,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."}}}},{"3":{"ItemType":72}},{"2":{"Name":"AWS.DataSync/LocationNFS","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":74,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.DataSync/LocationNFS@default","ScopeType":0,"Body":76}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key for an AWS resource tag."},"Value":{"Type":4,"Flags":1,"Description":"The value for an AWS resource tag."}}}},{"2":{"Name":"AWS.DataSync/LocationObjectStorageProperties","Properties":{"AccessKey":{"Type":4,"Flags":0,"Description":"Optional. The access key is used if credentials are required to access the self-managed object storage server."},"AgentArns":{"Type":80,"Flags":1,"Description":"The Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location."},"BucketName":{"Type":4,"Flags":4,"Description":"The name of the bucket on the self-managed object storage server."},"LocationArn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN) of the location that is created."},"LocationUri":{"Type":4,"Flags":2,"Description":"The URL of the object storage location that was described."},"SecretKey":{"Type":4,"Flags":4,"Description":"Optional. The secret key is used if credentials are required to access the self-managed object storage server."},"ServerCertificate":{"Type":4,"Flags":0,"Description":"X.509 PEM content containing a certificate authority or chain to trust."},"ServerHostname":{"Type":4,"Flags":4,"Description":"The name of the self-managed object storage server. This value is the IP address or Domain Name Service (DNS) name of the object storage server."},"ServerPort":{"Type":3,"Flags":0,"Description":"The port that your self-managed server accepts inbound network traffic on."},"ServerProtocol":{"Type":4,"Flags":0,"Description":"The protocol that the object storage server uses to communicate."},"Subdirectory":{"Type":4,"Flags":4,"Description":"The subdirectory in the self-managed object storage server that is used to read data from."},"Tags":{"Type":81,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":78}},{"2":{"Name":"AWS.DataSync/LocationObjectStorage","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":79,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.DataSync/LocationObjectStorage@default","ScopeType":0,"Body":82}},{"2":{"Name":"S3Config","Properties":{"BucketAccessRoleArn":{"Type":4,"Flags":1,"Description":"The ARN of the IAM role of the Amazon S3 bucket."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key for an AWS resource tag."},"Value":{"Type":4,"Flags":1,"Description":"The value for an AWS resource tag."}}}},{"2":{"Name":"AWS.DataSync/LocationS3Properties","Properties":{"LocationArn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN) of the Amazon S3 bucket location."},"LocationUri":{"Type":4,"Flags":2,"Description":"The URL of the S3 location that was described."},"S3BucketArn":{"Type":4,"Flags":4,"Description":"The Amazon Resource Name (ARN) of the Amazon S3 bucket."},"S3Config":{"Type":84,"Flags":1},"S3StorageClass":{"Type":4,"Flags":0,"Description":"The Amazon S3 storage class you want to store your files in when this location is used as a task destination."},"Subdirectory":{"Type":4,"Flags":4,"Description":"A subdirectory in the Amazon S3 bucket. This subdirectory in Amazon S3 is used to read data from the S3 source location or write data to the S3 destination."},"Tags":{"Type":87,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."}}}},{"3":{"ItemType":85}},{"2":{"Name":"AWS.DataSync/LocationS3","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":86,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.DataSync/LocationS3@default","ScopeType":0,"Body":88}},{"2":{"Name":"MountOptions","Properties":{"Version":{"Type":4,"Flags":0,"Description":"The specific SMB version that you want DataSync to use to mount your SMB share."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key for an AWS resource tag."},"Value":{"Type":4,"Flags":1,"Description":"The value for an AWS resource tag."}}}},{"2":{"Name":"AWS.DataSync/LocationSMBProperties","Properties":{"AgentArns":{"Type":93,"Flags":1,"Description":"The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location."},"Domain":{"Type":4,"Flags":0,"Description":"The name of the Windows domain that the SMB server belongs to."},"LocationArn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN) of the SMB location that is created."},"LocationUri":{"Type":4,"Flags":2,"Description":"The URL of the SMB location that was described."},"MountOptions":{"Type":90,"Flags":0},"Password":{"Type":4,"Flags":4,"Description":"The password of the user who can mount the share and has the permissions to access files and folders in the SMB share."},"ServerHostname":{"Type":4,"Flags":4,"Description":"The name of the SMB server. This value is the IP address or Domain Name Service (DNS) name of the SMB server."},"Subdirectory":{"Type":4,"Flags":4,"Description":"The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination"},"Tags":{"Type":94,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."},"User":{"Type":4,"Flags":1,"Description":"The user who can mount the share, has the permissions to access files and folders in the SMB share."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":91}},{"2":{"Name":"AWS.DataSync/LocationSMB","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":92,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.DataSync/LocationSMB@default","ScopeType":0,"Body":95}},{"2":{"Name":"ServerConfiguration","Properties":{"ServerHostname":{"Type":4,"Flags":1,"Description":"The domain name or IP address of the storage system's management interface."},"ServerPort":{"Type":3,"Flags":0,"Description":"The network port needed to access the system's management interface"}}}},{"2":{"Name":"ServerCredentials","Properties":{"Password":{"Type":4,"Flags":1,"Description":"The password for your storage system's management interface"},"Username":{"Type":4,"Flags":1,"Description":"The username for your storage system's management interface."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key for an AWS resource tag."},"Value":{"Type":4,"Flags":1,"Description":"The value for an AWS resource tag."}}}},{"2":{"Name":"AWS.DataSync/StorageSystemProperties","Properties":{"AgentArns":{"Type":101,"Flags":1,"Description":"The ARN of the DataSync agent that connects to and reads from the on-premises storage system's management interface."},"CloudWatchLogGroupArn":{"Type":4,"Flags":0,"Description":"The ARN of the Amazon CloudWatch log group used to monitor and log discovery job events."},"ConnectivityStatus":{"Type":4,"Flags":2,"Description":"Indicates whether the DataSync agent can access the on-premises storage system."},"Name":{"Type":4,"Flags":0,"Description":"A familiar name for the on-premises storage system."},"SecretsManagerArn":{"Type":4,"Flags":2,"Description":"The ARN of a secret stored by AWS Secrets Manager."},"ServerConfiguration":{"Type":97,"Flags":1},"ServerCredentials":{"Type":98,"Flags":4},"StorageSystemArn":{"Type":4,"Flags":18,"Description":"The ARN of the on-premises storage system added to DataSync Discovery."},"SystemType":{"Type":4,"Flags":1,"Description":"The type of on-premises storage system that DataSync Discovery will analyze."},"Tags":{"Type":102,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":99}},{"2":{"Name":"AWS.DataSync/StorageSystem","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":100,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.DataSync/StorageSystem@default","ScopeType":0,"Body":103}},{"2":{"Name":"DestinationNetworkInterfaceArns"}},{"2":{"Name":"FilterRule","Properties":{"FilterType":{"Type":4,"Flags":0,"Description":"The type of filter rule to apply. AWS DataSync only supports the SIMPLE_PATTERN rule type."},"Value":{"Type":4,"Flags":0,"Description":"A single filter string that consists of the patterns to include or exclude. The patterns are delimited by \"|\"."}}}},{"2":{"Name":"Options","Properties":{"Atime":{"Type":4,"Flags":0,"Description":"A file metadata value that shows the last time a file was accessed (that is, when the file was read or written to)."},"BytesPerSecond":{"Type":3,"Flags":0,"Description":"A value that limits the bandwidth used by AWS DataSync."},"Gid":{"Type":4,"Flags":0,"Description":"The group ID (GID) of the file's owners."},"LogLevel":{"Type":4,"Flags":0,"Description":"A value that determines the types of logs that DataSync publishes to a log stream in the Amazon CloudWatch log group that you provide."},"Mtime":{"Type":4,"Flags":0,"Description":"A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase."},"ObjectTags":{"Type":4,"Flags":0,"Description":"A value that determines whether object tags should be read from the source object store and written to the destination object store."},"OverwriteMode":{"Type":4,"Flags":0,"Description":"A value that determines whether files at the destination should be overwritten or preserved when copying files."},"PosixPermissions":{"Type":4,"Flags":0,"Description":"A value that determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file."},"PreserveDeletedFiles":{"Type":4,"Flags":0,"Description":"A value that specifies whether files in the destination that don't exist in the source file system should be preserved."},"PreserveDevices":{"Type":4,"Flags":0,"Description":"A value that determines whether AWS DataSync should preserve the metadata of block and character devices in the source file system, and recreate the files with that device name and metadata on the destination."},"SecurityDescriptorCopyFlags":{"Type":4,"Flags":0,"Description":"A value that determines which components of the SMB security descriptor are copied during transfer."},"TaskQueueing":{"Type":4,"Flags":0,"Description":"A value that determines whether tasks should be queued before executing the tasks."},"TransferMode":{"Type":4,"Flags":0,"Description":"A value that determines whether DataSync transfers only the data and metadata that differ between the source and the destination location, or whether DataSync transfers all the content from the source, without comparing to the destination location."},"Uid":{"Type":4,"Flags":0,"Description":"The user ID (UID) of the file's owner."},"VerifyMode":{"Type":4,"Flags":0,"Description":"A value that determines whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred."}}}},{"2":{"Name":"SourceNetworkInterfaceArns"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key for an AWS resource tag."},"Value":{"Type":4,"Flags":1,"Description":"The value for an AWS resource tag."}}}},{"2":{"Name":"TaskReportConfig","Properties":{"Destination":{"Type":115,"Flags":1,"Description":"Specifies where DataSync uploads your task report."},"ObjectVersionIds":{"Type":4,"Flags":0,"Description":"Specifies whether your task report includes the new version of each object transferred into an S3 bucket, this only applies if you enable versioning on your bucket."},"OutputType":{"Type":4,"Flags":1,"Description":"Specifies the type of task report that you want."},"Overrides":{"Type":120,"Flags":0,"Description":"Customizes the reporting level for aspects of your task report. For example, your report might generally only include errors, but you could specify that you want a list of successes and errors just for the files that Datasync attempted to delete in your destination location."},"ReportLevel":{"Type":4,"Flags":0,"Description":"Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't."}}}},{"2":{"Name":"TaskSchedule","Properties":{"ScheduleExpression":{"Type":4,"Flags":1,"Description":"A cron expression that specifies when AWS DataSync initiates a scheduled transfer from a source to a destination location"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"Task_Destination_S3","Properties":{"BucketAccessRoleArn":{"Type":4,"Flags":0,"Description":"Specifies the Amazon Resource Name (ARN) of the IAM policy that allows Datasync to upload a task report to your S3 bucket."},"S3BucketArn":{"Type":4,"Flags":0,"Description":"Specifies the ARN of the S3 bucket where Datasync uploads your report."},"Subdirectory":{"Type":4,"Flags":0,"Description":"Specifies a bucket prefix for your report."}}}},{"2":{"Name":"Task_Destination","Properties":{"S3":{"Type":114,"Flags":0,"Description":"Specifies the Amazon S3 bucket where DataSync uploads your task report."}}}},{"2":{"Name":"Task_Overrides_Deleted","Properties":{"ReportLevel":{"Type":4,"Flags":0,"Description":"Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't."}}}},{"2":{"Name":"Task_Overrides_Skipped","Properties":{"ReportLevel":{"Type":4,"Flags":0,"Description":"Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't."}}}},{"2":{"Name":"Task_Overrides_Transferred","Properties":{"ReportLevel":{"Type":4,"Flags":0,"Description":"Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't."}}}},{"2":{"Name":"Task_Overrides_Verified","Properties":{"ReportLevel":{"Type":4,"Flags":0,"Description":"Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't."}}}},{"2":{"Name":"Task_Overrides","Properties":{"Deleted":{"Type":116,"Flags":0,"Description":"Specifies the level of reporting for the files, objects, and directories that Datasync attempted to delete in your destination location. This only applies if you configure your task to delete data in the destination that isn't in the source."},"Skipped":{"Type":117,"Flags":0,"Description":"Specifies the level of reporting for the files, objects, and directories that Datasync attempted to skip during your transfer."},"Transferred":{"Type":118,"Flags":0,"Description":"Specifies the level of reporting for the files, objects, and directories that Datasync attempted to transfer."},"Verified":{"Type":119,"Flags":0,"Description":"Specifies the level of reporting for the files, objects, and directories that Datasync attempted to verify at the end of your transfer. This only applies if you configure your task to verify data during and after the transfer (which Datasync does by default)"}}}},{"2":{"Name":"AWS.DataSync/TaskProperties","Properties":{"CloudWatchLogGroupArn":{"Type":4,"Flags":0,"Description":"The ARN of the Amazon CloudWatch log group that is used to monitor and log events in the task."},"DestinationLocationArn":{"Type":4,"Flags":1,"Description":"The ARN of an AWS storage resource's location."},"DestinationNetworkInterfaceArns":{"Type":122,"Flags":2},"Excludes":{"Type":123,"Flags":0},"Includes":{"Type":124,"Flags":0},"Name":{"Type":4,"Flags":0,"Description":"The name of a task. This value is a text reference that is used to identify the task in the console."},"Options":{"Type":107,"Flags":0},"Schedule":{"Type":111,"Flags":0},"SourceLocationArn":{"Type":4,"Flags":1,"Description":"The ARN of the source location for the task."},"SourceNetworkInterfaceArns":{"Type":125,"Flags":2},"Status":{"Type":4,"Flags":2,"Description":"The status of the task that was described."},"Tags":{"Type":126,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."},"TaskArn":{"Type":4,"Flags":18,"Description":"The ARN of the task."},"TaskReportConfig":{"Type":110,"Flags":0}}}},{"3":{"ItemType":4}},{"3":{"ItemType":106}},{"3":{"ItemType":106}},{"3":{"ItemType":4}},{"3":{"ItemType":109}},{"2":{"Name":"AWS.DataSync/Task","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":121,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.DataSync/Task@default","ScopeType":0,"Body":127}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key for an AWS resource tag." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for an AWS resource tag." + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.DataSync/AgentProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ObjectType", + "name": "AWS.DataSync/AgentProperties", + "properties": { + "ActivationKey": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "Activation key of the Agent." + }, + "AgentArn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The DataSync Agent ARN." + }, + "AgentName": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The name configured for the agent. Text reference used to identify the agent in the console." + }, + "EndpointType": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The service endpoints that the agent will connect to." + }, + "SecurityGroupArns": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The ARNs of the security group used to protect your data transfer task subnets." + }, + "SubnetArns": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The ARNs of the subnets in which DataSync will create elastic network interfaces for each data transfer task." + }, + "Tags": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + }, + "VpcEndpointId": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The ID of the VPC endpoint that the agent has access to." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.DataSync/Agent", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/6" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.DataSync/Agent@default", + "scopeType": 0, + "body": { + "$ref": "#/7" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AzureBlobSasConfiguration", + "properties": { + "AzureBlobSasToken": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Specifies the shared access signature (SAS) token, which indicates the permissions DataSync needs to access your Azure Blob Storage container." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key for an AWS resource tag." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for an AWS resource tag." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.DataSync/LocationAzureBlobProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/10" + } + }, + { + "$type": "ObjectType", + "name": "AWS.DataSync/LocationAzureBlobProperties", + "properties": { + "AgentArns": { + "type": { + "$ref": "#/12" + }, + "flags": 1, + "description": "The Amazon Resource Names (ARNs) of agents to use for an Azure Blob Location." + }, + "AzureAccessTier": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Specifies an access tier for the objects you're transferring into your Azure Blob Storage container." + }, + "AzureBlobAuthenticationType": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The specific authentication type that you want DataSync to use to access your Azure Blob Container." + }, + "AzureBlobContainerUrl": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The URL of the Azure Blob container that was described." + }, + "AzureBlobSasConfiguration": { + "type": { + "$ref": "#/9" + }, + "flags": 4 + }, + "AzureBlobType": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Specifies a blob type for the objects you're transferring into your Azure Blob Storage container." + }, + "LocationArn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) of the Azure Blob Location that is created." + }, + "LocationUri": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The URL of the Azure Blob Location that was described." + }, + "Subdirectory": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The subdirectory in the Azure Blob Container that is used to read data from the Azure Blob Source Location." + }, + "Tags": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.DataSync/LocationAzureBlob", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/14" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.DataSync/LocationAzureBlob@default", + "scopeType": 0, + "body": { + "$ref": "#/15" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Ec2Config", + "properties": { + "SecurityGroupArns": { + "type": { + "$ref": "#/19" + }, + "flags": 1, + "description": "The Amazon Resource Names (ARNs) of the security groups that are configured for the Amazon EC2 resource." + }, + "SubnetArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The ARN of the subnet that DataSync uses to access the target EFS file system." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key for an AWS resource tag." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for an AWS resource tag." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.DataSync/LocationEFSProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/18" + } + }, + { + "$type": "ObjectType", + "name": "AWS.DataSync/LocationEFSProperties", + "properties": { + "AccessPointArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) for the Amazon EFS Access point that DataSync uses when accessing the EFS file system." + }, + "Ec2Config": { + "type": { + "$ref": "#/17" + }, + "flags": 1 + }, + "EfsFilesystemArn": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The Amazon Resource Name (ARN) for the Amazon EFS file system." + }, + "FileSystemAccessRoleArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the AWS IAM role that the DataSync will assume when mounting the EFS file system." + }, + "InTransitEncryption": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Protocol that is used for encrypting the traffic exchanged between the DataSync Agent and the EFS file system." + }, + "LocationArn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) of the Amazon EFS file system location that is created." + }, + "LocationUri": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The URL of the EFS location that was described." + }, + "Subdirectory": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "A subdirectory in the location's path. This subdirectory in the EFS file system is used to read data from the EFS source location or write data to the EFS destination." + }, + "Tags": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.DataSync/LocationEFS", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/22" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.DataSync/LocationEFS@default", + "scopeType": 0, + "body": { + "$ref": "#/23" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key for an AWS resource tag." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for an AWS resource tag." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.DataSync/LocationFSxLustreProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/25" + } + }, + { + "$type": "ObjectType", + "name": "AWS.DataSync/LocationFSxLustreProperties", + "properties": { + "FsxFilesystemArn": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The Amazon Resource Name (ARN) for the FSx for Lustre file system." + }, + "LocationArn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) of the Amazon FSx for Lustre file system location that is created." + }, + "LocationUri": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The URL of the FSx for Lustre location that was described." + }, + "SecurityGroupArns": { + "type": { + "$ref": "#/27" + }, + "flags": 1, + "description": "The ARNs of the security groups that are to use to configure the FSx for Lustre file system." + }, + "Subdirectory": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "A subdirectory in the location's path." + }, + "Tags": { + "type": { + "$ref": "#/28" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.DataSync/LocationFSxLustre", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/29" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.DataSync/LocationFSxLustre@default", + "scopeType": 0, + "body": { + "$ref": "#/30" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "NFS", + "properties": { + "MountOptions": { + "type": { + "$ref": "#/33" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "NfsMountOptions", + "properties": { + "Version": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The specific NFS version that you want DataSync to use to mount your NFS share." + } + } + }, + { + "$type": "ObjectType", + "name": "Protocol", + "properties": { + "NFS": { + "type": { + "$ref": "#/32" + }, + "flags": 0 + }, + "SMB": { + "type": { + "$ref": "#/35" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SMB", + "properties": { + "Domain": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The name of the Windows domain that the SMB server belongs to." + }, + "MountOptions": { + "type": { + "$ref": "#/36" + }, + "flags": 1 + }, + "Password": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The password of the user who can mount the share and has the permissions to access files and folders in the SMB share." + }, + "User": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The user who can mount the share, has the permissions to access files and folders in the SMB share." + } + } + }, + { + "$type": "ObjectType", + "name": "SmbMountOptions", + "properties": { + "Version": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The specific SMB version that you want DataSync to use to mount your SMB share." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key for an AWS resource tag." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for an AWS resource tag." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.DataSync/LocationFSxONTAPProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/37" + } + }, + { + "$type": "ObjectType", + "name": "AWS.DataSync/LocationFSxONTAPProperties", + "properties": { + "FsxFilesystemArn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) for the FSx ONAP file system." + }, + "LocationArn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) of the Amazon FSx ONTAP file system location that is created." + }, + "LocationUri": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The URL of the FSx ONTAP file system that was described." + }, + "Protocol": { + "type": { + "$ref": "#/34" + }, + "flags": 4 + }, + "SecurityGroupArns": { + "type": { + "$ref": "#/39" + }, + "flags": 1, + "description": "The ARNs of the security groups that are to use to configure the FSx ONTAP file system." + }, + "StorageVirtualMachineArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) for the FSx ONTAP SVM." + }, + "Subdirectory": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "A subdirectory in the location's path." + }, + "Tags": { + "type": { + "$ref": "#/40" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.DataSync/LocationFSxONTAP", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/41" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.DataSync/LocationFSxONTAP@default", + "scopeType": 0, + "body": { + "$ref": "#/42" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "MountOptions", + "properties": { + "Version": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The specific NFS version that you want DataSync to use to mount your NFS share." + } + } + }, + { + "$type": "ObjectType", + "name": "NFS", + "properties": { + "MountOptions": { + "type": { + "$ref": "#/44" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Protocol", + "properties": { + "NFS": { + "type": { + "$ref": "#/45" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key for an AWS resource tag." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for an AWS resource tag." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.DataSync/LocationFSxOpenZFSProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/47" + } + }, + { + "$type": "ObjectType", + "name": "AWS.DataSync/LocationFSxOpenZFSProperties", + "properties": { + "FsxFilesystemArn": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The Amazon Resource Name (ARN) for the FSx OpenZFS file system." + }, + "LocationArn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) of the Amazon FSx OpenZFS file system location that is created." + }, + "LocationUri": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The URL of the FSx OpenZFS that was described." + }, + "Protocol": { + "type": { + "$ref": "#/46" + }, + "flags": 1 + }, + "SecurityGroupArns": { + "type": { + "$ref": "#/49" + }, + "flags": 1, + "description": "The ARNs of the security groups that are to use to configure the FSx OpenZFS file system." + }, + "Subdirectory": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "A subdirectory in the location's path." + }, + "Tags": { + "type": { + "$ref": "#/50" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.DataSync/LocationFSxOpenZFS", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/51" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.DataSync/LocationFSxOpenZFS@default", + "scopeType": 0, + "body": { + "$ref": "#/52" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key for an AWS resource tag." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for an AWS resource tag." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.DataSync/LocationFSxWindowsProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/54" + } + }, + { + "$type": "ObjectType", + "name": "AWS.DataSync/LocationFSxWindowsProperties", + "properties": { + "Domain": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The name of the Windows domain that the FSx for Windows server belongs to." + }, + "FsxFilesystemArn": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The Amazon Resource Name (ARN) for the FSx for Windows file system." + }, + "LocationArn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) of the Amazon FSx for Windows file system location that is created." + }, + "LocationUri": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The URL of the FSx for Windows location that was described." + }, + "Password": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The password of the user who has the permissions to access files and folders in the FSx for Windows file system." + }, + "SecurityGroupArns": { + "type": { + "$ref": "#/56" + }, + "flags": 1, + "description": "The ARNs of the security groups that are to use to configure the FSx for Windows file system." + }, + "Subdirectory": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "A subdirectory in the location's path." + }, + "Tags": { + "type": { + "$ref": "#/57" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + }, + "User": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The user who has the permissions to access files and folders in the FSx for Windows file system." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.DataSync/LocationFSxWindows", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/58" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.DataSync/LocationFSxWindows@default", + "scopeType": 0, + "body": { + "$ref": "#/59" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "NameNode", + "properties": { + "Hostname": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The DNS name or IP address of the Name Node in the customer's on premises HDFS cluster." + }, + "Port": { + "type": { + "$ref": "#/64" + }, + "flags": 1, + "description": "The port on which the Name Node is listening on for client requests." + } + } + }, + { + "$type": "ObjectType", + "name": "QopConfiguration", + "properties": { + "DataTransferProtection": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Configuration for Data Transfer Protection." + }, + "RpcProtection": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Configuration for RPC Protection." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.DataSync/LocationHDFSProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/61" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/63" + } + }, + { + "$type": "ObjectType", + "name": "AWS.DataSync/LocationHDFSProperties", + "properties": { + "AgentArns": { + "type": { + "$ref": "#/66" + }, + "flags": 1, + "description": "ARN(s) of the agent(s) to use for an HDFS location." + }, + "AuthenticationType": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The authentication mode used to determine identity of user." + }, + "BlockSize": { + "type": { + "$ref": "#/64" + }, + "flags": 0, + "description": "Size of chunks (blocks) in bytes that the data is divided into when stored in the HDFS cluster." + }, + "KerberosKeytab": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The Base64 string representation of the Keytab file." + }, + "KerberosKrb5Conf": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The string representation of the Krb5Conf file, or the presigned URL to access the Krb5.conf file within an S3 bucket." + }, + "KerberosPrincipal": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The unique identity, or principal, to which Kerberos can assign tickets." + }, + "KmsKeyProviderUri": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The identifier for the Key Management Server where the encryption keys that encrypt data inside HDFS clusters are stored." + }, + "LocationArn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) of the HDFS location." + }, + "LocationUri": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The URL of the HDFS location that was described." + }, + "NameNodes": { + "type": { + "$ref": "#/67" + }, + "flags": 1, + "description": "An array of Name Node(s) of the HDFS location." + }, + "QopConfiguration": { + "type": { + "$ref": "#/62" + }, + "flags": 0 + }, + "ReplicationFactor": { + "type": { + "$ref": "#/64" + }, + "flags": 0, + "description": "Number of copies of each block that exists inside the HDFS cluster." + }, + "SimpleUser": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The user name that has read and write permissions on the specified HDFS cluster." + }, + "Subdirectory": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The subdirectory in HDFS that is used to read data from the HDFS source location or write data to the HDFS destination." + }, + "Tags": { + "type": { + "$ref": "#/68" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.DataSync/LocationHDFS", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/69" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.DataSync/LocationHDFS@default", + "scopeType": 0, + "body": { + "$ref": "#/70" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "MountOptions", + "properties": { + "Version": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The specific NFS version that you want DataSync to use to mount your NFS share." + } + } + }, + { + "$type": "ObjectType", + "name": "OnPremConfig", + "properties": { + "AgentArns": { + "type": { + "$ref": "#/75" + }, + "flags": 1, + "description": "ARN(s) of the agent(s) to use for an NFS location." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key for an AWS resource tag." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for an AWS resource tag." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.DataSync/LocationNFSProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/74" + } + }, + { + "$type": "ObjectType", + "name": "AWS.DataSync/LocationNFSProperties", + "properties": { + "LocationArn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) of the NFS location." + }, + "LocationUri": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The URL of the NFS location that was described." + }, + "MountOptions": { + "type": { + "$ref": "#/72" + }, + "flags": 0 + }, + "OnPremConfig": { + "type": { + "$ref": "#/73" + }, + "flags": 1 + }, + "ServerHostname": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The name of the NFS server. This value is the IP address or DNS name of the NFS server." + }, + "Subdirectory": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The subdirectory in the NFS file system that is used to read data from the NFS source location or write data to the NFS destination." + }, + "Tags": { + "type": { + "$ref": "#/77" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.DataSync/LocationNFS", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/78" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.DataSync/LocationNFS@default", + "scopeType": 0, + "body": { + "$ref": "#/79" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key for an AWS resource tag." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for an AWS resource tag." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.DataSync/LocationObjectStorageProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/81" + } + }, + { + "$type": "ObjectType", + "name": "AWS.DataSync/LocationObjectStorageProperties", + "properties": { + "AccessKey": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Optional. The access key is used if credentials are required to access the self-managed object storage server." + }, + "AgentArns": { + "type": { + "$ref": "#/83" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location." + }, + "BucketName": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The name of the bucket on the self-managed object storage server." + }, + "LocationArn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) of the location that is created." + }, + "LocationUri": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The URL of the object storage location that was described." + }, + "SecretKey": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "Optional. The secret key is used if credentials are required to access the self-managed object storage server." + }, + "ServerCertificate": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "X.509 PEM content containing a certificate authority or chain to trust." + }, + "ServerHostname": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The name of the self-managed object storage server. This value is the IP address or Domain Name Service (DNS) name of the object storage server." + }, + "ServerPort": { + "type": { + "$ref": "#/64" + }, + "flags": 0, + "description": "The port that your self-managed server accepts inbound network traffic on." + }, + "ServerProtocol": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The protocol that the object storage server uses to communicate." + }, + "Subdirectory": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The subdirectory in the self-managed object storage server that is used to read data from." + }, + "Tags": { + "type": { + "$ref": "#/84" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.DataSync/LocationObjectStorage", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/85" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.DataSync/LocationObjectStorage@default", + "scopeType": 0, + "body": { + "$ref": "#/86" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "S3Config", + "properties": { + "BucketAccessRoleArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The ARN of the IAM role of the Amazon S3 bucket." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key for an AWS resource tag." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for an AWS resource tag." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.DataSync/LocationS3Properties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/89" + } + }, + { + "$type": "ObjectType", + "name": "AWS.DataSync/LocationS3Properties", + "properties": { + "LocationArn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) of the Amazon S3 bucket location." + }, + "LocationUri": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The URL of the S3 location that was described." + }, + "S3BucketArn": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The Amazon Resource Name (ARN) of the Amazon S3 bucket." + }, + "S3Config": { + "type": { + "$ref": "#/88" + }, + "flags": 1 + }, + "S3StorageClass": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The Amazon S3 storage class you want to store your files in when this location is used as a task destination." + }, + "Subdirectory": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "A subdirectory in the Amazon S3 bucket. This subdirectory in Amazon S3 is used to read data from the S3 source location or write data to the S3 destination." + }, + "Tags": { + "type": { + "$ref": "#/91" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.DataSync/LocationS3", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/92" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.DataSync/LocationS3@default", + "scopeType": 0, + "body": { + "$ref": "#/93" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "MountOptions", + "properties": { + "Version": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The specific SMB version that you want DataSync to use to mount your SMB share." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key for an AWS resource tag." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for an AWS resource tag." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.DataSync/LocationSMBProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/96" + } + }, + { + "$type": "ObjectType", + "name": "AWS.DataSync/LocationSMBProperties", + "properties": { + "AgentArns": { + "type": { + "$ref": "#/98" + }, + "flags": 1, + "description": "The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location." + }, + "Domain": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The name of the Windows domain that the SMB server belongs to." + }, + "LocationArn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) of the SMB location that is created." + }, + "LocationUri": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The URL of the SMB location that was described." + }, + "MountOptions": { + "type": { + "$ref": "#/95" + }, + "flags": 0 + }, + "Password": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The password of the user who can mount the share and has the permissions to access files and folders in the SMB share." + }, + "ServerHostname": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The name of the SMB server. This value is the IP address or Domain Name Service (DNS) name of the SMB server." + }, + "Subdirectory": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination" + }, + "Tags": { + "type": { + "$ref": "#/99" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + }, + "User": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The user who can mount the share, has the permissions to access files and folders in the SMB share." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.DataSync/LocationSMB", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/100" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.DataSync/LocationSMB@default", + "scopeType": 0, + "body": { + "$ref": "#/101" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "ServerConfiguration", + "properties": { + "ServerHostname": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The domain name or IP address of the storage system's management interface." + }, + "ServerPort": { + "type": { + "$ref": "#/64" + }, + "flags": 0, + "description": "The network port needed to access the system's management interface" + } + } + }, + { + "$type": "ObjectType", + "name": "ServerCredentials", + "properties": { + "Password": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The password for your storage system's management interface" + }, + "Username": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The username for your storage system's management interface." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key for an AWS resource tag." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for an AWS resource tag." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.DataSync/StorageSystemProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/105" + } + }, + { + "$type": "ObjectType", + "name": "AWS.DataSync/StorageSystemProperties", + "properties": { + "AgentArns": { + "type": { + "$ref": "#/107" + }, + "flags": 1, + "description": "The ARN of the DataSync agent that connects to and reads from the on-premises storage system's management interface." + }, + "CloudWatchLogGroupArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The ARN of the Amazon CloudWatch log group used to monitor and log discovery job events." + }, + "ConnectivityStatus": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "Indicates whether the DataSync agent can access the on-premises storage system." + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A familiar name for the on-premises storage system." + }, + "SecretsManagerArn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The ARN of a secret stored by AWS Secrets Manager." + }, + "ServerConfiguration": { + "type": { + "$ref": "#/103" + }, + "flags": 1 + }, + "ServerCredentials": { + "type": { + "$ref": "#/104" + }, + "flags": 4 + }, + "StorageSystemArn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The ARN of the on-premises storage system added to DataSync Discovery." + }, + "SystemType": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The type of on-premises storage system that DataSync Discovery will analyze." + }, + "Tags": { + "type": { + "$ref": "#/108" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.DataSync/StorageSystem", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/109" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.DataSync/StorageSystem@default", + "scopeType": 0, + "body": { + "$ref": "#/110" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "DestinationNetworkInterfaceArns", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "FilterRule", + "properties": { + "FilterType": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The type of filter rule to apply. AWS DataSync only supports the SIMPLE_PATTERN rule type." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A single filter string that consists of the patterns to include or exclude. The patterns are delimited by \"|\"." + } + } + }, + { + "$type": "ObjectType", + "name": "ManifestConfig", + "properties": { + "Action": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Specifies what DataSync uses the manifest for." + }, + "Format": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Specifies the file format of your manifest." + }, + "Source": { + "type": { + "$ref": "#/123" + }, + "flags": 1, + "description": "Specifies the manifest that you want DataSync to use and where it's hosted." + } + } + }, + { + "$type": "ObjectType", + "name": "ManifestConfigSourceS3", + "properties": { + "BucketAccessRoleArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Specifies the AWS Identity and Access Management (IAM) role that allows DataSync to access your manifest." + }, + "ManifestObjectPath": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Specifies the Amazon S3 object key of your manifest." + }, + "ManifestObjectVersionId": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Specifies the object version ID of the manifest that you want DataSync to use." + }, + "S3BucketArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Specifies the Amazon Resource Name (ARN) of the S3 bucket where you're hosting your manifest." + } + } + }, + { + "$type": "ObjectType", + "name": "Options", + "properties": { + "Atime": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A file metadata value that shows the last time a file was accessed (that is, when the file was read or written to)." + }, + "BytesPerSecond": { + "type": { + "$ref": "#/64" + }, + "flags": 0, + "description": "A value that limits the bandwidth used by AWS DataSync." + }, + "Gid": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The group ID (GID) of the file's owners." + }, + "LogLevel": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A value that determines the types of logs that DataSync publishes to a log stream in the Amazon CloudWatch log group that you provide." + }, + "Mtime": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase." + }, + "ObjectTags": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A value that determines whether object tags should be read from the source object store and written to the destination object store." + }, + "OverwriteMode": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A value that determines whether files at the destination should be overwritten or preserved when copying files." + }, + "PosixPermissions": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A value that determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file." + }, + "PreserveDeletedFiles": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A value that specifies whether files in the destination that don't exist in the source file system should be preserved." + }, + "PreserveDevices": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A value that determines whether AWS DataSync should preserve the metadata of block and character devices in the source file system, and recreate the files with that device name and metadata on the destination." + }, + "SecurityDescriptorCopyFlags": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A value that determines which components of the SMB security descriptor are copied during transfer." + }, + "TaskQueueing": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A value that determines whether tasks should be queued before executing the tasks." + }, + "TransferMode": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A value that determines whether DataSync transfers only the data and metadata that differ between the source and the destination location, or whether DataSync transfers all the content from the source, without comparing to the destination location." + }, + "Uid": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The user ID (UID) of the file's owner." + }, + "VerifyMode": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A value that determines whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred." + } + } + }, + { + "$type": "ObjectType", + "name": "SourceNetworkInterfaceArns", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key for an AWS resource tag." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for an AWS resource tag." + } + } + }, + { + "$type": "ObjectType", + "name": "TaskReportConfig", + "properties": { + "Destination": { + "type": { + "$ref": "#/125" + }, + "flags": 1, + "description": "Specifies where DataSync uploads your task report." + }, + "ObjectVersionIds": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Specifies whether your task report includes the new version of each object transferred into an S3 bucket, this only applies if you enable versioning on your bucket." + }, + "OutputType": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Specifies the type of task report that you want." + }, + "Overrides": { + "type": { + "$ref": "#/130" + }, + "flags": 0, + "description": "Customizes the reporting level for aspects of your task report. For example, your report might generally only include errors, but you could specify that you want a list of successes and errors just for the files that Datasync attempted to delete in your destination location." + }, + "ReportLevel": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't." + } + } + }, + { + "$type": "ObjectType", + "name": "TaskReportConfigDestinationS3", + "properties": { + "BucketAccessRoleArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Specifies the Amazon Resource Name (ARN) of the IAM policy that allows Datasync to upload a task report to your S3 bucket." + }, + "S3BucketArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Specifies the ARN of the S3 bucket where Datasync uploads your report." + }, + "Subdirectory": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Specifies a bucket prefix for your report." + } + } + }, + { + "$type": "ObjectType", + "name": "TaskSchedule", + "properties": { + "ScheduleExpression": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A cron expression that specifies when AWS DataSync initiates a scheduled transfer from a source to a destination location" + }, + "Status": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Specifies status of a schedule." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "Task_Source", + "properties": { + "S3": { + "type": { + "$ref": "#/115" + }, + "flags": 0 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "Task_Destination", + "properties": { + "S3": { + "type": { + "$ref": "#/120" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Task_Overrides_Deleted", + "properties": { + "ReportLevel": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't." + } + } + }, + { + "$type": "ObjectType", + "name": "Task_Overrides_Skipped", + "properties": { + "ReportLevel": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't." + } + } + }, + { + "$type": "ObjectType", + "name": "Task_Overrides_Transferred", + "properties": { + "ReportLevel": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't." + } + } + }, + { + "$type": "ObjectType", + "name": "Task_Overrides_Verified", + "properties": { + "ReportLevel": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't." + } + } + }, + { + "$type": "ObjectType", + "name": "Task_Overrides", + "properties": { + "Deleted": { + "type": { + "$ref": "#/126" + }, + "flags": 0, + "description": "Specifies the level of reporting for the files, objects, and directories that Datasync attempted to delete in your destination location. This only applies if you configure your task to delete data in the destination that isn't in the source." + }, + "Skipped": { + "type": { + "$ref": "#/127" + }, + "flags": 0, + "description": "Specifies the level of reporting for the files, objects, and directories that Datasync attempted to skip during your transfer." + }, + "Transferred": { + "type": { + "$ref": "#/128" + }, + "flags": 0, + "description": "Specifies the level of reporting for the files, objects, and directories that Datasync attempted to transfer." + }, + "Verified": { + "type": { + "$ref": "#/129" + }, + "flags": 0, + "description": "Specifies the level of reporting for the files, objects, and directories that Datasync attempted to verify at the end of your transfer. This only applies if you configure your task to verify data during and after the transfer (which Datasync does by default)" + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.DataSync/TaskProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/118" + } + }, + { + "$type": "ObjectType", + "name": "AWS.DataSync/TaskProperties", + "properties": { + "CloudWatchLogGroupArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The ARN of the Amazon CloudWatch log group that is used to monitor and log events in the task." + }, + "DestinationLocationArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The ARN of an AWS storage resource's location." + }, + "DestinationNetworkInterfaceArns": { + "type": { + "$ref": "#/132" + }, + "flags": 2 + }, + "Excludes": { + "type": { + "$ref": "#/133" + }, + "flags": 0 + }, + "Includes": { + "type": { + "$ref": "#/134" + }, + "flags": 0 + }, + "ManifestConfig": { + "type": { + "$ref": "#/114" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The name of a task. This value is a text reference that is used to identify the task in the console." + }, + "Options": { + "type": { + "$ref": "#/116" + }, + "flags": 0 + }, + "Schedule": { + "type": { + "$ref": "#/121" + }, + "flags": 0 + }, + "SourceLocationArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The ARN of the source location for the task." + }, + "SourceNetworkInterfaceArns": { + "type": { + "$ref": "#/135" + }, + "flags": 2 + }, + "Status": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The status of the task that was described." + }, + "Tags": { + "type": { + "$ref": "#/136" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + }, + "TaskArn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The ARN of the task." + }, + "TaskReportConfig": { + "type": { + "$ref": "#/119" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.DataSync/Task", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/137" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.DataSync/Task@default", + "scopeType": 0, + "body": { + "$ref": "#/138" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.datasync/default/types.md b/artifacts/bicep/aws/aws.datasync/default/types.md index a008a4b1..a3bc0c54 100644 --- a/artifacts/bicep/aws/aws.datasync/default/types.md +++ b/artifacts/bicep/aws/aws.datasync/default/types.md @@ -3,100 +3,100 @@ ## Resource AWS.DataSync/Agent@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.DataSync/AgentProperties](#awsdatasyncagentproperties): properties of the resource +* **properties**: [AWS.DataSync/AgentProperties](#awsdatasyncagentproperties) (Identifier): properties of the resource ## Resource AWS.DataSync/LocationAzureBlob@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.DataSync/LocationAzureBlobProperties](#awsdatasynclocationazureblobproperties) (Required): properties of the resource +* **properties**: [AWS.DataSync/LocationAzureBlobProperties](#awsdatasynclocationazureblobproperties) (Required, Identifier): properties of the resource ## Resource AWS.DataSync/LocationEFS@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.DataSync/LocationEFSProperties](#awsdatasynclocationefsproperties) (Required): properties of the resource +* **properties**: [AWS.DataSync/LocationEFSProperties](#awsdatasynclocationefsproperties) (Required, Identifier): properties of the resource ## Resource AWS.DataSync/LocationFSxLustre@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.DataSync/LocationFSxLustreProperties](#awsdatasynclocationfsxlustreproperties) (Required): properties of the resource +* **properties**: [AWS.DataSync/LocationFSxLustreProperties](#awsdatasynclocationfsxlustreproperties) (Required, Identifier): properties of the resource ## Resource AWS.DataSync/LocationFSxONTAP@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.DataSync/LocationFSxONTAPProperties](#awsdatasynclocationfsxontapproperties) (Required): properties of the resource +* **properties**: [AWS.DataSync/LocationFSxONTAPProperties](#awsdatasynclocationfsxontapproperties) (Required, Identifier): properties of the resource ## Resource AWS.DataSync/LocationFSxOpenZFS@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.DataSync/LocationFSxOpenZFSProperties](#awsdatasynclocationfsxopenzfsproperties) (Required): properties of the resource +* **properties**: [AWS.DataSync/LocationFSxOpenZFSProperties](#awsdatasynclocationfsxopenzfsproperties) (Required, Identifier): properties of the resource ## Resource AWS.DataSync/LocationFSxWindows@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.DataSync/LocationFSxWindowsProperties](#awsdatasynclocationfsxwindowsproperties) (Required): properties of the resource +* **properties**: [AWS.DataSync/LocationFSxWindowsProperties](#awsdatasynclocationfsxwindowsproperties) (Required, Identifier): properties of the resource ## Resource AWS.DataSync/LocationHDFS@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.DataSync/LocationHDFSProperties](#awsdatasynclocationhdfsproperties) (Required): properties of the resource +* **properties**: [AWS.DataSync/LocationHDFSProperties](#awsdatasynclocationhdfsproperties) (Required, Identifier): properties of the resource ## Resource AWS.DataSync/LocationNFS@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.DataSync/LocationNFSProperties](#awsdatasynclocationnfsproperties) (Required): properties of the resource +* **properties**: [AWS.DataSync/LocationNFSProperties](#awsdatasynclocationnfsproperties) (Required, Identifier): properties of the resource ## Resource AWS.DataSync/LocationObjectStorage@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.DataSync/LocationObjectStorageProperties](#awsdatasynclocationobjectstorageproperties) (Required): properties of the resource +* **properties**: [AWS.DataSync/LocationObjectStorageProperties](#awsdatasynclocationobjectstorageproperties) (Required, Identifier): properties of the resource ## Resource AWS.DataSync/LocationS3@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.DataSync/LocationS3Properties](#awsdatasynclocations3properties) (Required): properties of the resource +* **properties**: [AWS.DataSync/LocationS3Properties](#awsdatasynclocations3properties) (Required, Identifier): properties of the resource ## Resource AWS.DataSync/LocationSMB@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.DataSync/LocationSMBProperties](#awsdatasynclocationsmbproperties) (Required): properties of the resource +* **properties**: [AWS.DataSync/LocationSMBProperties](#awsdatasynclocationsmbproperties) (Required, Identifier): properties of the resource ## Resource AWS.DataSync/StorageSystem@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.DataSync/StorageSystemProperties](#awsdatasyncstoragesystemproperties) (Required): properties of the resource +* **properties**: [AWS.DataSync/StorageSystemProperties](#awsdatasyncstoragesystemproperties) (Required, Identifier): properties of the resource ## Resource AWS.DataSync/Task@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.DataSync/TaskProperties](#awsdatasynctaskproperties) (Required): properties of the resource +* **properties**: [AWS.DataSync/TaskProperties](#awsdatasynctaskproperties) (Required, Identifier): properties of the resource ## AWS.DataSync/AgentProperties ### Properties @@ -109,11 +109,6 @@ * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. * **VpcEndpointId**: string: The ID of the VPC endpoint that the agent has access to. -## Tag -### Properties -* **Key**: string (Required): The key for an AWS resource tag. -* **Value**: string (Required): The value for an AWS resource tag. - ## AWS.DataSync/LocationAzureBlobProperties ### Properties * **AgentArns**: string[] (Required): The Amazon Resource Names (ARNs) of agents to use for an Azure Blob Location. @@ -127,15 +122,6 @@ * **Subdirectory**: string (WriteOnly): The subdirectory in the Azure Blob Container that is used to read data from the Azure Blob Source Location. * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. -## AzureBlobSasConfiguration -### Properties -* **AzureBlobSasToken**: string (Required): Specifies the shared access signature (SAS) token, which indicates the permissions DataSync needs to access your Azure Blob Storage container. - -## Tag -### Properties -* **Key**: string (Required): The key for an AWS resource tag. -* **Value**: string (Required): The value for an AWS resource tag. - ## AWS.DataSync/LocationEFSProperties ### Properties * **AccessPointArn**: string: The Amazon Resource Name (ARN) for the Amazon EFS Access point that DataSync uses when accessing the EFS file system. @@ -148,16 +134,6 @@ * **Subdirectory**: string (WriteOnly): A subdirectory in the location's path. This subdirectory in the EFS file system is used to read data from the EFS source location or write data to the EFS destination. * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. -## Ec2Config -### Properties -* **SecurityGroupArns**: string[] (Required): The Amazon Resource Names (ARNs) of the security groups that are configured for the Amazon EC2 resource. -* **SubnetArn**: string (Required): The ARN of the subnet that DataSync uses to access the target EFS file system. - -## Tag -### Properties -* **Key**: string (Required): The key for an AWS resource tag. -* **Value**: string (Required): The value for an AWS resource tag. - ## AWS.DataSync/LocationFSxLustreProperties ### Properties * **FsxFilesystemArn**: string (WriteOnly): The Amazon Resource Name (ARN) for the FSx for Lustre file system. @@ -167,11 +143,6 @@ * **Subdirectory**: string (WriteOnly): A subdirectory in the location's path. * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. -## Tag -### Properties -* **Key**: string (Required): The key for an AWS resource tag. -* **Value**: string (Required): The value for an AWS resource tag. - ## AWS.DataSync/LocationFSxONTAPProperties ### Properties * **FsxFilesystemArn**: string (ReadOnly): The Amazon Resource Name (ARN) for the FSx ONAP file system. @@ -183,35 +154,6 @@ * **Subdirectory**: string (WriteOnly): A subdirectory in the location's path. * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. -## Protocol -### Properties -* **NFS**: [NFS](#nfs) -* **SMB**: [SMB](#smb) - -## NFS -### Properties -* **MountOptions**: [NfsMountOptions](#nfsmountoptions) (Required) - -## NfsMountOptions -### Properties -* **Version**: string: The specific NFS version that you want DataSync to use to mount your NFS share. - -## SMB -### Properties -* **Domain**: string: The name of the Windows domain that the SMB server belongs to. -* **MountOptions**: [SmbMountOptions](#smbmountoptions) (Required) -* **Password**: string (Required): The password of the user who can mount the share and has the permissions to access files and folders in the SMB share. -* **User**: string (Required): The user who can mount the share, has the permissions to access files and folders in the SMB share. - -## SmbMountOptions -### Properties -* **Version**: string: The specific SMB version that you want DataSync to use to mount your SMB share. - -## Tag -### Properties -* **Key**: string (Required): The key for an AWS resource tag. -* **Value**: string (Required): The value for an AWS resource tag. - ## AWS.DataSync/LocationFSxOpenZFSProperties ### Properties * **FsxFilesystemArn**: string (WriteOnly): The Amazon Resource Name (ARN) for the FSx OpenZFS file system. @@ -222,23 +164,6 @@ * **Subdirectory**: string (WriteOnly): A subdirectory in the location's path. * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. -## Protocol -### Properties -* **NFS**: [NFS](#nfs) - -## NFS -### Properties -* **MountOptions**: [MountOptions](#mountoptions) (Required) - -## MountOptions -### Properties -* **Version**: string: The specific NFS version that you want DataSync to use to mount your NFS share. - -## Tag -### Properties -* **Key**: string (Required): The key for an AWS resource tag. -* **Value**: string (Required): The value for an AWS resource tag. - ## AWS.DataSync/LocationFSxWindowsProperties ### Properties * **Domain**: string: The name of the Windows domain that the FSx for Windows server belongs to. @@ -251,11 +176,6 @@ * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. * **User**: string (Required): The user who has the permissions to access files and folders in the FSx for Windows file system. -## Tag -### Properties -* **Key**: string (Required): The key for an AWS resource tag. -* **Value**: string (Required): The value for an AWS resource tag. - ## AWS.DataSync/LocationHDFSProperties ### Properties * **AgentArns**: string[] (Required): ARN(s) of the agent(s) to use for an HDFS location. @@ -274,21 +194,6 @@ * **Subdirectory**: string (WriteOnly): The subdirectory in HDFS that is used to read data from the HDFS source location or write data to the HDFS destination. * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. -## NameNode -### Properties -* **Hostname**: string (Required): The DNS name or IP address of the Name Node in the customer's on premises HDFS cluster. -* **Port**: int (Required): The port on which the Name Node is listening on for client requests. - -## QopConfiguration -### Properties -* **DataTransferProtection**: string: Configuration for Data Transfer Protection. -* **RpcProtection**: string: Configuration for RPC Protection. - -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## AWS.DataSync/LocationNFSProperties ### Properties * **LocationArn**: string (ReadOnly, Identifier): The Amazon Resource Name (ARN) of the NFS location. @@ -299,19 +204,6 @@ * **Subdirectory**: string (WriteOnly): The subdirectory in the NFS file system that is used to read data from the NFS source location or write data to the NFS destination. * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. -## MountOptions -### Properties -* **Version**: string: The specific NFS version that you want DataSync to use to mount your NFS share. - -## OnPremConfig -### Properties -* **AgentArns**: string[] (Required): ARN(s) of the agent(s) to use for an NFS location. - -## Tag -### Properties -* **Key**: string (Required): The key for an AWS resource tag. -* **Value**: string (Required): The value for an AWS resource tag. - ## AWS.DataSync/LocationObjectStorageProperties ### Properties * **AccessKey**: string: Optional. The access key is used if credentials are required to access the self-managed object storage server. @@ -327,11 +219,6 @@ * **Subdirectory**: string (WriteOnly): The subdirectory in the self-managed object storage server that is used to read data from. * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. -## Tag -### Properties -* **Key**: string (Required): The key for an AWS resource tag. -* **Value**: string (Required): The value for an AWS resource tag. - ## AWS.DataSync/LocationS3Properties ### Properties * **LocationArn**: string (ReadOnly, Identifier): The Amazon Resource Name (ARN) of the Amazon S3 bucket location. @@ -342,15 +229,6 @@ * **Subdirectory**: string (WriteOnly): A subdirectory in the Amazon S3 bucket. This subdirectory in Amazon S3 is used to read data from the S3 source location or write data to the S3 destination. * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. -## S3Config -### Properties -* **BucketAccessRoleArn**: string (Required): The ARN of the IAM role of the Amazon S3 bucket. - -## Tag -### Properties -* **Key**: string (Required): The key for an AWS resource tag. -* **Value**: string (Required): The value for an AWS resource tag. - ## AWS.DataSync/LocationSMBProperties ### Properties * **AgentArns**: string[] (Required): The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location. @@ -364,15 +242,6 @@ * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. * **User**: string (Required): The user who can mount the share, has the permissions to access files and folders in the SMB share. -## MountOptions -### Properties -* **Version**: string: The specific SMB version that you want DataSync to use to mount your SMB share. - -## Tag -### Properties -* **Key**: string (Required): The key for an AWS resource tag. -* **Value**: string (Required): The value for an AWS resource tag. - ## AWS.DataSync/StorageSystemProperties ### Properties * **AgentArns**: string[] (Required): The ARN of the DataSync agent that connects to and reads from the on-premises storage system's management interface. @@ -386,21 +255,6 @@ * **SystemType**: string (Required): The type of on-premises storage system that DataSync Discovery will analyze. * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. -## ServerConfiguration -### Properties -* **ServerHostname**: string (Required): The domain name or IP address of the storage system's management interface. -* **ServerPort**: int: The network port needed to access the system's management interface - -## ServerCredentials -### Properties -* **Password**: string (Required): The password for your storage system's management interface -* **Username**: string (Required): The username for your storage system's management interface. - -## Tag -### Properties -* **Key**: string (Required): The key for an AWS resource tag. -* **Value**: string (Required): The value for an AWS resource tag. - ## AWS.DataSync/TaskProperties ### Properties * **CloudWatchLogGroupArn**: string: The ARN of the Amazon CloudWatch log group that is used to monitor and log events in the task. @@ -408,6 +262,7 @@ * **DestinationNetworkInterfaceArns**: string[] (ReadOnly) * **Excludes**: [FilterRule](#filterrule)[] * **Includes**: [FilterRule](#filterrule)[] +* **ManifestConfig**: [ManifestConfig](#manifestconfig) * **Name**: string: The name of a task. This value is a text reference that is used to identify the task in the console. * **Options**: [Options](#options) * **Schedule**: [TaskSchedule](#taskschedule) @@ -418,11 +273,66 @@ * **TaskArn**: string (ReadOnly, Identifier): The ARN of the task. * **TaskReportConfig**: [TaskReportConfig](#taskreportconfig) +## AzureBlobSasConfiguration +### Properties +* **AzureBlobSasToken**: string (Required): Specifies the shared access signature (SAS) token, which indicates the permissions DataSync needs to access your Azure Blob Storage container. + +## Ec2Config +### Properties +* **SecurityGroupArns**: string[] (Required): The Amazon Resource Names (ARNs) of the security groups that are configured for the Amazon EC2 resource. +* **SubnetArn**: string (Required): The ARN of the subnet that DataSync uses to access the target EFS file system. + ## FilterRule ### Properties * **FilterType**: string: The type of filter rule to apply. AWS DataSync only supports the SIMPLE_PATTERN rule type. * **Value**: string: A single filter string that consists of the patterns to include or exclude. The patterns are delimited by "|". +## ManifestConfig +### Properties +* **Action**: string: Specifies what DataSync uses the manifest for. +* **Format**: string: Specifies the file format of your manifest. +* **Source**: [Task_Source](#tasksource) (Required): Specifies the manifest that you want DataSync to use and where it's hosted. + +## ManifestConfigSourceS3 +### Properties +* **BucketAccessRoleArn**: string: Specifies the AWS Identity and Access Management (IAM) role that allows DataSync to access your manifest. +* **ManifestObjectPath**: string: Specifies the Amazon S3 object key of your manifest. +* **ManifestObjectVersionId**: string: Specifies the object version ID of the manifest that you want DataSync to use. +* **S3BucketArn**: string: Specifies the Amazon Resource Name (ARN) of the S3 bucket where you're hosting your manifest. + +## MountOptions +### Properties +* **Version**: string: The specific NFS version that you want DataSync to use to mount your NFS share. + +## MountOptions +### Properties +* **Version**: string: The specific NFS version that you want DataSync to use to mount your NFS share. + +## MountOptions +### Properties +* **Version**: string: The specific SMB version that you want DataSync to use to mount your SMB share. + +## NameNode +### Properties +* **Hostname**: string (Required): The DNS name or IP address of the Name Node in the customer's on premises HDFS cluster. +* **Port**: int (Required): The port on which the Name Node is listening on for client requests. + +## NFS +### Properties +* **MountOptions**: [NfsMountOptions](#nfsmountoptions) (Required) + +## NFS +### Properties +* **MountOptions**: [MountOptions](#mountoptions) (Required) + +## NfsMountOptions +### Properties +* **Version**: string: The specific NFS version that you want DataSync to use to mount your NFS share. + +## OnPremConfig +### Properties +* **AgentArns**: string[] (Required): ARN(s) of the agent(s) to use for an NFS location. + ## Options ### Properties * **Atime**: string: A file metadata value that shows the last time a file was accessed (that is, when the file was read or written to). @@ -441,32 +351,118 @@ * **Uid**: string: The user ID (UID) of the file's owner. * **VerifyMode**: string: A value that determines whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred. -## TaskSchedule +## Protocol +### Properties +* **NFS**: [NFS](#nfs) +* **SMB**: [SMB](#smb) + +## Protocol +### Properties +* **NFS**: [NFS](#nfs) + +## QopConfiguration +### Properties +* **DataTransferProtection**: string: Configuration for Data Transfer Protection. +* **RpcProtection**: string: Configuration for RPC Protection. + +## S3Config +### Properties +* **BucketAccessRoleArn**: string (Required): The ARN of the IAM role of the Amazon S3 bucket. + +## ServerConfiguration +### Properties +* **ServerHostname**: string (Required): The domain name or IP address of the storage system's management interface. +* **ServerPort**: int: The network port needed to access the system's management interface + +## ServerCredentials +### Properties +* **Password**: string (Required): The password for your storage system's management interface +* **Username**: string (Required): The username for your storage system's management interface. + +## SMB +### Properties +* **Domain**: string: The name of the Windows domain that the SMB server belongs to. +* **MountOptions**: [SmbMountOptions](#smbmountoptions) (Required) +* **Password**: string (Required): The password of the user who can mount the share and has the permissions to access files and folders in the SMB share. +* **User**: string (Required): The user who can mount the share, has the permissions to access files and folders in the SMB share. + +## SmbMountOptions ### Properties -* **ScheduleExpression**: string (Required): A cron expression that specifies when AWS DataSync initiates a scheduled transfer from a source to a destination location +* **Version**: string: The specific SMB version that you want DataSync to use to mount your SMB share. ## Tag ### Properties * **Key**: string (Required): The key for an AWS resource tag. * **Value**: string (Required): The value for an AWS resource tag. -## TaskReportConfig +## Tag ### Properties -* **Destination**: [Task_Destination](#taskdestination) (Required): Specifies where DataSync uploads your task report. -* **ObjectVersionIds**: string: Specifies whether your task report includes the new version of each object transferred into an S3 bucket, this only applies if you enable versioning on your bucket. -* **OutputType**: string (Required): Specifies the type of task report that you want. -* **Overrides**: [Task_Overrides](#taskoverrides): Customizes the reporting level for aspects of your task report. For example, your report might generally only include errors, but you could specify that you want a list of successes and errors just for the files that Datasync attempted to delete in your destination location. -* **ReportLevel**: string: Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't. +* **Key**: string (Required): The key for an AWS resource tag. +* **Value**: string (Required): The value for an AWS resource tag. -## Task_Destination +## Tag ### Properties -* **S3**: [Task_Destination_S3](#taskdestinations3): Specifies the Amazon S3 bucket where DataSync uploads your task report. +* **Key**: string (Required): The key for an AWS resource tag. +* **Value**: string (Required): The value for an AWS resource tag. -## Task_Destination_S3 +## Tag ### Properties -* **BucketAccessRoleArn**: string: Specifies the Amazon Resource Name (ARN) of the IAM policy that allows Datasync to upload a task report to your S3 bucket. -* **S3BucketArn**: string: Specifies the ARN of the S3 bucket where Datasync uploads your report. -* **Subdirectory**: string: Specifies a bucket prefix for your report. +* **Key**: string (Required): The key for an AWS resource tag. +* **Value**: string (Required): The value for an AWS resource tag. + +## Tag +### Properties +* **Key**: string (Required): The key for an AWS resource tag. +* **Value**: string (Required): The value for an AWS resource tag. + +## Tag +### Properties +* **Key**: string (Required): The key for an AWS resource tag. +* **Value**: string (Required): The value for an AWS resource tag. + +## Tag +### Properties +* **Key**: string (Required): The key for an AWS resource tag. +* **Value**: string (Required): The value for an AWS resource tag. + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## Tag +### Properties +* **Key**: string (Required): The key for an AWS resource tag. +* **Value**: string (Required): The value for an AWS resource tag. + +## Tag +### Properties +* **Key**: string (Required): The key for an AWS resource tag. +* **Value**: string (Required): The value for an AWS resource tag. + +## Tag +### Properties +* **Key**: string (Required): The key for an AWS resource tag. +* **Value**: string (Required): The value for an AWS resource tag. + +## Tag +### Properties +* **Key**: string (Required): The key for an AWS resource tag. +* **Value**: string (Required): The value for an AWS resource tag. + +## Tag +### Properties +* **Key**: string (Required): The key for an AWS resource tag. +* **Value**: string (Required): The value for an AWS resource tag. + +## Tag +### Properties +* **Key**: string (Required): The key for an AWS resource tag. +* **Value**: string (Required): The value for an AWS resource tag. + +## Task_Destination +### Properties +* **S3**: [TaskReportConfigDestinationS3](#taskreportconfigdestinations3) ## Task_Overrides ### Properties @@ -491,3 +487,26 @@ ### Properties * **ReportLevel**: string: Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't. +## Task_Source +### Properties +* **S3**: [ManifestConfigSourceS3](#manifestconfigsources3) + +## TaskReportConfig +### Properties +* **Destination**: [Task_Destination](#taskdestination) (Required): Specifies where DataSync uploads your task report. +* **ObjectVersionIds**: string: Specifies whether your task report includes the new version of each object transferred into an S3 bucket, this only applies if you enable versioning on your bucket. +* **OutputType**: string (Required): Specifies the type of task report that you want. +* **Overrides**: [Task_Overrides](#taskoverrides): Customizes the reporting level for aspects of your task report. For example, your report might generally only include errors, but you could specify that you want a list of successes and errors just for the files that Datasync attempted to delete in your destination location. +* **ReportLevel**: string: Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't. + +## TaskReportConfigDestinationS3 +### Properties +* **BucketAccessRoleArn**: string: Specifies the Amazon Resource Name (ARN) of the IAM policy that allows Datasync to upload a task report to your S3 bucket. +* **S3BucketArn**: string: Specifies the ARN of the S3 bucket where Datasync uploads your report. +* **Subdirectory**: string: Specifies a bucket prefix for your report. + +## TaskSchedule +### Properties +* **ScheduleExpression**: string: A cron expression that specifies when AWS DataSync initiates a scheduled transfer from a source to a destination location +* **Status**: string: Specifies status of a schedule. + diff --git a/artifacts/bicep/aws/aws.datazone/default/types.json b/artifacts/bicep/aws/aws.datazone/default/types.json new file mode 100644 index 00000000..99fc61ac --- /dev/null +++ b/artifacts/bicep/aws/aws.datazone/default/types.json @@ -0,0 +1,1913 @@ +[ + { + "$type": "ObjectType", + "name": "AccountId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DataAccessRole", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DataSourceConfigurationInput", + "properties": { + "GlueRunConfiguration": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "RedshiftRunConfiguration": { + "type": { + "$ref": "#/13" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DataSourceStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "EnableSetting", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "FilterExpression", + "properties": { + "Expression": { + "type": { + "$ref": "#/22" + }, + "flags": 1 + }, + "Type": { + "type": { + "$ref": "#/22" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "FilterExpressionType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "FormInput", + "properties": { + "Content": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "The content of the metadata form." + }, + "FormName": { + "type": { + "$ref": "#/22" + }, + "flags": 1, + "description": "The name of the metadata form." + }, + "TypeIdentifier": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "The ID of the metadata form type." + }, + "TypeRevision": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "The revision of the metadata form type." + } + } + }, + { + "$type": "ObjectType", + "name": "FormName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "GlueRunConfigurationInput", + "properties": { + "AutoImportDataQualityResult": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "Specifies whether to automatically import data quality metrics as part of the data source run." + }, + "DataAccessRole": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "The data access role included in the configuration details of the AWS Glue data source." + }, + "RelationalFilterConfigurations": { + "type": { + "$ref": "#/24" + }, + "flags": 1, + "description": "The relational filter configurations included in the configuration details of the AWS Glue data source." + } + } + }, + { + "$type": "ObjectType", + "name": "RecommendationConfiguration", + "properties": { + "EnableBusinessNameGeneration": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "Specifies whether automatic business name generation is to be enabled or not as part of the recommendation configuration." + } + } + }, + { + "$type": "ObjectType", + "name": "RedshiftClusterStorage", + "properties": { + "ClusterName": { + "type": { + "$ref": "#/22" + }, + "flags": 1, + "description": "The name of an Amazon Redshift cluster." + } + } + }, + { + "$type": "ObjectType", + "name": "RedshiftCredentialConfiguration", + "properties": { + "SecretManagerArn": { + "type": { + "$ref": "#/22" + }, + "flags": 1, + "description": "The ARN of a secret manager for an Amazon Redshift cluster." + } + } + }, + { + "$type": "ObjectType", + "name": "RedshiftRunConfigurationInput", + "properties": { + "DataAccessRole": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "The data access role included in the configuration details of the Amazon Redshift data source." + }, + "RedshiftCredentialConfiguration": { + "type": { + "$ref": "#/12" + }, + "flags": 1, + "description": "The details of the credentials required to access an Amazon Redshift cluster." + }, + "RedshiftStorage": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "The details of the Amazon Redshift storage as part of the configuration of an Amazon Redshift data source run." + }, + "RelationalFilterConfigurations": { + "type": { + "$ref": "#/26" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "RedshiftServerlessStorage", + "properties": { + "WorkgroupName": { + "type": { + "$ref": "#/22" + }, + "flags": 1, + "description": "The name of the Amazon Redshift Serverless workgroup." + } + } + }, + { + "$type": "ObjectType", + "name": "RedshiftStorage", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Region", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RelationalFilterConfiguration", + "properties": { + "DatabaseName": { + "type": { + "$ref": "#/22" + }, + "flags": 1, + "description": "The database name specified in the relational filter configuration for the data source." + }, + "FilterExpressions": { + "type": { + "$ref": "#/27" + }, + "flags": 0, + "description": "The filter expressions specified in the relational filter configuration for the data source." + }, + "SchemaName": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "The schema name specified in the relational filter configuration for the data source." + } + } + }, + { + "$type": "ObjectType", + "name": "RelationalFilterConfigurations", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ScheduleConfiguration", + "properties": { + "Schedule": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "The schedule of the data source runs." + }, + "Timezone": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "The timezone of the data source run." + } + } + }, + { + "$type": "ObjectType", + "name": "Timezone", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TypeRevision", + "properties": {} + }, + { + "$type": "StringType" + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/17" + } + }, + { + "$type": "ObjectType", + "name": "DataSource_RedshiftStorage", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/17" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/17" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.DataZone/DataSourceProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/7" + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "ObjectType", + "name": "AWS.DataZone/DataSourceProperties", + "properties": { + "AssetFormsInput": { + "type": { + "$ref": "#/30" + }, + "flags": 4, + "description": "The metadata forms that are to be attached to the assets that this data source works with." + }, + "Configuration": { + "type": { + "$ref": "#/2" + }, + "flags": 4, + "description": "Configuration of the data source. It can be set to either glueRunConfiguration or redshiftRunConfiguration." + }, + "CreatedAt": { + "type": { + "$ref": "#/22" + }, + "flags": 2, + "description": "The timestamp of when the data source was created." + }, + "Description": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "The description of the data source." + }, + "DomainId": { + "type": { + "$ref": "#/22" + }, + "flags": 18, + "description": "The ID of the Amazon DataZone domain where the data source is created." + }, + "DomainIdentifier": { + "type": { + "$ref": "#/22" + }, + "flags": 5, + "description": "The ID of the Amazon DataZone domain where the data source is created." + }, + "EnableSetting": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "Specifies whether the data source is enabled." + }, + "EnvironmentId": { + "type": { + "$ref": "#/22" + }, + "flags": 2, + "description": "The unique identifier of the Amazon DataZone environment to which the data source publishes assets." + }, + "EnvironmentIdentifier": { + "type": { + "$ref": "#/22" + }, + "flags": 5, + "description": "The unique identifier of the Amazon DataZone environment to which the data source publishes assets." + }, + "Id": { + "type": { + "$ref": "#/22" + }, + "flags": 18, + "description": "The unique identifier of the data source." + }, + "LastRunAssetCount": { + "type": { + "$ref": "#/31" + }, + "flags": 2, + "description": "The number of assets created by the data source during its last run." + }, + "LastRunAt": { + "type": { + "$ref": "#/22" + }, + "flags": 2, + "description": "The timestamp that specifies when the data source was last run." + }, + "LastRunStatus": { + "type": { + "$ref": "#/22" + }, + "flags": 2, + "description": "The status of the last run of this data source." + }, + "Name": { + "type": { + "$ref": "#/22" + }, + "flags": 1, + "description": "The name of the data source." + }, + "ProjectId": { + "type": { + "$ref": "#/22" + }, + "flags": 2, + "description": "The ID of the Amazon DataZone project to which the data source is added." + }, + "ProjectIdentifier": { + "type": { + "$ref": "#/22" + }, + "flags": 5, + "description": "The identifier of the Amazon DataZone project in which you want to add the data source." + }, + "PublishOnImport": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog." + }, + "Recommendation": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "Specifies whether the business name generation is to be enabled for this data source." + }, + "Schedule": { + "type": { + "$ref": "#/19" + }, + "flags": 0, + "description": "The schedule of the data source runs." + }, + "Status": { + "type": { + "$ref": "#/22" + }, + "flags": 2, + "description": "The status of the data source." + }, + "Type": { + "type": { + "$ref": "#/22" + }, + "flags": 1, + "description": "The type of the data source." + }, + "UpdatedAt": { + "type": { + "$ref": "#/22" + }, + "flags": 2, + "description": "The timestamp of when this data source was updated." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.DataZone/DataSource", + "properties": { + "name": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/22" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/32" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.DataZone/DataSource@default", + "scopeType": 0, + "body": { + "$ref": "#/33" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AuthType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DomainStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SingleSignOn", + "properties": { + "Type": { + "type": { + "$ref": "#/22" + }, + "flags": 0 + }, + "UserAssignment": { + "type": { + "$ref": "#/22" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/22" + }, + "flags": 1, + "description": "The key name of the tag." + }, + "Value": { + "type": { + "$ref": "#/22" + }, + "flags": 1, + "description": "The value for the tag." + } + } + }, + { + "$type": "ObjectType", + "name": "UserAssignment", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.DataZone/DomainProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/38" + } + }, + { + "$type": "ObjectType", + "name": "AWS.DataZone/DomainProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/22" + }, + "flags": 2, + "description": "The ARN of the Amazon DataZone domain." + }, + "CreatedAt": { + "type": { + "$ref": "#/22" + }, + "flags": 2, + "description": "The timestamp of when the Amazon DataZone domain was last updated." + }, + "Description": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "The description of the Amazon DataZone domain." + }, + "DomainExecutionRole": { + "type": { + "$ref": "#/22" + }, + "flags": 1, + "description": "The domain execution role that is created when an Amazon DataZone domain is created. The domain execution role is created in the AWS account that houses the Amazon DataZone domain." + }, + "Id": { + "type": { + "$ref": "#/22" + }, + "flags": 18, + "description": "The id of the Amazon DataZone domain." + }, + "KmsKeyIdentifier": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "The identifier of the AWS Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data." + }, + "LastUpdatedAt": { + "type": { + "$ref": "#/22" + }, + "flags": 2, + "description": "The timestamp of when the Amazon DataZone domain was last updated." + }, + "ManagedAccountId": { + "type": { + "$ref": "#/22" + }, + "flags": 2, + "description": "The identifier of the AWS account that manages the domain." + }, + "Name": { + "type": { + "$ref": "#/22" + }, + "flags": 1, + "description": "The name of the Amazon DataZone domain." + }, + "PortalUrl": { + "type": { + "$ref": "#/22" + }, + "flags": 2, + "description": "The URL of the data portal for this Amazon DataZone domain." + }, + "SingleSignOn": { + "type": { + "$ref": "#/37" + }, + "flags": 0, + "description": "The single-sign on configuration of the Amazon DataZone domain." + }, + "Status": { + "type": { + "$ref": "#/22" + }, + "flags": 2, + "description": "The status of the Amazon DataZone domain." + }, + "Tags": { + "type": { + "$ref": "#/41" + }, + "flags": 0, + "description": "The tags specified for the Amazon DataZone domain." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.DataZone/Domain", + "properties": { + "name": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/22" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/42" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.DataZone/Domain@default", + "scopeType": 0, + "body": { + "$ref": "#/43" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "EnvironmentParameter", + "properties": { + "Name": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "The name of an environment parameter." + }, + "Value": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "The value of an environment parameter." + } + } + }, + { + "$type": "ObjectType", + "name": "EnvironmentStatus", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.DataZone/EnvironmentProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/22" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/45" + } + }, + { + "$type": "ObjectType", + "name": "AWS.DataZone/EnvironmentProperties", + "properties": { + "AwsAccountId": { + "type": { + "$ref": "#/22" + }, + "flags": 2, + "description": "The AWS account in which the Amazon DataZone environment is created." + }, + "AwsAccountRegion": { + "type": { + "$ref": "#/22" + }, + "flags": 2, + "description": "The AWS region in which the Amazon DataZone environment is created." + }, + "CreatedAt": { + "type": { + "$ref": "#/22" + }, + "flags": 2, + "description": "The timestamp of when the environment was created." + }, + "CreatedBy": { + "type": { + "$ref": "#/22" + }, + "flags": 2, + "description": "The Amazon DataZone user who created the environment." + }, + "Description": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "The description of the Amazon DataZone environment." + }, + "DomainId": { + "type": { + "$ref": "#/22" + }, + "flags": 18, + "description": "The identifier of the Amazon DataZone domain in which the environment is created." + }, + "DomainIdentifier": { + "type": { + "$ref": "#/22" + }, + "flags": 5, + "description": "The identifier of the Amazon DataZone domain in which the environment would be created." + }, + "EnvironmentBlueprintId": { + "type": { + "$ref": "#/22" + }, + "flags": 2, + "description": "The ID of the blueprint with which the Amazon DataZone environment was created." + }, + "EnvironmentProfileId": { + "type": { + "$ref": "#/22" + }, + "flags": 2, + "description": "The ID of the environment profile with which the Amazon DataZone environment was created." + }, + "EnvironmentProfileIdentifier": { + "type": { + "$ref": "#/22" + }, + "flags": 5, + "description": "The ID of the environment profile with which the Amazon DataZone environment would be created." + }, + "GlossaryTerms": { + "type": { + "$ref": "#/48" + }, + "flags": 0, + "description": "The glossary terms that can be used in the Amazon DataZone environment." + }, + "Id": { + "type": { + "$ref": "#/22" + }, + "flags": 18, + "description": "The ID of the Amazon DataZone environment." + }, + "Name": { + "type": { + "$ref": "#/22" + }, + "flags": 1, + "description": "The name of the environment." + }, + "ProjectId": { + "type": { + "$ref": "#/22" + }, + "flags": 2, + "description": "The ID of the Amazon DataZone project in which the environment is created." + }, + "ProjectIdentifier": { + "type": { + "$ref": "#/22" + }, + "flags": 5, + "description": "The ID of the Amazon DataZone project in which the environment would be created." + }, + "Provider": { + "type": { + "$ref": "#/22" + }, + "flags": 2, + "description": "The provider of the Amazon DataZone environment." + }, + "Status": { + "type": { + "$ref": "#/22" + }, + "flags": 2, + "description": "The status of the Amazon DataZone environment." + }, + "UpdatedAt": { + "type": { + "$ref": "#/22" + }, + "flags": 2, + "description": "The timestamp of when the environment was updated." + }, + "UserParameters": { + "type": { + "$ref": "#/49" + }, + "flags": 0, + "description": "The user parameters of the Amazon DataZone environment." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.DataZone/Environment", + "properties": { + "name": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/22" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/50" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.DataZone/Environment@default", + "scopeType": 0, + "body": { + "$ref": "#/51" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Parameter", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RegionalParameter", + "properties": { + "Parameters": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "Region": { + "type": { + "$ref": "#/22" + }, + "flags": 0 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.DataZone/EnvironmentBlueprintConfigurationProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/22" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/54" + } + }, + { + "$type": "ObjectType", + "name": "AWS.DataZone/EnvironmentBlueprintConfigurationProperties", + "properties": { + "CreatedAt": { + "type": { + "$ref": "#/22" + }, + "flags": 2 + }, + "DomainId": { + "type": { + "$ref": "#/22" + }, + "flags": 18 + }, + "DomainIdentifier": { + "type": { + "$ref": "#/22" + }, + "flags": 5 + }, + "EnabledRegions": { + "type": { + "$ref": "#/56" + }, + "flags": 1 + }, + "EnvironmentBlueprintId": { + "type": { + "$ref": "#/22" + }, + "flags": 18 + }, + "EnvironmentBlueprintIdentifier": { + "type": { + "$ref": "#/22" + }, + "flags": 5 + }, + "ManageAccessRoleArn": { + "type": { + "$ref": "#/22" + }, + "flags": 0 + }, + "ProvisioningRoleArn": { + "type": { + "$ref": "#/22" + }, + "flags": 0 + }, + "RegionalParameters": { + "type": { + "$ref": "#/57" + }, + "flags": 0 + }, + "UpdatedAt": { + "type": { + "$ref": "#/22" + }, + "flags": 2 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.DataZone/EnvironmentBlueprintConfiguration", + "properties": { + "name": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/22" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/58" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.DataZone/EnvironmentBlueprintConfiguration@default", + "scopeType": 0, + "body": { + "$ref": "#/59" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "EnvironmentParameter", + "properties": { + "Name": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "The name of an environment profile parameter." + }, + "Value": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "The value of an environment profile parameter." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.DataZone/EnvironmentProfileProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/61" + } + }, + { + "$type": "ObjectType", + "name": "AWS.DataZone/EnvironmentProfileProperties", + "properties": { + "AwsAccountId": { + "type": { + "$ref": "#/22" + }, + "flags": 1, + "description": "The AWS account in which the Amazon DataZone environment is created." + }, + "AwsAccountRegion": { + "type": { + "$ref": "#/22" + }, + "flags": 1, + "description": "The AWS region in which this environment profile is created." + }, + "CreatedAt": { + "type": { + "$ref": "#/22" + }, + "flags": 2, + "description": "The timestamp of when this environment profile was created." + }, + "CreatedBy": { + "type": { + "$ref": "#/22" + }, + "flags": 2, + "description": "The Amazon DataZone user who created this environment profile." + }, + "Description": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "The description of this Amazon DataZone environment profile." + }, + "DomainId": { + "type": { + "$ref": "#/22" + }, + "flags": 18, + "description": "The ID of the Amazon DataZone domain in which this environment profile is created." + }, + "DomainIdentifier": { + "type": { + "$ref": "#/22" + }, + "flags": 5, + "description": "The ID of the Amazon DataZone domain in which this environment profile is created." + }, + "EnvironmentBlueprintId": { + "type": { + "$ref": "#/22" + }, + "flags": 2, + "description": "The ID of the blueprint with which this environment profile is created." + }, + "EnvironmentBlueprintIdentifier": { + "type": { + "$ref": "#/22" + }, + "flags": 5, + "description": "The ID of the blueprint with which this environment profile is created." + }, + "Id": { + "type": { + "$ref": "#/22" + }, + "flags": 18, + "description": "The ID of this Amazon DataZone environment profile." + }, + "Name": { + "type": { + "$ref": "#/22" + }, + "flags": 1, + "description": "The name of this Amazon DataZone environment profile." + }, + "ProjectId": { + "type": { + "$ref": "#/22" + }, + "flags": 2, + "description": "The identifier of the project in which to create the environment profile." + }, + "ProjectIdentifier": { + "type": { + "$ref": "#/22" + }, + "flags": 5, + "description": "The identifier of the project in which to create the environment profile." + }, + "UpdatedAt": { + "type": { + "$ref": "#/22" + }, + "flags": 2, + "description": "The timestamp of when this environment profile was updated." + }, + "UserParameters": { + "type": { + "$ref": "#/63" + }, + "flags": 0, + "description": "The user parameters of this Amazon DataZone environment profile." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.DataZone/EnvironmentProfile", + "properties": { + "name": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/22" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/64" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.DataZone/EnvironmentProfile@default", + "scopeType": 0, + "body": { + "$ref": "#/65" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "GroupProfileStatus", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.DataZone/GroupProfileProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.DataZone/GroupProfileProperties", + "properties": { + "DomainId": { + "type": { + "$ref": "#/22" + }, + "flags": 18, + "description": "The identifier of the Amazon DataZone domain in which the group profile is created." + }, + "DomainIdentifier": { + "type": { + "$ref": "#/22" + }, + "flags": 5, + "description": "The identifier of the Amazon DataZone domain in which the group profile would be created." + }, + "GroupIdentifier": { + "type": { + "$ref": "#/22" + }, + "flags": 5, + "description": "The ID of the group." + }, + "GroupName": { + "type": { + "$ref": "#/22" + }, + "flags": 2, + "description": "The group-name of the Group Profile." + }, + "Id": { + "type": { + "$ref": "#/22" + }, + "flags": 18, + "description": "The ID of the Amazon DataZone group profile." + }, + "Status": { + "type": { + "$ref": "#/22" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.DataZone/GroupProfile", + "properties": { + "name": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/22" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/69" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.DataZone/GroupProfile@default", + "scopeType": 0, + "body": { + "$ref": "#/70" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.DataZone/ProjectProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/22" + } + }, + { + "$type": "ObjectType", + "name": "AWS.DataZone/ProjectProperties", + "properties": { + "CreatedAt": { + "type": { + "$ref": "#/22" + }, + "flags": 2, + "description": "The timestamp of when the project was created." + }, + "CreatedBy": { + "type": { + "$ref": "#/22" + }, + "flags": 2, + "description": "The Amazon DataZone user who created the project." + }, + "Description": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "The description of the Amazon DataZone project." + }, + "DomainId": { + "type": { + "$ref": "#/22" + }, + "flags": 18, + "description": "The identifier of the Amazon DataZone domain in which the project was created." + }, + "DomainIdentifier": { + "type": { + "$ref": "#/22" + }, + "flags": 5, + "description": "The ID of the Amazon DataZone domain in which this project is created." + }, + "GlossaryTerms": { + "type": { + "$ref": "#/73" + }, + "flags": 0, + "description": "The glossary terms that can be used in this Amazon DataZone project." + }, + "Id": { + "type": { + "$ref": "#/22" + }, + "flags": 18, + "description": "The ID of the Amazon DataZone project." + }, + "LastUpdatedAt": { + "type": { + "$ref": "#/22" + }, + "flags": 2, + "description": "The timestamp of when the project was last updated." + }, + "Name": { + "type": { + "$ref": "#/22" + }, + "flags": 1, + "description": "The name of the Amazon DataZone project." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.DataZone/Project", + "properties": { + "name": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/22" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/74" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.DataZone/Project@default", + "scopeType": 0, + "body": { + "$ref": "#/75" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Member", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MemberIdentifierType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "UserDesignation", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.DataZone/ProjectMembershipProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.DataZone/ProjectMembershipProperties", + "properties": { + "Designation": { + "type": { + "$ref": "#/22" + }, + "flags": 5 + }, + "DomainIdentifier": { + "type": { + "$ref": "#/22" + }, + "flags": 17 + }, + "Member": { + "type": { + "$ref": "#/77" + }, + "flags": 5 + }, + "ProjectIdentifier": { + "type": { + "$ref": "#/22" + }, + "flags": 17 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.DataZone/ProjectMembership", + "properties": { + "name": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/22" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/81" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.DataZone/ProjectMembership@default", + "scopeType": 0, + "body": { + "$ref": "#/82" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "SubscriptionTargetForm", + "properties": { + "Content": { + "type": { + "$ref": "#/22" + }, + "flags": 1, + "description": "The content of the subscription target configuration." + }, + "FormName": { + "type": { + "$ref": "#/22" + }, + "flags": 1, + "description": "The form name included in the subscription target configuration." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.DataZone/SubscriptionTargetProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/22" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/22" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/84" + } + }, + { + "$type": "ObjectType", + "name": "AWS.DataZone/SubscriptionTargetProperties", + "properties": { + "ApplicableAssetTypes": { + "type": { + "$ref": "#/86" + }, + "flags": 1, + "description": "The asset types that can be included in the subscription target." + }, + "AuthorizedPrincipals": { + "type": { + "$ref": "#/87" + }, + "flags": 1, + "description": "The authorized principals of the subscription target." + }, + "CreatedAt": { + "type": { + "$ref": "#/22" + }, + "flags": 2, + "description": "The timestamp of when the subscription target was created." + }, + "CreatedBy": { + "type": { + "$ref": "#/22" + }, + "flags": 2, + "description": "The Amazon DataZone user who created the subscription target." + }, + "DomainId": { + "type": { + "$ref": "#/22" + }, + "flags": 18, + "description": "The ID of the Amazon DataZone domain in which subscription target is created." + }, + "DomainIdentifier": { + "type": { + "$ref": "#/22" + }, + "flags": 5, + "description": "The ID of the Amazon DataZone domain in which subscription target would be created." + }, + "EnvironmentId": { + "type": { + "$ref": "#/22" + }, + "flags": 18, + "description": "The ID of the environment in which subscription target is created." + }, + "EnvironmentIdentifier": { + "type": { + "$ref": "#/22" + }, + "flags": 5, + "description": "The ID of the environment in which subscription target would be created." + }, + "Id": { + "type": { + "$ref": "#/22" + }, + "flags": 18, + "description": "The ID of the subscription target." + }, + "ManageAccessRole": { + "type": { + "$ref": "#/22" + }, + "flags": 1, + "description": "The manage access role that is used to create the subscription target." + }, + "Name": { + "type": { + "$ref": "#/22" + }, + "flags": 1, + "description": "The name of the subscription target." + }, + "ProjectId": { + "type": { + "$ref": "#/22" + }, + "flags": 2, + "description": "The identifier of the project specified in the subscription target." + }, + "Provider": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "The provider of the subscription target." + }, + "SubscriptionTargetConfig": { + "type": { + "$ref": "#/88" + }, + "flags": 1, + "description": "The configuration of the subscription target." + }, + "Type": { + "type": { + "$ref": "#/22" + }, + "flags": 1, + "description": "The type of the subscription target." + }, + "UpdatedAt": { + "type": { + "$ref": "#/22" + }, + "flags": 2, + "description": "The timestamp of when the subscription target was updated." + }, + "UpdatedBy": { + "type": { + "$ref": "#/22" + }, + "flags": 2, + "description": "The Amazon DataZone user who updated the subscription target." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.DataZone/SubscriptionTarget", + "properties": { + "name": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/22" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/89" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.DataZone/SubscriptionTarget@default", + "scopeType": 0, + "body": { + "$ref": "#/90" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "IamUserProfileDetails", + "properties": { + "Arn": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "The ARN of the IAM User Profile." + } + } + }, + { + "$type": "ObjectType", + "name": "SsoUserProfileDetails", + "properties": { + "FirstName": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "The First Name of the IAM User Profile." + }, + "LastName": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "The Last Name of the IAM User Profile." + }, + "Username": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "The username of the SSO User Profile." + } + } + }, + { + "$type": "ObjectType", + "name": "UserProfileDetails", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "UserProfileStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "UserProfileType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "UserType", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.DataZone/UserProfileProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.DataZone/UserProfileProperties", + "properties": { + "Details": { + "type": { + "$ref": "#/94" + }, + "flags": 2 + }, + "DomainId": { + "type": { + "$ref": "#/22" + }, + "flags": 18, + "description": "The identifier of the Amazon DataZone domain in which the user profile is created." + }, + "DomainIdentifier": { + "type": { + "$ref": "#/22" + }, + "flags": 5, + "description": "The identifier of the Amazon DataZone domain in which the user profile would be created." + }, + "Id": { + "type": { + "$ref": "#/22" + }, + "flags": 18, + "description": "The ID of the Amazon DataZone user profile." + }, + "Status": { + "type": { + "$ref": "#/22" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/22" + }, + "flags": 2 + }, + "UserIdentifier": { + "type": { + "$ref": "#/22" + }, + "flags": 5, + "description": "The ID of the user." + }, + "UserType": { + "type": { + "$ref": "#/22" + }, + "flags": 4 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.DataZone/UserProfile", + "properties": { + "name": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/22" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/99" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.DataZone/UserProfile@default", + "scopeType": 0, + "body": { + "$ref": "#/100" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.datazone/default/types.md b/artifacts/bicep/aws/aws.datazone/default/types.md new file mode 100644 index 00000000..f1f392d5 --- /dev/null +++ b/artifacts/bicep/aws/aws.datazone/default/types.md @@ -0,0 +1,316 @@ +# AWS.DataZone @ default + +## Resource AWS.DataZone/DataSource@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.DataZone/DataSourceProperties](#awsdatazonedatasourceproperties) (Required, Identifier): properties of the resource + +## Resource AWS.DataZone/Domain@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.DataZone/DomainProperties](#awsdatazonedomainproperties) (Required, Identifier): properties of the resource + +## Resource AWS.DataZone/Environment@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.DataZone/EnvironmentProperties](#awsdatazoneenvironmentproperties) (Required, Identifier): properties of the resource + +## Resource AWS.DataZone/EnvironmentBlueprintConfiguration@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.DataZone/EnvironmentBlueprintConfigurationProperties](#awsdatazoneenvironmentblueprintconfigurationproperties) (Required, Identifier): properties of the resource + +## Resource AWS.DataZone/EnvironmentProfile@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.DataZone/EnvironmentProfileProperties](#awsdatazoneenvironmentprofileproperties) (Required, Identifier): properties of the resource + +## Resource AWS.DataZone/GroupProfile@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.DataZone/GroupProfileProperties](#awsdatazonegroupprofileproperties) (Required, Identifier): properties of the resource + +## Resource AWS.DataZone/Project@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.DataZone/ProjectProperties](#awsdatazoneprojectproperties) (Required, Identifier): properties of the resource + +## Resource AWS.DataZone/ProjectMembership@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.DataZone/ProjectMembershipProperties](#awsdatazoneprojectmembershipproperties) (Required, Identifier): properties of the resource + +## Resource AWS.DataZone/SubscriptionTarget@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.DataZone/SubscriptionTargetProperties](#awsdatazonesubscriptiontargetproperties) (Required, Identifier): properties of the resource + +## Resource AWS.DataZone/UserProfile@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.DataZone/UserProfileProperties](#awsdatazoneuserprofileproperties) (Required, Identifier): properties of the resource + +## AWS.DataZone/DataSourceProperties +### Properties +* **AssetFormsInput**: [FormInput](#forminput)[] (WriteOnly): The metadata forms that are to be attached to the assets that this data source works with. +* **Configuration**: [DataSourceConfigurationInput](#datasourceconfigurationinput) (WriteOnly): Configuration of the data source. It can be set to either glueRunConfiguration or redshiftRunConfiguration. +* **CreatedAt**: string (ReadOnly): The timestamp of when the data source was created. +* **Description**: string: The description of the data source. +* **DomainId**: string (ReadOnly, Identifier): The ID of the Amazon DataZone domain where the data source is created. +* **DomainIdentifier**: string (Required, WriteOnly): The ID of the Amazon DataZone domain where the data source is created. +* **EnableSetting**: string: Specifies whether the data source is enabled. +* **EnvironmentId**: string (ReadOnly): The unique identifier of the Amazon DataZone environment to which the data source publishes assets. +* **EnvironmentIdentifier**: string (Required, WriteOnly): The unique identifier of the Amazon DataZone environment to which the data source publishes assets. +* **Id**: string (ReadOnly, Identifier): The unique identifier of the data source. +* **LastRunAssetCount**: int (ReadOnly): The number of assets created by the data source during its last run. +* **LastRunAt**: string (ReadOnly): The timestamp that specifies when the data source was last run. +* **LastRunStatus**: string (ReadOnly): The status of the last run of this data source. +* **Name**: string (Required): The name of the data source. +* **ProjectId**: string (ReadOnly): The ID of the Amazon DataZone project to which the data source is added. +* **ProjectIdentifier**: string (Required, WriteOnly): The identifier of the Amazon DataZone project in which you want to add the data source. +* **PublishOnImport**: bool: Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog. +* **Recommendation**: [RecommendationConfiguration](#recommendationconfiguration): Specifies whether the business name generation is to be enabled for this data source. +* **Schedule**: [ScheduleConfiguration](#scheduleconfiguration): The schedule of the data source runs. +* **Status**: string (ReadOnly): The status of the data source. +* **Type**: string (Required): The type of the data source. +* **UpdatedAt**: string (ReadOnly): The timestamp of when this data source was updated. + +## AWS.DataZone/DomainProperties +### Properties +* **Arn**: string (ReadOnly): The ARN of the Amazon DataZone domain. +* **CreatedAt**: string (ReadOnly): The timestamp of when the Amazon DataZone domain was last updated. +* **Description**: string: The description of the Amazon DataZone domain. +* **DomainExecutionRole**: string (Required): The domain execution role that is created when an Amazon DataZone domain is created. The domain execution role is created in the AWS account that houses the Amazon DataZone domain. +* **Id**: string (ReadOnly, Identifier): The id of the Amazon DataZone domain. +* **KmsKeyIdentifier**: string: The identifier of the AWS Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data. +* **LastUpdatedAt**: string (ReadOnly): The timestamp of when the Amazon DataZone domain was last updated. +* **ManagedAccountId**: string (ReadOnly): The identifier of the AWS account that manages the domain. +* **Name**: string (Required): The name of the Amazon DataZone domain. +* **PortalUrl**: string (ReadOnly): The URL of the data portal for this Amazon DataZone domain. +* **SingleSignOn**: [SingleSignOn](#singlesignon): The single-sign on configuration of the Amazon DataZone domain. +* **Status**: string (ReadOnly): The status of the Amazon DataZone domain. +* **Tags**: [Tag](#tag)[]: The tags specified for the Amazon DataZone domain. + +## AWS.DataZone/EnvironmentBlueprintConfigurationProperties +### Properties +* **CreatedAt**: string (ReadOnly) +* **DomainId**: string (ReadOnly, Identifier) +* **DomainIdentifier**: string (Required, WriteOnly) +* **EnabledRegions**: string[] (Required) +* **EnvironmentBlueprintId**: string (ReadOnly, Identifier) +* **EnvironmentBlueprintIdentifier**: string (Required, WriteOnly) +* **ManageAccessRoleArn**: string +* **ProvisioningRoleArn**: string +* **RegionalParameters**: [RegionalParameter](#regionalparameter)[] +* **UpdatedAt**: string (ReadOnly) + +## AWS.DataZone/EnvironmentProfileProperties +### Properties +* **AwsAccountId**: string (Required): The AWS account in which the Amazon DataZone environment is created. +* **AwsAccountRegion**: string (Required): The AWS region in which this environment profile is created. +* **CreatedAt**: string (ReadOnly): The timestamp of when this environment profile was created. +* **CreatedBy**: string (ReadOnly): The Amazon DataZone user who created this environment profile. +* **Description**: string: The description of this Amazon DataZone environment profile. +* **DomainId**: string (ReadOnly, Identifier): The ID of the Amazon DataZone domain in which this environment profile is created. +* **DomainIdentifier**: string (Required, WriteOnly): The ID of the Amazon DataZone domain in which this environment profile is created. +* **EnvironmentBlueprintId**: string (ReadOnly): The ID of the blueprint with which this environment profile is created. +* **EnvironmentBlueprintIdentifier**: string (Required, WriteOnly): The ID of the blueprint with which this environment profile is created. +* **Id**: string (ReadOnly, Identifier): The ID of this Amazon DataZone environment profile. +* **Name**: string (Required): The name of this Amazon DataZone environment profile. +* **ProjectId**: string (ReadOnly): The identifier of the project in which to create the environment profile. +* **ProjectIdentifier**: string (Required, WriteOnly): The identifier of the project in which to create the environment profile. +* **UpdatedAt**: string (ReadOnly): The timestamp of when this environment profile was updated. +* **UserParameters**: [EnvironmentParameter](#environmentparameter)[]: The user parameters of this Amazon DataZone environment profile. + +## AWS.DataZone/EnvironmentProperties +### Properties +* **AwsAccountId**: string (ReadOnly): The AWS account in which the Amazon DataZone environment is created. +* **AwsAccountRegion**: string (ReadOnly): The AWS region in which the Amazon DataZone environment is created. +* **CreatedAt**: string (ReadOnly): The timestamp of when the environment was created. +* **CreatedBy**: string (ReadOnly): The Amazon DataZone user who created the environment. +* **Description**: string: The description of the Amazon DataZone environment. +* **DomainId**: string (ReadOnly, Identifier): The identifier of the Amazon DataZone domain in which the environment is created. +* **DomainIdentifier**: string (Required, WriteOnly): The identifier of the Amazon DataZone domain in which the environment would be created. +* **EnvironmentBlueprintId**: string (ReadOnly): The ID of the blueprint with which the Amazon DataZone environment was created. +* **EnvironmentProfileId**: string (ReadOnly): The ID of the environment profile with which the Amazon DataZone environment was created. +* **EnvironmentProfileIdentifier**: string (Required, WriteOnly): The ID of the environment profile with which the Amazon DataZone environment would be created. +* **GlossaryTerms**: string[]: The glossary terms that can be used in the Amazon DataZone environment. +* **Id**: string (ReadOnly, Identifier): The ID of the Amazon DataZone environment. +* **Name**: string (Required): The name of the environment. +* **ProjectId**: string (ReadOnly): The ID of the Amazon DataZone project in which the environment is created. +* **ProjectIdentifier**: string (Required, WriteOnly): The ID of the Amazon DataZone project in which the environment would be created. +* **Provider**: string (ReadOnly): The provider of the Amazon DataZone environment. +* **Status**: string (ReadOnly): The status of the Amazon DataZone environment. +* **UpdatedAt**: string (ReadOnly): The timestamp of when the environment was updated. +* **UserParameters**: [EnvironmentParameter](#environmentparameter)[]: The user parameters of the Amazon DataZone environment. + +## AWS.DataZone/GroupProfileProperties +### Properties +* **DomainId**: string (ReadOnly, Identifier): The identifier of the Amazon DataZone domain in which the group profile is created. +* **DomainIdentifier**: string (Required, WriteOnly): The identifier of the Amazon DataZone domain in which the group profile would be created. +* **GroupIdentifier**: string (Required, WriteOnly): The ID of the group. +* **GroupName**: string (ReadOnly): The group-name of the Group Profile. +* **Id**: string (ReadOnly, Identifier): The ID of the Amazon DataZone group profile. +* **Status**: string + +## AWS.DataZone/ProjectMembershipProperties +### Properties +* **Designation**: string (Required, WriteOnly) +* **DomainIdentifier**: string (Required, Identifier) +* **Member**: [Member](#member) (Required, WriteOnly) +* **ProjectIdentifier**: string (Required, Identifier) + +## AWS.DataZone/ProjectProperties +### Properties +* **CreatedAt**: string (ReadOnly): The timestamp of when the project was created. +* **CreatedBy**: string (ReadOnly): The Amazon DataZone user who created the project. +* **Description**: string: The description of the Amazon DataZone project. +* **DomainId**: string (ReadOnly, Identifier): The identifier of the Amazon DataZone domain in which the project was created. +* **DomainIdentifier**: string (Required, WriteOnly): The ID of the Amazon DataZone domain in which this project is created. +* **GlossaryTerms**: string[]: The glossary terms that can be used in this Amazon DataZone project. +* **Id**: string (ReadOnly, Identifier): The ID of the Amazon DataZone project. +* **LastUpdatedAt**: string (ReadOnly): The timestamp of when the project was last updated. +* **Name**: string (Required): The name of the Amazon DataZone project. + +## AWS.DataZone/SubscriptionTargetProperties +### Properties +* **ApplicableAssetTypes**: string[] (Required): The asset types that can be included in the subscription target. +* **AuthorizedPrincipals**: string[] (Required): The authorized principals of the subscription target. +* **CreatedAt**: string (ReadOnly): The timestamp of when the subscription target was created. +* **CreatedBy**: string (ReadOnly): The Amazon DataZone user who created the subscription target. +* **DomainId**: string (ReadOnly, Identifier): The ID of the Amazon DataZone domain in which subscription target is created. +* **DomainIdentifier**: string (Required, WriteOnly): The ID of the Amazon DataZone domain in which subscription target would be created. +* **EnvironmentId**: string (ReadOnly, Identifier): The ID of the environment in which subscription target is created. +* **EnvironmentIdentifier**: string (Required, WriteOnly): The ID of the environment in which subscription target would be created. +* **Id**: string (ReadOnly, Identifier): The ID of the subscription target. +* **ManageAccessRole**: string (Required): The manage access role that is used to create the subscription target. +* **Name**: string (Required): The name of the subscription target. +* **ProjectId**: string (ReadOnly): The identifier of the project specified in the subscription target. +* **Provider**: string: The provider of the subscription target. +* **SubscriptionTargetConfig**: [SubscriptionTargetForm](#subscriptiontargetform)[] (Required): The configuration of the subscription target. +* **Type**: string (Required): The type of the subscription target. +* **UpdatedAt**: string (ReadOnly): The timestamp of when the subscription target was updated. +* **UpdatedBy**: string (ReadOnly): The Amazon DataZone user who updated the subscription target. + +## AWS.DataZone/UserProfileProperties +### Properties +* **Details**: [UserProfileDetails](#userprofiledetails) (ReadOnly) +* **DomainId**: string (ReadOnly, Identifier): The identifier of the Amazon DataZone domain in which the user profile is created. +* **DomainIdentifier**: string (Required, WriteOnly): The identifier of the Amazon DataZone domain in which the user profile would be created. +* **Id**: string (ReadOnly, Identifier): The ID of the Amazon DataZone user profile. +* **Status**: string +* **Type**: string (ReadOnly) +* **UserIdentifier**: string (Required, WriteOnly): The ID of the user. +* **UserType**: string (WriteOnly) + +## DataSource_RedshiftStorage +### Properties + +## DataSourceConfigurationInput +### Properties +* **GlueRunConfiguration**: [GlueRunConfigurationInput](#gluerunconfigurationinput) +* **RedshiftRunConfiguration**: [RedshiftRunConfigurationInput](#redshiftrunconfigurationinput) + +## EnvironmentParameter +### Properties +* **Name**: string: The name of an environment parameter. +* **Value**: string: The value of an environment parameter. + +## EnvironmentParameter +### Properties +* **Name**: string: The name of an environment profile parameter. +* **Value**: string: The value of an environment profile parameter. + +## FilterExpression +### Properties +* **Expression**: string (Required) +* **Type**: string (Required) + +## FormInput +### Properties +* **Content**: string: The content of the metadata form. +* **FormName**: string (Required): The name of the metadata form. +* **TypeIdentifier**: string: The ID of the metadata form type. +* **TypeRevision**: string: The revision of the metadata form type. + +## GlueRunConfigurationInput +### Properties +* **AutoImportDataQualityResult**: bool: Specifies whether to automatically import data quality metrics as part of the data source run. +* **DataAccessRole**: string: The data access role included in the configuration details of the AWS Glue data source. +* **RelationalFilterConfigurations**: [RelationalFilterConfiguration](#relationalfilterconfiguration)[] (Required): The relational filter configurations included in the configuration details of the AWS Glue data source. + +## Member +### Properties + +## Parameter +### Properties + +## RecommendationConfiguration +### Properties +* **EnableBusinessNameGeneration**: bool: Specifies whether automatic business name generation is to be enabled or not as part of the recommendation configuration. + +## RedshiftCredentialConfiguration +### Properties +* **SecretManagerArn**: string (Required): The ARN of a secret manager for an Amazon Redshift cluster. + +## RedshiftRunConfigurationInput +### Properties +* **DataAccessRole**: string: The data access role included in the configuration details of the Amazon Redshift data source. +* **RedshiftCredentialConfiguration**: [RedshiftCredentialConfiguration](#redshiftcredentialconfiguration) (Required): The details of the credentials required to access an Amazon Redshift cluster. +* **RedshiftStorage**: [DataSource_RedshiftStorage](#datasourceredshiftstorage) (Required): The details of the Amazon Redshift storage as part of the configuration of an Amazon Redshift data source run. +* **RelationalFilterConfigurations**: [RelationalFilterConfiguration](#relationalfilterconfiguration)[] (Required) + +## RegionalParameter +### Properties +* **Parameters**: [Parameter](#parameter) +* **Region**: string + +## RelationalFilterConfiguration +### Properties +* **DatabaseName**: string (Required): The database name specified in the relational filter configuration for the data source. +* **FilterExpressions**: [FilterExpression](#filterexpression)[]: The filter expressions specified in the relational filter configuration for the data source. +* **SchemaName**: string: The schema name specified in the relational filter configuration for the data source. + +## ScheduleConfiguration +### Properties +* **Schedule**: string: The schedule of the data source runs. +* **Timezone**: string: The timezone of the data source run. + +## SingleSignOn +### Properties +* **Type**: string +* **UserAssignment**: string + +## SubscriptionTargetForm +### Properties +* **Content**: string (Required): The content of the subscription target configuration. +* **FormName**: string (Required): The form name included in the subscription target configuration. + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. +* **Value**: string (Required): The value for the tag. + +## UserProfileDetails +### Properties + diff --git a/artifacts/bicep/aws/aws.deadline/default/types.json b/artifacts/bicep/aws/aws.deadline/default/types.json new file mode 100644 index 00000000..6202c1c4 --- /dev/null +++ b/artifacts/bicep/aws/aws.deadline/default/types.json @@ -0,0 +1,1390 @@ +[ + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.Deadline/FarmProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Deadline/FarmProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 18 + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "DisplayName": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "FarmId": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "KmsKeyArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Deadline/Farm", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Deadline/Farm@default", + "scopeType": 0, + "body": { + "$ref": "#/5" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AcceleratorCountRange", + "properties": { + "Max": { + "type": { + "$ref": "#/29" + }, + "flags": 0 + }, + "Min": { + "type": { + "$ref": "#/29" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AcceleratorTotalMemoryMiBRange", + "properties": { + "Max": { + "type": { + "$ref": "#/29" + }, + "flags": 0 + }, + "Min": { + "type": { + "$ref": "#/29" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AcceleratorType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AutoScalingMode", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CpuArchitectureType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CustomerManagedFleetConfiguration", + "properties": { + "Mode": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "StorageProfileId": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "WorkerCapabilities": { + "type": { + "$ref": "#/14" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomerManagedFleetOperatingSystemFamily", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CustomerManagedWorkerCapabilities", + "properties": { + "AcceleratorCount": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "AcceleratorTotalMemoryMiB": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "AcceleratorTypes": { + "type": { + "$ref": "#/30" + }, + "flags": 0 + }, + "CpuArchitectureType": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "CustomAmounts": { + "type": { + "$ref": "#/31" + }, + "flags": 0 + }, + "CustomAttributes": { + "type": { + "$ref": "#/32" + }, + "flags": 0 + }, + "MemoryMiB": { + "type": { + "$ref": "#/22" + }, + "flags": 1 + }, + "OsFamily": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "VCpuCount": { + "type": { + "$ref": "#/28" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Ec2EbsVolume", + "properties": { + "Iops": { + "type": { + "$ref": "#/29" + }, + "flags": 0 + }, + "SizeGiB": { + "type": { + "$ref": "#/29" + }, + "flags": 0 + }, + "ThroughputMiB": { + "type": { + "$ref": "#/29" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Ec2MarketType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "FleetAmountCapability", + "properties": { + "Max": { + "type": { + "$ref": "#/29" + }, + "flags": 0 + }, + "Min": { + "type": { + "$ref": "#/29" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "FleetAttributeCapability", + "properties": { + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Values": { + "type": { + "$ref": "#/33" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "FleetCapabilities", + "properties": { + "Amounts": { + "type": { + "$ref": "#/34" + }, + "flags": 0 + }, + "Attributes": { + "type": { + "$ref": "#/35" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FleetConfiguration", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "FleetStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MemoryMiBRange", + "properties": { + "Max": { + "type": { + "$ref": "#/29" + }, + "flags": 0 + }, + "Min": { + "type": { + "$ref": "#/29" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ServiceManagedEc2FleetConfiguration", + "properties": { + "InstanceCapabilities": { + "type": { + "$ref": "#/24" + }, + "flags": 1 + }, + "InstanceMarketOptions": { + "type": { + "$ref": "#/25" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ServiceManagedEc2InstanceCapabilities", + "properties": { + "AllowedInstanceTypes": { + "type": { + "$ref": "#/36" + }, + "flags": 0 + }, + "CpuArchitectureType": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "CustomAmounts": { + "type": { + "$ref": "#/37" + }, + "flags": 0 + }, + "CustomAttributes": { + "type": { + "$ref": "#/38" + }, + "flags": 0 + }, + "ExcludedInstanceTypes": { + "type": { + "$ref": "#/39" + }, + "flags": 0 + }, + "MemoryMiB": { + "type": { + "$ref": "#/22" + }, + "flags": 1 + }, + "OsFamily": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "RootEbsVolume": { + "type": { + "$ref": "#/15" + }, + "flags": 0 + }, + "VCpuCount": { + "type": { + "$ref": "#/28" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ServiceManagedEc2InstanceMarketOptions", + "properties": { + "Type": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ServiceManagedFleetOperatingSystemFamily", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + } + } + }, + { + "$type": "ObjectType", + "name": "VCpuCountRange", + "properties": { + "Max": { + "type": { + "$ref": "#/29" + }, + "flags": 0 + }, + "Min": { + "type": { + "$ref": "#/29" + }, + "flags": 1 + } + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/17" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/18" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/17" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/18" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/17" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/18" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Deadline/FleetProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/27" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Deadline/FleetProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 18 + }, + "Capabilities": { + "type": { + "$ref": "#/19" + }, + "flags": 2 + }, + "Configuration": { + "type": { + "$ref": "#/20" + }, + "flags": 1 + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "DisplayName": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "FarmId": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "FleetId": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "MaxWorkerCount": { + "type": { + "$ref": "#/29" + }, + "flags": 1 + }, + "MinWorkerCount": { + "type": { + "$ref": "#/29" + }, + "flags": 0 + }, + "RoleArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Status": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "Tags": { + "type": { + "$ref": "#/41" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + }, + "WorkerCount": { + "type": { + "$ref": "#/29" + }, + "flags": 2 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Deadline/Fleet", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/42" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Deadline/Fleet@default", + "scopeType": 0, + "body": { + "$ref": "#/43" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "LicenseEndpointStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Deadline/LicenseEndpointProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/46" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Deadline/LicenseEndpointProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 18 + }, + "DnsName": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "LicenseEndpointId": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "SecurityGroupIds": { + "type": { + "$ref": "#/48" + }, + "flags": 1 + }, + "Status": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "StatusMessage": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "SubnetIds": { + "type": { + "$ref": "#/49" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/50" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + }, + "VpcId": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Deadline/LicenseEndpoint", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/51" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Deadline/LicenseEndpoint@default", + "scopeType": 0, + "body": { + "$ref": "#/52" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.Deadline/MonitorProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.Deadline/MonitorProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 18 + }, + "DisplayName": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "IdentityCenterApplicationArn": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "IdentityCenterInstanceArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "MonitorId": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "RoleArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Subdomain": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Url": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Deadline/Monitor", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/55" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Deadline/Monitor@default", + "scopeType": 0, + "body": { + "$ref": "#/56" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "DefaultQueueBudgetAction", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "JobAttachmentSettings", + "properties": { + "RootPrefix": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "S3BucketName": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "JobRunAsUser", + "properties": { + "Posix": { + "type": { + "$ref": "#/61" + }, + "flags": 0 + }, + "RunAs": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Windows": { + "type": { + "$ref": "#/64" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PosixUser", + "properties": { + "Group": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "User": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "RunAs", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + } + } + }, + { + "$type": "ObjectType", + "name": "WindowsUser", + "properties": { + "PasswordArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "User": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Deadline/QueueProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/63" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Deadline/QueueProperties", + "properties": { + "AllowedStorageProfileIds": { + "type": { + "$ref": "#/66" + }, + "flags": 0 + }, + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 18 + }, + "DefaultBudgetAction": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "DisplayName": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "FarmId": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "JobAttachmentSettings": { + "type": { + "$ref": "#/59" + }, + "flags": 0 + }, + "JobRunAsUser": { + "type": { + "$ref": "#/60" + }, + "flags": 0 + }, + "QueueId": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "RequiredFileSystemLocationNames": { + "type": { + "$ref": "#/67" + }, + "flags": 0 + }, + "RoleArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/68" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Deadline/Queue", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/69" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Deadline/Queue@default", + "scopeType": 0, + "body": { + "$ref": "#/70" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "EnvironmentTemplateType", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.Deadline/QueueEnvironmentProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.Deadline/QueueEnvironmentProperties", + "properties": { + "FarmId": { + "type": { + "$ref": "#/1" + }, + "flags": 17 + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "Priority": { + "type": { + "$ref": "#/29" + }, + "flags": 1 + }, + "QueueEnvironmentId": { + "type": { + "$ref": "#/1" + }, + "flags": 18 + }, + "QueueId": { + "type": { + "$ref": "#/1" + }, + "flags": 17 + }, + "Template": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "TemplateType": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Deadline/QueueEnvironment", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/74" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Deadline/QueueEnvironment@default", + "scopeType": 0, + "body": { + "$ref": "#/75" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "FileSystemLocation", + "properties": { + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Path": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Type": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "FileSystemLocationType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "StorageProfileOperatingSystemFamily", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.Deadline/StorageProfileProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/77" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Deadline/StorageProfileProperties", + "properties": { + "DisplayName": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "FarmId": { + "type": { + "$ref": "#/1" + }, + "flags": 16 + }, + "FileSystemLocations": { + "type": { + "$ref": "#/81" + }, + "flags": 0 + }, + "OsFamily": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "StorageProfileId": { + "type": { + "$ref": "#/1" + }, + "flags": 18 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Deadline/StorageProfile", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/82" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Deadline/StorageProfile@default", + "scopeType": 0, + "body": { + "$ref": "#/83" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.deadline/default/types.md b/artifacts/bicep/aws/aws.deadline/default/types.md new file mode 100644 index 00000000..eb1b27d2 --- /dev/null +++ b/artifacts/bicep/aws/aws.deadline/default/types.md @@ -0,0 +1,198 @@ +# AWS.Deadline @ default + +## Resource AWS.Deadline/Farm@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.Deadline/FarmProperties](#awsdeadlinefarmproperties) (Required, Identifier): properties of the resource + +## Resource AWS.Deadline/Fleet@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.Deadline/FleetProperties](#awsdeadlinefleetproperties) (Required, Identifier): properties of the resource + +## Resource AWS.Deadline/LicenseEndpoint@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.Deadline/LicenseEndpointProperties](#awsdeadlinelicenseendpointproperties) (Required, Identifier): properties of the resource + +## Resource AWS.Deadline/Monitor@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.Deadline/MonitorProperties](#awsdeadlinemonitorproperties) (Required, Identifier): properties of the resource + +## Resource AWS.Deadline/Queue@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.Deadline/QueueProperties](#awsdeadlinequeueproperties) (Required, Identifier): properties of the resource + +## Resource AWS.Deadline/QueueEnvironment@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.Deadline/QueueEnvironmentProperties](#awsdeadlinequeueenvironmentproperties) (Required, Identifier): properties of the resource + +## Resource AWS.Deadline/StorageProfile@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.Deadline/StorageProfileProperties](#awsdeadlinestorageprofileproperties) (Required, Identifier): properties of the resource + +## AWS.Deadline/FarmProperties +### Properties +* **Arn**: string (ReadOnly, Identifier) +* **Description**: string +* **DisplayName**: string (Required) +* **FarmId**: string (ReadOnly) +* **KmsKeyArn**: string +* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. + +## AWS.Deadline/FleetProperties +### Properties +* **Arn**: string (ReadOnly, Identifier) +* **Capabilities**: [FleetCapabilities](#fleetcapabilities) (ReadOnly) +* **Configuration**: [FleetConfiguration](#fleetconfiguration) (Required) +* **Description**: string +* **DisplayName**: string (Required) +* **FarmId**: string +* **FleetId**: string (ReadOnly) +* **MaxWorkerCount**: int (Required) +* **MinWorkerCount**: int +* **RoleArn**: string (Required) +* **Status**: string (ReadOnly) +* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. +* **WorkerCount**: int (ReadOnly) + +## AWS.Deadline/LicenseEndpointProperties +### Properties +* **Arn**: string (ReadOnly, Identifier) +* **DnsName**: string (ReadOnly) +* **LicenseEndpointId**: string (ReadOnly) +* **SecurityGroupIds**: string[] (Required) +* **Status**: string (ReadOnly) +* **StatusMessage**: string (ReadOnly) +* **SubnetIds**: string[] (Required) +* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. +* **VpcId**: string (Required) + +## AWS.Deadline/MonitorProperties +### Properties +* **Arn**: string (ReadOnly, Identifier) +* **DisplayName**: string (Required) +* **IdentityCenterApplicationArn**: string (ReadOnly) +* **IdentityCenterInstanceArn**: string (Required) +* **MonitorId**: string (ReadOnly) +* **RoleArn**: string (Required) +* **Subdomain**: string (Required) +* **Url**: string (ReadOnly) + +## AWS.Deadline/QueueEnvironmentProperties +### Properties +* **FarmId**: string (Required, Identifier) +* **Name**: string (ReadOnly) +* **Priority**: int (Required) +* **QueueEnvironmentId**: string (ReadOnly, Identifier) +* **QueueId**: string (Required, Identifier) +* **Template**: string (Required) +* **TemplateType**: string (Required) + +## AWS.Deadline/QueueProperties +### Properties +* **AllowedStorageProfileIds**: string[] +* **Arn**: string (ReadOnly, Identifier) +* **DefaultBudgetAction**: string +* **Description**: string +* **DisplayName**: string (Required) +* **FarmId**: string +* **JobAttachmentSettings**: [JobAttachmentSettings](#jobattachmentsettings) +* **JobRunAsUser**: [JobRunAsUser](#jobrunasuser) +* **QueueId**: string (ReadOnly) +* **RequiredFileSystemLocationNames**: string[] +* **RoleArn**: string +* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. + +## AWS.Deadline/StorageProfileProperties +### Properties +* **DisplayName**: string (Required) +* **FarmId**: string (Identifier) +* **FileSystemLocations**: [FileSystemLocation](#filesystemlocation)[] +* **OsFamily**: string (Required) +* **StorageProfileId**: string (ReadOnly, Identifier) + +## FileSystemLocation +### Properties +* **Name**: string (Required) +* **Path**: string (Required) +* **Type**: string (Required) + +## FleetAmountCapability +### Properties +* **Max**: int +* **Min**: int (Required) +* **Name**: string (Required) + +## FleetAttributeCapability +### Properties +* **Name**: string (Required) +* **Values**: string[] (Required) + +## FleetCapabilities +### Properties +* **Amounts**: [FleetAmountCapability](#fleetamountcapability)[] +* **Attributes**: [FleetAttributeCapability](#fleetattributecapability)[] + +## FleetConfiguration +### Properties + +## JobAttachmentSettings +### Properties +* **RootPrefix**: string (Required) +* **S3BucketName**: string (Required) + +## JobRunAsUser +### Properties +* **Posix**: [PosixUser](#posixuser) +* **RunAs**: string (Required) +* **Windows**: [WindowsUser](#windowsuser) + +## PosixUser +### Properties +* **Group**: string (Required) +* **User**: string (Required) + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## WindowsUser +### Properties +* **PasswordArn**: string (Required) +* **User**: string (Required) + diff --git a/artifacts/bicep/aws/aws.detective/default/types.json b/artifacts/bicep/aws/aws.detective/default/types.json index 6aaddc4d..7ab050c4 100644 --- a/artifacts/bicep/aws/aws.detective/default/types.json +++ b/artifacts/bicep/aws/aws.detective/default/types.json @@ -1 +1,241 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":0,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @ "},"Value":{"Type":4,"Flags":0,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @ "}}}},{"2":{"Name":"AWS.Detective/GraphProperties","Properties":{"Arn":{"Type":4,"Flags":18,"Description":"The Detective graph ARN"},"AutoEnableMembers":{"Type":2,"Flags":0,"Description":"Indicates whether to automatically enable new organization accounts as member accounts in the organization behavior graph."},"Tags":{"Type":10,"Flags":0}}}},{"3":{"ItemType":8}},{"2":{"Name":"AWS.Detective/Graph","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":9,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Detective/Graph@default","ScopeType":0,"Body":11}},{"2":{"Name":"AWS.Detective/MemberInvitationProperties","Properties":{"DisableEmailNotification":{"Type":2,"Flags":4,"Description":"When set to true, invitation emails are not sent to the member accounts. Member accounts must still accept the invitation before they are added to the behavior graph. Updating this field has no effect."},"GraphArn":{"Type":4,"Flags":17,"Description":"The ARN of the graph to which the member account will be invited"},"MemberEmailAddress":{"Type":4,"Flags":1,"Description":"The root email address for the account to be invited, for validation. Updating this field has no effect."},"MemberId":{"Type":4,"Flags":17,"Description":"The AWS account ID to be invited to join the graph as a member"},"Message":{"Type":4,"Flags":4,"Description":"A message to be included in the email invitation sent to the invited account. Updating this field has no effect."}}}},{"2":{"Name":"AWS.Detective/MemberInvitation","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":13,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Detective/MemberInvitation@default","ScopeType":0,"Body":14}},{"2":{"Name":"AWS.Detective/OrganizationAdminProperties","Properties":{"AccountId":{"Type":4,"Flags":17,"Description":"The account ID of the account that should be registered as your Organization's delegated administrator for Detective"},"GraphArn":{"Type":4,"Flags":2,"Description":"The Detective graph ARN"}}}},{"2":{"Name":"AWS.Detective/OrganizationAdmin","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":16,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Detective/OrganizationAdmin@default","ScopeType":0,"Body":17}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @ " + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @ " + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.Detective/GraphProperties" + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Detective/GraphProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The Detective graph ARN" + }, + "AutoEnableMembers": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "Indicates whether to automatically enable new organization accounts as member accounts in the organization behavior graph." + }, + "Tags": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Detective/Graph", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/5" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Detective/Graph@default", + "scopeType": 0, + "body": { + "$ref": "#/6" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.Detective/MemberInvitationProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.Detective/MemberInvitationProperties", + "properties": { + "DisableEmailNotification": { + "type": { + "$ref": "#/3" + }, + "flags": 4, + "description": "When set to true, invitation emails are not sent to the member accounts. Member accounts must still accept the invitation before they are added to the behavior graph. Updating this field has no effect." + }, + "GraphArn": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The ARN of the graph to which the member account will be invited" + }, + "MemberEmailAddress": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The root email address for the account to be invited, for validation. Updating this field has no effect." + }, + "MemberId": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The AWS account ID to be invited to join the graph as a member" + }, + "Message": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "A message to be included in the email invitation sent to the invited account. Updating this field has no effect." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Detective/MemberInvitation", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/9" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Detective/MemberInvitation@default", + "scopeType": 0, + "body": { + "$ref": "#/10" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.Detective/OrganizationAdminProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.Detective/OrganizationAdminProperties", + "properties": { + "AccountId": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The account ID of the account that should be registered as your Organization's delegated administrator for Detective" + }, + "GraphArn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The Detective graph ARN" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Detective/OrganizationAdmin", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/13" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Detective/OrganizationAdmin@default", + "scopeType": 0, + "body": { + "$ref": "#/14" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.detective/default/types.md b/artifacts/bicep/aws/aws.detective/default/types.md index 92ef05ef..f0f5d909 100644 --- a/artifacts/bicep/aws/aws.detective/default/types.md +++ b/artifacts/bicep/aws/aws.detective/default/types.md @@ -3,23 +3,23 @@ ## Resource AWS.Detective/Graph@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Detective/GraphProperties](#awsdetectivegraphproperties): properties of the resource +* **properties**: [AWS.Detective/GraphProperties](#awsdetectivegraphproperties) (Identifier): properties of the resource ## Resource AWS.Detective/MemberInvitation@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Detective/MemberInvitationProperties](#awsdetectivememberinvitationproperties) (Required): properties of the resource +* **properties**: [AWS.Detective/MemberInvitationProperties](#awsdetectivememberinvitationproperties) (Required, Identifier): properties of the resource ## Resource AWS.Detective/OrganizationAdmin@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Detective/OrganizationAdminProperties](#awsdetectiveorganizationadminproperties) (Required): properties of the resource +* **properties**: [AWS.Detective/OrganizationAdminProperties](#awsdetectiveorganizationadminproperties) (Required, Identifier): properties of the resource ## AWS.Detective/GraphProperties ### Properties @@ -27,11 +27,6 @@ * **AutoEnableMembers**: bool: Indicates whether to automatically enable new organization accounts as member accounts in the organization behavior graph. * **Tags**: [Tag](#tag)[] -## Tag -### Properties -* **Key**: string: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @ -* **Value**: string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @ - ## AWS.Detective/MemberInvitationProperties ### Properties * **DisableEmailNotification**: bool (WriteOnly): When set to true, invitation emails are not sent to the member accounts. Member accounts must still accept the invitation before they are added to the behavior graph. Updating this field has no effect. @@ -45,3 +40,8 @@ * **AccountId**: string (Required, Identifier): The account ID of the account that should be registered as your Organization's delegated administrator for Detective * **GraphArn**: string (ReadOnly): The Detective graph ARN +## Tag +### Properties +* **Key**: string: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @ +* **Value**: string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @ + diff --git a/artifacts/bicep/aws/aws.devicefarm/default/types.json b/artifacts/bicep/aws/aws.devicefarm/default/types.json index 8b25d16e..472c2c24 100644 --- a/artifacts/bicep/aws/aws.devicefarm/default/types.json +++ b/artifacts/bicep/aws/aws.devicefarm/default/types.json @@ -1 +1,805 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"Rule","Properties":{"Attribute":{"Type":4,"Flags":0,"Description":"The rule's stringified attribute."},"Operator":{"Type":4,"Flags":0,"Description":"Specifies how Device Farm compares the rule's attribute to the value."},"Value":{"Type":4,"Flags":0,"Description":"The rule's value."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.DeviceFarm/DevicePoolProperties","Properties":{"Arn":{"Type":4,"Flags":18},"Description":{"Type":4,"Flags":0},"MaxDevices":{"Type":3,"Flags":0},"Name":{"Type":4,"Flags":1},"ProjectArn":{"Type":4,"Flags":1},"Rules":{"Type":11,"Flags":1},"Tags":{"Type":12,"Flags":0}}}},{"3":{"ItemType":8}},{"3":{"ItemType":9}},{"2":{"Name":"AWS.DeviceFarm/DevicePool","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":10,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.DeviceFarm/DevicePool@default","ScopeType":0,"Body":13}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.DeviceFarm/InstanceProfileProperties","Properties":{"Arn":{"Type":4,"Flags":18},"Description":{"Type":4,"Flags":0},"ExcludeAppPackagesFromCleanup":{"Type":17,"Flags":0},"Name":{"Type":4,"Flags":1},"PackageCleanup":{"Type":2,"Flags":0},"RebootAfterUse":{"Type":2,"Flags":0},"Tags":{"Type":18,"Flags":0}}}},{"3":{"ItemType":4}},{"3":{"ItemType":15}},{"2":{"Name":"AWS.DeviceFarm/InstanceProfile","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":16,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.DeviceFarm/InstanceProfile@default","ScopeType":0,"Body":19}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.DeviceFarm/NetworkProfileProperties","Properties":{"Arn":{"Type":4,"Flags":18},"Description":{"Type":4,"Flags":0},"DownlinkBandwidthBits":{"Type":3,"Flags":0},"DownlinkDelayMs":{"Type":3,"Flags":0},"DownlinkJitterMs":{"Type":3,"Flags":0},"DownlinkLossPercent":{"Type":3,"Flags":0},"Name":{"Type":4,"Flags":1},"ProjectArn":{"Type":4,"Flags":1},"Tags":{"Type":23,"Flags":0},"UplinkBandwidthBits":{"Type":3,"Flags":0},"UplinkDelayMs":{"Type":3,"Flags":0},"UplinkJitterMs":{"Type":3,"Flags":0},"UplinkLossPercent":{"Type":3,"Flags":0}}}},{"3":{"ItemType":21}},{"2":{"Name":"AWS.DeviceFarm/NetworkProfile","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":22,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.DeviceFarm/NetworkProfile@default","ScopeType":0,"Body":24}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"VpcConfig","Properties":{"SecurityGroupIds":{"Type":28,"Flags":1,"Description":"An array of security group Ids in your Amazon VPC"},"SubnetIds":{"Type":29,"Flags":1,"Description":"A array of subnet IDs in your Amazon VPC."},"VpcId":{"Type":4,"Flags":1,"Description":"The ID of the Amazon VPC"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.DeviceFarm/ProjectProperties","Properties":{"Arn":{"Type":4,"Flags":18},"DefaultJobTimeoutMinutes":{"Type":3,"Flags":0},"Name":{"Type":4,"Flags":1},"Tags":{"Type":31,"Flags":0},"VpcConfig":{"Type":27,"Flags":0}}}},{"3":{"ItemType":26}},{"2":{"Name":"AWS.DeviceFarm/Project","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":30,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.DeviceFarm/Project@default","ScopeType":0,"Body":32}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"VpcConfig","Properties":{"SecurityGroupIds":{"Type":36,"Flags":1,"Description":"A list of VPC security group IDs in your Amazon VPC."},"SubnetIds":{"Type":37,"Flags":1,"Description":"A list of VPC subnet IDs in your Amazon VPC."},"VpcId":{"Type":4,"Flags":1}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.DeviceFarm/TestGridProjectProperties","Properties":{"Arn":{"Type":4,"Flags":18},"Description":{"Type":4,"Flags":0},"Name":{"Type":4,"Flags":1},"Tags":{"Type":39,"Flags":0},"VpcConfig":{"Type":35,"Flags":4}}}},{"3":{"ItemType":34}},{"2":{"Name":"AWS.DeviceFarm/TestGridProject","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":38,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.DeviceFarm/TestGridProject@default","ScopeType":0,"Body":40}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.DeviceFarm/VPCEConfigurationProperties","Properties":{"Arn":{"Type":4,"Flags":18},"ServiceDnsName":{"Type":4,"Flags":1},"Tags":{"Type":44,"Flags":0},"VpceConfigurationDescription":{"Type":4,"Flags":0},"VpceConfigurationName":{"Type":4,"Flags":1},"VpceServiceName":{"Type":4,"Flags":1}}}},{"3":{"ItemType":42}},{"2":{"Name":"AWS.DeviceFarm/VPCEConfiguration","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":43,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.DeviceFarm/VPCEConfiguration@default","ScopeType":0,"Body":45}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Rule", + "properties": { + "Attribute": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The rule's stringified attribute." + }, + "Operator": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "Specifies how Device Farm compares the rule's attribute to the value." + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The rule's value." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.DeviceFarm/DevicePoolProperties" + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "AWS.DeviceFarm/DevicePoolProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/2" + }, + "flags": 18 + }, + "Description": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "MaxDevices": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "ProjectArn": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Rules": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.DeviceFarm/DevicePool", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/7" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.DeviceFarm/DevicePool@default", + "scopeType": 0, + "body": { + "$ref": "#/8" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.DeviceFarm/InstanceProfileProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/10" + } + }, + { + "$type": "ObjectType", + "name": "AWS.DeviceFarm/InstanceProfileProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/2" + }, + "flags": 18 + }, + "Description": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "ExcludeAppPackagesFromCleanup": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "PackageCleanup": { + "type": { + "$ref": "#/13" + }, + "flags": 0 + }, + "RebootAfterUse": { + "type": { + "$ref": "#/13" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.DeviceFarm/InstanceProfile", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/15" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.DeviceFarm/InstanceProfile@default", + "scopeType": 0, + "body": { + "$ref": "#/16" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.DeviceFarm/NetworkProfileProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/18" + } + }, + { + "$type": "ObjectType", + "name": "AWS.DeviceFarm/NetworkProfileProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/2" + }, + "flags": 18 + }, + "Description": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "DownlinkBandwidthBits": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "DownlinkDelayMs": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "DownlinkJitterMs": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "DownlinkLossPercent": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "ProjectArn": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/20" + }, + "flags": 0 + }, + "UplinkBandwidthBits": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "UplinkDelayMs": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "UplinkJitterMs": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "UplinkLossPercent": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.DeviceFarm/NetworkProfile", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/21" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.DeviceFarm/NetworkProfile@default", + "scopeType": 0, + "body": { + "$ref": "#/22" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "VpcConfig", + "properties": { + "SecurityGroupIds": { + "type": { + "$ref": "#/26" + }, + "flags": 1, + "description": "An array of security group Ids in your Amazon VPC" + }, + "SubnetIds": { + "type": { + "$ref": "#/27" + }, + "flags": 1, + "description": "A array of subnet IDs in your Amazon VPC." + }, + "VpcId": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The ID of the Amazon VPC" + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.DeviceFarm/ProjectProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/24" + } + }, + { + "$type": "ObjectType", + "name": "AWS.DeviceFarm/ProjectProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/2" + }, + "flags": 18 + }, + "DefaultJobTimeoutMinutes": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/29" + }, + "flags": 0 + }, + "VpcConfig": { + "type": { + "$ref": "#/25" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.DeviceFarm/Project", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/30" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.DeviceFarm/Project@default", + "scopeType": 0, + "body": { + "$ref": "#/31" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "VpcConfig", + "properties": { + "SecurityGroupIds": { + "type": { + "$ref": "#/35" + }, + "flags": 1, + "description": "A list of VPC security group IDs in your Amazon VPC." + }, + "SubnetIds": { + "type": { + "$ref": "#/36" + }, + "flags": 1, + "description": "A list of VPC subnet IDs in your Amazon VPC." + }, + "VpcId": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.DeviceFarm/TestGridProjectProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/33" + } + }, + { + "$type": "ObjectType", + "name": "AWS.DeviceFarm/TestGridProjectProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/2" + }, + "flags": 18 + }, + "Description": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/38" + }, + "flags": 0 + }, + "VpcConfig": { + "type": { + "$ref": "#/34" + }, + "flags": 4 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.DeviceFarm/TestGridProject", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/39" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.DeviceFarm/TestGridProject@default", + "scopeType": 0, + "body": { + "$ref": "#/40" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.DeviceFarm/VPCEConfigurationProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/42" + } + }, + { + "$type": "ObjectType", + "name": "AWS.DeviceFarm/VPCEConfigurationProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/2" + }, + "flags": 18 + }, + "ServiceDnsName": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/44" + }, + "flags": 0 + }, + "VpceConfigurationDescription": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "VpceConfigurationName": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "VpceServiceName": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.DeviceFarm/VPCEConfiguration", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/45" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.DeviceFarm/VPCEConfiguration@default", + "scopeType": 0, + "body": { + "$ref": "#/46" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.devicefarm/default/types.md b/artifacts/bicep/aws/aws.devicefarm/default/types.md index b0764633..6a30d310 100644 --- a/artifacts/bicep/aws/aws.devicefarm/default/types.md +++ b/artifacts/bicep/aws/aws.devicefarm/default/types.md @@ -3,44 +3,44 @@ ## Resource AWS.DeviceFarm/DevicePool@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.DeviceFarm/DevicePoolProperties](#awsdevicefarmdevicepoolproperties) (Required): properties of the resource +* **properties**: [AWS.DeviceFarm/DevicePoolProperties](#awsdevicefarmdevicepoolproperties) (Required, Identifier): properties of the resource ## Resource AWS.DeviceFarm/InstanceProfile@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.DeviceFarm/InstanceProfileProperties](#awsdevicefarminstanceprofileproperties) (Required): properties of the resource +* **properties**: [AWS.DeviceFarm/InstanceProfileProperties](#awsdevicefarminstanceprofileproperties) (Required, Identifier): properties of the resource ## Resource AWS.DeviceFarm/NetworkProfile@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.DeviceFarm/NetworkProfileProperties](#awsdevicefarmnetworkprofileproperties) (Required): properties of the resource +* **properties**: [AWS.DeviceFarm/NetworkProfileProperties](#awsdevicefarmnetworkprofileproperties) (Required, Identifier): properties of the resource ## Resource AWS.DeviceFarm/Project@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.DeviceFarm/ProjectProperties](#awsdevicefarmprojectproperties) (Required): properties of the resource +* **properties**: [AWS.DeviceFarm/ProjectProperties](#awsdevicefarmprojectproperties) (Required, Identifier): properties of the resource ## Resource AWS.DeviceFarm/TestGridProject@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.DeviceFarm/TestGridProjectProperties](#awsdevicefarmtestgridprojectproperties) (Required): properties of the resource +* **properties**: [AWS.DeviceFarm/TestGridProjectProperties](#awsdevicefarmtestgridprojectproperties) (Required, Identifier): properties of the resource ## Resource AWS.DeviceFarm/VPCEConfiguration@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.DeviceFarm/VPCEConfigurationProperties](#awsdevicefarmvpceconfigurationproperties) (Required): properties of the resource +* **properties**: [AWS.DeviceFarm/VPCEConfigurationProperties](#awsdevicefarmvpceconfigurationproperties) (Required, Identifier): properties of the resource ## AWS.DeviceFarm/DevicePoolProperties ### Properties @@ -52,17 +52,6 @@ * **Rules**: [Rule](#rule)[] (Required) * **Tags**: [Tag](#tag)[] -## Rule -### Properties -* **Attribute**: string: The rule's stringified attribute. -* **Operator**: string: Specifies how Device Farm compares the rule's attribute to the value. -* **Value**: string: The rule's value. - -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - ## AWS.DeviceFarm/InstanceProfileProperties ### Properties * **Arn**: string (ReadOnly, Identifier) @@ -73,11 +62,6 @@ * **RebootAfterUse**: bool * **Tags**: [Tag](#tag)[] -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - ## AWS.DeviceFarm/NetworkProfileProperties ### Properties * **Arn**: string (ReadOnly, Identifier) @@ -94,11 +78,6 @@ * **UplinkJitterMs**: int * **UplinkLossPercent**: int -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - ## AWS.DeviceFarm/ProjectProperties ### Properties * **Arn**: string (ReadOnly, Identifier) @@ -107,17 +86,6 @@ * **Tags**: [Tag](#tag)[] * **VpcConfig**: [VpcConfig](#vpcconfig) -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - -## VpcConfig -### Properties -* **SecurityGroupIds**: string[] (Required): An array of security group Ids in your Amazon VPC -* **SubnetIds**: string[] (Required): A array of subnet IDs in your Amazon VPC. -* **VpcId**: string (Required): The ID of the Amazon VPC - ## AWS.DeviceFarm/TestGridProjectProperties ### Properties * **Arn**: string (ReadOnly, Identifier) @@ -126,17 +94,6 @@ * **Tags**: [Tag](#tag)[] * **VpcConfig**: [VpcConfig](#vpcconfig) (WriteOnly) -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - -## VpcConfig -### Properties -* **SecurityGroupIds**: string[] (Required): A list of VPC security group IDs in your Amazon VPC. -* **SubnetIds**: string[] (Required): A list of VPC subnet IDs in your Amazon VPC. -* **VpcId**: string (Required) - ## AWS.DeviceFarm/VPCEConfigurationProperties ### Properties * **Arn**: string (ReadOnly, Identifier) @@ -146,8 +103,51 @@ * **VpceConfigurationName**: string (Required) * **VpceServiceName**: string (Required) +## Rule +### Properties +* **Attribute**: string: The rule's stringified attribute. +* **Operator**: string: Specifies how Device Farm compares the rule's attribute to the value. +* **Value**: string: The rule's value. + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + ## Tag ### Properties * **Key**: string (Required) * **Value**: string (Required) +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + +## VpcConfig +### Properties +* **SecurityGroupIds**: string[] (Required): An array of security group Ids in your Amazon VPC +* **SubnetIds**: string[] (Required): A array of subnet IDs in your Amazon VPC. +* **VpcId**: string (Required): The ID of the Amazon VPC + +## VpcConfig +### Properties +* **SecurityGroupIds**: string[] (Required): A list of VPC security group IDs in your Amazon VPC. +* **SubnetIds**: string[] (Required): A list of VPC subnet IDs in your Amazon VPC. +* **VpcId**: string (Required) + diff --git a/artifacts/bicep/aws/aws.devopsguru/default/types.json b/artifacts/bicep/aws/aws.devopsguru/default/types.json index eef7f093..e2d2ba73 100644 --- a/artifacts/bicep/aws/aws.devopsguru/default/types.json +++ b/artifacts/bicep/aws/aws.devopsguru/default/types.json @@ -1 +1,201 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"AccountId"}},{"2":{"Name":"AWS.DevOpsGuru/LogAnomalyDetectionIntegrationProperties","Properties":{"AccountId":{"Type":4,"Flags":18}}}},{"2":{"Name":"AWS.DevOpsGuru/LogAnomalyDetectionIntegration","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":9,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.DevOpsGuru/LogAnomalyDetectionIntegration@default","ScopeType":0,"Body":10}},{"2":{"Name":"CloudFormationCollectionFilter","Properties":{"StackNames":{"Type":16,"Flags":0,"Description":"An array of CloudFormation stack names."}}}},{"2":{"Name":"ResourceCollectionFilter","Properties":{"CloudFormation":{"Type":12,"Flags":0},"Tags":{"Type":17,"Flags":0}}}},{"2":{"Name":"TagCollection","Properties":{"AppBoundaryKey":{"Type":4,"Flags":0,"Description":"A Tag key for DevOps Guru app boundary."},"TagValues":{"Type":18,"Flags":0,"Description":"Tag values of DevOps Guru app boundary."}}}},{"2":{"Name":"TagCollections"}},{"3":{"ItemType":4}},{"3":{"ItemType":14}},{"3":{"ItemType":4}},{"3":{"ItemType":14}},{"2":{"Name":"AWS.DevOpsGuru/ResourceCollectionProperties","Properties":{"ResourceCollectionFilter":{"Type":13,"Flags":1},"ResourceCollectionType":{"Type":4,"Flags":18,"Description":"The type of ResourceCollection"}}}},{"2":{"Name":"AWS.DevOpsGuru/ResourceCollection","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":20,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.DevOpsGuru/ResourceCollection@default","ScopeType":0,"Body":21}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "AccountId", + "properties": {} + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.DevOpsGuru/LogAnomalyDetectionIntegrationProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.DevOpsGuru/LogAnomalyDetectionIntegrationProperties", + "properties": { + "AccountId": { + "type": { + "$ref": "#/1" + }, + "flags": 18 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.DevOpsGuru/LogAnomalyDetectionIntegration", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/3" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.DevOpsGuru/LogAnomalyDetectionIntegration@default", + "scopeType": 0, + "body": { + "$ref": "#/4" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "CloudFormationCollectionFilter", + "properties": { + "StackNames": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "An array of CloudFormation stack names." + } + } + }, + { + "$type": "ObjectType", + "name": "ResourceCollectionFilter", + "properties": { + "CloudFormation": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/11" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TagCollection", + "properties": { + "AppBoundaryKey": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A Tag key for DevOps Guru app boundary." + }, + "TagValues": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "Tag values of DevOps Guru app boundary." + } + } + }, + { + "$type": "ObjectType", + "name": "TagCollections", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/8" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/8" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.DevOpsGuru/ResourceCollectionProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.DevOpsGuru/ResourceCollectionProperties", + "properties": { + "ResourceCollectionFilter": { + "type": { + "$ref": "#/7" + }, + "flags": 1 + }, + "ResourceCollectionType": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The type of ResourceCollection" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.DevOpsGuru/ResourceCollection", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/15" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.DevOpsGuru/ResourceCollection@default", + "scopeType": 0, + "body": { + "$ref": "#/16" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.devopsguru/default/types.md b/artifacts/bicep/aws/aws.devopsguru/default/types.md index af817d1b..6498994e 100644 --- a/artifacts/bicep/aws/aws.devopsguru/default/types.md +++ b/artifacts/bicep/aws/aws.devopsguru/default/types.md @@ -3,16 +3,16 @@ ## Resource AWS.DevOpsGuru/LogAnomalyDetectionIntegration@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.DevOpsGuru/LogAnomalyDetectionIntegrationProperties](#awsdevopsguruloganomalydetectionintegrationproperties): properties of the resource +* **properties**: [AWS.DevOpsGuru/LogAnomalyDetectionIntegrationProperties](#awsdevopsguruloganomalydetectionintegrationproperties) (Identifier): properties of the resource ## Resource AWS.DevOpsGuru/ResourceCollection@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.DevOpsGuru/ResourceCollectionProperties](#awsdevopsgururesourcecollectionproperties) (Required): properties of the resource +* **properties**: [AWS.DevOpsGuru/ResourceCollectionProperties](#awsdevopsgururesourcecollectionproperties) (Required, Identifier): properties of the resource ## AWS.DevOpsGuru/LogAnomalyDetectionIntegrationProperties ### Properties @@ -23,15 +23,15 @@ * **ResourceCollectionFilter**: [ResourceCollectionFilter](#resourcecollectionfilter) (Required) * **ResourceCollectionType**: string (ReadOnly, Identifier): The type of ResourceCollection +## CloudFormationCollectionFilter +### Properties +* **StackNames**: string[]: An array of CloudFormation stack names. + ## ResourceCollectionFilter ### Properties * **CloudFormation**: [CloudFormationCollectionFilter](#cloudformationcollectionfilter) * **Tags**: [TagCollection](#tagcollection)[] -## CloudFormationCollectionFilter -### Properties -* **StackNames**: string[]: An array of CloudFormation stack names. - ## TagCollection ### Properties * **AppBoundaryKey**: string: A Tag key for DevOps Guru app boundary. diff --git a/artifacts/bicep/aws/aws.directoryservice/default/types.json b/artifacts/bicep/aws/aws.directoryservice/default/types.json index 2fd803b3..ddeafb07 100644 --- a/artifacts/bicep/aws/aws.directoryservice/default/types.json +++ b/artifacts/bicep/aws/aws.directoryservice/default/types.json @@ -1 +1,163 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"VpcSettings","Properties":{"SubnetIds":{"Type":9,"Flags":1,"Description":"The identifiers of the subnets for the directory servers. The two subnets must be in different Availability Zones. AWS Directory Service specifies a directory server and a DNS server in each of these subnets."},"VpcId":{"Type":4,"Flags":1,"Description":"The identifier of the VPC in which to create the directory."}}}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.DirectoryService/SimpleADProperties","Properties":{"Alias":{"Type":4,"Flags":2,"Description":"The alias for a directory."},"CreateAlias":{"Type":2,"Flags":0,"Description":"The name of the configuration set."},"Description":{"Type":4,"Flags":0,"Description":"Description for the directory."},"DirectoryId":{"Type":4,"Flags":18,"Description":"The unique identifier for a directory."},"DnsIpAddresses":{"Type":11,"Flags":2,"Description":"The IP addresses of the DNS servers for the directory, such as [ \"172.31.3.154\", \"172.31.63.203\" ]."},"EnableSso":{"Type":2,"Flags":0,"Description":"Whether to enable single sign-on for a Simple Active Directory in AWS."},"Name":{"Type":4,"Flags":1,"Description":"The fully qualified domain name for the AWS Managed Simple AD directory."},"Password":{"Type":4,"Flags":4,"Description":"The password for the default administrative user named Admin."},"ShortName":{"Type":4,"Flags":0,"Description":"The NetBIOS name for your domain."},"Size":{"Type":4,"Flags":1,"Description":"The size of the directory."},"VpcSettings":{"Type":8,"Flags":1,"Description":"VPC settings of the Simple AD directory server in AWS."}}}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.DirectoryService/SimpleAD","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":10,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.DirectoryService/SimpleAD@default","ScopeType":0,"Body":12}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "VpcSettings", + "properties": { + "SubnetIds": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The identifiers of the subnets for the directory servers. The two subnets must be in different Availability Zones. AWS Directory Service specifies a directory server and a DNS server in each of these subnets." + }, + "VpcId": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The identifier of the VPC in which to create the directory." + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.DirectoryService/SimpleADProperties" + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "AWS.DirectoryService/SimpleADProperties", + "properties": { + "Alias": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The alias for a directory." + }, + "CreateAlias": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The name of the configuration set." + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Description for the directory." + }, + "DirectoryId": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The unique identifier for a directory." + }, + "DnsIpAddresses": { + "type": { + "$ref": "#/5" + }, + "flags": 2, + "description": "The IP addresses of the DNS servers for the directory, such as [ \"172.31.3.154\", \"172.31.63.203\" ]." + }, + "EnableSso": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Whether to enable single sign-on for a Simple Active Directory in AWS." + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The fully qualified domain name for the AWS Managed Simple AD directory." + }, + "Password": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The password for the default administrative user named Admin." + }, + "ShortName": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The NetBIOS name for your domain." + }, + "Size": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The size of the directory." + }, + "VpcSettings": { + "type": { + "$ref": "#/0" + }, + "flags": 1, + "description": "VPC settings of the Simple AD directory server in AWS." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.DirectoryService/SimpleAD", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/6" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.DirectoryService/SimpleAD@default", + "scopeType": 0, + "body": { + "$ref": "#/7" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.directoryservice/default/types.md b/artifacts/bicep/aws/aws.directoryservice/default/types.md index cc675c17..25ea098d 100644 --- a/artifacts/bicep/aws/aws.directoryservice/default/types.md +++ b/artifacts/bicep/aws/aws.directoryservice/default/types.md @@ -3,9 +3,9 @@ ## Resource AWS.DirectoryService/SimpleAD@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.DirectoryService/SimpleADProperties](#awsdirectoryservicesimpleadproperties) (Required): properties of the resource +* **properties**: [AWS.DirectoryService/SimpleADProperties](#awsdirectoryservicesimpleadproperties) (Required, Identifier): properties of the resource ## AWS.DirectoryService/SimpleADProperties ### Properties diff --git a/artifacts/bicep/aws/aws.dms/default/types.json b/artifacts/bicep/aws/aws.dms/default/types.json index 44358028..0b69cb31 100644 --- a/artifacts/bicep/aws/aws.dms/default/types.json +++ b/artifacts/bicep/aws/aws.dms/default/types.json @@ -1 +1,993 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"DmsSslModeValue"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.DMS/DataProviderProperties","Properties":{"DataProviderArn":{"Type":4,"Flags":18,"Description":"The data provider ARN."},"DataProviderCreationTime":{"Type":4,"Flags":2,"Description":"The data provider creation time."},"DataProviderIdentifier":{"Type":4,"Flags":4,"Description":"The property describes an identifier for the data provider. It is used for describing/deleting/modifying can be name/arn"},"DataProviderName":{"Type":4,"Flags":0,"Description":"The property describes a name to identify the data provider."},"Description":{"Type":4,"Flags":0,"Description":"The optional description of the data provider."},"Engine":{"Type":4,"Flags":1,"Description":"The property describes a data engine for the data provider."},"ExactSettings":{"Type":2,"Flags":4,"Description":"The property describes the exact settings which can be modified"},"Settings":{"Type":11,"Flags":0,"Description":"The property identifies the exact type of settings for the data provider."},"Tags":{"Type":12,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."}}}},{"2":{"Name":"DataProvider_Settings","Properties":{}}},{"3":{"ItemType":9}},{"2":{"Name":"AWS.DMS/DataProvider","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":10,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.DMS/DataProvider@default","ScopeType":0,"Body":13}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.DMS/InstanceProfileProperties","Properties":{"AvailabilityZone":{"Type":4,"Flags":0,"Description":"The property describes an availability zone of the instance profile."},"Description":{"Type":4,"Flags":0,"Description":"The optional description of the instance profile."},"InstanceProfileArn":{"Type":4,"Flags":18,"Description":"The property describes an ARN of the instance profile."},"InstanceProfileCreationTime":{"Type":4,"Flags":2,"Description":"The property describes a creating time of the instance profile."},"InstanceProfileIdentifier":{"Type":4,"Flags":4,"Description":"The property describes an identifier for the instance profile. It is used for describing/deleting/modifying. Can be name/arn"},"InstanceProfileName":{"Type":4,"Flags":0,"Description":"The property describes a name for the instance profile."},"KmsKeyArn":{"Type":4,"Flags":0,"Description":"The property describes kms key arn for the instance profile."},"NetworkType":{"Type":4,"Flags":0,"Description":"The property describes a network type for the instance profile."},"PubliclyAccessible":{"Type":2,"Flags":0,"Description":"The property describes the publicly accessible of the instance profile"},"SubnetGroupIdentifier":{"Type":4,"Flags":0,"Description":"The property describes a subnet group identifier for the instance profile."},"Tags":{"Type":17,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."},"VpcSecurityGroups":{"Type":18,"Flags":0,"Description":"The property describes vps security groups for the instance profile."}}}},{"3":{"ItemType":15}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.DMS/InstanceProfile","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":16,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.DMS/InstanceProfile@default","ScopeType":0,"Body":19}},{"2":{"Name":"DataProviderDescriptor","Properties":{"DataProviderArn":{"Type":4,"Flags":0},"DataProviderIdentifier":{"Type":4,"Flags":0},"DataProviderName":{"Type":4,"Flags":0},"SecretsManagerAccessRoleArn":{"Type":4,"Flags":0},"SecretsManagerSecretId":{"Type":4,"Flags":0}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, , and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, , and -."}}}},{"2":{"Name":"AWS.DMS/MigrationProjectProperties","Properties":{"Description":{"Type":4,"Flags":0,"Description":"The optional description of the migration project."},"InstanceProfileArn":{"Type":4,"Flags":0,"Description":"The property describes an instance profile arn for the migration project. For read"},"InstanceProfileIdentifier":{"Type":4,"Flags":4,"Description":"The property describes an instance profile identifier for the migration project. For create"},"InstanceProfileName":{"Type":4,"Flags":0,"Description":"The property describes an instance profile name for the migration project. For read"},"MigrationProjectArn":{"Type":4,"Flags":18,"Description":"The property describes an ARN of the migration project."},"MigrationProjectCreationTime":{"Type":4,"Flags":0,"Description":"The property describes a creating time of the migration project."},"MigrationProjectIdentifier":{"Type":4,"Flags":4,"Description":"The property describes an identifier for the migration project. It is used for describing/deleting/modifying can be name/arn"},"MigrationProjectName":{"Type":4,"Flags":0,"Description":"The property describes a name to identify the migration project."},"SchemaConversionApplicationAttributes":{"Type":24,"Flags":0,"Description":"The property describes schema conversion application attributes for the migration project."},"SourceDataProviderDescriptors":{"Type":25,"Flags":4,"Description":"The property describes source data provider descriptors for the migration project."},"Tags":{"Type":26,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."},"TargetDataProviderDescriptors":{"Type":27,"Flags":4,"Description":"The property describes target data provider descriptors for the migration project."},"TransformationRules":{"Type":4,"Flags":0,"Description":"The property describes transformation rules for the migration project."}}}},{"2":{"Name":"MigrationProject_SchemaConversionApplicationAttributes","Properties":{"S3BucketPath":{"Type":4,"Flags":0},"S3BucketRoleArn":{"Type":4,"Flags":0}}}},{"3":{"ItemType":21}},{"3":{"ItemType":22}},{"3":{"ItemType":21}},{"2":{"Name":"AWS.DMS/MigrationProject","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":23,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.DMS/MigrationProject@default","ScopeType":0,"Body":28}},{"2":{"Name":"ComputeConfig","Properties":{"AvailabilityZone":{"Type":4,"Flags":0},"DnsNameServers":{"Type":4,"Flags":0},"KmsKeyId":{"Type":4,"Flags":0},"MaxCapacityUnits":{"Type":3,"Flags":1},"MinCapacityUnits":{"Type":3,"Flags":0},"MultiAZ":{"Type":2,"Flags":0},"PreferredMaintenanceWindow":{"Type":4,"Flags":0},"ReplicationSubnetGroupId":{"Type":4,"Flags":0},"VpcSecurityGroupIds":{"Type":32,"Flags":0}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"

Tag key.

"},"Value":{"Type":4,"Flags":1,"Description":"

Tag value.

"}}}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.DMS/ReplicationConfigProperties","Properties":{"ComputeConfig":{"Type":30,"Flags":0},"ReplicationConfigArn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN) of the Replication Config"},"ReplicationConfigIdentifier":{"Type":4,"Flags":0,"Description":"A unique identifier of replication configuration"},"ReplicationSettings":{"Type":34,"Flags":0,"Description":"JSON settings for Servereless replications that are provisioned using this replication configuration"},"ReplicationType":{"Type":4,"Flags":0,"Description":"The type of AWS DMS Serverless replication to provision using this replication configuration"},"ResourceIdentifier":{"Type":4,"Flags":0,"Description":"A unique value or name that you get set for a given resource that can be used to construct an Amazon Resource Name (ARN) for that resource"},"SourceEndpointArn":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) of the source endpoint for this AWS DMS Serverless replication configuration"},"SupplementalSettings":{"Type":35,"Flags":0,"Description":"JSON settings for specifying supplemental data"},"TableMappings":{"Type":36,"Flags":0,"Description":"JSON table mappings for AWS DMS Serverless replications that are provisioned using this replication configuration"},"Tags":{"Type":37,"Flags":0,"Description":"

Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.

"},"TargetEndpointArn":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) of the target endpoint for this AWS DMS Serverless replication configuration"}}}},{"2":{"Name":"ReplicationConfig_ReplicationSettings","Properties":{}}},{"2":{"Name":"ReplicationConfig_SupplementalSettings","Properties":{}}},{"2":{"Name":"ReplicationConfig_TableMappings","Properties":{}}},{"3":{"ItemType":31}},{"2":{"Name":"AWS.DMS/ReplicationConfig","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":33,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.DMS/ReplicationConfig@default","ScopeType":0,"Body":38}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "DmsSslModeValue", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.DMS/DataProviderProperties" + }, + { + "$type": "BooleanType" + }, + { + "$type": "IntegerType" + }, + { + "$type": "ObjectType", + "name": "DataProvider_DmsSslModeValue", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DataProvider_Settings_MicrosoftSqlServerSettings", + "properties": { + "CertificateArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "DatabaseName": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Port": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "ServerName": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "SslMode": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DataProvider_DmsSslModeValue", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DataProvider_Settings_MySqlSettings", + "properties": { + "CertificateArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Port": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "ServerName": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "SslMode": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DataProvider_DmsSslModeValue", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DataProvider_Settings_OracleSettings", + "properties": { + "AsmServer": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "CertificateArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "DatabaseName": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Port": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "SecretsManagerOracleAsmAccessRoleArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "SecretsManagerOracleAsmSecretId": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "SecretsManagerSecurityDbEncryptionAccessRoleArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "SecretsManagerSecurityDbEncryptionSecretId": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "ServerName": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "SslMode": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DataProvider_DmsSslModeValue", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DataProvider_Settings_PostgreSqlSettings", + "properties": { + "CertificateArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "DatabaseName": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Port": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "ServerName": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "SslMode": { + "type": { + "$ref": "#/12" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DataProvider_Settings", + "properties": { + "MicrosoftSqlServerSettings": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "MicrosoftSqlServerSettings property identifier." + }, + "MySqlSettings": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "MySqlSettings property identifier." + }, + "OracleSettings": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "OracleSettings property identifier." + }, + "PostgreSqlSettings": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "PostgreSqlSettings property identifier." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "AWS.DMS/DataProviderProperties", + "properties": { + "DataProviderArn": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "The data provider ARN." + }, + "DataProviderCreationTime": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The data provider creation time." + }, + "DataProviderIdentifier": { + "type": { + "$ref": "#/2" + }, + "flags": 4, + "description": "The property describes an identifier for the data provider. It is used for describing/deleting/modifying can be name/arn" + }, + "DataProviderName": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The property describes a name to identify the data provider." + }, + "Description": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The optional description of the data provider." + }, + "Engine": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The property describes a data engine for the data provider." + }, + "ExactSettings": { + "type": { + "$ref": "#/4" + }, + "flags": 4, + "description": "The property describes the exact settings which can be modified" + }, + "Settings": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The property identifies the exact type of settings for the data provider." + }, + "Tags": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.DMS/DataProvider", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/16" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.DMS/DataProvider@default", + "scopeType": 0, + "body": { + "$ref": "#/17" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.DMS/InstanceProfileProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/19" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ObjectType", + "name": "AWS.DMS/InstanceProfileProperties", + "properties": { + "AvailabilityZone": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The property describes an availability zone of the instance profile." + }, + "Description": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The optional description of the instance profile." + }, + "InstanceProfileArn": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "The property describes an ARN of the instance profile." + }, + "InstanceProfileCreationTime": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The property describes a creating time of the instance profile." + }, + "InstanceProfileIdentifier": { + "type": { + "$ref": "#/2" + }, + "flags": 4, + "description": "The property describes an identifier for the instance profile. It is used for describing/deleting/modifying. Can be name/arn" + }, + "InstanceProfileName": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The property describes a name for the instance profile." + }, + "KmsKeyArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The property describes kms key arn for the instance profile." + }, + "NetworkType": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The property describes a network type for the instance profile." + }, + "PubliclyAccessible": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The property describes the publicly accessible of the instance profile" + }, + "SubnetGroupIdentifier": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The property describes a subnet group identifier for the instance profile." + }, + "Tags": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + }, + "VpcSecurityGroups": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "The property describes vps security groups for the instance profile." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.DMS/InstanceProfile", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/23" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.DMS/InstanceProfile@default", + "scopeType": 0, + "body": { + "$ref": "#/24" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "DataProviderDescriptor", + "properties": { + "DataProviderArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "DataProviderIdentifier": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "DataProviderName": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "SecretsManagerAccessRoleArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "SecretsManagerSecretId": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, , and -." + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, , and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.DMS/MigrationProjectProperties" + }, + { + "$type": "ObjectType", + "name": "MigrationProject_SchemaConversionApplicationAttributes", + "properties": { + "S3BucketPath": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "S3BucketRoleArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/26" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/27" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/26" + } + }, + { + "$type": "ObjectType", + "name": "AWS.DMS/MigrationProjectProperties", + "properties": { + "Description": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The optional description of the migration project." + }, + "InstanceProfileArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The property describes an instance profile arn for the migration project. For read" + }, + "InstanceProfileIdentifier": { + "type": { + "$ref": "#/2" + }, + "flags": 4, + "description": "The property describes an instance profile identifier for the migration project. For create" + }, + "InstanceProfileName": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The property describes an instance profile name for the migration project. For read" + }, + "MigrationProjectArn": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "The property describes an ARN of the migration project." + }, + "MigrationProjectCreationTime": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The property describes a creating time of the migration project." + }, + "MigrationProjectIdentifier": { + "type": { + "$ref": "#/2" + }, + "flags": 4, + "description": "The property describes an identifier for the migration project. It is used for describing/deleting/modifying can be name/arn" + }, + "MigrationProjectName": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The property describes a name to identify the migration project." + }, + "SchemaConversionApplicationAttributes": { + "type": { + "$ref": "#/29" + }, + "flags": 0, + "description": "The property describes schema conversion application attributes for the migration project." + }, + "SourceDataProviderDescriptors": { + "type": { + "$ref": "#/30" + }, + "flags": 4, + "description": "The property describes source data provider descriptors for the migration project." + }, + "Tags": { + "type": { + "$ref": "#/31" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + }, + "TargetDataProviderDescriptors": { + "type": { + "$ref": "#/32" + }, + "flags": 4, + "description": "The property describes target data provider descriptors for the migration project." + }, + "TransformationRules": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The property describes transformation rules for the migration project." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.DMS/MigrationProject", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/33" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.DMS/MigrationProject@default", + "scopeType": 0, + "body": { + "$ref": "#/34" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "ComputeConfig", + "properties": { + "AvailabilityZone": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "DnsNameServers": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "KmsKeyId": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "MaxCapacityUnits": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "MinCapacityUnits": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "MultiAZ": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "PreferredMaintenanceWindow": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "ReplicationSubnetGroupId": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "VpcSecurityGroupIds": { + "type": { + "$ref": "#/38" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "

Tag key.

" + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "

Tag value.

" + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.DMS/ReplicationConfigProperties" + }, + { + "$type": "ObjectType", + "name": "ReplicationConfig_ReplicationSettings", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ReplicationConfig_SupplementalSettings", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ReplicationConfig_TableMappings", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/37" + } + }, + { + "$type": "ObjectType", + "name": "AWS.DMS/ReplicationConfigProperties", + "properties": { + "ComputeConfig": { + "type": { + "$ref": "#/36" + }, + "flags": 0 + }, + "ReplicationConfigArn": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) of the Replication Config" + }, + "ReplicationConfigIdentifier": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "A unique identifier of replication configuration" + }, + "ReplicationSettings": { + "type": { + "$ref": "#/40" + }, + "flags": 0, + "description": "JSON settings for Servereless replications that are provisioned using this replication configuration" + }, + "ReplicationType": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The type of AWS DMS Serverless replication to provision using this replication configuration" + }, + "ResourceIdentifier": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "A unique value or name that you get set for a given resource that can be used to construct an Amazon Resource Name (ARN) for that resource" + }, + "SourceEndpointArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the source endpoint for this AWS DMS Serverless replication configuration" + }, + "SupplementalSettings": { + "type": { + "$ref": "#/41" + }, + "flags": 0, + "description": "JSON settings for specifying supplemental data" + }, + "TableMappings": { + "type": { + "$ref": "#/42" + }, + "flags": 0, + "description": "JSON table mappings for AWS DMS Serverless replications that are provisioned using this replication configuration" + }, + "Tags": { + "type": { + "$ref": "#/43" + }, + "flags": 0, + "description": "

Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.

" + }, + "TargetEndpointArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the target endpoint for this AWS DMS Serverless replication configuration" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.DMS/ReplicationConfig", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/44" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.DMS/ReplicationConfig@default", + "scopeType": 0, + "body": { + "$ref": "#/45" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.dms/default/types.md b/artifacts/bicep/aws/aws.dms/default/types.md index 8896b4e1..d9585735 100644 --- a/artifacts/bicep/aws/aws.dms/default/types.md +++ b/artifacts/bicep/aws/aws.dms/default/types.md @@ -3,30 +3,30 @@ ## Resource AWS.DMS/DataProvider@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.DMS/DataProviderProperties](#awsdmsdataproviderproperties) (Required): properties of the resource +* **properties**: [AWS.DMS/DataProviderProperties](#awsdmsdataproviderproperties) (Required, Identifier): properties of the resource ## Resource AWS.DMS/InstanceProfile@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.DMS/InstanceProfileProperties](#awsdmsinstanceprofileproperties): properties of the resource +* **properties**: [AWS.DMS/InstanceProfileProperties](#awsdmsinstanceprofileproperties) (Identifier): properties of the resource ## Resource AWS.DMS/MigrationProject@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.DMS/MigrationProjectProperties](#awsdmsmigrationprojectproperties): properties of the resource +* **properties**: [AWS.DMS/MigrationProjectProperties](#awsdmsmigrationprojectproperties) (Identifier): properties of the resource ## Resource AWS.DMS/ReplicationConfig@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.DMS/ReplicationConfigProperties](#awsdmsreplicationconfigproperties): properties of the resource +* **properties**: [AWS.DMS/ReplicationConfigProperties](#awsdmsreplicationconfigproperties) (Identifier): properties of the resource ## AWS.DMS/DataProviderProperties ### Properties @@ -40,14 +40,6 @@ * **Settings**: [DataProvider_Settings](#dataprovidersettings): The property identifies the exact type of settings for the data provider. * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. -## DataProvider_Settings -### Properties - -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## AWS.DMS/InstanceProfileProperties ### Properties * **AvailabilityZone**: string: The property describes an availability zone of the instance profile. @@ -63,11 +55,6 @@ * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. * **VpcSecurityGroups**: string[]: The property describes vps security groups for the instance profile. -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## AWS.DMS/MigrationProjectProperties ### Properties * **Description**: string: The optional description of the migration project. @@ -84,24 +71,6 @@ * **TargetDataProviderDescriptors**: [DataProviderDescriptor](#dataproviderdescriptor)[] (WriteOnly): The property describes target data provider descriptors for the migration project. * **TransformationRules**: string: The property describes transformation rules for the migration project. -## MigrationProject_SchemaConversionApplicationAttributes -### Properties -* **S3BucketPath**: string -* **S3BucketRoleArn**: string - -## DataProviderDescriptor -### Properties -* **DataProviderArn**: string -* **DataProviderIdentifier**: string -* **DataProviderName**: string -* **SecretsManagerAccessRoleArn**: string -* **SecretsManagerSecretId**: string - -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, , and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, , and -. - ## AWS.DMS/ReplicationConfigProperties ### Properties * **ComputeConfig**: [ComputeConfig](#computeconfig) @@ -128,6 +97,74 @@ * **ReplicationSubnetGroupId**: string * **VpcSecurityGroupIds**: string[] +## DataProvider_DmsSslModeValue +### Properties + +## DataProvider_DmsSslModeValue +### Properties + +## DataProvider_DmsSslModeValue +### Properties + +## DataProvider_DmsSslModeValue +### Properties + +## DataProvider_Settings +### Properties +* **MicrosoftSqlServerSettings**: [DataProvider_Settings_MicrosoftSqlServerSettings](#dataprovidersettingsmicrosoftsqlserversettings): MicrosoftSqlServerSettings property identifier. +* **MySqlSettings**: [DataProvider_Settings_MySqlSettings](#dataprovidersettingsmysqlsettings): MySqlSettings property identifier. +* **OracleSettings**: [DataProvider_Settings_OracleSettings](#dataprovidersettingsoraclesettings): OracleSettings property identifier. +* **PostgreSqlSettings**: [DataProvider_Settings_PostgreSqlSettings](#dataprovidersettingspostgresqlsettings): PostgreSqlSettings property identifier. + +## DataProvider_Settings_MicrosoftSqlServerSettings +### Properties +* **CertificateArn**: string +* **DatabaseName**: string (Required) +* **Port**: int (Required) +* **ServerName**: string (Required) +* **SslMode**: [DataProvider_DmsSslModeValue](#dataproviderdmssslmodevalue) (Required) + +## DataProvider_Settings_MySqlSettings +### Properties +* **CertificateArn**: string +* **Port**: int (Required) +* **ServerName**: string (Required) +* **SslMode**: [DataProvider_DmsSslModeValue](#dataproviderdmssslmodevalue) (Required) + +## DataProvider_Settings_OracleSettings +### Properties +* **AsmServer**: string +* **CertificateArn**: string +* **DatabaseName**: string (Required) +* **Port**: int (Required) +* **SecretsManagerOracleAsmAccessRoleArn**: string +* **SecretsManagerOracleAsmSecretId**: string +* **SecretsManagerSecurityDbEncryptionAccessRoleArn**: string +* **SecretsManagerSecurityDbEncryptionSecretId**: string +* **ServerName**: string (Required) +* **SslMode**: [DataProvider_DmsSslModeValue](#dataproviderdmssslmodevalue) (Required) + +## DataProvider_Settings_PostgreSqlSettings +### Properties +* **CertificateArn**: string +* **DatabaseName**: string (Required) +* **Port**: int (Required) +* **ServerName**: string (Required) +* **SslMode**: [DataProvider_DmsSslModeValue](#dataproviderdmssslmodevalue) (Required) + +## DataProviderDescriptor +### Properties +* **DataProviderArn**: string +* **DataProviderIdentifier**: string +* **DataProviderName**: string +* **SecretsManagerAccessRoleArn**: string +* **SecretsManagerSecretId**: string + +## MigrationProject_SchemaConversionApplicationAttributes +### Properties +* **S3BucketPath**: string +* **S3BucketRoleArn**: string + ## ReplicationConfig_ReplicationSettings ### Properties @@ -137,6 +174,21 @@ ## ReplicationConfig_TableMappings ### Properties +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, , and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, , and -. + ## Tag ### Properties * **Key**: string (Required):

Tag key.

diff --git a/artifacts/bicep/aws/aws.docdbelastic/default/types.json b/artifacts/bicep/aws/aws.docdbelastic/default/types.json index f62ccb8f..e8191dbb 100644 --- a/artifacts/bicep/aws/aws.docdbelastic/default/types.json +++ b/artifacts/bicep/aws/aws.docdbelastic/default/types.json @@ -1 +1,186 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.DocDBElastic/ClusterProperties","Properties":{"AdminUserName":{"Type":4,"Flags":1},"AdminUserPassword":{"Type":4,"Flags":4},"AuthType":{"Type":4,"Flags":1},"ClusterArn":{"Type":4,"Flags":18},"ClusterEndpoint":{"Type":4,"Flags":2},"ClusterName":{"Type":4,"Flags":1},"KmsKeyId":{"Type":4,"Flags":0},"PreferredMaintenanceWindow":{"Type":4,"Flags":0},"ShardCapacity":{"Type":3,"Flags":1},"ShardCount":{"Type":3,"Flags":1},"SubnetIds":{"Type":10,"Flags":0},"Tags":{"Type":11,"Flags":0},"VpcSecurityGroupIds":{"Type":12,"Flags":0}}}},{"3":{"ItemType":4}},{"3":{"ItemType":8}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.DocDBElastic/Cluster","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":9,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.DocDBElastic/Cluster@default","ScopeType":0,"Body":13}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.DocDBElastic/ClusterProperties" + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "AWS.DocDBElastic/ClusterProperties", + "properties": { + "AdminUserName": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "AdminUserPassword": { + "type": { + "$ref": "#/1" + }, + "flags": 4 + }, + "AuthType": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "BackupRetentionPeriod": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "ClusterArn": { + "type": { + "$ref": "#/1" + }, + "flags": 18 + }, + "ClusterEndpoint": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "ClusterName": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "KmsKeyId": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "PreferredBackupWindow": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "PreferredMaintenanceWindow": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "ShardCapacity": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + }, + "ShardCount": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + }, + "ShardInstanceCount": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "SubnetIds": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "VpcSecurityGroupIds": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.DocDBElastic/Cluster", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/7" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.DocDBElastic/Cluster@default", + "scopeType": 0, + "body": { + "$ref": "#/8" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.docdbelastic/default/types.md b/artifacts/bicep/aws/aws.docdbelastic/default/types.md index 92780de8..68228149 100644 --- a/artifacts/bicep/aws/aws.docdbelastic/default/types.md +++ b/artifacts/bicep/aws/aws.docdbelastic/default/types.md @@ -3,22 +3,25 @@ ## Resource AWS.DocDBElastic/Cluster@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.DocDBElastic/ClusterProperties](#awsdocdbelasticclusterproperties) (Required): properties of the resource +* **properties**: [AWS.DocDBElastic/ClusterProperties](#awsdocdbelasticclusterproperties) (Required, Identifier): properties of the resource ## AWS.DocDBElastic/ClusterProperties ### Properties * **AdminUserName**: string (Required) * **AdminUserPassword**: string (WriteOnly) * **AuthType**: string (Required) +* **BackupRetentionPeriod**: int * **ClusterArn**: string (ReadOnly, Identifier) * **ClusterEndpoint**: string (ReadOnly) * **ClusterName**: string (Required) * **KmsKeyId**: string +* **PreferredBackupWindow**: string * **PreferredMaintenanceWindow**: string * **ShardCapacity**: int (Required) * **ShardCount**: int (Required) +* **ShardInstanceCount**: int * **SubnetIds**: string[] * **Tags**: [Tag](#tag)[] * **VpcSecurityGroupIds**: string[] diff --git a/artifacts/bicep/aws/aws.dynamodb/default/types.json b/artifacts/bicep/aws/aws.dynamodb/default/types.json index dca7a93f..03cf53f9 100644 --- a/artifacts/bicep/aws/aws.dynamodb/default/types.json +++ b/artifacts/bicep/aws/aws.dynamodb/default/types.json @@ -1 +1,1394 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"AttributeDefinition","Properties":{"AttributeName":{"Type":4,"Flags":1},"AttributeType":{"Type":4,"Flags":1}}}},{"2":{"Name":"CapacityAutoScalingSettings","Properties":{"MaxCapacity":{"Type":3,"Flags":1},"MinCapacity":{"Type":3,"Flags":1},"SeedCapacity":{"Type":3,"Flags":4},"TargetTrackingScalingPolicyConfiguration":{"Type":24,"Flags":1}}}},{"2":{"Name":"ContributorInsightsSpecification","Properties":{"Enabled":{"Type":2,"Flags":1}}}},{"2":{"Name":"GlobalSecondaryIndex","Properties":{"IndexName":{"Type":4,"Flags":1},"KeySchema":{"Type":27,"Flags":1},"Projection":{"Type":16,"Flags":1},"WriteProvisionedThroughputSettings":{"Type":26,"Flags":0}}}},{"2":{"Name":"KeySchema","Properties":{"AttributeName":{"Type":4,"Flags":1},"KeyType":{"Type":4,"Flags":1}}}},{"2":{"Name":"KinesisStreamSpecification","Properties":{"StreamArn":{"Type":4,"Flags":1}}}},{"2":{"Name":"LocalSecondaryIndex","Properties":{"IndexName":{"Type":4,"Flags":1},"KeySchema":{"Type":28,"Flags":1},"Projection":{"Type":16,"Flags":1}}}},{"2":{"Name":"PointInTimeRecoverySpecification","Properties":{"PointInTimeRecoveryEnabled":{"Type":2,"Flags":0}}}},{"2":{"Name":"Projection","Properties":{"NonKeyAttributes":{"Type":29,"Flags":0},"ProjectionType":{"Type":4,"Flags":0}}}},{"2":{"Name":"ReadProvisionedThroughputSettings","Properties":{"ReadCapacityAutoScalingSettings":{"Type":9,"Flags":0},"ReadCapacityUnits":{"Type":3,"Flags":0}}}},{"2":{"Name":"ReplicaGlobalSecondaryIndexSpecification","Properties":{"ContributorInsightsSpecification":{"Type":10,"Flags":0},"IndexName":{"Type":4,"Flags":1},"ReadProvisionedThroughputSettings":{"Type":17,"Flags":0}}}},{"2":{"Name":"ReplicaSSESpecification","Properties":{"KMSMasterKeyId":{"Type":4,"Flags":1}}}},{"2":{"Name":"ReplicaSpecification","Properties":{"ContributorInsightsSpecification":{"Type":10,"Flags":0},"DeletionProtectionEnabled":{"Type":2,"Flags":0},"GlobalSecondaryIndexes":{"Type":30,"Flags":0},"KinesisStreamSpecification":{"Type":13,"Flags":0},"PointInTimeRecoverySpecification":{"Type":15,"Flags":0},"ReadProvisionedThroughputSettings":{"Type":17,"Flags":0},"Region":{"Type":4,"Flags":1},"SSESpecification":{"Type":19,"Flags":0},"TableClass":{"Type":4,"Flags":0},"Tags":{"Type":31,"Flags":0}}}},{"2":{"Name":"SSESpecification","Properties":{"SSEEnabled":{"Type":2,"Flags":1},"SSEType":{"Type":4,"Flags":0}}}},{"2":{"Name":"StreamSpecification","Properties":{"StreamViewType":{"Type":4,"Flags":1}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"TargetTrackingScalingPolicyConfiguration","Properties":{"DisableScaleIn":{"Type":2,"Flags":0},"ScaleInCooldown":{"Type":3,"Flags":0},"ScaleOutCooldown":{"Type":3,"Flags":0},"TargetValue":{"Type":3,"Flags":1}}}},{"2":{"Name":"TimeToLiveSpecification","Properties":{"AttributeName":{"Type":4,"Flags":0},"Enabled":{"Type":2,"Flags":1}}}},{"2":{"Name":"WriteProvisionedThroughputSettings","Properties":{"WriteCapacityAutoScalingSettings":{"Type":9,"Flags":0}}}},{"3":{"ItemType":12}},{"3":{"ItemType":12}},{"3":{"ItemType":4}},{"3":{"ItemType":18}},{"3":{"ItemType":23}},{"2":{"Name":"AWS.DynamoDB/GlobalTableProperties","Properties":{"Arn":{"Type":4,"Flags":2},"AttributeDefinitions":{"Type":33,"Flags":1},"BillingMode":{"Type":4,"Flags":0},"GlobalSecondaryIndexes":{"Type":34,"Flags":4},"KeySchema":{"Type":35,"Flags":1},"LocalSecondaryIndexes":{"Type":36,"Flags":0},"Replicas":{"Type":37,"Flags":5},"SSESpecification":{"Type":21,"Flags":0},"StreamArn":{"Type":4,"Flags":2},"StreamSpecification":{"Type":22,"Flags":0},"TableId":{"Type":4,"Flags":2},"TableName":{"Type":4,"Flags":16},"TimeToLiveSpecification":{"Type":25,"Flags":0},"WriteProvisionedThroughputSettings":{"Type":26,"Flags":0}}}},{"3":{"ItemType":8}},{"3":{"ItemType":11}},{"3":{"ItemType":12}},{"3":{"ItemType":14}},{"3":{"ItemType":20}},{"2":{"Name":"AWS.DynamoDB/GlobalTable","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":32,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.DynamoDB/GlobalTable@default","ScopeType":0,"Body":38}},{"2":{"Name":"AttributeDefinition","Properties":{"AttributeName":{"Type":4,"Flags":1},"AttributeType":{"Type":4,"Flags":1}}}},{"2":{"Name":"ContributorInsightsSpecification","Properties":{"Enabled":{"Type":2,"Flags":1}}}},{"2":{"Name":"Csv","Properties":{"Delimiter":{"Type":4,"Flags":0},"HeaderList":{"Type":59,"Flags":0}}}},{"2":{"Name":"DeprecatedHashKeyElement","Properties":{"AttributeName":{"Type":4,"Flags":1},"AttributeType":{"Type":4,"Flags":1}}}},{"2":{"Name":"DeprecatedKeySchema","Properties":{"HashKeyElement":{"Type":43,"Flags":1}}}},{"2":{"Name":"GlobalSecondaryIndex","Properties":{"ContributorInsightsSpecification":{"Type":41,"Flags":0},"IndexName":{"Type":4,"Flags":1},"KeySchema":{"Type":60,"Flags":1},"Projection":{"Type":52,"Flags":1},"ProvisionedThroughput":{"Type":53,"Flags":0}}}},{"2":{"Name":"ImportSourceSpecification","Properties":{"InputCompressionType":{"Type":4,"Flags":0},"InputFormat":{"Type":4,"Flags":1},"InputFormatOptions":{"Type":47,"Flags":0},"S3BucketSource":{"Type":54,"Flags":1}}}},{"2":{"Name":"InputFormatOptions","Properties":{"Csv":{"Type":42,"Flags":0}}}},{"2":{"Name":"KeySchema","Properties":{"AttributeName":{"Type":4,"Flags":1},"KeyType":{"Type":4,"Flags":1}}}},{"2":{"Name":"KinesisStreamSpecification","Properties":{"StreamArn":{"Type":4,"Flags":1}}}},{"2":{"Name":"LocalSecondaryIndex","Properties":{"IndexName":{"Type":4,"Flags":1},"KeySchema":{"Type":61,"Flags":1},"Projection":{"Type":52,"Flags":1}}}},{"2":{"Name":"PointInTimeRecoverySpecification","Properties":{"PointInTimeRecoveryEnabled":{"Type":2,"Flags":0}}}},{"2":{"Name":"Projection","Properties":{"NonKeyAttributes":{"Type":62,"Flags":0},"ProjectionType":{"Type":4,"Flags":0}}}},{"2":{"Name":"ProvisionedThroughput","Properties":{"ReadCapacityUnits":{"Type":3,"Flags":1},"WriteCapacityUnits":{"Type":3,"Flags":1}}}},{"2":{"Name":"S3BucketSource","Properties":{"S3Bucket":{"Type":4,"Flags":1},"S3BucketOwner":{"Type":4,"Flags":0},"S3KeyPrefix":{"Type":4,"Flags":0}}}},{"2":{"Name":"SSESpecification","Properties":{"KMSMasterKeyId":{"Type":4,"Flags":0},"SSEEnabled":{"Type":2,"Flags":1},"SSEType":{"Type":4,"Flags":0}}}},{"2":{"Name":"StreamSpecification","Properties":{"StreamViewType":{"Type":4,"Flags":1}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"TimeToLiveSpecification","Properties":{"AttributeName":{"Type":4,"Flags":0},"Enabled":{"Type":2,"Flags":1}}}},{"3":{"ItemType":4}},{"3":{"ItemType":48}},{"3":{"ItemType":48}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.DynamoDB/TableProperties","Properties":{"Arn":{"Type":4,"Flags":2},"AttributeDefinitions":{"Type":64,"Flags":0},"BillingMode":{"Type":4,"Flags":0},"ContributorInsightsSpecification":{"Type":41,"Flags":0},"DeletionProtectionEnabled":{"Type":2,"Flags":0},"GlobalSecondaryIndexes":{"Type":65,"Flags":0},"ImportSourceSpecification":{"Type":46,"Flags":4},"KeySchema":{"Type":66,"Flags":1},"KinesisStreamSpecification":{"Type":49,"Flags":0},"LocalSecondaryIndexes":{"Type":67,"Flags":0},"PointInTimeRecoverySpecification":{"Type":51,"Flags":0},"ProvisionedThroughput":{"Type":53,"Flags":0},"SSESpecification":{"Type":55,"Flags":0},"StreamArn":{"Type":4,"Flags":2},"StreamSpecification":{"Type":56,"Flags":0},"TableClass":{"Type":4,"Flags":0},"TableName":{"Type":4,"Flags":16},"Tags":{"Type":68,"Flags":0},"TimeToLiveSpecification":{"Type":58,"Flags":0}}}},{"3":{"ItemType":40}},{"3":{"ItemType":45}},{"2":{"Name":"Table_KeySchema","Properties":{}}},{"3":{"ItemType":50}},{"3":{"ItemType":57}},{"2":{"Name":"AWS.DynamoDB/Table","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":63,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.DynamoDB/Table@default","ScopeType":0,"Body":69}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "AttributeDefinition", + "properties": { + "AttributeName": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + }, + "AttributeType": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CapacityAutoScalingSettings", + "properties": { + "MaxCapacity": { + "type": { + "$ref": "#/24" + }, + "flags": 1 + }, + "MinCapacity": { + "type": { + "$ref": "#/24" + }, + "flags": 1 + }, + "SeedCapacity": { + "type": { + "$ref": "#/24" + }, + "flags": 4 + }, + "TargetTrackingScalingPolicyConfiguration": { + "type": { + "$ref": "#/19" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ContributorInsightsSpecification", + "properties": { + "Enabled": { + "type": { + "$ref": "#/25" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "GlobalSecondaryIndex", + "properties": { + "IndexName": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + }, + "KeySchema": { + "type": { + "$ref": "#/26" + }, + "flags": 1 + }, + "Projection": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + }, + "WriteOnDemandThroughputSettings": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "WriteProvisionedThroughputSettings": { + "type": { + "$ref": "#/22" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "KeySchema", + "properties": { + "AttributeName": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + }, + "KeyType": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "KinesisStreamSpecification", + "properties": { + "ApproximateCreationDateTimePrecision": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "StreamArn": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "LocalSecondaryIndex", + "properties": { + "IndexName": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + }, + "KeySchema": { + "type": { + "$ref": "#/27" + }, + "flags": 1 + }, + "Projection": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "PointInTimeRecoverySpecification", + "properties": { + "PointInTimeRecoveryEnabled": { + "type": { + "$ref": "#/25" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Projection", + "properties": { + "NonKeyAttributes": { + "type": { + "$ref": "#/28" + }, + "flags": 0 + }, + "ProjectionType": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ReadOnDemandThroughputSettings", + "properties": { + "MaxReadRequestUnits": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ReadProvisionedThroughputSettings", + "properties": { + "ReadCapacityAutoScalingSettings": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "ReadCapacityUnits": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ReplicaGlobalSecondaryIndexSpecification", + "properties": { + "ContributorInsightsSpecification": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "IndexName": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + }, + "ReadOnDemandThroughputSettings": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "ReadProvisionedThroughputSettings": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ReplicaSSESpecification", + "properties": { + "KMSMasterKeyId": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ReplicaSpecification", + "properties": { + "ContributorInsightsSpecification": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "DeletionProtectionEnabled": { + "type": { + "$ref": "#/25" + }, + "flags": 0 + }, + "GlobalSecondaryIndexes": { + "type": { + "$ref": "#/29" + }, + "flags": 0 + }, + "KinesisStreamSpecification": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "PointInTimeRecoverySpecification": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "ReadOnDemandThroughputSettings": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "ReadProvisionedThroughputSettings": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "Region": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + }, + "ReplicaStreamSpecification": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + }, + "ResourcePolicy": { + "type": { + "$ref": "#/15" + }, + "flags": 0 + }, + "SSESpecification": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + }, + "TableClass": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/30" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ReplicaStreamSpecification", + "properties": { + "ResourcePolicy": { + "type": { + "$ref": "#/15" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ResourcePolicy", + "properties": { + "PolicyDocument": { + "type": { + "$ref": "#/31" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "SSESpecification", + "properties": { + "SSEEnabled": { + "type": { + "$ref": "#/25" + }, + "flags": 1 + }, + "SSEType": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "StreamSpecification", + "properties": { + "StreamViewType": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TargetTrackingScalingPolicyConfiguration", + "properties": { + "DisableScaleIn": { + "type": { + "$ref": "#/25" + }, + "flags": 0 + }, + "ScaleInCooldown": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "ScaleOutCooldown": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "TargetValue": { + "type": { + "$ref": "#/24" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TimeToLiveSpecification", + "properties": { + "AttributeName": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "Enabled": { + "type": { + "$ref": "#/25" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "WriteOnDemandThroughputSettings", + "properties": { + "MaxWriteRequestUnits": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "WriteProvisionedThroughputSettings", + "properties": { + "WriteCapacityAutoScalingSettings": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "IntegerType" + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/23" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/11" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/18" + } + }, + { + "$type": "ObjectType", + "name": "GlobalTable_PolicyDocument", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.DynamoDB/GlobalTableProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "ObjectType", + "name": "AWS.DynamoDB/GlobalTableProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/23" + }, + "flags": 2 + }, + "AttributeDefinitions": { + "type": { + "$ref": "#/33" + }, + "flags": 1 + }, + "BillingMode": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "GlobalSecondaryIndexes": { + "type": { + "$ref": "#/34" + }, + "flags": 4 + }, + "KeySchema": { + "type": { + "$ref": "#/35" + }, + "flags": 1 + }, + "LocalSecondaryIndexes": { + "type": { + "$ref": "#/36" + }, + "flags": 0 + }, + "Replicas": { + "type": { + "$ref": "#/37" + }, + "flags": 5 + }, + "SSESpecification": { + "type": { + "$ref": "#/16" + }, + "flags": 0 + }, + "StreamArn": { + "type": { + "$ref": "#/23" + }, + "flags": 2 + }, + "StreamSpecification": { + "type": { + "$ref": "#/17" + }, + "flags": 0 + }, + "TableId": { + "type": { + "$ref": "#/23" + }, + "flags": 2 + }, + "TableName": { + "type": { + "$ref": "#/23" + }, + "flags": 16 + }, + "TimeToLiveSpecification": { + "type": { + "$ref": "#/20" + }, + "flags": 0 + }, + "WriteOnDemandThroughputSettings": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "WriteProvisionedThroughputSettings": { + "type": { + "$ref": "#/22" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.DynamoDB/GlobalTable", + "properties": { + "name": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/23" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/38" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.DynamoDB/GlobalTable@default", + "scopeType": 0, + "body": { + "$ref": "#/39" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AttributeDefinition", + "properties": { + "AttributeName": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "A name for the attribute." + }, + "AttributeType": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "The data type for the attribute, where:\n + ``S`` - the attribute is of type String\n + ``N`` - the attribute is of type Number\n + ``B`` - the attribute is of type Binary" + } + } + }, + { + "$type": "ObjectType", + "name": "ContributorInsightsSpecification", + "properties": { + "Enabled": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "Indicates whether CloudWatch Contributor Insights are to be enabled (true) or disabled (false)." + } + } + }, + { + "$type": "ObjectType", + "name": "Csv", + "properties": { + "Delimiter": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "The delimiter used for separating items in the CSV file being imported." + }, + "HeaderList": { + "type": { + "$ref": "#/62" + }, + "flags": 0, + "description": "List of the headers used to specify a common header for all source CSV files being imported. If this field is specified then the first line of each CSV file is treated as data instead of the header. If this field is not specified the the first line of each CSV file is treated as the header." + } + } + }, + { + "$type": "ObjectType", + "name": "DeprecatedHashKeyElement", + "properties": { + "AttributeName": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + }, + "AttributeType": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DeprecatedKeySchema", + "properties": { + "HashKeyElement": { + "type": { + "$ref": "#/44" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "GlobalSecondaryIndex", + "properties": { + "ContributorInsightsSpecification": { + "type": { + "$ref": "#/42" + }, + "flags": 0, + "description": "The settings used to enable or disable CloudWatch Contributor Insights for the specified global secondary index." + }, + "IndexName": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "The name of the global secondary index. The name must be unique among all other indexes on this table." + }, + "KeySchema": { + "type": { + "$ref": "#/63" + }, + "flags": 1, + "description": "The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:\n + ``HASH`` - partition key\n + ``RANGE`` - sort key\n \n The partition key of an item is also known as its *hash attribute*. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.\n The sort key of an item is also known as its *range attribute*. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value." + }, + "OnDemandThroughput": { + "type": { + "$ref": "#/52" + }, + "flags": 0, + "description": "The maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify ``MaxReadRequestUnits``, ``MaxWriteRequestUnits``, or both." + }, + "Projection": { + "type": { + "$ref": "#/54" + }, + "flags": 1, + "description": "Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected." + }, + "ProvisionedThroughput": { + "type": { + "$ref": "#/55" + }, + "flags": 0, + "description": "Represents the provisioned throughput settings for the specified global secondary index.\n For current minimum and maximum provisioned throughput values, see [Service, Account, and Table Quotas](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) in the *Amazon DynamoDB Developer Guide*." + } + } + }, + { + "$type": "ObjectType", + "name": "ImportSourceSpecification", + "properties": { + "InputCompressionType": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "Type of compression to be used on the input coming from the imported table." + }, + "InputFormat": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "The format of the source data. Valid values for ``ImportFormat`` are ``CSV``, ``DYNAMODB_JSON`` or ``ION``." + }, + "InputFormatOptions": { + "type": { + "$ref": "#/48" + }, + "flags": 0, + "description": "Additional properties that specify how the input is formatted," + }, + "S3BucketSource": { + "type": { + "$ref": "#/57" + }, + "flags": 1, + "description": "The S3 bucket that provides the source for the import." + } + } + }, + { + "$type": "ObjectType", + "name": "InputFormatOptions", + "properties": { + "Csv": { + "type": { + "$ref": "#/43" + }, + "flags": 0, + "description": "The options for imported source files in CSV format. The values are Delimiter and HeaderList." + } + } + }, + { + "$type": "ObjectType", + "name": "KeySchema", + "properties": { + "AttributeName": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "The name of a key attribute." + }, + "KeyType": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "The role that this key attribute will assume:\n + ``HASH`` - partition key\n + ``RANGE`` - sort key\n \n The partition key of an item is also known as its *hash attribute*. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.\n The sort key of an item is also known as its *range attribute*. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value." + } + } + }, + { + "$type": "ObjectType", + "name": "KinesisStreamSpecification", + "properties": { + "ApproximateCreationDateTimePrecision": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "The precision for the time and date that the stream was created." + }, + "StreamArn": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "The ARN for a specific Kinesis data stream.\n Length Constraints: Minimum length of 37. Maximum length of 1024." + } + } + }, + { + "$type": "ObjectType", + "name": "LocalSecondaryIndex", + "properties": { + "IndexName": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "The name of the local secondary index. The name must be unique among all other indexes on this table." + }, + "KeySchema": { + "type": { + "$ref": "#/64" + }, + "flags": 1, + "description": "The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:\n + ``HASH`` - partition key\n + ``RANGE`` - sort key\n \n The partition key of an item is also known as its *hash attribute*. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.\n The sort key of an item is also known as its *range attribute*. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value." + }, + "Projection": { + "type": { + "$ref": "#/54" + }, + "flags": 1, + "description": "Represents attributes that are copied (projected) from the table into the local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected." + } + } + }, + { + "$type": "ObjectType", + "name": "OnDemandThroughput", + "properties": { + "MaxReadRequestUnits": { + "type": { + "$ref": "#/24" + }, + "flags": 0, + "description": "Maximum number of read request units for the specified table.\n To specify a maximum ``OnDemandThroughput`` on your table, set the value of ``MaxReadRequestUnits`` as greater than or equal to 1. To remove the maximum ``OnDemandThroughput`` that is currently set on your table, set the value of ``MaxReadRequestUnits`` to -1." + }, + "MaxWriteRequestUnits": { + "type": { + "$ref": "#/24" + }, + "flags": 0, + "description": "Maximum number of write request units for the specified table.\n To specify a maximum ``OnDemandThroughput`` on your table, set the value of ``MaxWriteRequestUnits`` as greater than or equal to 1. To remove the maximum ``OnDemandThroughput`` that is currently set on your table, set the value of ``MaxWriteRequestUnits`` to -1." + } + } + }, + { + "$type": "ObjectType", + "name": "PointInTimeRecoverySpecification", + "properties": { + "PointInTimeRecoveryEnabled": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "Indicates whether point in time recovery is enabled (true) or disabled (false) on the table." + } + } + }, + { + "$type": "ObjectType", + "name": "Projection", + "properties": { + "NonKeyAttributes": { + "type": { + "$ref": "#/65" + }, + "flags": 0, + "description": "Represents the non-key attribute names which will be projected into the index.\n For local secondary indexes, the total count of ``NonKeyAttributes`` summed across all of the local secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total." + }, + "ProjectionType": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "The set of attributes that are projected into the index:\n + ``KEYS_ONLY`` - Only the index and primary keys are projected into the index.\n + ``INCLUDE`` - In addition to the attributes described in ``KEYS_ONLY``, the secondary index will include other non-key attributes that you specify.\n + ``ALL`` - All of the table attributes are projected into the index.\n \n When using the DynamoDB console, ``ALL`` is selected by default." + } + } + }, + { + "$type": "ObjectType", + "name": "ProvisionedThroughput", + "properties": { + "ReadCapacityUnits": { + "type": { + "$ref": "#/24" + }, + "flags": 1, + "description": "The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ``ThrottlingException``. For more information, see [Specifying Read and Write Requirements](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughput.html) in the *Amazon DynamoDB Developer Guide*.\n If read/write capacity mode is ``PAY_PER_REQUEST`` the value is set to 0." + }, + "WriteCapacityUnits": { + "type": { + "$ref": "#/24" + }, + "flags": 1, + "description": "The maximum number of writes consumed per second before DynamoDB returns a ``ThrottlingException``. For more information, see [Specifying Read and Write Requirements](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughput.html) in the *Amazon DynamoDB Developer Guide*.\n If read/write capacity mode is ``PAY_PER_REQUEST`` the value is set to 0." + } + } + }, + { + "$type": "ObjectType", + "name": "ResourcePolicy", + "properties": { + "PolicyDocument": { + "type": { + "$ref": "#/66" + }, + "flags": 1, + "description": "A resource-based policy document that contains permissions to add to the specified DDB table, index, or both. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see [Using resource-based policies for](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html)." + } + } + }, + { + "$type": "ObjectType", + "name": "S3BucketSource", + "properties": { + "S3Bucket": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "The S3 bucket that is being imported from." + }, + "S3BucketOwner": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "The account number of the S3 bucket that is being imported from. If the bucket is owned by the requester this is optional." + }, + "S3KeyPrefix": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "The key prefix shared by all S3 Objects that are being imported." + } + } + }, + { + "$type": "ObjectType", + "name": "SSESpecification", + "properties": { + "KMSMasterKeyId": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "The KMS key that should be used for the KMS encryption. To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB key ``alias/aws/dynamodb``." + }, + "SSEEnabled": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "Indicates whether server-side encryption is done using an AWS managed key or an AWS owned key. If enabled (true), server-side encryption type is set to ``KMS`` and an AWS managed key is used (KMS charges apply). If disabled (false) or not specified, server-side encryption is set to AWS owned key." + }, + "SSEType": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "Server-side encryption type. The only supported value is:\n + ``KMS`` - Server-side encryption that uses KMSlong. The key is stored in your account and is managed by KMS (KMS charges apply)." + } + } + }, + { + "$type": "ObjectType", + "name": "StreamSpecification", + "properties": { + "ResourcePolicy": { + "type": { + "$ref": "#/56" + }, + "flags": 0, + "description": "Creates or updates a resource-based policy document that contains the permissions for DDB resources, such as a table's streams. Resource-based policies let you define access permissions by specifying who has access to each resource, and the actions they are allowed to perform on each resource.\n In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see [Using resource-based policies for](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html)." + }, + "StreamViewType": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "When an item in the table is modified, ``StreamViewType`` determines what information is written to the stream for this table. Valid values for ``StreamViewType`` are:\n + ``KEYS_ONLY`` - Only the key attributes of the modified item are written to the stream.\n + ``NEW_IMAGE`` - The entire item, as it appears after it was modified, is written to the stream.\n + ``OLD_IMAGE`` - The entire item, as it appeared before it was modified, is written to the stream.\n + ``NEW_AND_OLD_IMAGES`` - Both the new and the old item images of the item are written to the stream." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "The key of the tag. Tag keys are case sensitive. Each DynamoDB table can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value." + }, + "Value": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "The value of the tag. Tag values are case-sensitive and can be null." + } + } + }, + { + "$type": "ObjectType", + "name": "TimeToLiveSpecification", + "properties": { + "AttributeName": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "The name of the TTL attribute used to store the expiration time for items in the table.\n + The ``AttributeName`` property is required when enabling the TTL, or when TTL is already enabled.\n + To update this property, you must first disable TTL and then enable TTL with the new attribute name." + }, + "Enabled": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "Indicates whether TTL is to be enabled (true) or disabled (false) on the table." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/23" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/49" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/49" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/23" + } + }, + { + "$type": "ObjectType", + "name": "Table_PolicyDocument", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.DynamoDB/TableProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/41" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/46" + } + }, + { + "$type": "ObjectType", + "name": "Table_KeySchema", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/51" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/60" + } + }, + { + "$type": "ObjectType", + "name": "AWS.DynamoDB/TableProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/23" + }, + "flags": 2, + "description": "" + }, + "AttributeDefinitions": { + "type": { + "$ref": "#/68" + }, + "flags": 0, + "description": "A list of attributes that describe the key schema for the table and indexes.\n This property is required to create a DDB table.\n Update requires: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt). Replacement if you edit an existing AttributeDefinition." + }, + "BillingMode": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "Specify how you are charged for read and write throughput and how you manage capacity.\n Valid values include:\n + ``PROVISIONED`` - We recommend using ``PROVISIONED`` for predictable workloads. ``PROVISIONED`` sets the billing mode to [Provisioned Mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.ProvisionedThroughput.Manual).\n + ``PAY_PER_REQUEST`` - We recommend using ``PAY_PER_REQUEST`` for unpredictable workloads. ``PAY_PER_REQUEST`` sets the billing mode to [On-Demand Mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.OnDemand).\n \n If not specified, the default is ``PROVISIONED``." + }, + "ContributorInsightsSpecification": { + "type": { + "$ref": "#/42" + }, + "flags": 0, + "description": "The settings used to enable or disable CloudWatch Contributor Insights for the specified table." + }, + "DeletionProtectionEnabled": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "Determines if a table is protected from deletion. When enabled, the table cannot be deleted by any user or process. This setting is disabled by default. For more information, see [Using deletion protection](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html#WorkingWithTables.Basics.DeletionProtection) in the *Developer Guide*." + }, + "GlobalSecondaryIndexes": { + "type": { + "$ref": "#/69" + }, + "flags": 0, + "description": "Global secondary indexes to be created on the table. You can create up to 20 global secondary indexes.\n If you update a table to include a new global secondary index, CFNlong initiates the index creation and then proceeds with the stack update. CFNlong doesn't wait for the index to complete creation because the backfilling phase can take a long time, depending on the size of the table. You can't use the index or update the table until the index's status is ``ACTIVE``. You can track its status by using the DynamoDB [DescribeTable](https://docs.aws.amazon.com/cli/latest/reference/dynamodb/describe-table.html) command.\n If you add or delete an index during an update, we recommend that you don't update any other resources. If your stack fails to update and is rolled back while adding a new index, you must manually delete the index. \n Updates are not supported. The following are exceptions:\n + If you update either the contributor insights specification or the provisioned throughput values of global secondary indexes, you can update the table without interruption.\n + You can delete or add one global secondary index without interruption. If you do both in the same update (for example, by changing the index's logical ID), the update fails." + }, + "ImportSourceSpecification": { + "type": { + "$ref": "#/47" + }, + "flags": 4, + "description": "Specifies the properties of data being imported from the S3 bucket source to the table.\n If you specify the ``ImportSourceSpecification`` property, and also specify either the ``StreamSpecification``, the ``TableClass`` property, or the ``DeletionProtectionEnabled`` property, the IAM entity creating/updating stack must have ``UpdateTable`` permission." + }, + "KeySchema": { + "type": { + "$ref": "#/70" + }, + "flags": 1, + "description": "Specifies the attributes that make up the primary key for the table. The attributes in the ``KeySchema`` property must also be defined in the ``AttributeDefinitions`` property." + }, + "KinesisStreamSpecification": { + "type": { + "$ref": "#/50" + }, + "flags": 0, + "description": "The Kinesis Data Streams configuration for the specified table." + }, + "LocalSecondaryIndexes": { + "type": { + "$ref": "#/71" + }, + "flags": 0, + "description": "Local secondary indexes to be created on the table. You can create up to 5 local secondary indexes. Each index is scoped to a given hash key value. The size of each hash key can be up to 10 gigabytes." + }, + "OnDemandThroughput": { + "type": { + "$ref": "#/52" + }, + "flags": 0, + "description": "Sets the maximum number of read and write units for the specified on-demand table. If you use this property, you must specify ``MaxReadRequestUnits``, ``MaxWriteRequestUnits``, or both." + }, + "PointInTimeRecoverySpecification": { + "type": { + "$ref": "#/53" + }, + "flags": 0, + "description": "The settings used to enable point in time recovery." + }, + "ProvisionedThroughput": { + "type": { + "$ref": "#/55" + }, + "flags": 0, + "description": "Throughput for the specified table, which consists of values for ``ReadCapacityUnits`` and ``WriteCapacityUnits``. For more information about the contents of a provisioned throughput structure, see [Amazon DynamoDB Table ProvisionedThroughput](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ProvisionedThroughput.html). \n If you set ``BillingMode`` as ``PROVISIONED``, you must specify this property. If you set ``BillingMode`` as ``PAY_PER_REQUEST``, you cannot specify this property." + }, + "ResourcePolicy": { + "type": { + "$ref": "#/56" + }, + "flags": 0, + "description": "A resource-based policy document that contains permissions to add to the specified table. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see [Using resource-based policies for](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html).\n When you attach a resource-based policy while creating a table, the policy creation is *strongly consistent*. For information about the considerations that you should keep in mind while attaching a resource-based policy, see [Resource-based policy considerations](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html)." + }, + "SSESpecification": { + "type": { + "$ref": "#/58" + }, + "flags": 0, + "description": "Specifies the settings to enable server-side encryption." + }, + "StreamArn": { + "type": { + "$ref": "#/23" + }, + "flags": 2, + "description": "" + }, + "StreamSpecification": { + "type": { + "$ref": "#/59" + }, + "flags": 0, + "description": "The settings for the DDB table stream, which capture changes to items stored in the table." + }, + "TableClass": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "The table class of the new table. Valid values are ``STANDARD`` and ``STANDARD_INFREQUENT_ACCESS``." + }, + "TableName": { + "type": { + "$ref": "#/23" + }, + "flags": 16, + "description": "A name for the table. If you don't specify a name, CFNlong generates a unique physical ID and uses that ID for the table name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).\n If 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." + }, + "Tags": { + "type": { + "$ref": "#/72" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource.\n For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)." + }, + "TimeToLiveSpecification": { + "type": { + "$ref": "#/61" + }, + "flags": 0, + "description": "Specifies the Time to Live (TTL) settings for the table.\n For detailed information about the limits in DynamoDB, see [Limits in Amazon DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) in the Amazon DynamoDB Developer Guide." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.DynamoDB/Table", + "properties": { + "name": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/23" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/73" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.DynamoDB/Table@default", + "scopeType": 0, + "body": { + "$ref": "#/74" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.dynamodb/default/types.md b/artifacts/bicep/aws/aws.dynamodb/default/types.md index 08b6cae8..9ee2c93c 100644 --- a/artifacts/bicep/aws/aws.dynamodb/default/types.md +++ b/artifacts/bicep/aws/aws.dynamodb/default/types.md @@ -3,16 +3,29 @@ ## Resource AWS.DynamoDB/GlobalTable@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.DynamoDB/GlobalTableProperties](#awsdynamodbglobaltableproperties) (Required): properties of the resource +* **properties**: [AWS.DynamoDB/GlobalTableProperties](#awsdynamodbglobaltableproperties) (Required, Identifier): properties of the resource ## Resource AWS.DynamoDB/Table@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.DynamoDB/TableProperties](#awsdynamodbtableproperties) (Required): properties of the resource +* **properties**: [AWS.DynamoDB/TableProperties](#awsdynamodbtableproperties) (Required, Identifier): properties of the resource + +## AttributeDefinition +### Properties +* **AttributeName**: string (Required) +* **AttributeType**: string (Required) + +## AttributeDefinition +### Properties +* **AttributeName**: string (Required): A name for the attribute. +* **AttributeType**: string (Required): The data type for the attribute, where: + + ``S`` - the attribute is of type String + + ``N`` - the attribute is of type Number + + ``B`` - the attribute is of type Binary ## AWS.DynamoDB/GlobalTableProperties ### Properties @@ -29,223 +42,309 @@ * **TableId**: string (ReadOnly) * **TableName**: string (Identifier) * **TimeToLiveSpecification**: [TimeToLiveSpecification](#timetolivespecification) +* **WriteOnDemandThroughputSettings**: [WriteOnDemandThroughputSettings](#writeondemandthroughputsettings) * **WriteProvisionedThroughputSettings**: [WriteProvisionedThroughputSettings](#writeprovisionedthroughputsettings) -## AttributeDefinition +## AWS.DynamoDB/TableProperties ### Properties -* **AttributeName**: string (Required) -* **AttributeType**: string (Required) +* **Arn**: string (ReadOnly) +* **AttributeDefinitions**: [AttributeDefinition](#attributedefinition)[]: A list of attributes that describe the key schema for the table and indexes. + This property is required to create a DDB table. + Update requires: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt). Replacement if you edit an existing AttributeDefinition. +* **BillingMode**: string: Specify how you are charged for read and write throughput and how you manage capacity. + Valid values include: + + ``PROVISIONED`` - We recommend using ``PROVISIONED`` for predictable workloads. ``PROVISIONED`` sets the billing mode to [Provisioned Mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.ProvisionedThroughput.Manual). + + ``PAY_PER_REQUEST`` - We recommend using ``PAY_PER_REQUEST`` for unpredictable workloads. ``PAY_PER_REQUEST`` sets the billing mode to [On-Demand Mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.OnDemand). + + If not specified, the default is ``PROVISIONED``. +* **ContributorInsightsSpecification**: [ContributorInsightsSpecification](#contributorinsightsspecification): The settings used to enable or disable CloudWatch Contributor Insights for the specified table. +* **DeletionProtectionEnabled**: bool: Determines if a table is protected from deletion. When enabled, the table cannot be deleted by any user or process. This setting is disabled by default. For more information, see [Using deletion protection](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html#WorkingWithTables.Basics.DeletionProtection) in the *Developer Guide*. +* **GlobalSecondaryIndexes**: [GlobalSecondaryIndex](#globalsecondaryindex)[]: Global secondary indexes to be created on the table. You can create up to 20 global secondary indexes. + If you update a table to include a new global secondary index, CFNlong initiates the index creation and then proceeds with the stack update. CFNlong doesn't wait for the index to complete creation because the backfilling phase can take a long time, depending on the size of the table. You can't use the index or update the table until the index's status is ``ACTIVE``. You can track its status by using the DynamoDB [DescribeTable](https://docs.aws.amazon.com/cli/latest/reference/dynamodb/describe-table.html) command. + If you add or delete an index during an update, we recommend that you don't update any other resources. If your stack fails to update and is rolled back while adding a new index, you must manually delete the index. + Updates are not supported. The following are exceptions: + + If you update either the contributor insights specification or the provisioned throughput values of global secondary indexes, you can update the table without interruption. + + You can delete or add one global secondary index without interruption. If you do both in the same update (for example, by changing the index's logical ID), the update fails. +* **ImportSourceSpecification**: [ImportSourceSpecification](#importsourcespecification) (WriteOnly): Specifies the properties of data being imported from the S3 bucket source to the table. + If you specify the ``ImportSourceSpecification`` property, and also specify either the ``StreamSpecification``, the ``TableClass`` property, or the ``DeletionProtectionEnabled`` property, the IAM entity creating/updating stack must have ``UpdateTable`` permission. +* **KeySchema**: [Table_KeySchema](#tablekeyschema) (Required): Specifies the attributes that make up the primary key for the table. The attributes in the ``KeySchema`` property must also be defined in the ``AttributeDefinitions`` property. +* **KinesisStreamSpecification**: [KinesisStreamSpecification](#kinesisstreamspecification): The Kinesis Data Streams configuration for the specified table. +* **LocalSecondaryIndexes**: [LocalSecondaryIndex](#localsecondaryindex)[]: Local secondary indexes to be created on the table. You can create up to 5 local secondary indexes. Each index is scoped to a given hash key value. The size of each hash key can be up to 10 gigabytes. +* **OnDemandThroughput**: [OnDemandThroughput](#ondemandthroughput): Sets the maximum number of read and write units for the specified on-demand table. If you use this property, you must specify ``MaxReadRequestUnits``, ``MaxWriteRequestUnits``, or both. +* **PointInTimeRecoverySpecification**: [PointInTimeRecoverySpecification](#pointintimerecoveryspecification): The settings used to enable point in time recovery. +* **ProvisionedThroughput**: [ProvisionedThroughput](#provisionedthroughput): Throughput for the specified table, which consists of values for ``ReadCapacityUnits`` and ``WriteCapacityUnits``. For more information about the contents of a provisioned throughput structure, see [Amazon DynamoDB Table ProvisionedThroughput](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ProvisionedThroughput.html). + If you set ``BillingMode`` as ``PROVISIONED``, you must specify this property. If you set ``BillingMode`` as ``PAY_PER_REQUEST``, you cannot specify this property. +* **ResourcePolicy**: [ResourcePolicy](#resourcepolicy): A resource-based policy document that contains permissions to add to the specified table. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see [Using resource-based policies for](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html). + When you attach a resource-based policy while creating a table, the policy creation is *strongly consistent*. For information about the considerations that you should keep in mind while attaching a resource-based policy, see [Resource-based policy considerations](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html). +* **SSESpecification**: [SSESpecification](#ssespecification): Specifies the settings to enable server-side encryption. +* **StreamArn**: string (ReadOnly) +* **StreamSpecification**: [StreamSpecification](#streamspecification): The settings for the DDB table stream, which capture changes to items stored in the table. +* **TableClass**: string: The table class of the new table. Valid values are ``STANDARD`` and ``STANDARD_INFREQUENT_ACCESS``. +* **TableName**: string (Identifier): A name for the table. If you don't specify a name, CFNlong generates a unique physical ID and uses that ID for the table name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html). + If 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. +* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. + For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html). +* **TimeToLiveSpecification**: [TimeToLiveSpecification](#timetolivespecification): Specifies the Time to Live (TTL) settings for the table. + For detailed information about the limits in DynamoDB, see [Limits in Amazon DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) in the Amazon DynamoDB Developer Guide. + +## CapacityAutoScalingSettings +### Properties +* **MaxCapacity**: int (Required) +* **MinCapacity**: int (Required) +* **SeedCapacity**: int (WriteOnly) +* **TargetTrackingScalingPolicyConfiguration**: [TargetTrackingScalingPolicyConfiguration](#targettrackingscalingpolicyconfiguration) (Required) + +## ContributorInsightsSpecification +### Properties +* **Enabled**: bool (Required) + +## ContributorInsightsSpecification +### Properties +* **Enabled**: bool (Required): Indicates whether CloudWatch Contributor Insights are to be enabled (true) or disabled (false). + +## Csv +### Properties +* **Delimiter**: string: The delimiter used for separating items in the CSV file being imported. +* **HeaderList**: string[]: List of the headers used to specify a common header for all source CSV files being imported. If this field is specified then the first line of each CSV file is treated as data instead of the header. If this field is not specified the the first line of each CSV file is treated as the header. ## GlobalSecondaryIndex ### Properties * **IndexName**: string (Required) * **KeySchema**: [KeySchema](#keyschema)[] (Required) * **Projection**: [Projection](#projection) (Required) +* **WriteOnDemandThroughputSettings**: [WriteOnDemandThroughputSettings](#writeondemandthroughputsettings) * **WriteProvisionedThroughputSettings**: [WriteProvisionedThroughputSettings](#writeprovisionedthroughputsettings) -## KeySchema +## GlobalSecondaryIndex ### Properties -* **AttributeName**: string (Required) -* **KeyType**: string (Required) +* **ContributorInsightsSpecification**: [ContributorInsightsSpecification](#contributorinsightsspecification): The settings used to enable or disable CloudWatch Contributor Insights for the specified global secondary index. +* **IndexName**: string (Required): The name of the global secondary index. The name must be unique among all other indexes on this table. +* **KeySchema**: [KeySchema](#keyschema)[] (Required): The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types: + + ``HASH`` - partition key + + ``RANGE`` - sort key + + The partition key of an item is also known as its *hash attribute*. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. + The sort key of an item is also known as its *range attribute*. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value. +* **OnDemandThroughput**: [OnDemandThroughput](#ondemandthroughput): The maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify ``MaxReadRequestUnits``, ``MaxWriteRequestUnits``, or both. +* **Projection**: [Projection](#projection) (Required): Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. +* **ProvisionedThroughput**: [ProvisionedThroughput](#provisionedthroughput): Represents the provisioned throughput settings for the specified global secondary index. + For current minimum and maximum provisioned throughput values, see [Service, Account, and Table Quotas](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) in the *Amazon DynamoDB Developer Guide*. -## Projection +## GlobalTable_PolicyDocument ### Properties -* **NonKeyAttributes**: string[] -* **ProjectionType**: string -## WriteProvisionedThroughputSettings +## ImportSourceSpecification ### Properties -* **WriteCapacityAutoScalingSettings**: [CapacityAutoScalingSettings](#capacityautoscalingsettings) +* **InputCompressionType**: string: Type of compression to be used on the input coming from the imported table. +* **InputFormat**: string (Required): The format of the source data. Valid values for ``ImportFormat`` are ``CSV``, ``DYNAMODB_JSON`` or ``ION``. +* **InputFormatOptions**: [InputFormatOptions](#inputformatoptions): Additional properties that specify how the input is formatted, +* **S3BucketSource**: [S3BucketSource](#s3bucketsource) (Required): The S3 bucket that provides the source for the import. -## CapacityAutoScalingSettings +## InputFormatOptions ### Properties -* **MaxCapacity**: int (Required) -* **MinCapacity**: int (Required) -* **SeedCapacity**: int (WriteOnly) -* **TargetTrackingScalingPolicyConfiguration**: [TargetTrackingScalingPolicyConfiguration](#targettrackingscalingpolicyconfiguration) (Required) +* **Csv**: [Csv](#csv): The options for imported source files in CSV format. The values are Delimiter and HeaderList. -## TargetTrackingScalingPolicyConfiguration +## KeySchema ### Properties -* **DisableScaleIn**: bool -* **ScaleInCooldown**: int -* **ScaleOutCooldown**: int -* **TargetValue**: int (Required) +* **AttributeName**: string (Required) +* **KeyType**: string (Required) -## LocalSecondaryIndex +## KeySchema ### Properties -* **IndexName**: string (Required) -* **KeySchema**: [KeySchema](#keyschema)[] (Required) -* **Projection**: [Projection](#projection) (Required) +* **AttributeName**: string (Required): The name of a key attribute. +* **KeyType**: string (Required): The role that this key attribute will assume: + + ``HASH`` - partition key + + ``RANGE`` - sort key + + The partition key of an item is also known as its *hash attribute*. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. + The sort key of an item is also known as its *range attribute*. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value. -## ReplicaSpecification +## KinesisStreamSpecification ### Properties -* **ContributorInsightsSpecification**: [ContributorInsightsSpecification](#contributorinsightsspecification) -* **DeletionProtectionEnabled**: bool -* **GlobalSecondaryIndexes**: [ReplicaGlobalSecondaryIndexSpecification](#replicaglobalsecondaryindexspecification)[] -* **KinesisStreamSpecification**: [KinesisStreamSpecification](#kinesisstreamspecification) -* **PointInTimeRecoverySpecification**: [PointInTimeRecoverySpecification](#pointintimerecoveryspecification) -* **ReadProvisionedThroughputSettings**: [ReadProvisionedThroughputSettings](#readprovisionedthroughputsettings) -* **Region**: string (Required) -* **SSESpecification**: [ReplicaSSESpecification](#replicassespecification) -* **TableClass**: string -* **Tags**: [Tag](#tag)[] +* **ApproximateCreationDateTimePrecision**: string +* **StreamArn**: string (Required) -## ContributorInsightsSpecification +## KinesisStreamSpecification ### Properties -* **Enabled**: bool (Required) +* **ApproximateCreationDateTimePrecision**: string: The precision for the time and date that the stream was created. +* **StreamArn**: string (Required): The ARN for a specific Kinesis data stream. + Length Constraints: Minimum length of 37. Maximum length of 1024. -## ReplicaGlobalSecondaryIndexSpecification +## LocalSecondaryIndex ### Properties -* **ContributorInsightsSpecification**: [ContributorInsightsSpecification](#contributorinsightsspecification) * **IndexName**: string (Required) -* **ReadProvisionedThroughputSettings**: [ReadProvisionedThroughputSettings](#readprovisionedthroughputsettings) +* **KeySchema**: [KeySchema](#keyschema)[] (Required) +* **Projection**: [Projection](#projection) (Required) -## ReadProvisionedThroughputSettings +## LocalSecondaryIndex ### Properties -* **ReadCapacityAutoScalingSettings**: [CapacityAutoScalingSettings](#capacityautoscalingsettings) -* **ReadCapacityUnits**: int +* **IndexName**: string (Required): The name of the local secondary index. The name must be unique among all other indexes on this table. +* **KeySchema**: [KeySchema](#keyschema)[] (Required): The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types: + + ``HASH`` - partition key + + ``RANGE`` - sort key + + The partition key of an item is also known as its *hash attribute*. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. + The sort key of an item is also known as its *range attribute*. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value. +* **Projection**: [Projection](#projection) (Required): Represents attributes that are copied (projected) from the table into the local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. -## KinesisStreamSpecification +## OnDemandThroughput ### Properties -* **StreamArn**: string (Required) +* **MaxReadRequestUnits**: int: Maximum number of read request units for the specified table. + To specify a maximum ``OnDemandThroughput`` on your table, set the value of ``MaxReadRequestUnits`` as greater than or equal to 1. To remove the maximum ``OnDemandThroughput`` that is currently set on your table, set the value of ``MaxReadRequestUnits`` to -1. +* **MaxWriteRequestUnits**: int: Maximum number of write request units for the specified table. + To specify a maximum ``OnDemandThroughput`` on your table, set the value of ``MaxWriteRequestUnits`` as greater than or equal to 1. To remove the maximum ``OnDemandThroughput`` that is currently set on your table, set the value of ``MaxWriteRequestUnits`` to -1. ## PointInTimeRecoverySpecification ### Properties * **PointInTimeRecoveryEnabled**: bool -## ReplicaSSESpecification +## PointInTimeRecoverySpecification ### Properties -* **KMSMasterKeyId**: string (Required) +* **PointInTimeRecoveryEnabled**: bool: Indicates whether point in time recovery is enabled (true) or disabled (false) on the table. -## Tag +## Projection ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **NonKeyAttributes**: string[] +* **ProjectionType**: string -## SSESpecification +## Projection ### Properties -* **SSEEnabled**: bool (Required) -* **SSEType**: string +* **NonKeyAttributes**: string[]: Represents the non-key attribute names which will be projected into the index. + For local secondary indexes, the total count of ``NonKeyAttributes`` summed across all of the local secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. +* **ProjectionType**: string: The set of attributes that are projected into the index: + + ``KEYS_ONLY`` - Only the index and primary keys are projected into the index. + + ``INCLUDE`` - In addition to the attributes described in ``KEYS_ONLY``, the secondary index will include other non-key attributes that you specify. + + ``ALL`` - All of the table attributes are projected into the index. + + When using the DynamoDB console, ``ALL`` is selected by default. -## StreamSpecification +## ProvisionedThroughput ### Properties -* **StreamViewType**: string (Required) +* **ReadCapacityUnits**: int (Required): The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ``ThrottlingException``. For more information, see [Specifying Read and Write Requirements](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughput.html) in the *Amazon DynamoDB Developer Guide*. + If read/write capacity mode is ``PAY_PER_REQUEST`` the value is set to 0. +* **WriteCapacityUnits**: int (Required): The maximum number of writes consumed per second before DynamoDB returns a ``ThrottlingException``. For more information, see [Specifying Read and Write Requirements](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughput.html) in the *Amazon DynamoDB Developer Guide*. + If read/write capacity mode is ``PAY_PER_REQUEST`` the value is set to 0. -## TimeToLiveSpecification +## ReadOnDemandThroughputSettings ### Properties -* **AttributeName**: string -* **Enabled**: bool (Required) +* **MaxReadRequestUnits**: int -## AWS.DynamoDB/TableProperties +## ReadProvisionedThroughputSettings +### Properties +* **ReadCapacityAutoScalingSettings**: [CapacityAutoScalingSettings](#capacityautoscalingsettings) +* **ReadCapacityUnits**: int + +## ReplicaGlobalSecondaryIndexSpecification +### Properties +* **ContributorInsightsSpecification**: [ContributorInsightsSpecification](#contributorinsightsspecification) +* **IndexName**: string (Required) +* **ReadOnDemandThroughputSettings**: [ReadOnDemandThroughputSettings](#readondemandthroughputsettings) +* **ReadProvisionedThroughputSettings**: [ReadProvisionedThroughputSettings](#readprovisionedthroughputsettings) + +## ReplicaSpecification ### Properties -* **Arn**: string (ReadOnly) -* **AttributeDefinitions**: [AttributeDefinition](#attributedefinition)[] -* **BillingMode**: string * **ContributorInsightsSpecification**: [ContributorInsightsSpecification](#contributorinsightsspecification) * **DeletionProtectionEnabled**: bool -* **GlobalSecondaryIndexes**: [GlobalSecondaryIndex](#globalsecondaryindex)[] -* **ImportSourceSpecification**: [ImportSourceSpecification](#importsourcespecification) (WriteOnly) -* **KeySchema**: [Table_KeySchema](#tablekeyschema) (Required) +* **GlobalSecondaryIndexes**: [ReplicaGlobalSecondaryIndexSpecification](#replicaglobalsecondaryindexspecification)[] * **KinesisStreamSpecification**: [KinesisStreamSpecification](#kinesisstreamspecification) -* **LocalSecondaryIndexes**: [LocalSecondaryIndex](#localsecondaryindex)[] * **PointInTimeRecoverySpecification**: [PointInTimeRecoverySpecification](#pointintimerecoveryspecification) -* **ProvisionedThroughput**: [ProvisionedThroughput](#provisionedthroughput) -* **SSESpecification**: [SSESpecification](#ssespecification) -* **StreamArn**: string (ReadOnly) -* **StreamSpecification**: [StreamSpecification](#streamspecification) +* **ReadOnDemandThroughputSettings**: [ReadOnDemandThroughputSettings](#readondemandthroughputsettings) +* **ReadProvisionedThroughputSettings**: [ReadProvisionedThroughputSettings](#readprovisionedthroughputsettings) +* **Region**: string (Required) +* **ReplicaStreamSpecification**: [ReplicaStreamSpecification](#replicastreamspecification) +* **ResourcePolicy**: [ResourcePolicy](#resourcepolicy) +* **SSESpecification**: [ReplicaSSESpecification](#replicassespecification) * **TableClass**: string -* **TableName**: string (Identifier) * **Tags**: [Tag](#tag)[] -* **TimeToLiveSpecification**: [TimeToLiveSpecification](#timetolivespecification) -## AttributeDefinition +## ReplicaSSESpecification ### Properties -* **AttributeName**: string (Required) -* **AttributeType**: string (Required) +* **KMSMasterKeyId**: string (Required) -## ContributorInsightsSpecification +## ReplicaStreamSpecification ### Properties -* **Enabled**: bool (Required) +* **ResourcePolicy**: [ResourcePolicy](#resourcepolicy) (Required) -## GlobalSecondaryIndex +## ResourcePolicy ### Properties -* **ContributorInsightsSpecification**: [ContributorInsightsSpecification](#contributorinsightsspecification) -* **IndexName**: string (Required) -* **KeySchema**: [KeySchema](#keyschema)[] (Required) -* **Projection**: [Projection](#projection) (Required) -* **ProvisionedThroughput**: [ProvisionedThroughput](#provisionedthroughput) +* **PolicyDocument**: [GlobalTable_PolicyDocument](#globaltablepolicydocument) (Required) -## KeySchema +## ResourcePolicy ### Properties -* **AttributeName**: string (Required) -* **KeyType**: string (Required) +* **PolicyDocument**: [Table_PolicyDocument](#tablepolicydocument) (Required): A resource-based policy document that contains permissions to add to the specified DDB table, index, or both. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see [Using resource-based policies for](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html). -## Projection +## S3BucketSource ### Properties -* **NonKeyAttributes**: string[] -* **ProjectionType**: string +* **S3Bucket**: string (Required): The S3 bucket that is being imported from. +* **S3BucketOwner**: string: The account number of the S3 bucket that is being imported from. If the bucket is owned by the requester this is optional. +* **S3KeyPrefix**: string: The key prefix shared by all S3 Objects that are being imported. -## ProvisionedThroughput +## SSESpecification ### Properties -* **ReadCapacityUnits**: int (Required) -* **WriteCapacityUnits**: int (Required) +* **SSEEnabled**: bool (Required) +* **SSEType**: string -## ImportSourceSpecification +## SSESpecification ### Properties -* **InputCompressionType**: string -* **InputFormat**: string (Required) -* **InputFormatOptions**: [InputFormatOptions](#inputformatoptions) -* **S3BucketSource**: [S3BucketSource](#s3bucketsource) (Required) +* **KMSMasterKeyId**: string: The KMS key that should be used for the KMS encryption. To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB key ``alias/aws/dynamodb``. +* **SSEEnabled**: bool (Required): Indicates whether server-side encryption is done using an AWS managed key or an AWS owned key. If enabled (true), server-side encryption type is set to ``KMS`` and an AWS managed key is used (KMS charges apply). If disabled (false) or not specified, server-side encryption is set to AWS owned key. +* **SSEType**: string: Server-side encryption type. The only supported value is: + + ``KMS`` - Server-side encryption that uses KMSlong. The key is stored in your account and is managed by KMS (KMS charges apply). -## InputFormatOptions +## StreamSpecification ### Properties -* **Csv**: [Csv](#csv) +* **StreamViewType**: string (Required) -## Csv +## StreamSpecification ### Properties -* **Delimiter**: string -* **HeaderList**: string[] +* **ResourcePolicy**: [ResourcePolicy](#resourcepolicy): Creates or updates a resource-based policy document that contains the permissions for DDB resources, such as a table's streams. Resource-based policies let you define access permissions by specifying who has access to each resource, and the actions they are allowed to perform on each resource. + In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see [Using resource-based policies for](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html). +* **StreamViewType**: string (Required): When an item in the table is modified, ``StreamViewType`` determines what information is written to the stream for this table. Valid values for ``StreamViewType`` are: + + ``KEYS_ONLY`` - Only the key attributes of the modified item are written to the stream. + + ``NEW_IMAGE`` - The entire item, as it appears after it was modified, is written to the stream. + + ``OLD_IMAGE`` - The entire item, as it appeared before it was modified, is written to the stream. + + ``NEW_AND_OLD_IMAGES`` - Both the new and the old item images of the item are written to the stream. -## S3BucketSource +## Table_KeySchema ### Properties -* **S3Bucket**: string (Required) -* **S3BucketOwner**: string -* **S3KeyPrefix**: string -## Table_KeySchema +## Table_PolicyDocument ### Properties -## KinesisStreamSpecification +## Tag ### Properties -* **StreamArn**: string (Required) +* **Key**: string (Required) +* **Value**: string (Required) -## LocalSecondaryIndex +## Tag ### Properties -* **IndexName**: string (Required) -* **KeySchema**: [KeySchema](#keyschema)[] (Required) -* **Projection**: [Projection](#projection) (Required) +* **Key**: string (Required): The key of the tag. Tag keys are case sensitive. Each DynamoDB table can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value. +* **Value**: string (Required): The value of the tag. Tag values are case-sensitive and can be null. -## PointInTimeRecoverySpecification +## TargetTrackingScalingPolicyConfiguration ### Properties -* **PointInTimeRecoveryEnabled**: bool +* **DisableScaleIn**: bool +* **ScaleInCooldown**: int +* **ScaleOutCooldown**: int +* **TargetValue**: int (Required) -## SSESpecification +## TimeToLiveSpecification ### Properties -* **KMSMasterKeyId**: string -* **SSEEnabled**: bool (Required) -* **SSEType**: string +* **AttributeName**: string +* **Enabled**: bool (Required) -## StreamSpecification +## TimeToLiveSpecification ### Properties -* **StreamViewType**: string (Required) +* **AttributeName**: string: The name of the TTL attribute used to store the expiration time for items in the table. + + The ``AttributeName`` property is required when enabling the TTL, or when TTL is already enabled. + + To update this property, you must first disable TTL and then enable TTL with the new attribute name. +* **Enabled**: bool (Required): Indicates whether TTL is to be enabled (true) or disabled (false) on the table. -## Tag +## WriteOnDemandThroughputSettings ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **MaxWriteRequestUnits**: int -## TimeToLiveSpecification +## WriteProvisionedThroughputSettings ### Properties -* **AttributeName**: string -* **Enabled**: bool (Required) +* **WriteCapacityAutoScalingSettings**: [CapacityAutoScalingSettings](#capacityautoscalingsettings) diff --git a/artifacts/bicep/aws/aws.ec2/default/types.json b/artifacts/bicep/aws/aws.ec2/default/types.json index 97e93810..92f7b4d4 100644 --- a/artifacts/bicep/aws/aws.ec2/default/types.json +++ b/artifacts/bicep/aws/aws.ec2/default/types.json @@ -1 +1,14544 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"TagSpecification","Properties":{"ResourceType":{"Type":4,"Flags":0},"Tags":{"Type":10,"Flags":0}}}},{"3":{"ItemType":8}},{"2":{"Name":"AWS.EC2/CapacityReservationProperties","Properties":{"AvailabilityZone":{"Type":4,"Flags":1},"AvailableInstanceCount":{"Type":3,"Flags":2},"EbsOptimized":{"Type":2,"Flags":0},"EndDate":{"Type":4,"Flags":0},"EndDateType":{"Type":4,"Flags":0},"EphemeralStorage":{"Type":2,"Flags":0},"Id":{"Type":4,"Flags":18},"InstanceCount":{"Type":3,"Flags":1},"InstanceMatchCriteria":{"Type":4,"Flags":0},"InstancePlatform":{"Type":4,"Flags":1},"InstanceType":{"Type":4,"Flags":1},"OutPostArn":{"Type":4,"Flags":0},"PlacementGroupArn":{"Type":4,"Flags":0},"TagSpecifications":{"Type":12,"Flags":0},"Tenancy":{"Type":4,"Flags":0},"TotalInstanceCount":{"Type":3,"Flags":2}}}},{"3":{"ItemType":9}},{"2":{"Name":"AWS.EC2/CapacityReservation","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":11,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EC2/CapacityReservation@default","ScopeType":0,"Body":13}},{"2":{"Name":"InstanceTypeSpecification","Properties":{"AvailabilityZone":{"Type":4,"Flags":0},"AvailabilityZoneId":{"Type":4,"Flags":0},"EbsOptimized":{"Type":2,"Flags":0},"InstancePlatform":{"Type":4,"Flags":0},"InstanceType":{"Type":4,"Flags":0},"Priority":{"Type":3,"Flags":0},"Weight":{"Type":3,"Flags":0}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"TagSpecification","Properties":{"ResourceType":{"Type":4,"Flags":0},"Tags":{"Type":18,"Flags":0}}}},{"3":{"ItemType":16}},{"2":{"Name":"AWS.EC2/CapacityReservationFleetProperties","Properties":{"AllocationStrategy":{"Type":4,"Flags":0},"CapacityReservationFleetId":{"Type":4,"Flags":18},"EndDate":{"Type":4,"Flags":0},"InstanceMatchCriteria":{"Type":4,"Flags":0},"InstanceTypeSpecifications":{"Type":20,"Flags":0},"NoRemoveEndDate":{"Type":2,"Flags":0},"RemoveEndDate":{"Type":2,"Flags":0},"TagSpecifications":{"Type":21,"Flags":0},"Tenancy":{"Type":4,"Flags":0},"TotalTargetCapacity":{"Type":3,"Flags":0}}}},{"3":{"ItemType":15}},{"3":{"ItemType":17}},{"2":{"Name":"AWS.EC2/CapacityReservationFleet","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":19,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EC2/CapacityReservationFleet@default","ScopeType":0,"Body":22}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":0},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"Tags"}},{"3":{"ItemType":24}},{"2":{"Name":"AWS.EC2/CarrierGatewayProperties","Properties":{"CarrierGatewayId":{"Type":4,"Flags":18,"Description":"The ID of the carrier gateway."},"OwnerId":{"Type":4,"Flags":2,"Description":"The ID of the owner."},"State":{"Type":4,"Flags":2,"Description":"The state of the carrier gateway."},"Tags":{"Type":28,"Flags":0,"Description":"The tags for the carrier gateway."},"VpcId":{"Type":4,"Flags":1,"Description":"The ID of the VPC."}}}},{"3":{"ItemType":24}},{"2":{"Name":"AWS.EC2/CarrierGateway","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":27,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EC2/CarrierGateway@default","ScopeType":0,"Body":29}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.EC2/CustomerGatewayProperties","Properties":{"BgpAsn":{"Type":3,"Flags":1,"Description":"For devices that support BGP, the customer gateway's BGP ASN."},"CustomerGatewayId":{"Type":4,"Flags":18,"Description":"CustomerGateway ID generated after customer gateway is created. Each customer gateway has a unique ID."},"DeviceName":{"Type":4,"Flags":0,"Description":"A name for the customer gateway device."},"IpAddress":{"Type":4,"Flags":1,"Description":"The internet-routable IP address for the customer gateway's outside interface. The address must be static."},"Tags":{"Type":33,"Flags":0,"Description":"One or more tags for the customer gateway."},"Type":{"Type":4,"Flags":1,"Description":"The type of VPN connection that this customer gateway supports."}}}},{"3":{"ItemType":31}},{"2":{"Name":"AWS.EC2/CustomerGateway","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":32,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EC2/CustomerGateway@default","ScopeType":0,"Body":34}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.EC2/DHCPOptionsProperties","Properties":{"DhcpOptionsId":{"Type":4,"Flags":18},"DomainName":{"Type":4,"Flags":0,"Description":"This value is used to complete unqualified DNS hostnames."},"DomainNameServers":{"Type":38,"Flags":0,"Description":"The IPv4 addresses of up to four domain name servers, or AmazonProvidedDNS."},"NetbiosNameServers":{"Type":39,"Flags":0,"Description":"The IPv4 addresses of up to four NetBIOS name servers."},"NetbiosNodeType":{"Type":3,"Flags":0,"Description":"The NetBIOS node type (1, 2, 4, or 8)."},"NtpServers":{"Type":40,"Flags":0,"Description":"The IPv4 addresses of up to four Network Time Protocol (NTP) servers."},"Tags":{"Type":41,"Flags":0,"Description":"Any tags assigned to the DHCP options set."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":36}},{"2":{"Name":"AWS.EC2/DHCPOptions","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":37,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EC2/DHCPOptions@default","ScopeType":0,"Body":42}},{"2":{"Name":"AcceleratorCountRequest","Properties":{"Max":{"Type":3,"Flags":0},"Min":{"Type":3,"Flags":0}}}},{"2":{"Name":"AcceleratorTotalMemoryMiBRequest","Properties":{"Max":{"Type":3,"Flags":0},"Min":{"Type":3,"Flags":0}}}},{"2":{"Name":"BaselineEbsBandwidthMbpsRequest","Properties":{"Max":{"Type":3,"Flags":0},"Min":{"Type":3,"Flags":0}}}},{"2":{"Name":"CapacityRebalance","Properties":{"ReplacementStrategy":{"Type":4,"Flags":0},"TerminationDelay":{"Type":3,"Flags":0}}}},{"2":{"Name":"CapacityReservationOptionsRequest","Properties":{"UsageStrategy":{"Type":4,"Flags":0}}}},{"2":{"Name":"FleetLaunchTemplateConfigRequest","Properties":{"LaunchTemplateSpecification":{"Type":51,"Flags":0},"Overrides":{"Type":66,"Flags":0}}}},{"2":{"Name":"FleetLaunchTemplateOverridesRequest","Properties":{"AvailabilityZone":{"Type":4,"Flags":0},"InstanceRequirements":{"Type":52,"Flags":0},"InstanceType":{"Type":4,"Flags":0},"MaxPrice":{"Type":4,"Flags":0},"Placement":{"Type":59,"Flags":0},"Priority":{"Type":3,"Flags":0},"SubnetId":{"Type":4,"Flags":0},"WeightedCapacity":{"Type":3,"Flags":0}}}},{"2":{"Name":"FleetLaunchTemplateSpecificationRequest","Properties":{"LaunchTemplateId":{"Type":4,"Flags":0},"LaunchTemplateName":{"Type":4,"Flags":0},"Version":{"Type":4,"Flags":1}}}},{"2":{"Name":"InstanceRequirementsRequest","Properties":{"AcceleratorCount":{"Type":44,"Flags":0},"AcceleratorManufacturers":{"Type":67,"Flags":0},"AcceleratorNames":{"Type":68,"Flags":0},"AcceleratorTotalMemoryMiB":{"Type":45,"Flags":0},"AcceleratorTypes":{"Type":69,"Flags":0},"AllowedInstanceTypes":{"Type":70,"Flags":0},"BareMetal":{"Type":4,"Flags":0},"BaselineEbsBandwidthMbps":{"Type":46,"Flags":0},"BurstablePerformance":{"Type":4,"Flags":0},"CpuManufacturers":{"Type":71,"Flags":0},"ExcludedInstanceTypes":{"Type":72,"Flags":0},"InstanceGenerations":{"Type":73,"Flags":0},"LocalStorage":{"Type":4,"Flags":0},"LocalStorageTypes":{"Type":74,"Flags":0},"MemoryGiBPerVCpu":{"Type":54,"Flags":0},"MemoryMiB":{"Type":55,"Flags":0},"NetworkBandwidthGbps":{"Type":56,"Flags":0},"NetworkInterfaceCount":{"Type":57,"Flags":0},"OnDemandMaxPricePercentageOverLowestPrice":{"Type":3,"Flags":0},"RequireHibernateSupport":{"Type":2,"Flags":0},"SpotMaxPricePercentageOverLowestPrice":{"Type":3,"Flags":0},"TotalLocalStorageGB":{"Type":64,"Flags":0},"VCpuCount":{"Type":65,"Flags":0}}}},{"2":{"Name":"MaintenanceStrategies","Properties":{"CapacityRebalance":{"Type":47,"Flags":0}}}},{"2":{"Name":"MemoryGiBPerVCpuRequest","Properties":{"Max":{"Type":3,"Flags":0},"Min":{"Type":3,"Flags":0}}}},{"2":{"Name":"MemoryMiBRequest","Properties":{"Max":{"Type":3,"Flags":0},"Min":{"Type":3,"Flags":0}}}},{"2":{"Name":"NetworkBandwidthGbpsRequest","Properties":{"Max":{"Type":3,"Flags":0},"Min":{"Type":3,"Flags":0}}}},{"2":{"Name":"NetworkInterfaceCountRequest","Properties":{"Max":{"Type":3,"Flags":0},"Min":{"Type":3,"Flags":0}}}},{"2":{"Name":"OnDemandOptionsRequest","Properties":{"AllocationStrategy":{"Type":4,"Flags":0},"CapacityReservationOptions":{"Type":48,"Flags":0},"MaxTotalPrice":{"Type":4,"Flags":0},"MinTargetCapacity":{"Type":3,"Flags":0},"SingleAvailabilityZone":{"Type":2,"Flags":0},"SingleInstanceType":{"Type":2,"Flags":0}}}},{"2":{"Name":"Placement","Properties":{"Affinity":{"Type":4,"Flags":0},"AvailabilityZone":{"Type":4,"Flags":0},"GroupName":{"Type":4,"Flags":0},"HostId":{"Type":4,"Flags":0},"HostResourceGroupArn":{"Type":4,"Flags":0},"PartitionNumber":{"Type":3,"Flags":0},"SpreadDomain":{"Type":4,"Flags":0},"Tenancy":{"Type":4,"Flags":0}}}},{"2":{"Name":"SpotOptionsRequest","Properties":{"AllocationStrategy":{"Type":4,"Flags":0},"InstanceInterruptionBehavior":{"Type":4,"Flags":0},"InstancePoolsToUseCount":{"Type":3,"Flags":0},"MaintenanceStrategies":{"Type":53,"Flags":0},"MaxTotalPrice":{"Type":4,"Flags":0},"MinTargetCapacity":{"Type":3,"Flags":0},"SingleAvailabilityZone":{"Type":2,"Flags":0},"SingleInstanceType":{"Type":2,"Flags":0}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"TagSpecification","Properties":{"ResourceType":{"Type":4,"Flags":0},"Tags":{"Type":75,"Flags":0}}}},{"2":{"Name":"TargetCapacitySpecificationRequest","Properties":{"DefaultTargetCapacityType":{"Type":4,"Flags":0},"OnDemandTargetCapacity":{"Type":3,"Flags":0},"SpotTargetCapacity":{"Type":3,"Flags":0},"TargetCapacityUnitType":{"Type":4,"Flags":0},"TotalTargetCapacity":{"Type":3,"Flags":1}}}},{"2":{"Name":"TotalLocalStorageGBRequest","Properties":{"Max":{"Type":3,"Flags":0},"Min":{"Type":3,"Flags":0}}}},{"2":{"Name":"VCpuCountRangeRequest","Properties":{"Max":{"Type":3,"Flags":0},"Min":{"Type":3,"Flags":0}}}},{"3":{"ItemType":50}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":61}},{"2":{"Name":"AWS.EC2/EC2FleetProperties","Properties":{"Context":{"Type":4,"Flags":0},"ExcessCapacityTerminationPolicy":{"Type":4,"Flags":0},"FleetId":{"Type":4,"Flags":18},"LaunchTemplateConfigs":{"Type":77,"Flags":1},"OnDemandOptions":{"Type":58,"Flags":0},"ReplaceUnhealthyInstances":{"Type":2,"Flags":0},"SpotOptions":{"Type":60,"Flags":0},"TagSpecifications":{"Type":78,"Flags":0},"TargetCapacitySpecification":{"Type":63,"Flags":1},"TerminateInstancesWithExpiration":{"Type":2,"Flags":0},"Type":{"Type":4,"Flags":0},"ValidFrom":{"Type":4,"Flags":0},"ValidUntil":{"Type":4,"Flags":0}}}},{"3":{"ItemType":49}},{"3":{"ItemType":62}},{"2":{"Name":"AWS.EC2/EC2Fleet","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":76,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EC2/EC2Fleet@default","ScopeType":0,"Body":79}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.EC2/EIPProperties","Properties":{"AllocationId":{"Type":4,"Flags":18,"Description":"The Allocation ID of the EIP generated by resource."},"Domain":{"Type":4,"Flags":0,"Description":"Indicates whether the Elastic IP address is for use with instances in a VPC or instance in EC2-Classic."},"InstanceId":{"Type":4,"Flags":0,"Description":"The ID of the instance."},"NetworkBorderGroup":{"Type":4,"Flags":0,"Description":"A unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses."},"PublicIp":{"Type":4,"Flags":18,"Description":"The PublicIP of the EIP generated by resource."},"PublicIpv4Pool":{"Type":4,"Flags":0,"Description":"The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool."},"Tags":{"Type":83,"Flags":0,"Description":"Any tags assigned to the EIP."},"TransferAddress":{"Type":4,"Flags":4,"Description":"The PublicIP of the EIP generated by resource through transfer from another account"}}}},{"3":{"ItemType":81}},{"2":{"Name":"AWS.EC2/EIP","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":82,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EC2/EIP@default","ScopeType":0,"Body":84}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.EC2/FlowLogProperties","Properties":{"DeliverCrossAccountRole":{"Type":4,"Flags":0,"Description":"The ARN of the IAM role that allows Amazon EC2 to publish flow logs across accounts."},"DeliverLogsPermissionArn":{"Type":4,"Flags":0,"Description":"The ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account. If you specify LogDestinationType as s3 or kinesis-data-firehose, do not specify DeliverLogsPermissionArn or LogGroupName."},"DestinationOptions":{"Type":88,"Flags":0},"Id":{"Type":4,"Flags":18,"Description":"The Flow Log ID"},"LogDestination":{"Type":4,"Flags":0,"Description":"Specifies the destination to which the flow log data is to be published. Flow log data can be published to a CloudWatch Logs log group, an Amazon S3 bucket, or a Kinesis Firehose stream. The value specified for this parameter depends on the value specified for LogDestinationType."},"LogDestinationType":{"Type":4,"Flags":0,"Description":"Specifies the type of destination to which the flow log data is to be published. Flow log data can be published to CloudWatch Logs or Amazon S3."},"LogFormat":{"Type":4,"Flags":0,"Description":"The fields to include in the flow log record, in the order in which they should appear."},"LogGroupName":{"Type":4,"Flags":0,"Description":"The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs. If you specify LogDestinationType as s3 or kinesis-data-firehose, do not specify DeliverLogsPermissionArn or LogGroupName."},"MaxAggregationInterval":{"Type":3,"Flags":0,"Description":"The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. You can specify 60 seconds (1 minute) or 600 seconds (10 minutes)."},"ResourceId":{"Type":4,"Flags":1,"Description":"The ID of the subnet, network interface, or VPC for which you want to create a flow log."},"ResourceType":{"Type":4,"Flags":1,"Description":"The type of resource for which to create the flow log. For example, if you specified a VPC ID for the ResourceId property, specify VPC for this property."},"Tags":{"Type":89,"Flags":0,"Description":"The tags to apply to the flow logs."},"TrafficType":{"Type":4,"Flags":0,"Description":"The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic."}}}},{"2":{"Name":"FlowLog_DestinationOptions","Properties":{"FileFormat":{"Type":4,"Flags":1},"HiveCompatiblePartitions":{"Type":2,"Flags":1},"PerHourPartition":{"Type":2,"Flags":1}}}},{"3":{"ItemType":86}},{"2":{"Name":"AWS.EC2/FlowLog","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":87,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EC2/FlowLog@default","ScopeType":0,"Body":90}},{"2":{"Name":"AWS.EC2/GatewayRouteTableAssociationProperties","Properties":{"AssociationId":{"Type":4,"Flags":2,"Description":"The route table association ID."},"GatewayId":{"Type":4,"Flags":17,"Description":"The ID of the gateway."},"RouteTableId":{"Type":4,"Flags":1,"Description":"The ID of the route table."}}}},{"2":{"Name":"AWS.EC2/GatewayRouteTableAssociation","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":92,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EC2/GatewayRouteTableAssociation@default","ScopeType":0,"Body":93}},{"2":{"Name":"AWS.EC2/HostProperties","Properties":{"AssetId":{"Type":4,"Flags":0,"Description":"The ID of the Outpost hardware asset."},"AutoPlacement":{"Type":4,"Flags":0,"Description":"Indicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance launches that specify its unique host ID."},"AvailabilityZone":{"Type":4,"Flags":1,"Description":"The Availability Zone in which to allocate the Dedicated Host."},"HostId":{"Type":4,"Flags":18,"Description":"ID of the host created."},"HostMaintenance":{"Type":4,"Flags":0,"Description":"Automatically allocates a new dedicated host and moves your instances on to it if a degradation is detected on your current host."},"HostRecovery":{"Type":4,"Flags":0,"Description":"Indicates whether to enable or disable host recovery for the Dedicated Host. Host recovery is disabled by default."},"InstanceFamily":{"Type":4,"Flags":0,"Description":"Specifies the instance family to be supported by the Dedicated Hosts. If you specify an instance family, the Dedicated Hosts support multiple instance types within that instance family."},"InstanceType":{"Type":4,"Flags":0,"Description":"Specifies the instance type to be supported by the Dedicated Hosts. If you specify an instance type, the Dedicated Hosts support instances of the specified instance type only."},"OutpostArn":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which to allocate the Dedicated Host."}}}},{"2":{"Name":"AWS.EC2/Host","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":95,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EC2/Host@default","ScopeType":0,"Body":96}},{"2":{"Name":"IpamOperatingRegion","Properties":{"RegionName":{"Type":4,"Flags":1,"Description":"The name of the region."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.EC2/IPAMProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) of the IPAM."},"DefaultResourceDiscoveryAssociationId":{"Type":4,"Flags":2,"Description":"The Id of the default association to the default resource discovery, created with this IPAM."},"DefaultResourceDiscoveryId":{"Type":4,"Flags":2,"Description":"The Id of the default resource discovery, created with this IPAM."},"Description":{"Type":4,"Flags":0},"IpamId":{"Type":4,"Flags":18,"Description":"Id of the IPAM."},"OperatingRegions":{"Type":101,"Flags":0,"Description":"The regions IPAM is enabled for. Allows pools to be created in these regions, as well as enabling monitoring"},"PrivateDefaultScopeId":{"Type":4,"Flags":2,"Description":"The Id of the default scope for publicly routable IP space, created with this IPAM."},"PublicDefaultScopeId":{"Type":4,"Flags":2,"Description":"The Id of the default scope for publicly routable IP space, created with this IPAM."},"ResourceDiscoveryAssociationCount":{"Type":3,"Flags":2,"Description":"The count of resource discoveries associated with this IPAM."},"ScopeCount":{"Type":3,"Flags":2,"Description":"The number of scopes that currently exist in this IPAM."},"Tags":{"Type":102,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."},"Tier":{"Type":4,"Flags":0,"Description":"The tier of the IPAM."}}}},{"3":{"ItemType":98}},{"3":{"ItemType":99}},{"2":{"Name":"AWS.EC2/IPAM","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":100,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EC2/IPAM@default","ScopeType":0,"Body":103}},{"2":{"Name":"Cidr"}},{"2":{"Name":"ProvisionedCidr","Properties":{"Cidr":{"Type":4,"Flags":1}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.EC2/IPAMPoolProperties","Properties":{"AddressFamily":{"Type":4,"Flags":1,"Description":"The address family of the address space in this pool. Either IPv4 or IPv6."},"AllocationDefaultNetmaskLength":{"Type":3,"Flags":0,"Description":"The default netmask length for allocations made from this pool. This value is used when the netmask length of an allocation isn't specified."},"AllocationMaxNetmaskLength":{"Type":3,"Flags":0,"Description":"The maximum allowed netmask length for allocations made from this pool."},"AllocationMinNetmaskLength":{"Type":3,"Flags":0,"Description":"The minimum allowed netmask length for allocations made from this pool."},"AllocationResourceTags":{"Type":109,"Flags":0,"Description":"When specified, an allocation will not be allowed unless a resource has a matching set of tags."},"Arn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) of the IPAM Pool."},"AutoImport":{"Type":2,"Flags":0,"Description":"Determines what to do if IPAM discovers resources that haven't been assigned an allocation. If set to true, an allocation will be made automatically."},"AwsService":{"Type":4,"Flags":0,"Description":"Limits which service in Amazon Web Services that the pool can be used in."},"Description":{"Type":4,"Flags":0},"IpamArn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) of the IPAM this pool is a part of."},"IpamPoolId":{"Type":4,"Flags":18,"Description":"Id of the IPAM Pool."},"IpamScopeArn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) of the scope this pool is a part of."},"IpamScopeId":{"Type":4,"Flags":1,"Description":"The Id of the scope this pool is a part of."},"IpamScopeType":{"Type":4,"Flags":2,"Description":"Determines whether this scope contains publicly routable space or space for a private network"},"Locale":{"Type":4,"Flags":0,"Description":"The region of this pool. If not set, this will default to \"None\" which will disable non-custom allocations. If the locale has been specified for the source pool, this value must match."},"PoolDepth":{"Type":3,"Flags":2,"Description":"The depth of this pool in the source pool hierarchy."},"ProvisionedCidrs":{"Type":110,"Flags":0,"Description":"A list of cidrs representing the address space available for allocation in this pool."},"PublicIpSource":{"Type":4,"Flags":0,"Description":"The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is `byoip`."},"PubliclyAdvertisable":{"Type":2,"Flags":0,"Description":"Determines whether or not address space from this pool is publicly advertised. Must be set if and only if the pool is IPv6."},"SourceIpamPoolId":{"Type":4,"Flags":0,"Description":"The Id of this pool's source. If set, all space provisioned in this pool must be free space provisioned in the parent pool."},"State":{"Type":4,"Flags":2,"Description":"The state of this pool. This can be one of the following values: \"create-in-progress\", \"create-complete\", \"modify-in-progress\", \"modify-complete\", \"delete-in-progress\", or \"delete-complete\""},"StateMessage":{"Type":4,"Flags":2,"Description":"An explanation of how the pool arrived at it current state."},"Tags":{"Type":111,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."}}}},{"3":{"ItemType":107}},{"3":{"ItemType":106}},{"3":{"ItemType":107}},{"2":{"Name":"AWS.EC2/IPAMPool","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":108,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EC2/IPAMPool@default","ScopeType":0,"Body":112}},{"2":{"Name":"IpamOperatingRegion","Properties":{"RegionName":{"Type":4,"Flags":1,"Description":"The name of the region."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.EC2/IPAMResourceDiscoveryProperties","Properties":{"Description":{"Type":4,"Flags":0},"IpamResourceDiscoveryArn":{"Type":4,"Flags":2,"Description":"Amazon Resource Name (Arn) for the Resource Discovery."},"IpamResourceDiscoveryId":{"Type":4,"Flags":18,"Description":"Id of the IPAM Pool."},"IpamResourceDiscoveryRegion":{"Type":4,"Flags":2,"Description":"The region the resource discovery is setup in. "},"IsDefault":{"Type":2,"Flags":2,"Description":"Determines whether or not address space from this pool is publicly advertised. Must be set if and only if the pool is IPv6."},"OperatingRegions":{"Type":117,"Flags":0,"Description":"The regions Resource Discovery is enabled for. Allows resource discoveries to be created in these regions, as well as enabling monitoring"},"OwnerId":{"Type":4,"Flags":2,"Description":"Owner Account ID of the Resource Discovery"},"State":{"Type":4,"Flags":2,"Description":"The state of this Resource Discovery."},"Tags":{"Type":118,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."}}}},{"3":{"ItemType":114}},{"3":{"ItemType":115}},{"2":{"Name":"AWS.EC2/IPAMResourceDiscovery","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":116,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EC2/IPAMResourceDiscovery@default","ScopeType":0,"Body":119}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.EC2/IPAMResourceDiscoveryAssociationProperties","Properties":{"IpamArn":{"Type":4,"Flags":2,"Description":"Arn of the IPAM."},"IpamId":{"Type":4,"Flags":1,"Description":"The Id of the IPAM this Resource Discovery is associated to."},"IpamRegion":{"Type":4,"Flags":2,"Description":"The home region of the IPAM."},"IpamResourceDiscoveryAssociationArn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) of the resource discovery association is a part of."},"IpamResourceDiscoveryAssociationId":{"Type":4,"Flags":18,"Description":"Id of the IPAM Resource Discovery Association."},"IpamResourceDiscoveryId":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) of the IPAM Resource Discovery Association."},"IsDefault":{"Type":2,"Flags":2,"Description":"If the Resource Discovery Association exists due as part of CreateIpam."},"OwnerId":{"Type":4,"Flags":2,"Description":"The AWS Account ID for the account where the shared IPAM exists."},"ResourceDiscoveryStatus":{"Type":4,"Flags":2,"Description":"The status of the resource discovery."},"State":{"Type":4,"Flags":2,"Description":"The operational state of the Resource Discovery Association. Related to Create/Delete activities."},"Tags":{"Type":123,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."}}}},{"3":{"ItemType":121}},{"2":{"Name":"AWS.EC2/IPAMResourceDiscoveryAssociation","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":122,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EC2/IPAMResourceDiscoveryAssociation@default","ScopeType":0,"Body":124}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.EC2/IPAMScopeProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) of the IPAM scope."},"Description":{"Type":4,"Flags":0},"IpamArn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) of the IPAM this scope is a part of."},"IpamId":{"Type":4,"Flags":1,"Description":"The Id of the IPAM this scope is a part of."},"IpamScopeId":{"Type":4,"Flags":18,"Description":"Id of the IPAM scope."},"IpamScopeType":{"Type":4,"Flags":2,"Description":"Determines whether this scope contains publicly routable space or space for a private network"},"IsDefault":{"Type":2,"Flags":2,"Description":"Is this one of the default scopes created with the IPAM."},"PoolCount":{"Type":3,"Flags":2,"Description":"The number of pools that currently exist in this scope."},"Tags":{"Type":128,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."}}}},{"3":{"ItemType":126}},{"2":{"Name":"AWS.EC2/IPAMScope","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":127,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EC2/IPAMScope@default","ScopeType":0,"Body":129}},{"2":{"Name":"AssociationParameter","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":150,"Flags":1}}}},{"2":{"Name":"BlockDeviceMapping","Properties":{"DeviceName":{"Type":4,"Flags":1},"Ebs":{"Type":135,"Flags":0},"NoDevice":{"Type":144,"Flags":0},"VirtualName":{"Type":4,"Flags":0}}}},{"2":{"Name":"CpuOptions","Properties":{"CoreCount":{"Type":3,"Flags":0},"ThreadsPerCore":{"Type":3,"Flags":0}}}},{"2":{"Name":"CreditSpecification","Properties":{"CPUCredits":{"Type":4,"Flags":0}}}},{"2":{"Name":"Ebs","Properties":{"DeleteOnTermination":{"Type":2,"Flags":0},"Encrypted":{"Type":2,"Flags":0},"Iops":{"Type":3,"Flags":0},"KmsKeyId":{"Type":4,"Flags":0},"SnapshotId":{"Type":4,"Flags":0},"VolumeSize":{"Type":3,"Flags":0},"VolumeType":{"Type":4,"Flags":0}}}},{"2":{"Name":"ElasticGpuSpecification","Properties":{"Type":{"Type":4,"Flags":1}}}},{"2":{"Name":"ElasticInferenceAccelerator","Properties":{"Count":{"Type":3,"Flags":0},"Type":{"Type":4,"Flags":1}}}},{"2":{"Name":"EnclaveOptions","Properties":{"Enabled":{"Type":2,"Flags":0}}}},{"2":{"Name":"HibernationOptions","Properties":{"Configured":{"Type":2,"Flags":0}}}},{"2":{"Name":"InstanceIpv6Address","Properties":{"Ipv6Address":{"Type":4,"Flags":1}}}},{"2":{"Name":"LaunchTemplateSpecification","Properties":{"LaunchTemplateId":{"Type":4,"Flags":0},"LaunchTemplateName":{"Type":4,"Flags":0},"Version":{"Type":4,"Flags":1}}}},{"2":{"Name":"LicenseSpecification","Properties":{"LicenseConfigurationArn":{"Type":4,"Flags":1}}}},{"2":{"Name":"NetworkInterface","Properties":{"AssociateCarrierIpAddress":{"Type":2,"Flags":0},"AssociatePublicIpAddress":{"Type":2,"Flags":0},"DeleteOnTermination":{"Type":2,"Flags":0},"Description":{"Type":4,"Flags":0},"DeviceIndex":{"Type":4,"Flags":1},"GroupSet":{"Type":151,"Flags":0},"Ipv6AddressCount":{"Type":3,"Flags":0},"Ipv6Addresses":{"Type":152,"Flags":0},"NetworkInterfaceId":{"Type":4,"Flags":0},"PrivateIpAddress":{"Type":4,"Flags":0},"PrivateIpAddresses":{"Type":153,"Flags":0},"SecondaryPrivateIpAddressCount":{"Type":3,"Flags":0},"SubnetId":{"Type":4,"Flags":0}}}},{"2":{"Name":"NoDevice","Properties":{}}},{"2":{"Name":"PrivateDnsNameOptions","Properties":{"EnableResourceNameDnsAAAARecord":{"Type":2,"Flags":0},"EnableResourceNameDnsARecord":{"Type":2,"Flags":0},"HostnameType":{"Type":4,"Flags":0}}}},{"2":{"Name":"PrivateIpAddressSpecification","Properties":{"Primary":{"Type":2,"Flags":1},"PrivateIpAddress":{"Type":4,"Flags":1}}}},{"2":{"Name":"SsmAssociation","Properties":{"AssociationParameters":{"Type":154,"Flags":0},"DocumentName":{"Type":4,"Flags":1}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"Volume","Properties":{"Device":{"Type":4,"Flags":1},"VolumeId":{"Type":4,"Flags":1}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":140}},{"3":{"ItemType":146}},{"3":{"ItemType":131}},{"2":{"Name":"AWS.EC2/InstanceProperties","Properties":{"AdditionalInfo":{"Type":4,"Flags":0},"Affinity":{"Type":4,"Flags":0},"AvailabilityZone":{"Type":4,"Flags":0},"BlockDeviceMappings":{"Type":156,"Flags":0},"CpuOptions":{"Type":133,"Flags":0},"CreditSpecification":{"Type":134,"Flags":0},"DisableApiTermination":{"Type":2,"Flags":0},"EbsOptimized":{"Type":2,"Flags":0},"ElasticGpuSpecifications":{"Type":157,"Flags":0},"ElasticInferenceAccelerators":{"Type":158,"Flags":0},"EnclaveOptions":{"Type":138,"Flags":0},"HibernationOptions":{"Type":139,"Flags":0},"HostId":{"Type":4,"Flags":0},"HostResourceGroupArn":{"Type":4,"Flags":0},"IamInstanceProfile":{"Type":4,"Flags":0},"Id":{"Type":4,"Flags":18},"ImageId":{"Type":4,"Flags":0},"InstanceInitiatedShutdownBehavior":{"Type":4,"Flags":0},"InstanceType":{"Type":4,"Flags":0},"Ipv6AddressCount":{"Type":3,"Flags":0},"Ipv6Addresses":{"Type":159,"Flags":0},"KernelId":{"Type":4,"Flags":0},"KeyName":{"Type":4,"Flags":0},"LaunchTemplate":{"Type":141,"Flags":0},"LicenseSpecifications":{"Type":160,"Flags":0},"Monitoring":{"Type":2,"Flags":0},"NetworkInterfaces":{"Type":161,"Flags":0},"PlacementGroupName":{"Type":4,"Flags":0},"PrivateDnsName":{"Type":4,"Flags":2},"PrivateDnsNameOptions":{"Type":145,"Flags":0},"PrivateIp":{"Type":4,"Flags":2},"PrivateIpAddress":{"Type":4,"Flags":0},"PropagateTagsToVolumeOnCreation":{"Type":2,"Flags":0},"PublicDnsName":{"Type":4,"Flags":2},"PublicIp":{"Type":4,"Flags":2},"RamdiskId":{"Type":4,"Flags":0},"SecurityGroupIds":{"Type":162,"Flags":0},"SecurityGroups":{"Type":163,"Flags":0},"SourceDestCheck":{"Type":2,"Flags":0},"SsmAssociations":{"Type":164,"Flags":0},"SubnetId":{"Type":4,"Flags":0},"Tags":{"Type":165,"Flags":0},"Tenancy":{"Type":4,"Flags":0},"UserData":{"Type":4,"Flags":0},"Volumes":{"Type":166,"Flags":0}}}},{"3":{"ItemType":132}},{"3":{"ItemType":136}},{"3":{"ItemType":137}},{"3":{"ItemType":140}},{"3":{"ItemType":142}},{"3":{"ItemType":143}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":147}},{"3":{"ItemType":148}},{"3":{"ItemType":149}},{"2":{"Name":"AWS.EC2/Instance","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":155,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EC2/Instance@default","ScopeType":0,"Body":167}},{"2":{"Name":"SecurityGroupId"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.EC2/InstanceConnectEndpointProperties","Properties":{"ClientToken":{"Type":4,"Flags":4,"Description":"The client token of the instance connect endpoint."},"Id":{"Type":4,"Flags":18,"Description":"The id of the instance connect endpoint"},"PreserveClientIp":{"Type":2,"Flags":0,"Description":"If true, the address of the loki client is preserved when connecting to the end resource"},"SecurityGroupIds":{"Type":172,"Flags":0,"Description":"The security group IDs of the instance connect endpoint."},"SubnetId":{"Type":4,"Flags":1,"Description":"The subnet id of the instance connect endpoint"},"Tags":{"Type":173,"Flags":0,"Description":"The tags of the instance connect endpoint."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":170}},{"2":{"Name":"AWS.EC2/InstanceConnectEndpoint","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":171,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EC2/InstanceConnectEndpoint@default","ScopeType":0,"Body":174}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.EC2/InternetGatewayProperties","Properties":{"InternetGatewayId":{"Type":4,"Flags":18,"Description":"ID of internet gateway."},"Tags":{"Type":178,"Flags":0,"Description":"Any tags to assign to the internet gateway."}}}},{"3":{"ItemType":176}},{"2":{"Name":"AWS.EC2/InternetGateway","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":177,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EC2/InternetGateway@default","ScopeType":0,"Body":179}},{"2":{"Name":"AcceleratorCount","Properties":{"Max":{"Type":3,"Flags":0,"Description":"The maximum number of accelerators."},"Min":{"Type":3,"Flags":0,"Description":"The minimum number of accelerators."}}}},{"2":{"Name":"AcceleratorTotalMemoryMiB","Properties":{"Max":{"Type":3,"Flags":0,"Description":"The maximum amount of accelerator memory, in MiB."},"Min":{"Type":3,"Flags":0,"Description":"The minimum amount of accelerator memory, in MiB."}}}},{"2":{"Name":"BaselineEbsBandwidthMbps","Properties":{"Max":{"Type":3,"Flags":0,"Description":"The maximum baseline bandwidth, in Mbps."},"Min":{"Type":3,"Flags":0,"Description":"The minimum baseline bandwidth, in Mbps."}}}},{"2":{"Name":"BlockDeviceMapping","Properties":{"DeviceName":{"Type":4,"Flags":0,"Description":"The user data to make available to the instance."},"Ebs":{"Type":190,"Flags":0},"NoDevice":{"Type":4,"Flags":0,"Description":"To omit the device from the block device mapping, specify an empty string."},"VirtualName":{"Type":4,"Flags":0,"Description":"The virtual device name (ephemeralN)."}}}},{"2":{"Name":"CapacityReservationSpecification","Properties":{"CapacityReservationPreference":{"Type":4,"Flags":0,"Description":"Indicates the instance's Capacity Reservation preferences."},"CapacityReservationTarget":{"Type":186,"Flags":0}}}},{"2":{"Name":"CapacityReservationTarget","Properties":{"CapacityReservationId":{"Type":4,"Flags":0,"Description":"The ID of the Capacity Reservation in which to run the instance."},"CapacityReservationResourceGroupArn":{"Type":4,"Flags":0,"Description":"The ARN of the Capacity Reservation resource group in which to run the instance."}}}},{"2":{"Name":"ConnectionTrackingSpecification","Properties":{"TcpEstablishedTimeout":{"Type":3,"Flags":0,"Description":"Integer value for TCP Established Timeout"},"UdpStreamTimeout":{"Type":3,"Flags":0,"Description":"Integer value for UDP Stream Timeout"},"UdpTimeout":{"Type":3,"Flags":0,"Description":"Integer value for UDP Timeout"}}}},{"2":{"Name":"CpuOptions","Properties":{"AmdSevSnp":{"Type":4,"Flags":0,"Description":"Indicates whether to enable the instance for AMD SEV-SNP. AMD SEV-SNP is supported with M6a, R6a, and C6a instance types only."},"CoreCount":{"Type":3,"Flags":0,"Description":"The number of CPU cores for the instance."},"ThreadsPerCore":{"Type":3,"Flags":0,"Description":"The number of threads per CPU core. To disable multithreading for the instance, specify a value of 1. Otherwise, specify the default value of 2."}}}},{"2":{"Name":"CreditSpecification","Properties":{"CpuCredits":{"Type":4,"Flags":0,"Description":"The user data to make available to the instance."}}}},{"2":{"Name":"Ebs","Properties":{"DeleteOnTermination":{"Type":2,"Flags":0,"Description":"Indicates whether the EBS volume is deleted on instance termination."},"Encrypted":{"Type":2,"Flags":0,"Description":"Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value."},"Iops":{"Type":3,"Flags":0,"Description":"The number of I/O operations per second (IOPS)."},"KmsKeyId":{"Type":4,"Flags":0,"Description":"The ARN of the symmetric AWS Key Management Service (AWS KMS) CMK used for encryption."},"SnapshotId":{"Type":4,"Flags":0,"Description":"The ID of the snapshot."},"Throughput":{"Type":3,"Flags":0,"Description":"The throughput to provision for a gp3 volume, with a maximum of 1,000 MiB/s."},"VolumeSize":{"Type":3,"Flags":0,"Description":"The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size."},"VolumeType":{"Type":4,"Flags":0,"Description":"The volume type."}}}},{"2":{"Name":"ElasticGpuSpecification","Properties":{"Type":{"Type":4,"Flags":0,"Description":"The type of Elastic Graphics accelerator."}}}},{"2":{"Name":"EnaSrdSpecification","Properties":{"EnaSrdEnabled":{"Type":2,"Flags":0,"Description":"Enables TCP ENA-SRD"},"EnaSrdUdpSpecification":{"Type":193,"Flags":0}}}},{"2":{"Name":"EnaSrdUdpSpecification","Properties":{"EnaSrdUdpEnabled":{"Type":2,"Flags":0,"Description":"Enables UDP ENA-SRD"}}}},{"2":{"Name":"EnclaveOptions","Properties":{"Enabled":{"Type":2,"Flags":0,"Description":"If this parameter is set to true, the instance is enabled for AWS Nitro Enclaves; otherwise, it is not enabled for AWS Nitro Enclaves."}}}},{"2":{"Name":"HibernationOptions","Properties":{"Configured":{"Type":2,"Flags":0,"Description":"TIf you set this parameter to true, the instance is enabled for hibernation."}}}},{"2":{"Name":"IamInstanceProfile","Properties":{"Arn":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) of the instance profile."},"Name":{"Type":4,"Flags":0,"Description":"The name of the instance profile."}}}},{"2":{"Name":"InstanceMarketOptions","Properties":{"MarketType":{"Type":4,"Flags":0,"Description":"The market type."},"SpotOptions":{"Type":217,"Flags":0}}}},{"2":{"Name":"InstanceRequirements","Properties":{"AcceleratorCount":{"Type":181,"Flags":0},"AcceleratorManufacturers":{"Type":222,"Flags":0,"Description":"Indicates whether instance types must have accelerators by specific manufacturers."},"AcceleratorNames":{"Type":223,"Flags":0,"Description":"The accelerators that must be on the instance type."},"AcceleratorTotalMemoryMiB":{"Type":182,"Flags":0},"AcceleratorTypes":{"Type":224,"Flags":0,"Description":"The accelerator types that must be on the instance type."},"AllowedInstanceTypes":{"Type":225,"Flags":0,"Description":"The instance types to apply your specified attributes against."},"BareMetal":{"Type":4,"Flags":0,"Description":"Indicates whether bare metal instance types must be included, excluded, or required."},"BaselineEbsBandwidthMbps":{"Type":183,"Flags":0},"BurstablePerformance":{"Type":4,"Flags":0},"CpuManufacturers":{"Type":226,"Flags":0,"Description":"The CPU manufacturers to include."},"ExcludedInstanceTypes":{"Type":227,"Flags":0,"Description":"The instance types to exclude."},"InstanceGenerations":{"Type":228,"Flags":0,"Description":"Indicates whether current or previous generation instance types are included."},"LocalStorage":{"Type":4,"Flags":0,"Description":"The user data to make available to the instance."},"LocalStorageTypes":{"Type":229,"Flags":0,"Description":"The type of local storage that is required."},"MemoryGiBPerVCpu":{"Type":207,"Flags":0},"MemoryMiB":{"Type":208,"Flags":0},"NetworkBandwidthGbps":{"Type":211,"Flags":0},"NetworkInterfaceCount":{"Type":213,"Flags":0},"OnDemandMaxPricePercentageOverLowestPrice":{"Type":3,"Flags":0,"Description":"The price protection threshold for On-Demand Instances."},"RequireHibernateSupport":{"Type":2,"Flags":0,"Description":"Indicates whether instance types must support hibernation for On-Demand Instances."},"SpotMaxPricePercentageOverLowestPrice":{"Type":3,"Flags":0,"Description":"The price protection threshold for Spot Instances."},"TotalLocalStorageGB":{"Type":220,"Flags":0},"VCpuCount":{"Type":221,"Flags":0}}}},{"2":{"Name":"Ipv4PrefixSpecification","Properties":{"Ipv4Prefix":{"Type":4,"Flags":0,"Description":"The IPv4 prefix."}}}},{"2":{"Name":"Ipv6Add","Properties":{"Ipv6Address":{"Type":4,"Flags":0}}}},{"2":{"Name":"Ipv6PrefixSpecification","Properties":{"Ipv6Prefix":{"Type":4,"Flags":0}}}},{"2":{"Name":"LaunchTemplateData","Properties":{"BlockDeviceMappings":{"Type":230,"Flags":0,"Description":"The block device mapping."},"CapacityReservationSpecification":{"Type":185,"Flags":0},"CpuOptions":{"Type":188,"Flags":0},"CreditSpecification":{"Type":189,"Flags":0},"DisableApiStop":{"Type":2,"Flags":0,"Description":"Indicates whether to enable the instance for stop protection."},"DisableApiTermination":{"Type":2,"Flags":0,"Description":"If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API."},"EbsOptimized":{"Type":2,"Flags":0,"Description":"Indicates whether the instance is optimized for Amazon EBS I/O."},"ElasticGpuSpecifications":{"Type":231,"Flags":0,"Description":"An elastic GPU to associate with the instance."},"ElasticInferenceAccelerators":{"Type":232,"Flags":0,"Description":"The elastic inference accelerator for the instance."},"EnclaveOptions":{"Type":194,"Flags":0},"HibernationOptions":{"Type":195,"Flags":0},"IamInstanceProfile":{"Type":196,"Flags":0},"ImageId":{"Type":4,"Flags":0,"Description":"The ID of the AMI. Alternatively, you can specify a Systems Manager parameter, which will resolve to an AMI ID on launch."},"InstanceInitiatedShutdownBehavior":{"Type":4,"Flags":0,"Description":"Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown)."},"InstanceMarketOptions":{"Type":197,"Flags":0},"InstanceRequirements":{"Type":198,"Flags":0},"InstanceType":{"Type":4,"Flags":0},"KernelId":{"Type":4,"Flags":0,"Description":"The ID of the kernel."},"KeyName":{"Type":4,"Flags":0,"Description":"The name of the EC2 key pair"},"LicenseSpecifications":{"Type":233,"Flags":0,"Description":"The license configurations."},"MaintenanceOptions":{"Type":206,"Flags":0},"MetadataOptions":{"Type":209,"Flags":0},"Monitoring":{"Type":210,"Flags":0},"NetworkInterfaces":{"Type":234,"Flags":0,"Description":"If you specify a network interface, you must specify any security groups and subnets as part of the network interface."},"Placement":{"Type":214,"Flags":0},"PrivateDnsNameOptions":{"Type":215,"Flags":0},"RamDiskId":{"Type":4,"Flags":0},"SecurityGroupIds":{"Type":235,"Flags":0,"Description":"One or more security group IDs. "},"SecurityGroups":{"Type":236,"Flags":0,"Description":"One or more security group names."},"TagSpecifications":{"Type":237,"Flags":0,"Description":"The tags to apply to the resources that are created during instance launch."},"UserData":{"Type":4,"Flags":0,"Description":"The user data to make available to the instance."}}}},{"2":{"Name":"LaunchTemplateElasticInferenceAccelerator","Properties":{"Count":{"Type":3,"Flags":0,"Description":"The number of elastic inference accelerators to attach to the instance."},"Type":{"Type":4,"Flags":0,"Description":"The type of elastic inference accelerator."}}}},{"2":{"Name":"LaunchTemplateTagSpecification","Properties":{"ResourceType":{"Type":4,"Flags":0,"Description":"The type of resource to tag."},"Tags":{"Type":238,"Flags":0,"Description":"The tags for the resource."}}}},{"2":{"Name":"LicenseSpecification","Properties":{"LicenseConfigurationArn":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) of the license configuration."}}}},{"2":{"Name":"MaintenanceOptions","Properties":{"AutoRecovery":{"Type":4,"Flags":0,"Description":"Disables the automatic recovery behavior of your instance or sets it to default."},"RebootMigration":{"Type":4,"Flags":0,"Description":"Disables the automatic reboot-migration behavior of your instance or sets it to default."}}}},{"2":{"Name":"MemoryGiBPerVCpu","Properties":{"Max":{"Type":3,"Flags":0,"Description":"The maximum amount of memory per vCPU, in GiB."},"Min":{"Type":3,"Flags":0,"Description":"TThe minimum amount of memory per vCPU, in GiB."}}}},{"2":{"Name":"MemoryMiB","Properties":{"Max":{"Type":3,"Flags":0,"Description":"The maximum amount of memory, in MiB."},"Min":{"Type":3,"Flags":0,"Description":"The minimum amount of memory, in MiB."}}}},{"2":{"Name":"MetadataOptions","Properties":{"HttpEndpoint":{"Type":4,"Flags":0,"Description":"Enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled."},"HttpProtocolIpv6":{"Type":4,"Flags":0,"Description":"Enables or disables the IPv6 endpoint for the instance metadata service."},"HttpPutResponseHopLimit":{"Type":3,"Flags":0,"Description":"The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel."},"HttpTokens":{"Type":4,"Flags":0,"Description":"IMDSv2 uses token-backed sessions."},"InstanceMetadataTags":{"Type":4,"Flags":0,"Description":"Set to enabled to allow access to instance tags from the instance metadata."}}}},{"2":{"Name":"Monitoring","Properties":{"Enabled":{"Type":2,"Flags":0,"Description":"Specify true to enable detailed monitoring."}}}},{"2":{"Name":"NetworkBandwidthGbps","Properties":{"Max":{"Type":3,"Flags":0,"Description":"The maximum amount of network bandwidth, in Gbps."},"Min":{"Type":3,"Flags":0,"Description":"The minimum amount of network bandwidth, in Gbps."}}}},{"2":{"Name":"NetworkInterface","Properties":{"AssociateCarrierIpAddress":{"Type":2,"Flags":0,"Description":"Indicates whether to associate a Carrier IP address with eth0 for a new network interface."},"AssociatePublicIpAddress":{"Type":2,"Flags":0,"Description":"Associates a public IPv4 address with eth0 for a new network interface."},"ConnectionTrackingSpecification":{"Type":187,"Flags":0},"DeleteOnTermination":{"Type":2,"Flags":0,"Description":"Indicates whether the network interface is deleted when the instance is terminated."},"Description":{"Type":4,"Flags":0,"Description":"A description for the network interface."},"DeviceIndex":{"Type":3,"Flags":0,"Description":"The device index for the network interface attachment."},"EnaSrdSpecification":{"Type":192,"Flags":0},"Groups":{"Type":239,"Flags":0,"Description":"The IDs of one or more security groups."},"InterfaceType":{"Type":4,"Flags":0,"Description":"The type of network interface."},"Ipv4PrefixCount":{"Type":3,"Flags":0,"Description":"The number of IPv4 prefixes to be automatically assigned to the network interface."},"Ipv4Prefixes":{"Type":240,"Flags":0,"Description":"One or more IPv4 prefixes to be assigned to the network interface."},"Ipv6AddressCount":{"Type":3,"Flags":0,"Description":"The number of IPv6 addresses to assign to a network interface."},"Ipv6Addresses":{"Type":241,"Flags":0,"Description":"One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet."},"Ipv6PrefixCount":{"Type":3,"Flags":0,"Description":"The number of IPv6 prefixes to be automatically assigned to the network interface."},"Ipv6Prefixes":{"Type":242,"Flags":0,"Description":"One or more IPv6 prefixes to be assigned to the network interface."},"NetworkCardIndex":{"Type":3,"Flags":0,"Description":"The index of the network card."},"NetworkInterfaceId":{"Type":4,"Flags":0,"Description":"The ID of the network interface."},"PrimaryIpv6":{"Type":2,"Flags":0,"Description":"Enables the first IPv6 global unique address (GUA) on a dual stack or IPv6-only ENI immutable."},"PrivateIpAddress":{"Type":4,"Flags":0,"Description":"The primary private IPv4 address of the network interface."},"PrivateIpAddresses":{"Type":243,"Flags":0,"Description":"One or more private IPv4 addresses."},"SecondaryPrivateIpAddressCount":{"Type":3,"Flags":0,"Description":"The number of secondary private IPv4 addresses to assign to a network interface."},"SubnetId":{"Type":4,"Flags":0,"Description":"The ID of the subnet for the network interface."}}}},{"2":{"Name":"NetworkInterfaceCount","Properties":{"Max":{"Type":3,"Flags":0},"Min":{"Type":3,"Flags":0}}}},{"2":{"Name":"Placement","Properties":{"Affinity":{"Type":4,"Flags":0,"Description":"The affinity setting for an instance on a Dedicated Host."},"AvailabilityZone":{"Type":4,"Flags":0,"Description":"The Availability Zone for the instance."},"GroupId":{"Type":4,"Flags":0,"Description":"The Group Id of a placement group. You must specify the Placement Group Group Id to launch an instance in a shared placement group."},"GroupName":{"Type":4,"Flags":0,"Description":"The name of the placement group for the instance."},"HostId":{"Type":4,"Flags":0,"Description":"The ID of the Dedicated Host for the instance."},"HostResourceGroupArn":{"Type":4,"Flags":0,"Description":"The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host."},"PartitionNumber":{"Type":3,"Flags":0,"Description":"The number of the partition the instance should launch in. Valid only if the placement group strategy is set to partition."},"SpreadDomain":{"Type":4,"Flags":0,"Description":"Reserved for future use."},"Tenancy":{"Type":4,"Flags":0,"Description":"The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware."}}}},{"2":{"Name":"PrivateDnsNameOptions","Properties":{"EnableResourceNameDnsAAAARecord":{"Type":2,"Flags":0,"Description":"Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records."},"EnableResourceNameDnsARecord":{"Type":2,"Flags":0,"Description":"Indicates whether to respond to DNS queries for instance hostnames with DNS A records."},"HostnameType":{"Type":4,"Flags":0,"Description":"The type of hostname for EC2 instances."}}}},{"2":{"Name":"PrivateIpAdd","Properties":{"Primary":{"Type":2,"Flags":0,"Description":"Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary."},"PrivateIpAddress":{"Type":4,"Flags":0,"Description":"The private IPv4 address."}}}},{"2":{"Name":"SpotOptions","Properties":{"BlockDurationMinutes":{"Type":3,"Flags":0,"Description":"Deprecated"},"InstanceInterruptionBehavior":{"Type":4,"Flags":0,"Description":"The behavior when a Spot Instance is interrupted. The default is terminate."},"MaxPrice":{"Type":4,"Flags":0,"Description":"The maximum hourly price you're willing to pay for the Spot Instances."},"SpotInstanceType":{"Type":4,"Flags":0,"Description":"The Spot Instance request type."},"ValidUntil":{"Type":4,"Flags":0,"Description":"The end date of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ). Supported only for persistent requests."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"TagSpecification","Properties":{"ResourceType":{"Type":4,"Flags":0,"Description":"The type of resource to tag."},"Tags":{"Type":244,"Flags":0,"Description":"The tags for the resource."}}}},{"2":{"Name":"TotalLocalStorageGB","Properties":{"Max":{"Type":3,"Flags":0},"Min":{"Type":3,"Flags":0}}}},{"2":{"Name":"VCpuCount","Properties":{"Max":{"Type":3,"Flags":0,"Description":"The maximum number of vCPUs."},"Min":{"Type":3,"Flags":0,"Description":"The minimum number of vCPUs."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":184}},{"3":{"ItemType":191}},{"3":{"ItemType":203}},{"3":{"ItemType":205}},{"3":{"ItemType":212}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":219}},{"3":{"ItemType":218}},{"3":{"ItemType":4}},{"3":{"ItemType":199}},{"3":{"ItemType":200}},{"3":{"ItemType":201}},{"3":{"ItemType":216}},{"3":{"ItemType":218}},{"2":{"Name":"AWS.EC2/LaunchTemplateProperties","Properties":{"DefaultVersionNumber":{"Type":4,"Flags":2,"Description":"The default version of the launch template"},"LatestVersionNumber":{"Type":4,"Flags":2,"Description":"The latest version of the launch template"},"LaunchTemplateData":{"Type":202,"Flags":5},"LaunchTemplateId":{"Type":4,"Flags":18,"Description":"LaunchTemplate ID generated by service"},"LaunchTemplateName":{"Type":4,"Flags":0,"Description":"A name for the launch template."},"TagSpecifications":{"Type":246,"Flags":4,"Description":"The tags to apply to the launch template on creation."},"VersionDescription":{"Type":4,"Flags":4,"Description":"A description for the first version of the launch template."}}}},{"3":{"ItemType":204}},{"2":{"Name":"AWS.EC2/LaunchTemplate","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":245,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EC2/LaunchTemplate@default","ScopeType":0,"Body":247}},{"2":{"Name":"AWS.EC2/LocalGatewayRouteProperties","Properties":{"DestinationCidrBlock":{"Type":4,"Flags":17,"Description":"The CIDR block used for destination matches."},"LocalGatewayRouteTableId":{"Type":4,"Flags":17,"Description":"The ID of the local gateway route table."},"LocalGatewayVirtualInterfaceGroupId":{"Type":4,"Flags":0,"Description":"The ID of the virtual interface group."},"NetworkInterfaceId":{"Type":4,"Flags":0,"Description":"The ID of the network interface."},"State":{"Type":4,"Flags":2,"Description":"The state of the route."},"Type":{"Type":4,"Flags":2,"Description":"The route type."}}}},{"2":{"Name":"AWS.EC2/LocalGatewayRoute","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":249,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EC2/LocalGatewayRoute@default","ScopeType":0,"Body":250}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":0},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"Tags"}},{"3":{"ItemType":252}},{"2":{"Name":"AWS.EC2/LocalGatewayRouteTableProperties","Properties":{"LocalGatewayId":{"Type":4,"Flags":1,"Description":"The ID of the local gateway."},"LocalGatewayRouteTableArn":{"Type":4,"Flags":2,"Description":"The ARN of the local gateway route table."},"LocalGatewayRouteTableId":{"Type":4,"Flags":18,"Description":"The ID of the local gateway route table."},"Mode":{"Type":4,"Flags":0,"Description":"The mode of the local gateway route table."},"OutpostArn":{"Type":4,"Flags":2,"Description":"The ARN of the outpost."},"OwnerId":{"Type":4,"Flags":2,"Description":"The owner of the local gateway route table."},"State":{"Type":4,"Flags":2,"Description":"The state of the local gateway route table."},"Tags":{"Type":256,"Flags":0,"Description":"The tags for the local gateway route table."}}}},{"3":{"ItemType":252}},{"2":{"Name":"AWS.EC2/LocalGatewayRouteTable","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":255,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EC2/LocalGatewayRouteTable@default","ScopeType":0,"Body":257}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":0},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"Tags"}},{"3":{"ItemType":259}},{"2":{"Name":"AWS.EC2/LocalGatewayRouteTableVPCAssociationProperties","Properties":{"LocalGatewayId":{"Type":4,"Flags":2,"Description":"The ID of the local gateway."},"LocalGatewayRouteTableId":{"Type":4,"Flags":1,"Description":"The ID of the local gateway route table."},"LocalGatewayRouteTableVpcAssociationId":{"Type":4,"Flags":18,"Description":"The ID of the association."},"State":{"Type":4,"Flags":2,"Description":"The state of the association."},"Tags":{"Type":263,"Flags":0,"Description":"The tags for the association."},"VpcId":{"Type":4,"Flags":1,"Description":"The ID of the VPC."}}}},{"3":{"ItemType":259}},{"2":{"Name":"AWS.EC2/LocalGatewayRouteTableVPCAssociation","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":262,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EC2/LocalGatewayRouteTableVPCAssociation@default","ScopeType":0,"Body":264}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":0},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"Tags"}},{"3":{"ItemType":266}},{"2":{"Name":"AWS.EC2/LocalGatewayRouteTableVirtualInterfaceGroupAssociationProperties","Properties":{"LocalGatewayId":{"Type":4,"Flags":2,"Description":"The ID of the local gateway."},"LocalGatewayRouteTableArn":{"Type":4,"Flags":2,"Description":"The ARN of the local gateway route table."},"LocalGatewayRouteTableId":{"Type":4,"Flags":1,"Description":"The ID of the local gateway route table."},"LocalGatewayRouteTableVirtualInterfaceGroupAssociationId":{"Type":4,"Flags":18,"Description":"The ID of the local gateway route table virtual interface group association."},"LocalGatewayVirtualInterfaceGroupId":{"Type":4,"Flags":1,"Description":"The ID of the local gateway route table virtual interface group."},"OwnerId":{"Type":4,"Flags":2,"Description":"The owner of the local gateway route table virtual interface group association."},"State":{"Type":4,"Flags":2,"Description":"The state of the local gateway route table virtual interface group association."},"Tags":{"Type":270,"Flags":0,"Description":"The tags for the local gateway route table virtual interface group association."}}}},{"3":{"ItemType":266}},{"2":{"Name":"AWS.EC2/LocalGatewayRouteTableVirtualInterfaceGroupAssociation","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":269,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EC2/LocalGatewayRouteTableVirtualInterfaceGroupAssociation@default","ScopeType":0,"Body":271}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.EC2/NatGatewayProperties","Properties":{"AllocationId":{"Type":4,"Flags":0},"ConnectivityType":{"Type":4,"Flags":0},"MaxDrainDurationSeconds":{"Type":3,"Flags":4},"NatGatewayId":{"Type":4,"Flags":18},"PrivateIpAddress":{"Type":4,"Flags":0},"SecondaryAllocationIds":{"Type":275,"Flags":0},"SecondaryPrivateIpAddressCount":{"Type":3,"Flags":0},"SecondaryPrivateIpAddresses":{"Type":276,"Flags":0},"SubnetId":{"Type":4,"Flags":1},"Tags":{"Type":277,"Flags":0}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":273}},{"2":{"Name":"AWS.EC2/NatGateway","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":274,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EC2/NatGateway@default","ScopeType":0,"Body":278}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.EC2/NetworkAclProperties","Properties":{"Id":{"Type":4,"Flags":18},"Tags":{"Type":282,"Flags":0,"Description":"The tags to assign to the network ACL."},"VpcId":{"Type":4,"Flags":1,"Description":"The ID of the VPC."}}}},{"3":{"ItemType":280}},{"2":{"Name":"AWS.EC2/NetworkAcl","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":281,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EC2/NetworkAcl@default","ScopeType":0,"Body":283}},{"2":{"Name":"AccessScopePathRequest","Properties":{"Destination":{"Type":287,"Flags":0},"Source":{"Type":287,"Flags":0},"ThroughResources":{"Type":292,"Flags":0}}}},{"2":{"Name":"PacketHeaderStatementRequest","Properties":{"DestinationAddresses":{"Type":293,"Flags":0},"DestinationPorts":{"Type":294,"Flags":0},"DestinationPrefixLists":{"Type":295,"Flags":0},"Protocols":{"Type":296,"Flags":0},"SourceAddresses":{"Type":297,"Flags":0},"SourcePorts":{"Type":298,"Flags":0},"SourcePrefixLists":{"Type":299,"Flags":0}}}},{"2":{"Name":"PathStatementRequest","Properties":{"PacketHeaderStatement":{"Type":286,"Flags":0},"ResourceStatement":{"Type":289,"Flags":0}}}},{"2":{"Name":"Protocol"}},{"2":{"Name":"ResourceStatementRequest","Properties":{"ResourceTypes":{"Type":300,"Flags":0},"Resources":{"Type":301,"Flags":0}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"ThroughResourcesStatementRequest","Properties":{"ResourceStatement":{"Type":289,"Flags":0}}}},{"3":{"ItemType":291}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.EC2/NetworkInsightsAccessScopeProperties","Properties":{"CreatedDate":{"Type":4,"Flags":2},"ExcludePaths":{"Type":303,"Flags":4},"MatchPaths":{"Type":304,"Flags":4},"NetworkInsightsAccessScopeArn":{"Type":4,"Flags":2},"NetworkInsightsAccessScopeId":{"Type":4,"Flags":18},"Tags":{"Type":305,"Flags":0},"UpdatedDate":{"Type":4,"Flags":2}}}},{"3":{"ItemType":285}},{"3":{"ItemType":285}},{"3":{"ItemType":290}},{"2":{"Name":"AWS.EC2/NetworkInsightsAccessScope","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":302,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EC2/NetworkInsightsAccessScope@default","ScopeType":0,"Body":306}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"AWS.EC2/NetworkInsightsAccessScopeAnalysisProperties","Properties":{"AnalyzedEniCount":{"Type":3,"Flags":2},"EndDate":{"Type":4,"Flags":2},"FindingsFound":{"Type":4,"Flags":2},"NetworkInsightsAccessScopeAnalysisArn":{"Type":4,"Flags":2},"NetworkInsightsAccessScopeAnalysisId":{"Type":4,"Flags":18},"NetworkInsightsAccessScopeId":{"Type":4,"Flags":1},"StartDate":{"Type":4,"Flags":2},"Status":{"Type":4,"Flags":2},"StatusMessage":{"Type":4,"Flags":2},"Tags":{"Type":310,"Flags":0}}}},{"3":{"ItemType":308}},{"2":{"Name":"AWS.EC2/NetworkInsightsAccessScopeAnalysis","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":309,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EC2/NetworkInsightsAccessScopeAnalysis@default","ScopeType":0,"Body":311}},{"2":{"Name":"AdditionalDetail","Properties":{"AdditionalDetailType":{"Type":4,"Flags":0},"Component":{"Type":316,"Flags":0},"LoadBalancers":{"Type":332,"Flags":0},"ServiceName":{"Type":4,"Flags":0}}}},{"2":{"Name":"AlternatePathHint","Properties":{"ComponentArn":{"Type":4,"Flags":0},"ComponentId":{"Type":4,"Flags":0}}}},{"2":{"Name":"AnalysisAclRule","Properties":{"Cidr":{"Type":4,"Flags":0},"Egress":{"Type":2,"Flags":0},"PortRange":{"Type":326,"Flags":0},"Protocol":{"Type":4,"Flags":0},"RuleAction":{"Type":4,"Flags":0},"RuleNumber":{"Type":3,"Flags":0}}}},{"2":{"Name":"AnalysisComponent","Properties":{"Arn":{"Type":4,"Flags":0},"Id":{"Type":4,"Flags":0}}}},{"2":{"Name":"AnalysisLoadBalancerListener","Properties":{"InstancePort":{"Type":3,"Flags":0},"LoadBalancerPort":{"Type":3,"Flags":0}}}},{"2":{"Name":"AnalysisLoadBalancerTarget","Properties":{"Address":{"Type":4,"Flags":0},"AvailabilityZone":{"Type":4,"Flags":0},"Instance":{"Type":316,"Flags":0},"Port":{"Type":3,"Flags":0}}}},{"2":{"Name":"AnalysisPacketHeader","Properties":{"DestinationAddresses":{"Type":333,"Flags":0},"DestinationPortRanges":{"Type":334,"Flags":0},"Protocol":{"Type":4,"Flags":0},"SourceAddresses":{"Type":335,"Flags":0},"SourcePortRanges":{"Type":336,"Flags":0}}}},{"2":{"Name":"AnalysisRouteTableRoute","Properties":{"NatGatewayId":{"Type":4,"Flags":0},"NetworkInterfaceId":{"Type":4,"Flags":0},"Origin":{"Type":4,"Flags":0},"State":{"Type":4,"Flags":0},"TransitGatewayId":{"Type":4,"Flags":0},"VpcPeeringConnectionId":{"Type":4,"Flags":0},"destinationCidr":{"Type":4,"Flags":0},"destinationPrefixListId":{"Type":4,"Flags":0},"egressOnlyInternetGatewayId":{"Type":4,"Flags":0},"gatewayId":{"Type":4,"Flags":0},"instanceId":{"Type":4,"Flags":0}}}},{"2":{"Name":"AnalysisSecurityGroupRule","Properties":{"Cidr":{"Type":4,"Flags":0},"Direction":{"Type":4,"Flags":0},"PortRange":{"Type":326,"Flags":0},"PrefixListId":{"Type":4,"Flags":0},"Protocol":{"Type":4,"Flags":0},"SecurityGroupId":{"Type":4,"Flags":0}}}},{"2":{"Name":"Explanation","Properties":{"Acl":{"Type":316,"Flags":0},"AclRule":{"Type":315,"Flags":0},"Address":{"Type":4,"Flags":0},"Addresses":{"Type":337,"Flags":0},"AttachedTo":{"Type":316,"Flags":0},"AvailabilityZones":{"Type":338,"Flags":0},"Cidrs":{"Type":339,"Flags":0},"ClassicLoadBalancerListener":{"Type":317,"Flags":0},"Component":{"Type":316,"Flags":0},"ComponentAccount":{"Type":4,"Flags":0},"ComponentRegion":{"Type":4,"Flags":0},"CustomerGateway":{"Type":316,"Flags":0},"Destination":{"Type":316,"Flags":0},"DestinationVpc":{"Type":316,"Flags":0},"Direction":{"Type":4,"Flags":0},"ElasticLoadBalancerListener":{"Type":316,"Flags":0},"ExplanationCode":{"Type":4,"Flags":0},"IngressRouteTable":{"Type":316,"Flags":0},"InternetGateway":{"Type":316,"Flags":0},"LoadBalancerArn":{"Type":4,"Flags":0},"LoadBalancerListenerPort":{"Type":3,"Flags":0},"LoadBalancerTarget":{"Type":318,"Flags":0},"LoadBalancerTargetGroup":{"Type":316,"Flags":0},"LoadBalancerTargetGroups":{"Type":340,"Flags":0},"LoadBalancerTargetPort":{"Type":3,"Flags":0},"MissingComponent":{"Type":4,"Flags":0},"NatGateway":{"Type":316,"Flags":0},"NetworkInterface":{"Type":316,"Flags":0},"PacketField":{"Type":4,"Flags":0},"Port":{"Type":3,"Flags":0},"PortRanges":{"Type":341,"Flags":0},"PrefixList":{"Type":316,"Flags":0},"Protocols":{"Type":342,"Flags":0},"RouteTable":{"Type":316,"Flags":0},"RouteTableRoute":{"Type":320,"Flags":0},"SecurityGroup":{"Type":316,"Flags":0},"SecurityGroupRule":{"Type":321,"Flags":0},"SecurityGroups":{"Type":343,"Flags":0},"SourceVpc":{"Type":316,"Flags":0},"State":{"Type":4,"Flags":0},"Subnet":{"Type":316,"Flags":0},"SubnetRouteTable":{"Type":316,"Flags":0},"TransitGateway":{"Type":316,"Flags":0},"TransitGatewayAttachment":{"Type":316,"Flags":0},"TransitGatewayRouteTable":{"Type":316,"Flags":0},"TransitGatewayRouteTableRoute":{"Type":331,"Flags":0},"Vpc":{"Type":316,"Flags":0},"VpcPeeringConnection":{"Type":316,"Flags":0},"VpnConnection":{"Type":316,"Flags":0},"VpnGateway":{"Type":316,"Flags":0},"vpcEndpoint":{"Type":316,"Flags":0}}}},{"2":{"Name":"IpAddress"}},{"2":{"Name":"PathComponent","Properties":{"AclRule":{"Type":315,"Flags":0},"AdditionalDetails":{"Type":344,"Flags":0},"Component":{"Type":316,"Flags":0},"DestinationVpc":{"Type":316,"Flags":0},"ElasticLoadBalancerListener":{"Type":316,"Flags":0},"Explanations":{"Type":345,"Flags":0},"InboundHeader":{"Type":319,"Flags":0},"OutboundHeader":{"Type":319,"Flags":0},"RouteTableRoute":{"Type":320,"Flags":0},"SecurityGroupRule":{"Type":321,"Flags":0},"SequenceNumber":{"Type":3,"Flags":0},"ServiceName":{"Type":4,"Flags":0},"SourceVpc":{"Type":316,"Flags":0},"Subnet":{"Type":316,"Flags":0},"TransitGateway":{"Type":316,"Flags":0},"TransitGatewayRouteTableRoute":{"Type":331,"Flags":0},"Vpc":{"Type":316,"Flags":0}}}},{"2":{"Name":"Port"}},{"2":{"Name":"PortRange","Properties":{"From":{"Type":3,"Flags":0},"To":{"Type":3,"Flags":0}}}},{"2":{"Name":"Protocol"}},{"2":{"Name":"ResourceArn"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"Tags"}},{"2":{"Name":"TransitGatewayRouteTableRoute","Properties":{"AttachmentId":{"Type":4,"Flags":0},"DestinationCidr":{"Type":4,"Flags":0},"PrefixListId":{"Type":4,"Flags":0},"ResourceId":{"Type":4,"Flags":0},"ResourceType":{"Type":4,"Flags":0},"RouteOrigin":{"Type":4,"Flags":0},"State":{"Type":4,"Flags":0}}}},{"3":{"ItemType":316}},{"3":{"ItemType":4}},{"3":{"ItemType":326}},{"3":{"ItemType":4}},{"3":{"ItemType":326}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":316}},{"3":{"ItemType":326}},{"3":{"ItemType":4}},{"3":{"ItemType":316}},{"3":{"ItemType":313}},{"3":{"ItemType":322}},{"3":{"ItemType":329}},{"2":{"Name":"AWS.EC2/NetworkInsightsAnalysisProperties","Properties":{"AdditionalAccounts":{"Type":348,"Flags":0},"AlternatePathHints":{"Type":349,"Flags":2},"Explanations":{"Type":350,"Flags":2},"FilterInArns":{"Type":351,"Flags":0},"ForwardPathComponents":{"Type":352,"Flags":2},"NetworkInsightsAnalysisArn":{"Type":4,"Flags":2},"NetworkInsightsAnalysisId":{"Type":4,"Flags":18},"NetworkInsightsPathId":{"Type":4,"Flags":1},"NetworkPathFound":{"Type":2,"Flags":2},"ReturnPathComponents":{"Type":353,"Flags":2},"StartDate":{"Type":4,"Flags":2},"Status":{"Type":4,"Flags":2},"StatusMessage":{"Type":4,"Flags":2},"SuggestedAccounts":{"Type":354,"Flags":2},"Tags":{"Type":355,"Flags":0}}}},{"3":{"ItemType":4}},{"3":{"ItemType":314}},{"3":{"ItemType":322}},{"3":{"ItemType":4}},{"3":{"ItemType":324}},{"3":{"ItemType":324}},{"3":{"ItemType":4}},{"3":{"ItemType":329}},{"2":{"Name":"AWS.EC2/NetworkInsightsAnalysis","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":347,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EC2/NetworkInsightsAnalysis@default","ScopeType":0,"Body":356}},{"2":{"Name":"FilterPortRange","Properties":{"FromPort":{"Type":3,"Flags":0},"ToPort":{"Type":3,"Flags":0}}}},{"2":{"Name":"IpAddress"}},{"2":{"Name":"PathFilter","Properties":{"DestinationAddress":{"Type":4,"Flags":0},"DestinationPortRange":{"Type":358,"Flags":0},"SourceAddress":{"Type":4,"Flags":0},"SourcePortRange":{"Type":358,"Flags":0}}}},{"2":{"Name":"Port"}},{"2":{"Name":"Protocol"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"Tags"}},{"3":{"ItemType":363}},{"2":{"Name":"AWS.EC2/NetworkInsightsPathProperties","Properties":{"CreatedDate":{"Type":4,"Flags":2},"Destination":{"Type":4,"Flags":0},"DestinationArn":{"Type":4,"Flags":2},"DestinationIp":{"Type":4,"Flags":0},"DestinationPort":{"Type":3,"Flags":0},"FilterAtDestination":{"Type":360,"Flags":0},"FilterAtSource":{"Type":360,"Flags":0},"NetworkInsightsPathArn":{"Type":4,"Flags":2},"NetworkInsightsPathId":{"Type":4,"Flags":18},"Protocol":{"Type":4,"Flags":1},"Source":{"Type":4,"Flags":1},"SourceArn":{"Type":4,"Flags":2},"SourceIp":{"Type":4,"Flags":0},"Tags":{"Type":367,"Flags":0}}}},{"3":{"ItemType":363}},{"2":{"Name":"AWS.EC2/NetworkInsightsPath","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":366,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EC2/NetworkInsightsPath@default","ScopeType":0,"Body":368}},{"2":{"Name":"InstanceIpv6Address","Properties":{"Ipv6Address":{"Type":4,"Flags":1}}}},{"2":{"Name":"Ipv4PrefixSpecification","Properties":{"Ipv4Prefix":{"Type":4,"Flags":1}}}},{"2":{"Name":"Ipv6PrefixSpecification","Properties":{"Ipv6Prefix":{"Type":4,"Flags":1}}}},{"2":{"Name":"PrivateIpAddressSpecification","Properties":{"Primary":{"Type":2,"Flags":1},"PrivateIpAddress":{"Type":4,"Flags":1}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.EC2/NetworkInterfaceProperties","Properties":{"Description":{"Type":4,"Flags":0,"Description":"A description for the network interface."},"EnablePrimaryIpv6":{"Type":2,"Flags":0,"Description":"If you have instances or ENIs that rely on the IPv6 address not changing, to avoid disrupting traffic to instances or ENIs, you can enable a primary IPv6 address. Enable this option to automatically assign an IPv6 associated with the ENI attached to your instance to be the primary IPv6 address. When you enable an IPv6 address to be a primary IPv6, you cannot disable it. Traffic will be routed to the primary IPv6 address until the instance is terminated or the ENI is detached. If you have multiple IPv6 addresses associated with an ENI and you enable a primary IPv6 address, the first IPv6 address associated with the ENI becomes the primary IPv6 address."},"GroupSet":{"Type":376,"Flags":0,"Description":"A list of security group IDs associated with this network interface."},"Id":{"Type":4,"Flags":18,"Description":"Network interface id."},"InterfaceType":{"Type":4,"Flags":0,"Description":"Indicates the type of network interface."},"Ipv4PrefixCount":{"Type":3,"Flags":0,"Description":"The number of IPv4 prefixes to assign to a network interface. When you specify a number of IPv4 prefixes, Amazon EC2 selects these prefixes from your existing subnet CIDR reservations, if available, or from free spaces in the subnet. By default, these will be /28 prefixes. 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."},"Ipv4Prefixes":{"Type":377,"Flags":0,"Description":"Assigns a list of IPv4 prefixes to the network interface. If you want EC2 to automatically assign IPv4 prefixes, use the Ipv4PrefixCount property and do not specify this property. Presently, only /28 prefixes are supported. 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."},"Ipv6AddressCount":{"Type":3,"Flags":0,"Description":"The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. To specify specific IPv6 addresses, use the Ipv6Addresses property and don't specify this property."},"Ipv6Addresses":{"Type":378,"Flags":0,"Description":"One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet to associate with the network interface. If you're specifying a number of IPv6 addresses, use the Ipv6AddressCount property and don't specify this property."},"Ipv6PrefixCount":{"Type":3,"Flags":0,"Description":"The number of IPv6 prefixes to assign to a network interface. When you specify a number of IPv6 prefixes, Amazon EC2 selects these prefixes from your existing subnet CIDR reservations, if available, or from free spaces in the subnet. By default, these will be /80 prefixes. You can't specify a count of IPv6 prefixes if you've specified one of the following: specific IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses."},"Ipv6Prefixes":{"Type":379,"Flags":0,"Description":"Assigns a list of IPv6 prefixes to the network interface. If you want EC2 to automatically assign IPv6 prefixes, use the Ipv6PrefixCount property and do not specify this property. Presently, only /80 prefixes are supported. You can't specify IPv6 prefixes if you've specified one of the following: a count of IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses."},"PrimaryIpv6Address":{"Type":4,"Flags":2,"Description":"The primary IPv6 address"},"PrimaryPrivateIpAddress":{"Type":4,"Flags":2,"Description":"Returns the primary private IP address of the network interface."},"PrivateIpAddress":{"Type":4,"Flags":0,"Description":"Assigns a single private IP address to the network interface, which is used as the primary private IP address. If you want to specify multiple private IP address, use the PrivateIpAddresses property. "},"PrivateIpAddresses":{"Type":380,"Flags":0,"Description":"Assigns a list of private IP addresses to the network interface. You can specify a primary private IP address by setting the value of the Primary property to true in the PrivateIpAddressSpecification property. If you want EC2 to automatically assign private IP addresses, use the SecondaryPrivateIpAddressCount property and do not specify this property."},"SecondaryPrivateIpAddressCount":{"Type":3,"Flags":0,"Description":"The number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet's IPv4 CIDR range. You can't specify this option and specify more than one private IP address using privateIpAddresses"},"SecondaryPrivateIpAddresses":{"Type":381,"Flags":2,"Description":"Returns the secondary private IP addresses of the network interface."},"SourceDestCheck":{"Type":2,"Flags":0,"Description":"Indicates whether traffic to or from the instance is validated."},"SubnetId":{"Type":4,"Flags":1,"Description":"The ID of the subnet to associate with the network interface."},"Tags":{"Type":382,"Flags":0,"Description":"An arbitrary set of tags (key-value pairs) for this network interface."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":371}},{"3":{"ItemType":370}},{"3":{"ItemType":372}},{"3":{"ItemType":373}},{"3":{"ItemType":4}},{"3":{"ItemType":374}},{"2":{"Name":"AWS.EC2/NetworkInterface","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":375,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EC2/NetworkInterface@default","ScopeType":0,"Body":383}},{"2":{"Name":"AWS.EC2/NetworkInterfaceAttachmentProperties","Properties":{"AttachmentId":{"Type":4,"Flags":18,"Description":"The ID of the network interface attachment."},"DeleteOnTermination":{"Type":2,"Flags":0,"Description":"Whether to delete the network interface when the instance terminates. By default, this value is set to true."},"DeviceIndex":{"Type":4,"Flags":1,"Description":"The network interface's position in the attachment order. For example, the first attached network interface has a DeviceIndex of 0."},"InstanceId":{"Type":4,"Flags":1,"Description":"The ID of the instance to which you will attach the ENI."},"NetworkInterfaceId":{"Type":4,"Flags":1,"Description":"The ID of the ENI that you want to attach."}}}},{"2":{"Name":"AWS.EC2/NetworkInterfaceAttachment","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":385,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EC2/NetworkInterfaceAttachment@default","ScopeType":0,"Body":386}},{"2":{"Name":"Entry","Properties":{"Cidr":{"Type":4,"Flags":1},"Description":{"Type":4,"Flags":0}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"AWS.EC2/PrefixListProperties","Properties":{"AddressFamily":{"Type":4,"Flags":1,"Description":"Ip Version of Prefix List."},"Arn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) of the Prefix List."},"Entries":{"Type":391,"Flags":0,"Description":"Entries of Prefix List."},"MaxEntries":{"Type":3,"Flags":1,"Description":"Max Entries of Prefix List."},"OwnerId":{"Type":4,"Flags":2,"Description":"Owner Id of Prefix List."},"PrefixListId":{"Type":4,"Flags":18,"Description":"Id of Prefix List."},"PrefixListName":{"Type":4,"Flags":1,"Description":"Name of Prefix List."},"Tags":{"Type":392,"Flags":0,"Description":"Tags for Prefix List"},"Version":{"Type":3,"Flags":2,"Description":"Version of Prefix List."}}}},{"3":{"ItemType":388}},{"3":{"ItemType":389}},{"2":{"Name":"AWS.EC2/PrefixList","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":390,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EC2/PrefixList@default","ScopeType":0,"Body":393}},{"2":{"Name":"AWS.EC2/RouteProperties","Properties":{"CarrierGatewayId":{"Type":4,"Flags":0,"Description":"The ID of the carrier gateway."},"CidrBlock":{"Type":4,"Flags":18,"Description":"The primary identifier of the resource generated by the service."},"CoreNetworkArn":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) of the core network."},"DestinationCidrBlock":{"Type":4,"Flags":0,"Description":"The IPv4 CIDR block used for the destination match."},"DestinationIpv6CidrBlock":{"Type":4,"Flags":0,"Description":"The IPv6 CIDR block used for the destination match."},"DestinationPrefixListId":{"Type":4,"Flags":0,"Description":"The ID of managed prefix list, it's a set of one or more CIDR blocks."},"EgressOnlyInternetGatewayId":{"Type":4,"Flags":0,"Description":"The ID of the egress-only internet gateway."},"GatewayId":{"Type":4,"Flags":0,"Description":"The ID of an internet gateway or virtual private gateway attached to your VPC."},"InstanceId":{"Type":4,"Flags":0,"Description":"The ID of a NAT instance in your VPC."},"LocalGatewayId":{"Type":4,"Flags":0,"Description":"The ID of the local gateway."},"NatGatewayId":{"Type":4,"Flags":0,"Description":"The ID of a NAT gateway."},"NetworkInterfaceId":{"Type":4,"Flags":0,"Description":"The ID of the network interface."},"RouteTableId":{"Type":4,"Flags":17,"Description":"The ID of the route table. The routing table must be associated with the same VPC that the virtual private gateway is attached to."},"TransitGatewayId":{"Type":4,"Flags":0,"Description":"The ID of a transit gateway."},"VpcEndpointId":{"Type":4,"Flags":0,"Description":"The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only."},"VpcPeeringConnectionId":{"Type":4,"Flags":0,"Description":"The ID of a VPC peering connection."}}}},{"2":{"Name":"AWS.EC2/Route","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":395,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EC2/Route@default","ScopeType":0,"Body":396}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.EC2/RouteTableProperties","Properties":{"RouteTableId":{"Type":4,"Flags":18,"Description":"The route table ID."},"Tags":{"Type":400,"Flags":0,"Description":"Any tags assigned to the route table."},"VpcId":{"Type":4,"Flags":1,"Description":"The ID of the VPC."}}}},{"3":{"ItemType":398}},{"2":{"Name":"AWS.EC2/RouteTable","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":399,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EC2/RouteTable@default","ScopeType":0,"Body":401}},{"2":{"Name":"Egress","Properties":{"CidrIp":{"Type":4,"Flags":0},"CidrIpv6":{"Type":4,"Flags":0},"Description":{"Type":4,"Flags":0},"DestinationPrefixListId":{"Type":4,"Flags":0},"DestinationSecurityGroupId":{"Type":4,"Flags":0},"FromPort":{"Type":3,"Flags":0},"IpProtocol":{"Type":4,"Flags":1},"ToPort":{"Type":3,"Flags":0}}}},{"2":{"Name":"Ingress","Properties":{"CidrIp":{"Type":4,"Flags":0},"CidrIpv6":{"Type":4,"Flags":0},"Description":{"Type":4,"Flags":0},"FromPort":{"Type":3,"Flags":0},"IpProtocol":{"Type":4,"Flags":1},"SourcePrefixListId":{"Type":4,"Flags":0},"SourceSecurityGroupId":{"Type":4,"Flags":0},"SourceSecurityGroupName":{"Type":4,"Flags":0},"SourceSecurityGroupOwnerId":{"Type":4,"Flags":0},"ToPort":{"Type":3,"Flags":0}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.EC2/SecurityGroupProperties","Properties":{"GroupDescription":{"Type":4,"Flags":1},"GroupId":{"Type":4,"Flags":2},"GroupName":{"Type":4,"Flags":0},"Id":{"Type":4,"Flags":18},"SecurityGroupEgress":{"Type":407,"Flags":0},"SecurityGroupIngress":{"Type":408,"Flags":0},"Tags":{"Type":409,"Flags":0},"VpcId":{"Type":4,"Flags":0}}}},{"3":{"ItemType":403}},{"3":{"ItemType":404}},{"3":{"ItemType":405}},{"2":{"Name":"AWS.EC2/SecurityGroup","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":406,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EC2/SecurityGroup@default","ScopeType":0,"Body":410}},{"2":{"Name":"AWS.EC2/SecurityGroupEgressProperties","Properties":{"CidrIp":{"Type":4,"Flags":0,"Description":"The IPv4 ranges"},"CidrIpv6":{"Type":4,"Flags":0,"Description":"[VPC only] The IPv6 ranges"},"Description":{"Type":4,"Flags":0,"Description":"Resource Type definition for an egress (outbound) security group rule."},"DestinationPrefixListId":{"Type":4,"Flags":0,"Description":"[EC2-VPC only] The ID of a prefix list."},"DestinationSecurityGroupId":{"Type":4,"Flags":0,"Description":"You must specify a destination security group (DestinationPrefixListId or DestinationSecurityGroupId) or a CIDR range (CidrIp or CidrIpv6)."},"FromPort":{"Type":3,"Flags":0,"Description":"The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes."},"GroupId":{"Type":4,"Flags":1,"Description":"The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID."},"Id":{"Type":4,"Flags":18,"Description":"The Security Group Rule Id"},"IpProtocol":{"Type":4,"Flags":1,"Description":"[VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp, udp, and icmp, you must specify a port range. For icmpv6, the port range is optional; if you omit the port range, traffic for all types and codes is allowed."},"ToPort":{"Type":3,"Flags":0,"Description":"The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes."}}}},{"2":{"Name":"AWS.EC2/SecurityGroupEgress","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":412,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EC2/SecurityGroupEgress@default","ScopeType":0,"Body":413}},{"2":{"Name":"AWS.EC2/SnapshotBlockPublicAccessProperties","Properties":{"AccountId":{"Type":4,"Flags":18,"Description":"The identifier for the specified AWS account."},"State":{"Type":4,"Flags":1,"Description":"The state of EBS Snapshot Block Public Access."}}}},{"2":{"Name":"AWS.EC2/SnapshotBlockPublicAccess","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":415,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EC2/SnapshotBlockPublicAccess@default","ScopeType":0,"Body":416}},{"2":{"Name":"AcceleratorCountRequest","Properties":{"Max":{"Type":3,"Flags":0},"Min":{"Type":3,"Flags":0}}}},{"2":{"Name":"AcceleratorTotalMemoryMiBRequest","Properties":{"Max":{"Type":3,"Flags":0},"Min":{"Type":3,"Flags":0}}}},{"2":{"Name":"BaselineEbsBandwidthMbpsRequest","Properties":{"Max":{"Type":3,"Flags":0},"Min":{"Type":3,"Flags":0}}}},{"2":{"Name":"BlockDeviceMapping","Properties":{"DeviceName":{"Type":4,"Flags":1},"Ebs":{"Type":424,"Flags":0},"NoDevice":{"Type":4,"Flags":0},"VirtualName":{"Type":4,"Flags":0}}}},{"2":{"Name":"ClassicLoadBalancer","Properties":{"Name":{"Type":4,"Flags":1}}}},{"2":{"Name":"ClassicLoadBalancersConfig","Properties":{"ClassicLoadBalancers":{"Type":451,"Flags":1}}}},{"2":{"Name":"EbsBlockDevice","Properties":{"DeleteOnTermination":{"Type":2,"Flags":0},"Encrypted":{"Type":2,"Flags":0},"Iops":{"Type":3,"Flags":0},"SnapshotId":{"Type":4,"Flags":0},"VolumeSize":{"Type":3,"Flags":0},"VolumeType":{"Type":4,"Flags":0}}}},{"2":{"Name":"FleetLaunchTemplateSpecification","Properties":{"LaunchTemplateId":{"Type":4,"Flags":0},"LaunchTemplateName":{"Type":4,"Flags":0},"Version":{"Type":4,"Flags":1}}}},{"2":{"Name":"GroupIdentifier","Properties":{"GroupId":{"Type":4,"Flags":1}}}},{"2":{"Name":"IamInstanceProfileSpecification","Properties":{"Arn":{"Type":4,"Flags":0}}}},{"2":{"Name":"InstanceIpv6Address","Properties":{"Ipv6Address":{"Type":4,"Flags":1}}}},{"2":{"Name":"InstanceNetworkInterfaceSpecification","Properties":{"AssociatePublicIpAddress":{"Type":2,"Flags":0},"DeleteOnTermination":{"Type":2,"Flags":0},"Description":{"Type":4,"Flags":0},"DeviceIndex":{"Type":3,"Flags":0},"Groups":{"Type":452,"Flags":0},"Ipv6AddressCount":{"Type":3,"Flags":0},"Ipv6Addresses":{"Type":453,"Flags":0},"NetworkInterfaceId":{"Type":4,"Flags":0},"PrivateIpAddresses":{"Type":454,"Flags":0},"SecondaryPrivateIpAddressCount":{"Type":3,"Flags":0},"SubnetId":{"Type":4,"Flags":0}}}},{"2":{"Name":"InstanceRequirementsRequest","Properties":{"AcceleratorCount":{"Type":418,"Flags":0},"AcceleratorManufacturers":{"Type":455,"Flags":0},"AcceleratorNames":{"Type":456,"Flags":0},"AcceleratorTotalMemoryMiB":{"Type":419,"Flags":0},"AcceleratorTypes":{"Type":457,"Flags":0},"AllowedInstanceTypes":{"Type":458,"Flags":0},"BareMetal":{"Type":4,"Flags":0},"BaselineEbsBandwidthMbps":{"Type":420,"Flags":0},"BurstablePerformance":{"Type":4,"Flags":0},"CpuManufacturers":{"Type":459,"Flags":0},"ExcludedInstanceTypes":{"Type":460,"Flags":0},"InstanceGenerations":{"Type":461,"Flags":0},"LocalStorage":{"Type":4,"Flags":0},"LocalStorageTypes":{"Type":462,"Flags":0},"MemoryGiBPerVCpu":{"Type":434,"Flags":0},"MemoryMiB":{"Type":435,"Flags":0},"NetworkBandwidthGbps":{"Type":436,"Flags":0},"NetworkInterfaceCount":{"Type":437,"Flags":0},"OnDemandMaxPricePercentageOverLowestPrice":{"Type":3,"Flags":0},"RequireHibernateSupport":{"Type":2,"Flags":0},"SpotMaxPricePercentageOverLowestPrice":{"Type":3,"Flags":0},"TotalLocalStorageGB":{"Type":449,"Flags":0},"VCpuCount":{"Type":450,"Flags":0}}}},{"2":{"Name":"LaunchTemplateConfig","Properties":{"LaunchTemplateSpecification":{"Type":425,"Flags":0},"Overrides":{"Type":463,"Flags":0}}}},{"2":{"Name":"LaunchTemplateOverrides","Properties":{"AvailabilityZone":{"Type":4,"Flags":0},"InstanceRequirements":{"Type":430,"Flags":0},"InstanceType":{"Type":4,"Flags":0},"Priority":{"Type":3,"Flags":0},"SpotPrice":{"Type":4,"Flags":0},"SubnetId":{"Type":4,"Flags":0},"WeightedCapacity":{"Type":3,"Flags":0}}}},{"2":{"Name":"LoadBalancersConfig","Properties":{"ClassicLoadBalancersConfig":{"Type":423,"Flags":0},"TargetGroupsConfig":{"Type":448,"Flags":0}}}},{"2":{"Name":"MemoryGiBPerVCpuRequest","Properties":{"Max":{"Type":3,"Flags":0},"Min":{"Type":3,"Flags":0}}}},{"2":{"Name":"MemoryMiBRequest","Properties":{"Max":{"Type":3,"Flags":0},"Min":{"Type":3,"Flags":0}}}},{"2":{"Name":"NetworkBandwidthGbpsRequest","Properties":{"Max":{"Type":3,"Flags":0},"Min":{"Type":3,"Flags":0}}}},{"2":{"Name":"NetworkInterfaceCountRequest","Properties":{"Max":{"Type":3,"Flags":0},"Min":{"Type":3,"Flags":0}}}},{"2":{"Name":"PrivateIpAddressSpecification","Properties":{"Primary":{"Type":2,"Flags":0},"PrivateIpAddress":{"Type":4,"Flags":1}}}},{"2":{"Name":"SpotCapacityRebalance","Properties":{"ReplacementStrategy":{"Type":4,"Flags":0},"TerminationDelay":{"Type":3,"Flags":0}}}},{"2":{"Name":"SpotFleetLaunchSpecification","Properties":{"BlockDeviceMappings":{"Type":464,"Flags":0},"EbsOptimized":{"Type":2,"Flags":0},"IamInstanceProfile":{"Type":427,"Flags":0},"ImageId":{"Type":4,"Flags":1},"InstanceRequirements":{"Type":430,"Flags":0},"InstanceType":{"Type":4,"Flags":0},"KernelId":{"Type":4,"Flags":0},"KeyName":{"Type":4,"Flags":0},"Monitoring":{"Type":441,"Flags":0},"NetworkInterfaces":{"Type":465,"Flags":0},"Placement":{"Type":445,"Flags":0},"RamdiskId":{"Type":4,"Flags":0},"SecurityGroups":{"Type":466,"Flags":0},"SpotPrice":{"Type":4,"Flags":0},"SubnetId":{"Type":4,"Flags":0},"TagSpecifications":{"Type":467,"Flags":0},"UserData":{"Type":4,"Flags":0},"WeightedCapacity":{"Type":3,"Flags":0}}}},{"2":{"Name":"SpotFleetMonitoring","Properties":{"Enabled":{"Type":2,"Flags":0}}}},{"2":{"Name":"SpotFleetRequestConfigData","Properties":{"AllocationStrategy":{"Type":4,"Flags":0},"Context":{"Type":4,"Flags":0},"ExcessCapacityTerminationPolicy":{"Type":4,"Flags":0},"IamFleetRole":{"Type":4,"Flags":1},"InstanceInterruptionBehavior":{"Type":4,"Flags":0},"InstancePoolsToUseCount":{"Type":3,"Flags":0},"LaunchSpecifications":{"Type":468,"Flags":4},"LaunchTemplateConfigs":{"Type":469,"Flags":0},"LoadBalancersConfig":{"Type":433,"Flags":0},"OnDemandAllocationStrategy":{"Type":4,"Flags":0},"OnDemandMaxTotalPrice":{"Type":4,"Flags":0},"OnDemandTargetCapacity":{"Type":3,"Flags":0},"ReplaceUnhealthyInstances":{"Type":2,"Flags":0},"SpotMaintenanceStrategies":{"Type":444,"Flags":0},"SpotMaxTotalPrice":{"Type":4,"Flags":0},"SpotPrice":{"Type":4,"Flags":0},"TagSpecifications":{"Type":470,"Flags":4},"TargetCapacity":{"Type":3,"Flags":1},"TargetCapacityUnitType":{"Type":4,"Flags":0},"TerminateInstancesWithExpiration":{"Type":2,"Flags":0},"Type":{"Type":4,"Flags":0},"ValidFrom":{"Type":4,"Flags":0},"ValidUntil":{"Type":4,"Flags":0}}}},{"2":{"Name":"SpotFleetTagSpecification","Properties":{"ResourceType":{"Type":4,"Flags":0},"Tags":{"Type":471,"Flags":0}}}},{"2":{"Name":"SpotMaintenanceStrategies","Properties":{"CapacityRebalance":{"Type":439,"Flags":0}}}},{"2":{"Name":"SpotPlacement","Properties":{"AvailabilityZone":{"Type":4,"Flags":0},"GroupName":{"Type":4,"Flags":0},"Tenancy":{"Type":4,"Flags":0}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"TargetGroup","Properties":{"Arn":{"Type":4,"Flags":1}}}},{"2":{"Name":"TargetGroupsConfig","Properties":{"TargetGroups":{"Type":472,"Flags":1}}}},{"2":{"Name":"TotalLocalStorageGBRequest","Properties":{"Max":{"Type":3,"Flags":0},"Min":{"Type":3,"Flags":0}}}},{"2":{"Name":"VCpuCountRangeRequest","Properties":{"Max":{"Type":3,"Flags":0},"Min":{"Type":3,"Flags":0}}}},{"3":{"ItemType":422}},{"3":{"ItemType":4}},{"3":{"ItemType":428}},{"3":{"ItemType":438}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":432}},{"3":{"ItemType":421}},{"3":{"ItemType":429}},{"3":{"ItemType":426}},{"3":{"ItemType":443}},{"3":{"ItemType":440}},{"3":{"ItemType":431}},{"3":{"ItemType":443}},{"3":{"ItemType":446}},{"3":{"ItemType":447}},{"2":{"Name":"AWS.EC2/SpotFleetProperties","Properties":{"Id":{"Type":4,"Flags":18},"SpotFleetRequestConfigData":{"Type":442,"Flags":1}}}},{"2":{"Name":"AWS.EC2/SpotFleet","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":473,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EC2/SpotFleet@default","ScopeType":0,"Body":474}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.EC2/SubnetProperties","Properties":{"AssignIpv6AddressOnCreation":{"Type":2,"Flags":0},"AvailabilityZone":{"Type":4,"Flags":0},"AvailabilityZoneId":{"Type":4,"Flags":0},"CidrBlock":{"Type":4,"Flags":0},"EnableDns64":{"Type":2,"Flags":0},"Ipv4IpamPoolId":{"Type":4,"Flags":4,"Description":"The ID of an IPv4 IPAM pool you want to use for allocating this subnet's CIDR"},"Ipv4NetmaskLength":{"Type":3,"Flags":4,"Description":"The netmask length of the IPv4 CIDR you want to allocate to this subnet from an Amazon VPC IP Address Manager (IPAM) pool"},"Ipv6CidrBlock":{"Type":4,"Flags":0},"Ipv6CidrBlocks":{"Type":478,"Flags":0},"Ipv6IpamPoolId":{"Type":4,"Flags":4,"Description":"The ID of an IPv6 IPAM pool you want to use for allocating this subnet's CIDR"},"Ipv6Native":{"Type":2,"Flags":0},"Ipv6NetmaskLength":{"Type":3,"Flags":4,"Description":"The netmask length of the IPv6 CIDR you want to allocate to this subnet from an Amazon VPC IP Address Manager (IPAM) pool"},"MapPublicIpOnLaunch":{"Type":2,"Flags":0},"NetworkAclAssociationId":{"Type":4,"Flags":2},"OutpostArn":{"Type":4,"Flags":0},"PrivateDnsNameOptionsOnLaunch":{"Type":479,"Flags":0},"SubnetId":{"Type":4,"Flags":18},"Tags":{"Type":480,"Flags":0},"VpcId":{"Type":4,"Flags":1}}}},{"3":{"ItemType":4}},{"2":{"Name":"Subnet_PrivateDnsNameOptionsOnLaunch","Properties":{"EnableResourceNameDnsAAAARecord":{"Type":2,"Flags":0},"EnableResourceNameDnsARecord":{"Type":2,"Flags":0},"HostnameType":{"Type":4,"Flags":0}}}},{"3":{"ItemType":476}},{"2":{"Name":"AWS.EC2/Subnet","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":477,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EC2/Subnet@default","ScopeType":0,"Body":481}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.EC2/TransitGatewayProperties","Properties":{"AmazonSideAsn":{"Type":3,"Flags":0},"AssociationDefaultRouteTableId":{"Type":4,"Flags":0},"AutoAcceptSharedAttachments":{"Type":4,"Flags":0},"DefaultRouteTableAssociation":{"Type":4,"Flags":0},"DefaultRouteTablePropagation":{"Type":4,"Flags":0},"Description":{"Type":4,"Flags":0},"DnsSupport":{"Type":4,"Flags":0},"Id":{"Type":4,"Flags":18},"MulticastSupport":{"Type":4,"Flags":0},"PropagationDefaultRouteTableId":{"Type":4,"Flags":0},"Tags":{"Type":485,"Flags":0},"TransitGatewayArn":{"Type":4,"Flags":2},"TransitGatewayCidrBlocks":{"Type":486,"Flags":0},"VpnEcmpSupport":{"Type":4,"Flags":0}}}},{"3":{"ItemType":483}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.EC2/TransitGateway","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":484,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EC2/TransitGateway@default","ScopeType":0,"Body":487}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.EC2/TransitGatewayAttachmentProperties","Properties":{"Id":{"Type":4,"Flags":18},"Options":{"Type":491,"Flags":0,"Description":"The options for the transit gateway vpc attachment."},"SubnetIds":{"Type":492,"Flags":1},"Tags":{"Type":493,"Flags":0},"TransitGatewayId":{"Type":4,"Flags":1},"VpcId":{"Type":4,"Flags":1}}}},{"2":{"Name":"TransitGatewayAttachment_Options","Properties":{"ApplianceModeSupport":{"Type":4,"Flags":0,"Description":"Indicates whether to enable Ipv6 Support for Vpc Attachment. Valid Values: enable | disable"},"DnsSupport":{"Type":4,"Flags":0,"Description":"Indicates whether to enable DNS Support for Vpc Attachment. Valid Values: enable | disable"},"Ipv6Support":{"Type":4,"Flags":0,"Description":"Indicates whether to enable Ipv6 Support for Vpc Attachment. Valid Values: enable | disable"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":489}},{"2":{"Name":"AWS.EC2/TransitGatewayAttachment","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":490,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EC2/TransitGatewayAttachment@default","ScopeType":0,"Body":494}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":0,"Description":"The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:."},"Value":{"Type":4,"Flags":0,"Description":"The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters."}}}},{"2":{"Name":"TransitGatewayConnectOptions","Properties":{"Protocol":{"Type":4,"Flags":0,"Description":"The tunnel protocol."}}}},{"2":{"Name":"AWS.EC2/TransitGatewayConnectProperties","Properties":{"CreationTime":{"Type":4,"Flags":2,"Description":"The creation time."},"Options":{"Type":497,"Flags":1,"Description":"The Connect attachment options."},"State":{"Type":4,"Flags":2,"Description":"The state of the attachment."},"Tags":{"Type":499,"Flags":0,"Description":"The tags for the attachment."},"TransitGatewayAttachmentId":{"Type":4,"Flags":18,"Description":"The ID of the Connect attachment."},"TransitGatewayId":{"Type":4,"Flags":2,"Description":"The ID of the transit gateway."},"TransportTransitGatewayAttachmentId":{"Type":4,"Flags":1,"Description":"The ID of the attachment from which the Connect attachment was created."}}}},{"3":{"ItemType":496}},{"2":{"Name":"AWS.EC2/TransitGatewayConnect","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":498,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EC2/TransitGatewayConnect@default","ScopeType":0,"Body":500}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":0,"Description":"The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:."},"Value":{"Type":4,"Flags":0,"Description":"The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters."}}}},{"2":{"Name":"AWS.EC2/TransitGatewayMulticastDomainProperties","Properties":{"CreationTime":{"Type":4,"Flags":2,"Description":"The time the transit gateway multicast domain was created."},"Options":{"Type":504,"Flags":0,"Description":"The options for the transit gateway multicast domain."},"State":{"Type":4,"Flags":2,"Description":"The state of the transit gateway multicast domain."},"Tags":{"Type":505,"Flags":0,"Description":"The tags for the transit gateway multicast domain."},"TransitGatewayId":{"Type":4,"Flags":1,"Description":"The ID of the transit gateway."},"TransitGatewayMulticastDomainArn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) of the transit gateway multicast domain."},"TransitGatewayMulticastDomainId":{"Type":4,"Flags":18,"Description":"The ID of the transit gateway multicast domain."}}}},{"2":{"Name":"TransitGatewayMulticastDomain_Options","Properties":{"AutoAcceptSharedAssociations":{"Type":4,"Flags":0,"Description":"Indicates whether to automatically cross-account subnet associations that are associated with the transit gateway multicast domain. Valid Values: enable | disable"},"Igmpv2Support":{"Type":4,"Flags":0,"Description":"Indicates whether Internet Group Management Protocol (IGMP) version 2 is turned on for the transit gateway multicast domain. Valid Values: enable | disable"},"StaticSourcesSupport":{"Type":4,"Flags":0,"Description":"Indicates whether support for statically configuring transit gateway multicast group sources is turned on. Valid Values: enable | disable"}}}},{"3":{"ItemType":502}},{"2":{"Name":"AWS.EC2/TransitGatewayMulticastDomain","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":503,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EC2/TransitGatewayMulticastDomain@default","ScopeType":0,"Body":506}},{"2":{"Name":"PeeringAttachmentStatus","Properties":{"Code":{"Type":4,"Flags":0,"Description":"The status code."},"Message":{"Type":4,"Flags":0,"Description":"The status message, if applicable."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":0,"Description":"The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:."},"Value":{"Type":4,"Flags":0,"Description":"The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters."}}}},{"2":{"Name":"AWS.EC2/TransitGatewayPeeringAttachmentProperties","Properties":{"CreationTime":{"Type":4,"Flags":2,"Description":"The time the transit gateway peering attachment was created."},"PeerAccountId":{"Type":4,"Flags":1,"Description":"The ID of the peer account"},"PeerRegion":{"Type":4,"Flags":1,"Description":"Peer Region"},"PeerTransitGatewayId":{"Type":4,"Flags":1,"Description":"The ID of the peer transit gateway."},"State":{"Type":4,"Flags":2,"Description":"The state of the transit gateway peering attachment. Note that the initiating state has been deprecated."},"Status":{"Type":508,"Flags":2,"Description":"The status of the transit gateway peering attachment."},"Tags":{"Type":511,"Flags":0,"Description":"The tags for the transit gateway peering attachment."},"TransitGatewayAttachmentId":{"Type":4,"Flags":18,"Description":"The ID of the transit gateway peering attachment."},"TransitGatewayId":{"Type":4,"Flags":1,"Description":"The ID of the transit gateway."}}}},{"3":{"ItemType":509}},{"2":{"Name":"AWS.EC2/TransitGatewayPeeringAttachment","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":510,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EC2/TransitGatewayPeeringAttachment@default","ScopeType":0,"Body":512}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.EC2/TransitGatewayVpcAttachmentProperties","Properties":{"AddSubnetIds":{"Type":516,"Flags":4},"Id":{"Type":4,"Flags":18},"Options":{"Type":517,"Flags":0,"Description":"The options for the transit gateway vpc attachment."},"RemoveSubnetIds":{"Type":518,"Flags":4},"SubnetIds":{"Type":519,"Flags":1},"Tags":{"Type":520,"Flags":0},"TransitGatewayId":{"Type":4,"Flags":1},"VpcId":{"Type":4,"Flags":1}}}},{"3":{"ItemType":4}},{"2":{"Name":"TransitGatewayVpcAttachment_Options","Properties":{"ApplianceModeSupport":{"Type":4,"Flags":0,"Description":"Indicates whether to enable Ipv6 Support for Vpc Attachment. Valid Values: enable | disable"},"DnsSupport":{"Type":4,"Flags":0,"Description":"Indicates whether to enable DNS Support for Vpc Attachment. Valid Values: enable | disable"},"Ipv6Support":{"Type":4,"Flags":0,"Description":"Indicates whether to enable Ipv6 Support for Vpc Attachment. Valid Values: enable | disable"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":514}},{"2":{"Name":"AWS.EC2/TransitGatewayVpcAttachment","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":515,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EC2/TransitGatewayVpcAttachment@default","ScopeType":0,"Body":521}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.EC2/VPCProperties","Properties":{"CidrBlock":{"Type":4,"Flags":0,"Description":"The primary IPv4 CIDR block for the VPC."},"CidrBlockAssociations":{"Type":525,"Flags":2,"Description":"A list of IPv4 CIDR block association IDs for the VPC."},"DefaultNetworkAcl":{"Type":4,"Flags":2,"Description":"The default network ACL ID that is associated with the VPC."},"DefaultSecurityGroup":{"Type":4,"Flags":2,"Description":"The default security group ID that is associated with the VPC."},"EnableDnsHostnames":{"Type":2,"Flags":0,"Description":"Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not. Disabled by default for nondefault VPCs."},"EnableDnsSupport":{"Type":2,"Flags":0,"Description":"Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range \"plus two\" succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled. Enabled by default."},"InstanceTenancy":{"Type":4,"Flags":0,"Description":"The allowed tenancy of instances launched into the VPC.\n\n\"default\": An instance launched into the VPC runs on shared hardware by default, unless you explicitly specify a different tenancy during instance launch.\n\n\"dedicated\": An instance launched into the VPC is a Dedicated Instance by default, unless you explicitly specify a tenancy of host during instance launch. You cannot specify a tenancy of default during instance launch.\n\nUpdating InstanceTenancy requires no replacement only if you are updating its value from \"dedicated\" to \"default\". Updating InstanceTenancy from \"default\" to \"dedicated\" requires replacement."},"Ipv4IpamPoolId":{"Type":4,"Flags":4,"Description":"The ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR"},"Ipv4NetmaskLength":{"Type":3,"Flags":4,"Description":"The netmask length of the IPv4 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool"},"Ipv6CidrBlocks":{"Type":526,"Flags":2,"Description":"A list of IPv6 CIDR blocks that are associated with the VPC."},"Tags":{"Type":527,"Flags":0,"Description":"The tags for the VPC."},"VpcId":{"Type":4,"Flags":18,"Description":"The Id for the model."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":523}},{"2":{"Name":"AWS.EC2/VPC","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":524,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EC2/VPC@default","ScopeType":0,"Body":528}},{"2":{"Name":"AWS.EC2/VPCDHCPOptionsAssociationProperties","Properties":{"DhcpOptionsId":{"Type":4,"Flags":17,"Description":"The ID of the DHCP options set, or default to associate no DHCP options with the VPC."},"VpcId":{"Type":4,"Flags":17,"Description":"The ID of the VPC."}}}},{"2":{"Name":"AWS.EC2/VPCDHCPOptionsAssociation","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":530,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EC2/VPCDHCPOptionsAssociation@default","ScopeType":0,"Body":531}},{"2":{"Name":"AWS.EC2/VPCEndpointProperties","Properties":{"CreationTimestamp":{"Type":4,"Flags":2},"DnsEntries":{"Type":534,"Flags":2},"Id":{"Type":4,"Flags":18},"NetworkInterfaceIds":{"Type":535,"Flags":2},"PolicyDocument":{"Type":537,"Flags":0,"Description":"A policy to attach to the endpoint that controls access to the service."},"PrivateDnsEnabled":{"Type":2,"Flags":0,"Description":"Indicate whether to associate a private hosted zone with the specified VPC."},"RouteTableIds":{"Type":538,"Flags":0,"Description":"One or more route table IDs."},"SecurityGroupIds":{"Type":539,"Flags":0,"Description":"The ID of one or more security groups to associate with the endpoint network interface."},"ServiceName":{"Type":4,"Flags":1,"Description":"The service name."},"SubnetIds":{"Type":540,"Flags":0,"Description":"The ID of one or more subnets in which to create an endpoint network interface."},"VpcEndpointType":{"Type":4,"Flags":0},"VpcId":{"Type":4,"Flags":1,"Description":"The ID of the VPC in which the endpoint will be used."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"VPCEndpoint_PolicyDocument","Properties":{}}},{"5":{"Elements":[4,536]}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.EC2/VPCEndpoint","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":533,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EC2/VPCEndpoint@default","ScopeType":0,"Body":541}},{"2":{"Name":"AWS.EC2/VPCEndpointConnectionNotificationProperties","Properties":{"ConnectionEvents":{"Type":544,"Flags":1,"Description":"The endpoint events for which to receive notifications."},"ConnectionNotificationArn":{"Type":4,"Flags":1,"Description":"The ARN of the SNS topic for the notifications."},"ServiceId":{"Type":4,"Flags":0,"Description":"The ID of the endpoint service."},"VPCEndpointConnectionNotificationId":{"Type":4,"Flags":18,"Description":"VPC Endpoint Connection ID generated by service"},"VPCEndpointId":{"Type":4,"Flags":0,"Description":"The ID of the endpoint."}}}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.EC2/VPCEndpointConnectionNotification","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":543,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EC2/VPCEndpointConnectionNotification@default","ScopeType":0,"Body":545}},{"2":{"Name":"AWS.EC2/VPCEndpointServiceProperties","Properties":{"AcceptanceRequired":{"Type":2,"Flags":0},"ContributorInsightsEnabled":{"Type":2,"Flags":4},"GatewayLoadBalancerArns":{"Type":548,"Flags":0},"NetworkLoadBalancerArns":{"Type":549,"Flags":0},"PayerResponsibility":{"Type":4,"Flags":0},"ServiceId":{"Type":4,"Flags":18}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.EC2/VPCEndpointService","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":547,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EC2/VPCEndpointService@default","ScopeType":0,"Body":550}},{"2":{"Name":"AWS.EC2/VPCEndpointServicePermissionsProperties","Properties":{"AllowedPrincipals":{"Type":553,"Flags":0},"ServiceId":{"Type":4,"Flags":17}}}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.EC2/VPCEndpointServicePermissions","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":552,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EC2/VPCEndpointServicePermissions@default","ScopeType":0,"Body":554}},{"2":{"Name":"AWS.EC2/VPCGatewayAttachmentProperties","Properties":{"AttachmentType":{"Type":4,"Flags":18,"Description":"Used to identify if this resource is an Internet Gateway or Vpn Gateway Attachment "},"InternetGatewayId":{"Type":4,"Flags":0,"Description":"The ID of the internet gateway. You must specify either InternetGatewayId or VpnGatewayId, but not both."},"VpcId":{"Type":4,"Flags":17,"Description":"The ID of the VPC."},"VpnGatewayId":{"Type":4,"Flags":0,"Description":"The ID of the virtual private gateway. You must specify either InternetGatewayId or VpnGatewayId, but not both."}}}},{"2":{"Name":"AWS.EC2/VPCGatewayAttachment","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":556,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EC2/VPCGatewayAttachment@default","ScopeType":0,"Body":557}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.EC2/VPCPeeringConnectionProperties","Properties":{"Id":{"Type":4,"Flags":18},"PeerOwnerId":{"Type":4,"Flags":0,"Description":"The AWS account ID of the owner of the accepter VPC."},"PeerRegion":{"Type":4,"Flags":0,"Description":"The Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request."},"PeerRoleArn":{"Type":4,"Flags":4,"Description":"The Amazon Resource Name (ARN) of the VPC peer role for the peering connection in another AWS account."},"PeerVpcId":{"Type":4,"Flags":1,"Description":"The ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request."},"Tags":{"Type":561,"Flags":0},"VpcId":{"Type":4,"Flags":1,"Description":"The ID of the VPC."}}}},{"3":{"ItemType":559}},{"2":{"Name":"AWS.EC2/VPCPeeringConnection","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":560,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EC2/VPCPeeringConnection@default","ScopeType":0,"Body":562}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"VpnTunnelOptionsSpecification","Properties":{"PreSharedKey":{"Type":4,"Flags":0},"TunnelInsideCidr":{"Type":4,"Flags":0}}}},{"2":{"Name":"AWS.EC2/VPNConnectionProperties","Properties":{"CustomerGatewayId":{"Type":4,"Flags":1,"Description":"The ID of the customer gateway at your end of the VPN connection."},"StaticRoutesOnly":{"Type":2,"Flags":0,"Description":"Indicates whether the VPN connection uses static routes only."},"Tags":{"Type":567,"Flags":0,"Description":"Any tags assigned to the VPN connection."},"TransitGatewayId":{"Type":4,"Flags":0,"Description":"The ID of the transit gateway associated with the VPN connection."},"Type":{"Type":4,"Flags":1,"Description":"The type of VPN connection."},"VpnConnectionId":{"Type":4,"Flags":18,"Description":"The provider-assigned unique ID for this managed resource"},"VpnGatewayId":{"Type":4,"Flags":0,"Description":"The ID of the virtual private gateway at the AWS side of the VPN connection."},"VpnTunnelOptionsSpecifications":{"Type":568,"Flags":0,"Description":"The tunnel options for the VPN connection."}}}},{"3":{"ItemType":564}},{"3":{"ItemType":565}},{"2":{"Name":"AWS.EC2/VPNConnection","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":566,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EC2/VPNConnection@default","ScopeType":0,"Body":569}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.EC2/VPNGatewayProperties","Properties":{"AmazonSideAsn":{"Type":3,"Flags":0,"Description":"The private Autonomous System Number (ASN) for the Amazon side of a BGP session."},"Tags":{"Type":573,"Flags":0,"Description":"Any tags assigned to the virtual private gateway."},"Type":{"Type":4,"Flags":1,"Description":"The type of VPN connection the virtual private gateway supports."},"VPNGatewayId":{"Type":4,"Flags":18,"Description":"VPN Gateway ID generated by service"}}}},{"3":{"ItemType":571}},{"2":{"Name":"AWS.EC2/VPNGateway","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":572,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EC2/VPNGateway@default","ScopeType":0,"Body":574}},{"2":{"Name":"LoadBalancerOptions","Properties":{"LoadBalancerArn":{"Type":4,"Flags":0,"Description":"The ARN of the load balancer."},"Port":{"Type":3,"Flags":0,"Description":"The IP port number."},"Protocol":{"Type":4,"Flags":0,"Description":"The IP protocol."},"SubnetIds":{"Type":582,"Flags":0,"Description":"The IDs of the subnets."}}}},{"2":{"Name":"NetworkInterfaceOptions","Properties":{"NetworkInterfaceId":{"Type":4,"Flags":0,"Description":"The ID of the network interface."},"Port":{"Type":3,"Flags":0,"Description":"The IP port number."},"Protocol":{"Type":4,"Flags":0,"Description":"The IP protocol."}}}},{"2":{"Name":"SecurityGroupId"}},{"2":{"Name":"SseSpecification","Properties":{"CustomerManagedKeyEnabled":{"Type":2,"Flags":0,"Description":"Whether to encrypt the policy with the provided key or disable encryption"},"KmsKeyArn":{"Type":4,"Flags":0,"Description":"KMS Key Arn used to encrypt the group policy"}}}},{"2":{"Name":"SubnetId"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.EC2/VerifiedAccessEndpointProperties","Properties":{"ApplicationDomain":{"Type":4,"Flags":1,"Description":"The DNS name for users to reach your application."},"AttachmentType":{"Type":4,"Flags":1,"Description":"The type of attachment used to provide connectivity between the AWS Verified Access endpoint and the application."},"CreationTime":{"Type":4,"Flags":2,"Description":"The creation time."},"Description":{"Type":4,"Flags":0,"Description":"A description for the AWS Verified Access endpoint."},"DeviceValidationDomain":{"Type":4,"Flags":2,"Description":"Returned if endpoint has a device trust provider attached."},"DomainCertificateArn":{"Type":4,"Flags":1,"Description":"The ARN of a public TLS/SSL certificate imported into or created with ACM."},"EndpointDomain":{"Type":4,"Flags":2,"Description":"A DNS name that is generated for the endpoint."},"EndpointDomainPrefix":{"Type":4,"Flags":1,"Description":"A custom identifier that gets prepended to a DNS name that is generated for the endpoint."},"EndpointType":{"Type":4,"Flags":1,"Description":"The type of AWS Verified Access endpoint. Incoming application requests will be sent to an IP address, load balancer or a network interface depending on the endpoint type specified.The type of AWS Verified Access endpoint. Incoming application requests will be sent to an IP address, load balancer or a network interface depending on the endpoint type specified."},"LastUpdatedTime":{"Type":4,"Flags":2,"Description":"The last updated time."},"LoadBalancerOptions":{"Type":576,"Flags":0,"Description":"The load balancer details if creating the AWS Verified Access endpoint as load-balancer type."},"NetworkInterfaceOptions":{"Type":577,"Flags":0,"Description":"The options for network-interface type endpoint."},"PolicyDocument":{"Type":4,"Flags":0,"Description":"The AWS Verified Access policy document."},"PolicyEnabled":{"Type":2,"Flags":0,"Description":"The status of the Verified Access policy."},"SecurityGroupIds":{"Type":584,"Flags":0,"Description":"The IDs of the security groups for the endpoint."},"SseSpecification":{"Type":579,"Flags":0,"Description":"The configuration options for customer provided KMS encryption."},"Status":{"Type":4,"Flags":2,"Description":"The endpoint status."},"Tags":{"Type":585,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."},"VerifiedAccessEndpointId":{"Type":4,"Flags":18,"Description":"The ID of the AWS Verified Access endpoint."},"VerifiedAccessGroupId":{"Type":4,"Flags":1,"Description":"The ID of the AWS Verified Access group."},"VerifiedAccessInstanceId":{"Type":4,"Flags":2,"Description":"The ID of the AWS Verified Access instance."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":581}},{"2":{"Name":"AWS.EC2/VerifiedAccessEndpoint","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":583,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EC2/VerifiedAccessEndpoint@default","ScopeType":0,"Body":586}},{"2":{"Name":"SseSpecification","Properties":{"CustomerManagedKeyEnabled":{"Type":2,"Flags":0,"Description":"Whether to encrypt the policy with the provided key or disable encryption"},"KmsKeyArn":{"Type":4,"Flags":0,"Description":"KMS Key Arn used to encrypt the group policy"}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.EC2/VerifiedAccessGroupProperties","Properties":{"CreationTime":{"Type":4,"Flags":2,"Description":"Time this Verified Access Group was created."},"Description":{"Type":4,"Flags":0,"Description":"A description for the AWS Verified Access group."},"LastUpdatedTime":{"Type":4,"Flags":2,"Description":"Time this Verified Access Group was last updated."},"Owner":{"Type":4,"Flags":2,"Description":"The AWS account number that owns the group."},"PolicyDocument":{"Type":4,"Flags":0,"Description":"The AWS Verified Access policy document."},"PolicyEnabled":{"Type":2,"Flags":0,"Description":"The status of the Verified Access policy."},"SseSpecification":{"Type":588,"Flags":0,"Description":"The configuration options for customer provided KMS encryption."},"Tags":{"Type":591,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."},"VerifiedAccessGroupArn":{"Type":4,"Flags":2,"Description":"The ARN of the Verified Access group."},"VerifiedAccessGroupId":{"Type":4,"Flags":18,"Description":"The ID of the AWS Verified Access group."},"VerifiedAccessInstanceId":{"Type":4,"Flags":1,"Description":"The ID of the AWS Verified Access instance."}}}},{"3":{"ItemType":589}},{"2":{"Name":"AWS.EC2/VerifiedAccessGroup","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":590,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EC2/VerifiedAccessGroup@default","ScopeType":0,"Body":592}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"VerifiedAccessLogs","Properties":{"CloudWatchLogs":{"Type":598,"Flags":0,"Description":"Sends Verified Access logs to CloudWatch Logs."},"IncludeTrustContext":{"Type":2,"Flags":0,"Description":"Include claims from trust providers in Verified Access logs."},"KinesisDataFirehose":{"Type":599,"Flags":0,"Description":"Sends Verified Access logs to Kinesis."},"LogVersion":{"Type":4,"Flags":0,"Description":"Select log version for Verified Access logs."},"S3":{"Type":600,"Flags":0,"Description":"Sends Verified Access logs to Amazon S3."}}}},{"2":{"Name":"VerifiedAccessTrustProvider","Properties":{"Description":{"Type":4,"Flags":0,"Description":"The description of trust provider."},"DeviceTrustProviderType":{"Type":4,"Flags":0,"Description":"The type of device-based trust provider."},"TrustProviderType":{"Type":4,"Flags":0,"Description":"The type of trust provider (user- or device-based)."},"UserTrustProviderType":{"Type":4,"Flags":0,"Description":"The type of user-based trust provider."},"VerifiedAccessTrustProviderId":{"Type":4,"Flags":0,"Description":"The ID of the trust provider."}}}},{"2":{"Name":"VerifiedAccessTrustProviderId"}},{"2":{"Name":"VerifiedAccessInstance_CloudWatchLogs","Properties":{"Enabled":{"Type":2,"Flags":0,"Description":"Indicates whether logging is enabled."},"LogGroup":{"Type":4,"Flags":0,"Description":"The ID of the CloudWatch Logs log group."}}}},{"2":{"Name":"VerifiedAccessInstance_KinesisDataFirehose","Properties":{"DeliveryStream":{"Type":4,"Flags":0,"Description":"The ID of the delivery stream."},"Enabled":{"Type":2,"Flags":0,"Description":"Indicates whether logging is enabled."}}}},{"2":{"Name":"VerifiedAccessInstance_S3","Properties":{"BucketName":{"Type":4,"Flags":0,"Description":"The bucket name."},"BucketOwner":{"Type":4,"Flags":0,"Description":"The ID of the AWS account that owns the Amazon S3 bucket."},"Enabled":{"Type":2,"Flags":0,"Description":"Indicates whether logging is enabled."},"Prefix":{"Type":4,"Flags":0,"Description":"The bucket prefix."}}}},{"2":{"Name":"AWS.EC2/VerifiedAccessInstanceProperties","Properties":{"CreationTime":{"Type":4,"Flags":2,"Description":"Time this Verified Access Instance was created."},"Description":{"Type":4,"Flags":0,"Description":"A description for the AWS Verified Access instance."},"FipsEnabled":{"Type":2,"Flags":0,"Description":"Indicates whether FIPS is enabled"},"LastUpdatedTime":{"Type":4,"Flags":2,"Description":"Time this Verified Access Instance was last updated."},"LoggingConfigurations":{"Type":595,"Flags":0,"Description":"The configuration options for AWS Verified Access instances."},"Tags":{"Type":602,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."},"VerifiedAccessInstanceId":{"Type":4,"Flags":18,"Description":"The ID of the AWS Verified Access instance."},"VerifiedAccessTrustProviderIds":{"Type":603,"Flags":0,"Description":"The IDs of the AWS Verified Access trust providers."},"VerifiedAccessTrustProviders":{"Type":604,"Flags":0,"Description":"AWS Verified Access trust providers."}}}},{"3":{"ItemType":594}},{"3":{"ItemType":4}},{"3":{"ItemType":596}},{"2":{"Name":"AWS.EC2/VerifiedAccessInstance","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":601,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EC2/VerifiedAccessInstance@default","ScopeType":0,"Body":605}},{"2":{"Name":"DeviceOptions","Properties":{"PublicSigningKeyUrl":{"Type":4,"Flags":0,"Description":"URL Verified Access will use to verify authenticity of the device tokens."},"TenantId":{"Type":4,"Flags":0,"Description":"The ID of the tenant application with the device-identity provider."}}}},{"2":{"Name":"OidcOptions","Properties":{"AuthorizationEndpoint":{"Type":4,"Flags":0,"Description":"The OIDC authorization endpoint."},"ClientId":{"Type":4,"Flags":0,"Description":"The client identifier."},"ClientSecret":{"Type":4,"Flags":0,"Description":"The client secret."},"Issuer":{"Type":4,"Flags":0,"Description":"The OIDC issuer."},"Scope":{"Type":4,"Flags":0,"Description":"OpenID Connect (OIDC) scopes are used by an application during authentication to authorize access to details of a user. Each scope returns a specific set of user attributes."},"TokenEndpoint":{"Type":4,"Flags":0,"Description":"The OIDC token endpoint."},"UserInfoEndpoint":{"Type":4,"Flags":0,"Description":"The OIDC user info endpoint."}}}},{"2":{"Name":"SseSpecification","Properties":{}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.EC2/VerifiedAccessTrustProviderProperties","Properties":{"CreationTime":{"Type":4,"Flags":2,"Description":"The creation time."},"Description":{"Type":4,"Flags":0,"Description":"A description for the Amazon Web Services Verified Access trust provider."},"DeviceOptions":{"Type":607,"Flags":0},"DeviceTrustProviderType":{"Type":4,"Flags":0,"Description":"The type of device-based trust provider. Possible values: jamf|crowdstrike"},"LastUpdatedTime":{"Type":4,"Flags":2,"Description":"The last updated time."},"OidcOptions":{"Type":608,"Flags":0},"PolicyReferenceName":{"Type":4,"Flags":1,"Description":"The identifier to be used when working with policy rules."},"SseSpecification":{"Type":612,"Flags":0,"Description":"The configuration options for customer provided KMS encryption."},"Tags":{"Type":613,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."},"TrustProviderType":{"Type":4,"Flags":1,"Description":"Type of trust provider. Possible values: user|device"},"UserTrustProviderType":{"Type":4,"Flags":0,"Description":"The type of device-based trust provider. Possible values: oidc|iam-identity-center"},"VerifiedAccessTrustProviderId":{"Type":4,"Flags":18,"Description":"The ID of the Amazon Web Services Verified Access trust provider."}}}},{"2":{"Name":"VerifiedAccessTrustProvider_SseSpecification","Properties":{"CustomerManagedKeyEnabled":{"Type":2,"Flags":0,"Description":"Whether to encrypt the policy with the provided key or disable encryption"},"KmsKeyArn":{"Type":4,"Flags":0,"Description":"KMS Key Arn used to encrypt the group policy"}}}},{"3":{"ItemType":610}},{"2":{"Name":"AWS.EC2/VerifiedAccessTrustProvider","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":611,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EC2/VerifiedAccessTrustProvider@default","ScopeType":0,"Body":614}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}}}},{"2":{"Name":"AWS.EC2/VolumeProperties","Properties":{"AutoEnableIO":{"Type":2,"Flags":0,"Description":"The Availability Zone in which to create the volume."},"AvailabilityZone":{"Type":4,"Flags":1,"Description":"The Availability Zone in which to create the volume."},"Encrypted":{"Type":2,"Flags":0,"Description":"Specifies whether the volume should be encrypted. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Encryption by default in the Amazon Elastic Compute Cloud User Guide. Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types."},"Iops":{"Type":3,"Flags":0,"Description":"The number of I/O operations per second (IOPS) to provision for an io1 or io2 volume, with a maximum ratio of 50 IOPS/GiB for io1, and 500 IOPS/GiB for io2. Range is 100 to 64,000 IOPS for volumes in most Regions. Maximum IOPS of 64,000 is guaranteed only on Nitro-based instances. Other instance families guarantee performance up to 32,000 IOPS. For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide. This parameter is valid only for Provisioned IOPS SSD (io1 and io2) volumes. "},"KmsKeyId":{"Type":4,"Flags":0,"Description":"The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption. If KmsKeyId is specified, the encrypted state must be true. If you omit this property and your account is enabled for encryption by default, or Encrypted is set to true, then the volume is encrypted using the default CMK specified for your account. If your account does not have a default CMK, then the volume is encrypted using the AWS managed CMK. Alternatively, if you want to specify a different CMK, you can specify one of the following: Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab. Key alias. Specify the alias for the CMK, prefixed with alias/. For example, for a CMK with the alias my_cmk, use alias/my_cmk. Or to specify the AWS managed CMK, use alias/aws/ebs. Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab. Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias."},"MultiAttachEnabled":{"Type":2,"Flags":0,"Description":"Indicates whether Amazon EBS Multi-Attach is enabled."},"OutpostArn":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) of the Outpost."},"Size":{"Type":3,"Flags":0,"Description":"The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. Constraints: 1-16,384 for gp2, 4-16,384 for io1 and io2, 500-16,384 for st1, 500-16,384 for sc1, and 1-1,024 for standard. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size. Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size. "},"SnapshotId":{"Type":4,"Flags":0,"Description":"The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size. "},"Tags":{"Type":618,"Flags":0,"Description":"The tags to apply to the volume during creation."},"Throughput":{"Type":3,"Flags":0,"Description":"The throughput that the volume supports, in MiB/s."},"VolumeId":{"Type":4,"Flags":18},"VolumeType":{"Type":4,"Flags":0,"Description":"The volume type. This parameter can be one of the following values: General Purpose SSD: gp2 | gp3, Provisioned IOPS SSD: io1 | io2, Throughput Optimized HDD: st1, Cold HDD: sc1, Magnetic: standard"}}}},{"3":{"ItemType":616}},{"2":{"Name":"AWS.EC2/Volume","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":617,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EC2/Volume@default","ScopeType":0,"Body":619}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TagSpecification", + "properties": { + "ResourceType": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/CapacityReservationProperties" + }, + { + "$type": "IntegerType" + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/CapacityReservationProperties", + "properties": { + "AvailabilityZone": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "AvailableInstanceCount": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "EbsOptimized": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "EndDate": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "EndDateType": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "EphemeralStorage": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "Id": { + "type": { + "$ref": "#/2" + }, + "flags": 18 + }, + "InstanceCount": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "InstanceMatchCriteria": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "InstancePlatform": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "InstanceType": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "OutPostArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "PlacementGroupArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "TagSpecifications": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "Tenancy": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "TotalInstanceCount": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/CapacityReservation", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/8" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/CapacityReservation@default", + "scopeType": 0, + "body": { + "$ref": "#/9" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "InstanceTypeSpecification", + "properties": { + "AvailabilityZone": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "AvailabilityZoneId": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "EbsOptimized": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "InstancePlatform": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "InstanceType": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Priority": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Weight": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TagSpecification", + "properties": { + "ResourceType": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/12" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/CapacityReservationFleetProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/11" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/CapacityReservationFleetProperties", + "properties": { + "AllocationStrategy": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "CapacityReservationFleetId": { + "type": { + "$ref": "#/2" + }, + "flags": 18 + }, + "EndDate": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "InstanceMatchCriteria": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "InstanceTypeSpecifications": { + "type": { + "$ref": "#/16" + }, + "flags": 0 + }, + "NoRemoveEndDate": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "RemoveEndDate": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "TagSpecifications": { + "type": { + "$ref": "#/17" + }, + "flags": 0 + }, + "Tenancy": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "TotalTargetCapacity": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/CapacityReservationFleet", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/18" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/CapacityReservationFleet@default", + "scopeType": 0, + "body": { + "$ref": "#/19" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tags", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/21" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/CarrierGatewayProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/21" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/CarrierGatewayProperties", + "properties": { + "CarrierGatewayId": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "The ID of the carrier gateway." + }, + "OwnerId": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The ID of the owner." + }, + "State": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The state of the carrier gateway." + }, + "Tags": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "The tags for the carrier gateway." + }, + "VpcId": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The ID of the VPC." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/CarrierGateway", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/26" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/CarrierGateway@default", + "scopeType": 0, + "body": { + "$ref": "#/27" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The tag key." + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The tag value." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/CustomerGatewayProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/29" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/CustomerGatewayProperties", + "properties": { + "BgpAsn": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "For 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``.\n Default: 65000\n Valid values: ``1`` to ``2,147,483,647``" + }, + "BgpAsnExtended": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "For 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``.\n Valid values: ``2,147,483,648`` to ``4,294,967,295``" + }, + "CertificateArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) for the customer gateway certificate." + }, + "CustomerGatewayId": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "" + }, + "DeviceName": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The name of customer gateway device." + }, + "IpAddress": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "IPv4 address for the customer gateway device's outside interface. The address must be static. If ``OutsideIpAddressType`` in your VPN connection options is set to ``PrivateIpv4``, you can use an RFC6598 or RFC1918 private IPv4 address. If ``OutsideIpAddressType`` is set to ``PublicIpv4``, you can use a public IPv4 address." + }, + "Tags": { + "type": { + "$ref": "#/31" + }, + "flags": 0, + "description": "One or more tags for the customer gateway." + }, + "Type": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The type of VPN connection that this customer gateway supports (``ipsec.1``)." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/CustomerGateway", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/32" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/CustomerGateway@default", + "scopeType": 0, + "body": { + "$ref": "#/33" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/DHCPOptionsProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/35" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/DHCPOptionsProperties", + "properties": { + "DhcpOptionsId": { + "type": { + "$ref": "#/2" + }, + "flags": 18 + }, + "DomainName": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "This value is used to complete unqualified DNS hostnames." + }, + "DomainNameServers": { + "type": { + "$ref": "#/37" + }, + "flags": 0, + "description": "The IPv4 addresses of up to four domain name servers, or AmazonProvidedDNS." + }, + "Ipv6AddressPreferredLeaseTime": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The preferred Lease Time for ipV6 address in seconds." + }, + "NetbiosNameServers": { + "type": { + "$ref": "#/38" + }, + "flags": 0, + "description": "The IPv4 addresses of up to four NetBIOS name servers." + }, + "NetbiosNodeType": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The NetBIOS node type (1, 2, 4, or 8)." + }, + "NtpServers": { + "type": { + "$ref": "#/39" + }, + "flags": 0, + "description": "The IPv4 addresses of up to four Network Time Protocol (NTP) servers." + }, + "Tags": { + "type": { + "$ref": "#/40" + }, + "flags": 0, + "description": "Any tags assigned to the DHCP options set." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/DHCPOptions", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/41" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/DHCPOptions@default", + "scopeType": 0, + "body": { + "$ref": "#/42" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AcceleratorCountRequest", + "properties": { + "Max": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Min": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AcceleratorTotalMemoryMiBRequest", + "properties": { + "Max": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Min": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BaselineEbsBandwidthMbpsRequest", + "properties": { + "Max": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Min": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CapacityRebalance", + "properties": { + "ReplacementStrategy": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "TerminationDelay": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CapacityReservationOptionsRequest", + "properties": { + "UsageStrategy": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FleetLaunchTemplateConfigRequest", + "properties": { + "LaunchTemplateSpecification": { + "type": { + "$ref": "#/51" + }, + "flags": 0 + }, + "Overrides": { + "type": { + "$ref": "#/66" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FleetLaunchTemplateOverridesRequest", + "properties": { + "AvailabilityZone": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "InstanceRequirements": { + "type": { + "$ref": "#/52" + }, + "flags": 0 + }, + "InstanceType": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "MaxPrice": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Placement": { + "type": { + "$ref": "#/59" + }, + "flags": 0 + }, + "Priority": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "SubnetId": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "WeightedCapacity": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FleetLaunchTemplateSpecificationRequest", + "properties": { + "LaunchTemplateId": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "LaunchTemplateName": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Version": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "InstanceRequirementsRequest", + "properties": { + "AcceleratorCount": { + "type": { + "$ref": "#/44" + }, + "flags": 0 + }, + "AcceleratorManufacturers": { + "type": { + "$ref": "#/67" + }, + "flags": 0 + }, + "AcceleratorNames": { + "type": { + "$ref": "#/68" + }, + "flags": 0 + }, + "AcceleratorTotalMemoryMiB": { + "type": { + "$ref": "#/45" + }, + "flags": 0 + }, + "AcceleratorTypes": { + "type": { + "$ref": "#/69" + }, + "flags": 0 + }, + "AllowedInstanceTypes": { + "type": { + "$ref": "#/70" + }, + "flags": 0 + }, + "BareMetal": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "BaselineEbsBandwidthMbps": { + "type": { + "$ref": "#/46" + }, + "flags": 0 + }, + "BurstablePerformance": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "CpuManufacturers": { + "type": { + "$ref": "#/71" + }, + "flags": 0 + }, + "ExcludedInstanceTypes": { + "type": { + "$ref": "#/72" + }, + "flags": 0 + }, + "InstanceGenerations": { + "type": { + "$ref": "#/73" + }, + "flags": 0 + }, + "LocalStorage": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "LocalStorageTypes": { + "type": { + "$ref": "#/74" + }, + "flags": 0 + }, + "MaxSpotPriceAsPercentageOfOptimalOnDemandPrice": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "MemoryGiBPerVCpu": { + "type": { + "$ref": "#/54" + }, + "flags": 0 + }, + "MemoryMiB": { + "type": { + "$ref": "#/55" + }, + "flags": 0 + }, + "NetworkBandwidthGbps": { + "type": { + "$ref": "#/56" + }, + "flags": 0 + }, + "NetworkInterfaceCount": { + "type": { + "$ref": "#/57" + }, + "flags": 0 + }, + "OnDemandMaxPricePercentageOverLowestPrice": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "RequireHibernateSupport": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "SpotMaxPricePercentageOverLowestPrice": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "TotalLocalStorageGB": { + "type": { + "$ref": "#/64" + }, + "flags": 0 + }, + "VCpuCount": { + "type": { + "$ref": "#/65" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "MaintenanceStrategies", + "properties": { + "CapacityRebalance": { + "type": { + "$ref": "#/47" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "MemoryGiBPerVCpuRequest", + "properties": { + "Max": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Min": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "MemoryMiBRequest", + "properties": { + "Max": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Min": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "NetworkBandwidthGbpsRequest", + "properties": { + "Max": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Min": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "NetworkInterfaceCountRequest", + "properties": { + "Max": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Min": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "OnDemandOptionsRequest", + "properties": { + "AllocationStrategy": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "CapacityReservationOptions": { + "type": { + "$ref": "#/48" + }, + "flags": 0 + }, + "MaxTotalPrice": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "MinTargetCapacity": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "SingleAvailabilityZone": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "SingleInstanceType": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Placement", + "properties": { + "Affinity": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "AvailabilityZone": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "GroupName": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "HostId": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "HostResourceGroupArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "PartitionNumber": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "SpreadDomain": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Tenancy": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SpotOptionsRequest", + "properties": { + "AllocationStrategy": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "InstanceInterruptionBehavior": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "InstancePoolsToUseCount": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "MaintenanceStrategies": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "MaxTotalPrice": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "MinTargetCapacity": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "SingleAvailabilityZone": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "SingleInstanceType": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TagSpecification", + "properties": { + "ResourceType": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/75" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TargetCapacitySpecificationRequest", + "properties": { + "DefaultTargetCapacityType": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "OnDemandTargetCapacity": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "SpotTargetCapacity": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "TargetCapacityUnitType": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "TotalTargetCapacity": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TotalLocalStorageGBRequest", + "properties": { + "Max": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Min": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "VCpuCountRangeRequest", + "properties": { + "Max": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Min": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/50" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/61" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/EC2FleetProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/49" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/62" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/EC2FleetProperties", + "properties": { + "Context": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "ExcessCapacityTerminationPolicy": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "FleetId": { + "type": { + "$ref": "#/2" + }, + "flags": 18 + }, + "LaunchTemplateConfigs": { + "type": { + "$ref": "#/77" + }, + "flags": 1 + }, + "OnDemandOptions": { + "type": { + "$ref": "#/58" + }, + "flags": 0 + }, + "ReplaceUnhealthyInstances": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "SpotOptions": { + "type": { + "$ref": "#/60" + }, + "flags": 0 + }, + "TagSpecifications": { + "type": { + "$ref": "#/78" + }, + "flags": 0 + }, + "TargetCapacitySpecification": { + "type": { + "$ref": "#/63" + }, + "flags": 1 + }, + "TerminateInstancesWithExpiration": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "ValidFrom": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "ValidUntil": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/EC2Fleet", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/79" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/EC2Fleet@default", + "scopeType": 0, + "body": { + "$ref": "#/80" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The tag key." + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The tag value." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/EIPProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/82" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/EIPProperties", + "properties": { + "AllocationId": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "" + }, + "Domain": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The network (``vpc``).\n If you define an Elastic IP address and associate it with a VPC that is defined in the same template, you must declare a dependency on the VPC-gateway attachment by using the [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) on this resource." + }, + "InstanceId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The ID of the instance.\n Updates to the ``InstanceId`` property may require *some interruptions*. Updates on an EIP reassociates the address on its associated resource." + }, + "NetworkBorderGroup": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "A unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses. Use this parameter to limit the IP address to this location. IP addresses cannot move between network border groups.\n Use [DescribeAvailabilityZones](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeAvailabilityZones.html) to view the network border groups." + }, + "PublicIp": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "" + }, + "PublicIpv4Pool": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool.\n Updates to the ``PublicIpv4Pool`` property may require *some interruptions*. Updates on an EIP reassociates the address on its associated resource." + }, + "Tags": { + "type": { + "$ref": "#/84" + }, + "flags": 0, + "description": "Any tags assigned to the Elastic IP address.\n Updates to the ``Tags`` property may require *some interruptions*. Updates on an EIP reassociates the address on its associated resource." + }, + "TransferAddress": { + "type": { + "$ref": "#/2" + }, + "flags": 4, + "description": "The Elastic IP address you are accepting for transfer. You can only accept one transferred address. For more information on Elastic IP address transfers, see [Transfer Elastic IP addresses](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#transfer-EIPs-intro) in the *Amazon Virtual Private Cloud User Guide*." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/EIP", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/85" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/EIP@default", + "scopeType": 0, + "body": { + "$ref": "#/86" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/FlowLogProperties" + }, + { + "$type": "ObjectType", + "name": "FlowLog_DestinationOptions", + "properties": { + "FileFormat": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "HiveCompatiblePartitions": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "PerHourPartition": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/88" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/FlowLogProperties", + "properties": { + "DeliverCrossAccountRole": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The ARN of the IAM role that allows Amazon EC2 to publish flow logs across accounts." + }, + "DeliverLogsPermissionArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account. If you specify LogDestinationType as s3 or kinesis-data-firehose, do not specify DeliverLogsPermissionArn or LogGroupName." + }, + "DestinationOptions": { + "type": { + "$ref": "#/90" + }, + "flags": 0 + }, + "Id": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "The Flow Log ID" + }, + "LogDestination": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "Specifies the destination to which the flow log data is to be published. Flow log data can be published to a CloudWatch Logs log group, an Amazon S3 bucket, or a Kinesis Firehose stream. The value specified for this parameter depends on the value specified for LogDestinationType." + }, + "LogDestinationType": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "Specifies the type of destination to which the flow log data is to be published. Flow log data can be published to CloudWatch Logs or Amazon S3." + }, + "LogFormat": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The fields to include in the flow log record, in the order in which they should appear." + }, + "LogGroupName": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs. If you specify LogDestinationType as s3 or kinesis-data-firehose, do not specify DeliverLogsPermissionArn or LogGroupName." + }, + "MaxAggregationInterval": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. You can specify 60 seconds (1 minute) or 600 seconds (10 minutes)." + }, + "ResourceId": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The ID of the subnet, network interface, or VPC for which you want to create a flow log." + }, + "ResourceType": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The type of resource for which to create the flow log. For example, if you specified a VPC ID for the ResourceId property, specify VPC for this property." + }, + "Tags": { + "type": { + "$ref": "#/91" + }, + "flags": 0, + "description": "The tags to apply to the flow logs." + }, + "TrafficType": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/FlowLog", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/92" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/FlowLog@default", + "scopeType": 0, + "body": { + "$ref": "#/93" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/GatewayRouteTableAssociationProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/GatewayRouteTableAssociationProperties", + "properties": { + "AssociationId": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The route table association ID." + }, + "GatewayId": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "The ID of the gateway." + }, + "RouteTableId": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The ID of the route table." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/GatewayRouteTableAssociation", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/96" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/GatewayRouteTableAssociation@default", + "scopeType": 0, + "body": { + "$ref": "#/97" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/HostProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/HostProperties", + "properties": { + "AssetId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The ID of the Outpost hardware asset." + }, + "AutoPlacement": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "Indicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance launches that specify its unique host ID." + }, + "AvailabilityZone": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The Availability Zone in which to allocate the Dedicated Host." + }, + "HostId": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "ID of the host created." + }, + "HostMaintenance": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "Automatically allocates a new dedicated host and moves your instances on to it if a degradation is detected on your current host." + }, + "HostRecovery": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "Indicates whether to enable or disable host recovery for the Dedicated Host. Host recovery is disabled by default." + }, + "InstanceFamily": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "Specifies the instance family to be supported by the Dedicated Hosts. If you specify an instance family, the Dedicated Hosts support multiple instance types within that instance family." + }, + "InstanceType": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "Specifies the instance type to be supported by the Dedicated Hosts. If you specify an instance type, the Dedicated Hosts support instances of the specified instance type only." + }, + "OutpostArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which to allocate the Dedicated Host." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/Host", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/100" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/Host@default", + "scopeType": 0, + "body": { + "$ref": "#/101" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "IpamOperatingRegion", + "properties": { + "RegionName": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The name of the region." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/IPAMProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/103" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/104" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/IPAMProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) of the IPAM." + }, + "DefaultResourceDiscoveryAssociationId": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The Id of the default association to the default resource discovery, created with this IPAM." + }, + "DefaultResourceDiscoveryId": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The Id of the default resource discovery, created with this IPAM." + }, + "Description": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "IpamId": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "Id of the IPAM." + }, + "OperatingRegions": { + "type": { + "$ref": "#/106" + }, + "flags": 0, + "description": "The regions IPAM is enabled for. Allows pools to be created in these regions, as well as enabling monitoring" + }, + "PrivateDefaultScopeId": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The Id of the default scope for publicly routable IP space, created with this IPAM." + }, + "PublicDefaultScopeId": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The Id of the default scope for publicly routable IP space, created with this IPAM." + }, + "ResourceDiscoveryAssociationCount": { + "type": { + "$ref": "#/5" + }, + "flags": 2, + "description": "The count of resource discoveries associated with this IPAM." + }, + "ScopeCount": { + "type": { + "$ref": "#/5" + }, + "flags": 2, + "description": "The number of scopes that currently exist in this IPAM." + }, + "Tags": { + "type": { + "$ref": "#/107" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + }, + "Tier": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The tier of the IPAM." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/IPAM", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/108" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/IPAM@default", + "scopeType": 0, + "body": { + "$ref": "#/109" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Cidr", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ProvisionedCidr", + "properties": { + "Cidr": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "SourceResource", + "properties": { + "ResourceId": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "ResourceOwner": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "ResourceRegion": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "ResourceType": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/IPAMPoolProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/114" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/112" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/114" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/IPAMPoolProperties", + "properties": { + "AddressFamily": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The address family of the address space in this pool. Either IPv4 or IPv6." + }, + "AllocationDefaultNetmaskLength": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The default netmask length for allocations made from this pool. This value is used when the netmask length of an allocation isn't specified." + }, + "AllocationMaxNetmaskLength": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The maximum allowed netmask length for allocations made from this pool." + }, + "AllocationMinNetmaskLength": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The minimum allowed netmask length for allocations made from this pool." + }, + "AllocationResourceTags": { + "type": { + "$ref": "#/116" + }, + "flags": 0, + "description": "When specified, an allocation will not be allowed unless a resource has a matching set of tags." + }, + "Arn": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) of the IPAM Pool." + }, + "AutoImport": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Determines what to do if IPAM discovers resources that haven't been assigned an allocation. If set to true, an allocation will be made automatically." + }, + "AwsService": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "Limits which service in Amazon Web Services that the pool can be used in." + }, + "Description": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "IpamArn": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) of the IPAM this pool is a part of." + }, + "IpamPoolId": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "Id of the IPAM Pool." + }, + "IpamScopeArn": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) of the scope this pool is a part of." + }, + "IpamScopeId": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The Id of the scope this pool is a part of." + }, + "IpamScopeType": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "Determines whether this scope contains publicly routable space or space for a private network" + }, + "Locale": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The region of this pool. If not set, this will default to \"None\" which will disable non-custom allocations. If the locale has been specified for the source pool, this value must match." + }, + "PoolDepth": { + "type": { + "$ref": "#/5" + }, + "flags": 2, + "description": "The depth of this pool in the source pool hierarchy." + }, + "ProvisionedCidrs": { + "type": { + "$ref": "#/117" + }, + "flags": 0, + "description": "A list of cidrs representing the address space available for allocation in this pool." + }, + "PublicIpSource": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is `byoip`." + }, + "PubliclyAdvertisable": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Determines whether or not address space from this pool is publicly advertised. Must be set if and only if the pool is IPv6." + }, + "SourceIpamPoolId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The Id of this pool's source. If set, all space provisioned in this pool must be free space provisioned in the parent pool." + }, + "SourceResource": { + "type": { + "$ref": "#/113" + }, + "flags": 0 + }, + "State": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The state of this pool. This can be one of the following values: \"create-in-progress\", \"create-complete\", \"modify-in-progress\", \"modify-complete\", \"delete-in-progress\", or \"delete-complete\"" + }, + "StateMessage": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "An explanation of how the pool arrived at it current state." + }, + "Tags": { + "type": { + "$ref": "#/118" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/IPAMPool", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/119" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/IPAMPool@default", + "scopeType": 0, + "body": { + "$ref": "#/120" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "IpamOperatingRegion", + "properties": { + "RegionName": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The name of the region." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/IPAMResourceDiscoveryProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/122" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/123" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/IPAMResourceDiscoveryProperties", + "properties": { + "Description": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "IpamResourceDiscoveryArn": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "Amazon Resource Name (Arn) for the Resource Discovery." + }, + "IpamResourceDiscoveryId": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "Id of the IPAM Pool." + }, + "IpamResourceDiscoveryRegion": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The region the resource discovery is setup in. " + }, + "IsDefault": { + "type": { + "$ref": "#/6" + }, + "flags": 2, + "description": "Determines whether or not address space from this pool is publicly advertised. Must be set if and only if the pool is IPv6." + }, + "OperatingRegions": { + "type": { + "$ref": "#/125" + }, + "flags": 0, + "description": "The regions Resource Discovery is enabled for. Allows resource discoveries to be created in these regions, as well as enabling monitoring" + }, + "OwnerId": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "Owner Account ID of the Resource Discovery" + }, + "State": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The state of this Resource Discovery." + }, + "Tags": { + "type": { + "$ref": "#/126" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/IPAMResourceDiscovery", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/127" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/IPAMResourceDiscovery@default", + "scopeType": 0, + "body": { + "$ref": "#/128" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/IPAMResourceDiscoveryAssociationProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/130" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/IPAMResourceDiscoveryAssociationProperties", + "properties": { + "IpamArn": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "Arn of the IPAM." + }, + "IpamId": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The Id of the IPAM this Resource Discovery is associated to." + }, + "IpamRegion": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The home region of the IPAM." + }, + "IpamResourceDiscoveryAssociationArn": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) of the resource discovery association is a part of." + }, + "IpamResourceDiscoveryAssociationId": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "Id of the IPAM Resource Discovery Association." + }, + "IpamResourceDiscoveryId": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of the IPAM Resource Discovery Association." + }, + "IsDefault": { + "type": { + "$ref": "#/6" + }, + "flags": 2, + "description": "If the Resource Discovery Association exists due as part of CreateIpam." + }, + "OwnerId": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The AWS Account ID for the account where the shared IPAM exists." + }, + "ResourceDiscoveryStatus": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The status of the resource discovery." + }, + "State": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The operational state of the Resource Discovery Association. Related to Create/Delete activities." + }, + "Tags": { + "type": { + "$ref": "#/132" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/IPAMResourceDiscoveryAssociation", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/133" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/IPAMResourceDiscoveryAssociation@default", + "scopeType": 0, + "body": { + "$ref": "#/134" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/IPAMScopeProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/136" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/IPAMScopeProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) of the IPAM scope." + }, + "Description": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "IpamArn": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) of the IPAM this scope is a part of." + }, + "IpamId": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The Id of the IPAM this scope is a part of." + }, + "IpamScopeId": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "Id of the IPAM scope." + }, + "IpamScopeType": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "Determines whether this scope contains publicly routable space or space for a private network" + }, + "IsDefault": { + "type": { + "$ref": "#/6" + }, + "flags": 2, + "description": "Is this one of the default scopes created with the IPAM." + }, + "PoolCount": { + "type": { + "$ref": "#/5" + }, + "flags": 2, + "description": "The number of pools that currently exist in this scope." + }, + "Tags": { + "type": { + "$ref": "#/138" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/IPAMScope", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/139" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/IPAMScope@default", + "scopeType": 0, + "body": { + "$ref": "#/140" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AssociationParameter", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The name of an input parameter that is in the associated SSM document." + }, + "Value": { + "type": { + "$ref": "#/157" + }, + "flags": 1, + "description": "The value of an input parameter." + } + } + }, + { + "$type": "ObjectType", + "name": "BlockDeviceMapping", + "properties": { + "DeviceName": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The device name (for example, /dev/sdh or xvdh)." + }, + "Ebs": { + "type": { + "$ref": "#/144" + }, + "flags": 0, + "description": "Parameters used to automatically set up EBS volumes when the instance is launched." + }, + "NoDevice": { + "type": { + "$ref": "#/158" + }, + "flags": 0 + }, + "VirtualName": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Ebs", + "properties": { + "DeleteOnTermination": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Indicates whether the EBS volume is deleted on instance termination." + }, + "Encrypted": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Indicates whether the volume should be encrypted." + }, + "Iops": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting." + }, + "KmsKeyId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The identifier of the AWS Key Management Service (AWS KMS) customer managed CMK to use for Amazon EBS encryption. If KmsKeyId is specified, the encrypted state must be true. If the encrypted state is true but you do not specify KmsKeyId, your AWS managed CMK for EBS is used." + }, + "SnapshotId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The ID of the snapshot." + }, + "VolumeSize": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size." + }, + "VolumeType": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The volume type." + } + } + }, + { + "$type": "ObjectType", + "name": "ElasticGpuSpecification", + "properties": { + "Type": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The type of Elastic Graphics accelerator." + } + } + }, + { + "$type": "ObjectType", + "name": "ElasticInferenceAccelerator", + "properties": { + "Count": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The number of elastic inference accelerators to attach to the instance." + }, + "Type": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The type of elastic inference accelerator." + } + } + }, + { + "$type": "ObjectType", + "name": "InstanceIpv6Address", + "properties": { + "Ipv6Address": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The IPv6 address." + } + } + }, + { + "$type": "ObjectType", + "name": "LaunchTemplateSpecification", + "properties": { + "LaunchTemplateId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The ID of the launch template. You must specify the LaunchTemplateName or the LaunchTemplateId, but not both." + }, + "LaunchTemplateName": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The name of the launch template. You must specify the LaunchTemplateName or the LaunchTemplateId, but not both." + }, + "Version": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The version number of the launch template." + } + } + }, + { + "$type": "ObjectType", + "name": "LicenseSpecification", + "properties": { + "LicenseConfigurationArn": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of the license configuration." + } + } + }, + { + "$type": "ObjectType", + "name": "NetworkInterface", + "properties": { + "AssociateCarrierIpAddress": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Not currently supported by AWS CloudFormation." + }, + "AssociatePublicIpAddress": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Indicates whether to assign a public IPv4 address to an instance you launch in a VPC." + }, + "DeleteOnTermination": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "If set to true, the interface is deleted when the instance is terminated." + }, + "Description": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The description of the network interface." + }, + "DeviceIndex": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The position of the network interface in the attachment order. A primary network interface has a device index of 0." + }, + "GroupSet": { + "type": { + "$ref": "#/159" + }, + "flags": 0, + "description": "The IDs of the security groups for the network interface." + }, + "Ipv6AddressCount": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "A number of IPv6 addresses to assign to the network interface." + }, + "Ipv6Addresses": { + "type": { + "$ref": "#/160" + }, + "flags": 0, + "description": "The IPv6 addresses associated with the network interface." + }, + "NetworkInterfaceId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The ID of the network interface." + }, + "PrivateIpAddress": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The private IPv4 address of the network interface." + }, + "PrivateIpAddresses": { + "type": { + "$ref": "#/161" + }, + "flags": 0, + "description": "One or more private IPv4 addresses to assign to the network interface." + }, + "SecondaryPrivateIpAddressCount": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The number of secondary private IPv4 addresses." + }, + "SubnetId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The ID of the subnet." + } + } + }, + { + "$type": "ObjectType", + "name": "PrivateDnsNameOptions", + "properties": { + "EnableResourceNameDnsAAAARecord": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records. For more information, see Amazon EC2 instance hostname types in the Amazon Elastic Compute Cloud User Guide." + }, + "EnableResourceNameDnsARecord": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Indicates whether to respond to DNS queries for instance hostnames with DNS A records. For more information, see Amazon EC2 instance hostname types in the Amazon Elastic Compute Cloud User Guide." + }, + "HostnameType": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The type of hostnames to assign to instances in the subnet at launch. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID. For more information, see Amazon EC2 instance hostname types in the Amazon Elastic Compute Cloud User Guide." + } + } + }, + { + "$type": "ObjectType", + "name": "PrivateIpAddressSpecification", + "properties": { + "Primary": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary." + }, + "PrivateIpAddress": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The private IPv4 addresses." + } + } + }, + { + "$type": "ObjectType", + "name": "SsmAssociation", + "properties": { + "AssociationParameters": { + "type": { + "$ref": "#/162" + }, + "flags": 0, + "description": "The input parameter values to use with the associated SSM document." + }, + "DocumentName": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The name of an SSM document to associate with the instance." + } + } + }, + { + "$type": "ObjectType", + "name": "State", + "properties": { + "Code": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The state of the instance as a 16-bit unsigned integer." + }, + "Name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The current state of the instance." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Volume", + "properties": { + "Device": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The device name (for example, /dev/sdh or xvdh)." + }, + "VolumeId": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The ID of the EBS volume. The volume and instance must be within the same Availability Zone." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ObjectType", + "name": "Instance_NoDevice", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/147" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/152" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/142" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/InstanceProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/143" + } + }, + { + "$type": "ObjectType", + "name": "Instance_CpuOptions", + "properties": { + "CoreCount": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "ThreadsPerCore": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Instance_CreditSpecification", + "properties": { + "CPUCredits": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/145" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/146" + } + }, + { + "$type": "ObjectType", + "name": "Instance_EnclaveOptions", + "properties": { + "Enabled": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "If this parameter is set to true, the instance is enabled for AWS Nitro Enclaves; otherwise, it is not enabled for AWS Nitro Enclaves." + } + } + }, + { + "$type": "ObjectType", + "name": "Instance_HibernationOptions", + "properties": { + "Configured": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "If you set this parameter to true, your instance is enabled for hibernation." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/147" + } + }, + { + "$type": "ObjectType", + "name": "Instance_LaunchTemplateSpecification", + "properties": { + "LaunchTemplateId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The ID of the launch template. You must specify the LaunchTemplateName or the LaunchTemplateId, but not both." + }, + "LaunchTemplateName": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The name of the launch template. You must specify the LaunchTemplateName or the LaunchTemplateId, but not both." + }, + "Version": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The version number of the launch template." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/149" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/150" + } + }, + { + "$type": "ObjectType", + "name": "Instance_PrivateDnsNameOptions", + "properties": { + "EnableResourceNameDnsAAAARecord": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records. For more information, see Amazon EC2 instance hostname types in the Amazon Elastic Compute Cloud User Guide." + }, + "EnableResourceNameDnsARecord": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Indicates whether to respond to DNS queries for instance hostnames with DNS A records. For more information, see Amazon EC2 instance hostname types in the Amazon Elastic Compute Cloud User Guide." + }, + "HostnameType": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The type of hostnames to assign to instances in the subnet at launch. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID. For more information, see Amazon EC2 instance hostname types in the Amazon Elastic Compute Cloud User Guide." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/153" + } + }, + { + "$type": "ObjectType", + "name": "Instance_State", + "properties": { + "Code": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The state of the instance as a 16-bit unsigned integer." + }, + "Name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The current state of the instance." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/155" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/156" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/InstanceProperties", + "properties": { + "AdditionalInfo": { + "type": { + "$ref": "#/2" + }, + "flags": 4, + "description": "This property is reserved for internal use. If you use it, the stack fails with this error: Bad property set: [Testing this property] (Service: AmazonEC2; Status Code: 400; Error Code: InvalidParameterCombination; Request ID: 0XXXXXX-49c7-4b40-8bcc-76885dcXXXXX)." + }, + "Affinity": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "Indicates whether the instance is associated with a dedicated host. If you want the instance to always restart on the same host on which it was launched, specify host. If you want the instance to restart on any available host, but try to launch onto the last host it ran on (on a best-effort basis), specify default." + }, + "AvailabilityZone": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The Availability Zone of the instance." + }, + "BlockDeviceMappings": { + "type": { + "$ref": "#/164" + }, + "flags": 4, + "description": "The block device mapping entries that defines the block devices to attach to the instance at launch." + }, + "CpuOptions": { + "type": { + "$ref": "#/165" + }, + "flags": 0, + "description": "The CPU options for the instance." + }, + "CreditSpecification": { + "type": { + "$ref": "#/166" + }, + "flags": 0, + "description": "The credit option for CPU usage of the burstable performance instance. Valid values are standard and unlimited." + }, + "DisableApiTermination": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can." + }, + "EbsOptimized": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Indicates whether the instance is optimized for Amazon EBS I/O." + }, + "ElasticGpuSpecifications": { + "type": { + "$ref": "#/167" + }, + "flags": 0, + "description": "An elastic GPU to associate with the instance." + }, + "ElasticInferenceAccelerators": { + "type": { + "$ref": "#/168" + }, + "flags": 0, + "description": "An elastic inference accelerator to associate with the instance." + }, + "EnclaveOptions": { + "type": { + "$ref": "#/169" + }, + "flags": 0, + "description": "Indicates whether the instance is enabled for AWS Nitro Enclaves." + }, + "HibernationOptions": { + "type": { + "$ref": "#/170" + }, + "flags": 0, + "description": "Indicates whether an instance is enabled for hibernation." + }, + "HostId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "If you specify host for the Affinity property, the ID of a dedicated host that the instance is associated with. If you don't specify an ID, Amazon EC2 launches the instance onto any available, compatible dedicated host in your account." + }, + "HostResourceGroupArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host." + }, + "IamInstanceProfile": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The IAM instance profile." + }, + "ImageId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The ID of the AMI. An AMI ID is required to launch an instance and must be specified here or in a launch template." + }, + "InstanceId": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "The EC2 Instance ID." + }, + "InstanceInitiatedShutdownBehavior": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown)." + }, + "InstanceType": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The instance type." + }, + "Ipv6AddressCount": { + "type": { + "$ref": "#/5" + }, + "flags": 4, + "description": "[EC2-VPC] The number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet." + }, + "Ipv6Addresses": { + "type": { + "$ref": "#/171" + }, + "flags": 4, + "description": "[EC2-VPC] The IPv6 addresses from the range of the subnet to associate with the primary network interface." + }, + "KernelId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The ID of the kernel." + }, + "KeyName": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The name of the key pair." + }, + "LaunchTemplate": { + "type": { + "$ref": "#/172" + }, + "flags": 0, + "description": "The launch template to use to launch the instances." + }, + "LicenseSpecifications": { + "type": { + "$ref": "#/173" + }, + "flags": 0, + "description": "The license configurations." + }, + "Monitoring": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Specifies whether detailed monitoring is enabled for the instance." + }, + "NetworkInterfaces": { + "type": { + "$ref": "#/174" + }, + "flags": 0, + "description": "The network interfaces to associate with the instance." + }, + "PlacementGroupName": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The name of an existing placement group that you want to launch the instance into (cluster | partition | spread)." + }, + "PrivateDnsName": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The private DNS name of the specified instance. For example: ip-10-24-34-0.ec2.internal." + }, + "PrivateDnsNameOptions": { + "type": { + "$ref": "#/175" + }, + "flags": 0, + "description": "The options for the instance hostname." + }, + "PrivateIp": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The private IP address of the specified instance. For example: 10.24.34.0." + }, + "PrivateIpAddress": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "[EC2-VPC] The primary IPv4 address. You must specify a value from the IPv4 address range of the subnet." + }, + "PropagateTagsToVolumeOnCreation": { + "type": { + "$ref": "#/6" + }, + "flags": 4, + "description": "Indicates whether to assign the tags from the instance to all of the volumes attached to the instance at launch. If you specify true and you assign tags to the instance, those tags are automatically assigned to all of the volumes that you attach to the instance at launch. If you specify false, those tags are not assigned to the attached volumes." + }, + "PublicDnsName": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The public DNS name of the specified instance. For example: ec2-107-20-50-45.compute-1.amazonaws.com." + }, + "PublicIp": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The public IP address of the specified instance. For example: 192.0.2.0." + }, + "RamdiskId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The ID of the RAM disk to select." + }, + "SecurityGroupIds": { + "type": { + "$ref": "#/176" + }, + "flags": 0, + "description": "The IDs of the security groups." + }, + "SecurityGroups": { + "type": { + "$ref": "#/177" + }, + "flags": 0, + "description": "the names of the security groups. For a nondefault VPC, you must use security group IDs instead." + }, + "SourceDestCheck": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Specifies whether to enable an instance launched in a VPC to perform NAT." + }, + "SsmAssociations": { + "type": { + "$ref": "#/178" + }, + "flags": 0, + "description": "The SSM document and parameter values in AWS Systems Manager to associate with this instance." + }, + "State": { + "type": { + "$ref": "#/179" + }, + "flags": 2, + "description": "The current state of the instance." + }, + "SubnetId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "[EC2-VPC] The ID of the subnet to launch the instance into.\n\n" + }, + "Tags": { + "type": { + "$ref": "#/180" + }, + "flags": 0, + "description": "The tags to add to the instance." + }, + "Tenancy": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware." + }, + "UserData": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The user data to make available to the instance." + }, + "Volumes": { + "type": { + "$ref": "#/181" + }, + "flags": 0, + "description": "The volumes to attach to the instance." + }, + "VpcId": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The ID of the VPC that the instance is running in." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/Instance", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/182" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/Instance@default", + "scopeType": 0, + "body": { + "$ref": "#/183" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "SecurityGroupId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/InstanceConnectEndpointProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/186" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/InstanceConnectEndpointProperties", + "properties": { + "ClientToken": { + "type": { + "$ref": "#/2" + }, + "flags": 4, + "description": "The client token of the instance connect endpoint." + }, + "Id": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "The id of the instance connect endpoint" + }, + "PreserveClientIp": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "If true, the address of the instance connect endpoint client is preserved when connecting to the end resource" + }, + "SecurityGroupIds": { + "type": { + "$ref": "#/188" + }, + "flags": 0, + "description": "The security group IDs of the instance connect endpoint." + }, + "SubnetId": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The subnet id of the instance connect endpoint" + }, + "Tags": { + "type": { + "$ref": "#/189" + }, + "flags": 0, + "description": "The tags of the instance connect endpoint." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/InstanceConnectEndpoint", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/190" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/InstanceConnectEndpoint@default", + "scopeType": 0, + "body": { + "$ref": "#/191" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The tag key." + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The tag value." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/InternetGatewayProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/193" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/InternetGatewayProperties", + "properties": { + "InternetGatewayId": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "" + }, + "Tags": { + "type": { + "$ref": "#/195" + }, + "flags": 0, + "description": "Any tags to assign to the internet gateway." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/InternetGateway", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/196" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/InternetGateway@default", + "scopeType": 0, + "body": { + "$ref": "#/197" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AcceleratorCount", + "properties": { + "Max": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The maximum number of accelerators. To specify no maximum limit, omit this parameter. To exclude accelerator-enabled instance types, set ``Max`` to ``0``." + }, + "Min": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The minimum number of accelerators. To specify no minimum limit, omit this parameter." + } + } + }, + { + "$type": "ObjectType", + "name": "AcceleratorTotalMemoryMiB", + "properties": { + "Max": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The maximum amount of accelerator memory, in MiB. To specify no maximum limit, omit this parameter." + }, + "Min": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The minimum amount of accelerator memory, in MiB. To specify no minimum limit, omit this parameter." + } + } + }, + { + "$type": "ObjectType", + "name": "BaselineEbsBandwidthMbps", + "properties": { + "Max": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The maximum baseline bandwidth, in Mbps. To specify no maximum limit, omit this parameter." + }, + "Min": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The minimum baseline bandwidth, in Mbps. To specify no minimum limit, omit this parameter." + } + } + }, + { + "$type": "ObjectType", + "name": "BlockDeviceMapping", + "properties": { + "DeviceName": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The device name (for example, /dev/sdh or xvdh)." + }, + "Ebs": { + "type": { + "$ref": "#/208" + }, + "flags": 0, + "description": "Parameters used to automatically set up EBS volumes when the instance is launched." + }, + "NoDevice": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "To omit the device from the block device mapping, specify an empty string." + }, + "VirtualName": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume." + } + } + }, + { + "$type": "ObjectType", + "name": "CapacityReservationSpecification", + "properties": { + "CapacityReservationPreference": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "Indicates the instance's Capacity Reservation preferences. Possible preferences include:\n + ``open`` - The instance can run in any ``open`` Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).\n + ``none`` - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity." + }, + "CapacityReservationTarget": { + "type": { + "$ref": "#/204" + }, + "flags": 0, + "description": "Information about the target Capacity Reservation or Capacity Reservation group." + } + } + }, + { + "$type": "ObjectType", + "name": "CapacityReservationTarget", + "properties": { + "CapacityReservationId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The ID of the Capacity Reservation in which to run the instance." + }, + "CapacityReservationResourceGroupArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The ARN of the Capacity Reservation resource group in which to run the instance." + } + } + }, + { + "$type": "ObjectType", + "name": "ConnectionTrackingSpecification", + "properties": { + "TcpEstablishedTimeout": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "Timeout (in seconds) for idle TCP connections in an established state. Min: 60 seconds. Max: 432000 seconds (5 days). Default: 432000 seconds. Recommended: Less than 432000 seconds." + }, + "UdpStreamTimeout": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "Timeout (in seconds) for idle UDP flows classified as streams which have seen more than one request-response transaction. Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180 seconds." + }, + "UdpTimeout": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "Timeout (in seconds) for idle UDP flows that have seen traffic only in a single direction or a single request-response transaction. Min: 30 seconds. Max: 60 seconds. Default: 30 seconds." + } + } + }, + { + "$type": "ObjectType", + "name": "CpuOptions", + "properties": { + "AmdSevSnp": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "Indicates whether to enable the instance for AMD SEV-SNP. AMD SEV-SNP is supported with M6a, R6a, and C6a instance types only. For more information, see [AMD SEV-SNP](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/sev-snp.html)." + }, + "CoreCount": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The number of CPU cores for the instance." + }, + "ThreadsPerCore": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The number of threads per CPU core. To disable multithreading for the instance, specify a value of ``1``. Otherwise, specify the default value of ``2``." + } + } + }, + { + "$type": "ObjectType", + "name": "CreditSpecification", + "properties": { + "CpuCredits": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The credit option for CPU usage of a T instance.\n Valid values: ``standard`` | ``unlimited``" + } + } + }, + { + "$type": "ObjectType", + "name": "Ebs", + "properties": { + "DeleteOnTermination": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Indicates whether the EBS volume is deleted on instance termination." + }, + "Encrypted": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value." + }, + "Iops": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The number of I/O operations per second (IOPS). For ``gp3``, ``io1``, and ``io2`` volumes, this represents the number of IOPS that are provisioned for the volume. For ``gp2`` volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.\n The 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\n \n For ``io2`` volumes, you can achieve up to 256,000 IOPS on [instances built 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.\n This parameter is supported for ``io1``, ``io2``, and ``gp3`` volumes only." + }, + "KmsKeyId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The ARN of the symmetric KMSlong (KMS) CMK used for encryption." + }, + "SnapshotId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The ID of the snapshot." + }, + "Throughput": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The throughput to provision for a ``gp3`` volume, with a maximum of 1,000 MiB/s.\n Valid Range: Minimum value of 125. Maximum value of 1000." + }, + "VolumeSize": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. The following are the supported volumes sizes for each volume type:\n + ``gp2`` and ``gp3``: 1 - 16,384 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" + }, + "VolumeType": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The volume type. For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volume-types.html) in the *Amazon EBS User Guide*." + } + } + }, + { + "$type": "ObjectType", + "name": "ElasticGpuSpecification", + "properties": { + "Type": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The type of Elastic Graphics accelerator. For more information about the values to specify for ``Type``, see [Elastic Graphics Basics](https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/elastic-graphics.html#elastic-graphics-basics), specifically the Elastic Graphics accelerator column, in the *Amazon Elastic Compute Cloud User Guide for Windows Instances*." + } + } + }, + { + "$type": "ObjectType", + "name": "EnaSrdSpecification", + "properties": { + "EnaSrdEnabled": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Indicates whether ENA Express is enabled for the network interface." + }, + "EnaSrdUdpSpecification": { + "type": { + "$ref": "#/211" + }, + "flags": 0, + "description": "Configures ENA Express for UDP network traffic." + } + } + }, + { + "$type": "ObjectType", + "name": "EnaSrdUdpSpecification", + "properties": { + "EnaSrdUdpEnabled": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Indicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting, you must first enable ENA Express." + } + } + }, + { + "$type": "ObjectType", + "name": "EnclaveOptions", + "properties": { + "Enabled": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "If this parameter is set to ``true``, the instance is enabled for AWS Nitro Enclaves; otherwise, it is not enabled for AWS Nitro Enclaves." + } + } + }, + { + "$type": "ObjectType", + "name": "HibernationOptions", + "properties": { + "Configured": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "If you set this parameter to ``true``, the instance is enabled for hibernation.\n Default: ``false``" + } + } + }, + { + "$type": "ObjectType", + "name": "IamInstanceProfile", + "properties": { + "Arn": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the instance profile." + }, + "Name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The name of the instance profile." + } + } + }, + { + "$type": "ObjectType", + "name": "InstanceMarketOptions", + "properties": { + "MarketType": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The market type." + }, + "SpotOptions": { + "type": { + "$ref": "#/235" + }, + "flags": 0, + "description": "The options for Spot Instances." + } + } + }, + { + "$type": "ObjectType", + "name": "InstanceRequirements", + "properties": { + "AcceleratorCount": { + "type": { + "$ref": "#/199" + }, + "flags": 0, + "description": "The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) on an instance.\n To exclude accelerator-enabled instance types, set ``Max`` to ``0``.\n Default: No minimum or maximum limits" + }, + "AcceleratorManufacturers": { + "type": { + "$ref": "#/240" + }, + "flags": 0, + "description": "Indicates 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``.\n \n Default: Any manufacturer" + }, + "AcceleratorNames": { + "type": { + "$ref": "#/241" + }, + "flags": 0, + "description": "The 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 NVIDIA GRID K520 GPUs, specify ``k520``.\n + For instance types with NVIDIA K80 GPUs, specify ``k80``.\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 NVIDIA T4 GPUs, specify ``t4``.\n + For instance types with NVIDIA T4G GPUs, specify ``t4g``.\n + For instance types with Xilinx VU9P FPGAs, specify ``vu9p``.\n + For instance types with NVIDIA V100 GPUs, specify ``v100``.\n \n Default: Any accelerator" + }, + "AcceleratorTotalMemoryMiB": { + "type": { + "$ref": "#/200" + }, + "flags": 0, + "description": "The minimum and maximum amount of total accelerator memory, in MiB.\n Default: No minimum or maximum limits" + }, + "AcceleratorTypes": { + "type": { + "$ref": "#/242" + }, + "flags": 0, + "description": "The accelerator types that must be on the 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 ``inference``.\n \n Default: Any accelerator type" + }, + "AllowedInstanceTypes": { + "type": { + "$ref": "#/243" + }, + "flags": 0, + "description": "The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes.\n You can use strings with one or more wild cards, represented by an asterisk (``*``), to allow an instance type, size, or generation. The following are examples: ``m5.8xlarge``, ``c5*.*``, ``m5a.*``, ``r*``, ``*3*``.\n For example, if you specify ``c5*``,Amazon EC2 will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify ``m5a.*``, Amazon EC2 will allow all the M5a instance types, but not the M5n instance types.\n If you specify ``AllowedInstanceTypes``, you can't specify ``ExcludedInstanceTypes``.\n Default: All instance types" + }, + "BareMetal": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "Indicates 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``.\n \n Default: ``excluded``" + }, + "BaselineEbsBandwidthMbps": { + "type": { + "$ref": "#/201" + }, + "flags": 0, + "description": "The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see [Amazon EBS–optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the *Amazon EC2 User Guide*.\n Default: No minimum or maximum limits" + }, + "BurstablePerformance": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see [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``.\n \n Default: ``excluded``" + }, + "CpuManufacturers": { + "type": { + "$ref": "#/244" + }, + "flags": 0, + "description": "The 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 \n Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template.\n Default: Any manufacturer" + }, + "ExcludedInstanceTypes": { + "type": { + "$ref": "#/245" + }, + "flags": 0, + "description": "The instance types to exclude.\n You can use strings with one or more wild cards, represented by an asterisk (``*``), to exclude an instance type, size, or generation. The following are examples: ``m5.8xlarge``, ``c5*.*``, ``m5a.*``, ``r*``, ``*3*``.\n For example, if you specify ``c5*``,Amazon EC2 will exclude the entire C5 instance family, which includes all C5a and C5n instance types. If you specify ``m5a.*``, Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types.\n If you specify ``ExcludedInstanceTypes``, you can't specify ``AllowedInstanceTypes``.\n Default: No excluded instance types" + }, + "InstanceGenerations": { + "type": { + "$ref": "#/246" + }, + "flags": 0, + "description": "Indicates whether current or previous generation instance types are included. The current generation instance types are recommended for use. Current generation instance types are typically the latest two to three generations in each instance family. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide*.\n For current generation instance types, specify ``current``.\n For previous generation instance types, specify ``previous``.\n Default: Current and previous generation instance types" + }, + "LocalStorage": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, [Amazon EC2 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 ``included``.\n + To require only instance types with instance store volumes, specify ``required``.\n + To exclude instance types with instance store volumes, specify ``excluded``.\n \n Default: ``included``" + }, + "LocalStorageTypes": { + "type": { + "$ref": "#/247" + }, + "flags": 0, + "description": "The 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 ``ssd``.\n \n Default: ``hdd`` and ``ssd``" + }, + "MaxSpotPriceAsPercentageOfOptimalOnDemandPrice": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "[Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold.\n The parameter accepts an integer, which Amazon EC2 interprets as a percentage.\n If you set ``DesiredCapacityType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is based on the per vCPU or per memory price instead of the per instance price.\n Only one of ``SpotMaxPricePercentageOverLowestPrice`` or ``MaxSpotPriceAsPercentageOfOptimalOnDemandPrice`` can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as ``999999``." + }, + "MemoryGiBPerVCpu": { + "type": { + "$ref": "#/225" + }, + "flags": 0, + "description": "The minimum and maximum amount of memory per vCPU, in GiB.\n Default: No minimum or maximum limits" + }, + "MemoryMiB": { + "type": { + "$ref": "#/226" + }, + "flags": 0, + "description": "The minimum and maximum amount of memory, in MiB." + }, + "NetworkBandwidthGbps": { + "type": { + "$ref": "#/229" + }, + "flags": 0, + "description": "The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).\n Default: No minimum or maximum limits" + }, + "NetworkInterfaceCount": { + "type": { + "$ref": "#/231" + }, + "flags": 0, + "description": "The minimum and maximum number of network interfaces.\n Default: No minimum or maximum limits" + }, + "OnDemandMaxPricePercentageOverLowestPrice": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "[Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold.\n The parameter accepts an integer, which Amazon EC2 interprets as a percentage.\n To turn off price protection, specify a high value, such as ``999999``.\n This 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 If you set ``TargetCapacityUnitType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.\n Default: ``20``" + }, + "RequireHibernateSupport": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Indicates whether instance types must support hibernation for On-Demand Instances.\n This parameter is not supported for [GetSpotPlacementScores](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html).\n Default: ``false``" + }, + "SpotMaxPricePercentageOverLowestPrice": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "[Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the Spot price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified Spot price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose Spot price exceeds your specified threshold.\n The parameter accepts an integer, which Amazon EC2 interprets as a percentage.\n If you set ``TargetCapacityUnitType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.\n This 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 Only one of ``SpotMaxPricePercentageOverLowestPrice`` or ``MaxSpotPriceAsPercentageOfOptimalOnDemandPrice`` can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as ``999999``.\n Default: ``100``" + }, + "TotalLocalStorageGB": { + "type": { + "$ref": "#/238" + }, + "flags": 0, + "description": "The minimum and maximum amount of total local storage, in GB.\n Default: No minimum or maximum limits" + }, + "VCpuCount": { + "type": { + "$ref": "#/239" + }, + "flags": 0, + "description": "The minimum and maximum number of vCPUs." + } + } + }, + { + "$type": "ObjectType", + "name": "Ipv4PrefixSpecification", + "properties": { + "Ipv4Prefix": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The IPv4 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 *Amazon Elastic Compute Cloud User Guide*." + } + } + }, + { + "$type": "ObjectType", + "name": "Ipv6Add", + "properties": { + "Ipv6Address": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses." + } + } + }, + { + "$type": "ObjectType", + "name": "Ipv6PrefixSpecification", + "properties": { + "Ipv6Prefix": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The IPv6 prefix." + } + } + }, + { + "$type": "ObjectType", + "name": "LaunchTemplateData", + "properties": { + "BlockDeviceMappings": { + "type": { + "$ref": "#/248" + }, + "flags": 0, + "description": "The block device mapping." + }, + "CapacityReservationSpecification": { + "type": { + "$ref": "#/203" + }, + "flags": 0, + "description": "The Capacity Reservation targeting option. If you do not specify this parameter, the instance's Capacity Reservation preference defaults to ``open``, which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone)." + }, + "CpuOptions": { + "type": { + "$ref": "#/206" + }, + "flags": 0, + "description": "The CPU options for the instance. For more information, see [Optimizing CPU Options](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html) in the *Amazon Elastic Compute Cloud User Guide*." + }, + "CreditSpecification": { + "type": { + "$ref": "#/207" + }, + "flags": 0, + "description": "The credit option for CPU usage of the instance. Valid only for T instances." + }, + "DisableApiStop": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Indicates whether to enable the instance for stop protection. For more information, see [Stop protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Stop_Start.html#Using_StopProtection) in the *Amazon Elastic Compute Cloud User Guide*." + }, + "DisableApiTermination": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "If you set this parameter to ``true``, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch, use [ModifyInstanceAttribute](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyInstanceAttribute.html). Alternatively, if you set ``InstanceInitiatedShutdownBehavior`` to ``terminate``, you can terminate the instance by running the shutdown command from the instance." + }, + "EbsOptimized": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance." + }, + "ElasticGpuSpecifications": { + "type": { + "$ref": "#/249" + }, + "flags": 0, + "description": "Deprecated.\n Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, G4dn, or G5 instances." + }, + "ElasticInferenceAccelerators": { + "type": { + "$ref": "#/250" + }, + "flags": 0, + "description": "An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads.\n You cannot specify accelerators from different generations in the same request.\n Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service." + }, + "EnclaveOptions": { + "type": { + "$ref": "#/212" + }, + "flags": 0, + "description": "Indicates whether the instance is enabled for AWS Nitro Enclaves. For more information, see [What is Nitro Enclaves?](https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave.html) in the *Nitro Enclaves User Guide*.\n You can't enable AWS Nitro Enclaves and hibernation on the same instance." + }, + "HibernationOptions": { + "type": { + "$ref": "#/213" + }, + "flags": 0, + "description": "Indicates whether an instance is enabled for hibernation. This parameter is valid only if the instance meets the [hibernation prerequisites](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/hibernating-prerequisites.html). For more information, see [Hibernate your instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html) in the *Amazon Elastic Compute Cloud User Guide*." + }, + "IamInstanceProfile": { + "type": { + "$ref": "#/214" + }, + "flags": 0, + "description": "The name or Amazon Resource Name (ARN) of an IAM instance profile." + }, + "ImageId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The ID of the AMI. Alternatively, you can specify a Systems Manager parameter, which will resolve to an AMI ID on launch.\n Valid formats:\n + ``ami-17characters00000`` \n + ``resolve:ssm:parameter-name`` \n + ``resolve:ssm:parameter-name:version-number`` \n + ``resolve:ssm:parameter-name:label`` \n \n For 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*." + }, + "InstanceInitiatedShutdownBehavior": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).\n Default: ``stop``" + }, + "InstanceMarketOptions": { + "type": { + "$ref": "#/215" + }, + "flags": 0, + "description": "The market (purchasing) option for the instances." + }, + "InstanceRequirements": { + "type": { + "$ref": "#/216" + }, + "flags": 0, + "description": "The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.\n You must specify ``VCpuCount`` and ``MemoryMiB``. All other attributes are optional. Any unspecified optional attribute is set to its default.\n When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values.\n To limit the list of instance types from which Amazon EC2 can identify matching instance types, you 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 other instance types are ignored, even if they match your specified attributes.\n + ``ExcludedInstanceTypes`` - The instance types to exclude from the list, even if they match your specified attributes.\n \n If you specify ``InstanceRequirements``, you can't specify ``InstanceType``.\n Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the [launch instance wizard](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 [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) AWS CloudFormation resource, you can't specify ``InstanceRequirements``.\n For more information, see [Attribute-based instance type selection for EC2 Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html), [Attribute-based instance type selection for Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-attribute-based-instance-type-selection.html), and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*." + }, + "InstanceType": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The instance type. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon Elastic Compute Cloud User Guide*.\n If you specify ``InstanceType``, you can't specify ``InstanceRequirements``." + }, + "KernelId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The ID of the kernel.\n We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see [User Provided Kernels](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html) in the *Amazon EC2 User Guide*." + }, + "KeyName": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The name of the key pair. You can create a key pair using [CreateKeyPair](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateKeyPair.html) or [ImportKeyPair](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportKeyPair.html).\n If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in." + }, + "LicenseSpecifications": { + "type": { + "$ref": "#/251" + }, + "flags": 0, + "description": "The license configurations." + }, + "MaintenanceOptions": { + "type": { + "$ref": "#/224" + }, + "flags": 0, + "description": "The maintenance options of your instance." + }, + "MetadataOptions": { + "type": { + "$ref": "#/227" + }, + "flags": 0, + "description": "The 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 *Amazon Elastic Compute Cloud User Guide*." + }, + "Monitoring": { + "type": { + "$ref": "#/228" + }, + "flags": 0, + "description": "The monitoring for the instance." + }, + "NetworkInterfaces": { + "type": { + "$ref": "#/252" + }, + "flags": 0, + "description": "The network interfaces for the instance." + }, + "Placement": { + "type": { + "$ref": "#/232" + }, + "flags": 0, + "description": "The placement for the instance." + }, + "PrivateDnsNameOptions": { + "type": { + "$ref": "#/233" + }, + "flags": 0, + "description": "The 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 *User Guide*." + }, + "RamDiskId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The ID of the RAM disk.\n We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see [User provided kernels](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html) in the *Amazon Elastic Compute Cloud User Guide*." + }, + "SecurityGroupIds": { + "type": { + "$ref": "#/253" + }, + "flags": 0, + "description": "The IDs of the security groups. You can specify the IDs of existing security groups and references to resources created by the stack template.\n If you specify a network interface, you must specify any security groups as part of the network interface instead." + }, + "SecurityGroups": { + "type": { + "$ref": "#/254" + }, + "flags": 0, + "description": "The names of the security groups. For a nondefault VPC, you must use security group IDs instead.\n If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter." + }, + "TagSpecifications": { + "type": { + "$ref": "#/255" + }, + "flags": 0, + "description": "The tags to apply to the resources that are created during instance launch.\n To tag a resource after it has been created, see [CreateTags](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html).\n To tag the launch template itself, use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-tagspecifications)." + }, + "UserData": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The user data to make available to the instance. You must provide base64-encoded text. User data is limited to 16 KB. For more information, see [Run commands on your Linux instance at launch](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html) (Linux) or [Work with instance user data](https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/instancedata-add-user-data.html) (Windows) in the *Amazon Elastic Compute Cloud User Guide*.\n If you are creating the launch template for use with BATCH, the user data must be provided in the [MIME multi-part archive format](https://docs.aws.amazon.com/https://cloudinit.readthedocs.io/en/latest/topics/format.html#mime-multi-part-archive). For more information, see [Amazon EC2 user data in launch templates](https://docs.aws.amazon.com/batch/latest/userguide/launch-templates.html) in the *User Guide*." + } + } + }, + { + "$type": "ObjectType", + "name": "LaunchTemplateElasticInferenceAccelerator", + "properties": { + "Count": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The number of elastic inference accelerators to attach to the instance. \n Default: 1" + }, + "Type": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The type of elastic inference accelerator. The possible values are eia1.medium, eia1.large, and eia1.xlarge." + } + } + }, + { + "$type": "ObjectType", + "name": "LaunchTemplateTagSpecification", + "properties": { + "ResourceType": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The type of resource. To tag the launch template, ``ResourceType`` must be ``launch-template``." + }, + "Tags": { + "type": { + "$ref": "#/256" + }, + "flags": 0, + "description": "The tags for the resource." + } + } + }, + { + "$type": "ObjectType", + "name": "LicenseSpecification", + "properties": { + "LicenseConfigurationArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the license configuration." + } + } + }, + { + "$type": "ObjectType", + "name": "MaintenanceOptions", + "properties": { + "AutoRecovery": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "Disables the automatic recovery behavior of your instance or sets it to default." + } + } + }, + { + "$type": "ObjectType", + "name": "MemoryGiBPerVCpu", + "properties": { + "Max": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The maximum amount of memory per vCPU, in GiB. To specify no maximum limit, omit this parameter." + }, + "Min": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The minimum amount of memory per vCPU, in GiB. To specify no minimum limit, omit this parameter." + } + } + }, + { + "$type": "ObjectType", + "name": "MemoryMiB", + "properties": { + "Max": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The maximum amount of memory, in MiB. To specify no maximum limit, omit this parameter." + }, + "Min": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The minimum amount of memory, in MiB. To specify no minimum limit, specify ``0``." + } + } + }, + { + "$type": "ObjectType", + "name": "MetadataOptions", + "properties": { + "HttpEndpoint": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "Enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is ``enabled``.\n If you specify a value of ``disabled``, you will not be able to access your instance metadata." + }, + "HttpProtocolIpv6": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "Enables or disables the IPv6 endpoint for the instance metadata service.\n Default: ``disabled``" + }, + "HttpPutResponseHopLimit": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.\n Default: ``1`` \n Possible values: Integers from 1 to 64" + }, + "HttpTokens": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "Indicates whether IMDSv2 is required.\n + ``optional`` - IMDSv2 is optional. You can choose whether to send a session token in your instance metadata retrieval requests. If you retrieve IAM role credentials without a session token, you receive the IMDSv1 role credentials. If you retrieve IAM role credentials using a valid session token, you receive the IMDSv2 role credentials.\n + ``required`` - IMDSv2 is required. You must send a session token in your instance metadata retrieval requests. With this option, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available.\n \n Default: If the value of ``ImdsSupport`` for the Amazon Machine Image (AMI) for your instance is ``v2.0``, the default is ``required``." + }, + "InstanceMetadataTags": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "Set to ``enabled`` to allow access to instance tags from the instance metadata. Set to ``disabled`` to turn off access to instance tags from the instance metadata. For more information, see [Work with instance tags using the instance metadata](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#work-with-tags-in-IMDS).\n Default: ``disabled``" + } + } + }, + { + "$type": "ObjectType", + "name": "Monitoring", + "properties": { + "Enabled": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Specify ``true`` to enable detailed monitoring. Otherwise, basic monitoring is enabled." + } + } + }, + { + "$type": "ObjectType", + "name": "NetworkBandwidthGbps", + "properties": { + "Max": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The maximum amount of network bandwidth, in Gbps. To specify no maximum limit, omit this parameter." + }, + "Min": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The minimum amount of network bandwidth, in Gbps. If this parameter is not specified, there is no minimum limit." + } + } + }, + { + "$type": "ObjectType", + "name": "NetworkInterface", + "properties": { + "AssociateCarrierIpAddress": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Associates a Carrier IP address with eth0 for a new network interface.\n Use this option when you launch an instance in a Wavelength Zone and want to associate a Carrier IP address with the network interface. For more information about Carrier IP addresses, see [Carrier IP addresses](https://docs.aws.amazon.com/wavelength/latest/developerguide/how-wavelengths-work.html#provider-owned-ip) in the *Developer Guide*." + }, + "AssociatePublicIpAddress": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Associates a public IPv4 address with eth0 for a new network interface.\n AWS charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the *Public IPv4 Address* tab on the [Amazon VPC pricing page](https://docs.aws.amazon.com/vpc/pricing/)." + }, + "ConnectionTrackingSpecification": { + "type": { + "$ref": "#/205" + }, + "flags": 0, + "description": "A connection tracking specification for the network interface." + }, + "DeleteOnTermination": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Indicates whether the network interface is deleted when the instance is terminated." + }, + "Description": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "A description for the network interface." + }, + "DeviceIndex": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The device index for the network interface attachment. Each network interface requires a device index. If you create a launch template that includes secondary network interfaces but not a primary network interface, then you must add a primary network interface as a launch parameter when you launch an instance from the template." + }, + "EnaSrdSpecification": { + "type": { + "$ref": "#/210" + }, + "flags": 0, + "description": "The ENA Express configuration for the network interface." + }, + "Groups": { + "type": { + "$ref": "#/257" + }, + "flags": 0, + "description": "The IDs of one or more security groups." + }, + "InterfaceType": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The type of network interface. To create an Elastic Fabric Adapter (EFA), specify ``efa``. For more information, see [Elastic Fabric Adapter](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa.html) in the *Amazon Elastic Compute Cloud User Guide*.\n If you are not creating an EFA, specify ``interface`` or omit this parameter.\n Valid values: ``interface`` | ``efa``" + }, + "Ipv4PrefixCount": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The number of IPv4 prefixes to be automatically assigned to the network interface. You cannot use this option if you use the ``Ipv4Prefix`` option." + }, + "Ipv4Prefixes": { + "type": { + "$ref": "#/258" + }, + "flags": 0, + "description": "One or more IPv4 prefixes to be assigned to the network interface. You cannot use this option if you use the ``Ipv4PrefixCount`` option." + }, + "Ipv6AddressCount": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses." + }, + "Ipv6Addresses": { + "type": { + "$ref": "#/259" + }, + "flags": 0, + "description": "One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses." + }, + "Ipv6PrefixCount": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The number of IPv6 prefixes to be automatically assigned to the network interface. You cannot use this option if you use the ``Ipv6Prefix`` option." + }, + "Ipv6Prefixes": { + "type": { + "$ref": "#/260" + }, + "flags": 0, + "description": "One or more IPv6 prefixes to be assigned to the network interface. You cannot use this option if you use the ``Ipv6PrefixCount`` option." + }, + "NetworkCardIndex": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The index of the network card. Some instance types support multiple network cards. The primary network interface must be assigned to network card index 0. The default is network card index 0." + }, + "NetworkInterfaceId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The ID of the network interface." + }, + "PrimaryIpv6": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "The primary IPv6 address of the network interface. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information about primary IPv6 addresses, see [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html)." + }, + "PrivateIpAddress": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The primary private IPv4 address of the network interface." + }, + "PrivateIpAddresses": { + "type": { + "$ref": "#/261" + }, + "flags": 0, + "description": "One or more private IPv4 addresses." + }, + "SecondaryPrivateIpAddressCount": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The number of secondary private IPv4 addresses to assign to a network interface." + }, + "SubnetId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The ID of the subnet for the network interface." + } + } + }, + { + "$type": "ObjectType", + "name": "NetworkInterfaceCount", + "properties": { + "Max": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The maximum number of network interfaces. To specify no maximum limit, omit this parameter." + }, + "Min": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The minimum number of network interfaces. To specify no minimum limit, omit this parameter." + } + } + }, + { + "$type": "ObjectType", + "name": "Placement", + "properties": { + "Affinity": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The affinity setting for an instance on a Dedicated Host." + }, + "AvailabilityZone": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The Availability Zone for the instance." + }, + "GroupId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The Group Id of a placement group. You must specify the Placement Group *Group Id* to launch an instance in a shared placement group." + }, + "GroupName": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The name of the placement group for the instance." + }, + "HostId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The ID of the Dedicated Host for the instance." + }, + "HostResourceGroupArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the *Tenancy* parameter or set it to ``host``." + }, + "PartitionNumber": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The number of the partition the instance should launch in. Valid only if the placement group strategy is set to ``partition``." + }, + "SpreadDomain": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "Reserved for future use." + }, + "Tenancy": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware." + } + } + }, + { + "$type": "ObjectType", + "name": "PrivateDnsNameOptions", + "properties": { + "EnableResourceNameDnsAAAARecord": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records." + }, + "EnableResourceNameDnsARecord": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Indicates whether to respond to DNS queries for instance hostnames with DNS A records." + }, + "HostnameType": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The type of hostname for EC2 instances. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names 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 *User Guide*." + } + } + }, + { + "$type": "ObjectType", + "name": "PrivateIpAdd", + "properties": { + "Primary": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary." + }, + "PrivateIpAddress": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The private IPv4 address." + } + } + }, + { + "$type": "ObjectType", + "name": "SpotOptions", + "properties": { + "BlockDurationMinutes": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "Deprecated." + }, + "InstanceInterruptionBehavior": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The behavior when a Spot Instance is interrupted. The default is ``terminate``." + }, + "MaxPrice": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The maximum hourly price you're willing to pay for the Spot Instances. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.\n If you specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter." + }, + "SpotInstanceType": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The Spot Instance request type.\n If you are using Spot Instances with an Auto Scaling group, use ``one-time`` requests, as the ASlong service handles requesting new Spot Instances whenever the group is below its desired capacity." + }, + "ValidUntil": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The end date of the request, in UTC format (*YYYY-MM-DD*T*HH:MM:SS*Z). Supported only for persistent requests.\n + For a persistent request, the request remains active until the ``ValidUntil`` date and time is reached. Otherwise, the request remains active until you cancel it.\n + For a one-time request, ``ValidUntil`` is not supported. The request remains active until all instances launch or you cancel the request.\n \n Default: 7 days from the current date" + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The tag key." + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The tag value." + } + } + }, + { + "$type": "ObjectType", + "name": "TagSpecification", + "properties": { + "ResourceType": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The type of resource to tag.\n Valid Values lists all resource types for Amazon EC2 that can be tagged. When you create a launch template, you can specify tags for the following resource types only: ``instance`` | ``volume`` | ``network-interface`` | ``spot-instances-request``. If the instance does not include the resource type that you specify, the instance launch fails. For example, not all instance types include a volume.\n To tag a resource after it has been created, see [CreateTags](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html)." + }, + "Tags": { + "type": { + "$ref": "#/262" + }, + "flags": 0, + "description": "The tags to apply to the resource." + } + } + }, + { + "$type": "ObjectType", + "name": "TotalLocalStorageGB", + "properties": { + "Max": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The maximum amount of total local storage, in GB. To specify no maximum limit, omit this parameter." + }, + "Min": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The minimum amount of total local storage, in GB. To specify no minimum limit, omit this parameter." + } + } + }, + { + "$type": "ObjectType", + "name": "VCpuCount", + "properties": { + "Max": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The maximum number of vCPUs. To specify no maximum limit, omit this parameter." + }, + "Min": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The minimum number of vCPUs. To specify no minimum limit, specify ``0``." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/202" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/209" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/221" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/223" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/230" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/237" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/236" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/217" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/218" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/219" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/234" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/236" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/LaunchTemplateProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/222" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/LaunchTemplateProperties", + "properties": { + "DefaultVersionNumber": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "" + }, + "LatestVersionNumber": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "" + }, + "LaunchTemplateData": { + "type": { + "$ref": "#/220" + }, + "flags": 5, + "description": "The information for the launch template." + }, + "LaunchTemplateId": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "" + }, + "LaunchTemplateName": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "A name for the launch template." + }, + "TagSpecifications": { + "type": { + "$ref": "#/264" + }, + "flags": 4, + "description": "The tags to apply to the launch template on creation. To tag the launch template, the resource type must be ``launch-template``.\n To specify the tags for the resources that are created when an instance is launched, you must use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-tagspecifications)." + }, + "VersionDescription": { + "type": { + "$ref": "#/2" + }, + "flags": 4, + "description": "A description for the first version of the launch template." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/LaunchTemplate", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/265" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/LaunchTemplate@default", + "scopeType": 0, + "body": { + "$ref": "#/266" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/LocalGatewayRouteProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/LocalGatewayRouteProperties", + "properties": { + "DestinationCidrBlock": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "The CIDR block used for destination matches." + }, + "LocalGatewayRouteTableId": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "The ID of the local gateway route table." + }, + "LocalGatewayVirtualInterfaceGroupId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The ID of the virtual interface group." + }, + "NetworkInterfaceId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The ID of the network interface." + }, + "State": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The state of the route." + }, + "Type": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The route type." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/LocalGatewayRoute", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/269" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/LocalGatewayRoute@default", + "scopeType": 0, + "body": { + "$ref": "#/270" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tags", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/272" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/LocalGatewayRouteTableProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/272" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/LocalGatewayRouteTableProperties", + "properties": { + "LocalGatewayId": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The ID of the local gateway." + }, + "LocalGatewayRouteTableArn": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The ARN of the local gateway route table." + }, + "LocalGatewayRouteTableId": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "The ID of the local gateway route table." + }, + "Mode": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The mode of the local gateway route table." + }, + "OutpostArn": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The ARN of the outpost." + }, + "OwnerId": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The owner of the local gateway route table." + }, + "State": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The state of the local gateway route table." + }, + "Tags": { + "type": { + "$ref": "#/276" + }, + "flags": 0, + "description": "The tags for the local gateway route table." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/LocalGatewayRouteTable", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/277" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/LocalGatewayRouteTable@default", + "scopeType": 0, + "body": { + "$ref": "#/278" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tags", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/280" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/LocalGatewayRouteTableVPCAssociationProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/280" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/LocalGatewayRouteTableVPCAssociationProperties", + "properties": { + "LocalGatewayId": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The ID of the local gateway." + }, + "LocalGatewayRouteTableId": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The ID of the local gateway route table." + }, + "LocalGatewayRouteTableVpcAssociationId": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "The ID of the association." + }, + "State": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The state of the association." + }, + "Tags": { + "type": { + "$ref": "#/284" + }, + "flags": 0, + "description": "The tags for the association." + }, + "VpcId": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The ID of the VPC." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/LocalGatewayRouteTableVPCAssociation", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/285" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/LocalGatewayRouteTableVPCAssociation@default", + "scopeType": 0, + "body": { + "$ref": "#/286" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tags", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/288" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/LocalGatewayRouteTableVirtualInterfaceGroupAssociationProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/288" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/LocalGatewayRouteTableVirtualInterfaceGroupAssociationProperties", + "properties": { + "LocalGatewayId": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The ID of the local gateway." + }, + "LocalGatewayRouteTableArn": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The ARN of the local gateway route table." + }, + "LocalGatewayRouteTableId": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The ID of the local gateway route table." + }, + "LocalGatewayRouteTableVirtualInterfaceGroupAssociationId": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "The ID of the local gateway route table virtual interface group association." + }, + "LocalGatewayVirtualInterfaceGroupId": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The ID of the local gateway route table virtual interface group." + }, + "OwnerId": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The owner of the local gateway route table virtual interface group association." + }, + "State": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The state of the local gateway route table virtual interface group association." + }, + "Tags": { + "type": { + "$ref": "#/292" + }, + "flags": 0, + "description": "The tags for the local gateway route table virtual interface group association." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/LocalGatewayRouteTableVirtualInterfaceGroupAssociation", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/293" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/LocalGatewayRouteTableVirtualInterfaceGroupAssociation@default", + "scopeType": 0, + "body": { + "$ref": "#/294" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The tag key." + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The tag value." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/NatGatewayProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/296" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/NatGatewayProperties", + "properties": { + "AllocationId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "[Public NAT gateway only] The allocation ID of the Elastic IP address that's associated with the NAT gateway. This property is required for a public NAT gateway and cannot be specified with a private NAT gateway." + }, + "ConnectivityType": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "Indicates whether the NAT gateway supports public or private connectivity. The default is public connectivity." + }, + "MaxDrainDurationSeconds": { + "type": { + "$ref": "#/5" + }, + "flags": 4, + "description": "The maximum amount of time to wait (in seconds) before forcibly releasing the IP addresses if connections are still in progress. Default value is 350 seconds." + }, + "NatGatewayId": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "" + }, + "PrivateIpAddress": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The private IPv4 address to assign to the NAT gateway. If you don't provide an address, a private IPv4 address will be automatically assigned." + }, + "SecondaryAllocationIds": { + "type": { + "$ref": "#/298" + }, + "flags": 0, + "description": "Secondary EIP allocation IDs. For more information, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon VPC User Guide*." + }, + "SecondaryPrivateIpAddressCount": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "[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." + }, + "SecondaryPrivateIpAddresses": { + "type": { + "$ref": "#/299" + }, + "flags": 0, + "description": "Secondary private IPv4 addresses. For more information about secondary addresses, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon Virtual Private Cloud User Guide*.\n ``SecondaryPrivateIpAddressCount`` and ``SecondaryPrivateIpAddresses`` cannot be set at the same time." + }, + "SubnetId": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The ID of the subnet in which the NAT gateway is located." + }, + "Tags": { + "type": { + "$ref": "#/300" + }, + "flags": 0, + "description": "The tags for the NAT gateway." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/NatGateway", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/301" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/NatGateway@default", + "scopeType": 0, + "body": { + "$ref": "#/302" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The tag key." + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The tag value." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/NetworkAclProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/304" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/NetworkAclProperties", + "properties": { + "Id": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "" + }, + "Tags": { + "type": { + "$ref": "#/306" + }, + "flags": 0, + "description": "The tags for the network ACL." + }, + "VpcId": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The ID of the VPC for the network ACL." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/NetworkAcl", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/307" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/NetworkAcl@default", + "scopeType": 0, + "body": { + "$ref": "#/308" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AccessScopePathRequest", + "properties": { + "Destination": { + "type": { + "$ref": "#/312" + }, + "flags": 0 + }, + "Source": { + "type": { + "$ref": "#/312" + }, + "flags": 0 + }, + "ThroughResources": { + "type": { + "$ref": "#/317" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PacketHeaderStatementRequest", + "properties": { + "DestinationAddresses": { + "type": { + "$ref": "#/318" + }, + "flags": 0 + }, + "DestinationPorts": { + "type": { + "$ref": "#/319" + }, + "flags": 0 + }, + "DestinationPrefixLists": { + "type": { + "$ref": "#/320" + }, + "flags": 0 + }, + "Protocols": { + "type": { + "$ref": "#/321" + }, + "flags": 0 + }, + "SourceAddresses": { + "type": { + "$ref": "#/322" + }, + "flags": 0 + }, + "SourcePorts": { + "type": { + "$ref": "#/323" + }, + "flags": 0 + }, + "SourcePrefixLists": { + "type": { + "$ref": "#/324" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PathStatementRequest", + "properties": { + "PacketHeaderStatement": { + "type": { + "$ref": "#/311" + }, + "flags": 0 + }, + "ResourceStatement": { + "type": { + "$ref": "#/314" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Protocol", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ResourceStatementRequest", + "properties": { + "ResourceTypes": { + "type": { + "$ref": "#/325" + }, + "flags": 0 + }, + "Resources": { + "type": { + "$ref": "#/326" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ThroughResourcesStatementRequest", + "properties": { + "ResourceStatement": { + "type": { + "$ref": "#/314" + }, + "flags": 0 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/316" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/NetworkInsightsAccessScopeProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/310" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/310" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/315" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/NetworkInsightsAccessScopeProperties", + "properties": { + "CreatedDate": { + "type": { + "$ref": "#/2" + }, + "flags": 2 + }, + "ExcludePaths": { + "type": { + "$ref": "#/328" + }, + "flags": 4 + }, + "MatchPaths": { + "type": { + "$ref": "#/329" + }, + "flags": 4 + }, + "NetworkInsightsAccessScopeArn": { + "type": { + "$ref": "#/2" + }, + "flags": 2 + }, + "NetworkInsightsAccessScopeId": { + "type": { + "$ref": "#/2" + }, + "flags": 18 + }, + "Tags": { + "type": { + "$ref": "#/330" + }, + "flags": 0 + }, + "UpdatedDate": { + "type": { + "$ref": "#/2" + }, + "flags": 2 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/NetworkInsightsAccessScope", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/331" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/NetworkInsightsAccessScope@default", + "scopeType": 0, + "body": { + "$ref": "#/332" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/NetworkInsightsAccessScopeAnalysisProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/334" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/NetworkInsightsAccessScopeAnalysisProperties", + "properties": { + "AnalyzedEniCount": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "EndDate": { + "type": { + "$ref": "#/2" + }, + "flags": 2 + }, + "FindingsFound": { + "type": { + "$ref": "#/2" + }, + "flags": 2 + }, + "NetworkInsightsAccessScopeAnalysisArn": { + "type": { + "$ref": "#/2" + }, + "flags": 2 + }, + "NetworkInsightsAccessScopeAnalysisId": { + "type": { + "$ref": "#/2" + }, + "flags": 18 + }, + "NetworkInsightsAccessScopeId": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "StartDate": { + "type": { + "$ref": "#/2" + }, + "flags": 2 + }, + "Status": { + "type": { + "$ref": "#/2" + }, + "flags": 2 + }, + "StatusMessage": { + "type": { + "$ref": "#/2" + }, + "flags": 2 + }, + "Tags": { + "type": { + "$ref": "#/336" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/NetworkInsightsAccessScopeAnalysis", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/337" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/NetworkInsightsAccessScopeAnalysis@default", + "scopeType": 0, + "body": { + "$ref": "#/338" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AdditionalDetail", + "properties": { + "AdditionalDetailType": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Component": { + "type": { + "$ref": "#/343" + }, + "flags": 0 + }, + "LoadBalancers": { + "type": { + "$ref": "#/359" + }, + "flags": 0 + }, + "ServiceName": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AlternatePathHint", + "properties": { + "ComponentArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "ComponentId": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AnalysisAclRule", + "properties": { + "Cidr": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Egress": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "PortRange": { + "type": { + "$ref": "#/353" + }, + "flags": 0 + }, + "Protocol": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "RuleAction": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "RuleNumber": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AnalysisComponent", + "properties": { + "Arn": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Id": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AnalysisLoadBalancerListener", + "properties": { + "InstancePort": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "LoadBalancerPort": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AnalysisLoadBalancerTarget", + "properties": { + "Address": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "AvailabilityZone": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Instance": { + "type": { + "$ref": "#/343" + }, + "flags": 0 + }, + "Port": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AnalysisPacketHeader", + "properties": { + "DestinationAddresses": { + "type": { + "$ref": "#/360" + }, + "flags": 0 + }, + "DestinationPortRanges": { + "type": { + "$ref": "#/361" + }, + "flags": 0 + }, + "Protocol": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "SourceAddresses": { + "type": { + "$ref": "#/362" + }, + "flags": 0 + }, + "SourcePortRanges": { + "type": { + "$ref": "#/363" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AnalysisRouteTableRoute", + "properties": { + "NatGatewayId": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "NetworkInterfaceId": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Origin": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "State": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "TransitGatewayId": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "VpcPeeringConnectionId": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "destinationCidr": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "destinationPrefixListId": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "egressOnlyInternetGatewayId": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "gatewayId": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "instanceId": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AnalysisSecurityGroupRule", + "properties": { + "Cidr": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Direction": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "PortRange": { + "type": { + "$ref": "#/353" + }, + "flags": 0 + }, + "PrefixListId": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Protocol": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "SecurityGroupId": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Explanation", + "properties": { + "Acl": { + "type": { + "$ref": "#/343" + }, + "flags": 0 + }, + "AclRule": { + "type": { + "$ref": "#/342" + }, + "flags": 0 + }, + "Address": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Addresses": { + "type": { + "$ref": "#/364" + }, + "flags": 0 + }, + "AttachedTo": { + "type": { + "$ref": "#/343" + }, + "flags": 0 + }, + "AvailabilityZones": { + "type": { + "$ref": "#/365" + }, + "flags": 0 + }, + "Cidrs": { + "type": { + "$ref": "#/366" + }, + "flags": 0 + }, + "ClassicLoadBalancerListener": { + "type": { + "$ref": "#/344" + }, + "flags": 0 + }, + "Component": { + "type": { + "$ref": "#/343" + }, + "flags": 0 + }, + "ComponentAccount": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "ComponentRegion": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "CustomerGateway": { + "type": { + "$ref": "#/343" + }, + "flags": 0 + }, + "Destination": { + "type": { + "$ref": "#/343" + }, + "flags": 0 + }, + "DestinationVpc": { + "type": { + "$ref": "#/343" + }, + "flags": 0 + }, + "Direction": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "ElasticLoadBalancerListener": { + "type": { + "$ref": "#/343" + }, + "flags": 0 + }, + "ExplanationCode": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "IngressRouteTable": { + "type": { + "$ref": "#/343" + }, + "flags": 0 + }, + "InternetGateway": { + "type": { + "$ref": "#/343" + }, + "flags": 0 + }, + "LoadBalancerArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "LoadBalancerListenerPort": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "LoadBalancerTarget": { + "type": { + "$ref": "#/345" + }, + "flags": 0 + }, + "LoadBalancerTargetGroup": { + "type": { + "$ref": "#/343" + }, + "flags": 0 + }, + "LoadBalancerTargetGroups": { + "type": { + "$ref": "#/367" + }, + "flags": 0 + }, + "LoadBalancerTargetPort": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "MissingComponent": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "NatGateway": { + "type": { + "$ref": "#/343" + }, + "flags": 0 + }, + "NetworkInterface": { + "type": { + "$ref": "#/343" + }, + "flags": 0 + }, + "PacketField": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Port": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "PortRanges": { + "type": { + "$ref": "#/368" + }, + "flags": 0 + }, + "PrefixList": { + "type": { + "$ref": "#/343" + }, + "flags": 0 + }, + "Protocols": { + "type": { + "$ref": "#/369" + }, + "flags": 0 + }, + "RouteTable": { + "type": { + "$ref": "#/343" + }, + "flags": 0 + }, + "RouteTableRoute": { + "type": { + "$ref": "#/347" + }, + "flags": 0 + }, + "SecurityGroup": { + "type": { + "$ref": "#/343" + }, + "flags": 0 + }, + "SecurityGroupRule": { + "type": { + "$ref": "#/348" + }, + "flags": 0 + }, + "SecurityGroups": { + "type": { + "$ref": "#/370" + }, + "flags": 0 + }, + "SourceVpc": { + "type": { + "$ref": "#/343" + }, + "flags": 0 + }, + "State": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Subnet": { + "type": { + "$ref": "#/343" + }, + "flags": 0 + }, + "SubnetRouteTable": { + "type": { + "$ref": "#/343" + }, + "flags": 0 + }, + "TransitGateway": { + "type": { + "$ref": "#/343" + }, + "flags": 0 + }, + "TransitGatewayAttachment": { + "type": { + "$ref": "#/343" + }, + "flags": 0 + }, + "TransitGatewayRouteTable": { + "type": { + "$ref": "#/343" + }, + "flags": 0 + }, + "TransitGatewayRouteTableRoute": { + "type": { + "$ref": "#/358" + }, + "flags": 0 + }, + "Vpc": { + "type": { + "$ref": "#/343" + }, + "flags": 0 + }, + "VpcPeeringConnection": { + "type": { + "$ref": "#/343" + }, + "flags": 0 + }, + "VpnConnection": { + "type": { + "$ref": "#/343" + }, + "flags": 0 + }, + "VpnGateway": { + "type": { + "$ref": "#/343" + }, + "flags": 0 + }, + "vpcEndpoint": { + "type": { + "$ref": "#/343" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "IpAddress", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PathComponent", + "properties": { + "AclRule": { + "type": { + "$ref": "#/342" + }, + "flags": 0 + }, + "AdditionalDetails": { + "type": { + "$ref": "#/371" + }, + "flags": 0 + }, + "Component": { + "type": { + "$ref": "#/343" + }, + "flags": 0 + }, + "DestinationVpc": { + "type": { + "$ref": "#/343" + }, + "flags": 0 + }, + "ElasticLoadBalancerListener": { + "type": { + "$ref": "#/343" + }, + "flags": 0 + }, + "Explanations": { + "type": { + "$ref": "#/372" + }, + "flags": 0 + }, + "InboundHeader": { + "type": { + "$ref": "#/346" + }, + "flags": 0 + }, + "OutboundHeader": { + "type": { + "$ref": "#/346" + }, + "flags": 0 + }, + "RouteTableRoute": { + "type": { + "$ref": "#/347" + }, + "flags": 0 + }, + "SecurityGroupRule": { + "type": { + "$ref": "#/348" + }, + "flags": 0 + }, + "SequenceNumber": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "ServiceName": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "SourceVpc": { + "type": { + "$ref": "#/343" + }, + "flags": 0 + }, + "Subnet": { + "type": { + "$ref": "#/343" + }, + "flags": 0 + }, + "TransitGateway": { + "type": { + "$ref": "#/343" + }, + "flags": 0 + }, + "TransitGatewayRouteTableRoute": { + "type": { + "$ref": "#/358" + }, + "flags": 0 + }, + "Vpc": { + "type": { + "$ref": "#/343" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Port", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PortRange", + "properties": { + "From": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "To": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Protocol", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ResourceArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tags", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TransitGatewayRouteTableRoute", + "properties": { + "AttachmentId": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "DestinationCidr": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "PrefixListId": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "ResourceId": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "ResourceType": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "RouteOrigin": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "State": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/343" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/353" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/353" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/343" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/353" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/343" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/340" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/349" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/356" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/NetworkInsightsAnalysisProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/341" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/349" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/351" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/351" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/356" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/NetworkInsightsAnalysisProperties", + "properties": { + "AdditionalAccounts": { + "type": { + "$ref": "#/375" + }, + "flags": 0 + }, + "AlternatePathHints": { + "type": { + "$ref": "#/376" + }, + "flags": 2 + }, + "Explanations": { + "type": { + "$ref": "#/377" + }, + "flags": 2 + }, + "FilterInArns": { + "type": { + "$ref": "#/378" + }, + "flags": 0 + }, + "ForwardPathComponents": { + "type": { + "$ref": "#/379" + }, + "flags": 2 + }, + "NetworkInsightsAnalysisArn": { + "type": { + "$ref": "#/2" + }, + "flags": 2 + }, + "NetworkInsightsAnalysisId": { + "type": { + "$ref": "#/2" + }, + "flags": 18 + }, + "NetworkInsightsPathId": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "NetworkPathFound": { + "type": { + "$ref": "#/6" + }, + "flags": 2 + }, + "ReturnPathComponents": { + "type": { + "$ref": "#/380" + }, + "flags": 2 + }, + "StartDate": { + "type": { + "$ref": "#/2" + }, + "flags": 2 + }, + "Status": { + "type": { + "$ref": "#/2" + }, + "flags": 2 + }, + "StatusMessage": { + "type": { + "$ref": "#/2" + }, + "flags": 2 + }, + "SuggestedAccounts": { + "type": { + "$ref": "#/381" + }, + "flags": 2 + }, + "Tags": { + "type": { + "$ref": "#/382" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/NetworkInsightsAnalysis", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/383" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/NetworkInsightsAnalysis@default", + "scopeType": 0, + "body": { + "$ref": "#/384" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "FilterPortRange", + "properties": { + "FromPort": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "ToPort": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "IpAddress", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PathFilter", + "properties": { + "DestinationAddress": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "DestinationPortRange": { + "type": { + "$ref": "#/386" + }, + "flags": 0 + }, + "SourceAddress": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "SourcePortRange": { + "type": { + "$ref": "#/386" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Port", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Protocol", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tags", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/391" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/NetworkInsightsPathProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/391" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/NetworkInsightsPathProperties", + "properties": { + "CreatedDate": { + "type": { + "$ref": "#/2" + }, + "flags": 2 + }, + "Destination": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "DestinationArn": { + "type": { + "$ref": "#/2" + }, + "flags": 2 + }, + "DestinationIp": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "DestinationPort": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "FilterAtDestination": { + "type": { + "$ref": "#/388" + }, + "flags": 0 + }, + "FilterAtSource": { + "type": { + "$ref": "#/388" + }, + "flags": 0 + }, + "NetworkInsightsPathArn": { + "type": { + "$ref": "#/2" + }, + "flags": 2 + }, + "NetworkInsightsPathId": { + "type": { + "$ref": "#/2" + }, + "flags": 18 + }, + "Protocol": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Source": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "SourceArn": { + "type": { + "$ref": "#/2" + }, + "flags": 2 + }, + "SourceIp": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/395" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/NetworkInsightsPath", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/396" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/NetworkInsightsPath@default", + "scopeType": 0, + "body": { + "$ref": "#/397" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "ConnectionTrackingSpecification", + "properties": { + "TcpEstablishedTimeout": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "UdpStreamTimeout": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "UdpTimeout": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "InstanceIpv6Address", + "properties": { + "Ipv6Address": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Ipv4PrefixSpecification", + "properties": { + "Ipv4Prefix": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Ipv6PrefixSpecification", + "properties": { + "Ipv6Prefix": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "PrivateIpAddressSpecification", + "properties": { + "Primary": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "PrivateIpAddress": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/NetworkInterfaceProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/401" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/400" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/402" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/403" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/404" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/NetworkInterfaceProperties", + "properties": { + "ConnectionTrackingSpecification": { + "type": { + "$ref": "#/399" + }, + "flags": 0 + }, + "Description": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "A description for the network interface." + }, + "EnablePrimaryIpv6": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "If you have instances or ENIs that rely on the IPv6 address not changing, to avoid disrupting traffic to instances or ENIs, you can enable a primary IPv6 address. Enable this option to automatically assign an IPv6 associated with the ENI attached to your instance to be the primary IPv6 address. When you enable an IPv6 address to be a primary IPv6, you cannot disable it. Traffic will be routed to the primary IPv6 address until the instance is terminated or the ENI is detached. If you have multiple IPv6 addresses associated with an ENI and you enable a primary IPv6 address, the first IPv6 address associated with the ENI becomes the primary IPv6 address." + }, + "GroupSet": { + "type": { + "$ref": "#/406" + }, + "flags": 0, + "description": "A list of security group IDs associated with this network interface." + }, + "Id": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "Network interface id." + }, + "InterfaceType": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "Indicates the type of network interface." + }, + "Ipv4PrefixCount": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The number of IPv4 prefixes to assign to a network interface. When you specify a number of IPv4 prefixes, Amazon EC2 selects these prefixes from your existing subnet CIDR reservations, if available, or from free spaces in the subnet. By default, these will be /28 prefixes. 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." + }, + "Ipv4Prefixes": { + "type": { + "$ref": "#/407" + }, + "flags": 0, + "description": "Assigns a list of IPv4 prefixes to the network interface. If you want EC2 to automatically assign IPv4 prefixes, use the Ipv4PrefixCount property and do not specify this property. Presently, only /28 prefixes are supported. 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." + }, + "Ipv6AddressCount": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. To specify specific IPv6 addresses, use the Ipv6Addresses property and don't specify this property." + }, + "Ipv6Addresses": { + "type": { + "$ref": "#/408" + }, + "flags": 0, + "description": "One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet to associate with the network interface. If you're specifying a number of IPv6 addresses, use the Ipv6AddressCount property and don't specify this property." + }, + "Ipv6PrefixCount": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The number of IPv6 prefixes to assign to a network interface. When you specify a number of IPv6 prefixes, Amazon EC2 selects these prefixes from your existing subnet CIDR reservations, if available, or from free spaces in the subnet. By default, these will be /80 prefixes. You can't specify a count of IPv6 prefixes if you've specified one of the following: specific IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses." + }, + "Ipv6Prefixes": { + "type": { + "$ref": "#/409" + }, + "flags": 0, + "description": "Assigns a list of IPv6 prefixes to the network interface. If you want EC2 to automatically assign IPv6 prefixes, use the Ipv6PrefixCount property and do not specify this property. Presently, only /80 prefixes are supported. You can't specify IPv6 prefixes if you've specified one of the following: a count of IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses." + }, + "PrimaryIpv6Address": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The primary IPv6 address" + }, + "PrimaryPrivateIpAddress": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "Returns the primary private IP address of the network interface." + }, + "PrivateIpAddress": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "Assigns a single private IP address to the network interface, which is used as the primary private IP address. If you want to specify multiple private IP address, use the PrivateIpAddresses property. " + }, + "PrivateIpAddresses": { + "type": { + "$ref": "#/410" + }, + "flags": 0, + "description": "Assigns a list of private IP addresses to the network interface. You can specify a primary private IP address by setting the value of the Primary property to true in the PrivateIpAddressSpecification property. If you want EC2 to automatically assign private IP addresses, use the SecondaryPrivateIpAddressCount property and do not specify this property." + }, + "SecondaryPrivateIpAddressCount": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet's IPv4 CIDR range. You can't specify this option and specify more than one private IP address using privateIpAddresses" + }, + "SecondaryPrivateIpAddresses": { + "type": { + "$ref": "#/411" + }, + "flags": 2, + "description": "Returns the secondary private IP addresses of the network interface." + }, + "SourceDestCheck": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Indicates whether traffic to or from the instance is validated." + }, + "SubnetId": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The ID of the subnet to associate with the network interface." + }, + "Tags": { + "type": { + "$ref": "#/412" + }, + "flags": 0, + "description": "An arbitrary set of tags (key-value pairs) for this network interface." + }, + "VpcId": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The ID of the VPC" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/NetworkInterface", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/413" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/NetworkInterface@default", + "scopeType": 0, + "body": { + "$ref": "#/414" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "EnaSrdSpecification", + "properties": { + "EnaSrdEnabled": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "EnaSrdUdpSpecification": { + "type": { + "$ref": "#/417" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "NetworkInterfaceAttachment_EnaSrdUdpSpecification", + "properties": { + "EnaSrdUdpEnabled": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/NetworkInterfaceAttachmentProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/NetworkInterfaceAttachmentProperties", + "properties": { + "AttachmentId": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "The ID of the network interface attachment." + }, + "DeleteOnTermination": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Whether to delete the network interface when the instance terminates. By default, this value is set to true." + }, + "DeviceIndex": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The network interface's position in the attachment order. For example, the first attached network interface has a DeviceIndex of 0." + }, + "EnaSrdSpecification": { + "type": { + "$ref": "#/416" + }, + "flags": 0 + }, + "InstanceId": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The ID of the instance to which you will attach the ENI." + }, + "NetworkInterfaceId": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The ID of the ENI that you want to attach." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/NetworkInterfaceAttachment", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/419" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/NetworkInterfaceAttachment@default", + "scopeType": 0, + "body": { + "$ref": "#/420" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Entry", + "properties": { + "Cidr": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Description": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/PrefixListProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/422" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/423" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/PrefixListProperties", + "properties": { + "AddressFamily": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "Ip Version of Prefix List." + }, + "Arn": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) of the Prefix List." + }, + "Entries": { + "type": { + "$ref": "#/425" + }, + "flags": 0, + "description": "Entries of Prefix List." + }, + "MaxEntries": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "Max Entries of Prefix List." + }, + "OwnerId": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "Owner Id of Prefix List." + }, + "PrefixListId": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "Id of Prefix List." + }, + "PrefixListName": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "Name of Prefix List." + }, + "Tags": { + "type": { + "$ref": "#/426" + }, + "flags": 0, + "description": "Tags for Prefix List" + }, + "Version": { + "type": { + "$ref": "#/5" + }, + "flags": 2, + "description": "Version of Prefix List." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/PrefixList", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/427" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/PrefixList@default", + "scopeType": 0, + "body": { + "$ref": "#/428" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/RouteProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/RouteProperties", + "properties": { + "CarrierGatewayId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The ID of the carrier gateway.\n You can only use this option when the VPC contains a subnet which is associated with a Wavelength Zone." + }, + "CidrBlock": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "" + }, + "CoreNetworkArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the core network." + }, + "DestinationCidrBlock": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The 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``." + }, + "DestinationIpv6CidrBlock": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match." + }, + "DestinationPrefixListId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The ID of a prefix list used for the destination match." + }, + "EgressOnlyInternetGatewayId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "[IPv6 traffic only] The ID of an egress-only internet gateway." + }, + "GatewayId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The ID of an internet gateway or virtual private gateway attached to your VPC." + }, + "InstanceId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached." + }, + "LocalGatewayId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The ID of the local gateway." + }, + "NatGatewayId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "[IPv4 traffic only] The ID of a NAT gateway." + }, + "NetworkInterfaceId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The ID of a network interface." + }, + "RouteTableId": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "The ID of the route table for the route." + }, + "TransitGatewayId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The ID of a transit gateway." + }, + "VpcEndpointId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only." + }, + "VpcPeeringConnectionId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The ID of a VPC peering connection." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/Route", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/431" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/Route@default", + "scopeType": 0, + "body": { + "$ref": "#/432" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The tag key." + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The tag value." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/RouteTableProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/434" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/RouteTableProperties", + "properties": { + "RouteTableId": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "" + }, + "Tags": { + "type": { + "$ref": "#/436" + }, + "flags": 0, + "description": "Any tags assigned to the route table." + }, + "VpcId": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The ID of the VPC." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/RouteTable", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/437" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/RouteTable@default", + "scopeType": 0, + "body": { + "$ref": "#/438" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Egress", + "properties": { + "CidrIp": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "CidrIpv6": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Description": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "DestinationPrefixListId": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "DestinationSecurityGroupId": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "FromPort": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "IpProtocol": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "ToPort": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Ingress", + "properties": { + "CidrIp": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "CidrIpv6": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Description": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "FromPort": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "IpProtocol": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "SourcePrefixListId": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "SourceSecurityGroupId": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "SourceSecurityGroupName": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "SourceSecurityGroupOwnerId": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "ToPort": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/SecurityGroupProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/440" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/441" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/442" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/SecurityGroupProperties", + "properties": { + "GroupDescription": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "A description for the security group." + }, + "GroupId": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The group ID of the specified security group." + }, + "GroupName": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The name of the security group." + }, + "Id": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "The group name or group ID depending on whether the SG is created in default or specific VPC" + }, + "SecurityGroupEgress": { + "type": { + "$ref": "#/444" + }, + "flags": 0, + "description": "[VPC only] The outbound rules associated with the security group. There is a short interruption during which you cannot connect to the security group." + }, + "SecurityGroupIngress": { + "type": { + "$ref": "#/445" + }, + "flags": 4, + "description": "The inbound rules associated with the security group. There is a short interruption during which you cannot connect to the security group." + }, + "Tags": { + "type": { + "$ref": "#/446" + }, + "flags": 0, + "description": "Any tags assigned to the security group." + }, + "VpcId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The ID of the VPC for the security group." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/SecurityGroup", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/447" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/SecurityGroup@default", + "scopeType": 0, + "body": { + "$ref": "#/448" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/SecurityGroupEgressProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/SecurityGroupEgressProperties", + "properties": { + "CidrIp": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The IPv4 address range, in CIDR format.\n You must specify exactly one of the following: ``CidrIp``, ``CidrIpv6``, ``DestinationPrefixListId``, or ``DestinationSecurityGroupId``.\n For 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 *User Guide*." + }, + "CidrIpv6": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The IPv6 address range, in CIDR format.\n You must specify exactly one of the following: ``CidrIp``, ``CidrIpv6``, ``DestinationPrefixListId``, or ``DestinationSecurityGroupId``.\n For 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 *User Guide*." + }, + "Description": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The description of an egress (outbound) security group rule.\n Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*" + }, + "DestinationPrefixListId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The prefix list IDs for an AWS service. This is the AWS service to access through a VPC endpoint from instances associated with the security group.\n You must specify exactly one of the following: ``CidrIp``, ``CidrIpv6``, ``DestinationPrefixListId``, or ``DestinationSecurityGroupId``." + }, + "DestinationSecurityGroupId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The ID of the security group.\n You must specify exactly one of the following: ``CidrIp``, ``CidrIpv6``, ``DestinationPrefixListId``, or ``DestinationSecurityGroupId``." + }, + "FromPort": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types)." + }, + "GroupId": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID." + }, + "Id": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "" + }, + "IpProtocol": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The IP protocol name (``tcp``, ``udp``, ``icmp``, ``icmpv6``) or number (see [Protocol Numbers](https://docs.aws.amazon.com/http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml)).\n Use ``-1`` to specify all protocols. When authorizing security group rules, specifying ``-1`` or a protocol number other than ``tcp``, ``udp``, ``icmp``, or ``icmpv6`` allows traffic on all ports, regardless of any port range you specify. For ``tcp``, ``udp``, and ``icmp``, you must specify a port range. For ``icmpv6``, the port range is optional; if you omit the port range, traffic for all types and codes is allowed." + }, + "ToPort": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes)." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/SecurityGroupEgress", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/451" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/SecurityGroupEgress@default", + "scopeType": 0, + "body": { + "$ref": "#/452" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/SecurityGroupIngressProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/SecurityGroupIngressProperties", + "properties": { + "CidrIp": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The IPv4 ranges" + }, + "CidrIpv6": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "[VPC only] The IPv6 ranges" + }, + "Description": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "Updates the description of an ingress (inbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously" + }, + "FromPort": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.\n\nUse this for ICMP and any protocol that uses ports." + }, + "GroupId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.\n\nYou must specify the GroupName property or the GroupId property. For security groups that are in a VPC, you must use the GroupId property." + }, + "GroupName": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The name of the security group." + }, + "Id": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "The Security Group Rule Id" + }, + "IpProtocol": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The IP protocol name (tcp, udp, icmp, icmpv6) or number (see Protocol Numbers).\n\n[VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp, udp, and icmp, you must specify a port range. For icmpv6, the port range is optional; if you omit the port range, traffic for all types and codes is allowed." + }, + "SourcePrefixListId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "[EC2-VPC only] The ID of a prefix list.\n\n" + }, + "SourceSecurityGroupId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The ID of the security group. You must specify either the security group ID or the security group name. For security groups in a nondefault VPC, you must specify the security group ID." + }, + "SourceSecurityGroupName": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "[EC2-Classic, default VPC] The name of the source security group.\n\nYou must specify the GroupName property or the GroupId property. For security groups that are in a VPC, you must use the GroupId property." + }, + "SourceSecurityGroupOwnerId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "[nondefault VPC] The AWS account ID that owns the source security group. You can't specify this property with an IP address range.\n\nIf you specify SourceSecurityGroupName or SourceSecurityGroupId and that security group is owned by a different account than the account creating the stack, you must specify the SourceSecurityGroupOwnerId; otherwise, this property is optional." + }, + "ToPort": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes for the specified ICMP type. If you specify all ICMP/ICMPv6 types, you must specify all codes.\n\nUse this for ICMP and any protocol that uses ports." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/SecurityGroupIngress", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/455" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/SecurityGroupIngress@default", + "scopeType": 0, + "body": { + "$ref": "#/456" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/SnapshotBlockPublicAccessProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/SnapshotBlockPublicAccessProperties", + "properties": { + "AccountId": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "The identifier for the specified AWS account." + }, + "State": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The state of EBS Snapshot Block Public Access." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/SnapshotBlockPublicAccess", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/459" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/SnapshotBlockPublicAccess@default", + "scopeType": 0, + "body": { + "$ref": "#/460" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AcceleratorCountRequest", + "properties": { + "Max": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Min": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AcceleratorTotalMemoryMiBRequest", + "properties": { + "Max": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Min": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BaselineEbsBandwidthMbpsRequest", + "properties": { + "Max": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Min": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BlockDeviceMapping", + "properties": { + "DeviceName": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Ebs": { + "type": { + "$ref": "#/468" + }, + "flags": 0 + }, + "NoDevice": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "VirtualName": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ClassicLoadBalancer", + "properties": { + "Name": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ClassicLoadBalancersConfig", + "properties": { + "ClassicLoadBalancers": { + "type": { + "$ref": "#/495" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "EbsBlockDevice", + "properties": { + "DeleteOnTermination": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "Encrypted": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "Iops": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "SnapshotId": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "VolumeSize": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "VolumeType": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FleetLaunchTemplateSpecification", + "properties": { + "LaunchTemplateId": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "LaunchTemplateName": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Version": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "GroupIdentifier", + "properties": { + "GroupId": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "IamInstanceProfileSpecification", + "properties": { + "Arn": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "InstanceIpv6Address", + "properties": { + "Ipv6Address": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "InstanceNetworkInterfaceSpecification", + "properties": { + "AssociatePublicIpAddress": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "DeleteOnTermination": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "Description": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "DeviceIndex": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Groups": { + "type": { + "$ref": "#/496" + }, + "flags": 0 + }, + "Ipv6AddressCount": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Ipv6Addresses": { + "type": { + "$ref": "#/497" + }, + "flags": 0 + }, + "NetworkInterfaceId": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "PrivateIpAddresses": { + "type": { + "$ref": "#/498" + }, + "flags": 0 + }, + "SecondaryPrivateIpAddressCount": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "SubnetId": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "InstanceRequirementsRequest", + "properties": { + "AcceleratorCount": { + "type": { + "$ref": "#/462" + }, + "flags": 0 + }, + "AcceleratorManufacturers": { + "type": { + "$ref": "#/499" + }, + "flags": 0 + }, + "AcceleratorNames": { + "type": { + "$ref": "#/500" + }, + "flags": 0 + }, + "AcceleratorTotalMemoryMiB": { + "type": { + "$ref": "#/463" + }, + "flags": 0 + }, + "AcceleratorTypes": { + "type": { + "$ref": "#/501" + }, + "flags": 0 + }, + "AllowedInstanceTypes": { + "type": { + "$ref": "#/502" + }, + "flags": 0 + }, + "BareMetal": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "BaselineEbsBandwidthMbps": { + "type": { + "$ref": "#/464" + }, + "flags": 0 + }, + "BurstablePerformance": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "CpuManufacturers": { + "type": { + "$ref": "#/503" + }, + "flags": 0 + }, + "ExcludedInstanceTypes": { + "type": { + "$ref": "#/504" + }, + "flags": 0 + }, + "InstanceGenerations": { + "type": { + "$ref": "#/505" + }, + "flags": 0 + }, + "LocalStorage": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "LocalStorageTypes": { + "type": { + "$ref": "#/506" + }, + "flags": 0 + }, + "MaxSpotPriceAsPercentageOfOptimalOnDemandPrice": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "MemoryGiBPerVCpu": { + "type": { + "$ref": "#/478" + }, + "flags": 0 + }, + "MemoryMiB": { + "type": { + "$ref": "#/479" + }, + "flags": 0 + }, + "NetworkBandwidthGbps": { + "type": { + "$ref": "#/480" + }, + "flags": 0 + }, + "NetworkInterfaceCount": { + "type": { + "$ref": "#/481" + }, + "flags": 0 + }, + "OnDemandMaxPricePercentageOverLowestPrice": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "RequireHibernateSupport": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "SpotMaxPricePercentageOverLowestPrice": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "TotalLocalStorageGB": { + "type": { + "$ref": "#/493" + }, + "flags": 0 + }, + "VCpuCount": { + "type": { + "$ref": "#/494" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "LaunchTemplateConfig", + "properties": { + "LaunchTemplateSpecification": { + "type": { + "$ref": "#/469" + }, + "flags": 0 + }, + "Overrides": { + "type": { + "$ref": "#/507" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "LaunchTemplateOverrides", + "properties": { + "AvailabilityZone": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "InstanceRequirements": { + "type": { + "$ref": "#/474" + }, + "flags": 0 + }, + "InstanceType": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Priority": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "SpotPrice": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "SubnetId": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "WeightedCapacity": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "LoadBalancersConfig", + "properties": { + "ClassicLoadBalancersConfig": { + "type": { + "$ref": "#/467" + }, + "flags": 0 + }, + "TargetGroupsConfig": { + "type": { + "$ref": "#/492" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "MemoryGiBPerVCpuRequest", + "properties": { + "Max": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Min": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "MemoryMiBRequest", + "properties": { + "Max": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Min": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "NetworkBandwidthGbpsRequest", + "properties": { + "Max": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Min": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "NetworkInterfaceCountRequest", + "properties": { + "Max": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Min": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PrivateIpAddressSpecification", + "properties": { + "Primary": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "PrivateIpAddress": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "SpotCapacityRebalance", + "properties": { + "ReplacementStrategy": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "TerminationDelay": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SpotFleetLaunchSpecification", + "properties": { + "BlockDeviceMappings": { + "type": { + "$ref": "#/508" + }, + "flags": 0 + }, + "EbsOptimized": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "IamInstanceProfile": { + "type": { + "$ref": "#/471" + }, + "flags": 0 + }, + "ImageId": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "InstanceRequirements": { + "type": { + "$ref": "#/474" + }, + "flags": 0 + }, + "InstanceType": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "KernelId": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "KeyName": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Monitoring": { + "type": { + "$ref": "#/485" + }, + "flags": 0 + }, + "NetworkInterfaces": { + "type": { + "$ref": "#/509" + }, + "flags": 0 + }, + "Placement": { + "type": { + "$ref": "#/489" + }, + "flags": 0 + }, + "RamdiskId": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "SecurityGroups": { + "type": { + "$ref": "#/510" + }, + "flags": 0 + }, + "SpotPrice": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "SubnetId": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "TagSpecifications": { + "type": { + "$ref": "#/511" + }, + "flags": 0 + }, + "UserData": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "WeightedCapacity": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SpotFleetMonitoring", + "properties": { + "Enabled": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SpotFleetRequestConfigData", + "properties": { + "AllocationStrategy": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Context": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "ExcessCapacityTerminationPolicy": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "IamFleetRole": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "InstanceInterruptionBehavior": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "InstancePoolsToUseCount": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "LaunchSpecifications": { + "type": { + "$ref": "#/512" + }, + "flags": 4 + }, + "LaunchTemplateConfigs": { + "type": { + "$ref": "#/513" + }, + "flags": 0 + }, + "LoadBalancersConfig": { + "type": { + "$ref": "#/477" + }, + "flags": 0 + }, + "OnDemandAllocationStrategy": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "OnDemandMaxTotalPrice": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "OnDemandTargetCapacity": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "ReplaceUnhealthyInstances": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "SpotMaintenanceStrategies": { + "type": { + "$ref": "#/488" + }, + "flags": 0 + }, + "SpotMaxTotalPrice": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "SpotPrice": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "TagSpecifications": { + "type": { + "$ref": "#/514" + }, + "flags": 4 + }, + "TargetCapacity": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "TargetCapacityUnitType": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "TerminateInstancesWithExpiration": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "ValidFrom": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "ValidUntil": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SpotFleetTagSpecification", + "properties": { + "ResourceType": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/515" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SpotMaintenanceStrategies", + "properties": { + "CapacityRebalance": { + "type": { + "$ref": "#/483" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SpotPlacement", + "properties": { + "AvailabilityZone": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "GroupName": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Tenancy": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TargetGroup", + "properties": { + "Arn": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TargetGroupsConfig", + "properties": { + "TargetGroups": { + "type": { + "$ref": "#/516" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TotalLocalStorageGBRequest", + "properties": { + "Max": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Min": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "VCpuCountRangeRequest", + "properties": { + "Max": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Min": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/466" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/472" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/482" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/476" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/465" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/473" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/470" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/487" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/484" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/475" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/487" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/490" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/491" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/SpotFleetProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/SpotFleetProperties", + "properties": { + "Id": { + "type": { + "$ref": "#/2" + }, + "flags": 18 + }, + "SpotFleetRequestConfigData": { + "type": { + "$ref": "#/486" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/SpotFleet", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/518" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/SpotFleet@default", + "scopeType": 0, + "body": { + "$ref": "#/519" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The tag key." + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The tag value." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/SubnetProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ObjectType", + "name": "Subnet_PrivateDnsNameOptionsOnLaunch", + "properties": { + "EnableResourceNameDnsAAAARecord": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "EnableResourceNameDnsARecord": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "HostnameType": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/521" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/SubnetProperties", + "properties": { + "AssignIpv6AddressOnCreation": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Indicates whether a network interface created in this subnet receives an IPv6 address. The default value is ``false``.\n If you specify ``AssignIpv6AddressOnCreation``, you must also specify an IPv6 CIDR block." + }, + "AvailabilityZone": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The Availability Zone of the subnet.\n If you update this property, you must also update the ``CidrBlock`` property." + }, + "AvailabilityZoneId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The AZ ID of the subnet." + }, + "CidrBlock": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The IPv4 CIDR block assigned to the subnet.\n If you update this property, we create a new subnet, and then delete the existing one." + }, + "EnableDns64": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations. For more information, see [DNS64 and NAT64](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-nat64-dns64) in the *User Guide*." + }, + "EnableLniAtDeviceIndex": { + "type": { + "$ref": "#/5" + }, + "flags": 4, + "description": "Indicates the device position for local network interfaces in this subnet. For example, ``1`` indicates local network interfaces in this subnet are the secondary network interface (eth1)." + }, + "Ipv4IpamPoolId": { + "type": { + "$ref": "#/2" + }, + "flags": 4, + "description": "An IPv4 IPAM pool ID for the subnet." + }, + "Ipv4NetmaskLength": { + "type": { + "$ref": "#/5" + }, + "flags": 4, + "description": "An IPv4 netmask length for the subnet." + }, + "Ipv6CidrBlock": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The IPv6 CIDR block.\n If you specify ``AssignIpv6AddressOnCreation``, you must also specify an IPv6 CIDR block." + }, + "Ipv6CidrBlocks": { + "type": { + "$ref": "#/523" + }, + "flags": 0, + "description": "The IPv6 network ranges for the subnet, in CIDR notation." + }, + "Ipv6IpamPoolId": { + "type": { + "$ref": "#/2" + }, + "flags": 4, + "description": "An IPv6 IPAM pool ID for the subnet." + }, + "Ipv6Native": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Indicates 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 *User Guide*." + }, + "Ipv6NetmaskLength": { + "type": { + "$ref": "#/5" + }, + "flags": 4, + "description": "An IPv6 netmask length for the subnet." + }, + "MapPublicIpOnLaunch": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Indicates whether instances launched in this subnet receive a public IPv4 address. The default value is ``false``.\n AWS charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the *Public IPv4 Address* tab on the [VPC pricing page](https://docs.aws.amazon.com/vpc/pricing/)." + }, + "NetworkAclAssociationId": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "" + }, + "OutpostArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the Outpost." + }, + "PrivateDnsNameOptionsOnLaunch": { + "type": { + "$ref": "#/524" + }, + "flags": 0, + "description": "The 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 *User Guide*.\n Available options:\n + EnableResourceNameDnsAAAARecord (true | false)\n + EnableResourceNameDnsARecord (true | false)\n + HostnameType (ip-name | resource-name)" + }, + "SubnetId": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "" + }, + "Tags": { + "type": { + "$ref": "#/525" + }, + "flags": 0, + "description": "Any tags assigned to the subnet." + }, + "VpcId": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The ID of the VPC the subnet is in.\n If you update this property, you must also update the ``CidrBlock`` property." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/Subnet", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/526" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/Subnet@default", + "scopeType": 0, + "body": { + "$ref": "#/527" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/TransitGatewayProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/529" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/TransitGatewayProperties", + "properties": { + "AmazonSideAsn": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "AssociationDefaultRouteTableId": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "AutoAcceptSharedAttachments": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "DefaultRouteTableAssociation": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "DefaultRouteTablePropagation": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Description": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "DnsSupport": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Id": { + "type": { + "$ref": "#/2" + }, + "flags": 18 + }, + "MulticastSupport": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "PropagationDefaultRouteTableId": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/531" + }, + "flags": 0 + }, + "TransitGatewayArn": { + "type": { + "$ref": "#/2" + }, + "flags": 2 + }, + "TransitGatewayCidrBlocks": { + "type": { + "$ref": "#/532" + }, + "flags": 0 + }, + "VpnEcmpSupport": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/TransitGateway", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/533" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/TransitGateway@default", + "scopeType": 0, + "body": { + "$ref": "#/534" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/TransitGatewayAttachmentProperties" + }, + { + "$type": "ObjectType", + "name": "TransitGatewayAttachment_Options", + "properties": { + "ApplianceModeSupport": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "Indicates whether to enable Ipv6 Support for Vpc Attachment. Valid Values: enable | disable" + }, + "DnsSupport": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "Indicates whether to enable DNS Support for Vpc Attachment. Valid Values: enable | disable" + }, + "Ipv6Support": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "Indicates whether to enable Ipv6 Support for Vpc Attachment. Valid Values: enable | disable" + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/536" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/TransitGatewayAttachmentProperties", + "properties": { + "Id": { + "type": { + "$ref": "#/2" + }, + "flags": 18 + }, + "Options": { + "type": { + "$ref": "#/538" + }, + "flags": 0, + "description": "The options for the transit gateway vpc attachment." + }, + "SubnetIds": { + "type": { + "$ref": "#/539" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/540" + }, + "flags": 0 + }, + "TransitGatewayId": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "VpcId": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/TransitGatewayAttachment", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/541" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/TransitGatewayAttachment@default", + "scopeType": 0, + "body": { + "$ref": "#/542" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:." + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters." + } + } + }, + { + "$type": "ObjectType", + "name": "TransitGatewayConnectOptions", + "properties": { + "Protocol": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The tunnel protocol." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/TransitGatewayConnectProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/544" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/TransitGatewayConnectProperties", + "properties": { + "CreationTime": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The creation time." + }, + "Options": { + "type": { + "$ref": "#/545" + }, + "flags": 1, + "description": "The Connect attachment options." + }, + "State": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The state of the attachment." + }, + "Tags": { + "type": { + "$ref": "#/547" + }, + "flags": 0, + "description": "The tags for the attachment." + }, + "TransitGatewayAttachmentId": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "The ID of the Connect attachment." + }, + "TransitGatewayId": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The ID of the transit gateway." + }, + "TransportTransitGatewayAttachmentId": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The ID of the attachment from which the Connect attachment was created." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/TransitGatewayConnect", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/548" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/TransitGatewayConnect@default", + "scopeType": 0, + "body": { + "$ref": "#/549" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:." + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/TransitGatewayMulticastDomainProperties" + }, + { + "$type": "ObjectType", + "name": "TransitGatewayMulticastDomain_Options", + "properties": { + "AutoAcceptSharedAssociations": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "Indicates whether to automatically cross-account subnet associations that are associated with the transit gateway multicast domain. Valid Values: enable | disable" + }, + "Igmpv2Support": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "Indicates whether Internet Group Management Protocol (IGMP) version 2 is turned on for the transit gateway multicast domain. Valid Values: enable | disable" + }, + "StaticSourcesSupport": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "Indicates whether support for statically configuring transit gateway multicast group sources is turned on. Valid Values: enable | disable" + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/551" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/TransitGatewayMulticastDomainProperties", + "properties": { + "CreationTime": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The time the transit gateway multicast domain was created." + }, + "Options": { + "type": { + "$ref": "#/553" + }, + "flags": 0, + "description": "The options for the transit gateway multicast domain." + }, + "State": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The state of the transit gateway multicast domain." + }, + "Tags": { + "type": { + "$ref": "#/554" + }, + "flags": 0, + "description": "The tags for the transit gateway multicast domain." + }, + "TransitGatewayId": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The ID of the transit gateway." + }, + "TransitGatewayMulticastDomainArn": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) of the transit gateway multicast domain." + }, + "TransitGatewayMulticastDomainId": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "The ID of the transit gateway multicast domain." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/TransitGatewayMulticastDomain", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/555" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/TransitGatewayMulticastDomain@default", + "scopeType": 0, + "body": { + "$ref": "#/556" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "PeeringAttachmentStatus", + "properties": { + "Code": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The status code." + }, + "Message": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The status message, if applicable." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:." + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/TransitGatewayPeeringAttachmentProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/559" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/TransitGatewayPeeringAttachmentProperties", + "properties": { + "CreationTime": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The time the transit gateway peering attachment was created." + }, + "PeerAccountId": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The ID of the peer account" + }, + "PeerRegion": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "Peer Region" + }, + "PeerTransitGatewayId": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The ID of the peer transit gateway." + }, + "State": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The state of the transit gateway peering attachment. Note that the initiating state has been deprecated." + }, + "Status": { + "type": { + "$ref": "#/558" + }, + "flags": 2, + "description": "The status of the transit gateway peering attachment." + }, + "Tags": { + "type": { + "$ref": "#/561" + }, + "flags": 0, + "description": "The tags for the transit gateway peering attachment." + }, + "TransitGatewayAttachmentId": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "The ID of the transit gateway peering attachment." + }, + "TransitGatewayId": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The ID of the transit gateway." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/TransitGatewayPeeringAttachment", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/562" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/TransitGatewayPeeringAttachment@default", + "scopeType": 0, + "body": { + "$ref": "#/563" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/TransitGatewayVpcAttachmentProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ObjectType", + "name": "TransitGatewayVpcAttachment_Options", + "properties": { + "ApplianceModeSupport": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "Indicates whether to enable Ipv6 Support for Vpc Attachment. Valid Values: enable | disable" + }, + "DnsSupport": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "Indicates whether to enable DNS Support for Vpc Attachment. Valid Values: enable | disable" + }, + "Ipv6Support": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "Indicates whether to enable Ipv6 Support for Vpc Attachment. Valid Values: enable | disable" + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/565" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/TransitGatewayVpcAttachmentProperties", + "properties": { + "AddSubnetIds": { + "type": { + "$ref": "#/567" + }, + "flags": 4 + }, + "Id": { + "type": { + "$ref": "#/2" + }, + "flags": 18 + }, + "Options": { + "type": { + "$ref": "#/568" + }, + "flags": 0, + "description": "The options for the transit gateway vpc attachment." + }, + "RemoveSubnetIds": { + "type": { + "$ref": "#/569" + }, + "flags": 4 + }, + "SubnetIds": { + "type": { + "$ref": "#/570" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/571" + }, + "flags": 0 + }, + "TransitGatewayId": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "VpcId": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/TransitGatewayVpcAttachment", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/572" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/TransitGatewayVpcAttachment@default", + "scopeType": 0, + "body": { + "$ref": "#/573" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The tag key." + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The tag value." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/VPCProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/575" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/VPCProperties", + "properties": { + "CidrBlock": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The IPv4 network range for the VPC, in CIDR notation. For example, ``10.0.0.0/16``. We modify the specified CIDR block to its canonical form; for example, if you specify ``100.68.0.18/18``, we modify it to ``100.68.0.0/18``.\n You must specify either``CidrBlock`` or ``Ipv4IpamPoolId``." + }, + "CidrBlockAssociations": { + "type": { + "$ref": "#/577" + }, + "flags": 2, + "description": "" + }, + "DefaultNetworkAcl": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "" + }, + "DefaultSecurityGroup": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "" + }, + "EnableDnsHostnames": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not. Disabled by default for nondefault VPCs. For more information, see [DNS attributes in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support).\n You can only enable DNS hostnames if you've enabled DNS support." + }, + "EnableDnsSupport": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range \"plus two\" succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled. Enabled by default. For more information, see [DNS attributes in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support)." + }, + "InstanceTenancy": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The allowed tenancy of instances launched into the VPC.\n + ``default``: An instance launched into the VPC runs on shared hardware by default, unless you explicitly specify a different tenancy during instance launch.\n + ``dedicated``: An instance launched into the VPC runs on dedicated hardware by default, unless you explicitly specify a tenancy of ``host`` during instance launch. You cannot specify a tenancy of ``default`` during instance launch.\n \n Updating ``InstanceTenancy`` requires no replacement only if you are updating its value from ``dedicated`` to ``default``. Updating ``InstanceTenancy`` from ``default`` to ``dedicated`` requires replacement." + }, + "Ipv4IpamPoolId": { + "type": { + "$ref": "#/2" + }, + "flags": 4, + "description": "The ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR. For more information, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*.\n You must specify either``CidrBlock`` or ``Ipv4IpamPoolId``." + }, + "Ipv4NetmaskLength": { + "type": { + "$ref": "#/5" + }, + "flags": 4, + "description": "The netmask length of the IPv4 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*." + }, + "Ipv6CidrBlocks": { + "type": { + "$ref": "#/578" + }, + "flags": 2, + "description": "" + }, + "Tags": { + "type": { + "$ref": "#/579" + }, + "flags": 0, + "description": "The tags for the VPC." + }, + "VpcId": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/VPC", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/580" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/VPC@default", + "scopeType": 0, + "body": { + "$ref": "#/581" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/VPCDHCPOptionsAssociationProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/VPCDHCPOptionsAssociationProperties", + "properties": { + "DhcpOptionsId": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "The ID of the DHCP options set, or default to associate no DHCP options with the VPC." + }, + "VpcId": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "The ID of the VPC." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/VPCDHCPOptionsAssociation", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/584" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/VPCDHCPOptionsAssociation@default", + "scopeType": 0, + "body": { + "$ref": "#/585" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/VPCEndpointProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ObjectType", + "name": "VPCEndpoint_PolicyDocument", + "properties": {} + }, + { + "$type": "UnionType", + "elements": [ + { + "$ref": "#/2" + }, + { + "$ref": "#/590" + } + ] + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/VPCEndpointProperties", + "properties": { + "CreationTimestamp": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "" + }, + "DnsEntries": { + "type": { + "$ref": "#/588" + }, + "flags": 2, + "description": "" + }, + "Id": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "" + }, + "NetworkInterfaceIds": { + "type": { + "$ref": "#/589" + }, + "flags": 2, + "description": "" + }, + "PolicyDocument": { + "type": { + "$ref": "#/591" + }, + "flags": 0, + "description": "An endpoint policy, which controls access to the service from the VPC. The default endpoint policy allows full access to the service. Endpoint policies are supported only for gateway and interface endpoints.\n For CloudFormation templates in YAML, you can provide the policy in JSON or YAML format. CFNlong converts YAML policies to JSON format before calling the API to create or modify the VPC endpoint." + }, + "PrivateDnsEnabled": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Indicate whether to associate a private hosted zone with the specified VPC. The private hosted zone contains a record set for the default public DNS name for the service for the Region (for example, ``kinesis.us-east-1.amazonaws.com``), which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC endpoint service.\n To use a private hosted zone, you must set the following VPC attributes to ``true``: ``enableDnsHostnames`` and ``enableDnsSupport``.\n This property is supported only for interface endpoints.\n Default: ``false``" + }, + "RouteTableIds": { + "type": { + "$ref": "#/592" + }, + "flags": 0, + "description": "The IDs of the route tables. Routing is supported only for gateway endpoints." + }, + "SecurityGroupIds": { + "type": { + "$ref": "#/593" + }, + "flags": 0, + "description": "The IDs of the security groups to associate with the endpoint network interfaces. If this parameter is not specified, we use the default security group for the VPC. Security groups are supported only for interface endpoints." + }, + "ServiceName": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The name of the endpoint service." + }, + "SubnetIds": { + "type": { + "$ref": "#/594" + }, + "flags": 0, + "description": "The IDs of the subnets in which to create endpoint network interfaces. You must specify this property for an interface endpoint or a Gateway Load Balancer endpoint. You can't specify this property for a gateway endpoint. For a Gateway Load Balancer endpoint, you can specify only one subnet." + }, + "VpcEndpointType": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The type of endpoint.\n Default: Gateway" + }, + "VpcId": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The ID of the VPC." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/VPCEndpoint", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/595" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/VPCEndpoint@default", + "scopeType": 0, + "body": { + "$ref": "#/596" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/VPCEndpointConnectionNotificationProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/VPCEndpointConnectionNotificationProperties", + "properties": { + "ConnectionEvents": { + "type": { + "$ref": "#/599" + }, + "flags": 1, + "description": "The endpoint events for which to receive notifications." + }, + "ConnectionNotificationArn": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The ARN of the SNS topic for the notifications." + }, + "ServiceId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The ID of the endpoint service." + }, + "VPCEndpointConnectionNotificationId": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "VPC Endpoint Connection ID generated by service" + }, + "VPCEndpointId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The ID of the endpoint." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/VPCEndpointConnectionNotification", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/600" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/VPCEndpointConnectionNotification@default", + "scopeType": 0, + "body": { + "$ref": "#/601" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/VPCEndpointServiceProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/VPCEndpointServiceProperties", + "properties": { + "AcceptanceRequired": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "ContributorInsightsEnabled": { + "type": { + "$ref": "#/6" + }, + "flags": 4 + }, + "GatewayLoadBalancerArns": { + "type": { + "$ref": "#/604" + }, + "flags": 0 + }, + "NetworkLoadBalancerArns": { + "type": { + "$ref": "#/605" + }, + "flags": 0 + }, + "PayerResponsibility": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "ServiceId": { + "type": { + "$ref": "#/2" + }, + "flags": 18 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/VPCEndpointService", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/606" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/VPCEndpointService@default", + "scopeType": 0, + "body": { + "$ref": "#/607" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/VPCEndpointServicePermissionsProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/VPCEndpointServicePermissionsProperties", + "properties": { + "AllowedPrincipals": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "ServiceId": { + "type": { + "$ref": "#/2" + }, + "flags": 17 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/VPCEndpointServicePermissions", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/611" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/VPCEndpointServicePermissions@default", + "scopeType": 0, + "body": { + "$ref": "#/612" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/VPCGatewayAttachmentProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/VPCGatewayAttachmentProperties", + "properties": { + "AttachmentType": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "Used to identify if this resource is an Internet Gateway or Vpn Gateway Attachment " + }, + "InternetGatewayId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The ID of the internet gateway. You must specify either InternetGatewayId or VpnGatewayId, but not both." + }, + "VpcId": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "The ID of the VPC." + }, + "VpnGatewayId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The ID of the virtual private gateway. You must specify either InternetGatewayId or VpnGatewayId, but not both." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/VPCGatewayAttachment", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/615" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/VPCGatewayAttachment@default", + "scopeType": 0, + "body": { + "$ref": "#/616" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/VPCPeeringConnectionProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/618" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/VPCPeeringConnectionProperties", + "properties": { + "Id": { + "type": { + "$ref": "#/2" + }, + "flags": 18 + }, + "PeerOwnerId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The AWS account ID of the owner of the accepter VPC." + }, + "PeerRegion": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request." + }, + "PeerRoleArn": { + "type": { + "$ref": "#/2" + }, + "flags": 4, + "description": "The Amazon Resource Name (ARN) of the VPC peer role for the peering connection in another AWS account." + }, + "PeerVpcId": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request." + }, + "Tags": { + "type": { + "$ref": "#/620" + }, + "flags": 0 + }, + "VpcId": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The ID of the VPC." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/VPCPeeringConnection", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/621" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/VPCPeeringConnection@default", + "scopeType": 0, + "body": { + "$ref": "#/622" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "VpnTunnelOptionsSpecification", + "properties": { + "PreSharedKey": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "TunnelInsideCidr": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/VPNConnectionProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/624" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/625" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/VPNConnectionProperties", + "properties": { + "CustomerGatewayId": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The ID of the customer gateway at your end of the VPN connection." + }, + "StaticRoutesOnly": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Indicates whether the VPN connection uses static routes only." + }, + "Tags": { + "type": { + "$ref": "#/627" + }, + "flags": 0, + "description": "Any tags assigned to the VPN connection." + }, + "TransitGatewayId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The ID of the transit gateway associated with the VPN connection." + }, + "Type": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The type of VPN connection." + }, + "VpnConnectionId": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "The provider-assigned unique ID for this managed resource" + }, + "VpnGatewayId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The ID of the virtual private gateway at the AWS side of the VPN connection." + }, + "VpnTunnelOptionsSpecifications": { + "type": { + "$ref": "#/628" + }, + "flags": 0, + "description": "The tunnel options for the VPN connection." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/VPNConnection", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/629" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/VPNConnection@default", + "scopeType": 0, + "body": { + "$ref": "#/630" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The tag key." + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The tag value." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/VPNGatewayProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/632" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/VPNGatewayProperties", + "properties": { + "AmazonSideAsn": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The private Autonomous System Number (ASN) for the Amazon side of a BGP session." + }, + "Tags": { + "type": { + "$ref": "#/634" + }, + "flags": 0, + "description": "Any tags assigned to the virtual private gateway." + }, + "Type": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The type of VPN connection the virtual private gateway supports." + }, + "VPNGatewayId": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/VPNGateway", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/635" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/VPNGateway@default", + "scopeType": 0, + "body": { + "$ref": "#/636" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "LoadBalancerOptions", + "properties": { + "LoadBalancerArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The ARN of the load balancer." + }, + "Port": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The IP port number." + }, + "Protocol": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The IP protocol." + }, + "SubnetIds": { + "type": { + "$ref": "#/644" + }, + "flags": 0, + "description": "The IDs of the subnets." + } + } + }, + { + "$type": "ObjectType", + "name": "NetworkInterfaceOptions", + "properties": { + "NetworkInterfaceId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The ID of the network interface." + }, + "Port": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The IP port number." + }, + "Protocol": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The IP protocol." + } + } + }, + { + "$type": "ObjectType", + "name": "SecurityGroupId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SseSpecification", + "properties": { + "CustomerManagedKeyEnabled": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Whether to encrypt the policy with the provided key or disable encryption" + }, + "KmsKeyArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "KMS Key Arn used to encrypt the group policy" + } + } + }, + { + "$type": "ObjectType", + "name": "SubnetId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/VerifiedAccessEndpointProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/643" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/VerifiedAccessEndpointProperties", + "properties": { + "ApplicationDomain": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The DNS name for users to reach your application." + }, + "AttachmentType": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The type of attachment used to provide connectivity between the AWS Verified Access endpoint and the application." + }, + "CreationTime": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The creation time." + }, + "Description": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "A description for the AWS Verified Access endpoint." + }, + "DeviceValidationDomain": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "Returned if endpoint has a device trust provider attached." + }, + "DomainCertificateArn": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The ARN of a public TLS/SSL certificate imported into or created with ACM." + }, + "EndpointDomain": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "A DNS name that is generated for the endpoint." + }, + "EndpointDomainPrefix": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "A custom identifier that gets prepended to a DNS name that is generated for the endpoint." + }, + "EndpointType": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The type of AWS Verified Access endpoint. Incoming application requests will be sent to an IP address, load balancer or a network interface depending on the endpoint type specified.The type of AWS Verified Access endpoint. Incoming application requests will be sent to an IP address, load balancer or a network interface depending on the endpoint type specified." + }, + "LastUpdatedTime": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The last updated time." + }, + "LoadBalancerOptions": { + "type": { + "$ref": "#/638" + }, + "flags": 0, + "description": "The load balancer details if creating the AWS Verified Access endpoint as load-balancer type." + }, + "NetworkInterfaceOptions": { + "type": { + "$ref": "#/639" + }, + "flags": 0, + "description": "The options for network-interface type endpoint." + }, + "PolicyDocument": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The AWS Verified Access policy document." + }, + "PolicyEnabled": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "The status of the Verified Access policy." + }, + "SecurityGroupIds": { + "type": { + "$ref": "#/646" + }, + "flags": 0, + "description": "The IDs of the security groups for the endpoint." + }, + "SseSpecification": { + "type": { + "$ref": "#/641" + }, + "flags": 0, + "description": "The configuration options for customer provided KMS encryption." + }, + "Status": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The endpoint status." + }, + "Tags": { + "type": { + "$ref": "#/647" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + }, + "VerifiedAccessEndpointId": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "The ID of the AWS Verified Access endpoint." + }, + "VerifiedAccessGroupId": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The ID of the AWS Verified Access group." + }, + "VerifiedAccessInstanceId": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The ID of the AWS Verified Access instance." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/VerifiedAccessEndpoint", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/648" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/VerifiedAccessEndpoint@default", + "scopeType": 0, + "body": { + "$ref": "#/649" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "SseSpecification", + "properties": { + "CustomerManagedKeyEnabled": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Whether to encrypt the policy with the provided key or disable encryption" + }, + "KmsKeyArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "KMS Key Arn used to encrypt the group policy" + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/VerifiedAccessGroupProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/652" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/VerifiedAccessGroupProperties", + "properties": { + "CreationTime": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "Time this Verified Access Group was created." + }, + "Description": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "A description for the AWS Verified Access group." + }, + "LastUpdatedTime": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "Time this Verified Access Group was last updated." + }, + "Owner": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The AWS account number that owns the group." + }, + "PolicyDocument": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The AWS Verified Access policy document." + }, + "PolicyEnabled": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "The status of the Verified Access policy." + }, + "SseSpecification": { + "type": { + "$ref": "#/651" + }, + "flags": 0, + "description": "The configuration options for customer provided KMS encryption." + }, + "Tags": { + "type": { + "$ref": "#/654" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + }, + "VerifiedAccessGroupArn": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The ARN of the Verified Access group." + }, + "VerifiedAccessGroupId": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "The ID of the AWS Verified Access group." + }, + "VerifiedAccessInstanceId": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The ID of the AWS Verified Access instance." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/VerifiedAccessGroup", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/655" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/VerifiedAccessGroup@default", + "scopeType": 0, + "body": { + "$ref": "#/656" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "ObjectType", + "name": "VerifiedAccessLogs", + "properties": { + "CloudWatchLogs": { + "type": { + "$ref": "#/662" + }, + "flags": 0, + "description": "Sends Verified Access logs to CloudWatch Logs." + }, + "IncludeTrustContext": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Include claims from trust providers in Verified Access logs." + }, + "KinesisDataFirehose": { + "type": { + "$ref": "#/663" + }, + "flags": 0, + "description": "Sends Verified Access logs to Kinesis." + }, + "LogVersion": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "Select log version for Verified Access logs." + }, + "S3": { + "type": { + "$ref": "#/664" + }, + "flags": 0, + "description": "Sends Verified Access logs to Amazon S3." + } + } + }, + { + "$type": "ObjectType", + "name": "VerifiedAccessTrustProvider", + "properties": { + "Description": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The description of trust provider." + }, + "DeviceTrustProviderType": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The type of device-based trust provider." + }, + "TrustProviderType": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The type of trust provider (user- or device-based)." + }, + "UserTrustProviderType": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The type of user-based trust provider." + }, + "VerifiedAccessTrustProviderId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The ID of the trust provider." + } + } + }, + { + "$type": "ObjectType", + "name": "VerifiedAccessTrustProviderId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "VerifiedAccessInstance_CloudWatchLogs", + "properties": { + "Enabled": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Indicates whether logging is enabled." + }, + "LogGroup": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The ID of the CloudWatch Logs log group." + } + } + }, + { + "$type": "ObjectType", + "name": "VerifiedAccessInstance_KinesisDataFirehose", + "properties": { + "DeliveryStream": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The ID of the delivery stream." + }, + "Enabled": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Indicates whether logging is enabled." + } + } + }, + { + "$type": "ObjectType", + "name": "VerifiedAccessInstance_S3", + "properties": { + "BucketName": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The bucket name." + }, + "BucketOwner": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The ID of the AWS account that owns the Amazon S3 bucket." + }, + "Enabled": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Indicates whether logging is enabled." + }, + "Prefix": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The bucket prefix." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/VerifiedAccessInstanceProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/658" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/660" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/VerifiedAccessInstanceProperties", + "properties": { + "CreationTime": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "Time this Verified Access Instance was created." + }, + "Description": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "A description for the AWS Verified Access instance." + }, + "FipsEnabled": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Indicates whether FIPS is enabled" + }, + "LastUpdatedTime": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "Time this Verified Access Instance was last updated." + }, + "LoggingConfigurations": { + "type": { + "$ref": "#/659" + }, + "flags": 0, + "description": "The configuration options for AWS Verified Access instances." + }, + "Tags": { + "type": { + "$ref": "#/666" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + }, + "VerifiedAccessInstanceId": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "The ID of the AWS Verified Access instance." + }, + "VerifiedAccessTrustProviderIds": { + "type": { + "$ref": "#/667" + }, + "flags": 0, + "description": "The IDs of the AWS Verified Access trust providers." + }, + "VerifiedAccessTrustProviders": { + "type": { + "$ref": "#/668" + }, + "flags": 0, + "description": "AWS Verified Access trust providers." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/VerifiedAccessInstance", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/669" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/VerifiedAccessInstance@default", + "scopeType": 0, + "body": { + "$ref": "#/670" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "DeviceOptions", + "properties": { + "PublicSigningKeyUrl": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "URL Verified Access will use to verify authenticity of the device tokens." + }, + "TenantId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The ID of the tenant application with the device-identity provider." + } + } + }, + { + "$type": "ObjectType", + "name": "OidcOptions", + "properties": { + "AuthorizationEndpoint": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The OIDC authorization endpoint." + }, + "ClientId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The client identifier." + }, + "ClientSecret": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The client secret." + }, + "Issuer": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The OIDC issuer." + }, + "Scope": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "OpenID Connect (OIDC) scopes are used by an application during authentication to authorize access to details of a user. Each scope returns a specific set of user attributes." + }, + "TokenEndpoint": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The OIDC token endpoint." + }, + "UserInfoEndpoint": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The OIDC user info endpoint." + } + } + }, + { + "$type": "ObjectType", + "name": "SseSpecification", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/VerifiedAccessTrustProviderProperties" + }, + { + "$type": "ObjectType", + "name": "VerifiedAccessTrustProvider_SseSpecification", + "properties": { + "CustomerManagedKeyEnabled": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Whether to encrypt the policy with the provided key or disable encryption" + }, + "KmsKeyArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "KMS Key Arn used to encrypt the group policy" + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/675" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/VerifiedAccessTrustProviderProperties", + "properties": { + "CreationTime": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The creation time." + }, + "Description": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "A description for the Amazon Web Services Verified Access trust provider." + }, + "DeviceOptions": { + "type": { + "$ref": "#/672" + }, + "flags": 0 + }, + "DeviceTrustProviderType": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The type of device-based trust provider. Possible values: jamf|crowdstrike" + }, + "LastUpdatedTime": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The last updated time." + }, + "OidcOptions": { + "type": { + "$ref": "#/673" + }, + "flags": 0 + }, + "PolicyReferenceName": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The identifier to be used when working with policy rules." + }, + "SseSpecification": { + "type": { + "$ref": "#/677" + }, + "flags": 0, + "description": "The configuration options for customer provided KMS encryption." + }, + "Tags": { + "type": { + "$ref": "#/678" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + }, + "TrustProviderType": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "Type of trust provider. Possible values: user|device" + }, + "UserTrustProviderType": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The type of device-based trust provider. Possible values: oidc|iam-identity-center" + }, + "VerifiedAccessTrustProviderId": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "The ID of the Amazon Web Services Verified Access trust provider." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/VerifiedAccessTrustProvider", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/679" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/VerifiedAccessTrustProvider@default", + "scopeType": 0, + "body": { + "$ref": "#/680" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The tag key." + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The tag value." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EC2/VolumeProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/682" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/VolumeProperties", + "properties": { + "AutoEnableIO": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Indicates whether the volume is auto-enabled for I/O operations. By default, Amazon EBS disables I/O to the volume from attached EC2 instances when it determines that a volume's data is potentially inconsistent. If the consistency of the volume is not a concern, and you prefer that the volume be made available immediately if it's impaired, you can configure the volume to automatically enable I/O." + }, + "AvailabilityZone": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The ID of the Availability Zone in which to create the volume. For example, ``us-east-1a``." + }, + "Encrypted": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Indicates whether the volume should be encrypted. The effect of setting the encryption state to ``true`` depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see [Encryption by default](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-by-default) in the *Amazon Elastic Compute Cloud User Guide*.\n Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see [Supported instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances)." + }, + "Iops": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The number of I/O operations per second (IOPS). For ``gp3``, ``io1``, and ``io2`` volumes, this represents the number of IOPS that are provisioned for the volume. For ``gp2`` volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.\n The 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\n \n For ``io2`` volumes, you can achieve up to 256,000 IOPS on [instances built 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.\n This parameter is required for ``io1`` and ``io2`` volumes. The default for ``gp3`` volumes is 3,000 IOPS. This parameter is not supported for ``gp2``, ``st1``, ``sc1``, or ``standard`` volumes." + }, + "KmsKeyId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The identifier of the kms-key-long to use for Amazon EBS encryption. If ``KmsKeyId`` is specified, the encrypted state must be ``true``.\n If you omit this property and your account is enabled for encryption by default, or *Encrypted* is set to ``true``, then the volume is encrypted using the default key specified for your account. If your account does not have a default key, then the volume is encrypted using the aws-managed-key.\n Alternatively, 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 ``my_cmk``, use ``alias/my_cmk``. Or to specify the aws-managed-key, use ``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." + }, + "MultiAttachEnabled": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Indicates whether Amazon EBS Multi-Attach is enabled.\n CFNlong does not currently support updating a single-attach volume to be multi-attach enabled, updating a multi-attach enabled volume to be single-attach, or updating the size or number of I/O operations per second (IOPS) of a multi-attach enabled volume." + }, + "OutpostArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the Outpost." + }, + "Size": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.\n The following are the supported volumes sizes for each volume type:\n + ``gp2`` and ``gp3``: 1 - 16,384 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" + }, + "SnapshotId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size." + }, + "Tags": { + "type": { + "$ref": "#/684" + }, + "flags": 0, + "description": "The tags to apply to the volume during creation." + }, + "Throughput": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The throughput to provision for a volume, with a maximum of 1,000 MiB/s.\n This parameter is valid only for ``gp3`` volumes. The default value is 125.\n Valid Range: Minimum value of 125. Maximum value of 1000." + }, + "VolumeId": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "" + }, + "VolumeType": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The volume type. This parameter can be one of the following values:\n + General Purpose SSD: ``gp2`` | ``gp3`` \n + Provisioned IOPS SSD: ``io1`` | ``io2`` \n + Throughput Optimized HDD: ``st1`` \n + Cold HDD: ``sc1`` \n + Magnetic: ``standard`` \n \n For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the *Amazon Elastic Compute Cloud User Guide*.\n Default: ``gp2``" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EC2/Volume", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/685" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EC2/Volume@default", + "scopeType": 0, + "body": { + "$ref": "#/686" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.ec2/default/types.md b/artifacts/bicep/aws/aws.ec2/default/types.md index b0bc61aa..921547e7 100644 --- a/artifacts/bicep/aws/aws.ec2/default/types.md +++ b/artifacts/bicep/aws/aws.ec2/default/types.md @@ -3,451 +3,539 @@ ## Resource AWS.EC2/CapacityReservation@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EC2/CapacityReservationProperties](#awsec2capacityreservationproperties) (Required): properties of the resource +* **properties**: [AWS.EC2/CapacityReservationProperties](#awsec2capacityreservationproperties) (Required, Identifier): properties of the resource ## Resource AWS.EC2/CapacityReservationFleet@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EC2/CapacityReservationFleetProperties](#awsec2capacityreservationfleetproperties): properties of the resource +* **properties**: [AWS.EC2/CapacityReservationFleetProperties](#awsec2capacityreservationfleetproperties) (Identifier): properties of the resource ## Resource AWS.EC2/CarrierGateway@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EC2/CarrierGatewayProperties](#awsec2carriergatewayproperties) (Required): properties of the resource +* **properties**: [AWS.EC2/CarrierGatewayProperties](#awsec2carriergatewayproperties) (Required, Identifier): properties of the resource ## Resource AWS.EC2/CustomerGateway@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EC2/CustomerGatewayProperties](#awsec2customergatewayproperties) (Required): properties of the resource +* **properties**: [AWS.EC2/CustomerGatewayProperties](#awsec2customergatewayproperties) (Required, Identifier): properties of the resource ## Resource AWS.EC2/DHCPOptions@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EC2/DHCPOptionsProperties](#awsec2dhcpoptionsproperties): properties of the resource +* **properties**: [AWS.EC2/DHCPOptionsProperties](#awsec2dhcpoptionsproperties) (Identifier): properties of the resource ## Resource AWS.EC2/EC2Fleet@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EC2/EC2FleetProperties](#awsec2ec2fleetproperties) (Required): properties of the resource +* **properties**: [AWS.EC2/EC2FleetProperties](#awsec2ec2fleetproperties) (Required, Identifier): properties of the resource ## Resource AWS.EC2/EIP@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EC2/EIPProperties](#awsec2eipproperties): properties of the resource +* **properties**: [AWS.EC2/EIPProperties](#awsec2eipproperties) (Identifier): properties of the resource ## Resource AWS.EC2/FlowLog@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EC2/FlowLogProperties](#awsec2flowlogproperties) (Required): properties of the resource +* **properties**: [AWS.EC2/FlowLogProperties](#awsec2flowlogproperties) (Required, Identifier): properties of the resource ## Resource AWS.EC2/GatewayRouteTableAssociation@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EC2/GatewayRouteTableAssociationProperties](#awsec2gatewayroutetableassociationproperties) (Required): properties of the resource +* **properties**: [AWS.EC2/GatewayRouteTableAssociationProperties](#awsec2gatewayroutetableassociationproperties) (Required, Identifier): properties of the resource ## Resource AWS.EC2/Host@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EC2/HostProperties](#awsec2hostproperties) (Required): properties of the resource +* **properties**: [AWS.EC2/HostProperties](#awsec2hostproperties) (Required, Identifier): properties of the resource ## Resource AWS.EC2/Instance@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EC2/InstanceProperties](#awsec2instanceproperties): properties of the resource +* **properties**: [AWS.EC2/InstanceProperties](#awsec2instanceproperties) (Identifier): properties of the resource ## Resource AWS.EC2/InstanceConnectEndpoint@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EC2/InstanceConnectEndpointProperties](#awsec2instanceconnectendpointproperties) (Required): properties of the resource +* **properties**: [AWS.EC2/InstanceConnectEndpointProperties](#awsec2instanceconnectendpointproperties) (Required, Identifier): properties of the resource ## Resource AWS.EC2/InternetGateway@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EC2/InternetGatewayProperties](#awsec2internetgatewayproperties): properties of the resource +* **properties**: [AWS.EC2/InternetGatewayProperties](#awsec2internetgatewayproperties) (Identifier): properties of the resource ## Resource AWS.EC2/IPAM@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EC2/IPAMProperties](#awsec2ipamproperties): properties of the resource +* **properties**: [AWS.EC2/IPAMProperties](#awsec2ipamproperties) (Identifier): properties of the resource ## Resource AWS.EC2/IPAMPool@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EC2/IPAMPoolProperties](#awsec2ipampoolproperties) (Required): properties of the resource +* **properties**: [AWS.EC2/IPAMPoolProperties](#awsec2ipampoolproperties) (Required, Identifier): properties of the resource ## Resource AWS.EC2/IPAMResourceDiscovery@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EC2/IPAMResourceDiscoveryProperties](#awsec2ipamresourcediscoveryproperties): properties of the resource +* **properties**: [AWS.EC2/IPAMResourceDiscoveryProperties](#awsec2ipamresourcediscoveryproperties) (Identifier): properties of the resource ## Resource AWS.EC2/IPAMResourceDiscoveryAssociation@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EC2/IPAMResourceDiscoveryAssociationProperties](#awsec2ipamresourcediscoveryassociationproperties) (Required): properties of the resource +* **properties**: [AWS.EC2/IPAMResourceDiscoveryAssociationProperties](#awsec2ipamresourcediscoveryassociationproperties) (Required, Identifier): properties of the resource ## Resource AWS.EC2/IPAMScope@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EC2/IPAMScopeProperties](#awsec2ipamscopeproperties) (Required): properties of the resource +* **properties**: [AWS.EC2/IPAMScopeProperties](#awsec2ipamscopeproperties) (Required, Identifier): properties of the resource ## Resource AWS.EC2/LaunchTemplate@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EC2/LaunchTemplateProperties](#awsec2launchtemplateproperties) (Required): properties of the resource +* **properties**: [AWS.EC2/LaunchTemplateProperties](#awsec2launchtemplateproperties) (Required, Identifier): properties of the resource ## Resource AWS.EC2/LocalGatewayRoute@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EC2/LocalGatewayRouteProperties](#awsec2localgatewayrouteproperties) (Required): properties of the resource +* **properties**: [AWS.EC2/LocalGatewayRouteProperties](#awsec2localgatewayrouteproperties) (Required, Identifier): properties of the resource ## Resource AWS.EC2/LocalGatewayRouteTable@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EC2/LocalGatewayRouteTableProperties](#awsec2localgatewayroutetableproperties) (Required): properties of the resource +* **properties**: [AWS.EC2/LocalGatewayRouteTableProperties](#awsec2localgatewayroutetableproperties) (Required, Identifier): properties of the resource ## Resource AWS.EC2/LocalGatewayRouteTableVirtualInterfaceGroupAssociation@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EC2/LocalGatewayRouteTableVirtualInterfaceGroupAssociationProperties](#awsec2localgatewayroutetablevirtualinterfacegroupassociationproperties) (Required): properties of the resource +* **properties**: [AWS.EC2/LocalGatewayRouteTableVirtualInterfaceGroupAssociationProperties](#awsec2localgatewayroutetablevirtualinterfacegroupassociationproperties) (Required, Identifier): properties of the resource ## Resource AWS.EC2/LocalGatewayRouteTableVPCAssociation@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EC2/LocalGatewayRouteTableVPCAssociationProperties](#awsec2localgatewayroutetablevpcassociationproperties) (Required): properties of the resource +* **properties**: [AWS.EC2/LocalGatewayRouteTableVPCAssociationProperties](#awsec2localgatewayroutetablevpcassociationproperties) (Required, Identifier): properties of the resource ## Resource AWS.EC2/NatGateway@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EC2/NatGatewayProperties](#awsec2natgatewayproperties) (Required): properties of the resource +* **properties**: [AWS.EC2/NatGatewayProperties](#awsec2natgatewayproperties) (Required, Identifier): properties of the resource ## Resource AWS.EC2/NetworkAcl@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EC2/NetworkAclProperties](#awsec2networkaclproperties) (Required): properties of the resource +* **properties**: [AWS.EC2/NetworkAclProperties](#awsec2networkaclproperties) (Required, Identifier): properties of the resource ## Resource AWS.EC2/NetworkInsightsAccessScope@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EC2/NetworkInsightsAccessScopeProperties](#awsec2networkinsightsaccessscopeproperties): properties of the resource +* **properties**: [AWS.EC2/NetworkInsightsAccessScopeProperties](#awsec2networkinsightsaccessscopeproperties) (Identifier): properties of the resource ## Resource AWS.EC2/NetworkInsightsAccessScopeAnalysis@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EC2/NetworkInsightsAccessScopeAnalysisProperties](#awsec2networkinsightsaccessscopeanalysisproperties) (Required): properties of the resource +* **properties**: [AWS.EC2/NetworkInsightsAccessScopeAnalysisProperties](#awsec2networkinsightsaccessscopeanalysisproperties) (Required, Identifier): properties of the resource ## Resource AWS.EC2/NetworkInsightsAnalysis@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EC2/NetworkInsightsAnalysisProperties](#awsec2networkinsightsanalysisproperties) (Required): properties of the resource +* **properties**: [AWS.EC2/NetworkInsightsAnalysisProperties](#awsec2networkinsightsanalysisproperties) (Required, Identifier): properties of the resource ## Resource AWS.EC2/NetworkInsightsPath@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EC2/NetworkInsightsPathProperties](#awsec2networkinsightspathproperties) (Required): properties of the resource +* **properties**: [AWS.EC2/NetworkInsightsPathProperties](#awsec2networkinsightspathproperties) (Required, Identifier): properties of the resource ## Resource AWS.EC2/NetworkInterface@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EC2/NetworkInterfaceProperties](#awsec2networkinterfaceproperties) (Required): properties of the resource +* **properties**: [AWS.EC2/NetworkInterfaceProperties](#awsec2networkinterfaceproperties) (Required, Identifier): properties of the resource ## Resource AWS.EC2/NetworkInterfaceAttachment@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EC2/NetworkInterfaceAttachmentProperties](#awsec2networkinterfaceattachmentproperties) (Required): properties of the resource +* **properties**: [AWS.EC2/NetworkInterfaceAttachmentProperties](#awsec2networkinterfaceattachmentproperties) (Required, Identifier): properties of the resource ## Resource AWS.EC2/PrefixList@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EC2/PrefixListProperties](#awsec2prefixlistproperties) (Required): properties of the resource +* **properties**: [AWS.EC2/PrefixListProperties](#awsec2prefixlistproperties) (Required, Identifier): properties of the resource ## Resource AWS.EC2/Route@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EC2/RouteProperties](#awsec2routeproperties) (Required): properties of the resource +* **properties**: [AWS.EC2/RouteProperties](#awsec2routeproperties) (Required, Identifier): properties of the resource ## Resource AWS.EC2/RouteTable@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EC2/RouteTableProperties](#awsec2routetableproperties) (Required): properties of the resource +* **properties**: [AWS.EC2/RouteTableProperties](#awsec2routetableproperties) (Required, Identifier): properties of the resource ## Resource AWS.EC2/SecurityGroup@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EC2/SecurityGroupProperties](#awsec2securitygroupproperties) (Required): properties of the resource +* **properties**: [AWS.EC2/SecurityGroupProperties](#awsec2securitygroupproperties) (Required, Identifier): properties of the resource ## Resource AWS.EC2/SecurityGroupEgress@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EC2/SecurityGroupEgressProperties](#awsec2securitygroupegressproperties) (Required): properties of the resource +* **properties**: [AWS.EC2/SecurityGroupEgressProperties](#awsec2securitygroupegressproperties) (Required, Identifier): properties of the resource + +## Resource AWS.EC2/SecurityGroupIngress@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.EC2/SecurityGroupIngressProperties](#awsec2securitygroupingressproperties) (Required, Identifier): properties of the resource ## Resource AWS.EC2/SnapshotBlockPublicAccess@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EC2/SnapshotBlockPublicAccessProperties](#awsec2snapshotblockpublicaccessproperties) (Required): properties of the resource +* **properties**: [AWS.EC2/SnapshotBlockPublicAccessProperties](#awsec2snapshotblockpublicaccessproperties) (Required, Identifier): properties of the resource ## Resource AWS.EC2/SpotFleet@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EC2/SpotFleetProperties](#awsec2spotfleetproperties) (Required): properties of the resource +* **properties**: [AWS.EC2/SpotFleetProperties](#awsec2spotfleetproperties) (Required, Identifier): properties of the resource ## Resource AWS.EC2/Subnet@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EC2/SubnetProperties](#awsec2subnetproperties) (Required): properties of the resource +* **properties**: [AWS.EC2/SubnetProperties](#awsec2subnetproperties) (Required, Identifier): properties of the resource ## Resource AWS.EC2/TransitGateway@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EC2/TransitGatewayProperties](#awsec2transitgatewayproperties): properties of the resource +* **properties**: [AWS.EC2/TransitGatewayProperties](#awsec2transitgatewayproperties) (Identifier): properties of the resource ## Resource AWS.EC2/TransitGatewayAttachment@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EC2/TransitGatewayAttachmentProperties](#awsec2transitgatewayattachmentproperties) (Required): properties of the resource +* **properties**: [AWS.EC2/TransitGatewayAttachmentProperties](#awsec2transitgatewayattachmentproperties) (Required, Identifier): properties of the resource ## Resource AWS.EC2/TransitGatewayConnect@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EC2/TransitGatewayConnectProperties](#awsec2transitgatewayconnectproperties) (Required): properties of the resource +* **properties**: [AWS.EC2/TransitGatewayConnectProperties](#awsec2transitgatewayconnectproperties) (Required, Identifier): properties of the resource ## Resource AWS.EC2/TransitGatewayMulticastDomain@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EC2/TransitGatewayMulticastDomainProperties](#awsec2transitgatewaymulticastdomainproperties) (Required): properties of the resource +* **properties**: [AWS.EC2/TransitGatewayMulticastDomainProperties](#awsec2transitgatewaymulticastdomainproperties) (Required, Identifier): properties of the resource ## Resource AWS.EC2/TransitGatewayPeeringAttachment@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EC2/TransitGatewayPeeringAttachmentProperties](#awsec2transitgatewaypeeringattachmentproperties) (Required): properties of the resource +* **properties**: [AWS.EC2/TransitGatewayPeeringAttachmentProperties](#awsec2transitgatewaypeeringattachmentproperties) (Required, Identifier): properties of the resource ## Resource AWS.EC2/TransitGatewayVpcAttachment@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EC2/TransitGatewayVpcAttachmentProperties](#awsec2transitgatewayvpcattachmentproperties) (Required): properties of the resource +* **properties**: [AWS.EC2/TransitGatewayVpcAttachmentProperties](#awsec2transitgatewayvpcattachmentproperties) (Required, Identifier): properties of the resource ## Resource AWS.EC2/VerifiedAccessEndpoint@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EC2/VerifiedAccessEndpointProperties](#awsec2verifiedaccessendpointproperties) (Required): properties of the resource +* **properties**: [AWS.EC2/VerifiedAccessEndpointProperties](#awsec2verifiedaccessendpointproperties) (Required, Identifier): properties of the resource ## Resource AWS.EC2/VerifiedAccessGroup@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EC2/VerifiedAccessGroupProperties](#awsec2verifiedaccessgroupproperties) (Required): properties of the resource +* **properties**: [AWS.EC2/VerifiedAccessGroupProperties](#awsec2verifiedaccessgroupproperties) (Required, Identifier): properties of the resource ## Resource AWS.EC2/VerifiedAccessInstance@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EC2/VerifiedAccessInstanceProperties](#awsec2verifiedaccessinstanceproperties): properties of the resource +* **properties**: [AWS.EC2/VerifiedAccessInstanceProperties](#awsec2verifiedaccessinstanceproperties) (Identifier): properties of the resource ## Resource AWS.EC2/VerifiedAccessTrustProvider@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EC2/VerifiedAccessTrustProviderProperties](#awsec2verifiedaccesstrustproviderproperties) (Required): properties of the resource +* **properties**: [AWS.EC2/VerifiedAccessTrustProviderProperties](#awsec2verifiedaccesstrustproviderproperties) (Required, Identifier): properties of the resource ## Resource AWS.EC2/Volume@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EC2/VolumeProperties](#awsec2volumeproperties) (Required): properties of the resource +* **properties**: [AWS.EC2/VolumeProperties](#awsec2volumeproperties) (Required, Identifier): properties of the resource ## Resource AWS.EC2/VPC@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EC2/VPCProperties](#awsec2vpcproperties): properties of the resource +* **properties**: [AWS.EC2/VPCProperties](#awsec2vpcproperties) (Identifier): properties of the resource ## Resource AWS.EC2/VPCDHCPOptionsAssociation@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EC2/VPCDHCPOptionsAssociationProperties](#awsec2vpcdhcpoptionsassociationproperties) (Required): properties of the resource +* **properties**: [AWS.EC2/VPCDHCPOptionsAssociationProperties](#awsec2vpcdhcpoptionsassociationproperties) (Required, Identifier): properties of the resource ## Resource AWS.EC2/VPCEndpoint@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EC2/VPCEndpointProperties](#awsec2vpcendpointproperties) (Required): properties of the resource +* **properties**: [AWS.EC2/VPCEndpointProperties](#awsec2vpcendpointproperties) (Required, Identifier): properties of the resource ## Resource AWS.EC2/VPCEndpointConnectionNotification@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EC2/VPCEndpointConnectionNotificationProperties](#awsec2vpcendpointconnectionnotificationproperties) (Required): properties of the resource +* **properties**: [AWS.EC2/VPCEndpointConnectionNotificationProperties](#awsec2vpcendpointconnectionnotificationproperties) (Required, Identifier): properties of the resource ## Resource AWS.EC2/VPCEndpointService@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EC2/VPCEndpointServiceProperties](#awsec2vpcendpointserviceproperties): properties of the resource +* **properties**: [AWS.EC2/VPCEndpointServiceProperties](#awsec2vpcendpointserviceproperties) (Identifier): properties of the resource ## Resource AWS.EC2/VPCEndpointServicePermissions@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EC2/VPCEndpointServicePermissionsProperties](#awsec2vpcendpointservicepermissionsproperties) (Required): properties of the resource +* **properties**: [AWS.EC2/VPCEndpointServicePermissionsProperties](#awsec2vpcendpointservicepermissionsproperties) (Required, Identifier): properties of the resource ## Resource AWS.EC2/VPCGatewayAttachment@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EC2/VPCGatewayAttachmentProperties](#awsec2vpcgatewayattachmentproperties) (Required): properties of the resource +* **properties**: [AWS.EC2/VPCGatewayAttachmentProperties](#awsec2vpcgatewayattachmentproperties) (Required, Identifier): properties of the resource ## Resource AWS.EC2/VPCPeeringConnection@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EC2/VPCPeeringConnectionProperties](#awsec2vpcpeeringconnectionproperties) (Required): properties of the resource +* **properties**: [AWS.EC2/VPCPeeringConnectionProperties](#awsec2vpcpeeringconnectionproperties) (Required, Identifier): properties of the resource ## Resource AWS.EC2/VPNConnection@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EC2/VPNConnectionProperties](#awsec2vpnconnectionproperties) (Required): properties of the resource +* **properties**: [AWS.EC2/VPNConnectionProperties](#awsec2vpnconnectionproperties) (Required, Identifier): properties of the resource ## Resource AWS.EC2/VPNGateway@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EC2/VPNGatewayProperties](#awsec2vpngatewayproperties) (Required): properties of the resource +* **properties**: [AWS.EC2/VPNGatewayProperties](#awsec2vpngatewayproperties) (Required, Identifier): properties of the resource -## AWS.EC2/CapacityReservationProperties +## AcceleratorCount ### Properties -* **AvailabilityZone**: string (Required) -* **AvailableInstanceCount**: int (ReadOnly) -* **EbsOptimized**: bool -* **EndDate**: string -* **EndDateType**: string -* **EphemeralStorage**: bool -* **Id**: string (ReadOnly, Identifier) -* **InstanceCount**: int (Required) -* **InstanceMatchCriteria**: string -* **InstancePlatform**: string (Required) -* **InstanceType**: string (Required) -* **OutPostArn**: string -* **PlacementGroupArn**: string -* **TagSpecifications**: [TagSpecification](#tagspecification)[] -* **Tenancy**: string -* **TotalInstanceCount**: int (ReadOnly) +* **Max**: int: The maximum number of accelerators. To specify no maximum limit, omit this parameter. To exclude accelerator-enabled instance types, set ``Max`` to ``0``. +* **Min**: int: The minimum number of accelerators. To specify no minimum limit, omit this parameter. -## TagSpecification +## AcceleratorCountRequest ### Properties -* **ResourceType**: string -* **Tags**: [Tag](#tag)[] +* **Max**: int +* **Min**: int -## Tag +## AcceleratorCountRequest ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **Max**: int +* **Min**: int + +## AcceleratorTotalMemoryMiB +### Properties +* **Max**: int: The maximum amount of accelerator memory, in MiB. To specify no maximum limit, omit this parameter. +* **Min**: int: The minimum amount of accelerator memory, in MiB. To specify no minimum limit, omit this parameter. + +## AcceleratorTotalMemoryMiBRequest +### Properties +* **Max**: int +* **Min**: int + +## AcceleratorTotalMemoryMiBRequest +### Properties +* **Max**: int +* **Min**: int + +## AccessScopePathRequest +### Properties +* **Destination**: [PathStatementRequest](#pathstatementrequest) +* **Source**: [PathStatementRequest](#pathstatementrequest) +* **ThroughResources**: [ThroughResourcesStatementRequest](#throughresourcesstatementrequest)[] + +## AdditionalDetail +### Properties +* **AdditionalDetailType**: string +* **Component**: [AnalysisComponent](#analysiscomponent) +* **LoadBalancers**: [AnalysisComponent](#analysiscomponent)[] +* **ServiceName**: string + +## AlternatePathHint +### Properties +* **ComponentArn**: string +* **ComponentId**: string + +## AnalysisAclRule +### Properties +* **Cidr**: string +* **Egress**: bool +* **PortRange**: [PortRange](#portrange) +* **Protocol**: string +* **RuleAction**: string +* **RuleNumber**: int + +## AnalysisComponent +### Properties +* **Arn**: string +* **Id**: string + +## AnalysisLoadBalancerListener +### Properties +* **InstancePort**: int +* **LoadBalancerPort**: int + +## AnalysisLoadBalancerTarget +### Properties +* **Address**: string +* **AvailabilityZone**: string +* **Instance**: [AnalysisComponent](#analysiscomponent) +* **Port**: int + +## AnalysisPacketHeader +### Properties +* **DestinationAddresses**: string[] +* **DestinationPortRanges**: [PortRange](#portrange)[] +* **Protocol**: string +* **SourceAddresses**: string[] +* **SourcePortRanges**: [PortRange](#portrange)[] + +## AnalysisRouteTableRoute +### Properties +* **destinationCidr**: string +* **destinationPrefixListId**: string +* **egressOnlyInternetGatewayId**: string +* **gatewayId**: string +* **instanceId**: string +* **NatGatewayId**: string +* **NetworkInterfaceId**: string +* **Origin**: string +* **State**: string +* **TransitGatewayId**: string +* **VpcPeeringConnectionId**: string + +## AnalysisSecurityGroupRule +### Properties +* **Cidr**: string +* **Direction**: string +* **PortRange**: [PortRange](#portrange) +* **PrefixListId**: string +* **Protocol**: string +* **SecurityGroupId**: string + +## AssociationParameter +### Properties +* **Key**: string (Required): The name of an input parameter that is in the associated SSM document. +* **Value**: string[] (Required): The value of an input parameter. ## AWS.EC2/CapacityReservationFleetProperties ### Properties @@ -462,25 +550,24 @@ * **Tenancy**: string * **TotalTargetCapacity**: int -## InstanceTypeSpecification +## AWS.EC2/CapacityReservationProperties ### Properties -* **AvailabilityZone**: string -* **AvailabilityZoneId**: string +* **AvailabilityZone**: string (Required) +* **AvailableInstanceCount**: int (ReadOnly) * **EbsOptimized**: bool -* **InstancePlatform**: string -* **InstanceType**: string -* **Priority**: int -* **Weight**: int - -## TagSpecification -### Properties -* **ResourceType**: string -* **Tags**: [Tag](#tag)[] - -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **EndDate**: string +* **EndDateType**: string +* **EphemeralStorage**: bool +* **Id**: string (ReadOnly, Identifier) +* **InstanceCount**: int (Required) +* **InstanceMatchCriteria**: string +* **InstancePlatform**: string (Required) +* **InstanceType**: string (Required) +* **OutPostArn**: string +* **PlacementGroupArn**: string +* **TagSpecifications**: [TagSpecification](#tagspecification)[] +* **Tenancy**: string +* **TotalInstanceCount**: int (ReadOnly) ## AWS.EC2/CarrierGatewayProperties ### Properties @@ -490,40 +577,31 @@ * **Tags**: [Tag](#tag)[]: The tags for the carrier gateway. * **VpcId**: string (Required): The ID of the VPC. -## Tag -### Properties -* **Key**: string -* **Value**: string - ## AWS.EC2/CustomerGatewayProperties ### Properties -* **BgpAsn**: int (Required): For devices that support BGP, the customer gateway's BGP ASN. -* **CustomerGatewayId**: string (ReadOnly, Identifier): CustomerGateway ID generated after customer gateway is created. Each customer gateway has a unique ID. -* **DeviceName**: string: A name for the customer gateway device. -* **IpAddress**: string (Required): The internet-routable IP address for the customer gateway's outside interface. The address must be static. +* **BgpAsn**: int: For 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``. + Default: 65000 + Valid values: ``1`` to ``2,147,483,647`` +* **BgpAsnExtended**: int: For 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``. + Valid values: ``2,147,483,648`` to ``4,294,967,295`` +* **CertificateArn**: string: The Amazon Resource Name (ARN) for the customer gateway certificate. +* **CustomerGatewayId**: string (ReadOnly, Identifier) +* **DeviceName**: string: The name of customer gateway device. +* **IpAddress**: string (Required): IPv4 address for the customer gateway device's outside interface. The address must be static. If ``OutsideIpAddressType`` in your VPN connection options is set to ``PrivateIpv4``, you can use an RFC6598 or RFC1918 private IPv4 address. If ``OutsideIpAddressType`` is set to ``PublicIpv4``, you can use a public IPv4 address. * **Tags**: [Tag](#tag)[]: One or more tags for the customer gateway. -* **Type**: string (Required): The type of VPN connection that this customer gateway supports. - -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **Type**: string (Required): The type of VPN connection that this customer gateway supports (``ipsec.1``). ## AWS.EC2/DHCPOptionsProperties ### Properties * **DhcpOptionsId**: string (ReadOnly, Identifier) * **DomainName**: string: This value is used to complete unqualified DNS hostnames. * **DomainNameServers**: string[]: The IPv4 addresses of up to four domain name servers, or AmazonProvidedDNS. +* **Ipv6AddressPreferredLeaseTime**: int: The preferred Lease Time for ipV6 address in seconds. * **NetbiosNameServers**: string[]: The IPv4 addresses of up to four NetBIOS name servers. * **NetbiosNodeType**: int: The NetBIOS node type (1, 2, 4, or 8). * **NtpServers**: string[]: The IPv4 addresses of up to four Network Time Protocol (NTP) servers. * **Tags**: [Tag](#tag)[]: Any tags assigned to the DHCP options set. -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - ## AWS.EC2/EC2FleetProperties ### Properties * **Context**: string @@ -540,1103 +618,1655 @@ * **ValidFrom**: string * **ValidUntil**: string -## FleetLaunchTemplateConfigRequest +## AWS.EC2/EIPProperties ### Properties -* **LaunchTemplateSpecification**: [FleetLaunchTemplateSpecificationRequest](#fleetlaunchtemplatespecificationrequest) -* **Overrides**: [FleetLaunchTemplateOverridesRequest](#fleetlaunchtemplateoverridesrequest)[] +* **AllocationId**: string (ReadOnly, Identifier) +* **Domain**: string: The network (``vpc``). + If you define an Elastic IP address and associate it with a VPC that is defined in the same template, you must declare a dependency on the VPC-gateway attachment by using the [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) on this resource. +* **InstanceId**: string: The ID of the instance. + Updates to the ``InstanceId`` property may require *some interruptions*. Updates on an EIP reassociates the address on its associated resource. +* **NetworkBorderGroup**: string: A unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses. Use this parameter to limit the IP address to this location. IP addresses cannot move between network border groups. + Use [DescribeAvailabilityZones](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeAvailabilityZones.html) to view the network border groups. +* **PublicIp**: string (ReadOnly, Identifier) +* **PublicIpv4Pool**: string: The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool. + Updates to the ``PublicIpv4Pool`` property may require *some interruptions*. Updates on an EIP reassociates the address on its associated resource. +* **Tags**: [Tag](#tag)[]: Any tags assigned to the Elastic IP address. + Updates to the ``Tags`` property may require *some interruptions*. Updates on an EIP reassociates the address on its associated resource. +* **TransferAddress**: string (WriteOnly): The Elastic IP address you are accepting for transfer. You can only accept one transferred address. For more information on Elastic IP address transfers, see [Transfer Elastic IP addresses](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#transfer-EIPs-intro) in the *Amazon Virtual Private Cloud User Guide*. -## FleetLaunchTemplateSpecificationRequest +## AWS.EC2/FlowLogProperties ### Properties -* **LaunchTemplateId**: string -* **LaunchTemplateName**: string -* **Version**: string (Required) +* **DeliverCrossAccountRole**: string: The ARN of the IAM role that allows Amazon EC2 to publish flow logs across accounts. +* **DeliverLogsPermissionArn**: string: The ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account. If you specify LogDestinationType as s3 or kinesis-data-firehose, do not specify DeliverLogsPermissionArn or LogGroupName. +* **DestinationOptions**: [FlowLog_DestinationOptions](#flowlogdestinationoptions) +* **Id**: string (ReadOnly, Identifier): The Flow Log ID +* **LogDestination**: string: Specifies the destination to which the flow log data is to be published. Flow log data can be published to a CloudWatch Logs log group, an Amazon S3 bucket, or a Kinesis Firehose stream. The value specified for this parameter depends on the value specified for LogDestinationType. +* **LogDestinationType**: string: Specifies the type of destination to which the flow log data is to be published. Flow log data can be published to CloudWatch Logs or Amazon S3. +* **LogFormat**: string: The fields to include in the flow log record, in the order in which they should appear. +* **LogGroupName**: string: The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs. If you specify LogDestinationType as s3 or kinesis-data-firehose, do not specify DeliverLogsPermissionArn or LogGroupName. +* **MaxAggregationInterval**: int: The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. You can specify 60 seconds (1 minute) or 600 seconds (10 minutes). +* **ResourceId**: string (Required): The ID of the subnet, network interface, or VPC for which you want to create a flow log. +* **ResourceType**: string (Required): The type of resource for which to create the flow log. For example, if you specified a VPC ID for the ResourceId property, specify VPC for this property. +* **Tags**: [Tag](#tag)[]: The tags to apply to the flow logs. +* **TrafficType**: string: The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic. -## FleetLaunchTemplateOverridesRequest +## AWS.EC2/GatewayRouteTableAssociationProperties ### Properties -* **AvailabilityZone**: string -* **InstanceRequirements**: [InstanceRequirementsRequest](#instancerequirementsrequest) -* **InstanceType**: string -* **MaxPrice**: string -* **Placement**: [Placement](#placement) -* **Priority**: int -* **SubnetId**: string -* **WeightedCapacity**: int +* **AssociationId**: string (ReadOnly): The route table association ID. +* **GatewayId**: string (Required, Identifier): The ID of the gateway. +* **RouteTableId**: string (Required): The ID of the route table. -## InstanceRequirementsRequest +## AWS.EC2/HostProperties ### Properties -* **AcceleratorCount**: [AcceleratorCountRequest](#acceleratorcountrequest) -* **AcceleratorManufacturers**: string[] -* **AcceleratorNames**: string[] -* **AcceleratorTotalMemoryMiB**: [AcceleratorTotalMemoryMiBRequest](#acceleratortotalmemorymibrequest) -* **AcceleratorTypes**: string[] -* **AllowedInstanceTypes**: string[] -* **BareMetal**: string -* **BaselineEbsBandwidthMbps**: [BaselineEbsBandwidthMbpsRequest](#baselineebsbandwidthmbpsrequest) -* **BurstablePerformance**: string -* **CpuManufacturers**: string[] -* **ExcludedInstanceTypes**: string[] -* **InstanceGenerations**: string[] -* **LocalStorage**: string -* **LocalStorageTypes**: string[] -* **MemoryGiBPerVCpu**: [MemoryGiBPerVCpuRequest](#memorygibpervcpurequest) -* **MemoryMiB**: [MemoryMiBRequest](#memorymibrequest) -* **NetworkBandwidthGbps**: [NetworkBandwidthGbpsRequest](#networkbandwidthgbpsrequest) -* **NetworkInterfaceCount**: [NetworkInterfaceCountRequest](#networkinterfacecountrequest) -* **OnDemandMaxPricePercentageOverLowestPrice**: int -* **RequireHibernateSupport**: bool -* **SpotMaxPricePercentageOverLowestPrice**: int -* **TotalLocalStorageGB**: [TotalLocalStorageGBRequest](#totallocalstoragegbrequest) -* **VCpuCount**: [VCpuCountRangeRequest](#vcpucountrangerequest) +* **AssetId**: string: The ID of the Outpost hardware asset. +* **AutoPlacement**: string: Indicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance launches that specify its unique host ID. +* **AvailabilityZone**: string (Required): The Availability Zone in which to allocate the Dedicated Host. +* **HostId**: string (ReadOnly, Identifier): ID of the host created. +* **HostMaintenance**: string: Automatically allocates a new dedicated host and moves your instances on to it if a degradation is detected on your current host. +* **HostRecovery**: string: Indicates whether to enable or disable host recovery for the Dedicated Host. Host recovery is disabled by default. +* **InstanceFamily**: string: Specifies the instance family to be supported by the Dedicated Hosts. If you specify an instance family, the Dedicated Hosts support multiple instance types within that instance family. +* **InstanceType**: string: Specifies the instance type to be supported by the Dedicated Hosts. If you specify an instance type, the Dedicated Hosts support instances of the specified instance type only. +* **OutpostArn**: string: The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which to allocate the Dedicated Host. -## AcceleratorCountRequest +## AWS.EC2/InstanceConnectEndpointProperties ### Properties -* **Max**: int -* **Min**: int +* **ClientToken**: string (WriteOnly): The client token of the instance connect endpoint. +* **Id**: string (ReadOnly, Identifier): The id of the instance connect endpoint +* **PreserveClientIp**: bool: If true, the address of the instance connect endpoint client is preserved when connecting to the end resource +* **SecurityGroupIds**: string[]: The security group IDs of the instance connect endpoint. +* **SubnetId**: string (Required): The subnet id of the instance connect endpoint +* **Tags**: [Tag](#tag)[]: The tags of the instance connect endpoint. -## AcceleratorTotalMemoryMiBRequest +## AWS.EC2/InstanceProperties ### Properties -* **Max**: int -* **Min**: int +* **AdditionalInfo**: string (WriteOnly): This property is reserved for internal use. If you use it, the stack fails with this error: Bad property set: [Testing this property] (Service: AmazonEC2; Status Code: 400; Error Code: InvalidParameterCombination; Request ID: 0XXXXXX-49c7-4b40-8bcc-76885dcXXXXX). +* **Affinity**: string: Indicates whether the instance is associated with a dedicated host. If you want the instance to always restart on the same host on which it was launched, specify host. If you want the instance to restart on any available host, but try to launch onto the last host it ran on (on a best-effort basis), specify default. +* **AvailabilityZone**: string: The Availability Zone of the instance. +* **BlockDeviceMappings**: [BlockDeviceMapping](#blockdevicemapping)[] (WriteOnly): The block device mapping entries that defines the block devices to attach to the instance at launch. +* **CpuOptions**: [Instance_CpuOptions](#instancecpuoptions): The CPU options for the instance. +* **CreditSpecification**: [Instance_CreditSpecification](#instancecreditspecification): The credit option for CPU usage of the burstable performance instance. Valid values are standard and unlimited. +* **DisableApiTermination**: bool: If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. +* **EbsOptimized**: bool: Indicates whether the instance is optimized for Amazon EBS I/O. +* **ElasticGpuSpecifications**: [ElasticGpuSpecification](#elasticgpuspecification)[]: An elastic GPU to associate with the instance. +* **ElasticInferenceAccelerators**: [ElasticInferenceAccelerator](#elasticinferenceaccelerator)[]: An elastic inference accelerator to associate with the instance. +* **EnclaveOptions**: [Instance_EnclaveOptions](#instanceenclaveoptions): Indicates whether the instance is enabled for AWS Nitro Enclaves. +* **HibernationOptions**: [Instance_HibernationOptions](#instancehibernationoptions): Indicates whether an instance is enabled for hibernation. +* **HostId**: string: If you specify host for the Affinity property, the ID of a dedicated host that the instance is associated with. If you don't specify an ID, Amazon EC2 launches the instance onto any available, compatible dedicated host in your account. +* **HostResourceGroupArn**: string: The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host. +* **IamInstanceProfile**: string: The IAM instance profile. +* **ImageId**: string: The ID of the AMI. An AMI ID is required to launch an instance and must be specified here or in a launch template. +* **InstanceId**: string (ReadOnly, Identifier): The EC2 Instance ID. +* **InstanceInitiatedShutdownBehavior**: string: Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown). +* **InstanceType**: string: The instance type. +* **Ipv6AddressCount**: int (WriteOnly): [EC2-VPC] The number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet. +* **Ipv6Addresses**: [InstanceIpv6Address](#instanceipv6address)[] (WriteOnly): [EC2-VPC] The IPv6 addresses from the range of the subnet to associate with the primary network interface. +* **KernelId**: string: The ID of the kernel. +* **KeyName**: string: The name of the key pair. +* **LaunchTemplate**: [Instance_LaunchTemplateSpecification](#instancelaunchtemplatespecification): The launch template to use to launch the instances. +* **LicenseSpecifications**: [LicenseSpecification](#licensespecification)[]: The license configurations. +* **Monitoring**: bool: Specifies whether detailed monitoring is enabled for the instance. +* **NetworkInterfaces**: [NetworkInterface](#networkinterface)[]: The network interfaces to associate with the instance. +* **PlacementGroupName**: string: The name of an existing placement group that you want to launch the instance into (cluster | partition | spread). +* **PrivateDnsName**: string (ReadOnly): The private DNS name of the specified instance. For example: ip-10-24-34-0.ec2.internal. +* **PrivateDnsNameOptions**: [Instance_PrivateDnsNameOptions](#instanceprivatednsnameoptions): The options for the instance hostname. +* **PrivateIp**: string (ReadOnly): The private IP address of the specified instance. For example: 10.24.34.0. +* **PrivateIpAddress**: string: [EC2-VPC] The primary IPv4 address. You must specify a value from the IPv4 address range of the subnet. +* **PropagateTagsToVolumeOnCreation**: bool (WriteOnly): Indicates whether to assign the tags from the instance to all of the volumes attached to the instance at launch. If you specify true and you assign tags to the instance, those tags are automatically assigned to all of the volumes that you attach to the instance at launch. If you specify false, those tags are not assigned to the attached volumes. +* **PublicDnsName**: string (ReadOnly): The public DNS name of the specified instance. For example: ec2-107-20-50-45.compute-1.amazonaws.com. +* **PublicIp**: string (ReadOnly): The public IP address of the specified instance. For example: 192.0.2.0. +* **RamdiskId**: string: The ID of the RAM disk to select. +* **SecurityGroupIds**: string[]: The IDs of the security groups. +* **SecurityGroups**: string[]: the names of the security groups. For a nondefault VPC, you must use security group IDs instead. +* **SourceDestCheck**: bool: Specifies whether to enable an instance launched in a VPC to perform NAT. +* **SsmAssociations**: [SsmAssociation](#ssmassociation)[]: The SSM document and parameter values in AWS Systems Manager to associate with this instance. +* **State**: [Instance_State](#instancestate) (ReadOnly): The current state of the instance. +* **SubnetId**: string: [EC2-VPC] The ID of the subnet to launch the instance into. + + +* **Tags**: [Tag](#tag)[]: The tags to add to the instance. +* **Tenancy**: string: The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. +* **UserData**: string: The user data to make available to the instance. +* **Volumes**: [Volume](#volume)[]: The volumes to attach to the instance. +* **VpcId**: string (ReadOnly): The ID of the VPC that the instance is running in. -## BaselineEbsBandwidthMbpsRequest +## AWS.EC2/InternetGatewayProperties ### Properties -* **Max**: int -* **Min**: int +* **InternetGatewayId**: string (ReadOnly, Identifier) +* **Tags**: [Tag](#tag)[]: Any tags to assign to the internet gateway. -## MemoryGiBPerVCpuRequest +## AWS.EC2/IPAMPoolProperties ### Properties -* **Max**: int -* **Min**: int +* **AddressFamily**: string (Required): The address family of the address space in this pool. Either IPv4 or IPv6. +* **AllocationDefaultNetmaskLength**: int: The default netmask length for allocations made from this pool. This value is used when the netmask length of an allocation isn't specified. +* **AllocationMaxNetmaskLength**: int: The maximum allowed netmask length for allocations made from this pool. +* **AllocationMinNetmaskLength**: int: The minimum allowed netmask length for allocations made from this pool. +* **AllocationResourceTags**: [Tag](#tag)[]: When specified, an allocation will not be allowed unless a resource has a matching set of tags. +* **Arn**: string (ReadOnly): The Amazon Resource Name (ARN) of the IPAM Pool. +* **AutoImport**: bool: Determines what to do if IPAM discovers resources that haven't been assigned an allocation. If set to true, an allocation will be made automatically. +* **AwsService**: string: Limits which service in Amazon Web Services that the pool can be used in. +* **Description**: string +* **IpamArn**: string (ReadOnly): The Amazon Resource Name (ARN) of the IPAM this pool is a part of. +* **IpamPoolId**: string (ReadOnly, Identifier): Id of the IPAM Pool. +* **IpamScopeArn**: string (ReadOnly): The Amazon Resource Name (ARN) of the scope this pool is a part of. +* **IpamScopeId**: string (Required): The Id of the scope this pool is a part of. +* **IpamScopeType**: string (ReadOnly): Determines whether this scope contains publicly routable space or space for a private network +* **Locale**: string: The region of this pool. If not set, this will default to "None" which will disable non-custom allocations. If the locale has been specified for the source pool, this value must match. +* **PoolDepth**: int (ReadOnly): The depth of this pool in the source pool hierarchy. +* **ProvisionedCidrs**: [ProvisionedCidr](#provisionedcidr)[]: A list of cidrs representing the address space available for allocation in this pool. +* **PublicIpSource**: string: The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is `byoip`. +* **PubliclyAdvertisable**: bool: Determines whether or not address space from this pool is publicly advertised. Must be set if and only if the pool is IPv6. +* **SourceIpamPoolId**: string: The Id of this pool's source. If set, all space provisioned in this pool must be free space provisioned in the parent pool. +* **SourceResource**: [SourceResource](#sourceresource) +* **State**: string (ReadOnly): The state of this pool. This can be one of the following values: "create-in-progress", "create-complete", "modify-in-progress", "modify-complete", "delete-in-progress", or "delete-complete" +* **StateMessage**: string (ReadOnly): An explanation of how the pool arrived at it current state. +* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. -## MemoryMiBRequest +## AWS.EC2/IPAMProperties ### Properties -* **Max**: int -* **Min**: int +* **Arn**: string (ReadOnly): The Amazon Resource Name (ARN) of the IPAM. +* **DefaultResourceDiscoveryAssociationId**: string (ReadOnly): The Id of the default association to the default resource discovery, created with this IPAM. +* **DefaultResourceDiscoveryId**: string (ReadOnly): The Id of the default resource discovery, created with this IPAM. +* **Description**: string +* **IpamId**: string (ReadOnly, Identifier): Id of the IPAM. +* **OperatingRegions**: [IpamOperatingRegion](#ipamoperatingregion)[]: The regions IPAM is enabled for. Allows pools to be created in these regions, as well as enabling monitoring +* **PrivateDefaultScopeId**: string (ReadOnly): The Id of the default scope for publicly routable IP space, created with this IPAM. +* **PublicDefaultScopeId**: string (ReadOnly): The Id of the default scope for publicly routable IP space, created with this IPAM. +* **ResourceDiscoveryAssociationCount**: int (ReadOnly): The count of resource discoveries associated with this IPAM. +* **ScopeCount**: int (ReadOnly): The number of scopes that currently exist in this IPAM. +* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. +* **Tier**: string: The tier of the IPAM. -## NetworkBandwidthGbpsRequest +## AWS.EC2/IPAMResourceDiscoveryAssociationProperties ### Properties -* **Max**: int -* **Min**: int +* **IpamArn**: string (ReadOnly): Arn of the IPAM. +* **IpamId**: string (Required): The Id of the IPAM this Resource Discovery is associated to. +* **IpamRegion**: string (ReadOnly): The home region of the IPAM. +* **IpamResourceDiscoveryAssociationArn**: string (ReadOnly): The Amazon Resource Name (ARN) of the resource discovery association is a part of. +* **IpamResourceDiscoveryAssociationId**: string (ReadOnly, Identifier): Id of the IPAM Resource Discovery Association. +* **IpamResourceDiscoveryId**: string (Required): The Amazon Resource Name (ARN) of the IPAM Resource Discovery Association. +* **IsDefault**: bool (ReadOnly): If the Resource Discovery Association exists due as part of CreateIpam. +* **OwnerId**: string (ReadOnly): The AWS Account ID for the account where the shared IPAM exists. +* **ResourceDiscoveryStatus**: string (ReadOnly): The status of the resource discovery. +* **State**: string (ReadOnly): The operational state of the Resource Discovery Association. Related to Create/Delete activities. +* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. -## NetworkInterfaceCountRequest +## AWS.EC2/IPAMResourceDiscoveryProperties ### Properties -* **Max**: int -* **Min**: int +* **Description**: string +* **IpamResourceDiscoveryArn**: string (ReadOnly): Amazon Resource Name (Arn) for the Resource Discovery. +* **IpamResourceDiscoveryId**: string (ReadOnly, Identifier): Id of the IPAM Pool. +* **IpamResourceDiscoveryRegion**: string (ReadOnly): The region the resource discovery is setup in. +* **IsDefault**: bool (ReadOnly): Determines whether or not address space from this pool is publicly advertised. Must be set if and only if the pool is IPv6. +* **OperatingRegions**: [IpamOperatingRegion](#ipamoperatingregion)[]: The regions Resource Discovery is enabled for. Allows resource discoveries to be created in these regions, as well as enabling monitoring +* **OwnerId**: string (ReadOnly): Owner Account ID of the Resource Discovery +* **State**: string (ReadOnly): The state of this Resource Discovery. +* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. -## TotalLocalStorageGBRequest +## AWS.EC2/IPAMScopeProperties ### Properties -* **Max**: int -* **Min**: int +* **Arn**: string (ReadOnly): The Amazon Resource Name (ARN) of the IPAM scope. +* **Description**: string +* **IpamArn**: string (ReadOnly): The Amazon Resource Name (ARN) of the IPAM this scope is a part of. +* **IpamId**: string (Required): The Id of the IPAM this scope is a part of. +* **IpamScopeId**: string (ReadOnly, Identifier): Id of the IPAM scope. +* **IpamScopeType**: string (ReadOnly): Determines whether this scope contains publicly routable space or space for a private network +* **IsDefault**: bool (ReadOnly): Is this one of the default scopes created with the IPAM. +* **PoolCount**: int (ReadOnly): The number of pools that currently exist in this scope. +* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. -## VCpuCountRangeRequest +## AWS.EC2/LaunchTemplateProperties ### Properties -* **Max**: int -* **Min**: int +* **DefaultVersionNumber**: string (ReadOnly) +* **LatestVersionNumber**: string (ReadOnly) +* **LaunchTemplateData**: [LaunchTemplateData](#launchtemplatedata) (Required, WriteOnly): The information for the launch template. +* **LaunchTemplateId**: string (ReadOnly, Identifier) +* **LaunchTemplateName**: string: A name for the launch template. +* **TagSpecifications**: [LaunchTemplateTagSpecification](#launchtemplatetagspecification)[] (WriteOnly): The tags to apply to the launch template on creation. To tag the launch template, the resource type must be ``launch-template``. + To specify the tags for the resources that are created when an instance is launched, you must use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-tagspecifications). +* **VersionDescription**: string (WriteOnly): A description for the first version of the launch template. -## Placement +## AWS.EC2/LocalGatewayRouteProperties ### Properties -* **Affinity**: string -* **AvailabilityZone**: string -* **GroupName**: string -* **HostId**: string -* **HostResourceGroupArn**: string -* **PartitionNumber**: int -* **SpreadDomain**: string -* **Tenancy**: string +* **DestinationCidrBlock**: string (Required, Identifier): The CIDR block used for destination matches. +* **LocalGatewayRouteTableId**: string (Required, Identifier): The ID of the local gateway route table. +* **LocalGatewayVirtualInterfaceGroupId**: string: The ID of the virtual interface group. +* **NetworkInterfaceId**: string: The ID of the network interface. +* **State**: string (ReadOnly): The state of the route. +* **Type**: string (ReadOnly): The route type. -## OnDemandOptionsRequest +## AWS.EC2/LocalGatewayRouteTableProperties ### Properties -* **AllocationStrategy**: string -* **CapacityReservationOptions**: [CapacityReservationOptionsRequest](#capacityreservationoptionsrequest) -* **MaxTotalPrice**: string -* **MinTargetCapacity**: int -* **SingleAvailabilityZone**: bool -* **SingleInstanceType**: bool +* **LocalGatewayId**: string (Required): The ID of the local gateway. +* **LocalGatewayRouteTableArn**: string (ReadOnly): The ARN of the local gateway route table. +* **LocalGatewayRouteTableId**: string (ReadOnly, Identifier): The ID of the local gateway route table. +* **Mode**: string: The mode of the local gateway route table. +* **OutpostArn**: string (ReadOnly): The ARN of the outpost. +* **OwnerId**: string (ReadOnly): The owner of the local gateway route table. +* **State**: string (ReadOnly): The state of the local gateway route table. +* **Tags**: [Tag](#tag)[]: The tags for the local gateway route table. -## CapacityReservationOptionsRequest +## AWS.EC2/LocalGatewayRouteTableVirtualInterfaceGroupAssociationProperties ### Properties -* **UsageStrategy**: string +* **LocalGatewayId**: string (ReadOnly): The ID of the local gateway. +* **LocalGatewayRouteTableArn**: string (ReadOnly): The ARN of the local gateway route table. +* **LocalGatewayRouteTableId**: string (Required): The ID of the local gateway route table. +* **LocalGatewayRouteTableVirtualInterfaceGroupAssociationId**: string (ReadOnly, Identifier): The ID of the local gateway route table virtual interface group association. +* **LocalGatewayVirtualInterfaceGroupId**: string (Required): The ID of the local gateway route table virtual interface group. +* **OwnerId**: string (ReadOnly): The owner of the local gateway route table virtual interface group association. +* **State**: string (ReadOnly): The state of the local gateway route table virtual interface group association. +* **Tags**: [Tag](#tag)[]: The tags for the local gateway route table virtual interface group association. -## SpotOptionsRequest +## AWS.EC2/LocalGatewayRouteTableVPCAssociationProperties ### Properties -* **AllocationStrategy**: string -* **InstanceInterruptionBehavior**: string -* **InstancePoolsToUseCount**: int -* **MaintenanceStrategies**: [MaintenanceStrategies](#maintenancestrategies) -* **MaxTotalPrice**: string -* **MinTargetCapacity**: int -* **SingleAvailabilityZone**: bool -* **SingleInstanceType**: bool +* **LocalGatewayId**: string (ReadOnly): The ID of the local gateway. +* **LocalGatewayRouteTableId**: string (Required): The ID of the local gateway route table. +* **LocalGatewayRouteTableVpcAssociationId**: string (ReadOnly, Identifier): The ID of the association. +* **State**: string (ReadOnly): The state of the association. +* **Tags**: [Tag](#tag)[]: The tags for the association. +* **VpcId**: string (Required): The ID of the VPC. + +## AWS.EC2/NatGatewayProperties +### Properties +* **AllocationId**: string: [Public NAT gateway only] The allocation ID of the Elastic IP address that's associated with the NAT gateway. This property is required for a public NAT gateway and cannot be specified with a private NAT gateway. +* **ConnectivityType**: string: Indicates whether the NAT gateway supports public or private connectivity. The default is public connectivity. +* **MaxDrainDurationSeconds**: int (WriteOnly): The maximum amount of time to wait (in seconds) before forcibly releasing the IP addresses if connections are still in progress. Default value is 350 seconds. +* **NatGatewayId**: string (ReadOnly, Identifier) +* **PrivateIpAddress**: string: The private IPv4 address to assign to the NAT gateway. If you don't provide an address, a private IPv4 address will be automatically assigned. +* **SecondaryAllocationIds**: string[]: Secondary EIP allocation IDs. For more information, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon VPC User Guide*. +* **SecondaryPrivateIpAddressCount**: int: [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*. + ``SecondaryPrivateIpAddressCount`` and ``SecondaryPrivateIpAddresses`` cannot be set at the same time. +* **SecondaryPrivateIpAddresses**: string[]: Secondary private IPv4 addresses. For more information about secondary addresses, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon Virtual Private Cloud User Guide*. + ``SecondaryPrivateIpAddressCount`` and ``SecondaryPrivateIpAddresses`` cannot be set at the same time. +* **SubnetId**: string (Required): The ID of the subnet in which the NAT gateway is located. +* **Tags**: [Tag](#tag)[]: The tags for the NAT gateway. + +## AWS.EC2/NetworkAclProperties +### Properties +* **Id**: string (ReadOnly, Identifier) +* **Tags**: [Tag](#tag)[]: The tags for the network ACL. +* **VpcId**: string (Required): The ID of the VPC for the network ACL. + +## AWS.EC2/NetworkInsightsAccessScopeAnalysisProperties +### Properties +* **AnalyzedEniCount**: int (ReadOnly) +* **EndDate**: string (ReadOnly) +* **FindingsFound**: string (ReadOnly) +* **NetworkInsightsAccessScopeAnalysisArn**: string (ReadOnly) +* **NetworkInsightsAccessScopeAnalysisId**: string (ReadOnly, Identifier) +* **NetworkInsightsAccessScopeId**: string (Required) +* **StartDate**: string (ReadOnly) +* **Status**: string (ReadOnly) +* **StatusMessage**: string (ReadOnly) +* **Tags**: [Tag](#tag)[] + +## AWS.EC2/NetworkInsightsAccessScopeProperties +### Properties +* **CreatedDate**: string (ReadOnly) +* **ExcludePaths**: [AccessScopePathRequest](#accessscopepathrequest)[] (WriteOnly) +* **MatchPaths**: [AccessScopePathRequest](#accessscopepathrequest)[] (WriteOnly) +* **NetworkInsightsAccessScopeArn**: string (ReadOnly) +* **NetworkInsightsAccessScopeId**: string (ReadOnly, Identifier) +* **Tags**: [Tag](#tag)[] +* **UpdatedDate**: string (ReadOnly) + +## AWS.EC2/NetworkInsightsAnalysisProperties +### Properties +* **AdditionalAccounts**: string[] +* **AlternatePathHints**: [AlternatePathHint](#alternatepathhint)[] (ReadOnly) +* **Explanations**: [Explanation](#explanation)[] (ReadOnly) +* **FilterInArns**: string[] +* **ForwardPathComponents**: [PathComponent](#pathcomponent)[] (ReadOnly) +* **NetworkInsightsAnalysisArn**: string (ReadOnly) +* **NetworkInsightsAnalysisId**: string (ReadOnly, Identifier) +* **NetworkInsightsPathId**: string (Required) +* **NetworkPathFound**: bool (ReadOnly) +* **ReturnPathComponents**: [PathComponent](#pathcomponent)[] (ReadOnly) +* **StartDate**: string (ReadOnly) +* **Status**: string (ReadOnly) +* **StatusMessage**: string (ReadOnly) +* **SuggestedAccounts**: string[] (ReadOnly) +* **Tags**: [Tag](#tag)[] + +## AWS.EC2/NetworkInsightsPathProperties +### Properties +* **CreatedDate**: string (ReadOnly) +* **Destination**: string +* **DestinationArn**: string (ReadOnly) +* **DestinationIp**: string +* **DestinationPort**: int +* **FilterAtDestination**: [PathFilter](#pathfilter) +* **FilterAtSource**: [PathFilter](#pathfilter) +* **NetworkInsightsPathArn**: string (ReadOnly) +* **NetworkInsightsPathId**: string (ReadOnly, Identifier) +* **Protocol**: string (Required) +* **Source**: string (Required) +* **SourceArn**: string (ReadOnly) +* **SourceIp**: string +* **Tags**: [Tag](#tag)[] + +## AWS.EC2/NetworkInterfaceAttachmentProperties +### Properties +* **AttachmentId**: string (ReadOnly, Identifier): The ID of the network interface attachment. +* **DeleteOnTermination**: bool: Whether to delete the network interface when the instance terminates. By default, this value is set to true. +* **DeviceIndex**: string (Required): The network interface's position in the attachment order. For example, the first attached network interface has a DeviceIndex of 0. +* **EnaSrdSpecification**: [EnaSrdSpecification](#enasrdspecification) +* **InstanceId**: string (Required): The ID of the instance to which you will attach the ENI. +* **NetworkInterfaceId**: string (Required): The ID of the ENI that you want to attach. + +## AWS.EC2/NetworkInterfaceProperties +### Properties +* **ConnectionTrackingSpecification**: [ConnectionTrackingSpecification](#connectiontrackingspecification) +* **Description**: string: A description for the network interface. +* **EnablePrimaryIpv6**: bool: If you have instances or ENIs that rely on the IPv6 address not changing, to avoid disrupting traffic to instances or ENIs, you can enable a primary IPv6 address. Enable this option to automatically assign an IPv6 associated with the ENI attached to your instance to be the primary IPv6 address. When you enable an IPv6 address to be a primary IPv6, you cannot disable it. Traffic will be routed to the primary IPv6 address until the instance is terminated or the ENI is detached. If you have multiple IPv6 addresses associated with an ENI and you enable a primary IPv6 address, the first IPv6 address associated with the ENI becomes the primary IPv6 address. +* **GroupSet**: string[]: A list of security group IDs associated with this network interface. +* **Id**: string (ReadOnly, Identifier): Network interface id. +* **InterfaceType**: string: Indicates the type of network interface. +* **Ipv4PrefixCount**: int: The number of IPv4 prefixes to assign to a network interface. When you specify a number of IPv4 prefixes, Amazon EC2 selects these prefixes from your existing subnet CIDR reservations, if available, or from free spaces in the subnet. By default, these will be /28 prefixes. 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. +* **Ipv4Prefixes**: [Ipv4PrefixSpecification](#ipv4prefixspecification)[]: Assigns a list of IPv4 prefixes to the network interface. If you want EC2 to automatically assign IPv4 prefixes, use the Ipv4PrefixCount property and do not specify this property. Presently, only /28 prefixes are supported. 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. +* **Ipv6AddressCount**: int: The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. To specify specific IPv6 addresses, use the Ipv6Addresses property and don't specify this property. +* **Ipv6Addresses**: [InstanceIpv6Address](#instanceipv6address)[]: One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet to associate with the network interface. If you're specifying a number of IPv6 addresses, use the Ipv6AddressCount property and don't specify this property. +* **Ipv6PrefixCount**: int: The number of IPv6 prefixes to assign to a network interface. When you specify a number of IPv6 prefixes, Amazon EC2 selects these prefixes from your existing subnet CIDR reservations, if available, or from free spaces in the subnet. By default, these will be /80 prefixes. You can't specify a count of IPv6 prefixes if you've specified one of the following: specific IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses. +* **Ipv6Prefixes**: [Ipv6PrefixSpecification](#ipv6prefixspecification)[]: Assigns a list of IPv6 prefixes to the network interface. If you want EC2 to automatically assign IPv6 prefixes, use the Ipv6PrefixCount property and do not specify this property. Presently, only /80 prefixes are supported. You can't specify IPv6 prefixes if you've specified one of the following: a count of IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses. +* **PrimaryIpv6Address**: string (ReadOnly): The primary IPv6 address +* **PrimaryPrivateIpAddress**: string (ReadOnly): Returns the primary private IP address of the network interface. +* **PrivateIpAddress**: string: Assigns a single private IP address to the network interface, which is used as the primary private IP address. If you want to specify multiple private IP address, use the PrivateIpAddresses property. +* **PrivateIpAddresses**: [PrivateIpAddressSpecification](#privateipaddressspecification)[]: Assigns a list of private IP addresses to the network interface. You can specify a primary private IP address by setting the value of the Primary property to true in the PrivateIpAddressSpecification property. If you want EC2 to automatically assign private IP addresses, use the SecondaryPrivateIpAddressCount property and do not specify this property. +* **SecondaryPrivateIpAddressCount**: int: The number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet's IPv4 CIDR range. You can't specify this option and specify more than one private IP address using privateIpAddresses +* **SecondaryPrivateIpAddresses**: string[] (ReadOnly): Returns the secondary private IP addresses of the network interface. +* **SourceDestCheck**: bool: Indicates whether traffic to or from the instance is validated. +* **SubnetId**: string (Required): The ID of the subnet to associate with the network interface. +* **Tags**: [Tag](#tag)[]: An arbitrary set of tags (key-value pairs) for this network interface. +* **VpcId**: string (ReadOnly): The ID of the VPC + +## AWS.EC2/PrefixListProperties +### Properties +* **AddressFamily**: string (Required): Ip Version of Prefix List. +* **Arn**: string (ReadOnly): The Amazon Resource Name (ARN) of the Prefix List. +* **Entries**: [Entry](#entry)[]: Entries of Prefix List. +* **MaxEntries**: int: Max Entries of Prefix List. +* **OwnerId**: string (ReadOnly): Owner Id of Prefix List. +* **PrefixListId**: string (ReadOnly, Identifier): Id of Prefix List. +* **PrefixListName**: string (Required): Name of Prefix List. +* **Tags**: [Tag](#tag)[]: Tags for Prefix List +* **Version**: int (ReadOnly): Version of Prefix List. -## MaintenanceStrategies +## AWS.EC2/RouteProperties ### Properties -* **CapacityRebalance**: [CapacityRebalance](#capacityrebalance) +* **CarrierGatewayId**: string: The ID of the carrier gateway. + You can only use this option when the VPC contains a subnet which is associated with a Wavelength Zone. +* **CidrBlock**: string (ReadOnly, Identifier) +* **CoreNetworkArn**: string: The Amazon Resource Name (ARN) of the core network. +* **DestinationCidrBlock**: string: The 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``. +* **DestinationIpv6CidrBlock**: string: The IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match. +* **DestinationPrefixListId**: string: The ID of a prefix list used for the destination match. +* **EgressOnlyInternetGatewayId**: string: [IPv6 traffic only] The ID of an egress-only internet gateway. +* **GatewayId**: string: The ID of an internet gateway or virtual private gateway attached to your VPC. +* **InstanceId**: string: The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached. +* **LocalGatewayId**: string: The ID of the local gateway. +* **NatGatewayId**: string: [IPv4 traffic only] The ID of a NAT gateway. +* **NetworkInterfaceId**: string: The ID of a network interface. +* **RouteTableId**: string (Required, Identifier): The ID of the route table for the route. +* **TransitGatewayId**: string: The ID of a transit gateway. +* **VpcEndpointId**: string: The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only. +* **VpcPeeringConnectionId**: string: The ID of a VPC peering connection. -## CapacityRebalance +## AWS.EC2/RouteTableProperties ### Properties -* **ReplacementStrategy**: string -* **TerminationDelay**: int +* **RouteTableId**: string (ReadOnly, Identifier) +* **Tags**: [Tag](#tag)[]: Any tags assigned to the route table. +* **VpcId**: string (Required): The ID of the VPC. -## TagSpecification +## AWS.EC2/SecurityGroupEgressProperties ### Properties -* **ResourceType**: string -* **Tags**: [Tag](#tag)[] +* **CidrIp**: string: The IPv4 address range, in CIDR format. + You must specify exactly one of the following: ``CidrIp``, ``CidrIpv6``, ``DestinationPrefixListId``, or ``DestinationSecurityGroupId``. + For 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 *User Guide*. +* **CidrIpv6**: string: The IPv6 address range, in CIDR format. + You must specify exactly one of the following: ``CidrIp``, ``CidrIpv6``, ``DestinationPrefixListId``, or ``DestinationSecurityGroupId``. + For 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 *User Guide*. +* **Description**: string: The description of an egress (outbound) security group rule. + Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$* +* **DestinationPrefixListId**: string: The prefix list IDs for an AWS service. This is the AWS service to access through a VPC endpoint from instances associated with the security group. + You must specify exactly one of the following: ``CidrIp``, ``CidrIpv6``, ``DestinationPrefixListId``, or ``DestinationSecurityGroupId``. +* **DestinationSecurityGroupId**: string: The ID of the security group. + You must specify exactly one of the following: ``CidrIp``, ``CidrIpv6``, ``DestinationPrefixListId``, or ``DestinationSecurityGroupId``. +* **FromPort**: int: If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types). +* **GroupId**: string (Required): The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID. +* **Id**: string (ReadOnly, Identifier) +* **IpProtocol**: string (Required): The IP protocol name (``tcp``, ``udp``, ``icmp``, ``icmpv6``) or number (see [Protocol Numbers](https://docs.aws.amazon.com/http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml)). + Use ``-1`` to specify all protocols. When authorizing security group rules, specifying ``-1`` or a protocol number other than ``tcp``, ``udp``, ``icmp``, or ``icmpv6`` allows traffic on all ports, regardless of any port range you specify. For ``tcp``, ``udp``, and ``icmp``, you must specify a port range. For ``icmpv6``, the port range is optional; if you omit the port range, traffic for all types and codes is allowed. +* **ToPort**: int: If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes). -## Tag +## AWS.EC2/SecurityGroupIngressProperties ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **CidrIp**: string: The IPv4 ranges +* **CidrIpv6**: string: [VPC only] The IPv6 ranges +* **Description**: string: Updates the description of an ingress (inbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously +* **FromPort**: int: The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes. -## TargetCapacitySpecificationRequest -### Properties -* **DefaultTargetCapacityType**: string -* **OnDemandTargetCapacity**: int -* **SpotTargetCapacity**: int -* **TargetCapacityUnitType**: string -* **TotalTargetCapacity**: int (Required) +Use this for ICMP and any protocol that uses ports. +* **GroupId**: string: The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID. -## AWS.EC2/EIPProperties -### Properties -* **AllocationId**: string (ReadOnly, Identifier): The Allocation ID of the EIP generated by resource. -* **Domain**: string: Indicates whether the Elastic IP address is for use with instances in a VPC or instance in EC2-Classic. -* **InstanceId**: string: The ID of the instance. -* **NetworkBorderGroup**: string: A unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses. -* **PublicIp**: string (ReadOnly, Identifier): The PublicIP of the EIP generated by resource. -* **PublicIpv4Pool**: string: The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool. -* **Tags**: [Tag](#tag)[]: Any tags assigned to the EIP. -* **TransferAddress**: string (WriteOnly): The PublicIP of the EIP generated by resource through transfer from another account +You must specify the GroupName property or the GroupId property. For security groups that are in a VPC, you must use the GroupId property. +* **GroupName**: string: The name of the security group. +* **Id**: string (ReadOnly, Identifier): The Security Group Rule Id +* **IpProtocol**: string (Required): The IP protocol name (tcp, udp, icmp, icmpv6) or number (see Protocol Numbers). -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) +[VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp, udp, and icmp, you must specify a port range. For icmpv6, the port range is optional; if you omit the port range, traffic for all types and codes is allowed. +* **SourcePrefixListId**: string: [EC2-VPC only] The ID of a prefix list. -## AWS.EC2/FlowLogProperties -### Properties -* **DeliverCrossAccountRole**: string: The ARN of the IAM role that allows Amazon EC2 to publish flow logs across accounts. -* **DeliverLogsPermissionArn**: string: The ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account. If you specify LogDestinationType as s3 or kinesis-data-firehose, do not specify DeliverLogsPermissionArn or LogGroupName. -* **DestinationOptions**: [FlowLog_DestinationOptions](#flowlogdestinationoptions) -* **Id**: string (ReadOnly, Identifier): The Flow Log ID -* **LogDestination**: string: Specifies the destination to which the flow log data is to be published. Flow log data can be published to a CloudWatch Logs log group, an Amazon S3 bucket, or a Kinesis Firehose stream. The value specified for this parameter depends on the value specified for LogDestinationType. -* **LogDestinationType**: string: Specifies the type of destination to which the flow log data is to be published. Flow log data can be published to CloudWatch Logs or Amazon S3. -* **LogFormat**: string: The fields to include in the flow log record, in the order in which they should appear. -* **LogGroupName**: string: The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs. If you specify LogDestinationType as s3 or kinesis-data-firehose, do not specify DeliverLogsPermissionArn or LogGroupName. -* **MaxAggregationInterval**: int: The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. You can specify 60 seconds (1 minute) or 600 seconds (10 minutes). -* **ResourceId**: string (Required): The ID of the subnet, network interface, or VPC for which you want to create a flow log. -* **ResourceType**: string (Required): The type of resource for which to create the flow log. For example, if you specified a VPC ID for the ResourceId property, specify VPC for this property. -* **Tags**: [Tag](#tag)[]: The tags to apply to the flow logs. -* **TrafficType**: string: The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic. -## FlowLog_DestinationOptions -### Properties -* **FileFormat**: string (Required) -* **HiveCompatiblePartitions**: bool (Required) -* **PerHourPartition**: bool (Required) +* **SourceSecurityGroupId**: string: The ID of the security group. You must specify either the security group ID or the security group name. For security groups in a nondefault VPC, you must specify the security group ID. +* **SourceSecurityGroupName**: string: [EC2-Classic, default VPC] The name of the source security group. -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) +You must specify the GroupName property or the GroupId property. For security groups that are in a VPC, you must use the GroupId property. +* **SourceSecurityGroupOwnerId**: string: [nondefault VPC] The AWS account ID that owns the source security group. You can't specify this property with an IP address range. -## AWS.EC2/GatewayRouteTableAssociationProperties +If you specify SourceSecurityGroupName or SourceSecurityGroupId and that security group is owned by a different account than the account creating the stack, you must specify the SourceSecurityGroupOwnerId; otherwise, this property is optional. +* **ToPort**: int: The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes for the specified ICMP type. If you specify all ICMP/ICMPv6 types, you must specify all codes. + +Use this for ICMP and any protocol that uses ports. + +## AWS.EC2/SecurityGroupProperties ### Properties -* **AssociationId**: string (ReadOnly): The route table association ID. -* **GatewayId**: string (Required, Identifier): The ID of the gateway. -* **RouteTableId**: string (Required): The ID of the route table. +* **GroupDescription**: string (Required): A description for the security group. +* **GroupId**: string (ReadOnly): The group ID of the specified security group. +* **GroupName**: string: The name of the security group. +* **Id**: string (ReadOnly, Identifier): The group name or group ID depending on whether the SG is created in default or specific VPC +* **SecurityGroupEgress**: [Egress](#egress)[]: [VPC only] The outbound rules associated with the security group. There is a short interruption during which you cannot connect to the security group. +* **SecurityGroupIngress**: [Ingress](#ingress)[] (WriteOnly): The inbound rules associated with the security group. There is a short interruption during which you cannot connect to the security group. +* **Tags**: [Tag](#tag)[]: Any tags assigned to the security group. +* **VpcId**: string: The ID of the VPC for the security group. -## AWS.EC2/HostProperties +## AWS.EC2/SnapshotBlockPublicAccessProperties ### Properties -* **AssetId**: string: The ID of the Outpost hardware asset. -* **AutoPlacement**: string: Indicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance launches that specify its unique host ID. -* **AvailabilityZone**: string (Required): The Availability Zone in which to allocate the Dedicated Host. -* **HostId**: string (ReadOnly, Identifier): ID of the host created. -* **HostMaintenance**: string: Automatically allocates a new dedicated host and moves your instances on to it if a degradation is detected on your current host. -* **HostRecovery**: string: Indicates whether to enable or disable host recovery for the Dedicated Host. Host recovery is disabled by default. -* **InstanceFamily**: string: Specifies the instance family to be supported by the Dedicated Hosts. If you specify an instance family, the Dedicated Hosts support multiple instance types within that instance family. -* **InstanceType**: string: Specifies the instance type to be supported by the Dedicated Hosts. If you specify an instance type, the Dedicated Hosts support instances of the specified instance type only. -* **OutpostArn**: string: The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which to allocate the Dedicated Host. +* **AccountId**: string (ReadOnly, Identifier): The identifier for the specified AWS account. +* **State**: string (Required): The state of EBS Snapshot Block Public Access. -## AWS.EC2/InstanceProperties +## AWS.EC2/SpotFleetProperties ### Properties -* **AdditionalInfo**: string -* **Affinity**: string -* **AvailabilityZone**: string -* **BlockDeviceMappings**: [BlockDeviceMapping](#blockdevicemapping)[] -* **CpuOptions**: [CpuOptions](#cpuoptions) -* **CreditSpecification**: [CreditSpecification](#creditspecification) -* **DisableApiTermination**: bool -* **EbsOptimized**: bool -* **ElasticGpuSpecifications**: [ElasticGpuSpecification](#elasticgpuspecification)[] -* **ElasticInferenceAccelerators**: [ElasticInferenceAccelerator](#elasticinferenceaccelerator)[] -* **EnclaveOptions**: [EnclaveOptions](#enclaveoptions) -* **HibernationOptions**: [HibernationOptions](#hibernationoptions) -* **HostId**: string -* **HostResourceGroupArn**: string -* **IamInstanceProfile**: string * **Id**: string (ReadOnly, Identifier) -* **ImageId**: string -* **InstanceInitiatedShutdownBehavior**: string -* **InstanceType**: string -* **Ipv6AddressCount**: int -* **Ipv6Addresses**: [InstanceIpv6Address](#instanceipv6address)[] -* **KernelId**: string -* **KeyName**: string -* **LaunchTemplate**: [LaunchTemplateSpecification](#launchtemplatespecification) -* **LicenseSpecifications**: [LicenseSpecification](#licensespecification)[] -* **Monitoring**: bool -* **NetworkInterfaces**: [NetworkInterface](#networkinterface)[] -* **PlacementGroupName**: string -* **PrivateDnsName**: string (ReadOnly) -* **PrivateDnsNameOptions**: [PrivateDnsNameOptions](#privatednsnameoptions) -* **PrivateIp**: string (ReadOnly) -* **PrivateIpAddress**: string -* **PropagateTagsToVolumeOnCreation**: bool -* **PublicDnsName**: string (ReadOnly) -* **PublicIp**: string (ReadOnly) -* **RamdiskId**: string -* **SecurityGroupIds**: string[] -* **SecurityGroups**: string[] -* **SourceDestCheck**: bool -* **SsmAssociations**: [SsmAssociation](#ssmassociation)[] -* **SubnetId**: string -* **Tags**: [Tag](#tag)[] -* **Tenancy**: string -* **UserData**: string -* **Volumes**: [Volume](#volume)[] +* **SpotFleetRequestConfigData**: [SpotFleetRequestConfigData](#spotfleetrequestconfigdata) (Required) -## BlockDeviceMapping +## AWS.EC2/SubnetProperties ### Properties -* **DeviceName**: string (Required) -* **Ebs**: [Ebs](#ebs) -* **NoDevice**: [NoDevice](#nodevice) -* **VirtualName**: string +* **AssignIpv6AddressOnCreation**: bool: Indicates whether a network interface created in this subnet receives an IPv6 address. The default value is ``false``. + If you specify ``AssignIpv6AddressOnCreation``, you must also specify an IPv6 CIDR block. +* **AvailabilityZone**: string: The Availability Zone of the subnet. + If you update this property, you must also update the ``CidrBlock`` property. +* **AvailabilityZoneId**: string: The AZ ID of the subnet. +* **CidrBlock**: string: The IPv4 CIDR block assigned to the subnet. + If you update this property, we create a new subnet, and then delete the existing one. +* **EnableDns64**: bool: Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations. For more information, see [DNS64 and NAT64](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-nat64-dns64) in the *User Guide*. +* **EnableLniAtDeviceIndex**: int (WriteOnly): Indicates the device position for local network interfaces in this subnet. For example, ``1`` indicates local network interfaces in this subnet are the secondary network interface (eth1). +* **Ipv4IpamPoolId**: string (WriteOnly): An IPv4 IPAM pool ID for the subnet. +* **Ipv4NetmaskLength**: int (WriteOnly): An IPv4 netmask length for the subnet. +* **Ipv6CidrBlock**: string: The IPv6 CIDR block. + If you specify ``AssignIpv6AddressOnCreation``, you must also specify an IPv6 CIDR block. +* **Ipv6CidrBlocks**: string[]: The IPv6 network ranges for the subnet, in CIDR notation. +* **Ipv6IpamPoolId**: string (WriteOnly): An IPv6 IPAM pool ID for the subnet. +* **Ipv6Native**: bool: Indicates 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 *User Guide*. +* **Ipv6NetmaskLength**: int (WriteOnly): An IPv6 netmask length for the subnet. +* **MapPublicIpOnLaunch**: bool: Indicates whether instances launched in this subnet receive a public IPv4 address. The default value is ``false``. + AWS charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the *Public IPv4 Address* tab on the [VPC pricing page](https://docs.aws.amazon.com/vpc/pricing/). +* **NetworkAclAssociationId**: string (ReadOnly) +* **OutpostArn**: string: The Amazon Resource Name (ARN) of the Outpost. +* **PrivateDnsNameOptionsOnLaunch**: [Subnet_PrivateDnsNameOptionsOnLaunch](#subnetprivatednsnameoptionsonlaunch): The 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 *User Guide*. + Available options: + + EnableResourceNameDnsAAAARecord (true | false) + + EnableResourceNameDnsARecord (true | false) + + HostnameType (ip-name | resource-name) +* **SubnetId**: string (ReadOnly, Identifier) +* **Tags**: [Tag](#tag)[]: Any tags assigned to the subnet. +* **VpcId**: string (Required): The ID of the VPC the subnet is in. + If you update this property, you must also update the ``CidrBlock`` property. -## Ebs +## AWS.EC2/TransitGatewayAttachmentProperties ### Properties -* **DeleteOnTermination**: bool -* **Encrypted**: bool -* **Iops**: int -* **KmsKeyId**: string -* **SnapshotId**: string -* **VolumeSize**: int -* **VolumeType**: string +* **Id**: string (ReadOnly, Identifier) +* **Options**: [TransitGatewayAttachment_Options](#transitgatewayattachmentoptions): The options for the transit gateway vpc attachment. +* **SubnetIds**: string[] (Required) +* **Tags**: [Tag](#tag)[] +* **TransitGatewayId**: string (Required) +* **VpcId**: string (Required) -## NoDevice +## AWS.EC2/TransitGatewayConnectProperties ### Properties +* **CreationTime**: string (ReadOnly): The creation time. +* **Options**: [TransitGatewayConnectOptions](#transitgatewayconnectoptions) (Required): The Connect attachment options. +* **State**: string (ReadOnly): The state of the attachment. +* **Tags**: [Tag](#tag)[]: The tags for the attachment. +* **TransitGatewayAttachmentId**: string (ReadOnly, Identifier): The ID of the Connect attachment. +* **TransitGatewayId**: string (ReadOnly): The ID of the transit gateway. +* **TransportTransitGatewayAttachmentId**: string (Required): The ID of the attachment from which the Connect attachment was created. -## CpuOptions +## AWS.EC2/TransitGatewayMulticastDomainProperties ### Properties -* **CoreCount**: int -* **ThreadsPerCore**: int +* **CreationTime**: string (ReadOnly): The time the transit gateway multicast domain was created. +* **Options**: [TransitGatewayMulticastDomain_Options](#transitgatewaymulticastdomainoptions): The options for the transit gateway multicast domain. +* **State**: string (ReadOnly): The state of the transit gateway multicast domain. +* **Tags**: [Tag](#tag)[]: The tags for the transit gateway multicast domain. +* **TransitGatewayId**: string (Required): The ID of the transit gateway. +* **TransitGatewayMulticastDomainArn**: string (ReadOnly): The Amazon Resource Name (ARN) of the transit gateway multicast domain. +* **TransitGatewayMulticastDomainId**: string (ReadOnly, Identifier): The ID of the transit gateway multicast domain. -## CreditSpecification +## AWS.EC2/TransitGatewayPeeringAttachmentProperties ### Properties -* **CPUCredits**: string +* **CreationTime**: string (ReadOnly): The time the transit gateway peering attachment was created. +* **PeerAccountId**: string (Required): The ID of the peer account +* **PeerRegion**: string (Required): Peer Region +* **PeerTransitGatewayId**: string (Required): The ID of the peer transit gateway. +* **State**: string (ReadOnly): The state of the transit gateway peering attachment. Note that the initiating state has been deprecated. +* **Status**: [PeeringAttachmentStatus](#peeringattachmentstatus) (ReadOnly): The status of the transit gateway peering attachment. +* **Tags**: [Tag](#tag)[]: The tags for the transit gateway peering attachment. +* **TransitGatewayAttachmentId**: string (ReadOnly, Identifier): The ID of the transit gateway peering attachment. +* **TransitGatewayId**: string (Required): The ID of the transit gateway. -## ElasticGpuSpecification +## AWS.EC2/TransitGatewayProperties ### Properties -* **Type**: string (Required) +* **AmazonSideAsn**: int +* **AssociationDefaultRouteTableId**: string +* **AutoAcceptSharedAttachments**: string +* **DefaultRouteTableAssociation**: string +* **DefaultRouteTablePropagation**: string +* **Description**: string +* **DnsSupport**: string +* **Id**: string (ReadOnly, Identifier) +* **MulticastSupport**: string +* **PropagationDefaultRouteTableId**: string +* **Tags**: [Tag](#tag)[] +* **TransitGatewayArn**: string (ReadOnly) +* **TransitGatewayCidrBlocks**: string[] +* **VpnEcmpSupport**: string -## ElasticInferenceAccelerator +## AWS.EC2/TransitGatewayVpcAttachmentProperties ### Properties -* **Count**: int -* **Type**: string (Required) +* **AddSubnetIds**: string[] (WriteOnly) +* **Id**: string (ReadOnly, Identifier) +* **Options**: [TransitGatewayVpcAttachment_Options](#transitgatewayvpcattachmentoptions): The options for the transit gateway vpc attachment. +* **RemoveSubnetIds**: string[] (WriteOnly) +* **SubnetIds**: string[] (Required) +* **Tags**: [Tag](#tag)[] +* **TransitGatewayId**: string (Required) +* **VpcId**: string (Required) -## EnclaveOptions +## AWS.EC2/VerifiedAccessEndpointProperties ### Properties -* **Enabled**: bool +* **ApplicationDomain**: string (Required): The DNS name for users to reach your application. +* **AttachmentType**: string (Required): The type of attachment used to provide connectivity between the AWS Verified Access endpoint and the application. +* **CreationTime**: string (ReadOnly): The creation time. +* **Description**: string: A description for the AWS Verified Access endpoint. +* **DeviceValidationDomain**: string (ReadOnly): Returned if endpoint has a device trust provider attached. +* **DomainCertificateArn**: string (Required): The ARN of a public TLS/SSL certificate imported into or created with ACM. +* **EndpointDomain**: string (ReadOnly): A DNS name that is generated for the endpoint. +* **EndpointDomainPrefix**: string (Required): A custom identifier that gets prepended to a DNS name that is generated for the endpoint. +* **EndpointType**: string (Required): The type of AWS Verified Access endpoint. Incoming application requests will be sent to an IP address, load balancer or a network interface depending on the endpoint type specified.The type of AWS Verified Access endpoint. Incoming application requests will be sent to an IP address, load balancer or a network interface depending on the endpoint type specified. +* **LastUpdatedTime**: string (ReadOnly): The last updated time. +* **LoadBalancerOptions**: [LoadBalancerOptions](#loadbalanceroptions): The load balancer details if creating the AWS Verified Access endpoint as load-balancer type. +* **NetworkInterfaceOptions**: [NetworkInterfaceOptions](#networkinterfaceoptions): The options for network-interface type endpoint. +* **PolicyDocument**: string: The AWS Verified Access policy document. +* **PolicyEnabled**: bool: The status of the Verified Access policy. +* **SecurityGroupIds**: string[]: The IDs of the security groups for the endpoint. +* **SseSpecification**: [SseSpecification](#ssespecification): The configuration options for customer provided KMS encryption. +* **Status**: string (ReadOnly): The endpoint status. +* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. +* **VerifiedAccessEndpointId**: string (ReadOnly, Identifier): The ID of the AWS Verified Access endpoint. +* **VerifiedAccessGroupId**: string (Required): The ID of the AWS Verified Access group. +* **VerifiedAccessInstanceId**: string (ReadOnly): The ID of the AWS Verified Access instance. -## HibernationOptions +## AWS.EC2/VerifiedAccessGroupProperties ### Properties -* **Configured**: bool +* **CreationTime**: string (ReadOnly): Time this Verified Access Group was created. +* **Description**: string: A description for the AWS Verified Access group. +* **LastUpdatedTime**: string (ReadOnly): Time this Verified Access Group was last updated. +* **Owner**: string (ReadOnly): The AWS account number that owns the group. +* **PolicyDocument**: string: The AWS Verified Access policy document. +* **PolicyEnabled**: bool: The status of the Verified Access policy. +* **SseSpecification**: [SseSpecification](#ssespecification): The configuration options for customer provided KMS encryption. +* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. +* **VerifiedAccessGroupArn**: string (ReadOnly): The ARN of the Verified Access group. +* **VerifiedAccessGroupId**: string (ReadOnly, Identifier): The ID of the AWS Verified Access group. +* **VerifiedAccessInstanceId**: string (Required): The ID of the AWS Verified Access instance. -## InstanceIpv6Address +## AWS.EC2/VerifiedAccessInstanceProperties ### Properties -* **Ipv6Address**: string (Required) +* **CreationTime**: string (ReadOnly): Time this Verified Access Instance was created. +* **Description**: string: A description for the AWS Verified Access instance. +* **FipsEnabled**: bool: Indicates whether FIPS is enabled +* **LastUpdatedTime**: string (ReadOnly): Time this Verified Access Instance was last updated. +* **LoggingConfigurations**: [VerifiedAccessLogs](#verifiedaccesslogs): The configuration options for AWS Verified Access instances. +* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. +* **VerifiedAccessInstanceId**: string (ReadOnly, Identifier): The ID of the AWS Verified Access instance. +* **VerifiedAccessTrustProviderIds**: string[]: The IDs of the AWS Verified Access trust providers. +* **VerifiedAccessTrustProviders**: [VerifiedAccessTrustProvider](#verifiedaccesstrustprovider)[]: AWS Verified Access trust providers. -## LaunchTemplateSpecification +## AWS.EC2/VerifiedAccessTrustProviderProperties ### Properties -* **LaunchTemplateId**: string -* **LaunchTemplateName**: string -* **Version**: string (Required) +* **CreationTime**: string (ReadOnly): The creation time. +* **Description**: string: A description for the Amazon Web Services Verified Access trust provider. +* **DeviceOptions**: [DeviceOptions](#deviceoptions) +* **DeviceTrustProviderType**: string: The type of device-based trust provider. Possible values: jamf|crowdstrike +* **LastUpdatedTime**: string (ReadOnly): The last updated time. +* **OidcOptions**: [OidcOptions](#oidcoptions) +* **PolicyReferenceName**: string (Required): The identifier to be used when working with policy rules. +* **SseSpecification**: [VerifiedAccessTrustProvider_SseSpecification](#verifiedaccesstrustproviderssespecification): The configuration options for customer provided KMS encryption. +* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. +* **TrustProviderType**: string (Required): Type of trust provider. Possible values: user|device +* **UserTrustProviderType**: string: The type of device-based trust provider. Possible values: oidc|iam-identity-center +* **VerifiedAccessTrustProviderId**: string (ReadOnly, Identifier): The ID of the Amazon Web Services Verified Access trust provider. -## LicenseSpecification +## AWS.EC2/VolumeProperties ### Properties -* **LicenseConfigurationArn**: string (Required) +* **AutoEnableIO**: bool: Indicates whether the volume is auto-enabled for I/O operations. By default, Amazon EBS disables I/O to the volume from attached EC2 instances when it determines that a volume's data is potentially inconsistent. If the consistency of the volume is not a concern, and you prefer that the volume be made available immediately if it's impaired, you can configure the volume to automatically enable I/O. +* **AvailabilityZone**: string (Required): The ID of the Availability Zone in which to create the volume. For example, ``us-east-1a``. +* **Encrypted**: bool: Indicates whether the volume should be encrypted. The effect of setting the encryption state to ``true`` depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see [Encryption by default](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-by-default) in the *Amazon Elastic Compute Cloud User Guide*. + Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see [Supported instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances). +* **Iops**: int: The number of I/O operations per second (IOPS). For ``gp3``, ``io1``, and ``io2`` volumes, this represents the number of IOPS that are provisioned for the volume. For ``gp2`` volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. + The following are the supported values for each volume type: + + ``gp3``: 3,000 - 16,000 IOPS + + ``io1``: 100 - 64,000 IOPS + + ``io2``: 100 - 256,000 IOPS + + For ``io2`` volumes, you can achieve up to 256,000 IOPS on [instances built 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. + This parameter is required for ``io1`` and ``io2`` volumes. The default for ``gp3`` volumes is 3,000 IOPS. This parameter is not supported for ``gp2``, ``st1``, ``sc1``, or ``standard`` volumes. +* **KmsKeyId**: string: The identifier of the kms-key-long to use for Amazon EBS encryption. If ``KmsKeyId`` is specified, the encrypted state must be ``true``. + If you omit this property and your account is enabled for encryption by default, or *Encrypted* is set to ``true``, then the volume is encrypted using the default key specified for your account. If your account does not have a default key, then the volume is encrypted using the aws-managed-key. + Alternatively, if you want to specify a different key, you can specify one of the following: + + Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab. + + Key alias. Specify the alias for the key, prefixed with ``alias/``. For example, for a key with the alias ``my_cmk``, use ``alias/my_cmk``. Or to specify the aws-managed-key, use ``alias/aws/ebs``. + + Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab. + + Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias. +* **MultiAttachEnabled**: bool: Indicates whether Amazon EBS Multi-Attach is enabled. + CFNlong does not currently support updating a single-attach volume to be multi-attach enabled, updating a multi-attach enabled volume to be single-attach, or updating the size or number of I/O operations per second (IOPS) of a multi-attach enabled volume. +* **OutpostArn**: string: The Amazon Resource Name (ARN) of the Outpost. +* **Size**: int: The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size. + The following are the supported volumes sizes for each volume type: + + ``gp2`` and ``gp3``: 1 - 16,384 GiB + + ``io1``: 4 - 16,384 GiB + + ``io2``: 4 - 65,536 GiB + + ``st1`` and ``sc1``: 125 - 16,384 GiB + + ``standard``: 1 - 1024 GiB +* **SnapshotId**: string: The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size. +* **Tags**: [Tag](#tag)[]: The tags to apply to the volume during creation. +* **Throughput**: int: The throughput to provision for a volume, with a maximum of 1,000 MiB/s. + This parameter is valid only for ``gp3`` volumes. The default value is 125. + Valid Range: Minimum value of 125. Maximum value of 1000. +* **VolumeId**: string (ReadOnly, Identifier) +* **VolumeType**: string: The volume type. This parameter can be one of the following values: + + General Purpose SSD: ``gp2`` | ``gp3`` + + Provisioned IOPS SSD: ``io1`` | ``io2`` + + Throughput Optimized HDD: ``st1`` + + Cold HDD: ``sc1`` + + Magnetic: ``standard`` + + For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the *Amazon Elastic Compute Cloud User Guide*. + Default: ``gp2`` -## NetworkInterface +## AWS.EC2/VPCDHCPOptionsAssociationProperties ### Properties -* **AssociateCarrierIpAddress**: bool -* **AssociatePublicIpAddress**: bool -* **DeleteOnTermination**: bool -* **Description**: string -* **DeviceIndex**: string (Required) -* **GroupSet**: string[] -* **Ipv6AddressCount**: int -* **Ipv6Addresses**: [InstanceIpv6Address](#instanceipv6address)[] -* **NetworkInterfaceId**: string -* **PrivateIpAddress**: string -* **PrivateIpAddresses**: [PrivateIpAddressSpecification](#privateipaddressspecification)[] -* **SecondaryPrivateIpAddressCount**: int -* **SubnetId**: string +* **DhcpOptionsId**: string (Required, Identifier): The ID of the DHCP options set, or default to associate no DHCP options with the VPC. +* **VpcId**: string (Required, Identifier): The ID of the VPC. -## PrivateIpAddressSpecification +## AWS.EC2/VPCEndpointConnectionNotificationProperties ### Properties -* **Primary**: bool (Required) -* **PrivateIpAddress**: string (Required) +* **ConnectionEvents**: string[] (Required): The endpoint events for which to receive notifications. +* **ConnectionNotificationArn**: string (Required): The ARN of the SNS topic for the notifications. +* **ServiceId**: string: The ID of the endpoint service. +* **VPCEndpointConnectionNotificationId**: string (ReadOnly, Identifier): VPC Endpoint Connection ID generated by service +* **VPCEndpointId**: string: The ID of the endpoint. -## PrivateDnsNameOptions +## AWS.EC2/VPCEndpointProperties ### Properties -* **EnableResourceNameDnsAAAARecord**: bool -* **EnableResourceNameDnsARecord**: bool -* **HostnameType**: string +* **CreationTimestamp**: string (ReadOnly) +* **DnsEntries**: string[] (ReadOnly) +* **Id**: string (ReadOnly, Identifier) +* **NetworkInterfaceIds**: string[] (ReadOnly) +* **PolicyDocument**: [VPCEndpoint_PolicyDocument](#vpcendpointpolicydocument) | string: An endpoint policy, which controls access to the service from the VPC. The default endpoint policy allows full access to the service. Endpoint policies are supported only for gateway and interface endpoints. + For CloudFormation templates in YAML, you can provide the policy in JSON or YAML format. CFNlong converts YAML policies to JSON format before calling the API to create or modify the VPC endpoint. +* **PrivateDnsEnabled**: bool: Indicate whether to associate a private hosted zone with the specified VPC. The private hosted zone contains a record set for the default public DNS name for the service for the Region (for example, ``kinesis.us-east-1.amazonaws.com``), which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC endpoint service. + To use a private hosted zone, you must set the following VPC attributes to ``true``: ``enableDnsHostnames`` and ``enableDnsSupport``. + This property is supported only for interface endpoints. + Default: ``false`` +* **RouteTableIds**: string[]: The IDs of the route tables. Routing is supported only for gateway endpoints. +* **SecurityGroupIds**: string[]: The IDs of the security groups to associate with the endpoint network interfaces. If this parameter is not specified, we use the default security group for the VPC. Security groups are supported only for interface endpoints. +* **ServiceName**: string (Required): The name of the endpoint service. +* **SubnetIds**: string[]: The IDs of the subnets in which to create endpoint network interfaces. You must specify this property for an interface endpoint or a Gateway Load Balancer endpoint. You can't specify this property for a gateway endpoint. For a Gateway Load Balancer endpoint, you can specify only one subnet. +* **VpcEndpointType**: string: The type of endpoint. + Default: Gateway +* **VpcId**: string (Required): The ID of the VPC. -## SsmAssociation +## AWS.EC2/VPCEndpointServicePermissionsProperties ### Properties -* **AssociationParameters**: [AssociationParameter](#associationparameter)[] -* **DocumentName**: string (Required) +* **AllowedPrincipals**: string[] +* **ServiceId**: string (Required, Identifier) -## AssociationParameter +## AWS.EC2/VPCEndpointServiceProperties ### Properties -* **Key**: string (Required) -* **Value**: string[] (Required) +* **AcceptanceRequired**: bool +* **ContributorInsightsEnabled**: bool (WriteOnly) +* **GatewayLoadBalancerArns**: string[] +* **NetworkLoadBalancerArns**: string[] +* **PayerResponsibility**: string +* **ServiceId**: string (ReadOnly, Identifier) -## Tag +## AWS.EC2/VPCGatewayAttachmentProperties ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **AttachmentType**: string (ReadOnly, Identifier): Used to identify if this resource is an Internet Gateway or Vpn Gateway Attachment +* **InternetGatewayId**: string: The ID of the internet gateway. You must specify either InternetGatewayId or VpnGatewayId, but not both. +* **VpcId**: string (Required, Identifier): The ID of the VPC. +* **VpnGatewayId**: string: The ID of the virtual private gateway. You must specify either InternetGatewayId or VpnGatewayId, but not both. -## Volume +## AWS.EC2/VPCPeeringConnectionProperties ### Properties -* **Device**: string (Required) -* **VolumeId**: string (Required) +* **Id**: string (ReadOnly, Identifier) +* **PeerOwnerId**: string: The AWS account ID of the owner of the accepter VPC. +* **PeerRegion**: string: The Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request. +* **PeerRoleArn**: string (WriteOnly): The Amazon Resource Name (ARN) of the VPC peer role for the peering connection in another AWS account. +* **PeerVpcId**: string (Required): The ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request. +* **Tags**: [Tag](#tag)[] +* **VpcId**: string (Required): The ID of the VPC. -## AWS.EC2/InstanceConnectEndpointProperties +## AWS.EC2/VPCProperties ### Properties -* **ClientToken**: string (WriteOnly): The client token of the instance connect endpoint. -* **Id**: string (ReadOnly, Identifier): The id of the instance connect endpoint -* **PreserveClientIp**: bool: If true, the address of the loki client is preserved when connecting to the end resource -* **SecurityGroupIds**: string[]: The security group IDs of the instance connect endpoint. -* **SubnetId**: string (Required): The subnet id of the instance connect endpoint -* **Tags**: [Tag](#tag)[]: The tags of the instance connect endpoint. +* **CidrBlock**: string: The IPv4 network range for the VPC, in CIDR notation. For example, ``10.0.0.0/16``. We modify the specified CIDR block to its canonical form; for example, if you specify ``100.68.0.18/18``, we modify it to ``100.68.0.0/18``. + You must specify either``CidrBlock`` or ``Ipv4IpamPoolId``. +* **CidrBlockAssociations**: string[] (ReadOnly) +* **DefaultNetworkAcl**: string (ReadOnly) +* **DefaultSecurityGroup**: string (ReadOnly) +* **EnableDnsHostnames**: bool: Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not. Disabled by default for nondefault VPCs. For more information, see [DNS attributes in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support). + You can only enable DNS hostnames if you've enabled DNS support. +* **EnableDnsSupport**: bool: Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range "plus two" succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled. Enabled by default. For more information, see [DNS attributes in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support). +* **InstanceTenancy**: string: The allowed tenancy of instances launched into the VPC. + + ``default``: An instance launched into the VPC runs on shared hardware by default, unless you explicitly specify a different tenancy during instance launch. + + ``dedicated``: An instance launched into the VPC runs on dedicated hardware by default, unless you explicitly specify a tenancy of ``host`` during instance launch. You cannot specify a tenancy of ``default`` during instance launch. + + Updating ``InstanceTenancy`` requires no replacement only if you are updating its value from ``dedicated`` to ``default``. Updating ``InstanceTenancy`` from ``default`` to ``dedicated`` requires replacement. +* **Ipv4IpamPoolId**: string (WriteOnly): The ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR. For more information, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*. + You must specify either``CidrBlock`` or ``Ipv4IpamPoolId``. +* **Ipv4NetmaskLength**: int (WriteOnly): The netmask length of the IPv4 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*. +* **Ipv6CidrBlocks**: string[] (ReadOnly) +* **Tags**: [Tag](#tag)[]: The tags for the VPC. +* **VpcId**: string (ReadOnly, Identifier) -## Tag +## AWS.EC2/VPNConnectionProperties ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **CustomerGatewayId**: string (Required): The ID of the customer gateway at your end of the VPN connection. +* **StaticRoutesOnly**: bool: Indicates whether the VPN connection uses static routes only. +* **Tags**: [Tag](#tag)[]: Any tags assigned to the VPN connection. +* **TransitGatewayId**: string: The ID of the transit gateway associated with the VPN connection. +* **Type**: string (Required): The type of VPN connection. +* **VpnConnectionId**: string (ReadOnly, Identifier): The provider-assigned unique ID for this managed resource +* **VpnGatewayId**: string: The ID of the virtual private gateway at the AWS side of the VPN connection. +* **VpnTunnelOptionsSpecifications**: [VpnTunnelOptionsSpecification](#vpntunneloptionsspecification)[]: The tunnel options for the VPN connection. -## AWS.EC2/InternetGatewayProperties +## AWS.EC2/VPNGatewayProperties ### Properties -* **InternetGatewayId**: string (ReadOnly, Identifier): ID of internet gateway. -* **Tags**: [Tag](#tag)[]: Any tags to assign to the internet gateway. +* **AmazonSideAsn**: int: The private Autonomous System Number (ASN) for the Amazon side of a BGP session. +* **Tags**: [Tag](#tag)[]: Any tags assigned to the virtual private gateway. +* **Type**: string (Required): The type of VPN connection the virtual private gateway supports. +* **VPNGatewayId**: string (ReadOnly, Identifier) -## Tag +## BaselineEbsBandwidthMbps ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **Max**: int: The maximum baseline bandwidth, in Mbps. To specify no maximum limit, omit this parameter. +* **Min**: int: The minimum baseline bandwidth, in Mbps. To specify no minimum limit, omit this parameter. -## AWS.EC2/IPAMProperties +## BaselineEbsBandwidthMbpsRequest ### Properties -* **Arn**: string (ReadOnly): The Amazon Resource Name (ARN) of the IPAM. -* **DefaultResourceDiscoveryAssociationId**: string (ReadOnly): The Id of the default association to the default resource discovery, created with this IPAM. -* **DefaultResourceDiscoveryId**: string (ReadOnly): The Id of the default resource discovery, created with this IPAM. -* **Description**: string -* **IpamId**: string (ReadOnly, Identifier): Id of the IPAM. -* **OperatingRegions**: [IpamOperatingRegion](#ipamoperatingregion)[]: The regions IPAM is enabled for. Allows pools to be created in these regions, as well as enabling monitoring -* **PrivateDefaultScopeId**: string (ReadOnly): The Id of the default scope for publicly routable IP space, created with this IPAM. -* **PublicDefaultScopeId**: string (ReadOnly): The Id of the default scope for publicly routable IP space, created with this IPAM. -* **ResourceDiscoveryAssociationCount**: int (ReadOnly): The count of resource discoveries associated with this IPAM. -* **ScopeCount**: int (ReadOnly): The number of scopes that currently exist in this IPAM. -* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. -* **Tier**: string: The tier of the IPAM. +* **Max**: int +* **Min**: int -## IpamOperatingRegion +## BaselineEbsBandwidthMbpsRequest ### Properties -* **RegionName**: string (Required): The name of the region. +* **Max**: int +* **Min**: int -## Tag +## BlockDeviceMapping ### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **DeviceName**: string (Required): The device name (for example, /dev/sdh or xvdh). +* **Ebs**: [Ebs](#ebs): Parameters used to automatically set up EBS volumes when the instance is launched. +* **NoDevice**: [Instance_NoDevice](#instancenodevice) +* **VirtualName**: string -## AWS.EC2/IPAMPoolProperties +## BlockDeviceMapping ### Properties -* **AddressFamily**: string (Required): The address family of the address space in this pool. Either IPv4 or IPv6. -* **AllocationDefaultNetmaskLength**: int: The default netmask length for allocations made from this pool. This value is used when the netmask length of an allocation isn't specified. -* **AllocationMaxNetmaskLength**: int: The maximum allowed netmask length for allocations made from this pool. -* **AllocationMinNetmaskLength**: int: The minimum allowed netmask length for allocations made from this pool. -* **AllocationResourceTags**: [Tag](#tag)[]: When specified, an allocation will not be allowed unless a resource has a matching set of tags. -* **Arn**: string (ReadOnly): The Amazon Resource Name (ARN) of the IPAM Pool. -* **AutoImport**: bool: Determines what to do if IPAM discovers resources that haven't been assigned an allocation. If set to true, an allocation will be made automatically. -* **AwsService**: string: Limits which service in Amazon Web Services that the pool can be used in. -* **Description**: string -* **IpamArn**: string (ReadOnly): The Amazon Resource Name (ARN) of the IPAM this pool is a part of. -* **IpamPoolId**: string (ReadOnly, Identifier): Id of the IPAM Pool. -* **IpamScopeArn**: string (ReadOnly): The Amazon Resource Name (ARN) of the scope this pool is a part of. -* **IpamScopeId**: string (Required): The Id of the scope this pool is a part of. -* **IpamScopeType**: string (ReadOnly): Determines whether this scope contains publicly routable space or space for a private network -* **Locale**: string: The region of this pool. If not set, this will default to "None" which will disable non-custom allocations. If the locale has been specified for the source pool, this value must match. -* **PoolDepth**: int (ReadOnly): The depth of this pool in the source pool hierarchy. -* **ProvisionedCidrs**: [ProvisionedCidr](#provisionedcidr)[]: A list of cidrs representing the address space available for allocation in this pool. -* **PublicIpSource**: string: The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is `byoip`. -* **PubliclyAdvertisable**: bool: Determines whether or not address space from this pool is publicly advertised. Must be set if and only if the pool is IPv6. -* **SourceIpamPoolId**: string: The Id of this pool's source. If set, all space provisioned in this pool must be free space provisioned in the parent pool. -* **State**: string (ReadOnly): The state of this pool. This can be one of the following values: "create-in-progress", "create-complete", "modify-in-progress", "modify-complete", "delete-in-progress", or "delete-complete" -* **StateMessage**: string (ReadOnly): An explanation of how the pool arrived at it current state. -* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. +* **DeviceName**: string: The device name (for example, /dev/sdh or xvdh). +* **Ebs**: [Ebs](#ebs): Parameters used to automatically set up EBS volumes when the instance is launched. +* **NoDevice**: string: To omit the device from the block device mapping, specify an empty string. +* **VirtualName**: string: The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume. -## Tag +## BlockDeviceMapping ### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **DeviceName**: string (Required) +* **Ebs**: [EbsBlockDevice](#ebsblockdevice) +* **NoDevice**: string +* **VirtualName**: string -## ProvisionedCidr +## CapacityRebalance ### Properties -* **Cidr**: string (Required) +* **ReplacementStrategy**: string +* **TerminationDelay**: int -## AWS.EC2/IPAMResourceDiscoveryProperties +## CapacityReservationOptionsRequest ### Properties -* **Description**: string -* **IpamResourceDiscoveryArn**: string (ReadOnly): Amazon Resource Name (Arn) for the Resource Discovery. -* **IpamResourceDiscoveryId**: string (ReadOnly, Identifier): Id of the IPAM Pool. -* **IpamResourceDiscoveryRegion**: string (ReadOnly): The region the resource discovery is setup in. -* **IsDefault**: bool (ReadOnly): Determines whether or not address space from this pool is publicly advertised. Must be set if and only if the pool is IPv6. -* **OperatingRegions**: [IpamOperatingRegion](#ipamoperatingregion)[]: The regions Resource Discovery is enabled for. Allows resource discoveries to be created in these regions, as well as enabling monitoring -* **OwnerId**: string (ReadOnly): Owner Account ID of the Resource Discovery -* **State**: string (ReadOnly): The state of this Resource Discovery. -* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. +* **UsageStrategy**: string -## IpamOperatingRegion +## CapacityReservationSpecification ### Properties -* **RegionName**: string (Required): The name of the region. +* **CapacityReservationPreference**: string: Indicates the instance's Capacity Reservation preferences. Possible preferences include: + + ``open`` - The instance can run in any ``open`` Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). + + ``none`` - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity. +* **CapacityReservationTarget**: [CapacityReservationTarget](#capacityreservationtarget): Information about the target Capacity Reservation or Capacity Reservation group. -## Tag +## CapacityReservationTarget ### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **CapacityReservationId**: string: The ID of the Capacity Reservation in which to run the instance. +* **CapacityReservationResourceGroupArn**: string: The ARN of the Capacity Reservation resource group in which to run the instance. -## AWS.EC2/IPAMResourceDiscoveryAssociationProperties +## ClassicLoadBalancer ### Properties -* **IpamArn**: string (ReadOnly): Arn of the IPAM. -* **IpamId**: string (Required): The Id of the IPAM this Resource Discovery is associated to. -* **IpamRegion**: string (ReadOnly): The home region of the IPAM. -* **IpamResourceDiscoveryAssociationArn**: string (ReadOnly): The Amazon Resource Name (ARN) of the resource discovery association is a part of. -* **IpamResourceDiscoveryAssociationId**: string (ReadOnly, Identifier): Id of the IPAM Resource Discovery Association. -* **IpamResourceDiscoveryId**: string (Required): The Amazon Resource Name (ARN) of the IPAM Resource Discovery Association. -* **IsDefault**: bool (ReadOnly): If the Resource Discovery Association exists due as part of CreateIpam. -* **OwnerId**: string (ReadOnly): The AWS Account ID for the account where the shared IPAM exists. -* **ResourceDiscoveryStatus**: string (ReadOnly): The status of the resource discovery. -* **State**: string (ReadOnly): The operational state of the Resource Discovery Association. Related to Create/Delete activities. -* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. +* **Name**: string (Required) -## Tag +## ClassicLoadBalancersConfig ### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **ClassicLoadBalancers**: [ClassicLoadBalancer](#classicloadbalancer)[] (Required) -## AWS.EC2/IPAMScopeProperties +## ConnectionTrackingSpecification ### Properties -* **Arn**: string (ReadOnly): The Amazon Resource Name (ARN) of the IPAM scope. -* **Description**: string -* **IpamArn**: string (ReadOnly): The Amazon Resource Name (ARN) of the IPAM this scope is a part of. -* **IpamId**: string (Required): The Id of the IPAM this scope is a part of. -* **IpamScopeId**: string (ReadOnly, Identifier): Id of the IPAM scope. -* **IpamScopeType**: string (ReadOnly): Determines whether this scope contains publicly routable space or space for a private network -* **IsDefault**: bool (ReadOnly): Is this one of the default scopes created with the IPAM. -* **PoolCount**: int (ReadOnly): The number of pools that currently exist in this scope. -* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. +* **TcpEstablishedTimeout**: int: Timeout (in seconds) for idle TCP connections in an established state. Min: 60 seconds. Max: 432000 seconds (5 days). Default: 432000 seconds. Recommended: Less than 432000 seconds. +* **UdpStreamTimeout**: int: Timeout (in seconds) for idle UDP flows classified as streams which have seen more than one request-response transaction. Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180 seconds. +* **UdpTimeout**: int: Timeout (in seconds) for idle UDP flows that have seen traffic only in a single direction or a single request-response transaction. Min: 30 seconds. Max: 60 seconds. Default: 30 seconds. -## Tag +## ConnectionTrackingSpecification ### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **TcpEstablishedTimeout**: int +* **UdpStreamTimeout**: int +* **UdpTimeout**: int -## AWS.EC2/LaunchTemplateProperties +## CpuOptions ### Properties -* **DefaultVersionNumber**: string (ReadOnly): The default version of the launch template -* **LatestVersionNumber**: string (ReadOnly): The latest version of the launch template -* **LaunchTemplateData**: [LaunchTemplateData](#launchtemplatedata) (Required, WriteOnly) -* **LaunchTemplateId**: string (ReadOnly, Identifier): LaunchTemplate ID generated by service -* **LaunchTemplateName**: string: A name for the launch template. -* **TagSpecifications**: [LaunchTemplateTagSpecification](#launchtemplatetagspecification)[] (WriteOnly): The tags to apply to the launch template on creation. -* **VersionDescription**: string (WriteOnly): A description for the first version of the launch template. +* **AmdSevSnp**: string: Indicates whether to enable the instance for AMD SEV-SNP. AMD SEV-SNP is supported with M6a, R6a, and C6a instance types only. For more information, see [AMD SEV-SNP](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/sev-snp.html). +* **CoreCount**: int: The number of CPU cores for the instance. +* **ThreadsPerCore**: int: The number of threads per CPU core. To disable multithreading for the instance, specify a value of ``1``. Otherwise, specify the default value of ``2``. -## LaunchTemplateData +## CreditSpecification ### Properties -* **BlockDeviceMappings**: [BlockDeviceMapping](#blockdevicemapping)[]: The block device mapping. -* **CapacityReservationSpecification**: [CapacityReservationSpecification](#capacityreservationspecification) -* **CpuOptions**: [CpuOptions](#cpuoptions) -* **CreditSpecification**: [CreditSpecification](#creditspecification) -* **DisableApiStop**: bool: Indicates whether to enable the instance for stop protection. -* **DisableApiTermination**: bool: If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API. -* **EbsOptimized**: bool: Indicates whether the instance is optimized for Amazon EBS I/O. -* **ElasticGpuSpecifications**: [ElasticGpuSpecification](#elasticgpuspecification)[]: An elastic GPU to associate with the instance. -* **ElasticInferenceAccelerators**: [LaunchTemplateElasticInferenceAccelerator](#launchtemplateelasticinferenceaccelerator)[]: The elastic inference accelerator for the instance. -* **EnclaveOptions**: [EnclaveOptions](#enclaveoptions) -* **HibernationOptions**: [HibernationOptions](#hibernationoptions) -* **IamInstanceProfile**: [IamInstanceProfile](#iaminstanceprofile) -* **ImageId**: string: The ID of the AMI. Alternatively, you can specify a Systems Manager parameter, which will resolve to an AMI ID on launch. -* **InstanceInitiatedShutdownBehavior**: string: Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown). -* **InstanceMarketOptions**: [InstanceMarketOptions](#instancemarketoptions) -* **InstanceRequirements**: [InstanceRequirements](#instancerequirements) -* **InstanceType**: string -* **KernelId**: string: The ID of the kernel. -* **KeyName**: string: The name of the EC2 key pair -* **LicenseSpecifications**: [LicenseSpecification](#licensespecification)[]: The license configurations. -* **MaintenanceOptions**: [MaintenanceOptions](#maintenanceoptions) -* **MetadataOptions**: [MetadataOptions](#metadataoptions) -* **Monitoring**: [Monitoring](#monitoring) -* **NetworkInterfaces**: [NetworkInterface](#networkinterface)[]: If you specify a network interface, you must specify any security groups and subnets as part of the network interface. -* **Placement**: [Placement](#placement) -* **PrivateDnsNameOptions**: [PrivateDnsNameOptions](#privatednsnameoptions) -* **RamDiskId**: string -* **SecurityGroupIds**: string[]: One or more security group IDs. -* **SecurityGroups**: string[]: One or more security group names. -* **TagSpecifications**: [TagSpecification](#tagspecification)[]: The tags to apply to the resources that are created during instance launch. -* **UserData**: string: The user data to make available to the instance. +* **CpuCredits**: string: The credit option for CPU usage of a T instance. + Valid values: ``standard`` | ``unlimited`` -## BlockDeviceMapping +## DeviceOptions ### Properties -* **DeviceName**: string: The user data to make available to the instance. -* **Ebs**: [Ebs](#ebs) -* **NoDevice**: string: To omit the device from the block device mapping, specify an empty string. -* **VirtualName**: string: The virtual device name (ephemeralN). +* **PublicSigningKeyUrl**: string: URL Verified Access will use to verify authenticity of the device tokens. +* **TenantId**: string: The ID of the tenant application with the device-identity provider. ## Ebs ### Properties * **DeleteOnTermination**: bool: Indicates whether the EBS volume is deleted on instance termination. -* **Encrypted**: bool: Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value. -* **Iops**: int: The number of I/O operations per second (IOPS). -* **KmsKeyId**: string: The ARN of the symmetric AWS Key Management Service (AWS KMS) CMK used for encryption. +* **Encrypted**: bool: Indicates whether the volume should be encrypted. +* **Iops**: int: The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. +* **KmsKeyId**: string: The identifier of the AWS Key Management Service (AWS KMS) customer managed CMK to use for Amazon EBS encryption. If KmsKeyId is specified, the encrypted state must be true. If the encrypted state is true but you do not specify KmsKeyId, your AWS managed CMK for EBS is used. * **SnapshotId**: string: The ID of the snapshot. -* **Throughput**: int: The throughput to provision for a gp3 volume, with a maximum of 1,000 MiB/s. -* **VolumeSize**: int: The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. +* **VolumeSize**: int: The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size. * **VolumeType**: string: The volume type. -## CapacityReservationSpecification -### Properties -* **CapacityReservationPreference**: string: Indicates the instance's Capacity Reservation preferences. -* **CapacityReservationTarget**: [CapacityReservationTarget](#capacityreservationtarget) - -## CapacityReservationTarget +## Ebs ### Properties -* **CapacityReservationId**: string: The ID of the Capacity Reservation in which to run the instance. -* **CapacityReservationResourceGroupArn**: string: The ARN of the Capacity Reservation resource group in which to run the instance. +* **DeleteOnTermination**: bool: Indicates whether the EBS volume is deleted on instance termination. +* **Encrypted**: bool: Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value. +* **Iops**: int: The number of I/O operations per second (IOPS). For ``gp3``, ``io1``, and ``io2`` volumes, this represents the number of IOPS that are provisioned for the volume. For ``gp2`` volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. + The following are the supported values for each volume type: + + ``gp3``: 3,000 - 16,000 IOPS + + ``io1``: 100 - 64,000 IOPS + + ``io2``: 100 - 256,000 IOPS + + For ``io2`` volumes, you can achieve up to 256,000 IOPS on [instances built 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. + This parameter is supported for ``io1``, ``io2``, and ``gp3`` volumes only. +* **KmsKeyId**: string: The ARN of the symmetric KMSlong (KMS) CMK used for encryption. +* **SnapshotId**: string: The ID of the snapshot. +* **Throughput**: int: The throughput to provision for a ``gp3`` volume, with a maximum of 1,000 MiB/s. + Valid Range: Minimum value of 125. Maximum value of 1000. +* **VolumeSize**: int: The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. The following are the supported volumes sizes for each volume type: + + ``gp2`` and ``gp3``: 1 - 16,384 GiB + + ``io1``: 4 - 16,384 GiB + + ``io2``: 4 - 65,536 GiB + + ``st1`` and ``sc1``: 125 - 16,384 GiB + + ``standard``: 1 - 1024 GiB +* **VolumeType**: string: The volume type. For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volume-types.html) in the *Amazon EBS User Guide*. -## CpuOptions +## EbsBlockDevice ### Properties -* **AmdSevSnp**: string: Indicates whether to enable the instance for AMD SEV-SNP. AMD SEV-SNP is supported with M6a, R6a, and C6a instance types only. -* **CoreCount**: int: The number of CPU cores for the instance. -* **ThreadsPerCore**: int: The number of threads per CPU core. To disable multithreading for the instance, specify a value of 1. Otherwise, specify the default value of 2. +* **DeleteOnTermination**: bool +* **Encrypted**: bool +* **Iops**: int +* **SnapshotId**: string +* **VolumeSize**: int +* **VolumeType**: string -## CreditSpecification +## Egress ### Properties -* **CpuCredits**: string: The user data to make available to the instance. +* **CidrIp**: string +* **CidrIpv6**: string +* **Description**: string +* **DestinationPrefixListId**: string +* **DestinationSecurityGroupId**: string +* **FromPort**: int +* **IpProtocol**: string (Required) +* **ToPort**: int ## ElasticGpuSpecification ### Properties -* **Type**: string: The type of Elastic Graphics accelerator. +* **Type**: string (Required): The type of Elastic Graphics accelerator. -## LaunchTemplateElasticInferenceAccelerator +## ElasticGpuSpecification ### Properties -* **Count**: int: The number of elastic inference accelerators to attach to the instance. -* **Type**: string: The type of elastic inference accelerator. +* **Type**: string: The type of Elastic Graphics accelerator. For more information about the values to specify for ``Type``, see [Elastic Graphics Basics](https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/elastic-graphics.html#elastic-graphics-basics), specifically the Elastic Graphics accelerator column, in the *Amazon Elastic Compute Cloud User Guide for Windows Instances*. -## EnclaveOptions +## ElasticInferenceAccelerator ### Properties -* **Enabled**: bool: If this parameter is set to true, the instance is enabled for AWS Nitro Enclaves; otherwise, it is not enabled for AWS Nitro Enclaves. +* **Count**: int: The number of elastic inference accelerators to attach to the instance. +* **Type**: string (Required): The type of elastic inference accelerator. -## HibernationOptions +## EnaSrdSpecification ### Properties -* **Configured**: bool: TIf you set this parameter to true, the instance is enabled for hibernation. +* **EnaSrdEnabled**: bool: Indicates whether ENA Express is enabled for the network interface. +* **EnaSrdUdpSpecification**: [EnaSrdUdpSpecification](#enasrdudpspecification): Configures ENA Express for UDP network traffic. -## IamInstanceProfile +## EnaSrdSpecification ### Properties -* **Arn**: string: The Amazon Resource Name (ARN) of the instance profile. -* **Name**: string: The name of the instance profile. +* **EnaSrdEnabled**: bool +* **EnaSrdUdpSpecification**: [NetworkInterfaceAttachment_EnaSrdUdpSpecification](#networkinterfaceattachmentenasrdudpspecification) -## InstanceMarketOptions +## EnaSrdUdpSpecification ### Properties -* **MarketType**: string: The market type. -* **SpotOptions**: [SpotOptions](#spotoptions) +* **EnaSrdUdpEnabled**: bool: Indicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting, you must first enable ENA Express. -## SpotOptions +## EnclaveOptions ### Properties -* **BlockDurationMinutes**: int: Deprecated -* **InstanceInterruptionBehavior**: string: The behavior when a Spot Instance is interrupted. The default is terminate. -* **MaxPrice**: string: The maximum hourly price you're willing to pay for the Spot Instances. -* **SpotInstanceType**: string: The Spot Instance request type. -* **ValidUntil**: string: The end date of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ). Supported only for persistent requests. +* **Enabled**: bool: If this parameter is set to ``true``, the instance is enabled for AWS Nitro Enclaves; otherwise, it is not enabled for AWS Nitro Enclaves. -## InstanceRequirements +## Entry ### Properties -* **AcceleratorCount**: [AcceleratorCount](#acceleratorcount) -* **AcceleratorManufacturers**: string[]: Indicates whether instance types must have accelerators by specific manufacturers. -* **AcceleratorNames**: string[]: The accelerators that must be on the instance type. -* **AcceleratorTotalMemoryMiB**: [AcceleratorTotalMemoryMiB](#acceleratortotalmemorymib) -* **AcceleratorTypes**: string[]: The accelerator types that must be on the instance type. -* **AllowedInstanceTypes**: string[]: The instance types to apply your specified attributes against. -* **BareMetal**: string: Indicates whether bare metal instance types must be included, excluded, or required. -* **BaselineEbsBandwidthMbps**: [BaselineEbsBandwidthMbps](#baselineebsbandwidthmbps) -* **BurstablePerformance**: string -* **CpuManufacturers**: string[]: The CPU manufacturers to include. -* **ExcludedInstanceTypes**: string[]: The instance types to exclude. -* **InstanceGenerations**: string[]: Indicates whether current or previous generation instance types are included. -* **LocalStorage**: string: The user data to make available to the instance. -* **LocalStorageTypes**: string[]: The type of local storage that is required. -* **MemoryGiBPerVCpu**: [MemoryGiBPerVCpu](#memorygibpervcpu) -* **MemoryMiB**: [MemoryMiB](#memorymib) -* **NetworkBandwidthGbps**: [NetworkBandwidthGbps](#networkbandwidthgbps) -* **NetworkInterfaceCount**: [NetworkInterfaceCount](#networkinterfacecount) -* **OnDemandMaxPricePercentageOverLowestPrice**: int: The price protection threshold for On-Demand Instances. -* **RequireHibernateSupport**: bool: Indicates whether instance types must support hibernation for On-Demand Instances. -* **SpotMaxPricePercentageOverLowestPrice**: int: The price protection threshold for Spot Instances. -* **TotalLocalStorageGB**: [TotalLocalStorageGB](#totallocalstoragegb) -* **VCpuCount**: [VCpuCount](#vcpucount) +* **Cidr**: string (Required) +* **Description**: string -## AcceleratorCount +## Explanation ### Properties -* **Max**: int: The maximum number of accelerators. -* **Min**: int: The minimum number of accelerators. +* **Acl**: [AnalysisComponent](#analysiscomponent) +* **AclRule**: [AnalysisAclRule](#analysisaclrule) +* **Address**: string +* **Addresses**: string[] +* **AttachedTo**: [AnalysisComponent](#analysiscomponent) +* **AvailabilityZones**: string[] +* **Cidrs**: string[] +* **ClassicLoadBalancerListener**: [AnalysisLoadBalancerListener](#analysisloadbalancerlistener) +* **Component**: [AnalysisComponent](#analysiscomponent) +* **ComponentAccount**: string +* **ComponentRegion**: string +* **CustomerGateway**: [AnalysisComponent](#analysiscomponent) +* **Destination**: [AnalysisComponent](#analysiscomponent) +* **DestinationVpc**: [AnalysisComponent](#analysiscomponent) +* **Direction**: string +* **ElasticLoadBalancerListener**: [AnalysisComponent](#analysiscomponent) +* **ExplanationCode**: string +* **IngressRouteTable**: [AnalysisComponent](#analysiscomponent) +* **InternetGateway**: [AnalysisComponent](#analysiscomponent) +* **LoadBalancerArn**: string +* **LoadBalancerListenerPort**: int +* **LoadBalancerTarget**: [AnalysisLoadBalancerTarget](#analysisloadbalancertarget) +* **LoadBalancerTargetGroup**: [AnalysisComponent](#analysiscomponent) +* **LoadBalancerTargetGroups**: [AnalysisComponent](#analysiscomponent)[] +* **LoadBalancerTargetPort**: int +* **MissingComponent**: string +* **NatGateway**: [AnalysisComponent](#analysiscomponent) +* **NetworkInterface**: [AnalysisComponent](#analysiscomponent) +* **PacketField**: string +* **Port**: int +* **PortRanges**: [PortRange](#portrange)[] +* **PrefixList**: [AnalysisComponent](#analysiscomponent) +* **Protocols**: string[] +* **RouteTable**: [AnalysisComponent](#analysiscomponent) +* **RouteTableRoute**: [AnalysisRouteTableRoute](#analysisroutetableroute) +* **SecurityGroup**: [AnalysisComponent](#analysiscomponent) +* **SecurityGroupRule**: [AnalysisSecurityGroupRule](#analysissecuritygrouprule) +* **SecurityGroups**: [AnalysisComponent](#analysiscomponent)[] +* **SourceVpc**: [AnalysisComponent](#analysiscomponent) +* **State**: string +* **Subnet**: [AnalysisComponent](#analysiscomponent) +* **SubnetRouteTable**: [AnalysisComponent](#analysiscomponent) +* **TransitGateway**: [AnalysisComponent](#analysiscomponent) +* **TransitGatewayAttachment**: [AnalysisComponent](#analysiscomponent) +* **TransitGatewayRouteTable**: [AnalysisComponent](#analysiscomponent) +* **TransitGatewayRouteTableRoute**: [TransitGatewayRouteTableRoute](#transitgatewayroutetableroute) +* **Vpc**: [AnalysisComponent](#analysiscomponent) +* **vpcEndpoint**: [AnalysisComponent](#analysiscomponent) +* **VpcPeeringConnection**: [AnalysisComponent](#analysiscomponent) +* **VpnConnection**: [AnalysisComponent](#analysiscomponent) +* **VpnGateway**: [AnalysisComponent](#analysiscomponent) -## AcceleratorTotalMemoryMiB +## FilterPortRange ### Properties -* **Max**: int: The maximum amount of accelerator memory, in MiB. -* **Min**: int: The minimum amount of accelerator memory, in MiB. +* **FromPort**: int +* **ToPort**: int -## BaselineEbsBandwidthMbps +## FleetLaunchTemplateConfigRequest ### Properties -* **Max**: int: The maximum baseline bandwidth, in Mbps. -* **Min**: int: The minimum baseline bandwidth, in Mbps. +* **LaunchTemplateSpecification**: [FleetLaunchTemplateSpecificationRequest](#fleetlaunchtemplatespecificationrequest) +* **Overrides**: [FleetLaunchTemplateOverridesRequest](#fleetlaunchtemplateoverridesrequest)[] -## MemoryGiBPerVCpu +## FleetLaunchTemplateOverridesRequest ### Properties -* **Max**: int: The maximum amount of memory per vCPU, in GiB. -* **Min**: int: TThe minimum amount of memory per vCPU, in GiB. +* **AvailabilityZone**: string +* **InstanceRequirements**: [InstanceRequirementsRequest](#instancerequirementsrequest) +* **InstanceType**: string +* **MaxPrice**: string +* **Placement**: [Placement](#placement) +* **Priority**: int +* **SubnetId**: string +* **WeightedCapacity**: int -## MemoryMiB +## FleetLaunchTemplateSpecification ### Properties -* **Max**: int: The maximum amount of memory, in MiB. -* **Min**: int: The minimum amount of memory, in MiB. +* **LaunchTemplateId**: string +* **LaunchTemplateName**: string +* **Version**: string (Required) -## NetworkBandwidthGbps +## FleetLaunchTemplateSpecificationRequest ### Properties -* **Max**: int: The maximum amount of network bandwidth, in Gbps. -* **Min**: int: The minimum amount of network bandwidth, in Gbps. +* **LaunchTemplateId**: string +* **LaunchTemplateName**: string +* **Version**: string (Required) -## NetworkInterfaceCount +## FlowLog_DestinationOptions ### Properties -* **Max**: int -* **Min**: int +* **FileFormat**: string (Required) +* **HiveCompatiblePartitions**: bool (Required) +* **PerHourPartition**: bool (Required) -## TotalLocalStorageGB +## GroupIdentifier ### Properties -* **Max**: int -* **Min**: int +* **GroupId**: string (Required) -## VCpuCount +## HibernationOptions ### Properties -* **Max**: int: The maximum number of vCPUs. -* **Min**: int: The minimum number of vCPUs. +* **Configured**: bool: If you set this parameter to ``true``, the instance is enabled for hibernation. + Default: ``false`` -## LicenseSpecification +## IamInstanceProfile ### Properties -* **LicenseConfigurationArn**: string: The Amazon Resource Name (ARN) of the license configuration. +* **Arn**: string: The Amazon Resource Name (ARN) of the instance profile. +* **Name**: string: The name of the instance profile. -## MaintenanceOptions +## IamInstanceProfileSpecification ### Properties -* **AutoRecovery**: string: Disables the automatic recovery behavior of your instance or sets it to default. -* **RebootMigration**: string: Disables the automatic reboot-migration behavior of your instance or sets it to default. +* **Arn**: string -## MetadataOptions +## Ingress ### Properties -* **HttpEndpoint**: string: Enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled. -* **HttpProtocolIpv6**: string: Enables or disables the IPv6 endpoint for the instance metadata service. -* **HttpPutResponseHopLimit**: int: The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel. -* **HttpTokens**: string: IMDSv2 uses token-backed sessions. -* **InstanceMetadataTags**: string: Set to enabled to allow access to instance tags from the instance metadata. +* **CidrIp**: string +* **CidrIpv6**: string +* **Description**: string +* **FromPort**: int +* **IpProtocol**: string (Required) +* **SourcePrefixListId**: string +* **SourceSecurityGroupId**: string +* **SourceSecurityGroupName**: string +* **SourceSecurityGroupOwnerId**: string +* **ToPort**: int -## Monitoring +## Instance_CpuOptions ### Properties -* **Enabled**: bool: Specify true to enable detailed monitoring. +* **CoreCount**: int +* **ThreadsPerCore**: int -## NetworkInterface +## Instance_CreditSpecification ### Properties -* **AssociateCarrierIpAddress**: bool: Indicates whether to associate a Carrier IP address with eth0 for a new network interface. -* **AssociatePublicIpAddress**: bool: Associates a public IPv4 address with eth0 for a new network interface. -* **ConnectionTrackingSpecification**: [ConnectionTrackingSpecification](#connectiontrackingspecification) -* **DeleteOnTermination**: bool: Indicates whether the network interface is deleted when the instance is terminated. -* **Description**: string: A description for the network interface. -* **DeviceIndex**: int: The device index for the network interface attachment. -* **EnaSrdSpecification**: [EnaSrdSpecification](#enasrdspecification) -* **Groups**: string[]: The IDs of one or more security groups. -* **InterfaceType**: string: The type of network interface. -* **Ipv4PrefixCount**: int: The number of IPv4 prefixes to be automatically assigned to the network interface. -* **Ipv4Prefixes**: [Ipv4PrefixSpecification](#ipv4prefixspecification)[]: One or more IPv4 prefixes to be assigned to the network interface. -* **Ipv6AddressCount**: int: The number of IPv6 addresses to assign to a network interface. -* **Ipv6Addresses**: [Ipv6Add](#ipv6add)[]: One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. -* **Ipv6PrefixCount**: int: The number of IPv6 prefixes to be automatically assigned to the network interface. -* **Ipv6Prefixes**: [Ipv6PrefixSpecification](#ipv6prefixspecification)[]: One or more IPv6 prefixes to be assigned to the network interface. -* **NetworkCardIndex**: int: The index of the network card. -* **NetworkInterfaceId**: string: The ID of the network interface. -* **PrimaryIpv6**: bool: Enables the first IPv6 global unique address (GUA) on a dual stack or IPv6-only ENI immutable. -* **PrivateIpAddress**: string: The primary private IPv4 address of the network interface. -* **PrivateIpAddresses**: [PrivateIpAdd](#privateipadd)[]: One or more private IPv4 addresses. -* **SecondaryPrivateIpAddressCount**: int: The number of secondary private IPv4 addresses to assign to a network interface. -* **SubnetId**: string: The ID of the subnet for the network interface. +* **CPUCredits**: string -## ConnectionTrackingSpecification +## Instance_EnclaveOptions ### Properties -* **TcpEstablishedTimeout**: int: Integer value for TCP Established Timeout -* **UdpStreamTimeout**: int: Integer value for UDP Stream Timeout -* **UdpTimeout**: int: Integer value for UDP Timeout +* **Enabled**: bool: If this parameter is set to true, the instance is enabled for AWS Nitro Enclaves; otherwise, it is not enabled for AWS Nitro Enclaves. -## EnaSrdSpecification +## Instance_HibernationOptions ### Properties -* **EnaSrdEnabled**: bool: Enables TCP ENA-SRD -* **EnaSrdUdpSpecification**: [EnaSrdUdpSpecification](#enasrdudpspecification) +* **Configured**: bool: If you set this parameter to true, your instance is enabled for hibernation. -## EnaSrdUdpSpecification +## Instance_LaunchTemplateSpecification ### Properties -* **EnaSrdUdpEnabled**: bool: Enables UDP ENA-SRD +* **LaunchTemplateId**: string: The ID of the launch template. You must specify the LaunchTemplateName or the LaunchTemplateId, but not both. +* **LaunchTemplateName**: string: The name of the launch template. You must specify the LaunchTemplateName or the LaunchTemplateId, but not both. +* **Version**: string: The version number of the launch template. -## Ipv4PrefixSpecification +## Instance_NoDevice ### Properties -* **Ipv4Prefix**: string: The IPv4 prefix. -## Ipv6Add +## Instance_PrivateDnsNameOptions ### Properties -* **Ipv6Address**: string +* **EnableResourceNameDnsAAAARecord**: bool: Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records. For more information, see Amazon EC2 instance hostname types in the Amazon Elastic Compute Cloud User Guide. +* **EnableResourceNameDnsARecord**: bool: Indicates whether to respond to DNS queries for instance hostnames with DNS A records. For more information, see Amazon EC2 instance hostname types in the Amazon Elastic Compute Cloud User Guide. +* **HostnameType**: string: The type of hostnames to assign to instances in the subnet at launch. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID. For more information, see Amazon EC2 instance hostname types in the Amazon Elastic Compute Cloud User Guide. -## Ipv6PrefixSpecification +## Instance_State ### Properties -* **Ipv6Prefix**: string +* **Code**: string: The state of the instance as a 16-bit unsigned integer. +* **Name**: string: The current state of the instance. -## PrivateIpAdd +## InstanceIpv6Address ### Properties -* **Primary**: bool: Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary. -* **PrivateIpAddress**: string: The private IPv4 address. +* **Ipv6Address**: string (Required): The IPv6 address. -## Placement +## InstanceIpv6Address ### Properties -* **Affinity**: string: The affinity setting for an instance on a Dedicated Host. -* **AvailabilityZone**: string: The Availability Zone for the instance. -* **GroupId**: string: The Group Id of a placement group. You must specify the Placement Group Group Id to launch an instance in a shared placement group. -* **GroupName**: string: The name of the placement group for the instance. -* **HostId**: string: The ID of the Dedicated Host for the instance. -* **HostResourceGroupArn**: string: The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host. -* **PartitionNumber**: int: The number of the partition the instance should launch in. Valid only if the placement group strategy is set to partition. -* **SpreadDomain**: string: Reserved for future use. -* **Tenancy**: string: The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. +* **Ipv6Address**: string (Required) -## PrivateDnsNameOptions +## InstanceIpv6Address ### Properties -* **EnableResourceNameDnsAAAARecord**: bool: Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records. -* **EnableResourceNameDnsARecord**: bool: Indicates whether to respond to DNS queries for instance hostnames with DNS A records. -* **HostnameType**: string: The type of hostname for EC2 instances. +* **Ipv6Address**: string (Required) -## TagSpecification +## InstanceMarketOptions ### Properties -* **ResourceType**: string: The type of resource to tag. -* **Tags**: [Tag](#tag)[]: The tags for the resource. +* **MarketType**: string: The market type. +* **SpotOptions**: [SpotOptions](#spotoptions): The options for Spot Instances. -## Tag +## InstanceNetworkInterfaceSpecification ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **AssociatePublicIpAddress**: bool +* **DeleteOnTermination**: bool +* **Description**: string +* **DeviceIndex**: int +* **Groups**: string[] +* **Ipv6AddressCount**: int +* **Ipv6Addresses**: [InstanceIpv6Address](#instanceipv6address)[] +* **NetworkInterfaceId**: string +* **PrivateIpAddresses**: [PrivateIpAddressSpecification](#privateipaddressspecification)[] +* **SecondaryPrivateIpAddressCount**: int +* **SubnetId**: string -## LaunchTemplateTagSpecification +## InstanceRequirements ### Properties -* **ResourceType**: string: The type of resource to tag. -* **Tags**: [Tag](#tag)[]: The tags for the resource. +* **AcceleratorCount**: [AcceleratorCount](#acceleratorcount): The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) on an instance. + To exclude accelerator-enabled instance types, set ``Max`` to ``0``. + Default: No minimum or maximum limits +* **AcceleratorManufacturers**: string[]: Indicates whether instance types must have accelerators by specific manufacturers. + + For instance types with AWS devices, specify ``amazon-web-services``. + + For instance types with AMD devices, specify ``amd``. + + For instance types with Habana devices, specify ``habana``. + + For instance types with NVIDIA devices, specify ``nvidia``. + + For instance types with Xilinx devices, specify ``xilinx``. + + Default: Any manufacturer +* **AcceleratorNames**: string[]: The accelerators that must be on the instance type. + + For instance types with NVIDIA A10G GPUs, specify ``a10g``. + + For instance types with NVIDIA A100 GPUs, specify ``a100``. + + For instance types with NVIDIA H100 GPUs, specify ``h100``. + + For instance types with AWS Inferentia chips, specify ``inferentia``. + + For instance types with NVIDIA GRID K520 GPUs, specify ``k520``. + + For instance types with NVIDIA K80 GPUs, specify ``k80``. + + For instance types with NVIDIA M60 GPUs, specify ``m60``. + + For instance types with AMD Radeon Pro V520 GPUs, specify ``radeon-pro-v520``. + + For instance types with NVIDIA T4 GPUs, specify ``t4``. + + For instance types with NVIDIA T4G GPUs, specify ``t4g``. + + For instance types with Xilinx VU9P FPGAs, specify ``vu9p``. + + For instance types with NVIDIA V100 GPUs, specify ``v100``. + + Default: Any accelerator +* **AcceleratorTotalMemoryMiB**: [AcceleratorTotalMemoryMiB](#acceleratortotalmemorymib): The minimum and maximum amount of total accelerator memory, in MiB. + Default: No minimum or maximum limits +* **AcceleratorTypes**: string[]: The accelerator types that must be on the instance type. + + For instance types with GPU accelerators, specify ``gpu``. + + For instance types with FPGA accelerators, specify ``fpga``. + + For instance types with inference accelerators, specify ``inference``. + + Default: Any accelerator type +* **AllowedInstanceTypes**: string[]: The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes. + You can use strings with one or more wild cards, represented by an asterisk (``*``), to allow an instance type, size, or generation. The following are examples: ``m5.8xlarge``, ``c5*.*``, ``m5a.*``, ``r*``, ``*3*``. + For example, if you specify ``c5*``,Amazon EC2 will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify ``m5a.*``, Amazon EC2 will allow all the M5a instance types, but not the M5n instance types. + If you specify ``AllowedInstanceTypes``, you can't specify ``ExcludedInstanceTypes``. + Default: All instance types +* **BareMetal**: string: Indicates whether bare metal instance types must be included, excluded, or required. + + To include bare metal instance types, specify ``included``. + + To require only bare metal instance types, specify ``required``. + + To exclude bare metal instance types, specify ``excluded``. + + Default: ``excluded`` +* **BaselineEbsBandwidthMbps**: [BaselineEbsBandwidthMbps](#baselineebsbandwidthmbps): The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see [Amazon EBS–optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the *Amazon EC2 User Guide*. + Default: No minimum or maximum limits +* **BurstablePerformance**: string: Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see [Burstable performance instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html). + + To include burstable performance instance types, specify ``included``. + + To require only burstable performance instance types, specify ``required``. + + To exclude burstable performance instance types, specify ``excluded``. + + Default: ``excluded`` +* **CpuManufacturers**: string[]: The CPU manufacturers to include. + + For instance types with Intel CPUs, specify ``intel``. + + For instance types with AMD CPUs, specify ``amd``. + + For instance types with AWS CPUs, specify ``amazon-web-services``. + + Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template. + Default: Any manufacturer +* **ExcludedInstanceTypes**: string[]: The instance types to exclude. + You can use strings with one or more wild cards, represented by an asterisk (``*``), to exclude an instance type, size, or generation. The following are examples: ``m5.8xlarge``, ``c5*.*``, ``m5a.*``, ``r*``, ``*3*``. + For example, if you specify ``c5*``,Amazon EC2 will exclude the entire C5 instance family, which includes all C5a and C5n instance types. If you specify ``m5a.*``, Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types. + If you specify ``ExcludedInstanceTypes``, you can't specify ``AllowedInstanceTypes``. + Default: No excluded instance types +* **InstanceGenerations**: string[]: Indicates whether current or previous generation instance types are included. The current generation instance types are recommended for use. Current generation instance types are typically the latest two to three generations in each instance family. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide*. + For current generation instance types, specify ``current``. + For previous generation instance types, specify ``previous``. + Default: Current and previous generation instance types +* **LocalStorage**: string: Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, [Amazon EC2 instance store](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html) in the *Amazon EC2 User Guide*. + + To include instance types with instance store volumes, specify ``included``. + + To require only instance types with instance store volumes, specify ``required``. + + To exclude instance types with instance store volumes, specify ``excluded``. + + Default: ``included`` +* **LocalStorageTypes**: string[]: The type of local storage that is required. + + For instance types with hard disk drive (HDD) storage, specify ``hdd``. + + For instance types with solid state drive (SSD) storage, specify ``ssd``. + + Default: ``hdd`` and ``ssd`` +* **MaxSpotPriceAsPercentageOfOptimalOnDemandPrice**: int: [Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold. + The parameter accepts an integer, which Amazon EC2 interprets as a percentage. + If you set ``DesiredCapacityType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is based on the per vCPU or per memory price instead of the per instance price. + Only one of ``SpotMaxPricePercentageOverLowestPrice`` or ``MaxSpotPriceAsPercentageOfOptimalOnDemandPrice`` can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as ``999999``. +* **MemoryGiBPerVCpu**: [MemoryGiBPerVCpu](#memorygibpervcpu): The minimum and maximum amount of memory per vCPU, in GiB. + Default: No minimum or maximum limits +* **MemoryMiB**: [MemoryMiB](#memorymib): The minimum and maximum amount of memory, in MiB. +* **NetworkBandwidthGbps**: [NetworkBandwidthGbps](#networkbandwidthgbps): The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps). + Default: No minimum or maximum limits +* **NetworkInterfaceCount**: [NetworkInterfaceCount](#networkinterfacecount): The minimum and maximum number of network interfaces. + Default: No minimum or maximum limits +* **OnDemandMaxPricePercentageOverLowestPrice**: int: [Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold. + The parameter accepts an integer, which Amazon EC2 interprets as a percentage. + To turn off price protection, specify a high value, such as ``999999``. + This 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). + If you set ``TargetCapacityUnitType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price. + Default: ``20`` +* **RequireHibernateSupport**: bool: Indicates whether instance types must support hibernation for On-Demand Instances. + This parameter is not supported for [GetSpotPlacementScores](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html). + Default: ``false`` +* **SpotMaxPricePercentageOverLowestPrice**: int: [Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the Spot price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified Spot price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose Spot price exceeds your specified threshold. + The parameter accepts an integer, which Amazon EC2 interprets as a percentage. + If you set ``TargetCapacityUnitType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price. + This 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). + Only one of ``SpotMaxPricePercentageOverLowestPrice`` or ``MaxSpotPriceAsPercentageOfOptimalOnDemandPrice`` can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as ``999999``. + Default: ``100`` +* **TotalLocalStorageGB**: [TotalLocalStorageGB](#totallocalstoragegb): The minimum and maximum amount of total local storage, in GB. + Default: No minimum or maximum limits +* **VCpuCount**: [VCpuCount](#vcpucount): The minimum and maximum number of vCPUs. -## AWS.EC2/LocalGatewayRouteProperties +## InstanceRequirementsRequest ### Properties -* **DestinationCidrBlock**: string (Required, Identifier): The CIDR block used for destination matches. -* **LocalGatewayRouteTableId**: string (Required, Identifier): The ID of the local gateway route table. -* **LocalGatewayVirtualInterfaceGroupId**: string: The ID of the virtual interface group. -* **NetworkInterfaceId**: string: The ID of the network interface. -* **State**: string (ReadOnly): The state of the route. -* **Type**: string (ReadOnly): The route type. +* **AcceleratorCount**: [AcceleratorCountRequest](#acceleratorcountrequest) +* **AcceleratorManufacturers**: string[] +* **AcceleratorNames**: string[] +* **AcceleratorTotalMemoryMiB**: [AcceleratorTotalMemoryMiBRequest](#acceleratortotalmemorymibrequest) +* **AcceleratorTypes**: string[] +* **AllowedInstanceTypes**: string[] +* **BareMetal**: string +* **BaselineEbsBandwidthMbps**: [BaselineEbsBandwidthMbpsRequest](#baselineebsbandwidthmbpsrequest) +* **BurstablePerformance**: string +* **CpuManufacturers**: string[] +* **ExcludedInstanceTypes**: string[] +* **InstanceGenerations**: string[] +* **LocalStorage**: string +* **LocalStorageTypes**: string[] +* **MaxSpotPriceAsPercentageOfOptimalOnDemandPrice**: int +* **MemoryGiBPerVCpu**: [MemoryGiBPerVCpuRequest](#memorygibpervcpurequest) +* **MemoryMiB**: [MemoryMiBRequest](#memorymibrequest) +* **NetworkBandwidthGbps**: [NetworkBandwidthGbpsRequest](#networkbandwidthgbpsrequest) +* **NetworkInterfaceCount**: [NetworkInterfaceCountRequest](#networkinterfacecountrequest) +* **OnDemandMaxPricePercentageOverLowestPrice**: int +* **RequireHibernateSupport**: bool +* **SpotMaxPricePercentageOverLowestPrice**: int +* **TotalLocalStorageGB**: [TotalLocalStorageGBRequest](#totallocalstoragegbrequest) +* **VCpuCount**: [VCpuCountRangeRequest](#vcpucountrangerequest) -## AWS.EC2/LocalGatewayRouteTableProperties +## InstanceRequirementsRequest ### Properties -* **LocalGatewayId**: string (Required): The ID of the local gateway. -* **LocalGatewayRouteTableArn**: string (ReadOnly): The ARN of the local gateway route table. -* **LocalGatewayRouteTableId**: string (ReadOnly, Identifier): The ID of the local gateway route table. -* **Mode**: string: The mode of the local gateway route table. -* **OutpostArn**: string (ReadOnly): The ARN of the outpost. -* **OwnerId**: string (ReadOnly): The owner of the local gateway route table. -* **State**: string (ReadOnly): The state of the local gateway route table. -* **Tags**: [Tag](#tag)[]: The tags for the local gateway route table. +* **AcceleratorCount**: [AcceleratorCountRequest](#acceleratorcountrequest) +* **AcceleratorManufacturers**: string[] +* **AcceleratorNames**: string[] +* **AcceleratorTotalMemoryMiB**: [AcceleratorTotalMemoryMiBRequest](#acceleratortotalmemorymibrequest) +* **AcceleratorTypes**: string[] +* **AllowedInstanceTypes**: string[] +* **BareMetal**: string +* **BaselineEbsBandwidthMbps**: [BaselineEbsBandwidthMbpsRequest](#baselineebsbandwidthmbpsrequest) +* **BurstablePerformance**: string +* **CpuManufacturers**: string[] +* **ExcludedInstanceTypes**: string[] +* **InstanceGenerations**: string[] +* **LocalStorage**: string +* **LocalStorageTypes**: string[] +* **MaxSpotPriceAsPercentageOfOptimalOnDemandPrice**: int +* **MemoryGiBPerVCpu**: [MemoryGiBPerVCpuRequest](#memorygibpervcpurequest) +* **MemoryMiB**: [MemoryMiBRequest](#memorymibrequest) +* **NetworkBandwidthGbps**: [NetworkBandwidthGbpsRequest](#networkbandwidthgbpsrequest) +* **NetworkInterfaceCount**: [NetworkInterfaceCountRequest](#networkinterfacecountrequest) +* **OnDemandMaxPricePercentageOverLowestPrice**: int +* **RequireHibernateSupport**: bool +* **SpotMaxPricePercentageOverLowestPrice**: int +* **TotalLocalStorageGB**: [TotalLocalStorageGBRequest](#totallocalstoragegbrequest) +* **VCpuCount**: [VCpuCountRangeRequest](#vcpucountrangerequest) -## Tag +## InstanceTypeSpecification ### Properties -* **Key**: string -* **Value**: string +* **AvailabilityZone**: string +* **AvailabilityZoneId**: string +* **EbsOptimized**: bool +* **InstancePlatform**: string +* **InstanceType**: string +* **Priority**: int +* **Weight**: int -## AWS.EC2/LocalGatewayRouteTableVirtualInterfaceGroupAssociationProperties +## IpamOperatingRegion ### Properties -* **LocalGatewayId**: string (ReadOnly): The ID of the local gateway. -* **LocalGatewayRouteTableArn**: string (ReadOnly): The ARN of the local gateway route table. -* **LocalGatewayRouteTableId**: string (Required): The ID of the local gateway route table. -* **LocalGatewayRouteTableVirtualInterfaceGroupAssociationId**: string (ReadOnly, Identifier): The ID of the local gateway route table virtual interface group association. -* **LocalGatewayVirtualInterfaceGroupId**: string (Required): The ID of the local gateway route table virtual interface group. -* **OwnerId**: string (ReadOnly): The owner of the local gateway route table virtual interface group association. -* **State**: string (ReadOnly): The state of the local gateway route table virtual interface group association. -* **Tags**: [Tag](#tag)[]: The tags for the local gateway route table virtual interface group association. +* **RegionName**: string (Required): The name of the region. -## Tag +## IpamOperatingRegion ### Properties -* **Key**: string -* **Value**: string +* **RegionName**: string (Required): The name of the region. -## AWS.EC2/LocalGatewayRouteTableVPCAssociationProperties +## Ipv4PrefixSpecification ### Properties -* **LocalGatewayId**: string (ReadOnly): The ID of the local gateway. -* **LocalGatewayRouteTableId**: string (Required): The ID of the local gateway route table. -* **LocalGatewayRouteTableVpcAssociationId**: string (ReadOnly, Identifier): The ID of the association. -* **State**: string (ReadOnly): The state of the association. -* **Tags**: [Tag](#tag)[]: The tags for the association. -* **VpcId**: string (Required): The ID of the VPC. +* **Ipv4Prefix**: string: The IPv4 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 *Amazon Elastic Compute Cloud User Guide*. -## Tag +## Ipv4PrefixSpecification ### Properties -* **Key**: string -* **Value**: string +* **Ipv4Prefix**: string (Required) -## AWS.EC2/NatGatewayProperties +## Ipv6Add ### Properties -* **AllocationId**: string -* **ConnectivityType**: string -* **MaxDrainDurationSeconds**: int (WriteOnly) -* **NatGatewayId**: string (ReadOnly, Identifier) -* **PrivateIpAddress**: string -* **SecondaryAllocationIds**: string[] -* **SecondaryPrivateIpAddressCount**: int -* **SecondaryPrivateIpAddresses**: string[] -* **SubnetId**: string (Required) -* **Tags**: [Tag](#tag)[] +* **Ipv6Address**: string: One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses. -## Tag +## Ipv6PrefixSpecification ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **Ipv6Prefix**: string: The IPv6 prefix. -## AWS.EC2/NetworkAclProperties +## Ipv6PrefixSpecification ### Properties -* **Id**: string (ReadOnly, Identifier) -* **Tags**: [Tag](#tag)[]: The tags to assign to the network ACL. -* **VpcId**: string (Required): The ID of the VPC. +* **Ipv6Prefix**: string (Required) -## Tag +## LaunchTemplateConfig ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **LaunchTemplateSpecification**: [FleetLaunchTemplateSpecification](#fleetlaunchtemplatespecification) +* **Overrides**: [LaunchTemplateOverrides](#launchtemplateoverrides)[] -## AWS.EC2/NetworkInsightsAccessScopeProperties +## LaunchTemplateData ### Properties -* **CreatedDate**: string (ReadOnly) -* **ExcludePaths**: [AccessScopePathRequest](#accessscopepathrequest)[] (WriteOnly) -* **MatchPaths**: [AccessScopePathRequest](#accessscopepathrequest)[] (WriteOnly) -* **NetworkInsightsAccessScopeArn**: string (ReadOnly) -* **NetworkInsightsAccessScopeId**: string (ReadOnly, Identifier) -* **Tags**: [Tag](#tag)[] -* **UpdatedDate**: string (ReadOnly) +* **BlockDeviceMappings**: [BlockDeviceMapping](#blockdevicemapping)[]: The block device mapping. +* **CapacityReservationSpecification**: [CapacityReservationSpecification](#capacityreservationspecification): The Capacity Reservation targeting option. If you do not specify this parameter, the instance's Capacity Reservation preference defaults to ``open``, which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). +* **CpuOptions**: [CpuOptions](#cpuoptions): The CPU options for the instance. For more information, see [Optimizing CPU Options](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html) in the *Amazon Elastic Compute Cloud User Guide*. +* **CreditSpecification**: [CreditSpecification](#creditspecification): The credit option for CPU usage of the instance. Valid only for T instances. +* **DisableApiStop**: bool: Indicates whether to enable the instance for stop protection. For more information, see [Stop protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Stop_Start.html#Using_StopProtection) in the *Amazon Elastic Compute Cloud User Guide*. +* **DisableApiTermination**: bool: If you set this parameter to ``true``, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch, use [ModifyInstanceAttribute](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyInstanceAttribute.html). Alternatively, if you set ``InstanceInitiatedShutdownBehavior`` to ``terminate``, you can terminate the instance by running the shutdown command from the instance. +* **EbsOptimized**: bool: Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance. +* **ElasticGpuSpecifications**: [ElasticGpuSpecification](#elasticgpuspecification)[]: Deprecated. + Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, G4dn, or G5 instances. +* **ElasticInferenceAccelerators**: [LaunchTemplateElasticInferenceAccelerator](#launchtemplateelasticinferenceaccelerator)[]: An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads. + You cannot specify accelerators from different generations in the same request. + Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service. +* **EnclaveOptions**: [EnclaveOptions](#enclaveoptions): Indicates whether the instance is enabled for AWS Nitro Enclaves. For more information, see [What is Nitro Enclaves?](https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave.html) in the *Nitro Enclaves User Guide*. + You can't enable AWS Nitro Enclaves and hibernation on the same instance. +* **HibernationOptions**: [HibernationOptions](#hibernationoptions): Indicates whether an instance is enabled for hibernation. This parameter is valid only if the instance meets the [hibernation prerequisites](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/hibernating-prerequisites.html). For more information, see [Hibernate your instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html) in the *Amazon Elastic Compute Cloud User Guide*. +* **IamInstanceProfile**: [IamInstanceProfile](#iaminstanceprofile): The name or Amazon Resource Name (ARN) of an IAM instance profile. +* **ImageId**: string: The ID of the AMI. Alternatively, you can specify a Systems Manager parameter, which will resolve to an AMI ID on launch. + Valid formats: + + ``ami-17characters00000`` + + ``resolve:ssm:parameter-name`` + + ``resolve:ssm:parameter-name:version-number`` + + ``resolve:ssm:parameter-name:label`` + + For 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*. +* **InstanceInitiatedShutdownBehavior**: string: Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown). + Default: ``stop`` +* **InstanceMarketOptions**: [InstanceMarketOptions](#instancemarketoptions): The market (purchasing) option for the instances. +* **InstanceRequirements**: [InstanceRequirements](#instancerequirements): The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes. + You must specify ``VCpuCount`` and ``MemoryMiB``. All other attributes are optional. Any unspecified optional attribute is set to its default. + When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values. + To limit the list of instance types from which Amazon EC2 can identify matching instance types, you can use one of the following parameters, but not both in the same request: + + ``AllowedInstanceTypes`` - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes. + + ``ExcludedInstanceTypes`` - The instance types to exclude from the list, even if they match your specified attributes. + + If you specify ``InstanceRequirements``, you can't specify ``InstanceType``. + Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the [launch instance wizard](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 [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) AWS CloudFormation resource, you can't specify ``InstanceRequirements``. + For more information, see [Attribute-based instance type selection for EC2 Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html), [Attribute-based instance type selection for Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-attribute-based-instance-type-selection.html), and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*. +* **InstanceType**: string: The instance type. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon Elastic Compute Cloud User Guide*. + If you specify ``InstanceType``, you can't specify ``InstanceRequirements``. +* **KernelId**: string: The ID of the kernel. + We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see [User Provided Kernels](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html) in the *Amazon EC2 User Guide*. +* **KeyName**: string: The name of the key pair. You can create a key pair using [CreateKeyPair](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateKeyPair.html) or [ImportKeyPair](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportKeyPair.html). + If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in. +* **LicenseSpecifications**: [LicenseSpecification](#licensespecification)[]: The license configurations. +* **MaintenanceOptions**: [MaintenanceOptions](#maintenanceoptions): The maintenance options of your instance. +* **MetadataOptions**: [MetadataOptions](#metadataoptions): The 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 *Amazon Elastic Compute Cloud User Guide*. +* **Monitoring**: [Monitoring](#monitoring): The monitoring for the instance. +* **NetworkInterfaces**: [NetworkInterface](#networkinterface)[]: The network interfaces for the instance. +* **Placement**: [Placement](#placement): The placement for the instance. +* **PrivateDnsNameOptions**: [PrivateDnsNameOptions](#privatednsnameoptions): The 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 *User Guide*. +* **RamDiskId**: string: The ID of the RAM disk. + We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see [User provided kernels](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html) in the *Amazon Elastic Compute Cloud User Guide*. +* **SecurityGroupIds**: string[]: The IDs of the security groups. You can specify the IDs of existing security groups and references to resources created by the stack template. + If you specify a network interface, you must specify any security groups as part of the network interface instead. +* **SecurityGroups**: string[]: The names of the security groups. For a nondefault VPC, you must use security group IDs instead. + If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter. +* **TagSpecifications**: [TagSpecification](#tagspecification)[]: The tags to apply to the resources that are created during instance launch. + To tag a resource after it has been created, see [CreateTags](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html). + To tag the launch template itself, use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-tagspecifications). +* **UserData**: string: The user data to make available to the instance. You must provide base64-encoded text. User data is limited to 16 KB. For more information, see [Run commands on your Linux instance at launch](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html) (Linux) or [Work with instance user data](https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/instancedata-add-user-data.html) (Windows) in the *Amazon Elastic Compute Cloud User Guide*. + If you are creating the launch template for use with BATCH, the user data must be provided in the [MIME multi-part archive format](https://docs.aws.amazon.com/https://cloudinit.readthedocs.io/en/latest/topics/format.html#mime-multi-part-archive). For more information, see [Amazon EC2 user data in launch templates](https://docs.aws.amazon.com/batch/latest/userguide/launch-templates.html) in the *User Guide*. -## AccessScopePathRequest +## LaunchTemplateElasticInferenceAccelerator ### Properties -* **Destination**: [PathStatementRequest](#pathstatementrequest) -* **Source**: [PathStatementRequest](#pathstatementrequest) -* **ThroughResources**: [ThroughResourcesStatementRequest](#throughresourcesstatementrequest)[] +* **Count**: int: The number of elastic inference accelerators to attach to the instance. + Default: 1 +* **Type**: string: The type of elastic inference accelerator. The possible values are eia1.medium, eia1.large, and eia1.xlarge. -## PathStatementRequest +## LaunchTemplateOverrides ### Properties -* **PacketHeaderStatement**: [PacketHeaderStatementRequest](#packetheaderstatementrequest) -* **ResourceStatement**: [ResourceStatementRequest](#resourcestatementrequest) +* **AvailabilityZone**: string +* **InstanceRequirements**: [InstanceRequirementsRequest](#instancerequirementsrequest) +* **InstanceType**: string +* **Priority**: int +* **SpotPrice**: string +* **SubnetId**: string +* **WeightedCapacity**: int -## PacketHeaderStatementRequest +## LaunchTemplateTagSpecification ### Properties -* **DestinationAddresses**: string[] -* **DestinationPorts**: string[] -* **DestinationPrefixLists**: string[] -* **Protocols**: string[] -* **SourceAddresses**: string[] -* **SourcePorts**: string[] -* **SourcePrefixLists**: string[] +* **ResourceType**: string: The type of resource. To tag the launch template, ``ResourceType`` must be ``launch-template``. +* **Tags**: [Tag](#tag)[]: The tags for the resource. -## ResourceStatementRequest +## LicenseSpecification ### Properties -* **Resources**: string[] -* **ResourceTypes**: string[] +* **LicenseConfigurationArn**: string (Required): The Amazon Resource Name (ARN) of the license configuration. -## ThroughResourcesStatementRequest +## LicenseSpecification ### Properties -* **ResourceStatement**: [ResourceStatementRequest](#resourcestatementrequest) +* **LicenseConfigurationArn**: string: The Amazon Resource Name (ARN) of the license configuration. -## Tag +## LoadBalancerOptions ### Properties -* **Key**: string (Required) -* **Value**: string +* **LoadBalancerArn**: string: The ARN of the load balancer. +* **Port**: int: The IP port number. +* **Protocol**: string: The IP protocol. +* **SubnetIds**: string[]: The IDs of the subnets. -## AWS.EC2/NetworkInsightsAccessScopeAnalysisProperties +## LoadBalancersConfig ### Properties -* **AnalyzedEniCount**: int (ReadOnly) -* **EndDate**: string (ReadOnly) -* **FindingsFound**: string (ReadOnly) -* **NetworkInsightsAccessScopeAnalysisArn**: string (ReadOnly) -* **NetworkInsightsAccessScopeAnalysisId**: string (ReadOnly, Identifier) -* **NetworkInsightsAccessScopeId**: string (Required) -* **StartDate**: string (ReadOnly) -* **Status**: string (ReadOnly) -* **StatusMessage**: string (ReadOnly) -* **Tags**: [Tag](#tag)[] +* **ClassicLoadBalancersConfig**: [ClassicLoadBalancersConfig](#classicloadbalancersconfig) +* **TargetGroupsConfig**: [TargetGroupsConfig](#targetgroupsconfig) -## Tag +## MaintenanceOptions ### Properties -* **Key**: string (Required) -* **Value**: string +* **AutoRecovery**: string: Disables the automatic recovery behavior of your instance or sets it to default. -## AWS.EC2/NetworkInsightsAnalysisProperties +## MaintenanceStrategies ### Properties -* **AdditionalAccounts**: string[] -* **AlternatePathHints**: [AlternatePathHint](#alternatepathhint)[] (ReadOnly) -* **Explanations**: [Explanation](#explanation)[] (ReadOnly) -* **FilterInArns**: string[] -* **ForwardPathComponents**: [PathComponent](#pathcomponent)[] (ReadOnly) -* **NetworkInsightsAnalysisArn**: string (ReadOnly) -* **NetworkInsightsAnalysisId**: string (ReadOnly, Identifier) -* **NetworkInsightsPathId**: string (Required) -* **NetworkPathFound**: bool (ReadOnly) -* **ReturnPathComponents**: [PathComponent](#pathcomponent)[] (ReadOnly) -* **StartDate**: string (ReadOnly) -* **Status**: string (ReadOnly) -* **StatusMessage**: string (ReadOnly) -* **SuggestedAccounts**: string[] (ReadOnly) -* **Tags**: [Tag](#tag)[] +* **CapacityRebalance**: [CapacityRebalance](#capacityrebalance) -## AlternatePathHint +## MemoryGiBPerVCpu ### Properties -* **ComponentArn**: string -* **ComponentId**: string +* **Max**: int: The maximum amount of memory per vCPU, in GiB. To specify no maximum limit, omit this parameter. +* **Min**: int: The minimum amount of memory per vCPU, in GiB. To specify no minimum limit, omit this parameter. -## Explanation +## MemoryGiBPerVCpuRequest ### Properties -* **Acl**: [AnalysisComponent](#analysiscomponent) -* **AclRule**: [AnalysisAclRule](#analysisaclrule) -* **Address**: string -* **Addresses**: string[] -* **AttachedTo**: [AnalysisComponent](#analysiscomponent) -* **AvailabilityZones**: string[] -* **Cidrs**: string[] -* **ClassicLoadBalancerListener**: [AnalysisLoadBalancerListener](#analysisloadbalancerlistener) -* **Component**: [AnalysisComponent](#analysiscomponent) -* **ComponentAccount**: string -* **ComponentRegion**: string -* **CustomerGateway**: [AnalysisComponent](#analysiscomponent) -* **Destination**: [AnalysisComponent](#analysiscomponent) -* **DestinationVpc**: [AnalysisComponent](#analysiscomponent) -* **Direction**: string -* **ElasticLoadBalancerListener**: [AnalysisComponent](#analysiscomponent) -* **ExplanationCode**: string -* **IngressRouteTable**: [AnalysisComponent](#analysiscomponent) -* **InternetGateway**: [AnalysisComponent](#analysiscomponent) -* **LoadBalancerArn**: string -* **LoadBalancerListenerPort**: int -* **LoadBalancerTarget**: [AnalysisLoadBalancerTarget](#analysisloadbalancertarget) -* **LoadBalancerTargetGroup**: [AnalysisComponent](#analysiscomponent) -* **LoadBalancerTargetGroups**: [AnalysisComponent](#analysiscomponent)[] -* **LoadBalancerTargetPort**: int -* **MissingComponent**: string -* **NatGateway**: [AnalysisComponent](#analysiscomponent) -* **NetworkInterface**: [AnalysisComponent](#analysiscomponent) -* **PacketField**: string -* **Port**: int -* **PortRanges**: [PortRange](#portrange)[] -* **PrefixList**: [AnalysisComponent](#analysiscomponent) -* **Protocols**: string[] -* **RouteTable**: [AnalysisComponent](#analysiscomponent) -* **RouteTableRoute**: [AnalysisRouteTableRoute](#analysisroutetableroute) -* **SecurityGroup**: [AnalysisComponent](#analysiscomponent) -* **SecurityGroupRule**: [AnalysisSecurityGroupRule](#analysissecuritygrouprule) -* **SecurityGroups**: [AnalysisComponent](#analysiscomponent)[] -* **SourceVpc**: [AnalysisComponent](#analysiscomponent) -* **State**: string -* **Subnet**: [AnalysisComponent](#analysiscomponent) -* **SubnetRouteTable**: [AnalysisComponent](#analysiscomponent) -* **TransitGateway**: [AnalysisComponent](#analysiscomponent) -* **TransitGatewayAttachment**: [AnalysisComponent](#analysiscomponent) -* **TransitGatewayRouteTable**: [AnalysisComponent](#analysiscomponent) -* **TransitGatewayRouteTableRoute**: [TransitGatewayRouteTableRoute](#transitgatewayroutetableroute) -* **Vpc**: [AnalysisComponent](#analysiscomponent) -* **vpcEndpoint**: [AnalysisComponent](#analysiscomponent) -* **VpcPeeringConnection**: [AnalysisComponent](#analysiscomponent) -* **VpnConnection**: [AnalysisComponent](#analysiscomponent) -* **VpnGateway**: [AnalysisComponent](#analysiscomponent) +* **Max**: int +* **Min**: int -## AnalysisComponent +## MemoryGiBPerVCpuRequest ### Properties -* **Arn**: string -* **Id**: string +* **Max**: int +* **Min**: int -## AnalysisAclRule +## MemoryMiB ### Properties -* **Cidr**: string -* **Egress**: bool -* **PortRange**: [PortRange](#portrange) -* **Protocol**: string -* **RuleAction**: string -* **RuleNumber**: int +* **Max**: int: The maximum amount of memory, in MiB. To specify no maximum limit, omit this parameter. +* **Min**: int: The minimum amount of memory, in MiB. To specify no minimum limit, specify ``0``. -## PortRange +## MemoryMiBRequest ### Properties -* **From**: int -* **To**: int +* **Max**: int +* **Min**: int -## AnalysisLoadBalancerListener +## MemoryMiBRequest ### Properties -* **InstancePort**: int -* **LoadBalancerPort**: int +* **Max**: int +* **Min**: int -## AnalysisLoadBalancerTarget +## MetadataOptions ### Properties -* **Address**: string -* **AvailabilityZone**: string -* **Instance**: [AnalysisComponent](#analysiscomponent) -* **Port**: int +* **HttpEndpoint**: string: Enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is ``enabled``. + If you specify a value of ``disabled``, you will not be able to access your instance metadata. +* **HttpProtocolIpv6**: string: Enables or disables the IPv6 endpoint for the instance metadata service. + Default: ``disabled`` +* **HttpPutResponseHopLimit**: int: The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel. + Default: ``1`` + Possible values: Integers from 1 to 64 +* **HttpTokens**: string: Indicates whether IMDSv2 is required. + + ``optional`` - IMDSv2 is optional. You can choose whether to send a session token in your instance metadata retrieval requests. If you retrieve IAM role credentials without a session token, you receive the IMDSv1 role credentials. If you retrieve IAM role credentials using a valid session token, you receive the IMDSv2 role credentials. + + ``required`` - IMDSv2 is required. You must send a session token in your instance metadata retrieval requests. With this option, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available. + + Default: If the value of ``ImdsSupport`` for the Amazon Machine Image (AMI) for your instance is ``v2.0``, the default is ``required``. +* **InstanceMetadataTags**: string: Set to ``enabled`` to allow access to instance tags from the instance metadata. Set to ``disabled`` to turn off access to instance tags from the instance metadata. For more information, see [Work with instance tags using the instance metadata](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#work-with-tags-in-IMDS). + Default: ``disabled`` -## AnalysisRouteTableRoute +## Monitoring ### Properties -* **destinationCidr**: string -* **destinationPrefixListId**: string -* **egressOnlyInternetGatewayId**: string -* **gatewayId**: string -* **instanceId**: string -* **NatGatewayId**: string -* **NetworkInterfaceId**: string -* **Origin**: string -* **State**: string -* **TransitGatewayId**: string -* **VpcPeeringConnectionId**: string +* **Enabled**: bool: Specify ``true`` to enable detailed monitoring. Otherwise, basic monitoring is enabled. -## AnalysisSecurityGroupRule +## NetworkBandwidthGbps ### Properties -* **Cidr**: string -* **Direction**: string -* **PortRange**: [PortRange](#portrange) -* **PrefixListId**: string -* **Protocol**: string -* **SecurityGroupId**: string +* **Max**: int: The maximum amount of network bandwidth, in Gbps. To specify no maximum limit, omit this parameter. +* **Min**: int: The minimum amount of network bandwidth, in Gbps. If this parameter is not specified, there is no minimum limit. -## TransitGatewayRouteTableRoute +## NetworkBandwidthGbpsRequest ### Properties -* **AttachmentId**: string -* **DestinationCidr**: string -* **PrefixListId**: string -* **ResourceId**: string -* **ResourceType**: string -* **RouteOrigin**: string -* **State**: string +* **Max**: int +* **Min**: int + +## NetworkBandwidthGbpsRequest +### Properties +* **Max**: int +* **Min**: int + +## NetworkInterface +### Properties +* **AssociateCarrierIpAddress**: bool: Not currently supported by AWS CloudFormation. +* **AssociatePublicIpAddress**: bool: Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. +* **DeleteOnTermination**: bool: If set to true, the interface is deleted when the instance is terminated. +* **Description**: string: The description of the network interface. +* **DeviceIndex**: string (Required): The position of the network interface in the attachment order. A primary network interface has a device index of 0. +* **GroupSet**: string[]: The IDs of the security groups for the network interface. +* **Ipv6AddressCount**: int: A number of IPv6 addresses to assign to the network interface. +* **Ipv6Addresses**: [InstanceIpv6Address](#instanceipv6address)[]: The IPv6 addresses associated with the network interface. +* **NetworkInterfaceId**: string: The ID of the network interface. +* **PrivateIpAddress**: string: The private IPv4 address of the network interface. +* **PrivateIpAddresses**: [PrivateIpAddressSpecification](#privateipaddressspecification)[]: One or more private IPv4 addresses to assign to the network interface. +* **SecondaryPrivateIpAddressCount**: int: The number of secondary private IPv4 addresses. +* **SubnetId**: string: The ID of the subnet. + +## NetworkInterface +### Properties +* **AssociateCarrierIpAddress**: bool: Associates a Carrier IP address with eth0 for a new network interface. + Use this option when you launch an instance in a Wavelength Zone and want to associate a Carrier IP address with the network interface. For more information about Carrier IP addresses, see [Carrier IP addresses](https://docs.aws.amazon.com/wavelength/latest/developerguide/how-wavelengths-work.html#provider-owned-ip) in the *Developer Guide*. +* **AssociatePublicIpAddress**: bool: Associates a public IPv4 address with eth0 for a new network interface. + AWS charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the *Public IPv4 Address* tab on the [Amazon VPC pricing page](https://docs.aws.amazon.com/vpc/pricing/). +* **ConnectionTrackingSpecification**: [ConnectionTrackingSpecification](#connectiontrackingspecification): A connection tracking specification for the network interface. +* **DeleteOnTermination**: bool: Indicates whether the network interface is deleted when the instance is terminated. +* **Description**: string: A description for the network interface. +* **DeviceIndex**: int: The device index for the network interface attachment. Each network interface requires a device index. If you create a launch template that includes secondary network interfaces but not a primary network interface, then you must add a primary network interface as a launch parameter when you launch an instance from the template. +* **EnaSrdSpecification**: [EnaSrdSpecification](#enasrdspecification): The ENA Express configuration for the network interface. +* **Groups**: string[]: The IDs of one or more security groups. +* **InterfaceType**: string: The type of network interface. To create an Elastic Fabric Adapter (EFA), specify ``efa``. For more information, see [Elastic Fabric Adapter](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa.html) in the *Amazon Elastic Compute Cloud User Guide*. + If you are not creating an EFA, specify ``interface`` or omit this parameter. + Valid values: ``interface`` | ``efa`` +* **Ipv4PrefixCount**: int: The number of IPv4 prefixes to be automatically assigned to the network interface. You cannot use this option if you use the ``Ipv4Prefix`` option. +* **Ipv4Prefixes**: [Ipv4PrefixSpecification](#ipv4prefixspecification)[]: One or more IPv4 prefixes to be assigned to the network interface. You cannot use this option if you use the ``Ipv4PrefixCount`` option. +* **Ipv6AddressCount**: int: The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses. +* **Ipv6Addresses**: [Ipv6Add](#ipv6add)[]: One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses. +* **Ipv6PrefixCount**: int: The number of IPv6 prefixes to be automatically assigned to the network interface. You cannot use this option if you use the ``Ipv6Prefix`` option. +* **Ipv6Prefixes**: [Ipv6PrefixSpecification](#ipv6prefixspecification)[]: One or more IPv6 prefixes to be assigned to the network interface. You cannot use this option if you use the ``Ipv6PrefixCount`` option. +* **NetworkCardIndex**: int: The index of the network card. Some instance types support multiple network cards. The primary network interface must be assigned to network card index 0. The default is network card index 0. +* **NetworkInterfaceId**: string: The ID of the network interface. +* **PrimaryIpv6**: bool: The primary IPv6 address of the network interface. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information about primary IPv6 addresses, see [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html). +* **PrivateIpAddress**: string: The primary private IPv4 address of the network interface. +* **PrivateIpAddresses**: [PrivateIpAdd](#privateipadd)[]: One or more private IPv4 addresses. +* **SecondaryPrivateIpAddressCount**: int: The number of secondary private IPv4 addresses to assign to a network interface. +* **SubnetId**: string: The ID of the subnet for the network interface. + +## NetworkInterfaceAttachment_EnaSrdUdpSpecification +### Properties +* **EnaSrdUdpEnabled**: bool + +## NetworkInterfaceCount +### Properties +* **Max**: int: The maximum number of network interfaces. To specify no maximum limit, omit this parameter. +* **Min**: int: The minimum number of network interfaces. To specify no minimum limit, omit this parameter. + +## NetworkInterfaceCountRequest +### Properties +* **Max**: int +* **Min**: int + +## NetworkInterfaceCountRequest +### Properties +* **Max**: int +* **Min**: int + +## NetworkInterfaceOptions +### Properties +* **NetworkInterfaceId**: string: The ID of the network interface. +* **Port**: int: The IP port number. +* **Protocol**: string: The IP protocol. + +## OidcOptions +### Properties +* **AuthorizationEndpoint**: string: The OIDC authorization endpoint. +* **ClientId**: string: The client identifier. +* **ClientSecret**: string: The client secret. +* **Issuer**: string: The OIDC issuer. +* **Scope**: string: OpenID Connect (OIDC) scopes are used by an application during authentication to authorize access to details of a user. Each scope returns a specific set of user attributes. +* **TokenEndpoint**: string: The OIDC token endpoint. +* **UserInfoEndpoint**: string: The OIDC user info endpoint. + +## OnDemandOptionsRequest +### Properties +* **AllocationStrategy**: string +* **CapacityReservationOptions**: [CapacityReservationOptionsRequest](#capacityreservationoptionsrequest) +* **MaxTotalPrice**: string +* **MinTargetCapacity**: int +* **SingleAvailabilityZone**: bool +* **SingleInstanceType**: bool + +## PacketHeaderStatementRequest +### Properties +* **DestinationAddresses**: string[] +* **DestinationPorts**: string[] +* **DestinationPrefixLists**: string[] +* **Protocols**: string[] +* **SourceAddresses**: string[] +* **SourcePorts**: string[] +* **SourcePrefixLists**: string[] ## PathComponent ### Properties @@ -1658,43 +2288,6 @@ * **TransitGatewayRouteTableRoute**: [TransitGatewayRouteTableRoute](#transitgatewayroutetableroute) * **Vpc**: [AnalysisComponent](#analysiscomponent) -## AdditionalDetail -### Properties -* **AdditionalDetailType**: string -* **Component**: [AnalysisComponent](#analysiscomponent) -* **LoadBalancers**: [AnalysisComponent](#analysiscomponent)[] -* **ServiceName**: string - -## AnalysisPacketHeader -### Properties -* **DestinationAddresses**: string[] -* **DestinationPortRanges**: [PortRange](#portrange)[] -* **Protocol**: string -* **SourceAddresses**: string[] -* **SourcePortRanges**: [PortRange](#portrange)[] - -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string - -## AWS.EC2/NetworkInsightsPathProperties -### Properties -* **CreatedDate**: string (ReadOnly) -* **Destination**: string -* **DestinationArn**: string (ReadOnly) -* **DestinationIp**: string -* **DestinationPort**: int -* **FilterAtDestination**: [PathFilter](#pathfilter) -* **FilterAtSource**: [PathFilter](#pathfilter) -* **NetworkInsightsPathArn**: string (ReadOnly) -* **NetworkInsightsPathId**: string (ReadOnly, Identifier) -* **Protocol**: string (Required) -* **Source**: string (Required) -* **SourceArn**: string (ReadOnly) -* **SourceIp**: string -* **Tags**: [Tag](#tag)[] - ## PathFilter ### Properties * **DestinationAddress**: string @@ -1702,183 +2295,115 @@ * **SourceAddress**: string * **SourcePortRange**: [FilterPortRange](#filterportrange) -## FilterPortRange -### Properties -* **FromPort**: int -* **ToPort**: int - -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string - -## AWS.EC2/NetworkInterfaceProperties -### Properties -* **Description**: string: A description for the network interface. -* **EnablePrimaryIpv6**: bool: If you have instances or ENIs that rely on the IPv6 address not changing, to avoid disrupting traffic to instances or ENIs, you can enable a primary IPv6 address. Enable this option to automatically assign an IPv6 associated with the ENI attached to your instance to be the primary IPv6 address. When you enable an IPv6 address to be a primary IPv6, you cannot disable it. Traffic will be routed to the primary IPv6 address until the instance is terminated or the ENI is detached. If you have multiple IPv6 addresses associated with an ENI and you enable a primary IPv6 address, the first IPv6 address associated with the ENI becomes the primary IPv6 address. -* **GroupSet**: string[]: A list of security group IDs associated with this network interface. -* **Id**: string (ReadOnly, Identifier): Network interface id. -* **InterfaceType**: string: Indicates the type of network interface. -* **Ipv4PrefixCount**: int: The number of IPv4 prefixes to assign to a network interface. When you specify a number of IPv4 prefixes, Amazon EC2 selects these prefixes from your existing subnet CIDR reservations, if available, or from free spaces in the subnet. By default, these will be /28 prefixes. 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. -* **Ipv4Prefixes**: [Ipv4PrefixSpecification](#ipv4prefixspecification)[]: Assigns a list of IPv4 prefixes to the network interface. If you want EC2 to automatically assign IPv4 prefixes, use the Ipv4PrefixCount property and do not specify this property. Presently, only /28 prefixes are supported. 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. -* **Ipv6AddressCount**: int: The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. To specify specific IPv6 addresses, use the Ipv6Addresses property and don't specify this property. -* **Ipv6Addresses**: [InstanceIpv6Address](#instanceipv6address)[]: One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet to associate with the network interface. If you're specifying a number of IPv6 addresses, use the Ipv6AddressCount property and don't specify this property. -* **Ipv6PrefixCount**: int: The number of IPv6 prefixes to assign to a network interface. When you specify a number of IPv6 prefixes, Amazon EC2 selects these prefixes from your existing subnet CIDR reservations, if available, or from free spaces in the subnet. By default, these will be /80 prefixes. You can't specify a count of IPv6 prefixes if you've specified one of the following: specific IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses. -* **Ipv6Prefixes**: [Ipv6PrefixSpecification](#ipv6prefixspecification)[]: Assigns a list of IPv6 prefixes to the network interface. If you want EC2 to automatically assign IPv6 prefixes, use the Ipv6PrefixCount property and do not specify this property. Presently, only /80 prefixes are supported. You can't specify IPv6 prefixes if you've specified one of the following: a count of IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses. -* **PrimaryIpv6Address**: string (ReadOnly): The primary IPv6 address -* **PrimaryPrivateIpAddress**: string (ReadOnly): Returns the primary private IP address of the network interface. -* **PrivateIpAddress**: string: Assigns a single private IP address to the network interface, which is used as the primary private IP address. If you want to specify multiple private IP address, use the PrivateIpAddresses property. -* **PrivateIpAddresses**: [PrivateIpAddressSpecification](#privateipaddressspecification)[]: Assigns a list of private IP addresses to the network interface. You can specify a primary private IP address by setting the value of the Primary property to true in the PrivateIpAddressSpecification property. If you want EC2 to automatically assign private IP addresses, use the SecondaryPrivateIpAddressCount property and do not specify this property. -* **SecondaryPrivateIpAddressCount**: int: The number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet's IPv4 CIDR range. You can't specify this option and specify more than one private IP address using privateIpAddresses -* **SecondaryPrivateIpAddresses**: string[] (ReadOnly): Returns the secondary private IP addresses of the network interface. -* **SourceDestCheck**: bool: Indicates whether traffic to or from the instance is validated. -* **SubnetId**: string (Required): The ID of the subnet to associate with the network interface. -* **Tags**: [Tag](#tag)[]: An arbitrary set of tags (key-value pairs) for this network interface. - -## Ipv4PrefixSpecification -### Properties -* **Ipv4Prefix**: string (Required) - -## InstanceIpv6Address -### Properties -* **Ipv6Address**: string (Required) - -## Ipv6PrefixSpecification -### Properties -* **Ipv6Prefix**: string (Required) - -## PrivateIpAddressSpecification +## PathStatementRequest ### Properties -* **Primary**: bool (Required) -* **PrivateIpAddress**: string (Required) +* **PacketHeaderStatement**: [PacketHeaderStatementRequest](#packetheaderstatementrequest) +* **ResourceStatement**: [ResourceStatementRequest](#resourcestatementrequest) -## Tag +## PeeringAttachmentStatus ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **Code**: string: The status code. +* **Message**: string: The status message, if applicable. -## AWS.EC2/NetworkInterfaceAttachmentProperties +## Placement ### Properties -* **AttachmentId**: string (ReadOnly, Identifier): The ID of the network interface attachment. -* **DeleteOnTermination**: bool: Whether to delete the network interface when the instance terminates. By default, this value is set to true. -* **DeviceIndex**: string (Required): The network interface's position in the attachment order. For example, the first attached network interface has a DeviceIndex of 0. -* **InstanceId**: string (Required): The ID of the instance to which you will attach the ENI. -* **NetworkInterfaceId**: string (Required): The ID of the ENI that you want to attach. +* **Affinity**: string +* **AvailabilityZone**: string +* **GroupName**: string +* **HostId**: string +* **HostResourceGroupArn**: string +* **PartitionNumber**: int +* **SpreadDomain**: string +* **Tenancy**: string -## AWS.EC2/PrefixListProperties -### Properties -* **AddressFamily**: string (Required): Ip Version of Prefix List. -* **Arn**: string (ReadOnly): The Amazon Resource Name (ARN) of the Prefix List. -* **Entries**: [Entry](#entry)[]: Entries of Prefix List. -* **MaxEntries**: int (Required): Max Entries of Prefix List. -* **OwnerId**: string (ReadOnly): Owner Id of Prefix List. -* **PrefixListId**: string (ReadOnly, Identifier): Id of Prefix List. -* **PrefixListName**: string (Required): Name of Prefix List. -* **Tags**: [Tag](#tag)[]: Tags for Prefix List -* **Version**: int (ReadOnly): Version of Prefix List. +## Placement +### Properties +* **Affinity**: string: The affinity setting for an instance on a Dedicated Host. +* **AvailabilityZone**: string: The Availability Zone for the instance. +* **GroupId**: string: The Group Id of a placement group. You must specify the Placement Group *Group Id* to launch an instance in a shared placement group. +* **GroupName**: string: The name of the placement group for the instance. +* **HostId**: string: The ID of the Dedicated Host for the instance. +* **HostResourceGroupArn**: string: The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the *Tenancy* parameter or set it to ``host``. +* **PartitionNumber**: int: The number of the partition the instance should launch in. Valid only if the placement group strategy is set to ``partition``. +* **SpreadDomain**: string: Reserved for future use. +* **Tenancy**: string: The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware. -## Entry +## PortRange ### Properties -* **Cidr**: string (Required) -* **Description**: string +* **From**: int +* **To**: int -## Tag +## PrivateDnsNameOptions ### Properties -* **Key**: string (Required) -* **Value**: string +* **EnableResourceNameDnsAAAARecord**: bool: Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records. +* **EnableResourceNameDnsARecord**: bool: Indicates whether to respond to DNS queries for instance hostnames with DNS A records. +* **HostnameType**: string: The type of hostname for EC2 instances. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names 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 *User Guide*. -## AWS.EC2/RouteProperties +## PrivateIpAdd ### Properties -* **CarrierGatewayId**: string: The ID of the carrier gateway. -* **CidrBlock**: string (ReadOnly, Identifier): The primary identifier of the resource generated by the service. -* **CoreNetworkArn**: string: The Amazon Resource Name (ARN) of the core network. -* **DestinationCidrBlock**: string: The IPv4 CIDR block used for the destination match. -* **DestinationIpv6CidrBlock**: string: The IPv6 CIDR block used for the destination match. -* **DestinationPrefixListId**: string: The ID of managed prefix list, it's a set of one or more CIDR blocks. -* **EgressOnlyInternetGatewayId**: string: The ID of the egress-only internet gateway. -* **GatewayId**: string: The ID of an internet gateway or virtual private gateway attached to your VPC. -* **InstanceId**: string: The ID of a NAT instance in your VPC. -* **LocalGatewayId**: string: The ID of the local gateway. -* **NatGatewayId**: string: The ID of a NAT gateway. -* **NetworkInterfaceId**: string: The ID of the network interface. -* **RouteTableId**: string (Required, Identifier): The ID of the route table. The routing table must be associated with the same VPC that the virtual private gateway is attached to. -* **TransitGatewayId**: string: The ID of a transit gateway. -* **VpcEndpointId**: string: The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only. -* **VpcPeeringConnectionId**: string: The ID of a VPC peering connection. +* **Primary**: bool: Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary. +* **PrivateIpAddress**: string: The private IPv4 address. -## AWS.EC2/RouteTableProperties +## PrivateIpAddressSpecification ### Properties -* **RouteTableId**: string (ReadOnly, Identifier): The route table ID. -* **Tags**: [Tag](#tag)[]: Any tags assigned to the route table. -* **VpcId**: string (Required): The ID of the VPC. +* **Primary**: bool (Required): Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary. +* **PrivateIpAddress**: string (Required): The private IPv4 addresses. -## Tag +## PrivateIpAddressSpecification ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **Primary**: bool (Required) +* **PrivateIpAddress**: string (Required) -## AWS.EC2/SecurityGroupProperties +## PrivateIpAddressSpecification ### Properties -* **GroupDescription**: string (Required) -* **GroupId**: string (ReadOnly) -* **GroupName**: string -* **Id**: string (ReadOnly, Identifier) -* **SecurityGroupEgress**: [Egress](#egress)[] -* **SecurityGroupIngress**: [Ingress](#ingress)[] -* **Tags**: [Tag](#tag)[] -* **VpcId**: string +* **Primary**: bool +* **PrivateIpAddress**: string (Required) -## Egress +## ProvisionedCidr ### Properties -* **CidrIp**: string -* **CidrIpv6**: string -* **Description**: string -* **DestinationPrefixListId**: string -* **DestinationSecurityGroupId**: string -* **FromPort**: int -* **IpProtocol**: string (Required) -* **ToPort**: int +* **Cidr**: string (Required) -## Ingress +## ResourceStatementRequest ### Properties -* **CidrIp**: string -* **CidrIpv6**: string -* **Description**: string -* **FromPort**: int -* **IpProtocol**: string (Required) -* **SourcePrefixListId**: string -* **SourceSecurityGroupId**: string -* **SourceSecurityGroupName**: string -* **SourceSecurityGroupOwnerId**: string -* **ToPort**: int +* **Resources**: string[] +* **ResourceTypes**: string[] -## Tag +## SourceResource ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **ResourceId**: string (Required) +* **ResourceOwner**: string (Required) +* **ResourceRegion**: string (Required) +* **ResourceType**: string (Required) -## AWS.EC2/SecurityGroupEgressProperties +## SpotCapacityRebalance ### Properties -* **CidrIp**: string: The IPv4 ranges -* **CidrIpv6**: string: [VPC only] The IPv6 ranges -* **Description**: string: Resource Type definition for an egress (outbound) security group rule. -* **DestinationPrefixListId**: string: [EC2-VPC only] The ID of a prefix list. -* **DestinationSecurityGroupId**: string: You must specify a destination security group (DestinationPrefixListId or DestinationSecurityGroupId) or a CIDR range (CidrIp or CidrIpv6). -* **FromPort**: int: The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes. -* **GroupId**: string (Required): The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID. -* **Id**: string (ReadOnly, Identifier): The Security Group Rule Id -* **IpProtocol**: string (Required): [VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp, udp, and icmp, you must specify a port range. For icmpv6, the port range is optional; if you omit the port range, traffic for all types and codes is allowed. -* **ToPort**: int: The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes. +* **ReplacementStrategy**: string +* **TerminationDelay**: int -## AWS.EC2/SnapshotBlockPublicAccessProperties +## SpotFleetLaunchSpecification ### Properties -* **AccountId**: string (ReadOnly, Identifier): The identifier for the specified AWS account. -* **State**: string (Required): The state of EBS Snapshot Block Public Access. +* **BlockDeviceMappings**: [BlockDeviceMapping](#blockdevicemapping)[] +* **EbsOptimized**: bool +* **IamInstanceProfile**: [IamInstanceProfileSpecification](#iaminstanceprofilespecification) +* **ImageId**: string (Required) +* **InstanceRequirements**: [InstanceRequirementsRequest](#instancerequirementsrequest) +* **InstanceType**: string +* **KernelId**: string +* **KeyName**: string +* **Monitoring**: [SpotFleetMonitoring](#spotfleetmonitoring) +* **NetworkInterfaces**: [InstanceNetworkInterfaceSpecification](#instancenetworkinterfacespecification)[] +* **Placement**: [SpotPlacement](#spotplacement) +* **RamdiskId**: string +* **SecurityGroups**: [GroupIdentifier](#groupidentifier)[] +* **SpotPrice**: string +* **SubnetId**: string +* **TagSpecifications**: [SpotFleetTagSpecification](#spotfleettagspecification)[] +* **UserData**: string +* **WeightedCapacity**: int -## AWS.EC2/SpotFleetProperties +## SpotFleetMonitoring ### Properties -* **Id**: string (ReadOnly, Identifier) -* **SpotFleetRequestConfigData**: [SpotFleetRequestConfigData](#spotfleetrequestconfigdata) (Required) +* **Enabled**: bool ## SpotFleetRequestConfigData ### Properties @@ -1906,677 +2431,451 @@ * **ValidFrom**: string * **ValidUntil**: string -## SpotFleetLaunchSpecification -### Properties -* **BlockDeviceMappings**: [BlockDeviceMapping](#blockdevicemapping)[] -* **EbsOptimized**: bool -* **IamInstanceProfile**: [IamInstanceProfileSpecification](#iaminstanceprofilespecification) -* **ImageId**: string (Required) -* **InstanceRequirements**: [InstanceRequirementsRequest](#instancerequirementsrequest) -* **InstanceType**: string -* **KernelId**: string -* **KeyName**: string -* **Monitoring**: [SpotFleetMonitoring](#spotfleetmonitoring) -* **NetworkInterfaces**: [InstanceNetworkInterfaceSpecification](#instancenetworkinterfacespecification)[] -* **Placement**: [SpotPlacement](#spotplacement) -* **RamdiskId**: string -* **SecurityGroups**: [GroupIdentifier](#groupidentifier)[] -* **SpotPrice**: string -* **SubnetId**: string -* **TagSpecifications**: [SpotFleetTagSpecification](#spotfleettagspecification)[] -* **UserData**: string -* **WeightedCapacity**: int - -## BlockDeviceMapping -### Properties -* **DeviceName**: string (Required) -* **Ebs**: [EbsBlockDevice](#ebsblockdevice) -* **NoDevice**: string -* **VirtualName**: string - -## EbsBlockDevice -### Properties -* **DeleteOnTermination**: bool -* **Encrypted**: bool -* **Iops**: int -* **SnapshotId**: string -* **VolumeSize**: int -* **VolumeType**: string - -## IamInstanceProfileSpecification -### Properties -* **Arn**: string - -## InstanceRequirementsRequest -### Properties -* **AcceleratorCount**: [AcceleratorCountRequest](#acceleratorcountrequest) -* **AcceleratorManufacturers**: string[] -* **AcceleratorNames**: string[] -* **AcceleratorTotalMemoryMiB**: [AcceleratorTotalMemoryMiBRequest](#acceleratortotalmemorymibrequest) -* **AcceleratorTypes**: string[] -* **AllowedInstanceTypes**: string[] -* **BareMetal**: string -* **BaselineEbsBandwidthMbps**: [BaselineEbsBandwidthMbpsRequest](#baselineebsbandwidthmbpsrequest) -* **BurstablePerformance**: string -* **CpuManufacturers**: string[] -* **ExcludedInstanceTypes**: string[] -* **InstanceGenerations**: string[] -* **LocalStorage**: string -* **LocalStorageTypes**: string[] -* **MemoryGiBPerVCpu**: [MemoryGiBPerVCpuRequest](#memorygibpervcpurequest) -* **MemoryMiB**: [MemoryMiBRequest](#memorymibrequest) -* **NetworkBandwidthGbps**: [NetworkBandwidthGbpsRequest](#networkbandwidthgbpsrequest) -* **NetworkInterfaceCount**: [NetworkInterfaceCountRequest](#networkinterfacecountrequest) -* **OnDemandMaxPricePercentageOverLowestPrice**: int -* **RequireHibernateSupport**: bool -* **SpotMaxPricePercentageOverLowestPrice**: int -* **TotalLocalStorageGB**: [TotalLocalStorageGBRequest](#totallocalstoragegbrequest) -* **VCpuCount**: [VCpuCountRangeRequest](#vcpucountrangerequest) - -## AcceleratorCountRequest +## SpotFleetTagSpecification ### Properties -* **Max**: int -* **Min**: int +* **ResourceType**: string +* **Tags**: [Tag](#tag)[] -## AcceleratorTotalMemoryMiBRequest +## SpotMaintenanceStrategies ### Properties -* **Max**: int -* **Min**: int +* **CapacityRebalance**: [SpotCapacityRebalance](#spotcapacityrebalance) -## BaselineEbsBandwidthMbpsRequest +## SpotOptions ### Properties -* **Max**: int -* **Min**: int +* **BlockDurationMinutes**: int: Deprecated. +* **InstanceInterruptionBehavior**: string: The behavior when a Spot Instance is interrupted. The default is ``terminate``. +* **MaxPrice**: string: The maximum hourly price you're willing to pay for the Spot Instances. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price. + If you specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter. +* **SpotInstanceType**: string: The Spot Instance request type. + If you are using Spot Instances with an Auto Scaling group, use ``one-time`` requests, as the ASlong service handles requesting new Spot Instances whenever the group is below its desired capacity. +* **ValidUntil**: string: The end date of the request, in UTC format (*YYYY-MM-DD*T*HH:MM:SS*Z). Supported only for persistent requests. + + For a persistent request, the request remains active until the ``ValidUntil`` date and time is reached. Otherwise, the request remains active until you cancel it. + + For a one-time request, ``ValidUntil`` is not supported. The request remains active until all instances launch or you cancel the request. + + Default: 7 days from the current date -## MemoryGiBPerVCpuRequest +## SpotOptionsRequest ### Properties -* **Max**: int -* **Min**: int +* **AllocationStrategy**: string +* **InstanceInterruptionBehavior**: string +* **InstancePoolsToUseCount**: int +* **MaintenanceStrategies**: [MaintenanceStrategies](#maintenancestrategies) +* **MaxTotalPrice**: string +* **MinTargetCapacity**: int +* **SingleAvailabilityZone**: bool +* **SingleInstanceType**: bool -## MemoryMiBRequest +## SpotPlacement ### Properties -* **Max**: int -* **Min**: int +* **AvailabilityZone**: string +* **GroupName**: string +* **Tenancy**: string -## NetworkBandwidthGbpsRequest +## SseSpecification ### Properties -* **Max**: int -* **Min**: int +* **CustomerManagedKeyEnabled**: bool: Whether to encrypt the policy with the provided key or disable encryption +* **KmsKeyArn**: string: KMS Key Arn used to encrypt the group policy -## NetworkInterfaceCountRequest +## SseSpecification ### Properties -* **Max**: int -* **Min**: int +* **CustomerManagedKeyEnabled**: bool: Whether to encrypt the policy with the provided key or disable encryption +* **KmsKeyArn**: string: KMS Key Arn used to encrypt the group policy -## TotalLocalStorageGBRequest +## SsmAssociation ### Properties -* **Max**: int -* **Min**: int +* **AssociationParameters**: [AssociationParameter](#associationparameter)[]: The input parameter values to use with the associated SSM document. +* **DocumentName**: string (Required): The name of an SSM document to associate with the instance. -## VCpuCountRangeRequest +## Subnet_PrivateDnsNameOptionsOnLaunch ### Properties -* **Max**: int -* **Min**: int +* **EnableResourceNameDnsAAAARecord**: bool +* **EnableResourceNameDnsARecord**: bool +* **HostnameType**: string -## SpotFleetMonitoring +## Tag ### Properties -* **Enabled**: bool +* **Key**: string (Required) +* **Value**: string (Required) -## InstanceNetworkInterfaceSpecification +## Tag ### Properties -* **AssociatePublicIpAddress**: bool -* **DeleteOnTermination**: bool -* **Description**: string -* **DeviceIndex**: int -* **Groups**: string[] -* **Ipv6AddressCount**: int -* **Ipv6Addresses**: [InstanceIpv6Address](#instanceipv6address)[] -* **NetworkInterfaceId**: string -* **PrivateIpAddresses**: [PrivateIpAddressSpecification](#privateipaddressspecification)[] -* **SecondaryPrivateIpAddressCount**: int -* **SubnetId**: string +* **Key**: string (Required) +* **Value**: string (Required) -## InstanceIpv6Address +## Tag ### Properties -* **Ipv6Address**: string (Required) +* **Key**: string +* **Value**: string -## PrivateIpAddressSpecification +## Tag ### Properties -* **Primary**: bool -* **PrivateIpAddress**: string (Required) +* **Key**: string (Required): The tag key. +* **Value**: string (Required): The tag value. -## SpotPlacement +## Tag ### Properties -* **AvailabilityZone**: string -* **GroupName**: string -* **Tenancy**: string +* **Key**: string (Required) +* **Value**: string (Required) -## GroupIdentifier +## Tag ### Properties -* **GroupId**: string (Required) +* **Key**: string (Required) +* **Value**: string (Required) -## SpotFleetTagSpecification +## Tag ### Properties -* **ResourceType**: string -* **Tags**: [Tag](#tag)[] +* **Key**: string (Required): The tag key. +* **Value**: string (Required): The tag value. ## Tag ### Properties * **Key**: string (Required) * **Value**: string (Required) -## LaunchTemplateConfig +## Tag ### Properties -* **LaunchTemplateSpecification**: [FleetLaunchTemplateSpecification](#fleetlaunchtemplatespecification) -* **Overrides**: [LaunchTemplateOverrides](#launchtemplateoverrides)[] +* **Key**: string (Required) +* **Value**: string (Required) -## FleetLaunchTemplateSpecification +## Tag ### Properties -* **LaunchTemplateId**: string -* **LaunchTemplateName**: string -* **Version**: string (Required) +* **Key**: string (Required) +* **Value**: string (Required) -## LaunchTemplateOverrides +## Tag ### Properties -* **AvailabilityZone**: string -* **InstanceRequirements**: [InstanceRequirementsRequest](#instancerequirementsrequest) -* **InstanceType**: string -* **Priority**: int -* **SpotPrice**: string -* **SubnetId**: string -* **WeightedCapacity**: int +* **Key**: string (Required): The tag key. +* **Value**: string (Required): The tag value. -## LoadBalancersConfig +## Tag ### Properties -* **ClassicLoadBalancersConfig**: [ClassicLoadBalancersConfig](#classicloadbalancersconfig) -* **TargetGroupsConfig**: [TargetGroupsConfig](#targetgroupsconfig) +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -## ClassicLoadBalancersConfig +## Tag ### Properties -* **ClassicLoadBalancers**: [ClassicLoadBalancer](#classicloadbalancer)[] (Required) +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -## ClassicLoadBalancer +## Tag ### Properties -* **Name**: string (Required) +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -## TargetGroupsConfig +## Tag ### Properties -* **TargetGroups**: [TargetGroup](#targetgroup)[] (Required) +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -## TargetGroup +## Tag ### Properties -* **Arn**: string (Required) +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -## SpotMaintenanceStrategies +## Tag ### Properties -* **CapacityRebalance**: [SpotCapacityRebalance](#spotcapacityrebalance) +* **Key**: string (Required): The tag key. +* **Value**: string (Required): The tag value. -## SpotCapacityRebalance +## Tag ### Properties -* **ReplacementStrategy**: string -* **TerminationDelay**: int +* **Key**: string +* **Value**: string -## AWS.EC2/SubnetProperties +## Tag ### Properties -* **AssignIpv6AddressOnCreation**: bool -* **AvailabilityZone**: string -* **AvailabilityZoneId**: string -* **CidrBlock**: string -* **EnableDns64**: bool -* **Ipv4IpamPoolId**: string (WriteOnly): The ID of an IPv4 IPAM pool you want to use for allocating this subnet's CIDR -* **Ipv4NetmaskLength**: int (WriteOnly): The netmask length of the IPv4 CIDR you want to allocate to this subnet from an Amazon VPC IP Address Manager (IPAM) pool -* **Ipv6CidrBlock**: string -* **Ipv6CidrBlocks**: string[] -* **Ipv6IpamPoolId**: string (WriteOnly): The ID of an IPv6 IPAM pool you want to use for allocating this subnet's CIDR -* **Ipv6Native**: bool -* **Ipv6NetmaskLength**: int (WriteOnly): The netmask length of the IPv6 CIDR you want to allocate to this subnet from an Amazon VPC IP Address Manager (IPAM) pool -* **MapPublicIpOnLaunch**: bool -* **NetworkAclAssociationId**: string (ReadOnly) -* **OutpostArn**: string -* **PrivateDnsNameOptionsOnLaunch**: [Subnet_PrivateDnsNameOptionsOnLaunch](#subnetprivatednsnameoptionsonlaunch) -* **SubnetId**: string (ReadOnly, Identifier) -* **Tags**: [Tag](#tag)[] -* **VpcId**: string (Required) +* **Key**: string +* **Value**: string -## Subnet_PrivateDnsNameOptionsOnLaunch +## Tag ### Properties -* **EnableResourceNameDnsAAAARecord**: bool -* **EnableResourceNameDnsARecord**: bool -* **HostnameType**: string +* **Key**: string +* **Value**: string ## Tag ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **Key**: string (Required): The tag key. +* **Value**: string (Required): The tag value. -## AWS.EC2/TransitGatewayProperties +## Tag ### Properties -* **AmazonSideAsn**: int -* **AssociationDefaultRouteTableId**: string -* **AutoAcceptSharedAttachments**: string -* **DefaultRouteTableAssociation**: string -* **DefaultRouteTablePropagation**: string -* **Description**: string -* **DnsSupport**: string -* **Id**: string (ReadOnly, Identifier) -* **MulticastSupport**: string -* **PropagationDefaultRouteTableId**: string -* **Tags**: [Tag](#tag)[] -* **TransitGatewayArn**: string (ReadOnly) -* **TransitGatewayCidrBlocks**: string[] -* **VpnEcmpSupport**: string +* **Key**: string (Required): The tag key. +* **Value**: string (Required): The tag value. ## Tag ### Properties * **Key**: string (Required) -* **Value**: string (Required) +* **Value**: string -## AWS.EC2/TransitGatewayAttachmentProperties +## Tag ### Properties -* **Id**: string (ReadOnly, Identifier) -* **Options**: [TransitGatewayAttachment_Options](#transitgatewayattachmentoptions): The options for the transit gateway vpc attachment. -* **SubnetIds**: string[] (Required) -* **Tags**: [Tag](#tag)[] -* **TransitGatewayId**: string (Required) -* **VpcId**: string (Required) +* **Key**: string (Required) +* **Value**: string -## TransitGatewayAttachment_Options +## Tag ### Properties -* **ApplianceModeSupport**: string: Indicates whether to enable Ipv6 Support for Vpc Attachment. Valid Values: enable | disable -* **DnsSupport**: string: Indicates whether to enable DNS Support for Vpc Attachment. Valid Values: enable | disable -* **Ipv6Support**: string: Indicates whether to enable Ipv6 Support for Vpc Attachment. Valid Values: enable | disable +* **Key**: string (Required) +* **Value**: string ## Tag ### Properties * **Key**: string (Required) -* **Value**: string (Required) +* **Value**: string -## AWS.EC2/TransitGatewayConnectProperties +## Tag ### Properties -* **CreationTime**: string (ReadOnly): The creation time. -* **Options**: [TransitGatewayConnectOptions](#transitgatewayconnectoptions) (Required): The Connect attachment options. -* **State**: string (ReadOnly): The state of the attachment. -* **Tags**: [Tag](#tag)[]: The tags for the attachment. -* **TransitGatewayAttachmentId**: string (ReadOnly, Identifier): The ID of the Connect attachment. -* **TransitGatewayId**: string (ReadOnly): The ID of the transit gateway. -* **TransportTransitGatewayAttachmentId**: string (Required): The ID of the attachment from which the Connect attachment was created. +* **Key**: string (Required) +* **Value**: string (Required) -## TransitGatewayConnectOptions +## Tag ### Properties -* **Protocol**: string: The tunnel protocol. +* **Key**: string (Required) +* **Value**: string ## Tag ### Properties -* **Key**: string: The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:. -* **Value**: string: The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters. +* **Key**: string (Required): The tag key. +* **Value**: string (Required): The tag value. -## AWS.EC2/TransitGatewayMulticastDomainProperties +## Tag ### Properties -* **CreationTime**: string (ReadOnly): The time the transit gateway multicast domain was created. -* **Options**: [TransitGatewayMulticastDomain_Options](#transitgatewaymulticastdomainoptions): The options for the transit gateway multicast domain. -* **State**: string (ReadOnly): The state of the transit gateway multicast domain. -* **Tags**: [Tag](#tag)[]: The tags for the transit gateway multicast domain. -* **TransitGatewayId**: string (Required): The ID of the transit gateway. -* **TransitGatewayMulticastDomainArn**: string (ReadOnly): The Amazon Resource Name (ARN) of the transit gateway multicast domain. -* **TransitGatewayMulticastDomainId**: string (ReadOnly, Identifier): The ID of the transit gateway multicast domain. +* **Key**: string (Required) +* **Value**: string (Required) -## TransitGatewayMulticastDomain_Options +## Tag ### Properties -* **AutoAcceptSharedAssociations**: string: Indicates whether to automatically cross-account subnet associations that are associated with the transit gateway multicast domain. Valid Values: enable | disable -* **Igmpv2Support**: string: Indicates whether Internet Group Management Protocol (IGMP) version 2 is turned on for the transit gateway multicast domain. Valid Values: enable | disable -* **StaticSourcesSupport**: string: Indicates whether support for statically configuring transit gateway multicast group sources is turned on. Valid Values: enable | disable +* **Key**: string (Required) +* **Value**: string (Required) ## Tag ### Properties -* **Key**: string: The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:. -* **Value**: string: The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters. +* **Key**: string (Required): The tag key. +* **Value**: string (Required): The tag value. -## AWS.EC2/TransitGatewayPeeringAttachmentProperties +## Tag ### Properties -* **CreationTime**: string (ReadOnly): The time the transit gateway peering attachment was created. -* **PeerAccountId**: string (Required): The ID of the peer account -* **PeerRegion**: string (Required): Peer Region -* **PeerTransitGatewayId**: string (Required): The ID of the peer transit gateway. -* **State**: string (ReadOnly): The state of the transit gateway peering attachment. Note that the initiating state has been deprecated. -* **Status**: [PeeringAttachmentStatus](#peeringattachmentstatus) (ReadOnly): The status of the transit gateway peering attachment. -* **Tags**: [Tag](#tag)[]: The tags for the transit gateway peering attachment. -* **TransitGatewayAttachmentId**: string (ReadOnly, Identifier): The ID of the transit gateway peering attachment. -* **TransitGatewayId**: string (Required): The ID of the transit gateway. +* **Key**: string (Required) +* **Value**: string (Required) -## PeeringAttachmentStatus +## Tag ### Properties -* **Code**: string: The status code. -* **Message**: string: The status message, if applicable. +* **Key**: string (Required) +* **Value**: string (Required) ## Tag ### Properties * **Key**: string: The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:. * **Value**: string: The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters. -## AWS.EC2/TransitGatewayVpcAttachmentProperties +## Tag ### Properties -* **AddSubnetIds**: string[] (WriteOnly) -* **Id**: string (ReadOnly, Identifier) -* **Options**: [TransitGatewayVpcAttachment_Options](#transitgatewayvpcattachmentoptions): The options for the transit gateway vpc attachment. -* **RemoveSubnetIds**: string[] (WriteOnly) -* **SubnetIds**: string[] (Required) -* **Tags**: [Tag](#tag)[] -* **TransitGatewayId**: string (Required) -* **VpcId**: string (Required) +* **Key**: string: The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:. +* **Value**: string: The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters. -## TransitGatewayVpcAttachment_Options +## Tag ### Properties -* **ApplianceModeSupport**: string: Indicates whether to enable Ipv6 Support for Vpc Attachment. Valid Values: enable | disable -* **DnsSupport**: string: Indicates whether to enable DNS Support for Vpc Attachment. Valid Values: enable | disable -* **Ipv6Support**: string: Indicates whether to enable Ipv6 Support for Vpc Attachment. Valid Values: enable | disable +* **Key**: string: The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:. +* **Value**: string: The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters. ## Tag ### Properties * **Key**: string (Required) * **Value**: string (Required) -## AWS.EC2/VerifiedAccessEndpointProperties -### Properties -* **ApplicationDomain**: string (Required): The DNS name for users to reach your application. -* **AttachmentType**: string (Required): The type of attachment used to provide connectivity between the AWS Verified Access endpoint and the application. -* **CreationTime**: string (ReadOnly): The creation time. -* **Description**: string: A description for the AWS Verified Access endpoint. -* **DeviceValidationDomain**: string (ReadOnly): Returned if endpoint has a device trust provider attached. -* **DomainCertificateArn**: string (Required): The ARN of a public TLS/SSL certificate imported into or created with ACM. -* **EndpointDomain**: string (ReadOnly): A DNS name that is generated for the endpoint. -* **EndpointDomainPrefix**: string (Required): A custom identifier that gets prepended to a DNS name that is generated for the endpoint. -* **EndpointType**: string (Required): The type of AWS Verified Access endpoint. Incoming application requests will be sent to an IP address, load balancer or a network interface depending on the endpoint type specified.The type of AWS Verified Access endpoint. Incoming application requests will be sent to an IP address, load balancer or a network interface depending on the endpoint type specified. -* **LastUpdatedTime**: string (ReadOnly): The last updated time. -* **LoadBalancerOptions**: [LoadBalancerOptions](#loadbalanceroptions): The load balancer details if creating the AWS Verified Access endpoint as load-balancer type. -* **NetworkInterfaceOptions**: [NetworkInterfaceOptions](#networkinterfaceoptions): The options for network-interface type endpoint. -* **PolicyDocument**: string: The AWS Verified Access policy document. -* **PolicyEnabled**: bool: The status of the Verified Access policy. -* **SecurityGroupIds**: string[]: The IDs of the security groups for the endpoint. -* **SseSpecification**: [SseSpecification](#ssespecification): The configuration options for customer provided KMS encryption. -* **Status**: string (ReadOnly): The endpoint status. -* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. -* **VerifiedAccessEndpointId**: string (ReadOnly, Identifier): The ID of the AWS Verified Access endpoint. -* **VerifiedAccessGroupId**: string (Required): The ID of the AWS Verified Access group. -* **VerifiedAccessInstanceId**: string (ReadOnly): The ID of the AWS Verified Access instance. - -## LoadBalancerOptions +## Tag ### Properties -* **LoadBalancerArn**: string: The ARN of the load balancer. -* **Port**: int: The IP port number. -* **Protocol**: string: The IP protocol. -* **SubnetIds**: string[]: The IDs of the subnets. +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -## NetworkInterfaceOptions +## Tag ### Properties -* **NetworkInterfaceId**: string: The ID of the network interface. -* **Port**: int: The IP port number. -* **Protocol**: string: The IP protocol. +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -## SseSpecification +## Tag ### Properties -* **CustomerManagedKeyEnabled**: bool: Whether to encrypt the policy with the provided key or disable encryption -* **KmsKeyArn**: string: KMS Key Arn used to encrypt the group policy +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ## Tag ### Properties * **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. * **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -## AWS.EC2/VerifiedAccessGroupProperties +## Tag ### Properties -* **CreationTime**: string (ReadOnly): Time this Verified Access Group was created. -* **Description**: string: A description for the AWS Verified Access group. -* **LastUpdatedTime**: string (ReadOnly): Time this Verified Access Group was last updated. -* **Owner**: string (ReadOnly): The AWS account number that owns the group. -* **PolicyDocument**: string: The AWS Verified Access policy document. -* **PolicyEnabled**: bool: The status of the Verified Access policy. -* **SseSpecification**: [SseSpecification](#ssespecification): The configuration options for customer provided KMS encryption. -* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. -* **VerifiedAccessGroupArn**: string (ReadOnly): The ARN of the Verified Access group. -* **VerifiedAccessGroupId**: string (ReadOnly, Identifier): The ID of the AWS Verified Access group. -* **VerifiedAccessInstanceId**: string (Required): The ID of the AWS Verified Access instance. +* **Key**: string (Required): The tag key. +* **Value**: string (Required): The tag value. -## SseSpecification +## Tag ### Properties -* **CustomerManagedKeyEnabled**: bool: Whether to encrypt the policy with the provided key or disable encryption -* **KmsKeyArn**: string: KMS Key Arn used to encrypt the group policy +* **Key**: string (Required): The tag key. +* **Value**: string (Required): The tag value. ## Tag ### Properties * **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. * **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -## AWS.EC2/VerifiedAccessInstanceProperties +## Tag ### Properties -* **CreationTime**: string (ReadOnly): Time this Verified Access Instance was created. -* **Description**: string: A description for the AWS Verified Access instance. -* **FipsEnabled**: bool: Indicates whether FIPS is enabled -* **LastUpdatedTime**: string (ReadOnly): Time this Verified Access Instance was last updated. -* **LoggingConfigurations**: [VerifiedAccessLogs](#verifiedaccesslogs): The configuration options for AWS Verified Access instances. -* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. -* **VerifiedAccessInstanceId**: string (ReadOnly, Identifier): The ID of the AWS Verified Access instance. -* **VerifiedAccessTrustProviderIds**: string[]: The IDs of the AWS Verified Access trust providers. -* **VerifiedAccessTrustProviders**: [VerifiedAccessTrustProvider](#verifiedaccesstrustprovider)[]: AWS Verified Access trust providers. +* **Key**: string (Required) +* **Value**: string (Required) -## VerifiedAccessLogs +## Tag ### Properties -* **CloudWatchLogs**: [VerifiedAccessInstance_CloudWatchLogs](#verifiedaccessinstancecloudwatchlogs): Sends Verified Access logs to CloudWatch Logs. -* **IncludeTrustContext**: bool: Include claims from trust providers in Verified Access logs. -* **KinesisDataFirehose**: [VerifiedAccessInstance_KinesisDataFirehose](#verifiedaccessinstancekinesisdatafirehose): Sends Verified Access logs to Kinesis. -* **LogVersion**: string: Select log version for Verified Access logs. -* **S3**: [VerifiedAccessInstance_S3](#verifiedaccessinstances3): Sends Verified Access logs to Amazon S3. +* **Key**: string (Required): The tag key. +* **Value**: string (Required): The tag value. -## VerifiedAccessInstance_CloudWatchLogs +## TagSpecification ### Properties -* **Enabled**: bool: Indicates whether logging is enabled. -* **LogGroup**: string: The ID of the CloudWatch Logs log group. +* **ResourceType**: string +* **Tags**: [Tag](#tag)[] -## VerifiedAccessInstance_KinesisDataFirehose +## TagSpecification ### Properties -* **DeliveryStream**: string: The ID of the delivery stream. -* **Enabled**: bool: Indicates whether logging is enabled. +* **ResourceType**: string +* **Tags**: [Tag](#tag)[] -## VerifiedAccessInstance_S3 +## TagSpecification ### Properties -* **BucketName**: string: The bucket name. -* **BucketOwner**: string: The ID of the AWS account that owns the Amazon S3 bucket. -* **Enabled**: bool: Indicates whether logging is enabled. -* **Prefix**: string: The bucket prefix. +* **ResourceType**: string +* **Tags**: [Tag](#tag)[] -## Tag +## TagSpecification ### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **ResourceType**: string: The type of resource to tag. + Valid Values lists all resource types for Amazon EC2 that can be tagged. When you create a launch template, you can specify tags for the following resource types only: ``instance`` | ``volume`` | ``network-interface`` | ``spot-instances-request``. If the instance does not include the resource type that you specify, the instance launch fails. For example, not all instance types include a volume. + To tag a resource after it has been created, see [CreateTags](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html). +* **Tags**: [Tag](#tag)[]: The tags to apply to the resource. -## VerifiedAccessTrustProvider +## TargetCapacitySpecificationRequest ### Properties -* **Description**: string: The description of trust provider. -* **DeviceTrustProviderType**: string: The type of device-based trust provider. -* **TrustProviderType**: string: The type of trust provider (user- or device-based). -* **UserTrustProviderType**: string: The type of user-based trust provider. -* **VerifiedAccessTrustProviderId**: string: The ID of the trust provider. +* **DefaultTargetCapacityType**: string +* **OnDemandTargetCapacity**: int +* **SpotTargetCapacity**: int +* **TargetCapacityUnitType**: string +* **TotalTargetCapacity**: int (Required) -## AWS.EC2/VerifiedAccessTrustProviderProperties +## TargetGroup ### Properties -* **CreationTime**: string (ReadOnly): The creation time. -* **Description**: string: A description for the Amazon Web Services Verified Access trust provider. -* **DeviceOptions**: [DeviceOptions](#deviceoptions) -* **DeviceTrustProviderType**: string: The type of device-based trust provider. Possible values: jamf|crowdstrike -* **LastUpdatedTime**: string (ReadOnly): The last updated time. -* **OidcOptions**: [OidcOptions](#oidcoptions) -* **PolicyReferenceName**: string (Required): The identifier to be used when working with policy rules. -* **SseSpecification**: [VerifiedAccessTrustProvider_SseSpecification](#verifiedaccesstrustproviderssespecification): The configuration options for customer provided KMS encryption. -* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. -* **TrustProviderType**: string (Required): Type of trust provider. Possible values: user|device -* **UserTrustProviderType**: string: The type of device-based trust provider. Possible values: oidc|iam-identity-center -* **VerifiedAccessTrustProviderId**: string (ReadOnly, Identifier): The ID of the Amazon Web Services Verified Access trust provider. +* **Arn**: string (Required) -## DeviceOptions +## TargetGroupsConfig ### Properties -* **PublicSigningKeyUrl**: string: URL Verified Access will use to verify authenticity of the device tokens. -* **TenantId**: string: The ID of the tenant application with the device-identity provider. +* **TargetGroups**: [TargetGroup](#targetgroup)[] (Required) -## OidcOptions +## ThroughResourcesStatementRequest ### Properties -* **AuthorizationEndpoint**: string: The OIDC authorization endpoint. -* **ClientId**: string: The client identifier. -* **ClientSecret**: string: The client secret. -* **Issuer**: string: The OIDC issuer. -* **Scope**: string: OpenID Connect (OIDC) scopes are used by an application during authentication to authorize access to details of a user. Each scope returns a specific set of user attributes. -* **TokenEndpoint**: string: The OIDC token endpoint. -* **UserInfoEndpoint**: string: The OIDC user info endpoint. +* **ResourceStatement**: [ResourceStatementRequest](#resourcestatementrequest) -## VerifiedAccessTrustProvider_SseSpecification +## TotalLocalStorageGB ### Properties -* **CustomerManagedKeyEnabled**: bool: Whether to encrypt the policy with the provided key or disable encryption -* **KmsKeyArn**: string: KMS Key Arn used to encrypt the group policy +* **Max**: int: The maximum amount of total local storage, in GB. To specify no maximum limit, omit this parameter. +* **Min**: int: The minimum amount of total local storage, in GB. To specify no minimum limit, omit this parameter. -## Tag +## TotalLocalStorageGBRequest ### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Max**: int +* **Min**: int -## AWS.EC2/VolumeProperties +## TotalLocalStorageGBRequest ### Properties -* **AutoEnableIO**: bool: The Availability Zone in which to create the volume. -* **AvailabilityZone**: string (Required): The Availability Zone in which to create the volume. -* **Encrypted**: bool: Specifies whether the volume should be encrypted. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Encryption by default in the Amazon Elastic Compute Cloud User Guide. Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types. -* **Iops**: int: The number of I/O operations per second (IOPS) to provision for an io1 or io2 volume, with a maximum ratio of 50 IOPS/GiB for io1, and 500 IOPS/GiB for io2. Range is 100 to 64,000 IOPS for volumes in most Regions. Maximum IOPS of 64,000 is guaranteed only on Nitro-based instances. Other instance families guarantee performance up to 32,000 IOPS. For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide. This parameter is valid only for Provisioned IOPS SSD (io1 and io2) volumes. -* **KmsKeyId**: string: The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption. If KmsKeyId is specified, the encrypted state must be true. If you omit this property and your account is enabled for encryption by default, or Encrypted is set to true, then the volume is encrypted using the default CMK specified for your account. If your account does not have a default CMK, then the volume is encrypted using the AWS managed CMK. Alternatively, if you want to specify a different CMK, you can specify one of the following: Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab. Key alias. Specify the alias for the CMK, prefixed with alias/. For example, for a CMK with the alias my_cmk, use alias/my_cmk. Or to specify the AWS managed CMK, use alias/aws/ebs. Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab. Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias. -* **MultiAttachEnabled**: bool: Indicates whether Amazon EBS Multi-Attach is enabled. -* **OutpostArn**: string: The Amazon Resource Name (ARN) of the Outpost. -* **Size**: int: The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. Constraints: 1-16,384 for gp2, 4-16,384 for io1 and io2, 500-16,384 for st1, 500-16,384 for sc1, and 1-1,024 for standard. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size. Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size. -* **SnapshotId**: string: The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size. -* **Tags**: [Tag](#tag)[]: The tags to apply to the volume during creation. -* **Throughput**: int: The throughput that the volume supports, in MiB/s. -* **VolumeId**: string (ReadOnly, Identifier) -* **VolumeType**: string: The volume type. This parameter can be one of the following values: General Purpose SSD: gp2 | gp3, Provisioned IOPS SSD: io1 | io2, Throughput Optimized HDD: st1, Cold HDD: sc1, Magnetic: standard +* **Max**: int +* **Min**: int -## Tag +## TransitGatewayAttachment_Options ### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **ApplianceModeSupport**: string: Indicates whether to enable Ipv6 Support for Vpc Attachment. Valid Values: enable | disable +* **DnsSupport**: string: Indicates whether to enable DNS Support for Vpc Attachment. Valid Values: enable | disable +* **Ipv6Support**: string: Indicates whether to enable Ipv6 Support for Vpc Attachment. Valid Values: enable | disable -## AWS.EC2/VPCProperties +## TransitGatewayConnectOptions ### Properties -* **CidrBlock**: string: The primary IPv4 CIDR block for the VPC. -* **CidrBlockAssociations**: string[] (ReadOnly): A list of IPv4 CIDR block association IDs for the VPC. -* **DefaultNetworkAcl**: string (ReadOnly): The default network ACL ID that is associated with the VPC. -* **DefaultSecurityGroup**: string (ReadOnly): The default security group ID that is associated with the VPC. -* **EnableDnsHostnames**: bool: Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not. Disabled by default for nondefault VPCs. -* **EnableDnsSupport**: bool: Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range "plus two" succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled. Enabled by default. -* **InstanceTenancy**: string: The allowed tenancy of instances launched into the VPC. - -"default": An instance launched into the VPC runs on shared hardware by default, unless you explicitly specify a different tenancy during instance launch. +* **Protocol**: string: The tunnel protocol. -"dedicated": An instance launched into the VPC is a Dedicated Instance by default, unless you explicitly specify a tenancy of host during instance launch. You cannot specify a tenancy of default during instance launch. +## TransitGatewayMulticastDomain_Options +### Properties +* **AutoAcceptSharedAssociations**: string: Indicates whether to automatically cross-account subnet associations that are associated with the transit gateway multicast domain. Valid Values: enable | disable +* **Igmpv2Support**: string: Indicates whether Internet Group Management Protocol (IGMP) version 2 is turned on for the transit gateway multicast domain. Valid Values: enable | disable +* **StaticSourcesSupport**: string: Indicates whether support for statically configuring transit gateway multicast group sources is turned on. Valid Values: enable | disable -Updating InstanceTenancy requires no replacement only if you are updating its value from "dedicated" to "default". Updating InstanceTenancy from "default" to "dedicated" requires replacement. -* **Ipv4IpamPoolId**: string (WriteOnly): The ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR -* **Ipv4NetmaskLength**: int (WriteOnly): The netmask length of the IPv4 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool -* **Ipv6CidrBlocks**: string[] (ReadOnly): A list of IPv6 CIDR blocks that are associated with the VPC. -* **Tags**: [Tag](#tag)[]: The tags for the VPC. -* **VpcId**: string (ReadOnly, Identifier): The Id for the model. +## TransitGatewayRouteTableRoute +### Properties +* **AttachmentId**: string +* **DestinationCidr**: string +* **PrefixListId**: string +* **ResourceId**: string +* **ResourceType**: string +* **RouteOrigin**: string +* **State**: string -## Tag +## TransitGatewayVpcAttachment_Options ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **ApplianceModeSupport**: string: Indicates whether to enable Ipv6 Support for Vpc Attachment. Valid Values: enable | disable +* **DnsSupport**: string: Indicates whether to enable DNS Support for Vpc Attachment. Valid Values: enable | disable +* **Ipv6Support**: string: Indicates whether to enable Ipv6 Support for Vpc Attachment. Valid Values: enable | disable -## AWS.EC2/VPCDHCPOptionsAssociationProperties +## VCpuCount ### Properties -* **DhcpOptionsId**: string (Required, Identifier): The ID of the DHCP options set, or default to associate no DHCP options with the VPC. -* **VpcId**: string (Required, Identifier): The ID of the VPC. +* **Max**: int: The maximum number of vCPUs. To specify no maximum limit, omit this parameter. +* **Min**: int: The minimum number of vCPUs. To specify no minimum limit, specify ``0``. -## AWS.EC2/VPCEndpointProperties +## VCpuCountRangeRequest ### Properties -* **CreationTimestamp**: string (ReadOnly) -* **DnsEntries**: string[] (ReadOnly) -* **Id**: string (ReadOnly, Identifier) -* **NetworkInterfaceIds**: string[] (ReadOnly) -* **PolicyDocument**: [VPCEndpoint_PolicyDocument](#vpcendpointpolicydocument) | string: A policy to attach to the endpoint that controls access to the service. -* **PrivateDnsEnabled**: bool: Indicate whether to associate a private hosted zone with the specified VPC. -* **RouteTableIds**: string[]: One or more route table IDs. -* **SecurityGroupIds**: string[]: The ID of one or more security groups to associate with the endpoint network interface. -* **ServiceName**: string (Required): The service name. -* **SubnetIds**: string[]: The ID of one or more subnets in which to create an endpoint network interface. -* **VpcEndpointType**: string -* **VpcId**: string (Required): The ID of the VPC in which the endpoint will be used. +* **Max**: int +* **Min**: int -## AWS.EC2/VPCEndpointConnectionNotificationProperties +## VCpuCountRangeRequest ### Properties -* **ConnectionEvents**: string[] (Required): The endpoint events for which to receive notifications. -* **ConnectionNotificationArn**: string (Required): The ARN of the SNS topic for the notifications. -* **ServiceId**: string: The ID of the endpoint service. -* **VPCEndpointConnectionNotificationId**: string (ReadOnly, Identifier): VPC Endpoint Connection ID generated by service -* **VPCEndpointId**: string: The ID of the endpoint. +* **Max**: int +* **Min**: int -## AWS.EC2/VPCEndpointServiceProperties +## VerifiedAccessInstance_CloudWatchLogs ### Properties -* **AcceptanceRequired**: bool -* **ContributorInsightsEnabled**: bool (WriteOnly) -* **GatewayLoadBalancerArns**: string[] -* **NetworkLoadBalancerArns**: string[] -* **PayerResponsibility**: string -* **ServiceId**: string (ReadOnly, Identifier) +* **Enabled**: bool: Indicates whether logging is enabled. +* **LogGroup**: string: The ID of the CloudWatch Logs log group. -## AWS.EC2/VPCEndpointServicePermissionsProperties +## VerifiedAccessInstance_KinesisDataFirehose ### Properties -* **AllowedPrincipals**: string[] -* **ServiceId**: string (Required, Identifier) +* **DeliveryStream**: string: The ID of the delivery stream. +* **Enabled**: bool: Indicates whether logging is enabled. -## AWS.EC2/VPCGatewayAttachmentProperties +## VerifiedAccessInstance_S3 ### Properties -* **AttachmentType**: string (ReadOnly, Identifier): Used to identify if this resource is an Internet Gateway or Vpn Gateway Attachment -* **InternetGatewayId**: string: The ID of the internet gateway. You must specify either InternetGatewayId or VpnGatewayId, but not both. -* **VpcId**: string (Required, Identifier): The ID of the VPC. -* **VpnGatewayId**: string: The ID of the virtual private gateway. You must specify either InternetGatewayId or VpnGatewayId, but not both. +* **BucketName**: string: The bucket name. +* **BucketOwner**: string: The ID of the AWS account that owns the Amazon S3 bucket. +* **Enabled**: bool: Indicates whether logging is enabled. +* **Prefix**: string: The bucket prefix. -## AWS.EC2/VPCPeeringConnectionProperties +## VerifiedAccessLogs ### Properties -* **Id**: string (ReadOnly, Identifier) -* **PeerOwnerId**: string: The AWS account ID of the owner of the accepter VPC. -* **PeerRegion**: string: The Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request. -* **PeerRoleArn**: string (WriteOnly): The Amazon Resource Name (ARN) of the VPC peer role for the peering connection in another AWS account. -* **PeerVpcId**: string (Required): The ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request. -* **Tags**: [Tag](#tag)[] -* **VpcId**: string (Required): The ID of the VPC. +* **CloudWatchLogs**: [VerifiedAccessInstance_CloudWatchLogs](#verifiedaccessinstancecloudwatchlogs): Sends Verified Access logs to CloudWatch Logs. +* **IncludeTrustContext**: bool: Include claims from trust providers in Verified Access logs. +* **KinesisDataFirehose**: [VerifiedAccessInstance_KinesisDataFirehose](#verifiedaccessinstancekinesisdatafirehose): Sends Verified Access logs to Kinesis. +* **LogVersion**: string: Select log version for Verified Access logs. +* **S3**: [VerifiedAccessInstance_S3](#verifiedaccessinstances3): Sends Verified Access logs to Amazon S3. -## Tag +## VerifiedAccessTrustProvider ### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Description**: string: The description of trust provider. +* **DeviceTrustProviderType**: string: The type of device-based trust provider. +* **TrustProviderType**: string: The type of trust provider (user- or device-based). +* **UserTrustProviderType**: string: The type of user-based trust provider. +* **VerifiedAccessTrustProviderId**: string: The ID of the trust provider. -## AWS.EC2/VPNConnectionProperties +## VerifiedAccessTrustProvider_SseSpecification ### Properties -* **CustomerGatewayId**: string (Required): The ID of the customer gateway at your end of the VPN connection. -* **StaticRoutesOnly**: bool: Indicates whether the VPN connection uses static routes only. -* **Tags**: [Tag](#tag)[]: Any tags assigned to the VPN connection. -* **TransitGatewayId**: string: The ID of the transit gateway associated with the VPN connection. -* **Type**: string (Required): The type of VPN connection. -* **VpnConnectionId**: string (ReadOnly, Identifier): The provider-assigned unique ID for this managed resource -* **VpnGatewayId**: string: The ID of the virtual private gateway at the AWS side of the VPN connection. -* **VpnTunnelOptionsSpecifications**: [VpnTunnelOptionsSpecification](#vpntunneloptionsspecification)[]: The tunnel options for the VPN connection. +* **CustomerManagedKeyEnabled**: bool: Whether to encrypt the policy with the provided key or disable encryption +* **KmsKeyArn**: string: KMS Key Arn used to encrypt the group policy -## Tag +## Volume ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **Device**: string (Required): The device name (for example, /dev/sdh or xvdh). +* **VolumeId**: string (Required): The ID of the EBS volume. The volume and instance must be within the same Availability Zone. ## VpnTunnelOptionsSpecification ### Properties * **PreSharedKey**: string * **TunnelInsideCidr**: string -## AWS.EC2/VPNGatewayProperties -### Properties -* **AmazonSideAsn**: int: The private Autonomous System Number (ASN) for the Amazon side of a BGP session. -* **Tags**: [Tag](#tag)[]: Any tags assigned to the virtual private gateway. -* **Type**: string (Required): The type of VPN connection the virtual private gateway supports. -* **VPNGatewayId**: string (ReadOnly, Identifier): VPN Gateway ID generated by service - -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - diff --git a/artifacts/bicep/aws/aws.ecr/default/types.json b/artifacts/bicep/aws/aws.ecr/default/types.json index 9aa56e3c..9c711285 100644 --- a/artifacts/bicep/aws/aws.ecr/default/types.json +++ b/artifacts/bicep/aws/aws.ecr/default/types.json @@ -1 +1,800 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"CredentialArn"}},{"2":{"Name":"EcrRepositoryPrefix"}},{"2":{"Name":"PullThroughCacheRule","Properties":{"CredentialArn":{"Type":4,"Flags":0},"EcrRepositoryPrefix":{"Type":4,"Flags":17},"RegistryId":{"Type":4,"Flags":0},"UpstreamRegistry":{"Type":4,"Flags":0},"UpstreamRegistryUrl":{"Type":4,"Flags":1}}}},{"2":{"Name":"RegistryId"}},{"2":{"Name":"UpstreamRegistry"}},{"2":{"Name":"UpstreamRegistryUrl"}},{"2":{"Name":"AWS.ECR/PullThroughCacheRuleProperties","Properties":{"CredentialArn":{"Type":4,"Flags":4,"Description":"The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that identifies the credentials to authenticate to the upstream registry."},"EcrRepositoryPrefix":{"Type":4,"Flags":16,"Description":"The ECRRepositoryPrefix is a custom alias for upstream registry url."},"UpstreamRegistry":{"Type":4,"Flags":4,"Description":"The name of the upstream registry."},"UpstreamRegistryUrl":{"Type":4,"Flags":0,"Description":"The upstreamRegistryUrl is the endpoint of upstream registry url of the public repository to be cached"}}}},{"2":{"Name":"AWS.ECR/PullThroughCacheRule","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":14,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ECR/PullThroughCacheRule@default","ScopeType":0,"Body":15}},{"2":{"Name":"RegistryId"}},{"2":{"Name":"AWS.ECR/RegistryPolicyProperties","Properties":{"PolicyText":{"Type":19,"Flags":1,"Description":"The JSON policy text to apply to your registry. The policy text follows the same format as IAM policy text. For more information, see Registry permissions (https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry-permissions.html) in the Amazon Elastic Container Registry User Guide."},"RegistryId":{"Type":4,"Flags":18}}}},{"2":{"Name":"RegistryPolicy_PolicyText","Properties":{}}},{"2":{"Name":"AWS.ECR/RegistryPolicy","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":18,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ECR/RegistryPolicy@default","ScopeType":0,"Body":20}},{"2":{"Name":"Filter"}},{"2":{"Name":"FilterType"}},{"2":{"Name":"Region"}},{"2":{"Name":"RegistryId"}},{"2":{"Name":"ReplicationConfiguration","Properties":{"Rules":{"Type":30,"Flags":1,"Description":"An array of objects representing the replication rules for a replication configuration. A replication configuration may contain a maximum of 10 rules."}}}},{"2":{"Name":"ReplicationDestination","Properties":{"Region":{"Type":4,"Flags":1},"RegistryId":{"Type":4,"Flags":17}}}},{"2":{"Name":"ReplicationRule","Properties":{"Destinations":{"Type":31,"Flags":1,"Description":"An array of objects representing the details of a replication destination."},"RepositoryFilters":{"Type":32,"Flags":0,"Description":"An array of objects representing the details of a repository filter."}}}},{"2":{"Name":"RepositoryFilter","Properties":{"Filter":{"Type":4,"Flags":1},"FilterType":{"Type":4,"Flags":1}}}},{"3":{"ItemType":28}},{"3":{"ItemType":27}},{"3":{"ItemType":29}},{"2":{"Name":"AWS.ECR/ReplicationConfigurationProperties","Properties":{"RegistryId":{"Type":4,"Flags":18,"Description":"The RegistryId associated with the aws account."},"ReplicationConfiguration":{"Type":26,"Flags":1}}}},{"2":{"Name":"AWS.ECR/ReplicationConfiguration","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":33,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ECR/ReplicationConfiguration@default","ScopeType":0,"Body":34}},{"2":{"Name":"EmptyOnDelete"}},{"2":{"Name":"EncryptionConfiguration","Properties":{"EncryptionType":{"Type":4,"Flags":1},"KmsKey":{"Type":4,"Flags":0}}}},{"2":{"Name":"EncryptionType"}},{"2":{"Name":"ImageScanningConfiguration","Properties":{"ScanOnPush":{"Type":2,"Flags":0}}}},{"2":{"Name":"KmsKey"}},{"2":{"Name":"LifecyclePolicy","Properties":{"LifecyclePolicyText":{"Type":4,"Flags":0},"RegistryId":{"Type":4,"Flags":0}}}},{"2":{"Name":"LifecyclePolicyText"}},{"2":{"Name":"RegistryId"}},{"2":{"Name":"ScanOnPush"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}}}},{"2":{"Name":"AWS.ECR/RepositoryProperties","Properties":{"Arn":{"Type":4,"Flags":2},"EmptyOnDelete":{"Type":2,"Flags":4},"EncryptionConfiguration":{"Type":37,"Flags":0},"ImageScanningConfiguration":{"Type":39,"Flags":0},"ImageTagMutability":{"Type":4,"Flags":0,"Description":"The image tag mutability setting for the repository."},"LifecyclePolicy":{"Type":41,"Flags":0},"RepositoryName":{"Type":4,"Flags":16,"Description":"The name to use for the repository. The repository name may be specified on its own (such as nginx-web-app) or it can be prepended with a namespace to group the repository into a category (such as project-a/nginx-web-app). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the repository name. For more information, see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html."},"RepositoryPolicyText":{"Type":48,"Flags":0,"Description":"The JSON repository policy text to apply to the repository. For more information, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/RepositoryPolicyExamples.html in the Amazon Elastic Container Registry User Guide. "},"RepositoryUri":{"Type":4,"Flags":2},"Tags":{"Type":49,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."}}}},{"2":{"Name":"Repository_RepositoryPolicyText","Properties":{}}},{"5":{"Elements":[47,4]}},{"3":{"ItemType":45}},{"2":{"Name":"AWS.ECR/Repository","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":46,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ECR/Repository@default","ScopeType":0,"Body":50}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "CredentialArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "EcrRepositoryPrefix", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PullThroughCacheRule", + "properties": { + "CredentialArn": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "EcrRepositoryPrefix": { + "type": { + "$ref": "#/6" + }, + "flags": 17 + }, + "RegistryId": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "UpstreamRegistry": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "UpstreamRegistryUrl": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "RegistryId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "UpstreamRegistry", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "UpstreamRegistryUrl", + "properties": {} + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.ECR/PullThroughCacheRuleProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.ECR/PullThroughCacheRuleProperties", + "properties": { + "CredentialArn": { + "type": { + "$ref": "#/6" + }, + "flags": 4, + "description": "The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that identifies the credentials to authenticate to the upstream registry." + }, + "EcrRepositoryPrefix": { + "type": { + "$ref": "#/6" + }, + "flags": 16, + "description": "The ECRRepositoryPrefix is a custom alias for upstream registry url." + }, + "UpstreamRegistry": { + "type": { + "$ref": "#/6" + }, + "flags": 4, + "description": "The name of the upstream registry." + }, + "UpstreamRegistryUrl": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "The upstreamRegistryUrl is the endpoint of upstream registry url of the public repository to be cached" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ECR/PullThroughCacheRule", + "properties": { + "name": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/6" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/8" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ECR/PullThroughCacheRule@default", + "scopeType": 0, + "body": { + "$ref": "#/9" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "RegistryId", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.ECR/RegistryPolicyProperties" + }, + { + "$type": "ObjectType", + "name": "RegistryPolicy_PolicyText", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AWS.ECR/RegistryPolicyProperties", + "properties": { + "PolicyText": { + "type": { + "$ref": "#/13" + }, + "flags": 1, + "description": "The JSON policy text for your registry." + }, + "RegistryId": { + "type": { + "$ref": "#/6" + }, + "flags": 18, + "description": "" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ECR/RegistryPolicy", + "properties": { + "name": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/6" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/14" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ECR/RegistryPolicy@default", + "scopeType": 0, + "body": { + "$ref": "#/15" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Filter", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "FilterType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Region", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RegistryId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ReplicationConfiguration", + "properties": { + "Rules": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "An array of objects representing the replication rules for a replication configuration. A replication configuration may contain a maximum of 10 rules." + } + } + }, + { + "$type": "ObjectType", + "name": "ReplicationDestination", + "properties": { + "Region": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "RegistryId": { + "type": { + "$ref": "#/6" + }, + "flags": 17 + } + } + }, + { + "$type": "ObjectType", + "name": "ReplicationRule", + "properties": { + "Destinations": { + "type": { + "$ref": "#/26" + }, + "flags": 1, + "description": "An array of objects representing the details of a replication destination." + }, + "RepositoryFilters": { + "type": { + "$ref": "#/27" + }, + "flags": 0, + "description": "An array of objects representing the details of a repository filter." + } + } + }, + { + "$type": "ObjectType", + "name": "RepositoryFilter", + "properties": { + "Filter": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "FilterType": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/23" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/22" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/24" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.ECR/ReplicationConfigurationProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.ECR/ReplicationConfigurationProperties", + "properties": { + "RegistryId": { + "type": { + "$ref": "#/6" + }, + "flags": 18, + "description": "The RegistryId associated with the aws account." + }, + "ReplicationConfiguration": { + "type": { + "$ref": "#/21" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ECR/ReplicationConfiguration", + "properties": { + "name": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/6" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/29" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ECR/ReplicationConfiguration@default", + "scopeType": 0, + "body": { + "$ref": "#/30" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "EmptyOnDelete", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "EncryptionConfiguration", + "properties": { + "EncryptionType": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "The encryption type to use.\n If you use the ``KMS`` encryption type, the contents of the repository will be encrypted using server-side encryption with KMSlong key stored in KMS. When you use KMS to encrypt your data, you can either use the default AWS managed KMS key for Amazon ECR, or specify your own KMS key, which you already created. For more information, see [Protecting data using server-side encryption with an key stored in (SSE-KMS)](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html) in the *Amazon Simple Storage Service Console Developer Guide*.\n If you use the ``AES256`` encryption type, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts the images in the repository using an AES-256 encryption algorithm. For more information, see [Protecting data using server-side encryption with Amazon S3-managed encryption keys (SSE-S3)](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html) in the *Ama" + }, + "KmsKey": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "If you use the ``KMS`` encryption type, specify the KMS key to use for encryption. The alias, key ID, or full ARN of the KMS key can be specified. The key must exist in the same Region as the repository. If no key is specified, the default AWS managed KMS key for Amazon ECR will be used." + } + } + }, + { + "$type": "ObjectType", + "name": "EncryptionType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ImageScanningConfiguration", + "properties": { + "ScanOnPush": { + "type": { + "$ref": "#/42" + }, + "flags": 0, + "description": "The setting that determines whether images are scanned after being pushed to a repository. If set to ``true``, images will be scanned after being pushed. If this parameter is not specified, it will default to ``false`` and images will not be scanned unless a scan is manually started." + } + } + }, + { + "$type": "ObjectType", + "name": "KmsKey", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LifecyclePolicy", + "properties": { + "LifecyclePolicyText": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "The JSON repository policy text to apply to the repository." + }, + "RegistryId": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "The AWS account ID associated with the registry that contains the repository. If you do? not specify a registry, the default registry is assumed." + } + } + }, + { + "$type": "ObjectType", + "name": "LifecyclePolicyText", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RegistryId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ScanOnPush", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "One part of a key-value pair that make up a tag. A ``key`` is a general label that acts like a category for more specific tag values." + }, + "Value": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "A ``value`` acts as a descriptor within a tag category (key)." + } + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.ECR/RepositoryProperties" + }, + { + "$type": "ObjectType", + "name": "Repository_RepositoryPolicyText", + "properties": {} + }, + { + "$type": "UnionType", + "elements": [ + { + "$ref": "#/44" + }, + { + "$ref": "#/6" + } + ] + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/41" + } + }, + { + "$type": "ObjectType", + "name": "AWS.ECR/RepositoryProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/6" + }, + "flags": 2, + "description": "" + }, + "EmptyOnDelete": { + "type": { + "$ref": "#/42" + }, + "flags": 4, + "description": "If true, deleting the repository force deletes the contents of the repository. If false, the repository must be empty before attempting to delete it." + }, + "EncryptionConfiguration": { + "type": { + "$ref": "#/33" + }, + "flags": 0, + "description": "The encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest." + }, + "ImageScanningConfiguration": { + "type": { + "$ref": "#/35" + }, + "flags": 0, + "description": "The image scanning configuration for the repository. This determines whether images are scanned for known vulnerabilities after being pushed to the repository." + }, + "ImageTagMutability": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "The tag mutability setting for the repository. If this parameter is omitted, the default setting of ``MUTABLE`` will be used which will allow image tags to be overwritten. If ``IMMUTABLE`` is specified, all image tags within the repository will be immutable which will prevent them from being overwritten." + }, + "LifecyclePolicy": { + "type": { + "$ref": "#/37" + }, + "flags": 0, + "description": "Creates or updates a lifecycle policy. For information about lifecycle policy syntax, see [Lifecycle policy template](https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html)." + }, + "RepositoryName": { + "type": { + "$ref": "#/6" + }, + "flags": 16, + "description": "The name to use for the repository. The repository name may be specified on its own (such as ``nginx-web-app``) or it can be prepended with a namespace to group the repository into a category (such as ``project-a/nginx-web-app``). If you don't specify a name, CFNlong generates a unique physical ID and uses that ID for the repository name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).\n The repository name must start with a letter and can only contain lowercase letters, numbers, hyphens, underscores, and forward slashes.\n If 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." + }, + "RepositoryPolicyText": { + "type": { + "$ref": "#/45" + }, + "flags": 0, + "description": "The JSON repository policy text to apply to the repository. For more information, see [Amazon ECR repository policies](https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policy-examples.html) in the *Amazon Elastic Container Registry User Guide*." + }, + "RepositoryUri": { + "type": { + "$ref": "#/6" + }, + "flags": 2, + "description": "" + }, + "Tags": { + "type": { + "$ref": "#/46" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ECR/Repository", + "properties": { + "name": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/6" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/47" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ECR/Repository@default", + "scopeType": 0, + "body": { + "$ref": "#/48" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AppliedForItem", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "EncryptionConfiguration", + "properties": { + "EncryptionType": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "KmsKey": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "EncryptionType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "KmsKey", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.ECR/RepositoryCreationTemplateProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/54" + } + }, + { + "$type": "ObjectType", + "name": "AWS.ECR/RepositoryCreationTemplateProperties", + "properties": { + "AppliedFor": { + "type": { + "$ref": "#/56" + }, + "flags": 1, + "description": "A list of enumerable Strings representing the repository creation scenarios that the template will apply towards." + }, + "CreatedAt": { + "type": { + "$ref": "#/6" + }, + "flags": 2, + "description": "Create timestamp of the template." + }, + "Description": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "The description of the template." + }, + "EncryptionConfiguration": { + "type": { + "$ref": "#/51" + }, + "flags": 0 + }, + "ImageTagMutability": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "The image tag mutability setting for the repository." + }, + "LifecyclePolicy": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "The JSON lifecycle policy text to apply to the repository. For information about lifecycle policy syntax, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html" + }, + "Prefix": { + "type": { + "$ref": "#/6" + }, + "flags": 17, + "description": "The prefix use to match the repository name and apply the template." + }, + "RepositoryPolicy": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "The JSON repository policy text to apply to the repository. For more information, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/RepositoryPolicyExamples.html" + }, + "ResourceTags": { + "type": { + "$ref": "#/57" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + }, + "UpdatedAt": { + "type": { + "$ref": "#/6" + }, + "flags": 2, + "description": "Update timestamp of the template." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ECR/RepositoryCreationTemplate", + "properties": { + "name": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/6" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/58" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ECR/RepositoryCreationTemplate@default", + "scopeType": 0, + "body": { + "$ref": "#/59" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.ecr/default/types.md b/artifacts/bicep/aws/aws.ecr/default/types.md index 99a25bc2..e7569879 100644 --- a/artifacts/bicep/aws/aws.ecr/default/types.md +++ b/artifacts/bicep/aws/aws.ecr/default/types.md @@ -3,30 +3,37 @@ ## Resource AWS.ECR/PullThroughCacheRule@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ECR/PullThroughCacheRuleProperties](#awsecrpullthroughcacheruleproperties): properties of the resource +* **properties**: [AWS.ECR/PullThroughCacheRuleProperties](#awsecrpullthroughcacheruleproperties) (Identifier): properties of the resource ## Resource AWS.ECR/RegistryPolicy@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ECR/RegistryPolicyProperties](#awsecrregistrypolicyproperties) (Required): properties of the resource +* **properties**: [AWS.ECR/RegistryPolicyProperties](#awsecrregistrypolicyproperties) (Required, Identifier): properties of the resource ## Resource AWS.ECR/ReplicationConfiguration@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ECR/ReplicationConfigurationProperties](#awsecrreplicationconfigurationproperties) (Required): properties of the resource +* **properties**: [AWS.ECR/ReplicationConfigurationProperties](#awsecrreplicationconfigurationproperties) (Required, Identifier): properties of the resource ## Resource AWS.ECR/Repository@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ECR/RepositoryProperties](#awsecrrepositoryproperties): properties of the resource +* **properties**: [AWS.ECR/RepositoryProperties](#awsecrrepositoryproperties) (Identifier): properties of the resource + +## Resource AWS.ECR/RepositoryCreationTemplate@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.ECR/RepositoryCreationTemplateProperties](#awsecrrepositorycreationtemplateproperties) (Required, Identifier): properties of the resource ## AWS.ECR/PullThroughCacheRuleProperties ### Properties @@ -37,49 +44,49 @@ ## AWS.ECR/RegistryPolicyProperties ### Properties -* **PolicyText**: [RegistryPolicy_PolicyText](#registrypolicypolicytext) (Required): The JSON policy text to apply to your registry. The policy text follows the same format as IAM policy text. For more information, see Registry permissions (https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry-permissions.html) in the Amazon Elastic Container Registry User Guide. +* **PolicyText**: [RegistryPolicy_PolicyText](#registrypolicypolicytext) (Required): The JSON policy text for your registry. * **RegistryId**: string (ReadOnly, Identifier) -## RegistryPolicy_PolicyText -### Properties - ## AWS.ECR/ReplicationConfigurationProperties ### Properties * **RegistryId**: string (ReadOnly, Identifier): The RegistryId associated with the aws account. * **ReplicationConfiguration**: [ReplicationConfiguration](#replicationconfiguration) (Required) -## ReplicationConfiguration -### Properties -* **Rules**: [ReplicationRule](#replicationrule)[] (Required): An array of objects representing the replication rules for a replication configuration. A replication configuration may contain a maximum of 10 rules. - -## ReplicationRule -### Properties -* **Destinations**: [ReplicationDestination](#replicationdestination)[] (Required): An array of objects representing the details of a replication destination. -* **RepositoryFilters**: [RepositoryFilter](#repositoryfilter)[]: An array of objects representing the details of a repository filter. - -## ReplicationDestination -### Properties -* **Region**: string (Required) -* **RegistryId**: string (Required, Identifier) - -## RepositoryFilter +## AWS.ECR/RepositoryCreationTemplateProperties ### Properties -* **Filter**: string (Required) -* **FilterType**: string (Required) +* **AppliedFor**: string[] (Required): A list of enumerable Strings representing the repository creation scenarios that the template will apply towards. +* **CreatedAt**: string (ReadOnly): Create timestamp of the template. +* **Description**: string: The description of the template. +* **EncryptionConfiguration**: [EncryptionConfiguration](#encryptionconfiguration) +* **ImageTagMutability**: string: The image tag mutability setting for the repository. +* **LifecyclePolicy**: string: The JSON lifecycle policy text to apply to the repository. For information about lifecycle policy syntax, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html +* **Prefix**: string (Required, Identifier): The prefix use to match the repository name and apply the template. +* **RepositoryPolicy**: string: The JSON repository policy text to apply to the repository. For more information, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/RepositoryPolicyExamples.html +* **ResourceTags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. +* **UpdatedAt**: string (ReadOnly): Update timestamp of the template. ## AWS.ECR/RepositoryProperties ### Properties * **Arn**: string (ReadOnly) -* **EmptyOnDelete**: bool (WriteOnly) -* **EncryptionConfiguration**: [EncryptionConfiguration](#encryptionconfiguration) -* **ImageScanningConfiguration**: [ImageScanningConfiguration](#imagescanningconfiguration) -* **ImageTagMutability**: string: The image tag mutability setting for the repository. -* **LifecyclePolicy**: [LifecyclePolicy](#lifecyclepolicy) -* **RepositoryName**: string (Identifier): The name to use for the repository. The repository name may be specified on its own (such as nginx-web-app) or it can be prepended with a namespace to group the repository into a category (such as project-a/nginx-web-app). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the repository name. For more information, see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html. -* **RepositoryPolicyText**: [Repository_RepositoryPolicyText](#repositoryrepositorypolicytext) | string: The JSON repository policy text to apply to the repository. For more information, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/RepositoryPolicyExamples.html in the Amazon Elastic Container Registry User Guide. +* **EmptyOnDelete**: bool (WriteOnly): If true, deleting the repository force deletes the contents of the repository. If false, the repository must be empty before attempting to delete it. +* **EncryptionConfiguration**: [EncryptionConfiguration](#encryptionconfiguration): The encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest. +* **ImageScanningConfiguration**: [ImageScanningConfiguration](#imagescanningconfiguration): The image scanning configuration for the repository. This determines whether images are scanned for known vulnerabilities after being pushed to the repository. +* **ImageTagMutability**: string: The tag mutability setting for the repository. If this parameter is omitted, the default setting of ``MUTABLE`` will be used which will allow image tags to be overwritten. If ``IMMUTABLE`` is specified, all image tags within the repository will be immutable which will prevent them from being overwritten. +* **LifecyclePolicy**: [LifecyclePolicy](#lifecyclepolicy): Creates or updates a lifecycle policy. For information about lifecycle policy syntax, see [Lifecycle policy template](https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html). +* **RepositoryName**: string (Identifier): The name to use for the repository. The repository name may be specified on its own (such as ``nginx-web-app``) or it can be prepended with a namespace to group the repository into a category (such as ``project-a/nginx-web-app``). If you don't specify a name, CFNlong generates a unique physical ID and uses that ID for the repository name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html). + The repository name must start with a letter and can only contain lowercase letters, numbers, hyphens, underscores, and forward slashes. + If 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. +* **RepositoryPolicyText**: [Repository_RepositoryPolicyText](#repositoryrepositorypolicytext) | string: The JSON repository policy text to apply to the repository. For more information, see [Amazon ECR repository policies](https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policy-examples.html) in the *Amazon Elastic Container Registry User Guide*. * **RepositoryUri**: string (ReadOnly) * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. +## EncryptionConfiguration +### Properties +* **EncryptionType**: string (Required): The encryption type to use. + If you use the ``KMS`` encryption type, the contents of the repository will be encrypted using server-side encryption with KMSlong key stored in KMS. When you use KMS to encrypt your data, you can either use the default AWS managed KMS key for Amazon ECR, or specify your own KMS key, which you already created. For more information, see [Protecting data using server-side encryption with an key stored in (SSE-KMS)](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html) in the *Amazon Simple Storage Service Console Developer Guide*. + If you use the ``AES256`` encryption type, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts the images in the repository using an AES-256 encryption algorithm. For more information, see [Protecting data using server-side encryption with Amazon S3-managed encryption keys (SSE-S3)](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html) in the *Ama +* **KmsKey**: string: If you use the ``KMS`` encryption type, specify the KMS key to use for encryption. The alias, key ID, or full ARN of the KMS key can be specified. The key must exist in the same Region as the repository. If no key is specified, the default AWS managed KMS key for Amazon ECR will be used. + ## EncryptionConfiguration ### Properties * **EncryptionType**: string (Required) @@ -87,15 +94,42 @@ ## ImageScanningConfiguration ### Properties -* **ScanOnPush**: bool +* **ScanOnPush**: bool: The setting that determines whether images are scanned after being pushed to a repository. If set to ``true``, images will be scanned after being pushed. If this parameter is not specified, it will default to ``false`` and images will not be scanned unless a scan is manually started. ## LifecyclePolicy ### Properties -* **LifecyclePolicyText**: string -* **RegistryId**: string +* **LifecyclePolicyText**: string: The JSON repository policy text to apply to the repository. +* **RegistryId**: string: The AWS account ID associated with the registry that contains the repository. If you do? not specify a registry, the default registry is assumed. + +## RegistryPolicy_PolicyText +### Properties + +## ReplicationConfiguration +### Properties +* **Rules**: [ReplicationRule](#replicationrule)[] (Required): An array of objects representing the replication rules for a replication configuration. A replication configuration may contain a maximum of 10 rules. + +## ReplicationDestination +### Properties +* **Region**: string (Required) +* **RegistryId**: string (Required, Identifier) + +## ReplicationRule +### Properties +* **Destinations**: [ReplicationDestination](#replicationdestination)[] (Required): An array of objects representing the details of a replication destination. +* **RepositoryFilters**: [RepositoryFilter](#repositoryfilter)[]: An array of objects representing the details of a repository filter. + +## RepositoryFilter +### Properties +* **Filter**: string (Required) +* **FilterType**: string (Required) + +## Tag +### Properties +* **Key**: string (Required): One part of a key-value pair that make up a tag. A ``key`` is a general label that acts like a category for more specific tag values. +* **Value**: string (Required): A ``value`` acts as a descriptor within a tag category (key). ## Tag ### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. diff --git a/artifacts/bicep/aws/aws.ecs/default/types.json b/artifacts/bicep/aws/aws.ecs/default/types.json index c034a982..5fec4445 100644 --- a/artifacts/bicep/aws/aws.ecs/default/types.json +++ b/artifacts/bicep/aws/aws.ecs/default/types.json @@ -1 +1,3411 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"AutoScalingGroupProvider","Properties":{"AutoScalingGroupArn":{"Type":4,"Flags":1},"ManagedDraining":{"Type":4,"Flags":0},"ManagedScaling":{"Type":9,"Flags":0},"ManagedTerminationProtection":{"Type":4,"Flags":0}}}},{"2":{"Name":"ManagedScaling","Properties":{"InstanceWarmupPeriod":{"Type":3,"Flags":0},"MaximumScalingStepSize":{"Type":3,"Flags":0},"MinimumScalingStepSize":{"Type":3,"Flags":0},"Status":{"Type":4,"Flags":0},"TargetCapacity":{"Type":3,"Flags":0}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":0},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"AWS.ECS/CapacityProviderProperties","Properties":{"AutoScalingGroupProvider":{"Type":8,"Flags":1},"Name":{"Type":4,"Flags":16},"Tags":{"Type":12,"Flags":0}}}},{"3":{"ItemType":10}},{"2":{"Name":"AWS.ECS/CapacityProvider","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":11,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ECS/CapacityProvider@default","ScopeType":0,"Body":13}},{"2":{"Name":"CapacityProviderStrategyItem","Properties":{"Base":{"Type":3,"Flags":0},"CapacityProvider":{"Type":4,"Flags":0},"Weight":{"Type":3,"Flags":0}}}},{"2":{"Name":"ClusterConfiguration","Properties":{"ExecuteCommandConfiguration":{"Type":18,"Flags":0}}}},{"2":{"Name":"ClusterSettings","Properties":{"Name":{"Type":4,"Flags":0},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"ExecuteCommandConfiguration","Properties":{"KmsKeyId":{"Type":4,"Flags":0},"LogConfiguration":{"Type":19,"Flags":0},"Logging":{"Type":4,"Flags":0}}}},{"2":{"Name":"ExecuteCommandLogConfiguration","Properties":{"CloudWatchEncryptionEnabled":{"Type":2,"Flags":0},"CloudWatchLogGroupName":{"Type":4,"Flags":0},"S3BucketName":{"Type":4,"Flags":0},"S3EncryptionEnabled":{"Type":2,"Flags":0},"S3KeyPrefix":{"Type":4,"Flags":0}}}},{"2":{"Name":"ServiceConnectDefaults","Properties":{"Namespace":{"Type":4,"Flags":0,"Description":"Service Connect Namespace Name or ARN default for all services or tasks within this cluster"}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":0},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"AWS.ECS/ClusterProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) of the Amazon ECS cluster, such as arn:aws:ecs:us-east-2:123456789012:cluster/MyECSCluster."},"CapacityProviders":{"Type":23,"Flags":0},"ClusterName":{"Type":4,"Flags":16,"Description":"A user-generated string that you use to identify your cluster. If you don't specify a name, AWS CloudFormation generates a unique physical ID for the name."},"ClusterSettings":{"Type":24,"Flags":0},"Configuration":{"Type":16,"Flags":0},"DefaultCapacityProviderStrategy":{"Type":25,"Flags":0},"ServiceConnectDefaults":{"Type":20,"Flags":4},"Tags":{"Type":26,"Flags":0}}}},{"3":{"ItemType":4}},{"3":{"ItemType":17}},{"3":{"ItemType":15}},{"3":{"ItemType":21}},{"2":{"Name":"AWS.ECS/Cluster","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":22,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ECS/Cluster@default","ScopeType":0,"Body":27}},{"2":{"Name":"CapacityProvider"}},{"2":{"Name":"CapacityProviderStrategy","Properties":{"Base":{"Type":3,"Flags":0},"CapacityProvider":{"Type":4,"Flags":1},"Weight":{"Type":3,"Flags":0}}}},{"2":{"Name":"CapacityProviders"}},{"2":{"Name":"Cluster"}},{"2":{"Name":"DefaultCapacityProviderStrategy"}},{"3":{"ItemType":4}},{"3":{"ItemType":30}},{"2":{"Name":"AWS.ECS/ClusterCapacityProviderAssociationsProperties","Properties":{"CapacityProviders":{"Type":37,"Flags":1},"Cluster":{"Type":4,"Flags":17},"DefaultCapacityProviderStrategy":{"Type":38,"Flags":1}}}},{"3":{"ItemType":4}},{"3":{"ItemType":30}},{"2":{"Name":"AWS.ECS/ClusterCapacityProviderAssociations","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":36,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ECS/ClusterCapacityProviderAssociations@default","ScopeType":0,"Body":39}},{"2":{"Name":"AWS.ECS/PrimaryTaskSetProperties","Properties":{"Cluster":{"Type":4,"Flags":17,"Description":"The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in."},"Service":{"Type":4,"Flags":17,"Description":"The short name or full Amazon Resource Name (ARN) of the service to create the task set in."},"TaskSetId":{"Type":4,"Flags":1,"Description":"The ID or full Amazon Resource Name (ARN) of the task set."}}}},{"2":{"Name":"AWS.ECS/PrimaryTaskSet","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":41,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ECS/PrimaryTaskSet@default","ScopeType":0,"Body":42}},{"2":{"Name":"AwsVpcConfiguration","Properties":{"AssignPublicIp":{"Type":4,"Flags":0},"SecurityGroups":{"Type":64,"Flags":0},"Subnets":{"Type":65,"Flags":0}}}},{"2":{"Name":"CapacityProviderStrategyItem","Properties":{"Base":{"Type":3,"Flags":0},"CapacityProvider":{"Type":4,"Flags":0},"Weight":{"Type":3,"Flags":0}}}},{"2":{"Name":"DeploymentAlarms","Properties":{"AlarmNames":{"Type":66,"Flags":1},"Enable":{"Type":2,"Flags":1},"Rollback":{"Type":2,"Flags":1}}}},{"2":{"Name":"DeploymentCircuitBreaker","Properties":{"Enable":{"Type":2,"Flags":1},"Rollback":{"Type":2,"Flags":1}}}},{"2":{"Name":"DeploymentConfiguration","Properties":{"Alarms":{"Type":46,"Flags":0},"DeploymentCircuitBreaker":{"Type":47,"Flags":0},"MaximumPercent":{"Type":3,"Flags":0},"MinimumHealthyPercent":{"Type":3,"Flags":0}}}},{"2":{"Name":"DeploymentController","Properties":{"Type":{"Type":4,"Flags":0}}}},{"2":{"Name":"EBSTagSpecification","Properties":{"PropagateTags":{"Type":4,"Flags":0},"ResourceType":{"Type":4,"Flags":1},"Tags":{"Type":67,"Flags":0}}}},{"2":{"Name":"LoadBalancer","Properties":{"ContainerName":{"Type":4,"Flags":0},"ContainerPort":{"Type":3,"Flags":0},"LoadBalancerName":{"Type":4,"Flags":0},"TargetGroupArn":{"Type":4,"Flags":0}}}},{"2":{"Name":"LogConfiguration","Properties":{"LogDriver":{"Type":4,"Flags":0},"Options":{"Type":68,"Flags":0},"SecretOptions":{"Type":69,"Flags":0}}}},{"2":{"Name":"NetworkConfiguration","Properties":{"AwsvpcConfiguration":{"Type":44,"Flags":0}}}},{"2":{"Name":"PlacementConstraint","Properties":{"Expression":{"Type":4,"Flags":0},"Type":{"Type":4,"Flags":1}}}},{"2":{"Name":"PlacementStrategy","Properties":{"Field":{"Type":4,"Flags":0},"Type":{"Type":4,"Flags":1}}}},{"2":{"Name":"Secret","Properties":{"Name":{"Type":4,"Flags":1},"ValueFrom":{"Type":4,"Flags":1}}}},{"2":{"Name":"ServiceConnectClientAlias","Properties":{"DnsName":{"Type":4,"Flags":0},"Port":{"Type":3,"Flags":1}}}},{"2":{"Name":"ServiceConnectConfiguration","Properties":{"Enabled":{"Type":2,"Flags":1},"LogConfiguration":{"Type":52,"Flags":0},"Namespace":{"Type":4,"Flags":0},"Services":{"Type":70,"Flags":0}}}},{"2":{"Name":"ServiceConnectService","Properties":{"ClientAliases":{"Type":71,"Flags":0},"DiscoveryName":{"Type":4,"Flags":0},"IngressPortOverride":{"Type":3,"Flags":0},"PortName":{"Type":4,"Flags":1}}}},{"2":{"Name":"ServiceManagedEBSVolumeConfiguration","Properties":{"Encrypted":{"Type":2,"Flags":0},"FilesystemType":{"Type":4,"Flags":0},"Iops":{"Type":3,"Flags":0},"KmsKeyId":{"Type":4,"Flags":0},"RoleArn":{"Type":4,"Flags":1},"SizeInGiB":{"Type":3,"Flags":0},"SnapshotId":{"Type":4,"Flags":0},"TagSpecifications":{"Type":72,"Flags":0},"Throughput":{"Type":3,"Flags":0},"VolumeType":{"Type":4,"Flags":0}}}},{"2":{"Name":"ServiceRegistry","Properties":{"ContainerName":{"Type":4,"Flags":0},"ContainerPort":{"Type":3,"Flags":0},"Port":{"Type":3,"Flags":0},"RegistryArn":{"Type":4,"Flags":0}}}},{"2":{"Name":"ServiceVolumeConfiguration","Properties":{"ManagedEBSVolume":{"Type":60,"Flags":0},"Name":{"Type":4,"Flags":1}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":0},"Value":{"Type":4,"Flags":0}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":63}},{"2":{"Name":"Service_Options","Properties":{}}},{"3":{"ItemType":56}},{"3":{"ItemType":59}},{"3":{"ItemType":57}},{"3":{"ItemType":50}},{"2":{"Name":"AWS.ECS/ServiceProperties","Properties":{"CapacityProviderStrategy":{"Type":74,"Flags":0},"Cluster":{"Type":4,"Flags":16},"DeploymentConfiguration":{"Type":48,"Flags":0},"DeploymentController":{"Type":49,"Flags":0},"DesiredCount":{"Type":3,"Flags":0},"EnableECSManagedTags":{"Type":2,"Flags":0},"EnableExecuteCommand":{"Type":2,"Flags":0},"HealthCheckGracePeriodSeconds":{"Type":3,"Flags":0},"LaunchType":{"Type":4,"Flags":0},"LoadBalancers":{"Type":75,"Flags":0},"Name":{"Type":4,"Flags":2},"NetworkConfiguration":{"Type":53,"Flags":0},"PlacementConstraints":{"Type":76,"Flags":0},"PlacementStrategies":{"Type":77,"Flags":0},"PlatformVersion":{"Type":4,"Flags":0},"PropagateTags":{"Type":4,"Flags":0},"Role":{"Type":4,"Flags":0},"SchedulingStrategy":{"Type":4,"Flags":0},"ServiceArn":{"Type":4,"Flags":18},"ServiceConnectConfiguration":{"Type":58,"Flags":4},"ServiceName":{"Type":4,"Flags":0},"ServiceRegistries":{"Type":78,"Flags":0},"Tags":{"Type":79,"Flags":0},"TaskDefinition":{"Type":4,"Flags":0},"VolumeConfigurations":{"Type":80,"Flags":4}}}},{"3":{"ItemType":45}},{"3":{"ItemType":51}},{"3":{"ItemType":54}},{"3":{"ItemType":55}},{"3":{"ItemType":61}},{"3":{"ItemType":63}},{"3":{"ItemType":62}},{"2":{"Name":"AWS.ECS/Service","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":73,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ECS/Service@default","ScopeType":0,"Body":81}},{"2":{"Name":"AuthorizationConfig","Properties":{"AccessPointId":{"Type":4,"Flags":0},"IAM":{"Type":4,"Flags":0}}}},{"2":{"Name":"ContainerDefinition","Properties":{"Command":{"Type":114,"Flags":0},"Cpu":{"Type":3,"Flags":0},"DependsOn":{"Type":115,"Flags":0},"DisableNetworking":{"Type":2,"Flags":0},"DnsSearchDomains":{"Type":116,"Flags":0},"DnsServers":{"Type":117,"Flags":0},"DockerLabels":{"Type":118,"Flags":0},"DockerSecurityOptions":{"Type":119,"Flags":0},"EntryPoint":{"Type":120,"Flags":0},"Environment":{"Type":121,"Flags":0,"Description":"The environment variables to pass to a container"},"EnvironmentFiles":{"Type":122,"Flags":0,"Description":"The list of one or more files that contain the environment variables to pass to a container"},"Essential":{"Type":2,"Flags":0},"ExtraHosts":{"Type":123,"Flags":0},"FirelensConfiguration":{"Type":91,"Flags":0},"HealthCheck":{"Type":92,"Flags":0},"Hostname":{"Type":4,"Flags":0},"Image":{"Type":4,"Flags":1,"Description":"The image used to start a container. This string is passed directly to the Docker daemon."},"Interactive":{"Type":2,"Flags":0},"Links":{"Type":124,"Flags":0},"LinuxParameters":{"Type":98,"Flags":0},"LogConfiguration":{"Type":99,"Flags":0},"Memory":{"Type":3,"Flags":0,"Description":"The amount (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed."},"MemoryReservation":{"Type":3,"Flags":0},"MountPoints":{"Type":125,"Flags":0},"Name":{"Type":4,"Flags":1,"Description":"The name of a container. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed"},"PortMappings":{"Type":126,"Flags":0,"Description":"Port mappings allow containers to access ports on the host container instance to send or receive traffic."},"Privileged":{"Type":2,"Flags":0},"PseudoTerminal":{"Type":2,"Flags":0},"ReadonlyRootFilesystem":{"Type":2,"Flags":0},"RepositoryCredentials":{"Type":103,"Flags":0},"ResourceRequirements":{"Type":127,"Flags":0},"Secrets":{"Type":128,"Flags":0},"StartTimeout":{"Type":3,"Flags":0},"StopTimeout":{"Type":3,"Flags":0},"SystemControls":{"Type":129,"Flags":0},"Ulimits":{"Type":130,"Flags":0},"User":{"Type":4,"Flags":0},"VolumesFrom":{"Type":131,"Flags":0},"WorkingDirectory":{"Type":4,"Flags":0}}}},{"2":{"Name":"ContainerDependency","Properties":{"Condition":{"Type":4,"Flags":0},"ContainerName":{"Type":4,"Flags":0}}}},{"2":{"Name":"Device","Properties":{"ContainerPath":{"Type":4,"Flags":0},"HostPath":{"Type":4,"Flags":0},"Permissions":{"Type":132,"Flags":0}}}},{"2":{"Name":"DockerVolumeConfiguration","Properties":{"Autoprovision":{"Type":2,"Flags":0},"Driver":{"Type":4,"Flags":0},"DriverOpts":{"Type":133,"Flags":0},"Labels":{"Type":134,"Flags":0},"Scope":{"Type":4,"Flags":0}}}},{"2":{"Name":"EFSVolumeConfiguration","Properties":{"AuthorizationConfig":{"Type":83,"Flags":0},"FilesystemId":{"Type":4,"Flags":1},"RootDirectory":{"Type":4,"Flags":0},"TransitEncryption":{"Type":4,"Flags":0},"TransitEncryptionPort":{"Type":3,"Flags":0}}}},{"2":{"Name":"EnvironmentFile","Properties":{"Type":{"Type":4,"Flags":0},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"EphemeralStorage","Properties":{"SizeInGiB":{"Type":3,"Flags":0}}}},{"2":{"Name":"FirelensConfiguration","Properties":{"Options":{"Type":135,"Flags":0},"Type":{"Type":4,"Flags":0}}}},{"2":{"Name":"HealthCheck","Properties":{"Command":{"Type":136,"Flags":0,"Description":"A string array representing the command that the container runs to determine if it is healthy."},"Interval":{"Type":3,"Flags":0,"Description":"The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds."},"Retries":{"Type":3,"Flags":0,"Description":"The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is three retries."},"StartPeriod":{"Type":3,"Flags":0,"Description":"The optional grace period within which to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You may specify between 0 and 300 seconds. The startPeriod is disabled by default."},"Timeout":{"Type":3,"Flags":0,"Description":"The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5 seconds."}}}},{"2":{"Name":"HostEntry","Properties":{"Hostname":{"Type":4,"Flags":0},"IpAddress":{"Type":4,"Flags":0}}}},{"2":{"Name":"HostVolumeProperties","Properties":{"SourcePath":{"Type":4,"Flags":0}}}},{"2":{"Name":"InferenceAccelerator","Properties":{"DeviceName":{"Type":4,"Flags":0},"DeviceType":{"Type":4,"Flags":0}}}},{"2":{"Name":"KernelCapabilities","Properties":{"Add":{"Type":137,"Flags":0},"Drop":{"Type":138,"Flags":0}}}},{"2":{"Name":"KeyValuePair","Properties":{"Name":{"Type":4,"Flags":0},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"LinuxParameters","Properties":{"Capabilities":{"Type":96,"Flags":0},"Devices":{"Type":139,"Flags":0},"InitProcessEnabled":{"Type":2,"Flags":0},"MaxSwap":{"Type":3,"Flags":0},"SharedMemorySize":{"Type":3,"Flags":0},"Swappiness":{"Type":3,"Flags":0},"Tmpfs":{"Type":140,"Flags":0}}}},{"2":{"Name":"LogConfiguration","Properties":{"LogDriver":{"Type":4,"Flags":1},"Options":{"Type":141,"Flags":0},"SecretOptions":{"Type":142,"Flags":0}}}},{"2":{"Name":"MountPoint","Properties":{"ContainerPath":{"Type":4,"Flags":0},"ReadOnly":{"Type":2,"Flags":0},"SourceVolume":{"Type":4,"Flags":0}}}},{"2":{"Name":"PortMapping","Properties":{"AppProtocol":{"Type":4,"Flags":0},"ContainerPort":{"Type":3,"Flags":0},"ContainerPortRange":{"Type":4,"Flags":0},"HostPort":{"Type":3,"Flags":0},"Name":{"Type":4,"Flags":0},"Protocol":{"Type":4,"Flags":0}}}},{"2":{"Name":"ProxyConfiguration","Properties":{"ContainerName":{"Type":4,"Flags":1},"ProxyConfigurationProperties":{"Type":143,"Flags":0},"Type":{"Type":4,"Flags":0}}}},{"2":{"Name":"RepositoryCredentials","Properties":{"CredentialsParameter":{"Type":4,"Flags":0}}}},{"2":{"Name":"ResourceRequirement","Properties":{"Type":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"RuntimePlatform","Properties":{"CpuArchitecture":{"Type":4,"Flags":0},"OperatingSystemFamily":{"Type":4,"Flags":0}}}},{"2":{"Name":"Secret","Properties":{"Name":{"Type":4,"Flags":1},"ValueFrom":{"Type":4,"Flags":1}}}},{"2":{"Name":"SystemControl","Properties":{"Namespace":{"Type":4,"Flags":0},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":0},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"TaskDefinitionPlacementConstraint","Properties":{"Expression":{"Type":4,"Flags":0},"Type":{"Type":4,"Flags":1}}}},{"2":{"Name":"Tmpfs","Properties":{"ContainerPath":{"Type":4,"Flags":0},"MountOptions":{"Type":144,"Flags":0},"Size":{"Type":3,"Flags":1}}}},{"2":{"Name":"Ulimit","Properties":{"HardLimit":{"Type":3,"Flags":1},"Name":{"Type":4,"Flags":1},"SoftLimit":{"Type":3,"Flags":1}}}},{"2":{"Name":"Volume","Properties":{"DockerVolumeConfiguration":{"Type":87,"Flags":0},"EFSVolumeConfiguration":{"Type":88,"Flags":0},"Host":{"Type":94,"Flags":0},"Name":{"Type":4,"Flags":0}}}},{"2":{"Name":"VolumeFrom","Properties":{"ReadOnly":{"Type":2,"Flags":0},"SourceContainer":{"Type":4,"Flags":0}}}},{"3":{"ItemType":4}},{"3":{"ItemType":85}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"TaskDefinition_DockerLabels","Properties":{}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":97}},{"3":{"ItemType":89}},{"3":{"ItemType":93}},{"3":{"ItemType":4}},{"3":{"ItemType":100}},{"3":{"ItemType":101}},{"3":{"ItemType":104}},{"3":{"ItemType":106}},{"3":{"ItemType":107}},{"3":{"ItemType":111}},{"3":{"ItemType":113}},{"3":{"ItemType":4}},{"2":{"Name":"TaskDefinition_DriverOpts","Properties":{}}},{"2":{"Name":"TaskDefinition_Labels","Properties":{}}},{"2":{"Name":"TaskDefinition_Options","Properties":{}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":86}},{"3":{"ItemType":110}},{"2":{"Name":"TaskDefinition_Options","Properties":{}}},{"3":{"ItemType":106}},{"3":{"ItemType":97}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.ECS/TaskDefinitionProperties","Properties":{"ContainerDefinitions":{"Type":146,"Flags":0},"Cpu":{"Type":4,"Flags":0},"EphemeralStorage":{"Type":90,"Flags":0},"ExecutionRoleArn":{"Type":4,"Flags":0},"Family":{"Type":4,"Flags":0},"InferenceAccelerators":{"Type":147,"Flags":0},"IpcMode":{"Type":4,"Flags":0},"Memory":{"Type":4,"Flags":0},"NetworkMode":{"Type":4,"Flags":0},"PidMode":{"Type":4,"Flags":0},"PlacementConstraints":{"Type":148,"Flags":0},"ProxyConfiguration":{"Type":102,"Flags":0},"RequiresCompatibilities":{"Type":149,"Flags":0},"RuntimePlatform":{"Type":105,"Flags":0},"Tags":{"Type":150,"Flags":0},"TaskDefinitionArn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN) of the Amazon ECS task definition"},"TaskRoleArn":{"Type":4,"Flags":0},"Volumes":{"Type":151,"Flags":0}}}},{"3":{"ItemType":84}},{"3":{"ItemType":95}},{"3":{"ItemType":109}},{"3":{"ItemType":4}},{"3":{"ItemType":108}},{"3":{"ItemType":112}},{"2":{"Name":"AWS.ECS/TaskDefinition","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":145,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ECS/TaskDefinition@default","ScopeType":0,"Body":152}},{"2":{"Name":"AwsVpcConfiguration","Properties":{"AssignPublicIp":{"Type":4,"Flags":0,"Description":"Whether the task's elastic network interface receives a public IP address. The default value is DISABLED."},"SecurityGroups":{"Type":159,"Flags":0,"Description":"The security groups associated with the task or service. If you do not specify a security group, the default security group for the VPC is used. There is a limit of 5 security groups that can be specified per AwsVpcConfiguration."},"Subnets":{"Type":160,"Flags":1,"Description":"The subnets associated with the task or service. There is a limit of 16 subnets that can be specified per AwsVpcConfiguration."}}}},{"2":{"Name":"LoadBalancer","Properties":{"ContainerName":{"Type":4,"Flags":0,"Description":"The name of the container (as it appears in a container definition) to associate with the load balancer."},"ContainerPort":{"Type":3,"Flags":0,"Description":"The port on the container to associate with the load balancer. This port must correspond to a containerPort in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they are launched on must allow ingress traffic on the hostPort of the port mapping."},"TargetGroupArn":{"Type":4,"Flags":0,"Description":"The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set. A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you are using a Classic Load Balancer this should be omitted. For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html in the Amazon Elastic Container Service Developer Guide. For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-bluegreen.html in the Amazon Elastic Container Service Developer Guide. If your service's task definition uses the awsvpc network mode (which is required for the Fargate launch type), you must choose ip as the target type, not instance, when creating your target groups because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance."}}}},{"2":{"Name":"NetworkConfiguration","Properties":{"AwsVpcConfiguration":{"Type":154,"Flags":0}}}},{"2":{"Name":"Scale","Properties":{"Unit":{"Type":4,"Flags":0,"Description":"The unit of measure for the scale value."},"Value":{"Type":3,"Flags":0,"Description":"The value, specified as a percent total of a service's desiredCount, to scale the task set. Accepted values are numbers between 0 and 100."}}}},{"2":{"Name":"ServiceRegistry","Properties":{"ContainerName":{"Type":4,"Flags":0,"Description":"The container name value, already specified in the task definition, to be used for your service discovery service. If the task definition that your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition that your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value, but not both."},"ContainerPort":{"Type":3,"Flags":0,"Description":"The port value, already specified in the task definition, to be used for your service discovery service. If the task definition your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value, but not both."},"Port":{"Type":3,"Flags":0,"Description":"The port value used if your service discovery service specified an SRV record. This field may be used if both the awsvpc network mode and SRV records are used."},"RegistryArn":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is AWS Cloud Map. For more information, see https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.ECS/TaskSetProperties","Properties":{"Cluster":{"Type":4,"Flags":17,"Description":"The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in."},"ExternalId":{"Type":4,"Flags":0,"Description":"An optional non-unique tag that identifies this task set in external systems. If the task set is associated with a service discovery registry, the tasks in this task set will have the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute set to the provided value. "},"Id":{"Type":4,"Flags":18,"Description":"The ID of the task set."},"LaunchType":{"Type":4,"Flags":0,"Description":"The launch type that new tasks in the task set will use. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html in the Amazon Elastic Container Service Developer Guide. "},"LoadBalancers":{"Type":162,"Flags":0},"NetworkConfiguration":{"Type":156,"Flags":0},"PlatformVersion":{"Type":4,"Flags":0,"Description":"The platform version that the tasks in the task set should use. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used by default."},"Scale":{"Type":157,"Flags":0,"Description":"A floating-point percentage of the desired number of tasks to place and keep running in the task set."},"Service":{"Type":4,"Flags":17,"Description":"The short name or full Amazon Resource Name (ARN) of the service to create the task set in."},"ServiceRegistries":{"Type":163,"Flags":0,"Description":"The details of the service discovery registries to assign to this task set. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html."},"TaskDefinition":{"Type":4,"Flags":1,"Description":"The short name or full Amazon Resource Name (ARN) of the task definition for the tasks in the task set to use."}}}},{"3":{"ItemType":155}},{"3":{"ItemType":158}},{"2":{"Name":"AWS.ECS/TaskSet","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":161,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ECS/TaskSet@default","ScopeType":0,"Body":164}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "AutoScalingGroupProvider", + "properties": { + "AutoScalingGroupArn": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + }, + "ManagedDraining": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "ManagedScaling": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "ManagedTerminationProtection": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ManagedScaling", + "properties": { + "InstanceWarmupPeriod": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "MaximumScalingStepSize": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "MinimumScalingStepSize": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "Status": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "TargetCapacity": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "IntegerType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.ECS/CapacityProviderProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ObjectType", + "name": "AWS.ECS/CapacityProviderProperties", + "properties": { + "AutoScalingGroupProvider": { + "type": { + "$ref": "#/0" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/3" + }, + "flags": 16 + }, + "Tags": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ECS/CapacityProvider", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/7" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ECS/CapacityProvider@default", + "scopeType": 0, + "body": { + "$ref": "#/8" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "CapacityProviderStrategyItem", + "properties": { + "Base": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The *base* value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a *base* defined. If no value is specified, the default value of ``0`` is used." + }, + "CapacityProvider": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The short name of the capacity provider." + }, + "Weight": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The *weight* value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The ``weight`` value is taken into consideration after the ``base`` value, if defined, is satisfied.\n If no ``weight`` value is specified, the default value of ``0`` is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of ``0`` can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of ``0``, any ``RunTask`` or ``CreateService`` actions using the capacity provider strategy will fail.\n An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of ``1``, then when the ``base`` is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of ``1`` for *capacityProviderA* and a weight of ``4`` for *capacityProviderB*, then for every one task that's run using *capacityProviderA*, four tasks would use *capacityProviderB*." + } + } + }, + { + "$type": "ObjectType", + "name": "ClusterConfiguration", + "properties": { + "ExecuteCommandConfiguration": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "The details of the execute command configuration." + }, + "ManagedStorageConfiguration": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "" + } + } + }, + { + "$type": "ObjectType", + "name": "ClusterSettings", + "properties": { + "Name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The name of the cluster setting. The value is ``containerInsights`` ." + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The value to set for the cluster setting. The supported values are ``enabled`` and ``disabled``. \n If you set ``name`` to ``containerInsights`` and ``value`` to ``enabled``, CloudWatch Container Insights will be on for the cluster, otherwise it will be off unless the ``containerInsights`` account setting is turned on. If a cluster value is specified, it will override the ``containerInsights`` value set with [PutAccountSetting](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSetting.html) or [PutAccountSettingDefault](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSettingDefault.html)." + } + } + }, + { + "$type": "ObjectType", + "name": "ExecuteCommandConfiguration", + "properties": { + "KmsKeyId": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "Specify an KMSlong key ID to encrypt the data between the local client and the container." + }, + "LogConfiguration": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket. When ``logging=OVERRIDE`` is specified, a ``logConfiguration`` must be provided." + }, + "Logging": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The log setting to use for redirecting logs for your execute command results. The following log settings are available.\n + ``NONE``: The execute command session is not logged.\n + ``DEFAULT``: The ``awslogs`` configuration in the task definition is used. If no logging parameter is specified, it defaults to this value. If no ``awslogs`` log driver is configured in the task definition, the output won't be logged.\n + ``OVERRIDE``: Specify the logging details as a part of ``logConfiguration``. If the ``OVERRIDE`` logging option is specified, the ``logConfiguration`` is required." + } + } + }, + { + "$type": "ObjectType", + "name": "ExecuteCommandLogConfiguration", + "properties": { + "CloudWatchEncryptionEnabled": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "Determines whether to use encryption on the CloudWatch logs. If not specified, encryption will be off." + }, + "CloudWatchLogGroupName": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The name of the CloudWatch log group to send logs to.\n The CloudWatch log group must already be created." + }, + "S3BucketName": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The name of the S3 bucket to send logs to.\n The S3 bucket must already be created." + }, + "S3EncryptionEnabled": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "Determines whether to use encryption on the S3 logs. If not specified, encryption is not used." + }, + "S3KeyPrefix": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "An optional folder in the S3 bucket to place logs in." + } + } + }, + { + "$type": "ObjectType", + "name": "ManagedStorageConfiguration", + "properties": { + "FargateEphemeralStorageKmsKeyId": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "KmsKeyId": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ServiceConnectDefaults", + "properties": { + "Namespace": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The namespace name or full Amazon Resource Name (ARN) of the CMAPlong namespace that's used when you create a service and don't specify a Service Connect configuration. The namespace name can include up to 1024 characters. The name is case-sensitive. The name can't include hyphens (-), tilde (~), greater than (>), less than (<), or slash (/).\n If you enter an existing namespace name or ARN, then that namespace will be used. Any namespace type is supported. The namespace must be in this account and this AWS Region.\n If you enter a new name, a CMAPlong namespace will be created. Amazon ECS creates a CMAP namespace with the \"API calls\" method of instance discovery only. This instance discovery method is the \"HTTP\" namespace type in the CLIlong. Other types of instance discovery aren't used by Service Connect.\n If you update the cluster with an empty string ``\"\"`` for the namespace name, the cluster configuration for Service Connect is removed. Note that the namespace will remain in CMAP and must be deleted separately.\n For more information about CMAPlong, see [Working with Services](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-services.html) in the *Developer Guide*." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "One part of a key-value pair that make up a tag. A ``key`` is a general label that acts like a category for more specific tag values." + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The optional part of a key-value pair that make up a tag. A ``value`` acts as a descriptor within a tag category (key)." + } + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.ECS/ClusterProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/12" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/10" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/17" + } + }, + { + "$type": "ObjectType", + "name": "AWS.ECS/ClusterProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "" + }, + "CapacityProviders": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "The short name of one or more capacity providers to associate with the cluster. A capacity provider must be associated with a cluster before it can be included as part of the default capacity provider strategy of the cluster or used in a capacity provider strategy when calling the [CreateService](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html) or [RunTask](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html) actions.\n If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must be created but not associated with another cluster. New Auto Scaling group capacity providers can be created with the [CreateCapacityProvider](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCapacityProvider.html) API operation.\n To use a FARGATElong capacity provider, specify either the ``FARGATE`` or ``FARGATE_SPOT`` capacity providers. The FARGATElong capacity providers are available to all accounts and only need to be associated with a cluster to be used.\n The [PutCapacityProvider](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutCapacityProvider.html) API operation is used to update the list of available capacity providers for a cluster after the cluster is created." + }, + "ClusterName": { + "type": { + "$ref": "#/3" + }, + "flags": 16, + "description": "A user-generated string that you use to identify your cluster. If you don't specify a name, CFNlong generates a unique physical ID for the name." + }, + "ClusterSettings": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "The settings to use when creating a cluster. This parameter is used to turn on CloudWatch Container Insights for a cluster." + }, + "Configuration": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The execute command configuration for the cluster." + }, + "DefaultCapacityProviderStrategy": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "The default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used." + }, + "ServiceConnectDefaults": { + "type": { + "$ref": "#/16" + }, + "flags": 4, + "description": "Use this parameter to set a default Service Connect namespace. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the ``enabled`` parameter to ``true`` in the ``ServiceConnectConfiguration``. You can set the namespace of each service individually in the ``ServiceConnectConfiguration`` to override this default parameter.\n Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*." + }, + "Tags": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.\n The following basic restrictions apply to tags:\n + Maximum number of tags per resource - 50\n + For each resource, each tag key must be unique, and each tag key can have only one value.\n + Maximum key length - 128 Unicode characters in UTF-8\n + Maximum value length - 256 Unicode characters in UTF-8\n + If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.\n + Tag keys and values are case-sensitive.\n + Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ECS/Cluster", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/24" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ECS/Cluster@default", + "scopeType": 0, + "body": { + "$ref": "#/25" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "CapacityProvider", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CapacityProviderStrategy", + "properties": { + "Base": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "CapacityProvider": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + }, + "Weight": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CapacityProviders", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Cluster", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DefaultCapacityProviderStrategy", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/28" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.ECS/ClusterCapacityProviderAssociationsProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/28" + } + }, + { + "$type": "ObjectType", + "name": "AWS.ECS/ClusterCapacityProviderAssociationsProperties", + "properties": { + "CapacityProviders": { + "type": { + "$ref": "#/35" + }, + "flags": 1 + }, + "Cluster": { + "type": { + "$ref": "#/3" + }, + "flags": 17 + }, + "DefaultCapacityProviderStrategy": { + "type": { + "$ref": "#/36" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ECS/ClusterCapacityProviderAssociations", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/37" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ECS/ClusterCapacityProviderAssociations@default", + "scopeType": 0, + "body": { + "$ref": "#/38" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.ECS/PrimaryTaskSetProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.ECS/PrimaryTaskSetProperties", + "properties": { + "Cluster": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in." + }, + "Service": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "The short name or full Amazon Resource Name (ARN) of the service to create the task set in." + }, + "TaskSetId": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The ID or full Amazon Resource Name (ARN) of the task set." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ECS/PrimaryTaskSet", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/41" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ECS/PrimaryTaskSet@default", + "scopeType": 0, + "body": { + "$ref": "#/42" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AwsVpcConfiguration", + "properties": { + "AssignPublicIp": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "Whether the task's elastic network interface receives a public IP address. The default value is ``DISABLED``." + }, + "SecurityGroups": { + "type": { + "$ref": "#/67" + }, + "flags": 0, + "description": "The IDs of the security groups associated with the task or service. If you don't specify a security group, the default security group for the VPC is used. There's a limit of 5 security groups that can be specified per ``AwsVpcConfiguration``.\n All specified security groups must be from the same VPC." + }, + "Subnets": { + "type": { + "$ref": "#/68" + }, + "flags": 0, + "description": "The IDs of the subnets associated with the task or service. There's a limit of 16 subnets that can be specified per ``AwsVpcConfiguration``.\n All specified subnets must be from the same VPC." + } + } + }, + { + "$type": "ObjectType", + "name": "CapacityProviderStrategyItem", + "properties": { + "Base": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The *base* value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a *base* defined. If no value is specified, the default value of ``0`` is used." + }, + "CapacityProvider": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The short name of the capacity provider." + }, + "Weight": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The *weight* value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The ``weight`` value is taken into consideration after the ``base`` value, if defined, is satisfied.\n If no ``weight`` value is specified, the default value of ``0`` is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of ``0`` can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of ``0``, any ``RunTask`` or ``CreateService`` actions using the capacity provider strategy will fail.\n An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of ``1``, then when the ``base`` is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of ``1`` for *capacityProviderA* and a weight of ``4`` for *capacityProviderB*, then for every one task that's run using *capacityProviderA*, four tasks would use *capacityProviderB*." + } + } + }, + { + "$type": "ObjectType", + "name": "DeploymentAlarms", + "properties": { + "AlarmNames": { + "type": { + "$ref": "#/69" + }, + "flags": 1, + "description": "One or more CloudWatch alarm names. Use a \",\" to separate the alarms." + }, + "Enable": { + "type": { + "$ref": "#/18" + }, + "flags": 1, + "description": "Determines whether to use the CloudWatch alarm option in the service deployment process." + }, + "Rollback": { + "type": { + "$ref": "#/18" + }, + "flags": 1, + "description": "Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is used, when a service deployment fails, the service is rolled back to the last deployment that completed successfully." + } + } + }, + { + "$type": "ObjectType", + "name": "DeploymentCircuitBreaker", + "properties": { + "Enable": { + "type": { + "$ref": "#/18" + }, + "flags": 1, + "description": "Determines whether to use the deployment circuit breaker logic for the service." + }, + "Rollback": { + "type": { + "$ref": "#/18" + }, + "flags": 1, + "description": "Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is on, when a service deployment fails, the service is rolled back to the last deployment that completed successfully." + } + } + }, + { + "$type": "ObjectType", + "name": "DeploymentConfiguration", + "properties": { + "Alarms": { + "type": { + "$ref": "#/46" + }, + "flags": 0, + "description": "Information about the CloudWatch alarms." + }, + "DeploymentCircuitBreaker": { + "type": { + "$ref": "#/47" + }, + "flags": 0, + "description": "The deployment circuit breaker can only be used for services using the rolling update (``ECS``) deployment type.\n The *deployment circuit breaker* determines whether a service deployment will fail if the service can't reach a steady state. If you use the deployment circuit breaker, a service deployment will transition to a failed state and stop launching new tasks. If you use the rollback option, when a service deployment fails, the service is rolled back to the last deployment that completed successfully. For more information, see [Rolling update](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html) in the *Amazon Elastic Container Service Developer Guide*" + }, + "MaximumPercent": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "If a service is using the rolling update (``ECS``) deployment type, the ``maximumPercent`` parameter represents an upper limit on the number of your service's tasks that are allowed in the ``RUNNING`` or ``PENDING`` state during a deployment, as a percentage of the ``desiredCount`` (rounded down to the nearest integer). This parameter enables you to define the deployment batch size. For example, if your service is using the ``REPLICA`` service scheduler and has a ``desiredCount`` of four tasks and a ``maximumPercent`` value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default ``maximumPercent`` value for a service using the ``REPLICA`` service scheduler is 200%.\n If a service is using either the blue/green (``CODE_DEPLOY``) or ``EXTERNAL`` deployment types and tasks that use the EC2 launch type, the *maximum percent* value is set to the default value and is used to define the upper limit on the number of the tasks in the service that remain in the ``RUNNING`` state while the container instances are in the ``DRAINING`` state. If the tasks in the service use the Fargate launch type, the maximum percent value is not used, although it is returned when describing your service." + }, + "MinimumHealthyPercent": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "If a service is using the rolling update (``ECS``) deployment type, the ``minimumHealthyPercent`` represents a lower limit on the number of your service's tasks that must remain in the ``RUNNING`` state during a deployment, as a percentage of the ``desiredCount`` (rounded up to the nearest integer). This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a ``desiredCount`` of four tasks and a ``minimumHealthyPercent`` of 50%, the service scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks. \n For services that *do not* use a load balancer, the following should be noted:\n + A service is considered healthy if all essential containers within the tasks in the service pass their health checks.\n + If a task has no essential containers with a health check defined, the service scheduler will wait for 40 seconds after a task reaches a ``RUNNING`` state before the task is counted towards the minimum healthy percent total.\n + If a task has one or more essential containers with a health check defined, the service scheduler will wait for the task to reach a healthy status before counting it towards the minimum healthy percent total. A task is considered healthy when all essential containers within the task have passed their health checks. The amount of time the service scheduler can wait for is determined by the container health check settings. \n \n For services that *do* use a load balancer, the following should be noted:\n + If a task has no essential containers with a health check defined, the service scheduler will wait for the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total.\n + If a task has an essential container with a health check defined, the service scheduler will wait for both the task to reach a healthy status and the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total.\n \n If a service is using either the blue/green (``CODE_DEPLOY``) or ``EXTERNAL`` deployment types and is running tasks that use the EC2 launch type, the *minimum healthy percent* value is set to the default value and is used to define the lower limit on the number of the tasks in the service that remain in the ``RUNNING`` state while the container instances are in the ``DRAINING`` state. If a service is using either the blue/green (``CODE_DEPLOY``) or ``EXTERNAL`` deployment types and is running tasks that use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service." + } + } + }, + { + "$type": "ObjectType", + "name": "DeploymentController", + "properties": { + "Type": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The deployment controller type to use. There are three deployment controller types available:\n + ECS The rolling update (ECS) deployment type involves replacing the current running version of the container with the latest version. The number of containers Amazon ECS adds or removes from the service during a rolling update is controlled by adjusting the minimum and maximum number of healthy tasks allowed during a service deployment, as specified in the DeploymentConfiguration. + CODE_DEPLOY The blue/green (CODE_DEPLOY) deployment type uses the blue/green deployment model powered by , which allows you to verify a new deployment of a service before sending production traffic to it. + EXTERNAL The external (EXTERNAL) deployment type enables you to use any third-party deployment controller for full control over the deployment process for an Amazon ECS service." + } + } + }, + { + "$type": "ObjectType", + "name": "EBSTagSpecification", + "properties": { + "PropagateTags": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "Determines whether to propagate the tags from the task definition to ?the Amazon EBS volume. Tags can only propagate to a ``SERVICE`` specified in ?``ServiceVolumeConfiguration``. If no value is specified, the tags aren't ?propagated." + }, + "ResourceType": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The type of volume resource." + }, + "Tags": { + "type": { + "$ref": "#/70" + }, + "flags": 0, + "description": "The tags applied to this Amazon EBS volume. ``AmazonECSCreated`` and ``AmazonECSManaged`` are reserved tags that can't be used." + } + } + }, + { + "$type": "ObjectType", + "name": "LoadBalancer", + "properties": { + "ContainerName": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The name of the container (as it appears in a container definition) to associate with the load balancer.\n You need to specify the container name when configuring the target group for an Amazon ECS load balancer." + }, + "ContainerPort": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The port on the container to associate with the load balancer. This port must correspond to a ``containerPort`` in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they're launched on must allow ingress traffic on the ``hostPort`` of the port mapping." + }, + "LoadBalancerName": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The name of the load balancer to associate with the Amazon ECS service or task set.\n If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted." + }, + "TargetGroupArn": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.\n A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. \n For services using the ``ECS`` deployment controller, you can specify one or multiple target groups. For more information, see [Registering multiple target groups with a service](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html) in the *Amazon Elastic Container Service Developer Guide*.\n For services using the ``CODE_DEPLOY`` deployment controller, you're required to define two target groups for the load balancer. For more information, see [Blue/green deployment with CodeDeploy](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-bluegreen.html) in the *Amazon Elastic Container Service Developer Guide*.\n If your service's task definition uses the ``awsvpc`` network mode, you must choose ``ip`` as the target type, not ``instance``. Do this when creating your target groups because tasks that use the ``awsvpc`` network mode are associated with an elastic network interface, not an Amazon EC2 instance. This network mode is required for the Fargate launch type." + } + } + }, + { + "$type": "ObjectType", + "name": "LogConfiguration", + "properties": { + "LogDriver": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The log driver to use for the container.\n For tasks on FARGATElong, the supported log drivers are ``awslogs``, ``splunk``, and ``awsfirelens``.\n For tasks hosted on Amazon EC2 instances, the supported log drivers are ``awslogs``, ``fluentd``, ``gelf``, ``json-file``, ``journald``, ``logentries``,``syslog``, ``splunk``, and ``awsfirelens``.\n For more information about using the ``awslogs`` log driver, see [Using the awslogs log driver](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html) in the *Amazon Elastic Container Service Developer Guide*.\n For more information about using the ``awsfirelens`` log driver, see [Custom log routing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) in the *Amazon Elastic Container Service Developer Guide*.\n If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's [available on GitHub](https://docs.aws.amazon.com/https://github.com/aws/amazon-ecs-agent) and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we don't currently provide support for running modified copies of this software." + }, + "Options": { + "type": { + "$ref": "#/71" + }, + "flags": 0, + "description": "The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'``" + }, + "SecretOptions": { + "type": { + "$ref": "#/72" + }, + "flags": 0, + "description": "The secrets to pass to the log configuration. For more information, see [Specifying sensitive data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer Guide*." + } + } + }, + { + "$type": "ObjectType", + "name": "NetworkConfiguration", + "properties": { + "AwsvpcConfiguration": { + "type": { + "$ref": "#/44" + }, + "flags": 0, + "description": "The VPC subnets and security groups that are associated with a task.\n All specified subnets and security groups must be from the same VPC." + } + } + }, + { + "$type": "ObjectType", + "name": "PlacementConstraint", + "properties": { + "Expression": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "A cluster query language expression to apply to the constraint. The expression can have a maximum length of 2000 characters. You can't specify an expression if the constraint type is ``distinctInstance``. For more information, see [Cluster query language](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) in the *Amazon Elastic Container Service Developer Guide*." + }, + "Type": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The type of constraint. Use ``distinctInstance`` to ensure that each task in a particular group is running on a different container instance. Use ``memberOf`` to restrict the selection to a group of valid candidates." + } + } + }, + { + "$type": "ObjectType", + "name": "PlacementStrategy", + "properties": { + "Field": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The field to apply the placement strategy against. For the ``spread`` placement strategy, valid values are ``instanceId`` (or ``host``, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as ``attribute:ecs.availability-zone``. For the ``binpack`` placement strategy, valid values are ``CPU`` and ``MEMORY``. For the ``random`` placement strategy, this field is not used." + }, + "Type": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The type of placement strategy. The ``random`` placement strategy randomly places tasks on available candidates. The ``spread`` placement strategy spreads placement across available candidates evenly based on the ``field`` parameter. The ``binpack`` strategy places tasks on available candidates that have the least available amount of the resource that's specified with the ``field`` parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory but still enough to run the task." + } + } + }, + { + "$type": "ObjectType", + "name": "Secret", + "properties": { + "Name": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The name of the secret." + }, + "ValueFrom": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The secret to expose to the container. The supported values are either the full ARN of the ASMlong secret or the full ARN of the parameter in the SSM Parameter Store.\n For information about the require IAMlong permissions, see [Required IAM permissions for Amazon ECS secrets](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-secrets.html#secrets-iam) (for Secrets Manager) or [Required IAM permissions for Amazon ECS secrets](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-parameters.html) (for Systems Manager Parameter store) in the *Amazon Elastic Container Service Developer Guide*.\n If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified." + } + } + }, + { + "$type": "ObjectType", + "name": "ServiceConnectClientAlias", + "properties": { + "DnsName": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The ``dnsName`` is the name that you use in the applications of client tasks to connect to this service. The name must be a valid DNS name but doesn't need to be fully-qualified. The name can include up to 127 characters. The name can include lowercase letters, numbers, underscores (_), hyphens (-), and periods (.). The name can't start with a hyphen.\n If this parameter isn't specified, the default value of ``discoveryName.namespace`` is used. If the ``discoveryName`` isn't specified, the port mapping name from the task definition is used in ``portName.namespace``.\n To avoid changing your applications in client Amazon ECS services, set this to the same name that the client application uses by default. For example, a few common names are ``database``, ``db``, or the lowercase name of a database, such as ``mysql`` or ``redis``. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*." + }, + "Port": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The listening port number for the Service Connect proxy. This port is available inside of all of the tasks within the same namespace.\n To avoid changing your applications in client Amazon ECS services, set this to the same port that the client application uses by default. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*." + } + } + }, + { + "$type": "ObjectType", + "name": "ServiceConnectConfiguration", + "properties": { + "Enabled": { + "type": { + "$ref": "#/18" + }, + "flags": 1, + "description": "Specifies whether to use Service Connect with this service." + }, + "LogConfiguration": { + "type": { + "$ref": "#/52" + }, + "flags": 0, + "description": "The log configuration for the container. This parameter maps to ``LogConfig`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--log-driver`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/commandline/run/).\n By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a different logging driver than the Docker daemon by specifying a log driver configuration in the container definition. For more information about the options for different supported log drivers, see [Configure logging drivers](https://docs.aws.amazon.com/https://docs.docker.com/engine/admin/logging/overview/) in the Docker documentation.\n Understand the following when specifying a log configuration for your containers.\n + Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon. Additional log drivers may be available in future releases of the Amazon ECS container agent.\n For tasks on FARGATElong, the supported log drivers are ``awslogs``, ``splunk``, and ``awsfirelens``.\n For tasks hosted on Amazon EC2 instances, the supported log drivers are ``awslogs``, ``fluentd``, ``gelf``, ``json-file``, ``journald``, ``logentries``,``syslog``, ``splunk``, and ``awsfirelens``.\n + This parameter requires version 1.18 of the Docker Remote API or greater on your container instance.\n + For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container agent must register the available logging drivers with the ``ECS_AVAILABLE_LOGGING_DRIVERS`` environment variable before containers placed on that instance can use these log configuration options. For more information, see [Amazon ECS container agent configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service Developer Guide*.\n + For tasks that are on FARGATElong, because you don't have access to the underlying infrastructure your tasks are hosted on, any additional software needed must be installed outside of the task. For example, the Fluentd output aggregators or a remote host running Logstash to send Gelf logs to." + }, + "Namespace": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The namespace name or full Amazon Resource Name (ARN) of the CMAPlong namespace for use with Service Connect. The namespace must be in the same AWS Region as the Amazon ECS service and cluster. The type of namespace doesn't affect Service Connect. For more information about CMAPlong, see [Working with Services](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-services.html) in the *Developer Guide*." + }, + "Services": { + "type": { + "$ref": "#/73" + }, + "flags": 0, + "description": "The list of Service Connect service objects. These are names and aliases (also known as endpoints) that are used by other Amazon ECS services to connect to this service. \n This field is not required for a \"client\" Amazon ECS service that's a member of a namespace only to connect to other services within the namespace. An example of this would be a frontend application that accepts incoming requests from either a load balancer that's attached to the service or by other means.\n An object selects a port from the task definition, assigns a name for the CMAPlong service, and a list of aliases (endpoints) and ports for client applications to refer to this service." + } + } + }, + { + "$type": "ObjectType", + "name": "ServiceConnectService", + "properties": { + "ClientAliases": { + "type": { + "$ref": "#/74" + }, + "flags": 0, + "description": "The list of client aliases for this Service Connect service. You use these to assign names that can be used by client applications. The maximum number of client aliases that you can have in this list is 1.\n Each alias (\"endpoint\") is a fully-qualified name and port number that other Amazon ECS tasks (\"clients\") can use to connect to this service.\n Each name and port mapping must be unique within the namespace.\n For each ``ServiceConnectService``, you must provide at least one ``clientAlias`` with one ``port``." + }, + "DiscoveryName": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The ``discoveryName`` is the name of the new CMAP service that Amazon ECS creates for this Amazon ECS service. This must be unique within the CMAP namespace. The name can contain up to 64 characters. The name can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen.\n If the ``discoveryName`` isn't specified, the port mapping name from the task definition is used in ``portName.namespace``." + }, + "IngressPortOverride": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The port number for the Service Connect proxy to listen on.\n Use the value of this field to bypass the proxy for traffic on the port number specified in the named ``portMapping`` in the task definition of this application, and then use it in your VPC security groups to allow traffic into the proxy for this Amazon ECS service.\n In ``awsvpc`` mode and Fargate, the default value is the container port number. The container port number is in the ``portMapping`` in the task definition. In bridge mode, the default value is the ephemeral port of the Service Connect proxy." + }, + "PortName": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The ``portName`` must match the name of one of the ``portMappings`` from all the containers in the task definition of this Amazon ECS service." + }, + "Timeout": { + "type": { + "$ref": "#/66" + }, + "flags": 0, + "description": "A reference to an object that represents the configured timeouts for Service Connect." + }, + "Tls": { + "type": { + "$ref": "#/61" + }, + "flags": 0, + "description": "A reference to an object that represents a Transport Layer Security (TLS) configuration." + } + } + }, + { + "$type": "ObjectType", + "name": "ServiceConnectTlsCertificateAuthority", + "properties": { + "AwsPcaAuthorityArn": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The ARN of the AWS Private Certificate Authority certificate." + } + } + }, + { + "$type": "ObjectType", + "name": "ServiceConnectTlsConfiguration", + "properties": { + "IssuerCertificateAuthority": { + "type": { + "$ref": "#/60" + }, + "flags": 1, + "description": "The signer certificate authority." + }, + "KmsKey": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The AWS Key Management Service key." + }, + "RoleArn": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the IAM role that's associated with the Service Connect TLS." + } + } + }, + { + "$type": "ObjectType", + "name": "ServiceManagedEBSVolumeConfiguration", + "properties": { + "Encrypted": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "Indicates whether the volume should be encrypted. If no value is specified, encryption is turned on by default. This parameter maps 1:1 with the ``Encrypted`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*." + }, + "FilesystemType": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The Linux filesystem type for the volume. For volumes created from a snapshot, you must specify the same filesystem type that the volume was using when the snapshot was created. If there is a filesystem type mismatch, the task will fail to start.\n The available filesystem types are? ``ext3``, ``ext4``, and ``xfs``. If no value is specified, the ``xfs`` filesystem type is used by default." + }, + "Iops": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The number of I/O operations per second (IOPS). For ``gp3``, ``io1``, and ``io2`` volumes, this represents the number of IOPS that are provisioned for the volume. For ``gp2`` volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.\n The 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\n \n This parameter is required for ``io1`` and ``io2`` volume types. The default for ``gp3`` volumes is ``3,000 IOPS``. This parameter is not supported for ``st1``, ``sc1``, or ``standard`` volume types.\n This 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 Reference*." + }, + "KmsKeyId": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) identifier of the AWS Key Management Service key to use for Amazon EBS encryption. When encryption is turned on and no AWS Key Management Service key is specified, the default AWS managed key for Amazon EBS volumes is used. This parameter maps 1:1 with the ``KmsKeyId`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*.\n AWS authenticates the AWS Key Management Service key asynchronously. Therefore, if you specify an ID, alias, or ARN that is invalid, the action can appear to complete, but eventually fails." + }, + "RoleArn": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The ARN of the IAM role to associate with this volume. This is the Amazon ECS infrastructure IAM role that is used to manage your AWS infrastructure. We recommend using the Amazon ECS-managed ``AmazonECSInfrastructureRolePolicyForVolumes`` IAM policy with this role. For more information, see [Amazon ECS infrastructure IAM role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/infrastructure_IAM_role.html) in the *Amazon ECS Developer Guide*." + }, + "SizeInGiB": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The size of the volume in GiB. You must specify either a volume size or a snapshot ID. If you specify a snapshot ID, the snapshot size is used for the volume size by default. You can optionally specify a volume size greater than or equal to the snapshot size. This 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 Reference*.\n The 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" + }, + "SnapshotId": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The snapshot that Amazon ECS uses to create the volume. You must specify either a snapshot ID or a volume size. This parameter maps 1:1 with the ``SnapshotId`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*." + }, + "TagSpecifications": { + "type": { + "$ref": "#/75" + }, + "flags": 0, + "description": "The tags to apply to the volume. Amazon ECS applies service-managed tags by default. This parameter maps 1:1 with the ``TagSpecifications.N`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*." + }, + "Throughput": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The throughput to provision for a volume, in MiB/s, with a maximum of 1,000 MiB/s. This 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 Reference*.\n This parameter is only supported for the ``gp3`` volume type." + }, + "VolumeType": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The volume type. This parameter maps 1:1 with the ``VolumeType`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*. For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volume-types.html) in the *Amazon EC2 User Guide*.\n The 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 The magnetic volume type is not supported on Fargate." + } + } + }, + { + "$type": "ObjectType", + "name": "ServiceRegistry", + "properties": { + "ContainerName": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The container name value to be used for your service discovery service. It's already specified in the task definition. If the task definition that your service task specifies uses the ``bridge`` or ``host`` network mode, you must specify a ``containerName`` and ``containerPort`` combination from the task definition. If the task definition that your service task specifies uses the ``awsvpc`` network mode and a type SRV DNS record is used, you must specify either a ``containerName`` and ``containerPort`` combination or a ``port`` value. However, you can't specify both." + }, + "ContainerPort": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The port value to be used for your service discovery service. It's already specified in the task definition. If the task definition your service task specifies uses the ``bridge`` or ``host`` network mode, you must specify a ``containerName`` and ``containerPort`` combination from the task definition. If the task definition your service task specifies uses the ``awsvpc`` network mode and a type SRV DNS record is used, you must specify either a ``containerName`` and ``containerPort`` combination or a ``port`` value. However, you can't specify both." + }, + "Port": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The port value used if your service discovery service specified an SRV record. This field might be used if both the ``awsvpc`` network mode and SRV records are used." + }, + "RegistryArn": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is CMAP. For more information, see [CreateService](https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html)." + } + } + }, + { + "$type": "ObjectType", + "name": "ServiceVolumeConfiguration", + "properties": { + "ManagedEBSVolume": { + "type": { + "$ref": "#/62" + }, + "flags": 0, + "description": "The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf. These settings are used to create each Amazon EBS volume, with one volume created for each task in the service. The Amazon EBS volumes are visible in your account in the Amazon EC2 console once they are created." + }, + "Name": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The name of the volume. This value must match the volume name from the ``Volume`` object in the task definition." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "One part of a key-value pair that make up a tag. A ``key`` is a general label that acts like a category for more specific tag values." + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The optional part of a key-value pair that make up a tag. A ``value`` acts as a descriptor within a tag category (key)." + } + } + }, + { + "$type": "ObjectType", + "name": "TimeoutConfiguration", + "properties": { + "IdleTimeoutSeconds": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The amount of time in seconds a connection will stay active while idle. A value of ``0`` can be set to disable ``idleTimeout``.\n The ``idleTimeout`` default for ``HTTP``/``HTTP2``/``GRPC`` is 5 minutes.\n The ``idleTimeout`` default for ``TCP`` is 1 hour." + }, + "PerRequestTimeoutSeconds": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The amount of time waiting for the upstream to respond with a complete response per request. A value of ``0`` can be set to disable ``perRequestTimeout``. ``perRequestTimeout`` can only be set if Service Connect ``appProtocol`` isn't ``TCP``. Only ``idleTimeout`` is allowed for ``TCP`` ``appProtocol``." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/65" + } + }, + { + "$type": "ObjectType", + "name": "Service_Options", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/56" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/59" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/57" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/50" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.ECS/ServiceProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/45" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/51" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/54" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/55" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/63" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/65" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/64" + } + }, + { + "$type": "ObjectType", + "name": "AWS.ECS/ServiceProperties", + "properties": { + "CapacityProviderStrategy": { + "type": { + "$ref": "#/77" + }, + "flags": 0, + "description": "The capacity provider strategy to use for the service.\n If a ``capacityProviderStrategy`` is specified, the ``launchType`` parameter must be omitted. If no ``capacityProviderStrategy`` or ``launchType`` is specified, the ``defaultCapacityProviderStrategy`` for the cluster is used.\n A capacity provider strategy may contain a maximum of 6 capacity providers." + }, + "Cluster": { + "type": { + "$ref": "#/3" + }, + "flags": 16, + "description": "The short name or full Amazon Resource Name (ARN) of the cluster that you run your service on. If you do not specify a cluster, the default cluster is assumed." + }, + "DeploymentConfiguration": { + "type": { + "$ref": "#/48" + }, + "flags": 0, + "description": "Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks." + }, + "DeploymentController": { + "type": { + "$ref": "#/49" + }, + "flags": 0, + "description": "The deployment controller to use for the service. If no deployment controller is specified, the default value of ``ECS`` is used." + }, + "DesiredCount": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The number of instantiations of the specified task definition to place and keep running in your service.\n For new services, if a desired count is not specified, a default value of ``1`` is used. When using the ``DAEMON`` scheduling strategy, the desired count is not required.\n For existing services, if a desired count is not specified, it is omitted from the operation." + }, + "EnableECSManagedTags": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "Specifies whether to turn on Amazon ECS managed tags for the tasks within the service. For more information, see [Tagging your Amazon ECS resources](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) in the *Amazon Elastic Container Service Developer Guide*.\n When you use Amazon ECS managed tags, you need to set the ``propagateTags`` request parameter." + }, + "EnableExecuteCommand": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "Determines whether the execute command functionality is turned on for the service. If ``true``, the execute command functionality is turned on for all containers in tasks as part of the service." + }, + "HealthCheckGracePeriodSeconds": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started. This is only used when your service is configured to use a load balancer. If your service has a load balancer defined and you don't specify a health check grace period value, the default value of ``0`` is used.\n If you do not use an Elastic Load Balancing, we recommend that you use the ``startPeriod`` in the task definition health check parameters. For more information, see [Health check](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_HealthCheck.html).\n If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds (about 69 years). During that time, the Amazon ECS service scheduler ignores health check status. This grace period can prevent the service scheduler from marking tasks as unhealthy and stopping them before they have time to come up." + }, + "LaunchType": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The launch type on which to run your service. For more information, see [Amazon ECS Launch Types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer Guide*." + }, + "LoadBalancers": { + "type": { + "$ref": "#/78" + }, + "flags": 0, + "description": "A list of load balancer objects to associate with the service. If you specify the ``Role`` property, ``LoadBalancers`` must be specified as well. For information about the number of load balancers that you can specify per service, see [Service Load Balancing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html) in the *Amazon Elastic Container Service Developer Guide*." + }, + "Name": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "" + }, + "NetworkConfiguration": { + "type": { + "$ref": "#/53" + }, + "flags": 0, + "description": "The network configuration for the service. This parameter is required for task definitions that use the ``awsvpc`` network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*." + }, + "PlacementConstraints": { + "type": { + "$ref": "#/79" + }, + "flags": 0, + "description": "An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints for each task. This limit includes constraints in the task definition and those specified at runtime." + }, + "PlacementStrategies": { + "type": { + "$ref": "#/80" + }, + "flags": 0, + "description": "The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules for each service." + }, + "PlatformVersion": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The platform version that your tasks in the service are running on. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the ``LATEST`` platform version is used. For more information, see [platform versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) in the *Amazon Elastic Container Service Developer Guide*." + }, + "PropagateTags": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the task during 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.\n The default is ``NONE``." + }, + "Role": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition doesn't use the ``awsvpc`` network mode. If you specify the ``role`` parameter, you must also specify a load balancer object with the ``loadBalancers`` parameter.\n If your account has already created the Amazon ECS service-linked role, that role is used for your service unless you specify a role here. The service-linked role is required if your task definition uses the ``awsvpc`` network mode or if the service is configured to use service discovery, an external deployment controller, multiple target groups, or Elastic Inference accelerators in which case you don't specify a role here. For more information, see [Using service-linked roles for Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html) in the *Amazon Elastic Container Service Developer Guide*.\n If your specified role has a path other than ``/``, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name ``bar`` has a path of ``/foo/`` then you would specify ``/foo/bar`` as the role name. For more information, see [Friendly names and paths](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names) in the *IAM User Guide*." + }, + "SchedulingStrategy": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The scheduling strategy to use for the service. For more information, see [Services](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html).\n There are two service scheduler strategies available:\n + ``REPLICA``-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. This scheduler strategy is required if the service uses the ``CODE_DEPLOY`` or ``EXTERNAL`` deployment controller types.\n + ``DAEMON``-The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that don't meet the placement constraints. When you're using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies.\n Tasks using the Fargate launch type or the ``CODE_DEPLOY`` or ``EXTERNAL`` deployment controller types don't support the ``DAEMON`` scheduling strategy." + }, + "ServiceArn": { + "type": { + "$ref": "#/3" + }, + "flags": 18, + "description": "" + }, + "ServiceConnectConfiguration": { + "type": { + "$ref": "#/58" + }, + "flags": 4, + "description": "The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.\n Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*." + }, + "ServiceName": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.\n The stack update fails if you change any properties that require replacement and the ``ServiceName`` is configured. This is because AWS CloudFormation creates the replacement service first, but each ``ServiceName`` must be unique in the cluster." + }, + "ServiceRegistries": { + "type": { + "$ref": "#/81" + }, + "flags": 0, + "description": "The details of the service discovery registry to associate with this service. For more information, see [Service discovery](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html).\n Each service may be associated with one service registry. Multiple service registries for each service isn't supported." + }, + "Tags": { + "type": { + "$ref": "#/82" + }, + "flags": 0, + "description": "The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as well.\n The following basic restrictions apply to tags:\n + Maximum number of tags per resource - 50\n + For each resource, each tag key must be unique, and each tag key can have only one value.\n + Maximum key length - 128 Unicode characters in UTF-8\n + Maximum value length - 256 Unicode characters in UTF-8\n + If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.\n + Tag keys and values are case-sensitive.\n + Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit." + }, + "TaskDefinition": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The ``family`` and ``revision`` (``family:revision``) or full ARN of the task definition to run in your service. If a ``revision`` isn't specified, the latest ``ACTIVE`` revision is used.\n A task definition must be specified if the service uses either the ``ECS`` or ``CODE_DEPLOY`` deployment controllers.\n For more information about deployment types, see [Amazon ECS deployment types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html)." + }, + "VolumeConfigurations": { + "type": { + "$ref": "#/83" + }, + "flags": 4, + "description": "The configuration for a volume specified in the task definition as a volume that is configured at launch time. Currently, the only supported volume type is an Amazon EBS volume." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ECS/Service", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/84" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ECS/Service@default", + "scopeType": 0, + "body": { + "$ref": "#/85" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AuthorizationConfig", + "properties": { + "AccessPointId": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the ``EFSVolumeConfiguration`` must either be omitted or set to ``/`` which will enforce the path set on the EFS access point. If an access point is used, transit encryption must be on in the ``EFSVolumeConfiguration``. For more information, see [Working with Amazon EFS access points](https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html) in the *Amazon Elastic File System User Guide*." + }, + "IAM": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "Determines whether to use the Amazon ECS task role defined in a task definition when mounting the Amazon EFS file system. If it is turned on, transit encryption must be turned on in the ``EFSVolumeConfiguration``. If this parameter is omitted, the default value of ``DISABLED`` is used. For more information, see [Using Amazon EFS access points](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/efs-volumes.html#efs-volume-accesspoints) in the *Amazon Elastic Container Service Developer Guide*." + } + } + }, + { + "$type": "ObjectType", + "name": "ContainerDefinition", + "properties": { + "Command": { + "type": { + "$ref": "#/120" + }, + "flags": 0, + "description": "The command that's passed to the container. This parameter maps to ``Cmd`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``COMMAND`` parameter to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). For more information, see [https://docs.docker.com/engine/reference/builder/#cmd](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/builder/#cmd). If there are multiple arguments, each argument is a separated string in the array." + }, + "Cpu": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The number of ``cpu`` units reserved for the container. This parameter maps to ``CpuShares`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--cpu-shares`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-level ``cpu`` value.\n You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the [Amazon EC2 Instances](https://docs.aws.amazon.com/ec2/instance-types/) detail page by 1,024.\n Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that's the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task is guaranteed a minimum of 512 CPU units when needed. Moreover, each container could float to higher CPU usage if the other container was not using it. If both tasks were 100% active all of the time, they would be limited to 512 CPU units.\n On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see [CPU share constraint](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#cpu-share-constraint) in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2. However, the CPU parameter isn't required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:\n + *Agent versions less than or equal to 1.1.0:* Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to two CPU shares.\n + *Agent versions greater than or equal to 1.2.0:* Null, zero, and CPU values of 1 are passed to Docker as 2.\n \n On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that's described in the task definition. A null or zero CPU value is passed to Docker as ``0``, which Windows interprets as 1% of one CPU." + }, + "CredentialSpecs": { + "type": { + "$ref": "#/121" + }, + "flags": 0, + "description": "A list of ARNs in SSM or Amazon S3 to a credential spec (``CredSpec``) file that configures the container for Active Directory authentication. We recommend that you use this parameter instead of the ``dockerSecurityOptions``. The maximum number of ARNs is 1.\n There are two formats for each ARN.\n + credentialspecdomainless:MyARN You use credentialspecdomainless:MyARN to provide a CredSpec with an additional section for a secret in . You provide the login credentials to the domain in the secret. Each task that runs on any container instance can join different domains. You can use this format without joining the container instance to a domain. + credentialspec:MyARN You use credentialspec:MyARN to provide a CredSpec for a single domain. You must join the container instance to the domain before you start any tasks that use this task definition. \n In both formats, replace ``MyARN`` with the ARN in SSM or Amazon S3.\n If you provide a ``credentialspecdomainless:MyARN``, the ``credspec`` must provide a ARN in ASMlong for a secret containing the username, password, and the domain to connect to. For better security, the instance isn't joined to the domain for domainless authentication. Other applications on the instance can't use the domainless credentials. You can use this parameter to run tasks on the same instance, even it the tasks need to join different domains. For more information, see [Using gMSAs for Windows Containers](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows-gmsa.html) and [Using gMSAs for Linux Containers](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/linux-gmsa.html)." + }, + "DependsOn": { + "type": { + "$ref": "#/122" + }, + "flags": 0, + "description": "The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed.\n For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to turn on container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the *Amazon Elastic Container Service Developer Guide*. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ``ecs-init`` package. If your container instances are launched from version ``20190301`` or later, then they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*.\n For tasks using the Fargate launch type, the task or service requires the following platforms:\n + Linux platform version ``1.3.0`` or later.\n + Windows platform version ``1.0.0`` or later.\n \n If the task definition is used in a blue/green deployment that uses [AWS::CodeDeploy::DeploymentGroup BlueGreenDeploymentConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-bluegreendeploymentconfiguration.html), the ``dependsOn`` parameter is not supported. For more information see [Issue #680](https://docs.aws.amazon.com/https://github.com/aws-cloudformation/cloudformation-coverage-roadmap/issues/680) on the on the GitHub website." + }, + "DisableNetworking": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "When this parameter is true, networking is off within the container. This parameter maps to ``NetworkDisabled`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/).\n This parameter is not supported for Windows containers." + }, + "DnsSearchDomains": { + "type": { + "$ref": "#/123" + }, + "flags": 0, + "description": "A list of DNS search domains that are presented to the container. This parameter maps to ``DnsSearch`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--dns-search`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n This parameter is not supported for Windows containers." + }, + "DnsServers": { + "type": { + "$ref": "#/124" + }, + "flags": 0, + "description": "A list of DNS servers that are presented to the container. This parameter maps to ``Dns`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--dns`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n This parameter is not supported for Windows containers." + }, + "DockerLabels": { + "type": { + "$ref": "#/125" + }, + "flags": 0, + "description": "A key/value map of labels to add to the container. This parameter maps to ``Labels`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--label`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'``" + }, + "DockerSecurityOptions": { + "type": { + "$ref": "#/126" + }, + "flags": 0, + "description": "A list of strings to provide custom configuration for multiple security systems. For more information about valid values, see [Docker Run Security Configuration](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). This field isn't valid for containers in tasks using the Fargate launch type.\n For Linux tasks on EC2, this parameter can be used to reference custom labels for SELinux and AppArmor multi-level security systems.\n For any tasks on EC2, this parameter can be used to reference a credential spec file that configures a container for Active Directory authentication. For more information, see [Using gMSAs for Windows Containers](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows-gmsa.html) and [Using gMSAs for Linux Containers](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/linux-gmsa.html) in the *Amazon Elastic Container Service Developer Guide*.\n This parameter maps to ``SecurityOpt`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--security-opt`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n The Amazon ECS container agent running on a container instance must register with the ``ECS_SELINUX_CAPABLE=true`` or ``ECS_APPARMOR_CAPABLE=true`` environment variables before containers placed on that instance can use these security options. For more information, see [Amazon ECS Container Agent Configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service Developer Guide*.\n For more information about valid values, see [Docker Run Security Configuration](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). \n Valid values: \"no-new-privileges\" | \"apparmor:PROFILE\" | \"label:value\" | \"credentialspec:CredentialSpecFilePath\"" + }, + "EntryPoint": { + "type": { + "$ref": "#/127" + }, + "flags": 0, + "description": "Early versions of the Amazon ECS container agent don't properly handle ``entryPoint`` parameters. If you have problems using ``entryPoint``, update your container agent or enter your commands and arguments as ``command`` array items instead.\n The entry point that's passed to the container. This parameter maps to ``Entrypoint`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--entrypoint`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). For more information, see [https://docs.docker.com/engine/reference/builder/#entrypoint](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/builder/#entrypoint)." + }, + "Environment": { + "type": { + "$ref": "#/128" + }, + "flags": 0, + "description": "The environment variables to pass to a container. This parameter maps to ``Env`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--env`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n We don't recommend that you use plaintext environment variables for sensitive information, such as credential data." + }, + "EnvironmentFiles": { + "type": { + "$ref": "#/129" + }, + "flags": 0, + "description": "A list of files containing the environment variables to pass to a container. This parameter maps to the ``--env-file`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n You can specify up to ten environment files. The file must have a ``.env`` file extension. Each line in an environment file contains an environment variable in ``VARIABLE=VALUE`` format. Lines beginning with ``#`` are treated as comments and are ignored. For more information about the environment variable file syntax, see [Declare default environment variables in file](https://docs.aws.amazon.com/https://docs.docker.com/compose/env-file/).\n If there are environment variables specified using the ``environment`` parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they're processed from the top down. We recommend that you use unique variable names. For more information, see [Specifying Environment Variables](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html) in the *Amazon Elastic Container Service Developer Guide*." + }, + "Essential": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "If the ``essential`` parameter of a container is marked as ``true``, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the ``essential`` parameter of a container is marked as ``false``, its failure doesn't affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.\n All tasks must have at least one essential container. If you have an application that's composed of multiple containers, group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see [Application Architecture](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/application_architecture.html) in the *Amazon Elastic Container Service Developer Guide*." + }, + "ExtraHosts": { + "type": { + "$ref": "#/130" + }, + "flags": 0, + "description": "A list of hostnames and IP address mappings to append to the ``/etc/hosts`` file on the container. This parameter maps to ``ExtraHosts`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--add-host`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n This parameter isn't supported for Windows containers or tasks that use the ``awsvpc`` network mode." + }, + "FirelensConfiguration": { + "type": { + "$ref": "#/97" + }, + "flags": 0, + "description": "The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see [Custom Log Routing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) in the *Amazon Elastic Container Service Developer Guide*." + }, + "HealthCheck": { + "type": { + "$ref": "#/98" + }, + "flags": 0, + "description": "The container health check command and associated configuration parameters for the container. This parameter maps to ``HealthCheck`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``HEALTHCHECK`` parameter of [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration)." + }, + "Hostname": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The hostname to use for your container. This parameter maps to ``Hostname`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--hostname`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n The ``hostname`` parameter is not supported if you're using the ``awsvpc`` network mode." + }, + "Image": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The image used to start a container. This string is passed directly to the Docker daemon. By default, images in the Docker Hub registry are available. Other repositories are specified with either ``repository-url/image:tag`` or ``repository-url/image@digest``. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to ``Image`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``IMAGE`` parameter of [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n + When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image aren't propagated to already running tasks.\n + Images in Amazon ECR repositories can be specified by either using the full ``registry/repository:tag`` or ``registry/repository@digest``. For example, ``012345678910.dkr.ecr..amazonaws.com/:latest`` or ``012345678910.dkr.ecr..amazonaws.com/@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE``. \n + Images in official repositories on Docker Hub use a single name (for example, ``ubuntu`` or ``mongo``).\n + Images in other repositories on Docker Hub are qualified with an organization name (for example, ``amazon/amazon-ecs-agent``).\n + Images in other online repositories are qualified further by a domain name (for example, ``quay.io/assemblyline/ubuntu``)." + }, + "Interactive": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "When this parameter is ``true``, you can deploy containerized applications that require ``stdin`` or a ``tty`` to be allocated. This parameter maps to ``OpenStdin`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--interactive`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration)." + }, + "Links": { + "type": { + "$ref": "#/131" + }, + "flags": 0, + "description": "The ``links`` parameter allows containers to communicate with each other without the need for port mappings. This parameter is only supported if the network mode of a task definition is ``bridge``. The ``name:internalName`` construct is analogous to ``name:alias`` in Docker links. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. For more information about linking Docker containers, go to [Legacy container links](https://docs.aws.amazon.com/https://docs.docker.com/network/links/) in the Docker documentation. This parameter maps to ``Links`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--link`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n This parameter is not supported for Windows containers.\n Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings." + }, + "LinuxParameters": { + "type": { + "$ref": "#/104" + }, + "flags": 0, + "description": "Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information see [KernelCapabilities](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html).\n This parameter is not supported for Windows containers." + }, + "LogConfiguration": { + "type": { + "$ref": "#/105" + }, + "flags": 0, + "description": "The log configuration specification for the container.\n This parameter maps to ``LogConfig`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--log-driver`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/). By default, containers use the same logging driver that the Docker daemon uses. However, the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see [Configure logging drivers](https://docs.aws.amazon.com/https://docs.docker.com/engine/admin/logging/overview/) in the Docker documentation.\n Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the [LogConfiguration](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_LogConfiguration.html) data type). Additional log drivers may be available in future releases of the Amazon ECS container agent.\n This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'`` \n The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ``ECS_AVAILABLE_LOGGING_DRIVERS`` environment variable before containers placed on that instance can use these log configuration options. For more information, see [Amazon ECS Container Agent Configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service Developer Guide*." + }, + "Memory": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The amount (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. The total amount of memory reserved for all containers within a task must be lower than the task ``memory`` value, if one is specified. This parameter maps to ``Memory`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--memory`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n If using the Fargate launch type, this parameter is optional.\n If using the EC2 launch type, you must specify either a task-level memory value or a container-level memory value. If you specify both a container-level ``memory`` and ``memoryReservation`` value, ``memory`` must be greater than ``memoryReservation``. If you specify ``memoryReservation``, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value of ``memory`` is used.\n The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container, so you should not specify fewer than 6 MiB of memory for your containers.\n The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers." + }, + "MemoryReservation": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the ``memory`` parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps to ``MemoryReservation`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--memory-reservation`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n If a task-level memory value is not specified, you must specify a non-zero integer for one or both of ``memory`` or ``memoryReservation`` in a container definition. If you specify both, ``memory`` must be greater than ``memoryReservation``. If you specify ``memoryReservation``, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value of ``memory`` is used.\n For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a ``memoryReservation`` of 128 MiB, and a ``memory`` hard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed.\n The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers. \n The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers." + }, + "MountPoints": { + "type": { + "$ref": "#/132" + }, + "flags": 0, + "description": "The mount points for data volumes in your container.\n This parameter maps to ``Volumes`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--volume`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n Windows containers can mount whole directories on the same drive as ``$env:ProgramData``. Windows containers can't mount directories on a different drive, and mount point can't be across drives." + }, + "Name": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The name of a container. If you're linking multiple containers together in a task definition, the ``name`` of one container can be entered in the ``links`` of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter maps to ``name`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--name`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration)." + }, + "PortMappings": { + "type": { + "$ref": "#/133" + }, + "flags": 0, + "description": "The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic.\n For task definitions that use the ``awsvpc`` network mode, you should only specify the ``containerPort``. The ``hostPort`` can be left blank or it must be the same value as the ``containerPort``.\n Port mappings on Windows use the ``NetNAT`` gateway address rather than ``localhost``. There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself. \n This parameter maps to ``PortBindings`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--publish`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/). If the network mode of a task definition is set to ``none``, then you can't specify port mappings. If the network mode of a task definition is set to ``host``, then host ports must either be undefined or they must match the container port in the port mapping.\n After a task reaches the ``RUNNING`` status, manual and automatic host and container port assignments are visible in the *Network Bindings* section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in the ``networkBindings`` section [DescribeTasks](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html) responses." + }, + "Privileged": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "When this parameter is true, the container is given elevated privileges on the host container instance (similar to the ``root`` user). This parameter maps to ``Privileged`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--privileged`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n This parameter is not supported for Windows containers or tasks run on FARGATElong." + }, + "PseudoTerminal": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "When this parameter is ``true``, a TTY is allocated. This parameter maps to ``Tty`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--tty`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration)." + }, + "ReadonlyRootFilesystem": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ``ReadonlyRootfs`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--read-only`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n This parameter is not supported for Windows containers." + }, + "RepositoryCredentials": { + "type": { + "$ref": "#/109" + }, + "flags": 0, + "description": "The private repository authentication credentials to use." + }, + "ResourceRequirements": { + "type": { + "$ref": "#/134" + }, + "flags": 0, + "description": "The type and amount of a resource to assign to a container. The only supported resource is a GPU." + }, + "Secrets": { + "type": { + "$ref": "#/135" + }, + "flags": 0, + "description": "The secrets to pass to the container. For more information, see [Specifying Sensitive Data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer Guide*." + }, + "StartTimeout": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Time duration (in seconds) to wait before giving up on resolving dependencies for a container. For example, you specify two containers in a task definition with containerA having a dependency on containerB reaching a ``COMPLETE``, ``SUCCESS``, or ``HEALTHY`` status. If a ``startTimeout`` value is specified for containerB and it doesn't reach the desired status within that time then containerA gives up and not start. This results in the task transitioning to a ``STOPPED`` state.\n When the ``ECS_CONTAINER_START_TIMEOUT`` container agent configuration variable is used, it's enforced independently from this start timeout value.\n For tasks using the Fargate launch type, the task or service requires the following platforms:\n + Linux platform version ``1.3.0`` or later.\n + Windows platform version ``1.0.0`` or later.\n \n For tasks using the EC2 launch type, your container instances require at least version ``1.26.0`` of the container agent to use a container start timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the *Amazon Elastic Container Service Developer Guide*. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version ``1.26.0-1`` of the ``ecs-init`` package. If your container instances are launched from version ``20190301`` or later, then they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*.\n The valid values are 2-120 seconds." + }, + "StopTimeout": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own.\n For tasks using the Fargate launch type, the task or service requires the following platforms:\n + Linux platform version ``1.3.0`` or later.\n + Windows platform version ``1.0.0`` or later.\n \n The max stop timeout value is 120 seconds and if the parameter is not specified, the default value of 30 seconds is used.\n For tasks that use the EC2 launch type, if the ``stopTimeout`` parameter isn't specified, the value set for the Amazon ECS container agent configuration variable ``ECS_CONTAINER_STOP_TIMEOUT`` is used. If neither the ``stopTimeout`` parameter or the ``ECS_CONTAINER_STOP_TIMEOUT`` agent configuration variable are set, then the default values of 30 seconds for Linux containers and 30 seconds on Windows containers are used. Your container instances require at least version 1.26.0 of the container agent to use a container stop timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the *Amazon Elastic Container Service Developer Guide*. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ``ecs-init`` package. If your container instances are launched from version ``20190301`` or later, then they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*.\n The valid values are 2-120 seconds." + }, + "SystemControls": { + "type": { + "$ref": "#/136" + }, + "flags": 0, + "description": "A list of namespaced kernel parameters to set in the container. This parameter maps to ``Sysctls`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--sysctl`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). For example, you can configure ``net.ipv4.tcp_keepalive_time`` setting to maintain longer lived connections." + }, + "Ulimits": { + "type": { + "$ref": "#/137" + }, + "flags": 0, + "description": "A list of ``ulimits`` to set in the container. This parameter maps to ``Ulimits`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--ulimit`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/). Valid naming values are displayed in the [Ulimit](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Ulimit.html) data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'`` \n This parameter is not supported for Windows containers." + }, + "User": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The user to use inside the container. This parameter maps to ``User`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--user`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n When running tasks using the ``host`` network mode, don't run containers using the root user (UID 0). We recommend using a non-root user for better security.\n You can specify the ``user`` using the following formats. If specifying a UID or GID, you must specify it as a positive integer.\n + ``user`` \n + ``user:group`` \n + ``uid`` \n + ``uid:gid`` \n + ``user:gid`` \n + ``uid:group`` \n \n This parameter is not supported for Windows containers." + }, + "VolumesFrom": { + "type": { + "$ref": "#/138" + }, + "flags": 0, + "description": "Data volumes to mount from another container. This parameter maps to ``VolumesFrom`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--volumes-from`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration)." + }, + "WorkingDirectory": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The working directory to run commands inside the container in. This parameter maps to ``WorkingDir`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--workdir`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration)." + } + } + }, + { + "$type": "ObjectType", + "name": "ContainerDependency", + "properties": { + "Condition": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The dependency condition of the container. The following are the available conditions and their behavior:\n + ``START`` - This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start.\n + ``COMPLETE`` - This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition can't be set on an essential container.\n + ``SUCCESS`` - This condition is the same as ``COMPLETE``, but it also requires that the container exits with a ``zero`` status. This condition can't be set on an essential container.\n + ``HEALTHY`` - This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confirmed only at task startup." + }, + "ContainerName": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The name of a container." + } + } + }, + { + "$type": "ObjectType", + "name": "Device", + "properties": { + "ContainerPath": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The path inside the container at which to expose the host device." + }, + "HostPath": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The path for the device on the host container instance." + }, + "Permissions": { + "type": { + "$ref": "#/139" + }, + "flags": 0, + "description": "The explicit permissions to provide to the container for the device. By default, the container has permissions for ``read``, ``write``, and ``mknod`` for the device." + } + } + }, + { + "$type": "ObjectType", + "name": "DockerVolumeConfiguration", + "properties": { + "Autoprovision": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "If this value is ``true``, the Docker volume is created if it doesn't already exist.\n This field is only used if the ``scope`` is ``shared``." + }, + "Driver": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use ``docker plugin ls`` to retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. For more information, see [Docker plugin discovery](https://docs.aws.amazon.com/https://docs.docker.com/engine/extend/plugin_api/#plugin-discovery). This parameter maps to ``Driver`` in the [Create a volume](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``xxdriver`` option to [docker volume create](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/commandline/volume_create/)." + }, + "DriverOpts": { + "type": { + "$ref": "#/140" + }, + "flags": 0, + "description": "A map of Docker driver-specific options passed through. This parameter maps to ``DriverOpts`` in the [Create a volume](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``xxopt`` option to [docker volume create](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/commandline/volume_create/)." + }, + "Labels": { + "type": { + "$ref": "#/141" + }, + "flags": 0, + "description": "Custom metadata to add to your Docker volume. This parameter maps to ``Labels`` in the [Create a volume](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``xxlabel`` option to [docker volume create](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/commandline/volume_create/)." + }, + "Scope": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a ``task`` are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped as ``shared`` persist after the task stops." + } + } + }, + { + "$type": "ObjectType", + "name": "EFSVolumeConfiguration", + "properties": { + "AuthorizationConfig": { + "type": { + "$ref": "#/87" + }, + "flags": 0, + "description": "The authorization configuration details for the Amazon EFS file system." + }, + "FilesystemId": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The Amazon EFS file system ID to use." + }, + "RootDirectory": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume will be used. Specifying ``/`` will have the same effect as omitting this parameter.\n If an EFS access point is specified in the ``authorizationConfig``, the root directory parameter must either be omitted or set to ``/`` which will enforce the path set on the EFS access point." + }, + "TransitEncryption": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be turned on if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of ``DISABLED`` is used. For more information, see [Encrypting data in transit](https://docs.aws.amazon.com/efs/latest/ug/encryption-in-transit.html) in the *Amazon Elastic File System User Guide*." + }, + "TransitEncryptionPort": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses. For more information, see [EFS mount helper](https://docs.aws.amazon.com/efs/latest/ug/efs-mount-helper.html) in the *Amazon Elastic File System User Guide*." + } + } + }, + { + "$type": "ObjectType", + "name": "EnvironmentFile", + "properties": { + "Type": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The file type to use. Environment files are objects in Amazon S3. The only supported value is ``s3``." + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file." + } + } + }, + { + "$type": "ObjectType", + "name": "EphemeralStorage", + "properties": { + "SizeInGiB": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is ``20`` GiB and the maximum supported value is ``200`` GiB." + } + } + }, + { + "$type": "ObjectType", + "name": "FSxAuthorizationConfig", + "properties": { + "CredentialsParameter": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "" + }, + "Domain": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "" + } + } + }, + { + "$type": "ObjectType", + "name": "FSxWindowsFileServerVolumeConfiguration", + "properties": { + "AuthorizationConfig": { + "type": { + "$ref": "#/95" + }, + "flags": 0, + "description": "The authorization configuration details for the Amazon FSx for Windows File Server file system." + }, + "FileSystemId": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The Amazon FSx for Windows File Server file system ID to use." + }, + "RootDirectory": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host." + } + } + }, + { + "$type": "ObjectType", + "name": "FirelensConfiguration", + "properties": { + "Options": { + "type": { + "$ref": "#/142" + }, + "flags": 0, + "description": "The options to use when configuring the log router. This field is optional and can be used to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event.\n If specified, valid option keys are:\n + ``enable-ecs-log-metadata``, which can be ``true`` or ``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" + }, + "Type": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The log router to use. The valid values are ``fluentd`` or ``fluentbit``." + } + } + }, + { + "$type": "ObjectType", + "name": "HealthCheck", + "properties": { + "Command": { + "type": { + "$ref": "#/143" + }, + "flags": 0, + "description": "A string array representing the command that the container runs to determine if it is healthy. The string array must start with ``CMD`` to run the command arguments directly, or ``CMD-SHELL`` to run the command with the container's default shell. \n When you use the AWS Management Console JSON panel, the CLIlong, or the APIs, enclose the list of commands in double quotes and brackets.\n ``[ \"CMD-SHELL\", \"curl -f http://localhost/ || exit 1\" ]`` \n You don't include the double quotes and brackets when you use the AWS Management Console.\n ``CMD-SHELL, curl -f http://localhost/ || exit 1`` \n An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, see ``HealthCheck`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/)." + }, + "Interval": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds." + }, + "Retries": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3." + }, + "StartPeriod": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The optional grace period to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You can specify between 0 and 300 seconds. By default, the ``startPeriod`` is off.\n If a health check succeeds within the ``startPeriod``, then the container is considered healthy and any subsequent failures count toward the maximum number of retries." + }, + "Timeout": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5." + } + } + }, + { + "$type": "ObjectType", + "name": "HostEntry", + "properties": { + "Hostname": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The hostname to use in the ``/etc/hosts`` entry." + }, + "IpAddress": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The IP address to use in the ``/etc/hosts`` entry." + } + } + }, + { + "$type": "ObjectType", + "name": "HostVolumeProperties", + "properties": { + "SourcePath": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "When the ``host`` parameter is used, specify a ``sourcePath`` to declare the path on the host container instance that's presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the ``host`` parameter contains a ``sourcePath`` file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the ``sourcePath`` value doesn't exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.\n If you're using the Fargate launch type, the ``sourcePath`` parameter is not supported." + } + } + }, + { + "$type": "ObjectType", + "name": "InferenceAccelerator", + "properties": { + "DeviceName": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The Elastic Inference accelerator device name. The ``deviceName`` must also be referenced in a container definition as a [ResourceRequirement](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ResourceRequirement.html)." + }, + "DeviceType": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The Elastic Inference accelerator type to use." + } + } + }, + { + "$type": "ObjectType", + "name": "KernelCapabilities", + "properties": { + "Add": { + "type": { + "$ref": "#/144" + }, + "flags": 0, + "description": "The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to ``CapAdd`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--cap-add`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n Tasks launched on FARGATElong only support adding the ``SYS_PTRACE`` kernel capability.\n Valid values: ``\"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" | \"BLOCK_SUSPEND\" | \"CHOWN\" | \"DAC_OVERRIDE\" | \"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" | \"IPC_LOCK\" | \"IPC_OWNER\" | \"KILL\" | \"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" | \"MAC_OVERRIDE\" | \"MKNOD\" | \"NET_ADMIN\" | \"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" | \"SETFCAP\" | \"SETGID\" | \"SETPCAP\" | \"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" | \"SYS_CHROOT\" | \"SYS_MODULE\" | \"SYS_NICE\" | \"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" | \"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" | \"SYSLOG\" | \"WAKE_ALARM\"``" + }, + "Drop": { + "type": { + "$ref": "#/145" + }, + "flags": 0, + "description": "The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to ``CapDrop`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--cap-drop`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n Valid values: ``\"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" | \"BLOCK_SUSPEND\" | \"CHOWN\" | \"DAC_OVERRIDE\" | \"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" | \"IPC_LOCK\" | \"IPC_OWNER\" | \"KILL\" | \"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" | \"MAC_OVERRIDE\" | \"MKNOD\" | \"NET_ADMIN\" | \"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" | \"SETFCAP\" | \"SETGID\" | \"SETPCAP\" | \"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" | \"SYS_CHROOT\" | \"SYS_MODULE\" | \"SYS_NICE\" | \"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" | \"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" | \"SYSLOG\" | \"WAKE_ALARM\"``" + } + } + }, + { + "$type": "ObjectType", + "name": "KeyValuePair", + "properties": { + "Name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The name of the key-value pair. For environment variables, this is the name of the environment variable." + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The value of the key-value pair. For environment variables, this is the value of the environment variable." + } + } + }, + { + "$type": "ObjectType", + "name": "LinuxParameters", + "properties": { + "Capabilities": { + "type": { + "$ref": "#/102" + }, + "flags": 0, + "description": "The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.\n For tasks that use the Fargate launch type, ``capabilities`` is supported for all platform versions but the ``add`` parameter is only supported if using platform version 1.4.0 or later." + }, + "Devices": { + "type": { + "$ref": "#/146" + }, + "flags": 0, + "description": "Any host devices to expose to the container. This parameter maps to ``Devices`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--device`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n If you're using tasks that use the Fargate launch type, the ``devices`` parameter isn't supported." + }, + "InitProcessEnabled": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "Run an ``init`` process inside the container that forwards signals and reaps processes. This parameter maps to the ``--init`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'``" + }, + "MaxSwap": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The total amount of swap memory (in MiB) a container can use. This parameter will be translated to the ``--memory-swap`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration) where the value would be the sum of the container memory plus the ``maxSwap`` value.\n If a ``maxSwap`` value of ``0`` is specified, the container will not use swap. Accepted values are ``0`` or any positive integer. If the ``maxSwap`` parameter is omitted, the container will use the swap configuration for the container instance it is running on. A ``maxSwap`` value must be set for the ``swappiness`` parameter to be used.\n If you're using tasks that use the Fargate launch type, the ``maxSwap`` parameter isn't supported.\n If you're using tasks on Amazon Linux 2023 the ``swappiness`` parameter isn't supported." + }, + "SharedMemorySize": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The value for the size (in MiB) of the ``/dev/shm`` volume. This parameter maps to the ``--shm-size`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n If you are using tasks that use the Fargate launch type, the ``sharedMemorySize`` parameter is not supported." + }, + "Swappiness": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "This allows you to tune a container's memory swappiness behavior. A ``swappiness`` value of ``0`` will cause swapping to not happen unless absolutely necessary. A ``swappiness`` value of ``100`` will cause pages to be swapped very aggressively. Accepted values are whole numbers between ``0`` and ``100``. If the ``swappiness`` parameter is not specified, a default value of ``60`` is used. If a value is not specified for ``maxSwap`` then this parameter is ignored. This parameter maps to the ``--memory-swappiness`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n If you're using tasks that use the Fargate launch type, the ``swappiness`` parameter isn't supported.\n If you're using tasks on Amazon Linux 2023 the ``swappiness`` parameter isn't supported." + }, + "Tmpfs": { + "type": { + "$ref": "#/147" + }, + "flags": 0, + "description": "The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the ``--tmpfs`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n If you're using tasks that use the Fargate launch type, the ``tmpfs`` parameter isn't supported." + } + } + }, + { + "$type": "ObjectType", + "name": "LogConfiguration", + "properties": { + "LogDriver": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The log driver to use for the container.\n For tasks on FARGATElong, the supported log drivers are ``awslogs``, ``splunk``, and ``awsfirelens``.\n For tasks hosted on Amazon EC2 instances, the supported log drivers are ``awslogs``, ``fluentd``, ``gelf``, ``json-file``, ``journald``, ``logentries``,``syslog``, ``splunk``, and ``awsfirelens``.\n For more information about using the ``awslogs`` log driver, see [Using the awslogs log driver](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html) in the *Amazon Elastic Container Service Developer Guide*.\n For more information about using the ``awsfirelens`` log driver, see [Custom log routing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) in the *Amazon Elastic Container Service Developer Guide*.\n If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's [available on GitHub](https://docs.aws.amazon.com/https://github.com/aws/amazon-ecs-agent) and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we don't currently provide support for running modified copies of this software." + }, + "Options": { + "type": { + "$ref": "#/148" + }, + "flags": 0, + "description": "The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'``" + }, + "SecretOptions": { + "type": { + "$ref": "#/149" + }, + "flags": 0, + "description": "The secrets to pass to the log configuration. For more information, see [Specifying sensitive data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer Guide*." + } + } + }, + { + "$type": "ObjectType", + "name": "MountPoint", + "properties": { + "ContainerPath": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The path on the container to mount the host volume at." + }, + "ReadOnly": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "If this value is ``true``, the container has read-only access to the volume. If this value is ``false``, then the container can write to the volume. The default value is ``false``." + }, + "SourceVolume": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The name of the volume to mount. Must be a volume name referenced in the ``name`` parameter of task definition ``volume``." + } + } + }, + { + "$type": "ObjectType", + "name": "PortMapping", + "properties": { + "AppProtocol": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The application protocol that's used for the port mapping. This parameter only applies to Service Connect. We recommend that you set this parameter to be consistent with the protocol that your application uses. If you set this parameter, Amazon ECS adds protocol-specific connection handling to the Service Connect proxy. If you set this parameter, Amazon ECS adds protocol-specific telemetry in the Amazon ECS console and CloudWatch.\n If you don't set a value for this parameter, then TCP is used. However, Amazon ECS doesn't add protocol-specific telemetry for TCP.\n ``appProtocol`` is immutable in a Service Connect service. Updating this field requires a service deletion and redeployment.\n Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*." + }, + "ContainerPort": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The port number on the container that's bound to the user-specified or automatically assigned host port.\n If you use containers in a task with the ``awsvpc`` or ``host`` network mode, specify the exposed ports using ``containerPort``.\n If you use containers in a task with the ``bridge`` network mode and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range. For more information, see ``hostPort``. Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance." + }, + "ContainerPortRange": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The port number range on the container that's bound to the dynamically mapped host port range. \n The following rules apply when you specify a ``containerPortRange``:\n + You must use either the ``bridge`` network mode or the ``awsvpc`` network mode.\n + This parameter is available for both the EC2 and FARGATElong launch types.\n + This parameter is available for both the Linux and Windows operating systems.\n + The container instance must have at least version 1.67.0 of the container agent and at least version 1.67.0-1 of the ``ecs-init`` package \n + You can specify a maximum of 100 port ranges per container.\n + You do not specify a ``hostPortRange``. The value of the ``hostPortRange`` is set as follows:\n + For containers in a task with the ``awsvpc`` network mode, the ``hostPortRange`` is set to the same value as the ``containerPortRange``. This is a static mapping strategy.\n + For containers in a task with the ``bridge`` network mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports.\n \n + The ``containerPortRange`` valid values are between 1 and 65535.\n + A port can only be included in one port mapping per container.\n + You cannot specify overlapping port ranges.\n + The first port in the range must be less than last port in the range.\n + Docker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports.\n For more information, see [Issue #11185](https://docs.aws.amazon.com/https://github.com/moby/moby/issues/11185) on the Github website.\n For information about how to turn off the docker-proxy in the Docker daemon 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 Guide*.\n \n You can call [DescribeTasks](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html) to view the ``hostPortRange`` which are the host ports that are bound to the container ports." + }, + "HostPort": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The port number on the container instance to reserve for your container.\n If you specify a ``containerPortRange``, leave this field empty and the value of the ``hostPort`` is set as follows:\n + For containers in a task with the ``awsvpc`` network mode, the ``hostPort`` is set to the same value as the ``containerPort``. This is a static mapping strategy.\n + For containers in a task with the ``bridge`` network mode, the Amazon ECS agent finds open ports on the host and automatically binds them to the container ports. This is a dynamic mapping strategy.\n \n If you use containers in a task with the ``awsvpc`` or ``host`` network mode, the ``hostPort`` can either be left blank or set to the same value as the ``containerPort``.\n If you use containers in a task with the ``bridge`` network mode, you can specify a non-reserved host port for your container port mapping, or you can omit the ``hostPort`` (or set it to ``0``) while specifying a ``containerPort`` and your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version.\n The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under ``/proc/sys/net/ipv4/ip_local_port_range``. If this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 (Linux) or 49152 through 65535 (Windows) is used. Do not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.\n The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678-51680. Any host port that was previously specified in a running task is also reserved while the task is running. That is, after a task stops, the host port is released. The current reserved ports are displayed in the ``remainingResources`` of [DescribeContainerInstances](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeContainerInstances.html) output. A container instance can have up to 100 reserved ports at a time. This number includes the default reserved ports. Automatically assigned ports aren't included in the 100 reserved ports quota." + }, + "Name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The name that's used for the port mapping. This parameter only applies to Service Connect. This parameter is the name that you use in the ``serviceConnectConfiguration`` of a service. The name can include up to 64 characters. The characters can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen.\n For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*." + }, + "Protocol": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The protocol used for the port mapping. Valid values are ``tcp`` and ``udp``. The default is ``tcp``. ``protocol`` is immutable in a Service Connect service. Updating this field requires a service deletion and redeployment." + } + } + }, + { + "$type": "ObjectType", + "name": "ProxyConfiguration", + "properties": { + "ContainerName": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The name of the container that will serve as the App Mesh proxy." + }, + "ProxyConfigurationProperties": { + "type": { + "$ref": "#/150" + }, + "flags": 0, + "description": "The set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified as key-value pairs.\n + ``IgnoredUID`` - (Required) The user ID (UID) of the proxy container as defined by the ``user`` parameter in a container definition. This is used to ensure the proxy ignores its own traffic. If ``IgnoredGID`` is specified, this field can be empty.\n + ``IgnoredGID`` - (Required) The group ID (GID) of the proxy container as defined by the ``user`` parameter in a container definition. This is used to ensure the proxy ignores its own traffic. If ``IgnoredUID`` is specified, this field can be empty.\n + ``AppPorts`` - (Required) The list of ports that the application uses. Network traffic to these ports is forwarded to the ``ProxyIngressPort`` and ``ProxyEgressPort``.\n + ``ProxyIngressPort`` - (Required) Specifies the port that incoming traffic to the ``AppPorts`` is directed to.\n + ``ProxyEgressPort`` - (Required) Specifies the port that outgoing traffic from the ``AppPorts`` is directed to.\n + ``EgressIgnoredPorts`` - (Required) The egress traffic going to the specified ports is ignored and not redirected to the ``ProxyEgressPort``. It can be an empty list.\n + ``EgressIgnoredIPs`` - (Required) The egress traffic going to the specified IP addresses is ignored and not redirected to the ``ProxyEgressPort``. It can be an empty list." + }, + "Type": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The proxy type. The only supported value is ``APPMESH``." + } + } + }, + { + "$type": "ObjectType", + "name": "RepositoryCredentials", + "properties": { + "CredentialsParameter": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the secret containing the private repository credentials.\n When you use the Amazon ECS API, CLI, or AWS SDK, if the secret exists in the same Region as the task that you're launching then you can use either the full ARN or the name of the secret. When you use the AWS Management Console, you must specify the full ARN of the secret." + } + } + }, + { + "$type": "ObjectType", + "name": "ResourceRequirement", + "properties": { + "Type": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The type of resource to assign to a container." + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The value for the specified resource type.\n When the type is ``GPU``, the value is the number of physical ``GPUs`` the Amazon ECS container agent reserves for the container. The number of GPUs that's reserved for all containers in a task can't exceed the number of available GPUs on the container instance that the task is launched on.\n When the type is ``InferenceAccelerator``, the ``value`` matches the ``deviceName`` for an [InferenceAccelerator](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_InferenceAccelerator.html) specified in a task definition." + } + } + }, + { + "$type": "ObjectType", + "name": "RuntimePlatform", + "properties": { + "CpuArchitecture": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The CPU architecture.\n You can run your Linux tasks on an ARM-based platform by setting the value to ``ARM64``. This option is available for tasks that run on Linux Amazon EC2 instance or Linux containers on Fargate." + }, + "OperatingSystemFamily": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The operating system." + } + } + }, + { + "$type": "ObjectType", + "name": "Secret", + "properties": { + "Name": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The name of the secret." + }, + "ValueFrom": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The secret to expose to the container. The supported values are either the full ARN of the ASMlong secret or the full ARN of the parameter in the SSM Parameter Store.\n For information about the require IAMlong permissions, see [Required IAM permissions for Amazon ECS secrets](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-secrets.html#secrets-iam) (for Secrets Manager) or [Required IAM permissions for Amazon ECS secrets](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-parameters.html) (for Systems Manager Parameter store) in the *Amazon Elastic Container Service Developer Guide*.\n If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified." + } + } + }, + { + "$type": "ObjectType", + "name": "SystemControl", + "properties": { + "Namespace": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The namespaced kernel parameter to set a ``value`` for." + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The namespaced kernel parameter to set a ``value`` for.\n Valid IPC namespace values: ``\"kernel.msgmax\" | \"kernel.msgmnb\" | \"kernel.msgmni\" | \"kernel.sem\" | \"kernel.shmall\" | \"kernel.shmmax\" | \"kernel.shmmni\" | \"kernel.shm_rmid_forced\"``, and ``Sysctls`` that start with ``\"fs.mqueue.*\"`` \n Valid network namespace values: ``Sysctls`` that start with ``\"net.*\"`` \n All of these values are supported by Fargate." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "One part of a key-value pair that make up a tag. A ``key`` is a general label that acts like a category for more specific tag values." + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The optional part of a key-value pair that make up a tag. A ``value`` acts as a descriptor within a tag category (key)." + } + } + }, + { + "$type": "ObjectType", + "name": "TaskDefinitionPlacementConstraint", + "properties": { + "Expression": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "A cluster query language expression to apply to the constraint. For more information, see [Cluster query language](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) in the *Amazon Elastic Container Service Developer Guide*." + }, + "Type": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The type of constraint. The ``MemberOf`` constraint restricts selection to be from a group of valid candidates." + } + } + }, + { + "$type": "ObjectType", + "name": "Tmpfs", + "properties": { + "ContainerPath": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The absolute file path where the tmpfs volume is to be mounted." + }, + "MountOptions": { + "type": { + "$ref": "#/151" + }, + "flags": 0, + "description": "The list of tmpfs volume mount options.\n Valid values: ``\"defaults\" | \"ro\" | \"rw\" | \"suid\" | \"nosuid\" | \"dev\" | \"nodev\" | \"exec\" | \"noexec\" | \"sync\" | \"async\" | \"dirsync\" | \"remount\" | \"mand\" | \"nomand\" | \"atime\" | \"noatime\" | \"diratime\" | \"nodiratime\" | \"bind\" | \"rbind\" | \"unbindable\" | \"runbindable\" | \"private\" | \"rprivate\" | \"shared\" | \"rshared\" | \"slave\" | \"rslave\" | \"relatime\" | \"norelatime\" | \"strictatime\" | \"nostrictatime\" | \"mode\" | \"uid\" | \"gid\" | \"nr_inodes\" | \"nr_blocks\" | \"mpol\"``" + }, + "Size": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The maximum size (in MiB) of the tmpfs volume." + } + } + }, + { + "$type": "ObjectType", + "name": "Ulimit", + "properties": { + "HardLimit": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The hard limit for the ``ulimit`` type." + }, + "Name": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The ``type`` of the ``ulimit``." + }, + "SoftLimit": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The soft limit for the ``ulimit`` type." + } + } + }, + { + "$type": "ObjectType", + "name": "Volume", + "properties": { + "ConfiguredAtLaunch": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "Indicates whether the volume should be configured at launch time. This is used to create Amazon EBS volumes for standalone tasks or tasks created as part of a service. Each task definition revision may only have one volume configured at launch in the volume configuration.\n To configure a volume at launch time, use this task definition revision and specify a ``volumeConfigurations`` object when calling the ``CreateService``, ``UpdateService``, ``RunTask`` or ``StartTask`` APIs." + }, + "DockerVolumeConfiguration": { + "type": { + "$ref": "#/91" + }, + "flags": 0, + "description": "This parameter is specified when you use Docker volumes.\n Windows containers only support the use of the ``local`` driver. To use bind mounts, specify the ``host`` parameter instead.\n Docker volumes aren't supported by tasks run on FARGATElong." + }, + "EFSVolumeConfiguration": { + "type": { + "$ref": "#/92" + }, + "flags": 0, + "description": "This parameter is specified when you use an Amazon Elastic File System file system for task storage." + }, + "FSxWindowsFileServerVolumeConfiguration": { + "type": { + "$ref": "#/96" + }, + "flags": 0, + "description": "This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage." + }, + "Host": { + "type": { + "$ref": "#/100" + }, + "flags": 0, + "description": "This parameter is specified when you use bind mount host volumes. The contents of the ``host`` parameter determine whether your bind mount host volume persists on the host container instance and where it's stored. If the ``host`` parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it stop running.\n Windows containers can mount whole directories on the same drive as ``$env:ProgramData``. Windows containers can't mount directories on a different drive, and mount point can't be across drives. For example, you can mount ``C:\\my\\path:C:\\my\\path`` and ``D:\\:D:\\``, but not ``D:\\my\\path:C:\\my\\path`` or ``D:\\:C:\\my\\path``." + }, + "Name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.\n When using a volume configured at launch, the ``name`` is required and must also be specified as the volume name in the ``ServiceVolumeConfiguration`` or ``TaskVolumeConfiguration`` parameter when creating your service or standalone task.\n For all other types of volumes, this name is referenced in the ``sourceVolume`` parameter of the ``mountPoints`` object in the container definition.\n When a volume is using the ``efsVolumeConfiguration``, the name is required." + } + } + }, + { + "$type": "ObjectType", + "name": "VolumeFrom", + "properties": { + "ReadOnly": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "If this value is ``true``, the container has read-only access to the volume. If this value is ``false``, then the container can write to the volume. The default value is ``false``." + }, + "SourceContainer": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The name of another container within the same task definition to mount volumes from." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/89" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ObjectType", + "name": "TaskDefinition_DockerLabels", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/103" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/93" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/99" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/106" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/107" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/110" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/112" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/117" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/119" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ObjectType", + "name": "TaskDefinition_DriverOpts", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TaskDefinition_Labels", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TaskDefinition_Options", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/90" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/116" + } + }, + { + "$type": "ObjectType", + "name": "TaskDefinition_Options", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/112" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/103" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.ECS/TaskDefinitionProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/88" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/101" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/115" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/114" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/118" + } + }, + { + "$type": "ObjectType", + "name": "AWS.ECS/TaskDefinitionProperties", + "properties": { + "ContainerDefinitions": { + "type": { + "$ref": "#/153" + }, + "flags": 0, + "description": "A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see [Amazon ECS Task Definitions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon Elastic Container Service Developer Guide*." + }, + "Cpu": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The number of ``cpu`` units used by the task. If you use the EC2 launch type, this field is optional. Any value can be used. If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines your range of valid values for the ``memory`` parameter.\n The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.\n + 256 (.25 vCPU) - Available ``memory`` values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)\n + 512 (.5 vCPU) - Available ``memory`` values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)\n + 1024 (1 vCPU) - Available ``memory`` values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)\n + 2048 (2 vCPU) - Available ``memory`` values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)\n + 4096 (4 vCPU) - Available ``memory`` values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)\n + 8192 (8 vCPU) - Available ``memory`` values: 16 GB and 60 GB in 4 GB increments\n This option requires Linux platform ``1.4.0`` or later.\n + 16384 (16vCPU) - Available ``memory`` values: 32GB and 120 GB in 8 GB increments\n This option requires Linux platform ``1.4.0`` or later." + }, + "EphemeralStorage": { + "type": { + "$ref": "#/94" + }, + "flags": 0, + "description": "The ephemeral storage settings to use for tasks run with the task definition." + }, + "ExecutionRoleArn": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make AWS API calls on your behalf. The task execution IAM role is required depending on the requirements of your task. For more information, see [Amazon ECS task execution IAM role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html) in the *Amazon Elastic Container Service Developer Guide*." + }, + "Family": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The name of a family that this task definition is registered to. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.\n A family groups multiple versions of a task definition. Amazon ECS gives the first task definition that you registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task definition that you add.\n To use revision numbers when you update a task definition, specify this property. If you don't specify a value, CFNlong generates a new task definition each time that you update it." + }, + "InferenceAccelerators": { + "type": { + "$ref": "#/154" + }, + "flags": 0, + "description": "The Elastic Inference accelerators to use for the containers in the task." + }, + "IpcMode": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The IPC resource namespace to use for the containers in the task. The valid values are ``host``, ``task``, or ``none``. If ``host`` is specified, then all containers within the tasks that specified the ``host`` IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If ``task`` is specified, all containers within the specified task share the same IPC resources. If ``none`` is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see [IPC settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#ipc-settings---ipc) in the *Docker run reference*.\n If the ``host`` IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see [Docker security](https://docs.aws.amazon.com/https://docs.docker.com/engine/security/security/).\n If you are setting namespaced kernel parameters using ``systemControls`` for the containers in the task, the following will apply to your IPC resource namespace. For more information, see [System Controls](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html) in the *Amazon Elastic Container Service Developer Guide*.\n + For tasks that use the ``host`` IPC mode, IPC namespace related ``systemControls`` are not supported.\n + For tasks that use the ``task`` IPC mode, IPC namespace related ``systemControls`` will apply to all containers within a task.\n \n This parameter is not supported for Windows containers or tasks run on FARGATElong." + }, + "Memory": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The amount (in MiB) of memory used by the task.\n If your tasks runs on Amazon EC2 instances, you must specify either a task-level memory value or a container-level memory value. This field is optional and any value can be used. If a task-level memory value is specified, the container-level memory value is optional. For more information regarding container-level memory and memory reservation, see [ContainerDefinition](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html).\n If your tasks runs on FARGATElong, this field is required. You must use one of the following values. The value you choose determines your range of valid values for the ``cpu`` parameter.\n + 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available ``cpu`` values: 256 (.25 vCPU)\n + 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available ``cpu`` values: 512 (.5 vCPU)\n + 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available ``cpu`` values: 1024 (1 vCPU)\n + Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available ``cpu`` values: 2048 (2 vCPU)\n + Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available ``cpu`` values: 4096 (4 vCPU)\n + Between 16 GB and 60 GB in 4 GB increments - Available ``cpu`` values: 8192 (8 vCPU)\n This option requires Linux platform ``1.4.0`` or later.\n + Between 32GB and 120 GB in 8 GB increments - Available ``cpu`` values: 16384 (16 vCPU)\n This option requires Linux platform ``1.4.0`` or later." + }, + "NetworkMode": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The Docker networking mode to use for the containers in the task. The valid values are ``none``, ``bridge``, ``awsvpc``, and ``host``. If no network mode is specified, the default is ``bridge``.\n For Amazon ECS tasks on Fargate, the ``awsvpc`` network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, ```` or ``awsvpc`` can be used. If the network mode is set to ``none``, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The ``host`` and ``awsvpc`` network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the ``bridge`` mode.\n With the ``host`` and ``awsvpc`` network modes, exposed container ports are mapped directly to the corresponding host port (for the ``host`` network mode) or the attached elastic network interface port (for the ``awsvpc`` network mode), so you cannot take advantage of dynamic host port mappings. \n When using the ``host`` network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.\n If the network mode is ``awsvpc``, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*.\n If the network mode is ``host``, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.\n For more information, see [Network settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#network-settings) in the *Docker run reference*." + }, + "PidMode": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The process namespace to use for the containers in the task. The valid values are ``host`` or ``task``. On Fargate for Linux containers, the only valid value is ``task``. For example, monitoring sidecars might need ``pidMode`` to access information about other containers running in the same task.\n If ``host`` is specified, all containers within the tasks that specified the ``host`` PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance.\n If ``task`` is specified, all containers within the specified task share the same process namespace.\n If no value is specified, the default is a private namespace for each container. For more information, see [PID settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#pid-settings---pid) in the *Docker run reference*.\n If the ``host`` PID mode is used, there's a heightened risk of undesired process namespace exposure. For more information, see [Docker security](https://docs.aws.amazon.com/https://docs.docker.com/engine/security/security/).\n This parameter is not supported for Windows containers.\n This parameter is only supported for tasks that are hosted on FARGATElong if the tasks are using platform version ``1.4.0`` or later (Linux). This isn't supported for Windows containers on Fargate." + }, + "PlacementConstraints": { + "type": { + "$ref": "#/155" + }, + "flags": 0, + "description": "An array of placement constraint objects to use for tasks.\n This parameter isn't supported for tasks run on FARGATElong." + }, + "ProxyConfiguration": { + "type": { + "$ref": "#/108" + }, + "flags": 0, + "description": "The configuration details for the App Mesh proxy.\n Your Amazon ECS container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ``ecs-init`` package to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version ``20190301`` or later, they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*." + }, + "RequiresCompatibilities": { + "type": { + "$ref": "#/156" + }, + "flags": 0, + "description": "The task launch types the task definition was validated against. The valid values are ``EC2``, ``FARGATE``, and ``EXTERNAL``. For more information, see [Amazon ECS launch types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer Guide*." + }, + "RuntimePlatform": { + "type": { + "$ref": "#/111" + }, + "flags": 0, + "description": "The operating system that your tasks definitions run on. A platform family is specified only for tasks using the Fargate launch type." + }, + "Tags": { + "type": { + "$ref": "#/157" + }, + "flags": 0, + "description": "The metadata that you apply to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value. You define both of them.\n The following basic restrictions apply to tags:\n + Maximum number of tags per resource - 50\n + For each resource, each tag key must be unique, and each tag key can have only one value.\n + Maximum key length - 128 Unicode characters in UTF-8\n + Maximum value length - 256 Unicode characters in UTF-8\n + If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.\n + Tag keys and values are case-sensitive.\n + Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit." + }, + "TaskDefinitionArn": { + "type": { + "$ref": "#/3" + }, + "flags": 18, + "description": "" + }, + "TaskRoleArn": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The short name or full Amazon Resource Name (ARN) of the IAMlong role that grants containers in the task permission to call AWS APIs on your behalf. For more information, see [Amazon ECS Task Role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) in the *Amazon Elastic Container Service Developer Guide*.\n IAM roles for tasks on Windows require that the ``-EnableTaskIAMRole`` option is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code to use the feature. For more information, see [Windows IAM roles for tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows_task_IAM_roles.html) in the *Amazon Elastic Container Service Developer Guide*." + }, + "Volumes": { + "type": { + "$ref": "#/158" + }, + "flags": 0, + "description": "The list of data volume definitions for the task. For more information, see [Using data volumes in tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html) in the *Amazon Elastic Container Service Developer Guide*.\n The ``host`` and ``sourcePath`` parameters aren't supported for tasks run on FARGATElong." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ECS/TaskDefinition", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/159" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ECS/TaskDefinition@default", + "scopeType": 0, + "body": { + "$ref": "#/160" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AwsVpcConfiguration", + "properties": { + "AssignPublicIp": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "Whether the task's elastic network interface receives a public IP address. The default value is DISABLED." + }, + "SecurityGroups": { + "type": { + "$ref": "#/168" + }, + "flags": 0, + "description": "The security groups associated with the task or service. If you do not specify a security group, the default security group for the VPC is used. There is a limit of 5 security groups that can be specified per AwsVpcConfiguration." + }, + "Subnets": { + "type": { + "$ref": "#/169" + }, + "flags": 1, + "description": "The subnets associated with the task or service. There is a limit of 16 subnets that can be specified per AwsVpcConfiguration." + } + } + }, + { + "$type": "ObjectType", + "name": "LoadBalancer", + "properties": { + "ContainerName": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The name of the container (as it appears in a container definition) to associate with the load balancer." + }, + "ContainerPort": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The port on the container to associate with the load balancer. This port must correspond to a containerPort in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they are launched on must allow ingress traffic on the hostPort of the port mapping." + }, + "TargetGroupArn": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set. A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you are using a Classic Load Balancer this should be omitted. For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html in the Amazon Elastic Container Service Developer Guide. For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-bluegreen.html in the Amazon Elastic Container Service Developer Guide. If your service's task definition uses the awsvpc network mode (which is required for the Fargate launch type), you must choose ip as the target type, not instance, when creating your target groups because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance." + } + } + }, + { + "$type": "ObjectType", + "name": "NetworkConfiguration", + "properties": { + "AwsVpcConfiguration": { + "type": { + "$ref": "#/162" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Scale", + "properties": { + "Unit": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The unit of measure for the scale value." + }, + "Value": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The value, specified as a percent total of a service's desiredCount, to scale the task set. Accepted values are numbers between 0 and 100." + } + } + }, + { + "$type": "ObjectType", + "name": "ServiceRegistry", + "properties": { + "ContainerName": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The container name value, already specified in the task definition, to be used for your service discovery service. If the task definition that your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition that your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value, but not both." + }, + "ContainerPort": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The port value, already specified in the task definition, to be used for your service discovery service. If the task definition your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value, but not both." + }, + "Port": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The port value used if your service discovery service specified an SRV record. This field may be used if both the awsvpc network mode and SRV records are used." + }, + "RegistryArn": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is AWS Cloud Map. For more information, see https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html" + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.ECS/TaskSetProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/163" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/166" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/167" + } + }, + { + "$type": "ObjectType", + "name": "AWS.ECS/TaskSetProperties", + "properties": { + "Cluster": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in." + }, + "ExternalId": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "An optional non-unique tag that identifies this task set in external systems. If the task set is associated with a service discovery registry, the tasks in this task set will have the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute set to the provided value. " + }, + "Id": { + "type": { + "$ref": "#/3" + }, + "flags": 18, + "description": "The ID of the task set." + }, + "LaunchType": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The launch type that new tasks in the task set will use. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html in the Amazon Elastic Container Service Developer Guide. " + }, + "LoadBalancers": { + "type": { + "$ref": "#/171" + }, + "flags": 0 + }, + "NetworkConfiguration": { + "type": { + "$ref": "#/164" + }, + "flags": 0 + }, + "PlatformVersion": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The platform version that the tasks in the task set should use. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used by default." + }, + "Scale": { + "type": { + "$ref": "#/165" + }, + "flags": 0, + "description": "A floating-point percentage of the desired number of tasks to place and keep running in the task set." + }, + "Service": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "The short name or full Amazon Resource Name (ARN) of the service to create the task set in." + }, + "ServiceRegistries": { + "type": { + "$ref": "#/172" + }, + "flags": 0, + "description": "The details of the service discovery registries to assign to this task set. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html." + }, + "Tags": { + "type": { + "$ref": "#/173" + }, + "flags": 0 + }, + "TaskDefinition": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The short name or full Amazon Resource Name (ARN) of the task definition for the tasks in the task set to use." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ECS/TaskSet", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/174" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ECS/TaskSet@default", + "scopeType": 0, + "body": { + "$ref": "#/175" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.ecs/default/types.md b/artifacts/bicep/aws/aws.ecs/default/types.md index 7e14df7b..2c3f00ee 100644 --- a/artifacts/bicep/aws/aws.ecs/default/types.md +++ b/artifacts/bicep/aws/aws.ecs/default/types.md @@ -3,57 +3,56 @@ ## Resource AWS.ECS/CapacityProvider@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ECS/CapacityProviderProperties](#awsecscapacityproviderproperties) (Required): properties of the resource +* **properties**: [AWS.ECS/CapacityProviderProperties](#awsecscapacityproviderproperties) (Required, Identifier): properties of the resource ## Resource AWS.ECS/Cluster@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ECS/ClusterProperties](#awsecsclusterproperties): properties of the resource +* **properties**: [AWS.ECS/ClusterProperties](#awsecsclusterproperties) (Identifier): properties of the resource ## Resource AWS.ECS/ClusterCapacityProviderAssociations@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ECS/ClusterCapacityProviderAssociationsProperties](#awsecsclustercapacityproviderassociationsproperties) (Required): properties of the resource +* **properties**: [AWS.ECS/ClusterCapacityProviderAssociationsProperties](#awsecsclustercapacityproviderassociationsproperties) (Required, Identifier): properties of the resource ## Resource AWS.ECS/PrimaryTaskSet@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ECS/PrimaryTaskSetProperties](#awsecsprimarytasksetproperties) (Required): properties of the resource +* **properties**: [AWS.ECS/PrimaryTaskSetProperties](#awsecsprimarytasksetproperties) (Required, Identifier): properties of the resource ## Resource AWS.ECS/Service@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ECS/ServiceProperties](#awsecsserviceproperties): properties of the resource +* **properties**: [AWS.ECS/ServiceProperties](#awsecsserviceproperties) (Identifier): properties of the resource ## Resource AWS.ECS/TaskDefinition@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ECS/TaskDefinitionProperties](#awsecstaskdefinitionproperties): properties of the resource +* **properties**: [AWS.ECS/TaskDefinitionProperties](#awsecstaskdefinitionproperties) (Identifier): properties of the resource ## Resource AWS.ECS/TaskSet@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ECS/TaskSetProperties](#awsecstasksetproperties) (Required): properties of the resource +* **properties**: [AWS.ECS/TaskSetProperties](#awsecstasksetproperties) (Required, Identifier): properties of the resource -## AWS.ECS/CapacityProviderProperties +## AuthorizationConfig ### Properties -* **AutoScalingGroupProvider**: [AutoScalingGroupProvider](#autoscalinggroupprovider) (Required) -* **Name**: string (Identifier) -* **Tags**: [Tag](#tag)[] +* **AccessPointId**: string: The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the ``EFSVolumeConfiguration`` must either be omitted or set to ``/`` which will enforce the path set on the EFS access point. If an access point is used, transit encryption must be on in the ``EFSVolumeConfiguration``. For more information, see [Working with Amazon EFS access points](https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html) in the *Amazon Elastic File System User Guide*. +* **IAM**: string: Determines whether to use the Amazon ECS task role defined in a task definition when mounting the Amazon EFS file system. If it is turned on, transit encryption must be turned on in the ``EFSVolumeConfiguration``. If this parameter is omitted, the default value of ``DISABLED`` is used. For more information, see [Using Amazon EFS access points](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/efs-volumes.html#efs-volume-accesspoints) in the *Amazon Elastic Container Service Developer Guide*. ## AutoScalingGroupProvider ### Properties @@ -62,73 +61,204 @@ * **ManagedScaling**: [ManagedScaling](#managedscaling) * **ManagedTerminationProtection**: string -## ManagedScaling -### Properties -* **InstanceWarmupPeriod**: int -* **MaximumScalingStepSize**: int -* **MinimumScalingStepSize**: int -* **Status**: string -* **TargetCapacity**: int - -## Tag -### Properties -* **Key**: string -* **Value**: string - -## AWS.ECS/ClusterProperties +## AWS.ECS/CapacityProviderProperties ### Properties -* **Arn**: string (ReadOnly): The Amazon Resource Name (ARN) of the Amazon ECS cluster, such as arn:aws:ecs:us-east-2:123456789012:cluster/MyECSCluster. -* **CapacityProviders**: string[] -* **ClusterName**: string (Identifier): A user-generated string that you use to identify your cluster. If you don't specify a name, AWS CloudFormation generates a unique physical ID for the name. -* **ClusterSettings**: [ClusterSettings](#clustersettings)[] -* **Configuration**: [ClusterConfiguration](#clusterconfiguration) -* **DefaultCapacityProviderStrategy**: [CapacityProviderStrategyItem](#capacityproviderstrategyitem)[] -* **ServiceConnectDefaults**: [ServiceConnectDefaults](#serviceconnectdefaults) (WriteOnly) +* **AutoScalingGroupProvider**: [AutoScalingGroupProvider](#autoscalinggroupprovider) (Required) +* **Name**: string (Identifier) * **Tags**: [Tag](#tag)[] -## ClusterSettings +## AWS.ECS/ClusterCapacityProviderAssociationsProperties ### Properties -* **Name**: string -* **Value**: string +* **CapacityProviders**: string[] (Required) +* **Cluster**: string (Required, Identifier) +* **DefaultCapacityProviderStrategy**: [CapacityProviderStrategy](#capacityproviderstrategy)[] (Required) -## ClusterConfiguration +## AWS.ECS/ClusterProperties ### Properties -* **ExecuteCommandConfiguration**: [ExecuteCommandConfiguration](#executecommandconfiguration) +* **Arn**: string (ReadOnly) +* **CapacityProviders**: string[]: The short name of one or more capacity providers to associate with the cluster. A capacity provider must be associated with a cluster before it can be included as part of the default capacity provider strategy of the cluster or used in a capacity provider strategy when calling the [CreateService](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html) or [RunTask](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html) actions. + If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must be created but not associated with another cluster. New Auto Scaling group capacity providers can be created with the [CreateCapacityProvider](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCapacityProvider.html) API operation. + To use a FARGATElong capacity provider, specify either the ``FARGATE`` or ``FARGATE_SPOT`` capacity providers. The FARGATElong capacity providers are available to all accounts and only need to be associated with a cluster to be used. + The [PutCapacityProvider](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutCapacityProvider.html) API operation is used to update the list of available capacity providers for a cluster after the cluster is created. +* **ClusterName**: string (Identifier): A user-generated string that you use to identify your cluster. If you don't specify a name, CFNlong generates a unique physical ID for the name. +* **ClusterSettings**: [ClusterSettings](#clustersettings)[]: The settings to use when creating a cluster. This parameter is used to turn on CloudWatch Container Insights for a cluster. +* **Configuration**: [ClusterConfiguration](#clusterconfiguration): The execute command configuration for the cluster. +* **DefaultCapacityProviderStrategy**: [CapacityProviderStrategyItem](#capacityproviderstrategyitem)[]: The default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used. +* **ServiceConnectDefaults**: [ServiceConnectDefaults](#serviceconnectdefaults) (WriteOnly): Use this parameter to set a default Service Connect namespace. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the ``enabled`` parameter to ``true`` in the ``ServiceConnectConfiguration``. You can set the namespace of each service individually in the ``ServiceConnectConfiguration`` to override this default parameter. + Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*. +* **Tags**: [Tag](#tag)[]: The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value. You define both. + The following basic restrictions apply to tags: + + Maximum number of tags per resource - 50 + + For each resource, each tag key must be unique, and each tag key can have only one value. + + Maximum key length - 128 Unicode characters in UTF-8 + + Maximum value length - 256 Unicode characters in UTF-8 + + 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: + - = . _ : / @. + + Tag keys and values are case-sensitive. + + Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit. -## ExecuteCommandConfiguration +## AWS.ECS/PrimaryTaskSetProperties ### Properties -* **KmsKeyId**: string -* **LogConfiguration**: [ExecuteCommandLogConfiguration](#executecommandlogconfiguration) -* **Logging**: string +* **Cluster**: string (Required, Identifier): The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in. +* **Service**: string (Required, Identifier): The short name or full Amazon Resource Name (ARN) of the service to create the task set in. +* **TaskSetId**: string (Required): The ID or full Amazon Resource Name (ARN) of the task set. -## ExecuteCommandLogConfiguration +## AWS.ECS/ServiceProperties ### Properties -* **CloudWatchEncryptionEnabled**: bool -* **CloudWatchLogGroupName**: string -* **S3BucketName**: string -* **S3EncryptionEnabled**: bool -* **S3KeyPrefix**: string +* **CapacityProviderStrategy**: [CapacityProviderStrategyItem](#capacityproviderstrategyitem)[]: The capacity provider strategy to use for the service. + If a ``capacityProviderStrategy`` is specified, the ``launchType`` parameter must be omitted. If no ``capacityProviderStrategy`` or ``launchType`` is specified, the ``defaultCapacityProviderStrategy`` for the cluster is used. + A capacity provider strategy may contain a maximum of 6 capacity providers. +* **Cluster**: string (Identifier): The short name or full Amazon Resource Name (ARN) of the cluster that you run your service on. If you do not specify a cluster, the default cluster is assumed. +* **DeploymentConfiguration**: [DeploymentConfiguration](#deploymentconfiguration): Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks. +* **DeploymentController**: [DeploymentController](#deploymentcontroller): The deployment controller to use for the service. If no deployment controller is specified, the default value of ``ECS`` is used. +* **DesiredCount**: int: The number of instantiations of the specified task definition to place and keep running in your service. + For new services, if a desired count is not specified, a default value of ``1`` is used. When using the ``DAEMON`` scheduling strategy, the desired count is not required. + For existing services, if a desired count is not specified, it is omitted from the operation. +* **EnableECSManagedTags**: bool: Specifies whether to turn on Amazon ECS managed tags for the tasks within the service. For more information, see [Tagging your Amazon ECS resources](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) in the *Amazon Elastic Container Service Developer Guide*. + When you use Amazon ECS managed tags, you need to set the ``propagateTags`` request parameter. +* **EnableExecuteCommand**: bool: Determines whether the execute command functionality is turned on for the service. If ``true``, the execute command functionality is turned on for all containers in tasks as part of the service. +* **HealthCheckGracePeriodSeconds**: int: The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started. This is only used when your service is configured to use a load balancer. If your service has a load balancer defined and you don't specify a health check grace period value, the default value of ``0`` is used. + If you do not use an Elastic Load Balancing, we recommend that you use the ``startPeriod`` in the task definition health check parameters. For more information, see [Health check](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_HealthCheck.html). + If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds (about 69 years). During that time, the Amazon ECS service scheduler ignores health check status. This grace period can prevent the service scheduler from marking tasks as unhealthy and stopping them before they have time to come up. +* **LaunchType**: string: The launch type on which to run your service. For more information, see [Amazon ECS Launch Types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer Guide*. +* **LoadBalancers**: [LoadBalancer](#loadbalancer)[]: A list of load balancer objects to associate with the service. If you specify the ``Role`` property, ``LoadBalancers`` must be specified as well. For information about the number of load balancers that you can specify per service, see [Service Load Balancing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html) in the *Amazon Elastic Container Service Developer Guide*. +* **Name**: string (ReadOnly) +* **NetworkConfiguration**: [NetworkConfiguration](#networkconfiguration): The network configuration for the service. This parameter is required for task definitions that use the ``awsvpc`` network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*. +* **PlacementConstraints**: [PlacementConstraint](#placementconstraint)[]: An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints for each task. This limit includes constraints in the task definition and those specified at runtime. +* **PlacementStrategies**: [PlacementStrategy](#placementstrategy)[]: The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules for each service. +* **PlatformVersion**: string: The platform version that your tasks in the service are running on. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the ``LATEST`` platform version is used. For more information, see [platform versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) in the *Amazon Elastic Container Service Developer Guide*. +* **PropagateTags**: string: Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the task during 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. + The default is ``NONE``. +* **Role**: string: The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition doesn't use the ``awsvpc`` network mode. If you specify the ``role`` parameter, you must also specify a load balancer object with the ``loadBalancers`` parameter. + If your account has already created the Amazon ECS service-linked role, that role is used for your service unless you specify a role here. The service-linked role is required if your task definition uses the ``awsvpc`` network mode or if the service is configured to use service discovery, an external deployment controller, multiple target groups, or Elastic Inference accelerators in which case you don't specify a role here. For more information, see [Using service-linked roles for Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html) in the *Amazon Elastic Container Service Developer Guide*. + If your specified role has a path other than ``/``, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name ``bar`` has a path of ``/foo/`` then you would specify ``/foo/bar`` as the role name. For more information, see [Friendly names and paths](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names) in the *IAM User Guide*. +* **SchedulingStrategy**: string: The scheduling strategy to use for the service. For more information, see [Services](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html). + There are two service scheduler strategies available: + + ``REPLICA``-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. This scheduler strategy is required if the service uses the ``CODE_DEPLOY`` or ``EXTERNAL`` deployment controller types. + + ``DAEMON``-The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that don't meet the placement constraints. When you're using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies. + Tasks using the Fargate launch type or the ``CODE_DEPLOY`` or ``EXTERNAL`` deployment controller types don't support the ``DAEMON`` scheduling strategy. +* **ServiceArn**: string (ReadOnly, Identifier) +* **ServiceConnectConfiguration**: [ServiceConnectConfiguration](#serviceconnectconfiguration) (WriteOnly): The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace. + Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*. +* **ServiceName**: string: The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions. + The stack update fails if you change any properties that require replacement and the ``ServiceName`` is configured. This is because AWS CloudFormation creates the replacement service first, but each ``ServiceName`` must be unique in the cluster. +* **ServiceRegistries**: [ServiceRegistry](#serviceregistry)[]: The details of the service discovery registry to associate with this service. For more information, see [Service discovery](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html). + Each service may be associated with one service registry. Multiple service registries for each service isn't supported. +* **Tags**: [Tag](#tag)[]: The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as well. + The following basic restrictions apply to tags: + + Maximum number of tags per resource - 50 + + For each resource, each tag key must be unique, and each tag key can have only one value. + + Maximum key length - 128 Unicode characters in UTF-8 + + Maximum value length - 256 Unicode characters in UTF-8 + + 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: + - = . _ : / @. + + Tag keys and values are case-sensitive. + + Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit. +* **TaskDefinition**: string: The ``family`` and ``revision`` (``family:revision``) or full ARN of the task definition to run in your service. If a ``revision`` isn't specified, the latest ``ACTIVE`` revision is used. + A task definition must be specified if the service uses either the ``ECS`` or ``CODE_DEPLOY`` deployment controllers. + For more information about deployment types, see [Amazon ECS deployment types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html). +* **VolumeConfigurations**: [ServiceVolumeConfiguration](#servicevolumeconfiguration)[] (WriteOnly): The configuration for a volume specified in the task definition as a volume that is configured at launch time. Currently, the only supported volume type is an Amazon EBS volume. -## CapacityProviderStrategyItem +## AWS.ECS/TaskDefinitionProperties ### Properties -* **Base**: int -* **CapacityProvider**: string -* **Weight**: int +* **ContainerDefinitions**: [ContainerDefinition](#containerdefinition)[]: A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see [Amazon ECS Task Definitions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon Elastic Container Service Developer Guide*. +* **Cpu**: string: The number of ``cpu`` units used by the task. If you use the EC2 launch type, this field is optional. Any value can be used. If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines your range of valid values for the ``memory`` parameter. + The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate. + + 256 (.25 vCPU) - Available ``memory`` values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) + + 512 (.5 vCPU) - Available ``memory`` values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) + + 1024 (1 vCPU) - Available ``memory`` values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) + + 2048 (2 vCPU) - Available ``memory`` values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) + + 4096 (4 vCPU) - Available ``memory`` values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) + + 8192 (8 vCPU) - Available ``memory`` values: 16 GB and 60 GB in 4 GB increments + This option requires Linux platform ``1.4.0`` or later. + + 16384 (16vCPU) - Available ``memory`` values: 32GB and 120 GB in 8 GB increments + This option requires Linux platform ``1.4.0`` or later. +* **EphemeralStorage**: [EphemeralStorage](#ephemeralstorage): The ephemeral storage settings to use for tasks run with the task definition. +* **ExecutionRoleArn**: string: The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make AWS API calls on your behalf. The task execution IAM role is required depending on the requirements of your task. For more information, see [Amazon ECS task execution IAM role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html) in the *Amazon Elastic Container Service Developer Guide*. +* **Family**: string: The name of a family that this task definition is registered to. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. + A family groups multiple versions of a task definition. Amazon ECS gives the first task definition that you registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task definition that you add. + To use revision numbers when you update a task definition, specify this property. If you don't specify a value, CFNlong generates a new task definition each time that you update it. +* **InferenceAccelerators**: [InferenceAccelerator](#inferenceaccelerator)[]: The Elastic Inference accelerators to use for the containers in the task. +* **IpcMode**: string: The IPC resource namespace to use for the containers in the task. The valid values are ``host``, ``task``, or ``none``. If ``host`` is specified, then all containers within the tasks that specified the ``host`` IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If ``task`` is specified, all containers within the specified task share the same IPC resources. If ``none`` is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see [IPC settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#ipc-settings---ipc) in the *Docker run reference*. + If the ``host`` IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see [Docker security](https://docs.aws.amazon.com/https://docs.docker.com/engine/security/security/). + If you are setting namespaced kernel parameters using ``systemControls`` for the containers in the task, the following will apply to your IPC resource namespace. For more information, see [System Controls](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html) in the *Amazon Elastic Container Service Developer Guide*. + + For tasks that use the ``host`` IPC mode, IPC namespace related ``systemControls`` are not supported. + + For tasks that use the ``task`` IPC mode, IPC namespace related ``systemControls`` will apply to all containers within a task. + + This parameter is not supported for Windows containers or tasks run on FARGATElong. +* **Memory**: string: The amount (in MiB) of memory used by the task. + If your tasks runs on Amazon EC2 instances, you must specify either a task-level memory value or a container-level memory value. This field is optional and any value can be used. If a task-level memory value is specified, the container-level memory value is optional. For more information regarding container-level memory and memory reservation, see [ContainerDefinition](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html). + If your tasks runs on FARGATElong, this field is required. You must use one of the following values. The value you choose determines your range of valid values for the ``cpu`` parameter. + + 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available ``cpu`` values: 256 (.25 vCPU) + + 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available ``cpu`` values: 512 (.5 vCPU) + + 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available ``cpu`` values: 1024 (1 vCPU) + + Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available ``cpu`` values: 2048 (2 vCPU) + + Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available ``cpu`` values: 4096 (4 vCPU) + + Between 16 GB and 60 GB in 4 GB increments - Available ``cpu`` values: 8192 (8 vCPU) + This option requires Linux platform ``1.4.0`` or later. + + Between 32GB and 120 GB in 8 GB increments - Available ``cpu`` values: 16384 (16 vCPU) + This option requires Linux platform ``1.4.0`` or later. +* **NetworkMode**: string: The Docker networking mode to use for the containers in the task. The valid values are ``none``, ``bridge``, ``awsvpc``, and ``host``. If no network mode is specified, the default is ``bridge``. + For Amazon ECS tasks on Fargate, the ``awsvpc`` network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, ```` or ``awsvpc`` can be used. If the network mode is set to ``none``, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The ``host`` and ``awsvpc`` network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the ``bridge`` mode. + With the ``host`` and ``awsvpc`` network modes, exposed container ports are mapped directly to the corresponding host port (for the ``host`` network mode) or the attached elastic network interface port (for the ``awsvpc`` network mode), so you cannot take advantage of dynamic host port mappings. + When using the ``host`` network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user. + If the network mode is ``awsvpc``, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*. + If the network mode is ``host``, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used. + For more information, see [Network settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#network-settings) in the *Docker run reference*. +* **PidMode**: string: The process namespace to use for the containers in the task. The valid values are ``host`` or ``task``. On Fargate for Linux containers, the only valid value is ``task``. For example, monitoring sidecars might need ``pidMode`` to access information about other containers running in the same task. + If ``host`` is specified, all containers within the tasks that specified the ``host`` PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance. + If ``task`` is specified, all containers within the specified task share the same process namespace. + If no value is specified, the default is a private namespace for each container. For more information, see [PID settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#pid-settings---pid) in the *Docker run reference*. + If the ``host`` PID mode is used, there's a heightened risk of undesired process namespace exposure. For more information, see [Docker security](https://docs.aws.amazon.com/https://docs.docker.com/engine/security/security/). + This parameter is not supported for Windows containers. + This parameter is only supported for tasks that are hosted on FARGATElong if the tasks are using platform version ``1.4.0`` or later (Linux). This isn't supported for Windows containers on Fargate. +* **PlacementConstraints**: [TaskDefinitionPlacementConstraint](#taskdefinitionplacementconstraint)[]: An array of placement constraint objects to use for tasks. + This parameter isn't supported for tasks run on FARGATElong. +* **ProxyConfiguration**: [ProxyConfiguration](#proxyconfiguration): The configuration details for the App Mesh proxy. + Your Amazon ECS container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ``ecs-init`` package to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version ``20190301`` or later, they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*. +* **RequiresCompatibilities**: string[]: The task launch types the task definition was validated against. The valid values are ``EC2``, ``FARGATE``, and ``EXTERNAL``. For more information, see [Amazon ECS launch types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer Guide*. +* **RuntimePlatform**: [RuntimePlatform](#runtimeplatform): The operating system that your tasks definitions run on. A platform family is specified only for tasks using the Fargate launch type. +* **Tags**: [Tag](#tag)[]: The metadata that you apply to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value. You define both of them. + The following basic restrictions apply to tags: + + Maximum number of tags per resource - 50 + + For each resource, each tag key must be unique, and each tag key can have only one value. + + Maximum key length - 128 Unicode characters in UTF-8 + + Maximum value length - 256 Unicode characters in UTF-8 + + 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: + - = . _ : / @. + + Tag keys and values are case-sensitive. + + Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit. +* **TaskDefinitionArn**: string (ReadOnly, Identifier) +* **TaskRoleArn**: string: The short name or full Amazon Resource Name (ARN) of the IAMlong role that grants containers in the task permission to call AWS APIs on your behalf. For more information, see [Amazon ECS Task Role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) in the *Amazon Elastic Container Service Developer Guide*. + IAM roles for tasks on Windows require that the ``-EnableTaskIAMRole`` option is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code to use the feature. For more information, see [Windows IAM roles for tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows_task_IAM_roles.html) in the *Amazon Elastic Container Service Developer Guide*. +* **Volumes**: [Volume](#volume)[]: The list of data volume definitions for the task. For more information, see [Using data volumes in tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html) in the *Amazon Elastic Container Service Developer Guide*. + The ``host`` and ``sourcePath`` parameters aren't supported for tasks run on FARGATElong. -## ServiceConnectDefaults +## AWS.ECS/TaskSetProperties ### Properties -* **Namespace**: string: Service Connect Namespace Name or ARN default for all services or tasks within this cluster +* **Cluster**: string (Required, Identifier): The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in. +* **ExternalId**: string: An optional non-unique tag that identifies this task set in external systems. If the task set is associated with a service discovery registry, the tasks in this task set will have the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute set to the provided value. +* **Id**: string (ReadOnly, Identifier): The ID of the task set. +* **LaunchType**: string: The launch type that new tasks in the task set will use. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html in the Amazon Elastic Container Service Developer Guide. +* **LoadBalancers**: [LoadBalancer](#loadbalancer)[] +* **NetworkConfiguration**: [NetworkConfiguration](#networkconfiguration) +* **PlatformVersion**: string: The platform version that the tasks in the task set should use. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used by default. +* **Scale**: [Scale](#scale): A floating-point percentage of the desired number of tasks to place and keep running in the task set. +* **Service**: string (Required, Identifier): The short name or full Amazon Resource Name (ARN) of the service to create the task set in. +* **ServiceRegistries**: [ServiceRegistry](#serviceregistry)[]: The details of the service discovery registries to assign to this task set. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html. +* **Tags**: [Tag](#tag)[] +* **TaskDefinition**: string (Required): The short name or full Amazon Resource Name (ARN) of the task definition for the tasks in the task set to use. -## Tag +## AwsVpcConfiguration ### Properties -* **Key**: string -* **Value**: string +* **AssignPublicIp**: string: Whether the task's elastic network interface receives a public IP address. The default value is ``DISABLED``. +* **SecurityGroups**: string[]: The IDs of the security groups associated with the task or service. If you don't specify a security group, the default security group for the VPC is used. There's a limit of 5 security groups that can be specified per ``AwsVpcConfiguration``. + All specified security groups must be from the same VPC. +* **Subnets**: string[]: The IDs of the subnets associated with the task or service. There's a limit of 16 subnets that can be specified per ``AwsVpcConfiguration``. + All specified subnets must be from the same VPC. -## AWS.ECS/ClusterCapacityProviderAssociationsProperties +## AwsVpcConfiguration ### Properties -* **CapacityProviders**: string[] (Required) -* **Cluster**: string (Required, Identifier) -* **DefaultCapacityProviderStrategy**: [CapacityProviderStrategy](#capacityproviderstrategy)[] (Required) +* **AssignPublicIp**: string: Whether the task's elastic network interface receives a public IP address. The default value is DISABLED. +* **SecurityGroups**: string[]: The security groups associated with the task or service. If you do not specify a security group, the default security group for the VPC is used. There is a limit of 5 security groups that can be specified per AwsVpcConfiguration. +* **Subnets**: string[] (Required): The subnets associated with the task or service. There is a limit of 16 subnets that can be specified per AwsVpcConfiguration. ## CapacityProviderStrategy ### Properties @@ -136,454 +266,723 @@ * **CapacityProvider**: string (Required) * **Weight**: int -## AWS.ECS/PrimaryTaskSetProperties +## CapacityProviderStrategyItem ### Properties -* **Cluster**: string (Required, Identifier): The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in. -* **Service**: string (Required, Identifier): The short name or full Amazon Resource Name (ARN) of the service to create the task set in. -* **TaskSetId**: string (Required): The ID or full Amazon Resource Name (ARN) of the task set. +* **Base**: int: The *base* value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a *base* defined. If no value is specified, the default value of ``0`` is used. +* **CapacityProvider**: string: The short name of the capacity provider. +* **Weight**: int: The *weight* value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The ``weight`` value is taken into consideration after the ``base`` value, if defined, is satisfied. + If no ``weight`` value is specified, the default value of ``0`` is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of ``0`` can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of ``0``, any ``RunTask`` or ``CreateService`` actions using the capacity provider strategy will fail. + An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of ``1``, then when the ``base`` is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of ``1`` for *capacityProviderA* and a weight of ``4`` for *capacityProviderB*, then for every one task that's run using *capacityProviderA*, four tasks would use *capacityProviderB*. -## AWS.ECS/ServiceProperties +## CapacityProviderStrategyItem ### Properties -* **CapacityProviderStrategy**: [CapacityProviderStrategyItem](#capacityproviderstrategyitem)[] -* **Cluster**: string (Identifier) -* **DeploymentConfiguration**: [DeploymentConfiguration](#deploymentconfiguration) -* **DeploymentController**: [DeploymentController](#deploymentcontroller) -* **DesiredCount**: int -* **EnableECSManagedTags**: bool -* **EnableExecuteCommand**: bool -* **HealthCheckGracePeriodSeconds**: int -* **LaunchType**: string -* **LoadBalancers**: [LoadBalancer](#loadbalancer)[] -* **Name**: string (ReadOnly) -* **NetworkConfiguration**: [NetworkConfiguration](#networkconfiguration) -* **PlacementConstraints**: [PlacementConstraint](#placementconstraint)[] -* **PlacementStrategies**: [PlacementStrategy](#placementstrategy)[] -* **PlatformVersion**: string -* **PropagateTags**: string -* **Role**: string -* **SchedulingStrategy**: string -* **ServiceArn**: string (ReadOnly, Identifier) -* **ServiceConnectConfiguration**: [ServiceConnectConfiguration](#serviceconnectconfiguration) (WriteOnly) -* **ServiceName**: string -* **ServiceRegistries**: [ServiceRegistry](#serviceregistry)[] -* **Tags**: [Tag](#tag)[] -* **TaskDefinition**: string -* **VolumeConfigurations**: [ServiceVolumeConfiguration](#servicevolumeconfiguration)[] (WriteOnly) +* **Base**: int: The *base* value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a *base* defined. If no value is specified, the default value of ``0`` is used. +* **CapacityProvider**: string: The short name of the capacity provider. +* **Weight**: int: The *weight* value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The ``weight`` value is taken into consideration after the ``base`` value, if defined, is satisfied. + If no ``weight`` value is specified, the default value of ``0`` is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of ``0`` can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of ``0``, any ``RunTask`` or ``CreateService`` actions using the capacity provider strategy will fail. + An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of ``1``, then when the ``base`` is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of ``1`` for *capacityProviderA* and a weight of ``4`` for *capacityProviderB*, then for every one task that's run using *capacityProviderA*, four tasks would use *capacityProviderB*. -## CapacityProviderStrategyItem +## ClusterConfiguration ### Properties -* **Base**: int -* **CapacityProvider**: string -* **Weight**: int +* **ExecuteCommandConfiguration**: [ExecuteCommandConfiguration](#executecommandconfiguration): The details of the execute command configuration. +* **ManagedStorageConfiguration**: [ManagedStorageConfiguration](#managedstorageconfiguration) -## DeploymentConfiguration +## ClusterSettings ### Properties -* **Alarms**: [DeploymentAlarms](#deploymentalarms) -* **DeploymentCircuitBreaker**: [DeploymentCircuitBreaker](#deploymentcircuitbreaker) -* **MaximumPercent**: int -* **MinimumHealthyPercent**: int +* **Name**: string: The name of the cluster setting. The value is ``containerInsights`` . +* **Value**: string: The value to set for the cluster setting. The supported values are ``enabled`` and ``disabled``. + If you set ``name`` to ``containerInsights`` and ``value`` to ``enabled``, CloudWatch Container Insights will be on for the cluster, otherwise it will be off unless the ``containerInsights`` account setting is turned on. If a cluster value is specified, it will override the ``containerInsights`` value set with [PutAccountSetting](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSetting.html) or [PutAccountSettingDefault](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSettingDefault.html). + +## ContainerDefinition +### Properties +* **Command**: string[]: The command that's passed to the container. This parameter maps to ``Cmd`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``COMMAND`` parameter to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). For more information, see [https://docs.docker.com/engine/reference/builder/#cmd](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/builder/#cmd). If there are multiple arguments, each argument is a separated string in the array. +* **Cpu**: int: The number of ``cpu`` units reserved for the container. This parameter maps to ``CpuShares`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--cpu-shares`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). + This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-level ``cpu`` value. + You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the [Amazon EC2 Instances](https://docs.aws.amazon.com/ec2/instance-types/) detail page by 1,024. + Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that's the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task is guaranteed a minimum of 512 CPU units when needed. Moreover, each container could float to higher CPU usage if the other container was not using it. If both tasks were 100% active all of the time, they would be limited to 512 CPU units. + On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see [CPU share constraint](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#cpu-share-constraint) in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2. However, the CPU parameter isn't required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version: + + *Agent versions less than or equal to 1.1.0:* Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to two CPU shares. + + *Agent versions greater than or equal to 1.2.0:* Null, zero, and CPU values of 1 are passed to Docker as 2. + + On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that's described in the task definition. A null or zero CPU value is passed to Docker as ``0``, which Windows interprets as 1% of one CPU. +* **CredentialSpecs**: string[]: A list of ARNs in SSM or Amazon S3 to a credential spec (``CredSpec``) file that configures the container for Active Directory authentication. We recommend that you use this parameter instead of the ``dockerSecurityOptions``. The maximum number of ARNs is 1. + There are two formats for each ARN. + + credentialspecdomainless:MyARN You use credentialspecdomainless:MyARN to provide a CredSpec with an additional section for a secret in . You provide the login credentials to the domain in the secret. Each task that runs on any container instance can join different domains. You can use this format without joining the container instance to a domain. + credentialspec:MyARN You use credentialspec:MyARN to provide a CredSpec for a single domain. You must join the container instance to the domain before you start any tasks that use this task definition. + In both formats, replace ``MyARN`` with the ARN in SSM or Amazon S3. + If you provide a ``credentialspecdomainless:MyARN``, the ``credspec`` must provide a ARN in ASMlong for a secret containing the username, password, and the domain to connect to. For better security, the instance isn't joined to the domain for domainless authentication. Other applications on the instance can't use the domainless credentials. You can use this parameter to run tasks on the same instance, even it the tasks need to join different domains. For more information, see [Using gMSAs for Windows Containers](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows-gmsa.html) and [Using gMSAs for Linux Containers](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/linux-gmsa.html). +* **DependsOn**: [ContainerDependency](#containerdependency)[]: The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed. + For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to turn on container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the *Amazon Elastic Container Service Developer Guide*. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ``ecs-init`` package. If your container instances are launched from version ``20190301`` or later, then they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*. + For tasks using the Fargate launch type, the task or service requires the following platforms: + + Linux platform version ``1.3.0`` or later. + + Windows platform version ``1.0.0`` or later. + + If the task definition is used in a blue/green deployment that uses [AWS::CodeDeploy::DeploymentGroup BlueGreenDeploymentConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-bluegreendeploymentconfiguration.html), the ``dependsOn`` parameter is not supported. For more information see [Issue #680](https://docs.aws.amazon.com/https://github.com/aws-cloudformation/cloudformation-coverage-roadmap/issues/680) on the on the GitHub website. +* **DisableNetworking**: bool: When this parameter is true, networking is off within the container. This parameter maps to ``NetworkDisabled`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/). + This parameter is not supported for Windows containers. +* **DnsSearchDomains**: string[]: A list of DNS search domains that are presented to the container. This parameter maps to ``DnsSearch`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--dns-search`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). + This parameter is not supported for Windows containers. +* **DnsServers**: string[]: A list of DNS servers that are presented to the container. This parameter maps to ``Dns`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--dns`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). + This parameter is not supported for Windows containers. +* **DockerLabels**: [TaskDefinition_DockerLabels](#taskdefinitiondockerlabels): A key/value map of labels to add to the container. This parameter maps to ``Labels`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--label`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'`` +* **DockerSecurityOptions**: string[]: A list of strings to provide custom configuration for multiple security systems. For more information about valid values, see [Docker Run Security Configuration](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). This field isn't valid for containers in tasks using the Fargate launch type. + For Linux tasks on EC2, this parameter can be used to reference custom labels for SELinux and AppArmor multi-level security systems. + For any tasks on EC2, this parameter can be used to reference a credential spec file that configures a container for Active Directory authentication. For more information, see [Using gMSAs for Windows Containers](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows-gmsa.html) and [Using gMSAs for Linux Containers](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/linux-gmsa.html) in the *Amazon Elastic Container Service Developer Guide*. + This parameter maps to ``SecurityOpt`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--security-opt`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). + The Amazon ECS container agent running on a container instance must register with the ``ECS_SELINUX_CAPABLE=true`` or ``ECS_APPARMOR_CAPABLE=true`` environment variables before containers placed on that instance can use these security options. For more information, see [Amazon ECS Container Agent Configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service Developer Guide*. + For more information about valid values, see [Docker Run Security Configuration](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). + Valid values: "no-new-privileges" | "apparmor:PROFILE" | "label:value" | "credentialspec:CredentialSpecFilePath" +* **EntryPoint**: string[]: Early versions of the Amazon ECS container agent don't properly handle ``entryPoint`` parameters. If you have problems using ``entryPoint``, update your container agent or enter your commands and arguments as ``command`` array items instead. + The entry point that's passed to the container. This parameter maps to ``Entrypoint`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--entrypoint`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). For more information, see [https://docs.docker.com/engine/reference/builder/#entrypoint](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/builder/#entrypoint). +* **Environment**: [KeyValuePair](#keyvaluepair)[]: The environment variables to pass to a container. This parameter maps to ``Env`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--env`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). + We don't recommend that you use plaintext environment variables for sensitive information, such as credential data. +* **EnvironmentFiles**: [EnvironmentFile](#environmentfile)[]: A list of files containing the environment variables to pass to a container. This parameter maps to the ``--env-file`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). + You can specify up to ten environment files. The file must have a ``.env`` file extension. Each line in an environment file contains an environment variable in ``VARIABLE=VALUE`` format. Lines beginning with ``#`` are treated as comments and are ignored. For more information about the environment variable file syntax, see [Declare default environment variables in file](https://docs.aws.amazon.com/https://docs.docker.com/compose/env-file/). + If there are environment variables specified using the ``environment`` parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they're processed from the top down. We recommend that you use unique variable names. For more information, see [Specifying Environment Variables](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html) in the *Amazon Elastic Container Service Developer Guide*. +* **Essential**: bool: If the ``essential`` parameter of a container is marked as ``true``, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the ``essential`` parameter of a container is marked as ``false``, its failure doesn't affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential. + All tasks must have at least one essential container. If you have an application that's composed of multiple containers, group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see [Application Architecture](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/application_architecture.html) in the *Amazon Elastic Container Service Developer Guide*. +* **ExtraHosts**: [HostEntry](#hostentry)[]: A list of hostnames and IP address mappings to append to the ``/etc/hosts`` file on the container. This parameter maps to ``ExtraHosts`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--add-host`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). + This parameter isn't supported for Windows containers or tasks that use the ``awsvpc`` network mode. +* **FirelensConfiguration**: [FirelensConfiguration](#firelensconfiguration): The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see [Custom Log Routing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) in the *Amazon Elastic Container Service Developer Guide*. +* **HealthCheck**: [HealthCheck](#healthcheck): The container health check command and associated configuration parameters for the container. This parameter maps to ``HealthCheck`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``HEALTHCHECK`` parameter of [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). +* **Hostname**: string: The hostname to use for your container. This parameter maps to ``Hostname`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--hostname`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). + The ``hostname`` parameter is not supported if you're using the ``awsvpc`` network mode. +* **Image**: string (Required): The image used to start a container. This string is passed directly to the Docker daemon. By default, images in the Docker Hub registry are available. Other repositories are specified with either ``repository-url/image:tag`` or ``repository-url/image@digest``. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to ``Image`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``IMAGE`` parameter of [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). + + When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image aren't propagated to already running tasks. + + Images in Amazon ECR repositories can be specified by either using the full ``registry/repository:tag`` or ``registry/repository@digest``. For example, ``012345678910.dkr.ecr..amazonaws.com/:latest`` or ``012345678910.dkr.ecr..amazonaws.com/@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE``. + + Images in official repositories on Docker Hub use a single name (for example, ``ubuntu`` or ``mongo``). + + Images in other repositories on Docker Hub are qualified with an organization name (for example, ``amazon/amazon-ecs-agent``). + + Images in other online repositories are qualified further by a domain name (for example, ``quay.io/assemblyline/ubuntu``). +* **Interactive**: bool: When this parameter is ``true``, you can deploy containerized applications that require ``stdin`` or a ``tty`` to be allocated. This parameter maps to ``OpenStdin`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--interactive`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). +* **Links**: string[]: The ``links`` parameter allows containers to communicate with each other without the need for port mappings. This parameter is only supported if the network mode of a task definition is ``bridge``. The ``name:internalName`` construct is analogous to ``name:alias`` in Docker links. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. For more information about linking Docker containers, go to [Legacy container links](https://docs.aws.amazon.com/https://docs.docker.com/network/links/) in the Docker documentation. This parameter maps to ``Links`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--link`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). + This parameter is not supported for Windows containers. + Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings. +* **LinuxParameters**: [LinuxParameters](#linuxparameters): Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information see [KernelCapabilities](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html). + This parameter is not supported for Windows containers. +* **LogConfiguration**: [LogConfiguration](#logconfiguration): The log configuration specification for the container. + This parameter maps to ``LogConfig`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--log-driver`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/). By default, containers use the same logging driver that the Docker daemon uses. However, the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see [Configure logging drivers](https://docs.aws.amazon.com/https://docs.docker.com/engine/admin/logging/overview/) in the Docker documentation. + Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the [LogConfiguration](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_LogConfiguration.html) data type). Additional log drivers may be available in future releases of the Amazon ECS container agent. + This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'`` + The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ``ECS_AVAILABLE_LOGGING_DRIVERS`` environment variable before containers placed on that instance can use these log configuration options. For more information, see [Amazon ECS Container Agent Configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service Developer Guide*. +* **Memory**: int: The amount (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. The total amount of memory reserved for all containers within a task must be lower than the task ``memory`` value, if one is specified. This parameter maps to ``Memory`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--memory`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). + If using the Fargate launch type, this parameter is optional. + If using the EC2 launch type, you must specify either a task-level memory value or a container-level memory value. If you specify both a container-level ``memory`` and ``memoryReservation`` value, ``memory`` must be greater than ``memoryReservation``. If you specify ``memoryReservation``, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value of ``memory`` is used. + The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container, so you should not specify fewer than 6 MiB of memory for your containers. + The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers. +* **MemoryReservation**: int: The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the ``memory`` parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps to ``MemoryReservation`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--memory-reservation`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). + If a task-level memory value is not specified, you must specify a non-zero integer for one or both of ``memory`` or ``memoryReservation`` in a container definition. If you specify both, ``memory`` must be greater than ``memoryReservation``. If you specify ``memoryReservation``, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value of ``memory`` is used. + For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a ``memoryReservation`` of 128 MiB, and a ``memory`` hard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed. + The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers. + The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers. +* **MountPoints**: [MountPoint](#mountpoint)[]: The mount points for data volumes in your container. + This parameter maps to ``Volumes`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--volume`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). + Windows containers can mount whole directories on the same drive as ``$env:ProgramData``. Windows containers can't mount directories on a different drive, and mount point can't be across drives. +* **Name**: string (Required): The name of a container. If you're linking multiple containers together in a task definition, the ``name`` of one container can be entered in the ``links`` of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter maps to ``name`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--name`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). +* **PortMappings**: [PortMapping](#portmapping)[]: The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic. + For task definitions that use the ``awsvpc`` network mode, you should only specify the ``containerPort``. The ``hostPort`` can be left blank or it must be the same value as the ``containerPort``. + Port mappings on Windows use the ``NetNAT`` gateway address rather than ``localhost``. There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself. + This parameter maps to ``PortBindings`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--publish`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/). If the network mode of a task definition is set to ``none``, then you can't specify port mappings. If the network mode of a task definition is set to ``host``, then host ports must either be undefined or they must match the container port in the port mapping. + After a task reaches the ``RUNNING`` status, manual and automatic host and container port assignments are visible in the *Network Bindings* section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in the ``networkBindings`` section [DescribeTasks](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html) responses. +* **Privileged**: bool: When this parameter is true, the container is given elevated privileges on the host container instance (similar to the ``root`` user). This parameter maps to ``Privileged`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--privileged`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). + This parameter is not supported for Windows containers or tasks run on FARGATElong. +* **PseudoTerminal**: bool: When this parameter is ``true``, a TTY is allocated. This parameter maps to ``Tty`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--tty`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). +* **ReadonlyRootFilesystem**: bool: When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ``ReadonlyRootfs`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--read-only`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). + This parameter is not supported for Windows containers. +* **RepositoryCredentials**: [RepositoryCredentials](#repositorycredentials): The private repository authentication credentials to use. +* **ResourceRequirements**: [ResourceRequirement](#resourcerequirement)[]: The type and amount of a resource to assign to a container. The only supported resource is a GPU. +* **Secrets**: [Secret](#secret)[]: The secrets to pass to the container. For more information, see [Specifying Sensitive Data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer Guide*. +* **StartTimeout**: int: Time duration (in seconds) to wait before giving up on resolving dependencies for a container. For example, you specify two containers in a task definition with containerA having a dependency on containerB reaching a ``COMPLETE``, ``SUCCESS``, or ``HEALTHY`` status. If a ``startTimeout`` value is specified for containerB and it doesn't reach the desired status within that time then containerA gives up and not start. This results in the task transitioning to a ``STOPPED`` state. + When the ``ECS_CONTAINER_START_TIMEOUT`` container agent configuration variable is used, it's enforced independently from this start timeout value. + For tasks using the Fargate launch type, the task or service requires the following platforms: + + Linux platform version ``1.3.0`` or later. + + Windows platform version ``1.0.0`` or later. + + For tasks using the EC2 launch type, your container instances require at least version ``1.26.0`` of the container agent to use a container start timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the *Amazon Elastic Container Service Developer Guide*. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version ``1.26.0-1`` of the ``ecs-init`` package. If your container instances are launched from version ``20190301`` or later, then they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*. + The valid values are 2-120 seconds. +* **StopTimeout**: int: Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own. + For tasks using the Fargate launch type, the task or service requires the following platforms: + + Linux platform version ``1.3.0`` or later. + + Windows platform version ``1.0.0`` or later. + + The max stop timeout value is 120 seconds and if the parameter is not specified, the default value of 30 seconds is used. + For tasks that use the EC2 launch type, if the ``stopTimeout`` parameter isn't specified, the value set for the Amazon ECS container agent configuration variable ``ECS_CONTAINER_STOP_TIMEOUT`` is used. If neither the ``stopTimeout`` parameter or the ``ECS_CONTAINER_STOP_TIMEOUT`` agent configuration variable are set, then the default values of 30 seconds for Linux containers and 30 seconds on Windows containers are used. Your container instances require at least version 1.26.0 of the container agent to use a container stop timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the *Amazon Elastic Container Service Developer Guide*. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ``ecs-init`` package. If your container instances are launched from version ``20190301`` or later, then they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*. + The valid values are 2-120 seconds. +* **SystemControls**: [SystemControl](#systemcontrol)[]: A list of namespaced kernel parameters to set in the container. This parameter maps to ``Sysctls`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--sysctl`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). For example, you can configure ``net.ipv4.tcp_keepalive_time`` setting to maintain longer lived connections. +* **Ulimits**: [Ulimit](#ulimit)[]: A list of ``ulimits`` to set in the container. This parameter maps to ``Ulimits`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--ulimit`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/). Valid naming values are displayed in the [Ulimit](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Ulimit.html) data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'`` + This parameter is not supported for Windows containers. +* **User**: string: The user to use inside the container. This parameter maps to ``User`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--user`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). + When running tasks using the ``host`` network mode, don't run containers using the root user (UID 0). We recommend using a non-root user for better security. + You can specify the ``user`` using the following formats. If specifying a UID or GID, you must specify it as a positive integer. + + ``user`` + + ``user:group`` + + ``uid`` + + ``uid:gid`` + + ``user:gid`` + + ``uid:group`` + + This parameter is not supported for Windows containers. +* **VolumesFrom**: [VolumeFrom](#volumefrom)[]: Data volumes to mount from another container. This parameter maps to ``VolumesFrom`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--volumes-from`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). +* **WorkingDirectory**: string: The working directory to run commands inside the container in. This parameter maps to ``WorkingDir`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--workdir`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). + +## ContainerDependency +### Properties +* **Condition**: string: The dependency condition of the container. The following are the available conditions and their behavior: + + ``START`` - This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start. + + ``COMPLETE`` - This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition can't be set on an essential container. + + ``SUCCESS`` - This condition is the same as ``COMPLETE``, but it also requires that the container exits with a ``zero`` status. This condition can't be set on an essential container. + + ``HEALTHY`` - This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confirmed only at task startup. +* **ContainerName**: string: The name of a container. ## DeploymentAlarms ### Properties -* **AlarmNames**: string[] (Required) -* **Enable**: bool (Required) -* **Rollback**: bool (Required) +* **AlarmNames**: string[] (Required): One or more CloudWatch alarm names. Use a "," to separate the alarms. +* **Enable**: bool (Required): Determines whether to use the CloudWatch alarm option in the service deployment process. +* **Rollback**: bool (Required): Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is used, when a service deployment fails, the service is rolled back to the last deployment that completed successfully. ## DeploymentCircuitBreaker ### Properties -* **Enable**: bool (Required) -* **Rollback**: bool (Required) +* **Enable**: bool (Required): Determines whether to use the deployment circuit breaker logic for the service. +* **Rollback**: bool (Required): Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is on, when a service deployment fails, the service is rolled back to the last deployment that completed successfully. + +## DeploymentConfiguration +### Properties +* **Alarms**: [DeploymentAlarms](#deploymentalarms): Information about the CloudWatch alarms. +* **DeploymentCircuitBreaker**: [DeploymentCircuitBreaker](#deploymentcircuitbreaker): The deployment circuit breaker can only be used for services using the rolling update (``ECS``) deployment type. + The *deployment circuit breaker* determines whether a service deployment will fail if the service can't reach a steady state. If you use the deployment circuit breaker, a service deployment will transition to a failed state and stop launching new tasks. If you use the rollback option, when a service deployment fails, the service is rolled back to the last deployment that completed successfully. For more information, see [Rolling update](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html) in the *Amazon Elastic Container Service Developer Guide* +* **MaximumPercent**: int: If a service is using the rolling update (``ECS``) deployment type, the ``maximumPercent`` parameter represents an upper limit on the number of your service's tasks that are allowed in the ``RUNNING`` or ``PENDING`` state during a deployment, as a percentage of the ``desiredCount`` (rounded down to the nearest integer). This parameter enables you to define the deployment batch size. For example, if your service is using the ``REPLICA`` service scheduler and has a ``desiredCount`` of four tasks and a ``maximumPercent`` value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default ``maximumPercent`` value for a service using the ``REPLICA`` service scheduler is 200%. + If a service is using either the blue/green (``CODE_DEPLOY``) or ``EXTERNAL`` deployment types and tasks that use the EC2 launch type, the *maximum percent* value is set to the default value and is used to define the upper limit on the number of the tasks in the service that remain in the ``RUNNING`` state while the container instances are in the ``DRAINING`` state. If the tasks in the service use the Fargate launch type, the maximum percent value is not used, although it is returned when describing your service. +* **MinimumHealthyPercent**: int: If a service is using the rolling update (``ECS``) deployment type, the ``minimumHealthyPercent`` represents a lower limit on the number of your service's tasks that must remain in the ``RUNNING`` state during a deployment, as a percentage of the ``desiredCount`` (rounded up to the nearest integer). This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a ``desiredCount`` of four tasks and a ``minimumHealthyPercent`` of 50%, the service scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks. + For services that *do not* use a load balancer, the following should be noted: + + A service is considered healthy if all essential containers within the tasks in the service pass their health checks. + + If a task has no essential containers with a health check defined, the service scheduler will wait for 40 seconds after a task reaches a ``RUNNING`` state before the task is counted towards the minimum healthy percent total. + + If a task has one or more essential containers with a health check defined, the service scheduler will wait for the task to reach a healthy status before counting it towards the minimum healthy percent total. A task is considered healthy when all essential containers within the task have passed their health checks. The amount of time the service scheduler can wait for is determined by the container health check settings. + + For services that *do* use a load balancer, the following should be noted: + + If a task has no essential containers with a health check defined, the service scheduler will wait for the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total. + + If a task has an essential container with a health check defined, the service scheduler will wait for both the task to reach a healthy status and the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total. + + If a service is using either the blue/green (``CODE_DEPLOY``) or ``EXTERNAL`` deployment types and is running tasks that use the EC2 launch type, the *minimum healthy percent* value is set to the default value and is used to define the lower limit on the number of the tasks in the service that remain in the ``RUNNING`` state while the container instances are in the ``DRAINING`` state. If a service is using either the blue/green (``CODE_DEPLOY``) or ``EXTERNAL`` deployment types and is running tasks that use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service. ## DeploymentController ### Properties -* **Type**: string +* **Type**: string: The deployment controller type to use. There are three deployment controller types available: + + ECS The rolling update (ECS) deployment type involves replacing the current running version of the container with the latest version. The number of containers Amazon ECS adds or removes from the service during a rolling update is controlled by adjusting the minimum and maximum number of healthy tasks allowed during a service deployment, as specified in the DeploymentConfiguration. + CODE_DEPLOY The blue/green (CODE_DEPLOY) deployment type uses the blue/green deployment model powered by , which allows you to verify a new deployment of a service before sending production traffic to it. + EXTERNAL The external (EXTERNAL) deployment type enables you to use any third-party deployment controller for full control over the deployment process for an Amazon ECS service. -## LoadBalancer +## Device ### Properties -* **ContainerName**: string -* **ContainerPort**: int -* **LoadBalancerName**: string -* **TargetGroupArn**: string +* **ContainerPath**: string: The path inside the container at which to expose the host device. +* **HostPath**: string: The path for the device on the host container instance. +* **Permissions**: string[]: The explicit permissions to provide to the container for the device. By default, the container has permissions for ``read``, ``write``, and ``mknod`` for the device. -## NetworkConfiguration +## DockerVolumeConfiguration ### Properties -* **AwsvpcConfiguration**: [AwsVpcConfiguration](#awsvpcconfiguration) +* **Autoprovision**: bool: If this value is ``true``, the Docker volume is created if it doesn't already exist. + This field is only used if the ``scope`` is ``shared``. +* **Driver**: string: The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use ``docker plugin ls`` to retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. For more information, see [Docker plugin discovery](https://docs.aws.amazon.com/https://docs.docker.com/engine/extend/plugin_api/#plugin-discovery). This parameter maps to ``Driver`` in the [Create a volume](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``xxdriver`` option to [docker volume create](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/commandline/volume_create/). +* **DriverOpts**: [TaskDefinition_DriverOpts](#taskdefinitiondriveropts): A map of Docker driver-specific options passed through. This parameter maps to ``DriverOpts`` in the [Create a volume](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``xxopt`` option to [docker volume create](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/commandline/volume_create/). +* **Labels**: [TaskDefinition_Labels](#taskdefinitionlabels): Custom metadata to add to your Docker volume. This parameter maps to ``Labels`` in the [Create a volume](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``xxlabel`` option to [docker volume create](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/commandline/volume_create/). +* **Scope**: string: The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a ``task`` are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped as ``shared`` persist after the task stops. -## AwsVpcConfiguration +## EBSTagSpecification ### Properties -* **AssignPublicIp**: string -* **SecurityGroups**: string[] -* **Subnets**: string[] +* **PropagateTags**: string: Determines whether to propagate the tags from the task definition to ?the Amazon EBS volume. Tags can only propagate to a ``SERVICE`` specified in ?``ServiceVolumeConfiguration``. If no value is specified, the tags aren't ?propagated. +* **ResourceType**: string (Required): The type of volume resource. +* **Tags**: [Tag](#tag)[]: The tags applied to this Amazon EBS volume. ``AmazonECSCreated`` and ``AmazonECSManaged`` are reserved tags that can't be used. -## PlacementConstraint +## EFSVolumeConfiguration ### Properties -* **Expression**: string -* **Type**: string (Required) +* **AuthorizationConfig**: [AuthorizationConfig](#authorizationconfig): The authorization configuration details for the Amazon EFS file system. +* **FilesystemId**: string (Required): The Amazon EFS file system ID to use. +* **RootDirectory**: string: The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume will be used. Specifying ``/`` will have the same effect as omitting this parameter. + If an EFS access point is specified in the ``authorizationConfig``, the root directory parameter must either be omitted or set to ``/`` which will enforce the path set on the EFS access point. +* **TransitEncryption**: string: Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be turned on if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of ``DISABLED`` is used. For more information, see [Encrypting data in transit](https://docs.aws.amazon.com/efs/latest/ug/encryption-in-transit.html) in the *Amazon Elastic File System User Guide*. +* **TransitEncryptionPort**: int: The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses. For more information, see [EFS mount helper](https://docs.aws.amazon.com/efs/latest/ug/efs-mount-helper.html) in the *Amazon Elastic File System User Guide*. -## PlacementStrategy +## EnvironmentFile ### Properties -* **Field**: string -* **Type**: string (Required) +* **Type**: string: The file type to use. Environment files are objects in Amazon S3. The only supported value is ``s3``. +* **Value**: string: The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file. -## ServiceConnectConfiguration +## EphemeralStorage ### Properties -* **Enabled**: bool (Required) -* **LogConfiguration**: [LogConfiguration](#logconfiguration) -* **Namespace**: string -* **Services**: [ServiceConnectService](#serviceconnectservice)[] +* **SizeInGiB**: int: The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is ``20`` GiB and the maximum supported value is ``200`` GiB. -## LogConfiguration +## ExecuteCommandConfiguration ### Properties -* **LogDriver**: string -* **Options**: [Service_Options](#serviceoptions) -* **SecretOptions**: [Secret](#secret)[] +* **KmsKeyId**: string: Specify an KMSlong key ID to encrypt the data between the local client and the container. +* **LogConfiguration**: [ExecuteCommandLogConfiguration](#executecommandlogconfiguration): The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket. When ``logging=OVERRIDE`` is specified, a ``logConfiguration`` must be provided. +* **Logging**: string: The log setting to use for redirecting logs for your execute command results. The following log settings are available. + + ``NONE``: The execute command session is not logged. + + ``DEFAULT``: The ``awslogs`` configuration in the task definition is used. If no logging parameter is specified, it defaults to this value. If no ``awslogs`` log driver is configured in the task definition, the output won't be logged. + + ``OVERRIDE``: Specify the logging details as a part of ``logConfiguration``. If the ``OVERRIDE`` logging option is specified, the ``logConfiguration`` is required. -## Service_Options +## ExecuteCommandLogConfiguration ### Properties +* **CloudWatchEncryptionEnabled**: bool: Determines whether to use encryption on the CloudWatch logs. If not specified, encryption will be off. +* **CloudWatchLogGroupName**: string: The name of the CloudWatch log group to send logs to. + The CloudWatch log group must already be created. +* **S3BucketName**: string: The name of the S3 bucket to send logs to. + The S3 bucket must already be created. +* **S3EncryptionEnabled**: bool: Determines whether to use encryption on the S3 logs. If not specified, encryption is not used. +* **S3KeyPrefix**: string: An optional folder in the S3 bucket to place logs in. -## Secret +## FirelensConfiguration ### Properties -* **Name**: string (Required) -* **ValueFrom**: string (Required) +* **Options**: [TaskDefinition_Options](#taskdefinitionoptions): The options to use when configuring the log router. This field is optional and can be used to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. + If specified, valid option keys are: + + ``enable-ecs-log-metadata``, which can be ``true`` or ``false`` + + ``config-file-type``, which can be ``s3`` or ``file`` + + ``config-file-value``, which is either an S3 ARN or a file path +* **Type**: string: The log router to use. The valid values are ``fluentd`` or ``fluentbit``. -## ServiceConnectService +## FSxAuthorizationConfig ### Properties -* **ClientAliases**: [ServiceConnectClientAlias](#serviceconnectclientalias)[] -* **DiscoveryName**: string -* **IngressPortOverride**: int -* **PortName**: string (Required) +* **CredentialsParameter**: string (Required) +* **Domain**: string (Required) -## ServiceConnectClientAlias +## FSxWindowsFileServerVolumeConfiguration ### Properties -* **DnsName**: string -* **Port**: int (Required) +* **AuthorizationConfig**: [FSxAuthorizationConfig](#fsxauthorizationconfig): The authorization configuration details for the Amazon FSx for Windows File Server file system. +* **FileSystemId**: string (Required): The Amazon FSx for Windows File Server file system ID to use. +* **RootDirectory**: string (Required): The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host. -## ServiceRegistry +## HealthCheck ### Properties -* **ContainerName**: string -* **ContainerPort**: int -* **Port**: int -* **RegistryArn**: string +* **Command**: string[]: A string array representing the command that the container runs to determine if it is healthy. The string array must start with ``CMD`` to run the command arguments directly, or ``CMD-SHELL`` to run the command with the container's default shell. + When you use the AWS Management Console JSON panel, the CLIlong, or the APIs, enclose the list of commands in double quotes and brackets. + ``[ "CMD-SHELL", "curl -f http://localhost/ || exit 1" ]`` + You don't include the double quotes and brackets when you use the AWS Management Console. + ``CMD-SHELL, curl -f http://localhost/ || exit 1`` + An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, see ``HealthCheck`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/). +* **Interval**: int: The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds. +* **Retries**: int: The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3. +* **StartPeriod**: int: The optional grace period to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You can specify between 0 and 300 seconds. By default, the ``startPeriod`` is off. + If a health check succeeds within the ``startPeriod``, then the container is considered healthy and any subsequent failures count toward the maximum number of retries. +* **Timeout**: int: The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5. -## Tag +## HostEntry ### Properties -* **Key**: string -* **Value**: string +* **Hostname**: string: The hostname to use in the ``/etc/hosts`` entry. +* **IpAddress**: string: The IP address to use in the ``/etc/hosts`` entry. -## ServiceVolumeConfiguration +## HostVolumeProperties ### Properties -* **ManagedEBSVolume**: [ServiceManagedEBSVolumeConfiguration](#servicemanagedebsvolumeconfiguration) -* **Name**: string (Required) +* **SourcePath**: string: When the ``host`` parameter is used, specify a ``sourcePath`` to declare the path on the host container instance that's presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the ``host`` parameter contains a ``sourcePath`` file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the ``sourcePath`` value doesn't exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported. + If you're using the Fargate launch type, the ``sourcePath`` parameter is not supported. -## ServiceManagedEBSVolumeConfiguration +## InferenceAccelerator ### Properties -* **Encrypted**: bool -* **FilesystemType**: string -* **Iops**: int -* **KmsKeyId**: string -* **RoleArn**: string (Required) -* **SizeInGiB**: int -* **SnapshotId**: string -* **TagSpecifications**: [EBSTagSpecification](#ebstagspecification)[] -* **Throughput**: int -* **VolumeType**: string +* **DeviceName**: string: The Elastic Inference accelerator device name. The ``deviceName`` must also be referenced in a container definition as a [ResourceRequirement](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ResourceRequirement.html). +* **DeviceType**: string: The Elastic Inference accelerator type to use. -## EBSTagSpecification +## KernelCapabilities ### Properties -* **PropagateTags**: string -* **ResourceType**: string (Required) -* **Tags**: [Tag](#tag)[] +* **Add**: string[]: The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to ``CapAdd`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--cap-add`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). + Tasks launched on FARGATElong only support adding the ``SYS_PTRACE`` kernel capability. + Valid values: ``"ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"`` +* **Drop**: string[]: The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to ``CapDrop`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--cap-drop`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). + Valid values: ``"ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"`` -## AWS.ECS/TaskDefinitionProperties +## KeyValuePair ### Properties -* **ContainerDefinitions**: [ContainerDefinition](#containerdefinition)[] -* **Cpu**: string -* **EphemeralStorage**: [EphemeralStorage](#ephemeralstorage) -* **ExecutionRoleArn**: string -* **Family**: string -* **InferenceAccelerators**: [InferenceAccelerator](#inferenceaccelerator)[] -* **IpcMode**: string -* **Memory**: string -* **NetworkMode**: string -* **PidMode**: string -* **PlacementConstraints**: [TaskDefinitionPlacementConstraint](#taskdefinitionplacementconstraint)[] -* **ProxyConfiguration**: [ProxyConfiguration](#proxyconfiguration) -* **RequiresCompatibilities**: string[] -* **RuntimePlatform**: [RuntimePlatform](#runtimeplatform) -* **Tags**: [Tag](#tag)[] -* **TaskDefinitionArn**: string (ReadOnly, Identifier): The Amazon Resource Name (ARN) of the Amazon ECS task definition -* **TaskRoleArn**: string -* **Volumes**: [Volume](#volume)[] +* **Name**: string: The name of the key-value pair. For environment variables, this is the name of the environment variable. +* **Value**: string: The value of the key-value pair. For environment variables, this is the value of the environment variable. -## ContainerDefinition +## LinuxParameters ### Properties -* **Command**: string[] -* **Cpu**: int -* **DependsOn**: [ContainerDependency](#containerdependency)[] -* **DisableNetworking**: bool -* **DnsSearchDomains**: string[] -* **DnsServers**: string[] -* **DockerLabels**: [TaskDefinition_DockerLabels](#taskdefinitiondockerlabels) -* **DockerSecurityOptions**: string[] -* **EntryPoint**: string[] -* **Environment**: [KeyValuePair](#keyvaluepair)[]: The environment variables to pass to a container -* **EnvironmentFiles**: [EnvironmentFile](#environmentfile)[]: The list of one or more files that contain the environment variables to pass to a container -* **Essential**: bool -* **ExtraHosts**: [HostEntry](#hostentry)[] -* **FirelensConfiguration**: [FirelensConfiguration](#firelensconfiguration) -* **HealthCheck**: [HealthCheck](#healthcheck) -* **Hostname**: string -* **Image**: string (Required): The image used to start a container. This string is passed directly to the Docker daemon. -* **Interactive**: bool -* **Links**: string[] -* **LinuxParameters**: [LinuxParameters](#linuxparameters) -* **LogConfiguration**: [LogConfiguration](#logconfiguration) -* **Memory**: int: The amount (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. -* **MemoryReservation**: int -* **MountPoints**: [MountPoint](#mountpoint)[] -* **Name**: string (Required): The name of a container. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed -* **PortMappings**: [PortMapping](#portmapping)[]: Port mappings allow containers to access ports on the host container instance to send or receive traffic. -* **Privileged**: bool -* **PseudoTerminal**: bool -* **ReadonlyRootFilesystem**: bool -* **RepositoryCredentials**: [RepositoryCredentials](#repositorycredentials) -* **ResourceRequirements**: [ResourceRequirement](#resourcerequirement)[] -* **Secrets**: [Secret](#secret)[] -* **StartTimeout**: int -* **StopTimeout**: int -* **SystemControls**: [SystemControl](#systemcontrol)[] -* **Ulimits**: [Ulimit](#ulimit)[] -* **User**: string -* **VolumesFrom**: [VolumeFrom](#volumefrom)[] -* **WorkingDirectory**: string +* **Capabilities**: [KernelCapabilities](#kernelcapabilities): The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker. + For tasks that use the Fargate launch type, ``capabilities`` is supported for all platform versions but the ``add`` parameter is only supported if using platform version 1.4.0 or later. +* **Devices**: [Device](#device)[]: Any host devices to expose to the container. This parameter maps to ``Devices`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--device`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). + If you're using tasks that use the Fargate launch type, the ``devices`` parameter isn't supported. +* **InitProcessEnabled**: bool: Run an ``init`` process inside the container that forwards signals and reaps processes. This parameter maps to the ``--init`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'`` +* **MaxSwap**: int: The total amount of swap memory (in MiB) a container can use. This parameter will be translated to the ``--memory-swap`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration) where the value would be the sum of the container memory plus the ``maxSwap`` value. + If a ``maxSwap`` value of ``0`` is specified, the container will not use swap. Accepted values are ``0`` or any positive integer. If the ``maxSwap`` parameter is omitted, the container will use the swap configuration for the container instance it is running on. A ``maxSwap`` value must be set for the ``swappiness`` parameter to be used. + If you're using tasks that use the Fargate launch type, the ``maxSwap`` parameter isn't supported. + If you're using tasks on Amazon Linux 2023 the ``swappiness`` parameter isn't supported. +* **SharedMemorySize**: int: The value for the size (in MiB) of the ``/dev/shm`` volume. This parameter maps to the ``--shm-size`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). + If you are using tasks that use the Fargate launch type, the ``sharedMemorySize`` parameter is not supported. +* **Swappiness**: int: This allows you to tune a container's memory swappiness behavior. A ``swappiness`` value of ``0`` will cause swapping to not happen unless absolutely necessary. A ``swappiness`` value of ``100`` will cause pages to be swapped very aggressively. Accepted values are whole numbers between ``0`` and ``100``. If the ``swappiness`` parameter is not specified, a default value of ``60`` is used. If a value is not specified for ``maxSwap`` then this parameter is ignored. This parameter maps to the ``--memory-swappiness`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). + If you're using tasks that use the Fargate launch type, the ``swappiness`` parameter isn't supported. + If you're using tasks on Amazon Linux 2023 the ``swappiness`` parameter isn't supported. +* **Tmpfs**: [Tmpfs](#tmpfs)[]: The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the ``--tmpfs`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). + If you're using tasks that use the Fargate launch type, the ``tmpfs`` parameter isn't supported. -## ContainerDependency +## LoadBalancer ### Properties -* **Condition**: string -* **ContainerName**: string +* **ContainerName**: string: The name of the container (as it appears in a container definition) to associate with the load balancer. + You need to specify the container name when configuring the target group for an Amazon ECS load balancer. +* **ContainerPort**: int: The port on the container to associate with the load balancer. This port must correspond to a ``containerPort`` in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they're launched on must allow ingress traffic on the ``hostPort`` of the port mapping. +* **LoadBalancerName**: string: The name of the load balancer to associate with the Amazon ECS service or task set. + If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted. +* **TargetGroupArn**: string: The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set. + A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. + For services using the ``ECS`` deployment controller, you can specify one or multiple target groups. For more information, see [Registering multiple target groups with a service](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html) in the *Amazon Elastic Container Service Developer Guide*. + For services using the ``CODE_DEPLOY`` deployment controller, you're required to define two target groups for the load balancer. For more information, see [Blue/green deployment with CodeDeploy](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-bluegreen.html) in the *Amazon Elastic Container Service Developer Guide*. + If your service's task definition uses the ``awsvpc`` network mode, you must choose ``ip`` as the target type, not ``instance``. Do this when creating your target groups because tasks that use the ``awsvpc`` network mode are associated with an elastic network interface, not an Amazon EC2 instance. This network mode is required for the Fargate launch type. -## TaskDefinition_DockerLabels +## LoadBalancer ### Properties +* **ContainerName**: string: The name of the container (as it appears in a container definition) to associate with the load balancer. +* **ContainerPort**: int: The port on the container to associate with the load balancer. This port must correspond to a containerPort in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they are launched on must allow ingress traffic on the hostPort of the port mapping. +* **TargetGroupArn**: string: The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set. A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you are using a Classic Load Balancer this should be omitted. For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html in the Amazon Elastic Container Service Developer Guide. For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-bluegreen.html in the Amazon Elastic Container Service Developer Guide. If your service's task definition uses the awsvpc network mode (which is required for the Fargate launch type), you must choose ip as the target type, not instance, when creating your target groups because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance. -## KeyValuePair +## LogConfiguration ### Properties -* **Name**: string -* **Value**: string +* **LogDriver**: string: The log driver to use for the container. + For tasks on FARGATElong, the supported log drivers are ``awslogs``, ``splunk``, and ``awsfirelens``. + For tasks hosted on Amazon EC2 instances, the supported log drivers are ``awslogs``, ``fluentd``, ``gelf``, ``json-file``, ``journald``, ``logentries``,``syslog``, ``splunk``, and ``awsfirelens``. + For more information about using the ``awslogs`` log driver, see [Using the awslogs log driver](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html) in the *Amazon Elastic Container Service Developer Guide*. + For more information about using the ``awsfirelens`` log driver, see [Custom log routing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) in the *Amazon Elastic Container Service Developer Guide*. + If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's [available on GitHub](https://docs.aws.amazon.com/https://github.com/aws/amazon-ecs-agent) and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we don't currently provide support for running modified copies of this software. +* **Options**: [Service_Options](#serviceoptions): The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'`` +* **SecretOptions**: [Secret](#secret)[]: The secrets to pass to the log configuration. For more information, see [Specifying sensitive data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer Guide*. -## EnvironmentFile +## LogConfiguration ### Properties -* **Type**: string -* **Value**: string +* **LogDriver**: string (Required): The log driver to use for the container. + For tasks on FARGATElong, the supported log drivers are ``awslogs``, ``splunk``, and ``awsfirelens``. + For tasks hosted on Amazon EC2 instances, the supported log drivers are ``awslogs``, ``fluentd``, ``gelf``, ``json-file``, ``journald``, ``logentries``,``syslog``, ``splunk``, and ``awsfirelens``. + For more information about using the ``awslogs`` log driver, see [Using the awslogs log driver](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html) in the *Amazon Elastic Container Service Developer Guide*. + For more information about using the ``awsfirelens`` log driver, see [Custom log routing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) in the *Amazon Elastic Container Service Developer Guide*. + If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's [available on GitHub](https://docs.aws.amazon.com/https://github.com/aws/amazon-ecs-agent) and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we don't currently provide support for running modified copies of this software. +* **Options**: [TaskDefinition_Options](#taskdefinitionoptions): The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'`` +* **SecretOptions**: [Secret](#secret)[]: The secrets to pass to the log configuration. For more information, see [Specifying sensitive data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer Guide*. -## HostEntry +## ManagedScaling ### Properties -* **Hostname**: string -* **IpAddress**: string +* **InstanceWarmupPeriod**: int +* **MaximumScalingStepSize**: int +* **MinimumScalingStepSize**: int +* **Status**: string +* **TargetCapacity**: int -## FirelensConfiguration +## ManagedStorageConfiguration ### Properties -* **Options**: [TaskDefinition_Options](#taskdefinitionoptions) -* **Type**: string +* **FargateEphemeralStorageKmsKeyId**: string +* **KmsKeyId**: string -## TaskDefinition_Options +## MountPoint ### Properties +* **ContainerPath**: string: The path on the container to mount the host volume at. +* **ReadOnly**: bool: If this value is ``true``, the container has read-only access to the volume. If this value is ``false``, then the container can write to the volume. The default value is ``false``. +* **SourceVolume**: string: The name of the volume to mount. Must be a volume name referenced in the ``name`` parameter of task definition ``volume``. -## HealthCheck +## NetworkConfiguration ### Properties -* **Command**: string[]: A string array representing the command that the container runs to determine if it is healthy. -* **Interval**: int: The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds. -* **Retries**: int: The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is three retries. -* **StartPeriod**: int: The optional grace period within which to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You may specify between 0 and 300 seconds. The startPeriod is disabled by default. -* **Timeout**: int: The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5 seconds. +* **AwsvpcConfiguration**: [AwsVpcConfiguration](#awsvpcconfiguration): The VPC subnets and security groups that are associated with a task. + All specified subnets and security groups must be from the same VPC. -## LinuxParameters +## NetworkConfiguration ### Properties -* **Capabilities**: [KernelCapabilities](#kernelcapabilities) -* **Devices**: [Device](#device)[] -* **InitProcessEnabled**: bool -* **MaxSwap**: int -* **SharedMemorySize**: int -* **Swappiness**: int -* **Tmpfs**: [Tmpfs](#tmpfs)[] +* **AwsVpcConfiguration**: [AwsVpcConfiguration](#awsvpcconfiguration) -## KernelCapabilities +## PlacementConstraint ### Properties -* **Add**: string[] -* **Drop**: string[] +* **Expression**: string: A cluster query language expression to apply to the constraint. The expression can have a maximum length of 2000 characters. You can't specify an expression if the constraint type is ``distinctInstance``. For more information, see [Cluster query language](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) in the *Amazon Elastic Container Service Developer Guide*. +* **Type**: string (Required): The type of constraint. Use ``distinctInstance`` to ensure that each task in a particular group is running on a different container instance. Use ``memberOf`` to restrict the selection to a group of valid candidates. -## Device +## PlacementStrategy ### Properties -* **ContainerPath**: string -* **HostPath**: string -* **Permissions**: string[] +* **Field**: string: The field to apply the placement strategy against. For the ``spread`` placement strategy, valid values are ``instanceId`` (or ``host``, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as ``attribute:ecs.availability-zone``. For the ``binpack`` placement strategy, valid values are ``CPU`` and ``MEMORY``. For the ``random`` placement strategy, this field is not used. +* **Type**: string (Required): The type of placement strategy. The ``random`` placement strategy randomly places tasks on available candidates. The ``spread`` placement strategy spreads placement across available candidates evenly based on the ``field`` parameter. The ``binpack`` strategy places tasks on available candidates that have the least available amount of the resource that's specified with the ``field`` parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory but still enough to run the task. -## Tmpfs +## PortMapping ### Properties -* **ContainerPath**: string -* **MountOptions**: string[] -* **Size**: int (Required) +* **AppProtocol**: string: The application protocol that's used for the port mapping. This parameter only applies to Service Connect. We recommend that you set this parameter to be consistent with the protocol that your application uses. If you set this parameter, Amazon ECS adds protocol-specific connection handling to the Service Connect proxy. If you set this parameter, Amazon ECS adds protocol-specific telemetry in the Amazon ECS console and CloudWatch. + If you don't set a value for this parameter, then TCP is used. However, Amazon ECS doesn't add protocol-specific telemetry for TCP. + ``appProtocol`` is immutable in a Service Connect service. Updating this field requires a service deletion and redeployment. + Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*. +* **ContainerPort**: int: The port number on the container that's bound to the user-specified or automatically assigned host port. + If you use containers in a task with the ``awsvpc`` or ``host`` network mode, specify the exposed ports using ``containerPort``. + If you use containers in a task with the ``bridge`` network mode and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range. For more information, see ``hostPort``. Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance. +* **ContainerPortRange**: string: The port number range on the container that's bound to the dynamically mapped host port range. + The following rules apply when you specify a ``containerPortRange``: + + You must use either the ``bridge`` network mode or the ``awsvpc`` network mode. + + This parameter is available for both the EC2 and FARGATElong launch types. + + This parameter is available for both the Linux and Windows operating systems. + + The container instance must have at least version 1.67.0 of the container agent and at least version 1.67.0-1 of the ``ecs-init`` package + + You can specify a maximum of 100 port ranges per container. + + You do not specify a ``hostPortRange``. The value of the ``hostPortRange`` is set as follows: + + For containers in a task with the ``awsvpc`` network mode, the ``hostPortRange`` is set to the same value as the ``containerPortRange``. This is a static mapping strategy. + + For containers in a task with the ``bridge`` network mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports. + + + The ``containerPortRange`` valid values are between 1 and 65535. + + A port can only be included in one port mapping per container. + + You cannot specify overlapping port ranges. + + The first port in the range must be less than last port in the range. + + Docker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports. + For more information, see [Issue #11185](https://docs.aws.amazon.com/https://github.com/moby/moby/issues/11185) on the Github website. + For information about how to turn off the docker-proxy in the Docker daemon 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 Guide*. + + You can call [DescribeTasks](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html) to view the ``hostPortRange`` which are the host ports that are bound to the container ports. +* **HostPort**: int: The port number on the container instance to reserve for your container. + If you specify a ``containerPortRange``, leave this field empty and the value of the ``hostPort`` is set as follows: + + For containers in a task with the ``awsvpc`` network mode, the ``hostPort`` is set to the same value as the ``containerPort``. This is a static mapping strategy. + + For containers in a task with the ``bridge`` network mode, the Amazon ECS agent finds open ports on the host and automatically binds them to the container ports. This is a dynamic mapping strategy. + + If you use containers in a task with the ``awsvpc`` or ``host`` network mode, the ``hostPort`` can either be left blank or set to the same value as the ``containerPort``. + If you use containers in a task with the ``bridge`` network mode, you can specify a non-reserved host port for your container port mapping, or you can omit the ``hostPort`` (or set it to ``0``) while specifying a ``containerPort`` and your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version. + The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under ``/proc/sys/net/ipv4/ip_local_port_range``. If this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 (Linux) or 49152 through 65535 (Windows) is used. Do not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range. + The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678-51680. Any host port that was previously specified in a running task is also reserved while the task is running. That is, after a task stops, the host port is released. The current reserved ports are displayed in the ``remainingResources`` of [DescribeContainerInstances](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeContainerInstances.html) output. A container instance can have up to 100 reserved ports at a time. This number includes the default reserved ports. Automatically assigned ports aren't included in the 100 reserved ports quota. +* **Name**: string: The name that's used for the port mapping. This parameter only applies to Service Connect. This parameter is the name that you use in the ``serviceConnectConfiguration`` of a service. The name can include up to 64 characters. The characters can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen. + For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*. +* **Protocol**: string: The protocol used for the port mapping. Valid values are ``tcp`` and ``udp``. The default is ``tcp``. ``protocol`` is immutable in a Service Connect service. Updating this field requires a service deletion and redeployment. -## LogConfiguration +## ProxyConfiguration ### Properties -* **LogDriver**: string (Required) -* **Options**: [TaskDefinition_Options](#taskdefinitionoptions) -* **SecretOptions**: [Secret](#secret)[] +* **ContainerName**: string (Required): The name of the container that will serve as the App Mesh proxy. +* **ProxyConfigurationProperties**: [KeyValuePair](#keyvaluepair)[]: The set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified as key-value pairs. + + ``IgnoredUID`` - (Required) The user ID (UID) of the proxy container as defined by the ``user`` parameter in a container definition. This is used to ensure the proxy ignores its own traffic. If ``IgnoredGID`` is specified, this field can be empty. + + ``IgnoredGID`` - (Required) The group ID (GID) of the proxy container as defined by the ``user`` parameter in a container definition. This is used to ensure the proxy ignores its own traffic. If ``IgnoredUID`` is specified, this field can be empty. + + ``AppPorts`` - (Required) The list of ports that the application uses. Network traffic to these ports is forwarded to the ``ProxyIngressPort`` and ``ProxyEgressPort``. + + ``ProxyIngressPort`` - (Required) Specifies the port that incoming traffic to the ``AppPorts`` is directed to. + + ``ProxyEgressPort`` - (Required) Specifies the port that outgoing traffic from the ``AppPorts`` is directed to. + + ``EgressIgnoredPorts`` - (Required) The egress traffic going to the specified ports is ignored and not redirected to the ``ProxyEgressPort``. It can be an empty list. + + ``EgressIgnoredIPs`` - (Required) The egress traffic going to the specified IP addresses is ignored and not redirected to the ``ProxyEgressPort``. It can be an empty list. +* **Type**: string: The proxy type. The only supported value is ``APPMESH``. -## TaskDefinition_Options +## RepositoryCredentials ### Properties +* **CredentialsParameter**: string: The Amazon Resource Name (ARN) of the secret containing the private repository credentials. + When you use the Amazon ECS API, CLI, or AWS SDK, if the secret exists in the same Region as the task that you're launching then you can use either the full ARN or the name of the secret. When you use the AWS Management Console, you must specify the full ARN of the secret. + +## ResourceRequirement +### Properties +* **Type**: string (Required): The type of resource to assign to a container. +* **Value**: string (Required): The value for the specified resource type. + When the type is ``GPU``, the value is the number of physical ``GPUs`` the Amazon ECS container agent reserves for the container. The number of GPUs that's reserved for all containers in a task can't exceed the number of available GPUs on the container instance that the task is launched on. + When the type is ``InferenceAccelerator``, the ``value`` matches the ``deviceName`` for an [InferenceAccelerator](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_InferenceAccelerator.html) specified in a task definition. + +## RuntimePlatform +### Properties +* **CpuArchitecture**: string: The CPU architecture. + You can run your Linux tasks on an ARM-based platform by setting the value to ``ARM64``. This option is available for tasks that run on Linux Amazon EC2 instance or Linux containers on Fargate. +* **OperatingSystemFamily**: string: The operating system. + +## Scale +### Properties +* **Unit**: string: The unit of measure for the scale value. +* **Value**: int: The value, specified as a percent total of a service's desiredCount, to scale the task set. Accepted values are numbers between 0 and 100. ## Secret ### Properties -* **Name**: string (Required) -* **ValueFrom**: string (Required) +* **Name**: string (Required): The name of the secret. +* **ValueFrom**: string (Required): The secret to expose to the container. The supported values are either the full ARN of the ASMlong secret or the full ARN of the parameter in the SSM Parameter Store. + For information about the require IAMlong permissions, see [Required IAM permissions for Amazon ECS secrets](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-secrets.html#secrets-iam) (for Secrets Manager) or [Required IAM permissions for Amazon ECS secrets](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-parameters.html) (for Systems Manager Parameter store) in the *Amazon Elastic Container Service Developer Guide*. + If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified. -## MountPoint +## Secret ### Properties -* **ContainerPath**: string -* **ReadOnly**: bool -* **SourceVolume**: string +* **Name**: string (Required): The name of the secret. +* **ValueFrom**: string (Required): The secret to expose to the container. The supported values are either the full ARN of the ASMlong secret or the full ARN of the parameter in the SSM Parameter Store. + For information about the require IAMlong permissions, see [Required IAM permissions for Amazon ECS secrets](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-secrets.html#secrets-iam) (for Secrets Manager) or [Required IAM permissions for Amazon ECS secrets](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-parameters.html) (for Systems Manager Parameter store) in the *Amazon Elastic Container Service Developer Guide*. + If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified. -## PortMapping +## Service_Options ### Properties -* **AppProtocol**: string -* **ContainerPort**: int -* **ContainerPortRange**: string -* **HostPort**: int -* **Name**: string -* **Protocol**: string -## RepositoryCredentials +## ServiceConnectClientAlias ### Properties -* **CredentialsParameter**: string +* **DnsName**: string: The ``dnsName`` is the name that you use in the applications of client tasks to connect to this service. The name must be a valid DNS name but doesn't need to be fully-qualified. The name can include up to 127 characters. The name can include lowercase letters, numbers, underscores (_), hyphens (-), and periods (.). The name can't start with a hyphen. + If this parameter isn't specified, the default value of ``discoveryName.namespace`` is used. If the ``discoveryName`` isn't specified, the port mapping name from the task definition is used in ``portName.namespace``. + To avoid changing your applications in client Amazon ECS services, set this to the same name that the client application uses by default. For example, a few common names are ``database``, ``db``, or the lowercase name of a database, such as ``mysql`` or ``redis``. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*. +* **Port**: int (Required): The listening port number for the Service Connect proxy. This port is available inside of all of the tasks within the same namespace. + To avoid changing your applications in client Amazon ECS services, set this to the same port that the client application uses by default. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*. -## ResourceRequirement +## ServiceConnectConfiguration ### Properties -* **Type**: string (Required) -* **Value**: string (Required) +* **Enabled**: bool (Required): Specifies whether to use Service Connect with this service. +* **LogConfiguration**: [LogConfiguration](#logconfiguration): The log configuration for the container. This parameter maps to ``LogConfig`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--log-driver`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/commandline/run/). + By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a different logging driver than the Docker daemon by specifying a log driver configuration in the container definition. For more information about the options for different supported log drivers, see [Configure logging drivers](https://docs.aws.amazon.com/https://docs.docker.com/engine/admin/logging/overview/) in the Docker documentation. + Understand the following when specifying a log configuration for your containers. + + Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon. Additional log drivers may be available in future releases of the Amazon ECS container agent. + For tasks on FARGATElong, the supported log drivers are ``awslogs``, ``splunk``, and ``awsfirelens``. + For tasks hosted on Amazon EC2 instances, the supported log drivers are ``awslogs``, ``fluentd``, ``gelf``, ``json-file``, ``journald``, ``logentries``,``syslog``, ``splunk``, and ``awsfirelens``. + + This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. + + For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container agent must register the available logging drivers with the ``ECS_AVAILABLE_LOGGING_DRIVERS`` environment variable before containers placed on that instance can use these log configuration options. For more information, see [Amazon ECS container agent configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service Developer Guide*. + + For tasks that are on FARGATElong, because you don't have access to the underlying infrastructure your tasks are hosted on, any additional software needed must be installed outside of the task. For example, the Fluentd output aggregators or a remote host running Logstash to send Gelf logs to. +* **Namespace**: string: The namespace name or full Amazon Resource Name (ARN) of the CMAPlong namespace for use with Service Connect. The namespace must be in the same AWS Region as the Amazon ECS service and cluster. The type of namespace doesn't affect Service Connect. For more information about CMAPlong, see [Working with Services](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-services.html) in the *Developer Guide*. +* **Services**: [ServiceConnectService](#serviceconnectservice)[]: The list of Service Connect service objects. These are names and aliases (also known as endpoints) that are used by other Amazon ECS services to connect to this service. + This field is not required for a "client" Amazon ECS service that's a member of a namespace only to connect to other services within the namespace. An example of this would be a frontend application that accepts incoming requests from either a load balancer that's attached to the service or by other means. + An object selects a port from the task definition, assigns a name for the CMAPlong service, and a list of aliases (endpoints) and ports for client applications to refer to this service. -## SystemControl +## ServiceConnectDefaults ### Properties -* **Namespace**: string -* **Value**: string +* **Namespace**: string: The namespace name or full Amazon Resource Name (ARN) of the CMAPlong namespace that's used when you create a service and don't specify a Service Connect configuration. The namespace name can include up to 1024 characters. The name is case-sensitive. The name can't include hyphens (-), tilde (~), greater than (>), less than (<), or slash (/). + If you enter an existing namespace name or ARN, then that namespace will be used. Any namespace type is supported. The namespace must be in this account and this AWS Region. + If you enter a new name, a CMAPlong namespace will be created. Amazon ECS creates a CMAP namespace with the "API calls" method of instance discovery only. This instance discovery method is the "HTTP" namespace type in the CLIlong. Other types of instance discovery aren't used by Service Connect. + If you update the cluster with an empty string ``""`` for the namespace name, the cluster configuration for Service Connect is removed. Note that the namespace will remain in CMAP and must be deleted separately. + For more information about CMAPlong, see [Working with Services](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-services.html) in the *Developer Guide*. -## Ulimit +## ServiceConnectService ### Properties -* **HardLimit**: int (Required) -* **Name**: string (Required) -* **SoftLimit**: int (Required) +* **ClientAliases**: [ServiceConnectClientAlias](#serviceconnectclientalias)[]: The list of client aliases for this Service Connect service. You use these to assign names that can be used by client applications. The maximum number of client aliases that you can have in this list is 1. + Each alias ("endpoint") is a fully-qualified name and port number that other Amazon ECS tasks ("clients") can use to connect to this service. + Each name and port mapping must be unique within the namespace. + For each ``ServiceConnectService``, you must provide at least one ``clientAlias`` with one ``port``. +* **DiscoveryName**: string: The ``discoveryName`` is the name of the new CMAP service that Amazon ECS creates for this Amazon ECS service. This must be unique within the CMAP namespace. The name can contain up to 64 characters. The name can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen. + If the ``discoveryName`` isn't specified, the port mapping name from the task definition is used in ``portName.namespace``. +* **IngressPortOverride**: int: The port number for the Service Connect proxy to listen on. + Use the value of this field to bypass the proxy for traffic on the port number specified in the named ``portMapping`` in the task definition of this application, and then use it in your VPC security groups to allow traffic into the proxy for this Amazon ECS service. + In ``awsvpc`` mode and Fargate, the default value is the container port number. The container port number is in the ``portMapping`` in the task definition. In bridge mode, the default value is the ephemeral port of the Service Connect proxy. +* **PortName**: string (Required): The ``portName`` must match the name of one of the ``portMappings`` from all the containers in the task definition of this Amazon ECS service. +* **Timeout**: [TimeoutConfiguration](#timeoutconfiguration): A reference to an object that represents the configured timeouts for Service Connect. +* **Tls**: [ServiceConnectTlsConfiguration](#serviceconnecttlsconfiguration): A reference to an object that represents a Transport Layer Security (TLS) configuration. -## VolumeFrom +## ServiceConnectTlsCertificateAuthority ### Properties -* **ReadOnly**: bool -* **SourceContainer**: string +* **AwsPcaAuthorityArn**: string: The ARN of the AWS Private Certificate Authority certificate. -## EphemeralStorage +## ServiceConnectTlsConfiguration ### Properties -* **SizeInGiB**: int +* **IssuerCertificateAuthority**: [ServiceConnectTlsCertificateAuthority](#serviceconnecttlscertificateauthority) (Required): The signer certificate authority. +* **KmsKey**: string: The AWS Key Management Service key. +* **RoleArn**: string: The Amazon Resource Name (ARN) of the IAM role that's associated with the Service Connect TLS. -## InferenceAccelerator +## ServiceManagedEBSVolumeConfiguration ### Properties -* **DeviceName**: string -* **DeviceType**: string +* **Encrypted**: bool: Indicates whether the volume should be encrypted. If no value is specified, encryption is turned on by default. This parameter maps 1:1 with the ``Encrypted`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*. +* **FilesystemType**: string: The Linux filesystem type for the volume. For volumes created from a snapshot, you must specify the same filesystem type that the volume was using when the snapshot was created. If there is a filesystem type mismatch, the task will fail to start. + The available filesystem types are? ``ext3``, ``ext4``, and ``xfs``. If no value is specified, the ``xfs`` filesystem type is used by default. +* **Iops**: int: The number of I/O operations per second (IOPS). For ``gp3``, ``io1``, and ``io2`` volumes, this represents the number of IOPS that are provisioned for the volume. For ``gp2`` volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. + The following are the supported values for each volume type. + + ``gp3``: 3,000 - 16,000 IOPS + + ``io1``: 100 - 64,000 IOPS + + ``io2``: 100 - 256,000 IOPS + + This parameter is required for ``io1`` and ``io2`` volume types. The default for ``gp3`` volumes is ``3,000 IOPS``. This parameter is not supported for ``st1``, ``sc1``, or ``standard`` volume types. + This 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 Reference*. +* **KmsKeyId**: string: The Amazon Resource Name (ARN) identifier of the AWS Key Management Service key to use for Amazon EBS encryption. When encryption is turned on and no AWS Key Management Service key is specified, the default AWS managed key for Amazon EBS volumes is used. This parameter maps 1:1 with the ``KmsKeyId`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*. + AWS authenticates the AWS Key Management Service key asynchronously. Therefore, if you specify an ID, alias, or ARN that is invalid, the action can appear to complete, but eventually fails. +* **RoleArn**: string (Required): The ARN of the IAM role to associate with this volume. This is the Amazon ECS infrastructure IAM role that is used to manage your AWS infrastructure. We recommend using the Amazon ECS-managed ``AmazonECSInfrastructureRolePolicyForVolumes`` IAM policy with this role. For more information, see [Amazon ECS infrastructure IAM role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/infrastructure_IAM_role.html) in the *Amazon ECS Developer Guide*. +* **SizeInGiB**: int: The size of the volume in GiB. You must specify either a volume size or a snapshot ID. If you specify a snapshot ID, the snapshot size is used for the volume size by default. You can optionally specify a volume size greater than or equal to the snapshot size. This 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 Reference*. + The following are the supported volume size values for each volume type. + + ``gp2`` and ``gp3``: 1-16,384 + + ``io1`` and ``io2``: 4-16,384 + + ``st1`` and ``sc1``: 125-16,384 + + ``standard``: 1-1,024 +* **SnapshotId**: string: The snapshot that Amazon ECS uses to create the volume. You must specify either a snapshot ID or a volume size. This parameter maps 1:1 with the ``SnapshotId`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*. +* **TagSpecifications**: [EBSTagSpecification](#ebstagspecification)[]: The tags to apply to the volume. Amazon ECS applies service-managed tags by default. This parameter maps 1:1 with the ``TagSpecifications.N`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*. +* **Throughput**: int: The throughput to provision for a volume, in MiB/s, with a maximum of 1,000 MiB/s. This 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 Reference*. + This parameter is only supported for the ``gp3`` volume type. +* **VolumeType**: string: The volume type. This parameter maps 1:1 with the ``VolumeType`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*. For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volume-types.html) in the *Amazon EC2 User Guide*. + The following are the supported volume types. + + General Purpose SSD: ``gp2``|``gp3`` + + Provisioned IOPS SSD: ``io1``|``io2`` + + Throughput Optimized HDD: ``st1`` + + Cold HDD: ``sc1`` + + Magnetic: ``standard`` + The magnetic volume type is not supported on Fargate. -## TaskDefinitionPlacementConstraint +## ServiceRegistry ### Properties -* **Expression**: string -* **Type**: string (Required) +* **ContainerName**: string: The container name value to be used for your service discovery service. It's already specified in the task definition. If the task definition that your service task specifies uses the ``bridge`` or ``host`` network mode, you must specify a ``containerName`` and ``containerPort`` combination from the task definition. If the task definition that your service task specifies uses the ``awsvpc`` network mode and a type SRV DNS record is used, you must specify either a ``containerName`` and ``containerPort`` combination or a ``port`` value. However, you can't specify both. +* **ContainerPort**: int: The port value to be used for your service discovery service. It's already specified in the task definition. If the task definition your service task specifies uses the ``bridge`` or ``host`` network mode, you must specify a ``containerName`` and ``containerPort`` combination from the task definition. If the task definition your service task specifies uses the ``awsvpc`` network mode and a type SRV DNS record is used, you must specify either a ``containerName`` and ``containerPort`` combination or a ``port`` value. However, you can't specify both. +* **Port**: int: The port value used if your service discovery service specified an SRV record. This field might be used if both the ``awsvpc`` network mode and SRV records are used. +* **RegistryArn**: string: The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is CMAP. For more information, see [CreateService](https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html). -## ProxyConfiguration +## ServiceRegistry ### Properties -* **ContainerName**: string (Required) -* **ProxyConfigurationProperties**: [KeyValuePair](#keyvaluepair)[] -* **Type**: string +* **ContainerName**: string: The container name value, already specified in the task definition, to be used for your service discovery service. If the task definition that your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition that your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value, but not both. +* **ContainerPort**: int: The port value, already specified in the task definition, to be used for your service discovery service. If the task definition your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value, but not both. +* **Port**: int: The port value used if your service discovery service specified an SRV record. This field may be used if both the awsvpc network mode and SRV records are used. +* **RegistryArn**: string: The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is AWS Cloud Map. For more information, see https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html -## RuntimePlatform +## ServiceVolumeConfiguration ### Properties -* **CpuArchitecture**: string -* **OperatingSystemFamily**: string +* **ManagedEBSVolume**: [ServiceManagedEBSVolumeConfiguration](#servicemanagedebsvolumeconfiguration): The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf. These settings are used to create each Amazon EBS volume, with one volume created for each task in the service. The Amazon EBS volumes are visible in your account in the Amazon EC2 console once they are created. +* **Name**: string (Required): The name of the volume. This value must match the volume name from the ``Volume`` object in the task definition. + +## SystemControl +### Properties +* **Namespace**: string: The namespaced kernel parameter to set a ``value`` for. +* **Value**: string: The namespaced kernel parameter to set a ``value`` for. + Valid IPC namespace values: ``"kernel.msgmax" | "kernel.msgmnb" | "kernel.msgmni" | "kernel.sem" | "kernel.shmall" | "kernel.shmmax" | "kernel.shmmni" | "kernel.shm_rmid_forced"``, and ``Sysctls`` that start with ``"fs.mqueue.*"`` + Valid network namespace values: ``Sysctls`` that start with ``"net.*"`` + All of these values are supported by Fargate. ## Tag ### Properties * **Key**: string * **Value**: string -## Volume +## Tag ### Properties -* **DockerVolumeConfiguration**: [DockerVolumeConfiguration](#dockervolumeconfiguration) -* **EFSVolumeConfiguration**: [EFSVolumeConfiguration](#efsvolumeconfiguration) -* **Host**: [HostVolumeProperties](#hostvolumeproperties) -* **Name**: string +* **Key**: string: One part of a key-value pair that make up a tag. A ``key`` is a general label that acts like a category for more specific tag values. +* **Value**: string: The optional part of a key-value pair that make up a tag. A ``value`` acts as a descriptor within a tag category (key). -## DockerVolumeConfiguration +## Tag ### Properties -* **Autoprovision**: bool -* **Driver**: string -* **DriverOpts**: [TaskDefinition_DriverOpts](#taskdefinitiondriveropts) -* **Labels**: [TaskDefinition_Labels](#taskdefinitionlabels) -* **Scope**: string +* **Key**: string: One part of a key-value pair that make up a tag. A ``key`` is a general label that acts like a category for more specific tag values. +* **Value**: string: The optional part of a key-value pair that make up a tag. A ``value`` acts as a descriptor within a tag category (key). -## TaskDefinition_DriverOpts +## Tag ### Properties +* **Key**: string: One part of a key-value pair that make up a tag. A ``key`` is a general label that acts like a category for more specific tag values. +* **Value**: string: The optional part of a key-value pair that make up a tag. A ``value`` acts as a descriptor within a tag category (key). -## TaskDefinition_Labels +## Tag ### Properties +* **Key**: string +* **Value**: string -## EFSVolumeConfiguration +## TaskDefinition_DockerLabels ### Properties -* **AuthorizationConfig**: [AuthorizationConfig](#authorizationconfig) -* **FilesystemId**: string (Required) -* **RootDirectory**: string -* **TransitEncryption**: string -* **TransitEncryptionPort**: int -## AuthorizationConfig +## TaskDefinition_DriverOpts ### Properties -* **AccessPointId**: string -* **IAM**: string -## HostVolumeProperties +## TaskDefinition_Labels ### Properties -* **SourcePath**: string -## AWS.ECS/TaskSetProperties +## TaskDefinition_Options ### Properties -* **Cluster**: string (Required, Identifier): The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in. -* **ExternalId**: string: An optional non-unique tag that identifies this task set in external systems. If the task set is associated with a service discovery registry, the tasks in this task set will have the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute set to the provided value. -* **Id**: string (ReadOnly, Identifier): The ID of the task set. -* **LaunchType**: string: The launch type that new tasks in the task set will use. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html in the Amazon Elastic Container Service Developer Guide. -* **LoadBalancers**: [LoadBalancer](#loadbalancer)[] -* **NetworkConfiguration**: [NetworkConfiguration](#networkconfiguration) -* **PlatformVersion**: string: The platform version that the tasks in the task set should use. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used by default. -* **Scale**: [Scale](#scale): A floating-point percentage of the desired number of tasks to place and keep running in the task set. -* **Service**: string (Required, Identifier): The short name or full Amazon Resource Name (ARN) of the service to create the task set in. -* **ServiceRegistries**: [ServiceRegistry](#serviceregistry)[]: The details of the service discovery registries to assign to this task set. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html. -* **TaskDefinition**: string (Required): The short name or full Amazon Resource Name (ARN) of the task definition for the tasks in the task set to use. -## LoadBalancer +## TaskDefinition_Options ### Properties -* **ContainerName**: string: The name of the container (as it appears in a container definition) to associate with the load balancer. -* **ContainerPort**: int: The port on the container to associate with the load balancer. This port must correspond to a containerPort in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they are launched on must allow ingress traffic on the hostPort of the port mapping. -* **TargetGroupArn**: string: The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set. A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you are using a Classic Load Balancer this should be omitted. For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html in the Amazon Elastic Container Service Developer Guide. For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-bluegreen.html in the Amazon Elastic Container Service Developer Guide. If your service's task definition uses the awsvpc network mode (which is required for the Fargate launch type), you must choose ip as the target type, not instance, when creating your target groups because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance. -## NetworkConfiguration +## TaskDefinitionPlacementConstraint ### Properties -* **AwsVpcConfiguration**: [AwsVpcConfiguration](#awsvpcconfiguration) +* **Expression**: string: A cluster query language expression to apply to the constraint. For more information, see [Cluster query language](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) in the *Amazon Elastic Container Service Developer Guide*. +* **Type**: string (Required): The type of constraint. The ``MemberOf`` constraint restricts selection to be from a group of valid candidates. -## AwsVpcConfiguration +## TimeoutConfiguration ### Properties -* **AssignPublicIp**: string: Whether the task's elastic network interface receives a public IP address. The default value is DISABLED. -* **SecurityGroups**: string[]: The security groups associated with the task or service. If you do not specify a security group, the default security group for the VPC is used. There is a limit of 5 security groups that can be specified per AwsVpcConfiguration. -* **Subnets**: string[] (Required): The subnets associated with the task or service. There is a limit of 16 subnets that can be specified per AwsVpcConfiguration. +* **IdleTimeoutSeconds**: int: The amount of time in seconds a connection will stay active while idle. A value of ``0`` can be set to disable ``idleTimeout``. + The ``idleTimeout`` default for ``HTTP``/``HTTP2``/``GRPC`` is 5 minutes. + The ``idleTimeout`` default for ``TCP`` is 1 hour. +* **PerRequestTimeoutSeconds**: int: The amount of time waiting for the upstream to respond with a complete response per request. A value of ``0`` can be set to disable ``perRequestTimeout``. ``perRequestTimeout`` can only be set if Service Connect ``appProtocol`` isn't ``TCP``. Only ``idleTimeout`` is allowed for ``TCP`` ``appProtocol``. -## Scale +## Tmpfs ### Properties -* **Unit**: string: The unit of measure for the scale value. -* **Value**: int: The value, specified as a percent total of a service's desiredCount, to scale the task set. Accepted values are numbers between 0 and 100. +* **ContainerPath**: string: The absolute file path where the tmpfs volume is to be mounted. +* **MountOptions**: string[]: The list of tmpfs volume mount options. + Valid values: ``"defaults" | "ro" | "rw" | "suid" | "nosuid" | "dev" | "nodev" | "exec" | "noexec" | "sync" | "async" | "dirsync" | "remount" | "mand" | "nomand" | "atime" | "noatime" | "diratime" | "nodiratime" | "bind" | "rbind" | "unbindable" | "runbindable" | "private" | "rprivate" | "shared" | "rshared" | "slave" | "rslave" | "relatime" | "norelatime" | "strictatime" | "nostrictatime" | "mode" | "uid" | "gid" | "nr_inodes" | "nr_blocks" | "mpol"`` +* **Size**: int (Required): The maximum size (in MiB) of the tmpfs volume. -## ServiceRegistry +## Ulimit ### Properties -* **ContainerName**: string: The container name value, already specified in the task definition, to be used for your service discovery service. If the task definition that your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition that your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value, but not both. -* **ContainerPort**: int: The port value, already specified in the task definition, to be used for your service discovery service. If the task definition your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value, but not both. -* **Port**: int: The port value used if your service discovery service specified an SRV record. This field may be used if both the awsvpc network mode and SRV records are used. -* **RegistryArn**: string: The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is AWS Cloud Map. For more information, see https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html +* **HardLimit**: int (Required): The hard limit for the ``ulimit`` type. +* **Name**: string (Required): The ``type`` of the ``ulimit``. +* **SoftLimit**: int (Required): The soft limit for the ``ulimit`` type. + +## Volume +### Properties +* **ConfiguredAtLaunch**: bool: Indicates whether the volume should be configured at launch time. This is used to create Amazon EBS volumes for standalone tasks or tasks created as part of a service. Each task definition revision may only have one volume configured at launch in the volume configuration. + To configure a volume at launch time, use this task definition revision and specify a ``volumeConfigurations`` object when calling the ``CreateService``, ``UpdateService``, ``RunTask`` or ``StartTask`` APIs. +* **DockerVolumeConfiguration**: [DockerVolumeConfiguration](#dockervolumeconfiguration): This parameter is specified when you use Docker volumes. + Windows containers only support the use of the ``local`` driver. To use bind mounts, specify the ``host`` parameter instead. + Docker volumes aren't supported by tasks run on FARGATElong. +* **EFSVolumeConfiguration**: [EFSVolumeConfiguration](#efsvolumeconfiguration): This parameter is specified when you use an Amazon Elastic File System file system for task storage. +* **FSxWindowsFileServerVolumeConfiguration**: [FSxWindowsFileServerVolumeConfiguration](#fsxwindowsfileservervolumeconfiguration): This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage. +* **Host**: [HostVolumeProperties](#hostvolumeproperties): This parameter is specified when you use bind mount host volumes. The contents of the ``host`` parameter determine whether your bind mount host volume persists on the host container instance and where it's stored. If the ``host`` parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it stop running. + Windows containers can mount whole directories on the same drive as ``$env:ProgramData``. Windows containers can't mount directories on a different drive, and mount point can't be across drives. For example, you can mount ``C:\my\path:C:\my\path`` and ``D:\:D:\``, but not ``D:\my\path:C:\my\path`` or ``D:\:C:\my\path``. +* **Name**: string: The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. + When using a volume configured at launch, the ``name`` is required and must also be specified as the volume name in the ``ServiceVolumeConfiguration`` or ``TaskVolumeConfiguration`` parameter when creating your service or standalone task. + For all other types of volumes, this name is referenced in the ``sourceVolume`` parameter of the ``mountPoints`` object in the container definition. + When a volume is using the ``efsVolumeConfiguration``, the name is required. + +## VolumeFrom +### Properties +* **ReadOnly**: bool: If this value is ``true``, the container has read-only access to the volume. If this value is ``false``, then the container can write to the volume. The default value is ``false``. +* **SourceContainer**: string: The name of another container within the same task definition to mount volumes from. diff --git a/artifacts/bicep/aws/aws.efs/default/types.json b/artifacts/bicep/aws/aws.efs/default/types.json index 332059a2..57196529 100644 --- a/artifacts/bicep/aws/aws.efs/default/types.json +++ b/artifacts/bicep/aws/aws.efs/default/types.json @@ -1 +1,598 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"AccessPointTag","Properties":{"Key":{"Type":4,"Flags":0},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"CreationInfo","Properties":{"OwnerGid":{"Type":4,"Flags":1,"Description":"Specifies the POSIX group ID to apply to the RootDirectory. Accepts values from 0 to 2^32 (4294967295)."},"OwnerUid":{"Type":4,"Flags":1,"Description":"Specifies the POSIX user ID to apply to the RootDirectory. Accepts values from 0 to 2^32 (4294967295)."},"Permissions":{"Type":4,"Flags":1,"Description":"Specifies the POSIX permissions to apply to the RootDirectory, in the format of an octal number representing the file's mode bits."}}}},{"2":{"Name":"PosixUser","Properties":{"Gid":{"Type":4,"Flags":1,"Description":"The POSIX group ID used for all file system operations using this access point."},"SecondaryGids":{"Type":12,"Flags":0,"Description":"Secondary POSIX group IDs used for all file system operations using this access point."},"Uid":{"Type":4,"Flags":1,"Description":"The POSIX user ID used for all file system operations using this access point."}}}},{"2":{"Name":"RootDirectory","Properties":{"CreationInfo":{"Type":9,"Flags":0,"Description":"(Optional) Specifies the POSIX IDs and permissions to apply to the access point's RootDirectory. If the RootDirectory>Path specified does not exist, EFS creates the root directory using the CreationInfo settings when a client connects to an access point. When specifying the CreationInfo, you must provide values for all properties. If you do not provide CreationInfo and the specified RootDirectory>Path does not exist, attempts to mount the file system using the access point will fail. "},"Path":{"Type":4,"Flags":0,"Description":"Specifies the path on the EFS file system to expose as the root directory to NFS clients using the access point to access the EFS file system. A path can have up to four subdirectories. If the specified path does not exist, you are required to provide the CreationInfo."}}}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.EFS/AccessPointProperties","Properties":{"AccessPointId":{"Type":4,"Flags":18},"AccessPointTags":{"Type":14,"Flags":0},"Arn":{"Type":4,"Flags":2},"ClientToken":{"Type":4,"Flags":0,"Description":"(optional) A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation."},"FileSystemId":{"Type":4,"Flags":1,"Description":"The ID of the EFS file system that the access point provides access to."},"PosixUser":{"Type":10,"Flags":0,"Description":"The operating system user and group applied to all file system requests made using the access point."},"RootDirectory":{"Type":11,"Flags":0,"Description":"Specifies the directory on the Amazon EFS file system that the access point exposes as the root directory of your file system to NFS clients using the access point. The clients using the access point can only access the root directory and below. If the RootDirectory>Path specified does not exist, EFS creates it and applies the CreationInfo settings when a client connects to an access point. When specifying a RootDirectory, you need to provide the Path, and the CreationInfo is optional."}}}},{"3":{"ItemType":8}},{"2":{"Name":"AWS.EFS/AccessPoint","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":13,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EFS/AccessPoint@default","ScopeType":0,"Body":15}},{"2":{"Name":"Arn"}},{"2":{"Name":"BackupPolicy","Properties":{"Status":{"Type":4,"Flags":1}}}},{"2":{"Name":"ElasticFileSystemTag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"FileSystemProtection","Properties":{"ReplicationOverwriteProtection":{"Type":4,"Flags":0}}}},{"2":{"Name":"LifecyclePolicy","Properties":{"TransitionToArchive":{"Type":4,"Flags":0},"TransitionToIA":{"Type":4,"Flags":0},"TransitionToPrimaryStorageClass":{"Type":4,"Flags":0}}}},{"2":{"Name":"ReplicationConfiguration","Properties":{"Destinations":{"Type":24,"Flags":4}}}},{"2":{"Name":"ReplicationDestination","Properties":{"AvailabilityZoneName":{"Type":4,"Flags":0},"FileSystemId":{"Type":4,"Flags":16},"KmsKeyId":{"Type":4,"Flags":0},"Region":{"Type":4,"Flags":0}}}},{"3":{"ItemType":23}},{"2":{"Name":"AWS.EFS/FileSystemProperties","Properties":{"Arn":{"Type":4,"Flags":2},"AvailabilityZoneName":{"Type":4,"Flags":0},"BackupPolicy":{"Type":18,"Flags":0},"BypassPolicyLockoutSafetyCheck":{"Type":2,"Flags":4,"Description":"Whether to bypass the FileSystemPolicy lockout safety check. The policy lockout safety check determines whether the policy in the request will prevent the principal making the request to be locked out from making future PutFileSystemPolicy requests on the file system. Set BypassPolicyLockoutSafetyCheck to True only when you intend to prevent the principal that is making the request from making a subsequent PutFileSystemPolicy request on the file system. Defaults to false"},"Encrypted":{"Type":2,"Flags":0},"FileSystemId":{"Type":4,"Flags":18},"FileSystemPolicy":{"Type":26,"Flags":0},"FileSystemProtection":{"Type":20,"Flags":0},"FileSystemTags":{"Type":27,"Flags":0},"KmsKeyId":{"Type":4,"Flags":0},"LifecyclePolicies":{"Type":28,"Flags":0},"PerformanceMode":{"Type":4,"Flags":0},"ProvisionedThroughputInMibps":{"Type":3,"Flags":0},"ReplicationConfiguration":{"Type":22,"Flags":0},"ThroughputMode":{"Type":4,"Flags":0}}}},{"2":{"Name":"FileSystem_FileSystemPolicy","Properties":{}}},{"3":{"ItemType":19}},{"3":{"ItemType":21}},{"2":{"Name":"AWS.EFS/FileSystem","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":25,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EFS/FileSystem@default","ScopeType":0,"Body":29}},{"2":{"Name":"AWS.EFS/MountTargetProperties","Properties":{"FileSystemId":{"Type":4,"Flags":1},"Id":{"Type":4,"Flags":18},"IpAddress":{"Type":4,"Flags":0},"SecurityGroups":{"Type":32,"Flags":1},"SubnetId":{"Type":4,"Flags":1}}}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.EFS/MountTarget","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":31,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EFS/MountTarget@default","ScopeType":0,"Body":33}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "AccessPointTag", + "properties": { + "Key": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The tag key (String). The key can't start with ``aws:``." + }, + "Value": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The value of the tag key." + } + } + }, + { + "$type": "ObjectType", + "name": "CreationInfo", + "properties": { + "OwnerGid": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "Specifies the POSIX group ID to apply to the ``RootDirectory``. Accepts values from 0 to 2^32 (4294967295)." + }, + "OwnerUid": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "Specifies the POSIX user ID to apply to the ``RootDirectory``. Accepts values from 0 to 2^32 (4294967295)." + }, + "Permissions": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "Specifies the POSIX permissions to apply to the ``RootDirectory``, in the format of an octal number representing the file's mode bits." + } + } + }, + { + "$type": "ObjectType", + "name": "PosixUser", + "properties": { + "Gid": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The POSIX group ID used for all file system operations using this access point." + }, + "SecondaryGids": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "Secondary POSIX group IDs used for all file system operations using this access point." + }, + "Uid": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The POSIX user ID used for all file system operations using this access point." + } + } + }, + { + "$type": "ObjectType", + "name": "RootDirectory", + "properties": { + "CreationInfo": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "(Optional) Specifies the POSIX IDs and permissions to apply to the access point's ``RootDirectory``. If the ``RootDirectory`` > ``Path`` specified does not exist, EFS creates the root directory using the ``CreationInfo`` settings when a client connects to an access point. When specifying the ``CreationInfo``, you must provide values for all properties. \n If you do not provide ``CreationInfo`` and the specified ``RootDirectory`` > ``Path`` does not exist, attempts to mount the file system using the access point will fail." + }, + "Path": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Specifies the path on the EFS file system to expose as the root directory to NFS clients using the access point to access the EFS file system. A path can have up to four subdirectories. If the specified path does not exist, you are required to provide the ``CreationInfo``." + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EFS/AccessPointProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EFS/AccessPointProperties", + "properties": { + "AccessPointId": { + "type": { + "$ref": "#/4" + }, + "flags": 18, + "description": "" + }, + "AccessPointTags": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource.\n For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)." + }, + "Arn": { + "type": { + "$ref": "#/4" + }, + "flags": 2, + "description": "" + }, + "ClientToken": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The opaque string specified in the request to ensure idempotent creation." + }, + "FileSystemId": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The ID of the EFS file system that the access point applies to. Accepts only the ID format for input when specifying a file system, for example ``fs-0123456789abcedf2``." + }, + "PosixUser": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The full POSIX identity, including the user ID, group ID, and secondary group IDs on the access point that is used for all file operations by NFS clients using the access point." + }, + "RootDirectory": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The directory on the EFS file system that the access point exposes as the root directory to NFS clients using the access point." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EFS/AccessPoint", + "properties": { + "name": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/8" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EFS/AccessPoint@default", + "scopeType": 0, + "body": { + "$ref": "#/9" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Arn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "BackupPolicy", + "properties": { + "Status": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "Set the backup policy status for the file system.\n + *ENABLED* - Turns automatic backups on for the file system. \n + *DISABLED* - Turns automatic backups off for the file system." + } + } + }, + { + "$type": "ObjectType", + "name": "ElasticFileSystemTag", + "properties": { + "Key": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The tag key (String). The key can't start with ``aws:``." + }, + "Value": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The value of the tag key." + } + } + }, + { + "$type": "ObjectType", + "name": "FileSystemProtection", + "properties": { + "ReplicationOverwriteProtection": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The status of the file system's replication overwrite protection.\n + ``ENABLED`` ? The file system cannot be used as the destination file system in a replication configuration. The file system is writeable. Replication overwrite protection is ``ENABLED`` by default. \n + ``DISABLED`` ? The file system can be used as the destination file system in a replication configuration. The file system is read-only and can only be modified by EFS replication.\n + ``REPLICATING`` ? The file system is being used as the destination file system in a replication configuration. The file system is read-only and is only modified only by EFS replication.\n \n If the replication configuration is deleted, the file system's replication overwrite protection is re-enabled, the file system becomes writeable." + } + } + }, + { + "$type": "ObjectType", + "name": "LifecyclePolicy", + "properties": { + "TransitionToArchive": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The number of days after files were last accessed in primary storage (the Standard storage class) at which to move them to Archive storage. Metadata operations such as listing the contents of a directory don't count as file access events." + }, + "TransitionToIA": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The number of days after files were last accessed in primary storage (the Standard storage class) at which to move them to Infrequent Access (IA) storage. Metadata operations such as listing the contents of a directory don't count as file access events." + }, + "TransitionToPrimaryStorageClass": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Whether to move files back to primary (Standard) storage after they are accessed in IA or Archive storage. Metadata operations such as listing the contents of a directory don't count as file access events." + } + } + }, + { + "$type": "ObjectType", + "name": "ReplicationConfiguration", + "properties": { + "Destinations": { + "type": { + "$ref": "#/18" + }, + "flags": 4, + "description": "An array of destination objects. Only one destination object is supported." + } + } + }, + { + "$type": "ObjectType", + "name": "ReplicationDestination", + "properties": { + "AvailabilityZoneName": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The AWS For One Zone file systems, the replication configuration must specify the Availability Zone in which the destination file system is located. \n Use the format ``us-east-1a`` to specify the Availability Zone. For more 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 One Zone file system type is not available in all Availability Zones in AWS-Regions where Amazon EFS is available." + }, + "FileSystemId": { + "type": { + "$ref": "#/4" + }, + "flags": 16, + "description": "The ID of the destination Amazon EFS file system." + }, + "KmsKeyId": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The ID of an kms-key-long used to protect the encrypted file system." + }, + "Region": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The AWS-Region in which the destination file system is located.\n For One Zone file systems, the replication configuration must specify the AWS-Region in which the destination file system is located." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/17" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EFS/FileSystemProperties" + }, + { + "$type": "BooleanType" + }, + { + "$type": "ObjectType", + "name": "FileSystem_FileSystemPolicy", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/15" + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "ObjectType", + "name": "AWS.EFS/FileSystemProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/4" + }, + "flags": 2, + "description": "" + }, + "AvailabilityZoneName": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "For One Zone file systems, specify the AWS Availability Zone in which to create the file system. Use the format ``us-east-1a`` to specify the Availability Zone. For more information about One Zone file systems, see [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 One Zone file systems are not available in all Availability Zones in AWS-Regions where Amazon EFS is available." + }, + "BackupPolicy": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "Use the ``BackupPolicy`` to turn automatic backups on or off for the file system." + }, + "BypassPolicyLockoutSafetyCheck": { + "type": { + "$ref": "#/20" + }, + "flags": 4, + "description": "(Optional) A boolean that specifies whether or not to bypass the ``FileSystemPolicy`` lockout safety check. The lockout safety check determines whether the policy in the request will lock out, or prevent, the IAM principal that is making the request from making future ``PutFileSystemPolicy`` requests on this file system. Set ``BypassPolicyLockoutSafetyCheck`` to ``True`` only when you intend to prevent the IAM principal that is making the request from making subsequent ``PutFileSystemPolicy`` requests on this file system. The default value is ``False``." + }, + "Encrypted": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "A Boolean value that, if true, creates an encrypted file system. When creating an encrypted file system, you have the option of specifying a KmsKeyId for an existing kms-key-long. If you don't specify a kms-key, then the default kms-key for EFS, ``/aws/elasticfilesystem``, is used to protect the encrypted file system." + }, + "FileSystemId": { + "type": { + "$ref": "#/4" + }, + "flags": 18, + "description": "" + }, + "FileSystemPolicy": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "The ``FileSystemPolicy`` for the EFS file system. A file system policy is an IAM resource policy used to control NFS access to an EFS file system. For more information, see [Using to control NFS access to Amazon EFS](https://docs.aws.amazon.com/efs/latest/ug/iam-access-control-nfs-efs.html) in the *Amazon EFS User Guide*." + }, + "FileSystemProtection": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "Describes the protection on the file system." + }, + "FileSystemTags": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "Use to create one or more tags associated with the file system. Each tag is a user-defined key-value pair. Name your file system on creation by including a ``\"Key\":\"Name\",\"Value\":\"{value}\"`` key-value pair. Each key must be unique. For more information, see [Tagging resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the *General Reference Guide*." + }, + "KmsKeyId": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The ID of the kms-key-long to be used to protect the encrypted file system. This parameter is only required if you want to use a nondefault kms-key. If this parameter is not specified, the default kms-key for EFS is used. This ID can be in one of the following formats:\n + Key ID - A unique identifier of the key, for example ``1234abcd-12ab-34cd-56ef-1234567890ab``.\n + ARN - An Amazon Resource Name (ARN) for the key, for example ``arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab``.\n + Key alias - A previously created display name for a key, for example ``alias/projectKey1``.\n + Key alias ARN - An ARN for a key alias, for example ``arn:aws:kms:us-west-2:444455556666:alias/projectKey1``.\n \n If ``KmsKeyId`` is specified, the ``Encrypted`` parameter must be set to true." + }, + "LifecyclePolicies": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "An array of ``LifecyclePolicy`` objects that define the file system's ``LifecycleConfiguration`` object. A ``LifecycleConfiguration`` object informs 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 to Archive storage.\n + When to move files that are in IA or Archive storage to primary storage.\n \n EFS requires that each ``LifecyclePolicy`` object have only a single transition. This means that in a request body, ``LifecyclePolicies`` needs to be structured as an array of ``LifecyclePolicy`` objects, one object for each transition, ``TransitionToIA``, ``TransitionToArchive`` ``TransitionToPrimaryStorageClass``. See the example requests in the following section for more information." + }, + "PerformanceMode": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The Performance mode of the file system. We recommend ``generalPurpose`` performance mode for all file systems. File systems using the ``maxIO`` performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The performance mode can't be changed after the file system has been created. The ``maxIO`` mode is not supported on One Zone file systems.\n Due to the higher per-operation latencies with Max I/O, we recommend using General Purpose performance mode for all file systems.\n Default is ``generalPurpose``." + }, + "ProvisionedThroughputInMibps": { + "type": { + "$ref": "#/24" + }, + "flags": 0, + "description": "The throughput, measured in mebibytes per second (MiBps), that you want to provision for a file system that you're creating. Required if ``ThroughputMode`` is set to ``provisioned``. Valid values are 1-3414 MiBps, with the upper limit depending on Region. To increase this limit, contact SUP. For more information, see [Amazon EFS quotas that you can increase](https://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits) in the *Amazon EFS User Guide*." + }, + "ReplicationConfiguration": { + "type": { + "$ref": "#/16" + }, + "flags": 0, + "description": "Describes the replication configuration for a specific file system." + }, + "ThroughputMode": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Specifies the throughput mode for the file system. The mode can be ``bursting``, ``provisioned``, or ``elastic``. If you set ``ThroughputMode`` to ``provisioned``, you must also set a value for ``ProvisionedThroughputInMibps``. After you create the file system, you can decrease your file system's Provisioned throughput or change between the throughput modes, with certain time restrictions. For more information, see [Specifying throughput with provisioned mode](https://docs.aws.amazon.com/efs/latest/ug/performance.html#provisioned-throughput) in the *Amazon EFS User Guide*. \n Default is ``bursting``." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EFS/FileSystem", + "properties": { + "name": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/25" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EFS/FileSystem@default", + "scopeType": 0, + "body": { + "$ref": "#/26" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.EFS/MountTargetProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EFS/MountTargetProperties", + "properties": { + "FileSystemId": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The ID of the file system for which to create the mount target." + }, + "Id": { + "type": { + "$ref": "#/4" + }, + "flags": 18, + "description": "" + }, + "IpAddress": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Valid IPv4 address within the address range of the specified subnet." + }, + "SecurityGroups": { + "type": { + "$ref": "#/29" + }, + "flags": 1, + "description": "Up to five VPC security group IDs, of the form ``sg-xxxxxxxx``. These must be for the same VPC as subnet specified." + }, + "SubnetId": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The ID of the subnet to add the mount target in. For One Zone file systems, use the subnet that is associated with the file system's Availability Zone." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EFS/MountTarget", + "properties": { + "name": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/30" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EFS/MountTarget@default", + "scopeType": 0, + "body": { + "$ref": "#/31" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.efs/default/types.md b/artifacts/bicep/aws/aws.efs/default/types.md index e284ff45..c594d7ab 100644 --- a/artifacts/bicep/aws/aws.efs/default/types.md +++ b/artifacts/bicep/aws/aws.efs/default/types.md @@ -3,112 +3,139 @@ ## Resource AWS.EFS/AccessPoint@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EFS/AccessPointProperties](#awsefsaccesspointproperties) (Required): properties of the resource +* **properties**: [AWS.EFS/AccessPointProperties](#awsefsaccesspointproperties) (Required, Identifier): properties of the resource ## Resource AWS.EFS/FileSystem@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EFS/FileSystemProperties](#awsefsfilesystemproperties): properties of the resource +* **properties**: [AWS.EFS/FileSystemProperties](#awsefsfilesystemproperties) (Identifier): properties of the resource ## Resource AWS.EFS/MountTarget@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EFS/MountTargetProperties](#awsefsmounttargetproperties) (Required): properties of the resource +* **properties**: [AWS.EFS/MountTargetProperties](#awsefsmounttargetproperties) (Required, Identifier): properties of the resource + +## AccessPointTag +### Properties +* **Key**: string: The tag key (String). The key can't start with ``aws:``. +* **Value**: string: The value of the tag key. ## AWS.EFS/AccessPointProperties ### Properties * **AccessPointId**: string (ReadOnly, Identifier) -* **AccessPointTags**: [AccessPointTag](#accesspointtag)[] +* **AccessPointTags**: [AccessPointTag](#accesspointtag)[]: An array of key-value pairs to apply to this resource. + For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html). * **Arn**: string (ReadOnly) -* **ClientToken**: string: (optional) A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation. -* **FileSystemId**: string (Required): The ID of the EFS file system that the access point provides access to. -* **PosixUser**: [PosixUser](#posixuser): The operating system user and group applied to all file system requests made using the access point. -* **RootDirectory**: [RootDirectory](#rootdirectory): Specifies the directory on the Amazon EFS file system that the access point exposes as the root directory of your file system to NFS clients using the access point. The clients using the access point can only access the root directory and below. If the RootDirectory>Path specified does not exist, EFS creates it and applies the CreationInfo settings when a client connects to an access point. When specifying a RootDirectory, you need to provide the Path, and the CreationInfo is optional. +* **ClientToken**: string: The opaque string specified in the request to ensure idempotent creation. +* **FileSystemId**: string (Required): The ID of the EFS file system that the access point applies to. Accepts only the ID format for input when specifying a file system, for example ``fs-0123456789abcedf2``. +* **PosixUser**: [PosixUser](#posixuser): The full POSIX identity, including the user ID, group ID, and secondary group IDs on the access point that is used for all file operations by NFS clients using the access point. +* **RootDirectory**: [RootDirectory](#rootdirectory): The directory on the EFS file system that the access point exposes as the root directory to NFS clients using the access point. -## AccessPointTag +## AWS.EFS/FileSystemProperties ### Properties -* **Key**: string -* **Value**: string +* **Arn**: string (ReadOnly) +* **AvailabilityZoneName**: string: For One Zone file systems, specify the AWS Availability Zone in which to create the file system. Use the format ``us-east-1a`` to specify the Availability Zone. For more information about One Zone file systems, see [EFS file system types](https://docs.aws.amazon.com/efs/latest/ug/availability-durability.html#file-system-type) in the *Amazon EFS User Guide*. + One Zone file systems are not available in all Availability Zones in AWS-Regions where Amazon EFS is available. +* **BackupPolicy**: [BackupPolicy](#backuppolicy): Use the ``BackupPolicy`` to turn automatic backups on or off for the file system. +* **BypassPolicyLockoutSafetyCheck**: bool (WriteOnly): (Optional) A boolean that specifies whether or not to bypass the ``FileSystemPolicy`` lockout safety check. The lockout safety check determines whether the policy in the request will lock out, or prevent, the IAM principal that is making the request from making future ``PutFileSystemPolicy`` requests on this file system. Set ``BypassPolicyLockoutSafetyCheck`` to ``True`` only when you intend to prevent the IAM principal that is making the request from making subsequent ``PutFileSystemPolicy`` requests on this file system. The default value is ``False``. +* **Encrypted**: bool: A Boolean value that, if true, creates an encrypted file system. When creating an encrypted file system, you have the option of specifying a KmsKeyId for an existing kms-key-long. If you don't specify a kms-key, then the default kms-key for EFS, ``/aws/elasticfilesystem``, is used to protect the encrypted file system. +* **FileSystemId**: string (ReadOnly, Identifier) +* **FileSystemPolicy**: [FileSystem_FileSystemPolicy](#filesystemfilesystempolicy): The ``FileSystemPolicy`` for the EFS file system. A file system policy is an IAM resource policy used to control NFS access to an EFS file system. For more information, see [Using to control NFS access to Amazon EFS](https://docs.aws.amazon.com/efs/latest/ug/iam-access-control-nfs-efs.html) in the *Amazon EFS User Guide*. +* **FileSystemProtection**: [FileSystemProtection](#filesystemprotection): Describes the protection on the file system. +* **FileSystemTags**: [ElasticFileSystemTag](#elasticfilesystemtag)[]: Use to create one or more tags associated with the file system. Each tag is a user-defined key-value pair. Name your file system on creation by including a ``"Key":"Name","Value":"{value}"`` key-value pair. Each key must be unique. For more information, see [Tagging resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the *General Reference Guide*. +* **KmsKeyId**: string: The ID of the kms-key-long to be used to protect the encrypted file system. This parameter is only required if you want to use a nondefault kms-key. If this parameter is not specified, the default kms-key for EFS is used. This ID can be in one of the following formats: + + Key ID - A unique identifier of the key, for example ``1234abcd-12ab-34cd-56ef-1234567890ab``. + + ARN - An Amazon Resource Name (ARN) for the key, for example ``arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab``. + + Key alias - A previously created display name for a key, for example ``alias/projectKey1``. + + Key alias ARN - An ARN for a key alias, for example ``arn:aws:kms:us-west-2:444455556666:alias/projectKey1``. + + If ``KmsKeyId`` is specified, the ``Encrypted`` parameter must be set to true. +* **LifecyclePolicies**: [LifecyclePolicy](#lifecyclepolicy)[]: An array of ``LifecyclePolicy`` objects that define the file system's ``LifecycleConfiguration`` object. A ``LifecycleConfiguration`` object informs Lifecycle management of the following: + + When to move files in the file system from primary storage to IA storage. + + When to move files in the file system from primary storage or IA storage to Archive storage. + + When to move files that are in IA or Archive storage to primary storage. + + EFS requires that each ``LifecyclePolicy`` object have only a single transition. This means that in a request body, ``LifecyclePolicies`` needs to be structured as an array of ``LifecyclePolicy`` objects, one object for each transition, ``TransitionToIA``, ``TransitionToArchive`` ``TransitionToPrimaryStorageClass``. See the example requests in the following section for more information. +* **PerformanceMode**: string: The Performance mode of the file system. We recommend ``generalPurpose`` performance mode for all file systems. File systems using the ``maxIO`` performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The performance mode can't be changed after the file system has been created. The ``maxIO`` mode is not supported on One Zone file systems. + Due to the higher per-operation latencies with Max I/O, we recommend using General Purpose performance mode for all file systems. + Default is ``generalPurpose``. +* **ProvisionedThroughputInMibps**: int: The throughput, measured in mebibytes per second (MiBps), that you want to provision for a file system that you're creating. Required if ``ThroughputMode`` is set to ``provisioned``. Valid values are 1-3414 MiBps, with the upper limit depending on Region. To increase this limit, contact SUP. For more information, see [Amazon EFS quotas that you can increase](https://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits) in the *Amazon EFS User Guide*. +* **ReplicationConfiguration**: [ReplicationConfiguration](#replicationconfiguration): Describes the replication configuration for a specific file system. +* **ThroughputMode**: string: Specifies the throughput mode for the file system. The mode can be ``bursting``, ``provisioned``, or ``elastic``. If you set ``ThroughputMode`` to ``provisioned``, you must also set a value for ``ProvisionedThroughputInMibps``. After you create the file system, you can decrease your file system's Provisioned throughput or change between the throughput modes, with certain time restrictions. For more information, see [Specifying throughput with provisioned mode](https://docs.aws.amazon.com/efs/latest/ug/performance.html#provisioned-throughput) in the *Amazon EFS User Guide*. + Default is ``bursting``. -## PosixUser +## AWS.EFS/MountTargetProperties ### Properties -* **Gid**: string (Required): The POSIX group ID used for all file system operations using this access point. -* **SecondaryGids**: string[]: Secondary POSIX group IDs used for all file system operations using this access point. -* **Uid**: string (Required): The POSIX user ID used for all file system operations using this access point. +* **FileSystemId**: string (Required): The ID of the file system for which to create the mount target. +* **Id**: string (ReadOnly, Identifier) +* **IpAddress**: string: Valid IPv4 address within the address range of the specified subnet. +* **SecurityGroups**: string[] (Required): Up to five VPC security group IDs, of the form ``sg-xxxxxxxx``. These must be for the same VPC as subnet specified. +* **SubnetId**: string (Required): The ID of the subnet to add the mount target in. For One Zone file systems, use the subnet that is associated with the file system's Availability Zone. -## RootDirectory +## BackupPolicy ### Properties -* **CreationInfo**: [CreationInfo](#creationinfo): (Optional) Specifies the POSIX IDs and permissions to apply to the access point's RootDirectory. If the RootDirectory>Path specified does not exist, EFS creates the root directory using the CreationInfo settings when a client connects to an access point. When specifying the CreationInfo, you must provide values for all properties. If you do not provide CreationInfo and the specified RootDirectory>Path does not exist, attempts to mount the file system using the access point will fail. -* **Path**: string: Specifies the path on the EFS file system to expose as the root directory to NFS clients using the access point to access the EFS file system. A path can have up to four subdirectories. If the specified path does not exist, you are required to provide the CreationInfo. +* **Status**: string (Required): Set the backup policy status for the file system. + + *ENABLED* - Turns automatic backups on for the file system. + + *DISABLED* - Turns automatic backups off for the file system. ## CreationInfo ### Properties -* **OwnerGid**: string (Required): Specifies the POSIX group ID to apply to the RootDirectory. Accepts values from 0 to 2^32 (4294967295). -* **OwnerUid**: string (Required): Specifies the POSIX user ID to apply to the RootDirectory. Accepts values from 0 to 2^32 (4294967295). -* **Permissions**: string (Required): Specifies the POSIX permissions to apply to the RootDirectory, in the format of an octal number representing the file's mode bits. - -## AWS.EFS/FileSystemProperties -### Properties -* **Arn**: string (ReadOnly) -* **AvailabilityZoneName**: string -* **BackupPolicy**: [BackupPolicy](#backuppolicy) -* **BypassPolicyLockoutSafetyCheck**: bool (WriteOnly): Whether to bypass the FileSystemPolicy lockout safety check. The policy lockout safety check determines whether the policy in the request will prevent the principal making the request to be locked out from making future PutFileSystemPolicy requests on the file system. Set BypassPolicyLockoutSafetyCheck to True only when you intend to prevent the principal that is making the request from making a subsequent PutFileSystemPolicy request on the file system. Defaults to false -* **Encrypted**: bool -* **FileSystemId**: string (ReadOnly, Identifier) -* **FileSystemPolicy**: [FileSystem_FileSystemPolicy](#filesystemfilesystempolicy) -* **FileSystemProtection**: [FileSystemProtection](#filesystemprotection) -* **FileSystemTags**: [ElasticFileSystemTag](#elasticfilesystemtag)[] -* **KmsKeyId**: string -* **LifecyclePolicies**: [LifecyclePolicy](#lifecyclepolicy)[] -* **PerformanceMode**: string -* **ProvisionedThroughputInMibps**: int -* **ReplicationConfiguration**: [ReplicationConfiguration](#replicationconfiguration) -* **ThroughputMode**: string +* **OwnerGid**: string (Required): Specifies the POSIX group ID to apply to the ``RootDirectory``. Accepts values from 0 to 2^32 (4294967295). +* **OwnerUid**: string (Required): Specifies the POSIX user ID to apply to the ``RootDirectory``. Accepts values from 0 to 2^32 (4294967295). +* **Permissions**: string (Required): Specifies the POSIX permissions to apply to the ``RootDirectory``, in the format of an octal number representing the file's mode bits. -## BackupPolicy +## ElasticFileSystemTag ### Properties -* **Status**: string (Required) +* **Key**: string (Required): The tag key (String). The key can't start with ``aws:``. +* **Value**: string (Required): The value of the tag key. ## FileSystem_FileSystemPolicy ### Properties ## FileSystemProtection ### Properties -* **ReplicationOverwriteProtection**: string +* **ReplicationOverwriteProtection**: string: The status of the file system's replication overwrite protection. + + ``ENABLED`` ? The file system cannot be used as the destination file system in a replication configuration. The file system is writeable. Replication overwrite protection is ``ENABLED`` by default. + + ``DISABLED`` ? The file system can be used as the destination file system in a replication configuration. The file system is read-only and can only be modified by EFS replication. + + ``REPLICATING`` ? The file system is being used as the destination file system in a replication configuration. The file system is read-only and is only modified only by EFS replication. + + If the replication configuration is deleted, the file system's replication overwrite protection is re-enabled, the file system becomes writeable. -## ElasticFileSystemTag +## LifecyclePolicy ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **TransitionToArchive**: string: The number of days after files were last accessed in primary storage (the Standard storage class) at which to move them to Archive storage. Metadata operations such as listing the contents of a directory don't count as file access events. +* **TransitionToIA**: string: The number of days after files were last accessed in primary storage (the Standard storage class) at which to move them to Infrequent Access (IA) storage. Metadata operations such as listing the contents of a directory don't count as file access events. +* **TransitionToPrimaryStorageClass**: string: Whether to move files back to primary (Standard) storage after they are accessed in IA or Archive storage. Metadata operations such as listing the contents of a directory don't count as file access events. -## LifecyclePolicy +## PosixUser ### Properties -* **TransitionToArchive**: string -* **TransitionToIA**: string -* **TransitionToPrimaryStorageClass**: string +* **Gid**: string (Required): The POSIX group ID used for all file system operations using this access point. +* **SecondaryGids**: string[]: Secondary POSIX group IDs used for all file system operations using this access point. +* **Uid**: string (Required): The POSIX user ID used for all file system operations using this access point. ## ReplicationConfiguration ### Properties -* **Destinations**: [ReplicationDestination](#replicationdestination)[] (WriteOnly) +* **Destinations**: [ReplicationDestination](#replicationdestination)[] (WriteOnly): An array of destination objects. Only one destination object is supported. ## ReplicationDestination ### Properties -* **AvailabilityZoneName**: string -* **FileSystemId**: string (Identifier) -* **KmsKeyId**: string -* **Region**: string +* **AvailabilityZoneName**: string: The AWS For One Zone file systems, the replication configuration must specify the Availability Zone in which the destination file system is located. + Use the format ``us-east-1a`` to specify the Availability Zone. For more 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*. + One Zone file system type is not available in all Availability Zones in AWS-Regions where Amazon EFS is available. +* **FileSystemId**: string (Identifier): The ID of the destination Amazon EFS file system. +* **KmsKeyId**: string: The ID of an kms-key-long used to protect the encrypted file system. +* **Region**: string: The AWS-Region in which the destination file system is located. + For One Zone file systems, the replication configuration must specify the AWS-Region in which the destination file system is located. -## AWS.EFS/MountTargetProperties +## RootDirectory ### Properties -* **FileSystemId**: string (Required) -* **Id**: string (ReadOnly, Identifier) -* **IpAddress**: string -* **SecurityGroups**: string[] (Required) -* **SubnetId**: string (Required) +* **CreationInfo**: [CreationInfo](#creationinfo): (Optional) Specifies the POSIX IDs and permissions to apply to the access point's ``RootDirectory``. If the ``RootDirectory`` > ``Path`` specified does not exist, EFS creates the root directory using the ``CreationInfo`` settings when a client connects to an access point. When specifying the ``CreationInfo``, you must provide values for all properties. + If you do not provide ``CreationInfo`` and the specified ``RootDirectory`` > ``Path`` does not exist, attempts to mount the file system using the access point will fail. +* **Path**: string: Specifies the path on the EFS file system to expose as the root directory to NFS clients using the access point to access the EFS file system. A path can have up to four subdirectories. If the specified path does not exist, you are required to provide the ``CreationInfo``. diff --git a/artifacts/bicep/aws/aws.eks/default/types.json b/artifacts/bicep/aws/aws.eks/default/types.json index 43e1daea..1b111a63 100644 --- a/artifacts/bicep/aws/aws.eks/default/types.json +++ b/artifacts/bicep/aws/aws.eks/default/types.json @@ -1 +1,1624 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"AccessPolicy","Properties":{"AccessScope":{"Type":9,"Flags":1},"PolicyArn":{"Type":4,"Flags":1,"Description":"The ARN of the access policy to add to the access entry."}}}},{"2":{"Name":"AccessScope","Properties":{"Namespaces":{"Type":11,"Flags":0,"Description":"The namespaces to associate with the access scope. Only specify if Type is set to 'namespace'."},"Type":{"Type":4,"Flags":1,"Description":"The type of the access scope."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.EKS/AccessEntryProperties","Properties":{"AccessEntryArn":{"Type":4,"Flags":2,"Description":"The ARN of the access entry."},"AccessPolicies":{"Type":13,"Flags":0,"Description":"An array of access policies that are associated with the access entry."},"ClusterName":{"Type":4,"Flags":17,"Description":"The cluster that the access entry is created for."},"KubernetesGroups":{"Type":14,"Flags":0,"Description":"The Kubernetes groups that the access entry is associated with."},"PrincipalArn":{"Type":4,"Flags":17,"Description":"The principal ARN that the access entry is created for."},"Tags":{"Type":15,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."},"Type":{"Type":4,"Flags":0,"Description":"The node type to associate with the access entry."},"Username":{"Type":4,"Flags":0,"Description":"The Kubernetes user that the access entry is associated with."}}}},{"3":{"ItemType":8}},{"3":{"ItemType":4}},{"3":{"ItemType":10}},{"2":{"Name":"AWS.EKS/AccessEntry","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":12,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EKS/AccessEntry@default","ScopeType":0,"Body":16}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}}}},{"2":{"Name":"AWS.EKS/AddonProperties","Properties":{"AddonName":{"Type":4,"Flags":17,"Description":"Name of Addon"},"AddonVersion":{"Type":4,"Flags":0,"Description":"Version of Addon"},"Arn":{"Type":4,"Flags":2,"Description":"Amazon Resource Name (ARN) of the add-on"},"ClusterName":{"Type":4,"Flags":17,"Description":"Name of Cluster"},"ConfigurationValues":{"Type":4,"Flags":0,"Description":"The configuration values to use with the add-on"},"PreserveOnDelete":{"Type":2,"Flags":4,"Description":"PreserveOnDelete parameter value"},"ResolveConflicts":{"Type":4,"Flags":4,"Description":"Resolve parameter value conflicts"},"ServiceAccountRoleArn":{"Type":4,"Flags":0,"Description":"IAM role to bind to the add-on's service account"},"Tags":{"Type":20,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."}}}},{"3":{"ItemType":18}},{"2":{"Name":"AWS.EKS/Addon","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":19,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EKS/Addon@default","ScopeType":0,"Body":21}},{"2":{"Name":"AccessConfig","Properties":{"AuthenticationMode":{"Type":4,"Flags":0,"Description":"Specify the authentication mode that should be used to create your cluster."},"BootstrapClusterCreatorAdminPermissions":{"Type":2,"Flags":4,"Description":"Set this value to false to avoid creating a default cluster admin Access Entry using the IAM principal used to create the cluster."}}}},{"2":{"Name":"ClusterLogging","Properties":{"EnabledTypes":{"Type":35,"Flags":0}}}},{"2":{"Name":"ControlPlanePlacement","Properties":{"GroupName":{"Type":4,"Flags":0,"Description":"Specify the placement group name of the control place machines for your cluster."}}}},{"2":{"Name":"EnabledTypes"}},{"2":{"Name":"EncryptionConfig","Properties":{"Provider":{"Type":32,"Flags":0,"Description":"The encryption provider for the cluster."},"Resources":{"Type":37,"Flags":0,"Description":"Specifies the resources to be encrypted. The only supported value is \"secrets\"."}}}},{"2":{"Name":"KubernetesNetworkConfig","Properties":{"IpFamily":{"Type":4,"Flags":0,"Description":"Ipv4 or Ipv6. You can only specify ipv6 for 1.21 and later clusters that use version 1.10.1 or later of the Amazon VPC CNI add-on"},"ServiceIpv4Cidr":{"Type":4,"Flags":0,"Description":"The CIDR block to assign Kubernetes service IP addresses from. If you don't specify a block, Kubernetes assigns addresses from either the 10.100.0.0/16 or 172.20.0.0/16 CIDR blocks. We recommend that you specify a block that does not overlap with resources in other networks that are peered or connected to your VPC. "},"ServiceIpv6Cidr":{"Type":4,"Flags":2,"Description":"The CIDR block to assign Kubernetes service IP addresses from."}}}},{"2":{"Name":"Logging","Properties":{"ClusterLogging":{"Type":24,"Flags":0,"Description":"The cluster control plane logging configuration for your cluster. "}}}},{"2":{"Name":"LoggingTypeConfig","Properties":{"Type":{"Type":4,"Flags":0,"Description":"name of the log type"}}}},{"2":{"Name":"OutpostConfig","Properties":{"ControlPlaneInstanceType":{"Type":4,"Flags":1,"Description":"Specify the Instance type of the machines that should be used to create your cluster."},"ControlPlanePlacement":{"Type":25,"Flags":0,"Description":"Specify the placement group of the control plane machines for your cluster."},"OutpostArns":{"Type":38,"Flags":1,"Description":"Specify one or more Arn(s) of Outpost(s) on which you would like to create your cluster."}}}},{"2":{"Name":"Provider","Properties":{"KeyArn":{"Type":4,"Flags":0,"Description":"Amazon Resource Name (ARN) or alias of the KMS key. The KMS key must be symmetric, created in the same region as the cluster, and if the KMS key was created in a different account, the user must have access to the KMS key."}}}},{"2":{"Name":"ResourcesVpcConfig","Properties":{"EndpointPrivateAccess":{"Type":2,"Flags":0,"Description":"Set this value to true to enable private access for your cluster's Kubernetes API server endpoint. If you enable private access, Kubernetes API requests from within your cluster's VPC use the private VPC endpoint. The default value for this parameter is false, which disables private access for your Kubernetes API server. If you disable private access and you have nodes or AWS Fargate pods in the cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks for communication with the nodes or Fargate pods."},"EndpointPublicAccess":{"Type":2,"Flags":0,"Description":"Set this value to false to disable public access to your cluster's Kubernetes API server endpoint. If you disable public access, your cluster's Kubernetes API server can only receive requests from within the cluster VPC. The default value for this parameter is true, which enables public access for your Kubernetes API server."},"PublicAccessCidrs":{"Type":39,"Flags":0,"Description":"The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to the endpoint from addresses outside of the CIDR blocks that you specify is denied. The default value is 0.0.0.0/0. If you've disabled private endpoint access and you have nodes or AWS Fargate pods in the cluster, then ensure that you specify the necessary CIDR blocks."},"SecurityGroupIds":{"Type":40,"Flags":0,"Description":"Specify one or more security groups for the cross-account elastic network interfaces that Amazon EKS creates to use to allow communication between your worker nodes and the Kubernetes control plane. If you don't specify a security group, the default security group for your VPC is used."},"SubnetIds":{"Type":41,"Flags":1,"Description":"Specify subnets for your Amazon EKS nodes. Amazon EKS creates cross-account elastic network interfaces in these subnets to allow communication between your nodes and the Kubernetes control plane."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"3":{"ItemType":30}},{"3":{"ItemType":30}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.EKS/ClusterProperties","Properties":{"AccessConfig":{"Type":23,"Flags":0},"Arn":{"Type":4,"Flags":2,"Description":"The ARN of the cluster, such as arn:aws:eks:us-west-2:666666666666:cluster/prod."},"CertificateAuthorityData":{"Type":4,"Flags":2,"Description":"The certificate-authority-data for your cluster."},"ClusterSecurityGroupId":{"Type":4,"Flags":2,"Description":"The cluster security group that was created by Amazon EKS for the cluster. Managed node groups use this security group for control plane to data plane communication."},"EncryptionConfig":{"Type":43,"Flags":0},"EncryptionConfigKeyArn":{"Type":4,"Flags":2,"Description":"Amazon Resource Name (ARN) or alias of the customer master key (CMK)."},"Endpoint":{"Type":4,"Flags":2,"Description":"The endpoint for your Kubernetes API server, such as https://5E1D0CEXAMPLEA591B746AFC5AB30262.yl4.us-west-2.eks.amazonaws.com."},"Id":{"Type":4,"Flags":2,"Description":"The unique ID given to your cluster."},"KubernetesNetworkConfig":{"Type":28,"Flags":0},"Logging":{"Type":29,"Flags":0},"Name":{"Type":4,"Flags":16,"Description":"The unique name to give to your cluster."},"OpenIdConnectIssuerUrl":{"Type":4,"Flags":2,"Description":"The issuer URL for the cluster's OIDC identity provider, such as https://oidc.eks.us-west-2.amazonaws.com/id/EXAMPLED539D4633E53DE1B716D3041E. If you need to remove https:// from this output value, you can include the following code in your template."},"OutpostConfig":{"Type":31,"Flags":0},"ResourcesVpcConfig":{"Type":33,"Flags":1},"RoleArn":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf."},"Tags":{"Type":44,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."},"Version":{"Type":4,"Flags":0,"Description":"The desired Kubernetes version for your cluster. If you don't specify a value here, the latest version available in Amazon EKS is used."}}}},{"3":{"ItemType":27}},{"3":{"ItemType":34}},{"2":{"Name":"AWS.EKS/Cluster","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":42,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EKS/Cluster@default","ScopeType":0,"Body":45}},{"2":{"Name":"Label","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the label."},"Value":{"Type":4,"Flags":1,"Description":"The value for the label. "}}}},{"2":{"Name":"Selector","Properties":{"Labels":{"Type":50,"Flags":0},"Namespace":{"Type":4,"Flags":1}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}}}},{"3":{"ItemType":47}},{"2":{"Name":"AWS.EKS/FargateProfileProperties","Properties":{"Arn":{"Type":4,"Flags":2},"ClusterName":{"Type":4,"Flags":17,"Description":"Name of the Cluster"},"FargateProfileName":{"Type":4,"Flags":16,"Description":"Name of FargateProfile"},"PodExecutionRoleArn":{"Type":4,"Flags":1,"Description":"The IAM policy arn for pods"},"Selectors":{"Type":52,"Flags":1},"Subnets":{"Type":53,"Flags":0},"Tags":{"Type":54,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."}}}},{"3":{"ItemType":48}},{"3":{"ItemType":4}},{"3":{"ItemType":49}},{"2":{"Name":"AWS.EKS/FargateProfile","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":51,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EKS/FargateProfile@default","ScopeType":0,"Body":55}},{"2":{"Name":"OidcIdentityProviderConfig","Properties":{"ClientId":{"Type":4,"Flags":1,"Description":"This is also known as audience. The ID for the client application that makes authentication requests to the OpenID identity provider."},"GroupsClaim":{"Type":4,"Flags":0,"Description":"The JWT claim that the provider uses to return your groups."},"GroupsPrefix":{"Type":4,"Flags":0,"Description":"The prefix that is prepended to group claims to prevent clashes with existing names (such as system: groups)."},"IssuerUrl":{"Type":4,"Flags":1,"Description":"The URL of the OpenID identity provider that allows the API server to discover public signing keys for verifying tokens."},"RequiredClaims":{"Type":60,"Flags":0},"UsernameClaim":{"Type":4,"Flags":0,"Description":"The JSON Web Token (JWT) claim to use as the username. The default is sub, which is expected to be a unique identifier of the end user. You can choose other claims, such as email or name, depending on the OpenID identity provider. Claims other than email are prefixed with the issuer URL to prevent naming clashes with other plug-ins."},"UsernamePrefix":{"Type":4,"Flags":0,"Description":"The prefix that is prepended to username claims to prevent clashes with existing names. If you do not provide this field, and username is a value other than email, the prefix defaults to issuerurl#. You can use the value - to disable all prefixing."}}}},{"2":{"Name":"RequiredClaim","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key of the requiredClaims."},"Value":{"Type":4,"Flags":1,"Description":"The value for the requiredClaims."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"3":{"ItemType":58}},{"2":{"Name":"AWS.EKS/IdentityProviderConfigProperties","Properties":{"ClusterName":{"Type":4,"Flags":17,"Description":"The name of the identity provider configuration."},"IdentityProviderConfigArn":{"Type":4,"Flags":2,"Description":"The ARN of the configuration."},"IdentityProviderConfigName":{"Type":4,"Flags":16,"Description":"The name of the OIDC provider configuration."},"Oidc":{"Type":57,"Flags":0},"Tags":{"Type":62,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."},"Type":{"Type":4,"Flags":17,"Description":"The type of the identity provider configuration."}}}},{"3":{"ItemType":59}},{"2":{"Name":"AWS.EKS/IdentityProviderConfig","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":61,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EKS/IdentityProviderConfig@default","ScopeType":0,"Body":63}},{"2":{"Name":"LaunchTemplateSpecification","Properties":{"Id":{"Type":4,"Flags":16},"Name":{"Type":4,"Flags":0},"Version":{"Type":4,"Flags":0}}}},{"2":{"Name":"RemoteAccess","Properties":{"Ec2SshKey":{"Type":4,"Flags":1},"SourceSecurityGroups":{"Type":70,"Flags":0}}}},{"2":{"Name":"ScalingConfig","Properties":{"DesiredSize":{"Type":3,"Flags":0},"MaxSize":{"Type":3,"Flags":0},"MinSize":{"Type":3,"Flags":0}}}},{"2":{"Name":"Taint","Properties":{"Effect":{"Type":4,"Flags":0},"Key":{"Type":4,"Flags":0},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"UpdateConfig","Properties":{"MaxUnavailable":{"Type":3,"Flags":0,"Description":"The maximum number of nodes unavailable at once during a version update. Nodes will be updated in parallel. This value or maxUnavailablePercentage is required to have a value.The maximum number is 100. "},"MaxUnavailablePercentage":{"Type":3,"Flags":0,"Description":"The maximum percentage of nodes unavailable during a version update. This percentage of nodes will be updated in parallel, up to 100 nodes at once. This value or maxUnavailable is required to have a value."}}}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.EKS/NodegroupProperties","Properties":{"AmiType":{"Type":4,"Flags":0,"Description":"The AMI type for your node group."},"Arn":{"Type":4,"Flags":2},"CapacityType":{"Type":4,"Flags":0,"Description":"The capacity type of your managed node group."},"ClusterName":{"Type":4,"Flags":1,"Description":"Name of the cluster to create the node group in."},"DiskSize":{"Type":3,"Flags":0,"Description":"The root device disk size (in GiB) for your node group instances."},"ForceUpdateEnabled":{"Type":2,"Flags":4,"Description":"Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue."},"Id":{"Type":4,"Flags":18},"InstanceTypes":{"Type":72,"Flags":0,"Description":"Specify the instance types for a node group."},"Labels":{"Type":73,"Flags":0,"Description":"The Kubernetes labels to be applied to the nodes in the node group when they are created."},"LaunchTemplate":{"Type":65,"Flags":0,"Description":"An object representing a node group's launch template specification."},"NodeRole":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) of the IAM role to associate with your node group."},"NodegroupName":{"Type":4,"Flags":0,"Description":"The unique name to give your node group."},"ReleaseVersion":{"Type":4,"Flags":0,"Description":"The AMI version of the Amazon EKS-optimized AMI to use with your node group."},"RemoteAccess":{"Type":66,"Flags":0,"Description":"The remote access (SSH) configuration to use with your node group."},"ScalingConfig":{"Type":67,"Flags":0,"Description":"The scaling configuration details for the Auto Scaling group that is created for your node group."},"Subnets":{"Type":74,"Flags":1,"Description":"The subnets to use for the Auto Scaling group that is created for your node group."},"Tags":{"Type":75,"Flags":0,"Description":"The metadata, as key-value pairs, to apply to the node group to assist with categorization and organization. Follows same schema as Labels for consistency."},"Taints":{"Type":76,"Flags":0,"Description":"The Kubernetes taints to be applied to the nodes in the node group when they are created."},"UpdateConfig":{"Type":69,"Flags":0,"Description":"The node group update configuration."},"Version":{"Type":4,"Flags":0,"Description":"The Kubernetes version to use for your managed nodes."}}}},{"3":{"ItemType":4}},{"2":{"Name":"Nodegroup_Labels","Properties":{}}},{"3":{"ItemType":4}},{"2":{"Name":"Nodegroup_Tags","Properties":{}}},{"3":{"ItemType":68}},{"2":{"Name":"AWS.EKS/Nodegroup","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":71,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EKS/Nodegroup@default","ScopeType":0,"Body":77}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.EKS/PodIdentityAssociationProperties","Properties":{"AssociationArn":{"Type":4,"Flags":18,"Description":"The ARN of the pod identity association."},"AssociationId":{"Type":4,"Flags":2,"Description":"The ID of the pod identity association."},"ClusterName":{"Type":4,"Flags":1,"Description":"The cluster that the pod identity association is created for."},"Namespace":{"Type":4,"Flags":1,"Description":"The Kubernetes namespace that the pod identity association is created for."},"RoleArn":{"Type":4,"Flags":1,"Description":"The IAM role ARN that the pod identity association is created for."},"ServiceAccount":{"Type":4,"Flags":1,"Description":"The Kubernetes service account that the pod identity association is created for."},"Tags":{"Type":81,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."}}}},{"3":{"ItemType":79}},{"2":{"Name":"AWS.EKS/PodIdentityAssociation","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":80,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EKS/PodIdentityAssociation@default","ScopeType":0,"Body":82}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "AccessPolicy", + "properties": { + "AccessScope": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "PolicyArn": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The ARN of the access policy to add to the access entry." + } + } + }, + { + "$type": "ObjectType", + "name": "AccessScope", + "properties": { + "Namespaces": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The namespaces to associate with the access scope. Only specify if Type is set to 'namespace'." + }, + "Type": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The type of the access scope." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EKS/AccessEntryProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EKS/AccessEntryProperties", + "properties": { + "AccessEntryArn": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The ARN of the access entry." + }, + "AccessPolicies": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "An array of access policies that are associated with the access entry." + }, + "ClusterName": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "The cluster that the access entry is created for." + }, + "KubernetesGroups": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "The Kubernetes groups that the access entry is associated with." + }, + "PrincipalArn": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "The principal ARN that the access entry is created for." + }, + "Tags": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + }, + "Type": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The node type to associate with the access entry." + }, + "Username": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The Kubernetes user that the access entry is associated with." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EKS/AccessEntry", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/9" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EKS/AccessEntry@default", + "scopeType": 0, + "body": { + "$ref": "#/10" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "PodIdentityAssociation", + "properties": { + "RoleArn": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The IAM role ARN that the pod identity association is created for." + }, + "ServiceAccount": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The Kubernetes service account that the pod identity association is created for." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EKS/AddonProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/12" + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EKS/AddonProperties", + "properties": { + "AddonName": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "Name of Addon" + }, + "AddonVersion": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "Version of Addon" + }, + "Arn": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "Amazon Resource Name (ARN) of the add-on" + }, + "ClusterName": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "Name of Cluster" + }, + "ConfigurationValues": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The configuration values to use with the add-on" + }, + "PodIdentityAssociations": { + "type": { + "$ref": "#/15" + }, + "flags": 4, + "description": "An array of pod identities to apply to this add-on." + }, + "PreserveOnDelete": { + "type": { + "$ref": "#/16" + }, + "flags": 4, + "description": "PreserveOnDelete parameter value" + }, + "ResolveConflicts": { + "type": { + "$ref": "#/3" + }, + "flags": 4, + "description": "Resolve parameter value conflicts" + }, + "ServiceAccountRoleArn": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "IAM role to bind to the add-on's service account" + }, + "Tags": { + "type": { + "$ref": "#/17" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EKS/Addon", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/18" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EKS/Addon@default", + "scopeType": 0, + "body": { + "$ref": "#/19" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AccessConfig", + "properties": { + "AuthenticationMode": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "Specify the authentication mode that should be used to create your cluster." + }, + "BootstrapClusterCreatorAdminPermissions": { + "type": { + "$ref": "#/16" + }, + "flags": 4, + "description": "Set this value to false to avoid creating a default cluster admin Access Entry using the IAM principal used to create the cluster." + } + } + }, + { + "$type": "ObjectType", + "name": "ClusterLogging", + "properties": { + "EnabledTypes": { + "type": { + "$ref": "#/33" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ControlPlanePlacement", + "properties": { + "GroupName": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "Specify the placement group name of the control place machines for your cluster." + } + } + }, + { + "$type": "ObjectType", + "name": "EnabledTypes", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "EncryptionConfig", + "properties": { + "Provider": { + "type": { + "$ref": "#/30" + }, + "flags": 0, + "description": "The encryption provider for the cluster." + }, + "Resources": { + "type": { + "$ref": "#/35" + }, + "flags": 0, + "description": "Specifies the resources to be encrypted. The only supported value is \"secrets\"." + } + } + }, + { + "$type": "ObjectType", + "name": "KubernetesNetworkConfig", + "properties": { + "IpFamily": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "Ipv4 or Ipv6. You can only specify ipv6 for 1.21 and later clusters that use version 1.10.1 or later of the Amazon VPC CNI add-on" + }, + "ServiceIpv4Cidr": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The CIDR block to assign Kubernetes service IP addresses from. If you don't specify a block, Kubernetes assigns addresses from either the 10.100.0.0/16 or 172.20.0.0/16 CIDR blocks. We recommend that you specify a block that does not overlap with resources in other networks that are peered or connected to your VPC. " + }, + "ServiceIpv6Cidr": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The CIDR block to assign Kubernetes service IP addresses from." + } + } + }, + { + "$type": "ObjectType", + "name": "Logging", + "properties": { + "ClusterLogging": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "The cluster control plane logging configuration for your cluster. " + } + } + }, + { + "$type": "ObjectType", + "name": "LoggingTypeConfig", + "properties": { + "Type": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "name of the log type" + } + } + }, + { + "$type": "ObjectType", + "name": "OutpostConfig", + "properties": { + "ControlPlaneInstanceType": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "Specify the Instance type of the machines that should be used to create your cluster." + }, + "ControlPlanePlacement": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "Specify the placement group of the control plane machines for your cluster." + }, + "OutpostArns": { + "type": { + "$ref": "#/36" + }, + "flags": 1, + "description": "Specify one or more Arn(s) of Outpost(s) on which you would like to create your cluster." + } + } + }, + { + "$type": "ObjectType", + "name": "Provider", + "properties": { + "KeyArn": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "Amazon Resource Name (ARN) or alias of the KMS key. The KMS key must be symmetric, created in the same region as the cluster, and if the KMS key was created in a different account, the user must have access to the KMS key." + } + } + }, + { + "$type": "ObjectType", + "name": "ResourcesVpcConfig", + "properties": { + "EndpointPrivateAccess": { + "type": { + "$ref": "#/16" + }, + "flags": 0, + "description": "Set this value to true to enable private access for your cluster's Kubernetes API server endpoint. If you enable private access, Kubernetes API requests from within your cluster's VPC use the private VPC endpoint. The default value for this parameter is false, which disables private access for your Kubernetes API server. If you disable private access and you have nodes or AWS Fargate pods in the cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks for communication with the nodes or Fargate pods." + }, + "EndpointPublicAccess": { + "type": { + "$ref": "#/16" + }, + "flags": 0, + "description": "Set this value to false to disable public access to your cluster's Kubernetes API server endpoint. If you disable public access, your cluster's Kubernetes API server can only receive requests from within the cluster VPC. The default value for this parameter is true, which enables public access for your Kubernetes API server." + }, + "PublicAccessCidrs": { + "type": { + "$ref": "#/37" + }, + "flags": 0, + "description": "The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to the endpoint from addresses outside of the CIDR blocks that you specify is denied. The default value is 0.0.0.0/0. If you've disabled private endpoint access and you have nodes or AWS Fargate pods in the cluster, then ensure that you specify the necessary CIDR blocks." + }, + "SecurityGroupIds": { + "type": { + "$ref": "#/38" + }, + "flags": 0, + "description": "Specify one or more security groups for the cross-account elastic network interfaces that Amazon EKS creates to use to allow communication between your worker nodes and the Kubernetes control plane. If you don't specify a security group, the default security group for your VPC is used." + }, + "SubnetIds": { + "type": { + "$ref": "#/39" + }, + "flags": 1, + "description": "Specify subnets for your Amazon EKS nodes. Amazon EKS creates cross-account elastic network interfaces in these subnets to allow communication between your nodes and the Kubernetes control plane." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/28" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/28" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EKS/ClusterProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/25" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/32" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EKS/ClusterProperties", + "properties": { + "AccessConfig": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "Arn": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The ARN of the cluster, such as arn:aws:eks:us-west-2:666666666666:cluster/prod." + }, + "BootstrapSelfManagedAddons": { + "type": { + "$ref": "#/16" + }, + "flags": 4, + "description": "Set this value to false to avoid creating the default networking addons when the cluster is created." + }, + "CertificateAuthorityData": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The certificate-authority-data for your cluster." + }, + "ClusterSecurityGroupId": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The cluster security group that was created by Amazon EKS for the cluster. Managed node groups use this security group for control plane to data plane communication." + }, + "EncryptionConfig": { + "type": { + "$ref": "#/41" + }, + "flags": 0 + }, + "EncryptionConfigKeyArn": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "Amazon Resource Name (ARN) or alias of the customer master key (CMK)." + }, + "Endpoint": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The endpoint for your Kubernetes API server, such as https://5E1D0CEXAMPLEA591B746AFC5AB30262.yl4.us-west-2.eks.amazonaws.com." + }, + "Id": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The unique ID given to your cluster." + }, + "KubernetesNetworkConfig": { + "type": { + "$ref": "#/26" + }, + "flags": 0 + }, + "Logging": { + "type": { + "$ref": "#/27" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/3" + }, + "flags": 16, + "description": "The unique name to give to your cluster." + }, + "OpenIdConnectIssuerUrl": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The issuer URL for the cluster's OIDC identity provider, such as https://oidc.eks.us-west-2.amazonaws.com/id/EXAMPLED539D4633E53DE1B716D3041E. If you need to remove https:// from this output value, you can include the following code in your template." + }, + "OutpostConfig": { + "type": { + "$ref": "#/29" + }, + "flags": 0 + }, + "ResourcesVpcConfig": { + "type": { + "$ref": "#/31" + }, + "flags": 1 + }, + "RoleArn": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf." + }, + "Tags": { + "type": { + "$ref": "#/42" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + }, + "Version": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The desired Kubernetes version for your cluster. If you don't specify a value here, the latest version available in Amazon EKS is used." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EKS/Cluster", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/43" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EKS/Cluster@default", + "scopeType": 0, + "body": { + "$ref": "#/44" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Label", + "properties": { + "Key": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The key name of the label." + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The value for the label. " + } + } + }, + { + "$type": "ObjectType", + "name": "Selector", + "properties": { + "Labels": { + "type": { + "$ref": "#/49" + }, + "flags": 0 + }, + "Namespace": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/46" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EKS/FargateProfileProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/47" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/48" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EKS/FargateProfileProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/3" + }, + "flags": 2 + }, + "ClusterName": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "Name of the Cluster" + }, + "FargateProfileName": { + "type": { + "$ref": "#/3" + }, + "flags": 16, + "description": "Name of FargateProfile" + }, + "PodExecutionRoleArn": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The IAM policy arn for pods" + }, + "Selectors": { + "type": { + "$ref": "#/51" + }, + "flags": 1 + }, + "Subnets": { + "type": { + "$ref": "#/52" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/53" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EKS/FargateProfile", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/54" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EKS/FargateProfile@default", + "scopeType": 0, + "body": { + "$ref": "#/55" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "OidcIdentityProviderConfig", + "properties": { + "ClientId": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "This is also known as audience. The ID for the client application that makes authentication requests to the OpenID identity provider." + }, + "GroupsClaim": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The JWT claim that the provider uses to return your groups." + }, + "GroupsPrefix": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The prefix that is prepended to group claims to prevent clashes with existing names (such as system: groups)." + }, + "IssuerUrl": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The URL of the OpenID identity provider that allows the API server to discover public signing keys for verifying tokens." + }, + "RequiredClaims": { + "type": { + "$ref": "#/60" + }, + "flags": 0 + }, + "UsernameClaim": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The JSON Web Token (JWT) claim to use as the username. The default is sub, which is expected to be a unique identifier of the end user. You can choose other claims, such as email or name, depending on the OpenID identity provider. Claims other than email are prefixed with the issuer URL to prevent naming clashes with other plug-ins." + }, + "UsernamePrefix": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The prefix that is prepended to username claims to prevent clashes with existing names. If you do not provide this field, and username is a value other than email, the prefix defaults to issuerurl#. You can use the value - to disable all prefixing." + } + } + }, + { + "$type": "ObjectType", + "name": "RequiredClaim", + "properties": { + "Key": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The key of the requiredClaims." + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The value for the requiredClaims." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/58" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EKS/IdentityProviderConfigProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/59" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EKS/IdentityProviderConfigProperties", + "properties": { + "ClusterName": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "The name of the identity provider configuration." + }, + "IdentityProviderConfigArn": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The ARN of the configuration." + }, + "IdentityProviderConfigName": { + "type": { + "$ref": "#/3" + }, + "flags": 16, + "description": "The name of the OIDC provider configuration." + }, + "Oidc": { + "type": { + "$ref": "#/57" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/62" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + }, + "Type": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "The type of the identity provider configuration." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EKS/IdentityProviderConfig", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/63" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EKS/IdentityProviderConfig@default", + "scopeType": 0, + "body": { + "$ref": "#/64" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "LaunchTemplateSpecification", + "properties": { + "Id": { + "type": { + "$ref": "#/3" + }, + "flags": 16 + }, + "Name": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "Version": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "RemoteAccess", + "properties": { + "Ec2SshKey": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + }, + "SourceSecurityGroups": { + "type": { + "$ref": "#/71" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ScalingConfig", + "properties": { + "DesiredSize": { + "type": { + "$ref": "#/72" + }, + "flags": 0 + }, + "MaxSize": { + "type": { + "$ref": "#/72" + }, + "flags": 0 + }, + "MinSize": { + "type": { + "$ref": "#/72" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Taint", + "properties": { + "Effect": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "Key": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "UpdateConfig", + "properties": { + "MaxUnavailable": { + "type": { + "$ref": "#/72" + }, + "flags": 0, + "description": "The maximum number of nodes unavailable at once during a version update. Nodes will be updated in parallel. This value or maxUnavailablePercentage is required to have a value.The maximum number is 100. " + }, + "MaxUnavailablePercentage": { + "type": { + "$ref": "#/72" + }, + "flags": 0, + "description": "The maximum percentage of nodes unavailable during a version update. This percentage of nodes will be updated in parallel, up to 100 nodes at once. This value or maxUnavailable is required to have a value." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.EKS/NodegroupProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ObjectType", + "name": "Nodegroup_Labels", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ObjectType", + "name": "Nodegroup_Tags", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/69" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EKS/NodegroupProperties", + "properties": { + "AmiType": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The AMI type for your node group." + }, + "Arn": { + "type": { + "$ref": "#/3" + }, + "flags": 2 + }, + "CapacityType": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The capacity type of your managed node group." + }, + "ClusterName": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "Name of the cluster to create the node group in." + }, + "DiskSize": { + "type": { + "$ref": "#/72" + }, + "flags": 0, + "description": "The root device disk size (in GiB) for your node group instances." + }, + "ForceUpdateEnabled": { + "type": { + "$ref": "#/16" + }, + "flags": 4, + "description": "Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue." + }, + "Id": { + "type": { + "$ref": "#/3" + }, + "flags": 18 + }, + "InstanceTypes": { + "type": { + "$ref": "#/74" + }, + "flags": 0, + "description": "Specify the instance types for a node group." + }, + "Labels": { + "type": { + "$ref": "#/75" + }, + "flags": 0, + "description": "The Kubernetes labels to be applied to the nodes in the node group when they are created." + }, + "LaunchTemplate": { + "type": { + "$ref": "#/66" + }, + "flags": 0, + "description": "An object representing a node group's launch template specification." + }, + "NodeRole": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of the IAM role to associate with your node group." + }, + "NodegroupName": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The unique name to give your node group." + }, + "ReleaseVersion": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The AMI version of the Amazon EKS-optimized AMI to use with your node group." + }, + "RemoteAccess": { + "type": { + "$ref": "#/67" + }, + "flags": 0, + "description": "The remote access (SSH) configuration to use with your node group." + }, + "ScalingConfig": { + "type": { + "$ref": "#/68" + }, + "flags": 0, + "description": "The scaling configuration details for the Auto Scaling group that is created for your node group." + }, + "Subnets": { + "type": { + "$ref": "#/76" + }, + "flags": 1, + "description": "The subnets to use for the Auto Scaling group that is created for your node group." + }, + "Tags": { + "type": { + "$ref": "#/77" + }, + "flags": 0, + "description": "The metadata, as key-value pairs, to apply to the node group to assist with categorization and organization. Follows same schema as Labels for consistency." + }, + "Taints": { + "type": { + "$ref": "#/78" + }, + "flags": 0, + "description": "The Kubernetes taints to be applied to the nodes in the node group when they are created." + }, + "UpdateConfig": { + "type": { + "$ref": "#/70" + }, + "flags": 0, + "description": "The node group update configuration." + }, + "Version": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The Kubernetes version to use for your managed nodes." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EKS/Nodegroup", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/79" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EKS/Nodegroup@default", + "scopeType": 0, + "body": { + "$ref": "#/80" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EKS/PodIdentityAssociationProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/82" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EKS/PodIdentityAssociationProperties", + "properties": { + "AssociationArn": { + "type": { + "$ref": "#/3" + }, + "flags": 18, + "description": "The ARN of the pod identity association." + }, + "AssociationId": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The ID of the pod identity association." + }, + "ClusterName": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The cluster that the pod identity association is created for." + }, + "Namespace": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The Kubernetes namespace that the pod identity association is created for." + }, + "RoleArn": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The IAM role ARN that the pod identity association is created for." + }, + "ServiceAccount": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The Kubernetes service account that the pod identity association is created for." + }, + "Tags": { + "type": { + "$ref": "#/84" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EKS/PodIdentityAssociation", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/85" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EKS/PodIdentityAssociation@default", + "scopeType": 0, + "body": { + "$ref": "#/86" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.eks/default/types.md b/artifacts/bicep/aws/aws.eks/default/types.md index 587e3ef3..6cd4313b 100644 --- a/artifacts/bicep/aws/aws.eks/default/types.md +++ b/artifacts/bicep/aws/aws.eks/default/types.md @@ -3,62 +3,56 @@ ## Resource AWS.EKS/AccessEntry@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EKS/AccessEntryProperties](#awseksaccessentryproperties) (Required): properties of the resource +* **properties**: [AWS.EKS/AccessEntryProperties](#awseksaccessentryproperties) (Required, Identifier): properties of the resource ## Resource AWS.EKS/Addon@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EKS/AddonProperties](#awseksaddonproperties) (Required): properties of the resource +* **properties**: [AWS.EKS/AddonProperties](#awseksaddonproperties) (Required, Identifier): properties of the resource ## Resource AWS.EKS/Cluster@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EKS/ClusterProperties](#awseksclusterproperties) (Required): properties of the resource +* **properties**: [AWS.EKS/ClusterProperties](#awseksclusterproperties) (Required, Identifier): properties of the resource ## Resource AWS.EKS/FargateProfile@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EKS/FargateProfileProperties](#awseksfargateprofileproperties) (Required): properties of the resource +* **properties**: [AWS.EKS/FargateProfileProperties](#awseksfargateprofileproperties) (Required, Identifier): properties of the resource ## Resource AWS.EKS/IdentityProviderConfig@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EKS/IdentityProviderConfigProperties](#awseksidentityproviderconfigproperties) (Required): properties of the resource +* **properties**: [AWS.EKS/IdentityProviderConfigProperties](#awseksidentityproviderconfigproperties) (Required, Identifier): properties of the resource ## Resource AWS.EKS/Nodegroup@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EKS/NodegroupProperties](#awseksnodegroupproperties) (Required): properties of the resource +* **properties**: [AWS.EKS/NodegroupProperties](#awseksnodegroupproperties) (Required, Identifier): properties of the resource ## Resource AWS.EKS/PodIdentityAssociation@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EKS/PodIdentityAssociationProperties](#awsekspodidentityassociationproperties) (Required): properties of the resource +* **properties**: [AWS.EKS/PodIdentityAssociationProperties](#awsekspodidentityassociationproperties) (Required, Identifier): properties of the resource -## AWS.EKS/AccessEntryProperties +## AccessConfig ### Properties -* **AccessEntryArn**: string (ReadOnly): The ARN of the access entry. -* **AccessPolicies**: [AccessPolicy](#accesspolicy)[]: An array of access policies that are associated with the access entry. -* **ClusterName**: string (Required, Identifier): The cluster that the access entry is created for. -* **KubernetesGroups**: string[]: The Kubernetes groups that the access entry is associated with. -* **PrincipalArn**: string (Required, Identifier): The principal ARN that the access entry is created for. -* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. -* **Type**: string: The node type to associate with the access entry. -* **Username**: string: The Kubernetes user that the access entry is associated with. +* **AuthenticationMode**: string: Specify the authentication mode that should be used to create your cluster. +* **BootstrapClusterCreatorAdminPermissions**: bool (WriteOnly): Set this value to false to avoid creating a default cluster admin Access Entry using the IAM principal used to create the cluster. ## AccessPolicy ### Properties @@ -70,10 +64,16 @@ * **Namespaces**: string[]: The namespaces to associate with the access scope. Only specify if Type is set to 'namespace'. * **Type**: string (Required): The type of the access scope. -## Tag +## AWS.EKS/AccessEntryProperties ### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **AccessEntryArn**: string (ReadOnly): The ARN of the access entry. +* **AccessPolicies**: [AccessPolicy](#accesspolicy)[]: An array of access policies that are associated with the access entry. +* **ClusterName**: string (Required, Identifier): The cluster that the access entry is created for. +* **KubernetesGroups**: string[]: The Kubernetes groups that the access entry is associated with. +* **PrincipalArn**: string (Required, Identifier): The principal ARN that the access entry is created for. +* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. +* **Type**: string: The node type to associate with the access entry. +* **Username**: string: The Kubernetes user that the access entry is associated with. ## AWS.EKS/AddonProperties ### Properties @@ -82,20 +82,17 @@ * **Arn**: string (ReadOnly): Amazon Resource Name (ARN) of the add-on * **ClusterName**: string (Required, Identifier): Name of Cluster * **ConfigurationValues**: string: The configuration values to use with the add-on +* **PodIdentityAssociations**: [PodIdentityAssociation](#podidentityassociation)[] (WriteOnly): An array of pod identities to apply to this add-on. * **PreserveOnDelete**: bool (WriteOnly): PreserveOnDelete parameter value * **ResolveConflicts**: string (WriteOnly): Resolve parameter value conflicts * **ServiceAccountRoleArn**: string: IAM role to bind to the add-on's service account * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## AWS.EKS/ClusterProperties ### Properties * **AccessConfig**: [AccessConfig](#accessconfig) * **Arn**: string (ReadOnly): The ARN of the cluster, such as arn:aws:eks:us-west-2:666666666666:cluster/prod. +* **BootstrapSelfManagedAddons**: bool (WriteOnly): Set this value to false to avoid creating the default networking addons when the cluster is created. * **CertificateAuthorityData**: string (ReadOnly): The certificate-authority-data for your cluster. * **ClusterSecurityGroupId**: string (ReadOnly): The cluster security group that was created by Amazon EKS for the cluster. Managed node groups use this security group for control plane to data plane communication. * **EncryptionConfig**: [EncryptionConfig](#encryptionconfig)[] @@ -112,61 +109,6 @@ * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. * **Version**: string: The desired Kubernetes version for your cluster. If you don't specify a value here, the latest version available in Amazon EKS is used. -## AccessConfig -### Properties -* **AuthenticationMode**: string: Specify the authentication mode that should be used to create your cluster. -* **BootstrapClusterCreatorAdminPermissions**: bool (WriteOnly): Set this value to false to avoid creating a default cluster admin Access Entry using the IAM principal used to create the cluster. - -## EncryptionConfig -### Properties -* **Provider**: [Provider](#provider): The encryption provider for the cluster. -* **Resources**: string[]: Specifies the resources to be encrypted. The only supported value is "secrets". - -## Provider -### Properties -* **KeyArn**: string: Amazon Resource Name (ARN) or alias of the KMS key. The KMS key must be symmetric, created in the same region as the cluster, and if the KMS key was created in a different account, the user must have access to the KMS key. - -## KubernetesNetworkConfig -### Properties -* **IpFamily**: string: Ipv4 or Ipv6. You can only specify ipv6 for 1.21 and later clusters that use version 1.10.1 or later of the Amazon VPC CNI add-on -* **ServiceIpv4Cidr**: string: The CIDR block to assign Kubernetes service IP addresses from. If you don't specify a block, Kubernetes assigns addresses from either the 10.100.0.0/16 or 172.20.0.0/16 CIDR blocks. We recommend that you specify a block that does not overlap with resources in other networks that are peered or connected to your VPC. -* **ServiceIpv6Cidr**: string (ReadOnly): The CIDR block to assign Kubernetes service IP addresses from. - -## Logging -### Properties -* **ClusterLogging**: [ClusterLogging](#clusterlogging): The cluster control plane logging configuration for your cluster. - -## ClusterLogging -### Properties -* **EnabledTypes**: [LoggingTypeConfig](#loggingtypeconfig)[] - -## LoggingTypeConfig -### Properties -* **Type**: string: name of the log type - -## OutpostConfig -### Properties -* **ControlPlaneInstanceType**: string (Required): Specify the Instance type of the machines that should be used to create your cluster. -* **ControlPlanePlacement**: [ControlPlanePlacement](#controlplaneplacement): Specify the placement group of the control plane machines for your cluster. -* **OutpostArns**: string[] (Required): Specify one or more Arn(s) of Outpost(s) on which you would like to create your cluster. - -## ControlPlanePlacement -### Properties -* **GroupName**: string: Specify the placement group name of the control place machines for your cluster. - -## ResourcesVpcConfig -### Properties -* **EndpointPrivateAccess**: bool: Set this value to true to enable private access for your cluster's Kubernetes API server endpoint. If you enable private access, Kubernetes API requests from within your cluster's VPC use the private VPC endpoint. The default value for this parameter is false, which disables private access for your Kubernetes API server. If you disable private access and you have nodes or AWS Fargate pods in the cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks for communication with the nodes or Fargate pods. -* **EndpointPublicAccess**: bool: Set this value to false to disable public access to your cluster's Kubernetes API server endpoint. If you disable public access, your cluster's Kubernetes API server can only receive requests from within the cluster VPC. The default value for this parameter is true, which enables public access for your Kubernetes API server. -* **PublicAccessCidrs**: string[]: The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to the endpoint from addresses outside of the CIDR blocks that you specify is denied. The default value is 0.0.0.0/0. If you've disabled private endpoint access and you have nodes or AWS Fargate pods in the cluster, then ensure that you specify the necessary CIDR blocks. -* **SecurityGroupIds**: string[]: Specify one or more security groups for the cross-account elastic network interfaces that Amazon EKS creates to use to allow communication between your worker nodes and the Kubernetes control plane. If you don't specify a security group, the default security group for your VPC is used. -* **SubnetIds**: string[] (Required): Specify subnets for your Amazon EKS nodes. Amazon EKS creates cross-account elastic network interfaces in these subnets to allow communication between your nodes and the Kubernetes control plane. - -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## AWS.EKS/FargateProfileProperties ### Properties * **Arn**: string (ReadOnly) @@ -177,21 +119,6 @@ * **Subnets**: string[] * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. -## Selector -### Properties -* **Labels**: [Label](#label)[] -* **Namespace**: string (Required) - -## Label -### Properties -* **Key**: string (Required): The key name of the label. -* **Value**: string (Required): The value for the label. - -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## AWS.EKS/IdentityProviderConfigProperties ### Properties * **ClusterName**: string (Required, Identifier): The name of the identity provider configuration. @@ -201,26 +128,6 @@ * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. * **Type**: string (Required, Identifier): The type of the identity provider configuration. -## OidcIdentityProviderConfig -### Properties -* **ClientId**: string (Required): This is also known as audience. The ID for the client application that makes authentication requests to the OpenID identity provider. -* **GroupsClaim**: string: The JWT claim that the provider uses to return your groups. -* **GroupsPrefix**: string: The prefix that is prepended to group claims to prevent clashes with existing names (such as system: groups). -* **IssuerUrl**: string (Required): The URL of the OpenID identity provider that allows the API server to discover public signing keys for verifying tokens. -* **RequiredClaims**: [RequiredClaim](#requiredclaim)[] -* **UsernameClaim**: string: The JSON Web Token (JWT) claim to use as the username. The default is sub, which is expected to be a unique identifier of the end user. You can choose other claims, such as email or name, depending on the OpenID identity provider. Claims other than email are prefixed with the issuer URL to prevent naming clashes with other plug-ins. -* **UsernamePrefix**: string: The prefix that is prepended to username claims to prevent clashes with existing names. If you do not provide this field, and username is a value other than email, the prefix defaults to issuerurl#. You can use the value - to disable all prefixing. - -## RequiredClaim -### Properties -* **Key**: string (Required): The key of the requiredClaims. -* **Value**: string (Required): The value for the requiredClaims. - -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## AWS.EKS/NodegroupProperties ### Properties * **AmiType**: string: The AMI type for your node group. @@ -244,8 +151,39 @@ * **UpdateConfig**: [UpdateConfig](#updateconfig): The node group update configuration. * **Version**: string: The Kubernetes version to use for your managed nodes. -## Nodegroup_Labels +## AWS.EKS/PodIdentityAssociationProperties +### Properties +* **AssociationArn**: string (ReadOnly, Identifier): The ARN of the pod identity association. +* **AssociationId**: string (ReadOnly): The ID of the pod identity association. +* **ClusterName**: string (Required): The cluster that the pod identity association is created for. +* **Namespace**: string (Required): The Kubernetes namespace that the pod identity association is created for. +* **RoleArn**: string (Required): The IAM role ARN that the pod identity association is created for. +* **ServiceAccount**: string (Required): The Kubernetes service account that the pod identity association is created for. +* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. + +## ClusterLogging +### Properties +* **EnabledTypes**: [LoggingTypeConfig](#loggingtypeconfig)[] + +## ControlPlanePlacement +### Properties +* **GroupName**: string: Specify the placement group name of the control place machines for your cluster. + +## EncryptionConfig +### Properties +* **Provider**: [Provider](#provider): The encryption provider for the cluster. +* **Resources**: string[]: Specifies the resources to be encrypted. The only supported value is "secrets". + +## KubernetesNetworkConfig +### Properties +* **IpFamily**: string: Ipv4 or Ipv6. You can only specify ipv6 for 1.21 and later clusters that use version 1.10.1 or later of the Amazon VPC CNI add-on +* **ServiceIpv4Cidr**: string: The CIDR block to assign Kubernetes service IP addresses from. If you don't specify a block, Kubernetes assigns addresses from either the 10.100.0.0/16 or 172.20.0.0/16 CIDR blocks. We recommend that you specify a block that does not overlap with resources in other networks that are peered or connected to your VPC. +* **ServiceIpv6Cidr**: string (ReadOnly): The CIDR block to assign Kubernetes service IP addresses from. + +## Label ### Properties +* **Key**: string (Required): The key name of the label. +* **Value**: string (Required): The value for the label. ## LaunchTemplateSpecification ### Properties @@ -253,43 +191,112 @@ * **Name**: string * **Version**: string +## Logging +### Properties +* **ClusterLogging**: [ClusterLogging](#clusterlogging): The cluster control plane logging configuration for your cluster. + +## LoggingTypeConfig +### Properties +* **Type**: string: name of the log type + +## Nodegroup_Labels +### Properties + +## Nodegroup_Tags +### Properties + +## OidcIdentityProviderConfig +### Properties +* **ClientId**: string (Required): This is also known as audience. The ID for the client application that makes authentication requests to the OpenID identity provider. +* **GroupsClaim**: string: The JWT claim that the provider uses to return your groups. +* **GroupsPrefix**: string: The prefix that is prepended to group claims to prevent clashes with existing names (such as system: groups). +* **IssuerUrl**: string (Required): The URL of the OpenID identity provider that allows the API server to discover public signing keys for verifying tokens. +* **RequiredClaims**: [RequiredClaim](#requiredclaim)[] +* **UsernameClaim**: string: The JSON Web Token (JWT) claim to use as the username. The default is sub, which is expected to be a unique identifier of the end user. You can choose other claims, such as email or name, depending on the OpenID identity provider. Claims other than email are prefixed with the issuer URL to prevent naming clashes with other plug-ins. +* **UsernamePrefix**: string: The prefix that is prepended to username claims to prevent clashes with existing names. If you do not provide this field, and username is a value other than email, the prefix defaults to issuerurl#. You can use the value - to disable all prefixing. + +## OutpostConfig +### Properties +* **ControlPlaneInstanceType**: string (Required): Specify the Instance type of the machines that should be used to create your cluster. +* **ControlPlanePlacement**: [ControlPlanePlacement](#controlplaneplacement): Specify the placement group of the control plane machines for your cluster. +* **OutpostArns**: string[] (Required): Specify one or more Arn(s) of Outpost(s) on which you would like to create your cluster. + +## PodIdentityAssociation +### Properties +* **RoleArn**: string (Required): The IAM role ARN that the pod identity association is created for. +* **ServiceAccount**: string (Required): The Kubernetes service account that the pod identity association is created for. + +## Provider +### Properties +* **KeyArn**: string: Amazon Resource Name (ARN) or alias of the KMS key. The KMS key must be symmetric, created in the same region as the cluster, and if the KMS key was created in a different account, the user must have access to the KMS key. + ## RemoteAccess ### Properties * **Ec2SshKey**: string (Required) * **SourceSecurityGroups**: string[] +## RequiredClaim +### Properties +* **Key**: string (Required): The key of the requiredClaims. +* **Value**: string (Required): The value for the requiredClaims. + +## ResourcesVpcConfig +### Properties +* **EndpointPrivateAccess**: bool: Set this value to true to enable private access for your cluster's Kubernetes API server endpoint. If you enable private access, Kubernetes API requests from within your cluster's VPC use the private VPC endpoint. The default value for this parameter is false, which disables private access for your Kubernetes API server. If you disable private access and you have nodes or AWS Fargate pods in the cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks for communication with the nodes or Fargate pods. +* **EndpointPublicAccess**: bool: Set this value to false to disable public access to your cluster's Kubernetes API server endpoint. If you disable public access, your cluster's Kubernetes API server can only receive requests from within the cluster VPC. The default value for this parameter is true, which enables public access for your Kubernetes API server. +* **PublicAccessCidrs**: string[]: The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to the endpoint from addresses outside of the CIDR blocks that you specify is denied. The default value is 0.0.0.0/0. If you've disabled private endpoint access and you have nodes or AWS Fargate pods in the cluster, then ensure that you specify the necessary CIDR blocks. +* **SecurityGroupIds**: string[]: Specify one or more security groups for the cross-account elastic network interfaces that Amazon EKS creates to use to allow communication between your worker nodes and the Kubernetes control plane. If you don't specify a security group, the default security group for your VPC is used. +* **SubnetIds**: string[] (Required): Specify subnets for your Amazon EKS nodes. Amazon EKS creates cross-account elastic network interfaces in these subnets to allow communication between your nodes and the Kubernetes control plane. + ## ScalingConfig ### Properties * **DesiredSize**: int * **MaxSize**: int * **MinSize**: int -## Nodegroup_Tags +## Selector ### Properties +* **Labels**: [Label](#label)[] +* **Namespace**: string (Required) -## Taint +## Tag ### Properties -* **Effect**: string -* **Key**: string -* **Value**: string +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -## UpdateConfig +## Tag ### Properties -* **MaxUnavailable**: int: The maximum number of nodes unavailable at once during a version update. Nodes will be updated in parallel. This value or maxUnavailablePercentage is required to have a value.The maximum number is 100. -* **MaxUnavailablePercentage**: int: The maximum percentage of nodes unavailable during a version update. This percentage of nodes will be updated in parallel, up to 100 nodes at once. This value or maxUnavailable is required to have a value. +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -## AWS.EKS/PodIdentityAssociationProperties +## Tag ### Properties -* **AssociationArn**: string (ReadOnly, Identifier): The ARN of the pod identity association. -* **AssociationId**: string (ReadOnly): The ID of the pod identity association. -* **ClusterName**: string (Required): The cluster that the pod identity association is created for. -* **Namespace**: string (Required): The Kubernetes namespace that the pod identity association is created for. -* **RoleArn**: string (Required): The IAM role ARN that the pod identity association is created for. -* **ServiceAccount**: string (Required): The Kubernetes service account that the pod identity association is created for. -* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ## Tag ### Properties * **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. * **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## Taint +### Properties +* **Effect**: string +* **Key**: string +* **Value**: string + +## UpdateConfig +### Properties +* **MaxUnavailable**: int: The maximum number of nodes unavailable at once during a version update. Nodes will be updated in parallel. This value or maxUnavailablePercentage is required to have a value.The maximum number is 100. +* **MaxUnavailablePercentage**: int: The maximum percentage of nodes unavailable during a version update. This percentage of nodes will be updated in parallel, up to 100 nodes at once. This value or maxUnavailable is required to have a value. + diff --git a/artifacts/bicep/aws/aws.elasticache/default/types.json b/artifacts/bicep/aws/aws.elasticache/default/types.json index ff948982..ab451f39 100644 --- a/artifacts/bicep/aws/aws.elasticache/default/types.json +++ b/artifacts/bicep/aws/aws.elasticache/default/types.json @@ -1 +1,1050 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"GlobalReplicationGroupMember","Properties":{"ReplicationGroupId":{"Type":4,"Flags":0,"Description":"Regionally unique identifier for the member i.e. ReplicationGroupId."},"ReplicationGroupRegion":{"Type":4,"Flags":0,"Description":"The AWS region of the Global Datastore member."},"Role":{"Type":4,"Flags":0,"Description":"Indicates the role of the member, primary or secondary."}}}},{"2":{"Name":"RegionalConfiguration","Properties":{"ReplicationGroupId":{"Type":4,"Flags":0,"Description":"The replication group id of the Global Datastore member."},"ReplicationGroupRegion":{"Type":4,"Flags":0,"Description":"The AWS region of the Global Datastore member."},"ReshardingConfigurations":{"Type":11,"Flags":0,"Description":"A list of PreferredAvailabilityZones objects that specifies the configuration of a node group in the resharded cluster. "}}}},{"2":{"Name":"ReshardingConfiguration","Properties":{"NodeGroupId":{"Type":4,"Flags":0,"Description":"Unique identifier for the Node Group. This is either auto-generated by ElastiCache (4-digit id) or a user supplied id."},"PreferredAvailabilityZones":{"Type":12,"Flags":0,"Description":"A list of preferred availability zones for the nodes of new node groups."}}}},{"3":{"ItemType":10}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.ElastiCache/GlobalReplicationGroupProperties","Properties":{"AutomaticFailoverEnabled":{"Type":2,"Flags":4,"Description":"AutomaticFailoverEnabled"},"CacheNodeType":{"Type":4,"Flags":4,"Description":"The cache node type of the Global Datastore"},"CacheParameterGroupName":{"Type":4,"Flags":0,"Description":"Cache parameter group name to use for the new engine version. This parameter cannot be modified independently."},"EngineVersion":{"Type":4,"Flags":4,"Description":"The engine version of the Global Datastore."},"GlobalNodeGroupCount":{"Type":3,"Flags":4,"Description":"Indicates the number of node groups in the Global Datastore."},"GlobalReplicationGroupDescription":{"Type":4,"Flags":4,"Description":"The optional description of the Global Datastore"},"GlobalReplicationGroupId":{"Type":4,"Flags":18,"Description":"The name of the Global Datastore, it is generated by ElastiCache adding a prefix to GlobalReplicationGroupIdSuffix."},"GlobalReplicationGroupIdSuffix":{"Type":4,"Flags":4,"Description":"The suffix name of a Global Datastore. Amazon ElastiCache automatically applies a prefix to the Global Datastore ID when it is created. Each AWS Region has its own prefix. "},"Members":{"Type":14,"Flags":1,"Description":"The replication groups that comprise the Global Datastore."},"RegionalConfigurations":{"Type":15,"Flags":4,"Description":"Describes the replication group IDs, the AWS regions where they are stored and the shard configuration for each that comprise the Global Datastore "},"Status":{"Type":4,"Flags":2,"Description":"The status of the Global Datastore"}}}},{"3":{"ItemType":8}},{"3":{"ItemType":9}},{"2":{"Name":"AWS.ElastiCache/GlobalReplicationGroup","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":13,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ElastiCache/GlobalReplicationGroup@default","ScopeType":0,"Body":16}},{"2":{"Name":"CacheUsageLimits","Properties":{"DataStorage":{"Type":19,"Flags":0},"ECPUPerSecond":{"Type":20,"Flags":0}}}},{"2":{"Name":"DataStorage","Properties":{"Maximum":{"Type":3,"Flags":1,"Description":"The maximum cached data capacity of the Serverless Cache."},"Unit":{"Type":4,"Flags":1,"Description":"The unix of cached data capacity of the Serverless Cache."}}}},{"2":{"Name":"ECPUPerSecond","Properties":{"Maximum":{"Type":3,"Flags":1,"Description":"The maximum ECPU per second of the Serverless Cache."}}}},{"2":{"Name":"Endpoint","Properties":{"Address":{"Type":4,"Flags":2,"Description":"Endpoint address."},"Port":{"Type":3,"Flags":2,"Description":"Endpoint port."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with 'aws:'. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":0,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.ElastiCache/ServerlessCacheProperties","Properties":{"ARN":{"Type":4,"Flags":2,"Description":"The ARN of the Serverless Cache."},"CacheUsageLimits":{"Type":18,"Flags":0},"CreateTime":{"Type":4,"Flags":2,"Description":"The creation time of the Serverless Cache."},"DailySnapshotTime":{"Type":4,"Flags":0,"Description":"The daily time range (in UTC) during which the service takes automatic snapshot of the Serverless Cache."},"Description":{"Type":4,"Flags":0,"Description":"The description of the Serverless Cache."},"Endpoint":{"Type":21,"Flags":0},"Engine":{"Type":4,"Flags":1,"Description":"The engine name of the Serverless Cache."},"FinalSnapshotName":{"Type":4,"Flags":4,"Description":"The final snapshot name which is taken before Serverless Cache is deleted."},"FullEngineVersion":{"Type":4,"Flags":2,"Description":"The full engine version of the Serverless Cache."},"KmsKeyId":{"Type":4,"Flags":0,"Description":"The ID of the KMS key used to encrypt the cluster."},"MajorEngineVersion":{"Type":4,"Flags":0,"Description":"The major engine version of the Serverless Cache."},"ReaderEndpoint":{"Type":21,"Flags":0},"SecurityGroupIds":{"Type":24,"Flags":0,"Description":"One or more Amazon VPC security groups associated with this Serverless Cache."},"ServerlessCacheName":{"Type":4,"Flags":17,"Description":"The name of the Serverless Cache. This value must be unique."},"SnapshotArnsToRestore":{"Type":25,"Flags":4,"Description":"The ARN's of snapshot to restore Serverless Cache."},"SnapshotRetentionLimit":{"Type":3,"Flags":0,"Description":"The snapshot retention limit of the Serverless Cache."},"Status":{"Type":4,"Flags":2,"Description":"The status of the Serverless Cache."},"SubnetIds":{"Type":26,"Flags":0,"Description":"The subnet id's of the Serverless Cache."},"Tags":{"Type":27,"Flags":0,"Description":"An array of key-value pairs to apply to this Serverless Cache."},"UserGroupId":{"Type":4,"Flags":0,"Description":"The ID of the user group."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":22}},{"2":{"Name":"AWS.ElastiCache/ServerlessCache","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":23,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ElastiCache/ServerlessCache@default","ScopeType":0,"Body":28}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.ElastiCache/SubnetGroupProperties","Properties":{"CacheSubnetGroupName":{"Type":4,"Flags":16,"Description":"The name for the cache subnet group. This value is stored as a lowercase string."},"Description":{"Type":4,"Flags":1,"Description":"The description for the cache subnet group."},"SubnetIds":{"Type":32,"Flags":1,"Description":"The EC2 subnet IDs for the cache subnet group."},"Tags":{"Type":33,"Flags":0}}}},{"3":{"ItemType":4}},{"3":{"ItemType":30}},{"2":{"Name":"AWS.ElastiCache/SubnetGroup","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":31,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ElastiCache/SubnetGroup@default","ScopeType":0,"Body":34}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with 'aws:'. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":0,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.ElastiCache/UserProperties","Properties":{"AccessString":{"Type":4,"Flags":4,"Description":"Access permissions string used for this user account."},"Arn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) of the user account."},"AuthenticationMode":{"Type":39,"Flags":4},"Engine":{"Type":4,"Flags":1,"Description":"Must be redis."},"NoPasswordRequired":{"Type":2,"Flags":4,"Description":"Indicates a password is not required for this user account."},"Passwords":{"Type":40,"Flags":4,"Description":"Passwords used for this user account. You can create up to two passwords for each user."},"Status":{"Type":4,"Flags":2,"Description":"Indicates the user status. Can be \"active\", \"modifying\" or \"deleting\"."},"Tags":{"Type":41,"Flags":0,"Description":"An array of key-value pairs to apply to this user."},"UserId":{"Type":4,"Flags":17,"Description":"The ID of the user."},"UserName":{"Type":4,"Flags":1,"Description":"The username of the user."}}}},{"3":{"ItemType":4}},{"2":{"Name":"User_AuthenticationMode","Properties":{"Passwords":{"Type":38,"Flags":0,"Description":"Passwords used for this user account. You can create up to two passwords for each user."},"Type":{"Type":4,"Flags":1,"Description":"Authentication Type"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":36}},{"2":{"Name":"AWS.ElastiCache/User","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":37,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ElastiCache/User@default","ScopeType":0,"Body":42}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with 'aws:'. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":0,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.ElastiCache/UserGroupProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) of the user account."},"Engine":{"Type":4,"Flags":1,"Description":"Must be redis."},"Status":{"Type":4,"Flags":2,"Description":"Indicates user group status. Can be \"creating\", \"active\", \"modifying\", \"deleting\"."},"Tags":{"Type":46,"Flags":0,"Description":"An array of key-value pairs to apply to this user."},"UserGroupId":{"Type":4,"Flags":17,"Description":"The ID of the user group."},"UserIds":{"Type":47,"Flags":1,"Description":"List of users associated to this user group."}}}},{"3":{"ItemType":44}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.ElastiCache/UserGroup","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":45,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ElastiCache/UserGroup@default","ScopeType":0,"Body":48}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "GlobalReplicationGroupMember", + "properties": { + "ReplicationGroupId": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "Regionally unique identifier for the member i.e. ReplicationGroupId." + }, + "ReplicationGroupRegion": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The AWS region of the Global Datastore member." + }, + "Role": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "Indicates the role of the member, primary or secondary." + } + } + }, + { + "$type": "ObjectType", + "name": "RegionalConfiguration", + "properties": { + "ReplicationGroupId": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The replication group id of the Global Datastore member." + }, + "ReplicationGroupRegion": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The AWS region of the Global Datastore member." + }, + "ReshardingConfigurations": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "A list of PreferredAvailabilityZones objects that specifies the configuration of a node group in the resharded cluster. " + } + } + }, + { + "$type": "ObjectType", + "name": "ReshardingConfiguration", + "properties": { + "NodeGroupId": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "Unique identifier for the Node Group. This is either auto-generated by ElastiCache (4-digit id) or a user supplied id." + }, + "PreferredAvailabilityZones": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "A list of preferred availability zones for the nodes of new node groups." + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.ElastiCache/GlobalReplicationGroupProperties" + }, + { + "$type": "BooleanType" + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "AWS.ElastiCache/GlobalReplicationGroupProperties", + "properties": { + "AutomaticFailoverEnabled": { + "type": { + "$ref": "#/7" + }, + "flags": 4, + "description": "AutomaticFailoverEnabled" + }, + "CacheNodeType": { + "type": { + "$ref": "#/3" + }, + "flags": 4, + "description": "The cache node type of the Global Datastore" + }, + "CacheParameterGroupName": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "Cache parameter group name to use for the new engine version. This parameter cannot be modified independently." + }, + "EngineVersion": { + "type": { + "$ref": "#/3" + }, + "flags": 4, + "description": "The engine version of the Global Datastore." + }, + "GlobalNodeGroupCount": { + "type": { + "$ref": "#/8" + }, + "flags": 4, + "description": "Indicates the number of node groups in the Global Datastore." + }, + "GlobalReplicationGroupDescription": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The optional description of the Global Datastore" + }, + "GlobalReplicationGroupId": { + "type": { + "$ref": "#/3" + }, + "flags": 18, + "description": "The name of the Global Datastore, it is generated by ElastiCache adding a prefix to GlobalReplicationGroupIdSuffix." + }, + "GlobalReplicationGroupIdSuffix": { + "type": { + "$ref": "#/3" + }, + "flags": 4, + "description": "The suffix name of a Global Datastore. Amazon ElastiCache automatically applies a prefix to the Global Datastore ID when it is created. Each AWS Region has its own prefix. " + }, + "Members": { + "type": { + "$ref": "#/9" + }, + "flags": 1, + "description": "The replication groups that comprise the Global Datastore." + }, + "RegionalConfigurations": { + "type": { + "$ref": "#/10" + }, + "flags": 4, + "description": "Describes the replication group IDs, the AWS regions where they are stored and the shard configuration for each that comprise the Global Datastore " + }, + "Status": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The status of the Global Datastore" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ElastiCache/GlobalReplicationGroup", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/11" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ElastiCache/GlobalReplicationGroup@default", + "scopeType": 0, + "body": { + "$ref": "#/12" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.ElastiCache/ParameterGroupProperties" + }, + { + "$type": "ObjectType", + "name": "ParameterGroup_Properties", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/14" + } + }, + { + "$type": "ObjectType", + "name": "AWS.ElastiCache/ParameterGroupProperties", + "properties": { + "CacheParameterGroupFamily": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The name of the cache parameter group family that this cache parameter group is compatible with." + }, + "CacheParameterGroupName": { + "type": { + "$ref": "#/3" + }, + "flags": 18, + "description": "The name of the Cache Parameter Group." + }, + "Description": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The description for this cache parameter group." + }, + "Properties": { + "type": { + "$ref": "#/16" + }, + "flags": 0, + "description": "A comma-delimited list of parameter name/value pairs. For more information see ModifyCacheParameterGroup in the Amazon ElastiCache API Reference Guide." + }, + "Tags": { + "type": { + "$ref": "#/17" + }, + "flags": 0, + "description": "Tags are composed of a Key/Value pair. You can use tags to categorize and track each parameter group. The tag value null is permitted." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ElastiCache/ParameterGroup", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/18" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ElastiCache/ParameterGroup@default", + "scopeType": 0, + "body": { + "$ref": "#/19" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "CacheUsageLimits", + "properties": { + "DataStorage": { + "type": { + "$ref": "#/22" + }, + "flags": 0 + }, + "ECPUPerSecond": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DataStorage", + "properties": { + "Maximum": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The maximum cached data capacity of the Serverless Cache." + }, + "Minimum": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The minimum cached data capacity of the Serverless Cache." + }, + "Unit": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The unit of cached data capacity of the Serverless Cache." + } + } + }, + { + "$type": "ObjectType", + "name": "ECPUPerSecond", + "properties": { + "Maximum": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The maximum ECPU per second of the Serverless Cache." + }, + "Minimum": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The minimum ECPU per second of the Serverless Cache." + } + } + }, + { + "$type": "ObjectType", + "name": "Endpoint", + "properties": { + "Address": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "Endpoint address." + }, + "Port": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "Endpoint port." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with 'aws:'. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.ElastiCache/ServerlessCacheProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/25" + } + }, + { + "$type": "ObjectType", + "name": "AWS.ElastiCache/ServerlessCacheProperties", + "properties": { + "ARN": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The ARN of the Serverless Cache." + }, + "CacheUsageLimits": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "CreateTime": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The creation time of the Serverless Cache." + }, + "DailySnapshotTime": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The daily time range (in UTC) during which the service takes automatic snapshot of the Serverless Cache." + }, + "Description": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The description of the Serverless Cache." + }, + "Endpoint": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "Engine": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The engine name of the Serverless Cache." + }, + "FinalSnapshotName": { + "type": { + "$ref": "#/3" + }, + "flags": 4, + "description": "The final snapshot name which is taken before Serverless Cache is deleted." + }, + "FullEngineVersion": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The full engine version of the Serverless Cache." + }, + "KmsKeyId": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The ID of the KMS key used to encrypt the cluster." + }, + "MajorEngineVersion": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The major engine version of the Serverless Cache." + }, + "ReaderEndpoint": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "SecurityGroupIds": { + "type": { + "$ref": "#/27" + }, + "flags": 0, + "description": "One or more Amazon VPC security groups associated with this Serverless Cache." + }, + "ServerlessCacheName": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "The name of the Serverless Cache. This value must be unique." + }, + "SnapshotArnsToRestore": { + "type": { + "$ref": "#/28" + }, + "flags": 4, + "description": "The ARN's of snapshot to restore Serverless Cache." + }, + "SnapshotRetentionLimit": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The snapshot retention limit of the Serverless Cache." + }, + "Status": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The status of the Serverless Cache." + }, + "SubnetIds": { + "type": { + "$ref": "#/29" + }, + "flags": 0, + "description": "The subnet id's of the Serverless Cache." + }, + "Tags": { + "type": { + "$ref": "#/30" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this Serverless Cache." + }, + "UserGroupId": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The ID of the user group." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ElastiCache/ServerlessCache", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/31" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ElastiCache/ServerlessCache@default", + "scopeType": 0, + "body": { + "$ref": "#/32" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.ElastiCache/SubnetGroupProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/34" + } + }, + { + "$type": "ObjectType", + "name": "AWS.ElastiCache/SubnetGroupProperties", + "properties": { + "CacheSubnetGroupName": { + "type": { + "$ref": "#/3" + }, + "flags": 16, + "description": "The name for the cache subnet group. This value is stored as a lowercase string." + }, + "Description": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The description for the cache subnet group." + }, + "SubnetIds": { + "type": { + "$ref": "#/36" + }, + "flags": 1, + "description": "The EC2 subnet IDs for the cache subnet group." + }, + "Tags": { + "type": { + "$ref": "#/37" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ElastiCache/SubnetGroup", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/38" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ElastiCache/SubnetGroup@default", + "scopeType": 0, + "body": { + "$ref": "#/39" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with 'aws:'. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.ElastiCache/UserProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ObjectType", + "name": "User_AuthenticationMode", + "properties": { + "Passwords": { + "type": { + "$ref": "#/43" + }, + "flags": 0, + "description": "Passwords used for this user account. You can create up to two passwords for each user." + }, + "Type": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "Authentication Type" + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/41" + } + }, + { + "$type": "ObjectType", + "name": "AWS.ElastiCache/UserProperties", + "properties": { + "AccessString": { + "type": { + "$ref": "#/3" + }, + "flags": 4, + "description": "Access permissions string used for this user account." + }, + "Arn": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) of the user account." + }, + "AuthenticationMode": { + "type": { + "$ref": "#/44" + }, + "flags": 4 + }, + "Engine": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "Must be redis." + }, + "NoPasswordRequired": { + "type": { + "$ref": "#/7" + }, + "flags": 4, + "description": "Indicates a password is not required for this user account." + }, + "Passwords": { + "type": { + "$ref": "#/45" + }, + "flags": 4, + "description": "Passwords used for this user account. You can create up to two passwords for each user." + }, + "Status": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "Indicates the user status. Can be \"active\", \"modifying\" or \"deleting\"." + }, + "Tags": { + "type": { + "$ref": "#/46" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this user." + }, + "UserId": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "The ID of the user." + }, + "UserName": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The username of the user." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ElastiCache/User", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/47" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ElastiCache/User@default", + "scopeType": 0, + "body": { + "$ref": "#/48" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with 'aws:'. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.ElastiCache/UserGroupProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/50" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ObjectType", + "name": "AWS.ElastiCache/UserGroupProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) of the user account." + }, + "Engine": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "Must be redis." + }, + "Status": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "Indicates user group status. Can be \"creating\", \"active\", \"modifying\", \"deleting\"." + }, + "Tags": { + "type": { + "$ref": "#/52" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this user." + }, + "UserGroupId": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "The ID of the user group." + }, + "UserIds": { + "type": { + "$ref": "#/53" + }, + "flags": 1, + "description": "List of users associated to this user group." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ElastiCache/UserGroup", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/54" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ElastiCache/UserGroup@default", + "scopeType": 0, + "body": { + "$ref": "#/55" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.elasticache/default/types.md b/artifacts/bicep/aws/aws.elasticache/default/types.md index 104c8ad7..b1f98be4 100644 --- a/artifacts/bicep/aws/aws.elasticache/default/types.md +++ b/artifacts/bicep/aws/aws.elasticache/default/types.md @@ -3,37 +3,44 @@ ## Resource AWS.ElastiCache/GlobalReplicationGroup@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ElastiCache/GlobalReplicationGroupProperties](#awselasticacheglobalreplicationgroupproperties) (Required): properties of the resource +* **properties**: [AWS.ElastiCache/GlobalReplicationGroupProperties](#awselasticacheglobalreplicationgroupproperties) (Required, Identifier): properties of the resource + +## Resource AWS.ElastiCache/ParameterGroup@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.ElastiCache/ParameterGroupProperties](#awselasticacheparametergroupproperties) (Required, Identifier): properties of the resource ## Resource AWS.ElastiCache/ServerlessCache@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ElastiCache/ServerlessCacheProperties](#awselasticacheserverlesscacheproperties) (Required): properties of the resource +* **properties**: [AWS.ElastiCache/ServerlessCacheProperties](#awselasticacheserverlesscacheproperties) (Required, Identifier): properties of the resource ## Resource AWS.ElastiCache/SubnetGroup@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ElastiCache/SubnetGroupProperties](#awselasticachesubnetgroupproperties) (Required): properties of the resource +* **properties**: [AWS.ElastiCache/SubnetGroupProperties](#awselasticachesubnetgroupproperties) (Required, Identifier): properties of the resource ## Resource AWS.ElastiCache/User@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ElastiCache/UserProperties](#awselasticacheuserproperties) (Required): properties of the resource +* **properties**: [AWS.ElastiCache/UserProperties](#awselasticacheuserproperties) (Required, Identifier): properties of the resource ## Resource AWS.ElastiCache/UserGroup@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ElastiCache/UserGroupProperties](#awselasticacheusergroupproperties) (Required): properties of the resource +* **properties**: [AWS.ElastiCache/UserGroupProperties](#awselasticacheusergroupproperties) (Required, Identifier): properties of the resource ## AWS.ElastiCache/GlobalReplicationGroupProperties ### Properties @@ -42,29 +49,20 @@ * **CacheParameterGroupName**: string: Cache parameter group name to use for the new engine version. This parameter cannot be modified independently. * **EngineVersion**: string (WriteOnly): The engine version of the Global Datastore. * **GlobalNodeGroupCount**: int (WriteOnly): Indicates the number of node groups in the Global Datastore. -* **GlobalReplicationGroupDescription**: string (WriteOnly): The optional description of the Global Datastore +* **GlobalReplicationGroupDescription**: string: The optional description of the Global Datastore * **GlobalReplicationGroupId**: string (ReadOnly, Identifier): The name of the Global Datastore, it is generated by ElastiCache adding a prefix to GlobalReplicationGroupIdSuffix. * **GlobalReplicationGroupIdSuffix**: string (WriteOnly): The suffix name of a Global Datastore. Amazon ElastiCache automatically applies a prefix to the Global Datastore ID when it is created. Each AWS Region has its own prefix. * **Members**: [GlobalReplicationGroupMember](#globalreplicationgroupmember)[] (Required): The replication groups that comprise the Global Datastore. * **RegionalConfigurations**: [RegionalConfiguration](#regionalconfiguration)[] (WriteOnly): Describes the replication group IDs, the AWS regions where they are stored and the shard configuration for each that comprise the Global Datastore * **Status**: string (ReadOnly): The status of the Global Datastore -## GlobalReplicationGroupMember -### Properties -* **ReplicationGroupId**: string: Regionally unique identifier for the member i.e. ReplicationGroupId. -* **ReplicationGroupRegion**: string: The AWS region of the Global Datastore member. -* **Role**: string: Indicates the role of the member, primary or secondary. - -## RegionalConfiguration +## AWS.ElastiCache/ParameterGroupProperties ### Properties -* **ReplicationGroupId**: string: The replication group id of the Global Datastore member. -* **ReplicationGroupRegion**: string: The AWS region of the Global Datastore member. -* **ReshardingConfigurations**: [ReshardingConfiguration](#reshardingconfiguration)[]: A list of PreferredAvailabilityZones objects that specifies the configuration of a node group in the resharded cluster. - -## ReshardingConfiguration -### Properties -* **NodeGroupId**: string: Unique identifier for the Node Group. This is either auto-generated by ElastiCache (4-digit id) or a user supplied id. -* **PreferredAvailabilityZones**: string[]: A list of preferred availability zones for the nodes of new node groups. +* **CacheParameterGroupFamily**: string (Required): The name of the cache parameter group family that this cache parameter group is compatible with. +* **CacheParameterGroupName**: string (ReadOnly, Identifier): The name of the Cache Parameter Group. +* **Description**: string (Required): The description for this cache parameter group. +* **Properties**: [ParameterGroup_Properties](#parametergroupproperties): A comma-delimited list of parameter name/value pairs. For more information see ModifyCacheParameterGroup in the Amazon ElastiCache API Reference Guide. +* **Tags**: [Tag](#tag)[]: Tags are composed of a Key/Value pair. You can use tags to categorize and track each parameter group. The tag value null is permitted. ## AWS.ElastiCache/ServerlessCacheProperties ### Properties @@ -89,6 +87,35 @@ * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this Serverless Cache. * **UserGroupId**: string: The ID of the user group. +## AWS.ElastiCache/SubnetGroupProperties +### Properties +* **CacheSubnetGroupName**: string (Identifier): The name for the cache subnet group. This value is stored as a lowercase string. +* **Description**: string (Required): The description for the cache subnet group. +* **SubnetIds**: string[] (Required): The EC2 subnet IDs for the cache subnet group. +* **Tags**: [Tag](#tag)[] + +## AWS.ElastiCache/UserGroupProperties +### Properties +* **Arn**: string (ReadOnly): The Amazon Resource Name (ARN) of the user account. +* **Engine**: string (Required): Must be redis. +* **Status**: string (ReadOnly): Indicates user group status. Can be "creating", "active", "modifying", "deleting". +* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this user. +* **UserGroupId**: string (Required, Identifier): The ID of the user group. +* **UserIds**: string[] (Required): List of users associated to this user group. + +## AWS.ElastiCache/UserProperties +### Properties +* **AccessString**: string (WriteOnly): Access permissions string used for this user account. +* **Arn**: string (ReadOnly): The Amazon Resource Name (ARN) of the user account. +* **AuthenticationMode**: [User_AuthenticationMode](#userauthenticationmode) (WriteOnly) +* **Engine**: string (Required): Must be redis. +* **NoPasswordRequired**: bool (WriteOnly): Indicates a password is not required for this user account. +* **Passwords**: string[] (WriteOnly): Passwords used for this user account. You can create up to two passwords for each user. +* **Status**: string (ReadOnly): Indicates the user status. Can be "active", "modifying" or "deleting". +* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this user. +* **UserId**: string (Required, Identifier): The ID of the user. +* **UserName**: string (Required): The username of the user. + ## CacheUsageLimits ### Properties * **DataStorage**: [DataStorage](#datastorage) @@ -96,69 +123,67 @@ ## DataStorage ### Properties -* **Maximum**: int (Required): The maximum cached data capacity of the Serverless Cache. -* **Unit**: string (Required): The unix of cached data capacity of the Serverless Cache. +* **Maximum**: int: The maximum cached data capacity of the Serverless Cache. +* **Minimum**: int: The minimum cached data capacity of the Serverless Cache. +* **Unit**: string (Required): The unit of cached data capacity of the Serverless Cache. ## ECPUPerSecond ### Properties -* **Maximum**: int (Required): The maximum ECPU per second of the Serverless Cache. +* **Maximum**: int: The maximum ECPU per second of the Serverless Cache. +* **Minimum**: int: The minimum ECPU per second of the Serverless Cache. ## Endpoint ### Properties * **Address**: string (ReadOnly): Endpoint address. -* **Port**: int (ReadOnly): Endpoint port. +* **Port**: string (ReadOnly): Endpoint port. -## Tag +## GlobalReplicationGroupMember ### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with 'aws:'. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **ReplicationGroupId**: string: Regionally unique identifier for the member i.e. ReplicationGroupId. +* **ReplicationGroupRegion**: string: The AWS region of the Global Datastore member. +* **Role**: string: Indicates the role of the member, primary or secondary. -## AWS.ElastiCache/SubnetGroupProperties +## ParameterGroup_Properties ### Properties -* **CacheSubnetGroupName**: string (Identifier): The name for the cache subnet group. This value is stored as a lowercase string. -* **Description**: string (Required): The description for the cache subnet group. -* **SubnetIds**: string[] (Required): The EC2 subnet IDs for the cache subnet group. -* **Tags**: [Tag](#tag)[] + +## RegionalConfiguration +### Properties +* **ReplicationGroupId**: string: The replication group id of the Global Datastore member. +* **ReplicationGroupRegion**: string: The AWS region of the Global Datastore member. +* **ReshardingConfigurations**: [ReshardingConfiguration](#reshardingconfiguration)[]: A list of PreferredAvailabilityZones objects that specifies the configuration of a node group in the resharded cluster. + +## ReshardingConfiguration +### Properties +* **NodeGroupId**: string: Unique identifier for the Node Group. This is either auto-generated by ElastiCache (4-digit id) or a user supplied id. +* **PreferredAvailabilityZones**: string[]: A list of preferred availability zones for the nodes of new node groups. ## Tag ### Properties * **Key**: string (Required) * **Value**: string (Required) -## AWS.ElastiCache/UserProperties +## Tag ### Properties -* **AccessString**: string (WriteOnly): Access permissions string used for this user account. -* **Arn**: string (ReadOnly): The Amazon Resource Name (ARN) of the user account. -* **AuthenticationMode**: [User_AuthenticationMode](#userauthenticationmode) (WriteOnly) -* **Engine**: string (Required): Must be redis. -* **NoPasswordRequired**: bool (WriteOnly): Indicates a password is not required for this user account. -* **Passwords**: string[] (WriteOnly): Passwords used for this user account. You can create up to two passwords for each user. -* **Status**: string (ReadOnly): Indicates the user status. Can be "active", "modifying" or "deleting". -* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this user. -* **UserId**: string (Required, Identifier): The ID of the user. -* **UserName**: string (Required): The username of the user. +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with 'aws:'. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -## User_AuthenticationMode +## Tag ### Properties -* **Passwords**: string[]: Passwords used for this user account. You can create up to two passwords for each user. -* **Type**: string (Required): Authentication Type +* **Key**: string (Required) +* **Value**: string (Required) ## Tag ### Properties * **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with 'aws:'. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. * **Value**: string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -## AWS.ElastiCache/UserGroupProperties -### Properties -* **Arn**: string (ReadOnly): The Amazon Resource Name (ARN) of the user account. -* **Engine**: string (Required): Must be redis. -* **Status**: string (ReadOnly): Indicates user group status. Can be "creating", "active", "modifying", "deleting". -* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this user. -* **UserGroupId**: string (Required, Identifier): The ID of the user group. -* **UserIds**: string[] (Required): List of users associated to this user group. - ## Tag ### Properties * **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with 'aws:'. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. * **Value**: string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +## User_AuthenticationMode +### Properties +* **Passwords**: string[]: Passwords used for this user account. You can create up to two passwords for each user. +* **Type**: string (Required): Authentication Type + diff --git a/artifacts/bicep/aws/aws.elasticbeanstalk/default/types.json b/artifacts/bicep/aws/aws.elasticbeanstalk/default/types.json index 46140e8c..8b0deb1b 100644 --- a/artifacts/bicep/aws/aws.elasticbeanstalk/default/types.json +++ b/artifacts/bicep/aws/aws.elasticbeanstalk/default/types.json @@ -1 +1,656 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"ApplicationResourceLifecycleConfig","Properties":{"ServiceRole":{"Type":4,"Flags":0,"Description":"The ARN of an IAM service role that Elastic Beanstalk has permission to assume. The ServiceRole property is required the first time that you provide a ResourceLifecycleConfig for the application. After you provide it once, Elastic Beanstalk persists the Service Role with the application, and you don't need to specify it again. You can, however, specify it in subsequent updates to change the Service Role to another value."},"VersionLifecycleConfig":{"Type":9,"Flags":0,"Description":"Defines lifecycle settings for application versions."}}}},{"2":{"Name":"ApplicationVersionLifecycleConfig","Properties":{"MaxAgeRule":{"Type":10,"Flags":0,"Description":"Specify a max age rule to restrict the length of time that application versions are retained for an application."},"MaxCountRule":{"Type":11,"Flags":0,"Description":"Specify a max count rule to restrict the number of application versions that are retained for an application."}}}},{"2":{"Name":"MaxAgeRule","Properties":{"DeleteSourceFromS3":{"Type":2,"Flags":0,"Description":"Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version."},"Enabled":{"Type":2,"Flags":0,"Description":"Specify true to apply the rule, or false to disable it."},"MaxAgeInDays":{"Type":3,"Flags":0,"Description":"Specify the number of days to retain an application versions."}}}},{"2":{"Name":"MaxCountRule","Properties":{"DeleteSourceFromS3":{"Type":2,"Flags":0,"Description":"Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version."},"Enabled":{"Type":2,"Flags":0,"Description":"Specify true to apply the rule, or false to disable it."},"MaxCount":{"Type":3,"Flags":0,"Description":"Specify the maximum number of application versions to retain."}}}},{"2":{"Name":"AWS.ElasticBeanstalk/ApplicationProperties","Properties":{"ApplicationName":{"Type":4,"Flags":16,"Description":"A 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."},"Description":{"Type":4,"Flags":0,"Description":"Your description of the application."},"ResourceLifecycleConfig":{"Type":8,"Flags":0,"Description":"Specifies an application resource lifecycle configuration to prevent your application from accumulating too many versions."}}}},{"2":{"Name":"AWS.ElasticBeanstalk/Application","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":12,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ElasticBeanstalk/Application@default","ScopeType":0,"Body":13}},{"2":{"Name":"SourceBundle","Properties":{"S3Bucket":{"Type":4,"Flags":1,"Description":"The Amazon S3 bucket where the data is located."},"S3Key":{"Type":4,"Flags":1,"Description":"The Amazon S3 key where the data is located."}}}},{"2":{"Name":"AWS.ElasticBeanstalk/ApplicationVersionProperties","Properties":{"ApplicationName":{"Type":4,"Flags":17,"Description":"The name of the Elastic Beanstalk application that is associated with this application version. "},"Description":{"Type":4,"Flags":0,"Description":"A description of this application version."},"Id":{"Type":4,"Flags":18},"SourceBundle":{"Type":15,"Flags":1,"Description":"The Amazon S3 bucket and key that identify the location of the source bundle for this version. "}}}},{"2":{"Name":"AWS.ElasticBeanstalk/ApplicationVersion","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":16,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ElasticBeanstalk/ApplicationVersion@default","ScopeType":0,"Body":17}},{"2":{"Name":"ConfigurationOptionSetting","Properties":{"Namespace":{"Type":4,"Flags":1,"Description":"A unique namespace that identifies the option's associated AWS resource."},"OptionName":{"Type":4,"Flags":1,"Description":"The name of the configuration option."},"ResourceName":{"Type":4,"Flags":0,"Description":"A unique resource name for the option setting. Use it for a time–based scaling configuration option. "},"Value":{"Type":4,"Flags":0,"Description":"The current value for the configuration option."}}}},{"2":{"Name":"SourceConfiguration","Properties":{"ApplicationName":{"Type":4,"Flags":21,"Description":"The name of the application associated with the configuration."},"TemplateName":{"Type":4,"Flags":21,"Description":"The name of the configuration template."}}}},{"2":{"Name":"AWS.ElasticBeanstalk/ConfigurationTemplateProperties","Properties":{"ApplicationName":{"Type":4,"Flags":17,"Description":"The name of the Elastic Beanstalk application to associate with this configuration template. "},"Description":{"Type":4,"Flags":0,"Description":"An optional description for this configuration."},"EnvironmentId":{"Type":4,"Flags":4,"Description":"The ID of an environment whose settings you want to use to create the configuration template. You must specify EnvironmentId if you don't specify PlatformArn, SolutionStackName, or SourceConfiguration. "},"OptionSettings":{"Type":22,"Flags":0,"Description":"Option values for the Elastic Beanstalk configuration, such as the instance type. If specified, these values override the values obtained from the solution stack or the source configuration template. 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 AWS Elastic Beanstalk Developer Guide. "},"PlatformArn":{"Type":4,"Flags":0,"Description":"The 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. "},"SolutionStackName":{"Type":4,"Flags":0,"Description":"The name of an Elastic Beanstalk solution stack (platform version) that this configuration uses. For example, 64bit Amazon Linux 2013.09 running Tomcat 7 Java 7. A solution stack specifies the operating system, runtime, and application server for a configuration template. It also determines the set of configuration options as well as the possible and default values. For more information, see [Supported Platforms](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/concepts.platforms.html) in the AWS Elastic Beanstalk Developer Guide.\n\n You must specify SolutionStackName if you don't specify PlatformArn, EnvironmentId, or SourceConfiguration.\n\n Use the ListAvailableSolutionStacks API to obtain a list of available solution stacks. "},"SourceConfiguration":{"Type":20,"Flags":0,"Description":"An Elastic Beanstalk configuration template to base this one on. If specified, Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.\n\nValues specified in OptionSettings override any values obtained from the SourceConfiguration.\n\nYou must specify SourceConfiguration if you don't specify PlatformArn, EnvironmentId, or SolutionStackName.\n\nConstraint: If both solution stack name and source configuration are specified, the solution stack of the source configuration template must match the specified solution stack name. "},"TemplateName":{"Type":4,"Flags":18,"Description":"The name of the configuration template"}}}},{"3":{"ItemType":19}},{"2":{"Name":"AWS.ElasticBeanstalk/ConfigurationTemplate","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":21,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ElasticBeanstalk/ConfigurationTemplate@default","ScopeType":0,"Body":23}},{"2":{"Name":"OptionSetting","Properties":{"Namespace":{"Type":4,"Flags":1,"Description":"A unique namespace that identifies the option's associated AWS resource."},"OptionName":{"Type":4,"Flags":1,"Description":"The name of the configuration option."},"ResourceName":{"Type":4,"Flags":0,"Description":"A unique resource name for the option setting. Use it for a time–based scaling configuration option."},"Value":{"Type":4,"Flags":0,"Description":"The current value for the configuration option."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag."}}}},{"2":{"Name":"Tier","Properties":{"Name":{"Type":4,"Flags":0,"Description":"The name of this environment tier."},"Type":{"Type":4,"Flags":0,"Description":"The type of this environment tier."},"Version":{"Type":4,"Flags":0,"Description":"The version of this environment tier. When you don't set a value to it, Elastic Beanstalk uses the latest compatible worker tier version."}}}},{"2":{"Name":"AWS.ElasticBeanstalk/EnvironmentProperties","Properties":{"ApplicationName":{"Type":4,"Flags":1,"Description":"The name of the application that is associated with this environment."},"CNAMEPrefix":{"Type":4,"Flags":0,"Description":"If 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 generated automatically by appending a random alphanumeric string to the environment name."},"Description":{"Type":4,"Flags":0,"Description":"Your description for this environment."},"EndpointURL":{"Type":4,"Flags":2},"EnvironmentName":{"Type":4,"Flags":16,"Description":"A unique name for the environment."},"OperationsRole":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role."},"OptionSettings":{"Type":29,"Flags":4,"Description":"Key-value pairs defining configuration options for this environment, such as the instance type."},"PlatformArn":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) of the custom platform to use with the environment."},"SolutionStackName":{"Type":4,"Flags":0,"Description":"The name of an Elastic Beanstalk solution stack (platform version) to use with the environment."},"Tags":{"Type":30,"Flags":0,"Description":"Specifies the tags applied to resources in the environment."},"TemplateName":{"Type":4,"Flags":4,"Description":"The name of the Elastic Beanstalk configuration template to use with the environment."},"Tier":{"Type":27,"Flags":0,"Description":"Specifies the tier to use in creating this environment. The environment tier that you choose determines whether Elastic Beanstalk provisions resources to support a web application that handles HTTP(S) requests or a web application that handles background-processing tasks."},"VersionLabel":{"Type":4,"Flags":0,"Description":"The name of the application version to deploy."}}}},{"3":{"ItemType":25}},{"3":{"ItemType":26}},{"2":{"Name":"AWS.ElasticBeanstalk/Environment","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":28,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ElasticBeanstalk/Environment@default","ScopeType":0,"Body":31}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "ApplicationResourceLifecycleConfig", + "properties": { + "ServiceRole": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The ARN of an IAM service role that Elastic Beanstalk has permission to assume. The ServiceRole property is required the first time that you provide a ResourceLifecycleConfig for the application. After you provide it once, Elastic Beanstalk persists the Service Role with the application, and you don't need to specify it again. You can, however, specify it in subsequent updates to change the Service Role to another value." + }, + "VersionLifecycleConfig": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Defines lifecycle settings for application versions." + } + } + }, + { + "$type": "ObjectType", + "name": "ApplicationVersionLifecycleConfig", + "properties": { + "MaxAgeRule": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "Specify a max age rule to restrict the length of time that application versions are retained for an application." + }, + "MaxCountRule": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "Specify a max count rule to restrict the number of application versions that are retained for an application." + } + } + }, + { + "$type": "ObjectType", + "name": "MaxAgeRule", + "properties": { + "DeleteSourceFromS3": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version." + }, + "Enabled": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "Specify true to apply the rule, or false to disable it." + }, + "MaxAgeInDays": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Specify the number of days to retain an application versions." + } + } + }, + { + "$type": "ObjectType", + "name": "MaxCountRule", + "properties": { + "DeleteSourceFromS3": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version." + }, + "Enabled": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "Specify true to apply the rule, or false to disable it." + }, + "MaxCount": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Specify the maximum number of application versions to retain." + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "BooleanType" + }, + { + "$type": "IntegerType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.ElasticBeanstalk/ApplicationProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.ElasticBeanstalk/ApplicationProperties", + "properties": { + "ApplicationName": { + "type": { + "$ref": "#/4" + }, + "flags": 16, + "description": "A 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." + }, + "Description": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Your description of the application." + }, + "ResourceLifecycleConfig": { + "type": { + "$ref": "#/0" + }, + "flags": 0, + "description": "Specifies an application resource lifecycle configuration to prevent your application from accumulating too many versions." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ElasticBeanstalk/Application", + "properties": { + "name": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/8" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ElasticBeanstalk/Application@default", + "scopeType": 0, + "body": { + "$ref": "#/9" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "SourceBundle", + "properties": { + "S3Bucket": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The Amazon S3 bucket where the data is located." + }, + "S3Key": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The Amazon S3 key where the data is located." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.ElasticBeanstalk/ApplicationVersionProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.ElasticBeanstalk/ApplicationVersionProperties", + "properties": { + "ApplicationName": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "The name of the Elastic Beanstalk application that is associated with this application version. " + }, + "Description": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "A description of this application version." + }, + "Id": { + "type": { + "$ref": "#/4" + }, + "flags": 18 + }, + "SourceBundle": { + "type": { + "$ref": "#/11" + }, + "flags": 1, + "description": "The Amazon S3 bucket and key that identify the location of the source bundle for this version. " + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ElasticBeanstalk/ApplicationVersion", + "properties": { + "name": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/13" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ElasticBeanstalk/ApplicationVersion@default", + "scopeType": 0, + "body": { + "$ref": "#/14" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "ConfigurationOptionSetting", + "properties": { + "Namespace": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "A unique namespace that identifies the option's associated AWS resource." + }, + "OptionName": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The name of the configuration option." + }, + "ResourceName": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "A unique resource name for the option setting. Use it for a time–based scaling configuration option. " + }, + "Value": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The current value for the configuration option." + } + } + }, + { + "$type": "ObjectType", + "name": "SourceConfiguration", + "properties": { + "ApplicationName": { + "type": { + "$ref": "#/4" + }, + "flags": 21, + "description": "The name of the application associated with the configuration." + }, + "TemplateName": { + "type": { + "$ref": "#/4" + }, + "flags": 21, + "description": "The name of the configuration template." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.ElasticBeanstalk/ConfigurationTemplateProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/16" + } + }, + { + "$type": "ObjectType", + "name": "AWS.ElasticBeanstalk/ConfigurationTemplateProperties", + "properties": { + "ApplicationName": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "The name of the Elastic Beanstalk application to associate with this configuration template. " + }, + "Description": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "An optional description for this configuration." + }, + "EnvironmentId": { + "type": { + "$ref": "#/4" + }, + "flags": 4, + "description": "The ID of an environment whose settings you want to use to create the configuration template. You must specify EnvironmentId if you don't specify PlatformArn, SolutionStackName, or SourceConfiguration. " + }, + "OptionSettings": { + "type": { + "$ref": "#/19" + }, + "flags": 0, + "description": "Option values for the Elastic Beanstalk configuration, such as the instance type. If specified, these values override the values obtained from the solution stack or the source configuration template. 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 AWS Elastic Beanstalk Developer Guide. " + }, + "PlatformArn": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The 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. " + }, + "SolutionStackName": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The name of an Elastic Beanstalk solution stack (platform version) that this configuration uses. For example, 64bit Amazon Linux 2013.09 running Tomcat 7 Java 7. A solution stack specifies the operating system, runtime, and application server for a configuration template. It also determines the set of configuration options as well as the possible and default values. For more information, see [Supported Platforms](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/concepts.platforms.html) in the AWS Elastic Beanstalk Developer Guide.\n\n You must specify SolutionStackName if you don't specify PlatformArn, EnvironmentId, or SourceConfiguration.\n\n Use the ListAvailableSolutionStacks API to obtain a list of available solution stacks. " + }, + "SourceConfiguration": { + "type": { + "$ref": "#/17" + }, + "flags": 0, + "description": "An Elastic Beanstalk configuration template to base this one on. If specified, Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.\n\nValues specified in OptionSettings override any values obtained from the SourceConfiguration.\n\nYou must specify SourceConfiguration if you don't specify PlatformArn, EnvironmentId, or SolutionStackName.\n\nConstraint: If both solution stack name and source configuration are specified, the solution stack of the source configuration template must match the specified solution stack name. " + }, + "TemplateName": { + "type": { + "$ref": "#/4" + }, + "flags": 18, + "description": "The name of the configuration template" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ElasticBeanstalk/ConfigurationTemplate", + "properties": { + "name": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/20" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ElasticBeanstalk/ConfigurationTemplate@default", + "scopeType": 0, + "body": { + "$ref": "#/21" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "OptionSetting", + "properties": { + "Namespace": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "A unique namespace that identifies the option's associated AWS resource." + }, + "OptionName": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The name of the configuration option." + }, + "ResourceName": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "A unique resource name for the option setting. Use it for a time–based scaling configuration option." + }, + "Value": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The current value for the configuration option." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The key name of the tag." + }, + "Value": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The value for the tag." + } + } + }, + { + "$type": "ObjectType", + "name": "Tier", + "properties": { + "Name": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The name of this environment tier." + }, + "Type": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The type of this environment tier." + }, + "Version": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The version of this environment tier. When you don't set a value to it, Elastic Beanstalk uses the latest compatible worker tier version." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.ElasticBeanstalk/EnvironmentProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/23" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/24" + } + }, + { + "$type": "ObjectType", + "name": "AWS.ElasticBeanstalk/EnvironmentProperties", + "properties": { + "ApplicationName": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The name of the application that is associated with this environment." + }, + "CNAMEPrefix": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "If 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 generated automatically by appending a random alphanumeric string to the environment name." + }, + "Description": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Your description for this environment." + }, + "EndpointURL": { + "type": { + "$ref": "#/4" + }, + "flags": 2 + }, + "EnvironmentName": { + "type": { + "$ref": "#/4" + }, + "flags": 16, + "description": "A unique name for the environment." + }, + "OperationsRole": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role." + }, + "OptionSettings": { + "type": { + "$ref": "#/27" + }, + "flags": 4, + "description": "Key-value pairs defining configuration options for this environment, such as the instance type." + }, + "PlatformArn": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the custom platform to use with the environment." + }, + "SolutionStackName": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The name of an Elastic Beanstalk solution stack (platform version) to use with the environment." + }, + "Tags": { + "type": { + "$ref": "#/28" + }, + "flags": 0, + "description": "Specifies the tags applied to resources in the environment." + }, + "TemplateName": { + "type": { + "$ref": "#/4" + }, + "flags": 4, + "description": "The name of the Elastic Beanstalk configuration template to use with the environment." + }, + "Tier": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "Specifies the tier to use in creating this environment. The environment tier that you choose determines whether Elastic Beanstalk provisions resources to support a web application that handles HTTP(S) requests or a web application that handles background-processing tasks." + }, + "VersionLabel": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The name of the application version to deploy." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ElasticBeanstalk/Environment", + "properties": { + "name": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/29" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ElasticBeanstalk/Environment@default", + "scopeType": 0, + "body": { + "$ref": "#/30" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.elasticbeanstalk/default/types.md b/artifacts/bicep/aws/aws.elasticbeanstalk/default/types.md index f2042ad6..b4d69426 100644 --- a/artifacts/bicep/aws/aws.elasticbeanstalk/default/types.md +++ b/artifacts/bicep/aws/aws.elasticbeanstalk/default/types.md @@ -3,36 +3,30 @@ ## Resource AWS.ElasticBeanstalk/Application@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ElasticBeanstalk/ApplicationProperties](#awselasticbeanstalkapplicationproperties): properties of the resource +* **properties**: [AWS.ElasticBeanstalk/ApplicationProperties](#awselasticbeanstalkapplicationproperties) (Identifier): properties of the resource ## Resource AWS.ElasticBeanstalk/ApplicationVersion@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ElasticBeanstalk/ApplicationVersionProperties](#awselasticbeanstalkapplicationversionproperties) (Required): properties of the resource +* **properties**: [AWS.ElasticBeanstalk/ApplicationVersionProperties](#awselasticbeanstalkapplicationversionproperties) (Required, Identifier): properties of the resource ## Resource AWS.ElasticBeanstalk/ConfigurationTemplate@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ElasticBeanstalk/ConfigurationTemplateProperties](#awselasticbeanstalkconfigurationtemplateproperties) (Required): properties of the resource +* **properties**: [AWS.ElasticBeanstalk/ConfigurationTemplateProperties](#awselasticbeanstalkconfigurationtemplateproperties) (Required, Identifier): properties of the resource ## Resource AWS.ElasticBeanstalk/Environment@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ElasticBeanstalk/EnvironmentProperties](#awselasticbeanstalkenvironmentproperties) (Required): properties of the resource - -## AWS.ElasticBeanstalk/ApplicationProperties -### Properties -* **ApplicationName**: string (Identifier): A 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. -* **Description**: string: Your description of the application. -* **ResourceLifecycleConfig**: [ApplicationResourceLifecycleConfig](#applicationresourcelifecycleconfig): Specifies an application resource lifecycle configuration to prevent your application from accumulating too many versions. +* **properties**: [AWS.ElasticBeanstalk/EnvironmentProperties](#awselasticbeanstalkenvironmentproperties) (Required, Identifier): properties of the resource ## ApplicationResourceLifecycleConfig ### Properties @@ -44,17 +38,11 @@ * **MaxAgeRule**: [MaxAgeRule](#maxagerule): Specify a max age rule to restrict the length of time that application versions are retained for an application. * **MaxCountRule**: [MaxCountRule](#maxcountrule): Specify a max count rule to restrict the number of application versions that are retained for an application. -## MaxAgeRule -### Properties -* **DeleteSourceFromS3**: bool: Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version. -* **Enabled**: bool: Specify true to apply the rule, or false to disable it. -* **MaxAgeInDays**: int: Specify the number of days to retain an application versions. - -## MaxCountRule +## AWS.ElasticBeanstalk/ApplicationProperties ### Properties -* **DeleteSourceFromS3**: bool: Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version. -* **Enabled**: bool: Specify true to apply the rule, or false to disable it. -* **MaxCount**: int: Specify the maximum number of application versions to retain. +* **ApplicationName**: string (Identifier): A 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. +* **Description**: string: Your description of the application. +* **ResourceLifecycleConfig**: [ApplicationResourceLifecycleConfig](#applicationresourcelifecycleconfig): Specifies an application resource lifecycle configuration to prevent your application from accumulating too many versions. ## AWS.ElasticBeanstalk/ApplicationVersionProperties ### Properties @@ -63,11 +51,6 @@ * **Id**: string (ReadOnly, Identifier) * **SourceBundle**: [SourceBundle](#sourcebundle) (Required): The Amazon S3 bucket and key that identify the location of the source bundle for this version. -## SourceBundle -### Properties -* **S3Bucket**: string (Required): The Amazon S3 bucket where the data is located. -* **S3Key**: string (Required): The Amazon S3 key where the data is located. - ## AWS.ElasticBeanstalk/ConfigurationTemplateProperties ### Properties * **ApplicationName**: string (Required, Identifier): The name of the Elastic Beanstalk application to associate with this configuration template. @@ -89,18 +72,6 @@ You must specify SourceConfiguration if you don't specify PlatformArn, Environme Constraint: If both solution stack name and source configuration are specified, the solution stack of the source configuration template must match the specified solution stack name. * **TemplateName**: string (ReadOnly, Identifier): The name of the configuration template -## ConfigurationOptionSetting -### Properties -* **Namespace**: string (Required): A unique namespace that identifies the option's associated AWS resource. -* **OptionName**: string (Required): The name of the configuration option. -* **ResourceName**: string: A unique resource name for the option setting. Use it for a time–based scaling configuration option. -* **Value**: string: The current value for the configuration option. - -## SourceConfiguration -### Properties -* **ApplicationName**: string (Required, WriteOnly, Identifier): The name of the application associated with the configuration. -* **TemplateName**: string (Required, WriteOnly, Identifier): The name of the configuration template. - ## AWS.ElasticBeanstalk/EnvironmentProperties ### Properties * **ApplicationName**: string (Required): The name of the application that is associated with this environment. @@ -117,6 +88,25 @@ Constraint: If both solution stack name and source configuration are specified, * **Tier**: [Tier](#tier): Specifies the tier to use in creating this environment. The environment tier that you choose determines whether Elastic Beanstalk provisions resources to support a web application that handles HTTP(S) requests or a web application that handles background-processing tasks. * **VersionLabel**: string: The name of the application version to deploy. +## ConfigurationOptionSetting +### Properties +* **Namespace**: string (Required): A unique namespace that identifies the option's associated AWS resource. +* **OptionName**: string (Required): The name of the configuration option. +* **ResourceName**: string: A unique resource name for the option setting. Use it for a time–based scaling configuration option. +* **Value**: string: The current value for the configuration option. + +## MaxAgeRule +### Properties +* **DeleteSourceFromS3**: bool: Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version. +* **Enabled**: bool: Specify true to apply the rule, or false to disable it. +* **MaxAgeInDays**: int: Specify the number of days to retain an application versions. + +## MaxCountRule +### Properties +* **DeleteSourceFromS3**: bool: Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version. +* **Enabled**: bool: Specify true to apply the rule, or false to disable it. +* **MaxCount**: int: Specify the maximum number of application versions to retain. + ## OptionSetting ### Properties * **Namespace**: string (Required): A unique namespace that identifies the option's associated AWS resource. @@ -124,6 +114,16 @@ Constraint: If both solution stack name and source configuration are specified, * **ResourceName**: string: A unique resource name for the option setting. Use it for a time–based scaling configuration option. * **Value**: string: The current value for the configuration option. +## SourceBundle +### Properties +* **S3Bucket**: string (Required): The Amazon S3 bucket where the data is located. +* **S3Key**: string (Required): The Amazon S3 key where the data is located. + +## SourceConfiguration +### Properties +* **ApplicationName**: string (Required, WriteOnly, Identifier): The name of the application associated with the configuration. +* **TemplateName**: string (Required, WriteOnly, Identifier): The name of the configuration template. + ## Tag ### Properties * **Key**: string (Required): The key name of the tag. diff --git a/artifacts/bicep/aws/aws.elasticloadbalancingv2/default/types.json b/artifacts/bicep/aws/aws.elasticloadbalancingv2/default/types.json index bfa921e4..c1bbca84 100644 --- a/artifacts/bicep/aws/aws.elasticloadbalancingv2/default/types.json +++ b/artifacts/bicep/aws/aws.elasticloadbalancingv2/default/types.json @@ -1 +1,1916 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"Action","Properties":{"AuthenticateCognitoConfig":{"Type":9,"Flags":0},"AuthenticateOidcConfig":{"Type":10,"Flags":0},"FixedResponseConfig":{"Type":12,"Flags":0},"ForwardConfig":{"Type":13,"Flags":0},"Order":{"Type":3,"Flags":0},"RedirectConfig":{"Type":15,"Flags":0},"TargetGroupArn":{"Type":4,"Flags":0},"Type":{"Type":4,"Flags":1}}}},{"2":{"Name":"AuthenticateCognitoConfig","Properties":{"AuthenticationRequestExtraParams":{"Type":18,"Flags":0},"OnUnauthenticatedRequest":{"Type":4,"Flags":0},"Scope":{"Type":4,"Flags":0},"SessionCookieName":{"Type":4,"Flags":0},"SessionTimeout":{"Type":4,"Flags":0},"UserPoolArn":{"Type":4,"Flags":1},"UserPoolClientId":{"Type":4,"Flags":1},"UserPoolDomain":{"Type":4,"Flags":1}}}},{"2":{"Name":"AuthenticateOidcConfig","Properties":{"AuthenticationRequestExtraParams":{"Type":19,"Flags":0},"AuthorizationEndpoint":{"Type":4,"Flags":1},"ClientId":{"Type":4,"Flags":1},"ClientSecret":{"Type":4,"Flags":0},"Issuer":{"Type":4,"Flags":1},"OnUnauthenticatedRequest":{"Type":4,"Flags":0},"Scope":{"Type":4,"Flags":0},"SessionCookieName":{"Type":4,"Flags":0},"SessionTimeout":{"Type":4,"Flags":0},"TokenEndpoint":{"Type":4,"Flags":1},"UseExistingClientSecret":{"Type":2,"Flags":0},"UserInfoEndpoint":{"Type":4,"Flags":1}}}},{"2":{"Name":"Certificate","Properties":{"CertificateArn":{"Type":4,"Flags":0}}}},{"2":{"Name":"FixedResponseConfig","Properties":{"ContentType":{"Type":4,"Flags":0},"MessageBody":{"Type":4,"Flags":0},"StatusCode":{"Type":4,"Flags":1}}}},{"2":{"Name":"ForwardConfig","Properties":{"TargetGroupStickinessConfig":{"Type":16,"Flags":0},"TargetGroups":{"Type":20,"Flags":0}}}},{"2":{"Name":"MutualAuthentication","Properties":{"IgnoreClientCertificateExpiry":{"Type":2,"Flags":0},"Mode":{"Type":4,"Flags":0},"TrustStoreArn":{"Type":4,"Flags":0}}}},{"2":{"Name":"RedirectConfig","Properties":{"Host":{"Type":4,"Flags":0},"Path":{"Type":4,"Flags":0},"Port":{"Type":4,"Flags":0},"Protocol":{"Type":4,"Flags":0},"Query":{"Type":4,"Flags":0},"StatusCode":{"Type":4,"Flags":1}}}},{"2":{"Name":"TargetGroupStickinessConfig","Properties":{"DurationSeconds":{"Type":3,"Flags":0},"Enabled":{"Type":2,"Flags":0}}}},{"2":{"Name":"TargetGroupTuple","Properties":{"TargetGroupArn":{"Type":4,"Flags":0},"Weight":{"Type":3,"Flags":0}}}},{"2":{"Name":"Listener_AuthenticationRequestExtraParams","Properties":{}}},{"2":{"Name":"Listener_AuthenticationRequestExtraParams","Properties":{}}},{"3":{"ItemType":17}},{"2":{"Name":"AWS.ElasticLoadBalancingV2/ListenerProperties","Properties":{"AlpnPolicy":{"Type":22,"Flags":0},"Certificates":{"Type":23,"Flags":0},"DefaultActions":{"Type":24,"Flags":5},"ListenerArn":{"Type":4,"Flags":18},"LoadBalancerArn":{"Type":4,"Flags":1},"MutualAuthentication":{"Type":14,"Flags":0},"Port":{"Type":3,"Flags":0},"Protocol":{"Type":4,"Flags":0},"SslPolicy":{"Type":4,"Flags":0}}}},{"3":{"ItemType":4}},{"3":{"ItemType":11}},{"3":{"ItemType":8}},{"2":{"Name":"AWS.ElasticLoadBalancingV2/Listener","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":21,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ElasticLoadBalancingV2/Listener@default","ScopeType":0,"Body":25}},{"2":{"Name":"Action","Properties":{"AuthenticateCognitoConfig":{"Type":28,"Flags":0},"AuthenticateOidcConfig":{"Type":29,"Flags":0},"FixedResponseConfig":{"Type":30,"Flags":0},"ForwardConfig":{"Type":31,"Flags":0},"Order":{"Type":3,"Flags":0},"RedirectConfig":{"Type":38,"Flags":0},"TargetGroupArn":{"Type":4,"Flags":0},"Type":{"Type":4,"Flags":1}}}},{"2":{"Name":"AuthenticateCognitoConfig","Properties":{"AuthenticationRequestExtraParams":{"Type":43,"Flags":0},"OnUnauthenticatedRequest":{"Type":4,"Flags":0},"Scope":{"Type":4,"Flags":0},"SessionCookieName":{"Type":4,"Flags":0},"SessionTimeout":{"Type":3,"Flags":0},"UserPoolArn":{"Type":4,"Flags":1},"UserPoolClientId":{"Type":4,"Flags":1},"UserPoolDomain":{"Type":4,"Flags":1}}}},{"2":{"Name":"AuthenticateOidcConfig","Properties":{"AuthenticationRequestExtraParams":{"Type":44,"Flags":0},"AuthorizationEndpoint":{"Type":4,"Flags":1},"ClientId":{"Type":4,"Flags":1},"ClientSecret":{"Type":4,"Flags":0},"Issuer":{"Type":4,"Flags":1},"OnUnauthenticatedRequest":{"Type":4,"Flags":0},"Scope":{"Type":4,"Flags":0},"SessionCookieName":{"Type":4,"Flags":0},"SessionTimeout":{"Type":3,"Flags":0},"TokenEndpoint":{"Type":4,"Flags":1},"UseExistingClientSecret":{"Type":2,"Flags":0},"UserInfoEndpoint":{"Type":4,"Flags":1}}}},{"2":{"Name":"FixedResponseConfig","Properties":{"ContentType":{"Type":4,"Flags":0},"MessageBody":{"Type":4,"Flags":0},"StatusCode":{"Type":4,"Flags":1}}}},{"2":{"Name":"ForwardConfig","Properties":{"TargetGroupStickinessConfig":{"Type":41,"Flags":0},"TargetGroups":{"Type":45,"Flags":0}}}},{"2":{"Name":"HostHeaderConfig","Properties":{"Values":{"Type":46,"Flags":0}}}},{"2":{"Name":"HttpHeaderConfig","Properties":{"HttpHeaderName":{"Type":4,"Flags":0},"Values":{"Type":47,"Flags":0}}}},{"2":{"Name":"HttpRequestMethodConfig","Properties":{"Values":{"Type":48,"Flags":0}}}},{"2":{"Name":"PathPatternConfig","Properties":{"Values":{"Type":49,"Flags":0}}}},{"2":{"Name":"QueryStringConfig","Properties":{"Values":{"Type":50,"Flags":0}}}},{"2":{"Name":"QueryStringKeyValue","Properties":{"Key":{"Type":4,"Flags":0},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"RedirectConfig","Properties":{"Host":{"Type":4,"Flags":0},"Path":{"Type":4,"Flags":0},"Port":{"Type":4,"Flags":0},"Protocol":{"Type":4,"Flags":0},"Query":{"Type":4,"Flags":0},"StatusCode":{"Type":4,"Flags":1}}}},{"2":{"Name":"RuleCondition","Properties":{"Field":{"Type":4,"Flags":0},"HostHeaderConfig":{"Type":32,"Flags":0},"HttpHeaderConfig":{"Type":33,"Flags":0},"HttpRequestMethodConfig":{"Type":34,"Flags":0},"PathPatternConfig":{"Type":35,"Flags":0},"QueryStringConfig":{"Type":36,"Flags":0},"SourceIpConfig":{"Type":40,"Flags":0},"Values":{"Type":51,"Flags":0}}}},{"2":{"Name":"SourceIpConfig","Properties":{"Values":{"Type":52,"Flags":0}}}},{"2":{"Name":"TargetGroupStickinessConfig","Properties":{"DurationSeconds":{"Type":3,"Flags":0},"Enabled":{"Type":2,"Flags":0}}}},{"2":{"Name":"TargetGroupTuple","Properties":{"TargetGroupArn":{"Type":4,"Flags":0},"Weight":{"Type":3,"Flags":0}}}},{"2":{"Name":"ListenerRule_AuthenticationRequestExtraParams","Properties":{}}},{"2":{"Name":"ListenerRule_AuthenticationRequestExtraParams","Properties":{}}},{"3":{"ItemType":42}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":37}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.ElasticLoadBalancingV2/ListenerRuleProperties","Properties":{"Actions":{"Type":54,"Flags":5},"Conditions":{"Type":55,"Flags":1},"IsDefault":{"Type":2,"Flags":2},"ListenerArn":{"Type":4,"Flags":4},"Priority":{"Type":3,"Flags":1},"RuleArn":{"Type":4,"Flags":18}}}},{"3":{"ItemType":27}},{"3":{"ItemType":39}},{"2":{"Name":"AWS.ElasticLoadBalancingV2/ListenerRule","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":53,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ElasticLoadBalancingV2/ListenerRule@default","ScopeType":0,"Body":56}},{"2":{"Name":"LoadBalancerAttribute","Properties":{"Key":{"Type":4,"Flags":0},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"SubnetMapping","Properties":{"AllocationId":{"Type":4,"Flags":0},"IPv6Address":{"Type":4,"Flags":0},"PrivateIPv4Address":{"Type":4,"Flags":0},"SubnetId":{"Type":4,"Flags":1}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"AWS.ElasticLoadBalancingV2/LoadBalancerProperties","Properties":{"CanonicalHostedZoneID":{"Type":4,"Flags":2,"Description":"The ID of the Amazon Route 53 hosted zone associated with the load balancer."},"DNSName":{"Type":4,"Flags":2,"Description":"The public DNS name of the load balancer."},"IpAddressType":{"Type":4,"Flags":0,"Description":"The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses)."},"LoadBalancerArn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN) of the load balancer."},"LoadBalancerAttributes":{"Type":62,"Flags":0,"Description":"The load balancer attributes."},"LoadBalancerFullName":{"Type":4,"Flags":2,"Description":"The full name of the load balancer."},"LoadBalancerName":{"Type":4,"Flags":2,"Description":"The name of the load balancer."},"Name":{"Type":4,"Flags":0,"Description":"The name of the load balancer."},"Scheme":{"Type":4,"Flags":0,"Description":"The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet. The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer. The default is an Internet-facing load balancer."},"SecurityGroups":{"Type":63,"Flags":0,"Description":"The IDs of the security groups for the load balancer."},"SubnetMappings":{"Type":64,"Flags":0,"Description":"The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both."},"Subnets":{"Type":65,"Flags":0,"Description":"The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. To specify an Elastic IP address, specify subnet mappings instead of subnets."},"Tags":{"Type":66,"Flags":0,"Description":"The tags to assign to the load balancer."},"Type":{"Type":4,"Flags":0,"Description":"The type of load balancer. The default is application."}}}},{"3":{"ItemType":58}},{"3":{"ItemType":4}},{"3":{"ItemType":59}},{"3":{"ItemType":4}},{"3":{"ItemType":60}},{"2":{"Name":"AWS.ElasticLoadBalancingV2/LoadBalancer","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":61,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ElasticLoadBalancingV2/LoadBalancer@default","ScopeType":0,"Body":67}},{"2":{"Name":"Matcher","Properties":{"GrpcCode":{"Type":4,"Flags":0,"Description":"You can specify values between 0 and 99. You can specify multiple values, or a range of values. The default value is 12."},"HttpCode":{"Type":4,"Flags":0,"Description":"For Application Load Balancers, you can specify values between 200 and 499, and the default value is 200. You can specify multiple values or a range of values. "}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The value for the tag. "},"Value":{"Type":4,"Flags":1,"Description":"The key name of the tag. "}}}},{"2":{"Name":"TargetDescription","Properties":{"AvailabilityZone":{"Type":4,"Flags":0,"Description":"An Availability Zone or all. This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer."},"Id":{"Type":4,"Flags":1,"Description":"The ID of the target. If the target type of the target group is instance, specify an instance ID. If the target type is ip, specify an IP address. If the target type is lambda, specify the ARN of the Lambda function. If the target type is alb, specify the ARN of the Application Load Balancer target. "},"Port":{"Type":3,"Flags":0,"Description":"The port on which the target is listening. If the target group protocol is GENEVE, the supported port is 6081. If the target type is alb, the targeted Application Load Balancer must have at least one listener whose port matches the target group port. Not used if the target is a Lambda function."}}}},{"2":{"Name":"TargetGroupAttribute","Properties":{"Key":{"Type":4,"Flags":0,"Description":"The value of the attribute."},"Value":{"Type":4,"Flags":0,"Description":"The name of the attribute."}}}},{"2":{"Name":"AWS.ElasticLoadBalancingV2/TargetGroupProperties","Properties":{"HealthCheckEnabled":{"Type":2,"Flags":0,"Description":"Indicates whether health checks are enabled. If the target type is lambda, health checks are disabled by default but can be enabled. If the target type is instance, ip, or alb, health checks are always enabled and cannot be disabled."},"HealthCheckIntervalSeconds":{"Type":3,"Flags":0,"Description":"The approximate amount of time, in seconds, between health checks of an individual target."},"HealthCheckPath":{"Type":4,"Flags":0,"Description":"[HTTP/HTTPS health checks] The destination for health checks on the targets. [HTTP1 or HTTP2 protocol version] The ping path. The default is /. [GRPC protocol version] The path of a custom health check method with the format /package.service/method. The default is /AWS.ALB/healthcheck."},"HealthCheckPort":{"Type":4,"Flags":0,"Description":"The port the load balancer uses when performing health checks on targets. "},"HealthCheckProtocol":{"Type":4,"Flags":0,"Description":"The protocol the load balancer uses when performing health checks on targets. "},"HealthCheckTimeoutSeconds":{"Type":3,"Flags":0,"Description":"The amount of time, in seconds, during which no response from a target means a failed health check."},"HealthyThresholdCount":{"Type":3,"Flags":0,"Description":"The number of consecutive health checks successes required before considering an unhealthy target healthy. "},"IpAddressType":{"Type":4,"Flags":0,"Description":"The type of IP address used for this target group. The possible values are ipv4 and ipv6. "},"LoadBalancerArns":{"Type":74,"Flags":2,"Description":"The Amazon Resource Names (ARNs) of the load balancers that route traffic to this target group."},"Matcher":{"Type":69,"Flags":0,"Description":"[HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target."},"Name":{"Type":4,"Flags":0,"Description":"The name of the target group."},"Port":{"Type":3,"Flags":0,"Description":"The port on which the targets receive traffic. This port is used unless you specify a port override when registering the target. If the target is a Lambda function, this parameter does not apply. If the protocol is GENEVE, the supported port is 6081."},"Protocol":{"Type":4,"Flags":0,"Description":"The protocol to use for routing traffic to the targets."},"ProtocolVersion":{"Type":4,"Flags":0,"Description":"[HTTP/HTTPS protocol] The protocol version. The possible values are GRPC, HTTP1, and HTTP2."},"Tags":{"Type":75,"Flags":0,"Description":"The tags."},"TargetGroupArn":{"Type":4,"Flags":18,"Description":"The ARN of the Target Group"},"TargetGroupAttributes":{"Type":76,"Flags":0,"Description":"The attributes."},"TargetGroupFullName":{"Type":4,"Flags":2,"Description":"The full name of the target group."},"TargetGroupName":{"Type":4,"Flags":2,"Description":"The name of the target group."},"TargetType":{"Type":4,"Flags":0,"Description":"The type of target that you must specify when registering targets with this target group. You can't specify targets for a target group using more than one target type."},"Targets":{"Type":77,"Flags":0,"Description":"The targets."},"UnhealthyThresholdCount":{"Type":3,"Flags":0,"Description":"The number of consecutive health check failures required before considering a target unhealthy."},"VpcId":{"Type":4,"Flags":0,"Description":"The identifier of the virtual private cloud (VPC). If the target is a Lambda function, this parameter does not apply."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":70}},{"3":{"ItemType":72}},{"3":{"ItemType":71}},{"2":{"Name":"AWS.ElasticLoadBalancingV2/TargetGroup","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":73,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ElasticLoadBalancingV2/TargetGroup@default","ScopeType":0,"Body":78}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.ElasticLoadBalancingV2/TrustStoreProperties","Properties":{"CaCertificatesBundleS3Bucket":{"Type":4,"Flags":4,"Description":"The name of the S3 bucket to fetch the CA certificate bundle from."},"CaCertificatesBundleS3Key":{"Type":4,"Flags":4,"Description":"The name of the S3 object to fetch the CA certificate bundle from."},"CaCertificatesBundleS3ObjectVersion":{"Type":4,"Flags":4,"Description":"The version of the S3 bucket that contains the CA certificate bundle."},"Name":{"Type":4,"Flags":0,"Description":"The name of the trust store."},"NumberOfCaCertificates":{"Type":3,"Flags":2,"Description":"The number of certificates associated with the trust store."},"Status":{"Type":4,"Flags":2,"Description":"The status of the trust store, could be either of ACTIVE or CREATING."},"Tags":{"Type":82,"Flags":0,"Description":"The tags to assign to the trust store."},"TrustStoreArn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN) of the trust store."}}}},{"3":{"ItemType":80}},{"2":{"Name":"AWS.ElasticLoadBalancingV2/TrustStore","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":81,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ElasticLoadBalancingV2/TrustStore@default","ScopeType":0,"Body":83}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Action", + "properties": { + "AuthenticateCognitoConfig": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "[HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when ``Type`` is ``authenticate-cognito``." + }, + "AuthenticateOidcConfig": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "[HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when ``Type`` is ``authenticate-oidc``." + }, + "FixedResponseConfig": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "[Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when ``Type`` is ``fixed-response``." + }, + "ForwardConfig": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when ``Type`` is ``forward``. If you specify both ``ForwardConfig`` and ``TargetGroupArn``, you can specify only one target group using ``ForwardConfig`` and it must be the same target group specified in ``TargetGroupArn``." + }, + "Order": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first." + }, + "RedirectConfig": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "[Application Load Balancer] Information for creating a redirect action. Specify only when ``Type`` is ``redirect``." + }, + "TargetGroupArn": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the target group. Specify only when ``Type`` is ``forward`` and you want to route to a single target group. To route to one or more target groups, use ``ForwardConfig`` instead." + }, + "Type": { + "type": { + "$ref": "#/11" + }, + "flags": 1, + "description": "The type of action." + } + } + }, + { + "$type": "ObjectType", + "name": "AuthenticateCognitoConfig", + "properties": { + "AuthenticationRequestExtraParams": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "The query parameters (up to 10) to include in the redirect request to the authorization endpoint." + }, + "OnUnauthenticatedRequest": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The behavior if the user is not authenticated. The following are possible values:\n + deny```` - Return an HTTP 401 Unauthorized error.\n + allow```` - Allow the request to be forwarded to the target.\n + authenticate```` - Redirect the request to the IdP authorization endpoint. This is the default value." + }, + "Scope": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The set of user claims to be requested from the IdP. The default is ``openid``.\n To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP." + }, + "SessionCookieName": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie." + }, + "SessionTimeout": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days)." + }, + "UserPoolArn": { + "type": { + "$ref": "#/11" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of the Amazon Cognito user pool." + }, + "UserPoolClientId": { + "type": { + "$ref": "#/11" + }, + "flags": 1, + "description": "The ID of the Amazon Cognito user pool client." + }, + "UserPoolDomain": { + "type": { + "$ref": "#/11" + }, + "flags": 1, + "description": "The domain prefix or fully-qualified domain name of the Amazon Cognito user pool." + } + } + }, + { + "$type": "ObjectType", + "name": "AuthenticateOidcConfig", + "properties": { + "AuthenticationRequestExtraParams": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "The query parameters (up to 10) to include in the redirect request to the authorization endpoint." + }, + "AuthorizationEndpoint": { + "type": { + "$ref": "#/11" + }, + "flags": 1, + "description": "The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path." + }, + "ClientId": { + "type": { + "$ref": "#/11" + }, + "flags": 1, + "description": "The OAuth 2.0 client identifier." + }, + "ClientSecret": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you are modifying a rule, you can omit this parameter if you set ``UseExistingClientSecret`` to true." + }, + "Issuer": { + "type": { + "$ref": "#/11" + }, + "flags": 1, + "description": "The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path." + }, + "OnUnauthenticatedRequest": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The behavior if the user is not authenticated. The following are possible values:\n + deny```` - Return an HTTP 401 Unauthorized error.\n + allow```` - Allow the request to be forwarded to the target.\n + authenticate```` - Redirect the request to the IdP authorization endpoint. This is the default value." + }, + "Scope": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The set of user claims to be requested from the IdP. The default is ``openid``.\n To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP." + }, + "SessionCookieName": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie." + }, + "SessionTimeout": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days)." + }, + "TokenEndpoint": { + "type": { + "$ref": "#/11" + }, + "flags": 1, + "description": "The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path." + }, + "UseExistingClientSecret": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "Indicates whether to use the existing client secret when modifying a rule. If you are creating a rule, you can omit this parameter or set it to false." + }, + "UserInfoEndpoint": { + "type": { + "$ref": "#/11" + }, + "flags": 1, + "description": "The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path." + } + } + }, + { + "$type": "ObjectType", + "name": "Certificate", + "properties": { + "CertificateArn": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the certificate." + } + } + }, + { + "$type": "ObjectType", + "name": "FixedResponseConfig", + "properties": { + "ContentType": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The content type.\n Valid Values: text/plain | text/css | text/html | application/javascript | application/json" + }, + "MessageBody": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The message." + }, + "StatusCode": { + "type": { + "$ref": "#/11" + }, + "flags": 1, + "description": "The HTTP response code (2XX, 4XX, or 5XX)." + } + } + }, + { + "$type": "ObjectType", + "name": "ForwardConfig", + "properties": { + "TargetGroupStickinessConfig": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "Information about the target group stickiness for a rule." + }, + "TargetGroups": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "Information about how traffic will be distributed between multiple target groups in a forward rule." + } + } + }, + { + "$type": "ObjectType", + "name": "MutualAuthentication", + "properties": { + "IgnoreClientCertificateExpiry": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "Indicates whether expired client certificates are ignored." + }, + "Mode": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The client certificate handling method. Options are ``off``, ``passthrough`` or ``verify``. The default value is ``off``." + }, + "TrustStoreArn": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the trust store." + } + } + }, + { + "$type": "ObjectType", + "name": "RedirectConfig", + "properties": { + "Host": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The hostname. This component is not percent-encoded. The hostname can contain #{host}." + }, + "Path": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The absolute path, starting with the leading \"/\". This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}." + }, + "Port": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The port. You can specify a value from 1 to 65535 or #{port}." + }, + "Protocol": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP, HTTP to HTTPS, and HTTPS to HTTPS. You cannot redirect HTTPS to HTTP." + }, + "Query": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The query parameters, URL-encoded when necessary, but not percent-encoded. Do not include the leading \"?\", as it is automatically added. You can specify any of the reserved keywords." + }, + "StatusCode": { + "type": { + "$ref": "#/11" + }, + "flags": 1, + "description": "The HTTP redirect code. The redirect is either permanent (HTTP 301) or temporary (HTTP 302)." + } + } + }, + { + "$type": "ObjectType", + "name": "TargetGroupStickinessConfig", + "properties": { + "DurationSeconds": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The time period, in seconds, during which requests from a client should be routed to the same target group. The range is 1-604800 seconds (7 days)." + }, + "Enabled": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "Indicates whether target group stickiness is enabled." + } + } + }, + { + "$type": "ObjectType", + "name": "TargetGroupTuple", + "properties": { + "TargetGroupArn": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the target group." + }, + "Weight": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The weight. The range is 0 to 999." + } + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "StringType" + }, + { + "$type": "ObjectType", + "name": "Listener_AuthenticationRequestExtraParams", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Listener_AuthenticationRequestExtraParams", + "properties": {} + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/9" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.ElasticLoadBalancingV2/ListenerProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/11" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ObjectType", + "name": "AWS.ElasticLoadBalancingV2/ListenerProperties", + "properties": { + "AlpnPolicy": { + "type": { + "$ref": "#/17" + }, + "flags": 0, + "description": "[TLS listener] The name of the Application-Layer Protocol Negotiation (ALPN) policy." + }, + "Certificates": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "The default SSL server certificate for a secure listener. You must provide exactly one certificate if the listener protocol is HTTPS or TLS.\n To 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)." + }, + "DefaultActions": { + "type": { + "$ref": "#/19" + }, + "flags": 5, + "description": "The actions for the default rule. You cannot define a condition for a default rule.\n To 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)." + }, + "ListenerArn": { + "type": { + "$ref": "#/11" + }, + "flags": 18, + "description": "" + }, + "LoadBalancerArn": { + "type": { + "$ref": "#/11" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of the load balancer." + }, + "MutualAuthentication": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "The mutual authentication configuration information." + }, + "Port": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The port on which the load balancer is listening. You cannot specify a port for a Gateway Load Balancer." + }, + "Protocol": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The protocol for connections from clients to the load balancer. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP, TLS, UDP, and TCP_UDP. You can’t specify the UDP or TCP_UDP protocol if dual-stack mode is enabled. You cannot specify a protocol for a Gateway Load Balancer." + }, + "SslPolicy": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "[HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are supported.\n Updating the security policy can result in interruptions if the load balancer is handling a high volume of traffic.\n For more information, see [Security policies](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html#describe-ssl-policies) in the *Application Load Balancers Guide* and [Security policies](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html#describe-ssl-policies) in the *Network Load Balancers Guide*." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ElasticLoadBalancingV2/Listener", + "properties": { + "name": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/11" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/20" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ElasticLoadBalancingV2/Listener@default", + "scopeType": 0, + "body": { + "$ref": "#/21" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Action", + "properties": { + "AuthenticateCognitoConfig": { + "type": { + "$ref": "#/24" + }, + "flags": 0, + "description": "[HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when ``Type`` is ``authenticate-cognito``." + }, + "AuthenticateOidcConfig": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "[HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when ``Type`` is ``authenticate-oidc``." + }, + "FixedResponseConfig": { + "type": { + "$ref": "#/26" + }, + "flags": 0, + "description": "[Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when ``Type`` is ``fixed-response``." + }, + "ForwardConfig": { + "type": { + "$ref": "#/27" + }, + "flags": 0, + "description": "Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when ``Type`` is ``forward``. If you specify both ``ForwardConfig`` and ``TargetGroupArn``, you can specify only one target group using ``ForwardConfig`` and it must be the same target group specified in ``TargetGroupArn``." + }, + "Order": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first." + }, + "RedirectConfig": { + "type": { + "$ref": "#/34" + }, + "flags": 0, + "description": "[Application Load Balancer] Information for creating a redirect action. Specify only when ``Type`` is ``redirect``." + }, + "TargetGroupArn": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the target group. Specify only when ``Type`` is ``forward`` and you want to route to a single target group. To route to one or more target groups, use ``ForwardConfig`` instead." + }, + "Type": { + "type": { + "$ref": "#/11" + }, + "flags": 1, + "description": "The type of action." + } + } + }, + { + "$type": "ObjectType", + "name": "AuthenticateCognitoConfig", + "properties": { + "AuthenticationRequestExtraParams": { + "type": { + "$ref": "#/39" + }, + "flags": 0, + "description": "The query parameters (up to 10) to include in the redirect request to the authorization endpoint." + }, + "OnUnauthenticatedRequest": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The behavior if the user is not authenticated. The following are possible values:\n + deny```` - Return an HTTP 401 Unauthorized error.\n + allow```` - Allow the request to be forwarded to the target.\n + authenticate```` - Redirect the request to the IdP authorization endpoint. This is the default value." + }, + "Scope": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The set of user claims to be requested from the IdP. The default is ``openid``.\n To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP." + }, + "SessionCookieName": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie." + }, + "SessionTimeout": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days)." + }, + "UserPoolArn": { + "type": { + "$ref": "#/11" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of the Amazon Cognito user pool." + }, + "UserPoolClientId": { + "type": { + "$ref": "#/11" + }, + "flags": 1, + "description": "The ID of the Amazon Cognito user pool client." + }, + "UserPoolDomain": { + "type": { + "$ref": "#/11" + }, + "flags": 1, + "description": "The domain prefix or fully-qualified domain name of the Amazon Cognito user pool." + } + } + }, + { + "$type": "ObjectType", + "name": "AuthenticateOidcConfig", + "properties": { + "AuthenticationRequestExtraParams": { + "type": { + "$ref": "#/40" + }, + "flags": 0, + "description": "The query parameters (up to 10) to include in the redirect request to the authorization endpoint." + }, + "AuthorizationEndpoint": { + "type": { + "$ref": "#/11" + }, + "flags": 1, + "description": "The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path." + }, + "ClientId": { + "type": { + "$ref": "#/11" + }, + "flags": 1, + "description": "The OAuth 2.0 client identifier." + }, + "ClientSecret": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you are modifying a rule, you can omit this parameter if you set ``UseExistingClientSecret`` to true." + }, + "Issuer": { + "type": { + "$ref": "#/11" + }, + "flags": 1, + "description": "The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path." + }, + "OnUnauthenticatedRequest": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The behavior if the user is not authenticated. The following are possible values:\n + deny```` - Return an HTTP 401 Unauthorized error.\n + allow```` - Allow the request to be forwarded to the target.\n + authenticate```` - Redirect the request to the IdP authorization endpoint. This is the default value." + }, + "Scope": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The set of user claims to be requested from the IdP. The default is ``openid``.\n To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP." + }, + "SessionCookieName": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie." + }, + "SessionTimeout": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days)." + }, + "TokenEndpoint": { + "type": { + "$ref": "#/11" + }, + "flags": 1, + "description": "The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path." + }, + "UseExistingClientSecret": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "Indicates whether to use the existing client secret when modifying a rule. If you are creating a rule, you can omit this parameter or set it to false." + }, + "UserInfoEndpoint": { + "type": { + "$ref": "#/11" + }, + "flags": 1, + "description": "The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path." + } + } + }, + { + "$type": "ObjectType", + "name": "FixedResponseConfig", + "properties": { + "ContentType": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The content type.\n Valid Values: text/plain | text/css | text/html | application/javascript | application/json" + }, + "MessageBody": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The message." + }, + "StatusCode": { + "type": { + "$ref": "#/11" + }, + "flags": 1, + "description": "The HTTP response code (2XX, 4XX, or 5XX)." + } + } + }, + { + "$type": "ObjectType", + "name": "ForwardConfig", + "properties": { + "TargetGroupStickinessConfig": { + "type": { + "$ref": "#/37" + }, + "flags": 0, + "description": "Information about the target group stickiness for a rule." + }, + "TargetGroups": { + "type": { + "$ref": "#/41" + }, + "flags": 0, + "description": "Information about how traffic will be distributed between multiple target groups in a forward rule." + } + } + }, + { + "$type": "ObjectType", + "name": "HostHeaderConfig", + "properties": { + "Values": { + "type": { + "$ref": "#/42" + }, + "flags": 0, + "description": "The host names. The maximum size of each name is 128 characters. The comparison is case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).\n If you specify multiple strings, the condition is satisfied if one of the strings matches the host name." + } + } + }, + { + "$type": "ObjectType", + "name": "HttpHeaderConfig", + "properties": { + "HttpHeaderName": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The name of the HTTP header field. The maximum size is 40 characters. The header name is case insensitive. The allowed characters are specified by RFC 7230. Wildcards are not supported." + }, + "Values": { + "type": { + "$ref": "#/43" + }, + "flags": 0, + "description": "The strings to compare against the value of the HTTP header. The maximum size of each string is 128 characters. The comparison strings are case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).\n If the same header appears multiple times in the request, we search them in order until a match is found.\n If you specify multiple strings, the condition is satisfied if one of the strings matches the value of the HTTP header. To require that all of the strings are a match, create one condition per string." + } + } + }, + { + "$type": "ObjectType", + "name": "HttpRequestMethodConfig", + "properties": { + "Values": { + "type": { + "$ref": "#/44" + }, + "flags": 0, + "description": "The name of the request method. The maximum size is 40 characters. The allowed characters are A-Z, hyphen (-), and underscore (_). The comparison is case sensitive. Wildcards are not supported; therefore, the method name must be an exact match.\n If you specify multiple strings, the condition is satisfied if one of the strings matches the HTTP request method. We recommend that you route GET and HEAD requests in the same way, because the response to a HEAD request may be cached." + } + } + }, + { + "$type": "ObjectType", + "name": "PathPatternConfig", + "properties": { + "Values": { + "type": { + "$ref": "#/45" + }, + "flags": 0, + "description": "The path patterns to compare against the request URL. The maximum size of each string is 128 characters. The comparison is case sensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).\n If you specify multiple strings, the condition is satisfied if one of them matches the request URL. The path pattern is compared only to the path of the URL, not to its query string." + } + } + }, + { + "$type": "ObjectType", + "name": "QueryStringConfig", + "properties": { + "Values": { + "type": { + "$ref": "#/46" + }, + "flags": 0, + "description": "The key/value pairs or values to find in the query string. The maximum size of each string is 128 characters. The comparison is case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character). To search for a literal '*' or '?' character in a query string, you must escape these characters in ``Values`` using a '\\' character.\n If you specify multiple key/value pairs or values, the condition is satisfied if one of them is found in the query string." + } + } + }, + { + "$type": "ObjectType", + "name": "QueryStringKeyValue", + "properties": { + "Key": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The key. You can omit the key." + }, + "Value": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The value." + } + } + }, + { + "$type": "ObjectType", + "name": "RedirectConfig", + "properties": { + "Host": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The hostname. This component is not percent-encoded. The hostname can contain #{host}." + }, + "Path": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The absolute path, starting with the leading \"/\". This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}." + }, + "Port": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The port. You can specify a value from 1 to 65535 or #{port}." + }, + "Protocol": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP, HTTP to HTTPS, and HTTPS to HTTPS. You cannot redirect HTTPS to HTTP." + }, + "Query": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The query parameters, URL-encoded when necessary, but not percent-encoded. Do not include the leading \"?\", as it is automatically added. You can specify any of the reserved keywords." + }, + "StatusCode": { + "type": { + "$ref": "#/11" + }, + "flags": 1, + "description": "The HTTP redirect code. The redirect is either permanent (HTTP 301) or temporary (HTTP 302)." + } + } + }, + { + "$type": "ObjectType", + "name": "RuleCondition", + "properties": { + "Field": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The 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``" + }, + "HostHeaderConfig": { + "type": { + "$ref": "#/28" + }, + "flags": 0, + "description": "Information for a host header condition. Specify only when ``Field`` is ``host-header``." + }, + "HttpHeaderConfig": { + "type": { + "$ref": "#/29" + }, + "flags": 0, + "description": "Information for an HTTP header condition. Specify only when ``Field`` is ``http-header``." + }, + "HttpRequestMethodConfig": { + "type": { + "$ref": "#/30" + }, + "flags": 0, + "description": "Information for an HTTP method condition. Specify only when ``Field`` is ``http-request-method``." + }, + "PathPatternConfig": { + "type": { + "$ref": "#/31" + }, + "flags": 0, + "description": "Information for a path pattern condition. Specify only when ``Field`` is ``path-pattern``." + }, + "QueryStringConfig": { + "type": { + "$ref": "#/32" + }, + "flags": 0, + "description": "Information for a query string condition. Specify only when ``Field`` is ``query-string``." + }, + "SourceIpConfig": { + "type": { + "$ref": "#/36" + }, + "flags": 0, + "description": "Information for a source IP condition. Specify only when ``Field`` is ``source-ip``." + }, + "Values": { + "type": { + "$ref": "#/47" + }, + "flags": 0, + "description": "The condition value. Specify only when ``Field`` is ``host-header`` or ``path-pattern``. Alternatively, to specify multiple host names or multiple path patterns, use ``HostHeaderConfig`` or ``PathPatternConfig``.\n If ``Field`` is ``host-header`` and you're not using ``HostHeaderConfig``, you can specify a single host name (for example, my.example.com). A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters.\n + A-Z, a-z, 0-9\n + - .\n + * (matches 0 or more characters)\n + ? (matches exactly 1 character)\n \n If ``Field`` is ``path-pattern`` and you're not using ``PathPatternConfig``, you can specify a single path pattern (for example, /img/*). A path pattern is case-sensitive, can be up to 128 characters in length, and can contain any of the following characters.\n + A-Z, a-z, 0-9\n + _ - . $ / ~ \" ' @ : +\n + & (using &)\n + * (matches 0 or more characters)\n + ? (matches exactly 1 character)" + } + } + }, + { + "$type": "ObjectType", + "name": "SourceIpConfig", + "properties": { + "Values": { + "type": { + "$ref": "#/48" + }, + "flags": 0, + "description": "The source IP addresses, in CIDR format. You can use both IPv4 and IPv6 addresses. Wildcards are not supported.\n If you specify multiple addresses, the condition is satisfied if the source IP address of the request matches one of the CIDR blocks. This condition is not satisfied by the addresses in the X-Forwarded-For header." + } + } + }, + { + "$type": "ObjectType", + "name": "TargetGroupStickinessConfig", + "properties": { + "DurationSeconds": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The time period, in seconds, during which requests from a client should be routed to the same target group. The range is 1-604800 seconds (7 days)." + }, + "Enabled": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "Indicates whether target group stickiness is enabled." + } + } + }, + { + "$type": "ObjectType", + "name": "TargetGroupTuple", + "properties": { + "TargetGroupArn": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the target group." + }, + "Weight": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The weight. The range is 0 to 999." + } + } + }, + { + "$type": "ObjectType", + "name": "ListenerRule_AuthenticationRequestExtraParams", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ListenerRule_AuthenticationRequestExtraParams", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/38" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/11" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/11" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/11" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/11" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/33" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/11" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/11" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.ElasticLoadBalancingV2/ListenerRuleProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/23" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/35" + } + }, + { + "$type": "ObjectType", + "name": "AWS.ElasticLoadBalancingV2/ListenerRuleProperties", + "properties": { + "Actions": { + "type": { + "$ref": "#/50" + }, + "flags": 5, + "description": "The actions.\n The rule must include exactly one of the following types of actions: ``forward``, ``fixed-response``, or ``redirect``, and it must be the last action to be performed. If the rule is for an HTTPS listener, it can also optionally include an authentication action." + }, + "Conditions": { + "type": { + "$ref": "#/51" + }, + "flags": 1, + "description": "The conditions.\n The rule can optionally include up to one of each of the following conditions: ``http-request-method``, ``host-header``, ``path-pattern``, and ``source-ip``. A rule can also optionally include one or more of each of the following conditions: ``http-header`` and ``query-string``." + }, + "IsDefault": { + "type": { + "$ref": "#/14" + }, + "flags": 2, + "description": "" + }, + "ListenerArn": { + "type": { + "$ref": "#/11" + }, + "flags": 4, + "description": "The Amazon Resource Name (ARN) of the listener." + }, + "Priority": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The rule priority. A listener can't have multiple rules with the same priority.\n If you try to reorder rules by updating their priorities, do not specify a new priority if an existing rule already uses this priority, as this can cause an error. If you need to reuse a priority with a different rule, you must remove it as a priority first, and then specify it in a subsequent update." + }, + "RuleArn": { + "type": { + "$ref": "#/11" + }, + "flags": 18, + "description": "" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ElasticLoadBalancingV2/ListenerRule", + "properties": { + "name": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/11" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/52" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ElasticLoadBalancingV2/ListenerRule@default", + "scopeType": 0, + "body": { + "$ref": "#/53" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "LoadBalancerAttribute", + "properties": { + "Key": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The name of the attribute.\n The following attributes are supported by all load balancers:\n + ``deletion_protection.enabled`` - Indicates whether deletion protection is enabled. The value is ``true`` or ``false``. The default is ``false``.\n + ``load_balancing.cross_zone.enabled`` - Indicates whether cross-zone load balancing is enabled. The possible values are ``true`` and ``false``. The default for Network Load Balancers and Gateway Load Balancers is ``false``. The default for Application Load Balancers is ``true``, and cannot be changed.\n \n The following attributes are supported by both Application Load Balancers and Network Load Balancers:\n + ``access_logs.s3.enabled`` - Indicates whether access logs are enabled. The value is ``true`` or ``false``. The default is ``false``.\n + ``access_logs.s3.bucket`` - The name of the S3 bucket for the access logs. This attribute is required if access logs are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket.\n + ``access_logs.s3.prefix`` - The prefix for the location in the S3 bucket for the access logs.\n + ``ipv6.deny_all_igw_traffic`` - Blocks internet gateway (IGW) access to the load balancer. It is set to ``false`` for internet-facing load balancers and ``true`` for internal load balancers, preventing unintended access to your internal load balancer through an internet gateway.\n \n The following attributes are supported by only Application Load Balancers:\n + ``idle_timeout.timeout_seconds`` - The idle timeout value, in seconds. The valid range is 1-4000 seconds. The default is 60 seconds.\n + ``client_keep_alive.seconds`` - The client keep alive value, in seconds. The valid range is 60-604800 seconds. The default is 3600 seconds.\n + ``connection_logs.s3.enabled`` - Indicates whether connection logs are enabled. The value is ``true`` or ``false``. The default is ``false``.\n + ``connection_logs.s3.bucket`` - The name of the S3 bucket for the connection logs. This attribute is required if connection logs are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket.\n + ``connection_logs.s3.prefix`` - The prefix for the location in the S3 bucket for the connection logs.\n + ``routing.http.desync_mitigation_mode`` - Determines how the load balancer handles requests that might pose a security risk to your application. The possible values are ``monitor``, ``defensive``, and ``strictest``. The default is ``defensive``.\n + ``routing.http.drop_invalid_header_fields.enabled`` - Indicates whether HTTP headers with invalid header fields are removed by the load balancer (``true``) or routed to targets (``false``). The default is ``false``.\n + ``routing.http.preserve_host_header.enabled`` - Indicates whether the Application Load Balancer should preserve the ``Host`` header in the HTTP request and send it to the target without any change. The possible values are ``true`` and ``false``. The default is ``false``.\n + ``routing.http.x_amzn_tls_version_and_cipher_suite.enabled`` - Indicates whether the two headers (``x-amzn-tls-version`` and ``x-amzn-tls-cipher-suite``), which contain information about the negotiated TLS version and cipher suite, are added to the client request before sending it to the target. The ``x-amzn-tls-version`` header has information about the TLS protocol version negotiated with the client, and the ``x-amzn-tls-cipher-suite`` header has information about the cipher suite negotiated with the client. Both headers are in OpenSSL format. The possible values for the attribute are ``true`` and ``false``. The default is ``false``.\n + ``routing.http.xff_client_port.enabled`` - Indicates whether the ``X-Forwarded-For`` header should preserve the source port that the client used to connect to the load balancer. The possible values are ``true`` and ``false``. The default is ``false``.\n + ``routing.http.xff_header_processing.mode`` - Enables you to modify, preserve, or remove the ``X-Forwarded-For`` header in the HTTP request before the Application Load Balancer sends the request to the target. The possible values are ``append``, ``preserve``, and ``remove``. The default is ``append``.\n + If the value is ``append``, the Application Load Balancer adds the client IP address (of the last hop) to the ``X-Forwarded-For`` header in the HTTP request before it sends it to targets.\n + If the value is ``preserve`` the Application Load Balancer preserves the ``X-Forwarded-For`` header in the HTTP request, and sends it to targets without any change.\n + If the value is ``remove``, the Application Load Balancer removes the ``X-Forwarded-For`` header in the HTTP request before it sends it to targets.\n \n + ``routing.http2.enabled`` - Indicates whether HTTP/2 is enabled. The possible values are ``true`` and ``false``. The default is ``true``. Elastic Load Balancing requires that message header names contain only alphanumeric characters and hyphens.\n + ``waf.fail_open.enabled`` - Indicates whether to allow a WAF-enabled load balancer to route requests to targets if it is unable to forward the request to AWS WAF. The possible values are ``true`` and ``false``. The default is ``false``.\n \n The following attributes are supported by only Network Load Balancers:\n + ``dns_record.client_routing_policy`` - Indicates how traffic is distributed among the load balancer Availability Zones. The possible values are ``availability_zone_affinity`` with 100 percent zonal affinity, ``partial_availability_zone_affinity`` with 85 percent zonal affinity, and ``any_availability_zone`` with 0 percent zonal affinity." + }, + "Value": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The value of the attribute." + } + } + }, + { + "$type": "ObjectType", + "name": "SubnetMapping", + "properties": { + "AllocationId": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "[Network Load Balancers] The allocation ID of the Elastic IP address for an internet-facing load balancer." + }, + "IPv6Address": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "[Network Load Balancers] The IPv6 address." + }, + "PrivateIPv4Address": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "[Network Load Balancers] The private IPv4 address for an internal load balancer." + }, + "SubnetId": { + "type": { + "$ref": "#/11" + }, + "flags": 1, + "description": "The ID of the subnet." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/11" + }, + "flags": 1, + "description": "The key of the tag." + }, + "Value": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The value of the tag." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.ElasticLoadBalancingV2/LoadBalancerProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/55" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/11" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/56" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/11" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/57" + } + }, + { + "$type": "ObjectType", + "name": "AWS.ElasticLoadBalancingV2/LoadBalancerProperties", + "properties": { + "CanonicalHostedZoneID": { + "type": { + "$ref": "#/11" + }, + "flags": 2, + "description": "" + }, + "DNSName": { + "type": { + "$ref": "#/11" + }, + "flags": 2, + "description": "" + }, + "EnforceSecurityGroupInboundRulesOnPrivateLinkTraffic": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "Indicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through privatelink." + }, + "IpAddressType": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "Note: Internal load balancers must use the ``ipv4`` IP address type.\n [Application Load Balancers] The IP address type. The possible values are ``ipv4`` (for only IPv4 addresses), ``dualstack`` (for IPv4 and IPv6 addresses), and ``dualstack-without-public-ipv4`` (for IPv6 only public addresses, with private IPv4 and IPv6 addresses).\n [Network Load Balancers] The IP address type. The possible values are ``ipv4`` (for only IPv4 addresses) and ``dualstack`` (for IPv4 and IPv6 addresses). You can’t specify ``dualstack`` for a load balancer with a UDP or TCP_UDP listener.\n [Gateway Load Balancers] The IP address type. The possible values are ``ipv4`` (for only IPv4 addresses) and ``dualstack`` (for IPv4 and IPv6 addresses)." + }, + "LoadBalancerArn": { + "type": { + "$ref": "#/11" + }, + "flags": 18, + "description": "" + }, + "LoadBalancerAttributes": { + "type": { + "$ref": "#/59" + }, + "flags": 0, + "description": "The load balancer attributes." + }, + "LoadBalancerFullName": { + "type": { + "$ref": "#/11" + }, + "flags": 2, + "description": "" + }, + "LoadBalancerName": { + "type": { + "$ref": "#/11" + }, + "flags": 2, + "description": "" + }, + "Name": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The name of the load balancer. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, must not begin or end with a hyphen, and must not begin with \"internal-\".\n If you don't specify a name, AWS CloudFormation generates a unique physical ID for the load balancer. If you specify a name, you cannot perform updates that require replacement of this resource, but you can perform other updates. To replace the resource, specify a new name." + }, + "Scheme": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet.\n The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer.\n The default is an Internet-facing load balancer.\n You cannot specify a scheme for a Gateway Load Balancer." + }, + "SecurityGroups": { + "type": { + "$ref": "#/60" + }, + "flags": 0, + "description": "[Application Load Balancers and Network Load Balancers] The IDs of the security groups for the load balancer." + }, + "SubnetMappings": { + "type": { + "$ref": "#/61" + }, + "flags": 0, + "description": "The IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both.\n [Application Load Balancers] You must specify subnets from at least two Availability Zones. You cannot 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 Zones.\n [Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet.\n [Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You cannot specify Elastic IP addresses for your subnets." + }, + "Subnets": { + "type": { + "$ref": "#/62" + }, + "flags": 0, + "description": "The IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. To specify an Elastic IP address, specify subnet mappings instead of subnets.\n [Application Load Balancers] You must specify subnets from at least two Availability Zones.\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 Zones.\n [Network Load Balancers] You can specify subnets from one or more Availability Zones.\n [Gateway Load Balancers] You can specify subnets from one or more Availability Zones." + }, + "Tags": { + "type": { + "$ref": "#/63" + }, + "flags": 0, + "description": "The tags to assign to the load balancer." + }, + "Type": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The type of load balancer. The default is ``application``." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ElasticLoadBalancingV2/LoadBalancer", + "properties": { + "name": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/11" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/64" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ElasticLoadBalancingV2/LoadBalancer@default", + "scopeType": 0, + "body": { + "$ref": "#/65" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Matcher", + "properties": { + "GrpcCode": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "You can specify values between 0 and 99. You can specify multiple values, or a range of values. The default value is 12." + }, + "HttpCode": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "For Application Load Balancers, you can specify values between 200 and 499, and the default value is 200. You can specify multiple values or a range of values. " + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/11" + }, + "flags": 1, + "description": "The value for the tag. " + }, + "Value": { + "type": { + "$ref": "#/11" + }, + "flags": 1, + "description": "The key name of the tag. " + } + } + }, + { + "$type": "ObjectType", + "name": "TargetDescription", + "properties": { + "AvailabilityZone": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "An Availability Zone or all. This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer." + }, + "Id": { + "type": { + "$ref": "#/11" + }, + "flags": 1, + "description": "The ID of the target. If the target type of the target group is instance, specify an instance ID. If the target type is ip, specify an IP address. If the target type is lambda, specify the ARN of the Lambda function. If the target type is alb, specify the ARN of the Application Load Balancer target. " + }, + "Port": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The port on which the target is listening. If the target group protocol is GENEVE, the supported port is 6081. If the target type is alb, the targeted Application Load Balancer must have at least one listener whose port matches the target group port. Not used if the target is a Lambda function." + } + } + }, + { + "$type": "ObjectType", + "name": "TargetGroupAttribute", + "properties": { + "Key": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The value of the attribute." + }, + "Value": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The name of the attribute." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.ElasticLoadBalancingV2/TargetGroupProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/11" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/68" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/70" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/69" + } + }, + { + "$type": "ObjectType", + "name": "AWS.ElasticLoadBalancingV2/TargetGroupProperties", + "properties": { + "HealthCheckEnabled": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "Indicates whether health checks are enabled. If the target type is lambda, health checks are disabled by default but can be enabled. If the target type is instance, ip, or alb, health checks are always enabled and cannot be disabled." + }, + "HealthCheckIntervalSeconds": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The approximate amount of time, in seconds, between health checks of an individual target." + }, + "HealthCheckPath": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "[HTTP/HTTPS health checks] The destination for health checks on the targets. [HTTP1 or HTTP2 protocol version] The ping path. The default is /. [GRPC protocol version] The path of a custom health check method with the format /package.service/method. The default is /AWS.ALB/healthcheck." + }, + "HealthCheckPort": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The port the load balancer uses when performing health checks on targets. " + }, + "HealthCheckProtocol": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The protocol the load balancer uses when performing health checks on targets. " + }, + "HealthCheckTimeoutSeconds": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The amount of time, in seconds, during which no response from a target means a failed health check." + }, + "HealthyThresholdCount": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The number of consecutive health checks successes required before considering an unhealthy target healthy. " + }, + "IpAddressType": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The type of IP address used for this target group. The possible values are ipv4 and ipv6. " + }, + "LoadBalancerArns": { + "type": { + "$ref": "#/72" + }, + "flags": 2, + "description": "The Amazon Resource Names (ARNs) of the load balancers that route traffic to this target group." + }, + "Matcher": { + "type": { + "$ref": "#/67" + }, + "flags": 0, + "description": "[HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target." + }, + "Name": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The name of the target group." + }, + "Port": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The port on which the targets receive traffic. This port is used unless you specify a port override when registering the target. If the target is a Lambda function, this parameter does not apply. If the protocol is GENEVE, the supported port is 6081." + }, + "Protocol": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The protocol to use for routing traffic to the targets." + }, + "ProtocolVersion": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "[HTTP/HTTPS protocol] The protocol version. The possible values are GRPC, HTTP1, and HTTP2." + }, + "Tags": { + "type": { + "$ref": "#/73" + }, + "flags": 0, + "description": "The tags." + }, + "TargetGroupArn": { + "type": { + "$ref": "#/11" + }, + "flags": 18, + "description": "The ARN of the Target Group" + }, + "TargetGroupAttributes": { + "type": { + "$ref": "#/74" + }, + "flags": 0, + "description": "The attributes." + }, + "TargetGroupFullName": { + "type": { + "$ref": "#/11" + }, + "flags": 2, + "description": "The full name of the target group." + }, + "TargetGroupName": { + "type": { + "$ref": "#/11" + }, + "flags": 2, + "description": "The name of the target group." + }, + "TargetType": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The type of target that you must specify when registering targets with this target group. You can't specify targets for a target group using more than one target type." + }, + "Targets": { + "type": { + "$ref": "#/75" + }, + "flags": 0, + "description": "The targets." + }, + "UnhealthyThresholdCount": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The number of consecutive health check failures required before considering a target unhealthy." + }, + "VpcId": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The identifier of the virtual private cloud (VPC). If the target is a Lambda function, this parameter does not apply." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ElasticLoadBalancingV2/TargetGroup", + "properties": { + "name": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/11" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/76" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ElasticLoadBalancingV2/TargetGroup@default", + "scopeType": 0, + "body": { + "$ref": "#/77" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/11" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/11" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.ElasticLoadBalancingV2/TrustStoreProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/79" + } + }, + { + "$type": "ObjectType", + "name": "AWS.ElasticLoadBalancingV2/TrustStoreProperties", + "properties": { + "CaCertificatesBundleS3Bucket": { + "type": { + "$ref": "#/11" + }, + "flags": 4, + "description": "The name of the S3 bucket to fetch the CA certificate bundle from." + }, + "CaCertificatesBundleS3Key": { + "type": { + "$ref": "#/11" + }, + "flags": 4, + "description": "The name of the S3 object to fetch the CA certificate bundle from." + }, + "CaCertificatesBundleS3ObjectVersion": { + "type": { + "$ref": "#/11" + }, + "flags": 4, + "description": "The version of the S3 bucket that contains the CA certificate bundle." + }, + "Name": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The name of the trust store." + }, + "NumberOfCaCertificates": { + "type": { + "$ref": "#/10" + }, + "flags": 2, + "description": "The number of certificates associated with the trust store." + }, + "Status": { + "type": { + "$ref": "#/11" + }, + "flags": 2, + "description": "The status of the trust store, could be either of ACTIVE or CREATING." + }, + "Tags": { + "type": { + "$ref": "#/81" + }, + "flags": 0, + "description": "The tags to assign to the trust store." + }, + "TrustStoreArn": { + "type": { + "$ref": "#/11" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) of the trust store." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ElasticLoadBalancingV2/TrustStore", + "properties": { + "name": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/11" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/82" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ElasticLoadBalancingV2/TrustStore@default", + "scopeType": 0, + "body": { + "$ref": "#/83" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.elasticloadbalancingv2/default/types.md b/artifacts/bicep/aws/aws.elasticloadbalancingv2/default/types.md index 567197c0..45ad643f 100644 --- a/artifacts/bicep/aws/aws.elasticloadbalancingv2/default/types.md +++ b/artifacts/bicep/aws/aws.elasticloadbalancingv2/default/types.md @@ -3,330 +3,420 @@ ## Resource AWS.ElasticLoadBalancingV2/Listener@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ElasticLoadBalancingV2/ListenerProperties](#awselasticloadbalancingv2listenerproperties) (Required): properties of the resource +* **properties**: [AWS.ElasticLoadBalancingV2/ListenerProperties](#awselasticloadbalancingv2listenerproperties) (Required, Identifier): properties of the resource ## Resource AWS.ElasticLoadBalancingV2/ListenerRule@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ElasticLoadBalancingV2/ListenerRuleProperties](#awselasticloadbalancingv2listenerruleproperties) (Required): properties of the resource +* **properties**: [AWS.ElasticLoadBalancingV2/ListenerRuleProperties](#awselasticloadbalancingv2listenerruleproperties) (Required, Identifier): properties of the resource ## Resource AWS.ElasticLoadBalancingV2/LoadBalancer@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ElasticLoadBalancingV2/LoadBalancerProperties](#awselasticloadbalancingv2loadbalancerproperties): properties of the resource +* **properties**: [AWS.ElasticLoadBalancingV2/LoadBalancerProperties](#awselasticloadbalancingv2loadbalancerproperties) (Identifier): properties of the resource ## Resource AWS.ElasticLoadBalancingV2/TargetGroup@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ElasticLoadBalancingV2/TargetGroupProperties](#awselasticloadbalancingv2targetgroupproperties): properties of the resource +* **properties**: [AWS.ElasticLoadBalancingV2/TargetGroupProperties](#awselasticloadbalancingv2targetgroupproperties) (Identifier): properties of the resource ## Resource AWS.ElasticLoadBalancingV2/TrustStore@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ElasticLoadBalancingV2/TrustStoreProperties](#awselasticloadbalancingv2truststoreproperties): properties of the resource +* **properties**: [AWS.ElasticLoadBalancingV2/TrustStoreProperties](#awselasticloadbalancingv2truststoreproperties) (Identifier): properties of the resource -## AWS.ElasticLoadBalancingV2/ListenerProperties -### Properties -* **AlpnPolicy**: string[] -* **Certificates**: [Certificate](#certificate)[] -* **DefaultActions**: [Action](#action)[] (Required, WriteOnly) -* **ListenerArn**: string (ReadOnly, Identifier) -* **LoadBalancerArn**: string (Required) -* **MutualAuthentication**: [MutualAuthentication](#mutualauthentication) -* **Port**: int -* **Protocol**: string -* **SslPolicy**: string - -## Certificate +## Action ### Properties -* **CertificateArn**: string +* **AuthenticateCognitoConfig**: [AuthenticateCognitoConfig](#authenticatecognitoconfig): [HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when ``Type`` is ``authenticate-cognito``. +* **AuthenticateOidcConfig**: [AuthenticateOidcConfig](#authenticateoidcconfig): [HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when ``Type`` is ``authenticate-oidc``. +* **FixedResponseConfig**: [FixedResponseConfig](#fixedresponseconfig): [Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when ``Type`` is ``fixed-response``. +* **ForwardConfig**: [ForwardConfig](#forwardconfig): Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when ``Type`` is ``forward``. If you specify both ``ForwardConfig`` and ``TargetGroupArn``, you can specify only one target group using ``ForwardConfig`` and it must be the same target group specified in ``TargetGroupArn``. +* **Order**: int: The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first. +* **RedirectConfig**: [RedirectConfig](#redirectconfig): [Application Load Balancer] Information for creating a redirect action. Specify only when ``Type`` is ``redirect``. +* **TargetGroupArn**: string: The Amazon Resource Name (ARN) of the target group. Specify only when ``Type`` is ``forward`` and you want to route to a single target group. To route to one or more target groups, use ``ForwardConfig`` instead. +* **Type**: string (Required): The type of action. ## Action ### Properties -* **AuthenticateCognitoConfig**: [AuthenticateCognitoConfig](#authenticatecognitoconfig) -* **AuthenticateOidcConfig**: [AuthenticateOidcConfig](#authenticateoidcconfig) -* **FixedResponseConfig**: [FixedResponseConfig](#fixedresponseconfig) -* **ForwardConfig**: [ForwardConfig](#forwardconfig) -* **Order**: int -* **RedirectConfig**: [RedirectConfig](#redirectconfig) -* **TargetGroupArn**: string -* **Type**: string (Required) +* **AuthenticateCognitoConfig**: [AuthenticateCognitoConfig](#authenticatecognitoconfig): [HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when ``Type`` is ``authenticate-cognito``. +* **AuthenticateOidcConfig**: [AuthenticateOidcConfig](#authenticateoidcconfig): [HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when ``Type`` is ``authenticate-oidc``. +* **FixedResponseConfig**: [FixedResponseConfig](#fixedresponseconfig): [Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when ``Type`` is ``fixed-response``. +* **ForwardConfig**: [ForwardConfig](#forwardconfig): Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when ``Type`` is ``forward``. If you specify both ``ForwardConfig`` and ``TargetGroupArn``, you can specify only one target group using ``ForwardConfig`` and it must be the same target group specified in ``TargetGroupArn``. +* **Order**: int: The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first. +* **RedirectConfig**: [RedirectConfig](#redirectconfig): [Application Load Balancer] Information for creating a redirect action. Specify only when ``Type`` is ``redirect``. +* **TargetGroupArn**: string: The Amazon Resource Name (ARN) of the target group. Specify only when ``Type`` is ``forward`` and you want to route to a single target group. To route to one or more target groups, use ``ForwardConfig`` instead. +* **Type**: string (Required): The type of action. ## AuthenticateCognitoConfig ### Properties -* **AuthenticationRequestExtraParams**: [Listener_AuthenticationRequestExtraParams](#listenerauthenticationrequestextraparams) -* **OnUnauthenticatedRequest**: string -* **Scope**: string -* **SessionCookieName**: string -* **SessionTimeout**: string -* **UserPoolArn**: string (Required) -* **UserPoolClientId**: string (Required) -* **UserPoolDomain**: string (Required) +* **AuthenticationRequestExtraParams**: [Listener_AuthenticationRequestExtraParams](#listenerauthenticationrequestextraparams): The query parameters (up to 10) to include in the redirect request to the authorization endpoint. +* **OnUnauthenticatedRequest**: string: The behavior if the user is not authenticated. The following are possible values: + + deny```` - Return an HTTP 401 Unauthorized error. + + allow```` - Allow the request to be forwarded to the target. + + authenticate```` - Redirect the request to the IdP authorization endpoint. This is the default value. +* **Scope**: string: The set of user claims to be requested from the IdP. The default is ``openid``. + To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP. +* **SessionCookieName**: string: The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie. +* **SessionTimeout**: string: The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days). +* **UserPoolArn**: string (Required): The Amazon Resource Name (ARN) of the Amazon Cognito user pool. +* **UserPoolClientId**: string (Required): The ID of the Amazon Cognito user pool client. +* **UserPoolDomain**: string (Required): The domain prefix or fully-qualified domain name of the Amazon Cognito user pool. -## Listener_AuthenticationRequestExtraParams +## AuthenticateCognitoConfig ### Properties +* **AuthenticationRequestExtraParams**: [ListenerRule_AuthenticationRequestExtraParams](#listenerruleauthenticationrequestextraparams): The query parameters (up to 10) to include in the redirect request to the authorization endpoint. +* **OnUnauthenticatedRequest**: string: The behavior if the user is not authenticated. The following are possible values: + + deny```` - Return an HTTP 401 Unauthorized error. + + allow```` - Allow the request to be forwarded to the target. + + authenticate```` - Redirect the request to the IdP authorization endpoint. This is the default value. +* **Scope**: string: The set of user claims to be requested from the IdP. The default is ``openid``. + To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP. +* **SessionCookieName**: string: The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie. +* **SessionTimeout**: int: The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days). +* **UserPoolArn**: string (Required): The Amazon Resource Name (ARN) of the Amazon Cognito user pool. +* **UserPoolClientId**: string (Required): The ID of the Amazon Cognito user pool client. +* **UserPoolDomain**: string (Required): The domain prefix or fully-qualified domain name of the Amazon Cognito user pool. ## AuthenticateOidcConfig ### Properties -* **AuthenticationRequestExtraParams**: [Listener_AuthenticationRequestExtraParams](#listenerauthenticationrequestextraparams) -* **AuthorizationEndpoint**: string (Required) -* **ClientId**: string (Required) -* **ClientSecret**: string -* **Issuer**: string (Required) -* **OnUnauthenticatedRequest**: string -* **Scope**: string -* **SessionCookieName**: string -* **SessionTimeout**: string -* **TokenEndpoint**: string (Required) -* **UseExistingClientSecret**: bool -* **UserInfoEndpoint**: string (Required) - -## Listener_AuthenticationRequestExtraParams -### Properties +* **AuthenticationRequestExtraParams**: [Listener_AuthenticationRequestExtraParams](#listenerauthenticationrequestextraparams): The query parameters (up to 10) to include in the redirect request to the authorization endpoint. +* **AuthorizationEndpoint**: string (Required): The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path. +* **ClientId**: string (Required): The OAuth 2.0 client identifier. +* **ClientSecret**: string: The OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you are modifying a rule, you can omit this parameter if you set ``UseExistingClientSecret`` to true. +* **Issuer**: string (Required): The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path. +* **OnUnauthenticatedRequest**: string: The behavior if the user is not authenticated. The following are possible values: + + deny```` - Return an HTTP 401 Unauthorized error. + + allow```` - Allow the request to be forwarded to the target. + + authenticate```` - Redirect the request to the IdP authorization endpoint. This is the default value. +* **Scope**: string: The set of user claims to be requested from the IdP. The default is ``openid``. + To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP. +* **SessionCookieName**: string: The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie. +* **SessionTimeout**: string: The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days). +* **TokenEndpoint**: string (Required): The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path. +* **UseExistingClientSecret**: bool: Indicates whether to use the existing client secret when modifying a rule. If you are creating a rule, you can omit this parameter or set it to false. +* **UserInfoEndpoint**: string (Required): The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path. -## FixedResponseConfig +## AuthenticateOidcConfig ### Properties -* **ContentType**: string -* **MessageBody**: string -* **StatusCode**: string (Required) +* **AuthenticationRequestExtraParams**: [ListenerRule_AuthenticationRequestExtraParams](#listenerruleauthenticationrequestextraparams): The query parameters (up to 10) to include in the redirect request to the authorization endpoint. +* **AuthorizationEndpoint**: string (Required): The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path. +* **ClientId**: string (Required): The OAuth 2.0 client identifier. +* **ClientSecret**: string: The OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you are modifying a rule, you can omit this parameter if you set ``UseExistingClientSecret`` to true. +* **Issuer**: string (Required): The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path. +* **OnUnauthenticatedRequest**: string: The behavior if the user is not authenticated. The following are possible values: + + deny```` - Return an HTTP 401 Unauthorized error. + + allow```` - Allow the request to be forwarded to the target. + + authenticate```` - Redirect the request to the IdP authorization endpoint. This is the default value. +* **Scope**: string: The set of user claims to be requested from the IdP. The default is ``openid``. + To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP. +* **SessionCookieName**: string: The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie. +* **SessionTimeout**: int: The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days). +* **TokenEndpoint**: string (Required): The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path. +* **UseExistingClientSecret**: bool: Indicates whether to use the existing client secret when modifying a rule. If you are creating a rule, you can omit this parameter or set it to false. +* **UserInfoEndpoint**: string (Required): The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path. -## ForwardConfig +## AWS.ElasticLoadBalancingV2/ListenerProperties ### Properties -* **TargetGroups**: [TargetGroupTuple](#targetgrouptuple)[] -* **TargetGroupStickinessConfig**: [TargetGroupStickinessConfig](#targetgroupstickinessconfig) +* **AlpnPolicy**: string[]: [TLS listener] The name of the Application-Layer Protocol Negotiation (ALPN) policy. +* **Certificates**: [Certificate](#certificate)[]: The default SSL server certificate for a secure listener. You must provide exactly one certificate if the listener protocol is HTTPS or TLS. + To 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). +* **DefaultActions**: [Action](#action)[] (Required, WriteOnly): The actions for the default rule. You cannot define a condition for a default rule. + To 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). +* **ListenerArn**: string (ReadOnly, Identifier) +* **LoadBalancerArn**: string (Required): The Amazon Resource Name (ARN) of the load balancer. +* **MutualAuthentication**: [MutualAuthentication](#mutualauthentication): The mutual authentication configuration information. +* **Port**: int: The port on which the load balancer is listening. You cannot specify a port for a Gateway Load Balancer. +* **Protocol**: string: The protocol for connections from clients to the load balancer. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP, TLS, UDP, and TCP_UDP. You can’t specify the UDP or TCP_UDP protocol if dual-stack mode is enabled. You cannot specify a protocol for a Gateway Load Balancer. +* **SslPolicy**: string: [HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are supported. + Updating the security policy can result in interruptions if the load balancer is handling a high volume of traffic. + For more information, see [Security policies](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html#describe-ssl-policies) in the *Application Load Balancers Guide* and [Security policies](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html#describe-ssl-policies) in the *Network Load Balancers Guide*. -## TargetGroupTuple +## AWS.ElasticLoadBalancingV2/ListenerRuleProperties ### Properties -* **TargetGroupArn**: string -* **Weight**: int +* **Actions**: [Action](#action)[] (Required, WriteOnly): The actions. + The rule must include exactly one of the following types of actions: ``forward``, ``fixed-response``, or ``redirect``, and it must be the last action to be performed. If the rule is for an HTTPS listener, it can also optionally include an authentication action. +* **Conditions**: [RuleCondition](#rulecondition)[] (Required): The conditions. + The rule can optionally include up to one of each of the following conditions: ``http-request-method``, ``host-header``, ``path-pattern``, and ``source-ip``. A rule can also optionally include one or more of each of the following conditions: ``http-header`` and ``query-string``. +* **IsDefault**: bool (ReadOnly) +* **ListenerArn**: string (WriteOnly): The Amazon Resource Name (ARN) of the listener. +* **Priority**: int (Required): The rule priority. A listener can't have multiple rules with the same priority. + If you try to reorder rules by updating their priorities, do not specify a new priority if an existing rule already uses this priority, as this can cause an error. If you need to reuse a priority with a different rule, you must remove it as a priority first, and then specify it in a subsequent update. +* **RuleArn**: string (ReadOnly, Identifier) -## TargetGroupStickinessConfig +## AWS.ElasticLoadBalancingV2/LoadBalancerProperties ### Properties -* **DurationSeconds**: int -* **Enabled**: bool +* **CanonicalHostedZoneID**: string (ReadOnly) +* **DNSName**: string (ReadOnly) +* **EnforceSecurityGroupInboundRulesOnPrivateLinkTraffic**: string: Indicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through privatelink. +* **IpAddressType**: string: Note: Internal load balancers must use the ``ipv4`` IP address type. + [Application Load Balancers] The IP address type. The possible values are ``ipv4`` (for only IPv4 addresses), ``dualstack`` (for IPv4 and IPv6 addresses), and ``dualstack-without-public-ipv4`` (for IPv6 only public addresses, with private IPv4 and IPv6 addresses). + [Network Load Balancers] The IP address type. The possible values are ``ipv4`` (for only IPv4 addresses) and ``dualstack`` (for IPv4 and IPv6 addresses). You can’t specify ``dualstack`` for a load balancer with a UDP or TCP_UDP listener. + [Gateway Load Balancers] The IP address type. The possible values are ``ipv4`` (for only IPv4 addresses) and ``dualstack`` (for IPv4 and IPv6 addresses). +* **LoadBalancerArn**: string (ReadOnly, Identifier) +* **LoadBalancerAttributes**: [LoadBalancerAttribute](#loadbalancerattribute)[]: The load balancer attributes. +* **LoadBalancerFullName**: string (ReadOnly) +* **LoadBalancerName**: string (ReadOnly) +* **Name**: string: The name of the load balancer. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, must not begin or end with a hyphen, and must not begin with "internal-". + If you don't specify a name, AWS CloudFormation generates a unique physical ID for the load balancer. If you specify a name, you cannot perform updates that require replacement of this resource, but you can perform other updates. To replace the resource, specify a new name. +* **Scheme**: string: The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet. + The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer. + The default is an Internet-facing load balancer. + You cannot specify a scheme for a Gateway Load Balancer. +* **SecurityGroups**: string[]: [Application Load Balancers and Network Load Balancers] The IDs of the security groups for the load balancer. +* **SubnetMappings**: [SubnetMapping](#subnetmapping)[]: The IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. + [Application Load Balancers] You must specify subnets from at least two Availability Zones. You cannot specify Elastic IP addresses for your subnets. + [Application Load Balancers on Outposts] You must specify one Outpost subnet. + [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones. + [Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet. + [Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You cannot specify Elastic IP addresses for your subnets. +* **Subnets**: string[]: The IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. To specify an Elastic IP address, specify subnet mappings instead of subnets. + [Application Load Balancers] You must specify subnets from at least two Availability Zones. + [Application Load Balancers on Outposts] You must specify one Outpost subnet. + [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones. + [Network Load Balancers] You can specify subnets from one or more Availability Zones. + [Gateway Load Balancers] You can specify subnets from one or more Availability Zones. +* **Tags**: [Tag](#tag)[]: The tags to assign to the load balancer. +* **Type**: string: The type of load balancer. The default is ``application``. -## RedirectConfig +## AWS.ElasticLoadBalancingV2/TargetGroupProperties ### Properties -* **Host**: string -* **Path**: string -* **Port**: string -* **Protocol**: string -* **Query**: string -* **StatusCode**: string (Required) +* **HealthCheckEnabled**: bool: Indicates whether health checks are enabled. If the target type is lambda, health checks are disabled by default but can be enabled. If the target type is instance, ip, or alb, health checks are always enabled and cannot be disabled. +* **HealthCheckIntervalSeconds**: int: The approximate amount of time, in seconds, between health checks of an individual target. +* **HealthCheckPath**: string: [HTTP/HTTPS health checks] The destination for health checks on the targets. [HTTP1 or HTTP2 protocol version] The ping path. The default is /. [GRPC protocol version] The path of a custom health check method with the format /package.service/method. The default is /AWS.ALB/healthcheck. +* **HealthCheckPort**: string: The port the load balancer uses when performing health checks on targets. +* **HealthCheckProtocol**: string: The protocol the load balancer uses when performing health checks on targets. +* **HealthCheckTimeoutSeconds**: int: The amount of time, in seconds, during which no response from a target means a failed health check. +* **HealthyThresholdCount**: int: The number of consecutive health checks successes required before considering an unhealthy target healthy. +* **IpAddressType**: string: The type of IP address used for this target group. The possible values are ipv4 and ipv6. +* **LoadBalancerArns**: string[] (ReadOnly): The Amazon Resource Names (ARNs) of the load balancers that route traffic to this target group. +* **Matcher**: [Matcher](#matcher): [HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target. +* **Name**: string: The name of the target group. +* **Port**: int: The port on which the targets receive traffic. This port is used unless you specify a port override when registering the target. If the target is a Lambda function, this parameter does not apply. If the protocol is GENEVE, the supported port is 6081. +* **Protocol**: string: The protocol to use for routing traffic to the targets. +* **ProtocolVersion**: string: [HTTP/HTTPS protocol] The protocol version. The possible values are GRPC, HTTP1, and HTTP2. +* **Tags**: [Tag](#tag)[]: The tags. +* **TargetGroupArn**: string (ReadOnly, Identifier): The ARN of the Target Group +* **TargetGroupAttributes**: [TargetGroupAttribute](#targetgroupattribute)[]: The attributes. +* **TargetGroupFullName**: string (ReadOnly): The full name of the target group. +* **TargetGroupName**: string (ReadOnly): The name of the target group. +* **Targets**: [TargetDescription](#targetdescription)[]: The targets. +* **TargetType**: string: The type of target that you must specify when registering targets with this target group. You can't specify targets for a target group using more than one target type. +* **UnhealthyThresholdCount**: int: The number of consecutive health check failures required before considering a target unhealthy. +* **VpcId**: string: The identifier of the virtual private cloud (VPC). If the target is a Lambda function, this parameter does not apply. -## MutualAuthentication +## AWS.ElasticLoadBalancingV2/TrustStoreProperties ### Properties -* **IgnoreClientCertificateExpiry**: bool -* **Mode**: string -* **TrustStoreArn**: string +* **CaCertificatesBundleS3Bucket**: string (WriteOnly): The name of the S3 bucket to fetch the CA certificate bundle from. +* **CaCertificatesBundleS3Key**: string (WriteOnly): The name of the S3 object to fetch the CA certificate bundle from. +* **CaCertificatesBundleS3ObjectVersion**: string (WriteOnly): The version of the S3 bucket that contains the CA certificate bundle. +* **Name**: string: The name of the trust store. +* **NumberOfCaCertificates**: int (ReadOnly): The number of certificates associated with the trust store. +* **Status**: string (ReadOnly): The status of the trust store, could be either of ACTIVE or CREATING. +* **Tags**: [Tag](#tag)[]: The tags to assign to the trust store. +* **TrustStoreArn**: string (ReadOnly, Identifier): The Amazon Resource Name (ARN) of the trust store. -## AWS.ElasticLoadBalancingV2/ListenerRuleProperties +## Certificate ### Properties -* **Actions**: [Action](#action)[] (Required, WriteOnly) -* **Conditions**: [RuleCondition](#rulecondition)[] (Required) -* **IsDefault**: bool (ReadOnly) -* **ListenerArn**: string (WriteOnly) -* **Priority**: int (Required) -* **RuleArn**: string (ReadOnly, Identifier) +* **CertificateArn**: string: The Amazon Resource Name (ARN) of the certificate. -## Action +## FixedResponseConfig ### Properties -* **AuthenticateCognitoConfig**: [AuthenticateCognitoConfig](#authenticatecognitoconfig) -* **AuthenticateOidcConfig**: [AuthenticateOidcConfig](#authenticateoidcconfig) -* **FixedResponseConfig**: [FixedResponseConfig](#fixedresponseconfig) -* **ForwardConfig**: [ForwardConfig](#forwardconfig) -* **Order**: int -* **RedirectConfig**: [RedirectConfig](#redirectconfig) -* **TargetGroupArn**: string -* **Type**: string (Required) +* **ContentType**: string: The content type. + Valid Values: text/plain | text/css | text/html | application/javascript | application/json +* **MessageBody**: string: The message. +* **StatusCode**: string (Required): The HTTP response code (2XX, 4XX, or 5XX). -## AuthenticateCognitoConfig +## FixedResponseConfig ### Properties -* **AuthenticationRequestExtraParams**: [ListenerRule_AuthenticationRequestExtraParams](#listenerruleauthenticationrequestextraparams) -* **OnUnauthenticatedRequest**: string -* **Scope**: string -* **SessionCookieName**: string -* **SessionTimeout**: int -* **UserPoolArn**: string (Required) -* **UserPoolClientId**: string (Required) -* **UserPoolDomain**: string (Required) +* **ContentType**: string: The content type. + Valid Values: text/plain | text/css | text/html | application/javascript | application/json +* **MessageBody**: string: The message. +* **StatusCode**: string (Required): The HTTP response code (2XX, 4XX, or 5XX). -## ListenerRule_AuthenticationRequestExtraParams +## ForwardConfig ### Properties +* **TargetGroups**: [TargetGroupTuple](#targetgrouptuple)[]: Information about how traffic will be distributed between multiple target groups in a forward rule. +* **TargetGroupStickinessConfig**: [TargetGroupStickinessConfig](#targetgroupstickinessconfig): Information about the target group stickiness for a rule. -## AuthenticateOidcConfig +## ForwardConfig ### Properties -* **AuthenticationRequestExtraParams**: [ListenerRule_AuthenticationRequestExtraParams](#listenerruleauthenticationrequestextraparams) -* **AuthorizationEndpoint**: string (Required) -* **ClientId**: string (Required) -* **ClientSecret**: string -* **Issuer**: string (Required) -* **OnUnauthenticatedRequest**: string -* **Scope**: string -* **SessionCookieName**: string -* **SessionTimeout**: int -* **TokenEndpoint**: string (Required) -* **UseExistingClientSecret**: bool -* **UserInfoEndpoint**: string (Required) +* **TargetGroups**: [TargetGroupTuple](#targetgrouptuple)[]: Information about how traffic will be distributed between multiple target groups in a forward rule. +* **TargetGroupStickinessConfig**: [TargetGroupStickinessConfig](#targetgroupstickinessconfig): Information about the target group stickiness for a rule. -## ListenerRule_AuthenticationRequestExtraParams +## HostHeaderConfig ### Properties +* **Values**: string[]: The host names. The maximum size of each name is 128 characters. The comparison is case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character). + If you specify multiple strings, the condition is satisfied if one of the strings matches the host name. -## FixedResponseConfig +## HttpHeaderConfig ### Properties -* **ContentType**: string -* **MessageBody**: string -* **StatusCode**: string (Required) +* **HttpHeaderName**: string: The name of the HTTP header field. The maximum size is 40 characters. The header name is case insensitive. The allowed characters are specified by RFC 7230. Wildcards are not supported. +* **Values**: string[]: The strings to compare against the value of the HTTP header. The maximum size of each string is 128 characters. The comparison strings are case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character). + If the same header appears multiple times in the request, we search them in order until a match is found. + If you specify multiple strings, the condition is satisfied if one of the strings matches the value of the HTTP header. To require that all of the strings are a match, create one condition per string. -## ForwardConfig +## HttpRequestMethodConfig ### Properties -* **TargetGroups**: [TargetGroupTuple](#targetgrouptuple)[] -* **TargetGroupStickinessConfig**: [TargetGroupStickinessConfig](#targetgroupstickinessconfig) +* **Values**: string[]: The name of the request method. The maximum size is 40 characters. The allowed characters are A-Z, hyphen (-), and underscore (_). The comparison is case sensitive. Wildcards are not supported; therefore, the method name must be an exact match. + If you specify multiple strings, the condition is satisfied if one of the strings matches the HTTP request method. We recommend that you route GET and HEAD requests in the same way, because the response to a HEAD request may be cached. -## TargetGroupTuple +## Listener_AuthenticationRequestExtraParams ### Properties -* **TargetGroupArn**: string -* **Weight**: int -## TargetGroupStickinessConfig +## Listener_AuthenticationRequestExtraParams ### Properties -* **DurationSeconds**: int -* **Enabled**: bool -## RedirectConfig +## ListenerRule_AuthenticationRequestExtraParams ### Properties -* **Host**: string -* **Path**: string -* **Port**: string -* **Protocol**: string -* **Query**: string -* **StatusCode**: string (Required) -## RuleCondition +## ListenerRule_AuthenticationRequestExtraParams ### Properties -* **Field**: string -* **HostHeaderConfig**: [HostHeaderConfig](#hostheaderconfig) -* **HttpHeaderConfig**: [HttpHeaderConfig](#httpheaderconfig) -* **HttpRequestMethodConfig**: [HttpRequestMethodConfig](#httprequestmethodconfig) -* **PathPatternConfig**: [PathPatternConfig](#pathpatternconfig) -* **QueryStringConfig**: [QueryStringConfig](#querystringconfig) -* **SourceIpConfig**: [SourceIpConfig](#sourceipconfig) -* **Values**: string[] -## HostHeaderConfig +## LoadBalancerAttribute ### Properties -* **Values**: string[] +* **Key**: string: The name of the attribute. + The following attributes are supported by all load balancers: + + ``deletion_protection.enabled`` - Indicates whether deletion protection is enabled. The value is ``true`` or ``false``. The default is ``false``. + + ``load_balancing.cross_zone.enabled`` - Indicates whether cross-zone load balancing is enabled. The possible values are ``true`` and ``false``. The default for Network Load Balancers and Gateway Load Balancers is ``false``. The default for Application Load Balancers is ``true``, and cannot be changed. + + The following attributes are supported by both Application Load Balancers and Network Load Balancers: + + ``access_logs.s3.enabled`` - Indicates whether access logs are enabled. The value is ``true`` or ``false``. The default is ``false``. + + ``access_logs.s3.bucket`` - The name of the S3 bucket for the access logs. This attribute is required if access logs are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket. + + ``access_logs.s3.prefix`` - The prefix for the location in the S3 bucket for the access logs. + + ``ipv6.deny_all_igw_traffic`` - Blocks internet gateway (IGW) access to the load balancer. It is set to ``false`` for internet-facing load balancers and ``true`` for internal load balancers, preventing unintended access to your internal load balancer through an internet gateway. + + The following attributes are supported by only Application Load Balancers: + + ``idle_timeout.timeout_seconds`` - The idle timeout value, in seconds. The valid range is 1-4000 seconds. The default is 60 seconds. + + ``client_keep_alive.seconds`` - The client keep alive value, in seconds. The valid range is 60-604800 seconds. The default is 3600 seconds. + + ``connection_logs.s3.enabled`` - Indicates whether connection logs are enabled. The value is ``true`` or ``false``. The default is ``false``. + + ``connection_logs.s3.bucket`` - The name of the S3 bucket for the connection logs. This attribute is required if connection logs are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket. + + ``connection_logs.s3.prefix`` - The prefix for the location in the S3 bucket for the connection logs. + + ``routing.http.desync_mitigation_mode`` - Determines how the load balancer handles requests that might pose a security risk to your application. The possible values are ``monitor``, ``defensive``, and ``strictest``. The default is ``defensive``. + + ``routing.http.drop_invalid_header_fields.enabled`` - Indicates whether HTTP headers with invalid header fields are removed by the load balancer (``true``) or routed to targets (``false``). The default is ``false``. + + ``routing.http.preserve_host_header.enabled`` - Indicates whether the Application Load Balancer should preserve the ``Host`` header in the HTTP request and send it to the target without any change. The possible values are ``true`` and ``false``. The default is ``false``. + + ``routing.http.x_amzn_tls_version_and_cipher_suite.enabled`` - Indicates whether the two headers (``x-amzn-tls-version`` and ``x-amzn-tls-cipher-suite``), which contain information about the negotiated TLS version and cipher suite, are added to the client request before sending it to the target. The ``x-amzn-tls-version`` header has information about the TLS protocol version negotiated with the client, and the ``x-amzn-tls-cipher-suite`` header has information about the cipher suite negotiated with the client. Both headers are in OpenSSL format. The possible values for the attribute are ``true`` and ``false``. The default is ``false``. + + ``routing.http.xff_client_port.enabled`` - Indicates whether the ``X-Forwarded-For`` header should preserve the source port that the client used to connect to the load balancer. The possible values are ``true`` and ``false``. The default is ``false``. + + ``routing.http.xff_header_processing.mode`` - Enables you to modify, preserve, or remove the ``X-Forwarded-For`` header in the HTTP request before the Application Load Balancer sends the request to the target. The possible values are ``append``, ``preserve``, and ``remove``. The default is ``append``. + + If the value is ``append``, the Application Load Balancer adds the client IP address (of the last hop) to the ``X-Forwarded-For`` header in the HTTP request before it sends it to targets. + + If the value is ``preserve`` the Application Load Balancer preserves the ``X-Forwarded-For`` header in the HTTP request, and sends it to targets without any change. + + If the value is ``remove``, the Application Load Balancer removes the ``X-Forwarded-For`` header in the HTTP request before it sends it to targets. + + + ``routing.http2.enabled`` - Indicates whether HTTP/2 is enabled. The possible values are ``true`` and ``false``. The default is ``true``. Elastic Load Balancing requires that message header names contain only alphanumeric characters and hyphens. + + ``waf.fail_open.enabled`` - Indicates whether to allow a WAF-enabled load balancer to route requests to targets if it is unable to forward the request to AWS WAF. The possible values are ``true`` and ``false``. The default is ``false``. + + The following attributes are supported by only Network Load Balancers: + + ``dns_record.client_routing_policy`` - Indicates how traffic is distributed among the load balancer Availability Zones. The possible values are ``availability_zone_affinity`` with 100 percent zonal affinity, ``partial_availability_zone_affinity`` with 85 percent zonal affinity, and ``any_availability_zone`` with 0 percent zonal affinity. +* **Value**: string: The value of the attribute. -## HttpHeaderConfig +## Matcher ### Properties -* **HttpHeaderName**: string -* **Values**: string[] +* **GrpcCode**: string: You can specify values between 0 and 99. You can specify multiple values, or a range of values. The default value is 12. +* **HttpCode**: string: For Application Load Balancers, you can specify values between 200 and 499, and the default value is 200. You can specify multiple values or a range of values. -## HttpRequestMethodConfig +## MutualAuthentication ### Properties -* **Values**: string[] +* **IgnoreClientCertificateExpiry**: bool: Indicates whether expired client certificates are ignored. +* **Mode**: string: The client certificate handling method. Options are ``off``, ``passthrough`` or ``verify``. The default value is ``off``. +* **TrustStoreArn**: string: The Amazon Resource Name (ARN) of the trust store. ## PathPatternConfig ### Properties -* **Values**: string[] +* **Values**: string[]: The path patterns to compare against the request URL. The maximum size of each string is 128 characters. The comparison is case sensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character). + If you specify multiple strings, the condition is satisfied if one of them matches the request URL. The path pattern is compared only to the path of the URL, not to its query string. ## QueryStringConfig ### Properties -* **Values**: [QueryStringKeyValue](#querystringkeyvalue)[] +* **Values**: [QueryStringKeyValue](#querystringkeyvalue)[]: The key/value pairs or values to find in the query string. The maximum size of each string is 128 characters. The comparison is case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character). To search for a literal '*' or '?' character in a query string, you must escape these characters in ``Values`` using a '\' character. + If you specify multiple key/value pairs or values, the condition is satisfied if one of them is found in the query string. ## QueryStringKeyValue ### Properties -* **Key**: string -* **Value**: string +* **Key**: string: The key. You can omit the key. +* **Value**: string: The value. -## SourceIpConfig +## RedirectConfig ### Properties -* **Values**: string[] +* **Host**: string: The hostname. This component is not percent-encoded. The hostname can contain #{host}. +* **Path**: string: The absolute path, starting with the leading "/". This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}. +* **Port**: string: The port. You can specify a value from 1 to 65535 or #{port}. +* **Protocol**: string: The protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP, HTTP to HTTPS, and HTTPS to HTTPS. You cannot redirect HTTPS to HTTP. +* **Query**: string: The query parameters, URL-encoded when necessary, but not percent-encoded. Do not include the leading "?", as it is automatically added. You can specify any of the reserved keywords. +* **StatusCode**: string (Required): The HTTP redirect code. The redirect is either permanent (HTTP 301) or temporary (HTTP 302). -## AWS.ElasticLoadBalancingV2/LoadBalancerProperties +## RedirectConfig ### Properties -* **CanonicalHostedZoneID**: string (ReadOnly): The ID of the Amazon Route 53 hosted zone associated with the load balancer. -* **DNSName**: string (ReadOnly): The public DNS name of the load balancer. -* **IpAddressType**: string: The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses). -* **LoadBalancerArn**: string (ReadOnly, Identifier): The Amazon Resource Name (ARN) of the load balancer. -* **LoadBalancerAttributes**: [LoadBalancerAttribute](#loadbalancerattribute)[]: The load balancer attributes. -* **LoadBalancerFullName**: string (ReadOnly): The full name of the load balancer. -* **LoadBalancerName**: string (ReadOnly): The name of the load balancer. -* **Name**: string: The name of the load balancer. -* **Scheme**: string: The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet. The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer. The default is an Internet-facing load balancer. -* **SecurityGroups**: string[]: The IDs of the security groups for the load balancer. -* **SubnetMappings**: [SubnetMapping](#subnetmapping)[]: The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. -* **Subnets**: string[]: The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. To specify an Elastic IP address, specify subnet mappings instead of subnets. -* **Tags**: [Tag](#tag)[]: The tags to assign to the load balancer. -* **Type**: string: The type of load balancer. The default is application. +* **Host**: string: The hostname. This component is not percent-encoded. The hostname can contain #{host}. +* **Path**: string: The absolute path, starting with the leading "/". This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}. +* **Port**: string: The port. You can specify a value from 1 to 65535 or #{port}. +* **Protocol**: string: The protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP, HTTP to HTTPS, and HTTPS to HTTPS. You cannot redirect HTTPS to HTTP. +* **Query**: string: The query parameters, URL-encoded when necessary, but not percent-encoded. Do not include the leading "?", as it is automatically added. You can specify any of the reserved keywords. +* **StatusCode**: string (Required): The HTTP redirect code. The redirect is either permanent (HTTP 301) or temporary (HTTP 302). -## LoadBalancerAttribute +## RuleCondition ### Properties -* **Key**: string -* **Value**: string +* **Field**: string: The field in the HTTP request. The following are the possible values: + + ``http-header`` + + ``http-request-method`` + + ``host-header`` + + ``path-pattern`` + + ``query-string`` + + ``source-ip`` +* **HostHeaderConfig**: [HostHeaderConfig](#hostheaderconfig): Information for a host header condition. Specify only when ``Field`` is ``host-header``. +* **HttpHeaderConfig**: [HttpHeaderConfig](#httpheaderconfig): Information for an HTTP header condition. Specify only when ``Field`` is ``http-header``. +* **HttpRequestMethodConfig**: [HttpRequestMethodConfig](#httprequestmethodconfig): Information for an HTTP method condition. Specify only when ``Field`` is ``http-request-method``. +* **PathPatternConfig**: [PathPatternConfig](#pathpatternconfig): Information for a path pattern condition. Specify only when ``Field`` is ``path-pattern``. +* **QueryStringConfig**: [QueryStringConfig](#querystringconfig): Information for a query string condition. Specify only when ``Field`` is ``query-string``. +* **SourceIpConfig**: [SourceIpConfig](#sourceipconfig): Information for a source IP condition. Specify only when ``Field`` is ``source-ip``. +* **Values**: string[]: The condition value. Specify only when ``Field`` is ``host-header`` or ``path-pattern``. Alternatively, to specify multiple host names or multiple path patterns, use ``HostHeaderConfig`` or ``PathPatternConfig``. + If ``Field`` is ``host-header`` and you're not using ``HostHeaderConfig``, you can specify a single host name (for example, my.example.com). A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters. + + A-Z, a-z, 0-9 + + - . + + * (matches 0 or more characters) + + ? (matches exactly 1 character) + + If ``Field`` is ``path-pattern`` and you're not using ``PathPatternConfig``, you can specify a single path pattern (for example, /img/*). A path pattern is case-sensitive, can be up to 128 characters in length, and can contain any of the following characters. + + A-Z, a-z, 0-9 + + _ - . $ / ~ " ' @ : + + + & (using &) + + * (matches 0 or more characters) + + ? (matches exactly 1 character) -## SubnetMapping +## SourceIpConfig ### Properties -* **AllocationId**: string -* **IPv6Address**: string -* **PrivateIPv4Address**: string -* **SubnetId**: string (Required) +* **Values**: string[]: The source IP addresses, in CIDR format. You can use both IPv4 and IPv6 addresses. Wildcards are not supported. + If you specify multiple addresses, the condition is satisfied if the source IP address of the request matches one of the CIDR blocks. This condition is not satisfied by the addresses in the X-Forwarded-For header. -## Tag +## SubnetMapping ### Properties -* **Key**: string (Required) -* **Value**: string +* **AllocationId**: string: [Network Load Balancers] The allocation ID of the Elastic IP address for an internet-facing load balancer. +* **IPv6Address**: string: [Network Load Balancers] The IPv6 address. +* **PrivateIPv4Address**: string: [Network Load Balancers] The private IPv4 address for an internal load balancer. +* **SubnetId**: string (Required): The ID of the subnet. -## AWS.ElasticLoadBalancingV2/TargetGroupProperties -### Properties -* **HealthCheckEnabled**: bool: Indicates whether health checks are enabled. If the target type is lambda, health checks are disabled by default but can be enabled. If the target type is instance, ip, or alb, health checks are always enabled and cannot be disabled. -* **HealthCheckIntervalSeconds**: int: The approximate amount of time, in seconds, between health checks of an individual target. -* **HealthCheckPath**: string: [HTTP/HTTPS health checks] The destination for health checks on the targets. [HTTP1 or HTTP2 protocol version] The ping path. The default is /. [GRPC protocol version] The path of a custom health check method with the format /package.service/method. The default is /AWS.ALB/healthcheck. -* **HealthCheckPort**: string: The port the load balancer uses when performing health checks on targets. -* **HealthCheckProtocol**: string: The protocol the load balancer uses when performing health checks on targets. -* **HealthCheckTimeoutSeconds**: int: The amount of time, in seconds, during which no response from a target means a failed health check. -* **HealthyThresholdCount**: int: The number of consecutive health checks successes required before considering an unhealthy target healthy. -* **IpAddressType**: string: The type of IP address used for this target group. The possible values are ipv4 and ipv6. -* **LoadBalancerArns**: string[] (ReadOnly): The Amazon Resource Names (ARNs) of the load balancers that route traffic to this target group. -* **Matcher**: [Matcher](#matcher): [HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target. -* **Name**: string: The name of the target group. -* **Port**: int: The port on which the targets receive traffic. This port is used unless you specify a port override when registering the target. If the target is a Lambda function, this parameter does not apply. If the protocol is GENEVE, the supported port is 6081. -* **Protocol**: string: The protocol to use for routing traffic to the targets. -* **ProtocolVersion**: string: [HTTP/HTTPS protocol] The protocol version. The possible values are GRPC, HTTP1, and HTTP2. -* **Tags**: [Tag](#tag)[]: The tags. -* **TargetGroupArn**: string (ReadOnly, Identifier): The ARN of the Target Group -* **TargetGroupAttributes**: [TargetGroupAttribute](#targetgroupattribute)[]: The attributes. -* **TargetGroupFullName**: string (ReadOnly): The full name of the target group. -* **TargetGroupName**: string (ReadOnly): The name of the target group. -* **Targets**: [TargetDescription](#targetdescription)[]: The targets. -* **TargetType**: string: The type of target that you must specify when registering targets with this target group. You can't specify targets for a target group using more than one target type. -* **UnhealthyThresholdCount**: int: The number of consecutive health check failures required before considering a target unhealthy. -* **VpcId**: string: The identifier of the virtual private cloud (VPC). If the target is a Lambda function, this parameter does not apply. - -## Matcher +## Tag ### Properties -* **GrpcCode**: string: You can specify values between 0 and 99. You can specify multiple values, or a range of values. The default value is 12. -* **HttpCode**: string: For Application Load Balancers, you can specify values between 200 and 499, and the default value is 200. You can specify multiple values or a range of values. +* **Key**: string (Required): The key of the tag. +* **Value**: string: The value of the tag. ## Tag ### Properties * **Key**: string (Required): The value for the tag. * **Value**: string (Required): The key name of the tag. -## TargetGroupAttribute +## Tag ### Properties -* **Key**: string: The value of the attribute. -* **Value**: string: The name of the attribute. +* **Key**: string (Required) +* **Value**: string (Required) ## TargetDescription ### Properties @@ -334,19 +424,28 @@ * **Id**: string (Required): The ID of the target. If the target type of the target group is instance, specify an instance ID. If the target type is ip, specify an IP address. If the target type is lambda, specify the ARN of the Lambda function. If the target type is alb, specify the ARN of the Application Load Balancer target. * **Port**: int: The port on which the target is listening. If the target group protocol is GENEVE, the supported port is 6081. If the target type is alb, the targeted Application Load Balancer must have at least one listener whose port matches the target group port. Not used if the target is a Lambda function. -## AWS.ElasticLoadBalancingV2/TrustStoreProperties +## TargetGroupAttribute ### Properties -* **CaCertificatesBundleS3Bucket**: string (WriteOnly): The name of the S3 bucket to fetch the CA certificate bundle from. -* **CaCertificatesBundleS3Key**: string (WriteOnly): The name of the S3 object to fetch the CA certificate bundle from. -* **CaCertificatesBundleS3ObjectVersion**: string (WriteOnly): The version of the S3 bucket that contains the CA certificate bundle. -* **Name**: string: The name of the trust store. -* **NumberOfCaCertificates**: int (ReadOnly): The number of certificates associated with the trust store. -* **Status**: string (ReadOnly): The status of the trust store, could be either of ACTIVE or CREATING. -* **Tags**: [Tag](#tag)[]: The tags to assign to the trust store. -* **TrustStoreArn**: string (ReadOnly, Identifier): The Amazon Resource Name (ARN) of the trust store. +* **Key**: string: The value of the attribute. +* **Value**: string: The name of the attribute. -## Tag +## TargetGroupStickinessConfig ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **DurationSeconds**: int: The time period, in seconds, during which requests from a client should be routed to the same target group. The range is 1-604800 seconds (7 days). +* **Enabled**: bool: Indicates whether target group stickiness is enabled. + +## TargetGroupStickinessConfig +### Properties +* **DurationSeconds**: int: The time period, in seconds, during which requests from a client should be routed to the same target group. The range is 1-604800 seconds (7 days). +* **Enabled**: bool: Indicates whether target group stickiness is enabled. + +## TargetGroupTuple +### Properties +* **TargetGroupArn**: string: The Amazon Resource Name (ARN) of the target group. +* **Weight**: int: The weight. The range is 0 to 999. + +## TargetGroupTuple +### Properties +* **TargetGroupArn**: string: The Amazon Resource Name (ARN) of the target group. +* **Weight**: int: The weight. The range is 0 to 999. diff --git a/artifacts/bicep/aws/aws.emr/default/types.json b/artifacts/bicep/aws/aws.emr/default/types.json index 982dd779..ab79419b 100644 --- a/artifacts/bicep/aws/aws.emr/default/types.json +++ b/artifacts/bicep/aws/aws.emr/default/types.json @@ -1 +1,412 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"Arn"}},{"2":{"Name":"SubnetId"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 255 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}}}},{"2":{"Name":"Tags"}},{"3":{"ItemType":10}},{"2":{"Name":"AWS.EMR/StudioProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) of the EMR Studio."},"AuthMode":{"Type":4,"Flags":1,"Description":"Specifies whether the Studio authenticates users using single sign-on (SSO) or IAM. Amazon EMR Studio currently only supports SSO authentication."},"DefaultS3Location":{"Type":4,"Flags":1,"Description":"The default Amazon S3 location to back up EMR Studio Workspaces and notebook files. A Studio user can select an alternative Amazon S3 location when creating a Workspace."},"Description":{"Type":4,"Flags":0,"Description":"A detailed description of the Studio."},"EncryptionKeyArn":{"Type":4,"Flags":0,"Description":"The AWS KMS key identifier (ARN) used to encrypt AWS EMR Studio workspace and notebook files when backed up to AWS S3."},"EngineSecurityGroupId":{"Type":4,"Flags":1,"Description":"The ID of the Amazon EMR Studio Engine security group. The Engine security group allows inbound network traffic from the Workspace security group, and it must be in the same VPC specified by VpcId."},"IdcInstanceArn":{"Type":4,"Flags":0,"Description":"The ARN of the IAM Identity Center instance to create the Studio application."},"IdcUserAssignment":{"Type":4,"Flags":0,"Description":"Specifies whether IAM Identity Center user assignment is REQUIRED or OPTIONAL. If the value is set to REQUIRED, users must be explicitly assigned to the Studio application to access the Studio."},"IdpAuthUrl":{"Type":4,"Flags":0,"Description":"Your identity provider's authentication endpoint. Amazon EMR Studio redirects federated users to this endpoint for authentication when logging in to a Studio with the Studio URL."},"IdpRelayStateParameterName":{"Type":4,"Flags":0,"Description":"The name of relay state parameter for external Identity Provider."},"Name":{"Type":4,"Flags":1,"Description":"A descriptive name for the Amazon EMR Studio."},"ServiceRole":{"Type":4,"Flags":1,"Description":"The IAM role that will be assumed by the Amazon EMR Studio. The service role provides a way for Amazon EMR Studio to interoperate with other AWS services."},"StudioId":{"Type":4,"Flags":18,"Description":"The ID of the EMR Studio."},"SubnetIds":{"Type":14,"Flags":1,"Description":"A list of up to 5 subnet IDs to associate with the Studio. The subnets must belong to the VPC specified by VpcId. Studio users can create a Workspace in any of the specified subnets."},"Tags":{"Type":15,"Flags":0,"Description":"A list of tags to associate with the Studio. Tags are user-defined key-value pairs that consist of a required key string with a maximum of 128 characters, and an optional value string with a maximum of 256 characters."},"TrustedIdentityPropagationEnabled":{"Type":2,"Flags":0,"Description":"A Boolean indicating whether to enable Trusted identity propagation for the Studio. The default value is false."},"Url":{"Type":4,"Flags":2,"Description":"The unique Studio access URL."},"UserRole":{"Type":4,"Flags":0,"Description":"The IAM user role that will be assumed by users and groups logged in to a Studio. The permissions attached to this IAM role can be scoped down for each user or group using session policies."},"VpcId":{"Type":4,"Flags":1,"Description":"The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio."},"WorkspaceSecurityGroupId":{"Type":4,"Flags":1,"Description":"The ID of the Amazon EMR Studio Workspace security group. The Workspace security group allows outbound network traffic to resources in the Engine security group, and it must be in the same VPC specified by VpcId."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":10}},{"2":{"Name":"AWS.EMR/Studio","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":13,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EMR/Studio@default","ScopeType":0,"Body":16}},{"2":{"Name":"IamPolicyArn"}},{"2":{"Name":"AWS.EMR/StudioSessionMappingProperties","Properties":{"IdentityName":{"Type":4,"Flags":17,"Description":"The name of the user or group. For more information, see UserName and DisplayName in the AWS SSO Identity Store API Reference. Either IdentityName or IdentityId must be specified."},"IdentityType":{"Type":4,"Flags":17,"Description":"Specifies whether the identity to map to the Studio is a user or a group."},"SessionPolicyArn":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) for the session policy that will be applied to the user or group. Session policies refine Studio user permissions without the need to use multiple IAM user roles."},"StudioId":{"Type":4,"Flags":17,"Description":"The ID of the Amazon EMR Studio to which the user or group will be mapped."}}}},{"2":{"Name":"AWS.EMR/StudioSessionMapping","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":19,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EMR/StudioSessionMapping@default","ScopeType":0,"Body":20}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.EMR/WALWorkspaceProperties","Properties":{"Tags":{"Type":24,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."},"WALWorkspaceName":{"Type":4,"Flags":16,"Description":"The name of the emrwal container"}}}},{"3":{"ItemType":22}},{"2":{"Name":"AWS.EMR/WALWorkspace","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":23,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EMR/WALWorkspace@default","ScopeType":0,"Body":25}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Arn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SubnetId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + }, + "Value": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 255 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + } + } + }, + { + "$type": "ObjectType", + "name": "Tags", + "properties": {} + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EMR/StudioProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "ObjectType", + "name": "AWS.EMR/StudioProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/4" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) of the EMR Studio." + }, + "AuthMode": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "Specifies whether the Studio authenticates users using single sign-on (SSO) or IAM. Amazon EMR Studio currently only supports SSO authentication." + }, + "DefaultS3Location": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The default Amazon S3 location to back up EMR Studio Workspaces and notebook files. A Studio user can select an alternative Amazon S3 location when creating a Workspace." + }, + "Description": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "A detailed description of the Studio." + }, + "EncryptionKeyArn": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The AWS KMS key identifier (ARN) used to encrypt AWS EMR Studio workspace and notebook files when backed up to AWS S3." + }, + "EngineSecurityGroupId": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The ID of the Amazon EMR Studio Engine security group. The Engine security group allows inbound network traffic from the Workspace security group, and it must be in the same VPC specified by VpcId." + }, + "IdcInstanceArn": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The ARN of the IAM Identity Center instance to create the Studio application." + }, + "IdcUserAssignment": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Specifies whether IAM Identity Center user assignment is REQUIRED or OPTIONAL. If the value is set to REQUIRED, users must be explicitly assigned to the Studio application to access the Studio." + }, + "IdpAuthUrl": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Your identity provider's authentication endpoint. Amazon EMR Studio redirects federated users to this endpoint for authentication when logging in to a Studio with the Studio URL." + }, + "IdpRelayStateParameterName": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The name of relay state parameter for external Identity Provider." + }, + "Name": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "A descriptive name for the Amazon EMR Studio." + }, + "ServiceRole": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The IAM role that will be assumed by the Amazon EMR Studio. The service role provides a way for Amazon EMR Studio to interoperate with other AWS services." + }, + "StudioId": { + "type": { + "$ref": "#/4" + }, + "flags": 18, + "description": "The ID of the EMR Studio." + }, + "SubnetIds": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "A list of up to 5 subnet IDs to associate with the Studio. The subnets must belong to the VPC specified by VpcId. Studio users can create a Workspace in any of the specified subnets." + }, + "Tags": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "A list of tags to associate with the Studio. Tags are user-defined key-value pairs that consist of a required key string with a maximum of 128 characters, and an optional value string with a maximum of 256 characters." + }, + "TrustedIdentityPropagationEnabled": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "A Boolean indicating whether to enable Trusted identity propagation for the Studio. The default value is false." + }, + "Url": { + "type": { + "$ref": "#/4" + }, + "flags": 2, + "description": "The unique Studio access URL." + }, + "UserRole": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The IAM user role that will be assumed by users and groups logged in to a Studio. The permissions attached to this IAM role can be scoped down for each user or group using session policies." + }, + "VpcId": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio." + }, + "WorkspaceSecurityGroupId": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The ID of the Amazon EMR Studio Workspace security group. The Workspace security group allows outbound network traffic to resources in the Engine security group, and it must be in the same VPC specified by VpcId." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EMR/Studio", + "properties": { + "name": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/10" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EMR/Studio@default", + "scopeType": 0, + "body": { + "$ref": "#/11" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "IamPolicyArn", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.EMR/StudioSessionMappingProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.EMR/StudioSessionMappingProperties", + "properties": { + "IdentityName": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "The name of the user or group. For more information, see UserName and DisplayName in the AWS SSO Identity Store API Reference. Either IdentityName or IdentityId must be specified." + }, + "IdentityType": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "Specifies whether the identity to map to the Studio is a user or a group." + }, + "SessionPolicyArn": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) for the session policy that will be applied to the user or group. Session policies refine Studio user permissions without the need to use multiple IAM user roles." + }, + "StudioId": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "The ID of the Amazon EMR Studio to which the user or group will be mapped." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EMR/StudioSessionMapping", + "properties": { + "name": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/15" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EMR/StudioSessionMapping@default", + "scopeType": 0, + "body": { + "$ref": "#/16" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EMR/WALWorkspaceProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/18" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EMR/WALWorkspaceProperties", + "properties": { + "Tags": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + }, + "WALWorkspaceName": { + "type": { + "$ref": "#/4" + }, + "flags": 16, + "description": "The name of the emrwal container" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EMR/WALWorkspace", + "properties": { + "name": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/21" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EMR/WALWorkspace@default", + "scopeType": 0, + "body": { + "$ref": "#/22" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.emr/default/types.md b/artifacts/bicep/aws/aws.emr/default/types.md index 1fd3f56c..49672d80 100644 --- a/artifacts/bicep/aws/aws.emr/default/types.md +++ b/artifacts/bicep/aws/aws.emr/default/types.md @@ -3,23 +3,23 @@ ## Resource AWS.EMR/Studio@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EMR/StudioProperties](#awsemrstudioproperties) (Required): properties of the resource +* **properties**: [AWS.EMR/StudioProperties](#awsemrstudioproperties) (Required, Identifier): properties of the resource ## Resource AWS.EMR/StudioSessionMapping@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EMR/StudioSessionMappingProperties](#awsemrstudiosessionmappingproperties) (Required): properties of the resource +* **properties**: [AWS.EMR/StudioSessionMappingProperties](#awsemrstudiosessionmappingproperties) (Required, Identifier): properties of the resource ## Resource AWS.EMR/WALWorkspace@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EMR/WALWorkspaceProperties](#awsemrwalworkspaceproperties): properties of the resource +* **properties**: [AWS.EMR/WALWorkspaceProperties](#awsemrwalworkspaceproperties) (Identifier): properties of the resource ## AWS.EMR/StudioProperties ### Properties @@ -44,11 +44,6 @@ * **VpcId**: string (Required): The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio. * **WorkspaceSecurityGroupId**: string (Required): The ID of the Amazon EMR Studio Workspace security group. The Workspace security group allows outbound network traffic to resources in the Engine security group, and it must be in the same VPC specified by VpcId. -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 255 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## AWS.EMR/StudioSessionMappingProperties ### Properties * **IdentityName**: string (Required, Identifier): The name of the user or group. For more information, see UserName and DisplayName in the AWS SSO Identity Store API Reference. Either IdentityName or IdentityId must be specified. @@ -61,6 +56,11 @@ * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. * **WALWorkspaceName**: string (Identifier): The name of the emrwal container +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 255 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + ## Tag ### Properties * **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. diff --git a/artifacts/bicep/aws/aws.emrcontainers/default/types.json b/artifacts/bicep/aws/aws.emrcontainers/default/types.json index 2b7aa8cd..69ddb714 100644 --- a/artifacts/bicep/aws/aws.emrcontainers/default/types.json +++ b/artifacts/bicep/aws/aws.emrcontainers/default/types.json @@ -1 +1,161 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"ContainerInfo","Properties":{"EksInfo":{"Type":10,"Flags":1}}}},{"2":{"Name":"ContainerProvider","Properties":{"Id":{"Type":4,"Flags":17,"Description":"The ID of the container cluster"},"Info":{"Type":8,"Flags":1},"Type":{"Type":4,"Flags":1,"Description":"The type of the container provider"}}}},{"2":{"Name":"EksInfo","Properties":{"Namespace":{"Type":4,"Flags":1}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.EMRContainers/VirtualClusterProperties","Properties":{"Arn":{"Type":4,"Flags":2},"ContainerProvider":{"Type":9,"Flags":1,"Description":"Container provider of the virtual cluster."},"Id":{"Type":4,"Flags":18,"Description":"Id of the virtual cluster."},"Name":{"Type":4,"Flags":1,"Description":"Name of the virtual cluster."},"Tags":{"Type":13,"Flags":0,"Description":"An array of key-value pairs to apply to this virtual cluster."}}}},{"3":{"ItemType":11}},{"2":{"Name":"AWS.EMRContainers/VirtualCluster","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":12,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EMRContainers/VirtualCluster@default","ScopeType":0,"Body":14}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "ContainerInfo", + "properties": { + "EksInfo": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ContainerProvider", + "properties": { + "Id": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "The ID of the container cluster" + }, + "Info": { + "type": { + "$ref": "#/0" + }, + "flags": 1 + }, + "Type": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The type of the container provider" + } + } + }, + { + "$type": "ObjectType", + "name": "EksInfo", + "properties": { + "Namespace": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.EMRContainers/VirtualClusterProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EMRContainers/VirtualClusterProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/4" + }, + "flags": 2 + }, + "ContainerProvider": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Container provider of the virtual cluster." + }, + "Id": { + "type": { + "$ref": "#/4" + }, + "flags": 18, + "description": "Id of the virtual cluster." + }, + "Name": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "Name of the virtual cluster." + }, + "Tags": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this virtual cluster." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EMRContainers/VirtualCluster", + "properties": { + "name": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/7" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EMRContainers/VirtualCluster@default", + "scopeType": 0, + "body": { + "$ref": "#/8" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.emrcontainers/default/types.md b/artifacts/bicep/aws/aws.emrcontainers/default/types.md index 025e8d55..eea07727 100644 --- a/artifacts/bicep/aws/aws.emrcontainers/default/types.md +++ b/artifacts/bicep/aws/aws.emrcontainers/default/types.md @@ -3,9 +3,9 @@ ## Resource AWS.EMRContainers/VirtualCluster@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EMRContainers/VirtualClusterProperties](#awsemrcontainersvirtualclusterproperties) (Required): properties of the resource +* **properties**: [AWS.EMRContainers/VirtualClusterProperties](#awsemrcontainersvirtualclusterproperties) (Required, Identifier): properties of the resource ## AWS.EMRContainers/VirtualClusterProperties ### Properties @@ -15,16 +15,16 @@ * **Name**: string (Required): Name of the virtual cluster. * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this virtual cluster. +## ContainerInfo +### Properties +* **EksInfo**: [EksInfo](#eksinfo) (Required) + ## ContainerProvider ### Properties * **Id**: string (Required, Identifier): The ID of the container cluster * **Info**: [ContainerInfo](#containerinfo) (Required) * **Type**: string (Required): The type of the container provider -## ContainerInfo -### Properties -* **EksInfo**: [EksInfo](#eksinfo) (Required) - ## EksInfo ### Properties * **Namespace**: string (Required) diff --git a/artifacts/bicep/aws/aws.emrserverless/default/types.json b/artifacts/bicep/aws/aws.emrserverless/default/types.json index 7c97868e..4ea28d8c 100644 --- a/artifacts/bicep/aws/aws.emrserverless/default/types.json +++ b/artifacts/bicep/aws/aws.emrserverless/default/types.json @@ -1 +1,702 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"Architecture"}},{"2":{"Name":"AutoStartConfiguration","Properties":{"Enabled":{"Type":2,"Flags":0,"Description":"If set to true, the Application will automatically start. Defaults to true."}}}},{"2":{"Name":"AutoStopConfiguration","Properties":{"Enabled":{"Type":2,"Flags":0,"Description":"If set to true, the Application will automatically stop after being idle. Defaults to true."},"IdleTimeoutMinutes":{"Type":3,"Flags":0,"Description":"The amount of time [in minutes] to wait before auto stopping the Application when idle. Defaults to 15 minutes."}}}},{"2":{"Name":"Classification"}},{"2":{"Name":"CloudWatchLoggingConfiguration","Properties":{"Enabled":{"Type":2,"Flags":0,"Description":"If set to false, CloudWatch logging will be turned off. Defaults to false."},"EncryptionKeyArn":{"Type":4,"Flags":0,"Description":"KMS key ARN to encrypt the logs stored in given CloudWatch log-group."},"LogGroupName":{"Type":4,"Flags":0,"Description":"Log-group name to produce log-streams on CloudWatch. If undefined, logs will be produced in a default log-group /aws/emr-serverless"},"LogStreamNamePrefix":{"Type":4,"Flags":0,"Description":"Log-stream name prefix by which log-stream names will start in the CloudWatch Log-group."},"LogTypeMap":{"Type":43,"Flags":0,"Description":"The specific log-streams which need to be uploaded to CloudWatch."}}}},{"2":{"Name":"ConfigurationList"}},{"2":{"Name":"ConfigurationObject","Properties":{"Classification":{"Type":4,"Flags":1,"Description":"String with a maximum length of 1024."},"Configurations":{"Type":45,"Flags":0},"Properties":{"Type":46,"Flags":0}}}},{"2":{"Name":"CpuSize"}},{"2":{"Name":"DiskSize"}},{"2":{"Name":"EncryptionKeyArn"}},{"2":{"Name":"ImageConfigurationInput","Properties":{"ImageUri":{"Type":4,"Flags":0,"Description":"The URI of an image in the Amazon ECR registry. This field is required when you create a new application. If you leave this field blank in an update, Amazon EMR will remove the image configuration."}}}},{"2":{"Name":"InitialCapacityConfig","Properties":{"WorkerConfiguration":{"Type":39,"Flags":1},"WorkerCount":{"Type":3,"Flags":1,"Description":"Initial count of workers to be initialized when an Application is started. This count will be continued to be maintained until the Application is stopped"}}}},{"2":{"Name":"InitialCapacityConfigKeyValuePair","Properties":{"Key":{"Type":4,"Flags":1,"Description":"Worker type for an analytics framework."},"Value":{"Type":19,"Flags":1}}}},{"2":{"Name":"InitialCapacityConfigMap"}},{"2":{"Name":"LogGroupName"}},{"2":{"Name":"LogStreamNamePrefix"}},{"2":{"Name":"LogTypeList"}},{"2":{"Name":"LogTypeMapKeyValuePair","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":49,"Flags":1}}}},{"2":{"Name":"LogTypeString"}},{"2":{"Name":"ManagedPersistenceMonitoringConfiguration","Properties":{"Enabled":{"Type":2,"Flags":0,"Description":"If set to false, managed logging will be turned off. Defaults to true."},"EncryptionKeyArn":{"Type":4,"Flags":0,"Description":"KMS key ARN to encrypt the logs stored in managed persistence"}}}},{"2":{"Name":"MaximumAllowedResources","Properties":{"Cpu":{"Type":4,"Flags":1,"Description":"Per worker CPU resource. vCPU is the only supported unit and specifying vCPU is optional."},"Disk":{"Type":4,"Flags":0,"Description":"Per worker Disk resource. GB is the only supported unit and specifying GB is optional"},"Memory":{"Type":4,"Flags":1,"Description":"Per worker memory resource. GB is the only supported unit and specifying GB is optional."}}}},{"2":{"Name":"MemorySize"}},{"2":{"Name":"MonitoringConfiguration","Properties":{"CloudWatchLoggingConfiguration":{"Type":12,"Flags":0,"Description":"CloudWatch logging configurations for a JobRun."},"ManagedPersistenceMonitoringConfiguration":{"Type":27,"Flags":0,"Description":"Managed log persistence configurations for a JobRun."},"S3MonitoringConfiguration":{"Type":50,"Flags":0,"Description":"S3 monitoring configurations for a JobRun."}}}},{"2":{"Name":"NetworkConfiguration","Properties":{"SecurityGroupIds":{"Type":51,"Flags":0,"Description":"The ID of the security groups in the VPC to which you want to connect your job or application."},"SubnetIds":{"Type":52,"Flags":0,"Description":"The ID of the subnets in the VPC to which you want to connect your job or application."}}}},{"2":{"Name":"S3MonitoringConfiguration","Properties":{"EncryptionKeyArn":{"Type":4,"Flags":0,"Description":"KMS key ARN to encrypt the logs stored in given s3"},"LogUri":{"Type":4,"Flags":0}}}},{"2":{"Name":"SecurityGroupId"}},{"2":{"Name":"SensitivePropertiesKeyValuePair"}},{"2":{"Name":"SensitivePropertiesMap"}},{"2":{"Name":"SubnetId"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 1 to 128 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}}}},{"2":{"Name":"UriString"}},{"2":{"Name":"WorkerConfiguration","Properties":{"Cpu":{"Type":4,"Flags":1,"Description":"Per worker CPU resource. vCPU is the only supported unit and specifying vCPU is optional."},"Disk":{"Type":4,"Flags":0,"Description":"Per worker Disk resource. GB is the only supported unit and specifying GB is optional"},"Memory":{"Type":4,"Flags":1,"Description":"Per worker memory resource. GB is the only supported unit and specifying GB is optional."}}}},{"2":{"Name":"WorkerTypeSpecificationInput","Properties":{"ImageConfiguration":{"Type":18,"Flags":0}}}},{"2":{"Name":"WorkerTypeSpecificationInputMap","Properties":{}}},{"2":{"Name":"WorkerTypeString"}},{"3":{"ItemType":25}},{"3":{"ItemType":14}},{"3":{"ItemType":14}},{"2":{"Name":"Application_Properties","Properties":{}}},{"3":{"ItemType":20}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"Application_S3MonitoringConfiguration","Properties":{"EncryptionKeyArn":{"Type":4,"Flags":0,"Description":"KMS key ARN to encrypt the logs stored in given s3"},"LogUri":{"Type":4,"Flags":0}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.EMRServerless/ApplicationProperties","Properties":{"ApplicationId":{"Type":4,"Flags":18,"Description":"The ID of the EMR Serverless Application."},"Architecture":{"Type":4,"Flags":0},"Arn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) of the EMR Serverless Application."},"AutoStartConfiguration":{"Type":9,"Flags":0,"Description":"Configuration for Auto Start of Application."},"AutoStopConfiguration":{"Type":10,"Flags":0,"Description":"Configuration for Auto Stop of Application."},"ImageConfiguration":{"Type":18,"Flags":0},"InitialCapacity":{"Type":54,"Flags":0,"Description":"Initial capacity initialized when an Application is started."},"MaximumCapacity":{"Type":28,"Flags":0,"Description":"Maximum allowed cumulative resources for an Application. No new resources will be created once the limit is hit."},"MonitoringConfiguration":{"Type":30,"Flags":0},"Name":{"Type":4,"Flags":0,"Description":"User friendly Application name."},"NetworkConfiguration":{"Type":31,"Flags":0,"Description":"Network Configuration for customer VPC connectivity."},"ReleaseLabel":{"Type":4,"Flags":1,"Description":"EMR release label."},"RuntimeConfiguration":{"Type":55,"Flags":0},"Tags":{"Type":56,"Flags":0,"Description":"Tag map with key and value"},"Type":{"Type":4,"Flags":1,"Description":"The type of the application"},"WorkerTypeSpecifications":{"Type":41,"Flags":0,"Description":"The key-value pairs that specify worker type to WorkerTypeSpecificationInput. This parameter must contain all valid worker types for a Spark or Hive application. Valid worker types include Driver and Executor for Spark applications and HiveDriver and TezTask for Hive applications. You can either set image details in this parameter for each worker type, or in imageConfiguration for all worker types."}}}},{"3":{"ItemType":20}},{"3":{"ItemType":14}},{"3":{"ItemType":37}},{"2":{"Name":"AWS.EMRServerless/Application","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":53,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EMRServerless/Application@default","ScopeType":0,"Body":57}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Architecture", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AutoStartConfiguration", + "properties": { + "Enabled": { + "type": { + "$ref": "#/37" + }, + "flags": 0, + "description": "If set to true, the Application will automatically start. Defaults to true." + } + } + }, + { + "$type": "ObjectType", + "name": "AutoStopConfiguration", + "properties": { + "Enabled": { + "type": { + "$ref": "#/37" + }, + "flags": 0, + "description": "If set to true, the Application will automatically stop after being idle. Defaults to true." + }, + "IdleTimeoutMinutes": { + "type": { + "$ref": "#/38" + }, + "flags": 0, + "description": "The amount of time [in minutes] to wait before auto stopping the Application when idle. Defaults to 15 minutes." + } + } + }, + { + "$type": "ObjectType", + "name": "Classification", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CloudWatchLoggingConfiguration", + "properties": { + "Enabled": { + "type": { + "$ref": "#/37" + }, + "flags": 0, + "description": "If set to false, CloudWatch logging will be turned off. Defaults to false." + }, + "EncryptionKeyArn": { + "type": { + "$ref": "#/36" + }, + "flags": 0, + "description": "KMS key ARN to encrypt the logs stored in given CloudWatch log-group." + }, + "LogGroupName": { + "type": { + "$ref": "#/36" + }, + "flags": 0, + "description": "Log-group name to produce log-streams on CloudWatch. If undefined, logs will be produced in a default log-group /aws/emr-serverless" + }, + "LogStreamNamePrefix": { + "type": { + "$ref": "#/36" + }, + "flags": 0, + "description": "Log-stream name prefix by which log-stream names will start in the CloudWatch Log-group." + }, + "LogTypeMap": { + "type": { + "$ref": "#/39" + }, + "flags": 0, + "description": "The specific log-streams which need to be uploaded to CloudWatch." + } + } + }, + { + "$type": "ObjectType", + "name": "ConfigurationList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ConfigurationObject", + "properties": { + "Classification": { + "type": { + "$ref": "#/36" + }, + "flags": 1, + "description": "String with a maximum length of 1024." + }, + "Configurations": { + "type": { + "$ref": "#/41" + }, + "flags": 0 + }, + "Properties": { + "type": { + "$ref": "#/42" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CpuSize", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DiskSize", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DiskType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "EncryptionKeyArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ImageConfigurationInput", + "properties": { + "ImageUri": { + "type": { + "$ref": "#/36" + }, + "flags": 0, + "description": "The URI of an image in the Amazon ECR registry. This field is required when you create a new application. If you leave this field blank in an update, Amazon EMR will remove the image configuration." + } + } + }, + { + "$type": "ObjectType", + "name": "InitialCapacityConfig", + "properties": { + "WorkerConfiguration": { + "type": { + "$ref": "#/32" + }, + "flags": 1 + }, + "WorkerCount": { + "type": { + "$ref": "#/38" + }, + "flags": 1, + "description": "Initial count of workers to be initialized when an Application is started. This count will be continued to be maintained until the Application is stopped" + } + } + }, + { + "$type": "ObjectType", + "name": "InitialCapacityConfigKeyValuePair", + "properties": { + "Key": { + "type": { + "$ref": "#/36" + }, + "flags": 1, + "description": "Worker type for an analytics framework." + }, + "Value": { + "type": { + "$ref": "#/12" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "InitialCapacityConfigMap", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LogGroupName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LogStreamNamePrefix", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LogTypeList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LogTypeMapKeyValuePair", + "properties": { + "Key": { + "type": { + "$ref": "#/36" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/45" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "LogTypeString", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ManagedPersistenceMonitoringConfiguration", + "properties": { + "Enabled": { + "type": { + "$ref": "#/37" + }, + "flags": 0, + "description": "If set to false, managed logging will be turned off. Defaults to true." + }, + "EncryptionKeyArn": { + "type": { + "$ref": "#/36" + }, + "flags": 0, + "description": "KMS key ARN to encrypt the logs stored in managed persistence" + } + } + }, + { + "$type": "ObjectType", + "name": "MaximumAllowedResources", + "properties": { + "Cpu": { + "type": { + "$ref": "#/36" + }, + "flags": 1, + "description": "Per worker CPU resource. vCPU is the only supported unit and specifying vCPU is optional." + }, + "Disk": { + "type": { + "$ref": "#/36" + }, + "flags": 0, + "description": "Per worker Disk resource. GB is the only supported unit and specifying GB is optional" + }, + "Memory": { + "type": { + "$ref": "#/36" + }, + "flags": 1, + "description": "Per worker memory resource. GB is the only supported unit and specifying GB is optional." + } + } + }, + { + "$type": "ObjectType", + "name": "MemorySize", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MonitoringConfiguration", + "properties": { + "CloudWatchLoggingConfiguration": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "CloudWatch logging configurations for a JobRun." + }, + "ManagedPersistenceMonitoringConfiguration": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "Managed log persistence configurations for a JobRun." + }, + "S3MonitoringConfiguration": { + "type": { + "$ref": "#/46" + }, + "flags": 0, + "description": "S3 monitoring configurations for a JobRun." + } + } + }, + { + "$type": "ObjectType", + "name": "NetworkConfiguration", + "properties": { + "SecurityGroupIds": { + "type": { + "$ref": "#/47" + }, + "flags": 0, + "description": "The ID of the security groups in the VPC to which you want to connect your job or application." + }, + "SubnetIds": { + "type": { + "$ref": "#/48" + }, + "flags": 0, + "description": "The ID of the subnets in the VPC to which you want to connect your job or application." + } + } + }, + { + "$type": "ObjectType", + "name": "S3MonitoringConfiguration", + "properties": { + "EncryptionKeyArn": { + "type": { + "$ref": "#/36" + }, + "flags": 0, + "description": "KMS key ARN to encrypt the logs stored in given s3" + }, + "LogUri": { + "type": { + "$ref": "#/36" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SecurityGroupId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SensitivePropertiesKeyValuePair", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SensitivePropertiesMap", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SubnetId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/36" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 1 to 128 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + }, + "Value": { + "type": { + "$ref": "#/36" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + } + } + }, + { + "$type": "ObjectType", + "name": "UriString", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "WorkerConfiguration", + "properties": { + "Cpu": { + "type": { + "$ref": "#/36" + }, + "flags": 1, + "description": "Per worker CPU resource. vCPU is the only supported unit and specifying vCPU is optional." + }, + "Disk": { + "type": { + "$ref": "#/36" + }, + "flags": 0, + "description": "Per worker Disk resource. GB is the only supported unit and specifying GB is optional" + }, + "DiskType": { + "type": { + "$ref": "#/36" + }, + "flags": 0, + "description": "Per worker DiskType resource. Shuffle optimized and Standard are only supported types and specifying diskType is optional" + }, + "Memory": { + "type": { + "$ref": "#/36" + }, + "flags": 1, + "description": "Per worker memory resource. GB is the only supported unit and specifying GB is optional." + } + } + }, + { + "$type": "ObjectType", + "name": "WorkerTypeSpecificationInput", + "properties": { + "ImageConfiguration": { + "type": { + "$ref": "#/11" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "WorkerTypeSpecificationInputMap", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "WorkerTypeString", + "properties": {} + }, + { + "$type": "StringType" + }, + { + "$type": "BooleanType" + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/18" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ObjectType", + "name": "Application_Properties", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/36" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/36" + } + }, + { + "$type": "ObjectType", + "name": "Application_S3MonitoringConfiguration", + "properties": { + "EncryptionKeyArn": { + "type": { + "$ref": "#/36" + }, + "flags": 0, + "description": "KMS key ARN to encrypt the logs stored in given s3" + }, + "LogUri": { + "type": { + "$ref": "#/36" + }, + "flags": 0 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/36" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/36" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EMRServerless/ApplicationProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/30" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EMRServerless/ApplicationProperties", + "properties": { + "ApplicationId": { + "type": { + "$ref": "#/36" + }, + "flags": 18, + "description": "The ID of the EMR Serverless Application." + }, + "Architecture": { + "type": { + "$ref": "#/36" + }, + "flags": 0 + }, + "Arn": { + "type": { + "$ref": "#/36" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) of the EMR Serverless Application." + }, + "AutoStartConfiguration": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Configuration for Auto Start of Application." + }, + "AutoStopConfiguration": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "Configuration for Auto Stop of Application." + }, + "ImageConfiguration": { + "type": { + "$ref": "#/11" + }, + "flags": 0 + }, + "InitialCapacity": { + "type": { + "$ref": "#/50" + }, + "flags": 0, + "description": "Initial capacity initialized when an Application is started." + }, + "MaximumCapacity": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "Maximum allowed cumulative resources for an Application. No new resources will be created once the limit is hit." + }, + "MonitoringConfiguration": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/36" + }, + "flags": 0, + "description": "User friendly Application name." + }, + "NetworkConfiguration": { + "type": { + "$ref": "#/24" + }, + "flags": 0, + "description": "Network Configuration for customer VPC connectivity." + }, + "ReleaseLabel": { + "type": { + "$ref": "#/36" + }, + "flags": 1, + "description": "EMR release label." + }, + "RuntimeConfiguration": { + "type": { + "$ref": "#/51" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/52" + }, + "flags": 0, + "description": "Tag map with key and value" + }, + "Type": { + "type": { + "$ref": "#/36" + }, + "flags": 1, + "description": "The type of the application" + }, + "WorkerTypeSpecifications": { + "type": { + "$ref": "#/34" + }, + "flags": 0, + "description": "The key-value pairs that specify worker type to WorkerTypeSpecificationInput. This parameter must contain all valid worker types for a Spark or Hive application. Valid worker types include Driver and Executor for Spark applications and HiveDriver and TezTask for Hive applications. You can either set image details in this parameter for each worker type, or in imageConfiguration for all worker types." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EMRServerless/Application", + "properties": { + "name": { + "type": { + "$ref": "#/36" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/36" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/53" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EMRServerless/Application@default", + "scopeType": 0, + "body": { + "$ref": "#/54" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.emrserverless/default/types.md b/artifacts/bicep/aws/aws.emrserverless/default/types.md index 142ac188..b70975e7 100644 --- a/artifacts/bicep/aws/aws.emrserverless/default/types.md +++ b/artifacts/bicep/aws/aws.emrserverless/default/types.md @@ -3,9 +3,26 @@ ## Resource AWS.EMRServerless/Application@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EMRServerless/ApplicationProperties](#awsemrserverlessapplicationproperties) (Required): properties of the resource +* **properties**: [AWS.EMRServerless/ApplicationProperties](#awsemrserverlessapplicationproperties) (Required, Identifier): properties of the resource + +## Application_Properties +### Properties + +## Application_S3MonitoringConfiguration +### Properties +* **EncryptionKeyArn**: string: KMS key ARN to encrypt the logs stored in given s3 +* **LogUri**: string + +## AutoStartConfiguration +### Properties +* **Enabled**: bool: If set to true, the Application will automatically start. Defaults to true. + +## AutoStopConfiguration +### Properties +* **Enabled**: bool: If set to true, the Application will automatically stop after being idle. Defaults to true. +* **IdleTimeoutMinutes**: int: The amount of time [in minutes] to wait before auto stopping the Application when idle. Defaults to 15 minutes. ## AWS.EMRServerless/ApplicationProperties ### Properties @@ -26,34 +43,43 @@ * **Type**: string (Required): The type of the application * **WorkerTypeSpecifications**: [WorkerTypeSpecificationInputMap](#workertypespecificationinputmap): The key-value pairs that specify worker type to WorkerTypeSpecificationInput. This parameter must contain all valid worker types for a Spark or Hive application. Valid worker types include Driver and Executor for Spark applications and HiveDriver and TezTask for Hive applications. You can either set image details in this parameter for each worker type, or in imageConfiguration for all worker types. -## AutoStartConfiguration +## CloudWatchLoggingConfiguration ### Properties -* **Enabled**: bool: If set to true, the Application will automatically start. Defaults to true. +* **Enabled**: bool: If set to false, CloudWatch logging will be turned off. Defaults to false. +* **EncryptionKeyArn**: string: KMS key ARN to encrypt the logs stored in given CloudWatch log-group. +* **LogGroupName**: string: Log-group name to produce log-streams on CloudWatch. If undefined, logs will be produced in a default log-group /aws/emr-serverless +* **LogStreamNamePrefix**: string: Log-stream name prefix by which log-stream names will start in the CloudWatch Log-group. +* **LogTypeMap**: [LogTypeMapKeyValuePair](#logtypemapkeyvaluepair)[]: The specific log-streams which need to be uploaded to CloudWatch. -## AutoStopConfiguration +## ConfigurationObject ### Properties -* **Enabled**: bool: If set to true, the Application will automatically stop after being idle. Defaults to true. -* **IdleTimeoutMinutes**: int: The amount of time [in minutes] to wait before auto stopping the Application when idle. Defaults to 15 minutes. +* **Classification**: string (Required): String with a maximum length of 1024. +* **Configurations**: [ConfigurationObject](#configurationobject)[] +* **Properties**: [Application_Properties](#applicationproperties) ## ImageConfigurationInput ### Properties * **ImageUri**: string: The URI of an image in the Amazon ECR registry. This field is required when you create a new application. If you leave this field blank in an update, Amazon EMR will remove the image configuration. +## InitialCapacityConfig +### Properties +* **WorkerConfiguration**: [WorkerConfiguration](#workerconfiguration) (Required) +* **WorkerCount**: int (Required): Initial count of workers to be initialized when an Application is started. This count will be continued to be maintained until the Application is stopped + ## InitialCapacityConfigKeyValuePair ### Properties * **Key**: string (Required): Worker type for an analytics framework. * **Value**: [InitialCapacityConfig](#initialcapacityconfig) (Required) -## InitialCapacityConfig +## LogTypeMapKeyValuePair ### Properties -* **WorkerConfiguration**: [WorkerConfiguration](#workerconfiguration) (Required) -* **WorkerCount**: int (Required): Initial count of workers to be initialized when an Application is started. This count will be continued to be maintained until the Application is stopped +* **Key**: string (Required) +* **Value**: string[] (Required) -## WorkerConfiguration +## ManagedPersistenceMonitoringConfiguration ### Properties -* **Cpu**: string (Required): Per worker CPU resource. vCPU is the only supported unit and specifying vCPU is optional. -* **Disk**: string: Per worker Disk resource. GB is the only supported unit and specifying GB is optional -* **Memory**: string (Required): Per worker memory resource. GB is the only supported unit and specifying GB is optional. +* **Enabled**: bool: If set to false, managed logging will be turned off. Defaults to true. +* **EncryptionKeyArn**: string: KMS key ARN to encrypt the logs stored in managed persistence ## MaximumAllowedResources ### Properties @@ -67,48 +93,23 @@ * **ManagedPersistenceMonitoringConfiguration**: [ManagedPersistenceMonitoringConfiguration](#managedpersistencemonitoringconfiguration): Managed log persistence configurations for a JobRun. * **S3MonitoringConfiguration**: [Application_S3MonitoringConfiguration](#applications3monitoringconfiguration): S3 monitoring configurations for a JobRun. -## CloudWatchLoggingConfiguration -### Properties -* **Enabled**: bool: If set to false, CloudWatch logging will be turned off. Defaults to false. -* **EncryptionKeyArn**: string: KMS key ARN to encrypt the logs stored in given CloudWatch log-group. -* **LogGroupName**: string: Log-group name to produce log-streams on CloudWatch. If undefined, logs will be produced in a default log-group /aws/emr-serverless -* **LogStreamNamePrefix**: string: Log-stream name prefix by which log-stream names will start in the CloudWatch Log-group. -* **LogTypeMap**: [LogTypeMapKeyValuePair](#logtypemapkeyvaluepair)[]: The specific log-streams which need to be uploaded to CloudWatch. - -## LogTypeMapKeyValuePair -### Properties -* **Key**: string (Required) -* **Value**: string[] (Required) - -## ManagedPersistenceMonitoringConfiguration -### Properties -* **Enabled**: bool: If set to false, managed logging will be turned off. Defaults to true. -* **EncryptionKeyArn**: string: KMS key ARN to encrypt the logs stored in managed persistence - -## Application_S3MonitoringConfiguration -### Properties -* **EncryptionKeyArn**: string: KMS key ARN to encrypt the logs stored in given s3 -* **LogUri**: string - ## NetworkConfiguration ### Properties * **SecurityGroupIds**: string[]: The ID of the security groups in the VPC to which you want to connect your job or application. * **SubnetIds**: string[]: The ID of the subnets in the VPC to which you want to connect your job or application. -## ConfigurationObject -### Properties -* **Classification**: string (Required): String with a maximum length of 1024. -* **Configurations**: [ConfigurationObject](#configurationobject)[] -* **Properties**: [Application_Properties](#applicationproperties) - -## Application_Properties -### Properties - ## Tag ### Properties * **Key**: string (Required): The value for the tag. You can specify a value that is 1 to 128 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. * **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +## WorkerConfiguration +### Properties +* **Cpu**: string (Required): Per worker CPU resource. vCPU is the only supported unit and specifying vCPU is optional. +* **Disk**: string: Per worker Disk resource. GB is the only supported unit and specifying GB is optional +* **DiskType**: string: Per worker DiskType resource. Shuffle optimized and Standard are only supported types and specifying diskType is optional +* **Memory**: string (Required): Per worker memory resource. GB is the only supported unit and specifying GB is optional. + ## WorkerTypeSpecificationInputMap ### Properties diff --git a/artifacts/bicep/aws/aws.entityresolution/default/types.json b/artifacts/bicep/aws/aws.entityresolution/default/types.json index 57136cbe..c055501e 100644 --- a/artifacts/bicep/aws/aws.entityresolution/default/types.json +++ b/artifacts/bicep/aws/aws.entityresolution/default/types.json @@ -1 +1,1262 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"AttributeName"}},{"2":{"Name":"CreatedAt"}},{"2":{"Name":"Description"}},{"2":{"Name":"EntityName"}},{"2":{"Name":"IdMappingTechniques","Properties":{"IdMappingType":{"Type":4,"Flags":0},"ProviderProperties":{"Type":18,"Flags":0}}}},{"2":{"Name":"IdMappingWorkflowArn"}},{"2":{"Name":"IdMappingWorkflowInputSource","Properties":{"InputSourceARN":{"Type":4,"Flags":1,"Description":"An Glue table ARN for the input source table"},"SchemaArn":{"Type":4,"Flags":1}}}},{"2":{"Name":"IdMappingWorkflowOutputSource","Properties":{"KMSArn":{"Type":4,"Flags":0},"OutputS3Path":{"Type":4,"Flags":1,"Description":"The S3 path to which Entity Resolution will write the output table"}}}},{"2":{"Name":"IntermediateSourceConfiguration","Properties":{"IntermediateS3Path":{"Type":4,"Flags":1,"Description":"The s3 path that would be used to stage the intermediate data being generated during workflow execution."}}}},{"2":{"Name":"KMSArn"}},{"2":{"Name":"ProviderProperties","Properties":{"IntermediateSourceConfiguration":{"Type":16,"Flags":0},"ProviderConfiguration":{"Type":22,"Flags":0,"Description":"Additional Provider configuration that would be required for the provider service. The Configuration must be in JSON string format"},"ProviderServiceArn":{"Type":4,"Flags":1,"Description":"Arn of the Provider Service being used."}}}},{"2":{"Name":"SchemaMappingArn"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"UpdatedAt"}},{"2":{"Name":"IdMappingWorkflow_ProviderConfiguration","Properties":{}}},{"2":{"Name":"AWS.EntityResolution/IdMappingWorkflowProperties","Properties":{"CreatedAt":{"Type":4,"Flags":2},"Description":{"Type":4,"Flags":0,"Description":"The description of the IdMappingWorkflow"},"IdMappingTechniques":{"Type":12,"Flags":1},"InputSourceConfig":{"Type":24,"Flags":1},"OutputSourceConfig":{"Type":25,"Flags":1},"RoleArn":{"Type":4,"Flags":1},"Tags":{"Type":26,"Flags":0},"UpdatedAt":{"Type":4,"Flags":2},"WorkflowArn":{"Type":4,"Flags":2},"WorkflowName":{"Type":4,"Flags":17,"Description":"The name of the IdMappingWorkflow"}}}},{"3":{"ItemType":14}},{"3":{"ItemType":15}},{"3":{"ItemType":20}},{"2":{"Name":"AWS.EntityResolution/IdMappingWorkflow","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":23,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EntityResolution/IdMappingWorkflow@default","ScopeType":0,"Body":27}},{"2":{"Name":"AttributeName"}},{"2":{"Name":"CreatedAt"}},{"2":{"Name":"Description"}},{"2":{"Name":"EntityName"}},{"2":{"Name":"InputSource","Properties":{"ApplyNormalization":{"Type":2,"Flags":0},"InputSourceARN":{"Type":4,"Flags":1,"Description":"An Glue table ARN for the input source table"},"SchemaArn":{"Type":4,"Flags":1}}}},{"2":{"Name":"IntermediateSourceConfiguration","Properties":{"IntermediateS3Path":{"Type":4,"Flags":1,"Description":"The s3 path that would be used to stage the intermediate data being generated during workflow execution."}}}},{"2":{"Name":"KMSArn"}},{"2":{"Name":"MatchingWorkflowArn"}},{"2":{"Name":"OutputAttribute","Properties":{"Hashed":{"Type":2,"Flags":0},"Name":{"Type":4,"Flags":1}}}},{"2":{"Name":"OutputSource","Properties":{"ApplyNormalization":{"Type":2,"Flags":0},"KMSArn":{"Type":4,"Flags":0},"Output":{"Type":46,"Flags":1},"OutputS3Path":{"Type":4,"Flags":1,"Description":"The S3 path to which Entity Resolution will write the output table"}}}},{"2":{"Name":"ProviderProperties","Properties":{"IntermediateSourceConfiguration":{"Type":34,"Flags":0},"ProviderConfiguration":{"Type":47,"Flags":0,"Description":"Additional Provider configuration that would be required for the provider service. The Configuration must be in JSON string format"},"ProviderServiceArn":{"Type":4,"Flags":1,"Description":"Arn of the Provider service being used."}}}},{"2":{"Name":"ResolutionTechniques","Properties":{"ProviderProperties":{"Type":39,"Flags":0},"ResolutionType":{"Type":4,"Flags":0},"RuleBasedProperties":{"Type":42,"Flags":0}}}},{"2":{"Name":"Rule","Properties":{"MatchingKeys":{"Type":48,"Flags":1},"RuleName":{"Type":4,"Flags":1}}}},{"2":{"Name":"RuleBasedProperties","Properties":{"AttributeMatchingModel":{"Type":4,"Flags":1},"Rules":{"Type":49,"Flags":1}}}},{"2":{"Name":"SchemaMappingArn"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"UpdatedAt"}},{"3":{"ItemType":37}},{"2":{"Name":"MatchingWorkflow_ProviderConfiguration","Properties":{}}},{"3":{"ItemType":4}},{"3":{"ItemType":41}},{"2":{"Name":"AWS.EntityResolution/MatchingWorkflowProperties","Properties":{"CreatedAt":{"Type":4,"Flags":2},"Description":{"Type":4,"Flags":0,"Description":"The description of the MatchingWorkflow"},"InputSourceConfig":{"Type":51,"Flags":1},"OutputSourceConfig":{"Type":52,"Flags":1},"ResolutionTechniques":{"Type":40,"Flags":1},"RoleArn":{"Type":4,"Flags":1},"Tags":{"Type":53,"Flags":0},"UpdatedAt":{"Type":4,"Flags":2},"WorkflowArn":{"Type":4,"Flags":2},"WorkflowName":{"Type":4,"Flags":17,"Description":"The name of the MatchingWorkflow"}}}},{"3":{"ItemType":33}},{"3":{"ItemType":38}},{"3":{"ItemType":44}},{"2":{"Name":"AWS.EntityResolution/MatchingWorkflow","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":50,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EntityResolution/MatchingWorkflow@default","ScopeType":0,"Body":54}},{"2":{"Name":"AttributeName"}},{"2":{"Name":"CreatedAt"}},{"2":{"Name":"Description"}},{"2":{"Name":"EntityName"}},{"2":{"Name":"HasWorkflows"}},{"2":{"Name":"MappedInputFields"}},{"2":{"Name":"SchemaAttributeType"}},{"2":{"Name":"SchemaInputAttribute","Properties":{"FieldName":{"Type":4,"Flags":1},"GroupName":{"Type":4,"Flags":0},"MatchKey":{"Type":4,"Flags":0},"SubType":{"Type":4,"Flags":0,"Description":"The subtype of the Attribute. Would be required only when type is PROVIDER_ID"},"Type":{"Type":4,"Flags":1}}}},{"2":{"Name":"SchemaMappingArn"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"UpdatedAt"}},{"3":{"ItemType":63}},{"2":{"Name":"AWS.EntityResolution/SchemaMappingProperties","Properties":{"CreatedAt":{"Type":4,"Flags":2},"Description":{"Type":4,"Flags":0,"Description":"The description of the SchemaMapping"},"HasWorkflows":{"Type":2,"Flags":2},"MappedInputFields":{"Type":69,"Flags":1,"Description":"The SchemaMapping attributes input"},"SchemaArn":{"Type":4,"Flags":2},"SchemaName":{"Type":4,"Flags":17,"Description":"The name of the SchemaMapping"},"Tags":{"Type":70,"Flags":0},"UpdatedAt":{"Type":4,"Flags":2}}}},{"3":{"ItemType":63}},{"3":{"ItemType":65}},{"2":{"Name":"AWS.EntityResolution/SchemaMapping","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":68,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EntityResolution/SchemaMapping@default","ScopeType":0,"Body":71}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "AttributeName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CreatedAt", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Description", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "EntityName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "IdMappingTechniques", + "properties": { + "IdMappingType": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + }, + "ProviderProperties": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "IdMappingWorkflowArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "IdMappingWorkflowInputSource", + "properties": { + "InputSourceARN": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "An Glue table ARN for the input source table or IdNamespace ARN" + }, + "SchemaArn": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "IdMappingWorkflowOutputSource", + "properties": { + "KMSArn": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + }, + "OutputS3Path": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The S3 path to which Entity Resolution will write the output table" + } + } + }, + { + "$type": "ObjectType", + "name": "IntermediateSourceConfiguration", + "properties": { + "IntermediateS3Path": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The s3 path that would be used to stage the intermediate data being generated during workflow execution." + } + } + }, + { + "$type": "ObjectType", + "name": "KMSArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ProviderProperties", + "properties": { + "IntermediateSourceConfiguration": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "ProviderConfiguration": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "Additional Provider configuration that would be required for the provider service. The Configuration must be in JSON string format" + }, + "ProviderServiceArn": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "Arn of the Provider Service being used." + } + } + }, + { + "$type": "ObjectType", + "name": "SchemaMappingArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "ObjectType", + "name": "UpdatedAt", + "properties": {} + }, + { + "$type": "StringType" + }, + { + "$type": "ObjectType", + "name": "IdMappingWorkflow_ProviderConfiguration", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.EntityResolution/IdMappingWorkflowProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/7" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/12" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EntityResolution/IdMappingWorkflowProperties", + "properties": { + "CreatedAt": { + "type": { + "$ref": "#/14" + }, + "flags": 2 + }, + "Description": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The description of the IdMappingWorkflow" + }, + "IdMappingTechniques": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + }, + "InputSourceConfig": { + "type": { + "$ref": "#/17" + }, + "flags": 1 + }, + "OutputSourceConfig": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "RoleArn": { + "type": { + "$ref": "#/14" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/19" + }, + "flags": 0 + }, + "UpdatedAt": { + "type": { + "$ref": "#/14" + }, + "flags": 2 + }, + "WorkflowArn": { + "type": { + "$ref": "#/14" + }, + "flags": 2 + }, + "WorkflowName": { + "type": { + "$ref": "#/14" + }, + "flags": 17, + "description": "The name of the IdMappingWorkflow" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EntityResolution/IdMappingWorkflow", + "properties": { + "name": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/14" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/20" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EntityResolution/IdMappingWorkflow@default", + "scopeType": 0, + "body": { + "$ref": "#/21" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "EntityName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "IdNamespaceIdMappingWorkflowProperties", + "properties": { + "IdMappingType": { + "type": { + "$ref": "#/14" + }, + "flags": 1 + }, + "ProviderProperties": { + "type": { + "$ref": "#/26" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "IdNamespaceInputSource", + "properties": { + "InputSourceARN": { + "type": { + "$ref": "#/14" + }, + "flags": 1 + }, + "SchemaName": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "NamespaceProviderProperties", + "properties": { + "ProviderConfiguration": { + "type": { + "$ref": "#/29" + }, + "flags": 0, + "description": "Additional Provider configuration that would be required for the provider service. The Configuration must be in JSON string format." + }, + "ProviderServiceArn": { + "type": { + "$ref": "#/14" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ProviderServiceArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "ObjectType", + "name": "IdNamespace_ProviderConfiguration", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.EntityResolution/IdNamespaceProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/24" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/25" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/28" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EntityResolution/IdNamespaceProperties", + "properties": { + "CreatedAt": { + "type": { + "$ref": "#/14" + }, + "flags": 2, + "description": "The date and time when the IdNamespace was created" + }, + "Description": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + }, + "IdMappingWorkflowProperties": { + "type": { + "$ref": "#/31" + }, + "flags": 0 + }, + "IdNamespaceArn": { + "type": { + "$ref": "#/14" + }, + "flags": 2, + "description": "The arn associated with the IdNamespace" + }, + "IdNamespaceName": { + "type": { + "$ref": "#/14" + }, + "flags": 17 + }, + "InputSourceConfig": { + "type": { + "$ref": "#/32" + }, + "flags": 0 + }, + "RoleArn": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/33" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/14" + }, + "flags": 1 + }, + "UpdatedAt": { + "type": { + "$ref": "#/14" + }, + "flags": 2, + "description": "The date and time when the IdNamespace was updated" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EntityResolution/IdNamespace", + "properties": { + "name": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/14" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/34" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EntityResolution/IdNamespace@default", + "scopeType": 0, + "body": { + "$ref": "#/35" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AttributeName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CreatedAt", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Description", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "EntityName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "InputSource", + "properties": { + "ApplyNormalization": { + "type": { + "$ref": "#/54" + }, + "flags": 0 + }, + "InputSourceARN": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "An Glue table ARN for the input source table" + }, + "SchemaArn": { + "type": { + "$ref": "#/14" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "IntermediateSourceConfiguration", + "properties": { + "IntermediateS3Path": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The s3 path that would be used to stage the intermediate data being generated during workflow execution." + } + } + }, + { + "$type": "ObjectType", + "name": "KMSArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MatchingWorkflowArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "OutputAttribute", + "properties": { + "Hashed": { + "type": { + "$ref": "#/54" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/14" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "OutputSource", + "properties": { + "ApplyNormalization": { + "type": { + "$ref": "#/54" + }, + "flags": 0 + }, + "KMSArn": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + }, + "Output": { + "type": { + "$ref": "#/55" + }, + "flags": 1 + }, + "OutputS3Path": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The S3 path to which Entity Resolution will write the output table" + } + } + }, + { + "$type": "ObjectType", + "name": "ProviderProperties", + "properties": { + "IntermediateSourceConfiguration": { + "type": { + "$ref": "#/42" + }, + "flags": 0 + }, + "ProviderConfiguration": { + "type": { + "$ref": "#/56" + }, + "flags": 0, + "description": "Additional Provider configuration that would be required for the provider service. The Configuration must be in JSON string format" + }, + "ProviderServiceArn": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "Arn of the Provider service being used." + } + } + }, + { + "$type": "ObjectType", + "name": "ResolutionTechniques", + "properties": { + "ProviderProperties": { + "type": { + "$ref": "#/47" + }, + "flags": 0 + }, + "ResolutionType": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + }, + "RuleBasedProperties": { + "type": { + "$ref": "#/50" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Rule", + "properties": { + "MatchingKeys": { + "type": { + "$ref": "#/57" + }, + "flags": 1 + }, + "RuleName": { + "type": { + "$ref": "#/14" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "RuleBasedProperties", + "properties": { + "AttributeMatchingModel": { + "type": { + "$ref": "#/14" + }, + "flags": 1 + }, + "Rules": { + "type": { + "$ref": "#/58" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "SchemaMappingArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "ObjectType", + "name": "UpdatedAt", + "properties": {} + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/45" + } + }, + { + "$type": "ObjectType", + "name": "MatchingWorkflow_ProviderConfiguration", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/14" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/49" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EntityResolution/MatchingWorkflowProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/41" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/46" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/52" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EntityResolution/MatchingWorkflowProperties", + "properties": { + "CreatedAt": { + "type": { + "$ref": "#/14" + }, + "flags": 2 + }, + "Description": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The description of the MatchingWorkflow" + }, + "InputSourceConfig": { + "type": { + "$ref": "#/60" + }, + "flags": 1 + }, + "OutputSourceConfig": { + "type": { + "$ref": "#/61" + }, + "flags": 1 + }, + "ResolutionTechniques": { + "type": { + "$ref": "#/48" + }, + "flags": 1 + }, + "RoleArn": { + "type": { + "$ref": "#/14" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/62" + }, + "flags": 0 + }, + "UpdatedAt": { + "type": { + "$ref": "#/14" + }, + "flags": 2 + }, + "WorkflowArn": { + "type": { + "$ref": "#/14" + }, + "flags": 2 + }, + "WorkflowName": { + "type": { + "$ref": "#/14" + }, + "flags": 17, + "description": "The name of the MatchingWorkflow" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EntityResolution/MatchingWorkflow", + "properties": { + "name": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/14" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/63" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EntityResolution/MatchingWorkflow@default", + "scopeType": 0, + "body": { + "$ref": "#/64" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "StatementAction", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "StatementActionList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "StatementCondition", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "StatementEffect", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "StatementId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "StatementPrincipal", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "StatementPrincipalList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "VeniceGlobalArn", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/14" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/14" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EntityResolution/PolicyStatementProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/14" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/14" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EntityResolution/PolicyStatementProperties", + "properties": { + "Action": { + "type": { + "$ref": "#/77" + }, + "flags": 0 + }, + "Arn": { + "type": { + "$ref": "#/14" + }, + "flags": 17 + }, + "Condition": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + }, + "Effect": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + }, + "Principal": { + "type": { + "$ref": "#/78" + }, + "flags": 0 + }, + "StatementId": { + "type": { + "$ref": "#/14" + }, + "flags": 17 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EntityResolution/PolicyStatement", + "properties": { + "name": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/14" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/79" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EntityResolution/PolicyStatement@default", + "scopeType": 0, + "body": { + "$ref": "#/80" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AttributeName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CreatedAt", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Description", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "EntityName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "HasWorkflows", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MappedInputFields", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SchemaAttributeType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SchemaInputAttribute", + "properties": { + "FieldName": { + "type": { + "$ref": "#/14" + }, + "flags": 1 + }, + "GroupName": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + }, + "MatchKey": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + }, + "SubType": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The subtype of the Attribute. Would be required only when type is PROVIDER_ID" + }, + "Type": { + "type": { + "$ref": "#/14" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "SchemaMappingArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "ObjectType", + "name": "UpdatedAt", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/89" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EntityResolution/SchemaMappingProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/89" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/91" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EntityResolution/SchemaMappingProperties", + "properties": { + "CreatedAt": { + "type": { + "$ref": "#/14" + }, + "flags": 2 + }, + "Description": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The description of the SchemaMapping" + }, + "HasWorkflows": { + "type": { + "$ref": "#/54" + }, + "flags": 2 + }, + "MappedInputFields": { + "type": { + "$ref": "#/95" + }, + "flags": 1, + "description": "The SchemaMapping attributes input" + }, + "SchemaArn": { + "type": { + "$ref": "#/14" + }, + "flags": 2 + }, + "SchemaName": { + "type": { + "$ref": "#/14" + }, + "flags": 17, + "description": "The name of the SchemaMapping" + }, + "Tags": { + "type": { + "$ref": "#/96" + }, + "flags": 0 + }, + "UpdatedAt": { + "type": { + "$ref": "#/14" + }, + "flags": 2 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EntityResolution/SchemaMapping", + "properties": { + "name": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/14" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/97" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EntityResolution/SchemaMapping@default", + "scopeType": 0, + "body": { + "$ref": "#/98" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.entityresolution/default/types.md b/artifacts/bicep/aws/aws.entityresolution/default/types.md index 4f7ea01e..16c1fcc3 100644 --- a/artifacts/bicep/aws/aws.entityresolution/default/types.md +++ b/artifacts/bicep/aws/aws.entityresolution/default/types.md @@ -3,23 +3,37 @@ ## Resource AWS.EntityResolution/IdMappingWorkflow@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EntityResolution/IdMappingWorkflowProperties](#awsentityresolutionidmappingworkflowproperties) (Required): properties of the resource +* **properties**: [AWS.EntityResolution/IdMappingWorkflowProperties](#awsentityresolutionidmappingworkflowproperties) (Required, Identifier): properties of the resource + +## Resource AWS.EntityResolution/IdNamespace@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.EntityResolution/IdNamespaceProperties](#awsentityresolutionidnamespaceproperties) (Required, Identifier): properties of the resource ## Resource AWS.EntityResolution/MatchingWorkflow@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EntityResolution/MatchingWorkflowProperties](#awsentityresolutionmatchingworkflowproperties) (Required): properties of the resource +* **properties**: [AWS.EntityResolution/MatchingWorkflowProperties](#awsentityresolutionmatchingworkflowproperties) (Required, Identifier): properties of the resource + +## Resource AWS.EntityResolution/PolicyStatement@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.EntityResolution/PolicyStatementProperties](#awsentityresolutionpolicystatementproperties) (Required, Identifier): properties of the resource ## Resource AWS.EntityResolution/SchemaMapping@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EntityResolution/SchemaMappingProperties](#awsentityresolutionschemamappingproperties) (Required): properties of the resource +* **properties**: [AWS.EntityResolution/SchemaMappingProperties](#awsentityresolutionschemamappingproperties) (Required, Identifier): properties of the resource ## AWS.EntityResolution/IdMappingWorkflowProperties ### Properties @@ -27,58 +41,90 @@ * **Description**: string: The description of the IdMappingWorkflow * **IdMappingTechniques**: [IdMappingTechniques](#idmappingtechniques) (Required) * **InputSourceConfig**: [IdMappingWorkflowInputSource](#idmappingworkflowinputsource)[] (Required) -* **OutputSourceConfig**: [IdMappingWorkflowOutputSource](#idmappingworkflowoutputsource)[] (Required) +* **OutputSourceConfig**: [IdMappingWorkflowOutputSource](#idmappingworkflowoutputsource)[] * **RoleArn**: string (Required) * **Tags**: [Tag](#tag)[] * **UpdatedAt**: string (ReadOnly) * **WorkflowArn**: string (ReadOnly) * **WorkflowName**: string (Required, Identifier): The name of the IdMappingWorkflow -## IdMappingTechniques +## AWS.EntityResolution/IdNamespaceProperties ### Properties -* **IdMappingType**: string -* **ProviderProperties**: [ProviderProperties](#providerproperties) +* **CreatedAt**: string (ReadOnly): The date and time when the IdNamespace was created +* **Description**: string +* **IdMappingWorkflowProperties**: [IdNamespaceIdMappingWorkflowProperties](#idnamespaceidmappingworkflowproperties)[] +* **IdNamespaceArn**: string (ReadOnly): The arn associated with the IdNamespace +* **IdNamespaceName**: string (Required, Identifier) +* **InputSourceConfig**: [IdNamespaceInputSource](#idnamespaceinputsource)[] +* **RoleArn**: string +* **Tags**: [Tag](#tag)[] +* **Type**: string (Required) +* **UpdatedAt**: string (ReadOnly): The date and time when the IdNamespace was updated -## ProviderProperties +## AWS.EntityResolution/MatchingWorkflowProperties ### Properties -* **IntermediateSourceConfiguration**: [IntermediateSourceConfiguration](#intermediatesourceconfiguration) -* **ProviderConfiguration**: [IdMappingWorkflow_ProviderConfiguration](#idmappingworkflowproviderconfiguration): Additional Provider configuration that would be required for the provider service. The Configuration must be in JSON string format -* **ProviderServiceArn**: string (Required): Arn of the Provider Service being used. +* **CreatedAt**: string (ReadOnly) +* **Description**: string: The description of the MatchingWorkflow +* **InputSourceConfig**: [InputSource](#inputsource)[] (Required) +* **OutputSourceConfig**: [OutputSource](#outputsource)[] (Required) +* **ResolutionTechniques**: [ResolutionTechniques](#resolutiontechniques) (Required) +* **RoleArn**: string (Required) +* **Tags**: [Tag](#tag)[] +* **UpdatedAt**: string (ReadOnly) +* **WorkflowArn**: string (ReadOnly) +* **WorkflowName**: string (Required, Identifier): The name of the MatchingWorkflow -## IntermediateSourceConfiguration +## AWS.EntityResolution/PolicyStatementProperties ### Properties -* **IntermediateS3Path**: string (Required): The s3 path that would be used to stage the intermediate data being generated during workflow execution. +* **Action**: string[] +* **Arn**: string (Required, Identifier) +* **Condition**: string +* **Effect**: string +* **Principal**: string[] +* **StatementId**: string (Required, Identifier) + +## AWS.EntityResolution/SchemaMappingProperties +### Properties +* **CreatedAt**: string (ReadOnly) +* **Description**: string: The description of the SchemaMapping +* **HasWorkflows**: bool (ReadOnly) +* **MappedInputFields**: [SchemaInputAttribute](#schemainputattribute)[] (Required): The SchemaMapping attributes input +* **SchemaArn**: string (ReadOnly) +* **SchemaName**: string (Required, Identifier): The name of the SchemaMapping +* **Tags**: [Tag](#tag)[] +* **UpdatedAt**: string (ReadOnly) + +## IdMappingTechniques +### Properties +* **IdMappingType**: string +* **ProviderProperties**: [ProviderProperties](#providerproperties) ## IdMappingWorkflow_ProviderConfiguration ### Properties ## IdMappingWorkflowInputSource ### Properties -* **InputSourceARN**: string (Required): An Glue table ARN for the input source table -* **SchemaArn**: string (Required) +* **InputSourceARN**: string (Required): An Glue table ARN for the input source table or IdNamespace ARN +* **SchemaArn**: string +* **Type**: string ## IdMappingWorkflowOutputSource ### Properties * **KMSArn**: string * **OutputS3Path**: string (Required): The S3 path to which Entity Resolution will write the output table -## Tag +## IdNamespace_ProviderConfiguration ### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -## AWS.EntityResolution/MatchingWorkflowProperties +## IdNamespaceIdMappingWorkflowProperties ### Properties -* **CreatedAt**: string (ReadOnly) -* **Description**: string: The description of the MatchingWorkflow -* **InputSourceConfig**: [InputSource](#inputsource)[] (Required) -* **OutputSourceConfig**: [OutputSource](#outputsource)[] (Required) -* **ResolutionTechniques**: [ResolutionTechniques](#resolutiontechniques) (Required) -* **RoleArn**: string (Required) -* **Tags**: [Tag](#tag)[] -* **UpdatedAt**: string (ReadOnly) -* **WorkflowArn**: string (ReadOnly) -* **WorkflowName**: string (Required, Identifier): The name of the MatchingWorkflow +* **IdMappingType**: string (Required) +* **ProviderProperties**: [NamespaceProviderProperties](#namespaceproviderproperties) + +## IdNamespaceInputSource +### Properties +* **InputSourceARN**: string (Required) +* **SchemaName**: string ## InputSource ### Properties @@ -86,23 +132,39 @@ * **InputSourceARN**: string (Required): An Glue table ARN for the input source table * **SchemaArn**: string (Required) -## OutputSource +## IntermediateSourceConfiguration ### Properties -* **ApplyNormalization**: bool -* **KMSArn**: string -* **Output**: [OutputAttribute](#outputattribute)[] (Required) -* **OutputS3Path**: string (Required): The S3 path to which Entity Resolution will write the output table +* **IntermediateS3Path**: string (Required): The s3 path that would be used to stage the intermediate data being generated during workflow execution. + +## IntermediateSourceConfiguration +### Properties +* **IntermediateS3Path**: string (Required): The s3 path that would be used to stage the intermediate data being generated during workflow execution. + +## MatchingWorkflow_ProviderConfiguration +### Properties + +## NamespaceProviderProperties +### Properties +* **ProviderConfiguration**: [IdNamespace_ProviderConfiguration](#idnamespaceproviderconfiguration): Additional Provider configuration that would be required for the provider service. The Configuration must be in JSON string format. +* **ProviderServiceArn**: string (Required) ## OutputAttribute ### Properties * **Hashed**: bool * **Name**: string (Required) -## ResolutionTechniques +## OutputSource ### Properties -* **ProviderProperties**: [ProviderProperties](#providerproperties) -* **ResolutionType**: string -* **RuleBasedProperties**: [RuleBasedProperties](#rulebasedproperties) +* **ApplyNormalization**: bool +* **KMSArn**: string +* **Output**: [OutputAttribute](#outputattribute)[] (Required) +* **OutputS3Path**: string (Required): The S3 path to which Entity Resolution will write the output table + +## ProviderProperties +### Properties +* **IntermediateSourceConfiguration**: [IntermediateSourceConfiguration](#intermediatesourceconfiguration) +* **ProviderConfiguration**: [IdMappingWorkflow_ProviderConfiguration](#idmappingworkflowproviderconfiguration): Additional Provider configuration that would be required for the provider service. The Configuration must be in JSON string format +* **ProviderServiceArn**: string (Required): Arn of the Provider Service being used. ## ProviderProperties ### Properties @@ -110,46 +172,44 @@ * **ProviderConfiguration**: [MatchingWorkflow_ProviderConfiguration](#matchingworkflowproviderconfiguration): Additional Provider configuration that would be required for the provider service. The Configuration must be in JSON string format * **ProviderServiceArn**: string (Required): Arn of the Provider service being used. -## IntermediateSourceConfiguration +## ResolutionTechniques ### Properties -* **IntermediateS3Path**: string (Required): The s3 path that would be used to stage the intermediate data being generated during workflow execution. +* **ProviderProperties**: [ProviderProperties](#providerproperties) +* **ResolutionType**: string +* **RuleBasedProperties**: [RuleBasedProperties](#rulebasedproperties) -## MatchingWorkflow_ProviderConfiguration +## Rule ### Properties +* **MatchingKeys**: string[] (Required) +* **RuleName**: string (Required) ## RuleBasedProperties ### Properties * **AttributeMatchingModel**: string (Required) * **Rules**: [Rule](#rule)[] (Required) -## Rule +## SchemaInputAttribute ### Properties -* **MatchingKeys**: string[] (Required) -* **RuleName**: string (Required) +* **FieldName**: string (Required) +* **GroupName**: string +* **MatchKey**: string +* **SubType**: string: The subtype of the Attribute. Would be required only when type is PROVIDER_ID +* **Type**: string (Required) ## Tag ### Properties * **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. * **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -## AWS.EntityResolution/SchemaMappingProperties +## Tag ### Properties -* **CreatedAt**: string (ReadOnly) -* **Description**: string: The description of the SchemaMapping -* **HasWorkflows**: bool (ReadOnly) -* **MappedInputFields**: [SchemaInputAttribute](#schemainputattribute)[] (Required): The SchemaMapping attributes input -* **SchemaArn**: string (ReadOnly) -* **SchemaName**: string (Required, Identifier): The name of the SchemaMapping -* **Tags**: [Tag](#tag)[] -* **UpdatedAt**: string (ReadOnly) +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -## SchemaInputAttribute +## Tag ### Properties -* **FieldName**: string (Required) -* **GroupName**: string -* **MatchKey**: string -* **SubType**: string: The subtype of the Attribute. Would be required only when type is PROVIDER_ID -* **Type**: string (Required) +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ## Tag ### Properties diff --git a/artifacts/bicep/aws/aws.events/default/types.json b/artifacts/bicep/aws/aws.events/default/types.json index bd06818c..929d0f3c 100644 --- a/artifacts/bicep/aws/aws.events/default/types.json +++ b/artifacts/bicep/aws/aws.events/default/types.json @@ -1 +1,1631 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"AWS.Events/ApiDestinationProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"The arn of the api destination."},"ConnectionArn":{"Type":4,"Flags":1,"Description":"The arn of the connection."},"Description":{"Type":4,"Flags":0},"HttpMethod":{"Type":4,"Flags":1},"InvocationEndpoint":{"Type":4,"Flags":1,"Description":"Url endpoint to invoke."},"InvocationRateLimitPerSecond":{"Type":3,"Flags":0},"Name":{"Type":4,"Flags":16,"Description":"Name of the apiDestination."}}}},{"2":{"Name":"AWS.Events/ApiDestination","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":8,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Events/ApiDestination@default","ScopeType":0,"Body":9}},{"2":{"Name":"AWS.Events/ArchiveProperties","Properties":{"ArchiveName":{"Type":4,"Flags":16},"Arn":{"Type":4,"Flags":2},"Description":{"Type":4,"Flags":0},"EventPattern":{"Type":12,"Flags":0},"RetentionDays":{"Type":3,"Flags":0},"SourceArn":{"Type":4,"Flags":1}}}},{"2":{"Name":"Archive_EventPattern","Properties":{}}},{"2":{"Name":"AWS.Events/Archive","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":11,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Events/Archive@default","ScopeType":0,"Body":13}},{"2":{"Name":"ApiKeyAuthParameters","Properties":{"ApiKeyName":{"Type":4,"Flags":1},"ApiKeyValue":{"Type":4,"Flags":1}}}},{"2":{"Name":"AuthParameters","Properties":{"ApiKeyAuthParameters":{"Type":15,"Flags":0},"BasicAuthParameters":{"Type":17,"Flags":0},"InvocationHttpParameters":{"Type":19,"Flags":0},"OAuthParameters":{"Type":20,"Flags":0}}}},{"2":{"Name":"BasicAuthParameters","Properties":{"Password":{"Type":4,"Flags":1},"Username":{"Type":4,"Flags":1}}}},{"2":{"Name":"ClientParameters","Properties":{"ClientID":{"Type":4,"Flags":1},"ClientSecret":{"Type":4,"Flags":1}}}},{"2":{"Name":"ConnectionHttpParameters","Properties":{"BodyParameters":{"Type":22,"Flags":0},"HeaderParameters":{"Type":23,"Flags":0},"QueryStringParameters":{"Type":24,"Flags":0}}}},{"2":{"Name":"OAuthParameters","Properties":{"AuthorizationEndpoint":{"Type":4,"Flags":1},"ClientParameters":{"Type":18,"Flags":1},"HttpMethod":{"Type":4,"Flags":1},"OAuthHttpParameters":{"Type":19,"Flags":0}}}},{"2":{"Name":"Parameter","Properties":{"IsValueSecret":{"Type":2,"Flags":0},"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"3":{"ItemType":21}},{"3":{"ItemType":21}},{"3":{"ItemType":21}},{"2":{"Name":"AWS.Events/ConnectionProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"The arn of the connection resource."},"AuthParameters":{"Type":16,"Flags":5},"AuthorizationType":{"Type":4,"Flags":1},"Description":{"Type":4,"Flags":0,"Description":"Description of the connection."},"Name":{"Type":4,"Flags":16,"Description":"Name of the connection."},"SecretArn":{"Type":4,"Flags":2,"Description":"The arn of the secrets manager secret created in the customer account."}}}},{"2":{"Name":"AWS.Events/Connection","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":25,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Events/Connection@default","ScopeType":0,"Body":26}},{"2":{"Name":"EndpointEventBus","Properties":{"EventBusArn":{"Type":4,"Flags":1}}}},{"2":{"Name":"EventBusArn"}},{"2":{"Name":"EventBuses"}},{"2":{"Name":"FailoverConfig","Properties":{"Primary":{"Type":33,"Flags":1},"Secondary":{"Type":38,"Flags":1}}}},{"2":{"Name":"HealthCheck"}},{"2":{"Name":"Primary","Properties":{"HealthCheck":{"Type":4,"Flags":1}}}},{"2":{"Name":"ReplicationConfig","Properties":{"State":{"Type":4,"Flags":1}}}},{"2":{"Name":"ReplicationState"}},{"2":{"Name":"Route"}},{"2":{"Name":"RoutingConfig","Properties":{"FailoverConfig":{"Type":31,"Flags":1}}}},{"2":{"Name":"Secondary","Properties":{"Route":{"Type":4,"Flags":1}}}},{"3":{"ItemType":28}},{"2":{"Name":"AWS.Events/EndpointProperties","Properties":{"Arn":{"Type":4,"Flags":2},"Description":{"Type":4,"Flags":0},"EndpointId":{"Type":4,"Flags":2},"EndpointUrl":{"Type":4,"Flags":2},"EventBuses":{"Type":41,"Flags":1},"Name":{"Type":4,"Flags":16},"ReplicationConfig":{"Type":34,"Flags":0},"RoleArn":{"Type":4,"Flags":0},"RoutingConfig":{"Type":37,"Flags":1},"State":{"Type":4,"Flags":2},"StateReason":{"Type":4,"Flags":2}}}},{"3":{"ItemType":28}},{"2":{"Name":"AWS.Events/Endpoint","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":40,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Events/Endpoint@default","ScopeType":0,"Body":42}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.Events/EventBusProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) for the event bus."},"EventSourceName":{"Type":4,"Flags":4,"Description":"If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with."},"Name":{"Type":4,"Flags":17,"Description":"The name of the event bus."},"Policy":{"Type":47,"Flags":0,"Description":"A JSON string that describes the permission policy statement for the event bus."},"Tags":{"Type":48,"Flags":0,"Description":"Any tags assigned to the event bus."}}}},{"2":{"Name":"EventBus_Policy","Properties":{}}},{"5":{"Elements":[46,4]}},{"3":{"ItemType":44}},{"2":{"Name":"AWS.Events/EventBus","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":45,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Events/EventBus@default","ScopeType":0,"Body":49}},{"2":{"Name":"AppSyncParameters","Properties":{"GraphQLOperation":{"Type":4,"Flags":1}}}},{"2":{"Name":"AwsVpcConfiguration","Properties":{"AssignPublicIp":{"Type":4,"Flags":0},"SecurityGroups":{"Type":74,"Flags":0},"Subnets":{"Type":75,"Flags":1}}}},{"2":{"Name":"BatchArrayProperties","Properties":{"Size":{"Type":3,"Flags":0}}}},{"2":{"Name":"BatchParameters","Properties":{"ArrayProperties":{"Type":53,"Flags":0},"JobDefinition":{"Type":4,"Flags":1},"JobName":{"Type":4,"Flags":1},"RetryStrategy":{"Type":55,"Flags":0}}}},{"2":{"Name":"BatchRetryStrategy","Properties":{"Attempts":{"Type":3,"Flags":0}}}},{"2":{"Name":"CapacityProviderStrategyItem","Properties":{"Base":{"Type":3,"Flags":0},"CapacityProvider":{"Type":4,"Flags":1},"Weight":{"Type":3,"Flags":0}}}},{"2":{"Name":"DeadLetterConfig","Properties":{"Arn":{"Type":4,"Flags":16}}}},{"2":{"Name":"EcsParameters","Properties":{"CapacityProviderStrategy":{"Type":76,"Flags":0},"EnableECSManagedTags":{"Type":2,"Flags":0},"EnableExecuteCommand":{"Type":2,"Flags":0},"Group":{"Type":4,"Flags":0},"LaunchType":{"Type":4,"Flags":0},"NetworkConfiguration":{"Type":62,"Flags":0},"PlacementConstraints":{"Type":77,"Flags":0},"PlacementStrategies":{"Type":78,"Flags":0},"PlatformVersion":{"Type":4,"Flags":0},"PropagateTags":{"Type":4,"Flags":0},"ReferenceId":{"Type":4,"Flags":0},"TagList":{"Type":79,"Flags":0},"TaskCount":{"Type":3,"Flags":0},"TaskDefinitionArn":{"Type":4,"Flags":1}}}},{"2":{"Name":"HttpParameters","Properties":{"HeaderParameters":{"Type":80,"Flags":0},"PathParameterValues":{"Type":81,"Flags":0},"QueryStringParameters":{"Type":82,"Flags":0}}}},{"2":{"Name":"InputTransformer","Properties":{"InputPathsMap":{"Type":83,"Flags":0},"InputTemplate":{"Type":4,"Flags":1}}}},{"2":{"Name":"KinesisParameters","Properties":{"PartitionKeyPath":{"Type":4,"Flags":1}}}},{"2":{"Name":"NetworkConfiguration","Properties":{"AwsVpcConfiguration":{"Type":52,"Flags":0}}}},{"2":{"Name":"PlacementConstraint","Properties":{"Expression":{"Type":4,"Flags":0},"Type":{"Type":4,"Flags":0}}}},{"2":{"Name":"PlacementStrategy","Properties":{"Field":{"Type":4,"Flags":0},"Type":{"Type":4,"Flags":0}}}},{"2":{"Name":"RedshiftDataParameters","Properties":{"Database":{"Type":4,"Flags":1},"DbUser":{"Type":4,"Flags":0},"SecretManagerArn":{"Type":4,"Flags":0},"Sql":{"Type":4,"Flags":0},"Sqls":{"Type":84,"Flags":0},"StatementName":{"Type":4,"Flags":0},"WithEvent":{"Type":2,"Flags":0}}}},{"2":{"Name":"RetryPolicy","Properties":{"MaximumEventAgeInSeconds":{"Type":3,"Flags":0},"MaximumRetryAttempts":{"Type":3,"Flags":0}}}},{"2":{"Name":"RunCommandParameters","Properties":{"RunCommandTargets":{"Type":85,"Flags":1}}}},{"2":{"Name":"RunCommandTarget","Properties":{"Key":{"Type":4,"Flags":1},"Values":{"Type":86,"Flags":1}}}},{"2":{"Name":"SageMakerPipelineParameter","Properties":{"Name":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"SageMakerPipelineParameters","Properties":{"PipelineParameterList":{"Type":87,"Flags":0}}}},{"2":{"Name":"SqsParameters","Properties":{"MessageGroupId":{"Type":4,"Flags":1}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":0},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"Target","Properties":{"AppSyncParameters":{"Type":51,"Flags":0},"Arn":{"Type":4,"Flags":17},"BatchParameters":{"Type":54,"Flags":0},"DeadLetterConfig":{"Type":57,"Flags":0},"EcsParameters":{"Type":58,"Flags":0},"HttpParameters":{"Type":59,"Flags":0},"Id":{"Type":4,"Flags":1},"Input":{"Type":4,"Flags":0},"InputPath":{"Type":4,"Flags":0},"InputTransformer":{"Type":60,"Flags":0},"KinesisParameters":{"Type":61,"Flags":0},"RedshiftDataParameters":{"Type":65,"Flags":0},"RetryPolicy":{"Type":66,"Flags":0},"RoleArn":{"Type":4,"Flags":0},"RunCommandParameters":{"Type":67,"Flags":0},"SageMakerPipelineParameters":{"Type":70,"Flags":0},"SqsParameters":{"Type":71,"Flags":0}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":56}},{"3":{"ItemType":63}},{"3":{"ItemType":64}},{"3":{"ItemType":72}},{"2":{"Name":"Rule_HeaderParameters","Properties":{}}},{"3":{"ItemType":4}},{"2":{"Name":"Rule_QueryStringParameters","Properties":{}}},{"2":{"Name":"Rule_InputPathsMap","Properties":{}}},{"3":{"ItemType":4}},{"3":{"ItemType":68}},{"3":{"ItemType":4}},{"3":{"ItemType":69}},{"2":{"Name":"AWS.Events/RuleProperties","Properties":{"Arn":{"Type":4,"Flags":18,"Description":"The ARN of the rule, such as arn:aws:events:us-east-2:123456789012:rule/example."},"Description":{"Type":4,"Flags":0,"Description":"The description of the rule."},"EventBusName":{"Type":4,"Flags":0,"Description":"The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used."},"EventPattern":{"Type":90,"Flags":0,"Description":"The event pattern of the rule. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide."},"Name":{"Type":4,"Flags":0,"Description":"The name of the rule."},"RoleArn":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) of the role that is used for target invocation."},"ScheduleExpression":{"Type":4,"Flags":0,"Description":"The scheduling expression. For example, \"cron(0 20 * * ? *)\", \"rate(5 minutes)\". For more information, see Creating an Amazon EventBridge rule that runs on a schedule."},"State":{"Type":4,"Flags":0,"Description":"The state of the rule."},"Targets":{"Type":91,"Flags":0,"Description":"Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule.\nTargets are the resources that are invoked when a rule is triggered."}}}},{"2":{"Name":"Rule_EventPattern","Properties":{}}},{"5":{"Elements":[4,89]}},{"3":{"ItemType":73}},{"2":{"Name":"AWS.Events/Rule","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":88,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Events/Rule@default","ScopeType":0,"Body":92}}] \ No newline at end of file +[ + { + "$type": "StringLiteralType", + "value": "AWS.Events/ApiDestinationProperties" + }, + { + "$type": "StringType" + }, + { + "$type": "IntegerType" + }, + { + "$type": "ObjectType", + "name": "AWS.Events/ApiDestinationProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The arn of the api destination." + }, + "ConnectionArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The arn of the connection." + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "HttpMethod": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "InvocationEndpoint": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Url endpoint to invoke." + }, + "InvocationRateLimitPerSecond": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 16, + "description": "Name of the apiDestination." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Events/ApiDestination", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Events/ApiDestination@default", + "scopeType": 0, + "body": { + "$ref": "#/4" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.Events/ArchiveProperties" + }, + { + "$type": "ObjectType", + "name": "Archive_EventPattern", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AWS.Events/ArchiveProperties", + "properties": { + "ArchiveName": { + "type": { + "$ref": "#/1" + }, + "flags": 16 + }, + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "EventPattern": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "RetentionDays": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "SourceArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Events/Archive", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/8" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Events/Archive@default", + "scopeType": 0, + "body": { + "$ref": "#/9" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "ApiKeyAuthParameters", + "properties": { + "ApiKeyName": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "ApiKeyValue": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AuthParameters", + "properties": { + "ApiKeyAuthParameters": { + "type": { + "$ref": "#/11" + }, + "flags": 0 + }, + "BasicAuthParameters": { + "type": { + "$ref": "#/13" + }, + "flags": 0 + }, + "InvocationHttpParameters": { + "type": { + "$ref": "#/15" + }, + "flags": 0 + }, + "OAuthParameters": { + "type": { + "$ref": "#/16" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BasicAuthParameters", + "properties": { + "Password": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Username": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ClientParameters", + "properties": { + "ClientID": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "ClientSecret": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ConnectionHttpParameters", + "properties": { + "BodyParameters": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "HeaderParameters": { + "type": { + "$ref": "#/19" + }, + "flags": 0 + }, + "QueryStringParameters": { + "type": { + "$ref": "#/20" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "OAuthParameters", + "properties": { + "AuthorizationEndpoint": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "ClientParameters": { + "type": { + "$ref": "#/14" + }, + "flags": 1 + }, + "HttpMethod": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "OAuthHttpParameters": { + "type": { + "$ref": "#/15" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Parameter", + "properties": { + "IsValueSecret": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/17" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/17" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/17" + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.Events/ConnectionProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.Events/ConnectionProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The arn of the connection resource." + }, + "AuthParameters": { + "type": { + "$ref": "#/12" + }, + "flags": 5 + }, + "AuthorizationType": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Description of the connection." + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 16, + "description": "Name of the connection." + }, + "SecretArn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The arn of the secrets manager secret created in the customer account." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Events/Connection", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/23" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Events/Connection@default", + "scopeType": 0, + "body": { + "$ref": "#/24" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "EndpointEventBus", + "properties": { + "EventBusArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "EventBusArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "EventBuses", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "FailoverConfig", + "properties": { + "Primary": { + "type": { + "$ref": "#/31" + }, + "flags": 1 + }, + "Secondary": { + "type": { + "$ref": "#/36" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "HealthCheck", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Primary", + "properties": { + "HealthCheck": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ReplicationConfig", + "properties": { + "State": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ReplicationState", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Route", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RoutingConfig", + "properties": { + "FailoverConfig": { + "type": { + "$ref": "#/29" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Secondary", + "properties": { + "Route": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/26" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Events/EndpointProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/26" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Events/EndpointProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "EndpointId": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "EndpointUrl": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "EventBuses": { + "type": { + "$ref": "#/39" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 16 + }, + "ReplicationConfig": { + "type": { + "$ref": "#/32" + }, + "flags": 0 + }, + "RoleArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "RoutingConfig": { + "type": { + "$ref": "#/35" + }, + "flags": 1 + }, + "State": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "StateReason": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Events/Endpoint", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/40" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Events/Endpoint@default", + "scopeType": 0, + "body": { + "$ref": "#/41" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Events/EventBusProperties" + }, + { + "$type": "ObjectType", + "name": "EventBus_DeadLetterConfig", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "EventBus_Policy", + "properties": {} + }, + { + "$type": "UnionType", + "elements": [ + { + "$ref": "#/46" + }, + { + "$ref": "#/1" + } + ] + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/43" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Events/EventBusProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) for the event bus." + }, + "DeadLetterConfig": { + "type": { + "$ref": "#/45" + }, + "flags": 0, + "description": "Dead Letter Queue for the event bus." + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The description of the event bus." + }, + "EventSourceName": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with." + }, + "KmsKeyIdentifier": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Kms Key Identifier used to encrypt events at rest in the event bus." + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The name of the event bus." + }, + "Policy": { + "type": { + "$ref": "#/47" + }, + "flags": 0, + "description": "A JSON string that describes the permission policy statement for the event bus." + }, + "Tags": { + "type": { + "$ref": "#/48" + }, + "flags": 0, + "description": "Any tags assigned to the event bus." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Events/EventBus", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/49" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Events/EventBus@default", + "scopeType": 0, + "body": { + "$ref": "#/50" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AppSyncParameters", + "properties": { + "GraphQLOperation": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AwsVpcConfiguration", + "properties": { + "AssignPublicIp": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "SecurityGroups": { + "type": { + "$ref": "#/75" + }, + "flags": 0 + }, + "Subnets": { + "type": { + "$ref": "#/76" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "BatchArrayProperties", + "properties": { + "Size": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BatchParameters", + "properties": { + "ArrayProperties": { + "type": { + "$ref": "#/54" + }, + "flags": 0 + }, + "JobDefinition": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "JobName": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "RetryStrategy": { + "type": { + "$ref": "#/56" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BatchRetryStrategy", + "properties": { + "Attempts": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CapacityProviderStrategyItem", + "properties": { + "Base": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "CapacityProvider": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Weight": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DeadLetterConfig", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 16 + } + } + }, + { + "$type": "ObjectType", + "name": "EcsParameters", + "properties": { + "CapacityProviderStrategy": { + "type": { + "$ref": "#/77" + }, + "flags": 0 + }, + "EnableECSManagedTags": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "EnableExecuteCommand": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "Group": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "LaunchType": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "NetworkConfiguration": { + "type": { + "$ref": "#/63" + }, + "flags": 0 + }, + "PlacementConstraints": { + "type": { + "$ref": "#/78" + }, + "flags": 0 + }, + "PlacementStrategies": { + "type": { + "$ref": "#/79" + }, + "flags": 0 + }, + "PlatformVersion": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "PropagateTags": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "ReferenceId": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "TagList": { + "type": { + "$ref": "#/80" + }, + "flags": 0 + }, + "TaskCount": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "TaskDefinitionArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "HttpParameters", + "properties": { + "HeaderParameters": { + "type": { + "$ref": "#/81" + }, + "flags": 0 + }, + "PathParameterValues": { + "type": { + "$ref": "#/82" + }, + "flags": 0 + }, + "QueryStringParameters": { + "type": { + "$ref": "#/83" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "InputTransformer", + "properties": { + "InputPathsMap": { + "type": { + "$ref": "#/84" + }, + "flags": 0 + }, + "InputTemplate": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "KinesisParameters", + "properties": { + "PartitionKeyPath": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "NetworkConfiguration", + "properties": { + "AwsVpcConfiguration": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PlacementConstraint", + "properties": { + "Expression": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PlacementStrategy", + "properties": { + "Field": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "RedshiftDataParameters", + "properties": { + "Database": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "DbUser": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "SecretManagerArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "Sql": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "Sqls": { + "type": { + "$ref": "#/85" + }, + "flags": 0 + }, + "StatementName": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "WithEvent": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "RetryPolicy", + "properties": { + "MaximumEventAgeInSeconds": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "MaximumRetryAttempts": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "RunCommandParameters", + "properties": { + "RunCommandTargets": { + "type": { + "$ref": "#/86" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "RunCommandTarget", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Values": { + "type": { + "$ref": "#/87" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "SageMakerPipelineParameter", + "properties": { + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "SageMakerPipelineParameters", + "properties": { + "PipelineParameterList": { + "type": { + "$ref": "#/88" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SqsParameters", + "properties": { + "MessageGroupId": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Target", + "properties": { + "AppSyncParameters": { + "type": { + "$ref": "#/52" + }, + "flags": 0 + }, + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 17 + }, + "BatchParameters": { + "type": { + "$ref": "#/55" + }, + "flags": 0 + }, + "DeadLetterConfig": { + "type": { + "$ref": "#/58" + }, + "flags": 0 + }, + "EcsParameters": { + "type": { + "$ref": "#/59" + }, + "flags": 0 + }, + "HttpParameters": { + "type": { + "$ref": "#/60" + }, + "flags": 0 + }, + "Id": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Input": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "InputPath": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "InputTransformer": { + "type": { + "$ref": "#/61" + }, + "flags": 0 + }, + "KinesisParameters": { + "type": { + "$ref": "#/62" + }, + "flags": 0 + }, + "RedshiftDataParameters": { + "type": { + "$ref": "#/66" + }, + "flags": 0 + }, + "RetryPolicy": { + "type": { + "$ref": "#/67" + }, + "flags": 0 + }, + "RoleArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "RunCommandParameters": { + "type": { + "$ref": "#/68" + }, + "flags": 0 + }, + "SageMakerPipelineParameters": { + "type": { + "$ref": "#/71" + }, + "flags": 0 + }, + "SqsParameters": { + "type": { + "$ref": "#/72" + }, + "flags": 0 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/57" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/64" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/65" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/73" + } + }, + { + "$type": "ObjectType", + "name": "Rule_HeaderParameters", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "Rule_QueryStringParameters", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Rule_InputPathsMap", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/69" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/70" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Events/RuleProperties" + }, + { + "$type": "ObjectType", + "name": "Rule_EventPattern", + "properties": {} + }, + { + "$type": "UnionType", + "elements": [ + { + "$ref": "#/1" + }, + { + "$ref": "#/90" + } + ] + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/74" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Events/RuleProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The ARN of the rule, such as arn:aws:events:us-east-2:123456789012:rule/example." + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The description of the rule." + }, + "EventBusName": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used." + }, + "EventPattern": { + "type": { + "$ref": "#/91" + }, + "flags": 0, + "description": "The event pattern of the rule. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide." + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The name of the rule." + }, + "RoleArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the role that is used for target invocation." + }, + "ScheduleExpression": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The scheduling expression. For example, \"cron(0 20 * * ? *)\", \"rate(5 minutes)\". For more information, see Creating an Amazon EventBridge rule that runs on a schedule." + }, + "State": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The state of the rule." + }, + "Targets": { + "type": { + "$ref": "#/92" + }, + "flags": 0, + "description": "Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule.\nTargets are the resources that are invoked when a rule is triggered." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Events/Rule", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/93" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Events/Rule@default", + "scopeType": 0, + "body": { + "$ref": "#/94" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.events/default/types.md b/artifacts/bicep/aws/aws.events/default/types.md index 81767e91..a7408a38 100644 --- a/artifacts/bicep/aws/aws.events/default/types.md +++ b/artifacts/bicep/aws/aws.events/default/types.md @@ -3,44 +3,63 @@ ## Resource AWS.Events/ApiDestination@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Events/ApiDestinationProperties](#awseventsapidestinationproperties) (Required): properties of the resource +* **properties**: [AWS.Events/ApiDestinationProperties](#awseventsapidestinationproperties) (Required, Identifier): properties of the resource ## Resource AWS.Events/Archive@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Events/ArchiveProperties](#awseventsarchiveproperties) (Required): properties of the resource +* **properties**: [AWS.Events/ArchiveProperties](#awseventsarchiveproperties) (Required, Identifier): properties of the resource ## Resource AWS.Events/Connection@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Events/ConnectionProperties](#awseventsconnectionproperties) (Required): properties of the resource +* **properties**: [AWS.Events/ConnectionProperties](#awseventsconnectionproperties) (Required, Identifier): properties of the resource ## Resource AWS.Events/Endpoint@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Events/EndpointProperties](#awseventsendpointproperties) (Required): properties of the resource +* **properties**: [AWS.Events/EndpointProperties](#awseventsendpointproperties) (Required, Identifier): properties of the resource ## Resource AWS.Events/EventBus@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Events/EventBusProperties](#awseventseventbusproperties) (Required): properties of the resource +* **properties**: [AWS.Events/EventBusProperties](#awseventseventbusproperties) (Required, Identifier): properties of the resource ## Resource AWS.Events/Rule@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Events/RuleProperties](#awseventsruleproperties): properties of the resource +* **properties**: [AWS.Events/RuleProperties](#awseventsruleproperties) (Identifier): properties of the resource + +## ApiKeyAuthParameters +### Properties +* **ApiKeyName**: string (Required) +* **ApiKeyValue**: string (Required) + +## AppSyncParameters +### Properties +* **GraphQLOperation**: string (Required) + +## Archive_EventPattern +### Properties + +## AuthParameters +### Properties +* **ApiKeyAuthParameters**: [ApiKeyAuthParameters](#apikeyauthparameters) +* **BasicAuthParameters**: [BasicAuthParameters](#basicauthparameters) +* **InvocationHttpParameters**: [ConnectionHttpParameters](#connectionhttpparameters) +* **OAuthParameters**: [OAuthParameters](#oauthparameters) ## AWS.Events/ApiDestinationProperties ### Properties @@ -61,9 +80,6 @@ * **RetentionDays**: int * **SourceArn**: string (Required) -## Archive_EventPattern -### Properties - ## AWS.Events/ConnectionProperties ### Properties * **Arn**: string (ReadOnly): The arn of the connection resource. @@ -73,47 +89,6 @@ * **Name**: string (Identifier): Name of the connection. * **SecretArn**: string (ReadOnly): The arn of the secrets manager secret created in the customer account. -## AuthParameters -### Properties -* **ApiKeyAuthParameters**: [ApiKeyAuthParameters](#apikeyauthparameters) -* **BasicAuthParameters**: [BasicAuthParameters](#basicauthparameters) -* **InvocationHttpParameters**: [ConnectionHttpParameters](#connectionhttpparameters) -* **OAuthParameters**: [OAuthParameters](#oauthparameters) - -## ApiKeyAuthParameters -### Properties -* **ApiKeyName**: string (Required) -* **ApiKeyValue**: string (Required) - -## BasicAuthParameters -### Properties -* **Password**: string (Required) -* **Username**: string (Required) - -## ConnectionHttpParameters -### Properties -* **BodyParameters**: [Parameter](#parameter)[] -* **HeaderParameters**: [Parameter](#parameter)[] -* **QueryStringParameters**: [Parameter](#parameter)[] - -## Parameter -### Properties -* **IsValueSecret**: bool -* **Key**: string (Required) -* **Value**: string (Required) - -## OAuthParameters -### Properties -* **AuthorizationEndpoint**: string (Required) -* **ClientParameters**: [ClientParameters](#clientparameters) (Required) -* **HttpMethod**: string (Required) -* **OAuthHttpParameters**: [ConnectionHttpParameters](#connectionhttpparameters) - -## ClientParameters -### Properties -* **ClientID**: string (Required) -* **ClientSecret**: string (Required) - ## AWS.Events/EndpointProperties ### Properties * **Arn**: string (ReadOnly) @@ -128,44 +103,17 @@ * **State**: string (ReadOnly) * **StateReason**: string (ReadOnly) -## EndpointEventBus -### Properties -* **EventBusArn**: string (Required) - -## ReplicationConfig -### Properties -* **State**: string (Required) - -## RoutingConfig -### Properties -* **FailoverConfig**: [FailoverConfig](#failoverconfig) (Required) - -## FailoverConfig -### Properties -* **Primary**: [Primary](#primary) (Required) -* **Secondary**: [Secondary](#secondary) (Required) - -## Primary -### Properties -* **HealthCheck**: string (Required) - -## Secondary -### Properties -* **Route**: string (Required) - ## AWS.Events/EventBusProperties ### Properties * **Arn**: string (ReadOnly): The Amazon Resource Name (ARN) for the event bus. +* **DeadLetterConfig**: [EventBus_DeadLetterConfig](#eventbusdeadletterconfig): Dead Letter Queue for the event bus. +* **Description**: string: The description of the event bus. * **EventSourceName**: string (WriteOnly): If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with. +* **KmsKeyIdentifier**: string: Kms Key Identifier used to encrypt events at rest in the event bus. * **Name**: string (Required, Identifier): The name of the event bus. * **Policy**: [EventBus_Policy](#eventbuspolicy) | string: A JSON string that describes the permission policy statement for the event bus. * **Tags**: [Tag](#tag)[]: Any tags assigned to the event bus. -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - ## AWS.Events/RuleProperties ### Properties * **Arn**: string (ReadOnly, Identifier): The ARN of the rule, such as arn:aws:events:us-east-2:123456789012:rule/example. @@ -179,29 +127,20 @@ * **Targets**: [Target](#target)[]: Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule. Targets are the resources that are invoked when a rule is triggered. -## Target +## AwsVpcConfiguration ### Properties -* **AppSyncParameters**: [AppSyncParameters](#appsyncparameters) -* **Arn**: string (Required, Identifier) -* **BatchParameters**: [BatchParameters](#batchparameters) -* **DeadLetterConfig**: [DeadLetterConfig](#deadletterconfig) -* **EcsParameters**: [EcsParameters](#ecsparameters) -* **HttpParameters**: [HttpParameters](#httpparameters) -* **Id**: string (Required) -* **Input**: string -* **InputPath**: string -* **InputTransformer**: [InputTransformer](#inputtransformer) -* **KinesisParameters**: [KinesisParameters](#kinesisparameters) -* **RedshiftDataParameters**: [RedshiftDataParameters](#redshiftdataparameters) -* **RetryPolicy**: [RetryPolicy](#retrypolicy) -* **RoleArn**: string -* **RunCommandParameters**: [RunCommandParameters](#runcommandparameters) -* **SageMakerPipelineParameters**: [SageMakerPipelineParameters](#sagemakerpipelineparameters) -* **SqsParameters**: [SqsParameters](#sqsparameters) +* **AssignPublicIp**: string +* **SecurityGroups**: string[] +* **Subnets**: string[] (Required) -## AppSyncParameters +## BasicAuthParameters ### Properties -* **GraphQLOperation**: string (Required) +* **Password**: string (Required) +* **Username**: string (Required) + +## BatchArrayProperties +### Properties +* **Size**: int ## BatchParameters ### Properties @@ -210,14 +149,27 @@ Targets are the resources that are invoked when a rule is triggered. * **JobName**: string (Required) * **RetryStrategy**: [BatchRetryStrategy](#batchretrystrategy) -## BatchArrayProperties -### Properties -* **Size**: int - ## BatchRetryStrategy ### Properties * **Attempts**: int +## CapacityProviderStrategyItem +### Properties +* **Base**: int +* **CapacityProvider**: string (Required) +* **Weight**: int + +## ClientParameters +### Properties +* **ClientID**: string (Required) +* **ClientSecret**: string (Required) + +## ConnectionHttpParameters +### Properties +* **BodyParameters**: [Parameter](#parameter)[] +* **HeaderParameters**: [Parameter](#parameter)[] +* **QueryStringParameters**: [Parameter](#parameter)[] + ## DeadLetterConfig ### Properties * **Arn**: string (Identifier) @@ -239,60 +191,64 @@ Targets are the resources that are invoked when a rule is triggered. * **TaskCount**: int * **TaskDefinitionArn**: string (Required) -## CapacityProviderStrategyItem +## EndpointEventBus ### Properties -* **Base**: int -* **CapacityProvider**: string (Required) -* **Weight**: int +* **EventBusArn**: string (Required) -## NetworkConfiguration +## EventBus_DeadLetterConfig ### Properties -* **AwsVpcConfiguration**: [AwsVpcConfiguration](#awsvpcconfiguration) +* **Arn**: string -## AwsVpcConfiguration +## FailoverConfig ### Properties -* **AssignPublicIp**: string -* **SecurityGroups**: string[] -* **Subnets**: string[] (Required) +* **Primary**: [Primary](#primary) (Required) +* **Secondary**: [Secondary](#secondary) (Required) -## PlacementConstraint +## HttpParameters ### Properties -* **Expression**: string -* **Type**: string +* **HeaderParameters**: [Rule_HeaderParameters](#ruleheaderparameters) +* **PathParameterValues**: string[] +* **QueryStringParameters**: [Rule_QueryStringParameters](#rulequerystringparameters) -## PlacementStrategy +## InputTransformer ### Properties -* **Field**: string -* **Type**: string +* **InputPathsMap**: [Rule_InputPathsMap](#ruleinputpathsmap) +* **InputTemplate**: string (Required) -## Tag +## KinesisParameters ### Properties -* **Key**: string -* **Value**: string +* **PartitionKeyPath**: string (Required) -## HttpParameters +## NetworkConfiguration ### Properties -* **HeaderParameters**: [Rule_HeaderParameters](#ruleheaderparameters) -* **PathParameterValues**: string[] -* **QueryStringParameters**: [Rule_QueryStringParameters](#rulequerystringparameters) +* **AwsVpcConfiguration**: [AwsVpcConfiguration](#awsvpcconfiguration) -## Rule_HeaderParameters +## OAuthParameters ### Properties +* **AuthorizationEndpoint**: string (Required) +* **ClientParameters**: [ClientParameters](#clientparameters) (Required) +* **HttpMethod**: string (Required) +* **OAuthHttpParameters**: [ConnectionHttpParameters](#connectionhttpparameters) -## Rule_QueryStringParameters +## Parameter ### Properties +* **IsValueSecret**: bool +* **Key**: string (Required) +* **Value**: string (Required) -## InputTransformer +## PlacementConstraint ### Properties -* **InputPathsMap**: [Rule_InputPathsMap](#ruleinputpathsmap) -* **InputTemplate**: string (Required) +* **Expression**: string +* **Type**: string -## Rule_InputPathsMap +## PlacementStrategy ### Properties +* **Field**: string +* **Type**: string -## KinesisParameters +## Primary ### Properties -* **PartitionKeyPath**: string (Required) +* **HealthCheck**: string (Required) ## RedshiftDataParameters ### Properties @@ -304,11 +260,28 @@ Targets are the resources that are invoked when a rule is triggered. * **StatementName**: string * **WithEvent**: bool +## ReplicationConfig +### Properties +* **State**: string (Required) + ## RetryPolicy ### Properties * **MaximumEventAgeInSeconds**: int * **MaximumRetryAttempts**: int +## RoutingConfig +### Properties +* **FailoverConfig**: [FailoverConfig](#failoverconfig) (Required) + +## Rule_HeaderParameters +### Properties + +## Rule_InputPathsMap +### Properties + +## Rule_QueryStringParameters +### Properties + ## RunCommandParameters ### Properties * **RunCommandTargets**: [RunCommandTarget](#runcommandtarget)[] (Required) @@ -318,16 +291,50 @@ Targets are the resources that are invoked when a rule is triggered. * **Key**: string (Required) * **Values**: string[] (Required) +## SageMakerPipelineParameter +### Properties +* **Name**: string (Required) +* **Value**: string (Required) + ## SageMakerPipelineParameters ### Properties * **PipelineParameterList**: [SageMakerPipelineParameter](#sagemakerpipelineparameter)[] -## SageMakerPipelineParameter +## Secondary ### Properties -* **Name**: string (Required) -* **Value**: string (Required) +* **Route**: string (Required) ## SqsParameters ### Properties * **MessageGroupId**: string (Required) +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + +## Tag +### Properties +* **Key**: string +* **Value**: string + +## Target +### Properties +* **AppSyncParameters**: [AppSyncParameters](#appsyncparameters) +* **Arn**: string (Required, Identifier) +* **BatchParameters**: [BatchParameters](#batchparameters) +* **DeadLetterConfig**: [DeadLetterConfig](#deadletterconfig) +* **EcsParameters**: [EcsParameters](#ecsparameters) +* **HttpParameters**: [HttpParameters](#httpparameters) +* **Id**: string (Required) +* **Input**: string +* **InputPath**: string +* **InputTransformer**: [InputTransformer](#inputtransformer) +* **KinesisParameters**: [KinesisParameters](#kinesisparameters) +* **RedshiftDataParameters**: [RedshiftDataParameters](#redshiftdataparameters) +* **RetryPolicy**: [RetryPolicy](#retrypolicy) +* **RoleArn**: string +* **RunCommandParameters**: [RunCommandParameters](#runcommandparameters) +* **SageMakerPipelineParameters**: [SageMakerPipelineParameters](#sagemakerpipelineparameters) +* **SqsParameters**: [SqsParameters](#sqsparameters) + diff --git a/artifacts/bicep/aws/aws.eventschemas/default/types.json b/artifacts/bicep/aws/aws.eventschemas/default/types.json index 13ebca9c..7380b003 100644 --- a/artifacts/bicep/aws/aws.eventschemas/default/types.json +++ b/artifacts/bicep/aws/aws.eventschemas/default/types.json @@ -1 +1,440 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"TagsEntry","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.EventSchemas/DiscovererProperties","Properties":{"CrossAccount":{"Type":2,"Flags":0,"Description":"Defines whether event schemas from other accounts are discovered. Default is True."},"Description":{"Type":4,"Flags":0,"Description":"A description for the discoverer."},"DiscovererArn":{"Type":4,"Flags":18,"Description":"The ARN of the discoverer."},"DiscovererId":{"Type":4,"Flags":2,"Description":"The Id of the discoverer."},"SourceArn":{"Type":4,"Flags":1,"Description":"The ARN of the event bus."},"State":{"Type":4,"Flags":2,"Description":"Defines the current state of the discoverer."},"Tags":{"Type":10,"Flags":0,"Description":"Tags associated with the resource."}}}},{"3":{"ItemType":8}},{"2":{"Name":"AWS.EventSchemas/Discoverer","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":9,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EventSchemas/Discoverer@default","ScopeType":0,"Body":11}},{"2":{"Name":"TagsEntry","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.EventSchemas/RegistryProperties","Properties":{"Description":{"Type":4,"Flags":0,"Description":"A description of the registry to be created."},"RegistryArn":{"Type":4,"Flags":18,"Description":"The ARN of the registry."},"RegistryName":{"Type":4,"Flags":0,"Description":"The name of the schema registry."},"Tags":{"Type":15,"Flags":0,"Description":"Tags associated with the resource."}}}},{"3":{"ItemType":13}},{"2":{"Name":"AWS.EventSchemas/Registry","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":14,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EventSchemas/Registry@default","ScopeType":0,"Body":16}},{"2":{"Name":"AWS.EventSchemas/RegistryPolicyProperties","Properties":{"Id":{"Type":4,"Flags":18},"Policy":{"Type":19,"Flags":1},"RegistryName":{"Type":4,"Flags":1},"RevisionId":{"Type":4,"Flags":0}}}},{"2":{"Name":"RegistryPolicy_Policy","Properties":{}}},{"2":{"Name":"AWS.EventSchemas/RegistryPolicy","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":18,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EventSchemas/RegistryPolicy@default","ScopeType":0,"Body":20}},{"2":{"Name":"TagsEntry","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.EventSchemas/SchemaProperties","Properties":{"Content":{"Type":4,"Flags":1,"Description":"The source of the schema definition."},"Description":{"Type":4,"Flags":0,"Description":"A description of the schema."},"LastModified":{"Type":4,"Flags":2,"Description":"The last modified time of the schema."},"RegistryName":{"Type":4,"Flags":1,"Description":"The name of the schema registry."},"SchemaArn":{"Type":4,"Flags":18,"Description":"The ARN of the schema."},"SchemaName":{"Type":4,"Flags":0,"Description":"The name of the schema."},"SchemaVersion":{"Type":4,"Flags":2,"Description":"The version number of the schema."},"Tags":{"Type":24,"Flags":0,"Description":"Tags associated with the resource."},"Type":{"Type":4,"Flags":1,"Description":"The type of schema. Valid types include OpenApi3 and JSONSchemaDraft4."},"VersionCreatedDate":{"Type":4,"Flags":2,"Description":"The date the schema version was created."}}}},{"3":{"ItemType":22}},{"2":{"Name":"AWS.EventSchemas/Schema","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":23,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.EventSchemas/Schema@default","ScopeType":0,"Body":25}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "TagsEntry", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.EventSchemas/DiscovererProperties" + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EventSchemas/DiscovererProperties", + "properties": { + "CrossAccount": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "Defines whether event schemas from other accounts are discovered. Default is True." + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A description for the discoverer." + }, + "DiscovererArn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The ARN of the discoverer." + }, + "DiscovererId": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The Id of the discoverer." + }, + "SourceArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The ARN of the event bus." + }, + "State": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "Defines the current state of the discoverer." + }, + "Tags": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Tags associated with the resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EventSchemas/Discoverer", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EventSchemas/Discoverer@default", + "scopeType": 0, + "body": { + "$ref": "#/6" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "TagsEntry", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EventSchemas/RegistryProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/8" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EventSchemas/RegistryProperties", + "properties": { + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A description of the registry to be created." + }, + "RegistryArn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The ARN of the registry." + }, + "RegistryName": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The name of the schema registry." + }, + "Tags": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "Tags associated with the resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EventSchemas/Registry", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/11" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EventSchemas/Registry@default", + "scopeType": 0, + "body": { + "$ref": "#/12" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.EventSchemas/RegistryPolicyProperties" + }, + { + "$type": "ObjectType", + "name": "RegistryPolicy_Policy", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AWS.EventSchemas/RegistryPolicyProperties", + "properties": { + "Id": { + "type": { + "$ref": "#/1" + }, + "flags": 18 + }, + "Policy": { + "type": { + "$ref": "#/15" + }, + "flags": 1 + }, + "RegistryName": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "RevisionId": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EventSchemas/RegistryPolicy", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/16" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EventSchemas/RegistryPolicy@default", + "scopeType": 0, + "body": { + "$ref": "#/17" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "TagsEntry", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.EventSchemas/SchemaProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/19" + } + }, + { + "$type": "ObjectType", + "name": "AWS.EventSchemas/SchemaProperties", + "properties": { + "Content": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The source of the schema definition." + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A description of the schema." + }, + "LastModified": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The last modified time of the schema." + }, + "RegistryName": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The name of the schema registry." + }, + "SchemaArn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The ARN of the schema." + }, + "SchemaName": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The name of the schema." + }, + "SchemaVersion": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The version number of the schema." + }, + "Tags": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "Tags associated with the resource." + }, + "Type": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The type of schema. Valid types include OpenApi3 and JSONSchemaDraft4." + }, + "VersionCreatedDate": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The date the schema version was created." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.EventSchemas/Schema", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/22" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.EventSchemas/Schema@default", + "scopeType": 0, + "body": { + "$ref": "#/23" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.eventschemas/default/types.md b/artifacts/bicep/aws/aws.eventschemas/default/types.md index 3a0dea82..4175b8d9 100644 --- a/artifacts/bicep/aws/aws.eventschemas/default/types.md +++ b/artifacts/bicep/aws/aws.eventschemas/default/types.md @@ -3,30 +3,30 @@ ## Resource AWS.EventSchemas/Discoverer@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EventSchemas/DiscovererProperties](#awseventschemasdiscovererproperties) (Required): properties of the resource +* **properties**: [AWS.EventSchemas/DiscovererProperties](#awseventschemasdiscovererproperties) (Required, Identifier): properties of the resource ## Resource AWS.EventSchemas/Registry@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EventSchemas/RegistryProperties](#awseventschemasregistryproperties): properties of the resource +* **properties**: [AWS.EventSchemas/RegistryProperties](#awseventschemasregistryproperties) (Identifier): properties of the resource ## Resource AWS.EventSchemas/RegistryPolicy@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EventSchemas/RegistryPolicyProperties](#awseventschemasregistrypolicyproperties) (Required): properties of the resource +* **properties**: [AWS.EventSchemas/RegistryPolicyProperties](#awseventschemasregistrypolicyproperties) (Required, Identifier): properties of the resource ## Resource AWS.EventSchemas/Schema@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.EventSchemas/SchemaProperties](#awseventschemasschemaproperties) (Required): properties of the resource +* **properties**: [AWS.EventSchemas/SchemaProperties](#awseventschemasschemaproperties) (Required, Identifier): properties of the resource ## AWS.EventSchemas/DiscovererProperties ### Properties @@ -38,23 +38,6 @@ * **State**: string (ReadOnly): Defines the current state of the discoverer. * **Tags**: [TagsEntry](#tagsentry)[]: Tags associated with the resource. -## TagsEntry -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - -## AWS.EventSchemas/RegistryProperties -### Properties -* **Description**: string: A description of the registry to be created. -* **RegistryArn**: string (ReadOnly, Identifier): The ARN of the registry. -* **RegistryName**: string: The name of the schema registry. -* **Tags**: [TagsEntry](#tagsentry)[]: Tags associated with the resource. - -## TagsEntry -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - ## AWS.EventSchemas/RegistryPolicyProperties ### Properties * **Id**: string (ReadOnly, Identifier) @@ -62,8 +45,12 @@ * **RegistryName**: string (Required) * **RevisionId**: string -## RegistryPolicy_Policy +## AWS.EventSchemas/RegistryProperties ### Properties +* **Description**: string: A description of the registry to be created. +* **RegistryArn**: string (ReadOnly, Identifier): The ARN of the registry. +* **RegistryName**: string: The name of the schema registry. +* **Tags**: [TagsEntry](#tagsentry)[]: Tags associated with the resource. ## AWS.EventSchemas/SchemaProperties ### Properties @@ -78,6 +65,19 @@ * **Type**: string (Required): The type of schema. Valid types include OpenApi3 and JSONSchemaDraft4. * **VersionCreatedDate**: string (ReadOnly): The date the schema version was created. +## RegistryPolicy_Policy +### Properties + +## TagsEntry +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + +## TagsEntry +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + ## TagsEntry ### Properties * **Key**: string (Required) diff --git a/artifacts/bicep/aws/aws.evidently/default/types.json b/artifacts/bicep/aws/aws.evidently/default/types.json index 64d13197..967799aa 100644 --- a/artifacts/bicep/aws/aws.evidently/default/types.json +++ b/artifacts/bicep/aws/aws.evidently/default/types.json @@ -1 +1,1014 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"MetricGoalObject","Properties":{"DesiredChange":{"Type":4,"Flags":1},"EntityIdKey":{"Type":4,"Flags":1,"Description":"The JSON path to reference the entity id in the event."},"EventPattern":{"Type":4,"Flags":0,"Description":"Event patterns have the same structure as the events they match. Rules use event patterns to select events. An event pattern either matches an event or it doesn't."},"MetricName":{"Type":4,"Flags":1},"UnitLabel":{"Type":4,"Flags":0},"ValueKey":{"Type":4,"Flags":1,"Description":"The JSON path to reference the numerical metric value in the event."}}}},{"2":{"Name":"OnlineAbConfigObject","Properties":{"ControlTreatmentName":{"Type":4,"Flags":0},"TreatmentWeights":{"Type":14,"Flags":0}}}},{"2":{"Name":"RunningStatusObject","Properties":{"AnalysisCompleteTime":{"Type":4,"Flags":0,"Description":"Provide the analysis Completion time for an experiment"},"DesiredState":{"Type":4,"Flags":0,"Description":"Provide CANCELLED or COMPLETED desired state when stopping an experiment"},"Reason":{"Type":4,"Flags":0,"Description":"Reason is a required input for stopping the experiment"},"Status":{"Type":4,"Flags":1,"Description":"Provide START or STOP action to apply on an experiment"}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"TreatmentObject","Properties":{"Description":{"Type":4,"Flags":0},"Feature":{"Type":4,"Flags":1},"TreatmentName":{"Type":4,"Flags":1},"Variation":{"Type":4,"Flags":1}}}},{"2":{"Name":"TreatmentToWeight","Properties":{"SplitWeight":{"Type":3,"Flags":1},"Treatment":{"Type":4,"Flags":1}}}},{"3":{"ItemType":13}},{"2":{"Name":"AWS.Evidently/ExperimentProperties","Properties":{"Arn":{"Type":4,"Flags":18},"Description":{"Type":4,"Flags":0},"MetricGoals":{"Type":16,"Flags":1},"Name":{"Type":4,"Flags":1},"OnlineAbConfig":{"Type":9,"Flags":1},"Project":{"Type":4,"Flags":1},"RandomizationSalt":{"Type":4,"Flags":0},"RemoveSegment":{"Type":2,"Flags":0},"RunningStatus":{"Type":10,"Flags":0,"Description":"Start Experiment. Default is False"},"SamplingRate":{"Type":3,"Flags":0},"Segment":{"Type":4,"Flags":0},"Tags":{"Type":17,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."},"Treatments":{"Type":18,"Flags":1}}}},{"3":{"ItemType":8}},{"3":{"ItemType":11}},{"3":{"ItemType":12}},{"2":{"Name":"AWS.Evidently/Experiment","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":15,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Evidently/Experiment@default","ScopeType":0,"Body":19}},{"2":{"Name":"EntityOverride","Properties":{"EntityId":{"Type":4,"Flags":0},"Variation":{"Type":4,"Flags":0}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"VariationObject","Properties":{"BooleanValue":{"Type":2,"Flags":0},"DoubleValue":{"Type":3,"Flags":0},"LongValue":{"Type":3,"Flags":0},"StringValue":{"Type":4,"Flags":0},"VariationName":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.Evidently/FeatureProperties","Properties":{"Arn":{"Type":4,"Flags":18},"DefaultVariation":{"Type":4,"Flags":0},"Description":{"Type":4,"Flags":0},"EntityOverrides":{"Type":25,"Flags":0},"EvaluationStrategy":{"Type":4,"Flags":0},"Name":{"Type":4,"Flags":1},"Project":{"Type":4,"Flags":1},"Tags":{"Type":26,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."},"Variations":{"Type":27,"Flags":1}}}},{"3":{"ItemType":21}},{"3":{"ItemType":22}},{"3":{"ItemType":23}},{"2":{"Name":"AWS.Evidently/Feature","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":24,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Evidently/Feature@default","ScopeType":0,"Body":28}},{"2":{"Name":"ExecutionStatusObject","Properties":{"DesiredState":{"Type":4,"Flags":0,"Description":"Provide CANCELLED or COMPLETED as the launch desired state. Defaults to Completed if not provided."},"Reason":{"Type":4,"Flags":0,"Description":"Provide a reason for stopping the launch. Defaults to empty if not provided."},"Status":{"Type":4,"Flags":1,"Description":"Provide START or STOP action to apply on a launch"}}}},{"2":{"Name":"GroupToWeight","Properties":{"GroupName":{"Type":4,"Flags":1},"SplitWeight":{"Type":3,"Flags":1}}}},{"2":{"Name":"LaunchGroupObject","Properties":{"Description":{"Type":4,"Flags":0},"Feature":{"Type":4,"Flags":1},"GroupName":{"Type":4,"Flags":1},"Variation":{"Type":4,"Flags":1}}}},{"2":{"Name":"MetricDefinitionObject","Properties":{"EntityIdKey":{"Type":4,"Flags":1,"Description":"The JSON path to reference the entity id in the event."},"EventPattern":{"Type":4,"Flags":0,"Description":"Event patterns have the same structure as the events they match. Rules use event patterns to select events. An event pattern either matches an event or it doesn't."},"MetricName":{"Type":4,"Flags":1},"UnitLabel":{"Type":4,"Flags":0},"ValueKey":{"Type":4,"Flags":1,"Description":"The JSON path to reference the numerical metric value in the event."}}}},{"2":{"Name":"SegmentOverride","Properties":{"EvaluationOrder":{"Type":3,"Flags":1},"Segment":{"Type":4,"Flags":1},"Weights":{"Type":37,"Flags":1}}}},{"2":{"Name":"StepConfig","Properties":{"GroupWeights":{"Type":38,"Flags":1},"SegmentOverrides":{"Type":39,"Flags":0},"StartTime":{"Type":4,"Flags":1}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"3":{"ItemType":31}},{"3":{"ItemType":31}},{"3":{"ItemType":34}},{"2":{"Name":"AWS.Evidently/LaunchProperties","Properties":{"Arn":{"Type":4,"Flags":18},"Description":{"Type":4,"Flags":0},"ExecutionStatus":{"Type":30,"Flags":0,"Description":"Start or Stop Launch Launch. Default is not started."},"Groups":{"Type":41,"Flags":1},"MetricMonitors":{"Type":42,"Flags":0},"Name":{"Type":4,"Flags":1},"Project":{"Type":4,"Flags":1},"RandomizationSalt":{"Type":4,"Flags":0},"ScheduledSplitsConfig":{"Type":43,"Flags":1},"Tags":{"Type":44,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."}}}},{"3":{"ItemType":32}},{"3":{"ItemType":33}},{"3":{"ItemType":35}},{"3":{"ItemType":36}},{"2":{"Name":"AWS.Evidently/Launch","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":40,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Evidently/Launch@default","ScopeType":0,"Body":45}},{"2":{"Name":"AppConfigResourceObject","Properties":{"ApplicationId":{"Type":4,"Flags":1},"EnvironmentId":{"Type":4,"Flags":1}}}},{"2":{"Name":"DataDeliveryObject","Properties":{"LogGroup":{"Type":4,"Flags":0},"S3":{"Type":49,"Flags":0}}}},{"2":{"Name":"S3Destination","Properties":{"BucketName":{"Type":4,"Flags":1},"Prefix":{"Type":4,"Flags":0}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.Evidently/ProjectProperties","Properties":{"AppConfigResource":{"Type":47,"Flags":0},"Arn":{"Type":4,"Flags":18},"DataDelivery":{"Type":48,"Flags":0},"Description":{"Type":4,"Flags":0},"Name":{"Type":4,"Flags":1},"Tags":{"Type":52,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."}}}},{"3":{"ItemType":50}},{"2":{"Name":"AWS.Evidently/Project","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":51,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Evidently/Project@default","ScopeType":0,"Body":53}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "MetricGoalObject", + "properties": { + "DesiredChange": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "EntityIdKey": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "The JSON path to reference the entity id in the event." + }, + "EventPattern": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Event patterns have the same structure as the events they match. Rules use event patterns to select events. An event pattern either matches an event or it doesn't." + }, + "MetricName": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "UnitLabel": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "ValueKey": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "The JSON path to reference the numerical metric value in the event." + } + } + }, + { + "$type": "ObjectType", + "name": "OnlineAbConfigObject", + "properties": { + "ControlTreatmentName": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "TreatmentWeights": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "RunningStatusObject", + "properties": { + "AnalysisCompleteTime": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Provide the analysis Completion time for an experiment" + }, + "DesiredState": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Provide CANCELLED or COMPLETED desired state when stopping an experiment" + }, + "Reason": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Reason is a required input for stopping the experiment" + }, + "Status": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "Provide START or STOP action to apply on an experiment" + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "ObjectType", + "name": "TreatmentObject", + "properties": { + "Description": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "Feature": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "TreatmentName": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "Variation": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TreatmentToWeight", + "properties": { + "SplitWeight": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + }, + "Treatment": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.Evidently/ExperimentProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Evidently/ExperimentProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/6" + }, + "flags": 18 + }, + "Description": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "MetricGoals": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "OnlineAbConfig": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Project": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "RandomizationSalt": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "RemoveSegment": { + "type": { + "$ref": "#/11" + }, + "flags": 0 + }, + "RunningStatus": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "Start Experiment. Default is False" + }, + "SamplingRate": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "Segment": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + }, + "Treatments": { + "type": { + "$ref": "#/13" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Evidently/Experiment", + "properties": { + "name": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/6" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/14" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Evidently/Experiment@default", + "scopeType": 0, + "body": { + "$ref": "#/15" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "EntityOverride", + "properties": { + "EntityId": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "Variation": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "ObjectType", + "name": "VariationObject", + "properties": { + "BooleanValue": { + "type": { + "$ref": "#/11" + }, + "flags": 0 + }, + "DoubleValue": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "LongValue": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "StringValue": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "VariationName": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Evidently/FeatureProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/17" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/18" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/19" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Evidently/FeatureProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/6" + }, + "flags": 18 + }, + "DefaultVariation": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "Description": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "EntityOverrides": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "EvaluationStrategy": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "Project": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + }, + "Variations": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Evidently/Feature", + "properties": { + "name": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/6" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/24" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Evidently/Feature@default", + "scopeType": 0, + "body": { + "$ref": "#/25" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "ExecutionStatusObject", + "properties": { + "DesiredState": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Provide CANCELLED or COMPLETED as the launch desired state. Defaults to Completed if not provided." + }, + "Reason": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Provide a reason for stopping the launch. Defaults to empty if not provided." + }, + "Status": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "Provide START or STOP action to apply on a launch" + } + } + }, + { + "$type": "ObjectType", + "name": "GroupToWeight", + "properties": { + "GroupName": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "SplitWeight": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "LaunchGroupObject", + "properties": { + "Description": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "Feature": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "GroupName": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "Variation": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "MetricDefinitionObject", + "properties": { + "EntityIdKey": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "The JSON path to reference the entity id in the event." + }, + "EventPattern": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Event patterns have the same structure as the events they match. Rules use event patterns to select events. An event pattern either matches an event or it doesn't." + }, + "MetricName": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "UnitLabel": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "ValueKey": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "The JSON path to reference the numerical metric value in the event." + } + } + }, + { + "$type": "ObjectType", + "name": "SegmentOverride", + "properties": { + "EvaluationOrder": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + }, + "Segment": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "Weights": { + "type": { + "$ref": "#/34" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "StepConfig", + "properties": { + "GroupWeights": { + "type": { + "$ref": "#/35" + }, + "flags": 1 + }, + "SegmentOverrides": { + "type": { + "$ref": "#/36" + }, + "flags": 0 + }, + "StartTime": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/28" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/28" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/31" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Evidently/LaunchProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/29" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/30" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/32" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/33" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Evidently/LaunchProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/6" + }, + "flags": 18 + }, + "Description": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "ExecutionStatus": { + "type": { + "$ref": "#/27" + }, + "flags": 0, + "description": "Start or Stop Launch Launch. Default is not started." + }, + "Groups": { + "type": { + "$ref": "#/38" + }, + "flags": 1 + }, + "MetricMonitors": { + "type": { + "$ref": "#/39" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "Project": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "RandomizationSalt": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "ScheduledSplitsConfig": { + "type": { + "$ref": "#/40" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/41" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Evidently/Launch", + "properties": { + "name": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/6" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/42" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Evidently/Launch@default", + "scopeType": 0, + "body": { + "$ref": "#/43" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AppConfigResourceObject", + "properties": { + "ApplicationId": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "EnvironmentId": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DataDeliveryObject", + "properties": { + "LogGroup": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "S3": { + "type": { + "$ref": "#/47" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "S3Destination", + "properties": { + "BucketName": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "Prefix": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Evidently/ProjectProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/48" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Evidently/ProjectProperties", + "properties": { + "AppConfigResource": { + "type": { + "$ref": "#/45" + }, + "flags": 0 + }, + "Arn": { + "type": { + "$ref": "#/6" + }, + "flags": 18 + }, + "DataDelivery": { + "type": { + "$ref": "#/46" + }, + "flags": 0 + }, + "Description": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/50" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Evidently/Project", + "properties": { + "name": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/6" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/51" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Evidently/Project@default", + "scopeType": 0, + "body": { + "$ref": "#/52" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.evidently/default/types.md b/artifacts/bicep/aws/aws.evidently/default/types.md index 535d40e1..7ba9f910 100644 --- a/artifacts/bicep/aws/aws.evidently/default/types.md +++ b/artifacts/bicep/aws/aws.evidently/default/types.md @@ -3,30 +3,35 @@ ## Resource AWS.Evidently/Experiment@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Evidently/ExperimentProperties](#awsevidentlyexperimentproperties) (Required): properties of the resource +* **properties**: [AWS.Evidently/ExperimentProperties](#awsevidentlyexperimentproperties) (Required, Identifier): properties of the resource ## Resource AWS.Evidently/Feature@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Evidently/FeatureProperties](#awsevidentlyfeatureproperties) (Required): properties of the resource +* **properties**: [AWS.Evidently/FeatureProperties](#awsevidentlyfeatureproperties) (Required, Identifier): properties of the resource ## Resource AWS.Evidently/Launch@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Evidently/LaunchProperties](#awsevidentlylaunchproperties) (Required): properties of the resource +* **properties**: [AWS.Evidently/LaunchProperties](#awsevidentlylaunchproperties) (Required, Identifier): properties of the resource ## Resource AWS.Evidently/Project@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Evidently/ProjectProperties](#awsevidentlyprojectproperties) (Required): properties of the resource +* **properties**: [AWS.Evidently/ProjectProperties](#awsevidentlyprojectproperties) (Required, Identifier): properties of the resource + +## AppConfigResourceObject +### Properties +* **ApplicationId**: string (Required) +* **EnvironmentId**: string (Required) ## AWS.Evidently/ExperimentProperties ### Properties @@ -44,44 +49,6 @@ * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. * **Treatments**: [TreatmentObject](#treatmentobject)[] (Required) -## MetricGoalObject -### Properties -* **DesiredChange**: string (Required) -* **EntityIdKey**: string (Required): The JSON path to reference the entity id in the event. -* **EventPattern**: string: Event patterns have the same structure as the events they match. Rules use event patterns to select events. An event pattern either matches an event or it doesn't. -* **MetricName**: string (Required) -* **UnitLabel**: string -* **ValueKey**: string (Required): The JSON path to reference the numerical metric value in the event. - -## OnlineAbConfigObject -### Properties -* **ControlTreatmentName**: string -* **TreatmentWeights**: [TreatmentToWeight](#treatmenttoweight)[] - -## TreatmentToWeight -### Properties -* **SplitWeight**: int (Required) -* **Treatment**: string (Required) - -## RunningStatusObject -### Properties -* **AnalysisCompleteTime**: string: Provide the analysis Completion time for an experiment -* **DesiredState**: string: Provide CANCELLED or COMPLETED desired state when stopping an experiment -* **Reason**: string: Reason is a required input for stopping the experiment -* **Status**: string (Required): Provide START or STOP action to apply on an experiment - -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - -## TreatmentObject -### Properties -* **Description**: string -* **Feature**: string (Required) -* **TreatmentName**: string (Required) -* **Variation**: string (Required) - ## AWS.Evidently/FeatureProperties ### Properties * **Arn**: string (ReadOnly, Identifier) @@ -94,24 +61,6 @@ * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. * **Variations**: [VariationObject](#variationobject)[] (Required) -## EntityOverride -### Properties -* **EntityId**: string -* **Variation**: string - -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - -## VariationObject -### Properties -* **BooleanValue**: bool -* **DoubleValue**: int -* **LongValue**: int -* **StringValue**: string -* **VariationName**: string (Required) - ## AWS.Evidently/LaunchProperties ### Properties * **Arn**: string (ReadOnly, Identifier) @@ -125,12 +74,36 @@ * **ScheduledSplitsConfig**: [StepConfig](#stepconfig)[] (Required) * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. +## AWS.Evidently/ProjectProperties +### Properties +* **AppConfigResource**: [AppConfigResourceObject](#appconfigresourceobject) +* **Arn**: string (ReadOnly, Identifier) +* **DataDelivery**: [DataDeliveryObject](#datadeliveryobject) +* **Description**: string +* **Name**: string (Required) +* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. + +## DataDeliveryObject +### Properties +* **LogGroup**: string +* **S3**: [S3Destination](#s3destination) + +## EntityOverride +### Properties +* **EntityId**: string +* **Variation**: string + ## ExecutionStatusObject ### Properties * **DesiredState**: string: Provide CANCELLED or COMPLETED as the launch desired state. Defaults to Completed if not provided. * **Reason**: string: Provide a reason for stopping the launch. Defaults to empty if not provided. * **Status**: string (Required): Provide START or STOP action to apply on a launch +## GroupToWeight +### Properties +* **GroupName**: string (Required) +* **SplitWeight**: int (Required) + ## LaunchGroupObject ### Properties * **Description**: string @@ -146,16 +119,31 @@ * **UnitLabel**: string * **ValueKey**: string (Required): The JSON path to reference the numerical metric value in the event. -## StepConfig +## MetricGoalObject ### Properties -* **GroupWeights**: [GroupToWeight](#grouptoweight)[] (Required) -* **SegmentOverrides**: [SegmentOverride](#segmentoverride)[] -* **StartTime**: string (Required) +* **DesiredChange**: string (Required) +* **EntityIdKey**: string (Required): The JSON path to reference the entity id in the event. +* **EventPattern**: string: Event patterns have the same structure as the events they match. Rules use event patterns to select events. An event pattern either matches an event or it doesn't. +* **MetricName**: string (Required) +* **UnitLabel**: string +* **ValueKey**: string (Required): The JSON path to reference the numerical metric value in the event. -## GroupToWeight +## OnlineAbConfigObject ### Properties -* **GroupName**: string (Required) -* **SplitWeight**: int (Required) +* **ControlTreatmentName**: string +* **TreatmentWeights**: [TreatmentToWeight](#treatmenttoweight)[] + +## RunningStatusObject +### Properties +* **AnalysisCompleteTime**: string: Provide the analysis Completion time for an experiment +* **DesiredState**: string: Provide CANCELLED or COMPLETED desired state when stopping an experiment +* **Reason**: string: Reason is a required input for stopping the experiment +* **Status**: string (Required): Provide START or STOP action to apply on an experiment + +## S3Destination +### Properties +* **BucketName**: string (Required) +* **Prefix**: string ## SegmentOverride ### Properties @@ -163,37 +151,49 @@ * **Segment**: string (Required) * **Weights**: [GroupToWeight](#grouptoweight)[] (Required) +## StepConfig +### Properties +* **GroupWeights**: [GroupToWeight](#grouptoweight)[] (Required) +* **SegmentOverrides**: [SegmentOverride](#segmentoverride)[] +* **StartTime**: string (Required) + ## Tag ### Properties * **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. * **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -## AWS.Evidently/ProjectProperties +## Tag ### Properties -* **AppConfigResource**: [AppConfigResourceObject](#appconfigresourceobject) -* **Arn**: string (ReadOnly, Identifier) -* **DataDelivery**: [DataDeliveryObject](#datadeliveryobject) -* **Description**: string -* **Name**: string (Required) -* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -## AppConfigResourceObject +## Tag ### Properties -* **ApplicationId**: string (Required) -* **EnvironmentId**: string (Required) +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -## DataDeliveryObject +## Tag ### Properties -* **LogGroup**: string -* **S3**: [S3Destination](#s3destination) +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -## S3Destination +## TreatmentObject ### Properties -* **BucketName**: string (Required) -* **Prefix**: string +* **Description**: string +* **Feature**: string (Required) +* **TreatmentName**: string (Required) +* **Variation**: string (Required) -## Tag +## TreatmentToWeight ### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **SplitWeight**: int (Required) +* **Treatment**: string (Required) + +## VariationObject +### Properties +* **BooleanValue**: bool +* **DoubleValue**: int +* **LongValue**: int +* **StringValue**: string +* **VariationName**: string (Required) diff --git a/artifacts/bicep/aws/aws.finspace/default/types.json b/artifacts/bicep/aws/aws.finspace/default/types.json index f5d19b4d..acc86b8e 100644 --- a/artifacts/bicep/aws/aws.finspace/default/types.json +++ b/artifacts/bicep/aws/aws.finspace/default/types.json @@ -1 +1,292 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"DataBundleArn"}},{"2":{"Name":"FederationParameters","Properties":{"ApplicationCallBackURL":{"Type":4,"Flags":0,"Description":"SAML metadata URL to link with the Environment"},"AttributeMap":{"Type":13,"Flags":4,"Description":"Attribute map for SAML configuration"},"FederationProviderName":{"Type":4,"Flags":0,"Description":"Federation provider name to link with the Environment"},"FederationURN":{"Type":4,"Flags":0,"Description":"SAML metadata URL to link with the Environment"},"SamlMetadataDocument":{"Type":4,"Flags":0,"Description":"SAML metadata document to link the federation provider to the Environment"},"SamlMetadataURL":{"Type":4,"Flags":0,"Description":"SAML metadata URL to link with the Environment"}}}},{"2":{"Name":"SuperuserParameters","Properties":{"EmailAddress":{"Type":4,"Flags":0,"Description":"Email address"},"FirstName":{"Type":4,"Flags":0,"Description":"First name"},"LastName":{"Type":4,"Flags":0,"Description":"Last name"}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"Environment_AttributeMap","Properties":{"Key":{"Type":4,"Flags":0,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":0,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"3":{"ItemType":12}},{"2":{"Name":"AWS.FinSpace/EnvironmentProperties","Properties":{"AwsAccountId":{"Type":4,"Flags":2,"Description":"AWS account ID associated with the Environment"},"DataBundles":{"Type":15,"Flags":0,"Description":"ARNs of FinSpace Data Bundles to install"},"DedicatedServiceAccountId":{"Type":4,"Flags":2,"Description":"ID for FinSpace created account used to store Environment artifacts"},"Description":{"Type":4,"Flags":0,"Description":"Description of the Environment"},"EnvironmentArn":{"Type":4,"Flags":2,"Description":"ARN of the Environment"},"EnvironmentId":{"Type":4,"Flags":18,"Description":"Unique identifier for representing FinSpace Environment"},"EnvironmentUrl":{"Type":4,"Flags":2,"Description":"URL used to login to the Environment"},"FederationMode":{"Type":4,"Flags":0,"Description":"Federation mode used with the Environment"},"FederationParameters":{"Type":9,"Flags":0},"KmsKeyId":{"Type":4,"Flags":0,"Description":"KMS key used to encrypt customer data within FinSpace Environment infrastructure"},"Name":{"Type":4,"Flags":1,"Description":"Name of the Environment"},"SageMakerStudioDomainUrl":{"Type":4,"Flags":2,"Description":"SageMaker Studio Domain URL associated with the Environment"},"Status":{"Type":4,"Flags":2,"Description":"State of the Environment"},"SuperuserParameters":{"Type":10,"Flags":4},"Tags":{"Type":16,"Flags":4,"Description":"An array of key-value pairs to apply to this resource."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":11}},{"2":{"Name":"AWS.FinSpace/Environment","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":14,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.FinSpace/Environment@default","ScopeType":0,"Body":17}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "DataBundleArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "FederationParameters", + "properties": { + "ApplicationCallBackURL": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "SAML metadata URL to link with the Environment" + }, + "AttributeMap": { + "type": { + "$ref": "#/6" + }, + "flags": 4, + "description": "Attribute map for SAML configuration" + }, + "FederationProviderName": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Federation provider name to link with the Environment" + }, + "FederationURN": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "SAML metadata URL to link with the Environment" + }, + "SamlMetadataDocument": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "SAML metadata document to link the federation provider to the Environment" + }, + "SamlMetadataURL": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "SAML metadata URL to link with the Environment" + } + } + }, + { + "$type": "ObjectType", + "name": "SuperuserParameters", + "properties": { + "EmailAddress": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Email address" + }, + "FirstName": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "First name" + }, + "LastName": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Last name" + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "ObjectType", + "name": "Environment_AttributeMap", + "properties": { + "Key": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.FinSpace/EnvironmentProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ObjectType", + "name": "AWS.FinSpace/EnvironmentProperties", + "properties": { + "AwsAccountId": { + "type": { + "$ref": "#/4" + }, + "flags": 2, + "description": "AWS account ID associated with the Environment" + }, + "DataBundles": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "ARNs of FinSpace Data Bundles to install" + }, + "DedicatedServiceAccountId": { + "type": { + "$ref": "#/4" + }, + "flags": 2, + "description": "ID for FinSpace created account used to store Environment artifacts" + }, + "Description": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Description of the Environment" + }, + "EnvironmentArn": { + "type": { + "$ref": "#/4" + }, + "flags": 2, + "description": "ARN of the Environment" + }, + "EnvironmentId": { + "type": { + "$ref": "#/4" + }, + "flags": 18, + "description": "Unique identifier for representing FinSpace Environment" + }, + "EnvironmentUrl": { + "type": { + "$ref": "#/4" + }, + "flags": 2, + "description": "URL used to login to the Environment" + }, + "FederationMode": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Federation mode used with the Environment" + }, + "FederationParameters": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "KmsKeyId": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "KMS key used to encrypt customer data within FinSpace Environment infrastructure" + }, + "Name": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "Name of the Environment" + }, + "SageMakerStudioDomainUrl": { + "type": { + "$ref": "#/4" + }, + "flags": 2, + "description": "SageMaker Studio Domain URL associated with the Environment" + }, + "Status": { + "type": { + "$ref": "#/4" + }, + "flags": 2, + "description": "State of the Environment" + }, + "SuperuserParameters": { + "type": { + "$ref": "#/2" + }, + "flags": 4 + }, + "Tags": { + "type": { + "$ref": "#/9" + }, + "flags": 4, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.FinSpace/Environment", + "properties": { + "name": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/10" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.FinSpace/Environment@default", + "scopeType": 0, + "body": { + "$ref": "#/11" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.finspace/default/types.md b/artifacts/bicep/aws/aws.finspace/default/types.md index 2f8335dc..ae0063eb 100644 --- a/artifacts/bicep/aws/aws.finspace/default/types.md +++ b/artifacts/bicep/aws/aws.finspace/default/types.md @@ -3,9 +3,9 @@ ## Resource AWS.FinSpace/Environment@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.FinSpace/EnvironmentProperties](#awsfinspaceenvironmentproperties) (Required): properties of the resource +* **properties**: [AWS.FinSpace/EnvironmentProperties](#awsfinspaceenvironmentproperties) (Required, Identifier): properties of the resource ## AWS.FinSpace/EnvironmentProperties ### Properties @@ -25,6 +25,11 @@ * **SuperuserParameters**: [SuperuserParameters](#superuserparameters) (WriteOnly) * **Tags**: [Tag](#tag)[] (WriteOnly): An array of key-value pairs to apply to this resource. +## Environment_AttributeMap +### Properties +* **Key**: string: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + ## FederationParameters ### Properties * **ApplicationCallBackURL**: string: SAML metadata URL to link with the Environment @@ -34,11 +39,6 @@ * **SamlMetadataDocument**: string: SAML metadata document to link the federation provider to the Environment * **SamlMetadataURL**: string: SAML metadata URL to link with the Environment -## Environment_AttributeMap -### Properties -* **Key**: string: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## SuperuserParameters ### Properties * **EmailAddress**: string: Email address diff --git a/artifacts/bicep/aws/aws.fis/default/types.json b/artifacts/bicep/aws/aws.fis/default/types.json index 64cf02f4..d3ad88a5 100644 --- a/artifacts/bicep/aws/aws.fis/default/types.json +++ b/artifacts/bicep/aws/aws.fis/default/types.json @@ -1 +1,583 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"ActionId"}},{"2":{"Name":"ExperimentTemplateAction","Properties":{"ActionId":{"Type":4,"Flags":1},"Description":{"Type":4,"Flags":0},"Parameters":{"Type":36,"Flags":0,"Description":"The parameters for the action, if applicable."},"StartAfter":{"Type":37,"Flags":0},"Targets":{"Type":38,"Flags":0,"Description":"One or more targets for the action."}}}},{"2":{"Name":"ExperimentTemplateActionItemDescription"}},{"2":{"Name":"ExperimentTemplateActionItemParameter"}},{"2":{"Name":"ExperimentTemplateActionItemStartAfter"}},{"2":{"Name":"ExperimentTemplateActionItemStartAfterList"}},{"2":{"Name":"ExperimentTemplateActionItemTarget"}},{"2":{"Name":"ExperimentTemplateActionMap","Properties":{}}},{"2":{"Name":"ExperimentTemplateDescription"}},{"2":{"Name":"ExperimentTemplateExperimentOptions","Properties":{"AccountTargeting":{"Type":4,"Flags":0,"Description":"The account targeting setting for the experiment template."},"EmptyTargetResolutionMode":{"Type":4,"Flags":0,"Description":"The target resolution failure mode for the experiment template."}}}},{"2":{"Name":"ExperimentTemplateId"}},{"2":{"Name":"ExperimentTemplateLogConfiguration","Properties":{"CloudWatchLogsConfiguration":{"Type":40,"Flags":0},"LogSchemaVersion":{"Type":3,"Flags":1},"S3Configuration":{"Type":41,"Flags":0}}}},{"2":{"Name":"ExperimentTemplateStopCondition","Properties":{"Source":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"ExperimentTemplateStopConditionList"}},{"2":{"Name":"ExperimentTemplateTarget","Properties":{"Filters":{"Type":43,"Flags":0},"Parameters":{"Type":44,"Flags":0},"ResourceArns":{"Type":45,"Flags":0},"ResourceTags":{"Type":46,"Flags":0},"ResourceType":{"Type":4,"Flags":1},"SelectionMode":{"Type":4,"Flags":1}}}},{"2":{"Name":"ExperimentTemplateTargetFilter","Properties":{"Path":{"Type":4,"Flags":1},"Values":{"Type":47,"Flags":1}}}},{"2":{"Name":"ExperimentTemplateTargetFilterList"}},{"2":{"Name":"ExperimentTemplateTargetFilterPath"}},{"2":{"Name":"ExperimentTemplateTargetFilterValue"}},{"2":{"Name":"ExperimentTemplateTargetFilterValues"}},{"2":{"Name":"ExperimentTemplateTargetMap","Properties":{}}},{"2":{"Name":"ExperimentTemplateTargetSelectionMode"}},{"2":{"Name":"ResourceArn"}},{"2":{"Name":"ResourceArnList"}},{"2":{"Name":"ResourceType"}},{"2":{"Name":"RoleArn"}},{"2":{"Name":"StopConditionSource"}},{"2":{"Name":"StopConditionValue"}},{"2":{"Name":"ExperimentTemplate_Parameters","Properties":{}}},{"3":{"ItemType":4}},{"2":{"Name":"ExperimentTemplate_Targets","Properties":{}}},{"3":{"ItemType":4}},{"2":{"Name":"ExperimentTemplate_CloudWatchLogsConfiguration","Properties":{"LogGroupArn":{"Type":4,"Flags":1}}}},{"2":{"Name":"ExperimentTemplate_S3Configuration","Properties":{"BucketName":{"Type":4,"Flags":1},"Prefix":{"Type":4,"Flags":0}}}},{"3":{"ItemType":20}},{"3":{"ItemType":23}},{"2":{"Name":"ExperimentTemplate_Parameters","Properties":{}}},{"3":{"ItemType":4}},{"2":{"Name":"ExperimentTemplate_ResourceTags","Properties":{}}},{"3":{"ItemType":4}},{"3":{"ItemType":23}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.FIS/ExperimentTemplateProperties","Properties":{"Actions":{"Type":15,"Flags":0},"Description":{"Type":4,"Flags":1},"ExperimentOptions":{"Type":17,"Flags":0},"Id":{"Type":4,"Flags":18},"LogConfiguration":{"Type":19,"Flags":0},"RoleArn":{"Type":4,"Flags":1},"StopConditions":{"Type":52,"Flags":1},"Tags":{"Type":53,"Flags":1},"Targets":{"Type":28,"Flags":1}}}},{"3":{"ItemType":20}},{"2":{"Name":"ExperimentTemplate_Tags","Properties":{}}},{"2":{"Name":"AWS.FIS/ExperimentTemplate","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":51,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.FIS/ExperimentTemplate@default","ScopeType":0,"Body":54}},{"2":{"Name":"TargetAccountConfigurationDescription"}},{"2":{"Name":"TargetAccountId"}},{"2":{"Name":"TargetAccountRoleArn"}},{"2":{"Name":"TargetExperimentTemplateId"}},{"2":{"Name":"AWS.FIS/TargetAccountConfigurationProperties","Properties":{"AccountId":{"Type":4,"Flags":17},"Description":{"Type":4,"Flags":0},"ExperimentTemplateId":{"Type":4,"Flags":17},"RoleArn":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.FIS/TargetAccountConfiguration","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":60,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.FIS/TargetAccountConfiguration@default","ScopeType":0,"Body":61}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "ActionId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ExperimentTemplateAction", + "properties": { + "ActionId": { + "type": { + "$ref": "#/28" + }, + "flags": 1 + }, + "Description": { + "type": { + "$ref": "#/28" + }, + "flags": 0 + }, + "Parameters": { + "type": { + "$ref": "#/29" + }, + "flags": 0, + "description": "The parameters for the action, if applicable." + }, + "StartAfter": { + "type": { + "$ref": "#/30" + }, + "flags": 0 + }, + "Targets": { + "type": { + "$ref": "#/31" + }, + "flags": 0, + "description": "One or more targets for the action." + } + } + }, + { + "$type": "ObjectType", + "name": "ExperimentTemplateActionItemDescription", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ExperimentTemplateActionItemParameter", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ExperimentTemplateActionItemStartAfter", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ExperimentTemplateActionItemStartAfterList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ExperimentTemplateActionItemTarget", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ExperimentTemplateActionMap", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ExperimentTemplateDescription", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ExperimentTemplateExperimentOptions", + "properties": { + "AccountTargeting": { + "type": { + "$ref": "#/28" + }, + "flags": 0, + "description": "The account targeting setting for the experiment template." + }, + "EmptyTargetResolutionMode": { + "type": { + "$ref": "#/28" + }, + "flags": 0, + "description": "The target resolution failure mode for the experiment template." + } + } + }, + { + "$type": "ObjectType", + "name": "ExperimentTemplateId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ExperimentTemplateLogConfiguration", + "properties": { + "CloudWatchLogsConfiguration": { + "type": { + "$ref": "#/33" + }, + "flags": 0 + }, + "LogSchemaVersion": { + "type": { + "$ref": "#/34" + }, + "flags": 1 + }, + "S3Configuration": { + "type": { + "$ref": "#/35" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ExperimentTemplateStopCondition", + "properties": { + "Source": { + "type": { + "$ref": "#/28" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/28" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ExperimentTemplateStopConditionList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ExperimentTemplateTarget", + "properties": { + "Filters": { + "type": { + "$ref": "#/37" + }, + "flags": 0 + }, + "Parameters": { + "type": { + "$ref": "#/38" + }, + "flags": 0 + }, + "ResourceArns": { + "type": { + "$ref": "#/39" + }, + "flags": 0 + }, + "ResourceTags": { + "type": { + "$ref": "#/40" + }, + "flags": 0 + }, + "ResourceType": { + "type": { + "$ref": "#/28" + }, + "flags": 1 + }, + "SelectionMode": { + "type": { + "$ref": "#/28" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ExperimentTemplateTargetFilter", + "properties": { + "Path": { + "type": { + "$ref": "#/28" + }, + "flags": 1 + }, + "Values": { + "type": { + "$ref": "#/41" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ExperimentTemplateTargetFilterList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ExperimentTemplateTargetFilterPath", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ExperimentTemplateTargetFilterValue", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ExperimentTemplateTargetFilterValues", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ExperimentTemplateTargetMap", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ExperimentTemplateTargetSelectionMode", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ResourceArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ResourceArnList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ResourceType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RoleArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "StopConditionSource", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "StopConditionValue", + "properties": {} + }, + { + "$type": "StringType" + }, + { + "$type": "ObjectType", + "name": "ExperimentTemplate_Parameters", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/28" + } + }, + { + "$type": "ObjectType", + "name": "ExperimentTemplate_Targets", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/28" + } + }, + { + "$type": "ObjectType", + "name": "ExperimentTemplate_CloudWatchLogsConfiguration", + "properties": { + "LogGroupArn": { + "type": { + "$ref": "#/28" + }, + "flags": 1 + } + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "ObjectType", + "name": "ExperimentTemplate_S3Configuration", + "properties": { + "BucketName": { + "type": { + "$ref": "#/28" + }, + "flags": 1 + }, + "Prefix": { + "type": { + "$ref": "#/28" + }, + "flags": 0 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/12" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/15" + } + }, + { + "$type": "ObjectType", + "name": "ExperimentTemplate_Parameters", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/28" + } + }, + { + "$type": "ObjectType", + "name": "ExperimentTemplate_ResourceTags", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/28" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/15" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/28" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/28" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.FIS/ExperimentTemplateProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/12" + } + }, + { + "$type": "ObjectType", + "name": "ExperimentTemplate_Tags", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AWS.FIS/ExperimentTemplateProperties", + "properties": { + "Actions": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "Description": { + "type": { + "$ref": "#/28" + }, + "flags": 1 + }, + "ExperimentOptions": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "Id": { + "type": { + "$ref": "#/28" + }, + "flags": 18 + }, + "LogConfiguration": { + "type": { + "$ref": "#/11" + }, + "flags": 0 + }, + "RoleArn": { + "type": { + "$ref": "#/28" + }, + "flags": 1 + }, + "StopConditions": { + "type": { + "$ref": "#/46" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/47" + }, + "flags": 1 + }, + "Targets": { + "type": { + "$ref": "#/20" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.FIS/ExperimentTemplate", + "properties": { + "name": { + "type": { + "$ref": "#/28" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/28" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/48" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.FIS/ExperimentTemplate@default", + "scopeType": 0, + "body": { + "$ref": "#/49" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "TargetAccountConfigurationDescription", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TargetAccountId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TargetAccountRoleArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TargetExperimentTemplateId", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.FIS/TargetAccountConfigurationProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.FIS/TargetAccountConfigurationProperties", + "properties": { + "AccountId": { + "type": { + "$ref": "#/28" + }, + "flags": 17 + }, + "Description": { + "type": { + "$ref": "#/28" + }, + "flags": 0 + }, + "ExperimentTemplateId": { + "type": { + "$ref": "#/28" + }, + "flags": 17 + }, + "RoleArn": { + "type": { + "$ref": "#/28" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.FIS/TargetAccountConfiguration", + "properties": { + "name": { + "type": { + "$ref": "#/28" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/28" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/56" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.FIS/TargetAccountConfiguration@default", + "scopeType": 0, + "body": { + "$ref": "#/57" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.fis/default/types.md b/artifacts/bicep/aws/aws.fis/default/types.md index 3aa5b2af..e29ad24e 100644 --- a/artifacts/bicep/aws/aws.fis/default/types.md +++ b/artifacts/bicep/aws/aws.fis/default/types.md @@ -3,16 +3,16 @@ ## Resource AWS.FIS/ExperimentTemplate@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.FIS/ExperimentTemplateProperties](#awsfisexperimenttemplateproperties) (Required): properties of the resource +* **properties**: [AWS.FIS/ExperimentTemplateProperties](#awsfisexperimenttemplateproperties) (Required, Identifier): properties of the resource ## Resource AWS.FIS/TargetAccountConfiguration@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.FIS/TargetAccountConfigurationProperties](#awsfistargetaccountconfigurationproperties) (Required): properties of the resource +* **properties**: [AWS.FIS/TargetAccountConfigurationProperties](#awsfistargetaccountconfigurationproperties) (Required, Identifier): properties of the resource ## AWS.FIS/ExperimentTemplateProperties ### Properties @@ -26,6 +26,25 @@ * **Tags**: [ExperimentTemplate_Tags](#experimenttemplatetags) (Required) * **Targets**: [ExperimentTemplateTargetMap](#experimenttemplatetargetmap) (Required) +## AWS.FIS/TargetAccountConfigurationProperties +### Properties +* **AccountId**: string (Required, Identifier) +* **Description**: string +* **ExperimentTemplateId**: string (Required, Identifier) +* **RoleArn**: string (Required) + +## ExperimentTemplate_CloudWatchLogsConfiguration +### Properties +* **LogGroupArn**: string (Required) + +## ExperimentTemplate_S3Configuration +### Properties +* **BucketName**: string (Required) +* **Prefix**: string + +## ExperimentTemplate_Tags +### Properties + ## ExperimentTemplateActionMap ### Properties @@ -40,30 +59,11 @@ * **LogSchemaVersion**: int (Required) * **S3Configuration**: [ExperimentTemplate_S3Configuration](#experimenttemplates3configuration) -## ExperimentTemplate_CloudWatchLogsConfiguration -### Properties -* **LogGroupArn**: string (Required) - -## ExperimentTemplate_S3Configuration -### Properties -* **BucketName**: string (Required) -* **Prefix**: string - ## ExperimentTemplateStopCondition ### Properties * **Source**: string (Required) * **Value**: string -## ExperimentTemplate_Tags -### Properties - ## ExperimentTemplateTargetMap ### Properties -## AWS.FIS/TargetAccountConfigurationProperties -### Properties -* **AccountId**: string (Required, Identifier) -* **Description**: string -* **ExperimentTemplateId**: string (Required, Identifier) -* **RoleArn**: string (Required) - diff --git a/artifacts/bicep/aws/aws.fms/default/types.json b/artifacts/bicep/aws/aws.fms/default/types.json index bdff6d4f..0b2363dc 100644 --- a/artifacts/bicep/aws/aws.fms/default/types.json +++ b/artifacts/bicep/aws/aws.fms/default/types.json @@ -1 +1,711 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"ResourceArn"}},{"2":{"Name":"AWS.FMS/NotificationChannelProperties","Properties":{"SnsRoleName":{"Type":4,"Flags":1},"SnsTopicArn":{"Type":4,"Flags":17}}}},{"2":{"Name":"AWS.FMS/NotificationChannel","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":9,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.FMS/NotificationChannel@default","ScopeType":0,"Body":10}},{"2":{"Name":"AccountId"}},{"2":{"Name":"Base62Id"}},{"2":{"Name":"FirewallDeploymentModel"}},{"2":{"Name":"IEMap","Properties":{"ACCOUNT":{"Type":27,"Flags":0},"ORGUNIT":{"Type":28,"Flags":0}}}},{"2":{"Name":"ManagedServiceData"}},{"2":{"Name":"NetworkFirewallPolicy","Properties":{"FirewallDeploymentModel":{"Type":4,"Flags":1}}}},{"2":{"Name":"OrganizationalUnitId"}},{"2":{"Name":"PolicyOption","Properties":{"NetworkFirewallPolicy":{"Type":17,"Flags":0},"ThirdPartyFirewallPolicy":{"Type":26,"Flags":0}}}},{"2":{"Name":"PolicyTag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"PolicyType"}},{"2":{"Name":"ResourceArn"}},{"2":{"Name":"ResourceTag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"ResourceType"}},{"2":{"Name":"SecurityServicePolicyData","Properties":{"ManagedServiceData":{"Type":4,"Flags":0},"PolicyOption":{"Type":19,"Flags":0},"Type":{"Type":4,"Flags":1}}}},{"2":{"Name":"ThirdPartyFirewallPolicy","Properties":{"FirewallDeploymentModel":{"Type":4,"Flags":1}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.FMS/PolicyProperties","Properties":{"Arn":{"Type":4,"Flags":2},"DeleteAllPolicyResources":{"Type":2,"Flags":4},"ExcludeMap":{"Type":15,"Flags":0},"ExcludeResourceTags":{"Type":2,"Flags":1},"Id":{"Type":4,"Flags":18},"IncludeMap":{"Type":15,"Flags":0},"PolicyDescription":{"Type":4,"Flags":0},"PolicyName":{"Type":4,"Flags":1},"RemediationEnabled":{"Type":2,"Flags":1},"ResourceSetIds":{"Type":30,"Flags":0},"ResourceTags":{"Type":31,"Flags":0},"ResourceType":{"Type":4,"Flags":0},"ResourceTypeList":{"Type":32,"Flags":0},"ResourcesCleanUp":{"Type":2,"Flags":0},"SecurityServicePolicyData":{"Type":25,"Flags":1},"Tags":{"Type":33,"Flags":0}}}},{"3":{"ItemType":4}},{"3":{"ItemType":23}},{"3":{"ItemType":4}},{"3":{"ItemType":20}},{"2":{"Name":"AWS.FMS/Policy","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":29,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.FMS/Policy@default","ScopeType":0,"Body":34}},{"2":{"Name":"Base62Id"}},{"2":{"Name":"Resource"}},{"2":{"Name":"ResourceType"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.FMS/ResourceSetProperties","Properties":{"Description":{"Type":4,"Flags":0},"Id":{"Type":4,"Flags":18},"Name":{"Type":4,"Flags":1},"ResourceTypeList":{"Type":41,"Flags":1},"Resources":{"Type":42,"Flags":0},"Tags":{"Type":43,"Flags":0}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":39}},{"2":{"Name":"AWS.FMS/ResourceSet","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":40,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.FMS/ResourceSet@default","ScopeType":0,"Body":44}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "ResourceArn", + "properties": {} + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.FMS/NotificationChannelProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.FMS/NotificationChannelProperties", + "properties": { + "SnsRoleName": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "SnsTopicArn": { + "type": { + "$ref": "#/1" + }, + "flags": 17 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.FMS/NotificationChannel", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.FMS/NotificationChannel@default", + "scopeType": 0, + "body": { + "$ref": "#/4" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AccountId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Base62Id", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "FirewallDeploymentModel", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "IEMap", + "properties": { + "ACCOUNT": { + "type": { + "$ref": "#/25" + }, + "flags": 0 + }, + "ORGUNIT": { + "type": { + "$ref": "#/26" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ManagedServiceData", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "NetworkAclCommonPolicy", + "properties": { + "NetworkAclEntrySet": { + "type": { + "$ref": "#/14" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "NetworkAclEntry", + "properties": { + "CidrBlock": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "CIDR block." + }, + "Egress": { + "type": { + "$ref": "#/27" + }, + "flags": 1, + "description": "Whether the entry is an egress entry." + }, + "IcmpTypeCode": { + "type": { + "$ref": "#/29" + }, + "flags": 0, + "description": "ICMP type and code." + }, + "Ipv6CidrBlock": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "IPv6 CIDR block." + }, + "PortRange": { + "type": { + "$ref": "#/30" + }, + "flags": 0, + "description": "Port range." + }, + "Protocol": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Protocol." + }, + "RuleAction": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Rule Action." + } + } + }, + { + "$type": "ObjectType", + "name": "NetworkAclEntryList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "NetworkAclEntrySet", + "properties": { + "FirstEntries": { + "type": { + "$ref": "#/32" + }, + "flags": 0 + }, + "ForceRemediateForFirstEntries": { + "type": { + "$ref": "#/27" + }, + "flags": 1 + }, + "ForceRemediateForLastEntries": { + "type": { + "$ref": "#/27" + }, + "flags": 1 + }, + "LastEntries": { + "type": { + "$ref": "#/33" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "NetworkFirewallPolicy", + "properties": { + "FirewallDeploymentModel": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "OrganizationalUnitId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PolicyOption", + "properties": { + "NetworkAclCommonPolicy": { + "type": { + "$ref": "#/11" + }, + "flags": 0 + }, + "NetworkFirewallPolicy": { + "type": { + "$ref": "#/15" + }, + "flags": 0 + }, + "ThirdPartyFirewallPolicy": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PolicyTag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "PolicyType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ResourceArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ResourceTag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ResourceType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SecurityServicePolicyData", + "properties": { + "ManagedServiceData": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "PolicyOption": { + "type": { + "$ref": "#/17" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ThirdPartyFirewallPolicy", + "properties": { + "FirewallDeploymentModel": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "IntegerType" + }, + { + "$type": "ObjectType", + "name": "Policy_IcmpTypeCode", + "properties": { + "Code": { + "type": { + "$ref": "#/28" + }, + "flags": 1, + "description": "Code." + }, + "Type": { + "type": { + "$ref": "#/28" + }, + "flags": 1, + "description": "Type." + } + } + }, + { + "$type": "ObjectType", + "name": "Policy_PortRange", + "properties": { + "From": { + "type": { + "$ref": "#/28" + }, + "flags": 1, + "description": "From Port." + }, + "To": { + "type": { + "$ref": "#/28" + }, + "flags": 1, + "description": "To Port." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/12" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/12" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/12" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.FMS/PolicyProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/21" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/18" + } + }, + { + "$type": "ObjectType", + "name": "AWS.FMS/PolicyProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "DeleteAllPolicyResources": { + "type": { + "$ref": "#/27" + }, + "flags": 4 + }, + "ExcludeMap": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "ExcludeResourceTags": { + "type": { + "$ref": "#/27" + }, + "flags": 1 + }, + "Id": { + "type": { + "$ref": "#/1" + }, + "flags": 18 + }, + "IncludeMap": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "PolicyDescription": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "PolicyName": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "RemediationEnabled": { + "type": { + "$ref": "#/27" + }, + "flags": 1 + }, + "ResourceSetIds": { + "type": { + "$ref": "#/35" + }, + "flags": 0 + }, + "ResourceTags": { + "type": { + "$ref": "#/36" + }, + "flags": 0 + }, + "ResourceType": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "ResourceTypeList": { + "type": { + "$ref": "#/37" + }, + "flags": 0 + }, + "ResourcesCleanUp": { + "type": { + "$ref": "#/27" + }, + "flags": 0 + }, + "SecurityServicePolicyData": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/38" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.FMS/Policy", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/39" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.FMS/Policy@default", + "scopeType": 0, + "body": { + "$ref": "#/40" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Base62Id", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Resource", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ResourceType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.FMS/ResourceSetProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/45" + } + }, + { + "$type": "ObjectType", + "name": "AWS.FMS/ResourceSetProperties", + "properties": { + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "Id": { + "type": { + "$ref": "#/1" + }, + "flags": 18 + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "ResourceTypeList": { + "type": { + "$ref": "#/47" + }, + "flags": 1 + }, + "Resources": { + "type": { + "$ref": "#/48" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/49" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.FMS/ResourceSet", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/50" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.FMS/ResourceSet@default", + "scopeType": 0, + "body": { + "$ref": "#/51" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.fms/default/types.md b/artifacts/bicep/aws/aws.fms/default/types.md index ca7d9148..c02037e9 100644 --- a/artifacts/bicep/aws/aws.fms/default/types.md +++ b/artifacts/bicep/aws/aws.fms/default/types.md @@ -3,23 +3,23 @@ ## Resource AWS.FMS/NotificationChannel@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.FMS/NotificationChannelProperties](#awsfmsnotificationchannelproperties) (Required): properties of the resource +* **properties**: [AWS.FMS/NotificationChannelProperties](#awsfmsnotificationchannelproperties) (Required, Identifier): properties of the resource ## Resource AWS.FMS/Policy@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.FMS/PolicyProperties](#awsfmspolicyproperties) (Required): properties of the resource +* **properties**: [AWS.FMS/PolicyProperties](#awsfmspolicyproperties) (Required, Identifier): properties of the resource ## Resource AWS.FMS/ResourceSet@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.FMS/ResourceSetProperties](#awsfmsresourcesetproperties) (Required): properties of the resource +* **properties**: [AWS.FMS/ResourceSetProperties](#awsfmsresourcesetproperties) (Required, Identifier): properties of the resource ## AWS.FMS/NotificationChannelProperties ### Properties @@ -45,51 +45,83 @@ * **SecurityServicePolicyData**: [SecurityServicePolicyData](#securityservicepolicydata) (Required) * **Tags**: [PolicyTag](#policytag)[] +## AWS.FMS/ResourceSetProperties +### Properties +* **Description**: string +* **Id**: string (ReadOnly, Identifier) +* **Name**: string (Required) +* **Resources**: string[] +* **ResourceTypeList**: string[] (Required) +* **Tags**: [Tag](#tag)[] + ## IEMap ### Properties * **ACCOUNT**: string[] * **ORGUNIT**: string[] -## ResourceTag +## NetworkAclCommonPolicy ### Properties -* **Key**: string (Required) -* **Value**: string +* **NetworkAclEntrySet**: [NetworkAclEntrySet](#networkaclentryset) (Required) -## SecurityServicePolicyData +## NetworkAclEntry ### Properties -* **ManagedServiceData**: string -* **PolicyOption**: [PolicyOption](#policyoption) -* **Type**: string (Required) +* **CidrBlock**: string: CIDR block. +* **Egress**: bool (Required): Whether the entry is an egress entry. +* **IcmpTypeCode**: [Policy_IcmpTypeCode](#policyicmptypecode): ICMP type and code. +* **Ipv6CidrBlock**: string: IPv6 CIDR block. +* **PortRange**: [Policy_PortRange](#policyportrange): Port range. +* **Protocol**: string (Required): Protocol. +* **RuleAction**: string (Required): Rule Action. -## PolicyOption +## NetworkAclEntrySet ### Properties -* **NetworkFirewallPolicy**: [NetworkFirewallPolicy](#networkfirewallpolicy) -* **ThirdPartyFirewallPolicy**: [ThirdPartyFirewallPolicy](#thirdpartyfirewallpolicy) +* **FirstEntries**: [NetworkAclEntry](#networkaclentry)[] +* **ForceRemediateForFirstEntries**: bool (Required) +* **ForceRemediateForLastEntries**: bool (Required) +* **LastEntries**: [NetworkAclEntry](#networkaclentry)[] ## NetworkFirewallPolicy ### Properties * **FirewallDeploymentModel**: string (Required) -## ThirdPartyFirewallPolicy +## Policy_IcmpTypeCode ### Properties -* **FirewallDeploymentModel**: string (Required) +* **Code**: int (Required): Code. +* **Type**: int (Required): Type. + +## Policy_PortRange +### Properties +* **From**: int (Required): From Port. +* **To**: int (Required): To Port. + +## PolicyOption +### Properties +* **NetworkAclCommonPolicy**: [NetworkAclCommonPolicy](#networkaclcommonpolicy) +* **NetworkFirewallPolicy**: [NetworkFirewallPolicy](#networkfirewallpolicy) +* **ThirdPartyFirewallPolicy**: [ThirdPartyFirewallPolicy](#thirdpartyfirewallpolicy) ## PolicyTag ### Properties * **Key**: string (Required) * **Value**: string (Required) -## AWS.FMS/ResourceSetProperties +## ResourceTag ### Properties -* **Description**: string -* **Id**: string (ReadOnly, Identifier) -* **Name**: string (Required) -* **Resources**: string[] -* **ResourceTypeList**: string[] (Required) -* **Tags**: [Tag](#tag)[] +* **Key**: string (Required) +* **Value**: string + +## SecurityServicePolicyData +### Properties +* **ManagedServiceData**: string +* **PolicyOption**: [PolicyOption](#policyoption) +* **Type**: string (Required) ## Tag ### Properties * **Key**: string (Required) * **Value**: string (Required) +## ThirdPartyFirewallPolicy +### Properties +* **FirewallDeploymentModel**: string (Required) + diff --git a/artifacts/bicep/aws/aws.forecast/default/types.json b/artifacts/bicep/aws/aws.forecast/default/types.json index 4e657b08..67e3640e 100644 --- a/artifacts/bicep/aws/aws.forecast/default/types.json +++ b/artifacts/bicep/aws/aws.forecast/default/types.json @@ -1 +1,136 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"Arn"}},{"2":{"Name":"MaxResults"}},{"2":{"Name":"NextToken"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.Forecast/DatasetGroupProperties","Properties":{"DatasetArns":{"Type":13,"Flags":0,"Description":"An array of Amazon Resource Names (ARNs) of the datasets that you want to include in the dataset group."},"DatasetGroupArn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN) of the dataset group to delete."},"DatasetGroupName":{"Type":4,"Flags":1,"Description":"A name for the dataset group."},"Domain":{"Type":4,"Flags":1,"Description":"The domain associated with the dataset group. When you add a dataset to a dataset group, this value and the value specified for the Domain parameter of the CreateDataset operation must match."},"Tags":{"Type":14,"Flags":0,"Description":"The tags of Application Insights application."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":11}},{"2":{"Name":"AWS.Forecast/DatasetGroup","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":12,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Forecast/DatasetGroup@default","ScopeType":0,"Body":15}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Arn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MaxResults", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "NextToken", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "IntegerType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.Forecast/DatasetGroupProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Forecast/DatasetGroupProperties", + "properties": { + "DatasetArns": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "An array of Amazon Resource Names (ARNs) of the datasets that you want to include in the dataset group." + }, + "DatasetGroupArn": { + "type": { + "$ref": "#/4" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) of the dataset group to delete." + }, + "DatasetGroupName": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "A name for the dataset group." + }, + "Domain": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The domain associated with the dataset group. When you add a dataset to a dataset group, this value and the value specified for the Domain parameter of the CreateDataset operation must match." + }, + "Tags": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The tags of Application Insights application." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Forecast/DatasetGroup", + "properties": { + "name": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/9" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Forecast/DatasetGroup@default", + "scopeType": 0, + "body": { + "$ref": "#/10" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.forecast/default/types.md b/artifacts/bicep/aws/aws.forecast/default/types.md index 814c6efd..59abc637 100644 --- a/artifacts/bicep/aws/aws.forecast/default/types.md +++ b/artifacts/bicep/aws/aws.forecast/default/types.md @@ -3,9 +3,9 @@ ## Resource AWS.Forecast/DatasetGroup@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Forecast/DatasetGroupProperties](#awsforecastdatasetgroupproperties) (Required): properties of the resource +* **properties**: [AWS.Forecast/DatasetGroupProperties](#awsforecastdatasetgroupproperties) (Required, Identifier): properties of the resource ## AWS.Forecast/DatasetGroupProperties ### Properties diff --git a/artifacts/bicep/aws/aws.frauddetector/default/types.json b/artifacts/bicep/aws/aws.frauddetector/default/types.json index 0ed17359..e4cc4cde 100644 --- a/artifacts/bicep/aws/aws.frauddetector/default/types.json +++ b/artifacts/bicep/aws/aws.frauddetector/default/types.json @@ -1 +1,1585 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"EntityType","Properties":{"Arn":{"Type":4,"Flags":16},"CreatedTime":{"Type":4,"Flags":0,"Description":"The time when the entity type was created."},"Description":{"Type":4,"Flags":0,"Description":"The description."},"Inline":{"Type":2,"Flags":0},"LastUpdatedTime":{"Type":4,"Flags":0,"Description":"The time when the entity type was last updated."},"Name":{"Type":4,"Flags":0},"Tags":{"Type":16,"Flags":0,"Description":"Tags associated with this entity type."}}}},{"2":{"Name":"EventType","Properties":{"Arn":{"Type":4,"Flags":18,"Description":"The ARN of the event type."},"CreatedTime":{"Type":4,"Flags":2,"Description":"The time when the event type was created."},"Description":{"Type":4,"Flags":0,"Description":"The description of the event type."},"EntityTypes":{"Type":17,"Flags":2},"EventVariables":{"Type":18,"Flags":2},"Inline":{"Type":2,"Flags":0},"Labels":{"Type":19,"Flags":2},"LastUpdatedTime":{"Type":4,"Flags":2,"Description":"The time when the event type was last updated."},"Name":{"Type":4,"Flags":0,"Description":"The name for the event type"},"Tags":{"Type":20,"Flags":0,"Description":"Tags associated with this event type."}}}},{"2":{"Name":"EventVariable","Properties":{"Arn":{"Type":4,"Flags":16},"CreatedTime":{"Type":4,"Flags":0,"Description":"The time when the event variable was created."},"DataSource":{"Type":4,"Flags":0},"DataType":{"Type":4,"Flags":0},"DefaultValue":{"Type":4,"Flags":0},"Description":{"Type":4,"Flags":0,"Description":"The description."},"Inline":{"Type":2,"Flags":0},"LastUpdatedTime":{"Type":4,"Flags":0,"Description":"The time when the event variable was last updated."},"Name":{"Type":4,"Flags":0},"Tags":{"Type":21,"Flags":0,"Description":"Tags associated with this event variable."},"VariableType":{"Type":4,"Flags":0}}}},{"2":{"Name":"Label","Properties":{"Arn":{"Type":4,"Flags":16},"CreatedTime":{"Type":4,"Flags":0,"Description":"The time when the label was created."},"Description":{"Type":4,"Flags":0,"Description":"The description."},"Inline":{"Type":2,"Flags":0},"LastUpdatedTime":{"Type":4,"Flags":0,"Description":"The time when the label was last updated."},"Name":{"Type":4,"Flags":0},"Tags":{"Type":22,"Flags":0,"Description":"Tags associated with this label."}}}},{"2":{"Name":"Model","Properties":{"Arn":{"Type":4,"Flags":16}}}},{"2":{"Name":"Outcome","Properties":{"Arn":{"Type":4,"Flags":16},"CreatedTime":{"Type":4,"Flags":0,"Description":"The time when the outcome was created."},"Description":{"Type":4,"Flags":0,"Description":"The description."},"Inline":{"Type":2,"Flags":0},"LastUpdatedTime":{"Type":4,"Flags":0,"Description":"The time when the outcome was last updated."},"Name":{"Type":4,"Flags":0},"Tags":{"Type":23,"Flags":0,"Description":"Tags associated with this outcome."}}}},{"2":{"Name":"Rule","Properties":{"Arn":{"Type":4,"Flags":16},"CreatedTime":{"Type":4,"Flags":0,"Description":"The time when the event type was created."},"Description":{"Type":4,"Flags":0,"Description":"The description."},"DetectorId":{"Type":4,"Flags":0},"Expression":{"Type":4,"Flags":0},"Language":{"Type":4,"Flags":0},"LastUpdatedTime":{"Type":4,"Flags":0,"Description":"The time when the event type was last updated."},"Outcomes":{"Type":24,"Flags":0},"RuleId":{"Type":4,"Flags":0},"RuleVersion":{"Type":4,"Flags":0},"Tags":{"Type":25,"Flags":0,"Description":"Tags associated with this event type."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"3":{"ItemType":15}},{"3":{"ItemType":8}},{"3":{"ItemType":10}},{"3":{"ItemType":11}},{"3":{"ItemType":15}},{"3":{"ItemType":15}},{"3":{"ItemType":15}},{"3":{"ItemType":15}},{"3":{"ItemType":13}},{"3":{"ItemType":15}},{"2":{"Name":"AWS.FraudDetector/DetectorProperties","Properties":{"Arn":{"Type":4,"Flags":18,"Description":"The ARN of the detector."},"AssociatedModels":{"Type":27,"Flags":2,"Description":"The models to associate with this detector."},"CreatedTime":{"Type":4,"Flags":2,"Description":"The time when the detector was created."},"Description":{"Type":4,"Flags":0,"Description":"The description of the detector."},"DetectorId":{"Type":4,"Flags":1,"Description":"The ID of the detector"},"DetectorVersionId":{"Type":4,"Flags":2,"Description":"The active version ID of the detector"},"DetectorVersionStatus":{"Type":4,"Flags":0,"Description":"The desired detector version status for the detector"},"EventType":{"Type":9,"Flags":1,"Description":"The event type to associate this detector with."},"LastUpdatedTime":{"Type":4,"Flags":2,"Description":"The time when the detector was last updated."},"RuleExecutionMode":{"Type":4,"Flags":0},"Rules":{"Type":28,"Flags":3},"Tags":{"Type":29,"Flags":0,"Description":"Tags associated with this detector."}}}},{"3":{"ItemType":12}},{"3":{"ItemType":14}},{"3":{"ItemType":15}},{"2":{"Name":"AWS.FraudDetector/Detector","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":26,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.FraudDetector/Detector@default","ScopeType":0,"Body":30}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.FraudDetector/EntityTypeProperties","Properties":{"Arn":{"Type":4,"Flags":18,"Description":"The entity type ARN."},"CreatedTime":{"Type":4,"Flags":2,"Description":"The timestamp when the entity type was created."},"Description":{"Type":4,"Flags":0,"Description":"The entity type description."},"LastUpdatedTime":{"Type":4,"Flags":2,"Description":"The timestamp when the entity type was last updated."},"Name":{"Type":4,"Flags":1,"Description":"The name of the entity type."},"Tags":{"Type":34,"Flags":0,"Description":"Tags associated with this entity type."}}}},{"3":{"ItemType":32}},{"2":{"Name":"AWS.FraudDetector/EntityType","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":33,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.FraudDetector/EntityType@default","ScopeType":0,"Body":35}},{"2":{"Name":"EntityType","Properties":{"Arn":{"Type":4,"Flags":16},"CreatedTime":{"Type":4,"Flags":0,"Description":"The time when the event type was created."},"Description":{"Type":4,"Flags":0,"Description":"The description."},"Inline":{"Type":2,"Flags":0},"LastUpdatedTime":{"Type":4,"Flags":0,"Description":"The time when the event type was last updated."},"Name":{"Type":4,"Flags":0},"Tags":{"Type":41,"Flags":0,"Description":"Tags associated with this event type."}}}},{"2":{"Name":"EventVariable","Properties":{"Arn":{"Type":4,"Flags":16},"CreatedTime":{"Type":4,"Flags":0,"Description":"The time when the event type was created."},"DataSource":{"Type":4,"Flags":0},"DataType":{"Type":4,"Flags":0},"DefaultValue":{"Type":4,"Flags":0},"Description":{"Type":4,"Flags":0,"Description":"The description."},"Inline":{"Type":2,"Flags":0},"LastUpdatedTime":{"Type":4,"Flags":0,"Description":"The time when the event type was last updated."},"Name":{"Type":4,"Flags":0},"Tags":{"Type":42,"Flags":0,"Description":"Tags associated with this event type."},"VariableType":{"Type":4,"Flags":0}}}},{"2":{"Name":"Label","Properties":{"Arn":{"Type":4,"Flags":16},"CreatedTime":{"Type":4,"Flags":0,"Description":"The time when the event type was created."},"Description":{"Type":4,"Flags":0,"Description":"The description."},"Inline":{"Type":2,"Flags":0},"LastUpdatedTime":{"Type":4,"Flags":0,"Description":"The time when the event type was last updated."},"Name":{"Type":4,"Flags":0},"Tags":{"Type":43,"Flags":0,"Description":"Tags associated with this event type."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"3":{"ItemType":40}},{"3":{"ItemType":40}},{"3":{"ItemType":40}},{"2":{"Name":"AWS.FraudDetector/EventTypeProperties","Properties":{"Arn":{"Type":4,"Flags":18,"Description":"The ARN of the event type."},"CreatedTime":{"Type":4,"Flags":2,"Description":"The time when the event type was created."},"Description":{"Type":4,"Flags":0,"Description":"The description of the event type."},"EntityTypes":{"Type":45,"Flags":3},"EventVariables":{"Type":46,"Flags":3},"Labels":{"Type":47,"Flags":3},"LastUpdatedTime":{"Type":4,"Flags":2,"Description":"The time when the event type was last updated."},"Name":{"Type":4,"Flags":1,"Description":"The name for the event type"},"Tags":{"Type":48,"Flags":0,"Description":"Tags associated with this event type."}}}},{"3":{"ItemType":37}},{"3":{"ItemType":38}},{"3":{"ItemType":39}},{"3":{"ItemType":40}},{"2":{"Name":"AWS.FraudDetector/EventType","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":44,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.FraudDetector/EventType@default","ScopeType":0,"Body":49}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.FraudDetector/LabelProperties","Properties":{"Arn":{"Type":4,"Flags":18,"Description":"The label ARN."},"CreatedTime":{"Type":4,"Flags":2,"Description":"The timestamp when the label was created."},"Description":{"Type":4,"Flags":0,"Description":"The label description."},"LastUpdatedTime":{"Type":4,"Flags":2,"Description":"The timestamp when the label was last updated."},"Name":{"Type":4,"Flags":1,"Description":"The name of the label."},"Tags":{"Type":53,"Flags":0,"Description":"Tags associated with this label."}}}},{"3":{"ItemType":51}},{"2":{"Name":"AWS.FraudDetector/Label","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":52,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.FraudDetector/Label@default","ScopeType":0,"Body":54}},{"2":{"Name":"Element"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.FraudDetector/ListProperties","Properties":{"Arn":{"Type":4,"Flags":18,"Description":"The list ARN."},"CreatedTime":{"Type":4,"Flags":2,"Description":"The time when the list was created."},"Description":{"Type":4,"Flags":0,"Description":"The description of the list."},"Elements":{"Type":59,"Flags":0,"Description":"The elements in this list."},"LastUpdatedTime":{"Type":4,"Flags":2,"Description":"The time when the list was last updated."},"Name":{"Type":4,"Flags":1,"Description":"The name of the list."},"Tags":{"Type":60,"Flags":0,"Description":"Tags associated with this list."},"VariableType":{"Type":4,"Flags":0,"Description":"The variable type of the list."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":57}},{"2":{"Name":"AWS.FraudDetector/List","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":58,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.FraudDetector/List@default","ScopeType":0,"Body":61}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.FraudDetector/OutcomeProperties","Properties":{"Arn":{"Type":4,"Flags":18,"Description":"The outcome ARN."},"CreatedTime":{"Type":4,"Flags":2,"Description":"The timestamp when the outcome was created."},"Description":{"Type":4,"Flags":0,"Description":"The outcome description."},"LastUpdatedTime":{"Type":4,"Flags":2,"Description":"The timestamp when the outcome was last updated."},"Name":{"Type":4,"Flags":1,"Description":"The name of the outcome."},"Tags":{"Type":65,"Flags":0,"Description":"Tags associated with this outcome."}}}},{"3":{"ItemType":63}},{"2":{"Name":"AWS.FraudDetector/Outcome","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":64,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.FraudDetector/Outcome@default","ScopeType":0,"Body":66}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.FraudDetector/VariableProperties","Properties":{"Arn":{"Type":4,"Flags":18,"Description":"The ARN of the variable."},"CreatedTime":{"Type":4,"Flags":2,"Description":"The time when the variable was created."},"DataSource":{"Type":4,"Flags":1,"Description":"The source of the data."},"DataType":{"Type":4,"Flags":1,"Description":"The data type."},"DefaultValue":{"Type":4,"Flags":1,"Description":"The default value for the variable when no value is received."},"Description":{"Type":4,"Flags":0,"Description":"The description."},"LastUpdatedTime":{"Type":4,"Flags":2,"Description":"The time when the variable was last updated."},"Name":{"Type":4,"Flags":1,"Description":"The name of the variable."},"Tags":{"Type":70,"Flags":0,"Description":"Tags associated with this variable."},"VariableType":{"Type":4,"Flags":0,"Description":"The variable type. For more information see https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types"}}}},{"3":{"ItemType":68}},{"2":{"Name":"AWS.FraudDetector/Variable","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":69,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.FraudDetector/Variable@default","ScopeType":0,"Body":71}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "EntityType", + "properties": { + "Arn": { + "type": { + "$ref": "#/8" + }, + "flags": 16 + }, + "CreatedTime": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The time when the entity type was created." + }, + "Description": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The description." + }, + "Inline": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "LastUpdatedTime": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The time when the entity type was last updated." + }, + "Name": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "Tags associated with this entity type." + } + } + }, + { + "$type": "ObjectType", + "name": "EventType", + "properties": { + "Arn": { + "type": { + "$ref": "#/8" + }, + "flags": 18, + "description": "The ARN of the event type." + }, + "CreatedTime": { + "type": { + "$ref": "#/8" + }, + "flags": 2, + "description": "The time when the event type was created." + }, + "Description": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The description of the event type." + }, + "EntityTypes": { + "type": { + "$ref": "#/11" + }, + "flags": 2 + }, + "EventVariables": { + "type": { + "$ref": "#/12" + }, + "flags": 2 + }, + "Inline": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "Labels": { + "type": { + "$ref": "#/13" + }, + "flags": 2 + }, + "LastUpdatedTime": { + "type": { + "$ref": "#/8" + }, + "flags": 2, + "description": "The time when the event type was last updated." + }, + "Name": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The name for the event type" + }, + "Tags": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "Tags associated with this event type." + } + } + }, + { + "$type": "ObjectType", + "name": "EventVariable", + "properties": { + "Arn": { + "type": { + "$ref": "#/8" + }, + "flags": 16 + }, + "CreatedTime": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The time when the event variable was created." + }, + "DataSource": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "DataType": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "DefaultValue": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "Description": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The description." + }, + "Inline": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "LastUpdatedTime": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The time when the event variable was last updated." + }, + "Name": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "Tags associated with this event variable." + }, + "VariableType": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Label", + "properties": { + "Arn": { + "type": { + "$ref": "#/8" + }, + "flags": 16 + }, + "CreatedTime": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The time when the label was created." + }, + "Description": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The description." + }, + "Inline": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "LastUpdatedTime": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The time when the label was last updated." + }, + "Name": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/16" + }, + "flags": 0, + "description": "Tags associated with this label." + } + } + }, + { + "$type": "ObjectType", + "name": "Model", + "properties": { + "Arn": { + "type": { + "$ref": "#/8" + }, + "flags": 16 + } + } + }, + { + "$type": "ObjectType", + "name": "Outcome", + "properties": { + "Arn": { + "type": { + "$ref": "#/8" + }, + "flags": 16 + }, + "CreatedTime": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The time when the outcome was created." + }, + "Description": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The description." + }, + "Inline": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "LastUpdatedTime": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The time when the outcome was last updated." + }, + "Name": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/17" + }, + "flags": 0, + "description": "Tags associated with this outcome." + } + } + }, + { + "$type": "ObjectType", + "name": "Rule", + "properties": { + "Arn": { + "type": { + "$ref": "#/8" + }, + "flags": 16 + }, + "CreatedTime": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The time when the event type was created." + }, + "Description": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The description." + }, + "DetectorId": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "Expression": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "Language": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "LastUpdatedTime": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The time when the event type was last updated." + }, + "Outcomes": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "RuleId": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "RuleVersion": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/19" + }, + "flags": 0, + "description": "Tags associated with this event type." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/7" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/7" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/7" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/7" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/7" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/7" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.FraudDetector/DetectorProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/7" + } + }, + { + "$type": "ObjectType", + "name": "AWS.FraudDetector/DetectorProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/8" + }, + "flags": 18, + "description": "The ARN of the detector." + }, + "AssociatedModels": { + "type": { + "$ref": "#/21" + }, + "flags": 2, + "description": "The models to associate with this detector." + }, + "CreatedTime": { + "type": { + "$ref": "#/8" + }, + "flags": 2, + "description": "The time when the detector was created." + }, + "Description": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The description of the detector." + }, + "DetectorId": { + "type": { + "$ref": "#/8" + }, + "flags": 1, + "description": "The ID of the detector" + }, + "DetectorVersionId": { + "type": { + "$ref": "#/8" + }, + "flags": 2, + "description": "The active version ID of the detector" + }, + "DetectorVersionStatus": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The desired detector version status for the detector" + }, + "EventType": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The event type to associate this detector with." + }, + "LastUpdatedTime": { + "type": { + "$ref": "#/8" + }, + "flags": 2, + "description": "The time when the detector was last updated." + }, + "RuleExecutionMode": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "Rules": { + "type": { + "$ref": "#/22" + }, + "flags": 3 + }, + "Tags": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "Tags associated with this detector." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.FraudDetector/Detector", + "properties": { + "name": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/8" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/24" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.FraudDetector/Detector@default", + "scopeType": 0, + "body": { + "$ref": "#/25" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.FraudDetector/EntityTypeProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/27" + } + }, + { + "$type": "ObjectType", + "name": "AWS.FraudDetector/EntityTypeProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/8" + }, + "flags": 18, + "description": "The entity type ARN." + }, + "CreatedTime": { + "type": { + "$ref": "#/8" + }, + "flags": 2, + "description": "The timestamp when the entity type was created." + }, + "Description": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The entity type description." + }, + "LastUpdatedTime": { + "type": { + "$ref": "#/8" + }, + "flags": 2, + "description": "The timestamp when the entity type was last updated." + }, + "Name": { + "type": { + "$ref": "#/8" + }, + "flags": 1, + "description": "The name of the entity type." + }, + "Tags": { + "type": { + "$ref": "#/29" + }, + "flags": 0, + "description": "Tags associated with this entity type." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.FraudDetector/EntityType", + "properties": { + "name": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/8" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/30" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.FraudDetector/EntityType@default", + "scopeType": 0, + "body": { + "$ref": "#/31" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "EntityType", + "properties": { + "Arn": { + "type": { + "$ref": "#/8" + }, + "flags": 16 + }, + "CreatedTime": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The time when the event type was created." + }, + "Description": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The description." + }, + "Inline": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "LastUpdatedTime": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The time when the event type was last updated." + }, + "Name": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/37" + }, + "flags": 0, + "description": "Tags associated with this event type." + } + } + }, + { + "$type": "ObjectType", + "name": "EventVariable", + "properties": { + "Arn": { + "type": { + "$ref": "#/8" + }, + "flags": 16 + }, + "CreatedTime": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The time when the event type was created." + }, + "DataSource": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "DataType": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "DefaultValue": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "Description": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The description." + }, + "Inline": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "LastUpdatedTime": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The time when the event type was last updated." + }, + "Name": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/38" + }, + "flags": 0, + "description": "Tags associated with this event type." + }, + "VariableType": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Label", + "properties": { + "Arn": { + "type": { + "$ref": "#/8" + }, + "flags": 16 + }, + "CreatedTime": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The time when the event type was created." + }, + "Description": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The description." + }, + "Inline": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "LastUpdatedTime": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The time when the event type was last updated." + }, + "Name": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/39" + }, + "flags": 0, + "description": "Tags associated with this event type." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/36" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/36" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/36" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.FraudDetector/EventTypeProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/33" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/34" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/35" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/36" + } + }, + { + "$type": "ObjectType", + "name": "AWS.FraudDetector/EventTypeProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/8" + }, + "flags": 18, + "description": "The ARN of the event type." + }, + "CreatedTime": { + "type": { + "$ref": "#/8" + }, + "flags": 2, + "description": "The time when the event type was created." + }, + "Description": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The description of the event type." + }, + "EntityTypes": { + "type": { + "$ref": "#/41" + }, + "flags": 3 + }, + "EventVariables": { + "type": { + "$ref": "#/42" + }, + "flags": 3 + }, + "Labels": { + "type": { + "$ref": "#/43" + }, + "flags": 3 + }, + "LastUpdatedTime": { + "type": { + "$ref": "#/8" + }, + "flags": 2, + "description": "The time when the event type was last updated." + }, + "Name": { + "type": { + "$ref": "#/8" + }, + "flags": 1, + "description": "The name for the event type" + }, + "Tags": { + "type": { + "$ref": "#/44" + }, + "flags": 0, + "description": "Tags associated with this event type." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.FraudDetector/EventType", + "properties": { + "name": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/8" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/45" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.FraudDetector/EventType@default", + "scopeType": 0, + "body": { + "$ref": "#/46" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.FraudDetector/LabelProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/48" + } + }, + { + "$type": "ObjectType", + "name": "AWS.FraudDetector/LabelProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/8" + }, + "flags": 18, + "description": "The label ARN." + }, + "CreatedTime": { + "type": { + "$ref": "#/8" + }, + "flags": 2, + "description": "The timestamp when the label was created." + }, + "Description": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The label description." + }, + "LastUpdatedTime": { + "type": { + "$ref": "#/8" + }, + "flags": 2, + "description": "The timestamp when the label was last updated." + }, + "Name": { + "type": { + "$ref": "#/8" + }, + "flags": 1, + "description": "The name of the label." + }, + "Tags": { + "type": { + "$ref": "#/50" + }, + "flags": 0, + "description": "Tags associated with this label." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.FraudDetector/Label", + "properties": { + "name": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/8" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/51" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.FraudDetector/Label@default", + "scopeType": 0, + "body": { + "$ref": "#/52" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Element", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/8" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/8" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.FraudDetector/ListProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/8" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/55" + } + }, + { + "$type": "ObjectType", + "name": "AWS.FraudDetector/ListProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/8" + }, + "flags": 18, + "description": "The list ARN." + }, + "CreatedTime": { + "type": { + "$ref": "#/8" + }, + "flags": 2, + "description": "The time when the list was created." + }, + "Description": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The description of the list." + }, + "Elements": { + "type": { + "$ref": "#/57" + }, + "flags": 0, + "description": "The elements in this list." + }, + "LastUpdatedTime": { + "type": { + "$ref": "#/8" + }, + "flags": 2, + "description": "The time when the list was last updated." + }, + "Name": { + "type": { + "$ref": "#/8" + }, + "flags": 1, + "description": "The name of the list." + }, + "Tags": { + "type": { + "$ref": "#/58" + }, + "flags": 0, + "description": "Tags associated with this list." + }, + "VariableType": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The variable type of the list." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.FraudDetector/List", + "properties": { + "name": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/8" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/59" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.FraudDetector/List@default", + "scopeType": 0, + "body": { + "$ref": "#/60" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.FraudDetector/OutcomeProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/62" + } + }, + { + "$type": "ObjectType", + "name": "AWS.FraudDetector/OutcomeProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/8" + }, + "flags": 18, + "description": "The outcome ARN." + }, + "CreatedTime": { + "type": { + "$ref": "#/8" + }, + "flags": 2, + "description": "The timestamp when the outcome was created." + }, + "Description": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The outcome description." + }, + "LastUpdatedTime": { + "type": { + "$ref": "#/8" + }, + "flags": 2, + "description": "The timestamp when the outcome was last updated." + }, + "Name": { + "type": { + "$ref": "#/8" + }, + "flags": 1, + "description": "The name of the outcome." + }, + "Tags": { + "type": { + "$ref": "#/64" + }, + "flags": 0, + "description": "Tags associated with this outcome." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.FraudDetector/Outcome", + "properties": { + "name": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/8" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/65" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.FraudDetector/Outcome@default", + "scopeType": 0, + "body": { + "$ref": "#/66" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.FraudDetector/VariableProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/68" + } + }, + { + "$type": "ObjectType", + "name": "AWS.FraudDetector/VariableProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/8" + }, + "flags": 18, + "description": "The ARN of the variable." + }, + "CreatedTime": { + "type": { + "$ref": "#/8" + }, + "flags": 2, + "description": "The time when the variable was created." + }, + "DataSource": { + "type": { + "$ref": "#/8" + }, + "flags": 1, + "description": "The source of the data." + }, + "DataType": { + "type": { + "$ref": "#/8" + }, + "flags": 1, + "description": "The data type." + }, + "DefaultValue": { + "type": { + "$ref": "#/8" + }, + "flags": 1, + "description": "The default value for the variable when no value is received." + }, + "Description": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The description." + }, + "LastUpdatedTime": { + "type": { + "$ref": "#/8" + }, + "flags": 2, + "description": "The time when the variable was last updated." + }, + "Name": { + "type": { + "$ref": "#/8" + }, + "flags": 1, + "description": "The name of the variable." + }, + "Tags": { + "type": { + "$ref": "#/70" + }, + "flags": 0, + "description": "Tags associated with this variable." + }, + "VariableType": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The variable type. For more information see https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.FraudDetector/Variable", + "properties": { + "name": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/8" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/71" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.FraudDetector/Variable@default", + "scopeType": 0, + "body": { + "$ref": "#/72" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.frauddetector/default/types.md b/artifacts/bicep/aws/aws.frauddetector/default/types.md index b758573a..49ac34e6 100644 --- a/artifacts/bicep/aws/aws.frauddetector/default/types.md +++ b/artifacts/bicep/aws/aws.frauddetector/default/types.md @@ -3,51 +3,51 @@ ## Resource AWS.FraudDetector/Detector@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.FraudDetector/DetectorProperties](#awsfrauddetectordetectorproperties) (Required): properties of the resource +* **properties**: [AWS.FraudDetector/DetectorProperties](#awsfrauddetectordetectorproperties) (Required, Identifier): properties of the resource ## Resource AWS.FraudDetector/EntityType@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.FraudDetector/EntityTypeProperties](#awsfrauddetectorentitytypeproperties) (Required): properties of the resource +* **properties**: [AWS.FraudDetector/EntityTypeProperties](#awsfrauddetectorentitytypeproperties) (Required, Identifier): properties of the resource ## Resource AWS.FraudDetector/EventType@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.FraudDetector/EventTypeProperties](#awsfrauddetectoreventtypeproperties) (Required): properties of the resource +* **properties**: [AWS.FraudDetector/EventTypeProperties](#awsfrauddetectoreventtypeproperties) (Required, Identifier): properties of the resource ## Resource AWS.FraudDetector/Label@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.FraudDetector/LabelProperties](#awsfrauddetectorlabelproperties) (Required): properties of the resource +* **properties**: [AWS.FraudDetector/LabelProperties](#awsfrauddetectorlabelproperties) (Required, Identifier): properties of the resource ## Resource AWS.FraudDetector/List@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.FraudDetector/ListProperties](#awsfrauddetectorlistproperties) (Required): properties of the resource +* **properties**: [AWS.FraudDetector/ListProperties](#awsfrauddetectorlistproperties) (Required, Identifier): properties of the resource ## Resource AWS.FraudDetector/Outcome@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.FraudDetector/OutcomeProperties](#awsfrauddetectoroutcomeproperties) (Required): properties of the resource +* **properties**: [AWS.FraudDetector/OutcomeProperties](#awsfrauddetectoroutcomeproperties) (Required, Identifier): properties of the resource ## Resource AWS.FraudDetector/Variable@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.FraudDetector/VariableProperties](#awsfrauddetectorvariableproperties) (Required): properties of the resource +* **properties**: [AWS.FraudDetector/VariableProperties](#awsfrauddetectorvariableproperties) (Required, Identifier): properties of the resource ## AWS.FraudDetector/DetectorProperties ### Properties @@ -64,23 +64,69 @@ * **Rules**: [Rule](#rule)[] (Required, ReadOnly) * **Tags**: [Tag](#tag)[]: Tags associated with this detector. -## Model +## AWS.FraudDetector/EntityTypeProperties ### Properties -* **Arn**: string (Identifier) +* **Arn**: string (ReadOnly, Identifier): The entity type ARN. +* **CreatedTime**: string (ReadOnly): The timestamp when the entity type was created. +* **Description**: string: The entity type description. +* **LastUpdatedTime**: string (ReadOnly): The timestamp when the entity type was last updated. +* **Name**: string (Required): The name of the entity type. +* **Tags**: [Tag](#tag)[]: Tags associated with this entity type. -## EventType +## AWS.FraudDetector/EventTypeProperties ### Properties * **Arn**: string (ReadOnly, Identifier): The ARN of the event type. * **CreatedTime**: string (ReadOnly): The time when the event type was created. * **Description**: string: The description of the event type. -* **EntityTypes**: [EntityType](#entitytype)[] (ReadOnly) -* **EventVariables**: [EventVariable](#eventvariable)[] (ReadOnly) -* **Inline**: bool -* **Labels**: [Label](#label)[] (ReadOnly) +* **EntityTypes**: [EntityType](#entitytype)[] (Required, ReadOnly) +* **EventVariables**: [EventVariable](#eventvariable)[] (Required, ReadOnly) +* **Labels**: [Label](#label)[] (Required, ReadOnly) * **LastUpdatedTime**: string (ReadOnly): The time when the event type was last updated. -* **Name**: string: The name for the event type +* **Name**: string (Required): The name for the event type * **Tags**: [Tag](#tag)[]: Tags associated with this event type. +## AWS.FraudDetector/LabelProperties +### Properties +* **Arn**: string (ReadOnly, Identifier): The label ARN. +* **CreatedTime**: string (ReadOnly): The timestamp when the label was created. +* **Description**: string: The label description. +* **LastUpdatedTime**: string (ReadOnly): The timestamp when the label was last updated. +* **Name**: string (Required): The name of the label. +* **Tags**: [Tag](#tag)[]: Tags associated with this label. + +## AWS.FraudDetector/ListProperties +### Properties +* **Arn**: string (ReadOnly, Identifier): The list ARN. +* **CreatedTime**: string (ReadOnly): The time when the list was created. +* **Description**: string: The description of the list. +* **Elements**: string[]: The elements in this list. +* **LastUpdatedTime**: string (ReadOnly): The time when the list was last updated. +* **Name**: string (Required): The name of the list. +* **Tags**: [Tag](#tag)[]: Tags associated with this list. +* **VariableType**: string: The variable type of the list. + +## AWS.FraudDetector/OutcomeProperties +### Properties +* **Arn**: string (ReadOnly, Identifier): The outcome ARN. +* **CreatedTime**: string (ReadOnly): The timestamp when the outcome was created. +* **Description**: string: The outcome description. +* **LastUpdatedTime**: string (ReadOnly): The timestamp when the outcome was last updated. +* **Name**: string (Required): The name of the outcome. +* **Tags**: [Tag](#tag)[]: Tags associated with this outcome. + +## AWS.FraudDetector/VariableProperties +### Properties +* **Arn**: string (ReadOnly, Identifier): The ARN of the variable. +* **CreatedTime**: string (ReadOnly): The time when the variable was created. +* **DataSource**: string (Required): The source of the data. +* **DataType**: string (Required): The data type. +* **DefaultValue**: string (Required): The default value for the variable when no value is received. +* **Description**: string: The description. +* **LastUpdatedTime**: string (ReadOnly): The time when the variable was last updated. +* **Name**: string (Required): The name of the variable. +* **Tags**: [Tag](#tag)[]: Tags associated with this variable. +* **VariableType**: string: The variable type. For more information see https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types + ## EntityType ### Properties * **Arn**: string (Identifier) @@ -91,10 +137,28 @@ * **Name**: string * **Tags**: [Tag](#tag)[]: Tags associated with this entity type. -## Tag +## EntityType ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **Arn**: string (Identifier) +* **CreatedTime**: string: The time when the event type was created. +* **Description**: string: The description. +* **Inline**: bool +* **LastUpdatedTime**: string: The time when the event type was last updated. +* **Name**: string +* **Tags**: [Tag](#tag)[]: Tags associated with this event type. + +## EventType +### Properties +* **Arn**: string (ReadOnly, Identifier): The ARN of the event type. +* **CreatedTime**: string (ReadOnly): The time when the event type was created. +* **Description**: string: The description of the event type. +* **EntityTypes**: [EntityType](#entitytype)[] (ReadOnly) +* **EventVariables**: [EventVariable](#eventvariable)[] (ReadOnly) +* **Inline**: bool +* **Labels**: [Label](#label)[] (ReadOnly) +* **LastUpdatedTime**: string (ReadOnly): The time when the event type was last updated. +* **Name**: string: The name for the event type +* **Tags**: [Tag](#tag)[]: Tags associated with this event type. ## EventVariable ### Properties @@ -110,6 +174,20 @@ * **Tags**: [Tag](#tag)[]: Tags associated with this event variable. * **VariableType**: string +## EventVariable +### Properties +* **Arn**: string (Identifier) +* **CreatedTime**: string: The time when the event type was created. +* **DataSource**: string +* **DataType**: string +* **DefaultValue**: string +* **Description**: string: The description. +* **Inline**: bool +* **LastUpdatedTime**: string: The time when the event type was last updated. +* **Name**: string +* **Tags**: [Tag](#tag)[]: Tags associated with this event type. +* **VariableType**: string + ## Label ### Properties * **Arn**: string (Identifier) @@ -120,20 +198,20 @@ * **Name**: string * **Tags**: [Tag](#tag)[]: Tags associated with this label. -## Rule +## Label ### Properties * **Arn**: string (Identifier) * **CreatedTime**: string: The time when the event type was created. * **Description**: string: The description. -* **DetectorId**: string -* **Expression**: string -* **Language**: string +* **Inline**: bool * **LastUpdatedTime**: string: The time when the event type was last updated. -* **Outcomes**: [Outcome](#outcome)[] -* **RuleId**: string -* **RuleVersion**: string +* **Name**: string * **Tags**: [Tag](#tag)[]: Tags associated with this event type. +## Model +### Properties +* **Arn**: string (Identifier) + ## Outcome ### Properties * **Arn**: string (Identifier) @@ -144,40 +222,18 @@ * **Name**: string * **Tags**: [Tag](#tag)[]: Tags associated with this outcome. -## AWS.FraudDetector/EntityTypeProperties -### Properties -* **Arn**: string (ReadOnly, Identifier): The entity type ARN. -* **CreatedTime**: string (ReadOnly): The timestamp when the entity type was created. -* **Description**: string: The entity type description. -* **LastUpdatedTime**: string (ReadOnly): The timestamp when the entity type was last updated. -* **Name**: string (Required): The name of the entity type. -* **Tags**: [Tag](#tag)[]: Tags associated with this entity type. - -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - -## AWS.FraudDetector/EventTypeProperties -### Properties -* **Arn**: string (ReadOnly, Identifier): The ARN of the event type. -* **CreatedTime**: string (ReadOnly): The time when the event type was created. -* **Description**: string: The description of the event type. -* **EntityTypes**: [EntityType](#entitytype)[] (Required, ReadOnly) -* **EventVariables**: [EventVariable](#eventvariable)[] (Required, ReadOnly) -* **Labels**: [Label](#label)[] (Required, ReadOnly) -* **LastUpdatedTime**: string (ReadOnly): The time when the event type was last updated. -* **Name**: string (Required): The name for the event type -* **Tags**: [Tag](#tag)[]: Tags associated with this event type. - -## EntityType +## Rule ### Properties * **Arn**: string (Identifier) * **CreatedTime**: string: The time when the event type was created. * **Description**: string: The description. -* **Inline**: bool +* **DetectorId**: string +* **Expression**: string +* **Language**: string * **LastUpdatedTime**: string: The time when the event type was last updated. -* **Name**: string +* **Outcomes**: [Outcome](#outcome)[] +* **RuleId**: string +* **RuleVersion**: string * **Tags**: [Tag](#tag)[]: Tags associated with this event type. ## Tag @@ -185,87 +241,31 @@ * **Key**: string (Required) * **Value**: string (Required) -## EventVariable -### Properties -* **Arn**: string (Identifier) -* **CreatedTime**: string: The time when the event type was created. -* **DataSource**: string -* **DataType**: string -* **DefaultValue**: string -* **Description**: string: The description. -* **Inline**: bool -* **LastUpdatedTime**: string: The time when the event type was last updated. -* **Name**: string -* **Tags**: [Tag](#tag)[]: Tags associated with this event type. -* **VariableType**: string - -## Label -### Properties -* **Arn**: string (Identifier) -* **CreatedTime**: string: The time when the event type was created. -* **Description**: string: The description. -* **Inline**: bool -* **LastUpdatedTime**: string: The time when the event type was last updated. -* **Name**: string -* **Tags**: [Tag](#tag)[]: Tags associated with this event type. - -## AWS.FraudDetector/LabelProperties +## Tag ### Properties -* **Arn**: string (ReadOnly, Identifier): The label ARN. -* **CreatedTime**: string (ReadOnly): The timestamp when the label was created. -* **Description**: string: The label description. -* **LastUpdatedTime**: string (ReadOnly): The timestamp when the label was last updated. -* **Name**: string (Required): The name of the label. -* **Tags**: [Tag](#tag)[]: Tags associated with this label. +* **Key**: string (Required) +* **Value**: string (Required) ## Tag ### Properties * **Key**: string (Required) * **Value**: string (Required) -## AWS.FraudDetector/ListProperties +## Tag ### Properties -* **Arn**: string (ReadOnly, Identifier): The list ARN. -* **CreatedTime**: string (ReadOnly): The time when the list was created. -* **Description**: string: The description of the list. -* **Elements**: string[]: The elements in this list. -* **LastUpdatedTime**: string (ReadOnly): The time when the list was last updated. -* **Name**: string (Required): The name of the list. -* **Tags**: [Tag](#tag)[]: Tags associated with this list. -* **VariableType**: string: The variable type of the list. +* **Key**: string (Required) +* **Value**: string (Required) ## Tag ### Properties * **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. * **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -## AWS.FraudDetector/OutcomeProperties -### Properties -* **Arn**: string (ReadOnly, Identifier): The outcome ARN. -* **CreatedTime**: string (ReadOnly): The timestamp when the outcome was created. -* **Description**: string: The outcome description. -* **LastUpdatedTime**: string (ReadOnly): The timestamp when the outcome was last updated. -* **Name**: string (Required): The name of the outcome. -* **Tags**: [Tag](#tag)[]: Tags associated with this outcome. - ## Tag ### Properties * **Key**: string (Required) * **Value**: string (Required) -## AWS.FraudDetector/VariableProperties -### Properties -* **Arn**: string (ReadOnly, Identifier): The ARN of the variable. -* **CreatedTime**: string (ReadOnly): The time when the variable was created. -* **DataSource**: string (Required): The source of the data. -* **DataType**: string (Required): The data type. -* **DefaultValue**: string (Required): The default value for the variable when no value is received. -* **Description**: string: The description. -* **LastUpdatedTime**: string (ReadOnly): The time when the variable was last updated. -* **Name**: string (Required): The name of the variable. -* **Tags**: [Tag](#tag)[]: Tags associated with this variable. -* **VariableType**: string: The variable type. For more information see https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types - ## Tag ### Properties * **Key**: string (Required) diff --git a/artifacts/bicep/aws/aws.fsx/default/types.json b/artifacts/bicep/aws/aws.fsx/default/types.json index 3449acc3..a1970c7a 100644 --- a/artifacts/bicep/aws/aws.fsx/default/types.json +++ b/artifacts/bicep/aws/aws.fsx/default/types.json @@ -1 +1,220 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"AutoExportPolicy","Properties":{"Events":{"Type":14,"Flags":1,"Description":"The ``AutoExportPolicy`` can have the following event values:\n + ``NEW`` - New files and directories are automatically exported to the data repository as they are added to the file system.\n + ``CHANGED`` - Changes to files and directories on the file system are automatically exported to the data repository.\n + ``DELETED`` - Files and directories are automatically deleted on the data repository when they are deleted on the file system.\n \n You can define any combination of event types for your ``AutoExportPolicy``."}}}},{"2":{"Name":"AutoImportPolicy","Properties":{"Events":{"Type":15,"Flags":1,"Description":"The ``AutoImportPolicy`` can have the following event values:\n + ``NEW`` - Amazon FSx automatically imports metadata of files added to the linked S3 bucket that do not currently exist in the FSx file system.\n + ``CHANGED`` - Amazon FSx automatically updates file metadata and invalidates existing file content on the file system as files change in the data repository.\n + ``DELETED`` - Amazon FSx automatically deletes files on the file system as corresponding files are deleted in the data repository.\n \n You can define any combination of event types for your ``AutoImportPolicy``."}}}},{"2":{"Name":"EventType"}},{"2":{"Name":"EventTypes"}},{"2":{"Name":"S3","Properties":{"AutoExportPolicy":{"Type":8,"Flags":0,"Description":"Describes a data repository association's automatic export policy. The ``AutoExportPolicy`` defines the types of updated objects on the file system that will be automatically exported to the data repository. As you create, modify, or delete files, Amazon FSx for Lustre automatically exports the defined changes asynchronously once your application finishes modifying the file.\n The ``AutoExportPolicy`` is only supported on Amazon FSx for Lustre file systems with a data repository association."},"AutoImportPolicy":{"Type":9,"Flags":0,"Description":"Describes the data repository association's automatic import policy. The AutoImportPolicy defines how Amazon FSx keeps your file metadata and directory listings up to date by importing changes to your Amazon FSx for Lustre file system as you modify objects in a linked S3 bucket.\n The ``AutoImportPolicy`` is only supported on Amazon FSx for Lustre file systems with a data repository association."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"A value that specifies the ``TagKey``, the name of the tag. Tag keys must be unique for the resource to which they are attached."},"Value":{"Type":4,"Flags":1,"Description":"A value that specifies the ``TagValue``, the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of ``finances : April`` and also of ``payroll : April``."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.FSx/DataRepositoryAssociationProperties","Properties":{"AssociationId":{"Type":4,"Flags":18,"Description":""},"BatchImportMetaDataOnCreate":{"Type":2,"Flags":0,"Description":"A boolean flag indicating whether an import data repository task to import metadata should run after the data repository association is created. The task runs if this flag is set to ``true``."},"DataRepositoryPath":{"Type":4,"Flags":1,"Description":"The path to the Amazon S3 data repository that will be linked to the file system. The path can be an S3 bucket or prefix in the format ``s3://myBucket/myPrefix/``. This path specifies where in the S3 data repository files will be imported from or exported to."},"FileSystemId":{"Type":4,"Flags":1,"Description":"The ID of the file system on which the data repository association is configured."},"FileSystemPath":{"Type":4,"Flags":1,"Description":"A path on the Amazon FSx for Lustre file system that points to a high-level directory (such as ``/ns1/``) or subdirectory (such as ``/ns1/subdir/``) that will be mapped 1-1 with ``DataRepositoryPath``. The leading forward slash in the name is required. Two data repository associations cannot have overlapping file system paths. For example, if a data repository is associated with file system path ``/ns1/``, then you cannot link another data repository with file system path ``/ns1/ns2``.\n This path specifies where in your file system files will be exported from or imported to. This file system directory can be linked to only one Amazon S3 bucket, and no other S3 bucket can be linked to the directory.\n If you specify only a forward slash (``/``) as the file system path, you can link only one data repository to the file system. You can only specify \"/\" as the file system path for the first data repository associated with a file system."},"ImportedFileChunkSize":{"Type":3,"Flags":0,"Description":"For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system or cache.\n The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB."},"ResourceARN":{"Type":4,"Flags":2,"Description":""},"S3":{"Type":12,"Flags":0,"Description":"The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association. The configuration defines which file events (new, changed, or deleted files or directories) are automatically imported from the linked data repository to the file system or automatically exported from the file system to the data repository."},"Tags":{"Type":18,"Flags":0,"Description":"An array of key-value pairs to apply to this resource.\n For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)."}}}},{"3":{"ItemType":13}},{"2":{"Name":"AWS.FSx/DataRepositoryAssociation","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":17,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.FSx/DataRepositoryAssociation@default","ScopeType":0,"Body":19}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "AutoExportPolicy", + "properties": { + "Events": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "The ``AutoExportPolicy`` can have the following event values:\n + ``NEW`` - New files and directories are automatically exported to the data repository as they are added to the file system.\n + ``CHANGED`` - Changes to files and directories on the file system are automatically exported to the data repository.\n + ``DELETED`` - Files and directories are automatically deleted on the data repository when they are deleted on the file system.\n \n You can define any combination of event types for your ``AutoExportPolicy``." + } + } + }, + { + "$type": "ObjectType", + "name": "AutoImportPolicy", + "properties": { + "Events": { + "type": { + "$ref": "#/8" + }, + "flags": 1, + "description": "The ``AutoImportPolicy`` can have the following event values:\n + ``NEW`` - Amazon FSx automatically imports metadata of files added to the linked S3 bucket that do not currently exist in the FSx file system.\n + ``CHANGED`` - Amazon FSx automatically updates file metadata and invalidates existing file content on the file system as files change in the data repository.\n + ``DELETED`` - Amazon FSx automatically deletes files on the file system as corresponding files are deleted in the data repository.\n \n You can define any combination of event types for your ``AutoImportPolicy``." + } + } + }, + { + "$type": "ObjectType", + "name": "EventType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "EventTypes", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "S3", + "properties": { + "AutoExportPolicy": { + "type": { + "$ref": "#/0" + }, + "flags": 0, + "description": "Describes a data repository association's automatic export policy. The ``AutoExportPolicy`` defines the types of updated objects on the file system that will be automatically exported to the data repository. As you create, modify, or delete files, Amazon FSx for Lustre automatically exports the defined changes asynchronously once your application finishes modifying the file.\n The ``AutoExportPolicy`` is only supported on Amazon FSx for Lustre file systems with a data repository association." + }, + "AutoImportPolicy": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Describes the data repository association's automatic import policy. The AutoImportPolicy defines how Amazon FSx keeps your file metadata and directory listings up to date by importing changes to your Amazon FSx for Lustre file system as you modify objects in a linked S3 bucket.\n The ``AutoImportPolicy`` is only supported on Amazon FSx for Lustre file systems with a data repository association." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "A value that specifies the ``TagKey``, the name of the tag. Tag keys must be unique for the resource to which they are attached." + }, + "Value": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "A value that specifies the ``TagValue``, the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of ``finances : April`` and also of ``payroll : April``." + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.FSx/DataRepositoryAssociationProperties" + }, + { + "$type": "BooleanType" + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ObjectType", + "name": "AWS.FSx/DataRepositoryAssociationProperties", + "properties": { + "AssociationId": { + "type": { + "$ref": "#/6" + }, + "flags": 18, + "description": "" + }, + "BatchImportMetaDataOnCreate": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "A boolean flag indicating whether an import data repository task to import metadata should run after the data repository association is created. The task runs if this flag is set to ``true``." + }, + "DataRepositoryPath": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "The path to the Amazon S3 data repository that will be linked to the file system. The path can be an S3 bucket or prefix in the format ``s3://myBucket/myPrefix/``. This path specifies where in the S3 data repository files will be imported from or exported to." + }, + "FileSystemId": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "The ID of the file system on which the data repository association is configured." + }, + "FileSystemPath": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "A path on the Amazon FSx for Lustre file system that points to a high-level directory (such as ``/ns1/``) or subdirectory (such as ``/ns1/subdir/``) that will be mapped 1-1 with ``DataRepositoryPath``. The leading forward slash in the name is required. Two data repository associations cannot have overlapping file system paths. For example, if a data repository is associated with file system path ``/ns1/``, then you cannot link another data repository with file system path ``/ns1/ns2``.\n This path specifies where in your file system files will be exported from or imported to. This file system directory can be linked to only one Amazon S3 bucket, and no other S3 bucket can be linked to the directory.\n If you specify only a forward slash (``/``) as the file system path, you can link only one data repository to the file system. You can only specify \"/\" as the file system path for the first data repository associated with a file system." + }, + "ImportedFileChunkSize": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system or cache.\n The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB." + }, + "ResourceARN": { + "type": { + "$ref": "#/6" + }, + "flags": 2, + "description": "" + }, + "S3": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association. The configuration defines which file events (new, changed, or deleted files or directories) are automatically imported from the linked data repository to the file system or automatically exported from the file system to the data repository." + }, + "Tags": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource.\n For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.FSx/DataRepositoryAssociation", + "properties": { + "name": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/6" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/14" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.FSx/DataRepositoryAssociation@default", + "scopeType": 0, + "body": { + "$ref": "#/15" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.fsx/default/types.md b/artifacts/bicep/aws/aws.fsx/default/types.md index 3e71597a..6879d014 100644 --- a/artifacts/bicep/aws/aws.fsx/default/types.md +++ b/artifacts/bicep/aws/aws.fsx/default/types.md @@ -3,9 +3,27 @@ ## Resource AWS.FSx/DataRepositoryAssociation@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.FSx/DataRepositoryAssociationProperties](#awsfsxdatarepositoryassociationproperties) (Required): properties of the resource +* **properties**: [AWS.FSx/DataRepositoryAssociationProperties](#awsfsxdatarepositoryassociationproperties) (Required, Identifier): properties of the resource + +## AutoExportPolicy +### Properties +* **Events**: string[] (Required): The ``AutoExportPolicy`` can have the following event values: + + ``NEW`` - New files and directories are automatically exported to the data repository as they are added to the file system. + + ``CHANGED`` - Changes to files and directories on the file system are automatically exported to the data repository. + + ``DELETED`` - Files and directories are automatically deleted on the data repository when they are deleted on the file system. + + You can define any combination of event types for your ``AutoExportPolicy``. + +## AutoImportPolicy +### Properties +* **Events**: string[] (Required): The ``AutoImportPolicy`` can have the following event values: + + ``NEW`` - Amazon FSx automatically imports metadata of files added to the linked S3 bucket that do not currently exist in the FSx file system. + + ``CHANGED`` - Amazon FSx automatically updates file metadata and invalidates existing file content on the file system as files change in the data repository. + + ``DELETED`` - Amazon FSx automatically deletes files on the file system as corresponding files are deleted in the data repository. + + You can define any combination of event types for your ``AutoImportPolicy``. ## AWS.FSx/DataRepositoryAssociationProperties ### Properties @@ -30,24 +48,6 @@ * **AutoImportPolicy**: [AutoImportPolicy](#autoimportpolicy): Describes the data repository association's automatic import policy. The AutoImportPolicy defines how Amazon FSx keeps your file metadata and directory listings up to date by importing changes to your Amazon FSx for Lustre file system as you modify objects in a linked S3 bucket. The ``AutoImportPolicy`` is only supported on Amazon FSx for Lustre file systems with a data repository association. -## AutoExportPolicy -### Properties -* **Events**: string[] (Required): The ``AutoExportPolicy`` can have the following event values: - + ``NEW`` - New files and directories are automatically exported to the data repository as they are added to the file system. - + ``CHANGED`` - Changes to files and directories on the file system are automatically exported to the data repository. - + ``DELETED`` - Files and directories are automatically deleted on the data repository when they are deleted on the file system. - - You can define any combination of event types for your ``AutoExportPolicy``. - -## AutoImportPolicy -### Properties -* **Events**: string[] (Required): The ``AutoImportPolicy`` can have the following event values: - + ``NEW`` - Amazon FSx automatically imports metadata of files added to the linked S3 bucket that do not currently exist in the FSx file system. - + ``CHANGED`` - Amazon FSx automatically updates file metadata and invalidates existing file content on the file system as files change in the data repository. - + ``DELETED`` - Amazon FSx automatically deletes files on the file system as corresponding files are deleted in the data repository. - - You can define any combination of event types for your ``AutoImportPolicy``. - ## Tag ### Properties * **Key**: string (Required): A value that specifies the ``TagKey``, the name of the tag. Tag keys must be unique for the resource to which they are attached. diff --git a/artifacts/bicep/aws/aws.gamelift/default/types.json b/artifacts/bicep/aws/aws.gamelift/default/types.json index d8da7fe6..f7b22dab 100644 --- a/artifacts/bicep/aws/aws.gamelift/default/types.json +++ b/artifacts/bicep/aws/aws.gamelift/default/types.json @@ -1 +1,2715 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"RoutingStrategy","Properties":{"FleetId":{"Type":4,"Flags":0,"Description":"A unique identifier for a fleet that the alias points to. If you specify SIMPLE for the Type property, you must specify this property."},"Message":{"Type":4,"Flags":0,"Description":"The message text to be used with a terminal routing strategy. If you specify TERMINAL for the Type property, you must specify this property."},"Type":{"Type":4,"Flags":1,"Description":"Simple routing strategy. The alias resolves to one specific fleet. Use this type when routing to active fleets."}}}},{"2":{"Name":"AWS.GameLift/AliasProperties","Properties":{"AliasId":{"Type":4,"Flags":18,"Description":"Unique alias ID"},"Description":{"Type":4,"Flags":0,"Description":"A human-readable description of the alias."},"Name":{"Type":4,"Flags":1,"Description":"A descriptive label that is associated with an alias. Alias names do not need to be unique."},"RoutingStrategy":{"Type":8,"Flags":1,"Description":"A routing configuration that specifies where traffic is directed for this alias, such as to a fleet or to a message."}}}},{"2":{"Name":"AWS.GameLift/Alias","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":9,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.GameLift/Alias@default","ScopeType":0,"Body":10}},{"2":{"Name":"StorageLocation","Properties":{"Bucket":{"Type":4,"Flags":1,"Description":"An Amazon S3 bucket identifier. This is the name of the S3 bucket."},"Key":{"Type":4,"Flags":1,"Description":"The name of the zip file that contains the build files or script files."},"ObjectVersion":{"Type":4,"Flags":0,"Description":"The version of the file, if object versioning is turned on for the bucket. Amazon GameLift uses this information when retrieving files from your S3 bucket. To retrieve a specific version of the file, provide an object version. To retrieve the latest version of the file, do not set this parameter."},"RoleArn":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access the S3 bucket."}}}},{"2":{"Name":"AWS.GameLift/BuildProperties","Properties":{"BuildId":{"Type":4,"Flags":18,"Description":"A unique identifier for a build to be deployed on the new fleet. If you are deploying the fleet with a custom game build, you must specify this property. The build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created."},"Name":{"Type":4,"Flags":0,"Description":"A descriptive label that is associated with a build. Build names do not need to be unique."},"OperatingSystem":{"Type":4,"Flags":0,"Description":"The operating system that the game server binaries are built to run on. This value determines the type of fleet resources that you can use for this build. If your game build contains multiple executables, they all must run on the same operating system. If an operating system is not specified when creating a build, Amazon GameLift uses the default value (WINDOWS_2012). This value cannot be changed later."},"ServerSdkVersion":{"Type":4,"Flags":4,"Description":"A server SDK version you used when integrating your game server build with Amazon GameLift. By default Amazon GameLift sets this value to 4.0.2."},"StorageLocation":{"Type":12,"Flags":4,"Description":"Information indicating where your game build files are stored. Use this parameter only when creating a build with files stored in an Amazon S3 bucket that you own. The storage location must specify an Amazon S3 bucket name and key. The location must also specify a role ARN that you set up to allow Amazon GameLift to access your Amazon S3 bucket. The S3 bucket and your new build must be in the same Region."},"Version":{"Type":4,"Flags":0,"Description":"Version information that is associated with this build. Version strings do not need to be unique."}}}},{"2":{"Name":"AWS.GameLift/Build","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":13,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.GameLift/Build@default","ScopeType":0,"Body":14}},{"2":{"Name":"AnywhereConfiguration","Properties":{"Cost":{"Type":4,"Flags":1,"Description":"Cost of compute can be specified on Anywhere Fleets to prioritize placement across Queue destinations based on Cost."}}}},{"2":{"Name":"CertificateConfiguration","Properties":{"CertificateType":{"Type":4,"Flags":1}}}},{"2":{"Name":"IpPermission","Properties":{"FromPort":{"Type":3,"Flags":1,"Description":"A starting value for a range of allowed port numbers."},"IpRange":{"Type":4,"Flags":1,"Description":"A range of allowed IP addresses. This value must be expressed in CIDR notation. Example: \"000.000.000.000/[subnet mask]\" or optionally the shortened version \"0.0.0.0/[subnet mask]\"."},"Protocol":{"Type":4,"Flags":1,"Description":"The network communication protocol used by the fleet."},"ToPort":{"Type":3,"Flags":1,"Description":"An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort."}}}},{"2":{"Name":"Location"}},{"2":{"Name":"LocationCapacity","Properties":{"DesiredEC2Instances":{"Type":3,"Flags":1,"Description":"The number of EC2 instances you want to maintain in the specified fleet location. This value must fall between the minimum and maximum size limits."},"MaxSize":{"Type":3,"Flags":1,"Description":"The maximum value that is allowed for the fleet's instance count for a location. When creating a new fleet, GameLift automatically sets this value to \"1\". Once the fleet is active, you can change this value."},"MinSize":{"Type":3,"Flags":1,"Description":"The minimum value allowed for the fleet's instance count for a location. When creating a new fleet, GameLift automatically sets this value to \"0\". After the fleet is active, you can change this value."}}}},{"2":{"Name":"LocationConfiguration","Properties":{"Location":{"Type":4,"Flags":1},"LocationCapacity":{"Type":20,"Flags":0}}}},{"2":{"Name":"ResourceCreationLimitPolicy","Properties":{"NewGameSessionsPerCreator":{"Type":3,"Flags":0,"Description":"The maximum number of game sessions that an individual can create during the policy period."},"PolicyPeriodInMinutes":{"Type":3,"Flags":0,"Description":"The time span used in evaluating the resource creation limit policy."}}}},{"2":{"Name":"RuntimeConfiguration","Properties":{"GameSessionActivationTimeoutSeconds":{"Type":3,"Flags":0,"Description":"The maximum amount of time (in seconds) that a game session can remain in status ACTIVATING. If the game session is not active before the timeout, activation is terminated and the game session status is changed to TERMINATED."},"MaxConcurrentGameSessionActivations":{"Type":3,"Flags":0,"Description":"The maximum number of game sessions with status ACTIVATING to allow on an instance simultaneously. This setting limits the amount of instance resources that can be used for new game activations at any one time."},"ServerProcesses":{"Type":27,"Flags":0,"Description":"A collection of server process configurations that describe which server processes to run on each instance in a fleet."}}}},{"2":{"Name":"ScalingPolicy","Properties":{"ComparisonOperator":{"Type":4,"Flags":0,"Description":"Comparison operator to use when measuring a metric against the threshold value."},"EvaluationPeriods":{"Type":3,"Flags":0,"Description":"Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered."},"Location":{"Type":4,"Flags":0},"MetricName":{"Type":4,"Flags":1,"Description":"Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment."},"Name":{"Type":4,"Flags":1,"Description":"A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique."},"PolicyType":{"Type":4,"Flags":0,"Description":"The type of scaling policy to create. For a target-based policy, set the parameter MetricName to 'PercentAvailableGameSessions' and specify a TargetConfiguration. For a rule-based policy set the following parameters: MetricName, ComparisonOperator, Threshold, EvaluationPeriods, ScalingAdjustmentType, and ScalingAdjustment."},"ScalingAdjustment":{"Type":3,"Flags":0,"Description":"Amount of adjustment to make, based on the scaling adjustment type."},"ScalingAdjustmentType":{"Type":4,"Flags":0,"Description":"The type of adjustment to make to a fleet's instance count."},"Status":{"Type":4,"Flags":0,"Description":"Current status of the scaling policy. The scaling policy can be in force only when in an ACTIVE status. Scaling policies can be suspended for individual fleets. If the policy is suspended for a fleet, the policy status does not change."},"TargetConfiguration":{"Type":26,"Flags":0,"Description":"An object that contains settings for a target-based scaling policy."},"Threshold":{"Type":3,"Flags":0,"Description":"Metric value used to trigger a scaling event."},"UpdateStatus":{"Type":4,"Flags":0,"Description":"The current status of the fleet's scaling policies in a requested fleet location. The status PENDING_UPDATE indicates that an update was requested for the fleet but has not yet been completed for the location."}}}},{"2":{"Name":"ServerProcess","Properties":{"ConcurrentExecutions":{"Type":3,"Flags":1,"Description":"The number of server processes that use this configuration to run concurrently on an instance."},"LaunchPath":{"Type":4,"Flags":1,"Description":"The location of the server executable in a custom game build or the name of the Realtime script file that contains the Init() function. Game builds and Realtime scripts are installed on instances at the root:\n\nWindows (for custom game builds only): C:\\game. Example: \"C:\\game\\MyGame\\server.exe\"\n\nLinux: /local/game. Examples: \"/local/game/MyGame/server.exe\" or \"/local/game/MyRealtimeScript.js\""},"Parameters":{"Type":4,"Flags":0,"Description":"An optional list of parameters to pass to the server executable or Realtime script on launch."}}}},{"2":{"Name":"TargetConfiguration","Properties":{"TargetValue":{"Type":3,"Flags":1,"Description":"Desired value to use with a target-based scaling policy. The value must be relevant for whatever metric the scaling policy is using. For example, in a policy using the metric PercentAvailableGameSessions, the target value should be the preferred size of the fleet's buffer (the percent of capacity that should be idle and ready for new game sessions)."}}}},{"3":{"ItemType":25}},{"2":{"Name":"AWS.GameLift/FleetProperties","Properties":{"AnywhereConfiguration":{"Type":16,"Flags":0,"Description":"Configuration for Anywhere fleet."},"ApplyCapacity":{"Type":4,"Flags":0,"Description":"ComputeType to differentiate EC2 hardware managed by GameLift and Anywhere hardware managed by the customer."},"BuildId":{"Type":4,"Flags":0,"Description":"A unique identifier for a build to be deployed on the new fleet. If you are deploying the fleet with a custom game build, you must specify this property. The build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created."},"CertificateConfiguration":{"Type":17,"Flags":0,"Description":"Indicates whether to generate a TLS/SSL certificate for the new fleet. TLS certificates are used for encrypting traffic between game clients and game servers running on GameLift. If this parameter is not set, certificate generation is disabled. This fleet setting cannot be changed once the fleet is created."},"ComputeType":{"Type":4,"Flags":0,"Description":"ComputeType to differentiate EC2 hardware managed by GameLift and Anywhere hardware managed by the customer."},"Description":{"Type":4,"Flags":0,"Description":"A human-readable description of a fleet."},"DesiredEC2Instances":{"Type":3,"Flags":0,"Description":"[DEPRECATED] The number of EC2 instances that you want this fleet to host. When creating a new fleet, GameLift automatically sets this value to \"1\" and initiates a single instance. Once the fleet is active, update this value to trigger GameLift to add or remove instances from the fleet."},"EC2InboundPermissions":{"Type":29,"Flags":0,"Description":"A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server."},"EC2InstanceType":{"Type":4,"Flags":0,"Description":"The name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions."},"FleetId":{"Type":4,"Flags":18,"Description":"Unique fleet ID"},"FleetType":{"Type":4,"Flags":0,"Description":"Indicates whether to use On-Demand instances or Spot instances for this fleet. If empty, the default is ON_DEMAND. Both categories of instances use identical hardware and configurations based on the instance type selected for this fleet."},"InstanceRoleARN":{"Type":4,"Flags":0,"Description":"A unique identifier for an AWS IAM role that manages access to your AWS services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). Create a role or look up a role's ARN from the IAM dashboard in the AWS Management Console."},"InstanceRoleCredentialsProvider":{"Type":4,"Flags":0,"Description":"Credentials provider implementation that loads credentials from the Amazon EC2 Instance Metadata Service."},"Locations":{"Type":30,"Flags":0},"LogPaths":{"Type":31,"Flags":0,"Description":"This parameter is no longer used. When hosting a custom game build, specify where Amazon GameLift should store log files using the Amazon GameLift server API call ProcessReady()"},"MaxSize":{"Type":3,"Flags":0,"Description":"[DEPRECATED] The maximum value that is allowed for the fleet's instance count. When creating a new fleet, GameLift automatically sets this value to \"1\". Once the fleet is active, you can change this value."},"MetricGroups":{"Type":32,"Flags":0,"Description":"The name of an Amazon CloudWatch metric group. A metric group aggregates the metrics for all fleets in the group. Specify a string containing the metric group name. You can use an existing name or use a new name to create a new metric group. Currently, this parameter can have only one string."},"MinSize":{"Type":3,"Flags":0,"Description":"[DEPRECATED] The minimum value allowed for the fleet's instance count. When creating a new fleet, GameLift automatically sets this value to \"0\". After the fleet is active, you can change this value."},"Name":{"Type":4,"Flags":1,"Description":"A descriptive label that is associated with a fleet. Fleet names do not need to be unique."},"NewGameSessionProtectionPolicy":{"Type":4,"Flags":0,"Description":"A game session protection policy to apply to all game sessions hosted on instances in this fleet. When protected, active game sessions cannot be terminated during a scale-down event. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy to affect future game sessions on the fleet. You can also set protection for individual game sessions."},"PeerVpcAwsAccountId":{"Type":4,"Flags":0,"Description":"A unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift fleet with. You can find your account ID in the AWS Management Console under account settings."},"PeerVpcId":{"Type":4,"Flags":0,"Description":"A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the AWS Management Console."},"ResourceCreationLimitPolicy":{"Type":22,"Flags":0,"Description":"A policy that limits the number of game sessions an individual player can create over a span of time for this fleet."},"RuntimeConfiguration":{"Type":23,"Flags":0,"Description":"Instructions for launching server processes on each instance in the fleet. Server processes run either a custom game build executable or a Realtime script. The runtime configuration defines the server executables or launch script file, launch parameters, and the number of processes to run concurrently on each instance. When creating a fleet, the runtime configuration must have at least one server process configuration; otherwise the request fails with an invalid request exception.\n\nThis parameter is required unless the parameters ServerLaunchPath and ServerLaunchParameters are defined. Runtime configuration has replaced these parameters, but fleets that use them will continue to work."},"ScalingPolicies":{"Type":33,"Flags":0,"Description":"A list of rules that control how a fleet is scaled."},"ScriptId":{"Type":4,"Flags":0,"Description":"A unique identifier for a Realtime script to be deployed on a new Realtime Servers fleet. The script must have been successfully uploaded to Amazon GameLift. This fleet setting cannot be changed once the fleet is created.\n\nNote: It is not currently possible to use the !Ref command to reference a script created with a CloudFormation template for the fleet property ScriptId. Instead, use Fn::GetAtt Script.Arn or Fn::GetAtt Script.Id to retrieve either of these properties as input for ScriptId. Alternatively, enter a ScriptId string manually."},"ServerLaunchParameters":{"Type":4,"Flags":0,"Description":"This parameter is no longer used but is retained for backward compatibility. Instead, specify server launch parameters in the RuntimeConfiguration parameter. A request must specify either a runtime configuration or values for both ServerLaunchParameters and ServerLaunchPath."},"ServerLaunchPath":{"Type":4,"Flags":0,"Description":"This parameter is no longer used. Instead, specify a server launch path using the RuntimeConfiguration parameter. Requests that specify a server launch path and launch parameters instead of a runtime configuration will continue to work."}}}},{"3":{"ItemType":18}},{"3":{"ItemType":21}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":24}},{"2":{"Name":"AWS.GameLift/Fleet","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":28,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.GameLift/Fleet@default","ScopeType":0,"Body":34}},{"2":{"Name":"AutoScalingGroupArn"}},{"2":{"Name":"AutoScalingPolicy","Properties":{"EstimatedInstanceWarmup":{"Type":3,"Flags":0},"TargetTrackingConfiguration":{"Type":61,"Flags":1}}}},{"2":{"Name":"BalancingStrategy"}},{"2":{"Name":"CreationTime"}},{"2":{"Name":"DeleteOption"}},{"2":{"Name":"EstimatedInstanceWarmup"}},{"2":{"Name":"GameServerGroup","Properties":{"AutoScalingGroupArn":{"Type":4,"Flags":0},"BalancingStrategy":{"Type":4,"Flags":0},"CreationTime":{"Type":4,"Flags":0},"GameServerGroupArn":{"Type":4,"Flags":16},"GameServerGroupName":{"Type":4,"Flags":0},"GameServerProtectionPolicy":{"Type":4,"Flags":0},"InstanceDefinitions":{"Type":66,"Flags":0},"LastUpdatedTime":{"Type":4,"Flags":0},"RoleArn":{"Type":4,"Flags":0},"Status":{"Type":4,"Flags":0},"StatusReason":{"Type":4,"Flags":0},"SuspendedActions":{"Type":67,"Flags":0}}}},{"2":{"Name":"GameServerGroupArn"}},{"2":{"Name":"GameServerGroupName"}},{"2":{"Name":"GameServerProtectionPolicy"}},{"2":{"Name":"InstanceDefinition","Properties":{"InstanceType":{"Type":4,"Flags":1},"WeightedCapacity":{"Type":4,"Flags":0}}}},{"2":{"Name":"InstanceDefinitions"}},{"2":{"Name":"InstanceType"}},{"2":{"Name":"LastUpdatedTime"}},{"2":{"Name":"LaunchTemplate","Properties":{"LaunchTemplateId":{"Type":4,"Flags":0},"LaunchTemplateName":{"Type":4,"Flags":0},"Version":{"Type":4,"Flags":0}}}},{"2":{"Name":"LaunchTemplateId"}},{"2":{"Name":"LaunchTemplateName"}},{"2":{"Name":"MaxSize"}},{"2":{"Name":"MinSize"}},{"2":{"Name":"RoleArn"}},{"2":{"Name":"Status"}},{"2":{"Name":"StatusReason"}},{"2":{"Name":"SuspendedActions"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":0,"Description":"The key for a developer-defined key:value pair for tagging an AWS resource."},"Value":{"Type":4,"Flags":0,"Description":"The value for a developer-defined key:value pair for tagging an AWS resource."}}}},{"2":{"Name":"Tags"}},{"2":{"Name":"TargetTrackingConfiguration","Properties":{"TargetValue":{"Type":3,"Flags":1}}}},{"2":{"Name":"TargetValue"}},{"2":{"Name":"Version"}},{"2":{"Name":"VpcSubnets"}},{"2":{"Name":"WeightedCapacity"}},{"3":{"ItemType":46}},{"3":{"ItemType":4}},{"3":{"ItemType":46}},{"3":{"ItemType":4}},{"3":{"ItemType":59}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.GameLift/GameServerGroupProperties","Properties":{"AutoScalingGroupArn":{"Type":4,"Flags":2,"Description":"A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group."},"AutoScalingPolicy":{"Type":37,"Flags":4,"Description":"Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting"},"BalancingStrategy":{"Type":4,"Flags":0,"Description":"The fallback balancing method to use for the game server group when Spot Instances in a Region become unavailable or are not viable for game hosting."},"DeleteOption":{"Type":4,"Flags":4,"Description":"The type of delete to perform."},"GameServerGroupArn":{"Type":4,"Flags":18,"Description":"A generated unique ID for the game server group."},"GameServerGroupName":{"Type":4,"Flags":1,"Description":"An identifier for the new game server group."},"GameServerProtectionPolicy":{"Type":4,"Flags":0,"Description":"A flag that indicates whether instances in the game server group are protected from early termination."},"InstanceDefinitions":{"Type":73,"Flags":1,"Description":"A set of EC2 instance types to use when creating instances in the group."},"LaunchTemplate":{"Type":50,"Flags":4,"Description":"The EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group."},"MaxSize":{"Type":3,"Flags":4,"Description":"The maximum number of instances allowed in the EC2 Auto Scaling group."},"MinSize":{"Type":3,"Flags":4,"Description":"The minimum number of instances allowed in the EC2 Auto Scaling group."},"RoleArn":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups."},"Tags":{"Type":74,"Flags":4,"Description":"A list of labels to assign to the new game server group resource."},"VpcSubnets":{"Type":75,"Flags":4,"Description":"A list of virtual private cloud (VPC) subnets to use with instances in the game server group."}}}},{"3":{"ItemType":46}},{"3":{"ItemType":59}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.GameLift/GameServerGroup","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":72,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.GameLift/GameServerGroup@default","ScopeType":0,"Body":76}},{"2":{"Name":"AllowedLocations"}},{"2":{"Name":"FilterConfiguration","Properties":{"AllowedLocations":{"Type":87,"Flags":0}}}},{"2":{"Name":"GameSessionQueueDestination","Properties":{"DestinationArn":{"Type":4,"Flags":0}}}},{"2":{"Name":"LocationOrder"}},{"2":{"Name":"PlayerLatencyPolicy","Properties":{"MaximumIndividualPlayerLatencyMilliseconds":{"Type":3,"Flags":0,"Description":"The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value set for this property."},"PolicyDurationSeconds":{"Type":3,"Flags":0,"Description":"The length of time, in seconds, that the policy is enforced while placing a new game session."}}}},{"2":{"Name":"PriorityConfiguration","Properties":{"LocationOrder":{"Type":89,"Flags":0},"PriorityOrder":{"Type":90,"Flags":0}}}},{"2":{"Name":"PriorityOrder"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.GameLift/GameSessionQueueProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it."},"CustomEventData":{"Type":4,"Flags":0,"Description":"Information that is added to all events that are related to this game session queue."},"Destinations":{"Type":93,"Flags":0,"Description":"A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue."},"FilterConfiguration":{"Type":95,"Flags":0,"Description":"A list of locations where a queue is allowed to place new game sessions."},"Name":{"Type":4,"Flags":17,"Description":"A descriptive label that is associated with game session queue. Queue names must be unique within each Region."},"NotificationTarget":{"Type":4,"Flags":0,"Description":"An SNS topic ARN that is set up to receive game session placement notifications."},"PlayerLatencyPolicies":{"Type":96,"Flags":0,"Description":"A set of policies that act as a sliding cap on player latency."},"PriorityConfiguration":{"Type":99,"Flags":0,"Description":"Custom settings to use when prioritizing destinations and locations for game session placements."},"Tags":{"Type":100,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."},"TimeoutInSeconds":{"Type":3,"Flags":0,"Description":"The maximum time, in seconds, that a new game session placement request remains in the queue."}}}},{"3":{"ItemType":80}},{"3":{"ItemType":4}},{"2":{"Name":"GameSessionQueue_FilterConfiguration","Properties":{"AllowedLocations":{"Type":94,"Flags":0}}}},{"3":{"ItemType":82}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"GameSessionQueue_PriorityConfiguration","Properties":{"LocationOrder":{"Type":97,"Flags":0},"PriorityOrder":{"Type":98,"Flags":0}}}},{"3":{"ItemType":85}},{"2":{"Name":"AWS.GameLift/GameSessionQueue","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":92,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.GameLift/GameSessionQueue@default","ScopeType":0,"Body":101}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length."}}}},{"2":{"Name":"AWS.GameLift/LocationProperties","Properties":{"LocationArn":{"Type":4,"Flags":2},"LocationName":{"Type":4,"Flags":17},"Tags":{"Type":105,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."}}}},{"3":{"ItemType":103}},{"2":{"Name":"AWS.GameLift/Location","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":104,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.GameLift/Location@default","ScopeType":0,"Body":106}},{"2":{"Name":"GameProperty","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The game property identifier."},"Value":{"Type":4,"Flags":1,"Description":"The game property value."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length."}}}},{"2":{"Name":"AWS.GameLift/MatchmakingConfigurationProperties","Properties":{"AcceptanceRequired":{"Type":2,"Flags":1,"Description":"A flag that indicates whether a match that was created with this configuration must be accepted by the matched players"},"AcceptanceTimeoutSeconds":{"Type":3,"Flags":0,"Description":"The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required."},"AdditionalPlayerCount":{"Type":3,"Flags":0,"Description":"The number of player slots in a match to keep open for future players."},"Arn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift matchmaking configuration resource and uniquely identifies it."},"BackfillMode":{"Type":4,"Flags":0,"Description":"The method used to backfill game sessions created with this matchmaking configuration."},"CreationTime":{"Type":4,"Flags":0,"Description":"A time stamp indicating when this data object was created."},"CustomEventData":{"Type":4,"Flags":0,"Description":"Information to attach to all events related to the matchmaking configuration."},"Description":{"Type":4,"Flags":0,"Description":"A descriptive label that is associated with matchmaking configuration."},"FlexMatchMode":{"Type":4,"Flags":0,"Description":"Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution."},"GameProperties":{"Type":111,"Flags":0,"Description":"A set of custom properties for a game session, formatted as key:value pairs."},"GameSessionData":{"Type":4,"Flags":0,"Description":"A set of custom game session properties, formatted as a single string value."},"GameSessionQueueArns":{"Type":112,"Flags":0,"Description":"The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it."},"Name":{"Type":4,"Flags":17,"Description":"A unique identifier for the matchmaking configuration."},"NotificationTarget":{"Type":4,"Flags":0,"Description":"An SNS topic ARN that is set up to receive matchmaking notifications."},"RequestTimeoutSeconds":{"Type":3,"Flags":1,"Description":"The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out."},"RuleSetArn":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) associated with the GameLift matchmaking rule set resource that this configuration uses."},"RuleSetName":{"Type":4,"Flags":1,"Description":"A unique identifier for the matchmaking rule set to use with this configuration."},"Tags":{"Type":113,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."}}}},{"3":{"ItemType":108}},{"3":{"ItemType":4}},{"3":{"ItemType":109}},{"2":{"Name":"AWS.GameLift/MatchmakingConfiguration","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":110,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.GameLift/MatchmakingConfiguration@default","ScopeType":0,"Body":114}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length."}}}},{"2":{"Name":"AWS.GameLift/MatchmakingRuleSetProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift matchmaking rule set resource and uniquely identifies it."},"CreationTime":{"Type":4,"Flags":2,"Description":"A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds."},"Name":{"Type":4,"Flags":17,"Description":"A unique identifier for the matchmaking rule set."},"RuleSetBody":{"Type":4,"Flags":1,"Description":"A collection of matchmaking rules, formatted as a JSON string."},"Tags":{"Type":118,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."}}}},{"3":{"ItemType":116}},{"2":{"Name":"AWS.GameLift/MatchmakingRuleSet","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":117,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.GameLift/MatchmakingRuleSet@default","ScopeType":0,"Body":119}},{"2":{"Name":"S3Location","Properties":{"Bucket":{"Type":4,"Flags":1,"Description":"An Amazon S3 bucket identifier. This is the name of the S3 bucket."},"Key":{"Type":4,"Flags":1,"Description":"The name of the zip file that contains the script files."},"ObjectVersion":{"Type":4,"Flags":0,"Description":"The version of the file, if object versioning is turned on for the bucket. Amazon GameLift uses this information when retrieving files from your S3 bucket. To retrieve a specific version of the file, provide an object version. To retrieve the latest version of the file, do not set this parameter."},"RoleArn":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access the S3 bucket."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length."}}}},{"2":{"Name":"AWS.GameLift/ScriptProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift script resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift script ARN, the resource ID matches the Id value."},"CreationTime":{"Type":4,"Flags":2,"Description":"A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\")."},"Id":{"Type":4,"Flags":18,"Description":"A unique identifier for the Realtime script"},"Name":{"Type":4,"Flags":0,"Description":"A descriptive label that is associated with a script. Script names do not need to be unique."},"SizeOnDisk":{"Type":3,"Flags":2,"Description":"The file size of the uploaded Realtime script, expressed in bytes. When files are uploaded from an S3 location, this value remains at \"0\"."},"StorageLocation":{"Type":124,"Flags":1,"Description":"The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the \"key\"), and a role ARN that allows Amazon GameLift to access the Amazon S3 storage location. The S3 bucket must be in the same Region where you want to create a new script. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the ObjectVersion parameter to specify an earlier version."},"Tags":{"Type":125,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."},"Version":{"Type":4,"Flags":0,"Description":"The version that is associated with a script. Version strings do not need to be unique."}}}},{"2":{"Name":"Script_S3Location","Properties":{"Bucket":{"Type":4,"Flags":1,"Description":"An Amazon S3 bucket identifier. This is the name of the S3 bucket."},"Key":{"Type":4,"Flags":1,"Description":"The name of the zip file that contains the script files."},"ObjectVersion":{"Type":4,"Flags":0,"Description":"The version of the file, if object versioning is turned on for the bucket. Amazon GameLift uses this information when retrieving files from your S3 bucket. To retrieve a specific version of the file, provide an object version. To retrieve the latest version of the file, do not set this parameter."},"RoleArn":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access the S3 bucket."}}}},{"3":{"ItemType":122}},{"2":{"Name":"AWS.GameLift/Script","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":123,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.GameLift/Script@default","ScopeType":0,"Body":126}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "RoutingStrategy", + "properties": { + "FleetId": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A unique identifier for a fleet that the alias points to. If you specify SIMPLE for the Type property, you must specify this property." + }, + "Message": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The message text to be used with a terminal routing strategy. If you specify TERMINAL for the Type property, you must specify this property." + }, + "Type": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Simple routing strategy. The alias resolves to one specific fleet. Use this type when routing to active fleets." + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.GameLift/AliasProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.GameLift/AliasProperties", + "properties": { + "AliasId": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "Unique alias ID" + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A human-readable description of the alias." + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "A descriptive label that is associated with an alias. Alias names do not need to be unique." + }, + "RoutingStrategy": { + "type": { + "$ref": "#/0" + }, + "flags": 1, + "description": "A routing configuration that specifies where traffic is directed for this alias, such as to a fleet or to a message." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.GameLift/Alias", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.GameLift/Alias@default", + "scopeType": 0, + "body": { + "$ref": "#/4" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "StorageLocation", + "properties": { + "Bucket": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "An Amazon S3 bucket identifier. This is the name of the S3 bucket." + }, + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The name of the zip file that contains the build files or script files." + }, + "ObjectVersion": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The version of the file, if object versioning is turned on for the bucket. Amazon GameLift uses this information when retrieving files from your S3 bucket. To retrieve a specific version of the file, provide an object version. To retrieve the latest version of the file, do not set this parameter." + }, + "RoleArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access the S3 bucket." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.GameLift/BuildProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.GameLift/BuildProperties", + "properties": { + "BuildId": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "A unique identifier for a build to be deployed on the new fleet. If you are deploying the fleet with a custom game build, you must specify this property. The build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created." + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A descriptive label that is associated with a build. Build names do not need to be unique." + }, + "OperatingSystem": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The operating system that the game server binaries are built to run on. This value determines the type of fleet resources that you can use for this build. If your game build contains multiple executables, they all must run on the same operating system. If an operating system is not specified when creating a build, Amazon GameLift uses the default value (WINDOWS_2012). This value cannot be changed later." + }, + "ServerSdkVersion": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "A server SDK version you used when integrating your game server build with Amazon GameLift. By default Amazon GameLift sets this value to 4.0.2." + }, + "StorageLocation": { + "type": { + "$ref": "#/6" + }, + "flags": 4, + "description": "Information indicating where your game build files are stored. Use this parameter only when creating a build with files stored in an Amazon S3 bucket that you own. The storage location must specify an Amazon S3 bucket name and key. The location must also specify a role ARN that you set up to allow Amazon GameLift to access your Amazon S3 bucket. The S3 bucket and your new build must be in the same Region." + }, + "Version": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Version information that is associated with this build. Version strings do not need to be unique." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.GameLift/Build", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/8" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.GameLift/Build@default", + "scopeType": 0, + "body": { + "$ref": "#/9" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "ContainerDefinition", + "properties": { + "Command": { + "type": { + "$ref": "#/19" + }, + "flags": 0, + "description": "The command that's passed to the container." + }, + "ContainerName": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "A descriptive label for the container definition. Container definition names must be unique with a container group definition." + }, + "Cpu": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "The maximum number of CPU units reserved for this container. The value is expressed as an integer amount of CPU units. 1 vCPU is equal to 1024 CPU units" + }, + "DependsOn": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "A list of container dependencies that determines when this container starts up and shuts down. For container groups with multiple containers, dependencies let you define a startup/shutdown sequence across the containers." + }, + "EntryPoint": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "The entry point that's passed to the container so that it will run as an executable. If there are multiple arguments, each argument is a string in the array." + }, + "Environment": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "The environment variables to pass to a container." + }, + "Essential": { + "type": { + "$ref": "#/24" + }, + "flags": 0, + "description": "Specifies if the container is essential. If an essential container fails a health check, then all containers in the container group will be restarted. You must specify exactly 1 essential container in a container group." + }, + "HealthCheck": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "Specifies how the health of the containers will be checked." + }, + "ImageUri": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Specifies the image URI of this container." + }, + "MemoryLimits": { + "type": { + "$ref": "#/16" + }, + "flags": 0, + "description": "Specifies how much memory is available to the container. You must specify at least this parameter or the TotalMemoryLimit parameter of the ContainerGroupDefinition." + }, + "PortConfiguration": { + "type": { + "$ref": "#/17" + }, + "flags": 0, + "description": "Defines the ports on the container." + }, + "ResolvedImageDigest": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The digest of the container image." + }, + "WorkingDirectory": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The working directory to run commands inside the container in." + } + } + }, + { + "$type": "ObjectType", + "name": "ContainerDependency", + "properties": { + "Condition": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The type of dependency." + }, + "ContainerName": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "A descriptive label for the container definition. The container being defined depends on this container's condition." + } + } + }, + { + "$type": "ObjectType", + "name": "ContainerEnvironment", + "properties": { + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The environment variable name." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The environment variable value." + } + } + }, + { + "$type": "ObjectType", + "name": "ContainerHealthCheck", + "properties": { + "Command": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "A string array representing the command that the container runs to determine if it is healthy." + }, + "Interval": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "How often (in seconds) the health is checked." + }, + "Retries": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "How many times the process manager will retry the command after a timeout. (The first run of the command does not count as a retry.)" + }, + "StartPeriod": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "The optional grace period (in seconds) to give a container time to boostrap before teh health check is declared failed." + }, + "Timeout": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "How many seconds the process manager allows the command to run before canceling it." + } + } + }, + { + "$type": "ObjectType", + "name": "ContainerPortRange", + "properties": { + "FromPort": { + "type": { + "$ref": "#/20" + }, + "flags": 1, + "description": "A starting value for the range of allowed port numbers." + }, + "Protocol": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Defines the protocol of these ports." + }, + "ToPort": { + "type": { + "$ref": "#/20" + }, + "flags": 1, + "description": "An ending value for the range of allowed port numbers. Port numbers are end-inclusive. This value must be equal to or greater than FromPort." + } + } + }, + { + "$type": "ObjectType", + "name": "MemoryLimits", + "properties": { + "HardLimit": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "The hard limit of memory to reserve for the container." + }, + "SoftLimit": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "The amount of memory that is reserved for the container." + } + } + }, + { + "$type": "ObjectType", + "name": "PortConfiguration", + "properties": { + "ContainerPortRanges": { + "type": { + "$ref": "#/26" + }, + "flags": 1, + "description": "Specifies one or more ranges of ports on a container." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/12" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/15" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.GameLift/ContainerGroupDefinitionProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/11" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/18" + } + }, + { + "$type": "ObjectType", + "name": "AWS.GameLift/ContainerGroupDefinitionProperties", + "properties": { + "ContainerDefinitions": { + "type": { + "$ref": "#/28" + }, + "flags": 3, + "description": "A collection of container definitions that define the containers in this group." + }, + "ContainerGroupDefinitionArn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift container group resource and uniquely identifies it across all AWS Regions." + }, + "CreationTime": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\")." + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "A descriptive label for the container group definition." + }, + "OperatingSystem": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The operating system of the container group" + }, + "SchedulingStrategy": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Specifies whether the container group includes replica or daemon containers." + }, + "Tags": { + "type": { + "$ref": "#/29" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + }, + "TotalCpuLimit": { + "type": { + "$ref": "#/20" + }, + "flags": 1, + "description": "The maximum number of CPU units reserved for this container group. The value is expressed as an integer amount of CPU units. (1 vCPU is equal to 1024 CPU units.)" + }, + "TotalMemoryLimit": { + "type": { + "$ref": "#/20" + }, + "flags": 1, + "description": "The maximum amount of memory (in MiB) to allocate for this container group." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.GameLift/ContainerGroupDefinition", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/30" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.GameLift/ContainerGroupDefinition@default", + "scopeType": 0, + "body": { + "$ref": "#/31" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AnywhereConfiguration", + "properties": { + "Cost": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Cost of compute can be specified on Anywhere Fleets to prioritize placement across Queue destinations based on Cost." + } + } + }, + { + "$type": "ObjectType", + "name": "CertificateConfiguration", + "properties": { + "CertificateType": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ConnectionPortRange", + "properties": { + "FromPort": { + "type": { + "$ref": "#/20" + }, + "flags": 1, + "description": "A starting value for a range of allowed port numbers." + }, + "ToPort": { + "type": { + "$ref": "#/20" + }, + "flags": 1, + "description": "An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort." + } + } + }, + { + "$type": "ObjectType", + "name": "ContainerGroupsConfiguration", + "properties": { + "ConnectionPortRange": { + "type": { + "$ref": "#/35" + }, + "flags": 1 + }, + "ContainerGroupDefinitionNames": { + "type": { + "$ref": "#/47" + }, + "flags": 1, + "description": "The names of the container group definitions that will be created in an instance. You must specify exactly one REPLICA container group. You have the option to also specify one DAEMON container group." + }, + "ContainerGroupsPerInstance": { + "type": { + "$ref": "#/37" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ContainerGroupsPerInstance", + "properties": { + "DesiredReplicaContainerGroupsPerInstance": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "Use this parameter to override the number of replica container groups GameLift will launch per instance with a number that is lower than that calculated maximum." + }, + "MaxReplicaContainerGroupsPerInstance": { + "type": { + "$ref": "#/20" + }, + "flags": 2, + "description": "GameLift calculates the maximum number of replica container groups it can launch per instance based on instance properties such as CPU, memory, and connection ports." + } + } + }, + { + "$type": "ObjectType", + "name": "IpPermission", + "properties": { + "FromPort": { + "type": { + "$ref": "#/20" + }, + "flags": 1, + "description": "A starting value for a range of allowed port numbers." + }, + "IpRange": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "A range of allowed IP addresses. This value must be expressed in CIDR notation. Example: \"000.000.000.000/[subnet mask]\" or optionally the shortened version \"0.0.0.0/[subnet mask]\"." + }, + "Protocol": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The network communication protocol used by the fleet." + }, + "ToPort": { + "type": { + "$ref": "#/20" + }, + "flags": 1, + "description": "An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort." + } + } + }, + { + "$type": "ObjectType", + "name": "Location", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LocationCapacity", + "properties": { + "DesiredEC2Instances": { + "type": { + "$ref": "#/20" + }, + "flags": 1, + "description": "The number of EC2 instances you want to maintain in the specified fleet location. This value must fall between the minimum and maximum size limits." + }, + "MaxSize": { + "type": { + "$ref": "#/20" + }, + "flags": 1, + "description": "The maximum value that is allowed for the fleet's instance count for a location. When creating a new fleet, GameLift automatically sets this value to \"1\". Once the fleet is active, you can change this value." + }, + "MinSize": { + "type": { + "$ref": "#/20" + }, + "flags": 1, + "description": "The minimum value allowed for the fleet's instance count for a location. When creating a new fleet, GameLift automatically sets this value to \"0\". After the fleet is active, you can change this value." + } + } + }, + { + "$type": "ObjectType", + "name": "LocationConfiguration", + "properties": { + "Location": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "LocationCapacity": { + "type": { + "$ref": "#/40" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ResourceCreationLimitPolicy", + "properties": { + "NewGameSessionsPerCreator": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "The maximum number of game sessions that an individual can create during the policy period." + }, + "PolicyPeriodInMinutes": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "The time span used in evaluating the resource creation limit policy." + } + } + }, + { + "$type": "ObjectType", + "name": "RuntimeConfiguration", + "properties": { + "GameSessionActivationTimeoutSeconds": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "The maximum amount of time (in seconds) that a game session can remain in status ACTIVATING. If the game session is not active before the timeout, activation is terminated and the game session status is changed to TERMINATED." + }, + "MaxConcurrentGameSessionActivations": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "The maximum number of game sessions with status ACTIVATING to allow on an instance simultaneously. This setting limits the amount of instance resources that can be used for new game activations at any one time." + }, + "ServerProcesses": { + "type": { + "$ref": "#/48" + }, + "flags": 0, + "description": "A collection of server process configurations that describe which server processes to run on each instance in a fleet." + } + } + }, + { + "$type": "ObjectType", + "name": "ScalingPolicy", + "properties": { + "ComparisonOperator": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Comparison operator to use when measuring a metric against the threshold value." + }, + "EvaluationPeriods": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered." + }, + "Location": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "MetricName": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment." + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique." + }, + "PolicyType": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The type of scaling policy to create. For a target-based policy, set the parameter MetricName to 'PercentAvailableGameSessions' and specify a TargetConfiguration. For a rule-based policy set the following parameters: MetricName, ComparisonOperator, Threshold, EvaluationPeriods, ScalingAdjustmentType, and ScalingAdjustment." + }, + "ScalingAdjustment": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "Amount of adjustment to make, based on the scaling adjustment type." + }, + "ScalingAdjustmentType": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The type of adjustment to make to a fleet's instance count." + }, + "Status": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Current status of the scaling policy. The scaling policy can be in force only when in an ACTIVE status. Scaling policies can be suspended for individual fleets. If the policy is suspended for a fleet, the policy status does not change." + }, + "TargetConfiguration": { + "type": { + "$ref": "#/46" + }, + "flags": 0, + "description": "An object that contains settings for a target-based scaling policy." + }, + "Threshold": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "Metric value used to trigger a scaling event." + }, + "UpdateStatus": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The current status of the fleet's scaling policies in a requested fleet location. The status PENDING_UPDATE indicates that an update was requested for the fleet but has not yet been completed for the location." + } + } + }, + { + "$type": "ObjectType", + "name": "ServerProcess", + "properties": { + "ConcurrentExecutions": { + "type": { + "$ref": "#/20" + }, + "flags": 1, + "description": "The number of server processes that use this configuration to run concurrently on an instance." + }, + "LaunchPath": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The location of the server executable in a custom game build or the name of the Realtime script file that contains the Init() function. Game builds and Realtime scripts are installed on instances at the root:\n\nWindows (for custom game builds only): C:\\game. Example: \"C:\\game\\MyGame\\server.exe\"\n\nLinux: /local/game. Examples: \"/local/game/MyGame/server.exe\" or \"/local/game/MyRealtimeScript.js\"" + }, + "Parameters": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "An optional list of parameters to pass to the server executable or Realtime script on launch." + } + } + }, + { + "$type": "ObjectType", + "name": "TargetConfiguration", + "properties": { + "TargetValue": { + "type": { + "$ref": "#/20" + }, + "flags": 1, + "description": "Desired value to use with a target-based scaling policy. The value must be relevant for whatever metric the scaling policy is using. For example, in a policy using the metric PercentAvailableGameSessions, the target value should be the preferred size of the fleet's buffer (the percent of capacity that should be idle and ready for new game sessions)." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/45" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.GameLift/FleetProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/38" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/41" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/44" + } + }, + { + "$type": "ObjectType", + "name": "AWS.GameLift/FleetProperties", + "properties": { + "AnywhereConfiguration": { + "type": { + "$ref": "#/33" + }, + "flags": 0, + "description": "Configuration for Anywhere fleet." + }, + "ApplyCapacity": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "Determines whether to apply fleet or location capacities on fleet creation." + }, + "BuildId": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A unique identifier for a build to be deployed on the new fleet. If you are deploying the fleet with a custom game build, you must specify this property. The build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created." + }, + "CertificateConfiguration": { + "type": { + "$ref": "#/34" + }, + "flags": 0, + "description": "Indicates whether to generate a TLS/SSL certificate for the new fleet. TLS certificates are used for encrypting traffic between game clients and game servers running on GameLift. If this parameter is not set, certificate generation is disabled. This fleet setting cannot be changed once the fleet is created." + }, + "ComputeType": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "ComputeType to differentiate EC2 hardware managed by GameLift and Anywhere hardware managed by the customer." + }, + "ContainerGroupsConfiguration": { + "type": { + "$ref": "#/36" + }, + "flags": 0 + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A human-readable description of a fleet." + }, + "DesiredEC2Instances": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "[DEPRECATED] The number of EC2 instances that you want this fleet to host. When creating a new fleet, GameLift automatically sets this value to \"1\" and initiates a single instance. Once the fleet is active, update this value to trigger GameLift to add or remove instances from the fleet." + }, + "EC2InboundPermissions": { + "type": { + "$ref": "#/50" + }, + "flags": 0, + "description": "A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server." + }, + "EC2InstanceType": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions." + }, + "FleetId": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "Unique fleet ID" + }, + "FleetType": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Indicates whether to use On-Demand instances or Spot instances for this fleet. If empty, the default is ON_DEMAND. Both categories of instances use identical hardware and configurations based on the instance type selected for this fleet." + }, + "InstanceRoleARN": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A unique identifier for an AWS IAM role that manages access to your AWS services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). Create a role or look up a role's ARN from the IAM dashboard in the AWS Management Console." + }, + "InstanceRoleCredentialsProvider": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Credentials provider implementation that loads credentials from the Amazon EC2 Instance Metadata Service." + }, + "Locations": { + "type": { + "$ref": "#/51" + }, + "flags": 0 + }, + "LogPaths": { + "type": { + "$ref": "#/52" + }, + "flags": 0, + "description": "This parameter is no longer used. When hosting a custom game build, specify where Amazon GameLift should store log files using the Amazon GameLift server API call ProcessReady()" + }, + "MaxSize": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "[DEPRECATED] The maximum value that is allowed for the fleet's instance count. When creating a new fleet, GameLift automatically sets this value to \"1\". Once the fleet is active, you can change this value." + }, + "MetricGroups": { + "type": { + "$ref": "#/53" + }, + "flags": 0, + "description": "The name of an Amazon CloudWatch metric group. A metric group aggregates the metrics for all fleets in the group. Specify a string containing the metric group name. You can use an existing name or use a new name to create a new metric group. Currently, this parameter can have only one string." + }, + "MinSize": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "[DEPRECATED] The minimum value allowed for the fleet's instance count. When creating a new fleet, GameLift automatically sets this value to \"0\". After the fleet is active, you can change this value." + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "A descriptive label that is associated with a fleet. Fleet names do not need to be unique." + }, + "NewGameSessionProtectionPolicy": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A game session protection policy to apply to all game sessions hosted on instances in this fleet. When protected, active game sessions cannot be terminated during a scale-down event. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy to affect future game sessions on the fleet. You can also set protection for individual game sessions." + }, + "PeerVpcAwsAccountId": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift fleet with. You can find your account ID in the AWS Management Console under account settings." + }, + "PeerVpcId": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the AWS Management Console." + }, + "ResourceCreationLimitPolicy": { + "type": { + "$ref": "#/42" + }, + "flags": 0, + "description": "A policy that limits the number of game sessions an individual player can create over a span of time for this fleet." + }, + "RuntimeConfiguration": { + "type": { + "$ref": "#/43" + }, + "flags": 0, + "description": "Instructions for launching server processes on each instance in the fleet. Server processes run either a custom game build executable or a Realtime script. The runtime configuration defines the server executables or launch script file, launch parameters, and the number of processes to run concurrently on each instance. When creating a fleet, the runtime configuration must have at least one server process configuration; otherwise the request fails with an invalid request exception.\n\nThis parameter is required unless the parameters ServerLaunchPath and ServerLaunchParameters are defined. Runtime configuration has replaced these parameters, but fleets that use them will continue to work." + }, + "ScalingPolicies": { + "type": { + "$ref": "#/54" + }, + "flags": 0, + "description": "A list of rules that control how a fleet is scaled." + }, + "ScriptId": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A unique identifier for a Realtime script to be deployed on a new Realtime Servers fleet. The script must have been successfully uploaded to Amazon GameLift. This fleet setting cannot be changed once the fleet is created.\n\nNote: It is not currently possible to use the !Ref command to reference a script created with a CloudFormation template for the fleet property ScriptId. Instead, use Fn::GetAtt Script.Arn or Fn::GetAtt Script.Id to retrieve either of these properties as input for ScriptId. Alternatively, enter a ScriptId string manually." + }, + "ServerLaunchParameters": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "This parameter is no longer used but is retained for backward compatibility. Instead, specify server launch parameters in the RuntimeConfiguration parameter. A request must specify either a runtime configuration or values for both ServerLaunchParameters and ServerLaunchPath." + }, + "ServerLaunchPath": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "This parameter is no longer used. Instead, specify a server launch path using the RuntimeConfiguration parameter. Requests that specify a server launch path and launch parameters instead of a runtime configuration will continue to work." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.GameLift/Fleet", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/55" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.GameLift/Fleet@default", + "scopeType": 0, + "body": { + "$ref": "#/56" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AutoScalingGroupArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AutoScalingPolicy", + "properties": { + "EstimatedInstanceWarmup": { + "type": { + "$ref": "#/20" + }, + "flags": 0 + }, + "TargetTrackingConfiguration": { + "type": { + "$ref": "#/83" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "BalancingStrategy", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CreationTime", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DeleteOption", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "EstimatedInstanceWarmup", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "GameServerGroup", + "properties": { + "AutoScalingGroupArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "BalancingStrategy": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "CreationTime": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "GameServerGroupArn": { + "type": { + "$ref": "#/1" + }, + "flags": 16 + }, + "GameServerGroupName": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "GameServerProtectionPolicy": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "InstanceDefinitions": { + "type": { + "$ref": "#/88" + }, + "flags": 0 + }, + "LastUpdatedTime": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "RoleArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "Status": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "StatusReason": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "SuspendedActions": { + "type": { + "$ref": "#/89" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GameServerGroupArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "GameServerGroupName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "GameServerProtectionPolicy", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "InstanceDefinition", + "properties": { + "InstanceType": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "WeightedCapacity": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "InstanceDefinitions", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "InstanceType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LastUpdatedTime", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LaunchTemplate", + "properties": { + "LaunchTemplateId": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "LaunchTemplateName": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "Version": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "LaunchTemplateId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LaunchTemplateName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MaxSize", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MinSize", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RoleArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Status", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "StatusReason", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SuspendedActions", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The key for a developer-defined key:value pair for tagging an AWS resource." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The value for a developer-defined key:value pair for tagging an AWS resource." + } + } + }, + { + "$type": "ObjectType", + "name": "Tags", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TargetTrackingConfiguration", + "properties": { + "TargetValue": { + "type": { + "$ref": "#/20" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TargetValue", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Version", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "VpcSubnets", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "WeightedCapacity", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/68" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/68" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/81" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.GameLift/GameServerGroupProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/68" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/81" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "AWS.GameLift/GameServerGroupProperties", + "properties": { + "AutoScalingGroupArn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group." + }, + "AutoScalingPolicy": { + "type": { + "$ref": "#/59" + }, + "flags": 4, + "description": "Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource." + }, + "BalancingStrategy": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The fallback balancing method to use for the game server group when Spot Instances in a Region become unavailable or are not viable for game hosting." + }, + "DeleteOption": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The type of delete to perform." + }, + "GameServerGroupArn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "A generated unique ID for the game server group." + }, + "GameServerGroupName": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "An identifier for the new game server group." + }, + "GameServerProtectionPolicy": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A flag that indicates whether instances in the game server group are protected from early termination." + }, + "InstanceDefinitions": { + "type": { + "$ref": "#/95" + }, + "flags": 1, + "description": "A set of EC2 instance types to use when creating instances in the group." + }, + "LaunchTemplate": { + "type": { + "$ref": "#/72" + }, + "flags": 4, + "description": "The EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource." + }, + "MaxSize": { + "type": { + "$ref": "#/20" + }, + "flags": 4, + "description": "The maximum number of instances allowed in the EC2 Auto Scaling group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource." + }, + "MinSize": { + "type": { + "$ref": "#/20" + }, + "flags": 4, + "description": "The minimum number of instances allowed in the EC2 Auto Scaling group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource." + }, + "RoleArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups." + }, + "Tags": { + "type": { + "$ref": "#/96" + }, + "flags": 4, + "description": "A list of labels to assign to the new game server group resource. Updating game server group tags with CloudFormation will not take effect. Please update this property using AWS GameLift APIs instead." + }, + "VpcSubnets": { + "type": { + "$ref": "#/97" + }, + "flags": 4, + "description": "A list of virtual private cloud (VPC) subnets to use with instances in the game server group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.GameLift/GameServerGroup", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/98" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.GameLift/GameServerGroup@default", + "scopeType": 0, + "body": { + "$ref": "#/99" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AllowedLocations", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "FilterConfiguration", + "properties": { + "AllowedLocations": { + "type": { + "$ref": "#/110" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GameSessionQueueDestination", + "properties": { + "DestinationArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "LocationOrder", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PlayerLatencyPolicy", + "properties": { + "MaximumIndividualPlayerLatencyMilliseconds": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value set for this property." + }, + "PolicyDurationSeconds": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "The length of time, in seconds, that the policy is enforced while placing a new game session." + } + } + }, + { + "$type": "ObjectType", + "name": "PriorityConfiguration", + "properties": { + "LocationOrder": { + "type": { + "$ref": "#/112" + }, + "flags": 0 + }, + "PriorityOrder": { + "type": { + "$ref": "#/113" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PriorityOrder", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.GameLift/GameSessionQueueProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/103" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "GameSessionQueue_FilterConfiguration", + "properties": { + "AllowedLocations": { + "type": { + "$ref": "#/117" + }, + "flags": 0 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/105" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "GameSessionQueue_PriorityConfiguration", + "properties": { + "LocationOrder": { + "type": { + "$ref": "#/120" + }, + "flags": 0 + }, + "PriorityOrder": { + "type": { + "$ref": "#/121" + }, + "flags": 0 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/108" + } + }, + { + "$type": "ObjectType", + "name": "AWS.GameLift/GameSessionQueueProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it." + }, + "CustomEventData": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Information that is added to all events that are related to this game session queue." + }, + "Destinations": { + "type": { + "$ref": "#/116" + }, + "flags": 0, + "description": "A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue." + }, + "FilterConfiguration": { + "type": { + "$ref": "#/118" + }, + "flags": 0, + "description": "A list of locations where a queue is allowed to place new game sessions." + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "A descriptive label that is associated with game session queue. Queue names must be unique within each Region." + }, + "NotificationTarget": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "An SNS topic ARN that is set up to receive game session placement notifications." + }, + "PlayerLatencyPolicies": { + "type": { + "$ref": "#/119" + }, + "flags": 0, + "description": "A set of policies that act as a sliding cap on player latency." + }, + "PriorityConfiguration": { + "type": { + "$ref": "#/122" + }, + "flags": 0, + "description": "Custom settings to use when prioritizing destinations and locations for game session placements." + }, + "Tags": { + "type": { + "$ref": "#/123" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + }, + "TimeoutInSeconds": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "The maximum time, in seconds, that a new game session placement request remains in the queue." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.GameLift/GameSessionQueue", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/124" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.GameLift/GameSessionQueue@default", + "scopeType": 0, + "body": { + "$ref": "#/125" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.GameLift/LocationProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/127" + } + }, + { + "$type": "ObjectType", + "name": "AWS.GameLift/LocationProperties", + "properties": { + "LocationArn": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "LocationName": { + "type": { + "$ref": "#/1" + }, + "flags": 17 + }, + "Tags": { + "type": { + "$ref": "#/129" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.GameLift/Location", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/130" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.GameLift/Location@default", + "scopeType": 0, + "body": { + "$ref": "#/131" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "GameProperty", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The game property identifier." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The game property value." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.GameLift/MatchmakingConfigurationProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/133" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/134" + } + }, + { + "$type": "ObjectType", + "name": "AWS.GameLift/MatchmakingConfigurationProperties", + "properties": { + "AcceptanceRequired": { + "type": { + "$ref": "#/24" + }, + "flags": 1, + "description": "A flag that indicates whether a match that was created with this configuration must be accepted by the matched players" + }, + "AcceptanceTimeoutSeconds": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required." + }, + "AdditionalPlayerCount": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "The number of player slots in a match to keep open for future players." + }, + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift matchmaking configuration resource and uniquely identifies it." + }, + "BackfillMode": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The method used to backfill game sessions created with this matchmaking configuration." + }, + "CreationTime": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A time stamp indicating when this data object was created." + }, + "CustomEventData": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Information to attach to all events related to the matchmaking configuration." + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A descriptive label that is associated with matchmaking configuration." + }, + "FlexMatchMode": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution." + }, + "GameProperties": { + "type": { + "$ref": "#/136" + }, + "flags": 0, + "description": "A set of custom properties for a game session, formatted as key:value pairs." + }, + "GameSessionData": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A set of custom game session properties, formatted as a single string value." + }, + "GameSessionQueueArns": { + "type": { + "$ref": "#/137" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it." + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "A unique identifier for the matchmaking configuration." + }, + "NotificationTarget": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "An SNS topic ARN that is set up to receive matchmaking notifications." + }, + "RequestTimeoutSeconds": { + "type": { + "$ref": "#/20" + }, + "flags": 1, + "description": "The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out." + }, + "RuleSetArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) associated with the GameLift matchmaking rule set resource that this configuration uses." + }, + "RuleSetName": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "A unique identifier for the matchmaking rule set to use with this configuration." + }, + "Tags": { + "type": { + "$ref": "#/138" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.GameLift/MatchmakingConfiguration", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/139" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.GameLift/MatchmakingConfiguration@default", + "scopeType": 0, + "body": { + "$ref": "#/140" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.GameLift/MatchmakingRuleSetProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/142" + } + }, + { + "$type": "ObjectType", + "name": "AWS.GameLift/MatchmakingRuleSetProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift matchmaking rule set resource and uniquely identifies it." + }, + "CreationTime": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds." + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "A unique identifier for the matchmaking rule set." + }, + "RuleSetBody": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "A collection of matchmaking rules, formatted as a JSON string." + }, + "Tags": { + "type": { + "$ref": "#/144" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.GameLift/MatchmakingRuleSet", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/145" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.GameLift/MatchmakingRuleSet@default", + "scopeType": 0, + "body": { + "$ref": "#/146" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "S3Location", + "properties": { + "Bucket": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "An Amazon S3 bucket identifier. This is the name of the S3 bucket." + }, + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The name of the zip file that contains the script files." + }, + "ObjectVersion": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The version of the file, if object versioning is turned on for the bucket. Amazon GameLift uses this information when retrieving files from your S3 bucket. To retrieve a specific version of the file, provide an object version. To retrieve the latest version of the file, do not set this parameter." + }, + "RoleArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access the S3 bucket." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.GameLift/ScriptProperties" + }, + { + "$type": "ObjectType", + "name": "Script_S3Location", + "properties": { + "Bucket": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "An Amazon S3 bucket identifier. This is the name of the S3 bucket." + }, + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The name of the zip file that contains the script files." + }, + "ObjectVersion": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The version of the file, if object versioning is turned on for the bucket. Amazon GameLift uses this information when retrieving files from your S3 bucket. To retrieve a specific version of the file, provide an object version. To retrieve the latest version of the file, do not set this parameter." + }, + "RoleArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access the S3 bucket." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/149" + } + }, + { + "$type": "ObjectType", + "name": "AWS.GameLift/ScriptProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift script resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift script ARN, the resource ID matches the Id value." + }, + "CreationTime": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\")." + }, + "Id": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "A unique identifier for the Realtime script" + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A descriptive label that is associated with a script. Script names do not need to be unique." + }, + "SizeOnDisk": { + "type": { + "$ref": "#/20" + }, + "flags": 2, + "description": "The file size of the uploaded Realtime script, expressed in bytes. When files are uploaded from an S3 location, this value remains at \"0\"." + }, + "StorageLocation": { + "type": { + "$ref": "#/151" + }, + "flags": 1, + "description": "The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the \"key\"), and a role ARN that allows Amazon GameLift to access the Amazon S3 storage location. The S3 bucket must be in the same Region where you want to create a new script. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the ObjectVersion parameter to specify an earlier version." + }, + "Tags": { + "type": { + "$ref": "#/152" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + }, + "Version": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The version that is associated with a script. Version strings do not need to be unique." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.GameLift/Script", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/153" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.GameLift/Script@default", + "scopeType": 0, + "body": { + "$ref": "#/154" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.gamelift/default/types.md b/artifacts/bicep/aws/aws.gamelift/default/types.md index 06da0d3b..459eb0e9 100644 --- a/artifacts/bicep/aws/aws.gamelift/default/types.md +++ b/artifacts/bicep/aws/aws.gamelift/default/types.md @@ -3,65 +3,81 @@ ## Resource AWS.GameLift/Alias@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.GameLift/AliasProperties](#awsgameliftaliasproperties) (Required): properties of the resource +* **properties**: [AWS.GameLift/AliasProperties](#awsgameliftaliasproperties) (Required, Identifier): properties of the resource ## Resource AWS.GameLift/Build@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.GameLift/BuildProperties](#awsgameliftbuildproperties): properties of the resource +* **properties**: [AWS.GameLift/BuildProperties](#awsgameliftbuildproperties) (Identifier): properties of the resource + +## Resource AWS.GameLift/ContainerGroupDefinition@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.GameLift/ContainerGroupDefinitionProperties](#awsgameliftcontainergroupdefinitionproperties) (Required, Identifier): properties of the resource ## Resource AWS.GameLift/Fleet@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.GameLift/FleetProperties](#awsgameliftfleetproperties) (Required): properties of the resource +* **properties**: [AWS.GameLift/FleetProperties](#awsgameliftfleetproperties) (Required, Identifier): properties of the resource ## Resource AWS.GameLift/GameServerGroup@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.GameLift/GameServerGroupProperties](#awsgameliftgameservergroupproperties) (Required): properties of the resource +* **properties**: [AWS.GameLift/GameServerGroupProperties](#awsgameliftgameservergroupproperties) (Required, Identifier): properties of the resource ## Resource AWS.GameLift/GameSessionQueue@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.GameLift/GameSessionQueueProperties](#awsgameliftgamesessionqueueproperties) (Required): properties of the resource +* **properties**: [AWS.GameLift/GameSessionQueueProperties](#awsgameliftgamesessionqueueproperties) (Required, Identifier): properties of the resource ## Resource AWS.GameLift/Location@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.GameLift/LocationProperties](#awsgameliftlocationproperties) (Required): properties of the resource +* **properties**: [AWS.GameLift/LocationProperties](#awsgameliftlocationproperties) (Required, Identifier): properties of the resource ## Resource AWS.GameLift/MatchmakingConfiguration@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.GameLift/MatchmakingConfigurationProperties](#awsgameliftmatchmakingconfigurationproperties) (Required): properties of the resource +* **properties**: [AWS.GameLift/MatchmakingConfigurationProperties](#awsgameliftmatchmakingconfigurationproperties) (Required, Identifier): properties of the resource ## Resource AWS.GameLift/MatchmakingRuleSet@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.GameLift/MatchmakingRuleSetProperties](#awsgameliftmatchmakingrulesetproperties) (Required): properties of the resource +* **properties**: [AWS.GameLift/MatchmakingRuleSetProperties](#awsgameliftmatchmakingrulesetproperties) (Required, Identifier): properties of the resource ## Resource AWS.GameLift/Script@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.GameLift/ScriptProperties](#awsgameliftscriptproperties) (Required): properties of the resource +* **properties**: [AWS.GameLift/ScriptProperties](#awsgameliftscriptproperties) (Required, Identifier): properties of the resource + +## AnywhereConfiguration +### Properties +* **Cost**: string (Required): Cost of compute can be specified on Anywhere Fleets to prioritize placement across Queue destinations based on Cost. + +## AutoScalingPolicy +### Properties +* **EstimatedInstanceWarmup**: int +* **TargetTrackingConfiguration**: [TargetTrackingConfiguration](#targettrackingconfiguration) (Required) ## AWS.GameLift/AliasProperties ### Properties @@ -70,12 +86,6 @@ * **Name**: string (Required): A descriptive label that is associated with an alias. Alias names do not need to be unique. * **RoutingStrategy**: [RoutingStrategy](#routingstrategy) (Required): A routing configuration that specifies where traffic is directed for this alias, such as to a fleet or to a message. -## RoutingStrategy -### Properties -* **FleetId**: string: A unique identifier for a fleet that the alias points to. If you specify SIMPLE for the Type property, you must specify this property. -* **Message**: string: The message text to be used with a terminal routing strategy. If you specify TERMINAL for the Type property, you must specify this property. -* **Type**: string (Required): Simple routing strategy. The alias resolves to one specific fleet. Use this type when routing to active fleets. - ## AWS.GameLift/BuildProperties ### Properties * **BuildId**: string (ReadOnly, Identifier): A unique identifier for a build to be deployed on the new fleet. If you are deploying the fleet with a custom game build, you must specify this property. The build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created. @@ -85,20 +95,26 @@ * **StorageLocation**: [StorageLocation](#storagelocation) (WriteOnly): Information indicating where your game build files are stored. Use this parameter only when creating a build with files stored in an Amazon S3 bucket that you own. The storage location must specify an Amazon S3 bucket name and key. The location must also specify a role ARN that you set up to allow Amazon GameLift to access your Amazon S3 bucket. The S3 bucket and your new build must be in the same Region. * **Version**: string: Version information that is associated with this build. Version strings do not need to be unique. -## StorageLocation +## AWS.GameLift/ContainerGroupDefinitionProperties ### Properties -* **Bucket**: string (Required): An Amazon S3 bucket identifier. This is the name of the S3 bucket. -* **Key**: string (Required): The name of the zip file that contains the build files or script files. -* **ObjectVersion**: string: The version of the file, if object versioning is turned on for the bucket. Amazon GameLift uses this information when retrieving files from your S3 bucket. To retrieve a specific version of the file, provide an object version. To retrieve the latest version of the file, do not set this parameter. -* **RoleArn**: string (Required): The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access the S3 bucket. +* **ContainerDefinitions**: [ContainerDefinition](#containerdefinition)[] (Required, ReadOnly): A collection of container definitions that define the containers in this group. +* **ContainerGroupDefinitionArn**: string (ReadOnly): The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift container group resource and uniquely identifies it across all AWS Regions. +* **CreationTime**: string (ReadOnly): A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). +* **Name**: string (Required, Identifier): A descriptive label for the container group definition. +* **OperatingSystem**: string (Required): The operating system of the container group +* **SchedulingStrategy**: string: Specifies whether the container group includes replica or daemon containers. +* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. +* **TotalCpuLimit**: int (Required): The maximum number of CPU units reserved for this container group. The value is expressed as an integer amount of CPU units. (1 vCPU is equal to 1024 CPU units.) +* **TotalMemoryLimit**: int (Required): The maximum amount of memory (in MiB) to allocate for this container group. ## AWS.GameLift/FleetProperties ### Properties * **AnywhereConfiguration**: [AnywhereConfiguration](#anywhereconfiguration): Configuration for Anywhere fleet. -* **ApplyCapacity**: string: ComputeType to differentiate EC2 hardware managed by GameLift and Anywhere hardware managed by the customer. +* **ApplyCapacity**: string (WriteOnly): Determines whether to apply fleet or location capacities on fleet creation. * **BuildId**: string: A unique identifier for a build to be deployed on the new fleet. If you are deploying the fleet with a custom game build, you must specify this property. The build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created. * **CertificateConfiguration**: [CertificateConfiguration](#certificateconfiguration): Indicates whether to generate a TLS/SSL certificate for the new fleet. TLS certificates are used for encrypting traffic between game clients and game servers running on GameLift. If this parameter is not set, certificate generation is disabled. This fleet setting cannot be changed once the fleet is created. * **ComputeType**: string: ComputeType to differentiate EC2 hardware managed by GameLift and Anywhere hardware managed by the customer. +* **ContainerGroupsConfiguration**: [ContainerGroupsConfiguration](#containergroupsconfiguration) * **Description**: string: A human-readable description of a fleet. * **DesiredEC2Instances**: int: [DEPRECATED] The number of EC2 instances that you want this fleet to host. When creating a new fleet, GameLift automatically sets this value to "1" and initiates a single instance. Once the fleet is active, update this value to trigger GameLift to add or remove instances from the fleet. * **EC2InboundPermissions**: [IpPermission](#ippermission)[]: A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server. @@ -127,14 +143,165 @@ Note: It is not currently possible to use the !Ref command to reference a script * **ServerLaunchParameters**: string: This parameter is no longer used but is retained for backward compatibility. Instead, specify server launch parameters in the RuntimeConfiguration parameter. A request must specify either a runtime configuration or values for both ServerLaunchParameters and ServerLaunchPath. * **ServerLaunchPath**: string: This parameter is no longer used. Instead, specify a server launch path using the RuntimeConfiguration parameter. Requests that specify a server launch path and launch parameters instead of a runtime configuration will continue to work. -## AnywhereConfiguration +## AWS.GameLift/GameServerGroupProperties ### Properties -* **Cost**: string (Required): Cost of compute can be specified on Anywhere Fleets to prioritize placement across Queue destinations based on Cost. +* **AutoScalingGroupArn**: string (ReadOnly): A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group. +* **AutoScalingPolicy**: [AutoScalingPolicy](#autoscalingpolicy) (WriteOnly): Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource. +* **BalancingStrategy**: string: The fallback balancing method to use for the game server group when Spot Instances in a Region become unavailable or are not viable for game hosting. +* **DeleteOption**: string (WriteOnly): The type of delete to perform. +* **GameServerGroupArn**: string (ReadOnly, Identifier): A generated unique ID for the game server group. +* **GameServerGroupName**: string (Required): An identifier for the new game server group. +* **GameServerProtectionPolicy**: string: A flag that indicates whether instances in the game server group are protected from early termination. +* **InstanceDefinitions**: [InstanceDefinition](#instancedefinition)[] (Required): A set of EC2 instance types to use when creating instances in the group. +* **LaunchTemplate**: [LaunchTemplate](#launchtemplate) (WriteOnly): The EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource. +* **MaxSize**: int (WriteOnly): The maximum number of instances allowed in the EC2 Auto Scaling group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource. +* **MinSize**: int (WriteOnly): The minimum number of instances allowed in the EC2 Auto Scaling group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource. +* **RoleArn**: string (Required): The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups. +* **Tags**: [Tag](#tag)[] (WriteOnly): A list of labels to assign to the new game server group resource. Updating game server group tags with CloudFormation will not take effect. Please update this property using AWS GameLift APIs instead. +* **VpcSubnets**: string[] (WriteOnly): A list of virtual private cloud (VPC) subnets to use with instances in the game server group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource. + +## AWS.GameLift/GameSessionQueueProperties +### Properties +* **Arn**: string (ReadOnly): The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it. +* **CustomEventData**: string: Information that is added to all events that are related to this game session queue. +* **Destinations**: [GameSessionQueueDestination](#gamesessionqueuedestination)[]: A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue. +* **FilterConfiguration**: [GameSessionQueue_FilterConfiguration](#gamesessionqueuefilterconfiguration): A list of locations where a queue is allowed to place new game sessions. +* **Name**: string (Required, Identifier): A descriptive label that is associated with game session queue. Queue names must be unique within each Region. +* **NotificationTarget**: string: An SNS topic ARN that is set up to receive game session placement notifications. +* **PlayerLatencyPolicies**: [PlayerLatencyPolicy](#playerlatencypolicy)[]: A set of policies that act as a sliding cap on player latency. +* **PriorityConfiguration**: [GameSessionQueue_PriorityConfiguration](#gamesessionqueuepriorityconfiguration): Custom settings to use when prioritizing destinations and locations for game session placements. +* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. +* **TimeoutInSeconds**: int: The maximum time, in seconds, that a new game session placement request remains in the queue. + +## AWS.GameLift/LocationProperties +### Properties +* **LocationArn**: string (ReadOnly) +* **LocationName**: string (Required, Identifier) +* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. + +## AWS.GameLift/MatchmakingConfigurationProperties +### Properties +* **AcceptanceRequired**: bool (Required): A flag that indicates whether a match that was created with this configuration must be accepted by the matched players +* **AcceptanceTimeoutSeconds**: int: The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required. +* **AdditionalPlayerCount**: int: The number of player slots in a match to keep open for future players. +* **Arn**: string (ReadOnly): The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift matchmaking configuration resource and uniquely identifies it. +* **BackfillMode**: string: The method used to backfill game sessions created with this matchmaking configuration. +* **CreationTime**: string: A time stamp indicating when this data object was created. +* **CustomEventData**: string: Information to attach to all events related to the matchmaking configuration. +* **Description**: string: A descriptive label that is associated with matchmaking configuration. +* **FlexMatchMode**: string: Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution. +* **GameProperties**: [GameProperty](#gameproperty)[]: A set of custom properties for a game session, formatted as key:value pairs. +* **GameSessionData**: string: A set of custom game session properties, formatted as a single string value. +* **GameSessionQueueArns**: string[]: The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it. +* **Name**: string (Required, Identifier): A unique identifier for the matchmaking configuration. +* **NotificationTarget**: string: An SNS topic ARN that is set up to receive matchmaking notifications. +* **RequestTimeoutSeconds**: int (Required): The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. +* **RuleSetArn**: string: The Amazon Resource Name (ARN) associated with the GameLift matchmaking rule set resource that this configuration uses. +* **RuleSetName**: string (Required): A unique identifier for the matchmaking rule set to use with this configuration. +* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. + +## AWS.GameLift/MatchmakingRuleSetProperties +### Properties +* **Arn**: string (ReadOnly): The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift matchmaking rule set resource and uniquely identifies it. +* **CreationTime**: string (ReadOnly): A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds. +* **Name**: string (Required, Identifier): A unique identifier for the matchmaking rule set. +* **RuleSetBody**: string (Required): A collection of matchmaking rules, formatted as a JSON string. +* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. + +## AWS.GameLift/ScriptProperties +### Properties +* **Arn**: string (ReadOnly): The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift script resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift script ARN, the resource ID matches the Id value. +* **CreationTime**: string (ReadOnly): A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). +* **Id**: string (ReadOnly, Identifier): A unique identifier for the Realtime script +* **Name**: string: A descriptive label that is associated with a script. Script names do not need to be unique. +* **SizeOnDisk**: int (ReadOnly): The file size of the uploaded Realtime script, expressed in bytes. When files are uploaded from an S3 location, this value remains at "0". +* **StorageLocation**: [Script_S3Location](#scripts3location) (Required): The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the "key"), and a role ARN that allows Amazon GameLift to access the Amazon S3 storage location. The S3 bucket must be in the same Region where you want to create a new script. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the ObjectVersion parameter to specify an earlier version. +* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. +* **Version**: string: The version that is associated with a script. Version strings do not need to be unique. ## CertificateConfiguration ### Properties * **CertificateType**: string (Required) +## ConnectionPortRange +### Properties +* **FromPort**: int (Required): A starting value for a range of allowed port numbers. +* **ToPort**: int (Required): An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort. + +## ContainerDefinition +### Properties +* **Command**: string[]: The command that's passed to the container. +* **ContainerName**: string (Required): A descriptive label for the container definition. Container definition names must be unique with a container group definition. +* **Cpu**: int: The maximum number of CPU units reserved for this container. The value is expressed as an integer amount of CPU units. 1 vCPU is equal to 1024 CPU units +* **DependsOn**: [ContainerDependency](#containerdependency)[]: A list of container dependencies that determines when this container starts up and shuts down. For container groups with multiple containers, dependencies let you define a startup/shutdown sequence across the containers. +* **EntryPoint**: string[]: The entry point that's passed to the container so that it will run as an executable. If there are multiple arguments, each argument is a string in the array. +* **Environment**: [ContainerEnvironment](#containerenvironment)[]: The environment variables to pass to a container. +* **Essential**: bool: Specifies if the container is essential. If an essential container fails a health check, then all containers in the container group will be restarted. You must specify exactly 1 essential container in a container group. +* **HealthCheck**: [ContainerHealthCheck](#containerhealthcheck): Specifies how the health of the containers will be checked. +* **ImageUri**: string (Required): Specifies the image URI of this container. +* **MemoryLimits**: [MemoryLimits](#memorylimits): Specifies how much memory is available to the container. You must specify at least this parameter or the TotalMemoryLimit parameter of the ContainerGroupDefinition. +* **PortConfiguration**: [PortConfiguration](#portconfiguration): Defines the ports on the container. +* **ResolvedImageDigest**: string: The digest of the container image. +* **WorkingDirectory**: string: The working directory to run commands inside the container in. + +## ContainerDependency +### Properties +* **Condition**: string (Required): The type of dependency. +* **ContainerName**: string (Required): A descriptive label for the container definition. The container being defined depends on this container's condition. + +## ContainerEnvironment +### Properties +* **Name**: string (Required, Identifier): The environment variable name. +* **Value**: string (Required): The environment variable value. + +## ContainerGroupsConfiguration +### Properties +* **ConnectionPortRange**: [ConnectionPortRange](#connectionportrange) (Required) +* **ContainerGroupDefinitionNames**: string[] (Required): The names of the container group definitions that will be created in an instance. You must specify exactly one REPLICA container group. You have the option to also specify one DAEMON container group. +* **ContainerGroupsPerInstance**: [ContainerGroupsPerInstance](#containergroupsperinstance) + +## ContainerGroupsPerInstance +### Properties +* **DesiredReplicaContainerGroupsPerInstance**: int: Use this parameter to override the number of replica container groups GameLift will launch per instance with a number that is lower than that calculated maximum. +* **MaxReplicaContainerGroupsPerInstance**: int (ReadOnly): GameLift calculates the maximum number of replica container groups it can launch per instance based on instance properties such as CPU, memory, and connection ports. + +## ContainerHealthCheck +### Properties +* **Command**: string[] (Required): A string array representing the command that the container runs to determine if it is healthy. +* **Interval**: int: How often (in seconds) the health is checked. +* **Retries**: int: How many times the process manager will retry the command after a timeout. (The first run of the command does not count as a retry.) +* **StartPeriod**: int: The optional grace period (in seconds) to give a container time to boostrap before teh health check is declared failed. +* **Timeout**: int: How many seconds the process manager allows the command to run before canceling it. + +## ContainerPortRange +### Properties +* **FromPort**: int (Required): A starting value for the range of allowed port numbers. +* **Protocol**: string (Required): Defines the protocol of these ports. +* **ToPort**: int (Required): An ending value for the range of allowed port numbers. Port numbers are end-inclusive. This value must be equal to or greater than FromPort. + +## GameProperty +### Properties +* **Key**: string (Required): The game property identifier. +* **Value**: string (Required): The game property value. + +## GameSessionQueue_FilterConfiguration +### Properties +* **AllowedLocations**: string[] + +## GameSessionQueue_PriorityConfiguration +### Properties +* **LocationOrder**: string[] +* **PriorityOrder**: string[] + +## GameSessionQueueDestination +### Properties +* **DestinationArn**: string + +## InstanceDefinition +### Properties +* **InstanceType**: string (Required) +* **WeightedCapacity**: string + ## IpPermission ### Properties * **FromPort**: int (Required): A starting value for a range of allowed port numbers. @@ -142,10 +309,11 @@ Note: It is not currently possible to use the !Ref command to reference a script * **Protocol**: string (Required): The network communication protocol used by the fleet. * **ToPort**: int (Required): An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort. -## LocationConfiguration +## LaunchTemplate ### Properties -* **Location**: string (Required) -* **LocationCapacity**: [LocationCapacity](#locationcapacity) +* **LaunchTemplateId**: string +* **LaunchTemplateName**: string +* **Version**: string ## LocationCapacity ### Properties @@ -153,27 +321,42 @@ Note: It is not currently possible to use the !Ref command to reference a script * **MaxSize**: int (Required): The maximum value that is allowed for the fleet's instance count for a location. When creating a new fleet, GameLift automatically sets this value to "1". Once the fleet is active, you can change this value. * **MinSize**: int (Required): The minimum value allowed for the fleet's instance count for a location. When creating a new fleet, GameLift automatically sets this value to "0". After the fleet is active, you can change this value. +## LocationConfiguration +### Properties +* **Location**: string (Required) +* **LocationCapacity**: [LocationCapacity](#locationcapacity) + +## MemoryLimits +### Properties +* **HardLimit**: int: The hard limit of memory to reserve for the container. +* **SoftLimit**: int: The amount of memory that is reserved for the container. + +## PlayerLatencyPolicy +### Properties +* **MaximumIndividualPlayerLatencyMilliseconds**: int: The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value set for this property. +* **PolicyDurationSeconds**: int: The length of time, in seconds, that the policy is enforced while placing a new game session. + +## PortConfiguration +### Properties +* **ContainerPortRanges**: [ContainerPortRange](#containerportrange)[] (Required): Specifies one or more ranges of ports on a container. + ## ResourceCreationLimitPolicy ### Properties * **NewGameSessionsPerCreator**: int: The maximum number of game sessions that an individual can create during the policy period. * **PolicyPeriodInMinutes**: int: The time span used in evaluating the resource creation limit policy. +## RoutingStrategy +### Properties +* **FleetId**: string: A unique identifier for a fleet that the alias points to. If you specify SIMPLE for the Type property, you must specify this property. +* **Message**: string: The message text to be used with a terminal routing strategy. If you specify TERMINAL for the Type property, you must specify this property. +* **Type**: string (Required): Simple routing strategy. The alias resolves to one specific fleet. Use this type when routing to active fleets. + ## RuntimeConfiguration ### Properties * **GameSessionActivationTimeoutSeconds**: int: The maximum amount of time (in seconds) that a game session can remain in status ACTIVATING. If the game session is not active before the timeout, activation is terminated and the game session status is changed to TERMINATED. * **MaxConcurrentGameSessionActivations**: int: The maximum number of game sessions with status ACTIVATING to allow on an instance simultaneously. This setting limits the amount of instance resources that can be used for new game activations at any one time. * **ServerProcesses**: [ServerProcess](#serverprocess)[]: A collection of server process configurations that describe which server processes to run on each instance in a fleet. -## ServerProcess -### Properties -* **ConcurrentExecutions**: int (Required): The number of server processes that use this configuration to run concurrently on an instance. -* **LaunchPath**: string (Required): The location of the server executable in a custom game build or the name of the Realtime script file that contains the Init() function. Game builds and Realtime scripts are installed on instances at the root: - -Windows (for custom game builds only): C:\game. Example: "C:\game\MyGame\server.exe" - -Linux: /local/game. Examples: "/local/game/MyGame/server.exe" or "/local/game/MyRealtimeScript.js" -* **Parameters**: string: An optional list of parameters to pass to the server executable or Realtime script on launch. - ## ScalingPolicy ### Properties * **ComparisonOperator**: string: Comparison operator to use when measuring a metric against the threshold value. @@ -189,163 +372,70 @@ Linux: /local/game. Examples: "/local/game/MyGame/server.exe" or "/local/game/My * **Threshold**: int: Metric value used to trigger a scaling event. * **UpdateStatus**: string: The current status of the fleet's scaling policies in a requested fleet location. The status PENDING_UPDATE indicates that an update was requested for the fleet but has not yet been completed for the location. -## TargetConfiguration +## Script_S3Location ### Properties -* **TargetValue**: int (Required): Desired value to use with a target-based scaling policy. The value must be relevant for whatever metric the scaling policy is using. For example, in a policy using the metric PercentAvailableGameSessions, the target value should be the preferred size of the fleet's buffer (the percent of capacity that should be idle and ready for new game sessions). +* **Bucket**: string (Required): An Amazon S3 bucket identifier. This is the name of the S3 bucket. +* **Key**: string (Required): The name of the zip file that contains the script files. +* **ObjectVersion**: string: The version of the file, if object versioning is turned on for the bucket. Amazon GameLift uses this information when retrieving files from your S3 bucket. To retrieve a specific version of the file, provide an object version. To retrieve the latest version of the file, do not set this parameter. +* **RoleArn**: string (Required): The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access the S3 bucket. -## AWS.GameLift/GameServerGroupProperties +## ServerProcess ### Properties -* **AutoScalingGroupArn**: string (ReadOnly): A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group. -* **AutoScalingPolicy**: [AutoScalingPolicy](#autoscalingpolicy) (WriteOnly): Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting -* **BalancingStrategy**: string: The fallback balancing method to use for the game server group when Spot Instances in a Region become unavailable or are not viable for game hosting. -* **DeleteOption**: string (WriteOnly): The type of delete to perform. -* **GameServerGroupArn**: string (ReadOnly, Identifier): A generated unique ID for the game server group. -* **GameServerGroupName**: string (Required): An identifier for the new game server group. -* **GameServerProtectionPolicy**: string: A flag that indicates whether instances in the game server group are protected from early termination. -* **InstanceDefinitions**: [InstanceDefinition](#instancedefinition)[] (Required): A set of EC2 instance types to use when creating instances in the group. -* **LaunchTemplate**: [LaunchTemplate](#launchtemplate) (WriteOnly): The EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group. -* **MaxSize**: int (WriteOnly): The maximum number of instances allowed in the EC2 Auto Scaling group. -* **MinSize**: int (WriteOnly): The minimum number of instances allowed in the EC2 Auto Scaling group. -* **RoleArn**: string (Required): The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups. -* **Tags**: [Tag](#tag)[] (WriteOnly): A list of labels to assign to the new game server group resource. -* **VpcSubnets**: string[] (WriteOnly): A list of virtual private cloud (VPC) subnets to use with instances in the game server group. +* **ConcurrentExecutions**: int (Required): The number of server processes that use this configuration to run concurrently on an instance. +* **LaunchPath**: string (Required): The location of the server executable in a custom game build or the name of the Realtime script file that contains the Init() function. Game builds and Realtime scripts are installed on instances at the root: -## AutoScalingPolicy -### Properties -* **EstimatedInstanceWarmup**: int -* **TargetTrackingConfiguration**: [TargetTrackingConfiguration](#targettrackingconfiguration) (Required) +Windows (for custom game builds only): C:\game. Example: "C:\game\MyGame\server.exe" -## TargetTrackingConfiguration -### Properties -* **TargetValue**: int (Required) +Linux: /local/game. Examples: "/local/game/MyGame/server.exe" or "/local/game/MyRealtimeScript.js" +* **Parameters**: string: An optional list of parameters to pass to the server executable or Realtime script on launch. -## InstanceDefinition +## StorageLocation ### Properties -* **InstanceType**: string (Required) -* **WeightedCapacity**: string +* **Bucket**: string (Required): An Amazon S3 bucket identifier. This is the name of the S3 bucket. +* **Key**: string (Required): The name of the zip file that contains the build files or script files. +* **ObjectVersion**: string: The version of the file, if object versioning is turned on for the bucket. Amazon GameLift uses this information when retrieving files from your S3 bucket. To retrieve a specific version of the file, provide an object version. To retrieve the latest version of the file, do not set this parameter. +* **RoleArn**: string (Required): The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access the S3 bucket. -## LaunchTemplate +## Tag ### Properties -* **LaunchTemplateId**: string -* **LaunchTemplateName**: string -* **Version**: string +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. ## Tag ### Properties * **Key**: string: The key for a developer-defined key:value pair for tagging an AWS resource. * **Value**: string: The value for a developer-defined key:value pair for tagging an AWS resource. -## AWS.GameLift/GameSessionQueueProperties -### Properties -* **Arn**: string (ReadOnly): The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it. -* **CustomEventData**: string: Information that is added to all events that are related to this game session queue. -* **Destinations**: [GameSessionQueueDestination](#gamesessionqueuedestination)[]: A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue. -* **FilterConfiguration**: [GameSessionQueue_FilterConfiguration](#gamesessionqueuefilterconfiguration): A list of locations where a queue is allowed to place new game sessions. -* **Name**: string (Required, Identifier): A descriptive label that is associated with game session queue. Queue names must be unique within each Region. -* **NotificationTarget**: string: An SNS topic ARN that is set up to receive game session placement notifications. -* **PlayerLatencyPolicies**: [PlayerLatencyPolicy](#playerlatencypolicy)[]: A set of policies that act as a sliding cap on player latency. -* **PriorityConfiguration**: [GameSessionQueue_PriorityConfiguration](#gamesessionqueuepriorityconfiguration): Custom settings to use when prioritizing destinations and locations for game session placements. -* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. -* **TimeoutInSeconds**: int: The maximum time, in seconds, that a new game session placement request remains in the queue. - -## GameSessionQueueDestination -### Properties -* **DestinationArn**: string - -## GameSessionQueue_FilterConfiguration -### Properties -* **AllowedLocations**: string[] - -## PlayerLatencyPolicy -### Properties -* **MaximumIndividualPlayerLatencyMilliseconds**: int: The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value set for this property. -* **PolicyDurationSeconds**: int: The length of time, in seconds, that the policy is enforced while placing a new game session. - -## GameSessionQueue_PriorityConfiguration -### Properties -* **LocationOrder**: string[] -* **PriorityOrder**: string[] - ## Tag ### Properties * **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length. * **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length. -## AWS.GameLift/LocationProperties -### Properties -* **LocationArn**: string (ReadOnly) -* **LocationName**: string (Required, Identifier) -* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. - ## Tag ### Properties * **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length. * **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. -## AWS.GameLift/MatchmakingConfigurationProperties -### Properties -* **AcceptanceRequired**: bool (Required): A flag that indicates whether a match that was created with this configuration must be accepted by the matched players -* **AcceptanceTimeoutSeconds**: int: The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required. -* **AdditionalPlayerCount**: int: The number of player slots in a match to keep open for future players. -* **Arn**: string (ReadOnly): The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift matchmaking configuration resource and uniquely identifies it. -* **BackfillMode**: string: The method used to backfill game sessions created with this matchmaking configuration. -* **CreationTime**: string: A time stamp indicating when this data object was created. -* **CustomEventData**: string: Information to attach to all events related to the matchmaking configuration. -* **Description**: string: A descriptive label that is associated with matchmaking configuration. -* **FlexMatchMode**: string: Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution. -* **GameProperties**: [GameProperty](#gameproperty)[]: A set of custom properties for a game session, formatted as key:value pairs. -* **GameSessionData**: string: A set of custom game session properties, formatted as a single string value. -* **GameSessionQueueArns**: string[]: The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it. -* **Name**: string (Required, Identifier): A unique identifier for the matchmaking configuration. -* **NotificationTarget**: string: An SNS topic ARN that is set up to receive matchmaking notifications. -* **RequestTimeoutSeconds**: int (Required): The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. -* **RuleSetArn**: string: The Amazon Resource Name (ARN) associated with the GameLift matchmaking rule set resource that this configuration uses. -* **RuleSetName**: string (Required): A unique identifier for the matchmaking rule set to use with this configuration. -* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. - -## GameProperty -### Properties -* **Key**: string (Required): The game property identifier. -* **Value**: string (Required): The game property value. - ## Tag ### Properties * **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length. * **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. -## AWS.GameLift/MatchmakingRuleSetProperties -### Properties -* **Arn**: string (ReadOnly): The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift matchmaking rule set resource and uniquely identifies it. -* **CreationTime**: string (ReadOnly): A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds. -* **Name**: string (Required, Identifier): A unique identifier for the matchmaking rule set. -* **RuleSetBody**: string (Required): A collection of matchmaking rules, formatted as a JSON string. -* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. - ## Tag ### Properties * **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length. * **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length. -## AWS.GameLift/ScriptProperties +## Tag ### Properties -* **Arn**: string (ReadOnly): The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift script resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift script ARN, the resource ID matches the Id value. -* **CreationTime**: string (ReadOnly): A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). -* **Id**: string (ReadOnly, Identifier): A unique identifier for the Realtime script -* **Name**: string: A descriptive label that is associated with a script. Script names do not need to be unique. -* **SizeOnDisk**: int (ReadOnly): The file size of the uploaded Realtime script, expressed in bytes. When files are uploaded from an S3 location, this value remains at "0". -* **StorageLocation**: [Script_S3Location](#scripts3location) (Required): The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the "key"), and a role ARN that allows Amazon GameLift to access the Amazon S3 storage location. The S3 bucket must be in the same Region where you want to create a new script. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the ObjectVersion parameter to specify an earlier version. -* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. -* **Version**: string: The version that is associated with a script. Version strings do not need to be unique. +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. -## Script_S3Location +## TargetConfiguration ### Properties -* **Bucket**: string (Required): An Amazon S3 bucket identifier. This is the name of the S3 bucket. -* **Key**: string (Required): The name of the zip file that contains the script files. -* **ObjectVersion**: string: The version of the file, if object versioning is turned on for the bucket. Amazon GameLift uses this information when retrieving files from your S3 bucket. To retrieve a specific version of the file, provide an object version. To retrieve the latest version of the file, do not set this parameter. -* **RoleArn**: string (Required): The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access the S3 bucket. +* **TargetValue**: int (Required): Desired value to use with a target-based scaling policy. The value must be relevant for whatever metric the scaling policy is using. For example, in a policy using the metric PercentAvailableGameSessions, the target value should be the preferred size of the fleet's buffer (the percent of capacity that should be idle and ready for new game sessions). -## Tag +## TargetTrackingConfiguration ### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. +* **TargetValue**: int (Required) diff --git a/artifacts/bicep/aws/aws.globalaccelerator/default/types.json b/artifacts/bicep/aws/aws.globalaccelerator/default/types.json index a17a3154..d5f7cffe 100644 --- a/artifacts/bicep/aws/aws.globalaccelerator/default/types.json +++ b/artifacts/bicep/aws/aws.globalaccelerator/default/types.json @@ -1 +1,611 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"IpAddress"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"Key of the tag. Value can be 1 to 127 characters."},"Value":{"Type":4,"Flags":1,"Description":"Value for the tag. Value can be 1 to 255 characters."}}}},{"2":{"Name":"AWS.GlobalAccelerator/AcceleratorProperties","Properties":{"AcceleratorArn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN) of the accelerator."},"DnsName":{"Type":4,"Flags":2,"Description":"The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IPv4 addresses."},"DualStackDnsName":{"Type":4,"Flags":2,"Description":"The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IPv4 and IPv6 addresses."},"Enabled":{"Type":2,"Flags":0,"Description":"Indicates whether an accelerator is enabled. The value is true or false."},"IpAddressType":{"Type":4,"Flags":0,"Description":"IP Address type."},"IpAddresses":{"Type":11,"Flags":0,"Description":"The IP addresses from BYOIP Prefix pool."},"Ipv4Addresses":{"Type":12,"Flags":2,"Description":"The IPv4 addresses assigned to the accelerator."},"Ipv6Addresses":{"Type":13,"Flags":2,"Description":"The IPv6 addresses assigned if the accelerator is dualstack"},"Name":{"Type":4,"Flags":1,"Description":"Name of accelerator."},"Tags":{"Type":14,"Flags":0}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":9}},{"2":{"Name":"AWS.GlobalAccelerator/Accelerator","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":10,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.GlobalAccelerator/Accelerator@default","ScopeType":0,"Body":15}},{"2":{"Name":"EndpointConfiguration","Properties":{"AttachmentArn":{"Type":4,"Flags":0,"Description":"Attachment ARN that provides access control to the cross account endpoint. Not required for resources hosted in the same account as the endpoint group."},"ClientIPPreservationEnabled":{"Type":2,"Flags":0,"Description":"true if client ip should be preserved"},"EndpointId":{"Type":4,"Flags":1,"Description":"Id of the endpoint. For Network/Application Load Balancer this value is the ARN. For EIP, this value is the allocation ID. For EC2 instances, this is the EC2 instance ID"},"Weight":{"Type":3,"Flags":0,"Description":"The weight for the endpoint."}}}},{"2":{"Name":"Port"}},{"2":{"Name":"PortOverride","Properties":{"EndpointPort":{"Type":3,"Flags":1},"ListenerPort":{"Type":3,"Flags":1}}}},{"2":{"Name":"AWS.GlobalAccelerator/EndpointGroupProperties","Properties":{"EndpointConfigurations":{"Type":21,"Flags":4,"Description":"The list of endpoint objects."},"EndpointGroupArn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN) of the endpoint group"},"EndpointGroupRegion":{"Type":4,"Flags":1,"Description":"The name of the AWS Region where the endpoint group is located"},"HealthCheckIntervalSeconds":{"Type":3,"Flags":0,"Description":"The time in seconds between each health check for an endpoint. Must be a value of 10 or 30"},"HealthCheckPath":{"Type":4,"Flags":0,"Description":""},"HealthCheckPort":{"Type":3,"Flags":0,"Description":"The port that AWS Global Accelerator uses to check the health of endpoints in this endpoint group."},"HealthCheckProtocol":{"Type":4,"Flags":0,"Description":"The protocol that AWS Global Accelerator uses to check the health of endpoints in this endpoint group."},"ListenerArn":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) of the listener"},"PortOverrides":{"Type":22,"Flags":0},"ThresholdCount":{"Type":3,"Flags":0,"Description":"The number of consecutive health checks required to set the state of the endpoint to unhealthy."},"TrafficDialPercentage":{"Type":3,"Flags":0,"Description":"The percentage of traffic to sent to an AWS Region"}}}},{"3":{"ItemType":17}},{"3":{"ItemType":19}},{"2":{"Name":"AWS.GlobalAccelerator/EndpointGroup","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":20,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.GlobalAccelerator/EndpointGroup@default","ScopeType":0,"Body":23}},{"2":{"Name":"Port"}},{"2":{"Name":"PortRange","Properties":{"FromPort":{"Type":3,"Flags":1},"ToPort":{"Type":3,"Flags":1}}}},{"2":{"Name":"AWS.GlobalAccelerator/ListenerProperties","Properties":{"AcceleratorArn":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) of the accelerator."},"ClientAffinity":{"Type":4,"Flags":0,"Description":"Client affinity lets you direct all requests from a user to the same endpoint."},"ListenerArn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN) of the listener."},"PortRanges":{"Type":28,"Flags":1},"Protocol":{"Type":4,"Flags":1,"Description":"The protocol for the listener."}}}},{"3":{"ItemType":26}},{"2":{"Name":"AWS.GlobalAccelerator/Listener","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":27,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.GlobalAccelerator/Listener@default","ScopeType":0,"Body":29}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "IpAddress", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "Key of the tag. Value can be 1 to 127 characters." + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "Value for the tag. Value can be 1 to 255 characters." + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.GlobalAccelerator/AcceleratorProperties" + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "AWS.GlobalAccelerator/AcceleratorProperties", + "properties": { + "AcceleratorArn": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) of the accelerator." + }, + "DnsName": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IPv4 addresses." + }, + "DualStackDnsName": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IPv4 and IPv6 addresses." + }, + "Enabled": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Indicates whether an accelerator is enabled. The value is true or false." + }, + "IpAddressType": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "IP Address type." + }, + "IpAddresses": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The IP addresses from BYOIP Prefix pool." + }, + "Ipv4Addresses": { + "type": { + "$ref": "#/6" + }, + "flags": 2, + "description": "The IPv4 addresses assigned to the accelerator." + }, + "Ipv6Addresses": { + "type": { + "$ref": "#/7" + }, + "flags": 2, + "description": "The IPv6 addresses assigned if the accelerator is dualstack" + }, + "Name": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "Name of accelerator." + }, + "Tags": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.GlobalAccelerator/Accelerator", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/9" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.GlobalAccelerator/Accelerator@default", + "scopeType": 0, + "body": { + "$ref": "#/10" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Resource", + "properties": { + "EndpointId": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Region": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "Key of the tag. Value can be 1 to 127 characters." + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "Value for the tag. Value can be 1 to 255 characters." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.GlobalAccelerator/CrossAccountAttachmentProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/12" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "ObjectType", + "name": "AWS.GlobalAccelerator/CrossAccountAttachmentProperties", + "properties": { + "AttachmentArn": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) of the attachment." + }, + "Name": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The Friendly identifier of the attachment." + }, + "Principals": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "Principals to share the resources with." + }, + "Resources": { + "type": { + "$ref": "#/16" + }, + "flags": 4, + "description": "Resources shared using the attachment." + }, + "Tags": { + "type": { + "$ref": "#/17" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.GlobalAccelerator/CrossAccountAttachment", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/18" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.GlobalAccelerator/CrossAccountAttachment@default", + "scopeType": 0, + "body": { + "$ref": "#/19" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "EndpointConfiguration", + "properties": { + "AttachmentArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "Attachment ARN that provides access control to the cross account endpoint. Not required for resources hosted in the same account as the endpoint group." + }, + "ClientIPPreservationEnabled": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "true if client ip should be preserved" + }, + "EndpointId": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "Id of the endpoint. For Network/Application Load Balancer this value is the ARN. For EIP, this value is the allocation ID. For EC2 instances, this is the EC2 instance ID" + }, + "Weight": { + "type": { + "$ref": "#/24" + }, + "flags": 0, + "description": "The weight for the endpoint." + } + } + }, + { + "$type": "ObjectType", + "name": "Port", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PortOverride", + "properties": { + "EndpointPort": { + "type": { + "$ref": "#/24" + }, + "flags": 1 + }, + "ListenerPort": { + "type": { + "$ref": "#/24" + }, + "flags": 1 + } + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.GlobalAccelerator/EndpointGroupProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/21" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/23" + } + }, + { + "$type": "ObjectType", + "name": "AWS.GlobalAccelerator/EndpointGroupProperties", + "properties": { + "EndpointConfigurations": { + "type": { + "$ref": "#/26" + }, + "flags": 4, + "description": "The list of endpoint objects." + }, + "EndpointGroupArn": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) of the endpoint group" + }, + "EndpointGroupRegion": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The name of the AWS Region where the endpoint group is located" + }, + "HealthCheckIntervalSeconds": { + "type": { + "$ref": "#/24" + }, + "flags": 0, + "description": "The time in seconds between each health check for an endpoint. Must be a value of 10 or 30" + }, + "HealthCheckPath": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "" + }, + "HealthCheckPort": { + "type": { + "$ref": "#/24" + }, + "flags": 0, + "description": "The port that AWS Global Accelerator uses to check the health of endpoints in this endpoint group." + }, + "HealthCheckProtocol": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The protocol that AWS Global Accelerator uses to check the health of endpoints in this endpoint group." + }, + "ListenerArn": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of the listener" + }, + "PortOverrides": { + "type": { + "$ref": "#/27" + }, + "flags": 0 + }, + "ThresholdCount": { + "type": { + "$ref": "#/24" + }, + "flags": 0, + "description": "The number of consecutive health checks required to set the state of the endpoint to unhealthy." + }, + "TrafficDialPercentage": { + "type": { + "$ref": "#/24" + }, + "flags": 0, + "description": "The percentage of traffic to sent to an AWS Region" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.GlobalAccelerator/EndpointGroup", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/28" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.GlobalAccelerator/EndpointGroup@default", + "scopeType": 0, + "body": { + "$ref": "#/29" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Port", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PortRange", + "properties": { + "FromPort": { + "type": { + "$ref": "#/24" + }, + "flags": 1 + }, + "ToPort": { + "type": { + "$ref": "#/24" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.GlobalAccelerator/ListenerProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/32" + } + }, + { + "$type": "ObjectType", + "name": "AWS.GlobalAccelerator/ListenerProperties", + "properties": { + "AcceleratorArn": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of the accelerator." + }, + "ClientAffinity": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "Client affinity lets you direct all requests from a user to the same endpoint." + }, + "ListenerArn": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) of the listener." + }, + "PortRanges": { + "type": { + "$ref": "#/34" + }, + "flags": 1 + }, + "Protocol": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The protocol for the listener." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.GlobalAccelerator/Listener", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/35" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.GlobalAccelerator/Listener@default", + "scopeType": 0, + "body": { + "$ref": "#/36" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.globalaccelerator/default/types.md b/artifacts/bicep/aws/aws.globalaccelerator/default/types.md index 99bee673..a88e9f09 100644 --- a/artifacts/bicep/aws/aws.globalaccelerator/default/types.md +++ b/artifacts/bicep/aws/aws.globalaccelerator/default/types.md @@ -3,23 +3,30 @@ ## Resource AWS.GlobalAccelerator/Accelerator@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.GlobalAccelerator/AcceleratorProperties](#awsglobalacceleratoracceleratorproperties) (Required): properties of the resource +* **properties**: [AWS.GlobalAccelerator/AcceleratorProperties](#awsglobalacceleratoracceleratorproperties) (Required, Identifier): properties of the resource + +## Resource AWS.GlobalAccelerator/CrossAccountAttachment@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.GlobalAccelerator/CrossAccountAttachmentProperties](#awsglobalacceleratorcrossaccountattachmentproperties) (Required, Identifier): properties of the resource ## Resource AWS.GlobalAccelerator/EndpointGroup@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.GlobalAccelerator/EndpointGroupProperties](#awsglobalacceleratorendpointgroupproperties) (Required): properties of the resource +* **properties**: [AWS.GlobalAccelerator/EndpointGroupProperties](#awsglobalacceleratorendpointgroupproperties) (Required, Identifier): properties of the resource ## Resource AWS.GlobalAccelerator/Listener@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.GlobalAccelerator/ListenerProperties](#awsglobalacceleratorlistenerproperties) (Required): properties of the resource +* **properties**: [AWS.GlobalAccelerator/ListenerProperties](#awsglobalacceleratorlistenerproperties) (Required, Identifier): properties of the resource ## AWS.GlobalAccelerator/AcceleratorProperties ### Properties @@ -34,10 +41,13 @@ * **Name**: string (Required): Name of accelerator. * **Tags**: [Tag](#tag)[] -## Tag +## AWS.GlobalAccelerator/CrossAccountAttachmentProperties ### Properties -* **Key**: string (Required): Key of the tag. Value can be 1 to 127 characters. -* **Value**: string (Required): Value for the tag. Value can be 1 to 255 characters. +* **AttachmentArn**: string (ReadOnly, Identifier): The Amazon Resource Name (ARN) of the attachment. +* **Name**: string (Required): The Friendly identifier of the attachment. +* **Principals**: string[]: Principals to share the resources with. +* **Resources**: [Resource](#resource)[] (WriteOnly): Resources shared using the attachment. +* **Tags**: [Tag](#tag)[] ## AWS.GlobalAccelerator/EndpointGroupProperties ### Properties @@ -53,6 +63,14 @@ * **ThresholdCount**: int: The number of consecutive health checks required to set the state of the endpoint to unhealthy. * **TrafficDialPercentage**: int: The percentage of traffic to sent to an AWS Region +## AWS.GlobalAccelerator/ListenerProperties +### Properties +* **AcceleratorArn**: string (Required): The Amazon Resource Name (ARN) of the accelerator. +* **ClientAffinity**: string: Client affinity lets you direct all requests from a user to the same endpoint. +* **ListenerArn**: string (ReadOnly, Identifier): The Amazon Resource Name (ARN) of the listener. +* **PortRanges**: [PortRange](#portrange)[] (Required) +* **Protocol**: string (Required): The protocol for the listener. + ## EndpointConfiguration ### Properties * **AttachmentArn**: string: Attachment ARN that provides access control to the cross account endpoint. Not required for resources hosted in the same account as the endpoint group. @@ -65,16 +83,23 @@ * **EndpointPort**: int (Required) * **ListenerPort**: int (Required) -## AWS.GlobalAccelerator/ListenerProperties -### Properties -* **AcceleratorArn**: string (Required): The Amazon Resource Name (ARN) of the accelerator. -* **ClientAffinity**: string: Client affinity lets you direct all requests from a user to the same endpoint. -* **ListenerArn**: string (ReadOnly, Identifier): The Amazon Resource Name (ARN) of the listener. -* **PortRanges**: [PortRange](#portrange)[] (Required) -* **Protocol**: string (Required): The protocol for the listener. - ## PortRange ### Properties * **FromPort**: int (Required) * **ToPort**: int (Required) +## Resource +### Properties +* **EndpointId**: string (Required) +* **Region**: string + +## Tag +### Properties +* **Key**: string (Required): Key of the tag. Value can be 1 to 127 characters. +* **Value**: string (Required): Value for the tag. Value can be 1 to 255 characters. + +## Tag +### Properties +* **Key**: string (Required): Key of the tag. Value can be 1 to 127 characters. +* **Value**: string (Required): Value for the tag. Value can be 1 to 255 characters. + diff --git a/artifacts/bicep/aws/aws.glue/default/types.json b/artifacts/bicep/aws/aws.glue/default/types.json index bbdfe15b..49be04a2 100644 --- a/artifacts/bicep/aws/aws.glue/default/types.json +++ b/artifacts/bicep/aws/aws.glue/default/types.json @@ -1 +1,291 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"A key to identify the tag."},"Value":{"Type":4,"Flags":1,"Description":"Corresponding tag value for the key."}}}},{"2":{"Name":"AWS.Glue/RegistryProperties","Properties":{"Arn":{"Type":4,"Flags":18,"Description":"Amazon Resource Name for the created Registry."},"Description":{"Type":4,"Flags":0,"Description":"A description of the registry. If description is not provided, there will not be any default value for this."},"Name":{"Type":4,"Flags":1,"Description":"Name of the registry to be created of max length of 255, and may only contain letters, numbers, hyphen, underscore, dollar sign, or hash mark. No whitespace."},"Tags":{"Type":10,"Flags":0,"Description":"List of tags to tag the Registry"}}}},{"3":{"ItemType":8}},{"2":{"Name":"AWS.Glue/Registry","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":9,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Glue/Registry@default","ScopeType":0,"Body":11}},{"2":{"Name":"Registry","Properties":{"Arn":{"Type":4,"Flags":16,"Description":"Amazon Resource Name for the Registry."},"Name":{"Type":4,"Flags":0,"Description":"Name of the registry in which the schema will be created."}}}},{"2":{"Name":"SchemaVersion","Properties":{"IsLatest":{"Type":2,"Flags":0,"Description":"Indicates if the latest version needs to be updated."},"VersionNumber":{"Type":3,"Flags":0,"Description":"Indicates the version number in the schema to update."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"A key to identify the tag."},"Value":{"Type":4,"Flags":1,"Description":"Corresponding tag value for the key."}}}},{"2":{"Name":"AWS.Glue/SchemaProperties","Properties":{"Arn":{"Type":4,"Flags":18,"Description":"Amazon Resource Name for the Schema."},"CheckpointVersion":{"Type":14,"Flags":0},"Compatibility":{"Type":4,"Flags":1,"Description":"Compatibility setting for the schema."},"DataFormat":{"Type":4,"Flags":1,"Description":"Data format name to use for the schema. Accepted values: 'AVRO', 'JSON', 'PROTOBUF'"},"Description":{"Type":4,"Flags":0,"Description":"A description of the schema. If description is not provided, there will not be any default value for this."},"InitialSchemaVersionId":{"Type":4,"Flags":2,"Description":"Represents the version ID associated with the initial schema version."},"Name":{"Type":4,"Flags":1,"Description":"Name of the schema."},"Registry":{"Type":13,"Flags":0},"SchemaDefinition":{"Type":4,"Flags":5,"Description":"Definition for the initial schema version in plain-text."},"Tags":{"Type":17,"Flags":0,"Description":"List of tags to tag the schema"}}}},{"3":{"ItemType":15}},{"2":{"Name":"AWS.Glue/Schema","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":16,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Glue/Schema@default","ScopeType":0,"Body":18}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "A key to identify the tag." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Corresponding tag value for the key." + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.Glue/RegistryProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Glue/RegistryProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "Amazon Resource Name for the created Registry." + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A description of the registry. If description is not provided, there will not be any default value for this." + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Name of the registry to be created of max length of 255, and may only contain letters, numbers, hyphen, underscore, dollar sign, or hash mark. No whitespace." + }, + "Tags": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "List of tags to tag the Registry" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Glue/Registry", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Glue/Registry@default", + "scopeType": 0, + "body": { + "$ref": "#/5" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Registry", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 16, + "description": "Amazon Resource Name for the Registry." + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Name of the registry in which the schema will be created." + } + } + }, + { + "$type": "ObjectType", + "name": "SchemaVersion", + "properties": { + "IsLatest": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "Indicates if the latest version needs to be updated." + }, + "VersionNumber": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "Indicates the version number in the schema to update." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "A key to identify the tag." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Corresponding tag value for the key." + } + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "IntegerType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.Glue/SchemaProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/9" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Glue/SchemaProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "Amazon Resource Name for the Schema." + }, + "CheckpointVersion": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "Compatibility": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Compatibility setting for the schema." + }, + "DataFormat": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Data format name to use for the schema. Accepted values: 'AVRO', 'JSON', 'PROTOBUF'" + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A description of the schema. If description is not provided, there will not be any default value for this." + }, + "InitialSchemaVersionId": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "Represents the version ID associated with the initial schema version." + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Name of the schema." + }, + "Registry": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "SchemaDefinition": { + "type": { + "$ref": "#/1" + }, + "flags": 5, + "description": "Definition for the initial schema version in plain-text." + }, + "Tags": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "List of tags to tag the schema" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Glue/Schema", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/14" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Glue/Schema@default", + "scopeType": 0, + "body": { + "$ref": "#/15" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.glue/default/types.md b/artifacts/bicep/aws/aws.glue/default/types.md index 76743600..f1b6e729 100644 --- a/artifacts/bicep/aws/aws.glue/default/types.md +++ b/artifacts/bicep/aws/aws.glue/default/types.md @@ -3,16 +3,16 @@ ## Resource AWS.Glue/Registry@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Glue/RegistryProperties](#awsglueregistryproperties) (Required): properties of the resource +* **properties**: [AWS.Glue/RegistryProperties](#awsglueregistryproperties) (Required, Identifier): properties of the resource ## Resource AWS.Glue/Schema@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Glue/SchemaProperties](#awsglueschemaproperties) (Required): properties of the resource +* **properties**: [AWS.Glue/SchemaProperties](#awsglueschemaproperties) (Required, Identifier): properties of the resource ## AWS.Glue/RegistryProperties ### Properties @@ -21,11 +21,6 @@ * **Name**: string (Required): Name of the registry to be created of max length of 255, and may only contain letters, numbers, hyphen, underscore, dollar sign, or hash mark. No whitespace. * **Tags**: [Tag](#tag)[]: List of tags to tag the Registry -## Tag -### Properties -* **Key**: string (Required): A key to identify the tag. -* **Value**: string (Required): Corresponding tag value for the key. - ## AWS.Glue/SchemaProperties ### Properties * **Arn**: string (ReadOnly, Identifier): Amazon Resource Name for the Schema. @@ -39,15 +34,20 @@ * **SchemaDefinition**: string (Required, WriteOnly): Definition for the initial schema version in plain-text. * **Tags**: [Tag](#tag)[]: List of tags to tag the schema +## Registry +### Properties +* **Arn**: string (Identifier): Amazon Resource Name for the Registry. +* **Name**: string: Name of the registry in which the schema will be created. + ## SchemaVersion ### Properties * **IsLatest**: bool: Indicates if the latest version needs to be updated. * **VersionNumber**: int: Indicates the version number in the schema to update. -## Registry +## Tag ### Properties -* **Arn**: string (Identifier): Amazon Resource Name for the Registry. -* **Name**: string: Name of the registry in which the schema will be created. +* **Key**: string (Required): A key to identify the tag. +* **Value**: string (Required): Corresponding tag value for the key. ## Tag ### Properties diff --git a/artifacts/bicep/aws/aws.grafana/default/types.json b/artifacts/bicep/aws/aws.grafana/default/types.json index 3b02de5a..29fd220c 100644 --- a/artifacts/bicep/aws/aws.grafana/default/types.json +++ b/artifacts/bicep/aws/aws.grafana/default/types.json @@ -1 +1,485 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"AccountAccessType"}},{"2":{"Name":"AssertionAttributes","Properties":{"Email":{"Type":4,"Flags":0,"Description":"Name of the attribute within the SAML assert to use as the users email in Grafana."},"Groups":{"Type":4,"Flags":0,"Description":"Name of the attribute within the SAML assert to use as the users groups in Grafana."},"Login":{"Type":4,"Flags":0,"Description":"Name of the attribute within the SAML assert to use as the users login handle in Grafana."},"Name":{"Type":4,"Flags":0,"Description":"Name of the attribute within the SAML assert to use as the users name in Grafana."},"Org":{"Type":4,"Flags":0,"Description":"Name of the attribute within the SAML assert to use as the users organizations in Grafana."},"Role":{"Type":4,"Flags":0,"Description":"Name of the attribute within the SAML assert to use as the users roles in Grafana."}}}},{"2":{"Name":"AuthenticationProviderTypes"}},{"2":{"Name":"DataSourceType"}},{"2":{"Name":"IdpMetadata","Properties":{"Url":{"Type":4,"Flags":0,"Description":"URL that vends the IdPs metadata."},"Xml":{"Type":4,"Flags":0,"Description":"XML blob of the IdPs metadata."}}}},{"2":{"Name":"NetworkAccessControl","Properties":{"PrefixListIds":{"Type":21,"Flags":0,"Description":"The list of prefix list IDs. A prefix list is a list of CIDR ranges of IP addresses. The IP addresses specified are allowed to access your workspace. If the list is not included in the configuration then no IP addresses will be allowed to access the workspace."},"VpceIds":{"Type":22,"Flags":0,"Description":"The list of Amazon VPC endpoint IDs for the workspace. If a NetworkAccessConfiguration is specified then only VPC endpoints specified here will be allowed to access the workspace."}}}},{"2":{"Name":"NotificationDestinationType"}},{"2":{"Name":"PermissionType"}},{"2":{"Name":"RoleValues","Properties":{"Admin":{"Type":23,"Flags":0,"Description":"List of SAML roles which will be mapped into the Grafana Admin role."},"Editor":{"Type":24,"Flags":0,"Description":"List of SAML roles which will be mapped into the Grafana Editor role."}}}},{"2":{"Name":"SamlConfiguration","Properties":{"AllowedOrganizations":{"Type":25,"Flags":0,"Description":"List of SAML organizations allowed to access Grafana."},"AssertionAttributes":{"Type":9,"Flags":0},"IdpMetadata":{"Type":12,"Flags":1},"LoginValidityDuration":{"Type":3,"Flags":0,"Description":"The maximum lifetime an authenticated user can be logged in (in minutes) before being required to re-authenticate."},"RoleValues":{"Type":16,"Flags":0}}}},{"2":{"Name":"SamlConfigurationStatus"}},{"2":{"Name":"VpcConfiguration","Properties":{"SecurityGroupIds":{"Type":26,"Flags":1,"Description":"The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect."},"SubnetIds":{"Type":27,"Flags":1,"Description":"The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect."}}}},{"2":{"Name":"WorkspaceStatus"}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.Grafana/WorkspaceProperties","Properties":{"AccountAccessType":{"Type":4,"Flags":1},"AuthenticationProviders":{"Type":29,"Flags":1,"Description":"List of authentication providers to enable."},"ClientToken":{"Type":4,"Flags":4,"Description":"A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request."},"CreationTimestamp":{"Type":4,"Flags":2,"Description":"Timestamp when the workspace was created."},"DataSources":{"Type":30,"Flags":0,"Description":"List of data sources on the service managed IAM role."},"Description":{"Type":4,"Flags":0,"Description":"Description of a workspace."},"Endpoint":{"Type":4,"Flags":2,"Description":"Endpoint for the Grafana workspace."},"GrafanaVersion":{"Type":4,"Flags":0,"Description":"The version of Grafana to support in your workspace."},"Id":{"Type":4,"Flags":18,"Description":"The id that uniquely identifies a Grafana workspace."},"ModificationTimestamp":{"Type":4,"Flags":2,"Description":"Timestamp when the workspace was last modified"},"Name":{"Type":4,"Flags":0,"Description":"The user friendly name of a workspace."},"NetworkAccessControl":{"Type":13,"Flags":0},"NotificationDestinations":{"Type":31,"Flags":0,"Description":"List of notification destinations on the customers service managed IAM role that the Grafana workspace can query."},"OrganizationRoleName":{"Type":4,"Flags":0,"Description":"The name of an IAM role that already exists to use with AWS Organizations to access AWS data sources and notification channels in other accounts in an organization."},"OrganizationalUnits":{"Type":32,"Flags":0,"Description":"List of Organizational Units containing AWS accounts the Grafana workspace can pull data from."},"PermissionType":{"Type":4,"Flags":1},"PluginAdminEnabled":{"Type":2,"Flags":0,"Description":"Allow workspace admins to install plugins"},"RoleArn":{"Type":4,"Flags":0,"Description":"IAM Role that will be used to grant the Grafana workspace access to a customers AWS resources."},"SamlConfiguration":{"Type":17,"Flags":0},"SamlConfigurationStatus":{"Type":4,"Flags":2},"SsoClientId":{"Type":4,"Flags":2,"Description":"The client ID of the AWS SSO Managed Application."},"StackSetName":{"Type":4,"Flags":0,"Description":"The name of the AWS CloudFormation stack set to use to generate IAM roles to be used for this workspace."},"Status":{"Type":4,"Flags":2},"VpcConfiguration":{"Type":19,"Flags":0}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.Grafana/Workspace","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":28,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Grafana/Workspace@default","ScopeType":0,"Body":33}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "AccountAccessType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AssertionAttributes", + "properties": { + "Email": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "Name of the attribute within the SAML assert to use as the users email in Grafana." + }, + "Groups": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "Name of the attribute within the SAML assert to use as the users groups in Grafana." + }, + "Login": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "Name of the attribute within the SAML assert to use as the users login handle in Grafana." + }, + "Name": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "Name of the attribute within the SAML assert to use as the users name in Grafana." + }, + "Org": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "Name of the attribute within the SAML assert to use as the users organizations in Grafana." + }, + "Role": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "Name of the attribute within the SAML assert to use as the users roles in Grafana." + } + } + }, + { + "$type": "ObjectType", + "name": "AuthenticationProviderTypes", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DataSourceType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "IdpMetadata", + "properties": { + "Url": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "URL that vends the IdPs metadata." + }, + "Xml": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "XML blob of the IdPs metadata." + } + } + }, + { + "$type": "ObjectType", + "name": "NetworkAccessControl", + "properties": { + "PrefixListIds": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The list of prefix list IDs. A prefix list is a list of CIDR ranges of IP addresses. The IP addresses specified are allowed to access your workspace. If the list is not included in the configuration then no IP addresses will be allowed to access the workspace." + }, + "VpceIds": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "The list of Amazon VPC endpoint IDs for the workspace. If a NetworkAccessConfiguration is specified then only VPC endpoints specified here will be allowed to access the workspace." + } + } + }, + { + "$type": "ObjectType", + "name": "NotificationDestinationType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PermissionType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RoleValues", + "properties": { + "Admin": { + "type": { + "$ref": "#/16" + }, + "flags": 0, + "description": "List of SAML roles which will be mapped into the Grafana Admin role." + }, + "Editor": { + "type": { + "$ref": "#/17" + }, + "flags": 0, + "description": "List of SAML roles which will be mapped into the Grafana Editor role." + } + } + }, + { + "$type": "ObjectType", + "name": "SamlConfiguration", + "properties": { + "AllowedOrganizations": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "List of SAML organizations allowed to access Grafana." + }, + "AssertionAttributes": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "IdpMetadata": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + }, + "LoginValidityDuration": { + "type": { + "$ref": "#/19" + }, + "flags": 0, + "description": "The maximum lifetime an authenticated user can be logged in (in minutes) before being required to re-authenticate." + }, + "RoleValues": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SamlConfigurationStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "VpcConfiguration", + "properties": { + "SecurityGroupIds": { + "type": { + "$ref": "#/20" + }, + "flags": 1, + "description": "The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect." + }, + "SubnetIds": { + "type": { + "$ref": "#/21" + }, + "flags": 1, + "description": "The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect." + } + } + }, + { + "$type": "ObjectType", + "name": "WorkspaceStatus", + "properties": {} + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Grafana/WorkspaceProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "ObjectType", + "name": "AWS.Grafana/WorkspaceProperties", + "properties": { + "AccountAccessType": { + "type": { + "$ref": "#/13" + }, + "flags": 1 + }, + "AuthenticationProviders": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "List of authentication providers to enable." + }, + "ClientToken": { + "type": { + "$ref": "#/13" + }, + "flags": 4, + "description": "A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request." + }, + "CreationTimestamp": { + "type": { + "$ref": "#/13" + }, + "flags": 2, + "description": "Timestamp when the workspace was created." + }, + "DataSources": { + "type": { + "$ref": "#/24" + }, + "flags": 0, + "description": "List of data sources on the service managed IAM role." + }, + "Description": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "Description of a workspace." + }, + "Endpoint": { + "type": { + "$ref": "#/13" + }, + "flags": 2, + "description": "Endpoint for the Grafana workspace." + }, + "GrafanaVersion": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "The version of Grafana to support in your workspace." + }, + "Id": { + "type": { + "$ref": "#/13" + }, + "flags": 18, + "description": "The id that uniquely identifies a Grafana workspace." + }, + "ModificationTimestamp": { + "type": { + "$ref": "#/13" + }, + "flags": 2, + "description": "Timestamp when the workspace was last modified" + }, + "Name": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "The user friendly name of a workspace." + }, + "NetworkAccessControl": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "NotificationDestinations": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "List of notification destinations on the customers service managed IAM role that the Grafana workspace can query." + }, + "OrganizationRoleName": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "The name of an IAM role that already exists to use with AWS Organizations to access AWS data sources and notification channels in other accounts in an organization." + }, + "OrganizationalUnits": { + "type": { + "$ref": "#/26" + }, + "flags": 0, + "description": "List of Organizational Units containing AWS accounts the Grafana workspace can pull data from." + }, + "PermissionType": { + "type": { + "$ref": "#/13" + }, + "flags": 1 + }, + "PluginAdminEnabled": { + "type": { + "$ref": "#/27" + }, + "flags": 0, + "description": "Allow workspace admins to install plugins" + }, + "RoleArn": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "IAM Role that will be used to grant the Grafana workspace access to a customers AWS resources." + }, + "SamlConfiguration": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "SamlConfigurationStatus": { + "type": { + "$ref": "#/13" + }, + "flags": 2 + }, + "SsoClientId": { + "type": { + "$ref": "#/13" + }, + "flags": 2, + "description": "The client ID of the AWS SSO Managed Application." + }, + "StackSetName": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "The name of the AWS CloudFormation stack set to use to generate IAM roles to be used for this workspace." + }, + "Status": { + "type": { + "$ref": "#/13" + }, + "flags": 2 + }, + "VpcConfiguration": { + "type": { + "$ref": "#/11" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Grafana/Workspace", + "properties": { + "name": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/13" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/28" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Grafana/Workspace@default", + "scopeType": 0, + "body": { + "$ref": "#/29" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.grafana/default/types.md b/artifacts/bicep/aws/aws.grafana/default/types.md index c2076c53..43fcb3db 100644 --- a/artifacts/bicep/aws/aws.grafana/default/types.md +++ b/artifacts/bicep/aws/aws.grafana/default/types.md @@ -3,9 +3,18 @@ ## Resource AWS.Grafana/Workspace@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Grafana/WorkspaceProperties](#awsgrafanaworkspaceproperties) (Required): properties of the resource +* **properties**: [AWS.Grafana/WorkspaceProperties](#awsgrafanaworkspaceproperties) (Required, Identifier): properties of the resource + +## AssertionAttributes +### Properties +* **Email**: string: Name of the attribute within the SAML assert to use as the users email in Grafana. +* **Groups**: string: Name of the attribute within the SAML assert to use as the users groups in Grafana. +* **Login**: string: Name of the attribute within the SAML assert to use as the users login handle in Grafana. +* **Name**: string: Name of the attribute within the SAML assert to use as the users name in Grafana. +* **Org**: string: Name of the attribute within the SAML assert to use as the users organizations in Grafana. +* **Role**: string: Name of the attribute within the SAML assert to use as the users roles in Grafana. ## AWS.Grafana/WorkspaceProperties ### Properties @@ -34,11 +43,21 @@ * **Status**: string (ReadOnly) * **VpcConfiguration**: [VpcConfiguration](#vpcconfiguration) +## IdpMetadata +### Properties +* **Url**: string: URL that vends the IdPs metadata. +* **Xml**: string: XML blob of the IdPs metadata. + ## NetworkAccessControl ### Properties * **PrefixListIds**: string[]: The list of prefix list IDs. A prefix list is a list of CIDR ranges of IP addresses. The IP addresses specified are allowed to access your workspace. If the list is not included in the configuration then no IP addresses will be allowed to access the workspace. * **VpceIds**: string[]: The list of Amazon VPC endpoint IDs for the workspace. If a NetworkAccessConfiguration is specified then only VPC endpoints specified here will be allowed to access the workspace. +## RoleValues +### Properties +* **Admin**: string[]: List of SAML roles which will be mapped into the Grafana Admin role. +* **Editor**: string[]: List of SAML roles which will be mapped into the Grafana Editor role. + ## SamlConfiguration ### Properties * **AllowedOrganizations**: string[]: List of SAML organizations allowed to access Grafana. @@ -47,25 +66,6 @@ * **LoginValidityDuration**: int: The maximum lifetime an authenticated user can be logged in (in minutes) before being required to re-authenticate. * **RoleValues**: [RoleValues](#rolevalues) -## AssertionAttributes -### Properties -* **Email**: string: Name of the attribute within the SAML assert to use as the users email in Grafana. -* **Groups**: string: Name of the attribute within the SAML assert to use as the users groups in Grafana. -* **Login**: string: Name of the attribute within the SAML assert to use as the users login handle in Grafana. -* **Name**: string: Name of the attribute within the SAML assert to use as the users name in Grafana. -* **Org**: string: Name of the attribute within the SAML assert to use as the users organizations in Grafana. -* **Role**: string: Name of the attribute within the SAML assert to use as the users roles in Grafana. - -## IdpMetadata -### Properties -* **Url**: string: URL that vends the IdPs metadata. -* **Xml**: string: XML blob of the IdPs metadata. - -## RoleValues -### Properties -* **Admin**: string[]: List of SAML roles which will be mapped into the Grafana Admin role. -* **Editor**: string[]: List of SAML roles which will be mapped into the Grafana Editor role. - ## VpcConfiguration ### Properties * **SecurityGroupIds**: string[] (Required): The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect. diff --git a/artifacts/bicep/aws/aws.greengrassv2/default/types.json b/artifacts/bicep/aws/aws.greengrassv2/default/types.json index 26f4e354..52ba95a0 100644 --- a/artifacts/bicep/aws/aws.greengrassv2/default/types.json +++ b/artifacts/bicep/aws/aws.greengrassv2/default/types.json @@ -1 +1,825 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"ComponentDependencyRequirement","Properties":{"DependencyType":{"Type":4,"Flags":0},"VersionRequirement":{"Type":4,"Flags":0}}}},{"2":{"Name":"ComponentPlatform","Properties":{"Attributes":{"Type":20,"Flags":0},"Name":{"Type":4,"Flags":0}}}},{"2":{"Name":"FilesystemPath"}},{"2":{"Name":"LambdaAddGroupOwnerBoolean"}},{"2":{"Name":"LambdaContainerParams","Properties":{"Devices":{"Type":21,"Flags":0},"MemorySizeInKB":{"Type":3,"Flags":0},"MountROSysfs":{"Type":2,"Flags":0},"Volumes":{"Type":22,"Flags":0}}}},{"2":{"Name":"LambdaDeviceMount","Properties":{"AddGroupOwner":{"Type":2,"Flags":0},"Path":{"Type":4,"Flags":0},"Permission":{"Type":4,"Flags":0}}}},{"2":{"Name":"LambdaEventSource","Properties":{"Topic":{"Type":4,"Flags":0},"Type":{"Type":4,"Flags":0}}}},{"2":{"Name":"LambdaExecutionParameters","Properties":{"EnvironmentVariables":{"Type":23,"Flags":0},"EventSources":{"Type":24,"Flags":0},"ExecArgs":{"Type":25,"Flags":0},"InputPayloadEncodingType":{"Type":4,"Flags":0},"LinuxProcessParams":{"Type":18,"Flags":0},"MaxIdleTimeInSeconds":{"Type":3,"Flags":0},"MaxInstancesCount":{"Type":3,"Flags":0},"MaxQueueSize":{"Type":3,"Flags":0},"Pinned":{"Type":2,"Flags":0},"StatusTimeoutInSeconds":{"Type":3,"Flags":0},"TimeoutInSeconds":{"Type":3,"Flags":0}}}},{"2":{"Name":"LambdaFilesystemPermission"}},{"2":{"Name":"LambdaFunctionRecipeSource","Properties":{"ComponentDependencies":{"Type":26,"Flags":0},"ComponentLambdaParameters":{"Type":15,"Flags":0},"ComponentName":{"Type":4,"Flags":0},"ComponentPlatforms":{"Type":27,"Flags":0},"ComponentVersion":{"Type":4,"Flags":0},"LambdaArn":{"Type":4,"Flags":0}}}},{"2":{"Name":"LambdaLinuxProcessParams","Properties":{"ContainerParams":{"Type":12,"Flags":0},"IsolationMode":{"Type":4,"Flags":0}}}},{"2":{"Name":"LambdaVolumeMount","Properties":{"AddGroupOwner":{"Type":2,"Flags":0},"DestinationPath":{"Type":4,"Flags":0},"Permission":{"Type":4,"Flags":0},"SourcePath":{"Type":4,"Flags":0}}}},{"2":{"Name":"ComponentVersion_Attributes","Properties":{}}},{"3":{"ItemType":13}},{"3":{"ItemType":19}},{"2":{"Name":"ComponentVersion_EnvironmentVariables","Properties":{}}},{"3":{"ItemType":14}},{"3":{"ItemType":4}},{"2":{"Name":"ComponentVersion_ComponentDependencies","Properties":{}}},{"3":{"ItemType":9}},{"2":{"Name":"AWS.GreengrassV2/ComponentVersionProperties","Properties":{"Arn":{"Type":4,"Flags":18},"ComponentName":{"Type":4,"Flags":2},"ComponentVersion":{"Type":4,"Flags":2},"InlineRecipe":{"Type":4,"Flags":4},"LambdaFunction":{"Type":17,"Flags":4},"Tags":{"Type":29,"Flags":0}}}},{"2":{"Name":"ComponentVersion_Tags","Properties":{}}},{"2":{"Name":"AWS.GreengrassV2/ComponentVersion","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":28,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.GreengrassV2/ComponentVersion@default","ScopeType":0,"Body":30}},{"2":{"Name":"ComponentConfigurationUpdate","Properties":{"Merge":{"Type":4,"Flags":0},"Reset":{"Type":47,"Flags":0}}}},{"2":{"Name":"ComponentDeploymentSpecification","Properties":{"ComponentVersion":{"Type":4,"Flags":0},"ConfigurationUpdate":{"Type":32,"Flags":0},"RunWith":{"Type":34,"Flags":0}}}},{"2":{"Name":"ComponentRunWith","Properties":{"PosixUser":{"Type":4,"Flags":0},"SystemResourceLimits":{"Type":46,"Flags":0},"WindowsUser":{"Type":4,"Flags":0}}}},{"2":{"Name":"DeploymentComponentUpdatePolicy","Properties":{"Action":{"Type":4,"Flags":0},"TimeoutInSeconds":{"Type":3,"Flags":0}}}},{"2":{"Name":"DeploymentConfigurationValidationPolicy","Properties":{"TimeoutInSeconds":{"Type":3,"Flags":0}}}},{"2":{"Name":"DeploymentIoTJobConfiguration","Properties":{"AbortConfig":{"Type":39,"Flags":0},"JobExecutionsRolloutConfig":{"Type":41,"Flags":0},"TimeoutConfig":{"Type":44,"Flags":0}}}},{"2":{"Name":"DeploymentPolicies","Properties":{"ComponentUpdatePolicy":{"Type":35,"Flags":0},"ConfigurationValidationPolicy":{"Type":36,"Flags":0},"FailureHandlingPolicy":{"Type":4,"Flags":0}}}},{"2":{"Name":"IoTJobAbortConfig","Properties":{"CriteriaList":{"Type":48,"Flags":1}}}},{"2":{"Name":"IoTJobAbortCriteria","Properties":{"Action":{"Type":4,"Flags":1},"FailureType":{"Type":4,"Flags":1},"MinNumberOfExecutedThings":{"Type":3,"Flags":1},"ThresholdPercentage":{"Type":3,"Flags":1}}}},{"2":{"Name":"IoTJobExecutionsRolloutConfig","Properties":{"ExponentialRate":{"Type":42,"Flags":0},"MaximumPerMinute":{"Type":3,"Flags":0}}}},{"2":{"Name":"IoTJobExponentialRolloutRate","Properties":{"BaseRatePerMinute":{"Type":3,"Flags":1},"IncrementFactor":{"Type":3,"Flags":1},"RateIncreaseCriteria":{"Type":43,"Flags":1}}}},{"2":{"Name":"IoTJobRateIncreaseCriteria","Properties":{"NumberOfNotifiedThings":{"Type":3,"Flags":0},"NumberOfSucceededThings":{"Type":3,"Flags":0}}}},{"2":{"Name":"IoTJobTimeoutConfig","Properties":{"InProgressTimeoutInMinutes":{"Type":3,"Flags":0}}}},{"2":{"Name":"NumberOfThings"}},{"2":{"Name":"SystemResourceLimits","Properties":{"Cpus":{"Type":3,"Flags":0},"Memory":{"Type":3,"Flags":0}}}},{"3":{"ItemType":4}},{"3":{"ItemType":40}},{"2":{"Name":"AWS.GreengrassV2/DeploymentProperties","Properties":{"Components":{"Type":50,"Flags":0},"DeploymentId":{"Type":4,"Flags":18},"DeploymentName":{"Type":4,"Flags":0},"DeploymentPolicies":{"Type":38,"Flags":0},"IotJobConfiguration":{"Type":37,"Flags":0},"ParentTargetArn":{"Type":4,"Flags":0},"Tags":{"Type":51,"Flags":0},"TargetArn":{"Type":4,"Flags":1}}}},{"2":{"Name":"Deployment_Components","Properties":{}}},{"2":{"Name":"Deployment_Tags","Properties":{}}},{"2":{"Name":"AWS.GreengrassV2/Deployment","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":49,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.GreengrassV2/Deployment@default","ScopeType":0,"Body":52}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "ComponentDependencyRequirement", + "properties": { + "DependencyType": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + }, + "VersionRequirement": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ComponentPlatform", + "properties": { + "Attributes": { + "type": { + "$ref": "#/13" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FilesystemPath", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LambdaAddGroupOwnerBoolean", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LambdaContainerParams", + "properties": { + "Devices": { + "type": { + "$ref": "#/15" + }, + "flags": 0 + }, + "MemorySizeInKB": { + "type": { + "$ref": "#/16" + }, + "flags": 0 + }, + "MountROSysfs": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + }, + "Volumes": { + "type": { + "$ref": "#/17" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "LambdaDeviceMount", + "properties": { + "AddGroupOwner": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + }, + "Path": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + }, + "Permission": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "LambdaEventSource", + "properties": { + "Topic": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "LambdaExecutionParameters", + "properties": { + "EnvironmentVariables": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "EventSources": { + "type": { + "$ref": "#/19" + }, + "flags": 0 + }, + "ExecArgs": { + "type": { + "$ref": "#/20" + }, + "flags": 0 + }, + "InputPayloadEncodingType": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + }, + "LinuxProcessParams": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "MaxIdleTimeInSeconds": { + "type": { + "$ref": "#/16" + }, + "flags": 0 + }, + "MaxInstancesCount": { + "type": { + "$ref": "#/16" + }, + "flags": 0 + }, + "MaxQueueSize": { + "type": { + "$ref": "#/16" + }, + "flags": 0 + }, + "Pinned": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + }, + "StatusTimeoutInSeconds": { + "type": { + "$ref": "#/16" + }, + "flags": 0 + }, + "TimeoutInSeconds": { + "type": { + "$ref": "#/16" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "LambdaFilesystemPermission", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LambdaFunctionRecipeSource", + "properties": { + "ComponentDependencies": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "ComponentLambdaParameters": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "ComponentName": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + }, + "ComponentPlatforms": { + "type": { + "$ref": "#/22" + }, + "flags": 0 + }, + "ComponentVersion": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + }, + "LambdaArn": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "LambdaLinuxProcessParams", + "properties": { + "ContainerParams": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "IsolationMode": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "LambdaVolumeMount", + "properties": { + "AddGroupOwner": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + }, + "DestinationPath": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + }, + "Permission": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + }, + "SourcePath": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "ObjectType", + "name": "ComponentVersion_Attributes", + "properties": {} + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/11" + } + }, + { + "$type": "ObjectType", + "name": "ComponentVersion_EnvironmentVariables", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/12" + } + }, + { + "$type": "ObjectType", + "name": "ComponentVersion_ComponentDependencies", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.GreengrassV2/ComponentVersionProperties" + }, + { + "$type": "ObjectType", + "name": "ComponentVersion_Tags", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AWS.GreengrassV2/ComponentVersionProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/12" + }, + "flags": 18 + }, + "ComponentName": { + "type": { + "$ref": "#/12" + }, + "flags": 2 + }, + "ComponentVersion": { + "type": { + "$ref": "#/12" + }, + "flags": 2 + }, + "InlineRecipe": { + "type": { + "$ref": "#/12" + }, + "flags": 4 + }, + "LambdaFunction": { + "type": { + "$ref": "#/9" + }, + "flags": 4 + }, + "Tags": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.GreengrassV2/ComponentVersion", + "properties": { + "name": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/12" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/25" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.GreengrassV2/ComponentVersion@default", + "scopeType": 0, + "body": { + "$ref": "#/26" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "ComponentConfigurationUpdate", + "properties": { + "Merge": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + }, + "Reset": { + "type": { + "$ref": "#/43" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ComponentDeploymentSpecification", + "properties": { + "ComponentVersion": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + }, + "ConfigurationUpdate": { + "type": { + "$ref": "#/28" + }, + "flags": 0 + }, + "RunWith": { + "type": { + "$ref": "#/30" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ComponentRunWith", + "properties": { + "PosixUser": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + }, + "SystemResourceLimits": { + "type": { + "$ref": "#/42" + }, + "flags": 0 + }, + "WindowsUser": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DeploymentComponentUpdatePolicy", + "properties": { + "Action": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + }, + "TimeoutInSeconds": { + "type": { + "$ref": "#/16" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DeploymentConfigurationValidationPolicy", + "properties": { + "TimeoutInSeconds": { + "type": { + "$ref": "#/16" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DeploymentIoTJobConfiguration", + "properties": { + "AbortConfig": { + "type": { + "$ref": "#/35" + }, + "flags": 0 + }, + "JobExecutionsRolloutConfig": { + "type": { + "$ref": "#/37" + }, + "flags": 0 + }, + "TimeoutConfig": { + "type": { + "$ref": "#/40" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DeploymentPolicies", + "properties": { + "ComponentUpdatePolicy": { + "type": { + "$ref": "#/31" + }, + "flags": 0 + }, + "ConfigurationValidationPolicy": { + "type": { + "$ref": "#/32" + }, + "flags": 0 + }, + "FailureHandlingPolicy": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "IoTJobAbortConfig", + "properties": { + "CriteriaList": { + "type": { + "$ref": "#/44" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "IoTJobAbortCriteria", + "properties": { + "Action": { + "type": { + "$ref": "#/12" + }, + "flags": 1 + }, + "FailureType": { + "type": { + "$ref": "#/12" + }, + "flags": 1 + }, + "MinNumberOfExecutedThings": { + "type": { + "$ref": "#/16" + }, + "flags": 1 + }, + "ThresholdPercentage": { + "type": { + "$ref": "#/16" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "IoTJobExecutionsRolloutConfig", + "properties": { + "ExponentialRate": { + "type": { + "$ref": "#/38" + }, + "flags": 0 + }, + "MaximumPerMinute": { + "type": { + "$ref": "#/16" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "IoTJobExponentialRolloutRate", + "properties": { + "BaseRatePerMinute": { + "type": { + "$ref": "#/16" + }, + "flags": 1 + }, + "IncrementFactor": { + "type": { + "$ref": "#/16" + }, + "flags": 1 + }, + "RateIncreaseCriteria": { + "type": { + "$ref": "#/39" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "IoTJobRateIncreaseCriteria", + "properties": { + "NumberOfNotifiedThings": { + "type": { + "$ref": "#/16" + }, + "flags": 0 + }, + "NumberOfSucceededThings": { + "type": { + "$ref": "#/16" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "IoTJobTimeoutConfig", + "properties": { + "InProgressTimeoutInMinutes": { + "type": { + "$ref": "#/16" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "NumberOfThings", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SystemResourceLimits", + "properties": { + "Cpus": { + "type": { + "$ref": "#/16" + }, + "flags": 0 + }, + "Memory": { + "type": { + "$ref": "#/16" + }, + "flags": 0 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/12" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/36" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.GreengrassV2/DeploymentProperties" + }, + { + "$type": "ObjectType", + "name": "Deployment_Components", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Deployment_Tags", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AWS.GreengrassV2/DeploymentProperties", + "properties": { + "Components": { + "type": { + "$ref": "#/46" + }, + "flags": 0 + }, + "DeploymentId": { + "type": { + "$ref": "#/12" + }, + "flags": 18 + }, + "DeploymentName": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + }, + "DeploymentPolicies": { + "type": { + "$ref": "#/34" + }, + "flags": 0 + }, + "IotJobConfiguration": { + "type": { + "$ref": "#/33" + }, + "flags": 0 + }, + "ParentTargetArn": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/47" + }, + "flags": 0 + }, + "TargetArn": { + "type": { + "$ref": "#/12" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.GreengrassV2/Deployment", + "properties": { + "name": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/12" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/48" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.GreengrassV2/Deployment@default", + "scopeType": 0, + "body": { + "$ref": "#/49" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.greengrassv2/default/types.md b/artifacts/bicep/aws/aws.greengrassv2/default/types.md index dcaab06e..0310feed 100644 --- a/artifacts/bicep/aws/aws.greengrassv2/default/types.md +++ b/artifacts/bicep/aws/aws.greengrassv2/default/types.md @@ -3,16 +3,16 @@ ## Resource AWS.GreengrassV2/ComponentVersion@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.GreengrassV2/ComponentVersionProperties](#awsgreengrassv2componentversionproperties): properties of the resource +* **properties**: [AWS.GreengrassV2/ComponentVersionProperties](#awsgreengrassv2componentversionproperties) (Identifier): properties of the resource ## Resource AWS.GreengrassV2/Deployment@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.GreengrassV2/DeploymentProperties](#awsgreengrassv2deploymentproperties) (Required): properties of the resource +* **properties**: [AWS.GreengrassV2/DeploymentProperties](#awsgreengrassv2deploymentproperties) (Required, Identifier): properties of the resource ## AWS.GreengrassV2/ComponentVersionProperties ### Properties @@ -23,64 +23,16 @@ * **LambdaFunction**: [LambdaFunctionRecipeSource](#lambdafunctionrecipesource) (WriteOnly) * **Tags**: [ComponentVersion_Tags](#componentversiontags) -## LambdaFunctionRecipeSource -### Properties -* **ComponentDependencies**: [ComponentVersion_ComponentDependencies](#componentversioncomponentdependencies) -* **ComponentLambdaParameters**: [LambdaExecutionParameters](#lambdaexecutionparameters) -* **ComponentName**: string -* **ComponentPlatforms**: [ComponentPlatform](#componentplatform)[] -* **ComponentVersion**: string -* **LambdaArn**: string - -## ComponentVersion_ComponentDependencies -### Properties - -## LambdaExecutionParameters -### Properties -* **EnvironmentVariables**: [ComponentVersion_EnvironmentVariables](#componentversionenvironmentvariables) -* **EventSources**: [LambdaEventSource](#lambdaeventsource)[] -* **ExecArgs**: string[] -* **InputPayloadEncodingType**: string -* **LinuxProcessParams**: [LambdaLinuxProcessParams](#lambdalinuxprocessparams) -* **MaxIdleTimeInSeconds**: int -* **MaxInstancesCount**: int -* **MaxQueueSize**: int -* **Pinned**: bool -* **StatusTimeoutInSeconds**: int -* **TimeoutInSeconds**: int - -## ComponentVersion_EnvironmentVariables -### Properties - -## LambdaEventSource -### Properties -* **Topic**: string -* **Type**: string - -## LambdaLinuxProcessParams -### Properties -* **ContainerParams**: [LambdaContainerParams](#lambdacontainerparams) -* **IsolationMode**: string - -## LambdaContainerParams -### Properties -* **Devices**: [LambdaDeviceMount](#lambdadevicemount)[] -* **MemorySizeInKB**: int -* **MountROSysfs**: bool -* **Volumes**: [LambdaVolumeMount](#lambdavolumemount)[] - -## LambdaDeviceMount -### Properties -* **AddGroupOwner**: bool -* **Path**: string -* **Permission**: string - -## LambdaVolumeMount +## AWS.GreengrassV2/DeploymentProperties ### Properties -* **AddGroupOwner**: bool -* **DestinationPath**: string -* **Permission**: string -* **SourcePath**: string +* **Components**: [Deployment_Components](#deploymentcomponents) +* **DeploymentId**: string (ReadOnly, Identifier) +* **DeploymentName**: string +* **DeploymentPolicies**: [DeploymentPolicies](#deploymentpolicies) +* **IotJobConfiguration**: [DeploymentIoTJobConfiguration](#deploymentiotjobconfiguration) +* **ParentTargetArn**: string +* **Tags**: [Deployment_Tags](#deploymenttags) +* **TargetArn**: string (Required) ## ComponentPlatform ### Properties @@ -90,28 +42,20 @@ ## ComponentVersion_Attributes ### Properties -## ComponentVersion_Tags +## ComponentVersion_ComponentDependencies ### Properties -## AWS.GreengrassV2/DeploymentProperties +## ComponentVersion_EnvironmentVariables +### Properties + +## ComponentVersion_Tags ### Properties -* **Components**: [Deployment_Components](#deploymentcomponents) -* **DeploymentId**: string (ReadOnly, Identifier) -* **DeploymentName**: string -* **DeploymentPolicies**: [DeploymentPolicies](#deploymentpolicies) -* **IotJobConfiguration**: [DeploymentIoTJobConfiguration](#deploymentiotjobconfiguration) -* **ParentTargetArn**: string -* **Tags**: [Deployment_Tags](#deploymenttags) -* **TargetArn**: string (Required) ## Deployment_Components ### Properties -## DeploymentPolicies +## Deployment_Tags ### Properties -* **ComponentUpdatePolicy**: [DeploymentComponentUpdatePolicy](#deploymentcomponentupdatepolicy) -* **ConfigurationValidationPolicy**: [DeploymentConfigurationValidationPolicy](#deploymentconfigurationvalidationpolicy) -* **FailureHandlingPolicy**: string ## DeploymentComponentUpdatePolicy ### Properties @@ -128,6 +72,12 @@ * **JobExecutionsRolloutConfig**: [IoTJobExecutionsRolloutConfig](#iotjobexecutionsrolloutconfig) * **TimeoutConfig**: [IoTJobTimeoutConfig](#iotjobtimeoutconfig) +## DeploymentPolicies +### Properties +* **ComponentUpdatePolicy**: [DeploymentComponentUpdatePolicy](#deploymentcomponentupdatepolicy) +* **ConfigurationValidationPolicy**: [DeploymentConfigurationValidationPolicy](#deploymentconfigurationvalidationpolicy) +* **FailureHandlingPolicy**: string + ## IoTJobAbortConfig ### Properties * **CriteriaList**: [IoTJobAbortCriteria](#iotjobabortcriteria)[] (Required) @@ -159,6 +109,56 @@ ### Properties * **InProgressTimeoutInMinutes**: int -## Deployment_Tags +## LambdaContainerParams +### Properties +* **Devices**: [LambdaDeviceMount](#lambdadevicemount)[] +* **MemorySizeInKB**: int +* **MountROSysfs**: bool +* **Volumes**: [LambdaVolumeMount](#lambdavolumemount)[] + +## LambdaDeviceMount +### Properties +* **AddGroupOwner**: bool +* **Path**: string +* **Permission**: string + +## LambdaEventSource +### Properties +* **Topic**: string +* **Type**: string + +## LambdaExecutionParameters +### Properties +* **EnvironmentVariables**: [ComponentVersion_EnvironmentVariables](#componentversionenvironmentvariables) +* **EventSources**: [LambdaEventSource](#lambdaeventsource)[] +* **ExecArgs**: string[] +* **InputPayloadEncodingType**: string +* **LinuxProcessParams**: [LambdaLinuxProcessParams](#lambdalinuxprocessparams) +* **MaxIdleTimeInSeconds**: int +* **MaxInstancesCount**: int +* **MaxQueueSize**: int +* **Pinned**: bool +* **StatusTimeoutInSeconds**: int +* **TimeoutInSeconds**: int + +## LambdaFunctionRecipeSource ### Properties +* **ComponentDependencies**: [ComponentVersion_ComponentDependencies](#componentversioncomponentdependencies) +* **ComponentLambdaParameters**: [LambdaExecutionParameters](#lambdaexecutionparameters) +* **ComponentName**: string +* **ComponentPlatforms**: [ComponentPlatform](#componentplatform)[] +* **ComponentVersion**: string +* **LambdaArn**: string + +## LambdaLinuxProcessParams +### Properties +* **ContainerParams**: [LambdaContainerParams](#lambdacontainerparams) +* **IsolationMode**: string + +## LambdaVolumeMount +### Properties +* **AddGroupOwner**: bool +* **DestinationPath**: string +* **Permission**: string +* **SourcePath**: string diff --git a/artifacts/bicep/aws/aws.groundstation/default/types.json b/artifacts/bicep/aws/aws.groundstation/default/types.json index 08060fc9..e0cf2cb4 100644 --- a/artifacts/bicep/aws/aws.groundstation/default/types.json +++ b/artifacts/bicep/aws/aws.groundstation/default/types.json @@ -1 +1,648 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"AntennaDownlinkConfig","Properties":{"SpectrumConfig":{"Type":27,"Flags":0}}}},{"2":{"Name":"AntennaDownlinkDemodDecodeConfig","Properties":{"DecodeConfig":{"Type":15,"Flags":0},"DemodulationConfig":{"Type":16,"Flags":0},"SpectrumConfig":{"Type":27,"Flags":0}}}},{"2":{"Name":"AntennaUplinkConfig","Properties":{"SpectrumConfig":{"Type":31,"Flags":0},"TargetEirp":{"Type":17,"Flags":0},"TransmitDisabled":{"Type":2,"Flags":0}}}},{"2":{"Name":"BandwidthUnits"}},{"2":{"Name":"BucketArn"}},{"2":{"Name":"ConfigData","Properties":{"AntennaDownlinkConfig":{"Type":8,"Flags":0},"AntennaDownlinkDemodDecodeConfig":{"Type":9,"Flags":0},"AntennaUplinkConfig":{"Type":10,"Flags":0},"DataflowEndpointConfig":{"Type":14,"Flags":0},"S3RecordingConfig":{"Type":26,"Flags":0},"TrackingConfig":{"Type":29,"Flags":0},"UplinkEchoConfig":{"Type":30,"Flags":0}}}},{"2":{"Name":"DataflowEndpointConfig","Properties":{"DataflowEndpointName":{"Type":4,"Flags":0},"DataflowEndpointRegion":{"Type":4,"Flags":0}}}},{"2":{"Name":"DecodeConfig","Properties":{"UnvalidatedJSON":{"Type":4,"Flags":0}}}},{"2":{"Name":"DemodulationConfig","Properties":{"UnvalidatedJSON":{"Type":4,"Flags":0}}}},{"2":{"Name":"Eirp","Properties":{"Units":{"Type":4,"Flags":0},"Value":{"Type":3,"Flags":0}}}},{"2":{"Name":"EirpUnits"}},{"2":{"Name":"Frequency","Properties":{"Units":{"Type":4,"Flags":0},"Value":{"Type":3,"Flags":0}}}},{"2":{"Name":"FrequencyBandwidth","Properties":{"Units":{"Type":4,"Flags":0},"Value":{"Type":3,"Flags":0}}}},{"2":{"Name":"FrequencyUnits"}},{"2":{"Name":"JsonString"}},{"2":{"Name":"Polarization"}},{"2":{"Name":"RoleArn"}},{"2":{"Name":"S3KeyPrefix"}},{"2":{"Name":"S3RecordingConfig","Properties":{"BucketArn":{"Type":4,"Flags":0},"Prefix":{"Type":4,"Flags":0},"RoleArn":{"Type":4,"Flags":0}}}},{"2":{"Name":"SpectrumConfig","Properties":{"Bandwidth":{"Type":20,"Flags":0},"CenterFrequency":{"Type":19,"Flags":0},"Polarization":{"Type":4,"Flags":0}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":0},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"TrackingConfig","Properties":{"Autotrack":{"Type":4,"Flags":0}}}},{"2":{"Name":"UplinkEchoConfig","Properties":{"AntennaUplinkConfigArn":{"Type":4,"Flags":0},"Enabled":{"Type":2,"Flags":0}}}},{"2":{"Name":"UplinkSpectrumConfig","Properties":{"CenterFrequency":{"Type":19,"Flags":0},"Polarization":{"Type":4,"Flags":0}}}},{"2":{"Name":"AWS.GroundStation/ConfigProperties","Properties":{"Arn":{"Type":4,"Flags":18},"ConfigData":{"Type":13,"Flags":1},"Id":{"Type":4,"Flags":2},"Name":{"Type":4,"Flags":1},"Tags":{"Type":33,"Flags":0},"Type":{"Type":4,"Flags":2}}}},{"3":{"ItemType":28}},{"2":{"Name":"AWS.GroundStation/Config","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":32,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.GroundStation/Config@default","ScopeType":0,"Body":34}},{"2":{"Name":"DataflowEdge","Properties":{"Destination":{"Type":4,"Flags":0},"Source":{"Type":4,"Flags":0}}}},{"2":{"Name":"StreamsKmsKey","Properties":{"KmsAliasArn":{"Type":4,"Flags":0},"KmsKeyArn":{"Type":4,"Flags":0}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.GroundStation/MissionProfileProperties","Properties":{"Arn":{"Type":4,"Flags":18},"ContactPostPassDurationSeconds":{"Type":3,"Flags":0,"Description":"Post-pass time needed after the contact."},"ContactPrePassDurationSeconds":{"Type":3,"Flags":0,"Description":"Pre-pass time needed before the contact."},"DataflowEdges":{"Type":40,"Flags":1,"Description":""},"Id":{"Type":4,"Flags":18},"MinimumViableContactDurationSeconds":{"Type":3,"Flags":1,"Description":"Visibilities with shorter duration than the specified minimum viable contact duration will be ignored when searching for available contacts."},"Name":{"Type":4,"Flags":1,"Description":"A name used to identify a mission profile."},"Region":{"Type":4,"Flags":2},"StreamsKmsKey":{"Type":37,"Flags":0,"Description":"The ARN of a KMS Key used for encrypting data during transmission from the source to destination locations."},"StreamsKmsRole":{"Type":4,"Flags":0,"Description":"The ARN of the KMS Key or Alias Key role used to define permissions on KMS Key usage."},"Tags":{"Type":41,"Flags":0},"TrackingConfigArn":{"Type":4,"Flags":1}}}},{"3":{"ItemType":36}},{"3":{"ItemType":38}},{"2":{"Name":"AWS.GroundStation/MissionProfile","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":39,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.GroundStation/MissionProfile@default","ScopeType":0,"Body":42}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "AntennaDownlinkConfig", + "properties": { + "SpectrumConfig": { + "type": { + "$ref": "#/19" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AntennaDownlinkDemodDecodeConfig", + "properties": { + "DecodeConfig": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "DemodulationConfig": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "SpectrumConfig": { + "type": { + "$ref": "#/19" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AntennaUplinkConfig", + "properties": { + "SpectrumConfig": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "TargetEirp": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "TransmitDisabled": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BandwidthUnits", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "BucketArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ConfigData", + "properties": { + "AntennaDownlinkConfig": { + "type": { + "$ref": "#/0" + }, + "flags": 0 + }, + "AntennaDownlinkDemodDecodeConfig": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "AntennaUplinkConfig": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "DataflowEndpointConfig": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "S3RecordingConfig": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "TrackingConfig": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "UplinkEchoConfig": { + "type": { + "$ref": "#/22" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DataflowEndpointConfig", + "properties": { + "DataflowEndpointName": { + "type": { + "$ref": "#/25" + }, + "flags": 0 + }, + "DataflowEndpointRegion": { + "type": { + "$ref": "#/25" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DecodeConfig", + "properties": { + "UnvalidatedJSON": { + "type": { + "$ref": "#/25" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DemodulationConfig", + "properties": { + "UnvalidatedJSON": { + "type": { + "$ref": "#/25" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Eirp", + "properties": { + "Units": { + "type": { + "$ref": "#/25" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/26" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "EirpUnits", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Frequency", + "properties": { + "Units": { + "type": { + "$ref": "#/25" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/26" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FrequencyBandwidth", + "properties": { + "Units": { + "type": { + "$ref": "#/25" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/26" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FrequencyUnits", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "JsonString", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Polarization", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RoleArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "S3KeyPrefix", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "S3RecordingConfig", + "properties": { + "BucketArn": { + "type": { + "$ref": "#/25" + }, + "flags": 0 + }, + "Prefix": { + "type": { + "$ref": "#/25" + }, + "flags": 0 + }, + "RoleArn": { + "type": { + "$ref": "#/25" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SpectrumConfig", + "properties": { + "Bandwidth": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + }, + "CenterFrequency": { + "type": { + "$ref": "#/11" + }, + "flags": 0 + }, + "Polarization": { + "type": { + "$ref": "#/25" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/25" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/25" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TrackingConfig", + "properties": { + "Autotrack": { + "type": { + "$ref": "#/25" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "UplinkEchoConfig", + "properties": { + "AntennaUplinkConfigArn": { + "type": { + "$ref": "#/25" + }, + "flags": 0 + }, + "Enabled": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "UplinkSpectrumConfig", + "properties": { + "CenterFrequency": { + "type": { + "$ref": "#/11" + }, + "flags": 0 + }, + "Polarization": { + "type": { + "$ref": "#/25" + }, + "flags": 0 + } + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "StringType" + }, + { + "$type": "IntegerType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.GroundStation/ConfigProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/20" + } + }, + { + "$type": "ObjectType", + "name": "AWS.GroundStation/ConfigProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/25" + }, + "flags": 18 + }, + "ConfigData": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Id": { + "type": { + "$ref": "#/25" + }, + "flags": 2 + }, + "Name": { + "type": { + "$ref": "#/25" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/28" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/25" + }, + "flags": 2 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.GroundStation/Config", + "properties": { + "name": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/25" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/29" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.GroundStation/Config@default", + "scopeType": 0, + "body": { + "$ref": "#/30" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "DataflowEdge", + "properties": { + "Destination": { + "type": { + "$ref": "#/25" + }, + "flags": 0 + }, + "Source": { + "type": { + "$ref": "#/25" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "StreamsKmsKey", + "properties": { + "KmsAliasArn": { + "type": { + "$ref": "#/25" + }, + "flags": 0 + }, + "KmsKeyArn": { + "type": { + "$ref": "#/25" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/25" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/25" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.GroundStation/MissionProfileProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/32" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/34" + } + }, + { + "$type": "ObjectType", + "name": "AWS.GroundStation/MissionProfileProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/25" + }, + "flags": 18 + }, + "ContactPostPassDurationSeconds": { + "type": { + "$ref": "#/26" + }, + "flags": 0, + "description": "Post-pass time needed after the contact." + }, + "ContactPrePassDurationSeconds": { + "type": { + "$ref": "#/26" + }, + "flags": 0, + "description": "Pre-pass time needed before the contact." + }, + "DataflowEdges": { + "type": { + "$ref": "#/36" + }, + "flags": 1, + "description": "" + }, + "Id": { + "type": { + "$ref": "#/25" + }, + "flags": 18 + }, + "MinimumViableContactDurationSeconds": { + "type": { + "$ref": "#/26" + }, + "flags": 1, + "description": "Visibilities with shorter duration than the specified minimum viable contact duration will be ignored when searching for available contacts." + }, + "Name": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "A name used to identify a mission profile." + }, + "Region": { + "type": { + "$ref": "#/25" + }, + "flags": 2 + }, + "StreamsKmsKey": { + "type": { + "$ref": "#/33" + }, + "flags": 0, + "description": "The ARN of a KMS Key used for encrypting data during transmission from the source to destination locations." + }, + "StreamsKmsRole": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "The ARN of the KMS Key or Alias Key role used to define permissions on KMS Key usage." + }, + "Tags": { + "type": { + "$ref": "#/37" + }, + "flags": 0 + }, + "TrackingConfigArn": { + "type": { + "$ref": "#/25" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.GroundStation/MissionProfile", + "properties": { + "name": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/25" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/38" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.GroundStation/MissionProfile@default", + "scopeType": 0, + "body": { + "$ref": "#/39" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.groundstation/default/types.md b/artifacts/bicep/aws/aws.groundstation/default/types.md index 2727c58b..f7634b0f 100644 --- a/artifacts/bicep/aws/aws.groundstation/default/types.md +++ b/artifacts/bicep/aws/aws.groundstation/default/types.md @@ -3,16 +3,32 @@ ## Resource AWS.GroundStation/Config@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.GroundStation/ConfigProperties](#awsgroundstationconfigproperties) (Required): properties of the resource +* **properties**: [AWS.GroundStation/ConfigProperties](#awsgroundstationconfigproperties) (Required, Identifier): properties of the resource ## Resource AWS.GroundStation/MissionProfile@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.GroundStation/MissionProfileProperties](#awsgroundstationmissionprofileproperties) (Required): properties of the resource +* **properties**: [AWS.GroundStation/MissionProfileProperties](#awsgroundstationmissionprofileproperties) (Required, Identifier): properties of the resource + +## AntennaDownlinkConfig +### Properties +* **SpectrumConfig**: [SpectrumConfig](#spectrumconfig) + +## AntennaDownlinkDemodDecodeConfig +### Properties +* **DecodeConfig**: [DecodeConfig](#decodeconfig) +* **DemodulationConfig**: [DemodulationConfig](#demodulationconfig) +* **SpectrumConfig**: [SpectrumConfig](#spectrumconfig) + +## AntennaUplinkConfig +### Properties +* **SpectrumConfig**: [UplinkSpectrumConfig](#uplinkspectrumconfig) +* **TargetEirp**: [Eirp](#eirp) +* **TransmitDisabled**: bool ## AWS.GroundStation/ConfigProperties ### Properties @@ -23,6 +39,21 @@ * **Tags**: [Tag](#tag)[] * **Type**: string (ReadOnly) +## AWS.GroundStation/MissionProfileProperties +### Properties +* **Arn**: string (ReadOnly, Identifier) +* **ContactPostPassDurationSeconds**: int: Post-pass time needed after the contact. +* **ContactPrePassDurationSeconds**: int: Pre-pass time needed before the contact. +* **DataflowEdges**: [DataflowEdge](#dataflowedge)[] (Required) +* **Id**: string (ReadOnly, Identifier) +* **MinimumViableContactDurationSeconds**: int (Required): Visibilities with shorter duration than the specified minimum viable contact duration will be ignored when searching for available contacts. +* **Name**: string (Required): A name used to identify a mission profile. +* **Region**: string (ReadOnly) +* **StreamsKmsKey**: [StreamsKmsKey](#streamskmskey): The ARN of a KMS Key used for encrypting data during transmission from the source to destination locations. +* **StreamsKmsRole**: string: The ARN of the KMS Key or Alias Key role used to define permissions on KMS Key usage. +* **Tags**: [Tag](#tag)[] +* **TrackingConfigArn**: string (Required) + ## ConfigData ### Properties * **AntennaDownlinkConfig**: [AntennaDownlinkConfig](#antennadownlinkconfig) @@ -33,31 +64,15 @@ * **TrackingConfig**: [TrackingConfig](#trackingconfig) * **UplinkEchoConfig**: [UplinkEchoConfig](#uplinkechoconfig) -## AntennaDownlinkConfig -### Properties -* **SpectrumConfig**: [SpectrumConfig](#spectrumconfig) - -## SpectrumConfig -### Properties -* **Bandwidth**: [FrequencyBandwidth](#frequencybandwidth) -* **CenterFrequency**: [Frequency](#frequency) -* **Polarization**: string - -## FrequencyBandwidth -### Properties -* **Units**: string -* **Value**: int - -## Frequency +## DataflowEdge ### Properties -* **Units**: string -* **Value**: int +* **Destination**: string +* **Source**: string -## AntennaDownlinkDemodDecodeConfig +## DataflowEndpointConfig ### Properties -* **DecodeConfig**: [DecodeConfig](#decodeconfig) -* **DemodulationConfig**: [DemodulationConfig](#demodulationconfig) -* **SpectrumConfig**: [SpectrumConfig](#spectrumconfig) +* **DataflowEndpointName**: string +* **DataflowEndpointRegion**: string ## DecodeConfig ### Properties @@ -67,26 +82,20 @@ ### Properties * **UnvalidatedJSON**: string -## AntennaUplinkConfig -### Properties -* **SpectrumConfig**: [UplinkSpectrumConfig](#uplinkspectrumconfig) -* **TargetEirp**: [Eirp](#eirp) -* **TransmitDisabled**: bool - -## UplinkSpectrumConfig +## Eirp ### Properties -* **CenterFrequency**: [Frequency](#frequency) -* **Polarization**: string +* **Units**: string +* **Value**: int -## Eirp +## Frequency ### Properties * **Units**: string * **Value**: int -## DataflowEndpointConfig +## FrequencyBandwidth ### Properties -* **DataflowEndpointName**: string -* **DataflowEndpointRegion**: string +* **Units**: string +* **Value**: int ## S3RecordingConfig ### Properties @@ -94,47 +103,38 @@ * **Prefix**: string * **RoleArn**: string -## TrackingConfig +## SpectrumConfig ### Properties -* **Autotrack**: string +* **Bandwidth**: [FrequencyBandwidth](#frequencybandwidth) +* **CenterFrequency**: [Frequency](#frequency) +* **Polarization**: string -## UplinkEchoConfig +## StreamsKmsKey ### Properties -* **AntennaUplinkConfigArn**: string -* **Enabled**: bool +* **KmsAliasArn**: string +* **KmsKeyArn**: string ## Tag ### Properties * **Key**: string * **Value**: string -## AWS.GroundStation/MissionProfileProperties +## Tag ### Properties -* **Arn**: string (ReadOnly, Identifier) -* **ContactPostPassDurationSeconds**: int: Post-pass time needed after the contact. -* **ContactPrePassDurationSeconds**: int: Pre-pass time needed before the contact. -* **DataflowEdges**: [DataflowEdge](#dataflowedge)[] (Required) -* **Id**: string (ReadOnly, Identifier) -* **MinimumViableContactDurationSeconds**: int (Required): Visibilities with shorter duration than the specified minimum viable contact duration will be ignored when searching for available contacts. -* **Name**: string (Required): A name used to identify a mission profile. -* **Region**: string (ReadOnly) -* **StreamsKmsKey**: [StreamsKmsKey](#streamskmskey): The ARN of a KMS Key used for encrypting data during transmission from the source to destination locations. -* **StreamsKmsRole**: string: The ARN of the KMS Key or Alias Key role used to define permissions on KMS Key usage. -* **Tags**: [Tag](#tag)[] -* **TrackingConfigArn**: string (Required) +* **Key**: string (Required) +* **Value**: string (Required) -## DataflowEdge +## TrackingConfig ### Properties -* **Destination**: string -* **Source**: string +* **Autotrack**: string -## StreamsKmsKey +## UplinkEchoConfig ### Properties -* **KmsAliasArn**: string -* **KmsKeyArn**: string +* **AntennaUplinkConfigArn**: string +* **Enabled**: bool -## Tag +## UplinkSpectrumConfig ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **CenterFrequency**: [Frequency](#frequency) +* **Polarization**: string diff --git a/artifacts/bicep/aws/aws.guardduty/default/types.json b/artifacts/bicep/aws/aws.guardduty/default/types.json index 6c15dd03..60523b31 100644 --- a/artifacts/bicep/aws/aws.guardduty/default/types.json +++ b/artifacts/bicep/aws/aws.guardduty/default/types.json @@ -1 +1,1016 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"CFNDataSourceConfigurations","Properties":{"Kubernetes":{"Type":12,"Flags":0},"MalwareProtection":{"Type":13,"Flags":0},"S3Logs":{"Type":14,"Flags":0}}}},{"2":{"Name":"CFNFeatureAdditionalConfiguration","Properties":{"Name":{"Type":4,"Flags":0},"Status":{"Type":4,"Flags":0}}}},{"2":{"Name":"CFNFeatureConfiguration","Properties":{"AdditionalConfiguration":{"Type":17,"Flags":0},"Name":{"Type":4,"Flags":1},"Status":{"Type":4,"Flags":1}}}},{"2":{"Name":"CFNKubernetesAuditLogsConfiguration","Properties":{"Enable":{"Type":2,"Flags":1}}}},{"2":{"Name":"CFNKubernetesConfiguration","Properties":{"AuditLogs":{"Type":11,"Flags":1}}}},{"2":{"Name":"CFNMalwareProtectionConfiguration","Properties":{"ScanEc2InstanceWithFindings":{"Type":15,"Flags":0}}}},{"2":{"Name":"CFNS3LogsConfiguration","Properties":{"Enable":{"Type":2,"Flags":1}}}},{"2":{"Name":"CFNScanEc2InstanceWithFindingsConfiguration","Properties":{"EbsVolumes":{"Type":2,"Flags":0}}}},{"2":{"Name":"TagItem","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"3":{"ItemType":9}},{"2":{"Name":"AWS.GuardDuty/DetectorProperties","Properties":{"DataSources":{"Type":8,"Flags":0},"Enable":{"Type":2,"Flags":1},"Features":{"Type":19,"Flags":0},"FindingPublishingFrequency":{"Type":4,"Flags":0},"Id":{"Type":4,"Flags":18},"Tags":{"Type":20,"Flags":0}}}},{"3":{"ItemType":10}},{"3":{"ItemType":16}},{"2":{"Name":"AWS.GuardDuty/Detector","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":18,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.GuardDuty/Detector@default","ScopeType":0,"Body":21}},{"2":{"Name":"TagItem","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.GuardDuty/IPSetProperties","Properties":{"Activate":{"Type":2,"Flags":4},"DetectorId":{"Type":4,"Flags":16},"Format":{"Type":4,"Flags":1},"Id":{"Type":4,"Flags":18},"Location":{"Type":4,"Flags":1},"Name":{"Type":4,"Flags":1},"Tags":{"Type":25,"Flags":0}}}},{"3":{"ItemType":23}},{"2":{"Name":"AWS.GuardDuty/IPSet","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":24,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.GuardDuty/IPSet@default","ScopeType":0,"Body":26}},{"2":{"Name":"TagItem","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.GuardDuty/ThreatIntelSetProperties","Properties":{"Activate":{"Type":2,"Flags":4},"DetectorId":{"Type":4,"Flags":16},"Format":{"Type":4,"Flags":1},"Id":{"Type":4,"Flags":18},"Location":{"Type":4,"Flags":1},"Name":{"Type":4,"Flags":1},"Tags":{"Type":30,"Flags":0}}}},{"3":{"ItemType":28}},{"2":{"Name":"AWS.GuardDuty/ThreatIntelSet","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":29,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.GuardDuty/ThreatIntelSet@default","ScopeType":0,"Body":31}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "CFNDataSourceConfigurations", + "properties": { + "Kubernetes": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "MalwareProtection": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "S3Logs": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CFNFeatureAdditionalConfiguration", + "properties": { + "Name": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "Status": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CFNFeatureConfiguration", + "properties": { + "AdditionalConfiguration": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + }, + "Status": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CFNKubernetesAuditLogsConfiguration", + "properties": { + "Enable": { + "type": { + "$ref": "#/11" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CFNKubernetesConfiguration", + "properties": { + "AuditLogs": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CFNMalwareProtectionConfiguration", + "properties": { + "ScanEc2InstanceWithFindings": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CFNS3LogsConfiguration", + "properties": { + "Enable": { + "type": { + "$ref": "#/11" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CFNScanEc2InstanceWithFindingsConfiguration", + "properties": { + "EbsVolumes": { + "type": { + "$ref": "#/11" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TagItem", + "properties": { + "Key": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.GuardDuty/DetectorProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/8" + } + }, + { + "$type": "ObjectType", + "name": "AWS.GuardDuty/DetectorProperties", + "properties": { + "DataSources": { + "type": { + "$ref": "#/0" + }, + "flags": 0 + }, + "Enable": { + "type": { + "$ref": "#/11" + }, + "flags": 1 + }, + "Features": { + "type": { + "$ref": "#/13" + }, + "flags": 0 + }, + "FindingPublishingFrequency": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "Id": { + "type": { + "$ref": "#/9" + }, + "flags": 18 + }, + "Tags": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.GuardDuty/Detector", + "properties": { + "name": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/9" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/15" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.GuardDuty/Detector@default", + "scopeType": 0, + "body": { + "$ref": "#/16" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Condition", + "properties": { + "Eq": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "Equals": { + "type": { + "$ref": "#/22" + }, + "flags": 0 + }, + "GreaterThan": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "GreaterThanOrEqual": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "Gt": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "Gte": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "LessThan": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "LessThanOrEqual": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "Lt": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "Lte": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "Neq": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "NotEquals": { + "type": { + "$ref": "#/25" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FindingCriteria", + "properties": { + "Criterion": { + "type": { + "$ref": "#/26" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TagItem", + "properties": { + "Key": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/9" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/9" + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/9" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/9" + } + }, + { + "$type": "ObjectType", + "name": "Filter_Criterion", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.GuardDuty/FilterProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/20" + } + }, + { + "$type": "ObjectType", + "name": "AWS.GuardDuty/FilterProperties", + "properties": { + "Action": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "Description": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "DetectorId": { + "type": { + "$ref": "#/9" + }, + "flags": 17 + }, + "FindingCriteria": { + "type": { + "$ref": "#/19" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/9" + }, + "flags": 17 + }, + "Rank": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/28" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.GuardDuty/Filter", + "properties": { + "name": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/9" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/29" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.GuardDuty/Filter@default", + "scopeType": 0, + "body": { + "$ref": "#/30" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "TagItem", + "properties": { + "Key": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.GuardDuty/IPSetProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/32" + } + }, + { + "$type": "ObjectType", + "name": "AWS.GuardDuty/IPSetProperties", + "properties": { + "Activate": { + "type": { + "$ref": "#/11" + }, + "flags": 4 + }, + "DetectorId": { + "type": { + "$ref": "#/9" + }, + "flags": 16 + }, + "Format": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + }, + "Id": { + "type": { + "$ref": "#/9" + }, + "flags": 18 + }, + "Location": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/34" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.GuardDuty/IPSet", + "properties": { + "name": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/9" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/35" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.GuardDuty/IPSet@default", + "scopeType": 0, + "body": { + "$ref": "#/36" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "CFNActions", + "properties": { + "Tagging": { + "type": { + "$ref": "#/41" + }, + "flags": 0, + "description": "Contains information about tagging status of the Malware Protection plan resource." + } + } + }, + { + "$type": "ObjectType", + "name": "CFNProtectedResource", + "properties": { + "S3Bucket": { + "type": { + "$ref": "#/44" + }, + "flags": 1, + "description": "Information about the protected S3 bucket resource." + } + } + }, + { + "$type": "ObjectType", + "name": "CFNStatusReasons", + "properties": { + "Code": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "The status code of the Malware Protection plan." + }, + "Message": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "Issue message that specifies the reason." + } + } + }, + { + "$type": "ObjectType", + "name": "CFNTagging", + "properties": { + "Status": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "Indicates whether or not you chose GuardDuty to add a predefined tag to the scanned S3 object." + } + } + }, + { + "$type": "ObjectType", + "name": "TagItem", + "properties": { + "Key": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/9" + } + }, + { + "$type": "ObjectType", + "name": "MalwareProtectionPlan_S3Bucket", + "properties": { + "BucketName": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "Name of the S3 bucket." + }, + "ObjectPrefixes": { + "type": { + "$ref": "#/43" + }, + "flags": 0, + "description": "Information about the specified object prefixes. The S3 object will be scanned only if it belongs to any of the specified object prefixes." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.GuardDuty/MalwareProtectionPlanProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/40" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/42" + } + }, + { + "$type": "ObjectType", + "name": "AWS.GuardDuty/MalwareProtectionPlanProperties", + "properties": { + "Actions": { + "type": { + "$ref": "#/38" + }, + "flags": 0, + "description": "Specifies the action that is to be applied to the Malware Protection plan resource." + }, + "Arn": { + "type": { + "$ref": "#/9" + }, + "flags": 2, + "description": "Amazon Resource Name (ARN) of the protected resource." + }, + "CreatedAt": { + "type": { + "$ref": "#/9" + }, + "flags": 2, + "description": "The timestamp when the Malware Protection plan resource was created." + }, + "MalwareProtectionPlanId": { + "type": { + "$ref": "#/9" + }, + "flags": 18, + "description": "A unique identifier associated with Malware Protection plan resource." + }, + "ProtectedResource": { + "type": { + "$ref": "#/39" + }, + "flags": 1, + "description": "Information about the protected resource. Presently, S3Bucket is the only supported protected resource." + }, + "Role": { + "type": { + "$ref": "#/9" + }, + "flags": 1, + "description": "IAM role that includes the permissions required to scan and (optionally) add tags to the associated protected resource." + }, + "Status": { + "type": { + "$ref": "#/9" + }, + "flags": 2, + "description": "Status of the Malware Protection plan resource." + }, + "StatusReasons": { + "type": { + "$ref": "#/46" + }, + "flags": 2, + "description": "Status details associated with the Malware Protection plan resource status." + }, + "Tags": { + "type": { + "$ref": "#/47" + }, + "flags": 0, + "description": "The tags to be added to the created Malware Protection plan resource. Each tag consists of a key and an optional value, both of which you need to specify." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.GuardDuty/MalwareProtectionPlan", + "properties": { + "name": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/9" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/48" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.GuardDuty/MalwareProtectionPlan@default", + "scopeType": 0, + "body": { + "$ref": "#/49" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.GuardDuty/MemberProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.GuardDuty/MemberProperties", + "properties": { + "DetectorId": { + "type": { + "$ref": "#/9" + }, + "flags": 16 + }, + "DisableEmailNotification": { + "type": { + "$ref": "#/11" + }, + "flags": 4 + }, + "Email": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + }, + "MemberId": { + "type": { + "$ref": "#/9" + }, + "flags": 16 + }, + "Message": { + "type": { + "$ref": "#/9" + }, + "flags": 4 + }, + "Status": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.GuardDuty/Member", + "properties": { + "name": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/9" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/52" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.GuardDuty/Member@default", + "scopeType": 0, + "body": { + "$ref": "#/53" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "TagItem", + "properties": { + "Key": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.GuardDuty/ThreatIntelSetProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/55" + } + }, + { + "$type": "ObjectType", + "name": "AWS.GuardDuty/ThreatIntelSetProperties", + "properties": { + "Activate": { + "type": { + "$ref": "#/11" + }, + "flags": 4 + }, + "DetectorId": { + "type": { + "$ref": "#/9" + }, + "flags": 16 + }, + "Format": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + }, + "Id": { + "type": { + "$ref": "#/9" + }, + "flags": 18 + }, + "Location": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/57" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.GuardDuty/ThreatIntelSet", + "properties": { + "name": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/9" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/58" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.GuardDuty/ThreatIntelSet@default", + "scopeType": 0, + "body": { + "$ref": "#/59" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.guardduty/default/types.md b/artifacts/bicep/aws/aws.guardduty/default/types.md index 7ec0f090..5e8f62e4 100644 --- a/artifacts/bicep/aws/aws.guardduty/default/types.md +++ b/artifacts/bicep/aws/aws.guardduty/default/types.md @@ -3,23 +3,44 @@ ## Resource AWS.GuardDuty/Detector@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.GuardDuty/DetectorProperties](#awsguarddutydetectorproperties) (Required): properties of the resource +* **properties**: [AWS.GuardDuty/DetectorProperties](#awsguarddutydetectorproperties) (Required, Identifier): properties of the resource + +## Resource AWS.GuardDuty/Filter@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.GuardDuty/FilterProperties](#awsguarddutyfilterproperties) (Required, Identifier): properties of the resource ## Resource AWS.GuardDuty/IPSet@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.GuardDuty/IPSetProperties](#awsguarddutyipsetproperties) (Required): properties of the resource +* **properties**: [AWS.GuardDuty/IPSetProperties](#awsguarddutyipsetproperties) (Required, Identifier): properties of the resource + +## Resource AWS.GuardDuty/MalwareProtectionPlan@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.GuardDuty/MalwareProtectionPlanProperties](#awsguarddutymalwareprotectionplanproperties) (Required, Identifier): properties of the resource + +## Resource AWS.GuardDuty/Member@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.GuardDuty/MemberProperties](#awsguarddutymemberproperties) (Required, Identifier): properties of the resource ## Resource AWS.GuardDuty/ThreatIntelSet@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.GuardDuty/ThreatIntelSetProperties](#awsguarddutythreatintelsetproperties) (Required): properties of the resource +* **properties**: [AWS.GuardDuty/ThreatIntelSetProperties](#awsguarddutythreatintelsetproperties) (Required, Identifier): properties of the resource ## AWS.GuardDuty/DetectorProperties ### Properties @@ -30,72 +51,142 @@ * **Id**: string (ReadOnly, Identifier) * **Tags**: [TagItem](#tagitem)[] +## AWS.GuardDuty/FilterProperties +### Properties +* **Action**: string +* **Description**: string +* **DetectorId**: string (Required, Identifier) +* **FindingCriteria**: [FindingCriteria](#findingcriteria) (Required) +* **Name**: string (Required, Identifier) +* **Rank**: int +* **Tags**: [TagItem](#tagitem)[] + +## AWS.GuardDuty/IPSetProperties +### Properties +* **Activate**: bool (WriteOnly) +* **DetectorId**: string (Identifier) +* **Format**: string (Required) +* **Id**: string (ReadOnly, Identifier) +* **Location**: string (Required) +* **Name**: string +* **Tags**: [TagItem](#tagitem)[] + +## AWS.GuardDuty/MalwareProtectionPlanProperties +### Properties +* **Actions**: [CFNActions](#cfnactions): Specifies the action that is to be applied to the Malware Protection plan resource. +* **Arn**: string (ReadOnly): Amazon Resource Name (ARN) of the protected resource. +* **CreatedAt**: string (ReadOnly): The timestamp when the Malware Protection plan resource was created. +* **MalwareProtectionPlanId**: string (ReadOnly, Identifier): A unique identifier associated with Malware Protection plan resource. +* **ProtectedResource**: [CFNProtectedResource](#cfnprotectedresource) (Required): Information about the protected resource. Presently, S3Bucket is the only supported protected resource. +* **Role**: string (Required): IAM role that includes the permissions required to scan and (optionally) add tags to the associated protected resource. +* **Status**: string (ReadOnly): Status of the Malware Protection plan resource. +* **StatusReasons**: [CFNStatusReasons](#cfnstatusreasons)[] (ReadOnly): Status details associated with the Malware Protection plan resource status. +* **Tags**: [TagItem](#tagitem)[]: The tags to be added to the created Malware Protection plan resource. Each tag consists of a key and an optional value, both of which you need to specify. + +## AWS.GuardDuty/MemberProperties +### Properties +* **DetectorId**: string (Identifier) +* **DisableEmailNotification**: bool (WriteOnly) +* **Email**: string (Required) +* **MemberId**: string (Identifier) +* **Message**: string (WriteOnly) +* **Status**: string + +## AWS.GuardDuty/ThreatIntelSetProperties +### Properties +* **Activate**: bool (WriteOnly) +* **DetectorId**: string (Identifier) +* **Format**: string (Required) +* **Id**: string (ReadOnly, Identifier) +* **Location**: string (Required) +* **Name**: string +* **Tags**: [TagItem](#tagitem)[] + +## CFNActions +### Properties +* **Tagging**: [CFNTagging](#cfntagging): Contains information about tagging status of the Malware Protection plan resource. + ## CFNDataSourceConfigurations ### Properties * **Kubernetes**: [CFNKubernetesConfiguration](#cfnkubernetesconfiguration) * **MalwareProtection**: [CFNMalwareProtectionConfiguration](#cfnmalwareprotectionconfiguration) * **S3Logs**: [CFNS3LogsConfiguration](#cfns3logsconfiguration) -## CFNKubernetesConfiguration +## CFNFeatureAdditionalConfiguration ### Properties -* **AuditLogs**: [CFNKubernetesAuditLogsConfiguration](#cfnkubernetesauditlogsconfiguration) (Required) +* **Name**: string +* **Status**: string + +## CFNFeatureConfiguration +### Properties +* **AdditionalConfiguration**: [CFNFeatureAdditionalConfiguration](#cfnfeatureadditionalconfiguration)[] +* **Name**: string (Required) +* **Status**: string (Required) ## CFNKubernetesAuditLogsConfiguration ### Properties * **Enable**: bool (Required) +## CFNKubernetesConfiguration +### Properties +* **AuditLogs**: [CFNKubernetesAuditLogsConfiguration](#cfnkubernetesauditlogsconfiguration) (Required) + ## CFNMalwareProtectionConfiguration ### Properties * **ScanEc2InstanceWithFindings**: [CFNScanEc2InstanceWithFindingsConfiguration](#cfnscanec2instancewithfindingsconfiguration) -## CFNScanEc2InstanceWithFindingsConfiguration +## CFNProtectedResource ### Properties -* **EbsVolumes**: bool +* **S3Bucket**: [MalwareProtectionPlan_S3Bucket](#malwareprotectionplans3bucket) (Required): Information about the protected S3 bucket resource. ## CFNS3LogsConfiguration ### Properties * **Enable**: bool (Required) -## CFNFeatureConfiguration +## CFNScanEc2InstanceWithFindingsConfiguration ### Properties -* **AdditionalConfiguration**: [CFNFeatureAdditionalConfiguration](#cfnfeatureadditionalconfiguration)[] -* **Name**: string (Required) -* **Status**: string (Required) +* **EbsVolumes**: bool -## CFNFeatureAdditionalConfiguration +## CFNStatusReasons ### Properties -* **Name**: string -* **Status**: string +* **Code**: string: The status code of the Malware Protection plan. +* **Message**: string: Issue message that specifies the reason. + +## CFNTagging +### Properties +* **Status**: string: Indicates whether or not you chose GuardDuty to add a predefined tag to the scanned S3 object. + +## Filter_Criterion +### Properties + +## FindingCriteria +### Properties +* **Criterion**: [Filter_Criterion](#filtercriterion) + +## MalwareProtectionPlan_S3Bucket +### Properties +* **BucketName**: string: Name of the S3 bucket. +* **ObjectPrefixes**: string[]: Information about the specified object prefixes. The S3 object will be scanned only if it belongs to any of the specified object prefixes. ## TagItem ### Properties * **Key**: string (Required) * **Value**: string (Required) -## AWS.GuardDuty/IPSetProperties +## TagItem ### Properties -* **Activate**: bool (WriteOnly) -* **DetectorId**: string (Identifier) -* **Format**: string (Required) -* **Id**: string (ReadOnly, Identifier) -* **Location**: string (Required) -* **Name**: string (Required) -* **Tags**: [TagItem](#tagitem)[] +* **Key**: string (Required) +* **Value**: string (Required) ## TagItem ### Properties * **Key**: string (Required) * **Value**: string (Required) -## AWS.GuardDuty/ThreatIntelSetProperties +## TagItem ### Properties -* **Activate**: bool (WriteOnly) -* **DetectorId**: string (Identifier) -* **Format**: string (Required) -* **Id**: string (ReadOnly, Identifier) -* **Location**: string (Required) -* **Name**: string (Required) -* **Tags**: [TagItem](#tagitem)[] +* **Key**: string (Required) +* **Value**: string (Required) ## TagItem ### Properties diff --git a/artifacts/bicep/aws/aws.healthlake/default/types.json b/artifacts/bicep/aws/aws.healthlake/default/types.json index b56f32ba..adb88f3f 100644 --- a/artifacts/bicep/aws/aws.healthlake/default/types.json +++ b/artifacts/bicep/aws/aws.healthlake/default/types.json @@ -1 +1,278 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"CreatedAt","Properties":{"Nanos":{"Type":3,"Flags":1,"Description":"Nanoseconds."},"Seconds":{"Type":4,"Flags":1,"Description":"Seconds since epoch."}}}},{"2":{"Name":"DatastoreArn"}},{"2":{"Name":"DatastoreEndpoint"}},{"2":{"Name":"DatastoreId"}},{"2":{"Name":"DatastoreName"}},{"2":{"Name":"DatastoreStatus"}},{"2":{"Name":"DatastoreTypeVersion"}},{"2":{"Name":"IdentityProviderConfiguration","Properties":{"AuthorizationStrategy":{"Type":4,"Flags":1,"Description":"Type of Authorization Strategy. The two types of supported Authorization strategies are SMART_ON_FHIR_V1 and AWS_AUTH."},"FineGrainedAuthorizationEnabled":{"Type":2,"Flags":0,"Description":"Flag to indicate if fine-grained authorization will be enabled for the datastore"},"IdpLambdaArn":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) of the Lambda function that will be used to decode the access token created by the authorization server."},"Metadata":{"Type":4,"Flags":0,"Description":"The JSON metadata elements for identity provider configuration."}}}},{"2":{"Name":"KmsEncryptionConfig","Properties":{"CmkType":{"Type":4,"Flags":1,"Description":"The type of customer-managed-key (CMK) used for encryption. The two types of supported CMKs are customer owned CMKs and AWS owned CMKs."},"KmsKeyId":{"Type":4,"Flags":0,"Description":"The KMS encryption key id/alias used to encrypt the Data Store contents at rest."}}}},{"2":{"Name":"PreloadDataConfig","Properties":{"PreloadDataType":{"Type":4,"Flags":1,"Description":"The type of preloaded data. Only Synthea preloaded data is supported."}}}},{"2":{"Name":"SseConfiguration","Properties":{"KmsEncryptionConfig":{"Type":16,"Flags":1}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key of the tag."},"Value":{"Type":4,"Flags":1,"Description":"The value of the tag."}}}},{"2":{"Name":"AWS.HealthLake/FHIRDatastoreProperties","Properties":{"CreatedAt":{"Type":8,"Flags":2},"DatastoreArn":{"Type":4,"Flags":2},"DatastoreEndpoint":{"Type":4,"Flags":2},"DatastoreId":{"Type":4,"Flags":18},"DatastoreName":{"Type":4,"Flags":0},"DatastoreStatus":{"Type":4,"Flags":2},"DatastoreTypeVersion":{"Type":4,"Flags":1},"IdentityProviderConfiguration":{"Type":15,"Flags":0},"PreloadDataConfig":{"Type":17,"Flags":0},"SseConfiguration":{"Type":18,"Flags":0},"Tags":{"Type":21,"Flags":0}}}},{"3":{"ItemType":19}},{"2":{"Name":"AWS.HealthLake/FHIRDatastore","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":20,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.HealthLake/FHIRDatastore@default","ScopeType":0,"Body":22}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "CreatedAt", + "properties": { + "Nanos": { + "type": { + "$ref": "#/12" + }, + "flags": 1, + "description": "Nanoseconds." + }, + "Seconds": { + "type": { + "$ref": "#/13" + }, + "flags": 1, + "description": "Seconds since epoch." + } + } + }, + { + "$type": "ObjectType", + "name": "DatastoreArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DatastoreEndpoint", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DatastoreId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DatastoreName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DatastoreStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DatastoreTypeVersion", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "IdentityProviderConfiguration", + "properties": { + "AuthorizationStrategy": { + "type": { + "$ref": "#/13" + }, + "flags": 1, + "description": "Type of Authorization Strategy. The two types of supported Authorization strategies are SMART_ON_FHIR_V1 and AWS_AUTH." + }, + "FineGrainedAuthorizationEnabled": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "Flag to indicate if fine-grained authorization will be enabled for the datastore" + }, + "IdpLambdaArn": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the Lambda function that will be used to decode the access token created by the authorization server." + }, + "Metadata": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "The JSON metadata elements for identity provider configuration." + } + } + }, + { + "$type": "ObjectType", + "name": "KmsEncryptionConfig", + "properties": { + "CmkType": { + "type": { + "$ref": "#/13" + }, + "flags": 1, + "description": "The type of customer-managed-key (CMK) used for encryption. The two types of supported CMKs are customer owned CMKs and AWS owned CMKs." + }, + "KmsKeyId": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "The KMS encryption key id/alias used to encrypt the Data Store contents at rest." + } + } + }, + { + "$type": "ObjectType", + "name": "PreloadDataConfig", + "properties": { + "PreloadDataType": { + "type": { + "$ref": "#/13" + }, + "flags": 1, + "description": "The type of preloaded data. Only Synthea preloaded data is supported." + } + } + }, + { + "$type": "ObjectType", + "name": "SseConfiguration", + "properties": { + "KmsEncryptionConfig": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/13" + }, + "flags": 1, + "description": "The key of the tag." + }, + "Value": { + "type": { + "$ref": "#/13" + }, + "flags": 1, + "description": "The value of the tag." + } + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "StringType" + }, + { + "$type": "BooleanType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.HealthLake/FHIRDatastoreProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/11" + } + }, + { + "$type": "ObjectType", + "name": "AWS.HealthLake/FHIRDatastoreProperties", + "properties": { + "CreatedAt": { + "type": { + "$ref": "#/0" + }, + "flags": 2 + }, + "DatastoreArn": { + "type": { + "$ref": "#/13" + }, + "flags": 2 + }, + "DatastoreEndpoint": { + "type": { + "$ref": "#/13" + }, + "flags": 2 + }, + "DatastoreId": { + "type": { + "$ref": "#/13" + }, + "flags": 18 + }, + "DatastoreName": { + "type": { + "$ref": "#/13" + }, + "flags": 0 + }, + "DatastoreStatus": { + "type": { + "$ref": "#/13" + }, + "flags": 2 + }, + "DatastoreTypeVersion": { + "type": { + "$ref": "#/13" + }, + "flags": 1 + }, + "IdentityProviderConfiguration": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "PreloadDataConfig": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "SseConfiguration": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/16" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.HealthLake/FHIRDatastore", + "properties": { + "name": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/13" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/17" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.HealthLake/FHIRDatastore@default", + "scopeType": 0, + "body": { + "$ref": "#/18" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.healthlake/default/types.md b/artifacts/bicep/aws/aws.healthlake/default/types.md index 5965f4ad..c65b4fc0 100644 --- a/artifacts/bicep/aws/aws.healthlake/default/types.md +++ b/artifacts/bicep/aws/aws.healthlake/default/types.md @@ -3,9 +3,9 @@ ## Resource AWS.HealthLake/FHIRDatastore@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.HealthLake/FHIRDatastoreProperties](#awshealthlakefhirdatastoreproperties) (Required): properties of the resource +* **properties**: [AWS.HealthLake/FHIRDatastoreProperties](#awshealthlakefhirdatastoreproperties) (Required, Identifier): properties of the resource ## AWS.HealthLake/FHIRDatastoreProperties ### Properties @@ -33,6 +33,11 @@ * **IdpLambdaArn**: string: The Amazon Resource Name (ARN) of the Lambda function that will be used to decode the access token created by the authorization server. * **Metadata**: string: The JSON metadata elements for identity provider configuration. +## KmsEncryptionConfig +### Properties +* **CmkType**: string (Required): The type of customer-managed-key (CMK) used for encryption. The two types of supported CMKs are customer owned CMKs and AWS owned CMKs. +* **KmsKeyId**: string: The KMS encryption key id/alias used to encrypt the Data Store contents at rest. + ## PreloadDataConfig ### Properties * **PreloadDataType**: string (Required): The type of preloaded data. Only Synthea preloaded data is supported. @@ -41,11 +46,6 @@ ### Properties * **KmsEncryptionConfig**: [KmsEncryptionConfig](#kmsencryptionconfig) (Required) -## KmsEncryptionConfig -### Properties -* **CmkType**: string (Required): The type of customer-managed-key (CMK) used for encryption. The two types of supported CMKs are customer owned CMKs and AWS owned CMKs. -* **KmsKeyId**: string: The KMS encryption key id/alias used to encrypt the Data Store contents at rest. - ## Tag ### Properties * **Key**: string (Required): The key of the tag. diff --git a/artifacts/bicep/aws/aws.iam/default/types.json b/artifacts/bicep/aws/aws.iam/default/types.json index aca950a2..f7d1de43 100644 --- a/artifacts/bicep/aws/aws.iam/default/types.json +++ b/artifacts/bicep/aws/aws.iam/default/types.json @@ -1 +1,1552 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"Policy","Properties":{"PolicyDocument":{"Type":10,"Flags":1,"Description":"The policy document."},"PolicyName":{"Type":4,"Flags":1,"Description":"The friendly name (not ARN) identifying the policy."}}}},{"2":{"Name":"Group_PolicyDocument","Properties":{}}},{"5":{"Elements":[4,9]}},{"2":{"Name":"AWS.IAM/GroupProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"The Arn of the group to create"},"GroupName":{"Type":4,"Flags":16,"Description":"The name of the group to create"},"ManagedPolicyArns":{"Type":12,"Flags":0,"Description":"A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the role. "},"Path":{"Type":4,"Flags":0,"Description":"The path to the group"},"Policies":{"Type":13,"Flags":0,"Description":"Adds or updates an inline policy document that is embedded in the specified IAM group"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":8}},{"2":{"Name":"AWS.IAM/Group","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":11,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IAM/Group@default","ScopeType":0,"Body":14}},{"2":{"Name":"AWS.IAM/GroupPolicyProperties","Properties":{"GroupName":{"Type":4,"Flags":17,"Description":"The name of the group to associate the policy with."},"PolicyDocument":{"Type":17,"Flags":0,"Description":"The policy document."},"PolicyName":{"Type":4,"Flags":17,"Description":"The name of the policy document."}}}},{"2":{"Name":"GroupPolicy_PolicyDocument","Properties":{}}},{"2":{"Name":"AWS.IAM/GroupPolicy","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":16,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IAM/GroupPolicy@default","ScopeType":0,"Body":18}},{"2":{"Name":"AWS.IAM/InstanceProfileProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) of the instance profile."},"InstanceProfileName":{"Type":4,"Flags":16,"Description":"The name of the instance profile to create."},"Path":{"Type":4,"Flags":0,"Description":"The path to the instance profile."},"Roles":{"Type":21,"Flags":1,"Description":"The name of the role to associate with the instance profile. Only one role can be assigned to an EC2 instance at a time, and all applications on the instance share the same role and permissions."}}}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.IAM/InstanceProfile","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":20,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IAM/InstanceProfile@default","ScopeType":0,"Body":22}},{"2":{"Name":"AWS.IAM/ManagedPolicyProperties","Properties":{"AttachmentCount":{"Type":3,"Flags":2,"Description":"The number of entities (users, groups, and roles) that the policy is attached to."},"CreateDate":{"Type":4,"Flags":2,"Description":"The date and time, in ISO 8601 date-time format, when the policy was created."},"DefaultVersionId":{"Type":4,"Flags":2,"Description":"The identifier for the version of the policy that is set as the default version."},"Description":{"Type":4,"Flags":0,"Description":"A friendly description of the policy."},"Groups":{"Type":25,"Flags":0,"Description":"The name (friendly name, not ARN) of the group to attach the policy to."},"IsAttachable":{"Type":2,"Flags":2,"Description":"Specifies whether the policy can be attached to an IAM user, group, or role."},"ManagedPolicyName":{"Type":4,"Flags":0,"Description":"The friendly name of the policy."},"Path":{"Type":4,"Flags":0,"Description":"The path for the policy."},"PermissionsBoundaryUsageCount":{"Type":3,"Flags":2,"Description":"The number of entities (users and roles) for which the policy is used to set the permissions boundary."},"PolicyArn":{"Type":4,"Flags":18,"Description":"Amazon Resource Name (ARN) of the managed policy"},"PolicyDocument":{"Type":27,"Flags":1,"Description":"The JSON policy document that you want to use as the content for the new policy."},"PolicyId":{"Type":4,"Flags":2,"Description":"The stable and unique string identifying the policy."},"Roles":{"Type":28,"Flags":0,"Description":"The name (friendly name, not ARN) of the role to attach the policy to."},"UpdateDate":{"Type":4,"Flags":2,"Description":"The date and time, in ISO 8601 date-time format, when the policy was last updated."},"Users":{"Type":29,"Flags":0,"Description":"The name (friendly name, not ARN) of the IAM user to attach the policy to."}}}},{"3":{"ItemType":4}},{"2":{"Name":"ManagedPolicy_PolicyDocument","Properties":{}}},{"5":{"Elements":[26,4]}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.IAM/ManagedPolicy","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":24,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IAM/ManagedPolicy@default","ScopeType":0,"Body":30}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.IAM/OIDCProviderProperties","Properties":{"Arn":{"Type":4,"Flags":18,"Description":"Amazon Resource Name (ARN) of the OIDC provider"},"ClientIdList":{"Type":34,"Flags":0},"Tags":{"Type":35,"Flags":0},"ThumbprintList":{"Type":36,"Flags":1},"Url":{"Type":4,"Flags":0}}}},{"3":{"ItemType":4}},{"3":{"ItemType":32}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.IAM/OIDCProvider","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":33,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IAM/OIDCProvider@default","ScopeType":0,"Body":37}},{"2":{"Name":"Policy","Properties":{"PolicyDocument":{"Type":42,"Flags":1,"Description":"The policy document."},"PolicyName":{"Type":4,"Flags":1,"Description":"The friendly name (not ARN) identifying the policy."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"Role_PolicyDocument","Properties":{}}},{"5":{"Elements":[4,41]}},{"2":{"Name":"AWS.IAM/RoleProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) for the role."},"AssumeRolePolicyDocument":{"Type":45,"Flags":1,"Description":"The trust policy that is associated with this role."},"Description":{"Type":4,"Flags":0,"Description":"A description of the role that you provide."},"ManagedPolicyArns":{"Type":46,"Flags":0,"Description":"A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the role. "},"MaxSessionDuration":{"Type":3,"Flags":0,"Description":"The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default maximum of one hour is applied. This setting can have a value from 1 hour to 12 hours. "},"Path":{"Type":4,"Flags":0,"Description":"The path to the role."},"PermissionsBoundary":{"Type":4,"Flags":0,"Description":"The ARN of the policy used to set the permissions boundary for the role."},"Policies":{"Type":47,"Flags":0,"Description":"Adds or updates an inline policy document that is embedded in the specified IAM role. "},"RoleId":{"Type":4,"Flags":2,"Description":"The stable and unique string identifying the role."},"RoleName":{"Type":4,"Flags":16,"Description":"A name for the IAM role, up to 64 characters in length."},"Tags":{"Type":48,"Flags":0,"Description":"A list of tags that are attached to the role."}}}},{"2":{"Name":"Role_AssumeRolePolicyDocument","Properties":{}}},{"5":{"Elements":[44,4]}},{"3":{"ItemType":4}},{"3":{"ItemType":39}},{"3":{"ItemType":40}},{"2":{"Name":"AWS.IAM/Role","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":43,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IAM/Role@default","ScopeType":0,"Body":49}},{"2":{"Name":"AWS.IAM/RolePolicyProperties","Properties":{"PolicyDocument":{"Type":52,"Flags":0,"Description":"The policy document."},"PolicyName":{"Type":4,"Flags":17,"Description":"The friendly name (not ARN) identifying the policy."},"RoleName":{"Type":4,"Flags":17,"Description":"The name of the policy document."}}}},{"2":{"Name":"RolePolicy_PolicyDocument","Properties":{}}},{"2":{"Name":"AWS.IAM/RolePolicy","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":51,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IAM/RolePolicy@default","ScopeType":0,"Body":53}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.IAM/SAMLProviderProperties","Properties":{"Arn":{"Type":4,"Flags":18,"Description":"Amazon Resource Name (ARN) of the SAML provider"},"Name":{"Type":4,"Flags":0},"SamlMetadataDocument":{"Type":4,"Flags":1},"Tags":{"Type":57,"Flags":0}}}},{"3":{"ItemType":55}},{"2":{"Name":"AWS.IAM/SAMLProvider","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":56,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IAM/SAMLProvider@default","ScopeType":0,"Body":58}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.IAM/ServerCertificateProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"Amazon Resource Name (ARN) of the server certificate"},"CertificateBody":{"Type":4,"Flags":4},"CertificateChain":{"Type":4,"Flags":4},"Path":{"Type":4,"Flags":0},"PrivateKey":{"Type":4,"Flags":4},"ServerCertificateName":{"Type":4,"Flags":16},"Tags":{"Type":62,"Flags":0}}}},{"3":{"ItemType":60}},{"2":{"Name":"AWS.IAM/ServerCertificate","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":61,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IAM/ServerCertificate@default","ScopeType":0,"Body":63}},{"2":{"Name":"AWS.IAM/ServiceLinkedRoleProperties","Properties":{"AWSServiceName":{"Type":4,"Flags":4,"Description":"The service principal for the AWS service to which this role is attached."},"CustomSuffix":{"Type":4,"Flags":4,"Description":"A string that you provide, which is combined with the service-provided prefix to form the complete role name."},"Description":{"Type":4,"Flags":0,"Description":"The description of the role."},"RoleName":{"Type":4,"Flags":18,"Description":"The name of the role."}}}},{"2":{"Name":"AWS.IAM/ServiceLinkedRole","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":65,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IAM/ServiceLinkedRole@default","ScopeType":0,"Body":66}},{"2":{"Name":"LoginProfile","Properties":{"Password":{"Type":4,"Flags":5,"Description":"The user's password."},"PasswordResetRequired":{"Type":2,"Flags":0,"Description":"Specifies whether the user is required to set a new password on next sign-in."}}}},{"2":{"Name":"Policy","Properties":{"PolicyDocument":{"Type":72,"Flags":1,"Description":"The policy document."},"PolicyName":{"Type":4,"Flags":1,"Description":"The friendly name (not ARN) identifying the policy."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"User_PolicyDocument","Properties":{}}},{"5":{"Elements":[71,4]}},{"2":{"Name":"AWS.IAM/UserProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the IAM User Guide."},"Groups":{"Type":74,"Flags":0,"Description":"A list of group names to which you want to add the user."},"LoginProfile":{"Type":68,"Flags":0,"Description":"Creates a password for the specified IAM user. A password allows an IAM user to access AWS services through the AWS Management Console."},"ManagedPolicyArns":{"Type":75,"Flags":0,"Description":"A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the role."},"Path":{"Type":4,"Flags":0,"Description":"The path to the user. For more information about paths, see IAM identifiers in the IAM User Guide. The ARN of the policy used to set the permissions boundary for the user."},"PermissionsBoundary":{"Type":4,"Flags":0,"Description":"The ARN of the policy that is used to set the permissions boundary for the user."},"Policies":{"Type":76,"Flags":0,"Description":"Adds or updates an inline policy document that is embedded in the specified IAM role."},"Tags":{"Type":77,"Flags":0,"Description":"A list of tags that are associated with the user. For more information about tagging, see Tagging IAM resources in the IAM User Guide."},"UserName":{"Type":4,"Flags":16,"Description":"The friendly name identifying the user."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":69}},{"3":{"ItemType":70}},{"2":{"Name":"AWS.IAM/User","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":73,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IAM/User@default","ScopeType":0,"Body":78}},{"2":{"Name":"AWS.IAM/UserPolicyProperties","Properties":{"PolicyDocument":{"Type":81,"Flags":0,"Description":"The policy document."},"PolicyName":{"Type":4,"Flags":17,"Description":"The name of the policy document."},"UserName":{"Type":4,"Flags":17,"Description":"The name of the user to associate the policy with."}}}},{"2":{"Name":"UserPolicy_PolicyDocument","Properties":{}}},{"2":{"Name":"AWS.IAM/UserPolicy","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":80,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IAM/UserPolicy@default","ScopeType":0,"Body":82}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.IAM/VirtualMFADeviceProperties","Properties":{"Path":{"Type":4,"Flags":0},"SerialNumber":{"Type":4,"Flags":18},"Tags":{"Type":86,"Flags":0},"Users":{"Type":87,"Flags":1},"VirtualMfaDeviceName":{"Type":4,"Flags":0}}}},{"3":{"ItemType":84}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.IAM/VirtualMFADevice","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":85,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IAM/VirtualMFADevice@default","ScopeType":0,"Body":88}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Policy", + "properties": { + "PolicyDocument": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The policy document." + }, + "PolicyName": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The friendly name (not ARN) identifying the policy." + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "ObjectType", + "name": "Group_PolicyDocument", + "properties": {} + }, + { + "$type": "UnionType", + "elements": [ + { + "$ref": "#/1" + }, + { + "$ref": "#/2" + } + ] + }, + { + "$type": "StringLiteralType", + "value": "AWS.IAM/GroupProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ObjectType", + "name": "AWS.IAM/GroupProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "" + }, + "GroupName": { + "type": { + "$ref": "#/1" + }, + "flags": 16, + "description": "The name of the group to create. Do not include the path in this value.\n The group name must be unique within the account. Group names are not distinguished by case. For example, you cannot create groups named both \"ADMINS\" and \"admins\". If you don't specify a name, CFN generates a unique physical ID and uses that ID for the group name.\n If 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 If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities).\n Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using ``Fn::Join`` and ``AWS::Region`` to create a Region-specific name, as in the following example: ``{\"Fn::Join\": [\"\", [{\"Ref\": \"AWS::Region\"}, {\"Ref\": \"MyResourceName\"}]]}``." + }, + "ManagedPolicyArns": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the IAM policy you want to attach.\n For more information about ARNs, see [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*." + }, + "Path": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The path to the group. For more information about paths, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*.\n This parameter is optional. If it is not included, it defaults to a slash (/).\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\\u0021``) through the DEL character (``\\u007F``), including most punctuation characters, digits, and upper and lowercased letters." + }, + "Policies": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Adds or updates an inline policy document that is embedded in the specified IAM group. To view AWS::IAM::Group snippets, see [Declaring an Group Resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-iam-group).\n The name of each inline policy for a role, user, or group must be unique. If you don't choose unique names, updates to the IAM identity will fail. \n For information about limits on the number of inline policies that you can embed in a group, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IAM/Group", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/7" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IAM/Group@default", + "scopeType": 0, + "body": { + "$ref": "#/8" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.IAM/GroupPolicyProperties" + }, + { + "$type": "ObjectType", + "name": "GroupPolicy_PolicyDocument", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AWS.IAM/GroupPolicyProperties", + "properties": { + "GroupName": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The name of the group to associate the policy with.\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-." + }, + "PolicyDocument": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The policy document.\n You must provide policies in JSON format in IAM. However, for CFN templates formatted in YAML, you can provide the policy in JSON or YAML format. CFN always converts a YAML policy to JSON format before submitting it to IAM.\n The [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) used to validate this parameter is a string of characters consisting of the following:\n + Any printable ASCII 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 (through ``\\u00FF``)\n + The special characters tab (``\\u0009``), line feed (``\\u000A``), and carriage return (``\\u000D``)" + }, + "PolicyName": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The name of the policy document.\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IAM/GroupPolicy", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/12" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IAM/GroupPolicy@default", + "scopeType": 0, + "body": { + "$ref": "#/13" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.IAM/InstanceProfileProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "AWS.IAM/InstanceProfileProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "" + }, + "InstanceProfileName": { + "type": { + "$ref": "#/1" + }, + "flags": 16, + "description": "The name of the instance profile to create.\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-" + }, + "Path": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The path to the instance profile. For more information about paths, see [IAM Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*.\n This parameter is optional. If it is not included, it defaults to a slash (/).\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\\u0021``) through the DEL character (``\\u007F``), including most punctuation characters, digits, and upper and lowercased letters." + }, + "Roles": { + "type": { + "$ref": "#/16" + }, + "flags": 1, + "description": "The name of the role to associate with the instance profile. Only one role can be assigned to an EC2 instance at a time, and all applications on the instance share the same role and permissions." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IAM/InstanceProfile", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/17" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IAM/InstanceProfile@default", + "scopeType": 0, + "body": { + "$ref": "#/18" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.IAM/ManagedPolicyProperties" + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "ObjectType", + "name": "ManagedPolicy_PolicyDocument", + "properties": {} + }, + { + "$type": "UnionType", + "elements": [ + { + "$ref": "#/24" + }, + { + "$ref": "#/1" + } + ] + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "AWS.IAM/ManagedPolicyProperties", + "properties": { + "AttachmentCount": { + "type": { + "$ref": "#/21" + }, + "flags": 2, + "description": "" + }, + "CreateDate": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "" + }, + "DefaultVersionId": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "" + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A friendly description of the policy.\n Typically used to store information about the permissions defined in the policy. For example, \"Grants access to production DynamoDB tables.\"\n The policy description is immutable. After a value is assigned, it cannot be changed." + }, + "Groups": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "The name (friendly name, not ARN) of the group to attach the policy to.\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-" + }, + "IsAttachable": { + "type": { + "$ref": "#/23" + }, + "flags": 2, + "description": "" + }, + "ManagedPolicyName": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The friendly name of the policy.\n If 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 If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities).\n Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using ``Fn::Join`` and ``AWS::Region`` to create a Region-specific name, as in the following example: ``{\"Fn::Join\": [\"\", [{\"Ref\": \"AWS::Region\"}, {\"Ref\": \"MyResourceName\"}]]}``." + }, + "Path": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The path for the policy.\n For more information about paths, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*.\n This parameter is optional. If it is not included, it defaults to a slash (/).\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\\u0021``) through the DEL character (``\\u007F``), including most punctuation characters, digits, and upper and lowercased letters.\n You cannot use an asterisk (*) in the path name." + }, + "PermissionsBoundaryUsageCount": { + "type": { + "$ref": "#/21" + }, + "flags": 2, + "description": "" + }, + "PolicyArn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "" + }, + "PolicyDocument": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "The JSON policy document that you want to use as the content for the new policy.\n You must provide policies in JSON format in IAM. However, for CFN templates formatted in YAML, you can provide the policy in JSON or YAML format. CFN always converts a YAML policy to JSON format before submitting it to IAM.\n The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see [IAM and character quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length).\n To learn more about JSON policy grammar, see [Grammar of the IAM JSON policy language](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_grammar.html) in the *IAM User Guide*. \n The [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) used to validate this parameter is a string of characters consisting of the following:\n + Any printable ASCII 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 (through ``\\u00FF``)\n + The special characters tab (``\\u0009``), line feed (``\\u000A``), and carriage return (``\\u000D``)" + }, + "PolicyId": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "" + }, + "Roles": { + "type": { + "$ref": "#/26" + }, + "flags": 0, + "description": "The name (friendly name, not ARN) of the role to attach the policy to.\n This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-\n If an external policy (such as ``AWS::IAM::Policy`` or ``AWS::IAM::ManagedPolicy``) has a ``Ref`` to a role and if a resource (such as ``AWS::ECS::Service``) also has a ``Ref`` to the same role, add a ``DependsOn`` attribute to the resource to make the resource depend on the external policy. This dependency ensures that the role's policy is available throughout the resource's lifecycle. For example, when you delete a stack with an ``AWS::ECS::Service`` resource, the ``DependsOn`` attribute ensures that CFN deletes the ``AWS::ECS::Service`` resource before deleting its role's policy." + }, + "UpdateDate": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "" + }, + "Users": { + "type": { + "$ref": "#/27" + }, + "flags": 0, + "description": "The name (friendly name, not ARN) of the IAM user to attach the policy to.\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IAM/ManagedPolicy", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/28" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IAM/ManagedPolicy@default", + "scopeType": 0, + "body": { + "$ref": "#/29" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.IAM/OIDCProviderProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/31" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "AWS.IAM/OIDCProviderProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "Amazon Resource Name (ARN) of the OIDC provider" + }, + "ClientIdList": { + "type": { + "$ref": "#/33" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/34" + }, + "flags": 0 + }, + "ThumbprintList": { + "type": { + "$ref": "#/35" + }, + "flags": 1 + }, + "Url": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IAM/OIDCProvider", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/36" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IAM/OIDCProvider@default", + "scopeType": 0, + "body": { + "$ref": "#/37" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Policy", + "properties": { + "PolicyDocument": { + "type": { + "$ref": "#/42" + }, + "flags": 1, + "description": "The entire contents of the policy that defines permissions. For more information, see [Overview of JSON policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json)." + }, + "PolicyName": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The friendly name (not ARN) identifying the policy." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name that can be used to look up or retrieve the associated value. For example, ``Department`` or ``Cost Center`` are common choices." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value associated with this tag. For example, tags with a key name of ``Department`` could have values such as ``Human Resources``, ``Accounting``, and ``Support``. Tags with a key name of ``Cost Center`` might have values that consist of the number associated with the different cost centers in your company. Typically, many resources have tags with the same key name but with different values.\n AWS always interprets the tag ``Value`` as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code." + } + } + }, + { + "$type": "ObjectType", + "name": "Role_PolicyDocument", + "properties": {} + }, + { + "$type": "UnionType", + "elements": [ + { + "$ref": "#/1" + }, + { + "$ref": "#/41" + } + ] + }, + { + "$type": "StringLiteralType", + "value": "AWS.IAM/RoleProperties" + }, + { + "$type": "ObjectType", + "name": "Role_AssumeRolePolicyDocument", + "properties": {} + }, + { + "$type": "UnionType", + "elements": [ + { + "$ref": "#/44" + }, + { + "$ref": "#/1" + } + ] + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/39" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/40" + } + }, + { + "$type": "ObjectType", + "name": "AWS.IAM/RoleProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "" + }, + "AssumeRolePolicyDocument": { + "type": { + "$ref": "#/45" + }, + "flags": 1, + "description": "The trust policy that is associated with this role. Trust policies define which entities can assume the role. You can associate only one trust policy with a role. For an example of a policy that can be used to assume a role, see [Template Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#aws-resource-iam-role--examples). For more information about the elements that you can use in an IAM policy, see [Policy Elements Reference](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements.html) in the *User Guide*." + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A description of the role that you provide." + }, + "ManagedPolicyArns": { + "type": { + "$ref": "#/46" + }, + "flags": 0, + "description": "A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the role.\n For more information about ARNs, see [Amazon Resource Names (ARNs) and Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*." + }, + "MaxSessionDuration": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default value of one hour is applied. This setting can have a value from 1 hour to 12 hours.\n Anyone who assumes the role from the CLI or API can use the ``DurationSeconds`` API parameter or the ``duration-seconds`` CLI parameter to request a longer session. The ``MaxSessionDuration`` setting determines the maximum duration that can be requested using the ``DurationSeconds`` parameter. If users don't specify a value for the ``DurationSeconds`` parameter, their security credentials are valid for one hour by default. This applies when you use the ``AssumeRole*`` API operations or the ``assume-role*`` CLI operations but does not apply when you use those operations to create a console URL. For more information, see [Using IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html) in the *IAM User Guide*." + }, + "Path": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The path to the role. For more information about paths, see [IAM Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*.\n This parameter is optional. If it is not included, it defaults to a slash (/).\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\\u0021``) through the DEL character (``\\u007F``), including most punctuation characters, digits, and upper and lowercased letters." + }, + "PermissionsBoundary": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The ARN of the policy used to set the permissions boundary for the role.\n For more information about permissions boundaries, see [Permissions boundaries for IAM identities](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) in the *IAM User Guide*." + }, + "Policies": { + "type": { + "$ref": "#/47" + }, + "flags": 0, + "description": "Adds or updates an inline policy document that is embedded in the specified IAM role.\n When you embed an inline policy in a role, the inline policy is used as part of the role's access (permissions) policy. The role's trust policy is created at the same time as the role. You can update a role's trust policy later. For more information about IAM roles, go to [Using Roles to Delegate Permissions and Federate Identities](https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html).\n A role can also have an attached managed policy. For information about policies, see [Managed Policies and Inline Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *User Guide*.\n For information about limits on the number of inline policies that you can embed with a role, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*.\n If an external policy (such as ``AWS::IAM::Policy`` or" + }, + "RoleId": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "" + }, + "RoleName": { + "type": { + "$ref": "#/1" + }, + "flags": 16, + "description": "A name for the IAM role, up to 64 characters in length. For valid values, see the ``RoleName`` parameter for the [CreateRole](https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html) action in the *User Guide*.\n This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. The role name must be unique within the account. Role names are not distinguished by case. For example, you cannot create roles named both \"Role1\" and \"role1\".\n If you don't specify a name, CFN generates a unique physical ID and uses that ID for the role name.\n If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/Use" + }, + "Tags": { + "type": { + "$ref": "#/48" + }, + "flags": 0, + "description": "A list of tags that are attached to the role. For more information about tagging, see [Tagging IAM resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the *IAM User Guide*." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IAM/Role", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/49" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IAM/Role@default", + "scopeType": 0, + "body": { + "$ref": "#/50" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.IAM/RolePolicyProperties" + }, + { + "$type": "ObjectType", + "name": "RolePolicy_PolicyDocument", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AWS.IAM/RolePolicyProperties", + "properties": { + "PolicyDocument": { + "type": { + "$ref": "#/53" + }, + "flags": 0, + "description": "The policy document.\n You must provide policies in JSON format in IAM. However, for CFN templates formatted in YAML, you can provide the policy in JSON or YAML format. CFN always converts a YAML policy to JSON format before submitting it to IAM.\n The [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) used to validate this parameter is a string of characters consisting of the following:\n + Any printable ASCII 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 (through ``\\u00FF``)\n + The special characters tab (``\\u0009``), line feed (``\\u000A``), and carriage return (``\\u000D``)" + }, + "PolicyName": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The name of the policy document.\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-" + }, + "RoleName": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The name of the role to associate the policy with.\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IAM/RolePolicy", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/54" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IAM/RolePolicy@default", + "scopeType": 0, + "body": { + "$ref": "#/55" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.IAM/SAMLProviderProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/57" + } + }, + { + "$type": "ObjectType", + "name": "AWS.IAM/SAMLProviderProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "Amazon Resource Name (ARN) of the SAML provider" + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "SamlMetadataDocument": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/59" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IAM/SAMLProvider", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/60" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IAM/SAMLProvider@default", + "scopeType": 0, + "body": { + "$ref": "#/61" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.IAM/ServerCertificateProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/63" + } + }, + { + "$type": "ObjectType", + "name": "AWS.IAM/ServerCertificateProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "Amazon Resource Name (ARN) of the server certificate" + }, + "CertificateBody": { + "type": { + "$ref": "#/1" + }, + "flags": 4 + }, + "CertificateChain": { + "type": { + "$ref": "#/1" + }, + "flags": 4 + }, + "Path": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "PrivateKey": { + "type": { + "$ref": "#/1" + }, + "flags": 4 + }, + "ServerCertificateName": { + "type": { + "$ref": "#/1" + }, + "flags": 16 + }, + "Tags": { + "type": { + "$ref": "#/65" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IAM/ServerCertificate", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/66" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IAM/ServerCertificate@default", + "scopeType": 0, + "body": { + "$ref": "#/67" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.IAM/ServiceLinkedRoleProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.IAM/ServiceLinkedRoleProperties", + "properties": { + "AWSServiceName": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The service principal for the AWS service to which this role is attached." + }, + "CustomSuffix": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "A string that you provide, which is combined with the service-provided prefix to form the complete role name." + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The description of the role." + }, + "RoleName": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The name of the role." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IAM/ServiceLinkedRole", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/70" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IAM/ServiceLinkedRole@default", + "scopeType": 0, + "body": { + "$ref": "#/71" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "LoginProfile", + "properties": { + "Password": { + "type": { + "$ref": "#/1" + }, + "flags": 5, + "description": "The user's password." + }, + "PasswordResetRequired": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "Specifies whether the user is required to set a new password on next sign-in." + } + } + }, + { + "$type": "ObjectType", + "name": "Policy", + "properties": { + "PolicyDocument": { + "type": { + "$ref": "#/77" + }, + "flags": 1, + "description": "The entire contents of the policy that defines permissions. For more information, see [Overview of JSON policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json)." + }, + "PolicyName": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The friendly name (not ARN) identifying the policy." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name that can be used to look up or retrieve the associated value. For example, ``Department`` or ``Cost Center`` are common choices." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value associated with this tag. For example, tags with a key name of ``Department`` could have values such as ``Human Resources``, ``Accounting``, and ``Support``. Tags with a key name of ``Cost Center`` might have values that consist of the number associated with the different cost centers in your company. Typically, many resources have tags with the same key name but with different values.\n AWS always interprets the tag ``Value`` as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code." + } + } + }, + { + "$type": "ObjectType", + "name": "User_PolicyDocument", + "properties": {} + }, + { + "$type": "UnionType", + "elements": [ + { + "$ref": "#/76" + }, + { + "$ref": "#/1" + } + ] + }, + { + "$type": "StringLiteralType", + "value": "AWS.IAM/UserProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/74" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/75" + } + }, + { + "$type": "ObjectType", + "name": "AWS.IAM/UserProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "" + }, + "Groups": { + "type": { + "$ref": "#/79" + }, + "flags": 0, + "description": "A list of group names to which you want to add the user." + }, + "LoginProfile": { + "type": { + "$ref": "#/73" + }, + "flags": 0, + "description": "Creates a password for the specified IAM user. A password allows an IAM user to access AWS services through the console.\n You can use the CLI, the AWS API, or the *Users* page in the IAM console to create a password for any IAM user. Use [ChangePassword](https://docs.aws.amazon.com/IAM/latest/APIReference/API_ChangePassword.html) to update your own existing password in the *My Security Credentials* page in the console.\n For more information about managing passwords, see [Managing passwords](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html) in the *User Guide*." + }, + "ManagedPolicyArns": { + "type": { + "$ref": "#/80" + }, + "flags": 0, + "description": "A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the user.\n For more information about ARNs, see [Amazon Resource Names (ARNs) and Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*." + }, + "Path": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The path for the user name. For more information about paths, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*.\n This parameter is optional. If it is not included, it defaults to a slash (/).\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\\u0021``) through the DEL character (``\\u007F``), including most punctuation characters, digits, and upper and lowercased letters." + }, + "PermissionsBoundary": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The ARN of the managed policy that is used to set the permissions boundary for the user.\n A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a resource-based policy can grant to an entity. To learn more, see [Permissions boundaries for IAM entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) in the *IAM User Guide*.\n For 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*." + }, + "Policies": { + "type": { + "$ref": "#/81" + }, + "flags": 0, + "description": "Adds or updates an inline policy document that is embedded in the specified IAM user. To view AWS::IAM::User snippets, see [Declaring an User Resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-iam-user).\n The name of each policy for a role, user, or group must be unique. If you don't choose unique names, updates to the IAM identity will fail. \n For information about limits on the number of inline policies that you can embed in a user, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*." + }, + "Tags": { + "type": { + "$ref": "#/82" + }, + "flags": 0, + "description": "A list of tags that you want to attach to the new user. Each tag consists of a key name and an associated value. For more information about tagging, see [Tagging IAM resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the *IAM User Guide*.\n If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created." + }, + "UserName": { + "type": { + "$ref": "#/1" + }, + "flags": 16, + "description": "The name of the user to create. Do not include the path in this value.\n This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. The user name must be unique within the account. User names are not distinguished by case. For example, you cannot create users named both \"John\" and \"john\".\n If you don't specify a name, CFN generates a unique physical ID and uses that ID for the user name.\n If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities).\n Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using ``Fn::Join`` and ``AWS::Region`` to create a Region-specific name, as in the following example: ``{\"Fn::Join\": [\"\", [{\"Ref\": \"AWS::Region\"}, {\"Ref\": \"MyResourceName\"}]]}``." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IAM/User", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/83" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IAM/User@default", + "scopeType": 0, + "body": { + "$ref": "#/84" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.IAM/UserPolicyProperties" + }, + { + "$type": "ObjectType", + "name": "UserPolicy_PolicyDocument", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AWS.IAM/UserPolicyProperties", + "properties": { + "PolicyDocument": { + "type": { + "$ref": "#/87" + }, + "flags": 0, + "description": "The policy document.\n You must provide policies in JSON format in IAM. However, for CFN templates formatted in YAML, you can provide the policy in JSON or YAML format. CFN always converts a YAML policy to JSON format before submitting it to IAM.\n The [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) used to validate this parameter is a string of characters consisting of the following:\n + Any printable ASCII 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 (through ``\\u00FF``)\n + The special characters tab (``\\u0009``), line feed (``\\u000A``), and carriage return (``\\u000D``)" + }, + "PolicyName": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The name of the policy document.\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-" + }, + "UserName": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The name of the user to associate the policy with.\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IAM/UserPolicy", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/88" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IAM/UserPolicy@default", + "scopeType": 0, + "body": { + "$ref": "#/89" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.IAM/VirtualMFADeviceProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/91" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "AWS.IAM/VirtualMFADeviceProperties", + "properties": { + "Path": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "SerialNumber": { + "type": { + "$ref": "#/1" + }, + "flags": 18 + }, + "Tags": { + "type": { + "$ref": "#/93" + }, + "flags": 0 + }, + "Users": { + "type": { + "$ref": "#/94" + }, + "flags": 1 + }, + "VirtualMfaDeviceName": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IAM/VirtualMFADevice", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/95" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IAM/VirtualMFADevice@default", + "scopeType": 0, + "body": { + "$ref": "#/96" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.iam/default/types.md b/artifacts/bicep/aws/aws.iam/default/types.md index 9672636a..ecc07516 100644 --- a/artifacts/bicep/aws/aws.iam/default/types.md +++ b/artifacts/bicep/aws/aws.iam/default/types.md @@ -3,140 +3,171 @@ ## Resource AWS.IAM/Group@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IAM/GroupProperties](#awsiamgroupproperties): properties of the resource +* **properties**: [AWS.IAM/GroupProperties](#awsiamgroupproperties) (Identifier): properties of the resource ## Resource AWS.IAM/GroupPolicy@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IAM/GroupPolicyProperties](#awsiamgrouppolicyproperties) (Required): properties of the resource +* **properties**: [AWS.IAM/GroupPolicyProperties](#awsiamgrouppolicyproperties) (Required, Identifier): properties of the resource ## Resource AWS.IAM/InstanceProfile@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IAM/InstanceProfileProperties](#awsiaminstanceprofileproperties) (Required): properties of the resource +* **properties**: [AWS.IAM/InstanceProfileProperties](#awsiaminstanceprofileproperties) (Required, Identifier): properties of the resource ## Resource AWS.IAM/ManagedPolicy@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IAM/ManagedPolicyProperties](#awsiammanagedpolicyproperties) (Required): properties of the resource +* **properties**: [AWS.IAM/ManagedPolicyProperties](#awsiammanagedpolicyproperties) (Required, Identifier): properties of the resource ## Resource AWS.IAM/OIDCProvider@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IAM/OIDCProviderProperties](#awsiamoidcproviderproperties) (Required): properties of the resource +* **properties**: [AWS.IAM/OIDCProviderProperties](#awsiamoidcproviderproperties) (Required, Identifier): properties of the resource ## Resource AWS.IAM/Role@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IAM/RoleProperties](#awsiamroleproperties) (Required): properties of the resource +* **properties**: [AWS.IAM/RoleProperties](#awsiamroleproperties) (Required, Identifier): properties of the resource ## Resource AWS.IAM/RolePolicy@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IAM/RolePolicyProperties](#awsiamrolepolicyproperties) (Required): properties of the resource +* **properties**: [AWS.IAM/RolePolicyProperties](#awsiamrolepolicyproperties) (Required, Identifier): properties of the resource ## Resource AWS.IAM/SAMLProvider@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IAM/SAMLProviderProperties](#awsiamsamlproviderproperties) (Required): properties of the resource +* **properties**: [AWS.IAM/SAMLProviderProperties](#awsiamsamlproviderproperties) (Required, Identifier): properties of the resource ## Resource AWS.IAM/ServerCertificate@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IAM/ServerCertificateProperties](#awsiamservercertificateproperties): properties of the resource +* **properties**: [AWS.IAM/ServerCertificateProperties](#awsiamservercertificateproperties) (Identifier): properties of the resource ## Resource AWS.IAM/ServiceLinkedRole@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IAM/ServiceLinkedRoleProperties](#awsiamservicelinkedroleproperties): properties of the resource +* **properties**: [AWS.IAM/ServiceLinkedRoleProperties](#awsiamservicelinkedroleproperties) (Identifier): properties of the resource ## Resource AWS.IAM/User@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IAM/UserProperties](#awsiamuserproperties): properties of the resource +* **properties**: [AWS.IAM/UserProperties](#awsiamuserproperties) (Identifier): properties of the resource ## Resource AWS.IAM/UserPolicy@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IAM/UserPolicyProperties](#awsiamuserpolicyproperties) (Required): properties of the resource +* **properties**: [AWS.IAM/UserPolicyProperties](#awsiamuserpolicyproperties) (Required, Identifier): properties of the resource ## Resource AWS.IAM/VirtualMFADevice@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IAM/VirtualMFADeviceProperties](#awsiamvirtualmfadeviceproperties) (Required): properties of the resource - -## AWS.IAM/GroupProperties -### Properties -* **Arn**: string (ReadOnly): The Arn of the group to create -* **GroupName**: string (Identifier): The name of the group to create -* **ManagedPolicyArns**: string[]: A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the role. -* **Path**: string: The path to the group -* **Policies**: [Policy](#policy)[]: Adds or updates an inline policy document that is embedded in the specified IAM group - -## Policy -### Properties -* **PolicyDocument**: [Group_PolicyDocument](#grouppolicydocument) | string (Required): The policy document. -* **PolicyName**: string (Required): The friendly name (not ARN) identifying the policy. +* **properties**: [AWS.IAM/VirtualMFADeviceProperties](#awsiamvirtualmfadeviceproperties) (Required, Identifier): properties of the resource ## AWS.IAM/GroupPolicyProperties ### Properties * **GroupName**: string (Required, Identifier): The name of the group to associate the policy with. + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. * **PolicyDocument**: [GroupPolicy_PolicyDocument](#grouppolicypolicydocument): The policy document. + You must provide policies in JSON format in IAM. However, for CFN templates formatted in YAML, you can provide the policy in JSON or YAML format. CFN always converts a YAML policy to JSON format before submitting it to IAM. + The [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) used to validate this parameter is a string of characters consisting of the following: + + Any printable ASCII character ranging from the space character (``\u0020``) through the end of the ASCII character range + + The printable characters in the Basic Latin and Latin-1 Supplement character set (through ``\u00FF``) + + The special characters tab (``\u0009``), line feed (``\u000A``), and carriage return (``\u000D``) * **PolicyName**: string (Required, Identifier): The name of the policy document. + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- -## GroupPolicy_PolicyDocument +## AWS.IAM/GroupProperties ### Properties +* **Arn**: string (ReadOnly) +* **GroupName**: string (Identifier): The name of the group to create. Do not include the path in this value. + The group name must be unique within the account. Group names are not distinguished by case. For example, you cannot create groups named both "ADMINS" and "admins". If you don't specify a name, CFN generates a unique physical ID and uses that ID for the group name. + If 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. + If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities). + Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using ``Fn::Join`` and ``AWS::Region`` to create a Region-specific name, as in the following example: ``{"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}``. +* **ManagedPolicyArns**: string[]: The Amazon Resource Name (ARN) of the IAM policy you want to attach. + For more information about ARNs, see [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*. +* **Path**: string: The path to the group. For more information about paths, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*. + This parameter is optional. If it is not included, it defaults to a slash (/). + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\u0021``) through the DEL character (``\u007F``), including most punctuation characters, digits, and upper and lowercased letters. +* **Policies**: [Policy](#policy)[]: Adds or updates an inline policy document that is embedded in the specified IAM group. To view AWS::IAM::Group snippets, see [Declaring an Group Resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-iam-group). + The name of each inline policy for a role, user, or group must be unique. If you don't choose unique names, updates to the IAM identity will fail. + For information about limits on the number of inline policies that you can embed in a group, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*. ## AWS.IAM/InstanceProfileProperties ### Properties -* **Arn**: string (ReadOnly): The Amazon Resource Name (ARN) of the instance profile. +* **Arn**: string (ReadOnly) * **InstanceProfileName**: string (Identifier): The name of the instance profile to create. -* **Path**: string: The path to the instance profile. + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- +* **Path**: string: The path to the instance profile. For more information about paths, see [IAM Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*. + This parameter is optional. If it is not included, it defaults to a slash (/). + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\u0021``) through the DEL character (``\u007F``), including most punctuation characters, digits, and upper and lowercased letters. * **Roles**: string[] (Required): The name of the role to associate with the instance profile. Only one role can be assigned to an EC2 instance at a time, and all applications on the instance share the same role and permissions. ## AWS.IAM/ManagedPolicyProperties ### Properties -* **AttachmentCount**: int (ReadOnly): The number of entities (users, groups, and roles) that the policy is attached to. -* **CreateDate**: string (ReadOnly): The date and time, in ISO 8601 date-time format, when the policy was created. -* **DefaultVersionId**: string (ReadOnly): The identifier for the version of the policy that is set as the default version. +* **AttachmentCount**: int (ReadOnly) +* **CreateDate**: string (ReadOnly) +* **DefaultVersionId**: string (ReadOnly) * **Description**: string: A friendly description of the policy. + Typically used to store information about the permissions defined in the policy. For example, "Grants access to production DynamoDB tables." + The policy description is immutable. After a value is assigned, it cannot be changed. * **Groups**: string[]: The name (friendly name, not ARN) of the group to attach the policy to. -* **IsAttachable**: bool (ReadOnly): Specifies whether the policy can be attached to an IAM user, group, or role. + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- +* **IsAttachable**: bool (ReadOnly) * **ManagedPolicyName**: string: The friendly name of the policy. + If 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. + If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities). + Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using ``Fn::Join`` and ``AWS::Region`` to create a Region-specific name, as in the following example: ``{"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}``. * **Path**: string: The path for the policy. -* **PermissionsBoundaryUsageCount**: int (ReadOnly): The number of entities (users and roles) for which the policy is used to set the permissions boundary. -* **PolicyArn**: string (ReadOnly, Identifier): Amazon Resource Name (ARN) of the managed policy + For more information about paths, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*. + This parameter is optional. If it is not included, it defaults to a slash (/). + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\u0021``) through the DEL character (``\u007F``), including most punctuation characters, digits, and upper and lowercased letters. + You cannot use an asterisk (*) in the path name. +* **PermissionsBoundaryUsageCount**: int (ReadOnly) +* **PolicyArn**: string (ReadOnly, Identifier) * **PolicyDocument**: [ManagedPolicy_PolicyDocument](#managedpolicypolicydocument) | string (Required): The JSON policy document that you want to use as the content for the new policy. -* **PolicyId**: string (ReadOnly): The stable and unique string identifying the policy. + You must provide policies in JSON format in IAM. However, for CFN templates formatted in YAML, you can provide the policy in JSON or YAML format. CFN always converts a YAML policy to JSON format before submitting it to IAM. + The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see [IAM and character quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length). + To learn more about JSON policy grammar, see [Grammar of the IAM JSON policy language](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_grammar.html) in the *IAM User Guide*. + The [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) used to validate this parameter is a string of characters consisting of the following: + + Any printable ASCII character ranging from the space character (``\u0020``) through the end of the ASCII character range + + The printable characters in the Basic Latin and Latin-1 Supplement character set (through ``\u00FF``) + + The special characters tab (``\u0009``), line feed (``\u000A``), and carriage return (``\u000D``) +* **PolicyId**: string (ReadOnly) * **Roles**: string[]: The name (friendly name, not ARN) of the role to attach the policy to. -* **UpdateDate**: string (ReadOnly): The date and time, in ISO 8601 date-time format, when the policy was last updated. + This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + If an external policy (such as ``AWS::IAM::Policy`` or ``AWS::IAM::ManagedPolicy``) has a ``Ref`` to a role and if a resource (such as ``AWS::ECS::Service``) also has a ``Ref`` to the same role, add a ``DependsOn`` attribute to the resource to make the resource depend on the external policy. This dependency ensures that the role's policy is available throughout the resource's lifecycle. For example, when you delete a stack with an ``AWS::ECS::Service`` resource, the ``DependsOn`` attribute ensures that CFN deletes the ``AWS::ECS::Service`` resource before deleting its role's policy. +* **UpdateDate**: string (ReadOnly) * **Users**: string[]: The name (friendly name, not ARN) of the IAM user to attach the policy to. + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- ## AWS.IAM/OIDCProviderProperties ### Properties @@ -146,43 +177,44 @@ * **ThumbprintList**: string[] (Required) * **Url**: string -## Tag +## AWS.IAM/RolePolicyProperties ### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **PolicyDocument**: [RolePolicy_PolicyDocument](#rolepolicypolicydocument): The policy document. + You must provide policies in JSON format in IAM. However, for CFN templates formatted in YAML, you can provide the policy in JSON or YAML format. CFN always converts a YAML policy to JSON format before submitting it to IAM. + The [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) used to validate this parameter is a string of characters consisting of the following: + + Any printable ASCII character ranging from the space character (``\u0020``) through the end of the ASCII character range + + The printable characters in the Basic Latin and Latin-1 Supplement character set (through ``\u00FF``) + + The special characters tab (``\u0009``), line feed (``\u000A``), and carriage return (``\u000D``) +* **PolicyName**: string (Required, Identifier): The name of the policy document. + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- +* **RoleName**: string (Required, Identifier): The name of the role to associate the policy with. + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- ## AWS.IAM/RoleProperties ### Properties -* **Arn**: string (ReadOnly): The Amazon Resource Name (ARN) for the role. -* **AssumeRolePolicyDocument**: [Role_AssumeRolePolicyDocument](#roleassumerolepolicydocument) | string (Required): The trust policy that is associated with this role. +* **Arn**: string (ReadOnly) +* **AssumeRolePolicyDocument**: [Role_AssumeRolePolicyDocument](#roleassumerolepolicydocument) | string (Required): The trust policy that is associated with this role. Trust policies define which entities can assume the role. You can associate only one trust policy with a role. For an example of a policy that can be used to assume a role, see [Template Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#aws-resource-iam-role--examples). For more information about the elements that you can use in an IAM policy, see [Policy Elements Reference](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements.html) in the *User Guide*. * **Description**: string: A description of the role that you provide. -* **ManagedPolicyArns**: string[]: A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the role. -* **MaxSessionDuration**: int: The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default maximum of one hour is applied. This setting can have a value from 1 hour to 12 hours. -* **Path**: string: The path to the role. +* **ManagedPolicyArns**: string[]: A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the role. + For more information about ARNs, see [Amazon Resource Names (ARNs) and Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*. +* **MaxSessionDuration**: int: The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default value of one hour is applied. This setting can have a value from 1 hour to 12 hours. + Anyone who assumes the role from the CLI or API can use the ``DurationSeconds`` API parameter or the ``duration-seconds`` CLI parameter to request a longer session. The ``MaxSessionDuration`` setting determines the maximum duration that can be requested using the ``DurationSeconds`` parameter. If users don't specify a value for the ``DurationSeconds`` parameter, their security credentials are valid for one hour by default. This applies when you use the ``AssumeRole*`` API operations or the ``assume-role*`` CLI operations but does not apply when you use those operations to create a console URL. For more information, see [Using IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html) in the *IAM User Guide*. +* **Path**: string: The path to the role. For more information about paths, see [IAM Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*. + This parameter is optional. If it is not included, it defaults to a slash (/). + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\u0021``) through the DEL character (``\u007F``), including most punctuation characters, digits, and upper and lowercased letters. * **PermissionsBoundary**: string: The ARN of the policy used to set the permissions boundary for the role. -* **Policies**: [Policy](#policy)[]: Adds or updates an inline policy document that is embedded in the specified IAM role. -* **RoleId**: string (ReadOnly): The stable and unique string identifying the role. -* **RoleName**: string (Identifier): A name for the IAM role, up to 64 characters in length. -* **Tags**: [Tag](#tag)[]: A list of tags that are attached to the role. - -## Policy -### Properties -* **PolicyDocument**: [Role_PolicyDocument](#rolepolicydocument) | string (Required): The policy document. -* **PolicyName**: string (Required): The friendly name (not ARN) identifying the policy. - -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - -## AWS.IAM/RolePolicyProperties -### Properties -* **PolicyDocument**: [RolePolicy_PolicyDocument](#rolepolicypolicydocument): The policy document. -* **PolicyName**: string (Required, Identifier): The friendly name (not ARN) identifying the policy. -* **RoleName**: string (Required, Identifier): The name of the policy document. - -## RolePolicy_PolicyDocument -### Properties + For more information about permissions boundaries, see [Permissions boundaries for IAM identities](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) in the *IAM User Guide*. +* **Policies**: [Policy](#policy)[]: Adds or updates an inline policy document that is embedded in the specified IAM role. + When you embed an inline policy in a role, the inline policy is used as part of the role's access (permissions) policy. The role's trust policy is created at the same time as the role. You can update a role's trust policy later. For more information about IAM roles, go to [Using Roles to Delegate Permissions and Federate Identities](https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html). + A role can also have an attached managed policy. For information about policies, see [Managed Policies and Inline Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *User Guide*. + For information about limits on the number of inline policies that you can embed with a role, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*. + If an external policy (such as ``AWS::IAM::Policy`` or +* **RoleId**: string (ReadOnly) +* **RoleName**: string (Identifier): A name for the IAM role, up to 64 characters in length. For valid values, see the ``RoleName`` parameter for the [CreateRole](https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html) action in the *User Guide*. + This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. The role name must be unique within the account. Role names are not distinguished by case. For example, you cannot create roles named both "Role1" and "role1". + If you don't specify a name, CFN generates a unique physical ID and uses that ID for the role name. + If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/Use +* **Tags**: [Tag](#tag)[]: A list of tags that are attached to the role. For more information about tagging, see [Tagging IAM resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the *IAM User Guide*. ## AWS.IAM/SAMLProviderProperties ### Properties @@ -191,11 +223,6 @@ * **SamlMetadataDocument**: string (Required) * **Tags**: [Tag](#tag)[] -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## AWS.IAM/ServerCertificateProperties ### Properties * **Arn**: string (ReadOnly): Amazon Resource Name (ARN) of the server certificate @@ -206,11 +233,6 @@ * **ServerCertificateName**: string (Identifier) * **Tags**: [Tag](#tag)[] -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## AWS.IAM/ServiceLinkedRoleProperties ### Properties * **AWSServiceName**: string (WriteOnly): The service principal for the AWS service to which this role is attached. @@ -218,17 +240,55 @@ * **Description**: string: The description of the role. * **RoleName**: string (ReadOnly, Identifier): The name of the role. +## AWS.IAM/UserPolicyProperties +### Properties +* **PolicyDocument**: [UserPolicy_PolicyDocument](#userpolicypolicydocument): The policy document. + You must provide policies in JSON format in IAM. However, for CFN templates formatted in YAML, you can provide the policy in JSON or YAML format. CFN always converts a YAML policy to JSON format before submitting it to IAM. + The [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) used to validate this parameter is a string of characters consisting of the following: + + Any printable ASCII character ranging from the space character (``\u0020``) through the end of the ASCII character range + + The printable characters in the Basic Latin and Latin-1 Supplement character set (through ``\u00FF``) + + The special characters tab (``\u0009``), line feed (``\u000A``), and carriage return (``\u000D``) +* **PolicyName**: string (Required, Identifier): The name of the policy document. + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- +* **UserName**: string (Required, Identifier): The name of the user to associate the policy with. + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + ## AWS.IAM/UserProperties ### Properties -* **Arn**: string (ReadOnly): The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the IAM User Guide. +* **Arn**: string (ReadOnly) * **Groups**: string[]: A list of group names to which you want to add the user. -* **LoginProfile**: [LoginProfile](#loginprofile): Creates a password for the specified IAM user. A password allows an IAM user to access AWS services through the AWS Management Console. -* **ManagedPolicyArns**: string[]: A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the role. -* **Path**: string: The path to the user. For more information about paths, see IAM identifiers in the IAM User Guide. The ARN of the policy used to set the permissions boundary for the user. -* **PermissionsBoundary**: string: The ARN of the policy that is used to set the permissions boundary for the user. -* **Policies**: [Policy](#policy)[]: Adds or updates an inline policy document that is embedded in the specified IAM role. -* **Tags**: [Tag](#tag)[]: A list of tags that are associated with the user. For more information about tagging, see Tagging IAM resources in the IAM User Guide. -* **UserName**: string (Identifier): The friendly name identifying the user. +* **LoginProfile**: [LoginProfile](#loginprofile): Creates a password for the specified IAM user. A password allows an IAM user to access AWS services through the console. + You can use the CLI, the AWS API, or the *Users* page in the IAM console to create a password for any IAM user. Use [ChangePassword](https://docs.aws.amazon.com/IAM/latest/APIReference/API_ChangePassword.html) to update your own existing password in the *My Security Credentials* page in the console. + For more information about managing passwords, see [Managing passwords](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html) in the *User Guide*. +* **ManagedPolicyArns**: string[]: A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the user. + For more information about ARNs, see [Amazon Resource Names (ARNs) and Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*. +* **Path**: string: The path for the user name. For more information about paths, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*. + This parameter is optional. If it is not included, it defaults to a slash (/). + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\u0021``) through the DEL character (``\u007F``), including most punctuation characters, digits, and upper and lowercased letters. +* **PermissionsBoundary**: string: The ARN of the managed policy that is used to set the permissions boundary for the user. + A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a resource-based policy can grant to an entity. To learn more, see [Permissions boundaries for IAM entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) in the *IAM User Guide*. + For 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*. +* **Policies**: [Policy](#policy)[]: Adds or updates an inline policy document that is embedded in the specified IAM user. To view AWS::IAM::User snippets, see [Declaring an User Resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-iam-user). + The name of each policy for a role, user, or group must be unique. If you don't choose unique names, updates to the IAM identity will fail. + For information about limits on the number of inline policies that you can embed in a user, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*. +* **Tags**: [Tag](#tag)[]: A list of tags that you want to attach to the new user. Each tag consists of a key name and an associated value. For more information about tagging, see [Tagging IAM resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the *IAM User Guide*. + If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. +* **UserName**: string (Identifier): The name of the user to create. Do not include the path in this value. + This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. The user name must be unique within the account. User names are not distinguished by case. For example, you cannot create users named both "John" and "john". + If you don't specify a name, CFN generates a unique physical ID and uses that ID for the user name. + If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities). + Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using ``Fn::Join`` and ``AWS::Region`` to create a Region-specific name, as in the following example: ``{"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}``. + +## AWS.IAM/VirtualMFADeviceProperties +### Properties +* **Path**: string +* **SerialNumber**: string (ReadOnly, Identifier) +* **Tags**: [Tag](#tag)[] +* **Users**: string[] (Required) +* **VirtualMfaDeviceName**: string + +## GroupPolicy_PolicyDocument +### Properties ## LoginProfile ### Properties @@ -237,33 +297,54 @@ ## Policy ### Properties -* **PolicyDocument**: [User_PolicyDocument](#userpolicydocument) | string (Required): The policy document. +* **PolicyDocument**: [Group_PolicyDocument](#grouppolicydocument) | string (Required): The policy document. +* **PolicyName**: string (Required): The friendly name (not ARN) identifying the policy. + +## Policy +### Properties +* **PolicyDocument**: [Role_PolicyDocument](#rolepolicydocument) | string (Required): The entire contents of the policy that defines permissions. For more information, see [Overview of JSON policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json). +* **PolicyName**: string (Required): The friendly name (not ARN) identifying the policy. + +## Policy +### Properties +* **PolicyDocument**: [User_PolicyDocument](#userpolicydocument) | string (Required): The entire contents of the policy that defines permissions. For more information, see [Overview of JSON policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json). * **PolicyName**: string (Required): The friendly name (not ARN) identifying the policy. +## RolePolicy_PolicyDocument +### Properties + ## Tag ### Properties * **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. * **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -## AWS.IAM/UserPolicyProperties +## Tag ### Properties -* **PolicyDocument**: [UserPolicy_PolicyDocument](#userpolicypolicydocument): The policy document. -* **PolicyName**: string (Required, Identifier): The name of the policy document. -* **UserName**: string (Required, Identifier): The name of the user to associate the policy with. +* **Key**: string (Required): The key name that can be used to look up or retrieve the associated value. For example, ``Department`` or ``Cost Center`` are common choices. +* **Value**: string (Required): The value associated with this tag. For example, tags with a key name of ``Department`` could have values such as ``Human Resources``, ``Accounting``, and ``Support``. Tags with a key name of ``Cost Center`` might have values that consist of the number associated with the different cost centers in your company. Typically, many resources have tags with the same key name but with different values. + AWS always interprets the tag ``Value`` as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code. -## UserPolicy_PolicyDocument +## Tag ### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -## AWS.IAM/VirtualMFADeviceProperties +## Tag ### Properties -* **Path**: string -* **SerialNumber**: string (ReadOnly, Identifier) -* **Tags**: [Tag](#tag)[] -* **Users**: string[] (Required) -* **VirtualMfaDeviceName**: string +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## Tag +### Properties +* **Key**: string (Required): The key name that can be used to look up or retrieve the associated value. For example, ``Department`` or ``Cost Center`` are common choices. +* **Value**: string (Required): The value associated with this tag. For example, tags with a key name of ``Department`` could have values such as ``Human Resources``, ``Accounting``, and ``Support``. Tags with a key name of ``Cost Center`` might have values that consist of the number associated with the different cost centers in your company. Typically, many resources have tags with the same key name but with different values. + AWS always interprets the tag ``Value`` as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code. ## Tag ### Properties * **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. * **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +## UserPolicy_PolicyDocument +### Properties + diff --git a/artifacts/bicep/aws/aws.identitystore/default/types.json b/artifacts/bicep/aws/aws.identitystore/default/types.json index 78fb1a52..c4bbc7c6 100644 --- a/artifacts/bicep/aws/aws.identitystore/default/types.json +++ b/artifacts/bicep/aws/aws.identitystore/default/types.json @@ -1 +1,79 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"AWS.IdentityStore/GroupProperties","Properties":{"Description":{"Type":4,"Flags":0,"Description":"A string containing the description of the group."},"DisplayName":{"Type":4,"Flags":1,"Description":"A string containing the name of the group. This value is commonly displayed when the group is referenced."},"GroupId":{"Type":4,"Flags":18,"Description":"The unique identifier for a group in the identity store."},"IdentityStoreId":{"Type":4,"Flags":17,"Description":"The globally unique identifier for the identity store."}}}},{"2":{"Name":"AWS.IdentityStore/Group","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":8,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IdentityStore/Group@default","ScopeType":0,"Body":9}}] \ No newline at end of file +[ + { + "$type": "StringLiteralType", + "value": "AWS.IdentityStore/GroupProperties" + }, + { + "$type": "StringType" + }, + { + "$type": "ObjectType", + "name": "AWS.IdentityStore/GroupProperties", + "properties": { + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A string containing the description of the group." + }, + "DisplayName": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "A string containing the name of the group. This value is commonly displayed when the group is referenced." + }, + "GroupId": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The unique identifier for a group in the identity store." + }, + "IdentityStoreId": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The globally unique identifier for the identity store." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IdentityStore/Group", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IdentityStore/Group@default", + "scopeType": 0, + "body": { + "$ref": "#/3" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.identitystore/default/types.md b/artifacts/bicep/aws/aws.identitystore/default/types.md index a98da41f..a3d5b635 100644 --- a/artifacts/bicep/aws/aws.identitystore/default/types.md +++ b/artifacts/bicep/aws/aws.identitystore/default/types.md @@ -3,9 +3,9 @@ ## Resource AWS.IdentityStore/Group@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IdentityStore/GroupProperties](#awsidentitystoregroupproperties) (Required): properties of the resource +* **properties**: [AWS.IdentityStore/GroupProperties](#awsidentitystoregroupproperties) (Required, Identifier): properties of the resource ## AWS.IdentityStore/GroupProperties ### Properties diff --git a/artifacts/bicep/aws/aws.imagebuilder/default/types.json b/artifacts/bicep/aws/aws.imagebuilder/default/types.json index a3703b9b..448d836e 100644 --- a/artifacts/bicep/aws/aws.imagebuilder/default/types.json +++ b/artifacts/bicep/aws/aws.imagebuilder/default/types.json @@ -1 +1,1386 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"AmiDistributionConfiguration","Properties":{"AmiTags":{"Type":18,"Flags":0,"Description":"The tags to apply to AMIs distributed to this Region."},"Description":{"Type":4,"Flags":0,"Description":"The description of the AMI distribution configuration."},"KmsKeyId":{"Type":4,"Flags":0,"Description":"The KMS key identifier used to encrypt the distributed image."},"LaunchPermissionConfiguration":{"Type":14,"Flags":0},"Name":{"Type":4,"Flags":0,"Description":"The name of the AMI distribution configuration."},"TargetAccountIds":{"Type":19,"Flags":0,"Description":"The ID of accounts to which you want to distribute an image."}}}},{"2":{"Name":"ContainerDistributionConfiguration","Properties":{"ContainerTags":{"Type":20,"Flags":0,"Description":"Tags that are attached to the container distribution configuration."},"Description":{"Type":4,"Flags":0,"Description":"The description of the container distribution configuration."},"TargetRepository":{"Type":17,"Flags":0,"Description":"The destination repository for the container distribution configuration."}}}},{"2":{"Name":"Distribution","Properties":{"AmiDistributionConfiguration":{"Type":8,"Flags":0},"ContainerDistributionConfiguration":{"Type":9,"Flags":0},"FastLaunchConfigurations":{"Type":21,"Flags":0,"Description":"The Windows faster-launching configurations to use for AMI distribution."},"LaunchTemplateConfigurations":{"Type":22,"Flags":0,"Description":"A group of launchTemplateConfiguration settings that apply to image distribution."},"LicenseConfigurationArns":{"Type":23,"Flags":0,"Description":"The License Manager Configuration to associate with the AMI in the specified Region."},"Region":{"Type":4,"Flags":1,"Description":"region"}}}},{"2":{"Name":"FastLaunchConfiguration","Properties":{"AccountId":{"Type":4,"Flags":0,"Description":"The owner account ID for the fast-launch enabled Windows AMI."},"Enabled":{"Type":2,"Flags":0,"Description":"A Boolean that represents the current state of faster launching for the Windows AMI. Set to true to start using Windows faster launching, or false to stop using it."},"LaunchTemplate":{"Type":12,"Flags":0,"Description":"The launch template that the fast-launch enabled Windows AMI uses when it launches Windows instances to create pre-provisioned snapshots."},"MaxParallelLaunches":{"Type":3,"Flags":0,"Description":"The maximum number of parallel instances that are launched for creating resources."},"SnapshotConfiguration":{"Type":13,"Flags":0,"Description":"Configuration settings for managing the number of snapshots that are created from pre-provisioned instances for the Windows AMI when faster launching is enabled."}}}},{"2":{"Name":"FastLaunchLaunchTemplateSpecification","Properties":{"LaunchTemplateId":{"Type":4,"Flags":0,"Description":"The ID of the launch template to use for faster launching for a Windows AMI."},"LaunchTemplateName":{"Type":4,"Flags":0,"Description":"The name of the launch template to use for faster launching for a Windows AMI."},"LaunchTemplateVersion":{"Type":4,"Flags":0,"Description":"The version of the launch template to use for faster launching for a Windows AMI."}}}},{"2":{"Name":"FastLaunchSnapshotConfiguration","Properties":{"TargetResourceCount":{"Type":3,"Flags":0,"Description":"The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled Windows AMI."}}}},{"2":{"Name":"LaunchPermissionConfiguration","Properties":{"OrganizationArns":{"Type":24,"Flags":0,"Description":"The ARN for an Amazon Web Services Organization that you want to share your AMI with."},"OrganizationalUnitArns":{"Type":25,"Flags":0,"Description":"The ARN for an Organizations organizational unit (OU) that you want to share your AMI with."},"UserGroups":{"Type":26,"Flags":0,"Description":"The name of the group."},"UserIds":{"Type":27,"Flags":0,"Description":"The AWS account ID."}}}},{"2":{"Name":"LaunchTemplateConfiguration","Properties":{"AccountId":{"Type":4,"Flags":0,"Description":"The account ID that this configuration applies to."},"LaunchTemplateId":{"Type":4,"Flags":0,"Description":"Identifies the EC2 launch template to use."},"SetDefaultVersion":{"Type":2,"Flags":0,"Description":"Set the specified EC2 launch template as the default launch template for the specified account."}}}},{"2":{"Name":"LicenseConfigurationArn"}},{"2":{"Name":"TargetContainerRepository","Properties":{"RepositoryName":{"Type":4,"Flags":0,"Description":"The repository name of target container repository."},"Service":{"Type":4,"Flags":0,"Description":"The service of target container repository."}}}},{"2":{"Name":"DistributionConfiguration_AmiTags","Properties":{}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":11}},{"3":{"ItemType":15}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.ImageBuilder/DistributionConfigurationProperties","Properties":{"Arn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN) of the distribution configuration."},"Description":{"Type":4,"Flags":0,"Description":"The description of the distribution configuration."},"Distributions":{"Type":29,"Flags":1,"Description":"The distributions of the distribution configuration."},"Name":{"Type":4,"Flags":1,"Description":"The name of the distribution configuration."},"Tags":{"Type":30,"Flags":0,"Description":"The tags associated with the component."}}}},{"3":{"ItemType":10}},{"2":{"Name":"DistributionConfiguration_Tags","Properties":{}}},{"2":{"Name":"AWS.ImageBuilder/DistributionConfiguration","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":28,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ImageBuilder/DistributionConfiguration@default","ScopeType":0,"Body":31}},{"2":{"Name":"EcrConfiguration","Properties":{"ContainerTags":{"Type":40,"Flags":0,"Description":"Tags for Image Builder to apply the output container image that is scanned. Tags can help you identify and manage your scanned images."},"RepositoryName":{"Type":4,"Flags":0,"Description":"The name of the container repository that Amazon Inspector scans to identify findings for your container images. The name includes the path for the repository location. If you don't provide this information, Image Builder creates a repository in your account named image-builder-image-scanning-repository to use for vulnerability scans for your output container images."}}}},{"2":{"Name":"ImageScanningConfiguration","Properties":{"EcrConfiguration":{"Type":33,"Flags":0,"Description":"Contains ECR settings for vulnerability scans."},"ImageScanningEnabled":{"Type":2,"Flags":0,"Description":"This sets whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image."}}}},{"2":{"Name":"ImageTestsConfiguration","Properties":{"ImageTestsEnabled":{"Type":2,"Flags":0,"Description":"Defines if tests should be executed when building this image."},"TimeoutMinutes":{"Type":3,"Flags":0,"Description":"The maximum time in minutes that tests are permitted to run."}}}},{"2":{"Name":"Schedule","Properties":{"PipelineExecutionStartCondition":{"Type":4,"Flags":0,"Description":"The condition configures when the pipeline should trigger a new image build."},"ScheduleExpression":{"Type":4,"Flags":0,"Description":"The expression determines how often EC2 Image Builder evaluates your pipelineExecutionStartCondition."}}}},{"2":{"Name":"WorkflowConfiguration","Properties":{"OnFailure":{"Type":4,"Flags":0,"Description":"Define execution decision in case of workflow failure"},"ParallelGroup":{"Type":4,"Flags":0,"Description":"The parallel group name"},"Parameters":{"Type":41,"Flags":0,"Description":"The parameters associated with the workflow"},"WorkflowArn":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) of the workflow"}}}},{"2":{"Name":"WorkflowParameter","Properties":{"Name":{"Type":4,"Flags":0},"Value":{"Type":42,"Flags":0}}}},{"2":{"Name":"WorkflowParameterValue"}},{"3":{"ItemType":4}},{"3":{"ItemType":38}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.ImageBuilder/ImagePipelineProperties","Properties":{"Arn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN) of the image pipeline."},"ContainerRecipeArn":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested."},"Description":{"Type":4,"Flags":0,"Description":"The description of the image pipeline."},"DistributionConfigurationArn":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline."},"EnhancedImageMetadataEnabled":{"Type":2,"Flags":0,"Description":"Collects additional information about the image being created, including the operating system (OS) version and package list."},"ExecutionRole":{"Type":4,"Flags":0,"Description":"The execution role name/ARN for the image build, if provided"},"ImageRecipeArn":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed."},"ImageScanningConfiguration":{"Type":34,"Flags":0,"Description":"Contains settings for vulnerability scans."},"ImageTestsConfiguration":{"Type":35,"Flags":0,"Description":"The image tests configuration of the image pipeline."},"InfrastructureConfigurationArn":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline."},"Name":{"Type":4,"Flags":1,"Description":"The name of the image pipeline."},"Schedule":{"Type":36,"Flags":0,"Description":"The schedule of the image pipeline."},"Status":{"Type":4,"Flags":0,"Description":"The status of the image pipeline."},"Tags":{"Type":44,"Flags":0,"Description":"The tags of this image pipeline."},"Workflows":{"Type":45,"Flags":0,"Description":"Workflows to define the image build process"}}}},{"2":{"Name":"ImagePipeline_Tags","Properties":{}}},{"3":{"ItemType":37}},{"2":{"Name":"AWS.ImageBuilder/ImagePipeline","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":43,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ImageBuilder/ImagePipeline@default","ScopeType":0,"Body":46}},{"2":{"Name":"InstanceMetadataOptions","Properties":{"HttpPutResponseHopLimit":{"Type":3,"Flags":0,"Description":"Limit the number of hops that an instance metadata request can traverse to reach its destination."},"HttpTokens":{"Type":4,"Flags":0,"Description":"Indicates whether a signed token header is required for instance metadata retrieval requests. The values affect the response as follows: "}}}},{"2":{"Name":"Logging","Properties":{"S3Logs":{"Type":50,"Flags":0}}}},{"2":{"Name":"S3Logs","Properties":{"S3BucketName":{"Type":4,"Flags":0,"Description":"S3BucketName"},"S3KeyPrefix":{"Type":4,"Flags":0,"Description":"S3KeyPrefix"}}}},{"2":{"Name":"TagMap","Properties":{"TagKey":{"Type":4,"Flags":0,"Description":"TagKey"},"TagValue":{"Type":4,"Flags":0,"Description":"TagValue"}}}},{"2":{"Name":"AWS.ImageBuilder/InfrastructureConfigurationProperties","Properties":{"Arn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN) of the infrastructure configuration."},"Description":{"Type":4,"Flags":0,"Description":"The description of the infrastructure configuration."},"InstanceMetadataOptions":{"Type":48,"Flags":0,"Description":"The instance metadata option settings for the infrastructure configuration."},"InstanceProfileName":{"Type":4,"Flags":1,"Description":"The instance profile of the infrastructure configuration."},"InstanceTypes":{"Type":53,"Flags":0,"Description":"The instance types of the infrastructure configuration."},"KeyPair":{"Type":4,"Flags":0,"Description":"The EC2 key pair of the infrastructure configuration.."},"Logging":{"Type":49,"Flags":0,"Description":"The logging configuration of the infrastructure configuration."},"Name":{"Type":4,"Flags":1,"Description":"The name of the infrastructure configuration."},"ResourceTags":{"Type":54,"Flags":0,"Description":"The tags attached to the resource created by Image Builder."},"SecurityGroupIds":{"Type":55,"Flags":0,"Description":"The security group IDs of the infrastructure configuration."},"SnsTopicArn":{"Type":4,"Flags":0,"Description":"The SNS Topic Amazon Resource Name (ARN) of the infrastructure configuration."},"SubnetId":{"Type":4,"Flags":0,"Description":"The subnet ID of the infrastructure configuration."},"Tags":{"Type":56,"Flags":0,"Description":"The tags associated with the component."},"TerminateInstanceOnFailure":{"Type":2,"Flags":0,"Description":"The terminate instance on failure configuration of the infrastructure configuration."}}}},{"3":{"ItemType":4}},{"2":{"Name":"InfrastructureConfiguration_ResourceTags","Properties":{}}},{"3":{"ItemType":4}},{"2":{"Name":"InfrastructureConfiguration_Tags","Properties":{}}},{"2":{"Name":"AWS.ImageBuilder/InfrastructureConfiguration","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":52,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ImageBuilder/InfrastructureConfiguration@default","ScopeType":0,"Body":57}},{"2":{"Name":"Action","Properties":{"IncludeResources":{"Type":63,"Flags":0},"Type":{"Type":4,"Flags":1,"Description":"The action type of the policy detail."}}}},{"2":{"Name":"AmiExclusionRules","Properties":{"IsPublic":{"Type":2,"Flags":0,"Description":"Use to apply lifecycle policy actions on whether the AMI is public."},"LastLaunched":{"Type":64,"Flags":0,"Description":"Use to apply lifecycle policy actions on AMIs launched before a certain time."},"Regions":{"Type":69,"Flags":0,"Description":"Use to apply lifecycle policy actions on AMIs distributed to a set of regions."},"SharedAccounts":{"Type":70,"Flags":0,"Description":"Use to apply lifecycle policy actions on AMIs shared with a set of regions."},"TagMap":{"Type":71,"Flags":0,"Description":"The AMIs to select by tag."}}}},{"2":{"Name":"ExclusionRules","Properties":{"Amis":{"Type":60,"Flags":0},"TagMap":{"Type":72,"Flags":0,"Description":"The Image Builder tags to filter on."}}}},{"2":{"Name":"Filter","Properties":{"RetainAtLeast":{"Type":3,"Flags":0,"Description":"The minimum number of Image Builder resources to retain."},"Type":{"Type":4,"Flags":1,"Description":"The filter type."},"Unit":{"Type":4,"Flags":0,"Description":"The value's time unit."},"Value":{"Type":3,"Flags":1,"Description":"The filter value."}}}},{"2":{"Name":"IncludeResources","Properties":{"Amis":{"Type":2,"Flags":0,"Description":"Use to configure lifecycle actions on AMIs."},"Containers":{"Type":2,"Flags":0,"Description":"Use to configure lifecycle actions on containers."},"Snapshots":{"Type":2,"Flags":0,"Description":"Use to configure lifecycle actions on snapshots."}}}},{"2":{"Name":"LastLaunched","Properties":{"Unit":{"Type":4,"Flags":1,"Description":"The value's time unit."},"Value":{"Type":3,"Flags":1,"Description":"The last launched value."}}}},{"2":{"Name":"PolicyDetail","Properties":{"Action":{"Type":59,"Flags":1},"ExclusionRules":{"Type":61,"Flags":0},"Filter":{"Type":62,"Flags":1}}}},{"2":{"Name":"RecipeSelection","Properties":{"Name":{"Type":4,"Flags":1,"Description":"The recipe name."},"SemanticVersion":{"Type":4,"Flags":0,"Description":"The recipe version."}}}},{"2":{"Name":"ResourceSelection","Properties":{"Recipes":{"Type":73,"Flags":0,"Description":"The recipes to select."},"TagMap":{"Type":74,"Flags":0,"Description":"The Image Builder resources to select by tag."}}}},{"2":{"Name":"TimeUnit"}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"LifecyclePolicy_TagMap","Properties":{}}},{"2":{"Name":"LifecyclePolicy_TagMap","Properties":{}}},{"3":{"ItemType":66}},{"2":{"Name":"LifecyclePolicy_TagMap","Properties":{}}},{"2":{"Name":"AWS.ImageBuilder/LifecyclePolicyProperties","Properties":{"Arn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN) of the lifecycle policy."},"Description":{"Type":4,"Flags":0,"Description":"The description of the lifecycle policy."},"ExecutionRole":{"Type":4,"Flags":1,"Description":"The execution role of the lifecycle policy."},"Name":{"Type":4,"Flags":1,"Description":"The name of the lifecycle policy."},"PolicyDetails":{"Type":76,"Flags":1,"Description":"The policy details of the lifecycle policy."},"ResourceSelection":{"Type":67,"Flags":1,"Description":"The resource selection of the lifecycle policy."},"ResourceType":{"Type":4,"Flags":1,"Description":"The resource type of the lifecycle policy."},"Status":{"Type":4,"Flags":0,"Description":"The status of the lifecycle policy."},"Tags":{"Type":77,"Flags":0,"Description":"The tags associated with the lifecycle policy."}}}},{"3":{"ItemType":65}},{"2":{"Name":"LifecyclePolicy_Tags","Properties":{}}},{"2":{"Name":"AWS.ImageBuilder/LifecyclePolicy","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":75,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ImageBuilder/LifecyclePolicy@default","ScopeType":0,"Body":78}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "AmiDistributionConfiguration", + "properties": { + "AmiTags": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The tags to apply to AMIs distributed to this Region." + }, + "Description": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The description of the AMI distribution configuration." + }, + "KmsKeyId": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The KMS key identifier used to encrypt the distributed image." + }, + "LaunchPermissionConfiguration": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The name of the AMI distribution configuration." + }, + "TargetAccountIds": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "The ID of accounts to which you want to distribute an image." + } + } + }, + { + "$type": "ObjectType", + "name": "ContainerDistributionConfiguration", + "properties": { + "ContainerTags": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "Tags that are attached to the container distribution configuration." + }, + "Description": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The description of the container distribution configuration." + }, + "TargetRepository": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "The destination repository for the container distribution configuration." + } + } + }, + { + "$type": "ObjectType", + "name": "Distribution", + "properties": { + "AmiDistributionConfiguration": { + "type": { + "$ref": "#/0" + }, + "flags": 0 + }, + "ContainerDistributionConfiguration": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "FastLaunchConfigurations": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The Windows faster-launching configurations to use for AMI distribution." + }, + "LaunchTemplateConfigurations": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "A group of launchTemplateConfiguration settings that apply to image distribution." + }, + "LicenseConfigurationArns": { + "type": { + "$ref": "#/16" + }, + "flags": 0, + "description": "The License Manager Configuration to associate with the AMI in the specified Region." + }, + "Region": { + "type": { + "$ref": "#/11" + }, + "flags": 1, + "description": "region" + } + } + }, + { + "$type": "ObjectType", + "name": "FastLaunchConfiguration", + "properties": { + "AccountId": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The owner account ID for the fast-launch enabled Windows AMI." + }, + "Enabled": { + "type": { + "$ref": "#/17" + }, + "flags": 0, + "description": "A Boolean that represents the current state of faster launching for the Windows AMI. Set to true to start using Windows faster launching, or false to stop using it." + }, + "LaunchTemplate": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The launch template that the fast-launch enabled Windows AMI uses when it launches Windows instances to create pre-provisioned snapshots." + }, + "MaxParallelLaunches": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "The maximum number of parallel instances that are launched for creating resources." + }, + "SnapshotConfiguration": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "Configuration settings for managing the number of snapshots that are created from pre-provisioned instances for the Windows AMI when faster launching is enabled." + } + } + }, + { + "$type": "ObjectType", + "name": "FastLaunchLaunchTemplateSpecification", + "properties": { + "LaunchTemplateId": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The ID of the launch template to use for faster launching for a Windows AMI." + }, + "LaunchTemplateName": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The name of the launch template to use for faster launching for a Windows AMI." + }, + "LaunchTemplateVersion": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The version of the launch template to use for faster launching for a Windows AMI." + } + } + }, + { + "$type": "ObjectType", + "name": "FastLaunchSnapshotConfiguration", + "properties": { + "TargetResourceCount": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled Windows AMI." + } + } + }, + { + "$type": "ObjectType", + "name": "LaunchPermissionConfiguration", + "properties": { + "OrganizationArns": { + "type": { + "$ref": "#/19" + }, + "flags": 0, + "description": "The ARN for an Amazon Web Services Organization that you want to share your AMI with." + }, + "OrganizationalUnitArns": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "The ARN for an Organizations organizational unit (OU) that you want to share your AMI with." + }, + "UserGroups": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "The name of the group." + }, + "UserIds": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "The AWS account ID." + } + } + }, + { + "$type": "ObjectType", + "name": "LaunchTemplateConfiguration", + "properties": { + "AccountId": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The account ID that this configuration applies to." + }, + "LaunchTemplateId": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "Identifies the EC2 launch template to use." + }, + "SetDefaultVersion": { + "type": { + "$ref": "#/17" + }, + "flags": 0, + "description": "Set the specified EC2 launch template as the default launch template for the specified account." + } + } + }, + { + "$type": "ObjectType", + "name": "LicenseConfigurationArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TargetContainerRepository", + "properties": { + "RepositoryName": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The repository name of target container repository." + }, + "Service": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The service of target container repository." + } + } + }, + { + "$type": "ObjectType", + "name": "DistributionConfiguration_AmiTags", + "properties": {} + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/11" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/11" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/7" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/11" + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/11" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/11" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/11" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/11" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.ImageBuilder/DistributionConfigurationProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ObjectType", + "name": "DistributionConfiguration_Tags", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AWS.ImageBuilder/DistributionConfigurationProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/11" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) of the distribution configuration." + }, + "Description": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The description of the distribution configuration." + }, + "Distributions": { + "type": { + "$ref": "#/24" + }, + "flags": 1, + "description": "The distributions of the distribution configuration." + }, + "Name": { + "type": { + "$ref": "#/11" + }, + "flags": 1, + "description": "The name of the distribution configuration." + }, + "Tags": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "The tags associated with the component." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ImageBuilder/DistributionConfiguration", + "properties": { + "name": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/11" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/26" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ImageBuilder/DistributionConfiguration@default", + "scopeType": 0, + "body": { + "$ref": "#/27" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "EcrConfiguration", + "properties": { + "ContainerTags": { + "type": { + "$ref": "#/36" + }, + "flags": 0, + "description": "Tags for Image Builder to apply the output container image that is scanned. Tags can help you identify and manage your scanned images." + }, + "RepositoryName": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The name of the container repository that Amazon Inspector scans to identify findings for your container images. The name includes the path for the repository location. If you don't provide this information, Image Builder creates a repository in your account named image-builder-image-scanning-repository to use for vulnerability scans for your output container images." + } + } + }, + { + "$type": "ObjectType", + "name": "ImageScanningConfiguration", + "properties": { + "EcrConfiguration": { + "type": { + "$ref": "#/29" + }, + "flags": 0, + "description": "Contains ECR settings for vulnerability scans." + }, + "ImageScanningEnabled": { + "type": { + "$ref": "#/17" + }, + "flags": 0, + "description": "This sets whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image." + } + } + }, + { + "$type": "ObjectType", + "name": "ImageTestsConfiguration", + "properties": { + "ImageTestsEnabled": { + "type": { + "$ref": "#/17" + }, + "flags": 0, + "description": "Defines if tests should be executed when building this image." + }, + "TimeoutMinutes": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "The maximum time in minutes that tests are permitted to run." + } + } + }, + { + "$type": "ObjectType", + "name": "Schedule", + "properties": { + "PipelineExecutionStartCondition": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The condition configures when the pipeline should trigger a new image build." + }, + "ScheduleExpression": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The expression determines how often EC2 Image Builder evaluates your pipelineExecutionStartCondition." + } + } + }, + { + "$type": "ObjectType", + "name": "WorkflowConfiguration", + "properties": { + "OnFailure": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "Define execution decision in case of workflow failure" + }, + "ParallelGroup": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The parallel group name" + }, + "Parameters": { + "type": { + "$ref": "#/37" + }, + "flags": 0, + "description": "The parameters associated with the workflow" + }, + "WorkflowArn": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the workflow" + } + } + }, + { + "$type": "ObjectType", + "name": "WorkflowParameter", + "properties": { + "Name": { + "type": { + "$ref": "#/11" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/38" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "WorkflowParameterValue", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/11" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/34" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/11" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.ImageBuilder/ImagePipelineProperties" + }, + { + "$type": "ObjectType", + "name": "ImagePipeline_Tags", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/33" + } + }, + { + "$type": "ObjectType", + "name": "AWS.ImageBuilder/ImagePipelineProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/11" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) of the image pipeline." + }, + "ContainerRecipeArn": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested." + }, + "Description": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The description of the image pipeline." + }, + "DistributionConfigurationArn": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline." + }, + "EnhancedImageMetadataEnabled": { + "type": { + "$ref": "#/17" + }, + "flags": 0, + "description": "Collects additional information about the image being created, including the operating system (OS) version and package list." + }, + "ExecutionRole": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The execution role name/ARN for the image build, if provided" + }, + "ImageRecipeArn": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed." + }, + "ImageScanningConfiguration": { + "type": { + "$ref": "#/30" + }, + "flags": 0, + "description": "Contains settings for vulnerability scans." + }, + "ImageTestsConfiguration": { + "type": { + "$ref": "#/31" + }, + "flags": 0, + "description": "The image tests configuration of the image pipeline." + }, + "InfrastructureConfigurationArn": { + "type": { + "$ref": "#/11" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline." + }, + "Name": { + "type": { + "$ref": "#/11" + }, + "flags": 1, + "description": "The name of the image pipeline." + }, + "Schedule": { + "type": { + "$ref": "#/32" + }, + "flags": 0, + "description": "The schedule of the image pipeline." + }, + "Status": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The status of the image pipeline." + }, + "Tags": { + "type": { + "$ref": "#/40" + }, + "flags": 0, + "description": "The tags of this image pipeline." + }, + "Workflows": { + "type": { + "$ref": "#/41" + }, + "flags": 0, + "description": "Workflows to define the image build process" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ImageBuilder/ImagePipeline", + "properties": { + "name": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/11" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/42" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ImageBuilder/ImagePipeline@default", + "scopeType": 0, + "body": { + "$ref": "#/43" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "InstanceMetadataOptions", + "properties": { + "HttpPutResponseHopLimit": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "Limit the number of hops that an instance metadata request can traverse to reach its destination." + }, + "HttpTokens": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "Indicates whether a signed token header is required for instance metadata retrieval requests. The values affect the response as follows: " + } + } + }, + { + "$type": "ObjectType", + "name": "Logging", + "properties": { + "S3Logs": { + "type": { + "$ref": "#/47" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "S3Logs", + "properties": { + "S3BucketName": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "S3BucketName" + }, + "S3KeyPrefix": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "S3KeyPrefix" + } + } + }, + { + "$type": "ObjectType", + "name": "TagMap", + "properties": { + "TagKey": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "TagKey" + }, + "TagValue": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "TagValue" + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.ImageBuilder/InfrastructureConfigurationProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/11" + } + }, + { + "$type": "ObjectType", + "name": "InfrastructureConfiguration_ResourceTags", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/11" + } + }, + { + "$type": "ObjectType", + "name": "InfrastructureConfiguration_Tags", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AWS.ImageBuilder/InfrastructureConfigurationProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/11" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) of the infrastructure configuration." + }, + "Description": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The description of the infrastructure configuration." + }, + "InstanceMetadataOptions": { + "type": { + "$ref": "#/45" + }, + "flags": 0, + "description": "The instance metadata option settings for the infrastructure configuration." + }, + "InstanceProfileName": { + "type": { + "$ref": "#/11" + }, + "flags": 1, + "description": "The instance profile of the infrastructure configuration." + }, + "InstanceTypes": { + "type": { + "$ref": "#/50" + }, + "flags": 0, + "description": "The instance types of the infrastructure configuration." + }, + "KeyPair": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The EC2 key pair of the infrastructure configuration.." + }, + "Logging": { + "type": { + "$ref": "#/46" + }, + "flags": 0, + "description": "The logging configuration of the infrastructure configuration." + }, + "Name": { + "type": { + "$ref": "#/11" + }, + "flags": 1, + "description": "The name of the infrastructure configuration." + }, + "ResourceTags": { + "type": { + "$ref": "#/51" + }, + "flags": 0, + "description": "The tags attached to the resource created by Image Builder." + }, + "SecurityGroupIds": { + "type": { + "$ref": "#/52" + }, + "flags": 0, + "description": "The security group IDs of the infrastructure configuration." + }, + "SnsTopicArn": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The SNS Topic Amazon Resource Name (ARN) of the infrastructure configuration." + }, + "SubnetId": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The subnet ID of the infrastructure configuration." + }, + "Tags": { + "type": { + "$ref": "#/53" + }, + "flags": 0, + "description": "The tags associated with the component." + }, + "TerminateInstanceOnFailure": { + "type": { + "$ref": "#/17" + }, + "flags": 0, + "description": "The terminate instance on failure configuration of the infrastructure configuration." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ImageBuilder/InfrastructureConfiguration", + "properties": { + "name": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/11" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/54" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ImageBuilder/InfrastructureConfiguration@default", + "scopeType": 0, + "body": { + "$ref": "#/55" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Action", + "properties": { + "IncludeResources": { + "type": { + "$ref": "#/61" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/11" + }, + "flags": 1, + "description": "The action type of the policy detail." + } + } + }, + { + "$type": "ObjectType", + "name": "AmiExclusionRules", + "properties": { + "IsPublic": { + "type": { + "$ref": "#/17" + }, + "flags": 0, + "description": "Use to apply lifecycle policy actions on whether the AMI is public." + }, + "LastLaunched": { + "type": { + "$ref": "#/62" + }, + "flags": 0, + "description": "Use to apply lifecycle policy actions on AMIs launched before a certain time." + }, + "Regions": { + "type": { + "$ref": "#/67" + }, + "flags": 0, + "description": "Use to apply lifecycle policy actions on AMIs distributed to a set of regions." + }, + "SharedAccounts": { + "type": { + "$ref": "#/68" + }, + "flags": 0, + "description": "Use to apply lifecycle policy actions on AMIs shared with a set of regions." + }, + "TagMap": { + "type": { + "$ref": "#/69" + }, + "flags": 0, + "description": "The AMIs to select by tag." + } + } + }, + { + "$type": "ObjectType", + "name": "ExclusionRules", + "properties": { + "Amis": { + "type": { + "$ref": "#/58" + }, + "flags": 0 + }, + "TagMap": { + "type": { + "$ref": "#/70" + }, + "flags": 0, + "description": "The Image Builder tags to filter on." + } + } + }, + { + "$type": "ObjectType", + "name": "Filter", + "properties": { + "RetainAtLeast": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "The minimum number of Image Builder resources to retain." + }, + "Type": { + "type": { + "$ref": "#/11" + }, + "flags": 1, + "description": "The filter type." + }, + "Unit": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The value's time unit." + }, + "Value": { + "type": { + "$ref": "#/18" + }, + "flags": 1, + "description": "The filter value." + } + } + }, + { + "$type": "ObjectType", + "name": "IncludeResources", + "properties": { + "Amis": { + "type": { + "$ref": "#/17" + }, + "flags": 0, + "description": "Use to configure lifecycle actions on AMIs." + }, + "Containers": { + "type": { + "$ref": "#/17" + }, + "flags": 0, + "description": "Use to configure lifecycle actions on containers." + }, + "Snapshots": { + "type": { + "$ref": "#/17" + }, + "flags": 0, + "description": "Use to configure lifecycle actions on snapshots." + } + } + }, + { + "$type": "ObjectType", + "name": "LastLaunched", + "properties": { + "Unit": { + "type": { + "$ref": "#/11" + }, + "flags": 1, + "description": "The value's time unit." + }, + "Value": { + "type": { + "$ref": "#/18" + }, + "flags": 1, + "description": "The last launched value." + } + } + }, + { + "$type": "ObjectType", + "name": "PolicyDetail", + "properties": { + "Action": { + "type": { + "$ref": "#/57" + }, + "flags": 1 + }, + "ExclusionRules": { + "type": { + "$ref": "#/59" + }, + "flags": 0 + }, + "Filter": { + "type": { + "$ref": "#/60" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "RecipeSelection", + "properties": { + "Name": { + "type": { + "$ref": "#/11" + }, + "flags": 1, + "description": "The recipe name." + }, + "SemanticVersion": { + "type": { + "$ref": "#/11" + }, + "flags": 1, + "description": "The recipe version." + } + } + }, + { + "$type": "ObjectType", + "name": "ResourceSelection", + "properties": { + "Recipes": { + "type": { + "$ref": "#/71" + }, + "flags": 0, + "description": "The recipes to select." + }, + "TagMap": { + "type": { + "$ref": "#/72" + }, + "flags": 0, + "description": "The Image Builder resources to select by tag." + } + } + }, + { + "$type": "ObjectType", + "name": "TimeUnit", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/11" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/11" + } + }, + { + "$type": "ObjectType", + "name": "LifecyclePolicy_TagMap", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LifecyclePolicy_TagMap", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/64" + } + }, + { + "$type": "ObjectType", + "name": "LifecyclePolicy_TagMap", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.ImageBuilder/LifecyclePolicyProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/63" + } + }, + { + "$type": "ObjectType", + "name": "LifecyclePolicy_Tags", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AWS.ImageBuilder/LifecyclePolicyProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/11" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) of the lifecycle policy." + }, + "Description": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The description of the lifecycle policy." + }, + "ExecutionRole": { + "type": { + "$ref": "#/11" + }, + "flags": 1, + "description": "The execution role of the lifecycle policy." + }, + "Name": { + "type": { + "$ref": "#/11" + }, + "flags": 1, + "description": "The name of the lifecycle policy." + }, + "PolicyDetails": { + "type": { + "$ref": "#/74" + }, + "flags": 1, + "description": "The policy details of the lifecycle policy." + }, + "ResourceSelection": { + "type": { + "$ref": "#/65" + }, + "flags": 1, + "description": "The resource selection of the lifecycle policy." + }, + "ResourceType": { + "type": { + "$ref": "#/11" + }, + "flags": 1, + "description": "The resource type of the lifecycle policy." + }, + "Status": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The status of the lifecycle policy." + }, + "Tags": { + "type": { + "$ref": "#/75" + }, + "flags": 0, + "description": "The tags associated with the lifecycle policy." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ImageBuilder/LifecyclePolicy", + "properties": { + "name": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/11" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/76" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ImageBuilder/LifecyclePolicy@default", + "scopeType": 0, + "body": { + "$ref": "#/77" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.imagebuilder/default/types.md b/artifacts/bicep/aws/aws.imagebuilder/default/types.md index 50be76e7..5993600b 100644 --- a/artifacts/bicep/aws/aws.imagebuilder/default/types.md +++ b/artifacts/bicep/aws/aws.imagebuilder/default/types.md @@ -3,30 +3,52 @@ ## Resource AWS.ImageBuilder/DistributionConfiguration@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ImageBuilder/DistributionConfigurationProperties](#awsimagebuilderdistributionconfigurationproperties) (Required): properties of the resource +* **properties**: [AWS.ImageBuilder/DistributionConfigurationProperties](#awsimagebuilderdistributionconfigurationproperties) (Required, Identifier): properties of the resource ## Resource AWS.ImageBuilder/ImagePipeline@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ImageBuilder/ImagePipelineProperties](#awsimagebuilderimagepipelineproperties) (Required): properties of the resource +* **properties**: [AWS.ImageBuilder/ImagePipelineProperties](#awsimagebuilderimagepipelineproperties) (Required, Identifier): properties of the resource ## Resource AWS.ImageBuilder/InfrastructureConfiguration@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ImageBuilder/InfrastructureConfigurationProperties](#awsimagebuilderinfrastructureconfigurationproperties) (Required): properties of the resource +* **properties**: [AWS.ImageBuilder/InfrastructureConfigurationProperties](#awsimagebuilderinfrastructureconfigurationproperties) (Required, Identifier): properties of the resource ## Resource AWS.ImageBuilder/LifecyclePolicy@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ImageBuilder/LifecyclePolicyProperties](#awsimagebuilderlifecyclepolicyproperties) (Required): properties of the resource +* **properties**: [AWS.ImageBuilder/LifecyclePolicyProperties](#awsimagebuilderlifecyclepolicyproperties) (Required, Identifier): properties of the resource + +## Action +### Properties +* **IncludeResources**: [IncludeResources](#includeresources) +* **Type**: string (Required): The action type of the policy detail. + +## AmiDistributionConfiguration +### Properties +* **AmiTags**: [DistributionConfiguration_AmiTags](#distributionconfigurationamitags): The tags to apply to AMIs distributed to this Region. +* **Description**: string: The description of the AMI distribution configuration. +* **KmsKeyId**: string: The KMS key identifier used to encrypt the distributed image. +* **LaunchPermissionConfiguration**: [LaunchPermissionConfiguration](#launchpermissionconfiguration) +* **Name**: string: The name of the AMI distribution configuration. +* **TargetAccountIds**: string[]: The ID of accounts to which you want to distribute an image. + +## AmiExclusionRules +### Properties +* **IsPublic**: bool: Use to apply lifecycle policy actions on whether the AMI is public. +* **LastLaunched**: [LastLaunched](#lastlaunched): Use to apply lifecycle policy actions on AMIs launched before a certain time. +* **Regions**: string[]: Use to apply lifecycle policy actions on AMIs distributed to a set of regions. +* **SharedAccounts**: string[]: Use to apply lifecycle policy actions on AMIs shared with a set of regions. +* **TagMap**: [LifecyclePolicy_TagMap](#lifecyclepolicytagmap): The AMIs to select by tag. ## AWS.ImageBuilder/DistributionConfigurationProperties ### Properties @@ -36,6 +58,59 @@ * **Name**: string (Required): The name of the distribution configuration. * **Tags**: [DistributionConfiguration_Tags](#distributionconfigurationtags): The tags associated with the component. +## AWS.ImageBuilder/ImagePipelineProperties +### Properties +* **Arn**: string (ReadOnly, Identifier): The Amazon Resource Name (ARN) of the image pipeline. +* **ContainerRecipeArn**: string: The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested. +* **Description**: string: The description of the image pipeline. +* **DistributionConfigurationArn**: string: The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline. +* **EnhancedImageMetadataEnabled**: bool: Collects additional information about the image being created, including the operating system (OS) version and package list. +* **ExecutionRole**: string: The execution role name/ARN for the image build, if provided +* **ImageRecipeArn**: string: The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed. +* **ImageScanningConfiguration**: [ImageScanningConfiguration](#imagescanningconfiguration): Contains settings for vulnerability scans. +* **ImageTestsConfiguration**: [ImageTestsConfiguration](#imagetestsconfiguration): The image tests configuration of the image pipeline. +* **InfrastructureConfigurationArn**: string (Required): The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline. +* **Name**: string (Required): The name of the image pipeline. +* **Schedule**: [Schedule](#schedule): The schedule of the image pipeline. +* **Status**: string: The status of the image pipeline. +* **Tags**: [ImagePipeline_Tags](#imagepipelinetags): The tags of this image pipeline. +* **Workflows**: [WorkflowConfiguration](#workflowconfiguration)[]: Workflows to define the image build process + +## AWS.ImageBuilder/InfrastructureConfigurationProperties +### Properties +* **Arn**: string (ReadOnly, Identifier): The Amazon Resource Name (ARN) of the infrastructure configuration. +* **Description**: string: The description of the infrastructure configuration. +* **InstanceMetadataOptions**: [InstanceMetadataOptions](#instancemetadataoptions): The instance metadata option settings for the infrastructure configuration. +* **InstanceProfileName**: string (Required): The instance profile of the infrastructure configuration. +* **InstanceTypes**: string[]: The instance types of the infrastructure configuration. +* **KeyPair**: string: The EC2 key pair of the infrastructure configuration.. +* **Logging**: [Logging](#logging): The logging configuration of the infrastructure configuration. +* **Name**: string (Required): The name of the infrastructure configuration. +* **ResourceTags**: [InfrastructureConfiguration_ResourceTags](#infrastructureconfigurationresourcetags): The tags attached to the resource created by Image Builder. +* **SecurityGroupIds**: string[]: The security group IDs of the infrastructure configuration. +* **SnsTopicArn**: string: The SNS Topic Amazon Resource Name (ARN) of the infrastructure configuration. +* **SubnetId**: string: The subnet ID of the infrastructure configuration. +* **Tags**: [InfrastructureConfiguration_Tags](#infrastructureconfigurationtags): The tags associated with the component. +* **TerminateInstanceOnFailure**: bool: The terminate instance on failure configuration of the infrastructure configuration. + +## AWS.ImageBuilder/LifecyclePolicyProperties +### Properties +* **Arn**: string (ReadOnly, Identifier): The Amazon Resource Name (ARN) of the lifecycle policy. +* **Description**: string: The description of the lifecycle policy. +* **ExecutionRole**: string (Required): The execution role of the lifecycle policy. +* **Name**: string (Required): The name of the lifecycle policy. +* **PolicyDetails**: [PolicyDetail](#policydetail)[] (Required): The policy details of the lifecycle policy. +* **ResourceSelection**: [ResourceSelection](#resourceselection) (Required): The resource selection of the lifecycle policy. +* **ResourceType**: string (Required): The resource type of the lifecycle policy. +* **Status**: string: The status of the lifecycle policy. +* **Tags**: [LifecyclePolicy_Tags](#lifecyclepolicytags): The tags associated with the lifecycle policy. + +## ContainerDistributionConfiguration +### Properties +* **ContainerTags**: string[]: Tags that are attached to the container distribution configuration. +* **Description**: string: The description of the container distribution configuration. +* **TargetRepository**: [TargetContainerRepository](#targetcontainerrepository): The destination repository for the container distribution configuration. + ## Distribution ### Properties * **AmiDistributionConfiguration**: [AmiDistributionConfiguration](#amidistributionconfiguration) @@ -45,35 +120,21 @@ * **LicenseConfigurationArns**: string[]: The License Manager Configuration to associate with the AMI in the specified Region. * **Region**: string (Required): region -## AmiDistributionConfiguration -### Properties -* **AmiTags**: [DistributionConfiguration_AmiTags](#distributionconfigurationamitags): The tags to apply to AMIs distributed to this Region. -* **Description**: string: The description of the AMI distribution configuration. -* **KmsKeyId**: string: The KMS key identifier used to encrypt the distributed image. -* **LaunchPermissionConfiguration**: [LaunchPermissionConfiguration](#launchpermissionconfiguration) -* **Name**: string: The name of the AMI distribution configuration. -* **TargetAccountIds**: string[]: The ID of accounts to which you want to distribute an image. - ## DistributionConfiguration_AmiTags ### Properties -## LaunchPermissionConfiguration +## DistributionConfiguration_Tags ### Properties -* **OrganizationalUnitArns**: string[]: The ARN for an Organizations organizational unit (OU) that you want to share your AMI with. -* **OrganizationArns**: string[]: The ARN for an Amazon Web Services Organization that you want to share your AMI with. -* **UserGroups**: string[]: The name of the group. -* **UserIds**: string[]: The AWS account ID. -## ContainerDistributionConfiguration +## EcrConfiguration ### Properties -* **ContainerTags**: string[]: Tags that are attached to the container distribution configuration. -* **Description**: string: The description of the container distribution configuration. -* **TargetRepository**: [TargetContainerRepository](#targetcontainerrepository): The destination repository for the container distribution configuration. +* **ContainerTags**: string[]: Tags for Image Builder to apply the output container image that is scanned. Tags can help you identify and manage your scanned images. +* **RepositoryName**: string: The name of the container repository that Amazon Inspector scans to identify findings for your container images. The name includes the path for the repository location. If you don't provide this information, Image Builder creates a repository in your account named image-builder-image-scanning-repository to use for vulnerability scans for your output container images. -## TargetContainerRepository +## ExclusionRules ### Properties -* **RepositoryName**: string: The repository name of target container repository. -* **Service**: string: The service of target container repository. +* **Amis**: [AmiExclusionRules](#amiexclusionrules) +* **TagMap**: [LifecyclePolicy_TagMap](#lifecyclepolicytagmap): The Image Builder tags to filter on. ## FastLaunchConfiguration ### Properties @@ -93,178 +154,117 @@ ### Properties * **TargetResourceCount**: int: The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled Windows AMI. -## LaunchTemplateConfiguration -### Properties -* **AccountId**: string: The account ID that this configuration applies to. -* **LaunchTemplateId**: string: Identifies the EC2 launch template to use. -* **SetDefaultVersion**: bool: Set the specified EC2 launch template as the default launch template for the specified account. - -## DistributionConfiguration_Tags +## Filter ### Properties +* **RetainAtLeast**: int: The minimum number of Image Builder resources to retain. +* **Type**: string (Required): The filter type. +* **Unit**: string: The value's time unit. +* **Value**: int (Required): The filter value. -## AWS.ImageBuilder/ImagePipelineProperties +## ImagePipeline_Tags ### Properties -* **Arn**: string (ReadOnly, Identifier): The Amazon Resource Name (ARN) of the image pipeline. -* **ContainerRecipeArn**: string: The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested. -* **Description**: string: The description of the image pipeline. -* **DistributionConfigurationArn**: string: The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline. -* **EnhancedImageMetadataEnabled**: bool: Collects additional information about the image being created, including the operating system (OS) version and package list. -* **ExecutionRole**: string: The execution role name/ARN for the image build, if provided -* **ImageRecipeArn**: string: The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed. -* **ImageScanningConfiguration**: [ImageScanningConfiguration](#imagescanningconfiguration): Contains settings for vulnerability scans. -* **ImageTestsConfiguration**: [ImageTestsConfiguration](#imagetestsconfiguration): The image tests configuration of the image pipeline. -* **InfrastructureConfigurationArn**: string (Required): The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline. -* **Name**: string (Required): The name of the image pipeline. -* **Schedule**: [Schedule](#schedule): The schedule of the image pipeline. -* **Status**: string: The status of the image pipeline. -* **Tags**: [ImagePipeline_Tags](#imagepipelinetags): The tags of this image pipeline. -* **Workflows**: [WorkflowConfiguration](#workflowconfiguration)[]: Workflows to define the image build process ## ImageScanningConfiguration ### Properties * **EcrConfiguration**: [EcrConfiguration](#ecrconfiguration): Contains ECR settings for vulnerability scans. * **ImageScanningEnabled**: bool: This sets whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image. -## EcrConfiguration -### Properties -* **ContainerTags**: string[]: Tags for Image Builder to apply the output container image that is scanned. Tags can help you identify and manage your scanned images. -* **RepositoryName**: string: The name of the container repository that Amazon Inspector scans to identify findings for your container images. The name includes the path for the repository location. If you don't provide this information, Image Builder creates a repository in your account named image-builder-image-scanning-repository to use for vulnerability scans for your output container images. - ## ImageTestsConfiguration ### Properties * **ImageTestsEnabled**: bool: Defines if tests should be executed when building this image. * **TimeoutMinutes**: int: The maximum time in minutes that tests are permitted to run. -## Schedule -### Properties -* **PipelineExecutionStartCondition**: string: The condition configures when the pipeline should trigger a new image build. -* **ScheduleExpression**: string: The expression determines how often EC2 Image Builder evaluates your pipelineExecutionStartCondition. - -## ImagePipeline_Tags +## IncludeResources ### Properties +* **Amis**: bool: Use to configure lifecycle actions on AMIs. +* **Containers**: bool: Use to configure lifecycle actions on containers. +* **Snapshots**: bool: Use to configure lifecycle actions on snapshots. -## WorkflowConfiguration +## InfrastructureConfiguration_ResourceTags ### Properties -* **OnFailure**: string: Define execution decision in case of workflow failure -* **ParallelGroup**: string: The parallel group name -* **Parameters**: [WorkflowParameter](#workflowparameter)[]: The parameters associated with the workflow -* **WorkflowArn**: string: The Amazon Resource Name (ARN) of the workflow -## WorkflowParameter +## InfrastructureConfiguration_Tags ### Properties -* **Name**: string -* **Value**: string[] - -## AWS.ImageBuilder/InfrastructureConfigurationProperties -### Properties -* **Arn**: string (ReadOnly, Identifier): The Amazon Resource Name (ARN) of the infrastructure configuration. -* **Description**: string: The description of the infrastructure configuration. -* **InstanceMetadataOptions**: [InstanceMetadataOptions](#instancemetadataoptions): The instance metadata option settings for the infrastructure configuration. -* **InstanceProfileName**: string (Required): The instance profile of the infrastructure configuration. -* **InstanceTypes**: string[]: The instance types of the infrastructure configuration. -* **KeyPair**: string: The EC2 key pair of the infrastructure configuration.. -* **Logging**: [Logging](#logging): The logging configuration of the infrastructure configuration. -* **Name**: string (Required): The name of the infrastructure configuration. -* **ResourceTags**: [InfrastructureConfiguration_ResourceTags](#infrastructureconfigurationresourcetags): The tags attached to the resource created by Image Builder. -* **SecurityGroupIds**: string[]: The security group IDs of the infrastructure configuration. -* **SnsTopicArn**: string: The SNS Topic Amazon Resource Name (ARN) of the infrastructure configuration. -* **SubnetId**: string: The subnet ID of the infrastructure configuration. -* **Tags**: [InfrastructureConfiguration_Tags](#infrastructureconfigurationtags): The tags associated with the component. -* **TerminateInstanceOnFailure**: bool: The terminate instance on failure configuration of the infrastructure configuration. ## InstanceMetadataOptions ### Properties * **HttpPutResponseHopLimit**: int: Limit the number of hops that an instance metadata request can traverse to reach its destination. * **HttpTokens**: string: Indicates whether a signed token header is required for instance metadata retrieval requests. The values affect the response as follows: -## Logging -### Properties -* **S3Logs**: [S3Logs](#s3logs) - -## S3Logs -### Properties -* **S3BucketName**: string: S3BucketName -* **S3KeyPrefix**: string: S3KeyPrefix - -## InfrastructureConfiguration_ResourceTags +## LastLaunched ### Properties +* **Unit**: string (Required): The value's time unit. +* **Value**: int (Required): The last launched value. -## InfrastructureConfiguration_Tags +## LaunchPermissionConfiguration ### Properties +* **OrganizationalUnitArns**: string[]: The ARN for an Organizations organizational unit (OU) that you want to share your AMI with. +* **OrganizationArns**: string[]: The ARN for an Amazon Web Services Organization that you want to share your AMI with. +* **UserGroups**: string[]: The name of the group. +* **UserIds**: string[]: The AWS account ID. -## AWS.ImageBuilder/LifecyclePolicyProperties +## LaunchTemplateConfiguration ### Properties -* **Arn**: string (ReadOnly, Identifier): The Amazon Resource Name (ARN) of the lifecycle policy. -* **Description**: string: The description of the lifecycle policy. -* **ExecutionRole**: string (Required): The execution role of the lifecycle policy. -* **Name**: string (Required): The name of the lifecycle policy. -* **PolicyDetails**: [PolicyDetail](#policydetail)[] (Required): The policy details of the lifecycle policy. -* **ResourceSelection**: [ResourceSelection](#resourceselection) (Required): The resource selection of the lifecycle policy. -* **ResourceType**: string (Required): The resource type of the lifecycle policy. -* **Status**: string: The status of the lifecycle policy. -* **Tags**: [LifecyclePolicy_Tags](#lifecyclepolicytags): The tags associated with the lifecycle policy. +* **AccountId**: string: The account ID that this configuration applies to. +* **LaunchTemplateId**: string: Identifies the EC2 launch template to use. +* **SetDefaultVersion**: bool: Set the specified EC2 launch template as the default launch template for the specified account. -## PolicyDetail +## LifecyclePolicy_TagMap ### Properties -* **Action**: [Action](#action) (Required) -* **ExclusionRules**: [ExclusionRules](#exclusionrules) -* **Filter**: [Filter](#filter) (Required) -## Action +## LifecyclePolicy_TagMap ### Properties -* **IncludeResources**: [IncludeResources](#includeresources) -* **Type**: string (Required): The action type of the policy detail. -## IncludeResources +## LifecyclePolicy_TagMap ### Properties -* **Amis**: bool: Use to configure lifecycle actions on AMIs. -* **Containers**: bool: Use to configure lifecycle actions on containers. -* **Snapshots**: bool: Use to configure lifecycle actions on snapshots. -## ExclusionRules +## LifecyclePolicy_Tags ### Properties -* **Amis**: [AmiExclusionRules](#amiexclusionrules) -* **TagMap**: [LifecyclePolicy_TagMap](#lifecyclepolicytagmap): The Image Builder tags to filter on. -## AmiExclusionRules +## Logging ### Properties -* **IsPublic**: bool: Use to apply lifecycle policy actions on whether the AMI is public. -* **LastLaunched**: [LastLaunched](#lastlaunched): Use to apply lifecycle policy actions on AMIs launched before a certain time. -* **Regions**: string[]: Use to apply lifecycle policy actions on AMIs distributed to a set of regions. -* **SharedAccounts**: string[]: Use to apply lifecycle policy actions on AMIs shared with a set of regions. -* **TagMap**: [LifecyclePolicy_TagMap](#lifecyclepolicytagmap): The AMIs to select by tag. +* **S3Logs**: [S3Logs](#s3logs) -## LastLaunched +## PolicyDetail ### Properties -* **Unit**: string (Required): The value's time unit. -* **Value**: int (Required): The last launched value. +* **Action**: [Action](#action) (Required) +* **ExclusionRules**: [ExclusionRules](#exclusionrules) +* **Filter**: [Filter](#filter) (Required) -## LifecyclePolicy_TagMap +## RecipeSelection ### Properties +* **Name**: string (Required): The recipe name. +* **SemanticVersion**: string (Required): The recipe version. -## LifecyclePolicy_TagMap +## ResourceSelection ### Properties +* **Recipes**: [RecipeSelection](#recipeselection)[]: The recipes to select. +* **TagMap**: [LifecyclePolicy_TagMap](#lifecyclepolicytagmap): The Image Builder resources to select by tag. -## Filter +## S3Logs ### Properties -* **RetainAtLeast**: int: The minimum number of Image Builder resources to retain. -* **Type**: string (Required): The filter type. -* **Unit**: string: The value's time unit. -* **Value**: int (Required): The filter value. +* **S3BucketName**: string: S3BucketName +* **S3KeyPrefix**: string: S3KeyPrefix -## ResourceSelection +## Schedule ### Properties -* **Recipes**: [RecipeSelection](#recipeselection)[]: The recipes to select. -* **TagMap**: [LifecyclePolicy_TagMap](#lifecyclepolicytagmap): The Image Builder resources to select by tag. +* **PipelineExecutionStartCondition**: string: The condition configures when the pipeline should trigger a new image build. +* **ScheduleExpression**: string: The expression determines how often EC2 Image Builder evaluates your pipelineExecutionStartCondition. -## RecipeSelection +## TargetContainerRepository ### Properties -* **Name**: string (Required): The recipe name. -* **SemanticVersion**: string: The recipe version. +* **RepositoryName**: string: The repository name of target container repository. +* **Service**: string: The service of target container repository. -## LifecyclePolicy_TagMap +## WorkflowConfiguration ### Properties +* **OnFailure**: string: Define execution decision in case of workflow failure +* **ParallelGroup**: string: The parallel group name +* **Parameters**: [WorkflowParameter](#workflowparameter)[]: The parameters associated with the workflow +* **WorkflowArn**: string: The Amazon Resource Name (ARN) of the workflow -## LifecyclePolicy_Tags +## WorkflowParameter ### Properties +* **Name**: string +* **Value**: string[] diff --git a/artifacts/bicep/aws/aws.inspector/default/types.json b/artifacts/bicep/aws/aws.inspector/default/types.json index 3c3ae8bf..c3373603 100644 --- a/artifacts/bicep/aws/aws.inspector/default/types.json +++ b/artifacts/bicep/aws/aws.inspector/default/types.json @@ -1 +1,69 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"AWS.Inspector/AssessmentTargetProperties","Properties":{"Arn":{"Type":4,"Flags":18},"AssessmentTargetName":{"Type":4,"Flags":0},"ResourceGroupArn":{"Type":4,"Flags":0}}}},{"2":{"Name":"AWS.Inspector/AssessmentTarget","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":8,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Inspector/AssessmentTarget@default","ScopeType":0,"Body":9}}] \ No newline at end of file +[ + { + "$type": "StringLiteralType", + "value": "AWS.Inspector/AssessmentTargetProperties" + }, + { + "$type": "StringType" + }, + { + "$type": "ObjectType", + "name": "AWS.Inspector/AssessmentTargetProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 18 + }, + "AssessmentTargetName": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "ResourceGroupArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Inspector/AssessmentTarget", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/2" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Inspector/AssessmentTarget@default", + "scopeType": 0, + "body": { + "$ref": "#/3" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.inspector/default/types.md b/artifacts/bicep/aws/aws.inspector/default/types.md index 33ff8ba8..9ff4f03f 100644 --- a/artifacts/bicep/aws/aws.inspector/default/types.md +++ b/artifacts/bicep/aws/aws.inspector/default/types.md @@ -3,9 +3,9 @@ ## Resource AWS.Inspector/AssessmentTarget@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Inspector/AssessmentTargetProperties](#awsinspectorassessmenttargetproperties): properties of the resource +* **properties**: [AWS.Inspector/AssessmentTargetProperties](#awsinspectorassessmenttargetproperties) (Identifier): properties of the resource ## AWS.Inspector/AssessmentTargetProperties ### Properties diff --git a/artifacts/bicep/aws/aws.inspectorv2/default/types.json b/artifacts/bicep/aws/aws.inspectorv2/default/types.json index a2eef524..6b43ca6f 100644 --- a/artifacts/bicep/aws/aws.inspectorv2/default/types.json +++ b/artifacts/bicep/aws/aws.inspectorv2/default/types.json @@ -1 +1,973 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"DateFilter","Properties":{"EndInclusive":{"Type":3,"Flags":0},"StartInclusive":{"Type":3,"Flags":0}}}},{"2":{"Name":"DateFilterList"}},{"2":{"Name":"FilterAction"}},{"2":{"Name":"FilterCriteria","Properties":{"AwsAccountId":{"Type":30,"Flags":0},"ComponentId":{"Type":31,"Flags":0},"ComponentType":{"Type":32,"Flags":0},"Ec2InstanceImageId":{"Type":33,"Flags":0},"Ec2InstanceSubnetId":{"Type":34,"Flags":0},"Ec2InstanceVpcId":{"Type":35,"Flags":0},"EcrImageArchitecture":{"Type":36,"Flags":0},"EcrImageHash":{"Type":37,"Flags":0},"EcrImagePushedAt":{"Type":38,"Flags":0},"EcrImageRegistry":{"Type":39,"Flags":0},"EcrImageRepositoryName":{"Type":40,"Flags":0},"EcrImageTags":{"Type":41,"Flags":0},"FindingArn":{"Type":42,"Flags":0},"FindingStatus":{"Type":43,"Flags":0},"FindingType":{"Type":44,"Flags":0},"FirstObservedAt":{"Type":45,"Flags":0},"InspectorScore":{"Type":46,"Flags":0},"LastObservedAt":{"Type":47,"Flags":0},"NetworkProtocol":{"Type":48,"Flags":0},"PortRange":{"Type":49,"Flags":0},"RelatedVulnerabilities":{"Type":50,"Flags":0},"ResourceId":{"Type":51,"Flags":0},"ResourceTags":{"Type":52,"Flags":0},"ResourceType":{"Type":53,"Flags":0},"Severity":{"Type":54,"Flags":0},"Title":{"Type":55,"Flags":0},"UpdatedAt":{"Type":56,"Flags":0},"VendorSeverity":{"Type":57,"Flags":0},"VulnerabilityId":{"Type":58,"Flags":0},"VulnerabilitySource":{"Type":59,"Flags":0},"VulnerablePackages":{"Type":60,"Flags":0}}}},{"2":{"Name":"MapComparison"}},{"2":{"Name":"MapFilter","Properties":{"Comparison":{"Type":4,"Flags":1},"Key":{"Type":4,"Flags":0},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"MapFilterList"}},{"2":{"Name":"MapKey"}},{"2":{"Name":"MapValue"}},{"2":{"Name":"NumberFilter","Properties":{"LowerInclusive":{"Type":3,"Flags":0},"UpperInclusive":{"Type":3,"Flags":0}}}},{"2":{"Name":"NumberFilterList"}},{"2":{"Name":"PackageFilter","Properties":{"Architecture":{"Type":25,"Flags":0},"Epoch":{"Type":17,"Flags":0},"Name":{"Type":25,"Flags":0},"Release":{"Type":25,"Flags":0},"SourceLayerHash":{"Type":25,"Flags":0},"Version":{"Type":25,"Flags":0}}}},{"2":{"Name":"PackageFilterList"}},{"2":{"Name":"Port"}},{"2":{"Name":"PortRangeFilter","Properties":{"BeginInclusive":{"Type":3,"Flags":0},"EndInclusive":{"Type":3,"Flags":0}}}},{"2":{"Name":"PortRangeFilterList"}},{"2":{"Name":"StringComparison"}},{"2":{"Name":"StringFilter","Properties":{"Comparison":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"StringFilterList"}},{"2":{"Name":"StringInput"}},{"2":{"Name":"Timestamp"}},{"3":{"ItemType":8}},{"3":{"ItemType":25}},{"3":{"ItemType":25}},{"3":{"ItemType":25}},{"3":{"ItemType":25}},{"3":{"ItemType":25}},{"3":{"ItemType":25}},{"3":{"ItemType":25}},{"3":{"ItemType":25}},{"3":{"ItemType":8}},{"3":{"ItemType":25}},{"3":{"ItemType":25}},{"3":{"ItemType":25}},{"3":{"ItemType":25}},{"3":{"ItemType":25}},{"3":{"ItemType":25}},{"3":{"ItemType":8}},{"3":{"ItemType":17}},{"3":{"ItemType":8}},{"3":{"ItemType":25}},{"3":{"ItemType":22}},{"3":{"ItemType":25}},{"3":{"ItemType":25}},{"3":{"ItemType":13}},{"3":{"ItemType":25}},{"3":{"ItemType":25}},{"3":{"ItemType":25}},{"3":{"ItemType":8}},{"3":{"ItemType":25}},{"3":{"ItemType":25}},{"3":{"ItemType":25}},{"3":{"ItemType":19}},{"3":{"ItemType":13}},{"3":{"ItemType":17}},{"3":{"ItemType":19}},{"3":{"ItemType":22}},{"3":{"ItemType":25}},{"2":{"Name":"AWS.InspectorV2/FilterProperties","Properties":{"Arn":{"Type":4,"Flags":18,"Description":"Findings filter ARN."},"Description":{"Type":4,"Flags":0,"Description":"Findings filter description."},"FilterAction":{"Type":4,"Flags":1,"Description":"Findings filter action."},"FilterCriteria":{"Type":11,"Flags":1,"Description":"Findings filter criteria."},"Name":{"Type":4,"Flags":1,"Description":"Findings filter name."}}}},{"2":{"Name":"AWS.InspectorV2/Filter","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":66,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.InspectorV2/Filter@default","ScopeType":0,"Body":67}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "CisSecurityLevel", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CisTagMap", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CisTargets", + "properties": { + "AccountIds": { + "type": { + "$ref": "#/14" + }, + "flags": 1 + }, + "TargetResourceTags": { + "type": { + "$ref": "#/15" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DailySchedule", + "properties": { + "StartTime": { + "type": { + "$ref": "#/11" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Day", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DaysList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MonthlySchedule", + "properties": { + "Day": { + "type": { + "$ref": "#/13" + }, + "flags": 1 + }, + "StartTime": { + "type": { + "$ref": "#/11" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "OneTimeSchedule", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Schedule", + "properties": { + "Daily": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "Monthly": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "OneTime": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "Weekly": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TagValueList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TargetResourceTags", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Time", + "properties": { + "TimeOfDay": { + "type": { + "$ref": "#/13" + }, + "flags": 1 + }, + "TimeZone": { + "type": { + "$ref": "#/13" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "WeeklySchedule", + "properties": { + "Days": { + "type": { + "$ref": "#/18" + }, + "flags": 1 + }, + "StartTime": { + "type": { + "$ref": "#/11" + }, + "flags": 1 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "ObjectType", + "name": "CisScanConfiguration_TargetResourceTags", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.InspectorV2/CisScanConfigurationProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.InspectorV2/CisScanConfigurationProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/13" + }, + "flags": 18, + "description": "CIS Scan configuration unique identifier" + }, + "ScanName": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "Name of the scan" + }, + "Schedule": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "SecurityLevel": { + "type": { + "$ref": "#/13" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "Targets": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.InspectorV2/CisScanConfiguration", + "properties": { + "name": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/13" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/20" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.InspectorV2/CisScanConfiguration@default", + "scopeType": 0, + "body": { + "$ref": "#/21" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "DateFilter", + "properties": { + "EndInclusive": { + "type": { + "$ref": "#/44" + }, + "flags": 0 + }, + "StartInclusive": { + "type": { + "$ref": "#/44" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DateFilterList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "FilterAction", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "FilterCriteria", + "properties": { + "AwsAccountId": { + "type": { + "$ref": "#/46" + }, + "flags": 0 + }, + "ComponentId": { + "type": { + "$ref": "#/47" + }, + "flags": 0 + }, + "ComponentType": { + "type": { + "$ref": "#/48" + }, + "flags": 0 + }, + "Ec2InstanceImageId": { + "type": { + "$ref": "#/49" + }, + "flags": 0 + }, + "Ec2InstanceSubnetId": { + "type": { + "$ref": "#/50" + }, + "flags": 0 + }, + "Ec2InstanceVpcId": { + "type": { + "$ref": "#/51" + }, + "flags": 0 + }, + "EcrImageArchitecture": { + "type": { + "$ref": "#/52" + }, + "flags": 0 + }, + "EcrImageHash": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "EcrImagePushedAt": { + "type": { + "$ref": "#/54" + }, + "flags": 0 + }, + "EcrImageRegistry": { + "type": { + "$ref": "#/55" + }, + "flags": 0 + }, + "EcrImageRepositoryName": { + "type": { + "$ref": "#/56" + }, + "flags": 0 + }, + "EcrImageTags": { + "type": { + "$ref": "#/57" + }, + "flags": 0 + }, + "FindingArn": { + "type": { + "$ref": "#/58" + }, + "flags": 0 + }, + "FindingStatus": { + "type": { + "$ref": "#/59" + }, + "flags": 0 + }, + "FindingType": { + "type": { + "$ref": "#/60" + }, + "flags": 0 + }, + "FirstObservedAt": { + "type": { + "$ref": "#/61" + }, + "flags": 0 + }, + "InspectorScore": { + "type": { + "$ref": "#/62" + }, + "flags": 0 + }, + "LastObservedAt": { + "type": { + "$ref": "#/63" + }, + "flags": 0 + }, + "NetworkProtocol": { + "type": { + "$ref": "#/64" + }, + "flags": 0 + }, + "PortRange": { + "type": { + "$ref": "#/65" + }, + "flags": 0 + }, + "RelatedVulnerabilities": { + "type": { + "$ref": "#/66" + }, + "flags": 0 + }, + "ResourceId": { + "type": { + "$ref": "#/67" + }, + "flags": 0 + }, + "ResourceTags": { + "type": { + "$ref": "#/68" + }, + "flags": 0 + }, + "ResourceType": { + "type": { + "$ref": "#/69" + }, + "flags": 0 + }, + "Severity": { + "type": { + "$ref": "#/70" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/71" + }, + "flags": 0 + }, + "UpdatedAt": { + "type": { + "$ref": "#/72" + }, + "flags": 0 + }, + "VendorSeverity": { + "type": { + "$ref": "#/73" + }, + "flags": 0 + }, + "VulnerabilityId": { + "type": { + "$ref": "#/74" + }, + "flags": 0 + }, + "VulnerabilitySource": { + "type": { + "$ref": "#/75" + }, + "flags": 0 + }, + "VulnerablePackages": { + "type": { + "$ref": "#/76" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "MapComparison", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MapFilter", + "properties": { + "Comparison": { + "type": { + "$ref": "#/13" + }, + "flags": 1 + }, + "Key": { + "type": { + "$ref": "#/13" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/13" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "MapFilterList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MapKey", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MapValue", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "NumberFilter", + "properties": { + "LowerInclusive": { + "type": { + "$ref": "#/44" + }, + "flags": 0 + }, + "UpperInclusive": { + "type": { + "$ref": "#/44" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "NumberFilterList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PackageFilter", + "properties": { + "Architecture": { + "type": { + "$ref": "#/40" + }, + "flags": 0 + }, + "Epoch": { + "type": { + "$ref": "#/32" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/40" + }, + "flags": 0 + }, + "Release": { + "type": { + "$ref": "#/40" + }, + "flags": 0 + }, + "SourceLayerHash": { + "type": { + "$ref": "#/40" + }, + "flags": 0 + }, + "Version": { + "type": { + "$ref": "#/40" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PackageFilterList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Port", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PortRangeFilter", + "properties": { + "BeginInclusive": { + "type": { + "$ref": "#/44" + }, + "flags": 0 + }, + "EndInclusive": { + "type": { + "$ref": "#/44" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PortRangeFilterList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "StringComparison", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "StringFilter", + "properties": { + "Comparison": { + "type": { + "$ref": "#/13" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/13" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "StringFilterList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "StringInput", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Timestamp", + "properties": {} + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/23" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/40" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/40" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/40" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/40" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/40" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/40" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/40" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/40" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/23" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/40" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/40" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/40" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/40" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/40" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/40" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/23" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/32" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/23" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/40" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/37" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/40" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/40" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/28" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/40" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/40" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/40" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/23" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/40" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/40" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/40" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/34" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/28" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/32" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/34" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/37" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/40" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.InspectorV2/FilterProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.InspectorV2/FilterProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/13" + }, + "flags": 18, + "description": "Findings filter ARN." + }, + "Description": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "Findings filter description." + }, + "FilterAction": { + "type": { + "$ref": "#/13" + }, + "flags": 1, + "description": "Findings filter action." + }, + "FilterCriteria": { + "type": { + "$ref": "#/26" + }, + "flags": 1, + "description": "Findings filter criteria." + }, + "Name": { + "type": { + "$ref": "#/13" + }, + "flags": 1, + "description": "Findings filter name." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.InspectorV2/Filter", + "properties": { + "name": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/13" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/83" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.InspectorV2/Filter@default", + "scopeType": 0, + "body": { + "$ref": "#/84" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.inspectorv2/default/types.md b/artifacts/bicep/aws/aws.inspectorv2/default/types.md index d3d8085c..e9e508b8 100644 --- a/artifacts/bicep/aws/aws.inspectorv2/default/types.md +++ b/artifacts/bicep/aws/aws.inspectorv2/default/types.md @@ -1,11 +1,27 @@ # AWS.InspectorV2 @ default +## Resource AWS.InspectorV2/CisScanConfiguration@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.InspectorV2/CisScanConfigurationProperties](#awsinspectorv2cisscanconfigurationproperties) (Identifier): properties of the resource + ## Resource AWS.InspectorV2/Filter@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.InspectorV2/FilterProperties](#awsinspectorv2filterproperties) (Required): properties of the resource +* **properties**: [AWS.InspectorV2/FilterProperties](#awsinspectorv2filterproperties) (Required, Identifier): properties of the resource + +## AWS.InspectorV2/CisScanConfigurationProperties +### Properties +* **Arn**: string (ReadOnly, Identifier): CIS Scan configuration unique identifier +* **ScanName**: string: Name of the scan +* **Schedule**: [Schedule](#schedule) +* **SecurityLevel**: string +* **Tags**: [CisTagMap](#cistagmap) +* **Targets**: [CisTargets](#cistargets) ## AWS.InspectorV2/FilterProperties ### Properties @@ -15,6 +31,26 @@ * **FilterCriteria**: [FilterCriteria](#filtercriteria) (Required): Findings filter criteria. * **Name**: string (Required): Findings filter name. +## CisScanConfiguration_TargetResourceTags +### Properties + +## CisTagMap +### Properties + +## CisTargets +### Properties +* **AccountIds**: string[] (Required) +* **TargetResourceTags**: [CisScanConfiguration_TargetResourceTags](#cisscanconfigurationtargetresourcetags) + +## DailySchedule +### Properties +* **StartTime**: [Time](#time) (Required) + +## DateFilter +### Properties +* **EndInclusive**: int +* **StartInclusive**: int + ## FilterCriteria ### Properties * **AwsAccountId**: [StringFilter](#stringfilter)[] @@ -49,31 +85,24 @@ * **VulnerabilitySource**: [StringFilter](#stringfilter)[] * **VulnerablePackages**: [PackageFilter](#packagefilter)[] -## StringFilter +## MapFilter ### Properties * **Comparison**: string (Required) -* **Value**: string (Required) +* **Key**: string +* **Value**: string -## DateFilter +## MonthlySchedule ### Properties -* **EndInclusive**: int -* **StartInclusive**: int +* **Day**: string (Required) +* **StartTime**: [Time](#time) (Required) ## NumberFilter ### Properties * **LowerInclusive**: int * **UpperInclusive**: int -## PortRangeFilter +## OneTimeSchedule ### Properties -* **BeginInclusive**: int -* **EndInclusive**: int - -## MapFilter -### Properties -* **Comparison**: string (Required) -* **Key**: string -* **Value**: string ## PackageFilter ### Properties @@ -84,3 +113,30 @@ * **SourceLayerHash**: [StringFilter](#stringfilter) * **Version**: [StringFilter](#stringfilter) +## PortRangeFilter +### Properties +* **BeginInclusive**: int +* **EndInclusive**: int + +## Schedule +### Properties +* **Daily**: [DailySchedule](#dailyschedule) +* **Monthly**: [MonthlySchedule](#monthlyschedule) +* **OneTime**: [OneTimeSchedule](#onetimeschedule) +* **Weekly**: [WeeklySchedule](#weeklyschedule) + +## StringFilter +### Properties +* **Comparison**: string (Required) +* **Value**: string (Required) + +## Time +### Properties +* **TimeOfDay**: string (Required) +* **TimeZone**: string (Required) + +## WeeklySchedule +### Properties +* **Days**: string[] (Required) +* **StartTime**: [Time](#time) (Required) + diff --git a/artifacts/bicep/aws/aws.internetmonitor/default/types.json b/artifacts/bicep/aws/aws.internetmonitor/default/types.json index c120eac6..f8444040 100644 --- a/artifacts/bicep/aws/aws.internetmonitor/default/types.json +++ b/artifacts/bicep/aws/aws.internetmonitor/default/types.json @@ -1 +1,306 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"HealthEventsConfig","Properties":{"AvailabilityLocalHealthEventsConfig":{"Type":10,"Flags":0},"AvailabilityScoreThreshold":{"Type":3,"Flags":0},"PerformanceLocalHealthEventsConfig":{"Type":10,"Flags":0},"PerformanceScoreThreshold":{"Type":3,"Flags":0}}}},{"2":{"Name":"InternetMeasurementsLogDelivery","Properties":{"S3Config":{"Type":13,"Flags":0}}}},{"2":{"Name":"LocalHealthEventsConfig","Properties":{"HealthScoreThreshold":{"Type":3,"Flags":0},"MinTrafficImpact":{"Type":3,"Flags":0},"Status":{"Type":4,"Flags":0}}}},{"2":{"Name":"MonitorConfigState"}},{"2":{"Name":"MonitorProcessingStatusCode"}},{"2":{"Name":"S3Config","Properties":{"BucketName":{"Type":4,"Flags":0},"BucketPrefix":{"Type":4,"Flags":0},"LogDeliveryStatus":{"Type":4,"Flags":0}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":0},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"iso8601UTC"}},{"2":{"Name":"AWS.InternetMonitor/MonitorProperties","Properties":{"CreatedAt":{"Type":4,"Flags":2},"HealthEventsConfig":{"Type":8,"Flags":0},"InternetMeasurementsLogDelivery":{"Type":9,"Flags":0},"MaxCityNetworksToMonitor":{"Type":3,"Flags":0},"ModifiedAt":{"Type":4,"Flags":2},"MonitorArn":{"Type":4,"Flags":2},"MonitorName":{"Type":4,"Flags":17},"ProcessingStatus":{"Type":4,"Flags":2},"ProcessingStatusInfo":{"Type":4,"Flags":2},"Resources":{"Type":17,"Flags":0},"ResourcesToAdd":{"Type":18,"Flags":4},"ResourcesToRemove":{"Type":19,"Flags":4},"Status":{"Type":4,"Flags":0},"Tags":{"Type":20,"Flags":0},"TrafficPercentageToMonitor":{"Type":3,"Flags":0}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":14}},{"2":{"Name":"AWS.InternetMonitor/Monitor","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":16,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.InternetMonitor/Monitor@default","ScopeType":0,"Body":21}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "HealthEventsConfig", + "properties": { + "AvailabilityLocalHealthEventsConfig": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "AvailabilityScoreThreshold": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "PerformanceLocalHealthEventsConfig": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "PerformanceScoreThreshold": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "InternetMeasurementsLogDelivery", + "properties": { + "S3Config": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "LocalHealthEventsConfig", + "properties": { + "HealthScoreThreshold": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "MinTrafficImpact": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "Status": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "MonitorConfigState", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MonitorProcessingStatusCode", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "S3Config", + "properties": { + "BucketName": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "BucketPrefix": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "LogDeliveryStatus": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "iso8601UTC", + "properties": {} + }, + { + "$type": "IntegerType" + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.InternetMonitor/MonitorProperties" + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/9" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/9" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/9" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ObjectType", + "name": "AWS.InternetMonitor/MonitorProperties", + "properties": { + "CreatedAt": { + "type": { + "$ref": "#/9" + }, + "flags": 2 + }, + "HealthEventsConfig": { + "type": { + "$ref": "#/0" + }, + "flags": 0 + }, + "IncludeLinkedAccounts": { + "type": { + "$ref": "#/11" + }, + "flags": 4 + }, + "InternetMeasurementsLogDelivery": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "LinkedAccountId": { + "type": { + "$ref": "#/9" + }, + "flags": 4 + }, + "MaxCityNetworksToMonitor": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "ModifiedAt": { + "type": { + "$ref": "#/9" + }, + "flags": 2 + }, + "MonitorArn": { + "type": { + "$ref": "#/9" + }, + "flags": 2 + }, + "MonitorName": { + "type": { + "$ref": "#/9" + }, + "flags": 17 + }, + "ProcessingStatus": { + "type": { + "$ref": "#/9" + }, + "flags": 2 + }, + "ProcessingStatusInfo": { + "type": { + "$ref": "#/9" + }, + "flags": 2 + }, + "Resources": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + }, + "ResourcesToAdd": { + "type": { + "$ref": "#/13" + }, + "flags": 4 + }, + "ResourcesToRemove": { + "type": { + "$ref": "#/14" + }, + "flags": 4 + }, + "Status": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/15" + }, + "flags": 0 + }, + "TrafficPercentageToMonitor": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.InternetMonitor/Monitor", + "properties": { + "name": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/9" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/16" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.InternetMonitor/Monitor@default", + "scopeType": 0, + "body": { + "$ref": "#/17" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.internetmonitor/default/types.md b/artifacts/bicep/aws/aws.internetmonitor/default/types.md index ab8dcdea..d552d335 100644 --- a/artifacts/bicep/aws/aws.internetmonitor/default/types.md +++ b/artifacts/bicep/aws/aws.internetmonitor/default/types.md @@ -3,15 +3,17 @@ ## Resource AWS.InternetMonitor/Monitor@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.InternetMonitor/MonitorProperties](#awsinternetmonitormonitorproperties) (Required): properties of the resource +* **properties**: [AWS.InternetMonitor/MonitorProperties](#awsinternetmonitormonitorproperties) (Required, Identifier): properties of the resource ## AWS.InternetMonitor/MonitorProperties ### Properties * **CreatedAt**: string (ReadOnly) * **HealthEventsConfig**: [HealthEventsConfig](#healtheventsconfig) +* **IncludeLinkedAccounts**: bool (WriteOnly) * **InternetMeasurementsLogDelivery**: [InternetMeasurementsLogDelivery](#internetmeasurementslogdelivery) +* **LinkedAccountId**: string (WriteOnly) * **MaxCityNetworksToMonitor**: int * **ModifiedAt**: string (ReadOnly) * **MonitorArn**: string (ReadOnly) @@ -32,16 +34,16 @@ * **PerformanceLocalHealthEventsConfig**: [LocalHealthEventsConfig](#localhealtheventsconfig) * **PerformanceScoreThreshold**: int +## InternetMeasurementsLogDelivery +### Properties +* **S3Config**: [S3Config](#s3config) + ## LocalHealthEventsConfig ### Properties * **HealthScoreThreshold**: int * **MinTrafficImpact**: int * **Status**: string -## InternetMeasurementsLogDelivery -### Properties -* **S3Config**: [S3Config](#s3config) - ## S3Config ### Properties * **BucketName**: string diff --git a/artifacts/bicep/aws/aws.iot/default/types.json b/artifacts/bicep/aws/aws.iot/default/types.json index a47d01f7..ccc25812 100644 --- a/artifacts/bicep/aws/aws.iot/default/types.json +++ b/artifacts/bicep/aws/aws.iot/default/types.json @@ -1 +1,4868 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"AuditCheckConfiguration","Properties":{"Enabled":{"Type":2,"Flags":0,"Description":"True if the check is enabled."}}}},{"2":{"Name":"AuditCheckConfigurations","Properties":{"AuthenticatedCognitoRoleOverlyPermissiveCheck":{"Type":8,"Flags":0},"CaCertificateExpiringCheck":{"Type":8,"Flags":0},"CaCertificateKeyQualityCheck":{"Type":8,"Flags":0},"ConflictingClientIdsCheck":{"Type":8,"Flags":0},"DeviceCertificateExpiringCheck":{"Type":8,"Flags":0},"DeviceCertificateKeyQualityCheck":{"Type":8,"Flags":0},"DeviceCertificateSharedCheck":{"Type":8,"Flags":0},"IntermediateCaRevokedForActiveDeviceCertificatesCheck":{"Type":8,"Flags":0},"IoTPolicyPotentialMisConfigurationCheck":{"Type":8,"Flags":0},"IotPolicyOverlyPermissiveCheck":{"Type":8,"Flags":0},"IotRoleAliasAllowsAccessToUnusedServicesCheck":{"Type":8,"Flags":0},"IotRoleAliasOverlyPermissiveCheck":{"Type":8,"Flags":0},"LoggingDisabledCheck":{"Type":8,"Flags":0},"RevokedCaCertificateStillActiveCheck":{"Type":8,"Flags":0},"RevokedDeviceCertificateStillActiveCheck":{"Type":8,"Flags":0},"UnauthenticatedCognitoRoleOverlyPermissiveCheck":{"Type":8,"Flags":0}}}},{"2":{"Name":"AuditNotificationTarget","Properties":{"Enabled":{"Type":2,"Flags":0,"Description":"True if notifications to the target are enabled."},"RoleArn":{"Type":4,"Flags":0,"Description":"The ARN of the role that grants permission to send notifications to the target."},"TargetArn":{"Type":4,"Flags":0,"Description":"The ARN of the target (SNS topic) to which audit notifications are sent."}}}},{"2":{"Name":"AuditNotificationTargetConfigurations","Properties":{"Sns":{"Type":10,"Flags":0}}}},{"2":{"Name":"AWS.IoT/AccountAuditConfigurationProperties","Properties":{"AccountId":{"Type":4,"Flags":17,"Description":"Your 12-digit account ID (used as the primary identifier for the CloudFormation resource)."},"AuditCheckConfigurations":{"Type":9,"Flags":1},"AuditNotificationTargetConfigurations":{"Type":11,"Flags":0},"RoleArn":{"Type":4,"Flags":1,"Description":"The ARN of the role that grants permission to AWS IoT to access information about your devices, policies, certificates and other items as required when performing an audit."}}}},{"2":{"Name":"AWS.IoT/AccountAuditConfiguration","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":12,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IoT/AccountAuditConfiguration@default","ScopeType":0,"Body":13}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.IoT/AuthorizerProperties","Properties":{"Arn":{"Type":4,"Flags":2},"AuthorizerFunctionArn":{"Type":4,"Flags":1},"AuthorizerName":{"Type":4,"Flags":16},"EnableCachingForHttp":{"Type":2,"Flags":0},"SigningDisabled":{"Type":2,"Flags":0},"Status":{"Type":4,"Flags":0},"Tags":{"Type":17,"Flags":0},"TokenKeyName":{"Type":4,"Flags":0},"TokenSigningPublicKeys":{"Type":18,"Flags":0}}}},{"3":{"ItemType":15}},{"2":{"Name":"Authorizer_TokenSigningPublicKeys","Properties":{}}},{"2":{"Name":"AWS.IoT/Authorizer","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":16,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IoT/Authorizer@default","ScopeType":0,"Body":19}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}}}},{"2":{"Name":"AWS.IoT/BillingGroupProperties","Properties":{"Arn":{"Type":4,"Flags":2},"BillingGroupName":{"Type":4,"Flags":16},"BillingGroupProperties":{"Type":23,"Flags":0},"Id":{"Type":4,"Flags":2},"Tags":{"Type":24,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."}}}},{"2":{"Name":"BillingGroup_BillingGroupProperties","Properties":{"BillingGroupDescription":{"Type":4,"Flags":0}}}},{"3":{"ItemType":21}},{"2":{"Name":"AWS.IoT/BillingGroup","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":22,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IoT/BillingGroup@default","ScopeType":0,"Body":25}},{"2":{"Name":"RegistrationConfig","Properties":{"RoleArn":{"Type":4,"Flags":0},"TemplateBody":{"Type":4,"Flags":0},"TemplateName":{"Type":4,"Flags":0}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.IoT/CACertificateProperties","Properties":{"Arn":{"Type":4,"Flags":2},"AutoRegistrationStatus":{"Type":4,"Flags":0},"CACertificatePem":{"Type":4,"Flags":1},"CertificateMode":{"Type":4,"Flags":0},"Id":{"Type":4,"Flags":18},"RegistrationConfig":{"Type":27,"Flags":0},"RemoveAutoRegistration":{"Type":2,"Flags":4},"Status":{"Type":4,"Flags":1},"Tags":{"Type":30,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."},"VerificationCertificatePem":{"Type":4,"Flags":4,"Description":"The private key verification certificate."}}}},{"3":{"ItemType":28}},{"2":{"Name":"AWS.IoT/CACertificate","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":29,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IoT/CACertificate@default","ScopeType":0,"Body":31}},{"2":{"Name":"AWS.IoT/CertificateProperties","Properties":{"Arn":{"Type":4,"Flags":2},"CACertificatePem":{"Type":4,"Flags":4},"CertificateMode":{"Type":4,"Flags":0},"CertificatePem":{"Type":4,"Flags":0},"CertificateSigningRequest":{"Type":4,"Flags":4},"Id":{"Type":4,"Flags":18},"Status":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.IoT/Certificate","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":33,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IoT/Certificate@default","ScopeType":0,"Body":34}},{"2":{"Name":"CertificateProviderOperation"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.IoT/CertificateProviderProperties","Properties":{"AccountDefaultForOperations":{"Type":39,"Flags":1},"Arn":{"Type":4,"Flags":2},"CertificateProviderName":{"Type":4,"Flags":16},"LambdaFunctionArn":{"Type":4,"Flags":1},"Tags":{"Type":40,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":37}},{"2":{"Name":"AWS.IoT/CertificateProvider","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":38,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IoT/CertificateProvider@default","ScopeType":0,"Body":41}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The tag's key."},"Value":{"Type":4,"Flags":1,"Description":"The tag's value."}}}},{"2":{"Name":"AWS.IoT/CustomMetricProperties","Properties":{"DisplayName":{"Type":4,"Flags":0,"Description":"Field represents a friendly name in the console for the custom metric; it doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated once defined."},"MetricArn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Number (ARN) of the custom metric."},"MetricName":{"Type":4,"Flags":16,"Description":"The name of the custom metric. This will be used in the metric report submitted from the device/thing. Shouldn't begin with aws: . Cannot be updated once defined."},"MetricType":{"Type":4,"Flags":1,"Description":"The type of the custom metric. Types include string-list, ip-address-list, number-list, and number."},"Tags":{"Type":45,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."}}}},{"3":{"ItemType":43}},{"2":{"Name":"AWS.IoT/CustomMetric","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":44,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IoT/CustomMetric@default","ScopeType":0,"Body":46}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The tag's key."},"Value":{"Type":4,"Flags":1,"Description":"The tag's value."}}}},{"2":{"Name":"AWS.IoT/DimensionProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"The ARN (Amazon resource name) of the created dimension."},"Name":{"Type":4,"Flags":16,"Description":"A unique identifier for the dimension."},"StringValues":{"Type":50,"Flags":1,"Description":"Specifies the value or list of values for the dimension."},"Tags":{"Type":51,"Flags":0,"Description":"Metadata that can be used to manage the dimension."},"Type":{"Type":4,"Flags":1,"Description":"Specifies the type of the dimension."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":48}},{"2":{"Name":"AWS.IoT/Dimension","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":49,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IoT/Dimension@default","ScopeType":0,"Body":52}},{"2":{"Name":"AuthorizerConfig","Properties":{"AllowAuthorizerOverride":{"Type":2,"Flags":0},"DefaultAuthorizerName":{"Type":4,"Flags":0}}}},{"2":{"Name":"ServerCertificateConfig","Properties":{"EnableOCSPCheck":{"Type":2,"Flags":0}}}},{"2":{"Name":"ServerCertificateSummary","Properties":{"ServerCertificateArn":{"Type":4,"Flags":0},"ServerCertificateStatus":{"Type":4,"Flags":0},"ServerCertificateStatusDetail":{"Type":4,"Flags":0}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"TlsConfig","Properties":{"SecurityPolicy":{"Type":4,"Flags":0}}}},{"2":{"Name":"AWS.IoT/DomainConfigurationProperties","Properties":{"Arn":{"Type":4,"Flags":2},"AuthorizerConfig":{"Type":54,"Flags":0},"DomainConfigurationName":{"Type":4,"Flags":16},"DomainConfigurationStatus":{"Type":4,"Flags":0},"DomainName":{"Type":4,"Flags":0},"DomainType":{"Type":4,"Flags":2},"ServerCertificateArns":{"Type":60,"Flags":4},"ServerCertificateConfig":{"Type":55,"Flags":0},"ServerCertificates":{"Type":61,"Flags":2},"ServiceType":{"Type":4,"Flags":0},"Tags":{"Type":62,"Flags":0},"TlsConfig":{"Type":58,"Flags":0},"ValidationCertificateArn":{"Type":4,"Flags":4}}}},{"3":{"ItemType":4}},{"3":{"ItemType":56}},{"3":{"ItemType":57}},{"2":{"Name":"AWS.IoT/DomainConfiguration","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":59,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IoT/DomainConfiguration@default","ScopeType":0,"Body":63}},{"2":{"Name":"AggregationType","Properties":{"Name":{"Type":4,"Flags":1,"Description":"Fleet Indexing aggregation type names such as Statistics, Percentiles and Cardinality"},"Values":{"Type":67,"Flags":1,"Description":"Fleet Indexing aggregation type values"}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The tag's key"},"Value":{"Type":4,"Flags":1,"Description":"The tag's value"}}}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.IoT/FleetMetricProperties","Properties":{"AggregationField":{"Type":4,"Flags":0,"Description":"The aggregation field to perform aggregation and metric emission"},"AggregationType":{"Type":65,"Flags":0},"CreationDate":{"Type":3,"Flags":2,"Description":"The creation date of a fleet metric"},"Description":{"Type":4,"Flags":0,"Description":"The description of a fleet metric"},"IndexName":{"Type":4,"Flags":0,"Description":"The index name of a fleet metric"},"LastModifiedDate":{"Type":3,"Flags":2,"Description":"The last modified date of a fleet metric"},"MetricArn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Number (ARN) of a fleet metric metric"},"MetricName":{"Type":4,"Flags":17,"Description":"The name of the fleet metric"},"Period":{"Type":3,"Flags":0,"Description":"The period of metric emission in seconds"},"QueryString":{"Type":4,"Flags":0,"Description":"The Fleet Indexing query used by a fleet metric"},"QueryVersion":{"Type":4,"Flags":0,"Description":"The version of a Fleet Indexing query used by a fleet metric"},"Tags":{"Type":69,"Flags":0,"Description":"An array of key-value pairs to apply to this resource"},"Unit":{"Type":4,"Flags":0,"Description":"The unit of data points emitted by a fleet metric"},"Version":{"Type":3,"Flags":2,"Description":"The version of a fleet metric"}}}},{"3":{"ItemType":66}},{"2":{"Name":"AWS.IoT/FleetMetric","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":68,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IoT/FleetMetric@default","ScopeType":0,"Body":70}},{"2":{"Name":"AWS.IoT/LoggingProperties","Properties":{"AccountId":{"Type":4,"Flags":17,"Description":"Your 12-digit account ID (used as the primary identifier for the CloudFormation resource)."},"DefaultLogLevel":{"Type":4,"Flags":1,"Description":"The log level to use. Valid values are: ERROR, WARN, INFO, DEBUG, or DISABLED."},"RoleArn":{"Type":4,"Flags":1,"Description":"The ARN of the role that allows IoT to write to Cloudwatch logs."}}}},{"2":{"Name":"AWS.IoT/Logging","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":72,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IoT/Logging@default","ScopeType":0,"Body":73}},{"2":{"Name":"ActionParams","Properties":{"AddThingsToThingGroupParams":{"Type":76,"Flags":0},"EnableIoTLoggingParams":{"Type":77,"Flags":0},"PublishFindingToSnsParams":{"Type":78,"Flags":0},"ReplaceDefaultPolicyVersionParams":{"Type":79,"Flags":0},"UpdateCACertificateParams":{"Type":81,"Flags":0},"UpdateDeviceCertificateParams":{"Type":82,"Flags":0}}}},{"2":{"Name":"AddThingsToThingGroupParams","Properties":{"OverrideDynamicGroups":{"Type":2,"Flags":0,"Description":"Specifies if this mitigation action can move the things that triggered the mitigation action out of one or more dynamic thing groups."},"ThingGroupNames":{"Type":83,"Flags":1,"Description":"The list of groups to which you want to add the things that triggered the mitigation action."}}}},{"2":{"Name":"EnableIoTLoggingParams","Properties":{"LogLevel":{"Type":4,"Flags":1,"Description":" Specifies which types of information are logged."},"RoleArnForLogging":{"Type":4,"Flags":1,"Description":" The ARN of the IAM role used for logging."}}}},{"2":{"Name":"PublishFindingToSnsParams","Properties":{"TopicArn":{"Type":4,"Flags":1,"Description":"The ARN of the topic to which you want to publish the findings."}}}},{"2":{"Name":"ReplaceDefaultPolicyVersionParams","Properties":{"TemplateName":{"Type":4,"Flags":1}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The tag's key."},"Value":{"Type":4,"Flags":1,"Description":"The tag's value."}}}},{"2":{"Name":"UpdateCACertificateParams","Properties":{"Action":{"Type":4,"Flags":1}}}},{"2":{"Name":"UpdateDeviceCertificateParams","Properties":{"Action":{"Type":4,"Flags":1}}}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.IoT/MitigationActionProperties","Properties":{"ActionName":{"Type":4,"Flags":16,"Description":"A unique identifier for the mitigation action."},"ActionParams":{"Type":75,"Flags":1},"MitigationActionArn":{"Type":4,"Flags":2},"MitigationActionId":{"Type":4,"Flags":2},"RoleArn":{"Type":4,"Flags":1},"Tags":{"Type":85,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."}}}},{"3":{"ItemType":80}},{"2":{"Name":"AWS.IoT/MitigationAction","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":84,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IoT/MitigationAction@default","ScopeType":0,"Body":86}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.IoT/PolicyProperties","Properties":{"Arn":{"Type":4,"Flags":2},"Id":{"Type":4,"Flags":18},"PolicyDocument":{"Type":91,"Flags":1},"PolicyName":{"Type":4,"Flags":0},"Tags":{"Type":92,"Flags":0}}}},{"2":{"Name":"Policy_PolicyDocument","Properties":{}}},{"5":{"Elements":[90,4]}},{"3":{"ItemType":88}},{"2":{"Name":"AWS.IoT/Policy","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":89,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IoT/Policy@default","ScopeType":0,"Body":93}},{"2":{"Name":"ProvisioningHook","Properties":{"PayloadVersion":{"Type":4,"Flags":0},"TargetArn":{"Type":4,"Flags":0}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.IoT/ProvisioningTemplateProperties","Properties":{"Description":{"Type":4,"Flags":0},"Enabled":{"Type":2,"Flags":0},"PreProvisioningHook":{"Type":95,"Flags":0},"ProvisioningRoleArn":{"Type":4,"Flags":1},"Tags":{"Type":98,"Flags":0},"TemplateArn":{"Type":4,"Flags":2},"TemplateBody":{"Type":4,"Flags":1},"TemplateName":{"Type":4,"Flags":16},"TemplateType":{"Type":4,"Flags":0}}}},{"3":{"ItemType":96}},{"2":{"Name":"AWS.IoT/ProvisioningTemplate","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":97,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IoT/ProvisioningTemplate@default","ScopeType":0,"Body":99}},{"2":{"Name":"AWS.IoT/ResourceSpecificLoggingProperties","Properties":{"LogLevel":{"Type":4,"Flags":1,"Description":"The log level for a specific target. Valid values are: ERROR, WARN, INFO, DEBUG, or DISABLED."},"TargetId":{"Type":4,"Flags":18,"Description":"Unique Id for a Target (TargetType:TargetName), this will be internally built to serve as primary identifier for a log target."},"TargetName":{"Type":4,"Flags":1,"Description":"The target name."},"TargetType":{"Type":4,"Flags":1,"Description":"The target type. Value must be THING_GROUP, CLIENT_ID, SOURCE_IP, PRINCIPAL_ID, or EVENT_TYPE."}}}},{"2":{"Name":"AWS.IoT/ResourceSpecificLogging","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":101,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IoT/ResourceSpecificLogging@default","ScopeType":0,"Body":102}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.IoT/RoleAliasProperties","Properties":{"CredentialDurationSeconds":{"Type":3,"Flags":0},"RoleAlias":{"Type":4,"Flags":16},"RoleAliasArn":{"Type":4,"Flags":2},"RoleArn":{"Type":4,"Flags":1},"Tags":{"Type":106,"Flags":0}}}},{"3":{"ItemType":104}},{"2":{"Name":"AWS.IoT/RoleAlias","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":105,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IoT/RoleAlias@default","ScopeType":0,"Body":107}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The tag's key."},"Value":{"Type":4,"Flags":1,"Description":"The tag's value."}}}},{"2":{"Name":"AWS.IoT/ScheduledAuditProperties","Properties":{"DayOfMonth":{"Type":4,"Flags":0,"Description":"The day of the month on which the scheduled audit takes place. Can be 1 through 31 or LAST. This field is required if the frequency parameter is set to MONTHLY."},"DayOfWeek":{"Type":4,"Flags":0,"Description":"The day of the week on which the scheduled audit takes place. Can be one of SUN, MON, TUE,WED, THU, FRI, or SAT. This field is required if the frequency parameter is set to WEEKLY or BIWEEKLY."},"Frequency":{"Type":4,"Flags":1,"Description":"How often the scheduled audit takes place. Can be one of DAILY, WEEKLY, BIWEEKLY, or MONTHLY."},"ScheduledAuditArn":{"Type":4,"Flags":2,"Description":"The ARN (Amazon resource name) of the scheduled audit."},"ScheduledAuditName":{"Type":4,"Flags":16,"Description":"The name you want to give to the scheduled audit."},"Tags":{"Type":111,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."},"TargetCheckNames":{"Type":112,"Flags":1,"Description":"Which checks are performed during the scheduled audit. Checks must be enabled for your account."}}}},{"3":{"ItemType":109}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.IoT/ScheduledAudit","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":110,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IoT/ScheduledAudit@default","ScopeType":0,"Body":113}},{"2":{"Name":"AlertTarget","Properties":{"AlertTargetArn":{"Type":4,"Flags":1,"Description":"The ARN of the notification target to which alerts are sent."},"RoleArn":{"Type":4,"Flags":1,"Description":"The ARN of the role that grants permission to send alerts to the notification target."}}}},{"2":{"Name":"Behavior","Properties":{"Criteria":{"Type":117,"Flags":0},"ExportMetric":{"Type":2,"Flags":0},"Metric":{"Type":4,"Flags":0,"Description":"What is measured by the behavior."},"MetricDimension":{"Type":120,"Flags":0},"Name":{"Type":4,"Flags":1,"Description":"The name for the behavior."},"SuppressAlerts":{"Type":2,"Flags":0,"Description":"Manage Detect alarm SNS notifications by setting behavior notification to on or suppressed. Detect will continue to performing device behavior evaluations. However, suppressed alarms wouldn't be forwarded for SNS notification."}}}},{"2":{"Name":"BehaviorCriteria","Properties":{"ComparisonOperator":{"Type":4,"Flags":0,"Description":"The operator that relates the thing measured (metric) to the criteria (containing a value or statisticalThreshold)."},"ConsecutiveDatapointsToAlarm":{"Type":3,"Flags":0,"Description":"If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs. If not specified, the default is 1."},"ConsecutiveDatapointsToClear":{"Type":3,"Flags":0,"Description":"If an alarm has occurred and the offending device is no longer in violation of the behavior for the specified number of consecutive datapoints, the alarm is cleared. If not specified, the default is 1."},"DurationSeconds":{"Type":3,"Flags":0,"Description":"Use this to specify the time duration over which the behavior is evaluated."},"MlDetectionConfig":{"Type":119,"Flags":0},"StatisticalThreshold":{"Type":123,"Flags":0},"Value":{"Type":122,"Flags":0}}}},{"2":{"Name":"ExportMetric"}},{"2":{"Name":"MachineLearningDetectionConfig","Properties":{"ConfidenceLevel":{"Type":4,"Flags":0,"Description":"The sensitivity of anomalous behavior evaluation. Can be Low, Medium, or High."}}}},{"2":{"Name":"MetricDimension","Properties":{"DimensionName":{"Type":4,"Flags":1,"Description":"A unique identifier for the dimension."},"Operator":{"Type":4,"Flags":0,"Description":"Defines how the dimensionValues of a dimension are interpreted."}}}},{"2":{"Name":"MetricToRetain","Properties":{"ExportMetric":{"Type":2,"Flags":0},"Metric":{"Type":4,"Flags":1,"Description":"What is measured by the behavior."},"MetricDimension":{"Type":120,"Flags":0}}}},{"2":{"Name":"MetricValue","Properties":{"Cidrs":{"Type":125,"Flags":0,"Description":"If the ComparisonOperator calls for a set of CIDRs, use this to specify that set to be compared with the metric."},"Count":{"Type":4,"Flags":0,"Description":"If the ComparisonOperator calls for a numeric value, use this to specify that (integer) numeric value to be compared with the metric."},"Number":{"Type":3,"Flags":0,"Description":"The numeral value of a metric."},"Numbers":{"Type":126,"Flags":0,"Description":"The numeral values of a metric."},"Ports":{"Type":127,"Flags":0,"Description":"If the ComparisonOperator calls for a set of ports, use this to specify that set to be compared with the metric."},"Strings":{"Type":128,"Flags":0,"Description":"The string values of a metric."}}}},{"2":{"Name":"StatisticalThreshold","Properties":{"Statistic":{"Type":4,"Flags":0,"Description":"The percentile which resolves to a threshold value by which compliance with a behavior is determined"}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The tag's key."},"Value":{"Type":4,"Flags":1,"Description":"The tag's value."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":3}},{"3":{"ItemType":3}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.IoT/SecurityProfileProperties","Properties":{"AdditionalMetricsToRetainV2":{"Type":130,"Flags":0,"Description":"A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here."},"AlertTargets":{"Type":131,"Flags":0,"Description":"Specifies the destinations to which alerts are sent."},"Behaviors":{"Type":132,"Flags":0,"Description":"Specifies the behaviors that, when violated by a device (thing), cause an alert."},"MetricsExportConfig":{"Type":133,"Flags":0,"Description":"A structure containing the mqtt topic for metrics export."},"SecurityProfileArn":{"Type":4,"Flags":2,"Description":"The ARN (Amazon resource name) of the created security profile."},"SecurityProfileDescription":{"Type":4,"Flags":0,"Description":"A description of the security profile."},"SecurityProfileName":{"Type":4,"Flags":16,"Description":"A unique identifier for the security profile."},"Tags":{"Type":134,"Flags":0,"Description":"Metadata that can be used to manage the security profile."},"TargetArns":{"Type":135,"Flags":0,"Description":"A set of target ARNs that the security profile is attached to."}}}},{"3":{"ItemType":121}},{"2":{"Name":"SecurityProfile_AlertTargets","Properties":{}}},{"3":{"ItemType":116}},{"2":{"Name":"SecurityProfile_MetricsExportConfig","Properties":{"MqttTopic":{"Type":4,"Flags":1,"Description":"The topic for metrics export."},"RoleArn":{"Type":4,"Flags":1,"Description":"The ARN of the role that grants permission to publish to mqtt topic."}}}},{"3":{"ItemType":124}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.IoT/SecurityProfile","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":129,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IoT/SecurityProfile@default","ScopeType":0,"Body":136}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}}}},{"2":{"Name":"AWS.IoT/SoftwarePackageProperties","Properties":{"Description":{"Type":4,"Flags":0},"PackageArn":{"Type":4,"Flags":2},"PackageName":{"Type":4,"Flags":16},"Tags":{"Type":140,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."}}}},{"3":{"ItemType":138}},{"2":{"Name":"AWS.IoT/SoftwarePackage","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":139,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IoT/SoftwarePackage@default","ScopeType":0,"Body":141}},{"2":{"Name":"PackageVersionStatus"}},{"2":{"Name":"ResourceAttributes","Properties":{}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}}}},{"2":{"Name":"AWS.IoT/SoftwarePackageVersionProperties","Properties":{"Attributes":{"Type":144,"Flags":0},"Description":{"Type":4,"Flags":0},"ErrorReason":{"Type":4,"Flags":2},"PackageName":{"Type":4,"Flags":17},"PackageVersionArn":{"Type":4,"Flags":2},"Status":{"Type":4,"Flags":2},"Tags":{"Type":147,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."},"VersionName":{"Type":4,"Flags":16}}}},{"3":{"ItemType":145}},{"2":{"Name":"AWS.IoT/SoftwarePackageVersion","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":146,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IoT/SoftwarePackageVersion@default","ScopeType":0,"Body":148}},{"2":{"Name":"AttributePayload","Properties":{"Attributes":{"Type":151,"Flags":0}}}},{"2":{"Name":"Thing_Attributes","Properties":{}}},{"2":{"Name":"AWS.IoT/ThingProperties","Properties":{"Arn":{"Type":4,"Flags":2},"AttributePayload":{"Type":150,"Flags":0},"Id":{"Type":4,"Flags":2},"ThingName":{"Type":4,"Flags":16}}}},{"2":{"Name":"AWS.IoT/Thing","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":152,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IoT/Thing@default","ScopeType":0,"Body":153}},{"2":{"Name":"AttributePayload","Properties":{"Attributes":{"Type":157,"Flags":0}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}}}},{"2":{"Name":"ThingGroup_Attributes","Properties":{}}},{"2":{"Name":"AWS.IoT/ThingGroupProperties","Properties":{"Arn":{"Type":4,"Flags":2},"Id":{"Type":4,"Flags":2},"ParentGroupName":{"Type":4,"Flags":0},"QueryString":{"Type":4,"Flags":0},"Tags":{"Type":159,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."},"ThingGroupName":{"Type":4,"Flags":16},"ThingGroupProperties":{"Type":160,"Flags":0}}}},{"3":{"ItemType":156}},{"2":{"Name":"ThingGroup_ThingGroupProperties","Properties":{"AttributePayload":{"Type":155,"Flags":0},"ThingGroupDescription":{"Type":4,"Flags":0}}}},{"2":{"Name":"AWS.IoT/ThingGroup","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":158,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IoT/ThingGroup@default","ScopeType":0,"Body":161}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}}}},{"2":{"Name":"AWS.IoT/ThingTypeProperties","Properties":{"Arn":{"Type":4,"Flags":2},"DeprecateThingType":{"Type":2,"Flags":0},"Id":{"Type":4,"Flags":2},"Tags":{"Type":165,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."},"ThingTypeName":{"Type":4,"Flags":16},"ThingTypeProperties":{"Type":167,"Flags":0}}}},{"3":{"ItemType":163}},{"3":{"ItemType":4}},{"2":{"Name":"ThingType_ThingTypeProperties","Properties":{"SearchableAttributes":{"Type":166,"Flags":0},"ThingTypeDescription":{"Type":4,"Flags":0}}}},{"2":{"Name":"AWS.IoT/ThingType","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":164,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IoT/ThingType@default","ScopeType":0,"Body":168}},{"2":{"Name":"Action","Properties":{"CloudwatchAlarm":{"Type":175,"Flags":0},"CloudwatchLogs":{"Type":176,"Flags":0},"CloudwatchMetric":{"Type":177,"Flags":0},"DynamoDB":{"Type":178,"Flags":0},"DynamoDBv2":{"Type":179,"Flags":0},"Elasticsearch":{"Type":180,"Flags":0},"Firehose":{"Type":181,"Flags":0},"Http":{"Type":182,"Flags":0},"IotAnalytics":{"Type":185,"Flags":0},"IotEvents":{"Type":186,"Flags":0},"IotSiteWise":{"Type":187,"Flags":0},"Kafka":{"Type":188,"Flags":0},"Kinesis":{"Type":190,"Flags":0},"Lambda":{"Type":191,"Flags":0},"Location":{"Type":192,"Flags":0},"OpenSearch":{"Type":193,"Flags":0},"Republish":{"Type":196,"Flags":0},"S3":{"Type":199,"Flags":0},"Sns":{"Type":201,"Flags":0},"Sqs":{"Type":202,"Flags":0},"StepFunctions":{"Type":203,"Flags":0},"Timestream":{"Type":206,"Flags":0}}}},{"2":{"Name":"AssetPropertyTimestamp","Properties":{"OffsetInNanos":{"Type":4,"Flags":0},"TimeInSeconds":{"Type":4,"Flags":1}}}},{"2":{"Name":"AssetPropertyValue","Properties":{"Quality":{"Type":4,"Flags":0},"Timestamp":{"Type":171,"Flags":1},"Value":{"Type":173,"Flags":1}}}},{"2":{"Name":"AssetPropertyVariant","Properties":{"BooleanValue":{"Type":4,"Flags":0},"DoubleValue":{"Type":4,"Flags":0},"IntegerValue":{"Type":4,"Flags":0},"StringValue":{"Type":4,"Flags":0}}}},{"2":{"Name":"CannedAccessControlList"}},{"2":{"Name":"CloudwatchAlarmAction","Properties":{"AlarmName":{"Type":4,"Flags":1},"RoleArn":{"Type":4,"Flags":1},"StateReason":{"Type":4,"Flags":1},"StateValue":{"Type":4,"Flags":1}}}},{"2":{"Name":"CloudwatchLogsAction","Properties":{"BatchMode":{"Type":2,"Flags":0},"LogGroupName":{"Type":4,"Flags":1},"RoleArn":{"Type":4,"Flags":1}}}},{"2":{"Name":"CloudwatchMetricAction","Properties":{"MetricName":{"Type":4,"Flags":1},"MetricNamespace":{"Type":4,"Flags":1},"MetricTimestamp":{"Type":4,"Flags":0},"MetricUnit":{"Type":4,"Flags":1},"MetricValue":{"Type":4,"Flags":1},"RoleArn":{"Type":4,"Flags":1}}}},{"2":{"Name":"DynamoDBAction","Properties":{"HashKeyField":{"Type":4,"Flags":1},"HashKeyType":{"Type":4,"Flags":0},"HashKeyValue":{"Type":4,"Flags":1},"PayloadField":{"Type":4,"Flags":0},"RangeKeyField":{"Type":4,"Flags":0},"RangeKeyType":{"Type":4,"Flags":0},"RangeKeyValue":{"Type":4,"Flags":0},"RoleArn":{"Type":4,"Flags":1},"TableName":{"Type":4,"Flags":1}}}},{"2":{"Name":"DynamoDBv2Action","Properties":{"PutItem":{"Type":195,"Flags":0},"RoleArn":{"Type":4,"Flags":0}}}},{"2":{"Name":"ElasticsearchAction","Properties":{"Endpoint":{"Type":4,"Flags":1},"Id":{"Type":4,"Flags":1},"Index":{"Type":4,"Flags":1},"RoleArn":{"Type":4,"Flags":1},"Type":{"Type":4,"Flags":1}}}},{"2":{"Name":"FirehoseAction","Properties":{"BatchMode":{"Type":2,"Flags":0},"DeliveryStreamName":{"Type":4,"Flags":1},"RoleArn":{"Type":4,"Flags":1},"Separator":{"Type":4,"Flags":0}}}},{"2":{"Name":"HttpAction","Properties":{"Auth":{"Type":184,"Flags":0},"ConfirmationUrl":{"Type":4,"Flags":0},"Headers":{"Type":213,"Flags":0},"Url":{"Type":4,"Flags":1}}}},{"2":{"Name":"HttpActionHeader","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"HttpAuthorization","Properties":{"Sigv4":{"Type":200,"Flags":0}}}},{"2":{"Name":"IotAnalyticsAction","Properties":{"BatchMode":{"Type":2,"Flags":0},"ChannelName":{"Type":4,"Flags":1},"RoleArn":{"Type":4,"Flags":1}}}},{"2":{"Name":"IotEventsAction","Properties":{"BatchMode":{"Type":2,"Flags":0},"InputName":{"Type":4,"Flags":1},"MessageId":{"Type":4,"Flags":0},"RoleArn":{"Type":4,"Flags":1}}}},{"2":{"Name":"IotSiteWiseAction","Properties":{"PutAssetPropertyValueEntries":{"Type":214,"Flags":1},"RoleArn":{"Type":4,"Flags":1}}}},{"2":{"Name":"KafkaAction","Properties":{"ClientProperties":{"Type":215,"Flags":1},"DestinationArn":{"Type":4,"Flags":1},"Headers":{"Type":216,"Flags":0},"Key":{"Type":4,"Flags":0},"Partition":{"Type":4,"Flags":0},"Topic":{"Type":4,"Flags":1}}}},{"2":{"Name":"KafkaActionHeader","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"KinesisAction","Properties":{"PartitionKey":{"Type":4,"Flags":0},"RoleArn":{"Type":4,"Flags":1},"StreamName":{"Type":4,"Flags":1}}}},{"2":{"Name":"LambdaAction","Properties":{"FunctionArn":{"Type":4,"Flags":0}}}},{"2":{"Name":"LocationAction","Properties":{"DeviceId":{"Type":4,"Flags":1},"Latitude":{"Type":4,"Flags":1},"Longitude":{"Type":4,"Flags":1},"RoleArn":{"Type":4,"Flags":1},"Timestamp":{"Type":205,"Flags":0},"TrackerName":{"Type":4,"Flags":1}}}},{"2":{"Name":"OpenSearchAction","Properties":{"Endpoint":{"Type":4,"Flags":1},"Id":{"Type":4,"Flags":1},"Index":{"Type":4,"Flags":1},"RoleArn":{"Type":4,"Flags":1},"Type":{"Type":4,"Flags":1}}}},{"2":{"Name":"PutAssetPropertyValueEntry","Properties":{"AssetId":{"Type":4,"Flags":0},"EntryId":{"Type":4,"Flags":0},"PropertyAlias":{"Type":4,"Flags":0},"PropertyId":{"Type":4,"Flags":0},"PropertyValues":{"Type":217,"Flags":1}}}},{"2":{"Name":"PutItemInput","Properties":{"TableName":{"Type":4,"Flags":1}}}},{"2":{"Name":"RepublishAction","Properties":{"Headers":{"Type":197,"Flags":0},"Qos":{"Type":3,"Flags":0},"RoleArn":{"Type":4,"Flags":1},"Topic":{"Type":4,"Flags":1}}}},{"2":{"Name":"RepublishActionHeaders","Properties":{"ContentType":{"Type":4,"Flags":0},"CorrelationData":{"Type":4,"Flags":0},"MessageExpiry":{"Type":4,"Flags":0},"PayloadFormatIndicator":{"Type":4,"Flags":0},"ResponseTopic":{"Type":4,"Flags":0},"UserProperties":{"Type":218,"Flags":0}}}},{"2":{"Name":"RoleArn"}},{"2":{"Name":"S3Action","Properties":{"BucketName":{"Type":4,"Flags":1},"CannedAcl":{"Type":4,"Flags":0},"Key":{"Type":4,"Flags":1},"RoleArn":{"Type":4,"Flags":1}}}},{"2":{"Name":"SigV4Authorization","Properties":{"RoleArn":{"Type":4,"Flags":1},"ServiceName":{"Type":4,"Flags":1},"SigningRegion":{"Type":4,"Flags":1}}}},{"2":{"Name":"SnsAction","Properties":{"MessageFormat":{"Type":4,"Flags":0},"RoleArn":{"Type":4,"Flags":1},"TargetArn":{"Type":4,"Flags":1}}}},{"2":{"Name":"SqsAction","Properties":{"QueueUrl":{"Type":4,"Flags":1},"RoleArn":{"Type":4,"Flags":1},"UseBase64":{"Type":2,"Flags":0}}}},{"2":{"Name":"StepFunctionsAction","Properties":{"ExecutionNamePrefix":{"Type":4,"Flags":0},"RoleArn":{"Type":4,"Flags":1},"StateMachineName":{"Type":4,"Flags":1}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"Timestamp","Properties":{"Unit":{"Type":4,"Flags":0},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"TimestreamAction","Properties":{"DatabaseName":{"Type":4,"Flags":1},"Dimensions":{"Type":219,"Flags":1},"RoleArn":{"Type":4,"Flags":1},"TableName":{"Type":4,"Flags":1},"Timestamp":{"Type":209,"Flags":0}}}},{"2":{"Name":"TimestreamDimension","Properties":{"Name":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"TimestreamDimensionsList"}},{"2":{"Name":"TimestreamTimestamp","Properties":{"Unit":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"TopicRulePayload","Properties":{"Actions":{"Type":221,"Flags":1},"AwsIotSqlVersion":{"Type":4,"Flags":0},"Description":{"Type":4,"Flags":0},"ErrorAction":{"Type":170,"Flags":0},"RuleDisabled":{"Type":2,"Flags":0},"Sql":{"Type":4,"Flags":1}}}},{"2":{"Name":"UserProperties"}},{"2":{"Name":"UserProperty","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"3":{"ItemType":183}},{"3":{"ItemType":194}},{"2":{"Name":"TopicRule_ClientProperties","Properties":{}}},{"3":{"ItemType":189}},{"3":{"ItemType":172}},{"3":{"ItemType":212}},{"3":{"ItemType":207}},{"3":{"ItemType":207}},{"3":{"ItemType":170}},{"3":{"ItemType":212}},{"2":{"Name":"AWS.IoT/TopicRuleProperties","Properties":{"Arn":{"Type":4,"Flags":2},"RuleName":{"Type":4,"Flags":16},"Tags":{"Type":224,"Flags":0},"TopicRulePayload":{"Type":210,"Flags":1}}}},{"3":{"ItemType":204}},{"2":{"Name":"AWS.IoT/TopicRule","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":223,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IoT/TopicRule@default","ScopeType":0,"Body":225}},{"2":{"Name":"HttpUrlDestinationSummary","Properties":{"ConfirmationUrl":{"Type":4,"Flags":0}}}},{"2":{"Name":"TopicRuleDestinationStatus"}},{"2":{"Name":"VpcDestinationProperties","Properties":{"RoleArn":{"Type":4,"Flags":0},"SecurityGroups":{"Type":230,"Flags":0},"SubnetIds":{"Type":231,"Flags":0},"VpcId":{"Type":4,"Flags":0}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.IoT/TopicRuleDestinationProperties","Properties":{"Arn":{"Type":4,"Flags":18,"Description":"Amazon Resource Name (ARN)."},"HttpUrlProperties":{"Type":227,"Flags":0,"Description":"HTTP URL destination properties."},"Status":{"Type":4,"Flags":0,"Description":"The status of the TopicRuleDestination."},"StatusReason":{"Type":4,"Flags":2,"Description":"The reasoning for the current status of the TopicRuleDestination."},"VpcProperties":{"Type":229,"Flags":0,"Description":"VPC destination properties."}}}},{"2":{"Name":"AWS.IoT/TopicRuleDestination","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":232,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IoT/TopicRuleDestination@default","ScopeType":0,"Body":233}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "AuditCheckConfiguration", + "properties": { + "Enabled": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "True if the check is enabled." + } + } + }, + { + "$type": "ObjectType", + "name": "AuditCheckConfigurations", + "properties": { + "AuthenticatedCognitoRoleOverlyPermissiveCheck": { + "type": { + "$ref": "#/0" + }, + "flags": 0 + }, + "CaCertificateExpiringCheck": { + "type": { + "$ref": "#/0" + }, + "flags": 0 + }, + "CaCertificateKeyQualityCheck": { + "type": { + "$ref": "#/0" + }, + "flags": 0 + }, + "ConflictingClientIdsCheck": { + "type": { + "$ref": "#/0" + }, + "flags": 0 + }, + "DeviceCertificateExpiringCheck": { + "type": { + "$ref": "#/0" + }, + "flags": 0 + }, + "DeviceCertificateKeyQualityCheck": { + "type": { + "$ref": "#/0" + }, + "flags": 0 + }, + "DeviceCertificateSharedCheck": { + "type": { + "$ref": "#/0" + }, + "flags": 0 + }, + "IntermediateCaRevokedForActiveDeviceCertificatesCheck": { + "type": { + "$ref": "#/0" + }, + "flags": 0 + }, + "IoTPolicyPotentialMisConfigurationCheck": { + "type": { + "$ref": "#/0" + }, + "flags": 0 + }, + "IotPolicyOverlyPermissiveCheck": { + "type": { + "$ref": "#/0" + }, + "flags": 0 + }, + "IotRoleAliasAllowsAccessToUnusedServicesCheck": { + "type": { + "$ref": "#/0" + }, + "flags": 0 + }, + "IotRoleAliasOverlyPermissiveCheck": { + "type": { + "$ref": "#/0" + }, + "flags": 0 + }, + "LoggingDisabledCheck": { + "type": { + "$ref": "#/0" + }, + "flags": 0 + }, + "RevokedCaCertificateStillActiveCheck": { + "type": { + "$ref": "#/0" + }, + "flags": 0 + }, + "RevokedDeviceCertificateStillActiveCheck": { + "type": { + "$ref": "#/0" + }, + "flags": 0 + }, + "UnauthenticatedCognitoRoleOverlyPermissiveCheck": { + "type": { + "$ref": "#/0" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AuditNotificationTarget", + "properties": { + "Enabled": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "True if notifications to the target are enabled." + }, + "RoleArn": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The ARN of the role that grants permission to send notifications to the target." + }, + "TargetArn": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The ARN of the target (SNS topic) to which audit notifications are sent." + } + } + }, + { + "$type": "ObjectType", + "name": "AuditNotificationTargetConfigurations", + "properties": { + "Sns": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.IoT/AccountAuditConfigurationProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.IoT/AccountAuditConfigurationProperties", + "properties": { + "AccountId": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "Your 12-digit account ID (used as the primary identifier for the CloudFormation resource)." + }, + "AuditCheckConfigurations": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "AuditNotificationTargetConfigurations": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "RoleArn": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The ARN of the role that grants permission to AWS IoT to access information about your devices, policies, certificates and other items as required when performing an audit." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoT/AccountAuditConfiguration", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/7" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IoT/AccountAuditConfiguration@default", + "scopeType": 0, + "body": { + "$ref": "#/8" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.IoT/AuthorizerProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/10" + } + }, + { + "$type": "ObjectType", + "name": "Authorizer_TokenSigningPublicKeys", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AWS.IoT/AuthorizerProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "AuthorizerFunctionArn": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "AuthorizerName": { + "type": { + "$ref": "#/5" + }, + "flags": 16 + }, + "EnableCachingForHttp": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "SigningDisabled": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "Status": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + }, + "TokenKeyName": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "TokenSigningPublicKeys": { + "type": { + "$ref": "#/13" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoT/Authorizer", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/14" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IoT/Authorizer@default", + "scopeType": 0, + "body": { + "$ref": "#/15" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.IoT/BillingGroupProperties" + }, + { + "$type": "ObjectType", + "name": "BillingGroup_BillingGroupProperties", + "properties": { + "BillingGroupDescription": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/17" + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoT/BillingGroupProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "BillingGroupName": { + "type": { + "$ref": "#/5" + }, + "flags": 16 + }, + "BillingGroupProperties": { + "type": { + "$ref": "#/19" + }, + "flags": 0 + }, + "Id": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "Tags": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoT/BillingGroup", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/21" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IoT/BillingGroup@default", + "scopeType": 0, + "body": { + "$ref": "#/22" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "RegistrationConfig", + "properties": { + "RoleArn": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "TemplateBody": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "TemplateName": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.IoT/CACertificateProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/25" + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoT/CACertificateProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "AutoRegistrationStatus": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "CACertificatePem": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "CertificateMode": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Id": { + "type": { + "$ref": "#/5" + }, + "flags": 18 + }, + "RegistrationConfig": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "RemoveAutoRegistration": { + "type": { + "$ref": "#/4" + }, + "flags": 4 + }, + "Status": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/27" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + }, + "VerificationCertificatePem": { + "type": { + "$ref": "#/5" + }, + "flags": 4, + "description": "The private key verification certificate." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoT/CACertificate", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/28" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IoT/CACertificate@default", + "scopeType": 0, + "body": { + "$ref": "#/29" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.IoT/CertificateProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.IoT/CertificateProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "CACertificatePem": { + "type": { + "$ref": "#/5" + }, + "flags": 4 + }, + "CertificateMode": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "CertificatePem": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "CertificateSigningRequest": { + "type": { + "$ref": "#/5" + }, + "flags": 4 + }, + "Id": { + "type": { + "$ref": "#/5" + }, + "flags": 18 + }, + "Status": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoT/Certificate", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/32" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IoT/Certificate@default", + "scopeType": 0, + "body": { + "$ref": "#/33" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "CertificateProviderOperation", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.IoT/CertificateProviderProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/36" + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoT/CertificateProviderProperties", + "properties": { + "AccountDefaultForOperations": { + "type": { + "$ref": "#/38" + }, + "flags": 1 + }, + "Arn": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "CertificateProviderName": { + "type": { + "$ref": "#/5" + }, + "flags": 16 + }, + "LambdaFunctionArn": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/39" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoT/CertificateProvider", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/40" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IoT/CertificateProvider@default", + "scopeType": 0, + "body": { + "$ref": "#/41" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The tag's key." + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The tag's value." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.IoT/CustomMetricProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/43" + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoT/CustomMetricProperties", + "properties": { + "DisplayName": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "Field represents a friendly name in the console for the custom metric; it doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated once defined." + }, + "MetricArn": { + "type": { + "$ref": "#/5" + }, + "flags": 2, + "description": "The Amazon Resource Number (ARN) of the custom metric." + }, + "MetricName": { + "type": { + "$ref": "#/5" + }, + "flags": 16, + "description": "The name of the custom metric. This will be used in the metric report submitted from the device/thing. Shouldn't begin with aws: . Cannot be updated once defined." + }, + "MetricType": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The type of the custom metric. Types include string-list, ip-address-list, number-list, and number." + }, + "Tags": { + "type": { + "$ref": "#/45" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoT/CustomMetric", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/46" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IoT/CustomMetric@default", + "scopeType": 0, + "body": { + "$ref": "#/47" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The tag's key." + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The tag's value." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.IoT/DimensionProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/49" + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoT/DimensionProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/5" + }, + "flags": 2, + "description": "The ARN (Amazon resource name) of the created dimension." + }, + "Name": { + "type": { + "$ref": "#/5" + }, + "flags": 16, + "description": "A unique identifier for the dimension." + }, + "StringValues": { + "type": { + "$ref": "#/51" + }, + "flags": 1, + "description": "Specifies the value or list of values for the dimension." + }, + "Tags": { + "type": { + "$ref": "#/52" + }, + "flags": 0, + "description": "Metadata that can be used to manage the dimension." + }, + "Type": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "Specifies the type of the dimension." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoT/Dimension", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/53" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IoT/Dimension@default", + "scopeType": 0, + "body": { + "$ref": "#/54" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AuthorizerConfig", + "properties": { + "AllowAuthorizerOverride": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "DefaultAuthorizerName": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ServerCertificateConfig", + "properties": { + "EnableOCSPCheck": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ServerCertificateSummary", + "properties": { + "ServerCertificateArn": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "ServerCertificateStatus": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "ServerCertificateStatusDetail": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TlsConfig", + "properties": { + "SecurityPolicy": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.IoT/DomainConfigurationProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/58" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/59" + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoT/DomainConfigurationProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "AuthorizerConfig": { + "type": { + "$ref": "#/56" + }, + "flags": 0 + }, + "DomainConfigurationName": { + "type": { + "$ref": "#/5" + }, + "flags": 16 + }, + "DomainConfigurationStatus": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "DomainName": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "DomainType": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "ServerCertificateArns": { + "type": { + "$ref": "#/62" + }, + "flags": 4 + }, + "ServerCertificateConfig": { + "type": { + "$ref": "#/57" + }, + "flags": 0 + }, + "ServerCertificates": { + "type": { + "$ref": "#/63" + }, + "flags": 2 + }, + "ServiceType": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/64" + }, + "flags": 0 + }, + "TlsConfig": { + "type": { + "$ref": "#/60" + }, + "flags": 0 + }, + "ValidationCertificateArn": { + "type": { + "$ref": "#/5" + }, + "flags": 4 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoT/DomainConfiguration", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/65" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IoT/DomainConfiguration@default", + "scopeType": 0, + "body": { + "$ref": "#/66" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AggregationType", + "properties": { + "Name": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "Fleet Indexing aggregation type names such as Statistics, Percentiles and Cardinality" + }, + "Values": { + "type": { + "$ref": "#/71" + }, + "flags": 1, + "description": "Fleet Indexing aggregation type values" + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The tag's key" + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The tag's value" + } + } + }, + { + "$type": "ObjectType", + "name": "iso8601UTC", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.IoT/FleetMetricProperties" + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/69" + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoT/FleetMetricProperties", + "properties": { + "AggregationField": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The aggregation field to perform aggregation and metric emission" + }, + "AggregationType": { + "type": { + "$ref": "#/68" + }, + "flags": 0 + }, + "CreationDate": { + "type": { + "$ref": "#/5" + }, + "flags": 2, + "description": "The creation date of a fleet metric" + }, + "Description": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The description of a fleet metric" + }, + "IndexName": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The index name of a fleet metric" + }, + "LastModifiedDate": { + "type": { + "$ref": "#/5" + }, + "flags": 2, + "description": "The last modified date of a fleet metric" + }, + "MetricArn": { + "type": { + "$ref": "#/5" + }, + "flags": 2, + "description": "The Amazon Resource Number (ARN) of a fleet metric metric" + }, + "MetricName": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "The name of the fleet metric" + }, + "Period": { + "type": { + "$ref": "#/73" + }, + "flags": 0, + "description": "The period of metric emission in seconds" + }, + "QueryString": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The Fleet Indexing query used by a fleet metric" + }, + "QueryVersion": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The version of a Fleet Indexing query used by a fleet metric" + }, + "Tags": { + "type": { + "$ref": "#/74" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource" + }, + "Unit": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The unit of data points emitted by a fleet metric" + }, + "Version": { + "type": { + "$ref": "#/73" + }, + "flags": 2, + "description": "The version of a fleet metric" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoT/FleetMetric", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/75" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IoT/FleetMetric@default", + "scopeType": 0, + "body": { + "$ref": "#/76" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.IoT/LoggingProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.IoT/LoggingProperties", + "properties": { + "AccountId": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "Your 12-digit account ID (used as the primary identifier for the CloudFormation resource)." + }, + "DefaultLogLevel": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The log level to use. Valid values are: ERROR, WARN, INFO, DEBUG, or DISABLED." + }, + "RoleArn": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The ARN of the role that allows IoT to write to Cloudwatch logs." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoT/Logging", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/79" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IoT/Logging@default", + "scopeType": 0, + "body": { + "$ref": "#/80" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "ActionParams", + "properties": { + "AddThingsToThingGroupParams": { + "type": { + "$ref": "#/83" + }, + "flags": 0 + }, + "EnableIoTLoggingParams": { + "type": { + "$ref": "#/84" + }, + "flags": 0 + }, + "PublishFindingToSnsParams": { + "type": { + "$ref": "#/85" + }, + "flags": 0 + }, + "ReplaceDefaultPolicyVersionParams": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + }, + "UpdateCACertificateParams": { + "type": { + "$ref": "#/88" + }, + "flags": 0 + }, + "UpdateDeviceCertificateParams": { + "type": { + "$ref": "#/89" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AddThingsToThingGroupParams", + "properties": { + "OverrideDynamicGroups": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Specifies if this mitigation action can move the things that triggered the mitigation action out of one or more dynamic thing groups." + }, + "ThingGroupNames": { + "type": { + "$ref": "#/90" + }, + "flags": 1, + "description": "The list of groups to which you want to add the things that triggered the mitigation action." + } + } + }, + { + "$type": "ObjectType", + "name": "EnableIoTLoggingParams", + "properties": { + "LogLevel": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": " Specifies which types of information are logged." + }, + "RoleArnForLogging": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": " The ARN of the IAM role used for logging." + } + } + }, + { + "$type": "ObjectType", + "name": "PublishFindingToSnsParams", + "properties": { + "TopicArn": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The ARN of the topic to which you want to publish the findings." + } + } + }, + { + "$type": "ObjectType", + "name": "ReplaceDefaultPolicyVersionParams", + "properties": { + "TemplateName": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The tag's key." + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The tag's value." + } + } + }, + { + "$type": "ObjectType", + "name": "UpdateCACertificateParams", + "properties": { + "Action": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "UpdateDeviceCertificateParams", + "properties": { + "Action": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.IoT/MitigationActionProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/87" + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoT/MitigationActionProperties", + "properties": { + "ActionName": { + "type": { + "$ref": "#/5" + }, + "flags": 16, + "description": "A unique identifier for the mitigation action." + }, + "ActionParams": { + "type": { + "$ref": "#/82" + }, + "flags": 1 + }, + "MitigationActionArn": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "MitigationActionId": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "RoleArn": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/92" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoT/MitigationAction", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/93" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IoT/MitigationAction@default", + "scopeType": 0, + "body": { + "$ref": "#/94" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.IoT/PolicyProperties" + }, + { + "$type": "ObjectType", + "name": "Policy_PolicyDocument", + "properties": {} + }, + { + "$type": "UnionType", + "elements": [ + { + "$ref": "#/98" + }, + { + "$ref": "#/5" + } + ] + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/96" + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoT/PolicyProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "Id": { + "type": { + "$ref": "#/5" + }, + "flags": 18 + }, + "PolicyDocument": { + "type": { + "$ref": "#/99" + }, + "flags": 1 + }, + "PolicyName": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/100" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoT/Policy", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/101" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IoT/Policy@default", + "scopeType": 0, + "body": { + "$ref": "#/102" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "ProvisioningHook", + "properties": { + "PayloadVersion": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "TargetArn": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.IoT/ProvisioningTemplateProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/105" + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoT/ProvisioningTemplateProperties", + "properties": { + "Description": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Enabled": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "PreProvisioningHook": { + "type": { + "$ref": "#/104" + }, + "flags": 0 + }, + "ProvisioningRoleArn": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/107" + }, + "flags": 0 + }, + "TemplateArn": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "TemplateBody": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "TemplateName": { + "type": { + "$ref": "#/5" + }, + "flags": 16 + }, + "TemplateType": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoT/ProvisioningTemplate", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/108" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IoT/ProvisioningTemplate@default", + "scopeType": 0, + "body": { + "$ref": "#/109" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.IoT/ResourceSpecificLoggingProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.IoT/ResourceSpecificLoggingProperties", + "properties": { + "LogLevel": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The log level for a specific target. Valid values are: ERROR, WARN, INFO, DEBUG, or DISABLED." + }, + "TargetId": { + "type": { + "$ref": "#/5" + }, + "flags": 18, + "description": "Unique Id for a Target (TargetType:TargetName), this will be internally built to serve as primary identifier for a log target." + }, + "TargetName": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The target name." + }, + "TargetType": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The target type. Value must be THING_GROUP, CLIENT_ID, SOURCE_IP, PRINCIPAL_ID, or EVENT_TYPE." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoT/ResourceSpecificLogging", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/112" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IoT/ResourceSpecificLogging@default", + "scopeType": 0, + "body": { + "$ref": "#/113" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.IoT/RoleAliasProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/115" + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoT/RoleAliasProperties", + "properties": { + "CredentialDurationSeconds": { + "type": { + "$ref": "#/73" + }, + "flags": 0 + }, + "RoleAlias": { + "type": { + "$ref": "#/5" + }, + "flags": 16 + }, + "RoleAliasArn": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "RoleArn": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/117" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoT/RoleAlias", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/118" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IoT/RoleAlias@default", + "scopeType": 0, + "body": { + "$ref": "#/119" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The tag's key." + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The tag's value." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.IoT/ScheduledAuditProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/121" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoT/ScheduledAuditProperties", + "properties": { + "DayOfMonth": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The day of the month on which the scheduled audit takes place. Can be 1 through 31 or LAST. This field is required if the frequency parameter is set to MONTHLY." + }, + "DayOfWeek": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The day of the week on which the scheduled audit takes place. Can be one of SUN, MON, TUE,WED, THU, FRI, or SAT. This field is required if the frequency parameter is set to WEEKLY or BIWEEKLY." + }, + "Frequency": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "How often the scheduled audit takes place. Can be one of DAILY, WEEKLY, BIWEEKLY, or MONTHLY." + }, + "ScheduledAuditArn": { + "type": { + "$ref": "#/5" + }, + "flags": 2, + "description": "The ARN (Amazon resource name) of the scheduled audit." + }, + "ScheduledAuditName": { + "type": { + "$ref": "#/5" + }, + "flags": 16, + "description": "The name you want to give to the scheduled audit." + }, + "Tags": { + "type": { + "$ref": "#/123" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + }, + "TargetCheckNames": { + "type": { + "$ref": "#/124" + }, + "flags": 1, + "description": "Which checks are performed during the scheduled audit. Checks must be enabled for your account." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoT/ScheduledAudit", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/125" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IoT/ScheduledAudit@default", + "scopeType": 0, + "body": { + "$ref": "#/126" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AlertTarget", + "properties": { + "AlertTargetArn": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The ARN of the notification target to which alerts are sent." + }, + "RoleArn": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The ARN of the role that grants permission to send alerts to the notification target." + } + } + }, + { + "$type": "ObjectType", + "name": "Behavior", + "properties": { + "Criteria": { + "type": { + "$ref": "#/130" + }, + "flags": 0 + }, + "ExportMetric": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "Metric": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "What is measured by the behavior." + }, + "MetricDimension": { + "type": { + "$ref": "#/133" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The name for the behavior." + }, + "SuppressAlerts": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Manage Detect alarm SNS notifications by setting behavior notification to on or suppressed. Detect will continue to performing device behavior evaluations. However, suppressed alarms wouldn't be forwarded for SNS notification." + } + } + }, + { + "$type": "ObjectType", + "name": "BehaviorCriteria", + "properties": { + "ComparisonOperator": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The operator that relates the thing measured (metric) to the criteria (containing a value or statisticalThreshold)." + }, + "ConsecutiveDatapointsToAlarm": { + "type": { + "$ref": "#/73" + }, + "flags": 0, + "description": "If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs. If not specified, the default is 1." + }, + "ConsecutiveDatapointsToClear": { + "type": { + "$ref": "#/73" + }, + "flags": 0, + "description": "If an alarm has occurred and the offending device is no longer in violation of the behavior for the specified number of consecutive datapoints, the alarm is cleared. If not specified, the default is 1." + }, + "DurationSeconds": { + "type": { + "$ref": "#/73" + }, + "flags": 0, + "description": "Use this to specify the time duration over which the behavior is evaluated." + }, + "MlDetectionConfig": { + "type": { + "$ref": "#/132" + }, + "flags": 0 + }, + "StatisticalThreshold": { + "type": { + "$ref": "#/136" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/135" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ExportMetric", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MachineLearningDetectionConfig", + "properties": { + "ConfidenceLevel": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The sensitivity of anomalous behavior evaluation. Can be Low, Medium, or High." + } + } + }, + { + "$type": "ObjectType", + "name": "MetricDimension", + "properties": { + "DimensionName": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "A unique identifier for the dimension." + }, + "Operator": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "Defines how the dimensionValues of a dimension are interpreted." + } + } + }, + { + "$type": "ObjectType", + "name": "MetricToRetain", + "properties": { + "ExportMetric": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "Metric": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "What is measured by the behavior." + }, + "MetricDimension": { + "type": { + "$ref": "#/133" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "MetricValue", + "properties": { + "Cidrs": { + "type": { + "$ref": "#/138" + }, + "flags": 0, + "description": "If the ComparisonOperator calls for a set of CIDRs, use this to specify that set to be compared with the metric." + }, + "Count": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "If the ComparisonOperator calls for a numeric value, use this to specify that (integer) numeric value to be compared with the metric." + }, + "Number": { + "type": { + "$ref": "#/73" + }, + "flags": 0, + "description": "The numeral value of a metric." + }, + "Numbers": { + "type": { + "$ref": "#/139" + }, + "flags": 0, + "description": "The numeral values of a metric." + }, + "Ports": { + "type": { + "$ref": "#/140" + }, + "flags": 0, + "description": "If the ComparisonOperator calls for a set of ports, use this to specify that set to be compared with the metric." + }, + "Strings": { + "type": { + "$ref": "#/141" + }, + "flags": 0, + "description": "The string values of a metric." + } + } + }, + { + "$type": "ObjectType", + "name": "StatisticalThreshold", + "properties": { + "Statistic": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The percentile which resolves to a threshold value by which compliance with a behavior is determined" + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The tag's key." + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The tag's value." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/73" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/73" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.IoT/SecurityProfileProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/134" + } + }, + { + "$type": "ObjectType", + "name": "SecurityProfile_AlertTargets", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/129" + } + }, + { + "$type": "ObjectType", + "name": "SecurityProfile_MetricsExportConfig", + "properties": { + "MqttTopic": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The topic for metrics export." + }, + "RoleArn": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The ARN of the role that grants permission to publish to mqtt topic." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/137" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoT/SecurityProfileProperties", + "properties": { + "AdditionalMetricsToRetainV2": { + "type": { + "$ref": "#/143" + }, + "flags": 0, + "description": "A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here." + }, + "AlertTargets": { + "type": { + "$ref": "#/144" + }, + "flags": 0, + "description": "Specifies the destinations to which alerts are sent." + }, + "Behaviors": { + "type": { + "$ref": "#/145" + }, + "flags": 0, + "description": "Specifies the behaviors that, when violated by a device (thing), cause an alert." + }, + "MetricsExportConfig": { + "type": { + "$ref": "#/146" + }, + "flags": 0, + "description": "A structure containing the mqtt topic for metrics export." + }, + "SecurityProfileArn": { + "type": { + "$ref": "#/5" + }, + "flags": 2, + "description": "The ARN (Amazon resource name) of the created security profile." + }, + "SecurityProfileDescription": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "A description of the security profile." + }, + "SecurityProfileName": { + "type": { + "$ref": "#/5" + }, + "flags": 16, + "description": "A unique identifier for the security profile." + }, + "Tags": { + "type": { + "$ref": "#/147" + }, + "flags": 0, + "description": "Metadata that can be used to manage the security profile." + }, + "TargetArns": { + "type": { + "$ref": "#/148" + }, + "flags": 0, + "description": "A set of target ARNs that the security profile is attached to." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoT/SecurityProfile", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/149" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IoT/SecurityProfile@default", + "scopeType": 0, + "body": { + "$ref": "#/150" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.IoT/SoftwarePackageProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/152" + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoT/SoftwarePackageProperties", + "properties": { + "Description": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "PackageArn": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "PackageName": { + "type": { + "$ref": "#/5" + }, + "flags": 16 + }, + "Tags": { + "type": { + "$ref": "#/154" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoT/SoftwarePackage", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/155" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IoT/SoftwarePackage@default", + "scopeType": 0, + "body": { + "$ref": "#/156" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "PackageVersionStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ResourceAttributes", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.IoT/SoftwarePackageVersionProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/160" + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoT/SoftwarePackageVersionProperties", + "properties": { + "Attributes": { + "type": { + "$ref": "#/159" + }, + "flags": 0 + }, + "Description": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "ErrorReason": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "PackageName": { + "type": { + "$ref": "#/5" + }, + "flags": 17 + }, + "PackageVersionArn": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "Status": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "Tags": { + "type": { + "$ref": "#/162" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + }, + "VersionName": { + "type": { + "$ref": "#/5" + }, + "flags": 16 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoT/SoftwarePackageVersion", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/163" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IoT/SoftwarePackageVersion@default", + "scopeType": 0, + "body": { + "$ref": "#/164" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AttributePayload", + "properties": { + "Attributes": { + "type": { + "$ref": "#/167" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Thing_Attributes", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.IoT/ThingProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.IoT/ThingProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "AttributePayload": { + "type": { + "$ref": "#/166" + }, + "flags": 0 + }, + "Id": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "ThingName": { + "type": { + "$ref": "#/5" + }, + "flags": 16 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoT/Thing", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/169" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IoT/Thing@default", + "scopeType": 0, + "body": { + "$ref": "#/170" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AttributePayload", + "properties": { + "Attributes": { + "type": { + "$ref": "#/174" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + } + } + }, + { + "$type": "ObjectType", + "name": "ThingGroup_Attributes", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.IoT/ThingGroupProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/173" + } + }, + { + "$type": "ObjectType", + "name": "ThingGroup_ThingGroupProperties", + "properties": { + "AttributePayload": { + "type": { + "$ref": "#/172" + }, + "flags": 0 + }, + "ThingGroupDescription": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoT/ThingGroupProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "Id": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "ParentGroupName": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "QueryString": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/176" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + }, + "ThingGroupName": { + "type": { + "$ref": "#/5" + }, + "flags": 16 + }, + "ThingGroupProperties": { + "type": { + "$ref": "#/177" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoT/ThingGroup", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/178" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IoT/ThingGroup@default", + "scopeType": 0, + "body": { + "$ref": "#/179" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.IoT/ThingTypeProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/181" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ObjectType", + "name": "ThingType_ThingTypeProperties", + "properties": { + "SearchableAttributes": { + "type": { + "$ref": "#/184" + }, + "flags": 0 + }, + "ThingTypeDescription": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoT/ThingTypeProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "DeprecateThingType": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "Id": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "Tags": { + "type": { + "$ref": "#/183" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + }, + "ThingTypeName": { + "type": { + "$ref": "#/5" + }, + "flags": 16 + }, + "ThingTypeProperties": { + "type": { + "$ref": "#/185" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoT/ThingType", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/186" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IoT/ThingType@default", + "scopeType": 0, + "body": { + "$ref": "#/187" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Action", + "properties": { + "CloudwatchAlarm": { + "type": { + "$ref": "#/194" + }, + "flags": 0 + }, + "CloudwatchLogs": { + "type": { + "$ref": "#/195" + }, + "flags": 0 + }, + "CloudwatchMetric": { + "type": { + "$ref": "#/196" + }, + "flags": 0 + }, + "DynamoDB": { + "type": { + "$ref": "#/197" + }, + "flags": 0 + }, + "DynamoDBv2": { + "type": { + "$ref": "#/198" + }, + "flags": 0 + }, + "Elasticsearch": { + "type": { + "$ref": "#/199" + }, + "flags": 0 + }, + "Firehose": { + "type": { + "$ref": "#/200" + }, + "flags": 0 + }, + "Http": { + "type": { + "$ref": "#/201" + }, + "flags": 0 + }, + "IotAnalytics": { + "type": { + "$ref": "#/204" + }, + "flags": 0 + }, + "IotEvents": { + "type": { + "$ref": "#/205" + }, + "flags": 0 + }, + "IotSiteWise": { + "type": { + "$ref": "#/206" + }, + "flags": 0 + }, + "Kafka": { + "type": { + "$ref": "#/207" + }, + "flags": 0 + }, + "Kinesis": { + "type": { + "$ref": "#/209" + }, + "flags": 0 + }, + "Lambda": { + "type": { + "$ref": "#/210" + }, + "flags": 0 + }, + "Location": { + "type": { + "$ref": "#/211" + }, + "flags": 0 + }, + "OpenSearch": { + "type": { + "$ref": "#/212" + }, + "flags": 0 + }, + "Republish": { + "type": { + "$ref": "#/215" + }, + "flags": 0 + }, + "S3": { + "type": { + "$ref": "#/218" + }, + "flags": 0 + }, + "Sns": { + "type": { + "$ref": "#/220" + }, + "flags": 0 + }, + "Sqs": { + "type": { + "$ref": "#/221" + }, + "flags": 0 + }, + "StepFunctions": { + "type": { + "$ref": "#/222" + }, + "flags": 0 + }, + "Timestream": { + "type": { + "$ref": "#/225" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AssetPropertyTimestamp", + "properties": { + "OffsetInNanos": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "TimeInSeconds": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AssetPropertyValue", + "properties": { + "Quality": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Timestamp": { + "type": { + "$ref": "#/190" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/192" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AssetPropertyVariant", + "properties": { + "BooleanValue": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "DoubleValue": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "IntegerValue": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "StringValue": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CannedAccessControlList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CloudwatchAlarmAction", + "properties": { + "AlarmName": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "RoleArn": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "StateReason": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "StateValue": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CloudwatchLogsAction", + "properties": { + "BatchMode": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "LogGroupName": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "RoleArn": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CloudwatchMetricAction", + "properties": { + "MetricName": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "MetricNamespace": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "MetricTimestamp": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "MetricUnit": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "MetricValue": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "RoleArn": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DynamoDBAction", + "properties": { + "HashKeyField": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "HashKeyType": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "HashKeyValue": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "PayloadField": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "RangeKeyField": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "RangeKeyType": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "RangeKeyValue": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "RoleArn": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "TableName": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DynamoDBv2Action", + "properties": { + "PutItem": { + "type": { + "$ref": "#/214" + }, + "flags": 0 + }, + "RoleArn": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ElasticsearchAction", + "properties": { + "Endpoint": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Id": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Index": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "RoleArn": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Type": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "FirehoseAction", + "properties": { + "BatchMode": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "DeliveryStreamName": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "RoleArn": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Separator": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "HttpAction", + "properties": { + "Auth": { + "type": { + "$ref": "#/203" + }, + "flags": 0 + }, + "ConfirmationUrl": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Headers": { + "type": { + "$ref": "#/232" + }, + "flags": 0 + }, + "Url": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "HttpActionHeader", + "properties": { + "Key": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "HttpAuthorization", + "properties": { + "Sigv4": { + "type": { + "$ref": "#/219" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "IotAnalyticsAction", + "properties": { + "BatchMode": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "ChannelName": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "RoleArn": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "IotEventsAction", + "properties": { + "BatchMode": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "InputName": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "MessageId": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "RoleArn": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "IotSiteWiseAction", + "properties": { + "PutAssetPropertyValueEntries": { + "type": { + "$ref": "#/233" + }, + "flags": 1 + }, + "RoleArn": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "KafkaAction", + "properties": { + "ClientProperties": { + "type": { + "$ref": "#/234" + }, + "flags": 1 + }, + "DestinationArn": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Headers": { + "type": { + "$ref": "#/235" + }, + "flags": 0 + }, + "Key": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Partition": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Topic": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "KafkaActionHeader", + "properties": { + "Key": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "KinesisAction", + "properties": { + "PartitionKey": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "RoleArn": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "StreamName": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "LambdaAction", + "properties": { + "FunctionArn": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "LocationAction", + "properties": { + "DeviceId": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Latitude": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Longitude": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "RoleArn": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Timestamp": { + "type": { + "$ref": "#/224" + }, + "flags": 0 + }, + "TrackerName": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "OpenSearchAction", + "properties": { + "Endpoint": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Id": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Index": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "RoleArn": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Type": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "PutAssetPropertyValueEntry", + "properties": { + "AssetId": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "EntryId": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "PropertyAlias": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "PropertyId": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "PropertyValues": { + "type": { + "$ref": "#/236" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "PutItemInput", + "properties": { + "TableName": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "RepublishAction", + "properties": { + "Headers": { + "type": { + "$ref": "#/216" + }, + "flags": 0 + }, + "Qos": { + "type": { + "$ref": "#/73" + }, + "flags": 0 + }, + "RoleArn": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Topic": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "RepublishActionHeaders", + "properties": { + "ContentType": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "CorrelationData": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "MessageExpiry": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "PayloadFormatIndicator": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "ResponseTopic": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "UserProperties": { + "type": { + "$ref": "#/237" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "RoleArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "S3Action", + "properties": { + "BucketName": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "CannedAcl": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Key": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "RoleArn": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "SigV4Authorization", + "properties": { + "RoleArn": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "ServiceName": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "SigningRegion": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "SnsAction", + "properties": { + "MessageFormat": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "RoleArn": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "TargetArn": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "SqsAction", + "properties": { + "QueueUrl": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "RoleArn": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "UseBase64": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "StepFunctionsAction", + "properties": { + "ExecutionNamePrefix": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "RoleArn": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "StateMachineName": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Timestamp", + "properties": { + "Unit": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TimestreamAction", + "properties": { + "DatabaseName": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Dimensions": { + "type": { + "$ref": "#/238" + }, + "flags": 1 + }, + "RoleArn": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "TableName": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Timestamp": { + "type": { + "$ref": "#/228" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TimestreamDimension", + "properties": { + "Name": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TimestreamDimensionsList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TimestreamTimestamp", + "properties": { + "Unit": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TopicRulePayload", + "properties": { + "Actions": { + "type": { + "$ref": "#/240" + }, + "flags": 1 + }, + "AwsIotSqlVersion": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Description": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "ErrorAction": { + "type": { + "$ref": "#/189" + }, + "flags": 0 + }, + "RuleDisabled": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "Sql": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "UserProperties", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "UserProperty", + "properties": { + "Key": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/202" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/213" + } + }, + { + "$type": "ObjectType", + "name": "TopicRule_ClientProperties", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/208" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/191" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/231" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/226" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/226" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/189" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/231" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.IoT/TopicRuleProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/223" + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoT/TopicRuleProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "RuleName": { + "type": { + "$ref": "#/5" + }, + "flags": 16 + }, + "Tags": { + "type": { + "$ref": "#/243" + }, + "flags": 0 + }, + "TopicRulePayload": { + "type": { + "$ref": "#/229" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoT/TopicRule", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/244" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IoT/TopicRule@default", + "scopeType": 0, + "body": { + "$ref": "#/245" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "HttpUrlDestinationSummary", + "properties": { + "ConfirmationUrl": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TopicRuleDestinationStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "VpcDestinationProperties", + "properties": { + "RoleArn": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "SecurityGroups": { + "type": { + "$ref": "#/250" + }, + "flags": 0 + }, + "SubnetIds": { + "type": { + "$ref": "#/251" + }, + "flags": 0 + }, + "VpcId": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.IoT/TopicRuleDestinationProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.IoT/TopicRuleDestinationProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/5" + }, + "flags": 18, + "description": "Amazon Resource Name (ARN)." + }, + "HttpUrlProperties": { + "type": { + "$ref": "#/247" + }, + "flags": 0, + "description": "HTTP URL destination properties." + }, + "Status": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The status of the TopicRuleDestination." + }, + "StatusReason": { + "type": { + "$ref": "#/5" + }, + "flags": 2, + "description": "The reasoning for the current status of the TopicRuleDestination." + }, + "VpcProperties": { + "type": { + "$ref": "#/249" + }, + "flags": 0, + "description": "VPC destination properties." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoT/TopicRuleDestination", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/253" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IoT/TopicRuleDestination@default", + "scopeType": 0, + "body": { + "$ref": "#/254" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.iot/default/types.md b/artifacts/bicep/aws/aws.iot/default/types.md index bdee0004..1c9e3a90 100644 --- a/artifacts/bicep/aws/aws.iot/default/types.md +++ b/artifacts/bicep/aws/aws.iot/default/types.md @@ -3,184 +3,251 @@ ## Resource AWS.IoT/AccountAuditConfiguration@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IoT/AccountAuditConfigurationProperties](#awsiotaccountauditconfigurationproperties) (Required): properties of the resource +* **properties**: [AWS.IoT/AccountAuditConfigurationProperties](#awsiotaccountauditconfigurationproperties) (Required, Identifier): properties of the resource ## Resource AWS.IoT/Authorizer@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IoT/AuthorizerProperties](#awsiotauthorizerproperties) (Required): properties of the resource +* **properties**: [AWS.IoT/AuthorizerProperties](#awsiotauthorizerproperties) (Required, Identifier): properties of the resource ## Resource AWS.IoT/BillingGroup@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IoT/BillingGroupProperties](#awsiotbillinggroupproperties): properties of the resource +* **properties**: [AWS.IoT/BillingGroupProperties](#awsiotbillinggroupproperties) (Identifier): properties of the resource ## Resource AWS.IoT/CACertificate@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IoT/CACertificateProperties](#awsiotcacertificateproperties) (Required): properties of the resource +* **properties**: [AWS.IoT/CACertificateProperties](#awsiotcacertificateproperties) (Required, Identifier): properties of the resource ## Resource AWS.IoT/Certificate@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IoT/CertificateProperties](#awsiotcertificateproperties) (Required): properties of the resource +* **properties**: [AWS.IoT/CertificateProperties](#awsiotcertificateproperties) (Required, Identifier): properties of the resource ## Resource AWS.IoT/CertificateProvider@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IoT/CertificateProviderProperties](#awsiotcertificateproviderproperties) (Required): properties of the resource +* **properties**: [AWS.IoT/CertificateProviderProperties](#awsiotcertificateproviderproperties) (Required, Identifier): properties of the resource ## Resource AWS.IoT/CustomMetric@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IoT/CustomMetricProperties](#awsiotcustommetricproperties) (Required): properties of the resource +* **properties**: [AWS.IoT/CustomMetricProperties](#awsiotcustommetricproperties) (Required, Identifier): properties of the resource ## Resource AWS.IoT/Dimension@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IoT/DimensionProperties](#awsiotdimensionproperties) (Required): properties of the resource +* **properties**: [AWS.IoT/DimensionProperties](#awsiotdimensionproperties) (Required, Identifier): properties of the resource ## Resource AWS.IoT/DomainConfiguration@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IoT/DomainConfigurationProperties](#awsiotdomainconfigurationproperties): properties of the resource +* **properties**: [AWS.IoT/DomainConfigurationProperties](#awsiotdomainconfigurationproperties) (Identifier): properties of the resource ## Resource AWS.IoT/FleetMetric@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IoT/FleetMetricProperties](#awsiotfleetmetricproperties) (Required): properties of the resource +* **properties**: [AWS.IoT/FleetMetricProperties](#awsiotfleetmetricproperties) (Required, Identifier): properties of the resource ## Resource AWS.IoT/Logging@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IoT/LoggingProperties](#awsiotloggingproperties) (Required): properties of the resource +* **properties**: [AWS.IoT/LoggingProperties](#awsiotloggingproperties) (Required, Identifier): properties of the resource ## Resource AWS.IoT/MitigationAction@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IoT/MitigationActionProperties](#awsiotmitigationactionproperties) (Required): properties of the resource +* **properties**: [AWS.IoT/MitigationActionProperties](#awsiotmitigationactionproperties) (Required, Identifier): properties of the resource ## Resource AWS.IoT/Policy@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IoT/PolicyProperties](#awsiotpolicyproperties) (Required): properties of the resource +* **properties**: [AWS.IoT/PolicyProperties](#awsiotpolicyproperties) (Required, Identifier): properties of the resource ## Resource AWS.IoT/ProvisioningTemplate@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IoT/ProvisioningTemplateProperties](#awsiotprovisioningtemplateproperties) (Required): properties of the resource +* **properties**: [AWS.IoT/ProvisioningTemplateProperties](#awsiotprovisioningtemplateproperties) (Required, Identifier): properties of the resource ## Resource AWS.IoT/ResourceSpecificLogging@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IoT/ResourceSpecificLoggingProperties](#awsiotresourcespecificloggingproperties) (Required): properties of the resource +* **properties**: [AWS.IoT/ResourceSpecificLoggingProperties](#awsiotresourcespecificloggingproperties) (Required, Identifier): properties of the resource ## Resource AWS.IoT/RoleAlias@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IoT/RoleAliasProperties](#awsiotrolealiasproperties) (Required): properties of the resource +* **properties**: [AWS.IoT/RoleAliasProperties](#awsiotrolealiasproperties) (Required, Identifier): properties of the resource ## Resource AWS.IoT/ScheduledAudit@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IoT/ScheduledAuditProperties](#awsiotscheduledauditproperties) (Required): properties of the resource +* **properties**: [AWS.IoT/ScheduledAuditProperties](#awsiotscheduledauditproperties) (Required, Identifier): properties of the resource ## Resource AWS.IoT/SecurityProfile@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IoT/SecurityProfileProperties](#awsiotsecurityprofileproperties): properties of the resource +* **properties**: [AWS.IoT/SecurityProfileProperties](#awsiotsecurityprofileproperties) (Identifier): properties of the resource ## Resource AWS.IoT/SoftwarePackage@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IoT/SoftwarePackageProperties](#awsiotsoftwarepackageproperties): properties of the resource +* **properties**: [AWS.IoT/SoftwarePackageProperties](#awsiotsoftwarepackageproperties) (Identifier): properties of the resource ## Resource AWS.IoT/SoftwarePackageVersion@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IoT/SoftwarePackageVersionProperties](#awsiotsoftwarepackageversionproperties) (Required): properties of the resource +* **properties**: [AWS.IoT/SoftwarePackageVersionProperties](#awsiotsoftwarepackageversionproperties) (Required, Identifier): properties of the resource ## Resource AWS.IoT/Thing@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IoT/ThingProperties](#awsiotthingproperties): properties of the resource +* **properties**: [AWS.IoT/ThingProperties](#awsiotthingproperties) (Identifier): properties of the resource ## Resource AWS.IoT/ThingGroup@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IoT/ThingGroupProperties](#awsiotthinggroupproperties): properties of the resource +* **properties**: [AWS.IoT/ThingGroupProperties](#awsiotthinggroupproperties) (Identifier): properties of the resource ## Resource AWS.IoT/ThingType@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IoT/ThingTypeProperties](#awsiotthingtypeproperties): properties of the resource +* **properties**: [AWS.IoT/ThingTypeProperties](#awsiotthingtypeproperties) (Identifier): properties of the resource ## Resource AWS.IoT/TopicRule@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IoT/TopicRuleProperties](#awsiottopicruleproperties) (Required): properties of the resource +* **properties**: [AWS.IoT/TopicRuleProperties](#awsiottopicruleproperties) (Required, Identifier): properties of the resource ## Resource AWS.IoT/TopicRuleDestination@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IoT/TopicRuleDestinationProperties](#awsiottopicruledestinationproperties): properties of the resource +* **properties**: [AWS.IoT/TopicRuleDestinationProperties](#awsiottopicruledestinationproperties) (Identifier): properties of the resource -## AWS.IoT/AccountAuditConfigurationProperties +## Action ### Properties -* **AccountId**: string (Required, Identifier): Your 12-digit account ID (used as the primary identifier for the CloudFormation resource). -* **AuditCheckConfigurations**: [AuditCheckConfigurations](#auditcheckconfigurations) (Required) -* **AuditNotificationTargetConfigurations**: [AuditNotificationTargetConfigurations](#auditnotificationtargetconfigurations) -* **RoleArn**: string (Required): The ARN of the role that grants permission to AWS IoT to access information about your devices, policies, certificates and other items as required when performing an audit. +* **CloudwatchAlarm**: [CloudwatchAlarmAction](#cloudwatchalarmaction) +* **CloudwatchLogs**: [CloudwatchLogsAction](#cloudwatchlogsaction) +* **CloudwatchMetric**: [CloudwatchMetricAction](#cloudwatchmetricaction) +* **DynamoDB**: [DynamoDBAction](#dynamodbaction) +* **DynamoDBv2**: [DynamoDBv2Action](#dynamodbv2action) +* **Elasticsearch**: [ElasticsearchAction](#elasticsearchaction) +* **Firehose**: [FirehoseAction](#firehoseaction) +* **Http**: [HttpAction](#httpaction) +* **IotAnalytics**: [IotAnalyticsAction](#iotanalyticsaction) +* **IotEvents**: [IotEventsAction](#ioteventsaction) +* **IotSiteWise**: [IotSiteWiseAction](#iotsitewiseaction) +* **Kafka**: [KafkaAction](#kafkaaction) +* **Kinesis**: [KinesisAction](#kinesisaction) +* **Lambda**: [LambdaAction](#lambdaaction) +* **Location**: [LocationAction](#locationaction) +* **OpenSearch**: [OpenSearchAction](#opensearchaction) +* **Republish**: [RepublishAction](#republishaction) +* **S3**: [S3Action](#s3action) +* **Sns**: [SnsAction](#snsaction) +* **Sqs**: [SqsAction](#sqsaction) +* **StepFunctions**: [StepFunctionsAction](#stepfunctionsaction) +* **Timestream**: [TimestreamAction](#timestreamaction) + +## ActionParams +### Properties +* **AddThingsToThingGroupParams**: [AddThingsToThingGroupParams](#addthingstothinggroupparams) +* **EnableIoTLoggingParams**: [EnableIoTLoggingParams](#enableiotloggingparams) +* **PublishFindingToSnsParams**: [PublishFindingToSnsParams](#publishfindingtosnsparams) +* **ReplaceDefaultPolicyVersionParams**: [ReplaceDefaultPolicyVersionParams](#replacedefaultpolicyversionparams) +* **UpdateCACertificateParams**: [UpdateCACertificateParams](#updatecacertificateparams) +* **UpdateDeviceCertificateParams**: [UpdateDeviceCertificateParams](#updatedevicecertificateparams) + +## AddThingsToThingGroupParams +### Properties +* **OverrideDynamicGroups**: bool: Specifies if this mitigation action can move the things that triggered the mitigation action out of one or more dynamic thing groups. +* **ThingGroupNames**: string[] (Required): The list of groups to which you want to add the things that triggered the mitigation action. + +## AggregationType +### Properties +* **Name**: string (Required): Fleet Indexing aggregation type names such as Statistics, Percentiles and Cardinality +* **Values**: string[] (Required): Fleet Indexing aggregation type values + +## AssetPropertyTimestamp +### Properties +* **OffsetInNanos**: string +* **TimeInSeconds**: string (Required) + +## AssetPropertyValue +### Properties +* **Quality**: string +* **Timestamp**: [AssetPropertyTimestamp](#assetpropertytimestamp) (Required) +* **Value**: [AssetPropertyVariant](#assetpropertyvariant) (Required) + +## AssetPropertyVariant +### Properties +* **BooleanValue**: string +* **DoubleValue**: string +* **IntegerValue**: string +* **StringValue**: string + +## AttributePayload +### Properties +* **Attributes**: [Thing_Attributes](#thingattributes) + +## AttributePayload +### Properties +* **Attributes**: [ThingGroup_Attributes](#thinggroupattributes) + +## AuditCheckConfiguration +### Properties +* **Enabled**: bool: True if the check is enabled. ## AuditCheckConfigurations ### Properties @@ -201,19 +268,30 @@ * **RevokedDeviceCertificateStillActiveCheck**: [AuditCheckConfiguration](#auditcheckconfiguration) * **UnauthenticatedCognitoRoleOverlyPermissiveCheck**: [AuditCheckConfiguration](#auditcheckconfiguration) -## AuditCheckConfiguration +## AuditNotificationTarget ### Properties -* **Enabled**: bool: True if the check is enabled. +* **Enabled**: bool: True if notifications to the target are enabled. +* **RoleArn**: string: The ARN of the role that grants permission to send notifications to the target. +* **TargetArn**: string: The ARN of the target (SNS topic) to which audit notifications are sent. ## AuditNotificationTargetConfigurations ### Properties * **Sns**: [AuditNotificationTarget](#auditnotificationtarget) -## AuditNotificationTarget +## Authorizer_TokenSigningPublicKeys ### Properties -* **Enabled**: bool: True if notifications to the target are enabled. -* **RoleArn**: string: The ARN of the role that grants permission to send notifications to the target. -* **TargetArn**: string: The ARN of the target (SNS topic) to which audit notifications are sent. + +## AuthorizerConfig +### Properties +* **AllowAuthorizerOverride**: bool +* **DefaultAuthorizerName**: string + +## AWS.IoT/AccountAuditConfigurationProperties +### Properties +* **AccountId**: string (Required, Identifier): Your 12-digit account ID (used as the primary identifier for the CloudFormation resource). +* **AuditCheckConfigurations**: [AuditCheckConfigurations](#auditcheckconfigurations) (Required) +* **AuditNotificationTargetConfigurations**: [AuditNotificationTargetConfigurations](#auditnotificationtargetconfigurations) +* **RoleArn**: string (Required): The ARN of the role that grants permission to AWS IoT to access information about your devices, policies, certificates and other items as required when performing an audit. ## AWS.IoT/AuthorizerProperties ### Properties @@ -227,14 +305,6 @@ * **TokenKeyName**: string * **TokenSigningPublicKeys**: [Authorizer_TokenSigningPublicKeys](#authorizertokensigningpublickeys) -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - -## Authorizer_TokenSigningPublicKeys -### Properties - ## AWS.IoT/BillingGroupProperties ### Properties * **Arn**: string (ReadOnly) @@ -243,15 +313,6 @@ * **Id**: string (ReadOnly) * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. -## BillingGroup_BillingGroupProperties -### Properties -* **BillingGroupDescription**: string - -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## AWS.IoT/CACertificateProperties ### Properties * **Arn**: string (ReadOnly) @@ -265,17 +326,6 @@ * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. * **VerificationCertificatePem**: string (WriteOnly): The private key verification certificate. -## RegistrationConfig -### Properties -* **RoleArn**: string -* **TemplateBody**: string -* **TemplateName**: string - -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## AWS.IoT/CertificateProperties ### Properties * **Arn**: string (ReadOnly) @@ -294,11 +344,6 @@ * **LambdaFunctionArn**: string (Required) * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## AWS.IoT/CustomMetricProperties ### Properties * **DisplayName**: string: Field represents a friendly name in the console for the custom metric; it doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated once defined. @@ -307,11 +352,6 @@ * **MetricType**: string (Required): The type of the custom metric. Types include string-list, ip-address-list, number-list, and number. * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. -## Tag -### Properties -* **Key**: string (Required): The tag's key. -* **Value**: string (Required): The tag's value. - ## AWS.IoT/DimensionProperties ### Properties * **Arn**: string (ReadOnly): The ARN (Amazon resource name) of the created dimension. @@ -320,11 +360,6 @@ * **Tags**: [Tag](#tag)[]: Metadata that can be used to manage the dimension. * **Type**: string (Required): Specifies the type of the dimension. -## Tag -### Properties -* **Key**: string (Required): The tag's key. -* **Value**: string (Required): The tag's value. - ## AWS.IoT/DomainConfigurationProperties ### Properties * **Arn**: string (ReadOnly) @@ -341,38 +376,14 @@ * **TlsConfig**: [TlsConfig](#tlsconfig) * **ValidationCertificateArn**: string (WriteOnly) -## AuthorizerConfig -### Properties -* **AllowAuthorizerOverride**: bool -* **DefaultAuthorizerName**: string - -## ServerCertificateConfig -### Properties -* **EnableOCSPCheck**: bool - -## ServerCertificateSummary -### Properties -* **ServerCertificateArn**: string -* **ServerCertificateStatus**: string -* **ServerCertificateStatusDetail**: string - -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - -## TlsConfig -### Properties -* **SecurityPolicy**: string - ## AWS.IoT/FleetMetricProperties ### Properties * **AggregationField**: string: The aggregation field to perform aggregation and metric emission * **AggregationType**: [AggregationType](#aggregationtype) -* **CreationDate**: int (ReadOnly): The creation date of a fleet metric +* **CreationDate**: string (ReadOnly): The creation date of a fleet metric * **Description**: string: The description of a fleet metric * **IndexName**: string: The index name of a fleet metric -* **LastModifiedDate**: int (ReadOnly): The last modified date of a fleet metric +* **LastModifiedDate**: string (ReadOnly): The last modified date of a fleet metric * **MetricArn**: string (ReadOnly): The Amazon Resource Number (ARN) of a fleet metric metric * **MetricName**: string (Required, Identifier): The name of the fleet metric * **Period**: int: The period of metric emission in seconds @@ -382,16 +393,6 @@ * **Unit**: string: The unit of data points emitted by a fleet metric * **Version**: int (ReadOnly): The version of a fleet metric -## AggregationType -### Properties -* **Name**: string (Required): Fleet Indexing aggregation type names such as Statistics, Percentiles and Cardinality -* **Values**: string[] (Required): Fleet Indexing aggregation type values - -## Tag -### Properties -* **Key**: string (Required): The tag's key -* **Value**: string (Required): The tag's value - ## AWS.IoT/LoggingProperties ### Properties * **AccountId**: string (Required, Identifier): Your 12-digit account ID (used as the primary identifier for the CloudFormation resource). @@ -407,46 +408,6 @@ * **RoleArn**: string (Required) * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. -## ActionParams -### Properties -* **AddThingsToThingGroupParams**: [AddThingsToThingGroupParams](#addthingstothinggroupparams) -* **EnableIoTLoggingParams**: [EnableIoTLoggingParams](#enableiotloggingparams) -* **PublishFindingToSnsParams**: [PublishFindingToSnsParams](#publishfindingtosnsparams) -* **ReplaceDefaultPolicyVersionParams**: [ReplaceDefaultPolicyVersionParams](#replacedefaultpolicyversionparams) -* **UpdateCACertificateParams**: [UpdateCACertificateParams](#updatecacertificateparams) -* **UpdateDeviceCertificateParams**: [UpdateDeviceCertificateParams](#updatedevicecertificateparams) - -## AddThingsToThingGroupParams -### Properties -* **OverrideDynamicGroups**: bool: Specifies if this mitigation action can move the things that triggered the mitigation action out of one or more dynamic thing groups. -* **ThingGroupNames**: string[] (Required): The list of groups to which you want to add the things that triggered the mitigation action. - -## EnableIoTLoggingParams -### Properties -* **LogLevel**: string (Required): Specifies which types of information are logged. -* **RoleArnForLogging**: string (Required): The ARN of the IAM role used for logging. - -## PublishFindingToSnsParams -### Properties -* **TopicArn**: string (Required): The ARN of the topic to which you want to publish the findings. - -## ReplaceDefaultPolicyVersionParams -### Properties -* **TemplateName**: string (Required) - -## UpdateCACertificateParams -### Properties -* **Action**: string (Required) - -## UpdateDeviceCertificateParams -### Properties -* **Action**: string (Required) - -## Tag -### Properties -* **Key**: string (Required): The tag's key. -* **Value**: string (Required): The tag's value. - ## AWS.IoT/PolicyProperties ### Properties * **Arn**: string (ReadOnly) @@ -455,11 +416,6 @@ * **PolicyName**: string * **Tags**: [Tag](#tag)[] -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - ## AWS.IoT/ProvisioningTemplateProperties ### Properties * **Description**: string @@ -472,16 +428,6 @@ * **TemplateName**: string (Identifier) * **TemplateType**: string -## ProvisioningHook -### Properties -* **PayloadVersion**: string -* **TargetArn**: string - -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - ## AWS.IoT/ResourceSpecificLoggingProperties ### Properties * **LogLevel**: string (Required): The log level for a specific target. Valid values are: ERROR, WARN, INFO, DEBUG, or DISABLED. @@ -497,11 +443,6 @@ * **RoleArn**: string (Required) * **Tags**: [Tag](#tag)[] -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## AWS.IoT/ScheduledAuditProperties ### Properties * **DayOfMonth**: string: The day of the month on which the scheduled audit takes place. Can be 1 through 31 or LAST. This field is required if the frequency parameter is set to MONTHLY. @@ -512,11 +453,6 @@ * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. * **TargetCheckNames**: string[] (Required): Which checks are performed during the scheduled audit. Checks must be enabled for your account. -## Tag -### Properties -* **Key**: string (Required): The tag's key. -* **Value**: string (Required): The tag's value. - ## AWS.IoT/SecurityProfileProperties ### Properties * **AdditionalMetricsToRetainV2**: [MetricToRetain](#metrictoretain)[]: A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here. @@ -529,79 +465,14 @@ * **Tags**: [Tag](#tag)[]: Metadata that can be used to manage the security profile. * **TargetArns**: string[]: A set of target ARNs that the security profile is attached to. -## MetricToRetain +## AWS.IoT/SoftwarePackageProperties ### Properties -* **ExportMetric**: bool -* **Metric**: string (Required): What is measured by the behavior. -* **MetricDimension**: [MetricDimension](#metricdimension) +* **Description**: string +* **PackageArn**: string (ReadOnly) +* **PackageName**: string (Identifier) +* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. -## MetricDimension -### Properties -* **DimensionName**: string (Required): A unique identifier for the dimension. -* **Operator**: string: Defines how the dimensionValues of a dimension are interpreted. - -## SecurityProfile_AlertTargets -### Properties - -## Behavior -### Properties -* **Criteria**: [BehaviorCriteria](#behaviorcriteria) -* **ExportMetric**: bool -* **Metric**: string: What is measured by the behavior. -* **MetricDimension**: [MetricDimension](#metricdimension) -* **Name**: string (Required): The name for the behavior. -* **SuppressAlerts**: bool: Manage Detect alarm SNS notifications by setting behavior notification to on or suppressed. Detect will continue to performing device behavior evaluations. However, suppressed alarms wouldn't be forwarded for SNS notification. - -## BehaviorCriteria -### Properties -* **ComparisonOperator**: string: The operator that relates the thing measured (metric) to the criteria (containing a value or statisticalThreshold). -* **ConsecutiveDatapointsToAlarm**: int: If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs. If not specified, the default is 1. -* **ConsecutiveDatapointsToClear**: int: If an alarm has occurred and the offending device is no longer in violation of the behavior for the specified number of consecutive datapoints, the alarm is cleared. If not specified, the default is 1. -* **DurationSeconds**: int: Use this to specify the time duration over which the behavior is evaluated. -* **MlDetectionConfig**: [MachineLearningDetectionConfig](#machinelearningdetectionconfig) -* **StatisticalThreshold**: [StatisticalThreshold](#statisticalthreshold) -* **Value**: [MetricValue](#metricvalue) - -## MachineLearningDetectionConfig -### Properties -* **ConfidenceLevel**: string: The sensitivity of anomalous behavior evaluation. Can be Low, Medium, or High. - -## StatisticalThreshold -### Properties -* **Statistic**: string: The percentile which resolves to a threshold value by which compliance with a behavior is determined - -## MetricValue -### Properties -* **Cidrs**: string[]: If the ComparisonOperator calls for a set of CIDRs, use this to specify that set to be compared with the metric. -* **Count**: string: If the ComparisonOperator calls for a numeric value, use this to specify that (integer) numeric value to be compared with the metric. -* **Number**: int: The numeral value of a metric. -* **Numbers**: int[]: The numeral values of a metric. -* **Ports**: int[]: If the ComparisonOperator calls for a set of ports, use this to specify that set to be compared with the metric. -* **Strings**: string[]: The string values of a metric. - -## SecurityProfile_MetricsExportConfig -### Properties -* **MqttTopic**: string (Required): The topic for metrics export. -* **RoleArn**: string (Required): The ARN of the role that grants permission to publish to mqtt topic. - -## Tag -### Properties -* **Key**: string (Required): The tag's key. -* **Value**: string (Required): The tag's value. - -## AWS.IoT/SoftwarePackageProperties -### Properties -* **Description**: string -* **PackageArn**: string (ReadOnly) -* **PackageName**: string (Identifier) -* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. - -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - -## AWS.IoT/SoftwarePackageVersionProperties +## AWS.IoT/SoftwarePackageVersionProperties ### Properties * **Attributes**: [ResourceAttributes](#resourceattributes) * **Description**: string @@ -612,28 +483,6 @@ * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. * **VersionName**: string (Identifier) -## ResourceAttributes -### Properties - -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - -## AWS.IoT/ThingProperties -### Properties -* **Arn**: string (ReadOnly) -* **AttributePayload**: [AttributePayload](#attributepayload) -* **Id**: string (ReadOnly) -* **ThingName**: string (Identifier) - -## AttributePayload -### Properties -* **Attributes**: [Thing_Attributes](#thingattributes) - -## Thing_Attributes -### Properties - ## AWS.IoT/ThingGroupProperties ### Properties * **Arn**: string (ReadOnly) @@ -644,22 +493,12 @@ * **ThingGroupName**: string (Identifier) * **ThingGroupProperties**: [ThingGroup_ThingGroupProperties](#thinggroupthinggroupproperties) -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - -## ThingGroup_ThingGroupProperties +## AWS.IoT/ThingProperties ### Properties +* **Arn**: string (ReadOnly) * **AttributePayload**: [AttributePayload](#attributepayload) -* **ThingGroupDescription**: string - -## AttributePayload -### Properties -* **Attributes**: [ThingGroup_Attributes](#thinggroupattributes) - -## ThingGroup_Attributes -### Properties +* **Id**: string (ReadOnly) +* **ThingName**: string (Identifier) ## AWS.IoT/ThingTypeProperties ### Properties @@ -670,15 +509,13 @@ * **ThingTypeName**: string (Identifier) * **ThingTypeProperties**: [ThingType_ThingTypeProperties](#thingtypethingtypeproperties) -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - -## ThingType_ThingTypeProperties +## AWS.IoT/TopicRuleDestinationProperties ### Properties -* **SearchableAttributes**: string[] -* **ThingTypeDescription**: string +* **Arn**: string (ReadOnly, Identifier): Amazon Resource Name (ARN). +* **HttpUrlProperties**: [HttpUrlDestinationSummary](#httpurldestinationsummary): HTTP URL destination properties. +* **Status**: string: The status of the TopicRuleDestination. +* **StatusReason**: string (ReadOnly): The reasoning for the current status of the TopicRuleDestination. +* **VpcProperties**: [VpcDestinationProperties](#vpcdestinationproperties): VPC destination properties. ## AWS.IoT/TopicRuleProperties ### Properties @@ -687,44 +524,28 @@ * **Tags**: [Tag](#tag)[] * **TopicRulePayload**: [TopicRulePayload](#topicrulepayload) (Required) -## Tag +## Behavior ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **Criteria**: [BehaviorCriteria](#behaviorcriteria) +* **ExportMetric**: bool +* **Metric**: string: What is measured by the behavior. +* **MetricDimension**: [MetricDimension](#metricdimension) +* **Name**: string (Required): The name for the behavior. +* **SuppressAlerts**: bool: Manage Detect alarm SNS notifications by setting behavior notification to on or suppressed. Detect will continue to performing device behavior evaluations. However, suppressed alarms wouldn't be forwarded for SNS notification. -## TopicRulePayload +## BehaviorCriteria ### Properties -* **Actions**: [Action](#action)[] (Required) -* **AwsIotSqlVersion**: string -* **Description**: string -* **ErrorAction**: [Action](#action) -* **RuleDisabled**: bool -* **Sql**: string (Required) +* **ComparisonOperator**: string: The operator that relates the thing measured (metric) to the criteria (containing a value or statisticalThreshold). +* **ConsecutiveDatapointsToAlarm**: int: If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs. If not specified, the default is 1. +* **ConsecutiveDatapointsToClear**: int: If an alarm has occurred and the offending device is no longer in violation of the behavior for the specified number of consecutive datapoints, the alarm is cleared. If not specified, the default is 1. +* **DurationSeconds**: int: Use this to specify the time duration over which the behavior is evaluated. +* **MlDetectionConfig**: [MachineLearningDetectionConfig](#machinelearningdetectionconfig) +* **StatisticalThreshold**: [StatisticalThreshold](#statisticalthreshold) +* **Value**: [MetricValue](#metricvalue) -## Action +## BillingGroup_BillingGroupProperties ### Properties -* **CloudwatchAlarm**: [CloudwatchAlarmAction](#cloudwatchalarmaction) -* **CloudwatchLogs**: [CloudwatchLogsAction](#cloudwatchlogsaction) -* **CloudwatchMetric**: [CloudwatchMetricAction](#cloudwatchmetricaction) -* **DynamoDB**: [DynamoDBAction](#dynamodbaction) -* **DynamoDBv2**: [DynamoDBv2Action](#dynamodbv2action) -* **Elasticsearch**: [ElasticsearchAction](#elasticsearchaction) -* **Firehose**: [FirehoseAction](#firehoseaction) -* **Http**: [HttpAction](#httpaction) -* **IotAnalytics**: [IotAnalyticsAction](#iotanalyticsaction) -* **IotEvents**: [IotEventsAction](#ioteventsaction) -* **IotSiteWise**: [IotSiteWiseAction](#iotsitewiseaction) -* **Kafka**: [KafkaAction](#kafkaaction) -* **Kinesis**: [KinesisAction](#kinesisaction) -* **Lambda**: [LambdaAction](#lambdaaction) -* **Location**: [LocationAction](#locationaction) -* **OpenSearch**: [OpenSearchAction](#opensearchaction) -* **Republish**: [RepublishAction](#republishaction) -* **S3**: [S3Action](#s3action) -* **Sns**: [SnsAction](#snsaction) -* **Sqs**: [SqsAction](#sqsaction) -* **StepFunctions**: [StepFunctionsAction](#stepfunctionsaction) -* **Timestream**: [TimestreamAction](#timestreamaction) +* **BillingGroupDescription**: string ## CloudwatchAlarmAction ### Properties @@ -765,10 +586,6 @@ * **PutItem**: [PutItemInput](#putiteminput) * **RoleArn**: string -## PutItemInput -### Properties -* **TableName**: string (Required) - ## ElasticsearchAction ### Properties * **Endpoint**: string (Required) @@ -777,6 +594,11 @@ * **RoleArn**: string (Required) * **Type**: string (Required) +## EnableIoTLoggingParams +### Properties +* **LogLevel**: string (Required): Specifies which types of information are logged. +* **RoleArnForLogging**: string (Required): The ARN of the IAM role used for logging. + ## FirehoseAction ### Properties * **BatchMode**: bool @@ -791,20 +613,18 @@ * **Headers**: [HttpActionHeader](#httpactionheader)[] * **Url**: string (Required) -## HttpAuthorization +## HttpActionHeader ### Properties -* **Sigv4**: [SigV4Authorization](#sigv4authorization) +* **Key**: string (Required) +* **Value**: string (Required) -## SigV4Authorization +## HttpAuthorization ### Properties -* **RoleArn**: string (Required) -* **ServiceName**: string (Required) -* **SigningRegion**: string (Required) +* **Sigv4**: [SigV4Authorization](#sigv4authorization) -## HttpActionHeader +## HttpUrlDestinationSummary ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **ConfirmationUrl**: string ## IotAnalyticsAction ### Properties @@ -824,32 +644,6 @@ * **PutAssetPropertyValueEntries**: [PutAssetPropertyValueEntry](#putassetpropertyvalueentry)[] (Required) * **RoleArn**: string (Required) -## PutAssetPropertyValueEntry -### Properties -* **AssetId**: string -* **EntryId**: string -* **PropertyAlias**: string -* **PropertyId**: string -* **PropertyValues**: [AssetPropertyValue](#assetpropertyvalue)[] (Required) - -## AssetPropertyValue -### Properties -* **Quality**: string -* **Timestamp**: [AssetPropertyTimestamp](#assetpropertytimestamp) (Required) -* **Value**: [AssetPropertyVariant](#assetpropertyvariant) (Required) - -## AssetPropertyTimestamp -### Properties -* **OffsetInNanos**: string -* **TimeInSeconds**: string (Required) - -## AssetPropertyVariant -### Properties -* **BooleanValue**: string -* **DoubleValue**: string -* **IntegerValue**: string -* **StringValue**: string - ## KafkaAction ### Properties * **ClientProperties**: [TopicRule_ClientProperties](#topicruleclientproperties) (Required) @@ -859,9 +653,6 @@ * **Partition**: string * **Topic**: string (Required) -## TopicRule_ClientProperties -### Properties - ## KafkaActionHeader ### Properties * **Key**: string (Required) @@ -886,10 +677,29 @@ * **Timestamp**: [Timestamp](#timestamp) * **TrackerName**: string (Required) -## Timestamp +## MachineLearningDetectionConfig ### Properties -* **Unit**: string -* **Value**: string (Required) +* **ConfidenceLevel**: string: The sensitivity of anomalous behavior evaluation. Can be Low, Medium, or High. + +## MetricDimension +### Properties +* **DimensionName**: string (Required): A unique identifier for the dimension. +* **Operator**: string: Defines how the dimensionValues of a dimension are interpreted. + +## MetricToRetain +### Properties +* **ExportMetric**: bool +* **Metric**: string (Required): What is measured by the behavior. +* **MetricDimension**: [MetricDimension](#metricdimension) + +## MetricValue +### Properties +* **Cidrs**: string[]: If the ComparisonOperator calls for a set of CIDRs, use this to specify that set to be compared with the metric. +* **Count**: string: If the ComparisonOperator calls for a numeric value, use this to specify that (integer) numeric value to be compared with the metric. +* **Number**: int: The numeral value of a metric. +* **Numbers**: int[]: The numeral values of a metric. +* **Ports**: int[]: If the ComparisonOperator calls for a set of ports, use this to specify that set to be compared with the metric. +* **Strings**: string[]: The string values of a metric. ## OpenSearchAction ### Properties @@ -899,6 +709,37 @@ * **RoleArn**: string (Required) * **Type**: string (Required) +## ProvisioningHook +### Properties +* **PayloadVersion**: string +* **TargetArn**: string + +## PublishFindingToSnsParams +### Properties +* **TopicArn**: string (Required): The ARN of the topic to which you want to publish the findings. + +## PutAssetPropertyValueEntry +### Properties +* **AssetId**: string +* **EntryId**: string +* **PropertyAlias**: string +* **PropertyId**: string +* **PropertyValues**: [AssetPropertyValue](#assetpropertyvalue)[] (Required) + +## PutItemInput +### Properties +* **TableName**: string (Required) + +## RegistrationConfig +### Properties +* **RoleArn**: string +* **TemplateBody**: string +* **TemplateName**: string + +## ReplaceDefaultPolicyVersionParams +### Properties +* **TemplateName**: string (Required) + ## RepublishAction ### Properties * **Headers**: [RepublishActionHeaders](#republishactionheaders) @@ -915,10 +756,8 @@ * **ResponseTopic**: string * **UserProperties**: [UserProperty](#userproperty)[] -## UserProperty +## ResourceAttributes ### Properties -* **Key**: string (Required) -* **Value**: string (Required) ## S3Action ### Properties @@ -927,6 +766,30 @@ * **Key**: string (Required) * **RoleArn**: string (Required) +## SecurityProfile_AlertTargets +### Properties + +## SecurityProfile_MetricsExportConfig +### Properties +* **MqttTopic**: string (Required): The topic for metrics export. +* **RoleArn**: string (Required): The ARN of the role that grants permission to publish to mqtt topic. + +## ServerCertificateConfig +### Properties +* **EnableOCSPCheck**: bool + +## ServerCertificateSummary +### Properties +* **ServerCertificateArn**: string +* **ServerCertificateStatus**: string +* **ServerCertificateStatusDetail**: string + +## SigV4Authorization +### Properties +* **RoleArn**: string (Required) +* **ServiceName**: string (Required) +* **SigningRegion**: string (Required) + ## SnsAction ### Properties * **MessageFormat**: string @@ -939,12 +802,132 @@ * **RoleArn**: string (Required) * **UseBase64**: bool +## StatisticalThreshold +### Properties +* **Statistic**: string: The percentile which resolves to a threshold value by which compliance with a behavior is determined + ## StepFunctionsAction ### Properties * **ExecutionNamePrefix**: string * **RoleArn**: string (Required) * **StateMachineName**: string (Required) +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## Tag +### Properties +* **Key**: string (Required): The tag's key. +* **Value**: string (Required): The tag's value. + +## Tag +### Properties +* **Key**: string (Required): The tag's key. +* **Value**: string (Required): The tag's value. + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + +## Tag +### Properties +* **Key**: string (Required): The tag's key +* **Value**: string (Required): The tag's value + +## Tag +### Properties +* **Key**: string (Required): The tag's key. +* **Value**: string (Required): The tag's value. + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## Tag +### Properties +* **Key**: string (Required): The tag's key. +* **Value**: string (Required): The tag's value. + +## Tag +### Properties +* **Key**: string (Required): The tag's key. +* **Value**: string (Required): The tag's value. + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + +## Thing_Attributes +### Properties + +## ThingGroup_Attributes +### Properties + +## ThingGroup_ThingGroupProperties +### Properties +* **AttributePayload**: [AttributePayload](#attributepayload) +* **ThingGroupDescription**: string + +## ThingType_ThingTypeProperties +### Properties +* **SearchableAttributes**: string[] +* **ThingTypeDescription**: string + +## Timestamp +### Properties +* **Unit**: string +* **Value**: string (Required) + ## TimestreamAction ### Properties * **DatabaseName**: string (Required) @@ -963,17 +946,34 @@ * **Unit**: string (Required) * **Value**: string (Required) -## AWS.IoT/TopicRuleDestinationProperties +## TlsConfig ### Properties -* **Arn**: string (ReadOnly, Identifier): Amazon Resource Name (ARN). -* **HttpUrlProperties**: [HttpUrlDestinationSummary](#httpurldestinationsummary): HTTP URL destination properties. -* **Status**: string: The status of the TopicRuleDestination. -* **StatusReason**: string (ReadOnly): The reasoning for the current status of the TopicRuleDestination. -* **VpcProperties**: [VpcDestinationProperties](#vpcdestinationproperties): VPC destination properties. +* **SecurityPolicy**: string -## HttpUrlDestinationSummary +## TopicRule_ClientProperties ### Properties -* **ConfirmationUrl**: string + +## TopicRulePayload +### Properties +* **Actions**: [Action](#action)[] (Required) +* **AwsIotSqlVersion**: string +* **Description**: string +* **ErrorAction**: [Action](#action) +* **RuleDisabled**: bool +* **Sql**: string (Required) + +## UpdateCACertificateParams +### Properties +* **Action**: string (Required) + +## UpdateDeviceCertificateParams +### Properties +* **Action**: string (Required) + +## UserProperty +### Properties +* **Key**: string (Required) +* **Value**: string (Required) ## VpcDestinationProperties ### Properties diff --git a/artifacts/bicep/aws/aws.iotanalytics/default/types.json b/artifacts/bicep/aws/aws.iotanalytics/default/types.json index c87e042c..fbcdeb33 100644 --- a/artifacts/bicep/aws/aws.iotanalytics/default/types.json +++ b/artifacts/bicep/aws/aws.iotanalytics/default/types.json @@ -1 +1,1541 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"ChannelStorage","Properties":{"CustomerManagedS3":{"Type":9,"Flags":0},"ServiceManagedS3":{"Type":11,"Flags":0}}}},{"2":{"Name":"CustomerManagedS3","Properties":{"Bucket":{"Type":4,"Flags":1},"KeyPrefix":{"Type":4,"Flags":0},"RoleArn":{"Type":4,"Flags":1}}}},{"2":{"Name":"RetentionPeriod","Properties":{"NumberOfDays":{"Type":3,"Flags":0},"Unlimited":{"Type":2,"Flags":0}}}},{"2":{"Name":"ServiceManagedS3","Properties":{}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.IoTAnalytics/ChannelProperties","Properties":{"ChannelName":{"Type":4,"Flags":16},"ChannelStorage":{"Type":8,"Flags":0},"Id":{"Type":4,"Flags":2},"RetentionPeriod":{"Type":10,"Flags":0},"Tags":{"Type":14,"Flags":0}}}},{"3":{"ItemType":12}},{"2":{"Name":"AWS.IoTAnalytics/Channel","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":13,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IoTAnalytics/Channel@default","ScopeType":0,"Body":15}},{"2":{"Name":"Action","Properties":{"ActionName":{"Type":4,"Flags":1},"ContainerAction":{"Type":18,"Flags":0},"QueryAction":{"Type":30,"Flags":0}}}},{"2":{"Name":"ContainerAction","Properties":{"ExecutionRoleArn":{"Type":4,"Flags":1},"Image":{"Type":4,"Flags":1},"ResourceConfiguration":{"Type":31,"Flags":1},"Variables":{"Type":40,"Flags":0}}}},{"2":{"Name":"DatasetContentDeliveryRule","Properties":{"Destination":{"Type":20,"Flags":1},"EntryName":{"Type":4,"Flags":0}}}},{"2":{"Name":"DatasetContentDeliveryRuleDestination","Properties":{"IotEventsDestinationConfiguration":{"Type":26,"Flags":0},"S3DestinationConfiguration":{"Type":33,"Flags":0}}}},{"2":{"Name":"DatasetContentVersionValue","Properties":{"DatasetName":{"Type":4,"Flags":17}}}},{"2":{"Name":"DeltaTime","Properties":{"OffsetSeconds":{"Type":3,"Flags":1},"TimeExpression":{"Type":4,"Flags":1}}}},{"2":{"Name":"DeltaTimeSessionWindowConfiguration","Properties":{"TimeoutInMinutes":{"Type":3,"Flags":1}}}},{"2":{"Name":"Filter","Properties":{"DeltaTime":{"Type":22,"Flags":0}}}},{"2":{"Name":"GlueConfiguration","Properties":{"DatabaseName":{"Type":4,"Flags":1},"TableName":{"Type":4,"Flags":1}}}},{"2":{"Name":"IotEventsDestinationConfiguration","Properties":{"InputName":{"Type":4,"Flags":1},"RoleArn":{"Type":4,"Flags":1}}}},{"2":{"Name":"LateDataRule","Properties":{"RuleConfiguration":{"Type":28,"Flags":1},"RuleName":{"Type":4,"Flags":0}}}},{"2":{"Name":"LateDataRuleConfiguration","Properties":{"DeltaTimeSessionWindowConfiguration":{"Type":23,"Flags":0}}}},{"2":{"Name":"OutputFileUriValue","Properties":{"FileName":{"Type":4,"Flags":1}}}},{"2":{"Name":"QueryAction","Properties":{"Filters":{"Type":41,"Flags":0},"SqlQuery":{"Type":4,"Flags":1}}}},{"2":{"Name":"ResourceConfiguration","Properties":{"ComputeType":{"Type":4,"Flags":1},"VolumeSizeInGB":{"Type":3,"Flags":1}}}},{"2":{"Name":"RetentionPeriod","Properties":{"NumberOfDays":{"Type":3,"Flags":0},"Unlimited":{"Type":2,"Flags":0}}}},{"2":{"Name":"S3DestinationConfiguration","Properties":{"Bucket":{"Type":4,"Flags":1},"GlueConfiguration":{"Type":25,"Flags":0},"Key":{"Type":4,"Flags":1},"RoleArn":{"Type":4,"Flags":1}}}},{"2":{"Name":"Schedule","Properties":{"ScheduleExpression":{"Type":4,"Flags":1}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"Trigger","Properties":{"Schedule":{"Type":34,"Flags":0},"TriggeringDataset":{"Type":37,"Flags":0}}}},{"2":{"Name":"TriggeringDataset","Properties":{"DatasetName":{"Type":4,"Flags":17}}}},{"2":{"Name":"Variable","Properties":{"DatasetContentVersionValue":{"Type":21,"Flags":0},"DoubleValue":{"Type":3,"Flags":0},"OutputFileUriValue":{"Type":29,"Flags":0},"StringValue":{"Type":4,"Flags":0},"VariableName":{"Type":4,"Flags":1}}}},{"2":{"Name":"VersioningConfiguration","Properties":{"MaxVersions":{"Type":3,"Flags":0},"Unlimited":{"Type":2,"Flags":0}}}},{"3":{"ItemType":38}},{"3":{"ItemType":24}},{"2":{"Name":"AWS.IoTAnalytics/DatasetProperties","Properties":{"Actions":{"Type":43,"Flags":1},"ContentDeliveryRules":{"Type":44,"Flags":0},"DatasetName":{"Type":4,"Flags":16},"Id":{"Type":4,"Flags":2},"LateDataRules":{"Type":45,"Flags":0},"RetentionPeriod":{"Type":32,"Flags":0},"Tags":{"Type":46,"Flags":0},"Triggers":{"Type":47,"Flags":0},"VersioningConfiguration":{"Type":39,"Flags":0}}}},{"3":{"ItemType":17}},{"3":{"ItemType":19}},{"3":{"ItemType":27}},{"3":{"ItemType":35}},{"3":{"ItemType":36}},{"2":{"Name":"AWS.IoTAnalytics/Dataset","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":42,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IoTAnalytics/Dataset@default","ScopeType":0,"Body":48}},{"2":{"Name":"Column","Properties":{"Name":{"Type":4,"Flags":1},"Type":{"Type":4,"Flags":1}}}},{"2":{"Name":"CustomerManagedS3","Properties":{"Bucket":{"Type":4,"Flags":1},"KeyPrefix":{"Type":4,"Flags":0},"RoleArn":{"Type":4,"Flags":1}}}},{"2":{"Name":"CustomerManagedS3Storage","Properties":{"Bucket":{"Type":4,"Flags":1},"KeyPrefix":{"Type":4,"Flags":0}}}},{"2":{"Name":"DatastorePartition","Properties":{"Partition":{"Type":60,"Flags":0},"TimestampPartition":{"Type":65,"Flags":0}}}},{"2":{"Name":"DatastorePartitions","Properties":{"Partitions":{"Type":66,"Flags":0}}}},{"2":{"Name":"DatastoreStorage","Properties":{"CustomerManagedS3":{"Type":51,"Flags":0},"IotSiteWiseMultiLayerStorage":{"Type":57,"Flags":0},"ServiceManagedS3":{"Type":63,"Flags":0}}}},{"2":{"Name":"FileFormatConfiguration","Properties":{"JsonConfiguration":{"Type":58,"Flags":0},"ParquetConfiguration":{"Type":59,"Flags":0}}}},{"2":{"Name":"IotSiteWiseMultiLayerStorage","Properties":{"CustomerManagedS3Storage":{"Type":52,"Flags":0}}}},{"2":{"Name":"JsonConfiguration","Properties":{}}},{"2":{"Name":"ParquetConfiguration","Properties":{"SchemaDefinition":{"Type":62,"Flags":0}}}},{"2":{"Name":"Partition","Properties":{"AttributeName":{"Type":4,"Flags":1}}}},{"2":{"Name":"RetentionPeriod","Properties":{"NumberOfDays":{"Type":3,"Flags":0},"Unlimited":{"Type":2,"Flags":0}}}},{"2":{"Name":"SchemaDefinition","Properties":{"Columns":{"Type":67,"Flags":0}}}},{"2":{"Name":"ServiceManagedS3","Properties":{}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"TimestampPartition","Properties":{"AttributeName":{"Type":4,"Flags":1},"TimestampFormat":{"Type":4,"Flags":0}}}},{"3":{"ItemType":53}},{"3":{"ItemType":50}},{"2":{"Name":"AWS.IoTAnalytics/DatastoreProperties","Properties":{"DatastoreName":{"Type":4,"Flags":16},"DatastorePartitions":{"Type":54,"Flags":0},"DatastoreStorage":{"Type":55,"Flags":0},"FileFormatConfiguration":{"Type":56,"Flags":0},"Id":{"Type":4,"Flags":2},"RetentionPeriod":{"Type":61,"Flags":0},"Tags":{"Type":69,"Flags":0}}}},{"3":{"ItemType":64}},{"2":{"Name":"AWS.IoTAnalytics/Datastore","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":68,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IoTAnalytics/Datastore@default","ScopeType":0,"Body":70}},{"2":{"Name":"Activity","Properties":{"AddAttributes":{"Type":73,"Flags":0},"Channel":{"Type":74,"Flags":0},"Datastore":{"Type":75,"Flags":0},"DeviceRegistryEnrich":{"Type":76,"Flags":0},"DeviceShadowEnrich":{"Type":77,"Flags":0},"Filter":{"Type":78,"Flags":0},"Lambda":{"Type":79,"Flags":0},"Math":{"Type":80,"Flags":0},"RemoveAttributes":{"Type":81,"Flags":0},"SelectAttributes":{"Type":82,"Flags":0}}}},{"2":{"Name":"AddAttributes","Properties":{"Attributes":{"Type":84,"Flags":1},"Name":{"Type":4,"Flags":1},"Next":{"Type":4,"Flags":0}}}},{"2":{"Name":"Channel","Properties":{"ChannelName":{"Type":4,"Flags":1},"Name":{"Type":4,"Flags":1},"Next":{"Type":4,"Flags":0}}}},{"2":{"Name":"Datastore","Properties":{"DatastoreName":{"Type":4,"Flags":1},"Name":{"Type":4,"Flags":1}}}},{"2":{"Name":"DeviceRegistryEnrich","Properties":{"Attribute":{"Type":4,"Flags":1},"Name":{"Type":4,"Flags":1},"Next":{"Type":4,"Flags":0},"RoleArn":{"Type":4,"Flags":1},"ThingName":{"Type":4,"Flags":1}}}},{"2":{"Name":"DeviceShadowEnrich","Properties":{"Attribute":{"Type":4,"Flags":1},"Name":{"Type":4,"Flags":1},"Next":{"Type":4,"Flags":0},"RoleArn":{"Type":4,"Flags":1},"ThingName":{"Type":4,"Flags":1}}}},{"2":{"Name":"Filter","Properties":{"Filter":{"Type":4,"Flags":1},"Name":{"Type":4,"Flags":1},"Next":{"Type":4,"Flags":0}}}},{"2":{"Name":"Lambda","Properties":{"BatchSize":{"Type":3,"Flags":1},"LambdaName":{"Type":4,"Flags":1},"Name":{"Type":4,"Flags":1},"Next":{"Type":4,"Flags":0}}}},{"2":{"Name":"Math","Properties":{"Attribute":{"Type":4,"Flags":1},"Math":{"Type":4,"Flags":1},"Name":{"Type":4,"Flags":1},"Next":{"Type":4,"Flags":0}}}},{"2":{"Name":"RemoveAttributes","Properties":{"Attributes":{"Type":85,"Flags":1},"Name":{"Type":4,"Flags":1},"Next":{"Type":4,"Flags":0}}}},{"2":{"Name":"SelectAttributes","Properties":{"Attributes":{"Type":86,"Flags":1},"Name":{"Type":4,"Flags":1},"Next":{"Type":4,"Flags":0}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"Pipeline_Attributes","Properties":{}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.IoTAnalytics/PipelineProperties","Properties":{"Id":{"Type":4,"Flags":2},"PipelineActivities":{"Type":88,"Flags":1},"PipelineName":{"Type":4,"Flags":16},"Tags":{"Type":89,"Flags":0}}}},{"3":{"ItemType":72}},{"3":{"ItemType":83}},{"2":{"Name":"AWS.IoTAnalytics/Pipeline","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":87,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IoTAnalytics/Pipeline@default","ScopeType":0,"Body":90}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "ChannelStorage", + "properties": { + "CustomerManagedS3": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "ServiceManagedS3": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomerManagedS3", + "properties": { + "Bucket": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "KeyPrefix": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "RoleArn": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "RetentionPeriod", + "properties": { + "NumberOfDays": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "Unlimited": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ServiceManagedS3", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "IntegerType" + }, + { + "$type": "BooleanType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.IoTAnalytics/ChannelProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoTAnalytics/ChannelProperties", + "properties": { + "ChannelName": { + "type": { + "$ref": "#/5" + }, + "flags": 16 + }, + "ChannelStorage": { + "type": { + "$ref": "#/0" + }, + "flags": 0 + }, + "Id": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "RetentionPeriod": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoTAnalytics/Channel", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/10" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IoTAnalytics/Channel@default", + "scopeType": 0, + "body": { + "$ref": "#/11" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Action", + "properties": { + "ActionName": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "ContainerAction": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + }, + "QueryAction": { + "type": { + "$ref": "#/26" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ContainerAction", + "properties": { + "ExecutionRoleArn": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Image": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "ResourceConfiguration": { + "type": { + "$ref": "#/27" + }, + "flags": 1 + }, + "Variables": { + "type": { + "$ref": "#/36" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DatasetContentDeliveryRule", + "properties": { + "Destination": { + "type": { + "$ref": "#/16" + }, + "flags": 1 + }, + "EntryName": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DatasetContentDeliveryRuleDestination", + "properties": { + "IotEventsDestinationConfiguration": { + "type": { + "$ref": "#/22" + }, + "flags": 0 + }, + "S3DestinationConfiguration": { + "type": { + "$ref": "#/29" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DatasetContentVersionValue", + "properties": { + "DatasetName": { + "type": { + "$ref": "#/5" + }, + "flags": 17 + } + } + }, + { + "$type": "ObjectType", + "name": "DeltaTime", + "properties": { + "OffsetSeconds": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "TimeExpression": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DeltaTimeSessionWindowConfiguration", + "properties": { + "TimeoutInMinutes": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Filter", + "properties": { + "DeltaTime": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GlueConfiguration", + "properties": { + "DatabaseName": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "TableName": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "IotEventsDestinationConfiguration", + "properties": { + "InputName": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "RoleArn": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "LateDataRule", + "properties": { + "RuleConfiguration": { + "type": { + "$ref": "#/24" + }, + "flags": 1 + }, + "RuleName": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "LateDataRuleConfiguration", + "properties": { + "DeltaTimeSessionWindowConfiguration": { + "type": { + "$ref": "#/19" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "OutputFileUriValue", + "properties": { + "FileName": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "QueryAction", + "properties": { + "Filters": { + "type": { + "$ref": "#/37" + }, + "flags": 0 + }, + "SqlQuery": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ResourceConfiguration", + "properties": { + "ComputeType": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "VolumeSizeInGB": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "RetentionPeriod", + "properties": { + "NumberOfDays": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "Unlimited": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "S3DestinationConfiguration", + "properties": { + "Bucket": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "GlueConfiguration": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "Key": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "RoleArn": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Schedule", + "properties": { + "ScheduleExpression": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Trigger", + "properties": { + "Schedule": { + "type": { + "$ref": "#/30" + }, + "flags": 0 + }, + "TriggeringDataset": { + "type": { + "$ref": "#/33" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TriggeringDataset", + "properties": { + "DatasetName": { + "type": { + "$ref": "#/5" + }, + "flags": 17 + } + } + }, + { + "$type": "ObjectType", + "name": "Variable", + "properties": { + "DatasetContentVersionValue": { + "type": { + "$ref": "#/17" + }, + "flags": 0 + }, + "DoubleValue": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "OutputFileUriValue": { + "type": { + "$ref": "#/25" + }, + "flags": 0 + }, + "StringValue": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "VariableName": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "VersioningConfiguration", + "properties": { + "MaxVersions": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "Unlimited": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/34" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/20" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.IoTAnalytics/DatasetProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/15" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/23" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/31" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/32" + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoTAnalytics/DatasetProperties", + "properties": { + "Actions": { + "type": { + "$ref": "#/39" + }, + "flags": 1 + }, + "ContentDeliveryRules": { + "type": { + "$ref": "#/40" + }, + "flags": 0 + }, + "DatasetName": { + "type": { + "$ref": "#/5" + }, + "flags": 16 + }, + "Id": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "LateDataRules": { + "type": { + "$ref": "#/41" + }, + "flags": 0 + }, + "RetentionPeriod": { + "type": { + "$ref": "#/28" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/42" + }, + "flags": 0 + }, + "Triggers": { + "type": { + "$ref": "#/43" + }, + "flags": 0 + }, + "VersioningConfiguration": { + "type": { + "$ref": "#/35" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoTAnalytics/Dataset", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/44" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IoTAnalytics/Dataset@default", + "scopeType": 0, + "body": { + "$ref": "#/45" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Column", + "properties": { + "Name": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Type": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomerManagedS3", + "properties": { + "Bucket": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "KeyPrefix": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "RoleArn": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomerManagedS3Storage", + "properties": { + "Bucket": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "KeyPrefix": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DatastorePartition", + "properties": { + "Partition": { + "type": { + "$ref": "#/57" + }, + "flags": 0 + }, + "TimestampPartition": { + "type": { + "$ref": "#/62" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DatastorePartitions", + "properties": { + "Partitions": { + "type": { + "$ref": "#/63" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DatastoreStorage", + "properties": { + "CustomerManagedS3": { + "type": { + "$ref": "#/48" + }, + "flags": 0 + }, + "IotSiteWiseMultiLayerStorage": { + "type": { + "$ref": "#/54" + }, + "flags": 0 + }, + "ServiceManagedS3": { + "type": { + "$ref": "#/60" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FileFormatConfiguration", + "properties": { + "JsonConfiguration": { + "type": { + "$ref": "#/55" + }, + "flags": 0 + }, + "ParquetConfiguration": { + "type": { + "$ref": "#/56" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "IotSiteWiseMultiLayerStorage", + "properties": { + "CustomerManagedS3Storage": { + "type": { + "$ref": "#/49" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "JsonConfiguration", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ParquetConfiguration", + "properties": { + "SchemaDefinition": { + "type": { + "$ref": "#/59" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Partition", + "properties": { + "AttributeName": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "RetentionPeriod", + "properties": { + "NumberOfDays": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "Unlimited": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SchemaDefinition", + "properties": { + "Columns": { + "type": { + "$ref": "#/64" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ServiceManagedS3", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TimestampPartition", + "properties": { + "AttributeName": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "TimestampFormat": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/50" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/47" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.IoTAnalytics/DatastoreProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/61" + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoTAnalytics/DatastoreProperties", + "properties": { + "DatastoreName": { + "type": { + "$ref": "#/5" + }, + "flags": 16 + }, + "DatastorePartitions": { + "type": { + "$ref": "#/51" + }, + "flags": 0 + }, + "DatastoreStorage": { + "type": { + "$ref": "#/52" + }, + "flags": 0 + }, + "FileFormatConfiguration": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "Id": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "RetentionPeriod": { + "type": { + "$ref": "#/58" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/66" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoTAnalytics/Datastore", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/67" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IoTAnalytics/Datastore@default", + "scopeType": 0, + "body": { + "$ref": "#/68" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Activity", + "properties": { + "AddAttributes": { + "type": { + "$ref": "#/71" + }, + "flags": 0 + }, + "Channel": { + "type": { + "$ref": "#/72" + }, + "flags": 0 + }, + "Datastore": { + "type": { + "$ref": "#/73" + }, + "flags": 0 + }, + "DeviceRegistryEnrich": { + "type": { + "$ref": "#/74" + }, + "flags": 0 + }, + "DeviceShadowEnrich": { + "type": { + "$ref": "#/75" + }, + "flags": 0 + }, + "Filter": { + "type": { + "$ref": "#/76" + }, + "flags": 0 + }, + "Lambda": { + "type": { + "$ref": "#/77" + }, + "flags": 0 + }, + "Math": { + "type": { + "$ref": "#/78" + }, + "flags": 0 + }, + "RemoveAttributes": { + "type": { + "$ref": "#/79" + }, + "flags": 0 + }, + "SelectAttributes": { + "type": { + "$ref": "#/80" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AddAttributes", + "properties": { + "Attributes": { + "type": { + "$ref": "#/82" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Next": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Channel", + "properties": { + "ChannelName": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Next": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Datastore", + "properties": { + "DatastoreName": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DeviceRegistryEnrich", + "properties": { + "Attribute": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Next": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "RoleArn": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "ThingName": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DeviceShadowEnrich", + "properties": { + "Attribute": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Next": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "RoleArn": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "ThingName": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Filter", + "properties": { + "Filter": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Next": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Lambda", + "properties": { + "BatchSize": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "LambdaName": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Next": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Math", + "properties": { + "Attribute": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Math": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Next": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "RemoveAttributes", + "properties": { + "Attributes": { + "type": { + "$ref": "#/83" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Next": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SelectAttributes", + "properties": { + "Attributes": { + "type": { + "$ref": "#/84" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Next": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Pipeline_Attributes", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.IoTAnalytics/PipelineProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/70" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/81" + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoTAnalytics/PipelineProperties", + "properties": { + "Id": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "PipelineActivities": { + "type": { + "$ref": "#/86" + }, + "flags": 1 + }, + "PipelineName": { + "type": { + "$ref": "#/5" + }, + "flags": 16 + }, + "Tags": { + "type": { + "$ref": "#/87" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoTAnalytics/Pipeline", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/88" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IoTAnalytics/Pipeline@default", + "scopeType": 0, + "body": { + "$ref": "#/89" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.iotanalytics/default/types.md b/artifacts/bicep/aws/aws.iotanalytics/default/types.md index c3b18a66..de8523f6 100644 --- a/artifacts/bicep/aws/aws.iotanalytics/default/types.md +++ b/artifacts/bicep/aws/aws.iotanalytics/default/types.md @@ -3,62 +3,63 @@ ## Resource AWS.IoTAnalytics/Channel@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IoTAnalytics/ChannelProperties](#awsiotanalyticschannelproperties): properties of the resource +* **properties**: [AWS.IoTAnalytics/ChannelProperties](#awsiotanalyticschannelproperties) (Identifier): properties of the resource ## Resource AWS.IoTAnalytics/Dataset@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IoTAnalytics/DatasetProperties](#awsiotanalyticsdatasetproperties) (Required): properties of the resource +* **properties**: [AWS.IoTAnalytics/DatasetProperties](#awsiotanalyticsdatasetproperties) (Required, Identifier): properties of the resource ## Resource AWS.IoTAnalytics/Datastore@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IoTAnalytics/DatastoreProperties](#awsiotanalyticsdatastoreproperties): properties of the resource +* **properties**: [AWS.IoTAnalytics/DatastoreProperties](#awsiotanalyticsdatastoreproperties) (Identifier): properties of the resource ## Resource AWS.IoTAnalytics/Pipeline@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IoTAnalytics/PipelineProperties](#awsiotanalyticspipelineproperties) (Required): properties of the resource +* **properties**: [AWS.IoTAnalytics/PipelineProperties](#awsiotanalyticspipelineproperties) (Required, Identifier): properties of the resource -## AWS.IoTAnalytics/ChannelProperties -### Properties -* **ChannelName**: string (Identifier) -* **ChannelStorage**: [ChannelStorage](#channelstorage) -* **Id**: string (ReadOnly) -* **RetentionPeriod**: [RetentionPeriod](#retentionperiod) -* **Tags**: [Tag](#tag)[] - -## ChannelStorage -### Properties -* **CustomerManagedS3**: [CustomerManagedS3](#customermanageds3) -* **ServiceManagedS3**: [ServiceManagedS3](#servicemanageds3) - -## CustomerManagedS3 +## Action ### Properties -* **Bucket**: string (Required) -* **KeyPrefix**: string -* **RoleArn**: string (Required) +* **ActionName**: string (Required) +* **ContainerAction**: [ContainerAction](#containeraction) +* **QueryAction**: [QueryAction](#queryaction) -## ServiceManagedS3 +## Activity ### Properties +* **AddAttributes**: [AddAttributes](#addattributes) +* **Channel**: [Channel](#channel) +* **Datastore**: [Datastore](#datastore) +* **DeviceRegistryEnrich**: [DeviceRegistryEnrich](#deviceregistryenrich) +* **DeviceShadowEnrich**: [DeviceShadowEnrich](#deviceshadowenrich) +* **Filter**: [Filter](#filter) +* **Lambda**: [Lambda](#lambda) +* **Math**: [Math](#math) +* **RemoveAttributes**: [RemoveAttributes](#removeattributes) +* **SelectAttributes**: [SelectAttributes](#selectattributes) -## RetentionPeriod +## AddAttributes ### Properties -* **NumberOfDays**: int -* **Unlimited**: bool +* **Attributes**: [Pipeline_Attributes](#pipelineattributes) (Required) +* **Name**: string (Required) +* **Next**: string -## Tag +## AWS.IoTAnalytics/ChannelProperties ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **ChannelName**: string (Identifier) +* **ChannelStorage**: [ChannelStorage](#channelstorage) +* **Id**: string (ReadOnly) +* **RetentionPeriod**: [RetentionPeriod](#retentionperiod) +* **Tags**: [Tag](#tag)[] ## AWS.IoTAnalytics/DatasetProperties ### Properties @@ -72,53 +73,62 @@ * **Triggers**: [Trigger](#trigger)[] * **VersioningConfiguration**: [VersioningConfiguration](#versioningconfiguration) -## Action +## AWS.IoTAnalytics/DatastoreProperties ### Properties -* **ActionName**: string (Required) -* **ContainerAction**: [ContainerAction](#containeraction) -* **QueryAction**: [QueryAction](#queryaction) +* **DatastoreName**: string (Identifier) +* **DatastorePartitions**: [DatastorePartitions](#datastorepartitions) +* **DatastoreStorage**: [DatastoreStorage](#datastorestorage) +* **FileFormatConfiguration**: [FileFormatConfiguration](#fileformatconfiguration) +* **Id**: string (ReadOnly) +* **RetentionPeriod**: [RetentionPeriod](#retentionperiod) +* **Tags**: [Tag](#tag)[] -## ContainerAction +## AWS.IoTAnalytics/PipelineProperties ### Properties -* **ExecutionRoleArn**: string (Required) -* **Image**: string (Required) -* **ResourceConfiguration**: [ResourceConfiguration](#resourceconfiguration) (Required) -* **Variables**: [Variable](#variable)[] +* **Id**: string (ReadOnly) +* **PipelineActivities**: [Activity](#activity)[] (Required) +* **PipelineName**: string (Identifier) +* **Tags**: [Tag](#tag)[] -## ResourceConfiguration +## Channel ### Properties -* **ComputeType**: string (Required) -* **VolumeSizeInGB**: int (Required) +* **ChannelName**: string (Required) +* **Name**: string (Required) +* **Next**: string -## Variable +## ChannelStorage ### Properties -* **DatasetContentVersionValue**: [DatasetContentVersionValue](#datasetcontentversionvalue) -* **DoubleValue**: int -* **OutputFileUriValue**: [OutputFileUriValue](#outputfileurivalue) -* **StringValue**: string -* **VariableName**: string (Required) +* **CustomerManagedS3**: [CustomerManagedS3](#customermanageds3) +* **ServiceManagedS3**: [ServiceManagedS3](#servicemanageds3) -## DatasetContentVersionValue +## Column ### Properties -* **DatasetName**: string (Required, Identifier) +* **Name**: string (Required) +* **Type**: string (Required) -## OutputFileUriValue +## ContainerAction ### Properties -* **FileName**: string (Required) +* **ExecutionRoleArn**: string (Required) +* **Image**: string (Required) +* **ResourceConfiguration**: [ResourceConfiguration](#resourceconfiguration) (Required) +* **Variables**: [Variable](#variable)[] -## QueryAction +## CustomerManagedS3 ### Properties -* **Filters**: [Filter](#filter)[] -* **SqlQuery**: string (Required) +* **Bucket**: string (Required) +* **KeyPrefix**: string +* **RoleArn**: string (Required) -## Filter +## CustomerManagedS3 ### Properties -* **DeltaTime**: [DeltaTime](#deltatime) +* **Bucket**: string (Required) +* **KeyPrefix**: string +* **RoleArn**: string (Required) -## DeltaTime +## CustomerManagedS3Storage ### Properties -* **OffsetSeconds**: int (Required) -* **TimeExpression**: string (Required) +* **Bucket**: string (Required) +* **KeyPrefix**: string ## DatasetContentDeliveryRule ### Properties @@ -130,237 +140,227 @@ * **IotEventsDestinationConfiguration**: [IotEventsDestinationConfiguration](#ioteventsdestinationconfiguration) * **S3DestinationConfiguration**: [S3DestinationConfiguration](#s3destinationconfiguration) -## IotEventsDestinationConfiguration +## DatasetContentVersionValue ### Properties -* **InputName**: string (Required) -* **RoleArn**: string (Required) +* **DatasetName**: string (Required, Identifier) -## S3DestinationConfiguration +## Datastore ### Properties -* **Bucket**: string (Required) -* **GlueConfiguration**: [GlueConfiguration](#glueconfiguration) -* **Key**: string (Required) -* **RoleArn**: string (Required) +* **DatastoreName**: string (Required) +* **Name**: string (Required) -## GlueConfiguration +## DatastorePartition ### Properties -* **DatabaseName**: string (Required) -* **TableName**: string (Required) +* **Partition**: [Partition](#partition) +* **TimestampPartition**: [TimestampPartition](#timestamppartition) -## LateDataRule +## DatastorePartitions ### Properties -* **RuleConfiguration**: [LateDataRuleConfiguration](#latedataruleconfiguration) (Required) -* **RuleName**: string +* **Partitions**: [DatastorePartition](#datastorepartition)[] -## LateDataRuleConfiguration +## DatastoreStorage ### Properties -* **DeltaTimeSessionWindowConfiguration**: [DeltaTimeSessionWindowConfiguration](#deltatimesessionwindowconfiguration) +* **CustomerManagedS3**: [CustomerManagedS3](#customermanageds3) +* **IotSiteWiseMultiLayerStorage**: [IotSiteWiseMultiLayerStorage](#iotsitewisemultilayerstorage) +* **ServiceManagedS3**: [ServiceManagedS3](#servicemanageds3) + +## DeltaTime +### Properties +* **OffsetSeconds**: int (Required) +* **TimeExpression**: string (Required) ## DeltaTimeSessionWindowConfiguration ### Properties * **TimeoutInMinutes**: int (Required) -## RetentionPeriod +## DeviceRegistryEnrich ### Properties -* **NumberOfDays**: int -* **Unlimited**: bool +* **Attribute**: string (Required) +* **Name**: string (Required) +* **Next**: string +* **RoleArn**: string (Required) +* **ThingName**: string (Required) -## Tag +## DeviceShadowEnrich ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **Attribute**: string (Required) +* **Name**: string (Required) +* **Next**: string +* **RoleArn**: string (Required) +* **ThingName**: string (Required) -## Trigger +## FileFormatConfiguration ### Properties -* **Schedule**: [Schedule](#schedule) -* **TriggeringDataset**: [TriggeringDataset](#triggeringdataset) +* **JsonConfiguration**: [JsonConfiguration](#jsonconfiguration) +* **ParquetConfiguration**: [ParquetConfiguration](#parquetconfiguration) -## Schedule +## Filter ### Properties -* **ScheduleExpression**: string (Required) +* **DeltaTime**: [DeltaTime](#deltatime) -## TriggeringDataset +## Filter ### Properties -* **DatasetName**: string (Required, Identifier) +* **Filter**: string (Required) +* **Name**: string (Required) +* **Next**: string -## VersioningConfiguration +## GlueConfiguration ### Properties -* **MaxVersions**: int -* **Unlimited**: bool +* **DatabaseName**: string (Required) +* **TableName**: string (Required) -## AWS.IoTAnalytics/DatastoreProperties +## IotEventsDestinationConfiguration ### Properties -* **DatastoreName**: string (Identifier) -* **DatastorePartitions**: [DatastorePartitions](#datastorepartitions) -* **DatastoreStorage**: [DatastoreStorage](#datastorestorage) -* **FileFormatConfiguration**: [FileFormatConfiguration](#fileformatconfiguration) -* **Id**: string (ReadOnly) -* **RetentionPeriod**: [RetentionPeriod](#retentionperiod) -* **Tags**: [Tag](#tag)[] +* **InputName**: string (Required) +* **RoleArn**: string (Required) -## DatastorePartitions +## IotSiteWiseMultiLayerStorage ### Properties -* **Partitions**: [DatastorePartition](#datastorepartition)[] +* **CustomerManagedS3Storage**: [CustomerManagedS3Storage](#customermanageds3storage) -## DatastorePartition +## JsonConfiguration ### Properties -* **Partition**: [Partition](#partition) -* **TimestampPartition**: [TimestampPartition](#timestamppartition) -## Partition +## Lambda ### Properties -* **AttributeName**: string (Required) +* **BatchSize**: int (Required) +* **LambdaName**: string (Required) +* **Name**: string (Required) +* **Next**: string -## TimestampPartition +## LateDataRule ### Properties -* **AttributeName**: string (Required) -* **TimestampFormat**: string +* **RuleConfiguration**: [LateDataRuleConfiguration](#latedataruleconfiguration) (Required) +* **RuleName**: string -## DatastoreStorage +## LateDataRuleConfiguration ### Properties -* **CustomerManagedS3**: [CustomerManagedS3](#customermanageds3) -* **IotSiteWiseMultiLayerStorage**: [IotSiteWiseMultiLayerStorage](#iotsitewisemultilayerstorage) -* **ServiceManagedS3**: [ServiceManagedS3](#servicemanageds3) +* **DeltaTimeSessionWindowConfiguration**: [DeltaTimeSessionWindowConfiguration](#deltatimesessionwindowconfiguration) -## CustomerManagedS3 +## Math ### Properties -* **Bucket**: string (Required) -* **KeyPrefix**: string -* **RoleArn**: string (Required) +* **Attribute**: string (Required) +* **Math**: string (Required) +* **Name**: string (Required) +* **Next**: string -## IotSiteWiseMultiLayerStorage +## OutputFileUriValue ### Properties -* **CustomerManagedS3Storage**: [CustomerManagedS3Storage](#customermanageds3storage) +* **FileName**: string (Required) -## CustomerManagedS3Storage +## ParquetConfiguration ### Properties -* **Bucket**: string (Required) -* **KeyPrefix**: string +* **SchemaDefinition**: [SchemaDefinition](#schemadefinition) -## ServiceManagedS3 +## Partition ### Properties +* **AttributeName**: string (Required) -## FileFormatConfiguration +## Pipeline_Attributes ### Properties -* **JsonConfiguration**: [JsonConfiguration](#jsonconfiguration) -* **ParquetConfiguration**: [ParquetConfiguration](#parquetconfiguration) -## JsonConfiguration +## QueryAction ### Properties +* **Filters**: [Filter](#filter)[] +* **SqlQuery**: string (Required) -## ParquetConfiguration +## RemoveAttributes ### Properties -* **SchemaDefinition**: [SchemaDefinition](#schemadefinition) +* **Attributes**: string[] (Required) +* **Name**: string (Required) +* **Next**: string -## SchemaDefinition +## ResourceConfiguration ### Properties -* **Columns**: [Column](#column)[] +* **ComputeType**: string (Required) +* **VolumeSizeInGB**: int (Required) -## Column +## RetentionPeriod ### Properties -* **Name**: string (Required) -* **Type**: string (Required) +* **NumberOfDays**: int +* **Unlimited**: bool ## RetentionPeriod ### Properties * **NumberOfDays**: int * **Unlimited**: bool -## Tag +## RetentionPeriod ### Properties +* **NumberOfDays**: int +* **Unlimited**: bool + +## S3DestinationConfiguration +### Properties +* **Bucket**: string (Required) +* **GlueConfiguration**: [GlueConfiguration](#glueconfiguration) * **Key**: string (Required) -* **Value**: string (Required) +* **RoleArn**: string (Required) -## AWS.IoTAnalytics/PipelineProperties +## Schedule ### Properties -* **Id**: string (ReadOnly) -* **PipelineActivities**: [Activity](#activity)[] (Required) -* **PipelineName**: string (Identifier) -* **Tags**: [Tag](#tag)[] +* **ScheduleExpression**: string (Required) -## Activity +## SchemaDefinition ### Properties -* **AddAttributes**: [AddAttributes](#addattributes) -* **Channel**: [Channel](#channel) -* **Datastore**: [Datastore](#datastore) -* **DeviceRegistryEnrich**: [DeviceRegistryEnrich](#deviceregistryenrich) -* **DeviceShadowEnrich**: [DeviceShadowEnrich](#deviceshadowenrich) -* **Filter**: [Filter](#filter) -* **Lambda**: [Lambda](#lambda) -* **Math**: [Math](#math) -* **RemoveAttributes**: [RemoveAttributes](#removeattributes) -* **SelectAttributes**: [SelectAttributes](#selectattributes) +* **Columns**: [Column](#column)[] -## AddAttributes +## SelectAttributes ### Properties -* **Attributes**: [Pipeline_Attributes](#pipelineattributes) (Required) +* **Attributes**: string[] (Required) * **Name**: string (Required) * **Next**: string -## Pipeline_Attributes +## ServiceManagedS3 ### Properties -## Channel +## ServiceManagedS3 ### Properties -* **ChannelName**: string (Required) -* **Name**: string (Required) -* **Next**: string -## Datastore +## Tag ### Properties -* **DatastoreName**: string (Required) -* **Name**: string (Required) +* **Key**: string (Required) +* **Value**: string (Required) -## DeviceRegistryEnrich +## Tag ### Properties -* **Attribute**: string (Required) -* **Name**: string (Required) -* **Next**: string -* **RoleArn**: string (Required) -* **ThingName**: string (Required) +* **Key**: string (Required) +* **Value**: string (Required) -## DeviceShadowEnrich +## Tag ### Properties -* **Attribute**: string (Required) -* **Name**: string (Required) -* **Next**: string -* **RoleArn**: string (Required) -* **ThingName**: string (Required) +* **Key**: string (Required) +* **Value**: string (Required) -## Filter +## Tag ### Properties -* **Filter**: string (Required) -* **Name**: string (Required) -* **Next**: string +* **Key**: string (Required) +* **Value**: string (Required) -## Lambda +## TimestampPartition ### Properties -* **BatchSize**: int (Required) -* **LambdaName**: string (Required) -* **Name**: string (Required) -* **Next**: string +* **AttributeName**: string (Required) +* **TimestampFormat**: string -## Math +## Trigger ### Properties -* **Attribute**: string (Required) -* **Math**: string (Required) -* **Name**: string (Required) -* **Next**: string +* **Schedule**: [Schedule](#schedule) +* **TriggeringDataset**: [TriggeringDataset](#triggeringdataset) -## RemoveAttributes +## TriggeringDataset ### Properties -* **Attributes**: string[] (Required) -* **Name**: string (Required) -* **Next**: string +* **DatasetName**: string (Required, Identifier) -## SelectAttributes +## Variable ### Properties -* **Attributes**: string[] (Required) -* **Name**: string (Required) -* **Next**: string +* **DatasetContentVersionValue**: [DatasetContentVersionValue](#datasetcontentversionvalue) +* **DoubleValue**: int +* **OutputFileUriValue**: [OutputFileUriValue](#outputfileurivalue) +* **StringValue**: string +* **VariableName**: string (Required) -## Tag +## VersioningConfiguration ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **MaxVersions**: int +* **Unlimited**: bool diff --git a/artifacts/bicep/aws/aws.iotcoredeviceadvisor/default/types.json b/artifacts/bicep/aws/aws.iotcoredeviceadvisor/default/types.json index 449bc809..d919d2e1 100644 --- a/artifacts/bicep/aws/aws.iotcoredeviceadvisor/default/types.json +++ b/artifacts/bicep/aws/aws.iotcoredeviceadvisor/default/types.json @@ -1 +1,205 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"DevicePermissionRoleArn"}},{"2":{"Name":"DeviceUnderTest","Properties":{"CertificateArn":{"Type":4,"Flags":0},"ThingArn":{"Type":4,"Flags":0}}}},{"2":{"Name":"Devices"}},{"2":{"Name":"IntendedForQualification"}},{"2":{"Name":"RootGroup"}},{"2":{"Name":"SuiteDefinitionName"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"3":{"ItemType":9}},{"2":{"Name":"AWS.IoTCoreDeviceAdvisor/SuiteDefinitionProperties","Properties":{"SuiteDefinitionArn":{"Type":4,"Flags":2,"Description":"The Amazon Resource name for the suite definition."},"SuiteDefinitionConfiguration":{"Type":18,"Flags":1},"SuiteDefinitionId":{"Type":4,"Flags":18,"Description":"The unique identifier for the suite definition."},"SuiteDefinitionVersion":{"Type":4,"Flags":2,"Description":"The suite definition version of a test suite."},"Tags":{"Type":19,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."}}}},{"3":{"ItemType":9}},{"2":{"Name":"SuiteDefinition_SuiteDefinitionConfiguration","Properties":{"DevicePermissionRoleArn":{"Type":4,"Flags":1},"Devices":{"Type":17,"Flags":0},"IntendedForQualification":{"Type":2,"Flags":0},"RootGroup":{"Type":4,"Flags":1},"SuiteDefinitionName":{"Type":4,"Flags":0}}}},{"3":{"ItemType":14}},{"2":{"Name":"AWS.IoTCoreDeviceAdvisor/SuiteDefinition","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":16,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IoTCoreDeviceAdvisor/SuiteDefinition@default","ScopeType":0,"Body":20}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "DevicePermissionRoleArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DeviceUnderTest", + "properties": { + "CertificateArn": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "ThingArn": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Devices", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "IntendedForQualification", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RootGroup", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SuiteDefinitionName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.IoTCoreDeviceAdvisor/SuiteDefinitionProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "SuiteDefinition_SuiteDefinitionConfiguration", + "properties": { + "DevicePermissionRoleArn": { + "type": { + "$ref": "#/7" + }, + "flags": 1 + }, + "Devices": { + "type": { + "$ref": "#/11" + }, + "flags": 0 + }, + "IntendedForQualification": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "RootGroup": { + "type": { + "$ref": "#/7" + }, + "flags": 1 + }, + "SuiteDefinitionName": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoTCoreDeviceAdvisor/SuiteDefinitionProperties", + "properties": { + "SuiteDefinitionArn": { + "type": { + "$ref": "#/7" + }, + "flags": 2, + "description": "The Amazon Resource name for the suite definition." + }, + "SuiteDefinitionConfiguration": { + "type": { + "$ref": "#/12" + }, + "flags": 1 + }, + "SuiteDefinitionId": { + "type": { + "$ref": "#/7" + }, + "flags": 18, + "description": "The unique identifier for the suite definition." + }, + "SuiteDefinitionVersion": { + "type": { + "$ref": "#/7" + }, + "flags": 2, + "description": "The suite definition version of a test suite." + }, + "Tags": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoTCoreDeviceAdvisor/SuiteDefinition", + "properties": { + "name": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/7" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/14" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IoTCoreDeviceAdvisor/SuiteDefinition@default", + "scopeType": 0, + "body": { + "$ref": "#/15" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.iotcoredeviceadvisor/default/types.md b/artifacts/bicep/aws/aws.iotcoredeviceadvisor/default/types.md index 711c4e39..c88bcd20 100644 --- a/artifacts/bicep/aws/aws.iotcoredeviceadvisor/default/types.md +++ b/artifacts/bicep/aws/aws.iotcoredeviceadvisor/default/types.md @@ -3,9 +3,9 @@ ## Resource AWS.IoTCoreDeviceAdvisor/SuiteDefinition@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IoTCoreDeviceAdvisor/SuiteDefinitionProperties](#awsiotcoredeviceadvisorsuitedefinitionproperties) (Required): properties of the resource +* **properties**: [AWS.IoTCoreDeviceAdvisor/SuiteDefinitionProperties](#awsiotcoredeviceadvisorsuitedefinitionproperties) (Required, Identifier): properties of the resource ## AWS.IoTCoreDeviceAdvisor/SuiteDefinitionProperties ### Properties @@ -15,6 +15,11 @@ * **SuiteDefinitionVersion**: string (ReadOnly): The suite definition version of a test suite. * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. +## DeviceUnderTest +### Properties +* **CertificateArn**: string +* **ThingArn**: string + ## SuiteDefinition_SuiteDefinitionConfiguration ### Properties * **DevicePermissionRoleArn**: string (Required) @@ -23,11 +28,6 @@ * **RootGroup**: string (Required) * **SuiteDefinitionName**: string -## DeviceUnderTest -### Properties -* **CertificateArn**: string -* **ThingArn**: string - ## Tag ### Properties * **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. diff --git a/artifacts/bicep/aws/aws.iotevents/default/types.json b/artifacts/bicep/aws/aws.iotevents/default/types.json index 49879fbb..a1b5a332 100644 --- a/artifacts/bicep/aws/aws.iotevents/default/types.json +++ b/artifacts/bicep/aws/aws.iotevents/default/types.json @@ -1 +1,1644 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"AcknowledgeFlow","Properties":{"Enabled":{"Type":2,"Flags":0,"Description":"The value must be TRUE or FALSE. If TRUE, you receive a notification when the alarm state changes. You must choose to acknowledge the notification before the alarm state can return to NORMAL. If FALSE, you won't receive notifications. The alarm automatically changes to the NORMAL state when the input property value returns to the specified range."}}}},{"2":{"Name":"AlarmAction","Properties":{"DynamoDB":{"Type":17,"Flags":0},"DynamoDBv2":{"Type":18,"Flags":0},"Firehose":{"Type":19,"Flags":0},"IotEvents":{"Type":21,"Flags":0},"IotSiteWise":{"Type":22,"Flags":0},"IotTopicPublish":{"Type":23,"Flags":0},"Lambda":{"Type":24,"Flags":0},"Sns":{"Type":27,"Flags":0},"Sqs":{"Type":28,"Flags":0}}}},{"2":{"Name":"AlarmActions"}},{"2":{"Name":"AlarmCapabilities","Properties":{"AcknowledgeFlow":{"Type":8,"Flags":0},"InitializationConfiguration":{"Type":20,"Flags":0}}}},{"2":{"Name":"AlarmEventActions","Properties":{"AlarmActions":{"Type":31,"Flags":0}}}},{"2":{"Name":"AlarmRule","Properties":{"SimpleRule":{"Type":26,"Flags":0}}}},{"2":{"Name":"AssetPropertyTimestamp","Properties":{"OffsetInNanos":{"Type":4,"Flags":0,"Description":"The timestamp, in seconds, in the Unix epoch format. The valid range is between `1-31556889864403199`. You can also specify an expression."},"TimeInSeconds":{"Type":4,"Flags":1,"Description":"The nanosecond offset converted from `timeInSeconds`. The valid range is between `0-999999999`. You can also specify an expression."}}}},{"2":{"Name":"AssetPropertyValue","Properties":{"Quality":{"Type":4,"Flags":0,"Description":"The quality of the asset property value. The value must be `GOOD`, `BAD`, or `UNCERTAIN`. You can also specify an expression."},"Timestamp":{"Type":14,"Flags":0},"Value":{"Type":16,"Flags":1}}}},{"2":{"Name":"AssetPropertyVariant","Properties":{"BooleanValue":{"Type":4,"Flags":0,"Description":"The asset property value is a Boolean value that must be `TRUE` or `FALSE`. You can also specify an expression. If you use an expression, the evaluated result should be a Boolean value."},"DoubleValue":{"Type":4,"Flags":0,"Description":"The asset property value is a double. You can also specify an expression. If you use an expression, the evaluated result should be a double."},"IntegerValue":{"Type":4,"Flags":0,"Description":"The asset property value is an integer. You can also specify an expression. If you use an expression, the evaluated result should be an integer."},"StringValue":{"Type":4,"Flags":0,"Description":"The asset property value is a string. You can also specify an expression. If you use an expression, the evaluated result should be a string."}}}},{"2":{"Name":"DynamoDB","Properties":{"HashKeyField":{"Type":4,"Flags":1,"Description":"The name of the hash key (also called the partition key)."},"HashKeyType":{"Type":4,"Flags":0,"Description":"The data type for the hash key (also called the partition key). You can specify the following values:\n\n* `STRING` - The hash key is a string.\n\n* `NUMBER` - The hash key is a number.\n\nIf you don't specify `hashKeyType`, the default value is `STRING`."},"HashKeyValue":{"Type":4,"Flags":1,"Description":"The value of the hash key (also called the partition key)."},"Operation":{"Type":4,"Flags":0,"Description":"The type of operation to perform. You can specify the following values:\n\n* `INSERT` - Insert data as a new item into the DynamoDB table. This item uses the specified hash key as a partition key. If you specified a range key, the item uses the range key as a sort key.\n\n* `UPDATE` - Update an existing item of the DynamoDB table with new data. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.\n\n* `DELETE` - Delete an existing item of the DynamoDB table. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.\n\nIf you don't specify this parameter, AWS IoT Events triggers the `INSERT` operation."},"Payload":{"Type":25,"Flags":0},"PayloadField":{"Type":4,"Flags":0,"Description":"The name of the DynamoDB column that receives the action payload.\n\nIf you don't specify this parameter, the name of the DynamoDB column is `payload`."},"RangeKeyField":{"Type":4,"Flags":0,"Description":"The name of the range key (also called the sort key)."},"RangeKeyType":{"Type":4,"Flags":0,"Description":"The data type for the range key (also called the sort key), You can specify the following values:\n\n* `STRING` - The range key is a string.\n\n* `NUMBER` - The range key is number.\n\nIf you don't specify `rangeKeyField`, the default value is `STRING`."},"RangeKeyValue":{"Type":4,"Flags":0,"Description":"The value of the range key (also called the sort key)."},"TableName":{"Type":4,"Flags":1,"Description":"The name of the DynamoDB table."}}}},{"2":{"Name":"DynamoDBv2","Properties":{"Payload":{"Type":25,"Flags":0},"TableName":{"Type":4,"Flags":1,"Description":"The name of the DynamoDB table."}}}},{"2":{"Name":"Firehose","Properties":{"DeliveryStreamName":{"Type":4,"Flags":1,"Description":"The name of the Kinesis Data Firehose delivery stream where the data is written."},"Payload":{"Type":25,"Flags":0},"Separator":{"Type":4,"Flags":0,"Description":"A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream. Valid values are: '\\n' (newline), '\\t' (tab), '\\r\\n' (Windows newline), ',' (comma)."}}}},{"2":{"Name":"InitializationConfiguration","Properties":{"DisabledOnInitialization":{"Type":2,"Flags":1,"Description":"The value must be TRUE or FALSE. If FALSE, all alarm instances created based on the alarm model are activated. The default value is TRUE."}}}},{"2":{"Name":"IotEvents","Properties":{"InputName":{"Type":4,"Flags":1,"Description":"The name of the AWS IoT Events input where the data is sent."},"Payload":{"Type":25,"Flags":0}}}},{"2":{"Name":"IotSiteWise","Properties":{"AssetId":{"Type":4,"Flags":0,"Description":"The ID of the asset that has the specified property. You can specify an expression."},"EntryId":{"Type":4,"Flags":0,"Description":"A unique identifier for this entry. You can use the entry ID to track which data entry causes an error in case of failure. The default is a new unique identifier. You can also specify an expression."},"PropertyAlias":{"Type":4,"Flags":0,"Description":"The alias of the asset property. You can also specify an expression."},"PropertyId":{"Type":4,"Flags":0,"Description":"The ID of the asset property. You can specify an expression."},"PropertyValue":{"Type":15,"Flags":0}}}},{"2":{"Name":"IotTopicPublish","Properties":{"MqttTopic":{"Type":4,"Flags":1,"Description":"The MQTT topic of the message. You can use a string expression that includes variables (`$variable.`) and input values (`$input..`) as the topic string."},"Payload":{"Type":25,"Flags":0}}}},{"2":{"Name":"Lambda","Properties":{"FunctionArn":{"Type":4,"Flags":1,"Description":"The ARN of the Lambda function that is executed."},"Payload":{"Type":25,"Flags":0}}}},{"2":{"Name":"Payload","Properties":{"ContentExpression":{"Type":4,"Flags":1,"Description":"The content of the payload. You can use a string expression that includes quoted strings (`''`), variables (`$variable.`), input values (`$input..`), string concatenations, and quoted strings that contain `${}` as the content. The recommended maximum size of a content expression is 1 KB."},"Type":{"Type":4,"Flags":1,"Description":"The value of the payload type can be either `STRING` or `JSON`."}}}},{"2":{"Name":"SimpleRule","Properties":{"ComparisonOperator":{"Type":4,"Flags":1,"Description":"The comparison operator."},"InputProperty":{"Type":4,"Flags":1,"Description":"The value on the left side of the comparison operator. You can specify an AWS IoT Events input attribute as an input property."},"Threshold":{"Type":4,"Flags":1,"Description":"The value on the right side of the comparison operator. You can enter a number or specify an AWS IoT Events input attribute."}}}},{"2":{"Name":"Sns","Properties":{"Payload":{"Type":25,"Flags":0},"TargetArn":{"Type":4,"Flags":1,"Description":"The ARN of the Amazon SNS target where the message is sent."}}}},{"2":{"Name":"Sqs","Properties":{"Payload":{"Type":25,"Flags":0},"QueueUrl":{"Type":4,"Flags":1,"Description":"The URL of the SQS queue where the data is written."},"UseBase64":{"Type":2,"Flags":0,"Description":"Set this to `TRUE` if you want the data to be base-64 encoded before it is written to the queue. Otherwise, set this to `FALSE`."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"Key of the Tag."},"Value":{"Type":4,"Flags":1,"Description":"Value of the Tag."}}}},{"3":{"ItemType":9}},{"3":{"ItemType":9}},{"2":{"Name":"AWS.IoTEvents/AlarmModelProperties","Properties":{"AlarmCapabilities":{"Type":11,"Flags":0},"AlarmEventActions":{"Type":12,"Flags":0},"AlarmModelDescription":{"Type":4,"Flags":0,"Description":"A brief description of the alarm model."},"AlarmModelName":{"Type":4,"Flags":16,"Description":"The name of the alarm model."},"AlarmRule":{"Type":13,"Flags":1},"Key":{"Type":4,"Flags":0,"Description":"The value used to identify a alarm instance. When a device or system sends input, a new alarm instance with a unique key value is created. AWS IoT Events can continue to route input to its corresponding alarm instance based on this identifying information.\n\nThis parameter uses a JSON-path expression to select the attribute-value pair in the message payload that is used for identification. To route the message to the correct alarm instance, the device must send a message payload that contains the same attribute-value."},"RoleArn":{"Type":4,"Flags":1,"Description":"The ARN of the role that grants permission to AWS IoT Events to perform its operations."},"Severity":{"Type":3,"Flags":0,"Description":"A non-negative integer that reflects the severity level of the alarm.\n\n"},"Tags":{"Type":33,"Flags":0,"Description":"An array of key-value pairs to apply to this resource.\n\nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)."}}}},{"3":{"ItemType":29}},{"2":{"Name":"AWS.IoTEvents/AlarmModel","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":32,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IoTEvents/AlarmModel@default","ScopeType":0,"Body":34}},{"2":{"Name":"Action","Properties":{"ClearTimer":{"Type":40,"Flags":0},"DynamoDB":{"Type":42,"Flags":0},"DynamoDBv2":{"Type":43,"Flags":0},"Firehose":{"Type":45,"Flags":0},"IotEvents":{"Type":46,"Flags":0},"IotSiteWise":{"Type":47,"Flags":0},"IotTopicPublish":{"Type":48,"Flags":0},"Lambda":{"Type":49,"Flags":0},"ResetTimer":{"Type":54,"Flags":0},"SetTimer":{"Type":55,"Flags":0},"SetVariable":{"Type":56,"Flags":0},"Sns":{"Type":57,"Flags":0},"Sqs":{"Type":58,"Flags":0}}}},{"2":{"Name":"AssetPropertyTimestamp","Properties":{"OffsetInNanos":{"Type":4,"Flags":0,"Description":"The timestamp, in seconds, in the Unix epoch format. The valid range is between `1-31556889864403199`. You can also specify an expression."},"TimeInSeconds":{"Type":4,"Flags":1,"Description":"The nanosecond offset converted from `timeInSeconds`. The valid range is between `0-999999999`. You can also specify an expression."}}}},{"2":{"Name":"AssetPropertyValue","Properties":{"Quality":{"Type":4,"Flags":0,"Description":"The quality of the asset property value. The value must be `GOOD`, `BAD`, or `UNCERTAIN`. You can also specify an expression."},"Timestamp":{"Type":37,"Flags":0},"Value":{"Type":39,"Flags":1}}}},{"2":{"Name":"AssetPropertyVariant","Properties":{"BooleanValue":{"Type":4,"Flags":0,"Description":"The asset property value is a Boolean value that must be `TRUE` or `FALSE`. You can also specify an expression. If you use an expression, the evaluated result should be a Boolean value."},"DoubleValue":{"Type":4,"Flags":0,"Description":"The asset property value is a double. You can also specify an expression. If you use an expression, the evaluated result should be a double."},"IntegerValue":{"Type":4,"Flags":0,"Description":"The asset property value is an integer. You can also specify an expression. If you use an expression, the evaluated result should be an integer."},"StringValue":{"Type":4,"Flags":0,"Description":"The asset property value is a string. You can also specify an expression. If you use an expression, the evaluated result should be a string."}}}},{"2":{"Name":"ClearTimer","Properties":{"TimerName":{"Type":4,"Flags":1}}}},{"2":{"Name":"DetectorModelDefinition","Properties":{"InitialStateName":{"Type":4,"Flags":1,"Description":"The state that is entered at the creation of each detector (instance)."},"States":{"Type":62,"Flags":1,"Description":"Information about the states of the detector."}}}},{"2":{"Name":"DynamoDB","Properties":{"HashKeyField":{"Type":4,"Flags":1,"Description":"The name of the hash key (also called the partition key)."},"HashKeyType":{"Type":4,"Flags":0,"Description":"The data type for the hash key (also called the partition key). You can specify the following values:\n\n* `STRING` - The hash key is a string.\n\n* `NUMBER` - The hash key is a number.\n\nIf you don't specify `hashKeyType`, the default value is `STRING`."},"HashKeyValue":{"Type":4,"Flags":1,"Description":"The value of the hash key (also called the partition key)."},"Operation":{"Type":4,"Flags":0,"Description":"The type of operation to perform. You can specify the following values:\n\n* `INSERT` - Insert data as a new item into the DynamoDB table. This item uses the specified hash key as a partition key. If you specified a range key, the item uses the range key as a sort key.\n\n* `UPDATE` - Update an existing item of the DynamoDB table with new data. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.\n\n* `DELETE` - Delete an existing item of the DynamoDB table. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.\n\nIf you don't specify this parameter, AWS IoT Events triggers the `INSERT` operation."},"Payload":{"Type":53,"Flags":0},"PayloadField":{"Type":4,"Flags":0,"Description":"The name of the DynamoDB column that receives the action payload.\n\nIf you don't specify this parameter, the name of the DynamoDB column is `payload`."},"RangeKeyField":{"Type":4,"Flags":0,"Description":"The name of the range key (also called the sort key)."},"RangeKeyType":{"Type":4,"Flags":0,"Description":"The data type for the range key (also called the sort key), You can specify the following values:\n\n* `STRING` - The range key is a string.\n\n* `NUMBER` - The range key is number.\n\nIf you don't specify `rangeKeyField`, the default value is `STRING`."},"RangeKeyValue":{"Type":4,"Flags":0,"Description":"The value of the range key (also called the sort key)."},"TableName":{"Type":4,"Flags":1,"Description":"The name of the DynamoDB table."}}}},{"2":{"Name":"DynamoDBv2","Properties":{"Payload":{"Type":53,"Flags":0},"TableName":{"Type":4,"Flags":1,"Description":"The name of the DynamoDB table."}}}},{"2":{"Name":"Event","Properties":{"Actions":{"Type":63,"Flags":0,"Description":"The actions to be performed."},"Condition":{"Type":4,"Flags":0,"Description":"The Boolean expression that, when `TRUE`, causes the `actions` to be performed. If not present, the `actions` are performed (=`TRUE`). If the expression result is not a `Boolean` value, the `actions` are not performed (=`FALSE`)."},"EventName":{"Type":4,"Flags":1,"Description":"The name of the event."}}}},{"2":{"Name":"Firehose","Properties":{"DeliveryStreamName":{"Type":4,"Flags":1,"Description":"The name of the Kinesis Data Firehose delivery stream where the data is written."},"Payload":{"Type":53,"Flags":0},"Separator":{"Type":4,"Flags":0,"Description":"A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream. Valid values are: '\\n' (newline), '\\t' (tab), '\\r\\n' (Windows newline), ',' (comma)."}}}},{"2":{"Name":"IotEvents","Properties":{"InputName":{"Type":4,"Flags":1,"Description":"The name of the AWS IoT Events input where the data is sent."},"Payload":{"Type":53,"Flags":0}}}},{"2":{"Name":"IotSiteWise","Properties":{"AssetId":{"Type":4,"Flags":0,"Description":"The ID of the asset that has the specified property. You can specify an expression."},"EntryId":{"Type":4,"Flags":0,"Description":"A unique identifier for this entry. You can use the entry ID to track which data entry causes an error in case of failure. The default is a new unique identifier. You can also specify an expression."},"PropertyAlias":{"Type":4,"Flags":0,"Description":"The alias of the asset property. You can also specify an expression."},"PropertyId":{"Type":4,"Flags":0,"Description":"The ID of the asset property. You can specify an expression."},"PropertyValue":{"Type":38,"Flags":1}}}},{"2":{"Name":"IotTopicPublish","Properties":{"MqttTopic":{"Type":4,"Flags":1,"Description":"The MQTT topic of the message. You can use a string expression that includes variables (`$variable.`) and input values (`$input..`) as the topic string."},"Payload":{"Type":53,"Flags":0}}}},{"2":{"Name":"Lambda","Properties":{"FunctionArn":{"Type":4,"Flags":1,"Description":"The ARN of the Lambda function that is executed."},"Payload":{"Type":53,"Flags":0}}}},{"2":{"Name":"OnEnter","Properties":{"Events":{"Type":64,"Flags":0,"Description":"Specifies the `actions` that are performed when the state is entered and the `condition` is `TRUE`."}}}},{"2":{"Name":"OnExit","Properties":{"Events":{"Type":65,"Flags":0,"Description":"Specifies the `actions` that are performed when the state is exited and the `condition` is `TRUE`."}}}},{"2":{"Name":"OnInput","Properties":{"Events":{"Type":66,"Flags":0,"Description":"Specifies the `actions` performed when the `condition` evaluates to `TRUE`."},"TransitionEvents":{"Type":67,"Flags":0,"Description":"Specifies the `actions` performed, and the next `state` entered, when a `condition` evaluates to `TRUE`."}}}},{"2":{"Name":"Payload","Properties":{"ContentExpression":{"Type":4,"Flags":1,"Description":"The content of the payload. You can use a string expression that includes quoted strings (`''`), variables (`$variable.`), input values (`$input..`), string concatenations, and quoted strings that contain `${}` as the content. The recommended maximum size of a content expression is 1 KB."},"Type":{"Type":4,"Flags":1,"Description":"The value of the payload type can be either `STRING` or `JSON`."}}}},{"2":{"Name":"ResetTimer","Properties":{"TimerName":{"Type":4,"Flags":1,"Description":"The name of the timer to reset."}}}},{"2":{"Name":"SetTimer","Properties":{"DurationExpression":{"Type":4,"Flags":0,"Description":"The duration of the timer, in seconds. You can use a string expression that includes numbers, variables (`$variable.`), and input values (`$input..`) as the duration. The range of the duration is `1-31622400` seconds. To ensure accuracy, the minimum duration is `60` seconds. The evaluated result of the duration is rounded down to the nearest whole number."},"Seconds":{"Type":3,"Flags":0,"Description":"The number of seconds until the timer expires. The minimum value is `60` seconds to ensure accuracy. The maximum value is `31622400` seconds."},"TimerName":{"Type":4,"Flags":1,"Description":"The name of the timer."}}}},{"2":{"Name":"SetVariable","Properties":{"Value":{"Type":4,"Flags":1,"Description":"The new value of the variable."},"VariableName":{"Type":4,"Flags":1,"Description":"The name of the variable."}}}},{"2":{"Name":"Sns","Properties":{"Payload":{"Type":53,"Flags":0},"TargetArn":{"Type":4,"Flags":1,"Description":"The ARN of the Amazon SNS target where the message is sent."}}}},{"2":{"Name":"Sqs","Properties":{"Payload":{"Type":53,"Flags":0},"QueueUrl":{"Type":4,"Flags":1,"Description":"The URL of the SQS queue where the data is written."},"UseBase64":{"Type":2,"Flags":0,"Description":"Set this to `TRUE` if you want the data to be base-64 encoded before it is written to the queue. Otherwise, set this to `FALSE`."}}}},{"2":{"Name":"State","Properties":{"OnEnter":{"Type":50,"Flags":0},"OnExit":{"Type":51,"Flags":0},"OnInput":{"Type":52,"Flags":0},"StateName":{"Type":4,"Flags":1,"Description":"The name of the state."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"Key of the Tag."},"Value":{"Type":4,"Flags":1,"Description":"Value of the Tag."}}}},{"2":{"Name":"TransitionEvent","Properties":{"Actions":{"Type":68,"Flags":0,"Description":"The actions to be performed."},"Condition":{"Type":4,"Flags":1,"Description":"A Boolean expression that when `TRUE` causes the `actions` to be performed and the `nextState` to be entered."},"EventName":{"Type":4,"Flags":1,"Description":"The name of the event."},"NextState":{"Type":4,"Flags":1,"Description":"The next state to enter."}}}},{"3":{"ItemType":59}},{"3":{"ItemType":36}},{"3":{"ItemType":44}},{"3":{"ItemType":44}},{"3":{"ItemType":44}},{"3":{"ItemType":61}},{"3":{"ItemType":36}},{"2":{"Name":"AWS.IoTEvents/DetectorModelProperties","Properties":{"DetectorModelDefinition":{"Type":41,"Flags":1},"DetectorModelDescription":{"Type":4,"Flags":0,"Description":"A brief description of the detector model."},"DetectorModelName":{"Type":4,"Flags":16,"Description":"The name of the detector model."},"EvaluationMethod":{"Type":4,"Flags":0,"Description":"Information about the order in which events are evaluated and how actions are executed."},"Key":{"Type":4,"Flags":0,"Description":"The value used to identify a detector instance. When a device or system sends input, a new detector instance with a unique key value is created. AWS IoT Events can continue to route input to its corresponding detector instance based on this identifying information.\n\nThis parameter uses a JSON-path expression to select the attribute-value pair in the message payload that is used for identification. To route the message to the correct detector instance, the device must send a message payload that contains the same attribute-value."},"RoleArn":{"Type":4,"Flags":1,"Description":"The ARN of the role that grants permission to AWS IoT Events to perform its operations."},"Tags":{"Type":70,"Flags":0,"Description":"An array of key-value pairs to apply to this resource.\n\nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)."}}}},{"3":{"ItemType":60}},{"2":{"Name":"AWS.IoTEvents/DetectorModel","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":69,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IoTEvents/DetectorModel@default","ScopeType":0,"Body":71}},{"2":{"Name":"Attribute","Properties":{"JsonPath":{"Type":4,"Flags":1,"Description":"An expression that specifies an attribute-value pair in a JSON structure. Use this to specify an attribute from the JSON payload that is made available by the input. Inputs are derived from messages sent to AWS IoT Events (`BatchPutMessage`). Each such message contains a JSON payload. The attribute (and its paired value) specified here are available for use in the `condition` expressions used by detectors.\n\n_Syntax_: `....`"}}}},{"2":{"Name":"InputDefinition","Properties":{"Attributes":{"Type":76,"Flags":1,"Description":"The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent to the AWS IoT Events system using `BatchPutMessage`. Each such message contains a JSON payload, and those attributes (and their paired values) specified here are available for use in the `condition` expressions used by detectors that monitor this input."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"Key of the Tag."},"Value":{"Type":4,"Flags":1,"Description":"Value of the Tag."}}}},{"3":{"ItemType":73}},{"2":{"Name":"AWS.IoTEvents/InputProperties","Properties":{"InputDefinition":{"Type":74,"Flags":1},"InputDescription":{"Type":4,"Flags":0,"Description":"A brief description of the input."},"InputName":{"Type":4,"Flags":16,"Description":"The name of the input."},"Tags":{"Type":78,"Flags":0,"Description":"An array of key-value pairs to apply to this resource.\n\nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)."}}}},{"3":{"ItemType":75}},{"2":{"Name":"AWS.IoTEvents/Input","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":77,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IoTEvents/Input@default","ScopeType":0,"Body":79}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "AcknowledgeFlow", + "properties": { + "Enabled": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "The value must be TRUE or FALSE. If TRUE, you receive a notification when the alarm state changes. You must choose to acknowledge the notification before the alarm state can return to NORMAL. If FALSE, you won't receive notifications. The alarm automatically changes to the NORMAL state when the input property value returns to the specified range." + } + } + }, + { + "$type": "ObjectType", + "name": "AlarmAction", + "properties": { + "DynamoDB": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "DynamoDBv2": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "Firehose": { + "type": { + "$ref": "#/11" + }, + "flags": 0 + }, + "IotEvents": { + "type": { + "$ref": "#/13" + }, + "flags": 0 + }, + "IotSiteWise": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + }, + "IotTopicPublish": { + "type": { + "$ref": "#/15" + }, + "flags": 0 + }, + "Lambda": { + "type": { + "$ref": "#/16" + }, + "flags": 0 + }, + "Sns": { + "type": { + "$ref": "#/19" + }, + "flags": 0 + }, + "Sqs": { + "type": { + "$ref": "#/20" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AlarmActions", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AlarmCapabilities", + "properties": { + "AcknowledgeFlow": { + "type": { + "$ref": "#/0" + }, + "flags": 0 + }, + "InitializationConfiguration": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AlarmEventActions", + "properties": { + "AlarmActions": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AlarmRule", + "properties": { + "SimpleRule": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AssetPropertyTimestamp", + "properties": { + "OffsetInNanos": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "The timestamp, in seconds, in the Unix epoch format. The valid range is between `1-31556889864403199`. You can also specify an expression." + }, + "TimeInSeconds": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "The nanosecond offset converted from `timeInSeconds`. The valid range is between `0-999999999`. You can also specify an expression." + } + } + }, + { + "$type": "ObjectType", + "name": "AssetPropertyValue", + "properties": { + "Quality": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "The quality of the asset property value. The value must be `GOOD`, `BAD`, or `UNCERTAIN`. You can also specify an expression." + }, + "Timestamp": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AssetPropertyVariant", + "properties": { + "BooleanValue": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "The asset property value is a Boolean value that must be `TRUE` or `FALSE`. You can also specify an expression. If you use an expression, the evaluated result should be a Boolean value." + }, + "DoubleValue": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "The asset property value is a double. You can also specify an expression. If you use an expression, the evaluated result should be a double." + }, + "IntegerValue": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "The asset property value is an integer. You can also specify an expression. If you use an expression, the evaluated result should be an integer." + }, + "StringValue": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "The asset property value is a string. You can also specify an expression. If you use an expression, the evaluated result should be a string." + } + } + }, + { + "$type": "ObjectType", + "name": "DynamoDB", + "properties": { + "HashKeyField": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "The name of the hash key (also called the partition key)." + }, + "HashKeyType": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "The data type for the hash key (also called the partition key). You can specify the following values:\n\n* `STRING` - The hash key is a string.\n\n* `NUMBER` - The hash key is a number.\n\nIf you don't specify `hashKeyType`, the default value is `STRING`." + }, + "HashKeyValue": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "The value of the hash key (also called the partition key)." + }, + "Operation": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "The type of operation to perform. You can specify the following values:\n\n* `INSERT` - Insert data as a new item into the DynamoDB table. This item uses the specified hash key as a partition key. If you specified a range key, the item uses the range key as a sort key.\n\n* `UPDATE` - Update an existing item of the DynamoDB table with new data. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.\n\n* `DELETE` - Delete an existing item of the DynamoDB table. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.\n\nIf you don't specify this parameter, AWS IoT Events triggers the `INSERT` operation." + }, + "Payload": { + "type": { + "$ref": "#/17" + }, + "flags": 0 + }, + "PayloadField": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "The name of the DynamoDB column that receives the action payload.\n\nIf you don't specify this parameter, the name of the DynamoDB column is `payload`." + }, + "RangeKeyField": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "The name of the range key (also called the sort key)." + }, + "RangeKeyType": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "The data type for the range key (also called the sort key), You can specify the following values:\n\n* `STRING` - The range key is a string.\n\n* `NUMBER` - The range key is number.\n\nIf you don't specify `rangeKeyField`, the default value is `STRING`." + }, + "RangeKeyValue": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "The value of the range key (also called the sort key)." + }, + "TableName": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "The name of the DynamoDB table." + } + } + }, + { + "$type": "ObjectType", + "name": "DynamoDBv2", + "properties": { + "Payload": { + "type": { + "$ref": "#/17" + }, + "flags": 0 + }, + "TableName": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "The name of the DynamoDB table." + } + } + }, + { + "$type": "ObjectType", + "name": "Firehose", + "properties": { + "DeliveryStreamName": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "The name of the Kinesis Data Firehose delivery stream where the data is written." + }, + "Payload": { + "type": { + "$ref": "#/17" + }, + "flags": 0 + }, + "Separator": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream. Valid values are: '\\n' (newline), '\\t' (tab), '\\r\\n' (Windows newline), ',' (comma)." + } + } + }, + { + "$type": "ObjectType", + "name": "InitializationConfiguration", + "properties": { + "DisabledOnInitialization": { + "type": { + "$ref": "#/22" + }, + "flags": 1, + "description": "The value must be TRUE or FALSE. If FALSE, all alarm instances created based on the alarm model are activated. The default value is TRUE." + } + } + }, + { + "$type": "ObjectType", + "name": "IotEvents", + "properties": { + "InputName": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "The name of the AWS IoT Events input where the data is sent." + }, + "Payload": { + "type": { + "$ref": "#/17" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "IotSiteWise", + "properties": { + "AssetId": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "The ID of the asset that has the specified property. You can specify an expression." + }, + "EntryId": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "A unique identifier for this entry. You can use the entry ID to track which data entry causes an error in case of failure. The default is a new unique identifier. You can also specify an expression." + }, + "PropertyAlias": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "The alias of the asset property. You can also specify an expression." + }, + "PropertyId": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "The ID of the asset property. You can specify an expression." + }, + "PropertyValue": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "IotTopicPublish", + "properties": { + "MqttTopic": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "The MQTT topic of the message. You can use a string expression that includes variables (`$variable.`) and input values (`$input..`) as the topic string." + }, + "Payload": { + "type": { + "$ref": "#/17" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Lambda", + "properties": { + "FunctionArn": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "The ARN of the Lambda function that is executed." + }, + "Payload": { + "type": { + "$ref": "#/17" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Payload", + "properties": { + "ContentExpression": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "The content of the payload. You can use a string expression that includes quoted strings (`''`), variables (`$variable.`), input values (`$input..`), string concatenations, and quoted strings that contain `${}` as the content. The recommended maximum size of a content expression is 1 KB." + }, + "Type": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "The value of the payload type can be either `STRING` or `JSON`." + } + } + }, + { + "$type": "ObjectType", + "name": "SimpleRule", + "properties": { + "ComparisonOperator": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "The comparison operator." + }, + "InputProperty": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "The value on the left side of the comparison operator. You can specify an AWS IoT Events input attribute as an input property." + }, + "Threshold": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "The value on the right side of the comparison operator. You can enter a number or specify an AWS IoT Events input attribute." + } + } + }, + { + "$type": "ObjectType", + "name": "Sns", + "properties": { + "Payload": { + "type": { + "$ref": "#/17" + }, + "flags": 0 + }, + "TargetArn": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "The ARN of the Amazon SNS target where the message is sent." + } + } + }, + { + "$type": "ObjectType", + "name": "Sqs", + "properties": { + "Payload": { + "type": { + "$ref": "#/17" + }, + "flags": 0 + }, + "QueueUrl": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "The URL of the SQS queue where the data is written." + }, + "UseBase64": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "Set this to `TRUE` if you want the data to be base-64 encoded before it is written to the queue. Otherwise, set this to `FALSE`." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "Key of the Tag." + }, + "Value": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "Value of the Tag." + } + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.IoTEvents/AlarmModelProperties" + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/21" + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoTEvents/AlarmModelProperties", + "properties": { + "AlarmCapabilities": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "AlarmEventActions": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "AlarmModelDescription": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "A brief description of the alarm model." + }, + "AlarmModelName": { + "type": { + "$ref": "#/25" + }, + "flags": 16, + "description": "The name of the alarm model." + }, + "AlarmRule": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Key": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "The value used to identify a alarm instance. When a device or system sends input, a new alarm instance with a unique key value is created. AWS IoT Events can continue to route input to its corresponding alarm instance based on this identifying information.\n\nThis parameter uses a JSON-path expression to select the attribute-value pair in the message payload that is used for identification. To route the message to the correct alarm instance, the device must send a message payload that contains the same attribute-value." + }, + "RoleArn": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "The ARN of the role that grants permission to AWS IoT Events to perform its operations." + }, + "Severity": { + "type": { + "$ref": "#/27" + }, + "flags": 0, + "description": "A non-negative integer that reflects the severity level of the alarm.\n\n" + }, + "Tags": { + "type": { + "$ref": "#/28" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource.\n\nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoTEvents/AlarmModel", + "properties": { + "name": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/25" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/29" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IoTEvents/AlarmModel@default", + "scopeType": 0, + "body": { + "$ref": "#/30" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Action", + "properties": { + "ClearTimer": { + "type": { + "$ref": "#/36" + }, + "flags": 0 + }, + "DynamoDB": { + "type": { + "$ref": "#/38" + }, + "flags": 0 + }, + "DynamoDBv2": { + "type": { + "$ref": "#/39" + }, + "flags": 0 + }, + "Firehose": { + "type": { + "$ref": "#/41" + }, + "flags": 0 + }, + "IotEvents": { + "type": { + "$ref": "#/42" + }, + "flags": 0 + }, + "IotSiteWise": { + "type": { + "$ref": "#/43" + }, + "flags": 0 + }, + "IotTopicPublish": { + "type": { + "$ref": "#/44" + }, + "flags": 0 + }, + "Lambda": { + "type": { + "$ref": "#/45" + }, + "flags": 0 + }, + "ResetTimer": { + "type": { + "$ref": "#/50" + }, + "flags": 0 + }, + "SetTimer": { + "type": { + "$ref": "#/51" + }, + "flags": 0 + }, + "SetVariable": { + "type": { + "$ref": "#/52" + }, + "flags": 0 + }, + "Sns": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "Sqs": { + "type": { + "$ref": "#/54" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AssetPropertyTimestamp", + "properties": { + "OffsetInNanos": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "The timestamp, in seconds, in the Unix epoch format. The valid range is between `1-31556889864403199`. You can also specify an expression." + }, + "TimeInSeconds": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "The nanosecond offset converted from `timeInSeconds`. The valid range is between `0-999999999`. You can also specify an expression." + } + } + }, + { + "$type": "ObjectType", + "name": "AssetPropertyValue", + "properties": { + "Quality": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "The quality of the asset property value. The value must be `GOOD`, `BAD`, or `UNCERTAIN`. You can also specify an expression." + }, + "Timestamp": { + "type": { + "$ref": "#/33" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/35" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AssetPropertyVariant", + "properties": { + "BooleanValue": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "The asset property value is a Boolean value that must be `TRUE` or `FALSE`. You can also specify an expression. If you use an expression, the evaluated result should be a Boolean value." + }, + "DoubleValue": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "The asset property value is a double. You can also specify an expression. If you use an expression, the evaluated result should be a double." + }, + "IntegerValue": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "The asset property value is an integer. You can also specify an expression. If you use an expression, the evaluated result should be an integer." + }, + "StringValue": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "The asset property value is a string. You can also specify an expression. If you use an expression, the evaluated result should be a string." + } + } + }, + { + "$type": "ObjectType", + "name": "ClearTimer", + "properties": { + "TimerName": { + "type": { + "$ref": "#/25" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DetectorModelDefinition", + "properties": { + "InitialStateName": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "The state that is entered at the creation of each detector (instance)." + }, + "States": { + "type": { + "$ref": "#/58" + }, + "flags": 1, + "description": "Information about the states of the detector." + } + } + }, + { + "$type": "ObjectType", + "name": "DynamoDB", + "properties": { + "HashKeyField": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "The name of the hash key (also called the partition key)." + }, + "HashKeyType": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "The data type for the hash key (also called the partition key). You can specify the following values:\n\n* `STRING` - The hash key is a string.\n\n* `NUMBER` - The hash key is a number.\n\nIf you don't specify `hashKeyType`, the default value is `STRING`." + }, + "HashKeyValue": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "The value of the hash key (also called the partition key)." + }, + "Operation": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "The type of operation to perform. You can specify the following values:\n\n* `INSERT` - Insert data as a new item into the DynamoDB table. This item uses the specified hash key as a partition key. If you specified a range key, the item uses the range key as a sort key.\n\n* `UPDATE` - Update an existing item of the DynamoDB table with new data. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.\n\n* `DELETE` - Delete an existing item of the DynamoDB table. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.\n\nIf you don't specify this parameter, AWS IoT Events triggers the `INSERT` operation." + }, + "Payload": { + "type": { + "$ref": "#/49" + }, + "flags": 0 + }, + "PayloadField": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "The name of the DynamoDB column that receives the action payload.\n\nIf you don't specify this parameter, the name of the DynamoDB column is `payload`." + }, + "RangeKeyField": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "The name of the range key (also called the sort key)." + }, + "RangeKeyType": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "The data type for the range key (also called the sort key), You can specify the following values:\n\n* `STRING` - The range key is a string.\n\n* `NUMBER` - The range key is number.\n\nIf you don't specify `rangeKeyField`, the default value is `STRING`." + }, + "RangeKeyValue": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "The value of the range key (also called the sort key)." + }, + "TableName": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "The name of the DynamoDB table." + } + } + }, + { + "$type": "ObjectType", + "name": "DynamoDBv2", + "properties": { + "Payload": { + "type": { + "$ref": "#/49" + }, + "flags": 0 + }, + "TableName": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "The name of the DynamoDB table." + } + } + }, + { + "$type": "ObjectType", + "name": "Event", + "properties": { + "Actions": { + "type": { + "$ref": "#/59" + }, + "flags": 0, + "description": "The actions to be performed." + }, + "Condition": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "The Boolean expression that, when `TRUE`, causes the `actions` to be performed. If not present, the `actions` are performed (=`TRUE`). If the expression result is not a `Boolean` value, the `actions` are not performed (=`FALSE`)." + }, + "EventName": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "The name of the event." + } + } + }, + { + "$type": "ObjectType", + "name": "Firehose", + "properties": { + "DeliveryStreamName": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "The name of the Kinesis Data Firehose delivery stream where the data is written." + }, + "Payload": { + "type": { + "$ref": "#/49" + }, + "flags": 0 + }, + "Separator": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream. Valid values are: '\\n' (newline), '\\t' (tab), '\\r\\n' (Windows newline), ',' (comma)." + } + } + }, + { + "$type": "ObjectType", + "name": "IotEvents", + "properties": { + "InputName": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "The name of the AWS IoT Events input where the data is sent." + }, + "Payload": { + "type": { + "$ref": "#/49" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "IotSiteWise", + "properties": { + "AssetId": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "The ID of the asset that has the specified property. You can specify an expression." + }, + "EntryId": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "A unique identifier for this entry. You can use the entry ID to track which data entry causes an error in case of failure. The default is a new unique identifier. You can also specify an expression." + }, + "PropertyAlias": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "The alias of the asset property. You can also specify an expression." + }, + "PropertyId": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "The ID of the asset property. You can specify an expression." + }, + "PropertyValue": { + "type": { + "$ref": "#/34" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "IotTopicPublish", + "properties": { + "MqttTopic": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "The MQTT topic of the message. You can use a string expression that includes variables (`$variable.`) and input values (`$input..`) as the topic string." + }, + "Payload": { + "type": { + "$ref": "#/49" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Lambda", + "properties": { + "FunctionArn": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "The ARN of the Lambda function that is executed." + }, + "Payload": { + "type": { + "$ref": "#/49" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "OnEnter", + "properties": { + "Events": { + "type": { + "$ref": "#/60" + }, + "flags": 0, + "description": "Specifies the `actions` that are performed when the state is entered and the `condition` is `TRUE`." + } + } + }, + { + "$type": "ObjectType", + "name": "OnExit", + "properties": { + "Events": { + "type": { + "$ref": "#/61" + }, + "flags": 0, + "description": "Specifies the `actions` that are performed when the state is exited and the `condition` is `TRUE`." + } + } + }, + { + "$type": "ObjectType", + "name": "OnInput", + "properties": { + "Events": { + "type": { + "$ref": "#/62" + }, + "flags": 0, + "description": "Specifies the `actions` performed when the `condition` evaluates to `TRUE`." + }, + "TransitionEvents": { + "type": { + "$ref": "#/63" + }, + "flags": 0, + "description": "Specifies the `actions` performed, and the next `state` entered, when a `condition` evaluates to `TRUE`." + } + } + }, + { + "$type": "ObjectType", + "name": "Payload", + "properties": { + "ContentExpression": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "The content of the payload. You can use a string expression that includes quoted strings (`''`), variables (`$variable.`), input values (`$input..`), string concatenations, and quoted strings that contain `${}` as the content. The recommended maximum size of a content expression is 1 KB." + }, + "Type": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "The value of the payload type can be either `STRING` or `JSON`." + } + } + }, + { + "$type": "ObjectType", + "name": "ResetTimer", + "properties": { + "TimerName": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "The name of the timer to reset." + } + } + }, + { + "$type": "ObjectType", + "name": "SetTimer", + "properties": { + "DurationExpression": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "The duration of the timer, in seconds. You can use a string expression that includes numbers, variables (`$variable.`), and input values (`$input..`) as the duration. The range of the duration is `1-31622400` seconds. To ensure accuracy, the minimum duration is `60` seconds. The evaluated result of the duration is rounded down to the nearest whole number." + }, + "Seconds": { + "type": { + "$ref": "#/27" + }, + "flags": 0, + "description": "The number of seconds until the timer expires. The minimum value is `60` seconds to ensure accuracy. The maximum value is `31622400` seconds." + }, + "TimerName": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "The name of the timer." + } + } + }, + { + "$type": "ObjectType", + "name": "SetVariable", + "properties": { + "Value": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "The new value of the variable." + }, + "VariableName": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "The name of the variable." + } + } + }, + { + "$type": "ObjectType", + "name": "Sns", + "properties": { + "Payload": { + "type": { + "$ref": "#/49" + }, + "flags": 0 + }, + "TargetArn": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "The ARN of the Amazon SNS target where the message is sent." + } + } + }, + { + "$type": "ObjectType", + "name": "Sqs", + "properties": { + "Payload": { + "type": { + "$ref": "#/49" + }, + "flags": 0 + }, + "QueueUrl": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "The URL of the SQS queue where the data is written." + }, + "UseBase64": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "Set this to `TRUE` if you want the data to be base-64 encoded before it is written to the queue. Otherwise, set this to `FALSE`." + } + } + }, + { + "$type": "ObjectType", + "name": "State", + "properties": { + "OnEnter": { + "type": { + "$ref": "#/46" + }, + "flags": 0 + }, + "OnExit": { + "type": { + "$ref": "#/47" + }, + "flags": 0 + }, + "OnInput": { + "type": { + "$ref": "#/48" + }, + "flags": 0 + }, + "StateName": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "The name of the state." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "Key of the Tag." + }, + "Value": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "Value of the Tag." + } + } + }, + { + "$type": "ObjectType", + "name": "TransitionEvent", + "properties": { + "Actions": { + "type": { + "$ref": "#/64" + }, + "flags": 0, + "description": "The actions to be performed." + }, + "Condition": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "A Boolean expression that when `TRUE` causes the `actions` to be performed and the `nextState` to be entered." + }, + "EventName": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "The name of the event." + }, + "NextState": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "The next state to enter." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/55" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/32" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/40" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/40" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/40" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/57" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/32" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.IoTEvents/DetectorModelProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/56" + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoTEvents/DetectorModelProperties", + "properties": { + "DetectorModelDefinition": { + "type": { + "$ref": "#/37" + }, + "flags": 1 + }, + "DetectorModelDescription": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "A brief description of the detector model." + }, + "DetectorModelName": { + "type": { + "$ref": "#/25" + }, + "flags": 16, + "description": "The name of the detector model." + }, + "EvaluationMethod": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "Information about the order in which events are evaluated and how actions are executed." + }, + "Key": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "The value used to identify a detector instance. When a device or system sends input, a new detector instance with a unique key value is created. AWS IoT Events can continue to route input to its corresponding detector instance based on this identifying information.\n\nThis parameter uses a JSON-path expression to select the attribute-value pair in the message payload that is used for identification. To route the message to the correct detector instance, the device must send a message payload that contains the same attribute-value." + }, + "RoleArn": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "The ARN of the role that grants permission to AWS IoT Events to perform its operations." + }, + "Tags": { + "type": { + "$ref": "#/66" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource.\n\nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoTEvents/DetectorModel", + "properties": { + "name": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/25" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/67" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IoTEvents/DetectorModel@default", + "scopeType": 0, + "body": { + "$ref": "#/68" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Attribute", + "properties": { + "JsonPath": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "An expression that specifies an attribute-value pair in a JSON structure. Use this to specify an attribute from the JSON payload that is made available by the input. Inputs are derived from messages sent to AWS IoT Events (`BatchPutMessage`). Each such message contains a JSON payload. The attribute (and its paired value) specified here are available for use in the `condition` expressions used by detectors.\n\n_Syntax_: `....`" + } + } + }, + { + "$type": "ObjectType", + "name": "InputDefinition", + "properties": { + "Attributes": { + "type": { + "$ref": "#/73" + }, + "flags": 1, + "description": "The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent to the AWS IoT Events system using `BatchPutMessage`. Each such message contains a JSON payload, and those attributes (and their paired values) specified here are available for use in the `condition` expressions used by detectors that monitor this input." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "Key of the Tag." + }, + "Value": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "Value of the Tag." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/70" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.IoTEvents/InputProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/72" + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoTEvents/InputProperties", + "properties": { + "InputDefinition": { + "type": { + "$ref": "#/71" + }, + "flags": 1 + }, + "InputDescription": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "A brief description of the input." + }, + "InputName": { + "type": { + "$ref": "#/25" + }, + "flags": 16, + "description": "The name of the input." + }, + "Tags": { + "type": { + "$ref": "#/75" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource.\n\nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoTEvents/Input", + "properties": { + "name": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/25" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/76" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IoTEvents/Input@default", + "scopeType": 0, + "body": { + "$ref": "#/77" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.iotevents/default/types.md b/artifacts/bicep/aws/aws.iotevents/default/types.md index 5be67fc4..efd5db8f 100644 --- a/artifacts/bicep/aws/aws.iotevents/default/types.md +++ b/artifacts/bicep/aws/aws.iotevents/default/types.md @@ -3,58 +3,43 @@ ## Resource AWS.IoTEvents/AlarmModel@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IoTEvents/AlarmModelProperties](#awsioteventsalarmmodelproperties) (Required): properties of the resource +* **properties**: [AWS.IoTEvents/AlarmModelProperties](#awsioteventsalarmmodelproperties) (Required, Identifier): properties of the resource ## Resource AWS.IoTEvents/DetectorModel@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IoTEvents/DetectorModelProperties](#awsioteventsdetectormodelproperties) (Required): properties of the resource +* **properties**: [AWS.IoTEvents/DetectorModelProperties](#awsioteventsdetectormodelproperties) (Required, Identifier): properties of the resource ## Resource AWS.IoTEvents/Input@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IoTEvents/InputProperties](#awsioteventsinputproperties) (Required): properties of the resource - -## AWS.IoTEvents/AlarmModelProperties -### Properties -* **AlarmCapabilities**: [AlarmCapabilities](#alarmcapabilities) -* **AlarmEventActions**: [AlarmEventActions](#alarmeventactions) -* **AlarmModelDescription**: string: A brief description of the alarm model. -* **AlarmModelName**: string (Identifier): The name of the alarm model. -* **AlarmRule**: [AlarmRule](#alarmrule) (Required) -* **Key**: string: The value used to identify a alarm instance. When a device or system sends input, a new alarm instance with a unique key value is created. AWS IoT Events can continue to route input to its corresponding alarm instance based on this identifying information. - -This parameter uses a JSON-path expression to select the attribute-value pair in the message payload that is used for identification. To route the message to the correct alarm instance, the device must send a message payload that contains the same attribute-value. -* **RoleArn**: string (Required): The ARN of the role that grants permission to AWS IoT Events to perform its operations. -* **Severity**: int: A non-negative integer that reflects the severity level of the alarm. - - -* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. - -For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html). - -## AlarmCapabilities -### Properties -* **AcknowledgeFlow**: [AcknowledgeFlow](#acknowledgeflow) -* **InitializationConfiguration**: [InitializationConfiguration](#initializationconfiguration) +* **properties**: [AWS.IoTEvents/InputProperties](#awsioteventsinputproperties) (Required, Identifier): properties of the resource ## AcknowledgeFlow ### Properties * **Enabled**: bool: The value must be TRUE or FALSE. If TRUE, you receive a notification when the alarm state changes. You must choose to acknowledge the notification before the alarm state can return to NORMAL. If FALSE, you won't receive notifications. The alarm automatically changes to the NORMAL state when the input property value returns to the specified range. -## InitializationConfiguration -### Properties -* **DisabledOnInitialization**: bool (Required): The value must be TRUE or FALSE. If FALSE, all alarm instances created based on the alarm model are activated. The default value is TRUE. - -## AlarmEventActions +## Action ### Properties -* **AlarmActions**: [AlarmAction](#alarmaction)[] +* **ClearTimer**: [ClearTimer](#cleartimer) +* **DynamoDB**: [DynamoDB](#dynamodb) +* **DynamoDBv2**: [DynamoDBv2](#dynamodbv2) +* **Firehose**: [Firehose](#firehose) +* **IotEvents**: [IotEvents](#iotevents) +* **IotSiteWise**: [IotSiteWise](#iotsitewise) +* **IotTopicPublish**: [IotTopicPublish](#iottopicpublish) +* **Lambda**: [Lambda](#lambda) +* **ResetTimer**: [ResetTimer](#resettimer) +* **SetTimer**: [SetTimer](#settimer) +* **SetVariable**: [SetVariable](#setvariable) +* **Sns**: [Sns](#sns) +* **Sqs**: [Sqs](#sqs) ## AlarmAction ### Properties @@ -68,69 +53,34 @@ For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/la * **Sns**: [Sns](#sns) * **Sqs**: [Sqs](#sqs) -## DynamoDB +## AlarmCapabilities ### Properties -* **HashKeyField**: string (Required): The name of the hash key (also called the partition key). -* **HashKeyType**: string: The data type for the hash key (also called the partition key). You can specify the following values: - -* `STRING` - The hash key is a string. - -* `NUMBER` - The hash key is a number. - -If you don't specify `hashKeyType`, the default value is `STRING`. -* **HashKeyValue**: string (Required): The value of the hash key (also called the partition key). -* **Operation**: string: The type of operation to perform. You can specify the following values: - -* `INSERT` - Insert data as a new item into the DynamoDB table. This item uses the specified hash key as a partition key. If you specified a range key, the item uses the range key as a sort key. - -* `UPDATE` - Update an existing item of the DynamoDB table with new data. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key. - -* `DELETE` - Delete an existing item of the DynamoDB table. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key. - -If you don't specify this parameter, AWS IoT Events triggers the `INSERT` operation. -* **Payload**: [Payload](#payload) -* **PayloadField**: string: The name of the DynamoDB column that receives the action payload. - -If you don't specify this parameter, the name of the DynamoDB column is `payload`. -* **RangeKeyField**: string: The name of the range key (also called the sort key). -* **RangeKeyType**: string: The data type for the range key (also called the sort key), You can specify the following values: - -* `STRING` - The range key is a string. - -* `NUMBER` - The range key is number. - -If you don't specify `rangeKeyField`, the default value is `STRING`. -* **RangeKeyValue**: string: The value of the range key (also called the sort key). -* **TableName**: string (Required): The name of the DynamoDB table. +* **AcknowledgeFlow**: [AcknowledgeFlow](#acknowledgeflow) +* **InitializationConfiguration**: [InitializationConfiguration](#initializationconfiguration) -## Payload +## AlarmEventActions ### Properties -* **ContentExpression**: string (Required): The content of the payload. You can use a string expression that includes quoted strings (`''`), variables (`$variable.`), input values (`$input..`), string concatenations, and quoted strings that contain `${}` as the content. The recommended maximum size of a content expression is 1 KB. -* **Type**: string (Required): The value of the payload type can be either `STRING` or `JSON`. +* **AlarmActions**: [AlarmAction](#alarmaction)[] -## DynamoDBv2 +## AlarmRule ### Properties -* **Payload**: [Payload](#payload) -* **TableName**: string (Required): The name of the DynamoDB table. +* **SimpleRule**: [SimpleRule](#simplerule) -## Firehose +## AssetPropertyTimestamp ### Properties -* **DeliveryStreamName**: string (Required): The name of the Kinesis Data Firehose delivery stream where the data is written. -* **Payload**: [Payload](#payload) -* **Separator**: string: A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma). +* **OffsetInNanos**: string: The timestamp, in seconds, in the Unix epoch format. The valid range is between `1-31556889864403199`. You can also specify an expression. +* **TimeInSeconds**: string (Required): The nanosecond offset converted from `timeInSeconds`. The valid range is between `0-999999999`. You can also specify an expression. -## IotEvents +## AssetPropertyTimestamp ### Properties -* **InputName**: string (Required): The name of the AWS IoT Events input where the data is sent. -* **Payload**: [Payload](#payload) +* **OffsetInNanos**: string: The timestamp, in seconds, in the Unix epoch format. The valid range is between `1-31556889864403199`. You can also specify an expression. +* **TimeInSeconds**: string (Required): The nanosecond offset converted from `timeInSeconds`. The valid range is between `0-999999999`. You can also specify an expression. -## IotSiteWise +## AssetPropertyValue ### Properties -* **AssetId**: string: The ID of the asset that has the specified property. You can specify an expression. -* **EntryId**: string: A unique identifier for this entry. You can use the entry ID to track which data entry causes an error in case of failure. The default is a new unique identifier. You can also specify an expression. -* **PropertyAlias**: string: The alias of the asset property. You can also specify an expression. -* **PropertyId**: string: The ID of the asset property. You can specify an expression. -* **PropertyValue**: [AssetPropertyValue](#assetpropertyvalue) +* **Quality**: string: The quality of the asset property value. The value must be `GOOD`, `BAD`, or `UNCERTAIN`. You can also specify an expression. +* **Timestamp**: [AssetPropertyTimestamp](#assetpropertytimestamp) +* **Value**: [AssetPropertyVariant](#assetpropertyvariant) (Required) ## AssetPropertyValue ### Properties @@ -138,10 +88,12 @@ If you don't specify `rangeKeyField`, the default value is `STRING`. * **Timestamp**: [AssetPropertyTimestamp](#assetpropertytimestamp) * **Value**: [AssetPropertyVariant](#assetpropertyvariant) (Required) -## AssetPropertyTimestamp +## AssetPropertyVariant ### Properties -* **OffsetInNanos**: string: The timestamp, in seconds, in the Unix epoch format. The valid range is between `1-31556889864403199`. You can also specify an expression. -* **TimeInSeconds**: string (Required): The nanosecond offset converted from `timeInSeconds`. The valid range is between `0-999999999`. You can also specify an expression. +* **BooleanValue**: string: The asset property value is a Boolean value that must be `TRUE` or `FALSE`. You can also specify an expression. If you use an expression, the evaluated result should be a Boolean value. +* **DoubleValue**: string: The asset property value is a double. You can also specify an expression. If you use an expression, the evaluated result should be a double. +* **IntegerValue**: string: The asset property value is an integer. You can also specify an expression. If you use an expression, the evaluated result should be an integer. +* **StringValue**: string: The asset property value is a string. You can also specify an expression. If you use an expression, the evaluated result should be a string. ## AssetPropertyVariant ### Properties @@ -150,41 +102,29 @@ If you don't specify `rangeKeyField`, the default value is `STRING`. * **IntegerValue**: string: The asset property value is an integer. You can also specify an expression. If you use an expression, the evaluated result should be an integer. * **StringValue**: string: The asset property value is a string. You can also specify an expression. If you use an expression, the evaluated result should be a string. -## IotTopicPublish +## Attribute ### Properties -* **MqttTopic**: string (Required): The MQTT topic of the message. You can use a string expression that includes variables (`$variable.`) and input values (`$input..`) as the topic string. -* **Payload**: [Payload](#payload) +* **JsonPath**: string (Required): An expression that specifies an attribute-value pair in a JSON structure. Use this to specify an attribute from the JSON payload that is made available by the input. Inputs are derived from messages sent to AWS IoT Events (`BatchPutMessage`). Each such message contains a JSON payload. The attribute (and its paired value) specified here are available for use in the `condition` expressions used by detectors. -## Lambda -### Properties -* **FunctionArn**: string (Required): The ARN of the Lambda function that is executed. -* **Payload**: [Payload](#payload) +_Syntax_: `....` -## Sns +## AWS.IoTEvents/AlarmModelProperties ### Properties -* **Payload**: [Payload](#payload) -* **TargetArn**: string (Required): The ARN of the Amazon SNS target where the message is sent. +* **AlarmCapabilities**: [AlarmCapabilities](#alarmcapabilities) +* **AlarmEventActions**: [AlarmEventActions](#alarmeventactions) +* **AlarmModelDescription**: string: A brief description of the alarm model. +* **AlarmModelName**: string (Identifier): The name of the alarm model. +* **AlarmRule**: [AlarmRule](#alarmrule) (Required) +* **Key**: string: The value used to identify a alarm instance. When a device or system sends input, a new alarm instance with a unique key value is created. AWS IoT Events can continue to route input to its corresponding alarm instance based on this identifying information. -## Sqs -### Properties -* **Payload**: [Payload](#payload) -* **QueueUrl**: string (Required): The URL of the SQS queue where the data is written. -* **UseBase64**: bool: Set this to `TRUE` if you want the data to be base-64 encoded before it is written to the queue. Otherwise, set this to `FALSE`. +This parameter uses a JSON-path expression to select the attribute-value pair in the message payload that is used for identification. To route the message to the correct alarm instance, the device must send a message payload that contains the same attribute-value. +* **RoleArn**: string (Required): The ARN of the role that grants permission to AWS IoT Events to perform its operations. +* **Severity**: int: A non-negative integer that reflects the severity level of the alarm. -## AlarmRule -### Properties -* **SimpleRule**: [SimpleRule](#simplerule) -## SimpleRule -### Properties -* **ComparisonOperator**: string (Required): The comparison operator. -* **InputProperty**: string (Required): The value on the left side of the comparison operator. You can specify an AWS IoT Events input attribute as an input property. -* **Threshold**: string (Required): The value on the right side of the comparison operator. You can enter a number or specify an AWS IoT Events input attribute. +* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. -## Tag -### Properties -* **Key**: string (Required): Key of the Tag. -* **Value**: string (Required): Value of the Tag. +For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html). ## AWS.IoTEvents/DetectorModelProperties ### Properties @@ -200,47 +140,58 @@ This parameter uses a JSON-path expression to select the attribute-value pair in For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html). +## AWS.IoTEvents/InputProperties +### Properties +* **InputDefinition**: [InputDefinition](#inputdefinition) (Required) +* **InputDescription**: string: A brief description of the input. +* **InputName**: string (Identifier): The name of the input. +* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. + +For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html). + +## ClearTimer +### Properties +* **TimerName**: string (Required) + ## DetectorModelDefinition ### Properties * **InitialStateName**: string (Required): The state that is entered at the creation of each detector (instance). * **States**: [State](#state)[] (Required): Information about the states of the detector. -## State +## DynamoDB ### Properties -* **OnEnter**: [OnEnter](#onenter) -* **OnExit**: [OnExit](#onexit) -* **OnInput**: [OnInput](#oninput) -* **StateName**: string (Required): The name of the state. +* **HashKeyField**: string (Required): The name of the hash key (also called the partition key). +* **HashKeyType**: string: The data type for the hash key (also called the partition key). You can specify the following values: -## OnEnter -### Properties -* **Events**: [Event](#event)[]: Specifies the `actions` that are performed when the state is entered and the `condition` is `TRUE`. +* `STRING` - The hash key is a string. -## Event -### Properties -* **Actions**: [Action](#action)[]: The actions to be performed. -* **Condition**: string: The Boolean expression that, when `TRUE`, causes the `actions` to be performed. If not present, the `actions` are performed (=`TRUE`). If the expression result is not a `Boolean` value, the `actions` are not performed (=`FALSE`). -* **EventName**: string (Required): The name of the event. +* `NUMBER` - The hash key is a number. -## Action -### Properties -* **ClearTimer**: [ClearTimer](#cleartimer) -* **DynamoDB**: [DynamoDB](#dynamodb) -* **DynamoDBv2**: [DynamoDBv2](#dynamodbv2) -* **Firehose**: [Firehose](#firehose) -* **IotEvents**: [IotEvents](#iotevents) -* **IotSiteWise**: [IotSiteWise](#iotsitewise) -* **IotTopicPublish**: [IotTopicPublish](#iottopicpublish) -* **Lambda**: [Lambda](#lambda) -* **ResetTimer**: [ResetTimer](#resettimer) -* **SetTimer**: [SetTimer](#settimer) -* **SetVariable**: [SetVariable](#setvariable) -* **Sns**: [Sns](#sns) -* **Sqs**: [Sqs](#sqs) +If you don't specify `hashKeyType`, the default value is `STRING`. +* **HashKeyValue**: string (Required): The value of the hash key (also called the partition key). +* **Operation**: string: The type of operation to perform. You can specify the following values: -## ClearTimer -### Properties -* **TimerName**: string (Required) +* `INSERT` - Insert data as a new item into the DynamoDB table. This item uses the specified hash key as a partition key. If you specified a range key, the item uses the range key as a sort key. + +* `UPDATE` - Update an existing item of the DynamoDB table with new data. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key. + +* `DELETE` - Delete an existing item of the DynamoDB table. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key. + +If you don't specify this parameter, AWS IoT Events triggers the `INSERT` operation. +* **Payload**: [Payload](#payload) +* **PayloadField**: string: The name of the DynamoDB column that receives the action payload. + +If you don't specify this parameter, the name of the DynamoDB column is `payload`. +* **RangeKeyField**: string: The name of the range key (also called the sort key). +* **RangeKeyType**: string: The data type for the range key (also called the sort key), You can specify the following values: + +* `STRING` - The range key is a string. + +* `NUMBER` - The range key is number. + +If you don't specify `rangeKeyField`, the default value is `STRING`. +* **RangeKeyValue**: string: The value of the range key (also called the sort key). +* **TableName**: string (Required): The name of the DynamoDB table. ## DynamoDB ### Properties @@ -277,22 +228,47 @@ If you don't specify `rangeKeyField`, the default value is `STRING`. * **RangeKeyValue**: string: The value of the range key (also called the sort key). * **TableName**: string (Required): The name of the DynamoDB table. -## Payload +## DynamoDBv2 ### Properties -* **ContentExpression**: string (Required): The content of the payload. You can use a string expression that includes quoted strings (`''`), variables (`$variable.`), input values (`$input..`), string concatenations, and quoted strings that contain `${}` as the content. The recommended maximum size of a content expression is 1 KB. -* **Type**: string (Required): The value of the payload type can be either `STRING` or `JSON`. +* **Payload**: [Payload](#payload) +* **TableName**: string (Required): The name of the DynamoDB table. ## DynamoDBv2 ### Properties * **Payload**: [Payload](#payload) * **TableName**: string (Required): The name of the DynamoDB table. +## Event +### Properties +* **Actions**: [Action](#action)[]: The actions to be performed. +* **Condition**: string: The Boolean expression that, when `TRUE`, causes the `actions` to be performed. If not present, the `actions` are performed (=`TRUE`). If the expression result is not a `Boolean` value, the `actions` are not performed (=`FALSE`). +* **EventName**: string (Required): The name of the event. + +## Firehose +### Properties +* **DeliveryStreamName**: string (Required): The name of the Kinesis Data Firehose delivery stream where the data is written. +* **Payload**: [Payload](#payload) +* **Separator**: string: A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma). + ## Firehose ### Properties * **DeliveryStreamName**: string (Required): The name of the Kinesis Data Firehose delivery stream where the data is written. * **Payload**: [Payload](#payload) * **Separator**: string: A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma). +## InitializationConfiguration +### Properties +* **DisabledOnInitialization**: bool (Required): The value must be TRUE or FALSE. If FALSE, all alarm instances created based on the alarm model are activated. The default value is TRUE. + +## InputDefinition +### Properties +* **Attributes**: [Attribute](#attribute)[] (Required): The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent to the AWS IoT Events system using `BatchPutMessage`. Each such message contains a JSON payload, and those attributes (and their paired values) specified here are available for use in the `condition` expressions used by detectors that monitor this input. + +## IotEvents +### Properties +* **InputName**: string (Required): The name of the AWS IoT Events input where the data is sent. +* **Payload**: [Payload](#payload) + ## IotEvents ### Properties * **InputName**: string (Required): The name of the AWS IoT Events input where the data is sent. @@ -304,25 +280,20 @@ If you don't specify `rangeKeyField`, the default value is `STRING`. * **EntryId**: string: A unique identifier for this entry. You can use the entry ID to track which data entry causes an error in case of failure. The default is a new unique identifier. You can also specify an expression. * **PropertyAlias**: string: The alias of the asset property. You can also specify an expression. * **PropertyId**: string: The ID of the asset property. You can specify an expression. -* **PropertyValue**: [AssetPropertyValue](#assetpropertyvalue) (Required) - -## AssetPropertyValue -### Properties -* **Quality**: string: The quality of the asset property value. The value must be `GOOD`, `BAD`, or `UNCERTAIN`. You can also specify an expression. -* **Timestamp**: [AssetPropertyTimestamp](#assetpropertytimestamp) -* **Value**: [AssetPropertyVariant](#assetpropertyvariant) (Required) +* **PropertyValue**: [AssetPropertyValue](#assetpropertyvalue) -## AssetPropertyTimestamp +## IotSiteWise ### Properties -* **OffsetInNanos**: string: The timestamp, in seconds, in the Unix epoch format. The valid range is between `1-31556889864403199`. You can also specify an expression. -* **TimeInSeconds**: string (Required): The nanosecond offset converted from `timeInSeconds`. The valid range is between `0-999999999`. You can also specify an expression. +* **AssetId**: string: The ID of the asset that has the specified property. You can specify an expression. +* **EntryId**: string: A unique identifier for this entry. You can use the entry ID to track which data entry causes an error in case of failure. The default is a new unique identifier. You can also specify an expression. +* **PropertyAlias**: string: The alias of the asset property. You can also specify an expression. +* **PropertyId**: string: The ID of the asset property. You can specify an expression. +* **PropertyValue**: [AssetPropertyValue](#assetpropertyvalue) (Required) -## AssetPropertyVariant +## IotTopicPublish ### Properties -* **BooleanValue**: string: The asset property value is a Boolean value that must be `TRUE` or `FALSE`. You can also specify an expression. If you use an expression, the evaluated result should be a Boolean value. -* **DoubleValue**: string: The asset property value is a double. You can also specify an expression. If you use an expression, the evaluated result should be a double. -* **IntegerValue**: string: The asset property value is an integer. You can also specify an expression. If you use an expression, the evaluated result should be an integer. -* **StringValue**: string: The asset property value is a string. You can also specify an expression. If you use an expression, the evaluated result should be a string. +* **MqttTopic**: string (Required): The MQTT topic of the message. You can use a string expression that includes variables (`$variable.`) and input values (`$input..`) as the topic string. +* **Payload**: [Payload](#payload) ## IotTopicPublish ### Properties @@ -334,6 +305,34 @@ If you don't specify `rangeKeyField`, the default value is `STRING`. * **FunctionArn**: string (Required): The ARN of the Lambda function that is executed. * **Payload**: [Payload](#payload) +## Lambda +### Properties +* **FunctionArn**: string (Required): The ARN of the Lambda function that is executed. +* **Payload**: [Payload](#payload) + +## OnEnter +### Properties +* **Events**: [Event](#event)[]: Specifies the `actions` that are performed when the state is entered and the `condition` is `TRUE`. + +## OnExit +### Properties +* **Events**: [Event](#event)[]: Specifies the `actions` that are performed when the state is exited and the `condition` is `TRUE`. + +## OnInput +### Properties +* **Events**: [Event](#event)[]: Specifies the `actions` performed when the `condition` evaluates to `TRUE`. +* **TransitionEvents**: [TransitionEvent](#transitionevent)[]: Specifies the `actions` performed, and the next `state` entered, when a `condition` evaluates to `TRUE`. + +## Payload +### Properties +* **ContentExpression**: string (Required): The content of the payload. You can use a string expression that includes quoted strings (`''`), variables (`$variable.`), input values (`$input..`), string concatenations, and quoted strings that contain `${}` as the content. The recommended maximum size of a content expression is 1 KB. +* **Type**: string (Required): The value of the payload type can be either `STRING` or `JSON`. + +## Payload +### Properties +* **ContentExpression**: string (Required): The content of the payload. You can use a string expression that includes quoted strings (`''`), variables (`$variable.`), input values (`$input..`), string concatenations, and quoted strings that contain `${}` as the content. The recommended maximum size of a content expression is 1 KB. +* **Type**: string (Required): The value of the payload type can be either `STRING` or `JSON`. + ## ResetTimer ### Properties * **TimerName**: string (Required): The name of the timer to reset. @@ -349,6 +348,17 @@ If you don't specify `rangeKeyField`, the default value is `STRING`. * **Value**: string (Required): The new value of the variable. * **VariableName**: string (Required): The name of the variable. +## SimpleRule +### Properties +* **ComparisonOperator**: string (Required): The comparison operator. +* **InputProperty**: string (Required): The value on the left side of the comparison operator. You can specify an AWS IoT Events input attribute as an input property. +* **Threshold**: string (Required): The value on the right side of the comparison operator. You can enter a number or specify an AWS IoT Events input attribute. + +## Sns +### Properties +* **Payload**: [Payload](#payload) +* **TargetArn**: string (Required): The ARN of the Amazon SNS target where the message is sent. + ## Sns ### Properties * **Payload**: [Payload](#payload) @@ -360,48 +370,38 @@ If you don't specify `rangeKeyField`, the default value is `STRING`. * **QueueUrl**: string (Required): The URL of the SQS queue where the data is written. * **UseBase64**: bool: Set this to `TRUE` if you want the data to be base-64 encoded before it is written to the queue. Otherwise, set this to `FALSE`. -## OnExit -### Properties -* **Events**: [Event](#event)[]: Specifies the `actions` that are performed when the state is exited and the `condition` is `TRUE`. - -## OnInput +## Sqs ### Properties -* **Events**: [Event](#event)[]: Specifies the `actions` performed when the `condition` evaluates to `TRUE`. -* **TransitionEvents**: [TransitionEvent](#transitionevent)[]: Specifies the `actions` performed, and the next `state` entered, when a `condition` evaluates to `TRUE`. +* **Payload**: [Payload](#payload) +* **QueueUrl**: string (Required): The URL of the SQS queue where the data is written. +* **UseBase64**: bool: Set this to `TRUE` if you want the data to be base-64 encoded before it is written to the queue. Otherwise, set this to `FALSE`. -## TransitionEvent +## State ### Properties -* **Actions**: [Action](#action)[]: The actions to be performed. -* **Condition**: string (Required): A Boolean expression that when `TRUE` causes the `actions` to be performed and the `nextState` to be entered. -* **EventName**: string (Required): The name of the event. -* **NextState**: string (Required): The next state to enter. +* **OnEnter**: [OnEnter](#onenter) +* **OnExit**: [OnExit](#onexit) +* **OnInput**: [OnInput](#oninput) +* **StateName**: string (Required): The name of the state. ## Tag ### Properties * **Key**: string (Required): Key of the Tag. * **Value**: string (Required): Value of the Tag. -## AWS.IoTEvents/InputProperties -### Properties -* **InputDefinition**: [InputDefinition](#inputdefinition) (Required) -* **InputDescription**: string: A brief description of the input. -* **InputName**: string (Identifier): The name of the input. -* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. - -For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html). - -## InputDefinition -### Properties -* **Attributes**: [Attribute](#attribute)[] (Required): The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent to the AWS IoT Events system using `BatchPutMessage`. Each such message contains a JSON payload, and those attributes (and their paired values) specified here are available for use in the `condition` expressions used by detectors that monitor this input. - -## Attribute +## Tag ### Properties -* **JsonPath**: string (Required): An expression that specifies an attribute-value pair in a JSON structure. Use this to specify an attribute from the JSON payload that is made available by the input. Inputs are derived from messages sent to AWS IoT Events (`BatchPutMessage`). Each such message contains a JSON payload. The attribute (and its paired value) specified here are available for use in the `condition` expressions used by detectors. - -_Syntax_: `....` +* **Key**: string (Required): Key of the Tag. +* **Value**: string (Required): Value of the Tag. ## Tag ### Properties * **Key**: string (Required): Key of the Tag. * **Value**: string (Required): Value of the Tag. +## TransitionEvent +### Properties +* **Actions**: [Action](#action)[]: The actions to be performed. +* **Condition**: string (Required): A Boolean expression that when `TRUE` causes the `actions` to be performed and the `nextState` to be entered. +* **EventName**: string (Required): The name of the event. +* **NextState**: string (Required): The next state to enter. + diff --git a/artifacts/bicep/aws/aws.iotfleethub/default/types.json b/artifacts/bicep/aws/aws.iotfleethub/default/types.json index 3e6faa3f..46a5082e 100644 --- a/artifacts/bicep/aws/aws.iotfleethub/default/types.json +++ b/artifacts/bicep/aws/aws.iotfleethub/default/types.json @@ -1 +1,164 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.IoTFleetHub/ApplicationProperties","Properties":{"ApplicationArn":{"Type":4,"Flags":2,"Description":"The ARN of the application."},"ApplicationCreationDate":{"Type":3,"Flags":2,"Description":"When the Application was created"},"ApplicationDescription":{"Type":4,"Flags":0,"Description":"Application Description, should be between 1 and 2048 characters."},"ApplicationId":{"Type":4,"Flags":18,"Description":"The ID of the application."},"ApplicationLastUpdateDate":{"Type":3,"Flags":2,"Description":"When the Application was last updated"},"ApplicationName":{"Type":4,"Flags":1,"Description":"Application Name, should be between 1 and 256 characters."},"ApplicationState":{"Type":4,"Flags":2,"Description":"The current state of the application."},"ApplicationUrl":{"Type":4,"Flags":2,"Description":"The URL of the application."},"ErrorMessage":{"Type":4,"Flags":2,"Description":"A message indicating why Create or Delete Application failed."},"RoleArn":{"Type":4,"Flags":1,"Description":"The ARN of the role that the web application assumes when it interacts with AWS IoT Core. For more info on configuring this attribute, see https://docs.aws.amazon.com/iot/latest/apireference/API_iotfleethub_CreateApplication.html#API_iotfleethub_CreateApplication_RequestSyntax"},"SsoClientId":{"Type":4,"Flags":2,"Description":"The AWS SSO application generated client ID (used with AWS SSO APIs)."},"Tags":{"Type":10,"Flags":0,"Description":"A list of key-value pairs that contain metadata for the application."}}}},{"3":{"ItemType":8}},{"2":{"Name":"AWS.IoTFleetHub/Application","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":9,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IoTFleetHub/Application@default","ScopeType":0,"Body":11}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.IoTFleetHub/ApplicationProperties" + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoTFleetHub/ApplicationProperties", + "properties": { + "ApplicationArn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The ARN of the application." + }, + "ApplicationCreationDate": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "When the Application was created" + }, + "ApplicationDescription": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Application Description, should be between 1 and 2048 characters." + }, + "ApplicationId": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The ID of the application." + }, + "ApplicationLastUpdateDate": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "When the Application was last updated" + }, + "ApplicationName": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Application Name, should be between 1 and 256 characters." + }, + "ApplicationState": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The current state of the application." + }, + "ApplicationUrl": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The URL of the application." + }, + "ErrorMessage": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "A message indicating why Create or Delete Application failed." + }, + "RoleArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The ARN of the role that the web application assumes when it interacts with AWS IoT Core. For more info on configuring this attribute, see https://docs.aws.amazon.com/iot/latest/apireference/API_iotfleethub_CreateApplication.html#API_iotfleethub_CreateApplication_RequestSyntax" + }, + "SsoClientId": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The AWS SSO application generated client ID (used with AWS SSO APIs)." + }, + "Tags": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "A list of key-value pairs that contain metadata for the application." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoTFleetHub/Application", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IoTFleetHub/Application@default", + "scopeType": 0, + "body": { + "$ref": "#/6" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.iotfleethub/default/types.md b/artifacts/bicep/aws/aws.iotfleethub/default/types.md index 80353771..7b03f677 100644 --- a/artifacts/bicep/aws/aws.iotfleethub/default/types.md +++ b/artifacts/bicep/aws/aws.iotfleethub/default/types.md @@ -3,9 +3,9 @@ ## Resource AWS.IoTFleetHub/Application@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IoTFleetHub/ApplicationProperties](#awsiotfleethubapplicationproperties) (Required): properties of the resource +* **properties**: [AWS.IoTFleetHub/ApplicationProperties](#awsiotfleethubapplicationproperties) (Required, Identifier): properties of the resource ## AWS.IoTFleetHub/ApplicationProperties ### Properties diff --git a/artifacts/bicep/aws/aws.iotsitewise/default/types.json b/artifacts/bicep/aws/aws.iotsitewise/default/types.json index a668cc80..d9380441 100644 --- a/artifacts/bicep/aws/aws.iotsitewise/default/types.json +++ b/artifacts/bicep/aws/aws.iotsitewise/default/types.json @@ -1 +1,1636 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"AccessPolicyIdentity","Properties":{"IamRole":{"Type":10,"Flags":0},"IamUser":{"Type":11,"Flags":0},"User":{"Type":14,"Flags":0}}}},{"2":{"Name":"AccessPolicyResource","Properties":{"Portal":{"Type":12,"Flags":0},"Project":{"Type":13,"Flags":0}}}},{"2":{"Name":"IamRole","Properties":{"arn":{"Type":4,"Flags":0,"Description":"The ARN of the IAM role."}}}},{"2":{"Name":"IamUser","Properties":{"arn":{"Type":4,"Flags":0,"Description":"The ARN of the IAM user."}}}},{"2":{"Name":"Portal","Properties":{"id":{"Type":4,"Flags":0,"Description":"The ID of the portal."}}}},{"2":{"Name":"Project","Properties":{"id":{"Type":4,"Flags":0,"Description":"The ID of the project."}}}},{"2":{"Name":"User","Properties":{"id":{"Type":4,"Flags":0,"Description":"The AWS SSO ID of the user."}}}},{"2":{"Name":"AWS.IoTSiteWise/AccessPolicyProperties","Properties":{"AccessPolicyArn":{"Type":4,"Flags":2,"Description":"The ARN of the access policy."},"AccessPolicyId":{"Type":4,"Flags":18,"Description":"The ID of the access policy."},"AccessPolicyIdentity":{"Type":8,"Flags":1,"Description":"The identity for this access policy. Choose either a user or a group but not both."},"AccessPolicyPermission":{"Type":4,"Flags":1,"Description":"The permission level for this access policy. Valid values are ADMINISTRATOR or VIEWER."},"AccessPolicyResource":{"Type":9,"Flags":1,"Description":"The AWS IoT SiteWise Monitor resource for this access policy. Choose either portal or project but not both."}}}},{"2":{"Name":"AWS.IoTSiteWise/AccessPolicy","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":15,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IoTSiteWise/AccessPolicy@default","ScopeType":0,"Body":16}},{"2":{"Name":"AssetHierarchy","Properties":{"ChildAssetId":{"Type":4,"Flags":1,"Description":"The ID of the child asset to be associated."},"LogicalId":{"Type":4,"Flags":1,"Description":"The LogicalID of a hierarchy in the parent asset's model."}}}},{"2":{"Name":"AssetProperty","Properties":{"Alias":{"Type":4,"Flags":0,"Description":"The property alias that identifies the property."},"LogicalId":{"Type":4,"Flags":1,"Description":"Customer provided ID for property."},"NotificationState":{"Type":4,"Flags":0,"Description":"The MQTT notification state (ENABLED or DISABLED) for this asset property."},"Unit":{"Type":4,"Flags":0,"Description":"The unit of measure (such as Newtons or RPM) of the asset property. If you don't specify a value for this parameter, the service uses the value of the assetModelProperty in the asset model."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.IoTSiteWise/AssetProperties","Properties":{"AssetArn":{"Type":4,"Flags":2,"Description":"The ARN of the asset"},"AssetDescription":{"Type":4,"Flags":0,"Description":"A description for the asset"},"AssetHierarchies":{"Type":22,"Flags":0},"AssetId":{"Type":4,"Flags":18,"Description":"The ID of the asset"},"AssetModelId":{"Type":4,"Flags":1,"Description":"The ID of the asset model from which to create the asset."},"AssetName":{"Type":4,"Flags":1,"Description":"A unique, friendly name for the asset."},"AssetProperties":{"Type":23,"Flags":0},"Tags":{"Type":24,"Flags":0,"Description":"A list of key-value pairs that contain metadata for the asset."}}}},{"3":{"ItemType":18}},{"3":{"ItemType":19}},{"3":{"ItemType":20}},{"2":{"Name":"AWS.IoTSiteWise/Asset","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":21,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IoTSiteWise/Asset@default","ScopeType":0,"Body":25}},{"2":{"Name":"AssetModelCompositeModel","Properties":{"CompositeModelProperties":{"Type":44,"Flags":0,"Description":"The property definitions of the asset model. You can specify up to 200 properties per asset model."},"Description":{"Type":4,"Flags":0,"Description":"A description for the asset composite model."},"Name":{"Type":4,"Flags":1,"Description":"A unique, friendly name for the asset composite model."},"Type":{"Type":4,"Flags":1,"Description":"The type of the composite model. For alarm composite models, this type is AWS/ALARM"}}}},{"2":{"Name":"AssetModelHierarchy","Properties":{"ChildAssetModelId":{"Type":4,"Flags":1,"Description":"The ID of the asset model. All assets in this hierarchy must be instances of the child AssetModelId asset model."},"LogicalId":{"Type":4,"Flags":1,"Description":"Customer provided ID for hierarchy."},"Name":{"Type":4,"Flags":1,"Description":"The name of the asset model hierarchy."}}}},{"2":{"Name":"AssetModelProperty","Properties":{"DataType":{"Type":4,"Flags":1,"Description":"The data type of the asset model property."},"DataTypeSpec":{"Type":4,"Flags":0,"Description":"The data type of the structure for this property."},"LogicalId":{"Type":4,"Flags":1,"Description":"Customer provided ID for property."},"Name":{"Type":4,"Flags":1,"Description":"The name of the asset model property."},"Type":{"Type":38,"Flags":1,"Description":"The property type"},"Unit":{"Type":4,"Flags":0,"Description":"The unit of the asset model property, such as Newtons or RPM."}}}},{"2":{"Name":"Attribute","Properties":{"DefaultValue":{"Type":4,"Flags":0}}}},{"2":{"Name":"DataType"}},{"2":{"Name":"DataTypeSpec"}},{"2":{"Name":"ExpressionVariable","Properties":{"Name":{"Type":4,"Flags":1,"Description":"The friendly name of the variable to be used in the expression."},"Value":{"Type":43,"Flags":1,"Description":"The variable that identifies an asset property from which to use values."}}}},{"2":{"Name":"Interval"}},{"2":{"Name":"Metric","Properties":{"Expression":{"Type":4,"Flags":1,"Description":"The mathematical expression that defines the metric aggregation function. You can specify up to 10 functions per expression."},"Variables":{"Type":45,"Flags":1,"Description":"The list of variables used in the expression."},"Window":{"Type":36,"Flags":1,"Description":"The window (time interval) over which AWS IoT SiteWise computes the metric's aggregation expression"}}}},{"2":{"Name":"MetricWindow","Properties":{"Tumbling":{"Type":41,"Flags":0}}}},{"2":{"Name":"Offset"}},{"2":{"Name":"PropertyType","Properties":{"Attribute":{"Type":30,"Flags":0},"Metric":{"Type":35,"Flags":0},"Transform":{"Type":40,"Flags":0},"TypeName":{"Type":4,"Flags":1}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"Transform","Properties":{"Expression":{"Type":4,"Flags":1,"Description":"The mathematical expression that defines the transformation function. You can specify up to 10 functions per expression."},"Variables":{"Type":46,"Flags":1,"Description":"The list of variables used in the expression."}}}},{"2":{"Name":"TumblingWindow","Properties":{"Interval":{"Type":4,"Flags":1},"Offset":{"Type":4,"Flags":0}}}},{"2":{"Name":"TypeName"}},{"2":{"Name":"VariableValue","Properties":{"HierarchyLogicalId":{"Type":4,"Flags":0},"PropertyLogicalId":{"Type":4,"Flags":1}}}},{"3":{"ItemType":29}},{"3":{"ItemType":33}},{"3":{"ItemType":33}},{"2":{"Name":"AWS.IoTSiteWise/AssetModelProperties","Properties":{"AssetModelArn":{"Type":4,"Flags":2,"Description":"The ARN of the asset model, which has the following format."},"AssetModelCompositeModels":{"Type":48,"Flags":4,"Description":"The composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties."},"AssetModelDescription":{"Type":4,"Flags":0,"Description":"A description for the asset model."},"AssetModelHierarchies":{"Type":49,"Flags":0,"Description":"The hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. You can specify up to 10 hierarchies per asset model."},"AssetModelId":{"Type":4,"Flags":18,"Description":"The ID of the asset model."},"AssetModelName":{"Type":4,"Flags":1,"Description":"A unique, friendly name for the asset model."},"AssetModelProperties":{"Type":50,"Flags":4,"Description":"The property definitions of the asset model. You can specify up to 200 properties per asset model."},"Tags":{"Type":51,"Flags":0,"Description":"A list of key-value pairs that contain metadata for the asset model."}}}},{"3":{"ItemType":27}},{"3":{"ItemType":28}},{"3":{"ItemType":29}},{"3":{"ItemType":39}},{"2":{"Name":"AWS.IoTSiteWise/AssetModel","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":47,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IoTSiteWise/AssetModel@default","ScopeType":0,"Body":52}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.IoTSiteWise/DashboardProperties","Properties":{"DashboardArn":{"Type":4,"Flags":2,"Description":"The ARN of the dashboard."},"DashboardDefinition":{"Type":4,"Flags":1,"Description":"The dashboard definition specified in a JSON literal."},"DashboardDescription":{"Type":4,"Flags":1,"Description":"A description for the dashboard."},"DashboardId":{"Type":4,"Flags":18,"Description":"The ID of the dashboard."},"DashboardName":{"Type":4,"Flags":1,"Description":"A friendly name for the dashboard."},"ProjectId":{"Type":4,"Flags":0,"Description":"The ID of the project in which to create the dashboard."},"Tags":{"Type":56,"Flags":0,"Description":"A list of key-value pairs that contain metadata for the dashboard."}}}},{"3":{"ItemType":54}},{"2":{"Name":"AWS.IoTSiteWise/Dashboard","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":55,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IoTSiteWise/Dashboard@default","ScopeType":0,"Body":57}},{"2":{"Name":"CapabilityConfiguration"}},{"2":{"Name":"CapabilityNamespace"}},{"2":{"Name":"GatewayCapabilitySummary","Properties":{"CapabilityConfiguration":{"Type":4,"Flags":0},"CapabilityNamespace":{"Type":4,"Flags":1}}}},{"2":{"Name":"GatewayPlatform","Properties":{"Greengrass":{"Type":63,"Flags":0,"Description":"A gateway that runs on AWS IoT Greengrass V1."},"GreengrassV2":{"Type":64,"Flags":0,"Description":"A gateway that runs on AWS IoT Greengrass V2."}}}},{"2":{"Name":"Greengrass","Properties":{"GroupArn":{"Type":4,"Flags":1,"Description":"The ARN of the Greengrass group."}}}},{"2":{"Name":"GreengrassV2","Properties":{"CoreDeviceThingName":{"Type":4,"Flags":1,"Description":"The name of the CoreDevice in GreenGrass V2."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.IoTSiteWise/GatewayProperties","Properties":{"GatewayCapabilitySummaries":{"Type":67,"Flags":0,"Description":"A list of gateway capability summaries that each contain a namespace and status."},"GatewayId":{"Type":4,"Flags":18,"Description":"The ID of the gateway device."},"GatewayName":{"Type":4,"Flags":1,"Description":"A unique, friendly name for the gateway."},"GatewayPlatform":{"Type":62,"Flags":1,"Description":"The gateway's platform. You can only specify one platform in a gateway."},"Tags":{"Type":68,"Flags":0,"Description":"A list of key-value pairs that contain metadata for the gateway."}}}},{"3":{"ItemType":61}},{"3":{"ItemType":65}},{"2":{"Name":"AWS.IoTSiteWise/Gateway","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":66,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IoTSiteWise/Gateway@default","ScopeType":0,"Body":69}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.IoTSiteWise/PortalProperties","Properties":{"Alarms":{"Type":73,"Flags":0,"Description":"Contains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range."},"NotificationSenderEmail":{"Type":4,"Flags":0,"Description":"The email address that sends alarm notifications."},"PortalArn":{"Type":4,"Flags":2,"Description":"The ARN of the portal, which has the following format."},"PortalAuthMode":{"Type":4,"Flags":0,"Description":"The service to use to authenticate users to the portal. Choose from SSO or IAM. You can't change this value after you create a portal."},"PortalClientId":{"Type":4,"Flags":2,"Description":"The AWS SSO application generated client ID (used with AWS SSO APIs)."},"PortalContactEmail":{"Type":4,"Flags":1,"Description":"The AWS administrator's contact email address."},"PortalDescription":{"Type":4,"Flags":0,"Description":"A description for the portal."},"PortalId":{"Type":4,"Flags":18,"Description":"The ID of the portal."},"PortalName":{"Type":4,"Flags":1,"Description":"A friendly name for the portal."},"PortalStartUrl":{"Type":4,"Flags":2,"Description":"The public root URL for the AWS IoT AWS IoT SiteWise Monitor application portal."},"RoleArn":{"Type":4,"Flags":1,"Description":"The ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf."},"Tags":{"Type":74,"Flags":4,"Description":"A list of key-value pairs that contain metadata for the portal."}}}},{"2":{"Name":"Portal_Alarms","Properties":{"AlarmRoleArn":{"Type":4,"Flags":0,"Description":"The ARN of the IAM role that allows the alarm to perform actions and access AWS resources and services, such as AWS IoT Events."},"NotificationLambdaArn":{"Type":4,"Flags":0,"Description":"The ARN of the AWS Lambda function that manages alarm notifications. For more information, see Managing alarm notifications in the AWS IoT Events Developer Guide."}}}},{"3":{"ItemType":71}},{"2":{"Name":"AWS.IoTSiteWise/Portal","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":72,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IoTSiteWise/Portal@default","ScopeType":0,"Body":75}},{"2":{"Name":"AssetId"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.IoTSiteWise/ProjectProperties","Properties":{"AssetIds":{"Type":80,"Flags":0,"Description":"The IDs of the assets to be associated to the project."},"PortalId":{"Type":4,"Flags":1,"Description":"The ID of the portal in which to create the project."},"ProjectArn":{"Type":4,"Flags":2,"Description":"The ARN of the project."},"ProjectDescription":{"Type":4,"Flags":0,"Description":"A description for the project."},"ProjectId":{"Type":4,"Flags":18,"Description":"The ID of the project."},"ProjectName":{"Type":4,"Flags":1,"Description":"A friendly name for the project."},"Tags":{"Type":81,"Flags":0,"Description":"A list of key-value pairs that contain metadata for the project."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":78}},{"2":{"Name":"AWS.IoTSiteWise/Project","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":79,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IoTSiteWise/Project@default","ScopeType":0,"Body":82}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "AccessPolicyIdentity", + "properties": { + "IamRole": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "IamUser": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "User": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AccessPolicyResource", + "properties": { + "Portal": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "Project": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "IamRole", + "properties": { + "arn": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "The ARN of the IAM role." + } + } + }, + { + "$type": "ObjectType", + "name": "IamUser", + "properties": { + "arn": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "The ARN of the IAM user." + } + } + }, + { + "$type": "ObjectType", + "name": "Portal", + "properties": { + "id": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "The ID of the portal." + } + } + }, + { + "$type": "ObjectType", + "name": "Project", + "properties": { + "id": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "The ID of the project." + } + } + }, + { + "$type": "ObjectType", + "name": "User", + "properties": { + "id": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "The AWS SSO ID of the user." + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.IoTSiteWise/AccessPolicyProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.IoTSiteWise/AccessPolicyProperties", + "properties": { + "AccessPolicyArn": { + "type": { + "$ref": "#/7" + }, + "flags": 2, + "description": "The ARN of the access policy." + }, + "AccessPolicyId": { + "type": { + "$ref": "#/7" + }, + "flags": 18, + "description": "The ID of the access policy." + }, + "AccessPolicyIdentity": { + "type": { + "$ref": "#/0" + }, + "flags": 1, + "description": "The identity for this access policy. Choose either a user or a group but not both." + }, + "AccessPolicyPermission": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "The permission level for this access policy. Valid values are ADMINISTRATOR or VIEWER." + }, + "AccessPolicyResource": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The AWS IoT SiteWise Monitor resource for this access policy. Choose either portal or project but not both." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoTSiteWise/AccessPolicy", + "properties": { + "name": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/7" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/9" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IoTSiteWise/AccessPolicy@default", + "scopeType": 0, + "body": { + "$ref": "#/10" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AssetHierarchy", + "properties": { + "ChildAssetId": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "The ID of the child asset to be associated." + }, + "ExternalId": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "String-friendly customer provided external ID" + }, + "Id": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "Customer provided actual UUID for property" + }, + "LogicalId": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "The LogicalID of a hierarchy in the parent asset's model." + } + } + }, + { + "$type": "ObjectType", + "name": "AssetProperty", + "properties": { + "Alias": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "The property alias that identifies the property." + }, + "ExternalId": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "String-friendly customer provided external ID" + }, + "Id": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "Customer provided actual UUID for property" + }, + "LogicalId": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "Customer provided ID for property." + }, + "NotificationState": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "The MQTT notification state (ENABLED or DISABLED) for this asset property." + }, + "Unit": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "The unit of measure (such as Newtons or RPM) of the asset property. If you don't specify a value for this parameter, the service uses the value of the assetModelProperty in the asset model." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/7" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/7" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.IoTSiteWise/AssetProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/12" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/14" + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoTSiteWise/AssetProperties", + "properties": { + "AssetArn": { + "type": { + "$ref": "#/7" + }, + "flags": 2, + "description": "The ARN of the asset" + }, + "AssetDescription": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "A description for the asset" + }, + "AssetExternalId": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "The External ID of the asset" + }, + "AssetHierarchies": { + "type": { + "$ref": "#/16" + }, + "flags": 2 + }, + "AssetId": { + "type": { + "$ref": "#/7" + }, + "flags": 18, + "description": "The ID of the asset" + }, + "AssetModelId": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "The ID of the asset model from which to create the asset." + }, + "AssetName": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "A unique, friendly name for the asset." + }, + "AssetProperties": { + "type": { + "$ref": "#/17" + }, + "flags": 2 + }, + "Tags": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "A list of key-value pairs that contain metadata for the asset." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoTSiteWise/Asset", + "properties": { + "name": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/7" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/19" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IoTSiteWise/Asset@default", + "scopeType": 0, + "body": { + "$ref": "#/20" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AssetModelCompositeModel", + "properties": { + "ComposedAssetModelId": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "The component model ID for which the composite model is composed of" + }, + "CompositeModelProperties": { + "type": { + "$ref": "#/40" + }, + "flags": 0, + "description": "The property definitions of the asset model. You can specify up to 200 properties per asset model." + }, + "Description": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "A description for the asset composite model." + }, + "ExternalId": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "The External ID of the composite model" + }, + "Id": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "The Actual ID of the composite model" + }, + "Name": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "A unique, friendly name for the asset composite model." + }, + "ParentAssetModelCompositeModelExternalId": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "The parent composite model External ID" + }, + "Path": { + "type": { + "$ref": "#/41" + }, + "flags": 0, + "description": "The path of the composite model. This is only for derived composite models" + }, + "Type": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "The type of the composite model. For alarm composite models, this type is AWS/ALARM" + } + } + }, + { + "$type": "ObjectType", + "name": "AssetModelHierarchy", + "properties": { + "ChildAssetModelId": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "The ID of the asset model. All assets in this hierarchy must be instances of the child AssetModelId asset model." + }, + "ExternalId": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "Customer provided external ID for hierarchy" + }, + "Id": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "Customer provided actual ID for hierarchy" + }, + "LogicalId": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "Customer provided logical ID for hierarchy." + }, + "Name": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "The name of the asset model hierarchy." + } + } + }, + { + "$type": "ObjectType", + "name": "AssetModelProperty", + "properties": { + "DataType": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "The data type of the asset model property." + }, + "DataTypeSpec": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "The data type of the structure for this property." + }, + "ExternalId": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "The External ID of the Asset Model Property" + }, + "Id": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "The ID of the Asset Model Property" + }, + "LogicalId": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "Customer provided Logical ID for property." + }, + "Name": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "The name of the asset model property." + }, + "Type": { + "type": { + "$ref": "#/34" + }, + "flags": 1, + "description": "The property type" + }, + "Unit": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "The unit of the asset model property, such as Newtons or RPM." + } + } + }, + { + "$type": "ObjectType", + "name": "Attribute", + "properties": { + "DefaultValue": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DataType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DataTypeSpec", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ExpressionVariable", + "properties": { + "Name": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "The friendly name of the variable to be used in the expression." + }, + "Value": { + "type": { + "$ref": "#/39" + }, + "flags": 1, + "description": "The variable that identifies an asset property from which to use values." + } + } + }, + { + "$type": "ObjectType", + "name": "Interval", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Metric", + "properties": { + "Expression": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "The mathematical expression that defines the metric aggregation function. You can specify up to 10 functions per expression." + }, + "Variables": { + "type": { + "$ref": "#/42" + }, + "flags": 1, + "description": "The list of variables used in the expression." + }, + "Window": { + "type": { + "$ref": "#/31" + }, + "flags": 1, + "description": "The window (time interval) over which AWS IoT SiteWise computes the metric's aggregation expression" + } + } + }, + { + "$type": "ObjectType", + "name": "MetricWindow", + "properties": { + "Tumbling": { + "type": { + "$ref": "#/37" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Offset", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PropertyPathDefinition", + "properties": { + "Name": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "The name of the property" + } + } + }, + { + "$type": "ObjectType", + "name": "PropertyType", + "properties": { + "Attribute": { + "type": { + "$ref": "#/25" + }, + "flags": 0 + }, + "Metric": { + "type": { + "$ref": "#/30" + }, + "flags": 0 + }, + "Transform": { + "type": { + "$ref": "#/36" + }, + "flags": 0 + }, + "TypeName": { + "type": { + "$ref": "#/7" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/7" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/7" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Transform", + "properties": { + "Expression": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "The mathematical expression that defines the transformation function. You can specify up to 10 functions per expression." + }, + "Variables": { + "type": { + "$ref": "#/43" + }, + "flags": 1, + "description": "The list of variables used in the expression." + } + } + }, + { + "$type": "ObjectType", + "name": "TumblingWindow", + "properties": { + "Interval": { + "type": { + "$ref": "#/7" + }, + "flags": 1 + }, + "Offset": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TypeName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "VariableValue", + "properties": { + "HierarchyExternalId": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "The External ID of the hierarchy that is trying to be referenced" + }, + "HierarchyId": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "The ID of the hierarchy that is trying to be referenced" + }, + "HierarchyLogicalId": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "PropertyExternalId": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "The External ID of the property that is trying to be referenced" + }, + "PropertyId": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "The ID of the property that is trying to be referenced" + }, + "PropertyLogicalId": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "PropertyPath": { + "type": { + "$ref": "#/44" + }, + "flags": 0, + "description": "The path of the property that is trying to be referenced" + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/24" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/7" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/28" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/28" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/33" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.IoTSiteWise/AssetModelProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/22" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/23" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/24" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/35" + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoTSiteWise/AssetModelProperties", + "properties": { + "AssetModelArn": { + "type": { + "$ref": "#/7" + }, + "flags": 2, + "description": "The ARN of the asset model, which has the following format." + }, + "AssetModelCompositeModels": { + "type": { + "$ref": "#/46" + }, + "flags": 6, + "description": "The composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties." + }, + "AssetModelDescription": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "A description for the asset model." + }, + "AssetModelExternalId": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "The external ID of the asset model." + }, + "AssetModelHierarchies": { + "type": { + "$ref": "#/47" + }, + "flags": 2, + "description": "The hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. You can specify up to 10 hierarchies per asset model." + }, + "AssetModelId": { + "type": { + "$ref": "#/7" + }, + "flags": 18, + "description": "The ID of the asset model." + }, + "AssetModelName": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "A unique, friendly name for the asset model." + }, + "AssetModelProperties": { + "type": { + "$ref": "#/48" + }, + "flags": 6, + "description": "The property definitions of the asset model. You can specify up to 200 properties per asset model." + }, + "AssetModelType": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "The type of the asset model (ASSET_MODEL OR COMPONENT_MODEL)" + }, + "Tags": { + "type": { + "$ref": "#/49" + }, + "flags": 0, + "description": "A list of key-value pairs that contain metadata for the asset model." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoTSiteWise/AssetModel", + "properties": { + "name": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/7" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/50" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IoTSiteWise/AssetModel@default", + "scopeType": 0, + "body": { + "$ref": "#/51" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/7" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/7" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.IoTSiteWise/DashboardProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/53" + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoTSiteWise/DashboardProperties", + "properties": { + "DashboardArn": { + "type": { + "$ref": "#/7" + }, + "flags": 2, + "description": "The ARN of the dashboard." + }, + "DashboardDefinition": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "The dashboard definition specified in a JSON literal." + }, + "DashboardDescription": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "A description for the dashboard." + }, + "DashboardId": { + "type": { + "$ref": "#/7" + }, + "flags": 18, + "description": "The ID of the dashboard." + }, + "DashboardName": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "A friendly name for the dashboard." + }, + "ProjectId": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "The ID of the project in which to create the dashboard." + }, + "Tags": { + "type": { + "$ref": "#/55" + }, + "flags": 0, + "description": "A list of key-value pairs that contain metadata for the dashboard." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoTSiteWise/Dashboard", + "properties": { + "name": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/7" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/56" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IoTSiteWise/Dashboard@default", + "scopeType": 0, + "body": { + "$ref": "#/57" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "CapabilityConfiguration", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CapabilityNamespace", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "GatewayCapabilitySummary", + "properties": { + "CapabilityConfiguration": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "CapabilityNamespace": { + "type": { + "$ref": "#/7" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "GatewayPlatform", + "properties": { + "Greengrass": { + "type": { + "$ref": "#/63" + }, + "flags": 0, + "description": "A gateway that runs on AWS IoT Greengrass V1." + }, + "GreengrassV2": { + "type": { + "$ref": "#/64" + }, + "flags": 0, + "description": "A gateway that runs on AWS IoT Greengrass V2." + }, + "SiemensIE": { + "type": { + "$ref": "#/65" + }, + "flags": 0, + "description": "A gateway that runs on Siemens Industrial Edge." + } + } + }, + { + "$type": "ObjectType", + "name": "Greengrass", + "properties": { + "GroupArn": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "The ARN of the Greengrass group." + } + } + }, + { + "$type": "ObjectType", + "name": "GreengrassV2", + "properties": { + "CoreDeviceThingName": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "The name of the CoreDevice in GreenGrass V2." + } + } + }, + { + "$type": "ObjectType", + "name": "SiemensIE", + "properties": { + "IotCoreThingName": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "The name of the IoT Core Thing." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/7" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/7" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.IoTSiteWise/GatewayProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/61" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/66" + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoTSiteWise/GatewayProperties", + "properties": { + "GatewayCapabilitySummaries": { + "type": { + "$ref": "#/68" + }, + "flags": 0, + "description": "A list of gateway capability summaries that each contain a namespace and status." + }, + "GatewayId": { + "type": { + "$ref": "#/7" + }, + "flags": 18, + "description": "The ID of the gateway device." + }, + "GatewayName": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "A unique, friendly name for the gateway." + }, + "GatewayPlatform": { + "type": { + "$ref": "#/62" + }, + "flags": 1, + "description": "The gateway's platform. You can only specify one platform in a gateway." + }, + "Tags": { + "type": { + "$ref": "#/69" + }, + "flags": 0, + "description": "A list of key-value pairs that contain metadata for the gateway." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoTSiteWise/Gateway", + "properties": { + "name": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/7" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/70" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IoTSiteWise/Gateway@default", + "scopeType": 0, + "body": { + "$ref": "#/71" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/7" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/7" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.IoTSiteWise/PortalProperties" + }, + { + "$type": "ObjectType", + "name": "Portal_Alarms", + "properties": { + "AlarmRoleArn": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "The ARN of the IAM role that allows the alarm to perform actions and access AWS resources and services, such as AWS IoT Events." + }, + "NotificationLambdaArn": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "The ARN of the AWS Lambda function that manages alarm notifications. For more information, see Managing alarm notifications in the AWS IoT Events Developer Guide." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/73" + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoTSiteWise/PortalProperties", + "properties": { + "Alarms": { + "type": { + "$ref": "#/75" + }, + "flags": 0, + "description": "Contains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range." + }, + "NotificationSenderEmail": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "The email address that sends alarm notifications." + }, + "PortalArn": { + "type": { + "$ref": "#/7" + }, + "flags": 2, + "description": "The ARN of the portal, which has the following format." + }, + "PortalAuthMode": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "The service to use to authenticate users to the portal. Choose from SSO or IAM. You can't change this value after you create a portal." + }, + "PortalClientId": { + "type": { + "$ref": "#/7" + }, + "flags": 2, + "description": "The AWS SSO application generated client ID (used with AWS SSO APIs)." + }, + "PortalContactEmail": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "The AWS administrator's contact email address." + }, + "PortalDescription": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "A description for the portal." + }, + "PortalId": { + "type": { + "$ref": "#/7" + }, + "flags": 18, + "description": "The ID of the portal." + }, + "PortalName": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "A friendly name for the portal." + }, + "PortalStartUrl": { + "type": { + "$ref": "#/7" + }, + "flags": 2, + "description": "The public root URL for the AWS IoT AWS IoT SiteWise Monitor application portal." + }, + "RoleArn": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "The ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf." + }, + "Tags": { + "type": { + "$ref": "#/76" + }, + "flags": 0, + "description": "A list of key-value pairs that contain metadata for the portal." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoTSiteWise/Portal", + "properties": { + "name": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/7" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/77" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IoTSiteWise/Portal@default", + "scopeType": 0, + "body": { + "$ref": "#/78" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AssetId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/7" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/7" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.IoTSiteWise/ProjectProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/7" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/81" + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoTSiteWise/ProjectProperties", + "properties": { + "AssetIds": { + "type": { + "$ref": "#/83" + }, + "flags": 0, + "description": "The IDs of the assets to be associated to the project." + }, + "PortalId": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "The ID of the portal in which to create the project." + }, + "ProjectArn": { + "type": { + "$ref": "#/7" + }, + "flags": 2, + "description": "The ARN of the project." + }, + "ProjectDescription": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "A description for the project." + }, + "ProjectId": { + "type": { + "$ref": "#/7" + }, + "flags": 18, + "description": "The ID of the project." + }, + "ProjectName": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "A friendly name for the project." + }, + "Tags": { + "type": { + "$ref": "#/84" + }, + "flags": 0, + "description": "A list of key-value pairs that contain metadata for the project." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoTSiteWise/Project", + "properties": { + "name": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/7" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/85" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IoTSiteWise/Project@default", + "scopeType": 0, + "body": { + "$ref": "#/86" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.iotsitewise/default/types.md b/artifacts/bicep/aws/aws.iotsitewise/default/types.md index af3e54ef..2ca24f0e 100644 --- a/artifacts/bicep/aws/aws.iotsitewise/default/types.md +++ b/artifacts/bicep/aws/aws.iotsitewise/default/types.md @@ -3,59 +3,51 @@ ## Resource AWS.IoTSiteWise/AccessPolicy@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IoTSiteWise/AccessPolicyProperties](#awsiotsitewiseaccesspolicyproperties) (Required): properties of the resource +* **properties**: [AWS.IoTSiteWise/AccessPolicyProperties](#awsiotsitewiseaccesspolicyproperties) (Required, Identifier): properties of the resource ## Resource AWS.IoTSiteWise/Asset@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IoTSiteWise/AssetProperties](#awsiotsitewiseassetproperties) (Required): properties of the resource +* **properties**: [AWS.IoTSiteWise/AssetProperties](#awsiotsitewiseassetproperties) (Required, Identifier): properties of the resource ## Resource AWS.IoTSiteWise/AssetModel@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IoTSiteWise/AssetModelProperties](#awsiotsitewiseassetmodelproperties) (Required): properties of the resource +* **properties**: [AWS.IoTSiteWise/AssetModelProperties](#awsiotsitewiseassetmodelproperties) (Required, Identifier): properties of the resource ## Resource AWS.IoTSiteWise/Dashboard@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IoTSiteWise/DashboardProperties](#awsiotsitewisedashboardproperties) (Required): properties of the resource +* **properties**: [AWS.IoTSiteWise/DashboardProperties](#awsiotsitewisedashboardproperties) (Required, Identifier): properties of the resource ## Resource AWS.IoTSiteWise/Gateway@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IoTSiteWise/GatewayProperties](#awsiotsitewisegatewayproperties) (Required): properties of the resource +* **properties**: [AWS.IoTSiteWise/GatewayProperties](#awsiotsitewisegatewayproperties) (Required, Identifier): properties of the resource ## Resource AWS.IoTSiteWise/Portal@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IoTSiteWise/PortalProperties](#awsiotsitewiseportalproperties) (Required): properties of the resource +* **properties**: [AWS.IoTSiteWise/PortalProperties](#awsiotsitewiseportalproperties) (Required, Identifier): properties of the resource ## Resource AWS.IoTSiteWise/Project@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IoTSiteWise/ProjectProperties](#awsiotsitewiseprojectproperties) (Required): properties of the resource - -## AWS.IoTSiteWise/AccessPolicyProperties -### Properties -* **AccessPolicyArn**: string (ReadOnly): The ARN of the access policy. -* **AccessPolicyId**: string (ReadOnly, Identifier): The ID of the access policy. -* **AccessPolicyIdentity**: [AccessPolicyIdentity](#accesspolicyidentity) (Required): The identity for this access policy. Choose either a user or a group but not both. -* **AccessPolicyPermission**: string (Required): The permission level for this access policy. Valid values are ADMINISTRATOR or VIEWER. -* **AccessPolicyResource**: [AccessPolicyResource](#accesspolicyresource) (Required): The AWS IoT SiteWise Monitor resource for this access policy. Choose either portal or project but not both. +* **properties**: [AWS.IoTSiteWise/ProjectProperties](#awsiotsitewiseprojectproperties) (Required, Identifier): properties of the resource ## AccessPolicyIdentity ### Properties @@ -63,137 +55,94 @@ * **IamUser**: [IamUser](#iamuser) * **User**: [User](#user) -## IamRole -### Properties -* **arn**: string: The ARN of the IAM role. - -## IamUser -### Properties -* **arn**: string: The ARN of the IAM user. - -## User -### Properties -* **id**: string: The AWS SSO ID of the user. - ## AccessPolicyResource ### Properties * **Portal**: [Portal](#portal) * **Project**: [Project](#project) -## Portal -### Properties -* **id**: string: The ID of the portal. - -## Project -### Properties -* **id**: string: The ID of the project. - -## AWS.IoTSiteWise/AssetProperties -### Properties -* **AssetArn**: string (ReadOnly): The ARN of the asset -* **AssetDescription**: string: A description for the asset -* **AssetHierarchies**: [AssetHierarchy](#assethierarchy)[] -* **AssetId**: string (ReadOnly, Identifier): The ID of the asset -* **AssetModelId**: string (Required): The ID of the asset model from which to create the asset. -* **AssetName**: string (Required): A unique, friendly name for the asset. -* **AssetProperties**: [AssetProperty](#assetproperty)[] -* **Tags**: [Tag](#tag)[]: A list of key-value pairs that contain metadata for the asset. - ## AssetHierarchy ### Properties * **ChildAssetId**: string (Required): The ID of the child asset to be associated. -* **LogicalId**: string (Required): The LogicalID of a hierarchy in the parent asset's model. - -## AssetProperty -### Properties -* **Alias**: string: The property alias that identifies the property. -* **LogicalId**: string (Required): Customer provided ID for property. -* **NotificationState**: string: The MQTT notification state (ENABLED or DISABLED) for this asset property. -* **Unit**: string: The unit of measure (such as Newtons or RPM) of the asset property. If you don't specify a value for this parameter, the service uses the value of the assetModelProperty in the asset model. - -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - -## AWS.IoTSiteWise/AssetModelProperties -### Properties -* **AssetModelArn**: string (ReadOnly): The ARN of the asset model, which has the following format. -* **AssetModelCompositeModels**: [AssetModelCompositeModel](#assetmodelcompositemodel)[] (WriteOnly): The composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties. -* **AssetModelDescription**: string: A description for the asset model. -* **AssetModelHierarchies**: [AssetModelHierarchy](#assetmodelhierarchy)[]: The hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. You can specify up to 10 hierarchies per asset model. -* **AssetModelId**: string (ReadOnly, Identifier): The ID of the asset model. -* **AssetModelName**: string (Required): A unique, friendly name for the asset model. -* **AssetModelProperties**: [AssetModelProperty](#assetmodelproperty)[] (WriteOnly): The property definitions of the asset model. You can specify up to 200 properties per asset model. -* **Tags**: [Tag](#tag)[]: A list of key-value pairs that contain metadata for the asset model. +* **ExternalId**: string: String-friendly customer provided external ID +* **Id**: string: Customer provided actual UUID for property +* **LogicalId**: string: The LogicalID of a hierarchy in the parent asset's model. ## AssetModelCompositeModel ### Properties +* **ComposedAssetModelId**: string: The component model ID for which the composite model is composed of * **CompositeModelProperties**: [AssetModelProperty](#assetmodelproperty)[]: The property definitions of the asset model. You can specify up to 200 properties per asset model. * **Description**: string: A description for the asset composite model. +* **ExternalId**: string: The External ID of the composite model +* **Id**: string: The Actual ID of the composite model * **Name**: string (Required): A unique, friendly name for the asset composite model. +* **ParentAssetModelCompositeModelExternalId**: string: The parent composite model External ID +* **Path**: string[]: The path of the composite model. This is only for derived composite models * **Type**: string (Required): The type of the composite model. For alarm composite models, this type is AWS/ALARM +## AssetModelHierarchy +### Properties +* **ChildAssetModelId**: string (Required): The ID of the asset model. All assets in this hierarchy must be instances of the child AssetModelId asset model. +* **ExternalId**: string: Customer provided external ID for hierarchy +* **Id**: string: Customer provided actual ID for hierarchy +* **LogicalId**: string: Customer provided logical ID for hierarchy. +* **Name**: string (Required): The name of the asset model hierarchy. + ## AssetModelProperty ### Properties * **DataType**: string (Required): The data type of the asset model property. * **DataTypeSpec**: string: The data type of the structure for this property. -* **LogicalId**: string (Required): Customer provided ID for property. +* **ExternalId**: string: The External ID of the Asset Model Property +* **Id**: string: The ID of the Asset Model Property +* **LogicalId**: string: Customer provided Logical ID for property. * **Name**: string (Required): The name of the asset model property. * **Type**: [PropertyType](#propertytype) (Required): The property type * **Unit**: string: The unit of the asset model property, such as Newtons or RPM. -## PropertyType +## AssetProperty ### Properties -* **Attribute**: [Attribute](#attribute) -* **Metric**: [Metric](#metric) -* **Transform**: [Transform](#transform) -* **TypeName**: string (Required) +* **Alias**: string: The property alias that identifies the property. +* **ExternalId**: string: String-friendly customer provided external ID +* **Id**: string: Customer provided actual UUID for property +* **LogicalId**: string: Customer provided ID for property. +* **NotificationState**: string: The MQTT notification state (ENABLED or DISABLED) for this asset property. +* **Unit**: string: The unit of measure (such as Newtons or RPM) of the asset property. If you don't specify a value for this parameter, the service uses the value of the assetModelProperty in the asset model. ## Attribute ### Properties * **DefaultValue**: string -## Metric -### Properties -* **Expression**: string (Required): The mathematical expression that defines the metric aggregation function. You can specify up to 10 functions per expression. -* **Variables**: [ExpressionVariable](#expressionvariable)[] (Required): The list of variables used in the expression. -* **Window**: [MetricWindow](#metricwindow) (Required): The window (time interval) over which AWS IoT SiteWise computes the metric's aggregation expression - -## ExpressionVariable -### Properties -* **Name**: string (Required): The friendly name of the variable to be used in the expression. -* **Value**: [VariableValue](#variablevalue) (Required): The variable that identifies an asset property from which to use values. - -## VariableValue -### Properties -* **HierarchyLogicalId**: string -* **PropertyLogicalId**: string (Required) - -## MetricWindow -### Properties -* **Tumbling**: [TumblingWindow](#tumblingwindow) - -## TumblingWindow -### Properties -* **Interval**: string (Required) -* **Offset**: string - -## Transform +## AWS.IoTSiteWise/AccessPolicyProperties ### Properties -* **Expression**: string (Required): The mathematical expression that defines the transformation function. You can specify up to 10 functions per expression. -* **Variables**: [ExpressionVariable](#expressionvariable)[] (Required): The list of variables used in the expression. +* **AccessPolicyArn**: string (ReadOnly): The ARN of the access policy. +* **AccessPolicyId**: string (ReadOnly, Identifier): The ID of the access policy. +* **AccessPolicyIdentity**: [AccessPolicyIdentity](#accesspolicyidentity) (Required): The identity for this access policy. Choose either a user or a group but not both. +* **AccessPolicyPermission**: string (Required): The permission level for this access policy. Valid values are ADMINISTRATOR or VIEWER. +* **AccessPolicyResource**: [AccessPolicyResource](#accesspolicyresource) (Required): The AWS IoT SiteWise Monitor resource for this access policy. Choose either portal or project but not both. -## AssetModelHierarchy +## AWS.IoTSiteWise/AssetModelProperties ### Properties -* **ChildAssetModelId**: string (Required): The ID of the asset model. All assets in this hierarchy must be instances of the child AssetModelId asset model. -* **LogicalId**: string (Required): Customer provided ID for hierarchy. -* **Name**: string (Required): The name of the asset model hierarchy. +* **AssetModelArn**: string (ReadOnly): The ARN of the asset model, which has the following format. +* **AssetModelCompositeModels**: [AssetModelCompositeModel](#assetmodelcompositemodel)[] (ReadOnly, WriteOnly): The composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties. +* **AssetModelDescription**: string: A description for the asset model. +* **AssetModelExternalId**: string: The external ID of the asset model. +* **AssetModelHierarchies**: [AssetModelHierarchy](#assetmodelhierarchy)[] (ReadOnly): The hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. You can specify up to 10 hierarchies per asset model. +* **AssetModelId**: string (ReadOnly, Identifier): The ID of the asset model. +* **AssetModelName**: string (Required): A unique, friendly name for the asset model. +* **AssetModelProperties**: [AssetModelProperty](#assetmodelproperty)[] (ReadOnly, WriteOnly): The property definitions of the asset model. You can specify up to 200 properties per asset model. +* **AssetModelType**: string: The type of the asset model (ASSET_MODEL OR COMPONENT_MODEL) +* **Tags**: [Tag](#tag)[]: A list of key-value pairs that contain metadata for the asset model. -## Tag +## AWS.IoTSiteWise/AssetProperties ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **AssetArn**: string (ReadOnly): The ARN of the asset +* **AssetDescription**: string: A description for the asset +* **AssetExternalId**: string: The External ID of the asset +* **AssetHierarchies**: [AssetHierarchy](#assethierarchy)[] (ReadOnly) +* **AssetId**: string (ReadOnly, Identifier): The ID of the asset +* **AssetModelId**: string (Required): The ID of the asset model from which to create the asset. +* **AssetName**: string (Required): A unique, friendly name for the asset. +* **AssetProperties**: [AssetProperty](#assetproperty)[] (ReadOnly) +* **Tags**: [Tag](#tag)[]: A list of key-value pairs that contain metadata for the asset. ## AWS.IoTSiteWise/DashboardProperties ### Properties @@ -205,11 +154,6 @@ * **ProjectId**: string: The ID of the project in which to create the dashboard. * **Tags**: [Tag](#tag)[]: A list of key-value pairs that contain metadata for the dashboard. -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - ## AWS.IoTSiteWise/GatewayProperties ### Properties * **GatewayCapabilitySummaries**: [GatewayCapabilitySummary](#gatewaycapabilitysummary)[]: A list of gateway capability summaries that each contain a namespace and status. @@ -218,6 +162,36 @@ * **GatewayPlatform**: [GatewayPlatform](#gatewayplatform) (Required): The gateway's platform. You can only specify one platform in a gateway. * **Tags**: [Tag](#tag)[]: A list of key-value pairs that contain metadata for the gateway. +## AWS.IoTSiteWise/PortalProperties +### Properties +* **Alarms**: [Portal_Alarms](#portalalarms): Contains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range. +* **NotificationSenderEmail**: string: The email address that sends alarm notifications. +* **PortalArn**: string (ReadOnly): The ARN of the portal, which has the following format. +* **PortalAuthMode**: string: The service to use to authenticate users to the portal. Choose from SSO or IAM. You can't change this value after you create a portal. +* **PortalClientId**: string (ReadOnly): The AWS SSO application generated client ID (used with AWS SSO APIs). +* **PortalContactEmail**: string (Required): The AWS administrator's contact email address. +* **PortalDescription**: string: A description for the portal. +* **PortalId**: string (ReadOnly, Identifier): The ID of the portal. +* **PortalName**: string (Required): A friendly name for the portal. +* **PortalStartUrl**: string (ReadOnly): The public root URL for the AWS IoT AWS IoT SiteWise Monitor application portal. +* **RoleArn**: string (Required): The ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf. +* **Tags**: [Tag](#tag)[]: A list of key-value pairs that contain metadata for the portal. + +## AWS.IoTSiteWise/ProjectProperties +### Properties +* **AssetIds**: string[]: The IDs of the assets to be associated to the project. +* **PortalId**: string (Required): The ID of the portal in which to create the project. +* **ProjectArn**: string (ReadOnly): The ARN of the project. +* **ProjectDescription**: string: A description for the project. +* **ProjectId**: string (ReadOnly, Identifier): The ID of the project. +* **ProjectName**: string (Required): A friendly name for the project. +* **Tags**: [Tag](#tag)[]: A list of key-value pairs that contain metadata for the project. + +## ExpressionVariable +### Properties +* **Name**: string (Required): The friendly name of the variable to be used in the expression. +* **Value**: [VariableValue](#variablevalue) (Required): The variable that identifies an asset property from which to use values. + ## GatewayCapabilitySummary ### Properties * **CapabilityConfiguration**: string @@ -227,6 +201,7 @@ ### Properties * **Greengrass**: [Greengrass](#greengrass): A gateway that runs on AWS IoT Greengrass V1. * **GreengrassV2**: [GreengrassV2](#greengrassv2): A gateway that runs on AWS IoT Greengrass V2. +* **SiemensIE**: [SiemensIE](#siemensie): A gateway that runs on Siemens Industrial Edge. ## Greengrass ### Properties @@ -236,48 +211,103 @@ ### Properties * **CoreDeviceThingName**: string (Required): The name of the CoreDevice in GreenGrass V2. -## Tag +## IamRole ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **arn**: string: The ARN of the IAM role. -## AWS.IoTSiteWise/PortalProperties +## IamUser ### Properties -* **Alarms**: [Portal_Alarms](#portalalarms): Contains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range. -* **NotificationSenderEmail**: string: The email address that sends alarm notifications. -* **PortalArn**: string (ReadOnly): The ARN of the portal, which has the following format. -* **PortalAuthMode**: string: The service to use to authenticate users to the portal. Choose from SSO or IAM. You can't change this value after you create a portal. -* **PortalClientId**: string (ReadOnly): The AWS SSO application generated client ID (used with AWS SSO APIs). -* **PortalContactEmail**: string (Required): The AWS administrator's contact email address. -* **PortalDescription**: string: A description for the portal. -* **PortalId**: string (ReadOnly, Identifier): The ID of the portal. -* **PortalName**: string (Required): A friendly name for the portal. -* **PortalStartUrl**: string (ReadOnly): The public root URL for the AWS IoT AWS IoT SiteWise Monitor application portal. -* **RoleArn**: string (Required): The ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf. -* **Tags**: [Tag](#tag)[] (WriteOnly): A list of key-value pairs that contain metadata for the portal. +* **arn**: string: The ARN of the IAM user. + +## Metric +### Properties +* **Expression**: string (Required): The mathematical expression that defines the metric aggregation function. You can specify up to 10 functions per expression. +* **Variables**: [ExpressionVariable](#expressionvariable)[] (Required): The list of variables used in the expression. +* **Window**: [MetricWindow](#metricwindow) (Required): The window (time interval) over which AWS IoT SiteWise computes the metric's aggregation expression + +## MetricWindow +### Properties +* **Tumbling**: [TumblingWindow](#tumblingwindow) + +## Portal +### Properties +* **id**: string: The ID of the portal. ## Portal_Alarms ### Properties * **AlarmRoleArn**: string: The ARN of the IAM role that allows the alarm to perform actions and access AWS resources and services, such as AWS IoT Events. * **NotificationLambdaArn**: string: The ARN of the AWS Lambda function that manages alarm notifications. For more information, see Managing alarm notifications in the AWS IoT Events Developer Guide. +## Project +### Properties +* **id**: string: The ID of the project. + +## PropertyPathDefinition +### Properties +* **Name**: string (Required): The name of the property + +## PropertyType +### Properties +* **Attribute**: [Attribute](#attribute) +* **Metric**: [Metric](#metric) +* **Transform**: [Transform](#transform) +* **TypeName**: string (Required) + +## SiemensIE +### Properties +* **IotCoreThingName**: string (Required): The name of the IoT Core Thing. + ## Tag ### Properties * **Key**: string (Required) * **Value**: string (Required) -## AWS.IoTSiteWise/ProjectProperties +## Tag ### Properties -* **AssetIds**: string[]: The IDs of the assets to be associated to the project. -* **PortalId**: string (Required): The ID of the portal in which to create the project. -* **ProjectArn**: string (ReadOnly): The ARN of the project. -* **ProjectDescription**: string: A description for the project. -* **ProjectId**: string (ReadOnly, Identifier): The ID of the project. -* **ProjectName**: string (Required): A friendly name for the project. -* **Tags**: [Tag](#tag)[]: A list of key-value pairs that contain metadata for the project. +* **Key**: string (Required) +* **Value**: string (Required) + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) ## Tag ### Properties * **Key**: string (Required) * **Value**: string (Required) +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + +## Transform +### Properties +* **Expression**: string (Required): The mathematical expression that defines the transformation function. You can specify up to 10 functions per expression. +* **Variables**: [ExpressionVariable](#expressionvariable)[] (Required): The list of variables used in the expression. + +## TumblingWindow +### Properties +* **Interval**: string (Required) +* **Offset**: string + +## User +### Properties +* **id**: string: The AWS SSO ID of the user. + +## VariableValue +### Properties +* **HierarchyExternalId**: string: The External ID of the hierarchy that is trying to be referenced +* **HierarchyId**: string: The ID of the hierarchy that is trying to be referenced +* **HierarchyLogicalId**: string +* **PropertyExternalId**: string: The External ID of the property that is trying to be referenced +* **PropertyId**: string: The ID of the property that is trying to be referenced +* **PropertyLogicalId**: string +* **PropertyPath**: [PropertyPathDefinition](#propertypathdefinition)[]: The path of the property that is trying to be referenced + diff --git a/artifacts/bicep/aws/aws.iottwinmaker/default/types.json b/artifacts/bicep/aws/aws.iottwinmaker/default/types.json index 61d88ebe..0c2bac09 100644 --- a/artifacts/bicep/aws/aws.iottwinmaker/default/types.json +++ b/artifacts/bicep/aws/aws.iottwinmaker/default/types.json @@ -1 +1,1440 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"CompositeComponentType","Properties":{"ComponentTypeId":{"Type":4,"Flags":16,"Description":"The id of the composite component type."}}}},{"2":{"Name":"DataConnector","Properties":{"IsNative":{"Type":2,"Flags":0,"Description":"A Boolean value that specifies whether the data connector is native to IoT TwinMaker."},"Lambda":{"Type":14,"Flags":0,"Description":"The Lambda function associated with this data connector."}}}},{"2":{"Name":"DataType","Properties":{"AllowedValues":{"Type":22,"Flags":0,"Description":"The allowed values for this data type."},"NestedType":{"Type":10,"Flags":0,"Description":"The nested type in the data type."},"Relationship":{"Type":19,"Flags":0,"Description":"A relationship that associates a component with another component."},"Type":{"Type":4,"Flags":1,"Description":"The underlying type of the data type."},"UnitOfMeasure":{"Type":4,"Flags":0,"Description":"The unit of measure used in this data type."}}}},{"2":{"Name":"DataValue","Properties":{"BooleanValue":{"Type":2,"Flags":0,"Description":"A Boolean value."},"DoubleValue":{"Type":3,"Flags":0,"Description":"A double value."},"Expression":{"Type":4,"Flags":0,"Description":"An expression that produces the value."},"IntegerValue":{"Type":3,"Flags":0,"Description":"An integer value."},"ListValue":{"Type":23,"Flags":0,"Description":"A list of multiple values."},"LongValue":{"Type":3,"Flags":0,"Description":"A long value."},"MapValue":{"Type":24,"Flags":0,"Description":"An object that maps strings to multiple DataValue objects. \n\n"},"RelationshipValue":{"Type":25,"Flags":0,"Description":"A value that relates a component to another component."},"StringValue":{"Type":4,"Flags":0,"Description":"A string value."}}}},{"2":{"Name":"DateTimeFormat"}},{"2":{"Name":"Function","Properties":{"ImplementedBy":{"Type":9,"Flags":0,"Description":"The data connector."},"RequiredProperties":{"Type":26,"Flags":0,"Description":"The required properties of the function."},"Scope":{"Type":4,"Flags":0,"Description":"The scope of the function."}}}},{"2":{"Name":"LambdaFunction","Properties":{"Arn":{"Type":4,"Flags":1}}}},{"2":{"Name":"ParentComponentType"}},{"2":{"Name":"PropertyDefinition","Properties":{"Configurations":{"Type":27,"Flags":0,"Description":"An object that specifies information about a property."},"DataType":{"Type":10,"Flags":0,"Description":"An object that contains information about the data type."},"DefaultValue":{"Type":11,"Flags":0,"Description":"An object that contains the default value."},"IsExternalId":{"Type":2,"Flags":0,"Description":"A Boolean value that specifies whether the property ID comes from an external data store."},"IsRequiredInEntity":{"Type":2,"Flags":0,"Description":"A Boolean value that specifies whether the property is required."},"IsStoredExternally":{"Type":2,"Flags":0,"Description":"A Boolean value that specifies whether the property is stored externally."},"IsTimeSeries":{"Type":2,"Flags":0,"Description":"A Boolean value that specifies whether the property consists of time series data."}}}},{"2":{"Name":"PropertyGroup","Properties":{"GroupType":{"Type":4,"Flags":0,"Description":"The type of property group."},"PropertyNames":{"Type":28,"Flags":0,"Description":"The list of property names in the property group."}}}},{"2":{"Name":"PropertyName"}},{"2":{"Name":"Relationship","Properties":{"RelationshipType":{"Type":4,"Flags":0,"Description":"The type of the relationship."},"TargetComponentTypeId":{"Type":4,"Flags":0,"Description":"The ID of the target component type associated with this relationship."}}}},{"2":{"Name":"RequiredProperty"}},{"2":{"Name":"Status","Properties":{"Error":{"Type":29,"Flags":0},"State":{"Type":4,"Flags":0}}}},{"3":{"ItemType":11}},{"3":{"ItemType":11}},{"2":{"Name":"ComponentType_MapValue","Properties":{}}},{"2":{"Name":"ComponentType_RelationshipValue","Properties":{"TargetComponentName":{"Type":4,"Flags":0},"TargetEntityId":{"Type":4,"Flags":0}}}},{"3":{"ItemType":4}},{"2":{"Name":"ComponentType_Configurations","Properties":{}}},{"3":{"ItemType":4}},{"2":{"Name":"ComponentType_Error","Properties":{}}},{"2":{"Name":"AWS.IoTTwinMaker/ComponentTypeProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"The ARN of the component type."},"ComponentTypeId":{"Type":4,"Flags":17,"Description":"The ID of the component type."},"CompositeComponentTypes":{"Type":31,"Flags":0,"Description":"An map of the composite component types in the component type. Each composite component type's key must be unique to this map."},"CreationDateTime":{"Type":4,"Flags":2,"Description":"The date and time when the component type was created."},"Description":{"Type":4,"Flags":0,"Description":"The description of the component type."},"ExtendsFrom":{"Type":32,"Flags":0,"Description":"Specifies the parent component type to extend."},"Functions":{"Type":33,"Flags":0,"Description":"a Map of functions in the component type. Each function's key must be unique to this map."},"IsAbstract":{"Type":2,"Flags":2,"Description":"A Boolean value that specifies whether the component type is abstract."},"IsSchemaInitialized":{"Type":2,"Flags":2,"Description":"A Boolean value that specifies whether the component type has a schema initializer and that the schema initializer has run."},"IsSingleton":{"Type":2,"Flags":0,"Description":"A Boolean value that specifies whether an entity can have more than one component of this type."},"PropertyDefinitions":{"Type":34,"Flags":0,"Description":"An map of the property definitions in the component type. Each property definition's key must be unique to this map."},"PropertyGroups":{"Type":35,"Flags":0,"Description":"An map of the property groups in the component type. Each property group's key must be unique to this map."},"Status":{"Type":21,"Flags":2,"Description":"The current status of the component type."},"Tags":{"Type":36,"Flags":0,"Description":"A map of key-value pairs to associate with a resource."},"UpdateDateTime":{"Type":4,"Flags":2,"Description":"The last date and time when the component type was updated."},"WorkspaceId":{"Type":4,"Flags":17,"Description":"The ID of the workspace that contains the component type."}}}},{"2":{"Name":"ComponentType_CompositeComponentTypes","Properties":{}}},{"3":{"ItemType":4}},{"2":{"Name":"ComponentType_Functions","Properties":{}}},{"2":{"Name":"ComponentType_PropertyDefinitions","Properties":{}}},{"2":{"Name":"ComponentType_PropertyGroups","Properties":{}}},{"2":{"Name":"ComponentType_Tags","Properties":{}}},{"2":{"Name":"AWS.IoTTwinMaker/ComponentType","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":30,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IoTTwinMaker/ComponentType@default","ScopeType":0,"Body":37}},{"2":{"Name":"Component","Properties":{"ComponentName":{"Type":4,"Flags":0,"Description":"The name of the component."},"ComponentTypeId":{"Type":4,"Flags":0,"Description":"The ID of the component type."},"DefinedIn":{"Type":4,"Flags":0,"Description":"The name of the property definition set in the component."},"Description":{"Type":4,"Flags":0,"Description":"The description of the component."},"Properties":{"Type":50,"Flags":0,"Description":"An object that maps strings to the properties to set in the component type. Each string in the mapping must be unique to this object."},"PropertyGroups":{"Type":51,"Flags":0,"Description":"An object that maps strings to the property groups to set in the component type. Each string in the mapping must be unique to this object."},"Status":{"Type":49,"Flags":0,"Description":"The current status of the entity."}}}},{"2":{"Name":"CompositeComponent","Properties":{"ComponentName":{"Type":4,"Flags":0,"Description":"The name of the component."},"ComponentPath":{"Type":4,"Flags":0,"Description":"The path of the component."},"ComponentTypeId":{"Type":4,"Flags":0,"Description":"The ID of the component type."},"Description":{"Type":4,"Flags":0,"Description":"The description of the component."},"Properties":{"Type":52,"Flags":0,"Description":"An object that maps strings to the properties to set in the component type. Each string in the mapping must be unique to this object."},"PropertyGroups":{"Type":53,"Flags":0,"Description":"An object that maps strings to the property groups to set in the component type. Each string in the mapping must be unique to this object."},"Status":{"Type":49,"Flags":0,"Description":"The current status of the component."}}}},{"2":{"Name":"DataType","Properties":{"AllowedValues":{"Type":54,"Flags":0,"Description":"The allowed values for this data type."},"NestedType":{"Type":41,"Flags":0,"Description":"The nested type in the data type."},"Relationship":{"Type":48,"Flags":0,"Description":"A relationship that associates a component with another component."},"Type":{"Type":4,"Flags":0,"Description":"The underlying type of the data type."},"UnitOfMeasure":{"Type":4,"Flags":0,"Description":"The unit of measure used in this data type."}}}},{"2":{"Name":"DataValue","Properties":{"BooleanValue":{"Type":2,"Flags":0,"Description":"A Boolean value."},"DoubleValue":{"Type":3,"Flags":0,"Description":"A double value."},"Expression":{"Type":4,"Flags":0,"Description":"An expression that produces the value."},"IntegerValue":{"Type":3,"Flags":0,"Description":"An integer value."},"ListValue":{"Type":55,"Flags":0,"Description":"A list of multiple values."},"LongValue":{"Type":3,"Flags":0,"Description":"A long value."},"MapValue":{"Type":56,"Flags":0,"Description":"An object that maps strings to multiple DataValue objects."},"RelationshipValue":{"Type":57,"Flags":0,"Description":"A value that relates a component to another component."},"StringValue":{"Type":4,"Flags":0,"Description":"A string value."}}}},{"2":{"Name":"DateTimeFormat"}},{"2":{"Name":"Property","Properties":{"Definition":{"Type":58,"Flags":0,"Description":"An object that specifies information about a property."},"Value":{"Type":42,"Flags":0,"Description":"The value of the property."}}}},{"2":{"Name":"PropertyDefinitionConfiguration","Properties":{}}},{"2":{"Name":"PropertyGroup","Properties":{"GroupType":{"Type":4,"Flags":0,"Description":"The type of property group."},"PropertyNames":{"Type":59,"Flags":0,"Description":"The list of property names in the property group."}}}},{"2":{"Name":"PropertyName"}},{"2":{"Name":"Relationship","Properties":{"RelationshipType":{"Type":4,"Flags":0,"Description":"The type of the relationship."},"TargetComponentTypeId":{"Type":4,"Flags":0,"Description":"The ID of the target component type associated with this relationship."}}}},{"2":{"Name":"Status","Properties":{"Error":{"Type":60,"Flags":0},"State":{"Type":4,"Flags":0}}}},{"2":{"Name":"Entity_Properties","Properties":{}}},{"2":{"Name":"Entity_PropertyGroups","Properties":{}}},{"2":{"Name":"Entity_Properties","Properties":{}}},{"2":{"Name":"Entity_PropertyGroups","Properties":{}}},{"3":{"ItemType":42}},{"3":{"ItemType":42}},{"2":{"Name":"Entity_MapValue","Properties":{}}},{"2":{"Name":"Entity_RelationshipValue","Properties":{"TargetComponentName":{"Type":4,"Flags":0},"TargetEntityId":{"Type":4,"Flags":0}}}},{"2":{"Name":"Entity_Definition","Properties":{"Configuration":{"Type":45,"Flags":0,"Description":"An object that specifies information about a property."},"DataType":{"Type":41,"Flags":0,"Description":"An object that contains information about the data type."},"DefaultValue":{"Type":42,"Flags":0,"Description":"An object that contains the default value."},"IsExternalId":{"Type":2,"Flags":0,"Description":"A Boolean value that specifies whether the property ID comes from an external data store."},"IsFinal":{"Type":2,"Flags":0,"Description":"A Boolean value that specifies whether the property definition can be updated."},"IsImported":{"Type":2,"Flags":0,"Description":"A Boolean value that specifies whether the property definition is imported from an external data store."},"IsInherited":{"Type":2,"Flags":0,"Description":"A Boolean value that specifies whether the property definition is inherited from a parent entity."},"IsRequiredInEntity":{"Type":2,"Flags":0,"Description":"A Boolean value that specifies whether the property is required."},"IsStoredExternally":{"Type":2,"Flags":0,"Description":"A Boolean value that specifies whether the property is stored externally."},"IsTimeSeries":{"Type":2,"Flags":0,"Description":"A Boolean value that specifies whether the property consists of time series data."}}}},{"3":{"ItemType":4}},{"2":{"Name":"Entity_Error","Properties":{}}},{"2":{"Name":"AWS.IoTTwinMaker/EntityProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"The ARN of the entity."},"Components":{"Type":62,"Flags":0,"Description":"A map that sets information about a component type."},"CompositeComponents":{"Type":63,"Flags":0,"Description":"A map that sets information about a composite component."},"CreationDateTime":{"Type":4,"Flags":2,"Description":"The date and time when the entity was created."},"Description":{"Type":4,"Flags":0,"Description":"The description of the entity."},"EntityId":{"Type":4,"Flags":16,"Description":"The ID of the entity."},"EntityName":{"Type":4,"Flags":1,"Description":"The name of the entity."},"HasChildEntities":{"Type":2,"Flags":2,"Description":"A Boolean value that specifies whether the entity has child entities or not."},"ParentEntityId":{"Type":4,"Flags":0,"Description":"The ID of the parent entity."},"Status":{"Type":49,"Flags":2,"Description":"The current status of the entity."},"Tags":{"Type":64,"Flags":0,"Description":"A key-value pair to associate with a resource."},"UpdateDateTime":{"Type":4,"Flags":2,"Description":"The last date and time when the entity was updated."},"WorkspaceId":{"Type":4,"Flags":17,"Description":"The ID of the workspace."}}}},{"2":{"Name":"Entity_Components","Properties":{}}},{"2":{"Name":"Entity_CompositeComponents","Properties":{}}},{"2":{"Name":"Entity_Tags","Properties":{}}},{"2":{"Name":"AWS.IoTTwinMaker/Entity","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":61,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IoTTwinMaker/Entity@default","ScopeType":0,"Body":65}},{"2":{"Name":"DateTimeFormat"}},{"2":{"Name":"AWS.IoTTwinMaker/SceneProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"The ARN of the scene."},"Capabilities":{"Type":69,"Flags":0,"Description":"A list of capabilities that the scene uses to render."},"ContentLocation":{"Type":4,"Flags":1,"Description":"The relative path that specifies the location of the content definition file."},"CreationDateTime":{"Type":4,"Flags":2,"Description":"The date and time when the scene was created."},"Description":{"Type":4,"Flags":0,"Description":"The description of the scene."},"GeneratedSceneMetadata":{"Type":70,"Flags":2,"Description":"A key-value pair of generated scene metadata for the scene."},"SceneId":{"Type":4,"Flags":17,"Description":"The ID of the scene."},"SceneMetadata":{"Type":71,"Flags":0,"Description":"A key-value pair of scene metadata for the scene."},"Tags":{"Type":72,"Flags":0,"Description":"A key-value pair to associate with a resource."},"UpdateDateTime":{"Type":4,"Flags":2,"Description":"The date and time of the current update."},"WorkspaceId":{"Type":4,"Flags":17,"Description":"The ID of the scene."}}}},{"3":{"ItemType":4}},{"2":{"Name":"Scene_GeneratedSceneMetadata","Properties":{}}},{"2":{"Name":"Scene_SceneMetadata","Properties":{}}},{"2":{"Name":"Scene_Tags","Properties":{}}},{"2":{"Name":"AWS.IoTTwinMaker/Scene","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":68,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IoTTwinMaker/Scene@default","ScopeType":0,"Body":73}},{"2":{"Name":"DateTimeFormat"}},{"2":{"Name":"AWS.IoTTwinMaker/WorkspaceProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"The ARN of the workspace."},"CreationDateTime":{"Type":4,"Flags":2,"Description":"The date and time when the workspace was created."},"Description":{"Type":4,"Flags":0,"Description":"The description of the workspace."},"Role":{"Type":4,"Flags":1,"Description":"The ARN of the execution role associated with the workspace."},"S3Location":{"Type":4,"Flags":1,"Description":"The ARN of the S3 bucket where resources associated with the workspace are stored."},"Tags":{"Type":77,"Flags":0,"Description":"A map of key-value pairs to associate with a resource."},"UpdateDateTime":{"Type":4,"Flags":2,"Description":"The date and time of the current update."},"WorkspaceId":{"Type":4,"Flags":17,"Description":"The ID of the workspace."}}}},{"2":{"Name":"Workspace_Tags","Properties":{}}},{"2":{"Name":"AWS.IoTTwinMaker/Workspace","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":76,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IoTTwinMaker/Workspace@default","ScopeType":0,"Body":78}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "CompositeComponentType", + "properties": { + "ComponentTypeId": { + "type": { + "$ref": "#/14" + }, + "flags": 16, + "description": "The id of the composite component type." + } + } + }, + { + "$type": "ObjectType", + "name": "DataConnector", + "properties": { + "IsNative": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "A Boolean value that specifies whether the data connector is native to IoT TwinMaker." + }, + "Lambda": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "The Lambda function associated with this data connector." + } + } + }, + { + "$type": "ObjectType", + "name": "DataType", + "properties": { + "AllowedValues": { + "type": { + "$ref": "#/16" + }, + "flags": 0, + "description": "The allowed values for this data type." + }, + "NestedType": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The nested type in the data type." + }, + "Relationship": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "A relationship that associates a component with another component." + }, + "Type": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The underlying type of the data type." + }, + "UnitOfMeasure": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The unit of measure used in this data type." + } + } + }, + { + "$type": "ObjectType", + "name": "DataValue", + "properties": { + "BooleanValue": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "A Boolean value." + }, + "DoubleValue": { + "type": { + "$ref": "#/17" + }, + "flags": 0, + "description": "A double value." + }, + "Expression": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "An expression that produces the value." + }, + "IntegerValue": { + "type": { + "$ref": "#/17" + }, + "flags": 0, + "description": "An integer value." + }, + "ListValue": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "A list of multiple values." + }, + "LongValue": { + "type": { + "$ref": "#/17" + }, + "flags": 0, + "description": "A long value." + }, + "MapValue": { + "type": { + "$ref": "#/19" + }, + "flags": 0, + "description": "An object that maps strings to multiple DataValue objects. \n\n" + }, + "RelationshipValue": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "A value that relates a component to another component." + }, + "StringValue": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "A string value." + } + } + }, + { + "$type": "ObjectType", + "name": "DateTimeFormat", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Function", + "properties": { + "ImplementedBy": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The data connector." + }, + "RequiredProperties": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "The required properties of the function." + }, + "Scope": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The scope of the function." + } + } + }, + { + "$type": "ObjectType", + "name": "LambdaFunction", + "properties": { + "Arn": { + "type": { + "$ref": "#/14" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ParentComponentType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PropertyDefinition", + "properties": { + "Configurations": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "An object that specifies information about a property." + }, + "DataType": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "An object that contains information about the data type." + }, + "DefaultValue": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "An object that contains the default value." + }, + "IsExternalId": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "A Boolean value that specifies whether the property ID comes from an external data store." + }, + "IsRequiredInEntity": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "A Boolean value that specifies whether the property is required." + }, + "IsStoredExternally": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "A Boolean value that specifies whether the property is stored externally." + }, + "IsTimeSeries": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "A Boolean value that specifies whether the property consists of time series data." + } + } + }, + { + "$type": "ObjectType", + "name": "PropertyGroup", + "properties": { + "GroupType": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The type of property group." + }, + "PropertyNames": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "The list of property names in the property group." + } + } + }, + { + "$type": "ObjectType", + "name": "PropertyName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Relationship", + "properties": { + "RelationshipType": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The type of the relationship." + }, + "TargetComponentTypeId": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The ID of the target component type associated with this relationship." + } + } + }, + { + "$type": "ObjectType", + "name": "RequiredProperty", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Status", + "properties": { + "Error": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "State": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ObjectType", + "name": "ComponentType_MapValue", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ComponentType_RelationshipValue", + "properties": { + "TargetComponentName": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + }, + "TargetEntityId": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/14" + } + }, + { + "$type": "ObjectType", + "name": "ComponentType_Configurations", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/14" + } + }, + { + "$type": "ObjectType", + "name": "ComponentType_Error", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.IoTTwinMaker/ComponentTypeProperties" + }, + { + "$type": "ObjectType", + "name": "ComponentType_CompositeComponentTypes", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/14" + } + }, + { + "$type": "ObjectType", + "name": "ComponentType_Functions", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ComponentType_PropertyDefinitions", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ComponentType_PropertyGroups", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ComponentType_Tags", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AWS.IoTTwinMaker/ComponentTypeProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/14" + }, + "flags": 2, + "description": "The ARN of the component type." + }, + "ComponentTypeId": { + "type": { + "$ref": "#/14" + }, + "flags": 17, + "description": "The ID of the component type." + }, + "CompositeComponentTypes": { + "type": { + "$ref": "#/26" + }, + "flags": 0, + "description": "An map of the composite component types in the component type. Each composite component type's key must be unique to this map." + }, + "CreationDateTime": { + "type": { + "$ref": "#/14" + }, + "flags": 2, + "description": "The date and time when the component type was created." + }, + "Description": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The description of the component type." + }, + "ExtendsFrom": { + "type": { + "$ref": "#/27" + }, + "flags": 0, + "description": "Specifies the parent component type to extend." + }, + "Functions": { + "type": { + "$ref": "#/28" + }, + "flags": 0, + "description": "a Map of functions in the component type. Each function's key must be unique to this map." + }, + "IsAbstract": { + "type": { + "$ref": "#/15" + }, + "flags": 2, + "description": "A Boolean value that specifies whether the component type is abstract." + }, + "IsSchemaInitialized": { + "type": { + "$ref": "#/15" + }, + "flags": 2, + "description": "A Boolean value that specifies whether the component type has a schema initializer and that the schema initializer has run." + }, + "IsSingleton": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "A Boolean value that specifies whether an entity can have more than one component of this type." + }, + "PropertyDefinitions": { + "type": { + "$ref": "#/29" + }, + "flags": 0, + "description": "An map of the property definitions in the component type. Each property definition's key must be unique to this map." + }, + "PropertyGroups": { + "type": { + "$ref": "#/30" + }, + "flags": 0, + "description": "An map of the property groups in the component type. Each property group's key must be unique to this map." + }, + "Status": { + "type": { + "$ref": "#/13" + }, + "flags": 2, + "description": "The current status of the component type." + }, + "Tags": { + "type": { + "$ref": "#/31" + }, + "flags": 0, + "description": "A map of key-value pairs to associate with a resource." + }, + "UpdateDateTime": { + "type": { + "$ref": "#/14" + }, + "flags": 2, + "description": "The last date and time when the component type was updated." + }, + "WorkspaceId": { + "type": { + "$ref": "#/14" + }, + "flags": 17, + "description": "The ID of the workspace that contains the component type." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoTTwinMaker/ComponentType", + "properties": { + "name": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/14" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/32" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IoTTwinMaker/ComponentType@default", + "scopeType": 0, + "body": { + "$ref": "#/33" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Component", + "properties": { + "ComponentName": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The name of the component." + }, + "ComponentTypeId": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The ID of the component type." + }, + "DefinedIn": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The name of the property definition set in the component." + }, + "Description": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The description of the component." + }, + "Properties": { + "type": { + "$ref": "#/47" + }, + "flags": 0, + "description": "An object that maps strings to the properties to set in the component type. Each string in the mapping must be unique to this object." + }, + "PropertyGroups": { + "type": { + "$ref": "#/48" + }, + "flags": 0, + "description": "An object that maps strings to the property groups to set in the component type. Each string in the mapping must be unique to this object." + }, + "Status": { + "type": { + "$ref": "#/46" + }, + "flags": 0, + "description": "The current status of the entity." + } + } + }, + { + "$type": "ObjectType", + "name": "CompositeComponent", + "properties": { + "ComponentName": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The name of the component." + }, + "ComponentPath": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The path of the component." + }, + "ComponentTypeId": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The ID of the component type." + }, + "Description": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The description of the component." + }, + "Properties": { + "type": { + "$ref": "#/49" + }, + "flags": 0, + "description": "An object that maps strings to the properties to set in the component type. Each string in the mapping must be unique to this object." + }, + "PropertyGroups": { + "type": { + "$ref": "#/50" + }, + "flags": 0, + "description": "An object that maps strings to the property groups to set in the component type. Each string in the mapping must be unique to this object." + }, + "Status": { + "type": { + "$ref": "#/46" + }, + "flags": 0, + "description": "The current status of the component." + } + } + }, + { + "$type": "ObjectType", + "name": "DataType", + "properties": { + "AllowedValues": { + "type": { + "$ref": "#/51" + }, + "flags": 0, + "description": "The allowed values for this data type." + }, + "NestedType": { + "type": { + "$ref": "#/37" + }, + "flags": 0, + "description": "The nested type in the data type." + }, + "Relationship": { + "type": { + "$ref": "#/45" + }, + "flags": 0, + "description": "A relationship that associates a component with another component." + }, + "Type": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The underlying type of the data type." + }, + "UnitOfMeasure": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The unit of measure used in this data type." + } + } + }, + { + "$type": "ObjectType", + "name": "DataValue", + "properties": { + "BooleanValue": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "A Boolean value." + }, + "DoubleValue": { + "type": { + "$ref": "#/17" + }, + "flags": 0, + "description": "A double value." + }, + "Expression": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "An expression that produces the value." + }, + "IntegerValue": { + "type": { + "$ref": "#/17" + }, + "flags": 0, + "description": "An integer value." + }, + "ListValue": { + "type": { + "$ref": "#/52" + }, + "flags": 0, + "description": "A list of multiple values." + }, + "LongValue": { + "type": { + "$ref": "#/17" + }, + "flags": 0, + "description": "A long value." + }, + "MapValue": { + "type": { + "$ref": "#/53" + }, + "flags": 0, + "description": "An object that maps strings to multiple DataValue objects." + }, + "RelationshipValue": { + "type": { + "$ref": "#/54" + }, + "flags": 0, + "description": "A value that relates a component to another component." + }, + "StringValue": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "A string value." + } + } + }, + { + "$type": "ObjectType", + "name": "DateTimeFormat", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Definition", + "properties": { + "Configuration": { + "type": { + "$ref": "#/42" + }, + "flags": 0, + "description": "An object that specifies information about a property configuration." + }, + "DataType": { + "type": { + "$ref": "#/37" + }, + "flags": 0, + "description": "An object that contains information about the data type." + }, + "DefaultValue": { + "type": { + "$ref": "#/38" + }, + "flags": 0, + "description": "An object that contains the default value." + }, + "IsExternalId": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "A Boolean value that specifies whether the property ID comes from an external data store." + }, + "IsFinal": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "A Boolean value that specifies whether the property definition can be updated." + }, + "IsImported": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "A Boolean value that specifies whether the property definition is imported from an external data store." + }, + "IsInherited": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "A Boolean value that specifies whether the property definition is inherited from a parent entity." + }, + "IsRequiredInEntity": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "A Boolean value that specifies whether the property is required." + }, + "IsStoredExternally": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "A Boolean value that specifies whether the property is stored externally." + }, + "IsTimeSeries": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "A Boolean value that specifies whether the property consists of time series data." + } + } + }, + { + "$type": "ObjectType", + "name": "Property", + "properties": { + "Definition": { + "type": { + "$ref": "#/40" + }, + "flags": 0, + "description": "The definition of the property." + }, + "Value": { + "type": { + "$ref": "#/38" + }, + "flags": 0, + "description": "The value of the property." + } + } + }, + { + "$type": "ObjectType", + "name": "PropertyDefinitionConfiguration", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PropertyGroup", + "properties": { + "GroupType": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The type of property group." + }, + "PropertyNames": { + "type": { + "$ref": "#/55" + }, + "flags": 0, + "description": "The list of property names in the property group." + } + } + }, + { + "$type": "ObjectType", + "name": "PropertyName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Relationship", + "properties": { + "RelationshipType": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The type of the relationship." + }, + "TargetComponentTypeId": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The ID of the target component type associated with this relationship." + } + } + }, + { + "$type": "ObjectType", + "name": "Status", + "properties": { + "Error": { + "type": { + "$ref": "#/56" + }, + "flags": 0 + }, + "State": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Entity_Properties", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Entity_PropertyGroups", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Entity_Properties", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Entity_PropertyGroups", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/38" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/38" + } + }, + { + "$type": "ObjectType", + "name": "Entity_MapValue", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Entity_RelationshipValue", + "properties": { + "TargetComponentName": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + }, + "TargetEntityId": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/14" + } + }, + { + "$type": "ObjectType", + "name": "Entity_Error", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.IoTTwinMaker/EntityProperties" + }, + { + "$type": "ObjectType", + "name": "Entity_Components", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Entity_CompositeComponents", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Entity_Tags", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AWS.IoTTwinMaker/EntityProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/14" + }, + "flags": 2, + "description": "The ARN of the entity." + }, + "Components": { + "type": { + "$ref": "#/58" + }, + "flags": 0, + "description": "A map that sets information about a component type." + }, + "CompositeComponents": { + "type": { + "$ref": "#/59" + }, + "flags": 0, + "description": "A map that sets information about a composite component." + }, + "CreationDateTime": { + "type": { + "$ref": "#/14" + }, + "flags": 2, + "description": "The date and time when the entity was created." + }, + "Description": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The description of the entity." + }, + "EntityId": { + "type": { + "$ref": "#/14" + }, + "flags": 16, + "description": "The ID of the entity." + }, + "EntityName": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The name of the entity." + }, + "HasChildEntities": { + "type": { + "$ref": "#/15" + }, + "flags": 2, + "description": "A Boolean value that specifies whether the entity has child entities or not." + }, + "ParentEntityId": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The ID of the parent entity." + }, + "Status": { + "type": { + "$ref": "#/46" + }, + "flags": 2, + "description": "The current status of the entity." + }, + "Tags": { + "type": { + "$ref": "#/60" + }, + "flags": 0, + "description": "A key-value pair to associate with a resource." + }, + "UpdateDateTime": { + "type": { + "$ref": "#/14" + }, + "flags": 2, + "description": "The last date and time when the entity was updated." + }, + "WorkspaceId": { + "type": { + "$ref": "#/14" + }, + "flags": 17, + "description": "The ID of the workspace." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoTTwinMaker/Entity", + "properties": { + "name": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/14" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/61" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IoTTwinMaker/Entity@default", + "scopeType": 0, + "body": { + "$ref": "#/62" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "DateTimeFormat", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.IoTTwinMaker/SceneProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/14" + } + }, + { + "$type": "ObjectType", + "name": "Scene_GeneratedSceneMetadata", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Scene_SceneMetadata", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Scene_Tags", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AWS.IoTTwinMaker/SceneProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/14" + }, + "flags": 2, + "description": "The ARN of the scene." + }, + "Capabilities": { + "type": { + "$ref": "#/66" + }, + "flags": 0, + "description": "A list of capabilities that the scene uses to render." + }, + "ContentLocation": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The relative path that specifies the location of the content definition file." + }, + "CreationDateTime": { + "type": { + "$ref": "#/14" + }, + "flags": 2, + "description": "The date and time when the scene was created." + }, + "Description": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The description of the scene." + }, + "GeneratedSceneMetadata": { + "type": { + "$ref": "#/67" + }, + "flags": 2, + "description": "A key-value pair of generated scene metadata for the scene." + }, + "SceneId": { + "type": { + "$ref": "#/14" + }, + "flags": 17, + "description": "The ID of the scene." + }, + "SceneMetadata": { + "type": { + "$ref": "#/68" + }, + "flags": 0, + "description": "A key-value pair of scene metadata for the scene." + }, + "Tags": { + "type": { + "$ref": "#/69" + }, + "flags": 0, + "description": "A key-value pair to associate with a resource." + }, + "UpdateDateTime": { + "type": { + "$ref": "#/14" + }, + "flags": 2, + "description": "The date and time of the current update." + }, + "WorkspaceId": { + "type": { + "$ref": "#/14" + }, + "flags": 17, + "description": "The ID of the scene." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoTTwinMaker/Scene", + "properties": { + "name": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/14" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/70" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IoTTwinMaker/Scene@default", + "scopeType": 0, + "body": { + "$ref": "#/71" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "DateTimeFormat", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.IoTTwinMaker/WorkspaceProperties" + }, + { + "$type": "ObjectType", + "name": "Workspace_Tags", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AWS.IoTTwinMaker/WorkspaceProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/14" + }, + "flags": 2, + "description": "The ARN of the workspace." + }, + "CreationDateTime": { + "type": { + "$ref": "#/14" + }, + "flags": 2, + "description": "The date and time when the workspace was created." + }, + "Description": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The description of the workspace." + }, + "Role": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The ARN of the execution role associated with the workspace." + }, + "S3Location": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The ARN of the S3 bucket where resources associated with the workspace are stored." + }, + "Tags": { + "type": { + "$ref": "#/75" + }, + "flags": 0, + "description": "A map of key-value pairs to associate with a resource." + }, + "UpdateDateTime": { + "type": { + "$ref": "#/14" + }, + "flags": 2, + "description": "The date and time of the current update." + }, + "WorkspaceId": { + "type": { + "$ref": "#/14" + }, + "flags": 17, + "description": "The ID of the workspace." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoTTwinMaker/Workspace", + "properties": { + "name": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/14" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/76" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IoTTwinMaker/Workspace@default", + "scopeType": 0, + "body": { + "$ref": "#/77" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.iottwinmaker/default/types.md b/artifacts/bicep/aws/aws.iottwinmaker/default/types.md index d434f202..a70887c1 100644 --- a/artifacts/bicep/aws/aws.iottwinmaker/default/types.md +++ b/artifacts/bicep/aws/aws.iottwinmaker/default/types.md @@ -3,30 +3,30 @@ ## Resource AWS.IoTTwinMaker/ComponentType@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IoTTwinMaker/ComponentTypeProperties](#awsiottwinmakercomponenttypeproperties) (Required): properties of the resource +* **properties**: [AWS.IoTTwinMaker/ComponentTypeProperties](#awsiottwinmakercomponenttypeproperties) (Required, Identifier): properties of the resource ## Resource AWS.IoTTwinMaker/Entity@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IoTTwinMaker/EntityProperties](#awsiottwinmakerentityproperties) (Required): properties of the resource +* **properties**: [AWS.IoTTwinMaker/EntityProperties](#awsiottwinmakerentityproperties) (Required, Identifier): properties of the resource ## Resource AWS.IoTTwinMaker/Scene@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IoTTwinMaker/SceneProperties](#awsiottwinmakersceneproperties) (Required): properties of the resource +* **properties**: [AWS.IoTTwinMaker/SceneProperties](#awsiottwinmakersceneproperties) (Required, Identifier): properties of the resource ## Resource AWS.IoTTwinMaker/Workspace@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IoTTwinMaker/WorkspaceProperties](#awsiottwinmakerworkspaceproperties) (Required): properties of the resource +* **properties**: [AWS.IoTTwinMaker/WorkspaceProperties](#awsiottwinmakerworkspaceproperties) (Required, Identifier): properties of the resource ## AWS.IoTTwinMaker/ComponentTypeProperties ### Properties @@ -47,29 +47,6 @@ * **UpdateDateTime**: string (ReadOnly): The last date and time when the component type was updated. * **WorkspaceId**: string (Required, Identifier): The ID of the workspace that contains the component type. -## ComponentType_CompositeComponentTypes -### Properties - -## ComponentType_Functions -### Properties - -## ComponentType_PropertyDefinitions -### Properties - -## ComponentType_PropertyGroups -### Properties - -## Status -### Properties -* **Error**: [ComponentType_Error](#componenttypeerror) -* **State**: string - -## ComponentType_Error -### Properties - -## ComponentType_Tags -### Properties - ## AWS.IoTTwinMaker/EntityProperties ### Properties * **Arn**: string (ReadOnly): The ARN of the entity. @@ -86,23 +63,6 @@ * **UpdateDateTime**: string (ReadOnly): The last date and time when the entity was updated. * **WorkspaceId**: string (Required, Identifier): The ID of the workspace. -## Entity_Components -### Properties - -## Entity_CompositeComponents -### Properties - -## Status -### Properties -* **Error**: [Entity_Error](#entityerror) -* **State**: string - -## Entity_Error -### Properties - -## Entity_Tags -### Properties - ## AWS.IoTTwinMaker/SceneProperties ### Properties * **Arn**: string (ReadOnly): The ARN of the scene. @@ -117,15 +77,6 @@ * **UpdateDateTime**: string (ReadOnly): The date and time of the current update. * **WorkspaceId**: string (Required, Identifier): The ID of the scene. -## Scene_GeneratedSceneMetadata -### Properties - -## Scene_SceneMetadata -### Properties - -## Scene_Tags -### Properties - ## AWS.IoTTwinMaker/WorkspaceProperties ### Properties * **Arn**: string (ReadOnly): The ARN of the workspace. @@ -137,6 +88,55 @@ * **UpdateDateTime**: string (ReadOnly): The date and time of the current update. * **WorkspaceId**: string (Required, Identifier): The ID of the workspace. +## ComponentType_CompositeComponentTypes +### Properties + +## ComponentType_Error +### Properties + +## ComponentType_Functions +### Properties + +## ComponentType_PropertyDefinitions +### Properties + +## ComponentType_PropertyGroups +### Properties + +## ComponentType_Tags +### Properties + +## Entity_Components +### Properties + +## Entity_CompositeComponents +### Properties + +## Entity_Error +### Properties + +## Entity_Tags +### Properties + +## Scene_GeneratedSceneMetadata +### Properties + +## Scene_SceneMetadata +### Properties + +## Scene_Tags +### Properties + +## Status +### Properties +* **Error**: [ComponentType_Error](#componenttypeerror) +* **State**: string + +## Status +### Properties +* **Error**: [Entity_Error](#entityerror) +* **State**: string + ## Workspace_Tags ### Properties diff --git a/artifacts/bicep/aws/aws.iotwireless/default/types.json b/artifacts/bicep/aws/aws.iotwireless/default/types.json index 3e19bc41..289647bc 100644 --- a/artifacts/bicep/aws/aws.iotwireless/default/types.json +++ b/artifacts/bicep/aws/aws.iotwireless/default/types.json @@ -1 +1,1108 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":0},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"AWS.IoTWireless/DestinationProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"Destination arn. Returned after successful create."},"Description":{"Type":4,"Flags":0,"Description":"Destination description"},"Expression":{"Type":4,"Flags":1,"Description":"Destination expression"},"ExpressionType":{"Type":4,"Flags":1,"Description":"Must be RuleName"},"Name":{"Type":4,"Flags":17,"Description":"Unique name of destination"},"RoleArn":{"Type":4,"Flags":0,"Description":"AWS role ARN that grants access"},"Tags":{"Type":10,"Flags":0,"Description":"A list of key-value pairs that contain metadata for the destination."}}}},{"3":{"ItemType":8}},{"2":{"Name":"AWS.IoTWireless/Destination","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":9,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IoTWireless/Destination@default","ScopeType":0,"Body":11}},{"2":{"Name":"LoRaWAN","Properties":{"RfRegion":{"Type":4,"Flags":1,"Description":"FUOTA task LoRaWAN RF region"},"StartTime":{"Type":4,"Flags":2,"Description":"FUOTA task LoRaWAN start time"}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":0},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"AWS.IoTWireless/FuotaTaskProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"FUOTA task arn. Returned after successful create."},"AssociateMulticastGroup":{"Type":4,"Flags":0,"Description":"Multicast group to associate. Only for update request."},"AssociateWirelessDevice":{"Type":4,"Flags":0,"Description":"Wireless device to associate. Only for update request."},"Description":{"Type":4,"Flags":0,"Description":"FUOTA task description"},"DisassociateMulticastGroup":{"Type":4,"Flags":0,"Description":"Multicast group to disassociate. Only for update request."},"DisassociateWirelessDevice":{"Type":4,"Flags":0,"Description":"Wireless device to disassociate. Only for update request."},"FirmwareUpdateImage":{"Type":4,"Flags":1,"Description":"FUOTA task firmware update image binary S3 link"},"FirmwareUpdateRole":{"Type":4,"Flags":1,"Description":"FUOTA task firmware IAM role for reading S3"},"FuotaTaskStatus":{"Type":4,"Flags":2,"Description":"FUOTA task status. Returned after successful read."},"Id":{"Type":4,"Flags":18,"Description":"FUOTA task id. Returned after successful create."},"LoRaWAN":{"Type":13,"Flags":1,"Description":"FUOTA task LoRaWAN"},"Name":{"Type":4,"Flags":0,"Description":"Name of FUOTA task"},"Tags":{"Type":16,"Flags":0,"Description":"A list of key-value pairs that contain metadata for the FUOTA task."}}}},{"3":{"ItemType":14}},{"2":{"Name":"AWS.IoTWireless/FuotaTask","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":15,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IoTWireless/FuotaTask@default","ScopeType":0,"Body":17}},{"2":{"Name":"LoRaWAN","Properties":{"DlClass":{"Type":4,"Flags":1,"Description":"Multicast group LoRaWAN DL Class"},"NumberOfDevicesInGroup":{"Type":3,"Flags":2,"Description":"Multicast group number of devices in group. Returned after successful read."},"NumberOfDevicesRequested":{"Type":3,"Flags":2,"Description":"Multicast group number of devices requested. Returned after successful read."},"RfRegion":{"Type":4,"Flags":1,"Description":"Multicast group LoRaWAN RF region"}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":0},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"AWS.IoTWireless/MulticastGroupProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"Multicast group arn. Returned after successful create."},"AssociateWirelessDevice":{"Type":4,"Flags":0,"Description":"Wireless device to associate. Only for update request."},"Description":{"Type":4,"Flags":0,"Description":"Multicast group description"},"DisassociateWirelessDevice":{"Type":4,"Flags":0,"Description":"Wireless device to disassociate. Only for update request."},"Id":{"Type":4,"Flags":18,"Description":"Multicast group id. Returned after successful create."},"LoRaWAN":{"Type":19,"Flags":1,"Description":"Multicast group LoRaWAN"},"Name":{"Type":4,"Flags":0,"Description":"Name of Multicast group"},"Status":{"Type":4,"Flags":2,"Description":"Multicast group status. Returned after successful read."},"Tags":{"Type":22,"Flags":0,"Description":"A list of key-value pairs that contain metadata for the Multicast group."}}}},{"3":{"ItemType":20}},{"2":{"Name":"AWS.IoTWireless/MulticastGroup","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":21,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IoTWireless/MulticastGroup@default","ScopeType":0,"Body":23}},{"2":{"Name":"LogLevel"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"WirelessDeviceFrameInfo"}},{"2":{"Name":"AWS.IoTWireless/NetworkAnalyzerConfigurationProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"Arn for network analyzer configuration, Returned upon successful create."},"Description":{"Type":4,"Flags":0,"Description":"The description of the new resource"},"Name":{"Type":4,"Flags":17,"Description":"Name of the network analyzer configuration"},"Tags":{"Type":29,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."},"TraceContent":{"Type":30,"Flags":0,"Description":"Trace content for your wireless gateway and wireless device resources"},"WirelessDevices":{"Type":31,"Flags":0,"Description":"List of wireless gateway resources that have been added to the network analyzer configuration"},"WirelessGateways":{"Type":32,"Flags":0,"Description":"List of wireless gateway resources that have been added to the network analyzer configuration"}}}},{"3":{"ItemType":26}},{"2":{"Name":"NetworkAnalyzerConfiguration_TraceContent","Properties":{"LogLevel":{"Type":4,"Flags":0},"WirelessDeviceFrameInfo":{"Type":4,"Flags":0}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.IoTWireless/NetworkAnalyzerConfiguration","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":28,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IoTWireless/NetworkAnalyzerConfiguration@default","ScopeType":0,"Body":33}},{"2":{"Name":"AbpV10x","Properties":{"DevAddr":{"Type":4,"Flags":1},"SessionKeys":{"Type":40,"Flags":1}}}},{"2":{"Name":"AbpV11","Properties":{"DevAddr":{"Type":4,"Flags":1},"SessionKeys":{"Type":41,"Flags":1}}}},{"2":{"Name":"LoRaWANDevice","Properties":{"AbpV10x":{"Type":35,"Flags":0},"AbpV11":{"Type":36,"Flags":0},"DevEui":{"Type":4,"Flags":0},"DeviceProfileId":{"Type":4,"Flags":0},"OtaaV10x":{"Type":38,"Flags":0},"OtaaV11":{"Type":39,"Flags":0},"ServiceProfileId":{"Type":4,"Flags":0}}}},{"2":{"Name":"OtaaV10x","Properties":{"AppEui":{"Type":4,"Flags":1},"AppKey":{"Type":4,"Flags":1}}}},{"2":{"Name":"OtaaV11","Properties":{"AppKey":{"Type":4,"Flags":1},"JoinEui":{"Type":4,"Flags":1},"NwkKey":{"Type":4,"Flags":1}}}},{"2":{"Name":"SessionKeysAbpV10x","Properties":{"AppSKey":{"Type":4,"Flags":1},"NwkSKey":{"Type":4,"Flags":1}}}},{"2":{"Name":"SessionKeysAbpV11","Properties":{"AppSKey":{"Type":4,"Flags":1},"FNwkSIntKey":{"Type":4,"Flags":1},"NwkSEncKey":{"Type":4,"Flags":1},"SNwkSIntKey":{"Type":4,"Flags":1}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":0},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"AWS.IoTWireless/WirelessDeviceProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"Wireless device arn. Returned after successful create."},"Description":{"Type":4,"Flags":0,"Description":"Wireless device description"},"DestinationName":{"Type":4,"Flags":1,"Description":"Wireless device destination name"},"Id":{"Type":4,"Flags":18,"Description":"Wireless device Id. Returned after successful create."},"LastUplinkReceivedAt":{"Type":4,"Flags":0,"Description":"The date and time when the most recent uplink was received."},"LoRaWAN":{"Type":37,"Flags":0,"Description":"The combination of Package, Station and Model which represents the version of the LoRaWAN Wireless Device."},"Name":{"Type":4,"Flags":0,"Description":"Wireless device name"},"Tags":{"Type":44,"Flags":0,"Description":"A list of key-value pairs that contain metadata for the device. Currently not supported, will not create if tags are passed."},"ThingArn":{"Type":4,"Flags":0,"Description":"Thing arn. Passed into update to associate Thing with Wireless device."},"ThingName":{"Type":4,"Flags":2,"Description":"Thing Arn. If there is a Thing created, this can be returned with a Get call."},"Type":{"Type":4,"Flags":1,"Description":"Wireless device type, currently only Sidewalk and LoRa"}}}},{"3":{"ItemType":42}},{"2":{"Name":"AWS.IoTWireless/WirelessDevice","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":43,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IoTWireless/WirelessDevice@default","ScopeType":0,"Body":45}},{"2":{"Name":"LoRaWANGateway","Properties":{"GatewayEui":{"Type":4,"Flags":1},"RfRegion":{"Type":4,"Flags":1}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":0},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"AWS.IoTWireless/WirelessGatewayProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"Arn for Wireless Gateway. Returned upon successful create."},"Description":{"Type":4,"Flags":0,"Description":"Description of Wireless Gateway."},"Id":{"Type":4,"Flags":18,"Description":"Id for Wireless Gateway. Returned upon successful create."},"LastUplinkReceivedAt":{"Type":4,"Flags":0,"Description":"The date and time when the most recent uplink was received."},"LoRaWAN":{"Type":47,"Flags":1,"Description":"The combination of Package, Station and Model which represents the version of the LoRaWAN Wireless Gateway."},"Name":{"Type":4,"Flags":0,"Description":"Name of Wireless Gateway."},"Tags":{"Type":50,"Flags":0,"Description":"A list of key-value pairs that contain metadata for the gateway."},"ThingArn":{"Type":4,"Flags":0,"Description":"Thing Arn. Passed into Update to associate a Thing with the Wireless Gateway."},"ThingName":{"Type":4,"Flags":0,"Description":"Thing Name. If there is a Thing created, this can be returned with a Get call."}}}},{"3":{"ItemType":48}},{"2":{"Name":"AWS.IoTWireless/WirelessGateway","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":49,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IoTWireless/WirelessGateway@default","ScopeType":0,"Body":51}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.IoTWireless/DestinationProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoTWireless/DestinationProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "Destination arn. Returned after successful create." + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Destination description" + }, + "Expression": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Destination expression" + }, + "ExpressionType": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Must be RuleName" + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "Unique name of destination" + }, + "RoleArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "AWS role ARN that grants access" + }, + "Tags": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "A list of key-value pairs that contain metadata for the destination." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoTWireless/Destination", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IoTWireless/Destination@default", + "scopeType": 0, + "body": { + "$ref": "#/5" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "LoRaWAN", + "properties": { + "RfRegion": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "FUOTA task LoRaWAN RF region" + }, + "StartTime": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "FUOTA task LoRaWAN start time" + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.IoTWireless/FuotaTaskProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/8" + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoTWireless/FuotaTaskProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "FUOTA task arn. Returned after successful create." + }, + "AssociateMulticastGroup": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Multicast group to associate. Only for update request." + }, + "AssociateWirelessDevice": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Wireless device to associate. Only for update request." + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "FUOTA task description" + }, + "DisassociateMulticastGroup": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Multicast group to disassociate. Only for update request." + }, + "DisassociateWirelessDevice": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Wireless device to disassociate. Only for update request." + }, + "FirmwareUpdateImage": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "FUOTA task firmware update image binary S3 link" + }, + "FirmwareUpdateRole": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "FUOTA task firmware IAM role for reading S3" + }, + "FuotaTaskStatus": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "FUOTA task status. Returned after successful read." + }, + "Id": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "FUOTA task id. Returned after successful create." + }, + "LoRaWAN": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "FUOTA task LoRaWAN" + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Name of FUOTA task" + }, + "Tags": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "A list of key-value pairs that contain metadata for the FUOTA task." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoTWireless/FuotaTask", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/11" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IoTWireless/FuotaTask@default", + "scopeType": 0, + "body": { + "$ref": "#/12" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "LoRaWAN", + "properties": { + "DlClass": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Multicast group LoRaWAN DL Class" + }, + "NumberOfDevicesInGroup": { + "type": { + "$ref": "#/16" + }, + "flags": 2, + "description": "Multicast group number of devices in group. Returned after successful read." + }, + "NumberOfDevicesRequested": { + "type": { + "$ref": "#/16" + }, + "flags": 2, + "description": "Multicast group number of devices requested. Returned after successful read." + }, + "RfRegion": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Multicast group LoRaWAN RF region" + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.IoTWireless/MulticastGroupProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/15" + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoTWireless/MulticastGroupProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "Multicast group arn. Returned after successful create." + }, + "AssociateWirelessDevice": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Wireless device to associate. Only for update request." + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Multicast group description" + }, + "DisassociateWirelessDevice": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Wireless device to disassociate. Only for update request." + }, + "Id": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "Multicast group id. Returned after successful create." + }, + "LoRaWAN": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "Multicast group LoRaWAN" + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Name of Multicast group" + }, + "Status": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "Multicast group status. Returned after successful read." + }, + "Tags": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "A list of key-value pairs that contain metadata for the Multicast group." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoTWireless/MulticastGroup", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/19" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IoTWireless/MulticastGroup@default", + "scopeType": 0, + "body": { + "$ref": "#/20" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "LogLevel", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "ObjectType", + "name": "WirelessDeviceFrameInfo", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.IoTWireless/NetworkAnalyzerConfigurationProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/23" + } + }, + { + "$type": "ObjectType", + "name": "NetworkAnalyzerConfiguration_TraceContent", + "properties": { + "LogLevel": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "WirelessDeviceFrameInfo": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoTWireless/NetworkAnalyzerConfigurationProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "Arn for network analyzer configuration, Returned upon successful create." + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The description of the new resource" + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "Name of the network analyzer configuration" + }, + "Tags": { + "type": { + "$ref": "#/26" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + }, + "TraceContent": { + "type": { + "$ref": "#/27" + }, + "flags": 0, + "description": "Trace content for your wireless gateway and wireless device resources" + }, + "WirelessDevices": { + "type": { + "$ref": "#/28" + }, + "flags": 0, + "description": "List of wireless gateway resources that have been added to the network analyzer configuration" + }, + "WirelessGateways": { + "type": { + "$ref": "#/29" + }, + "flags": 0, + "description": "List of wireless gateway resources that have been added to the network analyzer configuration" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoTWireless/NetworkAnalyzerConfiguration", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/30" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IoTWireless/NetworkAnalyzerConfiguration@default", + "scopeType": 0, + "body": { + "$ref": "#/31" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AbpV10x", + "properties": { + "DevAddr": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "SessionKeys": { + "type": { + "$ref": "#/38" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AbpV11", + "properties": { + "DevAddr": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "SessionKeys": { + "type": { + "$ref": "#/39" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "LoRaWANDevice", + "properties": { + "AbpV10x": { + "type": { + "$ref": "#/33" + }, + "flags": 0 + }, + "AbpV11": { + "type": { + "$ref": "#/34" + }, + "flags": 0 + }, + "DevEui": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "DeviceProfileId": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "OtaaV10x": { + "type": { + "$ref": "#/36" + }, + "flags": 0 + }, + "OtaaV11": { + "type": { + "$ref": "#/37" + }, + "flags": 0 + }, + "ServiceProfileId": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "OtaaV10x", + "properties": { + "AppEui": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "AppKey": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "OtaaV11", + "properties": { + "AppKey": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "JoinEui": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "NwkKey": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "SessionKeysAbpV10x", + "properties": { + "AppSKey": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "NwkSKey": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "SessionKeysAbpV11", + "properties": { + "AppSKey": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "FNwkSIntKey": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "NwkSEncKey": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "SNwkSIntKey": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.IoTWireless/WirelessDeviceProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/40" + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoTWireless/WirelessDeviceProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "Wireless device arn. Returned after successful create." + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Wireless device description" + }, + "DestinationName": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Wireless device destination name" + }, + "Id": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "Wireless device Id. Returned after successful create." + }, + "LastUplinkReceivedAt": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The date and time when the most recent uplink was received." + }, + "LoRaWAN": { + "type": { + "$ref": "#/35" + }, + "flags": 0, + "description": "The combination of Package, Station and Model which represents the version of the LoRaWAN Wireless Device." + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Wireless device name" + }, + "Tags": { + "type": { + "$ref": "#/42" + }, + "flags": 0, + "description": "A list of key-value pairs that contain metadata for the device. Currently not supported, will not create if tags are passed." + }, + "ThingArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Thing arn. Passed into update to associate Thing with Wireless device." + }, + "ThingName": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "Thing Arn. If there is a Thing created, this can be returned with a Get call." + }, + "Type": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Wireless device type, currently only Sidewalk and LoRa" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoTWireless/WirelessDevice", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/43" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IoTWireless/WirelessDevice@default", + "scopeType": 0, + "body": { + "$ref": "#/44" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "LoRaWANGateway", + "properties": { + "GatewayEui": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "RfRegion": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.IoTWireless/WirelessGatewayProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/47" + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoTWireless/WirelessGatewayProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "Arn for Wireless Gateway. Returned upon successful create." + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Description of Wireless Gateway." + }, + "Id": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "Id for Wireless Gateway. Returned upon successful create." + }, + "LastUplinkReceivedAt": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The date and time when the most recent uplink was received." + }, + "LoRaWAN": { + "type": { + "$ref": "#/46" + }, + "flags": 1, + "description": "The combination of Package, Station and Model which represents the version of the LoRaWAN Wireless Gateway." + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Name of Wireless Gateway." + }, + "Tags": { + "type": { + "$ref": "#/49" + }, + "flags": 0, + "description": "A list of key-value pairs that contain metadata for the gateway." + }, + "ThingArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Thing Arn. Passed into Update to associate a Thing with the Wireless Gateway." + }, + "ThingName": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Thing Name. If there is a Thing created, this can be returned with a Get call." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IoTWireless/WirelessGateway", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/50" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IoTWireless/WirelessGateway@default", + "scopeType": 0, + "body": { + "$ref": "#/51" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.iotwireless/default/types.md b/artifacts/bicep/aws/aws.iotwireless/default/types.md index 8a9e7034..dbe05dfd 100644 --- a/artifacts/bicep/aws/aws.iotwireless/default/types.md +++ b/artifacts/bicep/aws/aws.iotwireless/default/types.md @@ -3,44 +3,54 @@ ## Resource AWS.IoTWireless/Destination@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IoTWireless/DestinationProperties](#awsiotwirelessdestinationproperties) (Required): properties of the resource +* **properties**: [AWS.IoTWireless/DestinationProperties](#awsiotwirelessdestinationproperties) (Required, Identifier): properties of the resource ## Resource AWS.IoTWireless/FuotaTask@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IoTWireless/FuotaTaskProperties](#awsiotwirelessfuotataskproperties) (Required): properties of the resource +* **properties**: [AWS.IoTWireless/FuotaTaskProperties](#awsiotwirelessfuotataskproperties) (Required, Identifier): properties of the resource ## Resource AWS.IoTWireless/MulticastGroup@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IoTWireless/MulticastGroupProperties](#awsiotwirelessmulticastgroupproperties) (Required): properties of the resource +* **properties**: [AWS.IoTWireless/MulticastGroupProperties](#awsiotwirelessmulticastgroupproperties) (Required, Identifier): properties of the resource ## Resource AWS.IoTWireless/NetworkAnalyzerConfiguration@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IoTWireless/NetworkAnalyzerConfigurationProperties](#awsiotwirelessnetworkanalyzerconfigurationproperties) (Required): properties of the resource +* **properties**: [AWS.IoTWireless/NetworkAnalyzerConfigurationProperties](#awsiotwirelessnetworkanalyzerconfigurationproperties) (Required, Identifier): properties of the resource ## Resource AWS.IoTWireless/WirelessDevice@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IoTWireless/WirelessDeviceProperties](#awsiotwirelesswirelessdeviceproperties) (Required): properties of the resource +* **properties**: [AWS.IoTWireless/WirelessDeviceProperties](#awsiotwirelesswirelessdeviceproperties) (Required, Identifier): properties of the resource ## Resource AWS.IoTWireless/WirelessGateway@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IoTWireless/WirelessGatewayProperties](#awsiotwirelesswirelessgatewayproperties) (Required): properties of the resource +* **properties**: [AWS.IoTWireless/WirelessGatewayProperties](#awsiotwirelesswirelessgatewayproperties) (Required, Identifier): properties of the resource + +## AbpV10x +### Properties +* **DevAddr**: string (Required) +* **SessionKeys**: [SessionKeysAbpV10x](#sessionkeysabpv10x) (Required) + +## AbpV11 +### Properties +* **DevAddr**: string (Required) +* **SessionKeys**: [SessionKeysAbpV11](#sessionkeysabpv11) (Required) ## AWS.IoTWireless/DestinationProperties ### Properties @@ -52,11 +62,6 @@ * **RoleArn**: string: AWS role ARN that grants access * **Tags**: [Tag](#tag)[]: A list of key-value pairs that contain metadata for the destination. -## Tag -### Properties -* **Key**: string -* **Value**: string - ## AWS.IoTWireless/FuotaTaskProperties ### Properties * **Arn**: string (ReadOnly): FUOTA task arn. Returned after successful create. @@ -73,16 +78,6 @@ * **Name**: string: Name of FUOTA task * **Tags**: [Tag](#tag)[]: A list of key-value pairs that contain metadata for the FUOTA task. -## LoRaWAN -### Properties -* **RfRegion**: string (Required): FUOTA task LoRaWAN RF region -* **StartTime**: string (ReadOnly): FUOTA task LoRaWAN start time - -## Tag -### Properties -* **Key**: string -* **Value**: string - ## AWS.IoTWireless/MulticastGroupProperties ### Properties * **Arn**: string (ReadOnly): Multicast group arn. Returned after successful create. @@ -95,18 +90,6 @@ * **Status**: string (ReadOnly): Multicast group status. Returned after successful read. * **Tags**: [Tag](#tag)[]: A list of key-value pairs that contain metadata for the Multicast group. -## LoRaWAN -### Properties -* **DlClass**: string (Required): Multicast group LoRaWAN DL Class -* **NumberOfDevicesInGroup**: int (ReadOnly): Multicast group number of devices in group. Returned after successful read. -* **NumberOfDevicesRequested**: int (ReadOnly): Multicast group number of devices requested. Returned after successful read. -* **RfRegion**: string (Required): Multicast group LoRaWAN RF region - -## Tag -### Properties -* **Key**: string -* **Value**: string - ## AWS.IoTWireless/NetworkAnalyzerConfigurationProperties ### Properties * **Arn**: string (ReadOnly): Arn for network analyzer configuration, Returned upon successful create. @@ -117,16 +100,6 @@ * **WirelessDevices**: string[]: List of wireless gateway resources that have been added to the network analyzer configuration * **WirelessGateways**: string[]: List of wireless gateway resources that have been added to the network analyzer configuration -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - -## NetworkAnalyzerConfiguration_TraceContent -### Properties -* **LogLevel**: string -* **WirelessDeviceFrameInfo**: string - ## AWS.IoTWireless/WirelessDeviceProperties ### Properties * **Arn**: string (ReadOnly): Wireless device arn. Returned after successful create. @@ -141,6 +114,30 @@ * **ThingName**: string (ReadOnly): Thing Arn. If there is a Thing created, this can be returned with a Get call. * **Type**: string (Required): Wireless device type, currently only Sidewalk and LoRa +## AWS.IoTWireless/WirelessGatewayProperties +### Properties +* **Arn**: string (ReadOnly): Arn for Wireless Gateway. Returned upon successful create. +* **Description**: string: Description of Wireless Gateway. +* **Id**: string (ReadOnly, Identifier): Id for Wireless Gateway. Returned upon successful create. +* **LastUplinkReceivedAt**: string: The date and time when the most recent uplink was received. +* **LoRaWAN**: [LoRaWANGateway](#lorawangateway) (Required): The combination of Package, Station and Model which represents the version of the LoRaWAN Wireless Gateway. +* **Name**: string: Name of Wireless Gateway. +* **Tags**: [Tag](#tag)[]: A list of key-value pairs that contain metadata for the gateway. +* **ThingArn**: string: Thing Arn. Passed into Update to associate a Thing with the Wireless Gateway. +* **ThingName**: string: Thing Name. If there is a Thing created, this can be returned with a Get call. + +## LoRaWAN +### Properties +* **RfRegion**: string (Required): FUOTA task LoRaWAN RF region +* **StartTime**: string (ReadOnly): FUOTA task LoRaWAN start time + +## LoRaWAN +### Properties +* **DlClass**: string (Required): Multicast group LoRaWAN DL Class +* **NumberOfDevicesInGroup**: int (ReadOnly): Multicast group number of devices in group. Returned after successful read. +* **NumberOfDevicesRequested**: int (ReadOnly): Multicast group number of devices requested. Returned after successful read. +* **RfRegion**: string (Required): Multicast group LoRaWAN RF region + ## LoRaWANDevice ### Properties * **AbpV10x**: [AbpV10x](#abpv10x) @@ -151,21 +148,32 @@ * **OtaaV11**: [OtaaV11](#otaav11) * **ServiceProfileId**: string -## AbpV10x +## LoRaWANGateway ### Properties -* **DevAddr**: string (Required) -* **SessionKeys**: [SessionKeysAbpV10x](#sessionkeysabpv10x) (Required) +* **GatewayEui**: string (Required) +* **RfRegion**: string (Required) + +## NetworkAnalyzerConfiguration_TraceContent +### Properties +* **LogLevel**: string +* **WirelessDeviceFrameInfo**: string + +## OtaaV10x +### Properties +* **AppEui**: string (Required) +* **AppKey**: string (Required) + +## OtaaV11 +### Properties +* **AppKey**: string (Required) +* **JoinEui**: string (Required) +* **NwkKey**: string (Required) ## SessionKeysAbpV10x ### Properties * **AppSKey**: string (Required) * **NwkSKey**: string (Required) -## AbpV11 -### Properties -* **DevAddr**: string (Required) -* **SessionKeys**: [SessionKeysAbpV11](#sessionkeysabpv11) (Required) - ## SessionKeysAbpV11 ### Properties * **AppSKey**: string (Required) @@ -173,38 +181,30 @@ * **NwkSEncKey**: string (Required) * **SNwkSIntKey**: string (Required) -## OtaaV10x +## Tag ### Properties -* **AppEui**: string (Required) -* **AppKey**: string (Required) +* **Key**: string +* **Value**: string -## OtaaV11 +## Tag ### Properties -* **AppKey**: string (Required) -* **JoinEui**: string (Required) -* **NwkKey**: string (Required) +* **Key**: string +* **Value**: string ## Tag ### Properties * **Key**: string * **Value**: string -## AWS.IoTWireless/WirelessGatewayProperties +## Tag ### Properties -* **Arn**: string (ReadOnly): Arn for Wireless Gateway. Returned upon successful create. -* **Description**: string: Description of Wireless Gateway. -* **Id**: string (ReadOnly, Identifier): Id for Wireless Gateway. Returned upon successful create. -* **LastUplinkReceivedAt**: string: The date and time when the most recent uplink was received. -* **LoRaWAN**: [LoRaWANGateway](#lorawangateway) (Required): The combination of Package, Station and Model which represents the version of the LoRaWAN Wireless Gateway. -* **Name**: string: Name of Wireless Gateway. -* **Tags**: [Tag](#tag)[]: A list of key-value pairs that contain metadata for the gateway. -* **ThingArn**: string: Thing Arn. Passed into Update to associate a Thing with the Wireless Gateway. -* **ThingName**: string: Thing Name. If there is a Thing created, this can be returned with a Get call. +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -## LoRaWANGateway +## Tag ### Properties -* **GatewayEui**: string (Required) -* **RfRegion**: string (Required) +* **Key**: string +* **Value**: string ## Tag ### Properties diff --git a/artifacts/bicep/aws/aws.ivs/default/types.json b/artifacts/bicep/aws/aws.ivs/default/types.json index b7edefe2..882e170c 100644 --- a/artifacts/bicep/aws/aws.ivs/default/types.json +++ b/artifacts/bicep/aws/aws.ivs/default/types.json @@ -1 +1,1042 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.IVS/ChannelProperties","Properties":{"Arn":{"Type":4,"Flags":18,"Description":"Channel ARN is automatically generated on creation and assigned as the unique identifier."},"Authorized":{"Type":2,"Flags":0,"Description":"Whether the channel is authorized."},"IngestEndpoint":{"Type":4,"Flags":2,"Description":"Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software."},"InsecureIngest":{"Type":2,"Flags":0,"Description":"Whether the channel allows insecure ingest."},"LatencyMode":{"Type":4,"Flags":0,"Description":"Channel latency mode."},"Name":{"Type":4,"Flags":0,"Description":"Channel"},"PlaybackUrl":{"Type":4,"Flags":2,"Description":"Channel Playback URL."},"Preset":{"Type":4,"Flags":0,"Description":"Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string (\"\")."},"RecordingConfigurationArn":{"Type":4,"Flags":0,"Description":"Recording Configuration ARN. A value other than an empty string indicates that recording is enabled. Default: \"\" (recording is disabled)."},"Tags":{"Type":10,"Flags":0,"Description":"A list of key-value pairs that contain metadata for the asset model."},"Type":{"Type":4,"Flags":0,"Description":"Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately."}}}},{"3":{"ItemType":8}},{"2":{"Name":"AWS.IVS/Channel","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":9,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IVS/Channel@default","ScopeType":0,"Body":11}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.IVS/PlaybackKeyPairProperties","Properties":{"Arn":{"Type":4,"Flags":18,"Description":"Key-pair identifier."},"Fingerprint":{"Type":4,"Flags":2,"Description":"Key-pair identifier."},"Name":{"Type":4,"Flags":0,"Description":"An arbitrary string (a nickname) assigned to a playback key pair that helps the customer identify that resource. The value does not need to be unique."},"PublicKeyMaterial":{"Type":4,"Flags":4,"Description":"The public portion of a customer-generated key pair."},"Tags":{"Type":15,"Flags":0,"Description":"A list of key-value pairs that contain metadata for the asset model."}}}},{"3":{"ItemType":13}},{"2":{"Name":"AWS.IVS/PlaybackKeyPair","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":14,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IVS/PlaybackKeyPair@default","ScopeType":0,"Body":16}},{"2":{"Name":"DestinationConfiguration","Properties":{"S3":{"Type":20,"Flags":0}}}},{"2":{"Name":"RenditionConfiguration","Properties":{"RenditionSelection":{"Type":4,"Flags":0,"Description":"Resolution Selection indicates which set of renditions are recorded for a stream."},"Renditions":{"Type":23,"Flags":0,"Description":"Renditions indicates which renditions are recorded for a stream."}}}},{"2":{"Name":"S3DestinationConfiguration","Properties":{"BucketName":{"Type":4,"Flags":1}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"ThumbnailConfiguration","Properties":{"RecordingMode":{"Type":4,"Flags":0,"Description":"Thumbnail Recording Mode, which determines whether thumbnails are recorded at an interval or are disabled."},"Resolution":{"Type":4,"Flags":0,"Description":"Resolution indicates the desired resolution of recorded thumbnails."},"Storage":{"Type":24,"Flags":0,"Description":"Storage indicates the format in which thumbnails are recorded."},"TargetIntervalSeconds":{"Type":3,"Flags":0,"Description":"Target Interval Seconds defines the interval at which thumbnails are recorded. This field is required if RecordingMode is INTERVAL."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.IVS/RecordingConfigurationProperties","Properties":{"Arn":{"Type":4,"Flags":18,"Description":"Recording Configuration ARN is automatically generated on creation and assigned as the unique identifier."},"DestinationConfiguration":{"Type":18,"Flags":1},"Name":{"Type":4,"Flags":0,"Description":"Recording Configuration Name."},"RecordingReconnectWindowSeconds":{"Type":3,"Flags":0,"Description":"Recording Reconnect Window Seconds. (0 means disabled)"},"RenditionConfiguration":{"Type":19,"Flags":0},"State":{"Type":4,"Flags":2,"Description":"Recording Configuration State."},"Tags":{"Type":26,"Flags":0,"Description":"A list of key-value pairs that contain metadata for the asset model."},"ThumbnailConfiguration":{"Type":22,"Flags":0}}}},{"3":{"ItemType":21}},{"2":{"Name":"AWS.IVS/RecordingConfiguration","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":25,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IVS/RecordingConfiguration@default","ScopeType":0,"Body":27}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.IVS/StreamKeyProperties","Properties":{"Arn":{"Type":4,"Flags":18,"Description":"Stream Key ARN is automatically generated on creation and assigned as the unique identifier."},"ChannelArn":{"Type":4,"Flags":1,"Description":"Channel ARN for the stream."},"Tags":{"Type":31,"Flags":0,"Description":"A list of key-value pairs that contain metadata for the asset model."},"Value":{"Type":4,"Flags":2,"Description":"Stream-key value."}}}},{"3":{"ItemType":29}},{"2":{"Name":"AWS.IVS/StreamKey","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":30,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IVS/StreamKey@default","ScopeType":0,"Body":32}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.IVS/ChannelProperties" + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ObjectType", + "name": "AWS.IVS/ChannelProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "Channel ARN is automatically generated on creation and assigned as the unique identifier." + }, + "Authorized": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "Whether the channel is authorized." + }, + "IngestEndpoint": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software." + }, + "InsecureIngest": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "Whether the channel allows insecure ingest." + }, + "LatencyMode": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Channel latency mode." + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Channel" + }, + "PlaybackUrl": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "Channel Playback URL." + }, + "Preset": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string (\"\")." + }, + "RecordingConfigurationArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Recording Configuration ARN. A value other than an empty string indicates that recording is enabled. Default: \"\" (recording is disabled)." + }, + "Tags": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "A list of key-value pairs that contain metadata for the asset model." + }, + "Type": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IVS/Channel", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/5" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IVS/Channel@default", + "scopeType": 0, + "body": { + "$ref": "#/6" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.IVS/EncoderConfigurationProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/8" + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "ObjectType", + "name": "EncoderConfiguration_Video", + "properties": { + "Bitrate": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "Bitrate for generated output, in bps. Default: 2500000." + }, + "Framerate": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "Video frame rate, in fps. Default: 30." + }, + "Height": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "Video-resolution height. Note that the maximum value is determined by width times height, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 720." + }, + "Width": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "Video-resolution width. Note that the maximum value is determined by width times height, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 1280." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IVS/EncoderConfigurationProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "Encoder configuration identifier." + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Encoder configuration name." + }, + "Tags": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + }, + "Video": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30 fps" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IVS/EncoderConfiguration", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/13" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IVS/EncoderConfiguration@default", + "scopeType": 0, + "body": { + "$ref": "#/14" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.IVS/PlaybackKeyPairProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/16" + } + }, + { + "$type": "ObjectType", + "name": "AWS.IVS/PlaybackKeyPairProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "Key-pair identifier." + }, + "Fingerprint": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "Key-pair identifier." + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "An arbitrary string (a nickname) assigned to a playback key pair that helps the customer identify that resource. The value does not need to be unique." + }, + "PublicKeyMaterial": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The public portion of a customer-generated key pair." + }, + "Tags": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "A list of key-value pairs that contain metadata for the asset model." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IVS/PlaybackKeyPair", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/19" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IVS/PlaybackKeyPair@default", + "scopeType": 0, + "body": { + "$ref": "#/20" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.IVS/PlaybackRestrictionPolicyProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/22" + } + }, + { + "$type": "ObjectType", + "name": "AWS.IVS/PlaybackRestrictionPolicyProperties", + "properties": { + "AllowedCountries": { + "type": { + "$ref": "#/24" + }, + "flags": 1, + "description": "A list of country codes that control geoblocking restriction. Allowed values are the officially assigned ISO 3166-1 alpha-2 codes. Default: All countries (an empty array)." + }, + "AllowedOrigins": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "A list of origin sites that control CORS restriction. Allowed values are the same as valid values of the Origin header defined at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin" + }, + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "Playback-restriction-policy identifier." + }, + "EnableStrictOriginEnforcement": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "Whether channel playback is constrained by origin site." + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Playback-restriction-policy name." + }, + "Tags": { + "type": { + "$ref": "#/26" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IVS/PlaybackRestrictionPolicy", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/27" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IVS/PlaybackRestrictionPolicy@default", + "scopeType": 0, + "body": { + "$ref": "#/28" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "DestinationConfiguration", + "properties": { + "S3": { + "type": { + "$ref": "#/32" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "RenditionConfiguration", + "properties": { + "RenditionSelection": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Resolution Selection indicates which set of renditions are recorded for a stream." + }, + "Renditions": { + "type": { + "$ref": "#/35" + }, + "flags": 0, + "description": "Renditions indicates which renditions are recorded for a stream." + } + } + }, + { + "$type": "ObjectType", + "name": "S3DestinationConfiguration", + "properties": { + "BucketName": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ThumbnailConfiguration", + "properties": { + "RecordingMode": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Thumbnail Recording Mode, which determines whether thumbnails are recorded at an interval or are disabled." + }, + "Resolution": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Resolution indicates the desired resolution of recorded thumbnails." + }, + "Storage": { + "type": { + "$ref": "#/36" + }, + "flags": 0, + "description": "Storage indicates the format in which thumbnails are recorded." + }, + "TargetIntervalSeconds": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "Target Interval Seconds defines the interval at which thumbnails are recorded. This field is required if RecordingMode is INTERVAL." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.IVS/RecordingConfigurationProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/33" + } + }, + { + "$type": "ObjectType", + "name": "AWS.IVS/RecordingConfigurationProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "Recording Configuration ARN is automatically generated on creation and assigned as the unique identifier." + }, + "DestinationConfiguration": { + "type": { + "$ref": "#/30" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Recording Configuration Name." + }, + "RecordingReconnectWindowSeconds": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "Recording Reconnect Window Seconds. (0 means disabled)" + }, + "RenditionConfiguration": { + "type": { + "$ref": "#/31" + }, + "flags": 0 + }, + "State": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "Recording Configuration State." + }, + "Tags": { + "type": { + "$ref": "#/38" + }, + "flags": 0, + "description": "A list of key-value pairs that contain metadata for the asset model." + }, + "ThumbnailConfiguration": { + "type": { + "$ref": "#/34" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IVS/RecordingConfiguration", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/39" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IVS/RecordingConfiguration@default", + "scopeType": 0, + "body": { + "$ref": "#/40" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.IVS/StageProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/42" + } + }, + { + "$type": "ObjectType", + "name": "AWS.IVS/StageProperties", + "properties": { + "ActiveSessionId": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "ID of the active session within the stage." + }, + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "Stage ARN is automatically generated on creation and assigned as the unique identifier." + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Stage name" + }, + "Tags": { + "type": { + "$ref": "#/44" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IVS/Stage", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/45" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IVS/Stage@default", + "scopeType": 0, + "body": { + "$ref": "#/46" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "S3StorageConfiguration", + "properties": { + "BucketName": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Location (S3 bucket name) where recorded videos will be stored. Note that the StorageConfiguration and S3 bucket must be in the same region as the Composition." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.IVS/StorageConfigurationProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/49" + } + }, + { + "$type": "ObjectType", + "name": "AWS.IVS/StorageConfigurationProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "Storage Configuration ARN is automatically generated on creation and assigned as the unique identifier." + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Storage Configuration Name." + }, + "S3": { + "type": { + "$ref": "#/48" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/51" + }, + "flags": 0, + "description": "A list of key-value pairs that contain metadata for the asset model." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IVS/StorageConfiguration", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/52" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IVS/StorageConfiguration@default", + "scopeType": 0, + "body": { + "$ref": "#/53" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.IVS/StreamKeyProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/55" + } + }, + { + "$type": "ObjectType", + "name": "AWS.IVS/StreamKeyProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "Stream Key ARN is automatically generated on creation and assigned as the unique identifier." + }, + "ChannelArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Channel ARN for the stream." + }, + "Tags": { + "type": { + "$ref": "#/57" + }, + "flags": 0, + "description": "A list of key-value pairs that contain metadata for the asset model." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "Stream-key value." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IVS/StreamKey", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/58" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IVS/StreamKey@default", + "scopeType": 0, + "body": { + "$ref": "#/59" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.ivs/default/types.md b/artifacts/bicep/aws/aws.ivs/default/types.md index f9754e72..f1894eb1 100644 --- a/artifacts/bicep/aws/aws.ivs/default/types.md +++ b/artifacts/bicep/aws/aws.ivs/default/types.md @@ -3,30 +3,58 @@ ## Resource AWS.IVS/Channel@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IVS/ChannelProperties](#awsivschannelproperties): properties of the resource +* **properties**: [AWS.IVS/ChannelProperties](#awsivschannelproperties) (Identifier): properties of the resource + +## Resource AWS.IVS/EncoderConfiguration@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.IVS/EncoderConfigurationProperties](#awsivsencoderconfigurationproperties) (Identifier): properties of the resource ## Resource AWS.IVS/PlaybackKeyPair@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IVS/PlaybackKeyPairProperties](#awsivsplaybackkeypairproperties): properties of the resource +* **properties**: [AWS.IVS/PlaybackKeyPairProperties](#awsivsplaybackkeypairproperties) (Identifier): properties of the resource + +## Resource AWS.IVS/PlaybackRestrictionPolicy@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.IVS/PlaybackRestrictionPolicyProperties](#awsivsplaybackrestrictionpolicyproperties) (Required, Identifier): properties of the resource ## Resource AWS.IVS/RecordingConfiguration@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IVS/RecordingConfigurationProperties](#awsivsrecordingconfigurationproperties) (Required): properties of the resource +* **properties**: [AWS.IVS/RecordingConfigurationProperties](#awsivsrecordingconfigurationproperties) (Required, Identifier): properties of the resource + +## Resource AWS.IVS/Stage@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.IVS/StageProperties](#awsivsstageproperties) (Identifier): properties of the resource + +## Resource AWS.IVS/StorageConfiguration@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.IVS/StorageConfigurationProperties](#awsivsstorageconfigurationproperties) (Required, Identifier): properties of the resource ## Resource AWS.IVS/StreamKey@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IVS/StreamKeyProperties](#awsivsstreamkeyproperties) (Required): properties of the resource +* **properties**: [AWS.IVS/StreamKeyProperties](#awsivsstreamkeyproperties) (Required, Identifier): properties of the resource ## AWS.IVS/ChannelProperties ### Properties @@ -42,10 +70,12 @@ * **Tags**: [Tag](#tag)[]: A list of key-value pairs that contain metadata for the asset model. * **Type**: string: Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. -## Tag +## AWS.IVS/EncoderConfigurationProperties ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **Arn**: string (ReadOnly, Identifier): Encoder configuration identifier. +* **Name**: string: Encoder configuration name. +* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. +* **Video**: [EncoderConfiguration_Video](#encoderconfigurationvideo): Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30 fps ## AWS.IVS/PlaybackKeyPairProperties ### Properties @@ -55,10 +85,14 @@ * **PublicKeyMaterial**: string (WriteOnly): The public portion of a customer-generated key pair. * **Tags**: [Tag](#tag)[]: A list of key-value pairs that contain metadata for the asset model. -## Tag +## AWS.IVS/PlaybackRestrictionPolicyProperties ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **AllowedCountries**: string[] (Required): A list of country codes that control geoblocking restriction. Allowed values are the officially assigned ISO 3166-1 alpha-2 codes. Default: All countries (an empty array). +* **AllowedOrigins**: string[] (Required): A list of origin sites that control CORS restriction. Allowed values are the same as valid values of the Origin header defined at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin +* **Arn**: string (ReadOnly, Identifier): Playback-restriction-policy identifier. +* **EnableStrictOriginEnforcement**: bool: Whether channel playback is constrained by origin site. +* **Name**: string: Playback-restriction-policy name. +* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. ## AWS.IVS/RecordingConfigurationProperties ### Properties @@ -71,40 +105,95 @@ * **Tags**: [Tag](#tag)[]: A list of key-value pairs that contain metadata for the asset model. * **ThumbnailConfiguration**: [ThumbnailConfiguration](#thumbnailconfiguration) +## AWS.IVS/StageProperties +### Properties +* **ActiveSessionId**: string (ReadOnly): ID of the active session within the stage. +* **Arn**: string (ReadOnly, Identifier): Stage ARN is automatically generated on creation and assigned as the unique identifier. +* **Name**: string: Stage name +* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. + +## AWS.IVS/StorageConfigurationProperties +### Properties +* **Arn**: string (ReadOnly, Identifier): Storage Configuration ARN is automatically generated on creation and assigned as the unique identifier. +* **Name**: string: Storage Configuration Name. +* **S3**: [S3StorageConfiguration](#s3storageconfiguration) (Required) +* **Tags**: [Tag](#tag)[]: A list of key-value pairs that contain metadata for the asset model. + +## AWS.IVS/StreamKeyProperties +### Properties +* **Arn**: string (ReadOnly, Identifier): Stream Key ARN is automatically generated on creation and assigned as the unique identifier. +* **ChannelArn**: string (Required): Channel ARN for the stream. +* **Tags**: [Tag](#tag)[]: A list of key-value pairs that contain metadata for the asset model. +* **Value**: string (ReadOnly): Stream-key value. + ## DestinationConfiguration ### Properties * **S3**: [S3DestinationConfiguration](#s3destinationconfiguration) -## S3DestinationConfiguration +## EncoderConfiguration_Video ### Properties -* **BucketName**: string (Required) +* **Bitrate**: int: Bitrate for generated output, in bps. Default: 2500000. +* **Framerate**: int: Video frame rate, in fps. Default: 30. +* **Height**: int: Video-resolution height. Note that the maximum value is determined by width times height, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 720. +* **Width**: int: Video-resolution width. Note that the maximum value is determined by width times height, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 1280. ## RenditionConfiguration ### Properties * **Renditions**: string[]: Renditions indicates which renditions are recorded for a stream. * **RenditionSelection**: string: Resolution Selection indicates which set of renditions are recorded for a stream. +## S3DestinationConfiguration +### Properties +* **BucketName**: string (Required) + +## S3StorageConfiguration +### Properties +* **BucketName**: string (Required): Location (S3 bucket name) where recorded videos will be stored. Note that the StorageConfiguration and S3 bucket must be in the same region as the Composition. + ## Tag ### Properties * **Key**: string (Required) * **Value**: string (Required) -## ThumbnailConfiguration +## Tag ### Properties -* **RecordingMode**: string: Thumbnail Recording Mode, which determines whether thumbnails are recorded at an interval or are disabled. -* **Resolution**: string: Resolution indicates the desired resolution of recorded thumbnails. -* **Storage**: string[]: Storage indicates the format in which thumbnails are recorded. -* **TargetIntervalSeconds**: int: Target Interval Seconds defines the interval at which thumbnails are recorded. This field is required if RecordingMode is INTERVAL. +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -## AWS.IVS/StreamKeyProperties +## Tag ### Properties -* **Arn**: string (ReadOnly, Identifier): Stream Key ARN is automatically generated on creation and assigned as the unique identifier. -* **ChannelArn**: string (Required): Channel ARN for the stream. -* **Tags**: [Tag](#tag)[]: A list of key-value pairs that contain metadata for the asset model. -* **Value**: string (ReadOnly): Stream-key value. +* **Key**: string (Required) +* **Value**: string (Required) + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) ## Tag ### Properties * **Key**: string (Required) * **Value**: string (Required) +## ThumbnailConfiguration +### Properties +* **RecordingMode**: string: Thumbnail Recording Mode, which determines whether thumbnails are recorded at an interval or are disabled. +* **Resolution**: string: Resolution indicates the desired resolution of recorded thumbnails. +* **Storage**: string[]: Storage indicates the format in which thumbnails are recorded. +* **TargetIntervalSeconds**: int: Target Interval Seconds defines the interval at which thumbnails are recorded. This field is required if RecordingMode is INTERVAL. + diff --git a/artifacts/bicep/aws/aws.ivschat/default/types.json b/artifacts/bicep/aws/aws.ivschat/default/types.json index 2467c882..91b69dae 100644 --- a/artifacts/bicep/aws/aws.ivschat/default/types.json +++ b/artifacts/bicep/aws/aws.ivschat/default/types.json @@ -1 +1,337 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"CloudWatchLogsDestinationConfiguration","Properties":{"LogGroupName":{"Type":4,"Flags":1,"Description":"Name of the Amazon CloudWatch Logs log group where chat activity will be logged."}}}},{"2":{"Name":"DestinationConfiguration","Properties":{"CloudWatchLogs":{"Type":8,"Flags":0},"Firehose":{"Type":10,"Flags":0},"S3":{"Type":11,"Flags":0}}}},{"2":{"Name":"FirehoseDestinationConfiguration","Properties":{"DeliveryStreamName":{"Type":4,"Flags":1,"Description":"Name of the Amazon Kinesis Firehose delivery stream where chat activity will be logged."}}}},{"2":{"Name":"S3DestinationConfiguration","Properties":{"BucketName":{"Type":4,"Flags":1,"Description":"Name of the Amazon S3 bucket where chat activity will be logged."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.IVSChat/LoggingConfigurationProperties","Properties":{"Arn":{"Type":4,"Flags":18,"Description":"LoggingConfiguration ARN is automatically generated on creation and assigned as the unique identifier."},"DestinationConfiguration":{"Type":9,"Flags":1},"Id":{"Type":4,"Flags":2,"Description":"The system-generated ID of the logging configuration."},"Name":{"Type":4,"Flags":0,"Description":"The name of the logging configuration. The value does not need to be unique."},"State":{"Type":4,"Flags":2,"Description":"The state of the logging configuration. When the state is ACTIVE, the configuration is ready to log chat content."},"Tags":{"Type":14,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."}}}},{"3":{"ItemType":12}},{"2":{"Name":"AWS.IVSChat/LoggingConfiguration","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":13,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IVSChat/LoggingConfiguration@default","ScopeType":0,"Body":15}},{"2":{"Name":"MessageReviewHandler","Properties":{"FallbackResult":{"Type":4,"Flags":0,"Description":"Specifies the fallback behavior if the handler does not return a valid response, encounters an error, or times out."},"Uri":{"Type":4,"Flags":0,"Description":"Identifier of the message review handler."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.IVSChat/RoomProperties","Properties":{"Arn":{"Type":4,"Flags":18,"Description":"Room ARN is automatically generated on creation and assigned as the unique identifier."},"Id":{"Type":4,"Flags":2,"Description":"The system-generated ID of the room."},"LoggingConfigurationIdentifiers":{"Type":20,"Flags":0,"Description":"Array of logging configuration identifiers attached to the room."},"MaximumMessageLength":{"Type":3,"Flags":0,"Description":"The maximum number of characters in a single message."},"MaximumMessageRatePerSecond":{"Type":3,"Flags":0,"Description":"The maximum number of messages per second that can be sent to the room."},"MessageReviewHandler":{"Type":17,"Flags":0},"Name":{"Type":4,"Flags":0,"Description":"The name of the room. The value does not need to be unique."},"Tags":{"Type":21,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":18}},{"2":{"Name":"AWS.IVSChat/Room","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":19,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.IVSChat/Room@default","ScopeType":0,"Body":22}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "CloudWatchLogsDestinationConfiguration", + "properties": { + "LogGroupName": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "Name of the Amazon CloudWatch Logs log group where chat activity will be logged." + } + } + }, + { + "$type": "ObjectType", + "name": "DestinationConfiguration", + "properties": { + "CloudWatchLogs": { + "type": { + "$ref": "#/0" + }, + "flags": 0 + }, + "Firehose": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "S3": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FirehoseDestinationConfiguration", + "properties": { + "DeliveryStreamName": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "Name of the Amazon Kinesis Firehose delivery stream where chat activity will be logged." + } + } + }, + { + "$type": "ObjectType", + "name": "S3DestinationConfiguration", + "properties": { + "BucketName": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "Name of the Amazon S3 bucket where chat activity will be logged." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.IVSChat/LoggingConfigurationProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ObjectType", + "name": "AWS.IVSChat/LoggingConfigurationProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/5" + }, + "flags": 18, + "description": "LoggingConfiguration ARN is automatically generated on creation and assigned as the unique identifier." + }, + "DestinationConfiguration": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Id": { + "type": { + "$ref": "#/5" + }, + "flags": 2, + "description": "The system-generated ID of the logging configuration." + }, + "Name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The name of the logging configuration. The value does not need to be unique." + }, + "State": { + "type": { + "$ref": "#/5" + }, + "flags": 2, + "description": "The state of the logging configuration. When the state is ACTIVE, the configuration is ready to log chat content." + }, + "Tags": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IVSChat/LoggingConfiguration", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/8" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IVSChat/LoggingConfiguration@default", + "scopeType": 0, + "body": { + "$ref": "#/9" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "MessageReviewHandler", + "properties": { + "FallbackResult": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "Specifies the fallback behavior if the handler does not return a valid response, encounters an error, or times out." + }, + "Uri": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "Identifier of the message review handler." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.IVSChat/RoomProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/12" + } + }, + { + "$type": "ObjectType", + "name": "AWS.IVSChat/RoomProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/5" + }, + "flags": 18, + "description": "Room ARN is automatically generated on creation and assigned as the unique identifier." + }, + "Id": { + "type": { + "$ref": "#/5" + }, + "flags": 2, + "description": "The system-generated ID of the room." + }, + "LoggingConfigurationIdentifiers": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "Array of logging configuration identifiers attached to the room." + }, + "MaximumMessageLength": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "The maximum number of characters in a single message." + }, + "MaximumMessageRatePerSecond": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "The maximum number of messages per second that can be sent to the room." + }, + "MessageReviewHandler": { + "type": { + "$ref": "#/11" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The name of the room. The value does not need to be unique." + }, + "Tags": { + "type": { + "$ref": "#/16" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.IVSChat/Room", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/17" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.IVSChat/Room@default", + "scopeType": 0, + "body": { + "$ref": "#/18" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.ivschat/default/types.md b/artifacts/bicep/aws/aws.ivschat/default/types.md index 3080ff31..0224b1af 100644 --- a/artifacts/bicep/aws/aws.ivschat/default/types.md +++ b/artifacts/bicep/aws/aws.ivschat/default/types.md @@ -3,16 +3,16 @@ ## Resource AWS.IVSChat/LoggingConfiguration@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IVSChat/LoggingConfigurationProperties](#awsivschatloggingconfigurationproperties) (Required): properties of the resource +* **properties**: [AWS.IVSChat/LoggingConfigurationProperties](#awsivschatloggingconfigurationproperties) (Required, Identifier): properties of the resource ## Resource AWS.IVSChat/Room@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.IVSChat/RoomProperties](#awsivschatroomproperties): properties of the resource +* **properties**: [AWS.IVSChat/RoomProperties](#awsivschatroomproperties) (Identifier): properties of the resource ## AWS.IVSChat/LoggingConfigurationProperties ### Properties @@ -23,20 +23,36 @@ * **State**: string (ReadOnly): The state of the logging configuration. When the state is ACTIVE, the configuration is ready to log chat content. * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. -## DestinationConfiguration +## AWS.IVSChat/RoomProperties ### Properties -* **CloudWatchLogs**: [CloudWatchLogsDestinationConfiguration](#cloudwatchlogsdestinationconfiguration) -* **Firehose**: [FirehoseDestinationConfiguration](#firehosedestinationconfiguration) -* **S3**: [S3DestinationConfiguration](#s3destinationconfiguration) +* **Arn**: string (ReadOnly, Identifier): Room ARN is automatically generated on creation and assigned as the unique identifier. +* **Id**: string (ReadOnly): The system-generated ID of the room. +* **LoggingConfigurationIdentifiers**: string[]: Array of logging configuration identifiers attached to the room. +* **MaximumMessageLength**: int: The maximum number of characters in a single message. +* **MaximumMessageRatePerSecond**: int: The maximum number of messages per second that can be sent to the room. +* **MessageReviewHandler**: [MessageReviewHandler](#messagereviewhandler) +* **Name**: string: The name of the room. The value does not need to be unique. +* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. ## CloudWatchLogsDestinationConfiguration ### Properties * **LogGroupName**: string (Required): Name of the Amazon CloudWatch Logs log group where chat activity will be logged. +## DestinationConfiguration +### Properties +* **CloudWatchLogs**: [CloudWatchLogsDestinationConfiguration](#cloudwatchlogsdestinationconfiguration) +* **Firehose**: [FirehoseDestinationConfiguration](#firehosedestinationconfiguration) +* **S3**: [S3DestinationConfiguration](#s3destinationconfiguration) + ## FirehoseDestinationConfiguration ### Properties * **DeliveryStreamName**: string (Required): Name of the Amazon Kinesis Firehose delivery stream where chat activity will be logged. +## MessageReviewHandler +### Properties +* **FallbackResult**: string: Specifies the fallback behavior if the handler does not return a valid response, encounters an error, or times out. +* **Uri**: string: Identifier of the message review handler. + ## S3DestinationConfiguration ### Properties * **BucketName**: string (Required): Name of the Amazon S3 bucket where chat activity will be logged. @@ -46,22 +62,6 @@ * **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. * **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -## AWS.IVSChat/RoomProperties -### Properties -* **Arn**: string (ReadOnly, Identifier): Room ARN is automatically generated on creation and assigned as the unique identifier. -* **Id**: string (ReadOnly): The system-generated ID of the room. -* **LoggingConfigurationIdentifiers**: string[]: Array of logging configuration identifiers attached to the room. -* **MaximumMessageLength**: int: The maximum number of characters in a single message. -* **MaximumMessageRatePerSecond**: int: The maximum number of messages per second that can be sent to the room. -* **MessageReviewHandler**: [MessageReviewHandler](#messagereviewhandler) -* **Name**: string: The name of the room. The value does not need to be unique. -* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. - -## MessageReviewHandler -### Properties -* **FallbackResult**: string: Specifies the fallback behavior if the handler does not return a valid response, encounters an error, or times out. -* **Uri**: string: Identifier of the message review handler. - ## Tag ### Properties * **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. diff --git a/artifacts/bicep/aws/aws.kafkaconnect/default/types.json b/artifacts/bicep/aws/aws.kafkaconnect/default/types.json index 19dff080..a4db74ea 100644 --- a/artifacts/bicep/aws/aws.kafkaconnect/default/types.json +++ b/artifacts/bicep/aws/aws.kafkaconnect/default/types.json @@ -1 +1,836 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"ApacheKafkaCluster","Properties":{"BootstrapServers":{"Type":4,"Flags":1,"Description":"The bootstrap servers string of the Apache Kafka cluster."},"Vpc":{"Type":25,"Flags":1}}}},{"2":{"Name":"AutoScaling","Properties":{"MaxWorkerCount":{"Type":3,"Flags":1,"Description":"The maximum number of workers for a connector."},"McuCount":{"Type":3,"Flags":1,"Description":"Specifies how many MSK Connect Units (MCU) as the minimum scaling unit."},"MinWorkerCount":{"Type":3,"Flags":1,"Description":"The minimum number of workers for a connector."},"ScaleInPolicy":{"Type":23,"Flags":1},"ScaleOutPolicy":{"Type":24,"Flags":1}}}},{"2":{"Name":"Capacity","Properties":{"AutoScaling":{"Type":9,"Flags":0},"ProvisionedCapacity":{"Type":21,"Flags":0}}}},{"2":{"Name":"CloudWatchLogsLogDelivery","Properties":{"Enabled":{"Type":2,"Flags":1,"Description":"Specifies whether the logs get sent to the specified CloudWatch Logs destination."},"LogGroup":{"Type":4,"Flags":0,"Description":"The CloudWatch log group that is the destination for log delivery."}}}},{"2":{"Name":"CustomPlugin","Properties":{"CustomPluginArn":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) of the custom plugin to use."},"Revision":{"Type":3,"Flags":1,"Description":"The revision of the custom plugin to use."}}}},{"2":{"Name":"FirehoseLogDelivery","Properties":{"DeliveryStream":{"Type":4,"Flags":0,"Description":"The Kinesis Data Firehose delivery stream that is the destination for log delivery."},"Enabled":{"Type":2,"Flags":1,"Description":"Specifies whether the logs get sent to the specified Kinesis Data Firehose delivery stream."}}}},{"2":{"Name":"KafkaCluster","Properties":{"ApacheKafkaCluster":{"Type":8,"Flags":1}}}},{"2":{"Name":"KafkaClusterClientAuthentication","Properties":{"AuthenticationType":{"Type":4,"Flags":1}}}},{"2":{"Name":"KafkaClusterClientAuthenticationType"}},{"2":{"Name":"KafkaClusterEncryptionInTransit","Properties":{"EncryptionType":{"Type":4,"Flags":1}}}},{"2":{"Name":"KafkaClusterEncryptionInTransitType"}},{"2":{"Name":"LogDelivery","Properties":{"WorkerLogDelivery":{"Type":27,"Flags":1}}}},{"2":{"Name":"Plugin","Properties":{"CustomPlugin":{"Type":12,"Flags":1}}}},{"2":{"Name":"ProvisionedCapacity","Properties":{"McuCount":{"Type":3,"Flags":0,"Description":"Specifies how many MSK Connect Units (MCU) are allocated to the connector."},"WorkerCount":{"Type":3,"Flags":1,"Description":"Number of workers for a connector."}}}},{"2":{"Name":"S3LogDelivery","Properties":{"Bucket":{"Type":4,"Flags":0,"Description":"The name of the S3 bucket that is the destination for log delivery."},"Enabled":{"Type":2,"Flags":1,"Description":"Specifies whether the logs get sent to the specified Amazon S3 destination."},"Prefix":{"Type":4,"Flags":0,"Description":"The S3 prefix that is the destination for log delivery."}}}},{"2":{"Name":"ScaleInPolicy","Properties":{"CpuUtilizationPercentage":{"Type":3,"Flags":1,"Description":"Specifies the CPU utilization percentage threshold at which connector scale in should trigger."}}}},{"2":{"Name":"ScaleOutPolicy","Properties":{"CpuUtilizationPercentage":{"Type":3,"Flags":1,"Description":"Specifies the CPU utilization percentage threshold at which connector scale out should trigger."}}}},{"2":{"Name":"Vpc","Properties":{"SecurityGroups":{"Type":28,"Flags":1,"Description":"The AWS security groups to associate with the elastic network interfaces in order to specify what the connector has access to."},"Subnets":{"Type":29,"Flags":1,"Description":"The list of subnets to connect to in the virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets."}}}},{"2":{"Name":"WorkerConfiguration","Properties":{"Revision":{"Type":3,"Flags":1,"Description":"The revision of the worker configuration to use."},"WorkerConfigurationArn":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) of the worker configuration to use."}}}},{"2":{"Name":"WorkerLogDelivery","Properties":{"CloudWatchLogs":{"Type":11,"Flags":0},"Firehose":{"Type":13,"Flags":0},"S3":{"Type":22,"Flags":0}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.KafkaConnect/ConnectorProperties","Properties":{"Capacity":{"Type":10,"Flags":1},"ConnectorArn":{"Type":4,"Flags":18,"Description":"Amazon Resource Name for the created Connector."},"ConnectorConfiguration":{"Type":31,"Flags":1,"Description":"The configuration for the connector."},"ConnectorDescription":{"Type":4,"Flags":0,"Description":"A summary description of the connector."},"ConnectorName":{"Type":4,"Flags":1,"Description":"The name of the connector."},"KafkaCluster":{"Type":14,"Flags":1},"KafkaClusterClientAuthentication":{"Type":15,"Flags":1},"KafkaClusterEncryptionInTransit":{"Type":17,"Flags":1},"KafkaConnectVersion":{"Type":4,"Flags":1,"Description":"The version of Kafka Connect. It has to be compatible with both the Kafka cluster's version and the plugins."},"LogDelivery":{"Type":19,"Flags":0},"Plugins":{"Type":32,"Flags":1,"Description":"List of plugins to use with the connector."},"ServiceExecutionRoleArn":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon S3 objects and other external resources."},"WorkerConfiguration":{"Type":26,"Flags":0}}}},{"2":{"Name":"Connector_ConnectorConfiguration","Properties":{}}},{"3":{"ItemType":20}},{"2":{"Name":"AWS.KafkaConnect/Connector","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":30,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.KafkaConnect/Connector@default","ScopeType":0,"Body":33}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "ApacheKafkaCluster", + "properties": { + "BootstrapServers": { + "type": { + "$ref": "#/21" + }, + "flags": 1, + "description": "The bootstrap servers string of the Apache Kafka cluster." + }, + "Vpc": { + "type": { + "$ref": "#/18" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AutoScaling", + "properties": { + "MaxWorkerCount": { + "type": { + "$ref": "#/22" + }, + "flags": 1, + "description": "The maximum number of workers for a connector." + }, + "McuCount": { + "type": { + "$ref": "#/22" + }, + "flags": 1, + "description": "Specifies how many MSK Connect Units (MCU) as the minimum scaling unit." + }, + "MinWorkerCount": { + "type": { + "$ref": "#/22" + }, + "flags": 1, + "description": "The minimum number of workers for a connector." + }, + "ScaleInPolicy": { + "type": { + "$ref": "#/15" + }, + "flags": 1 + }, + "ScaleOutPolicy": { + "type": { + "$ref": "#/16" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Capacity", + "properties": { + "AutoScaling": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "ProvisionedCapacity": { + "type": { + "$ref": "#/13" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CloudWatchLogsLogDelivery", + "properties": { + "Enabled": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "Specifies whether the logs get sent to the specified CloudWatch Logs destination." + }, + "LogGroup": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "The CloudWatch log group that is the destination for log delivery." + } + } + }, + { + "$type": "ObjectType", + "name": "CustomPlugin", + "properties": { + "CustomPluginArn": { + "type": { + "$ref": "#/21" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of the custom plugin to use." + }, + "Revision": { + "type": { + "$ref": "#/22" + }, + "flags": 1, + "description": "The revision of the custom plugin to use." + } + } + }, + { + "$type": "ObjectType", + "name": "FirehoseLogDelivery", + "properties": { + "DeliveryStream": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "The Kinesis Data Firehose delivery stream that is the destination for log delivery." + }, + "Enabled": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "Specifies whether the logs get sent to the specified Kinesis Data Firehose delivery stream." + } + } + }, + { + "$type": "ObjectType", + "name": "KafkaCluster", + "properties": { + "ApacheKafkaCluster": { + "type": { + "$ref": "#/0" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "KafkaClusterClientAuthentication", + "properties": { + "AuthenticationType": { + "type": { + "$ref": "#/21" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "KafkaClusterClientAuthenticationType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "KafkaClusterEncryptionInTransit", + "properties": { + "EncryptionType": { + "type": { + "$ref": "#/21" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "KafkaClusterEncryptionInTransitType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LogDelivery", + "properties": { + "WorkerLogDelivery": { + "type": { + "$ref": "#/20" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Plugin", + "properties": { + "CustomPlugin": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ProvisionedCapacity", + "properties": { + "McuCount": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "Specifies how many MSK Connect Units (MCU) are allocated to the connector." + }, + "WorkerCount": { + "type": { + "$ref": "#/22" + }, + "flags": 1, + "description": "Number of workers for a connector." + } + } + }, + { + "$type": "ObjectType", + "name": "S3LogDelivery", + "properties": { + "Bucket": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "The name of the S3 bucket that is the destination for log delivery." + }, + "Enabled": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "Specifies whether the logs get sent to the specified Amazon S3 destination." + }, + "Prefix": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "The S3 prefix that is the destination for log delivery." + } + } + }, + { + "$type": "ObjectType", + "name": "ScaleInPolicy", + "properties": { + "CpuUtilizationPercentage": { + "type": { + "$ref": "#/22" + }, + "flags": 1, + "description": "Specifies the CPU utilization percentage threshold at which connector scale in should trigger." + } + } + }, + { + "$type": "ObjectType", + "name": "ScaleOutPolicy", + "properties": { + "CpuUtilizationPercentage": { + "type": { + "$ref": "#/22" + }, + "flags": 1, + "description": "Specifies the CPU utilization percentage threshold at which connector scale out should trigger." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/21" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/21" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Vpc", + "properties": { + "SecurityGroups": { + "type": { + "$ref": "#/24" + }, + "flags": 1, + "description": "The AWS security groups to associate with the elastic network interfaces in order to specify what the connector has access to." + }, + "Subnets": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "The list of subnets to connect to in the virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets." + } + } + }, + { + "$type": "ObjectType", + "name": "WorkerConfiguration", + "properties": { + "Revision": { + "type": { + "$ref": "#/22" + }, + "flags": 1, + "description": "The revision of the worker configuration to use." + }, + "WorkerConfigurationArn": { + "type": { + "$ref": "#/21" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of the worker configuration to use." + } + } + }, + { + "$type": "ObjectType", + "name": "WorkerLogDelivery", + "properties": { + "CloudWatchLogs": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "Firehose": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "S3": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "IntegerType" + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/21" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/21" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.KafkaConnect/ConnectorProperties" + }, + { + "$type": "ObjectType", + "name": "Connector_ConnectorConfiguration", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/12" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/17" + } + }, + { + "$type": "ObjectType", + "name": "AWS.KafkaConnect/ConnectorProperties", + "properties": { + "Capacity": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "ConnectorArn": { + "type": { + "$ref": "#/21" + }, + "flags": 18, + "description": "Amazon Resource Name for the created Connector." + }, + "ConnectorConfiguration": { + "type": { + "$ref": "#/27" + }, + "flags": 1, + "description": "The configuration for the connector." + }, + "ConnectorDescription": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "A summary description of the connector." + }, + "ConnectorName": { + "type": { + "$ref": "#/21" + }, + "flags": 1, + "description": "The name of the connector." + }, + "KafkaCluster": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "KafkaClusterClientAuthentication": { + "type": { + "$ref": "#/7" + }, + "flags": 1 + }, + "KafkaClusterEncryptionInTransit": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + }, + "KafkaConnectVersion": { + "type": { + "$ref": "#/21" + }, + "flags": 1, + "description": "The version of Kafka Connect. It has to be compatible with both the Kafka cluster's version and the plugins." + }, + "LogDelivery": { + "type": { + "$ref": "#/11" + }, + "flags": 0 + }, + "Plugins": { + "type": { + "$ref": "#/28" + }, + "flags": 1, + "description": "List of plugins to use with the connector." + }, + "ServiceExecutionRoleArn": { + "type": { + "$ref": "#/21" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon S3 objects and other external resources." + }, + "Tags": { + "type": { + "$ref": "#/29" + }, + "flags": 0, + "description": "A collection of tags associated with a resource" + }, + "WorkerConfiguration": { + "type": { + "$ref": "#/19" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.KafkaConnect/Connector", + "properties": { + "name": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/21" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/30" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.KafkaConnect/Connector@default", + "scopeType": 0, + "body": { + "$ref": "#/31" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "CustomPluginFileDescription", + "properties": { + "FileMd5": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "The hex-encoded MD5 checksum of the custom plugin file. You can use it to validate the file." + }, + "FileSize": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "The size in bytes of the custom plugin file. You can use it to validate the file." + } + } + }, + { + "$type": "ObjectType", + "name": "CustomPluginLocation", + "properties": { + "S3Location": { + "type": { + "$ref": "#/35" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "S3Location", + "properties": { + "BucketArn": { + "type": { + "$ref": "#/21" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of an S3 bucket." + }, + "FileKey": { + "type": { + "$ref": "#/21" + }, + "flags": 1, + "description": "The file key for an object in an S3 bucket." + }, + "ObjectVersion": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "The version of an object in an S3 bucket." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/21" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/21" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.KafkaConnect/CustomPluginProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/36" + } + }, + { + "$type": "ObjectType", + "name": "AWS.KafkaConnect/CustomPluginProperties", + "properties": { + "ContentType": { + "type": { + "$ref": "#/21" + }, + "flags": 1, + "description": "The type of the plugin file." + }, + "CustomPluginArn": { + "type": { + "$ref": "#/21" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) of the custom plugin to use." + }, + "Description": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "A summary description of the custom plugin." + }, + "FileDescription": { + "type": { + "$ref": "#/33" + }, + "flags": 2 + }, + "Location": { + "type": { + "$ref": "#/34" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/21" + }, + "flags": 1, + "description": "The name of the custom plugin." + }, + "Revision": { + "type": { + "$ref": "#/22" + }, + "flags": 2, + "description": "The revision of the custom plugin." + }, + "Tags": { + "type": { + "$ref": "#/38" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.KafkaConnect/CustomPlugin", + "properties": { + "name": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/21" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/39" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.KafkaConnect/CustomPlugin@default", + "scopeType": 0, + "body": { + "$ref": "#/40" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/21" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/21" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.KafkaConnect/WorkerConfigurationProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/42" + } + }, + { + "$type": "ObjectType", + "name": "AWS.KafkaConnect/WorkerConfigurationProperties", + "properties": { + "Description": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "A summary description of the worker configuration." + }, + "Name": { + "type": { + "$ref": "#/21" + }, + "flags": 1, + "description": "The name of the worker configuration." + }, + "PropertiesFileContent": { + "type": { + "$ref": "#/21" + }, + "flags": 1, + "description": "Base64 encoded contents of connect-distributed.properties file." + }, + "Revision": { + "type": { + "$ref": "#/22" + }, + "flags": 2, + "description": "The description of a revision of the worker configuration." + }, + "Tags": { + "type": { + "$ref": "#/44" + }, + "flags": 0, + "description": "A collection of tags associated with a resource" + }, + "WorkerConfigurationArn": { + "type": { + "$ref": "#/21" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) of the custom configuration." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.KafkaConnect/WorkerConfiguration", + "properties": { + "name": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/21" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/45" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.KafkaConnect/WorkerConfiguration@default", + "scopeType": 0, + "body": { + "$ref": "#/46" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.kafkaconnect/default/types.md b/artifacts/bicep/aws/aws.kafkaconnect/default/types.md index 5c1c87ab..3a4a8810 100644 --- a/artifacts/bicep/aws/aws.kafkaconnect/default/types.md +++ b/artifacts/bicep/aws/aws.kafkaconnect/default/types.md @@ -3,9 +3,36 @@ ## Resource AWS.KafkaConnect/Connector@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.KafkaConnect/ConnectorProperties](#awskafkaconnectconnectorproperties) (Required): properties of the resource +* **properties**: [AWS.KafkaConnect/ConnectorProperties](#awskafkaconnectconnectorproperties) (Required, Identifier): properties of the resource + +## Resource AWS.KafkaConnect/CustomPlugin@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.KafkaConnect/CustomPluginProperties](#awskafkaconnectcustompluginproperties) (Required, Identifier): properties of the resource + +## Resource AWS.KafkaConnect/WorkerConfiguration@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.KafkaConnect/WorkerConfigurationProperties](#awskafkaconnectworkerconfigurationproperties) (Required, Identifier): properties of the resource + +## ApacheKafkaCluster +### Properties +* **BootstrapServers**: string (Required): The bootstrap servers string of the Apache Kafka cluster. +* **Vpc**: [Vpc](#vpc) (Required) + +## AutoScaling +### Properties +* **MaxWorkerCount**: int (Required): The maximum number of workers for a connector. +* **McuCount**: int (Required): Specifies how many MSK Connect Units (MCU) as the minimum scaling unit. +* **MinWorkerCount**: int (Required): The minimum number of workers for a connector. +* **ScaleInPolicy**: [ScaleInPolicy](#scaleinpolicy) (Required) +* **ScaleOutPolicy**: [ScaleOutPolicy](#scaleoutpolicy) (Required) ## AWS.KafkaConnect/ConnectorProperties ### Properties @@ -21,50 +48,64 @@ * **LogDelivery**: [LogDelivery](#logdelivery) * **Plugins**: [Plugin](#plugin)[] (Required): List of plugins to use with the connector. * **ServiceExecutionRoleArn**: string (Required): The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon S3 objects and other external resources. +* **Tags**: [Tag](#tag)[]: A collection of tags associated with a resource * **WorkerConfiguration**: [WorkerConfiguration](#workerconfiguration) +## AWS.KafkaConnect/CustomPluginProperties +### Properties +* **ContentType**: string (Required): The type of the plugin file. +* **CustomPluginArn**: string (ReadOnly, Identifier): The Amazon Resource Name (ARN) of the custom plugin to use. +* **Description**: string: A summary description of the custom plugin. +* **FileDescription**: [CustomPluginFileDescription](#custompluginfiledescription) (ReadOnly) +* **Location**: [CustomPluginLocation](#custompluginlocation) (Required) +* **Name**: string (Required): The name of the custom plugin. +* **Revision**: int (ReadOnly): The revision of the custom plugin. +* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. + +## AWS.KafkaConnect/WorkerConfigurationProperties +### Properties +* **Description**: string: A summary description of the worker configuration. +* **Name**: string (Required): The name of the worker configuration. +* **PropertiesFileContent**: string (Required): Base64 encoded contents of connect-distributed.properties file. +* **Revision**: int (ReadOnly): The description of a revision of the worker configuration. +* **Tags**: [Tag](#tag)[]: A collection of tags associated with a resource +* **WorkerConfigurationArn**: string (ReadOnly, Identifier): The Amazon Resource Name (ARN) of the custom configuration. + ## Capacity ### Properties * **AutoScaling**: [AutoScaling](#autoscaling) * **ProvisionedCapacity**: [ProvisionedCapacity](#provisionedcapacity) -## AutoScaling -### Properties -* **MaxWorkerCount**: int (Required): The maximum number of workers for a connector. -* **McuCount**: int (Required): Specifies how many MSK Connect Units (MCU) as the minimum scaling unit. -* **MinWorkerCount**: int (Required): The minimum number of workers for a connector. -* **ScaleInPolicy**: [ScaleInPolicy](#scaleinpolicy) (Required) -* **ScaleOutPolicy**: [ScaleOutPolicy](#scaleoutpolicy) (Required) - -## ScaleInPolicy +## CloudWatchLogsLogDelivery ### Properties -* **CpuUtilizationPercentage**: int (Required): Specifies the CPU utilization percentage threshold at which connector scale in should trigger. +* **Enabled**: bool (Required): Specifies whether the logs get sent to the specified CloudWatch Logs destination. +* **LogGroup**: string: The CloudWatch log group that is the destination for log delivery. -## ScaleOutPolicy +## Connector_ConnectorConfiguration ### Properties -* **CpuUtilizationPercentage**: int (Required): Specifies the CPU utilization percentage threshold at which connector scale out should trigger. -## ProvisionedCapacity +## CustomPlugin ### Properties -* **McuCount**: int: Specifies how many MSK Connect Units (MCU) are allocated to the connector. -* **WorkerCount**: int (Required): Number of workers for a connector. +* **CustomPluginArn**: string (Required): The Amazon Resource Name (ARN) of the custom plugin to use. +* **Revision**: int (Required): The revision of the custom plugin to use. -## Connector_ConnectorConfiguration +## CustomPluginFileDescription ### Properties +* **FileMd5**: string: The hex-encoded MD5 checksum of the custom plugin file. You can use it to validate the file. +* **FileSize**: int: The size in bytes of the custom plugin file. You can use it to validate the file. -## KafkaCluster +## CustomPluginLocation ### Properties -* **ApacheKafkaCluster**: [ApacheKafkaCluster](#apachekafkacluster) (Required) +* **S3Location**: [S3Location](#s3location) (Required) -## ApacheKafkaCluster +## FirehoseLogDelivery ### Properties -* **BootstrapServers**: string (Required): The bootstrap servers string of the Apache Kafka cluster. -* **Vpc**: [Vpc](#vpc) (Required) +* **DeliveryStream**: string: The Kinesis Data Firehose delivery stream that is the destination for log delivery. +* **Enabled**: bool (Required): Specifies whether the logs get sent to the specified Kinesis Data Firehose delivery stream. -## Vpc +## KafkaCluster ### Properties -* **SecurityGroups**: string[] (Required): The AWS security groups to associate with the elastic network interfaces in order to specify what the connector has access to. -* **Subnets**: string[] (Required): The list of subnets to connect to in the virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets. +* **ApacheKafkaCluster**: [ApacheKafkaCluster](#apachekafkacluster) (Required) ## KafkaClusterClientAuthentication ### Properties @@ -78,21 +119,20 @@ ### Properties * **WorkerLogDelivery**: [WorkerLogDelivery](#workerlogdelivery) (Required) -## WorkerLogDelivery +## Plugin ### Properties -* **CloudWatchLogs**: [CloudWatchLogsLogDelivery](#cloudwatchlogslogdelivery) -* **Firehose**: [FirehoseLogDelivery](#firehoselogdelivery) -* **S3**: [S3LogDelivery](#s3logdelivery) +* **CustomPlugin**: [CustomPlugin](#customplugin) (Required) -## CloudWatchLogsLogDelivery +## ProvisionedCapacity ### Properties -* **Enabled**: bool (Required): Specifies whether the logs get sent to the specified CloudWatch Logs destination. -* **LogGroup**: string: The CloudWatch log group that is the destination for log delivery. +* **McuCount**: int: Specifies how many MSK Connect Units (MCU) are allocated to the connector. +* **WorkerCount**: int (Required): Number of workers for a connector. -## FirehoseLogDelivery +## S3Location ### Properties -* **DeliveryStream**: string: The Kinesis Data Firehose delivery stream that is the destination for log delivery. -* **Enabled**: bool (Required): Specifies whether the logs get sent to the specified Kinesis Data Firehose delivery stream. +* **BucketArn**: string (Required): The Amazon Resource Name (ARN) of an S3 bucket. +* **FileKey**: string (Required): The file key for an object in an S3 bucket. +* **ObjectVersion**: string: The version of an object in an S3 bucket. ## S3LogDelivery ### Properties @@ -100,17 +140,42 @@ * **Enabled**: bool (Required): Specifies whether the logs get sent to the specified Amazon S3 destination. * **Prefix**: string: The S3 prefix that is the destination for log delivery. -## Plugin +## ScaleInPolicy ### Properties -* **CustomPlugin**: [CustomPlugin](#customplugin) (Required) +* **CpuUtilizationPercentage**: int (Required): Specifies the CPU utilization percentage threshold at which connector scale in should trigger. -## CustomPlugin +## ScaleOutPolicy ### Properties -* **CustomPluginArn**: string (Required): The Amazon Resource Name (ARN) of the custom plugin to use. -* **Revision**: int (Required): The revision of the custom plugin to use. +* **CpuUtilizationPercentage**: int (Required): Specifies the CPU utilization percentage threshold at which connector scale out should trigger. + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + +## Vpc +### Properties +* **SecurityGroups**: string[] (Required): The AWS security groups to associate with the elastic network interfaces in order to specify what the connector has access to. +* **Subnets**: string[] (Required): The list of subnets to connect to in the virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets. ## WorkerConfiguration ### Properties * **Revision**: int (Required): The revision of the worker configuration to use. * **WorkerConfigurationArn**: string (Required): The Amazon Resource Name (ARN) of the worker configuration to use. +## WorkerLogDelivery +### Properties +* **CloudWatchLogs**: [CloudWatchLogsLogDelivery](#cloudwatchlogslogdelivery) +* **Firehose**: [FirehoseLogDelivery](#firehoselogdelivery) +* **S3**: [S3LogDelivery](#s3logdelivery) + diff --git a/artifacts/bicep/aws/aws.kendra/default/types.json b/artifacts/bicep/aws/aws.kendra/default/types.json index 4e0f4a8d..9616b5a4 100644 --- a/artifacts/bicep/aws/aws.kendra/default/types.json +++ b/artifacts/bicep/aws/aws.kendra/default/types.json @@ -1 +1,3216 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"AccessControlListConfiguration","Properties":{"KeyPath":{"Type":4,"Flags":0}}}},{"2":{"Name":"AclConfiguration","Properties":{"AllowedGroupsColumnName":{"Type":4,"Flags":1}}}},{"2":{"Name":"Arn"}},{"2":{"Name":"ChangeDetectingColumns"}},{"2":{"Name":"ColumnConfiguration","Properties":{"ChangeDetectingColumns":{"Type":130,"Flags":1},"DocumentDataColumnName":{"Type":4,"Flags":1},"DocumentIdColumnName":{"Type":4,"Flags":1},"DocumentTitleColumnName":{"Type":4,"Flags":0},"FieldMappings":{"Type":131,"Flags":0}}}},{"2":{"Name":"ColumnName"}},{"2":{"Name":"ConditionOperator"}},{"2":{"Name":"ConfluenceAttachmentConfiguration","Properties":{"AttachmentFieldMappings":{"Type":132,"Flags":0},"CrawlAttachments":{"Type":2,"Flags":0}}}},{"2":{"Name":"ConfluenceAttachmentFieldMappingsList"}},{"2":{"Name":"ConfluenceAttachmentFieldName"}},{"2":{"Name":"ConfluenceAttachmentToIndexFieldMapping","Properties":{"DataSourceFieldName":{"Type":4,"Flags":1},"DateFieldFormat":{"Type":4,"Flags":0},"IndexFieldName":{"Type":4,"Flags":1}}}},{"2":{"Name":"ConfluenceBlogConfiguration","Properties":{"BlogFieldMappings":{"Type":134,"Flags":0}}}},{"2":{"Name":"ConfluenceBlogFieldMappingsList"}},{"2":{"Name":"ConfluenceBlogFieldName"}},{"2":{"Name":"ConfluenceBlogToIndexFieldMapping","Properties":{"DataSourceFieldName":{"Type":4,"Flags":1},"DateFieldFormat":{"Type":4,"Flags":0},"IndexFieldName":{"Type":4,"Flags":1}}}},{"2":{"Name":"ConfluenceConfiguration","Properties":{"AttachmentConfiguration":{"Type":15,"Flags":0},"BlogConfiguration":{"Type":19,"Flags":0},"ExclusionPatterns":{"Type":136,"Flags":0},"InclusionPatterns":{"Type":137,"Flags":0},"PageConfiguration":{"Type":24,"Flags":0},"SecretArn":{"Type":4,"Flags":1},"ServerUrl":{"Type":4,"Flags":1},"SpaceConfiguration":{"Type":28,"Flags":0},"Version":{"Type":4,"Flags":1},"VpcConfiguration":{"Type":42,"Flags":0}}}},{"2":{"Name":"ConfluencePageConfiguration","Properties":{"PageFieldMappings":{"Type":138,"Flags":0}}}},{"2":{"Name":"ConfluencePageFieldMappingsList"}},{"2":{"Name":"ConfluencePageFieldName"}},{"2":{"Name":"ConfluencePageToIndexFieldMapping","Properties":{"DataSourceFieldName":{"Type":4,"Flags":1},"DateFieldFormat":{"Type":4,"Flags":0},"IndexFieldName":{"Type":4,"Flags":1}}}},{"2":{"Name":"ConfluenceSpaceConfiguration","Properties":{"CrawlArchivedSpaces":{"Type":2,"Flags":0},"CrawlPersonalSpaces":{"Type":2,"Flags":0},"ExcludeSpaces":{"Type":140,"Flags":0},"IncludeSpaces":{"Type":141,"Flags":0},"SpaceFieldMappings":{"Type":142,"Flags":0}}}},{"2":{"Name":"ConfluenceSpaceFieldMappingsList"}},{"2":{"Name":"ConfluenceSpaceFieldName"}},{"2":{"Name":"ConfluenceSpaceIdentifier"}},{"2":{"Name":"ConfluenceSpaceList"}},{"2":{"Name":"ConfluenceSpaceToIndexFieldMapping","Properties":{"DataSourceFieldName":{"Type":4,"Flags":1},"DateFieldFormat":{"Type":4,"Flags":0},"IndexFieldName":{"Type":4,"Flags":1}}}},{"2":{"Name":"ConfluenceVersion"}},{"2":{"Name":"ConnectionConfiguration","Properties":{"DatabaseHost":{"Type":4,"Flags":1},"DatabaseName":{"Type":4,"Flags":1},"DatabasePort":{"Type":3,"Flags":1},"SecretArn":{"Type":4,"Flags":1},"TableName":{"Type":4,"Flags":1}}}},{"2":{"Name":"CustomDocumentEnrichmentConfiguration","Properties":{"InlineConfigurations":{"Type":145,"Flags":0},"PostExtractionHookConfiguration":{"Type":60,"Flags":0},"PreExtractionHookConfiguration":{"Type":60,"Flags":0},"RoleArn":{"Type":4,"Flags":0}}}},{"2":{"Name":"DataSourceConfiguration","Properties":{"ConfluenceConfiguration":{"Type":23,"Flags":0},"DatabaseConfiguration":{"Type":43,"Flags":0},"GoogleDriveConfiguration":{"Type":59,"Flags":0},"OneDriveConfiguration":{"Type":71,"Flags":0},"S3Configuration":{"Type":79,"Flags":0},"SalesforceConfiguration":{"Type":85,"Flags":0},"ServiceNowConfiguration":{"Type":101,"Flags":0},"SharePointConfiguration":{"Type":106,"Flags":0},"WebCrawlerConfiguration":{"Type":120,"Flags":0},"WorkDocsConfiguration":{"Type":128,"Flags":0}}}},{"2":{"Name":"DataSourceFieldName"}},{"2":{"Name":"DataSourceInclusionsExclusionsStrings"}},{"2":{"Name":"DataSourceToIndexFieldMapping","Properties":{"DataSourceFieldName":{"Type":4,"Flags":1},"DateFieldFormat":{"Type":4,"Flags":0},"IndexFieldName":{"Type":4,"Flags":1}}}},{"2":{"Name":"DataSourceToIndexFieldMappingList"}},{"2":{"Name":"DataSourceVpcConfiguration","Properties":{"SecurityGroupIds":{"Type":148,"Flags":1},"SubnetIds":{"Type":149,"Flags":1}}}},{"2":{"Name":"DatabaseConfiguration","Properties":{"AclConfiguration":{"Type":9,"Flags":0},"ColumnConfiguration":{"Type":12,"Flags":1},"ConnectionConfiguration":{"Type":35,"Flags":1},"DatabaseEngineType":{"Type":4,"Flags":1},"SqlConfiguration":{"Type":108,"Flags":0},"VpcConfiguration":{"Type":42,"Flags":0}}}},{"2":{"Name":"DatabaseEngineType"}},{"2":{"Name":"DatabaseHost"}},{"2":{"Name":"DatabaseName"}},{"2":{"Name":"DatabasePort"}},{"2":{"Name":"DateFieldFormat"}},{"2":{"Name":"Description"}},{"2":{"Name":"DisableLocalGroups"}},{"2":{"Name":"DocumentAttributeCondition","Properties":{"ConditionDocumentAttributeKey":{"Type":4,"Flags":1},"ConditionOnValue":{"Type":54,"Flags":0},"Operator":{"Type":4,"Flags":1}}}},{"2":{"Name":"DocumentAttributeKey"}},{"2":{"Name":"DocumentAttributeTarget","Properties":{"TargetDocumentAttributeKey":{"Type":4,"Flags":1},"TargetDocumentAttributeValue":{"Type":54,"Flags":0},"TargetDocumentAttributeValueDeletion":{"Type":2,"Flags":0}}}},{"2":{"Name":"DocumentAttributeValue","Properties":{"DateValue":{"Type":4,"Flags":0},"LongValue":{"Type":3,"Flags":0},"StringListValue":{"Type":150,"Flags":0},"StringValue":{"Type":4,"Flags":0}}}},{"2":{"Name":"DocumentsMetadataConfiguration","Properties":{"S3Prefix":{"Type":4,"Flags":0}}}},{"2":{"Name":"ExcludeMimeTypesList"}},{"2":{"Name":"ExcludeSharedDrivesList"}},{"2":{"Name":"ExcludeUserAccountsList"}},{"2":{"Name":"GoogleDriveConfiguration","Properties":{"ExcludeMimeTypes":{"Type":154,"Flags":0},"ExcludeSharedDrives":{"Type":155,"Flags":0},"ExcludeUserAccounts":{"Type":156,"Flags":0},"ExclusionPatterns":{"Type":157,"Flags":0},"FieldMappings":{"Type":158,"Flags":0},"InclusionPatterns":{"Type":159,"Flags":0},"SecretArn":{"Type":4,"Flags":1}}}},{"2":{"Name":"HookConfiguration","Properties":{"InvocationCondition":{"Type":51,"Flags":0},"LambdaArn":{"Type":4,"Flags":1},"S3Bucket":{"Type":4,"Flags":1}}}},{"2":{"Name":"Id"}},{"2":{"Name":"IndexFieldName"}},{"2":{"Name":"IndexId"}},{"2":{"Name":"InlineConfigurations"}},{"2":{"Name":"InlineCustomDocumentEnrichmentConfiguration","Properties":{"Condition":{"Type":51,"Flags":0},"DocumentContentDeletion":{"Type":2,"Flags":0},"Target":{"Type":53,"Flags":0}}}},{"2":{"Name":"LambdaArn"}},{"2":{"Name":"LanguageCode"}},{"2":{"Name":"Long"}},{"2":{"Name":"MimeType"}},{"2":{"Name":"Name"}},{"2":{"Name":"OneDriveConfiguration","Properties":{"DisableLocalGroups":{"Type":2,"Flags":0},"ExclusionPatterns":{"Type":161,"Flags":0},"FieldMappings":{"Type":162,"Flags":0},"InclusionPatterns":{"Type":163,"Flags":0},"OneDriveUsers":{"Type":74,"Flags":1},"SecretArn":{"Type":4,"Flags":1},"TenantDomain":{"Type":4,"Flags":1}}}},{"2":{"Name":"OneDriveUser"}},{"2":{"Name":"OneDriveUserList"}},{"2":{"Name":"OneDriveUsers","Properties":{"OneDriveUserList":{"Type":165,"Flags":0},"OneDriveUserS3Path":{"Type":81,"Flags":0}}}},{"2":{"Name":"ProxyConfiguration","Properties":{"Credentials":{"Type":4,"Flags":0},"Host":{"Type":4,"Flags":1},"Port":{"Type":3,"Flags":1}}}},{"2":{"Name":"QueryIdentifiersEnclosingOption"}},{"2":{"Name":"RoleArn"}},{"2":{"Name":"S3BucketName"}},{"2":{"Name":"S3DataSourceConfiguration","Properties":{"AccessControlListConfiguration":{"Type":8,"Flags":0},"BucketName":{"Type":4,"Flags":1},"DocumentsMetadataConfiguration":{"Type":55,"Flags":0},"ExclusionPatterns":{"Type":166,"Flags":0},"InclusionPatterns":{"Type":167,"Flags":0},"InclusionPrefixes":{"Type":168,"Flags":0}}}},{"2":{"Name":"S3ObjectKey"}},{"2":{"Name":"S3Path","Properties":{"Bucket":{"Type":4,"Flags":1},"Key":{"Type":4,"Flags":1}}}},{"2":{"Name":"SalesforceChatterFeedConfiguration","Properties":{"DocumentDataFieldName":{"Type":4,"Flags":1},"DocumentTitleFieldName":{"Type":4,"Flags":0},"FieldMappings":{"Type":169,"Flags":0},"IncludeFilterTypes":{"Type":170,"Flags":0}}}},{"2":{"Name":"SalesforceChatterFeedIncludeFilterType"}},{"2":{"Name":"SalesforceChatterFeedIncludeFilterTypes"}},{"2":{"Name":"SalesforceConfiguration","Properties":{"ChatterFeedConfiguration":{"Type":82,"Flags":0},"CrawlAttachments":{"Type":2,"Flags":0},"ExcludeAttachmentFilePatterns":{"Type":172,"Flags":0},"IncludeAttachmentFilePatterns":{"Type":173,"Flags":0},"KnowledgeArticleConfiguration":{"Type":89,"Flags":0},"SecretArn":{"Type":4,"Flags":1},"ServerUrl":{"Type":4,"Flags":1},"StandardObjectAttachmentConfiguration":{"Type":93,"Flags":0},"StandardObjectConfigurations":{"Type":174,"Flags":0}}}},{"2":{"Name":"SalesforceCustomKnowledgeArticleTypeConfiguration","Properties":{"DocumentDataFieldName":{"Type":4,"Flags":1},"DocumentTitleFieldName":{"Type":4,"Flags":0},"FieldMappings":{"Type":175,"Flags":0},"Name":{"Type":4,"Flags":1}}}},{"2":{"Name":"SalesforceCustomKnowledgeArticleTypeConfigurationList"}},{"2":{"Name":"SalesforceCustomKnowledgeArticleTypeName"}},{"2":{"Name":"SalesforceKnowledgeArticleConfiguration","Properties":{"CustomKnowledgeArticleTypeConfigurations":{"Type":177,"Flags":0},"IncludedStates":{"Type":178,"Flags":1},"StandardKnowledgeArticleTypeConfiguration":{"Type":92,"Flags":0}}}},{"2":{"Name":"SalesforceKnowledgeArticleState"}},{"2":{"Name":"SalesforceKnowledgeArticleStateList"}},{"2":{"Name":"SalesforceStandardKnowledgeArticleTypeConfiguration","Properties":{"DocumentDataFieldName":{"Type":4,"Flags":1},"DocumentTitleFieldName":{"Type":4,"Flags":0},"FieldMappings":{"Type":180,"Flags":0}}}},{"2":{"Name":"SalesforceStandardObjectAttachmentConfiguration","Properties":{"DocumentTitleFieldName":{"Type":4,"Flags":0},"FieldMappings":{"Type":181,"Flags":0}}}},{"2":{"Name":"SalesforceStandardObjectConfiguration","Properties":{"DocumentDataFieldName":{"Type":4,"Flags":1},"DocumentTitleFieldName":{"Type":4,"Flags":0},"FieldMappings":{"Type":182,"Flags":0},"Name":{"Type":4,"Flags":1}}}},{"2":{"Name":"SalesforceStandardObjectConfigurationList"}},{"2":{"Name":"SalesforceStandardObjectName"}},{"2":{"Name":"Schedule"}},{"2":{"Name":"SecretArn"}},{"2":{"Name":"ServiceNowAuthenticationType"}},{"2":{"Name":"ServiceNowBuildVersionType"}},{"2":{"Name":"ServiceNowConfiguration","Properties":{"AuthenticationType":{"Type":4,"Flags":0},"HostUrl":{"Type":4,"Flags":1},"KnowledgeArticleConfiguration":{"Type":103,"Flags":0},"SecretArn":{"Type":4,"Flags":1},"ServiceCatalogConfiguration":{"Type":105,"Flags":0},"ServiceNowBuildVersion":{"Type":4,"Flags":1}}}},{"2":{"Name":"ServiceNowHostUrl"}},{"2":{"Name":"ServiceNowKnowledgeArticleConfiguration","Properties":{"CrawlAttachments":{"Type":2,"Flags":0},"DocumentDataFieldName":{"Type":4,"Flags":1},"DocumentTitleFieldName":{"Type":4,"Flags":0},"ExcludeAttachmentFilePatterns":{"Type":184,"Flags":0},"FieldMappings":{"Type":185,"Flags":0},"FilterQuery":{"Type":4,"Flags":0},"IncludeAttachmentFilePatterns":{"Type":186,"Flags":0}}}},{"2":{"Name":"ServiceNowKnowledgeArticleFilterQuery"}},{"2":{"Name":"ServiceNowServiceCatalogConfiguration","Properties":{"CrawlAttachments":{"Type":2,"Flags":0},"DocumentDataFieldName":{"Type":4,"Flags":1},"DocumentTitleFieldName":{"Type":4,"Flags":0},"ExcludeAttachmentFilePatterns":{"Type":187,"Flags":0},"FieldMappings":{"Type":188,"Flags":0},"IncludeAttachmentFilePatterns":{"Type":189,"Flags":0}}}},{"2":{"Name":"SharePointConfiguration","Properties":{"CrawlAttachments":{"Type":2,"Flags":0},"DisableLocalGroups":{"Type":2,"Flags":0},"DocumentTitleFieldName":{"Type":4,"Flags":0},"ExclusionPatterns":{"Type":190,"Flags":0},"FieldMappings":{"Type":191,"Flags":0},"InclusionPatterns":{"Type":192,"Flags":0},"SecretArn":{"Type":4,"Flags":1},"SharePointVersion":{"Type":4,"Flags":1},"SslCertificateS3Path":{"Type":81,"Flags":0},"Urls":{"Type":193,"Flags":1},"UseChangeLog":{"Type":2,"Flags":0},"VpcConfiguration":{"Type":42,"Flags":0}}}},{"2":{"Name":"SharedDriveId"}},{"2":{"Name":"SqlConfiguration","Properties":{"QueryIdentifiersEnclosingOption":{"Type":4,"Flags":0}}}},{"2":{"Name":"TableName"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"A string used to identify this tag"},"Value":{"Type":4,"Flags":1,"Description":"A string containing the value for the tag"}}}},{"2":{"Name":"TagList"}},{"2":{"Name":"TenantDomain"}},{"2":{"Name":"Timestamp"}},{"2":{"Name":"Type"}},{"2":{"Name":"Url"}},{"2":{"Name":"UserAccount"}},{"2":{"Name":"WebCrawlerAuthenticationConfiguration","Properties":{"BasicAuthentication":{"Type":195,"Flags":0}}}},{"2":{"Name":"WebCrawlerBasicAuthentication","Properties":{"Credentials":{"Type":4,"Flags":1},"Host":{"Type":4,"Flags":1},"Port":{"Type":3,"Flags":1}}}},{"2":{"Name":"WebCrawlerBasicAuthenticationList"}},{"2":{"Name":"WebCrawlerConfiguration","Properties":{"AuthenticationConfiguration":{"Type":117,"Flags":0},"CrawlDepth":{"Type":3,"Flags":0},"MaxContentSizePerPageInMegaBytes":{"Type":3,"Flags":0},"MaxLinksPerPage":{"Type":3,"Flags":0},"MaxUrlsPerMinuteCrawlRate":{"Type":3,"Flags":0},"ProxyConfiguration":{"Type":75,"Flags":0},"UrlExclusionPatterns":{"Type":197,"Flags":0},"UrlInclusionPatterns":{"Type":198,"Flags":0},"Urls":{"Type":127,"Flags":1}}}},{"2":{"Name":"WebCrawlerSeedUrl"}},{"2":{"Name":"WebCrawlerSeedUrlConfiguration","Properties":{"SeedUrls":{"Type":199,"Flags":1},"WebCrawlerMode":{"Type":4,"Flags":0}}}},{"2":{"Name":"WebCrawlerSeedUrlList"}},{"2":{"Name":"WebCrawlerSiteMap"}},{"2":{"Name":"WebCrawlerSiteMaps"}},{"2":{"Name":"WebCrawlerSiteMapsConfiguration","Properties":{"SiteMaps":{"Type":202,"Flags":1}}}},{"2":{"Name":"WebCrawlerUrls","Properties":{"SeedUrlConfiguration":{"Type":122,"Flags":0},"SiteMapsConfiguration":{"Type":126,"Flags":0}}}},{"2":{"Name":"WorkDocsConfiguration","Properties":{"CrawlComments":{"Type":2,"Flags":0},"ExclusionPatterns":{"Type":203,"Flags":0},"FieldMappings":{"Type":204,"Flags":0},"InclusionPatterns":{"Type":205,"Flags":0},"OrganizationId":{"Type":4,"Flags":1},"UseChangeLog":{"Type":2,"Flags":0}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":40}},{"3":{"ItemType":18}},{"3":{"ItemType":18}},{"3":{"ItemType":22}},{"3":{"ItemType":22}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":27}},{"3":{"ItemType":27}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":33}},{"3":{"ItemType":33}},{"3":{"ItemType":4}},{"3":{"ItemType":65}},{"3":{"ItemType":4}},{"3":{"ItemType":40}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":40}},{"3":{"ItemType":4}},{"3":{"ItemType":65}},{"3":{"ItemType":4}},{"3":{"ItemType":40}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":40}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":94}},{"3":{"ItemType":40}},{"3":{"ItemType":86}},{"3":{"ItemType":86}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":40}},{"3":{"ItemType":40}},{"3":{"ItemType":40}},{"3":{"ItemType":94}},{"3":{"ItemType":4}},{"3":{"ItemType":40}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":40}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":40}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":110}},{"3":{"ItemType":118}},{"3":{"ItemType":118}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":40}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.Kendra/DataSourceProperties","Properties":{"Arn":{"Type":4,"Flags":2},"CustomDocumentEnrichmentConfiguration":{"Type":36,"Flags":0},"DataSourceConfiguration":{"Type":37,"Flags":0},"Description":{"Type":4,"Flags":0},"Id":{"Type":4,"Flags":18},"IndexId":{"Type":4,"Flags":17},"LanguageCode":{"Type":4,"Flags":0},"Name":{"Type":4,"Flags":1},"RoleArn":{"Type":4,"Flags":0},"Schedule":{"Type":4,"Flags":0},"Tags":{"Type":207,"Flags":0,"Description":"Tags for labeling the data source"},"Type":{"Type":4,"Flags":1}}}},{"3":{"ItemType":110}},{"2":{"Name":"AWS.Kendra/DataSource","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":206,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Kendra/DataSource@default","ScopeType":0,"Body":208}},{"2":{"Name":"Description"}},{"2":{"Name":"FaqName"}},{"2":{"Name":"FileFormat"}},{"2":{"Name":"Id"}},{"2":{"Name":"IndexId"}},{"2":{"Name":"RoleArn"}},{"2":{"Name":"S3BucketName"}},{"2":{"Name":"S3ObjectKey"}},{"2":{"Name":"S3Path","Properties":{"Bucket":{"Type":4,"Flags":1},"Key":{"Type":4,"Flags":1}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"A string used to identify this tag"},"Value":{"Type":4,"Flags":1,"Description":"A string containing the value for the tag"}}}},{"2":{"Name":"TagList"}},{"3":{"ItemType":219}},{"2":{"Name":"AWS.Kendra/FaqProperties","Properties":{"Arn":{"Type":4,"Flags":2},"Description":{"Type":4,"Flags":0,"Description":"FAQ description"},"FileFormat":{"Type":4,"Flags":0,"Description":"FAQ file format"},"Id":{"Type":4,"Flags":18},"IndexId":{"Type":4,"Flags":17,"Description":"Index ID"},"Name":{"Type":4,"Flags":1,"Description":"FAQ name"},"RoleArn":{"Type":4,"Flags":1,"Description":"FAQ role ARN"},"S3Path":{"Type":218,"Flags":1,"Description":"FAQ S3 path"},"Tags":{"Type":223,"Flags":0,"Description":"Tags for labeling the FAQ"}}}},{"3":{"ItemType":219}},{"2":{"Name":"AWS.Kendra/Faq","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":222,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Kendra/Faq@default","ScopeType":0,"Body":224}},{"2":{"Name":"Arn"}},{"2":{"Name":"CapacityUnitsConfiguration","Properties":{"QueryCapacityUnits":{"Type":3,"Flags":1},"StorageCapacityUnits":{"Type":3,"Flags":1}}}},{"2":{"Name":"ClaimRegex"}},{"2":{"Name":"Description"}},{"2":{"Name":"DocumentAttributeValueType"}},{"2":{"Name":"DocumentMetadataConfiguration","Properties":{"Name":{"Type":4,"Flags":1},"Relevance":{"Type":248,"Flags":0},"Search":{"Type":250,"Flags":0},"Type":{"Type":4,"Flags":1}}}},{"2":{"Name":"DocumentMetadataConfigurationList"}},{"2":{"Name":"DocumentMetadataConfigurationName"}},{"2":{"Name":"Duration"}},{"2":{"Name":"Edition"}},{"2":{"Name":"Freshness"}},{"2":{"Name":"GroupAttributeField"}},{"2":{"Name":"Id"}},{"2":{"Name":"Importance"}},{"2":{"Name":"Issuer"}},{"2":{"Name":"JsonTokenTypeConfiguration","Properties":{"GroupAttributeField":{"Type":4,"Flags":1},"UserNameAttributeField":{"Type":4,"Flags":1}}}},{"2":{"Name":"JwtTokenTypeConfiguration","Properties":{"ClaimRegex":{"Type":4,"Flags":0},"GroupAttributeField":{"Type":4,"Flags":0},"Issuer":{"Type":4,"Flags":0},"KeyLocation":{"Type":4,"Flags":1},"SecretManagerArn":{"Type":4,"Flags":0},"URL":{"Type":4,"Flags":0},"UserNameAttributeField":{"Type":4,"Flags":0}}}},{"2":{"Name":"KeyLocation"}},{"2":{"Name":"KmsKeyId"}},{"2":{"Name":"Name"}},{"2":{"Name":"Order"}},{"2":{"Name":"QueryCapacityUnits"}},{"2":{"Name":"Relevance","Properties":{"Duration":{"Type":4,"Flags":0},"Freshness":{"Type":2,"Flags":0},"Importance":{"Type":3,"Flags":0},"RankOrder":{"Type":4,"Flags":0},"ValueImportanceItems":{"Type":264,"Flags":0}}}},{"2":{"Name":"RoleArn"}},{"2":{"Name":"Search","Properties":{"Displayable":{"Type":2,"Flags":0},"Facetable":{"Type":2,"Flags":0},"Searchable":{"Type":2,"Flags":0},"Sortable":{"Type":2,"Flags":0}}}},{"2":{"Name":"ServerSideEncryptionConfiguration","Properties":{"KmsKeyId":{"Type":4,"Flags":0}}}},{"2":{"Name":"StorageCapacityUnits"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"A string used to identify this tag"},"Value":{"Type":4,"Flags":1,"Description":"A string containing the value for the tag"}}}},{"2":{"Name":"TagList"}},{"2":{"Name":"Url"}},{"2":{"Name":"UserContextPolicy"}},{"2":{"Name":"UserNameAttributeField"}},{"2":{"Name":"UserTokenConfiguration","Properties":{"JsonTokenTypeConfiguration":{"Type":241,"Flags":0},"JwtTokenTypeConfiguration":{"Type":242,"Flags":0}}}},{"2":{"Name":"UserTokenConfigurationList"}},{"2":{"Name":"ValueImportanceItem","Properties":{"Key":{"Type":4,"Flags":0},"Value":{"Type":3,"Flags":0}}}},{"2":{"Name":"ValueImportanceItemKey"}},{"2":{"Name":"ValueImportanceItems"}},{"3":{"ItemType":231}},{"3":{"ItemType":260}},{"3":{"ItemType":253}},{"3":{"ItemType":258}},{"3":{"ItemType":260}},{"2":{"Name":"AWS.Kendra/IndexProperties","Properties":{"Arn":{"Type":4,"Flags":2},"CapacityUnits":{"Type":227,"Flags":0,"Description":"Capacity units"},"Description":{"Type":4,"Flags":0,"Description":"A description for the index"},"DocumentMetadataConfigurations":{"Type":269,"Flags":0,"Description":"Document metadata configurations"},"Edition":{"Type":4,"Flags":1},"Id":{"Type":4,"Flags":18},"Name":{"Type":4,"Flags":1},"RoleArn":{"Type":4,"Flags":1},"ServerSideEncryptionConfiguration":{"Type":251,"Flags":0,"Description":"Server side encryption configuration"},"Tags":{"Type":270,"Flags":0,"Description":"Tags for labeling the index"},"UserContextPolicy":{"Type":4,"Flags":0},"UserTokenConfigurations":{"Type":271,"Flags":0}}}},{"3":{"ItemType":231}},{"3":{"ItemType":253}},{"3":{"ItemType":258}},{"2":{"Name":"AWS.Kendra/Index","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":268,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Kendra/Index@default","ScopeType":0,"Body":272}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "AccessControlListConfiguration", + "properties": { + "KeyPath": { + "type": { + "$ref": "#/121" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AclConfiguration", + "properties": { + "AllowedGroupsColumnName": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Arn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ChangeDetectingColumns", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ColumnConfiguration", + "properties": { + "ChangeDetectingColumns": { + "type": { + "$ref": "#/123" + }, + "flags": 1 + }, + "DocumentDataColumnName": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + }, + "DocumentIdColumnName": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + }, + "DocumentTitleColumnName": { + "type": { + "$ref": "#/121" + }, + "flags": 0 + }, + "FieldMappings": { + "type": { + "$ref": "#/124" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ColumnName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ConditionOperator", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ConfluenceAttachmentConfiguration", + "properties": { + "AttachmentFieldMappings": { + "type": { + "$ref": "#/125" + }, + "flags": 0 + }, + "CrawlAttachments": { + "type": { + "$ref": "#/126" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ConfluenceAttachmentFieldMappingsList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ConfluenceAttachmentFieldName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ConfluenceAttachmentToIndexFieldMapping", + "properties": { + "DataSourceFieldName": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + }, + "DateFieldFormat": { + "type": { + "$ref": "#/121" + }, + "flags": 0 + }, + "IndexFieldName": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ConfluenceBlogConfiguration", + "properties": { + "BlogFieldMappings": { + "type": { + "$ref": "#/128" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ConfluenceBlogFieldMappingsList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ConfluenceBlogFieldName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ConfluenceBlogToIndexFieldMapping", + "properties": { + "DataSourceFieldName": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + }, + "DateFieldFormat": { + "type": { + "$ref": "#/121" + }, + "flags": 0 + }, + "IndexFieldName": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ConfluenceConfiguration", + "properties": { + "AttachmentConfiguration": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "BlogConfiguration": { + "type": { + "$ref": "#/11" + }, + "flags": 0 + }, + "ExclusionPatterns": { + "type": { + "$ref": "#/130" + }, + "flags": 0 + }, + "InclusionPatterns": { + "type": { + "$ref": "#/131" + }, + "flags": 0 + }, + "PageConfiguration": { + "type": { + "$ref": "#/16" + }, + "flags": 0 + }, + "SecretArn": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + }, + "ServerUrl": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + }, + "SpaceConfiguration": { + "type": { + "$ref": "#/20" + }, + "flags": 0 + }, + "Version": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + }, + "VpcConfiguration": { + "type": { + "$ref": "#/34" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ConfluencePageConfiguration", + "properties": { + "PageFieldMappings": { + "type": { + "$ref": "#/132" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ConfluencePageFieldMappingsList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ConfluencePageFieldName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ConfluencePageToIndexFieldMapping", + "properties": { + "DataSourceFieldName": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + }, + "DateFieldFormat": { + "type": { + "$ref": "#/121" + }, + "flags": 0 + }, + "IndexFieldName": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ConfluenceSpaceConfiguration", + "properties": { + "CrawlArchivedSpaces": { + "type": { + "$ref": "#/126" + }, + "flags": 0 + }, + "CrawlPersonalSpaces": { + "type": { + "$ref": "#/126" + }, + "flags": 0 + }, + "ExcludeSpaces": { + "type": { + "$ref": "#/134" + }, + "flags": 0 + }, + "IncludeSpaces": { + "type": { + "$ref": "#/135" + }, + "flags": 0 + }, + "SpaceFieldMappings": { + "type": { + "$ref": "#/136" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ConfluenceSpaceFieldMappingsList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ConfluenceSpaceFieldName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ConfluenceSpaceIdentifier", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ConfluenceSpaceList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ConfluenceSpaceToIndexFieldMapping", + "properties": { + "DataSourceFieldName": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + }, + "DateFieldFormat": { + "type": { + "$ref": "#/121" + }, + "flags": 0 + }, + "IndexFieldName": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ConfluenceVersion", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ConnectionConfiguration", + "properties": { + "DatabaseHost": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + }, + "DatabaseName": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + }, + "DatabasePort": { + "type": { + "$ref": "#/139" + }, + "flags": 1 + }, + "SecretArn": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + }, + "TableName": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomDocumentEnrichmentConfiguration", + "properties": { + "InlineConfigurations": { + "type": { + "$ref": "#/140" + }, + "flags": 0 + }, + "PostExtractionHookConfiguration": { + "type": { + "$ref": "#/52" + }, + "flags": 0 + }, + "PreExtractionHookConfiguration": { + "type": { + "$ref": "#/52" + }, + "flags": 0 + }, + "RoleArn": { + "type": { + "$ref": "#/121" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DataSourceConfiguration", + "properties": { + "ConfluenceConfiguration": { + "type": { + "$ref": "#/15" + }, + "flags": 0 + }, + "DatabaseConfiguration": { + "type": { + "$ref": "#/35" + }, + "flags": 0 + }, + "GoogleDriveConfiguration": { + "type": { + "$ref": "#/51" + }, + "flags": 0 + }, + "OneDriveConfiguration": { + "type": { + "$ref": "#/63" + }, + "flags": 0 + }, + "S3Configuration": { + "type": { + "$ref": "#/71" + }, + "flags": 0 + }, + "SalesforceConfiguration": { + "type": { + "$ref": "#/77" + }, + "flags": 0 + }, + "ServiceNowConfiguration": { + "type": { + "$ref": "#/93" + }, + "flags": 0 + }, + "SharePointConfiguration": { + "type": { + "$ref": "#/98" + }, + "flags": 0 + }, + "WebCrawlerConfiguration": { + "type": { + "$ref": "#/112" + }, + "flags": 0 + }, + "WorkDocsConfiguration": { + "type": { + "$ref": "#/120" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DataSourceFieldName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DataSourceInclusionsExclusionsStrings", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DataSourceToIndexFieldMapping", + "properties": { + "DataSourceFieldName": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + }, + "DateFieldFormat": { + "type": { + "$ref": "#/121" + }, + "flags": 0 + }, + "IndexFieldName": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DataSourceToIndexFieldMappingList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DataSourceVpcConfiguration", + "properties": { + "SecurityGroupIds": { + "type": { + "$ref": "#/143" + }, + "flags": 1 + }, + "SubnetIds": { + "type": { + "$ref": "#/144" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DatabaseConfiguration", + "properties": { + "AclConfiguration": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "ColumnConfiguration": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + }, + "ConnectionConfiguration": { + "type": { + "$ref": "#/27" + }, + "flags": 1 + }, + "DatabaseEngineType": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + }, + "SqlConfiguration": { + "type": { + "$ref": "#/100" + }, + "flags": 0 + }, + "VpcConfiguration": { + "type": { + "$ref": "#/34" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DatabaseEngineType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DatabaseHost", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DatabaseName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DatabasePort", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DateFieldFormat", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Description", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DisableLocalGroups", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DocumentAttributeCondition", + "properties": { + "ConditionDocumentAttributeKey": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + }, + "ConditionOnValue": { + "type": { + "$ref": "#/46" + }, + "flags": 0 + }, + "Operator": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DocumentAttributeKey", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DocumentAttributeTarget", + "properties": { + "TargetDocumentAttributeKey": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + }, + "TargetDocumentAttributeValue": { + "type": { + "$ref": "#/46" + }, + "flags": 0 + }, + "TargetDocumentAttributeValueDeletion": { + "type": { + "$ref": "#/126" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DocumentAttributeValue", + "properties": { + "DateValue": { + "type": { + "$ref": "#/121" + }, + "flags": 0 + }, + "LongValue": { + "type": { + "$ref": "#/139" + }, + "flags": 0 + }, + "StringListValue": { + "type": { + "$ref": "#/145" + }, + "flags": 0 + }, + "StringValue": { + "type": { + "$ref": "#/121" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DocumentsMetadataConfiguration", + "properties": { + "S3Prefix": { + "type": { + "$ref": "#/121" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ExcludeMimeTypesList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ExcludeSharedDrivesList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ExcludeUserAccountsList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "GoogleDriveConfiguration", + "properties": { + "ExcludeMimeTypes": { + "type": { + "$ref": "#/149" + }, + "flags": 0 + }, + "ExcludeSharedDrives": { + "type": { + "$ref": "#/150" + }, + "flags": 0 + }, + "ExcludeUserAccounts": { + "type": { + "$ref": "#/151" + }, + "flags": 0 + }, + "ExclusionPatterns": { + "type": { + "$ref": "#/152" + }, + "flags": 0 + }, + "FieldMappings": { + "type": { + "$ref": "#/153" + }, + "flags": 0 + }, + "InclusionPatterns": { + "type": { + "$ref": "#/154" + }, + "flags": 0 + }, + "SecretArn": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "HookConfiguration", + "properties": { + "InvocationCondition": { + "type": { + "$ref": "#/43" + }, + "flags": 0 + }, + "LambdaArn": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + }, + "S3Bucket": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Id", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "IndexFieldName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "IndexId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "InlineConfigurations", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "InlineCustomDocumentEnrichmentConfiguration", + "properties": { + "Condition": { + "type": { + "$ref": "#/43" + }, + "flags": 0 + }, + "DocumentContentDeletion": { + "type": { + "$ref": "#/126" + }, + "flags": 0 + }, + "Target": { + "type": { + "$ref": "#/45" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "LambdaArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LanguageCode", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Long", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MimeType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Name", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "OneDriveConfiguration", + "properties": { + "DisableLocalGroups": { + "type": { + "$ref": "#/126" + }, + "flags": 0 + }, + "ExclusionPatterns": { + "type": { + "$ref": "#/156" + }, + "flags": 0 + }, + "FieldMappings": { + "type": { + "$ref": "#/157" + }, + "flags": 0 + }, + "InclusionPatterns": { + "type": { + "$ref": "#/158" + }, + "flags": 0 + }, + "OneDriveUsers": { + "type": { + "$ref": "#/66" + }, + "flags": 1 + }, + "SecretArn": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + }, + "TenantDomain": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "OneDriveUser", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "OneDriveUserList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "OneDriveUsers", + "properties": { + "OneDriveUserList": { + "type": { + "$ref": "#/160" + }, + "flags": 0 + }, + "OneDriveUserS3Path": { + "type": { + "$ref": "#/73" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ProxyConfiguration", + "properties": { + "Credentials": { + "type": { + "$ref": "#/121" + }, + "flags": 0 + }, + "Host": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + }, + "Port": { + "type": { + "$ref": "#/139" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "QueryIdentifiersEnclosingOption", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RoleArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "S3BucketName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "S3DataSourceConfiguration", + "properties": { + "AccessControlListConfiguration": { + "type": { + "$ref": "#/0" + }, + "flags": 0 + }, + "BucketName": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + }, + "DocumentsMetadataConfiguration": { + "type": { + "$ref": "#/47" + }, + "flags": 0 + }, + "ExclusionPatterns": { + "type": { + "$ref": "#/161" + }, + "flags": 0 + }, + "InclusionPatterns": { + "type": { + "$ref": "#/162" + }, + "flags": 0 + }, + "InclusionPrefixes": { + "type": { + "$ref": "#/163" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "S3ObjectKey", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "S3Path", + "properties": { + "Bucket": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + }, + "Key": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "SalesforceChatterFeedConfiguration", + "properties": { + "DocumentDataFieldName": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + }, + "DocumentTitleFieldName": { + "type": { + "$ref": "#/121" + }, + "flags": 0 + }, + "FieldMappings": { + "type": { + "$ref": "#/164" + }, + "flags": 0 + }, + "IncludeFilterTypes": { + "type": { + "$ref": "#/165" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SalesforceChatterFeedIncludeFilterType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SalesforceChatterFeedIncludeFilterTypes", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SalesforceConfiguration", + "properties": { + "ChatterFeedConfiguration": { + "type": { + "$ref": "#/74" + }, + "flags": 0 + }, + "CrawlAttachments": { + "type": { + "$ref": "#/126" + }, + "flags": 0 + }, + "ExcludeAttachmentFilePatterns": { + "type": { + "$ref": "#/167" + }, + "flags": 0 + }, + "IncludeAttachmentFilePatterns": { + "type": { + "$ref": "#/168" + }, + "flags": 0 + }, + "KnowledgeArticleConfiguration": { + "type": { + "$ref": "#/81" + }, + "flags": 0 + }, + "SecretArn": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + }, + "ServerUrl": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + }, + "StandardObjectAttachmentConfiguration": { + "type": { + "$ref": "#/85" + }, + "flags": 0 + }, + "StandardObjectConfigurations": { + "type": { + "$ref": "#/169" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SalesforceCustomKnowledgeArticleTypeConfiguration", + "properties": { + "DocumentDataFieldName": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + }, + "DocumentTitleFieldName": { + "type": { + "$ref": "#/121" + }, + "flags": 0 + }, + "FieldMappings": { + "type": { + "$ref": "#/170" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "SalesforceCustomKnowledgeArticleTypeConfigurationList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SalesforceCustomKnowledgeArticleTypeName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SalesforceKnowledgeArticleConfiguration", + "properties": { + "CustomKnowledgeArticleTypeConfigurations": { + "type": { + "$ref": "#/172" + }, + "flags": 0 + }, + "IncludedStates": { + "type": { + "$ref": "#/173" + }, + "flags": 1 + }, + "StandardKnowledgeArticleTypeConfiguration": { + "type": { + "$ref": "#/84" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SalesforceKnowledgeArticleState", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SalesforceKnowledgeArticleStateList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SalesforceStandardKnowledgeArticleTypeConfiguration", + "properties": { + "DocumentDataFieldName": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + }, + "DocumentTitleFieldName": { + "type": { + "$ref": "#/121" + }, + "flags": 0 + }, + "FieldMappings": { + "type": { + "$ref": "#/175" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SalesforceStandardObjectAttachmentConfiguration", + "properties": { + "DocumentTitleFieldName": { + "type": { + "$ref": "#/121" + }, + "flags": 0 + }, + "FieldMappings": { + "type": { + "$ref": "#/176" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SalesforceStandardObjectConfiguration", + "properties": { + "DocumentDataFieldName": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + }, + "DocumentTitleFieldName": { + "type": { + "$ref": "#/121" + }, + "flags": 0 + }, + "FieldMappings": { + "type": { + "$ref": "#/177" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "SalesforceStandardObjectConfigurationList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SalesforceStandardObjectName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Schedule", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SecretArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ServiceNowAuthenticationType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ServiceNowBuildVersionType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ServiceNowConfiguration", + "properties": { + "AuthenticationType": { + "type": { + "$ref": "#/121" + }, + "flags": 0 + }, + "HostUrl": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + }, + "KnowledgeArticleConfiguration": { + "type": { + "$ref": "#/95" + }, + "flags": 0 + }, + "SecretArn": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + }, + "ServiceCatalogConfiguration": { + "type": { + "$ref": "#/97" + }, + "flags": 0 + }, + "ServiceNowBuildVersion": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ServiceNowHostUrl", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ServiceNowKnowledgeArticleConfiguration", + "properties": { + "CrawlAttachments": { + "type": { + "$ref": "#/126" + }, + "flags": 0 + }, + "DocumentDataFieldName": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + }, + "DocumentTitleFieldName": { + "type": { + "$ref": "#/121" + }, + "flags": 0 + }, + "ExcludeAttachmentFilePatterns": { + "type": { + "$ref": "#/179" + }, + "flags": 0 + }, + "FieldMappings": { + "type": { + "$ref": "#/180" + }, + "flags": 0 + }, + "FilterQuery": { + "type": { + "$ref": "#/121" + }, + "flags": 0 + }, + "IncludeAttachmentFilePatterns": { + "type": { + "$ref": "#/181" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ServiceNowKnowledgeArticleFilterQuery", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ServiceNowServiceCatalogConfiguration", + "properties": { + "CrawlAttachments": { + "type": { + "$ref": "#/126" + }, + "flags": 0 + }, + "DocumentDataFieldName": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + }, + "DocumentTitleFieldName": { + "type": { + "$ref": "#/121" + }, + "flags": 0 + }, + "ExcludeAttachmentFilePatterns": { + "type": { + "$ref": "#/182" + }, + "flags": 0 + }, + "FieldMappings": { + "type": { + "$ref": "#/183" + }, + "flags": 0 + }, + "IncludeAttachmentFilePatterns": { + "type": { + "$ref": "#/184" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SharePointConfiguration", + "properties": { + "CrawlAttachments": { + "type": { + "$ref": "#/126" + }, + "flags": 0 + }, + "DisableLocalGroups": { + "type": { + "$ref": "#/126" + }, + "flags": 0 + }, + "DocumentTitleFieldName": { + "type": { + "$ref": "#/121" + }, + "flags": 0 + }, + "ExclusionPatterns": { + "type": { + "$ref": "#/185" + }, + "flags": 0 + }, + "FieldMappings": { + "type": { + "$ref": "#/186" + }, + "flags": 0 + }, + "InclusionPatterns": { + "type": { + "$ref": "#/187" + }, + "flags": 0 + }, + "SecretArn": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + }, + "SharePointVersion": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + }, + "SslCertificateS3Path": { + "type": { + "$ref": "#/73" + }, + "flags": 0 + }, + "Urls": { + "type": { + "$ref": "#/188" + }, + "flags": 1 + }, + "UseChangeLog": { + "type": { + "$ref": "#/126" + }, + "flags": 0 + }, + "VpcConfiguration": { + "type": { + "$ref": "#/34" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SharedDriveId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SqlConfiguration", + "properties": { + "QueryIdentifiersEnclosingOption": { + "type": { + "$ref": "#/121" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/121" + }, + "flags": 1, + "description": "A string used to identify this tag" + }, + "Value": { + "type": { + "$ref": "#/121" + }, + "flags": 1, + "description": "A string containing the value for the tag" + } + } + }, + { + "$type": "ObjectType", + "name": "TagList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TenantDomain", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Timestamp", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Type", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Url", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "UserAccount", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "WebCrawlerAuthenticationConfiguration", + "properties": { + "BasicAuthentication": { + "type": { + "$ref": "#/190" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "WebCrawlerBasicAuthentication", + "properties": { + "Credentials": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + }, + "Host": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + }, + "Port": { + "type": { + "$ref": "#/139" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "WebCrawlerBasicAuthenticationList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "WebCrawlerConfiguration", + "properties": { + "AuthenticationConfiguration": { + "type": { + "$ref": "#/109" + }, + "flags": 0 + }, + "CrawlDepth": { + "type": { + "$ref": "#/139" + }, + "flags": 0 + }, + "MaxContentSizePerPageInMegaBytes": { + "type": { + "$ref": "#/139" + }, + "flags": 0 + }, + "MaxLinksPerPage": { + "type": { + "$ref": "#/139" + }, + "flags": 0 + }, + "MaxUrlsPerMinuteCrawlRate": { + "type": { + "$ref": "#/139" + }, + "flags": 0 + }, + "ProxyConfiguration": { + "type": { + "$ref": "#/67" + }, + "flags": 0 + }, + "UrlExclusionPatterns": { + "type": { + "$ref": "#/192" + }, + "flags": 0 + }, + "UrlInclusionPatterns": { + "type": { + "$ref": "#/193" + }, + "flags": 0 + }, + "Urls": { + "type": { + "$ref": "#/119" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "WebCrawlerSeedUrl", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "WebCrawlerSeedUrlConfiguration", + "properties": { + "SeedUrls": { + "type": { + "$ref": "#/194" + }, + "flags": 1 + }, + "WebCrawlerMode": { + "type": { + "$ref": "#/121" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "WebCrawlerSeedUrlList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "WebCrawlerSiteMap", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "WebCrawlerSiteMaps", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "WebCrawlerSiteMapsConfiguration", + "properties": { + "SiteMaps": { + "type": { + "$ref": "#/197" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "WebCrawlerUrls", + "properties": { + "SeedUrlConfiguration": { + "type": { + "$ref": "#/114" + }, + "flags": 0 + }, + "SiteMapsConfiguration": { + "type": { + "$ref": "#/118" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "WorkDocsConfiguration", + "properties": { + "CrawlComments": { + "type": { + "$ref": "#/126" + }, + "flags": 0 + }, + "ExclusionPatterns": { + "type": { + "$ref": "#/198" + }, + "flags": 0 + }, + "FieldMappings": { + "type": { + "$ref": "#/199" + }, + "flags": 0 + }, + "InclusionPatterns": { + "type": { + "$ref": "#/200" + }, + "flags": 0 + }, + "OrganizationId": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + }, + "UseChangeLog": { + "type": { + "$ref": "#/126" + }, + "flags": 0 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/121" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/121" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/32" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/10" + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/10" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/14" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/14" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/121" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/121" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/19" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/19" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/121" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/121" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/25" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/25" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/121" + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/57" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/121" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/32" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/121" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/121" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/121" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/121" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/121" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/121" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/121" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/121" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/121" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/121" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/32" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/121" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/57" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/121" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/32" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/121" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/121" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/121" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/121" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/121" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/121" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/32" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/121" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/121" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/121" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/121" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/86" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/32" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/78" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/78" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/121" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/121" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/32" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/32" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/32" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/86" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/121" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/32" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/121" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/121" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/32" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/121" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/121" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/32" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/121" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/121" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/102" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/110" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/110" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/121" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/121" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/121" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/121" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/121" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/121" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/121" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/32" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/121" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Kendra/DataSourceProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/102" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Kendra/DataSourceProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/121" + }, + "flags": 2 + }, + "CustomDocumentEnrichmentConfiguration": { + "type": { + "$ref": "#/28" + }, + "flags": 0 + }, + "DataSourceConfiguration": { + "type": { + "$ref": "#/29" + }, + "flags": 0 + }, + "Description": { + "type": { + "$ref": "#/121" + }, + "flags": 0 + }, + "Id": { + "type": { + "$ref": "#/121" + }, + "flags": 18 + }, + "IndexId": { + "type": { + "$ref": "#/121" + }, + "flags": 17 + }, + "LanguageCode": { + "type": { + "$ref": "#/121" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + }, + "RoleArn": { + "type": { + "$ref": "#/121" + }, + "flags": 0 + }, + "Schedule": { + "type": { + "$ref": "#/121" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/202" + }, + "flags": 0, + "description": "Tags for labeling the data source" + }, + "Type": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Kendra/DataSource", + "properties": { + "name": { + "type": { + "$ref": "#/121" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/121" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/203" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Kendra/DataSource@default", + "scopeType": 0, + "body": { + "$ref": "#/204" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Description", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "FaqName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "FileFormat", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Id", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "IndexId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LanguageCode", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RoleArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "S3BucketName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "S3ObjectKey", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "S3Path", + "properties": { + "Bucket": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + }, + "Key": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/121" + }, + "flags": 1, + "description": "A string used to identify this tag" + }, + "Value": { + "type": { + "$ref": "#/121" + }, + "flags": 1, + "description": "A string containing the value for the tag" + } + } + }, + { + "$type": "ObjectType", + "name": "TagList", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/216" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Kendra/FaqProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/216" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Kendra/FaqProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/121" + }, + "flags": 2 + }, + "Description": { + "type": { + "$ref": "#/121" + }, + "flags": 0, + "description": "FAQ description" + }, + "FileFormat": { + "type": { + "$ref": "#/121" + }, + "flags": 0, + "description": "FAQ file format" + }, + "Id": { + "type": { + "$ref": "#/121" + }, + "flags": 18 + }, + "IndexId": { + "type": { + "$ref": "#/121" + }, + "flags": 17, + "description": "Index ID" + }, + "LanguageCode": { + "type": { + "$ref": "#/121" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/121" + }, + "flags": 1, + "description": "FAQ name" + }, + "RoleArn": { + "type": { + "$ref": "#/121" + }, + "flags": 1, + "description": "FAQ role ARN" + }, + "S3Path": { + "type": { + "$ref": "#/215" + }, + "flags": 1, + "description": "FAQ S3 path" + }, + "Tags": { + "type": { + "$ref": "#/220" + }, + "flags": 0, + "description": "Tags for labeling the FAQ" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Kendra/Faq", + "properties": { + "name": { + "type": { + "$ref": "#/121" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/121" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/221" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Kendra/Faq@default", + "scopeType": 0, + "body": { + "$ref": "#/222" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Arn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CapacityUnitsConfiguration", + "properties": { + "QueryCapacityUnits": { + "type": { + "$ref": "#/139" + }, + "flags": 1 + }, + "StorageCapacityUnits": { + "type": { + "$ref": "#/139" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ClaimRegex", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Description", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DocumentAttributeValueType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DocumentMetadataConfiguration", + "properties": { + "Name": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + }, + "Relevance": { + "type": { + "$ref": "#/246" + }, + "flags": 0 + }, + "Search": { + "type": { + "$ref": "#/248" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DocumentMetadataConfigurationList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DocumentMetadataConfigurationName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Duration", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Edition", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Freshness", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "GroupAttributeField", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Id", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Importance", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Issuer", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "JsonTokenTypeConfiguration", + "properties": { + "GroupAttributeField": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + }, + "UserNameAttributeField": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "JwtTokenTypeConfiguration", + "properties": { + "ClaimRegex": { + "type": { + "$ref": "#/121" + }, + "flags": 0 + }, + "GroupAttributeField": { + "type": { + "$ref": "#/121" + }, + "flags": 0 + }, + "Issuer": { + "type": { + "$ref": "#/121" + }, + "flags": 0 + }, + "KeyLocation": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + }, + "SecretManagerArn": { + "type": { + "$ref": "#/121" + }, + "flags": 0 + }, + "URL": { + "type": { + "$ref": "#/121" + }, + "flags": 0 + }, + "UserNameAttributeField": { + "type": { + "$ref": "#/121" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "KeyLocation", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "KmsKeyId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Name", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Order", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "QueryCapacityUnits", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Relevance", + "properties": { + "Duration": { + "type": { + "$ref": "#/121" + }, + "flags": 0 + }, + "Freshness": { + "type": { + "$ref": "#/126" + }, + "flags": 0 + }, + "Importance": { + "type": { + "$ref": "#/139" + }, + "flags": 0 + }, + "RankOrder": { + "type": { + "$ref": "#/121" + }, + "flags": 0 + }, + "ValueImportanceItems": { + "type": { + "$ref": "#/262" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "RoleArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Search", + "properties": { + "Displayable": { + "type": { + "$ref": "#/126" + }, + "flags": 0 + }, + "Facetable": { + "type": { + "$ref": "#/126" + }, + "flags": 0 + }, + "Searchable": { + "type": { + "$ref": "#/126" + }, + "flags": 0 + }, + "Sortable": { + "type": { + "$ref": "#/126" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ServerSideEncryptionConfiguration", + "properties": { + "KmsKeyId": { + "type": { + "$ref": "#/121" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "StorageCapacityUnits", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/121" + }, + "flags": 1, + "description": "A string used to identify this tag" + }, + "Value": { + "type": { + "$ref": "#/121" + }, + "flags": 1, + "description": "A string containing the value for the tag" + } + } + }, + { + "$type": "ObjectType", + "name": "TagList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Url", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "UserContextPolicy", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "UserNameAttributeField", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "UserTokenConfiguration", + "properties": { + "JsonTokenTypeConfiguration": { + "type": { + "$ref": "#/239" + }, + "flags": 0 + }, + "JwtTokenTypeConfiguration": { + "type": { + "$ref": "#/240" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "UserTokenConfigurationList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ValueImportanceItem", + "properties": { + "Key": { + "type": { + "$ref": "#/121" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/139" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ValueImportanceItemKey", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ValueImportanceItems", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/229" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/258" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/251" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/256" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/258" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Kendra/IndexProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/229" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/251" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/256" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Kendra/IndexProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/121" + }, + "flags": 2 + }, + "CapacityUnits": { + "type": { + "$ref": "#/225" + }, + "flags": 0, + "description": "Capacity units" + }, + "Description": { + "type": { + "$ref": "#/121" + }, + "flags": 0, + "description": "A description for the index" + }, + "DocumentMetadataConfigurations": { + "type": { + "$ref": "#/267" + }, + "flags": 0, + "description": "Document metadata configurations" + }, + "Edition": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + }, + "Id": { + "type": { + "$ref": "#/121" + }, + "flags": 18 + }, + "Name": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + }, + "RoleArn": { + "type": { + "$ref": "#/121" + }, + "flags": 1 + }, + "ServerSideEncryptionConfiguration": { + "type": { + "$ref": "#/249" + }, + "flags": 0, + "description": "Server side encryption configuration" + }, + "Tags": { + "type": { + "$ref": "#/268" + }, + "flags": 0, + "description": "Tags for labeling the index" + }, + "UserContextPolicy": { + "type": { + "$ref": "#/121" + }, + "flags": 0 + }, + "UserTokenConfigurations": { + "type": { + "$ref": "#/269" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Kendra/Index", + "properties": { + "name": { + "type": { + "$ref": "#/121" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/121" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/270" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Kendra/Index@default", + "scopeType": 0, + "body": { + "$ref": "#/271" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.kendra/default/types.md b/artifacts/bicep/aws/aws.kendra/default/types.md index e6679081..f9d41e7b 100644 --- a/artifacts/bicep/aws/aws.kendra/default/types.md +++ b/artifacts/bicep/aws/aws.kendra/default/types.md @@ -3,23 +3,31 @@ ## Resource AWS.Kendra/DataSource@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Kendra/DataSourceProperties](#awskendradatasourceproperties) (Required): properties of the resource +* **properties**: [AWS.Kendra/DataSourceProperties](#awskendradatasourceproperties) (Required, Identifier): properties of the resource ## Resource AWS.Kendra/Faq@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Kendra/FaqProperties](#awskendrafaqproperties) (Required): properties of the resource +* **properties**: [AWS.Kendra/FaqProperties](#awskendrafaqproperties) (Required, Identifier): properties of the resource ## Resource AWS.Kendra/Index@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Kendra/IndexProperties](#awskendraindexproperties) (Required): properties of the resource +* **properties**: [AWS.Kendra/IndexProperties](#awskendraindexproperties) (Required, Identifier): properties of the resource + +## AccessControlListConfiguration +### Properties +* **KeyPath**: string + +## AclConfiguration +### Properties +* **AllowedGroupsColumnName**: string (Required) ## AWS.Kendra/DataSourceProperties ### Properties @@ -36,69 +44,46 @@ * **Tags**: [Tag](#tag)[]: Tags for labeling the data source * **Type**: string (Required) -## CustomDocumentEnrichmentConfiguration -### Properties -* **InlineConfigurations**: [InlineCustomDocumentEnrichmentConfiguration](#inlinecustomdocumentenrichmentconfiguration)[] -* **PostExtractionHookConfiguration**: [HookConfiguration](#hookconfiguration) -* **PreExtractionHookConfiguration**: [HookConfiguration](#hookconfiguration) -* **RoleArn**: string - -## InlineCustomDocumentEnrichmentConfiguration -### Properties -* **Condition**: [DocumentAttributeCondition](#documentattributecondition) -* **DocumentContentDeletion**: bool -* **Target**: [DocumentAttributeTarget](#documentattributetarget) - -## DocumentAttributeCondition -### Properties -* **ConditionDocumentAttributeKey**: string (Required) -* **ConditionOnValue**: [DocumentAttributeValue](#documentattributevalue) -* **Operator**: string (Required) - -## DocumentAttributeValue -### Properties -* **DateValue**: string -* **LongValue**: int -* **StringListValue**: string[] -* **StringValue**: string - -## DocumentAttributeTarget +## AWS.Kendra/FaqProperties ### Properties -* **TargetDocumentAttributeKey**: string (Required) -* **TargetDocumentAttributeValue**: [DocumentAttributeValue](#documentattributevalue) -* **TargetDocumentAttributeValueDeletion**: bool +* **Arn**: string (ReadOnly) +* **Description**: string: FAQ description +* **FileFormat**: string: FAQ file format +* **Id**: string (ReadOnly, Identifier) +* **IndexId**: string (Required, Identifier): Index ID +* **LanguageCode**: string +* **Name**: string (Required): FAQ name +* **RoleArn**: string (Required): FAQ role ARN +* **S3Path**: [S3Path](#s3path) (Required): FAQ S3 path +* **Tags**: [Tag](#tag)[]: Tags for labeling the FAQ -## HookConfiguration +## AWS.Kendra/IndexProperties ### Properties -* **InvocationCondition**: [DocumentAttributeCondition](#documentattributecondition) -* **LambdaArn**: string (Required) -* **S3Bucket**: string (Required) +* **Arn**: string (ReadOnly) +* **CapacityUnits**: [CapacityUnitsConfiguration](#capacityunitsconfiguration): Capacity units +* **Description**: string: A description for the index +* **DocumentMetadataConfigurations**: [DocumentMetadataConfiguration](#documentmetadataconfiguration)[]: Document metadata configurations +* **Edition**: string (Required) +* **Id**: string (ReadOnly, Identifier) +* **Name**: string (Required) +* **RoleArn**: string (Required) +* **ServerSideEncryptionConfiguration**: [ServerSideEncryptionConfiguration](#serversideencryptionconfiguration): Server side encryption configuration +* **Tags**: [Tag](#tag)[]: Tags for labeling the index +* **UserContextPolicy**: string +* **UserTokenConfigurations**: [UserTokenConfiguration](#usertokenconfiguration)[] -## DataSourceConfiguration +## CapacityUnitsConfiguration ### Properties -* **ConfluenceConfiguration**: [ConfluenceConfiguration](#confluenceconfiguration) -* **DatabaseConfiguration**: [DatabaseConfiguration](#databaseconfiguration) -* **GoogleDriveConfiguration**: [GoogleDriveConfiguration](#googledriveconfiguration) -* **OneDriveConfiguration**: [OneDriveConfiguration](#onedriveconfiguration) -* **S3Configuration**: [S3DataSourceConfiguration](#s3datasourceconfiguration) -* **SalesforceConfiguration**: [SalesforceConfiguration](#salesforceconfiguration) -* **ServiceNowConfiguration**: [ServiceNowConfiguration](#servicenowconfiguration) -* **SharePointConfiguration**: [SharePointConfiguration](#sharepointconfiguration) -* **WebCrawlerConfiguration**: [WebCrawlerConfiguration](#webcrawlerconfiguration) -* **WorkDocsConfiguration**: [WorkDocsConfiguration](#workdocsconfiguration) +* **QueryCapacityUnits**: int (Required) +* **StorageCapacityUnits**: int (Required) -## ConfluenceConfiguration +## ColumnConfiguration ### Properties -* **AttachmentConfiguration**: [ConfluenceAttachmentConfiguration](#confluenceattachmentconfiguration) -* **BlogConfiguration**: [ConfluenceBlogConfiguration](#confluenceblogconfiguration) -* **ExclusionPatterns**: string[] -* **InclusionPatterns**: string[] -* **PageConfiguration**: [ConfluencePageConfiguration](#confluencepageconfiguration) -* **SecretArn**: string (Required) -* **ServerUrl**: string (Required) -* **SpaceConfiguration**: [ConfluenceSpaceConfiguration](#confluencespaceconfiguration) -* **Version**: string (Required) -* **VpcConfiguration**: [DataSourceVpcConfiguration](#datasourcevpcconfiguration) +* **ChangeDetectingColumns**: string[] (Required) +* **DocumentDataColumnName**: string (Required) +* **DocumentIdColumnName**: string (Required) +* **DocumentTitleColumnName**: string +* **FieldMappings**: [DataSourceToIndexFieldMapping](#datasourcetoindexfieldmapping)[] ## ConfluenceAttachmentConfiguration ### Properties @@ -121,6 +106,19 @@ * **DateFieldFormat**: string * **IndexFieldName**: string (Required) +## ConfluenceConfiguration +### Properties +* **AttachmentConfiguration**: [ConfluenceAttachmentConfiguration](#confluenceattachmentconfiguration) +* **BlogConfiguration**: [ConfluenceBlogConfiguration](#confluenceblogconfiguration) +* **ExclusionPatterns**: string[] +* **InclusionPatterns**: string[] +* **PageConfiguration**: [ConfluencePageConfiguration](#confluencepageconfiguration) +* **SecretArn**: string (Required) +* **ServerUrl**: string (Required) +* **SpaceConfiguration**: [ConfluenceSpaceConfiguration](#confluencespaceconfiguration) +* **Version**: string (Required) +* **VpcConfiguration**: [DataSourceVpcConfiguration](#datasourcevpcconfiguration) + ## ConfluencePageConfiguration ### Properties * **PageFieldMappings**: [ConfluencePageToIndexFieldMapping](#confluencepagetoindexfieldmapping)[] @@ -145,10 +143,20 @@ * **DateFieldFormat**: string * **IndexFieldName**: string (Required) -## DataSourceVpcConfiguration +## ConnectionConfiguration ### Properties -* **SecurityGroupIds**: string[] (Required) -* **SubnetIds**: string[] (Required) +* **DatabaseHost**: string (Required) +* **DatabaseName**: string (Required) +* **DatabasePort**: int (Required) +* **SecretArn**: string (Required) +* **TableName**: string (Required) + +## CustomDocumentEnrichmentConfiguration +### Properties +* **InlineConfigurations**: [InlineCustomDocumentEnrichmentConfiguration](#inlinecustomdocumentenrichmentconfiguration)[] +* **PostExtractionHookConfiguration**: [HookConfiguration](#hookconfiguration) +* **PreExtractionHookConfiguration**: [HookConfiguration](#hookconfiguration) +* **RoleArn**: string ## DatabaseConfiguration ### Properties @@ -159,17 +167,18 @@ * **SqlConfiguration**: [SqlConfiguration](#sqlconfiguration) * **VpcConfiguration**: [DataSourceVpcConfiguration](#datasourcevpcconfiguration) -## AclConfiguration -### Properties -* **AllowedGroupsColumnName**: string (Required) - -## ColumnConfiguration +## DataSourceConfiguration ### Properties -* **ChangeDetectingColumns**: string[] (Required) -* **DocumentDataColumnName**: string (Required) -* **DocumentIdColumnName**: string (Required) -* **DocumentTitleColumnName**: string -* **FieldMappings**: [DataSourceToIndexFieldMapping](#datasourcetoindexfieldmapping)[] +* **ConfluenceConfiguration**: [ConfluenceConfiguration](#confluenceconfiguration) +* **DatabaseConfiguration**: [DatabaseConfiguration](#databaseconfiguration) +* **GoogleDriveConfiguration**: [GoogleDriveConfiguration](#googledriveconfiguration) +* **OneDriveConfiguration**: [OneDriveConfiguration](#onedriveconfiguration) +* **S3Configuration**: [S3DataSourceConfiguration](#s3datasourceconfiguration) +* **SalesforceConfiguration**: [SalesforceConfiguration](#salesforceconfiguration) +* **ServiceNowConfiguration**: [ServiceNowConfiguration](#servicenowconfiguration) +* **SharePointConfiguration**: [SharePointConfiguration](#sharepointconfiguration) +* **WebCrawlerConfiguration**: [WebCrawlerConfiguration](#webcrawlerconfiguration) +* **WorkDocsConfiguration**: [WorkDocsConfiguration](#workdocsconfiguration) ## DataSourceToIndexFieldMapping ### Properties @@ -177,17 +186,40 @@ * **DateFieldFormat**: string * **IndexFieldName**: string (Required) -## ConnectionConfiguration +## DataSourceVpcConfiguration ### Properties -* **DatabaseHost**: string (Required) -* **DatabaseName**: string (Required) -* **DatabasePort**: int (Required) -* **SecretArn**: string (Required) -* **TableName**: string (Required) +* **SecurityGroupIds**: string[] (Required) +* **SubnetIds**: string[] (Required) -## SqlConfiguration +## DocumentAttributeCondition ### Properties -* **QueryIdentifiersEnclosingOption**: string +* **ConditionDocumentAttributeKey**: string (Required) +* **ConditionOnValue**: [DocumentAttributeValue](#documentattributevalue) +* **Operator**: string (Required) + +## DocumentAttributeTarget +### Properties +* **TargetDocumentAttributeKey**: string (Required) +* **TargetDocumentAttributeValue**: [DocumentAttributeValue](#documentattributevalue) +* **TargetDocumentAttributeValueDeletion**: bool + +## DocumentAttributeValue +### Properties +* **DateValue**: string +* **LongValue**: int +* **StringListValue**: string[] +* **StringValue**: string + +## DocumentMetadataConfiguration +### Properties +* **Name**: string (Required) +* **Relevance**: [Relevance](#relevance) +* **Search**: [Search](#search) +* **Type**: string (Required) + +## DocumentsMetadataConfiguration +### Properties +* **S3Prefix**: string ## GoogleDriveConfiguration ### Properties @@ -199,6 +231,33 @@ * **InclusionPatterns**: string[] * **SecretArn**: string (Required) +## HookConfiguration +### Properties +* **InvocationCondition**: [DocumentAttributeCondition](#documentattributecondition) +* **LambdaArn**: string (Required) +* **S3Bucket**: string (Required) + +## InlineCustomDocumentEnrichmentConfiguration +### Properties +* **Condition**: [DocumentAttributeCondition](#documentattributecondition) +* **DocumentContentDeletion**: bool +* **Target**: [DocumentAttributeTarget](#documentattributetarget) + +## JsonTokenTypeConfiguration +### Properties +* **GroupAttributeField**: string (Required) +* **UserNameAttributeField**: string (Required) + +## JwtTokenTypeConfiguration +### Properties +* **ClaimRegex**: string +* **GroupAttributeField**: string +* **Issuer**: string +* **KeyLocation**: string (Required) +* **SecretManagerArn**: string +* **URL**: string +* **UserNameAttributeField**: string + ## OneDriveConfiguration ### Properties * **DisableLocalGroups**: bool @@ -214,10 +273,19 @@ * **OneDriveUserList**: string[] * **OneDriveUserS3Path**: [S3Path](#s3path) -## S3Path +## ProxyConfiguration ### Properties -* **Bucket**: string (Required) -* **Key**: string (Required) +* **Credentials**: string +* **Host**: string (Required) +* **Port**: int (Required) + +## Relevance +### Properties +* **Duration**: string +* **Freshness**: bool +* **Importance**: int +* **RankOrder**: string +* **ValueImportanceItems**: [ValueImportanceItem](#valueimportanceitem)[] ## S3DataSourceConfiguration ### Properties @@ -228,13 +296,22 @@ * **InclusionPatterns**: string[] * **InclusionPrefixes**: string[] -## AccessControlListConfiguration +## S3Path ### Properties -* **KeyPath**: string +* **Bucket**: string (Required) +* **Key**: string (Required) -## DocumentsMetadataConfiguration +## S3Path ### Properties -* **S3Prefix**: string +* **Bucket**: string (Required) +* **Key**: string (Required) + +## SalesforceChatterFeedConfiguration +### Properties +* **DocumentDataFieldName**: string (Required) +* **DocumentTitleFieldName**: string +* **FieldMappings**: [DataSourceToIndexFieldMapping](#datasourcetoindexfieldmapping)[] +* **IncludeFilterTypes**: string[] ## SalesforceConfiguration ### Properties @@ -248,12 +325,12 @@ * **StandardObjectAttachmentConfiguration**: [SalesforceStandardObjectAttachmentConfiguration](#salesforcestandardobjectattachmentconfiguration) * **StandardObjectConfigurations**: [SalesforceStandardObjectConfiguration](#salesforcestandardobjectconfiguration)[] -## SalesforceChatterFeedConfiguration +## SalesforceCustomKnowledgeArticleTypeConfiguration ### Properties * **DocumentDataFieldName**: string (Required) * **DocumentTitleFieldName**: string * **FieldMappings**: [DataSourceToIndexFieldMapping](#datasourcetoindexfieldmapping)[] -* **IncludeFilterTypes**: string[] +* **Name**: string (Required) ## SalesforceKnowledgeArticleConfiguration ### Properties @@ -261,13 +338,6 @@ * **IncludedStates**: string[] (Required) * **StandardKnowledgeArticleTypeConfiguration**: [SalesforceStandardKnowledgeArticleTypeConfiguration](#salesforcestandardknowledgearticletypeconfiguration) -## SalesforceCustomKnowledgeArticleTypeConfiguration -### Properties -* **DocumentDataFieldName**: string (Required) -* **DocumentTitleFieldName**: string -* **FieldMappings**: [DataSourceToIndexFieldMapping](#datasourcetoindexfieldmapping)[] -* **Name**: string (Required) - ## SalesforceStandardKnowledgeArticleTypeConfiguration ### Properties * **DocumentDataFieldName**: string (Required) @@ -286,6 +356,17 @@ * **FieldMappings**: [DataSourceToIndexFieldMapping](#datasourcetoindexfieldmapping)[] * **Name**: string (Required) +## Search +### Properties +* **Displayable**: bool +* **Facetable**: bool +* **Searchable**: bool +* **Sortable**: bool + +## ServerSideEncryptionConfiguration +### Properties +* **KmsKeyId**: string + ## ServiceNowConfiguration ### Properties * **AuthenticationType**: string @@ -329,157 +410,77 @@ * **UseChangeLog**: bool * **VpcConfiguration**: [DataSourceVpcConfiguration](#datasourcevpcconfiguration) -## WebCrawlerConfiguration -### Properties -* **AuthenticationConfiguration**: [WebCrawlerAuthenticationConfiguration](#webcrawlerauthenticationconfiguration) -* **CrawlDepth**: int -* **MaxContentSizePerPageInMegaBytes**: int -* **MaxLinksPerPage**: int -* **MaxUrlsPerMinuteCrawlRate**: int -* **ProxyConfiguration**: [ProxyConfiguration](#proxyconfiguration) -* **UrlExclusionPatterns**: string[] -* **UrlInclusionPatterns**: string[] -* **Urls**: [WebCrawlerUrls](#webcrawlerurls) (Required) - -## WebCrawlerAuthenticationConfiguration -### Properties -* **BasicAuthentication**: [WebCrawlerBasicAuthentication](#webcrawlerbasicauthentication)[] - -## WebCrawlerBasicAuthentication -### Properties -* **Credentials**: string (Required) -* **Host**: string (Required) -* **Port**: int (Required) - -## ProxyConfiguration -### Properties -* **Credentials**: string -* **Host**: string (Required) -* **Port**: int (Required) - -## WebCrawlerUrls -### Properties -* **SeedUrlConfiguration**: [WebCrawlerSeedUrlConfiguration](#webcrawlerseedurlconfiguration) -* **SiteMapsConfiguration**: [WebCrawlerSiteMapsConfiguration](#webcrawlersitemapsconfiguration) - -## WebCrawlerSeedUrlConfiguration -### Properties -* **SeedUrls**: string[] (Required) -* **WebCrawlerMode**: string - -## WebCrawlerSiteMapsConfiguration -### Properties -* **SiteMaps**: string[] (Required) - -## WorkDocsConfiguration +## SqlConfiguration ### Properties -* **CrawlComments**: bool -* **ExclusionPatterns**: string[] -* **FieldMappings**: [DataSourceToIndexFieldMapping](#datasourcetoindexfieldmapping)[] -* **InclusionPatterns**: string[] -* **OrganizationId**: string (Required) -* **UseChangeLog**: bool +* **QueryIdentifiersEnclosingOption**: string ## Tag ### Properties * **Key**: string (Required): A string used to identify this tag * **Value**: string (Required): A string containing the value for the tag -## AWS.Kendra/FaqProperties -### Properties -* **Arn**: string (ReadOnly) -* **Description**: string: FAQ description -* **FileFormat**: string: FAQ file format -* **Id**: string (ReadOnly, Identifier) -* **IndexId**: string (Required, Identifier): Index ID -* **Name**: string (Required): FAQ name -* **RoleArn**: string (Required): FAQ role ARN -* **S3Path**: [S3Path](#s3path) (Required): FAQ S3 path -* **Tags**: [Tag](#tag)[]: Tags for labeling the FAQ - -## S3Path -### Properties -* **Bucket**: string (Required) -* **Key**: string (Required) - ## Tag ### Properties * **Key**: string (Required): A string used to identify this tag * **Value**: string (Required): A string containing the value for the tag -## AWS.Kendra/IndexProperties -### Properties -* **Arn**: string (ReadOnly) -* **CapacityUnits**: [CapacityUnitsConfiguration](#capacityunitsconfiguration): Capacity units -* **Description**: string: A description for the index -* **DocumentMetadataConfigurations**: [DocumentMetadataConfiguration](#documentmetadataconfiguration)[]: Document metadata configurations -* **Edition**: string (Required) -* **Id**: string (ReadOnly, Identifier) -* **Name**: string (Required) -* **RoleArn**: string (Required) -* **ServerSideEncryptionConfiguration**: [ServerSideEncryptionConfiguration](#serversideencryptionconfiguration): Server side encryption configuration -* **Tags**: [Tag](#tag)[]: Tags for labeling the index -* **UserContextPolicy**: string -* **UserTokenConfigurations**: [UserTokenConfiguration](#usertokenconfiguration)[] - -## CapacityUnitsConfiguration -### Properties -* **QueryCapacityUnits**: int (Required) -* **StorageCapacityUnits**: int (Required) - -## DocumentMetadataConfiguration +## Tag ### Properties -* **Name**: string (Required) -* **Relevance**: [Relevance](#relevance) -* **Search**: [Search](#search) -* **Type**: string (Required) +* **Key**: string (Required): A string used to identify this tag +* **Value**: string (Required): A string containing the value for the tag -## Relevance +## UserTokenConfiguration ### Properties -* **Duration**: string -* **Freshness**: bool -* **Importance**: int -* **RankOrder**: string -* **ValueImportanceItems**: [ValueImportanceItem](#valueimportanceitem)[] +* **JsonTokenTypeConfiguration**: [JsonTokenTypeConfiguration](#jsontokentypeconfiguration) +* **JwtTokenTypeConfiguration**: [JwtTokenTypeConfiguration](#jwttokentypeconfiguration) ## ValueImportanceItem ### Properties * **Key**: string * **Value**: int -## Search +## WebCrawlerAuthenticationConfiguration ### Properties -* **Displayable**: bool -* **Facetable**: bool -* **Searchable**: bool -* **Sortable**: bool +* **BasicAuthentication**: [WebCrawlerBasicAuthentication](#webcrawlerbasicauthentication)[] -## ServerSideEncryptionConfiguration +## WebCrawlerBasicAuthentication ### Properties -* **KmsKeyId**: string +* **Credentials**: string (Required) +* **Host**: string (Required) +* **Port**: int (Required) -## Tag +## WebCrawlerConfiguration ### Properties -* **Key**: string (Required): A string used to identify this tag -* **Value**: string (Required): A string containing the value for the tag +* **AuthenticationConfiguration**: [WebCrawlerAuthenticationConfiguration](#webcrawlerauthenticationconfiguration) +* **CrawlDepth**: int +* **MaxContentSizePerPageInMegaBytes**: int +* **MaxLinksPerPage**: int +* **MaxUrlsPerMinuteCrawlRate**: int +* **ProxyConfiguration**: [ProxyConfiguration](#proxyconfiguration) +* **UrlExclusionPatterns**: string[] +* **UrlInclusionPatterns**: string[] +* **Urls**: [WebCrawlerUrls](#webcrawlerurls) (Required) -## UserTokenConfiguration +## WebCrawlerSeedUrlConfiguration ### Properties -* **JsonTokenTypeConfiguration**: [JsonTokenTypeConfiguration](#jsontokentypeconfiguration) -* **JwtTokenTypeConfiguration**: [JwtTokenTypeConfiguration](#jwttokentypeconfiguration) +* **SeedUrls**: string[] (Required) +* **WebCrawlerMode**: string -## JsonTokenTypeConfiguration +## WebCrawlerSiteMapsConfiguration ### Properties -* **GroupAttributeField**: string (Required) -* **UserNameAttributeField**: string (Required) +* **SiteMaps**: string[] (Required) -## JwtTokenTypeConfiguration +## WebCrawlerUrls ### Properties -* **ClaimRegex**: string -* **GroupAttributeField**: string -* **Issuer**: string -* **KeyLocation**: string (Required) -* **SecretManagerArn**: string -* **URL**: string -* **UserNameAttributeField**: string +* **SeedUrlConfiguration**: [WebCrawlerSeedUrlConfiguration](#webcrawlerseedurlconfiguration) +* **SiteMapsConfiguration**: [WebCrawlerSiteMapsConfiguration](#webcrawlersitemapsconfiguration) + +## WorkDocsConfiguration +### Properties +* **CrawlComments**: bool +* **ExclusionPatterns**: string[] +* **FieldMappings**: [DataSourceToIndexFieldMapping](#datasourcetoindexfieldmapping)[] +* **InclusionPatterns**: string[] +* **OrganizationId**: string (Required) +* **UseChangeLog**: bool diff --git a/artifacts/bicep/aws/aws.kendraranking/default/types.json b/artifacts/bicep/aws/aws.kendraranking/default/types.json index 7f49f2b7..79cfc576 100644 --- a/artifacts/bicep/aws/aws.kendraranking/default/types.json +++ b/artifacts/bicep/aws/aws.kendraranking/default/types.json @@ -1 +1,167 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"Arn"}},{"2":{"Name":"CapacityUnitsConfiguration","Properties":{"RescoreCapacityUnits":{"Type":3,"Flags":1}}}},{"2":{"Name":"Description"}},{"2":{"Name":"Id"}},{"2":{"Name":"Name"}},{"2":{"Name":"RescoreCapacityUnits"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"A string used to identify this tag"},"Value":{"Type":4,"Flags":1,"Description":"A string containing the value for the tag"}}}},{"2":{"Name":"Tags"}},{"3":{"ItemType":14}},{"2":{"Name":"AWS.KendraRanking/ExecutionPlanProperties","Properties":{"Arn":{"Type":4,"Flags":2},"CapacityUnits":{"Type":9,"Flags":0,"Description":"Capacity units"},"Description":{"Type":4,"Flags":0,"Description":"A description for the execution plan"},"Id":{"Type":4,"Flags":18},"Name":{"Type":4,"Flags":1},"Tags":{"Type":18,"Flags":0,"Description":"Tags for labeling the execution plan"}}}},{"3":{"ItemType":14}},{"2":{"Name":"AWS.KendraRanking/ExecutionPlan","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":17,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.KendraRanking/ExecutionPlan@default","ScopeType":0,"Body":19}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Arn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CapacityUnitsConfiguration", + "properties": { + "RescoreCapacityUnits": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Description", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Id", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Name", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RescoreCapacityUnits", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/8" + }, + "flags": 1, + "description": "A string used to identify this tag" + }, + "Value": { + "type": { + "$ref": "#/8" + }, + "flags": 1, + "description": "A string containing the value for the tag" + } + } + }, + { + "$type": "ObjectType", + "name": "Tags", + "properties": {} + }, + { + "$type": "StringType" + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.KendraRanking/ExecutionPlanProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ObjectType", + "name": "AWS.KendraRanking/ExecutionPlanProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/8" + }, + "flags": 2 + }, + "CapacityUnits": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Capacity units" + }, + "Description": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "A description for the execution plan" + }, + "Id": { + "type": { + "$ref": "#/8" + }, + "flags": 18 + }, + "Name": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "Tags for labeling the execution plan" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.KendraRanking/ExecutionPlan", + "properties": { + "name": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/8" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/13" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.KendraRanking/ExecutionPlan@default", + "scopeType": 0, + "body": { + "$ref": "#/14" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.kendraranking/default/types.md b/artifacts/bicep/aws/aws.kendraranking/default/types.md index f0671567..b156b1a6 100644 --- a/artifacts/bicep/aws/aws.kendraranking/default/types.md +++ b/artifacts/bicep/aws/aws.kendraranking/default/types.md @@ -3,9 +3,9 @@ ## Resource AWS.KendraRanking/ExecutionPlan@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.KendraRanking/ExecutionPlanProperties](#awskendrarankingexecutionplanproperties) (Required): properties of the resource +* **properties**: [AWS.KendraRanking/ExecutionPlanProperties](#awskendrarankingexecutionplanproperties) (Required, Identifier): properties of the resource ## AWS.KendraRanking/ExecutionPlanProperties ### Properties diff --git a/artifacts/bicep/aws/aws.kinesis/default/types.json b/artifacts/bicep/aws/aws.kinesis/default/types.json index 81c90ac4..31655fa4 100644 --- a/artifacts/bicep/aws/aws.kinesis/default/types.json +++ b/artifacts/bicep/aws/aws.kinesis/default/types.json @@ -1 +1,162 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"StreamEncryption","Properties":{"EncryptionType":{"Type":4,"Flags":1,"Description":"The encryption type to use. The only valid value is KMS. "},"KeyId":{"Type":4,"Flags":1,"Description":"The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified Amazon Resource Name (ARN) to either an alias or a key, or an alias name prefixed by \"alias/\".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis."}}}},{"2":{"Name":"StreamModeDetails","Properties":{"StreamMode":{"Type":4,"Flags":1,"Description":"The mode of the stream"}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.Kinesis/StreamProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"The Amazon resource name (ARN) of the Kinesis stream"},"Name":{"Type":4,"Flags":16,"Description":"The name of the Kinesis stream."},"RetentionPeriodHours":{"Type":3,"Flags":0,"Description":"The number of hours for the data records that are stored in shards to remain accessible."},"ShardCount":{"Type":3,"Flags":0,"Description":"The number of shards that the stream uses. Required when StreamMode = PROVISIONED is passed."},"StreamEncryption":{"Type":8,"Flags":0,"Description":"When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream."},"StreamModeDetails":{"Type":9,"Flags":0,"Description":"The mode in which the stream is running."},"Tags":{"Type":12,"Flags":0,"Description":"An arbitrary set of tags (key–value pairs) to associate with the Kinesis stream."}}}},{"3":{"ItemType":10}},{"2":{"Name":"AWS.Kinesis/Stream","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":11,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Kinesis/Stream@default","ScopeType":0,"Body":13}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "StreamEncryption", + "properties": { + "EncryptionType": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The encryption type to use. The only valid value is KMS. " + }, + "KeyId": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified Amazon Resource Name (ARN) to either an alias or a key, or an alias name prefixed by \"alias/\".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis." + } + } + }, + { + "$type": "ObjectType", + "name": "StreamModeDetails", + "properties": { + "StreamMode": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The mode of the stream" + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.Kinesis/StreamProperties" + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Kinesis/StreamProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The Amazon resource name (ARN) of the Kinesis stream" + }, + "Name": { + "type": { + "$ref": "#/3" + }, + "flags": 16, + "description": "The name of the Kinesis stream." + }, + "RetentionPeriodHours": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The number of hours for the data records that are stored in shards to remain accessible." + }, + "ShardCount": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The number of shards that the stream uses. Required when StreamMode = PROVISIONED is passed." + }, + "StreamEncryption": { + "type": { + "$ref": "#/0" + }, + "flags": 0, + "description": "When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream." + }, + "StreamModeDetails": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The mode in which the stream is running." + }, + "Tags": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "An arbitrary set of tags (key–value pairs) to associate with the Kinesis stream." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Kinesis/Stream", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/7" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Kinesis/Stream@default", + "scopeType": 0, + "body": { + "$ref": "#/8" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.kinesis/default/types.md b/artifacts/bicep/aws/aws.kinesis/default/types.md index b43a214b..a1f71c92 100644 --- a/artifacts/bicep/aws/aws.kinesis/default/types.md +++ b/artifacts/bicep/aws/aws.kinesis/default/types.md @@ -3,9 +3,9 @@ ## Resource AWS.Kinesis/Stream@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Kinesis/StreamProperties](#awskinesisstreamproperties): properties of the resource +* **properties**: [AWS.Kinesis/StreamProperties](#awskinesisstreamproperties) (Identifier): properties of the resource ## AWS.Kinesis/StreamProperties ### Properties diff --git a/artifacts/bicep/aws/aws.kinesisanalyticsv2/default/types.json b/artifacts/bicep/aws/aws.kinesisanalyticsv2/default/types.json index 57dae0a0..c5ba877d 100644 --- a/artifacts/bicep/aws/aws.kinesisanalyticsv2/default/types.json +++ b/artifacts/bicep/aws/aws.kinesisanalyticsv2/default/types.json @@ -1 +1,1036 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"ApplicationCodeConfiguration","Properties":{"CodeContent":{"Type":17,"Flags":1,"Description":"The location and type of the application code."},"CodeContentType":{"Type":4,"Flags":1,"Description":"Specifies whether the code content is in text or zip format."}}}},{"2":{"Name":"ApplicationConfiguration","Properties":{"ApplicationCodeConfiguration":{"Type":8,"Flags":0,"Description":"The code location and type parameters for a Flink-based Kinesis Data Analytics application."},"ApplicationSnapshotConfiguration":{"Type":12,"Flags":0,"Description":"Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application."},"EnvironmentProperties":{"Type":21,"Flags":4,"Description":"Describes execution properties for a Flink-based Kinesis Data Analytics application."},"FlinkApplicationConfiguration":{"Type":22,"Flags":0,"Description":"The creation and update parameters for a Flink-based Kinesis Data Analytics application."},"SqlApplicationConfiguration":{"Type":43,"Flags":0,"Description":"The creation and update parameters for a SQL-based Kinesis Data Analytics application."},"VpcConfigurations":{"Type":49,"Flags":0,"Description":"The array of descriptions of VPC configurations available to the application."},"ZeppelinApplicationConfiguration":{"Type":47,"Flags":0,"Description":"The configuration parameters for a Kinesis Data Analytics Studio notebook."}}}},{"2":{"Name":"ApplicationMaintenanceConfiguration","Properties":{"ApplicationMaintenanceWindowStartTime":{"Type":4,"Flags":1,"Description":"The start time for the maintenance window."}}}},{"2":{"Name":"ApplicationRestoreConfiguration","Properties":{"ApplicationRestoreType":{"Type":4,"Flags":1,"Description":"Specifies how the application should be restored."},"SnapshotName":{"Type":4,"Flags":0,"Description":"The identifier of an existing snapshot of application state to use to restart an application. The application uses this value if RESTORE_FROM_CUSTOM_SNAPSHOT is specified for the ApplicationRestoreType."}}}},{"2":{"Name":"ApplicationSnapshotConfiguration","Properties":{"SnapshotsEnabled":{"Type":2,"Flags":1,"Description":"Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application."}}}},{"2":{"Name":"Arn"}},{"2":{"Name":"CSVMappingParameters","Properties":{"RecordColumnDelimiter":{"Type":4,"Flags":1,"Description":"The column delimiter. For example, in a CSV format, a comma (\",\") is the typical column delimiter."},"RecordRowDelimiter":{"Type":4,"Flags":1,"Description":"The row delimiter. For example, in a CSV format, '\\n' is the typical row delimiter."}}}},{"2":{"Name":"CatalogConfiguration","Properties":{"GlueDataCatalogConfiguration":{"Type":24,"Flags":0,"Description":"The configuration parameters for the default Amazon Glue database. You use this database for Apache Flink SQL queries and table API transforms that you write in a Kinesis Data Analytics Studio notebook."}}}},{"2":{"Name":"CheckpointConfiguration","Properties":{"CheckpointInterval":{"Type":3,"Flags":0,"Description":"Describes the interval in milliseconds between checkpoint operations."},"CheckpointingEnabled":{"Type":2,"Flags":0,"Description":"Describes whether checkpointing is enabled for a Flink-based Kinesis Data Analytics application."},"ConfigurationType":{"Type":4,"Flags":1,"Description":"Describes whether the application uses Kinesis Data Analytics' default checkpointing behavior. You must set this property to `CUSTOM` in order to set the `CheckpointingEnabled`, `CheckpointInterval`, or `MinPauseBetweenCheckpoints` parameters."},"MinPauseBetweenCheckpoints":{"Type":3,"Flags":0,"Description":"Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start. If a checkpoint operation takes longer than the CheckpointInterval, the application otherwise performs continual checkpoint operations. For more information, see Tuning Checkpointing in the Apache Flink Documentation."}}}},{"2":{"Name":"CodeContent","Properties":{"S3ContentLocation":{"Type":42,"Flags":0,"Description":"Information about the Amazon S3 bucket that contains the application code."},"TextContent":{"Type":4,"Flags":0,"Description":"The text-format code for a Flink-based Kinesis Data Analytics application."},"ZipFileContent":{"Type":4,"Flags":4,"Description":"The zip-format code for a Flink-based Kinesis Data Analytics application."}}}},{"2":{"Name":"CustomArtifactConfiguration","Properties":{"ArtifactType":{"Type":4,"Flags":1,"Description":"Set this to either `UDF` or `DEPENDENCY_JAR`. `UDF` stands for user-defined functions. This type of artifact must be in an S3 bucket. A `DEPENDENCY_JAR` can be in either Maven or an S3 bucket."},"MavenReference":{"Type":34,"Flags":0,"Description":"The parameters required to fully specify a Maven reference."},"S3ContentLocation":{"Type":42,"Flags":0,"Description":"The location of the custom artifacts."}}}},{"2":{"Name":"CustomArtifactsConfiguration"}},{"2":{"Name":"DeployAsApplicationConfiguration","Properties":{"S3ContentLocation":{"Type":41,"Flags":1,"Description":"The description of an Amazon S3 object that contains the Amazon Data Analytics application, including the Amazon Resource Name (ARN) of the S3 bucket, the name of the Amazon S3 object that contains the data, and the version number of the Amazon S3 object that contains the data."}}}},{"2":{"Name":"EnvironmentProperties","Properties":{"PropertyGroups":{"Type":51,"Flags":0,"Description":"Describes the execution property groups."}}}},{"2":{"Name":"FlinkApplicationConfiguration","Properties":{"CheckpointConfiguration":{"Type":16,"Flags":0,"Description":"Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance. For more information, see Checkpoints for Fault Tolerance in the Apache Flink Documentation."},"MonitoringConfiguration":{"Type":35,"Flags":0,"Description":"Describes configuration parameters for Amazon CloudWatch logging for an application."},"ParallelismConfiguration":{"Type":36,"Flags":0,"Description":"Describes parameters for how an application executes multiple tasks simultaneously."}}}},{"2":{"Name":"FlinkRunConfiguration","Properties":{"AllowNonRestoredState":{"Type":2,"Flags":0,"Description":"When restoring from a snapshot, specifies whether the runtime is allowed to skip a state that cannot be mapped to the new program. Defaults to false. If you update your application without specifying this parameter, AllowNonRestoredState will be set to false, even if it was previously set to true."}}}},{"2":{"Name":"GlueDataCatalogConfiguration","Properties":{"DatabaseARN":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) of the database."}}}},{"2":{"Name":"Input","Properties":{"InputParallelism":{"Type":27,"Flags":0,"Description":"Describes the number of in-application streams to create."},"InputProcessingConfiguration":{"Type":28,"Flags":0,"Description":"The InputProcessingConfiguration for the input. An input processor transforms records as they are received from the stream, before the application's SQL code executes. Currently, the only input processing configuration available is InputLambdaProcessor."},"InputSchema":{"Type":29,"Flags":1,"Description":"Describes 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."},"KinesisFirehoseInput":{"Type":31,"Flags":0,"Description":"If the streaming source is an Amazon Kinesis Data Firehose delivery stream, identifies the delivery stream's ARN."},"KinesisStreamsInput":{"Type":32,"Flags":0,"Description":"If the streaming source is an Amazon Kinesis data stream, identifies the stream's Amazon Resource Name (ARN)."},"NamePrefix":{"Type":4,"Flags":1,"Description":"The name prefix to use when creating an in-application stream. Suppose that you specify a prefix `\"MyInApplicationStream\"`. Kinesis Data Analytics then creates one or more (as per the InputParallelism count you specified) in-application streams with the names `\"MyInApplicationStream_001\"`, `\"MyInApplicationStream_002\"`, and so on."}}}},{"2":{"Name":"InputLambdaProcessor","Properties":{"ResourceARN":{"Type":4,"Flags":1,"Description":"The ARN of the Amazon Lambda function that operates on records in the stream."}}}},{"2":{"Name":"InputParallelism","Properties":{"Count":{"Type":3,"Flags":0,"Description":"The number of in-application streams to create."}}}},{"2":{"Name":"InputProcessingConfiguration","Properties":{"InputLambdaProcessor":{"Type":26,"Flags":0,"Description":"The InputLambdaProcessor that is used to preprocess the records in the stream before being processed by your application code."}}}},{"2":{"Name":"InputSchema","Properties":{"RecordColumns":{"Type":52,"Flags":1,"Description":"A list of `RecordColumn` objects."},"RecordEncoding":{"Type":4,"Flags":0,"Description":"Specifies the encoding of the records in the streaming source. For example, UTF-8."},"RecordFormat":{"Type":39,"Flags":1,"Description":"Specifies the format of the records on the streaming source."}}}},{"2":{"Name":"JSONMappingParameters","Properties":{"RecordRowPath":{"Type":4,"Flags":1,"Description":"The path to the top-level parent that contains the records."}}}},{"2":{"Name":"KinesisFirehoseInput","Properties":{"ResourceARN":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) of the delivery stream."}}}},{"2":{"Name":"KinesisStreamsInput","Properties":{"ResourceARN":{"Type":4,"Flags":1,"Description":"The ARN of the input Kinesis data stream to read."}}}},{"2":{"Name":"MappingParameters","Properties":{"CSVMappingParameters":{"Type":14,"Flags":0,"Description":"Provides additional mapping information when the record format uses delimiters (for example, CSV)."},"JSONMappingParameters":{"Type":30,"Flags":0,"Description":"Provides additional mapping information when JSON is the record format on the streaming source."}}}},{"2":{"Name":"MavenReference","Properties":{"ArtifactId":{"Type":4,"Flags":1,"Description":"The artifact ID of the Maven reference."},"GroupId":{"Type":4,"Flags":1,"Description":"The group ID of the Maven reference."},"Version":{"Type":4,"Flags":1,"Description":"The version of the Maven reference."}}}},{"2":{"Name":"MonitoringConfiguration","Properties":{"ConfigurationType":{"Type":4,"Flags":1,"Description":"Describes whether to use the default CloudWatch logging configuration for an application. You must set this property to CUSTOM in order to set the LogLevel or MetricsLevel parameters."},"LogLevel":{"Type":4,"Flags":0,"Description":"Describes the verbosity of the CloudWatch Logs for an application."},"MetricsLevel":{"Type":4,"Flags":0,"Description":"Describes the granularity of the CloudWatch Logs for an application. The Parallelism level is not recommended for applications with a Parallelism over 64 due to excessive costs."}}}},{"2":{"Name":"ParallelismConfiguration","Properties":{"AutoScalingEnabled":{"Type":2,"Flags":0,"Description":"Describes whether the Kinesis Data Analytics service can increase the parallelism of the application in response to increased throughput."},"ConfigurationType":{"Type":4,"Flags":1,"Description":"Describes whether the application uses the default parallelism for the Kinesis Data Analytics service. You must set this property to `CUSTOM` in order to change your application's `AutoScalingEnabled`, `Parallelism`, or `ParallelismPerKPU` properties."},"Parallelism":{"Type":3,"Flags":0,"Description":"Describes the initial number of parallel tasks that a Java-based Kinesis Data Analytics application can perform. The Kinesis Data Analytics service can increase this number automatically if ParallelismConfiguration:AutoScalingEnabled is set to true."},"ParallelismPerKPU":{"Type":3,"Flags":0,"Description":"Describes the number of parallel tasks that a Java-based Kinesis Data Analytics application can perform per Kinesis Processing Unit (KPU) used by the application. For more information about KPUs, see Amazon Kinesis Data Analytics Pricing."}}}},{"2":{"Name":"PropertyGroup","Properties":{"PropertyGroupId":{"Type":4,"Flags":0,"Description":"Describes the key of an application execution property key-value pair."},"PropertyMap":{"Type":53,"Flags":0,"Description":"Describes the value of an application execution property key-value pair."}}}},{"2":{"Name":"RecordColumn","Properties":{"Mapping":{"Type":4,"Flags":0,"Description":"A reference to the data element in the streaming input or the reference data source."},"Name":{"Type":4,"Flags":1,"Description":"The name of the column that is created in the in-application input stream or reference table."},"SqlType":{"Type":4,"Flags":1,"Description":"The type of column created in the in-application input stream or reference table."}}}},{"2":{"Name":"RecordFormat","Properties":{"MappingParameters":{"Type":33,"Flags":0,"Description":"When you configure application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source."},"RecordFormatType":{"Type":4,"Flags":1,"Description":"The type of record format."}}}},{"2":{"Name":"RunConfiguration","Properties":{"ApplicationRestoreConfiguration":{"Type":11,"Flags":0,"Description":"Describes the restore behavior of a restarting application."},"FlinkRunConfiguration":{"Type":23,"Flags":0,"Description":"Describes the starting parameters for a Flink-based Kinesis Data Analytics application."}}}},{"2":{"Name":"S3ContentBaseLocation","Properties":{"BasePath":{"Type":4,"Flags":0,"Description":"The base path for the S3 bucket."},"BucketARN":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) of the S3 bucket."}}}},{"2":{"Name":"S3ContentLocation","Properties":{"BucketARN":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) for the S3 bucket containing the application code."},"FileKey":{"Type":4,"Flags":1,"Description":"The file key for the object containing the application code."},"ObjectVersion":{"Type":4,"Flags":0,"Description":"The version of the object containing the application code."}}}},{"2":{"Name":"SqlApplicationConfiguration","Properties":{"Inputs":{"Type":54,"Flags":0,"Description":"The array of Input objects describing the input streams used by the application."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that's 1 to 128 Unicode characters in length and can't be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that's 0 to 256 characters in length."}}}},{"2":{"Name":"VpcConfiguration","Properties":{"SecurityGroupIds":{"Type":55,"Flags":1,"Description":"The array of SecurityGroup IDs used by the VPC configuration."},"SubnetIds":{"Type":56,"Flags":1,"Description":"The array of Subnet IDs used by the VPC configuration."}}}},{"2":{"Name":"VpcConfigurations"}},{"2":{"Name":"ZeppelinApplicationConfiguration","Properties":{"CatalogConfiguration":{"Type":15,"Flags":0,"Description":"The Amazon Glue Data Catalog that you use in queries in a Kinesis Data Analytics Studio notebook."},"CustomArtifactsConfiguration":{"Type":58,"Flags":0,"Description":"A list of CustomArtifactConfiguration objects."},"DeployAsApplicationConfiguration":{"Type":20,"Flags":0,"Description":"The information required to deploy a Kinesis Data Analytics Studio notebook as an application with durable state."},"MonitoringConfiguration":{"Type":48,"Flags":0,"Description":"The monitoring configuration of a Kinesis Data Analytics Studio notebook."}}}},{"2":{"Name":"ZeppelinMonitoringConfiguration","Properties":{"LogLevel":{"Type":4,"Flags":0,"Description":"The verbosity of the CloudWatch Logs for an application. You can set it to `INFO`, `WARN`, `ERROR`, or `DEBUG`."}}}},{"3":{"ItemType":45}},{"3":{"ItemType":18}},{"3":{"ItemType":37}},{"3":{"ItemType":38}},{"2":{"Name":"Application_PropertyMap","Properties":{}}},{"3":{"ItemType":25}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":45}},{"3":{"ItemType":18}},{"2":{"Name":"AWS.KinesisAnalyticsV2/ApplicationProperties","Properties":{"ApplicationConfiguration":{"Type":9,"Flags":0,"Description":"Use this parameter to configure the application."},"ApplicationDescription":{"Type":4,"Flags":0,"Description":"The description of the application."},"ApplicationMaintenanceConfiguration":{"Type":10,"Flags":0,"Description":"Used to configure start of maintenance window."},"ApplicationMode":{"Type":4,"Flags":0,"Description":"To create a Kinesis Data Analytics Studio notebook, you must set the mode to `INTERACTIVE`. However, for a Kinesis Data Analytics for Apache Flink application, the mode is optional."},"ApplicationName":{"Type":4,"Flags":16,"Description":"The name of the application."},"RunConfiguration":{"Type":40,"Flags":4,"Description":"Specifies run configuration (start parameters) of a Kinesis Data Analytics application. Evaluated on update for RUNNING applications an only."},"RuntimeEnvironment":{"Type":4,"Flags":1,"Description":"The runtime environment for the application."},"ServiceExecutionRole":{"Type":4,"Flags":1,"Description":"Specifies the IAM role that the application uses to access external resources."},"Tags":{"Type":60,"Flags":0,"Description":"A list of one or more tags to assign to the application. A tag is a key-value pair that identifies an application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50."}}}},{"3":{"ItemType":44}},{"2":{"Name":"AWS.KinesisAnalyticsV2/Application","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":59,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.KinesisAnalyticsV2/Application@default","ScopeType":0,"Body":61}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "ApplicationCodeConfiguration", + "properties": { + "CodeContent": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The location and type of the application code." + }, + "CodeContentType": { + "type": { + "$ref": "#/42" + }, + "flags": 1, + "description": "Specifies whether the code content is in text or zip format." + } + } + }, + { + "$type": "ObjectType", + "name": "ApplicationConfiguration", + "properties": { + "ApplicationCodeConfiguration": { + "type": { + "$ref": "#/0" + }, + "flags": 0, + "description": "The code location and type parameters for a Flink-based Kinesis Data Analytics application." + }, + "ApplicationSnapshotConfiguration": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application." + }, + "ApplicationSystemRollbackConfiguration": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "Describes whether system initiated rollbacks are enabled for a Flink-based Kinesis Data Analytics application." + }, + "EnvironmentProperties": { + "type": { + "$ref": "#/14" + }, + "flags": 4, + "description": "Describes execution properties for a Flink-based Kinesis Data Analytics application." + }, + "FlinkApplicationConfiguration": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "The creation and update parameters for a Flink-based Kinesis Data Analytics application." + }, + "SqlApplicationConfiguration": { + "type": { + "$ref": "#/36" + }, + "flags": 0, + "description": "The creation and update parameters for a SQL-based Kinesis Data Analytics application." + }, + "VpcConfigurations": { + "type": { + "$ref": "#/43" + }, + "flags": 0, + "description": "The array of descriptions of VPC configurations available to the application." + }, + "ZeppelinApplicationConfiguration": { + "type": { + "$ref": "#/40" + }, + "flags": 0, + "description": "The configuration parameters for a Kinesis Data Analytics Studio notebook." + } + } + }, + { + "$type": "ObjectType", + "name": "ApplicationMaintenanceConfiguration", + "properties": { + "ApplicationMaintenanceWindowStartTime": { + "type": { + "$ref": "#/42" + }, + "flags": 1, + "description": "The start time for the maintenance window." + } + } + }, + { + "$type": "ObjectType", + "name": "ApplicationRestoreConfiguration", + "properties": { + "ApplicationRestoreType": { + "type": { + "$ref": "#/42" + }, + "flags": 1, + "description": "Specifies how the application should be restored." + }, + "SnapshotName": { + "type": { + "$ref": "#/42" + }, + "flags": 0, + "description": "The identifier of an existing snapshot of application state to use to restart an application. The application uses this value if RESTORE_FROM_CUSTOM_SNAPSHOT is specified for the ApplicationRestoreType." + } + } + }, + { + "$type": "ObjectType", + "name": "ApplicationSnapshotConfiguration", + "properties": { + "SnapshotsEnabled": { + "type": { + "$ref": "#/44" + }, + "flags": 1, + "description": "Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application." + } + } + }, + { + "$type": "ObjectType", + "name": "ApplicationSystemRollbackConfiguration", + "properties": { + "RollbackEnabled": { + "type": { + "$ref": "#/44" + }, + "flags": 1, + "description": "Describes whether system initiated rollbacks are enabled for a Flink-based Kinesis Data Analytics application." + } + } + }, + { + "$type": "ObjectType", + "name": "Arn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CSVMappingParameters", + "properties": { + "RecordColumnDelimiter": { + "type": { + "$ref": "#/42" + }, + "flags": 1, + "description": "The column delimiter. For example, in a CSV format, a comma (\",\") is the typical column delimiter." + }, + "RecordRowDelimiter": { + "type": { + "$ref": "#/42" + }, + "flags": 1, + "description": "The row delimiter. For example, in a CSV format, '\\n' is the typical row delimiter." + } + } + }, + { + "$type": "ObjectType", + "name": "CatalogConfiguration", + "properties": { + "GlueDataCatalogConfiguration": { + "type": { + "$ref": "#/17" + }, + "flags": 0, + "description": "The configuration parameters for the default Amazon Glue database. You use this database for Apache Flink SQL queries and table API transforms that you write in a Kinesis Data Analytics Studio notebook." + } + } + }, + { + "$type": "ObjectType", + "name": "CheckpointConfiguration", + "properties": { + "CheckpointInterval": { + "type": { + "$ref": "#/45" + }, + "flags": 0, + "description": "Describes the interval in milliseconds between checkpoint operations." + }, + "CheckpointingEnabled": { + "type": { + "$ref": "#/44" + }, + "flags": 0, + "description": "Describes whether checkpointing is enabled for a Flink-based Kinesis Data Analytics application." + }, + "ConfigurationType": { + "type": { + "$ref": "#/42" + }, + "flags": 1, + "description": "Describes whether the application uses Kinesis Data Analytics' default checkpointing behavior. You must set this property to `CUSTOM` in order to set the `CheckpointingEnabled`, `CheckpointInterval`, or `MinPauseBetweenCheckpoints` parameters." + }, + "MinPauseBetweenCheckpoints": { + "type": { + "$ref": "#/45" + }, + "flags": 0, + "description": "Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start. If a checkpoint operation takes longer than the CheckpointInterval, the application otherwise performs continual checkpoint operations. For more information, see Tuning Checkpointing in the Apache Flink Documentation." + } + } + }, + { + "$type": "ObjectType", + "name": "CodeContent", + "properties": { + "S3ContentLocation": { + "type": { + "$ref": "#/35" + }, + "flags": 0, + "description": "Information about the Amazon S3 bucket that contains the application code." + }, + "TextContent": { + "type": { + "$ref": "#/42" + }, + "flags": 0, + "description": "The text-format code for a Flink-based Kinesis Data Analytics application." + }, + "ZipFileContent": { + "type": { + "$ref": "#/42" + }, + "flags": 4, + "description": "The zip-format code for a Flink-based Kinesis Data Analytics application." + } + } + }, + { + "$type": "ObjectType", + "name": "CustomArtifactConfiguration", + "properties": { + "ArtifactType": { + "type": { + "$ref": "#/42" + }, + "flags": 1, + "description": "Set this to either `UDF` or `DEPENDENCY_JAR`. `UDF` stands for user-defined functions. This type of artifact must be in an S3 bucket. A `DEPENDENCY_JAR` can be in either Maven or an S3 bucket." + }, + "MavenReference": { + "type": { + "$ref": "#/27" + }, + "flags": 0, + "description": "The parameters required to fully specify a Maven reference." + }, + "S3ContentLocation": { + "type": { + "$ref": "#/35" + }, + "flags": 0, + "description": "The location of the custom artifacts." + } + } + }, + { + "$type": "ObjectType", + "name": "CustomArtifactsConfiguration", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DeployAsApplicationConfiguration", + "properties": { + "S3ContentLocation": { + "type": { + "$ref": "#/34" + }, + "flags": 1, + "description": "The description of an Amazon S3 object that contains the Amazon Data Analytics application, including the Amazon Resource Name (ARN) of the S3 bucket, the name of the Amazon S3 object that contains the data, and the version number of the Amazon S3 object that contains the data." + } + } + }, + { + "$type": "ObjectType", + "name": "EnvironmentProperties", + "properties": { + "PropertyGroups": { + "type": { + "$ref": "#/47" + }, + "flags": 0, + "description": "Describes the execution property groups." + } + } + }, + { + "$type": "ObjectType", + "name": "FlinkApplicationConfiguration", + "properties": { + "CheckpointConfiguration": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance. For more information, see Checkpoints for Fault Tolerance in the Apache Flink Documentation." + }, + "MonitoringConfiguration": { + "type": { + "$ref": "#/28" + }, + "flags": 0, + "description": "Describes configuration parameters for Amazon CloudWatch logging for an application." + }, + "ParallelismConfiguration": { + "type": { + "$ref": "#/29" + }, + "flags": 0, + "description": "Describes parameters for how an application executes multiple tasks simultaneously." + } + } + }, + { + "$type": "ObjectType", + "name": "FlinkRunConfiguration", + "properties": { + "AllowNonRestoredState": { + "type": { + "$ref": "#/44" + }, + "flags": 0, + "description": "When restoring from a snapshot, specifies whether the runtime is allowed to skip a state that cannot be mapped to the new program. Defaults to false. If you update your application without specifying this parameter, AllowNonRestoredState will be set to false, even if it was previously set to true." + } + } + }, + { + "$type": "ObjectType", + "name": "GlueDataCatalogConfiguration", + "properties": { + "DatabaseARN": { + "type": { + "$ref": "#/42" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the database." + } + } + }, + { + "$type": "ObjectType", + "name": "Input", + "properties": { + "InputParallelism": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "Describes the number of in-application streams to create." + }, + "InputProcessingConfiguration": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "The InputProcessingConfiguration for the input. An input processor transforms records as they are received from the stream, before the application's SQL code executes. Currently, the only input processing configuration available is InputLambdaProcessor." + }, + "InputSchema": { + "type": { + "$ref": "#/22" + }, + "flags": 1, + "description": "Describes 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." + }, + "KinesisFirehoseInput": { + "type": { + "$ref": "#/24" + }, + "flags": 0, + "description": "If the streaming source is an Amazon Kinesis Data Firehose delivery stream, identifies the delivery stream's ARN." + }, + "KinesisStreamsInput": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "If the streaming source is an Amazon Kinesis data stream, identifies the stream's Amazon Resource Name (ARN)." + }, + "NamePrefix": { + "type": { + "$ref": "#/42" + }, + "flags": 1, + "description": "The name prefix to use when creating an in-application stream. Suppose that you specify a prefix `\"MyInApplicationStream\"`. Kinesis Data Analytics then creates one or more (as per the InputParallelism count you specified) in-application streams with the names `\"MyInApplicationStream_001\"`, `\"MyInApplicationStream_002\"`, and so on." + } + } + }, + { + "$type": "ObjectType", + "name": "InputLambdaProcessor", + "properties": { + "ResourceARN": { + "type": { + "$ref": "#/42" + }, + "flags": 1, + "description": "The ARN of the Amazon Lambda function that operates on records in the stream." + } + } + }, + { + "$type": "ObjectType", + "name": "InputParallelism", + "properties": { + "Count": { + "type": { + "$ref": "#/45" + }, + "flags": 0, + "description": "The number of in-application streams to create." + } + } + }, + { + "$type": "ObjectType", + "name": "InputProcessingConfiguration", + "properties": { + "InputLambdaProcessor": { + "type": { + "$ref": "#/19" + }, + "flags": 0, + "description": "The InputLambdaProcessor that is used to preprocess the records in the stream before being processed by your application code." + } + } + }, + { + "$type": "ObjectType", + "name": "InputSchema", + "properties": { + "RecordColumns": { + "type": { + "$ref": "#/48" + }, + "flags": 1, + "description": "A list of `RecordColumn` objects." + }, + "RecordEncoding": { + "type": { + "$ref": "#/42" + }, + "flags": 0, + "description": "Specifies the encoding of the records in the streaming source. For example, UTF-8." + }, + "RecordFormat": { + "type": { + "$ref": "#/32" + }, + "flags": 1, + "description": "Specifies the format of the records on the streaming source." + } + } + }, + { + "$type": "ObjectType", + "name": "JSONMappingParameters", + "properties": { + "RecordRowPath": { + "type": { + "$ref": "#/42" + }, + "flags": 1, + "description": "The path to the top-level parent that contains the records." + } + } + }, + { + "$type": "ObjectType", + "name": "KinesisFirehoseInput", + "properties": { + "ResourceARN": { + "type": { + "$ref": "#/42" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of the delivery stream." + } + } + }, + { + "$type": "ObjectType", + "name": "KinesisStreamsInput", + "properties": { + "ResourceARN": { + "type": { + "$ref": "#/42" + }, + "flags": 1, + "description": "The ARN of the input Kinesis data stream to read." + } + } + }, + { + "$type": "ObjectType", + "name": "MappingParameters", + "properties": { + "CSVMappingParameters": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "Provides additional mapping information when the record format uses delimiters (for example, CSV)." + }, + "JSONMappingParameters": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "Provides additional mapping information when JSON is the record format on the streaming source." + } + } + }, + { + "$type": "ObjectType", + "name": "MavenReference", + "properties": { + "ArtifactId": { + "type": { + "$ref": "#/42" + }, + "flags": 1, + "description": "The artifact ID of the Maven reference." + }, + "GroupId": { + "type": { + "$ref": "#/42" + }, + "flags": 1, + "description": "The group ID of the Maven reference." + }, + "Version": { + "type": { + "$ref": "#/42" + }, + "flags": 1, + "description": "The version of the Maven reference." + } + } + }, + { + "$type": "ObjectType", + "name": "MonitoringConfiguration", + "properties": { + "ConfigurationType": { + "type": { + "$ref": "#/42" + }, + "flags": 1, + "description": "Describes whether to use the default CloudWatch logging configuration for an application. You must set this property to CUSTOM in order to set the LogLevel or MetricsLevel parameters." + }, + "LogLevel": { + "type": { + "$ref": "#/42" + }, + "flags": 0, + "description": "Describes the verbosity of the CloudWatch Logs for an application." + }, + "MetricsLevel": { + "type": { + "$ref": "#/42" + }, + "flags": 0, + "description": "Describes the granularity of the CloudWatch Logs for an application. The Parallelism level is not recommended for applications with a Parallelism over 64 due to excessive costs." + } + } + }, + { + "$type": "ObjectType", + "name": "ParallelismConfiguration", + "properties": { + "AutoScalingEnabled": { + "type": { + "$ref": "#/44" + }, + "flags": 0, + "description": "Describes whether the Kinesis Data Analytics service can increase the parallelism of the application in response to increased throughput." + }, + "ConfigurationType": { + "type": { + "$ref": "#/42" + }, + "flags": 1, + "description": "Describes whether the application uses the default parallelism for the Kinesis Data Analytics service. You must set this property to `CUSTOM` in order to change your application's `AutoScalingEnabled`, `Parallelism`, or `ParallelismPerKPU` properties." + }, + "Parallelism": { + "type": { + "$ref": "#/45" + }, + "flags": 0, + "description": "Describes the initial number of parallel tasks that a Java-based Kinesis Data Analytics application can perform. The Kinesis Data Analytics service can increase this number automatically if ParallelismConfiguration:AutoScalingEnabled is set to true." + }, + "ParallelismPerKPU": { + "type": { + "$ref": "#/45" + }, + "flags": 0, + "description": "Describes the number of parallel tasks that a Java-based Kinesis Data Analytics application can perform per Kinesis Processing Unit (KPU) used by the application. For more information about KPUs, see Amazon Kinesis Data Analytics Pricing." + } + } + }, + { + "$type": "ObjectType", + "name": "PropertyGroup", + "properties": { + "PropertyGroupId": { + "type": { + "$ref": "#/42" + }, + "flags": 0, + "description": "Describes the key of an application execution property key-value pair." + }, + "PropertyMap": { + "type": { + "$ref": "#/49" + }, + "flags": 0, + "description": "Describes the value of an application execution property key-value pair." + } + } + }, + { + "$type": "ObjectType", + "name": "RecordColumn", + "properties": { + "Mapping": { + "type": { + "$ref": "#/42" + }, + "flags": 0, + "description": "A reference to the data element in the streaming input or the reference data source." + }, + "Name": { + "type": { + "$ref": "#/42" + }, + "flags": 1, + "description": "The name of the column that is created in the in-application input stream or reference table." + }, + "SqlType": { + "type": { + "$ref": "#/42" + }, + "flags": 1, + "description": "The type of column created in the in-application input stream or reference table." + } + } + }, + { + "$type": "ObjectType", + "name": "RecordFormat", + "properties": { + "MappingParameters": { + "type": { + "$ref": "#/26" + }, + "flags": 0, + "description": "When you configure application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source." + }, + "RecordFormatType": { + "type": { + "$ref": "#/42" + }, + "flags": 1, + "description": "The type of record format." + } + } + }, + { + "$type": "ObjectType", + "name": "RunConfiguration", + "properties": { + "ApplicationRestoreConfiguration": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "Describes the restore behavior of a restarting application." + }, + "FlinkRunConfiguration": { + "type": { + "$ref": "#/16" + }, + "flags": 0, + "description": "Describes the starting parameters for a Flink-based Kinesis Data Analytics application." + } + } + }, + { + "$type": "ObjectType", + "name": "S3ContentBaseLocation", + "properties": { + "BasePath": { + "type": { + "$ref": "#/42" + }, + "flags": 0, + "description": "The base path for the S3 bucket." + }, + "BucketARN": { + "type": { + "$ref": "#/42" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of the S3 bucket." + } + } + }, + { + "$type": "ObjectType", + "name": "S3ContentLocation", + "properties": { + "BucketARN": { + "type": { + "$ref": "#/42" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) for the S3 bucket containing the application code." + }, + "FileKey": { + "type": { + "$ref": "#/42" + }, + "flags": 1, + "description": "The file key for the object containing the application code." + }, + "ObjectVersion": { + "type": { + "$ref": "#/42" + }, + "flags": 0, + "description": "The version of the object containing the application code." + } + } + }, + { + "$type": "ObjectType", + "name": "SqlApplicationConfiguration", + "properties": { + "Inputs": { + "type": { + "$ref": "#/50" + }, + "flags": 0, + "description": "The array of Input objects describing the input streams used by the application." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/42" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that's 1 to 128 Unicode characters in length and can't be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/42" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that's 0 to 256 characters in length." + } + } + }, + { + "$type": "ObjectType", + "name": "VpcConfiguration", + "properties": { + "SecurityGroupIds": { + "type": { + "$ref": "#/51" + }, + "flags": 1, + "description": "The array of SecurityGroup IDs used by the VPC configuration." + }, + "SubnetIds": { + "type": { + "$ref": "#/52" + }, + "flags": 1, + "description": "The array of Subnet IDs used by the VPC configuration." + } + } + }, + { + "$type": "ObjectType", + "name": "VpcConfigurations", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ZeppelinApplicationConfiguration", + "properties": { + "CatalogConfiguration": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The Amazon Glue Data Catalog that you use in queries in a Kinesis Data Analytics Studio notebook." + }, + "CustomArtifactsConfiguration": { + "type": { + "$ref": "#/54" + }, + "flags": 0, + "description": "A list of CustomArtifactConfiguration objects." + }, + "DeployAsApplicationConfiguration": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "The information required to deploy a Kinesis Data Analytics Studio notebook as an application with durable state." + }, + "MonitoringConfiguration": { + "type": { + "$ref": "#/41" + }, + "flags": 0, + "description": "The monitoring configuration of a Kinesis Data Analytics Studio notebook." + } + } + }, + { + "$type": "ObjectType", + "name": "ZeppelinMonitoringConfiguration", + "properties": { + "LogLevel": { + "type": { + "$ref": "#/42" + }, + "flags": 0, + "description": "The verbosity of the CloudWatch Logs for an application. You can set it to `INFO`, `WARN`, `ERROR`, or `DEBUG`." + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/38" + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/11" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/30" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/31" + } + }, + { + "$type": "ObjectType", + "name": "Application_PropertyMap", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/18" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/42" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/42" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/38" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/11" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.KinesisAnalyticsV2/ApplicationProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/37" + } + }, + { + "$type": "ObjectType", + "name": "AWS.KinesisAnalyticsV2/ApplicationProperties", + "properties": { + "ApplicationConfiguration": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Use this parameter to configure the application." + }, + "ApplicationDescription": { + "type": { + "$ref": "#/42" + }, + "flags": 0, + "description": "The description of the application." + }, + "ApplicationMaintenanceConfiguration": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "Used to configure start of maintenance window." + }, + "ApplicationMode": { + "type": { + "$ref": "#/42" + }, + "flags": 0, + "description": "To create a Kinesis Data Analytics Studio notebook, you must set the mode to `INTERACTIVE`. However, for a Kinesis Data Analytics for Apache Flink application, the mode is optional." + }, + "ApplicationName": { + "type": { + "$ref": "#/42" + }, + "flags": 16, + "description": "The name of the application." + }, + "RunConfiguration": { + "type": { + "$ref": "#/33" + }, + "flags": 4, + "description": "Specifies run configuration (start parameters) of a Kinesis Data Analytics application. Evaluated on update for RUNNING applications an only." + }, + "RuntimeEnvironment": { + "type": { + "$ref": "#/42" + }, + "flags": 1, + "description": "The runtime environment for the application." + }, + "ServiceExecutionRole": { + "type": { + "$ref": "#/42" + }, + "flags": 1, + "description": "Specifies the IAM role that the application uses to access external resources." + }, + "Tags": { + "type": { + "$ref": "#/56" + }, + "flags": 0, + "description": "A list of one or more tags to assign to the application. A tag is a key-value pair that identifies an application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.KinesisAnalyticsV2/Application", + "properties": { + "name": { + "type": { + "$ref": "#/42" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/42" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/57" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.KinesisAnalyticsV2/Application@default", + "scopeType": 0, + "body": { + "$ref": "#/58" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.kinesisanalyticsv2/default/types.md b/artifacts/bicep/aws/aws.kinesisanalyticsv2/default/types.md index f49bdd3d..1e50ccef 100644 --- a/artifacts/bicep/aws/aws.kinesisanalyticsv2/default/types.md +++ b/artifacts/bicep/aws/aws.kinesisanalyticsv2/default/types.md @@ -3,9 +3,45 @@ ## Resource AWS.KinesisAnalyticsV2/Application@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.KinesisAnalyticsV2/ApplicationProperties](#awskinesisanalyticsv2applicationproperties) (Required): properties of the resource +* **properties**: [AWS.KinesisAnalyticsV2/ApplicationProperties](#awskinesisanalyticsv2applicationproperties) (Required, Identifier): properties of the resource + +## Application_PropertyMap +### Properties + +## ApplicationCodeConfiguration +### Properties +* **CodeContent**: [CodeContent](#codecontent) (Required): The location and type of the application code. +* **CodeContentType**: string (Required): Specifies whether the code content is in text or zip format. + +## ApplicationConfiguration +### Properties +* **ApplicationCodeConfiguration**: [ApplicationCodeConfiguration](#applicationcodeconfiguration): The code location and type parameters for a Flink-based Kinesis Data Analytics application. +* **ApplicationSnapshotConfiguration**: [ApplicationSnapshotConfiguration](#applicationsnapshotconfiguration): Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application. +* **ApplicationSystemRollbackConfiguration**: [ApplicationSystemRollbackConfiguration](#applicationsystemrollbackconfiguration): Describes whether system initiated rollbacks are enabled for a Flink-based Kinesis Data Analytics application. +* **EnvironmentProperties**: [EnvironmentProperties](#environmentproperties) (WriteOnly): Describes execution properties for a Flink-based Kinesis Data Analytics application. +* **FlinkApplicationConfiguration**: [FlinkApplicationConfiguration](#flinkapplicationconfiguration): The creation and update parameters for a Flink-based Kinesis Data Analytics application. +* **SqlApplicationConfiguration**: [SqlApplicationConfiguration](#sqlapplicationconfiguration): The creation and update parameters for a SQL-based Kinesis Data Analytics application. +* **VpcConfigurations**: [VpcConfiguration](#vpcconfiguration)[]: The array of descriptions of VPC configurations available to the application. +* **ZeppelinApplicationConfiguration**: [ZeppelinApplicationConfiguration](#zeppelinapplicationconfiguration): The configuration parameters for a Kinesis Data Analytics Studio notebook. + +## ApplicationMaintenanceConfiguration +### Properties +* **ApplicationMaintenanceWindowStartTime**: string (Required): The start time for the maintenance window. + +## ApplicationRestoreConfiguration +### Properties +* **ApplicationRestoreType**: string (Required): Specifies how the application should be restored. +* **SnapshotName**: string: The identifier of an existing snapshot of application state to use to restart an application. The application uses this value if RESTORE_FROM_CUSTOM_SNAPSHOT is specified for the ApplicationRestoreType. + +## ApplicationSnapshotConfiguration +### Properties +* **SnapshotsEnabled**: bool (Required): Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application. + +## ApplicationSystemRollbackConfiguration +### Properties +* **RollbackEnabled**: bool (Required): Describes whether system initiated rollbacks are enabled for a Flink-based Kinesis Data Analytics application. ## AWS.KinesisAnalyticsV2/ApplicationProperties ### Properties @@ -19,20 +55,16 @@ * **ServiceExecutionRole**: string (Required): Specifies the IAM role that the application uses to access external resources. * **Tags**: [Tag](#tag)[]: A list of one or more tags to assign to the application. A tag is a key-value pair that identifies an application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50. -## ApplicationConfiguration +## CatalogConfiguration ### Properties -* **ApplicationCodeConfiguration**: [ApplicationCodeConfiguration](#applicationcodeconfiguration): The code location and type parameters for a Flink-based Kinesis Data Analytics application. -* **ApplicationSnapshotConfiguration**: [ApplicationSnapshotConfiguration](#applicationsnapshotconfiguration): Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application. -* **EnvironmentProperties**: [EnvironmentProperties](#environmentproperties) (WriteOnly): Describes execution properties for a Flink-based Kinesis Data Analytics application. -* **FlinkApplicationConfiguration**: [FlinkApplicationConfiguration](#flinkapplicationconfiguration): The creation and update parameters for a Flink-based Kinesis Data Analytics application. -* **SqlApplicationConfiguration**: [SqlApplicationConfiguration](#sqlapplicationconfiguration): The creation and update parameters for a SQL-based Kinesis Data Analytics application. -* **VpcConfigurations**: [VpcConfiguration](#vpcconfiguration)[]: The array of descriptions of VPC configurations available to the application. -* **ZeppelinApplicationConfiguration**: [ZeppelinApplicationConfiguration](#zeppelinapplicationconfiguration): The configuration parameters for a Kinesis Data Analytics Studio notebook. +* **GlueDataCatalogConfiguration**: [GlueDataCatalogConfiguration](#gluedatacatalogconfiguration): The configuration parameters for the default Amazon Glue database. You use this database for Apache Flink SQL queries and table API transforms that you write in a Kinesis Data Analytics Studio notebook. -## ApplicationCodeConfiguration +## CheckpointConfiguration ### Properties -* **CodeContent**: [CodeContent](#codecontent) (Required): The location and type of the application code. -* **CodeContentType**: string (Required): Specifies whether the code content is in text or zip format. +* **CheckpointingEnabled**: bool: Describes whether checkpointing is enabled for a Flink-based Kinesis Data Analytics application. +* **CheckpointInterval**: int: Describes the interval in milliseconds between checkpoint operations. +* **ConfigurationType**: string (Required): Describes whether the application uses Kinesis Data Analytics' default checkpointing behavior. You must set this property to `CUSTOM` in order to set the `CheckpointingEnabled`, `CheckpointInterval`, or `MinPauseBetweenCheckpoints` parameters. +* **MinPauseBetweenCheckpoints**: int: Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start. If a checkpoint operation takes longer than the CheckpointInterval, the application otherwise performs continual checkpoint operations. For more information, see Tuning Checkpointing in the Apache Flink Documentation. ## CodeContent ### Properties @@ -40,27 +72,24 @@ * **TextContent**: string: The text-format code for a Flink-based Kinesis Data Analytics application. * **ZipFileContent**: string (WriteOnly): The zip-format code for a Flink-based Kinesis Data Analytics application. -## S3ContentLocation -### Properties -* **BucketARN**: string (Required): The Amazon Resource Name (ARN) for the S3 bucket containing the application code. -* **FileKey**: string (Required): The file key for the object containing the application code. -* **ObjectVersion**: string: The version of the object containing the application code. - -## ApplicationSnapshotConfiguration +## CSVMappingParameters ### Properties -* **SnapshotsEnabled**: bool (Required): Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application. +* **RecordColumnDelimiter**: string (Required): The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter. +* **RecordRowDelimiter**: string (Required): The row delimiter. For example, in a CSV format, '\n' is the typical row delimiter. -## EnvironmentProperties +## CustomArtifactConfiguration ### Properties -* **PropertyGroups**: [PropertyGroup](#propertygroup)[]: Describes the execution property groups. +* **ArtifactType**: string (Required): Set this to either `UDF` or `DEPENDENCY_JAR`. `UDF` stands for user-defined functions. This type of artifact must be in an S3 bucket. A `DEPENDENCY_JAR` can be in either Maven or an S3 bucket. +* **MavenReference**: [MavenReference](#mavenreference): The parameters required to fully specify a Maven reference. +* **S3ContentLocation**: [S3ContentLocation](#s3contentlocation): The location of the custom artifacts. -## PropertyGroup +## DeployAsApplicationConfiguration ### Properties -* **PropertyGroupId**: string: Describes the key of an application execution property key-value pair. -* **PropertyMap**: [Application_PropertyMap](#applicationpropertymap): Describes the value of an application execution property key-value pair. +* **S3ContentLocation**: [S3ContentBaseLocation](#s3contentbaselocation) (Required): The description of an Amazon S3 object that contains the Amazon Data Analytics application, including the Amazon Resource Name (ARN) of the S3 bucket, the name of the Amazon S3 object that contains the data, and the version number of the Amazon S3 object that contains the data. -## Application_PropertyMap +## EnvironmentProperties ### Properties +* **PropertyGroups**: [PropertyGroup](#propertygroup)[]: Describes the execution property groups. ## FlinkApplicationConfiguration ### Properties @@ -68,29 +97,13 @@ * **MonitoringConfiguration**: [MonitoringConfiguration](#monitoringconfiguration): Describes configuration parameters for Amazon CloudWatch logging for an application. * **ParallelismConfiguration**: [ParallelismConfiguration](#parallelismconfiguration): Describes parameters for how an application executes multiple tasks simultaneously. -## CheckpointConfiguration -### Properties -* **CheckpointingEnabled**: bool: Describes whether checkpointing is enabled for a Flink-based Kinesis Data Analytics application. -* **CheckpointInterval**: int: Describes the interval in milliseconds between checkpoint operations. -* **ConfigurationType**: string (Required): Describes whether the application uses Kinesis Data Analytics' default checkpointing behavior. You must set this property to `CUSTOM` in order to set the `CheckpointingEnabled`, `CheckpointInterval`, or `MinPauseBetweenCheckpoints` parameters. -* **MinPauseBetweenCheckpoints**: int: Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start. If a checkpoint operation takes longer than the CheckpointInterval, the application otherwise performs continual checkpoint operations. For more information, see Tuning Checkpointing in the Apache Flink Documentation. - -## MonitoringConfiguration -### Properties -* **ConfigurationType**: string (Required): Describes whether to use the default CloudWatch logging configuration for an application. You must set this property to CUSTOM in order to set the LogLevel or MetricsLevel parameters. -* **LogLevel**: string: Describes the verbosity of the CloudWatch Logs for an application. -* **MetricsLevel**: string: Describes the granularity of the CloudWatch Logs for an application. The Parallelism level is not recommended for applications with a Parallelism over 64 due to excessive costs. - -## ParallelismConfiguration +## FlinkRunConfiguration ### Properties -* **AutoScalingEnabled**: bool: Describes whether the Kinesis Data Analytics service can increase the parallelism of the application in response to increased throughput. -* **ConfigurationType**: string (Required): Describes whether the application uses the default parallelism for the Kinesis Data Analytics service. You must set this property to `CUSTOM` in order to change your application's `AutoScalingEnabled`, `Parallelism`, or `ParallelismPerKPU` properties. -* **Parallelism**: int: Describes the initial number of parallel tasks that a Java-based Kinesis Data Analytics application can perform. The Kinesis Data Analytics service can increase this number automatically if ParallelismConfiguration:AutoScalingEnabled is set to true. -* **ParallelismPerKPU**: int: Describes the number of parallel tasks that a Java-based Kinesis Data Analytics application can perform per Kinesis Processing Unit (KPU) used by the application. For more information about KPUs, see Amazon Kinesis Data Analytics Pricing. +* **AllowNonRestoredState**: bool: When restoring from a snapshot, specifies whether the runtime is allowed to skip a state that cannot be mapped to the new program. Defaults to false. If you update your application without specifying this parameter, AllowNonRestoredState will be set to false, even if it was previously set to true. -## SqlApplicationConfiguration +## GlueDataCatalogConfiguration ### Properties -* **Inputs**: [Input](#input)[]: The array of Input objects describing the input streams used by the application. +* **DatabaseARN**: string: The Amazon Resource Name (ARN) of the database. ## Input ### Properties @@ -101,6 +114,10 @@ * **KinesisStreamsInput**: [KinesisStreamsInput](#kinesisstreamsinput): If the streaming source is an Amazon Kinesis data stream, identifies the stream's Amazon Resource Name (ARN). * **NamePrefix**: string (Required): The name prefix to use when creating an in-application stream. Suppose that you specify a prefix `"MyInApplicationStream"`. Kinesis Data Analytics then creates one or more (as per the InputParallelism count you specified) in-application streams with the names `"MyInApplicationStream_001"`, `"MyInApplicationStream_002"`, and so on. +## InputLambdaProcessor +### Properties +* **ResourceARN**: string (Required): The ARN of the Amazon Lambda function that operates on records in the stream. + ## InputParallelism ### Properties * **Count**: int: The number of in-application streams to create. @@ -109,37 +126,12 @@ ### Properties * **InputLambdaProcessor**: [InputLambdaProcessor](#inputlambdaprocessor): The InputLambdaProcessor that is used to preprocess the records in the stream before being processed by your application code. -## InputLambdaProcessor -### Properties -* **ResourceARN**: string (Required): The ARN of the Amazon Lambda function that operates on records in the stream. - ## InputSchema ### Properties * **RecordColumns**: [RecordColumn](#recordcolumn)[] (Required): A list of `RecordColumn` objects. * **RecordEncoding**: string: Specifies the encoding of the records in the streaming source. For example, UTF-8. * **RecordFormat**: [RecordFormat](#recordformat) (Required): Specifies the format of the records on the streaming source. -## RecordColumn -### Properties -* **Mapping**: string: A reference to the data element in the streaming input or the reference data source. -* **Name**: string (Required): The name of the column that is created in the in-application input stream or reference table. -* **SqlType**: string (Required): The type of column created in the in-application input stream or reference table. - -## RecordFormat -### Properties -* **MappingParameters**: [MappingParameters](#mappingparameters): When you configure application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source. -* **RecordFormatType**: string (Required): The type of record format. - -## MappingParameters -### Properties -* **CSVMappingParameters**: [CSVMappingParameters](#csvmappingparameters): Provides additional mapping information when the record format uses delimiters (for example, CSV). -* **JSONMappingParameters**: [JSONMappingParameters](#jsonmappingparameters): Provides additional mapping information when JSON is the record format on the streaming source. - -## CSVMappingParameters -### Properties -* **RecordColumnDelimiter**: string (Required): The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter. -* **RecordRowDelimiter**: string (Required): The row delimiter. For example, in a CSV format, '\n' is the typical row delimiter. - ## JSONMappingParameters ### Properties * **RecordRowPath**: string (Required): The path to the top-level parent that contains the records. @@ -152,71 +144,84 @@ ### Properties * **ResourceARN**: string (Required): The ARN of the input Kinesis data stream to read. -## VpcConfiguration +## MappingParameters ### Properties -* **SecurityGroupIds**: string[] (Required): The array of SecurityGroup IDs used by the VPC configuration. -* **SubnetIds**: string[] (Required): The array of Subnet IDs used by the VPC configuration. +* **CSVMappingParameters**: [CSVMappingParameters](#csvmappingparameters): Provides additional mapping information when the record format uses delimiters (for example, CSV). +* **JSONMappingParameters**: [JSONMappingParameters](#jsonmappingparameters): Provides additional mapping information when JSON is the record format on the streaming source. -## ZeppelinApplicationConfiguration +## MavenReference ### Properties -* **CatalogConfiguration**: [CatalogConfiguration](#catalogconfiguration): The Amazon Glue Data Catalog that you use in queries in a Kinesis Data Analytics Studio notebook. -* **CustomArtifactsConfiguration**: [CustomArtifactConfiguration](#customartifactconfiguration)[]: A list of CustomArtifactConfiguration objects. -* **DeployAsApplicationConfiguration**: [DeployAsApplicationConfiguration](#deployasapplicationconfiguration): The information required to deploy a Kinesis Data Analytics Studio notebook as an application with durable state. -* **MonitoringConfiguration**: [ZeppelinMonitoringConfiguration](#zeppelinmonitoringconfiguration): The monitoring configuration of a Kinesis Data Analytics Studio notebook. +* **ArtifactId**: string (Required): The artifact ID of the Maven reference. +* **GroupId**: string (Required): The group ID of the Maven reference. +* **Version**: string (Required): The version of the Maven reference. -## CatalogConfiguration +## MonitoringConfiguration ### Properties -* **GlueDataCatalogConfiguration**: [GlueDataCatalogConfiguration](#gluedatacatalogconfiguration): The configuration parameters for the default Amazon Glue database. You use this database for Apache Flink SQL queries and table API transforms that you write in a Kinesis Data Analytics Studio notebook. +* **ConfigurationType**: string (Required): Describes whether to use the default CloudWatch logging configuration for an application. You must set this property to CUSTOM in order to set the LogLevel or MetricsLevel parameters. +* **LogLevel**: string: Describes the verbosity of the CloudWatch Logs for an application. +* **MetricsLevel**: string: Describes the granularity of the CloudWatch Logs for an application. The Parallelism level is not recommended for applications with a Parallelism over 64 due to excessive costs. -## GlueDataCatalogConfiguration +## ParallelismConfiguration ### Properties -* **DatabaseARN**: string: The Amazon Resource Name (ARN) of the database. +* **AutoScalingEnabled**: bool: Describes whether the Kinesis Data Analytics service can increase the parallelism of the application in response to increased throughput. +* **ConfigurationType**: string (Required): Describes whether the application uses the default parallelism for the Kinesis Data Analytics service. You must set this property to `CUSTOM` in order to change your application's `AutoScalingEnabled`, `Parallelism`, or `ParallelismPerKPU` properties. +* **Parallelism**: int: Describes the initial number of parallel tasks that a Java-based Kinesis Data Analytics application can perform. The Kinesis Data Analytics service can increase this number automatically if ParallelismConfiguration:AutoScalingEnabled is set to true. +* **ParallelismPerKPU**: int: Describes the number of parallel tasks that a Java-based Kinesis Data Analytics application can perform per Kinesis Processing Unit (KPU) used by the application. For more information about KPUs, see Amazon Kinesis Data Analytics Pricing. -## CustomArtifactConfiguration +## PropertyGroup ### Properties -* **ArtifactType**: string (Required): Set this to either `UDF` or `DEPENDENCY_JAR`. `UDF` stands for user-defined functions. This type of artifact must be in an S3 bucket. A `DEPENDENCY_JAR` can be in either Maven or an S3 bucket. -* **MavenReference**: [MavenReference](#mavenreference): The parameters required to fully specify a Maven reference. -* **S3ContentLocation**: [S3ContentLocation](#s3contentlocation): The location of the custom artifacts. +* **PropertyGroupId**: string: Describes the key of an application execution property key-value pair. +* **PropertyMap**: [Application_PropertyMap](#applicationpropertymap): Describes the value of an application execution property key-value pair. -## MavenReference +## RecordColumn ### Properties -* **ArtifactId**: string (Required): The artifact ID of the Maven reference. -* **GroupId**: string (Required): The group ID of the Maven reference. -* **Version**: string (Required): The version of the Maven reference. +* **Mapping**: string: A reference to the data element in the streaming input or the reference data source. +* **Name**: string (Required): The name of the column that is created in the in-application input stream or reference table. +* **SqlType**: string (Required): The type of column created in the in-application input stream or reference table. -## DeployAsApplicationConfiguration +## RecordFormat ### Properties -* **S3ContentLocation**: [S3ContentBaseLocation](#s3contentbaselocation) (Required): The description of an Amazon S3 object that contains the Amazon Data Analytics application, including the Amazon Resource Name (ARN) of the S3 bucket, the name of the Amazon S3 object that contains the data, and the version number of the Amazon S3 object that contains the data. +* **MappingParameters**: [MappingParameters](#mappingparameters): When you configure application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source. +* **RecordFormatType**: string (Required): The type of record format. + +## RunConfiguration +### Properties +* **ApplicationRestoreConfiguration**: [ApplicationRestoreConfiguration](#applicationrestoreconfiguration): Describes the restore behavior of a restarting application. +* **FlinkRunConfiguration**: [FlinkRunConfiguration](#flinkrunconfiguration): Describes the starting parameters for a Flink-based Kinesis Data Analytics application. ## S3ContentBaseLocation ### Properties * **BasePath**: string: The base path for the S3 bucket. * **BucketARN**: string (Required): The Amazon Resource Name (ARN) of the S3 bucket. -## ZeppelinMonitoringConfiguration +## S3ContentLocation ### Properties -* **LogLevel**: string: The verbosity of the CloudWatch Logs for an application. You can set it to `INFO`, `WARN`, `ERROR`, or `DEBUG`. +* **BucketARN**: string (Required): The Amazon Resource Name (ARN) for the S3 bucket containing the application code. +* **FileKey**: string (Required): The file key for the object containing the application code. +* **ObjectVersion**: string: The version of the object containing the application code. -## ApplicationMaintenanceConfiguration +## SqlApplicationConfiguration ### Properties -* **ApplicationMaintenanceWindowStartTime**: string (Required): The start time for the maintenance window. +* **Inputs**: [Input](#input)[]: The array of Input objects describing the input streams used by the application. -## RunConfiguration +## Tag ### Properties -* **ApplicationRestoreConfiguration**: [ApplicationRestoreConfiguration](#applicationrestoreconfiguration): Describes the restore behavior of a restarting application. -* **FlinkRunConfiguration**: [FlinkRunConfiguration](#flinkrunconfiguration): Describes the starting parameters for a Flink-based Kinesis Data Analytics application. +* **Key**: string (Required): The key name of the tag. You can specify a value that's 1 to 128 Unicode characters in length and can't be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that's 0 to 256 characters in length. -## ApplicationRestoreConfiguration +## VpcConfiguration ### Properties -* **ApplicationRestoreType**: string (Required): Specifies how the application should be restored. -* **SnapshotName**: string: The identifier of an existing snapshot of application state to use to restart an application. The application uses this value if RESTORE_FROM_CUSTOM_SNAPSHOT is specified for the ApplicationRestoreType. +* **SecurityGroupIds**: string[] (Required): The array of SecurityGroup IDs used by the VPC configuration. +* **SubnetIds**: string[] (Required): The array of Subnet IDs used by the VPC configuration. -## FlinkRunConfiguration +## ZeppelinApplicationConfiguration ### Properties -* **AllowNonRestoredState**: bool: When restoring from a snapshot, specifies whether the runtime is allowed to skip a state that cannot be mapped to the new program. Defaults to false. If you update your application without specifying this parameter, AllowNonRestoredState will be set to false, even if it was previously set to true. +* **CatalogConfiguration**: [CatalogConfiguration](#catalogconfiguration): The Amazon Glue Data Catalog that you use in queries in a Kinesis Data Analytics Studio notebook. +* **CustomArtifactsConfiguration**: [CustomArtifactConfiguration](#customartifactconfiguration)[]: A list of CustomArtifactConfiguration objects. +* **DeployAsApplicationConfiguration**: [DeployAsApplicationConfiguration](#deployasapplicationconfiguration): The information required to deploy a Kinesis Data Analytics Studio notebook as an application with durable state. +* **MonitoringConfiguration**: [ZeppelinMonitoringConfiguration](#zeppelinmonitoringconfiguration): The monitoring configuration of a Kinesis Data Analytics Studio notebook. -## Tag +## ZeppelinMonitoringConfiguration ### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that's 1 to 128 Unicode characters in length and can't be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that's 0 to 256 characters in length. +* **LogLevel**: string: The verbosity of the CloudWatch Logs for an application. You can set it to `INFO`, `WARN`, `ERROR`, or `DEBUG`. diff --git a/artifacts/bicep/aws/aws.kinesisfirehose/default/types.json b/artifacts/bicep/aws/aws.kinesisfirehose/default/types.json index 3d29bce8..9ad65765 100644 --- a/artifacts/bicep/aws/aws.kinesisfirehose/default/types.json +++ b/artifacts/bicep/aws/aws.kinesisfirehose/default/types.json @@ -1 +1,1784 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"AmazonOpenSearchServerlessBufferingHints","Properties":{"IntervalInSeconds":{"Type":3,"Flags":0},"SizeInMBs":{"Type":3,"Flags":0}}}},{"2":{"Name":"AmazonOpenSearchServerlessDestinationConfiguration","Properties":{"BufferingHints":{"Type":8,"Flags":0},"CloudWatchLoggingOptions":{"Type":16,"Flags":0},"CollectionEndpoint":{"Type":4,"Flags":0},"IndexName":{"Type":4,"Flags":1},"ProcessingConfiguration":{"Type":41,"Flags":0},"RetryOptions":{"Type":10,"Flags":0},"RoleARN":{"Type":4,"Flags":1},"S3BackupMode":{"Type":4,"Flags":0},"S3Configuration":{"Type":47,"Flags":1},"VpcConfiguration":{"Type":54,"Flags":0}}}},{"2":{"Name":"AmazonOpenSearchServerlessRetryOptions","Properties":{"DurationInSeconds":{"Type":3,"Flags":0}}}},{"2":{"Name":"AmazonopensearchserviceBufferingHints","Properties":{"IntervalInSeconds":{"Type":3,"Flags":0},"SizeInMBs":{"Type":3,"Flags":0}}}},{"2":{"Name":"AmazonopensearchserviceDestinationConfiguration","Properties":{"BufferingHints":{"Type":11,"Flags":0},"CloudWatchLoggingOptions":{"Type":16,"Flags":0},"ClusterEndpoint":{"Type":4,"Flags":0},"DocumentIdOptions":{"Type":21,"Flags":0},"DomainARN":{"Type":4,"Flags":0},"IndexName":{"Type":4,"Flags":1},"IndexRotationPeriod":{"Type":4,"Flags":0},"ProcessingConfiguration":{"Type":41,"Flags":0},"RetryOptions":{"Type":13,"Flags":0},"RoleARN":{"Type":4,"Flags":1},"S3BackupMode":{"Type":4,"Flags":0},"S3Configuration":{"Type":47,"Flags":1},"TypeName":{"Type":4,"Flags":0},"VpcConfiguration":{"Type":54,"Flags":0}}}},{"2":{"Name":"AmazonopensearchserviceRetryOptions","Properties":{"DurationInSeconds":{"Type":3,"Flags":0}}}},{"2":{"Name":"AuthenticationConfiguration","Properties":{"Connectivity":{"Type":4,"Flags":1},"RoleARN":{"Type":4,"Flags":1}}}},{"2":{"Name":"BufferingHints","Properties":{"IntervalInSeconds":{"Type":3,"Flags":0},"SizeInMBs":{"Type":3,"Flags":0}}}},{"2":{"Name":"CloudWatchLoggingOptions","Properties":{"Enabled":{"Type":2,"Flags":0},"LogGroupName":{"Type":4,"Flags":0},"LogStreamName":{"Type":4,"Flags":0}}}},{"2":{"Name":"CopyCommand","Properties":{"CopyOptions":{"Type":4,"Flags":0},"DataTableColumns":{"Type":4,"Flags":0},"DataTableName":{"Type":4,"Flags":1}}}},{"2":{"Name":"DataFormatConversionConfiguration","Properties":{"Enabled":{"Type":2,"Flags":0},"InputFormatConfiguration":{"Type":33,"Flags":0},"OutputFormatConfiguration":{"Type":39,"Flags":0},"SchemaConfiguration":{"Type":48,"Flags":0}}}},{"2":{"Name":"DeliveryStreamEncryptionConfigurationInput","Properties":{"KeyARN":{"Type":4,"Flags":0},"KeyType":{"Type":4,"Flags":1}}}},{"2":{"Name":"Deserializer","Properties":{"HiveJsonSerDe":{"Type":28,"Flags":0},"OpenXJsonSerDe":{"Type":37,"Flags":0}}}},{"2":{"Name":"DocumentIdOptions","Properties":{"DefaultDocumentIdFormat":{"Type":4,"Flags":1}}}},{"2":{"Name":"DynamicPartitioningConfiguration","Properties":{"Enabled":{"Type":2,"Flags":0},"RetryOptions":{"Type":46,"Flags":0}}}},{"2":{"Name":"ElasticsearchBufferingHints","Properties":{"IntervalInSeconds":{"Type":3,"Flags":0},"SizeInMBs":{"Type":3,"Flags":0}}}},{"2":{"Name":"ElasticsearchDestinationConfiguration","Properties":{"BufferingHints":{"Type":23,"Flags":0},"CloudWatchLoggingOptions":{"Type":16,"Flags":0},"ClusterEndpoint":{"Type":4,"Flags":0},"DocumentIdOptions":{"Type":21,"Flags":0},"DomainARN":{"Type":4,"Flags":0},"IndexName":{"Type":4,"Flags":1},"IndexRotationPeriod":{"Type":4,"Flags":0},"ProcessingConfiguration":{"Type":41,"Flags":0},"RetryOptions":{"Type":25,"Flags":0},"RoleARN":{"Type":4,"Flags":1},"S3BackupMode":{"Type":4,"Flags":0},"S3Configuration":{"Type":47,"Flags":1},"TypeName":{"Type":4,"Flags":0},"VpcConfiguration":{"Type":54,"Flags":0}}}},{"2":{"Name":"ElasticsearchRetryOptions","Properties":{"DurationInSeconds":{"Type":3,"Flags":0}}}},{"2":{"Name":"EncryptionConfiguration","Properties":{"KMSEncryptionConfig":{"Type":34,"Flags":0},"NoEncryptionConfig":{"Type":4,"Flags":0}}}},{"2":{"Name":"ExtendedS3DestinationConfiguration","Properties":{"BucketARN":{"Type":4,"Flags":1},"BufferingHints":{"Type":15,"Flags":0},"CloudWatchLoggingOptions":{"Type":16,"Flags":0},"CompressionFormat":{"Type":4,"Flags":0},"DataFormatConversionConfiguration":{"Type":18,"Flags":0},"DynamicPartitioningConfiguration":{"Type":22,"Flags":0},"EncryptionConfiguration":{"Type":26,"Flags":0},"ErrorOutputPrefix":{"Type":4,"Flags":0},"Prefix":{"Type":4,"Flags":0},"ProcessingConfiguration":{"Type":41,"Flags":0},"RoleARN":{"Type":4,"Flags":1},"S3BackupConfiguration":{"Type":47,"Flags":0},"S3BackupMode":{"Type":4,"Flags":0}}}},{"2":{"Name":"HiveJsonSerDe","Properties":{"TimestampFormats":{"Type":55,"Flags":0}}}},{"2":{"Name":"HttpEndpointCommonAttribute","Properties":{"AttributeName":{"Type":4,"Flags":1},"AttributeValue":{"Type":4,"Flags":1}}}},{"2":{"Name":"HttpEndpointConfiguration","Properties":{"AccessKey":{"Type":4,"Flags":0},"Name":{"Type":4,"Flags":0},"Url":{"Type":4,"Flags":1}}}},{"2":{"Name":"HttpEndpointDestinationConfiguration","Properties":{"BufferingHints":{"Type":15,"Flags":0},"CloudWatchLoggingOptions":{"Type":16,"Flags":0},"EndpointConfiguration":{"Type":30,"Flags":1},"ProcessingConfiguration":{"Type":41,"Flags":0},"RequestConfiguration":{"Type":32,"Flags":0},"RetryOptions":{"Type":46,"Flags":0},"RoleARN":{"Type":4,"Flags":0},"S3BackupMode":{"Type":4,"Flags":0},"S3Configuration":{"Type":47,"Flags":1}}}},{"2":{"Name":"HttpEndpointRequestConfiguration","Properties":{"CommonAttributes":{"Type":56,"Flags":0},"ContentEncoding":{"Type":4,"Flags":0}}}},{"2":{"Name":"InputFormatConfiguration","Properties":{"Deserializer":{"Type":20,"Flags":0}}}},{"2":{"Name":"KMSEncryptionConfig","Properties":{"AWSKMSKeyARN":{"Type":4,"Flags":1}}}},{"2":{"Name":"KinesisStreamSourceConfiguration","Properties":{"KinesisStreamARN":{"Type":4,"Flags":1},"RoleARN":{"Type":4,"Flags":1}}}},{"2":{"Name":"MSKSourceConfiguration","Properties":{"AuthenticationConfiguration":{"Type":14,"Flags":1},"MSKClusterARN":{"Type":4,"Flags":1},"TopicName":{"Type":4,"Flags":1}}}},{"2":{"Name":"OpenXJsonSerDe","Properties":{"CaseInsensitive":{"Type":2,"Flags":0},"ColumnToJsonKeyMappings":{"Type":57,"Flags":0},"ConvertDotsInJsonKeysToUnderscores":{"Type":2,"Flags":0}}}},{"2":{"Name":"OrcSerDe","Properties":{"BlockSizeBytes":{"Type":3,"Flags":0},"BloomFilterColumns":{"Type":58,"Flags":0},"BloomFilterFalsePositiveProbability":{"Type":3,"Flags":0},"Compression":{"Type":4,"Flags":0},"DictionaryKeyThreshold":{"Type":3,"Flags":0},"EnablePadding":{"Type":2,"Flags":0},"FormatVersion":{"Type":4,"Flags":0},"PaddingTolerance":{"Type":3,"Flags":0},"RowIndexStride":{"Type":3,"Flags":0},"StripeSizeBytes":{"Type":3,"Flags":0}}}},{"2":{"Name":"OutputFormatConfiguration","Properties":{"Serializer":{"Type":49,"Flags":0}}}},{"2":{"Name":"ParquetSerDe","Properties":{"BlockSizeBytes":{"Type":3,"Flags":0},"Compression":{"Type":4,"Flags":0},"EnableDictionaryCompression":{"Type":2,"Flags":0},"MaxPaddingBytes":{"Type":3,"Flags":0},"PageSizeBytes":{"Type":3,"Flags":0},"WriterVersion":{"Type":4,"Flags":0}}}},{"2":{"Name":"ProcessingConfiguration","Properties":{"Enabled":{"Type":2,"Flags":0},"Processors":{"Type":59,"Flags":0}}}},{"2":{"Name":"Processor","Properties":{"Parameters":{"Type":60,"Flags":0},"Type":{"Type":4,"Flags":1}}}},{"2":{"Name":"ProcessorParameter","Properties":{"ParameterName":{"Type":4,"Flags":1},"ParameterValue":{"Type":4,"Flags":1}}}},{"2":{"Name":"RedshiftDestinationConfiguration","Properties":{"CloudWatchLoggingOptions":{"Type":16,"Flags":0},"ClusterJDBCURL":{"Type":4,"Flags":1},"CopyCommand":{"Type":17,"Flags":1},"Password":{"Type":4,"Flags":1},"ProcessingConfiguration":{"Type":41,"Flags":0},"RetryOptions":{"Type":45,"Flags":0},"RoleARN":{"Type":4,"Flags":1},"S3BackupConfiguration":{"Type":47,"Flags":0},"S3BackupMode":{"Type":4,"Flags":0},"S3Configuration":{"Type":47,"Flags":1},"Username":{"Type":4,"Flags":1}}}},{"2":{"Name":"RedshiftRetryOptions","Properties":{"DurationInSeconds":{"Type":3,"Flags":0}}}},{"2":{"Name":"RetryOptions","Properties":{"DurationInSeconds":{"Type":3,"Flags":0}}}},{"2":{"Name":"S3DestinationConfiguration","Properties":{"BucketARN":{"Type":4,"Flags":1},"BufferingHints":{"Type":15,"Flags":0},"CloudWatchLoggingOptions":{"Type":16,"Flags":0},"CompressionFormat":{"Type":4,"Flags":0},"EncryptionConfiguration":{"Type":26,"Flags":0},"ErrorOutputPrefix":{"Type":4,"Flags":0},"Prefix":{"Type":4,"Flags":0},"RoleARN":{"Type":4,"Flags":1}}}},{"2":{"Name":"SchemaConfiguration","Properties":{"CatalogId":{"Type":4,"Flags":0},"DatabaseName":{"Type":4,"Flags":0},"Region":{"Type":4,"Flags":0},"RoleARN":{"Type":4,"Flags":0},"TableName":{"Type":4,"Flags":0},"VersionId":{"Type":4,"Flags":0}}}},{"2":{"Name":"Serializer","Properties":{"OrcSerDe":{"Type":38,"Flags":0},"ParquetSerDe":{"Type":40,"Flags":0}}}},{"2":{"Name":"SplunkBufferingHints","Properties":{"IntervalInSeconds":{"Type":3,"Flags":0},"SizeInMBs":{"Type":3,"Flags":0}}}},{"2":{"Name":"SplunkDestinationConfiguration","Properties":{"BufferingHints":{"Type":50,"Flags":0},"CloudWatchLoggingOptions":{"Type":16,"Flags":0},"HECAcknowledgmentTimeoutInSeconds":{"Type":3,"Flags":0},"HECEndpoint":{"Type":4,"Flags":1},"HECEndpointType":{"Type":4,"Flags":1},"HECToken":{"Type":4,"Flags":1},"ProcessingConfiguration":{"Type":41,"Flags":0},"RetryOptions":{"Type":52,"Flags":0},"S3BackupMode":{"Type":4,"Flags":0},"S3Configuration":{"Type":47,"Flags":1}}}},{"2":{"Name":"SplunkRetryOptions","Properties":{"DurationInSeconds":{"Type":3,"Flags":0}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"VpcConfiguration","Properties":{"RoleARN":{"Type":4,"Flags":1},"SecurityGroupIds":{"Type":61,"Flags":1},"SubnetIds":{"Type":62,"Flags":1}}}},{"3":{"ItemType":4}},{"3":{"ItemType":29}},{"2":{"Name":"DeliveryStream_ColumnToJsonKeyMappings","Properties":{}}},{"3":{"ItemType":4}},{"3":{"ItemType":42}},{"3":{"ItemType":43}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.KinesisFirehose/DeliveryStreamProperties","Properties":{"AmazonOpenSearchServerlessDestinationConfiguration":{"Type":9,"Flags":0},"AmazonopensearchserviceDestinationConfiguration":{"Type":12,"Flags":0},"Arn":{"Type":4,"Flags":2},"DeliveryStreamEncryptionConfigurationInput":{"Type":19,"Flags":0},"DeliveryStreamName":{"Type":4,"Flags":16},"DeliveryStreamType":{"Type":4,"Flags":0},"ElasticsearchDestinationConfiguration":{"Type":24,"Flags":0},"ExtendedS3DestinationConfiguration":{"Type":27,"Flags":0},"HttpEndpointDestinationConfiguration":{"Type":31,"Flags":0},"KinesisStreamSourceConfiguration":{"Type":35,"Flags":0},"MSKSourceConfiguration":{"Type":36,"Flags":0},"RedshiftDestinationConfiguration":{"Type":44,"Flags":0},"S3DestinationConfiguration":{"Type":47,"Flags":0},"SplunkDestinationConfiguration":{"Type":51,"Flags":0},"Tags":{"Type":64,"Flags":0}}}},{"3":{"ItemType":53}},{"2":{"Name":"AWS.KinesisFirehose/DeliveryStream","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":63,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.KinesisFirehose/DeliveryStream@default","ScopeType":0,"Body":65}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "AmazonOpenSearchServerlessBufferingHints", + "properties": { + "IntervalInSeconds": { + "type": { + "$ref": "#/52" + }, + "flags": 0 + }, + "SizeInMBs": { + "type": { + "$ref": "#/52" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AmazonOpenSearchServerlessDestinationConfiguration", + "properties": { + "BufferingHints": { + "type": { + "$ref": "#/0" + }, + "flags": 0 + }, + "CloudWatchLoggingOptions": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "CollectionEndpoint": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "IndexName": { + "type": { + "$ref": "#/53" + }, + "flags": 1 + }, + "ProcessingConfiguration": { + "type": { + "$ref": "#/33" + }, + "flags": 0 + }, + "RetryOptions": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "RoleARN": { + "type": { + "$ref": "#/53" + }, + "flags": 1 + }, + "S3BackupMode": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "S3Configuration": { + "type": { + "$ref": "#/39" + }, + "flags": 1 + }, + "VpcConfiguration": { + "type": { + "$ref": "#/51" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AmazonOpenSearchServerlessRetryOptions", + "properties": { + "DurationInSeconds": { + "type": { + "$ref": "#/52" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AmazonopensearchserviceBufferingHints", + "properties": { + "IntervalInSeconds": { + "type": { + "$ref": "#/52" + }, + "flags": 0 + }, + "SizeInMBs": { + "type": { + "$ref": "#/52" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AmazonopensearchserviceDestinationConfiguration", + "properties": { + "BufferingHints": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "CloudWatchLoggingOptions": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "ClusterEndpoint": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "DocumentIdOptions": { + "type": { + "$ref": "#/13" + }, + "flags": 0 + }, + "DomainARN": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "IndexName": { + "type": { + "$ref": "#/53" + }, + "flags": 1 + }, + "IndexRotationPeriod": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "ProcessingConfiguration": { + "type": { + "$ref": "#/33" + }, + "flags": 0 + }, + "RetryOptions": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "RoleARN": { + "type": { + "$ref": "#/53" + }, + "flags": 1 + }, + "S3BackupMode": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "S3Configuration": { + "type": { + "$ref": "#/39" + }, + "flags": 1 + }, + "TypeName": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "VpcConfiguration": { + "type": { + "$ref": "#/51" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AmazonopensearchserviceRetryOptions", + "properties": { + "DurationInSeconds": { + "type": { + "$ref": "#/52" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AuthenticationConfiguration", + "properties": { + "Connectivity": { + "type": { + "$ref": "#/53" + }, + "flags": 1 + }, + "RoleARN": { + "type": { + "$ref": "#/53" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "BufferingHints", + "properties": { + "IntervalInSeconds": { + "type": { + "$ref": "#/52" + }, + "flags": 0 + }, + "SizeInMBs": { + "type": { + "$ref": "#/52" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CloudWatchLoggingOptions", + "properties": { + "Enabled": { + "type": { + "$ref": "#/54" + }, + "flags": 0 + }, + "LogGroupName": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "LogStreamName": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CopyCommand", + "properties": { + "CopyOptions": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "DataTableColumns": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "DataTableName": { + "type": { + "$ref": "#/53" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DataFormatConversionConfiguration", + "properties": { + "Enabled": { + "type": { + "$ref": "#/54" + }, + "flags": 0 + }, + "InputFormatConfiguration": { + "type": { + "$ref": "#/25" + }, + "flags": 0 + }, + "OutputFormatConfiguration": { + "type": { + "$ref": "#/31" + }, + "flags": 0 + }, + "SchemaConfiguration": { + "type": { + "$ref": "#/40" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DeliveryStreamEncryptionConfigurationInput", + "properties": { + "KeyARN": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "KeyType": { + "type": { + "$ref": "#/53" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Deserializer", + "properties": { + "HiveJsonSerDe": { + "type": { + "$ref": "#/20" + }, + "flags": 0 + }, + "OpenXJsonSerDe": { + "type": { + "$ref": "#/29" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DocumentIdOptions", + "properties": { + "DefaultDocumentIdFormat": { + "type": { + "$ref": "#/53" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DynamicPartitioningConfiguration", + "properties": { + "Enabled": { + "type": { + "$ref": "#/54" + }, + "flags": 0 + }, + "RetryOptions": { + "type": { + "$ref": "#/38" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ElasticsearchBufferingHints", + "properties": { + "IntervalInSeconds": { + "type": { + "$ref": "#/52" + }, + "flags": 0 + }, + "SizeInMBs": { + "type": { + "$ref": "#/52" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ElasticsearchDestinationConfiguration", + "properties": { + "BufferingHints": { + "type": { + "$ref": "#/15" + }, + "flags": 0 + }, + "CloudWatchLoggingOptions": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "ClusterEndpoint": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "DocumentIdOptions": { + "type": { + "$ref": "#/13" + }, + "flags": 0 + }, + "DomainARN": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "IndexName": { + "type": { + "$ref": "#/53" + }, + "flags": 1 + }, + "IndexRotationPeriod": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "ProcessingConfiguration": { + "type": { + "$ref": "#/33" + }, + "flags": 0 + }, + "RetryOptions": { + "type": { + "$ref": "#/17" + }, + "flags": 0 + }, + "RoleARN": { + "type": { + "$ref": "#/53" + }, + "flags": 1 + }, + "S3BackupMode": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "S3Configuration": { + "type": { + "$ref": "#/39" + }, + "flags": 1 + }, + "TypeName": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "VpcConfiguration": { + "type": { + "$ref": "#/51" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ElasticsearchRetryOptions", + "properties": { + "DurationInSeconds": { + "type": { + "$ref": "#/52" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "EncryptionConfiguration", + "properties": { + "KMSEncryptionConfig": { + "type": { + "$ref": "#/26" + }, + "flags": 0 + }, + "NoEncryptionConfig": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ExtendedS3DestinationConfiguration", + "properties": { + "BucketARN": { + "type": { + "$ref": "#/53" + }, + "flags": 1 + }, + "BufferingHints": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "CloudWatchLoggingOptions": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "CompressionFormat": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "CustomTimeZone": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "DataFormatConversionConfiguration": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "DynamicPartitioningConfiguration": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + }, + "EncryptionConfiguration": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "ErrorOutputPrefix": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "FileExtension": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "Prefix": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "ProcessingConfiguration": { + "type": { + "$ref": "#/33" + }, + "flags": 0 + }, + "RoleARN": { + "type": { + "$ref": "#/53" + }, + "flags": 1 + }, + "S3BackupConfiguration": { + "type": { + "$ref": "#/39" + }, + "flags": 0 + }, + "S3BackupMode": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "HiveJsonSerDe", + "properties": { + "TimestampFormats": { + "type": { + "$ref": "#/55" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "HttpEndpointCommonAttribute", + "properties": { + "AttributeName": { + "type": { + "$ref": "#/53" + }, + "flags": 1 + }, + "AttributeValue": { + "type": { + "$ref": "#/53" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "HttpEndpointConfiguration", + "properties": { + "AccessKey": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "Url": { + "type": { + "$ref": "#/53" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "HttpEndpointDestinationConfiguration", + "properties": { + "BufferingHints": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "CloudWatchLoggingOptions": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "EndpointConfiguration": { + "type": { + "$ref": "#/22" + }, + "flags": 1 + }, + "ProcessingConfiguration": { + "type": { + "$ref": "#/33" + }, + "flags": 0 + }, + "RequestConfiguration": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "RetryOptions": { + "type": { + "$ref": "#/38" + }, + "flags": 0 + }, + "RoleARN": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "S3BackupMode": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "S3Configuration": { + "type": { + "$ref": "#/39" + }, + "flags": 1 + }, + "SecretsManagerConfiguration": { + "type": { + "$ref": "#/41" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "HttpEndpointRequestConfiguration", + "properties": { + "CommonAttributes": { + "type": { + "$ref": "#/56" + }, + "flags": 0 + }, + "ContentEncoding": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "InputFormatConfiguration", + "properties": { + "Deserializer": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "KMSEncryptionConfig", + "properties": { + "AWSKMSKeyARN": { + "type": { + "$ref": "#/53" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "KinesisStreamSourceConfiguration", + "properties": { + "KinesisStreamARN": { + "type": { + "$ref": "#/53" + }, + "flags": 1 + }, + "RoleARN": { + "type": { + "$ref": "#/53" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "MSKSourceConfiguration", + "properties": { + "AuthenticationConfiguration": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "MSKClusterARN": { + "type": { + "$ref": "#/53" + }, + "flags": 1 + }, + "TopicName": { + "type": { + "$ref": "#/53" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "OpenXJsonSerDe", + "properties": { + "CaseInsensitive": { + "type": { + "$ref": "#/54" + }, + "flags": 0 + }, + "ColumnToJsonKeyMappings": { + "type": { + "$ref": "#/57" + }, + "flags": 0 + }, + "ConvertDotsInJsonKeysToUnderscores": { + "type": { + "$ref": "#/54" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "OrcSerDe", + "properties": { + "BlockSizeBytes": { + "type": { + "$ref": "#/52" + }, + "flags": 0 + }, + "BloomFilterColumns": { + "type": { + "$ref": "#/58" + }, + "flags": 0 + }, + "BloomFilterFalsePositiveProbability": { + "type": { + "$ref": "#/52" + }, + "flags": 0 + }, + "Compression": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "DictionaryKeyThreshold": { + "type": { + "$ref": "#/52" + }, + "flags": 0 + }, + "EnablePadding": { + "type": { + "$ref": "#/54" + }, + "flags": 0 + }, + "FormatVersion": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "PaddingTolerance": { + "type": { + "$ref": "#/52" + }, + "flags": 0 + }, + "RowIndexStride": { + "type": { + "$ref": "#/52" + }, + "flags": 0 + }, + "StripeSizeBytes": { + "type": { + "$ref": "#/52" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "OutputFormatConfiguration", + "properties": { + "Serializer": { + "type": { + "$ref": "#/42" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ParquetSerDe", + "properties": { + "BlockSizeBytes": { + "type": { + "$ref": "#/52" + }, + "flags": 0 + }, + "Compression": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "EnableDictionaryCompression": { + "type": { + "$ref": "#/54" + }, + "flags": 0 + }, + "MaxPaddingBytes": { + "type": { + "$ref": "#/52" + }, + "flags": 0 + }, + "PageSizeBytes": { + "type": { + "$ref": "#/52" + }, + "flags": 0 + }, + "WriterVersion": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ProcessingConfiguration", + "properties": { + "Enabled": { + "type": { + "$ref": "#/54" + }, + "flags": 0 + }, + "Processors": { + "type": { + "$ref": "#/59" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Processor", + "properties": { + "Parameters": { + "type": { + "$ref": "#/60" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/53" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ProcessorParameter", + "properties": { + "ParameterName": { + "type": { + "$ref": "#/53" + }, + "flags": 1 + }, + "ParameterValue": { + "type": { + "$ref": "#/53" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "RedshiftDestinationConfiguration", + "properties": { + "CloudWatchLoggingOptions": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "ClusterJDBCURL": { + "type": { + "$ref": "#/53" + }, + "flags": 1 + }, + "CopyCommand": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + }, + "Password": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "ProcessingConfiguration": { + "type": { + "$ref": "#/33" + }, + "flags": 0 + }, + "RetryOptions": { + "type": { + "$ref": "#/37" + }, + "flags": 0 + }, + "RoleARN": { + "type": { + "$ref": "#/53" + }, + "flags": 1 + }, + "S3BackupConfiguration": { + "type": { + "$ref": "#/39" + }, + "flags": 0 + }, + "S3BackupMode": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "S3Configuration": { + "type": { + "$ref": "#/39" + }, + "flags": 1 + }, + "SecretsManagerConfiguration": { + "type": { + "$ref": "#/41" + }, + "flags": 0 + }, + "Username": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "RedshiftRetryOptions", + "properties": { + "DurationInSeconds": { + "type": { + "$ref": "#/52" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "RetryOptions", + "properties": { + "DurationInSeconds": { + "type": { + "$ref": "#/52" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "S3DestinationConfiguration", + "properties": { + "BucketARN": { + "type": { + "$ref": "#/53" + }, + "flags": 1 + }, + "BufferingHints": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "CloudWatchLoggingOptions": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "CompressionFormat": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "EncryptionConfiguration": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "ErrorOutputPrefix": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "Prefix": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "RoleARN": { + "type": { + "$ref": "#/53" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "SchemaConfiguration", + "properties": { + "CatalogId": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "DatabaseName": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "Region": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "RoleARN": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "TableName": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "VersionId": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SecretsManagerConfiguration", + "properties": { + "Enabled": { + "type": { + "$ref": "#/54" + }, + "flags": 1 + }, + "RoleARN": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "SecretARN": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Serializer", + "properties": { + "OrcSerDe": { + "type": { + "$ref": "#/30" + }, + "flags": 0 + }, + "ParquetSerDe": { + "type": { + "$ref": "#/32" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SnowflakeDestinationConfiguration", + "properties": { + "AccountUrl": { + "type": { + "$ref": "#/53" + }, + "flags": 1 + }, + "CloudWatchLoggingOptions": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "ContentColumnName": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "DataLoadingOption": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "Database": { + "type": { + "$ref": "#/53" + }, + "flags": 1 + }, + "KeyPassphrase": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "MetaDataColumnName": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "PrivateKey": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "ProcessingConfiguration": { + "type": { + "$ref": "#/33" + }, + "flags": 0 + }, + "RetryOptions": { + "type": { + "$ref": "#/44" + }, + "flags": 0 + }, + "RoleARN": { + "type": { + "$ref": "#/53" + }, + "flags": 1 + }, + "S3BackupMode": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "S3Configuration": { + "type": { + "$ref": "#/39" + }, + "flags": 1 + }, + "Schema": { + "type": { + "$ref": "#/53" + }, + "flags": 1 + }, + "SecretsManagerConfiguration": { + "type": { + "$ref": "#/41" + }, + "flags": 0 + }, + "SnowflakeRoleConfiguration": { + "type": { + "$ref": "#/45" + }, + "flags": 0 + }, + "SnowflakeVpcConfiguration": { + "type": { + "$ref": "#/46" + }, + "flags": 0 + }, + "Table": { + "type": { + "$ref": "#/53" + }, + "flags": 1 + }, + "User": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SnowflakeRetryOptions", + "properties": { + "DurationInSeconds": { + "type": { + "$ref": "#/52" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SnowflakeRoleConfiguration", + "properties": { + "Enabled": { + "type": { + "$ref": "#/54" + }, + "flags": 0 + }, + "SnowflakeRole": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SnowflakeVpcConfiguration", + "properties": { + "PrivateLinkVpceId": { + "type": { + "$ref": "#/53" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "SplunkBufferingHints", + "properties": { + "IntervalInSeconds": { + "type": { + "$ref": "#/52" + }, + "flags": 0 + }, + "SizeInMBs": { + "type": { + "$ref": "#/52" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SplunkDestinationConfiguration", + "properties": { + "BufferingHints": { + "type": { + "$ref": "#/47" + }, + "flags": 0 + }, + "CloudWatchLoggingOptions": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "HECAcknowledgmentTimeoutInSeconds": { + "type": { + "$ref": "#/52" + }, + "flags": 0 + }, + "HECEndpoint": { + "type": { + "$ref": "#/53" + }, + "flags": 1 + }, + "HECEndpointType": { + "type": { + "$ref": "#/53" + }, + "flags": 1 + }, + "HECToken": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "ProcessingConfiguration": { + "type": { + "$ref": "#/33" + }, + "flags": 0 + }, + "RetryOptions": { + "type": { + "$ref": "#/49" + }, + "flags": 0 + }, + "S3BackupMode": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "S3Configuration": { + "type": { + "$ref": "#/39" + }, + "flags": 1 + }, + "SecretsManagerConfiguration": { + "type": { + "$ref": "#/41" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SplunkRetryOptions", + "properties": { + "DurationInSeconds": { + "type": { + "$ref": "#/52" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/53" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "VpcConfiguration", + "properties": { + "RoleARN": { + "type": { + "$ref": "#/53" + }, + "flags": 1 + }, + "SecurityGroupIds": { + "type": { + "$ref": "#/61" + }, + "flags": 1 + }, + "SubnetIds": { + "type": { + "$ref": "#/62" + }, + "flags": 1 + } + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "StringType" + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/53" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/21" + } + }, + { + "$type": "ObjectType", + "name": "DeliveryStream_ColumnToJsonKeyMappings", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/53" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/34" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/35" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/53" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/53" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.KinesisFirehose/DeliveryStreamProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/50" + } + }, + { + "$type": "ObjectType", + "name": "AWS.KinesisFirehose/DeliveryStreamProperties", + "properties": { + "AmazonOpenSearchServerlessDestinationConfiguration": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "AmazonopensearchserviceDestinationConfiguration": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "Arn": { + "type": { + "$ref": "#/53" + }, + "flags": 2 + }, + "DeliveryStreamEncryptionConfigurationInput": { + "type": { + "$ref": "#/11" + }, + "flags": 0 + }, + "DeliveryStreamName": { + "type": { + "$ref": "#/53" + }, + "flags": 16 + }, + "DeliveryStreamType": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "ElasticsearchDestinationConfiguration": { + "type": { + "$ref": "#/16" + }, + "flags": 0 + }, + "ExtendedS3DestinationConfiguration": { + "type": { + "$ref": "#/19" + }, + "flags": 0 + }, + "HttpEndpointDestinationConfiguration": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "KinesisStreamSourceConfiguration": { + "type": { + "$ref": "#/27" + }, + "flags": 0 + }, + "MSKSourceConfiguration": { + "type": { + "$ref": "#/28" + }, + "flags": 0 + }, + "RedshiftDestinationConfiguration": { + "type": { + "$ref": "#/36" + }, + "flags": 0 + }, + "S3DestinationConfiguration": { + "type": { + "$ref": "#/39" + }, + "flags": 0 + }, + "SnowflakeDestinationConfiguration": { + "type": { + "$ref": "#/43" + }, + "flags": 0 + }, + "SplunkDestinationConfiguration": { + "type": { + "$ref": "#/48" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/64" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.KinesisFirehose/DeliveryStream", + "properties": { + "name": { + "type": { + "$ref": "#/53" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/53" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/65" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.KinesisFirehose/DeliveryStream@default", + "scopeType": 0, + "body": { + "$ref": "#/66" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.kinesisfirehose/default/types.md b/artifacts/bicep/aws/aws.kinesisfirehose/default/types.md index dbfd8234..da19e924 100644 --- a/artifacts/bicep/aws/aws.kinesisfirehose/default/types.md +++ b/artifacts/bicep/aws/aws.kinesisfirehose/default/types.md @@ -3,27 +3,14 @@ ## Resource AWS.KinesisFirehose/DeliveryStream@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.KinesisFirehose/DeliveryStreamProperties](#awskinesisfirehosedeliverystreamproperties): properties of the resource +* **properties**: [AWS.KinesisFirehose/DeliveryStreamProperties](#awskinesisfirehosedeliverystreamproperties) (Identifier): properties of the resource -## AWS.KinesisFirehose/DeliveryStreamProperties +## AmazonOpenSearchServerlessBufferingHints ### Properties -* **AmazonOpenSearchServerlessDestinationConfiguration**: [AmazonOpenSearchServerlessDestinationConfiguration](#amazonopensearchserverlessdestinationconfiguration) -* **AmazonopensearchserviceDestinationConfiguration**: [AmazonopensearchserviceDestinationConfiguration](#amazonopensearchservicedestinationconfiguration) -* **Arn**: string (ReadOnly) -* **DeliveryStreamEncryptionConfigurationInput**: [DeliveryStreamEncryptionConfigurationInput](#deliverystreamencryptionconfigurationinput) -* **DeliveryStreamName**: string (Identifier) -* **DeliveryStreamType**: string -* **ElasticsearchDestinationConfiguration**: [ElasticsearchDestinationConfiguration](#elasticsearchdestinationconfiguration) -* **ExtendedS3DestinationConfiguration**: [ExtendedS3DestinationConfiguration](#extendeds3destinationconfiguration) -* **HttpEndpointDestinationConfiguration**: [HttpEndpointDestinationConfiguration](#httpendpointdestinationconfiguration) -* **KinesisStreamSourceConfiguration**: [KinesisStreamSourceConfiguration](#kinesisstreamsourceconfiguration) -* **MSKSourceConfiguration**: [MSKSourceConfiguration](#msksourceconfiguration) -* **RedshiftDestinationConfiguration**: [RedshiftDestinationConfiguration](#redshiftdestinationconfiguration) -* **S3DestinationConfiguration**: [S3DestinationConfiguration](#s3destinationconfiguration) -* **SplunkDestinationConfiguration**: [SplunkDestinationConfiguration](#splunkdestinationconfiguration) -* **Tags**: [Tag](#tag)[] +* **IntervalInSeconds**: int +* **SizeInMBs**: int ## AmazonOpenSearchServerlessDestinationConfiguration ### Properties @@ -38,67 +25,15 @@ * **S3Configuration**: [S3DestinationConfiguration](#s3destinationconfiguration) (Required) * **VpcConfiguration**: [VpcConfiguration](#vpcconfiguration) -## AmazonOpenSearchServerlessBufferingHints -### Properties -* **IntervalInSeconds**: int -* **SizeInMBs**: int - -## CloudWatchLoggingOptions -### Properties -* **Enabled**: bool -* **LogGroupName**: string -* **LogStreamName**: string - -## ProcessingConfiguration -### Properties -* **Enabled**: bool -* **Processors**: [Processor](#processor)[] - -## Processor -### Properties -* **Parameters**: [ProcessorParameter](#processorparameter)[] -* **Type**: string (Required) - -## ProcessorParameter -### Properties -* **ParameterName**: string (Required) -* **ParameterValue**: string (Required) - ## AmazonOpenSearchServerlessRetryOptions ### Properties * **DurationInSeconds**: int -## S3DestinationConfiguration -### Properties -* **BucketARN**: string (Required) -* **BufferingHints**: [BufferingHints](#bufferinghints) -* **CloudWatchLoggingOptions**: [CloudWatchLoggingOptions](#cloudwatchloggingoptions) -* **CompressionFormat**: string -* **EncryptionConfiguration**: [EncryptionConfiguration](#encryptionconfiguration) -* **ErrorOutputPrefix**: string -* **Prefix**: string -* **RoleARN**: string (Required) - -## BufferingHints +## AmazonopensearchserviceBufferingHints ### Properties * **IntervalInSeconds**: int * **SizeInMBs**: int -## EncryptionConfiguration -### Properties -* **KMSEncryptionConfig**: [KMSEncryptionConfig](#kmsencryptionconfig) -* **NoEncryptionConfig**: string - -## KMSEncryptionConfig -### Properties -* **AWSKMSKeyARN**: string (Required) - -## VpcConfiguration -### Properties -* **RoleARN**: string (Required) -* **SecurityGroupIds**: string[] (Required) -* **SubnetIds**: string[] (Required) - ## AmazonopensearchserviceDestinationConfiguration ### Properties * **BufferingHints**: [AmazonopensearchserviceBufferingHints](#amazonopensearchservicebufferinghints) @@ -116,24 +51,85 @@ * **TypeName**: string * **VpcConfiguration**: [VpcConfiguration](#vpcconfiguration) -## AmazonopensearchserviceBufferingHints +## AmazonopensearchserviceRetryOptions +### Properties +* **DurationInSeconds**: int + +## AuthenticationConfiguration +### Properties +* **Connectivity**: string (Required) +* **RoleARN**: string (Required) + +## AWS.KinesisFirehose/DeliveryStreamProperties +### Properties +* **AmazonOpenSearchServerlessDestinationConfiguration**: [AmazonOpenSearchServerlessDestinationConfiguration](#amazonopensearchserverlessdestinationconfiguration) +* **AmazonopensearchserviceDestinationConfiguration**: [AmazonopensearchserviceDestinationConfiguration](#amazonopensearchservicedestinationconfiguration) +* **Arn**: string (ReadOnly) +* **DeliveryStreamEncryptionConfigurationInput**: [DeliveryStreamEncryptionConfigurationInput](#deliverystreamencryptionconfigurationinput) +* **DeliveryStreamName**: string (Identifier) +* **DeliveryStreamType**: string +* **ElasticsearchDestinationConfiguration**: [ElasticsearchDestinationConfiguration](#elasticsearchdestinationconfiguration) +* **ExtendedS3DestinationConfiguration**: [ExtendedS3DestinationConfiguration](#extendeds3destinationconfiguration) +* **HttpEndpointDestinationConfiguration**: [HttpEndpointDestinationConfiguration](#httpendpointdestinationconfiguration) +* **KinesisStreamSourceConfiguration**: [KinesisStreamSourceConfiguration](#kinesisstreamsourceconfiguration) +* **MSKSourceConfiguration**: [MSKSourceConfiguration](#msksourceconfiguration) +* **RedshiftDestinationConfiguration**: [RedshiftDestinationConfiguration](#redshiftdestinationconfiguration) +* **S3DestinationConfiguration**: [S3DestinationConfiguration](#s3destinationconfiguration) +* **SnowflakeDestinationConfiguration**: [SnowflakeDestinationConfiguration](#snowflakedestinationconfiguration) +* **SplunkDestinationConfiguration**: [SplunkDestinationConfiguration](#splunkdestinationconfiguration) +* **Tags**: [Tag](#tag)[] + +## BufferingHints ### Properties * **IntervalInSeconds**: int * **SizeInMBs**: int -## DocumentIdOptions +## CloudWatchLoggingOptions ### Properties -* **DefaultDocumentIdFormat**: string (Required) +* **Enabled**: bool +* **LogGroupName**: string +* **LogStreamName**: string -## AmazonopensearchserviceRetryOptions +## CopyCommand +### Properties +* **CopyOptions**: string +* **DataTableColumns**: string +* **DataTableName**: string (Required) + +## DataFormatConversionConfiguration +### Properties +* **Enabled**: bool +* **InputFormatConfiguration**: [InputFormatConfiguration](#inputformatconfiguration) +* **OutputFormatConfiguration**: [OutputFormatConfiguration](#outputformatconfiguration) +* **SchemaConfiguration**: [SchemaConfiguration](#schemaconfiguration) + +## DeliveryStream_ColumnToJsonKeyMappings ### Properties -* **DurationInSeconds**: int ## DeliveryStreamEncryptionConfigurationInput ### Properties * **KeyARN**: string * **KeyType**: string (Required) +## Deserializer +### Properties +* **HiveJsonSerDe**: [HiveJsonSerDe](#hivejsonserde) +* **OpenXJsonSerDe**: [OpenXJsonSerDe](#openxjsonserde) + +## DocumentIdOptions +### Properties +* **DefaultDocumentIdFormat**: string (Required) + +## DynamicPartitioningConfiguration +### Properties +* **Enabled**: bool +* **RetryOptions**: [RetryOptions](#retryoptions) + +## ElasticsearchBufferingHints +### Properties +* **IntervalInSeconds**: int +* **SizeInMBs**: int + ## ElasticsearchDestinationConfiguration ### Properties * **BufferingHints**: [ElasticsearchBufferingHints](#elasticsearchbufferinghints) @@ -151,68 +147,90 @@ * **TypeName**: string * **VpcConfiguration**: [VpcConfiguration](#vpcconfiguration) -## ElasticsearchBufferingHints -### Properties -* **IntervalInSeconds**: int -* **SizeInMBs**: int - ## ElasticsearchRetryOptions ### Properties * **DurationInSeconds**: int +## EncryptionConfiguration +### Properties +* **KMSEncryptionConfig**: [KMSEncryptionConfig](#kmsencryptionconfig) +* **NoEncryptionConfig**: string + ## ExtendedS3DestinationConfiguration ### Properties * **BucketARN**: string (Required) * **BufferingHints**: [BufferingHints](#bufferinghints) * **CloudWatchLoggingOptions**: [CloudWatchLoggingOptions](#cloudwatchloggingoptions) * **CompressionFormat**: string +* **CustomTimeZone**: string * **DataFormatConversionConfiguration**: [DataFormatConversionConfiguration](#dataformatconversionconfiguration) * **DynamicPartitioningConfiguration**: [DynamicPartitioningConfiguration](#dynamicpartitioningconfiguration) * **EncryptionConfiguration**: [EncryptionConfiguration](#encryptionconfiguration) * **ErrorOutputPrefix**: string +* **FileExtension**: string * **Prefix**: string * **ProcessingConfiguration**: [ProcessingConfiguration](#processingconfiguration) * **RoleARN**: string (Required) * **S3BackupConfiguration**: [S3DestinationConfiguration](#s3destinationconfiguration) * **S3BackupMode**: string -## DataFormatConversionConfiguration +## HiveJsonSerDe ### Properties -* **Enabled**: bool -* **InputFormatConfiguration**: [InputFormatConfiguration](#inputformatconfiguration) -* **OutputFormatConfiguration**: [OutputFormatConfiguration](#outputformatconfiguration) -* **SchemaConfiguration**: [SchemaConfiguration](#schemaconfiguration) +* **TimestampFormats**: string[] -## InputFormatConfiguration +## HttpEndpointCommonAttribute ### Properties -* **Deserializer**: [Deserializer](#deserializer) +* **AttributeName**: string (Required) +* **AttributeValue**: string (Required) -## Deserializer +## HttpEndpointConfiguration ### Properties -* **HiveJsonSerDe**: [HiveJsonSerDe](#hivejsonserde) -* **OpenXJsonSerDe**: [OpenXJsonSerDe](#openxjsonserde) +* **AccessKey**: string +* **Name**: string +* **Url**: string (Required) -## HiveJsonSerDe +## HttpEndpointDestinationConfiguration ### Properties -* **TimestampFormats**: string[] +* **BufferingHints**: [BufferingHints](#bufferinghints) +* **CloudWatchLoggingOptions**: [CloudWatchLoggingOptions](#cloudwatchloggingoptions) +* **EndpointConfiguration**: [HttpEndpointConfiguration](#httpendpointconfiguration) (Required) +* **ProcessingConfiguration**: [ProcessingConfiguration](#processingconfiguration) +* **RequestConfiguration**: [HttpEndpointRequestConfiguration](#httpendpointrequestconfiguration) +* **RetryOptions**: [RetryOptions](#retryoptions) +* **RoleARN**: string +* **S3BackupMode**: string +* **S3Configuration**: [S3DestinationConfiguration](#s3destinationconfiguration) (Required) +* **SecretsManagerConfiguration**: [SecretsManagerConfiguration](#secretsmanagerconfiguration) -## OpenXJsonSerDe +## HttpEndpointRequestConfiguration ### Properties -* **CaseInsensitive**: bool -* **ColumnToJsonKeyMappings**: [DeliveryStream_ColumnToJsonKeyMappings](#deliverystreamcolumntojsonkeymappings) -* **ConvertDotsInJsonKeysToUnderscores**: bool +* **CommonAttributes**: [HttpEndpointCommonAttribute](#httpendpointcommonattribute)[] +* **ContentEncoding**: string -## DeliveryStream_ColumnToJsonKeyMappings +## InputFormatConfiguration ### Properties +* **Deserializer**: [Deserializer](#deserializer) -## OutputFormatConfiguration +## KinesisStreamSourceConfiguration ### Properties -* **Serializer**: [Serializer](#serializer) +* **KinesisStreamARN**: string (Required) +* **RoleARN**: string (Required) -## Serializer +## KMSEncryptionConfig ### Properties -* **OrcSerDe**: [OrcSerDe](#orcserde) -* **ParquetSerDe**: [ParquetSerDe](#parquetserde) +* **AWSKMSKeyARN**: string (Required) + +## MSKSourceConfiguration +### Properties +* **AuthenticationConfiguration**: [AuthenticationConfiguration](#authenticationconfiguration) (Required) +* **MSKClusterARN**: string (Required) +* **TopicName**: string (Required) + +## OpenXJsonSerDe +### Properties +* **CaseInsensitive**: bool +* **ColumnToJsonKeyMappings**: [DeliveryStream_ColumnToJsonKeyMappings](#deliverystreamcolumntojsonkeymappings) +* **ConvertDotsInJsonKeysToUnderscores**: bool ## OrcSerDe ### Properties @@ -227,6 +245,10 @@ * **RowIndexStride**: int * **StripeSizeBytes**: int +## OutputFormatConfiguration +### Properties +* **Serializer**: [Serializer](#serializer) + ## ParquetSerDe ### Properties * **BlockSizeBytes**: int @@ -236,91 +258,114 @@ * **PageSizeBytes**: int * **WriterVersion**: string -## SchemaConfiguration +## ProcessingConfiguration ### Properties -* **CatalogId**: string -* **DatabaseName**: string -* **Region**: string -* **RoleARN**: string -* **TableName**: string -* **VersionId**: string +* **Enabled**: bool +* **Processors**: [Processor](#processor)[] -## DynamicPartitioningConfiguration +## Processor ### Properties -* **Enabled**: bool -* **RetryOptions**: [RetryOptions](#retryoptions) +* **Parameters**: [ProcessorParameter](#processorparameter)[] +* **Type**: string (Required) -## RetryOptions +## ProcessorParameter ### Properties -* **DurationInSeconds**: int +* **ParameterName**: string (Required) +* **ParameterValue**: string (Required) -## HttpEndpointDestinationConfiguration +## RedshiftDestinationConfiguration ### Properties -* **BufferingHints**: [BufferingHints](#bufferinghints) * **CloudWatchLoggingOptions**: [CloudWatchLoggingOptions](#cloudwatchloggingoptions) -* **EndpointConfiguration**: [HttpEndpointConfiguration](#httpendpointconfiguration) (Required) +* **ClusterJDBCURL**: string (Required) +* **CopyCommand**: [CopyCommand](#copycommand) (Required) +* **Password**: string * **ProcessingConfiguration**: [ProcessingConfiguration](#processingconfiguration) -* **RequestConfiguration**: [HttpEndpointRequestConfiguration](#httpendpointrequestconfiguration) -* **RetryOptions**: [RetryOptions](#retryoptions) -* **RoleARN**: string +* **RetryOptions**: [RedshiftRetryOptions](#redshiftretryoptions) +* **RoleARN**: string (Required) +* **S3BackupConfiguration**: [S3DestinationConfiguration](#s3destinationconfiguration) * **S3BackupMode**: string * **S3Configuration**: [S3DestinationConfiguration](#s3destinationconfiguration) (Required) +* **SecretsManagerConfiguration**: [SecretsManagerConfiguration](#secretsmanagerconfiguration) +* **Username**: string -## HttpEndpointConfiguration +## RedshiftRetryOptions ### Properties -* **AccessKey**: string -* **Name**: string -* **Url**: string (Required) +* **DurationInSeconds**: int -## HttpEndpointRequestConfiguration +## RetryOptions ### Properties -* **CommonAttributes**: [HttpEndpointCommonAttribute](#httpendpointcommonattribute)[] -* **ContentEncoding**: string +* **DurationInSeconds**: int -## HttpEndpointCommonAttribute +## S3DestinationConfiguration ### Properties -* **AttributeName**: string (Required) -* **AttributeValue**: string (Required) +* **BucketARN**: string (Required) +* **BufferingHints**: [BufferingHints](#bufferinghints) +* **CloudWatchLoggingOptions**: [CloudWatchLoggingOptions](#cloudwatchloggingoptions) +* **CompressionFormat**: string +* **EncryptionConfiguration**: [EncryptionConfiguration](#encryptionconfiguration) +* **ErrorOutputPrefix**: string +* **Prefix**: string +* **RoleARN**: string (Required) -## KinesisStreamSourceConfiguration +## SchemaConfiguration ### Properties -* **KinesisStreamARN**: string (Required) -* **RoleARN**: string (Required) +* **CatalogId**: string +* **DatabaseName**: string +* **Region**: string +* **RoleARN**: string +* **TableName**: string +* **VersionId**: string -## MSKSourceConfiguration +## SecretsManagerConfiguration ### Properties -* **AuthenticationConfiguration**: [AuthenticationConfiguration](#authenticationconfiguration) (Required) -* **MSKClusterARN**: string (Required) -* **TopicName**: string (Required) +* **Enabled**: bool (Required) +* **RoleARN**: string +* **SecretARN**: string -## AuthenticationConfiguration +## Serializer ### Properties -* **Connectivity**: string (Required) -* **RoleARN**: string (Required) +* **OrcSerDe**: [OrcSerDe](#orcserde) +* **ParquetSerDe**: [ParquetSerDe](#parquetserde) -## RedshiftDestinationConfiguration +## SnowflakeDestinationConfiguration ### Properties +* **AccountUrl**: string (Required) * **CloudWatchLoggingOptions**: [CloudWatchLoggingOptions](#cloudwatchloggingoptions) -* **ClusterJDBCURL**: string (Required) -* **CopyCommand**: [CopyCommand](#copycommand) (Required) -* **Password**: string (Required) +* **ContentColumnName**: string +* **Database**: string (Required) +* **DataLoadingOption**: string +* **KeyPassphrase**: string +* **MetaDataColumnName**: string +* **PrivateKey**: string * **ProcessingConfiguration**: [ProcessingConfiguration](#processingconfiguration) -* **RetryOptions**: [RedshiftRetryOptions](#redshiftretryoptions) +* **RetryOptions**: [SnowflakeRetryOptions](#snowflakeretryoptions) * **RoleARN**: string (Required) -* **S3BackupConfiguration**: [S3DestinationConfiguration](#s3destinationconfiguration) * **S3BackupMode**: string * **S3Configuration**: [S3DestinationConfiguration](#s3destinationconfiguration) (Required) -* **Username**: string (Required) +* **Schema**: string (Required) +* **SecretsManagerConfiguration**: [SecretsManagerConfiguration](#secretsmanagerconfiguration) +* **SnowflakeRoleConfiguration**: [SnowflakeRoleConfiguration](#snowflakeroleconfiguration) +* **SnowflakeVpcConfiguration**: [SnowflakeVpcConfiguration](#snowflakevpcconfiguration) +* **Table**: string (Required) +* **User**: string -## CopyCommand +## SnowflakeRetryOptions ### Properties -* **CopyOptions**: string -* **DataTableColumns**: string -* **DataTableName**: string (Required) +* **DurationInSeconds**: int -## RedshiftRetryOptions +## SnowflakeRoleConfiguration ### Properties -* **DurationInSeconds**: int +* **Enabled**: bool +* **SnowflakeRole**: string + +## SnowflakeVpcConfiguration +### Properties +* **PrivateLinkVpceId**: string (Required) + +## SplunkBufferingHints +### Properties +* **IntervalInSeconds**: int +* **SizeInMBs**: int ## SplunkDestinationConfiguration ### Properties @@ -329,16 +374,12 @@ * **HECAcknowledgmentTimeoutInSeconds**: int * **HECEndpoint**: string (Required) * **HECEndpointType**: string (Required) -* **HECToken**: string (Required) +* **HECToken**: string * **ProcessingConfiguration**: [ProcessingConfiguration](#processingconfiguration) * **RetryOptions**: [SplunkRetryOptions](#splunkretryoptions) * **S3BackupMode**: string * **S3Configuration**: [S3DestinationConfiguration](#s3destinationconfiguration) (Required) - -## SplunkBufferingHints -### Properties -* **IntervalInSeconds**: int -* **SizeInMBs**: int +* **SecretsManagerConfiguration**: [SecretsManagerConfiguration](#secretsmanagerconfiguration) ## SplunkRetryOptions ### Properties @@ -349,3 +390,9 @@ * **Key**: string (Required) * **Value**: string +## VpcConfiguration +### Properties +* **RoleARN**: string (Required) +* **SecurityGroupIds**: string[] (Required) +* **SubnetIds**: string[] (Required) + diff --git a/artifacts/bicep/aws/aws.kinesisvideo/default/types.json b/artifacts/bicep/aws/aws.kinesisvideo/default/types.json index c4bd96a4..57de544b 100644 --- a/artifacts/bicep/aws/aws.kinesisvideo/default/types.json +++ b/artifacts/bicep/aws/aws.kinesisvideo/default/types.json @@ -1 +1,236 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. Specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. The following characters can be used: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. Specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. The following characters can be used: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.KinesisVideo/SignalingChannelProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) of the Kinesis Video Signaling Channel."},"MessageTtlSeconds":{"Type":3,"Flags":0,"Description":"The period of time a signaling channel retains undelivered messages before they are discarded."},"Name":{"Type":4,"Flags":16,"Description":"The name of the Kinesis Video Signaling Channel."},"Tags":{"Type":10,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."},"Type":{"Type":4,"Flags":0,"Description":"The type of the Kinesis Video Signaling Channel to create. Currently, SINGLE_MASTER is the only supported channel type."}}}},{"3":{"ItemType":8}},{"2":{"Name":"AWS.KinesisVideo/SignalingChannel","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":9,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.KinesisVideo/SignalingChannel@default","ScopeType":0,"Body":11}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. Specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. The following characters can be used: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. Specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. The following characters can be used: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.KinesisVideo/StreamProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) of the Kinesis Video stream."},"DataRetentionInHours":{"Type":3,"Flags":0,"Description":"The number of hours till which Kinesis Video will retain the data in the stream"},"DeviceName":{"Type":4,"Flags":0,"Description":"The name of the device that is writing to the stream."},"KmsKeyId":{"Type":4,"Flags":0,"Description":"AWS KMS key ID that Kinesis Video Streams uses to encrypt stream data."},"MediaType":{"Type":4,"Flags":0,"Description":"The media type of the stream. Consumers of the stream can use this information when processing the stream."},"Name":{"Type":4,"Flags":16,"Description":"The name of the Kinesis Video stream."},"Tags":{"Type":15,"Flags":0,"Description":"An array of key-value pairs associated with the Kinesis Video Stream."}}}},{"3":{"ItemType":13}},{"2":{"Name":"AWS.KinesisVideo/Stream","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":14,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.KinesisVideo/Stream@default","ScopeType":0,"Body":16}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. Specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. The following characters can be used: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for the tag. Specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. The following characters can be used: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.KinesisVideo/SignalingChannelProperties" + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ObjectType", + "name": "AWS.KinesisVideo/SignalingChannelProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) of the Kinesis Video Signaling Channel." + }, + "MessageTtlSeconds": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The period of time a signaling channel retains undelivered messages before they are discarded." + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 16, + "description": "The name of the Kinesis Video Signaling Channel." + }, + "Tags": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + }, + "Type": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The type of the Kinesis Video Signaling Channel to create. Currently, SINGLE_MASTER is the only supported channel type." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.KinesisVideo/SignalingChannel", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/5" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.KinesisVideo/SignalingChannel@default", + "scopeType": 0, + "body": { + "$ref": "#/6" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. Specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. The following characters can be used: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for the tag. Specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. The following characters can be used: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.KinesisVideo/StreamProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/8" + } + }, + { + "$type": "ObjectType", + "name": "AWS.KinesisVideo/StreamProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) of the Kinesis Video stream." + }, + "DataRetentionInHours": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The number of hours till which Kinesis Video will retain the data in the stream" + }, + "DeviceName": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The name of the device that is writing to the stream." + }, + "KmsKeyId": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "AWS KMS key ID that Kinesis Video Streams uses to encrypt stream data." + }, + "MediaType": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The media type of the stream. Consumers of the stream can use this information when processing the stream." + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 16, + "description": "The name of the Kinesis Video stream." + }, + "Tags": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "An array of key-value pairs associated with the Kinesis Video Stream." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.KinesisVideo/Stream", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/11" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.KinesisVideo/Stream@default", + "scopeType": 0, + "body": { + "$ref": "#/12" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.kinesisvideo/default/types.md b/artifacts/bicep/aws/aws.kinesisvideo/default/types.md index 9cb4d835..5659de0a 100644 --- a/artifacts/bicep/aws/aws.kinesisvideo/default/types.md +++ b/artifacts/bicep/aws/aws.kinesisvideo/default/types.md @@ -3,16 +3,16 @@ ## Resource AWS.KinesisVideo/SignalingChannel@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.KinesisVideo/SignalingChannelProperties](#awskinesisvideosignalingchannelproperties): properties of the resource +* **properties**: [AWS.KinesisVideo/SignalingChannelProperties](#awskinesisvideosignalingchannelproperties) (Identifier): properties of the resource ## Resource AWS.KinesisVideo/Stream@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.KinesisVideo/StreamProperties](#awskinesisvideostreamproperties): properties of the resource +* **properties**: [AWS.KinesisVideo/StreamProperties](#awskinesisvideostreamproperties) (Identifier): properties of the resource ## AWS.KinesisVideo/SignalingChannelProperties ### Properties @@ -22,11 +22,6 @@ * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. * **Type**: string: The type of the Kinesis Video Signaling Channel to create. Currently, SINGLE_MASTER is the only supported channel type. -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. Specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. The following characters can be used: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. Specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. The following characters can be used: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## AWS.KinesisVideo/StreamProperties ### Properties * **Arn**: string (ReadOnly): The Amazon Resource Name (ARN) of the Kinesis Video stream. @@ -37,6 +32,11 @@ * **Name**: string (Identifier): The name of the Kinesis Video stream. * **Tags**: [Tag](#tag)[]: An array of key-value pairs associated with the Kinesis Video Stream. +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. Specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. The following characters can be used: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. Specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. The following characters can be used: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + ## Tag ### Properties * **Key**: string (Required): The key name of the tag. Specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. The following characters can be used: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. diff --git a/artifacts/bicep/aws/aws.kms/default/types.json b/artifacts/bicep/aws/aws.kms/default/types.json index 5196fc13..49484075 100644 --- a/artifacts/bicep/aws/aws.kms/default/types.json +++ b/artifacts/bicep/aws/aws.kms/default/types.json @@ -1 +1,399 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"AWS.KMS/AliasProperties","Properties":{"AliasName":{"Type":4,"Flags":17,"Description":"Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias. The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed keys."},"TargetKeyId":{"Type":4,"Flags":1,"Description":"Identifies the AWS KMS key to which the alias refers. Specify the key ID or the Amazon Resource Name (ARN) of the AWS KMS key. You cannot specify another alias. For help finding the key ID and ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide."}}}},{"2":{"Name":"AWS.KMS/Alias","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":8,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.KMS/Alias@default","ScopeType":0,"Body":9}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.KMS/KeyProperties","Properties":{"Arn":{"Type":4,"Flags":2},"BypassPolicyLockoutSafetyCheck":{"Type":2,"Flags":4,"Description":"Skips (\"bypasses\") the key policy lockout safety check. The default value is false."},"Description":{"Type":4,"Flags":0,"Description":"A description of the AWS KMS key. Use a description that helps you to distinguish this AWS KMS key from others in the account, such as its intended use."},"EnableKeyRotation":{"Type":2,"Flags":0,"Description":"Enables automatic rotation of the key material for the specified AWS KMS key. By default, automation key rotation is not enabled."},"Enabled":{"Type":2,"Flags":0,"Description":"Specifies whether the AWS KMS key is enabled. Disabled AWS KMS keys cannot be used in cryptographic operations."},"KeyId":{"Type":4,"Flags":18},"KeyPolicy":{"Type":14,"Flags":0,"Description":"The key policy that authorizes use of the AWS KMS key. The key policy must observe the following rules."},"KeySpec":{"Type":4,"Flags":0,"Description":"Specifies the type of AWS KMS key to create. The default value is SYMMETRIC_DEFAULT. This property is required only for asymmetric AWS KMS keys. You can't change the KeySpec value after the AWS KMS key is created."},"KeyUsage":{"Type":4,"Flags":0,"Description":"Determines the cryptographic operations for which you can use the AWS KMS key. The default value is ENCRYPT_DECRYPT. This property is required only for asymmetric AWS KMS keys. You can't change the KeyUsage value after the AWS KMS key is created."},"MultiRegion":{"Type":2,"Flags":0,"Description":"Specifies whether the AWS KMS key should be Multi-Region. You can't change the MultiRegion value after the AWS KMS key is created."},"Origin":{"Type":4,"Flags":0,"Description":"The source of the key material for the KMS key. You cannot change the origin after you create the KMS key. The default is AWS_KMS, which means that AWS KMS creates the key material."},"PendingWindowInDays":{"Type":3,"Flags":4,"Description":"Specifies the number of days in the waiting period before AWS KMS deletes an AWS KMS key that has been removed from a CloudFormation stack. Enter a value between 7 and 30 days. The default value is 30 days."},"Tags":{"Type":15,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."}}}},{"2":{"Name":"Key_KeyPolicy","Properties":{}}},{"5":{"Elements":[13,4]}},{"3":{"ItemType":11}},{"2":{"Name":"AWS.KMS/Key","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":12,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.KMS/Key@default","ScopeType":0,"Body":16}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.KMS/ReplicaKeyProperties","Properties":{"Arn":{"Type":4,"Flags":2},"Description":{"Type":4,"Flags":0,"Description":"A description of the AWS KMS key. Use a description that helps you to distinguish this AWS KMS key from others in the account, such as its intended use."},"Enabled":{"Type":2,"Flags":0,"Description":"Specifies whether the AWS KMS key is enabled. Disabled AWS KMS keys cannot be used in cryptographic operations."},"KeyId":{"Type":4,"Flags":18},"KeyPolicy":{"Type":21,"Flags":1,"Description":"The key policy that authorizes use of the AWS KMS key. The key policy must observe the following rules."},"PendingWindowInDays":{"Type":3,"Flags":4,"Description":"Specifies the number of days in the waiting period before AWS KMS deletes an AWS KMS key that has been removed from a CloudFormation stack. Enter a value between 7 and 30 days. The default value is 30 days."},"PrimaryKeyArn":{"Type":4,"Flags":1,"Description":"Identifies the primary AWS KMS key to create a replica of. Specify the Amazon Resource Name (ARN) of the AWS KMS key. You cannot specify an alias or key ID. For help finding the ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide."},"Tags":{"Type":22,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."}}}},{"2":{"Name":"ReplicaKey_KeyPolicy","Properties":{}}},{"5":{"Elements":[20,4]}},{"3":{"ItemType":18}},{"2":{"Name":"AWS.KMS/ReplicaKey","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":19,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.KMS/ReplicaKey@default","ScopeType":0,"Body":23}}] \ No newline at end of file +[ + { + "$type": "StringLiteralType", + "value": "AWS.KMS/AliasProperties" + }, + { + "$type": "StringType" + }, + { + "$type": "ObjectType", + "name": "AWS.KMS/AliasProperties", + "properties": { + "AliasName": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "Specifies the alias name. This value must begin with ``alias/`` followed by a name, such as ``alias/ExampleAlias``. \n If you change the value of the ``AliasName`` property, the existing alias is deleted and a new alias is created for the specified KMS key. This change can disrupt applications that use the alias. It can also allow or deny access to a KMS key affected by attribute-based access control (ABAC).\n The alias must be string of 1-256 characters. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with ``alias/aws/``. The ``alias/aws/`` prefix is reserved for [](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk)." + }, + "TargetKeyId": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Associates the alias with the specified [](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk). The KMS key must be in the same AWS-account and Region.\n A valid key ID is required. If you supply a null or empty string value, this operation returns an error.\n For help finding the key ID and ARN, see [Finding the key ID and ARN](https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html#find-cmk-id-arn) in the *Developer Guide*.\n Specify the key ID or the key ARN of the KMS key.\n For example:\n + Key ID: ``1234abcd-12ab-34cd-56ef-1234567890ab`` \n + Key ARN: ``arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`` \n \n To get the key ID and key ARN for a KMS key, use [ListKeys](https://docs.aws.amazon.com/kms/latest/APIReference/API_ListKeys.html) or [DescribeKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html)." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.KMS/Alias", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.KMS/Alias@default", + "scopeType": 0, + "body": { + "$ref": "#/3" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "" + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "" + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.KMS/KeyProperties" + }, + { + "$type": "BooleanType" + }, + { + "$type": "ObjectType", + "name": "Key_KeyPolicy", + "properties": {} + }, + { + "$type": "UnionType", + "elements": [ + { + "$ref": "#/8" + }, + { + "$ref": "#/1" + } + ] + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ObjectType", + "name": "AWS.KMS/KeyProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "" + }, + "BypassPolicyLockoutSafetyCheck": { + "type": { + "$ref": "#/7" + }, + "flags": 4, + "description": "Skips (\"bypasses\") the key policy lockout safety check. The default value is false.\n Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately.\n For more information, see [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key) in the *Developer Guide*.\n Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent [PutKeyPolicy](https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) request on the KMS key." + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A description of the KMS key. Use a description that helps you to distinguish this KMS key from others in the account, such as its intended use." + }, + "EnableKeyRotation": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "Enables automatic rotation of the key material for the specified KMS key. By default, automatic key rotation is not enabled.\n KMS supports automatic rotation only for symmetric encryption KMS keys (``KeySpec`` = ``SYMMETRIC_DEFAULT``). For asymmetric KMS keys, HMAC KMS keys, and KMS keys with Origin ``EXTERNAL``, omit the ``EnableKeyRotation`` property or set it to ``false``.\n To enable automatic key rotation of the key material for a multi-Region KMS key, set ``EnableKeyRotation`` to ``true`` on the primary key (created by using ``AWS::KMS::Key``). KMS copies the rotation status to all replica keys. For details, see [Rotating multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-rotate) in the *Developer Guide*.\n When you enable automatic rotation, KMS automatically creates new key material for the KMS key one year after the enable date and every year thereafter. KMS retains all key material until you delete the KMS key. For detailed information about automatic key rotation, see [Rotating KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html) in the *Developer Guide*." + }, + "Enabled": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "Specifies whether the KMS key is enabled. Disabled KMS keys cannot be used in cryptographic operations.\n When ``Enabled`` is ``true``, the *key state* of the KMS key is ``Enabled``. When ``Enabled`` is ``false``, the key state of the KMS key is ``Disabled``. The default value is ``true``.\n The actual key state of the KMS key might be affected by actions taken outside of CloudFormation, such as running the [EnableKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_EnableKey.html), [DisableKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DisableKey.html), or [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operations.\n For information about the key states of a KMS key, see [Key state: Effect on your KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *Developer Guide*." + }, + "KeyId": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "" + }, + "KeyPolicy": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "The key policy to attach to the KMS key.\n If you provide a key policy, it must meet the following criteria:\n + The key policy must allow the caller to make a subsequent [PutKeyPolicy](https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, see [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam) in the *Developer Guide*. (To omit this condition, set ``BypassPolicyLockoutSafetyCheck`` to true.)\n + Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see [Changes that I make are not always immediately visible](https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency) in the *User Guide*.\n \n If you do not provide a key policy, KMS attaches a default key policy to the KMS key. For more information, see [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default) in the *Developer Guide*.\n A key policy document can include only the following characters:\n + Printable ASCII characters\n + Printable characters in the Basic Latin and Latin-1 Supplement character set\n + The tab (``\\u0009``), line feed (``\\u000A``), and carriage return (``\\u000D``) special characters\n \n *Minimum*: ``1`` \n *Maximum*: ``32768``" + }, + "KeySpec": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Specifies the type of KMS key to create. The default value, ``SYMMETRIC_DEFAULT``, creates a KMS key with a 256-bit symmetric key for encryption and decryption. In China Regions, ``SYMMETRIC_DEFAULT`` creates a 128-bit symmetric key that uses SM4 encryption. You can't change the ``KeySpec`` value after the KMS key is created. For help choosing a key spec for your KMS key, see [Choosing a KMS key type](https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-choose.html) in the *Developer Guide*.\n The ``KeySpec`` property determines the type of key material in the KMS key and the algorithms that the KMS key supports. To further restrict the algorithms that can be used with the KMS key, use a condition key in its key policy or IAM policy. For more information, see [condition keys](https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms) in the *Developer Guide*.\n If you change the value of the ``KeySpec`` property on an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing an immutable property value.\n [services that are integrated with](https://docs.aws.amazon.com/kms/features/#AWS_Service_Integration) use symmetric encryption KMS keys to protect your data. These services do not support encryption with asymmetric KMS keys. For help determining whether a KMS key is asymmetric, see [Identifying asymmetric KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/find-symm-asymm.html) in the *Developer Guide*.\n KMS supports the following key specs for KMS keys:\n + Symmetric encryption key (default)\n + ``SYMMETRIC_DEFAULT`` (AES-256-GCM)\n \n + HMAC keys (symmetric)\n + ``HMAC_224`` \n + ``HMAC_256`` \n + ``HMAC_384`` \n + ``HMAC_512`` \n \n + Asymmetric RSA key pairs\n + ``RSA_2048`` \n + ``RSA_3072`` \n + ``RSA_4096`` \n \n + Asymmetric NIST-recommended elliptic curve key pairs\n + ``ECC_NIST_P256`` (secp256r1)\n + ``ECC_NIST_P384`` (secp384r1)\n + ``ECC_NIST_P521`` (secp521r1)\n \n + Other asymmetric elliptic curve key pairs\n + ``ECC_SECG_P256K1`` (secp256k1), commonly used for cryptocurrencies.\n \n + SM2 key pairs (China Regions only)\n + ``SM2``" + }, + "KeyUsage": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Determines the [cryptographic operations](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) for which you can use the KMS key. The default value is ``ENCRYPT_DECRYPT``. This property is required for asymmetric KMS keys and HMAC KMS keys. You can't change the ``KeyUsage`` value after the KMS key is created.\n If you change the value of the ``KeyUsage`` property on an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing an immutable property value.\n Select only one valid value.\n + For symmetric encryption KMS keys, omit the property or specify ``ENCRYPT_DECRYPT``.\n + For asymmetric KMS keys with RSA key material, specify ``ENCRYPT_DECRYPT`` or ``SIGN_VERIFY``.\n + For asymmetric KMS keys with ECC key material, specify ``SIGN_VERIFY``.\n + For asymmetric KMS keys with SM2 (China Regions only) key material, specify ``ENCRYPT_DECRYPT`` or ``SIGN_VERIFY``.\n + For HMAC KMS keys, specify ``GENERATE_VERIFY_MAC``." + }, + "MultiRegion": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "Creates a multi-Region primary key that you can replicate in other AWS-Regions. You can't change the ``MultiRegion`` value after the KMS key is created.\n For a list of AWS-Regions in which multi-Region keys are supported, see [Multi-Region keys in](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the **.\n If you change the value of the ``MultiRegion`` property on an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing an immutable property value.\n For a multi-Region key, set to this property to ``true``. For a single-Region key, omit this property or set it to ``false``. The default value is ``false``.\n *Multi-Region keys* are an KMS feature that lets you create multiple interoperable KMS keys in different AWS-Regions. Because these KMS keys have the same key ID, key material, and other metadata, you can use them to encrypt data in one AWS-Region and decrypt it in a different AWS-Region without making a cross-Region call or exposing the plaintext data. For more information, see [Multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the *Developer Guide*.\n You can create a symmetric encryption, HMAC, or asymmetric multi-Region KMS key, and you can create a multi-Region key with imported key material. However, you cannot create a multi-Region key in a custom key store.\n To create a replica of this primary key in a different AWS-Region , create an [AWS::KMS::ReplicaKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-replicakey.html) resource in a CloudFormation stack in the replica Region. Specify the key ARN of this primary key." + }, + "Origin": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The source of the key material for the KMS key. You cannot change the origin after you create the KMS key. The default is ``AWS_KMS``, which means that KMS creates the key material.\n To [create a KMS key with no key material](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys-create-cmk.html) (for imported key material), set this value to ``EXTERNAL``. For more information about importing key material into KMS, see [Importing Key Material](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) in the *Developer Guide*.\n You can ignore ``ENABLED`` when Origin is ``EXTERNAL``. When a KMS key with Origin ``EXTERNAL`` is created, the key state is ``PENDING_IMPORT`` and ``ENABLED`` is ``false``. After you import the key material, ``ENABLED`` updated to ``true``. The KMS key can then be used for Cryptographic Operations. \n CFN doesn't support creating an ``Origin`` parameter of the ``AWS_CLOUDHSM`` or ``EXTERNAL_KEY_STORE`` values." + }, + "PendingWindowInDays": { + "type": { + "$ref": "#/10" + }, + "flags": 4, + "description": "Specifies the number of days in the waiting period before KMS deletes a KMS key that has been removed from a CloudFormation stack. Enter a value between 7 and 30 days. The default value is 30 days.\n When you remove a KMS key from a CloudFormation stack, KMS schedules the KMS key for deletion and starts the mandatory waiting period. The ``PendingWindowInDays`` property determines the length of waiting period. During the waiting period, the key state of KMS key is ``Pending Deletion`` or ``Pending Replica Deletion``, which prevents the KMS key from being used in cryptographic operations. When the waiting period expires, KMS permanently deletes the KMS key.\n KMS will not delete a [multi-Region primary key](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) that has replica keys. If you remove a multi-Region primary key from a CloudFormation stack, its key state changes to ``PendingReplicaDeletion`` so it cannot be replicated or used in cryptographic operations. This state can persist indefinitely. When the last of its replica keys is deleted, the key state of the primary key changes to ``PendingDeletion`` and the waiting period specified by ``PendingWindowInDays`` begins. When this waiting period expires, KMS deletes the primary key. For details, see [Deleting multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html) in the *Developer Guide*.\n You cannot use a CloudFormation template to cancel deletion of the KMS key after you remove it from the stack, regardless of the waiting period. If you specify a KMS key in your template, even one with the same name, CloudFormation creates a new KMS key. To cancel deletion of a KMS key, use the KMS console or the [CancelKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_CancelKeyDeletion.html) operation.\n For information about the ``Pending Deletion`` and ``Pending Replica Deletion`` key states, see [Key state: Effect on your KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *Developer Guide*. For more information about deleting KMS keys, see the [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operation in the *API Reference* and [Deleting KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html) in the *Developer Guide*." + }, + "RotationPeriodInDays": { + "type": { + "$ref": "#/10" + }, + "flags": 4, + "description": "Specifies a custom period of time between each rotation date. If no value is specified, the default value is 365 days.\n The rotation period defines the number of days after you enable automatic key rotation that KMS will rotate your key material, and the number of days between each automatic rotation thereafter.\n You can use the [kms:RotationPeriodInDays](https://docs.aws.amazon.com/kms/latest/developerguide/conditions-kms.html#conditions-kms-rotation-period-in-days) condition key to further constrain the values that principals can specify in the ``RotationPeriodInDays`` parameter.\n For more information about rotating KMS keys and automatic rotation, see [Rotating keys](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html) in the *Developer Guide*." + }, + "Tags": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "Assigns one or more tags to the replica key.\n Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see [ABAC for](https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) in the *Developer Guide*.\n For information about tags in KMS, see [Tagging keys](https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html) in the *Developer Guide*. For information about tags in CloudFormation, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.KMS/Key", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/12" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.KMS/Key@default", + "scopeType": 0, + "body": { + "$ref": "#/13" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.KMS/ReplicaKeyProperties" + }, + { + "$type": "ObjectType", + "name": "ReplicaKey_KeyPolicy", + "properties": {} + }, + { + "$type": "UnionType", + "elements": [ + { + "$ref": "#/17" + }, + { + "$ref": "#/1" + } + ] + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/15" + } + }, + { + "$type": "ObjectType", + "name": "AWS.KMS/ReplicaKeyProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A description of the AWS KMS key. Use a description that helps you to distinguish this AWS KMS key from others in the account, such as its intended use." + }, + "Enabled": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "Specifies whether the AWS KMS key is enabled. Disabled AWS KMS keys cannot be used in cryptographic operations." + }, + "KeyId": { + "type": { + "$ref": "#/1" + }, + "flags": 18 + }, + "KeyPolicy": { + "type": { + "$ref": "#/18" + }, + "flags": 1, + "description": "The key policy that authorizes use of the AWS KMS key. The key policy must observe the following rules." + }, + "PendingWindowInDays": { + "type": { + "$ref": "#/10" + }, + "flags": 4, + "description": "Specifies the number of days in the waiting period before AWS KMS deletes an AWS KMS key that has been removed from a CloudFormation stack. Enter a value between 7 and 30 days. The default value is 30 days." + }, + "PrimaryKeyArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Identifies the primary AWS KMS key to create a replica of. Specify the Amazon Resource Name (ARN) of the AWS KMS key. You cannot specify an alias or key ID. For help finding the ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide." + }, + "Tags": { + "type": { + "$ref": "#/19" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.KMS/ReplicaKey", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/20" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.KMS/ReplicaKey@default", + "scopeType": 0, + "body": { + "$ref": "#/21" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.kms/default/types.md b/artifacts/bicep/aws/aws.kms/default/types.md index 778ea36e..3ea47b3c 100644 --- a/artifacts/bicep/aws/aws.kms/default/types.md +++ b/artifacts/bicep/aws/aws.kms/default/types.md @@ -3,49 +3,129 @@ ## Resource AWS.KMS/Alias@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.KMS/AliasProperties](#awskmsaliasproperties) (Required): properties of the resource +* **properties**: [AWS.KMS/AliasProperties](#awskmsaliasproperties) (Required, Identifier): properties of the resource ## Resource AWS.KMS/Key@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.KMS/KeyProperties](#awskmskeyproperties): properties of the resource +* **properties**: [AWS.KMS/KeyProperties](#awskmskeyproperties) (Identifier): properties of the resource ## Resource AWS.KMS/ReplicaKey@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.KMS/ReplicaKeyProperties](#awskmsreplicakeyproperties) (Required): properties of the resource +* **properties**: [AWS.KMS/ReplicaKeyProperties](#awskmsreplicakeyproperties) (Required, Identifier): properties of the resource ## AWS.KMS/AliasProperties ### Properties -* **AliasName**: string (Required, Identifier): Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias. The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed keys. -* **TargetKeyId**: string (Required): Identifies the AWS KMS key to which the alias refers. Specify the key ID or the Amazon Resource Name (ARN) of the AWS KMS key. You cannot specify another alias. For help finding the key ID and ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide. +* **AliasName**: string (Required, Identifier): Specifies the alias name. This value must begin with ``alias/`` followed by a name, such as ``alias/ExampleAlias``. + If you change the value of the ``AliasName`` property, the existing alias is deleted and a new alias is created for the specified KMS key. This change can disrupt applications that use the alias. It can also allow or deny access to a KMS key affected by attribute-based access control (ABAC). + The alias must be string of 1-256 characters. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with ``alias/aws/``. The ``alias/aws/`` prefix is reserved for [](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk). +* **TargetKeyId**: string (Required): Associates the alias with the specified [](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk). The KMS key must be in the same AWS-account and Region. + A valid key ID is required. If you supply a null or empty string value, this operation returns an error. + For help finding the key ID and ARN, see [Finding the key ID and ARN](https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html#find-cmk-id-arn) in the *Developer Guide*. + Specify the key ID or the key ARN of the KMS key. + For example: + + Key ID: ``1234abcd-12ab-34cd-56ef-1234567890ab`` + + Key ARN: ``arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`` + + To get the key ID and key ARN for a KMS key, use [ListKeys](https://docs.aws.amazon.com/kms/latest/APIReference/API_ListKeys.html) or [DescribeKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html). ## AWS.KMS/KeyProperties ### Properties * **Arn**: string (ReadOnly) * **BypassPolicyLockoutSafetyCheck**: bool (WriteOnly): Skips ("bypasses") the key policy lockout safety check. The default value is false. -* **Description**: string: A description of the AWS KMS key. Use a description that helps you to distinguish this AWS KMS key from others in the account, such as its intended use. -* **Enabled**: bool: Specifies whether the AWS KMS key is enabled. Disabled AWS KMS keys cannot be used in cryptographic operations. -* **EnableKeyRotation**: bool: Enables automatic rotation of the key material for the specified AWS KMS key. By default, automation key rotation is not enabled. + Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately. + For more information, see [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key) in the *Developer Guide*. + Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent [PutKeyPolicy](https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) request on the KMS key. +* **Description**: string: A description of the KMS key. Use a description that helps you to distinguish this KMS key from others in the account, such as its intended use. +* **Enabled**: bool: Specifies whether the KMS key is enabled. Disabled KMS keys cannot be used in cryptographic operations. + When ``Enabled`` is ``true``, the *key state* of the KMS key is ``Enabled``. When ``Enabled`` is ``false``, the key state of the KMS key is ``Disabled``. The default value is ``true``. + The actual key state of the KMS key might be affected by actions taken outside of CloudFormation, such as running the [EnableKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_EnableKey.html), [DisableKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DisableKey.html), or [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operations. + For information about the key states of a KMS key, see [Key state: Effect on your KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *Developer Guide*. +* **EnableKeyRotation**: bool: Enables automatic rotation of the key material for the specified KMS key. By default, automatic key rotation is not enabled. + KMS supports automatic rotation only for symmetric encryption KMS keys (``KeySpec`` = ``SYMMETRIC_DEFAULT``). For asymmetric KMS keys, HMAC KMS keys, and KMS keys with Origin ``EXTERNAL``, omit the ``EnableKeyRotation`` property or set it to ``false``. + To enable automatic key rotation of the key material for a multi-Region KMS key, set ``EnableKeyRotation`` to ``true`` on the primary key (created by using ``AWS::KMS::Key``). KMS copies the rotation status to all replica keys. For details, see [Rotating multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-rotate) in the *Developer Guide*. + When you enable automatic rotation, KMS automatically creates new key material for the KMS key one year after the enable date and every year thereafter. KMS retains all key material until you delete the KMS key. For detailed information about automatic key rotation, see [Rotating KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html) in the *Developer Guide*. * **KeyId**: string (ReadOnly, Identifier) -* **KeyPolicy**: [Key_KeyPolicy](#keykeypolicy) | string: The key policy that authorizes use of the AWS KMS key. The key policy must observe the following rules. -* **KeySpec**: string: Specifies the type of AWS KMS key to create. The default value is SYMMETRIC_DEFAULT. This property is required only for asymmetric AWS KMS keys. You can't change the KeySpec value after the AWS KMS key is created. -* **KeyUsage**: string: Determines the cryptographic operations for which you can use the AWS KMS key. The default value is ENCRYPT_DECRYPT. This property is required only for asymmetric AWS KMS keys. You can't change the KeyUsage value after the AWS KMS key is created. -* **MultiRegion**: bool: Specifies whether the AWS KMS key should be Multi-Region. You can't change the MultiRegion value after the AWS KMS key is created. -* **Origin**: string: The source of the key material for the KMS key. You cannot change the origin after you create the KMS key. The default is AWS_KMS, which means that AWS KMS creates the key material. -* **PendingWindowInDays**: int (WriteOnly): Specifies the number of days in the waiting period before AWS KMS deletes an AWS KMS key that has been removed from a CloudFormation stack. Enter a value between 7 and 30 days. The default value is 30 days. -* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. - -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **KeyPolicy**: [Key_KeyPolicy](#keykeypolicy) | string: The key policy to attach to the KMS key. + If you provide a key policy, it must meet the following criteria: + + The key policy must allow the caller to make a subsequent [PutKeyPolicy](https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, see [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam) in the *Developer Guide*. (To omit this condition, set ``BypassPolicyLockoutSafetyCheck`` to true.) + + Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see [Changes that I make are not always immediately visible](https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency) in the *User Guide*. + + If you do not provide a key policy, KMS attaches a default key policy to the KMS key. For more information, see [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default) in the *Developer Guide*. + A key policy document can include only the following characters: + + Printable ASCII characters + + Printable characters in the Basic Latin and Latin-1 Supplement character set + + The tab (``\u0009``), line feed (``\u000A``), and carriage return (``\u000D``) special characters + + *Minimum*: ``1`` + *Maximum*: ``32768`` +* **KeySpec**: string: Specifies the type of KMS key to create. The default value, ``SYMMETRIC_DEFAULT``, creates a KMS key with a 256-bit symmetric key for encryption and decryption. In China Regions, ``SYMMETRIC_DEFAULT`` creates a 128-bit symmetric key that uses SM4 encryption. You can't change the ``KeySpec`` value after the KMS key is created. For help choosing a key spec for your KMS key, see [Choosing a KMS key type](https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-choose.html) in the *Developer Guide*. + The ``KeySpec`` property determines the type of key material in the KMS key and the algorithms that the KMS key supports. To further restrict the algorithms that can be used with the KMS key, use a condition key in its key policy or IAM policy. For more information, see [condition keys](https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms) in the *Developer Guide*. + If you change the value of the ``KeySpec`` property on an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing an immutable property value. + [services that are integrated with](https://docs.aws.amazon.com/kms/features/#AWS_Service_Integration) use symmetric encryption KMS keys to protect your data. These services do not support encryption with asymmetric KMS keys. For help determining whether a KMS key is asymmetric, see [Identifying asymmetric KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/find-symm-asymm.html) in the *Developer Guide*. + KMS supports the following key specs for KMS keys: + + Symmetric encryption key (default) + + ``SYMMETRIC_DEFAULT`` (AES-256-GCM) + + + HMAC keys (symmetric) + + ``HMAC_224`` + + ``HMAC_256`` + + ``HMAC_384`` + + ``HMAC_512`` + + + Asymmetric RSA key pairs + + ``RSA_2048`` + + ``RSA_3072`` + + ``RSA_4096`` + + + Asymmetric NIST-recommended elliptic curve key pairs + + ``ECC_NIST_P256`` (secp256r1) + + ``ECC_NIST_P384`` (secp384r1) + + ``ECC_NIST_P521`` (secp521r1) + + + Other asymmetric elliptic curve key pairs + + ``ECC_SECG_P256K1`` (secp256k1), commonly used for cryptocurrencies. + + + SM2 key pairs (China Regions only) + + ``SM2`` +* **KeyUsage**: string: Determines the [cryptographic operations](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) for which you can use the KMS key. The default value is ``ENCRYPT_DECRYPT``. This property is required for asymmetric KMS keys and HMAC KMS keys. You can't change the ``KeyUsage`` value after the KMS key is created. + If you change the value of the ``KeyUsage`` property on an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing an immutable property value. + Select only one valid value. + + For symmetric encryption KMS keys, omit the property or specify ``ENCRYPT_DECRYPT``. + + For asymmetric KMS keys with RSA key material, specify ``ENCRYPT_DECRYPT`` or ``SIGN_VERIFY``. + + For asymmetric KMS keys with ECC key material, specify ``SIGN_VERIFY``. + + For asymmetric KMS keys with SM2 (China Regions only) key material, specify ``ENCRYPT_DECRYPT`` or ``SIGN_VERIFY``. + + For HMAC KMS keys, specify ``GENERATE_VERIFY_MAC``. +* **MultiRegion**: bool: Creates a multi-Region primary key that you can replicate in other AWS-Regions. You can't change the ``MultiRegion`` value after the KMS key is created. + For a list of AWS-Regions in which multi-Region keys are supported, see [Multi-Region keys in](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the **. + If you change the value of the ``MultiRegion`` property on an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing an immutable property value. + For a multi-Region key, set to this property to ``true``. For a single-Region key, omit this property or set it to ``false``. The default value is ``false``. + *Multi-Region keys* are an KMS feature that lets you create multiple interoperable KMS keys in different AWS-Regions. Because these KMS keys have the same key ID, key material, and other metadata, you can use them to encrypt data in one AWS-Region and decrypt it in a different AWS-Region without making a cross-Region call or exposing the plaintext data. For more information, see [Multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the *Developer Guide*. + You can create a symmetric encryption, HMAC, or asymmetric multi-Region KMS key, and you can create a multi-Region key with imported key material. However, you cannot create a multi-Region key in a custom key store. + To create a replica of this primary key in a different AWS-Region , create an [AWS::KMS::ReplicaKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-replicakey.html) resource in a CloudFormation stack in the replica Region. Specify the key ARN of this primary key. +* **Origin**: string: The source of the key material for the KMS key. You cannot change the origin after you create the KMS key. The default is ``AWS_KMS``, which means that KMS creates the key material. + To [create a KMS key with no key material](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys-create-cmk.html) (for imported key material), set this value to ``EXTERNAL``. For more information about importing key material into KMS, see [Importing Key Material](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) in the *Developer Guide*. + You can ignore ``ENABLED`` when Origin is ``EXTERNAL``. When a KMS key with Origin ``EXTERNAL`` is created, the key state is ``PENDING_IMPORT`` and ``ENABLED`` is ``false``. After you import the key material, ``ENABLED`` updated to ``true``. The KMS key can then be used for Cryptographic Operations. + CFN doesn't support creating an ``Origin`` parameter of the ``AWS_CLOUDHSM`` or ``EXTERNAL_KEY_STORE`` values. +* **PendingWindowInDays**: int (WriteOnly): Specifies the number of days in the waiting period before KMS deletes a KMS key that has been removed from a CloudFormation stack. Enter a value between 7 and 30 days. The default value is 30 days. + When you remove a KMS key from a CloudFormation stack, KMS schedules the KMS key for deletion and starts the mandatory waiting period. The ``PendingWindowInDays`` property determines the length of waiting period. During the waiting period, the key state of KMS key is ``Pending Deletion`` or ``Pending Replica Deletion``, which prevents the KMS key from being used in cryptographic operations. When the waiting period expires, KMS permanently deletes the KMS key. + KMS will not delete a [multi-Region primary key](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) that has replica keys. If you remove a multi-Region primary key from a CloudFormation stack, its key state changes to ``PendingReplicaDeletion`` so it cannot be replicated or used in cryptographic operations. This state can persist indefinitely. When the last of its replica keys is deleted, the key state of the primary key changes to ``PendingDeletion`` and the waiting period specified by ``PendingWindowInDays`` begins. When this waiting period expires, KMS deletes the primary key. For details, see [Deleting multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html) in the *Developer Guide*. + You cannot use a CloudFormation template to cancel deletion of the KMS key after you remove it from the stack, regardless of the waiting period. If you specify a KMS key in your template, even one with the same name, CloudFormation creates a new KMS key. To cancel deletion of a KMS key, use the KMS console or the [CancelKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_CancelKeyDeletion.html) operation. + For information about the ``Pending Deletion`` and ``Pending Replica Deletion`` key states, see [Key state: Effect on your KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *Developer Guide*. For more information about deleting KMS keys, see the [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operation in the *API Reference* and [Deleting KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html) in the *Developer Guide*. +* **RotationPeriodInDays**: int (WriteOnly): Specifies a custom period of time between each rotation date. If no value is specified, the default value is 365 days. + The rotation period defines the number of days after you enable automatic key rotation that KMS will rotate your key material, and the number of days between each automatic rotation thereafter. + You can use the [kms:RotationPeriodInDays](https://docs.aws.amazon.com/kms/latest/developerguide/conditions-kms.html#conditions-kms-rotation-period-in-days) condition key to further constrain the values that principals can specify in the ``RotationPeriodInDays`` parameter. + For more information about rotating KMS keys and automatic rotation, see [Rotating keys](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html) in the *Developer Guide*. +* **Tags**: [Tag](#tag)[]: Assigns one or more tags to the replica key. + Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see [ABAC for](https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) in the *Developer Guide*. + For information about tags in KMS, see [Tagging keys](https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html) in the *Developer Guide*. For information about tags in CloudFormation, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html). ## AWS.KMS/ReplicaKeyProperties ### Properties @@ -58,6 +138,11 @@ * **PrimaryKeyArn**: string (Required): Identifies the primary AWS KMS key to create a replica of. Specify the Amazon Resource Name (ARN) of the AWS KMS key. You cannot specify an alias or key ID. For help finding the ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide. * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + ## Tag ### Properties * **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. diff --git a/artifacts/bicep/aws/aws.lakeformation/default/types.json b/artifacts/bicep/aws/aws.lakeformation/default/types.json index 64729e82..0850e0c6 100644 --- a/artifacts/bicep/aws/aws.lakeformation/default/types.json +++ b/artifacts/bicep/aws/aws.lakeformation/default/types.json @@ -1 +1,104 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"CatalogIdString"}},{"2":{"Name":"LFTagKey"}},{"2":{"Name":"LFTagValue"}},{"2":{"Name":"TagValueList"}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.LakeFormation/TagProperties","Properties":{"CatalogId":{"Type":4,"Flags":0,"Description":"The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment."},"TagKey":{"Type":4,"Flags":17,"Description":"The key-name for the LF-tag."},"TagValues":{"Type":14,"Flags":1,"Description":"A list of possible values an attribute can take."}}}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.LakeFormation/Tag","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":13,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.LakeFormation/Tag@default","ScopeType":0,"Body":15}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "CatalogIdString", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LFTagKey", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LFTagValue", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TagValueList", + "properties": {} + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.LakeFormation/TagProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ObjectType", + "name": "AWS.LakeFormation/TagProperties", + "properties": { + "CatalogId": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment." + }, + "TagKey": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "The key-name for the LF-tag." + }, + "TagValues": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "A list of possible values an attribute can take." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.LakeFormation/Tag", + "properties": { + "name": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/8" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.LakeFormation/Tag@default", + "scopeType": 0, + "body": { + "$ref": "#/9" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.lakeformation/default/types.md b/artifacts/bicep/aws/aws.lakeformation/default/types.md index d1b1bd27..f4b52b3c 100644 --- a/artifacts/bicep/aws/aws.lakeformation/default/types.md +++ b/artifacts/bicep/aws/aws.lakeformation/default/types.md @@ -3,9 +3,9 @@ ## Resource AWS.LakeFormation/Tag@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.LakeFormation/TagProperties](#awslakeformationtagproperties) (Required): properties of the resource +* **properties**: [AWS.LakeFormation/TagProperties](#awslakeformationtagproperties) (Required, Identifier): properties of the resource ## AWS.LakeFormation/TagProperties ### Properties diff --git a/artifacts/bicep/aws/aws.lambda/default/types.json b/artifacts/bicep/aws/aws.lambda/default/types.json index 5338bc00..c2bc0e3a 100644 --- a/artifacts/bicep/aws/aws.lambda/default/types.json +++ b/artifacts/bicep/aws/aws.lambda/default/types.json @@ -1 +1,1443 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"AllowedPublishers","Properties":{"SigningProfileVersionArns":{"Type":10,"Flags":1,"Description":"List of Signing profile version Arns"}}}},{"2":{"Name":"CodeSigningPolicies","Properties":{"UntrustedArtifactOnDeployment":{"Type":4,"Flags":1,"Description":"Indicates how Lambda operations involve updating the code artifact will operate. Default to Warn if not provided"}}}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.Lambda/CodeSigningConfigProperties","Properties":{"AllowedPublishers":{"Type":8,"Flags":1,"Description":"When the CodeSigningConfig is later on attached to a function, the function code will be expected to be signed by profiles from this list"},"CodeSigningConfigArn":{"Type":4,"Flags":18,"Description":"A unique Arn for CodeSigningConfig resource"},"CodeSigningConfigId":{"Type":4,"Flags":2,"Description":"A unique identifier for CodeSigningConfig resource"},"CodeSigningPolicies":{"Type":9,"Flags":0,"Description":"Policies to control how to act if a signature is invalid"},"Description":{"Type":4,"Flags":0,"Description":"A description of the CodeSigningConfig"}}}},{"2":{"Name":"AWS.Lambda/CodeSigningConfig","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":11,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Lambda/CodeSigningConfig@default","ScopeType":0,"Body":12}},{"2":{"Name":"DestinationConfig","Properties":{"OnFailure":{"Type":15,"Flags":0},"OnSuccess":{"Type":16,"Flags":0}}}},{"2":{"Name":"OnFailure","Properties":{"Destination":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) of the destination resource."}}}},{"2":{"Name":"OnSuccess","Properties":{"Destination":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) of the destination resource."}}}},{"2":{"Name":"AWS.Lambda/EventInvokeConfigProperties","Properties":{"DestinationConfig":{"Type":14,"Flags":0},"FunctionName":{"Type":4,"Flags":17,"Description":"The name of the Lambda function."},"MaximumEventAgeInSeconds":{"Type":3,"Flags":0,"Description":"The maximum age of a request that Lambda sends to a function for processing."},"MaximumRetryAttempts":{"Type":3,"Flags":0,"Description":"The maximum number of times to retry when the function returns an error."},"Qualifier":{"Type":4,"Flags":17,"Description":"The identifier of a version or alias."}}}},{"2":{"Name":"AWS.Lambda/EventInvokeConfig","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":17,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Lambda/EventInvokeConfig@default","ScopeType":0,"Body":18}},{"2":{"Name":"AmazonManagedKafkaEventSourceConfig","Properties":{"ConsumerGroupId":{"Type":4,"Flags":0,"Description":"The identifier for the Kafka Consumer Group to join."}}}},{"2":{"Name":"ConsumerGroupId"}},{"2":{"Name":"DestinationConfig","Properties":{"OnFailure":{"Type":28,"Flags":0,"Description":"The destination configuration for failed invocations."}}}},{"2":{"Name":"DocumentDBEventSourceConfig","Properties":{"CollectionName":{"Type":4,"Flags":0,"Description":"The collection name to connect to."},"DatabaseName":{"Type":4,"Flags":0,"Description":"The database name to connect to."},"FullDocument":{"Type":4,"Flags":0,"Description":"Include full document in change stream response. The default option will only send the changes made to documents to Lambda. If you want the complete document sent to Lambda, set this to UpdateLookup."}}}},{"2":{"Name":"Endpoints","Properties":{"KafkaBootstrapServers":{"Type":33,"Flags":0,"Description":"A list of Kafka server endpoints."}}}},{"2":{"Name":"Filter","Properties":{"Pattern":{"Type":4,"Flags":0,"Description":"The filter pattern that defines which events should be passed for invocations."}}}},{"2":{"Name":"FilterCriteria","Properties":{"Filters":{"Type":34,"Flags":0,"Description":"List of filters of this FilterCriteria"}}}},{"2":{"Name":"MaximumConcurrency"}},{"2":{"Name":"OnFailure","Properties":{"Destination":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) of the destination resource."}}}},{"2":{"Name":"ScalingConfig","Properties":{"MaximumConcurrency":{"Type":3,"Flags":0,"Description":"The maximum number of concurrent functions that the event source can invoke."}}}},{"2":{"Name":"SelfManagedEventSource","Properties":{"Endpoints":{"Type":24,"Flags":0,"Description":"The endpoints for a self-managed event source."}}}},{"2":{"Name":"SelfManagedKafkaEventSourceConfig","Properties":{"ConsumerGroupId":{"Type":4,"Flags":0,"Description":"The identifier for the Kafka Consumer Group to join."}}}},{"2":{"Name":"SourceAccessConfiguration","Properties":{"Type":{"Type":4,"Flags":0,"Description":"The type of source access configuration."},"URI":{"Type":4,"Flags":0,"Description":"The URI for the source access configuration resource."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":25}},{"2":{"Name":"AWS.Lambda/EventSourceMappingProperties","Properties":{"AmazonManagedKafkaEventSourceConfig":{"Type":20,"Flags":0,"Description":"Specific configuration settings for an MSK event source."},"BatchSize":{"Type":3,"Flags":0,"Description":"The maximum number of items to retrieve in a single batch."},"BisectBatchOnFunctionError":{"Type":2,"Flags":0,"Description":"(Streams) If the function returns an error, split the batch in two and retry."},"DestinationConfig":{"Type":22,"Flags":0,"Description":"(Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records."},"DocumentDBEventSourceConfig":{"Type":23,"Flags":0,"Description":"Document db event source config."},"Enabled":{"Type":2,"Flags":0,"Description":"Disables the event source mapping to pause polling and invocation."},"EventSourceArn":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) of the event source."},"FilterCriteria":{"Type":26,"Flags":0,"Description":"The filter criteria to control event filtering."},"FunctionName":{"Type":4,"Flags":1,"Description":"The name of the Lambda function."},"FunctionResponseTypes":{"Type":36,"Flags":0,"Description":"(Streams) A list of response types supported by the function."},"Id":{"Type":4,"Flags":18,"Description":"Event Source Mapping Identifier UUID."},"MaximumBatchingWindowInSeconds":{"Type":3,"Flags":0,"Description":"(Streams) The maximum amount of time to gather records before invoking the function, in seconds."},"MaximumRecordAgeInSeconds":{"Type":3,"Flags":0,"Description":"(Streams) The maximum age of a record that Lambda sends to a function for processing."},"MaximumRetryAttempts":{"Type":3,"Flags":0,"Description":"(Streams) The maximum number of times to retry when the function returns an error."},"ParallelizationFactor":{"Type":3,"Flags":0,"Description":"(Streams) The number of batches to process from each shard concurrently."},"Queues":{"Type":37,"Flags":0,"Description":"(ActiveMQ) A list of ActiveMQ queues."},"ScalingConfig":{"Type":29,"Flags":0,"Description":"The scaling configuration for the event source."},"SelfManagedEventSource":{"Type":30,"Flags":0,"Description":"Self-managed event source endpoints."},"SelfManagedKafkaEventSourceConfig":{"Type":31,"Flags":0,"Description":"Specific configuration settings for a Self-Managed Apache Kafka event source."},"SourceAccessConfigurations":{"Type":38,"Flags":0,"Description":"A list of SourceAccessConfiguration."},"StartingPosition":{"Type":4,"Flags":0,"Description":"The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Streams sources."},"StartingPositionTimestamp":{"Type":3,"Flags":0,"Description":"With StartingPosition set to AT_TIMESTAMP, the time from which to start reading, in Unix time seconds."},"Topics":{"Type":39,"Flags":0,"Description":"(Kafka) A list of Kafka topics."},"TumblingWindowInSeconds":{"Type":3,"Flags":0,"Description":"(Streams) Tumbling window (non-overlapping time window) duration to perform aggregations."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":32}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.Lambda/EventSourceMapping","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":35,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Lambda/EventSourceMapping@default","ScopeType":0,"Body":40}},{"2":{"Name":"Code","Properties":{"ImageUri":{"Type":4,"Flags":4,"Description":"ImageUri."},"S3Bucket":{"Type":4,"Flags":4,"Description":"An Amazon S3 bucket in the same AWS Region as your function. The bucket can be in a different AWS account."},"S3Key":{"Type":4,"Flags":4,"Description":"The Amazon S3 key of the deployment package."},"S3ObjectVersion":{"Type":4,"Flags":4,"Description":"For versioned objects, the version of the deployment package object to use."},"ZipFile":{"Type":4,"Flags":4,"Description":"The source code of your Lambda function. If you include your function source inline with this parameter, AWS CloudFormation places it in a file named index and zips it to create a deployment package.."}}}},{"2":{"Name":"DeadLetterConfig","Properties":{"TargetArn":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic."}}}},{"2":{"Name":"Environment","Properties":{"Variables":{"Type":55,"Flags":0,"Description":"Environment variable key-value pairs."}}}},{"2":{"Name":"EphemeralStorage","Properties":{"Size":{"Type":3,"Flags":1,"Description":"The amount of ephemeral storage that your function has access to."}}}},{"2":{"Name":"FileSystemConfig","Properties":{"Arn":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) of the Amazon EFS access point that provides access to the file system."},"LocalMountPath":{"Type":4,"Flags":1,"Description":"The path where the function can access the file system, starting with /mnt/."}}}},{"2":{"Name":"ImageConfig","Properties":{"Command":{"Type":56,"Flags":0,"Description":"Command."},"EntryPoint":{"Type":57,"Flags":0,"Description":"EntryPoint."},"WorkingDirectory":{"Type":4,"Flags":0,"Description":"WorkingDirectory."}}}},{"2":{"Name":"LoggingConfig","Properties":{"ApplicationLogLevel":{"Type":4,"Flags":0,"Description":"Application log granularity level, can only be used when LogFormat is set to JSON"},"LogFormat":{"Type":4,"Flags":0,"Description":"Log delivery format for the lambda function"},"LogGroup":{"Type":4,"Flags":0,"Description":"The log group name."},"SystemLogLevel":{"Type":4,"Flags":0,"Description":"System log granularity level, can only be used when LogFormat is set to JSON"}}}},{"2":{"Name":"RuntimeManagementConfig","Properties":{"RuntimeVersionArn":{"Type":4,"Flags":0,"Description":"Unique identifier for a runtime version arn"},"UpdateRuntimeOn":{"Type":4,"Flags":1,"Description":"Trigger for runtime update"}}}},{"2":{"Name":"SnapStart","Properties":{"ApplyOn":{"Type":4,"Flags":5,"Description":"Applying SnapStart setting on function resource type."}}}},{"2":{"Name":"SnapStartResponse","Properties":{"ApplyOn":{"Type":4,"Flags":2,"Description":"Applying SnapStart setting on function resource type."},"OptimizationStatus":{"Type":4,"Flags":2,"Description":"Indicates whether SnapStart is activated for the specified function version."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":0,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"TracingConfig","Properties":{"Mode":{"Type":4,"Flags":0,"Description":"The tracing mode."}}}},{"2":{"Name":"VpcConfig","Properties":{"Ipv6AllowedForDualStack":{"Type":2,"Flags":0,"Description":"A boolean indicating whether IPv6 protocols will be allowed for dual stack subnets"},"SecurityGroupIds":{"Type":58,"Flags":0,"Description":"A list of VPC security groups IDs."},"SubnetIds":{"Type":59,"Flags":0,"Description":"A list of VPC subnet IDs."}}}},{"2":{"Name":"Function_Variables","Properties":{}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.Lambda/FunctionProperties","Properties":{"Architectures":{"Type":61,"Flags":0},"Arn":{"Type":4,"Flags":2,"Description":"Unique identifier for function resources"},"Code":{"Type":42,"Flags":5,"Description":"The code for the function."},"CodeSigningConfigArn":{"Type":4,"Flags":0,"Description":"A unique Arn for CodeSigningConfig resource"},"DeadLetterConfig":{"Type":43,"Flags":0,"Description":"A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing."},"Description":{"Type":4,"Flags":0,"Description":"A description of the function."},"Environment":{"Type":44,"Flags":0,"Description":"Environment variables that are accessible from function code during execution."},"EphemeralStorage":{"Type":45,"Flags":0,"Description":"A function's ephemeral storage settings."},"FileSystemConfigs":{"Type":62,"Flags":0,"Description":"Connection settings for an Amazon EFS file system. To connect a function to a file system, a mount target must be available in every Availability Zone that your function connects to. If your template contains an AWS::EFS::MountTarget resource, you must also specify a DependsOn attribute to ensure that the mount target is created or updated before the function."},"FunctionName":{"Type":4,"Flags":16,"Description":"The name of the Lambda function, up to 64 characters in length. If you don't specify a name, AWS CloudFormation generates one."},"Handler":{"Type":4,"Flags":0,"Description":"The name of the method within your code that Lambda calls to execute your function. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime"},"ImageConfig":{"Type":47,"Flags":0,"Description":"ImageConfig"},"KmsKeyArn":{"Type":4,"Flags":0,"Description":"The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment variables. If it's not provided, AWS Lambda uses a default service key."},"Layers":{"Type":63,"Flags":0,"Description":"A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version."},"LoggingConfig":{"Type":48,"Flags":0,"Description":"The logging configuration of your function"},"MemorySize":{"Type":3,"Flags":0,"Description":"The amount of memory that your function has access to. Increasing the function's memory also increases its CPU allocation. The default value is 128 MB. The value must be a multiple of 64 MB."},"PackageType":{"Type":4,"Flags":0,"Description":"PackageType."},"ReservedConcurrentExecutions":{"Type":3,"Flags":0,"Description":"The number of simultaneous executions to reserve for the function."},"Role":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) of the function's execution role."},"Runtime":{"Type":4,"Flags":0,"Description":"The identifier of the function's runtime."},"RuntimeManagementConfig":{"Type":49,"Flags":0,"Description":"RuntimeManagementConfig"},"SnapStart":{"Type":50,"Flags":4,"Description":"The SnapStart setting of your function"},"SnapStartResponse":{"Type":51,"Flags":2,"Description":"The SnapStart response of your function"},"Tags":{"Type":64,"Flags":0,"Description":"A list of tags to apply to the function."},"Timeout":{"Type":3,"Flags":0,"Description":"The amount of time that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds."},"TracingConfig":{"Type":53,"Flags":0,"Description":"Set Mode to Active to sample and trace a subset of incoming requests with AWS X-Ray."},"VpcConfig":{"Type":54,"Flags":0,"Description":"For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":46}},{"3":{"ItemType":4}},{"3":{"ItemType":52}},{"2":{"Name":"AWS.Lambda/Function","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":60,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Lambda/Function@default","ScopeType":0,"Body":65}},{"2":{"Name":"AllowHeaders"}},{"2":{"Name":"AllowMethods"}},{"2":{"Name":"AllowOrigins"}},{"2":{"Name":"Cors","Properties":{"AllowCredentials":{"Type":2,"Flags":0,"Description":"Specifies whether credentials are included in the CORS request."},"AllowHeaders":{"Type":75,"Flags":0,"Description":"Represents a collection of allowed headers."},"AllowMethods":{"Type":76,"Flags":0,"Description":"Represents a collection of allowed HTTP methods."},"AllowOrigins":{"Type":77,"Flags":0,"Description":"Represents a collection of allowed origins."},"ExposeHeaders":{"Type":78,"Flags":0,"Description":"Represents a collection of exposed headers."},"MaxAge":{"Type":3,"Flags":0}}}},{"2":{"Name":"ExposeHeaders"}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.Lambda/UrlProperties","Properties":{"AuthType":{"Type":4,"Flags":1,"Description":"Can be either AWS_IAM if the requests are authorized via IAM, or NONE if no authorization is configured on the Function URL."},"Cors":{"Type":70,"Flags":0},"FunctionArn":{"Type":4,"Flags":18,"Description":"The full Amazon Resource Name (ARN) of the function associated with the Function URL."},"FunctionUrl":{"Type":4,"Flags":2,"Description":"The generated url for this resource."},"InvokeMode":{"Type":4,"Flags":0,"Description":"The invocation mode for the function?s URL. Set to BUFFERED if you want to buffer responses before returning them to the client. Set to RESPONSE_STREAM if you want to stream responses, allowing faster time to first byte and larger response payload sizes. If not set, defaults to BUFFERED."},"Qualifier":{"Type":4,"Flags":0,"Description":"The alias qualifier for the target function. If TargetFunctionArn is unqualified then Qualifier must be passed."},"TargetFunctionArn":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) of the function associated with the Function URL."}}}},{"2":{"Name":"AWS.Lambda/Url","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":80,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Lambda/Url@default","ScopeType":0,"Body":81}},{"2":{"Name":"ProvisionedConcurrencyConfiguration","Properties":{"ProvisionedConcurrentExecutions":{"Type":3,"Flags":1,"Description":"The amount of provisioned concurrency to allocate for the version."}}}},{"2":{"Name":"RuntimePolicy","Properties":{"RuntimeVersionArn":{"Type":4,"Flags":0,"Description":"The ARN of the runtime the function is configured to use. If the runtime update mode is manual, the ARN is returned, otherwise null is returned."},"UpdateRuntimeOn":{"Type":4,"Flags":1,"Description":"The runtime update mode."}}}},{"2":{"Name":"AWS.Lambda/VersionProperties","Properties":{"CodeSha256":{"Type":4,"Flags":0,"Description":"Only publish a version if the hash value matches the value that's specified. Use this option to avoid publishing a version if the function code has changed since you last updated it. Updates are not supported for this property."},"Description":{"Type":4,"Flags":0,"Description":"A description for the version to override the description in the function configuration. Updates are not supported for this property."},"FunctionArn":{"Type":4,"Flags":18,"Description":"The ARN of the version."},"FunctionName":{"Type":4,"Flags":1,"Description":"The name of the Lambda function."},"ProvisionedConcurrencyConfig":{"Type":83,"Flags":0,"Description":"Specifies a provisioned concurrency configuration for a function's version. Updates are not supported for this property."},"RuntimePolicy":{"Type":84,"Flags":0,"Description":"Specifies the runtime management configuration of a function. Displays runtimeVersionArn only for Manual."},"Version":{"Type":4,"Flags":2,"Description":"The version number."}}}},{"2":{"Name":"AWS.Lambda/Version","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":85,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Lambda/Version@default","ScopeType":0,"Body":86}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "AllowedPublishers", + "properties": { + "SigningProfileVersionArns": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "List of Signing profile version Arns" + } + } + }, + { + "$type": "ObjectType", + "name": "CodeSigningPolicies", + "properties": { + "UntrustedArtifactOnDeployment": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "Indicates how Lambda operations involve updating the code artifact will operate. Default to Warn if not provided" + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Lambda/CodeSigningConfigProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.Lambda/CodeSigningConfigProperties", + "properties": { + "AllowedPublishers": { + "type": { + "$ref": "#/0" + }, + "flags": 1, + "description": "When the CodeSigningConfig is later on attached to a function, the function code will be expected to be signed by profiles from this list" + }, + "CodeSigningConfigArn": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "A unique Arn for CodeSigningConfig resource" + }, + "CodeSigningConfigId": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "A unique identifier for CodeSigningConfig resource" + }, + "CodeSigningPolicies": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Policies to control how to act if a signature is invalid" + }, + "Description": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "A description of the CodeSigningConfig" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Lambda/CodeSigningConfig", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Lambda/CodeSigningConfig@default", + "scopeType": 0, + "body": { + "$ref": "#/6" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "DestinationConfig", + "properties": { + "OnFailure": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "OnSuccess": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "OnFailure", + "properties": { + "Destination": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of the destination resource." + } + } + }, + { + "$type": "ObjectType", + "name": "OnSuccess", + "properties": { + "Destination": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of the destination resource." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Lambda/EventInvokeConfigProperties" + }, + { + "$type": "IntegerType" + }, + { + "$type": "ObjectType", + "name": "AWS.Lambda/EventInvokeConfigProperties", + "properties": { + "DestinationConfig": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "FunctionName": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "The name of the Lambda function." + }, + "MaximumEventAgeInSeconds": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "The maximum age of a request that Lambda sends to a function for processing." + }, + "MaximumRetryAttempts": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "The maximum number of times to retry when the function returns an error." + }, + "Qualifier": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "The identifier of a version or alias." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Lambda/EventInvokeConfig", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/13" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Lambda/EventInvokeConfig@default", + "scopeType": 0, + "body": { + "$ref": "#/14" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AmazonManagedKafkaEventSourceConfig", + "properties": { + "ConsumerGroupId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer 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-msk.html#services-msk-consumer-group-id)." + } + } + }, + { + "$type": "ObjectType", + "name": "ConsumerGroupId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DestinationConfig", + "properties": { + "OnFailure": { + "type": { + "$ref": "#/24" + }, + "flags": 0, + "description": "The destination configuration for failed invocations." + } + } + }, + { + "$type": "ObjectType", + "name": "DocumentDBEventSourceConfig", + "properties": { + "CollectionName": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The name of the collection to consume within the database. If you do not specify a collection, Lambda consumes all collections." + }, + "DatabaseName": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The name of the database to consume within the DocumentDB cluster." + }, + "FullDocument": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "Determines 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." + } + } + }, + { + "$type": "ObjectType", + "name": "Endpoints", + "properties": { + "KafkaBootstrapServers": { + "type": { + "$ref": "#/29" + }, + "flags": 0, + "description": "The list of bootstrap servers for your Kafka brokers in the following format: ``\"KafkaBootstrapServers\": [\"abc.xyz.com:xxxx\",\"abc2.xyz.com:xxxx\"]``." + } + } + }, + { + "$type": "ObjectType", + "name": "Filter", + "properties": { + "Pattern": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "A filter pattern. For more information on the syntax of a filter pattern, see [Filter rule syntax](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html#filtering-syntax)." + } + } + }, + { + "$type": "ObjectType", + "name": "FilterCriteria", + "properties": { + "Filters": { + "type": { + "$ref": "#/30" + }, + "flags": 0, + "description": "A list of filters." + } + } + }, + { + "$type": "ObjectType", + "name": "MaximumConcurrency", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "OnFailure", + "properties": { + "Destination": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the destination resource.\n To retain records of [asynchronous invocations](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-async-destinations), you can configure an Amazon SNS topic, Amazon SQS queue, Lambda function, or Amazon EventBridge event bus as the destination.\n To retain records of failed invocations from [Kinesis and DynamoDB event sources](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventsourcemapping.html#event-source-mapping-destinations), you can configure an Amazon SNS topic or Amazon SQS queue as the destination.\n To retain records of failed invocations from [self-managed Kafka](https://docs.aws.amazon.com/lambda/latest/dg/with-kafka.html#services-smaa-onfailure-destination) or [Amazon MSK](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-onfailure-destination), you can configure an Amazon SNS topic, Amazon SQS queue, or Amazon S3 bucket as the destination." + } + } + }, + { + "$type": "ObjectType", + "name": "ScalingConfig", + "properties": { + "MaximumConcurrency": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "Limits the number of concurrent instances that the SQS event source can invoke." + } + } + }, + { + "$type": "ObjectType", + "name": "SelfManagedEventSource", + "properties": { + "Endpoints": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "The list of bootstrap servers for your Kafka brokers in the following format: ``\"KafkaBootstrapServers\": [\"abc.xyz.com:xxxx\",\"abc2.xyz.com:xxxx\"]``." + } + } + }, + { + "$type": "ObjectType", + "name": "SelfManagedKafkaEventSourceConfig", + "properties": { + "ConsumerGroupId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer 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-msk.html#services-msk-consumer-group-id)." + } + } + }, + { + "$type": "ObjectType", + "name": "SourceAccessConfiguration", + "properties": { + "Type": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The type of authentication protocol, VPC components, or virtual host for your event source. For example: ``\"Type\":\"SASL_SCRAM_512_AUTH\"``.\n + ``BASIC_AUTH`` – (Amazon MQ) The ASMlong secret that stores your broker credentials.\n + ``BASIC_AUTH`` – (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`` – (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`` – (Self-managed Apache Kafka) The VPC security group used to manage access to your self-managed Apache Kafka brokers.\n + ``SASL_SCRAM_256_AUTH`` – (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`` – (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`` –- (RabbitMQ) The name of the virtual host in your RabbitMQ broker. Lambda uses this RabbitMQ host as the event source. This property cannot be specified in an UpdateEventSourceMapping API call.\n + ``CLIENT_CERTIFICATE_TLS_AUTH`` – (Amazon MSK, self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the certificate chain (X.509 PEM), 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`` – (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." + }, + "URI": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The value for your chosen configuration in ``Type``. For example: ``\"URI\": \"arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName\"``." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/21" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Lambda/EventSourceMappingProperties" + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/28" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Lambda/EventSourceMappingProperties", + "properties": { + "AmazonManagedKafkaEventSourceConfig": { + "type": { + "$ref": "#/16" + }, + "flags": 0, + "description": "Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source." + }, + "BatchSize": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "The 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 (6 MB).\n + *Amazon Kinesis* – Default 100. Max 10,000.\n + *Amazon DynamoDB Streams* – Default 100. Max 10,000.\n + *Amazon Simple Queue Service* – Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10.\n + *Amazon Managed Streaming for Apache Kafka* – Default 100. Max 10,000.\n + *Self-managed Apache Kafka* – Default 100. Max 10,000.\n + *Amazon MQ (ActiveMQ and RabbitMQ)* – Default 100. Max 10,000.\n + *DocumentDB* – Default 100. Max 10,000." + }, + "BisectBatchOnFunctionError": { + "type": { + "$ref": "#/32" + }, + "flags": 0, + "description": "(Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry. The default value is false." + }, + "DestinationConfig": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka event sources only) A configuration object that specifies the destination of an event after Lambda processes it." + }, + "DocumentDBEventSourceConfig": { + "type": { + "$ref": "#/19" + }, + "flags": 0, + "description": "Specific configuration settings for a DocumentDB event source." + }, + "Enabled": { + "type": { + "$ref": "#/32" + }, + "flags": 0, + "description": "When true, the event source mapping is active. When false, Lambda pauses polling and invocation.\n Default: True" + }, + "EventSourceArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the event source.\n + *Amazon Kinesis* – The ARN of the data stream or a stream consumer.\n + *Amazon DynamoDB Streams* – The ARN of the stream.\n + *Amazon Simple Queue Service* – The ARN of the queue.\n + *Amazon Managed Streaming for Apache Kafka* – 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* – The ARN of the broker.\n + *Amazon DocumentDB* – The ARN of the DocumentDB change stream." + }, + "FilterCriteria": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see [Lambda event filtering](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html)." + }, + "FunctionName": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The 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 + *Version or Alias ARN* – ``arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD``.\n + *Partial ARN* – ``123456789012:function:MyFunction``.\n \n The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length." + }, + "FunctionResponseTypes": { + "type": { + "$ref": "#/33" + }, + "flags": 0, + "description": "(Streams and SQS) A list of current response type enums applied to the event source mapping.\n Valid Values: ``ReportBatchItemFailures``" + }, + "Id": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "" + }, + "MaximumBatchingWindowInSeconds": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.\n *Default (, , event sources)*: 0\n *Default (, Kafka, , event sources)*: 500 ms\n *Related setting:* For SQS event sources, when you set ``BatchSize`` to a value greater than 10, you must set ``MaximumBatchingWindowInSeconds`` to at least 1." + }, + "MaximumRecordAgeInSeconds": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "(Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records.\n The 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" + }, + "MaximumRetryAttempts": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "(Kinesis and DynamoDB Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the event source." + }, + "ParallelizationFactor": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "(Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard. The default value is 1." + }, + "Queues": { + "type": { + "$ref": "#/34" + }, + "flags": 0, + "description": "(Amazon MQ) The name of the Amazon MQ broker destination queue to consume." + }, + "ScalingConfig": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "(Amazon SQS only) The scaling configuration for the event source. For more information, see [Configuring maximum concurrency for Amazon SQS event sources](https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-max-concurrency)." + }, + "SelfManagedEventSource": { + "type": { + "$ref": "#/26" + }, + "flags": 0, + "description": "The self-managed Apache Kafka cluster for your event source." + }, + "SelfManagedKafkaEventSourceConfig": { + "type": { + "$ref": "#/27" + }, + "flags": 0, + "description": "Specific configuration settings for a self-managed Apache Kafka event source." + }, + "SourceAccessConfigurations": { + "type": { + "$ref": "#/35" + }, + "flags": 0, + "description": "An array of the authentication protocol, VPC components, or virtual host to secure and define your event source." + }, + "StartingPosition": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The 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." + }, + "StartingPositionTimestamp": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "With ``StartingPosition`` set to ``AT_TIMESTAMP``, the time from which to start reading, in Unix time seconds. ``StartingPositionTimestamp`` cannot be in the future." + }, + "Topics": { + "type": { + "$ref": "#/36" + }, + "flags": 0, + "description": "The name of the Kafka topic." + }, + "TumblingWindowInSeconds": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "(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." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Lambda/EventSourceMapping", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/37" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Lambda/EventSourceMapping@default", + "scopeType": 0, + "body": { + "$ref": "#/38" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Code", + "properties": { + "ImageUri": { + "type": { + "$ref": "#/2" + }, + "flags": 4, + "description": "URI of a [container image](https://docs.aws.amazon.com/lambda/latest/dg/lambda-images.html) in the Amazon ECR registry." + }, + "S3Bucket": { + "type": { + "$ref": "#/2" + }, + "flags": 4, + "description": "An Amazon S3 bucket in the same AWS-Region as your function. The bucket can be in a different AWS-account." + }, + "S3Key": { + "type": { + "$ref": "#/2" + }, + "flags": 4, + "description": "The Amazon S3 key of the deployment package." + }, + "S3ObjectVersion": { + "type": { + "$ref": "#/2" + }, + "flags": 4, + "description": "For versioned objects, the version of the deployment package object to use." + }, + "ZipFile": { + "type": { + "$ref": "#/2" + }, + "flags": 4, + "description": "(Node.js and Python) The source code of your Lambda function. If you include your function source inline with this parameter, CFN places it in a file named ``index`` and zips it to create a [deployment package](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html). This zip file cannot exceed 4MB. For the ``Handler`` property, the first part of the handler identifier must be ``index``. For example, ``index.handler``.\n For JSON, you must escape quotes and special characters such as newline (``\\n``) with a backslash.\n If you specify a function that interacts with an AWS CloudFormation custom resource, you don't have to write your own functions to send responses to the custom resource that invoked the function. AWS CloudFormation provides a response module ([cfn-response](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-lambda-function-code-cfnresponsemodule.html)) that simplifies sending responses. See [Using Lambda with CloudFormation](https://docs.aws.amazon.com/lambda/latest/dg/services-cloudformation.html) for details." + } + } + }, + { + "$type": "ObjectType", + "name": "DeadLetterConfig", + "properties": { + "TargetArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic." + } + } + }, + { + "$type": "ObjectType", + "name": "Environment", + "properties": { + "Variables": { + "type": { + "$ref": "#/53" + }, + "flags": 0, + "description": "Environment variable key-value pairs. For more information, see [Using Lambda environment variables](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html)." + } + } + }, + { + "$type": "ObjectType", + "name": "EphemeralStorage", + "properties": { + "Size": { + "type": { + "$ref": "#/12" + }, + "flags": 1, + "description": "The size of the function's ``/tmp`` directory." + } + } + }, + { + "$type": "ObjectType", + "name": "FileSystemConfig", + "properties": { + "Arn": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of the Amazon EFS access point that provides access to the file system." + }, + "LocalMountPath": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The path where the function can access the file system, starting with ``/mnt/``." + } + } + }, + { + "$type": "ObjectType", + "name": "ImageConfig", + "properties": { + "Command": { + "type": { + "$ref": "#/54" + }, + "flags": 0, + "description": "Specifies parameters that you want to pass in with ENTRYPOINT. You can specify a maximum of 1,500 parameters in the list." + }, + "EntryPoint": { + "type": { + "$ref": "#/55" + }, + "flags": 0, + "description": "Specifies the entry point to their application, which is typically the location of the runtime executable. You can specify a maximum of 1,500 string entries in the list." + }, + "WorkingDirectory": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "Specifies the working directory. The length of the directory string cannot exceed 1,000 characters." + } + } + }, + { + "$type": "ObjectType", + "name": "LoggingConfig", + "properties": { + "ApplicationLogLevel": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "Set this property to filter the application logs for your function that Lambda sends to CloudWatch. Lambda only sends application logs at the selected level of detail and lower, where ``TRACE`` is the highest level and ``FATAL`` is the lowest." + }, + "LogFormat": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The format in which Lambda sends your function's application and system logs to CloudWatch. Select between plain text and structured JSON." + }, + "LogGroup": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The name of the Amazon CloudWatch log group the function sends logs to. By default, Lambda functions send logs to a default log group named ``/aws/lambda/``. To use a different log group, enter an existing log group or enter a new log group name." + }, + "SystemLogLevel": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "Set this property to filter the system logs for your function that Lambda sends to CloudWatch. Lambda only sends system logs at the selected level of detail and lower, where ``DEBUG`` is the highest level and ``WARN`` is the lowest." + } + } + }, + { + "$type": "ObjectType", + "name": "RuntimeManagementConfig", + "properties": { + "RuntimeVersionArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The ARN of the runtime version you want the function to use.\n This is only required if you're using the *Manual* runtime update mode." + }, + "UpdateRuntimeOn": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "Specify 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 choice for most customers to ensure they always benefit from runtime updates.\n + *FunctionUpdate* - LAM updates the runtime of you function to the most recent and secure runtime version when you update your function. This approach synchronizes runtime updates with function deployments, giving you control over when runtime updates are applied and allowing you to detect and 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. 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, see [Roll back a runtime version](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html#runtime-management-rollback).\n \n *Valid Values*: ``Auto`` | ``FunctionUpdate`` | ``Manual``" + } + } + }, + { + "$type": "ObjectType", + "name": "SnapStart", + "properties": { + "ApplyOn": { + "type": { + "$ref": "#/2" + }, + "flags": 5, + "description": "Set ``ApplyOn`` to ``PublishedVersions`` to create a snapshot of the initialized execution environment when you publish a function version." + } + } + }, + { + "$type": "ObjectType", + "name": "SnapStartResponse", + "properties": { + "ApplyOn": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "When set to ``PublishedVersions``, Lambda creates a snapshot of the execution environment when you publish a function version." + }, + "OptimizationStatus": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "When 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." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "" + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "" + } + } + }, + { + "$type": "ObjectType", + "name": "TracingConfig", + "properties": { + "Mode": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The tracing mode." + } + } + }, + { + "$type": "ObjectType", + "name": "VpcConfig", + "properties": { + "Ipv6AllowedForDualStack": { + "type": { + "$ref": "#/32" + }, + "flags": 0, + "description": "Allows outbound IPv6 traffic on VPC functions that are connected to dual-stack subnets." + }, + "SecurityGroupIds": { + "type": { + "$ref": "#/56" + }, + "flags": 0, + "description": "A list of VPC security group IDs." + }, + "SubnetIds": { + "type": { + "$ref": "#/57" + }, + "flags": 0, + "description": "A list of VPC subnet IDs." + } + } + }, + { + "$type": "ObjectType", + "name": "Function_Variables", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Lambda/FunctionProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/44" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/50" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Lambda/FunctionProperties", + "properties": { + "Architectures": { + "type": { + "$ref": "#/59" + }, + "flags": 0, + "description": "The instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64). The default value is ``x86_64``." + }, + "Arn": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "" + }, + "Code": { + "type": { + "$ref": "#/40" + }, + "flags": 5, + "description": "The code for the function." + }, + "CodeSigningConfigArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "To enable code signing for this function, specify the ARN of a code-signing configuration. A code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function." + }, + "DeadLetterConfig": { + "type": { + "$ref": "#/41" + }, + "flags": 0, + "description": "A dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see [Dead-letter queues](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq)." + }, + "Description": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "A description of the function." + }, + "Environment": { + "type": { + "$ref": "#/42" + }, + "flags": 0, + "description": "Environment variables that are accessible from function code during execution." + }, + "EphemeralStorage": { + "type": { + "$ref": "#/43" + }, + "flags": 0, + "description": "The size of the function's ``/tmp`` directory in MB. The default value is 512, but it can be any whole number between 512 and 10,240 MB." + }, + "FileSystemConfigs": { + "type": { + "$ref": "#/60" + }, + "flags": 0, + "description": "Connection settings for an Amazon EFS file system. To connect a function to a file system, a mount target must be available in every Availability Zone that your function connects to. If your template contains an [AWS::EFS::MountTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html) resource, you must also specify a ``DependsOn`` attribute to ensure that the mount target is created or updated before the function.\n For more information about using the ``DependsOn`` attribute, see [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html)." + }, + "FunctionName": { + "type": { + "$ref": "#/2" + }, + "flags": 16, + "description": "The name of the Lambda function, up to 64 characters in length. If you don't specify a name, CFN generates one.\n If 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." + }, + "Handler": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The name of the method within your code that Lambda calls to run your function. Handler is required if the deployment package is a .zip file archive. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see [Lambda programming model](https://docs.aws.amazon.com/lambda/latest/dg/foundation-progmodel.html)." + }, + "ImageConfig": { + "type": { + "$ref": "#/45" + }, + "flags": 0, + "description": "Configuration values that override the container image Dockerfile settings. For more information, see [Container image settings](https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-parms)." + }, + "KmsKeyArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The ARN of the KMSlong (KMS) customer managed key that's used to encrypt your function's [environment variables](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-encryption). When [Lambda SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart-security.html) is activated, Lambda also uses this key is to encrypt your function's snapshot. If you deploy your function using a container image, Lambda also uses this key to encrypt your function when it's deployed. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). If you don't provide a customer managed key, Lambda uses a default service key." + }, + "Layers": { + "type": { + "$ref": "#/61" + }, + "flags": 0, + "description": "A list of [function layers](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) to add to the function's execution environment. Specify each layer by its ARN, including the version." + }, + "LoggingConfig": { + "type": { + "$ref": "#/46" + }, + "flags": 0, + "description": "The function's Amazon CloudWatch Logs configuration settings." + }, + "MemorySize": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "The amount of [memory available to the function](https://docs.aws.amazon.com/lambda/latest/dg/configuration-function-common.html#configuration-memory-console) at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB. Note that new AWS accounts have reduced concurrency and memory quotas. AWS raises these quotas automatically based on your usage. You can also request a quota increase." + }, + "PackageType": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The type of deployment package. Set to ``Image`` for container image and set ``Zip`` for .zip file archive." + }, + "ReservedConcurrentExecutions": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "The number of simultaneous executions to reserve for the function." + }, + "Role": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of the function's execution role." + }, + "Runtime": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The 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 an error if you're deploying a function using a container image.\n The following list includes deprecated runtimes. Lambda blocks creating new functions and updating existing functions shortly after each runtime is deprecated. For more information, see [Runtime use after deprecation](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-deprecation-levels).\n For a list of all currently supported runtimes, see [Supported runtimes](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtimes-supported)." + }, + "RuntimeManagementConfig": { + "type": { + "$ref": "#/47" + }, + "flags": 0, + "description": "Sets the runtime management configuration for a function's version. For more information, see [Runtime updates](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html)." + }, + "SnapStart": { + "type": { + "$ref": "#/48" + }, + "flags": 4, + "description": "The function's [SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) setting." + }, + "SnapStartResponse": { + "type": { + "$ref": "#/49" + }, + "flags": 2, + "description": "" + }, + "Tags": { + "type": { + "$ref": "#/62" + }, + "flags": 0, + "description": "A list of [tags](https://docs.aws.amazon.com/lambda/latest/dg/tagging.html) to apply to the function." + }, + "Timeout": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For more information, see [Lambda execution environment](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-context.html)." + }, + "TracingConfig": { + "type": { + "$ref": "#/51" + }, + "flags": 0, + "description": "Set ``Mode`` to ``Active`` to sample and trace a subset of incoming requests with [X-Ray](https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html)." + }, + "VpcConfig": { + "type": { + "$ref": "#/52" + }, + "flags": 0, + "description": "For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can access resources and the internet only through that VPC. For more information, see [Configuring a Lambda function to access resources in a VPC](https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html)." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Lambda/Function", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/63" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Lambda/Function@default", + "scopeType": 0, + "body": { + "$ref": "#/64" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AllowHeaders", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AllowMethods", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AllowOrigins", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Cors", + "properties": { + "AllowCredentials": { + "type": { + "$ref": "#/32" + }, + "flags": 0, + "description": "Specifies whether credentials are included in the CORS request." + }, + "AllowHeaders": { + "type": { + "$ref": "#/74" + }, + "flags": 0, + "description": "Represents a collection of allowed headers." + }, + "AllowMethods": { + "type": { + "$ref": "#/75" + }, + "flags": 0, + "description": "Represents a collection of allowed HTTP methods." + }, + "AllowOrigins": { + "type": { + "$ref": "#/76" + }, + "flags": 0, + "description": "Represents a collection of allowed origins." + }, + "ExposeHeaders": { + "type": { + "$ref": "#/77" + }, + "flags": 0, + "description": "Represents a collection of exposed headers." + }, + "MaxAge": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ExposeHeaders", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Lambda/UrlProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.Lambda/UrlProperties", + "properties": { + "AuthType": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "Can be either AWS_IAM if the requests are authorized via IAM, or NONE if no authorization is configured on the Function URL." + }, + "Cors": { + "type": { + "$ref": "#/69" + }, + "flags": 0 + }, + "FunctionArn": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "The full Amazon Resource Name (ARN) of the function associated with the Function URL." + }, + "FunctionUrl": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The generated url for this resource." + }, + "InvokeMode": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The invocation mode for the function's URL. Set to BUFFERED if you want to buffer responses before returning them to the client. Set to RESPONSE_STREAM if you want to stream responses, allowing faster time to first byte and larger response payload sizes. If not set, defaults to BUFFERED." + }, + "Qualifier": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The alias qualifier for the target function. If TargetFunctionArn is unqualified then Qualifier must be passed." + }, + "TargetFunctionArn": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of the function associated with the Function URL." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Lambda/Url", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/80" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Lambda/Url@default", + "scopeType": 0, + "body": { + "$ref": "#/81" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.lambda/default/types.md b/artifacts/bicep/aws/aws.lambda/default/types.md index 27df6d66..43d7dce6 100644 --- a/artifacts/bicep/aws/aws.lambda/default/types.md +++ b/artifacts/bicep/aws/aws.lambda/default/types.md @@ -3,44 +3,45 @@ ## Resource AWS.Lambda/CodeSigningConfig@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Lambda/CodeSigningConfigProperties](#awslambdacodesigningconfigproperties) (Required): properties of the resource +* **properties**: [AWS.Lambda/CodeSigningConfigProperties](#awslambdacodesigningconfigproperties) (Required, Identifier): properties of the resource ## Resource AWS.Lambda/EventInvokeConfig@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Lambda/EventInvokeConfigProperties](#awslambdaeventinvokeconfigproperties) (Required): properties of the resource +* **properties**: [AWS.Lambda/EventInvokeConfigProperties](#awslambdaeventinvokeconfigproperties) (Required, Identifier): properties of the resource ## Resource AWS.Lambda/EventSourceMapping@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Lambda/EventSourceMappingProperties](#awslambdaeventsourcemappingproperties) (Required): properties of the resource +* **properties**: [AWS.Lambda/EventSourceMappingProperties](#awslambdaeventsourcemappingproperties) (Required, Identifier): properties of the resource ## Resource AWS.Lambda/Function@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Lambda/FunctionProperties](#awslambdafunctionproperties) (Required): properties of the resource +* **properties**: [AWS.Lambda/FunctionProperties](#awslambdafunctionproperties) (Required, Identifier): properties of the resource ## Resource AWS.Lambda/Url@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Lambda/UrlProperties](#awslambdaurlproperties) (Required): properties of the resource +* **properties**: [AWS.Lambda/UrlProperties](#awslambdaurlproperties) (Required, Identifier): properties of the resource -## Resource AWS.Lambda/Version@default -* **Valid Scope(s)**: Unknown +## AllowedPublishers ### Properties -* **alias**: string (Required): the resource alias -* **name**: string: the resource name -* **properties**: [AWS.Lambda/VersionProperties](#awslambdaversionproperties) (Required): properties of the resource +* **SigningProfileVersionArns**: string[] (Required): List of Signing profile version Arns + +## AmazonManagedKafkaEventSourceConfig +### Properties +* **ConsumerGroupId**: string: The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer 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-msk.html#services-msk-consumer-group-id). ## AWS.Lambda/CodeSigningConfigProperties ### Properties @@ -50,14 +51,6 @@ * **CodeSigningPolicies**: [CodeSigningPolicies](#codesigningpolicies): Policies to control how to act if a signature is invalid * **Description**: string: A description of the CodeSigningConfig -## AllowedPublishers -### Properties -* **SigningProfileVersionArns**: string[] (Required): List of Signing profile version Arns - -## CodeSigningPolicies -### Properties -* **UntrustedArtifactOnDeployment**: string (Required): Indicates how Lambda operations involve updating the code artifact will operate. Default to Warn if not provided - ## AWS.Lambda/EventInvokeConfigProperties ### Properties * **DestinationConfig**: [DestinationConfig](#destinationconfig) @@ -66,228 +59,262 @@ * **MaximumRetryAttempts**: int: The maximum number of times to retry when the function returns an error. * **Qualifier**: string (Required, Identifier): The identifier of a version or alias. -## DestinationConfig -### Properties -* **OnFailure**: [OnFailure](#onfailure) -* **OnSuccess**: [OnSuccess](#onsuccess) - -## OnFailure -### Properties -* **Destination**: string (Required): The Amazon Resource Name (ARN) of the destination resource. - -## OnSuccess -### Properties -* **Destination**: string (Required): The Amazon Resource Name (ARN) of the destination resource. - ## AWS.Lambda/EventSourceMappingProperties ### Properties -* **AmazonManagedKafkaEventSourceConfig**: [AmazonManagedKafkaEventSourceConfig](#amazonmanagedkafkaeventsourceconfig): Specific configuration settings for an MSK event source. -* **BatchSize**: int: The maximum number of items to retrieve in a single batch. -* **BisectBatchOnFunctionError**: bool: (Streams) If the function returns an error, split the batch in two and retry. -* **DestinationConfig**: [DestinationConfig](#destinationconfig): (Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records. -* **DocumentDBEventSourceConfig**: [DocumentDBEventSourceConfig](#documentdbeventsourceconfig): Document db event source config. -* **Enabled**: bool: Disables the event source mapping to pause polling and invocation. +* **AmazonManagedKafkaEventSourceConfig**: [AmazonManagedKafkaEventSourceConfig](#amazonmanagedkafkaeventsourceconfig): Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source. +* **BatchSize**: int: The 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 (6 MB). + + *Amazon Kinesis* – Default 100. Max 10,000. + + *Amazon DynamoDB Streams* – Default 100. Max 10,000. + + *Amazon Simple Queue Service* – Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10. + + *Amazon Managed Streaming for Apache Kafka* – Default 100. Max 10,000. + + *Self-managed Apache Kafka* – Default 100. Max 10,000. + + *Amazon MQ (ActiveMQ and RabbitMQ)* – Default 100. Max 10,000. + + *DocumentDB* – Default 100. Max 10,000. +* **BisectBatchOnFunctionError**: bool: (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry. The default value is false. +* **DestinationConfig**: [DestinationConfig](#destinationconfig): (Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka event sources only) A configuration object that specifies the destination of an event after Lambda processes it. +* **DocumentDBEventSourceConfig**: [DocumentDBEventSourceConfig](#documentdbeventsourceconfig): Specific configuration settings for a DocumentDB event source. +* **Enabled**: bool: When true, the event source mapping is active. When false, Lambda pauses polling and invocation. + Default: True * **EventSourceArn**: string: The Amazon Resource Name (ARN) of the event source. -* **FilterCriteria**: [FilterCriteria](#filtercriteria): The filter criteria to control event filtering. -* **FunctionName**: string (Required): The name of the Lambda function. -* **FunctionResponseTypes**: string[]: (Streams) A list of response types supported by the function. -* **Id**: string (ReadOnly, Identifier): Event Source Mapping Identifier UUID. -* **MaximumBatchingWindowInSeconds**: int: (Streams) The maximum amount of time to gather records before invoking the function, in seconds. -* **MaximumRecordAgeInSeconds**: int: (Streams) The maximum age of a record that Lambda sends to a function for processing. -* **MaximumRetryAttempts**: int: (Streams) The maximum number of times to retry when the function returns an error. -* **ParallelizationFactor**: int: (Streams) The number of batches to process from each shard concurrently. -* **Queues**: string[]: (ActiveMQ) A list of ActiveMQ queues. -* **ScalingConfig**: [ScalingConfig](#scalingconfig): The scaling configuration for the event source. -* **SelfManagedEventSource**: [SelfManagedEventSource](#selfmanagedeventsource): Self-managed event source endpoints. -* **SelfManagedKafkaEventSourceConfig**: [SelfManagedKafkaEventSourceConfig](#selfmanagedkafkaeventsourceconfig): Specific configuration settings for a Self-Managed Apache Kafka event source. -* **SourceAccessConfigurations**: [SourceAccessConfiguration](#sourceaccessconfiguration)[]: A list of SourceAccessConfiguration. -* **StartingPosition**: string: The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Streams sources. -* **StartingPositionTimestamp**: int: With StartingPosition set to AT_TIMESTAMP, the time from which to start reading, in Unix time seconds. -* **Topics**: string[]: (Kafka) A list of Kafka topics. -* **TumblingWindowInSeconds**: int: (Streams) Tumbling window (non-overlapping time window) duration to perform aggregations. + + *Amazon Kinesis* – The ARN of the data stream or a stream consumer. + + *Amazon DynamoDB Streams* – The ARN of the stream. + + *Amazon Simple Queue Service* – The ARN of the queue. + + *Amazon Managed Streaming for Apache Kafka* – 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)). + + *Amazon MQ* – The ARN of the broker. + + *Amazon DocumentDB* – The ARN of the DocumentDB change stream. +* **FilterCriteria**: [FilterCriteria](#filtercriteria): An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see [Lambda event filtering](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html). +* **FunctionName**: string (Required): The name or ARN of the Lambda function. + **Name formats** + + *Function name* – ``MyFunction``. + + *Function ARN* – ``arn:aws:lambda:us-west-2:123456789012:function:MyFunction``. + + *Version or Alias ARN* – ``arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD``. + + *Partial ARN* – ``123456789012:function:MyFunction``. + + The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length. +* **FunctionResponseTypes**: string[]: (Streams and SQS) A list of current response type enums applied to the event source mapping. + Valid Values: ``ReportBatchItemFailures`` +* **Id**: string (ReadOnly, Identifier) +* **MaximumBatchingWindowInSeconds**: int: The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function. + *Default (, , event sources)*: 0 + *Default (, Kafka, , event sources)*: 500 ms + *Related setting:* For SQS event sources, when you set ``BatchSize`` to a value greater than 10, you must set ``MaximumBatchingWindowInSeconds`` to at least 1. +* **MaximumRecordAgeInSeconds**: int: (Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records. + The 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 +* **MaximumRetryAttempts**: int: (Kinesis and DynamoDB Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the event source. +* **ParallelizationFactor**: int: (Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard. The default value is 1. +* **Queues**: string[]: (Amazon MQ) The name of the Amazon MQ broker destination queue to consume. +* **ScalingConfig**: [ScalingConfig](#scalingconfig): (Amazon SQS only) The scaling configuration for the event source. For more information, see [Configuring maximum concurrency for Amazon SQS event sources](https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-max-concurrency). +* **SelfManagedEventSource**: [SelfManagedEventSource](#selfmanagedeventsource): The self-managed Apache Kafka cluster for your event source. +* **SelfManagedKafkaEventSourceConfig**: [SelfManagedKafkaEventSourceConfig](#selfmanagedkafkaeventsourceconfig): Specific configuration settings for a self-managed Apache Kafka event source. +* **SourceAccessConfigurations**: [SourceAccessConfiguration](#sourceaccessconfiguration)[]: An array of the authentication protocol, VPC components, or virtual host to secure and define your event source. +* **StartingPosition**: string: The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB. + + *LATEST* - Read only new records. + + *TRIM_HORIZON* - Process all available records. + + *AT_TIMESTAMP* - Specify a time from which to start reading records. +* **StartingPositionTimestamp**: int: With ``StartingPosition`` set to ``AT_TIMESTAMP``, the time from which to start reading, in Unix time seconds. ``StartingPositionTimestamp`` cannot be in the future. +* **Topics**: string[]: The name of the Kafka topic. +* **TumblingWindowInSeconds**: int: (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. -## AmazonManagedKafkaEventSourceConfig +## AWS.Lambda/FunctionProperties ### Properties -* **ConsumerGroupId**: string: The identifier for the Kafka Consumer Group to join. +* **Architectures**: string[]: The instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64). The default value is ``x86_64``. +* **Arn**: string (ReadOnly) +* **Code**: [Code](#code) (Required, WriteOnly): The code for the function. +* **CodeSigningConfigArn**: string: To enable code signing for this function, specify the ARN of a code-signing configuration. A code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function. +* **DeadLetterConfig**: [DeadLetterConfig](#deadletterconfig): A dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see [Dead-letter queues](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq). +* **Description**: string: A description of the function. +* **Environment**: [Environment](#environment): Environment variables that are accessible from function code during execution. +* **EphemeralStorage**: [EphemeralStorage](#ephemeralstorage): The size of the function's ``/tmp`` directory in MB. The default value is 512, but it can be any whole number between 512 and 10,240 MB. +* **FileSystemConfigs**: [FileSystemConfig](#filesystemconfig)[]: Connection settings for an Amazon EFS file system. To connect a function to a file system, a mount target must be available in every Availability Zone that your function connects to. If your template contains an [AWS::EFS::MountTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html) resource, you must also specify a ``DependsOn`` attribute to ensure that the mount target is created or updated before the function. + For more information about using the ``DependsOn`` attribute, see [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html). +* **FunctionName**: string (Identifier): The name of the Lambda function, up to 64 characters in length. If you don't specify a name, CFN generates one. + If 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. +* **Handler**: string: The name of the method within your code that Lambda calls to run your function. Handler is required if the deployment package is a .zip file archive. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see [Lambda programming model](https://docs.aws.amazon.com/lambda/latest/dg/foundation-progmodel.html). +* **ImageConfig**: [ImageConfig](#imageconfig): Configuration values that override the container image Dockerfile settings. For more information, see [Container image settings](https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-parms). +* **KmsKeyArn**: string: The ARN of the KMSlong (KMS) customer managed key that's used to encrypt your function's [environment variables](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-encryption). When [Lambda SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart-security.html) is activated, Lambda also uses this key is to encrypt your function's snapshot. If you deploy your function using a container image, Lambda also uses this key to encrypt your function when it's deployed. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). If you don't provide a customer managed key, Lambda uses a default service key. +* **Layers**: string[]: A list of [function layers](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) to add to the function's execution environment. Specify each layer by its ARN, including the version. +* **LoggingConfig**: [LoggingConfig](#loggingconfig): The function's Amazon CloudWatch Logs configuration settings. +* **MemorySize**: int: The amount of [memory available to the function](https://docs.aws.amazon.com/lambda/latest/dg/configuration-function-common.html#configuration-memory-console) at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB. Note that new AWS accounts have reduced concurrency and memory quotas. AWS raises these quotas automatically based on your usage. You can also request a quota increase. +* **PackageType**: string: The type of deployment package. Set to ``Image`` for container image and set ``Zip`` for .zip file archive. +* **ReservedConcurrentExecutions**: int: The number of simultaneous executions to reserve for the function. +* **Role**: string (Required): The Amazon Resource Name (ARN) of the function's execution role. +* **Runtime**: string: The 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 an error if you're deploying a function using a container image. + The following list includes deprecated runtimes. Lambda blocks creating new functions and updating existing functions shortly after each runtime is deprecated. For more information, see [Runtime use after deprecation](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-deprecation-levels). + For a list of all currently supported runtimes, see [Supported runtimes](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtimes-supported). +* **RuntimeManagementConfig**: [RuntimeManagementConfig](#runtimemanagementconfig): Sets the runtime management configuration for a function's version. For more information, see [Runtime updates](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html). +* **SnapStart**: [SnapStart](#snapstart) (WriteOnly): The function's [SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) setting. +* **SnapStartResponse**: [SnapStartResponse](#snapstartresponse) (ReadOnly) +* **Tags**: [Tag](#tag)[]: A list of [tags](https://docs.aws.amazon.com/lambda/latest/dg/tagging.html) to apply to the function. +* **Timeout**: int: The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For more information, see [Lambda execution environment](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-context.html). +* **TracingConfig**: [TracingConfig](#tracingconfig): Set ``Mode`` to ``Active`` to sample and trace a subset of incoming requests with [X-Ray](https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html). +* **VpcConfig**: [VpcConfig](#vpcconfig): For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can access resources and the internet only through that VPC. For more information, see [Configuring a Lambda function to access resources in a VPC](https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html). -## DestinationConfig +## AWS.Lambda/UrlProperties ### Properties -* **OnFailure**: [OnFailure](#onfailure): The destination configuration for failed invocations. +* **AuthType**: string (Required): Can be either AWS_IAM if the requests are authorized via IAM, or NONE if no authorization is configured on the Function URL. +* **Cors**: [Cors](#cors) +* **FunctionArn**: string (ReadOnly, Identifier): The full Amazon Resource Name (ARN) of the function associated with the Function URL. +* **FunctionUrl**: string (ReadOnly): The generated url for this resource. +* **InvokeMode**: string: The invocation mode for the function's URL. Set to BUFFERED if you want to buffer responses before returning them to the client. Set to RESPONSE_STREAM if you want to stream responses, allowing faster time to first byte and larger response payload sizes. If not set, defaults to BUFFERED. +* **Qualifier**: string: The alias qualifier for the target function. If TargetFunctionArn is unqualified then Qualifier must be passed. +* **TargetFunctionArn**: string (Required): The Amazon Resource Name (ARN) of the function associated with the Function URL. -## OnFailure +## Code ### Properties -* **Destination**: string: The Amazon Resource Name (ARN) of the destination resource. +* **ImageUri**: string (WriteOnly): URI of a [container image](https://docs.aws.amazon.com/lambda/latest/dg/lambda-images.html) in the Amazon ECR registry. +* **S3Bucket**: string (WriteOnly): An Amazon S3 bucket in the same AWS-Region as your function. The bucket can be in a different AWS-account. +* **S3Key**: string (WriteOnly): The Amazon S3 key of the deployment package. +* **S3ObjectVersion**: string (WriteOnly): For versioned objects, the version of the deployment package object to use. +* **ZipFile**: string (WriteOnly): (Node.js and Python) The source code of your Lambda function. If you include your function source inline with this parameter, CFN places it in a file named ``index`` and zips it to create a [deployment package](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html). This zip file cannot exceed 4MB. For the ``Handler`` property, the first part of the handler identifier must be ``index``. For example, ``index.handler``. + For JSON, you must escape quotes and special characters such as newline (``\n``) with a backslash. + If you specify a function that interacts with an AWS CloudFormation custom resource, you don't have to write your own functions to send responses to the custom resource that invoked the function. AWS CloudFormation provides a response module ([cfn-response](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-lambda-function-code-cfnresponsemodule.html)) that simplifies sending responses. See [Using Lambda with CloudFormation](https://docs.aws.amazon.com/lambda/latest/dg/services-cloudformation.html) for details. -## DocumentDBEventSourceConfig +## CodeSigningPolicies ### Properties -* **CollectionName**: string: The collection name to connect to. -* **DatabaseName**: string: The database name to connect to. -* **FullDocument**: string: Include full document in change stream response. The default option will only send the changes made to documents to Lambda. If you want the complete document sent to Lambda, set this to UpdateLookup. +* **UntrustedArtifactOnDeployment**: string (Required): Indicates how Lambda operations involve updating the code artifact will operate. Default to Warn if not provided -## FilterCriteria +## Cors ### Properties -* **Filters**: [Filter](#filter)[]: List of filters of this FilterCriteria +* **AllowCredentials**: bool: Specifies whether credentials are included in the CORS request. +* **AllowHeaders**: string[]: Represents a collection of allowed headers. +* **AllowMethods**: string[]: Represents a collection of allowed HTTP methods. +* **AllowOrigins**: string[]: Represents a collection of allowed origins. +* **ExposeHeaders**: string[]: Represents a collection of exposed headers. +* **MaxAge**: int -## Filter +## DeadLetterConfig ### Properties -* **Pattern**: string: The filter pattern that defines which events should be passed for invocations. +* **TargetArn**: string: The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic. -## ScalingConfig +## DestinationConfig ### Properties -* **MaximumConcurrency**: int: The maximum number of concurrent functions that the event source can invoke. +* **OnFailure**: [OnFailure](#onfailure) +* **OnSuccess**: [OnSuccess](#onsuccess) -## SelfManagedEventSource +## DestinationConfig ### Properties -* **Endpoints**: [Endpoints](#endpoints): The endpoints for a self-managed event source. +* **OnFailure**: [OnFailure](#onfailure): The destination configuration for failed invocations. -## Endpoints +## DocumentDBEventSourceConfig ### Properties -* **KafkaBootstrapServers**: string[]: A list of Kafka server endpoints. +* **CollectionName**: string: The name of the collection to consume within the database. If you do not specify a collection, Lambda consumes all collections. +* **DatabaseName**: string: The name of the database to consume within the DocumentDB cluster. +* **FullDocument**: string: Determines 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. -## SelfManagedKafkaEventSourceConfig +## Endpoints ### Properties -* **ConsumerGroupId**: string: The identifier for the Kafka Consumer Group to join. +* **KafkaBootstrapServers**: string[]: The list of bootstrap servers for your Kafka brokers in the following format: ``"KafkaBootstrapServers": ["abc.xyz.com:xxxx","abc2.xyz.com:xxxx"]``. -## SourceAccessConfiguration +## Environment ### Properties -* **Type**: string: The type of source access configuration. -* **URI**: string: The URI for the source access configuration resource. +* **Variables**: [Function_Variables](#functionvariables): Environment variable key-value pairs. For more information, see [Using Lambda environment variables](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html). -## AWS.Lambda/FunctionProperties +## EphemeralStorage ### Properties -* **Architectures**: string[] -* **Arn**: string (ReadOnly): Unique identifier for function resources -* **Code**: [Code](#code) (Required, WriteOnly): The code for the function. -* **CodeSigningConfigArn**: string: A unique Arn for CodeSigningConfig resource -* **DeadLetterConfig**: [DeadLetterConfig](#deadletterconfig): A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. -* **Description**: string: A description of the function. -* **Environment**: [Environment](#environment): Environment variables that are accessible from function code during execution. -* **EphemeralStorage**: [EphemeralStorage](#ephemeralstorage): A function's ephemeral storage settings. -* **FileSystemConfigs**: [FileSystemConfig](#filesystemconfig)[]: Connection settings for an Amazon EFS file system. To connect a function to a file system, a mount target must be available in every Availability Zone that your function connects to. If your template contains an AWS::EFS::MountTarget resource, you must also specify a DependsOn attribute to ensure that the mount target is created or updated before the function. -* **FunctionName**: string (Identifier): The name of the Lambda function, up to 64 characters in length. If you don't specify a name, AWS CloudFormation generates one. -* **Handler**: string: The name of the method within your code that Lambda calls to execute your function. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime -* **ImageConfig**: [ImageConfig](#imageconfig): ImageConfig -* **KmsKeyArn**: string: The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment variables. If it's not provided, AWS Lambda uses a default service key. -* **Layers**: string[]: A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version. -* **LoggingConfig**: [LoggingConfig](#loggingconfig): The logging configuration of your function -* **MemorySize**: int: The amount of memory that your function has access to. Increasing the function's memory also increases its CPU allocation. The default value is 128 MB. The value must be a multiple of 64 MB. -* **PackageType**: string: PackageType. -* **ReservedConcurrentExecutions**: int: The number of simultaneous executions to reserve for the function. -* **Role**: string (Required): The Amazon Resource Name (ARN) of the function's execution role. -* **Runtime**: string: The identifier of the function's runtime. -* **RuntimeManagementConfig**: [RuntimeManagementConfig](#runtimemanagementconfig): RuntimeManagementConfig -* **SnapStart**: [SnapStart](#snapstart) (WriteOnly): The SnapStart setting of your function -* **SnapStartResponse**: [SnapStartResponse](#snapstartresponse) (ReadOnly): The SnapStart response of your function -* **Tags**: [Tag](#tag)[]: A list of tags to apply to the function. -* **Timeout**: int: The amount of time that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. -* **TracingConfig**: [TracingConfig](#tracingconfig): Set Mode to Active to sample and trace a subset of incoming requests with AWS X-Ray. -* **VpcConfig**: [VpcConfig](#vpcconfig): For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC. +* **Size**: int (Required): The size of the function's ``/tmp`` directory. -## Code +## FileSystemConfig ### Properties -* **ImageUri**: string (WriteOnly): ImageUri. -* **S3Bucket**: string (WriteOnly): An Amazon S3 bucket in the same AWS Region as your function. The bucket can be in a different AWS account. -* **S3Key**: string (WriteOnly): The Amazon S3 key of the deployment package. -* **S3ObjectVersion**: string (WriteOnly): For versioned objects, the version of the deployment package object to use. -* **ZipFile**: string (WriteOnly): The source code of your Lambda function. If you include your function source inline with this parameter, AWS CloudFormation places it in a file named index and zips it to create a deployment package.. +* **Arn**: string (Required): The Amazon Resource Name (ARN) of the Amazon EFS access point that provides access to the file system. +* **LocalMountPath**: string (Required): The path where the function can access the file system, starting with ``/mnt/``. -## DeadLetterConfig +## Filter ### Properties -* **TargetArn**: string: The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic. +* **Pattern**: string: A filter pattern. For more information on the syntax of a filter pattern, see [Filter rule syntax](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html#filtering-syntax). -## Environment +## FilterCriteria ### Properties -* **Variables**: [Function_Variables](#functionvariables): Environment variable key-value pairs. +* **Filters**: [Filter](#filter)[]: A list of filters. ## Function_Variables ### Properties -## EphemeralStorage +## ImageConfig ### Properties -* **Size**: int (Required): The amount of ephemeral storage that your function has access to. +* **Command**: string[]: Specifies parameters that you want to pass in with ENTRYPOINT. You can specify a maximum of 1,500 parameters in the list. +* **EntryPoint**: string[]: Specifies the entry point to their application, which is typically the location of the runtime executable. You can specify a maximum of 1,500 string entries in the list. +* **WorkingDirectory**: string: Specifies the working directory. The length of the directory string cannot exceed 1,000 characters. -## FileSystemConfig +## LoggingConfig ### Properties -* **Arn**: string (Required): The Amazon Resource Name (ARN) of the Amazon EFS access point that provides access to the file system. -* **LocalMountPath**: string (Required): The path where the function can access the file system, starting with /mnt/. +* **ApplicationLogLevel**: string: Set this property to filter the application logs for your function that Lambda sends to CloudWatch. Lambda only sends application logs at the selected level of detail and lower, where ``TRACE`` is the highest level and ``FATAL`` is the lowest. +* **LogFormat**: string: The format in which Lambda sends your function's application and system logs to CloudWatch. Select between plain text and structured JSON. +* **LogGroup**: string: The name of the Amazon CloudWatch log group the function sends logs to. By default, Lambda functions send logs to a default log group named ``/aws/lambda/``. To use a different log group, enter an existing log group or enter a new log group name. +* **SystemLogLevel**: string: Set this property to filter the system logs for your function that Lambda sends to CloudWatch. Lambda only sends system logs at the selected level of detail and lower, where ``DEBUG`` is the highest level and ``WARN`` is the lowest. -## ImageConfig +## OnFailure ### Properties -* **Command**: string[]: Command. -* **EntryPoint**: string[]: EntryPoint. -* **WorkingDirectory**: string: WorkingDirectory. +* **Destination**: string (Required): The Amazon Resource Name (ARN) of the destination resource. -## LoggingConfig +## OnFailure ### Properties -* **ApplicationLogLevel**: string: Application log granularity level, can only be used when LogFormat is set to JSON -* **LogFormat**: string: Log delivery format for the lambda function -* **LogGroup**: string: The log group name. -* **SystemLogLevel**: string: System log granularity level, can only be used when LogFormat is set to JSON +* **Destination**: string: The Amazon Resource Name (ARN) of the destination resource. + To retain records of [asynchronous invocations](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-async-destinations), you can configure an Amazon SNS topic, Amazon SQS queue, Lambda function, or Amazon EventBridge event bus as the destination. + To retain records of failed invocations from [Kinesis and DynamoDB event sources](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventsourcemapping.html#event-source-mapping-destinations), you can configure an Amazon SNS topic or Amazon SQS queue as the destination. + To retain records of failed invocations from [self-managed Kafka](https://docs.aws.amazon.com/lambda/latest/dg/with-kafka.html#services-smaa-onfailure-destination) or [Amazon MSK](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-onfailure-destination), you can configure an Amazon SNS topic, Amazon SQS queue, or Amazon S3 bucket as the destination. -## RuntimeManagementConfig +## OnSuccess ### Properties -* **RuntimeVersionArn**: string: Unique identifier for a runtime version arn -* **UpdateRuntimeOn**: string (Required): Trigger for runtime update +* **Destination**: string (Required): The Amazon Resource Name (ARN) of the destination resource. -## SnapStart +## RuntimeManagementConfig ### Properties -* **ApplyOn**: string (Required, WriteOnly): Applying SnapStart setting on function resource type. +* **RuntimeVersionArn**: string: The ARN of the runtime version you want the function to use. + This is only required if you're using the *Manual* runtime update mode. +* **UpdateRuntimeOn**: string (Required): Specify the runtime update mode. + + *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 choice for most customers to ensure they always benefit from runtime updates. + + *FunctionUpdate* - LAM updates the runtime of you function to the most recent and secure runtime version when you update your function. This approach synchronizes runtime updates with function deployments, giving you control over when runtime updates are applied and allowing you to detect and mitigate rare runtime update incompatibilities early. When using this setting, you need to regularly update your functions to keep their runtime up-to-date. + + *Manual* - You specify a runtime version in your function configuration. The function will use this runtime version indefinitely. 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, see [Roll back a runtime version](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html#runtime-management-rollback). + + *Valid Values*: ``Auto`` | ``FunctionUpdate`` | ``Manual`` -## SnapStartResponse +## ScalingConfig ### Properties -* **ApplyOn**: string (ReadOnly): Applying SnapStart setting on function resource type. -* **OptimizationStatus**: string (ReadOnly): Indicates whether SnapStart is activated for the specified function version. +* **MaximumConcurrency**: int: Limits the number of concurrent instances that the SQS event source can invoke. -## Tag +## SelfManagedEventSource ### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Endpoints**: [Endpoints](#endpoints): The list of bootstrap servers for your Kafka brokers in the following format: ``"KafkaBootstrapServers": ["abc.xyz.com:xxxx","abc2.xyz.com:xxxx"]``. -## TracingConfig +## SelfManagedKafkaEventSourceConfig ### Properties -* **Mode**: string: The tracing mode. +* **ConsumerGroupId**: string: The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer 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-msk.html#services-msk-consumer-group-id). -## VpcConfig +## SnapStart ### Properties -* **Ipv6AllowedForDualStack**: bool: A boolean indicating whether IPv6 protocols will be allowed for dual stack subnets -* **SecurityGroupIds**: string[]: A list of VPC security groups IDs. -* **SubnetIds**: string[]: A list of VPC subnet IDs. +* **ApplyOn**: string (Required, WriteOnly): Set ``ApplyOn`` to ``PublishedVersions`` to create a snapshot of the initialized execution environment when you publish a function version. -## AWS.Lambda/UrlProperties +## SnapStartResponse ### Properties -* **AuthType**: string (Required): Can be either AWS_IAM if the requests are authorized via IAM, or NONE if no authorization is configured on the Function URL. -* **Cors**: [Cors](#cors) -* **FunctionArn**: string (ReadOnly, Identifier): The full Amazon Resource Name (ARN) of the function associated with the Function URL. -* **FunctionUrl**: string (ReadOnly): The generated url for this resource. -* **InvokeMode**: string: The invocation mode for the function?s URL. Set to BUFFERED if you want to buffer responses before returning them to the client. Set to RESPONSE_STREAM if you want to stream responses, allowing faster time to first byte and larger response payload sizes. If not set, defaults to BUFFERED. -* **Qualifier**: string: The alias qualifier for the target function. If TargetFunctionArn is unqualified then Qualifier must be passed. -* **TargetFunctionArn**: string (Required): The Amazon Resource Name (ARN) of the function associated with the Function URL. +* **ApplyOn**: string (ReadOnly): When set to ``PublishedVersions``, Lambda creates a snapshot of the execution environment when you publish a function version. +* **OptimizationStatus**: string (ReadOnly): When 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. -## Cors +## SourceAccessConfiguration ### Properties -* **AllowCredentials**: bool: Specifies whether credentials are included in the CORS request. -* **AllowHeaders**: string[]: Represents a collection of allowed headers. -* **AllowMethods**: string[]: Represents a collection of allowed HTTP methods. -* **AllowOrigins**: string[]: Represents a collection of allowed origins. -* **ExposeHeaders**: string[]: Represents a collection of exposed headers. -* **MaxAge**: int +* **Type**: string: The type of authentication protocol, VPC components, or virtual host for your event source. For example: ``"Type":"SASL_SCRAM_512_AUTH"``. + + ``BASIC_AUTH`` – (Amazon MQ) The ASMlong secret that stores your broker credentials. + + ``BASIC_AUTH`` – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL/PLAIN authentication of your Apache Kafka brokers. + + ``VPC_SUBNET`` – (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. + + ``VPC_SECURITY_GROUP`` – (Self-managed Apache Kafka) The VPC security group used to manage access to your self-managed Apache Kafka brokers. + + ``SASL_SCRAM_256_AUTH`` – (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. + + ``SASL_SCRAM_512_AUTH`` – (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. + + ``VIRTUAL_HOST`` –- (RabbitMQ) The name of the virtual host in your RabbitMQ broker. Lambda uses this RabbitMQ host as the event source. This property cannot be specified in an UpdateEventSourceMapping API call. + + ``CLIENT_CERTIFICATE_TLS_AUTH`` – (Amazon MSK, self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the certificate chain (X.509 PEM), private key (PKCS#8 PEM), and private key password (optional) used for mutual TLS authentication of your MSK/Apache Kafka brokers. + + ``SERVER_ROOT_CA_CERTIFICATE`` – (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. +* **URI**: string: The value for your chosen configuration in ``Type``. For example: ``"URI": "arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName"``. -## AWS.Lambda/VersionProperties +## Tag ### Properties -* **CodeSha256**: string: Only publish a version if the hash value matches the value that's specified. Use this option to avoid publishing a version if the function code has changed since you last updated it. Updates are not supported for this property. -* **Description**: string: A description for the version to override the description in the function configuration. Updates are not supported for this property. -* **FunctionArn**: string (ReadOnly, Identifier): The ARN of the version. -* **FunctionName**: string (Required): The name of the Lambda function. -* **ProvisionedConcurrencyConfig**: [ProvisionedConcurrencyConfiguration](#provisionedconcurrencyconfiguration): Specifies a provisioned concurrency configuration for a function's version. Updates are not supported for this property. -* **RuntimePolicy**: [RuntimePolicy](#runtimepolicy): Specifies the runtime management configuration of a function. Displays runtimeVersionArn only for Manual. -* **Version**: string (ReadOnly): The version number. +* **Key**: string (Required) +* **Value**: string -## ProvisionedConcurrencyConfiguration +## TracingConfig ### Properties -* **ProvisionedConcurrentExecutions**: int (Required): The amount of provisioned concurrency to allocate for the version. +* **Mode**: string: The tracing mode. -## RuntimePolicy +## VpcConfig ### Properties -* **RuntimeVersionArn**: string: The ARN of the runtime the function is configured to use. If the runtime update mode is manual, the ARN is returned, otherwise null is returned. -* **UpdateRuntimeOn**: string (Required): The runtime update mode. +* **Ipv6AllowedForDualStack**: bool: Allows outbound IPv6 traffic on VPC functions that are connected to dual-stack subnets. +* **SecurityGroupIds**: string[]: A list of VPC security group IDs. +* **SubnetIds**: string[]: A list of VPC subnet IDs. diff --git a/artifacts/bicep/aws/aws.lex/default/types.json b/artifacts/bicep/aws/aws.lex/default/types.json index 7d4e0eca..11168a0b 100644 --- a/artifacts/bicep/aws/aws.lex/default/types.json +++ b/artifacts/bicep/aws/aws.lex/default/types.json @@ -1 +1,3290 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"AdvancedRecognitionSetting","Properties":{"AudioRecognitionStrategy":{"Type":4,"Flags":0}}}},{"2":{"Name":"AllowedInputTypes","Properties":{"AllowAudioInput":{"Type":2,"Flags":1,"Description":"Indicates whether audio input is allowed."},"AllowDTMFInput":{"Type":2,"Flags":1,"Description":"Indicates whether DTMF input is allowed."}}}},{"2":{"Name":"AttachmentTitle"}},{"2":{"Name":"AttachmentUrl"}},{"2":{"Name":"AudioAndDTMFInputSpecification","Properties":{"AudioSpecification":{"Type":17,"Flags":0},"DTMFSpecification":{"Type":40,"Flags":0},"StartTimeoutMs":{"Type":3,"Flags":1,"Description":"Time for which a bot waits before assuming that the customer isn't going to speak or press a key. This timeout is shared between Audio and DTMF inputs."}}}},{"2":{"Name":"AudioLogDestination","Properties":{"S3Bucket":{"Type":92,"Flags":1}}}},{"2":{"Name":"AudioLogSetting","Properties":{"Destination":{"Type":13,"Flags":1},"Enabled":{"Type":2,"Flags":1,"Description":""}}}},{"2":{"Name":"AudioLogSettings"}},{"2":{"Name":"AudioRecognitionStrategy"}},{"2":{"Name":"AudioSpecification","Properties":{"EndTimeoutMs":{"Type":3,"Flags":1,"Description":"Time for which a bot waits after the customer stops speaking to assume the utterance is finished."},"MaxLengthMs":{"Type":3,"Flags":1,"Description":"Time for how long Amazon Lex waits before speech input is truncated and the speech is returned to application."}}}},{"2":{"Name":"BotAliasLocaleSettings","Properties":{"CodeHookSpecification":{"Type":25,"Flags":0},"Enabled":{"Type":2,"Flags":1,"Description":"Whether the Lambda code hook is enabled"}}}},{"2":{"Name":"BotAliasLocaleSettingsItem","Properties":{"BotAliasLocaleSetting":{"Type":18,"Flags":1},"LocaleId":{"Type":4,"Flags":1,"Description":"A string used to identify the locale"}}}},{"2":{"Name":"BotAliasLocaleSettingsList"}},{"2":{"Name":"BotArn"}},{"2":{"Name":"BotLocale","Properties":{"CustomVocabulary":{"Type":37,"Flags":0},"Description":{"Type":4,"Flags":0},"Intents":{"Type":136,"Flags":0,"Description":"List of intents"},"LocaleId":{"Type":4,"Flags":1},"NluConfidenceThreshold":{"Type":3,"Flags":1},"SlotTypes":{"Type":137,"Flags":0,"Description":"List of SlotTypes"},"VoiceSettings":{"Type":132,"Flags":0}}}},{"2":{"Name":"Button","Properties":{"Text":{"Type":4,"Flags":1,"Description":"The text that appears on the button."},"Value":{"Type":4,"Flags":1,"Description":"The value returned to Amazon Lex when the user chooses this button."}}}},{"2":{"Name":"CloudWatchLogGroupLogDestination","Properties":{"CloudWatchLogGroupArn":{"Type":4,"Flags":1,"Description":"A string used to identify the groupArn for the Cloudwatch Log Group"},"LogPrefix":{"Type":4,"Flags":1,"Description":"A string containing the value for the Log Prefix"}}}},{"2":{"Name":"CodeHookSpecification","Properties":{"LambdaCodeHook":{"Type":69,"Flags":1}}}},{"2":{"Name":"Condition","Properties":{"ExpressionString":{"Type":4,"Flags":1,"Description":"The expression string that is evaluated."}}}},{"2":{"Name":"ConditionExpression"}},{"2":{"Name":"Conditional","Properties":{"ConditionalBranches":{"Type":138,"Flags":1},"IsActive":{"Type":2,"Flags":1}}}},{"2":{"Name":"ConditionalBranch","Properties":{"Condition":{"Type":26,"Flags":1,"Description":"Contains the expression to evaluate. If the condition is true, the branch's actions are taken."},"Name":{"Type":4,"Flags":1,"Description":"The name of the branch."},"NextStep":{"Type":48,"Flags":1,"Description":"The next step in the conversation."},"Response":{"Type":90,"Flags":0,"Description":"Specifies a list of message groups that Amazon Lex uses to respond the user input."}}}},{"2":{"Name":"ConditionalBranches"}},{"2":{"Name":"ConditionalSpecification","Properties":{"ConditionalBranches":{"Type":140,"Flags":1,"Description":"A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true."},"DefaultBranch":{"Type":42,"Flags":1,"Description":"The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step."},"IsActive":{"Type":2,"Flags":1,"Description":"Determines whether a conditional branch is active. When active is false, the conditions are not evaluated."}}}},{"2":{"Name":"ConfidenceThreshold"}},{"2":{"Name":"ContextTimeToLiveInSeconds"}},{"2":{"Name":"ContextTurnsToLive"}},{"2":{"Name":"ConversationLogSettings","Properties":{"AudioLogSettings":{"Type":141,"Flags":0},"TextLogSettings":{"Type":142,"Flags":0}}}},{"2":{"Name":"CustomPayload","Properties":{"Value":{"Type":4,"Flags":1,"Description":"The string that is sent to your application."}}}},{"2":{"Name":"CustomVocabulary","Properties":{"CustomVocabularyItems":{"Type":143,"Flags":1}}}},{"2":{"Name":"CustomVocabularyItem","Properties":{"DisplayAs":{"Type":4,"Flags":0,"Description":"Defines how you want your phrase to look in your transcription output."},"Phrase":{"Type":4,"Flags":1,"Description":"Phrase that should be recognized."},"Weight":{"Type":3,"Flags":0,"Description":"The degree to which the phrase recognition is boosted. The weight 0 means that no boosting will be applied and the entry will only be used for performing replacements using the displayAs field."}}}},{"2":{"Name":"CustomVocabularyItems"}},{"2":{"Name":"DTMFSpecification","Properties":{"DeletionCharacter":{"Type":4,"Flags":1,"Description":"The DTMF character that clears the accumulated DTMF digits and immediately ends the input."},"EndCharacter":{"Type":4,"Flags":1,"Description":"The DTMF character that immediately ends input. If the user does not press this character, the input ends after the end timeout."},"EndTimeoutMs":{"Type":3,"Flags":1,"Description":"How long the bot should wait after the last DTMF character input before assuming that the input has concluded."},"MaxLength":{"Type":3,"Flags":1,"Description":"The maximum number of DTMF digits allowed in an utterance."}}}},{"2":{"Name":"DataPrivacy","Properties":{"ChildDirected":{"Type":2,"Flags":1,"Description":"Specify whether your use of Amazon Lex is related to application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA)."}}}},{"2":{"Name":"DefaultConditionalBranch","Properties":{"NextStep":{"Type":48,"Flags":0,"Description":"The next step in the conversation."},"Response":{"Type":90,"Flags":0,"Description":"Specifies a list of message groups that Amazon Lex uses to respond the user input."}}}},{"2":{"Name":"Description"}},{"2":{"Name":"DialogAction","Properties":{"SlotToElicit":{"Type":4,"Flags":0,"Description":"If the dialog action is ElicitSlot, defines the slot to elicit from the user."},"SuppressNextMessage":{"Type":2,"Flags":0,"Description":"When true the next message for the intent is not used."},"Type":{"Type":4,"Flags":1,"Description":"The action that the bot should execute."}}}},{"2":{"Name":"DialogActionType"}},{"2":{"Name":"DialogCodeHookInvocationSetting","Properties":{"EnableCodeHookInvocation":{"Type":2,"Flags":1,"Description":"Indicates whether a Lambda function should be invoked for the dialog."},"InvocationLabel":{"Type":4,"Flags":0,"Description":"A label that indicates the dialog step from which the dialog code hook is happening."},"IsActive":{"Type":2,"Flags":1,"Description":"Determines whether a dialog code hook is used when the intent is activated."},"PostCodeHookSpecification":{"Type":83,"Flags":1,"Description":"Contains the responses and actions that Amazon Lex takes after the Lambda function is complete."}}}},{"2":{"Name":"DialogCodeHookSetting","Properties":{"Enabled":{"Type":2,"Flags":1}}}},{"2":{"Name":"DialogState","Properties":{"DialogAction":{"Type":44,"Flags":0,"Description":"Defines the action that the bot executes at runtime when the conversation reaches this step."},"Intent":{"Type":66,"Flags":0,"Description":"Override settings to configure the intent state."},"SessionAttributes":{"Type":145,"Flags":0,"Description":"List of session attributes to be applied when the conversation reaches this step."}}}},{"2":{"Name":"ElicitationCodeHookInvocationSetting","Properties":{"EnableCodeHookInvocation":{"Type":2,"Flags":1,"Description":"Indicates whether a Lambda function should be invoked for the dialog."},"InvocationLabel":{"Type":4,"Flags":0,"Description":"A label that indicates the dialog step from which the dialog code hook is happening."}}}},{"2":{"Name":"ExternalSourceSetting","Properties":{"GrammarSlotTypeSetting":{"Type":55,"Flags":0}}}},{"2":{"Name":"FulfillmentCodeHookSetting","Properties":{"Enabled":{"Type":2,"Flags":1},"FulfillmentUpdatesSpecification":{"Type":54,"Flags":0},"IsActive":{"Type":2,"Flags":0,"Description":"Determines whether the fulfillment code hook is used. When active is false, the code hook doesn't run."},"PostFulfillmentStatusSpecification":{"Type":84,"Flags":0}}}},{"2":{"Name":"FulfillmentStartResponseSpecification","Properties":{"AllowInterrupt":{"Type":2,"Flags":0,"Description":"Determines whether the user can interrupt the start message while it is playing."},"DelayInSeconds":{"Type":3,"Flags":1,"Description":"The delay between when the Lambda fulfillment function starts running and the start message is played. If the Lambda function returns before the delay is over, the start message isn't played."},"MessageGroups":{"Type":146,"Flags":1}}}},{"2":{"Name":"FulfillmentUpdateResponseSpecification","Properties":{"AllowInterrupt":{"Type":2,"Flags":0,"Description":"Determines whether the user can interrupt an update message while it is playing."},"FrequencyInSeconds":{"Type":3,"Flags":1,"Description":"The frequency that a message is sent to the user. When the period ends, Amazon Lex chooses a message from the message groups and plays it to the user. If the fulfillment Lambda returns before the first period ends, an update message is not played to the user."},"MessageGroups":{"Type":147,"Flags":1}}}},{"2":{"Name":"FulfillmentUpdatesSpecification","Properties":{"Active":{"Type":2,"Flags":1,"Description":"Determines whether fulfillment updates are sent to the user. When this field is true, updates are sent."},"StartResponse":{"Type":52,"Flags":0},"TimeoutInSeconds":{"Type":3,"Flags":0,"Description":"The length of time that the fulfillment Lambda function should run before it times out."},"UpdateResponse":{"Type":53,"Flags":0}}}},{"2":{"Name":"GrammarSlotTypeSetting","Properties":{"Source":{"Type":56,"Flags":0}}}},{"2":{"Name":"GrammarSlotTypeSource","Properties":{"KmsKeyArn":{"Type":4,"Flags":0,"Description":"The Amazon KMS key required to decrypt the contents of the grammar, if any."},"S3BucketName":{"Type":4,"Flags":1,"Description":"The name of the S3 bucket that contains the grammar source."},"S3ObjectKey":{"Type":4,"Flags":1,"Description":"The path to the grammar in the S3 bucket."}}}},{"2":{"Name":"Id"}},{"2":{"Name":"IdleSessionTTLInSeconds"}},{"2":{"Name":"ImageResponseCard","Properties":{"Buttons":{"Type":148,"Flags":0,"Description":"A list of buttons that should be displayed on the response card."},"ImageUrl":{"Type":4,"Flags":0,"Description":"The URL of an image to display on the response card."},"Subtitle":{"Type":4,"Flags":0,"Description":"The subtitle to display on the response card."},"Title":{"Type":4,"Flags":1,"Description":"The title to display on the response card."}}}},{"2":{"Name":"InitialResponseSetting","Properties":{"CodeHook":{"Type":46,"Flags":0,"Description":"Settings that specify the dialog code hook that is called by Amazon Lex at a step of the conversation."},"Conditional":{"Type":31,"Flags":0,"Description":"Provides a list of conditional branches. Branches are evaluated in the order that they are entered in the list. The first branch with a condition that evaluates to true is executed. The last branch in the list is the default branch. The default branch should not have any condition expression. The default branch is executed if no other branch has a matching condition."},"InitialResponse":{"Type":90,"Flags":0,"Description":"Specifies a list of message groups that Amazon Lex uses to respond the user input."},"NextStep":{"Type":48,"Flags":0,"Description":"The next step in the conversation."}}}},{"2":{"Name":"InputContext","Properties":{"Name":{"Type":4,"Flags":1,"Description":"The name of the context."}}}},{"2":{"Name":"InputContextsList"}},{"2":{"Name":"Intent","Properties":{"Description":{"Type":4,"Flags":0,"Description":"Description of thr intent."},"DialogCodeHook":{"Type":47,"Flags":0},"FulfillmentCodeHook":{"Type":51,"Flags":0},"InitialResponseSetting":{"Type":60,"Flags":0,"Description":"Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots."},"InputContexts":{"Type":150,"Flags":0},"IntentClosingSetting":{"Type":64,"Flags":0},"IntentConfirmationSetting":{"Type":65,"Flags":0},"KendraConfiguration":{"Type":67,"Flags":0},"Name":{"Type":4,"Flags":1,"Description":"The name of the intent."},"OutputContexts":{"Type":151,"Flags":0},"ParentIntentSignature":{"Type":4,"Flags":0},"SampleUtterances":{"Type":152,"Flags":0,"Description":"A sample utterance that invokes an intent or respond to a slot elicitation prompt."},"SlotPriorities":{"Type":153,"Flags":0},"Slots":{"Type":154,"Flags":0,"Description":"List of slots"}}}},{"2":{"Name":"IntentClosingSetting","Properties":{"ClosingResponse":{"Type":90,"Flags":0,"Description":"The response that Amazon Lex sends to the user when the intent is complete."},"Conditional":{"Type":31,"Flags":0,"Description":"A list of conditional branches associated with the intent's closing response. These branches are executed when the nextStep attribute is set to EvalutateConditional."},"IsActive":{"Type":2,"Flags":0,"Description":"Specifies whether an intent's closing response is used. When this field is false, the closing response isn't sent to the user. If the active field isn't specified, the default is true."},"NextStep":{"Type":48,"Flags":0,"Description":"Specifies the next step that the bot executes after playing the intent's closing response."}}}},{"2":{"Name":"IntentConfirmationSetting","Properties":{"CodeHook":{"Type":46,"Flags":0,"Description":"The DialogCodeHookInvocationSetting object associated with intent's confirmation step. The dialog code hook is triggered based on these invocation settings when the confirmation next step or declination next step or failure next step is InvokeDialogCodeHook."},"ConfirmationConditional":{"Type":31,"Flags":0,"Description":"A list of conditional branches to evaluate after the intent is closed."},"ConfirmationNextStep":{"Type":48,"Flags":0,"Description":"Specifies the next step that the bot executes when the customer confirms the intent."},"ConfirmationResponse":{"Type":90,"Flags":0,"Description":"Specifies a list of message groups that Amazon Lex uses to respond the user input."},"DeclinationConditional":{"Type":31,"Flags":0,"Description":"A list of conditional branches to evaluate after the intent is declined."},"DeclinationNextStep":{"Type":48,"Flags":0,"Description":"Specifies the next step that the bot executes when the customer declines the intent."},"DeclinationResponse":{"Type":90,"Flags":0,"Description":"When the user answers \"no\" to the question defined in promptSpecification, Amazon Lex responds with this response to acknowledge that the intent was canceled."},"ElicitationCodeHook":{"Type":49,"Flags":0,"Description":"The DialogCodeHookInvocationSetting used when the code hook is invoked during confirmation prompt retries."},"FailureConditional":{"Type":31,"Flags":0,"Description":"Provides a list of conditional branches. Branches are evaluated in the order that they are entered in the list. The first branch with a condition that evaluates to true is executed. The last branch in the list is the default branch. The default branch should not have any condition expression. The default branch is executed if no other branch has a matching condition."},"FailureNextStep":{"Type":48,"Flags":0,"Description":"The next step to take in the conversation if the confirmation step fails."},"FailureResponse":{"Type":90,"Flags":0,"Description":"Specifies a list of message groups that Amazon Lex uses to respond the user input."},"IsActive":{"Type":2,"Flags":0,"Description":"Specifies whether the intent's confirmation is sent to the user. When this field is false, confirmation and declination responses aren't sent. If the active field isn't specified, the default is true."},"PromptSpecification":{"Type":88,"Flags":1,"Description":"Prompts the user to confirm the intent. This question should have a yes or no answer."}}}},{"2":{"Name":"IntentOverride","Properties":{"Name":{"Type":4,"Flags":0,"Description":"The name of the intent. Only required when you're switching intents."},"Slots":{"Type":155,"Flags":0,"Description":"A map of all of the slot value overrides for the intent."}}}},{"2":{"Name":"KendraConfiguration","Properties":{"KendraIndex":{"Type":4,"Flags":1},"QueryFilterString":{"Type":4,"Flags":0},"QueryFilterStringEnabled":{"Type":2,"Flags":0,"Description":"Determines whether the AMAZON.KendraSearchIntent intent uses a custom query string to query the Amazon Kendra index."}}}},{"2":{"Name":"KendraIndexArn"}},{"2":{"Name":"LambdaCodeHook","Properties":{"CodeHookInterfaceVersion":{"Type":4,"Flags":1,"Description":"The version of the request-response that you want Amazon Lex to use to invoke your Lambda function."},"LambdaArn":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) of the Lambda function."}}}},{"2":{"Name":"LocaleId"}},{"2":{"Name":"Message","Properties":{"CustomPayload":{"Type":36,"Flags":0},"ImageResponseCard":{"Type":59,"Flags":0},"PlainTextMessage":{"Type":82,"Flags":0},"SSMLMessage":{"Type":96,"Flags":0}}}},{"2":{"Name":"MessageGroup","Properties":{"Message":{"Type":71,"Flags":1},"Variations":{"Type":156,"Flags":0,"Description":"Message variations to send to the user."}}}},{"2":{"Name":"MessageGroupsList"}},{"2":{"Name":"MessageSelectionStrategy"}},{"2":{"Name":"MultipleValuesSetting","Properties":{"AllowMultipleValues":{"Type":2,"Flags":0}}}},{"2":{"Name":"Name"}},{"2":{"Name":"ObfuscationSetting","Properties":{"ObfuscationSettingType":{"Type":4,"Flags":1,"Description":"Value that determines whether Amazon Lex obscures slot values in conversation logs. The default is to obscure the values."}}}},{"2":{"Name":"OutputContext","Properties":{"Name":{"Type":4,"Flags":1},"TimeToLiveInSeconds":{"Type":3,"Flags":1},"TurnsToLive":{"Type":3,"Flags":1}}}},{"2":{"Name":"OutputContextsList"}},{"2":{"Name":"ParentIntentSignature"}},{"2":{"Name":"ParentSlotTypeSignature"}},{"2":{"Name":"PlainTextMessage","Properties":{"Value":{"Type":4,"Flags":1,"Description":"The message to send to the user."}}}},{"2":{"Name":"PostDialogCodeHookInvocationSpecification","Properties":{"FailureConditional":{"Type":31,"Flags":0,"Description":"A list of conditional branches to evaluate after the dialog code hook throws an exception or returns with the State field of the Intent object set to Failed."},"FailureNextStep":{"Type":48,"Flags":0,"Description":"Specifies the next step the bot runs after the dialog code hook throws an exception or returns with the State field of the Intent object set to Failed."},"FailureResponse":{"Type":90,"Flags":0,"Description":"Specifies a list of message groups that Amazon Lex uses to respond the user input."},"SuccessConditional":{"Type":31,"Flags":0,"Description":"A list of conditional branches to evaluate after the dialog code hook finishes successfully."},"SuccessNextStep":{"Type":48,"Flags":0,"Description":"Specifics the next step the bot runs after the dialog code hook finishes successfully."},"SuccessResponse":{"Type":90,"Flags":0,"Description":"Specifies a list of message groups that Amazon Lex uses to respond the user input."},"TimeoutConditional":{"Type":31,"Flags":0,"Description":"A list of conditional branches to evaluate if the code hook times out."},"TimeoutNextStep":{"Type":48,"Flags":0,"Description":"Specifies the next step that the bot runs when the code hook times out."},"TimeoutResponse":{"Type":90,"Flags":0,"Description":"Specifies a list of message groups that Amazon Lex uses to respond the user input."}}}},{"2":{"Name":"PostFulfillmentStatusSpecification","Properties":{"FailureConditional":{"Type":31,"Flags":0,"Description":"A list of conditional branches to evaluate after the fulfillment code hook throws an exception or returns with the State field of the Intent object set to Failed."},"FailureNextStep":{"Type":48,"Flags":0,"Description":"Specifies the next step the bot runs after the fulfillment code hook throws an exception or returns with the State field of the Intent object set to Failed."},"FailureResponse":{"Type":90,"Flags":0,"Description":"Specifies a list of message groups that Amazon Lex uses to respond the user input."},"SuccessConditional":{"Type":31,"Flags":0,"Description":"A list of conditional branches to evaluate after the fulfillment code hook finishes successfully."},"SuccessNextStep":{"Type":48,"Flags":0,"Description":"Specifies the next step in the conversation that Amazon Lex invokes when the fulfillment code hook completes successfully."},"SuccessResponse":{"Type":90,"Flags":0,"Description":"Specifies a list of message groups that Amazon Lex uses to respond the user input."},"TimeoutConditional":{"Type":31,"Flags":0,"Description":"A list of conditional branches to evaluate if the fulfillment code hook times out."},"TimeoutNextStep":{"Type":48,"Flags":0,"Description":"Specifies the next step that the bot runs when the fulfillment code hook times out."},"TimeoutResponse":{"Type":90,"Flags":0,"Description":"Specifies a list of message groups that Amazon Lex uses to respond the user input."}}}},{"2":{"Name":"PriorityValue"}},{"2":{"Name":"PromptAttemptSpecification","Properties":{"AllowInterrupt":{"Type":2,"Flags":0,"Description":"Indicates whether the user can interrupt a speech prompt attempt from the bot."},"AllowedInputTypes":{"Type":9,"Flags":1},"AudioAndDTMFInputSpecification":{"Type":12,"Flags":0},"TextInputSpecification":{"Type":127,"Flags":0}}}},{"2":{"Name":"PromptMaxRetries"}},{"2":{"Name":"PromptSpecification","Properties":{"AllowInterrupt":{"Type":2,"Flags":0,"Description":"Indicates whether the user can interrupt a speech prompt from the bot."},"MaxRetries":{"Type":3,"Flags":1},"MessageGroupsList":{"Type":159,"Flags":1},"MessageSelectionStrategy":{"Type":4,"Flags":0},"PromptAttemptsSpecification":{"Type":160,"Flags":0,"Description":"Specifies the advanced settings on each attempt of the prompt."}}}},{"2":{"Name":"QueryFilterString"}},{"2":{"Name":"ResponseSpecification","Properties":{"AllowInterrupt":{"Type":2,"Flags":0,"Description":"Indicates whether the user can interrupt a speech prompt from the bot."},"MessageGroupsList":{"Type":161,"Flags":1}}}},{"2":{"Name":"RoleArn"}},{"2":{"Name":"S3BucketLogDestination","Properties":{"KmsKeyArn":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key for encrypting audio log files stored in an S3 bucket."},"LogPrefix":{"Type":4,"Flags":1,"Description":"The Amazon S3 key of the deployment package."},"S3BucketArn":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored."}}}},{"2":{"Name":"S3BucketName"}},{"2":{"Name":"S3Location","Properties":{"S3Bucket":{"Type":4,"Flags":1,"Description":"An Amazon S3 bucket in the same AWS Region as your function. The bucket can be in a different AWS account."},"S3ObjectKey":{"Type":4,"Flags":1,"Description":"The Amazon S3 key of the deployment package."},"S3ObjectVersion":{"Type":4,"Flags":0,"Description":"For versioned objects, the version of the deployment package object to use. If not specified, the current object version will be used."}}}},{"2":{"Name":"S3ObjectKey"}},{"2":{"Name":"SSMLMessage","Properties":{"Value":{"Type":4,"Flags":1,"Description":"The SSML text that defines the prompt."}}}},{"2":{"Name":"SampleUtterance","Properties":{"Utterance":{"Type":4,"Flags":1}}}},{"2":{"Name":"SampleUtterancesList"}},{"2":{"Name":"SampleValue","Properties":{"Value":{"Type":4,"Flags":1,"Description":"The value that can be used for a slot type."}}}},{"2":{"Name":"SessionAttribute","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"Slot","Properties":{"Description":{"Type":4,"Flags":0},"MultipleValuesSetting":{"Type":75,"Flags":0},"Name":{"Type":4,"Flags":1},"ObfuscationSetting":{"Type":77,"Flags":0},"SlotTypeName":{"Type":4,"Flags":1},"ValueElicitationSetting":{"Type":114,"Flags":1}}}},{"2":{"Name":"SlotCaptureSetting","Properties":{"CaptureConditional":{"Type":31,"Flags":0,"Description":"A list of conditional branches to evaluate after the slot value is captured."},"CaptureNextStep":{"Type":48,"Flags":0,"Description":"Specifies the next step that the bot runs when the slot value is captured before the code hook times out."},"CaptureResponse":{"Type":90,"Flags":0,"Description":"Specifies a list of message groups that Amazon Lex uses to respond the user input."},"CodeHook":{"Type":46,"Flags":0,"Description":"Code hook called after Amazon Lex successfully captures a slot value."},"ElicitationCodeHook":{"Type":49,"Flags":0,"Description":"Code hook called when Amazon Lex doesn't capture a slot value."},"FailureConditional":{"Type":31,"Flags":0,"Description":"A list of conditional branches to evaluate when the slot value isn't captured."},"FailureNextStep":{"Type":48,"Flags":0,"Description":"Specifies the next step that the bot runs when the slot value code is not recognized."},"FailureResponse":{"Type":90,"Flags":0,"Description":"Specifies a list of message groups that Amazon Lex uses to respond the user input."}}}},{"2":{"Name":"SlotConstraint"}},{"2":{"Name":"SlotDefaultValue","Properties":{"DefaultValue":{"Type":4,"Flags":1,"Description":"The default value to use when a user doesn't provide a value for a slot."}}}},{"2":{"Name":"SlotDefaultValueSpecification","Properties":{"DefaultValueList":{"Type":163,"Flags":1,"Description":"A list of slot default values"}}}},{"2":{"Name":"SlotPrioritiesList"}},{"2":{"Name":"SlotPriority","Properties":{"Priority":{"Type":3,"Flags":1},"SlotName":{"Type":4,"Flags":1,"Description":"The name of the slot."}}}},{"2":{"Name":"SlotShape"}},{"2":{"Name":"SlotType","Properties":{"Description":{"Type":4,"Flags":0},"ExternalSourceSetting":{"Type":50,"Flags":0},"Name":{"Type":4,"Flags":1},"ParentSlotTypeSignature":{"Type":4,"Flags":0},"SlotTypeValues":{"Type":165,"Flags":0},"ValueSelectionSetting":{"Type":119,"Flags":0}}}},{"2":{"Name":"SlotTypeName"}},{"2":{"Name":"SlotTypeValue","Properties":{"SampleValue":{"Type":99,"Flags":1},"Synonyms":{"Type":166,"Flags":0}}}},{"2":{"Name":"SlotTypeValues"}},{"2":{"Name":"SlotValue","Properties":{"InterpretedValue":{"Type":4,"Flags":0,"Description":"The value that Amazon Lex determines for the slot."}}}},{"2":{"Name":"SlotValueElicitationSetting","Properties":{"DefaultValueSpecification":{"Type":105,"Flags":0,"Description":"A list of default values for a slot."},"PromptSpecification":{"Type":88,"Flags":0,"Description":"The prompt that Amazon Lex uses to elicit the slot value from the user."},"SampleUtterances":{"Type":168,"Flags":0,"Description":"If you know a specific pattern that users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy."},"SlotCaptureSetting":{"Type":102,"Flags":0,"Description":"Specifies the next stage in the conversation after capturing the slot."},"SlotConstraint":{"Type":4,"Flags":1,"Description":"Specifies whether the slot is required or optional."},"WaitAndContinueSpecification":{"Type":133,"Flags":0,"Description":"Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input."}}}},{"2":{"Name":"SlotValueOverride","Properties":{"Shape":{"Type":4,"Flags":0,"Description":"When the shape value is List, it indicates that the values field contains a list of slot values. When the value is Scalar, it indicates that the value field contains a single value."},"Value":{"Type":113,"Flags":0,"Description":"The current value of the slot."},"Values":{"Type":169,"Flags":0,"Description":"A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be \"pepperoni\" and \"pineapple.\""}}}},{"2":{"Name":"SlotValueOverrideMap","Properties":{"SlotName":{"Type":4,"Flags":0},"SlotValueOverride":{"Type":115,"Flags":0}}}},{"2":{"Name":"SlotValueRegexFilter","Properties":{"Pattern":{"Type":4,"Flags":1,"Description":"Regex pattern"}}}},{"2":{"Name":"SlotValueResolutionStrategy"}},{"2":{"Name":"SlotValueSelectionSetting","Properties":{"AdvancedRecognitionSetting":{"Type":8,"Flags":0},"RegexFilter":{"Type":117,"Flags":0},"ResolutionStrategy":{"Type":4,"Flags":1}}}},{"2":{"Name":"SlotValues"}},{"2":{"Name":"StillWaitingResponseFrequency"}},{"2":{"Name":"StillWaitingResponseSpecification","Properties":{"AllowInterrupt":{"Type":2,"Flags":0,"Description":"Indicates whether the user can interrupt a speech prompt from the bot."},"FrequencyInSeconds":{"Type":3,"Flags":1},"MessageGroupsList":{"Type":171,"Flags":1},"TimeoutInSeconds":{"Type":3,"Flags":1}}}},{"2":{"Name":"StillWaitingResponseTimeout"}},{"2":{"Name":"SynonymList"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"TestBotAliasSettings","Properties":{"BotAliasLocaleSettings":{"Type":173,"Flags":0},"ConversationLogSettings":{"Type":35,"Flags":0},"Description":{"Type":4,"Flags":0},"SentimentAnalysisSettings":{"Type":174,"Flags":0,"Description":"Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances."}}}},{"2":{"Name":"TextInputSpecification","Properties":{"StartTimeoutMs":{"Type":3,"Flags":1,"Description":"Time for which a bot waits before re-prompting a customer for text input."}}}},{"2":{"Name":"TextLogDestination","Properties":{"CloudWatch":{"Type":24,"Flags":1}}}},{"2":{"Name":"TextLogSetting","Properties":{"Destination":{"Type":128,"Flags":1},"Enabled":{"Type":2,"Flags":1,"Description":""}}}},{"2":{"Name":"TextLogSettings"}},{"2":{"Name":"Utterance"}},{"2":{"Name":"VoiceSettings","Properties":{"Engine":{"Type":4,"Flags":0,"Description":"Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user. For more information, see the engine parameter of the SynthesizeSpeech operation in the Amazon Polly developer guide."},"VoiceId":{"Type":4,"Flags":1,"Description":"The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user."}}}},{"2":{"Name":"WaitAndContinueSpecification","Properties":{"ContinueResponse":{"Type":90,"Flags":1,"Description":"The response that Amazon Lex sends to indicate that the bot is ready to continue the conversation."},"IsActive":{"Type":2,"Flags":0,"Description":"Specifies whether the bot will wait for a user to respond."},"StillWaitingResponse":{"Type":122,"Flags":0,"Description":"The response that Amazon Lex sends periodically to the user to indicate that the bot is still waiting for input from the user."},"WaitingResponse":{"Type":90,"Flags":1,"Description":"The response that Amazon Lex sends to indicate that the bot is waiting for the conversation to continue."}}}},{"3":{"ItemType":14}},{"3":{"ItemType":19}},{"3":{"ItemType":63}},{"3":{"ItemType":109}},{"3":{"ItemType":29}},{"3":{"ItemType":29}},{"3":{"ItemType":29}},{"3":{"ItemType":14}},{"3":{"ItemType":129}},{"3":{"ItemType":38}},{"3":{"ItemType":38}},{"3":{"ItemType":100}},{"3":{"ItemType":72}},{"3":{"ItemType":72}},{"3":{"ItemType":23}},{"3":{"ItemType":61}},{"3":{"ItemType":61}},{"3":{"ItemType":78}},{"3":{"ItemType":97}},{"3":{"ItemType":107}},{"3":{"ItemType":101}},{"3":{"ItemType":116}},{"3":{"ItemType":71}},{"3":{"ItemType":72}},{"3":{"ItemType":78}},{"3":{"ItemType":72}},{"2":{"Name":"Bot_PromptAttemptsSpecification","Properties":{}}},{"3":{"ItemType":72}},{"3":{"ItemType":97}},{"3":{"ItemType":104}},{"3":{"ItemType":107}},{"3":{"ItemType":111}},{"3":{"ItemType":99}},{"3":{"ItemType":111}},{"3":{"ItemType":97}},{"3":{"ItemType":115}},{"3":{"ItemType":115}},{"3":{"ItemType":72}},{"3":{"ItemType":99}},{"3":{"ItemType":19}},{"2":{"Name":"Bot_SentimentAnalysisSettings","Properties":{"DetectSentiment":{"Type":2,"Flags":1,"Description":"Enable to call Amazon Comprehend for Sentiment natively within Lex"}}}},{"3":{"ItemType":129}},{"2":{"Name":"AWS.Lex/BotProperties","Properties":{"Arn":{"Type":4,"Flags":2},"AutoBuildBotLocales":{"Type":2,"Flags":4,"Description":"Specifies whether to build the bot locales after bot creation completes."},"BotFileS3Location":{"Type":94,"Flags":4},"BotLocales":{"Type":177,"Flags":4,"Description":"List of bot locales"},"BotTags":{"Type":178,"Flags":4,"Description":"A list of tags to add to the bot, which can only be added at bot creation."},"DataPrivacy":{"Type":179,"Flags":1,"Description":"Data privacy setting of the Bot."},"Description":{"Type":4,"Flags":0},"Id":{"Type":4,"Flags":18},"IdleSessionTTLInSeconds":{"Type":3,"Flags":1,"Description":"IdleSessionTTLInSeconds of the resource"},"Name":{"Type":4,"Flags":1},"RoleArn":{"Type":4,"Flags":1},"TestBotAliasSettings":{"Type":126,"Flags":0},"TestBotAliasTags":{"Type":180,"Flags":4,"Description":"A list of tags to add to the test alias for a bot, , which can only be added at bot/bot alias creation."}}}},{"3":{"ItemType":22}},{"3":{"ItemType":125}},{"2":{"Name":"Bot_DataPrivacy","Properties":{"ChildDirected":{"Type":2,"Flags":1,"Description":""}}}},{"3":{"ItemType":125}},{"2":{"Name":"AWS.Lex/Bot","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":176,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Lex/Bot@default","ScopeType":0,"Body":181}},{"2":{"Name":"Arn"}},{"2":{"Name":"AudioLogDestination","Properties":{"S3Bucket":{"Type":200,"Flags":1}}}},{"2":{"Name":"AudioLogSetting","Properties":{"Destination":{"Type":184,"Flags":1},"Enabled":{"Type":2,"Flags":1,"Description":""}}}},{"2":{"Name":"AudioLogSettings"}},{"2":{"Name":"BotAliasLocaleSettings","Properties":{"CodeHookSpecification":{"Type":193,"Flags":0},"Enabled":{"Type":2,"Flags":1,"Description":"Whether the Lambda code hook is enabled"}}}},{"2":{"Name":"BotAliasLocaleSettingsItem","Properties":{"BotAliasLocaleSetting":{"Type":187,"Flags":1},"LocaleId":{"Type":4,"Flags":1,"Description":"A string used to identify the locale"}}}},{"2":{"Name":"BotAliasLocaleSettingsList"}},{"2":{"Name":"BotAliasStatus"}},{"2":{"Name":"BotVersion"}},{"2":{"Name":"CloudWatchLogGroupLogDestination","Properties":{"CloudWatchLogGroupArn":{"Type":4,"Flags":1,"Description":"A string used to identify the groupArn for the Cloudwatch Log Group"},"LogPrefix":{"Type":4,"Flags":1,"Description":"A string containing the value for the Log Prefix"}}}},{"2":{"Name":"CodeHookSpecification","Properties":{"LambdaCodeHook":{"Type":197,"Flags":1}}}},{"2":{"Name":"ConversationLogSettings","Properties":{"AudioLogSettings":{"Type":207,"Flags":0},"TextLogSettings":{"Type":208,"Flags":0}}}},{"2":{"Name":"Description"}},{"2":{"Name":"Id"}},{"2":{"Name":"LambdaCodeHook","Properties":{"CodeHookInterfaceVersion":{"Type":4,"Flags":1,"Description":"The version of the request-response that you want Amazon Lex to use to invoke your Lambda function."},"LambdaArn":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) of the Lambda function."}}}},{"2":{"Name":"LocaleId"}},{"2":{"Name":"Name"}},{"2":{"Name":"S3BucketLogDestination","Properties":{"KmsKeyArn":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key for encrypting audio log files stored in an S3 bucket."},"LogPrefix":{"Type":4,"Flags":1,"Description":"The Amazon S3 key of the deployment package."},"S3BucketArn":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"A string used to identify this tag"},"Value":{"Type":4,"Flags":1,"Description":"A string containing the value for the tag"}}}},{"2":{"Name":"TextLogDestination","Properties":{"CloudWatch":{"Type":192,"Flags":1}}}},{"2":{"Name":"TextLogSetting","Properties":{"Destination":{"Type":202,"Flags":1},"Enabled":{"Type":2,"Flags":1,"Description":""}}}},{"2":{"Name":"TextLogSettings"}},{"3":{"ItemType":185}},{"3":{"ItemType":188}},{"3":{"ItemType":185}},{"3":{"ItemType":203}},{"3":{"ItemType":203}},{"2":{"Name":"AWS.Lex/BotAliasProperties","Properties":{"Arn":{"Type":4,"Flags":2},"BotAliasId":{"Type":4,"Flags":18},"BotAliasLocaleSettings":{"Type":211,"Flags":0},"BotAliasName":{"Type":4,"Flags":1},"BotAliasStatus":{"Type":4,"Flags":2},"BotAliasTags":{"Type":212,"Flags":4,"Description":"A list of tags to add to the bot alias."},"BotId":{"Type":4,"Flags":17},"BotVersion":{"Type":4,"Flags":0},"ConversationLogSettings":{"Type":194,"Flags":0},"Description":{"Type":4,"Flags":0},"SentimentAnalysisSettings":{"Type":213,"Flags":0,"Description":"Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances."}}}},{"3":{"ItemType":188}},{"3":{"ItemType":201}},{"2":{"Name":"BotAlias_SentimentAnalysisSettings","Properties":{"DetectSentiment":{"Type":2,"Flags":1,"Description":"Enable to call Amazon Comprehend for Sentiment natively within Lex"}}}},{"2":{"Name":"AWS.Lex/BotAlias","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":210,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Lex/BotAlias@default","ScopeType":0,"Body":214}},{"2":{"Name":"PhysicalId"}},{"2":{"Name":"Policy","Properties":{}}},{"2":{"Name":"ResourceArn"}},{"2":{"Name":"RevisionId"}},{"2":{"Name":"AWS.Lex/ResourcePolicyProperties","Properties":{"Id":{"Type":4,"Flags":18},"Policy":{"Type":217,"Flags":1},"ResourceArn":{"Type":4,"Flags":1},"RevisionId":{"Type":4,"Flags":2}}}},{"2":{"Name":"AWS.Lex/ResourcePolicy","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":220,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Lex/ResourcePolicy@default","ScopeType":0,"Body":221}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "AdvancedRecognitionSetting", + "properties": { + "AudioRecognitionStrategy": { + "type": { + "$ref": "#/126" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AllowedInputTypes", + "properties": { + "AllowAudioInput": { + "type": { + "$ref": "#/127" + }, + "flags": 1, + "description": "Indicates whether audio input is allowed." + }, + "AllowDTMFInput": { + "type": { + "$ref": "#/127" + }, + "flags": 1, + "description": "Indicates whether DTMF input is allowed." + } + } + }, + { + "$type": "ObjectType", + "name": "AttachmentTitle", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AttachmentUrl", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AudioAndDTMFInputSpecification", + "properties": { + "AudioSpecification": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "DTMFSpecification": { + "type": { + "$ref": "#/32" + }, + "flags": 0 + }, + "StartTimeoutMs": { + "type": { + "$ref": "#/128" + }, + "flags": 1, + "description": "Time for which a bot waits before assuming that the customer isn't going to speak or press a key. This timeout is shared between Audio and DTMF inputs." + } + } + }, + { + "$type": "ObjectType", + "name": "AudioLogDestination", + "properties": { + "S3Bucket": { + "type": { + "$ref": "#/84" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AudioLogSetting", + "properties": { + "Destination": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Enabled": { + "type": { + "$ref": "#/127" + }, + "flags": 1, + "description": "" + } + } + }, + { + "$type": "ObjectType", + "name": "AudioLogSettings", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AudioRecognitionStrategy", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AudioSpecification", + "properties": { + "EndTimeoutMs": { + "type": { + "$ref": "#/128" + }, + "flags": 1, + "description": "Time for which a bot waits after the customer stops speaking to assume the utterance is finished." + }, + "MaxLengthMs": { + "type": { + "$ref": "#/128" + }, + "flags": 1, + "description": "Time for how long Amazon Lex waits before speech input is truncated and the speech is returned to application." + } + } + }, + { + "$type": "ObjectType", + "name": "BotAliasLocaleSettings", + "properties": { + "CodeHookSpecification": { + "type": { + "$ref": "#/17" + }, + "flags": 0 + }, + "Enabled": { + "type": { + "$ref": "#/127" + }, + "flags": 1, + "description": "Whether the Lambda code hook is enabled" + } + } + }, + { + "$type": "ObjectType", + "name": "BotAliasLocaleSettingsItem", + "properties": { + "BotAliasLocaleSetting": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + }, + "LocaleId": { + "type": { + "$ref": "#/126" + }, + "flags": 1, + "description": "A string used to identify the locale" + } + } + }, + { + "$type": "ObjectType", + "name": "BotAliasLocaleSettingsList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "BotArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "BotLocale", + "properties": { + "CustomVocabulary": { + "type": { + "$ref": "#/29" + }, + "flags": 0 + }, + "Description": { + "type": { + "$ref": "#/126" + }, + "flags": 0 + }, + "Intents": { + "type": { + "$ref": "#/131" + }, + "flags": 0, + "description": "List of intents" + }, + "LocaleId": { + "type": { + "$ref": "#/126" + }, + "flags": 1 + }, + "NluConfidenceThreshold": { + "type": { + "$ref": "#/128" + }, + "flags": 1 + }, + "SlotTypes": { + "type": { + "$ref": "#/132" + }, + "flags": 0, + "description": "List of SlotTypes" + }, + "VoiceSettings": { + "type": { + "$ref": "#/124" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Button", + "properties": { + "Text": { + "type": { + "$ref": "#/126" + }, + "flags": 1, + "description": "The text that appears on the button." + }, + "Value": { + "type": { + "$ref": "#/126" + }, + "flags": 1, + "description": "The value returned to Amazon Lex when the user chooses this button." + } + } + }, + { + "$type": "ObjectType", + "name": "CloudWatchLogGroupLogDestination", + "properties": { + "CloudWatchLogGroupArn": { + "type": { + "$ref": "#/126" + }, + "flags": 1, + "description": "A string used to identify the groupArn for the Cloudwatch Log Group" + }, + "LogPrefix": { + "type": { + "$ref": "#/126" + }, + "flags": 1, + "description": "A string containing the value for the Log Prefix" + } + } + }, + { + "$type": "ObjectType", + "name": "CodeHookSpecification", + "properties": { + "LambdaCodeHook": { + "type": { + "$ref": "#/61" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Condition", + "properties": { + "ExpressionString": { + "type": { + "$ref": "#/126" + }, + "flags": 1, + "description": "The expression string that is evaluated." + } + } + }, + { + "$type": "ObjectType", + "name": "ConditionExpression", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Conditional", + "properties": { + "ConditionalBranches": { + "type": { + "$ref": "#/133" + }, + "flags": 1 + }, + "IsActive": { + "type": { + "$ref": "#/127" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ConditionalBranch", + "properties": { + "Condition": { + "type": { + "$ref": "#/18" + }, + "flags": 1, + "description": "Contains the expression to evaluate. If the condition is true, the branch's actions are taken." + }, + "Name": { + "type": { + "$ref": "#/126" + }, + "flags": 1, + "description": "The name of the branch." + }, + "NextStep": { + "type": { + "$ref": "#/40" + }, + "flags": 1, + "description": "The next step in the conversation." + }, + "Response": { + "type": { + "$ref": "#/82" + }, + "flags": 0, + "description": "Specifies a list of message groups that Amazon Lex uses to respond the user input." + } + } + }, + { + "$type": "ObjectType", + "name": "ConditionalBranches", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ConditionalSpecification", + "properties": { + "ConditionalBranches": { + "type": { + "$ref": "#/135" + }, + "flags": 1, + "description": "A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true." + }, + "DefaultBranch": { + "type": { + "$ref": "#/34" + }, + "flags": 1, + "description": "The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step." + }, + "IsActive": { + "type": { + "$ref": "#/127" + }, + "flags": 1, + "description": "Determines whether a conditional branch is active. When active is false, the conditions are not evaluated." + } + } + }, + { + "$type": "ObjectType", + "name": "ConfidenceThreshold", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ContextTimeToLiveInSeconds", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ContextTurnsToLive", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ConversationLogSettings", + "properties": { + "AudioLogSettings": { + "type": { + "$ref": "#/136" + }, + "flags": 0 + }, + "TextLogSettings": { + "type": { + "$ref": "#/137" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomPayload", + "properties": { + "Value": { + "type": { + "$ref": "#/126" + }, + "flags": 1, + "description": "The string that is sent to your application." + } + } + }, + { + "$type": "ObjectType", + "name": "CustomVocabulary", + "properties": { + "CustomVocabularyItems": { + "type": { + "$ref": "#/138" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomVocabularyItem", + "properties": { + "DisplayAs": { + "type": { + "$ref": "#/126" + }, + "flags": 0, + "description": "Defines how you want your phrase to look in your transcription output." + }, + "Phrase": { + "type": { + "$ref": "#/126" + }, + "flags": 1, + "description": "Phrase that should be recognized." + }, + "Weight": { + "type": { + "$ref": "#/128" + }, + "flags": 0, + "description": "The degree to which the phrase recognition is boosted. The weight 0 means that no boosting will be applied and the entry will only be used for performing replacements using the displayAs field." + } + } + }, + { + "$type": "ObjectType", + "name": "CustomVocabularyItems", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DTMFSpecification", + "properties": { + "DeletionCharacter": { + "type": { + "$ref": "#/126" + }, + "flags": 1, + "description": "The DTMF character that clears the accumulated DTMF digits and immediately ends the input." + }, + "EndCharacter": { + "type": { + "$ref": "#/126" + }, + "flags": 1, + "description": "The DTMF character that immediately ends input. If the user does not press this character, the input ends after the end timeout." + }, + "EndTimeoutMs": { + "type": { + "$ref": "#/128" + }, + "flags": 1, + "description": "How long the bot should wait after the last DTMF character input before assuming that the input has concluded." + }, + "MaxLength": { + "type": { + "$ref": "#/128" + }, + "flags": 1, + "description": "The maximum number of DTMF digits allowed in an utterance." + } + } + }, + { + "$type": "ObjectType", + "name": "DataPrivacy", + "properties": { + "ChildDirected": { + "type": { + "$ref": "#/127" + }, + "flags": 1, + "description": "Specify whether your use of Amazon Lex is related to application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA)." + } + } + }, + { + "$type": "ObjectType", + "name": "DefaultConditionalBranch", + "properties": { + "NextStep": { + "type": { + "$ref": "#/40" + }, + "flags": 0, + "description": "The next step in the conversation." + }, + "Response": { + "type": { + "$ref": "#/82" + }, + "flags": 0, + "description": "Specifies a list of message groups that Amazon Lex uses to respond the user input." + } + } + }, + { + "$type": "ObjectType", + "name": "Description", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DialogAction", + "properties": { + "SlotToElicit": { + "type": { + "$ref": "#/126" + }, + "flags": 0, + "description": "If the dialog action is ElicitSlot, defines the slot to elicit from the user." + }, + "SuppressNextMessage": { + "type": { + "$ref": "#/127" + }, + "flags": 0, + "description": "When true the next message for the intent is not used." + }, + "Type": { + "type": { + "$ref": "#/126" + }, + "flags": 1, + "description": "The action that the bot should execute." + } + } + }, + { + "$type": "ObjectType", + "name": "DialogActionType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DialogCodeHookInvocationSetting", + "properties": { + "EnableCodeHookInvocation": { + "type": { + "$ref": "#/127" + }, + "flags": 1, + "description": "Indicates whether a Lambda function should be invoked for the dialog." + }, + "InvocationLabel": { + "type": { + "$ref": "#/126" + }, + "flags": 0, + "description": "A label that indicates the dialog step from which the dialog code hook is happening." + }, + "IsActive": { + "type": { + "$ref": "#/127" + }, + "flags": 1, + "description": "Determines whether a dialog code hook is used when the intent is activated." + }, + "PostCodeHookSpecification": { + "type": { + "$ref": "#/75" + }, + "flags": 1, + "description": "Contains the responses and actions that Amazon Lex takes after the Lambda function is complete." + } + } + }, + { + "$type": "ObjectType", + "name": "DialogCodeHookSetting", + "properties": { + "Enabled": { + "type": { + "$ref": "#/127" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DialogState", + "properties": { + "DialogAction": { + "type": { + "$ref": "#/36" + }, + "flags": 0, + "description": "Defines the action that the bot executes at runtime when the conversation reaches this step." + }, + "Intent": { + "type": { + "$ref": "#/58" + }, + "flags": 0, + "description": "Override settings to configure the intent state." + }, + "SessionAttributes": { + "type": { + "$ref": "#/140" + }, + "flags": 0, + "description": "List of session attributes to be applied when the conversation reaches this step." + } + } + }, + { + "$type": "ObjectType", + "name": "ElicitationCodeHookInvocationSetting", + "properties": { + "EnableCodeHookInvocation": { + "type": { + "$ref": "#/127" + }, + "flags": 1, + "description": "Indicates whether a Lambda function should be invoked for the dialog." + }, + "InvocationLabel": { + "type": { + "$ref": "#/126" + }, + "flags": 0, + "description": "A label that indicates the dialog step from which the dialog code hook is happening." + } + } + }, + { + "$type": "ObjectType", + "name": "ExternalSourceSetting", + "properties": { + "GrammarSlotTypeSetting": { + "type": { + "$ref": "#/47" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FulfillmentCodeHookSetting", + "properties": { + "Enabled": { + "type": { + "$ref": "#/127" + }, + "flags": 1 + }, + "FulfillmentUpdatesSpecification": { + "type": { + "$ref": "#/46" + }, + "flags": 0 + }, + "IsActive": { + "type": { + "$ref": "#/127" + }, + "flags": 0, + "description": "Determines whether the fulfillment code hook is used. When active is false, the code hook doesn't run." + }, + "PostFulfillmentStatusSpecification": { + "type": { + "$ref": "#/76" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FulfillmentStartResponseSpecification", + "properties": { + "AllowInterrupt": { + "type": { + "$ref": "#/127" + }, + "flags": 0, + "description": "Determines whether the user can interrupt the start message while it is playing." + }, + "DelayInSeconds": { + "type": { + "$ref": "#/128" + }, + "flags": 1, + "description": "The delay between when the Lambda fulfillment function starts running and the start message is played. If the Lambda function returns before the delay is over, the start message isn't played." + }, + "MessageGroups": { + "type": { + "$ref": "#/141" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "FulfillmentUpdateResponseSpecification", + "properties": { + "AllowInterrupt": { + "type": { + "$ref": "#/127" + }, + "flags": 0, + "description": "Determines whether the user can interrupt an update message while it is playing." + }, + "FrequencyInSeconds": { + "type": { + "$ref": "#/128" + }, + "flags": 1, + "description": "The frequency that a message is sent to the user. When the period ends, Amazon Lex chooses a message from the message groups and plays it to the user. If the fulfillment Lambda returns before the first period ends, an update message is not played to the user." + }, + "MessageGroups": { + "type": { + "$ref": "#/142" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "FulfillmentUpdatesSpecification", + "properties": { + "Active": { + "type": { + "$ref": "#/127" + }, + "flags": 1, + "description": "Determines whether fulfillment updates are sent to the user. When this field is true, updates are sent." + }, + "StartResponse": { + "type": { + "$ref": "#/44" + }, + "flags": 0 + }, + "TimeoutInSeconds": { + "type": { + "$ref": "#/128" + }, + "flags": 0, + "description": "The length of time that the fulfillment Lambda function should run before it times out." + }, + "UpdateResponse": { + "type": { + "$ref": "#/45" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GrammarSlotTypeSetting", + "properties": { + "Source": { + "type": { + "$ref": "#/48" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GrammarSlotTypeSource", + "properties": { + "KmsKeyArn": { + "type": { + "$ref": "#/126" + }, + "flags": 0, + "description": "The Amazon KMS key required to decrypt the contents of the grammar, if any." + }, + "S3BucketName": { + "type": { + "$ref": "#/126" + }, + "flags": 1, + "description": "The name of the S3 bucket that contains the grammar source." + }, + "S3ObjectKey": { + "type": { + "$ref": "#/126" + }, + "flags": 1, + "description": "The path to the grammar in the S3 bucket." + } + } + }, + { + "$type": "ObjectType", + "name": "Id", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "IdleSessionTTLInSeconds", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ImageResponseCard", + "properties": { + "Buttons": { + "type": { + "$ref": "#/143" + }, + "flags": 0, + "description": "A list of buttons that should be displayed on the response card." + }, + "ImageUrl": { + "type": { + "$ref": "#/126" + }, + "flags": 0, + "description": "The URL of an image to display on the response card." + }, + "Subtitle": { + "type": { + "$ref": "#/126" + }, + "flags": 0, + "description": "The subtitle to display on the response card." + }, + "Title": { + "type": { + "$ref": "#/126" + }, + "flags": 1, + "description": "The title to display on the response card." + } + } + }, + { + "$type": "ObjectType", + "name": "InitialResponseSetting", + "properties": { + "CodeHook": { + "type": { + "$ref": "#/38" + }, + "flags": 0, + "description": "Settings that specify the dialog code hook that is called by Amazon Lex at a step of the conversation." + }, + "Conditional": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "Provides a list of conditional branches. Branches are evaluated in the order that they are entered in the list. The first branch with a condition that evaluates to true is executed. The last branch in the list is the default branch. The default branch should not have any condition expression. The default branch is executed if no other branch has a matching condition." + }, + "InitialResponse": { + "type": { + "$ref": "#/82" + }, + "flags": 0, + "description": "Specifies a list of message groups that Amazon Lex uses to respond the user input." + }, + "NextStep": { + "type": { + "$ref": "#/40" + }, + "flags": 0, + "description": "The next step in the conversation." + } + } + }, + { + "$type": "ObjectType", + "name": "InputContext", + "properties": { + "Name": { + "type": { + "$ref": "#/126" + }, + "flags": 1, + "description": "The name of the context." + } + } + }, + { + "$type": "ObjectType", + "name": "InputContextsList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Intent", + "properties": { + "Description": { + "type": { + "$ref": "#/126" + }, + "flags": 0, + "description": "Description of thr intent." + }, + "DialogCodeHook": { + "type": { + "$ref": "#/39" + }, + "flags": 0 + }, + "FulfillmentCodeHook": { + "type": { + "$ref": "#/43" + }, + "flags": 0 + }, + "InitialResponseSetting": { + "type": { + "$ref": "#/52" + }, + "flags": 0, + "description": "Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots." + }, + "InputContexts": { + "type": { + "$ref": "#/145" + }, + "flags": 0 + }, + "IntentClosingSetting": { + "type": { + "$ref": "#/56" + }, + "flags": 0 + }, + "IntentConfirmationSetting": { + "type": { + "$ref": "#/57" + }, + "flags": 0 + }, + "KendraConfiguration": { + "type": { + "$ref": "#/59" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/126" + }, + "flags": 1, + "description": "The name of the intent." + }, + "OutputContexts": { + "type": { + "$ref": "#/146" + }, + "flags": 0 + }, + "ParentIntentSignature": { + "type": { + "$ref": "#/126" + }, + "flags": 0 + }, + "SampleUtterances": { + "type": { + "$ref": "#/147" + }, + "flags": 0, + "description": "A sample utterance that invokes an intent or respond to a slot elicitation prompt." + }, + "SlotPriorities": { + "type": { + "$ref": "#/148" + }, + "flags": 0 + }, + "Slots": { + "type": { + "$ref": "#/149" + }, + "flags": 0, + "description": "List of slots" + } + } + }, + { + "$type": "ObjectType", + "name": "IntentClosingSetting", + "properties": { + "ClosingResponse": { + "type": { + "$ref": "#/82" + }, + "flags": 0, + "description": "The response that Amazon Lex sends to the user when the intent is complete." + }, + "Conditional": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "A list of conditional branches associated with the intent's closing response. These branches are executed when the nextStep attribute is set to EvalutateConditional." + }, + "IsActive": { + "type": { + "$ref": "#/127" + }, + "flags": 0, + "description": "Specifies whether an intent's closing response is used. When this field is false, the closing response isn't sent to the user. If the active field isn't specified, the default is true." + }, + "NextStep": { + "type": { + "$ref": "#/40" + }, + "flags": 0, + "description": "Specifies the next step that the bot executes after playing the intent's closing response." + } + } + }, + { + "$type": "ObjectType", + "name": "IntentConfirmationSetting", + "properties": { + "CodeHook": { + "type": { + "$ref": "#/38" + }, + "flags": 0, + "description": "The DialogCodeHookInvocationSetting object associated with intent's confirmation step. The dialog code hook is triggered based on these invocation settings when the confirmation next step or declination next step or failure next step is InvokeDialogCodeHook." + }, + "ConfirmationConditional": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "A list of conditional branches to evaluate after the intent is closed." + }, + "ConfirmationNextStep": { + "type": { + "$ref": "#/40" + }, + "flags": 0, + "description": "Specifies the next step that the bot executes when the customer confirms the intent." + }, + "ConfirmationResponse": { + "type": { + "$ref": "#/82" + }, + "flags": 0, + "description": "Specifies a list of message groups that Amazon Lex uses to respond the user input." + }, + "DeclinationConditional": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "A list of conditional branches to evaluate after the intent is declined." + }, + "DeclinationNextStep": { + "type": { + "$ref": "#/40" + }, + "flags": 0, + "description": "Specifies the next step that the bot executes when the customer declines the intent." + }, + "DeclinationResponse": { + "type": { + "$ref": "#/82" + }, + "flags": 0, + "description": "When the user answers \"no\" to the question defined in promptSpecification, Amazon Lex responds with this response to acknowledge that the intent was canceled." + }, + "ElicitationCodeHook": { + "type": { + "$ref": "#/41" + }, + "flags": 0, + "description": "The DialogCodeHookInvocationSetting used when the code hook is invoked during confirmation prompt retries." + }, + "FailureConditional": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "Provides a list of conditional branches. Branches are evaluated in the order that they are entered in the list. The first branch with a condition that evaluates to true is executed. The last branch in the list is the default branch. The default branch should not have any condition expression. The default branch is executed if no other branch has a matching condition." + }, + "FailureNextStep": { + "type": { + "$ref": "#/40" + }, + "flags": 0, + "description": "The next step to take in the conversation if the confirmation step fails." + }, + "FailureResponse": { + "type": { + "$ref": "#/82" + }, + "flags": 0, + "description": "Specifies a list of message groups that Amazon Lex uses to respond the user input." + }, + "IsActive": { + "type": { + "$ref": "#/127" + }, + "flags": 0, + "description": "Specifies whether the intent's confirmation is sent to the user. When this field is false, confirmation and declination responses aren't sent. If the active field isn't specified, the default is true." + }, + "PromptSpecification": { + "type": { + "$ref": "#/80" + }, + "flags": 1, + "description": "Prompts the user to confirm the intent. This question should have a yes or no answer." + } + } + }, + { + "$type": "ObjectType", + "name": "IntentOverride", + "properties": { + "Name": { + "type": { + "$ref": "#/126" + }, + "flags": 0, + "description": "The name of the intent. Only required when you're switching intents." + }, + "Slots": { + "type": { + "$ref": "#/150" + }, + "flags": 0, + "description": "A map of all of the slot value overrides for the intent." + } + } + }, + { + "$type": "ObjectType", + "name": "KendraConfiguration", + "properties": { + "KendraIndex": { + "type": { + "$ref": "#/126" + }, + "flags": 1 + }, + "QueryFilterString": { + "type": { + "$ref": "#/126" + }, + "flags": 0 + }, + "QueryFilterStringEnabled": { + "type": { + "$ref": "#/127" + }, + "flags": 0, + "description": "Determines whether the AMAZON.KendraSearchIntent intent uses a custom query string to query the Amazon Kendra index." + } + } + }, + { + "$type": "ObjectType", + "name": "KendraIndexArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LambdaCodeHook", + "properties": { + "CodeHookInterfaceVersion": { + "type": { + "$ref": "#/126" + }, + "flags": 1, + "description": "The version of the request-response that you want Amazon Lex to use to invoke your Lambda function." + }, + "LambdaArn": { + "type": { + "$ref": "#/126" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of the Lambda function." + } + } + }, + { + "$type": "ObjectType", + "name": "LocaleId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Message", + "properties": { + "CustomPayload": { + "type": { + "$ref": "#/28" + }, + "flags": 0 + }, + "ImageResponseCard": { + "type": { + "$ref": "#/51" + }, + "flags": 0 + }, + "PlainTextMessage": { + "type": { + "$ref": "#/74" + }, + "flags": 0 + }, + "SSMLMessage": { + "type": { + "$ref": "#/88" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "MessageGroup", + "properties": { + "Message": { + "type": { + "$ref": "#/63" + }, + "flags": 1 + }, + "Variations": { + "type": { + "$ref": "#/151" + }, + "flags": 0, + "description": "Message variations to send to the user." + } + } + }, + { + "$type": "ObjectType", + "name": "MessageGroupsList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MessageSelectionStrategy", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MultipleValuesSetting", + "properties": { + "AllowMultipleValues": { + "type": { + "$ref": "#/127" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Name", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ObfuscationSetting", + "properties": { + "ObfuscationSettingType": { + "type": { + "$ref": "#/126" + }, + "flags": 1, + "description": "Value that determines whether Amazon Lex obscures slot values in conversation logs. The default is to obscure the values." + } + } + }, + { + "$type": "ObjectType", + "name": "OutputContext", + "properties": { + "Name": { + "type": { + "$ref": "#/126" + }, + "flags": 1 + }, + "TimeToLiveInSeconds": { + "type": { + "$ref": "#/128" + }, + "flags": 1 + }, + "TurnsToLive": { + "type": { + "$ref": "#/128" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "OutputContextsList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ParentIntentSignature", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ParentSlotTypeSignature", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PlainTextMessage", + "properties": { + "Value": { + "type": { + "$ref": "#/126" + }, + "flags": 1, + "description": "The message to send to the user." + } + } + }, + { + "$type": "ObjectType", + "name": "PostDialogCodeHookInvocationSpecification", + "properties": { + "FailureConditional": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "A list of conditional branches to evaluate after the dialog code hook throws an exception or returns with the State field of the Intent object set to Failed." + }, + "FailureNextStep": { + "type": { + "$ref": "#/40" + }, + "flags": 0, + "description": "Specifies the next step the bot runs after the dialog code hook throws an exception or returns with the State field of the Intent object set to Failed." + }, + "FailureResponse": { + "type": { + "$ref": "#/82" + }, + "flags": 0, + "description": "Specifies a list of message groups that Amazon Lex uses to respond the user input." + }, + "SuccessConditional": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "A list of conditional branches to evaluate after the dialog code hook finishes successfully." + }, + "SuccessNextStep": { + "type": { + "$ref": "#/40" + }, + "flags": 0, + "description": "Specifics the next step the bot runs after the dialog code hook finishes successfully." + }, + "SuccessResponse": { + "type": { + "$ref": "#/82" + }, + "flags": 0, + "description": "Specifies a list of message groups that Amazon Lex uses to respond the user input." + }, + "TimeoutConditional": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "A list of conditional branches to evaluate if the code hook times out." + }, + "TimeoutNextStep": { + "type": { + "$ref": "#/40" + }, + "flags": 0, + "description": "Specifies the next step that the bot runs when the code hook times out." + }, + "TimeoutResponse": { + "type": { + "$ref": "#/82" + }, + "flags": 0, + "description": "Specifies a list of message groups that Amazon Lex uses to respond the user input." + } + } + }, + { + "$type": "ObjectType", + "name": "PostFulfillmentStatusSpecification", + "properties": { + "FailureConditional": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "A list of conditional branches to evaluate after the fulfillment code hook throws an exception or returns with the State field of the Intent object set to Failed." + }, + "FailureNextStep": { + "type": { + "$ref": "#/40" + }, + "flags": 0, + "description": "Specifies the next step the bot runs after the fulfillment code hook throws an exception or returns with the State field of the Intent object set to Failed." + }, + "FailureResponse": { + "type": { + "$ref": "#/82" + }, + "flags": 0, + "description": "Specifies a list of message groups that Amazon Lex uses to respond the user input." + }, + "SuccessConditional": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "A list of conditional branches to evaluate after the fulfillment code hook finishes successfully." + }, + "SuccessNextStep": { + "type": { + "$ref": "#/40" + }, + "flags": 0, + "description": "Specifies the next step in the conversation that Amazon Lex invokes when the fulfillment code hook completes successfully." + }, + "SuccessResponse": { + "type": { + "$ref": "#/82" + }, + "flags": 0, + "description": "Specifies a list of message groups that Amazon Lex uses to respond the user input." + }, + "TimeoutConditional": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "A list of conditional branches to evaluate if the fulfillment code hook times out." + }, + "TimeoutNextStep": { + "type": { + "$ref": "#/40" + }, + "flags": 0, + "description": "Specifies the next step that the bot runs when the fulfillment code hook times out." + }, + "TimeoutResponse": { + "type": { + "$ref": "#/82" + }, + "flags": 0, + "description": "Specifies a list of message groups that Amazon Lex uses to respond the user input." + } + } + }, + { + "$type": "ObjectType", + "name": "PriorityValue", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PromptAttemptSpecification", + "properties": { + "AllowInterrupt": { + "type": { + "$ref": "#/127" + }, + "flags": 0, + "description": "Indicates whether the user can interrupt a speech prompt attempt from the bot." + }, + "AllowedInputTypes": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "AudioAndDTMFInputSpecification": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "TextInputSpecification": { + "type": { + "$ref": "#/119" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PromptMaxRetries", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PromptSpecification", + "properties": { + "AllowInterrupt": { + "type": { + "$ref": "#/127" + }, + "flags": 0, + "description": "Indicates whether the user can interrupt a speech prompt from the bot." + }, + "MaxRetries": { + "type": { + "$ref": "#/128" + }, + "flags": 1 + }, + "MessageGroupsList": { + "type": { + "$ref": "#/154" + }, + "flags": 1 + }, + "MessageSelectionStrategy": { + "type": { + "$ref": "#/126" + }, + "flags": 0 + }, + "PromptAttemptsSpecification": { + "type": { + "$ref": "#/155" + }, + "flags": 0, + "description": "Specifies the advanced settings on each attempt of the prompt." + } + } + }, + { + "$type": "ObjectType", + "name": "QueryFilterString", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ResponseSpecification", + "properties": { + "AllowInterrupt": { + "type": { + "$ref": "#/127" + }, + "flags": 0, + "description": "Indicates whether the user can interrupt a speech prompt from the bot." + }, + "MessageGroupsList": { + "type": { + "$ref": "#/156" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "RoleArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "S3BucketLogDestination", + "properties": { + "KmsKeyArn": { + "type": { + "$ref": "#/126" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key for encrypting audio log files stored in an S3 bucket." + }, + "LogPrefix": { + "type": { + "$ref": "#/126" + }, + "flags": 1, + "description": "The Amazon S3 key of the deployment package." + }, + "S3BucketArn": { + "type": { + "$ref": "#/126" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored." + } + } + }, + { + "$type": "ObjectType", + "name": "S3BucketName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "S3Location", + "properties": { + "S3Bucket": { + "type": { + "$ref": "#/126" + }, + "flags": 1, + "description": "An Amazon S3 bucket in the same AWS Region as your function. The bucket can be in a different AWS account." + }, + "S3ObjectKey": { + "type": { + "$ref": "#/126" + }, + "flags": 1, + "description": "The Amazon S3 key of the deployment package." + }, + "S3ObjectVersion": { + "type": { + "$ref": "#/126" + }, + "flags": 0, + "description": "For versioned objects, the version of the deployment package object to use. If not specified, the current object version will be used." + } + } + }, + { + "$type": "ObjectType", + "name": "S3ObjectKey", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SSMLMessage", + "properties": { + "Value": { + "type": { + "$ref": "#/126" + }, + "flags": 1, + "description": "The SSML text that defines the prompt." + } + } + }, + { + "$type": "ObjectType", + "name": "SampleUtterance", + "properties": { + "Utterance": { + "type": { + "$ref": "#/126" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "SampleUtterancesList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SampleValue", + "properties": { + "Value": { + "type": { + "$ref": "#/126" + }, + "flags": 1, + "description": "The value that can be used for a slot type." + } + } + }, + { + "$type": "ObjectType", + "name": "SessionAttribute", + "properties": { + "Key": { + "type": { + "$ref": "#/126" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/126" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Slot", + "properties": { + "Description": { + "type": { + "$ref": "#/126" + }, + "flags": 0 + }, + "MultipleValuesSetting": { + "type": { + "$ref": "#/67" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/126" + }, + "flags": 1 + }, + "ObfuscationSetting": { + "type": { + "$ref": "#/69" + }, + "flags": 0 + }, + "SlotTypeName": { + "type": { + "$ref": "#/126" + }, + "flags": 1 + }, + "ValueElicitationSetting": { + "type": { + "$ref": "#/106" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "SlotCaptureSetting", + "properties": { + "CaptureConditional": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "A list of conditional branches to evaluate after the slot value is captured." + }, + "CaptureNextStep": { + "type": { + "$ref": "#/40" + }, + "flags": 0, + "description": "Specifies the next step that the bot runs when the slot value is captured before the code hook times out." + }, + "CaptureResponse": { + "type": { + "$ref": "#/82" + }, + "flags": 0, + "description": "Specifies a list of message groups that Amazon Lex uses to respond the user input." + }, + "CodeHook": { + "type": { + "$ref": "#/38" + }, + "flags": 0, + "description": "Code hook called after Amazon Lex successfully captures a slot value." + }, + "ElicitationCodeHook": { + "type": { + "$ref": "#/41" + }, + "flags": 0, + "description": "Code hook called when Amazon Lex doesn't capture a slot value." + }, + "FailureConditional": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "A list of conditional branches to evaluate when the slot value isn't captured." + }, + "FailureNextStep": { + "type": { + "$ref": "#/40" + }, + "flags": 0, + "description": "Specifies the next step that the bot runs when the slot value code is not recognized." + }, + "FailureResponse": { + "type": { + "$ref": "#/82" + }, + "flags": 0, + "description": "Specifies a list of message groups that Amazon Lex uses to respond the user input." + } + } + }, + { + "$type": "ObjectType", + "name": "SlotConstraint", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SlotDefaultValue", + "properties": { + "DefaultValue": { + "type": { + "$ref": "#/126" + }, + "flags": 1, + "description": "The default value to use when a user doesn't provide a value for a slot." + } + } + }, + { + "$type": "ObjectType", + "name": "SlotDefaultValueSpecification", + "properties": { + "DefaultValueList": { + "type": { + "$ref": "#/158" + }, + "flags": 1, + "description": "A list of slot default values" + } + } + }, + { + "$type": "ObjectType", + "name": "SlotPrioritiesList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SlotPriority", + "properties": { + "Priority": { + "type": { + "$ref": "#/128" + }, + "flags": 1 + }, + "SlotName": { + "type": { + "$ref": "#/126" + }, + "flags": 1, + "description": "The name of the slot." + } + } + }, + { + "$type": "ObjectType", + "name": "SlotShape", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SlotType", + "properties": { + "Description": { + "type": { + "$ref": "#/126" + }, + "flags": 0 + }, + "ExternalSourceSetting": { + "type": { + "$ref": "#/42" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/126" + }, + "flags": 1 + }, + "ParentSlotTypeSignature": { + "type": { + "$ref": "#/126" + }, + "flags": 0 + }, + "SlotTypeValues": { + "type": { + "$ref": "#/160" + }, + "flags": 0 + }, + "ValueSelectionSetting": { + "type": { + "$ref": "#/111" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SlotTypeName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SlotTypeValue", + "properties": { + "SampleValue": { + "type": { + "$ref": "#/91" + }, + "flags": 1 + }, + "Synonyms": { + "type": { + "$ref": "#/161" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SlotTypeValues", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SlotValue", + "properties": { + "InterpretedValue": { + "type": { + "$ref": "#/126" + }, + "flags": 0, + "description": "The value that Amazon Lex determines for the slot." + } + } + }, + { + "$type": "ObjectType", + "name": "SlotValueElicitationSetting", + "properties": { + "DefaultValueSpecification": { + "type": { + "$ref": "#/97" + }, + "flags": 0, + "description": "A list of default values for a slot." + }, + "PromptSpecification": { + "type": { + "$ref": "#/80" + }, + "flags": 0, + "description": "The prompt that Amazon Lex uses to elicit the slot value from the user." + }, + "SampleUtterances": { + "type": { + "$ref": "#/163" + }, + "flags": 0, + "description": "If you know a specific pattern that users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy." + }, + "SlotCaptureSetting": { + "type": { + "$ref": "#/94" + }, + "flags": 0, + "description": "Specifies the next stage in the conversation after capturing the slot." + }, + "SlotConstraint": { + "type": { + "$ref": "#/126" + }, + "flags": 1, + "description": "Specifies whether the slot is required or optional." + }, + "WaitAndContinueSpecification": { + "type": { + "$ref": "#/125" + }, + "flags": 0, + "description": "Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input." + } + } + }, + { + "$type": "ObjectType", + "name": "SlotValueOverride", + "properties": { + "Shape": { + "type": { + "$ref": "#/126" + }, + "flags": 0, + "description": "When the shape value is List, it indicates that the values field contains a list of slot values. When the value is Scalar, it indicates that the value field contains a single value." + }, + "Value": { + "type": { + "$ref": "#/105" + }, + "flags": 0, + "description": "The current value of the slot." + }, + "Values": { + "type": { + "$ref": "#/164" + }, + "flags": 0, + "description": "A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be \"pepperoni\" and \"pineapple.\"" + } + } + }, + { + "$type": "ObjectType", + "name": "SlotValueOverrideMap", + "properties": { + "SlotName": { + "type": { + "$ref": "#/126" + }, + "flags": 0 + }, + "SlotValueOverride": { + "type": { + "$ref": "#/107" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SlotValueRegexFilter", + "properties": { + "Pattern": { + "type": { + "$ref": "#/126" + }, + "flags": 1, + "description": "Regex pattern" + } + } + }, + { + "$type": "ObjectType", + "name": "SlotValueResolutionStrategy", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SlotValueSelectionSetting", + "properties": { + "AdvancedRecognitionSetting": { + "type": { + "$ref": "#/0" + }, + "flags": 0 + }, + "RegexFilter": { + "type": { + "$ref": "#/109" + }, + "flags": 0 + }, + "ResolutionStrategy": { + "type": { + "$ref": "#/126" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "SlotValues", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "StillWaitingResponseFrequency", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "StillWaitingResponseSpecification", + "properties": { + "AllowInterrupt": { + "type": { + "$ref": "#/127" + }, + "flags": 0, + "description": "Indicates whether the user can interrupt a speech prompt from the bot." + }, + "FrequencyInSeconds": { + "type": { + "$ref": "#/128" + }, + "flags": 1 + }, + "MessageGroupsList": { + "type": { + "$ref": "#/166" + }, + "flags": 1 + }, + "TimeoutInSeconds": { + "type": { + "$ref": "#/128" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "StillWaitingResponseTimeout", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SynonymList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/126" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/126" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "ObjectType", + "name": "TestBotAliasSettings", + "properties": { + "BotAliasLocaleSettings": { + "type": { + "$ref": "#/168" + }, + "flags": 0 + }, + "ConversationLogSettings": { + "type": { + "$ref": "#/27" + }, + "flags": 0 + }, + "Description": { + "type": { + "$ref": "#/126" + }, + "flags": 0 + }, + "SentimentAnalysisSettings": { + "type": { + "$ref": "#/169" + }, + "flags": 0, + "description": "Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances." + } + } + }, + { + "$type": "ObjectType", + "name": "TextInputSpecification", + "properties": { + "StartTimeoutMs": { + "type": { + "$ref": "#/128" + }, + "flags": 1, + "description": "Time for which a bot waits before re-prompting a customer for text input." + } + } + }, + { + "$type": "ObjectType", + "name": "TextLogDestination", + "properties": { + "CloudWatch": { + "type": { + "$ref": "#/16" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TextLogSetting", + "properties": { + "Destination": { + "type": { + "$ref": "#/120" + }, + "flags": 1 + }, + "Enabled": { + "type": { + "$ref": "#/127" + }, + "flags": 1, + "description": "" + } + } + }, + { + "$type": "ObjectType", + "name": "TextLogSettings", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Utterance", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "VoiceSettings", + "properties": { + "Engine": { + "type": { + "$ref": "#/126" + }, + "flags": 0, + "description": "Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user. For more information, see the engine parameter of the SynthesizeSpeech operation in the Amazon Polly developer guide." + }, + "VoiceId": { + "type": { + "$ref": "#/126" + }, + "flags": 1, + "description": "The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user." + } + } + }, + { + "$type": "ObjectType", + "name": "WaitAndContinueSpecification", + "properties": { + "ContinueResponse": { + "type": { + "$ref": "#/82" + }, + "flags": 1, + "description": "The response that Amazon Lex sends to indicate that the bot is ready to continue the conversation." + }, + "IsActive": { + "type": { + "$ref": "#/127" + }, + "flags": 0, + "description": "Specifies whether the bot will wait for a user to respond." + }, + "StillWaitingResponse": { + "type": { + "$ref": "#/114" + }, + "flags": 0, + "description": "The response that Amazon Lex sends periodically to the user to indicate that the bot is still waiting for input from the user." + }, + "WaitingResponse": { + "type": { + "$ref": "#/82" + }, + "flags": 1, + "description": "The response that Amazon Lex sends to indicate that the bot is waiting for the conversation to continue." + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "BooleanType" + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/11" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/55" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/101" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/21" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/21" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/21" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/121" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/30" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/30" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/92" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/64" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/64" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/15" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/53" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/53" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/70" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/89" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/99" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/93" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/108" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/63" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/64" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/70" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/64" + } + }, + { + "$type": "ObjectType", + "name": "Bot_PromptAttemptsSpecification", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/64" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/89" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/96" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/99" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/103" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/91" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/103" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/89" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/107" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/107" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/64" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/91" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/11" + } + }, + { + "$type": "ObjectType", + "name": "Bot_SentimentAnalysisSettings", + "properties": { + "DetectSentiment": { + "type": { + "$ref": "#/127" + }, + "flags": 1, + "description": "Enable to call Amazon Comprehend for Sentiment natively within Lex" + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/121" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Lex/BotProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/14" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/117" + } + }, + { + "$type": "ObjectType", + "name": "Bot_DataPrivacy", + "properties": { + "ChildDirected": { + "type": { + "$ref": "#/127" + }, + "flags": 1, + "description": "" + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/117" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Lex/BotProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/126" + }, + "flags": 2 + }, + "AutoBuildBotLocales": { + "type": { + "$ref": "#/127" + }, + "flags": 4, + "description": "Specifies whether to build the bot locales after bot creation completes." + }, + "BotFileS3Location": { + "type": { + "$ref": "#/86" + }, + "flags": 4 + }, + "BotLocales": { + "type": { + "$ref": "#/172" + }, + "flags": 4, + "description": "List of bot locales" + }, + "BotTags": { + "type": { + "$ref": "#/173" + }, + "flags": 4, + "description": "A list of tags to add to the bot, which can only be added at bot creation." + }, + "DataPrivacy": { + "type": { + "$ref": "#/174" + }, + "flags": 1, + "description": "Data privacy setting of the Bot." + }, + "Description": { + "type": { + "$ref": "#/126" + }, + "flags": 0 + }, + "Id": { + "type": { + "$ref": "#/126" + }, + "flags": 18 + }, + "IdleSessionTTLInSeconds": { + "type": { + "$ref": "#/128" + }, + "flags": 1, + "description": "IdleSessionTTLInSeconds of the resource" + }, + "Name": { + "type": { + "$ref": "#/126" + }, + "flags": 1 + }, + "RoleArn": { + "type": { + "$ref": "#/126" + }, + "flags": 1 + }, + "TestBotAliasSettings": { + "type": { + "$ref": "#/118" + }, + "flags": 0 + }, + "TestBotAliasTags": { + "type": { + "$ref": "#/175" + }, + "flags": 4, + "description": "A list of tags to add to the test alias for a bot, , which can only be added at bot/bot alias creation." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Lex/Bot", + "properties": { + "name": { + "type": { + "$ref": "#/126" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/126" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/176" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Lex/Bot@default", + "scopeType": 0, + "body": { + "$ref": "#/177" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Arn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AudioLogDestination", + "properties": { + "S3Bucket": { + "type": { + "$ref": "#/196" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AudioLogSetting", + "properties": { + "Destination": { + "type": { + "$ref": "#/180" + }, + "flags": 1 + }, + "Enabled": { + "type": { + "$ref": "#/127" + }, + "flags": 1, + "description": "" + } + } + }, + { + "$type": "ObjectType", + "name": "AudioLogSettings", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "BotAliasLocaleSettings", + "properties": { + "CodeHookSpecification": { + "type": { + "$ref": "#/189" + }, + "flags": 0 + }, + "Enabled": { + "type": { + "$ref": "#/127" + }, + "flags": 1, + "description": "Whether the Lambda code hook is enabled" + } + } + }, + { + "$type": "ObjectType", + "name": "BotAliasLocaleSettingsItem", + "properties": { + "BotAliasLocaleSetting": { + "type": { + "$ref": "#/183" + }, + "flags": 1 + }, + "LocaleId": { + "type": { + "$ref": "#/126" + }, + "flags": 1, + "description": "A string used to identify the locale" + } + } + }, + { + "$type": "ObjectType", + "name": "BotAliasLocaleSettingsList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "BotAliasStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "BotVersion", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CloudWatchLogGroupLogDestination", + "properties": { + "CloudWatchLogGroupArn": { + "type": { + "$ref": "#/126" + }, + "flags": 1, + "description": "A string used to identify the groupArn for the Cloudwatch Log Group" + }, + "LogPrefix": { + "type": { + "$ref": "#/126" + }, + "flags": 1, + "description": "A string containing the value for the Log Prefix" + } + } + }, + { + "$type": "ObjectType", + "name": "CodeHookSpecification", + "properties": { + "LambdaCodeHook": { + "type": { + "$ref": "#/193" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ConversationLogSettings", + "properties": { + "AudioLogSettings": { + "type": { + "$ref": "#/203" + }, + "flags": 0 + }, + "TextLogSettings": { + "type": { + "$ref": "#/204" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Description", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Id", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LambdaCodeHook", + "properties": { + "CodeHookInterfaceVersion": { + "type": { + "$ref": "#/126" + }, + "flags": 1, + "description": "The version of the request-response that you want Amazon Lex to use to invoke your Lambda function." + }, + "LambdaArn": { + "type": { + "$ref": "#/126" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of the Lambda function." + } + } + }, + { + "$type": "ObjectType", + "name": "LocaleId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Name", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "S3BucketLogDestination", + "properties": { + "KmsKeyArn": { + "type": { + "$ref": "#/126" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key for encrypting audio log files stored in an S3 bucket." + }, + "LogPrefix": { + "type": { + "$ref": "#/126" + }, + "flags": 1, + "description": "The Amazon S3 key of the deployment package." + }, + "S3BucketArn": { + "type": { + "$ref": "#/126" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/126" + }, + "flags": 1, + "description": "A string used to identify this tag" + }, + "Value": { + "type": { + "$ref": "#/126" + }, + "flags": 1, + "description": "A string containing the value for the tag" + } + } + }, + { + "$type": "ObjectType", + "name": "TextLogDestination", + "properties": { + "CloudWatch": { + "type": { + "$ref": "#/188" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TextLogSetting", + "properties": { + "Destination": { + "type": { + "$ref": "#/198" + }, + "flags": 1 + }, + "Enabled": { + "type": { + "$ref": "#/127" + }, + "flags": 1, + "description": "" + } + } + }, + { + "$type": "ObjectType", + "name": "TextLogSettings", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/181" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/184" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/181" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/199" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/199" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Lex/BotAliasProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/184" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/197" + } + }, + { + "$type": "ObjectType", + "name": "BotAlias_SentimentAnalysisSettings", + "properties": { + "DetectSentiment": { + "type": { + "$ref": "#/127" + }, + "flags": 1, + "description": "Enable to call Amazon Comprehend for Sentiment natively within Lex" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Lex/BotAliasProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/126" + }, + "flags": 2 + }, + "BotAliasId": { + "type": { + "$ref": "#/126" + }, + "flags": 18 + }, + "BotAliasLocaleSettings": { + "type": { + "$ref": "#/207" + }, + "flags": 0 + }, + "BotAliasName": { + "type": { + "$ref": "#/126" + }, + "flags": 1 + }, + "BotAliasStatus": { + "type": { + "$ref": "#/126" + }, + "flags": 2 + }, + "BotAliasTags": { + "type": { + "$ref": "#/208" + }, + "flags": 4, + "description": "A list of tags to add to the bot alias." + }, + "BotId": { + "type": { + "$ref": "#/126" + }, + "flags": 17 + }, + "BotVersion": { + "type": { + "$ref": "#/126" + }, + "flags": 0 + }, + "ConversationLogSettings": { + "type": { + "$ref": "#/190" + }, + "flags": 0 + }, + "Description": { + "type": { + "$ref": "#/126" + }, + "flags": 0 + }, + "SentimentAnalysisSettings": { + "type": { + "$ref": "#/209" + }, + "flags": 0, + "description": "Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Lex/BotAlias", + "properties": { + "name": { + "type": { + "$ref": "#/126" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/126" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/210" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Lex/BotAlias@default", + "scopeType": 0, + "body": { + "$ref": "#/211" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "PhysicalId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Policy", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ResourceArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RevisionId", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.Lex/ResourcePolicyProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.Lex/ResourcePolicyProperties", + "properties": { + "Id": { + "type": { + "$ref": "#/126" + }, + "flags": 18 + }, + "Policy": { + "type": { + "$ref": "#/214" + }, + "flags": 1 + }, + "ResourceArn": { + "type": { + "$ref": "#/126" + }, + "flags": 1 + }, + "RevisionId": { + "type": { + "$ref": "#/126" + }, + "flags": 2 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Lex/ResourcePolicy", + "properties": { + "name": { + "type": { + "$ref": "#/126" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/126" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/218" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Lex/ResourcePolicy@default", + "scopeType": 0, + "body": { + "$ref": "#/219" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.lex/default/types.md b/artifacts/bicep/aws/aws.lex/default/types.md index 0d1c16ca..d75325e1 100644 --- a/artifacts/bicep/aws/aws.lex/default/types.md +++ b/artifacts/bicep/aws/aws.lex/default/types.md @@ -3,23 +3,59 @@ ## Resource AWS.Lex/Bot@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Lex/BotProperties](#awslexbotproperties) (Required): properties of the resource +* **properties**: [AWS.Lex/BotProperties](#awslexbotproperties) (Required, Identifier): properties of the resource ## Resource AWS.Lex/BotAlias@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Lex/BotAliasProperties](#awslexbotaliasproperties) (Required): properties of the resource +* **properties**: [AWS.Lex/BotAliasProperties](#awslexbotaliasproperties) (Required, Identifier): properties of the resource ## Resource AWS.Lex/ResourcePolicy@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Lex/ResourcePolicyProperties](#awslexresourcepolicyproperties) (Required): properties of the resource +* **properties**: [AWS.Lex/ResourcePolicyProperties](#awslexresourcepolicyproperties) (Required, Identifier): properties of the resource + +## AdvancedRecognitionSetting +### Properties +* **AudioRecognitionStrategy**: string + +## AudioLogDestination +### Properties +* **S3Bucket**: [S3BucketLogDestination](#s3bucketlogdestination) (Required) + +## AudioLogDestination +### Properties +* **S3Bucket**: [S3BucketLogDestination](#s3bucketlogdestination) (Required) + +## AudioLogSetting +### Properties +* **Destination**: [AudioLogDestination](#audiologdestination) (Required) +* **Enabled**: bool (Required) + +## AudioLogSetting +### Properties +* **Destination**: [AudioLogDestination](#audiologdestination) (Required) +* **Enabled**: bool (Required) + +## AWS.Lex/BotAliasProperties +### Properties +* **Arn**: string (ReadOnly) +* **BotAliasId**: string (ReadOnly, Identifier) +* **BotAliasLocaleSettings**: [BotAliasLocaleSettingsItem](#botaliaslocalesettingsitem)[] +* **BotAliasName**: string (Required) +* **BotAliasStatus**: string (ReadOnly) +* **BotAliasTags**: [Tag](#tag)[] (WriteOnly): A list of tags to add to the bot alias. +* **BotId**: string (Required, Identifier) +* **BotVersion**: string +* **ConversationLogSettings**: [ConversationLogSettings](#conversationlogsettings) +* **Description**: string +* **SentimentAnalysisSettings**: [BotAlias_SentimentAnalysisSettings](#botaliassentimentanalysissettings): Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances. ## AWS.Lex/BotProperties ### Properties @@ -37,11 +73,47 @@ * **TestBotAliasSettings**: [TestBotAliasSettings](#testbotaliassettings) * **TestBotAliasTags**: [Tag](#tag)[] (WriteOnly): A list of tags to add to the test alias for a bot, , which can only be added at bot/bot alias creation. -## S3Location +## AWS.Lex/ResourcePolicyProperties +### Properties +* **Id**: string (ReadOnly, Identifier) +* **Policy**: [Policy](#policy) (Required) +* **ResourceArn**: string (Required) +* **RevisionId**: string (ReadOnly) + +## Bot_DataPrivacy +### Properties +* **ChildDirected**: bool (Required) + +## Bot_PromptAttemptsSpecification ### Properties -* **S3Bucket**: string (Required): An Amazon S3 bucket in the same AWS Region as your function. The bucket can be in a different AWS account. -* **S3ObjectKey**: string (Required): The Amazon S3 key of the deployment package. -* **S3ObjectVersion**: string: For versioned objects, the version of the deployment package object to use. If not specified, the current object version will be used. + +## Bot_SentimentAnalysisSettings +### Properties +* **DetectSentiment**: bool (Required): Enable to call Amazon Comprehend for Sentiment natively within Lex + +## BotAlias_SentimentAnalysisSettings +### Properties +* **DetectSentiment**: bool (Required): Enable to call Amazon Comprehend for Sentiment natively within Lex + +## BotAliasLocaleSettings +### Properties +* **CodeHookSpecification**: [CodeHookSpecification](#codehookspecification) +* **Enabled**: bool (Required): Whether the Lambda code hook is enabled + +## BotAliasLocaleSettings +### Properties +* **CodeHookSpecification**: [CodeHookSpecification](#codehookspecification) +* **Enabled**: bool (Required): Whether the Lambda code hook is enabled + +## BotAliasLocaleSettingsItem +### Properties +* **BotAliasLocaleSetting**: [BotAliasLocaleSettings](#botaliaslocalesettings) (Required) +* **LocaleId**: string (Required): A string used to identify the locale + +## BotAliasLocaleSettingsItem +### Properties +* **BotAliasLocaleSetting**: [BotAliasLocaleSettings](#botaliaslocalesettings) (Required) +* **LocaleId**: string (Required): A string used to identify the locale ## BotLocale ### Properties @@ -53,127 +125,91 @@ * **SlotTypes**: [SlotType](#slottype)[]: List of SlotTypes * **VoiceSettings**: [VoiceSettings](#voicesettings) -## CustomVocabulary -### Properties -* **CustomVocabularyItems**: [CustomVocabularyItem](#customvocabularyitem)[] (Required) - -## CustomVocabularyItem -### Properties -* **DisplayAs**: string: Defines how you want your phrase to look in your transcription output. -* **Phrase**: string (Required): Phrase that should be recognized. -* **Weight**: int: The degree to which the phrase recognition is boosted. The weight 0 means that no boosting will be applied and the entry will only be used for performing replacements using the displayAs field. - -## Intent +## Button ### Properties -* **Description**: string: Description of thr intent. -* **DialogCodeHook**: [DialogCodeHookSetting](#dialogcodehooksetting) -* **FulfillmentCodeHook**: [FulfillmentCodeHookSetting](#fulfillmentcodehooksetting) -* **InitialResponseSetting**: [InitialResponseSetting](#initialresponsesetting): Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots. -* **InputContexts**: [InputContext](#inputcontext)[] -* **IntentClosingSetting**: [IntentClosingSetting](#intentclosingsetting) -* **IntentConfirmationSetting**: [IntentConfirmationSetting](#intentconfirmationsetting) -* **KendraConfiguration**: [KendraConfiguration](#kendraconfiguration) -* **Name**: string (Required): The name of the intent. -* **OutputContexts**: [OutputContext](#outputcontext)[] -* **ParentIntentSignature**: string -* **SampleUtterances**: [SampleUtterance](#sampleutterance)[]: A sample utterance that invokes an intent or respond to a slot elicitation prompt. -* **SlotPriorities**: [SlotPriority](#slotpriority)[] -* **Slots**: [Slot](#slot)[]: List of slots +* **Text**: string (Required): The text that appears on the button. +* **Value**: string (Required): The value returned to Amazon Lex when the user chooses this button. -## DialogCodeHookSetting +## CloudWatchLogGroupLogDestination ### Properties -* **Enabled**: bool (Required) +* **CloudWatchLogGroupArn**: string (Required): A string used to identify the groupArn for the Cloudwatch Log Group +* **LogPrefix**: string (Required): A string containing the value for the Log Prefix -## FulfillmentCodeHookSetting +## CloudWatchLogGroupLogDestination ### Properties -* **Enabled**: bool (Required) -* **FulfillmentUpdatesSpecification**: [FulfillmentUpdatesSpecification](#fulfillmentupdatesspecification) -* **IsActive**: bool: Determines whether the fulfillment code hook is used. When active is false, the code hook doesn't run. -* **PostFulfillmentStatusSpecification**: [PostFulfillmentStatusSpecification](#postfulfillmentstatusspecification) +* **CloudWatchLogGroupArn**: string (Required): A string used to identify the groupArn for the Cloudwatch Log Group +* **LogPrefix**: string (Required): A string containing the value for the Log Prefix -## FulfillmentUpdatesSpecification +## CodeHookSpecification ### Properties -* **Active**: bool (Required): Determines whether fulfillment updates are sent to the user. When this field is true, updates are sent. -* **StartResponse**: [FulfillmentStartResponseSpecification](#fulfillmentstartresponsespecification) -* **TimeoutInSeconds**: int: The length of time that the fulfillment Lambda function should run before it times out. -* **UpdateResponse**: [FulfillmentUpdateResponseSpecification](#fulfillmentupdateresponsespecification) +* **LambdaCodeHook**: [LambdaCodeHook](#lambdacodehook) (Required) -## FulfillmentStartResponseSpecification +## CodeHookSpecification ### Properties -* **AllowInterrupt**: bool: Determines whether the user can interrupt the start message while it is playing. -* **DelayInSeconds**: int (Required): The delay between when the Lambda fulfillment function starts running and the start message is played. If the Lambda function returns before the delay is over, the start message isn't played. -* **MessageGroups**: [MessageGroup](#messagegroup)[] (Required) +* **LambdaCodeHook**: [LambdaCodeHook](#lambdacodehook) (Required) -## MessageGroup +## Condition ### Properties -* **Message**: [Message](#message) (Required) -* **Variations**: [Message](#message)[]: Message variations to send to the user. +* **ExpressionString**: string (Required): The expression string that is evaluated. -## Message +## ConditionalBranch ### Properties -* **CustomPayload**: [CustomPayload](#custompayload) -* **ImageResponseCard**: [ImageResponseCard](#imageresponsecard) -* **PlainTextMessage**: [PlainTextMessage](#plaintextmessage) -* **SSMLMessage**: [SSMLMessage](#ssmlmessage) +* **Condition**: [Condition](#condition) (Required): Contains the expression to evaluate. If the condition is true, the branch's actions are taken. +* **Name**: string (Required): The name of the branch. +* **NextStep**: [DialogState](#dialogstate) (Required): The next step in the conversation. +* **Response**: [ResponseSpecification](#responsespecification): Specifies a list of message groups that Amazon Lex uses to respond the user input. -## CustomPayload +## ConditionalSpecification ### Properties -* **Value**: string (Required): The string that is sent to your application. +* **ConditionalBranches**: [ConditionalBranch](#conditionalbranch)[] (Required): A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true. +* **DefaultBranch**: [DefaultConditionalBranch](#defaultconditionalbranch) (Required): The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step. +* **IsActive**: bool (Required): Determines whether a conditional branch is active. When active is false, the conditions are not evaluated. -## ImageResponseCard +## ConversationLogSettings ### Properties -* **Buttons**: [Button](#button)[]: A list of buttons that should be displayed on the response card. -* **ImageUrl**: string: The URL of an image to display on the response card. -* **Subtitle**: string: The subtitle to display on the response card. -* **Title**: string (Required): The title to display on the response card. +* **AudioLogSettings**: [AudioLogSetting](#audiologsetting)[] +* **TextLogSettings**: [TextLogSetting](#textlogsetting)[] -## Button +## ConversationLogSettings ### Properties -* **Text**: string (Required): The text that appears on the button. -* **Value**: string (Required): The value returned to Amazon Lex when the user chooses this button. +* **AudioLogSettings**: [AudioLogSetting](#audiologsetting)[] +* **TextLogSettings**: [TextLogSetting](#textlogsetting)[] -## PlainTextMessage +## CustomPayload ### Properties -* **Value**: string (Required): The message to send to the user. +* **Value**: string (Required): The string that is sent to your application. -## SSMLMessage +## CustomVocabulary ### Properties -* **Value**: string (Required): The SSML text that defines the prompt. +* **CustomVocabularyItems**: [CustomVocabularyItem](#customvocabularyitem)[] (Required) -## FulfillmentUpdateResponseSpecification +## CustomVocabularyItem ### Properties -* **AllowInterrupt**: bool: Determines whether the user can interrupt an update message while it is playing. -* **FrequencyInSeconds**: int (Required): The frequency that a message is sent to the user. When the period ends, Amazon Lex chooses a message from the message groups and plays it to the user. If the fulfillment Lambda returns before the first period ends, an update message is not played to the user. -* **MessageGroups**: [MessageGroup](#messagegroup)[] (Required) +* **DisplayAs**: string: Defines how you want your phrase to look in your transcription output. +* **Phrase**: string (Required): Phrase that should be recognized. +* **Weight**: int: The degree to which the phrase recognition is boosted. The weight 0 means that no boosting will be applied and the entry will only be used for performing replacements using the displayAs field. -## PostFulfillmentStatusSpecification +## DefaultConditionalBranch ### Properties -* **FailureConditional**: [ConditionalSpecification](#conditionalspecification): A list of conditional branches to evaluate after the fulfillment code hook throws an exception or returns with the State field of the Intent object set to Failed. -* **FailureNextStep**: [DialogState](#dialogstate): Specifies the next step the bot runs after the fulfillment code hook throws an exception or returns with the State field of the Intent object set to Failed. -* **FailureResponse**: [ResponseSpecification](#responsespecification): Specifies a list of message groups that Amazon Lex uses to respond the user input. -* **SuccessConditional**: [ConditionalSpecification](#conditionalspecification): A list of conditional branches to evaluate after the fulfillment code hook finishes successfully. -* **SuccessNextStep**: [DialogState](#dialogstate): Specifies the next step in the conversation that Amazon Lex invokes when the fulfillment code hook completes successfully. -* **SuccessResponse**: [ResponseSpecification](#responsespecification): Specifies a list of message groups that Amazon Lex uses to respond the user input. -* **TimeoutConditional**: [ConditionalSpecification](#conditionalspecification): A list of conditional branches to evaluate if the fulfillment code hook times out. -* **TimeoutNextStep**: [DialogState](#dialogstate): Specifies the next step that the bot runs when the fulfillment code hook times out. -* **TimeoutResponse**: [ResponseSpecification](#responsespecification): Specifies a list of message groups that Amazon Lex uses to respond the user input. +* **NextStep**: [DialogState](#dialogstate): The next step in the conversation. +* **Response**: [ResponseSpecification](#responsespecification): Specifies a list of message groups that Amazon Lex uses to respond the user input. -## ConditionalSpecification +## DialogAction ### Properties -* **ConditionalBranches**: [ConditionalBranch](#conditionalbranch)[] (Required): A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true. -* **DefaultBranch**: [DefaultConditionalBranch](#defaultconditionalbranch) (Required): The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step. -* **IsActive**: bool (Required): Determines whether a conditional branch is active. When active is false, the conditions are not evaluated. +* **SlotToElicit**: string: If the dialog action is ElicitSlot, defines the slot to elicit from the user. +* **SuppressNextMessage**: bool: When true the next message for the intent is not used. +* **Type**: string (Required): The action that the bot should execute. -## ConditionalBranch +## DialogCodeHookInvocationSetting ### Properties -* **Condition**: [Condition](#condition) (Required): Contains the expression to evaluate. If the condition is true, the branch's actions are taken. -* **Name**: string (Required): The name of the branch. -* **NextStep**: [DialogState](#dialogstate) (Required): The next step in the conversation. -* **Response**: [ResponseSpecification](#responsespecification): Specifies a list of message groups that Amazon Lex uses to respond the user input. +* **EnableCodeHookInvocation**: bool (Required): Indicates whether a Lambda function should be invoked for the dialog. +* **InvocationLabel**: string: A label that indicates the dialog step from which the dialog code hook is happening. +* **IsActive**: bool (Required): Determines whether a dialog code hook is used when the intent is activated. +* **PostCodeHookSpecification**: [PostDialogCodeHookInvocationSpecification](#postdialogcodehookinvocationspecification) (Required): Contains the responses and actions that Amazon Lex takes after the Lambda function is complete. -## Condition +## DialogCodeHookSetting ### Properties -* **ExpressionString**: string (Required): The expression string that is evaluated. +* **Enabled**: bool (Required) ## DialogState ### Properties @@ -181,46 +217,57 @@ * **Intent**: [IntentOverride](#intentoverride): Override settings to configure the intent state. * **SessionAttributes**: [SessionAttribute](#sessionattribute)[]: List of session attributes to be applied when the conversation reaches this step. -## DialogAction +## ElicitationCodeHookInvocationSetting ### Properties -* **SlotToElicit**: string: If the dialog action is ElicitSlot, defines the slot to elicit from the user. -* **SuppressNextMessage**: bool: When true the next message for the intent is not used. -* **Type**: string (Required): The action that the bot should execute. +* **EnableCodeHookInvocation**: bool (Required): Indicates whether a Lambda function should be invoked for the dialog. +* **InvocationLabel**: string: A label that indicates the dialog step from which the dialog code hook is happening. -## IntentOverride +## ExternalSourceSetting ### Properties -* **Name**: string: The name of the intent. Only required when you're switching intents. -* **Slots**: [SlotValueOverrideMap](#slotvalueoverridemap)[]: A map of all of the slot value overrides for the intent. +* **GrammarSlotTypeSetting**: [GrammarSlotTypeSetting](#grammarslottypesetting) -## SlotValueOverrideMap +## FulfillmentCodeHookSetting ### Properties -* **SlotName**: string -* **SlotValueOverride**: [SlotValueOverride](#slotvalueoverride) +* **Enabled**: bool (Required) +* **FulfillmentUpdatesSpecification**: [FulfillmentUpdatesSpecification](#fulfillmentupdatesspecification) +* **IsActive**: bool: Determines whether the fulfillment code hook is used. When active is false, the code hook doesn't run. +* **PostFulfillmentStatusSpecification**: [PostFulfillmentStatusSpecification](#postfulfillmentstatusspecification) -## SlotValueOverride +## FulfillmentStartResponseSpecification ### Properties -* **Shape**: string: When the shape value is List, it indicates that the values field contains a list of slot values. When the value is Scalar, it indicates that the value field contains a single value. -* **Value**: [SlotValue](#slotvalue): The current value of the slot. -* **Values**: [SlotValueOverride](#slotvalueoverride)[]: A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple." +* **AllowInterrupt**: bool: Determines whether the user can interrupt the start message while it is playing. +* **DelayInSeconds**: int (Required): The delay between when the Lambda fulfillment function starts running and the start message is played. If the Lambda function returns before the delay is over, the start message isn't played. +* **MessageGroups**: [MessageGroup](#messagegroup)[] (Required) -## SlotValue +## FulfillmentUpdateResponseSpecification ### Properties -* **InterpretedValue**: string: The value that Amazon Lex determines for the slot. +* **AllowInterrupt**: bool: Determines whether the user can interrupt an update message while it is playing. +* **FrequencyInSeconds**: int (Required): The frequency that a message is sent to the user. When the period ends, Amazon Lex chooses a message from the message groups and plays it to the user. If the fulfillment Lambda returns before the first period ends, an update message is not played to the user. +* **MessageGroups**: [MessageGroup](#messagegroup)[] (Required) -## SessionAttribute +## FulfillmentUpdatesSpecification ### Properties -* **Key**: string (Required) -* **Value**: string +* **Active**: bool (Required): Determines whether fulfillment updates are sent to the user. When this field is true, updates are sent. +* **StartResponse**: [FulfillmentStartResponseSpecification](#fulfillmentstartresponsespecification) +* **TimeoutInSeconds**: int: The length of time that the fulfillment Lambda function should run before it times out. +* **UpdateResponse**: [FulfillmentUpdateResponseSpecification](#fulfillmentupdateresponsespecification) -## ResponseSpecification +## GrammarSlotTypeSetting ### Properties -* **AllowInterrupt**: bool: Indicates whether the user can interrupt a speech prompt from the bot. -* **MessageGroupsList**: [MessageGroup](#messagegroup)[] (Required) +* **Source**: [GrammarSlotTypeSource](#grammarslottypesource) -## DefaultConditionalBranch +## GrammarSlotTypeSource ### Properties -* **NextStep**: [DialogState](#dialogstate): The next step in the conversation. -* **Response**: [ResponseSpecification](#responsespecification): Specifies a list of message groups that Amazon Lex uses to respond the user input. +* **KmsKeyArn**: string: The Amazon KMS key required to decrypt the contents of the grammar, if any. +* **S3BucketName**: string (Required): The name of the S3 bucket that contains the grammar source. +* **S3ObjectKey**: string (Required): The path to the grammar in the S3 bucket. + +## ImageResponseCard +### Properties +* **Buttons**: [Button](#button)[]: A list of buttons that should be displayed on the response card. +* **ImageUrl**: string: The URL of an image to display on the response card. +* **Subtitle**: string: The subtitle to display on the response card. +* **Title**: string (Required): The title to display on the response card. ## InitialResponseSetting ### Properties @@ -229,29 +276,27 @@ * **InitialResponse**: [ResponseSpecification](#responsespecification): Specifies a list of message groups that Amazon Lex uses to respond the user input. * **NextStep**: [DialogState](#dialogstate): The next step in the conversation. -## DialogCodeHookInvocationSetting -### Properties -* **EnableCodeHookInvocation**: bool (Required): Indicates whether a Lambda function should be invoked for the dialog. -* **InvocationLabel**: string: A label that indicates the dialog step from which the dialog code hook is happening. -* **IsActive**: bool (Required): Determines whether a dialog code hook is used when the intent is activated. -* **PostCodeHookSpecification**: [PostDialogCodeHookInvocationSpecification](#postdialogcodehookinvocationspecification) (Required): Contains the responses and actions that Amazon Lex takes after the Lambda function is complete. - -## PostDialogCodeHookInvocationSpecification -### Properties -* **FailureConditional**: [ConditionalSpecification](#conditionalspecification): A list of conditional branches to evaluate after the dialog code hook throws an exception or returns with the State field of the Intent object set to Failed. -* **FailureNextStep**: [DialogState](#dialogstate): Specifies the next step the bot runs after the dialog code hook throws an exception or returns with the State field of the Intent object set to Failed. -* **FailureResponse**: [ResponseSpecification](#responsespecification): Specifies a list of message groups that Amazon Lex uses to respond the user input. -* **SuccessConditional**: [ConditionalSpecification](#conditionalspecification): A list of conditional branches to evaluate after the dialog code hook finishes successfully. -* **SuccessNextStep**: [DialogState](#dialogstate): Specifics the next step the bot runs after the dialog code hook finishes successfully. -* **SuccessResponse**: [ResponseSpecification](#responsespecification): Specifies a list of message groups that Amazon Lex uses to respond the user input. -* **TimeoutConditional**: [ConditionalSpecification](#conditionalspecification): A list of conditional branches to evaluate if the code hook times out. -* **TimeoutNextStep**: [DialogState](#dialogstate): Specifies the next step that the bot runs when the code hook times out. -* **TimeoutResponse**: [ResponseSpecification](#responsespecification): Specifies a list of message groups that Amazon Lex uses to respond the user input. - ## InputContext ### Properties * **Name**: string (Required): The name of the context. +## Intent +### Properties +* **Description**: string: Description of thr intent. +* **DialogCodeHook**: [DialogCodeHookSetting](#dialogcodehooksetting) +* **FulfillmentCodeHook**: [FulfillmentCodeHookSetting](#fulfillmentcodehooksetting) +* **InitialResponseSetting**: [InitialResponseSetting](#initialresponsesetting): Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots. +* **InputContexts**: [InputContext](#inputcontext)[] +* **IntentClosingSetting**: [IntentClosingSetting](#intentclosingsetting) +* **IntentConfirmationSetting**: [IntentConfirmationSetting](#intentconfirmationsetting) +* **KendraConfiguration**: [KendraConfiguration](#kendraconfiguration) +* **Name**: string (Required): The name of the intent. +* **OutputContexts**: [OutputContext](#outputcontext)[] +* **ParentIntentSignature**: string +* **SampleUtterances**: [SampleUtterance](#sampleutterance)[]: A sample utterance that invokes an intent or respond to a slot elicitation prompt. +* **SlotPriorities**: [SlotPriority](#slotpriority)[] +* **Slots**: [Slot](#slot)[]: List of slots + ## IntentClosingSetting ### Properties * **ClosingResponse**: [ResponseSpecification](#responsespecification): The response that Amazon Lex sends to the user when the intent is complete. @@ -275,10 +320,83 @@ * **IsActive**: bool: Specifies whether the intent's confirmation is sent to the user. When this field is false, confirmation and declination responses aren't sent. If the active field isn't specified, the default is true. * **PromptSpecification**: [PromptSpecification](#promptspecification) (Required): Prompts the user to confirm the intent. This question should have a yes or no answer. -## ElicitationCodeHookInvocationSetting +## IntentOverride ### Properties -* **EnableCodeHookInvocation**: bool (Required): Indicates whether a Lambda function should be invoked for the dialog. -* **InvocationLabel**: string: A label that indicates the dialog step from which the dialog code hook is happening. +* **Name**: string: The name of the intent. Only required when you're switching intents. +* **Slots**: [SlotValueOverrideMap](#slotvalueoverridemap)[]: A map of all of the slot value overrides for the intent. + +## KendraConfiguration +### Properties +* **KendraIndex**: string (Required) +* **QueryFilterString**: string +* **QueryFilterStringEnabled**: bool: Determines whether the AMAZON.KendraSearchIntent intent uses a custom query string to query the Amazon Kendra index. + +## LambdaCodeHook +### Properties +* **CodeHookInterfaceVersion**: string (Required): The version of the request-response that you want Amazon Lex to use to invoke your Lambda function. +* **LambdaArn**: string (Required): The Amazon Resource Name (ARN) of the Lambda function. + +## LambdaCodeHook +### Properties +* **CodeHookInterfaceVersion**: string (Required): The version of the request-response that you want Amazon Lex to use to invoke your Lambda function. +* **LambdaArn**: string (Required): The Amazon Resource Name (ARN) of the Lambda function. + +## Message +### Properties +* **CustomPayload**: [CustomPayload](#custompayload) +* **ImageResponseCard**: [ImageResponseCard](#imageresponsecard) +* **PlainTextMessage**: [PlainTextMessage](#plaintextmessage) +* **SSMLMessage**: [SSMLMessage](#ssmlmessage) + +## MessageGroup +### Properties +* **Message**: [Message](#message) (Required) +* **Variations**: [Message](#message)[]: Message variations to send to the user. + +## MultipleValuesSetting +### Properties +* **AllowMultipleValues**: bool + +## ObfuscationSetting +### Properties +* **ObfuscationSettingType**: string (Required): Value that determines whether Amazon Lex obscures slot values in conversation logs. The default is to obscure the values. + +## OutputContext +### Properties +* **Name**: string (Required) +* **TimeToLiveInSeconds**: int (Required) +* **TurnsToLive**: int (Required) + +## PlainTextMessage +### Properties +* **Value**: string (Required): The message to send to the user. + +## Policy +### Properties + +## PostDialogCodeHookInvocationSpecification +### Properties +* **FailureConditional**: [ConditionalSpecification](#conditionalspecification): A list of conditional branches to evaluate after the dialog code hook throws an exception or returns with the State field of the Intent object set to Failed. +* **FailureNextStep**: [DialogState](#dialogstate): Specifies the next step the bot runs after the dialog code hook throws an exception or returns with the State field of the Intent object set to Failed. +* **FailureResponse**: [ResponseSpecification](#responsespecification): Specifies a list of message groups that Amazon Lex uses to respond the user input. +* **SuccessConditional**: [ConditionalSpecification](#conditionalspecification): A list of conditional branches to evaluate after the dialog code hook finishes successfully. +* **SuccessNextStep**: [DialogState](#dialogstate): Specifics the next step the bot runs after the dialog code hook finishes successfully. +* **SuccessResponse**: [ResponseSpecification](#responsespecification): Specifies a list of message groups that Amazon Lex uses to respond the user input. +* **TimeoutConditional**: [ConditionalSpecification](#conditionalspecification): A list of conditional branches to evaluate if the code hook times out. +* **TimeoutNextStep**: [DialogState](#dialogstate): Specifies the next step that the bot runs when the code hook times out. +* **TimeoutResponse**: [ResponseSpecification](#responsespecification): Specifies a list of message groups that Amazon Lex uses to respond the user input. + +## PostFulfillmentStatusSpecification +### Properties +* **FailureConditional**: [ConditionalSpecification](#conditionalspecification): A list of conditional branches to evaluate after the fulfillment code hook throws an exception or returns with the State field of the Intent object set to Failed. +* **FailureNextStep**: [DialogState](#dialogstate): Specifies the next step the bot runs after the fulfillment code hook throws an exception or returns with the State field of the Intent object set to Failed. +* **FailureResponse**: [ResponseSpecification](#responsespecification): Specifies a list of message groups that Amazon Lex uses to respond the user input. +* **SuccessConditional**: [ConditionalSpecification](#conditionalspecification): A list of conditional branches to evaluate after the fulfillment code hook finishes successfully. +* **SuccessNextStep**: [DialogState](#dialogstate): Specifies the next step in the conversation that Amazon Lex invokes when the fulfillment code hook completes successfully. +* **SuccessResponse**: [ResponseSpecification](#responsespecification): Specifies a list of message groups that Amazon Lex uses to respond the user input. +* **TimeoutConditional**: [ConditionalSpecification](#conditionalspecification): A list of conditional branches to evaluate if the fulfillment code hook times out. +* **TimeoutNextStep**: [DialogState](#dialogstate): Specifies the next step that the bot runs when the fulfillment code hook times out. +* **TimeoutResponse**: [ResponseSpecification](#responsespecification): Specifies a list of message groups that Amazon Lex uses to respond the user input. ## PromptSpecification ### Properties @@ -288,29 +406,41 @@ * **MessageSelectionStrategy**: string * **PromptAttemptsSpecification**: [Bot_PromptAttemptsSpecification](#botpromptattemptsspecification): Specifies the advanced settings on each attempt of the prompt. -## Bot_PromptAttemptsSpecification +## ResponseSpecification ### Properties +* **AllowInterrupt**: bool: Indicates whether the user can interrupt a speech prompt from the bot. +* **MessageGroupsList**: [MessageGroup](#messagegroup)[] (Required) -## KendraConfiguration +## S3BucketLogDestination ### Properties -* **KendraIndex**: string (Required) -* **QueryFilterString**: string -* **QueryFilterStringEnabled**: bool: Determines whether the AMAZON.KendraSearchIntent intent uses a custom query string to query the Amazon Kendra index. +* **KmsKeyArn**: string: The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key for encrypting audio log files stored in an S3 bucket. +* **LogPrefix**: string (Required): The Amazon S3 key of the deployment package. +* **S3BucketArn**: string (Required): The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored. + +## S3BucketLogDestination +### Properties +* **KmsKeyArn**: string: The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key for encrypting audio log files stored in an S3 bucket. +* **LogPrefix**: string (Required): The Amazon S3 key of the deployment package. +* **S3BucketArn**: string (Required): The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored. -## OutputContext +## S3Location ### Properties -* **Name**: string (Required) -* **TimeToLiveInSeconds**: int (Required) -* **TurnsToLive**: int (Required) +* **S3Bucket**: string (Required): An Amazon S3 bucket in the same AWS Region as your function. The bucket can be in a different AWS account. +* **S3ObjectKey**: string (Required): The Amazon S3 key of the deployment package. +* **S3ObjectVersion**: string: For versioned objects, the version of the deployment package object to use. If not specified, the current object version will be used. ## SampleUtterance ### Properties * **Utterance**: string (Required) -## SlotPriority +## SampleValue ### Properties -* **Priority**: int (Required) -* **SlotName**: string (Required): The name of the slot. +* **Value**: string (Required): The value that can be used for a slot type. + +## SessionAttribute +### Properties +* **Key**: string (Required) +* **Value**: string ## Slot ### Properties @@ -321,31 +451,6 @@ * **SlotTypeName**: string (Required) * **ValueElicitationSetting**: [SlotValueElicitationSetting](#slotvalueelicitationsetting) (Required) -## MultipleValuesSetting -### Properties -* **AllowMultipleValues**: bool - -## ObfuscationSetting -### Properties -* **ObfuscationSettingType**: string (Required): Value that determines whether Amazon Lex obscures slot values in conversation logs. The default is to obscure the values. - -## SlotValueElicitationSetting -### Properties -* **DefaultValueSpecification**: [SlotDefaultValueSpecification](#slotdefaultvaluespecification): A list of default values for a slot. -* **PromptSpecification**: [PromptSpecification](#promptspecification): The prompt that Amazon Lex uses to elicit the slot value from the user. -* **SampleUtterances**: [SampleUtterance](#sampleutterance)[]: If you know a specific pattern that users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy. -* **SlotCaptureSetting**: [SlotCaptureSetting](#slotcapturesetting): Specifies the next stage in the conversation after capturing the slot. -* **SlotConstraint**: string (Required): Specifies whether the slot is required or optional. -* **WaitAndContinueSpecification**: [WaitAndContinueSpecification](#waitandcontinuespecification): Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input. - -## SlotDefaultValueSpecification -### Properties -* **DefaultValueList**: [SlotDefaultValue](#slotdefaultvalue)[] (Required): A list of slot default values - -## SlotDefaultValue -### Properties -* **DefaultValue**: string (Required): The default value to use when a user doesn't provide a value for a slot. - ## SlotCaptureSetting ### Properties * **CaptureConditional**: [ConditionalSpecification](#conditionalspecification): A list of conditional branches to evaluate after the slot value is captured. @@ -357,19 +462,18 @@ * **FailureNextStep**: [DialogState](#dialogstate): Specifies the next step that the bot runs when the slot value code is not recognized. * **FailureResponse**: [ResponseSpecification](#responsespecification): Specifies a list of message groups that Amazon Lex uses to respond the user input. -## WaitAndContinueSpecification +## SlotDefaultValue ### Properties -* **ContinueResponse**: [ResponseSpecification](#responsespecification) (Required): The response that Amazon Lex sends to indicate that the bot is ready to continue the conversation. -* **IsActive**: bool: Specifies whether the bot will wait for a user to respond. -* **StillWaitingResponse**: [StillWaitingResponseSpecification](#stillwaitingresponsespecification): The response that Amazon Lex sends periodically to the user to indicate that the bot is still waiting for input from the user. -* **WaitingResponse**: [ResponseSpecification](#responsespecification) (Required): The response that Amazon Lex sends to indicate that the bot is waiting for the conversation to continue. +* **DefaultValue**: string (Required): The default value to use when a user doesn't provide a value for a slot. -## StillWaitingResponseSpecification +## SlotDefaultValueSpecification ### Properties -* **AllowInterrupt**: bool: Indicates whether the user can interrupt a speech prompt from the bot. -* **FrequencyInSeconds**: int (Required) -* **MessageGroupsList**: [MessageGroup](#messagegroup)[] (Required) -* **TimeoutInSeconds**: int (Required) +* **DefaultValueList**: [SlotDefaultValue](#slotdefaultvalue)[] (Required): A list of slot default values + +## SlotPriority +### Properties +* **Priority**: int (Required) +* **SlotName**: string (Required): The name of the slot. ## SlotType ### Properties @@ -380,28 +484,38 @@ * **SlotTypeValues**: [SlotTypeValue](#slottypevalue)[] * **ValueSelectionSetting**: [SlotValueSelectionSetting](#slotvalueselectionsetting) -## ExternalSourceSetting +## SlotTypeValue ### Properties -* **GrammarSlotTypeSetting**: [GrammarSlotTypeSetting](#grammarslottypesetting) +* **SampleValue**: [SampleValue](#samplevalue) (Required) +* **Synonyms**: [SampleValue](#samplevalue)[] -## GrammarSlotTypeSetting +## SlotValue ### Properties -* **Source**: [GrammarSlotTypeSource](#grammarslottypesource) +* **InterpretedValue**: string: The value that Amazon Lex determines for the slot. -## GrammarSlotTypeSource +## SlotValueElicitationSetting ### Properties -* **KmsKeyArn**: string: The Amazon KMS key required to decrypt the contents of the grammar, if any. -* **S3BucketName**: string (Required): The name of the S3 bucket that contains the grammar source. -* **S3ObjectKey**: string (Required): The path to the grammar in the S3 bucket. +* **DefaultValueSpecification**: [SlotDefaultValueSpecification](#slotdefaultvaluespecification): A list of default values for a slot. +* **PromptSpecification**: [PromptSpecification](#promptspecification): The prompt that Amazon Lex uses to elicit the slot value from the user. +* **SampleUtterances**: [SampleUtterance](#sampleutterance)[]: If you know a specific pattern that users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy. +* **SlotCaptureSetting**: [SlotCaptureSetting](#slotcapturesetting): Specifies the next stage in the conversation after capturing the slot. +* **SlotConstraint**: string (Required): Specifies whether the slot is required or optional. +* **WaitAndContinueSpecification**: [WaitAndContinueSpecification](#waitandcontinuespecification): Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input. -## SlotTypeValue +## SlotValueOverride ### Properties -* **SampleValue**: [SampleValue](#samplevalue) (Required) -* **Synonyms**: [SampleValue](#samplevalue)[] +* **Shape**: string: When the shape value is List, it indicates that the values field contains a list of slot values. When the value is Scalar, it indicates that the value field contains a single value. +* **Value**: [SlotValue](#slotvalue): The current value of the slot. +* **Values**: [SlotValueOverride](#slotvalueoverride)[]: A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple." -## SampleValue +## SlotValueOverrideMap ### Properties -* **Value**: string (Required): The value that can be used for a slot type. +* **SlotName**: string +* **SlotValueOverride**: [SlotValueOverride](#slotvalueoverride) + +## SlotValueRegexFilter +### Properties +* **Pattern**: string (Required): Regex pattern ## SlotValueSelectionSetting ### Properties @@ -409,27 +523,26 @@ * **RegexFilter**: [SlotValueRegexFilter](#slotvalueregexfilter) * **ResolutionStrategy**: string (Required) -## AdvancedRecognitionSetting -### Properties -* **AudioRecognitionStrategy**: string - -## SlotValueRegexFilter +## SSMLMessage ### Properties -* **Pattern**: string (Required): Regex pattern +* **Value**: string (Required): The SSML text that defines the prompt. -## VoiceSettings +## StillWaitingResponseSpecification ### Properties -* **Engine**: string: Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user. For more information, see the engine parameter of the SynthesizeSpeech operation in the Amazon Polly developer guide. -* **VoiceId**: string (Required): The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. +* **AllowInterrupt**: bool: Indicates whether the user can interrupt a speech prompt from the bot. +* **FrequencyInSeconds**: int (Required) +* **MessageGroupsList**: [MessageGroup](#messagegroup)[] (Required) +* **TimeoutInSeconds**: int (Required) ## Tag ### Properties * **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. * **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -## Bot_DataPrivacy +## Tag ### Properties -* **ChildDirected**: bool (Required) +* **Key**: string (Required): A string used to identify this tag +* **Value**: string (Required): A string containing the value for the tag ## TestBotAliasSettings ### Properties @@ -438,146 +551,33 @@ * **Description**: string * **SentimentAnalysisSettings**: [Bot_SentimentAnalysisSettings](#botsentimentanalysissettings): Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances. -## BotAliasLocaleSettingsItem -### Properties -* **BotAliasLocaleSetting**: [BotAliasLocaleSettings](#botaliaslocalesettings) (Required) -* **LocaleId**: string (Required): A string used to identify the locale - -## BotAliasLocaleSettings -### Properties -* **CodeHookSpecification**: [CodeHookSpecification](#codehookspecification) -* **Enabled**: bool (Required): Whether the Lambda code hook is enabled - -## CodeHookSpecification -### Properties -* **LambdaCodeHook**: [LambdaCodeHook](#lambdacodehook) (Required) - -## LambdaCodeHook -### Properties -* **CodeHookInterfaceVersion**: string (Required): The version of the request-response that you want Amazon Lex to use to invoke your Lambda function. -* **LambdaArn**: string (Required): The Amazon Resource Name (ARN) of the Lambda function. - -## ConversationLogSettings -### Properties -* **AudioLogSettings**: [AudioLogSetting](#audiologsetting)[] -* **TextLogSettings**: [TextLogSetting](#textlogsetting)[] - -## AudioLogSetting -### Properties -* **Destination**: [AudioLogDestination](#audiologdestination) (Required) -* **Enabled**: bool (Required) - -## AudioLogDestination -### Properties -* **S3Bucket**: [S3BucketLogDestination](#s3bucketlogdestination) (Required) - -## S3BucketLogDestination -### Properties -* **KmsKeyArn**: string: The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key for encrypting audio log files stored in an S3 bucket. -* **LogPrefix**: string (Required): The Amazon S3 key of the deployment package. -* **S3BucketArn**: string (Required): The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored. - -## TextLogSetting -### Properties -* **Destination**: [TextLogDestination](#textlogdestination) (Required) -* **Enabled**: bool (Required) - ## TextLogDestination ### Properties * **CloudWatch**: [CloudWatchLogGroupLogDestination](#cloudwatchloggrouplogdestination) (Required) -## CloudWatchLogGroupLogDestination -### Properties -* **CloudWatchLogGroupArn**: string (Required): A string used to identify the groupArn for the Cloudwatch Log Group -* **LogPrefix**: string (Required): A string containing the value for the Log Prefix - -## Bot_SentimentAnalysisSettings -### Properties -* **DetectSentiment**: bool (Required): Enable to call Amazon Comprehend for Sentiment natively within Lex - -## AWS.Lex/BotAliasProperties -### Properties -* **Arn**: string (ReadOnly) -* **BotAliasId**: string (ReadOnly, Identifier) -* **BotAliasLocaleSettings**: [BotAliasLocaleSettingsItem](#botaliaslocalesettingsitem)[] -* **BotAliasName**: string (Required) -* **BotAliasStatus**: string (ReadOnly) -* **BotAliasTags**: [Tag](#tag)[] (WriteOnly): A list of tags to add to the bot alias. -* **BotId**: string (Required, Identifier) -* **BotVersion**: string -* **ConversationLogSettings**: [ConversationLogSettings](#conversationlogsettings) -* **Description**: string -* **SentimentAnalysisSettings**: [BotAlias_SentimentAnalysisSettings](#botaliassentimentanalysissettings): Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances. - -## BotAliasLocaleSettingsItem -### Properties -* **BotAliasLocaleSetting**: [BotAliasLocaleSettings](#botaliaslocalesettings) (Required) -* **LocaleId**: string (Required): A string used to identify the locale - -## BotAliasLocaleSettings -### Properties -* **CodeHookSpecification**: [CodeHookSpecification](#codehookspecification) -* **Enabled**: bool (Required): Whether the Lambda code hook is enabled - -## CodeHookSpecification -### Properties -* **LambdaCodeHook**: [LambdaCodeHook](#lambdacodehook) (Required) - -## LambdaCodeHook -### Properties -* **CodeHookInterfaceVersion**: string (Required): The version of the request-response that you want Amazon Lex to use to invoke your Lambda function. -* **LambdaArn**: string (Required): The Amazon Resource Name (ARN) of the Lambda function. - -## Tag -### Properties -* **Key**: string (Required): A string used to identify this tag -* **Value**: string (Required): A string containing the value for the tag - -## ConversationLogSettings +## TextLogDestination ### Properties -* **AudioLogSettings**: [AudioLogSetting](#audiologsetting)[] -* **TextLogSettings**: [TextLogSetting](#textlogsetting)[] +* **CloudWatch**: [CloudWatchLogGroupLogDestination](#cloudwatchloggrouplogdestination) (Required) -## AudioLogSetting +## TextLogSetting ### Properties -* **Destination**: [AudioLogDestination](#audiologdestination) (Required) +* **Destination**: [TextLogDestination](#textlogdestination) (Required) * **Enabled**: bool (Required) -## AudioLogDestination -### Properties -* **S3Bucket**: [S3BucketLogDestination](#s3bucketlogdestination) (Required) - -## S3BucketLogDestination -### Properties -* **KmsKeyArn**: string: The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key for encrypting audio log files stored in an S3 bucket. -* **LogPrefix**: string (Required): The Amazon S3 key of the deployment package. -* **S3BucketArn**: string (Required): The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored. - ## TextLogSetting ### Properties * **Destination**: [TextLogDestination](#textlogdestination) (Required) * **Enabled**: bool (Required) -## TextLogDestination -### Properties -* **CloudWatch**: [CloudWatchLogGroupLogDestination](#cloudwatchloggrouplogdestination) (Required) - -## CloudWatchLogGroupLogDestination -### Properties -* **CloudWatchLogGroupArn**: string (Required): A string used to identify the groupArn for the Cloudwatch Log Group -* **LogPrefix**: string (Required): A string containing the value for the Log Prefix - -## BotAlias_SentimentAnalysisSettings -### Properties -* **DetectSentiment**: bool (Required): Enable to call Amazon Comprehend for Sentiment natively within Lex - -## AWS.Lex/ResourcePolicyProperties +## VoiceSettings ### Properties -* **Id**: string (ReadOnly, Identifier) -* **Policy**: [Policy](#policy) (Required) -* **ResourceArn**: string (Required) -* **RevisionId**: string (ReadOnly) +* **Engine**: string: Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user. For more information, see the engine parameter of the SynthesizeSpeech operation in the Amazon Polly developer guide. +* **VoiceId**: string (Required): The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. -## Policy +## WaitAndContinueSpecification ### Properties +* **ContinueResponse**: [ResponseSpecification](#responsespecification) (Required): The response that Amazon Lex sends to indicate that the bot is ready to continue the conversation. +* **IsActive**: bool: Specifies whether the bot will wait for a user to respond. +* **StillWaitingResponse**: [StillWaitingResponseSpecification](#stillwaitingresponsespecification): The response that Amazon Lex sends periodically to the user to indicate that the bot is still waiting for input from the user. +* **WaitingResponse**: [ResponseSpecification](#responsespecification) (Required): The response that Amazon Lex sends to indicate that the bot is waiting for the conversation to continue. diff --git a/artifacts/bicep/aws/aws.licensemanager/default/types.json b/artifacts/bicep/aws/aws.licensemanager/default/types.json index 8140fe04..2f5e95a7 100644 --- a/artifacts/bicep/aws/aws.licensemanager/default/types.json +++ b/artifacts/bicep/aws/aws.licensemanager/default/types.json @@ -1 +1,432 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"Arn"}},{"2":{"Name":"AWS.LicenseManager/GrantProperties","Properties":{"AllowedOperations":{"Type":10,"Flags":4},"GrantArn":{"Type":4,"Flags":18,"Description":"Arn of the grant."},"GrantName":{"Type":4,"Flags":0,"Description":"Name for the created Grant."},"HomeRegion":{"Type":4,"Flags":0,"Description":"Home region for the created grant."},"LicenseArn":{"Type":4,"Flags":0,"Description":"License Arn for the grant."},"Principals":{"Type":11,"Flags":4},"Status":{"Type":4,"Flags":4},"Version":{"Type":4,"Flags":2,"Description":"The version of the grant."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.LicenseManager/Grant","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":9,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.LicenseManager/Grant@default","ScopeType":0,"Body":12}},{"2":{"Name":"Arn"}},{"2":{"Name":"BorrowConfiguration","Properties":{"AllowEarlyCheckIn":{"Type":2,"Flags":1},"MaxTimeToLiveInMinutes":{"Type":3,"Flags":1}}}},{"2":{"Name":"ConsumptionConfiguration","Properties":{"BorrowConfiguration":{"Type":15,"Flags":0},"ProvisionalConfiguration":{"Type":21,"Flags":0},"RenewType":{"Type":4,"Flags":0}}}},{"2":{"Name":"Entitlement","Properties":{"AllowCheckIn":{"Type":2,"Flags":0},"MaxCount":{"Type":3,"Flags":0},"Name":{"Type":4,"Flags":1},"Overage":{"Type":2,"Flags":0},"Unit":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"IssuerData","Properties":{"Name":{"Type":4,"Flags":1},"SignKey":{"Type":4,"Flags":0}}}},{"2":{"Name":"LicenseStatus"}},{"2":{"Name":"Metadata","Properties":{"Name":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"ProvisionalConfiguration","Properties":{"MaxTimeToLiveInMinutes":{"Type":3,"Flags":1}}}},{"2":{"Name":"ValidityDateFormat","Properties":{"Begin":{"Type":4,"Flags":1,"Description":"Validity begin date for the license."},"End":{"Type":4,"Flags":1,"Description":"Validity begin date for the license."}}}},{"2":{"Name":"AWS.LicenseManager/LicenseProperties","Properties":{"Beneficiary":{"Type":4,"Flags":0,"Description":"Beneficiary of the license."},"ConsumptionConfiguration":{"Type":16,"Flags":1},"Entitlements":{"Type":24,"Flags":1},"HomeRegion":{"Type":4,"Flags":1,"Description":"Home region for the created license."},"Issuer":{"Type":18,"Flags":1},"LicenseArn":{"Type":4,"Flags":18,"Description":"Amazon Resource Name is a unique name for each resource."},"LicenseMetadata":{"Type":25,"Flags":0},"LicenseName":{"Type":4,"Flags":1,"Description":"Name for the created license."},"ProductName":{"Type":4,"Flags":1,"Description":"Product name for the created license."},"ProductSKU":{"Type":4,"Flags":0,"Description":"ProductSKU of the license."},"Status":{"Type":4,"Flags":4},"Validity":{"Type":22,"Flags":1},"Version":{"Type":4,"Flags":2,"Description":"The version of the license."}}}},{"3":{"ItemType":17}},{"3":{"ItemType":20}},{"2":{"Name":"AWS.LicenseManager/License","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":23,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.LicenseManager/License@default","ScopeType":0,"Body":26}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Arn", + "properties": {} + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.LicenseManager/GrantProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "AWS.LicenseManager/GrantProperties", + "properties": { + "AllowedOperations": { + "type": { + "$ref": "#/3" + }, + "flags": 4 + }, + "GrantArn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "Arn of the grant." + }, + "GrantName": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Name for the created Grant." + }, + "HomeRegion": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Home region for the created grant." + }, + "LicenseArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "License Arn for the grant." + }, + "Principals": { + "type": { + "$ref": "#/4" + }, + "flags": 4 + }, + "Status": { + "type": { + "$ref": "#/1" + }, + "flags": 4 + }, + "Version": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The version of the grant." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.LicenseManager/Grant", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/5" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.LicenseManager/Grant@default", + "scopeType": 0, + "body": { + "$ref": "#/6" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Arn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "BorrowConfiguration", + "properties": { + "AllowEarlyCheckIn": { + "type": { + "$ref": "#/17" + }, + "flags": 1 + }, + "MaxTimeToLiveInMinutes": { + "type": { + "$ref": "#/18" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ConsumptionConfiguration", + "properties": { + "BorrowConfiguration": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "ProvisionalConfiguration": { + "type": { + "$ref": "#/15" + }, + "flags": 0 + }, + "RenewType": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Entitlement", + "properties": { + "AllowCheckIn": { + "type": { + "$ref": "#/17" + }, + "flags": 0 + }, + "MaxCount": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Overage": { + "type": { + "$ref": "#/17" + }, + "flags": 0 + }, + "Unit": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "IssuerData", + "properties": { + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "SignKey": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "LicenseStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Metadata", + "properties": { + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ProvisionalConfiguration", + "properties": { + "MaxTimeToLiveInMinutes": { + "type": { + "$ref": "#/18" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ValidityDateFormat", + "properties": { + "Begin": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Validity begin date for the license." + }, + "End": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Validity begin date for the license." + } + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "IntegerType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.LicenseManager/LicenseProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/11" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/14" + } + }, + { + "$type": "ObjectType", + "name": "AWS.LicenseManager/LicenseProperties", + "properties": { + "Beneficiary": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Beneficiary of the license." + }, + "ConsumptionConfiguration": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + }, + "Entitlements": { + "type": { + "$ref": "#/20" + }, + "flags": 1 + }, + "HomeRegion": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Home region for the created license." + }, + "Issuer": { + "type": { + "$ref": "#/12" + }, + "flags": 1 + }, + "LicenseArn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "Amazon Resource Name is a unique name for each resource." + }, + "LicenseMetadata": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "LicenseName": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Name for the created license." + }, + "ProductName": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Product name for the created license." + }, + "ProductSKU": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "ProductSKU of the license." + }, + "Status": { + "type": { + "$ref": "#/1" + }, + "flags": 4 + }, + "Validity": { + "type": { + "$ref": "#/16" + }, + "flags": 1 + }, + "Version": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The version of the license." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.LicenseManager/License", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/22" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.LicenseManager/License@default", + "scopeType": 0, + "body": { + "$ref": "#/23" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.licensemanager/default/types.md b/artifacts/bicep/aws/aws.licensemanager/default/types.md index e4f5160c..c5f002bb 100644 --- a/artifacts/bicep/aws/aws.licensemanager/default/types.md +++ b/artifacts/bicep/aws/aws.licensemanager/default/types.md @@ -3,16 +3,16 @@ ## Resource AWS.LicenseManager/Grant@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.LicenseManager/GrantProperties](#awslicensemanagergrantproperties): properties of the resource +* **properties**: [AWS.LicenseManager/GrantProperties](#awslicensemanagergrantproperties) (Identifier): properties of the resource ## Resource AWS.LicenseManager/License@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.LicenseManager/LicenseProperties](#awslicensemanagerlicenseproperties) (Required): properties of the resource +* **properties**: [AWS.LicenseManager/LicenseProperties](#awslicensemanagerlicenseproperties) (Required, Identifier): properties of the resource ## AWS.LicenseManager/GrantProperties ### Properties @@ -41,20 +41,16 @@ * **Validity**: [ValidityDateFormat](#validitydateformat) (Required) * **Version**: string (ReadOnly): The version of the license. -## ConsumptionConfiguration -### Properties -* **BorrowConfiguration**: [BorrowConfiguration](#borrowconfiguration) -* **ProvisionalConfiguration**: [ProvisionalConfiguration](#provisionalconfiguration) -* **RenewType**: string - ## BorrowConfiguration ### Properties * **AllowEarlyCheckIn**: bool (Required) * **MaxTimeToLiveInMinutes**: int (Required) -## ProvisionalConfiguration +## ConsumptionConfiguration ### Properties -* **MaxTimeToLiveInMinutes**: int (Required) +* **BorrowConfiguration**: [BorrowConfiguration](#borrowconfiguration) +* **ProvisionalConfiguration**: [ProvisionalConfiguration](#provisionalconfiguration) +* **RenewType**: string ## Entitlement ### Properties @@ -75,6 +71,10 @@ * **Name**: string (Required) * **Value**: string (Required) +## ProvisionalConfiguration +### Properties +* **MaxTimeToLiveInMinutes**: int (Required) + ## ValidityDateFormat ### Properties * **Begin**: string (Required): Validity begin date for the license. diff --git a/artifacts/bicep/aws/aws.lightsail/default/types.json b/artifacts/bicep/aws/aws.lightsail/default/types.json index b3bf900d..5d110c7f 100644 --- a/artifacts/bicep/aws/aws.lightsail/default/types.json +++ b/artifacts/bicep/aws/aws.lightsail/default/types.json @@ -1 +1,2238 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"AWS.Lightsail/AlarmProperties","Properties":{"AlarmArn":{"Type":4,"Flags":2},"AlarmName":{"Type":4,"Flags":17,"Description":"The name for the alarm. Specify the name of an existing alarm to update, and overwrite the previous configuration of the alarm."},"ComparisonOperator":{"Type":4,"Flags":1,"Description":"The arithmetic operation to use when comparing the specified statistic to the threshold. The specified statistic value is used as the first operand."},"ContactProtocols":{"Type":9,"Flags":0,"Description":"The contact protocols to use for the alarm, such as Email, SMS (text messaging), or both."},"DatapointsToAlarm":{"Type":3,"Flags":0,"Description":"The number of data points that must be not within the specified threshold to trigger the alarm. If you are setting an \"M out of N\" alarm, this value (datapointsToAlarm) is the M."},"EvaluationPeriods":{"Type":3,"Flags":1,"Description":"The number of most recent periods over which data is compared to the specified threshold. If you are setting an \"M out of N\" alarm, this value (evaluationPeriods) is the N."},"MetricName":{"Type":4,"Flags":1,"Description":"The name of the metric to associate with the alarm."},"MonitoredResourceName":{"Type":4,"Flags":1,"Description":"The validation status of the SSL/TLS certificate."},"NotificationEnabled":{"Type":2,"Flags":0,"Description":"Indicates whether the alarm is enabled. Notifications are enabled by default if you don't specify this parameter."},"NotificationTriggers":{"Type":10,"Flags":0,"Description":"The alarm states that trigger a notification."},"State":{"Type":4,"Flags":2,"Description":"The current state of the alarm."},"Threshold":{"Type":3,"Flags":1,"Description":"The value against which the specified statistic is compared."},"TreatMissingData":{"Type":4,"Flags":0,"Description":"Sets how this alarm will handle missing data points."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.Lightsail/Alarm","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":8,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Lightsail/Alarm@default","ScopeType":0,"Body":11}},{"2":{"Name":"AccessRules","Properties":{"AllowPublicOverrides":{"Type":2,"Flags":0,"Description":"A Boolean value that indicates whether the access control list (ACL) permissions that are applied to individual objects override the getObject option that is currently specified."},"GetObject":{"Type":4,"Flags":0,"Description":"Specifies the anonymous access to all objects in a bucket."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":0,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.Lightsail/BucketProperties","Properties":{"AbleToUpdateBundle":{"Type":2,"Flags":2,"Description":"Indicates whether the bundle that is currently applied to a bucket can be changed to another bundle. You can update a bucket's bundle only one time within a monthly AWS billing cycle."},"AccessRules":{"Type":13,"Flags":0},"BucketArn":{"Type":4,"Flags":2},"BucketName":{"Type":4,"Flags":17,"Description":"The name for the bucket."},"BundleId":{"Type":4,"Flags":1,"Description":"The ID of the bundle to use for the bucket."},"ObjectVersioning":{"Type":2,"Flags":0,"Description":"Specifies whether to enable or disable versioning of objects in the bucket."},"ReadOnlyAccessAccounts":{"Type":16,"Flags":0,"Description":"An array of strings to specify the AWS account IDs that can access the bucket."},"ResourcesReceivingAccess":{"Type":17,"Flags":0,"Description":"The names of the Lightsail resources for which to set bucket access."},"Tags":{"Type":18,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."},"Url":{"Type":4,"Flags":2,"Description":"The URL of the bucket."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":14}},{"2":{"Name":"AWS.Lightsail/Bucket","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":15,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Lightsail/Bucket@default","ScopeType":0,"Body":19}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":0,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.Lightsail/CertificateProperties","Properties":{"CertificateArn":{"Type":4,"Flags":2},"CertificateName":{"Type":4,"Flags":17,"Description":"The name for the certificate."},"DomainName":{"Type":4,"Flags":1,"Description":"The domain name (e.g., example.com ) for the certificate."},"Status":{"Type":4,"Flags":2,"Description":"The validation status of the certificate."},"SubjectAlternativeNames":{"Type":23,"Flags":0,"Description":"An array of strings that specify the alternate domains (e.g., example2.com) and subdomains (e.g., blog.example.com) for the certificate."},"Tags":{"Type":24,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":21}},{"2":{"Name":"AWS.Lightsail/Certificate","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":22,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Lightsail/Certificate@default","ScopeType":0,"Body":25}},{"2":{"Name":"Container","Properties":{"Command":{"Type":36,"Flags":0,"Description":"The launch command for the container."},"ContainerName":{"Type":4,"Flags":0,"Description":"The name of the container."},"Environment":{"Type":37,"Flags":0,"Description":"The environment variables of the container."},"Image":{"Type":4,"Flags":0,"Description":"The name of the image used for the container."},"Ports":{"Type":38,"Flags":0,"Description":"The open firewall ports of the container."}}}},{"2":{"Name":"ContainerServiceDeployment","Properties":{"Containers":{"Type":39,"Flags":0,"Description":"An object that describes the configuration for the containers of the deployment."},"PublicEndpoint":{"Type":34,"Flags":0,"Description":"An object that describes the endpoint of the deployment."}}}},{"2":{"Name":"EnvironmentVariable","Properties":{"Value":{"Type":4,"Flags":0},"Variable":{"Type":4,"Flags":0}}}},{"2":{"Name":"HealthCheckConfig","Properties":{"HealthyThreshold":{"Type":3,"Flags":0,"Description":"The number of consecutive health checks successes required before moving the container to the Healthy state. The default value is 2."},"IntervalSeconds":{"Type":3,"Flags":0,"Description":"The approximate interval, in seconds, between health checks of an individual container. You can specify between 5 and 300 seconds. The default value is 5."},"Path":{"Type":4,"Flags":0,"Description":"The path on the container on which to perform the health check. The default value is /."},"SuccessCodes":{"Type":4,"Flags":0,"Description":"The HTTP codes to use when checking for a successful response from a container. You can specify values between 200 and 499. You can specify multiple values (for example, 200,202) or a range of values (for example, 200-299)."},"TimeoutSeconds":{"Type":3,"Flags":0,"Description":"The amount of time, in seconds, during which no response means a failed health check. You can specify between 2 and 60 seconds. The default value is 2."},"UnhealthyThreshold":{"Type":3,"Flags":0,"Description":"The number of consecutive health check failures required before moving the container to the Unhealthy state. The default value is 2."}}}},{"2":{"Name":"PortInfo","Properties":{"Port":{"Type":4,"Flags":0},"Protocol":{"Type":4,"Flags":0}}}},{"2":{"Name":"PrivateRegistryAccess","Properties":{"EcrImagePullerRole":{"Type":40,"Flags":0,"Description":"An object to describe a request to activate or deactivate the role that you can use to grant an Amazon Lightsail container service access to Amazon Elastic Container Registry (Amazon ECR) private repositories."}}}},{"2":{"Name":"PublicDomainName","Properties":{"CertificateName":{"Type":4,"Flags":0},"DomainNames":{"Type":41,"Flags":0,"Description":"An object that describes the configuration for the containers of the deployment."}}}},{"2":{"Name":"PublicEndpoint","Properties":{"ContainerName":{"Type":4,"Flags":0,"Description":"The name of the container for the endpoint."},"ContainerPort":{"Type":3,"Flags":0,"Description":"The port of the container to which traffic is forwarded to."},"HealthCheckConfig":{"Type":30,"Flags":0,"Description":"An object that describes the health check configuration of the container."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":0,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":29}},{"3":{"ItemType":31}},{"3":{"ItemType":27}},{"2":{"Name":"Container_EcrImagePullerRole","Properties":{"IsActive":{"Type":2,"Flags":0,"Description":"A Boolean value that indicates whether to activate the role."},"PrincipalArn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) of the role, if it is activated."}}}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.Lightsail/ContainerProperties","Properties":{"ContainerArn":{"Type":4,"Flags":2},"ContainerServiceDeployment":{"Type":28,"Flags":0,"Description":"Describes a container deployment configuration of an Amazon Lightsail container service."},"IsDisabled":{"Type":2,"Flags":0,"Description":"A Boolean value to indicate whether the container service is disabled."},"Power":{"Type":4,"Flags":1,"Description":"The power specification for the container service."},"PrincipalArn":{"Type":4,"Flags":2,"Description":"The principal ARN of the container service."},"PrivateRegistryAccess":{"Type":32,"Flags":0,"Description":"A Boolean value to indicate whether the container service has access to private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories."},"PublicDomainNames":{"Type":43,"Flags":0,"Description":"The public domain names to use with the container service, such as example.com and www.example.com."},"Scale":{"Type":3,"Flags":1,"Description":"The scale specification for the container service."},"ServiceName":{"Type":4,"Flags":17,"Description":"The name for the container service."},"Tags":{"Type":44,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."},"Url":{"Type":4,"Flags":2,"Description":"The publicly accessible URL of the container service."}}}},{"3":{"ItemType":33}},{"3":{"ItemType":35}},{"2":{"Name":"AWS.Lightsail/Container","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":42,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Lightsail/Container@default","ScopeType":0,"Body":45}},{"2":{"Name":"RelationalDatabaseParameter","Properties":{"AllowedValues":{"Type":4,"Flags":0,"Description":"Specifies the valid range of values for the parameter."},"ApplyMethod":{"Type":4,"Flags":0,"Description":"Indicates when parameter updates are applied. Can be immediate or pending-reboot."},"ApplyType":{"Type":4,"Flags":0,"Description":"Specifies the engine-specific parameter type."},"DataType":{"Type":4,"Flags":0,"Description":"Specifies the valid data type for the parameter."},"Description":{"Type":4,"Flags":0,"Description":"Provides a description of the parameter."},"IsModifiable":{"Type":2,"Flags":0,"Description":"A Boolean value indicating whether the parameter can be modified."},"ParameterName":{"Type":4,"Flags":0,"Description":"Specifies the name of the parameter."},"ParameterValue":{"Type":4,"Flags":0,"Description":"Specifies the value of the parameter."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":0,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.Lightsail/DatabaseProperties","Properties":{"AvailabilityZone":{"Type":4,"Flags":0,"Description":"The Availability Zone in which to create your new database. Use the us-east-2a case-sensitive format."},"BackupRetention":{"Type":2,"Flags":0,"Description":"When true, enables automated backup retention for your database. Updates are applied during the next maintenance window because this can result in an outage."},"CaCertificateIdentifier":{"Type":4,"Flags":0,"Description":"Indicates the certificate that needs to be associated with the database."},"DatabaseArn":{"Type":4,"Flags":2},"MasterDatabaseName":{"Type":4,"Flags":1,"Description":"The name of the database to create when the Lightsail database resource is created. For MySQL, if this parameter isn't specified, no database is created in the database resource. For PostgreSQL, if this parameter isn't specified, a database named postgres is created in the database resource."},"MasterUserPassword":{"Type":4,"Flags":4,"Description":"The password for the master user. The password can include any printable ASCII character except \"/\", \"\"\", or \"@\". It cannot contain spaces."},"MasterUsername":{"Type":4,"Flags":1,"Description":"The name for the master user."},"PreferredBackupWindow":{"Type":4,"Flags":0,"Description":"The daily time range during which automated backups are created for your new database if automated backups are enabled."},"PreferredMaintenanceWindow":{"Type":4,"Flags":0,"Description":"The weekly time range during which system maintenance can occur on your new database."},"PubliclyAccessible":{"Type":2,"Flags":0,"Description":"Specifies the accessibility options for your new database. A value of true specifies a database that is available to resources outside of your Lightsail account. A value of false specifies a database that is available only to your Lightsail resources in the same region as your database."},"RelationalDatabaseBlueprintId":{"Type":4,"Flags":1,"Description":"The blueprint ID for your new database. A blueprint describes the major engine version of a database."},"RelationalDatabaseBundleId":{"Type":4,"Flags":1,"Description":"The bundle ID for your new database. A bundle describes the performance specifications for your database."},"RelationalDatabaseName":{"Type":4,"Flags":17,"Description":"The name to use for your new Lightsail database resource."},"RelationalDatabaseParameters":{"Type":50,"Flags":4,"Description":"Update one or more parameters of the relational database."},"RotateMasterUserPassword":{"Type":2,"Flags":4,"Description":"When true, the master user password is changed to a new strong password generated by Lightsail. Use the get relational database master user password operation to get the new password."},"Tags":{"Type":51,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."}}}},{"3":{"ItemType":47}},{"3":{"ItemType":48}},{"2":{"Name":"AWS.Lightsail/Database","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":49,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Lightsail/Database@default","ScopeType":0,"Body":52}},{"2":{"Name":"AddOn","Properties":{"AddOnType":{"Type":4,"Flags":1,"Description":"The add-on type"},"AutoSnapshotAddOnRequest":{"Type":55,"Flags":0},"Status":{"Type":4,"Flags":0,"Description":"Status of the Addon"}}}},{"2":{"Name":"AutoSnapshotAddOn","Properties":{"SnapshotTimeOfDay":{"Type":4,"Flags":0,"Description":"The daily time when an automatic snapshot will be created."}}}},{"2":{"Name":"Location","Properties":{"AvailabilityZone":{"Type":4,"Flags":2,"Description":"The Availability Zone in which to create your disk. Use the following format: us-east-2a (case sensitive). Be sure to add the include Availability Zones parameter to your request."},"RegionName":{"Type":4,"Flags":2,"Description":"The Region Name in which to create your disk."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":0,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.Lightsail/DiskProperties","Properties":{"AddOns":{"Type":59,"Flags":0,"Description":"An array of objects representing the add-ons to enable for the new instance."},"AttachedTo":{"Type":4,"Flags":2,"Description":"Name of the attached Lightsail Instance"},"AttachmentState":{"Type":4,"Flags":2,"Description":"Attachment State of the Lightsail disk"},"AvailabilityZone":{"Type":4,"Flags":0,"Description":"The Availability Zone in which to create your instance. Use the following format: us-east-2a (case sensitive). Be sure to add the include Availability Zones parameter to your request."},"DiskArn":{"Type":4,"Flags":2},"DiskName":{"Type":4,"Flags":17,"Description":"The names to use for your new Lightsail disk."},"Iops":{"Type":3,"Flags":2,"Description":"Iops of the Lightsail disk"},"IsAttached":{"Type":2,"Flags":2,"Description":"Check is Disk is attached state"},"Location":{"Type":56,"Flags":0},"Path":{"Type":4,"Flags":2,"Description":"Path of the attached Disk"},"ResourceType":{"Type":4,"Flags":2,"Description":"Resource type of Lightsail instance."},"SizeInGb":{"Type":3,"Flags":1,"Description":"Size of the Lightsail disk"},"State":{"Type":4,"Flags":2,"Description":"State of the Lightsail disk"},"SupportCode":{"Type":4,"Flags":2,"Description":"Support code to help identify any issues"},"Tags":{"Type":60,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."}}}},{"3":{"ItemType":54}},{"3":{"ItemType":57}},{"2":{"Name":"AWS.Lightsail/Disk","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":58,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Lightsail/Disk@default","ScopeType":0,"Body":61}},{"2":{"Name":"AddOn","Properties":{"AddOnType":{"Type":4,"Flags":1,"Description":"The add-on type"},"AutoSnapshotAddOnRequest":{"Type":64,"Flags":0},"Status":{"Type":4,"Flags":0,"Description":"Status of the Addon"}}}},{"2":{"Name":"AutoSnapshotAddOn","Properties":{"SnapshotTimeOfDay":{"Type":4,"Flags":0,"Description":"The daily time when an automatic snapshot will be created."}}}},{"2":{"Name":"Disk","Properties":{"AttachedTo":{"Type":4,"Flags":0,"Description":"Instance attached to the disk."},"AttachmentState":{"Type":4,"Flags":0,"Description":"Attachment state of the disk."},"DiskName":{"Type":4,"Flags":1,"Description":"The names to use for your new Lightsail disk."},"IOPS":{"Type":3,"Flags":0,"Description":"IOPS of disk."},"IsSystemDisk":{"Type":2,"Flags":0,"Description":"Is the Attached disk is the system disk of the Instance."},"Path":{"Type":4,"Flags":1,"Description":"Path of the disk attached to the instance."},"SizeInGb":{"Type":4,"Flags":0,"Description":"Size of the disk attached to the Instance."}}}},{"2":{"Name":"Hardware","Properties":{"CpuCount":{"Type":3,"Flags":2,"Description":"CPU count of the Instance."},"Disks":{"Type":76,"Flags":0,"Description":"Disks attached to the Instance."},"RamSizeInGb":{"Type":3,"Flags":2,"Description":"RAM Size of the Instance."}}}},{"2":{"Name":"Location","Properties":{"AvailabilityZone":{"Type":4,"Flags":2,"Description":"The Availability Zone in which to create your instance. Use the following format: us-east-2a (case sensitive). Be sure to add the include Availability Zones parameter to your request."},"RegionName":{"Type":4,"Flags":2,"Description":"The Region Name in which to create your instance."}}}},{"2":{"Name":"MonthlyTransfer","Properties":{"GbPerMonthAllocated":{"Type":4,"Flags":2,"Description":"GbPerMonthAllocated of the Instance."}}}},{"2":{"Name":"Networking","Properties":{"MonthlyTransfer":{"Type":68,"Flags":0},"Ports":{"Type":77,"Flags":1,"Description":"Ports to the Instance."}}}},{"2":{"Name":"Port","Properties":{"AccessDirection":{"Type":4,"Flags":0,"Description":"Access Direction for Protocol of the Instance(inbound/outbound)."},"AccessFrom":{"Type":4,"Flags":0,"Description":"Access From Protocol of the Instance."},"AccessType":{"Type":4,"Flags":0,"Description":"Access Type Protocol of the Instance."},"CidrListAliases":{"Type":78,"Flags":0},"Cidrs":{"Type":79,"Flags":0},"CommonName":{"Type":4,"Flags":0,"Description":"CommonName for Protocol of the Instance."},"FromPort":{"Type":3,"Flags":0,"Description":"From Port of the Instance."},"Ipv6Cidrs":{"Type":80,"Flags":0},"Protocol":{"Type":4,"Flags":0,"Description":"Port Protocol of the Instance."},"ToPort":{"Type":3,"Flags":0,"Description":"To Port of the Instance."}}}},{"2":{"Name":"State","Properties":{"Code":{"Type":3,"Flags":2,"Description":"Status code of the Instance."},"Name":{"Type":4,"Flags":2,"Description":"Status code of the Instance."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":0,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"cidrListAliases"}},{"2":{"Name":"cidrs"}},{"2":{"Name":"ipv6Cidrs"}},{"3":{"ItemType":65}},{"3":{"ItemType":70}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.Lightsail/InstanceProperties","Properties":{"AddOns":{"Type":85,"Flags":0,"Description":"An array of objects representing the add-ons to enable for the new instance."},"AvailabilityZone":{"Type":4,"Flags":0,"Description":"The Availability Zone in which to create your instance. Use the following format: us-east-2a (case sensitive). Be sure to add the include Availability Zones parameter to your request."},"BlueprintId":{"Type":4,"Flags":1,"Description":"The ID for a virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0 ). Use the get blueprints operation to return a list of available images (or blueprints )."},"BundleId":{"Type":4,"Flags":1,"Description":"The bundle of specification information for your virtual private server (or instance ), including the pricing plan (e.g., micro_1_0 )."},"Hardware":{"Type":66,"Flags":0},"InstanceArn":{"Type":4,"Flags":2},"InstanceName":{"Type":4,"Flags":17,"Description":"The names to use for your new Lightsail instance."},"IsStaticIp":{"Type":2,"Flags":2,"Description":"Is the IP Address of the Instance is the static IP"},"KeyPairName":{"Type":4,"Flags":0,"Description":"The name of your key pair."},"Location":{"Type":67,"Flags":0},"Networking":{"Type":69,"Flags":0},"PrivateIpAddress":{"Type":4,"Flags":2,"Description":"Private IP Address of the Instance"},"PublicIpAddress":{"Type":4,"Flags":2,"Description":"Public IP Address of the Instance"},"ResourceType":{"Type":4,"Flags":2,"Description":"Resource type of Lightsail instance."},"SshKeyName":{"Type":4,"Flags":2,"Description":"SSH Key Name of the Lightsail instance."},"State":{"Type":71,"Flags":0},"SupportCode":{"Type":4,"Flags":2,"Description":"Support code to help identify any issues"},"Tags":{"Type":86,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."},"UserData":{"Type":4,"Flags":4,"Description":"A launch script you can create that configures a server with additional user data. For example, you might want to run apt-get -y update."},"UserName":{"Type":4,"Flags":2,"Description":"Username of the Lightsail instance."}}}},{"3":{"ItemType":63}},{"3":{"ItemType":72}},{"2":{"Name":"AWS.Lightsail/Instance","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":84,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Lightsail/Instance@default","ScopeType":0,"Body":87}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":0,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.Lightsail/LoadBalancerProperties","Properties":{"AttachedInstances":{"Type":91,"Flags":0,"Description":"The names of the instances attached to the load balancer."},"HealthCheckPath":{"Type":4,"Flags":0,"Description":"The path you provided to perform the load balancer health check. If you didn't specify a health check path, Lightsail uses the root path of your website (e.g., \"/\")."},"InstancePort":{"Type":3,"Flags":1,"Description":"The instance port where you're creating your load balancer."},"IpAddressType":{"Type":4,"Flags":0,"Description":"The IP address type for the load balancer. The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6. The default value is dualstack."},"LoadBalancerArn":{"Type":4,"Flags":2},"LoadBalancerName":{"Type":4,"Flags":17,"Description":"The name of your load balancer."},"SessionStickinessEnabled":{"Type":2,"Flags":0,"Description":"Configuration option to enable session stickiness."},"SessionStickinessLBCookieDurationSeconds":{"Type":4,"Flags":0,"Description":"Configuration option to adjust session stickiness cookie duration parameter."},"Tags":{"Type":92,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."},"TlsPolicyName":{"Type":4,"Flags":0,"Description":"The name of the TLS policy to apply to the load balancer."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":89}},{"2":{"Name":"AWS.Lightsail/LoadBalancer","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":90,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Lightsail/LoadBalancer@default","ScopeType":0,"Body":93}},{"2":{"Name":"AWS.Lightsail/LoadBalancerTlsCertificateProperties","Properties":{"CertificateAlternativeNames":{"Type":96,"Flags":0,"Description":"An array of strings listing alternative domains and subdomains for your SSL/TLS certificate."},"CertificateDomainName":{"Type":4,"Flags":1,"Description":"The domain name (e.g., example.com ) for your SSL/TLS certificate."},"CertificateName":{"Type":4,"Flags":17,"Description":"The SSL/TLS certificate name."},"HttpsRedirectionEnabled":{"Type":2,"Flags":0,"Description":"A Boolean value that indicates whether HTTPS redirection is enabled for the load balancer."},"IsAttached":{"Type":2,"Flags":0,"Description":"When true, the SSL/TLS certificate is attached to the Lightsail load balancer."},"LoadBalancerName":{"Type":4,"Flags":17,"Description":"The name of your load balancer."},"LoadBalancerTlsCertificateArn":{"Type":4,"Flags":2},"Status":{"Type":4,"Flags":2,"Description":"The validation status of the SSL/TLS certificate."}}}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.Lightsail/LoadBalancerTlsCertificate","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":95,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Lightsail/LoadBalancerTlsCertificate@default","ScopeType":0,"Body":97}},{"2":{"Name":"AWS.Lightsail/StaticIpProperties","Properties":{"AttachedTo":{"Type":4,"Flags":0,"Description":"The instance where the static IP is attached."},"IpAddress":{"Type":4,"Flags":2,"Description":"The static IP address."},"IsAttached":{"Type":2,"Flags":2,"Description":"A Boolean value indicating whether the static IP is attached."},"StaticIpArn":{"Type":4,"Flags":2},"StaticIpName":{"Type":4,"Flags":17,"Description":"The name of the static IP address."}}}},{"2":{"Name":"AWS.Lightsail/StaticIp","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":99,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Lightsail/StaticIp@default","ScopeType":0,"Body":100}}] \ No newline at end of file +[ + { + "$type": "StringLiteralType", + "value": "AWS.Lightsail/AlarmProperties" + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Lightsail/AlarmProperties", + "properties": { + "AlarmArn": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "AlarmName": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The name for the alarm. Specify the name of an existing alarm to update, and overwrite the previous configuration of the alarm." + }, + "ComparisonOperator": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The arithmetic operation to use when comparing the specified statistic to the threshold. The specified statistic value is used as the first operand." + }, + "ContactProtocols": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The contact protocols to use for the alarm, such as Email, SMS (text messaging), or both." + }, + "DatapointsToAlarm": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The number of data points that must be not within the specified threshold to trigger the alarm. If you are setting an \"M out of N\" alarm, this value (datapointsToAlarm) is the M." + }, + "EvaluationPeriods": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The number of most recent periods over which data is compared to the specified threshold. If you are setting an \"M out of N\" alarm, this value (evaluationPeriods) is the N." + }, + "MetricName": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The name of the metric to associate with the alarm." + }, + "MonitoredResourceName": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The validation status of the SSL/TLS certificate." + }, + "NotificationEnabled": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Indicates whether the alarm is enabled. Notifications are enabled by default if you don't specify this parameter." + }, + "NotificationTriggers": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The alarm states that trigger a notification." + }, + "State": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The current state of the alarm." + }, + "Threshold": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The value against which the specified statistic is compared." + }, + "TreatMissingData": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Sets how this alarm will handle missing data points." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Lightsail/Alarm", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/6" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Lightsail/Alarm@default", + "scopeType": 0, + "body": { + "$ref": "#/7" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AccessRules", + "properties": { + "AllowPublicOverrides": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "A Boolean value that indicates whether the access control list (ACL) permissions that are applied to individual objects override the getObject option that is currently specified." + }, + "GetObject": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Specifies the anonymous access to all objects in a bucket." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Lightsail/BucketProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/10" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Lightsail/BucketProperties", + "properties": { + "AbleToUpdateBundle": { + "type": { + "$ref": "#/4" + }, + "flags": 2, + "description": "Indicates whether the bundle that is currently applied to a bucket can be changed to another bundle. You can update a bucket's bundle only one time within a monthly AWS billing cycle." + }, + "AccessRules": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "BucketArn": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "BucketName": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The name for the bucket." + }, + "BundleId": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The ID of the bundle to use for the bucket." + }, + "ObjectVersioning": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Specifies whether to enable or disable versioning of objects in the bucket." + }, + "ReadOnlyAccessAccounts": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "An array of strings to specify the AWS account IDs that can access the bucket." + }, + "ResourcesReceivingAccess": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "The names of the Lightsail resources for which to set bucket access." + }, + "Tags": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + }, + "Url": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The URL of the bucket." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Lightsail/Bucket", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/15" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Lightsail/Bucket@default", + "scopeType": 0, + "body": { + "$ref": "#/16" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Lightsail/CertificateProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/18" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Lightsail/CertificateProperties", + "properties": { + "CertificateArn": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "CertificateName": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The name for the certificate." + }, + "DomainName": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The domain name (e.g., example.com ) for the certificate." + }, + "Status": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The validation status of the certificate." + }, + "SubjectAlternativeNames": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "An array of strings that specify the alternate domains (e.g., example2.com) and subdomains (e.g., blog.example.com) for the certificate." + }, + "Tags": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Lightsail/Certificate", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/22" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Lightsail/Certificate@default", + "scopeType": 0, + "body": { + "$ref": "#/23" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Container", + "properties": { + "Command": { + "type": { + "$ref": "#/34" + }, + "flags": 0, + "description": "The launch command for the container." + }, + "ContainerName": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The name of the container." + }, + "Environment": { + "type": { + "$ref": "#/35" + }, + "flags": 0, + "description": "The environment variables of the container." + }, + "Image": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The name of the image used for the container." + }, + "Ports": { + "type": { + "$ref": "#/36" + }, + "flags": 0, + "description": "The open firewall ports of the container." + } + } + }, + { + "$type": "ObjectType", + "name": "ContainerServiceDeployment", + "properties": { + "Containers": { + "type": { + "$ref": "#/37" + }, + "flags": 0, + "description": "An object that describes the configuration for the containers of the deployment." + }, + "PublicEndpoint": { + "type": { + "$ref": "#/32" + }, + "flags": 0, + "description": "An object that describes the endpoint of the deployment." + } + } + }, + { + "$type": "ObjectType", + "name": "EnvironmentVariable", + "properties": { + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "Variable": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "HealthCheckConfig", + "properties": { + "HealthyThreshold": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The number of consecutive health checks successes required before moving the container to the Healthy state. The default value is 2." + }, + "IntervalSeconds": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The approximate interval, in seconds, between health checks of an individual container. You can specify between 5 and 300 seconds. The default value is 5." + }, + "Path": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The path on the container on which to perform the health check. The default value is /." + }, + "SuccessCodes": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The HTTP codes to use when checking for a successful response from a container. You can specify values between 200 and 499. You can specify multiple values (for example, 200,202) or a range of values (for example, 200-299)." + }, + "TimeoutSeconds": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The amount of time, in seconds, during which no response means a failed health check. You can specify between 2 and 60 seconds. The default value is 2." + }, + "UnhealthyThreshold": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The number of consecutive health check failures required before moving the container to the Unhealthy state. The default value is 2." + } + } + }, + { + "$type": "ObjectType", + "name": "PortInfo", + "properties": { + "Port": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "Protocol": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PrivateRegistryAccess", + "properties": { + "EcrImagePullerRole": { + "type": { + "$ref": "#/38" + }, + "flags": 0, + "description": "An object to describe a request to activate or deactivate the role that you can use to grant an Amazon Lightsail container service access to Amazon Elastic Container Registry (Amazon ECR) private repositories." + } + } + }, + { + "$type": "ObjectType", + "name": "PublicDomainName", + "properties": { + "CertificateName": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "DomainNames": { + "type": { + "$ref": "#/39" + }, + "flags": 0, + "description": "An object that describes the configuration for the containers of the deployment." + } + } + }, + { + "$type": "ObjectType", + "name": "PublicEndpoint", + "properties": { + "ContainerName": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The name of the container for the endpoint." + }, + "ContainerPort": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The port of the container to which traffic is forwarded to." + }, + "HealthCheckConfig": { + "type": { + "$ref": "#/28" + }, + "flags": 0, + "description": "An object that describes the health check configuration of the container." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/27" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/29" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/25" + } + }, + { + "$type": "ObjectType", + "name": "Container_EcrImagePullerRole", + "properties": { + "IsActive": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "A Boolean value that indicates whether to activate the role." + }, + "PrincipalArn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) of the role, if it is activated." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Lightsail/ContainerProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/31" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/33" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Lightsail/ContainerProperties", + "properties": { + "ContainerArn": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "ContainerServiceDeployment": { + "type": { + "$ref": "#/26" + }, + "flags": 0, + "description": "Describes a container deployment configuration of an Amazon Lightsail container service." + }, + "IsDisabled": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "A Boolean value to indicate whether the container service is disabled." + }, + "Power": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The power specification for the container service." + }, + "PrincipalArn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The principal ARN of the container service." + }, + "PrivateRegistryAccess": { + "type": { + "$ref": "#/30" + }, + "flags": 0, + "description": "A Boolean value to indicate whether the container service has access to private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories." + }, + "PublicDomainNames": { + "type": { + "$ref": "#/41" + }, + "flags": 0, + "description": "The public domain names to use with the container service, such as example.com and www.example.com." + }, + "Scale": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The scale specification for the container service." + }, + "ServiceName": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The name for the container service." + }, + "Tags": { + "type": { + "$ref": "#/42" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + }, + "Url": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The publicly accessible URL of the container service." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Lightsail/Container", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/43" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Lightsail/Container@default", + "scopeType": 0, + "body": { + "$ref": "#/44" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "RelationalDatabaseParameter", + "properties": { + "AllowedValues": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Specifies the valid range of values for the parameter." + }, + "ApplyMethod": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Indicates when parameter updates are applied. Can be immediate or pending-reboot." + }, + "ApplyType": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Specifies the engine-specific parameter type." + }, + "DataType": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Specifies the valid data type for the parameter." + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Provides a description of the parameter." + }, + "IsModifiable": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "A Boolean value indicating whether the parameter can be modified." + }, + "ParameterName": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Specifies the name of the parameter." + }, + "ParameterValue": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Specifies the value of the parameter." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Lightsail/DatabaseProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/46" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/47" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Lightsail/DatabaseProperties", + "properties": { + "AvailabilityZone": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The Availability Zone in which to create your new database. Use the us-east-2a case-sensitive format." + }, + "BackupRetention": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "When true, enables automated backup retention for your database. Updates are applied during the next maintenance window because this can result in an outage." + }, + "CaCertificateIdentifier": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Indicates the certificate that needs to be associated with the database." + }, + "DatabaseArn": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "MasterDatabaseName": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The name of the database to create when the Lightsail database resource is created. For MySQL, if this parameter isn't specified, no database is created in the database resource. For PostgreSQL, if this parameter isn't specified, a database named postgres is created in the database resource." + }, + "MasterUserPassword": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The password for the master user. The password can include any printable ASCII character except \"/\", \"\"\", or \"@\". It cannot contain spaces." + }, + "MasterUsername": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The name for the master user." + }, + "PreferredBackupWindow": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The daily time range during which automated backups are created for your new database if automated backups are enabled." + }, + "PreferredMaintenanceWindow": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The weekly time range during which system maintenance can occur on your new database." + }, + "PubliclyAccessible": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Specifies the accessibility options for your new database. A value of true specifies a database that is available to resources outside of your Lightsail account. A value of false specifies a database that is available only to your Lightsail resources in the same region as your database." + }, + "RelationalDatabaseBlueprintId": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The blueprint ID for your new database. A blueprint describes the major engine version of a database." + }, + "RelationalDatabaseBundleId": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The bundle ID for your new database. A bundle describes the performance specifications for your database." + }, + "RelationalDatabaseName": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The name to use for your new Lightsail database resource." + }, + "RelationalDatabaseParameters": { + "type": { + "$ref": "#/49" + }, + "flags": 4, + "description": "Update one or more parameters of the relational database." + }, + "RotateMasterUserPassword": { + "type": { + "$ref": "#/4" + }, + "flags": 4, + "description": "When true, the master user password is changed to a new strong password generated by Lightsail. Use the get relational database master user password operation to get the new password." + }, + "Tags": { + "type": { + "$ref": "#/50" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Lightsail/Database", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/51" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Lightsail/Database@default", + "scopeType": 0, + "body": { + "$ref": "#/52" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AddOn", + "properties": { + "AddOnType": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The add-on type" + }, + "AutoSnapshotAddOnRequest": { + "type": { + "$ref": "#/55" + }, + "flags": 0 + }, + "Status": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Status of the Addon" + } + } + }, + { + "$type": "ObjectType", + "name": "AutoSnapshotAddOn", + "properties": { + "SnapshotTimeOfDay": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The daily time when an automatic snapshot will be created." + } + } + }, + { + "$type": "ObjectType", + "name": "Location", + "properties": { + "AvailabilityZone": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The Availability Zone in which to create your disk. Use the following format: us-east-2a (case sensitive). Be sure to add the include Availability Zones parameter to your request." + }, + "RegionName": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The Region Name in which to create your disk." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Lightsail/DiskProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/54" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/57" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Lightsail/DiskProperties", + "properties": { + "AddOns": { + "type": { + "$ref": "#/59" + }, + "flags": 0, + "description": "An array of objects representing the add-ons to enable for the new instance." + }, + "AttachedTo": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "Name of the attached Lightsail Instance" + }, + "AttachmentState": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "Attachment State of the Lightsail disk" + }, + "AvailabilityZone": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The Availability Zone in which to create your instance. Use the following format: us-east-2a (case sensitive). Be sure to add the include Availability Zones parameter to your request." + }, + "DiskArn": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "DiskName": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The names to use for your new Lightsail disk." + }, + "Iops": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "Iops of the Lightsail disk" + }, + "IsAttached": { + "type": { + "$ref": "#/4" + }, + "flags": 2, + "description": "Check is Disk is attached state" + }, + "Location": { + "type": { + "$ref": "#/56" + }, + "flags": 0 + }, + "Path": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "Path of the attached Disk" + }, + "ResourceType": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "Resource type of Lightsail instance." + }, + "SizeInGb": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "Size of the Lightsail disk" + }, + "State": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "State of the Lightsail disk" + }, + "SupportCode": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "Support code to help identify any issues" + }, + "Tags": { + "type": { + "$ref": "#/60" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Lightsail/Disk", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/61" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Lightsail/Disk@default", + "scopeType": 0, + "body": { + "$ref": "#/62" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AddOn", + "properties": { + "AddOnType": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The add-on type" + }, + "AutoSnapshotAddOnRequest": { + "type": { + "$ref": "#/65" + }, + "flags": 0 + }, + "Status": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Status of the Addon" + } + } + }, + { + "$type": "ObjectType", + "name": "AutoSnapshotAddOn", + "properties": { + "SnapshotTimeOfDay": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The daily time when an automatic snapshot will be created." + } + } + }, + { + "$type": "ObjectType", + "name": "Disk", + "properties": { + "AttachedTo": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Instance attached to the disk." + }, + "AttachmentState": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Attachment state of the disk." + }, + "DiskName": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The names to use for your new Lightsail disk." + }, + "IOPS": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "IOPS of disk." + }, + "IsSystemDisk": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Is the Attached disk is the system disk of the Instance." + }, + "Path": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Path of the disk attached to the instance." + }, + "SizeInGb": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Size of the disk attached to the Instance." + } + } + }, + { + "$type": "ObjectType", + "name": "Hardware", + "properties": { + "CpuCount": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "CPU count of the Instance." + }, + "Disks": { + "type": { + "$ref": "#/77" + }, + "flags": 0, + "description": "Disks attached to the Instance." + }, + "RamSizeInGb": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "RAM Size of the Instance." + } + } + }, + { + "$type": "ObjectType", + "name": "Location", + "properties": { + "AvailabilityZone": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The Availability Zone in which to create your instance. Use the following format: us-east-2a (case sensitive). Be sure to add the include Availability Zones parameter to your request." + }, + "RegionName": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The Region Name in which to create your instance." + } + } + }, + { + "$type": "ObjectType", + "name": "MonthlyTransfer", + "properties": { + "GbPerMonthAllocated": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "GbPerMonthAllocated of the Instance." + } + } + }, + { + "$type": "ObjectType", + "name": "Networking", + "properties": { + "MonthlyTransfer": { + "type": { + "$ref": "#/69" + }, + "flags": 0 + }, + "Ports": { + "type": { + "$ref": "#/78" + }, + "flags": 1, + "description": "Ports to the Instance." + } + } + }, + { + "$type": "ObjectType", + "name": "Port", + "properties": { + "AccessDirection": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Access Direction for Protocol of the Instance(inbound/outbound)." + }, + "AccessFrom": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Access From Protocol of the Instance." + }, + "AccessType": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Access Type Protocol of the Instance." + }, + "CidrListAliases": { + "type": { + "$ref": "#/79" + }, + "flags": 0 + }, + "Cidrs": { + "type": { + "$ref": "#/80" + }, + "flags": 0 + }, + "CommonName": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "CommonName for Protocol of the Instance." + }, + "FromPort": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "From Port of the Instance." + }, + "Ipv6Cidrs": { + "type": { + "$ref": "#/81" + }, + "flags": 0 + }, + "Protocol": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Port Protocol of the Instance." + }, + "ToPort": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "To Port of the Instance." + } + } + }, + { + "$type": "ObjectType", + "name": "State", + "properties": { + "Code": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "Status code of the Instance." + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "Status code of the Instance." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "ObjectType", + "name": "cidrListAliases", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "cidrs", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ipv6Cidrs", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/66" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/71" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Lightsail/InstanceProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/64" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/73" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Lightsail/InstanceProperties", + "properties": { + "AddOns": { + "type": { + "$ref": "#/86" + }, + "flags": 0, + "description": "An array of objects representing the add-ons to enable for the new instance." + }, + "AvailabilityZone": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The Availability Zone in which to create your instance. Use the following format: us-east-2a (case sensitive). Be sure to add the include Availability Zones parameter to your request." + }, + "BlueprintId": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The ID for a virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0 ). Use the get blueprints operation to return a list of available images (or blueprints )." + }, + "BundleId": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The bundle of specification information for your virtual private server (or instance ), including the pricing plan (e.g., micro_1_0 )." + }, + "Hardware": { + "type": { + "$ref": "#/67" + }, + "flags": 0 + }, + "InstanceArn": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "InstanceName": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The names to use for your new Lightsail instance." + }, + "Ipv6Addresses": { + "type": { + "$ref": "#/87" + }, + "flags": 2, + "description": "IPv6 addresses of the instance" + }, + "IsStaticIp": { + "type": { + "$ref": "#/4" + }, + "flags": 2, + "description": "Is the IP Address of the Instance is the static IP" + }, + "KeyPairName": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The name of your key pair." + }, + "Location": { + "type": { + "$ref": "#/68" + }, + "flags": 0 + }, + "Networking": { + "type": { + "$ref": "#/70" + }, + "flags": 0 + }, + "PrivateIpAddress": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "Private IP Address of the Instance" + }, + "PublicIpAddress": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "Public IP Address of the Instance" + }, + "ResourceType": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "Resource type of Lightsail instance." + }, + "SshKeyName": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "SSH Key Name of the Lightsail instance." + }, + "State": { + "type": { + "$ref": "#/72" + }, + "flags": 0 + }, + "SupportCode": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "Support code to help identify any issues" + }, + "Tags": { + "type": { + "$ref": "#/88" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + }, + "UserData": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "A launch script you can create that configures a server with additional user data. For example, you might want to run apt-get -y update." + }, + "UserName": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "Username of the Lightsail instance." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Lightsail/Instance", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/89" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Lightsail/Instance@default", + "scopeType": 0, + "body": { + "$ref": "#/90" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Lightsail/LoadBalancerProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/92" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Lightsail/LoadBalancerProperties", + "properties": { + "AttachedInstances": { + "type": { + "$ref": "#/94" + }, + "flags": 0, + "description": "The names of the instances attached to the load balancer." + }, + "HealthCheckPath": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The path you provided to perform the load balancer health check. If you didn't specify a health check path, Lightsail uses the root path of your website (e.g., \"/\")." + }, + "InstancePort": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The instance port where you're creating your load balancer." + }, + "IpAddressType": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The IP address type for the load balancer. The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6. The default value is dualstack." + }, + "LoadBalancerArn": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "LoadBalancerName": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The name of your load balancer." + }, + "SessionStickinessEnabled": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Configuration option to enable session stickiness." + }, + "SessionStickinessLBCookieDurationSeconds": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Configuration option to adjust session stickiness cookie duration parameter." + }, + "Tags": { + "type": { + "$ref": "#/95" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + }, + "TlsPolicyName": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The name of the TLS policy to apply to the load balancer." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Lightsail/LoadBalancer", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/96" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Lightsail/LoadBalancer@default", + "scopeType": 0, + "body": { + "$ref": "#/97" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.Lightsail/LoadBalancerTlsCertificateProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Lightsail/LoadBalancerTlsCertificateProperties", + "properties": { + "CertificateAlternativeNames": { + "type": { + "$ref": "#/100" + }, + "flags": 0, + "description": "An array of strings listing alternative domains and subdomains for your SSL/TLS certificate." + }, + "CertificateDomainName": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The domain name (e.g., example.com ) for your SSL/TLS certificate." + }, + "CertificateName": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The SSL/TLS certificate name." + }, + "HttpsRedirectionEnabled": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "A Boolean value that indicates whether HTTPS redirection is enabled for the load balancer." + }, + "IsAttached": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "When true, the SSL/TLS certificate is attached to the Lightsail load balancer." + }, + "LoadBalancerName": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The name of your load balancer." + }, + "LoadBalancerTlsCertificateArn": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "Status": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The validation status of the SSL/TLS certificate." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Lightsail/LoadBalancerTlsCertificate", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/101" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Lightsail/LoadBalancerTlsCertificate@default", + "scopeType": 0, + "body": { + "$ref": "#/102" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.Lightsail/StaticIpProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.Lightsail/StaticIpProperties", + "properties": { + "AttachedTo": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The instance where the static IP is attached." + }, + "IpAddress": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The static IP address." + }, + "IsAttached": { + "type": { + "$ref": "#/4" + }, + "flags": 2, + "description": "A Boolean value indicating whether the static IP is attached." + }, + "StaticIpArn": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "StaticIpName": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The name of the static IP address." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Lightsail/StaticIp", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/105" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Lightsail/StaticIp@default", + "scopeType": 0, + "body": { + "$ref": "#/106" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.lightsail/default/types.md b/artifacts/bicep/aws/aws.lightsail/default/types.md index d21f1738..c50fcaa9 100644 --- a/artifacts/bicep/aws/aws.lightsail/default/types.md +++ b/artifacts/bicep/aws/aws.lightsail/default/types.md @@ -3,72 +3,97 @@ ## Resource AWS.Lightsail/Alarm@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Lightsail/AlarmProperties](#awslightsailalarmproperties) (Required): properties of the resource +* **properties**: [AWS.Lightsail/AlarmProperties](#awslightsailalarmproperties) (Required, Identifier): properties of the resource ## Resource AWS.Lightsail/Bucket@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Lightsail/BucketProperties](#awslightsailbucketproperties) (Required): properties of the resource +* **properties**: [AWS.Lightsail/BucketProperties](#awslightsailbucketproperties) (Required, Identifier): properties of the resource ## Resource AWS.Lightsail/Certificate@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Lightsail/CertificateProperties](#awslightsailcertificateproperties) (Required): properties of the resource +* **properties**: [AWS.Lightsail/CertificateProperties](#awslightsailcertificateproperties) (Required, Identifier): properties of the resource ## Resource AWS.Lightsail/Container@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Lightsail/ContainerProperties](#awslightsailcontainerproperties) (Required): properties of the resource +* **properties**: [AWS.Lightsail/ContainerProperties](#awslightsailcontainerproperties) (Required, Identifier): properties of the resource ## Resource AWS.Lightsail/Database@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Lightsail/DatabaseProperties](#awslightsaildatabaseproperties) (Required): properties of the resource +* **properties**: [AWS.Lightsail/DatabaseProperties](#awslightsaildatabaseproperties) (Required, Identifier): properties of the resource ## Resource AWS.Lightsail/Disk@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Lightsail/DiskProperties](#awslightsaildiskproperties) (Required): properties of the resource +* **properties**: [AWS.Lightsail/DiskProperties](#awslightsaildiskproperties) (Required, Identifier): properties of the resource ## Resource AWS.Lightsail/Instance@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Lightsail/InstanceProperties](#awslightsailinstanceproperties) (Required): properties of the resource +* **properties**: [AWS.Lightsail/InstanceProperties](#awslightsailinstanceproperties) (Required, Identifier): properties of the resource ## Resource AWS.Lightsail/LoadBalancer@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Lightsail/LoadBalancerProperties](#awslightsailloadbalancerproperties) (Required): properties of the resource +* **properties**: [AWS.Lightsail/LoadBalancerProperties](#awslightsailloadbalancerproperties) (Required, Identifier): properties of the resource ## Resource AWS.Lightsail/LoadBalancerTlsCertificate@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Lightsail/LoadBalancerTlsCertificateProperties](#awslightsailloadbalancertlscertificateproperties) (Required): properties of the resource +* **properties**: [AWS.Lightsail/LoadBalancerTlsCertificateProperties](#awslightsailloadbalancertlscertificateproperties) (Required, Identifier): properties of the resource ## Resource AWS.Lightsail/StaticIp@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Lightsail/StaticIpProperties](#awslightsailstaticipproperties) (Required): properties of the resource +* **properties**: [AWS.Lightsail/StaticIpProperties](#awslightsailstaticipproperties) (Required, Identifier): properties of the resource + +## AccessRules +### Properties +* **AllowPublicOverrides**: bool: A Boolean value that indicates whether the access control list (ACL) permissions that are applied to individual objects override the getObject option that is currently specified. +* **GetObject**: string: Specifies the anonymous access to all objects in a bucket. + +## AddOn +### Properties +* **AddOnType**: string (Required): The add-on type +* **AutoSnapshotAddOnRequest**: [AutoSnapshotAddOn](#autosnapshotaddon) +* **Status**: string: Status of the Addon + +## AddOn +### Properties +* **AddOnType**: string (Required): The add-on type +* **AutoSnapshotAddOnRequest**: [AutoSnapshotAddOn](#autosnapshotaddon) +* **Status**: string: Status of the Addon + +## AutoSnapshotAddOn +### Properties +* **SnapshotTimeOfDay**: string: The daily time when an automatic snapshot will be created. + +## AutoSnapshotAddOn +### Properties +* **SnapshotTimeOfDay**: string: The daily time when an automatic snapshot will be created. ## AWS.Lightsail/AlarmProperties ### Properties @@ -99,16 +124,6 @@ * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. * **Url**: string (ReadOnly): The URL of the bucket. -## AccessRules -### Properties -* **AllowPublicOverrides**: bool: A Boolean value that indicates whether the access control list (ACL) permissions that are applied to individual objects override the getObject option that is currently specified. -* **GetObject**: string: Specifies the anonymous access to all objects in a bucket. - -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## AWS.Lightsail/CertificateProperties ### Properties * **CertificateArn**: string (ReadOnly) @@ -118,11 +133,6 @@ * **SubjectAlternativeNames**: string[]: An array of strings that specify the alternate domains (e.g., example2.com) and subdomains (e.g., blog.example.com) for the certificate. * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## AWS.Lightsail/ContainerProperties ### Properties * **ContainerArn**: string (ReadOnly) @@ -137,63 +147,6 @@ * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. * **Url**: string (ReadOnly): The publicly accessible URL of the container service. -## ContainerServiceDeployment -### Properties -* **Containers**: [Container](#container)[]: An object that describes the configuration for the containers of the deployment. -* **PublicEndpoint**: [PublicEndpoint](#publicendpoint): An object that describes the endpoint of the deployment. - -## Container -### Properties -* **Command**: string[]: The launch command for the container. -* **ContainerName**: string: The name of the container. -* **Environment**: [EnvironmentVariable](#environmentvariable)[]: The environment variables of the container. -* **Image**: string: The name of the image used for the container. -* **Ports**: [PortInfo](#portinfo)[]: The open firewall ports of the container. - -## EnvironmentVariable -### Properties -* **Value**: string -* **Variable**: string - -## PortInfo -### Properties -* **Port**: string -* **Protocol**: string - -## PublicEndpoint -### Properties -* **ContainerName**: string: The name of the container for the endpoint. -* **ContainerPort**: int: The port of the container to which traffic is forwarded to. -* **HealthCheckConfig**: [HealthCheckConfig](#healthcheckconfig): An object that describes the health check configuration of the container. - -## HealthCheckConfig -### Properties -* **HealthyThreshold**: int: The number of consecutive health checks successes required before moving the container to the Healthy state. The default value is 2. -* **IntervalSeconds**: int: The approximate interval, in seconds, between health checks of an individual container. You can specify between 5 and 300 seconds. The default value is 5. -* **Path**: string: The path on the container on which to perform the health check. The default value is /. -* **SuccessCodes**: string: The HTTP codes to use when checking for a successful response from a container. You can specify values between 200 and 499. You can specify multiple values (for example, 200,202) or a range of values (for example, 200-299). -* **TimeoutSeconds**: int: The amount of time, in seconds, during which no response means a failed health check. You can specify between 2 and 60 seconds. The default value is 2. -* **UnhealthyThreshold**: int: The number of consecutive health check failures required before moving the container to the Unhealthy state. The default value is 2. - -## PrivateRegistryAccess -### Properties -* **EcrImagePullerRole**: [Container_EcrImagePullerRole](#containerecrimagepullerrole): An object to describe a request to activate or deactivate the role that you can use to grant an Amazon Lightsail container service access to Amazon Elastic Container Registry (Amazon ECR) private repositories. - -## Container_EcrImagePullerRole -### Properties -* **IsActive**: bool: A Boolean value that indicates whether to activate the role. -* **PrincipalArn**: string (ReadOnly): The Amazon Resource Name (ARN) of the role, if it is activated. - -## PublicDomainName -### Properties -* **CertificateName**: string -* **DomainNames**: string[]: An object that describes the configuration for the containers of the deployment. - -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## AWS.Lightsail/DatabaseProperties ### Properties * **AvailabilityZone**: string: The Availability Zone in which to create your new database. Use the us-east-2a case-sensitive format. @@ -213,22 +166,6 @@ * **RotateMasterUserPassword**: bool (WriteOnly): When true, the master user password is changed to a new strong password generated by Lightsail. Use the get relational database master user password operation to get the new password. * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. -## RelationalDatabaseParameter -### Properties -* **AllowedValues**: string: Specifies the valid range of values for the parameter. -* **ApplyMethod**: string: Indicates when parameter updates are applied. Can be immediate or pending-reboot. -* **ApplyType**: string: Specifies the engine-specific parameter type. -* **DataType**: string: Specifies the valid data type for the parameter. -* **Description**: string: Provides a description of the parameter. -* **IsModifiable**: bool: A Boolean value indicating whether the parameter can be modified. -* **ParameterName**: string: Specifies the name of the parameter. -* **ParameterValue**: string: Specifies the value of the parameter. - -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## AWS.Lightsail/DiskProperties ### Properties * **AddOns**: [AddOn](#addon)[]: An array of objects representing the add-ons to enable for the new instance. @@ -247,26 +184,6 @@ * **SupportCode**: string (ReadOnly): Support code to help identify any issues * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. -## AddOn -### Properties -* **AddOnType**: string (Required): The add-on type -* **AutoSnapshotAddOnRequest**: [AutoSnapshotAddOn](#autosnapshotaddon) -* **Status**: string: Status of the Addon - -## AutoSnapshotAddOn -### Properties -* **SnapshotTimeOfDay**: string: The daily time when an automatic snapshot will be created. - -## Location -### Properties -* **AvailabilityZone**: string (ReadOnly): The Availability Zone in which to create your disk. Use the following format: us-east-2a (case sensitive). Be sure to add the include Availability Zones parameter to your request. -* **RegionName**: string (ReadOnly): The Region Name in which to create your disk. - -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## AWS.Lightsail/InstanceProperties ### Properties * **AddOns**: [AddOn](#addon)[]: An array of objects representing the add-ons to enable for the new instance. @@ -276,6 +193,7 @@ * **Hardware**: [Hardware](#hardware) * **InstanceArn**: string (ReadOnly) * **InstanceName**: string (Required, Identifier): The names to use for your new Lightsail instance. +* **Ipv6Addresses**: string[] (ReadOnly): IPv6 addresses of the instance * **IsStaticIp**: bool (ReadOnly): Is the IP Address of the Instance is the static IP * **KeyPairName**: string: The name of your key pair. * **Location**: [Location](#location) @@ -290,21 +208,55 @@ * **UserData**: string (WriteOnly): A launch script you can create that configures a server with additional user data. For example, you might want to run apt-get -y update. * **UserName**: string (ReadOnly): Username of the Lightsail instance. -## AddOn +## AWS.Lightsail/LoadBalancerProperties ### Properties -* **AddOnType**: string (Required): The add-on type -* **AutoSnapshotAddOnRequest**: [AutoSnapshotAddOn](#autosnapshotaddon) -* **Status**: string: Status of the Addon +* **AttachedInstances**: string[]: The names of the instances attached to the load balancer. +* **HealthCheckPath**: string: The path you provided to perform the load balancer health check. If you didn't specify a health check path, Lightsail uses the root path of your website (e.g., "/"). +* **InstancePort**: int (Required): The instance port where you're creating your load balancer. +* **IpAddressType**: string: The IP address type for the load balancer. The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6. The default value is dualstack. +* **LoadBalancerArn**: string (ReadOnly) +* **LoadBalancerName**: string (Required, Identifier): The name of your load balancer. +* **SessionStickinessEnabled**: bool: Configuration option to enable session stickiness. +* **SessionStickinessLBCookieDurationSeconds**: string: Configuration option to adjust session stickiness cookie duration parameter. +* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. +* **TlsPolicyName**: string: The name of the TLS policy to apply to the load balancer. -## AutoSnapshotAddOn +## AWS.Lightsail/LoadBalancerTlsCertificateProperties ### Properties -* **SnapshotTimeOfDay**: string: The daily time when an automatic snapshot will be created. +* **CertificateAlternativeNames**: string[]: An array of strings listing alternative domains and subdomains for your SSL/TLS certificate. +* **CertificateDomainName**: string (Required): The domain name (e.g., example.com ) for your SSL/TLS certificate. +* **CertificateName**: string (Required, Identifier): The SSL/TLS certificate name. +* **HttpsRedirectionEnabled**: bool: A Boolean value that indicates whether HTTPS redirection is enabled for the load balancer. +* **IsAttached**: bool: When true, the SSL/TLS certificate is attached to the Lightsail load balancer. +* **LoadBalancerName**: string (Required, Identifier): The name of your load balancer. +* **LoadBalancerTlsCertificateArn**: string (ReadOnly) +* **Status**: string (ReadOnly): The validation status of the SSL/TLS certificate. -## Hardware +## AWS.Lightsail/StaticIpProperties ### Properties -* **CpuCount**: int (ReadOnly): CPU count of the Instance. -* **Disks**: [Disk](#disk)[]: Disks attached to the Instance. -* **RamSizeInGb**: int (ReadOnly): RAM Size of the Instance. +* **AttachedTo**: string: The instance where the static IP is attached. +* **IpAddress**: string (ReadOnly): The static IP address. +* **IsAttached**: bool (ReadOnly): A Boolean value indicating whether the static IP is attached. +* **StaticIpArn**: string (ReadOnly) +* **StaticIpName**: string (Required, Identifier): The name of the static IP address. + +## Container +### Properties +* **Command**: string[]: The launch command for the container. +* **ContainerName**: string: The name of the container. +* **Environment**: [EnvironmentVariable](#environmentvariable)[]: The environment variables of the container. +* **Image**: string: The name of the image used for the container. +* **Ports**: [PortInfo](#portinfo)[]: The open firewall ports of the container. + +## Container_EcrImagePullerRole +### Properties +* **IsActive**: bool: A Boolean value that indicates whether to activate the role. +* **PrincipalArn**: string (ReadOnly): The Amazon Resource Name (ARN) of the role, if it is activated. + +## ContainerServiceDeployment +### Properties +* **Containers**: [Container](#container)[]: An object that describes the configuration for the containers of the deployment. +* **PublicEndpoint**: [PublicEndpoint](#publicendpoint): An object that describes the endpoint of the deployment. ## Disk ### Properties @@ -316,20 +268,45 @@ * **Path**: string (Required): Path of the disk attached to the instance. * **SizeInGb**: string: Size of the disk attached to the Instance. +## EnvironmentVariable +### Properties +* **Value**: string +* **Variable**: string + +## Hardware +### Properties +* **CpuCount**: int (ReadOnly): CPU count of the Instance. +* **Disks**: [Disk](#disk)[]: Disks attached to the Instance. +* **RamSizeInGb**: int (ReadOnly): RAM Size of the Instance. + +## HealthCheckConfig +### Properties +* **HealthyThreshold**: int: The number of consecutive health checks successes required before moving the container to the Healthy state. The default value is 2. +* **IntervalSeconds**: int: The approximate interval, in seconds, between health checks of an individual container. You can specify between 5 and 300 seconds. The default value is 5. +* **Path**: string: The path on the container on which to perform the health check. The default value is /. +* **SuccessCodes**: string: The HTTP codes to use when checking for a successful response from a container. You can specify values between 200 and 499. You can specify multiple values (for example, 200,202) or a range of values (for example, 200-299). +* **TimeoutSeconds**: int: The amount of time, in seconds, during which no response means a failed health check. You can specify between 2 and 60 seconds. The default value is 2. +* **UnhealthyThreshold**: int: The number of consecutive health check failures required before moving the container to the Unhealthy state. The default value is 2. + +## Location +### Properties +* **AvailabilityZone**: string (ReadOnly): The Availability Zone in which to create your disk. Use the following format: us-east-2a (case sensitive). Be sure to add the include Availability Zones parameter to your request. +* **RegionName**: string (ReadOnly): The Region Name in which to create your disk. + ## Location ### Properties * **AvailabilityZone**: string (ReadOnly): The Availability Zone in which to create your instance. Use the following format: us-east-2a (case sensitive). Be sure to add the include Availability Zones parameter to your request. * **RegionName**: string (ReadOnly): The Region Name in which to create your instance. +## MonthlyTransfer +### Properties +* **GbPerMonthAllocated**: string (ReadOnly): GbPerMonthAllocated of the Instance. + ## Networking ### Properties * **MonthlyTransfer**: [MonthlyTransfer](#monthlytransfer) * **Ports**: [Port](#port)[] (Required): Ports to the Instance. -## MonthlyTransfer -### Properties -* **GbPerMonthAllocated**: string (ReadOnly): GbPerMonthAllocated of the Instance. - ## Port ### Properties * **AccessDirection**: string: Access Direction for Protocol of the Instance(inbound/outbound). @@ -343,6 +320,37 @@ * **Protocol**: string: Port Protocol of the Instance. * **ToPort**: int: To Port of the Instance. +## PortInfo +### Properties +* **Port**: string +* **Protocol**: string + +## PrivateRegistryAccess +### Properties +* **EcrImagePullerRole**: [Container_EcrImagePullerRole](#containerecrimagepullerrole): An object to describe a request to activate or deactivate the role that you can use to grant an Amazon Lightsail container service access to Amazon Elastic Container Registry (Amazon ECR) private repositories. + +## PublicDomainName +### Properties +* **CertificateName**: string +* **DomainNames**: string[]: An object that describes the configuration for the containers of the deployment. + +## PublicEndpoint +### Properties +* **ContainerName**: string: The name of the container for the endpoint. +* **ContainerPort**: int: The port of the container to which traffic is forwarded to. +* **HealthCheckConfig**: [HealthCheckConfig](#healthcheckconfig): An object that describes the health check configuration of the container. + +## RelationalDatabaseParameter +### Properties +* **AllowedValues**: string: Specifies the valid range of values for the parameter. +* **ApplyMethod**: string: Indicates when parameter updates are applied. Can be immediate or pending-reboot. +* **ApplyType**: string: Specifies the engine-specific parameter type. +* **DataType**: string: Specifies the valid data type for the parameter. +* **Description**: string: Provides a description of the parameter. +* **IsModifiable**: bool: A Boolean value indicating whether the parameter can be modified. +* **ParameterName**: string: Specifies the name of the parameter. +* **ParameterValue**: string: Specifies the value of the parameter. + ## State ### Properties * **Code**: int (ReadOnly): Status code of the Instance. @@ -353,40 +361,33 @@ * **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. * **Value**: string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -## AWS.Lightsail/LoadBalancerProperties +## Tag ### Properties -* **AttachedInstances**: string[]: The names of the instances attached to the load balancer. -* **HealthCheckPath**: string: The path you provided to perform the load balancer health check. If you didn't specify a health check path, Lightsail uses the root path of your website (e.g., "/"). -* **InstancePort**: int (Required): The instance port where you're creating your load balancer. -* **IpAddressType**: string: The IP address type for the load balancer. The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6. The default value is dualstack. -* **LoadBalancerArn**: string (ReadOnly) -* **LoadBalancerName**: string (Required, Identifier): The name of your load balancer. -* **SessionStickinessEnabled**: bool: Configuration option to enable session stickiness. -* **SessionStickinessLBCookieDurationSeconds**: string: Configuration option to adjust session stickiness cookie duration parameter. -* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. -* **TlsPolicyName**: string: The name of the TLS policy to apply to the load balancer. +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ## Tag ### Properties * **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. * **Value**: string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -## AWS.Lightsail/LoadBalancerTlsCertificateProperties +## Tag ### Properties -* **CertificateAlternativeNames**: string[]: An array of strings listing alternative domains and subdomains for your SSL/TLS certificate. -* **CertificateDomainName**: string (Required): The domain name (e.g., example.com ) for your SSL/TLS certificate. -* **CertificateName**: string (Required, Identifier): The SSL/TLS certificate name. -* **HttpsRedirectionEnabled**: bool: A Boolean value that indicates whether HTTPS redirection is enabled for the load balancer. -* **IsAttached**: bool: When true, the SSL/TLS certificate is attached to the Lightsail load balancer. -* **LoadBalancerName**: string (Required, Identifier): The name of your load balancer. -* **LoadBalancerTlsCertificateArn**: string (ReadOnly) -* **Status**: string (ReadOnly): The validation status of the SSL/TLS certificate. +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -## AWS.Lightsail/StaticIpProperties +## Tag ### Properties -* **AttachedTo**: string: The instance where the static IP is attached. -* **IpAddress**: string (ReadOnly): The static IP address. -* **IsAttached**: bool (ReadOnly): A Boolean value indicating whether the static IP is attached. -* **StaticIpArn**: string (ReadOnly) -* **StaticIpName**: string (Required, Identifier): The name of the static IP address. +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. diff --git a/artifacts/bicep/aws/aws.location/default/types.json b/artifacts/bicep/aws/aws.location/default/types.json index ad09a6f5..9786947e 100644 --- a/artifacts/bicep/aws/aws.location/default/types.json +++ b/artifacts/bicep/aws/aws.location/default/types.json @@ -1 +1,1005 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"ApiKeyRestrictions","Properties":{"AllowActions":{"Type":12,"Flags":1},"AllowReferers":{"Type":13,"Flags":0},"AllowResources":{"Type":14,"Flags":1}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"TagMap","Properties":{}}},{"2":{"Name":"iso8601UTC"}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.Location/APIKeyProperties","Properties":{"Arn":{"Type":4,"Flags":2},"CreateTime":{"Type":4,"Flags":2},"Description":{"Type":4,"Flags":0},"ExpireTime":{"Type":4,"Flags":0},"ForceDelete":{"Type":2,"Flags":4},"ForceUpdate":{"Type":2,"Flags":4},"KeyArn":{"Type":4,"Flags":2},"KeyName":{"Type":4,"Flags":17},"NoExpiry":{"Type":2,"Flags":4},"Restrictions":{"Type":8,"Flags":1},"Tags":{"Type":16,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."},"UpdateTime":{"Type":4,"Flags":2}}}},{"3":{"ItemType":9}},{"2":{"Name":"AWS.Location/APIKey","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":15,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Location/APIKey@default","ScopeType":0,"Body":17}},{"2":{"Name":"PricingPlan"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"TagMap","Properties":{}}},{"2":{"Name":"iso8601UTC"}},{"2":{"Name":"AWS.Location/GeofenceCollectionProperties","Properties":{"Arn":{"Type":4,"Flags":2},"CollectionArn":{"Type":4,"Flags":2},"CollectionName":{"Type":4,"Flags":17},"CreateTime":{"Type":4,"Flags":2},"Description":{"Type":4,"Flags":0},"KmsKeyId":{"Type":4,"Flags":0},"PricingPlan":{"Type":4,"Flags":0},"PricingPlanDataSource":{"Type":4,"Flags":0},"Tags":{"Type":24,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."},"UpdateTime":{"Type":4,"Flags":2}}}},{"3":{"ItemType":20}},{"2":{"Name":"AWS.Location/GeofenceCollection","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":23,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Location/GeofenceCollection@default","ScopeType":0,"Body":25}},{"2":{"Name":"MapConfiguration","Properties":{"PoliticalView":{"Type":4,"Flags":0},"Style":{"Type":4,"Flags":1}}}},{"2":{"Name":"PricingPlan"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"TagMap","Properties":{}}},{"2":{"Name":"iso8601UTC"}},{"2":{"Name":"AWS.Location/MapProperties","Properties":{"Arn":{"Type":4,"Flags":2},"Configuration":{"Type":27,"Flags":1},"CreateTime":{"Type":4,"Flags":2},"Description":{"Type":4,"Flags":0},"MapArn":{"Type":4,"Flags":2},"MapName":{"Type":4,"Flags":17},"PricingPlan":{"Type":4,"Flags":0},"Tags":{"Type":33,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."},"UpdateTime":{"Type":4,"Flags":2}}}},{"3":{"ItemType":29}},{"2":{"Name":"AWS.Location/Map","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":32,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Location/Map@default","ScopeType":0,"Body":34}},{"2":{"Name":"DataSourceConfiguration","Properties":{"IntendedUse":{"Type":4,"Flags":0}}}},{"2":{"Name":"IntendedUse"}},{"2":{"Name":"PricingPlan"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"TagMap","Properties":{}}},{"2":{"Name":"iso8601UTC"}},{"2":{"Name":"AWS.Location/PlaceIndexProperties","Properties":{"Arn":{"Type":4,"Flags":2},"CreateTime":{"Type":4,"Flags":2},"DataSource":{"Type":4,"Flags":1},"DataSourceConfiguration":{"Type":36,"Flags":0},"Description":{"Type":4,"Flags":0},"IndexArn":{"Type":4,"Flags":2},"IndexName":{"Type":4,"Flags":17},"PricingPlan":{"Type":4,"Flags":0},"Tags":{"Type":43,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."},"UpdateTime":{"Type":4,"Flags":2}}}},{"3":{"ItemType":39}},{"2":{"Name":"AWS.Location/PlaceIndex","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":42,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Location/PlaceIndex@default","ScopeType":0,"Body":44}},{"2":{"Name":"PricingPlan"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"TagMap","Properties":{}}},{"2":{"Name":"iso8601UTC"}},{"2":{"Name":"AWS.Location/RouteCalculatorProperties","Properties":{"Arn":{"Type":4,"Flags":2},"CalculatorArn":{"Type":4,"Flags":2},"CalculatorName":{"Type":4,"Flags":17},"CreateTime":{"Type":4,"Flags":2},"DataSource":{"Type":4,"Flags":1},"Description":{"Type":4,"Flags":0},"PricingPlan":{"Type":4,"Flags":0},"Tags":{"Type":51,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."},"UpdateTime":{"Type":4,"Flags":2}}}},{"3":{"ItemType":47}},{"2":{"Name":"AWS.Location/RouteCalculator","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":50,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Location/RouteCalculator@default","ScopeType":0,"Body":52}},{"2":{"Name":"PositionFiltering"}},{"2":{"Name":"PricingPlan"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"TagMap","Properties":{}}},{"2":{"Name":"iso8601UTC"}},{"2":{"Name":"AWS.Location/TrackerProperties","Properties":{"Arn":{"Type":4,"Flags":2},"CreateTime":{"Type":4,"Flags":2},"Description":{"Type":4,"Flags":0},"EventBridgeEnabled":{"Type":2,"Flags":0},"KmsKeyEnableGeospatialQueries":{"Type":2,"Flags":0},"KmsKeyId":{"Type":4,"Flags":0},"PositionFiltering":{"Type":4,"Flags":0},"PricingPlan":{"Type":4,"Flags":0},"PricingPlanDataSource":{"Type":4,"Flags":0},"Tags":{"Type":60,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."},"TrackerArn":{"Type":4,"Flags":2},"TrackerName":{"Type":4,"Flags":17},"UpdateTime":{"Type":4,"Flags":2}}}},{"3":{"ItemType":56}},{"2":{"Name":"AWS.Location/Tracker","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":59,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Location/Tracker@default","ScopeType":0,"Body":61}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "ApiKeyRestrictions", + "properties": { + "AllowActions": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "AllowReferers": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "AllowResources": { + "type": { + "$ref": "#/7" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "ObjectType", + "name": "TagMap", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "iso8601UTC", + "properties": {} + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Location/APIKeyProperties" + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Location/APIKeyProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/4" + }, + "flags": 2 + }, + "CreateTime": { + "type": { + "$ref": "#/4" + }, + "flags": 2 + }, + "Description": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "ExpireTime": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "ForceDelete": { + "type": { + "$ref": "#/9" + }, + "flags": 4 + }, + "ForceUpdate": { + "type": { + "$ref": "#/9" + }, + "flags": 4 + }, + "KeyArn": { + "type": { + "$ref": "#/4" + }, + "flags": 2 + }, + "KeyName": { + "type": { + "$ref": "#/4" + }, + "flags": 17 + }, + "NoExpiry": { + "type": { + "$ref": "#/9" + }, + "flags": 4 + }, + "Restrictions": { + "type": { + "$ref": "#/0" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + }, + "UpdateTime": { + "type": { + "$ref": "#/4" + }, + "flags": 2 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Location/APIKey", + "properties": { + "name": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/11" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Location/APIKey@default", + "scopeType": 0, + "body": { + "$ref": "#/12" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "PricingPlan", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "ObjectType", + "name": "TagMap", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "iso8601UTC", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.Location/GeofenceCollectionProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/15" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Location/GeofenceCollectionProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/4" + }, + "flags": 2 + }, + "CollectionArn": { + "type": { + "$ref": "#/4" + }, + "flags": 2 + }, + "CollectionName": { + "type": { + "$ref": "#/4" + }, + "flags": 17 + }, + "CreateTime": { + "type": { + "$ref": "#/4" + }, + "flags": 2 + }, + "Description": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "KmsKeyId": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "PricingPlan": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "PricingPlanDataSource": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "This shape is deprecated since 2022-02-01: Deprecated. No longer allowed." + }, + "Tags": { + "type": { + "$ref": "#/19" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + }, + "UpdateTime": { + "type": { + "$ref": "#/4" + }, + "flags": 2 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Location/GeofenceCollection", + "properties": { + "name": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/20" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Location/GeofenceCollection@default", + "scopeType": 0, + "body": { + "$ref": "#/21" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "MapConfiguration", + "properties": { + "CustomLayers": { + "type": { + "$ref": "#/28" + }, + "flags": 0 + }, + "PoliticalView": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "Style": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "PricingPlan", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "ObjectType", + "name": "TagMap", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "iso8601UTC", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Location/MapProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/25" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Location/MapProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/4" + }, + "flags": 2 + }, + "Configuration": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + }, + "CreateTime": { + "type": { + "$ref": "#/4" + }, + "flags": 2 + }, + "Description": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "MapArn": { + "type": { + "$ref": "#/4" + }, + "flags": 2 + }, + "MapName": { + "type": { + "$ref": "#/4" + }, + "flags": 17 + }, + "PricingPlan": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/30" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + }, + "UpdateTime": { + "type": { + "$ref": "#/4" + }, + "flags": 2 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Location/Map", + "properties": { + "name": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/31" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Location/Map@default", + "scopeType": 0, + "body": { + "$ref": "#/32" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "DataSourceConfiguration", + "properties": { + "IntendedUse": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "IntendedUse", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PricingPlan", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "ObjectType", + "name": "TagMap", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "iso8601UTC", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.Location/PlaceIndexProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/37" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Location/PlaceIndexProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/4" + }, + "flags": 2 + }, + "CreateTime": { + "type": { + "$ref": "#/4" + }, + "flags": 2 + }, + "DataSource": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + }, + "DataSourceConfiguration": { + "type": { + "$ref": "#/34" + }, + "flags": 0 + }, + "Description": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "IndexArn": { + "type": { + "$ref": "#/4" + }, + "flags": 2 + }, + "IndexName": { + "type": { + "$ref": "#/4" + }, + "flags": 17 + }, + "PricingPlan": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/41" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + }, + "UpdateTime": { + "type": { + "$ref": "#/4" + }, + "flags": 2 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Location/PlaceIndex", + "properties": { + "name": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/42" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Location/PlaceIndex@default", + "scopeType": 0, + "body": { + "$ref": "#/43" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "PricingPlan", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "ObjectType", + "name": "TagMap", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "iso8601UTC", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.Location/RouteCalculatorProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/46" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Location/RouteCalculatorProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/4" + }, + "flags": 2 + }, + "CalculatorArn": { + "type": { + "$ref": "#/4" + }, + "flags": 2 + }, + "CalculatorName": { + "type": { + "$ref": "#/4" + }, + "flags": 17 + }, + "CreateTime": { + "type": { + "$ref": "#/4" + }, + "flags": 2 + }, + "DataSource": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + }, + "Description": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "PricingPlan": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/50" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + }, + "UpdateTime": { + "type": { + "$ref": "#/4" + }, + "flags": 2 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Location/RouteCalculator", + "properties": { + "name": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/51" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Location/RouteCalculator@default", + "scopeType": 0, + "body": { + "$ref": "#/52" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "PositionFiltering", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PricingPlan", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "ObjectType", + "name": "TagMap", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "iso8601UTC", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.Location/TrackerProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/56" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Location/TrackerProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/4" + }, + "flags": 2 + }, + "CreateTime": { + "type": { + "$ref": "#/4" + }, + "flags": 2 + }, + "Description": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "EventBridgeEnabled": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "KmsKeyEnableGeospatialQueries": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "KmsKeyId": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "PositionFiltering": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "PricingPlan": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "PricingPlanDataSource": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "This shape is deprecated since 2022-02-01: Deprecated. No longer allowed." + }, + "Tags": { + "type": { + "$ref": "#/60" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + }, + "TrackerArn": { + "type": { + "$ref": "#/4" + }, + "flags": 2 + }, + "TrackerName": { + "type": { + "$ref": "#/4" + }, + "flags": 17 + }, + "UpdateTime": { + "type": { + "$ref": "#/4" + }, + "flags": 2 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Location/Tracker", + "properties": { + "name": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/61" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Location/Tracker@default", + "scopeType": 0, + "body": { + "$ref": "#/62" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.location/default/types.md b/artifacts/bicep/aws/aws.location/default/types.md index 192ce029..6ac5a6f1 100644 --- a/artifacts/bicep/aws/aws.location/default/types.md +++ b/artifacts/bicep/aws/aws.location/default/types.md @@ -3,44 +3,50 @@ ## Resource AWS.Location/APIKey@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Location/APIKeyProperties](#awslocationapikeyproperties) (Required): properties of the resource +* **properties**: [AWS.Location/APIKeyProperties](#awslocationapikeyproperties) (Required, Identifier): properties of the resource ## Resource AWS.Location/GeofenceCollection@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Location/GeofenceCollectionProperties](#awslocationgeofencecollectionproperties) (Required): properties of the resource +* **properties**: [AWS.Location/GeofenceCollectionProperties](#awslocationgeofencecollectionproperties) (Required, Identifier): properties of the resource ## Resource AWS.Location/Map@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Location/MapProperties](#awslocationmapproperties) (Required): properties of the resource +* **properties**: [AWS.Location/MapProperties](#awslocationmapproperties) (Required, Identifier): properties of the resource ## Resource AWS.Location/PlaceIndex@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Location/PlaceIndexProperties](#awslocationplaceindexproperties) (Required): properties of the resource +* **properties**: [AWS.Location/PlaceIndexProperties](#awslocationplaceindexproperties) (Required, Identifier): properties of the resource ## Resource AWS.Location/RouteCalculator@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Location/RouteCalculatorProperties](#awslocationroutecalculatorproperties) (Required): properties of the resource +* **properties**: [AWS.Location/RouteCalculatorProperties](#awslocationroutecalculatorproperties) (Required, Identifier): properties of the resource ## Resource AWS.Location/Tracker@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Location/TrackerProperties](#awslocationtrackerproperties) (Required): properties of the resource +* **properties**: [AWS.Location/TrackerProperties](#awslocationtrackerproperties) (Required, Identifier): properties of the resource + +## ApiKeyRestrictions +### Properties +* **AllowActions**: string[] (Required) +* **AllowReferers**: string[] +* **AllowResources**: string[] (Required) ## AWS.Location/APIKeyProperties ### Properties @@ -57,17 +63,6 @@ * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. * **UpdateTime**: string (ReadOnly) -## ApiKeyRestrictions -### Properties -* **AllowActions**: string[] (Required) -* **AllowReferers**: string[] -* **AllowResources**: string[] (Required) - -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## AWS.Location/GeofenceCollectionProperties ### Properties * **Arn**: string (ReadOnly) @@ -77,15 +72,10 @@ * **Description**: string * **KmsKeyId**: string * **PricingPlan**: string -* **PricingPlanDataSource**: string +* **PricingPlanDataSource**: string: This shape is deprecated since 2022-02-01: Deprecated. No longer allowed. * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. * **UpdateTime**: string (ReadOnly) -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## AWS.Location/MapProperties ### Properties * **Arn**: string (ReadOnly) @@ -98,16 +88,6 @@ * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. * **UpdateTime**: string (ReadOnly) -## MapConfiguration -### Properties -* **PoliticalView**: string -* **Style**: string (Required) - -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## AWS.Location/PlaceIndexProperties ### Properties * **Arn**: string (ReadOnly) @@ -121,15 +101,6 @@ * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. * **UpdateTime**: string (ReadOnly) -## DataSourceConfiguration -### Properties -* **IntendedUse**: string - -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## AWS.Location/RouteCalculatorProperties ### Properties * **Arn**: string (ReadOnly) @@ -142,11 +113,6 @@ * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. * **UpdateTime**: string (ReadOnly) -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## AWS.Location/TrackerProperties ### Properties * **Arn**: string (ReadOnly) @@ -157,12 +123,47 @@ * **KmsKeyId**: string * **PositionFiltering**: string * **PricingPlan**: string -* **PricingPlanDataSource**: string +* **PricingPlanDataSource**: string: This shape is deprecated since 2022-02-01: Deprecated. No longer allowed. * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. * **TrackerArn**: string (ReadOnly) * **TrackerName**: string (Required, Identifier) * **UpdateTime**: string (ReadOnly) +## DataSourceConfiguration +### Properties +* **IntendedUse**: string + +## MapConfiguration +### Properties +* **CustomLayers**: string[] +* **PoliticalView**: string +* **Style**: string (Required) + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + ## Tag ### Properties * **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. diff --git a/artifacts/bicep/aws/aws.logs/default/types.json b/artifacts/bicep/aws/aws.logs/default/types.json index eab49b34..f3462728 100644 --- a/artifacts/bicep/aws/aws.logs/default/types.json +++ b/artifacts/bicep/aws/aws.logs/default/types.json @@ -1 +1,1213 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"AWS.Logs/AccountPolicyProperties","Properties":{"AccountId":{"Type":4,"Flags":18,"Description":"User account id"},"PolicyDocument":{"Type":4,"Flags":1,"Description":"The body of the policy document you want to use for this topic.\n\nYou can only add one policy per PolicyType.\n\nThe policy must be in JSON string format.\n\nLength Constraints: Maximum length of 30720"},"PolicyName":{"Type":4,"Flags":17,"Description":"The name of the account policy"},"PolicyType":{"Type":4,"Flags":17,"Description":"Type of the policy."},"Scope":{"Type":4,"Flags":0,"Description":"Scope for policy application"}}}},{"2":{"Name":"AWS.Logs/AccountPolicy","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":8,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Logs/AccountPolicy@default","ScopeType":0,"Body":9}},{"2":{"Name":"Arn"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode"},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode"}}}},{"2":{"Name":"AWS.Logs/DeliveryProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) that uniquely identifies this delivery."},"DeliveryDestinationArn":{"Type":4,"Flags":1,"Description":"The ARN of the delivery destination that is associated with this delivery."},"DeliveryDestinationType":{"Type":4,"Flags":2,"Description":"Displays whether the delivery destination associated with this delivery is CloudWatch Logs, Amazon S3, or Kinesis Data Firehose."},"DeliveryId":{"Type":4,"Flags":18,"Description":"The unique ID that identifies this delivery in your account."},"DeliverySourceName":{"Type":4,"Flags":1,"Description":"The name of the delivery source that is associated with this delivery."},"Tags":{"Type":14,"Flags":0,"Description":"The tags that have been assigned to this delivery."}}}},{"3":{"ItemType":12}},{"2":{"Name":"AWS.Logs/Delivery","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":13,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Logs/Delivery@default","ScopeType":0,"Body":15}},{"2":{"Name":"Arn"}},{"2":{"Name":"DestinationPolicy","Properties":{"DeliveryDestinationName":{"Type":4,"Flags":1,"Description":"The name of the delivery destination to assign this policy to"},"DeliveryDestinationPolicy":{"Type":4,"Flags":1,"Description":"The contents of the policy attached to the delivery destination"}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.Logs/DeliveryDestinationProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) that uniquely identifies this delivery destination."},"DeliveryDestinationPolicy":{"Type":21,"Flags":0,"Description":"IAM policy that grants permissions to CloudWatch Logs to deliver logs cross-account to a specified destination in this account.\n\nThe policy must be in JSON string format.\n\nLength Constraints: Maximum length of 51200"},"DeliveryDestinationType":{"Type":4,"Flags":2,"Description":"Displays whether this delivery destination is CloudWatch Logs, Amazon S3, or Kinesis Data Firehose."},"DestinationResourceArn":{"Type":4,"Flags":0,"Description":"The ARN of the AWS resource that will receive the logs."},"Name":{"Type":4,"Flags":17,"Description":"The name of this delivery destination."},"Tags":{"Type":22,"Flags":0,"Description":"The tags that have been assigned to this delivery destination."}}}},{"2":{"Name":"DeliveryDestination_DeliveryDestinationPolicy","Properties":{}}},{"3":{"ItemType":19}},{"2":{"Name":"AWS.Logs/DeliveryDestination","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":20,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Logs/DeliveryDestination@default","ScopeType":0,"Body":23}},{"2":{"Name":"Arn"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode"},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode"}}}},{"2":{"Name":"AWS.Logs/DeliverySourceProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) that uniquely identifies this delivery source."},"LogType":{"Type":4,"Flags":0,"Description":"The type of logs being delivered. Only mandatory when the resourceArn could match more than one. In such a case, the error message will contain all the possible options."},"Name":{"Type":4,"Flags":17,"Description":"The unique name of the Log source."},"ResourceArn":{"Type":4,"Flags":4,"Description":"The ARN of the resource that will be sending the logs."},"ResourceArns":{"Type":28,"Flags":2,"Description":"This array contains the ARN of the AWS resource that sends logs and is represented by this delivery source. Currently, only one ARN can be in the array."},"Service":{"Type":4,"Flags":2,"Description":"The AWS service that is sending logs."},"Tags":{"Type":29,"Flags":0,"Description":"The tags that have been assigned to this delivery source."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":26}},{"2":{"Name":"AWS.Logs/DeliverySource","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":27,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Logs/DeliverySource@default","ScopeType":0,"Body":30}},{"2":{"Name":"AWS.Logs/DestinationProperties","Properties":{"Arn":{"Type":4,"Flags":2},"DestinationName":{"Type":4,"Flags":17,"Description":"The name of the destination resource"},"DestinationPolicy":{"Type":4,"Flags":0,"Description":"An IAM policy document that governs which AWS accounts can create subscription filters against this destination."},"RoleArn":{"Type":4,"Flags":1,"Description":"The ARN of an IAM role that permits CloudWatch Logs to send data to the specified AWS resource"},"TargetArn":{"Type":4,"Flags":1,"Description":"The ARN of the physical target where the log events are delivered (for example, a Kinesis stream)"}}}},{"2":{"Name":"AWS.Logs/Destination","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":32,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Logs/Destination@default","ScopeType":0,"Body":33}},{"2":{"Name":"AWS.Logs/LogAnomalyDetectorProperties","Properties":{"AccountId":{"Type":4,"Flags":4,"Description":"Account ID for owner of detector"},"AnomalyDetectorArn":{"Type":4,"Flags":18,"Description":"ARN of LogAnomalyDetector"},"AnomalyDetectorStatus":{"Type":4,"Flags":2,"Description":"Current status of detector."},"AnomalyVisibilityTime":{"Type":3,"Flags":0,"Description":""},"CreationTimeStamp":{"Type":3,"Flags":2,"Description":"When detector was created."},"DetectorName":{"Type":4,"Flags":0,"Description":"Name of detector"},"EvaluationFrequency":{"Type":4,"Flags":0,"Description":"How often log group is evaluated"},"FilterPattern":{"Type":4,"Flags":0,"Description":""},"KmsKeyId":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) of the CMK to use when encrypting log data."},"LastModifiedTimeStamp":{"Type":3,"Flags":2,"Description":"When detector was lsat modified."},"LogGroupArnList":{"Type":36,"Flags":0,"Description":"List of Arns for the given log group"}}}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.Logs/LogAnomalyDetector","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":35,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Logs/LogAnomalyDetector@default","ScopeType":0,"Body":37}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., :, /, =, +, - and @."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., :, /, =, +, - and @."}}}},{"2":{"Name":"AWS.Logs/LogGroupProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"The CloudWatch log group ARN."},"DataProtectionPolicy":{"Type":41,"Flags":0,"Description":"The body of the policy document you want to use for this topic.\n\nYou can only add one policy per topic.\n\nThe policy must be in JSON string format.\n\nLength Constraints: Maximum length of 30720"},"KmsKeyId":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) of the CMK to use when encrypting log data."},"LogGroupClass":{"Type":4,"Flags":0,"Description":"The class of the log group. Possible values are: STANDARD and INFREQUENT_ACCESS, with STANDARD being the default class"},"LogGroupName":{"Type":4,"Flags":16,"Description":"The name of the log group. If you don't specify a name, AWS CloudFormation generates a unique ID for the log group."},"RetentionInDays":{"Type":3,"Flags":0,"Description":"The number of days to retain the log events in the specified log group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1096, 1827, and 3653."},"Tags":{"Type":42,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."}}}},{"2":{"Name":"LogGroup_DataProtectionPolicy","Properties":{}}},{"3":{"ItemType":39}},{"2":{"Name":"AWS.Logs/LogGroup","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":40,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Logs/LogGroup@default","ScopeType":0,"Body":43}},{"2":{"Name":"Dimension","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key of the dimension. Maximum length of 255."},"Value":{"Type":4,"Flags":1,"Description":"The value of the dimension. Maximum length of 255."}}}},{"2":{"Name":"MetricTransformation","Properties":{"DefaultValue":{"Type":3,"Flags":0,"Description":"The value to emit when a filter pattern does not match a log event. This value can be null."},"Dimensions":{"Type":47,"Flags":0,"Description":"Dimensions are the key-value pairs that further define a metric"},"MetricName":{"Type":4,"Flags":1,"Description":"The name of the CloudWatch metric. Metric name must be in ASCII format."},"MetricNamespace":{"Type":4,"Flags":1,"Description":"The namespace of the CloudWatch metric."},"MetricValue":{"Type":4,"Flags":1,"Description":"The value to publish to the CloudWatch metric when a filter pattern matches a log event."},"Unit":{"Type":4,"Flags":0,"Description":"The unit to assign to the metric. If you omit this, the unit is set as None."}}}},{"3":{"ItemType":45}},{"2":{"Name":"AWS.Logs/MetricFilterProperties","Properties":{"FilterName":{"Type":4,"Flags":16,"Description":"A name for the metric filter."},"FilterPattern":{"Type":4,"Flags":1,"Description":"Pattern that Logs follows to interpret each entry in a log."},"LogGroupName":{"Type":4,"Flags":17,"Description":"Existing log group that you want to associate with this filter."},"MetricTransformations":{"Type":49,"Flags":1,"Description":"A collection of information that defines how metric data gets emitted."}}}},{"3":{"ItemType":46}},{"2":{"Name":"AWS.Logs/MetricFilter","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":48,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Logs/MetricFilter@default","ScopeType":0,"Body":50}},{"2":{"Name":"LogGroup"}},{"2":{"Name":"AWS.Logs/QueryDefinitionProperties","Properties":{"LogGroupNames":{"Type":54,"Flags":0,"Description":"Optionally define specific log groups as part of your query definition"},"Name":{"Type":4,"Flags":1,"Description":"A name for the saved query definition"},"QueryDefinitionId":{"Type":4,"Flags":18,"Description":"Unique identifier of a query definition"},"QueryString":{"Type":4,"Flags":1,"Description":"The query string to use for this definition"}}}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.Logs/QueryDefinition","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":53,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Logs/QueryDefinition@default","ScopeType":0,"Body":55}},{"2":{"Name":"AWS.Logs/ResourcePolicyProperties","Properties":{"PolicyDocument":{"Type":4,"Flags":1,"Description":"The policy document"},"PolicyName":{"Type":4,"Flags":17,"Description":"A name for resource policy"}}}},{"2":{"Name":"AWS.Logs/ResourcePolicy","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":57,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Logs/ResourcePolicy@default","ScopeType":0,"Body":58}},{"2":{"Name":"AWS.Logs/SubscriptionFilterProperties","Properties":{"DestinationArn":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) of the destination."},"Distribution":{"Type":4,"Flags":0,"Description":"The method used to distribute log data to the destination. By default, log data is grouped by log stream, but the grouping can be set to random for a more even distribution. This property is only applicable when the destination is an Amazon Kinesis stream."},"FilterName":{"Type":4,"Flags":16,"Description":"The name of the filter generated by resource."},"FilterPattern":{"Type":4,"Flags":1,"Description":"The filtering expressions that restrict what gets delivered to the destination AWS resource."},"LogGroupName":{"Type":4,"Flags":17,"Description":"Existing log group that you want to associate with this filter."},"RoleArn":{"Type":4,"Flags":0,"Description":"The ARN of an IAM role that grants CloudWatch Logs permissions to deliver ingested log events to the destination stream. You don't need to provide the ARN when you are working with a logical destination for cross-account delivery."}}}},{"2":{"Name":"AWS.Logs/SubscriptionFilter","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":60,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Logs/SubscriptionFilter@default","ScopeType":0,"Body":61}}] \ No newline at end of file +[ + { + "$type": "StringLiteralType", + "value": "AWS.Logs/AccountPolicyProperties" + }, + { + "$type": "StringType" + }, + { + "$type": "ObjectType", + "name": "AWS.Logs/AccountPolicyProperties", + "properties": { + "AccountId": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "User account id" + }, + "PolicyDocument": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The body of the policy document you want to use for this topic.\n\nYou can only add one policy per PolicyType.\n\nThe policy must be in JSON string format.\n\nLength Constraints: Maximum length of 30720" + }, + "PolicyName": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The name of the account policy" + }, + "PolicyType": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "Type of the policy." + }, + "Scope": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Scope for policy application" + }, + "SelectionCriteria": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Log group selection criteria to apply policy only to a subset of log groups. SelectionCriteria string can be up to 25KB and cloudwatchlogs determines the length of selectionCriteria by using its UTF-8 bytes" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Logs/AccountPolicy", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Logs/AccountPolicy@default", + "scopeType": 0, + "body": { + "$ref": "#/3" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Arn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode" + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode" + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Logs/DeliveryProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Logs/DeliveryProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) that uniquely identifies this delivery." + }, + "DeliveryDestinationArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The ARN of the delivery destination that is associated with this delivery." + }, + "DeliveryDestinationType": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "Displays whether the delivery destination associated with this delivery is CloudWatch Logs, Amazon S3, or Kinesis Data Firehose." + }, + "DeliveryId": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The unique ID that identifies this delivery in your account." + }, + "DeliverySourceName": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The name of the delivery source that is associated with this delivery." + }, + "Tags": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The tags that have been assigned to this delivery." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Logs/Delivery", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/9" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Logs/Delivery@default", + "scopeType": 0, + "body": { + "$ref": "#/10" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Arn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DestinationPolicy", + "properties": { + "DeliveryDestinationName": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The name of the delivery destination to assign this policy to" + }, + "DeliveryDestinationPolicy": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The contents of the policy attached to the delivery destination" + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Logs/DeliveryDestinationProperties" + }, + { + "$type": "ObjectType", + "name": "DeliveryDestination_DeliveryDestinationPolicy", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/14" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Logs/DeliveryDestinationProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) that uniquely identifies this delivery destination." + }, + "DeliveryDestinationPolicy": { + "type": { + "$ref": "#/16" + }, + "flags": 0, + "description": "IAM policy that grants permissions to CloudWatch Logs to deliver logs cross-account to a specified destination in this account.\n\nThe policy must be in JSON string format.\n\nLength Constraints: Maximum length of 51200" + }, + "DeliveryDestinationType": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "Displays whether this delivery destination is CloudWatch Logs, Amazon S3, or Kinesis Data Firehose." + }, + "DestinationResourceArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The ARN of the AWS resource that will receive the logs." + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The name of this delivery destination." + }, + "Tags": { + "type": { + "$ref": "#/17" + }, + "flags": 0, + "description": "The tags that have been assigned to this delivery destination." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Logs/DeliveryDestination", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/18" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Logs/DeliveryDestination@default", + "scopeType": 0, + "body": { + "$ref": "#/19" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Arn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode" + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode" + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Logs/DeliverySourceProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/22" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Logs/DeliverySourceProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) that uniquely identifies this delivery source." + }, + "LogType": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The type of logs being delivered. Only mandatory when the resourceArn could match more than one. In such a case, the error message will contain all the possible options." + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The unique name of the Log source." + }, + "ResourceArn": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The ARN of the resource that will be sending the logs." + }, + "ResourceArns": { + "type": { + "$ref": "#/24" + }, + "flags": 2, + "description": "This array contains the ARN of the AWS resource that sends logs and is represented by this delivery source. Currently, only one ARN can be in the array." + }, + "Service": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The AWS service that is sending logs." + }, + "Tags": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "The tags that have been assigned to this delivery source." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Logs/DeliverySource", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/26" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Logs/DeliverySource@default", + "scopeType": 0, + "body": { + "$ref": "#/27" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.Logs/DestinationProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.Logs/DestinationProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "DestinationName": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The name of the destination resource" + }, + "DestinationPolicy": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "An IAM policy document that governs which AWS accounts can create subscription filters against this destination." + }, + "RoleArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The ARN of an IAM role that permits CloudWatch Logs to send data to the specified AWS resource" + }, + "TargetArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The ARN of the physical target where the log events are delivered (for example, a Kinesis stream)" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Logs/Destination", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/30" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Logs/Destination@default", + "scopeType": 0, + "body": { + "$ref": "#/31" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.Logs/LogAnomalyDetectorProperties" + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Logs/LogAnomalyDetectorProperties", + "properties": { + "AccountId": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "Account ID for owner of detector" + }, + "AnomalyDetectorArn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "ARN of LogAnomalyDetector" + }, + "AnomalyDetectorStatus": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "Current status of detector." + }, + "AnomalyVisibilityTime": { + "type": { + "$ref": "#/34" + }, + "flags": 0, + "description": "" + }, + "CreationTimeStamp": { + "type": { + "$ref": "#/34" + }, + "flags": 2, + "description": "When detector was created." + }, + "DetectorName": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Name of detector" + }, + "EvaluationFrequency": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "How often log group is evaluated" + }, + "FilterPattern": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "" + }, + "KmsKeyId": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the CMK to use when encrypting log data." + }, + "LastModifiedTimeStamp": { + "type": { + "$ref": "#/34" + }, + "flags": 2, + "description": "When detector was lsat modified." + }, + "LogGroupArnList": { + "type": { + "$ref": "#/35" + }, + "flags": 0, + "description": "List of Arns for the given log group" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Logs/LogAnomalyDetector", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/36" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Logs/LogAnomalyDetector@default", + "scopeType": 0, + "body": { + "$ref": "#/37" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "" + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "" + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Logs/LogGroupProperties" + }, + { + "$type": "ObjectType", + "name": "LogGroup_DataProtectionPolicy", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/39" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Logs/LogGroupProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "" + }, + "DataProtectionPolicy": { + "type": { + "$ref": "#/41" + }, + "flags": 0, + "description": "Creates a data protection policy and assigns it to the log group. A data protection policy can help safeguard sensitive data that's ingested by the log group by auditing and masking the sensitive log data. When a user who does not have permission to view masked data views a log event that includes masked data, the sensitive data is replaced by asterisks.\n For more information, including a list of types of data that can be audited and masked, see [Protect sensitive log data with masking](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data.html)." + }, + "KmsKeyId": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data.\n To associate an KMS key with the log group, specify the ARN of that KMS key here. If you do so, ingested data is encrypted using this key. This association is stored as long as the data encrypted with the KMS key is still within CWL. This enables CWL to decrypt this data whenever it is requested.\n If you attempt to associate a KMS key with the log group but the KMS key doesn't exist or is deactivated, you will receive an ``InvalidParameterException`` error.\n Log group data is always encrypted in CWL. If you omit this key, the encryption does not use KMS. For more information, see [Encrypt log data in using](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/encrypt-log-data-kms.html)" + }, + "LogGroupClass": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Specifies the log group class for this log group. There are two classes:\n + The ``Standard`` log class supports all CWL features.\n + The ``Infrequent Access`` log class supports a subset of CWL features and incurs lower costs.\n \n For details about the features supported by each class, see [Log classes](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch_Logs_Log_Classes.html)" + }, + "LogGroupName": { + "type": { + "$ref": "#/1" + }, + "flags": 16, + "description": "The name of the log group. If you don't specify a name, CFNlong generates a unique ID for the log group." + }, + "RetentionInDays": { + "type": { + "$ref": "#/34" + }, + "flags": 0, + "description": "The number of days to retain the log events in the specified log group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1096, 1827, 2192, 2557, 2922, 3288, and 3653.\n To set a log group so that its log events do not expire, use [DeleteRetentionPolicy](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DeleteRetentionPolicy.html)." + }, + "Tags": { + "type": { + "$ref": "#/42" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to the log group.\n For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Logs/LogGroup", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/43" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Logs/LogGroup@default", + "scopeType": 0, + "body": { + "$ref": "#/44" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Dimension", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The name for the CW metric dimension that the metric filter creates.\n Dimension names must contain only ASCII characters, must include at least one non-whitespace character, and cannot start with a colon (:)." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The log event field that will contain the value for this dimension. This dimension will only be published for a metric if the value is found in the log event. For example, ``$.eventType`` for JSON log events, or ``$server`` for space-delimited log events." + } + } + }, + { + "$type": "ObjectType", + "name": "MetricTransformation", + "properties": { + "DefaultValue": { + "type": { + "$ref": "#/34" + }, + "flags": 0, + "description": "(Optional) The value to emit when a filter pattern does not match a log event. This value can be null." + }, + "Dimensions": { + "type": { + "$ref": "#/48" + }, + "flags": 0, + "description": "The fields to use as dimensions for the metric. One metric filter can include as many as three dimensions.\n Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as ``IPAddress`` or ``requestID`` as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric. \n CloudWatch Logs disables a metric filter if it generates 1000 different name/value pairs for your specified dimensions within a certain amount of time. This helps to prevent accidental high charges.\n You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see [Creating a Billing Alarm to Monitor Your Estimated Charges](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/monitor_estimated_charges_with_cloudwatch.html)." + }, + "MetricName": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The name of the CloudWatch metric." + }, + "MetricNamespace": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "A custom namespace to contain your metric in CloudWatch. Use namespaces to group together metrics that are similar. For more information, see [Namespaces](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Namespace)." + }, + "MetricValue": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value that is published to the CloudWatch metric. For example, if you're counting the occurrences of a particular term like ``Error``, specify 1 for the metric value. If you're counting the number of bytes transferred, reference the value that is in the log event by using $. followed by the name of the field that you specified in the filter pattern, such as ``$.size``." + }, + "Unit": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The unit to assign to the metric. If you omit this, the unit is set as ``None``." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/46" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Logs/MetricFilterProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/47" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Logs/MetricFilterProperties", + "properties": { + "FilterName": { + "type": { + "$ref": "#/1" + }, + "flags": 16, + "description": "The name of the metric filter." + }, + "FilterPattern": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "A filter pattern for extracting metric data out of ingested log events. For more information, see [Filter and Pattern Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html)." + }, + "LogGroupName": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The name of an existing log group that you want to associate with this metric filter." + }, + "MetricTransformations": { + "type": { + "$ref": "#/50" + }, + "flags": 1, + "description": "The metric transformations." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Logs/MetricFilter", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/51" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Logs/MetricFilter@default", + "scopeType": 0, + "body": { + "$ref": "#/52" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "LogGroup", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.Logs/QueryDefinitionProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Logs/QueryDefinitionProperties", + "properties": { + "LogGroupNames": { + "type": { + "$ref": "#/56" + }, + "flags": 0, + "description": "Optionally define specific log groups as part of your query definition" + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "A name for the saved query definition" + }, + "QueryDefinitionId": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "Unique identifier of a query definition" + }, + "QueryString": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The query string to use for this definition" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Logs/QueryDefinition", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/57" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Logs/QueryDefinition@default", + "scopeType": 0, + "body": { + "$ref": "#/58" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.Logs/ResourcePolicyProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.Logs/ResourcePolicyProperties", + "properties": { + "PolicyDocument": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The policy document" + }, + "PolicyName": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "A name for resource policy" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Logs/ResourcePolicy", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/61" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Logs/ResourcePolicy@default", + "scopeType": 0, + "body": { + "$ref": "#/62" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.Logs/SubscriptionFilterProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.Logs/SubscriptionFilterProperties", + "properties": { + "DestinationArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of the destination." + }, + "Distribution": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The method used to distribute log data to the destination, which can be either random or grouped by log stream." + }, + "FilterName": { + "type": { + "$ref": "#/1" + }, + "flags": 16, + "description": "The name of the subscription filter." + }, + "FilterPattern": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The filtering expressions that restrict what gets delivered to the destination AWS resource. For more information about the filter pattern syntax, see [Filter and Pattern Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html)." + }, + "LogGroupName": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The log group to associate with the subscription filter. All log events that are uploaded to this log group are filtered and delivered to the specified AWS resource if the filter pattern matches the log events." + }, + "RoleArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The ARN of an IAM role that grants CWL permissions to deliver ingested log events to the destination stream. You don't need to provide the ARN when you are working with a logical destination for cross-account delivery." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Logs/SubscriptionFilter", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/65" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Logs/SubscriptionFilter@default", + "scopeType": 0, + "body": { + "$ref": "#/66" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.logs/default/types.md b/artifacts/bicep/aws/aws.logs/default/types.md index 81b5743a..dfa9af0d 100644 --- a/artifacts/bicep/aws/aws.logs/default/types.md +++ b/artifacts/bicep/aws/aws.logs/default/types.md @@ -3,79 +3,79 @@ ## Resource AWS.Logs/AccountPolicy@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Logs/AccountPolicyProperties](#awslogsaccountpolicyproperties) (Required): properties of the resource +* **properties**: [AWS.Logs/AccountPolicyProperties](#awslogsaccountpolicyproperties) (Required, Identifier): properties of the resource ## Resource AWS.Logs/Delivery@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Logs/DeliveryProperties](#awslogsdeliveryproperties) (Required): properties of the resource +* **properties**: [AWS.Logs/DeliveryProperties](#awslogsdeliveryproperties) (Required, Identifier): properties of the resource ## Resource AWS.Logs/DeliveryDestination@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Logs/DeliveryDestinationProperties](#awslogsdeliverydestinationproperties) (Required): properties of the resource +* **properties**: [AWS.Logs/DeliveryDestinationProperties](#awslogsdeliverydestinationproperties) (Required, Identifier): properties of the resource ## Resource AWS.Logs/DeliverySource@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Logs/DeliverySourceProperties](#awslogsdeliverysourceproperties) (Required): properties of the resource +* **properties**: [AWS.Logs/DeliverySourceProperties](#awslogsdeliverysourceproperties) (Required, Identifier): properties of the resource ## Resource AWS.Logs/Destination@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Logs/DestinationProperties](#awslogsdestinationproperties) (Required): properties of the resource +* **properties**: [AWS.Logs/DestinationProperties](#awslogsdestinationproperties) (Required, Identifier): properties of the resource ## Resource AWS.Logs/LogAnomalyDetector@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Logs/LogAnomalyDetectorProperties](#awslogsloganomalydetectorproperties): properties of the resource +* **properties**: [AWS.Logs/LogAnomalyDetectorProperties](#awslogsloganomalydetectorproperties) (Identifier): properties of the resource ## Resource AWS.Logs/LogGroup@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Logs/LogGroupProperties](#awslogsloggroupproperties): properties of the resource +* **properties**: [AWS.Logs/LogGroupProperties](#awslogsloggroupproperties) (Identifier): properties of the resource ## Resource AWS.Logs/MetricFilter@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Logs/MetricFilterProperties](#awslogsmetricfilterproperties) (Required): properties of the resource +* **properties**: [AWS.Logs/MetricFilterProperties](#awslogsmetricfilterproperties) (Required, Identifier): properties of the resource ## Resource AWS.Logs/QueryDefinition@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Logs/QueryDefinitionProperties](#awslogsquerydefinitionproperties) (Required): properties of the resource +* **properties**: [AWS.Logs/QueryDefinitionProperties](#awslogsquerydefinitionproperties) (Required, Identifier): properties of the resource ## Resource AWS.Logs/ResourcePolicy@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Logs/ResourcePolicyProperties](#awslogsresourcepolicyproperties) (Required): properties of the resource +* **properties**: [AWS.Logs/ResourcePolicyProperties](#awslogsresourcepolicyproperties) (Required, Identifier): properties of the resource ## Resource AWS.Logs/SubscriptionFilter@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Logs/SubscriptionFilterProperties](#awslogssubscriptionfilterproperties) (Required): properties of the resource +* **properties**: [AWS.Logs/SubscriptionFilterProperties](#awslogssubscriptionfilterproperties) (Required, Identifier): properties of the resource ## AWS.Logs/AccountPolicyProperties ### Properties @@ -90,20 +90,7 @@ Length Constraints: Maximum length of 30720 * **PolicyName**: string (Required, Identifier): The name of the account policy * **PolicyType**: string (Required, Identifier): Type of the policy. * **Scope**: string: Scope for policy application - -## AWS.Logs/DeliveryProperties -### Properties -* **Arn**: string (ReadOnly): The Amazon Resource Name (ARN) that uniquely identifies this delivery. -* **DeliveryDestinationArn**: string (Required): The ARN of the delivery destination that is associated with this delivery. -* **DeliveryDestinationType**: string (ReadOnly): Displays whether the delivery destination associated with this delivery is CloudWatch Logs, Amazon S3, or Kinesis Data Firehose. -* **DeliveryId**: string (ReadOnly, Identifier): The unique ID that identifies this delivery in your account. -* **DeliverySourceName**: string (Required): The name of the delivery source that is associated with this delivery. -* **Tags**: [Tag](#tag)[]: The tags that have been assigned to this delivery. - -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode +* **SelectionCriteria**: string: Log group selection criteria to apply policy only to a subset of log groups. SelectionCriteria string can be up to 25KB and cloudwatchlogs determines the length of selectionCriteria by using its UTF-8 bytes ## AWS.Logs/DeliveryDestinationProperties ### Properties @@ -118,13 +105,14 @@ Length Constraints: Maximum length of 51200 * **Name**: string (Required, Identifier): The name of this delivery destination. * **Tags**: [Tag](#tag)[]: The tags that have been assigned to this delivery destination. -## DeliveryDestination_DeliveryDestinationPolicy -### Properties - -## Tag +## AWS.Logs/DeliveryProperties ### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Arn**: string (ReadOnly): The Amazon Resource Name (ARN) that uniquely identifies this delivery. +* **DeliveryDestinationArn**: string (Required): The ARN of the delivery destination that is associated with this delivery. +* **DeliveryDestinationType**: string (ReadOnly): Displays whether the delivery destination associated with this delivery is CloudWatch Logs, Amazon S3, or Kinesis Data Firehose. +* **DeliveryId**: string (ReadOnly, Identifier): The unique ID that identifies this delivery in your account. +* **DeliverySourceName**: string (Required): The name of the delivery source that is associated with this delivery. +* **Tags**: [Tag](#tag)[]: The tags that have been assigned to this delivery. ## AWS.Logs/DeliverySourceProperties ### Properties @@ -136,11 +124,6 @@ Length Constraints: Maximum length of 51200 * **Service**: string (ReadOnly): The AWS service that is sending logs. * **Tags**: [Tag](#tag)[]: The tags that have been assigned to this delivery source. -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode - ## AWS.Logs/DestinationProperties ### Properties * **Arn**: string (ReadOnly) @@ -165,67 +148,93 @@ Length Constraints: Maximum length of 51200 ## AWS.Logs/LogGroupProperties ### Properties -* **Arn**: string (ReadOnly): The CloudWatch log group ARN. -* **DataProtectionPolicy**: [LogGroup_DataProtectionPolicy](#loggroupdataprotectionpolicy): The body of the policy document you want to use for this topic. +* **Arn**: string (ReadOnly) +* **DataProtectionPolicy**: [LogGroup_DataProtectionPolicy](#loggroupdataprotectionpolicy): Creates a data protection policy and assigns it to the log group. A data protection policy can help safeguard sensitive data that's ingested by the log group by auditing and masking the sensitive log data. When a user who does not have permission to view masked data views a log event that includes masked data, the sensitive data is replaced by asterisks. + For more information, including a list of types of data that can be audited and masked, see [Protect sensitive log data with masking](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data.html). +* **KmsKeyId**: string: The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data. + To associate an KMS key with the log group, specify the ARN of that KMS key here. If you do so, ingested data is encrypted using this key. This association is stored as long as the data encrypted with the KMS key is still within CWL. This enables CWL to decrypt this data whenever it is requested. + If you attempt to associate a KMS key with the log group but the KMS key doesn't exist or is deactivated, you will receive an ``InvalidParameterException`` error. + Log group data is always encrypted in CWL. If you omit this key, the encryption does not use KMS. For more information, see [Encrypt log data in using](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/encrypt-log-data-kms.html) +* **LogGroupClass**: string: Specifies the log group class for this log group. There are two classes: + + The ``Standard`` log class supports all CWL features. + + The ``Infrequent Access`` log class supports a subset of CWL features and incurs lower costs. + + For details about the features supported by each class, see [Log classes](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch_Logs_Log_Classes.html) +* **LogGroupName**: string (Identifier): The name of the log group. If you don't specify a name, CFNlong generates a unique ID for the log group. +* **RetentionInDays**: int: The number of days to retain the log events in the specified log group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1096, 1827, 2192, 2557, 2922, 3288, and 3653. + To set a log group so that its log events do not expire, use [DeleteRetentionPolicy](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DeleteRetentionPolicy.html). +* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to the log group. + For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html). -You can only add one policy per topic. +## AWS.Logs/MetricFilterProperties +### Properties +* **FilterName**: string (Identifier): The name of the metric filter. +* **FilterPattern**: string (Required): A filter pattern for extracting metric data out of ingested log events. For more information, see [Filter and Pattern Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html). +* **LogGroupName**: string (Required, Identifier): The name of an existing log group that you want to associate with this metric filter. +* **MetricTransformations**: [MetricTransformation](#metrictransformation)[] (Required): The metric transformations. -The policy must be in JSON string format. +## AWS.Logs/QueryDefinitionProperties +### Properties +* **LogGroupNames**: string[]: Optionally define specific log groups as part of your query definition +* **Name**: string (Required): A name for the saved query definition +* **QueryDefinitionId**: string (ReadOnly, Identifier): Unique identifier of a query definition +* **QueryString**: string (Required): The query string to use for this definition -Length Constraints: Maximum length of 30720 -* **KmsKeyId**: string: The Amazon Resource Name (ARN) of the CMK to use when encrypting log data. -* **LogGroupClass**: string: The class of the log group. Possible values are: STANDARD and INFREQUENT_ACCESS, with STANDARD being the default class -* **LogGroupName**: string (Identifier): The name of the log group. If you don't specify a name, AWS CloudFormation generates a unique ID for the log group. -* **RetentionInDays**: int: The number of days to retain the log events in the specified log group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1096, 1827, and 3653. -* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. +## AWS.Logs/ResourcePolicyProperties +### Properties +* **PolicyDocument**: string (Required): The policy document +* **PolicyName**: string (Required, Identifier): A name for resource policy -## LogGroup_DataProtectionPolicy +## AWS.Logs/SubscriptionFilterProperties ### Properties +* **DestinationArn**: string (Required): The Amazon Resource Name (ARN) of the destination. +* **Distribution**: string: The method used to distribute log data to the destination, which can be either random or grouped by log stream. +* **FilterName**: string (Identifier): The name of the subscription filter. +* **FilterPattern**: string (Required): The filtering expressions that restrict what gets delivered to the destination AWS resource. For more information about the filter pattern syntax, see [Filter and Pattern Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html). +* **LogGroupName**: string (Required, Identifier): The log group to associate with the subscription filter. All log events that are uploaded to this log group are filtered and delivered to the specified AWS resource if the filter pattern matches the log events. +* **RoleArn**: string: The ARN of an IAM role that grants CWL permissions to deliver ingested log events to the destination stream. You don't need to provide the ARN when you are working with a logical destination for cross-account delivery. -## Tag +## DeliveryDestination_DeliveryDestinationPolicy ### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., :, /, =, +, - and @. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., :, /, =, +, - and @. -## AWS.Logs/MetricFilterProperties +## Dimension +### Properties +* **Key**: string (Required): The name for the CW metric dimension that the metric filter creates. + Dimension names must contain only ASCII characters, must include at least one non-whitespace character, and cannot start with a colon (:). +* **Value**: string (Required): The log event field that will contain the value for this dimension. This dimension will only be published for a metric if the value is found in the log event. For example, ``$.eventType`` for JSON log events, or ``$server`` for space-delimited log events. + +## LogGroup_DataProtectionPolicy ### Properties -* **FilterName**: string (Identifier): A name for the metric filter. -* **FilterPattern**: string (Required): Pattern that Logs follows to interpret each entry in a log. -* **LogGroupName**: string (Required, Identifier): Existing log group that you want to associate with this filter. -* **MetricTransformations**: [MetricTransformation](#metrictransformation)[] (Required): A collection of information that defines how metric data gets emitted. ## MetricTransformation ### Properties -* **DefaultValue**: int: The value to emit when a filter pattern does not match a log event. This value can be null. -* **Dimensions**: [Dimension](#dimension)[]: Dimensions are the key-value pairs that further define a metric -* **MetricName**: string (Required): The name of the CloudWatch metric. Metric name must be in ASCII format. -* **MetricNamespace**: string (Required): The namespace of the CloudWatch metric. -* **MetricValue**: string (Required): The value to publish to the CloudWatch metric when a filter pattern matches a log event. -* **Unit**: string: The unit to assign to the metric. If you omit this, the unit is set as None. +* **DefaultValue**: int: (Optional) The value to emit when a filter pattern does not match a log event. This value can be null. +* **Dimensions**: [Dimension](#dimension)[]: The fields to use as dimensions for the metric. One metric filter can include as many as three dimensions. + Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as ``IPAddress`` or ``requestID`` as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric. + CloudWatch Logs disables a metric filter if it generates 1000 different name/value pairs for your specified dimensions within a certain amount of time. This helps to prevent accidental high charges. + You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see [Creating a Billing Alarm to Monitor Your Estimated Charges](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/monitor_estimated_charges_with_cloudwatch.html). +* **MetricName**: string (Required): The name of the CloudWatch metric. +* **MetricNamespace**: string (Required): A custom namespace to contain your metric in CloudWatch. Use namespaces to group together metrics that are similar. For more information, see [Namespaces](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Namespace). +* **MetricValue**: string (Required): The value that is published to the CloudWatch metric. For example, if you're counting the occurrences of a particular term like ``Error``, specify 1 for the metric value. If you're counting the number of bytes transferred, reference the value that is in the log event by using $. followed by the name of the field that you specified in the filter pattern, such as ``$.size``. +* **Unit**: string: The unit to assign to the metric. If you omit this, the unit is set as ``None``. -## Dimension +## Tag ### Properties -* **Key**: string (Required): The key of the dimension. Maximum length of 255. -* **Value**: string (Required): The value of the dimension. Maximum length of 255. +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode -## AWS.Logs/QueryDefinitionProperties +## Tag ### Properties -* **LogGroupNames**: string[]: Optionally define specific log groups as part of your query definition -* **Name**: string (Required): A name for the saved query definition -* **QueryDefinitionId**: string (ReadOnly, Identifier): Unique identifier of a query definition -* **QueryString**: string (Required): The query string to use for this definition +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -## AWS.Logs/ResourcePolicyProperties +## Tag ### Properties -* **PolicyDocument**: string (Required): The policy document -* **PolicyName**: string (Required, Identifier): A name for resource policy +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode -## AWS.Logs/SubscriptionFilterProperties +## Tag ### Properties -* **DestinationArn**: string (Required): The Amazon Resource Name (ARN) of the destination. -* **Distribution**: string: The method used to distribute log data to the destination. By default, log data is grouped by log stream, but the grouping can be set to random for a more even distribution. This property is only applicable when the destination is an Amazon Kinesis stream. -* **FilterName**: string (Identifier): The name of the filter generated by resource. -* **FilterPattern**: string (Required): The filtering expressions that restrict what gets delivered to the destination AWS resource. -* **LogGroupName**: string (Required, Identifier): Existing log group that you want to associate with this filter. -* **RoleArn**: string: The ARN of an IAM role that grants CloudWatch Logs permissions to deliver ingested log events to the destination stream. You don't need to provide the ARN when you are working with a logical destination for cross-account delivery. +* **Key**: string (Required) +* **Value**: string (Required) diff --git a/artifacts/bicep/aws/aws.lookoutmetrics/default/types.json b/artifacts/bicep/aws/aws.lookoutmetrics/default/types.json index 73cc7610..322d43b1 100644 --- a/artifacts/bicep/aws/aws.lookoutmetrics/default/types.json +++ b/artifacts/bicep/aws/aws.lookoutmetrics/default/types.json @@ -1 +1,631 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"AnomalyDetectorConfig","Properties":{"AnomalyDetectorFrequency":{"Type":4,"Flags":1,"Description":"Frequency of anomaly detection"}}}},{"2":{"Name":"AnomalyDetectorFrequency"}},{"2":{"Name":"AppFlowConfig","Properties":{"FlowName":{"Type":4,"Flags":1},"RoleArn":{"Type":4,"Flags":1}}}},{"2":{"Name":"Arn"}},{"2":{"Name":"Charset"}},{"2":{"Name":"CloudwatchConfig","Properties":{"RoleArn":{"Type":4,"Flags":1}}}},{"2":{"Name":"ColumnName"}},{"2":{"Name":"CsvFormatDescriptor","Properties":{"Charset":{"Type":4,"Flags":0},"ContainsHeader":{"Type":2,"Flags":0},"Delimiter":{"Type":4,"Flags":0},"FileCompression":{"Type":4,"Flags":0},"HeaderList":{"Type":32,"Flags":0},"QuoteSymbol":{"Type":4,"Flags":0}}}},{"2":{"Name":"DatabaseHost"}},{"2":{"Name":"DatabasePort"}},{"2":{"Name":"FileFormatDescriptor","Properties":{"CsvFormatDescriptor":{"Type":15,"Flags":0},"JsonFormatDescriptor":{"Type":19,"Flags":0}}}},{"2":{"Name":"JsonFormatDescriptor","Properties":{"Charset":{"Type":4,"Flags":0},"FileCompression":{"Type":4,"Flags":0}}}},{"2":{"Name":"Metric","Properties":{"AggregationFunction":{"Type":4,"Flags":1,"Description":"Operator used to aggregate metric values"},"MetricName":{"Type":4,"Flags":1},"Namespace":{"Type":4,"Flags":0}}}},{"2":{"Name":"MetricSet","Properties":{"DimensionList":{"Type":33,"Flags":0,"Description":"Dimensions for this MetricSet."},"MetricList":{"Type":34,"Flags":1,"Description":"Metrics captured by this MetricSet."},"MetricSetDescription":{"Type":4,"Flags":0,"Description":"A description for the MetricSet."},"MetricSetFrequency":{"Type":4,"Flags":0,"Description":"A frequency period to aggregate the data"},"MetricSetName":{"Type":4,"Flags":1,"Description":"The name of the MetricSet."},"MetricSource":{"Type":22,"Flags":1},"Offset":{"Type":3,"Flags":0,"Description":"Offset, in seconds, between the frequency interval and the time at which the metrics are available."},"TimestampColumn":{"Type":30,"Flags":0},"Timezone":{"Type":4,"Flags":0}}}},{"2":{"Name":"MetricSource","Properties":{"AppFlowConfig":{"Type":10,"Flags":0},"CloudwatchConfig":{"Type":13,"Flags":0},"RDSSourceConfig":{"Type":23,"Flags":0},"RedshiftSourceConfig":{"Type":24,"Flags":0},"S3SourceConfig":{"Type":25,"Flags":0}}}},{"2":{"Name":"RDSSourceConfig","Properties":{"DBInstanceIdentifier":{"Type":4,"Flags":1},"DatabaseHost":{"Type":4,"Flags":1},"DatabaseName":{"Type":4,"Flags":1},"DatabasePort":{"Type":3,"Flags":1},"RoleArn":{"Type":4,"Flags":1},"SecretManagerArn":{"Type":4,"Flags":1},"TableName":{"Type":4,"Flags":1},"VpcConfiguration":{"Type":31,"Flags":1}}}},{"2":{"Name":"RedshiftSourceConfig","Properties":{"ClusterIdentifier":{"Type":4,"Flags":1},"DatabaseHost":{"Type":4,"Flags":1},"DatabaseName":{"Type":4,"Flags":1},"DatabasePort":{"Type":3,"Flags":1},"RoleArn":{"Type":4,"Flags":1},"SecretManagerArn":{"Type":4,"Flags":1},"TableName":{"Type":4,"Flags":1},"VpcConfiguration":{"Type":31,"Flags":1}}}},{"2":{"Name":"S3SourceConfig","Properties":{"FileFormatDescriptor":{"Type":18,"Flags":1},"HistoricalDataPathList":{"Type":35,"Flags":0},"RoleArn":{"Type":4,"Flags":1},"TemplatedPathList":{"Type":36,"Flags":0}}}},{"2":{"Name":"SecretManagerArn"}},{"2":{"Name":"SecurityGroupIdList"}},{"2":{"Name":"SubnetIdList"}},{"2":{"Name":"TableName"}},{"2":{"Name":"TimestampColumn","Properties":{"ColumnFormat":{"Type":4,"Flags":0,"Description":"A timestamp format for the timestamps in the dataset"},"ColumnName":{"Type":4,"Flags":0}}}},{"2":{"Name":"VpcConfiguration","Properties":{"SecurityGroupIdList":{"Type":39,"Flags":1},"SubnetIdList":{"Type":40,"Flags":1}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":20}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.LookoutMetrics/AnomalyDetectorProperties","Properties":{"AnomalyDetectorConfig":{"Type":8,"Flags":1,"Description":"Configuration options for the AnomalyDetector"},"AnomalyDetectorDescription":{"Type":4,"Flags":0,"Description":"A description for the AnomalyDetector."},"AnomalyDetectorName":{"Type":4,"Flags":0,"Description":"Name for the Amazon Lookout for Metrics Anomaly Detector"},"Arn":{"Type":4,"Flags":18},"KmsKeyArn":{"Type":4,"Flags":0,"Description":"KMS key used to encrypt the AnomalyDetector data"},"MetricSetList":{"Type":42,"Flags":1,"Description":"List of metric sets for anomaly detection"}}}},{"3":{"ItemType":21}},{"2":{"Name":"AWS.LookoutMetrics/AnomalyDetector","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":41,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.LookoutMetrics/AnomalyDetector@default","ScopeType":0,"Body":43}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "AnomalyDetectorConfig", + "properties": { + "AnomalyDetectorFrequency": { + "type": { + "$ref": "#/24" + }, + "flags": 1, + "description": "Frequency of anomaly detection" + } + } + }, + { + "$type": "ObjectType", + "name": "AnomalyDetectorFrequency", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AppFlowConfig", + "properties": { + "FlowName": { + "type": { + "$ref": "#/24" + }, + "flags": 1 + }, + "RoleArn": { + "type": { + "$ref": "#/24" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Arn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Charset", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CloudwatchConfig", + "properties": { + "RoleArn": { + "type": { + "$ref": "#/24" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ColumnName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CsvFormatDescriptor", + "properties": { + "Charset": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "ContainsHeader": { + "type": { + "$ref": "#/25" + }, + "flags": 0 + }, + "Delimiter": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "FileCompression": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "HeaderList": { + "type": { + "$ref": "#/26" + }, + "flags": 0 + }, + "QuoteSymbol": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DatabaseHost", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DatabasePort", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "FileFormatDescriptor", + "properties": { + "CsvFormatDescriptor": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "JsonFormatDescriptor": { + "type": { + "$ref": "#/11" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "JsonFormatDescriptor", + "properties": { + "Charset": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "FileCompression": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Metric", + "properties": { + "AggregationFunction": { + "type": { + "$ref": "#/24" + }, + "flags": 1, + "description": "Operator used to aggregate metric values" + }, + "MetricName": { + "type": { + "$ref": "#/24" + }, + "flags": 1 + }, + "Namespace": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "MetricSet", + "properties": { + "DimensionList": { + "type": { + "$ref": "#/28" + }, + "flags": 0, + "description": "Dimensions for this MetricSet." + }, + "MetricList": { + "type": { + "$ref": "#/29" + }, + "flags": 1, + "description": "Metrics captured by this MetricSet." + }, + "MetricSetDescription": { + "type": { + "$ref": "#/24" + }, + "flags": 0, + "description": "A description for the MetricSet." + }, + "MetricSetFrequency": { + "type": { + "$ref": "#/24" + }, + "flags": 0, + "description": "A frequency period to aggregate the data" + }, + "MetricSetName": { + "type": { + "$ref": "#/24" + }, + "flags": 1, + "description": "The name of the MetricSet." + }, + "MetricSource": { + "type": { + "$ref": "#/14" + }, + "flags": 1 + }, + "Offset": { + "type": { + "$ref": "#/27" + }, + "flags": 0, + "description": "Offset, in seconds, between the frequency interval and the time at which the metrics are available." + }, + "TimestampColumn": { + "type": { + "$ref": "#/22" + }, + "flags": 0 + }, + "Timezone": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "MetricSource", + "properties": { + "AppFlowConfig": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "CloudwatchConfig": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "RDSSourceConfig": { + "type": { + "$ref": "#/15" + }, + "flags": 0 + }, + "RedshiftSourceConfig": { + "type": { + "$ref": "#/16" + }, + "flags": 0 + }, + "S3SourceConfig": { + "type": { + "$ref": "#/17" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "RDSSourceConfig", + "properties": { + "DBInstanceIdentifier": { + "type": { + "$ref": "#/24" + }, + "flags": 1 + }, + "DatabaseHost": { + "type": { + "$ref": "#/24" + }, + "flags": 1 + }, + "DatabaseName": { + "type": { + "$ref": "#/24" + }, + "flags": 1 + }, + "DatabasePort": { + "type": { + "$ref": "#/27" + }, + "flags": 1 + }, + "RoleArn": { + "type": { + "$ref": "#/24" + }, + "flags": 1 + }, + "SecretManagerArn": { + "type": { + "$ref": "#/24" + }, + "flags": 1 + }, + "TableName": { + "type": { + "$ref": "#/24" + }, + "flags": 1 + }, + "VpcConfiguration": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "RedshiftSourceConfig", + "properties": { + "ClusterIdentifier": { + "type": { + "$ref": "#/24" + }, + "flags": 1 + }, + "DatabaseHost": { + "type": { + "$ref": "#/24" + }, + "flags": 1 + }, + "DatabaseName": { + "type": { + "$ref": "#/24" + }, + "flags": 1 + }, + "DatabasePort": { + "type": { + "$ref": "#/27" + }, + "flags": 1 + }, + "RoleArn": { + "type": { + "$ref": "#/24" + }, + "flags": 1 + }, + "SecretManagerArn": { + "type": { + "$ref": "#/24" + }, + "flags": 1 + }, + "TableName": { + "type": { + "$ref": "#/24" + }, + "flags": 1 + }, + "VpcConfiguration": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "S3SourceConfig", + "properties": { + "FileFormatDescriptor": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + }, + "HistoricalDataPathList": { + "type": { + "$ref": "#/30" + }, + "flags": 0 + }, + "RoleArn": { + "type": { + "$ref": "#/24" + }, + "flags": 1 + }, + "TemplatedPathList": { + "type": { + "$ref": "#/31" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SecretManagerArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SecurityGroupIdList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SubnetIdList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TableName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TimestampColumn", + "properties": { + "ColumnFormat": { + "type": { + "$ref": "#/24" + }, + "flags": 0, + "description": "A timestamp format for the timestamps in the dataset" + }, + "ColumnName": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "VpcConfiguration", + "properties": { + "SecurityGroupIdList": { + "type": { + "$ref": "#/34" + }, + "flags": 1 + }, + "SubnetIdList": { + "type": { + "$ref": "#/35" + }, + "flags": 1 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/24" + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/24" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/12" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/24" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/24" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/24" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/24" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/24" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/24" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.LookoutMetrics/AnomalyDetectorProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "ObjectType", + "name": "AWS.LookoutMetrics/AnomalyDetectorProperties", + "properties": { + "AnomalyDetectorConfig": { + "type": { + "$ref": "#/0" + }, + "flags": 1, + "description": "Configuration options for the AnomalyDetector" + }, + "AnomalyDetectorDescription": { + "type": { + "$ref": "#/24" + }, + "flags": 0, + "description": "A description for the AnomalyDetector." + }, + "AnomalyDetectorName": { + "type": { + "$ref": "#/24" + }, + "flags": 0, + "description": "Name for the Amazon Lookout for Metrics Anomaly Detector" + }, + "Arn": { + "type": { + "$ref": "#/24" + }, + "flags": 18 + }, + "KmsKeyArn": { + "type": { + "$ref": "#/24" + }, + "flags": 0, + "description": "KMS key used to encrypt the AnomalyDetector data" + }, + "MetricSetList": { + "type": { + "$ref": "#/37" + }, + "flags": 1, + "description": "List of metric sets for anomaly detection" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.LookoutMetrics/AnomalyDetector", + "properties": { + "name": { + "type": { + "$ref": "#/24" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/24" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/38" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.LookoutMetrics/AnomalyDetector@default", + "scopeType": 0, + "body": { + "$ref": "#/39" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.lookoutmetrics/default/types.md b/artifacts/bicep/aws/aws.lookoutmetrics/default/types.md index 527713f0..54f18147 100644 --- a/artifacts/bicep/aws/aws.lookoutmetrics/default/types.md +++ b/artifacts/bicep/aws/aws.lookoutmetrics/default/types.md @@ -3,9 +3,18 @@ ## Resource AWS.LookoutMetrics/AnomalyDetector@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.LookoutMetrics/AnomalyDetectorProperties](#awslookoutmetricsanomalydetectorproperties) (Required): properties of the resource +* **properties**: [AWS.LookoutMetrics/AnomalyDetectorProperties](#awslookoutmetricsanomalydetectorproperties) (Required, Identifier): properties of the resource + +## AnomalyDetectorConfig +### Properties +* **AnomalyDetectorFrequency**: string (Required): Frequency of anomaly detection + +## AppFlowConfig +### Properties +* **FlowName**: string (Required) +* **RoleArn**: string (Required) ## AWS.LookoutMetrics/AnomalyDetectorProperties ### Properties @@ -16,9 +25,34 @@ * **KmsKeyArn**: string: KMS key used to encrypt the AnomalyDetector data * **MetricSetList**: [MetricSet](#metricset)[] (Required): List of metric sets for anomaly detection -## AnomalyDetectorConfig +## CloudwatchConfig ### Properties -* **AnomalyDetectorFrequency**: string (Required): Frequency of anomaly detection +* **RoleArn**: string (Required) + +## CsvFormatDescriptor +### Properties +* **Charset**: string +* **ContainsHeader**: bool +* **Delimiter**: string +* **FileCompression**: string +* **HeaderList**: string[] +* **QuoteSymbol**: string + +## FileFormatDescriptor +### Properties +* **CsvFormatDescriptor**: [CsvFormatDescriptor](#csvformatdescriptor) +* **JsonFormatDescriptor**: [JsonFormatDescriptor](#jsonformatdescriptor) + +## JsonFormatDescriptor +### Properties +* **Charset**: string +* **FileCompression**: string + +## Metric +### Properties +* **AggregationFunction**: string (Required): Operator used to aggregate metric values +* **MetricName**: string (Required) +* **Namespace**: string ## MetricSet ### Properties @@ -32,12 +66,6 @@ * **TimestampColumn**: [TimestampColumn](#timestampcolumn) * **Timezone**: string -## Metric -### Properties -* **AggregationFunction**: string (Required): Operator used to aggregate metric values -* **MetricName**: string (Required) -* **Namespace**: string - ## MetricSource ### Properties * **AppFlowConfig**: [AppFlowConfig](#appflowconfig) @@ -46,15 +74,6 @@ * **RedshiftSourceConfig**: [RedshiftSourceConfig](#redshiftsourceconfig) * **S3SourceConfig**: [S3SourceConfig](#s3sourceconfig) -## AppFlowConfig -### Properties -* **FlowName**: string (Required) -* **RoleArn**: string (Required) - -## CloudwatchConfig -### Properties -* **RoleArn**: string (Required) - ## RDSSourceConfig ### Properties * **DatabaseHost**: string (Required) @@ -66,11 +85,6 @@ * **TableName**: string (Required) * **VpcConfiguration**: [VpcConfiguration](#vpcconfiguration) (Required) -## VpcConfiguration -### Properties -* **SecurityGroupIdList**: string[] (Required) -* **SubnetIdList**: string[] (Required) - ## RedshiftSourceConfig ### Properties * **ClusterIdentifier**: string (Required) @@ -89,27 +103,13 @@ * **RoleArn**: string (Required) * **TemplatedPathList**: string[] -## FileFormatDescriptor -### Properties -* **CsvFormatDescriptor**: [CsvFormatDescriptor](#csvformatdescriptor) -* **JsonFormatDescriptor**: [JsonFormatDescriptor](#jsonformatdescriptor) - -## CsvFormatDescriptor -### Properties -* **Charset**: string -* **ContainsHeader**: bool -* **Delimiter**: string -* **FileCompression**: string -* **HeaderList**: string[] -* **QuoteSymbol**: string - -## JsonFormatDescriptor -### Properties -* **Charset**: string -* **FileCompression**: string - ## TimestampColumn ### Properties * **ColumnFormat**: string: A timestamp format for the timestamps in the dataset * **ColumnName**: string +## VpcConfiguration +### Properties +* **SecurityGroupIdList**: string[] (Required) +* **SubnetIdList**: string[] (Required) + diff --git a/artifacts/bicep/aws/aws.lookoutvision/default/types.json b/artifacts/bicep/aws/aws.lookoutvision/default/types.json index 5a4ee5ee..48a027c7 100644 --- a/artifacts/bicep/aws/aws.lookoutvision/default/types.json +++ b/artifacts/bicep/aws/aws.lookoutvision/default/types.json @@ -1 +1,73 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"Arn"}},{"2":{"Name":"ProjectName"}},{"2":{"Name":"AWS.LookoutVision/ProjectProperties","Properties":{"Arn":{"Type":4,"Flags":2},"ProjectName":{"Type":4,"Flags":17}}}},{"2":{"Name":"AWS.LookoutVision/Project","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":10,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.LookoutVision/Project@default","ScopeType":0,"Body":11}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Arn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ProjectName", + "properties": {} + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.LookoutVision/ProjectProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.LookoutVision/ProjectProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/2" + }, + "flags": 2 + }, + "ProjectName": { + "type": { + "$ref": "#/2" + }, + "flags": 17 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.LookoutVision/Project", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.LookoutVision/Project@default", + "scopeType": 0, + "body": { + "$ref": "#/5" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.lookoutvision/default/types.md b/artifacts/bicep/aws/aws.lookoutvision/default/types.md index e09cc73f..406d278e 100644 --- a/artifacts/bicep/aws/aws.lookoutvision/default/types.md +++ b/artifacts/bicep/aws/aws.lookoutvision/default/types.md @@ -3,9 +3,9 @@ ## Resource AWS.LookoutVision/Project@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.LookoutVision/ProjectProperties](#awslookoutvisionprojectproperties) (Required): properties of the resource +* **properties**: [AWS.LookoutVision/ProjectProperties](#awslookoutvisionprojectproperties) (Required, Identifier): properties of the resource ## AWS.LookoutVision/ProjectProperties ### Properties diff --git a/artifacts/bicep/aws/aws.m2/default/types.json b/artifacts/bicep/aws/aws.m2/default/types.json index bfc377f6..8f311650 100644 --- a/artifacts/bicep/aws/aws.m2/default/types.json +++ b/artifacts/bicep/aws/aws.m2/default/types.json @@ -1 +1,361 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"Definition","Properties":{}}},{"2":{"Name":"EngineType"}},{"2":{"Name":"TagMap","Properties":{}}},{"2":{"Name":"AWS.M2/ApplicationProperties","Properties":{"ApplicationArn":{"Type":4,"Flags":18},"ApplicationId":{"Type":4,"Flags":2},"Definition":{"Type":8,"Flags":5},"Description":{"Type":4,"Flags":0},"EngineType":{"Type":4,"Flags":1},"KmsKeyId":{"Type":4,"Flags":0,"Description":"The ID or the Amazon Resource Name (ARN) of the customer managed KMS Key used for encrypting application-related resources."},"Name":{"Type":4,"Flags":1},"RoleArn":{"Type":4,"Flags":0},"Tags":{"Type":10,"Flags":0}}}},{"2":{"Name":"AWS.M2/Application","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":11,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.M2/Application@default","ScopeType":0,"Body":12}},{"2":{"Name":"EfsStorageConfiguration","Properties":{"FileSystemId":{"Type":4,"Flags":1,"Description":"The file system identifier."},"MountPoint":{"Type":4,"Flags":1,"Description":"The mount point for the file system."}}}},{"2":{"Name":"EngineType"}},{"2":{"Name":"FsxStorageConfiguration","Properties":{"FileSystemId":{"Type":4,"Flags":1,"Description":"The file system identifier."},"MountPoint":{"Type":4,"Flags":1,"Description":"The mount point for the file system."}}}},{"2":{"Name":"HighAvailabilityConfig","Properties":{"DesiredCapacity":{"Type":3,"Flags":1}}}},{"2":{"Name":"StorageConfiguration","Properties":{}}},{"2":{"Name":"TagMap","Properties":{}}},{"2":{"Name":"AWS.M2/EnvironmentProperties","Properties":{"Description":{"Type":4,"Flags":0,"Description":"The description of the environment."},"EngineType":{"Type":4,"Flags":1},"EngineVersion":{"Type":4,"Flags":0,"Description":"The version of the runtime engine for the environment."},"EnvironmentArn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN) of the runtime environment."},"EnvironmentId":{"Type":4,"Flags":2,"Description":"The unique identifier of the environment."},"HighAvailabilityConfig":{"Type":17,"Flags":0},"InstanceType":{"Type":4,"Flags":1,"Description":"The type of instance underlying the environment."},"KmsKeyId":{"Type":4,"Flags":0,"Description":"The ID or the Amazon Resource Name (ARN) of the customer managed KMS Key used for encrypting environment-related resources."},"Name":{"Type":4,"Flags":1,"Description":"The name of the environment."},"PreferredMaintenanceWindow":{"Type":4,"Flags":0,"Description":"Configures a desired maintenance window for the environment. If you do not provide a value, a random system-generated value will be assigned."},"PubliclyAccessible":{"Type":2,"Flags":0,"Description":"Specifies whether the environment is publicly accessible."},"SecurityGroupIds":{"Type":21,"Flags":0,"Description":"The list of security groups for the VPC associated with this environment."},"StorageConfigurations":{"Type":22,"Flags":0,"Description":"The storage configurations defined for the runtime environment."},"SubnetIds":{"Type":23,"Flags":0,"Description":"The unique identifiers of the subnets assigned to this runtime environment."},"Tags":{"Type":19,"Flags":0,"Description":"Tags associated to this environment."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":18}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.M2/Environment","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":20,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.M2/Environment@default","ScopeType":0,"Body":24}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Definition", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "EngineType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TagMap", + "properties": {} + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.M2/ApplicationProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.M2/ApplicationProperties", + "properties": { + "ApplicationArn": { + "type": { + "$ref": "#/3" + }, + "flags": 18 + }, + "ApplicationId": { + "type": { + "$ref": "#/3" + }, + "flags": 2 + }, + "Definition": { + "type": { + "$ref": "#/0" + }, + "flags": 5 + }, + "Description": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "EngineType": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + }, + "KmsKeyId": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The ID or the Amazon Resource Name (ARN) of the customer managed KMS Key used for encrypting application-related resources." + }, + "Name": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + }, + "RoleArn": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.M2/Application", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.M2/Application@default", + "scopeType": 0, + "body": { + "$ref": "#/6" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "EfsStorageConfiguration", + "properties": { + "FileSystemId": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The file system identifier." + }, + "MountPoint": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The mount point for the file system." + } + } + }, + { + "$type": "ObjectType", + "name": "EngineType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "FsxStorageConfiguration", + "properties": { + "FileSystemId": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The file system identifier." + }, + "MountPoint": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The mount point for the file system." + } + } + }, + { + "$type": "ObjectType", + "name": "HighAvailabilityConfig", + "properties": { + "DesiredCapacity": { + "type": { + "$ref": "#/14" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "StorageConfiguration", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TagMap", + "properties": {} + }, + { + "$type": "IntegerType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.M2/EnvironmentProperties" + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/12" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ObjectType", + "name": "AWS.M2/EnvironmentProperties", + "properties": { + "Description": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The description of the environment." + }, + "EngineType": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + }, + "EngineVersion": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The version of the runtime engine for the environment." + }, + "EnvironmentArn": { + "type": { + "$ref": "#/3" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) of the runtime environment." + }, + "EnvironmentId": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The unique identifier of the environment." + }, + "HighAvailabilityConfig": { + "type": { + "$ref": "#/11" + }, + "flags": 0 + }, + "InstanceType": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The type of instance underlying the environment." + }, + "KmsKeyId": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The ID or the Amazon Resource Name (ARN) of the customer managed KMS Key used for encrypting environment-related resources." + }, + "Name": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The name of the environment." + }, + "PreferredMaintenanceWindow": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "Configures a desired maintenance window for the environment. If you do not provide a value, a random system-generated value will be assigned." + }, + "PubliclyAccessible": { + "type": { + "$ref": "#/16" + }, + "flags": 0, + "description": "Specifies whether the environment is publicly accessible." + }, + "SecurityGroupIds": { + "type": { + "$ref": "#/17" + }, + "flags": 0, + "description": "The list of security groups for the VPC associated with this environment." + }, + "StorageConfigurations": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "The storage configurations defined for the runtime environment." + }, + "SubnetIds": { + "type": { + "$ref": "#/19" + }, + "flags": 0, + "description": "The unique identifiers of the subnets assigned to this runtime environment." + }, + "Tags": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "Tags associated to this environment." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.M2/Environment", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/20" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.M2/Environment@default", + "scopeType": 0, + "body": { + "$ref": "#/21" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.m2/default/types.md b/artifacts/bicep/aws/aws.m2/default/types.md index 15793ef0..0f7a2acf 100644 --- a/artifacts/bicep/aws/aws.m2/default/types.md +++ b/artifacts/bicep/aws/aws.m2/default/types.md @@ -3,16 +3,16 @@ ## Resource AWS.M2/Application@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.M2/ApplicationProperties](#awsm2applicationproperties) (Required): properties of the resource +* **properties**: [AWS.M2/ApplicationProperties](#awsm2applicationproperties) (Required, Identifier): properties of the resource ## Resource AWS.M2/Environment@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.M2/EnvironmentProperties](#awsm2environmentproperties) (Required): properties of the resource +* **properties**: [AWS.M2/EnvironmentProperties](#awsm2environmentproperties) (Required, Identifier): properties of the resource ## AWS.M2/ApplicationProperties ### Properties @@ -26,12 +26,6 @@ * **RoleArn**: string * **Tags**: [TagMap](#tagmap) -## Definition -### Properties - -## TagMap -### Properties - ## AWS.M2/EnvironmentProperties ### Properties * **Description**: string: The description of the environment. @@ -50,6 +44,9 @@ * **SubnetIds**: string[]: The unique identifiers of the subnets assigned to this runtime environment. * **Tags**: [TagMap](#tagmap): Tags associated to this environment. +## Definition +### Properties + ## HighAvailabilityConfig ### Properties * **DesiredCapacity**: int (Required) @@ -60,3 +57,6 @@ ## TagMap ### Properties +## TagMap +### Properties + diff --git a/artifacts/bicep/aws/aws.macie/default/types.json b/artifacts/bicep/aws/aws.macie/default/types.json index da303f46..6ee4ec85 100644 --- a/artifacts/bicep/aws/aws.macie/default/types.json +++ b/artifacts/bicep/aws/aws.macie/default/types.json @@ -1 +1,605 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"Criteria","Properties":{}}},{"2":{"Name":"Regex"}},{"2":{"Name":"S3WordsList","Properties":{"BucketName":{"Type":4,"Flags":1},"ObjectKey":{"Type":4,"Flags":1}}}},{"2":{"Name":"Status"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The tag's key."},"Value":{"Type":4,"Flags":1,"Description":"The tag's value."}}}},{"2":{"Name":"AWS.Macie/AllowListProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"AllowList ARN."},"Criteria":{"Type":8,"Flags":1,"Description":"AllowList criteria."},"Description":{"Type":4,"Flags":0,"Description":"Description of AllowList."},"Id":{"Type":4,"Flags":18,"Description":"AllowList ID."},"Name":{"Type":4,"Flags":1,"Description":"Name of AllowList."},"Status":{"Type":4,"Flags":2,"Description":"AllowList status."},"Tags":{"Type":14,"Flags":0,"Description":"A collection of tags associated with a resource"}}}},{"3":{"ItemType":12}},{"2":{"Name":"AWS.Macie/AllowList","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":13,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Macie/AllowList@default","ScopeType":0,"Body":15}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The tag's key."},"Value":{"Type":4,"Flags":1,"Description":"The tag's value."}}}},{"2":{"Name":"AWS.Macie/CustomDataIdentifierProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"Custom data identifier ARN."},"Description":{"Type":4,"Flags":0,"Description":"Description of custom data identifier."},"Id":{"Type":4,"Flags":18,"Description":"Custom data identifier ID."},"IgnoreWords":{"Type":19,"Flags":0,"Description":"Words to be ignored."},"Keywords":{"Type":20,"Flags":0,"Description":"Keywords to be matched against."},"MaximumMatchDistance":{"Type":3,"Flags":0,"Description":"Maximum match distance."},"Name":{"Type":4,"Flags":1,"Description":"Name of custom data identifier."},"Regex":{"Type":4,"Flags":1,"Description":"Regular expression for custom data identifier."},"Tags":{"Type":21,"Flags":0,"Description":"A collection of tags associated with a resource"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":17}},{"2":{"Name":"AWS.Macie/CustomDataIdentifier","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":18,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Macie/CustomDataIdentifier@default","ScopeType":0,"Body":22}},{"2":{"Name":"Criterion","Properties":{}}},{"2":{"Name":"CriterionAdditionalProperties","Properties":{"eq":{"Type":30,"Flags":0},"gt":{"Type":3,"Flags":0},"gte":{"Type":3,"Flags":0},"lt":{"Type":3,"Flags":0},"lte":{"Type":3,"Flags":0},"neq":{"Type":31,"Flags":0}}}},{"2":{"Name":"FindingCriteria","Properties":{"Criterion":{"Type":24,"Flags":0}}}},{"2":{"Name":"FindingFilterAction"}},{"2":{"Name":"FindingsFilterListItem","Properties":{"Id":{"Type":4,"Flags":16},"Name":{"Type":4,"Flags":0}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The tag's key."},"Value":{"Type":4,"Flags":1,"Description":"The tag's value."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.Macie/FindingsFilterProperties","Properties":{"Action":{"Type":4,"Flags":0,"Description":"Findings filter action."},"Arn":{"Type":4,"Flags":2,"Description":"Findings filter ARN."},"Description":{"Type":4,"Flags":0,"Description":"Findings filter description"},"FindingCriteria":{"Type":26,"Flags":1,"Description":"Findings filter criteria."},"Id":{"Type":4,"Flags":18,"Description":"Findings filter ID."},"Name":{"Type":4,"Flags":1,"Description":"Findings filter name"},"Position":{"Type":3,"Flags":0,"Description":"Findings filter position."},"Tags":{"Type":33,"Flags":0,"Description":"A collection of tags associated with a resource"}}}},{"3":{"ItemType":29}},{"2":{"Name":"AWS.Macie/FindingsFilter","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":32,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Macie/FindingsFilter@default","ScopeType":0,"Body":34}},{"2":{"Name":"AWS.Macie/SessionProperties","Properties":{"AwsAccountId":{"Type":4,"Flags":18,"Description":"AWS account ID of customer"},"FindingPublishingFrequency":{"Type":4,"Flags":0,"Description":"A enumeration value that specifies how frequently finding updates are published."},"ServiceRole":{"Type":4,"Flags":2,"Description":"Service role used by Macie"},"Status":{"Type":4,"Flags":0,"Description":"A enumeration value that specifies the status of the Macie Session."}}}},{"2":{"Name":"AWS.Macie/Session","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":36,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Macie/Session@default","ScopeType":0,"Body":37}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Criteria", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Regex", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "S3WordsList", + "properties": { + "BucketName": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "ObjectKey": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Status", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The tag's key." + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The tag's value." + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.Macie/AllowListProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Macie/AllowListProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/5" + }, + "flags": 2, + "description": "AllowList ARN." + }, + "Criteria": { + "type": { + "$ref": "#/0" + }, + "flags": 1, + "description": "AllowList criteria." + }, + "Description": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "Description of AllowList." + }, + "Id": { + "type": { + "$ref": "#/5" + }, + "flags": 18, + "description": "AllowList ID." + }, + "Name": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "Name of AllowList." + }, + "Status": { + "type": { + "$ref": "#/5" + }, + "flags": 2, + "description": "AllowList status." + }, + "Tags": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "A collection of tags associated with a resource" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Macie/AllowList", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/8" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Macie/AllowList@default", + "scopeType": 0, + "body": { + "$ref": "#/9" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The tag's key." + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The tag's value." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Macie/CustomDataIdentifierProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/11" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Macie/CustomDataIdentifierProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/5" + }, + "flags": 2, + "description": "Custom data identifier ARN." + }, + "Description": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "Description of custom data identifier." + }, + "Id": { + "type": { + "$ref": "#/5" + }, + "flags": 18, + "description": "Custom data identifier ID." + }, + "IgnoreWords": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "Words to be ignored." + }, + "Keywords": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "Keywords to be matched against." + }, + "MaximumMatchDistance": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "Maximum match distance." + }, + "Name": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "Name of custom data identifier." + }, + "Regex": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "Regular expression for custom data identifier." + }, + "Tags": { + "type": { + "$ref": "#/16" + }, + "flags": 0, + "description": "A collection of tags associated with a resource" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Macie/CustomDataIdentifier", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/17" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Macie/CustomDataIdentifier@default", + "scopeType": 0, + "body": { + "$ref": "#/18" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Criterion", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CriterionAdditionalProperties", + "properties": { + "eq": { + "type": { + "$ref": "#/26" + }, + "flags": 0 + }, + "gt": { + "type": { + "$ref": "#/15" + }, + "flags": 0 + }, + "gte": { + "type": { + "$ref": "#/15" + }, + "flags": 0 + }, + "lt": { + "type": { + "$ref": "#/15" + }, + "flags": 0 + }, + "lte": { + "type": { + "$ref": "#/15" + }, + "flags": 0 + }, + "neq": { + "type": { + "$ref": "#/27" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FindingCriteria", + "properties": { + "Criterion": { + "type": { + "$ref": "#/20" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FindingFilterAction", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "FindingsFilterListItem", + "properties": { + "Id": { + "type": { + "$ref": "#/5" + }, + "flags": 16 + }, + "Name": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The tag's key." + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The tag's value." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Macie/FindingsFilterProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/25" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Macie/FindingsFilterProperties", + "properties": { + "Action": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "Findings filter action." + }, + "Arn": { + "type": { + "$ref": "#/5" + }, + "flags": 2, + "description": "Findings filter ARN." + }, + "Description": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "Findings filter description" + }, + "FindingCriteria": { + "type": { + "$ref": "#/22" + }, + "flags": 1, + "description": "Findings filter criteria." + }, + "Id": { + "type": { + "$ref": "#/5" + }, + "flags": 18, + "description": "Findings filter ID." + }, + "Name": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "Findings filter name" + }, + "Position": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "Findings filter position." + }, + "Tags": { + "type": { + "$ref": "#/29" + }, + "flags": 0, + "description": "A collection of tags associated with a resource" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Macie/FindingsFilter", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/30" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Macie/FindingsFilter@default", + "scopeType": 0, + "body": { + "$ref": "#/31" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.Macie/SessionProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.Macie/SessionProperties", + "properties": { + "AwsAccountId": { + "type": { + "$ref": "#/5" + }, + "flags": 18, + "description": "AWS account ID of customer" + }, + "FindingPublishingFrequency": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "A enumeration value that specifies how frequently finding updates are published." + }, + "ServiceRole": { + "type": { + "$ref": "#/5" + }, + "flags": 2, + "description": "Service role used by Macie" + }, + "Status": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "A enumeration value that specifies the status of the Macie Session." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Macie/Session", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/34" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Macie/Session@default", + "scopeType": 0, + "body": { + "$ref": "#/35" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.macie/default/types.md b/artifacts/bicep/aws/aws.macie/default/types.md index ab7686fb..f576c780 100644 --- a/artifacts/bicep/aws/aws.macie/default/types.md +++ b/artifacts/bicep/aws/aws.macie/default/types.md @@ -3,30 +3,30 @@ ## Resource AWS.Macie/AllowList@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Macie/AllowListProperties](#awsmacieallowlistproperties) (Required): properties of the resource +* **properties**: [AWS.Macie/AllowListProperties](#awsmacieallowlistproperties) (Required, Identifier): properties of the resource ## Resource AWS.Macie/CustomDataIdentifier@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Macie/CustomDataIdentifierProperties](#awsmaciecustomdataidentifierproperties) (Required): properties of the resource +* **properties**: [AWS.Macie/CustomDataIdentifierProperties](#awsmaciecustomdataidentifierproperties) (Required, Identifier): properties of the resource ## Resource AWS.Macie/FindingsFilter@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Macie/FindingsFilterProperties](#awsmaciefindingsfilterproperties) (Required): properties of the resource +* **properties**: [AWS.Macie/FindingsFilterProperties](#awsmaciefindingsfilterproperties) (Required, Identifier): properties of the resource ## Resource AWS.Macie/Session@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Macie/SessionProperties](#awsmaciesessionproperties): properties of the resource +* **properties**: [AWS.Macie/SessionProperties](#awsmaciesessionproperties) (Identifier): properties of the resource ## AWS.Macie/AllowListProperties ### Properties @@ -38,14 +38,6 @@ * **Status**: string (ReadOnly): AllowList status. * **Tags**: [Tag](#tag)[]: A collection of tags associated with a resource -## Criteria -### Properties - -## Tag -### Properties -* **Key**: string (Required): The tag's key. -* **Value**: string (Required): The tag's value. - ## AWS.Macie/CustomDataIdentifierProperties ### Properties * **Arn**: string (ReadOnly): Custom data identifier ARN. @@ -58,11 +50,6 @@ * **Regex**: string (Required): Regular expression for custom data identifier. * **Tags**: [Tag](#tag)[]: A collection of tags associated with a resource -## Tag -### Properties -* **Key**: string (Required): The tag's key. -* **Value**: string (Required): The tag's value. - ## AWS.Macie/FindingsFilterProperties ### Properties * **Action**: string: Findings filter action. @@ -74,22 +61,35 @@ * **Position**: int: Findings filter position. * **Tags**: [Tag](#tag)[]: A collection of tags associated with a resource +## AWS.Macie/SessionProperties +### Properties +* **AwsAccountId**: string (ReadOnly, Identifier): AWS account ID of customer +* **FindingPublishingFrequency**: string: A enumeration value that specifies how frequently finding updates are published. +* **ServiceRole**: string (ReadOnly): Service role used by Macie +* **Status**: string: A enumeration value that specifies the status of the Macie Session. + +## Criteria +### Properties + +## Criterion +### Properties + ## FindingCriteria ### Properties * **Criterion**: [Criterion](#criterion) -## Criterion +## Tag ### Properties +* **Key**: string (Required): The tag's key. +* **Value**: string (Required): The tag's value. ## Tag ### Properties * **Key**: string (Required): The tag's key. * **Value**: string (Required): The tag's value. -## AWS.Macie/SessionProperties +## Tag ### Properties -* **AwsAccountId**: string (ReadOnly, Identifier): AWS account ID of customer -* **FindingPublishingFrequency**: string: A enumeration value that specifies how frequently finding updates are published. -* **ServiceRole**: string (ReadOnly): Service role used by Macie -* **Status**: string: A enumeration value that specifies the status of the Macie Session. +* **Key**: string (Required): The tag's key. +* **Value**: string (Required): The tag's value. diff --git a/artifacts/bicep/aws/aws.mediaconnect/default/types.json b/artifacts/bicep/aws/aws.mediaconnect/default/types.json index 7fdb24cf..34e86975 100644 --- a/artifacts/bicep/aws/aws.mediaconnect/default/types.json +++ b/artifacts/bicep/aws/aws.mediaconnect/default/types.json @@ -1 +1,2275 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"BridgeFlowSource","Properties":{"FlowArn":{"Type":4,"Flags":1,"Description":"The ARN of the cloud flow used as a source of this bridge."},"FlowVpcInterfaceAttachment":{"Type":21,"Flags":0,"Description":"The name of the VPC interface attachment to use for this source."},"Name":{"Type":4,"Flags":1,"Description":"The name of the flow source."}}}},{"2":{"Name":"BridgeNetworkOutput","Properties":{"IpAddress":{"Type":4,"Flags":1,"Description":"The network output IP Address."},"Name":{"Type":4,"Flags":1,"Description":"The network output name."},"NetworkName":{"Type":4,"Flags":1,"Description":"The network output's gateway network name."},"Port":{"Type":3,"Flags":1,"Description":"The network output port."},"Protocol":{"Type":4,"Flags":1,"Description":"The network output protocol."},"Ttl":{"Type":3,"Flags":1,"Description":"The network output TTL."}}}},{"2":{"Name":"BridgeNetworkSource","Properties":{"MulticastIp":{"Type":4,"Flags":1,"Description":"The network source multicast IP."},"Name":{"Type":4,"Flags":1,"Description":"The name of the network source."},"NetworkName":{"Type":4,"Flags":1,"Description":"The network source's gateway network name."},"Port":{"Type":3,"Flags":1,"Description":"The network source port."},"Protocol":{"Type":4,"Flags":1,"Description":"The network source protocol."}}}},{"2":{"Name":"BridgeOutput","Properties":{"NetworkOutput":{"Type":9,"Flags":0}}}},{"2":{"Name":"BridgeSource","Properties":{"FlowSource":{"Type":8,"Flags":0},"NetworkSource":{"Type":10,"Flags":0}}}},{"2":{"Name":"BridgeStateEnum"}},{"2":{"Name":"EgressGatewayBridge","Properties":{"MaxBitrate":{"Type":3,"Flags":1,"Description":"The maximum expected bitrate of the egress bridge."}}}},{"2":{"Name":"FailoverConfig","Properties":{"FailoverMode":{"Type":4,"Flags":1,"Description":"The type of failover you choose for this flow. FAILOVER allows switching between different streams."},"SourcePriority":{"Type":20,"Flags":0,"Description":"The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams."},"State":{"Type":4,"Flags":0}}}},{"2":{"Name":"FailoverConfigStateEnum"}},{"2":{"Name":"FailoverModeEnum"}},{"2":{"Name":"IngressGatewayBridge","Properties":{"MaxBitrate":{"Type":3,"Flags":1,"Description":"The maximum expected bitrate of the ingress bridge."},"MaxOutputs":{"Type":3,"Flags":1,"Description":"The maximum number of outputs on the ingress bridge."}}}},{"2":{"Name":"ProtocolEnum"}},{"2":{"Name":"SourcePriority","Properties":{"PrimarySource":{"Type":4,"Flags":0,"Description":"The name of the source you choose as the primary source for this flow."}}}},{"2":{"Name":"VpcInterfaceAttachment","Properties":{"VpcInterfaceName":{"Type":4,"Flags":0,"Description":"The name of the VPC interface to use for this resource."}}}},{"2":{"Name":"AWS.MediaConnect/BridgeProperties","Properties":{"BridgeArn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Number (ARN) of the bridge."},"BridgeState":{"Type":4,"Flags":2},"EgressGatewayBridge":{"Type":23,"Flags":0},"IngressGatewayBridge":{"Type":24,"Flags":0},"Name":{"Type":4,"Flags":1,"Description":"The name of the bridge."},"Outputs":{"Type":25,"Flags":0,"Description":"The outputs on this bridge."},"PlacementArn":{"Type":4,"Flags":1,"Description":"The placement Amazon Resource Number (ARN) of the bridge."},"SourceFailoverConfig":{"Type":15,"Flags":0},"Sources":{"Type":26,"Flags":1,"Description":"The sources on this bridge."}}}},{"2":{"Name":"Bridge_EgressGatewayBridge","Properties":{"MaxBitrate":{"Type":3,"Flags":1,"Description":"The maximum expected bitrate of the egress bridge."}}}},{"2":{"Name":"Bridge_IngressGatewayBridge","Properties":{"MaxBitrate":{"Type":3,"Flags":1,"Description":"The maximum expected bitrate of the ingress bridge."},"MaxOutputs":{"Type":3,"Flags":1,"Description":"The maximum number of outputs on the ingress bridge."}}}},{"3":{"ItemType":11}},{"3":{"ItemType":12}},{"2":{"Name":"AWS.MediaConnect/Bridge","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":22,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.MediaConnect/Bridge@default","ScopeType":0,"Body":27}},{"2":{"Name":"BridgeNetworkOutput","Properties":{"IpAddress":{"Type":4,"Flags":1,"Description":"The network output IP Address."},"NetworkName":{"Type":4,"Flags":1,"Description":"The network output's gateway network name."},"Port":{"Type":3,"Flags":1,"Description":"The network output port."},"Protocol":{"Type":4,"Flags":1,"Description":"The network output protocol."},"Ttl":{"Type":3,"Flags":1,"Description":"The network output TTL."}}}},{"2":{"Name":"AWS.MediaConnect/BridgeOutputProperties","Properties":{"BridgeArn":{"Type":4,"Flags":17,"Description":"The Amazon Resource Number (ARN) of the bridge."},"Name":{"Type":4,"Flags":17,"Description":"The network output name."},"NetworkOutput":{"Type":29,"Flags":1,"Description":"The output of the bridge."}}}},{"2":{"Name":"AWS.MediaConnect/BridgeOutput","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":30,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.MediaConnect/BridgeOutput@default","ScopeType":0,"Body":31}},{"2":{"Name":"BridgeFlowSource","Properties":{"FlowArn":{"Type":4,"Flags":1,"Description":"The ARN of the cloud flow used as a source of this bridge."},"FlowVpcInterfaceAttachment":{"Type":36,"Flags":0,"Description":"The name of the VPC interface attachment to use for this source."}}}},{"2":{"Name":"BridgeNetworkSource","Properties":{"MulticastIp":{"Type":4,"Flags":1,"Description":"The network source multicast IP."},"NetworkName":{"Type":4,"Flags":1,"Description":"The network source's gateway network name."},"Port":{"Type":3,"Flags":1,"Description":"The network source port."},"Protocol":{"Type":4,"Flags":1,"Description":"The network source protocol."}}}},{"2":{"Name":"ProtocolEnum"}},{"2":{"Name":"VpcInterfaceAttachment","Properties":{"VpcInterfaceName":{"Type":4,"Flags":0,"Description":"The name of the VPC interface to use for this resource."}}}},{"2":{"Name":"AWS.MediaConnect/BridgeSourceProperties","Properties":{"BridgeArn":{"Type":4,"Flags":17,"Description":"The Amazon Resource Number (ARN) of the bridge."},"FlowSource":{"Type":33,"Flags":0},"Name":{"Type":4,"Flags":17,"Description":"The name of the source."},"NetworkSource":{"Type":34,"Flags":0}}}},{"2":{"Name":"AWS.MediaConnect/BridgeSource","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":37,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.MediaConnect/BridgeSource@default","ScopeType":0,"Body":38}},{"2":{"Name":"Encryption","Properties":{"Algorithm":{"Type":4,"Flags":0,"Description":"The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256)."},"ConstantInitializationVector":{"Type":4,"Flags":0,"Description":"A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption."},"DeviceId":{"Type":4,"Flags":0,"Description":"The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption."},"KeyType":{"Type":4,"Flags":0,"Description":"The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key)."},"Region":{"Type":4,"Flags":0,"Description":"The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption."},"ResourceId":{"Type":4,"Flags":0,"Description":"An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption."},"RoleArn":{"Type":4,"Flags":1,"Description":"The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity)."},"SecretArn":{"Type":4,"Flags":0,"Description":" The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption."},"Url":{"Type":4,"Flags":0,"Description":"The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption."}}}},{"2":{"Name":"FailoverConfig","Properties":{"FailoverMode":{"Type":4,"Flags":0,"Description":"The type of failover you choose for this flow. MERGE combines the source streams into a single stream, allowing graceful recovery from any single-source loss. FAILOVER allows switching between different streams."},"RecoveryWindow":{"Type":3,"Flags":0,"Description":"Search window time to look for dash-7 packets"},"SourcePriority":{"Type":45,"Flags":0,"Description":"The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams."},"State":{"Type":4,"Flags":0}}}},{"2":{"Name":"GatewayBridgeSource","Properties":{"BridgeArn":{"Type":4,"Flags":1,"Description":"The ARN of the bridge feeding this flow."},"VpcInterfaceAttachment":{"Type":44,"Flags":0,"Description":"The name of the VPC interface attachment to use for this bridge source."}}}},{"2":{"Name":"Source","Properties":{"Decryption":{"Type":40,"Flags":0,"Description":"The type of decryption that is used on the content ingested from this source."},"Description":{"Type":4,"Flags":0,"Description":"A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account."},"EntitlementArn":{"Type":4,"Flags":0,"Description":"The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. The entitlement is set by the content originator and the ARN is generated as part of the originator's flow."},"GatewayBridgeSource":{"Type":42,"Flags":0,"Description":"The source configuration for cloud flows receiving a stream from a bridge."},"IngestIp":{"Type":4,"Flags":2,"Description":"The IP address that the flow will be listening on for incoming content."},"IngestPort":{"Type":3,"Flags":0,"Description":"The port that the flow will be listening on for incoming content."},"MaxBitrate":{"Type":3,"Flags":0,"Description":"The smoothing max bitrate for RIST, RTP, and RTP-FEC streams."},"MaxLatency":{"Type":3,"Flags":0,"Description":"The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams."},"MinLatency":{"Type":3,"Flags":0,"Description":"The minimum latency in milliseconds."},"Name":{"Type":4,"Flags":0,"Description":"The name of the source."},"Protocol":{"Type":4,"Flags":0,"Description":"The protocol that is used by the source."},"SenderControlPort":{"Type":3,"Flags":0,"Description":"The port that the flow uses to send outbound requests to initiate connection with the sender for fujitsu-qos protocol."},"SenderIpAddress":{"Type":4,"Flags":0,"Description":"The IP address that the flow communicates with to initiate connection with the sender for fujitsu-qos protocol."},"SourceArn":{"Type":4,"Flags":2,"Description":"The ARN of the source."},"SourceIngestPort":{"Type":4,"Flags":2,"Description":"The port that the flow will be listening on for incoming content.(ReadOnly)"},"SourceListenerAddress":{"Type":4,"Flags":0,"Description":"Source IP or domain name for SRT-caller protocol."},"SourceListenerPort":{"Type":3,"Flags":0,"Description":"Source port for SRT-caller protocol."},"StreamId":{"Type":4,"Flags":0,"Description":"The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams."},"VpcInterfaceName":{"Type":4,"Flags":0,"Description":"The name of the VPC Interface this Source is configured with."},"WhitelistCidr":{"Type":4,"Flags":0,"Description":"The 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."}}}},{"2":{"Name":"VpcInterfaceAttachment","Properties":{"VpcInterfaceName":{"Type":4,"Flags":0,"Description":"The name of the VPC interface to use for this resource."}}}},{"2":{"Name":"Flow_SourcePriority","Properties":{"PrimarySource":{"Type":4,"Flags":1,"Description":"The name of the source you choose as the primary source for this flow."}}}},{"2":{"Name":"AWS.MediaConnect/FlowProperties","Properties":{"AvailabilityZone":{"Type":4,"Flags":0,"Description":"The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS."},"FlowArn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow."},"FlowAvailabilityZone":{"Type":4,"Flags":2,"Description":"The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS.(ReadOnly)"},"Name":{"Type":4,"Flags":1,"Description":"The name of the flow."},"Source":{"Type":43,"Flags":1,"Description":"The source of the flow."},"SourceFailoverConfig":{"Type":41,"Flags":0,"Description":"The source failover config of the flow."}}}},{"2":{"Name":"AWS.MediaConnect/Flow","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":46,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.MediaConnect/Flow@default","ScopeType":0,"Body":47}},{"2":{"Name":"Encryption","Properties":{"Algorithm":{"Type":4,"Flags":1,"Description":"The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256)."},"ConstantInitializationVector":{"Type":4,"Flags":0,"Description":"A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption."},"DeviceId":{"Type":4,"Flags":0,"Description":"The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption."},"KeyType":{"Type":4,"Flags":0,"Description":"The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key)."},"Region":{"Type":4,"Flags":0,"Description":"The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption."},"ResourceId":{"Type":4,"Flags":0,"Description":"An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption."},"RoleArn":{"Type":4,"Flags":1,"Description":"The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity)."},"SecretArn":{"Type":4,"Flags":0,"Description":" The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption."},"Url":{"Type":4,"Flags":0,"Description":"The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption."}}}},{"2":{"Name":"AWS.MediaConnect/FlowEntitlementProperties","Properties":{"DataTransferSubscriberFeePercent":{"Type":3,"Flags":0,"Description":"Percentage from 0-100 of the data transfer cost to be billed to the subscriber."},"Description":{"Type":4,"Flags":1,"Description":"A description of the entitlement."},"Encryption":{"Type":49,"Flags":0,"Description":"The type of encryption that will be used on the output that is associated with this entitlement."},"EntitlementArn":{"Type":4,"Flags":18,"Description":"The ARN of the entitlement."},"EntitlementStatus":{"Type":4,"Flags":0,"Description":" An indication of whether the entitlement is enabled."},"FlowArn":{"Type":4,"Flags":1,"Description":"The ARN of the flow."},"Name":{"Type":4,"Flags":1,"Description":"The name of the entitlement."},"Subscribers":{"Type":51,"Flags":1,"Description":"The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flow using your content as the source."}}}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.MediaConnect/FlowEntitlement","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":50,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.MediaConnect/FlowEntitlement@default","ScopeType":0,"Body":52}},{"2":{"Name":"Encryption","Properties":{"Algorithm":{"Type":4,"Flags":0,"Description":"The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256)."},"KeyType":{"Type":4,"Flags":0,"Description":"The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key)."},"RoleArn":{"Type":4,"Flags":1,"Description":"The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity)."},"SecretArn":{"Type":4,"Flags":1,"Description":" The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption."}}}},{"2":{"Name":"VpcInterfaceAttachment","Properties":{"VpcInterfaceName":{"Type":4,"Flags":0,"Description":"The name of the VPC interface to use for this output."}}}},{"2":{"Name":"AWS.MediaConnect/FlowOutputProperties","Properties":{"CidrAllowList":{"Type":57,"Flags":0,"Description":"The 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."},"Description":{"Type":4,"Flags":0,"Description":"A description of the output."},"Destination":{"Type":4,"Flags":0,"Description":"The address where you want to send the output."},"Encryption":{"Type":54,"Flags":0,"Description":"The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key)."},"FlowArn":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow."},"MaxLatency":{"Type":3,"Flags":0,"Description":"The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams."},"MinLatency":{"Type":3,"Flags":0,"Description":"The minimum latency in milliseconds."},"Name":{"Type":4,"Flags":0,"Description":"The name of the output. This value must be unique within the current flow."},"OutputArn":{"Type":4,"Flags":18,"Description":"The ARN of the output."},"Port":{"Type":3,"Flags":0,"Description":"The port to use when content is distributed to this output."},"Protocol":{"Type":4,"Flags":1,"Description":"The protocol that is used by the source or output."},"RemoteId":{"Type":4,"Flags":0,"Description":"The remote ID for the Zixi-pull stream."},"SmoothingLatency":{"Type":3,"Flags":0,"Description":"The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams."},"StreamId":{"Type":4,"Flags":0,"Description":"The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams."},"VpcInterfaceAttachment":{"Type":55,"Flags":0,"Description":"The name of the VPC interface attachment to use for this output."}}}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.MediaConnect/FlowOutput","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":56,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.MediaConnect/FlowOutput@default","ScopeType":0,"Body":58}},{"2":{"Name":"Encryption","Properties":{"Algorithm":{"Type":4,"Flags":0,"Description":"The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256)."},"ConstantInitializationVector":{"Type":4,"Flags":0,"Description":"A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption."},"DeviceId":{"Type":4,"Flags":0,"Description":"The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption."},"KeyType":{"Type":4,"Flags":0,"Description":"The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key)."},"Region":{"Type":4,"Flags":0,"Description":"The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption."},"ResourceId":{"Type":4,"Flags":0,"Description":"An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption."},"RoleArn":{"Type":4,"Flags":1,"Description":"The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity)."},"SecretArn":{"Type":4,"Flags":0,"Description":" The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption."},"Url":{"Type":4,"Flags":0,"Description":"The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption."}}}},{"2":{"Name":"GatewayBridgeSource","Properties":{"BridgeArn":{"Type":4,"Flags":1,"Description":"The ARN of the bridge feeding this flow."},"VpcInterfaceAttachment":{"Type":62,"Flags":0,"Description":"The name of the VPC interface attachment to use for this bridge source."}}}},{"2":{"Name":"VpcInterfaceAttachment","Properties":{"VpcInterfaceName":{"Type":4,"Flags":0,"Description":"The name of the VPC interface to use for this resource."}}}},{"2":{"Name":"AWS.MediaConnect/FlowSourceProperties","Properties":{"Decryption":{"Type":60,"Flags":0,"Description":"The type of encryption that is used on the content ingested from this source."},"Description":{"Type":4,"Flags":1,"Description":"A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account."},"EntitlementArn":{"Type":4,"Flags":0,"Description":"The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. The entitlement is set by the content originator and the ARN is generated as part of the originator's flow."},"FlowArn":{"Type":4,"Flags":0,"Description":"The ARN of the flow."},"GatewayBridgeSource":{"Type":61,"Flags":0,"Description":"The source configuration for cloud flows receiving a stream from a bridge."},"IngestIp":{"Type":4,"Flags":2,"Description":"The IP address that the flow will be listening on for incoming content."},"IngestPort":{"Type":3,"Flags":0,"Description":"The port that the flow will be listening on for incoming content."},"MaxBitrate":{"Type":3,"Flags":0,"Description":"The smoothing max bitrate for RIST, RTP, and RTP-FEC streams."},"MaxLatency":{"Type":3,"Flags":0,"Description":"The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams."},"MinLatency":{"Type":3,"Flags":0,"Description":"The minimum latency in milliseconds."},"Name":{"Type":4,"Flags":1,"Description":"The name of the source."},"Protocol":{"Type":4,"Flags":0,"Description":"The protocol that is used by the source."},"SenderControlPort":{"Type":3,"Flags":0,"Description":"The port that the flow uses to send outbound requests to initiate connection with the sender for fujitsu-qos protocol."},"SenderIpAddress":{"Type":4,"Flags":0,"Description":"The IP address that the flow communicates with to initiate connection with the sender for fujitsu-qos protocol."},"SourceArn":{"Type":4,"Flags":18,"Description":"The ARN of the source."},"SourceIngestPort":{"Type":4,"Flags":2,"Description":"The port that the flow will be listening on for incoming content.(ReadOnly)"},"SourceListenerAddress":{"Type":4,"Flags":0,"Description":"Source IP or domain name for SRT-caller protocol."},"SourceListenerPort":{"Type":3,"Flags":0,"Description":"Source port for SRT-caller protocol."},"StreamId":{"Type":4,"Flags":0,"Description":"The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams."},"VpcInterfaceName":{"Type":4,"Flags":0,"Description":"The name of the VPC Interface this Source is configured with."},"WhitelistCidr":{"Type":4,"Flags":0,"Description":"The 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."}}}},{"2":{"Name":"AWS.MediaConnect/FlowSource","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":63,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.MediaConnect/FlowSource@default","ScopeType":0,"Body":64}},{"2":{"Name":"AWS.MediaConnect/FlowVpcInterfaceProperties","Properties":{"FlowArn":{"Type":4,"Flags":17,"Description":"The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow."},"Name":{"Type":4,"Flags":17,"Description":"Immutable and has to be a unique against other VpcInterfaces in this Flow."},"NetworkInterfaceIds":{"Type":67,"Flags":2,"Description":"IDs of the network interfaces created in customer's account by MediaConnect."},"RoleArn":{"Type":4,"Flags":1,"Description":"Role Arn MediaConnect can assumes to create ENIs in customer's account."},"SecurityGroupIds":{"Type":68,"Flags":1,"Description":"Security Group IDs to be used on ENI."},"SubnetId":{"Type":4,"Flags":1,"Description":"Subnet must be in the AZ of the Flow"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.MediaConnect/FlowVpcInterface","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":66,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.MediaConnect/FlowVpcInterface@default","ScopeType":0,"Body":69}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "BridgeFlowSource", + "properties": { + "FlowArn": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The ARN of the cloud flow used as a source of this bridge." + }, + "FlowVpcInterfaceAttachment": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "The name of the VPC interface attachment to use for this source." + }, + "Name": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The name of the flow source." + } + } + }, + { + "$type": "ObjectType", + "name": "BridgeNetworkOutput", + "properties": { + "IpAddress": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The network output IP Address." + }, + "Name": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The network output name." + }, + "NetworkName": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The network output's gateway network name." + }, + "Port": { + "type": { + "$ref": "#/15" + }, + "flags": 1, + "description": "The network output port." + }, + "Protocol": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The network output protocol." + }, + "Ttl": { + "type": { + "$ref": "#/15" + }, + "flags": 1, + "description": "The network output TTL." + } + } + }, + { + "$type": "ObjectType", + "name": "BridgeNetworkSource", + "properties": { + "MulticastIp": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The network source multicast IP." + }, + "Name": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The name of the network source." + }, + "NetworkName": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The network source's gateway network name." + }, + "Port": { + "type": { + "$ref": "#/15" + }, + "flags": 1, + "description": "The network source port." + }, + "Protocol": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The network source protocol." + } + } + }, + { + "$type": "ObjectType", + "name": "BridgeOutput", + "properties": { + "NetworkOutput": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BridgeSource", + "properties": { + "FlowSource": { + "type": { + "$ref": "#/0" + }, + "flags": 0 + }, + "NetworkSource": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BridgeStateEnum", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "EgressGatewayBridge", + "properties": { + "MaxBitrate": { + "type": { + "$ref": "#/15" + }, + "flags": 1, + "description": "The maximum expected bitrate of the egress bridge." + } + } + }, + { + "$type": "ObjectType", + "name": "FailoverConfig", + "properties": { + "FailoverMode": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The type of failover you choose for this flow. FAILOVER allows switching between different streams." + }, + "SourcePriority": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams." + }, + "State": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FailoverConfigStateEnum", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "FailoverModeEnum", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "IngressGatewayBridge", + "properties": { + "MaxBitrate": { + "type": { + "$ref": "#/15" + }, + "flags": 1, + "description": "The maximum expected bitrate of the ingress bridge." + }, + "MaxOutputs": { + "type": { + "$ref": "#/15" + }, + "flags": 1, + "description": "The maximum number of outputs on the ingress bridge." + } + } + }, + { + "$type": "ObjectType", + "name": "ProtocolEnum", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SourcePriority", + "properties": { + "PrimarySource": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The name of the source you choose as the primary source for this flow." + } + } + }, + { + "$type": "ObjectType", + "name": "VpcInterfaceAttachment", + "properties": { + "VpcInterfaceName": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The name of the VPC interface to use for this resource." + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "IntegerType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.MediaConnect/BridgeProperties" + }, + { + "$type": "ObjectType", + "name": "Bridge_EgressGatewayBridge", + "properties": { + "MaxBitrate": { + "type": { + "$ref": "#/15" + }, + "flags": 1, + "description": "The maximum expected bitrate of the egress bridge." + } + } + }, + { + "$type": "ObjectType", + "name": "Bridge_IngressGatewayBridge", + "properties": { + "MaxBitrate": { + "type": { + "$ref": "#/15" + }, + "flags": 1, + "description": "The maximum expected bitrate of the ingress bridge." + }, + "MaxOutputs": { + "type": { + "$ref": "#/15" + }, + "flags": 1, + "description": "The maximum number of outputs on the ingress bridge." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ObjectType", + "name": "AWS.MediaConnect/BridgeProperties", + "properties": { + "BridgeArn": { + "type": { + "$ref": "#/14" + }, + "flags": 18, + "description": "The Amazon Resource Number (ARN) of the bridge." + }, + "BridgeState": { + "type": { + "$ref": "#/14" + }, + "flags": 2 + }, + "EgressGatewayBridge": { + "type": { + "$ref": "#/17" + }, + "flags": 0 + }, + "IngressGatewayBridge": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The name of the bridge." + }, + "Outputs": { + "type": { + "$ref": "#/19" + }, + "flags": 0, + "description": "The outputs on this bridge." + }, + "PlacementArn": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The placement Amazon Resource Number (ARN) of the bridge." + }, + "SourceFailoverConfig": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "Sources": { + "type": { + "$ref": "#/20" + }, + "flags": 1, + "description": "The sources on this bridge." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.MediaConnect/Bridge", + "properties": { + "name": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/14" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/21" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.MediaConnect/Bridge@default", + "scopeType": 0, + "body": { + "$ref": "#/22" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "BridgeNetworkOutput", + "properties": { + "IpAddress": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The network output IP Address." + }, + "NetworkName": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The network output's gateway network name." + }, + "Port": { + "type": { + "$ref": "#/15" + }, + "flags": 1, + "description": "The network output port." + }, + "Protocol": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The network output protocol." + }, + "Ttl": { + "type": { + "$ref": "#/15" + }, + "flags": 1, + "description": "The network output TTL." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.MediaConnect/BridgeOutputProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.MediaConnect/BridgeOutputProperties", + "properties": { + "BridgeArn": { + "type": { + "$ref": "#/14" + }, + "flags": 17, + "description": "The Amazon Resource Number (ARN) of the bridge." + }, + "Name": { + "type": { + "$ref": "#/14" + }, + "flags": 17, + "description": "The network output name." + }, + "NetworkOutput": { + "type": { + "$ref": "#/24" + }, + "flags": 1, + "description": "The output of the bridge." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.MediaConnect/BridgeOutput", + "properties": { + "name": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/14" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/26" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.MediaConnect/BridgeOutput@default", + "scopeType": 0, + "body": { + "$ref": "#/27" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "BridgeFlowSource", + "properties": { + "FlowArn": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The ARN of the cloud flow used as a source of this bridge." + }, + "FlowVpcInterfaceAttachment": { + "type": { + "$ref": "#/32" + }, + "flags": 0, + "description": "The name of the VPC interface attachment to use for this source." + } + } + }, + { + "$type": "ObjectType", + "name": "BridgeNetworkSource", + "properties": { + "MulticastIp": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The network source multicast IP." + }, + "NetworkName": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The network source's gateway network name." + }, + "Port": { + "type": { + "$ref": "#/15" + }, + "flags": 1, + "description": "The network source port." + }, + "Protocol": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The network source protocol." + } + } + }, + { + "$type": "ObjectType", + "name": "ProtocolEnum", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "VpcInterfaceAttachment", + "properties": { + "VpcInterfaceName": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The name of the VPC interface to use for this resource." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.MediaConnect/BridgeSourceProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.MediaConnect/BridgeSourceProperties", + "properties": { + "BridgeArn": { + "type": { + "$ref": "#/14" + }, + "flags": 17, + "description": "The Amazon Resource Number (ARN) of the bridge." + }, + "FlowSource": { + "type": { + "$ref": "#/29" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/14" + }, + "flags": 17, + "description": "The name of the source." + }, + "NetworkSource": { + "type": { + "$ref": "#/30" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.MediaConnect/BridgeSource", + "properties": { + "name": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/14" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/34" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.MediaConnect/BridgeSource@default", + "scopeType": 0, + "body": { + "$ref": "#/35" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Encryption", + "properties": { + "Algorithm": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256)." + }, + "ConstantInitializationVector": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption." + }, + "DeviceId": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption." + }, + "KeyType": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key)." + }, + "Region": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption." + }, + "ResourceId": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption." + }, + "RoleArn": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity)." + }, + "SecretArn": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": " The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption." + }, + "Url": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption." + } + } + }, + { + "$type": "ObjectType", + "name": "FailoverConfig", + "properties": { + "FailoverMode": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The type of failover you choose for this flow. MERGE combines the source streams into a single stream, allowing graceful recovery from any single-source loss. FAILOVER allows switching between different streams." + }, + "RecoveryWindow": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "Search window time to look for dash-7 packets" + }, + "SourcePriority": { + "type": { + "$ref": "#/50" + }, + "flags": 0, + "description": "The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams." + }, + "State": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Fmtp", + "properties": { + "ChannelOrder": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The format of the audio channel." + }, + "Colorimetry": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The format used for the representation of color." + }, + "ExactFramerate": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The frame rate for the video stream, in frames/second. For example: 60000/1001." + }, + "Par": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The pixel aspect ratio (PAR) of the video." + }, + "Range": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The encoding range of the video." + }, + "ScanMode": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The type of compression that was used to smooth the video's appearance." + }, + "Tcs": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The transfer characteristic system (TCS) that is used in the video." + } + } + }, + { + "$type": "ObjectType", + "name": "GatewayBridgeSource", + "properties": { + "BridgeArn": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The ARN of the bridge feeding this flow." + }, + "VpcInterfaceAttachment": { + "type": { + "$ref": "#/49" + }, + "flags": 0, + "description": "The name of the VPC interface attachment to use for this bridge source." + } + } + }, + { + "$type": "ObjectType", + "name": "InputConfiguration", + "properties": { + "InputPort": { + "type": { + "$ref": "#/15" + }, + "flags": 1, + "description": "The port that the flow listens on for an incoming media stream." + }, + "Interface": { + "type": { + "$ref": "#/42" + }, + "flags": 1, + "description": "The VPC interface where the media stream comes in from." + } + } + }, + { + "$type": "ObjectType", + "name": "Interface", + "properties": { + "Name": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The name of the VPC interface that you want to use for the media stream associated with the output." + } + } + }, + { + "$type": "ObjectType", + "name": "Maintenance", + "properties": { + "MaintenanceDay": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "A day of a week when the maintenance will happen. Use Monday/Tuesday/Wednesday/Thursday/Friday/Saturday/Sunday." + }, + "MaintenanceStartHour": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "UTC time when the maintenance will happen. Use 24-hour HH:MM format. Minutes must be 00. Example: 13:00. The default value is 02:00." + } + } + }, + { + "$type": "ObjectType", + "name": "MediaStream", + "properties": { + "Attributes": { + "type": { + "$ref": "#/45" + }, + "flags": 0, + "description": "Attributes that are related to the media stream." + }, + "ClockRate": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "The sample rate for the stream. This value in measured in kHz." + }, + "Description": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "A description that can help you quickly identify what your media stream is used for." + }, + "Fmt": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "The format type number (sometimes referred to as RTP payload type) of the media stream. MediaConnect assigns this value to the media stream. For ST 2110 JPEG XS outputs, you need to provide this value to the receiver." + }, + "MediaStreamId": { + "type": { + "$ref": "#/15" + }, + "flags": 1, + "description": "A unique identifier for the media stream." + }, + "MediaStreamName": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "A name that helps you distinguish one media stream from another." + }, + "MediaStreamType": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The type of media stream." + }, + "VideoFormat": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The resolution of the video." + } + } + }, + { + "$type": "ObjectType", + "name": "MediaStreamAttributes", + "properties": { + "Fmtp": { + "type": { + "$ref": "#/39" + }, + "flags": 0, + "description": "A set of parameters that define the media stream." + }, + "Lang": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The audio language, in a format that is recognized by the receiver." + } + } + }, + { + "$type": "ObjectType", + "name": "MediaStreamSourceConfiguration", + "properties": { + "EncodingName": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The format that was used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv." + }, + "InputConfigurations": { + "type": { + "$ref": "#/51" + }, + "flags": 0, + "description": "The media streams that you want to associate with the source." + }, + "MediaStreamName": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "A name that helps you distinguish one media stream from another." + } + } + }, + { + "$type": "ObjectType", + "name": "Source", + "properties": { + "Decryption": { + "type": { + "$ref": "#/37" + }, + "flags": 0, + "description": "The type of decryption that is used on the content ingested from this source." + }, + "Description": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account." + }, + "EntitlementArn": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. The entitlement is set by the content originator and the ARN is generated as part of the originator's flow." + }, + "GatewayBridgeSource": { + "type": { + "$ref": "#/40" + }, + "flags": 0, + "description": "The source configuration for cloud flows receiving a stream from a bridge." + }, + "IngestIp": { + "type": { + "$ref": "#/14" + }, + "flags": 2, + "description": "The IP address that the flow will be listening on for incoming content." + }, + "IngestPort": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "The port that the flow will be listening on for incoming content." + }, + "MaxBitrate": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "The smoothing max bitrate for RIST, RTP, and RTP-FEC streams." + }, + "MaxLatency": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams." + }, + "MaxSyncBuffer": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "The size of the buffer (in milliseconds) to use to sync incoming source data." + }, + "MediaStreamSourceConfigurations": { + "type": { + "$ref": "#/52" + }, + "flags": 0, + "description": "The media stream that is associated with the source, and the parameters for that association." + }, + "MinLatency": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "The minimum latency in milliseconds." + }, + "Name": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The name of the source." + }, + "Protocol": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The protocol that is used by the source." + }, + "SenderControlPort": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "The port that the flow uses to send outbound requests to initiate connection with the sender for fujitsu-qos protocol." + }, + "SenderIpAddress": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The IP address that the flow communicates with to initiate connection with the sender for fujitsu-qos protocol." + }, + "SourceArn": { + "type": { + "$ref": "#/14" + }, + "flags": 2, + "description": "The ARN of the source." + }, + "SourceIngestPort": { + "type": { + "$ref": "#/14" + }, + "flags": 2, + "description": "The port that the flow will be listening on for incoming content.(ReadOnly)" + }, + "SourceListenerAddress": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "Source IP or domain name for SRT-caller protocol." + }, + "SourceListenerPort": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "Source port for SRT-caller protocol." + }, + "StreamId": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams." + }, + "VpcInterfaceName": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The name of the VPC Interface this Source is configured with." + }, + "WhitelistCidr": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The 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." + } + } + }, + { + "$type": "ObjectType", + "name": "VpcInterface", + "properties": { + "Name": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "Immutable and has to be a unique against other VpcInterfaces in this Flow." + }, + "NetworkInterfaceIds": { + "type": { + "$ref": "#/53" + }, + "flags": 0, + "description": "IDs of the network interfaces created in customer's account by MediaConnect." + }, + "NetworkInterfaceType": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The type of network adapter that you want MediaConnect to use on this interface. If you don't set this value, it defaults to ENA." + }, + "RoleArn": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "Role Arn MediaConnect can assume to create ENIs in customer's account." + }, + "SecurityGroupIds": { + "type": { + "$ref": "#/54" + }, + "flags": 1, + "description": "Security Group IDs to be used on ENI." + }, + "SubnetId": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "Subnet must be in the AZ of the Flow" + } + } + }, + { + "$type": "ObjectType", + "name": "VpcInterfaceAttachment", + "properties": { + "VpcInterfaceName": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The name of the VPC interface to use for this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "Flow_SourcePriority", + "properties": { + "PrimarySource": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The name of the source you choose as the primary source for this flow." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/41" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/46" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/14" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/14" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.MediaConnect/FlowProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/44" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/48" + } + }, + { + "$type": "ObjectType", + "name": "AWS.MediaConnect/FlowProperties", + "properties": { + "AvailabilityZone": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS." + }, + "EgressIp": { + "type": { + "$ref": "#/14" + }, + "flags": 2, + "description": "The IP address from which video will be sent to output destinations." + }, + "FlowArn": { + "type": { + "$ref": "#/14" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow." + }, + "FlowAvailabilityZone": { + "type": { + "$ref": "#/14" + }, + "flags": 2, + "description": "The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS.(ReadOnly)" + }, + "Maintenance": { + "type": { + "$ref": "#/43" + }, + "flags": 0, + "description": "The maintenance settings you want to use for the flow. " + }, + "MediaStreams": { + "type": { + "$ref": "#/56" + }, + "flags": 2, + "description": "The media streams associated with the flow. You can associate any of these media streams with sources and outputs on the flow." + }, + "Name": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The name of the flow." + }, + "Source": { + "type": { + "$ref": "#/47" + }, + "flags": 1, + "description": "The source of the flow." + }, + "SourceFailoverConfig": { + "type": { + "$ref": "#/38" + }, + "flags": 0, + "description": "The source failover config of the flow." + }, + "VpcInterfaces": { + "type": { + "$ref": "#/57" + }, + "flags": 2, + "description": "The VPC interfaces that you added to this flow." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.MediaConnect/Flow", + "properties": { + "name": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/14" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/58" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.MediaConnect/Flow@default", + "scopeType": 0, + "body": { + "$ref": "#/59" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Encryption", + "properties": { + "Algorithm": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256)." + }, + "ConstantInitializationVector": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption." + }, + "DeviceId": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption." + }, + "KeyType": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key)." + }, + "Region": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption." + }, + "ResourceId": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption." + }, + "RoleArn": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity)." + }, + "SecretArn": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": " The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption." + }, + "Url": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.MediaConnect/FlowEntitlementProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/14" + } + }, + { + "$type": "ObjectType", + "name": "AWS.MediaConnect/FlowEntitlementProperties", + "properties": { + "DataTransferSubscriberFeePercent": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "Percentage from 0-100 of the data transfer cost to be billed to the subscriber." + }, + "Description": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "A description of the entitlement." + }, + "Encryption": { + "type": { + "$ref": "#/61" + }, + "flags": 0, + "description": "The type of encryption that will be used on the output that is associated with this entitlement." + }, + "EntitlementArn": { + "type": { + "$ref": "#/14" + }, + "flags": 18, + "description": "The ARN of the entitlement." + }, + "EntitlementStatus": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": " An indication of whether the entitlement is enabled." + }, + "FlowArn": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The ARN of the flow." + }, + "Name": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The name of the entitlement." + }, + "Subscribers": { + "type": { + "$ref": "#/63" + }, + "flags": 1, + "description": "The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flow using your content as the source." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.MediaConnect/FlowEntitlement", + "properties": { + "name": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/14" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/64" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.MediaConnect/FlowEntitlement@default", + "scopeType": 0, + "body": { + "$ref": "#/65" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "DestinationConfiguration", + "properties": { + "DestinationIp": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The IP address where contents of the media stream will be sent." + }, + "DestinationPort": { + "type": { + "$ref": "#/15" + }, + "flags": 1, + "description": "The port to use when the content of the media stream is distributed to the output." + }, + "Interface": { + "type": { + "$ref": "#/70" + }, + "flags": 1, + "description": "The VPC interface that is used for the media stream associated with the output." + } + } + }, + { + "$type": "ObjectType", + "name": "EncodingParameters", + "properties": { + "CompressionFactor": { + "type": { + "$ref": "#/15" + }, + "flags": 1, + "description": "A value that is used to calculate compression for an output. The bitrate of the output is calculated as follows: Output bitrate = (1 / compressionFactor) * (source bitrate) This property only applies to outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol. Valid values are in the range of 3.0 to 10.0, inclusive." + }, + "EncoderProfile": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "A setting on the encoder that drives compression settings. This property only applies to video media streams associated with outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol." + } + } + }, + { + "$type": "ObjectType", + "name": "Encryption", + "properties": { + "Algorithm": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256)." + }, + "KeyType": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key)." + }, + "RoleArn": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity)." + }, + "SecretArn": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": " The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption." + } + } + }, + { + "$type": "ObjectType", + "name": "Interface", + "properties": { + "Name": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The name of the VPC interface that you want to use for the media stream associated with the output." + } + } + }, + { + "$type": "ObjectType", + "name": "MediaStreamOutputConfiguration", + "properties": { + "DestinationConfigurations": { + "type": { + "$ref": "#/73" + }, + "flags": 0, + "description": "The media streams that you want to associate with the output." + }, + "EncodingName": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The format that will be used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video streams on sources or outputs that use the CDI protocol, set the encoding name to raw. For video streams on sources or outputs that use the ST 2110 JPEG XS protocol, set the encoding name to jxsv." + }, + "EncodingParameters": { + "type": { + "$ref": "#/68" + }, + "flags": 0, + "description": "A collection of parameters that determine how MediaConnect will convert the content. These fields only apply to outputs on flows that have a CDI source." + }, + "MediaStreamName": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "A name that helps you distinguish one media stream from another." + } + } + }, + { + "$type": "ObjectType", + "name": "VpcInterfaceAttachment", + "properties": { + "VpcInterfaceName": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The name of the VPC interface to use for this output." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/67" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.MediaConnect/FlowOutputProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/14" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/71" + } + }, + { + "$type": "ObjectType", + "name": "AWS.MediaConnect/FlowOutputProperties", + "properties": { + "CidrAllowList": { + "type": { + "$ref": "#/75" + }, + "flags": 0, + "description": "The 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." + }, + "Description": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "A description of the output." + }, + "Destination": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The address where you want to send the output." + }, + "Encryption": { + "type": { + "$ref": "#/69" + }, + "flags": 0, + "description": "The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key)." + }, + "FlowArn": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow." + }, + "MaxLatency": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams." + }, + "MediaStreamOutputConfigurations": { + "type": { + "$ref": "#/76" + }, + "flags": 0, + "description": "The definition for each media stream that is associated with the output." + }, + "MinLatency": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "The minimum latency in milliseconds." + }, + "Name": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The name of the output. This value must be unique within the current flow." + }, + "OutputArn": { + "type": { + "$ref": "#/14" + }, + "flags": 18, + "description": "The ARN of the output." + }, + "Port": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "The port to use when content is distributed to this output." + }, + "Protocol": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The protocol that is used by the source or output." + }, + "RemoteId": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The remote ID for the Zixi-pull stream." + }, + "SmoothingLatency": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams." + }, + "StreamId": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams." + }, + "VpcInterfaceAttachment": { + "type": { + "$ref": "#/72" + }, + "flags": 0, + "description": "The name of the VPC interface attachment to use for this output." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.MediaConnect/FlowOutput", + "properties": { + "name": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/14" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/77" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.MediaConnect/FlowOutput@default", + "scopeType": 0, + "body": { + "$ref": "#/78" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Encryption", + "properties": { + "Algorithm": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256)." + }, + "ConstantInitializationVector": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption." + }, + "DeviceId": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption." + }, + "KeyType": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key)." + }, + "Region": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption." + }, + "ResourceId": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption." + }, + "RoleArn": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity)." + }, + "SecretArn": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": " The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption." + }, + "Url": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption." + } + } + }, + { + "$type": "ObjectType", + "name": "GatewayBridgeSource", + "properties": { + "BridgeArn": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The ARN of the bridge feeding this flow." + }, + "VpcInterfaceAttachment": { + "type": { + "$ref": "#/82" + }, + "flags": 0, + "description": "The name of the VPC interface attachment to use for this bridge source." + } + } + }, + { + "$type": "ObjectType", + "name": "VpcInterfaceAttachment", + "properties": { + "VpcInterfaceName": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The name of the VPC interface to use for this resource." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.MediaConnect/FlowSourceProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.MediaConnect/FlowSourceProperties", + "properties": { + "Decryption": { + "type": { + "$ref": "#/80" + }, + "flags": 0, + "description": "The type of encryption that is used on the content ingested from this source." + }, + "Description": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account." + }, + "EntitlementArn": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. The entitlement is set by the content originator and the ARN is generated as part of the originator's flow." + }, + "FlowArn": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The ARN of the flow." + }, + "GatewayBridgeSource": { + "type": { + "$ref": "#/81" + }, + "flags": 0, + "description": "The source configuration for cloud flows receiving a stream from a bridge." + }, + "IngestIp": { + "type": { + "$ref": "#/14" + }, + "flags": 2, + "description": "The IP address that the flow will be listening on for incoming content." + }, + "IngestPort": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "The port that the flow will be listening on for incoming content." + }, + "MaxBitrate": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "The smoothing max bitrate for RIST, RTP, and RTP-FEC streams." + }, + "MaxLatency": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams." + }, + "MinLatency": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "The minimum latency in milliseconds." + }, + "Name": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The name of the source." + }, + "Protocol": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The protocol that is used by the source." + }, + "SenderControlPort": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "The port that the flow uses to send outbound requests to initiate connection with the sender for fujitsu-qos protocol." + }, + "SenderIpAddress": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The IP address that the flow communicates with to initiate connection with the sender for fujitsu-qos protocol." + }, + "SourceArn": { + "type": { + "$ref": "#/14" + }, + "flags": 18, + "description": "The ARN of the source." + }, + "SourceIngestPort": { + "type": { + "$ref": "#/14" + }, + "flags": 2, + "description": "The port that the flow will be listening on for incoming content.(ReadOnly)" + }, + "SourceListenerAddress": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "Source IP or domain name for SRT-caller protocol." + }, + "SourceListenerPort": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "Source port for SRT-caller protocol." + }, + "StreamId": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams." + }, + "VpcInterfaceName": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The name of the VPC Interface this Source is configured with." + }, + "WhitelistCidr": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The 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." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.MediaConnect/FlowSource", + "properties": { + "name": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/14" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/84" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.MediaConnect/FlowSource@default", + "scopeType": 0, + "body": { + "$ref": "#/85" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.MediaConnect/FlowVpcInterfaceProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/14" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/14" + } + }, + { + "$type": "ObjectType", + "name": "AWS.MediaConnect/FlowVpcInterfaceProperties", + "properties": { + "FlowArn": { + "type": { + "$ref": "#/14" + }, + "flags": 17, + "description": "The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow." + }, + "Name": { + "type": { + "$ref": "#/14" + }, + "flags": 17, + "description": "Immutable and has to be a unique against other VpcInterfaces in this Flow." + }, + "NetworkInterfaceIds": { + "type": { + "$ref": "#/88" + }, + "flags": 2, + "description": "IDs of the network interfaces created in customer's account by MediaConnect." + }, + "RoleArn": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "Role Arn MediaConnect can assume to create ENIs in customer's account." + }, + "SecurityGroupIds": { + "type": { + "$ref": "#/89" + }, + "flags": 1, + "description": "Security Group IDs to be used on ENI." + }, + "SubnetId": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "Subnet must be in the AZ of the Flow" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.MediaConnect/FlowVpcInterface", + "properties": { + "name": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/14" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/90" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.MediaConnect/FlowVpcInterface@default", + "scopeType": 0, + "body": { + "$ref": "#/91" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.mediaconnect/default/types.md b/artifacts/bicep/aws/aws.mediaconnect/default/types.md index 8ae1cc0f..b69e4563 100644 --- a/artifacts/bicep/aws/aws.mediaconnect/default/types.md +++ b/artifacts/bicep/aws/aws.mediaconnect/default/types.md @@ -3,58 +3,64 @@ ## Resource AWS.MediaConnect/Bridge@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.MediaConnect/BridgeProperties](#awsmediaconnectbridgeproperties) (Required): properties of the resource +* **properties**: [AWS.MediaConnect/BridgeProperties](#awsmediaconnectbridgeproperties) (Required, Identifier): properties of the resource ## Resource AWS.MediaConnect/BridgeOutput@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.MediaConnect/BridgeOutputProperties](#awsmediaconnectbridgeoutputproperties) (Required): properties of the resource +* **properties**: [AWS.MediaConnect/BridgeOutputProperties](#awsmediaconnectbridgeoutputproperties) (Required, Identifier): properties of the resource ## Resource AWS.MediaConnect/BridgeSource@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.MediaConnect/BridgeSourceProperties](#awsmediaconnectbridgesourceproperties) (Required): properties of the resource +* **properties**: [AWS.MediaConnect/BridgeSourceProperties](#awsmediaconnectbridgesourceproperties) (Required, Identifier): properties of the resource ## Resource AWS.MediaConnect/Flow@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.MediaConnect/FlowProperties](#awsmediaconnectflowproperties) (Required): properties of the resource +* **properties**: [AWS.MediaConnect/FlowProperties](#awsmediaconnectflowproperties) (Required, Identifier): properties of the resource ## Resource AWS.MediaConnect/FlowEntitlement@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.MediaConnect/FlowEntitlementProperties](#awsmediaconnectflowentitlementproperties) (Required): properties of the resource +* **properties**: [AWS.MediaConnect/FlowEntitlementProperties](#awsmediaconnectflowentitlementproperties) (Required, Identifier): properties of the resource ## Resource AWS.MediaConnect/FlowOutput@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.MediaConnect/FlowOutputProperties](#awsmediaconnectflowoutputproperties) (Required): properties of the resource +* **properties**: [AWS.MediaConnect/FlowOutputProperties](#awsmediaconnectflowoutputproperties) (Required, Identifier): properties of the resource ## Resource AWS.MediaConnect/FlowSource@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.MediaConnect/FlowSourceProperties](#awsmediaconnectflowsourceproperties) (Required): properties of the resource +* **properties**: [AWS.MediaConnect/FlowSourceProperties](#awsmediaconnectflowsourceproperties) (Required, Identifier): properties of the resource ## Resource AWS.MediaConnect/FlowVpcInterface@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.MediaConnect/FlowVpcInterfaceProperties](#awsmediaconnectflowvpcinterfaceproperties) (Required): properties of the resource +* **properties**: [AWS.MediaConnect/FlowVpcInterfaceProperties](#awsmediaconnectflowvpcinterfaceproperties) (Required, Identifier): properties of the resource + +## AWS.MediaConnect/BridgeOutputProperties +### Properties +* **BridgeArn**: string (Required, Identifier): The Amazon Resource Number (ARN) of the bridge. +* **Name**: string (Required, Identifier): The network output name. +* **NetworkOutput**: [BridgeNetworkOutput](#bridgenetworkoutput) (Required): The output of the bridge. ## AWS.MediaConnect/BridgeProperties ### Properties @@ -68,42 +74,97 @@ * **SourceFailoverConfig**: [FailoverConfig](#failoverconfig) * **Sources**: [BridgeSource](#bridgesource)[] (Required): The sources on this bridge. -## Bridge_EgressGatewayBridge +## AWS.MediaConnect/BridgeSourceProperties ### Properties -* **MaxBitrate**: int (Required): The maximum expected bitrate of the egress bridge. +* **BridgeArn**: string (Required, Identifier): The Amazon Resource Number (ARN) of the bridge. +* **FlowSource**: [BridgeFlowSource](#bridgeflowsource) +* **Name**: string (Required, Identifier): The name of the source. +* **NetworkSource**: [BridgeNetworkSource](#bridgenetworksource) -## Bridge_IngressGatewayBridge +## AWS.MediaConnect/FlowEntitlementProperties ### Properties -* **MaxBitrate**: int (Required): The maximum expected bitrate of the ingress bridge. -* **MaxOutputs**: int (Required): The maximum number of outputs on the ingress bridge. +* **DataTransferSubscriberFeePercent**: int: Percentage from 0-100 of the data transfer cost to be billed to the subscriber. +* **Description**: string (Required): A description of the entitlement. +* **Encryption**: [Encryption](#encryption): The type of encryption that will be used on the output that is associated with this entitlement. +* **EntitlementArn**: string (ReadOnly, Identifier): The ARN of the entitlement. +* **EntitlementStatus**: string: An indication of whether the entitlement is enabled. +* **FlowArn**: string (Required): The ARN of the flow. +* **Name**: string (Required): The name of the entitlement. +* **Subscribers**: string[] (Required): The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flow using your content as the source. -## BridgeOutput +## AWS.MediaConnect/FlowOutputProperties ### Properties -* **NetworkOutput**: [BridgeNetworkOutput](#bridgenetworkoutput) +* **CidrAllowList**: string[]: The 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. +* **Description**: string: A description of the output. +* **Destination**: string: The address where you want to send the output. +* **Encryption**: [Encryption](#encryption): The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key). +* **FlowArn**: string (Required): The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow. +* **MaxLatency**: int: The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams. +* **MediaStreamOutputConfigurations**: [MediaStreamOutputConfiguration](#mediastreamoutputconfiguration)[]: The definition for each media stream that is associated with the output. +* **MinLatency**: int: The minimum latency in milliseconds. +* **Name**: string: The name of the output. This value must be unique within the current flow. +* **OutputArn**: string (ReadOnly, Identifier): The ARN of the output. +* **Port**: int: The port to use when content is distributed to this output. +* **Protocol**: string (Required): The protocol that is used by the source or output. +* **RemoteId**: string: The remote ID for the Zixi-pull stream. +* **SmoothingLatency**: int: The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams. +* **StreamId**: string: The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams. +* **VpcInterfaceAttachment**: [VpcInterfaceAttachment](#vpcinterfaceattachment): The name of the VPC interface attachment to use for this output. -## BridgeNetworkOutput +## AWS.MediaConnect/FlowProperties ### Properties -* **IpAddress**: string (Required): The network output IP Address. -* **Name**: string (Required): The network output name. -* **NetworkName**: string (Required): The network output's gateway network name. -* **Port**: int (Required): The network output port. -* **Protocol**: string (Required): The network output protocol. -* **Ttl**: int (Required): The network output TTL. +* **AvailabilityZone**: string: The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS. +* **EgressIp**: string (ReadOnly): The IP address from which video will be sent to output destinations. +* **FlowArn**: string (ReadOnly, Identifier): The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow. +* **FlowAvailabilityZone**: string (ReadOnly): The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS.(ReadOnly) +* **Maintenance**: [Maintenance](#maintenance): The maintenance settings you want to use for the flow. +* **MediaStreams**: [MediaStream](#mediastream)[] (ReadOnly): The media streams associated with the flow. You can associate any of these media streams with sources and outputs on the flow. +* **Name**: string (Required): The name of the flow. +* **Source**: [Source](#source) (Required): The source of the flow. +* **SourceFailoverConfig**: [FailoverConfig](#failoverconfig): The source failover config of the flow. +* **VpcInterfaces**: [VpcInterface](#vpcinterface)[] (ReadOnly): The VPC interfaces that you added to this flow. -## FailoverConfig +## AWS.MediaConnect/FlowSourceProperties ### Properties -* **FailoverMode**: string (Required): The type of failover you choose for this flow. FAILOVER allows switching between different streams. -* **SourcePriority**: [SourcePriority](#sourcepriority): The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams. -* **State**: string +* **Decryption**: [Encryption](#encryption): The type of encryption that is used on the content ingested from this source. +* **Description**: string (Required): A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account. +* **EntitlementArn**: string: The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. The entitlement is set by the content originator and the ARN is generated as part of the originator's flow. +* **FlowArn**: string: The ARN of the flow. +* **GatewayBridgeSource**: [GatewayBridgeSource](#gatewaybridgesource): The source configuration for cloud flows receiving a stream from a bridge. +* **IngestIp**: string (ReadOnly): The IP address that the flow will be listening on for incoming content. +* **IngestPort**: int: The port that the flow will be listening on for incoming content. +* **MaxBitrate**: int: The smoothing max bitrate for RIST, RTP, and RTP-FEC streams. +* **MaxLatency**: int: The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams. +* **MinLatency**: int: The minimum latency in milliseconds. +* **Name**: string (Required): The name of the source. +* **Protocol**: string: The protocol that is used by the source. +* **SenderControlPort**: int: The port that the flow uses to send outbound requests to initiate connection with the sender for fujitsu-qos protocol. +* **SenderIpAddress**: string: The IP address that the flow communicates with to initiate connection with the sender for fujitsu-qos protocol. +* **SourceArn**: string (ReadOnly, Identifier): The ARN of the source. +* **SourceIngestPort**: string (ReadOnly): The port that the flow will be listening on for incoming content.(ReadOnly) +* **SourceListenerAddress**: string: Source IP or domain name for SRT-caller protocol. +* **SourceListenerPort**: int: Source port for SRT-caller protocol. +* **StreamId**: string: The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams. +* **VpcInterfaceName**: string: The name of the VPC Interface this Source is configured with. +* **WhitelistCidr**: string: The 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. -## SourcePriority +## AWS.MediaConnect/FlowVpcInterfaceProperties ### Properties -* **PrimarySource**: string: The name of the source you choose as the primary source for this flow. +* **FlowArn**: string (Required, Identifier): The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow. +* **Name**: string (Required, Identifier): Immutable and has to be a unique against other VpcInterfaces in this Flow. +* **NetworkInterfaceIds**: string[] (ReadOnly): IDs of the network interfaces created in customer's account by MediaConnect. +* **RoleArn**: string (Required): Role Arn MediaConnect can assume to create ENIs in customer's account. +* **SecurityGroupIds**: string[] (Required): Security Group IDs to be used on ENI. +* **SubnetId**: string (Required): Subnet must be in the AZ of the Flow -## BridgeSource +## Bridge_EgressGatewayBridge ### Properties -* **FlowSource**: [BridgeFlowSource](#bridgeflowsource) -* **NetworkSource**: [BridgeNetworkSource](#bridgenetworksource) +* **MaxBitrate**: int (Required): The maximum expected bitrate of the egress bridge. + +## Bridge_IngressGatewayBridge +### Properties +* **MaxBitrate**: int (Required): The maximum expected bitrate of the ingress bridge. +* **MaxOutputs**: int (Required): The maximum number of outputs on the ingress bridge. ## BridgeFlowSource ### Properties @@ -111,9 +172,27 @@ * **FlowVpcInterfaceAttachment**: [VpcInterfaceAttachment](#vpcinterfaceattachment): The name of the VPC interface attachment to use for this source. * **Name**: string (Required): The name of the flow source. -## VpcInterfaceAttachment +## BridgeFlowSource ### Properties -* **VpcInterfaceName**: string: The name of the VPC interface to use for this resource. +* **FlowArn**: string (Required): The ARN of the cloud flow used as a source of this bridge. +* **FlowVpcInterfaceAttachment**: [VpcInterfaceAttachment](#vpcinterfaceattachment): The name of the VPC interface attachment to use for this source. + +## BridgeNetworkOutput +### Properties +* **IpAddress**: string (Required): The network output IP Address. +* **Name**: string (Required): The network output name. +* **NetworkName**: string (Required): The network output's gateway network name. +* **Port**: int (Required): The network output port. +* **Protocol**: string (Required): The network output protocol. +* **Ttl**: int (Required): The network output TTL. + +## BridgeNetworkOutput +### Properties +* **IpAddress**: string (Required): The network output IP Address. +* **NetworkName**: string (Required): The network output's gateway network name. +* **Port**: int (Required): The network output port. +* **Protocol**: string (Required): The network output protocol. +* **Ttl**: int (Required): The network output TTL. ## BridgeNetworkSource ### Properties @@ -123,74 +202,63 @@ * **Port**: int (Required): The network source port. * **Protocol**: string (Required): The network source protocol. -## AWS.MediaConnect/BridgeOutputProperties +## BridgeNetworkSource ### Properties -* **BridgeArn**: string (Required, Identifier): The Amazon Resource Number (ARN) of the bridge. -* **Name**: string (Required, Identifier): The network output name. -* **NetworkOutput**: [BridgeNetworkOutput](#bridgenetworkoutput) (Required): The output of the bridge. +* **MulticastIp**: string (Required): The network source multicast IP. +* **NetworkName**: string (Required): The network source's gateway network name. +* **Port**: int (Required): The network source port. +* **Protocol**: string (Required): The network source protocol. -## BridgeNetworkOutput +## BridgeOutput ### Properties -* **IpAddress**: string (Required): The network output IP Address. -* **NetworkName**: string (Required): The network output's gateway network name. -* **Port**: int (Required): The network output port. -* **Protocol**: string (Required): The network output protocol. -* **Ttl**: int (Required): The network output TTL. +* **NetworkOutput**: [BridgeNetworkOutput](#bridgenetworkoutput) -## AWS.MediaConnect/BridgeSourceProperties +## BridgeSource ### Properties -* **BridgeArn**: string (Required, Identifier): The Amazon Resource Number (ARN) of the bridge. * **FlowSource**: [BridgeFlowSource](#bridgeflowsource) -* **Name**: string (Required, Identifier): The name of the source. * **NetworkSource**: [BridgeNetworkSource](#bridgenetworksource) -## BridgeFlowSource +## DestinationConfiguration ### Properties -* **FlowArn**: string (Required): The ARN of the cloud flow used as a source of this bridge. -* **FlowVpcInterfaceAttachment**: [VpcInterfaceAttachment](#vpcinterfaceattachment): The name of the VPC interface attachment to use for this source. +* **DestinationIp**: string (Required): The IP address where contents of the media stream will be sent. +* **DestinationPort**: int (Required): The port to use when the content of the media stream is distributed to the output. +* **Interface**: [Interface](#interface) (Required): The VPC interface that is used for the media stream associated with the output. -## VpcInterfaceAttachment +## EncodingParameters ### Properties -* **VpcInterfaceName**: string: The name of the VPC interface to use for this resource. +* **CompressionFactor**: int (Required): A value that is used to calculate compression for an output. The bitrate of the output is calculated as follows: Output bitrate = (1 / compressionFactor) * (source bitrate) This property only applies to outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol. Valid values are in the range of 3.0 to 10.0, inclusive. +* **EncoderProfile**: string: A setting on the encoder that drives compression settings. This property only applies to video media streams associated with outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol. -## BridgeNetworkSource +## Encryption ### Properties -* **MulticastIp**: string (Required): The network source multicast IP. -* **NetworkName**: string (Required): The network source's gateway network name. -* **Port**: int (Required): The network source port. -* **Protocol**: string (Required): The network source protocol. +* **Algorithm**: string: The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). +* **ConstantInitializationVector**: string: A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption. +* **DeviceId**: string: The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption. +* **KeyType**: string: The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key). +* **Region**: string: The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption. +* **ResourceId**: string: An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption. +* **RoleArn**: string (Required): The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity). +* **SecretArn**: string: The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption. +* **Url**: string: The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption. -## AWS.MediaConnect/FlowProperties +## Encryption ### Properties -* **AvailabilityZone**: string: The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS. -* **FlowArn**: string (ReadOnly, Identifier): The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow. -* **FlowAvailabilityZone**: string (ReadOnly): The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS.(ReadOnly) -* **Name**: string (Required): The name of the flow. -* **Source**: [Source](#source) (Required): The source of the flow. -* **SourceFailoverConfig**: [FailoverConfig](#failoverconfig): The source failover config of the flow. +* **Algorithm**: string (Required): The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). +* **ConstantInitializationVector**: string: A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption. +* **DeviceId**: string: The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption. +* **KeyType**: string: The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key). +* **Region**: string: The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption. +* **ResourceId**: string: An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption. +* **RoleArn**: string (Required): The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity). +* **SecretArn**: string: The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption. +* **Url**: string: The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption. -## Source +## Encryption ### Properties -* **Decryption**: [Encryption](#encryption): The type of decryption that is used on the content ingested from this source. -* **Description**: string: A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account. -* **EntitlementArn**: string: The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. The entitlement is set by the content originator and the ARN is generated as part of the originator's flow. -* **GatewayBridgeSource**: [GatewayBridgeSource](#gatewaybridgesource): The source configuration for cloud flows receiving a stream from a bridge. -* **IngestIp**: string (ReadOnly): The IP address that the flow will be listening on for incoming content. -* **IngestPort**: int: The port that the flow will be listening on for incoming content. -* **MaxBitrate**: int: The smoothing max bitrate for RIST, RTP, and RTP-FEC streams. -* **MaxLatency**: int: The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams. -* **MinLatency**: int: The minimum latency in milliseconds. -* **Name**: string: The name of the source. -* **Protocol**: string: The protocol that is used by the source. -* **SenderControlPort**: int: The port that the flow uses to send outbound requests to initiate connection with the sender for fujitsu-qos protocol. -* **SenderIpAddress**: string: The IP address that the flow communicates with to initiate connection with the sender for fujitsu-qos protocol. -* **SourceArn**: string (ReadOnly): The ARN of the source. -* **SourceIngestPort**: string (ReadOnly): The port that the flow will be listening on for incoming content.(ReadOnly) -* **SourceListenerAddress**: string: Source IP or domain name for SRT-caller protocol. -* **SourceListenerPort**: int: Source port for SRT-caller protocol. -* **StreamId**: string: The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams. -* **VpcInterfaceName**: string: The name of the VPC Interface this Source is configured with. -* **WhitelistCidr**: string: The 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. +* **Algorithm**: string: The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). +* **KeyType**: string: The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key). +* **RoleArn**: string (Required): The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity). +* **SecretArn**: string (Required): The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption. ## Encryption ### Properties @@ -204,14 +272,11 @@ * **SecretArn**: string: The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption. * **Url**: string: The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption. -## GatewayBridgeSource -### Properties -* **BridgeArn**: string (Required): The ARN of the bridge feeding this flow. -* **VpcInterfaceAttachment**: [VpcInterfaceAttachment](#vpcinterfaceattachment): The name of the VPC interface attachment to use for this bridge source. - -## VpcInterfaceAttachment +## FailoverConfig ### Properties -* **VpcInterfaceName**: string: The name of the VPC interface to use for this resource. +* **FailoverMode**: string (Required): The type of failover you choose for this flow. FAILOVER allows switching between different streams. +* **SourcePriority**: [SourcePriority](#sourcepriority): The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams. +* **State**: string ## FailoverConfig ### Properties @@ -224,75 +289,91 @@ ### Properties * **PrimarySource**: string (Required): The name of the source you choose as the primary source for this flow. -## AWS.MediaConnect/FlowEntitlementProperties +## Fmtp ### Properties -* **DataTransferSubscriberFeePercent**: int: Percentage from 0-100 of the data transfer cost to be billed to the subscriber. -* **Description**: string (Required): A description of the entitlement. -* **Encryption**: [Encryption](#encryption): The type of encryption that will be used on the output that is associated with this entitlement. -* **EntitlementArn**: string (ReadOnly, Identifier): The ARN of the entitlement. -* **EntitlementStatus**: string: An indication of whether the entitlement is enabled. -* **FlowArn**: string (Required): The ARN of the flow. -* **Name**: string (Required): The name of the entitlement. -* **Subscribers**: string[] (Required): The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flow using your content as the source. +* **ChannelOrder**: string: The format of the audio channel. +* **Colorimetry**: string: The format used for the representation of color. +* **ExactFramerate**: string: The frame rate for the video stream, in frames/second. For example: 60000/1001. +* **Par**: string: The pixel aspect ratio (PAR) of the video. +* **Range**: string: The encoding range of the video. +* **ScanMode**: string: The type of compression that was used to smooth the video's appearance. +* **Tcs**: string: The transfer characteristic system (TCS) that is used in the video. -## Encryption +## GatewayBridgeSource ### Properties -* **Algorithm**: string (Required): The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). -* **ConstantInitializationVector**: string: A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption. -* **DeviceId**: string: The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption. -* **KeyType**: string: The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key). -* **Region**: string: The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption. -* **ResourceId**: string: An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption. -* **RoleArn**: string (Required): The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity). -* **SecretArn**: string: The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption. -* **Url**: string: The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption. +* **BridgeArn**: string (Required): The ARN of the bridge feeding this flow. +* **VpcInterfaceAttachment**: [VpcInterfaceAttachment](#vpcinterfaceattachment): The name of the VPC interface attachment to use for this bridge source. -## AWS.MediaConnect/FlowOutputProperties +## GatewayBridgeSource ### Properties -* **CidrAllowList**: string[]: The 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. -* **Description**: string: A description of the output. -* **Destination**: string: The address where you want to send the output. -* **Encryption**: [Encryption](#encryption): The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key). -* **FlowArn**: string (Required): The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow. -* **MaxLatency**: int: The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams. -* **MinLatency**: int: The minimum latency in milliseconds. -* **Name**: string: The name of the output. This value must be unique within the current flow. -* **OutputArn**: string (ReadOnly, Identifier): The ARN of the output. -* **Port**: int: The port to use when content is distributed to this output. -* **Protocol**: string (Required): The protocol that is used by the source or output. -* **RemoteId**: string: The remote ID for the Zixi-pull stream. -* **SmoothingLatency**: int: The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams. -* **StreamId**: string: The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams. -* **VpcInterfaceAttachment**: [VpcInterfaceAttachment](#vpcinterfaceattachment): The name of the VPC interface attachment to use for this output. +* **BridgeArn**: string (Required): The ARN of the bridge feeding this flow. +* **VpcInterfaceAttachment**: [VpcInterfaceAttachment](#vpcinterfaceattachment): The name of the VPC interface attachment to use for this bridge source. -## Encryption +## InputConfiguration ### Properties -* **Algorithm**: string: The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). -* **KeyType**: string: The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key). -* **RoleArn**: string (Required): The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity). -* **SecretArn**: string (Required): The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption. +* **InputPort**: int (Required): The port that the flow listens on for an incoming media stream. +* **Interface**: [Interface](#interface) (Required): The VPC interface where the media stream comes in from. -## VpcInterfaceAttachment +## Interface ### Properties -* **VpcInterfaceName**: string: The name of the VPC interface to use for this output. +* **Name**: string (Required): The name of the VPC interface that you want to use for the media stream associated with the output. -## AWS.MediaConnect/FlowSourceProperties +## Interface ### Properties -* **Decryption**: [Encryption](#encryption): The type of encryption that is used on the content ingested from this source. -* **Description**: string (Required): A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account. +* **Name**: string (Required): The name of the VPC interface that you want to use for the media stream associated with the output. + +## Maintenance +### Properties +* **MaintenanceDay**: string (Required): A day of a week when the maintenance will happen. Use Monday/Tuesday/Wednesday/Thursday/Friday/Saturday/Sunday. +* **MaintenanceStartHour**: string (Required): UTC time when the maintenance will happen. Use 24-hour HH:MM format. Minutes must be 00. Example: 13:00. The default value is 02:00. + +## MediaStream +### Properties +* **Attributes**: [MediaStreamAttributes](#mediastreamattributes): Attributes that are related to the media stream. +* **ClockRate**: int: The sample rate for the stream. This value in measured in kHz. +* **Description**: string: A description that can help you quickly identify what your media stream is used for. +* **Fmt**: int: The format type number (sometimes referred to as RTP payload type) of the media stream. MediaConnect assigns this value to the media stream. For ST 2110 JPEG XS outputs, you need to provide this value to the receiver. +* **MediaStreamId**: int (Required): A unique identifier for the media stream. +* **MediaStreamName**: string (Required): A name that helps you distinguish one media stream from another. +* **MediaStreamType**: string (Required): The type of media stream. +* **VideoFormat**: string: The resolution of the video. + +## MediaStreamAttributes +### Properties +* **Fmtp**: [Fmtp](#fmtp): A set of parameters that define the media stream. +* **Lang**: string: The audio language, in a format that is recognized by the receiver. + +## MediaStreamOutputConfiguration +### Properties +* **DestinationConfigurations**: [DestinationConfiguration](#destinationconfiguration)[]: The media streams that you want to associate with the output. +* **EncodingName**: string (Required): The format that will be used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video streams on sources or outputs that use the CDI protocol, set the encoding name to raw. For video streams on sources or outputs that use the ST 2110 JPEG XS protocol, set the encoding name to jxsv. +* **EncodingParameters**: [EncodingParameters](#encodingparameters): A collection of parameters that determine how MediaConnect will convert the content. These fields only apply to outputs on flows that have a CDI source. +* **MediaStreamName**: string (Required): A name that helps you distinguish one media stream from another. + +## MediaStreamSourceConfiguration +### Properties +* **EncodingName**: string (Required): The format that was used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv. +* **InputConfigurations**: [InputConfiguration](#inputconfiguration)[]: The media streams that you want to associate with the source. +* **MediaStreamName**: string (Required): A name that helps you distinguish one media stream from another. + +## Source +### Properties +* **Decryption**: [Encryption](#encryption): The type of decryption that is used on the content ingested from this source. +* **Description**: string: A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account. * **EntitlementArn**: string: The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. The entitlement is set by the content originator and the ARN is generated as part of the originator's flow. -* **FlowArn**: string: The ARN of the flow. * **GatewayBridgeSource**: [GatewayBridgeSource](#gatewaybridgesource): The source configuration for cloud flows receiving a stream from a bridge. * **IngestIp**: string (ReadOnly): The IP address that the flow will be listening on for incoming content. * **IngestPort**: int: The port that the flow will be listening on for incoming content. * **MaxBitrate**: int: The smoothing max bitrate for RIST, RTP, and RTP-FEC streams. * **MaxLatency**: int: The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams. +* **MaxSyncBuffer**: int: The size of the buffer (in milliseconds) to use to sync incoming source data. +* **MediaStreamSourceConfigurations**: [MediaStreamSourceConfiguration](#mediastreamsourceconfiguration)[]: The media stream that is associated with the source, and the parameters for that association. * **MinLatency**: int: The minimum latency in milliseconds. -* **Name**: string (Required): The name of the source. +* **Name**: string: The name of the source. * **Protocol**: string: The protocol that is used by the source. * **SenderControlPort**: int: The port that the flow uses to send outbound requests to initiate connection with the sender for fujitsu-qos protocol. * **SenderIpAddress**: string: The IP address that the flow communicates with to initiate connection with the sender for fujitsu-qos protocol. -* **SourceArn**: string (ReadOnly, Identifier): The ARN of the source. +* **SourceArn**: string (ReadOnly): The ARN of the source. * **SourceIngestPort**: string (ReadOnly): The port that the flow will be listening on for incoming content.(ReadOnly) * **SourceListenerAddress**: string: Source IP or domain name for SRT-caller protocol. * **SourceListenerPort**: int: Source port for SRT-caller protocol. @@ -300,33 +381,36 @@ * **VpcInterfaceName**: string: The name of the VPC Interface this Source is configured with. * **WhitelistCidr**: string: The 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. -## Encryption +## SourcePriority ### Properties -* **Algorithm**: string: The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). -* **ConstantInitializationVector**: string: A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption. -* **DeviceId**: string: The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption. -* **KeyType**: string: The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key). -* **Region**: string: The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption. -* **ResourceId**: string: An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption. -* **RoleArn**: string (Required): The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity). -* **SecretArn**: string: The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption. -* **Url**: string: The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption. +* **PrimarySource**: string: The name of the source you choose as the primary source for this flow. -## GatewayBridgeSource +## VpcInterface ### Properties -* **BridgeArn**: string (Required): The ARN of the bridge feeding this flow. -* **VpcInterfaceAttachment**: [VpcInterfaceAttachment](#vpcinterfaceattachment): The name of the VPC interface attachment to use for this bridge source. +* **Name**: string (Required): Immutable and has to be a unique against other VpcInterfaces in this Flow. +* **NetworkInterfaceIds**: string[]: IDs of the network interfaces created in customer's account by MediaConnect. +* **NetworkInterfaceType**: string: The type of network adapter that you want MediaConnect to use on this interface. If you don't set this value, it defaults to ENA. +* **RoleArn**: string (Required): Role Arn MediaConnect can assume to create ENIs in customer's account. +* **SecurityGroupIds**: string[] (Required): Security Group IDs to be used on ENI. +* **SubnetId**: string (Required): Subnet must be in the AZ of the Flow ## VpcInterfaceAttachment ### Properties * **VpcInterfaceName**: string: The name of the VPC interface to use for this resource. -## AWS.MediaConnect/FlowVpcInterfaceProperties +## VpcInterfaceAttachment ### Properties -* **FlowArn**: string (Required, Identifier): The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow. -* **Name**: string (Required, Identifier): Immutable and has to be a unique against other VpcInterfaces in this Flow. -* **NetworkInterfaceIds**: string[] (ReadOnly): IDs of the network interfaces created in customer's account by MediaConnect. -* **RoleArn**: string (Required): Role Arn MediaConnect can assumes to create ENIs in customer's account. -* **SecurityGroupIds**: string[] (Required): Security Group IDs to be used on ENI. -* **SubnetId**: string (Required): Subnet must be in the AZ of the Flow +* **VpcInterfaceName**: string: The name of the VPC interface to use for this resource. + +## VpcInterfaceAttachment +### Properties +* **VpcInterfaceName**: string: The name of the VPC interface to use for this resource. + +## VpcInterfaceAttachment +### Properties +* **VpcInterfaceName**: string: The name of the VPC interface to use for this output. + +## VpcInterfaceAttachment +### Properties +* **VpcInterfaceName**: string: The name of the VPC interface to use for this resource. diff --git a/artifacts/bicep/aws/aws.medialive/default/types.json b/artifacts/bicep/aws/aws.medialive/default/types.json index cd66875a..f999be5a 100644 --- a/artifacts/bicep/aws/aws.medialive/default/types.json +++ b/artifacts/bicep/aws/aws.medialive/default/types.json @@ -1 +1,538 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"MultiplexOutputDestination","Properties":{"MultiplexMediaConnectOutputDestinationSettings":{"Type":11,"Flags":0,"Description":"Multiplex MediaConnect output destination settings."}}}},{"2":{"Name":"MultiplexSettings","Properties":{"MaximumVideoBufferDelayMilliseconds":{"Type":3,"Flags":0,"Description":"Maximum video buffer delay in milliseconds."},"TransportStreamBitrate":{"Type":3,"Flags":1,"Description":"Transport stream bit rate."},"TransportStreamId":{"Type":3,"Flags":1,"Description":"Transport stream ID."},"TransportStreamReservedBitrate":{"Type":3,"Flags":0,"Description":"Transport stream reserved bit rate."}}}},{"2":{"Name":"Tags","Properties":{"Key":{"Type":4,"Flags":0},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"Multiplex_MultiplexMediaConnectOutputDestinationSettings","Properties":{"EntitlementArn":{"Type":4,"Flags":0,"Description":"The MediaConnect entitlement ARN available as a Flow source."}}}},{"2":{"Name":"AWS.MediaLive/MultiplexProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"The unique arn of the multiplex."},"AvailabilityZones":{"Type":13,"Flags":1,"Description":"A list of availability zones for the multiplex."},"Destinations":{"Type":14,"Flags":0,"Description":"A list of the multiplex output destinations."},"Id":{"Type":4,"Flags":18,"Description":"The unique id of the multiplex."},"MultiplexSettings":{"Type":9,"Flags":1,"Description":"Configuration for a multiplex event."},"Name":{"Type":4,"Flags":1,"Description":"Name of multiplex."},"PipelinesRunningCount":{"Type":3,"Flags":2,"Description":"The number of currently healthy pipelines."},"ProgramCount":{"Type":3,"Flags":2,"Description":"The number of programs in the multiplex."},"State":{"Type":4,"Flags":2},"Tags":{"Type":15,"Flags":0,"Description":"A collection of key-value pairs."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":8}},{"3":{"ItemType":10}},{"2":{"Name":"AWS.MediaLive/Multiplex","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":12,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.MediaLive/Multiplex@default","ScopeType":0,"Body":16}},{"2":{"Name":"MultiplexProgramPacketIdentifiersMap","Properties":{"AudioPids":{"Type":25,"Flags":0},"DvbSubPids":{"Type":26,"Flags":0},"DvbTeletextPid":{"Type":3,"Flags":0},"EtvPlatformPid":{"Type":3,"Flags":0},"EtvSignalPid":{"Type":3,"Flags":0},"KlvDataPids":{"Type":27,"Flags":0},"PcrPid":{"Type":3,"Flags":0},"PmtPid":{"Type":3,"Flags":0},"PrivateMetadataPid":{"Type":3,"Flags":0},"Scte27Pids":{"Type":28,"Flags":0},"Scte35Pid":{"Type":3,"Flags":0},"TimedMetadataPid":{"Type":3,"Flags":0},"VideoPid":{"Type":3,"Flags":0}}}},{"2":{"Name":"MultiplexProgramPipelineDetail","Properties":{"ActiveChannelPipeline":{"Type":4,"Flags":0,"Description":"Identifies the channel pipeline that is currently active for the pipeline (identified by PipelineId) in the multiplex."},"PipelineId":{"Type":4,"Flags":0,"Description":"Identifies a specific pipeline in the multiplex."}}}},{"2":{"Name":"MultiplexProgramServiceDescriptor","Properties":{"ProviderName":{"Type":4,"Flags":1,"Description":"Name of the provider."},"ServiceName":{"Type":4,"Flags":1,"Description":"Name of the service."}}}},{"2":{"Name":"MultiplexProgramSettings","Properties":{"PreferredChannelPipeline":{"Type":4,"Flags":0},"ProgramNumber":{"Type":3,"Flags":1,"Description":"Unique program number."},"ServiceDescriptor":{"Type":20,"Flags":0,"Description":"Transport stream service descriptor configuration for the Multiplex program."},"VideoSettings":{"Type":23,"Flags":0,"Description":"Program video settings configuration."}}}},{"2":{"Name":"MultiplexStatmuxVideoSettings","Properties":{"MaximumBitrate":{"Type":3,"Flags":0,"Description":"Maximum statmux bitrate."},"MinimumBitrate":{"Type":3,"Flags":0,"Description":"Minimum statmux bitrate."},"Priority":{"Type":3,"Flags":0,"Description":"The 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."}}}},{"2":{"Name":"MultiplexVideoSettings","Properties":{}}},{"2":{"Name":"PreferredChannelPipeline"}},{"3":{"ItemType":3}},{"3":{"ItemType":3}},{"3":{"ItemType":3}},{"3":{"ItemType":3}},{"2":{"Name":"AWS.MediaLive/MultiplexprogramProperties","Properties":{"ChannelId":{"Type":4,"Flags":0,"Description":"The MediaLive channel associated with the program."},"MultiplexId":{"Type":4,"Flags":16,"Description":"The ID of the multiplex that the program belongs to."},"MultiplexProgramSettings":{"Type":21,"Flags":0,"Description":"The settings for this multiplex program."},"PacketIdentifiersMap":{"Type":18,"Flags":0,"Description":"The packet identifier map for this multiplex program."},"PipelineDetails":{"Type":30,"Flags":0,"Description":"Contains information about the current sources for the specified program in the specified multiplex. Keep in mind that each multiplex pipeline connects to both pipelines in a given source channel (the channel identified by the program). But only one of those channel pipelines is ever active at one time."},"PreferredChannelPipeline":{"Type":4,"Flags":4,"Description":"The settings for this multiplex program."},"ProgramName":{"Type":4,"Flags":16,"Description":"The name of the multiplex program."}}}},{"3":{"ItemType":19}},{"2":{"Name":"AWS.MediaLive/Multiplexprogram","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":29,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.MediaLive/Multiplexprogram@default","ScopeType":0,"Body":31}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "MultiplexOutputDestination", + "properties": { + "MultiplexMediaConnectOutputDestinationSettings": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Multiplex MediaConnect output destination settings." + } + } + }, + { + "$type": "ObjectType", + "name": "MultiplexSettings", + "properties": { + "MaximumVideoBufferDelayMilliseconds": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "Maximum video buffer delay in milliseconds." + }, + "TransportStreamBitrate": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "Transport stream bit rate." + }, + "TransportStreamId": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "Transport stream ID." + }, + "TransportStreamReservedBitrate": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "Transport stream reserved bit rate." + } + } + }, + { + "$type": "ObjectType", + "name": "Tags", + "properties": { + "Key": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "ObjectType", + "name": "Multiplex_MultiplexMediaConnectOutputDestinationSettings", + "properties": { + "EntitlementArn": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The MediaConnect entitlement ARN available as a Flow source." + } + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.MediaLive/MultiplexProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ObjectType", + "name": "AWS.MediaLive/MultiplexProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The unique arn of the multiplex." + }, + "AvailabilityZones": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "A list of availability zones for the multiplex." + }, + "Destinations": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "A list of the multiplex output destinations." + }, + "Id": { + "type": { + "$ref": "#/3" + }, + "flags": 18, + "description": "The unique id of the multiplex." + }, + "MultiplexSettings": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Configuration for a multiplex event." + }, + "Name": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "Name of multiplex." + }, + "PipelinesRunningCount": { + "type": { + "$ref": "#/5" + }, + "flags": 2, + "description": "The number of currently healthy pipelines." + }, + "ProgramCount": { + "type": { + "$ref": "#/5" + }, + "flags": 2, + "description": "The number of programs in the multiplex." + }, + "State": { + "type": { + "$ref": "#/3" + }, + "flags": 2 + }, + "Tags": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "A collection of key-value pairs." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.MediaLive/Multiplex", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/10" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.MediaLive/Multiplex@default", + "scopeType": 0, + "body": { + "$ref": "#/11" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "MultiplexProgramPacketIdentifiersMap", + "properties": { + "AudioPids": { + "type": { + "$ref": "#/20" + }, + "flags": 0 + }, + "DvbSubPids": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "DvbTeletextPid": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "EtvPlatformPid": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "EtvSignalPid": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "KlvDataPids": { + "type": { + "$ref": "#/22" + }, + "flags": 0 + }, + "PcrPid": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "PmtPid": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "PrivateMetadataPid": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Scte27Pids": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "Scte35Pid": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "TimedMetadataPid": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "VideoPid": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "MultiplexProgramPipelineDetail", + "properties": { + "ActiveChannelPipeline": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "Identifies the channel pipeline that is currently active for the pipeline (identified by PipelineId) in the multiplex." + }, + "PipelineId": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "Identifies a specific pipeline in the multiplex." + } + } + }, + { + "$type": "ObjectType", + "name": "MultiplexProgramServiceDescriptor", + "properties": { + "ProviderName": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "Name of the provider." + }, + "ServiceName": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "Name of the service." + } + } + }, + { + "$type": "ObjectType", + "name": "MultiplexProgramSettings", + "properties": { + "PreferredChannelPipeline": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "ProgramNumber": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "Unique program number." + }, + "ServiceDescriptor": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "Transport stream service descriptor configuration for the Multiplex program." + }, + "VideoSettings": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "Program video settings configuration." + } + } + }, + { + "$type": "ObjectType", + "name": "MultiplexStatmuxVideoSettings", + "properties": { + "MaximumBitrate": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "Maximum statmux bitrate." + }, + "MinimumBitrate": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "Minimum statmux bitrate." + }, + "Priority": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The 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." + } + } + }, + { + "$type": "ObjectType", + "name": "MultiplexVideoSettings", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PreferredChannelPipeline", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.MediaLive/MultiplexprogramProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/14" + } + }, + { + "$type": "ObjectType", + "name": "AWS.MediaLive/MultiplexprogramProperties", + "properties": { + "ChannelId": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The MediaLive channel associated with the program." + }, + "MultiplexId": { + "type": { + "$ref": "#/3" + }, + "flags": 16, + "description": "The ID of the multiplex that the program belongs to." + }, + "MultiplexProgramSettings": { + "type": { + "$ref": "#/16" + }, + "flags": 0, + "description": "The settings for this multiplex program." + }, + "PacketIdentifiersMap": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "The packet identifier map for this multiplex program." + }, + "PipelineDetails": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "Contains information about the current sources for the specified program in the specified multiplex. Keep in mind that each multiplex pipeline connects to both pipelines in a given source channel (the channel identified by the program). But only one of those channel pipelines is ever active at one time." + }, + "PreferredChannelPipeline": { + "type": { + "$ref": "#/3" + }, + "flags": 4, + "description": "The settings for this multiplex program." + }, + "ProgramName": { + "type": { + "$ref": "#/3" + }, + "flags": 16, + "description": "The name of the multiplex program." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.MediaLive/Multiplexprogram", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/26" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.MediaLive/Multiplexprogram@default", + "scopeType": 0, + "body": { + "$ref": "#/27" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.medialive/default/types.md b/artifacts/bicep/aws/aws.medialive/default/types.md index d847d075..236bb0ea 100644 --- a/artifacts/bicep/aws/aws.medialive/default/types.md +++ b/artifacts/bicep/aws/aws.medialive/default/types.md @@ -3,16 +3,26 @@ ## Resource AWS.MediaLive/Multiplex@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.MediaLive/MultiplexProperties](#awsmedialivemultiplexproperties) (Required): properties of the resource +* **properties**: [AWS.MediaLive/MultiplexProperties](#awsmedialivemultiplexproperties) (Required, Identifier): properties of the resource ## Resource AWS.MediaLive/Multiplexprogram@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.MediaLive/MultiplexprogramProperties](#awsmedialivemultiplexprogramproperties): properties of the resource +* **properties**: [AWS.MediaLive/MultiplexprogramProperties](#awsmedialivemultiplexprogramproperties) (Identifier): properties of the resource + +## AWS.MediaLive/MultiplexprogramProperties +### Properties +* **ChannelId**: string: The MediaLive channel associated with the program. +* **MultiplexId**: string (Identifier): The ID of the multiplex that the program belongs to. +* **MultiplexProgramSettings**: [MultiplexProgramSettings](#multiplexprogramsettings): The settings for this multiplex program. +* **PacketIdentifiersMap**: [MultiplexProgramPacketIdentifiersMap](#multiplexprogrampacketidentifiersmap): The packet identifier map for this multiplex program. +* **PipelineDetails**: [MultiplexProgramPipelineDetail](#multiplexprogrampipelinedetail)[]: Contains information about the current sources for the specified program in the specified multiplex. Keep in mind that each multiplex pipeline connects to both pipelines in a given source channel (the channel identified by the program). But only one of those channel pipelines is ever active at one time. +* **PreferredChannelPipeline**: string (WriteOnly): The settings for this multiplex program. +* **ProgramName**: string (Identifier): The name of the multiplex program. ## AWS.MediaLive/MultiplexProperties ### Properties @@ -27,50 +37,13 @@ * **State**: string (ReadOnly) * **Tags**: [Tags](#tags)[]: A collection of key-value pairs. -## MultiplexOutputDestination -### Properties -* **MultiplexMediaConnectOutputDestinationSettings**: [Multiplex_MultiplexMediaConnectOutputDestinationSettings](#multiplexmultiplexmediaconnectoutputdestinationsettings): Multiplex MediaConnect output destination settings. - ## Multiplex_MultiplexMediaConnectOutputDestinationSettings ### Properties * **EntitlementArn**: string: The MediaConnect entitlement ARN available as a Flow source. -## MultiplexSettings -### Properties -* **MaximumVideoBufferDelayMilliseconds**: int: Maximum video buffer delay in milliseconds. -* **TransportStreamBitrate**: int (Required): Transport stream bit rate. -* **TransportStreamId**: int (Required): Transport stream ID. -* **TransportStreamReservedBitrate**: int: Transport stream reserved bit rate. - -## Tags -### Properties -* **Key**: string -* **Value**: string - -## AWS.MediaLive/MultiplexprogramProperties -### Properties -* **ChannelId**: string: The MediaLive channel associated with the program. -* **MultiplexId**: string (Identifier): The ID of the multiplex that the program belongs to. -* **MultiplexProgramSettings**: [MultiplexProgramSettings](#multiplexprogramsettings): The settings for this multiplex program. -* **PacketIdentifiersMap**: [MultiplexProgramPacketIdentifiersMap](#multiplexprogrampacketidentifiersmap): The packet identifier map for this multiplex program. -* **PipelineDetails**: [MultiplexProgramPipelineDetail](#multiplexprogrampipelinedetail)[]: Contains information about the current sources for the specified program in the specified multiplex. Keep in mind that each multiplex pipeline connects to both pipelines in a given source channel (the channel identified by the program). But only one of those channel pipelines is ever active at one time. -* **PreferredChannelPipeline**: string (WriteOnly): The settings for this multiplex program. -* **ProgramName**: string (Identifier): The name of the multiplex program. - -## MultiplexProgramSettings -### Properties -* **PreferredChannelPipeline**: string -* **ProgramNumber**: int (Required): Unique program number. -* **ServiceDescriptor**: [MultiplexProgramServiceDescriptor](#multiplexprogramservicedescriptor): Transport stream service descriptor configuration for the Multiplex program. -* **VideoSettings**: [MultiplexVideoSettings](#multiplexvideosettings): Program video settings configuration. - -## MultiplexProgramServiceDescriptor -### Properties -* **ProviderName**: string (Required): Name of the provider. -* **ServiceName**: string (Required): Name of the service. - -## MultiplexVideoSettings +## MultiplexOutputDestination ### Properties +* **MultiplexMediaConnectOutputDestinationSettings**: [Multiplex_MultiplexMediaConnectOutputDestinationSettings](#multiplexmultiplexmediaconnectoutputdestinationsettings): Multiplex MediaConnect output destination settings. ## MultiplexProgramPacketIdentifiersMap ### Properties @@ -93,3 +66,30 @@ * **ActiveChannelPipeline**: string: Identifies the channel pipeline that is currently active for the pipeline (identified by PipelineId) in the multiplex. * **PipelineId**: string: Identifies a specific pipeline in the multiplex. +## MultiplexProgramServiceDescriptor +### Properties +* **ProviderName**: string (Required): Name of the provider. +* **ServiceName**: string (Required): Name of the service. + +## MultiplexProgramSettings +### Properties +* **PreferredChannelPipeline**: string +* **ProgramNumber**: int (Required): Unique program number. +* **ServiceDescriptor**: [MultiplexProgramServiceDescriptor](#multiplexprogramservicedescriptor): Transport stream service descriptor configuration for the Multiplex program. +* **VideoSettings**: [MultiplexVideoSettings](#multiplexvideosettings): Program video settings configuration. + +## MultiplexSettings +### Properties +* **MaximumVideoBufferDelayMilliseconds**: int: Maximum video buffer delay in milliseconds. +* **TransportStreamBitrate**: int (Required): Transport stream bit rate. +* **TransportStreamId**: int (Required): Transport stream ID. +* **TransportStreamReservedBitrate**: int: Transport stream reserved bit rate. + +## MultiplexVideoSettings +### Properties + +## Tags +### Properties +* **Key**: string +* **Value**: string + diff --git a/artifacts/bicep/aws/aws.mediapackage/default/types.json b/artifacts/bicep/aws/aws.mediapackage/default/types.json index 0e5cd972..6291d56c 100644 --- a/artifacts/bicep/aws/aws.mediapackage/default/types.json +++ b/artifacts/bicep/aws/aws.mediapackage/default/types.json @@ -1 +1,1131 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"HlsIngest","Properties":{"ingestEndpoints":{"Type":12,"Flags":2,"Description":"A list of endpoints to which the source stream should be sent."}}}},{"2":{"Name":"IngestEndpoint","Properties":{"Id":{"Type":4,"Flags":17,"Description":"The system generated unique identifier for the IngestEndpoint"},"Password":{"Type":4,"Flags":1,"Description":"The system generated password for ingest authentication."},"Url":{"Type":4,"Flags":1,"Description":"The ingest URL to which the source stream should be sent."},"Username":{"Type":4,"Flags":1,"Description":"The system generated username for ingest authentication."}}}},{"2":{"Name":"LogConfiguration","Properties":{"LogGroupName":{"Type":4,"Flags":0,"Description":"Sets a custom AWS CloudWatch log group name for access logs. If a log group name isn't specified, the defaults are used: /aws/MediaPackage/EgressAccessLogs for egress access logs and /aws/MediaPackage/IngressAccessLogs for ingress access logs."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"3":{"ItemType":9}},{"2":{"Name":"AWS.MediaPackage/ChannelProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) assigned to the Channel."},"Description":{"Type":4,"Flags":0,"Description":"A short text description of the Channel."},"EgressAccessLogs":{"Type":10,"Flags":0,"Description":"The configuration parameters for egress access logging."},"HlsIngest":{"Type":8,"Flags":0,"Description":"An HTTP Live Streaming (HLS) ingest resource configuration."},"Id":{"Type":4,"Flags":17,"Description":"The ID of the Channel."},"IngressAccessLogs":{"Type":10,"Flags":0,"Description":"The configuration parameters for egress access logging."},"Tags":{"Type":14,"Flags":0,"Description":"A collection of tags associated with a resource"}}}},{"3":{"ItemType":11}},{"2":{"Name":"AWS.MediaPackage/Channel","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":13,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.MediaPackage/Channel@default","ScopeType":0,"Body":15}},{"2":{"Name":"AdsOnDeliveryRestrictions"}},{"2":{"Name":"Authorization","Properties":{"CdnIdentifierSecret":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) for the secret in Secrets Manager that your Content Distribution Network (CDN) uses for authorization to access your endpoint."},"SecretsRoleArn":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) for the IAM role that allows MediaPackage to communicate with AWS Secrets Manager."}}}},{"2":{"Name":"CmafEncryption","Properties":{"ConstantInitializationVector":{"Type":4,"Flags":0,"Description":"An optional 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting blocks. If you don't specify a value, then MediaPackage creates the constant initialization vector (IV)."},"EncryptionMethod":{"Type":4,"Flags":0,"Description":"The encryption method used"},"KeyRotationIntervalSeconds":{"Type":3,"Flags":0,"Description":"Time (in seconds) between each encryption key rotation."},"SpekeKeyProvider":{"Type":29,"Flags":1}}}},{"2":{"Name":"CmafPackage","Properties":{"Encryption":{"Type":19,"Flags":0},"HlsManifests":{"Type":32,"Flags":0,"Description":"A list of HLS manifest configurations"},"SegmentDurationSeconds":{"Type":3,"Flags":0,"Description":"Duration (in seconds) of each segment. Actual segments will be rounded to the nearest multiple of the source segment duration."},"SegmentPrefix":{"Type":4,"Flags":0,"Description":"An optional custom string that is prepended to the name of each segment. If not specified, it defaults to the ChannelId."},"StreamSelection":{"Type":30,"Flags":0}}}},{"2":{"Name":"DashEncryption","Properties":{"KeyRotationIntervalSeconds":{"Type":3,"Flags":0,"Description":"Time (in seconds) between each encryption key rotation."},"SpekeKeyProvider":{"Type":29,"Flags":1}}}},{"2":{"Name":"DashPackage","Properties":{"AdTriggers":{"Type":33,"Flags":0,"Description":"A list of SCTE-35 message types that are treated as ad markers in the output. If empty, no ad markers are output. Specify multiple items to create ad markers for all of the included message types."},"AdsOnDeliveryRestrictions":{"Type":4,"Flags":0},"Encryption":{"Type":21,"Flags":0},"IncludeIframeOnlyStream":{"Type":2,"Flags":0,"Description":"When enabled, an I-Frame only stream will be included in the output."},"ManifestLayout":{"Type":4,"Flags":0,"Description":"Determines the position of some tags in the Media Presentation Description (MPD). When set to FULL, elements like SegmentTemplate and ContentProtection are included in each Representation. When set to COMPACT, duplicate elements are combined and presented at the AdaptationSet level."},"ManifestWindowSeconds":{"Type":3,"Flags":0,"Description":"Time window (in seconds) contained in each manifest."},"MinBufferTimeSeconds":{"Type":3,"Flags":0,"Description":"Minimum duration (in seconds) that a player will buffer media before starting the presentation."},"MinUpdatePeriodSeconds":{"Type":3,"Flags":0,"Description":"Minimum duration (in seconds) between potential changes to the Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD)."},"PeriodTriggers":{"Type":34,"Flags":0,"Description":"A list of triggers that controls when the outgoing Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD) will be partitioned into multiple periods. If empty, the content will not be partitioned into more than one period. If the list contains \"ADS\", new periods will be created where the Channel source contains SCTE-35 ad markers."},"Profile":{"Type":4,"Flags":0,"Description":"The Dynamic Adaptive Streaming over HTTP (DASH) profile type. When set to \"HBBTV_1_5\", HbbTV 1.5 compliant output is enabled."},"SegmentDurationSeconds":{"Type":3,"Flags":0,"Description":"Duration (in seconds) of each segment. Actual segments will be rounded to the nearest multiple of the source segment duration."},"SegmentTemplateFormat":{"Type":4,"Flags":0,"Description":"Determines the type of SegmentTemplate included in the Media Presentation Description (MPD). When set to NUMBER_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Number$ media URLs. When set to TIME_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Time$ media URLs. When set to NUMBER_WITH_DURATION, only a duration is included in each SegmentTemplate, with $Number$ media URLs."},"StreamSelection":{"Type":30,"Flags":0},"SuggestedPresentationDelaySeconds":{"Type":3,"Flags":0,"Description":"Duration (in seconds) to delay live content before presentation."},"UtcTiming":{"Type":4,"Flags":0,"Description":"Determines the type of UTCTiming included in the Media Presentation Description (MPD)"},"UtcTimingUri":{"Type":4,"Flags":0,"Description":"Specifies the value attribute of the UTCTiming field when utcTiming is set to HTTP-ISO, HTTP-HEAD or HTTP-XSDATE"}}}},{"2":{"Name":"EncryptionContractConfiguration","Properties":{"PresetSpeke20Audio":{"Type":4,"Flags":1,"Description":"A collection of audio encryption presets."},"PresetSpeke20Video":{"Type":4,"Flags":1,"Description":"A collection of video encryption presets."}}}},{"2":{"Name":"HlsEncryption","Properties":{"ConstantInitializationVector":{"Type":4,"Flags":0,"Description":"A constant initialization vector for encryption (optional). When not specified the initialization vector will be periodically rotated."},"EncryptionMethod":{"Type":4,"Flags":0,"Description":"The encryption method to use."},"KeyRotationIntervalSeconds":{"Type":3,"Flags":0,"Description":"Interval (in seconds) between each encryption key rotation."},"RepeatExtXKey":{"Type":2,"Flags":0,"Description":"When enabled, the EXT-X-KEY tag will be repeated in output manifests."},"SpekeKeyProvider":{"Type":29,"Flags":1}}}},{"2":{"Name":"HlsManifest","Properties":{"AdMarkers":{"Type":4,"Flags":0,"Description":"This setting controls how ad markers are included in the packaged OriginEndpoint. \"NONE\" will omit all SCTE-35 ad markers from the output. \"PASSTHROUGH\" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. \"SCTE35_ENHANCED\" generates ad markers and blackout tags based on SCTE-35 messages in the input source. \"DATERANGE\" inserts EXT-X-DATERANGE tags to signal ad and program transition events in HLS and CMAF manifests. For this option, you must set a programDateTimeIntervalSeconds value that is greater than 0."},"AdTriggers":{"Type":35,"Flags":0,"Description":"A list of SCTE-35 message types that are treated as ad markers in the output. If empty, no ad markers are output. Specify multiple items to create ad markers for all of the included message types."},"AdsOnDeliveryRestrictions":{"Type":4,"Flags":0},"Id":{"Type":4,"Flags":17,"Description":"The ID of the manifest. The ID must be unique within the OriginEndpoint and it cannot be changed after it is created."},"IncludeIframeOnlyStream":{"Type":2,"Flags":0,"Description":"When enabled, an I-Frame only stream will be included in the output."},"ManifestName":{"Type":4,"Flags":0,"Description":"An optional short string appended to the end of the OriginEndpoint URL. If not specified, defaults to the manifestName for the OriginEndpoint."},"PlaylistType":{"Type":4,"Flags":0,"Description":"The HTTP Live Streaming (HLS) playlist type. When either \"EVENT\" or \"VOD\" is specified, a corresponding EXT-X-PLAYLIST-TYPE entry will be included in the media playlist."},"PlaylistWindowSeconds":{"Type":3,"Flags":0,"Description":"Time window (in seconds) contained in each parent manifest."},"ProgramDateTimeIntervalSeconds":{"Type":3,"Flags":0,"Description":"The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output."},"Url":{"Type":4,"Flags":0,"Description":"The URL of the packaged OriginEndpoint for consumption."}}}},{"2":{"Name":"HlsPackage","Properties":{"AdMarkers":{"Type":4,"Flags":0,"Description":"This setting controls how ad markers are included in the packaged OriginEndpoint. \"NONE\" will omit all SCTE-35 ad markers from the output. \"PASSTHROUGH\" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. \"SCTE35_ENHANCED\" generates ad markers and blackout tags based on SCTE-35 messages in the input source. \"DATERANGE\" inserts EXT-X-DATERANGE tags to signal ad and program transition events in HLS and CMAF manifests. For this option, you must set a programDateTimeIntervalSeconds value that is greater than 0."},"AdTriggers":{"Type":36,"Flags":0,"Description":"A list of SCTE-35 message types that are treated as ad markers in the output. If empty, no ad markers are output. Specify multiple items to create ad markers for all of the included message types."},"AdsOnDeliveryRestrictions":{"Type":4,"Flags":0},"Encryption":{"Type":24,"Flags":0},"IncludeDvbSubtitles":{"Type":2,"Flags":0,"Description":"When enabled, MediaPackage passes through digital video broadcasting (DVB) subtitles into the output."},"IncludeIframeOnlyStream":{"Type":2,"Flags":0,"Description":"When enabled, an I-Frame only stream will be included in the output."},"PlaylistType":{"Type":4,"Flags":0,"Description":"The HTTP Live Streaming (HLS) playlist type. When either \"EVENT\" or \"VOD\" is specified, a corresponding EXT-X-PLAYLIST-TYPE entry will be included in the media playlist."},"PlaylistWindowSeconds":{"Type":3,"Flags":0,"Description":"Time window (in seconds) contained in each parent manifest."},"ProgramDateTimeIntervalSeconds":{"Type":3,"Flags":0,"Description":"The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output."},"SegmentDurationSeconds":{"Type":3,"Flags":0,"Description":"Duration (in seconds) of each fragment. Actual fragments will be rounded to the nearest multiple of the source fragment duration."},"StreamSelection":{"Type":30,"Flags":0},"UseAudioRenditionGroup":{"Type":2,"Flags":0,"Description":"When enabled, audio streams will be placed in rendition groups in the output."}}}},{"2":{"Name":"MssEncryption","Properties":{"SpekeKeyProvider":{"Type":29,"Flags":1}}}},{"2":{"Name":"MssPackage","Properties":{"Encryption":{"Type":27,"Flags":0},"ManifestWindowSeconds":{"Type":3,"Flags":0,"Description":"The time window (in seconds) contained in each manifest."},"SegmentDurationSeconds":{"Type":3,"Flags":0,"Description":"The duration (in seconds) of each segment."},"StreamSelection":{"Type":30,"Flags":0}}}},{"2":{"Name":"SpekeKeyProvider","Properties":{"CertificateArn":{"Type":4,"Flags":0,"Description":"An Amazon Resource Name (ARN) of a Certificate Manager certificate that MediaPackage will use for enforcing secure end-to-end data transfer with the key provider service."},"EncryptionContractConfiguration":{"Type":23,"Flags":0},"ResourceId":{"Type":4,"Flags":1,"Description":"The resource ID to include in key requests."},"RoleArn":{"Type":4,"Flags":1,"Description":"An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service."},"SystemIds":{"Type":37,"Flags":1,"Description":"The system IDs to include in key requests."},"Url":{"Type":4,"Flags":1,"Description":"The URL of the external key provider service."}}}},{"2":{"Name":"StreamSelection","Properties":{"MaxVideoBitsPerSecond":{"Type":3,"Flags":0,"Description":"The maximum video bitrate (bps) to include in output."},"MinVideoBitsPerSecond":{"Type":3,"Flags":0,"Description":"The minimum video bitrate (bps) to include in output."},"StreamOrder":{"Type":4,"Flags":0,"Description":"A directive that determines the order of streams in the output."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"3":{"ItemType":25}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.MediaPackage/OriginEndpointProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) assigned to the OriginEndpoint."},"Authorization":{"Type":18,"Flags":0},"ChannelId":{"Type":4,"Flags":1,"Description":"The ID of the Channel the OriginEndpoint is associated with."},"CmafPackage":{"Type":20,"Flags":0},"DashPackage":{"Type":22,"Flags":0},"Description":{"Type":4,"Flags":0,"Description":"A short text description of the OriginEndpoint."},"HlsPackage":{"Type":26,"Flags":0},"Id":{"Type":4,"Flags":17,"Description":"The ID of the OriginEndpoint."},"ManifestName":{"Type":4,"Flags":0,"Description":"A short string appended to the end of the OriginEndpoint URL."},"MssPackage":{"Type":28,"Flags":0},"Origination":{"Type":4,"Flags":0,"Description":"Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint may by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be requested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination"},"StartoverWindowSeconds":{"Type":3,"Flags":0,"Description":"Maximum duration (seconds) of content to retain for startover playback. If not specified, startover playback will be disabled for the OriginEndpoint."},"Tags":{"Type":39,"Flags":0,"Description":"A collection of tags associated with a resource"},"TimeDelaySeconds":{"Type":3,"Flags":0,"Description":"Amount of delay (seconds) to enforce on the playback of live content. If not specified, there will be no time delay in effect for the OriginEndpoint."},"Url":{"Type":4,"Flags":2,"Description":"The URL of the packaged OriginEndpoint for consumption."},"Whitelist":{"Type":40,"Flags":0,"Description":"A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint."}}}},{"3":{"ItemType":31}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.MediaPackage/OriginEndpoint","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":38,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.MediaPackage/OriginEndpoint@default","ScopeType":0,"Body":41}},{"2":{"Name":"Authorization","Properties":{"CdnIdentifierSecret":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) for the secret in AWS Secrets Manager that is used for CDN authorization."},"SecretsRoleArn":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) for the IAM role that allows MediaPackage to communicate with AWS Secrets Manager."}}}},{"2":{"Name":"LogConfiguration","Properties":{"LogGroupName":{"Type":4,"Flags":0,"Description":"Sets a custom AWS CloudWatch log group name for egress logs. If a log group name isn't specified, the default name is used: /aws/MediaPackage/VodEgressAccessLogs."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.MediaPackage/PackagingGroupProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"The ARN of the PackagingGroup."},"Authorization":{"Type":43,"Flags":0,"Description":"CDN Authorization"},"DomainName":{"Type":4,"Flags":2,"Description":"The fully qualified domain name for Assets in the PackagingGroup."},"EgressAccessLogs":{"Type":44,"Flags":0,"Description":"The configuration parameters for egress access logging."},"Id":{"Type":4,"Flags":17,"Description":"The ID of the PackagingGroup."},"Tags":{"Type":47,"Flags":0,"Description":"A collection of tags associated with a resource"}}}},{"3":{"ItemType":45}},{"2":{"Name":"AWS.MediaPackage/PackagingGroup","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":46,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.MediaPackage/PackagingGroup@default","ScopeType":0,"Body":48}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "HlsIngest", + "properties": { + "ingestEndpoints": { + "type": { + "$ref": "#/4" + }, + "flags": 2, + "description": "A list of endpoints to which the source stream should be sent." + } + } + }, + { + "$type": "ObjectType", + "name": "IngestEndpoint", + "properties": { + "Id": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "The system generated unique identifier for the IngestEndpoint" + }, + "Password": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The system generated password for ingest authentication." + }, + "Url": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The ingest URL to which the source stream should be sent." + }, + "Username": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The system generated username for ingest authentication." + } + } + }, + { + "$type": "ObjectType", + "name": "LogConfiguration", + "properties": { + "LogGroupName": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "Sets a custom AWS CloudWatch log group name for access logs. If a log group name isn't specified, the defaults are used: /aws/MediaPackage/EgressAccessLogs for egress access logs and /aws/MediaPackage/IngressAccessLogs for ingress access logs." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.MediaPackage/ChannelProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ObjectType", + "name": "AWS.MediaPackage/ChannelProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/5" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) assigned to the Channel." + }, + "Description": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "A short text description of the Channel." + }, + "EgressAccessLogs": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The configuration parameters for egress access logging." + }, + "HlsIngest": { + "type": { + "$ref": "#/0" + }, + "flags": 0, + "description": "An HTTP Live Streaming (HLS) ingest resource configuration." + }, + "Id": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "The ID of the Channel." + }, + "IngressAccessLogs": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The configuration parameters for egress access logging." + }, + "Tags": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "A collection of tags associated with a resource" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.MediaPackage/Channel", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/8" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.MediaPackage/Channel@default", + "scopeType": 0, + "body": { + "$ref": "#/9" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AdsOnDeliveryRestrictions", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Authorization", + "properties": { + "CdnIdentifierSecret": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) for the secret in Secrets Manager that your Content Distribution Network (CDN) uses for authorization to access your endpoint." + }, + "SecretsRoleArn": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) for the IAM role that allows MediaPackage to communicate with AWS Secrets Manager." + } + } + }, + { + "$type": "ObjectType", + "name": "CmafEncryption", + "properties": { + "ConstantInitializationVector": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "An optional 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting blocks. If you don't specify a value, then MediaPackage creates the constant initialization vector (IV)." + }, + "EncryptionMethod": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The encryption method used" + }, + "KeyRotationIntervalSeconds": { + "type": { + "$ref": "#/26" + }, + "flags": 0, + "description": "Time (in seconds) between each encryption key rotation." + }, + "SpekeKeyProvider": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CmafPackage", + "properties": { + "Encryption": { + "type": { + "$ref": "#/13" + }, + "flags": 0 + }, + "HlsManifests": { + "type": { + "$ref": "#/27" + }, + "flags": 0, + "description": "A list of HLS manifest configurations" + }, + "SegmentDurationSeconds": { + "type": { + "$ref": "#/26" + }, + "flags": 0, + "description": "Duration (in seconds) of each segment. Actual segments will be rounded to the nearest multiple of the source segment duration." + }, + "SegmentPrefix": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "An optional custom string that is prepended to the name of each segment. If not specified, it defaults to the ChannelId." + }, + "StreamSelection": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DashEncryption", + "properties": { + "KeyRotationIntervalSeconds": { + "type": { + "$ref": "#/26" + }, + "flags": 0, + "description": "Time (in seconds) between each encryption key rotation." + }, + "SpekeKeyProvider": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DashPackage", + "properties": { + "AdTriggers": { + "type": { + "$ref": "#/28" + }, + "flags": 0, + "description": "A list of SCTE-35 message types that are treated as ad markers in the output. If empty, no ad markers are output. Specify multiple items to create ad markers for all of the included message types." + }, + "AdsOnDeliveryRestrictions": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Encryption": { + "type": { + "$ref": "#/15" + }, + "flags": 0 + }, + "IncludeIframeOnlyStream": { + "type": { + "$ref": "#/29" + }, + "flags": 0, + "description": "When enabled, an I-Frame only stream will be included in the output." + }, + "ManifestLayout": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "Determines the position of some tags in the Media Presentation Description (MPD). When set to FULL, elements like SegmentTemplate and ContentProtection are included in each Representation. When set to COMPACT, duplicate elements are combined and presented at the AdaptationSet level." + }, + "ManifestWindowSeconds": { + "type": { + "$ref": "#/26" + }, + "flags": 0, + "description": "Time window (in seconds) contained in each manifest." + }, + "MinBufferTimeSeconds": { + "type": { + "$ref": "#/26" + }, + "flags": 0, + "description": "Minimum duration (in seconds) that a player will buffer media before starting the presentation." + }, + "MinUpdatePeriodSeconds": { + "type": { + "$ref": "#/26" + }, + "flags": 0, + "description": "Minimum duration (in seconds) between potential changes to the Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD)." + }, + "PeriodTriggers": { + "type": { + "$ref": "#/30" + }, + "flags": 0, + "description": "A list of triggers that controls when the outgoing Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD) will be partitioned into multiple periods. If empty, the content will not be partitioned into more than one period. If the list contains \"ADS\", new periods will be created where the Channel source contains SCTE-35 ad markers." + }, + "Profile": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The Dynamic Adaptive Streaming over HTTP (DASH) profile type. When set to \"HBBTV_1_5\", HbbTV 1.5 compliant output is enabled." + }, + "SegmentDurationSeconds": { + "type": { + "$ref": "#/26" + }, + "flags": 0, + "description": "Duration (in seconds) of each segment. Actual segments will be rounded to the nearest multiple of the source segment duration." + }, + "SegmentTemplateFormat": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "Determines the type of SegmentTemplate included in the Media Presentation Description (MPD). When set to NUMBER_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Number$ media URLs. When set to TIME_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Time$ media URLs. When set to NUMBER_WITH_DURATION, only a duration is included in each SegmentTemplate, with $Number$ media URLs." + }, + "StreamSelection": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "SuggestedPresentationDelaySeconds": { + "type": { + "$ref": "#/26" + }, + "flags": 0, + "description": "Duration (in seconds) to delay live content before presentation." + }, + "UtcTiming": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "Determines the type of UTCTiming included in the Media Presentation Description (MPD)" + }, + "UtcTimingUri": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "Specifies the value attribute of the UTCTiming field when utcTiming is set to HTTP-ISO, HTTP-HEAD or HTTP-XSDATE" + } + } + }, + { + "$type": "ObjectType", + "name": "EncryptionContractConfiguration", + "properties": { + "PresetSpeke20Audio": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "A collection of audio encryption presets." + }, + "PresetSpeke20Video": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "A collection of video encryption presets." + } + } + }, + { + "$type": "ObjectType", + "name": "HlsEncryption", + "properties": { + "ConstantInitializationVector": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "A constant initialization vector for encryption (optional). When not specified the initialization vector will be periodically rotated." + }, + "EncryptionMethod": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The encryption method to use." + }, + "KeyRotationIntervalSeconds": { + "type": { + "$ref": "#/26" + }, + "flags": 0, + "description": "Interval (in seconds) between each encryption key rotation." + }, + "RepeatExtXKey": { + "type": { + "$ref": "#/29" + }, + "flags": 0, + "description": "When enabled, the EXT-X-KEY tag will be repeated in output manifests." + }, + "SpekeKeyProvider": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "HlsManifest", + "properties": { + "AdMarkers": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "This setting controls how ad markers are included in the packaged OriginEndpoint. \"NONE\" will omit all SCTE-35 ad markers from the output. \"PASSTHROUGH\" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. \"SCTE35_ENHANCED\" generates ad markers and blackout tags based on SCTE-35 messages in the input source. \"DATERANGE\" inserts EXT-X-DATERANGE tags to signal ad and program transition events in HLS and CMAF manifests. For this option, you must set a programDateTimeIntervalSeconds value that is greater than 0." + }, + "AdTriggers": { + "type": { + "$ref": "#/31" + }, + "flags": 0, + "description": "A list of SCTE-35 message types that are treated as ad markers in the output. If empty, no ad markers are output. Specify multiple items to create ad markers for all of the included message types." + }, + "AdsOnDeliveryRestrictions": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Id": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "The ID of the manifest. The ID must be unique within the OriginEndpoint and it cannot be changed after it is created." + }, + "IncludeIframeOnlyStream": { + "type": { + "$ref": "#/29" + }, + "flags": 0, + "description": "When enabled, an I-Frame only stream will be included in the output." + }, + "ManifestName": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "An optional short string appended to the end of the OriginEndpoint URL. If not specified, defaults to the manifestName for the OriginEndpoint." + }, + "PlaylistType": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The HTTP Live Streaming (HLS) playlist type. When either \"EVENT\" or \"VOD\" is specified, a corresponding EXT-X-PLAYLIST-TYPE entry will be included in the media playlist." + }, + "PlaylistWindowSeconds": { + "type": { + "$ref": "#/26" + }, + "flags": 0, + "description": "Time window (in seconds) contained in each parent manifest." + }, + "ProgramDateTimeIntervalSeconds": { + "type": { + "$ref": "#/26" + }, + "flags": 0, + "description": "The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output." + }, + "Url": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The URL of the packaged OriginEndpoint for consumption." + } + } + }, + { + "$type": "ObjectType", + "name": "HlsPackage", + "properties": { + "AdMarkers": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "This setting controls how ad markers are included in the packaged OriginEndpoint. \"NONE\" will omit all SCTE-35 ad markers from the output. \"PASSTHROUGH\" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. \"SCTE35_ENHANCED\" generates ad markers and blackout tags based on SCTE-35 messages in the input source. \"DATERANGE\" inserts EXT-X-DATERANGE tags to signal ad and program transition events in HLS and CMAF manifests. For this option, you must set a programDateTimeIntervalSeconds value that is greater than 0." + }, + "AdTriggers": { + "type": { + "$ref": "#/32" + }, + "flags": 0, + "description": "A list of SCTE-35 message types that are treated as ad markers in the output. If empty, no ad markers are output. Specify multiple items to create ad markers for all of the included message types." + }, + "AdsOnDeliveryRestrictions": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Encryption": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "IncludeDvbSubtitles": { + "type": { + "$ref": "#/29" + }, + "flags": 0, + "description": "When enabled, MediaPackage passes through digital video broadcasting (DVB) subtitles into the output." + }, + "IncludeIframeOnlyStream": { + "type": { + "$ref": "#/29" + }, + "flags": 0, + "description": "When enabled, an I-Frame only stream will be included in the output." + }, + "PlaylistType": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The HTTP Live Streaming (HLS) playlist type. When either \"EVENT\" or \"VOD\" is specified, a corresponding EXT-X-PLAYLIST-TYPE entry will be included in the media playlist." + }, + "PlaylistWindowSeconds": { + "type": { + "$ref": "#/26" + }, + "flags": 0, + "description": "Time window (in seconds) contained in each parent manifest." + }, + "ProgramDateTimeIntervalSeconds": { + "type": { + "$ref": "#/26" + }, + "flags": 0, + "description": "The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output." + }, + "SegmentDurationSeconds": { + "type": { + "$ref": "#/26" + }, + "flags": 0, + "description": "Duration (in seconds) of each fragment. Actual fragments will be rounded to the nearest multiple of the source fragment duration." + }, + "StreamSelection": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "UseAudioRenditionGroup": { + "type": { + "$ref": "#/29" + }, + "flags": 0, + "description": "When enabled, audio streams will be placed in rendition groups in the output." + } + } + }, + { + "$type": "ObjectType", + "name": "MssEncryption", + "properties": { + "SpekeKeyProvider": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "MssPackage", + "properties": { + "Encryption": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "ManifestWindowSeconds": { + "type": { + "$ref": "#/26" + }, + "flags": 0, + "description": "The time window (in seconds) contained in each manifest." + }, + "SegmentDurationSeconds": { + "type": { + "$ref": "#/26" + }, + "flags": 0, + "description": "The duration (in seconds) of each segment." + }, + "StreamSelection": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SpekeKeyProvider", + "properties": { + "CertificateArn": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "An Amazon Resource Name (ARN) of a Certificate Manager certificate that MediaPackage will use for enforcing secure end-to-end data transfer with the key provider service." + }, + "EncryptionContractConfiguration": { + "type": { + "$ref": "#/17" + }, + "flags": 0 + }, + "ResourceId": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The resource ID to include in key requests." + }, + "RoleArn": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service." + }, + "SystemIds": { + "type": { + "$ref": "#/33" + }, + "flags": 1, + "description": "The system IDs to include in key requests." + }, + "Url": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The URL of the external key provider service." + } + } + }, + { + "$type": "ObjectType", + "name": "StreamSelection", + "properties": { + "MaxVideoBitsPerSecond": { + "type": { + "$ref": "#/26" + }, + "flags": 0, + "description": "The maximum video bitrate (bps) to include in output." + }, + "MinVideoBitsPerSecond": { + "type": { + "$ref": "#/26" + }, + "flags": 0, + "description": "The minimum video bitrate (bps) to include in output." + }, + "StreamOrder": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "A directive that determines the order of streams in the output." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/19" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.MediaPackage/OriginEndpointProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/25" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ObjectType", + "name": "AWS.MediaPackage/OriginEndpointProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/5" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) assigned to the OriginEndpoint." + }, + "Authorization": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + }, + "ChannelId": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The ID of the Channel the OriginEndpoint is associated with." + }, + "CmafPackage": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + }, + "DashPackage": { + "type": { + "$ref": "#/16" + }, + "flags": 0 + }, + "Description": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "A short text description of the OriginEndpoint." + }, + "HlsPackage": { + "type": { + "$ref": "#/20" + }, + "flags": 0 + }, + "Id": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "The ID of the OriginEndpoint." + }, + "ManifestName": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "A short string appended to the end of the OriginEndpoint URL." + }, + "MssPackage": { + "type": { + "$ref": "#/22" + }, + "flags": 0 + }, + "Origination": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint may by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be requested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination" + }, + "StartoverWindowSeconds": { + "type": { + "$ref": "#/26" + }, + "flags": 0, + "description": "Maximum duration (seconds) of content to retain for startover playback. If not specified, startover playback will be disabled for the OriginEndpoint." + }, + "Tags": { + "type": { + "$ref": "#/35" + }, + "flags": 0, + "description": "A collection of tags associated with a resource" + }, + "TimeDelaySeconds": { + "type": { + "$ref": "#/26" + }, + "flags": 0, + "description": "Amount of delay (seconds) to enforce on the playback of live content. If not specified, there will be no time delay in effect for the OriginEndpoint." + }, + "Url": { + "type": { + "$ref": "#/5" + }, + "flags": 2, + "description": "The URL of the packaged OriginEndpoint for consumption." + }, + "Whitelist": { + "type": { + "$ref": "#/36" + }, + "flags": 0, + "description": "A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.MediaPackage/OriginEndpoint", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/37" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.MediaPackage/OriginEndpoint@default", + "scopeType": 0, + "body": { + "$ref": "#/38" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Authorization", + "properties": { + "CdnIdentifierSecret": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) for the secret in AWS Secrets Manager that is used for CDN authorization." + }, + "SecretsRoleArn": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) for the IAM role that allows MediaPackage to communicate with AWS Secrets Manager." + } + } + }, + { + "$type": "ObjectType", + "name": "LogConfiguration", + "properties": { + "LogGroupName": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "Sets a custom AWS CloudWatch log group name for egress logs. If a log group name isn't specified, the default name is used: /aws/MediaPackage/VodEgressAccessLogs." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.MediaPackage/PackagingGroupProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/42" + } + }, + { + "$type": "ObjectType", + "name": "AWS.MediaPackage/PackagingGroupProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/5" + }, + "flags": 2, + "description": "The ARN of the PackagingGroup." + }, + "Authorization": { + "type": { + "$ref": "#/40" + }, + "flags": 0, + "description": "CDN Authorization" + }, + "DomainName": { + "type": { + "$ref": "#/5" + }, + "flags": 2, + "description": "The fully qualified domain name for Assets in the PackagingGroup." + }, + "EgressAccessLogs": { + "type": { + "$ref": "#/41" + }, + "flags": 0, + "description": "The configuration parameters for egress access logging." + }, + "Id": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "The ID of the PackagingGroup." + }, + "Tags": { + "type": { + "$ref": "#/44" + }, + "flags": 0, + "description": "A collection of tags associated with a resource" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.MediaPackage/PackagingGroup", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/45" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.MediaPackage/PackagingGroup@default", + "scopeType": 0, + "body": { + "$ref": "#/46" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.mediapackage/default/types.md b/artifacts/bicep/aws/aws.mediapackage/default/types.md index 1a2cc547..31e7eb7c 100644 --- a/artifacts/bicep/aws/aws.mediapackage/default/types.md +++ b/artifacts/bicep/aws/aws.mediapackage/default/types.md @@ -3,23 +3,33 @@ ## Resource AWS.MediaPackage/Channel@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.MediaPackage/ChannelProperties](#awsmediapackagechannelproperties) (Required): properties of the resource +* **properties**: [AWS.MediaPackage/ChannelProperties](#awsmediapackagechannelproperties) (Required, Identifier): properties of the resource ## Resource AWS.MediaPackage/OriginEndpoint@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.MediaPackage/OriginEndpointProperties](#awsmediapackageoriginendpointproperties) (Required): properties of the resource +* **properties**: [AWS.MediaPackage/OriginEndpointProperties](#awsmediapackageoriginendpointproperties) (Required, Identifier): properties of the resource ## Resource AWS.MediaPackage/PackagingGroup@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.MediaPackage/PackagingGroupProperties](#awsmediapackagepackaginggroupproperties) (Required): properties of the resource +* **properties**: [AWS.MediaPackage/PackagingGroupProperties](#awsmediapackagepackaginggroupproperties) (Required, Identifier): properties of the resource + +## Authorization +### Properties +* **CdnIdentifierSecret**: string (Required): The Amazon Resource Name (ARN) for the secret in Secrets Manager that your Content Distribution Network (CDN) uses for authorization to access your endpoint. +* **SecretsRoleArn**: string (Required): The Amazon Resource Name (ARN) for the IAM role that allows MediaPackage to communicate with AWS Secrets Manager. + +## Authorization +### Properties +* **CdnIdentifierSecret**: string (Required): The Amazon Resource Name (ARN) for the secret in AWS Secrets Manager that is used for CDN authorization. +* **SecretsRoleArn**: string (Required): The Amazon Resource Name (ARN) for the IAM role that allows MediaPackage to communicate with AWS Secrets Manager. ## AWS.MediaPackage/ChannelProperties ### Properties @@ -31,26 +41,6 @@ * **IngressAccessLogs**: [LogConfiguration](#logconfiguration): The configuration parameters for egress access logging. * **Tags**: [Tag](#tag)[]: A collection of tags associated with a resource -## LogConfiguration -### Properties -* **LogGroupName**: string: Sets a custom AWS CloudWatch log group name for access logs. If a log group name isn't specified, the defaults are used: /aws/MediaPackage/EgressAccessLogs for egress access logs and /aws/MediaPackage/IngressAccessLogs for ingress access logs. - -## HlsIngest -### Properties -* **ingestEndpoints**: [IngestEndpoint](#ingestendpoint)[] (ReadOnly): A list of endpoints to which the source stream should be sent. - -## IngestEndpoint -### Properties -* **Id**: string (Required, Identifier): The system generated unique identifier for the IngestEndpoint -* **Password**: string (Required): The system generated password for ingest authentication. -* **Url**: string (Required): The ingest URL to which the source stream should be sent. -* **Username**: string (Required): The system generated username for ingest authentication. - -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - ## AWS.MediaPackage/OriginEndpointProperties ### Properties * **Arn**: string (ReadOnly): The Amazon Resource Name (ARN) assigned to the OriginEndpoint. @@ -70,10 +60,21 @@ * **Url**: string (ReadOnly): The URL of the packaged OriginEndpoint for consumption. * **Whitelist**: string[]: A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint. -## Authorization +## AWS.MediaPackage/PackagingGroupProperties ### Properties -* **CdnIdentifierSecret**: string (Required): The Amazon Resource Name (ARN) for the secret in Secrets Manager that your Content Distribution Network (CDN) uses for authorization to access your endpoint. -* **SecretsRoleArn**: string (Required): The Amazon Resource Name (ARN) for the IAM role that allows MediaPackage to communicate with AWS Secrets Manager. +* **Arn**: string (ReadOnly): The ARN of the PackagingGroup. +* **Authorization**: [Authorization](#authorization): CDN Authorization +* **DomainName**: string (ReadOnly): The fully qualified domain name for Assets in the PackagingGroup. +* **EgressAccessLogs**: [LogConfiguration](#logconfiguration): The configuration parameters for egress access logging. +* **Id**: string (Required, Identifier): The ID of the PackagingGroup. +* **Tags**: [Tag](#tag)[]: A collection of tags associated with a resource + +## CmafEncryption +### Properties +* **ConstantInitializationVector**: string: An optional 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting blocks. If you don't specify a value, then MediaPackage creates the constant initialization vector (IV). +* **EncryptionMethod**: string: The encryption method used +* **KeyRotationIntervalSeconds**: int: Time (in seconds) between each encryption key rotation. +* **SpekeKeyProvider**: [SpekeKeyProvider](#spekekeyprovider) (Required) ## CmafPackage ### Properties @@ -83,46 +84,11 @@ * **SegmentPrefix**: string: An optional custom string that is prepended to the name of each segment. If not specified, it defaults to the ChannelId. * **StreamSelection**: [StreamSelection](#streamselection) -## CmafEncryption +## DashEncryption ### Properties -* **ConstantInitializationVector**: string: An optional 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting blocks. If you don't specify a value, then MediaPackage creates the constant initialization vector (IV). -* **EncryptionMethod**: string: The encryption method used * **KeyRotationIntervalSeconds**: int: Time (in seconds) between each encryption key rotation. * **SpekeKeyProvider**: [SpekeKeyProvider](#spekekeyprovider) (Required) -## SpekeKeyProvider -### Properties -* **CertificateArn**: string: An Amazon Resource Name (ARN) of a Certificate Manager certificate that MediaPackage will use for enforcing secure end-to-end data transfer with the key provider service. -* **EncryptionContractConfiguration**: [EncryptionContractConfiguration](#encryptioncontractconfiguration) -* **ResourceId**: string (Required): The resource ID to include in key requests. -* **RoleArn**: string (Required): An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service. -* **SystemIds**: string[] (Required): The system IDs to include in key requests. -* **Url**: string (Required): The URL of the external key provider service. - -## EncryptionContractConfiguration -### Properties -* **PresetSpeke20Audio**: string (Required): A collection of audio encryption presets. -* **PresetSpeke20Video**: string (Required): A collection of video encryption presets. - -## HlsManifest -### Properties -* **AdMarkers**: string: This setting controls how ad markers are included in the packaged OriginEndpoint. "NONE" will omit all SCTE-35 ad markers from the output. "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. "SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35 messages in the input source. "DATERANGE" inserts EXT-X-DATERANGE tags to signal ad and program transition events in HLS and CMAF manifests. For this option, you must set a programDateTimeIntervalSeconds value that is greater than 0. -* **AdsOnDeliveryRestrictions**: string -* **AdTriggers**: string[]: A list of SCTE-35 message types that are treated as ad markers in the output. If empty, no ad markers are output. Specify multiple items to create ad markers for all of the included message types. -* **Id**: string (Required, Identifier): The ID of the manifest. The ID must be unique within the OriginEndpoint and it cannot be changed after it is created. -* **IncludeIframeOnlyStream**: bool: When enabled, an I-Frame only stream will be included in the output. -* **ManifestName**: string: An optional short string appended to the end of the OriginEndpoint URL. If not specified, defaults to the manifestName for the OriginEndpoint. -* **PlaylistType**: string: The HTTP Live Streaming (HLS) playlist type. When either "EVENT" or "VOD" is specified, a corresponding EXT-X-PLAYLIST-TYPE entry will be included in the media playlist. -* **PlaylistWindowSeconds**: int: Time window (in seconds) contained in each parent manifest. -* **ProgramDateTimeIntervalSeconds**: int: The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output. -* **Url**: string: The URL of the packaged OriginEndpoint for consumption. - -## StreamSelection -### Properties -* **MaxVideoBitsPerSecond**: int: The maximum video bitrate (bps) to include in output. -* **MinVideoBitsPerSecond**: int: The minimum video bitrate (bps) to include in output. -* **StreamOrder**: string: A directive that determines the order of streams in the output. - ## DashPackage ### Properties * **AdsOnDeliveryRestrictions**: string @@ -142,11 +108,36 @@ * **UtcTiming**: string: Determines the type of UTCTiming included in the Media Presentation Description (MPD) * **UtcTimingUri**: string: Specifies the value attribute of the UTCTiming field when utcTiming is set to HTTP-ISO, HTTP-HEAD or HTTP-XSDATE -## DashEncryption +## EncryptionContractConfiguration ### Properties -* **KeyRotationIntervalSeconds**: int: Time (in seconds) between each encryption key rotation. +* **PresetSpeke20Audio**: string (Required): A collection of audio encryption presets. +* **PresetSpeke20Video**: string (Required): A collection of video encryption presets. + +## HlsEncryption +### Properties +* **ConstantInitializationVector**: string: A constant initialization vector for encryption (optional). When not specified the initialization vector will be periodically rotated. +* **EncryptionMethod**: string: The encryption method to use. +* **KeyRotationIntervalSeconds**: int: Interval (in seconds) between each encryption key rotation. +* **RepeatExtXKey**: bool: When enabled, the EXT-X-KEY tag will be repeated in output manifests. * **SpekeKeyProvider**: [SpekeKeyProvider](#spekekeyprovider) (Required) +## HlsIngest +### Properties +* **ingestEndpoints**: [IngestEndpoint](#ingestendpoint)[] (ReadOnly): A list of endpoints to which the source stream should be sent. + +## HlsManifest +### Properties +* **AdMarkers**: string: This setting controls how ad markers are included in the packaged OriginEndpoint. "NONE" will omit all SCTE-35 ad markers from the output. "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. "SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35 messages in the input source. "DATERANGE" inserts EXT-X-DATERANGE tags to signal ad and program transition events in HLS and CMAF manifests. For this option, you must set a programDateTimeIntervalSeconds value that is greater than 0. +* **AdsOnDeliveryRestrictions**: string +* **AdTriggers**: string[]: A list of SCTE-35 message types that are treated as ad markers in the output. If empty, no ad markers are output. Specify multiple items to create ad markers for all of the included message types. +* **Id**: string (Required, Identifier): The ID of the manifest. The ID must be unique within the OriginEndpoint and it cannot be changed after it is created. +* **IncludeIframeOnlyStream**: bool: When enabled, an I-Frame only stream will be included in the output. +* **ManifestName**: string: An optional short string appended to the end of the OriginEndpoint URL. If not specified, defaults to the manifestName for the OriginEndpoint. +* **PlaylistType**: string: The HTTP Live Streaming (HLS) playlist type. When either "EVENT" or "VOD" is specified, a corresponding EXT-X-PLAYLIST-TYPE entry will be included in the media playlist. +* **PlaylistWindowSeconds**: int: Time window (in seconds) contained in each parent manifest. +* **ProgramDateTimeIntervalSeconds**: int: The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output. +* **Url**: string: The URL of the packaged OriginEndpoint for consumption. + ## HlsPackage ### Properties * **AdMarkers**: string: This setting controls how ad markers are included in the packaged OriginEndpoint. "NONE" will omit all SCTE-35 ad markers from the output. "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. "SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35 messages in the input source. "DATERANGE" inserts EXT-X-DATERANGE tags to signal ad and program transition events in HLS and CMAF manifests. For this option, you must set a programDateTimeIntervalSeconds value that is greater than 0. @@ -162,12 +153,23 @@ * **StreamSelection**: [StreamSelection](#streamselection) * **UseAudioRenditionGroup**: bool: When enabled, audio streams will be placed in rendition groups in the output. -## HlsEncryption +## IngestEndpoint +### Properties +* **Id**: string (Required, Identifier): The system generated unique identifier for the IngestEndpoint +* **Password**: string (Required): The system generated password for ingest authentication. +* **Url**: string (Required): The ingest URL to which the source stream should be sent. +* **Username**: string (Required): The system generated username for ingest authentication. + +## LogConfiguration +### Properties +* **LogGroupName**: string: Sets a custom AWS CloudWatch log group name for access logs. If a log group name isn't specified, the defaults are used: /aws/MediaPackage/EgressAccessLogs for egress access logs and /aws/MediaPackage/IngressAccessLogs for ingress access logs. + +## LogConfiguration +### Properties +* **LogGroupName**: string: Sets a custom AWS CloudWatch log group name for egress logs. If a log group name isn't specified, the default name is used: /aws/MediaPackage/VodEgressAccessLogs. + +## MssEncryption ### Properties -* **ConstantInitializationVector**: string: A constant initialization vector for encryption (optional). When not specified the initialization vector will be periodically rotated. -* **EncryptionMethod**: string: The encryption method to use. -* **KeyRotationIntervalSeconds**: int: Interval (in seconds) between each encryption key rotation. -* **RepeatExtXKey**: bool: When enabled, the EXT-X-KEY tag will be repeated in output manifests. * **SpekeKeyProvider**: [SpekeKeyProvider](#spekekeyprovider) (Required) ## MssPackage @@ -177,32 +179,30 @@ * **SegmentDurationSeconds**: int: The duration (in seconds) of each segment. * **StreamSelection**: [StreamSelection](#streamselection) -## MssEncryption +## SpekeKeyProvider ### Properties -* **SpekeKeyProvider**: [SpekeKeyProvider](#spekekeyprovider) (Required) +* **CertificateArn**: string: An Amazon Resource Name (ARN) of a Certificate Manager certificate that MediaPackage will use for enforcing secure end-to-end data transfer with the key provider service. +* **EncryptionContractConfiguration**: [EncryptionContractConfiguration](#encryptioncontractconfiguration) +* **ResourceId**: string (Required): The resource ID to include in key requests. +* **RoleArn**: string (Required): An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service. +* **SystemIds**: string[] (Required): The system IDs to include in key requests. +* **Url**: string (Required): The URL of the external key provider service. + +## StreamSelection +### Properties +* **MaxVideoBitsPerSecond**: int: The maximum video bitrate (bps) to include in output. +* **MinVideoBitsPerSecond**: int: The minimum video bitrate (bps) to include in output. +* **StreamOrder**: string: A directive that determines the order of streams in the output. ## Tag ### Properties * **Key**: string (Required) * **Value**: string (Required) -## AWS.MediaPackage/PackagingGroupProperties -### Properties -* **Arn**: string (ReadOnly): The ARN of the PackagingGroup. -* **Authorization**: [Authorization](#authorization): CDN Authorization -* **DomainName**: string (ReadOnly): The fully qualified domain name for Assets in the PackagingGroup. -* **EgressAccessLogs**: [LogConfiguration](#logconfiguration): The configuration parameters for egress access logging. -* **Id**: string (Required, Identifier): The ID of the PackagingGroup. -* **Tags**: [Tag](#tag)[]: A collection of tags associated with a resource - -## Authorization -### Properties -* **CdnIdentifierSecret**: string (Required): The Amazon Resource Name (ARN) for the secret in AWS Secrets Manager that is used for CDN authorization. -* **SecretsRoleArn**: string (Required): The Amazon Resource Name (ARN) for the IAM role that allows MediaPackage to communicate with AWS Secrets Manager. - -## LogConfiguration +## Tag ### Properties -* **LogGroupName**: string: Sets a custom AWS CloudWatch log group name for egress logs. If a log group name isn't specified, the default name is used: /aws/MediaPackage/VodEgressAccessLogs. +* **Key**: string (Required) +* **Value**: string (Required) ## Tag ### Properties diff --git a/artifacts/bicep/aws/aws.mediapackagev2/default/types.json b/artifacts/bicep/aws/aws.mediapackagev2/default/types.json index e640ae55..3aa74d82 100644 --- a/artifacts/bicep/aws/aws.mediapackagev2/default/types.json +++ b/artifacts/bicep/aws/aws.mediapackagev2/default/types.json @@ -1 +1,1189 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"IngestEndpoint","Properties":{"Id":{"Type":4,"Flags":0},"Url":{"Type":4,"Flags":0}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":0},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"AWS.MediaPackageV2/ChannelProperties","Properties":{"Arn":{"Type":4,"Flags":18},"ChannelGroupName":{"Type":4,"Flags":0},"ChannelName":{"Type":4,"Flags":0},"CreatedAt":{"Type":4,"Flags":2},"Description":{"Type":4,"Flags":0},"IngestEndpoints":{"Type":11,"Flags":2},"ModifiedAt":{"Type":4,"Flags":2},"Tags":{"Type":12,"Flags":0}}}},{"3":{"ItemType":8}},{"3":{"ItemType":9}},{"2":{"Name":"AWS.MediaPackageV2/Channel","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":10,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.MediaPackageV2/Channel@default","ScopeType":0,"Body":13}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":0},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"AWS.MediaPackageV2/ChannelGroupProperties","Properties":{"Arn":{"Type":4,"Flags":18},"ChannelGroupName":{"Type":4,"Flags":0},"CreatedAt":{"Type":4,"Flags":2},"Description":{"Type":4,"Flags":0},"EgressDomain":{"Type":4,"Flags":2},"ModifiedAt":{"Type":4,"Flags":2},"Tags":{"Type":17,"Flags":0}}}},{"3":{"ItemType":15}},{"2":{"Name":"AWS.MediaPackageV2/ChannelGroup","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":16,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.MediaPackageV2/ChannelGroup@default","ScopeType":0,"Body":18}},{"2":{"Name":"AWS.MediaPackageV2/ChannelPolicyProperties","Properties":{"ChannelGroupName":{"Type":4,"Flags":16},"ChannelName":{"Type":4,"Flags":16},"Policy":{"Type":22,"Flags":1}}}},{"2":{"Name":"ChannelPolicy_Policy","Properties":{}}},{"5":{"Elements":[21,4]}},{"2":{"Name":"AWS.MediaPackageV2/ChannelPolicy","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":20,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.MediaPackageV2/ChannelPolicy@default","ScopeType":0,"Body":23}},{"2":{"Name":"AdMarkerHls"}},{"2":{"Name":"CmafEncryptionMethod"}},{"2":{"Name":"ContainerType"}},{"2":{"Name":"DrmSystem"}},{"2":{"Name":"Encryption","Properties":{"ConstantInitializationVector":{"Type":4,"Flags":0,"Description":"

A 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).

"},"EncryptionMethod":{"Type":31,"Flags":1},"KeyRotationIntervalSeconds":{"Type":3,"Flags":0,"Description":"

The frequency (in seconds) of key changes for live workflows, in which content is streamed real time. The service retrieves content keys before the live content begins streaming, and then retrieves them as needed over the lifetime of the workflow. By default, key rotation is set to 300 seconds (5 minutes), the minimum rotation interval, which is equivalent to setting it to 300. If you don't enter an interval, content keys aren't rotated.

\n

The following example setting causes the service to rotate keys every thirty minutes: 1800\n

"},"SpekeKeyProvider":{"Type":41,"Flags":1}}}},{"2":{"Name":"EncryptionContractConfiguration","Properties":{"PresetSpeke20Audio":{"Type":4,"Flags":1},"PresetSpeke20Video":{"Type":4,"Flags":1}}}},{"2":{"Name":"EncryptionMethod","Properties":{"CmafEncryptionMethod":{"Type":4,"Flags":0},"TsEncryptionMethod":{"Type":4,"Flags":0}}}},{"2":{"Name":"FilterConfiguration","Properties":{"End":{"Type":4,"Flags":0,"Description":"

Optionally 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.

"},"ManifestFilter":{"Type":4,"Flags":0,"Description":"

Optionally 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.

"},"Start":{"Type":4,"Flags":0,"Description":"

Optionally 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.

"},"TimeDelaySeconds":{"Type":3,"Flags":0,"Description":"

Optionally 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.

"}}}},{"2":{"Name":"HlsManifestConfiguration","Properties":{"ChildManifestName":{"Type":4,"Flags":0,"Description":"

A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default child manifest name, index_1. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

"},"FilterConfiguration":{"Type":32,"Flags":0},"ManifestName":{"Type":4,"Flags":1,"Description":"

A short 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.

"},"ManifestWindowSeconds":{"Type":3,"Flags":0,"Description":"

The total duration (in seconds) of the manifest's content.

"},"ProgramDateTimeIntervalSeconds":{"Type":3,"Flags":0,"Description":"

Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, \n EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. \n The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player. \n ID3Timed metadata messages generate every 5 seconds whenever the content is ingested.

\n

Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.

"},"ScteHls":{"Type":39,"Flags":0},"Url":{"Type":4,"Flags":0,"Description":"

The egress domain URL for stream delivery from MediaPackage.

"}}}},{"2":{"Name":"LowLatencyHlsManifestConfiguration","Properties":{"ChildManifestName":{"Type":4,"Flags":0,"Description":"

A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default child manifest name, index_1. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

"},"FilterConfiguration":{"Type":32,"Flags":0},"ManifestName":{"Type":4,"Flags":1,"Description":"

A short 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.

"},"ManifestWindowSeconds":{"Type":3,"Flags":0,"Description":"

The total duration (in seconds) of the manifest's content.

"},"ProgramDateTimeIntervalSeconds":{"Type":3,"Flags":0,"Description":"

Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, \n EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. \n The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player. \n ID3Timed metadata messages generate every 5 seconds whenever the content is ingested.

\n

Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.

"},"ScteHls":{"Type":39,"Flags":0},"Url":{"Type":4,"Flags":0,"Description":"

The egress domain URL for stream delivery from MediaPackage.

"}}}},{"2":{"Name":"PresetSpeke20Audio"}},{"2":{"Name":"PresetSpeke20Video"}},{"2":{"Name":"Scte","Properties":{"ScteFilter":{"Type":44,"Flags":0,"Description":"

The SCTE-35 message types that you want to be treated as ad markers in the output.

"}}}},{"2":{"Name":"ScteFilter"}},{"2":{"Name":"ScteHls","Properties":{"AdMarkerHls":{"Type":4,"Flags":0}}}},{"2":{"Name":"Segment","Properties":{"Encryption":{"Type":29,"Flags":0},"IncludeIframeOnlyStreams":{"Type":2,"Flags":0,"Description":"

When selected, the stream set includes an additional I-frame only stream, along with the other tracks. If false, this extra stream is not included. MediaPackage generates an I-frame only stream from the first rendition in the manifest. The service inserts EXT-I-FRAMES-ONLY tags in the output manifest, and then generates and includes an I-frames only playlist in the stream. This playlist permits player functionality like fast forward and rewind.

"},"Scte":{"Type":37,"Flags":0},"SegmentDurationSeconds":{"Type":3,"Flags":0,"Description":"

The duration (in seconds) of each segment. Enter a value equal to, or a multiple of, the input segment duration. If the value that you enter is different from the input segment duration, MediaPackage rounds segments to the nearest multiple of the input segment duration.

"},"SegmentName":{"Type":4,"Flags":0,"Description":"

The name that describes the segment. The name is the base name of the segment used in all content manifests inside of the endpoint. You can't use spaces in the name.

"},"TsIncludeDvbSubtitles":{"Type":2,"Flags":0,"Description":"

By default, MediaPackage excludes all digital video broadcasting (DVB) subtitles from the output. When selected, MediaPackage passes through DVB subtitles into the output.

"},"TsUseAudioRenditionGroup":{"Type":2,"Flags":0,"Description":"

When selected, 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.

"}}}},{"2":{"Name":"SpekeKeyProvider","Properties":{"DrmSystems":{"Type":45,"Flags":1,"Description":"

The DRM solution provider you're using to protect your content during distribution.

"},"EncryptionContractConfiguration":{"Type":30,"Flags":1},"ResourceId":{"Type":4,"Flags":1,"Description":"

The unique identifier for the content. The service sends this to the key server to identify the current endpoint. How unique you make this 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.

\n

The following example shows a resource ID: MovieNight20171126093045\n

"},"RoleArn":{"Type":4,"Flags":1,"Description":"

The 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.

\n

Valid format: arn:aws:iam::{accountID}:role/{name}. The following example shows a role ARN: arn:aws:iam::444455556666:role/SpekeAccess\n

"},"Url":{"Type":4,"Flags":1,"Description":"

The URL of the API Gateway proxy that you set up to talk to your key server. The API Gateway proxy must reside in the same AWS Region as MediaPackage and must start with https://.

\n

The following example shows a URL: https://1wm2dx1f33.execute-api.us-west-2.amazonaws.com/SpekeSample/copyProtection\n

"}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":0},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"TsEncryptionMethod"}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.MediaPackageV2/OriginEndpointProperties","Properties":{"Arn":{"Type":4,"Flags":18,"Description":"

The Amazon Resource Name (ARN) associated with the resource.

"},"ChannelGroupName":{"Type":4,"Flags":0},"ChannelName":{"Type":4,"Flags":0},"ContainerType":{"Type":4,"Flags":1},"CreatedAt":{"Type":4,"Flags":2,"Description":"

The date and time the origin endpoint was created.

"},"Description":{"Type":4,"Flags":0,"Description":"

Enter any descriptive text that helps you to identify the origin endpoint.

"},"HlsManifests":{"Type":47,"Flags":2,"Description":"

An HTTP live streaming (HLS) manifest configuration.

"},"LowLatencyHlsManifests":{"Type":48,"Flags":2,"Description":"

A low-latency HLS manifest configuration.

"},"ModifiedAt":{"Type":4,"Flags":2,"Description":"

The date and time the origin endpoint was modified.

"},"OriginEndpointName":{"Type":4,"Flags":0},"Segment":{"Type":40,"Flags":0},"StartoverWindowSeconds":{"Type":3,"Flags":0,"Description":"

The size of the window (in seconds) to create 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. The maximum startover window is 1,209,600 seconds (14 days).

"},"Tags":{"Type":49,"Flags":0}}}},{"3":{"ItemType":33}},{"3":{"ItemType":34}},{"3":{"ItemType":42}},{"2":{"Name":"AWS.MediaPackageV2/OriginEndpoint","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":46,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.MediaPackageV2/OriginEndpoint@default","ScopeType":0,"Body":50}},{"2":{"Name":"AWS.MediaPackageV2/OriginEndpointPolicyProperties","Properties":{"ChannelGroupName":{"Type":4,"Flags":16},"ChannelName":{"Type":4,"Flags":16},"OriginEndpointName":{"Type":4,"Flags":16},"Policy":{"Type":54,"Flags":1}}}},{"2":{"Name":"OriginEndpointPolicy_Policy","Properties":{}}},{"5":{"Elements":[53,4]}},{"2":{"Name":"AWS.MediaPackageV2/OriginEndpointPolicy","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":52,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.MediaPackageV2/OriginEndpointPolicy@default","ScopeType":0,"Body":55}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "IngestEndpoint", + "properties": { + "Id": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "

The system-generated unique identifier for the IngestEndpoint.

" + }, + "Url": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "

The ingest domain URL where the source stream should be sent.

" + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.MediaPackageV2/ChannelProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "AWS.MediaPackageV2/ChannelProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "

The Amazon Resource Name (ARN) associated with the resource.

" + }, + "ChannelGroupName": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "ChannelName": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "CreatedAt": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "

The date and time the channel was created.

" + }, + "Description": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "

Enter any descriptive text that helps you to identify the channel.

" + }, + "IngestEndpointUrls": { + "type": { + "$ref": "#/4" + }, + "flags": 2 + }, + "IngestEndpoints": { + "type": { + "$ref": "#/5" + }, + "flags": 2, + "description": "

The list of ingest endpoints.

" + }, + "ModifiedAt": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "

The date and time the channel was modified.

" + }, + "Tags": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.MediaPackageV2/Channel", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/7" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.MediaPackageV2/Channel@default", + "scopeType": 0, + "body": { + "$ref": "#/8" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.MediaPackageV2/ChannelGroupProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/10" + } + }, + { + "$type": "ObjectType", + "name": "AWS.MediaPackageV2/ChannelGroupProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "

The Amazon Resource Name (ARN) associated with the resource.

" + }, + "ChannelGroupName": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "CreatedAt": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "

The date and time the channel group was created.

" + }, + "Description": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "

Enter any descriptive text that helps you to identify the channel group.

" + }, + "EgressDomain": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "

The output domain where the source stream should be sent. Integrate the domain with a downstream CDN (such as Amazon CloudFront) or playback device.

" + }, + "ModifiedAt": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "

The date and time the channel group was modified.

" + }, + "Tags": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.MediaPackageV2/ChannelGroup", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/13" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.MediaPackageV2/ChannelGroup@default", + "scopeType": 0, + "body": { + "$ref": "#/14" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.MediaPackageV2/ChannelPolicyProperties" + }, + { + "$type": "ObjectType", + "name": "ChannelPolicy_Policy", + "properties": {} + }, + { + "$type": "UnionType", + "elements": [ + { + "$ref": "#/17" + }, + { + "$ref": "#/2" + } + ] + }, + { + "$type": "ObjectType", + "name": "AWS.MediaPackageV2/ChannelPolicyProperties", + "properties": { + "ChannelGroupName": { + "type": { + "$ref": "#/2" + }, + "flags": 17 + }, + "ChannelName": { + "type": { + "$ref": "#/2" + }, + "flags": 17 + }, + "Policy": { + "type": { + "$ref": "#/18" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.MediaPackageV2/ChannelPolicy", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/19" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.MediaPackageV2/ChannelPolicy@default", + "scopeType": 0, + "body": { + "$ref": "#/20" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AdMarkerDash", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AdMarkerHls", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CmafEncryptionMethod", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ContainerType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DashDrmSignaling", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DashManifestConfiguration", + "properties": { + "DrmSignaling": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "FilterConfiguration": { + "type": { + "$ref": "#/36" + }, + "flags": 0 + }, + "ManifestName": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "

A 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.

" + }, + "ManifestWindowSeconds": { + "type": { + "$ref": "#/49" + }, + "flags": 0, + "description": "

The total duration (in seconds) of the manifest's content.

" + }, + "MinBufferTimeSeconds": { + "type": { + "$ref": "#/49" + }, + "flags": 0, + "description": "

Minimum amount of content (in seconds) that a player must keep available in the buffer.

" + }, + "MinUpdatePeriodSeconds": { + "type": { + "$ref": "#/49" + }, + "flags": 0, + "description": "

Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest.

" + }, + "PeriodTriggers": { + "type": { + "$ref": "#/50" + }, + "flags": 0, + "description": "

A list of triggers that controls when AWS Elemental MediaPackage separates the MPEG-DASH manifest into multiple periods. Leave this value empty to indicate that the manifest is contained all in one period.\n For more information about periods in the DASH manifest, see Multi-period DASH in AWS Elemental MediaPackage.

" + }, + "ScteDash": { + "type": { + "$ref": "#/42" + }, + "flags": 0 + }, + "SegmentTemplateFormat": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "SuggestedPresentationDelaySeconds": { + "type": { + "$ref": "#/49" + }, + "flags": 0, + "description": "

The amount of time (in seconds) that the player should be from the end of the manifest.

" + }, + "UtcTiming": { + "type": { + "$ref": "#/30" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DashPeriodTrigger", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DashSegmentTemplateFormat", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DashUtcTiming", + "properties": { + "TimingMode": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "TimingSource": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "

The the method that the player uses to synchronize to coordinated universal time (UTC) wall clock time.

" + } + } + }, + { + "$type": "ObjectType", + "name": "DashUtcTimingMode", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DrmSystem", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Encryption", + "properties": { + "ConstantInitializationVector": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "

A 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).

" + }, + "EncryptionMethod": { + "type": { + "$ref": "#/35" + }, + "flags": 1 + }, + "KeyRotationIntervalSeconds": { + "type": { + "$ref": "#/49" + }, + "flags": 0, + "description": "

The frequency (in seconds) of key changes for live workflows, in which content is streamed real time. The service retrieves content keys before the live content begins streaming, and then retrieves them as needed over the lifetime of the workflow. By default, key rotation is set to 300 seconds (5 minutes), the minimum rotation interval, which is equivalent to setting it to 300. If you don't enter an interval, content keys aren't rotated.

\n

The following example setting causes the service to rotate keys every thirty minutes: 1800\n

" + }, + "SpekeKeyProvider": { + "type": { + "$ref": "#/46" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "EncryptionContractConfiguration", + "properties": { + "PresetSpeke20Audio": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "PresetSpeke20Video": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "EncryptionMethod", + "properties": { + "CmafEncryptionMethod": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "TsEncryptionMethod": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FilterConfiguration", + "properties": { + "End": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "

Optionally 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.

" + }, + "ManifestFilter": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "

Optionally 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.

" + }, + "Start": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "

Optionally 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.

" + }, + "TimeDelaySeconds": { + "type": { + "$ref": "#/49" + }, + "flags": 0, + "description": "

Optionally 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.

" + } + } + }, + { + "$type": "ObjectType", + "name": "HlsManifestConfiguration", + "properties": { + "ChildManifestName": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "

A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default child manifest name, index_1. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

" + }, + "FilterConfiguration": { + "type": { + "$ref": "#/36" + }, + "flags": 0 + }, + "ManifestName": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "

A short 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.

" + }, + "ManifestWindowSeconds": { + "type": { + "$ref": "#/49" + }, + "flags": 0, + "description": "

The total duration (in seconds) of the manifest's content.

" + }, + "ProgramDateTimeIntervalSeconds": { + "type": { + "$ref": "#/49" + }, + "flags": 0, + "description": "

Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, \n EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. \n The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player. \n ID3Timed metadata messages generate every 5 seconds whenever the content is ingested.

\n

Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.

" + }, + "ScteHls": { + "type": { + "$ref": "#/44" + }, + "flags": 0 + }, + "Url": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "

The egress domain URL for stream delivery from MediaPackage.

" + } + } + }, + { + "$type": "ObjectType", + "name": "LowLatencyHlsManifestConfiguration", + "properties": { + "ChildManifestName": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "

A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default child manifest name, index_1. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

" + }, + "FilterConfiguration": { + "type": { + "$ref": "#/36" + }, + "flags": 0 + }, + "ManifestName": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "

A short 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.

" + }, + "ManifestWindowSeconds": { + "type": { + "$ref": "#/49" + }, + "flags": 0, + "description": "

The total duration (in seconds) of the manifest's content.

" + }, + "ProgramDateTimeIntervalSeconds": { + "type": { + "$ref": "#/49" + }, + "flags": 0, + "description": "

Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, \n EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. \n The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player. \n ID3Timed metadata messages generate every 5 seconds whenever the content is ingested.

\n

Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.

" + }, + "ScteHls": { + "type": { + "$ref": "#/44" + }, + "flags": 0 + }, + "Url": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "

The egress domain URL for stream delivery from MediaPackage.

" + } + } + }, + { + "$type": "ObjectType", + "name": "PresetSpeke20Audio", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PresetSpeke20Video", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Scte", + "properties": { + "ScteFilter": { + "type": { + "$ref": "#/51" + }, + "flags": 0, + "description": "

The SCTE-35 message types that you want to be treated as ad markers in the output.

" + } + } + }, + { + "$type": "ObjectType", + "name": "ScteDash", + "properties": { + "AdMarkerDash": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ScteFilter", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ScteHls", + "properties": { + "AdMarkerHls": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Segment", + "properties": { + "Encryption": { + "type": { + "$ref": "#/33" + }, + "flags": 0 + }, + "IncludeIframeOnlyStreams": { + "type": { + "$ref": "#/52" + }, + "flags": 0, + "description": "

When selected, the stream set includes an additional I-frame only stream, along with the other tracks. If false, this extra stream is not included. MediaPackage generates an I-frame only stream from the first rendition in the manifest. The service inserts EXT-I-FRAMES-ONLY tags in the output manifest, and then generates and includes an I-frames only playlist in the stream. This playlist permits player functionality like fast forward and rewind.

" + }, + "Scte": { + "type": { + "$ref": "#/41" + }, + "flags": 0 + }, + "SegmentDurationSeconds": { + "type": { + "$ref": "#/49" + }, + "flags": 0, + "description": "

The duration (in seconds) of each segment. Enter a value equal to, or a multiple of, the input segment duration. If the value that you enter is different from the input segment duration, MediaPackage rounds segments to the nearest multiple of the input segment duration.

" + }, + "SegmentName": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "

The name that describes the segment. The name is the base name of the segment used in all content manifests inside of the endpoint. You can't use spaces in the name.

" + }, + "TsIncludeDvbSubtitles": { + "type": { + "$ref": "#/52" + }, + "flags": 0, + "description": "

By default, MediaPackage excludes all digital video broadcasting (DVB) subtitles from the output. When selected, MediaPackage passes through DVB subtitles into the output.

" + }, + "TsUseAudioRenditionGroup": { + "type": { + "$ref": "#/52" + }, + "flags": 0, + "description": "

When selected, 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.

" + } + } + }, + { + "$type": "ObjectType", + "name": "SpekeKeyProvider", + "properties": { + "DrmSystems": { + "type": { + "$ref": "#/53" + }, + "flags": 1, + "description": "

The DRM solution provider you're using to protect your content during distribution.

" + }, + "EncryptionContractConfiguration": { + "type": { + "$ref": "#/34" + }, + "flags": 1 + }, + "ResourceId": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "

The unique identifier for the content. The service sends this to the key server to identify the current endpoint. How unique you make this 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.

\n

The following example shows a resource ID: MovieNight20171126093045\n

" + }, + "RoleArn": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "

The 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.

\n

Valid format: arn:aws:iam::{accountID}:role/{name}. The following example shows a role ARN: arn:aws:iam::444455556666:role/SpekeAccess\n

" + }, + "Url": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "

The URL of the API Gateway proxy that you set up to talk to your key server. The API Gateway proxy must reside in the same AWS Region as MediaPackage and must start with https://.

\n

The following example shows a URL: https://1wm2dx1f33.execute-api.us-west-2.amazonaws.com/SpekeSample/copyProtection\n

" + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TsEncryptionMethod", + "properties": {} + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.MediaPackageV2/OriginEndpointProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/27" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/37" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/38" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/47" + } + }, + { + "$type": "ObjectType", + "name": "AWS.MediaPackageV2/OriginEndpointProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "

The Amazon Resource Name (ARN) associated with the resource.

" + }, + "ChannelGroupName": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "ChannelName": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "ContainerType": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "CreatedAt": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "

The date and time the origin endpoint was created.

" + }, + "DashManifestUrls": { + "type": { + "$ref": "#/55" + }, + "flags": 2 + }, + "DashManifests": { + "type": { + "$ref": "#/56" + }, + "flags": 0, + "description": "

A DASH manifest configuration.

" + }, + "Description": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "

Enter any descriptive text that helps you to identify the origin endpoint.

" + }, + "HlsManifestUrls": { + "type": { + "$ref": "#/57" + }, + "flags": 2 + }, + "HlsManifests": { + "type": { + "$ref": "#/58" + }, + "flags": 2, + "description": "

An HTTP live streaming (HLS) manifest configuration.

" + }, + "LowLatencyHlsManifestUrls": { + "type": { + "$ref": "#/59" + }, + "flags": 2 + }, + "LowLatencyHlsManifests": { + "type": { + "$ref": "#/60" + }, + "flags": 2, + "description": "

A low-latency HLS manifest configuration.

" + }, + "ModifiedAt": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "

The date and time the origin endpoint was modified.

" + }, + "OriginEndpointName": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Segment": { + "type": { + "$ref": "#/45" + }, + "flags": 0 + }, + "StartoverWindowSeconds": { + "type": { + "$ref": "#/49" + }, + "flags": 0, + "description": "

The size of the window (in seconds) to create 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. The maximum startover window is 1,209,600 seconds (14 days).

" + }, + "Tags": { + "type": { + "$ref": "#/61" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.MediaPackageV2/OriginEndpoint", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/62" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.MediaPackageV2/OriginEndpoint@default", + "scopeType": 0, + "body": { + "$ref": "#/63" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.MediaPackageV2/OriginEndpointPolicyProperties" + }, + { + "$type": "ObjectType", + "name": "OriginEndpointPolicy_Policy", + "properties": {} + }, + { + "$type": "UnionType", + "elements": [ + { + "$ref": "#/66" + }, + { + "$ref": "#/2" + } + ] + }, + { + "$type": "ObjectType", + "name": "AWS.MediaPackageV2/OriginEndpointPolicyProperties", + "properties": { + "ChannelGroupName": { + "type": { + "$ref": "#/2" + }, + "flags": 17 + }, + "ChannelName": { + "type": { + "$ref": "#/2" + }, + "flags": 17 + }, + "OriginEndpointName": { + "type": { + "$ref": "#/2" + }, + "flags": 17 + }, + "Policy": { + "type": { + "$ref": "#/67" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.MediaPackageV2/OriginEndpointPolicy", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/68" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.MediaPackageV2/OriginEndpointPolicy@default", + "scopeType": 0, + "body": { + "$ref": "#/69" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.mediapackagev2/default/types.md b/artifacts/bicep/aws/aws.mediapackagev2/default/types.md index a0322950..97c96e1d 100644 --- a/artifacts/bicep/aws/aws.mediapackagev2/default/types.md +++ b/artifacts/bicep/aws/aws.mediapackagev2/default/types.md @@ -3,96 +3,139 @@ ## Resource AWS.MediaPackageV2/Channel@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.MediaPackageV2/ChannelProperties](#awsmediapackagev2channelproperties): properties of the resource +* **properties**: [AWS.MediaPackageV2/ChannelProperties](#awsmediapackagev2channelproperties) (Required, Identifier): properties of the resource ## Resource AWS.MediaPackageV2/ChannelGroup@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.MediaPackageV2/ChannelGroupProperties](#awsmediapackagev2channelgroupproperties): properties of the resource +* **properties**: [AWS.MediaPackageV2/ChannelGroupProperties](#awsmediapackagev2channelgroupproperties) (Required, Identifier): properties of the resource ## Resource AWS.MediaPackageV2/ChannelPolicy@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.MediaPackageV2/ChannelPolicyProperties](#awsmediapackagev2channelpolicyproperties) (Required): properties of the resource +* **properties**: [AWS.MediaPackageV2/ChannelPolicyProperties](#awsmediapackagev2channelpolicyproperties) (Required, Identifier): properties of the resource ## Resource AWS.MediaPackageV2/OriginEndpoint@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.MediaPackageV2/OriginEndpointProperties](#awsmediapackagev2originendpointproperties) (Required): properties of the resource +* **properties**: [AWS.MediaPackageV2/OriginEndpointProperties](#awsmediapackagev2originendpointproperties) (Required, Identifier): properties of the resource ## Resource AWS.MediaPackageV2/OriginEndpointPolicy@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.MediaPackageV2/OriginEndpointPolicyProperties](#awsmediapackagev2originendpointpolicyproperties) (Required): properties of the resource +* **properties**: [AWS.MediaPackageV2/OriginEndpointPolicyProperties](#awsmediapackagev2originendpointpolicyproperties) (Required, Identifier): properties of the resource -## AWS.MediaPackageV2/ChannelProperties +## AWS.MediaPackageV2/ChannelGroupProperties ### Properties -* **Arn**: string (ReadOnly, Identifier) -* **ChannelGroupName**: string -* **ChannelName**: string -* **CreatedAt**: string (ReadOnly) -* **Description**: string -* **IngestEndpoints**: [IngestEndpoint](#ingestendpoint)[] (ReadOnly) -* **ModifiedAt**: string (ReadOnly) +* **Arn**: string (ReadOnly, Identifier):

The Amazon Resource Name (ARN) associated with the resource.

+* **ChannelGroupName**: string (Required) +* **CreatedAt**: string (ReadOnly):

The date and time the channel group was created.

+* **Description**: string:

Enter any descriptive text that helps you to identify the channel group.

+* **EgressDomain**: string (ReadOnly):

The output domain where the source stream should be sent. Integrate the domain with a downstream CDN (such as Amazon CloudFront) or playback device.

+* **ModifiedAt**: string (ReadOnly):

The date and time the channel group was modified.

* **Tags**: [Tag](#tag)[] -## IngestEndpoint -### Properties -* **Id**: string -* **Url**: string - -## Tag +## AWS.MediaPackageV2/ChannelPolicyProperties ### Properties -* **Key**: string -* **Value**: string +* **ChannelGroupName**: string (Required, Identifier) +* **ChannelName**: string (Required, Identifier) +* **Policy**: [ChannelPolicy_Policy](#channelpolicypolicy) | string (Required) -## AWS.MediaPackageV2/ChannelGroupProperties +## AWS.MediaPackageV2/ChannelProperties ### Properties -* **Arn**: string (ReadOnly, Identifier) -* **ChannelGroupName**: string -* **CreatedAt**: string (ReadOnly) -* **Description**: string -* **EgressDomain**: string (ReadOnly) -* **ModifiedAt**: string (ReadOnly) +* **Arn**: string (ReadOnly, Identifier):

The Amazon Resource Name (ARN) associated with the resource.

+* **ChannelGroupName**: string (Required) +* **ChannelName**: string (Required) +* **CreatedAt**: string (ReadOnly):

The date and time the channel was created.

+* **Description**: string:

Enter any descriptive text that helps you to identify the channel.

+* **IngestEndpoints**: [IngestEndpoint](#ingestendpoint)[] (ReadOnly):

The list of ingest endpoints.

+* **IngestEndpointUrls**: string[] (ReadOnly) +* **ModifiedAt**: string (ReadOnly):

The date and time the channel was modified.

* **Tags**: [Tag](#tag)[] -## Tag -### Properties -* **Key**: string -* **Value**: string - -## AWS.MediaPackageV2/ChannelPolicyProperties +## AWS.MediaPackageV2/OriginEndpointPolicyProperties ### Properties -* **ChannelGroupName**: string (Identifier) -* **ChannelName**: string (Identifier) -* **Policy**: [ChannelPolicy_Policy](#channelpolicypolicy) | string (Required) +* **ChannelGroupName**: string (Required, Identifier) +* **ChannelName**: string (Required, Identifier) +* **OriginEndpointName**: string (Required, Identifier) +* **Policy**: [OriginEndpointPolicy_Policy](#originendpointpolicypolicy) | string (Required) ## AWS.MediaPackageV2/OriginEndpointProperties ### Properties * **Arn**: string (ReadOnly, Identifier):

The Amazon Resource Name (ARN) associated with the resource.

-* **ChannelGroupName**: string -* **ChannelName**: string -* **ContainerType**: string (Required) +* **ChannelGroupName**: string (Required) +* **ChannelName**: string (Required) +* **ContainerType**: string * **CreatedAt**: string (ReadOnly):

The date and time the origin endpoint was created.

+* **DashManifests**: [DashManifestConfiguration](#dashmanifestconfiguration)[]:

A DASH manifest configuration.

+* **DashManifestUrls**: string[] (ReadOnly) * **Description**: string:

Enter any descriptive text that helps you to identify the origin endpoint.

* **HlsManifests**: [HlsManifestConfiguration](#hlsmanifestconfiguration)[] (ReadOnly):

An HTTP live streaming (HLS) manifest configuration.

+* **HlsManifestUrls**: string[] (ReadOnly) * **LowLatencyHlsManifests**: [LowLatencyHlsManifestConfiguration](#lowlatencyhlsmanifestconfiguration)[] (ReadOnly):

A low-latency HLS manifest configuration.

+* **LowLatencyHlsManifestUrls**: string[] (ReadOnly) * **ModifiedAt**: string (ReadOnly):

The date and time the origin endpoint was modified.

-* **OriginEndpointName**: string +* **OriginEndpointName**: string (Required) * **Segment**: [Segment](#segment) * **StartoverWindowSeconds**: int:

The size of the window (in seconds) to create 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. The maximum startover window is 1,209,600 seconds (14 days).

* **Tags**: [Tag](#tag)[] +## DashManifestConfiguration +### Properties +* **DrmSignaling**: string +* **FilterConfiguration**: [FilterConfiguration](#filterconfiguration) +* **ManifestName**: string (Required):

A 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.

+* **ManifestWindowSeconds**: int:

The total duration (in seconds) of the manifest's content.

+* **MinBufferTimeSeconds**: int:

Minimum amount of content (in seconds) that a player must keep available in the buffer.

+* **MinUpdatePeriodSeconds**: int:

Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest.

+* **PeriodTriggers**: string[]:

A list of triggers that controls when AWS Elemental MediaPackage separates the MPEG-DASH manifest into multiple periods. Leave this value empty to indicate that the manifest is contained all in one period. + For more information about periods in the DASH manifest, see Multi-period DASH in AWS Elemental MediaPackage.

+* **ScteDash**: [ScteDash](#sctedash) +* **SegmentTemplateFormat**: string +* **SuggestedPresentationDelaySeconds**: int:

The amount of time (in seconds) that the player should be from the end of the manifest.

+* **UtcTiming**: [DashUtcTiming](#dashutctiming) + +## DashUtcTiming +### Properties +* **TimingMode**: string +* **TimingSource**: string:

The the method that the player uses to synchronize to coordinated universal time (UTC) wall clock time.

+ +## Encryption +### Properties +* **ConstantInitializationVector**: string:

A 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).

+* **EncryptionMethod**: [EncryptionMethod](#encryptionmethod) (Required) +* **KeyRotationIntervalSeconds**: int:

The frequency (in seconds) of key changes for live workflows, in which content is streamed real time. The service retrieves content keys before the live content begins streaming, and then retrieves them as needed over the lifetime of the workflow. By default, key rotation is set to 300 seconds (5 minutes), the minimum rotation interval, which is equivalent to setting it to 300. If you don't enter an interval, content keys aren't rotated.

+

The following example setting causes the service to rotate keys every thirty minutes: 1800 +

+* **SpekeKeyProvider**: [SpekeKeyProvider](#spekekeyprovider) (Required) + +## EncryptionContractConfiguration +### Properties +* **PresetSpeke20Audio**: string (Required) +* **PresetSpeke20Video**: string (Required) + +## EncryptionMethod +### Properties +* **CmafEncryptionMethod**: string +* **TsEncryptionMethod**: string + +## FilterConfiguration +### Properties +* **End**: string:

Optionally 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.

+* **ManifestFilter**: string:

Optionally 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.

+* **Start**: string:

Optionally 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.

+* **TimeDelaySeconds**: int:

Optionally 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.

+ ## HlsManifestConfiguration ### Properties * **ChildManifestName**: string:

A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default child manifest name, index_1. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

@@ -107,16 +150,10 @@ * **ScteHls**: [ScteHls](#sctehls) * **Url**: string:

The egress domain URL for stream delivery from MediaPackage.

-## FilterConfiguration -### Properties -* **End**: string:

Optionally 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.

-* **ManifestFilter**: string:

Optionally 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.

-* **Start**: string:

Optionally 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.

-* **TimeDelaySeconds**: int:

Optionally 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.

- -## ScteHls +## IngestEndpoint ### Properties -* **AdMarkerHls**: string +* **Id**: string:

The system-generated unique identifier for the IngestEndpoint.

+* **Url**: string:

The ingest domain URL where the source stream should be sent.

## LowLatencyHlsManifestConfiguration ### Properties @@ -132,6 +169,18 @@ * **ScteHls**: [ScteHls](#sctehls) * **Url**: string:

The egress domain URL for stream delivery from MediaPackage.

+## Scte +### Properties +* **ScteFilter**: string[]:

The SCTE-35 message types that you want to be treated as ad markers in the output.

+ +## ScteDash +### Properties +* **AdMarkerDash**: string + +## ScteHls +### Properties +* **AdMarkerHls**: string + ## Segment ### Properties * **Encryption**: [Encryption](#encryption) @@ -142,20 +191,6 @@ * **TsIncludeDvbSubtitles**: bool:

By default, MediaPackage excludes all digital video broadcasting (DVB) subtitles from the output. When selected, MediaPackage passes through DVB subtitles into the output.

* **TsUseAudioRenditionGroup**: bool:

When selected, 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.

-## Encryption -### Properties -* **ConstantInitializationVector**: string:

A 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).

-* **EncryptionMethod**: [EncryptionMethod](#encryptionmethod) (Required) -* **KeyRotationIntervalSeconds**: int:

The frequency (in seconds) of key changes for live workflows, in which content is streamed real time. The service retrieves content keys before the live content begins streaming, and then retrieves them as needed over the lifetime of the workflow. By default, key rotation is set to 300 seconds (5 minutes), the minimum rotation interval, which is equivalent to setting it to 300. If you don't enter an interval, content keys aren't rotated.

-

The following example setting causes the service to rotate keys every thirty minutes: 1800 -

-* **SpekeKeyProvider**: [SpekeKeyProvider](#spekekeyprovider) (Required) - -## EncryptionMethod -### Properties -* **CmafEncryptionMethod**: string -* **TsEncryptionMethod**: string - ## SpekeKeyProvider ### Properties * **DrmSystems**: string[] (Required):

The DRM solution provider you're using to protect your content during distribution.

@@ -170,24 +205,18 @@

The following example shows a URL: https://1wm2dx1f33.execute-api.us-west-2.amazonaws.com/SpekeSample/copyProtection

-## EncryptionContractConfiguration -### Properties -* **PresetSpeke20Audio**: string (Required) -* **PresetSpeke20Video**: string (Required) - -## Scte +## Tag ### Properties -* **ScteFilter**: string[]:

The SCTE-35 message types that you want to be treated as ad markers in the output.

+* **Key**: string +* **Value**: string ## Tag ### Properties * **Key**: string * **Value**: string -## AWS.MediaPackageV2/OriginEndpointPolicyProperties +## Tag ### Properties -* **ChannelGroupName**: string (Identifier) -* **ChannelName**: string (Identifier) -* **OriginEndpointName**: string (Identifier) -* **Policy**: [OriginEndpointPolicy_Policy](#originendpointpolicypolicy) | string (Required) +* **Key**: string +* **Value**: string diff --git a/artifacts/bicep/aws/aws.mediatailor/default/types.json b/artifacts/bicep/aws/aws.mediatailor/default/types.json index 17f55579..dc121f6a 100644 --- a/artifacts/bicep/aws/aws.mediatailor/default/types.json +++ b/artifacts/bicep/aws/aws.mediatailor/default/types.json @@ -1 +1,1247 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"AdMarkupType"}},{"2":{"Name":"DashPlaylistSettings","Properties":{"ManifestWindowSeconds":{"Type":3,"Flags":0,"Description":"

The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.

"},"MinBufferTimeSeconds":{"Type":3,"Flags":0,"Description":"

Minimum amount of content (measured in seconds) that a player must keep available in the buffer. Minimum value: 2 seconds. Maximum value: 60 seconds.

"},"MinUpdatePeriodSeconds":{"Type":3,"Flags":0,"Description":"

Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.

"},"SuggestedPresentationDelaySeconds":{"Type":3,"Flags":0,"Description":"

Amount 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.

"}}}},{"2":{"Name":"HlsPlaylistSettings","Properties":{"AdMarkupType":{"Type":19,"Flags":0,"Description":"

Determines 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).

"},"ManifestWindowSeconds":{"Type":3,"Flags":0,"Description":"

The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.

"}}}},{"2":{"Name":"LogConfigurationForChannel","Properties":{"LogTypes":{"Type":20,"Flags":0,"Description":"

The log types.

"}}}},{"2":{"Name":"LogType"}},{"2":{"Name":"PlaybackMode"}},{"2":{"Name":"RequestOutputItem","Properties":{"DashPlaylistSettings":{"Type":9,"Flags":0},"HlsPlaylistSettings":{"Type":10,"Flags":0},"ManifestName":{"Type":4,"Flags":1,"Description":"

The name of the manifest for the channel. The name appears in the PlaybackUrl.

"},"SourceGroup":{"Type":4,"Flags":1,"Description":"

A string used to match which HttpPackageConfiguration is used for each VodSource.

"}}}},{"2":{"Name":"SlateSource","Properties":{"SourceLocationName":{"Type":4,"Flags":0,"Description":"

The name of the source location where the slate VOD source is stored.

"},"VodSourceName":{"Type":4,"Flags":0,"Description":"

The slate VOD source name. The VOD source must already exist in a source location before it can be used for slate.

"}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"Tier"}},{"2":{"Name":"TimeShiftConfiguration","Properties":{"MaxTimeDelaySeconds":{"Type":3,"Flags":1,"Description":"

The maximum time delay for time-shifted viewing. The minimum allowed maximum time delay is 0 seconds, and the maximum allowed maximum time delay is 21600 seconds (6 hours).

"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.MediaTailor/ChannelProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"

The ARN of the channel.

"},"ChannelName":{"Type":4,"Flags":17},"FillerSlate":{"Type":15,"Flags":0},"LogConfiguration":{"Type":11,"Flags":0},"Outputs":{"Type":22,"Flags":5,"Description":"

The channel's output properties.

"},"PlaybackMode":{"Type":4,"Flags":1},"Tags":{"Type":23,"Flags":0,"Description":"The tags to assign to the channel."},"Tier":{"Type":4,"Flags":0},"TimeShiftConfiguration":{"Type":18,"Flags":0}}}},{"3":{"ItemType":14}},{"3":{"ItemType":16}},{"2":{"Name":"AWS.MediaTailor/Channel","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":21,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.MediaTailor/Channel@default","ScopeType":0,"Body":24}},{"2":{"Name":"AWS.MediaTailor/ChannelPolicyProperties","Properties":{"ChannelName":{"Type":4,"Flags":17},"Policy":{"Type":28,"Flags":1,"Description":"

The IAM policy for the channel. IAM policies are used to control access to your channel.

"}}}},{"2":{"Name":"ChannelPolicy_Policy","Properties":{}}},{"5":{"Elements":[27,4]}},{"2":{"Name":"AWS.MediaTailor/ChannelPolicy","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":26,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.MediaTailor/ChannelPolicy@default","ScopeType":0,"Body":29}},{"2":{"Name":"HttpPackageConfiguration","Properties":{"Path":{"Type":4,"Flags":1,"Description":"

The relative path to the URL for this VOD source. This is combined with SourceLocation::HttpConfiguration::BaseUrl to form a valid URL.

"},"SourceGroup":{"Type":4,"Flags":1,"Description":"

The name of the source group. This has to match one of the Channel::Outputs::SourceGroup.

"},"Type":{"Type":4,"Flags":1}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"Type"}},{"2":{"Name":"AWS.MediaTailor/LiveSourceProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"

The ARN of the live source.

"},"HttpPackageConfigurations":{"Type":35,"Flags":1,"Description":"

A list of HTTP package configuration parameters for this live source.

"},"LiveSourceName":{"Type":4,"Flags":17},"SourceLocationName":{"Type":4,"Flags":17},"Tags":{"Type":36,"Flags":0,"Description":"The tags to assign to the live source."}}}},{"3":{"ItemType":31}},{"3":{"ItemType":32}},{"2":{"Name":"AWS.MediaTailor/LiveSource","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":34,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.MediaTailor/LiveSource@default","ScopeType":0,"Body":37}},{"2":{"Name":"AdMarkerPassthrough","Properties":{"Enabled":{"Type":2,"Flags":0,"Description":"Enables ad marker passthrough for your configuration."}}}},{"2":{"Name":"AvailSuppression","Properties":{"Mode":{"Type":4,"Flags":0,"Description":"Sets the ad suppression mode. By default, ad suppression is set to 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."},"Value":{"Type":4,"Flags":0,"Description":"A 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."}}}},{"2":{"Name":"Bumper","Properties":{"EndUrl":{"Type":4,"Flags":0,"Description":"The URL for the end bumper asset."},"StartUrl":{"Type":4,"Flags":0,"Description":"The URL for the start bumper asset."}}}},{"2":{"Name":"CdnConfiguration","Properties":{"AdSegmentUrlPrefix":{"Type":4,"Flags":0,"Description":"A 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.<region>.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."},"ContentSegmentUrlPrefix":{"Type":4,"Flags":0,"Description":"A content delivery network (CDN) to cache content segments, so that content requests don't 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."}}}},{"2":{"Name":"ConfigurationAliases","Properties":{}}},{"2":{"Name":"DashConfiguration","Properties":{"ManifestEndpointPrefix":{"Type":4,"Flags":2,"Description":"The URL generated by MediaTailor to initiate a DASH playback session. The session uses server-side reporting."},"MpdLocation":{"Type":4,"Flags":0,"Description":"The setting that controls whether MediaTailor includes the Location tag in DASH manifests. MediaTailor populates the Location tag with the URL for manifest update requests, to be used by players that don't support sticky redirects. Disable this if you have CDN routing rules set up for accessing MediaTailor manifests, and you are either using client-side reporting or your players support sticky HTTP redirects. Valid values are DISABLED and EMT_DEFAULT. The EMT_DEFAULT setting enables the inclusion of the tag and is the default value."},"OriginManifestType":{"Type":4,"Flags":0,"Description":"The setting that controls whether MediaTailor handles manifests from the origin server as multi-period manifests or single-period manifests. If your origin server produces single-period manifests, set this to SINGLE_PERIOD. The default setting is MULTI_PERIOD. For multi-period manifests, omit this setting or set it to MULTI_PERIOD."}}}},{"2":{"Name":"HlsConfiguration","Properties":{"ManifestEndpointPrefix":{"Type":4,"Flags":2,"Description":"The URL that is used to initiate a playback session for devices that support Apple HLS. The session uses server-side reporting."}}}},{"2":{"Name":"LivePreRollConfiguration","Properties":{"AdDecisionServerUrl":{"Type":4,"Flags":0,"Description":"The 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."},"MaxDurationSeconds":{"Type":3,"Flags":0,"Description":"The 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."}}}},{"2":{"Name":"ManifestProcessingRules","Properties":{"AdMarkerPassthrough":{"Type":39,"Flags":0,"Description":"For 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. No 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."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.MediaTailor/PlaybackConfigurationProperties","Properties":{"AdDecisionServerUrl":{"Type":4,"Flags":1,"Description":"The 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."},"AvailSuppression":{"Type":40,"Flags":0,"Description":"The 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)."},"Bumper":{"Type":41,"Flags":0,"Description":"The 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)."},"CdnConfiguration":{"Type":42,"Flags":0,"Description":"The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management."},"ConfigurationAliases":{"Type":43,"Flags":0,"Description":"The player parameters and aliases used as dynamic variables during session initialization. For more information, see Domain Variables. "},"DashConfiguration":{"Type":44,"Flags":0,"Description":"The configuration for DASH content."},"HlsConfiguration":{"Type":45,"Flags":0,"Description":"The configuration for HLS content."},"LivePreRollConfiguration":{"Type":46,"Flags":0,"Description":"The configuration for pre-roll ad insertion."},"ManifestProcessingRules":{"Type":47,"Flags":0,"Description":"The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor."},"Name":{"Type":4,"Flags":17,"Description":"The identifier for the playback configuration."},"PersonalizationThresholdSeconds":{"Type":3,"Flags":0,"Description":"Defines 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)."},"PlaybackConfigurationArn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) for the playback configuration."},"PlaybackEndpointPrefix":{"Type":4,"Flags":2,"Description":"The URL that the player accesses to get a manifest from MediaTailor. This session will use server-side reporting."},"SessionInitializationEndpointPrefix":{"Type":4,"Flags":2,"Description":"The URL that the player uses to initialize a session that uses client-side reporting."},"SlateAdUrl":{"Type":4,"Flags":0,"Description":"The URL for a high-quality 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 configurations. For VPAID, the slate is required because MediaTailor provides it in the slots that are designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video."},"Tags":{"Type":50,"Flags":0,"Description":"The tags to assign to the playback configuration."},"TranscodeProfileName":{"Type":4,"Flags":0,"Description":"The 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."},"VideoContentSourceUrl":{"Type":4,"Flags":1,"Description":"The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters."}}}},{"3":{"ItemType":48}},{"2":{"Name":"AWS.MediaTailor/PlaybackConfiguration","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":49,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.MediaTailor/PlaybackConfiguration@default","ScopeType":0,"Body":51}},{"2":{"Name":"AccessConfiguration","Properties":{"AccessType":{"Type":4,"Flags":0},"SecretsManagerAccessTokenConfiguration":{"Type":57,"Flags":0}}}},{"2":{"Name":"AccessType"}},{"2":{"Name":"DefaultSegmentDeliveryConfiguration","Properties":{"BaseUrl":{"Type":4,"Flags":0,"Description":"

The hostname of the server that will be used to serve segments. This string must include the protocol, such as https://.

"}}}},{"2":{"Name":"HttpConfiguration","Properties":{"BaseUrl":{"Type":4,"Flags":1,"Description":"

The base URL for the source location host server. This string must include the protocol, such as https://.

"}}}},{"2":{"Name":"SecretsManagerAccessTokenConfiguration","Properties":{"HeaderName":{"Type":4,"Flags":0,"Description":"

The name of the HTTP header used to supply the access token in requests to the source location.

"},"SecretArn":{"Type":4,"Flags":0,"Description":"

The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the access token.

"},"SecretStringKey":{"Type":4,"Flags":0,"Description":"

The AWS Secrets Manager SecretString key associated with the access token. MediaTailor uses the key to look up SecretString key and value pair containing the access token.

"}}}},{"2":{"Name":"SegmentDeliveryConfiguration","Properties":{"BaseUrl":{"Type":4,"Flags":0,"Description":"

The 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*.

"},"Name":{"Type":4,"Flags":0,"Description":"

A unique identifier used to distinguish between multiple segment delivery configurations in a source location.

"}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.MediaTailor/SourceLocationProperties","Properties":{"AccessConfiguration":{"Type":53,"Flags":0},"Arn":{"Type":4,"Flags":2,"Description":"

The ARN of the source location.

"},"DefaultSegmentDeliveryConfiguration":{"Type":55,"Flags":0},"HttpConfiguration":{"Type":56,"Flags":1},"SegmentDeliveryConfigurations":{"Type":61,"Flags":0,"Description":"

A list of the segment delivery configurations associated with this resource.

"},"SourceLocationName":{"Type":4,"Flags":17},"Tags":{"Type":62,"Flags":0,"Description":"The tags to assign to the source location."}}}},{"3":{"ItemType":58}},{"3":{"ItemType":59}},{"2":{"Name":"AWS.MediaTailor/SourceLocation","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":60,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.MediaTailor/SourceLocation@default","ScopeType":0,"Body":63}},{"2":{"Name":"HttpPackageConfiguration","Properties":{"Path":{"Type":4,"Flags":1,"Description":"

The relative path to the URL for this VOD source. This is combined with SourceLocation::HttpConfiguration::BaseUrl to form a valid URL.

"},"SourceGroup":{"Type":4,"Flags":1,"Description":"

The name of the source group. This has to match one of the Channel::Outputs::SourceGroup.

"},"Type":{"Type":4,"Flags":1}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"Type"}},{"2":{"Name":"AWS.MediaTailor/VodSourceProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"

The ARN of the VOD source.

"},"HttpPackageConfigurations":{"Type":69,"Flags":1,"Description":"

A list of HTTP package configuration parameters for this VOD source.

"},"SourceLocationName":{"Type":4,"Flags":17},"Tags":{"Type":70,"Flags":0,"Description":"The tags to assign to the VOD source."},"VodSourceName":{"Type":4,"Flags":17}}}},{"3":{"ItemType":65}},{"3":{"ItemType":66}},{"2":{"Name":"AWS.MediaTailor/VodSource","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":68,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.MediaTailor/VodSource@default","ScopeType":0,"Body":71}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "AdMarkupType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DashPlaylistSettings", + "properties": { + "ManifestWindowSeconds": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "

The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.

" + }, + "MinBufferTimeSeconds": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "

Minimum amount of content (measured in seconds) that a player must keep available in the buffer. Minimum value: 2 seconds. Maximum value: 60 seconds.

" + }, + "MinUpdatePeriodSeconds": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "

Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.

" + }, + "SuggestedPresentationDelaySeconds": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "

Amount 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.

" + } + } + }, + { + "$type": "ObjectType", + "name": "HlsPlaylistSettings", + "properties": { + "AdMarkupType": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "

Determines 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).

" + }, + "ManifestWindowSeconds": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "

The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.

" + } + } + }, + { + "$type": "ObjectType", + "name": "LogConfigurationForChannel", + "properties": { + "LogTypes": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "

The log types.

" + } + } + }, + { + "$type": "ObjectType", + "name": "LogType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PlaybackMode", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RequestOutputItem", + "properties": { + "DashPlaylistSettings": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "HlsPlaylistSettings": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "ManifestName": { + "type": { + "$ref": "#/11" + }, + "flags": 1, + "description": "

The name of the manifest for the channel. The name appears in the PlaybackUrl.

" + }, + "SourceGroup": { + "type": { + "$ref": "#/11" + }, + "flags": 1, + "description": "

A string used to match which HttpPackageConfiguration is used for each VodSource.

" + } + } + }, + { + "$type": "ObjectType", + "name": "SlateSource", + "properties": { + "SourceLocationName": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "

The name of the source location where the slate VOD source is stored.

" + }, + "VodSourceName": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "

The slate VOD source name. The VOD source must already exist in a source location before it can be used for slate.

" + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/11" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/11" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Tier", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TimeShiftConfiguration", + "properties": { + "MaxTimeDelaySeconds": { + "type": { + "$ref": "#/12" + }, + "flags": 1, + "description": "

The maximum time delay for time-shifted viewing. The minimum allowed maximum time delay is 0 seconds, and the maximum allowed maximum time delay is 21600 seconds (6 hours).

" + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/11" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/11" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.MediaTailor/ChannelProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/11" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/8" + } + }, + { + "$type": "ObjectType", + "name": "AWS.MediaTailor/ChannelProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/11" + }, + "flags": 2, + "description": "

The ARN of the channel.

" + }, + "Audiences": { + "type": { + "$ref": "#/16" + }, + "flags": 0, + "description": "

The list of audiences defined in channel.

" + }, + "ChannelName": { + "type": { + "$ref": "#/11" + }, + "flags": 17 + }, + "FillerSlate": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "LogConfiguration": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "Outputs": { + "type": { + "$ref": "#/17" + }, + "flags": 5, + "description": "

The channel's output properties.

" + }, + "PlaybackMode": { + "type": { + "$ref": "#/11" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "The tags to assign to the channel." + }, + "Tier": { + "type": { + "$ref": "#/11" + }, + "flags": 0 + }, + "TimeShiftConfiguration": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.MediaTailor/Channel", + "properties": { + "name": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/11" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/19" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.MediaTailor/Channel@default", + "scopeType": 0, + "body": { + "$ref": "#/20" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.MediaTailor/ChannelPolicyProperties" + }, + { + "$type": "ObjectType", + "name": "ChannelPolicy_Policy", + "properties": {} + }, + { + "$type": "UnionType", + "elements": [ + { + "$ref": "#/23" + }, + { + "$ref": "#/11" + } + ] + }, + { + "$type": "ObjectType", + "name": "AWS.MediaTailor/ChannelPolicyProperties", + "properties": { + "ChannelName": { + "type": { + "$ref": "#/11" + }, + "flags": 17 + }, + "Policy": { + "type": { + "$ref": "#/24" + }, + "flags": 1, + "description": "

The IAM policy for the channel. IAM policies are used to control access to your channel.

" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.MediaTailor/ChannelPolicy", + "properties": { + "name": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/11" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/25" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.MediaTailor/ChannelPolicy@default", + "scopeType": 0, + "body": { + "$ref": "#/26" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "HttpPackageConfiguration", + "properties": { + "Path": { + "type": { + "$ref": "#/11" + }, + "flags": 1, + "description": "

The relative path to the URL for this VOD source. This is combined with SourceLocation::HttpConfiguration::BaseUrl to form a valid URL.

" + }, + "SourceGroup": { + "type": { + "$ref": "#/11" + }, + "flags": 1, + "description": "

The name of the source group. This has to match one of the Channel::Outputs::SourceGroup.

" + }, + "Type": { + "type": { + "$ref": "#/11" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/11" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/11" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Type", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.MediaTailor/LiveSourceProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/28" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/29" + } + }, + { + "$type": "ObjectType", + "name": "AWS.MediaTailor/LiveSourceProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/11" + }, + "flags": 2, + "description": "

The ARN of the live source.

" + }, + "HttpPackageConfigurations": { + "type": { + "$ref": "#/32" + }, + "flags": 1, + "description": "

A list of HTTP package configuration parameters for this live source.

" + }, + "LiveSourceName": { + "type": { + "$ref": "#/11" + }, + "flags": 17 + }, + "SourceLocationName": { + "type": { + "$ref": "#/11" + }, + "flags": 17 + }, + "Tags": { + "type": { + "$ref": "#/33" + }, + "flags": 0, + "description": "The tags to assign to the live source." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.MediaTailor/LiveSource", + "properties": { + "name": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/11" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/34" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.MediaTailor/LiveSource@default", + "scopeType": 0, + "body": { + "$ref": "#/35" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AdMarkerPassthrough", + "properties": { + "Enabled": { + "type": { + "$ref": "#/47" + }, + "flags": 0, + "description": "Enables ad marker passthrough for your configuration." + } + } + }, + { + "$type": "ObjectType", + "name": "AvailSuppression", + "properties": { + "FillPolicy": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "Defines 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. Valid values are FULL_AVAIL_ONLY and PARTIAL_AVAIL" + }, + "Mode": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "Sets 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." + }, + "Value": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "A 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." + } + } + }, + { + "$type": "ObjectType", + "name": "Bumper", + "properties": { + "EndUrl": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The URL for the end bumper asset." + }, + "StartUrl": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The URL for the start bumper asset." + } + } + }, + { + "$type": "ObjectType", + "name": "CdnConfiguration", + "properties": { + "AdSegmentUrlPrefix": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "A 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.<region>.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." + }, + "ContentSegmentUrlPrefix": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "A content delivery network (CDN) to cache content segments, so that content requests don't 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." + } + } + }, + { + "$type": "ObjectType", + "name": "ConfigurationAliases", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DashConfiguration", + "properties": { + "ManifestEndpointPrefix": { + "type": { + "$ref": "#/11" + }, + "flags": 2, + "description": "The URL generated by MediaTailor to initiate a DASH playback session. The session uses server-side reporting." + }, + "MpdLocation": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The setting that controls whether MediaTailor includes the Location tag in DASH manifests. MediaTailor populates the Location tag with the URL for manifest update requests, to be used by players that don't support sticky redirects. Disable this if you have CDN routing rules set up for accessing MediaTailor manifests, and you are either using client-side reporting or your players support sticky HTTP redirects. Valid values are DISABLED and EMT_DEFAULT. The EMT_DEFAULT setting enables the inclusion of the tag and is the default value." + }, + "OriginManifestType": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The setting that controls whether MediaTailor handles manifests from the origin server as multi-period manifests or single-period manifests. If your origin server produces single-period manifests, set this to SINGLE_PERIOD. The default setting is MULTI_PERIOD. For multi-period manifests, omit this setting or set it to MULTI_PERIOD." + } + } + }, + { + "$type": "ObjectType", + "name": "HlsConfiguration", + "properties": { + "ManifestEndpointPrefix": { + "type": { + "$ref": "#/11" + }, + "flags": 2, + "description": "The URL that is used to initiate a playback session for devices that support Apple HLS. The session uses server-side reporting." + } + } + }, + { + "$type": "ObjectType", + "name": "LivePreRollConfiguration", + "properties": { + "AdDecisionServerUrl": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The 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." + }, + "MaxDurationSeconds": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "The 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." + } + } + }, + { + "$type": "ObjectType", + "name": "ManifestProcessingRules", + "properties": { + "AdMarkerPassthrough": { + "type": { + "$ref": "#/37" + }, + "flags": 0, + "description": "For 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. No 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." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/11" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/11" + }, + "flags": 1 + } + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.MediaTailor/PlaybackConfigurationProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/46" + } + }, + { + "$type": "ObjectType", + "name": "AWS.MediaTailor/PlaybackConfigurationProperties", + "properties": { + "AdDecisionServerUrl": { + "type": { + "$ref": "#/11" + }, + "flags": 1, + "description": "The 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." + }, + "AvailSuppression": { + "type": { + "$ref": "#/38" + }, + "flags": 0, + "description": "The 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)." + }, + "Bumper": { + "type": { + "$ref": "#/39" + }, + "flags": 0, + "description": "The 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)." + }, + "CdnConfiguration": { + "type": { + "$ref": "#/40" + }, + "flags": 0, + "description": "The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management." + }, + "ConfigurationAliases": { + "type": { + "$ref": "#/41" + }, + "flags": 0, + "description": "The player parameters and aliases used as dynamic variables during session initialization. For more information, see Domain Variables. " + }, + "DashConfiguration": { + "type": { + "$ref": "#/42" + }, + "flags": 0, + "description": "The configuration for DASH content." + }, + "HlsConfiguration": { + "type": { + "$ref": "#/43" + }, + "flags": 0, + "description": "The configuration for HLS content." + }, + "LivePreRollConfiguration": { + "type": { + "$ref": "#/44" + }, + "flags": 0, + "description": "The configuration for pre-roll ad insertion." + }, + "ManifestProcessingRules": { + "type": { + "$ref": "#/45" + }, + "flags": 0, + "description": "The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor." + }, + "Name": { + "type": { + "$ref": "#/11" + }, + "flags": 17, + "description": "The identifier for the playback configuration." + }, + "PersonalizationThresholdSeconds": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "Defines 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)." + }, + "PlaybackConfigurationArn": { + "type": { + "$ref": "#/11" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) for the playback configuration." + }, + "PlaybackEndpointPrefix": { + "type": { + "$ref": "#/11" + }, + "flags": 2, + "description": "The URL that the player accesses to get a manifest from MediaTailor. This session will use server-side reporting." + }, + "SessionInitializationEndpointPrefix": { + "type": { + "$ref": "#/11" + }, + "flags": 2, + "description": "The URL that the player uses to initialize a session that uses client-side reporting." + }, + "SlateAdUrl": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The URL for a high-quality 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 configurations. For VPAID, the slate is required because MediaTailor provides it in the slots that are designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video." + }, + "Tags": { + "type": { + "$ref": "#/49" + }, + "flags": 0, + "description": "The tags to assign to the playback configuration." + }, + "TranscodeProfileName": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The 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." + }, + "VideoContentSourceUrl": { + "type": { + "$ref": "#/11" + }, + "flags": 1, + "description": "The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.MediaTailor/PlaybackConfiguration", + "properties": { + "name": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/11" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/50" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.MediaTailor/PlaybackConfiguration@default", + "scopeType": 0, + "body": { + "$ref": "#/51" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AccessConfiguration", + "properties": { + "AccessType": { + "type": { + "$ref": "#/11" + }, + "flags": 0 + }, + "SecretsManagerAccessTokenConfiguration": { + "type": { + "$ref": "#/57" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AccessType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DefaultSegmentDeliveryConfiguration", + "properties": { + "BaseUrl": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "

The hostname of the server that will be used to serve segments. This string must include the protocol, such as https://.

" + } + } + }, + { + "$type": "ObjectType", + "name": "HttpConfiguration", + "properties": { + "BaseUrl": { + "type": { + "$ref": "#/11" + }, + "flags": 1, + "description": "

The base URL for the source location host server. This string must include the protocol, such as https://.

" + } + } + }, + { + "$type": "ObjectType", + "name": "SecretsManagerAccessTokenConfiguration", + "properties": { + "HeaderName": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "

The name of the HTTP header used to supply the access token in requests to the source location.

" + }, + "SecretArn": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "

The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the access token.

" + }, + "SecretStringKey": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "

The AWS Secrets Manager SecretString key associated with the access token. MediaTailor uses the key to look up SecretString key and value pair containing the access token.

" + } + } + }, + { + "$type": "ObjectType", + "name": "SegmentDeliveryConfiguration", + "properties": { + "BaseUrl": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "

The 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*.

" + }, + "Name": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "

A unique identifier used to distinguish between multiple segment delivery configurations in a source location.

" + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/11" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/11" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.MediaTailor/SourceLocationProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/58" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/59" + } + }, + { + "$type": "ObjectType", + "name": "AWS.MediaTailor/SourceLocationProperties", + "properties": { + "AccessConfiguration": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "Arn": { + "type": { + "$ref": "#/11" + }, + "flags": 2, + "description": "

The ARN of the source location.

" + }, + "DefaultSegmentDeliveryConfiguration": { + "type": { + "$ref": "#/55" + }, + "flags": 0 + }, + "HttpConfiguration": { + "type": { + "$ref": "#/56" + }, + "flags": 1 + }, + "SegmentDeliveryConfigurations": { + "type": { + "$ref": "#/61" + }, + "flags": 0, + "description": "

A list of the segment delivery configurations associated with this resource.

" + }, + "SourceLocationName": { + "type": { + "$ref": "#/11" + }, + "flags": 17 + }, + "Tags": { + "type": { + "$ref": "#/62" + }, + "flags": 0, + "description": "The tags to assign to the source location." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.MediaTailor/SourceLocation", + "properties": { + "name": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/11" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/63" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.MediaTailor/SourceLocation@default", + "scopeType": 0, + "body": { + "$ref": "#/64" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "HttpPackageConfiguration", + "properties": { + "Path": { + "type": { + "$ref": "#/11" + }, + "flags": 1, + "description": "

The relative path to the URL for this VOD source. This is combined with SourceLocation::HttpConfiguration::BaseUrl to form a valid URL.

" + }, + "SourceGroup": { + "type": { + "$ref": "#/11" + }, + "flags": 1, + "description": "

The name of the source group. This has to match one of the Channel::Outputs::SourceGroup.

" + }, + "Type": { + "type": { + "$ref": "#/11" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/11" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/11" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Type", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.MediaTailor/VodSourceProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/66" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/67" + } + }, + { + "$type": "ObjectType", + "name": "AWS.MediaTailor/VodSourceProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/11" + }, + "flags": 2, + "description": "

The ARN of the VOD source.

" + }, + "HttpPackageConfigurations": { + "type": { + "$ref": "#/70" + }, + "flags": 1, + "description": "

A list of HTTP package configuration parameters for this VOD source.

" + }, + "SourceLocationName": { + "type": { + "$ref": "#/11" + }, + "flags": 17 + }, + "Tags": { + "type": { + "$ref": "#/71" + }, + "flags": 0, + "description": "The tags to assign to the VOD source." + }, + "VodSourceName": { + "type": { + "$ref": "#/11" + }, + "flags": 17 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.MediaTailor/VodSource", + "properties": { + "name": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/11" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/72" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.MediaTailor/VodSource@default", + "scopeType": 0, + "body": { + "$ref": "#/73" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.mediatailor/default/types.md b/artifacts/bicep/aws/aws.mediatailor/default/types.md index c6191cc6..9a5654d7 100644 --- a/artifacts/bicep/aws/aws.mediatailor/default/types.md +++ b/artifacts/bicep/aws/aws.mediatailor/default/types.md @@ -3,48 +3,69 @@ ## Resource AWS.MediaTailor/Channel@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.MediaTailor/ChannelProperties](#awsmediatailorchannelproperties) (Required): properties of the resource +* **properties**: [AWS.MediaTailor/ChannelProperties](#awsmediatailorchannelproperties) (Required, Identifier): properties of the resource ## Resource AWS.MediaTailor/ChannelPolicy@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.MediaTailor/ChannelPolicyProperties](#awsmediatailorchannelpolicyproperties) (Required): properties of the resource +* **properties**: [AWS.MediaTailor/ChannelPolicyProperties](#awsmediatailorchannelpolicyproperties) (Required, Identifier): properties of the resource ## Resource AWS.MediaTailor/LiveSource@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.MediaTailor/LiveSourceProperties](#awsmediatailorlivesourceproperties) (Required): properties of the resource +* **properties**: [AWS.MediaTailor/LiveSourceProperties](#awsmediatailorlivesourceproperties) (Required, Identifier): properties of the resource ## Resource AWS.MediaTailor/PlaybackConfiguration@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.MediaTailor/PlaybackConfigurationProperties](#awsmediatailorplaybackconfigurationproperties) (Required): properties of the resource +* **properties**: [AWS.MediaTailor/PlaybackConfigurationProperties](#awsmediatailorplaybackconfigurationproperties) (Required, Identifier): properties of the resource ## Resource AWS.MediaTailor/SourceLocation@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.MediaTailor/SourceLocationProperties](#awsmediatailorsourcelocationproperties) (Required): properties of the resource +* **properties**: [AWS.MediaTailor/SourceLocationProperties](#awsmediatailorsourcelocationproperties) (Required, Identifier): properties of the resource ## Resource AWS.MediaTailor/VodSource@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.MediaTailor/VodSourceProperties](#awsmediatailorvodsourceproperties) (Required): properties of the resource +* **properties**: [AWS.MediaTailor/VodSourceProperties](#awsmediatailorvodsourceproperties) (Required, Identifier): properties of the resource + +## AccessConfiguration +### Properties +* **AccessType**: string +* **SecretsManagerAccessTokenConfiguration**: [SecretsManagerAccessTokenConfiguration](#secretsmanageraccesstokenconfiguration) + +## AdMarkerPassthrough +### Properties +* **Enabled**: bool: Enables ad marker passthrough for your configuration. + +## AvailSuppression +### Properties +* **FillPolicy**: string: Defines 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. Valid values are FULL_AVAIL_ONLY and PARTIAL_AVAIL +* **Mode**: string: Sets 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. +* **Value**: string: A 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. + +## AWS.MediaTailor/ChannelPolicyProperties +### Properties +* **ChannelName**: string (Required, Identifier) +* **Policy**: [ChannelPolicy_Policy](#channelpolicypolicy) | string (Required):

The IAM policy for the channel. IAM policies are used to control access to your channel.

## AWS.MediaTailor/ChannelProperties ### Properties * **Arn**: string (ReadOnly):

The ARN of the channel.

+* **Audiences**: string[]:

The list of audiences defined in channel.

* **ChannelName**: string (Required, Identifier) * **FillerSlate**: [SlateSource](#slatesource) * **LogConfiguration**: [LogConfigurationForChannel](#logconfigurationforchannel) @@ -54,48 +75,6 @@ * **Tier**: string * **TimeShiftConfiguration**: [TimeShiftConfiguration](#timeshiftconfiguration) -## SlateSource -### Properties -* **SourceLocationName**: string:

The name of the source location where the slate VOD source is stored.

-* **VodSourceName**: string:

The slate VOD source name. The VOD source must already exist in a source location before it can be used for slate.

- -## LogConfigurationForChannel -### Properties -* **LogTypes**: string[]:

The log types.

- -## RequestOutputItem -### Properties -* **DashPlaylistSettings**: [DashPlaylistSettings](#dashplaylistsettings) -* **HlsPlaylistSettings**: [HlsPlaylistSettings](#hlsplaylistsettings) -* **ManifestName**: string (Required):

The name of the manifest for the channel. The name appears in the PlaybackUrl.

-* **SourceGroup**: string (Required):

A string used to match which HttpPackageConfiguration is used for each VodSource.

- -## DashPlaylistSettings -### Properties -* **ManifestWindowSeconds**: int:

The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.

-* **MinBufferTimeSeconds**: int:

Minimum amount of content (measured in seconds) that a player must keep available in the buffer. Minimum value: 2 seconds. Maximum value: 60 seconds.

-* **MinUpdatePeriodSeconds**: int:

Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.

-* **SuggestedPresentationDelaySeconds**: int:

Amount 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.

- -## HlsPlaylistSettings -### Properties -* **AdMarkupType**: string[]:

Determines 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).

-* **ManifestWindowSeconds**: int:

The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.

- -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - -## TimeShiftConfiguration -### Properties -* **MaxTimeDelaySeconds**: int (Required):

The maximum time delay for time-shifted viewing. The minimum allowed maximum time delay is 0 seconds, and the maximum allowed maximum time delay is 21600 seconds (6 hours).

- -## AWS.MediaTailor/ChannelPolicyProperties -### Properties -* **ChannelName**: string (Required, Identifier) -* **Policy**: [ChannelPolicy_Policy](#channelpolicypolicy) | string (Required):

The IAM policy for the channel. IAM policies are used to control access to your channel.

- ## AWS.MediaTailor/LiveSourceProperties ### Properties * **Arn**: string (ReadOnly):

The ARN of the live source.

@@ -104,17 +83,6 @@ * **SourceLocationName**: string (Required, Identifier) * **Tags**: [Tag](#tag)[]: The tags to assign to the live source. -## HttpPackageConfiguration -### Properties -* **Path**: string (Required):

The relative path to the URL for this VOD source. This is combined with SourceLocation::HttpConfiguration::BaseUrl to form a valid URL.

-* **SourceGroup**: string (Required):

The name of the source group. This has to match one of the Channel::Outputs::SourceGroup.

-* **Type**: string (Required) - -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - ## AWS.MediaTailor/PlaybackConfigurationProperties ### Properties * **AdDecisionServerUrl**: string (Required): The 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. @@ -136,10 +104,23 @@ * **TranscodeProfileName**: string: The 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. * **VideoContentSourceUrl**: string (Required): The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters. -## AvailSuppression +## AWS.MediaTailor/SourceLocationProperties ### Properties -* **Mode**: string: Sets the ad suppression mode. By default, ad suppression is set to 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. -* **Value**: string: A 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. +* **AccessConfiguration**: [AccessConfiguration](#accessconfiguration) +* **Arn**: string (ReadOnly):

The ARN of the source location.

+* **DefaultSegmentDeliveryConfiguration**: [DefaultSegmentDeliveryConfiguration](#defaultsegmentdeliveryconfiguration) +* **HttpConfiguration**: [HttpConfiguration](#httpconfiguration) (Required) +* **SegmentDeliveryConfigurations**: [SegmentDeliveryConfiguration](#segmentdeliveryconfiguration)[]:

A list of the segment delivery configurations associated with this resource.

+* **SourceLocationName**: string (Required, Identifier) +* **Tags**: [Tag](#tag)[]: The tags to assign to the source location. + +## AWS.MediaTailor/VodSourceProperties +### Properties +* **Arn**: string (ReadOnly):

The ARN of the VOD source.

+* **HttpPackageConfigurations**: [HttpPackageConfiguration](#httppackageconfiguration)[] (Required):

A list of HTTP package configuration parameters for this VOD source.

+* **SourceLocationName**: string (Required, Identifier) +* **Tags**: [Tag](#tag)[]: The tags to assign to the VOD source. +* **VodSourceName**: string (Required, Identifier) ## Bumper ### Properties @@ -160,42 +141,61 @@ * **MpdLocation**: string: The setting that controls whether MediaTailor includes the Location tag in DASH manifests. MediaTailor populates the Location tag with the URL for manifest update requests, to be used by players that don't support sticky redirects. Disable this if you have CDN routing rules set up for accessing MediaTailor manifests, and you are either using client-side reporting or your players support sticky HTTP redirects. Valid values are DISABLED and EMT_DEFAULT. The EMT_DEFAULT setting enables the inclusion of the tag and is the default value. * **OriginManifestType**: string: The setting that controls whether MediaTailor handles manifests from the origin server as multi-period manifests or single-period manifests. If your origin server produces single-period manifests, set this to SINGLE_PERIOD. The default setting is MULTI_PERIOD. For multi-period manifests, omit this setting or set it to MULTI_PERIOD. +## DashPlaylistSettings +### Properties +* **ManifestWindowSeconds**: int:

The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.

+* **MinBufferTimeSeconds**: int:

Minimum amount of content (measured in seconds) that a player must keep available in the buffer. Minimum value: 2 seconds. Maximum value: 60 seconds.

+* **MinUpdatePeriodSeconds**: int:

Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.

+* **SuggestedPresentationDelaySeconds**: int:

Amount 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.

+ +## DefaultSegmentDeliveryConfiguration +### Properties +* **BaseUrl**: string:

The hostname of the server that will be used to serve segments. This string must include the protocol, such as https://.

+ ## HlsConfiguration ### Properties * **ManifestEndpointPrefix**: string (ReadOnly): The URL that is used to initiate a playback session for devices that support Apple HLS. The session uses server-side reporting. -## LivePreRollConfiguration +## HlsPlaylistSettings ### Properties -* **AdDecisionServerUrl**: string: The 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. -* **MaxDurationSeconds**: int: The 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. +* **AdMarkupType**: string[]:

Determines 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).

+* **ManifestWindowSeconds**: int:

The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.

-## ManifestProcessingRules +## HttpConfiguration ### Properties -* **AdMarkerPassthrough**: [AdMarkerPassthrough](#admarkerpassthrough): For 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. No 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. +* **BaseUrl**: string (Required):

The base URL for the source location host server. This string must include the protocol, such as https://.

-## AdMarkerPassthrough +## HttpPackageConfiguration ### Properties -* **Enabled**: bool: Enables ad marker passthrough for your configuration. +* **Path**: string (Required):

The relative path to the URL for this VOD source. This is combined with SourceLocation::HttpConfiguration::BaseUrl to form a valid URL.

+* **SourceGroup**: string (Required):

The name of the source group. This has to match one of the Channel::Outputs::SourceGroup.

+* **Type**: string (Required) -## Tag +## HttpPackageConfiguration ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **Path**: string (Required):

The relative path to the URL for this VOD source. This is combined with SourceLocation::HttpConfiguration::BaseUrl to form a valid URL.

+* **SourceGroup**: string (Required):

The name of the source group. This has to match one of the Channel::Outputs::SourceGroup.

+* **Type**: string (Required) -## AWS.MediaTailor/SourceLocationProperties +## LivePreRollConfiguration ### Properties -* **AccessConfiguration**: [AccessConfiguration](#accessconfiguration) -* **Arn**: string (ReadOnly):

The ARN of the source location.

-* **DefaultSegmentDeliveryConfiguration**: [DefaultSegmentDeliveryConfiguration](#defaultsegmentdeliveryconfiguration) -* **HttpConfiguration**: [HttpConfiguration](#httpconfiguration) (Required) -* **SegmentDeliveryConfigurations**: [SegmentDeliveryConfiguration](#segmentdeliveryconfiguration)[]:

A list of the segment delivery configurations associated with this resource.

-* **SourceLocationName**: string (Required, Identifier) -* **Tags**: [Tag](#tag)[]: The tags to assign to the source location. +* **AdDecisionServerUrl**: string: The 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. +* **MaxDurationSeconds**: int: The 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. -## AccessConfiguration +## LogConfigurationForChannel ### Properties -* **AccessType**: string -* **SecretsManagerAccessTokenConfiguration**: [SecretsManagerAccessTokenConfiguration](#secretsmanageraccesstokenconfiguration) +* **LogTypes**: string[]:

The log types.

+ +## ManifestProcessingRules +### Properties +* **AdMarkerPassthrough**: [AdMarkerPassthrough](#admarkerpassthrough): For 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. No 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. + +## RequestOutputItem +### Properties +* **DashPlaylistSettings**: [DashPlaylistSettings](#dashplaylistsettings) +* **HlsPlaylistSettings**: [HlsPlaylistSettings](#hlsplaylistsettings) +* **ManifestName**: string (Required):

The name of the manifest for the channel. The name appears in the PlaybackUrl.

+* **SourceGroup**: string (Required):

A string used to match which HttpPackageConfiguration is used for each VodSource.

## SecretsManagerAccessTokenConfiguration ### Properties @@ -203,40 +203,42 @@ * **SecretArn**: string:

The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the access token.

* **SecretStringKey**: string:

The AWS Secrets Manager SecretString key associated with the access token. MediaTailor uses the key to look up SecretString key and value pair containing the access token.

-## DefaultSegmentDeliveryConfiguration +## SegmentDeliveryConfiguration ### Properties -* **BaseUrl**: string:

The hostname of the server that will be used to serve segments. This string must include the protocol, such as https://.

+* **BaseUrl**: string:

The 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*.

+* **Name**: string:

A unique identifier used to distinguish between multiple segment delivery configurations in a source location.

-## HttpConfiguration +## SlateSource ### Properties -* **BaseUrl**: string (Required):

The base URL for the source location host server. This string must include the protocol, such as https://.

+* **SourceLocationName**: string:

The name of the source location where the slate VOD source is stored.

+* **VodSourceName**: string:

The slate VOD source name. The VOD source must already exist in a source location before it can be used for slate.

-## SegmentDeliveryConfiguration +## Tag ### Properties -* **BaseUrl**: string:

The 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*.

-* **Name**: string:

A unique identifier used to distinguish between multiple segment delivery configurations in a source location.

+* **Key**: string (Required) +* **Value**: string (Required) ## Tag ### Properties * **Key**: string (Required) * **Value**: string (Required) -## AWS.MediaTailor/VodSourceProperties +## Tag ### Properties -* **Arn**: string (ReadOnly):

The ARN of the VOD source.

-* **HttpPackageConfigurations**: [HttpPackageConfiguration](#httppackageconfiguration)[] (Required):

A list of HTTP package configuration parameters for this VOD source.

-* **SourceLocationName**: string (Required, Identifier) -* **Tags**: [Tag](#tag)[]: The tags to assign to the VOD source. -* **VodSourceName**: string (Required, Identifier) +* **Key**: string (Required) +* **Value**: string (Required) -## HttpPackageConfiguration +## Tag ### Properties -* **Path**: string (Required):

The relative path to the URL for this VOD source. This is combined with SourceLocation::HttpConfiguration::BaseUrl to form a valid URL.

-* **SourceGroup**: string (Required):

The name of the source group. This has to match one of the Channel::Outputs::SourceGroup.

-* **Type**: string (Required) +* **Key**: string (Required) +* **Value**: string (Required) ## Tag ### Properties * **Key**: string (Required) * **Value**: string (Required) +## TimeShiftConfiguration +### Properties +* **MaxTimeDelaySeconds**: int (Required):

The maximum time delay for time-shifted viewing. The minimum allowed maximum time delay is 0 seconds, and the maximum allowed maximum time delay is 21600 seconds (6 hours).

+ diff --git a/artifacts/bicep/aws/aws.memorydb/default/types.json b/artifacts/bicep/aws/aws.memorydb/default/types.json index 5092859c..02485b6c 100644 --- a/artifacts/bicep/aws/aws.memorydb/default/types.json +++ b/artifacts/bicep/aws/aws.memorydb/default/types.json @@ -1 +1,805 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with 'aws:'. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":0,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.MemoryDB/ACLProperties","Properties":{"ACLName":{"Type":4,"Flags":17,"Description":"The name of the acl."},"Arn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) of the acl."},"Status":{"Type":4,"Flags":2,"Description":"Indicates acl status. Can be \"creating\", \"active\", \"modifying\", \"deleting\"."},"Tags":{"Type":10,"Flags":0,"Description":"An array of key-value pairs to apply to this cluster."},"UserNames":{"Type":11,"Flags":0,"Description":"List of users associated to this acl."}}}},{"3":{"ItemType":8}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.MemoryDB/ACL","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":9,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.MemoryDB/ACL@default","ScopeType":0,"Body":12}},{"2":{"Name":"DataTieringStatus"}},{"2":{"Name":"Endpoint","Properties":{"Address":{"Type":4,"Flags":2,"Description":"The DNS address of the primary read-write node."},"Port":{"Type":3,"Flags":2,"Description":"The port number that the engine is listening on. "}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key for the tag. May not be null."},"Value":{"Type":4,"Flags":1,"Description":"The tag's value. May be null."}}}},{"2":{"Name":"AWS.MemoryDB/ClusterProperties","Properties":{"ACLName":{"Type":4,"Flags":1,"Description":"The name of the Access Control List to associate with the cluster."},"ARN":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) of the cluster."},"AutoMinorVersionUpgrade":{"Type":2,"Flags":0,"Description":"A flag that enables automatic minor version upgrade when set to true.\n\nYou cannot modify the value of AutoMinorVersionUpgrade after the cluster is created. To enable AutoMinorVersionUpgrade on a cluster you must set AutoMinorVersionUpgrade to true when you create a cluster."},"ClusterEndpoint":{"Type":15,"Flags":0,"Description":"The cluster endpoint."},"ClusterName":{"Type":4,"Flags":17,"Description":"The name of the cluster. This value must be unique as it also serves as the cluster identifier."},"DataTiering":{"Type":18,"Flags":0,"Description":"Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes."},"Description":{"Type":4,"Flags":0,"Description":"An optional description of the cluster."},"EngineVersion":{"Type":4,"Flags":0,"Description":"The Redis engine version used by the cluster."},"FinalSnapshotName":{"Type":4,"Flags":4,"Description":"The user-supplied name of a final cluster snapshot. This is the unique name that identifies the snapshot. MemoryDB creates the snapshot, and then deletes the cluster immediately afterward."},"KmsKeyId":{"Type":4,"Flags":0,"Description":"The ID of the KMS key used to encrypt the cluster."},"MaintenanceWindow":{"Type":4,"Flags":0,"Description":"Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period."},"NodeType":{"Type":4,"Flags":1,"Description":"The compute and memory capacity of the nodes in the cluster."},"NumReplicasPerShard":{"Type":3,"Flags":0,"Description":"The number of replicas to apply to each shard. The limit is 5."},"NumShards":{"Type":3,"Flags":0,"Description":"The number of shards the cluster will contain."},"ParameterGroupName":{"Type":4,"Flags":0,"Description":"The name of the parameter group associated with the cluster."},"ParameterGroupStatus":{"Type":4,"Flags":2,"Description":"The status of the parameter group used by the cluster."},"Port":{"Type":3,"Flags":0,"Description":"The port number on which each member of the cluster accepts connections."},"SecurityGroupIds":{"Type":19,"Flags":0,"Description":"One or more Amazon VPC security groups associated with this cluster."},"SnapshotArns":{"Type":20,"Flags":4,"Description":"A list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored 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."},"SnapshotName":{"Type":4,"Flags":4,"Description":"The name of a snapshot from which to restore data into the new cluster. The snapshot status changes to restoring while the new cluster is being created."},"SnapshotRetentionLimit":{"Type":3,"Flags":0,"Description":"The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted."},"SnapshotWindow":{"Type":4,"Flags":0,"Description":"The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your cluster."},"SnsTopicArn":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent."},"SnsTopicStatus":{"Type":4,"Flags":0,"Description":"The status of the Amazon SNS notification topic. Notifications are sent only if the status is enabled."},"Status":{"Type":4,"Flags":2,"Description":"The status of the cluster. For example, Available, Updating, Creating."},"SubnetGroupName":{"Type":4,"Flags":0,"Description":"The name of the subnet group to be used for the cluster."},"TLSEnabled":{"Type":2,"Flags":0,"Description":"A flag that enables in-transit encryption when set to true.\n\nYou cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster."},"Tags":{"Type":21,"Flags":0,"Description":"An array of key-value pairs to apply to this cluster."}}}},{"2":{"Name":"Cluster_DataTieringStatus","Properties":{}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":16}},{"2":{"Name":"AWS.MemoryDB/Cluster","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":17,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.MemoryDB/Cluster@default","ScopeType":0,"Body":22}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key for the tag. May not be null."},"Value":{"Type":4,"Flags":1,"Description":"The tag's value. May be null."}}}},{"2":{"Name":"AWS.MemoryDB/ParameterGroupProperties","Properties":{"ARN":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) of the parameter group."},"Description":{"Type":4,"Flags":0,"Description":"A description of the parameter group."},"Family":{"Type":4,"Flags":1,"Description":"The name of the parameter group family that this parameter group is compatible with."},"ParameterGroupName":{"Type":4,"Flags":17,"Description":"The name of the parameter group."},"Parameters":{"Type":26,"Flags":4,"Description":"An map of parameter names and values for the parameter update. You must supply at least one parameter name and value; subsequent arguments are optional."},"Tags":{"Type":27,"Flags":0,"Description":"An array of key-value pairs to apply to this parameter group."}}}},{"2":{"Name":"ParameterGroup_Parameters","Properties":{}}},{"3":{"ItemType":24}},{"2":{"Name":"AWS.MemoryDB/ParameterGroup","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":25,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.MemoryDB/ParameterGroup@default","ScopeType":0,"Body":28}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key for the tag. May not be null."},"Value":{"Type":4,"Flags":1,"Description":"The tag's value. May be null."}}}},{"2":{"Name":"AWS.MemoryDB/SubnetGroupProperties","Properties":{"ARN":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) of the subnet group."},"Description":{"Type":4,"Flags":0,"Description":"An optional description of the subnet group."},"SubnetGroupName":{"Type":4,"Flags":17,"Description":"The name of the subnet group. This value must be unique as it also serves as the subnet group identifier."},"SubnetIds":{"Type":32,"Flags":1,"Description":"A list of VPC subnet IDs for the subnet group."},"Tags":{"Type":33,"Flags":0,"Description":"An array of key-value pairs to apply to this subnet group."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":30}},{"2":{"Name":"AWS.MemoryDB/SubnetGroup","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":31,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.MemoryDB/SubnetGroup@default","ScopeType":0,"Body":34}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with 'aws:'. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":0,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.MemoryDB/UserProperties","Properties":{"AccessString":{"Type":4,"Flags":4,"Description":"Access permissions string used for this user account."},"Arn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) of the user account."},"AuthenticationMode":{"Type":39,"Flags":4},"Status":{"Type":4,"Flags":2,"Description":"Indicates the user status. Can be \"active\", \"modifying\" or \"deleting\"."},"Tags":{"Type":40,"Flags":0,"Description":"An array of key-value pairs to apply to this user."},"UserName":{"Type":4,"Flags":17,"Description":"The name of the user."}}}},{"3":{"ItemType":4}},{"2":{"Name":"User_AuthenticationMode","Properties":{"Passwords":{"Type":38,"Flags":0,"Description":"Passwords used for this user account. You can create up to two passwords for each user."},"Type":{"Type":4,"Flags":0,"Description":"Type of authentication strategy for this user."}}}},{"3":{"ItemType":36}},{"2":{"Name":"AWS.MemoryDB/User","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":37,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.MemoryDB/User@default","ScopeType":0,"Body":41}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with 'aws:'. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.MemoryDB/ACLProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "AWS.MemoryDB/ACLProperties", + "properties": { + "ACLName": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The name of the acl." + }, + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) of the acl." + }, + "Status": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "Indicates acl status. Can be \"creating\", \"active\", \"modifying\", \"deleting\"." + }, + "Tags": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this cluster." + }, + "UserNames": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "List of users associated to this acl." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.MemoryDB/ACL", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.MemoryDB/ACL@default", + "scopeType": 0, + "body": { + "$ref": "#/6" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "DataTieringStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Endpoint", + "properties": { + "Address": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The DNS address of the primary read-write node." + }, + "Port": { + "type": { + "$ref": "#/11" + }, + "flags": 2, + "description": "The port number that the engine is listening on. " + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key for the tag. May not be null." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The tag's value. May be null." + } + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.MemoryDB/ClusterProperties" + }, + { + "$type": "BooleanType" + }, + { + "$type": "ObjectType", + "name": "Cluster_DataTieringStatus", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/10" + } + }, + { + "$type": "ObjectType", + "name": "AWS.MemoryDB/ClusterProperties", + "properties": { + "ACLName": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The name of the Access Control List to associate with the cluster." + }, + "ARN": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) of the cluster." + }, + "AutoMinorVersionUpgrade": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "A flag that enables automatic minor version upgrade when set to true.\n\nYou cannot modify the value of AutoMinorVersionUpgrade after the cluster is created. To enable AutoMinorVersionUpgrade on a cluster you must set AutoMinorVersionUpgrade to true when you create a cluster." + }, + "ClusterEndpoint": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "The cluster endpoint." + }, + "ClusterName": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The name of the cluster. This value must be unique as it also serves as the cluster identifier." + }, + "DataTiering": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes." + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "An optional description of the cluster." + }, + "EngineVersion": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The Redis engine version used by the cluster." + }, + "FinalSnapshotName": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The user-supplied name of a final cluster snapshot. This is the unique name that identifies the snapshot. MemoryDB creates the snapshot, and then deletes the cluster immediately afterward." + }, + "KmsKeyId": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The ID of the KMS key used to encrypt the cluster." + }, + "MaintenanceWindow": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period." + }, + "NodeType": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The compute and memory capacity of the nodes in the cluster." + }, + "NumReplicasPerShard": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The number of replicas to apply to each shard. The limit is 5." + }, + "NumShards": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The number of shards the cluster will contain." + }, + "ParameterGroupName": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The name of the parameter group associated with the cluster." + }, + "ParameterGroupStatus": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The status of the parameter group used by the cluster." + }, + "Port": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The port number on which each member of the cluster accepts connections." + }, + "SecurityGroupIds": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "One or more Amazon VPC security groups associated with this cluster." + }, + "SnapshotArns": { + "type": { + "$ref": "#/16" + }, + "flags": 4, + "description": "A list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored 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." + }, + "SnapshotName": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The name of a snapshot from which to restore data into the new cluster. The snapshot status changes to restoring while the new cluster is being created." + }, + "SnapshotRetentionLimit": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted." + }, + "SnapshotWindow": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your cluster." + }, + "SnsTopicArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent." + }, + "SnsTopicStatus": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The status of the Amazon SNS notification topic. Notifications are sent only if the status is enabled." + }, + "Status": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The status of the cluster. For example, Available, Updating, Creating." + }, + "SubnetGroupName": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The name of the subnet group to be used for the cluster." + }, + "TLSEnabled": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "A flag that enables in-transit encryption when set to true.\n\nYou cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster." + }, + "Tags": { + "type": { + "$ref": "#/17" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this cluster." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.MemoryDB/Cluster", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/18" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.MemoryDB/Cluster@default", + "scopeType": 0, + "body": { + "$ref": "#/19" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key for the tag. May not be null." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The tag's value. May be null." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.MemoryDB/ParameterGroupProperties" + }, + { + "$type": "ObjectType", + "name": "ParameterGroup_Parameters", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/21" + } + }, + { + "$type": "ObjectType", + "name": "AWS.MemoryDB/ParameterGroupProperties", + "properties": { + "ARN": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) of the parameter group." + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A description of the parameter group." + }, + "Family": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The name of the parameter group family that this parameter group is compatible with." + }, + "ParameterGroupName": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The name of the parameter group." + }, + "Parameters": { + "type": { + "$ref": "#/23" + }, + "flags": 4, + "description": "An map of parameter names and values for the parameter update. You must supply at least one parameter name and value; subsequent arguments are optional." + }, + "Tags": { + "type": { + "$ref": "#/24" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this parameter group." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.MemoryDB/ParameterGroup", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/25" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.MemoryDB/ParameterGroup@default", + "scopeType": 0, + "body": { + "$ref": "#/26" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key for the tag. May not be null." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The tag's value. May be null." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.MemoryDB/SubnetGroupProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/28" + } + }, + { + "$type": "ObjectType", + "name": "AWS.MemoryDB/SubnetGroupProperties", + "properties": { + "ARN": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) of the subnet group." + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "An optional description of the subnet group." + }, + "SubnetGroupName": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The name of the subnet group. This value must be unique as it also serves as the subnet group identifier." + }, + "SubnetIds": { + "type": { + "$ref": "#/30" + }, + "flags": 1, + "description": "A list of VPC subnet IDs for the subnet group." + }, + "Tags": { + "type": { + "$ref": "#/31" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this subnet group." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.MemoryDB/SubnetGroup", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/32" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.MemoryDB/SubnetGroup@default", + "scopeType": 0, + "body": { + "$ref": "#/33" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with 'aws:'. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.MemoryDB/UserProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "User_AuthenticationMode", + "properties": { + "Passwords": { + "type": { + "$ref": "#/37" + }, + "flags": 0, + "description": "Passwords used for this user account. You can create up to two passwords for each user." + }, + "Type": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Type of authentication strategy for this user." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/35" + } + }, + { + "$type": "ObjectType", + "name": "AWS.MemoryDB/UserProperties", + "properties": { + "AccessString": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "Access permissions string used for this user account." + }, + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) of the user account." + }, + "AuthenticationMode": { + "type": { + "$ref": "#/38" + }, + "flags": 4 + }, + "Status": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "Indicates the user status. Can be \"active\", \"modifying\" or \"deleting\"." + }, + "Tags": { + "type": { + "$ref": "#/39" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this user." + }, + "UserName": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The name of the user." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.MemoryDB/User", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/40" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.MemoryDB/User@default", + "scopeType": 0, + "body": { + "$ref": "#/41" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.memorydb/default/types.md b/artifacts/bicep/aws/aws.memorydb/default/types.md index 7ecb33cc..73d19343 100644 --- a/artifacts/bicep/aws/aws.memorydb/default/types.md +++ b/artifacts/bicep/aws/aws.memorydb/default/types.md @@ -3,37 +3,37 @@ ## Resource AWS.MemoryDB/ACL@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.MemoryDB/ACLProperties](#awsmemorydbaclproperties) (Required): properties of the resource +* **properties**: [AWS.MemoryDB/ACLProperties](#awsmemorydbaclproperties) (Required, Identifier): properties of the resource ## Resource AWS.MemoryDB/Cluster@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.MemoryDB/ClusterProperties](#awsmemorydbclusterproperties) (Required): properties of the resource +* **properties**: [AWS.MemoryDB/ClusterProperties](#awsmemorydbclusterproperties) (Required, Identifier): properties of the resource ## Resource AWS.MemoryDB/ParameterGroup@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.MemoryDB/ParameterGroupProperties](#awsmemorydbparametergroupproperties) (Required): properties of the resource +* **properties**: [AWS.MemoryDB/ParameterGroupProperties](#awsmemorydbparametergroupproperties) (Required, Identifier): properties of the resource ## Resource AWS.MemoryDB/SubnetGroup@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.MemoryDB/SubnetGroupProperties](#awsmemorydbsubnetgroupproperties) (Required): properties of the resource +* **properties**: [AWS.MemoryDB/SubnetGroupProperties](#awsmemorydbsubnetgroupproperties) (Required, Identifier): properties of the resource ## Resource AWS.MemoryDB/User@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.MemoryDB/UserProperties](#awsmemorydbuserproperties) (Required): properties of the resource +* **properties**: [AWS.MemoryDB/UserProperties](#awsmemorydbuserproperties) (Required, Identifier): properties of the resource ## AWS.MemoryDB/ACLProperties ### Properties @@ -43,11 +43,6 @@ * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this cluster. * **UserNames**: string[]: List of users associated to this acl. -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with 'aws:'. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## AWS.MemoryDB/ClusterProperties ### Properties * **ACLName**: string (Required): The name of the Access Control List to associate with the cluster. @@ -83,19 +78,6 @@ You cannot modify the value of AutoMinorVersionUpgrade after the cluster is crea You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster. -## Endpoint -### Properties -* **Address**: string (ReadOnly): The DNS address of the primary read-write node. -* **Port**: int (ReadOnly): The port number that the engine is listening on. - -## Cluster_DataTieringStatus -### Properties - -## Tag -### Properties -* **Key**: string (Required): The key for the tag. May not be null. -* **Value**: string (Required): The tag's value. May be null. - ## AWS.MemoryDB/ParameterGroupProperties ### Properties * **ARN**: string (ReadOnly): The Amazon Resource Name (ARN) of the parameter group. @@ -105,14 +87,6 @@ You cannot modify the value of TransitEncryptionEnabled after the cluster is cre * **Parameters**: [ParameterGroup_Parameters](#parametergroupparameters) (WriteOnly): An map of parameter names and values for the parameter update. You must supply at least one parameter name and value; subsequent arguments are optional. * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this parameter group. -## ParameterGroup_Parameters -### Properties - -## Tag -### Properties -* **Key**: string (Required): The key for the tag. May not be null. -* **Value**: string (Required): The tag's value. May be null. - ## AWS.MemoryDB/SubnetGroupProperties ### Properties * **ARN**: string (ReadOnly): The Amazon Resource Name (ARN) of the subnet group. @@ -121,11 +95,6 @@ You cannot modify the value of TransitEncryptionEnabled after the cluster is cre * **SubnetIds**: string[] (Required): A list of VPC subnet IDs for the subnet group. * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this subnet group. -## Tag -### Properties -* **Key**: string (Required): The key for the tag. May not be null. -* **Value**: string (Required): The tag's value. May be null. - ## AWS.MemoryDB/UserProperties ### Properties * **AccessString**: string (WriteOnly): Access permissions string used for this user account. @@ -135,13 +104,44 @@ You cannot modify the value of TransitEncryptionEnabled after the cluster is cre * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this user. * **UserName**: string (Required, Identifier): The name of the user. -## User_AuthenticationMode +## Cluster_DataTieringStatus ### Properties -* **Passwords**: string[]: Passwords used for this user account. You can create up to two passwords for each user. -* **Type**: string: Type of authentication strategy for this user. + +## Endpoint +### Properties +* **Address**: string (ReadOnly): The DNS address of the primary read-write node. +* **Port**: int (ReadOnly): The port number that the engine is listening on. + +## ParameterGroup_Parameters +### Properties + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with 'aws:'. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## Tag +### Properties +* **Key**: string (Required): The key for the tag. May not be null. +* **Value**: string (Required): The tag's value. May be null. + +## Tag +### Properties +* **Key**: string (Required): The key for the tag. May not be null. +* **Value**: string (Required): The tag's value. May be null. + +## Tag +### Properties +* **Key**: string (Required): The key for the tag. May not be null. +* **Value**: string (Required): The tag's value. May be null. ## Tag ### Properties * **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with 'aws:'. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. * **Value**: string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +## User_AuthenticationMode +### Properties +* **Passwords**: string[]: Passwords used for this user account. You can create up to two passwords for each user. +* **Type**: string: Type of authentication strategy for this user. + diff --git a/artifacts/bicep/aws/aws.msk/default/types.json b/artifacts/bicep/aws/aws.msk/default/types.json index 3b23bb8d..e4a48862 100644 --- a/artifacts/bicep/aws/aws.msk/default/types.json +++ b/artifacts/bicep/aws/aws.msk/default/types.json @@ -1 +1,1457 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"SecretArnList"}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.MSK/BatchScramSecretProperties","Properties":{"ClusterArn":{"Type":4,"Flags":17},"SecretArnList":{"Type":11,"Flags":0}}}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.MSK/BatchScramSecret","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":10,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.MSK/BatchScramSecret@default","ScopeType":0,"Body":12}},{"2":{"Name":"BrokerLogs","Properties":{"CloudWatchLogs":{"Type":17,"Flags":0},"Firehose":{"Type":24,"Flags":0},"S3":{"Type":33,"Flags":0}}}},{"2":{"Name":"BrokerNodeGroupInfo","Properties":{"BrokerAZDistribution":{"Type":4,"Flags":0},"ClientSubnets":{"Type":45,"Flags":1},"ConnectivityInfo":{"Type":19,"Flags":0},"InstanceType":{"Type":4,"Flags":1},"SecurityGroups":{"Type":46,"Flags":0},"StorageInfo":{"Type":36,"Flags":0}}}},{"2":{"Name":"ClientAuthentication","Properties":{"Sasl":{"Type":34,"Flags":0},"Tls":{"Type":37,"Flags":0},"Unauthenticated":{"Type":38,"Flags":0}}}},{"2":{"Name":"CloudWatchLogs","Properties":{"Enabled":{"Type":2,"Flags":1},"LogGroup":{"Type":4,"Flags":0}}}},{"2":{"Name":"ConfigurationInfo","Properties":{"Arn":{"Type":4,"Flags":17},"Revision":{"Type":3,"Flags":1}}}},{"2":{"Name":"ConnectivityInfo","Properties":{"PublicAccess":{"Type":32,"Flags":0},"VpcConnectivity":{"Type":39,"Flags":0}}}},{"2":{"Name":"EBSStorageInfo","Properties":{"ProvisionedThroughput":{"Type":31,"Flags":0},"VolumeSize":{"Type":3,"Flags":0}}}},{"2":{"Name":"EncryptionAtRest","Properties":{"DataVolumeKMSKeyId":{"Type":4,"Flags":1}}}},{"2":{"Name":"EncryptionInTransit","Properties":{"ClientBroker":{"Type":4,"Flags":0},"InCluster":{"Type":2,"Flags":0}}}},{"2":{"Name":"EncryptionInfo","Properties":{"EncryptionAtRest":{"Type":21,"Flags":0},"EncryptionInTransit":{"Type":22,"Flags":0}}}},{"2":{"Name":"Firehose","Properties":{"DeliveryStream":{"Type":4,"Flags":0},"Enabled":{"Type":2,"Flags":1}}}},{"2":{"Name":"Iam","Properties":{"Enabled":{"Type":2,"Flags":1}}}},{"2":{"Name":"JmxExporter","Properties":{"EnabledInBroker":{"Type":2,"Flags":1}}}},{"2":{"Name":"LoggingInfo","Properties":{"BrokerLogs":{"Type":14,"Flags":1}}}},{"2":{"Name":"NodeExporter","Properties":{"EnabledInBroker":{"Type":2,"Flags":1}}}},{"2":{"Name":"OpenMonitoring","Properties":{"Prometheus":{"Type":30,"Flags":1}}}},{"2":{"Name":"Prometheus","Properties":{"JmxExporter":{"Type":26,"Flags":0},"NodeExporter":{"Type":28,"Flags":0}}}},{"2":{"Name":"ProvisionedThroughput","Properties":{"Enabled":{"Type":2,"Flags":0},"VolumeThroughput":{"Type":3,"Flags":0}}}},{"2":{"Name":"PublicAccess","Properties":{"Type":{"Type":4,"Flags":0}}}},{"2":{"Name":"S3","Properties":{"Bucket":{"Type":4,"Flags":0},"Enabled":{"Type":2,"Flags":1},"Prefix":{"Type":4,"Flags":0}}}},{"2":{"Name":"Sasl","Properties":{"Iam":{"Type":25,"Flags":0},"Scram":{"Type":35,"Flags":0}}}},{"2":{"Name":"Scram","Properties":{"Enabled":{"Type":2,"Flags":1}}}},{"2":{"Name":"StorageInfo","Properties":{"EBSStorageInfo":{"Type":20,"Flags":0}}}},{"2":{"Name":"Tls","Properties":{"CertificateAuthorityArnList":{"Type":47,"Flags":0},"Enabled":{"Type":2,"Flags":0}}}},{"2":{"Name":"Unauthenticated","Properties":{"Enabled":{"Type":2,"Flags":1}}}},{"2":{"Name":"VpcConnectivity","Properties":{"ClientAuthentication":{"Type":40,"Flags":0}}}},{"2":{"Name":"VpcConnectivityClientAuthentication","Properties":{"Sasl":{"Type":42,"Flags":0},"Tls":{"Type":44,"Flags":0}}}},{"2":{"Name":"VpcConnectivityIam","Properties":{"Enabled":{"Type":2,"Flags":1}}}},{"2":{"Name":"VpcConnectivitySasl","Properties":{"Iam":{"Type":41,"Flags":0},"Scram":{"Type":43,"Flags":0}}}},{"2":{"Name":"VpcConnectivityScram","Properties":{"Enabled":{"Type":2,"Flags":1}}}},{"2":{"Name":"VpcConnectivityTls","Properties":{"Enabled":{"Type":2,"Flags":1}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.MSK/ClusterProperties","Properties":{"Arn":{"Type":4,"Flags":18},"BrokerNodeGroupInfo":{"Type":15,"Flags":1},"ClientAuthentication":{"Type":16,"Flags":0},"ClusterName":{"Type":4,"Flags":1},"ConfigurationInfo":{"Type":18,"Flags":0},"CurrentVersion":{"Type":4,"Flags":0,"Description":"The current version of the MSK cluster"},"EncryptionInfo":{"Type":23,"Flags":0},"EnhancedMonitoring":{"Type":4,"Flags":0},"KafkaVersion":{"Type":4,"Flags":1},"LoggingInfo":{"Type":27,"Flags":0},"NumberOfBrokerNodes":{"Type":3,"Flags":1},"OpenMonitoring":{"Type":29,"Flags":0},"StorageMode":{"Type":4,"Flags":0},"Tags":{"Type":49,"Flags":0,"Description":"A key-value pair to associate with a resource."}}}},{"2":{"Name":"Cluster_Tags","Properties":{}}},{"2":{"Name":"AWS.MSK/Cluster","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":48,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.MSK/Cluster@default","ScopeType":0,"Body":50}},{"2":{"Name":"AWS.MSK/ClusterPolicyProperties","Properties":{"ClusterArn":{"Type":4,"Flags":17,"Description":"The arn of the cluster for the resource policy."},"CurrentVersion":{"Type":4,"Flags":2,"Description":"The current version of the policy attached to the specified cluster"},"Policy":{"Type":53,"Flags":1,"Description":"A policy document containing permissions to add to the specified cluster."}}}},{"2":{"Name":"ClusterPolicy_Policy","Properties":{}}},{"2":{"Name":"AWS.MSK/ClusterPolicy","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":52,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.MSK/ClusterPolicy@default","ScopeType":0,"Body":54}},{"2":{"Name":"KafkaVersionsList"}},{"2":{"Name":"LatestRevision","Properties":{"CreationTime":{"Type":4,"Flags":2},"Description":{"Type":4,"Flags":2},"Revision":{"Type":3,"Flags":2}}}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.MSK/ConfigurationProperties","Properties":{"Arn":{"Type":4,"Flags":18},"Description":{"Type":4,"Flags":0},"KafkaVersionsList":{"Type":60,"Flags":0},"LatestRevision":{"Type":57,"Flags":0},"Name":{"Type":4,"Flags":1},"ServerProperties":{"Type":4,"Flags":5}}}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.MSK/Configuration","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":59,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.MSK/Configuration@default","ScopeType":0,"Body":61}},{"2":{"Name":"AmazonMskCluster","Properties":{"MskClusterArn":{"Type":4,"Flags":1,"Description":"The ARN of an Amazon MSK cluster."}}}},{"2":{"Name":"ConsumerGroupReplication","Properties":{"ConsumerGroupsToExclude":{"Type":70,"Flags":0,"Description":"List of regular expression patterns indicating the consumer groups that should not be replicated."},"ConsumerGroupsToReplicate":{"Type":71,"Flags":1,"Description":"List of regular expression patterns indicating the consumer groups to copy."},"DetectAndCopyNewConsumerGroups":{"Type":2,"Flags":0,"Description":"Whether to periodically check for new consumer groups."},"SynchroniseConsumerGroupOffsets":{"Type":2,"Flags":0,"Description":"Whether to periodically write the translated offsets to __consumer_offsets topic in target cluster."}}}},{"2":{"Name":"KafkaCluster","Properties":{"AmazonMskCluster":{"Type":63,"Flags":1,"Description":"Details of an Amazon MSK cluster. Exactly one of AmazonMskCluster is required."},"VpcConfig":{"Type":66,"Flags":1,"Description":"Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster."}}}},{"2":{"Name":"KafkaClusterClientVpcConfig","Properties":{"SecurityGroupIds":{"Type":72,"Flags":0,"Description":"The AWS security groups to associate with the elastic network interfaces in order to specify what the replicator has access to. If a security group is not specified, the default security group associated with the VPC is used."},"SubnetIds":{"Type":73,"Flags":1,"Description":"The list of subnets to connect to in the virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets."}}}},{"2":{"Name":"ReplicationInfo","Properties":{"ConsumerGroupReplication":{"Type":64,"Flags":1,"Description":"Configuration relating to consumer group replication."},"SourceKafkaClusterArn":{"Type":4,"Flags":1,"Description":"Amazon Resource Name of the source Kafka cluster."},"TargetCompressionType":{"Type":4,"Flags":1,"Description":"The type of compression to use writing records to target Kafka cluster."},"TargetKafkaClusterArn":{"Type":4,"Flags":1,"Description":"Amazon Resource Name of the target Kafka cluster."},"TopicReplication":{"Type":69,"Flags":1,"Description":"Configuration relating to topic replication."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"TopicReplication","Properties":{"CopyAccessControlListsForTopics":{"Type":2,"Flags":0,"Description":"Whether to periodically configure remote topic ACLs to match their corresponding upstream topics."},"CopyTopicConfigurations":{"Type":2,"Flags":0,"Description":"Whether to periodically configure remote topics to match their corresponding upstream topics."},"DetectAndCopyNewTopics":{"Type":2,"Flags":0,"Description":"Whether to periodically check for new topics and partitions."},"TopicsToExclude":{"Type":74,"Flags":0,"Description":"List of regular expression patterns indicating the topics that should not be replicated."},"TopicsToReplicate":{"Type":75,"Flags":1,"Description":"List of regular expression patterns indicating the topics to copy."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.MSK/ReplicatorProperties","Properties":{"CurrentVersion":{"Type":4,"Flags":0,"Description":"The current version of the MSK replicator."},"Description":{"Type":4,"Flags":0,"Description":"A summary description of the replicator."},"KafkaClusters":{"Type":77,"Flags":1,"Description":"Specifies a list of Kafka clusters which are targets of the replicator."},"ReplicationInfoList":{"Type":78,"Flags":1,"Description":"A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow."},"ReplicatorArn":{"Type":4,"Flags":18,"Description":"Amazon Resource Name for the created replicator."},"ReplicatorName":{"Type":4,"Flags":1,"Description":"The name of the replicator."},"ServiceExecutionRoleArn":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) of the IAM role used by the replicator to access external resources."},"Tags":{"Type":79,"Flags":0,"Description":"A collection of tags associated with a resource"}}}},{"3":{"ItemType":65}},{"3":{"ItemType":67}},{"3":{"ItemType":68}},{"2":{"Name":"AWS.MSK/Replicator","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":76,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.MSK/Replicator@default","ScopeType":0,"Body":80}},{"2":{"Name":"Authentication"}},{"2":{"Name":"ClientSubnets"}},{"2":{"Name":"SecurityGroups"}},{"2":{"Name":"Tags","Properties":{}}},{"2":{"Name":"VpcId"}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.MSK/VpcConnectionProperties","Properties":{"Arn":{"Type":4,"Flags":18},"Authentication":{"Type":4,"Flags":1},"ClientSubnets":{"Type":90,"Flags":1},"SecurityGroups":{"Type":91,"Flags":1},"Tags":{"Type":85,"Flags":0},"TargetClusterArn":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) of the target cluster"},"VpcId":{"Type":4,"Flags":1}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.MSK/VpcConnection","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":89,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.MSK/VpcConnection@default","ScopeType":0,"Body":92}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "SecretArnList", + "properties": {} + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.MSK/BatchScramSecretProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "AWS.MSK/BatchScramSecretProperties", + "properties": { + "ClusterArn": { + "type": { + "$ref": "#/1" + }, + "flags": 17 + }, + "SecretArnList": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.MSK/BatchScramSecret", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.MSK/BatchScramSecret@default", + "scopeType": 0, + "body": { + "$ref": "#/6" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "BrokerLogs", + "properties": { + "CloudWatchLogs": { + "type": { + "$ref": "#/11" + }, + "flags": 0 + }, + "Firehose": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "S3": { + "type": { + "$ref": "#/27" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BrokerNodeGroupInfo", + "properties": { + "BrokerAZDistribution": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "ClientSubnets": { + "type": { + "$ref": "#/39" + }, + "flags": 1 + }, + "ConnectivityInfo": { + "type": { + "$ref": "#/13" + }, + "flags": 0 + }, + "InstanceType": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "SecurityGroups": { + "type": { + "$ref": "#/40" + }, + "flags": 0 + }, + "StorageInfo": { + "type": { + "$ref": "#/30" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ClientAuthentication", + "properties": { + "Sasl": { + "type": { + "$ref": "#/28" + }, + "flags": 0 + }, + "Tls": { + "type": { + "$ref": "#/31" + }, + "flags": 0 + }, + "Unauthenticated": { + "type": { + "$ref": "#/32" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CloudWatchLogs", + "properties": { + "Enabled": { + "type": { + "$ref": "#/41" + }, + "flags": 1 + }, + "LogGroup": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ConfigurationInfo", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 17 + }, + "Revision": { + "type": { + "$ref": "#/42" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ConnectivityInfo", + "properties": { + "PublicAccess": { + "type": { + "$ref": "#/26" + }, + "flags": 0 + }, + "VpcConnectivity": { + "type": { + "$ref": "#/33" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "EBSStorageInfo", + "properties": { + "ProvisionedThroughput": { + "type": { + "$ref": "#/25" + }, + "flags": 0 + }, + "VolumeSize": { + "type": { + "$ref": "#/42" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "EncryptionAtRest", + "properties": { + "DataVolumeKMSKeyId": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "EncryptionInTransit", + "properties": { + "ClientBroker": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "InCluster": { + "type": { + "$ref": "#/41" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "EncryptionInfo", + "properties": { + "EncryptionAtRest": { + "type": { + "$ref": "#/15" + }, + "flags": 0 + }, + "EncryptionInTransit": { + "type": { + "$ref": "#/16" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Firehose", + "properties": { + "DeliveryStream": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "Enabled": { + "type": { + "$ref": "#/41" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Iam", + "properties": { + "Enabled": { + "type": { + "$ref": "#/41" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "JmxExporter", + "properties": { + "EnabledInBroker": { + "type": { + "$ref": "#/41" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "LoggingInfo", + "properties": { + "BrokerLogs": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "NodeExporter", + "properties": { + "EnabledInBroker": { + "type": { + "$ref": "#/41" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "OpenMonitoring", + "properties": { + "Prometheus": { + "type": { + "$ref": "#/24" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Prometheus", + "properties": { + "JmxExporter": { + "type": { + "$ref": "#/20" + }, + "flags": 0 + }, + "NodeExporter": { + "type": { + "$ref": "#/22" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ProvisionedThroughput", + "properties": { + "Enabled": { + "type": { + "$ref": "#/41" + }, + "flags": 0 + }, + "VolumeThroughput": { + "type": { + "$ref": "#/42" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PublicAccess", + "properties": { + "Type": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "S3", + "properties": { + "Bucket": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "Enabled": { + "type": { + "$ref": "#/41" + }, + "flags": 1 + }, + "Prefix": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Sasl", + "properties": { + "Iam": { + "type": { + "$ref": "#/19" + }, + "flags": 0 + }, + "Scram": { + "type": { + "$ref": "#/29" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Scram", + "properties": { + "Enabled": { + "type": { + "$ref": "#/41" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "StorageInfo", + "properties": { + "EBSStorageInfo": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tls", + "properties": { + "CertificateAuthorityArnList": { + "type": { + "$ref": "#/43" + }, + "flags": 0 + }, + "Enabled": { + "type": { + "$ref": "#/41" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Unauthenticated", + "properties": { + "Enabled": { + "type": { + "$ref": "#/41" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "VpcConnectivity", + "properties": { + "ClientAuthentication": { + "type": { + "$ref": "#/34" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "VpcConnectivityClientAuthentication", + "properties": { + "Sasl": { + "type": { + "$ref": "#/36" + }, + "flags": 0 + }, + "Tls": { + "type": { + "$ref": "#/38" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "VpcConnectivityIam", + "properties": { + "Enabled": { + "type": { + "$ref": "#/41" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "VpcConnectivitySasl", + "properties": { + "Iam": { + "type": { + "$ref": "#/35" + }, + "flags": 0 + }, + "Scram": { + "type": { + "$ref": "#/37" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "VpcConnectivityScram", + "properties": { + "Enabled": { + "type": { + "$ref": "#/41" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "VpcConnectivityTls", + "properties": { + "Enabled": { + "type": { + "$ref": "#/41" + }, + "flags": 1 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.MSK/ClusterProperties" + }, + { + "$type": "ObjectType", + "name": "Cluster_Tags", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AWS.MSK/ClusterProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 18 + }, + "BrokerNodeGroupInfo": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + }, + "ClientAuthentication": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "ClusterName": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "ConfigurationInfo": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + }, + "CurrentVersion": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The current version of the MSK cluster" + }, + "EncryptionInfo": { + "type": { + "$ref": "#/17" + }, + "flags": 0 + }, + "EnhancedMonitoring": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "KafkaVersion": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "LoggingInfo": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "NumberOfBrokerNodes": { + "type": { + "$ref": "#/42" + }, + "flags": 1 + }, + "OpenMonitoring": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "StorageMode": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/45" + }, + "flags": 0, + "description": "A key-value pair to associate with a resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.MSK/Cluster", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/46" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.MSK/Cluster@default", + "scopeType": 0, + "body": { + "$ref": "#/47" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.MSK/ClusterPolicyProperties" + }, + { + "$type": "ObjectType", + "name": "ClusterPolicy_Policy", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AWS.MSK/ClusterPolicyProperties", + "properties": { + "ClusterArn": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The arn of the cluster for the resource policy." + }, + "CurrentVersion": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The current version of the policy attached to the specified cluster" + }, + "Policy": { + "type": { + "$ref": "#/50" + }, + "flags": 1, + "description": "A policy document containing permissions to add to the specified cluster." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.MSK/ClusterPolicy", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/51" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.MSK/ClusterPolicy@default", + "scopeType": 0, + "body": { + "$ref": "#/52" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "KafkaVersionsList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LatestRevision", + "properties": { + "CreationTime": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "Revision": { + "type": { + "$ref": "#/42" + }, + "flags": 2 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.MSK/ConfigurationProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "AWS.MSK/ConfigurationProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 18 + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "KafkaVersionsList": { + "type": { + "$ref": "#/58" + }, + "flags": 0 + }, + "LatestRevision": { + "type": { + "$ref": "#/55" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "ServerProperties": { + "type": { + "$ref": "#/1" + }, + "flags": 5 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.MSK/Configuration", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/59" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.MSK/Configuration@default", + "scopeType": 0, + "body": { + "$ref": "#/60" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AmazonMskCluster", + "properties": { + "MskClusterArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The ARN of an Amazon MSK cluster." + } + } + }, + { + "$type": "ObjectType", + "name": "ConsumerGroupReplication", + "properties": { + "ConsumerGroupsToExclude": { + "type": { + "$ref": "#/71" + }, + "flags": 0, + "description": "List of regular expression patterns indicating the consumer groups that should not be replicated." + }, + "ConsumerGroupsToReplicate": { + "type": { + "$ref": "#/72" + }, + "flags": 1, + "description": "List of regular expression patterns indicating the consumer groups to copy." + }, + "DetectAndCopyNewConsumerGroups": { + "type": { + "$ref": "#/41" + }, + "flags": 0, + "description": "Whether to periodically check for new consumer groups." + }, + "SynchroniseConsumerGroupOffsets": { + "type": { + "$ref": "#/41" + }, + "flags": 0, + "description": "Whether to periodically write the translated offsets to __consumer_offsets topic in target cluster." + } + } + }, + { + "$type": "ObjectType", + "name": "KafkaCluster", + "properties": { + "AmazonMskCluster": { + "type": { + "$ref": "#/62" + }, + "flags": 1, + "description": "Details of an Amazon MSK cluster. Exactly one of AmazonMskCluster is required." + }, + "VpcConfig": { + "type": { + "$ref": "#/65" + }, + "flags": 1, + "description": "Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster." + } + } + }, + { + "$type": "ObjectType", + "name": "KafkaClusterClientVpcConfig", + "properties": { + "SecurityGroupIds": { + "type": { + "$ref": "#/73" + }, + "flags": 0, + "description": "The AWS security groups to associate with the elastic network interfaces in order to specify what the replicator has access to. If a security group is not specified, the default security group associated with the VPC is used." + }, + "SubnetIds": { + "type": { + "$ref": "#/74" + }, + "flags": 1, + "description": "The list of subnets to connect to in the virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets." + } + } + }, + { + "$type": "ObjectType", + "name": "ReplicationInfo", + "properties": { + "ConsumerGroupReplication": { + "type": { + "$ref": "#/63" + }, + "flags": 1, + "description": "Configuration relating to consumer group replication." + }, + "SourceKafkaClusterArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Amazon Resource Name of the source Kafka cluster." + }, + "TargetCompressionType": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The type of compression to use writing records to target Kafka cluster." + }, + "TargetKafkaClusterArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Amazon Resource Name of the target Kafka cluster." + }, + "TopicReplication": { + "type": { + "$ref": "#/70" + }, + "flags": 1, + "description": "Configuration relating to topic replication." + } + } + }, + { + "$type": "ObjectType", + "name": "ReplicationStartingPosition", + "properties": { + "Type": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ReplicationStartingPositionType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TopicReplication", + "properties": { + "CopyAccessControlListsForTopics": { + "type": { + "$ref": "#/41" + }, + "flags": 0, + "description": "Whether to periodically configure remote topic ACLs to match their corresponding upstream topics." + }, + "CopyTopicConfigurations": { + "type": { + "$ref": "#/41" + }, + "flags": 0, + "description": "Whether to periodically configure remote topics to match their corresponding upstream topics." + }, + "DetectAndCopyNewTopics": { + "type": { + "$ref": "#/41" + }, + "flags": 0, + "description": "Whether to periodically check for new topics and partitions." + }, + "StartingPosition": { + "type": { + "$ref": "#/67" + }, + "flags": 0, + "description": "Configuration for specifying the position in the topics to start replicating from." + }, + "TopicsToExclude": { + "type": { + "$ref": "#/75" + }, + "flags": 0, + "description": "List of regular expression patterns indicating the topics that should not be replicated." + }, + "TopicsToReplicate": { + "type": { + "$ref": "#/76" + }, + "flags": 1, + "description": "List of regular expression patterns indicating the topics to copy." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.MSK/ReplicatorProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/64" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/66" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/69" + } + }, + { + "$type": "ObjectType", + "name": "AWS.MSK/ReplicatorProperties", + "properties": { + "CurrentVersion": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The current version of the MSK replicator." + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A summary description of the replicator." + }, + "KafkaClusters": { + "type": { + "$ref": "#/78" + }, + "flags": 1, + "description": "Specifies a list of Kafka clusters which are targets of the replicator." + }, + "ReplicationInfoList": { + "type": { + "$ref": "#/79" + }, + "flags": 1, + "description": "A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow." + }, + "ReplicatorArn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "Amazon Resource Name for the created replicator." + }, + "ReplicatorName": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The name of the replicator." + }, + "ServiceExecutionRoleArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of the IAM role used by the replicator to access external resources." + }, + "Tags": { + "type": { + "$ref": "#/80" + }, + "flags": 0, + "description": "A collection of tags associated with a resource" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.MSK/Replicator", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/81" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.MSK/Replicator@default", + "scopeType": 0, + "body": { + "$ref": "#/82" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Authentication", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ClientSubnets", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SecurityGroups", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tags", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "VpcId", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.MSK/VpcConnectionProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "AWS.MSK/VpcConnectionProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 18 + }, + "Authentication": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "ClientSubnets": { + "type": { + "$ref": "#/92" + }, + "flags": 1 + }, + "SecurityGroups": { + "type": { + "$ref": "#/93" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/87" + }, + "flags": 0 + }, + "TargetClusterArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of the target cluster" + }, + "VpcId": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.MSK/VpcConnection", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/94" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.MSK/VpcConnection@default", + "scopeType": 0, + "body": { + "$ref": "#/95" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.msk/default/types.md b/artifacts/bicep/aws/aws.msk/default/types.md index 5f4c9609..ea399856 100644 --- a/artifacts/bicep/aws/aws.msk/default/types.md +++ b/artifacts/bicep/aws/aws.msk/default/types.md @@ -3,50 +3,60 @@ ## Resource AWS.MSK/BatchScramSecret@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.MSK/BatchScramSecretProperties](#awsmskbatchscramsecretproperties) (Required): properties of the resource +* **properties**: [AWS.MSK/BatchScramSecretProperties](#awsmskbatchscramsecretproperties) (Required, Identifier): properties of the resource ## Resource AWS.MSK/Cluster@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.MSK/ClusterProperties](#awsmskclusterproperties) (Required): properties of the resource +* **properties**: [AWS.MSK/ClusterProperties](#awsmskclusterproperties) (Required, Identifier): properties of the resource ## Resource AWS.MSK/ClusterPolicy@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.MSK/ClusterPolicyProperties](#awsmskclusterpolicyproperties) (Required): properties of the resource +* **properties**: [AWS.MSK/ClusterPolicyProperties](#awsmskclusterpolicyproperties) (Required, Identifier): properties of the resource ## Resource AWS.MSK/Configuration@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.MSK/ConfigurationProperties](#awsmskconfigurationproperties) (Required): properties of the resource +* **properties**: [AWS.MSK/ConfigurationProperties](#awsmskconfigurationproperties) (Required, Identifier): properties of the resource ## Resource AWS.MSK/Replicator@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.MSK/ReplicatorProperties](#awsmskreplicatorproperties) (Required): properties of the resource +* **properties**: [AWS.MSK/ReplicatorProperties](#awsmskreplicatorproperties) (Required, Identifier): properties of the resource ## Resource AWS.MSK/VpcConnection@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.MSK/VpcConnectionProperties](#awsmskvpcconnectionproperties) (Required): properties of the resource +* **properties**: [AWS.MSK/VpcConnectionProperties](#awsmskvpcconnectionproperties) (Required, Identifier): properties of the resource + +## AmazonMskCluster +### Properties +* **MskClusterArn**: string (Required): The ARN of an Amazon MSK cluster. ## AWS.MSK/BatchScramSecretProperties ### Properties * **ClusterArn**: string (Required, Identifier) * **SecretArnList**: string[] +## AWS.MSK/ClusterPolicyProperties +### Properties +* **ClusterArn**: string (Required, Identifier): The arn of the cluster for the resource policy. +* **CurrentVersion**: string (ReadOnly): The current version of the policy attached to the specified cluster +* **Policy**: [ClusterPolicy_Policy](#clusterpolicypolicy) (Required): A policy document containing permissions to add to the specified cluster. + ## AWS.MSK/ClusterProperties ### Properties * **Arn**: string (ReadOnly, Identifier) @@ -64,6 +74,42 @@ * **StorageMode**: string * **Tags**: [Cluster_Tags](#clustertags): A key-value pair to associate with a resource. +## AWS.MSK/ConfigurationProperties +### Properties +* **Arn**: string (ReadOnly, Identifier) +* **Description**: string +* **KafkaVersionsList**: string[] +* **LatestRevision**: [LatestRevision](#latestrevision) +* **Name**: string (Required) +* **ServerProperties**: string (Required, WriteOnly) + +## AWS.MSK/ReplicatorProperties +### Properties +* **CurrentVersion**: string: The current version of the MSK replicator. +* **Description**: string: A summary description of the replicator. +* **KafkaClusters**: [KafkaCluster](#kafkacluster)[] (Required): Specifies a list of Kafka clusters which are targets of the replicator. +* **ReplicationInfoList**: [ReplicationInfo](#replicationinfo)[] (Required): A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow. +* **ReplicatorArn**: string (ReadOnly, Identifier): Amazon Resource Name for the created replicator. +* **ReplicatorName**: string (Required): The name of the replicator. +* **ServiceExecutionRoleArn**: string (Required): The Amazon Resource Name (ARN) of the IAM role used by the replicator to access external resources. +* **Tags**: [Tag](#tag)[]: A collection of tags associated with a resource + +## AWS.MSK/VpcConnectionProperties +### Properties +* **Arn**: string (ReadOnly, Identifier) +* **Authentication**: string (Required) +* **ClientSubnets**: string[] (Required) +* **SecurityGroups**: string[] (Required) +* **Tags**: [Tags](#tags) +* **TargetClusterArn**: string (Required): The Amazon Resource Name (ARN) of the target cluster +* **VpcId**: string (Required) + +## BrokerLogs +### Properties +* **CloudWatchLogs**: [CloudWatchLogs](#cloudwatchlogs) +* **Firehose**: [Firehose](#firehose) +* **S3**: [S3](#s3) + ## BrokerNodeGroupInfo ### Properties * **BrokerAZDistribution**: string @@ -73,127 +119,95 @@ * **SecurityGroups**: string[] * **StorageInfo**: [StorageInfo](#storageinfo) -## ConnectivityInfo -### Properties -* **PublicAccess**: [PublicAccess](#publicaccess) -* **VpcConnectivity**: [VpcConnectivity](#vpcconnectivity) - -## PublicAccess -### Properties -* **Type**: string - -## VpcConnectivity +## ClientAuthentication ### Properties -* **ClientAuthentication**: [VpcConnectivityClientAuthentication](#vpcconnectivityclientauthentication) +* **Sasl**: [Sasl](#sasl) +* **Tls**: [Tls](#tls) +* **Unauthenticated**: [Unauthenticated](#unauthenticated) -## VpcConnectivityClientAuthentication +## CloudWatchLogs ### Properties -* **Sasl**: [VpcConnectivitySasl](#vpcconnectivitysasl) -* **Tls**: [VpcConnectivityTls](#vpcconnectivitytls) +* **Enabled**: bool (Required) +* **LogGroup**: string -## VpcConnectivitySasl +## Cluster_Tags ### Properties -* **Iam**: [VpcConnectivityIam](#vpcconnectivityiam) -* **Scram**: [VpcConnectivityScram](#vpcconnectivityscram) -## VpcConnectivityIam +## ClusterPolicy_Policy ### Properties -* **Enabled**: bool (Required) -## VpcConnectivityScram +## ConfigurationInfo ### Properties -* **Enabled**: bool (Required) +* **Arn**: string (Required, Identifier) +* **Revision**: int (Required) -## VpcConnectivityTls +## ConnectivityInfo ### Properties -* **Enabled**: bool (Required) +* **PublicAccess**: [PublicAccess](#publicaccess) +* **VpcConnectivity**: [VpcConnectivity](#vpcconnectivity) -## StorageInfo +## ConsumerGroupReplication ### Properties -* **EBSStorageInfo**: [EBSStorageInfo](#ebsstorageinfo) +* **ConsumerGroupsToExclude**: string[]: List of regular expression patterns indicating the consumer groups that should not be replicated. +* **ConsumerGroupsToReplicate**: string[] (Required): List of regular expression patterns indicating the consumer groups to copy. +* **DetectAndCopyNewConsumerGroups**: bool: Whether to periodically check for new consumer groups. +* **SynchroniseConsumerGroupOffsets**: bool: Whether to periodically write the translated offsets to __consumer_offsets topic in target cluster. ## EBSStorageInfo ### Properties * **ProvisionedThroughput**: [ProvisionedThroughput](#provisionedthroughput) * **VolumeSize**: int -## ProvisionedThroughput -### Properties -* **Enabled**: bool -* **VolumeThroughput**: int - -## ClientAuthentication +## EncryptionAtRest ### Properties -* **Sasl**: [Sasl](#sasl) -* **Tls**: [Tls](#tls) -* **Unauthenticated**: [Unauthenticated](#unauthenticated) +* **DataVolumeKMSKeyId**: string (Required) -## Sasl +## EncryptionInfo ### Properties -* **Iam**: [Iam](#iam) -* **Scram**: [Scram](#scram) +* **EncryptionAtRest**: [EncryptionAtRest](#encryptionatrest) +* **EncryptionInTransit**: [EncryptionInTransit](#encryptionintransit) -## Iam +## EncryptionInTransit ### Properties -* **Enabled**: bool (Required) +* **ClientBroker**: string +* **InCluster**: bool -## Scram +## Firehose ### Properties +* **DeliveryStream**: string * **Enabled**: bool (Required) -## Tls -### Properties -* **CertificateAuthorityArnList**: string[] -* **Enabled**: bool - -## Unauthenticated +## Iam ### Properties * **Enabled**: bool (Required) -## ConfigurationInfo +## JmxExporter ### Properties -* **Arn**: string (Required, Identifier) -* **Revision**: int (Required) +* **EnabledInBroker**: bool (Required) -## EncryptionInfo +## KafkaCluster ### Properties -* **EncryptionAtRest**: [EncryptionAtRest](#encryptionatrest) -* **EncryptionInTransit**: [EncryptionInTransit](#encryptionintransit) +* **AmazonMskCluster**: [AmazonMskCluster](#amazonmskcluster) (Required): Details of an Amazon MSK cluster. Exactly one of AmazonMskCluster is required. +* **VpcConfig**: [KafkaClusterClientVpcConfig](#kafkaclusterclientvpcconfig) (Required): Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster. -## EncryptionAtRest +## KafkaClusterClientVpcConfig ### Properties -* **DataVolumeKMSKeyId**: string (Required) +* **SecurityGroupIds**: string[]: The AWS security groups to associate with the elastic network interfaces in order to specify what the replicator has access to. If a security group is not specified, the default security group associated with the VPC is used. +* **SubnetIds**: string[] (Required): The list of subnets to connect to in the virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets. -## EncryptionInTransit +## LatestRevision ### Properties -* **ClientBroker**: string -* **InCluster**: bool +* **CreationTime**: string (ReadOnly) +* **Description**: string (ReadOnly) +* **Revision**: int (ReadOnly) ## LoggingInfo ### Properties * **BrokerLogs**: [BrokerLogs](#brokerlogs) (Required) -## BrokerLogs -### Properties -* **CloudWatchLogs**: [CloudWatchLogs](#cloudwatchlogs) -* **Firehose**: [Firehose](#firehose) -* **S3**: [S3](#s3) - -## CloudWatchLogs -### Properties -* **Enabled**: bool (Required) -* **LogGroup**: string - -## Firehose -### Properties -* **DeliveryStream**: string -* **Enabled**: bool (Required) - -## S3 +## NodeExporter ### Properties -* **Bucket**: string -* **Enabled**: bool (Required) -* **Prefix**: string +* **EnabledInBroker**: bool (Required) ## OpenMonitoring ### Properties @@ -204,104 +218,95 @@ * **JmxExporter**: [JmxExporter](#jmxexporter) * **NodeExporter**: [NodeExporter](#nodeexporter) -## JmxExporter -### Properties -* **EnabledInBroker**: bool (Required) - -## NodeExporter -### Properties -* **EnabledInBroker**: bool (Required) - -## Cluster_Tags +## ProvisionedThroughput ### Properties +* **Enabled**: bool +* **VolumeThroughput**: int -## AWS.MSK/ClusterPolicyProperties +## PublicAccess ### Properties -* **ClusterArn**: string (Required, Identifier): The arn of the cluster for the resource policy. -* **CurrentVersion**: string (ReadOnly): The current version of the policy attached to the specified cluster -* **Policy**: [ClusterPolicy_Policy](#clusterpolicypolicy) (Required): A policy document containing permissions to add to the specified cluster. +* **Type**: string -## ClusterPolicy_Policy +## ReplicationInfo ### Properties +* **ConsumerGroupReplication**: [ConsumerGroupReplication](#consumergroupreplication) (Required): Configuration relating to consumer group replication. +* **SourceKafkaClusterArn**: string (Required): Amazon Resource Name of the source Kafka cluster. +* **TargetCompressionType**: string (Required): The type of compression to use writing records to target Kafka cluster. +* **TargetKafkaClusterArn**: string (Required): Amazon Resource Name of the target Kafka cluster. +* **TopicReplication**: [TopicReplication](#topicreplication) (Required): Configuration relating to topic replication. -## AWS.MSK/ConfigurationProperties +## ReplicationStartingPosition ### Properties -* **Arn**: string (ReadOnly, Identifier) -* **Description**: string -* **KafkaVersionsList**: string[] -* **LatestRevision**: [LatestRevision](#latestrevision) -* **Name**: string (Required) -* **ServerProperties**: string (Required, WriteOnly) +* **Type**: string -## LatestRevision +## S3 ### Properties -* **CreationTime**: string (ReadOnly) -* **Description**: string (ReadOnly) -* **Revision**: int (ReadOnly) +* **Bucket**: string +* **Enabled**: bool (Required) +* **Prefix**: string -## AWS.MSK/ReplicatorProperties +## Sasl ### Properties -* **CurrentVersion**: string: The current version of the MSK replicator. -* **Description**: string: A summary description of the replicator. -* **KafkaClusters**: [KafkaCluster](#kafkacluster)[] (Required): Specifies a list of Kafka clusters which are targets of the replicator. -* **ReplicationInfoList**: [ReplicationInfo](#replicationinfo)[] (Required): A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow. -* **ReplicatorArn**: string (ReadOnly, Identifier): Amazon Resource Name for the created replicator. -* **ReplicatorName**: string (Required): The name of the replicator. -* **ServiceExecutionRoleArn**: string (Required): The Amazon Resource Name (ARN) of the IAM role used by the replicator to access external resources. -* **Tags**: [Tag](#tag)[]: A collection of tags associated with a resource +* **Iam**: [Iam](#iam) +* **Scram**: [Scram](#scram) -## KafkaCluster +## Scram ### Properties -* **AmazonMskCluster**: [AmazonMskCluster](#amazonmskcluster) (Required): Details of an Amazon MSK cluster. Exactly one of AmazonMskCluster is required. -* **VpcConfig**: [KafkaClusterClientVpcConfig](#kafkaclusterclientvpcconfig) (Required): Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster. +* **Enabled**: bool (Required) -## AmazonMskCluster +## StorageInfo ### Properties -* **MskClusterArn**: string (Required): The ARN of an Amazon MSK cluster. +* **EBSStorageInfo**: [EBSStorageInfo](#ebsstorageinfo) -## KafkaClusterClientVpcConfig +## Tag ### Properties -* **SecurityGroupIds**: string[]: The AWS security groups to associate with the elastic network interfaces in order to specify what the replicator has access to. If a security group is not specified, the default security group associated with the VPC is used. -* **SubnetIds**: string[] (Required): The list of subnets to connect to in the virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets. +* **Key**: string (Required) +* **Value**: string (Required) -## ReplicationInfo +## Tags ### Properties -* **ConsumerGroupReplication**: [ConsumerGroupReplication](#consumergroupreplication) (Required): Configuration relating to consumer group replication. -* **SourceKafkaClusterArn**: string (Required): Amazon Resource Name of the source Kafka cluster. -* **TargetCompressionType**: string (Required): The type of compression to use writing records to target Kafka cluster. -* **TargetKafkaClusterArn**: string (Required): Amazon Resource Name of the target Kafka cluster. -* **TopicReplication**: [TopicReplication](#topicreplication) (Required): Configuration relating to topic replication. -## ConsumerGroupReplication +## Tls ### Properties -* **ConsumerGroupsToExclude**: string[]: List of regular expression patterns indicating the consumer groups that should not be replicated. -* **ConsumerGroupsToReplicate**: string[] (Required): List of regular expression patterns indicating the consumer groups to copy. -* **DetectAndCopyNewConsumerGroups**: bool: Whether to periodically check for new consumer groups. -* **SynchroniseConsumerGroupOffsets**: bool: Whether to periodically write the translated offsets to __consumer_offsets topic in target cluster. +* **CertificateAuthorityArnList**: string[] +* **Enabled**: bool ## TopicReplication ### Properties * **CopyAccessControlListsForTopics**: bool: Whether to periodically configure remote topic ACLs to match their corresponding upstream topics. * **CopyTopicConfigurations**: bool: Whether to periodically configure remote topics to match their corresponding upstream topics. * **DetectAndCopyNewTopics**: bool: Whether to periodically check for new topics and partitions. +* **StartingPosition**: [ReplicationStartingPosition](#replicationstartingposition): Configuration for specifying the position in the topics to start replicating from. * **TopicsToExclude**: string[]: List of regular expression patterns indicating the topics that should not be replicated. * **TopicsToReplicate**: string[] (Required): List of regular expression patterns indicating the topics to copy. -## Tag +## Unauthenticated ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **Enabled**: bool (Required) -## AWS.MSK/VpcConnectionProperties +## VpcConnectivity ### Properties -* **Arn**: string (ReadOnly, Identifier) -* **Authentication**: string (Required) -* **ClientSubnets**: string[] (Required) -* **SecurityGroups**: string[] (Required) -* **Tags**: [Tags](#tags) -* **TargetClusterArn**: string (Required): The Amazon Resource Name (ARN) of the target cluster -* **VpcId**: string (Required) +* **ClientAuthentication**: [VpcConnectivityClientAuthentication](#vpcconnectivityclientauthentication) -## Tags +## VpcConnectivityClientAuthentication ### Properties +* **Sasl**: [VpcConnectivitySasl](#vpcconnectivitysasl) +* **Tls**: [VpcConnectivityTls](#vpcconnectivitytls) + +## VpcConnectivityIam +### Properties +* **Enabled**: bool (Required) + +## VpcConnectivitySasl +### Properties +* **Iam**: [VpcConnectivityIam](#vpcconnectivityiam) +* **Scram**: [VpcConnectivityScram](#vpcconnectivityscram) + +## VpcConnectivityScram +### Properties +* **Enabled**: bool (Required) + +## VpcConnectivityTls +### Properties +* **Enabled**: bool (Required) diff --git a/artifacts/bicep/aws/aws.mwaa/default/types.json b/artifacts/bicep/aws/aws.mwaa/default/types.json index 5de2bed0..d354e39d 100644 --- a/artifacts/bicep/aws/aws.mwaa/default/types.json +++ b/artifacts/bicep/aws/aws.mwaa/default/types.json @@ -1 +1,617 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"AirflowArn"}},{"2":{"Name":"AirflowVersion"}},{"2":{"Name":"CeleryExecutorQueue"}},{"2":{"Name":"CloudWatchLogGroupArn"}},{"2":{"Name":"ConfigKey"}},{"2":{"Name":"ConfigValue"}},{"2":{"Name":"CreatedAt"}},{"2":{"Name":"DatabaseVpcEndpointService"}},{"2":{"Name":"EndpointManagement"}},{"2":{"Name":"EnvironmentArn"}},{"2":{"Name":"EnvironmentClass"}},{"2":{"Name":"EnvironmentName"}},{"2":{"Name":"EnvironmentStatus"}},{"2":{"Name":"ErrorCode"}},{"2":{"Name":"ErrorMessage"}},{"2":{"Name":"ExecutionRoleArn"}},{"2":{"Name":"KmsKey"}},{"2":{"Name":"LastUpdate","Properties":{"CreatedAt":{"Type":4,"Flags":0},"Error":{"Type":43,"Flags":0},"Status":{"Type":4,"Flags":0}}}},{"2":{"Name":"LoggingConfiguration","Properties":{"DagProcessingLogs":{"Type":32,"Flags":0},"SchedulerLogs":{"Type":32,"Flags":0},"TaskLogs":{"Type":32,"Flags":0},"WebserverLogs":{"Type":32,"Flags":0},"WorkerLogs":{"Type":32,"Flags":0}}}},{"2":{"Name":"LoggingConfigurationInput","Properties":{"DagProcessingLogs":{"Type":33,"Flags":0},"SchedulerLogs":{"Type":33,"Flags":0},"TaskLogs":{"Type":33,"Flags":0},"WebserverLogs":{"Type":33,"Flags":0},"WorkerLogs":{"Type":33,"Flags":0}}}},{"2":{"Name":"LoggingEnabled"}},{"2":{"Name":"LoggingLevel"}},{"2":{"Name":"MaxWorkers"}},{"2":{"Name":"MinWorkers"}},{"2":{"Name":"ModuleLoggingConfiguration","Properties":{"CloudWatchLogGroupArn":{"Type":4,"Flags":2},"Enabled":{"Type":2,"Flags":0},"LogLevel":{"Type":4,"Flags":0}}}},{"2":{"Name":"ModuleLoggingConfigurationInput","Properties":{"Enabled":{"Type":2,"Flags":0},"LogLevel":{"Type":4,"Flags":0}}}},{"2":{"Name":"NetworkConfiguration","Properties":{"SecurityGroupIds":{"Type":49,"Flags":0,"Description":"A list of security groups to use for the environment."},"SubnetIds":{"Type":50,"Flags":0,"Description":"A list of subnets to use for the environment. These must be private subnets, in the same VPC, in two different availability zones."}}}},{"2":{"Name":"RelativePath"}},{"2":{"Name":"S3BucketArn"}},{"2":{"Name":"S3ObjectVersion"}},{"2":{"Name":"Schedulers"}},{"2":{"Name":"SecurityGroupId"}},{"2":{"Name":"ServiceRoleArn"}},{"2":{"Name":"SubnetId"}},{"2":{"Name":"UpdateCreatedAt"}},{"2":{"Name":"UpdateError","Properties":{"ErrorCode":{"Type":4,"Flags":0},"ErrorMessage":{"Type":4,"Flags":0}}}},{"2":{"Name":"UpdateStatus"}},{"2":{"Name":"WebserverAccessMode"}},{"2":{"Name":"WebserverUrl"}},{"2":{"Name":"WebserverVpcEndpointService"}},{"2":{"Name":"WeeklyMaintenanceWindowStart"}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.MWAA/EnvironmentProperties","Properties":{"AirflowConfigurationOptions":{"Type":52,"Flags":0,"Description":"Key/value pairs representing Airflow configuration variables.\n Keys are prefixed by their section:\n\n [core]\n dags_folder={AIRFLOW_HOME}/dags\n\n Would be represented as\n\n \"core.dags_folder\": \"{AIRFLOW_HOME}/dags\""},"AirflowVersion":{"Type":4,"Flags":0},"Arn":{"Type":4,"Flags":2},"CeleryExecutorQueue":{"Type":4,"Flags":2},"DagS3Path":{"Type":4,"Flags":0},"DatabaseVpcEndpointService":{"Type":4,"Flags":2},"EndpointManagement":{"Type":4,"Flags":0},"EnvironmentClass":{"Type":4,"Flags":0},"ExecutionRoleArn":{"Type":4,"Flags":0},"KmsKey":{"Type":4,"Flags":0},"LoggingConfiguration":{"Type":26,"Flags":0},"MaxWorkers":{"Type":3,"Flags":0},"MinWorkers":{"Type":3,"Flags":0},"Name":{"Type":4,"Flags":17},"NetworkConfiguration":{"Type":34,"Flags":0},"PluginsS3ObjectVersion":{"Type":4,"Flags":0},"PluginsS3Path":{"Type":4,"Flags":0},"RequirementsS3ObjectVersion":{"Type":4,"Flags":0},"RequirementsS3Path":{"Type":4,"Flags":0},"Schedulers":{"Type":3,"Flags":0},"SourceBucketArn":{"Type":4,"Flags":0},"StartupScriptS3ObjectVersion":{"Type":4,"Flags":0},"StartupScriptS3Path":{"Type":4,"Flags":0},"Tags":{"Type":53,"Flags":0,"Description":"A map of tags for the environment."},"WebserverAccessMode":{"Type":4,"Flags":0},"WebserverUrl":{"Type":4,"Flags":2},"WebserverVpcEndpointService":{"Type":4,"Flags":2},"WeeklyMaintenanceWindowStart":{"Type":4,"Flags":0}}}},{"2":{"Name":"Environment_AirflowConfigurationOptions","Properties":{}}},{"2":{"Name":"Environment_Tags","Properties":{}}},{"2":{"Name":"AWS.MWAA/Environment","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":51,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.MWAA/Environment@default","ScopeType":0,"Body":54}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "AirflowArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AirflowVersion", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CeleryExecutorQueue", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CloudWatchLogGroupArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ConfigKey", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ConfigValue", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CreatedAt", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DatabaseVpcEndpointService", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "EndpointManagement", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "EnvironmentArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "EnvironmentClass", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "EnvironmentName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "EnvironmentStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ErrorCode", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ErrorMessage", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ExecutionRoleArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "KmsKey", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LastUpdate", + "properties": { + "CreatedAt": { + "type": { + "$ref": "#/43" + }, + "flags": 0 + }, + "Error": { + "type": { + "$ref": "#/37" + }, + "flags": 0 + }, + "Status": { + "type": { + "$ref": "#/43" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "LoggingConfiguration", + "properties": { + "DagProcessingLogs": { + "type": { + "$ref": "#/26" + }, + "flags": 0 + }, + "SchedulerLogs": { + "type": { + "$ref": "#/26" + }, + "flags": 0 + }, + "TaskLogs": { + "type": { + "$ref": "#/26" + }, + "flags": 0 + }, + "WebserverLogs": { + "type": { + "$ref": "#/26" + }, + "flags": 0 + }, + "WorkerLogs": { + "type": { + "$ref": "#/26" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "LoggingConfigurationInput", + "properties": { + "DagProcessingLogs": { + "type": { + "$ref": "#/27" + }, + "flags": 0 + }, + "SchedulerLogs": { + "type": { + "$ref": "#/27" + }, + "flags": 0 + }, + "TaskLogs": { + "type": { + "$ref": "#/27" + }, + "flags": 0 + }, + "WebserverLogs": { + "type": { + "$ref": "#/27" + }, + "flags": 0 + }, + "WorkerLogs": { + "type": { + "$ref": "#/27" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "LoggingEnabled", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LoggingLevel", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MaxWebservers", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MaxWorkers", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MinWebservers", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MinWorkers", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ModuleLoggingConfiguration", + "properties": { + "CloudWatchLogGroupArn": { + "type": { + "$ref": "#/43" + }, + "flags": 2 + }, + "Enabled": { + "type": { + "$ref": "#/44" + }, + "flags": 0 + }, + "LogLevel": { + "type": { + "$ref": "#/43" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ModuleLoggingConfigurationInput", + "properties": { + "Enabled": { + "type": { + "$ref": "#/44" + }, + "flags": 0 + }, + "LogLevel": { + "type": { + "$ref": "#/43" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "NetworkConfiguration", + "properties": { + "SecurityGroupIds": { + "type": { + "$ref": "#/46" + }, + "flags": 0, + "description": "A list of security groups to use for the environment." + }, + "SubnetIds": { + "type": { + "$ref": "#/47" + }, + "flags": 0, + "description": "A list of subnets to use for the environment. These must be private subnets, in the same VPC, in two different availability zones." + } + } + }, + { + "$type": "ObjectType", + "name": "RelativePath", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "S3BucketArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "S3ObjectVersion", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Schedulers", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SecurityGroupId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ServiceRoleArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SubnetId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "UpdateCreatedAt", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "UpdateError", + "properties": { + "ErrorCode": { + "type": { + "$ref": "#/43" + }, + "flags": 0 + }, + "ErrorMessage": { + "type": { + "$ref": "#/43" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "UpdateStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "WebserverAccessMode", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "WebserverUrl", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "WebserverVpcEndpointService", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "WeeklyMaintenanceWindowStart", + "properties": {} + }, + { + "$type": "StringType" + }, + { + "$type": "BooleanType" + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/43" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/43" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.MWAA/EnvironmentProperties" + }, + { + "$type": "ObjectType", + "name": "Environment_AirflowConfigurationOptions", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Environment_Tags", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AWS.MWAA/EnvironmentProperties", + "properties": { + "AirflowConfigurationOptions": { + "type": { + "$ref": "#/49" + }, + "flags": 0, + "description": "Key/value pairs representing Airflow configuration variables.\n Keys are prefixed by their section:\n\n [core]\n dags_folder={AIRFLOW_HOME}/dags\n\n Would be represented as\n\n \"core.dags_folder\": \"{AIRFLOW_HOME}/dags\"" + }, + "AirflowVersion": { + "type": { + "$ref": "#/43" + }, + "flags": 0 + }, + "Arn": { + "type": { + "$ref": "#/43" + }, + "flags": 2 + }, + "CeleryExecutorQueue": { + "type": { + "$ref": "#/43" + }, + "flags": 2 + }, + "DagS3Path": { + "type": { + "$ref": "#/43" + }, + "flags": 0 + }, + "DatabaseVpcEndpointService": { + "type": { + "$ref": "#/43" + }, + "flags": 2 + }, + "EndpointManagement": { + "type": { + "$ref": "#/43" + }, + "flags": 0 + }, + "EnvironmentClass": { + "type": { + "$ref": "#/43" + }, + "flags": 0 + }, + "ExecutionRoleArn": { + "type": { + "$ref": "#/43" + }, + "flags": 0 + }, + "KmsKey": { + "type": { + "$ref": "#/43" + }, + "flags": 0 + }, + "LoggingConfiguration": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "MaxWebservers": { + "type": { + "$ref": "#/45" + }, + "flags": 0 + }, + "MaxWorkers": { + "type": { + "$ref": "#/45" + }, + "flags": 0 + }, + "MinWebservers": { + "type": { + "$ref": "#/45" + }, + "flags": 0 + }, + "MinWorkers": { + "type": { + "$ref": "#/45" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/43" + }, + "flags": 17 + }, + "NetworkConfiguration": { + "type": { + "$ref": "#/28" + }, + "flags": 0 + }, + "PluginsS3ObjectVersion": { + "type": { + "$ref": "#/43" + }, + "flags": 0 + }, + "PluginsS3Path": { + "type": { + "$ref": "#/43" + }, + "flags": 0 + }, + "RequirementsS3ObjectVersion": { + "type": { + "$ref": "#/43" + }, + "flags": 0 + }, + "RequirementsS3Path": { + "type": { + "$ref": "#/43" + }, + "flags": 0 + }, + "Schedulers": { + "type": { + "$ref": "#/45" + }, + "flags": 0 + }, + "SourceBucketArn": { + "type": { + "$ref": "#/43" + }, + "flags": 0 + }, + "StartupScriptS3ObjectVersion": { + "type": { + "$ref": "#/43" + }, + "flags": 0 + }, + "StartupScriptS3Path": { + "type": { + "$ref": "#/43" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/50" + }, + "flags": 0, + "description": "A map of tags for the environment." + }, + "WebserverAccessMode": { + "type": { + "$ref": "#/43" + }, + "flags": 0 + }, + "WebserverUrl": { + "type": { + "$ref": "#/43" + }, + "flags": 2 + }, + "WebserverVpcEndpointService": { + "type": { + "$ref": "#/43" + }, + "flags": 2 + }, + "WeeklyMaintenanceWindowStart": { + "type": { + "$ref": "#/43" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.MWAA/Environment", + "properties": { + "name": { + "type": { + "$ref": "#/43" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/43" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/51" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.MWAA/Environment@default", + "scopeType": 0, + "body": { + "$ref": "#/52" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.mwaa/default/types.md b/artifacts/bicep/aws/aws.mwaa/default/types.md index e4816613..de4b0629 100644 --- a/artifacts/bicep/aws/aws.mwaa/default/types.md +++ b/artifacts/bicep/aws/aws.mwaa/default/types.md @@ -3,9 +3,9 @@ ## Resource AWS.MWAA/Environment@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.MWAA/EnvironmentProperties](#awsmwaaenvironmentproperties) (Required): properties of the resource +* **properties**: [AWS.MWAA/EnvironmentProperties](#awsmwaaenvironmentproperties) (Required, Identifier): properties of the resource ## AWS.MWAA/EnvironmentProperties ### Properties @@ -28,7 +28,9 @@ * **ExecutionRoleArn**: string * **KmsKey**: string * **LoggingConfiguration**: [LoggingConfiguration](#loggingconfiguration) +* **MaxWebservers**: int * **MaxWorkers**: int +* **MinWebservers**: int * **MinWorkers**: int * **Name**: string (Required, Identifier) * **NetworkConfiguration**: [NetworkConfiguration](#networkconfiguration) @@ -49,6 +51,9 @@ ## Environment_AirflowConfigurationOptions ### Properties +## Environment_Tags +### Properties + ## LoggingConfiguration ### Properties * **DagProcessingLogs**: [ModuleLoggingConfiguration](#moduleloggingconfiguration) @@ -68,6 +73,3 @@ * **SecurityGroupIds**: string[]: A list of security groups to use for the environment. * **SubnetIds**: string[]: A list of subnets to use for the environment. These must be private subnets, in the same VPC, in two different availability zones. -## Environment_Tags -### Properties - diff --git a/artifacts/bicep/aws/aws.neptune/default/types.json b/artifacts/bicep/aws/aws.neptune/default/types.json index f73ffdcf..20d60528 100644 --- a/artifacts/bicep/aws/aws.neptune/default/types.json +++ b/artifacts/bicep/aws/aws.neptune/default/types.json @@ -1 +1,350 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"DBClusterRole","Properties":{"FeatureName":{"Type":4,"Flags":0,"Description":"The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion in the Amazon Neptune API Reference."},"RoleArn":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster."}}}},{"2":{"Name":"ServerlessScalingConfiguration","Properties":{"MaxCapacity":{"Type":3,"Flags":1,"Description":"The maximum number of Neptune capacity units (NCUs) for a DB instance in an Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 40, 40.5, 41, and so on. The smallest value you can use is 2.5, whereas the largest is 128."},"MinCapacity":{"Type":3,"Flags":1,"Description":"The minimum number of Neptune capacity units (NCUs) for a DB instance in an Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value you can use is 1, whereas the largest is 128."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"Value":{"Type":4,"Flags":0,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}}}},{"2":{"Name":"AWS.Neptune/DBClusterProperties","Properties":{"AssociatedRoles":{"Type":12,"Flags":0,"Description":"Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf."},"AvailabilityZones":{"Type":13,"Flags":0,"Description":"Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in."},"BackupRetentionPeriod":{"Type":3,"Flags":0,"Description":"Specifies the number of days for which automatic DB snapshots are retained."},"ClusterResourceId":{"Type":4,"Flags":2,"Description":"The resource id for the DB cluster. For example: `cluster-ABCD1234EFGH5678IJKL90MNOP`. The cluster ID uniquely identifies the cluster and is used in things like IAM authentication policies."},"CopyTagsToSnapshot":{"Type":2,"Flags":0,"Description":"A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default behaviour is not to copy them."},"DBClusterIdentifier":{"Type":4,"Flags":16,"Description":"The DB cluster identifier. Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster stored as a lowercase string."},"DBClusterParameterGroupName":{"Type":4,"Flags":0,"Description":"Provides the name of the DB cluster parameter group."},"DBInstanceParameterGroupName":{"Type":4,"Flags":4,"Description":"The name of the DB parameter group to apply to all instances of the DB cluster. Used only in case of a major EngineVersion upgrade request."},"DBPort":{"Type":3,"Flags":0,"Description":"The port number on which the DB instances in the DB cluster accept connections. \n\nIf not specified, the default port used is `8182`. \n\nNote: `Port` property will soon be deprecated from this resource. Please update existing templates to rename it with new property `DBPort` having same functionalities."},"DBSubnetGroupName":{"Type":4,"Flags":0,"Description":"Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group."},"DeletionProtection":{"Type":2,"Flags":0,"Description":"Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled."},"EnableCloudwatchLogsExports":{"Type":14,"Flags":0,"Description":"Specifies a list of log types that are enabled for export to CloudWatch Logs."},"Endpoint":{"Type":4,"Flags":2,"Description":"The connection endpoint for the DB cluster. For example: `mystack-mydbcluster-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com`"},"EngineVersion":{"Type":4,"Flags":0,"Description":"Indicates the database engine version."},"IamAuthEnabled":{"Type":2,"Flags":0,"Description":"True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false."},"KmsKeyId":{"Type":4,"Flags":0,"Description":"If `StorageEncrypted` is true, the Amazon KMS key identifier for the encrypted DB cluster."},"Port":{"Type":4,"Flags":2,"Description":"The port number on which the DB cluster accepts connections. For example: `8182`."},"PreferredBackupWindow":{"Type":4,"Flags":0,"Description":"Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod."},"PreferredMaintenanceWindow":{"Type":4,"Flags":0,"Description":"Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC)."},"ReadEndpoint":{"Type":4,"Flags":2,"Description":"The reader endpoint for the DB cluster. For example: `mystack-mydbcluster-ro-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com`"},"RestoreToTime":{"Type":4,"Flags":4,"Description":"Creates a new DB cluster from a DB snapshot or DB cluster snapshot.\n\nIf a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.\n\nIf a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group."},"RestoreType":{"Type":4,"Flags":4,"Description":"Creates a new DB cluster from a DB snapshot or DB cluster snapshot.\n\nIf a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.\n\nIf a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group."},"ServerlessScalingConfiguration":{"Type":9,"Flags":0,"Description":"Contains the scaling configuration used by the Neptune Serverless Instances within this DB cluster."},"SnapshotIdentifier":{"Type":4,"Flags":4,"Description":"Specifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot.\n\nAfter you restore a DB cluster using a SnapshotIdentifier, you must specify the same SnapshotIdentifier for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed.\n\nHowever, if you don't specify the SnapshotIdentifier, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the snapshot specified by the SnapshotIdentifier, and the original DB cluster is deleted."},"SourceDBClusterIdentifier":{"Type":4,"Flags":4,"Description":"Creates a new DB cluster from a DB snapshot or DB cluster snapshot.\n\nIf a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.\n\nIf a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group."},"StorageEncrypted":{"Type":2,"Flags":0,"Description":"Indicates whether the DB cluster is encrypted.\n\nIf you specify the `DBClusterIdentifier`, `DBSnapshotIdentifier`, or `SourceDBInstanceIdentifier` property, don't specify this property. The value is inherited from the cluster, snapshot, or source DB instance. If you specify the KmsKeyId property, you must enable encryption.\n\nIf you specify the KmsKeyId, you must enable encryption by setting StorageEncrypted to true."},"Tags":{"Type":15,"Flags":0,"Description":"The tags assigned to this cluster."},"UseLatestRestorableTime":{"Type":2,"Flags":4,"Description":"Creates a new DB cluster from a DB snapshot or DB cluster snapshot.\n\nIf a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.\n\nIf a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group."},"VpcSecurityGroupIds":{"Type":16,"Flags":0,"Description":"Provides a list of VPC security groups that the DB cluster belongs to."}}}},{"3":{"ItemType":8}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":10}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.Neptune/DBCluster","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":11,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Neptune/DBCluster@default","ScopeType":0,"Body":17}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "DBClusterRole", + "properties": { + "FeatureName": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion in the Amazon Neptune API Reference." + }, + "RoleArn": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster." + } + } + }, + { + "$type": "ObjectType", + "name": "ServerlessScalingConfiguration", + "properties": { + "MaxCapacity": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The maximum number of Neptune capacity units (NCUs) for a DB instance in an Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 40, 40.5, 41, and so on. The smallest value you can use is 2.5, whereas the largest is 128." + }, + "MinCapacity": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The minimum number of Neptune capacity units (NCUs) for a DB instance in an Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value you can use is 1, whereas the largest is 128." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "IntegerType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.Neptune/DBClusterProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Neptune/DBClusterProperties", + "properties": { + "AssociatedRoles": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf." + }, + "AvailabilityZones": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in." + }, + "BackupRetentionPeriod": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Specifies the number of days for which automatic DB snapshots are retained." + }, + "ClusterResourceId": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The resource id for the DB cluster. For example: `cluster-ABCD1234EFGH5678IJKL90MNOP`. The cluster ID uniquely identifies the cluster and is used in things like IAM authentication policies." + }, + "CopyTagsToSnapshot": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default behaviour is not to copy them." + }, + "DBClusterIdentifier": { + "type": { + "$ref": "#/3" + }, + "flags": 16, + "description": "The DB cluster identifier. Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster stored as a lowercase string." + }, + "DBClusterParameterGroupName": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "Provides the name of the DB cluster parameter group." + }, + "DBInstanceParameterGroupName": { + "type": { + "$ref": "#/3" + }, + "flags": 4, + "description": "The name of the DB parameter group to apply to all instances of the DB cluster. Used only in case of a major EngineVersion upgrade request." + }, + "DBPort": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The port number on which the DB instances in the DB cluster accept connections. \n\nIf not specified, the default port used is `8182`. \n\nNote: `Port` property will soon be deprecated from this resource. Please update existing templates to rename it with new property `DBPort` having same functionalities." + }, + "DBSubnetGroupName": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group." + }, + "DeletionProtection": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled." + }, + "EnableCloudwatchLogsExports": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "Specifies a list of log types that are enabled for export to CloudWatch Logs." + }, + "Endpoint": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The connection endpoint for the DB cluster. For example: `mystack-mydbcluster-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com`" + }, + "EngineVersion": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "Indicates the database engine version." + }, + "IamAuthEnabled": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false." + }, + "KmsKeyId": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "If `StorageEncrypted` is true, the Amazon KMS key identifier for the encrypted DB cluster." + }, + "Port": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The port number on which the DB cluster accepts connections. For example: `8182`." + }, + "PreferredBackupWindow": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod." + }, + "PreferredMaintenanceWindow": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC)." + }, + "ReadEndpoint": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The reader endpoint for the DB cluster. For example: `mystack-mydbcluster-ro-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com`" + }, + "RestoreToTime": { + "type": { + "$ref": "#/3" + }, + "flags": 4, + "description": "Creates a new DB cluster from a DB snapshot or DB cluster snapshot.\n\nIf a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.\n\nIf a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group." + }, + "RestoreType": { + "type": { + "$ref": "#/3" + }, + "flags": 4, + "description": "Creates a new DB cluster from a DB snapshot or DB cluster snapshot.\n\nIf a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.\n\nIf a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group." + }, + "ServerlessScalingConfiguration": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Contains the scaling configuration used by the Neptune Serverless Instances within this DB cluster." + }, + "SnapshotIdentifier": { + "type": { + "$ref": "#/3" + }, + "flags": 4, + "description": "Specifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot.\n\nAfter you restore a DB cluster using a SnapshotIdentifier, you must specify the same SnapshotIdentifier for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed.\n\nHowever, if you don't specify the SnapshotIdentifier, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the snapshot specified by the SnapshotIdentifier, and the original DB cluster is deleted." + }, + "SourceDBClusterIdentifier": { + "type": { + "$ref": "#/3" + }, + "flags": 4, + "description": "Creates a new DB cluster from a DB snapshot or DB cluster snapshot.\n\nIf a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.\n\nIf a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group." + }, + "StorageEncrypted": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "Indicates whether the DB cluster is encrypted.\n\nIf you specify the `DBClusterIdentifier`, `DBSnapshotIdentifier`, or `SourceDBInstanceIdentifier` property, don't specify this property. The value is inherited from the cluster, snapshot, or source DB instance. If you specify the KmsKeyId property, you must enable encryption.\n\nIf you specify the KmsKeyId, you must enable encryption by setting StorageEncrypted to true." + }, + "Tags": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The tags assigned to this cluster." + }, + "UseLatestRestorableTime": { + "type": { + "$ref": "#/8" + }, + "flags": 4, + "description": "Creates a new DB cluster from a DB snapshot or DB cluster snapshot.\n\nIf a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.\n\nIf a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group." + }, + "VpcSecurityGroupIds": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "Provides a list of VPC security groups that the DB cluster belongs to." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Neptune/DBCluster", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/12" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Neptune/DBCluster@default", + "scopeType": 0, + "body": { + "$ref": "#/13" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.neptune/default/types.md b/artifacts/bicep/aws/aws.neptune/default/types.md index bb597485..8858f85a 100644 --- a/artifacts/bicep/aws/aws.neptune/default/types.md +++ b/artifacts/bicep/aws/aws.neptune/default/types.md @@ -3,9 +3,9 @@ ## Resource AWS.Neptune/DBCluster@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Neptune/DBClusterProperties](#awsneptunedbclusterproperties): properties of the resource +* **properties**: [AWS.Neptune/DBClusterProperties](#awsneptunedbclusterproperties) (Identifier): properties of the resource ## AWS.Neptune/DBClusterProperties ### Properties diff --git a/artifacts/bicep/aws/aws.neptunegraph/default/types.json b/artifacts/bicep/aws/aws.neptunegraph/default/types.json index 29901d67..bc380165 100644 --- a/artifacts/bicep/aws/aws.neptunegraph/default/types.json +++ b/artifacts/bicep/aws/aws.neptunegraph/default/types.json @@ -1 +1,266 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"Value":{"Type":4,"Flags":0,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}}}},{"2":{"Name":"VectorSearchConfiguration","Properties":{"VectorSearchDimension":{"Type":3,"Flags":1,"Description":"The vector search dimension"}}}},{"2":{"Name":"AWS.NeptuneGraph/GraphProperties","Properties":{"DeletionProtection":{"Type":2,"Flags":0,"Description":"Value that indicates whether the Graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled.\n\n_Default_: If not specified, the default value is true."},"Endpoint":{"Type":4,"Flags":2,"Description":"The connection endpoint for the graph. For example: `g-12a3bcdef4.us-east-1.neptune-graph.amazonaws.com`"},"GraphArn":{"Type":4,"Flags":2,"Description":"Graph resource ARN"},"GraphId":{"Type":4,"Flags":18,"Description":"The auto-generated id assigned by the service."},"GraphName":{"Type":4,"Flags":0,"Description":"Contains a user-supplied name for the Graph. \n\nIf you don't specify a name, we generate a unique Graph Name using a combination of Stack Name and a UUID comprising of 4 characters.\n\n_Important_: If 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."},"ProvisionedMemory":{"Type":3,"Flags":1,"Description":"Memory for the Graph."},"PublicConnectivity":{"Type":2,"Flags":0,"Description":"Specifies whether the Graph can be reached over the internet. Access to all graphs requires IAM authentication.\n\nWhen the Graph is publicly reachable, its Domain Name System (DNS) endpoint resolves to the public IP address from the internet.\n\nWhen the Graph isn't publicly reachable, you need to create a PrivateGraphEndpoint in a given VPC to ensure the DNS name resolves to a private IP address that is reachable from the VPC.\n\n_Default_: If not specified, the default value is false."},"ReplicaCount":{"Type":3,"Flags":0,"Description":"Specifies the number of replicas you want when finished. All replicas will be provisioned in different availability zones.\n\nReplica Count should always be less than or equal to 2.\n\n_Default_: If not specified, the default value is 1."},"Tags":{"Type":11,"Flags":0,"Description":"The tags associated with this graph."},"VectorSearchConfiguration":{"Type":9,"Flags":0,"Description":"Vector Search Configuration"}}}},{"3":{"ItemType":8}},{"2":{"Name":"AWS.NeptuneGraph/Graph","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":10,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.NeptuneGraph/Graph@default","ScopeType":0,"Body":12}},{"2":{"Name":"AWS.NeptuneGraph/PrivateGraphEndpointProperties","Properties":{"GraphIdentifier":{"Type":4,"Flags":5,"Description":"The auto-generated Graph Id assigned by the service."},"PrivateGraphEndpointIdentifier":{"Type":4,"Flags":18,"Description":"PrivateGraphEndpoint resource identifier generated by concatenating the associated GraphIdentifier and VpcId with an underscore separator.\n\n For example, if GraphIdentifier is `g-12a3bcdef4` and VpcId is `vpc-0a12bc34567de8f90`, the generated PrivateGraphEndpointIdentifier will be `g-12a3bcdef4_vpc-0a12bc34567de8f90`"},"SecurityGroupIds":{"Type":15,"Flags":4,"Description":"The security group Ids associated with the VPC where you want the private graph endpoint to be created, ie, the graph will be reachable from within the VPC."},"SubnetIds":{"Type":16,"Flags":0,"Description":"The subnet Ids associated with the VPC where you want the private graph endpoint to be created, ie, the graph will be reachable from within the VPC."},"VpcEndpointId":{"Type":4,"Flags":2,"Description":"VPC endpoint that provides a private connection between the Graph and specified VPC."},"VpcId":{"Type":4,"Flags":1,"Description":"The VPC where you want the private graph endpoint to be created, ie, the graph will be reachable from within the VPC."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.NeptuneGraph/PrivateGraphEndpoint","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":14,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.NeptuneGraph/PrivateGraphEndpoint@default","ScopeType":0,"Body":17}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + } + } + }, + { + "$type": "ObjectType", + "name": "VectorSearchConfiguration", + "properties": { + "VectorSearchDimension": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The vector search dimension" + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "IntegerType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.NeptuneGraph/GraphProperties" + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ObjectType", + "name": "AWS.NeptuneGraph/GraphProperties", + "properties": { + "DeletionProtection": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "Value that indicates whether the Graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled.\n\n_Default_: If not specified, the default value is true." + }, + "Endpoint": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The connection endpoint for the graph. For example: `g-12a3bcdef4.us-east-1.neptune-graph.amazonaws.com`" + }, + "GraphArn": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "Graph resource ARN" + }, + "GraphId": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "The auto-generated id assigned by the service." + }, + "GraphName": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "Contains a user-supplied name for the Graph. \n\nIf you don't specify a name, we generate a unique Graph Name using a combination of Stack Name and a UUID comprising of 4 characters.\n\n_Important_: If 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." + }, + "ProvisionedMemory": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "Memory for the Graph." + }, + "PublicConnectivity": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "Specifies whether the Graph can be reached over the internet. Access to all graphs requires IAM authentication.\n\nWhen the Graph is publicly reachable, its Domain Name System (DNS) endpoint resolves to the public IP address from the internet.\n\nWhen the Graph isn't publicly reachable, you need to create a PrivateGraphEndpoint in a given VPC to ensure the DNS name resolves to a private IP address that is reachable from the VPC.\n\n_Default_: If not specified, the default value is false." + }, + "ReplicaCount": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "Specifies the number of replicas you want when finished. All replicas will be provisioned in different availability zones.\n\nReplica Count should always be less than or equal to 2.\n\n_Default_: If not specified, the default value is 1." + }, + "Tags": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "The tags associated with this graph." + }, + "VectorSearchConfiguration": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Vector Search Configuration" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.NeptuneGraph/Graph", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/7" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.NeptuneGraph/Graph@default", + "scopeType": 0, + "body": { + "$ref": "#/8" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.NeptuneGraph/PrivateGraphEndpointProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ObjectType", + "name": "AWS.NeptuneGraph/PrivateGraphEndpointProperties", + "properties": { + "GraphIdentifier": { + "type": { + "$ref": "#/2" + }, + "flags": 5, + "description": "The auto-generated Graph Id assigned by the service." + }, + "PrivateGraphEndpointIdentifier": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "PrivateGraphEndpoint resource identifier generated by concatenating the associated GraphIdentifier and VpcId with an underscore separator.\n\n For example, if GraphIdentifier is `g-12a3bcdef4` and VpcId is `vpc-0a12bc34567de8f90`, the generated PrivateGraphEndpointIdentifier will be `g-12a3bcdef4_vpc-0a12bc34567de8f90`" + }, + "SecurityGroupIds": { + "type": { + "$ref": "#/11" + }, + "flags": 4, + "description": "The security group Ids associated with the VPC where you want the private graph endpoint to be created, ie, the graph will be reachable from within the VPC." + }, + "SubnetIds": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "The subnet Ids associated with the VPC where you want the private graph endpoint to be created, ie, the graph will be reachable from within the VPC." + }, + "VpcEndpointId": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "VPC endpoint that provides a private connection between the Graph and specified VPC." + }, + "VpcId": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The VPC where you want the private graph endpoint to be created, ie, the graph will be reachable from within the VPC." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.NeptuneGraph/PrivateGraphEndpoint", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/13" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.NeptuneGraph/PrivateGraphEndpoint@default", + "scopeType": 0, + "body": { + "$ref": "#/14" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.neptunegraph/default/types.md b/artifacts/bicep/aws/aws.neptunegraph/default/types.md index 76595a0d..f384fc39 100644 --- a/artifacts/bicep/aws/aws.neptunegraph/default/types.md +++ b/artifacts/bicep/aws/aws.neptunegraph/default/types.md @@ -3,16 +3,16 @@ ## Resource AWS.NeptuneGraph/Graph@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.NeptuneGraph/GraphProperties](#awsneptunegraphgraphproperties) (Required): properties of the resource +* **properties**: [AWS.NeptuneGraph/GraphProperties](#awsneptunegraphgraphproperties) (Required, Identifier): properties of the resource ## Resource AWS.NeptuneGraph/PrivateGraphEndpoint@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.NeptuneGraph/PrivateGraphEndpointProperties](#awsneptunegraphprivategraphendpointproperties) (Required): properties of the resource +* **properties**: [AWS.NeptuneGraph/PrivateGraphEndpointProperties](#awsneptunegraphprivategraphendpointproperties) (Required, Identifier): properties of the resource ## AWS.NeptuneGraph/GraphProperties ### Properties @@ -43,15 +43,6 @@ _Default_: If not specified, the default value is 1. * **Tags**: [Tag](#tag)[]: The tags associated with this graph. * **VectorSearchConfiguration**: [VectorSearchConfiguration](#vectorsearchconfiguration): Vector Search Configuration -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - -## VectorSearchConfiguration -### Properties -* **VectorSearchDimension**: int (Required): The vector search dimension - ## AWS.NeptuneGraph/PrivateGraphEndpointProperties ### Properties * **GraphIdentifier**: string (Required, WriteOnly): The auto-generated Graph Id assigned by the service. @@ -63,3 +54,12 @@ _Default_: If not specified, the default value is 1. * **VpcEndpointId**: string (ReadOnly): VPC endpoint that provides a private connection between the Graph and specified VPC. * **VpcId**: string (Required): The VPC where you want the private graph endpoint to be created, ie, the graph will be reachable from within the VPC. +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## VectorSearchConfiguration +### Properties +* **VectorSearchDimension**: int (Required): The vector search dimension + diff --git a/artifacts/bicep/aws/aws.networkfirewall/default/types.json b/artifacts/bicep/aws/aws.networkfirewall/default/types.json index da4e8aa1..5218fdae 100644 --- a/artifacts/bicep/aws/aws.networkfirewall/default/types.json +++ b/artifacts/bicep/aws/aws.networkfirewall/default/types.json @@ -1 +1,1774 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"EndpointId"}},{"2":{"Name":"ResourceArn"}},{"2":{"Name":"SubnetMapping","Properties":{"IPAddressType":{"Type":4,"Flags":0,"Description":"A IPAddressType"},"SubnetId":{"Type":4,"Flags":1,"Description":"A SubnetId."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.NetworkFirewall/FirewallProperties","Properties":{"DeleteProtection":{"Type":2,"Flags":0},"Description":{"Type":4,"Flags":0},"EndpointIds":{"Type":13,"Flags":2},"FirewallArn":{"Type":4,"Flags":18},"FirewallId":{"Type":4,"Flags":2},"FirewallName":{"Type":4,"Flags":1},"FirewallPolicyArn":{"Type":4,"Flags":1},"FirewallPolicyChangeProtection":{"Type":2,"Flags":0},"SubnetChangeProtection":{"Type":2,"Flags":0},"SubnetMappings":{"Type":14,"Flags":1},"Tags":{"Type":15,"Flags":0},"VpcId":{"Type":4,"Flags":1}}}},{"3":{"ItemType":4}},{"3":{"ItemType":10}},{"3":{"ItemType":11}},{"2":{"Name":"AWS.NetworkFirewall/Firewall","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":12,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.NetworkFirewall/Firewall@default","ScopeType":0,"Body":16}},{"2":{"Name":"ActionDefinition","Properties":{"PublishMetricAction":{"Type":25,"Flags":0}}}},{"2":{"Name":"CustomAction","Properties":{"ActionDefinition":{"Type":18,"Flags":1},"ActionName":{"Type":4,"Flags":1}}}},{"2":{"Name":"Dimension","Properties":{"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"FirewallPolicy","Properties":{"PolicyVariables":{"Type":36,"Flags":0},"StatefulDefaultActions":{"Type":37,"Flags":0},"StatefulEngineOptions":{"Type":29,"Flags":0},"StatefulRuleGroupReferences":{"Type":38,"Flags":0},"StatelessCustomActions":{"Type":39,"Flags":0},"StatelessDefaultActions":{"Type":40,"Flags":1},"StatelessFragmentDefaultActions":{"Type":41,"Flags":1},"StatelessRuleGroupReferences":{"Type":42,"Flags":0},"TLSInspectionConfigurationArn":{"Type":4,"Flags":0}}}},{"2":{"Name":"IPSet","Properties":{"Definition":{"Type":43,"Flags":0}}}},{"2":{"Name":"OverrideAction"}},{"2":{"Name":"Priority"}},{"2":{"Name":"PublishMetricAction","Properties":{"Dimensions":{"Type":44,"Flags":1}}}},{"2":{"Name":"ResourceArn"}},{"2":{"Name":"RuleOrder"}},{"2":{"Name":"RuleVariables","Properties":{}}},{"2":{"Name":"StatefulEngineOptions","Properties":{"RuleOrder":{"Type":4,"Flags":0},"StreamExceptionPolicy":{"Type":4,"Flags":0}}}},{"2":{"Name":"StatefulRuleGroupOverride","Properties":{"Action":{"Type":4,"Flags":0}}}},{"2":{"Name":"StatefulRuleGroupReference","Properties":{"Override":{"Type":30,"Flags":0},"Priority":{"Type":3,"Flags":0},"ResourceArn":{"Type":4,"Flags":1}}}},{"2":{"Name":"StatelessRuleGroupReference","Properties":{"Priority":{"Type":3,"Flags":1},"ResourceArn":{"Type":4,"Flags":1}}}},{"2":{"Name":"StreamExceptionPolicy"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"VariableDefinition"}},{"2":{"Name":"FirewallPolicy_PolicyVariables","Properties":{"RuleVariables":{"Type":28,"Flags":0}}}},{"3":{"ItemType":4}},{"3":{"ItemType":31}},{"3":{"ItemType":19}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":32}},{"3":{"ItemType":4}},{"3":{"ItemType":20}},{"2":{"Name":"AWS.NetworkFirewall/FirewallPolicyProperties","Properties":{"Description":{"Type":4,"Flags":0},"FirewallPolicy":{"Type":21,"Flags":1},"FirewallPolicyArn":{"Type":4,"Flags":18},"FirewallPolicyId":{"Type":4,"Flags":2},"FirewallPolicyName":{"Type":4,"Flags":1},"Tags":{"Type":46,"Flags":0}}}},{"3":{"ItemType":34}},{"2":{"Name":"AWS.NetworkFirewall/FirewallPolicy","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":45,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.NetworkFirewall/FirewallPolicy@default","ScopeType":0,"Body":47}},{"2":{"Name":"LogDestinationConfig","Properties":{"LogDestination":{"Type":52,"Flags":1,"Description":"A key-value pair to configure the logDestinations."},"LogDestinationType":{"Type":4,"Flags":1},"LogType":{"Type":4,"Flags":1}}}},{"2":{"Name":"LoggingConfiguration","Properties":{"LogDestinationConfigs":{"Type":53,"Flags":1}}}},{"2":{"Name":"ResourceArn"}},{"2":{"Name":"LoggingConfiguration_LogDestination","Properties":{}}},{"3":{"ItemType":49}},{"2":{"Name":"AWS.NetworkFirewall/LoggingConfigurationProperties","Properties":{"FirewallArn":{"Type":4,"Flags":17},"FirewallName":{"Type":4,"Flags":0},"LoggingConfiguration":{"Type":50,"Flags":1}}}},{"2":{"Name":"AWS.NetworkFirewall/LoggingConfiguration","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":54,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.NetworkFirewall/LoggingConfiguration@default","ScopeType":0,"Body":55}},{"2":{"Name":"ActionDefinition","Properties":{"PublishMetricAction":{"Type":71,"Flags":0}}}},{"2":{"Name":"Address","Properties":{"AddressDefinition":{"Type":4,"Flags":1}}}},{"2":{"Name":"CustomAction","Properties":{"ActionDefinition":{"Type":57,"Flags":1},"ActionName":{"Type":4,"Flags":1}}}},{"2":{"Name":"Dimension","Properties":{"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"GeneratedRulesType"}},{"2":{"Name":"Header","Properties":{"Destination":{"Type":4,"Flags":1},"DestinationPort":{"Type":4,"Flags":1},"Direction":{"Type":4,"Flags":1},"Protocol":{"Type":4,"Flags":1},"Source":{"Type":4,"Flags":1},"SourcePort":{"Type":4,"Flags":1}}}},{"2":{"Name":"IPSet","Properties":{"Definition":{"Type":92,"Flags":0}}}},{"2":{"Name":"IPSetReference","Properties":{"ReferenceArn":{"Type":4,"Flags":0}}}},{"2":{"Name":"MatchAttributes","Properties":{"DestinationPorts":{"Type":93,"Flags":0},"Destinations":{"Type":94,"Flags":0},"Protocols":{"Type":95,"Flags":0},"SourcePorts":{"Type":96,"Flags":0},"Sources":{"Type":97,"Flags":0},"TCPFlags":{"Type":98,"Flags":0}}}},{"2":{"Name":"Port"}},{"2":{"Name":"PortRange","Properties":{"FromPort":{"Type":3,"Flags":1},"ToPort":{"Type":3,"Flags":1}}}},{"2":{"Name":"PortRangeBound"}},{"2":{"Name":"PortSet","Properties":{"Definition":{"Type":99,"Flags":0}}}},{"2":{"Name":"ProtocolNumber"}},{"2":{"Name":"PublishMetricAction","Properties":{"Dimensions":{"Type":100,"Flags":1}}}},{"2":{"Name":"ReferenceSets","Properties":{"IPSetReferences":{"Type":101,"Flags":0}}}},{"2":{"Name":"ResourceArn"}},{"2":{"Name":"RuleDefinition","Properties":{"Actions":{"Type":102,"Flags":1},"MatchAttributes":{"Type":65,"Flags":1}}}},{"2":{"Name":"RuleGroup","Properties":{"ReferenceSets":{"Type":72,"Flags":0},"RuleVariables":{"Type":78,"Flags":0},"RulesSource":{"Type":79,"Flags":1},"StatefulRuleOptions":{"Type":84,"Flags":0}}}},{"2":{"Name":"RuleOption","Properties":{"Keyword":{"Type":4,"Flags":1},"Settings":{"Type":103,"Flags":0}}}},{"2":{"Name":"RuleOrder"}},{"2":{"Name":"RuleVariables","Properties":{"IPSets":{"Type":104,"Flags":0},"PortSets":{"Type":105,"Flags":0}}}},{"2":{"Name":"RulesSource","Properties":{"RulesSourceList":{"Type":80,"Flags":0},"RulesString":{"Type":4,"Flags":0},"StatefulRules":{"Type":106,"Flags":0},"StatelessRulesAndCustomActions":{"Type":86,"Flags":0}}}},{"2":{"Name":"RulesSourceList","Properties":{"GeneratedRulesType":{"Type":4,"Flags":1},"TargetTypes":{"Type":107,"Flags":1},"Targets":{"Type":108,"Flags":1}}}},{"2":{"Name":"RulesString"}},{"2":{"Name":"Setting"}},{"2":{"Name":"StatefulRule","Properties":{"Action":{"Type":4,"Flags":1},"Header":{"Type":62,"Flags":1},"RuleOptions":{"Type":109,"Flags":1}}}},{"2":{"Name":"StatefulRuleOptions","Properties":{"RuleOrder":{"Type":4,"Flags":0}}}},{"2":{"Name":"StatelessRule","Properties":{"Priority":{"Type":3,"Flags":1},"RuleDefinition":{"Type":74,"Flags":1}}}},{"2":{"Name":"StatelessRulesAndCustomActions","Properties":{"CustomActions":{"Type":110,"Flags":0},"StatelessRules":{"Type":111,"Flags":1}}}},{"2":{"Name":"TCPFlag"}},{"2":{"Name":"TCPFlagField","Properties":{"Flags":{"Type":112,"Flags":1},"Masks":{"Type":113,"Flags":0}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"TargetType"}},{"2":{"Name":"VariableDefinition"}},{"3":{"ItemType":4}},{"3":{"ItemType":67}},{"3":{"ItemType":58}},{"3":{"ItemType":3}},{"3":{"ItemType":67}},{"3":{"ItemType":58}},{"3":{"ItemType":88}},{"3":{"ItemType":4}},{"3":{"ItemType":60}},{"2":{"Name":"RuleGroup_IPSetReferences","Properties":{}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"RuleGroup_IPSets","Properties":{}}},{"2":{"Name":"RuleGroup_PortSets","Properties":{}}},{"3":{"ItemType":83}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":76}},{"3":{"ItemType":59}},{"3":{"ItemType":85}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.NetworkFirewall/RuleGroupProperties","Properties":{"Capacity":{"Type":3,"Flags":1},"Description":{"Type":4,"Flags":0},"RuleGroup":{"Type":75,"Flags":0},"RuleGroupArn":{"Type":4,"Flags":18},"RuleGroupId":{"Type":4,"Flags":2},"RuleGroupName":{"Type":4,"Flags":1},"Tags":{"Type":115,"Flags":0},"Type":{"Type":4,"Flags":1}}}},{"3":{"ItemType":89}},{"2":{"Name":"AWS.NetworkFirewall/RuleGroup","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":114,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.NetworkFirewall/RuleGroup@default","ScopeType":0,"Body":116}},{"2":{"Name":"Address","Properties":{"AddressDefinition":{"Type":4,"Flags":1}}}},{"2":{"Name":"PortRange","Properties":{"FromPort":{"Type":3,"Flags":1},"ToPort":{"Type":3,"Flags":1}}}},{"2":{"Name":"PortRangeBound"}},{"2":{"Name":"ProtocolNumber"}},{"2":{"Name":"ResourceArn"}},{"2":{"Name":"RevokedStatusAction"}},{"2":{"Name":"ServerCertificate","Properties":{"ResourceArn":{"Type":4,"Flags":0}}}},{"2":{"Name":"ServerCertificateConfiguration","Properties":{"CertificateAuthorityArn":{"Type":4,"Flags":0},"CheckCertificateRevocationStatus":{"Type":130,"Flags":0},"Scopes":{"Type":131,"Flags":0},"ServerCertificates":{"Type":132,"Flags":0}}}},{"2":{"Name":"ServerCertificateScope","Properties":{"DestinationPorts":{"Type":133,"Flags":0},"Destinations":{"Type":134,"Flags":0},"Protocols":{"Type":135,"Flags":0},"SourcePorts":{"Type":136,"Flags":0},"Sources":{"Type":137,"Flags":0}}}},{"2":{"Name":"TLSInspectionConfiguration","Properties":{"ServerCertificateConfigurations":{"Type":138,"Flags":0}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"UnknownStatusAction"}},{"2":{"Name":"TLSInspectionConfiguration_CheckCertificateRevocationStatus","Properties":{"RevokedStatusAction":{"Type":4,"Flags":0},"UnknownStatusAction":{"Type":4,"Flags":0}}}},{"3":{"ItemType":126}},{"3":{"ItemType":124}},{"3":{"ItemType":119}},{"3":{"ItemType":118}},{"3":{"ItemType":3}},{"3":{"ItemType":119}},{"3":{"ItemType":118}},{"3":{"ItemType":125}},{"2":{"Name":"AWS.NetworkFirewall/TLSInspectionConfigurationProperties","Properties":{"Description":{"Type":4,"Flags":0},"TLSInspectionConfiguration":{"Type":127,"Flags":1},"TLSInspectionConfigurationArn":{"Type":4,"Flags":18},"TLSInspectionConfigurationId":{"Type":4,"Flags":2},"TLSInspectionConfigurationName":{"Type":4,"Flags":1},"Tags":{"Type":140,"Flags":0}}}},{"3":{"ItemType":128}},{"2":{"Name":"AWS.NetworkFirewall/TLSInspectionConfiguration","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":139,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.NetworkFirewall/TLSInspectionConfiguration@default","ScopeType":0,"Body":141}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "EndpointId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ResourceArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SubnetMapping", + "properties": { + "IPAddressType": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "A IPAddressType" + }, + "SubnetId": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "A SubnetId." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.NetworkFirewall/FirewallProperties" + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ObjectType", + "name": "AWS.NetworkFirewall/FirewallProperties", + "properties": { + "DeleteProtection": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "Description": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "EndpointIds": { + "type": { + "$ref": "#/7" + }, + "flags": 2 + }, + "FirewallArn": { + "type": { + "$ref": "#/4" + }, + "flags": 18 + }, + "FirewallId": { + "type": { + "$ref": "#/4" + }, + "flags": 2 + }, + "FirewallName": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + }, + "FirewallPolicyArn": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + }, + "FirewallPolicyChangeProtection": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "SubnetChangeProtection": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "SubnetMappings": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "VpcId": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.NetworkFirewall/Firewall", + "properties": { + "name": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/10" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.NetworkFirewall/Firewall@default", + "scopeType": 0, + "body": { + "$ref": "#/11" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "ActionDefinition", + "properties": { + "PublishMetricAction": { + "type": { + "$ref": "#/20" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomAction", + "properties": { + "ActionDefinition": { + "type": { + "$ref": "#/13" + }, + "flags": 1 + }, + "ActionName": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Dimension", + "properties": { + "Value": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "FirewallPolicy", + "properties": { + "PolicyVariables": { + "type": { + "$ref": "#/31" + }, + "flags": 0 + }, + "StatefulDefaultActions": { + "type": { + "$ref": "#/32" + }, + "flags": 0 + }, + "StatefulEngineOptions": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "StatefulRuleGroupReferences": { + "type": { + "$ref": "#/33" + }, + "flags": 0 + }, + "StatelessCustomActions": { + "type": { + "$ref": "#/34" + }, + "flags": 0 + }, + "StatelessDefaultActions": { + "type": { + "$ref": "#/35" + }, + "flags": 1 + }, + "StatelessFragmentDefaultActions": { + "type": { + "$ref": "#/36" + }, + "flags": 1 + }, + "StatelessRuleGroupReferences": { + "type": { + "$ref": "#/37" + }, + "flags": 0 + }, + "TLSInspectionConfigurationArn": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "IPSet", + "properties": { + "Definition": { + "type": { + "$ref": "#/38" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "OverrideAction", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Priority", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PublishMetricAction", + "properties": { + "Dimensions": { + "type": { + "$ref": "#/40" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ResourceArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RuleOrder", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RuleVariables", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "StatefulEngineOptions", + "properties": { + "RuleOrder": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "StreamExceptionPolicy": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "StatefulRuleGroupOverride", + "properties": { + "Action": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "StatefulRuleGroupReference", + "properties": { + "Override": { + "type": { + "$ref": "#/25" + }, + "flags": 0 + }, + "Priority": { + "type": { + "$ref": "#/39" + }, + "flags": 0 + }, + "ResourceArn": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "StatelessRuleGroupReference", + "properties": { + "Priority": { + "type": { + "$ref": "#/39" + }, + "flags": 1 + }, + "ResourceArn": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "StreamExceptionPolicy", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "VariableDefinition", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "FirewallPolicy_PolicyVariables", + "properties": { + "RuleVariables": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/26" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/14" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/27" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/15" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.NetworkFirewall/FirewallPolicyProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/29" + } + }, + { + "$type": "ObjectType", + "name": "AWS.NetworkFirewall/FirewallPolicyProperties", + "properties": { + "Description": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "FirewallPolicy": { + "type": { + "$ref": "#/16" + }, + "flags": 1 + }, + "FirewallPolicyArn": { + "type": { + "$ref": "#/4" + }, + "flags": 18 + }, + "FirewallPolicyId": { + "type": { + "$ref": "#/4" + }, + "flags": 2 + }, + "FirewallPolicyName": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/42" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.NetworkFirewall/FirewallPolicy", + "properties": { + "name": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/43" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.NetworkFirewall/FirewallPolicy@default", + "scopeType": 0, + "body": { + "$ref": "#/44" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "LogDestinationConfig", + "properties": { + "LogDestination": { + "type": { + "$ref": "#/49" + }, + "flags": 1, + "description": "A key-value pair to configure the logDestinations." + }, + "LogDestinationType": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + }, + "LogType": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "LoggingConfiguration", + "properties": { + "LogDestinationConfigs": { + "type": { + "$ref": "#/50" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ResourceArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LoggingConfiguration_LogDestination", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/46" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.NetworkFirewall/LoggingConfigurationProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.NetworkFirewall/LoggingConfigurationProperties", + "properties": { + "FirewallArn": { + "type": { + "$ref": "#/4" + }, + "flags": 17 + }, + "FirewallName": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "LoggingConfiguration": { + "type": { + "$ref": "#/47" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.NetworkFirewall/LoggingConfiguration", + "properties": { + "name": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/52" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.NetworkFirewall/LoggingConfiguration@default", + "scopeType": 0, + "body": { + "$ref": "#/53" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "ActionDefinition", + "properties": { + "PublishMetricAction": { + "type": { + "$ref": "#/69" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Address", + "properties": { + "AddressDefinition": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomAction", + "properties": { + "ActionDefinition": { + "type": { + "$ref": "#/55" + }, + "flags": 1 + }, + "ActionName": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Dimension", + "properties": { + "Value": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "GeneratedRulesType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Header", + "properties": { + "Destination": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + }, + "DestinationPort": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + }, + "Direction": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + }, + "Protocol": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + }, + "Source": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + }, + "SourcePort": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "IPSet", + "properties": { + "Definition": { + "type": { + "$ref": "#/90" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "IPSetReference", + "properties": { + "ReferenceArn": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "MatchAttributes", + "properties": { + "DestinationPorts": { + "type": { + "$ref": "#/91" + }, + "flags": 0 + }, + "Destinations": { + "type": { + "$ref": "#/92" + }, + "flags": 0 + }, + "Protocols": { + "type": { + "$ref": "#/93" + }, + "flags": 0 + }, + "SourcePorts": { + "type": { + "$ref": "#/94" + }, + "flags": 0 + }, + "Sources": { + "type": { + "$ref": "#/95" + }, + "flags": 0 + }, + "TCPFlags": { + "type": { + "$ref": "#/96" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Port", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PortRange", + "properties": { + "FromPort": { + "type": { + "$ref": "#/39" + }, + "flags": 1 + }, + "ToPort": { + "type": { + "$ref": "#/39" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "PortRangeBound", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PortSet", + "properties": { + "Definition": { + "type": { + "$ref": "#/97" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ProtocolNumber", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PublishMetricAction", + "properties": { + "Dimensions": { + "type": { + "$ref": "#/98" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ReferenceSets", + "properties": { + "IPSetReferences": { + "type": { + "$ref": "#/99" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ResourceArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RuleDefinition", + "properties": { + "Actions": { + "type": { + "$ref": "#/100" + }, + "flags": 1 + }, + "MatchAttributes": { + "type": { + "$ref": "#/63" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "RuleGroup", + "properties": { + "ReferenceSets": { + "type": { + "$ref": "#/70" + }, + "flags": 0 + }, + "RuleVariables": { + "type": { + "$ref": "#/76" + }, + "flags": 0 + }, + "RulesSource": { + "type": { + "$ref": "#/77" + }, + "flags": 1 + }, + "StatefulRuleOptions": { + "type": { + "$ref": "#/82" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "RuleOption", + "properties": { + "Keyword": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + }, + "Settings": { + "type": { + "$ref": "#/101" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "RuleOrder", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RuleVariables", + "properties": { + "IPSets": { + "type": { + "$ref": "#/102" + }, + "flags": 0 + }, + "PortSets": { + "type": { + "$ref": "#/103" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "RulesSource", + "properties": { + "RulesSourceList": { + "type": { + "$ref": "#/78" + }, + "flags": 0 + }, + "RulesString": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "StatefulRules": { + "type": { + "$ref": "#/104" + }, + "flags": 0 + }, + "StatelessRulesAndCustomActions": { + "type": { + "$ref": "#/84" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "RulesSourceList", + "properties": { + "GeneratedRulesType": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + }, + "TargetTypes": { + "type": { + "$ref": "#/105" + }, + "flags": 1 + }, + "Targets": { + "type": { + "$ref": "#/106" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "RulesString", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Setting", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "StatefulRule", + "properties": { + "Action": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + }, + "Header": { + "type": { + "$ref": "#/60" + }, + "flags": 1 + }, + "RuleOptions": { + "type": { + "$ref": "#/107" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "StatefulRuleOptions", + "properties": { + "RuleOrder": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "StatelessRule", + "properties": { + "Priority": { + "type": { + "$ref": "#/39" + }, + "flags": 1 + }, + "RuleDefinition": { + "type": { + "$ref": "#/72" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "StatelessRulesAndCustomActions", + "properties": { + "CustomActions": { + "type": { + "$ref": "#/108" + }, + "flags": 0 + }, + "StatelessRules": { + "type": { + "$ref": "#/109" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TCPFlag", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TCPFlagField", + "properties": { + "Flags": { + "type": { + "$ref": "#/110" + }, + "flags": 1 + }, + "Masks": { + "type": { + "$ref": "#/111" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TargetType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "VariableDefinition", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/65" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/56" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/39" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/65" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/56" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/86" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/58" + } + }, + { + "$type": "ObjectType", + "name": "RuleGroup_IPSetReferences", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ObjectType", + "name": "RuleGroup_IPSets", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RuleGroup_PortSets", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/81" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/74" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/57" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/83" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.NetworkFirewall/RuleGroupProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/87" + } + }, + { + "$type": "ObjectType", + "name": "AWS.NetworkFirewall/RuleGroupProperties", + "properties": { + "Capacity": { + "type": { + "$ref": "#/39" + }, + "flags": 1 + }, + "Description": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "RuleGroup": { + "type": { + "$ref": "#/73" + }, + "flags": 0 + }, + "RuleGroupArn": { + "type": { + "$ref": "#/4" + }, + "flags": 18 + }, + "RuleGroupId": { + "type": { + "$ref": "#/4" + }, + "flags": 2 + }, + "RuleGroupName": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/113" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.NetworkFirewall/RuleGroup", + "properties": { + "name": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/114" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.NetworkFirewall/RuleGroup@default", + "scopeType": 0, + "body": { + "$ref": "#/115" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Address", + "properties": { + "AddressDefinition": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "PortRange", + "properties": { + "FromPort": { + "type": { + "$ref": "#/39" + }, + "flags": 1 + }, + "ToPort": { + "type": { + "$ref": "#/39" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "PortRangeBound", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ProtocolNumber", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ResourceArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RevokedStatusAction", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ServerCertificate", + "properties": { + "ResourceArn": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ServerCertificateConfiguration", + "properties": { + "CertificateAuthorityArn": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "CheckCertificateRevocationStatus": { + "type": { + "$ref": "#/129" + }, + "flags": 0 + }, + "Scopes": { + "type": { + "$ref": "#/130" + }, + "flags": 0 + }, + "ServerCertificates": { + "type": { + "$ref": "#/131" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ServerCertificateScope", + "properties": { + "DestinationPorts": { + "type": { + "$ref": "#/132" + }, + "flags": 0 + }, + "Destinations": { + "type": { + "$ref": "#/133" + }, + "flags": 0 + }, + "Protocols": { + "type": { + "$ref": "#/134" + }, + "flags": 0 + }, + "SourcePorts": { + "type": { + "$ref": "#/135" + }, + "flags": 0 + }, + "Sources": { + "type": { + "$ref": "#/136" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TLSInspectionConfiguration", + "properties": { + "ServerCertificateConfigurations": { + "type": { + "$ref": "#/137" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "UnknownStatusAction", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TLSInspectionConfiguration_CheckCertificateRevocationStatus", + "properties": { + "RevokedStatusAction": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "UnknownStatusAction": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/125" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/123" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/118" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/117" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/39" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/118" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/117" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/124" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.NetworkFirewall/TLSInspectionConfigurationProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/127" + } + }, + { + "$type": "ObjectType", + "name": "AWS.NetworkFirewall/TLSInspectionConfigurationProperties", + "properties": { + "Description": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "TLSInspectionConfiguration": { + "type": { + "$ref": "#/126" + }, + "flags": 1 + }, + "TLSInspectionConfigurationArn": { + "type": { + "$ref": "#/4" + }, + "flags": 18 + }, + "TLSInspectionConfigurationId": { + "type": { + "$ref": "#/4" + }, + "flags": 2 + }, + "TLSInspectionConfigurationName": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/139" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.NetworkFirewall/TLSInspectionConfiguration", + "properties": { + "name": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/140" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.NetworkFirewall/TLSInspectionConfiguration@default", + "scopeType": 0, + "body": { + "$ref": "#/141" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.networkfirewall/default/types.md b/artifacts/bicep/aws/aws.networkfirewall/default/types.md index fe25cb97..855be653 100644 --- a/artifacts/bicep/aws/aws.networkfirewall/default/types.md +++ b/artifacts/bicep/aws/aws.networkfirewall/default/types.md @@ -3,37 +3,62 @@ ## Resource AWS.NetworkFirewall/Firewall@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.NetworkFirewall/FirewallProperties](#awsnetworkfirewallfirewallproperties) (Required): properties of the resource +* **properties**: [AWS.NetworkFirewall/FirewallProperties](#awsnetworkfirewallfirewallproperties) (Required, Identifier): properties of the resource ## Resource AWS.NetworkFirewall/FirewallPolicy@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.NetworkFirewall/FirewallPolicyProperties](#awsnetworkfirewallfirewallpolicyproperties) (Required): properties of the resource +* **properties**: [AWS.NetworkFirewall/FirewallPolicyProperties](#awsnetworkfirewallfirewallpolicyproperties) (Required, Identifier): properties of the resource ## Resource AWS.NetworkFirewall/LoggingConfiguration@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.NetworkFirewall/LoggingConfigurationProperties](#awsnetworkfirewallloggingconfigurationproperties) (Required): properties of the resource +* **properties**: [AWS.NetworkFirewall/LoggingConfigurationProperties](#awsnetworkfirewallloggingconfigurationproperties) (Required, Identifier): properties of the resource ## Resource AWS.NetworkFirewall/RuleGroup@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.NetworkFirewall/RuleGroupProperties](#awsnetworkfirewallrulegroupproperties) (Required): properties of the resource +* **properties**: [AWS.NetworkFirewall/RuleGroupProperties](#awsnetworkfirewallrulegroupproperties) (Required, Identifier): properties of the resource ## Resource AWS.NetworkFirewall/TLSInspectionConfiguration@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.NetworkFirewall/TLSInspectionConfigurationProperties](#awsnetworkfirewalltlsinspectionconfigurationproperties) (Required): properties of the resource +* **properties**: [AWS.NetworkFirewall/TLSInspectionConfigurationProperties](#awsnetworkfirewalltlsinspectionconfigurationproperties) (Required, Identifier): properties of the resource + +## ActionDefinition +### Properties +* **PublishMetricAction**: [PublishMetricAction](#publishmetricaction) + +## ActionDefinition +### Properties +* **PublishMetricAction**: [PublishMetricAction](#publishmetricaction) + +## Address +### Properties +* **AddressDefinition**: string (Required) + +## Address +### Properties +* **AddressDefinition**: string (Required) + +## AWS.NetworkFirewall/FirewallPolicyProperties +### Properties +* **Description**: string +* **FirewallPolicy**: [FirewallPolicy](#firewallpolicy) (Required) +* **FirewallPolicyArn**: string (ReadOnly, Identifier) +* **FirewallPolicyId**: string (ReadOnly) +* **FirewallPolicyName**: string (Required) +* **Tags**: [Tag](#tag)[] ## AWS.NetworkFirewall/FirewallProperties ### Properties @@ -50,24 +75,49 @@ * **Tags**: [Tag](#tag)[] * **VpcId**: string (Required) -## SubnetMapping +## AWS.NetworkFirewall/LoggingConfigurationProperties ### Properties -* **IPAddressType**: string: A IPAddressType -* **SubnetId**: string (Required): A SubnetId. +* **FirewallArn**: string (Required, Identifier) +* **FirewallName**: string +* **LoggingConfiguration**: [LoggingConfiguration](#loggingconfiguration) (Required) -## Tag +## AWS.NetworkFirewall/RuleGroupProperties ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **Capacity**: int (Required) +* **Description**: string +* **RuleGroup**: [RuleGroup](#rulegroup) +* **RuleGroupArn**: string (ReadOnly, Identifier) +* **RuleGroupId**: string (ReadOnly) +* **RuleGroupName**: string (Required) +* **Tags**: [Tag](#tag)[] +* **Type**: string (Required) -## AWS.NetworkFirewall/FirewallPolicyProperties +## AWS.NetworkFirewall/TLSInspectionConfigurationProperties ### Properties * **Description**: string -* **FirewallPolicy**: [FirewallPolicy](#firewallpolicy) (Required) -* **FirewallPolicyArn**: string (ReadOnly, Identifier) -* **FirewallPolicyId**: string (ReadOnly) -* **FirewallPolicyName**: string (Required) * **Tags**: [Tag](#tag)[] +* **TLSInspectionConfiguration**: [TLSInspectionConfiguration](#tlsinspectionconfiguration) (Required) +* **TLSInspectionConfigurationArn**: string (ReadOnly, Identifier) +* **TLSInspectionConfigurationId**: string (ReadOnly) +* **TLSInspectionConfigurationName**: string (Required) + +## CustomAction +### Properties +* **ActionDefinition**: [ActionDefinition](#actiondefinition) (Required) +* **ActionName**: string (Required) + +## CustomAction +### Properties +* **ActionDefinition**: [ActionDefinition](#actiondefinition) (Required) +* **ActionName**: string (Required) + +## Dimension +### Properties +* **Value**: string (Required) + +## Dimension +### Properties +* **Value**: string (Required) ## FirewallPolicy ### Properties @@ -85,80 +135,63 @@ ### Properties * **RuleVariables**: [RuleVariables](#rulevariables) -## RuleVariables -### Properties - -## StatefulEngineOptions -### Properties -* **RuleOrder**: string -* **StreamExceptionPolicy**: string - -## StatefulRuleGroupReference -### Properties -* **Override**: [StatefulRuleGroupOverride](#statefulrulegroupoverride) -* **Priority**: int -* **ResourceArn**: string (Required) - -## StatefulRuleGroupOverride -### Properties -* **Action**: string - -## CustomAction +## Header ### Properties -* **ActionDefinition**: [ActionDefinition](#actiondefinition) (Required) -* **ActionName**: string (Required) +* **Destination**: string (Required) +* **DestinationPort**: string (Required) +* **Direction**: string (Required) +* **Protocol**: string (Required) +* **Source**: string (Required) +* **SourcePort**: string (Required) -## ActionDefinition +## LogDestinationConfig ### Properties -* **PublishMetricAction**: [PublishMetricAction](#publishmetricaction) +* **LogDestination**: [LoggingConfiguration_LogDestination](#loggingconfigurationlogdestination) (Required): A key-value pair to configure the logDestinations. +* **LogDestinationType**: string (Required) +* **LogType**: string (Required) -## PublishMetricAction +## LoggingConfiguration ### Properties -* **Dimensions**: [Dimension](#dimension)[] (Required) +* **LogDestinationConfigs**: [LogDestinationConfig](#logdestinationconfig)[] (Required) -## Dimension +## LoggingConfiguration_LogDestination ### Properties -* **Value**: string (Required) -## StatelessRuleGroupReference +## MatchAttributes ### Properties -* **Priority**: int (Required) -* **ResourceArn**: string (Required) +* **DestinationPorts**: [PortRange](#portrange)[] +* **Destinations**: [Address](#address)[] +* **Protocols**: int[] +* **SourcePorts**: [PortRange](#portrange)[] +* **Sources**: [Address](#address)[] +* **TCPFlags**: [TCPFlagField](#tcpflagfield)[] -## Tag +## PortRange ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **FromPort**: int (Required) +* **ToPort**: int (Required) -## AWS.NetworkFirewall/LoggingConfigurationProperties +## PortRange ### Properties -* **FirewallArn**: string (Required, Identifier) -* **FirewallName**: string -* **LoggingConfiguration**: [LoggingConfiguration](#loggingconfiguration) (Required) +* **FromPort**: int (Required) +* **ToPort**: int (Required) -## LoggingConfiguration +## PublishMetricAction ### Properties -* **LogDestinationConfigs**: [LogDestinationConfig](#logdestinationconfig)[] (Required) +* **Dimensions**: [Dimension](#dimension)[] (Required) -## LogDestinationConfig +## PublishMetricAction ### Properties -* **LogDestination**: [LoggingConfiguration_LogDestination](#loggingconfigurationlogdestination) (Required): A key-value pair to configure the logDestinations. -* **LogDestinationType**: string (Required) -* **LogType**: string (Required) +* **Dimensions**: [Dimension](#dimension)[] (Required) -## LoggingConfiguration_LogDestination +## ReferenceSets ### Properties +* **IPSetReferences**: [RuleGroup_IPSetReferences](#rulegroupipsetreferences) -## AWS.NetworkFirewall/RuleGroupProperties +## RuleDefinition ### Properties -* **Capacity**: int (Required) -* **Description**: string -* **RuleGroup**: [RuleGroup](#rulegroup) -* **RuleGroupArn**: string (ReadOnly, Identifier) -* **RuleGroupId**: string (ReadOnly) -* **RuleGroupName**: string (Required) -* **Tags**: [Tag](#tag)[] -* **Type**: string (Required) +* **Actions**: string[] (Required) +* **MatchAttributes**: [MatchAttributes](#matchattributes) (Required) ## RuleGroup ### Properties @@ -167,13 +200,20 @@ * **RuleVariables**: [RuleVariables](#rulevariables) * **StatefulRuleOptions**: [StatefulRuleOptions](#statefulruleoptions) -## ReferenceSets +## RuleGroup_IPSetReferences ### Properties -* **IPSetReferences**: [RuleGroup_IPSetReferences](#rulegroupipsetreferences) -## RuleGroup_IPSetReferences +## RuleGroup_IPSets ### Properties +## RuleGroup_PortSets +### Properties + +## RuleOption +### Properties +* **Keyword**: string (Required) +* **Settings**: string[] + ## RulesSource ### Properties * **RulesSourceList**: [RulesSourceList](#rulessourcelist) @@ -187,149 +227,109 @@ * **Targets**: string[] (Required) * **TargetTypes**: string[] (Required) -## StatefulRule -### Properties -* **Action**: string (Required) -* **Header**: [Header](#header) (Required) -* **RuleOptions**: [RuleOption](#ruleoption)[] (Required) - -## Header -### Properties -* **Destination**: string (Required) -* **DestinationPort**: string (Required) -* **Direction**: string (Required) -* **Protocol**: string (Required) -* **Source**: string (Required) -* **SourcePort**: string (Required) - -## RuleOption -### Properties -* **Keyword**: string (Required) -* **Settings**: string[] - -## StatelessRulesAndCustomActions +## RuleVariables ### Properties -* **CustomActions**: [CustomAction](#customaction)[] -* **StatelessRules**: [StatelessRule](#statelessrule)[] (Required) -## CustomAction +## RuleVariables ### Properties -* **ActionDefinition**: [ActionDefinition](#actiondefinition) (Required) -* **ActionName**: string (Required) +* **IPSets**: [RuleGroup_IPSets](#rulegroupipsets) +* **PortSets**: [RuleGroup_PortSets](#rulegroupportsets) -## ActionDefinition +## ServerCertificate ### Properties -* **PublishMetricAction**: [PublishMetricAction](#publishmetricaction) +* **ResourceArn**: string -## PublishMetricAction +## ServerCertificateConfiguration ### Properties -* **Dimensions**: [Dimension](#dimension)[] (Required) +* **CertificateAuthorityArn**: string +* **CheckCertificateRevocationStatus**: [TLSInspectionConfiguration_CheckCertificateRevocationStatus](#tlsinspectionconfigurationcheckcertificaterevocationstatus) +* **Scopes**: [ServerCertificateScope](#servercertificatescope)[] +* **ServerCertificates**: [ServerCertificate](#servercertificate)[] -## Dimension +## ServerCertificateScope ### Properties -* **Value**: string (Required) +* **DestinationPorts**: [PortRange](#portrange)[] +* **Destinations**: [Address](#address)[] +* **Protocols**: int[] +* **SourcePorts**: [PortRange](#portrange)[] +* **Sources**: [Address](#address)[] -## StatelessRule +## StatefulEngineOptions ### Properties -* **Priority**: int (Required) -* **RuleDefinition**: [RuleDefinition](#ruledefinition) (Required) +* **RuleOrder**: string +* **StreamExceptionPolicy**: string -## RuleDefinition +## StatefulRule ### Properties -* **Actions**: string[] (Required) -* **MatchAttributes**: [MatchAttributes](#matchattributes) (Required) +* **Action**: string (Required) +* **Header**: [Header](#header) (Required) +* **RuleOptions**: [RuleOption](#ruleoption)[] (Required) -## MatchAttributes +## StatefulRuleGroupOverride ### Properties -* **DestinationPorts**: [PortRange](#portrange)[] -* **Destinations**: [Address](#address)[] -* **Protocols**: int[] -* **SourcePorts**: [PortRange](#portrange)[] -* **Sources**: [Address](#address)[] -* **TCPFlags**: [TCPFlagField](#tcpflagfield)[] +* **Action**: string -## PortRange +## StatefulRuleGroupReference ### Properties -* **FromPort**: int (Required) -* **ToPort**: int (Required) +* **Override**: [StatefulRuleGroupOverride](#statefulrulegroupoverride) +* **Priority**: int +* **ResourceArn**: string (Required) -## Address +## StatefulRuleOptions ### Properties -* **AddressDefinition**: string (Required) +* **RuleOrder**: string -## TCPFlagField +## StatelessRule ### Properties -* **Flags**: string[] (Required) -* **Masks**: string[] +* **Priority**: int (Required) +* **RuleDefinition**: [RuleDefinition](#ruledefinition) (Required) -## RuleVariables +## StatelessRuleGroupReference ### Properties -* **IPSets**: [RuleGroup_IPSets](#rulegroupipsets) -* **PortSets**: [RuleGroup_PortSets](#rulegroupportsets) +* **Priority**: int (Required) +* **ResourceArn**: string (Required) -## RuleGroup_IPSets +## StatelessRulesAndCustomActions ### Properties +* **CustomActions**: [CustomAction](#customaction)[] +* **StatelessRules**: [StatelessRule](#statelessrule)[] (Required) -## RuleGroup_PortSets +## SubnetMapping ### Properties +* **IPAddressType**: string: A IPAddressType +* **SubnetId**: string (Required): A SubnetId. -## StatefulRuleOptions +## Tag ### Properties -* **RuleOrder**: string +* **Key**: string (Required) +* **Value**: string (Required) ## Tag ### Properties * **Key**: string (Required) * **Value**: string (Required) -## AWS.NetworkFirewall/TLSInspectionConfigurationProperties +## Tag ### Properties -* **Description**: string -* **Tags**: [Tag](#tag)[] -* **TLSInspectionConfiguration**: [TLSInspectionConfiguration](#tlsinspectionconfiguration) (Required) -* **TLSInspectionConfigurationArn**: string (ReadOnly, Identifier) -* **TLSInspectionConfigurationId**: string (ReadOnly) -* **TLSInspectionConfigurationName**: string (Required) +* **Key**: string (Required) +* **Value**: string (Required) ## Tag ### Properties * **Key**: string (Required) * **Value**: string (Required) -## TLSInspectionConfiguration +## TCPFlagField ### Properties -* **ServerCertificateConfigurations**: [ServerCertificateConfiguration](#servercertificateconfiguration)[] +* **Flags**: string[] (Required) +* **Masks**: string[] -## ServerCertificateConfiguration +## TLSInspectionConfiguration ### Properties -* **CertificateAuthorityArn**: string -* **CheckCertificateRevocationStatus**: [TLSInspectionConfiguration_CheckCertificateRevocationStatus](#tlsinspectionconfigurationcheckcertificaterevocationstatus) -* **Scopes**: [ServerCertificateScope](#servercertificatescope)[] -* **ServerCertificates**: [ServerCertificate](#servercertificate)[] +* **ServerCertificateConfigurations**: [ServerCertificateConfiguration](#servercertificateconfiguration)[] ## TLSInspectionConfiguration_CheckCertificateRevocationStatus ### Properties * **RevokedStatusAction**: string * **UnknownStatusAction**: string -## ServerCertificateScope -### Properties -* **DestinationPorts**: [PortRange](#portrange)[] -* **Destinations**: [Address](#address)[] -* **Protocols**: int[] -* **SourcePorts**: [PortRange](#portrange)[] -* **Sources**: [Address](#address)[] - -## PortRange -### Properties -* **FromPort**: int (Required) -* **ToPort**: int (Required) - -## Address -### Properties -* **AddressDefinition**: string (Required) - -## ServerCertificate -### Properties -* **ResourceArn**: string - diff --git a/artifacts/bicep/aws/aws.networkmanager/default/types.json b/artifacts/bicep/aws/aws.networkmanager/default/types.json index a28ee3bb..7f237ddd 100644 --- a/artifacts/bicep/aws/aws.networkmanager/default/types.json +++ b/artifacts/bicep/aws/aws.networkmanager/default/types.json @@ -1 +1,2235 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"ConnectAttachmentOptions","Properties":{"Protocol":{"Type":4,"Flags":0,"Description":"Tunnel protocol for connect attachment"}}}},{"2":{"Name":"ProposedSegmentChange","Properties":{"AttachmentPolicyRuleNumber":{"Type":3,"Flags":0,"Description":"The rule number in the policy document that applies to this change."},"SegmentName":{"Type":4,"Flags":0,"Description":"The name of the segment to change."},"Tags":{"Type":11,"Flags":0,"Description":"The list of key-value tags that changed for the segment."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"3":{"ItemType":10}},{"2":{"Name":"AWS.NetworkManager/ConnectAttachmentProperties","Properties":{"AttachmentId":{"Type":4,"Flags":18,"Description":"The ID of the attachment."},"AttachmentPolicyRuleNumber":{"Type":3,"Flags":2,"Description":"The policy rule number associated with the attachment."},"AttachmentType":{"Type":4,"Flags":2,"Description":"The type of attachment."},"CoreNetworkArn":{"Type":4,"Flags":2,"Description":"The ARN of a core network."},"CoreNetworkId":{"Type":4,"Flags":1,"Description":"ID of the CoreNetwork that the attachment will be attached to."},"CreatedAt":{"Type":4,"Flags":2,"Description":"Creation time of the attachment."},"EdgeLocation":{"Type":4,"Flags":1,"Description":"Edge location of the attachment."},"Options":{"Type":8,"Flags":1,"Description":"Protocol options for connect attachment"},"OwnerAccountId":{"Type":4,"Flags":2,"Description":"The ID of the attachment account owner."},"ProposedSegmentChange":{"Type":9,"Flags":0,"Description":"The attachment to move from one segment to another."},"ResourceArn":{"Type":4,"Flags":2,"Description":"The attachment resource ARN."},"SegmentName":{"Type":4,"Flags":2,"Description":"The name of the segment attachment."},"State":{"Type":4,"Flags":2,"Description":"State of the attachment."},"Tags":{"Type":13,"Flags":0,"Description":"Tags for the attachment."},"TransportAttachmentId":{"Type":4,"Flags":1,"Description":"Id of transport attachment"},"UpdatedAt":{"Type":4,"Flags":2,"Description":"Last update time of the attachment."}}}},{"3":{"ItemType":10}},{"2":{"Name":"AWS.NetworkManager/ConnectAttachment","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":12,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.NetworkManager/ConnectAttachment@default","ScopeType":0,"Body":14}},{"2":{"Name":"BgpOptions","Properties":{"PeerAsn":{"Type":3,"Flags":0}}}},{"2":{"Name":"ConnectPeerBgpConfiguration","Properties":{"CoreNetworkAddress":{"Type":4,"Flags":0,"Description":"The address of a core network."},"CoreNetworkAsn":{"Type":3,"Flags":0,"Description":"The ASN of the Coret Network."},"PeerAddress":{"Type":4,"Flags":0,"Description":"The address of a core network Connect peer."},"PeerAsn":{"Type":3,"Flags":0,"Description":"The ASN of the Connect peer."}}}},{"2":{"Name":"ConnectPeerConfiguration","Properties":{"BgpConfigurations":{"Type":21,"Flags":0},"CoreNetworkAddress":{"Type":4,"Flags":0,"Description":"The IP address of a core network."},"InsideCidrBlocks":{"Type":22,"Flags":0,"Description":"The inside IP addresses used for a Connect peer configuration."},"PeerAddress":{"Type":4,"Flags":0,"Description":"The IP address of the Connect peer."},"Protocol":{"Type":4,"Flags":0}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"TunnelProtocol"}},{"3":{"ItemType":17}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.NetworkManager/ConnectPeerProperties","Properties":{"BgpOptions":{"Type":16,"Flags":4,"Description":"Bgp options for connect peer."},"Configuration":{"Type":18,"Flags":2,"Description":"Configuration of the connect peer."},"ConnectAttachmentId":{"Type":4,"Flags":1,"Description":"The ID of the attachment to connect."},"ConnectPeerId":{"Type":4,"Flags":18,"Description":"The ID of the Connect peer."},"CoreNetworkAddress":{"Type":4,"Flags":4,"Description":"The IP address of a core network."},"CoreNetworkId":{"Type":4,"Flags":2,"Description":"The ID of the core network."},"CreatedAt":{"Type":4,"Flags":2,"Description":"Connect peer creation time."},"EdgeLocation":{"Type":4,"Flags":2,"Description":"The Connect peer Regions where edges are located."},"InsideCidrBlocks":{"Type":24,"Flags":0,"Description":"The inside IP addresses used for a Connect peer configuration."},"PeerAddress":{"Type":4,"Flags":1,"Description":"The IP address of the Connect peer."},"State":{"Type":4,"Flags":2,"Description":"State of the connect peer."},"SubnetArn":{"Type":4,"Flags":4,"Description":"The subnet ARN for the connect peer."},"Tags":{"Type":25,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":19}},{"2":{"Name":"AWS.NetworkManager/ConnectPeer","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":23,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.NetworkManager/ConnectPeer@default","ScopeType":0,"Body":26}},{"2":{"Name":"CoreNetworkEdge","Properties":{"Asn":{"Type":3,"Flags":0,"Description":"The ASN of a core network edge."},"EdgeLocation":{"Type":4,"Flags":0,"Description":"The Region where a core network edge is located."},"InsideCidrBlocks":{"Type":31,"Flags":0}}}},{"2":{"Name":"CoreNetworkSegment","Properties":{"EdgeLocations":{"Type":32,"Flags":0},"Name":{"Type":4,"Flags":0,"Description":"Name of segment"},"SharedSegments":{"Type":33,"Flags":0}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.NetworkManager/CoreNetworkProperties","Properties":{"CoreNetworkArn":{"Type":4,"Flags":2,"Description":"The ARN (Amazon resource name) of core network"},"CoreNetworkId":{"Type":4,"Flags":18,"Description":"The Id of core network"},"CreatedAt":{"Type":4,"Flags":2,"Description":"The creation time of core network"},"Description":{"Type":4,"Flags":0,"Description":"The description of core network"},"Edges":{"Type":35,"Flags":2,"Description":"The edges within a core network."},"GlobalNetworkId":{"Type":4,"Flags":1,"Description":"The ID of the global network that your core network is a part of."},"OwnerAccount":{"Type":4,"Flags":2,"Description":"Owner of the core network"},"PolicyDocument":{"Type":36,"Flags":0,"Description":"Live policy document for the core network, you must provide PolicyDocument in Json Format"},"Segments":{"Type":37,"Flags":2,"Description":"The segments within a core network."},"State":{"Type":4,"Flags":2,"Description":"The state of core network"},"Tags":{"Type":38,"Flags":0,"Description":"The tags for the global network."}}}},{"3":{"ItemType":28}},{"2":{"Name":"CoreNetwork_PolicyDocument","Properties":{}}},{"3":{"ItemType":29}},{"3":{"ItemType":30}},{"2":{"Name":"AWS.NetworkManager/CoreNetwork","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":34,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.NetworkManager/CoreNetwork@default","ScopeType":0,"Body":39}},{"2":{"Name":"AWSLocation","Properties":{"SubnetArn":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) of the subnet that the device is located in."},"Zone":{"Type":4,"Flags":0,"Description":"The Zone that the device is located in. Specify the ID of an Availability Zone, Local Zone, Wavelength Zone, or an Outpost."}}}},{"2":{"Name":"Location","Properties":{"Address":{"Type":4,"Flags":0,"Description":"The physical address."},"Latitude":{"Type":4,"Flags":0,"Description":"The latitude."},"Longitude":{"Type":4,"Flags":0,"Description":"The longitude."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.NetworkManager/DeviceProperties","Properties":{"AWSLocation":{"Type":41,"Flags":0,"Description":"The Amazon Web Services location of the device, if applicable."},"CreatedAt":{"Type":4,"Flags":2,"Description":"The date and time that the device was created."},"Description":{"Type":4,"Flags":0,"Description":"The description of the device."},"DeviceArn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) of the device."},"DeviceId":{"Type":4,"Flags":18,"Description":"The ID of the device."},"GlobalNetworkId":{"Type":4,"Flags":17,"Description":"The ID of the global network."},"Location":{"Type":42,"Flags":0,"Description":"The site location."},"Model":{"Type":4,"Flags":0,"Description":"The device model"},"SerialNumber":{"Type":4,"Flags":0,"Description":"The device serial number."},"SiteId":{"Type":4,"Flags":0,"Description":"The site ID."},"State":{"Type":4,"Flags":2,"Description":"The state of the device."},"Tags":{"Type":45,"Flags":0,"Description":"The tags for the device."},"Type":{"Type":4,"Flags":0,"Description":"The device type."},"Vendor":{"Type":4,"Flags":0,"Description":"The device vendor."}}}},{"3":{"ItemType":43}},{"2":{"Name":"AWS.NetworkManager/Device","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":44,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.NetworkManager/Device@default","ScopeType":0,"Body":46}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.NetworkManager/GlobalNetworkProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) of the global network."},"CreatedAt":{"Type":4,"Flags":0,"Description":"The date and time that the global network was created."},"Description":{"Type":4,"Flags":0,"Description":"The description of the global network."},"Id":{"Type":4,"Flags":18,"Description":"The ID of the global network."},"State":{"Type":4,"Flags":0,"Description":"The state of the global network."},"Tags":{"Type":50,"Flags":0,"Description":"The tags for the global network."}}}},{"3":{"ItemType":48}},{"2":{"Name":"AWS.NetworkManager/GlobalNetwork","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":49,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.NetworkManager/GlobalNetwork@default","ScopeType":0,"Body":51}},{"2":{"Name":"Bandwidth","Properties":{"DownloadSpeed":{"Type":3,"Flags":0,"Description":"Download speed in Mbps."},"UploadSpeed":{"Type":3,"Flags":0,"Description":"Upload speed in Mbps."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.NetworkManager/LinkProperties","Properties":{"Bandwidth":{"Type":53,"Flags":1,"Description":"The Bandwidth for the link."},"CreatedAt":{"Type":4,"Flags":2,"Description":"The date and time that the device was created."},"Description":{"Type":4,"Flags":0,"Description":"The description of the link."},"GlobalNetworkId":{"Type":4,"Flags":17,"Description":"The ID of the global network."},"LinkArn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) of the link."},"LinkId":{"Type":4,"Flags":18,"Description":"The ID of the link."},"Provider":{"Type":4,"Flags":0,"Description":"The provider of the link."},"SiteId":{"Type":4,"Flags":1,"Description":"The ID of the site"},"State":{"Type":4,"Flags":2,"Description":"The state of the link."},"Tags":{"Type":56,"Flags":0,"Description":"The tags for the link."},"Type":{"Type":4,"Flags":0,"Description":"The type of the link."}}}},{"3":{"ItemType":54}},{"2":{"Name":"AWS.NetworkManager/Link","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":55,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.NetworkManager/Link@default","ScopeType":0,"Body":57}},{"2":{"Name":"Location","Properties":{"Address":{"Type":4,"Flags":0,"Description":"The physical address."},"Latitude":{"Type":4,"Flags":0,"Description":"The latitude."},"Longitude":{"Type":4,"Flags":0,"Description":"The longitude."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.NetworkManager/SiteProperties","Properties":{"CreatedAt":{"Type":4,"Flags":2,"Description":"The date and time that the device was created."},"Description":{"Type":4,"Flags":0,"Description":"The description of the site."},"GlobalNetworkId":{"Type":4,"Flags":17,"Description":"The ID of the global network."},"Location":{"Type":59,"Flags":0,"Description":"The location of the site."},"SiteArn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) of the site."},"SiteId":{"Type":4,"Flags":18,"Description":"The ID of the site."},"State":{"Type":4,"Flags":2,"Description":"The state of the site."},"Tags":{"Type":62,"Flags":0,"Description":"The tags for the site."}}}},{"3":{"ItemType":60}},{"2":{"Name":"AWS.NetworkManager/Site","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":61,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.NetworkManager/Site@default","ScopeType":0,"Body":63}},{"2":{"Name":"ProposedSegmentChange","Properties":{"AttachmentPolicyRuleNumber":{"Type":3,"Flags":0,"Description":"The rule number in the policy document that applies to this change."},"SegmentName":{"Type":4,"Flags":0,"Description":"The name of the segment to change."},"Tags":{"Type":67,"Flags":0,"Description":"The key-value tags that changed for the segment."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"3":{"ItemType":66}},{"2":{"Name":"AWS.NetworkManager/SiteToSiteVpnAttachmentProperties","Properties":{"AttachmentId":{"Type":4,"Flags":18,"Description":"The ID of the attachment."},"AttachmentPolicyRuleNumber":{"Type":3,"Flags":2,"Description":"The policy rule number associated with the attachment."},"AttachmentType":{"Type":4,"Flags":2,"Description":"The type of attachment."},"CoreNetworkArn":{"Type":4,"Flags":2,"Description":"The ARN of a core network for the VPC attachment."},"CoreNetworkId":{"Type":4,"Flags":1,"Description":"The ID of a core network where you're creating a site-to-site VPN attachment."},"CreatedAt":{"Type":4,"Flags":2,"Description":"Creation time of the attachment."},"EdgeLocation":{"Type":4,"Flags":2,"Description":"The Region where the edge is located."},"OwnerAccountId":{"Type":4,"Flags":2,"Description":"Owner account of the attachment."},"ProposedSegmentChange":{"Type":65,"Flags":0,"Description":"The attachment to move from one segment to another."},"ResourceArn":{"Type":4,"Flags":2,"Description":"The ARN of the Resource."},"SegmentName":{"Type":4,"Flags":2,"Description":"The name of the segment that attachment is in."},"State":{"Type":4,"Flags":2,"Description":"The state of the attachment."},"Tags":{"Type":69,"Flags":0,"Description":"Tags for the attachment."},"UpdatedAt":{"Type":4,"Flags":2,"Description":"Last update time of the attachment."},"VpnConnectionArn":{"Type":4,"Flags":1,"Description":"The ARN of the site-to-site VPN attachment."}}}},{"3":{"ItemType":66}},{"2":{"Name":"AWS.NetworkManager/SiteToSiteVpnAttachment","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":68,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.NetworkManager/SiteToSiteVpnAttachment@default","ScopeType":0,"Body":70}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.NetworkManager/TransitGatewayPeeringProperties","Properties":{"CoreNetworkArn":{"Type":4,"Flags":2,"Description":"The ARN (Amazon Resource Name) of the core network that you want to peer a transit gateway to."},"CoreNetworkId":{"Type":4,"Flags":1,"Description":"The Id of the core network that you want to peer a transit gateway to."},"CreatedAt":{"Type":4,"Flags":2,"Description":"The creation time of the transit gateway peering"},"EdgeLocation":{"Type":4,"Flags":2,"Description":"The location of the transit gateway peering"},"OwnerAccountId":{"Type":4,"Flags":2,"Description":"Peering owner account Id"},"PeeringId":{"Type":4,"Flags":18,"Description":"The Id of the transit gateway peering"},"PeeringType":{"Type":4,"Flags":2,"Description":"Peering type (TransitGatewayPeering)"},"ResourceArn":{"Type":4,"Flags":2,"Description":"The ARN (Amazon Resource Name) of the resource that you will peer to a core network"},"State":{"Type":4,"Flags":2,"Description":"The state of the transit gateway peering"},"Tags":{"Type":74,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."},"TransitGatewayArn":{"Type":4,"Flags":1,"Description":"The ARN (Amazon Resource Name) of the transit gateway that you will peer to a core network"},"TransitGatewayPeeringAttachmentId":{"Type":4,"Flags":2,"Description":"The ID of the TransitGatewayPeeringAttachment"}}}},{"3":{"ItemType":72}},{"2":{"Name":"AWS.NetworkManager/TransitGatewayPeering","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":73,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.NetworkManager/TransitGatewayPeering@default","ScopeType":0,"Body":75}},{"2":{"Name":"ProposedSegmentChange","Properties":{"AttachmentPolicyRuleNumber":{"Type":3,"Flags":0,"Description":"The rule number in the policy document that applies to this change."},"SegmentName":{"Type":4,"Flags":0,"Description":"The name of the segment to change."},"Tags":{"Type":79,"Flags":0,"Description":"The key-value tags that changed for the segment."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"3":{"ItemType":78}},{"2":{"Name":"AWS.NetworkManager/TransitGatewayRouteTableAttachmentProperties","Properties":{"AttachmentId":{"Type":4,"Flags":18,"Description":"The ID of the attachment."},"AttachmentPolicyRuleNumber":{"Type":3,"Flags":2,"Description":"The policy rule number associated with the attachment."},"AttachmentType":{"Type":4,"Flags":2,"Description":"The type of attachment."},"CoreNetworkArn":{"Type":4,"Flags":2,"Description":"The ARN of a core network for the VPC attachment."},"CoreNetworkId":{"Type":4,"Flags":2,"Description":"The ID of a core network where you're creating a site-to-site VPN attachment."},"CreatedAt":{"Type":4,"Flags":2,"Description":"Creation time of the attachment."},"EdgeLocation":{"Type":4,"Flags":2,"Description":"The Region where the edge is located."},"OwnerAccountId":{"Type":4,"Flags":2,"Description":"Owner account of the attachment."},"PeeringId":{"Type":4,"Flags":1,"Description":"The Id of peering between transit gateway and core network."},"ProposedSegmentChange":{"Type":77,"Flags":0,"Description":"The attachment to move from one segment to another."},"ResourceArn":{"Type":4,"Flags":2,"Description":"The ARN of the Resource."},"SegmentName":{"Type":4,"Flags":2,"Description":"The name of the segment that attachment is in."},"State":{"Type":4,"Flags":2,"Description":"The state of the attachment."},"Tags":{"Type":81,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."},"TransitGatewayRouteTableArn":{"Type":4,"Flags":1,"Description":"The Arn of transit gateway route table."},"UpdatedAt":{"Type":4,"Flags":2,"Description":"Last update time of the attachment."}}}},{"3":{"ItemType":78}},{"2":{"Name":"AWS.NetworkManager/TransitGatewayRouteTableAttachment","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":80,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.NetworkManager/TransitGatewayRouteTableAttachment@default","ScopeType":0,"Body":82}},{"2":{"Name":"ProposedSegmentChange","Properties":{"AttachmentPolicyRuleNumber":{"Type":3,"Flags":0,"Description":"The rule number in the policy document that applies to this change."},"SegmentName":{"Type":4,"Flags":0,"Description":"The name of the segment to change."},"Tags":{"Type":87,"Flags":0,"Description":"The key-value tags that changed for the segment."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"VpcOptions","Properties":{"ApplianceModeSupport":{"Type":2,"Flags":0,"Description":"Indicates whether to enable ApplianceModeSupport Support for Vpc Attachment. Valid Values: true | false"},"Ipv6Support":{"Type":2,"Flags":0,"Description":"Indicates whether to enable Ipv6 Support for Vpc Attachment. Valid Values: enable | disable"}}}},{"3":{"ItemType":85}},{"2":{"Name":"AWS.NetworkManager/VpcAttachmentProperties","Properties":{"AttachmentId":{"Type":4,"Flags":18,"Description":"Id of the attachment."},"AttachmentPolicyRuleNumber":{"Type":3,"Flags":2,"Description":"The policy rule number associated with the attachment."},"AttachmentType":{"Type":4,"Flags":2,"Description":"Attachment type."},"CoreNetworkArn":{"Type":4,"Flags":2,"Description":"The ARN of a core network for the VPC attachment."},"CoreNetworkId":{"Type":4,"Flags":1,"Description":"The ID of a core network for the VPC attachment."},"CreatedAt":{"Type":4,"Flags":2,"Description":"Creation time of the attachment."},"EdgeLocation":{"Type":4,"Flags":2,"Description":"The Region where the edge is located."},"Options":{"Type":86,"Flags":0,"Description":"Vpc options of the attachment."},"OwnerAccountId":{"Type":4,"Flags":2,"Description":"Owner account of the attachment."},"ProposedSegmentChange":{"Type":84,"Flags":0,"Description":"The attachment to move from one segment to another."},"ResourceArn":{"Type":4,"Flags":2,"Description":"The ARN of the Resource."},"SegmentName":{"Type":4,"Flags":2,"Description":"The name of the segment attachment.."},"State":{"Type":4,"Flags":2,"Description":"State of the attachment."},"SubnetArns":{"Type":89,"Flags":1,"Description":"Subnet Arn list"},"Tags":{"Type":90,"Flags":0,"Description":"Tags for the attachment."},"UpdatedAt":{"Type":4,"Flags":2,"Description":"Last update time of the attachment."},"VpcArn":{"Type":4,"Flags":1,"Description":"The ARN of the VPC."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":85}},{"2":{"Name":"AWS.NetworkManager/VpcAttachment","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":88,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.NetworkManager/VpcAttachment@default","ScopeType":0,"Body":91}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "ConnectAttachmentOptions", + "properties": { + "Protocol": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "Tunnel protocol for connect attachment" + } + } + }, + { + "$type": "ObjectType", + "name": "ProposedSegmentChange", + "properties": { + "AttachmentPolicyRuleNumber": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The rule number in the policy document that applies to this change." + }, + "SegmentName": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The name of the segment to change." + }, + "Tags": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The list of key-value tags that changed for the segment." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.NetworkManager/ConnectAttachmentProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ObjectType", + "name": "AWS.NetworkManager/ConnectAttachmentProperties", + "properties": { + "AttachmentId": { + "type": { + "$ref": "#/3" + }, + "flags": 18, + "description": "The ID of the attachment." + }, + "AttachmentPolicyRuleNumber": { + "type": { + "$ref": "#/4" + }, + "flags": 2, + "description": "The policy rule number associated with the attachment." + }, + "AttachmentType": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The type of attachment." + }, + "CoreNetworkArn": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The ARN of a core network." + }, + "CoreNetworkId": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "ID of the CoreNetwork that the attachment will be attached to." + }, + "CreatedAt": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "Creation time of the attachment." + }, + "EdgeLocation": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "Edge location of the attachment." + }, + "Options": { + "type": { + "$ref": "#/0" + }, + "flags": 1, + "description": "Protocol options for connect attachment" + }, + "OwnerAccountId": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The ID of the attachment account owner." + }, + "ProposedSegmentChange": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The attachment to move from one segment to another." + }, + "ResourceArn": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The attachment resource ARN." + }, + "SegmentName": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The name of the segment attachment." + }, + "State": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "State of the attachment." + }, + "Tags": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "Tags for the attachment." + }, + "TransportAttachmentId": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "Id of transport attachment" + }, + "UpdatedAt": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "Last update time of the attachment." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.NetworkManager/ConnectAttachment", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/8" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.NetworkManager/ConnectAttachment@default", + "scopeType": 0, + "body": { + "$ref": "#/9" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "BgpOptions", + "properties": { + "PeerAsn": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ConnectPeerBgpConfiguration", + "properties": { + "CoreNetworkAddress": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The address of a core network." + }, + "CoreNetworkAsn": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The ASN of the Coret Network." + }, + "PeerAddress": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The address of a core network Connect peer." + }, + "PeerAsn": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The ASN of the Connect peer." + } + } + }, + { + "$type": "ObjectType", + "name": "ConnectPeerConfiguration", + "properties": { + "BgpConfigurations": { + "type": { + "$ref": "#/16" + }, + "flags": 0 + }, + "CoreNetworkAddress": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The IP address of a core network." + }, + "InsideCidrBlocks": { + "type": { + "$ref": "#/17" + }, + "flags": 0, + "description": "The inside IP addresses used for a Connect peer configuration." + }, + "PeerAddress": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The IP address of the Connect peer." + }, + "Protocol": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "ObjectType", + "name": "TunnelProtocol", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/12" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.NetworkManager/ConnectPeerProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/14" + } + }, + { + "$type": "ObjectType", + "name": "AWS.NetworkManager/ConnectPeerProperties", + "properties": { + "BgpOptions": { + "type": { + "$ref": "#/11" + }, + "flags": 4, + "description": "Bgp options for connect peer." + }, + "Configuration": { + "type": { + "$ref": "#/13" + }, + "flags": 2, + "description": "Configuration of the connect peer." + }, + "ConnectAttachmentId": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The ID of the attachment to connect." + }, + "ConnectPeerId": { + "type": { + "$ref": "#/3" + }, + "flags": 18, + "description": "The ID of the Connect peer." + }, + "CoreNetworkAddress": { + "type": { + "$ref": "#/3" + }, + "flags": 4, + "description": "The IP address of a core network." + }, + "CoreNetworkId": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The ID of the core network." + }, + "CreatedAt": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "Connect peer creation time." + }, + "EdgeLocation": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The Connect peer Regions where edges are located." + }, + "InsideCidrBlocks": { + "type": { + "$ref": "#/19" + }, + "flags": 0, + "description": "The inside IP addresses used for a Connect peer configuration." + }, + "PeerAddress": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The IP address of the Connect peer." + }, + "State": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "State of the connect peer." + }, + "SubnetArn": { + "type": { + "$ref": "#/3" + }, + "flags": 4, + "description": "The subnet ARN for the connect peer." + }, + "Tags": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.NetworkManager/ConnectPeer", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/21" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.NetworkManager/ConnectPeer@default", + "scopeType": 0, + "body": { + "$ref": "#/22" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "CoreNetworkEdge", + "properties": { + "Asn": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The ASN of a core network edge." + }, + "EdgeLocation": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The Region where a core network edge is located." + }, + "InsideCidrBlocks": { + "type": { + "$ref": "#/27" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CoreNetworkSegment", + "properties": { + "EdgeLocations": { + "type": { + "$ref": "#/28" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "Name of segment" + }, + "SharedSegments": { + "type": { + "$ref": "#/29" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.NetworkManager/CoreNetworkProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/24" + } + }, + { + "$type": "ObjectType", + "name": "CoreNetwork_PolicyDocument", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/25" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/26" + } + }, + { + "$type": "ObjectType", + "name": "AWS.NetworkManager/CoreNetworkProperties", + "properties": { + "CoreNetworkArn": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The ARN (Amazon resource name) of core network" + }, + "CoreNetworkId": { + "type": { + "$ref": "#/3" + }, + "flags": 18, + "description": "The Id of core network" + }, + "CreatedAt": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The creation time of core network" + }, + "Description": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The description of core network" + }, + "Edges": { + "type": { + "$ref": "#/31" + }, + "flags": 2, + "description": "The edges within a core network." + }, + "GlobalNetworkId": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The ID of the global network that your core network is a part of." + }, + "OwnerAccount": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "Owner of the core network" + }, + "PolicyDocument": { + "type": { + "$ref": "#/32" + }, + "flags": 0, + "description": "Live policy document for the core network, you must provide PolicyDocument in Json Format" + }, + "Segments": { + "type": { + "$ref": "#/33" + }, + "flags": 2, + "description": "The segments within a core network." + }, + "State": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The state of core network" + }, + "Tags": { + "type": { + "$ref": "#/34" + }, + "flags": 0, + "description": "The tags for the global network." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.NetworkManager/CoreNetwork", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/35" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.NetworkManager/CoreNetwork@default", + "scopeType": 0, + "body": { + "$ref": "#/36" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AWSLocation", + "properties": { + "SubnetArn": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the subnet that the device is located in." + }, + "Zone": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The Zone that the device is located in. Specify the ID of an Availability Zone, Local Zone, Wavelength Zone, or an Outpost." + } + } + }, + { + "$type": "ObjectType", + "name": "Location", + "properties": { + "Address": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The physical address." + }, + "Latitude": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The latitude." + }, + "Longitude": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The longitude." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.NetworkManager/DeviceProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/40" + } + }, + { + "$type": "ObjectType", + "name": "AWS.NetworkManager/DeviceProperties", + "properties": { + "AWSLocation": { + "type": { + "$ref": "#/38" + }, + "flags": 0, + "description": "The Amazon Web Services location of the device, if applicable." + }, + "CreatedAt": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The date and time that the device was created." + }, + "Description": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The description of the device." + }, + "DeviceArn": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) of the device." + }, + "DeviceId": { + "type": { + "$ref": "#/3" + }, + "flags": 18, + "description": "The ID of the device." + }, + "GlobalNetworkId": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "The ID of the global network." + }, + "Location": { + "type": { + "$ref": "#/39" + }, + "flags": 0, + "description": "The site location." + }, + "Model": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The device model" + }, + "SerialNumber": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The device serial number." + }, + "SiteId": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The site ID." + }, + "State": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The state of the device." + }, + "Tags": { + "type": { + "$ref": "#/42" + }, + "flags": 0, + "description": "The tags for the device." + }, + "Type": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The device type." + }, + "Vendor": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The device vendor." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.NetworkManager/Device", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/43" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.NetworkManager/Device@default", + "scopeType": 0, + "body": { + "$ref": "#/44" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.NetworkManager/GlobalNetworkProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/46" + } + }, + { + "$type": "ObjectType", + "name": "AWS.NetworkManager/GlobalNetworkProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) of the global network." + }, + "CreatedAt": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The date and time that the global network was created." + }, + "Description": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The description of the global network." + }, + "Id": { + "type": { + "$ref": "#/3" + }, + "flags": 18, + "description": "The ID of the global network." + }, + "State": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The state of the global network." + }, + "Tags": { + "type": { + "$ref": "#/48" + }, + "flags": 0, + "description": "The tags for the global network." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.NetworkManager/GlobalNetwork", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/49" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.NetworkManager/GlobalNetwork@default", + "scopeType": 0, + "body": { + "$ref": "#/50" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Bandwidth", + "properties": { + "DownloadSpeed": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Download speed in Mbps." + }, + "UploadSpeed": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Upload speed in Mbps." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.NetworkManager/LinkProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/53" + } + }, + { + "$type": "ObjectType", + "name": "AWS.NetworkManager/LinkProperties", + "properties": { + "Bandwidth": { + "type": { + "$ref": "#/52" + }, + "flags": 1, + "description": "The Bandwidth for the link." + }, + "CreatedAt": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The date and time that the device was created." + }, + "Description": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The description of the link." + }, + "GlobalNetworkId": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "The ID of the global network." + }, + "LinkArn": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) of the link." + }, + "LinkId": { + "type": { + "$ref": "#/3" + }, + "flags": 18, + "description": "The ID of the link." + }, + "Provider": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The provider of the link." + }, + "SiteId": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The ID of the site" + }, + "State": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The state of the link." + }, + "Tags": { + "type": { + "$ref": "#/55" + }, + "flags": 0, + "description": "The tags for the link." + }, + "Type": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The type of the link." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.NetworkManager/Link", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/56" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.NetworkManager/Link@default", + "scopeType": 0, + "body": { + "$ref": "#/57" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Location", + "properties": { + "Address": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The physical address." + }, + "Latitude": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The latitude." + }, + "Longitude": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The longitude." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.NetworkManager/SiteProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/60" + } + }, + { + "$type": "ObjectType", + "name": "AWS.NetworkManager/SiteProperties", + "properties": { + "CreatedAt": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The date and time that the device was created." + }, + "Description": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The description of the site." + }, + "GlobalNetworkId": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "The ID of the global network." + }, + "Location": { + "type": { + "$ref": "#/59" + }, + "flags": 0, + "description": "The location of the site." + }, + "SiteArn": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) of the site." + }, + "SiteId": { + "type": { + "$ref": "#/3" + }, + "flags": 18, + "description": "The ID of the site." + }, + "State": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The state of the site." + }, + "Tags": { + "type": { + "$ref": "#/62" + }, + "flags": 0, + "description": "The tags for the site." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.NetworkManager/Site", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/63" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.NetworkManager/Site@default", + "scopeType": 0, + "body": { + "$ref": "#/64" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "ProposedSegmentChange", + "properties": { + "AttachmentPolicyRuleNumber": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The rule number in the policy document that applies to this change." + }, + "SegmentName": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The name of the segment to change." + }, + "Tags": { + "type": { + "$ref": "#/68" + }, + "flags": 0, + "description": "The key-value tags that changed for the segment." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/67" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.NetworkManager/SiteToSiteVpnAttachmentProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/67" + } + }, + { + "$type": "ObjectType", + "name": "AWS.NetworkManager/SiteToSiteVpnAttachmentProperties", + "properties": { + "AttachmentId": { + "type": { + "$ref": "#/3" + }, + "flags": 18, + "description": "The ID of the attachment." + }, + "AttachmentPolicyRuleNumber": { + "type": { + "$ref": "#/4" + }, + "flags": 2, + "description": "The policy rule number associated with the attachment." + }, + "AttachmentType": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The type of attachment." + }, + "CoreNetworkArn": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The ARN of a core network for the VPC attachment." + }, + "CoreNetworkId": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The ID of a core network where you're creating a site-to-site VPN attachment." + }, + "CreatedAt": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "Creation time of the attachment." + }, + "EdgeLocation": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The Region where the edge is located." + }, + "OwnerAccountId": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "Owner account of the attachment." + }, + "ProposedSegmentChange": { + "type": { + "$ref": "#/66" + }, + "flags": 0, + "description": "The attachment to move from one segment to another." + }, + "ResourceArn": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The ARN of the Resource." + }, + "SegmentName": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The name of the segment that attachment is in." + }, + "State": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The state of the attachment." + }, + "Tags": { + "type": { + "$ref": "#/70" + }, + "flags": 0, + "description": "Tags for the attachment." + }, + "UpdatedAt": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "Last update time of the attachment." + }, + "VpnConnectionArn": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The ARN of the site-to-site VPN attachment." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.NetworkManager/SiteToSiteVpnAttachment", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/71" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.NetworkManager/SiteToSiteVpnAttachment@default", + "scopeType": 0, + "body": { + "$ref": "#/72" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.NetworkManager/TransitGatewayPeeringProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/74" + } + }, + { + "$type": "ObjectType", + "name": "AWS.NetworkManager/TransitGatewayPeeringProperties", + "properties": { + "CoreNetworkArn": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The ARN (Amazon Resource Name) of the core network that you want to peer a transit gateway to." + }, + "CoreNetworkId": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The Id of the core network that you want to peer a transit gateway to." + }, + "CreatedAt": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The creation time of the transit gateway peering" + }, + "EdgeLocation": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The location of the transit gateway peering" + }, + "OwnerAccountId": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "Peering owner account Id" + }, + "PeeringId": { + "type": { + "$ref": "#/3" + }, + "flags": 18, + "description": "The Id of the transit gateway peering" + }, + "PeeringType": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "Peering type (TransitGatewayPeering)" + }, + "ResourceArn": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The ARN (Amazon Resource Name) of the resource that you will peer to a core network" + }, + "State": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The state of the transit gateway peering" + }, + "Tags": { + "type": { + "$ref": "#/76" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + }, + "TransitGatewayArn": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The ARN (Amazon Resource Name) of the transit gateway that you will peer to a core network" + }, + "TransitGatewayPeeringAttachmentId": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The ID of the TransitGatewayPeeringAttachment" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.NetworkManager/TransitGatewayPeering", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/77" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.NetworkManager/TransitGatewayPeering@default", + "scopeType": 0, + "body": { + "$ref": "#/78" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "ProposedSegmentChange", + "properties": { + "AttachmentPolicyRuleNumber": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The rule number in the policy document that applies to this change." + }, + "SegmentName": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The name of the segment to change." + }, + "Tags": { + "type": { + "$ref": "#/82" + }, + "flags": 0, + "description": "The key-value tags that changed for the segment." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/81" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.NetworkManager/TransitGatewayRouteTableAttachmentProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/81" + } + }, + { + "$type": "ObjectType", + "name": "AWS.NetworkManager/TransitGatewayRouteTableAttachmentProperties", + "properties": { + "AttachmentId": { + "type": { + "$ref": "#/3" + }, + "flags": 18, + "description": "The ID of the attachment." + }, + "AttachmentPolicyRuleNumber": { + "type": { + "$ref": "#/4" + }, + "flags": 2, + "description": "The policy rule number associated with the attachment." + }, + "AttachmentType": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The type of attachment." + }, + "CoreNetworkArn": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The ARN of a core network for the VPC attachment." + }, + "CoreNetworkId": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The ID of a core network where you're creating a site-to-site VPN attachment." + }, + "CreatedAt": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "Creation time of the attachment." + }, + "EdgeLocation": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The Region where the edge is located." + }, + "OwnerAccountId": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "Owner account of the attachment." + }, + "PeeringId": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The Id of peering between transit gateway and core network." + }, + "ProposedSegmentChange": { + "type": { + "$ref": "#/80" + }, + "flags": 0, + "description": "The attachment to move from one segment to another." + }, + "ResourceArn": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The ARN of the Resource." + }, + "SegmentName": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The name of the segment that attachment is in." + }, + "State": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The state of the attachment." + }, + "Tags": { + "type": { + "$ref": "#/84" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + }, + "TransitGatewayRouteTableArn": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The Arn of transit gateway route table." + }, + "UpdatedAt": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "Last update time of the attachment." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.NetworkManager/TransitGatewayRouteTableAttachment", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/85" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.NetworkManager/TransitGatewayRouteTableAttachment@default", + "scopeType": 0, + "body": { + "$ref": "#/86" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "ProposedSegmentChange", + "properties": { + "AttachmentPolicyRuleNumber": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The rule number in the policy document that applies to this change." + }, + "SegmentName": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The name of the segment to change." + }, + "Tags": { + "type": { + "$ref": "#/91" + }, + "flags": 0, + "description": "The key-value tags that changed for the segment." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "ObjectType", + "name": "VpcOptions", + "properties": { + "ApplianceModeSupport": { + "type": { + "$ref": "#/92" + }, + "flags": 0, + "description": "Indicates whether to enable ApplianceModeSupport Support for Vpc Attachment. Valid Values: true | false" + }, + "Ipv6Support": { + "type": { + "$ref": "#/92" + }, + "flags": 0, + "description": "Indicates whether to enable Ipv6 Support for Vpc Attachment. Valid Values: enable | disable" + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/89" + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.NetworkManager/VpcAttachmentProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/89" + } + }, + { + "$type": "ObjectType", + "name": "AWS.NetworkManager/VpcAttachmentProperties", + "properties": { + "AttachmentId": { + "type": { + "$ref": "#/3" + }, + "flags": 18, + "description": "Id of the attachment." + }, + "AttachmentPolicyRuleNumber": { + "type": { + "$ref": "#/4" + }, + "flags": 2, + "description": "The policy rule number associated with the attachment." + }, + "AttachmentType": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "Attachment type." + }, + "CoreNetworkArn": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The ARN of a core network for the VPC attachment." + }, + "CoreNetworkId": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The ID of a core network for the VPC attachment." + }, + "CreatedAt": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "Creation time of the attachment." + }, + "EdgeLocation": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The Region where the edge is located." + }, + "Options": { + "type": { + "$ref": "#/90" + }, + "flags": 0, + "description": "Vpc options of the attachment." + }, + "OwnerAccountId": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "Owner account of the attachment." + }, + "ProposedSegmentChange": { + "type": { + "$ref": "#/88" + }, + "flags": 0, + "description": "The attachment to move from one segment to another." + }, + "ResourceArn": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The ARN of the Resource." + }, + "SegmentName": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The name of the segment attachment.." + }, + "State": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "State of the attachment." + }, + "SubnetArns": { + "type": { + "$ref": "#/94" + }, + "flags": 1, + "description": "Subnet Arn list" + }, + "Tags": { + "type": { + "$ref": "#/95" + }, + "flags": 0, + "description": "Tags for the attachment." + }, + "UpdatedAt": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "Last update time of the attachment." + }, + "VpcArn": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The ARN of the VPC." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.NetworkManager/VpcAttachment", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/96" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.NetworkManager/VpcAttachment@default", + "scopeType": 0, + "body": { + "$ref": "#/97" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.networkmanager/default/types.md b/artifacts/bicep/aws/aws.networkmanager/default/types.md index cbdc47ad..a7bb4503 100644 --- a/artifacts/bicep/aws/aws.networkmanager/default/types.md +++ b/artifacts/bicep/aws/aws.networkmanager/default/types.md @@ -3,79 +3,79 @@ ## Resource AWS.NetworkManager/ConnectAttachment@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.NetworkManager/ConnectAttachmentProperties](#awsnetworkmanagerconnectattachmentproperties) (Required): properties of the resource +* **properties**: [AWS.NetworkManager/ConnectAttachmentProperties](#awsnetworkmanagerconnectattachmentproperties) (Required, Identifier): properties of the resource ## Resource AWS.NetworkManager/ConnectPeer@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.NetworkManager/ConnectPeerProperties](#awsnetworkmanagerconnectpeerproperties) (Required): properties of the resource +* **properties**: [AWS.NetworkManager/ConnectPeerProperties](#awsnetworkmanagerconnectpeerproperties) (Required, Identifier): properties of the resource ## Resource AWS.NetworkManager/CoreNetwork@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.NetworkManager/CoreNetworkProperties](#awsnetworkmanagercorenetworkproperties) (Required): properties of the resource +* **properties**: [AWS.NetworkManager/CoreNetworkProperties](#awsnetworkmanagercorenetworkproperties) (Required, Identifier): properties of the resource ## Resource AWS.NetworkManager/Device@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.NetworkManager/DeviceProperties](#awsnetworkmanagerdeviceproperties) (Required): properties of the resource +* **properties**: [AWS.NetworkManager/DeviceProperties](#awsnetworkmanagerdeviceproperties) (Required, Identifier): properties of the resource ## Resource AWS.NetworkManager/GlobalNetwork@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.NetworkManager/GlobalNetworkProperties](#awsnetworkmanagerglobalnetworkproperties): properties of the resource +* **properties**: [AWS.NetworkManager/GlobalNetworkProperties](#awsnetworkmanagerglobalnetworkproperties) (Identifier): properties of the resource ## Resource AWS.NetworkManager/Link@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.NetworkManager/LinkProperties](#awsnetworkmanagerlinkproperties) (Required): properties of the resource +* **properties**: [AWS.NetworkManager/LinkProperties](#awsnetworkmanagerlinkproperties) (Required, Identifier): properties of the resource ## Resource AWS.NetworkManager/Site@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.NetworkManager/SiteProperties](#awsnetworkmanagersiteproperties) (Required): properties of the resource +* **properties**: [AWS.NetworkManager/SiteProperties](#awsnetworkmanagersiteproperties) (Required, Identifier): properties of the resource ## Resource AWS.NetworkManager/SiteToSiteVpnAttachment@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.NetworkManager/SiteToSiteVpnAttachmentProperties](#awsnetworkmanagersitetositevpnattachmentproperties) (Required): properties of the resource +* **properties**: [AWS.NetworkManager/SiteToSiteVpnAttachmentProperties](#awsnetworkmanagersitetositevpnattachmentproperties) (Required, Identifier): properties of the resource ## Resource AWS.NetworkManager/TransitGatewayPeering@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.NetworkManager/TransitGatewayPeeringProperties](#awsnetworkmanagertransitgatewaypeeringproperties) (Required): properties of the resource +* **properties**: [AWS.NetworkManager/TransitGatewayPeeringProperties](#awsnetworkmanagertransitgatewaypeeringproperties) (Required, Identifier): properties of the resource ## Resource AWS.NetworkManager/TransitGatewayRouteTableAttachment@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.NetworkManager/TransitGatewayRouteTableAttachmentProperties](#awsnetworkmanagertransitgatewayroutetableattachmentproperties) (Required): properties of the resource +* **properties**: [AWS.NetworkManager/TransitGatewayRouteTableAttachmentProperties](#awsnetworkmanagertransitgatewayroutetableattachmentproperties) (Required, Identifier): properties of the resource ## Resource AWS.NetworkManager/VpcAttachment@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.NetworkManager/VpcAttachmentProperties](#awsnetworkmanagervpcattachmentproperties) (Required): properties of the resource +* **properties**: [AWS.NetworkManager/VpcAttachmentProperties](#awsnetworkmanagervpcattachmentproperties) (Required, Identifier): properties of the resource ## AWS.NetworkManager/ConnectAttachmentProperties ### Properties @@ -96,21 +96,6 @@ * **TransportAttachmentId**: string (Required): Id of transport attachment * **UpdatedAt**: string (ReadOnly): Last update time of the attachment. -## ConnectAttachmentOptions -### Properties -* **Protocol**: string: Tunnel protocol for connect attachment - -## ProposedSegmentChange -### Properties -* **AttachmentPolicyRuleNumber**: int: The rule number in the policy document that applies to this change. -* **SegmentName**: string: The name of the segment to change. -* **Tags**: [Tag](#tag)[]: The list of key-value tags that changed for the segment. - -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## AWS.NetworkManager/ConnectPeerProperties ### Properties * **BgpOptions**: [BgpOptions](#bgpoptions) (WriteOnly): Bgp options for connect peer. @@ -127,30 +112,6 @@ * **SubnetArn**: string (WriteOnly): The subnet ARN for the connect peer. * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. -## BgpOptions -### Properties -* **PeerAsn**: int - -## ConnectPeerConfiguration -### Properties -* **BgpConfigurations**: [ConnectPeerBgpConfiguration](#connectpeerbgpconfiguration)[] -* **CoreNetworkAddress**: string: The IP address of a core network. -* **InsideCidrBlocks**: string[]: The inside IP addresses used for a Connect peer configuration. -* **PeerAddress**: string: The IP address of the Connect peer. -* **Protocol**: string - -## ConnectPeerBgpConfiguration -### Properties -* **CoreNetworkAddress**: string: The address of a core network. -* **CoreNetworkAsn**: int: The ASN of the Coret Network. -* **PeerAddress**: string: The address of a core network Connect peer. -* **PeerAsn**: int: The ASN of the Connect peer. - -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## AWS.NetworkManager/CoreNetworkProperties ### Properties * **CoreNetworkArn**: string (ReadOnly): The ARN (Amazon resource name) of core network @@ -165,26 +126,6 @@ * **State**: string (ReadOnly): The state of core network * **Tags**: [Tag](#tag)[]: The tags for the global network. -## CoreNetworkEdge -### Properties -* **Asn**: int: The ASN of a core network edge. -* **EdgeLocation**: string: The Region where a core network edge is located. -* **InsideCidrBlocks**: string[] - -## CoreNetwork_PolicyDocument -### Properties - -## CoreNetworkSegment -### Properties -* **EdgeLocations**: string[] -* **Name**: string: Name of segment -* **SharedSegments**: string[] - -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## AWS.NetworkManager/DeviceProperties ### Properties * **AWSLocation**: [AWSLocation](#awslocation): The Amazon Web Services location of the device, if applicable. @@ -202,22 +143,6 @@ * **Type**: string: The device type. * **Vendor**: string: The device vendor. -## AWSLocation -### Properties -* **SubnetArn**: string: The Amazon Resource Name (ARN) of the subnet that the device is located in. -* **Zone**: string: The Zone that the device is located in. Specify the ID of an Availability Zone, Local Zone, Wavelength Zone, or an Outpost. - -## Location -### Properties -* **Address**: string: The physical address. -* **Latitude**: string: The latitude. -* **Longitude**: string: The longitude. - -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## AWS.NetworkManager/GlobalNetworkProperties ### Properties * **Arn**: string (ReadOnly): The Amazon Resource Name (ARN) of the global network. @@ -227,11 +152,6 @@ * **State**: string: The state of the global network. * **Tags**: [Tag](#tag)[]: The tags for the global network. -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## AWS.NetworkManager/LinkProperties ### Properties * **Bandwidth**: [Bandwidth](#bandwidth) (Required): The Bandwidth for the link. @@ -246,16 +166,6 @@ * **Tags**: [Tag](#tag)[]: The tags for the link. * **Type**: string: The type of the link. -## Bandwidth -### Properties -* **DownloadSpeed**: int: Download speed in Mbps. -* **UploadSpeed**: int: Upload speed in Mbps. - -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## AWS.NetworkManager/SiteProperties ### Properties * **CreatedAt**: string (ReadOnly): The date and time that the device was created. @@ -267,17 +177,6 @@ * **State**: string (ReadOnly): The state of the site. * **Tags**: [Tag](#tag)[]: The tags for the site. -## Location -### Properties -* **Address**: string: The physical address. -* **Latitude**: string: The latitude. -* **Longitude**: string: The longitude. - -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## AWS.NetworkManager/SiteToSiteVpnAttachmentProperties ### Properties * **AttachmentId**: string (ReadOnly, Identifier): The ID of the attachment. @@ -296,17 +195,6 @@ * **UpdatedAt**: string (ReadOnly): Last update time of the attachment. * **VpnConnectionArn**: string (Required): The ARN of the site-to-site VPN attachment. -## ProposedSegmentChange -### Properties -* **AttachmentPolicyRuleNumber**: int: The rule number in the policy document that applies to this change. -* **SegmentName**: string: The name of the segment to change. -* **Tags**: [Tag](#tag)[]: The key-value tags that changed for the segment. - -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## AWS.NetworkManager/TransitGatewayPeeringProperties ### Properties * **CoreNetworkArn**: string (ReadOnly): The ARN (Amazon Resource Name) of the core network that you want to peer a transit gateway to. @@ -322,11 +210,6 @@ * **TransitGatewayArn**: string (Required): The ARN (Amazon Resource Name) of the transit gateway that you will peer to a core network * **TransitGatewayPeeringAttachmentId**: string (ReadOnly): The ID of the TransitGatewayPeeringAttachment -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## AWS.NetworkManager/TransitGatewayRouteTableAttachmentProperties ### Properties * **AttachmentId**: string (ReadOnly, Identifier): The ID of the attachment. @@ -346,17 +229,6 @@ * **TransitGatewayRouteTableArn**: string (Required): The Arn of transit gateway route table. * **UpdatedAt**: string (ReadOnly): Last update time of the attachment. -## ProposedSegmentChange -### Properties -* **AttachmentPolicyRuleNumber**: int: The rule number in the policy document that applies to this change. -* **SegmentName**: string: The name of the segment to change. -* **Tags**: [Tag](#tag)[]: The key-value tags that changed for the segment. - -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## AWS.NetworkManager/VpcAttachmentProperties ### Properties * **AttachmentId**: string (ReadOnly, Identifier): Id of the attachment. @@ -377,10 +249,71 @@ * **UpdatedAt**: string (ReadOnly): Last update time of the attachment. * **VpcArn**: string (Required): The ARN of the VPC. -## VpcOptions +## AWSLocation +### Properties +* **SubnetArn**: string: The Amazon Resource Name (ARN) of the subnet that the device is located in. +* **Zone**: string: The Zone that the device is located in. Specify the ID of an Availability Zone, Local Zone, Wavelength Zone, or an Outpost. + +## Bandwidth +### Properties +* **DownloadSpeed**: int: Download speed in Mbps. +* **UploadSpeed**: int: Upload speed in Mbps. + +## BgpOptions +### Properties +* **PeerAsn**: int + +## ConnectAttachmentOptions +### Properties +* **Protocol**: string: Tunnel protocol for connect attachment + +## ConnectPeerBgpConfiguration +### Properties +* **CoreNetworkAddress**: string: The address of a core network. +* **CoreNetworkAsn**: int: The ASN of the Coret Network. +* **PeerAddress**: string: The address of a core network Connect peer. +* **PeerAsn**: int: The ASN of the Connect peer. + +## ConnectPeerConfiguration +### Properties +* **BgpConfigurations**: [ConnectPeerBgpConfiguration](#connectpeerbgpconfiguration)[] +* **CoreNetworkAddress**: string: The IP address of a core network. +* **InsideCidrBlocks**: string[]: The inside IP addresses used for a Connect peer configuration. +* **PeerAddress**: string: The IP address of the Connect peer. +* **Protocol**: string + +## CoreNetwork_PolicyDocument ### Properties -* **ApplianceModeSupport**: bool: Indicates whether to enable ApplianceModeSupport Support for Vpc Attachment. Valid Values: true | false -* **Ipv6Support**: bool: Indicates whether to enable Ipv6 Support for Vpc Attachment. Valid Values: enable | disable + +## CoreNetworkEdge +### Properties +* **Asn**: int: The ASN of a core network edge. +* **EdgeLocation**: string: The Region where a core network edge is located. +* **InsideCidrBlocks**: string[] + +## CoreNetworkSegment +### Properties +* **EdgeLocations**: string[] +* **Name**: string: Name of segment +* **SharedSegments**: string[] + +## Location +### Properties +* **Address**: string: The physical address. +* **Latitude**: string: The latitude. +* **Longitude**: string: The longitude. + +## Location +### Properties +* **Address**: string: The physical address. +* **Latitude**: string: The latitude. +* **Longitude**: string: The longitude. + +## ProposedSegmentChange +### Properties +* **AttachmentPolicyRuleNumber**: int: The rule number in the policy document that applies to this change. +* **SegmentName**: string: The name of the segment to change. +* **Tags**: [Tag](#tag)[]: The list of key-value tags that changed for the segment. ## ProposedSegmentChange ### Properties @@ -388,8 +321,75 @@ * **SegmentName**: string: The name of the segment to change. * **Tags**: [Tag](#tag)[]: The key-value tags that changed for the segment. +## ProposedSegmentChange +### Properties +* **AttachmentPolicyRuleNumber**: int: The rule number in the policy document that applies to this change. +* **SegmentName**: string: The name of the segment to change. +* **Tags**: [Tag](#tag)[]: The key-value tags that changed for the segment. + +## ProposedSegmentChange +### Properties +* **AttachmentPolicyRuleNumber**: int: The rule number in the policy document that applies to this change. +* **SegmentName**: string: The name of the segment to change. +* **Tags**: [Tag](#tag)[]: The key-value tags that changed for the segment. + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + ## Tag ### Properties * **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. * **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## VpcOptions +### Properties +* **ApplianceModeSupport**: bool: Indicates whether to enable ApplianceModeSupport Support for Vpc Attachment. Valid Values: true | false +* **Ipv6Support**: bool: Indicates whether to enable Ipv6 Support for Vpc Attachment. Valid Values: enable | disable + diff --git a/artifacts/bicep/aws/aws.nimblestudio/default/types.json b/artifacts/bicep/aws/aws.nimblestudio/default/types.json index 5aa603d5..cded505b 100644 --- a/artifacts/bicep/aws/aws.nimblestudio/default/types.json +++ b/artifacts/bicep/aws/aws.nimblestudio/default/types.json @@ -1 +1,987 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"AutomaticTerminationMode"}},{"2":{"Name":"SessionBackupMode"}},{"2":{"Name":"SessionPersistenceMode"}},{"2":{"Name":"StreamConfiguration","Properties":{"AutomaticTerminationMode":{"Type":4,"Flags":0},"ClipboardMode":{"Type":4,"Flags":1},"Ec2InstanceTypes":{"Type":20,"Flags":1,"Description":"

The EC2 instance types that users can select from when launching a streaming session\n with this launch profile.

"},"MaxSessionLengthInMinutes":{"Type":3,"Flags":0,"Description":"

The length of time, in minutes, that a streaming session can be active before it is\n stopped or terminated. After this point, Nimble Studio automatically terminates or\n stops the session. The default length of time is 690 minutes, and the maximum length of\n time is 30 days.

"},"MaxStoppedSessionLengthInMinutes":{"Type":3,"Flags":0,"Description":"

Integer that determines if you can start and stop your sessions and how long a session\n can stay in the STOPPED state. The default value is 0. The maximum value is\n 5760.

\n

This field is allowed only when sessionPersistenceMode is\n ACTIVATED and automaticTerminationMode is\n ACTIVATED.

\n

If the value is set to 0, your sessions can?t be STOPPED. If you then\n call StopStreamingSession, the session fails. If the time that a session\n stays in the READY state exceeds the maxSessionLengthInMinutes\n value, the session will automatically be terminated (instead of\n STOPPED).

\n

If the value is set to a positive number, the session can be stopped. You can call\n StopStreamingSession to stop sessions in the READY state.\n If the time that a session stays in the READY state exceeds the\n maxSessionLengthInMinutes value, the session will automatically be\n stopped (instead of terminated).

"},"SessionBackup":{"Type":12,"Flags":0},"SessionPersistenceMode":{"Type":4,"Flags":0},"SessionStorage":{"Type":13,"Flags":0},"StreamingImageIds":{"Type":21,"Flags":1,"Description":"

The streaming images that users can select from when launching a streaming session\n with this launch profile.

"},"VolumeConfiguration":{"Type":19,"Flags":0}}}},{"2":{"Name":"StreamConfigurationSessionBackup","Properties":{"MaxBackupsToRetain":{"Type":3,"Flags":0,"Description":"

The maximum number of backups that each streaming session created from this launch\n profile can have.

"},"Mode":{"Type":4,"Flags":0}}}},{"2":{"Name":"StreamConfigurationSessionStorage","Properties":{"Mode":{"Type":22,"Flags":1,"Description":"

Allows artists to upload files to their workstations. The only valid option is\n UPLOAD.

"},"Root":{"Type":17,"Flags":0}}}},{"2":{"Name":"StreamingClipboardMode"}},{"2":{"Name":"StreamingInstanceType"}},{"2":{"Name":"StreamingSessionStorageMode"}},{"2":{"Name":"StreamingSessionStorageRoot","Properties":{"Linux":{"Type":4,"Flags":0,"Description":"

The folder path in Linux workstations where files are uploaded.

"},"Windows":{"Type":4,"Flags":0,"Description":"

The folder path in Windows workstations where files are uploaded.

"}}}},{"2":{"Name":"Tags","Properties":{}}},{"2":{"Name":"VolumeConfiguration","Properties":{"Iops":{"Type":3,"Flags":0,"Description":"

The number of I/O operations per second for the root volume that is attached to\n streaming session.

"},"Size":{"Type":3,"Flags":0,"Description":"

The size of the root volume that is attached to the streaming session. The root volume\n size is measured in GiBs.

"},"Throughput":{"Type":3,"Flags":0,"Description":"

The throughput to provision for the root volume that is attached to the streaming\n session. The throughput is measured in MiB/s.

"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.NimbleStudio/LaunchProfileProperties","Properties":{"Description":{"Type":4,"Flags":0,"Description":"

The description.

"},"Ec2SubnetIds":{"Type":24,"Flags":1,"Description":"

Specifies the IDs of the EC2 subnets where streaming sessions will be accessible from.\n These subnets must support the specified instance types.

"},"LaunchProfileId":{"Type":4,"Flags":18},"LaunchProfileProtocolVersions":{"Type":25,"Flags":1,"Description":"

The version number of the protocol that is used by the launch profile. The only valid\n version is \"2021-03-31\".

"},"Name":{"Type":4,"Flags":1,"Description":"

The name for the launch profile.

"},"StreamConfiguration":{"Type":11,"Flags":1},"StudioComponentIds":{"Type":26,"Flags":1,"Description":"

Unique identifiers for a collection of studio components that can be used with this\n launch profile.

"},"StudioId":{"Type":4,"Flags":17,"Description":"

The studio ID.

"},"Tags":{"Type":18,"Flags":0}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.NimbleStudio/LaunchProfile","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":23,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.NimbleStudio/LaunchProfile@default","ScopeType":0,"Body":27}},{"2":{"Name":"StreamingImageEncryptionConfiguration","Properties":{"KeyArn":{"Type":4,"Flags":0,"Description":"

The ARN for a KMS key that is used to encrypt studio data.

"},"KeyType":{"Type":4,"Flags":1}}}},{"2":{"Name":"StreamingImageEncryptionConfigurationKeyType"}},{"2":{"Name":"Tags","Properties":{}}},{"2":{"Name":"AWS.NimbleStudio/StreamingImageProperties","Properties":{"Description":{"Type":4,"Flags":0,"Description":"

A human-readable description of the streaming image.

"},"Ec2ImageId":{"Type":4,"Flags":1,"Description":"

The ID of an EC2 machine image with which to create this streaming image.

"},"EncryptionConfiguration":{"Type":29,"Flags":2},"EulaIds":{"Type":33,"Flags":2,"Description":"

The list of EULAs that must be accepted before a Streaming Session can be started using this streaming image.

"},"Name":{"Type":4,"Flags":1,"Description":"

A friendly name for a streaming image resource.

"},"Owner":{"Type":4,"Flags":2,"Description":"

The owner of the streaming image, either the studioId that contains the streaming image, or 'amazon' for images that are provided by Amazon Nimble Studio.

"},"Platform":{"Type":4,"Flags":2,"Description":"

The platform of the streaming image, either WINDOWS or LINUX.

"},"StreamingImageId":{"Type":4,"Flags":18},"StudioId":{"Type":4,"Flags":17,"Description":"

The studioId.

"},"Tags":{"Type":31,"Flags":0}}}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.NimbleStudio/StreamingImage","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":32,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.NimbleStudio/StreamingImage@default","ScopeType":0,"Body":34}},{"2":{"Name":"StudioEncryptionConfiguration","Properties":{"KeyArn":{"Type":4,"Flags":0,"Description":"

The ARN for a KMS key that is used to encrypt studio data.

"},"KeyType":{"Type":4,"Flags":1}}}},{"2":{"Name":"StudioEncryptionConfigurationKeyType"}},{"2":{"Name":"Tags","Properties":{}}},{"2":{"Name":"AWS.NimbleStudio/StudioProperties","Properties":{"AdminRoleArn":{"Type":4,"Flags":1,"Description":"

The IAM role that Studio Admins will assume when logging in to the Nimble Studio portal.

"},"DisplayName":{"Type":4,"Flags":1,"Description":"

A friendly name for the studio.

"},"HomeRegion":{"Type":4,"Flags":2,"Description":"

The Amazon Web Services Region where the studio resource is located.

"},"SsoClientId":{"Type":4,"Flags":2,"Description":"

The Amazon Web Services SSO application client ID used to integrate with Amazon Web Services SSO to enable Amazon Web Services SSO users to log in to Nimble Studio portal.

"},"StudioEncryptionConfiguration":{"Type":36,"Flags":0},"StudioId":{"Type":4,"Flags":18},"StudioName":{"Type":4,"Flags":1,"Description":"

The studio name that is used in the URL of the Nimble Studio portal when accessed by Nimble Studio users.

"},"StudioUrl":{"Type":4,"Flags":2,"Description":"

The address of the web page for the studio.

"},"Tags":{"Type":38,"Flags":0},"UserRoleArn":{"Type":4,"Flags":1,"Description":"

The IAM role that Studio Users will assume when logging in to the Nimble Studio portal.

"}}}},{"2":{"Name":"AWS.NimbleStudio/Studio","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":39,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.NimbleStudio/Studio@default","ScopeType":0,"Body":40}},{"2":{"Name":"ActiveDirectoryComputerAttribute","Properties":{"Name":{"Type":4,"Flags":0,"Description":"

The name for the LDAP attribute.

"},"Value":{"Type":4,"Flags":0,"Description":"

The value for the LDAP attribute.

"}}}},{"2":{"Name":"ActiveDirectoryConfiguration","Properties":{"ComputerAttributes":{"Type":55,"Flags":0,"Description":"

A collection of custom attributes for an Active Directory computer.

"},"DirectoryId":{"Type":4,"Flags":0,"Description":"

The directory ID of the Directory Service for Microsoft Active Directory to access\n using this studio component.

"},"OrganizationalUnitDistinguishedName":{"Type":4,"Flags":0,"Description":"

The distinguished name (DN) and organizational unit (OU) of an Active Directory\n computer.

"}}}},{"2":{"Name":"ComputeFarmConfiguration","Properties":{"ActiveDirectoryUser":{"Type":4,"Flags":0,"Description":"

The name of an Active Directory user that is used on ComputeFarm worker\n instances.

"},"Endpoint":{"Type":4,"Flags":0,"Description":"

The endpoint of the ComputeFarm that is accessed by the studio component\n resource.

"}}}},{"2":{"Name":"LaunchProfilePlatform"}},{"2":{"Name":"LicenseServiceConfiguration","Properties":{"Endpoint":{"Type":4,"Flags":0,"Description":"

The endpoint of the license service that is accessed by the studio component\n resource.

"}}}},{"2":{"Name":"ScriptParameterKeyValue","Properties":{"Key":{"Type":4,"Flags":0,"Description":"

A script parameter key.

"},"Value":{"Type":4,"Flags":0,"Description":"

A script parameter value.

"}}}},{"2":{"Name":"SharedFileSystemConfiguration","Properties":{"Endpoint":{"Type":4,"Flags":0,"Description":"

The endpoint of the shared file system that is accessed by the studio component\n resource.

"},"FileSystemId":{"Type":4,"Flags":0,"Description":"

The unique identifier for a file system.

"},"LinuxMountPoint":{"Type":4,"Flags":0,"Description":"

The mount location for a shared file system on a Linux virtual workstation.

"},"ShareName":{"Type":4,"Flags":0,"Description":"

The name of the file share.

"},"WindowsMountDrive":{"Type":4,"Flags":0,"Description":"

The mount location for a shared file system on a Windows virtual workstation.

"}}}},{"2":{"Name":"StudioComponentConfiguration","Properties":{}}},{"2":{"Name":"StudioComponentInitializationScript","Properties":{"LaunchProfileProtocolVersion":{"Type":4,"Flags":0,"Description":"

The version number of the protocol that is used by the launch profile. The only valid\n version is \"2021-03-31\".

"},"Platform":{"Type":4,"Flags":0},"RunContext":{"Type":4,"Flags":0},"Script":{"Type":4,"Flags":0,"Description":"

The initialization script.

"}}}},{"2":{"Name":"StudioComponentInitializationScriptRunContext"}},{"2":{"Name":"StudioComponentSubtype"}},{"2":{"Name":"StudioComponentType"}},{"2":{"Name":"Tags","Properties":{}}},{"3":{"ItemType":42}},{"2":{"Name":"AWS.NimbleStudio/StudioComponentProperties","Properties":{"Configuration":{"Type":49,"Flags":0},"Description":{"Type":4,"Flags":0,"Description":"

The description.

"},"Ec2SecurityGroupIds":{"Type":57,"Flags":0,"Description":"

The EC2 security groups that control access to the studio component.

"},"InitializationScripts":{"Type":58,"Flags":0,"Description":"

Initialization scripts for studio components.

"},"Name":{"Type":4,"Flags":1,"Description":"

The name for the studio component.

"},"RuntimeRoleArn":{"Type":4,"Flags":0},"ScriptParameters":{"Type":59,"Flags":0,"Description":"

Parameters for the studio component scripts.

"},"SecureInitializationRoleArn":{"Type":4,"Flags":0},"StudioComponentId":{"Type":4,"Flags":18},"StudioId":{"Type":4,"Flags":17,"Description":"

The studio ID.

"},"Subtype":{"Type":4,"Flags":0},"Tags":{"Type":54,"Flags":0},"Type":{"Type":4,"Flags":1}}}},{"3":{"ItemType":4}},{"3":{"ItemType":50}},{"3":{"ItemType":47}},{"2":{"Name":"AWS.NimbleStudio/StudioComponent","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":56,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.NimbleStudio/StudioComponent@default","ScopeType":0,"Body":60}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "AutomaticTerminationMode", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SessionBackupMode", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SessionPersistenceMode", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "StreamConfiguration", + "properties": { + "AutomaticTerminationMode": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + }, + "ClipboardMode": { + "type": { + "$ref": "#/12" + }, + "flags": 1 + }, + "Ec2InstanceTypes": { + "type": { + "$ref": "#/13" + }, + "flags": 1, + "description": "

The EC2 instance types that users can select from when launching a streaming session\n with this launch profile.

" + }, + "MaxSessionLengthInMinutes": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "

The length of time, in minutes, that a streaming session can be active before it is\n stopped or terminated. After this point, Nimble Studio automatically terminates or\n stops the session. The default length of time is 690 minutes, and the maximum length of\n time is 30 days.

" + }, + "MaxStoppedSessionLengthInMinutes": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "

Integer that determines if you can start and stop your sessions and how long a session\n can stay in the STOPPED state. The default value is 0. The maximum value is\n 5760.

\n

This field is allowed only when sessionPersistenceMode is\n ACTIVATED and automaticTerminationMode is\n ACTIVATED.

\n

If the value is set to 0, your sessions can?t be STOPPED. If you then\n call StopStreamingSession, the session fails. If the time that a session\n stays in the READY state exceeds the maxSessionLengthInMinutes\n value, the session will automatically be terminated (instead of\n STOPPED).

\n

If the value is set to a positive number, the session can be stopped. You can call\n StopStreamingSession to stop sessions in the READY state.\n If the time that a session stays in the READY state exceeds the\n maxSessionLengthInMinutes value, the session will automatically be\n stopped (instead of terminated).

" + }, + "SessionBackup": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "SessionPersistenceMode": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + }, + "SessionStorage": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "StreamingImageIds": { + "type": { + "$ref": "#/15" + }, + "flags": 1, + "description": "

The streaming images that users can select from when launching a streaming session\n with this launch profile.

" + }, + "VolumeConfiguration": { + "type": { + "$ref": "#/11" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "StreamConfigurationSessionBackup", + "properties": { + "MaxBackupsToRetain": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "

The maximum number of backups that each streaming session created from this launch\n profile can have.

" + }, + "Mode": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "StreamConfigurationSessionStorage", + "properties": { + "Mode": { + "type": { + "$ref": "#/16" + }, + "flags": 1, + "description": "

Allows artists to upload files to their workstations. The only valid option is\n UPLOAD.

" + }, + "Root": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "StreamingClipboardMode", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "StreamingInstanceType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "StreamingSessionStorageMode", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "StreamingSessionStorageRoot", + "properties": { + "Linux": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "

The folder path in Linux workstations where files are uploaded.

" + }, + "Windows": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "

The folder path in Windows workstations where files are uploaded.

" + } + } + }, + { + "$type": "ObjectType", + "name": "Tags", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "VolumeConfiguration", + "properties": { + "Iops": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "

The number of I/O operations per second for the root volume that is attached to\n streaming session.

" + }, + "Size": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "

The size of the root volume that is attached to the streaming session. The root volume\n size is measured in GiBs.

" + }, + "Throughput": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "

The throughput to provision for the root volume that is attached to the streaming\n session. The throughput is measured in MiB/s.

" + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/12" + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/12" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/12" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.NimbleStudio/LaunchProfileProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/12" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/12" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/12" + } + }, + { + "$type": "ObjectType", + "name": "AWS.NimbleStudio/LaunchProfileProperties", + "properties": { + "Description": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "

The description.

" + }, + "Ec2SubnetIds": { + "type": { + "$ref": "#/18" + }, + "flags": 1, + "description": "

Specifies the IDs of the EC2 subnets where streaming sessions will be accessible from.\n These subnets must support the specified instance types.

" + }, + "LaunchProfileId": { + "type": { + "$ref": "#/12" + }, + "flags": 18 + }, + "LaunchProfileProtocolVersions": { + "type": { + "$ref": "#/19" + }, + "flags": 1, + "description": "

The version number of the protocol that is used by the launch profile. The only valid\n version is \"2021-03-31\".

" + }, + "Name": { + "type": { + "$ref": "#/12" + }, + "flags": 1, + "description": "

The name for the launch profile.

" + }, + "StreamConfiguration": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + }, + "StudioComponentIds": { + "type": { + "$ref": "#/20" + }, + "flags": 1, + "description": "

Unique identifiers for a collection of studio components that can be used with this\n launch profile.

" + }, + "StudioId": { + "type": { + "$ref": "#/12" + }, + "flags": 17, + "description": "

The studio ID.

" + }, + "Tags": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.NimbleStudio/LaunchProfile", + "properties": { + "name": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/12" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/21" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.NimbleStudio/LaunchProfile@default", + "scopeType": 0, + "body": { + "$ref": "#/22" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "StreamingImageEncryptionConfiguration", + "properties": { + "KeyArn": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "

The ARN for a KMS key that is used to encrypt studio data.

" + }, + "KeyType": { + "type": { + "$ref": "#/12" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "StreamingImageEncryptionConfigurationKeyType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tags", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.NimbleStudio/StreamingImageProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/12" + } + }, + { + "$type": "ObjectType", + "name": "AWS.NimbleStudio/StreamingImageProperties", + "properties": { + "Description": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "

A human-readable description of the streaming image.

" + }, + "Ec2ImageId": { + "type": { + "$ref": "#/12" + }, + "flags": 1, + "description": "

The ID of an EC2 machine image with which to create this streaming image.

" + }, + "EncryptionConfiguration": { + "type": { + "$ref": "#/24" + }, + "flags": 2 + }, + "EulaIds": { + "type": { + "$ref": "#/28" + }, + "flags": 2, + "description": "

The list of EULAs that must be accepted before a Streaming Session can be started using this streaming image.

" + }, + "Name": { + "type": { + "$ref": "#/12" + }, + "flags": 1, + "description": "

A friendly name for a streaming image resource.

" + }, + "Owner": { + "type": { + "$ref": "#/12" + }, + "flags": 2, + "description": "

The owner of the streaming image, either the studioId that contains the streaming image, or 'amazon' for images that are provided by Amazon Nimble Studio.

" + }, + "Platform": { + "type": { + "$ref": "#/12" + }, + "flags": 2, + "description": "

The platform of the streaming image, either WINDOWS or LINUX.

" + }, + "StreamingImageId": { + "type": { + "$ref": "#/12" + }, + "flags": 18 + }, + "StudioId": { + "type": { + "$ref": "#/12" + }, + "flags": 17, + "description": "

The studioId.

" + }, + "Tags": { + "type": { + "$ref": "#/26" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.NimbleStudio/StreamingImage", + "properties": { + "name": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/12" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/29" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.NimbleStudio/StreamingImage@default", + "scopeType": 0, + "body": { + "$ref": "#/30" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "StudioEncryptionConfiguration", + "properties": { + "KeyArn": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "

The ARN for a KMS key that is used to encrypt studio data.

" + }, + "KeyType": { + "type": { + "$ref": "#/12" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "StudioEncryptionConfigurationKeyType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tags", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.NimbleStudio/StudioProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.NimbleStudio/StudioProperties", + "properties": { + "AdminRoleArn": { + "type": { + "$ref": "#/12" + }, + "flags": 1, + "description": "

The IAM role that Studio Admins will assume when logging in to the Nimble Studio portal.

" + }, + "DisplayName": { + "type": { + "$ref": "#/12" + }, + "flags": 1, + "description": "

A friendly name for the studio.

" + }, + "HomeRegion": { + "type": { + "$ref": "#/12" + }, + "flags": 2, + "description": "

The Amazon Web Services Region where the studio resource is located.

" + }, + "SsoClientId": { + "type": { + "$ref": "#/12" + }, + "flags": 2, + "description": "

The Amazon Web Services SSO application client ID used to integrate with Amazon Web Services SSO to enable Amazon Web Services SSO users to log in to Nimble Studio portal.

" + }, + "StudioEncryptionConfiguration": { + "type": { + "$ref": "#/32" + }, + "flags": 0 + }, + "StudioId": { + "type": { + "$ref": "#/12" + }, + "flags": 18 + }, + "StudioName": { + "type": { + "$ref": "#/12" + }, + "flags": 1, + "description": "

The studio name that is used in the URL of the Nimble Studio portal when accessed by Nimble Studio users.

" + }, + "StudioUrl": { + "type": { + "$ref": "#/12" + }, + "flags": 2, + "description": "

The address of the web page for the studio.

" + }, + "Tags": { + "type": { + "$ref": "#/34" + }, + "flags": 0 + }, + "UserRoleArn": { + "type": { + "$ref": "#/12" + }, + "flags": 1, + "description": "

The IAM role that Studio Users will assume when logging in to the Nimble Studio portal.

" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.NimbleStudio/Studio", + "properties": { + "name": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/12" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/36" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.NimbleStudio/Studio@default", + "scopeType": 0, + "body": { + "$ref": "#/37" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "ActiveDirectoryComputerAttribute", + "properties": { + "Name": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "

The name for the LDAP attribute.

" + }, + "Value": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "

The value for the LDAP attribute.

" + } + } + }, + { + "$type": "ObjectType", + "name": "ActiveDirectoryConfiguration", + "properties": { + "ComputerAttributes": { + "type": { + "$ref": "#/52" + }, + "flags": 0, + "description": "

A collection of custom attributes for an Active Directory computer.

" + }, + "DirectoryId": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "

The directory ID of the Directory Service for Microsoft Active Directory to access\n using this studio component.

" + }, + "OrganizationalUnitDistinguishedName": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "

The distinguished name (DN) and organizational unit (OU) of an Active Directory\n computer.

" + } + } + }, + { + "$type": "ObjectType", + "name": "ComputeFarmConfiguration", + "properties": { + "ActiveDirectoryUser": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "

The name of an Active Directory user that is used on ComputeFarm worker\n instances.

" + }, + "Endpoint": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "

The endpoint of the ComputeFarm that is accessed by the studio component\n resource.

" + } + } + }, + { + "$type": "ObjectType", + "name": "LaunchProfilePlatform", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LicenseServiceConfiguration", + "properties": { + "Endpoint": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "

The endpoint of the license service that is accessed by the studio component\n resource.

" + } + } + }, + { + "$type": "ObjectType", + "name": "ScriptParameterKeyValue", + "properties": { + "Key": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "

A script parameter key.

" + }, + "Value": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "

A script parameter value.

" + } + } + }, + { + "$type": "ObjectType", + "name": "SharedFileSystemConfiguration", + "properties": { + "Endpoint": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "

The endpoint of the shared file system that is accessed by the studio component\n resource.

" + }, + "FileSystemId": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "

The unique identifier for a file system.

" + }, + "LinuxMountPoint": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "

The mount location for a shared file system on a Linux virtual workstation.

" + }, + "ShareName": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "

The name of the file share.

" + }, + "WindowsMountDrive": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "

The mount location for a shared file system on a Windows virtual workstation.

" + } + } + }, + { + "$type": "ObjectType", + "name": "StudioComponentConfiguration", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "StudioComponentInitializationScript", + "properties": { + "LaunchProfileProtocolVersion": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "

The version number of the protocol that is used by the launch profile. The only valid\n version is \"2021-03-31\".

" + }, + "Platform": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + }, + "RunContext": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + }, + "Script": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "

The initialization script.

" + } + } + }, + { + "$type": "ObjectType", + "name": "StudioComponentInitializationScriptRunContext", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "StudioComponentSubtype", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "StudioComponentType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tags", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/39" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.NimbleStudio/StudioComponentProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/12" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/47" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/44" + } + }, + { + "$type": "ObjectType", + "name": "AWS.NimbleStudio/StudioComponentProperties", + "properties": { + "Configuration": { + "type": { + "$ref": "#/46" + }, + "flags": 0 + }, + "Description": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "

The description.

" + }, + "Ec2SecurityGroupIds": { + "type": { + "$ref": "#/54" + }, + "flags": 0, + "description": "

The EC2 security groups that control access to the studio component.

" + }, + "InitializationScripts": { + "type": { + "$ref": "#/55" + }, + "flags": 0, + "description": "

Initialization scripts for studio components.

" + }, + "Name": { + "type": { + "$ref": "#/12" + }, + "flags": 1, + "description": "

The name for the studio component.

" + }, + "RuntimeRoleArn": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + }, + "ScriptParameters": { + "type": { + "$ref": "#/56" + }, + "flags": 0, + "description": "

Parameters for the studio component scripts.

" + }, + "SecureInitializationRoleArn": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + }, + "StudioComponentId": { + "type": { + "$ref": "#/12" + }, + "flags": 18 + }, + "StudioId": { + "type": { + "$ref": "#/12" + }, + "flags": 17, + "description": "

The studio ID.

" + }, + "Subtype": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/51" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/12" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.NimbleStudio/StudioComponent", + "properties": { + "name": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/12" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/57" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.NimbleStudio/StudioComponent@default", + "scopeType": 0, + "body": { + "$ref": "#/58" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.nimblestudio/default/types.md b/artifacts/bicep/aws/aws.nimblestudio/default/types.md index 93d49cda..55bbd931 100644 --- a/artifacts/bicep/aws/aws.nimblestudio/default/types.md +++ b/artifacts/bicep/aws/aws.nimblestudio/default/types.md @@ -3,30 +3,30 @@ ## Resource AWS.NimbleStudio/LaunchProfile@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.NimbleStudio/LaunchProfileProperties](#awsnimblestudiolaunchprofileproperties) (Required): properties of the resource +* **properties**: [AWS.NimbleStudio/LaunchProfileProperties](#awsnimblestudiolaunchprofileproperties) (Required, Identifier): properties of the resource ## Resource AWS.NimbleStudio/StreamingImage@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.NimbleStudio/StreamingImageProperties](#awsnimblestudiostreamingimageproperties) (Required): properties of the resource +* **properties**: [AWS.NimbleStudio/StreamingImageProperties](#awsnimblestudiostreamingimageproperties) (Required, Identifier): properties of the resource ## Resource AWS.NimbleStudio/Studio@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.NimbleStudio/StudioProperties](#awsnimblestudiostudioproperties) (Required): properties of the resource +* **properties**: [AWS.NimbleStudio/StudioProperties](#awsnimblestudiostudioproperties) (Required, Identifier): properties of the resource ## Resource AWS.NimbleStudio/StudioComponent@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.NimbleStudio/StudioComponentProperties](#awsnimblestudiostudiocomponentproperties) (Required): properties of the resource +* **properties**: [AWS.NimbleStudio/StudioComponentProperties](#awsnimblestudiostudiocomponentproperties) (Required, Identifier): properties of the resource ## AWS.NimbleStudio/LaunchProfileProperties ### Properties @@ -43,6 +43,53 @@ * **StudioId**: string (Required, Identifier):

The studio ID.

* **Tags**: [Tags](#tags) +## AWS.NimbleStudio/StreamingImageProperties +### Properties +* **Description**: string:

A human-readable description of the streaming image.

+* **Ec2ImageId**: string (Required):

The ID of an EC2 machine image with which to create this streaming image.

+* **EncryptionConfiguration**: [StreamingImageEncryptionConfiguration](#streamingimageencryptionconfiguration) (ReadOnly) +* **EulaIds**: string[] (ReadOnly):

The list of EULAs that must be accepted before a Streaming Session can be started using this streaming image.

+* **Name**: string (Required):

A friendly name for a streaming image resource.

+* **Owner**: string (ReadOnly):

The owner of the streaming image, either the studioId that contains the streaming image, or 'amazon' for images that are provided by Amazon Nimble Studio.

+* **Platform**: string (ReadOnly):

The platform of the streaming image, either WINDOWS or LINUX.

+* **StreamingImageId**: string (ReadOnly, Identifier) +* **StudioId**: string (Required, Identifier):

The studioId.

+* **Tags**: [Tags](#tags) + +## AWS.NimbleStudio/StudioComponentProperties +### Properties +* **Configuration**: [StudioComponentConfiguration](#studiocomponentconfiguration) +* **Description**: string:

The description.

+* **Ec2SecurityGroupIds**: string[]:

The EC2 security groups that control access to the studio component.

+* **InitializationScripts**: [StudioComponentInitializationScript](#studiocomponentinitializationscript)[]:

Initialization scripts for studio components.

+* **Name**: string (Required):

The name for the studio component.

+* **RuntimeRoleArn**: string +* **ScriptParameters**: [ScriptParameterKeyValue](#scriptparameterkeyvalue)[]:

Parameters for the studio component scripts.

+* **SecureInitializationRoleArn**: string +* **StudioComponentId**: string (ReadOnly, Identifier) +* **StudioId**: string (Required, Identifier):

The studio ID.

+* **Subtype**: string +* **Tags**: [Tags](#tags) +* **Type**: string (Required) + +## AWS.NimbleStudio/StudioProperties +### Properties +* **AdminRoleArn**: string (Required):

The IAM role that Studio Admins will assume when logging in to the Nimble Studio portal.

+* **DisplayName**: string (Required):

A friendly name for the studio.

+* **HomeRegion**: string (ReadOnly):

The Amazon Web Services Region where the studio resource is located.

+* **SsoClientId**: string (ReadOnly):

The Amazon Web Services SSO application client ID used to integrate with Amazon Web Services SSO to enable Amazon Web Services SSO users to log in to Nimble Studio portal.

+* **StudioEncryptionConfiguration**: [StudioEncryptionConfiguration](#studioencryptionconfiguration) +* **StudioId**: string (ReadOnly, Identifier) +* **StudioName**: string (Required):

The studio name that is used in the URL of the Nimble Studio portal when accessed by Nimble Studio users.

+* **StudioUrl**: string (ReadOnly):

The address of the web page for the studio.

+* **Tags**: [Tags](#tags) +* **UserRoleArn**: string (Required):

The IAM role that Studio Users will assume when logging in to the Nimble Studio portal.

+ +## ScriptParameterKeyValue +### Properties +* **Key**: string:

A script parameter key.

+* **Value**: string:

A script parameter value.

+ ## StreamConfiguration ### Properties * **AutomaticTerminationMode**: string @@ -88,56 +135,26 @@ UPLOAD.

* **Root**: [StreamingSessionStorageRoot](#streamingsessionstorageroot) -## StreamingSessionStorageRoot -### Properties -* **Linux**: string:

The folder path in Linux workstations where files are uploaded.

-* **Windows**: string:

The folder path in Windows workstations where files are uploaded.

- -## VolumeConfiguration -### Properties -* **Iops**: int:

The number of I/O operations per second for the root volume that is attached to - streaming session.

-* **Size**: int:

The size of the root volume that is attached to the streaming session. The root volume - size is measured in GiBs.

-* **Throughput**: int:

The throughput to provision for the root volume that is attached to the streaming - session. The throughput is measured in MiB/s.

- -## Tags -### Properties - -## AWS.NimbleStudio/StreamingImageProperties -### Properties -* **Description**: string:

A human-readable description of the streaming image.

-* **Ec2ImageId**: string (Required):

The ID of an EC2 machine image with which to create this streaming image.

-* **EncryptionConfiguration**: [StreamingImageEncryptionConfiguration](#streamingimageencryptionconfiguration) (ReadOnly) -* **EulaIds**: string[] (ReadOnly):

The list of EULAs that must be accepted before a Streaming Session can be started using this streaming image.

-* **Name**: string (Required):

A friendly name for a streaming image resource.

-* **Owner**: string (ReadOnly):

The owner of the streaming image, either the studioId that contains the streaming image, or 'amazon' for images that are provided by Amazon Nimble Studio.

-* **Platform**: string (ReadOnly):

The platform of the streaming image, either WINDOWS or LINUX.

-* **StreamingImageId**: string (ReadOnly, Identifier) -* **StudioId**: string (Required, Identifier):

The studioId.

-* **Tags**: [Tags](#tags) - ## StreamingImageEncryptionConfiguration ### Properties * **KeyArn**: string:

The ARN for a KMS key that is used to encrypt studio data.

* **KeyType**: string (Required) -## Tags +## StreamingSessionStorageRoot ### Properties +* **Linux**: string:

The folder path in Linux workstations where files are uploaded.

+* **Windows**: string:

The folder path in Windows workstations where files are uploaded.

-## AWS.NimbleStudio/StudioProperties +## StudioComponentConfiguration ### Properties -* **AdminRoleArn**: string (Required):

The IAM role that Studio Admins will assume when logging in to the Nimble Studio portal.

-* **DisplayName**: string (Required):

A friendly name for the studio.

-* **HomeRegion**: string (ReadOnly):

The Amazon Web Services Region where the studio resource is located.

-* **SsoClientId**: string (ReadOnly):

The Amazon Web Services SSO application client ID used to integrate with Amazon Web Services SSO to enable Amazon Web Services SSO users to log in to Nimble Studio portal.

-* **StudioEncryptionConfiguration**: [StudioEncryptionConfiguration](#studioencryptionconfiguration) -* **StudioId**: string (ReadOnly, Identifier) -* **StudioName**: string (Required):

The studio name that is used in the URL of the Nimble Studio portal when accessed by Nimble Studio users.

-* **StudioUrl**: string (ReadOnly):

The address of the web page for the studio.

-* **Tags**: [Tags](#tags) -* **UserRoleArn**: string (Required):

The IAM role that Studio Users will assume when logging in to the Nimble Studio portal.

+ +## StudioComponentInitializationScript +### Properties +* **LaunchProfileProtocolVersion**: string:

The version number of the protocol that is used by the launch profile. The only valid + version is "2021-03-31".

+* **Platform**: string +* **RunContext**: string +* **Script**: string:

The initialization script.

## StudioEncryptionConfiguration ### Properties @@ -147,38 +164,21 @@ ## Tags ### Properties -## AWS.NimbleStudio/StudioComponentProperties -### Properties -* **Configuration**: [StudioComponentConfiguration](#studiocomponentconfiguration) -* **Description**: string:

The description.

-* **Ec2SecurityGroupIds**: string[]:

The EC2 security groups that control access to the studio component.

-* **InitializationScripts**: [StudioComponentInitializationScript](#studiocomponentinitializationscript)[]:

Initialization scripts for studio components.

-* **Name**: string (Required):

The name for the studio component.

-* **RuntimeRoleArn**: string -* **ScriptParameters**: [ScriptParameterKeyValue](#scriptparameterkeyvalue)[]:

Parameters for the studio component scripts.

-* **SecureInitializationRoleArn**: string -* **StudioComponentId**: string (ReadOnly, Identifier) -* **StudioId**: string (Required, Identifier):

The studio ID.

-* **Subtype**: string -* **Tags**: [Tags](#tags) -* **Type**: string (Required) - -## StudioComponentConfiguration +## Tags ### Properties -## StudioComponentInitializationScript +## Tags ### Properties -* **LaunchProfileProtocolVersion**: string:

The version number of the protocol that is used by the launch profile. The only valid - version is "2021-03-31".

-* **Platform**: string -* **RunContext**: string -* **Script**: string:

The initialization script.

-## ScriptParameterKeyValue +## Tags ### Properties -* **Key**: string:

A script parameter key.

-* **Value**: string:

A script parameter value.

-## Tags +## VolumeConfiguration ### Properties +* **Iops**: int:

The number of I/O operations per second for the root volume that is attached to + streaming session.

+* **Size**: int:

The size of the root volume that is attached to the streaming session. The root volume + size is measured in GiBs.

+* **Throughput**: int:

The throughput to provision for the root volume that is attached to the streaming + session. The throughput is measured in MiB/s.

diff --git a/artifacts/bicep/aws/aws.oam/default/types.json b/artifacts/bicep/aws/aws.oam/default/types.json index 932bd37f..fa39d124 100644 --- a/artifacts/bicep/aws/aws.oam/default/types.json +++ b/artifacts/bicep/aws/aws.oam/default/types.json @@ -1 +1,224 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"ResourceType"}},{"2":{"Name":"AWS.Oam/LinkProperties","Properties":{"Arn":{"Type":4,"Flags":18},"Label":{"Type":4,"Flags":2},"LabelTemplate":{"Type":4,"Flags":4},"ResourceTypes":{"Type":10,"Flags":1},"SinkIdentifier":{"Type":4,"Flags":1},"Tags":{"Type":11,"Flags":0,"Description":"Tags to apply to the link"}}}},{"3":{"ItemType":4}},{"2":{"Name":"Link_Tags","Properties":{}}},{"2":{"Name":"AWS.Oam/Link","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":9,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Oam/Link@default","ScopeType":0,"Body":12}},{"2":{"Name":"AWS.Oam/SinkProperties","Properties":{"Arn":{"Type":4,"Flags":18,"Description":"The Amazon resource name (ARN) of the ObservabilityAccessManager Sink"},"Name":{"Type":4,"Flags":1,"Description":"The name of the ObservabilityAccessManager Sink."},"Policy":{"Type":15,"Flags":0,"Description":"The policy of this ObservabilityAccessManager Sink."},"Tags":{"Type":16,"Flags":0,"Description":"Tags to apply to the sink"}}}},{"2":{"Name":"Sink_Policy","Properties":{}}},{"2":{"Name":"Sink_Tags","Properties":{}}},{"2":{"Name":"AWS.Oam/Sink","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":14,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Oam/Sink@default","ScopeType":0,"Body":17}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "LinkConfiguration", + "properties": { + "LogGroupConfiguration": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "MetricConfiguration": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "LinkFilter", + "properties": { + "Filter": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ResourceType", + "properties": {} + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.Oam/LinkProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ObjectType", + "name": "Link_Tags", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AWS.Oam/LinkProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/3" + }, + "flags": 18 + }, + "Label": { + "type": { + "$ref": "#/3" + }, + "flags": 2 + }, + "LabelTemplate": { + "type": { + "$ref": "#/3" + }, + "flags": 4 + }, + "LinkConfiguration": { + "type": { + "$ref": "#/0" + }, + "flags": 0 + }, + "ResourceTypes": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "SinkIdentifier": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Tags to apply to the link" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Oam/Link", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/7" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Oam/Link@default", + "scopeType": 0, + "body": { + "$ref": "#/8" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.Oam/SinkProperties" + }, + { + "$type": "ObjectType", + "name": "Sink_Policy", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Sink_Tags", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AWS.Oam/SinkProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/3" + }, + "flags": 18, + "description": "The Amazon resource name (ARN) of the ObservabilityAccessManager Sink" + }, + "Name": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The name of the ObservabilityAccessManager Sink." + }, + "Policy": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The policy of this ObservabilityAccessManager Sink." + }, + "Tags": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "Tags to apply to the sink" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Oam/Sink", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/13" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Oam/Sink@default", + "scopeType": 0, + "body": { + "$ref": "#/14" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.oam/default/types.md b/artifacts/bicep/aws/aws.oam/default/types.md index 9859ecdc..71c38bf8 100644 --- a/artifacts/bicep/aws/aws.oam/default/types.md +++ b/artifacts/bicep/aws/aws.oam/default/types.md @@ -3,29 +3,27 @@ ## Resource AWS.Oam/Link@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Oam/LinkProperties](#awsoamlinkproperties) (Required): properties of the resource +* **properties**: [AWS.Oam/LinkProperties](#awsoamlinkproperties) (Required, Identifier): properties of the resource ## Resource AWS.Oam/Sink@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Oam/SinkProperties](#awsoamsinkproperties) (Required): properties of the resource +* **properties**: [AWS.Oam/SinkProperties](#awsoamsinkproperties) (Required, Identifier): properties of the resource ## AWS.Oam/LinkProperties ### Properties * **Arn**: string (ReadOnly, Identifier) * **Label**: string (ReadOnly) * **LabelTemplate**: string (WriteOnly) +* **LinkConfiguration**: [LinkConfiguration](#linkconfiguration) * **ResourceTypes**: string[] (Required) * **SinkIdentifier**: string (Required) * **Tags**: [Link_Tags](#linktags): Tags to apply to the link -## Link_Tags -### Properties - ## AWS.Oam/SinkProperties ### Properties * **Arn**: string (ReadOnly, Identifier): The Amazon resource name (ARN) of the ObservabilityAccessManager Sink @@ -33,6 +31,18 @@ * **Policy**: [Sink_Policy](#sinkpolicy): The policy of this ObservabilityAccessManager Sink. * **Tags**: [Sink_Tags](#sinktags): Tags to apply to the sink +## Link_Tags +### Properties + +## LinkConfiguration +### Properties +* **LogGroupConfiguration**: [LinkFilter](#linkfilter) +* **MetricConfiguration**: [LinkFilter](#linkfilter) + +## LinkFilter +### Properties +* **Filter**: string (Required) + ## Sink_Policy ### Properties diff --git a/artifacts/bicep/aws/aws.omics/default/types.json b/artifacts/bicep/aws/aws.omics/default/types.json index 1d05f932..b29b56e3 100644 --- a/artifacts/bicep/aws/aws.omics/default/types.json +++ b/artifacts/bicep/aws/aws.omics/default/types.json @@ -1 +1,697 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"AnnotationType"}},{"2":{"Name":"EncryptionType"}},{"2":{"Name":"FormatToHeader","Properties":{}}},{"2":{"Name":"FormatToHeaderKey"}},{"2":{"Name":"ReferenceItem","Properties":{"ReferenceArn":{"Type":4,"Flags":1}}}},{"2":{"Name":"SchemaItem","Properties":{}}},{"2":{"Name":"SchemaValueType"}},{"2":{"Name":"SseConfig","Properties":{"KeyArn":{"Type":4,"Flags":0},"Type":{"Type":4,"Flags":1}}}},{"2":{"Name":"StoreFormat"}},{"2":{"Name":"StoreOptions","Properties":{}}},{"2":{"Name":"StoreStatus"}},{"2":{"Name":"TagMap","Properties":{}}},{"2":{"Name":"TsvStoreOptions","Properties":{"AnnotationType":{"Type":4,"Flags":0},"FormatToHeader":{"Type":10,"Flags":0},"Schema":{"Type":21,"Flags":0}}}},{"3":{"ItemType":13}},{"2":{"Name":"AWS.Omics/AnnotationStoreProperties","Properties":{"CreationTime":{"Type":4,"Flags":2},"Description":{"Type":4,"Flags":0},"Id":{"Type":4,"Flags":2},"Name":{"Type":4,"Flags":17},"Reference":{"Type":12,"Flags":0},"SseConfig":{"Type":15,"Flags":0},"Status":{"Type":4,"Flags":2},"StatusMessage":{"Type":4,"Flags":2},"StoreArn":{"Type":4,"Flags":2},"StoreFormat":{"Type":4,"Flags":1},"StoreOptions":{"Type":17,"Flags":0},"StoreSizeBytes":{"Type":3,"Flags":2},"Tags":{"Type":19,"Flags":0},"UpdateTime":{"Type":4,"Flags":2}}}},{"2":{"Name":"AWS.Omics/AnnotationStore","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":22,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Omics/AnnotationStore@default","ScopeType":0,"Body":23}},{"2":{"Name":"TagMap","Properties":{}}},{"2":{"Name":"AWS.Omics/RunGroupProperties","Properties":{"Arn":{"Type":4,"Flags":2},"CreationTime":{"Type":4,"Flags":2},"Id":{"Type":4,"Flags":18},"MaxCpus":{"Type":3,"Flags":0},"MaxDuration":{"Type":3,"Flags":0},"MaxGpus":{"Type":3,"Flags":0},"MaxRuns":{"Type":3,"Flags":0},"Name":{"Type":4,"Flags":0},"Tags":{"Type":25,"Flags":0}}}},{"2":{"Name":"AWS.Omics/RunGroup","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":26,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Omics/RunGroup@default","ScopeType":0,"Body":27}},{"2":{"Name":"EncryptionType"}},{"2":{"Name":"ReferenceItem","Properties":{"ReferenceArn":{"Type":4,"Flags":1}}}},{"2":{"Name":"SseConfig","Properties":{"KeyArn":{"Type":4,"Flags":0},"Type":{"Type":4,"Flags":1}}}},{"2":{"Name":"StoreStatus"}},{"2":{"Name":"TagMap","Properties":{}}},{"2":{"Name":"AWS.Omics/VariantStoreProperties","Properties":{"CreationTime":{"Type":4,"Flags":2},"Description":{"Type":4,"Flags":0},"Id":{"Type":4,"Flags":2},"Name":{"Type":4,"Flags":17},"Reference":{"Type":30,"Flags":1},"SseConfig":{"Type":31,"Flags":0},"Status":{"Type":4,"Flags":2},"StatusMessage":{"Type":4,"Flags":2},"StoreArn":{"Type":4,"Flags":2},"StoreSizeBytes":{"Type":3,"Flags":2},"Tags":{"Type":33,"Flags":0},"UpdateTime":{"Type":4,"Flags":2}}}},{"2":{"Name":"AWS.Omics/VariantStore","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":34,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Omics/VariantStore@default","ScopeType":0,"Body":35}},{"2":{"Name":"Accelerators"}},{"2":{"Name":"TagMap","Properties":{}}},{"2":{"Name":"WorkflowEngine"}},{"2":{"Name":"WorkflowParameter","Properties":{"Description":{"Type":4,"Flags":0},"Optional":{"Type":2,"Flags":0}}}},{"2":{"Name":"WorkflowParameterTemplate","Properties":{}}},{"2":{"Name":"WorkflowStatus"}},{"2":{"Name":"WorkflowType"}},{"2":{"Name":"AWS.Omics/WorkflowProperties","Properties":{"Accelerators":{"Type":4,"Flags":0},"Arn":{"Type":4,"Flags":2},"CreationTime":{"Type":4,"Flags":2},"DefinitionUri":{"Type":4,"Flags":4},"Description":{"Type":4,"Flags":0},"Engine":{"Type":4,"Flags":0},"Id":{"Type":4,"Flags":18},"Main":{"Type":4,"Flags":0},"Name":{"Type":4,"Flags":0},"ParameterTemplate":{"Type":41,"Flags":0},"Status":{"Type":4,"Flags":2},"StorageCapacity":{"Type":3,"Flags":0},"Tags":{"Type":38,"Flags":0},"Type":{"Type":4,"Flags":2}}}},{"2":{"Name":"AWS.Omics/Workflow","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":44,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Omics/Workflow@default","ScopeType":0,"Body":45}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "AnnotationType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "EncryptionType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "FormatToHeader", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "FormatToHeaderKey", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ReferenceItem", + "properties": { + "ReferenceArn": { + "type": { + "$ref": "#/13" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "SchemaItem", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SchemaValueType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SseConfig", + "properties": { + "KeyArn": { + "type": { + "$ref": "#/13" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/13" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "StoreFormat", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "StoreOptions", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "StoreStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TagMap", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TsvStoreOptions", + "properties": { + "AnnotationType": { + "type": { + "$ref": "#/13" + }, + "flags": 0 + }, + "FormatToHeader": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Schema": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Omics/AnnotationStoreProperties" + }, + { + "$type": "IntegerType" + }, + { + "$type": "ObjectType", + "name": "AWS.Omics/AnnotationStoreProperties", + "properties": { + "CreationTime": { + "type": { + "$ref": "#/13" + }, + "flags": 2 + }, + "Description": { + "type": { + "$ref": "#/13" + }, + "flags": 0 + }, + "Id": { + "type": { + "$ref": "#/13" + }, + "flags": 2 + }, + "Name": { + "type": { + "$ref": "#/13" + }, + "flags": 17 + }, + "Reference": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "SseConfig": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "Status": { + "type": { + "$ref": "#/13" + }, + "flags": 2 + }, + "StatusMessage": { + "type": { + "$ref": "#/13" + }, + "flags": 2 + }, + "StoreArn": { + "type": { + "$ref": "#/13" + }, + "flags": 2 + }, + "StoreFormat": { + "type": { + "$ref": "#/13" + }, + "flags": 1 + }, + "StoreOptions": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "StoreSizeBytes": { + "type": { + "$ref": "#/16" + }, + "flags": 2 + }, + "Tags": { + "type": { + "$ref": "#/11" + }, + "flags": 0 + }, + "UpdateTime": { + "type": { + "$ref": "#/13" + }, + "flags": 2 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Omics/AnnotationStore", + "properties": { + "name": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/13" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/17" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Omics/AnnotationStore@default", + "scopeType": 0, + "body": { + "$ref": "#/18" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "TagMap", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.Omics/RunGroupProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.Omics/RunGroupProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/13" + }, + "flags": 2 + }, + "CreationTime": { + "type": { + "$ref": "#/13" + }, + "flags": 2 + }, + "Id": { + "type": { + "$ref": "#/13" + }, + "flags": 18 + }, + "MaxCpus": { + "type": { + "$ref": "#/16" + }, + "flags": 0 + }, + "MaxDuration": { + "type": { + "$ref": "#/16" + }, + "flags": 0 + }, + "MaxGpus": { + "type": { + "$ref": "#/16" + }, + "flags": 0 + }, + "MaxRuns": { + "type": { + "$ref": "#/16" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/13" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/20" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Omics/RunGroup", + "properties": { + "name": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/13" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/22" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Omics/RunGroup@default", + "scopeType": 0, + "body": { + "$ref": "#/23" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "EncryptionType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ReferenceItem", + "properties": { + "ReferenceArn": { + "type": { + "$ref": "#/13" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "SseConfig", + "properties": { + "KeyArn": { + "type": { + "$ref": "#/13" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/13" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "StoreStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TagMap", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.Omics/VariantStoreProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.Omics/VariantStoreProperties", + "properties": { + "CreationTime": { + "type": { + "$ref": "#/13" + }, + "flags": 2 + }, + "Description": { + "type": { + "$ref": "#/13" + }, + "flags": 0 + }, + "Id": { + "type": { + "$ref": "#/13" + }, + "flags": 2 + }, + "Name": { + "type": { + "$ref": "#/13" + }, + "flags": 17 + }, + "Reference": { + "type": { + "$ref": "#/26" + }, + "flags": 1 + }, + "SseConfig": { + "type": { + "$ref": "#/27" + }, + "flags": 0 + }, + "Status": { + "type": { + "$ref": "#/13" + }, + "flags": 2 + }, + "StatusMessage": { + "type": { + "$ref": "#/13" + }, + "flags": 2 + }, + "StoreArn": { + "type": { + "$ref": "#/13" + }, + "flags": 2 + }, + "StoreSizeBytes": { + "type": { + "$ref": "#/16" + }, + "flags": 2 + }, + "Tags": { + "type": { + "$ref": "#/29" + }, + "flags": 0 + }, + "UpdateTime": { + "type": { + "$ref": "#/13" + }, + "flags": 2 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Omics/VariantStore", + "properties": { + "name": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/13" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/31" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Omics/VariantStore@default", + "scopeType": 0, + "body": { + "$ref": "#/32" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Accelerators", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TagMap", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "WorkflowEngine", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "WorkflowParameter", + "properties": { + "Description": { + "type": { + "$ref": "#/13" + }, + "flags": 0 + }, + "Optional": { + "type": { + "$ref": "#/41" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "WorkflowParameterTemplate", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "WorkflowStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "WorkflowType", + "properties": {} + }, + { + "$type": "BooleanType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.Omics/WorkflowProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.Omics/WorkflowProperties", + "properties": { + "Accelerators": { + "type": { + "$ref": "#/13" + }, + "flags": 0 + }, + "Arn": { + "type": { + "$ref": "#/13" + }, + "flags": 2 + }, + "CreationTime": { + "type": { + "$ref": "#/13" + }, + "flags": 2 + }, + "DefinitionUri": { + "type": { + "$ref": "#/13" + }, + "flags": 4 + }, + "Description": { + "type": { + "$ref": "#/13" + }, + "flags": 0 + }, + "Engine": { + "type": { + "$ref": "#/13" + }, + "flags": 0 + }, + "Id": { + "type": { + "$ref": "#/13" + }, + "flags": 18 + }, + "Main": { + "type": { + "$ref": "#/13" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/13" + }, + "flags": 0 + }, + "ParameterTemplate": { + "type": { + "$ref": "#/38" + }, + "flags": 0 + }, + "Status": { + "type": { + "$ref": "#/13" + }, + "flags": 2 + }, + "StorageCapacity": { + "type": { + "$ref": "#/16" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/35" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/13" + }, + "flags": 2 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Omics/Workflow", + "properties": { + "name": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/13" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/43" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Omics/Workflow@default", + "scopeType": 0, + "body": { + "$ref": "#/44" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.omics/default/types.md b/artifacts/bicep/aws/aws.omics/default/types.md index fd3c46e3..dcbaa5e8 100644 --- a/artifacts/bicep/aws/aws.omics/default/types.md +++ b/artifacts/bicep/aws/aws.omics/default/types.md @@ -3,30 +3,30 @@ ## Resource AWS.Omics/AnnotationStore@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Omics/AnnotationStoreProperties](#awsomicsannotationstoreproperties) (Required): properties of the resource +* **properties**: [AWS.Omics/AnnotationStoreProperties](#awsomicsannotationstoreproperties) (Required, Identifier): properties of the resource ## Resource AWS.Omics/RunGroup@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Omics/RunGroupProperties](#awsomicsrungroupproperties): properties of the resource +* **properties**: [AWS.Omics/RunGroupProperties](#awsomicsrungroupproperties) (Identifier): properties of the resource ## Resource AWS.Omics/VariantStore@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Omics/VariantStoreProperties](#awsomicsvariantstoreproperties) (Required): properties of the resource +* **properties**: [AWS.Omics/VariantStoreProperties](#awsomicsvariantstoreproperties) (Required, Identifier): properties of the resource ## Resource AWS.Omics/Workflow@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Omics/WorkflowProperties](#awsomicsworkflowproperties): properties of the resource +* **properties**: [AWS.Omics/WorkflowProperties](#awsomicsworkflowproperties) (Identifier): properties of the resource ## AWS.Omics/AnnotationStoreProperties ### Properties @@ -45,21 +45,6 @@ * **Tags**: [TagMap](#tagmap) * **UpdateTime**: string (ReadOnly) -## ReferenceItem -### Properties -* **ReferenceArn**: string (Required) - -## SseConfig -### Properties -* **KeyArn**: string -* **Type**: string (Required) - -## StoreOptions -### Properties - -## TagMap -### Properties - ## AWS.Omics/RunGroupProperties ### Properties * **Arn**: string (ReadOnly) @@ -72,9 +57,6 @@ * **Name**: string * **Tags**: [TagMap](#tagmap) -## TagMap -### Properties - ## AWS.Omics/VariantStoreProperties ### Properties * **CreationTime**: string (ReadOnly) @@ -90,18 +72,6 @@ * **Tags**: [TagMap](#tagmap) * **UpdateTime**: string (ReadOnly) -## ReferenceItem -### Properties -* **ReferenceArn**: string (Required) - -## SseConfig -### Properties -* **KeyArn**: string -* **Type**: string (Required) - -## TagMap -### Properties - ## AWS.Omics/WorkflowProperties ### Properties * **Accelerators**: string @@ -119,9 +89,39 @@ * **Tags**: [TagMap](#tagmap) * **Type**: string (ReadOnly) -## WorkflowParameterTemplate +## ReferenceItem +### Properties +* **ReferenceArn**: string (Required) + +## ReferenceItem +### Properties +* **ReferenceArn**: string (Required) + +## SseConfig +### Properties +* **KeyArn**: string +* **Type**: string (Required) + +## SseConfig +### Properties +* **KeyArn**: string +* **Type**: string (Required) + +## StoreOptions +### Properties + +## TagMap ### Properties ## TagMap ### Properties +## TagMap +### Properties + +## TagMap +### Properties + +## WorkflowParameterTemplate +### Properties + diff --git a/artifacts/bicep/aws/aws.opensearchserverless/default/types.json b/artifacts/bicep/aws/aws.opensearchserverless/default/types.json index f6926e16..a214c39c 100644 --- a/artifacts/bicep/aws/aws.opensearchserverless/default/types.json +++ b/artifacts/bicep/aws/aws.opensearchserverless/default/types.json @@ -1 +1,596 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"AccessPolicyType"}},{"2":{"Name":"AWS.OpenSearchServerless/AccessPolicyProperties","Properties":{"Description":{"Type":4,"Flags":0,"Description":"The description of the policy"},"Name":{"Type":4,"Flags":17,"Description":"The name of the policy"},"Policy":{"Type":4,"Flags":1,"Description":"The JSON policy document that is the content for the policy"},"Type":{"Type":4,"Flags":17}}}},{"2":{"Name":"AWS.OpenSearchServerless/AccessPolicy","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":9,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.OpenSearchServerless/AccessPolicy@default","ScopeType":0,"Body":10}},{"2":{"Name":"CollectionType"}},{"2":{"Name":"StandbyReplicas"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key in the key-value pair"},"Value":{"Type":4,"Flags":1,"Description":"The value in the key-value pair"}}}},{"2":{"Name":"AWS.OpenSearchServerless/CollectionProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) of the collection."},"CollectionEndpoint":{"Type":4,"Flags":2,"Description":"The endpoint for the collection."},"DashboardEndpoint":{"Type":4,"Flags":2,"Description":"The OpenSearch Dashboards endpoint for the collection."},"Description":{"Type":4,"Flags":0,"Description":"The description of the collection"},"Id":{"Type":4,"Flags":18,"Description":"The identifier of the collection"},"Name":{"Type":4,"Flags":1,"Description":"The name of the collection.\n\nThe name must meet the following criteria:\nUnique to your account and AWS Region\nStarts with a lowercase letter\nContains only lowercase letters a-z, the numbers 0-9 and the hyphen (-)\nContains between 3 and 32 characters\n"},"StandbyReplicas":{"Type":4,"Flags":0},"Tags":{"Type":16,"Flags":4,"Description":"List of tags to be added to the resource"},"Type":{"Type":4,"Flags":0}}}},{"3":{"ItemType":14}},{"2":{"Name":"AWS.OpenSearchServerless/Collection","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":15,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.OpenSearchServerless/Collection@default","ScopeType":0,"Body":17}},{"2":{"Name":"LifecyclePolicyType"}},{"2":{"Name":"AWS.OpenSearchServerless/LifecyclePolicyProperties","Properties":{"Description":{"Type":4,"Flags":0,"Description":"The description of the policy"},"Name":{"Type":4,"Flags":17,"Description":"The name of the policy"},"Policy":{"Type":4,"Flags":1,"Description":"The JSON policy document that is the content for the policy"},"Type":{"Type":4,"Flags":17}}}},{"2":{"Name":"AWS.OpenSearchServerless/LifecyclePolicy","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":20,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.OpenSearchServerless/LifecyclePolicy@default","ScopeType":0,"Body":21}},{"2":{"Name":"SamlConfigOptions","Properties":{"GroupAttribute":{"Type":4,"Flags":0,"Description":"Group attribute for this saml integration"},"Metadata":{"Type":4,"Flags":1,"Description":"The XML saml provider metadata document that you want to use"},"SessionTimeout":{"Type":3,"Flags":0,"Description":"Defines the session timeout in minutes"},"UserAttribute":{"Type":4,"Flags":0,"Description":"Custom attribute for this saml integration"}}}},{"2":{"Name":"SecurityConfigType"}},{"2":{"Name":"AWS.OpenSearchServerless/SecurityConfigProperties","Properties":{"Description":{"Type":4,"Flags":0,"Description":"Security config description"},"Id":{"Type":4,"Flags":18,"Description":"The identifier of the security config"},"Name":{"Type":4,"Flags":4,"Description":"The friendly name of the security config"},"SamlOptions":{"Type":23,"Flags":0},"Type":{"Type":4,"Flags":0}}}},{"2":{"Name":"AWS.OpenSearchServerless/SecurityConfig","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":25,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.OpenSearchServerless/SecurityConfig@default","ScopeType":0,"Body":26}},{"2":{"Name":"SecurityPolicyType"}},{"2":{"Name":"AWS.OpenSearchServerless/SecurityPolicyProperties","Properties":{"Description":{"Type":4,"Flags":0,"Description":"The description of the policy"},"Name":{"Type":4,"Flags":17,"Description":"The name of the policy"},"Policy":{"Type":4,"Flags":1,"Description":"The JSON policy document that is the content for the policy"},"Type":{"Type":4,"Flags":17}}}},{"2":{"Name":"AWS.OpenSearchServerless/SecurityPolicy","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":29,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.OpenSearchServerless/SecurityPolicy@default","ScopeType":0,"Body":30}},{"2":{"Name":"AWS.OpenSearchServerless/VpcEndpointProperties","Properties":{"Id":{"Type":4,"Flags":18,"Description":"The identifier of the VPC Endpoint"},"Name":{"Type":4,"Flags":1,"Description":"The name of the VPC Endpoint"},"SecurityGroupIds":{"Type":33,"Flags":0,"Description":"The ID of one or more security groups to associate with the endpoint network interface"},"SubnetIds":{"Type":34,"Flags":1,"Description":"The ID of one or more subnets in which to create an endpoint network interface"},"VpcId":{"Type":4,"Flags":1,"Description":"The ID of the VPC in which the endpoint will be used."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.OpenSearchServerless/VpcEndpoint","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":32,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.OpenSearchServerless/VpcEndpoint@default","ScopeType":0,"Body":35}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "AccessPolicyType", + "properties": {} + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.OpenSearchServerless/AccessPolicyProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.OpenSearchServerless/AccessPolicyProperties", + "properties": { + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The description of the policy" + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The name of the policy" + }, + "Policy": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The JSON policy document that is the content for the policy" + }, + "Type": { + "type": { + "$ref": "#/1" + }, + "flags": 17 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.OpenSearchServerless/AccessPolicy", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.OpenSearchServerless/AccessPolicy@default", + "scopeType": 0, + "body": { + "$ref": "#/4" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "CollectionType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "StandbyReplicas", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key in the key-value pair" + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value in the key-value pair" + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.OpenSearchServerless/CollectionProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/8" + } + }, + { + "$type": "ObjectType", + "name": "AWS.OpenSearchServerless/CollectionProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) of the collection." + }, + "CollectionEndpoint": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The endpoint for the collection." + }, + "DashboardEndpoint": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The OpenSearch Dashboards endpoint for the collection." + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The description of the collection" + }, + "Id": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The identifier of the collection" + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The name of the collection.\n\nThe name must meet the following criteria:\nUnique to your account and AWS Region\nStarts with a lowercase letter\nContains only lowercase letters a-z, the numbers 0-9 and the hyphen (-)\nContains between 3 and 32 characters\n" + }, + "StandbyReplicas": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/10" + }, + "flags": 4, + "description": "List of tags to be added to the resource" + }, + "Type": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.OpenSearchServerless/Collection", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/11" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.OpenSearchServerless/Collection@default", + "scopeType": 0, + "body": { + "$ref": "#/12" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "LifecyclePolicyType", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.OpenSearchServerless/LifecyclePolicyProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.OpenSearchServerless/LifecyclePolicyProperties", + "properties": { + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The description of the policy" + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The name of the policy" + }, + "Policy": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The JSON policy document that is the content for the policy" + }, + "Type": { + "type": { + "$ref": "#/1" + }, + "flags": 17 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.OpenSearchServerless/LifecyclePolicy", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/16" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.OpenSearchServerless/LifecyclePolicy@default", + "scopeType": 0, + "body": { + "$ref": "#/17" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "SamlConfigOptions", + "properties": { + "GroupAttribute": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Group attribute for this saml integration" + }, + "Metadata": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The XML saml provider metadata document that you want to use" + }, + "SessionTimeout": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "Defines the session timeout in minutes" + }, + "UserAttribute": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Custom attribute for this saml integration" + } + } + }, + { + "$type": "ObjectType", + "name": "SecurityConfigType", + "properties": {} + }, + { + "$type": "IntegerType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.OpenSearchServerless/SecurityConfigProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.OpenSearchServerless/SecurityConfigProperties", + "properties": { + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Security config description" + }, + "Id": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The identifier of the security config" + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The friendly name of the security config" + }, + "SamlOptions": { + "type": { + "$ref": "#/19" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.OpenSearchServerless/SecurityConfig", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/23" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.OpenSearchServerless/SecurityConfig@default", + "scopeType": 0, + "body": { + "$ref": "#/24" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "SecurityPolicyType", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.OpenSearchServerless/SecurityPolicyProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.OpenSearchServerless/SecurityPolicyProperties", + "properties": { + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The description of the policy" + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The name of the policy" + }, + "Policy": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The JSON policy document that is the content for the policy" + }, + "Type": { + "type": { + "$ref": "#/1" + }, + "flags": 17 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.OpenSearchServerless/SecurityPolicy", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/28" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.OpenSearchServerless/SecurityPolicy@default", + "scopeType": 0, + "body": { + "$ref": "#/29" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.OpenSearchServerless/VpcEndpointProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "AWS.OpenSearchServerless/VpcEndpointProperties", + "properties": { + "Id": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The identifier of the VPC Endpoint" + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The name of the VPC Endpoint" + }, + "SecurityGroupIds": { + "type": { + "$ref": "#/32" + }, + "flags": 0, + "description": "The ID of one or more security groups to associate with the endpoint network interface" + }, + "SubnetIds": { + "type": { + "$ref": "#/33" + }, + "flags": 1, + "description": "The ID of one or more subnets in which to create an endpoint network interface" + }, + "VpcId": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The ID of the VPC in which the endpoint will be used." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.OpenSearchServerless/VpcEndpoint", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/34" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.OpenSearchServerless/VpcEndpoint@default", + "scopeType": 0, + "body": { + "$ref": "#/35" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.opensearchserverless/default/types.md b/artifacts/bicep/aws/aws.opensearchserverless/default/types.md index 4f03284b..ede281e5 100644 --- a/artifacts/bicep/aws/aws.opensearchserverless/default/types.md +++ b/artifacts/bicep/aws/aws.opensearchserverless/default/types.md @@ -3,44 +3,44 @@ ## Resource AWS.OpenSearchServerless/AccessPolicy@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.OpenSearchServerless/AccessPolicyProperties](#awsopensearchserverlessaccesspolicyproperties) (Required): properties of the resource +* **properties**: [AWS.OpenSearchServerless/AccessPolicyProperties](#awsopensearchserverlessaccesspolicyproperties) (Required, Identifier): properties of the resource ## Resource AWS.OpenSearchServerless/Collection@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.OpenSearchServerless/CollectionProperties](#awsopensearchserverlesscollectionproperties) (Required): properties of the resource +* **properties**: [AWS.OpenSearchServerless/CollectionProperties](#awsopensearchserverlesscollectionproperties) (Required, Identifier): properties of the resource ## Resource AWS.OpenSearchServerless/LifecyclePolicy@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.OpenSearchServerless/LifecyclePolicyProperties](#awsopensearchserverlesslifecyclepolicyproperties) (Required): properties of the resource +* **properties**: [AWS.OpenSearchServerless/LifecyclePolicyProperties](#awsopensearchserverlesslifecyclepolicyproperties) (Required, Identifier): properties of the resource ## Resource AWS.OpenSearchServerless/SecurityConfig@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.OpenSearchServerless/SecurityConfigProperties](#awsopensearchserverlesssecurityconfigproperties): properties of the resource +* **properties**: [AWS.OpenSearchServerless/SecurityConfigProperties](#awsopensearchserverlesssecurityconfigproperties) (Identifier): properties of the resource ## Resource AWS.OpenSearchServerless/SecurityPolicy@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.OpenSearchServerless/SecurityPolicyProperties](#awsopensearchserverlesssecuritypolicyproperties) (Required): properties of the resource +* **properties**: [AWS.OpenSearchServerless/SecurityPolicyProperties](#awsopensearchserverlesssecuritypolicyproperties) (Required, Identifier): properties of the resource ## Resource AWS.OpenSearchServerless/VpcEndpoint@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.OpenSearchServerless/VpcEndpointProperties](#awsopensearchserverlessvpcendpointproperties) (Required): properties of the resource +* **properties**: [AWS.OpenSearchServerless/VpcEndpointProperties](#awsopensearchserverlessvpcendpointproperties) (Required, Identifier): properties of the resource ## AWS.OpenSearchServerless/AccessPolicyProperties ### Properties @@ -68,11 +68,6 @@ Contains between 3 and 32 characters * **Tags**: [Tag](#tag)[] (WriteOnly): List of tags to be added to the resource * **Type**: string -## Tag -### Properties -* **Key**: string (Required): The key in the key-value pair -* **Value**: string (Required): The value in the key-value pair - ## AWS.OpenSearchServerless/LifecyclePolicyProperties ### Properties * **Description**: string: The description of the policy @@ -88,13 +83,6 @@ Contains between 3 and 32 characters * **SamlOptions**: [SamlConfigOptions](#samlconfigoptions) * **Type**: string -## SamlConfigOptions -### Properties -* **GroupAttribute**: string: Group attribute for this saml integration -* **Metadata**: string (Required): The XML saml provider metadata document that you want to use -* **SessionTimeout**: int: Defines the session timeout in minutes -* **UserAttribute**: string: Custom attribute for this saml integration - ## AWS.OpenSearchServerless/SecurityPolicyProperties ### Properties * **Description**: string: The description of the policy @@ -110,3 +98,15 @@ Contains between 3 and 32 characters * **SubnetIds**: string[] (Required): The ID of one or more subnets in which to create an endpoint network interface * **VpcId**: string (Required): The ID of the VPC in which the endpoint will be used. +## SamlConfigOptions +### Properties +* **GroupAttribute**: string: Group attribute for this saml integration +* **Metadata**: string (Required): The XML saml provider metadata document that you want to use +* **SessionTimeout**: int: Defines the session timeout in minutes +* **UserAttribute**: string: Custom attribute for this saml integration + +## Tag +### Properties +* **Key**: string (Required): The key in the key-value pair +* **Value**: string (Required): The value in the key-value pair + diff --git a/artifacts/bicep/aws/aws.opensearchservice/default/types.json b/artifacts/bicep/aws/aws.opensearchservice/default/types.json index 9bf3ef8b..82a906c2 100644 --- a/artifacts/bicep/aws/aws.opensearchservice/default/types.json +++ b/artifacts/bicep/aws/aws.opensearchservice/default/types.json @@ -1 +1,794 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"AdvancedSecurityOptionsInput","Properties":{"AnonymousAuthDisableDate":{"Type":4,"Flags":2},"AnonymousAuthEnabled":{"Type":2,"Flags":0},"Enabled":{"Type":2,"Flags":0},"InternalUserDatabaseEnabled":{"Type":2,"Flags":0},"MasterUserOptions":{"Type":16,"Flags":4},"SAMLOptions":{"Type":20,"Flags":0}}}},{"2":{"Name":"ClusterConfig","Properties":{"DedicatedMasterCount":{"Type":3,"Flags":0},"DedicatedMasterEnabled":{"Type":2,"Flags":0},"DedicatedMasterType":{"Type":4,"Flags":0},"InstanceCount":{"Type":3,"Flags":0},"InstanceType":{"Type":4,"Flags":0},"MultiAZWithStandbyEnabled":{"Type":2,"Flags":0},"WarmCount":{"Type":3,"Flags":0},"WarmEnabled":{"Type":2,"Flags":0},"WarmType":{"Type":4,"Flags":0},"ZoneAwarenessConfig":{"Type":27,"Flags":0},"ZoneAwarenessEnabled":{"Type":2,"Flags":0}}}},{"2":{"Name":"CognitoOptions","Properties":{"Enabled":{"Type":2,"Flags":0},"IdentityPoolId":{"Type":4,"Flags":0},"RoleArn":{"Type":4,"Flags":0},"UserPoolId":{"Type":4,"Flags":0}}}},{"2":{"Name":"DomainEndpointOptions","Properties":{"CustomEndpoint":{"Type":4,"Flags":0},"CustomEndpointCertificateArn":{"Type":4,"Flags":0},"CustomEndpointEnabled":{"Type":2,"Flags":0},"EnforceHTTPS":{"Type":2,"Flags":0},"TLSSecurityPolicy":{"Type":4,"Flags":0}}}},{"2":{"Name":"EBSOptions","Properties":{"EBSEnabled":{"Type":2,"Flags":0},"Iops":{"Type":3,"Flags":0},"Throughput":{"Type":3,"Flags":0},"VolumeSize":{"Type":3,"Flags":0},"VolumeType":{"Type":4,"Flags":0}}}},{"2":{"Name":"EncryptionAtRestOptions","Properties":{"Enabled":{"Type":2,"Flags":0},"KmsKeyId":{"Type":4,"Flags":0}}}},{"2":{"Name":"Idp","Properties":{"EntityId":{"Type":4,"Flags":1},"MetadataContent":{"Type":4,"Flags":1}}}},{"2":{"Name":"LogPublishingOption","Properties":{"CloudWatchLogsLogGroupArn":{"Type":4,"Flags":0},"Enabled":{"Type":2,"Flags":0}}}},{"2":{"Name":"MasterUserOptions","Properties":{"MasterUserARN":{"Type":4,"Flags":0},"MasterUserName":{"Type":4,"Flags":0},"MasterUserPassword":{"Type":4,"Flags":0}}}},{"2":{"Name":"NodeToNodeEncryptionOptions","Properties":{"Enabled":{"Type":2,"Flags":0}}}},{"2":{"Name":"OffPeakWindow","Properties":{"WindowStartTime":{"Type":26,"Flags":0}}}},{"2":{"Name":"OffPeakWindowOptions","Properties":{"Enabled":{"Type":2,"Flags":0},"OffPeakWindow":{"Type":18,"Flags":0}}}},{"2":{"Name":"SAMLOptions","Properties":{"Enabled":{"Type":2,"Flags":0},"Idp":{"Type":14,"Flags":0},"MasterBackendRole":{"Type":4,"Flags":4},"MasterUserName":{"Type":4,"Flags":4},"RolesKey":{"Type":4,"Flags":0},"SessionTimeoutMinutes":{"Type":3,"Flags":0},"SubjectKey":{"Type":4,"Flags":0}}}},{"2":{"Name":"ServiceSoftwareOptions","Properties":{"AutomatedUpdateDate":{"Type":4,"Flags":0},"Cancellable":{"Type":2,"Flags":0},"CurrentVersion":{"Type":4,"Flags":0},"Description":{"Type":4,"Flags":0},"NewVersion":{"Type":4,"Flags":0},"OptionalDeployment":{"Type":2,"Flags":0},"UpdateAvailable":{"Type":2,"Flags":0},"UpdateStatus":{"Type":4,"Flags":0}}}},{"2":{"Name":"SnapshotOptions","Properties":{"AutomatedSnapshotStartHour":{"Type":3,"Flags":0}}}},{"2":{"Name":"SoftwareUpdateOptions","Properties":{"AutoSoftwareUpdateEnabled":{"Type":2,"Flags":0}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The value of the tag."},"Value":{"Type":4,"Flags":1,"Description":"The key of the tag."}}}},{"2":{"Name":"VPCOptions","Properties":{"SecurityGroupIds":{"Type":28,"Flags":0},"SubnetIds":{"Type":29,"Flags":0}}}},{"2":{"Name":"WindowStartTime","Properties":{"Hours":{"Type":3,"Flags":1},"Minutes":{"Type":3,"Flags":1}}}},{"2":{"Name":"ZoneAwarenessConfig","Properties":{"AvailabilityZoneCount":{"Type":3,"Flags":0}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.OpenSearchService/DomainProperties","Properties":{"AccessPolicies":{"Type":31,"Flags":0},"AdvancedOptions":{"Type":32,"Flags":0},"AdvancedSecurityOptions":{"Type":8,"Flags":0},"Arn":{"Type":4,"Flags":2},"ClusterConfig":{"Type":9,"Flags":0},"CognitoOptions":{"Type":10,"Flags":0},"DomainArn":{"Type":4,"Flags":2},"DomainEndpoint":{"Type":4,"Flags":2},"DomainEndpointOptions":{"Type":11,"Flags":0},"DomainEndpointV2":{"Type":4,"Flags":2},"DomainEndpoints":{"Type":33,"Flags":2},"DomainName":{"Type":4,"Flags":16},"EBSOptions":{"Type":12,"Flags":0},"EncryptionAtRestOptions":{"Type":13,"Flags":0},"EngineVersion":{"Type":4,"Flags":0},"IPAddressType":{"Type":4,"Flags":0},"Id":{"Type":4,"Flags":2},"LogPublishingOptions":{"Type":34,"Flags":0},"NodeToNodeEncryptionOptions":{"Type":17,"Flags":0},"OffPeakWindowOptions":{"Type":19,"Flags":0},"ServiceSoftwareOptions":{"Type":21,"Flags":2},"SnapshotOptions":{"Type":22,"Flags":0},"SoftwareUpdateOptions":{"Type":23,"Flags":0},"Tags":{"Type":35,"Flags":0,"Description":"An arbitrary set of tags (key-value pairs) for this Domain."},"VPCOptions":{"Type":25,"Flags":0}}}},{"2":{"Name":"Domain_AccessPolicies","Properties":{}}},{"2":{"Name":"Domain_AdvancedOptions","Properties":{}}},{"2":{"Name":"Domain_DomainEndpoints","Properties":{}}},{"2":{"Name":"Domain_LogPublishingOptions","Properties":{}}},{"3":{"ItemType":24}},{"2":{"Name":"AWS.OpenSearchService/Domain","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":30,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.OpenSearchService/Domain@default","ScopeType":0,"Body":36}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "AdvancedSecurityOptionsInput", + "properties": { + "AnonymousAuthDisableDate": { + "type": { + "$ref": "#/21" + }, + "flags": 2 + }, + "AnonymousAuthEnabled": { + "type": { + "$ref": "#/22" + }, + "flags": 0 + }, + "Enabled": { + "type": { + "$ref": "#/22" + }, + "flags": 0 + }, + "InternalUserDatabaseEnabled": { + "type": { + "$ref": "#/22" + }, + "flags": 0 + }, + "MasterUserOptions": { + "type": { + "$ref": "#/9" + }, + "flags": 4 + }, + "SAMLOptions": { + "type": { + "$ref": "#/13" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ClusterConfig", + "properties": { + "ColdStorageOptions": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "DedicatedMasterCount": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "DedicatedMasterEnabled": { + "type": { + "$ref": "#/22" + }, + "flags": 0 + }, + "DedicatedMasterType": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "InstanceCount": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "InstanceType": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "MultiAZWithStandbyEnabled": { + "type": { + "$ref": "#/22" + }, + "flags": 0 + }, + "WarmCount": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "WarmEnabled": { + "type": { + "$ref": "#/22" + }, + "flags": 0 + }, + "WarmType": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "ZoneAwarenessConfig": { + "type": { + "$ref": "#/20" + }, + "flags": 0 + }, + "ZoneAwarenessEnabled": { + "type": { + "$ref": "#/22" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CognitoOptions", + "properties": { + "Enabled": { + "type": { + "$ref": "#/22" + }, + "flags": 0 + }, + "IdentityPoolId": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "RoleArn": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "UserPoolId": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ColdStorageOptions", + "properties": { + "Enabled": { + "type": { + "$ref": "#/22" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DomainEndpointOptions", + "properties": { + "CustomEndpoint": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "CustomEndpointCertificateArn": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "CustomEndpointEnabled": { + "type": { + "$ref": "#/22" + }, + "flags": 0 + }, + "EnforceHTTPS": { + "type": { + "$ref": "#/22" + }, + "flags": 0 + }, + "TLSSecurityPolicy": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "EBSOptions", + "properties": { + "EBSEnabled": { + "type": { + "$ref": "#/22" + }, + "flags": 0 + }, + "Iops": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "Throughput": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "VolumeSize": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "VolumeType": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "EncryptionAtRestOptions", + "properties": { + "Enabled": { + "type": { + "$ref": "#/22" + }, + "flags": 0 + }, + "KmsKeyId": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Idp", + "properties": { + "EntityId": { + "type": { + "$ref": "#/21" + }, + "flags": 1 + }, + "MetadataContent": { + "type": { + "$ref": "#/21" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "LogPublishingOption", + "properties": { + "CloudWatchLogsLogGroupArn": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "Enabled": { + "type": { + "$ref": "#/22" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "MasterUserOptions", + "properties": { + "MasterUserARN": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "MasterUserName": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "MasterUserPassword": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "NodeToNodeEncryptionOptions", + "properties": { + "Enabled": { + "type": { + "$ref": "#/22" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "OffPeakWindow", + "properties": { + "WindowStartTime": { + "type": { + "$ref": "#/19" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "OffPeakWindowOptions", + "properties": { + "Enabled": { + "type": { + "$ref": "#/22" + }, + "flags": 0 + }, + "OffPeakWindow": { + "type": { + "$ref": "#/11" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SAMLOptions", + "properties": { + "Enabled": { + "type": { + "$ref": "#/22" + }, + "flags": 0 + }, + "Idp": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "MasterBackendRole": { + "type": { + "$ref": "#/21" + }, + "flags": 4 + }, + "MasterUserName": { + "type": { + "$ref": "#/21" + }, + "flags": 4 + }, + "RolesKey": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "SessionTimeoutMinutes": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "SubjectKey": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ServiceSoftwareOptions", + "properties": { + "AutomatedUpdateDate": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "Cancellable": { + "type": { + "$ref": "#/22" + }, + "flags": 0 + }, + "CurrentVersion": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "Description": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "NewVersion": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "OptionalDeployment": { + "type": { + "$ref": "#/22" + }, + "flags": 0 + }, + "UpdateAvailable": { + "type": { + "$ref": "#/22" + }, + "flags": 0 + }, + "UpdateStatus": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SnapshotOptions", + "properties": { + "AutomatedSnapshotStartHour": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SoftwareUpdateOptions", + "properties": { + "AutoSoftwareUpdateEnabled": { + "type": { + "$ref": "#/22" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/21" + }, + "flags": 1, + "description": "The value of the tag." + }, + "Value": { + "type": { + "$ref": "#/21" + }, + "flags": 1, + "description": "The key of the tag." + } + } + }, + { + "$type": "ObjectType", + "name": "VPCOptions", + "properties": { + "SecurityGroupIds": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "SubnetIds": { + "type": { + "$ref": "#/25" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "WindowStartTime", + "properties": { + "Hours": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + }, + "Minutes": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ZoneAwarenessConfig", + "properties": { + "AvailabilityZoneCount": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "BooleanType" + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/21" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/21" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.OpenSearchService/DomainProperties" + }, + { + "$type": "ObjectType", + "name": "Domain_AccessPolicies", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Domain_AdvancedOptions", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Domain_DomainEndpoints", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Domain_LogPublishingOptions", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/17" + } + }, + { + "$type": "ObjectType", + "name": "AWS.OpenSearchService/DomainProperties", + "properties": { + "AccessPolicies": { + "type": { + "$ref": "#/27" + }, + "flags": 0 + }, + "AdvancedOptions": { + "type": { + "$ref": "#/28" + }, + "flags": 0 + }, + "AdvancedSecurityOptions": { + "type": { + "$ref": "#/0" + }, + "flags": 0 + }, + "Arn": { + "type": { + "$ref": "#/21" + }, + "flags": 2 + }, + "ClusterConfig": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "CognitoOptions": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "DomainArn": { + "type": { + "$ref": "#/21" + }, + "flags": 2 + }, + "DomainEndpoint": { + "type": { + "$ref": "#/21" + }, + "flags": 2 + }, + "DomainEndpointOptions": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "DomainEndpointV2": { + "type": { + "$ref": "#/21" + }, + "flags": 2 + }, + "DomainEndpoints": { + "type": { + "$ref": "#/29" + }, + "flags": 2 + }, + "DomainName": { + "type": { + "$ref": "#/21" + }, + "flags": 16 + }, + "EBSOptions": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "EncryptionAtRestOptions": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "EngineVersion": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "IPAddressType": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "Id": { + "type": { + "$ref": "#/21" + }, + "flags": 2 + }, + "LogPublishingOptions": { + "type": { + "$ref": "#/30" + }, + "flags": 0 + }, + "NodeToNodeEncryptionOptions": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "OffPeakWindowOptions": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + }, + "ServiceSoftwareOptions": { + "type": { + "$ref": "#/14" + }, + "flags": 2 + }, + "SnapshotOptions": { + "type": { + "$ref": "#/15" + }, + "flags": 0 + }, + "SoftwareUpdateOptions": { + "type": { + "$ref": "#/16" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/31" + }, + "flags": 0, + "description": "An arbitrary set of tags (key-value pairs) for this Domain." + }, + "VPCOptions": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.OpenSearchService/Domain", + "properties": { + "name": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/21" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/32" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.OpenSearchService/Domain@default", + "scopeType": 0, + "body": { + "$ref": "#/33" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.opensearchservice/default/types.md b/artifacts/bicep/aws/aws.opensearchservice/default/types.md index 8d0f9051..554b429c 100644 --- a/artifacts/bicep/aws/aws.opensearchservice/default/types.md +++ b/artifacts/bicep/aws/aws.opensearchservice/default/types.md @@ -3,9 +3,18 @@ ## Resource AWS.OpenSearchService/Domain@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.OpenSearchService/DomainProperties](#awsopensearchservicedomainproperties): properties of the resource +* **properties**: [AWS.OpenSearchService/DomainProperties](#awsopensearchservicedomainproperties) (Identifier): properties of the resource + +## AdvancedSecurityOptionsInput +### Properties +* **AnonymousAuthDisableDate**: string (ReadOnly) +* **AnonymousAuthEnabled**: bool +* **Enabled**: bool +* **InternalUserDatabaseEnabled**: bool +* **MasterUserOptions**: [MasterUserOptions](#masteruseroptions) (WriteOnly) +* **SAMLOptions**: [SAMLOptions](#samloptions) ## AWS.OpenSearchService/DomainProperties ### Properties @@ -35,44 +44,9 @@ * **Tags**: [Tag](#tag)[]: An arbitrary set of tags (key-value pairs) for this Domain. * **VPCOptions**: [VPCOptions](#vpcoptions) -## Domain_AccessPolicies -### Properties - -## Domain_AdvancedOptions -### Properties - -## AdvancedSecurityOptionsInput -### Properties -* **AnonymousAuthDisableDate**: string (ReadOnly) -* **AnonymousAuthEnabled**: bool -* **Enabled**: bool -* **InternalUserDatabaseEnabled**: bool -* **MasterUserOptions**: [MasterUserOptions](#masteruseroptions) (WriteOnly) -* **SAMLOptions**: [SAMLOptions](#samloptions) - -## MasterUserOptions -### Properties -* **MasterUserARN**: string -* **MasterUserName**: string -* **MasterUserPassword**: string - -## SAMLOptions -### Properties -* **Enabled**: bool -* **Idp**: [Idp](#idp) -* **MasterBackendRole**: string (WriteOnly) -* **MasterUserName**: string (WriteOnly) -* **RolesKey**: string -* **SessionTimeoutMinutes**: int -* **SubjectKey**: string - -## Idp -### Properties -* **EntityId**: string (Required) -* **MetadataContent**: string (Required) - ## ClusterConfig ### Properties +* **ColdStorageOptions**: [ColdStorageOptions](#coldstorageoptions) * **DedicatedMasterCount**: int * **DedicatedMasterEnabled**: bool * **DedicatedMasterType**: string @@ -85,10 +59,6 @@ * **ZoneAwarenessConfig**: [ZoneAwarenessConfig](#zoneawarenessconfig) * **ZoneAwarenessEnabled**: bool -## ZoneAwarenessConfig -### Properties -* **AvailabilityZoneCount**: int - ## CognitoOptions ### Properties * **Enabled**: bool @@ -96,6 +66,22 @@ * **RoleArn**: string * **UserPoolId**: string +## ColdStorageOptions +### Properties +* **Enabled**: bool + +## Domain_AccessPolicies +### Properties + +## Domain_AdvancedOptions +### Properties + +## Domain_DomainEndpoints +### Properties + +## Domain_LogPublishingOptions +### Properties + ## DomainEndpointOptions ### Properties * **CustomEndpoint**: string @@ -104,9 +90,6 @@ * **EnforceHTTPS**: bool * **TLSSecurityPolicy**: string -## Domain_DomainEndpoints -### Properties - ## EBSOptions ### Properties * **EBSEnabled**: bool @@ -120,26 +103,39 @@ * **Enabled**: bool * **KmsKeyId**: string -## Domain_LogPublishingOptions +## Idp ### Properties +* **EntityId**: string (Required) +* **MetadataContent**: string (Required) -## NodeToNodeEncryptionOptions +## MasterUserOptions ### Properties -* **Enabled**: bool +* **MasterUserARN**: string +* **MasterUserName**: string +* **MasterUserPassword**: string -## OffPeakWindowOptions +## NodeToNodeEncryptionOptions ### Properties * **Enabled**: bool -* **OffPeakWindow**: [OffPeakWindow](#offpeakwindow) ## OffPeakWindow ### Properties * **WindowStartTime**: [WindowStartTime](#windowstarttime) -## WindowStartTime +## OffPeakWindowOptions ### Properties -* **Hours**: int (Required) -* **Minutes**: int (Required) +* **Enabled**: bool +* **OffPeakWindow**: [OffPeakWindow](#offpeakwindow) + +## SAMLOptions +### Properties +* **Enabled**: bool +* **Idp**: [Idp](#idp) +* **MasterBackendRole**: string (WriteOnly) +* **MasterUserName**: string (WriteOnly) +* **RolesKey**: string +* **SessionTimeoutMinutes**: int +* **SubjectKey**: string ## ServiceSoftwareOptions ### Properties @@ -170,3 +166,12 @@ * **SecurityGroupIds**: string[] * **SubnetIds**: string[] +## WindowStartTime +### Properties +* **Hours**: int (Required) +* **Minutes**: int (Required) + +## ZoneAwarenessConfig +### Properties +* **AvailabilityZoneCount**: int + diff --git a/artifacts/bicep/aws/aws.opsworkscm/default/types.json b/artifacts/bicep/aws/aws.opsworkscm/default/types.json index b3f77189..a8606d06 100644 --- a/artifacts/bicep/aws/aws.opsworkscm/default/types.json +++ b/artifacts/bicep/aws/aws.opsworkscm/default/types.json @@ -1 +1,255 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"EngineAttribute","Properties":{"Name":{"Type":4,"Flags":0},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.OpsWorksCM/ServerProperties","Properties":{"Arn":{"Type":4,"Flags":2},"AssociatePublicIpAddress":{"Type":2,"Flags":0},"BackupId":{"Type":4,"Flags":4},"BackupRetentionCount":{"Type":3,"Flags":0},"CustomCertificate":{"Type":4,"Flags":4},"CustomDomain":{"Type":4,"Flags":4},"CustomPrivateKey":{"Type":4,"Flags":4},"DisableAutomatedBackup":{"Type":2,"Flags":0},"Endpoint":{"Type":4,"Flags":2},"Engine":{"Type":4,"Flags":0},"EngineAttributes":{"Type":11,"Flags":4},"EngineModel":{"Type":4,"Flags":0},"EngineVersion":{"Type":4,"Flags":4},"InstanceProfileArn":{"Type":4,"Flags":1},"InstanceType":{"Type":4,"Flags":1},"KeyPair":{"Type":4,"Flags":4},"PreferredBackupWindow":{"Type":4,"Flags":0},"PreferredMaintenanceWindow":{"Type":4,"Flags":0},"SecurityGroupIds":{"Type":12,"Flags":0},"ServerName":{"Type":4,"Flags":18},"ServiceRoleArn":{"Type":4,"Flags":1},"SubnetIds":{"Type":13,"Flags":0},"Tags":{"Type":14,"Flags":4}}}},{"3":{"ItemType":8}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":9}},{"2":{"Name":"AWS.OpsWorksCM/Server","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":10,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.OpsWorksCM/Server@default","ScopeType":0,"Body":15}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "EngineAttribute", + "properties": { + "Name": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.OpsWorksCM/ServerProperties" + }, + { + "$type": "BooleanType" + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "AWS.OpsWorksCM/ServerProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/2" + }, + "flags": 2 + }, + "AssociatePublicIpAddress": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "BackupId": { + "type": { + "$ref": "#/2" + }, + "flags": 4 + }, + "BackupRetentionCount": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "CustomCertificate": { + "type": { + "$ref": "#/2" + }, + "flags": 4 + }, + "CustomDomain": { + "type": { + "$ref": "#/2" + }, + "flags": 4 + }, + "CustomPrivateKey": { + "type": { + "$ref": "#/2" + }, + "flags": 4 + }, + "DisableAutomatedBackup": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "Endpoint": { + "type": { + "$ref": "#/2" + }, + "flags": 2 + }, + "Engine": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "EngineAttributes": { + "type": { + "$ref": "#/6" + }, + "flags": 4 + }, + "EngineModel": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "EngineVersion": { + "type": { + "$ref": "#/2" + }, + "flags": 4 + }, + "InstanceProfileArn": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "InstanceType": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "KeyPair": { + "type": { + "$ref": "#/2" + }, + "flags": 4 + }, + "PreferredBackupWindow": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "PreferredMaintenanceWindow": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "SecurityGroupIds": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "ServerName": { + "type": { + "$ref": "#/2" + }, + "flags": 18 + }, + "ServiceRoleArn": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "SubnetIds": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/9" + }, + "flags": 4 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.OpsWorksCM/Server", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/10" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.OpsWorksCM/Server@default", + "scopeType": 0, + "body": { + "$ref": "#/11" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.opsworkscm/default/types.md b/artifacts/bicep/aws/aws.opsworkscm/default/types.md index 6e16c8cb..b0a423c3 100644 --- a/artifacts/bicep/aws/aws.opsworkscm/default/types.md +++ b/artifacts/bicep/aws/aws.opsworkscm/default/types.md @@ -3,9 +3,9 @@ ## Resource AWS.OpsWorksCM/Server@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.OpsWorksCM/ServerProperties](#awsopsworkscmserverproperties) (Required): properties of the resource +* **properties**: [AWS.OpsWorksCM/ServerProperties](#awsopsworkscmserverproperties) (Required, Identifier): properties of the resource ## AWS.OpsWorksCM/ServerProperties ### Properties diff --git a/artifacts/bicep/aws/aws.organizations/default/types.json b/artifacts/bicep/aws/aws.organizations/default/types.json index 6aa1e72e..55a44715 100644 --- a/artifacts/bicep/aws/aws.organizations/default/types.json +++ b/artifacts/bicep/aws/aws.organizations/default/types.json @@ -1 +1,631 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key identifier, or name, of the tag."},"Value":{"Type":4,"Flags":1,"Description":"The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null."}}}},{"2":{"Name":"AWS.Organizations/AccountProperties","Properties":{"AccountId":{"Type":4,"Flags":18,"Description":"If the account was created successfully, the unique identifier (ID) of the new account."},"AccountName":{"Type":4,"Flags":1,"Description":"The friendly name of the member account."},"Arn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) of the account."},"Email":{"Type":4,"Flags":1,"Description":"The email address of the owner to assign to the new member account."},"JoinedMethod":{"Type":4,"Flags":2,"Description":"The method by which the account joined the organization."},"JoinedTimestamp":{"Type":4,"Flags":2,"Description":"The date the account became a part of the organization."},"ParentIds":{"Type":10,"Flags":0,"Description":"List of parent nodes for the member account. Currently only one parent at a time is supported. Default is root."},"RoleName":{"Type":4,"Flags":4,"Description":"The name of an IAM role that AWS Organizations automatically preconfigures in the new member account. Default name is OrganizationAccountAccessRole if not specified."},"Status":{"Type":4,"Flags":2,"Description":"The status of the account in the organization."},"Tags":{"Type":11,"Flags":0,"Description":"A list of tags that you want to attach to the newly created account. For each tag in the list, you must specify both a tag key and a value."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":8}},{"2":{"Name":"AWS.Organizations/Account","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":9,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Organizations/Account@default","ScopeType":0,"Body":12}},{"2":{"Name":"AWS.Organizations/OrganizationProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) of an organization."},"FeatureSet":{"Type":4,"Flags":0,"Description":"Specifies the feature set supported by the new organization. Each feature set supports different levels of functionality."},"Id":{"Type":4,"Flags":18,"Description":"The unique identifier (ID) of an organization."},"ManagementAccountArn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) of the account that is designated as the management account for the organization."},"ManagementAccountEmail":{"Type":4,"Flags":2,"Description":"The email address that is associated with the AWS account that is designated as the management account for the organization."},"ManagementAccountId":{"Type":4,"Flags":2,"Description":"The unique identifier (ID) of the management account of an organization."},"RootId":{"Type":4,"Flags":2,"Description":"The unique identifier (ID) for the root."}}}},{"2":{"Name":"AWS.Organizations/Organization","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":14,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Organizations/Organization@default","ScopeType":0,"Body":15}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key identifier, or name, of the tag."},"Value":{"Type":4,"Flags":1,"Description":"The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null."}}}},{"2":{"Name":"AWS.Organizations/OrganizationalUnitProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) of this OU."},"Id":{"Type":4,"Flags":18,"Description":"The unique identifier (ID) associated with this OU."},"Name":{"Type":4,"Flags":1,"Description":"The friendly name of this OU."},"ParentId":{"Type":4,"Flags":1,"Description":"The unique identifier (ID) of the parent root or OU that you want to create the new OU in."},"Tags":{"Type":19,"Flags":0,"Description":"A list of tags that you want to attach to the newly created OU."}}}},{"3":{"ItemType":17}},{"2":{"Name":"AWS.Organizations/OrganizationalUnit","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":18,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Organizations/OrganizationalUnit@default","ScopeType":0,"Body":20}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key identifier, or name, of the tag."},"Value":{"Type":4,"Flags":1,"Description":"The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null."}}}},{"2":{"Name":"AWS.Organizations/PolicyProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"ARN of the Policy"},"AwsManaged":{"Type":2,"Flags":2,"Description":"A boolean value that indicates whether the specified policy is an AWS managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it."},"Content":{"Type":25,"Flags":1,"Description":"The Policy text content. For AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it."},"Description":{"Type":4,"Flags":0,"Description":"Human readable description of the policy"},"Id":{"Type":4,"Flags":18,"Description":"Id of the Policy"},"Name":{"Type":4,"Flags":1,"Description":"Name of the Policy"},"Tags":{"Type":26,"Flags":0,"Description":"A list of tags that you want to attach to the newly created policy. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to null."},"TargetIds":{"Type":27,"Flags":0,"Description":"List of unique identifiers (IDs) of the root, OU, or account that you want to attach the policy to"},"Type":{"Type":4,"Flags":1,"Description":"The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY"}}}},{"2":{"Name":"Policy_Content","Properties":{}}},{"5":{"Elements":[24,4]}},{"3":{"ItemType":22}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.Organizations/Policy","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":23,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Organizations/Policy@default","ScopeType":0,"Body":28}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key identifier, or name, of the tag."},"Value":{"Type":4,"Flags":1,"Description":"The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null."}}}},{"2":{"Name":"AWS.Organizations/ResourcePolicyProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) of the resource policy."},"Content":{"Type":33,"Flags":1,"Description":"The policy document. For AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it."},"Id":{"Type":4,"Flags":18,"Description":"The unique identifier (ID) associated with this resource policy."},"Tags":{"Type":34,"Flags":0,"Description":"A list of tags that you want to attach to the resource policy"}}}},{"2":{"Name":"ResourcePolicy_Content","Properties":{}}},{"5":{"Elements":[32,4]}},{"3":{"ItemType":30}},{"2":{"Name":"AWS.Organizations/ResourcePolicy","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":31,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Organizations/ResourcePolicy@default","ScopeType":0,"Body":35}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key identifier, or name, of the tag." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null." + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.Organizations/AccountProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Organizations/AccountProperties", + "properties": { + "AccountId": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "If the account was created successfully, the unique identifier (ID) of the new account." + }, + "AccountName": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The friendly name of the member account." + }, + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) of the account." + }, + "Email": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The email address of the owner to assign to the new member account." + }, + "JoinedMethod": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The method by which the account joined the organization." + }, + "JoinedTimestamp": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The date the account became a part of the organization." + }, + "ParentIds": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "List of parent nodes for the member account. Currently only one parent at a time is supported. Default is root." + }, + "RoleName": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The name of an IAM role that AWS Organizations automatically preconfigures in the new member account. Default name is OrganizationAccountAccessRole if not specified." + }, + "Status": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The status of the account in the organization." + }, + "Tags": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "A list of tags that you want to attach to the newly created account. For each tag in the list, you must specify both a tag key and a value." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Organizations/Account", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Organizations/Account@default", + "scopeType": 0, + "body": { + "$ref": "#/6" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.Organizations/OrganizationProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.Organizations/OrganizationProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) of an organization." + }, + "FeatureSet": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Specifies the feature set supported by the new organization. Each feature set supports different levels of functionality." + }, + "Id": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The unique identifier (ID) of an organization." + }, + "ManagementAccountArn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) of the account that is designated as the management account for the organization." + }, + "ManagementAccountEmail": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The email address that is associated with the AWS account that is designated as the management account for the organization." + }, + "ManagementAccountId": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The unique identifier (ID) of the management account of an organization." + }, + "RootId": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The unique identifier (ID) for the root." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Organizations/Organization", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/9" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Organizations/Organization@default", + "scopeType": 0, + "body": { + "$ref": "#/10" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key identifier, or name, of the tag." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Organizations/OrganizationalUnitProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/12" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Organizations/OrganizationalUnitProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) of this OU." + }, + "Id": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The unique identifier (ID) associated with this OU." + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The friendly name of this OU." + }, + "ParentId": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The unique identifier (ID) of the parent root or OU that you want to create the new OU in." + }, + "Tags": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "A list of tags that you want to attach to the newly created OU." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Organizations/OrganizationalUnit", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/15" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Organizations/OrganizationalUnit@default", + "scopeType": 0, + "body": { + "$ref": "#/16" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key identifier, or name, of the tag." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Organizations/PolicyProperties" + }, + { + "$type": "BooleanType" + }, + { + "$type": "ObjectType", + "name": "Policy_Content", + "properties": {} + }, + { + "$type": "UnionType", + "elements": [ + { + "$ref": "#/21" + }, + { + "$ref": "#/1" + } + ] + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/18" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Organizations/PolicyProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "ARN of the Policy" + }, + "AwsManaged": { + "type": { + "$ref": "#/20" + }, + "flags": 2, + "description": "A boolean value that indicates whether the specified policy is an AWS managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it." + }, + "Content": { + "type": { + "$ref": "#/22" + }, + "flags": 1, + "description": "The Policy text content. For AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it." + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Human readable description of the policy" + }, + "Id": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "Id of the Policy" + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Name of the Policy" + }, + "Tags": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "A list of tags that you want to attach to the newly created policy. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to null." + }, + "TargetIds": { + "type": { + "$ref": "#/24" + }, + "flags": 0, + "description": "List of unique identifiers (IDs) of the root, OU, or account that you want to attach the policy to" + }, + "Type": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Organizations/Policy", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/25" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Organizations/Policy@default", + "scopeType": 0, + "body": { + "$ref": "#/26" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key identifier, or name, of the tag." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Organizations/ResourcePolicyProperties" + }, + { + "$type": "ObjectType", + "name": "ResourcePolicy_Content", + "properties": {} + }, + { + "$type": "UnionType", + "elements": [ + { + "$ref": "#/30" + }, + { + "$ref": "#/1" + } + ] + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/28" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Organizations/ResourcePolicyProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) of the resource policy." + }, + "Content": { + "type": { + "$ref": "#/31" + }, + "flags": 1, + "description": "The policy document. For AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it." + }, + "Id": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The unique identifier (ID) associated with this resource policy." + }, + "Tags": { + "type": { + "$ref": "#/32" + }, + "flags": 0, + "description": "A list of tags that you want to attach to the resource policy" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Organizations/ResourcePolicy", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/33" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Organizations/ResourcePolicy@default", + "scopeType": 0, + "body": { + "$ref": "#/34" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.organizations/default/types.md b/artifacts/bicep/aws/aws.organizations/default/types.md index 02b4b680..356eecb4 100644 --- a/artifacts/bicep/aws/aws.organizations/default/types.md +++ b/artifacts/bicep/aws/aws.organizations/default/types.md @@ -3,37 +3,37 @@ ## Resource AWS.Organizations/Account@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Organizations/AccountProperties](#awsorganizationsaccountproperties) (Required): properties of the resource +* **properties**: [AWS.Organizations/AccountProperties](#awsorganizationsaccountproperties) (Required, Identifier): properties of the resource ## Resource AWS.Organizations/Organization@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Organizations/OrganizationProperties](#awsorganizationsorganizationproperties): properties of the resource +* **properties**: [AWS.Organizations/OrganizationProperties](#awsorganizationsorganizationproperties) (Identifier): properties of the resource ## Resource AWS.Organizations/OrganizationalUnit@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Organizations/OrganizationalUnitProperties](#awsorganizationsorganizationalunitproperties) (Required): properties of the resource +* **properties**: [AWS.Organizations/OrganizationalUnitProperties](#awsorganizationsorganizationalunitproperties) (Required, Identifier): properties of the resource ## Resource AWS.Organizations/Policy@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Organizations/PolicyProperties](#awsorganizationspolicyproperties) (Required): properties of the resource +* **properties**: [AWS.Organizations/PolicyProperties](#awsorganizationspolicyproperties) (Required, Identifier): properties of the resource ## Resource AWS.Organizations/ResourcePolicy@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Organizations/ResourcePolicyProperties](#awsorganizationsresourcepolicyproperties) (Required): properties of the resource +* **properties**: [AWS.Organizations/ResourcePolicyProperties](#awsorganizationsresourcepolicyproperties) (Required, Identifier): properties of the resource ## AWS.Organizations/AccountProperties ### Properties @@ -48,10 +48,13 @@ * **Status**: string (ReadOnly): The status of the account in the organization. * **Tags**: [Tag](#tag)[]: A list of tags that you want to attach to the newly created account. For each tag in the list, you must specify both a tag key and a value. -## Tag +## AWS.Organizations/OrganizationalUnitProperties ### Properties -* **Key**: string (Required): The key identifier, or name, of the tag. -* **Value**: string (Required): The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null. +* **Arn**: string (ReadOnly): The Amazon Resource Name (ARN) of this OU. +* **Id**: string (ReadOnly, Identifier): The unique identifier (ID) associated with this OU. +* **Name**: string (Required): The friendly name of this OU. +* **ParentId**: string (Required): The unique identifier (ID) of the parent root or OU that you want to create the new OU in. +* **Tags**: [Tag](#tag)[]: A list of tags that you want to attach to the newly created OU. ## AWS.Organizations/OrganizationProperties ### Properties @@ -63,19 +66,6 @@ * **ManagementAccountId**: string (ReadOnly): The unique identifier (ID) of the management account of an organization. * **RootId**: string (ReadOnly): The unique identifier (ID) for the root. -## AWS.Organizations/OrganizationalUnitProperties -### Properties -* **Arn**: string (ReadOnly): The Amazon Resource Name (ARN) of this OU. -* **Id**: string (ReadOnly, Identifier): The unique identifier (ID) associated with this OU. -* **Name**: string (Required): The friendly name of this OU. -* **ParentId**: string (Required): The unique identifier (ID) of the parent root or OU that you want to create the new OU in. -* **Tags**: [Tag](#tag)[]: A list of tags that you want to attach to the newly created OU. - -## Tag -### Properties -* **Key**: string (Required): The key identifier, or name, of the tag. -* **Value**: string (Required): The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null. - ## AWS.Organizations/PolicyProperties ### Properties * **Arn**: string (ReadOnly): ARN of the Policy @@ -88,11 +78,6 @@ * **TargetIds**: string[]: List of unique identifiers (IDs) of the root, OU, or account that you want to attach the policy to * **Type**: string (Required): The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY -## Tag -### Properties -* **Key**: string (Required): The key identifier, or name, of the tag. -* **Value**: string (Required): The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null. - ## AWS.Organizations/ResourcePolicyProperties ### Properties * **Arn**: string (ReadOnly): The Amazon Resource Name (ARN) of the resource policy. @@ -105,3 +90,18 @@ * **Key**: string (Required): The key identifier, or name, of the tag. * **Value**: string (Required): The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null. +## Tag +### Properties +* **Key**: string (Required): The key identifier, or name, of the tag. +* **Value**: string (Required): The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null. + +## Tag +### Properties +* **Key**: string (Required): The key identifier, or name, of the tag. +* **Value**: string (Required): The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null. + +## Tag +### Properties +* **Key**: string (Required): The key identifier, or name, of the tag. +* **Value**: string (Required): The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null. + diff --git a/artifacts/bicep/aws/aws.osis/default/types.json b/artifacts/bicep/aws/aws.osis/default/types.json index 7a160060..4e9bb3a7 100644 --- a/artifacts/bicep/aws/aws.osis/default/types.json +++ b/artifacts/bicep/aws/aws.osis/default/types.json @@ -1 +1,305 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"BufferOptions","Properties":{"PersistentBufferEnabled":{"Type":2,"Flags":1,"Description":"Whether persistent buffering should be enabled."}}}},{"2":{"Name":"EncryptionAtRestOptions","Properties":{"KmsKeyArn":{"Type":4,"Flags":1,"Description":"The KMS key to use for encrypting data. By default an AWS owned key is used"}}}},{"2":{"Name":"LogPublishingOptions","Properties":{"CloudWatchLogDestination":{"Type":14,"Flags":0,"Description":"The destination for OpenSearch Ingestion Service logs sent to Amazon CloudWatch."},"IsLoggingEnabled":{"Type":2,"Flags":0,"Description":"Whether logs should be published."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"VpcEndpoint","Properties":{"VpcEndpointId":{"Type":4,"Flags":0,"Description":"The unique identifier of the endpoint."},"VpcId":{"Type":4,"Flags":0,"Description":"The ID for your VPC. AWS Privatelink generates this value when you create a VPC."},"VpcOptions":{"Type":13,"Flags":0}}}},{"2":{"Name":"VpcOptions","Properties":{"SecurityGroupIds":{"Type":15,"Flags":0,"Description":"A list of security groups associated with the VPC endpoint."},"SubnetIds":{"Type":16,"Flags":1,"Description":"A list of subnet IDs associated with the VPC endpoint."}}}},{"2":{"Name":"Pipeline_CloudWatchLogDestination","Properties":{"LogGroup":{"Type":4,"Flags":1}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.OSIS/PipelineProperties","Properties":{"BufferOptions":{"Type":8,"Flags":0},"EncryptionAtRestOptions":{"Type":9,"Flags":0},"IngestEndpointUrls":{"Type":18,"Flags":2,"Description":"A list of endpoints that can be used for ingesting data into a pipeline"},"LogPublishingOptions":{"Type":10,"Flags":0},"MaxUnits":{"Type":3,"Flags":1,"Description":"The maximum pipeline capacity, in Ingestion Compute Units (ICUs)."},"MinUnits":{"Type":3,"Flags":1,"Description":"The minimum pipeline capacity, in Ingestion Compute Units (ICUs)."},"PipelineArn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN) of the pipeline."},"PipelineConfigurationBody":{"Type":4,"Flags":1,"Description":"The Data Prepper pipeline configuration in YAML format."},"PipelineName":{"Type":4,"Flags":1,"Description":"Name of the OpenSearch Ingestion Service pipeline to create. Pipeline names are unique across the pipelines owned by an account within an AWS Region."},"Tags":{"Type":19,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."},"VpcEndpoints":{"Type":20,"Flags":2,"Description":"The VPC interface endpoints that have access to the pipeline."},"VpcOptions":{"Type":13,"Flags":4}}}},{"3":{"ItemType":4}},{"3":{"ItemType":11}},{"3":{"ItemType":12}},{"2":{"Name":"AWS.OSIS/Pipeline","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":17,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.OSIS/Pipeline@default","ScopeType":0,"Body":21}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "BufferOptions", + "properties": { + "PersistentBufferEnabled": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "Whether persistent buffering should be enabled." + } + } + }, + { + "$type": "ObjectType", + "name": "EncryptionAtRestOptions", + "properties": { + "KmsKeyArn": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "The KMS key to use for encrypting data. By default an AWS owned key is used" + } + } + }, + { + "$type": "ObjectType", + "name": "LogPublishingOptions", + "properties": { + "CloudWatchLogDestination": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The destination for OpenSearch Ingestion Service logs sent to Amazon CloudWatch." + }, + "IsLoggingEnabled": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Whether logs should be published." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "ObjectType", + "name": "VpcEndpoint", + "properties": { + "VpcEndpointId": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "The unique identifier of the endpoint." + }, + "VpcId": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "The ID for your VPC. AWS Privatelink generates this value when you create a VPC." + }, + "VpcOptions": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "VpcOptions", + "properties": { + "SecurityGroupIds": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "A list of security groups associated with the VPC endpoint." + }, + "SubnetIds": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "A list of subnet IDs associated with the VPC endpoint." + }, + "VpcEndpointManagement": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "Defines whether you or Amazon OpenSearch Ingestion service create and manage the VPC endpoint configured for the pipeline." + } + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "StringType" + }, + { + "$type": "ObjectType", + "name": "Pipeline_CloudWatchLogDestination", + "properties": { + "LogGroup": { + "type": { + "$ref": "#/7" + }, + "flags": 1 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/7" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/7" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.OSIS/PipelineProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/7" + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ObjectType", + "name": "AWS.OSIS/PipelineProperties", + "properties": { + "BufferOptions": { + "type": { + "$ref": "#/0" + }, + "flags": 0 + }, + "EncryptionAtRestOptions": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "IngestEndpointUrls": { + "type": { + "$ref": "#/12" + }, + "flags": 2, + "description": "A list of endpoints that can be used for ingesting data into a pipeline" + }, + "LogPublishingOptions": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "MaxUnits": { + "type": { + "$ref": "#/13" + }, + "flags": 1, + "description": "The maximum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs)." + }, + "MinUnits": { + "type": { + "$ref": "#/13" + }, + "flags": 1, + "description": "The minimum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs)." + }, + "PipelineArn": { + "type": { + "$ref": "#/7" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) of the pipeline." + }, + "PipelineConfigurationBody": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "The Data Prepper pipeline configuration." + }, + "PipelineName": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "Name of the OpenSearch Ingestion Service pipeline to create. Pipeline names are unique across the pipelines owned by an account within an AWS Region." + }, + "Tags": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + }, + "VpcEndpointService": { + "type": { + "$ref": "#/7" + }, + "flags": 2, + "description": "The VPC endpoint service name for the pipeline." + }, + "VpcEndpoints": { + "type": { + "$ref": "#/15" + }, + "flags": 2, + "description": "The VPC interface endpoints that have access to the pipeline." + }, + "VpcOptions": { + "type": { + "$ref": "#/5" + }, + "flags": 4 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.OSIS/Pipeline", + "properties": { + "name": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/7" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/16" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.OSIS/Pipeline@default", + "scopeType": 0, + "body": { + "$ref": "#/17" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.osis/default/types.md b/artifacts/bicep/aws/aws.osis/default/types.md index 359ae73c..9f9285c7 100644 --- a/artifacts/bicep/aws/aws.osis/default/types.md +++ b/artifacts/bicep/aws/aws.osis/default/types.md @@ -3,9 +3,9 @@ ## Resource AWS.OSIS/Pipeline@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.OSIS/PipelineProperties](#awsosispipelineproperties) (Required): properties of the resource +* **properties**: [AWS.OSIS/PipelineProperties](#awsosispipelineproperties) (Required, Identifier): properties of the resource ## AWS.OSIS/PipelineProperties ### Properties @@ -13,13 +13,14 @@ * **EncryptionAtRestOptions**: [EncryptionAtRestOptions](#encryptionatrestoptions) * **IngestEndpointUrls**: string[] (ReadOnly): A list of endpoints that can be used for ingesting data into a pipeline * **LogPublishingOptions**: [LogPublishingOptions](#logpublishingoptions) -* **MaxUnits**: int (Required): The maximum pipeline capacity, in Ingestion Compute Units (ICUs). -* **MinUnits**: int (Required): The minimum pipeline capacity, in Ingestion Compute Units (ICUs). +* **MaxUnits**: int (Required): The maximum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs). +* **MinUnits**: int (Required): The minimum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs). * **PipelineArn**: string (ReadOnly, Identifier): The Amazon Resource Name (ARN) of the pipeline. -* **PipelineConfigurationBody**: string (Required): The Data Prepper pipeline configuration in YAML format. +* **PipelineConfigurationBody**: string (Required): The Data Prepper pipeline configuration. * **PipelineName**: string (Required): Name of the OpenSearch Ingestion Service pipeline to create. Pipeline names are unique across the pipelines owned by an account within an AWS Region. * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. * **VpcEndpoints**: [VpcEndpoint](#vpcendpoint)[] (ReadOnly): The VPC interface endpoints that have access to the pipeline. +* **VpcEndpointService**: string (ReadOnly): The VPC endpoint service name for the pipeline. * **VpcOptions**: [VpcOptions](#vpcoptions) (WriteOnly) ## BufferOptions @@ -54,4 +55,5 @@ ### Properties * **SecurityGroupIds**: string[]: A list of security groups associated with the VPC endpoint. * **SubnetIds**: string[] (Required): A list of subnet IDs associated with the VPC endpoint. +* **VpcEndpointManagement**: string: Defines whether you or Amazon OpenSearch Ingestion service create and manage the VPC endpoint configured for the pipeline. diff --git a/artifacts/bicep/aws/aws.panorama/default/types.json b/artifacts/bicep/aws/aws.panorama/default/types.json index 2daff2b6..af5ddf6a 100644 --- a/artifacts/bicep/aws/aws.panorama/default/types.json +++ b/artifacts/bicep/aws/aws.panorama/default/types.json @@ -1 +1,625 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"ApplicationInstanceArn"}},{"2":{"Name":"ApplicationInstanceHealthStatus"}},{"2":{"Name":"ApplicationInstanceId"}},{"2":{"Name":"ApplicationInstanceStatus"}},{"2":{"Name":"ApplicationInstanceStatusDescription"}},{"2":{"Name":"DefaultRuntimeContextDevice"}},{"2":{"Name":"Description"}},{"2":{"Name":"DeviceId"}},{"2":{"Name":"DeviceName"}},{"2":{"Name":"ManifestOverridesPayload","Properties":{"PayloadData":{"Type":4,"Flags":0}}}},{"2":{"Name":"ManifestOverridesPayloadData"}},{"2":{"Name":"ManifestPayload","Properties":{"PayloadData":{"Type":4,"Flags":0}}}},{"2":{"Name":"ManifestPayloadData"}},{"2":{"Name":"Name"}},{"2":{"Name":"RuntimeRoleArn"}},{"2":{"Name":"StatusFilter"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"A string used to identify this tag"},"Value":{"Type":4,"Flags":1,"Description":"A string containing the value for the tag"}}}},{"2":{"Name":"TagList"}},{"2":{"Name":"Timestamp"}},{"3":{"ItemType":24}},{"2":{"Name":"AWS.Panorama/ApplicationInstanceProperties","Properties":{"ApplicationInstanceId":{"Type":4,"Flags":18},"ApplicationInstanceIdToReplace":{"Type":4,"Flags":4},"Arn":{"Type":4,"Flags":2},"CreatedTime":{"Type":3,"Flags":2},"DefaultRuntimeContextDevice":{"Type":4,"Flags":1},"DefaultRuntimeContextDeviceName":{"Type":4,"Flags":2},"Description":{"Type":4,"Flags":0},"HealthStatus":{"Type":4,"Flags":2},"LastUpdatedTime":{"Type":3,"Flags":2},"ManifestOverridesPayload":{"Type":17,"Flags":0},"ManifestPayload":{"Type":19,"Flags":1},"Name":{"Type":4,"Flags":0},"RuntimeRoleArn":{"Type":4,"Flags":0},"Status":{"Type":4,"Flags":2},"StatusDescription":{"Type":4,"Flags":2},"Tags":{"Type":29,"Flags":0}}}},{"3":{"ItemType":24}},{"2":{"Name":"AWS.Panorama/ApplicationInstance","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":28,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Panorama/ApplicationInstance@default","ScopeType":0,"Body":30}},{"2":{"Name":"NodePackageArn"}},{"2":{"Name":"NodePackageId"}},{"2":{"Name":"NodePackageName"}},{"2":{"Name":"StorageLocation","Properties":{"BinaryPrefixLocation":{"Type":4,"Flags":2},"Bucket":{"Type":4,"Flags":2},"GeneratedPrefixLocation":{"Type":4,"Flags":2},"ManifestPrefixLocation":{"Type":4,"Flags":2},"RepoPrefixLocation":{"Type":4,"Flags":2}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"TagList"}},{"2":{"Name":"Timestamp"}},{"3":{"ItemType":36}},{"2":{"Name":"AWS.Panorama/PackageProperties","Properties":{"Arn":{"Type":4,"Flags":2},"CreatedTime":{"Type":3,"Flags":2},"PackageId":{"Type":4,"Flags":18},"PackageName":{"Type":4,"Flags":1},"StorageLocation":{"Type":35,"Flags":0},"Tags":{"Type":41,"Flags":0}}}},{"3":{"ItemType":36}},{"2":{"Name":"AWS.Panorama/Package","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":40,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Panorama/Package@default","ScopeType":0,"Body":42}},{"2":{"Name":"NodePackageArn"}},{"2":{"Name":"NodePackageId"}},{"2":{"Name":"NodePackageName"}},{"2":{"Name":"NodePackagePatchVersion"}},{"2":{"Name":"NodePackageVersion"}},{"2":{"Name":"PackageOwnerAccount"}},{"2":{"Name":"PackageVersionStatus"}},{"2":{"Name":"PackageVersionStatusDescription"}},{"2":{"Name":"TimeStamp"}},{"2":{"Name":"AWS.Panorama/PackageVersionProperties","Properties":{"IsLatestPatch":{"Type":2,"Flags":2},"MarkLatest":{"Type":2,"Flags":0},"OwnerAccount":{"Type":4,"Flags":0},"PackageArn":{"Type":4,"Flags":2},"PackageId":{"Type":4,"Flags":17},"PackageName":{"Type":4,"Flags":2},"PackageVersion":{"Type":4,"Flags":17},"PatchVersion":{"Type":4,"Flags":17},"RegisteredTime":{"Type":3,"Flags":2},"Status":{"Type":4,"Flags":2},"StatusDescription":{"Type":4,"Flags":2},"UpdatedLatestPatchVersion":{"Type":4,"Flags":4}}}},{"2":{"Name":"AWS.Panorama/PackageVersion","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":53,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Panorama/PackageVersion@default","ScopeType":0,"Body":54}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "ApplicationInstanceArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ApplicationInstanceHealthStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ApplicationInstanceId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ApplicationInstanceStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ApplicationInstanceStatusDescription", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DefaultRuntimeContextDevice", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Description", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DeviceId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DeviceName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ManifestOverridesPayload", + "properties": { + "PayloadData": { + "type": { + "$ref": "#/19" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ManifestOverridesPayloadData", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ManifestPayload", + "properties": { + "PayloadData": { + "type": { + "$ref": "#/19" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ManifestPayloadData", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Name", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RuntimeRoleArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "StatusFilter", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/19" + }, + "flags": 1, + "description": "A string used to identify this tag" + }, + "Value": { + "type": { + "$ref": "#/19" + }, + "flags": 1, + "description": "A string containing the value for the tag" + } + } + }, + { + "$type": "ObjectType", + "name": "TagList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Timestamp", + "properties": {} + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/16" + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.Panorama/ApplicationInstanceProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/16" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Panorama/ApplicationInstanceProperties", + "properties": { + "ApplicationInstanceId": { + "type": { + "$ref": "#/19" + }, + "flags": 18 + }, + "ApplicationInstanceIdToReplace": { + "type": { + "$ref": "#/19" + }, + "flags": 4 + }, + "Arn": { + "type": { + "$ref": "#/19" + }, + "flags": 2 + }, + "CreatedTime": { + "type": { + "$ref": "#/21" + }, + "flags": 2 + }, + "DefaultRuntimeContextDevice": { + "type": { + "$ref": "#/19" + }, + "flags": 1 + }, + "DefaultRuntimeContextDeviceName": { + "type": { + "$ref": "#/19" + }, + "flags": 2 + }, + "Description": { + "type": { + "$ref": "#/19" + }, + "flags": 0 + }, + "HealthStatus": { + "type": { + "$ref": "#/19" + }, + "flags": 2 + }, + "LastUpdatedTime": { + "type": { + "$ref": "#/21" + }, + "flags": 2 + }, + "ManifestOverridesPayload": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "ManifestPayload": { + "type": { + "$ref": "#/11" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/19" + }, + "flags": 0 + }, + "RuntimeRoleArn": { + "type": { + "$ref": "#/19" + }, + "flags": 0 + }, + "Status": { + "type": { + "$ref": "#/19" + }, + "flags": 2 + }, + "StatusDescription": { + "type": { + "$ref": "#/19" + }, + "flags": 2 + }, + "Tags": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Panorama/ApplicationInstance", + "properties": { + "name": { + "type": { + "$ref": "#/19" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/19" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/24" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Panorama/ApplicationInstance@default", + "scopeType": 0, + "body": { + "$ref": "#/25" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "NodePackageArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "NodePackageId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "NodePackageName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "StorageLocation", + "properties": { + "BinaryPrefixLocation": { + "type": { + "$ref": "#/19" + }, + "flags": 2 + }, + "Bucket": { + "type": { + "$ref": "#/19" + }, + "flags": 2 + }, + "GeneratedPrefixLocation": { + "type": { + "$ref": "#/19" + }, + "flags": 2 + }, + "ManifestPrefixLocation": { + "type": { + "$ref": "#/19" + }, + "flags": 2 + }, + "RepoPrefixLocation": { + "type": { + "$ref": "#/19" + }, + "flags": 2 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/19" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/19" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TagList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Timestamp", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/31" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Panorama/PackageProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/31" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Panorama/PackageProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/19" + }, + "flags": 2 + }, + "CreatedTime": { + "type": { + "$ref": "#/21" + }, + "flags": 2 + }, + "PackageId": { + "type": { + "$ref": "#/19" + }, + "flags": 18 + }, + "PackageName": { + "type": { + "$ref": "#/19" + }, + "flags": 1 + }, + "StorageLocation": { + "type": { + "$ref": "#/30" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/36" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Panorama/Package", + "properties": { + "name": { + "type": { + "$ref": "#/19" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/19" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/37" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Panorama/Package@default", + "scopeType": 0, + "body": { + "$ref": "#/38" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "NodePackageArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "NodePackageId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "NodePackageName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "NodePackagePatchVersion", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "NodePackageVersion", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PackageOwnerAccount", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PackageVersionStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PackageVersionStatusDescription", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TimeStamp", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.Panorama/PackageVersionProperties" + }, + { + "$type": "BooleanType" + }, + { + "$type": "ObjectType", + "name": "AWS.Panorama/PackageVersionProperties", + "properties": { + "IsLatestPatch": { + "type": { + "$ref": "#/50" + }, + "flags": 2 + }, + "MarkLatest": { + "type": { + "$ref": "#/50" + }, + "flags": 0 + }, + "OwnerAccount": { + "type": { + "$ref": "#/19" + }, + "flags": 0 + }, + "PackageArn": { + "type": { + "$ref": "#/19" + }, + "flags": 2 + }, + "PackageId": { + "type": { + "$ref": "#/19" + }, + "flags": 17 + }, + "PackageName": { + "type": { + "$ref": "#/19" + }, + "flags": 2 + }, + "PackageVersion": { + "type": { + "$ref": "#/19" + }, + "flags": 17 + }, + "PatchVersion": { + "type": { + "$ref": "#/19" + }, + "flags": 17 + }, + "RegisteredTime": { + "type": { + "$ref": "#/21" + }, + "flags": 2 + }, + "Status": { + "type": { + "$ref": "#/19" + }, + "flags": 2 + }, + "StatusDescription": { + "type": { + "$ref": "#/19" + }, + "flags": 2 + }, + "UpdatedLatestPatchVersion": { + "type": { + "$ref": "#/19" + }, + "flags": 4 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Panorama/PackageVersion", + "properties": { + "name": { + "type": { + "$ref": "#/19" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/19" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/51" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Panorama/PackageVersion@default", + "scopeType": 0, + "body": { + "$ref": "#/52" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.panorama/default/types.md b/artifacts/bicep/aws/aws.panorama/default/types.md index 8f2ba794..7ea7b3d6 100644 --- a/artifacts/bicep/aws/aws.panorama/default/types.md +++ b/artifacts/bicep/aws/aws.panorama/default/types.md @@ -3,23 +3,23 @@ ## Resource AWS.Panorama/ApplicationInstance@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Panorama/ApplicationInstanceProperties](#awspanoramaapplicationinstanceproperties) (Required): properties of the resource +* **properties**: [AWS.Panorama/ApplicationInstanceProperties](#awspanoramaapplicationinstanceproperties) (Required, Identifier): properties of the resource ## Resource AWS.Panorama/Package@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Panorama/PackageProperties](#awspanoramapackageproperties) (Required): properties of the resource +* **properties**: [AWS.Panorama/PackageProperties](#awspanoramapackageproperties) (Required, Identifier): properties of the resource ## Resource AWS.Panorama/PackageVersion@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Panorama/PackageVersionProperties](#awspanoramapackageversionproperties) (Required): properties of the resource +* **properties**: [AWS.Panorama/PackageVersionProperties](#awspanoramapackageversionproperties) (Required, Identifier): properties of the resource ## AWS.Panorama/ApplicationInstanceProperties ### Properties @@ -40,19 +40,6 @@ * **StatusDescription**: string (ReadOnly) * **Tags**: [Tag](#tag)[] -## ManifestOverridesPayload -### Properties -* **PayloadData**: string - -## ManifestPayload -### Properties -* **PayloadData**: string - -## Tag -### Properties -* **Key**: string (Required): A string used to identify this tag -* **Value**: string (Required): A string containing the value for the tag - ## AWS.Panorama/PackageProperties ### Properties * **Arn**: string (ReadOnly) @@ -62,19 +49,6 @@ * **StorageLocation**: [StorageLocation](#storagelocation) * **Tags**: [Tag](#tag)[] -## StorageLocation -### Properties -* **BinaryPrefixLocation**: string (ReadOnly) -* **Bucket**: string (ReadOnly) -* **GeneratedPrefixLocation**: string (ReadOnly) -* **ManifestPrefixLocation**: string (ReadOnly) -* **RepoPrefixLocation**: string (ReadOnly) - -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - ## AWS.Panorama/PackageVersionProperties ### Properties * **IsLatestPatch**: bool (ReadOnly) @@ -90,3 +64,29 @@ * **StatusDescription**: string (ReadOnly) * **UpdatedLatestPatchVersion**: string (WriteOnly) +## ManifestOverridesPayload +### Properties +* **PayloadData**: string + +## ManifestPayload +### Properties +* **PayloadData**: string + +## StorageLocation +### Properties +* **BinaryPrefixLocation**: string (ReadOnly) +* **Bucket**: string (ReadOnly) +* **GeneratedPrefixLocation**: string (ReadOnly) +* **ManifestPrefixLocation**: string (ReadOnly) +* **RepoPrefixLocation**: string (ReadOnly) + +## Tag +### Properties +* **Key**: string (Required): A string used to identify this tag +* **Value**: string (Required): A string containing the value for the tag + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + diff --git a/artifacts/bicep/aws/aws.paymentcryptography/default/types.json b/artifacts/bicep/aws/aws.paymentcryptography/default/types.json new file mode 100644 index 00000000..c6f03e33 --- /dev/null +++ b/artifacts/bicep/aws/aws.paymentcryptography/default/types.json @@ -0,0 +1,304 @@ +[ + { + "$type": "StringLiteralType", + "value": "AWS.PaymentCryptography/AliasProperties" + }, + { + "$type": "StringType" + }, + { + "$type": "ObjectType", + "name": "AWS.PaymentCryptography/AliasProperties", + "properties": { + "AliasName": { + "type": { + "$ref": "#/1" + }, + "flags": 17 + }, + "KeyArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.PaymentCryptography/Alias", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.PaymentCryptography/Alias@default", + "scopeType": 0, + "body": { + "$ref": "#/3" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "KeyAlgorithm", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "KeyAttributes", + "properties": { + "KeyAlgorithm": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "KeyClass": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "KeyModesOfUse": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + }, + "KeyUsage": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "KeyCheckValueAlgorithm", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "KeyClass", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "KeyModesOfUse", + "properties": { + "Decrypt": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + }, + "DeriveKey": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + }, + "Encrypt": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + }, + "Generate": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + }, + "NoRestrictions": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + }, + "Sign": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + }, + "Unwrap": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + }, + "Verify": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + }, + "Wrap": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "KeyOrigin", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "KeyState", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "KeyUsage", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.PaymentCryptography/KeyProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "ObjectType", + "name": "AWS.PaymentCryptography/KeyProperties", + "properties": { + "Enabled": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + }, + "Exportable": { + "type": { + "$ref": "#/14" + }, + "flags": 1 + }, + "KeyAttributes": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "KeyCheckValueAlgorithm": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "KeyIdentifier": { + "type": { + "$ref": "#/1" + }, + "flags": 18 + }, + "KeyOrigin": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "KeyState": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "Tags": { + "type": { + "$ref": "#/16" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.PaymentCryptography/Key", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/17" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.PaymentCryptography/Key@default", + "scopeType": 0, + "body": { + "$ref": "#/18" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.paymentcryptography/default/types.md b/artifacts/bicep/aws/aws.paymentcryptography/default/types.md new file mode 100644 index 00000000..b6d9ca9d --- /dev/null +++ b/artifacts/bicep/aws/aws.paymentcryptography/default/types.md @@ -0,0 +1,56 @@ +# AWS.PaymentCryptography @ default + +## Resource AWS.PaymentCryptography/Alias@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.PaymentCryptography/AliasProperties](#awspaymentcryptographyaliasproperties) (Required, Identifier): properties of the resource + +## Resource AWS.PaymentCryptography/Key@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.PaymentCryptography/KeyProperties](#awspaymentcryptographykeyproperties) (Required, Identifier): properties of the resource + +## AWS.PaymentCryptography/AliasProperties +### Properties +* **AliasName**: string (Required, Identifier) +* **KeyArn**: string + +## AWS.PaymentCryptography/KeyProperties +### Properties +* **Enabled**: bool +* **Exportable**: bool (Required) +* **KeyAttributes**: [KeyAttributes](#keyattributes) (Required) +* **KeyCheckValueAlgorithm**: string +* **KeyIdentifier**: string (ReadOnly, Identifier) +* **KeyOrigin**: string (ReadOnly) +* **KeyState**: string (ReadOnly) +* **Tags**: [Tag](#tag)[] + +## KeyAttributes +### Properties +* **KeyAlgorithm**: string (Required) +* **KeyClass**: string (Required) +* **KeyModesOfUse**: [KeyModesOfUse](#keymodesofuse) (Required) +* **KeyUsage**: string (Required) + +## KeyModesOfUse +### Properties +* **Decrypt**: bool +* **DeriveKey**: bool +* **Encrypt**: bool +* **Generate**: bool +* **NoRestrictions**: bool +* **Sign**: bool +* **Unwrap**: bool +* **Verify**: bool +* **Wrap**: bool + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string + diff --git a/artifacts/bicep/aws/aws.pcaconnectorad/default/types.json b/artifacts/bicep/aws/aws.pcaconnectorad/default/types.json index 547f8a6b..2bfa118a 100644 --- a/artifacts/bicep/aws/aws.pcaconnectorad/default/types.json +++ b/artifacts/bicep/aws/aws.pcaconnectorad/default/types.json @@ -1 +1,1378 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"Tags","Properties":{}}},{"2":{"Name":"VpcInformation","Properties":{"SecurityGroupIds":{"Type":10,"Flags":1}}}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.PCAConnectorAD/ConnectorProperties","Properties":{"CertificateAuthorityArn":{"Type":4,"Flags":5},"ConnectorArn":{"Type":4,"Flags":18},"DirectoryId":{"Type":4,"Flags":5},"Tags":{"Type":8,"Flags":4},"VpcInformation":{"Type":9,"Flags":5}}}},{"2":{"Name":"AWS.PCAConnectorAD/Connector","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":11,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.PCAConnectorAD/Connector@default","ScopeType":0,"Body":12}},{"2":{"Name":"Tags","Properties":{}}},{"2":{"Name":"AWS.PCAConnectorAD/DirectoryRegistrationProperties","Properties":{"DirectoryId":{"Type":4,"Flags":5},"DirectoryRegistrationArn":{"Type":4,"Flags":18},"Tags":{"Type":14,"Flags":4}}}},{"2":{"Name":"AWS.PCAConnectorAD/DirectoryRegistration","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":15,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.PCAConnectorAD/DirectoryRegistration@default","ScopeType":0,"Body":16}},{"2":{"Name":"ApplicationPolicies","Properties":{"Critical":{"Type":2,"Flags":0},"Policies":{"Type":59,"Flags":1}}}},{"2":{"Name":"ApplicationPolicy","Properties":{}}},{"2":{"Name":"ApplicationPolicyType"}},{"2":{"Name":"CertificateValidity","Properties":{"RenewalPeriod":{"Type":56,"Flags":1},"ValidityPeriod":{"Type":56,"Flags":1}}}},{"2":{"Name":"ClientCompatibilityV2"}},{"2":{"Name":"ClientCompatibilityV3"}},{"2":{"Name":"ClientCompatibilityV4"}},{"2":{"Name":"EnrollmentFlagsV2","Properties":{"EnableKeyReuseOnNtTokenKeysetStorageFull":{"Type":2,"Flags":0},"IncludeSymmetricAlgorithms":{"Type":2,"Flags":0},"NoSecurityExtension":{"Type":2,"Flags":0},"RemoveInvalidCertificateFromPersonalStore":{"Type":2,"Flags":0},"UserInteractionRequired":{"Type":2,"Flags":0}}}},{"2":{"Name":"EnrollmentFlagsV3","Properties":{"EnableKeyReuseOnNtTokenKeysetStorageFull":{"Type":2,"Flags":0},"IncludeSymmetricAlgorithms":{"Type":2,"Flags":0},"NoSecurityExtension":{"Type":2,"Flags":0},"RemoveInvalidCertificateFromPersonalStore":{"Type":2,"Flags":0},"UserInteractionRequired":{"Type":2,"Flags":0}}}},{"2":{"Name":"EnrollmentFlagsV4","Properties":{"EnableKeyReuseOnNtTokenKeysetStorageFull":{"Type":2,"Flags":0},"IncludeSymmetricAlgorithms":{"Type":2,"Flags":0},"NoSecurityExtension":{"Type":2,"Flags":0},"RemoveInvalidCertificateFromPersonalStore":{"Type":2,"Flags":0},"UserInteractionRequired":{"Type":2,"Flags":0}}}},{"2":{"Name":"ExtensionsV2","Properties":{"ApplicationPolicies":{"Type":18,"Flags":0},"KeyUsage":{"Type":36,"Flags":1}}}},{"2":{"Name":"ExtensionsV3","Properties":{"ApplicationPolicies":{"Type":18,"Flags":0},"KeyUsage":{"Type":36,"Flags":1}}}},{"2":{"Name":"ExtensionsV4","Properties":{"ApplicationPolicies":{"Type":18,"Flags":0},"KeyUsage":{"Type":36,"Flags":1}}}},{"2":{"Name":"GeneralFlagsV2","Properties":{"AutoEnrollment":{"Type":2,"Flags":0},"MachineType":{"Type":2,"Flags":0}}}},{"2":{"Name":"GeneralFlagsV3","Properties":{"AutoEnrollment":{"Type":2,"Flags":0},"MachineType":{"Type":2,"Flags":0}}}},{"2":{"Name":"GeneralFlagsV4","Properties":{"AutoEnrollment":{"Type":2,"Flags":0},"MachineType":{"Type":2,"Flags":0}}}},{"2":{"Name":"HashAlgorithm"}},{"2":{"Name":"KeySpec"}},{"2":{"Name":"KeyUsage","Properties":{"Critical":{"Type":2,"Flags":0},"UsageFlags":{"Type":37,"Flags":1}}}},{"2":{"Name":"KeyUsageFlags","Properties":{"DataEncipherment":{"Type":2,"Flags":0},"DigitalSignature":{"Type":2,"Flags":0},"KeyAgreement":{"Type":2,"Flags":0},"KeyEncipherment":{"Type":2,"Flags":0},"NonRepudiation":{"Type":2,"Flags":0}}}},{"2":{"Name":"KeyUsageProperty","Properties":{}}},{"2":{"Name":"KeyUsagePropertyFlags","Properties":{"Decrypt":{"Type":2,"Flags":0},"KeyAgreement":{"Type":2,"Flags":0},"Sign":{"Type":2,"Flags":0}}}},{"2":{"Name":"KeyUsagePropertyType"}},{"2":{"Name":"PrivateKeyAlgorithm"}},{"2":{"Name":"PrivateKeyAttributesV2","Properties":{"CryptoProviders":{"Type":60,"Flags":0},"KeySpec":{"Type":4,"Flags":1},"MinimalKeyLength":{"Type":3,"Flags":1}}}},{"2":{"Name":"PrivateKeyAttributesV3","Properties":{"Algorithm":{"Type":4,"Flags":1},"CryptoProviders":{"Type":61,"Flags":0},"KeySpec":{"Type":4,"Flags":1},"KeyUsageProperty":{"Type":38,"Flags":1},"MinimalKeyLength":{"Type":3,"Flags":1}}}},{"2":{"Name":"PrivateKeyAttributesV4","Properties":{"Algorithm":{"Type":4,"Flags":0},"CryptoProviders":{"Type":62,"Flags":0},"KeySpec":{"Type":4,"Flags":1},"KeyUsageProperty":{"Type":38,"Flags":0},"MinimalKeyLength":{"Type":3,"Flags":1}}}},{"2":{"Name":"PrivateKeyFlagsV2","Properties":{"ClientVersion":{"Type":4,"Flags":1},"ExportableKey":{"Type":2,"Flags":0},"StrongKeyProtectionRequired":{"Type":2,"Flags":0}}}},{"2":{"Name":"PrivateKeyFlagsV3","Properties":{"ClientVersion":{"Type":4,"Flags":1},"ExportableKey":{"Type":2,"Flags":0},"RequireAlternateSignatureAlgorithm":{"Type":2,"Flags":0},"StrongKeyProtectionRequired":{"Type":2,"Flags":0}}}},{"2":{"Name":"PrivateKeyFlagsV4","Properties":{"ClientVersion":{"Type":4,"Flags":1},"ExportableKey":{"Type":2,"Flags":0},"RequireAlternateSignatureAlgorithm":{"Type":2,"Flags":0},"RequireSameKeyRenewal":{"Type":2,"Flags":0},"StrongKeyProtectionRequired":{"Type":2,"Flags":0},"UseLegacyProvider":{"Type":2,"Flags":0}}}},{"2":{"Name":"SubjectNameFlagsV2","Properties":{"RequireCommonName":{"Type":2,"Flags":0},"RequireDirectoryPath":{"Type":2,"Flags":0},"RequireDnsAsCn":{"Type":2,"Flags":0},"RequireEmail":{"Type":2,"Flags":0},"SanRequireDirectoryGuid":{"Type":2,"Flags":0},"SanRequireDns":{"Type":2,"Flags":0},"SanRequireDomainDns":{"Type":2,"Flags":0},"SanRequireEmail":{"Type":2,"Flags":0},"SanRequireSpn":{"Type":2,"Flags":0},"SanRequireUpn":{"Type":2,"Flags":0}}}},{"2":{"Name":"SubjectNameFlagsV3","Properties":{"RequireCommonName":{"Type":2,"Flags":0},"RequireDirectoryPath":{"Type":2,"Flags":0},"RequireDnsAsCn":{"Type":2,"Flags":0},"RequireEmail":{"Type":2,"Flags":0},"SanRequireDirectoryGuid":{"Type":2,"Flags":0},"SanRequireDns":{"Type":2,"Flags":0},"SanRequireDomainDns":{"Type":2,"Flags":0},"SanRequireEmail":{"Type":2,"Flags":0},"SanRequireSpn":{"Type":2,"Flags":0},"SanRequireUpn":{"Type":2,"Flags":0}}}},{"2":{"Name":"SubjectNameFlagsV4","Properties":{"RequireCommonName":{"Type":2,"Flags":0},"RequireDirectoryPath":{"Type":2,"Flags":0},"RequireDnsAsCn":{"Type":2,"Flags":0},"RequireEmail":{"Type":2,"Flags":0},"SanRequireDirectoryGuid":{"Type":2,"Flags":0},"SanRequireDns":{"Type":2,"Flags":0},"SanRequireDomainDns":{"Type":2,"Flags":0},"SanRequireEmail":{"Type":2,"Flags":0},"SanRequireSpn":{"Type":2,"Flags":0},"SanRequireUpn":{"Type":2,"Flags":0}}}},{"2":{"Name":"Tags","Properties":{}}},{"2":{"Name":"TemplateDefinition","Properties":{}}},{"2":{"Name":"TemplateV2","Properties":{"CertificateValidity":{"Type":21,"Flags":1},"EnrollmentFlags":{"Type":25,"Flags":1},"Extensions":{"Type":28,"Flags":1},"GeneralFlags":{"Type":31,"Flags":1},"PrivateKeyAttributes":{"Type":42,"Flags":1},"PrivateKeyFlags":{"Type":45,"Flags":1},"SubjectNameFlags":{"Type":48,"Flags":1},"SupersededTemplates":{"Type":63,"Flags":0}}}},{"2":{"Name":"TemplateV3","Properties":{"CertificateValidity":{"Type":21,"Flags":1},"EnrollmentFlags":{"Type":26,"Flags":1},"Extensions":{"Type":29,"Flags":1},"GeneralFlags":{"Type":32,"Flags":1},"HashAlgorithm":{"Type":4,"Flags":1},"PrivateKeyAttributes":{"Type":43,"Flags":1},"PrivateKeyFlags":{"Type":46,"Flags":1},"SubjectNameFlags":{"Type":49,"Flags":1},"SupersededTemplates":{"Type":64,"Flags":0}}}},{"2":{"Name":"TemplateV4","Properties":{"CertificateValidity":{"Type":21,"Flags":1},"EnrollmentFlags":{"Type":27,"Flags":1},"Extensions":{"Type":30,"Flags":1},"GeneralFlags":{"Type":33,"Flags":1},"HashAlgorithm":{"Type":4,"Flags":0},"PrivateKeyAttributes":{"Type":44,"Flags":1},"PrivateKeyFlags":{"Type":47,"Flags":1},"SubjectNameFlags":{"Type":50,"Flags":1},"SupersededTemplates":{"Type":65,"Flags":0}}}},{"2":{"Name":"ValidityPeriod","Properties":{"Period":{"Type":3,"Flags":1},"PeriodType":{"Type":4,"Flags":1}}}},{"2":{"Name":"ValidityPeriodType"}},{"2":{"Name":"Template_ApplicationPolicy","Properties":{}}},{"3":{"ItemType":58}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.PCAConnectorAD/TemplateProperties","Properties":{"ConnectorArn":{"Type":4,"Flags":5},"Definition":{"Type":52,"Flags":5},"Name":{"Type":4,"Flags":5},"ReenrollAllCertificateHolders":{"Type":2,"Flags":4},"Tags":{"Type":51,"Flags":4},"TemplateArn":{"Type":4,"Flags":18}}}},{"2":{"Name":"AWS.PCAConnectorAD/Template","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":66,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.PCAConnectorAD/Template@default","ScopeType":0,"Body":67}},{"2":{"Name":"AccessRight"}},{"2":{"Name":"AccessRights","Properties":{"AutoEnroll":{"Type":4,"Flags":0},"Enroll":{"Type":4,"Flags":0}}}},{"2":{"Name":"AWS.PCAConnectorAD/TemplateGroupAccessControlEntryProperties","Properties":{"AccessRights":{"Type":70,"Flags":5},"GroupDisplayName":{"Type":4,"Flags":5},"GroupSecurityIdentifier":{"Type":4,"Flags":16},"TemplateArn":{"Type":4,"Flags":16}}}},{"2":{"Name":"AWS.PCAConnectorAD/TemplateGroupAccessControlEntry","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":71,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.PCAConnectorAD/TemplateGroupAccessControlEntry@default","ScopeType":0,"Body":72}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Tags", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "VpcInformation", + "properties": { + "SecurityGroupIds": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.PCAConnectorAD/ConnectorProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.PCAConnectorAD/ConnectorProperties", + "properties": { + "CertificateAuthorityArn": { + "type": { + "$ref": "#/2" + }, + "flags": 5 + }, + "ConnectorArn": { + "type": { + "$ref": "#/2" + }, + "flags": 18 + }, + "DirectoryId": { + "type": { + "$ref": "#/2" + }, + "flags": 5 + }, + "Tags": { + "type": { + "$ref": "#/0" + }, + "flags": 4 + }, + "VpcInformation": { + "type": { + "$ref": "#/1" + }, + "flags": 5 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.PCAConnectorAD/Connector", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.PCAConnectorAD/Connector@default", + "scopeType": 0, + "body": { + "$ref": "#/6" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tags", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.PCAConnectorAD/DirectoryRegistrationProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.PCAConnectorAD/DirectoryRegistrationProperties", + "properties": { + "DirectoryId": { + "type": { + "$ref": "#/2" + }, + "flags": 5 + }, + "DirectoryRegistrationArn": { + "type": { + "$ref": "#/2" + }, + "flags": 18 + }, + "Tags": { + "type": { + "$ref": "#/8" + }, + "flags": 4 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.PCAConnectorAD/DirectoryRegistration", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/10" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.PCAConnectorAD/DirectoryRegistration@default", + "scopeType": 0, + "body": { + "$ref": "#/11" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "ApplicationPolicies", + "properties": { + "Critical": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "Policies": { + "type": { + "$ref": "#/55" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ApplicationPolicy", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ApplicationPolicyType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CertificateValidity", + "properties": { + "RenewalPeriod": { + "type": { + "$ref": "#/51" + }, + "flags": 1 + }, + "ValidityPeriod": { + "type": { + "$ref": "#/51" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ClientCompatibilityV2", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ClientCompatibilityV3", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ClientCompatibilityV4", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "EnrollmentFlagsV2", + "properties": { + "EnableKeyReuseOnNtTokenKeysetStorageFull": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "IncludeSymmetricAlgorithms": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "NoSecurityExtension": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "RemoveInvalidCertificateFromPersonalStore": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "UserInteractionRequired": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "EnrollmentFlagsV3", + "properties": { + "EnableKeyReuseOnNtTokenKeysetStorageFull": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "IncludeSymmetricAlgorithms": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "NoSecurityExtension": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "RemoveInvalidCertificateFromPersonalStore": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "UserInteractionRequired": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "EnrollmentFlagsV4", + "properties": { + "EnableKeyReuseOnNtTokenKeysetStorageFull": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "IncludeSymmetricAlgorithms": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "NoSecurityExtension": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "RemoveInvalidCertificateFromPersonalStore": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "UserInteractionRequired": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ExtensionsV2", + "properties": { + "ApplicationPolicies": { + "type": { + "$ref": "#/13" + }, + "flags": 0 + }, + "KeyUsage": { + "type": { + "$ref": "#/31" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ExtensionsV3", + "properties": { + "ApplicationPolicies": { + "type": { + "$ref": "#/13" + }, + "flags": 0 + }, + "KeyUsage": { + "type": { + "$ref": "#/31" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ExtensionsV4", + "properties": { + "ApplicationPolicies": { + "type": { + "$ref": "#/13" + }, + "flags": 0 + }, + "KeyUsage": { + "type": { + "$ref": "#/31" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "GeneralFlagsV2", + "properties": { + "AutoEnrollment": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "MachineType": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GeneralFlagsV3", + "properties": { + "AutoEnrollment": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "MachineType": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GeneralFlagsV4", + "properties": { + "AutoEnrollment": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "MachineType": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "HashAlgorithm", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "KeySpec", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "KeyUsage", + "properties": { + "Critical": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "UsageFlags": { + "type": { + "$ref": "#/32" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "KeyUsageFlags", + "properties": { + "DataEncipherment": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "DigitalSignature": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "KeyAgreement": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "KeyEncipherment": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "NonRepudiation": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "KeyUsageProperty", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "KeyUsagePropertyFlags", + "properties": { + "Decrypt": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "KeyAgreement": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "Sign": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "KeyUsagePropertyType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PrivateKeyAlgorithm", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PrivateKeyAttributesV2", + "properties": { + "CryptoProviders": { + "type": { + "$ref": "#/56" + }, + "flags": 0 + }, + "KeySpec": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "MinimalKeyLength": { + "type": { + "$ref": "#/57" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "PrivateKeyAttributesV3", + "properties": { + "Algorithm": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "CryptoProviders": { + "type": { + "$ref": "#/58" + }, + "flags": 0 + }, + "KeySpec": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "KeyUsageProperty": { + "type": { + "$ref": "#/33" + }, + "flags": 1 + }, + "MinimalKeyLength": { + "type": { + "$ref": "#/57" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "PrivateKeyAttributesV4", + "properties": { + "Algorithm": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "CryptoProviders": { + "type": { + "$ref": "#/59" + }, + "flags": 0 + }, + "KeySpec": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "KeyUsageProperty": { + "type": { + "$ref": "#/33" + }, + "flags": 0 + }, + "MinimalKeyLength": { + "type": { + "$ref": "#/57" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "PrivateKeyFlagsV2", + "properties": { + "ClientVersion": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "ExportableKey": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "StrongKeyProtectionRequired": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PrivateKeyFlagsV3", + "properties": { + "ClientVersion": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "ExportableKey": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "RequireAlternateSignatureAlgorithm": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "StrongKeyProtectionRequired": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PrivateKeyFlagsV4", + "properties": { + "ClientVersion": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "ExportableKey": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "RequireAlternateSignatureAlgorithm": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "RequireSameKeyRenewal": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "StrongKeyProtectionRequired": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "UseLegacyProvider": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SubjectNameFlagsV2", + "properties": { + "RequireCommonName": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "RequireDirectoryPath": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "RequireDnsAsCn": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "RequireEmail": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "SanRequireDirectoryGuid": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "SanRequireDns": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "SanRequireDomainDns": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "SanRequireEmail": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "SanRequireSpn": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "SanRequireUpn": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SubjectNameFlagsV3", + "properties": { + "RequireCommonName": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "RequireDirectoryPath": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "RequireDnsAsCn": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "RequireEmail": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "SanRequireDirectoryGuid": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "SanRequireDns": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "SanRequireDomainDns": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "SanRequireEmail": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "SanRequireSpn": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "SanRequireUpn": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SubjectNameFlagsV4", + "properties": { + "RequireCommonName": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "RequireDirectoryPath": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "RequireDnsAsCn": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "RequireEmail": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "SanRequireDirectoryGuid": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "SanRequireDns": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "SanRequireDomainDns": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "SanRequireEmail": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "SanRequireSpn": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "SanRequireUpn": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tags", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TemplateDefinition", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TemplateV2", + "properties": { + "CertificateValidity": { + "type": { + "$ref": "#/16" + }, + "flags": 1 + }, + "EnrollmentFlags": { + "type": { + "$ref": "#/20" + }, + "flags": 1 + }, + "Extensions": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + }, + "GeneralFlags": { + "type": { + "$ref": "#/26" + }, + "flags": 1 + }, + "PrivateKeyAttributes": { + "type": { + "$ref": "#/37" + }, + "flags": 1 + }, + "PrivateKeyFlags": { + "type": { + "$ref": "#/40" + }, + "flags": 1 + }, + "SubjectNameFlags": { + "type": { + "$ref": "#/43" + }, + "flags": 1 + }, + "SupersededTemplates": { + "type": { + "$ref": "#/60" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TemplateV3", + "properties": { + "CertificateValidity": { + "type": { + "$ref": "#/16" + }, + "flags": 1 + }, + "EnrollmentFlags": { + "type": { + "$ref": "#/21" + }, + "flags": 1 + }, + "Extensions": { + "type": { + "$ref": "#/24" + }, + "flags": 1 + }, + "GeneralFlags": { + "type": { + "$ref": "#/27" + }, + "flags": 1 + }, + "HashAlgorithm": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "PrivateKeyAttributes": { + "type": { + "$ref": "#/38" + }, + "flags": 1 + }, + "PrivateKeyFlags": { + "type": { + "$ref": "#/41" + }, + "flags": 1 + }, + "SubjectNameFlags": { + "type": { + "$ref": "#/44" + }, + "flags": 1 + }, + "SupersededTemplates": { + "type": { + "$ref": "#/61" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TemplateV4", + "properties": { + "CertificateValidity": { + "type": { + "$ref": "#/16" + }, + "flags": 1 + }, + "EnrollmentFlags": { + "type": { + "$ref": "#/22" + }, + "flags": 1 + }, + "Extensions": { + "type": { + "$ref": "#/25" + }, + "flags": 1 + }, + "GeneralFlags": { + "type": { + "$ref": "#/28" + }, + "flags": 1 + }, + "HashAlgorithm": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "PrivateKeyAttributes": { + "type": { + "$ref": "#/39" + }, + "flags": 1 + }, + "PrivateKeyFlags": { + "type": { + "$ref": "#/42" + }, + "flags": 1 + }, + "SubjectNameFlags": { + "type": { + "$ref": "#/45" + }, + "flags": 1 + }, + "SupersededTemplates": { + "type": { + "$ref": "#/62" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ValidityPeriod", + "properties": { + "Period": { + "type": { + "$ref": "#/57" + }, + "flags": 1 + }, + "PeriodType": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ValidityPeriodType", + "properties": {} + }, + { + "$type": "BooleanType" + }, + { + "$type": "ObjectType", + "name": "Template_ApplicationPolicy", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/54" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.PCAConnectorAD/TemplateProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.PCAConnectorAD/TemplateProperties", + "properties": { + "ConnectorArn": { + "type": { + "$ref": "#/2" + }, + "flags": 5 + }, + "Definition": { + "type": { + "$ref": "#/47" + }, + "flags": 5 + }, + "Name": { + "type": { + "$ref": "#/2" + }, + "flags": 5 + }, + "ReenrollAllCertificateHolders": { + "type": { + "$ref": "#/53" + }, + "flags": 4 + }, + "Tags": { + "type": { + "$ref": "#/46" + }, + "flags": 4 + }, + "TemplateArn": { + "type": { + "$ref": "#/2" + }, + "flags": 18 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.PCAConnectorAD/Template", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/64" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.PCAConnectorAD/Template@default", + "scopeType": 0, + "body": { + "$ref": "#/65" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AccessRight", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AccessRights", + "properties": { + "AutoEnroll": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Enroll": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.PCAConnectorAD/TemplateGroupAccessControlEntryProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.PCAConnectorAD/TemplateGroupAccessControlEntryProperties", + "properties": { + "AccessRights": { + "type": { + "$ref": "#/68" + }, + "flags": 5 + }, + "GroupDisplayName": { + "type": { + "$ref": "#/2" + }, + "flags": 5 + }, + "GroupSecurityIdentifier": { + "type": { + "$ref": "#/2" + }, + "flags": 16 + }, + "TemplateArn": { + "type": { + "$ref": "#/2" + }, + "flags": 16 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.PCAConnectorAD/TemplateGroupAccessControlEntry", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/70" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.PCAConnectorAD/TemplateGroupAccessControlEntry@default", + "scopeType": 0, + "body": { + "$ref": "#/71" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.pcaconnectorad/default/types.md b/artifacts/bicep/aws/aws.pcaconnectorad/default/types.md index 4c635148..aa522df5 100644 --- a/artifacts/bicep/aws/aws.pcaconnectorad/default/types.md +++ b/artifacts/bicep/aws/aws.pcaconnectorad/default/types.md @@ -3,30 +3,35 @@ ## Resource AWS.PCAConnectorAD/Connector@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.PCAConnectorAD/ConnectorProperties](#awspcaconnectoradconnectorproperties) (Required): properties of the resource +* **properties**: [AWS.PCAConnectorAD/ConnectorProperties](#awspcaconnectoradconnectorproperties) (Required, Identifier): properties of the resource ## Resource AWS.PCAConnectorAD/DirectoryRegistration@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.PCAConnectorAD/DirectoryRegistrationProperties](#awspcaconnectoraddirectoryregistrationproperties) (Required): properties of the resource +* **properties**: [AWS.PCAConnectorAD/DirectoryRegistrationProperties](#awspcaconnectoraddirectoryregistrationproperties) (Required, Identifier): properties of the resource ## Resource AWS.PCAConnectorAD/Template@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.PCAConnectorAD/TemplateProperties](#awspcaconnectoradtemplateproperties) (Required): properties of the resource +* **properties**: [AWS.PCAConnectorAD/TemplateProperties](#awspcaconnectoradtemplateproperties) (Required, Identifier): properties of the resource ## Resource AWS.PCAConnectorAD/TemplateGroupAccessControlEntry@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.PCAConnectorAD/TemplateGroupAccessControlEntryProperties](#awspcaconnectoradtemplategroupaccesscontrolentryproperties) (Required): properties of the resource +* **properties**: [AWS.PCAConnectorAD/TemplateGroupAccessControlEntryProperties](#awspcaconnectoradtemplategroupaccesscontrolentryproperties) (Required, Identifier): properties of the resource + +## AccessRights +### Properties +* **AutoEnroll**: string +* **Enroll**: string ## AWS.PCAConnectorAD/ConnectorProperties ### Properties @@ -36,21 +41,18 @@ * **Tags**: [Tags](#tags) (WriteOnly) * **VpcInformation**: [VpcInformation](#vpcinformation) (Required, WriteOnly) -## Tags -### Properties - -## VpcInformation -### Properties -* **SecurityGroupIds**: string[] (Required) - ## AWS.PCAConnectorAD/DirectoryRegistrationProperties ### Properties * **DirectoryId**: string (Required, WriteOnly) * **DirectoryRegistrationArn**: string (ReadOnly, Identifier) * **Tags**: [Tags](#tags) (WriteOnly) -## Tags +## AWS.PCAConnectorAD/TemplateGroupAccessControlEntryProperties ### Properties +* **AccessRights**: [AccessRights](#accessrights) (Required, WriteOnly) +* **GroupDisplayName**: string (Required, WriteOnly) +* **GroupSecurityIdentifier**: string (Identifier) +* **TemplateArn**: string (Identifier) ## AWS.PCAConnectorAD/TemplateProperties ### Properties @@ -61,21 +63,19 @@ * **Tags**: [Tags](#tags) (WriteOnly) * **TemplateArn**: string (ReadOnly, Identifier) -## TemplateDefinition +## Tags ### Properties ## Tags ### Properties -## AWS.PCAConnectorAD/TemplateGroupAccessControlEntryProperties +## Tags ### Properties -* **AccessRights**: [AccessRights](#accessrights) (Required, WriteOnly) -* **GroupDisplayName**: string (Required, WriteOnly) -* **GroupSecurityIdentifier**: string (Identifier) -* **TemplateArn**: string (Identifier) -## AccessRights +## TemplateDefinition ### Properties -* **AutoEnroll**: string -* **Enroll**: string + +## VpcInformation +### Properties +* **SecurityGroupIds**: string[] (Required) diff --git a/artifacts/bicep/aws/aws.personalize/default/types.json b/artifacts/bicep/aws/aws.personalize/default/types.json index a776324a..307044dc 100644 --- a/artifacts/bicep/aws/aws.personalize/default/types.json +++ b/artifacts/bicep/aws/aws.personalize/default/types.json @@ -1 +1,146 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"DatasetImportJob","Properties":{"DataSource":{"Type":9,"Flags":0,"Description":"The Amazon S3 bucket that contains the training data to import."},"DatasetArn":{"Type":4,"Flags":16,"Description":"The ARN of the dataset that receives the imported data"},"DatasetImportJobArn":{"Type":4,"Flags":0,"Description":"The ARN of the dataset import job"},"JobName":{"Type":4,"Flags":0,"Description":"The name for the dataset import job."},"RoleArn":{"Type":4,"Flags":0,"Description":"The ARN of the IAM role that has permissions to read from the Amazon S3 data source."}}}},{"2":{"Name":"Dataset_DataSource","Properties":{"DataLocation":{"Type":4,"Flags":0,"Description":"The path to the Amazon S3 bucket where the data that you want to upload to your dataset is stored."}}}},{"2":{"Name":"AWS.Personalize/DatasetProperties","Properties":{"DatasetArn":{"Type":4,"Flags":18,"Description":"The ARN of the dataset"},"DatasetGroupArn":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) of the dataset group to add the dataset to"},"DatasetImportJob":{"Type":8,"Flags":0},"DatasetType":{"Type":4,"Flags":1,"Description":"The type of dataset"},"Name":{"Type":4,"Flags":1,"Description":"The name for the dataset"},"SchemaArn":{"Type":4,"Flags":1,"Description":"The ARN of the schema to associate with the dataset. The schema defines the dataset fields."}}}},{"2":{"Name":"AWS.Personalize/Dataset","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":10,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Personalize/Dataset@default","ScopeType":0,"Body":11}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "DatasetImportJob", + "properties": { + "DataSource": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The Amazon S3 bucket that contains the training data to import." + }, + "DatasetArn": { + "type": { + "$ref": "#/1" + }, + "flags": 16, + "description": "The ARN of the dataset that receives the imported data" + }, + "DatasetImportJobArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The ARN of the dataset import job" + }, + "JobName": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The name for the dataset import job." + }, + "RoleArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The ARN of the IAM role that has permissions to read from the Amazon S3 data source." + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "ObjectType", + "name": "Dataset_DataSource", + "properties": { + "DataLocation": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The path to the Amazon S3 bucket where the data that you want to upload to your dataset is stored." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Personalize/DatasetProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.Personalize/DatasetProperties", + "properties": { + "DatasetArn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The ARN of the dataset" + }, + "DatasetGroupArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of the dataset group to add the dataset to" + }, + "DatasetImportJob": { + "type": { + "$ref": "#/0" + }, + "flags": 0 + }, + "DatasetType": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The type of dataset" + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The name for the dataset" + }, + "SchemaArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The ARN of the schema to associate with the dataset. The schema defines the dataset fields." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Personalize/Dataset", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Personalize/Dataset@default", + "scopeType": 0, + "body": { + "$ref": "#/5" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.personalize/default/types.md b/artifacts/bicep/aws/aws.personalize/default/types.md index 00cb6629..5cade409 100644 --- a/artifacts/bicep/aws/aws.personalize/default/types.md +++ b/artifacts/bicep/aws/aws.personalize/default/types.md @@ -3,9 +3,9 @@ ## Resource AWS.Personalize/Dataset@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Personalize/DatasetProperties](#awspersonalizedatasetproperties) (Required): properties of the resource +* **properties**: [AWS.Personalize/DatasetProperties](#awspersonalizedatasetproperties) (Required, Identifier): properties of the resource ## AWS.Personalize/DatasetProperties ### Properties @@ -16,6 +16,10 @@ * **Name**: string (Required): The name for the dataset * **SchemaArn**: string (Required): The ARN of the schema to associate with the dataset. The schema defines the dataset fields. +## Dataset_DataSource +### Properties +* **DataLocation**: string: The path to the Amazon S3 bucket where the data that you want to upload to your dataset is stored. + ## DatasetImportJob ### Properties * **DatasetArn**: string (Identifier): The ARN of the dataset that receives the imported data @@ -24,7 +28,3 @@ * **JobName**: string: The name for the dataset import job. * **RoleArn**: string: The ARN of the IAM role that has permissions to read from the Amazon S3 data source. -## Dataset_DataSource -### Properties -* **DataLocation**: string: The path to the Amazon S3 bucket where the data that you want to upload to your dataset is stored. - diff --git a/artifacts/bicep/aws/aws.pinpoint/default/types.json b/artifacts/bicep/aws/aws.pinpoint/default/types.json index 45f2a836..c89aff23 100644 --- a/artifacts/bicep/aws/aws.pinpoint/default/types.json +++ b/artifacts/bicep/aws/aws.pinpoint/default/types.json @@ -1 +1,302 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"Alignment"}},{"2":{"Name":"BodyConfig","Properties":{"Alignment":{"Type":4,"Flags":0},"Body":{"Type":4,"Flags":0},"TextColor":{"Type":4,"Flags":0}}}},{"2":{"Name":"ButtonAction"}},{"2":{"Name":"ButtonConfig","Properties":{"Android":{"Type":15,"Flags":0},"DefaultConfig":{"Type":12,"Flags":0},"IOS":{"Type":15,"Flags":0},"Web":{"Type":15,"Flags":0}}}},{"2":{"Name":"DefaultButtonConfiguration","Properties":{"BackgroundColor":{"Type":4,"Flags":0},"BorderRadius":{"Type":3,"Flags":0},"ButtonAction":{"Type":4,"Flags":0},"Link":{"Type":4,"Flags":0},"Text":{"Type":4,"Flags":0},"TextColor":{"Type":4,"Flags":0}}}},{"2":{"Name":"HeaderConfig","Properties":{"Alignment":{"Type":4,"Flags":0},"Header":{"Type":4,"Flags":0},"TextColor":{"Type":4,"Flags":0}}}},{"2":{"Name":"InAppMessageContent","Properties":{"BackgroundColor":{"Type":4,"Flags":0},"BodyConfig":{"Type":9,"Flags":0},"HeaderConfig":{"Type":13,"Flags":0},"ImageUrl":{"Type":4,"Flags":0},"PrimaryBtn":{"Type":11,"Flags":0},"SecondaryBtn":{"Type":11,"Flags":0}}}},{"2":{"Name":"OverrideButtonConfiguration","Properties":{"ButtonAction":{"Type":4,"Flags":0},"Link":{"Type":4,"Flags":0}}}},{"2":{"Name":"AWS.Pinpoint/InAppTemplateProperties","Properties":{"Arn":{"Type":4,"Flags":2},"Content":{"Type":17,"Flags":0},"CustomConfig":{"Type":18,"Flags":0},"Layout":{"Type":4,"Flags":0},"Tags":{"Type":19,"Flags":0},"TemplateDescription":{"Type":4,"Flags":0},"TemplateName":{"Type":4,"Flags":17}}}},{"3":{"ItemType":14}},{"2":{"Name":"InAppTemplate_CustomConfig","Properties":{}}},{"2":{"Name":"InAppTemplate_Tags","Properties":{}}},{"2":{"Name":"AWS.Pinpoint/InAppTemplate","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":16,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Pinpoint/InAppTemplate@default","ScopeType":0,"Body":20}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Alignment", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "BodyConfig", + "properties": { + "Alignment": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "Body": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "TextColor": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ButtonAction", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ButtonConfig", + "properties": { + "Android": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "DefaultConfig": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "IOS": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "Web": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DefaultButtonConfiguration", + "properties": { + "BackgroundColor": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "BorderRadius": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "ButtonAction": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "Link": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "Text": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "TextColor": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "HeaderConfig", + "properties": { + "Alignment": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "Header": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "TextColor": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "InAppMessageContent", + "properties": { + "BackgroundColor": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "BodyConfig": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "HeaderConfig": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "ImageUrl": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "PrimaryBtn": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "SecondaryBtn": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "OverrideButtonConfiguration", + "properties": { + "ButtonAction": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "Link": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "IntegerType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.Pinpoint/InAppTemplateProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ObjectType", + "name": "InAppTemplate_CustomConfig", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "InAppTemplate_Tags", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AWS.Pinpoint/InAppTemplateProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/8" + }, + "flags": 2 + }, + "Content": { + "type": { + "$ref": "#/11" + }, + "flags": 0 + }, + "CustomConfig": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + }, + "Layout": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/13" + }, + "flags": 0 + }, + "TemplateDescription": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "TemplateName": { + "type": { + "$ref": "#/8" + }, + "flags": 17 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Pinpoint/InAppTemplate", + "properties": { + "name": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/8" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/14" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Pinpoint/InAppTemplate@default", + "scopeType": 0, + "body": { + "$ref": "#/15" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.pinpoint/default/types.md b/artifacts/bicep/aws/aws.pinpoint/default/types.md index f049b2dd..cc62b9ec 100644 --- a/artifacts/bicep/aws/aws.pinpoint/default/types.md +++ b/artifacts/bicep/aws/aws.pinpoint/default/types.md @@ -3,9 +3,9 @@ ## Resource AWS.Pinpoint/InAppTemplate@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Pinpoint/InAppTemplateProperties](#awspinpointinapptemplateproperties) (Required): properties of the resource +* **properties**: [AWS.Pinpoint/InAppTemplateProperties](#awspinpointinapptemplateproperties) (Required, Identifier): properties of the resource ## AWS.Pinpoint/InAppTemplateProperties ### Properties @@ -17,27 +17,12 @@ * **TemplateDescription**: string * **TemplateName**: string (Required, Identifier) -## InAppMessageContent -### Properties -* **BackgroundColor**: string -* **BodyConfig**: [BodyConfig](#bodyconfig) -* **HeaderConfig**: [HeaderConfig](#headerconfig) -* **ImageUrl**: string -* **PrimaryBtn**: [ButtonConfig](#buttonconfig) -* **SecondaryBtn**: [ButtonConfig](#buttonconfig) - ## BodyConfig ### Properties * **Alignment**: string * **Body**: string * **TextColor**: string -## HeaderConfig -### Properties -* **Alignment**: string -* **Header**: string -* **TextColor**: string - ## ButtonConfig ### Properties * **Android**: [OverrideButtonConfiguration](#overridebuttonconfiguration) @@ -45,11 +30,6 @@ * **IOS**: [OverrideButtonConfiguration](#overridebuttonconfiguration) * **Web**: [OverrideButtonConfiguration](#overridebuttonconfiguration) -## OverrideButtonConfiguration -### Properties -* **ButtonAction**: string -* **Link**: string - ## DefaultButtonConfiguration ### Properties * **BackgroundColor**: string @@ -59,9 +39,29 @@ * **Text**: string * **TextColor**: string +## HeaderConfig +### Properties +* **Alignment**: string +* **Header**: string +* **TextColor**: string + +## InAppMessageContent +### Properties +* **BackgroundColor**: string +* **BodyConfig**: [BodyConfig](#bodyconfig) +* **HeaderConfig**: [HeaderConfig](#headerconfig) +* **ImageUrl**: string +* **PrimaryBtn**: [ButtonConfig](#buttonconfig) +* **SecondaryBtn**: [ButtonConfig](#buttonconfig) + ## InAppTemplate_CustomConfig ### Properties ## InAppTemplate_Tags ### Properties +## OverrideButtonConfiguration +### Properties +* **ButtonAction**: string +* **Link**: string + diff --git a/artifacts/bicep/aws/aws.pipes/default/types.json b/artifacts/bicep/aws/aws.pipes/default/types.json index 65133799..18c5e034 100644 --- a/artifacts/bicep/aws/aws.pipes/default/types.json +++ b/artifacts/bicep/aws/aws.pipes/default/types.json @@ -1 +1,2031 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"AssignPublicIp"}},{"2":{"Name":"AwsVpcConfiguration","Properties":{"AssignPublicIp":{"Type":4,"Flags":0},"SecurityGroups":{"Type":85,"Flags":0},"Subnets":{"Type":86,"Flags":1}}}},{"2":{"Name":"BatchArrayProperties","Properties":{"Size":{"Type":3,"Flags":0}}}},{"2":{"Name":"BatchContainerOverrides","Properties":{"Command":{"Type":87,"Flags":0},"Environment":{"Type":88,"Flags":0},"InstanceType":{"Type":4,"Flags":0},"ResourceRequirements":{"Type":89,"Flags":0}}}},{"2":{"Name":"BatchEnvironmentVariable","Properties":{"Name":{"Type":4,"Flags":16},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"BatchJobDependency","Properties":{"JobId":{"Type":4,"Flags":0},"Type":{"Type":4,"Flags":0}}}},{"2":{"Name":"BatchJobDependencyType"}},{"2":{"Name":"BatchParametersMap","Properties":{}}},{"2":{"Name":"BatchResourceRequirement","Properties":{"Type":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"BatchResourceRequirementType"}},{"2":{"Name":"BatchRetryStrategy","Properties":{"Attempts":{"Type":3,"Flags":0}}}},{"2":{"Name":"CapacityProviderStrategyItem","Properties":{"Base":{"Type":3,"Flags":0},"CapacityProvider":{"Type":4,"Flags":1},"Weight":{"Type":3,"Flags":0}}}},{"2":{"Name":"CloudwatchLogsLogDestination","Properties":{"LogGroupArn":{"Type":4,"Flags":0}}}},{"2":{"Name":"DeadLetterConfig","Properties":{"Arn":{"Type":4,"Flags":0}}}},{"2":{"Name":"DynamoDBStreamStartPosition"}},{"2":{"Name":"EcsContainerOverride","Properties":{"Command":{"Type":90,"Flags":0},"Cpu":{"Type":3,"Flags":0},"Environment":{"Type":91,"Flags":0},"EnvironmentFiles":{"Type":92,"Flags":0},"Memory":{"Type":3,"Flags":0},"MemoryReservation":{"Type":3,"Flags":0},"Name":{"Type":4,"Flags":16},"ResourceRequirements":{"Type":93,"Flags":0}}}},{"2":{"Name":"EcsEnvironmentFile","Properties":{"Type":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"EcsEnvironmentFileType"}},{"2":{"Name":"EcsEnvironmentVariable","Properties":{"Name":{"Type":4,"Flags":16},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"EcsEphemeralStorage","Properties":{"SizeInGiB":{"Type":3,"Flags":1}}}},{"2":{"Name":"EcsInferenceAcceleratorOverride","Properties":{"DeviceName":{"Type":4,"Flags":0},"DeviceType":{"Type":4,"Flags":0}}}},{"2":{"Name":"EcsResourceRequirement","Properties":{"Type":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"EcsResourceRequirementType"}},{"2":{"Name":"EcsTaskOverride","Properties":{"ContainerOverrides":{"Type":94,"Flags":0},"Cpu":{"Type":4,"Flags":0},"EphemeralStorage":{"Type":27,"Flags":0},"ExecutionRoleArn":{"Type":4,"Flags":0},"InferenceAcceleratorOverrides":{"Type":95,"Flags":0},"Memory":{"Type":4,"Flags":0},"TaskRoleArn":{"Type":4,"Flags":0}}}},{"2":{"Name":"Filter","Properties":{"Pattern":{"Type":4,"Flags":0}}}},{"2":{"Name":"FilterCriteria","Properties":{"Filters":{"Type":96,"Flags":0}}}},{"2":{"Name":"FirehoseLogDestination","Properties":{"DeliveryStreamArn":{"Type":4,"Flags":0}}}},{"2":{"Name":"HeaderParametersMap","Properties":{}}},{"2":{"Name":"IncludeExecutionDataOption"}},{"2":{"Name":"KinesisStreamStartPosition"}},{"2":{"Name":"LaunchType"}},{"2":{"Name":"LogLevel"}},{"2":{"Name":"MQBrokerAccessCredentials","Properties":{}}},{"2":{"Name":"MSKAccessCredentials","Properties":{}}},{"2":{"Name":"MSKStartPosition"}},{"2":{"Name":"NetworkConfiguration","Properties":{"AwsvpcConfiguration":{"Type":9,"Flags":0}}}},{"2":{"Name":"OnPartialBatchItemFailureStreams"}},{"2":{"Name":"PipeEnrichmentHttpParameters","Properties":{"HeaderParameters":{"Type":35,"Flags":0},"PathParameterValues":{"Type":97,"Flags":0},"QueryStringParameters":{"Type":75,"Flags":0}}}},{"2":{"Name":"PipeEnrichmentParameters","Properties":{"HttpParameters":{"Type":45,"Flags":0},"InputTemplate":{"Type":4,"Flags":0}}}},{"2":{"Name":"PipeLogConfiguration","Properties":{"CloudwatchLogsLogDestination":{"Type":20,"Flags":0},"FirehoseLogDestination":{"Type":34,"Flags":0},"IncludeExecutionData":{"Type":98,"Flags":0},"Level":{"Type":4,"Flags":0},"S3LogDestination":{"Type":77,"Flags":0}}}},{"2":{"Name":"PipeSourceActiveMQBrokerParameters","Properties":{"BatchSize":{"Type":3,"Flags":0},"Credentials":{"Type":40,"Flags":1},"MaximumBatchingWindowInSeconds":{"Type":3,"Flags":0},"QueueName":{"Type":4,"Flags":1}}}},{"2":{"Name":"PipeSourceDynamoDBStreamParameters","Properties":{"BatchSize":{"Type":3,"Flags":0},"DeadLetterConfig":{"Type":21,"Flags":0},"MaximumBatchingWindowInSeconds":{"Type":3,"Flags":0},"MaximumRecordAgeInSeconds":{"Type":3,"Flags":0},"MaximumRetryAttempts":{"Type":3,"Flags":0},"OnPartialBatchItemFailure":{"Type":4,"Flags":0},"ParallelizationFactor":{"Type":3,"Flags":0},"StartingPosition":{"Type":4,"Flags":1}}}},{"2":{"Name":"PipeSourceKinesisStreamParameters","Properties":{"BatchSize":{"Type":3,"Flags":0},"DeadLetterConfig":{"Type":21,"Flags":0},"MaximumBatchingWindowInSeconds":{"Type":3,"Flags":0},"MaximumRecordAgeInSeconds":{"Type":3,"Flags":0},"MaximumRetryAttempts":{"Type":3,"Flags":0},"OnPartialBatchItemFailure":{"Type":4,"Flags":0},"ParallelizationFactor":{"Type":3,"Flags":0},"StartingPosition":{"Type":4,"Flags":1},"StartingPositionTimestamp":{"Type":4,"Flags":0}}}},{"2":{"Name":"PipeSourceManagedStreamingKafkaParameters","Properties":{"BatchSize":{"Type":3,"Flags":0},"ConsumerGroupID":{"Type":4,"Flags":0},"Credentials":{"Type":41,"Flags":0},"MaximumBatchingWindowInSeconds":{"Type":3,"Flags":0},"StartingPosition":{"Type":4,"Flags":0},"TopicName":{"Type":4,"Flags":1}}}},{"2":{"Name":"PipeSourceParameters","Properties":{"ActiveMQBrokerParameters":{"Type":48,"Flags":0},"DynamoDBStreamParameters":{"Type":49,"Flags":0},"FilterCriteria":{"Type":33,"Flags":0},"KinesisStreamParameters":{"Type":50,"Flags":0},"ManagedStreamingKafkaParameters":{"Type":51,"Flags":0},"RabbitMQBrokerParameters":{"Type":53,"Flags":0},"SelfManagedKafkaParameters":{"Type":54,"Flags":0},"SqsQueueParameters":{"Type":55,"Flags":0}}}},{"2":{"Name":"PipeSourceRabbitMQBrokerParameters","Properties":{"BatchSize":{"Type":3,"Flags":0},"Credentials":{"Type":40,"Flags":1},"MaximumBatchingWindowInSeconds":{"Type":3,"Flags":0},"QueueName":{"Type":4,"Flags":1},"VirtualHost":{"Type":4,"Flags":0}}}},{"2":{"Name":"PipeSourceSelfManagedKafkaParameters","Properties":{"AdditionalBootstrapServers":{"Type":99,"Flags":0},"BatchSize":{"Type":3,"Flags":0},"ConsumerGroupID":{"Type":4,"Flags":0},"Credentials":{"Type":100,"Flags":0},"MaximumBatchingWindowInSeconds":{"Type":3,"Flags":0},"ServerRootCaCertificate":{"Type":4,"Flags":0,"Description":"Optional SecretManager ARN which stores the database credentials"},"StartingPosition":{"Type":4,"Flags":0},"TopicName":{"Type":4,"Flags":1},"Vpc":{"Type":81,"Flags":0}}}},{"2":{"Name":"PipeSourceSqsQueueParameters","Properties":{"BatchSize":{"Type":3,"Flags":0},"MaximumBatchingWindowInSeconds":{"Type":3,"Flags":0}}}},{"2":{"Name":"PipeState"}},{"2":{"Name":"PipeTargetBatchJobParameters","Properties":{"ArrayProperties":{"Type":10,"Flags":0},"ContainerOverrides":{"Type":11,"Flags":0},"DependsOn":{"Type":101,"Flags":0},"JobDefinition":{"Type":4,"Flags":1},"JobName":{"Type":4,"Flags":1},"Parameters":{"Type":15,"Flags":0},"RetryStrategy":{"Type":18,"Flags":0}}}},{"2":{"Name":"PipeTargetCloudWatchLogsParameters","Properties":{"LogStreamName":{"Type":4,"Flags":0},"Timestamp":{"Type":4,"Flags":0}}}},{"2":{"Name":"PipeTargetEcsTaskParameters","Properties":{"CapacityProviderStrategy":{"Type":102,"Flags":0},"EnableECSManagedTags":{"Type":2,"Flags":0},"EnableExecuteCommand":{"Type":2,"Flags":0},"Group":{"Type":4,"Flags":0},"LaunchType":{"Type":4,"Flags":0},"NetworkConfiguration":{"Type":43,"Flags":0},"Overrides":{"Type":31,"Flags":0},"PlacementConstraints":{"Type":103,"Flags":0},"PlacementStrategy":{"Type":104,"Flags":0},"PlatformVersion":{"Type":4,"Flags":0},"PropagateTags":{"Type":4,"Flags":0},"ReferenceId":{"Type":4,"Flags":0},"Tags":{"Type":105,"Flags":0},"TaskCount":{"Type":3,"Flags":0},"TaskDefinitionArn":{"Type":4,"Flags":1}}}},{"2":{"Name":"PipeTargetEventBridgeEventBusParameters","Properties":{"DetailType":{"Type":4,"Flags":0},"EndpointId":{"Type":4,"Flags":0},"Resources":{"Type":106,"Flags":0},"Source":{"Type":4,"Flags":0},"Time":{"Type":4,"Flags":0}}}},{"2":{"Name":"PipeTargetHttpParameters","Properties":{"HeaderParameters":{"Type":35,"Flags":0},"PathParameterValues":{"Type":107,"Flags":0},"QueryStringParameters":{"Type":75,"Flags":0}}}},{"2":{"Name":"PipeTargetInvocationType"}},{"2":{"Name":"PipeTargetKinesisStreamParameters","Properties":{"PartitionKey":{"Type":4,"Flags":1}}}},{"2":{"Name":"PipeTargetLambdaFunctionParameters","Properties":{"InvocationType":{"Type":4,"Flags":0}}}},{"2":{"Name":"PipeTargetParameters","Properties":{"BatchJobParameters":{"Type":57,"Flags":0},"CloudWatchLogsParameters":{"Type":58,"Flags":0},"EcsTaskParameters":{"Type":59,"Flags":0},"EventBridgeEventBusParameters":{"Type":60,"Flags":0},"HttpParameters":{"Type":61,"Flags":0},"InputTemplate":{"Type":4,"Flags":0},"KinesisStreamParameters":{"Type":63,"Flags":0},"LambdaFunctionParameters":{"Type":64,"Flags":0},"RedshiftDataParameters":{"Type":66,"Flags":0},"SageMakerPipelineParameters":{"Type":67,"Flags":0},"SqsQueueParameters":{"Type":68,"Flags":0},"StepFunctionStateMachineParameters":{"Type":69,"Flags":0}}}},{"2":{"Name":"PipeTargetRedshiftDataParameters","Properties":{"Database":{"Type":4,"Flags":1,"Description":"Redshift Database"},"DbUser":{"Type":4,"Flags":0,"Description":"Database user name"},"SecretManagerArn":{"Type":4,"Flags":0,"Description":"Optional SecretManager ARN which stores the database credentials"},"Sqls":{"Type":108,"Flags":1,"Description":"A list of SQLs."},"StatementName":{"Type":4,"Flags":0,"Description":"A name for Redshift DataAPI statement which can be used as filter of ListStatement."},"WithEvent":{"Type":2,"Flags":0}}}},{"2":{"Name":"PipeTargetSageMakerPipelineParameters","Properties":{"PipelineParameterList":{"Type":109,"Flags":0}}}},{"2":{"Name":"PipeTargetSqsQueueParameters","Properties":{"MessageDeduplicationId":{"Type":4,"Flags":0},"MessageGroupId":{"Type":4,"Flags":0}}}},{"2":{"Name":"PipeTargetStateMachineParameters","Properties":{"InvocationType":{"Type":4,"Flags":0}}}},{"2":{"Name":"PlacementConstraint","Properties":{"Expression":{"Type":4,"Flags":0},"Type":{"Type":4,"Flags":0}}}},{"2":{"Name":"PlacementConstraintType"}},{"2":{"Name":"PlacementStrategy","Properties":{"Field":{"Type":4,"Flags":0},"Type":{"Type":4,"Flags":0}}}},{"2":{"Name":"PlacementStrategyType"}},{"2":{"Name":"PropagateTags"}},{"2":{"Name":"QueryStringParametersMap","Properties":{}}},{"2":{"Name":"RequestedPipeState"}},{"2":{"Name":"S3LogDestination","Properties":{"BucketName":{"Type":4,"Flags":0},"BucketOwner":{"Type":4,"Flags":0},"OutputFormat":{"Type":4,"Flags":0},"Prefix":{"Type":4,"Flags":0}}}},{"2":{"Name":"S3OutputFormat"}},{"2":{"Name":"SageMakerPipelineParameter","Properties":{"Name":{"Type":4,"Flags":17},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"SelfManagedKafkaAccessConfigurationCredentials","Properties":{}}},{"2":{"Name":"SelfManagedKafkaAccessConfigurationVpc","Properties":{"SecurityGroup":{"Type":110,"Flags":0,"Description":"List of SecurityGroupId."},"Subnets":{"Type":111,"Flags":0,"Description":"List of SubnetId."}}}},{"2":{"Name":"SelfManagedKafkaStartPosition"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"TagMap","Properties":{}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":12}},{"3":{"ItemType":16}},{"3":{"ItemType":4}},{"3":{"ItemType":26}},{"3":{"ItemType":24}},{"3":{"ItemType":29}},{"3":{"ItemType":23}},{"3":{"ItemType":28}},{"3":{"ItemType":32}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"Pipe_SelfManagedKafkaAccessConfigurationCredentials","Properties":{}}},{"3":{"ItemType":13}},{"3":{"ItemType":19}},{"3":{"ItemType":70}},{"3":{"ItemType":72}},{"3":{"ItemType":83}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":79}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.Pipes/PipeProperties","Properties":{"Arn":{"Type":4,"Flags":2},"CreationTime":{"Type":4,"Flags":2},"CurrentState":{"Type":4,"Flags":2},"Description":{"Type":4,"Flags":0},"DesiredState":{"Type":4,"Flags":0},"Enrichment":{"Type":4,"Flags":0},"EnrichmentParameters":{"Type":46,"Flags":0},"LastModifiedTime":{"Type":4,"Flags":2},"LogConfiguration":{"Type":47,"Flags":0},"Name":{"Type":4,"Flags":16},"RoleArn":{"Type":4,"Flags":1},"Source":{"Type":4,"Flags":1},"SourceParameters":{"Type":52,"Flags":4},"StateReason":{"Type":4,"Flags":2},"Tags":{"Type":84,"Flags":0},"Target":{"Type":4,"Flags":1},"TargetParameters":{"Type":65,"Flags":4}}}},{"2":{"Name":"AWS.Pipes/Pipe","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":112,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Pipes/Pipe@default","ScopeType":0,"Body":113}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "AssignPublicIp", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AwsVpcConfiguration", + "properties": { + "AssignPublicIp": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + }, + "SecurityGroups": { + "type": { + "$ref": "#/87" + }, + "flags": 0 + }, + "Subnets": { + "type": { + "$ref": "#/88" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "BatchArrayProperties", + "properties": { + "Size": { + "type": { + "$ref": "#/89" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BatchContainerOverrides", + "properties": { + "Command": { + "type": { + "$ref": "#/90" + }, + "flags": 0 + }, + "Environment": { + "type": { + "$ref": "#/91" + }, + "flags": 0 + }, + "InstanceType": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + }, + "ResourceRequirements": { + "type": { + "$ref": "#/92" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BatchEnvironmentVariable", + "properties": { + "Name": { + "type": { + "$ref": "#/86" + }, + "flags": 16 + }, + "Value": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BatchJobDependency", + "properties": { + "JobId": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BatchJobDependencyType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "BatchParametersMap", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "BatchResourceRequirement", + "properties": { + "Type": { + "type": { + "$ref": "#/86" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/86" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "BatchResourceRequirementType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "BatchRetryStrategy", + "properties": { + "Attempts": { + "type": { + "$ref": "#/89" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CapacityProviderStrategyItem", + "properties": { + "Base": { + "type": { + "$ref": "#/89" + }, + "flags": 0 + }, + "CapacityProvider": { + "type": { + "$ref": "#/86" + }, + "flags": 1 + }, + "Weight": { + "type": { + "$ref": "#/89" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CloudwatchLogsLogDestination", + "properties": { + "LogGroupArn": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DeadLetterConfig", + "properties": { + "Arn": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DimensionMapping", + "properties": { + "DimensionName": { + "type": { + "$ref": "#/86" + }, + "flags": 1 + }, + "DimensionValue": { + "type": { + "$ref": "#/86" + }, + "flags": 1 + }, + "DimensionValueType": { + "type": { + "$ref": "#/86" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DimensionValueType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DynamoDBStreamStartPosition", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "EcsContainerOverride", + "properties": { + "Command": { + "type": { + "$ref": "#/93" + }, + "flags": 0 + }, + "Cpu": { + "type": { + "$ref": "#/89" + }, + "flags": 0 + }, + "Environment": { + "type": { + "$ref": "#/94" + }, + "flags": 0 + }, + "EnvironmentFiles": { + "type": { + "$ref": "#/95" + }, + "flags": 0 + }, + "Memory": { + "type": { + "$ref": "#/89" + }, + "flags": 0 + }, + "MemoryReservation": { + "type": { + "$ref": "#/89" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/86" + }, + "flags": 16 + }, + "ResourceRequirements": { + "type": { + "$ref": "#/96" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "EcsEnvironmentFile", + "properties": { + "Type": { + "type": { + "$ref": "#/86" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/86" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "EcsEnvironmentFileType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "EcsEnvironmentVariable", + "properties": { + "Name": { + "type": { + "$ref": "#/86" + }, + "flags": 16 + }, + "Value": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "EcsEphemeralStorage", + "properties": { + "SizeInGiB": { + "type": { + "$ref": "#/89" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "EcsInferenceAcceleratorOverride", + "properties": { + "DeviceName": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + }, + "DeviceType": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "EcsResourceRequirement", + "properties": { + "Type": { + "type": { + "$ref": "#/86" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/86" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "EcsResourceRequirementType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "EcsTaskOverride", + "properties": { + "ContainerOverrides": { + "type": { + "$ref": "#/97" + }, + "flags": 0 + }, + "Cpu": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + }, + "EphemeralStorage": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "ExecutionRoleArn": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + }, + "InferenceAcceleratorOverrides": { + "type": { + "$ref": "#/98" + }, + "flags": 0 + }, + "Memory": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + }, + "TaskRoleArn": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "EpochTimeUnit", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Filter", + "properties": { + "Pattern": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FilterCriteria", + "properties": { + "Filters": { + "type": { + "$ref": "#/99" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FirehoseLogDestination", + "properties": { + "DeliveryStreamArn": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "HeaderParametersMap", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "IncludeExecutionDataOption", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "KinesisStreamStartPosition", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LaunchType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LogLevel", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MQBrokerAccessCredentials", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MSKAccessCredentials", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MSKStartPosition", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MeasureValueType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MultiMeasureAttributeMapping", + "properties": { + "MeasureValue": { + "type": { + "$ref": "#/86" + }, + "flags": 1 + }, + "MeasureValueType": { + "type": { + "$ref": "#/86" + }, + "flags": 1 + }, + "MultiMeasureAttributeName": { + "type": { + "$ref": "#/86" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "MultiMeasureMapping", + "properties": { + "MultiMeasureAttributeMappings": { + "type": { + "$ref": "#/100" + }, + "flags": 1 + }, + "MultiMeasureName": { + "type": { + "$ref": "#/86" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "NetworkConfiguration", + "properties": { + "AwsvpcConfiguration": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "OnPartialBatchItemFailureStreams", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PipeEnrichmentHttpParameters", + "properties": { + "HeaderParameters": { + "type": { + "$ref": "#/30" + }, + "flags": 0 + }, + "PathParameterValues": { + "type": { + "$ref": "#/101" + }, + "flags": 0 + }, + "QueryStringParameters": { + "type": { + "$ref": "#/74" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PipeEnrichmentParameters", + "properties": { + "HttpParameters": { + "type": { + "$ref": "#/43" + }, + "flags": 0 + }, + "InputTemplate": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PipeLogConfiguration", + "properties": { + "CloudwatchLogsLogDestination": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + }, + "FirehoseLogDestination": { + "type": { + "$ref": "#/29" + }, + "flags": 0 + }, + "IncludeExecutionData": { + "type": { + "$ref": "#/102" + }, + "flags": 0 + }, + "Level": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + }, + "S3LogDestination": { + "type": { + "$ref": "#/76" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PipeSourceActiveMQBrokerParameters", + "properties": { + "BatchSize": { + "type": { + "$ref": "#/89" + }, + "flags": 0 + }, + "Credentials": { + "type": { + "$ref": "#/35" + }, + "flags": 1 + }, + "MaximumBatchingWindowInSeconds": { + "type": { + "$ref": "#/89" + }, + "flags": 0 + }, + "QueueName": { + "type": { + "$ref": "#/86" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "PipeSourceDynamoDBStreamParameters", + "properties": { + "BatchSize": { + "type": { + "$ref": "#/89" + }, + "flags": 0 + }, + "DeadLetterConfig": { + "type": { + "$ref": "#/13" + }, + "flags": 0 + }, + "MaximumBatchingWindowInSeconds": { + "type": { + "$ref": "#/89" + }, + "flags": 0 + }, + "MaximumRecordAgeInSeconds": { + "type": { + "$ref": "#/89" + }, + "flags": 0 + }, + "MaximumRetryAttempts": { + "type": { + "$ref": "#/89" + }, + "flags": 0 + }, + "OnPartialBatchItemFailure": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + }, + "ParallelizationFactor": { + "type": { + "$ref": "#/89" + }, + "flags": 0 + }, + "StartingPosition": { + "type": { + "$ref": "#/86" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "PipeSourceKinesisStreamParameters", + "properties": { + "BatchSize": { + "type": { + "$ref": "#/89" + }, + "flags": 0 + }, + "DeadLetterConfig": { + "type": { + "$ref": "#/13" + }, + "flags": 0 + }, + "MaximumBatchingWindowInSeconds": { + "type": { + "$ref": "#/89" + }, + "flags": 0 + }, + "MaximumRecordAgeInSeconds": { + "type": { + "$ref": "#/89" + }, + "flags": 0 + }, + "MaximumRetryAttempts": { + "type": { + "$ref": "#/89" + }, + "flags": 0 + }, + "OnPartialBatchItemFailure": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + }, + "ParallelizationFactor": { + "type": { + "$ref": "#/89" + }, + "flags": 0 + }, + "StartingPosition": { + "type": { + "$ref": "#/86" + }, + "flags": 1 + }, + "StartingPositionTimestamp": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PipeSourceManagedStreamingKafkaParameters", + "properties": { + "BatchSize": { + "type": { + "$ref": "#/89" + }, + "flags": 0 + }, + "ConsumerGroupID": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + }, + "Credentials": { + "type": { + "$ref": "#/36" + }, + "flags": 0 + }, + "MaximumBatchingWindowInSeconds": { + "type": { + "$ref": "#/89" + }, + "flags": 0 + }, + "StartingPosition": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + }, + "TopicName": { + "type": { + "$ref": "#/86" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "PipeSourceParameters", + "properties": { + "ActiveMQBrokerParameters": { + "type": { + "$ref": "#/46" + }, + "flags": 0 + }, + "DynamoDBStreamParameters": { + "type": { + "$ref": "#/47" + }, + "flags": 0 + }, + "FilterCriteria": { + "type": { + "$ref": "#/28" + }, + "flags": 0 + }, + "KinesisStreamParameters": { + "type": { + "$ref": "#/48" + }, + "flags": 0 + }, + "ManagedStreamingKafkaParameters": { + "type": { + "$ref": "#/49" + }, + "flags": 0 + }, + "RabbitMQBrokerParameters": { + "type": { + "$ref": "#/51" + }, + "flags": 0 + }, + "SelfManagedKafkaParameters": { + "type": { + "$ref": "#/52" + }, + "flags": 0 + }, + "SqsQueueParameters": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PipeSourceRabbitMQBrokerParameters", + "properties": { + "BatchSize": { + "type": { + "$ref": "#/89" + }, + "flags": 0 + }, + "Credentials": { + "type": { + "$ref": "#/35" + }, + "flags": 1 + }, + "MaximumBatchingWindowInSeconds": { + "type": { + "$ref": "#/89" + }, + "flags": 0 + }, + "QueueName": { + "type": { + "$ref": "#/86" + }, + "flags": 1 + }, + "VirtualHost": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PipeSourceSelfManagedKafkaParameters", + "properties": { + "AdditionalBootstrapServers": { + "type": { + "$ref": "#/103" + }, + "flags": 0 + }, + "BatchSize": { + "type": { + "$ref": "#/89" + }, + "flags": 0 + }, + "ConsumerGroupID": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + }, + "Credentials": { + "type": { + "$ref": "#/104" + }, + "flags": 0 + }, + "MaximumBatchingWindowInSeconds": { + "type": { + "$ref": "#/89" + }, + "flags": 0 + }, + "ServerRootCaCertificate": { + "type": { + "$ref": "#/86" + }, + "flags": 0, + "description": "Optional SecretManager ARN which stores the database credentials" + }, + "StartingPosition": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + }, + "TopicName": { + "type": { + "$ref": "#/86" + }, + "flags": 1 + }, + "Vpc": { + "type": { + "$ref": "#/80" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PipeSourceSqsQueueParameters", + "properties": { + "BatchSize": { + "type": { + "$ref": "#/89" + }, + "flags": 0 + }, + "MaximumBatchingWindowInSeconds": { + "type": { + "$ref": "#/89" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PipeState", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PipeTargetBatchJobParameters", + "properties": { + "ArrayProperties": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "ContainerOverrides": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "DependsOn": { + "type": { + "$ref": "#/105" + }, + "flags": 0 + }, + "JobDefinition": { + "type": { + "$ref": "#/86" + }, + "flags": 1 + }, + "JobName": { + "type": { + "$ref": "#/86" + }, + "flags": 1 + }, + "Parameters": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "RetryStrategy": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PipeTargetCloudWatchLogsParameters", + "properties": { + "LogStreamName": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + }, + "Timestamp": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PipeTargetEcsTaskParameters", + "properties": { + "CapacityProviderStrategy": { + "type": { + "$ref": "#/106" + }, + "flags": 0 + }, + "EnableECSManagedTags": { + "type": { + "$ref": "#/107" + }, + "flags": 0 + }, + "EnableExecuteCommand": { + "type": { + "$ref": "#/107" + }, + "flags": 0 + }, + "Group": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + }, + "LaunchType": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + }, + "NetworkConfiguration": { + "type": { + "$ref": "#/41" + }, + "flags": 0 + }, + "Overrides": { + "type": { + "$ref": "#/25" + }, + "flags": 0 + }, + "PlacementConstraints": { + "type": { + "$ref": "#/108" + }, + "flags": 0 + }, + "PlacementStrategy": { + "type": { + "$ref": "#/109" + }, + "flags": 0 + }, + "PlatformVersion": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + }, + "PropagateTags": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + }, + "ReferenceId": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/110" + }, + "flags": 0 + }, + "TaskCount": { + "type": { + "$ref": "#/89" + }, + "flags": 0 + }, + "TaskDefinitionArn": { + "type": { + "$ref": "#/86" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "PipeTargetEventBridgeEventBusParameters", + "properties": { + "DetailType": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + }, + "EndpointId": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + }, + "Resources": { + "type": { + "$ref": "#/111" + }, + "flags": 0 + }, + "Source": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + }, + "Time": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PipeTargetHttpParameters", + "properties": { + "HeaderParameters": { + "type": { + "$ref": "#/30" + }, + "flags": 0 + }, + "PathParameterValues": { + "type": { + "$ref": "#/112" + }, + "flags": 0 + }, + "QueryStringParameters": { + "type": { + "$ref": "#/74" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PipeTargetInvocationType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PipeTargetKinesisStreamParameters", + "properties": { + "PartitionKey": { + "type": { + "$ref": "#/86" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "PipeTargetLambdaFunctionParameters", + "properties": { + "InvocationType": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PipeTargetParameters", + "properties": { + "BatchJobParameters": { + "type": { + "$ref": "#/55" + }, + "flags": 0 + }, + "CloudWatchLogsParameters": { + "type": { + "$ref": "#/56" + }, + "flags": 0 + }, + "EcsTaskParameters": { + "type": { + "$ref": "#/57" + }, + "flags": 0 + }, + "EventBridgeEventBusParameters": { + "type": { + "$ref": "#/58" + }, + "flags": 0 + }, + "HttpParameters": { + "type": { + "$ref": "#/59" + }, + "flags": 0 + }, + "InputTemplate": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + }, + "KinesisStreamParameters": { + "type": { + "$ref": "#/61" + }, + "flags": 0 + }, + "LambdaFunctionParameters": { + "type": { + "$ref": "#/62" + }, + "flags": 0 + }, + "RedshiftDataParameters": { + "type": { + "$ref": "#/64" + }, + "flags": 0 + }, + "SageMakerPipelineParameters": { + "type": { + "$ref": "#/65" + }, + "flags": 0 + }, + "SqsQueueParameters": { + "type": { + "$ref": "#/66" + }, + "flags": 0 + }, + "StepFunctionStateMachineParameters": { + "type": { + "$ref": "#/67" + }, + "flags": 0 + }, + "TimestreamParameters": { + "type": { + "$ref": "#/68" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PipeTargetRedshiftDataParameters", + "properties": { + "Database": { + "type": { + "$ref": "#/86" + }, + "flags": 1, + "description": "Redshift Database" + }, + "DbUser": { + "type": { + "$ref": "#/86" + }, + "flags": 0, + "description": "Database user name" + }, + "SecretManagerArn": { + "type": { + "$ref": "#/86" + }, + "flags": 0, + "description": "Optional SecretManager ARN which stores the database credentials" + }, + "Sqls": { + "type": { + "$ref": "#/113" + }, + "flags": 1, + "description": "A list of SQLs." + }, + "StatementName": { + "type": { + "$ref": "#/86" + }, + "flags": 0, + "description": "A name for Redshift DataAPI statement which can be used as filter of ListStatement." + }, + "WithEvent": { + "type": { + "$ref": "#/107" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PipeTargetSageMakerPipelineParameters", + "properties": { + "PipelineParameterList": { + "type": { + "$ref": "#/114" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PipeTargetSqsQueueParameters", + "properties": { + "MessageDeduplicationId": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + }, + "MessageGroupId": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PipeTargetStateMachineParameters", + "properties": { + "InvocationType": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PipeTargetTimestreamParameters", + "properties": { + "DimensionMappings": { + "type": { + "$ref": "#/115" + }, + "flags": 1 + }, + "EpochTimeUnit": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + }, + "MultiMeasureMappings": { + "type": { + "$ref": "#/116" + }, + "flags": 0 + }, + "SingleMeasureMappings": { + "type": { + "$ref": "#/117" + }, + "flags": 0 + }, + "TimeFieldType": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + }, + "TimeValue": { + "type": { + "$ref": "#/86" + }, + "flags": 1 + }, + "TimestampFormat": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + }, + "VersionValue": { + "type": { + "$ref": "#/86" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "PlacementConstraint", + "properties": { + "Expression": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PlacementConstraintType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PlacementStrategy", + "properties": { + "Field": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PlacementStrategyType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PropagateTags", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "QueryStringParametersMap", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RequestedPipeState", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "S3LogDestination", + "properties": { + "BucketName": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + }, + "BucketOwner": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + }, + "OutputFormat": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + }, + "Prefix": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "S3OutputFormat", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SageMakerPipelineParameter", + "properties": { + "Name": { + "type": { + "$ref": "#/86" + }, + "flags": 17 + }, + "Value": { + "type": { + "$ref": "#/86" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "SelfManagedKafkaAccessConfigurationCredentials", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SelfManagedKafkaAccessConfigurationVpc", + "properties": { + "SecurityGroup": { + "type": { + "$ref": "#/118" + }, + "flags": 0, + "description": "List of SecurityGroupId." + }, + "Subnets": { + "type": { + "$ref": "#/119" + }, + "flags": 0, + "description": "List of SubnetId." + } + } + }, + { + "$type": "ObjectType", + "name": "SelfManagedKafkaStartPosition", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SingleMeasureMapping", + "properties": { + "MeasureName": { + "type": { + "$ref": "#/86" + }, + "flags": 1 + }, + "MeasureValue": { + "type": { + "$ref": "#/86" + }, + "flags": 1 + }, + "MeasureValueType": { + "type": { + "$ref": "#/86" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/86" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/86" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TagMap", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TimeFieldType", + "properties": {} + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/86" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/86" + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/86" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/8" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/86" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/20" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/18" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/23" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/17" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/22" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/27" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/39" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/86" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/86" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/86" + } + }, + { + "$type": "ObjectType", + "name": "Pipe_SelfManagedKafkaAccessConfigurationCredentials", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/11" + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/69" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/71" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/83" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/86" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/86" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/86" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/78" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/14" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/40" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/82" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/86" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/86" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Pipes/PipeProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.Pipes/PipeProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/86" + }, + "flags": 2 + }, + "CreationTime": { + "type": { + "$ref": "#/86" + }, + "flags": 2 + }, + "CurrentState": { + "type": { + "$ref": "#/86" + }, + "flags": 2 + }, + "Description": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + }, + "DesiredState": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + }, + "Enrichment": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + }, + "EnrichmentParameters": { + "type": { + "$ref": "#/44" + }, + "flags": 0 + }, + "LastModifiedTime": { + "type": { + "$ref": "#/86" + }, + "flags": 2 + }, + "LogConfiguration": { + "type": { + "$ref": "#/45" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/86" + }, + "flags": 16 + }, + "RoleArn": { + "type": { + "$ref": "#/86" + }, + "flags": 1 + }, + "Source": { + "type": { + "$ref": "#/86" + }, + "flags": 1 + }, + "SourceParameters": { + "type": { + "$ref": "#/50" + }, + "flags": 4 + }, + "StateReason": { + "type": { + "$ref": "#/86" + }, + "flags": 2 + }, + "Tags": { + "type": { + "$ref": "#/84" + }, + "flags": 0 + }, + "Target": { + "type": { + "$ref": "#/86" + }, + "flags": 1 + }, + "TargetParameters": { + "type": { + "$ref": "#/63" + }, + "flags": 4 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Pipes/Pipe", + "properties": { + "name": { + "type": { + "$ref": "#/86" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/86" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/121" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Pipes/Pipe@default", + "scopeType": 0, + "body": { + "$ref": "#/122" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.pipes/default/types.md b/artifacts/bicep/aws/aws.pipes/default/types.md index 857c9139..03d98837 100644 --- a/artifacts/bicep/aws/aws.pipes/default/types.md +++ b/artifacts/bicep/aws/aws.pipes/default/types.md @@ -3,9 +3,9 @@ ## Resource AWS.Pipes/Pipe@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Pipes/PipeProperties](#awspipespipeproperties) (Required): properties of the resource +* **properties**: [AWS.Pipes/PipeProperties](#awspipespipeproperties) (Required, Identifier): properties of the resource ## AWS.Pipes/PipeProperties ### Properties @@ -27,56 +27,167 @@ * **Target**: string (Required) * **TargetParameters**: [PipeTargetParameters](#pipetargetparameters) (WriteOnly) -## PipeEnrichmentParameters +## AwsVpcConfiguration ### Properties -* **HttpParameters**: [PipeEnrichmentHttpParameters](#pipeenrichmenthttpparameters) -* **InputTemplate**: string +* **AssignPublicIp**: string +* **SecurityGroups**: string[] +* **Subnets**: string[] (Required) -## PipeEnrichmentHttpParameters +## BatchArrayProperties ### Properties -* **HeaderParameters**: [HeaderParametersMap](#headerparametersmap) -* **PathParameterValues**: string[] -* **QueryStringParameters**: [QueryStringParametersMap](#querystringparametersmap) +* **Size**: int -## HeaderParametersMap +## BatchContainerOverrides ### Properties +* **Command**: string[] +* **Environment**: [BatchEnvironmentVariable](#batchenvironmentvariable)[] +* **InstanceType**: string +* **ResourceRequirements**: [BatchResourceRequirement](#batchresourcerequirement)[] -## QueryStringParametersMap +## BatchEnvironmentVariable ### Properties +* **Name**: string (Identifier) +* **Value**: string -## PipeLogConfiguration +## BatchJobDependency ### Properties -* **CloudwatchLogsLogDestination**: [CloudwatchLogsLogDestination](#cloudwatchlogslogdestination) -* **FirehoseLogDestination**: [FirehoseLogDestination](#firehoselogdestination) -* **IncludeExecutionData**: string[] -* **Level**: string -* **S3LogDestination**: [S3LogDestination](#s3logdestination) +* **JobId**: string +* **Type**: string + +## BatchParametersMap +### Properties + +## BatchResourceRequirement +### Properties +* **Type**: string (Required) +* **Value**: string (Required) + +## BatchRetryStrategy +### Properties +* **Attempts**: int + +## CapacityProviderStrategyItem +### Properties +* **Base**: int +* **CapacityProvider**: string (Required) +* **Weight**: int ## CloudwatchLogsLogDestination ### Properties * **LogGroupArn**: string +## DeadLetterConfig +### Properties +* **Arn**: string + +## DimensionMapping +### Properties +* **DimensionName**: string (Required) +* **DimensionValue**: string (Required) +* **DimensionValueType**: string (Required) + +## EcsContainerOverride +### Properties +* **Command**: string[] +* **Cpu**: int +* **Environment**: [EcsEnvironmentVariable](#ecsenvironmentvariable)[] +* **EnvironmentFiles**: [EcsEnvironmentFile](#ecsenvironmentfile)[] +* **Memory**: int +* **MemoryReservation**: int +* **Name**: string (Identifier) +* **ResourceRequirements**: [EcsResourceRequirement](#ecsresourcerequirement)[] + +## EcsEnvironmentFile +### Properties +* **Type**: string (Required) +* **Value**: string (Required) + +## EcsEnvironmentVariable +### Properties +* **Name**: string (Identifier) +* **Value**: string + +## EcsEphemeralStorage +### Properties +* **SizeInGiB**: int (Required) + +## EcsInferenceAcceleratorOverride +### Properties +* **DeviceName**: string +* **DeviceType**: string + +## EcsResourceRequirement +### Properties +* **Type**: string (Required) +* **Value**: string (Required) + +## EcsTaskOverride +### Properties +* **ContainerOverrides**: [EcsContainerOverride](#ecscontaineroverride)[] +* **Cpu**: string +* **EphemeralStorage**: [EcsEphemeralStorage](#ecsephemeralstorage) +* **ExecutionRoleArn**: string +* **InferenceAcceleratorOverrides**: [EcsInferenceAcceleratorOverride](#ecsinferenceacceleratoroverride)[] +* **Memory**: string +* **TaskRoleArn**: string + +## Filter +### Properties +* **Pattern**: string + +## FilterCriteria +### Properties +* **Filters**: [Filter](#filter)[] + ## FirehoseLogDestination ### Properties * **DeliveryStreamArn**: string -## S3LogDestination +## HeaderParametersMap ### Properties -* **BucketName**: string -* **BucketOwner**: string -* **OutputFormat**: string -* **Prefix**: string -## PipeSourceParameters +## MQBrokerAccessCredentials ### Properties -* **ActiveMQBrokerParameters**: [PipeSourceActiveMQBrokerParameters](#pipesourceactivemqbrokerparameters) -* **DynamoDBStreamParameters**: [PipeSourceDynamoDBStreamParameters](#pipesourcedynamodbstreamparameters) -* **FilterCriteria**: [FilterCriteria](#filtercriteria) -* **KinesisStreamParameters**: [PipeSourceKinesisStreamParameters](#pipesourcekinesisstreamparameters) -* **ManagedStreamingKafkaParameters**: [PipeSourceManagedStreamingKafkaParameters](#pipesourcemanagedstreamingkafkaparameters) -* **RabbitMQBrokerParameters**: [PipeSourceRabbitMQBrokerParameters](#pipesourcerabbitmqbrokerparameters) -* **SelfManagedKafkaParameters**: [PipeSourceSelfManagedKafkaParameters](#pipesourceselfmanagedkafkaparameters) -* **SqsQueueParameters**: [PipeSourceSqsQueueParameters](#pipesourcesqsqueueparameters) + +## MSKAccessCredentials +### Properties + +## MultiMeasureAttributeMapping +### Properties +* **MeasureValue**: string (Required) +* **MeasureValueType**: string (Required) +* **MultiMeasureAttributeName**: string (Required) + +## MultiMeasureMapping +### Properties +* **MultiMeasureAttributeMappings**: [MultiMeasureAttributeMapping](#multimeasureattributemapping)[] (Required) +* **MultiMeasureName**: string (Required) + +## NetworkConfiguration +### Properties +* **AwsvpcConfiguration**: [AwsVpcConfiguration](#awsvpcconfiguration) + +## Pipe_SelfManagedKafkaAccessConfigurationCredentials +### Properties + +## PipeEnrichmentHttpParameters +### Properties +* **HeaderParameters**: [HeaderParametersMap](#headerparametersmap) +* **PathParameterValues**: string[] +* **QueryStringParameters**: [QueryStringParametersMap](#querystringparametersmap) + +## PipeEnrichmentParameters +### Properties +* **HttpParameters**: [PipeEnrichmentHttpParameters](#pipeenrichmenthttpparameters) +* **InputTemplate**: string + +## PipeLogConfiguration +### Properties +* **CloudwatchLogsLogDestination**: [CloudwatchLogsLogDestination](#cloudwatchlogslogdestination) +* **FirehoseLogDestination**: [FirehoseLogDestination](#firehoselogdestination) +* **IncludeExecutionData**: string[] +* **Level**: string +* **S3LogDestination**: [S3LogDestination](#s3logdestination) ## PipeSourceActiveMQBrokerParameters ### Properties @@ -85,9 +196,6 @@ * **MaximumBatchingWindowInSeconds**: int * **QueueName**: string (Required) -## MQBrokerAccessCredentials -### Properties - ## PipeSourceDynamoDBStreamParameters ### Properties * **BatchSize**: int @@ -99,18 +207,6 @@ * **ParallelizationFactor**: int * **StartingPosition**: string (Required) -## DeadLetterConfig -### Properties -* **Arn**: string - -## FilterCriteria -### Properties -* **Filters**: [Filter](#filter)[] - -## Filter -### Properties -* **Pattern**: string - ## PipeSourceKinesisStreamParameters ### Properties * **BatchSize**: int @@ -132,8 +228,16 @@ * **StartingPosition**: string * **TopicName**: string (Required) -## MSKAccessCredentials +## PipeSourceParameters ### Properties +* **ActiveMQBrokerParameters**: [PipeSourceActiveMQBrokerParameters](#pipesourceactivemqbrokerparameters) +* **DynamoDBStreamParameters**: [PipeSourceDynamoDBStreamParameters](#pipesourcedynamodbstreamparameters) +* **FilterCriteria**: [FilterCriteria](#filtercriteria) +* **KinesisStreamParameters**: [PipeSourceKinesisStreamParameters](#pipesourcekinesisstreamparameters) +* **ManagedStreamingKafkaParameters**: [PipeSourceManagedStreamingKafkaParameters](#pipesourcemanagedstreamingkafkaparameters) +* **RabbitMQBrokerParameters**: [PipeSourceRabbitMQBrokerParameters](#pipesourcerabbitmqbrokerparameters) +* **SelfManagedKafkaParameters**: [PipeSourceSelfManagedKafkaParameters](#pipesourceselfmanagedkafkaparameters) +* **SqsQueueParameters**: [PipeSourceSqsQueueParameters](#pipesourcesqsqueueparameters) ## PipeSourceRabbitMQBrokerParameters ### Properties @@ -155,37 +259,11 @@ * **TopicName**: string (Required) * **Vpc**: [SelfManagedKafkaAccessConfigurationVpc](#selfmanagedkafkaaccessconfigurationvpc) -## Pipe_SelfManagedKafkaAccessConfigurationCredentials -### Properties - -## SelfManagedKafkaAccessConfigurationVpc -### Properties -* **SecurityGroup**: string[]: List of SecurityGroupId. -* **Subnets**: string[]: List of SubnetId. - ## PipeSourceSqsQueueParameters ### Properties * **BatchSize**: int * **MaximumBatchingWindowInSeconds**: int -## TagMap -### Properties - -## PipeTargetParameters -### Properties -* **BatchJobParameters**: [PipeTargetBatchJobParameters](#pipetargetbatchjobparameters) -* **CloudWatchLogsParameters**: [PipeTargetCloudWatchLogsParameters](#pipetargetcloudwatchlogsparameters) -* **EcsTaskParameters**: [PipeTargetEcsTaskParameters](#pipetargetecstaskparameters) -* **EventBridgeEventBusParameters**: [PipeTargetEventBridgeEventBusParameters](#pipetargeteventbridgeeventbusparameters) -* **HttpParameters**: [PipeTargetHttpParameters](#pipetargethttpparameters) -* **InputTemplate**: string -* **KinesisStreamParameters**: [PipeTargetKinesisStreamParameters](#pipetargetkinesisstreamparameters) -* **LambdaFunctionParameters**: [PipeTargetLambdaFunctionParameters](#pipetargetlambdafunctionparameters) -* **RedshiftDataParameters**: [PipeTargetRedshiftDataParameters](#pipetargetredshiftdataparameters) -* **SageMakerPipelineParameters**: [PipeTargetSageMakerPipelineParameters](#pipetargetsagemakerpipelineparameters) -* **SqsQueueParameters**: [PipeTargetSqsQueueParameters](#pipetargetsqsqueueparameters) -* **StepFunctionStateMachineParameters**: [PipeTargetStateMachineParameters](#pipetargetstatemachineparameters) - ## PipeTargetBatchJobParameters ### Properties * **ArrayProperties**: [BatchArrayProperties](#batcharrayproperties) @@ -196,39 +274,6 @@ * **Parameters**: [BatchParametersMap](#batchparametersmap) * **RetryStrategy**: [BatchRetryStrategy](#batchretrystrategy) -## BatchArrayProperties -### Properties -* **Size**: int - -## BatchContainerOverrides -### Properties -* **Command**: string[] -* **Environment**: [BatchEnvironmentVariable](#batchenvironmentvariable)[] -* **InstanceType**: string -* **ResourceRequirements**: [BatchResourceRequirement](#batchresourcerequirement)[] - -## BatchEnvironmentVariable -### Properties -* **Name**: string (Identifier) -* **Value**: string - -## BatchResourceRequirement -### Properties -* **Type**: string (Required) -* **Value**: string (Required) - -## BatchJobDependency -### Properties -* **JobId**: string -* **Type**: string - -## BatchParametersMap -### Properties - -## BatchRetryStrategy -### Properties -* **Attempts**: int - ## PipeTargetCloudWatchLogsParameters ### Properties * **LogStreamName**: string @@ -252,66 +297,76 @@ * **TaskCount**: int * **TaskDefinitionArn**: string (Required) -## CapacityProviderStrategyItem +## PipeTargetEventBridgeEventBusParameters ### Properties -* **Base**: int -* **CapacityProvider**: string (Required) -* **Weight**: int +* **DetailType**: string +* **EndpointId**: string +* **Resources**: string[] +* **Source**: string +* **Time**: string -## NetworkConfiguration +## PipeTargetHttpParameters ### Properties -* **AwsvpcConfiguration**: [AwsVpcConfiguration](#awsvpcconfiguration) +* **HeaderParameters**: [HeaderParametersMap](#headerparametersmap) +* **PathParameterValues**: string[] +* **QueryStringParameters**: [QueryStringParametersMap](#querystringparametersmap) -## AwsVpcConfiguration +## PipeTargetKinesisStreamParameters ### Properties -* **AssignPublicIp**: string -* **SecurityGroups**: string[] -* **Subnets**: string[] (Required) +* **PartitionKey**: string (Required) -## EcsTaskOverride +## PipeTargetLambdaFunctionParameters ### Properties -* **ContainerOverrides**: [EcsContainerOverride](#ecscontaineroverride)[] -* **Cpu**: string -* **EphemeralStorage**: [EcsEphemeralStorage](#ecsephemeralstorage) -* **ExecutionRoleArn**: string -* **InferenceAcceleratorOverrides**: [EcsInferenceAcceleratorOverride](#ecsinferenceacceleratoroverride)[] -* **Memory**: string -* **TaskRoleArn**: string +* **InvocationType**: string -## EcsContainerOverride +## PipeTargetParameters ### Properties -* **Command**: string[] -* **Cpu**: int -* **Environment**: [EcsEnvironmentVariable](#ecsenvironmentvariable)[] -* **EnvironmentFiles**: [EcsEnvironmentFile](#ecsenvironmentfile)[] -* **Memory**: int -* **MemoryReservation**: int -* **Name**: string (Identifier) -* **ResourceRequirements**: [EcsResourceRequirement](#ecsresourcerequirement)[] +* **BatchJobParameters**: [PipeTargetBatchJobParameters](#pipetargetbatchjobparameters) +* **CloudWatchLogsParameters**: [PipeTargetCloudWatchLogsParameters](#pipetargetcloudwatchlogsparameters) +* **EcsTaskParameters**: [PipeTargetEcsTaskParameters](#pipetargetecstaskparameters) +* **EventBridgeEventBusParameters**: [PipeTargetEventBridgeEventBusParameters](#pipetargeteventbridgeeventbusparameters) +* **HttpParameters**: [PipeTargetHttpParameters](#pipetargethttpparameters) +* **InputTemplate**: string +* **KinesisStreamParameters**: [PipeTargetKinesisStreamParameters](#pipetargetkinesisstreamparameters) +* **LambdaFunctionParameters**: [PipeTargetLambdaFunctionParameters](#pipetargetlambdafunctionparameters) +* **RedshiftDataParameters**: [PipeTargetRedshiftDataParameters](#pipetargetredshiftdataparameters) +* **SageMakerPipelineParameters**: [PipeTargetSageMakerPipelineParameters](#pipetargetsagemakerpipelineparameters) +* **SqsQueueParameters**: [PipeTargetSqsQueueParameters](#pipetargetsqsqueueparameters) +* **StepFunctionStateMachineParameters**: [PipeTargetStateMachineParameters](#pipetargetstatemachineparameters) +* **TimestreamParameters**: [PipeTargetTimestreamParameters](#pipetargettimestreamparameters) -## EcsEnvironmentVariable +## PipeTargetRedshiftDataParameters ### Properties -* **Name**: string (Identifier) -* **Value**: string +* **Database**: string (Required): Redshift Database +* **DbUser**: string: Database user name +* **SecretManagerArn**: string: Optional SecretManager ARN which stores the database credentials +* **Sqls**: string[] (Required): A list of SQLs. +* **StatementName**: string: A name for Redshift DataAPI statement which can be used as filter of ListStatement. +* **WithEvent**: bool -## EcsEnvironmentFile +## PipeTargetSageMakerPipelineParameters ### Properties -* **Type**: string (Required) -* **Value**: string (Required) +* **PipelineParameterList**: [SageMakerPipelineParameter](#sagemakerpipelineparameter)[] -## EcsResourceRequirement +## PipeTargetSqsQueueParameters ### Properties -* **Type**: string (Required) -* **Value**: string (Required) +* **MessageDeduplicationId**: string +* **MessageGroupId**: string -## EcsEphemeralStorage +## PipeTargetStateMachineParameters ### Properties -* **SizeInGiB**: int (Required) +* **InvocationType**: string -## EcsInferenceAcceleratorOverride +## PipeTargetTimestreamParameters ### Properties -* **DeviceName**: string -* **DeviceType**: string +* **DimensionMappings**: [DimensionMapping](#dimensionmapping)[] (Required) +* **EpochTimeUnit**: string +* **MultiMeasureMappings**: [MultiMeasureMapping](#multimeasuremapping)[] +* **SingleMeasureMappings**: [SingleMeasureMapping](#singlemeasuremapping)[] +* **TimeFieldType**: string +* **TimestampFormat**: string +* **TimeValue**: string (Required) +* **VersionValue**: string (Required) ## PlacementConstraint ### Properties @@ -323,57 +378,37 @@ * **Field**: string * **Type**: string -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - -## PipeTargetEventBridgeEventBusParameters -### Properties -* **DetailType**: string -* **EndpointId**: string -* **Resources**: string[] -* **Source**: string -* **Time**: string - -## PipeTargetHttpParameters +## QueryStringParametersMap ### Properties -* **HeaderParameters**: [HeaderParametersMap](#headerparametersmap) -* **PathParameterValues**: string[] -* **QueryStringParameters**: [QueryStringParametersMap](#querystringparametersmap) -## PipeTargetKinesisStreamParameters +## S3LogDestination ### Properties -* **PartitionKey**: string (Required) +* **BucketName**: string +* **BucketOwner**: string +* **OutputFormat**: string +* **Prefix**: string -## PipeTargetLambdaFunctionParameters +## SageMakerPipelineParameter ### Properties -* **InvocationType**: string +* **Name**: string (Required, Identifier) +* **Value**: string (Required) -## PipeTargetRedshiftDataParameters +## SelfManagedKafkaAccessConfigurationVpc ### Properties -* **Database**: string (Required): Redshift Database -* **DbUser**: string: Database user name -* **SecretManagerArn**: string: Optional SecretManager ARN which stores the database credentials -* **Sqls**: string[] (Required): A list of SQLs. -* **StatementName**: string: A name for Redshift DataAPI statement which can be used as filter of ListStatement. -* **WithEvent**: bool +* **SecurityGroup**: string[]: List of SecurityGroupId. +* **Subnets**: string[]: List of SubnetId. -## PipeTargetSageMakerPipelineParameters +## SingleMeasureMapping ### Properties -* **PipelineParameterList**: [SageMakerPipelineParameter](#sagemakerpipelineparameter)[] +* **MeasureName**: string (Required) +* **MeasureValue**: string (Required) +* **MeasureValueType**: string (Required) -## SageMakerPipelineParameter +## Tag ### Properties -* **Name**: string (Required, Identifier) +* **Key**: string (Required) * **Value**: string (Required) -## PipeTargetSqsQueueParameters -### Properties -* **MessageDeduplicationId**: string -* **MessageGroupId**: string - -## PipeTargetStateMachineParameters +## TagMap ### Properties -* **InvocationType**: string diff --git a/artifacts/bicep/aws/aws.proton/default/types.json b/artifacts/bicep/aws/aws.proton/default/types.json index 85d5a45e..9dbb5de7 100644 --- a/artifacts/bicep/aws/aws.proton/default/types.json +++ b/artifacts/bicep/aws/aws.proton/default/types.json @@ -1 +1,400 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"Status"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"

The key of the resource tag.

"},"Value":{"Type":4,"Flags":1,"Description":"

The value of the resource tag.

"}}}},{"2":{"Name":"AWS.Proton/EnvironmentAccountConnectionProperties","Properties":{"Arn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN) of the environment account connection."},"CodebuildRoleArn":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) of an IAM service role in the environment account. AWS Proton uses this role to provision infrastructure resources using CodeBuild-based provisioning in the associated environment account."},"ComponentRoleArn":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) of the IAM service role that AWS Proton uses when provisioning directly defined components in the associated environment account. It determines the scope of infrastructure that a component can provision in the account."},"EnvironmentAccountId":{"Type":4,"Flags":0,"Description":"The environment account that's connected to the environment account connection."},"EnvironmentName":{"Type":4,"Flags":0,"Description":"The name of the AWS Proton environment that's created in the associated management account."},"Id":{"Type":4,"Flags":2,"Description":"The ID of the environment account connection."},"ManagementAccountId":{"Type":4,"Flags":0,"Description":"The ID of the management account that accepts or rejects the environment account connection. You create an manage the AWS Proton environment in this account. If the management account accepts the environment account connection, AWS Proton can use the associated IAM role to provision environment infrastructure resources in the associated environment account."},"RoleArn":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) of the IAM service role that's created in the environment account. AWS Proton uses this role to provision infrastructure resources in the associated environment account."},"Status":{"Type":4,"Flags":2,"Description":"The status of the environment account connection."},"Tags":{"Type":11,"Flags":0,"Description":"

An optional list of metadata items that you can associate with the Proton environment account connection. A tag is a key-value pair.

\n

For more information, see Proton resources and tagging in the\n Proton User Guide.

"}}}},{"3":{"ItemType":9}},{"2":{"Name":"AWS.Proton/EnvironmentAccountConnection","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":10,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Proton/EnvironmentAccountConnection@default","ScopeType":0,"Body":12}},{"2":{"Name":"Provisioning"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"

The key of the resource tag.

"},"Value":{"Type":4,"Flags":1,"Description":"

The value of the resource tag.

"}}}},{"2":{"Name":"AWS.Proton/EnvironmentTemplateProperties","Properties":{"Arn":{"Type":4,"Flags":18,"Description":"

The Amazon Resource Name (ARN) of the environment template.

"},"Description":{"Type":4,"Flags":0,"Description":"

A description of the environment template.

"},"DisplayName":{"Type":4,"Flags":0,"Description":"

The environment template name as displayed in the developer interface.

"},"EncryptionKey":{"Type":4,"Flags":0,"Description":"

A customer provided encryption key that Proton uses to encrypt data.

"},"Name":{"Type":4,"Flags":0},"Provisioning":{"Type":4,"Flags":0},"Tags":{"Type":17,"Flags":0,"Description":"

An optional list of metadata items that you can associate with the Proton environment template. A tag is a key-value pair.

\n

For more information, see Proton resources and tagging in the\n Proton User Guide.

"}}}},{"3":{"ItemType":15}},{"2":{"Name":"AWS.Proton/EnvironmentTemplate","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":16,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Proton/EnvironmentTemplate@default","ScopeType":0,"Body":18}},{"2":{"Name":"Provisioning"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"

The key of the resource tag.

"},"Value":{"Type":4,"Flags":1,"Description":"

The value of the resource tag.

"}}}},{"2":{"Name":"AWS.Proton/ServiceTemplateProperties","Properties":{"Arn":{"Type":4,"Flags":18,"Description":"

The Amazon Resource Name (ARN) of the service template.

"},"Description":{"Type":4,"Flags":0,"Description":"

A description of the service template.

"},"DisplayName":{"Type":4,"Flags":0,"Description":"

The name of the service template as displayed in the developer interface.

"},"EncryptionKey":{"Type":4,"Flags":0,"Description":"

A customer provided encryption key that's used to encrypt data.

"},"Name":{"Type":4,"Flags":0},"PipelineProvisioning":{"Type":4,"Flags":0},"Tags":{"Type":23,"Flags":0,"Description":"

An optional list of metadata items that you can associate with the Proton service template. A tag is a key-value pair.

\n

For more information, see Proton resources and tagging in the\n Proton User Guide.

"}}}},{"3":{"ItemType":21}},{"2":{"Name":"AWS.Proton/ServiceTemplate","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":22,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Proton/ServiceTemplate@default","ScopeType":0,"Body":24}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Status", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "

The key of the resource tag.

" + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "

The value of the resource tag.

" + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.Proton/EnvironmentAccountConnectionProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Proton/EnvironmentAccountConnectionProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) of the environment account connection." + }, + "CodebuildRoleArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of an IAM service role in the environment account. AWS Proton uses this role to provision infrastructure resources using CodeBuild-based provisioning in the associated environment account." + }, + "ComponentRoleArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the IAM service role that AWS Proton uses when provisioning directly defined components in the associated environment account. It determines the scope of infrastructure that a component can provision in the account." + }, + "EnvironmentAccountId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The environment account that's connected to the environment account connection." + }, + "EnvironmentName": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The name of the AWS Proton environment that's created in the associated management account." + }, + "Id": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The ID of the environment account connection." + }, + "ManagementAccountId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The ID of the management account that accepts or rejects the environment account connection. You create an manage the AWS Proton environment in this account. If the management account accepts the environment account connection, AWS Proton can use the associated IAM role to provision environment infrastructure resources in the associated environment account." + }, + "RoleArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the IAM service role that's created in the environment account. AWS Proton uses this role to provision infrastructure resources in the associated environment account." + }, + "Status": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The status of the environment account connection." + }, + "Tags": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "

An optional list of metadata items that you can associate with the Proton environment account connection. A tag is a key-value pair.

\n

For more information, see Proton resources and tagging in the\n Proton User Guide.

" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Proton/EnvironmentAccountConnection", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/5" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Proton/EnvironmentAccountConnection@default", + "scopeType": 0, + "body": { + "$ref": "#/6" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Provisioning", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "

The key of the resource tag.

" + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "

The value of the resource tag.

" + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Proton/EnvironmentTemplateProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/9" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Proton/EnvironmentTemplateProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "

The Amazon Resource Name (ARN) of the environment template.

" + }, + "Description": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "

A description of the environment template.

" + }, + "DisplayName": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "

The environment template name as displayed in the developer interface.

" + }, + "EncryptionKey": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "

A customer provided encryption key that Proton uses to encrypt data.

" + }, + "Name": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Provisioning": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "

An optional list of metadata items that you can associate with the Proton environment template. A tag is a key-value pair.

\n

For more information, see Proton resources and tagging in the\n Proton User Guide.

" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Proton/EnvironmentTemplate", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/12" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Proton/EnvironmentTemplate@default", + "scopeType": 0, + "body": { + "$ref": "#/13" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Provisioning", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "

The key of the resource tag.

" + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "

The value of the resource tag.

" + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Proton/ServiceTemplateProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/16" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Proton/ServiceTemplateProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "

The Amazon Resource Name (ARN) of the service template.

" + }, + "Description": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "

A description of the service template.

" + }, + "DisplayName": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "

The name of the service template as displayed in the developer interface.

" + }, + "EncryptionKey": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "

A customer provided encryption key that's used to encrypt data.

" + }, + "Name": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "PipelineProvisioning": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "

An optional list of metadata items that you can associate with the Proton service template. A tag is a key-value pair.

\n

For more information, see Proton resources and tagging in the\n Proton User Guide.

" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Proton/ServiceTemplate", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/19" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Proton/ServiceTemplate@default", + "scopeType": 0, + "body": { + "$ref": "#/20" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.proton/default/types.md b/artifacts/bicep/aws/aws.proton/default/types.md index f960f287..be17c7d8 100644 --- a/artifacts/bicep/aws/aws.proton/default/types.md +++ b/artifacts/bicep/aws/aws.proton/default/types.md @@ -3,23 +3,23 @@ ## Resource AWS.Proton/EnvironmentAccountConnection@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Proton/EnvironmentAccountConnectionProperties](#awsprotonenvironmentaccountconnectionproperties): properties of the resource +* **properties**: [AWS.Proton/EnvironmentAccountConnectionProperties](#awsprotonenvironmentaccountconnectionproperties) (Identifier): properties of the resource ## Resource AWS.Proton/EnvironmentTemplate@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Proton/EnvironmentTemplateProperties](#awsprotonenvironmenttemplateproperties): properties of the resource +* **properties**: [AWS.Proton/EnvironmentTemplateProperties](#awsprotonenvironmenttemplateproperties) (Identifier): properties of the resource ## Resource AWS.Proton/ServiceTemplate@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Proton/ServiceTemplateProperties](#awsprotonservicetemplateproperties): properties of the resource +* **properties**: [AWS.Proton/ServiceTemplateProperties](#awsprotonservicetemplateproperties) (Identifier): properties of the resource ## AWS.Proton/EnvironmentAccountConnectionProperties ### Properties @@ -36,11 +36,6 @@

For more information, see Proton resources and tagging in the Proton User Guide.

-## Tag -### Properties -* **Key**: string (Required):

The key of the resource tag.

-* **Value**: string (Required):

The value of the resource tag.

- ## AWS.Proton/EnvironmentTemplateProperties ### Properties * **Arn**: string (ReadOnly, Identifier):

The Amazon Resource Name (ARN) of the environment template.

@@ -53,11 +48,6 @@

For more information, see Proton resources and tagging in the Proton User Guide.

-## Tag -### Properties -* **Key**: string (Required):

The key of the resource tag.

-* **Value**: string (Required):

The value of the resource tag.

- ## AWS.Proton/ServiceTemplateProperties ### Properties * **Arn**: string (ReadOnly, Identifier):

The Amazon Resource Name (ARN) of the service template.

@@ -75,3 +65,13 @@ * **Key**: string (Required):

The key of the resource tag.

* **Value**: string (Required):

The value of the resource tag.

+## Tag +### Properties +* **Key**: string (Required):

The key of the resource tag.

+* **Value**: string (Required):

The value of the resource tag.

+ +## Tag +### Properties +* **Key**: string (Required):

The key of the resource tag.

+* **Value**: string (Required):

The value of the resource tag.

+ diff --git a/artifacts/bicep/aws/aws.qbusiness/default/types.json b/artifacts/bicep/aws/aws.qbusiness/default/types.json new file mode 100644 index 00000000..b11bbfcd --- /dev/null +++ b/artifacts/bicep/aws/aws.qbusiness/default/types.json @@ -0,0 +1,1392 @@ +[ + { + "$type": "ObjectType", + "name": "ApplicationStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AttachmentsConfiguration", + "properties": { + "AttachmentsControlMode": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AttachmentsControlMode", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "EncryptionConfiguration", + "properties": { + "KmsKeyId": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.QBusiness/ApplicationProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ObjectType", + "name": "AWS.QBusiness/ApplicationProperties", + "properties": { + "ApplicationArn": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "ApplicationId": { + "type": { + "$ref": "#/5" + }, + "flags": 18 + }, + "AttachmentsConfiguration": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "CreatedAt": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "Description": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "DisplayName": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "EncryptionConfiguration": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "IdentityCenterApplicationArn": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "IdentityCenterInstanceArn": { + "type": { + "$ref": "#/5" + }, + "flags": 4 + }, + "RoleArn": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Status": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "Tags": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "UpdatedAt": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.QBusiness/Application", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/8" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.QBusiness/Application@default", + "scopeType": 0, + "body": { + "$ref": "#/9" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AttributeValueOperator", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DataSourceStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DataSourceVpcConfiguration", + "properties": { + "SecurityGroupIds": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + }, + "SubnetIds": { + "type": { + "$ref": "#/24" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DocumentAttributeCondition", + "properties": { + "Key": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Operator": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/25" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DocumentAttributeTarget", + "properties": { + "AttributeValueOperator": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Key": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/26" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DocumentAttributeValue", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DocumentContentOperator", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DocumentEnrichmentConditionOperator", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DocumentEnrichmentConfiguration", + "properties": { + "InlineConfigurations": { + "type": { + "$ref": "#/27" + }, + "flags": 0 + }, + "PostExtractionHookConfiguration": { + "type": { + "$ref": "#/20" + }, + "flags": 0 + }, + "PreExtractionHookConfiguration": { + "type": { + "$ref": "#/20" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "HookConfiguration", + "properties": { + "InvocationCondition": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + }, + "LambdaArn": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "RoleArn": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "S3BucketName": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "InlineDocumentEnrichmentConfiguration", + "properties": { + "Condition": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + }, + "DocumentContentOperator": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Target": { + "type": { + "$ref": "#/15" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ObjectType", + "name": "DataSource_DocumentAttributeValue", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DataSource_DocumentAttributeValue", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/21" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.QBusiness/DataSourceProperties" + }, + { + "$type": "ObjectType", + "name": "DataSource_Configuration", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/22" + } + }, + { + "$type": "ObjectType", + "name": "AWS.QBusiness/DataSourceProperties", + "properties": { + "ApplicationId": { + "type": { + "$ref": "#/5" + }, + "flags": 17 + }, + "Configuration": { + "type": { + "$ref": "#/29" + }, + "flags": 1 + }, + "CreatedAt": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "DataSourceArn": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "DataSourceId": { + "type": { + "$ref": "#/5" + }, + "flags": 18 + }, + "Description": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "DisplayName": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "DocumentEnrichmentConfiguration": { + "type": { + "$ref": "#/19" + }, + "flags": 0 + }, + "IndexId": { + "type": { + "$ref": "#/5" + }, + "flags": 17 + }, + "RoleArn": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Status": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "SyncSchedule": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/30" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "UpdatedAt": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "VpcConfiguration": { + "type": { + "$ref": "#/13" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.QBusiness/DataSource", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/31" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.QBusiness/DataSource@default", + "scopeType": 0, + "body": { + "$ref": "#/32" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AttributeType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DocumentAttributeConfiguration", + "properties": { + "Name": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Search": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "IndexCapacityConfiguration", + "properties": { + "Units": { + "type": { + "$ref": "#/43" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "IndexStatistics", + "properties": { + "TextDocumentStatistics": { + "type": { + "$ref": "#/42" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "IndexStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "IndexType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Status", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TextDocumentStatistics", + "properties": { + "IndexedTextBytes": { + "type": { + "$ref": "#/43" + }, + "flags": 0 + }, + "IndexedTextDocumentCount": { + "type": { + "$ref": "#/43" + }, + "flags": 0 + } + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.QBusiness/IndexProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/35" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/41" + } + }, + { + "$type": "ObjectType", + "name": "AWS.QBusiness/IndexProperties", + "properties": { + "ApplicationId": { + "type": { + "$ref": "#/5" + }, + "flags": 17 + }, + "CapacityConfiguration": { + "type": { + "$ref": "#/36" + }, + "flags": 0 + }, + "CreatedAt": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "Description": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "DisplayName": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "DocumentAttributeConfigurations": { + "type": { + "$ref": "#/45" + }, + "flags": 0 + }, + "IndexArn": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "IndexId": { + "type": { + "$ref": "#/5" + }, + "flags": 18 + }, + "IndexStatistics": { + "type": { + "$ref": "#/37" + }, + "flags": 2 + }, + "Status": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "Tags": { + "type": { + "$ref": "#/46" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "UpdatedAt": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.QBusiness/Index", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/47" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.QBusiness/Index@default", + "scopeType": 0, + "body": { + "$ref": "#/48" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "APISchema", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "APISchemaType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "BasicAuthConfiguration", + "properties": { + "RoleArn": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "SecretArn": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomPluginConfiguration", + "properties": { + "ApiSchema": { + "type": { + "$ref": "#/50" + }, + "flags": 1 + }, + "ApiSchemaType": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Description": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "NoAuthConfiguration", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "OAuth2ClientCredentialConfiguration", + "properties": { + "RoleArn": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "SecretArn": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "PluginAuthConfiguration", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PluginBuildStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PluginState", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PluginType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "S3", + "properties": { + "Bucket": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Key": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.QBusiness/PluginProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/61" + } + }, + { + "$type": "ObjectType", + "name": "AWS.QBusiness/PluginProperties", + "properties": { + "ApplicationId": { + "type": { + "$ref": "#/5" + }, + "flags": 17 + }, + "AuthConfiguration": { + "type": { + "$ref": "#/56" + }, + "flags": 1 + }, + "BuildStatus": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "CreatedAt": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "CustomPluginConfiguration": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "DisplayName": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "PluginArn": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "PluginId": { + "type": { + "$ref": "#/5" + }, + "flags": 18 + }, + "ServerUrl": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "State": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/63" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "UpdatedAt": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.QBusiness/Plugin", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/64" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.QBusiness/Plugin@default", + "scopeType": 0, + "body": { + "$ref": "#/65" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "KendraIndexConfiguration", + "properties": { + "IndexId": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "NativeIndexConfiguration", + "properties": { + "IndexId": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "RetrieverConfiguration", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RetrieverStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RetrieverType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.QBusiness/RetrieverProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/72" + } + }, + { + "$type": "ObjectType", + "name": "AWS.QBusiness/RetrieverProperties", + "properties": { + "ApplicationId": { + "type": { + "$ref": "#/5" + }, + "flags": 17 + }, + "Configuration": { + "type": { + "$ref": "#/69" + }, + "flags": 1 + }, + "CreatedAt": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "DisplayName": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "RetrieverArn": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "RetrieverId": { + "type": { + "$ref": "#/5" + }, + "flags": 18 + }, + "RoleArn": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Status": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "Tags": { + "type": { + "$ref": "#/74" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "UpdatedAt": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.QBusiness/Retriever", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/75" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.QBusiness/Retriever@default", + "scopeType": 0, + "body": { + "$ref": "#/76" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "WebExperienceSamplePromptsControlMode", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "WebExperienceStatus", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.QBusiness/WebExperienceProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/78" + } + }, + { + "$type": "ObjectType", + "name": "AWS.QBusiness/WebExperienceProperties", + "properties": { + "ApplicationId": { + "type": { + "$ref": "#/5" + }, + "flags": 17 + }, + "CreatedAt": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "DefaultEndpoint": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "RoleArn": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "SamplePromptsControlMode": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Status": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "Subtitle": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/82" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "UpdatedAt": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "WebExperienceArn": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "WebExperienceId": { + "type": { + "$ref": "#/5" + }, + "flags": 18 + }, + "WelcomeMessage": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.QBusiness/WebExperience", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/83" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.QBusiness/WebExperience@default", + "scopeType": 0, + "body": { + "$ref": "#/84" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.qbusiness/default/types.md b/artifacts/bicep/aws/aws.qbusiness/default/types.md new file mode 100644 index 00000000..ef903911 --- /dev/null +++ b/artifacts/bicep/aws/aws.qbusiness/default/types.md @@ -0,0 +1,258 @@ +# AWS.QBusiness @ default + +## Resource AWS.QBusiness/Application@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.QBusiness/ApplicationProperties](#awsqbusinessapplicationproperties) (Required, Identifier): properties of the resource + +## Resource AWS.QBusiness/DataSource@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.QBusiness/DataSourceProperties](#awsqbusinessdatasourceproperties) (Required, Identifier): properties of the resource + +## Resource AWS.QBusiness/Index@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.QBusiness/IndexProperties](#awsqbusinessindexproperties) (Required, Identifier): properties of the resource + +## Resource AWS.QBusiness/Plugin@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.QBusiness/PluginProperties](#awsqbusinesspluginproperties) (Required, Identifier): properties of the resource + +## Resource AWS.QBusiness/Retriever@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.QBusiness/RetrieverProperties](#awsqbusinessretrieverproperties) (Required, Identifier): properties of the resource + +## Resource AWS.QBusiness/WebExperience@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.QBusiness/WebExperienceProperties](#awsqbusinesswebexperienceproperties) (Required, Identifier): properties of the resource + +## APISchema +### Properties + +## AttachmentsConfiguration +### Properties +* **AttachmentsControlMode**: string (Required) + +## AWS.QBusiness/ApplicationProperties +### Properties +* **ApplicationArn**: string (ReadOnly) +* **ApplicationId**: string (ReadOnly, Identifier) +* **AttachmentsConfiguration**: [AttachmentsConfiguration](#attachmentsconfiguration) +* **CreatedAt**: string (ReadOnly) +* **Description**: string +* **DisplayName**: string (Required) +* **EncryptionConfiguration**: [EncryptionConfiguration](#encryptionconfiguration) +* **IdentityCenterApplicationArn**: string (ReadOnly) +* **IdentityCenterInstanceArn**: string (WriteOnly) +* **RoleArn**: string +* **Status**: string (ReadOnly) +* **Tags**: [Tag](#tag)[] +* **UpdatedAt**: string (ReadOnly) + +## AWS.QBusiness/DataSourceProperties +### Properties +* **ApplicationId**: string (Required, Identifier) +* **Configuration**: [DataSource_Configuration](#datasourceconfiguration) (Required) +* **CreatedAt**: string (ReadOnly) +* **DataSourceArn**: string (ReadOnly) +* **DataSourceId**: string (ReadOnly, Identifier) +* **Description**: string +* **DisplayName**: string (Required) +* **DocumentEnrichmentConfiguration**: [DocumentEnrichmentConfiguration](#documentenrichmentconfiguration) +* **IndexId**: string (Required, Identifier) +* **RoleArn**: string +* **Status**: string (ReadOnly) +* **SyncSchedule**: string +* **Tags**: [Tag](#tag)[] +* **Type**: string (ReadOnly) +* **UpdatedAt**: string (ReadOnly) +* **VpcConfiguration**: [DataSourceVpcConfiguration](#datasourcevpcconfiguration) + +## AWS.QBusiness/IndexProperties +### Properties +* **ApplicationId**: string (Required, Identifier) +* **CapacityConfiguration**: [IndexCapacityConfiguration](#indexcapacityconfiguration) +* **CreatedAt**: string (ReadOnly) +* **Description**: string +* **DisplayName**: string (Required) +* **DocumentAttributeConfigurations**: [DocumentAttributeConfiguration](#documentattributeconfiguration)[] +* **IndexArn**: string (ReadOnly) +* **IndexId**: string (ReadOnly, Identifier) +* **IndexStatistics**: [IndexStatistics](#indexstatistics) (ReadOnly) +* **Status**: string (ReadOnly) +* **Tags**: [Tag](#tag)[] +* **Type**: string +* **UpdatedAt**: string (ReadOnly) + +## AWS.QBusiness/PluginProperties +### Properties +* **ApplicationId**: string (Required, Identifier) +* **AuthConfiguration**: [PluginAuthConfiguration](#pluginauthconfiguration) (Required) +* **BuildStatus**: string (ReadOnly) +* **CreatedAt**: string (ReadOnly) +* **CustomPluginConfiguration**: [CustomPluginConfiguration](#custompluginconfiguration) +* **DisplayName**: string (Required) +* **PluginArn**: string (ReadOnly) +* **PluginId**: string (ReadOnly, Identifier) +* **ServerUrl**: string +* **State**: string +* **Tags**: [Tag](#tag)[] +* **Type**: string (Required) +* **UpdatedAt**: string (ReadOnly) + +## AWS.QBusiness/RetrieverProperties +### Properties +* **ApplicationId**: string (Required, Identifier) +* **Configuration**: [RetrieverConfiguration](#retrieverconfiguration) (Required) +* **CreatedAt**: string (ReadOnly) +* **DisplayName**: string (Required) +* **RetrieverArn**: string (ReadOnly) +* **RetrieverId**: string (ReadOnly, Identifier) +* **RoleArn**: string +* **Status**: string (ReadOnly) +* **Tags**: [Tag](#tag)[] +* **Type**: string (Required) +* **UpdatedAt**: string (ReadOnly) + +## AWS.QBusiness/WebExperienceProperties +### Properties +* **ApplicationId**: string (Required, Identifier) +* **CreatedAt**: string (ReadOnly) +* **DefaultEndpoint**: string (ReadOnly) +* **RoleArn**: string +* **SamplePromptsControlMode**: string +* **Status**: string (ReadOnly) +* **Subtitle**: string +* **Tags**: [Tag](#tag)[] +* **Title**: string +* **UpdatedAt**: string (ReadOnly) +* **WebExperienceArn**: string (ReadOnly) +* **WebExperienceId**: string (ReadOnly, Identifier) +* **WelcomeMessage**: string + +## CustomPluginConfiguration +### Properties +* **ApiSchema**: [APISchema](#apischema) (Required) +* **ApiSchemaType**: string (Required) +* **Description**: string (Required) + +## DataSource_Configuration +### Properties + +## DataSource_DocumentAttributeValue +### Properties + +## DataSource_DocumentAttributeValue +### Properties + +## DataSourceVpcConfiguration +### Properties +* **SecurityGroupIds**: string[] (Required) +* **SubnetIds**: string[] (Required) + +## DocumentAttributeCondition +### Properties +* **Key**: string (Required) +* **Operator**: string (Required) +* **Value**: [DataSource_DocumentAttributeValue](#datasourcedocumentattributevalue) + +## DocumentAttributeConfiguration +### Properties +* **Name**: string +* **Search**: string +* **Type**: string + +## DocumentAttributeTarget +### Properties +* **AttributeValueOperator**: string +* **Key**: string (Required) +* **Value**: [DataSource_DocumentAttributeValue](#datasourcedocumentattributevalue) + +## DocumentEnrichmentConfiguration +### Properties +* **InlineConfigurations**: [InlineDocumentEnrichmentConfiguration](#inlinedocumentenrichmentconfiguration)[] +* **PostExtractionHookConfiguration**: [HookConfiguration](#hookconfiguration) +* **PreExtractionHookConfiguration**: [HookConfiguration](#hookconfiguration) + +## EncryptionConfiguration +### Properties +* **KmsKeyId**: string + +## HookConfiguration +### Properties +* **InvocationCondition**: [DocumentAttributeCondition](#documentattributecondition) +* **LambdaArn**: string +* **RoleArn**: string +* **S3BucketName**: string + +## IndexCapacityConfiguration +### Properties +* **Units**: int + +## IndexStatistics +### Properties +* **TextDocumentStatistics**: [TextDocumentStatistics](#textdocumentstatistics) + +## InlineDocumentEnrichmentConfiguration +### Properties +* **Condition**: [DocumentAttributeCondition](#documentattributecondition) +* **DocumentContentOperator**: string +* **Target**: [DocumentAttributeTarget](#documentattributetarget) + +## PluginAuthConfiguration +### Properties + +## RetrieverConfiguration +### Properties + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + +## TextDocumentStatistics +### Properties +* **IndexedTextBytes**: int +* **IndexedTextDocumentCount**: int + diff --git a/artifacts/bicep/aws/aws.qldb/default/types.json b/artifacts/bicep/aws/aws.qldb/default/types.json index e5d01a2b..55765002 100644 --- a/artifacts/bicep/aws/aws.qldb/default/types.json +++ b/artifacts/bicep/aws/aws.qldb/default/types.json @@ -1 +1,163 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"Arn"}},{"2":{"Name":"KinesisConfiguration","Properties":{"AggregationEnabled":{"Type":2,"Flags":0},"StreamArn":{"Type":11,"Flags":0}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}}}},{"2":{"Name":"Stream_Arn","Properties":{}}},{"2":{"Name":"AWS.QLDB/StreamProperties","Properties":{"Arn":{"Type":4,"Flags":2},"ExclusiveEndTime":{"Type":4,"Flags":0},"Id":{"Type":4,"Flags":18},"InclusiveStartTime":{"Type":4,"Flags":1},"KinesisConfiguration":{"Type":9,"Flags":1},"LedgerName":{"Type":4,"Flags":17},"RoleArn":{"Type":4,"Flags":1},"StreamName":{"Type":4,"Flags":1},"Tags":{"Type":13,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."}}}},{"3":{"ItemType":10}},{"2":{"Name":"AWS.QLDB/Stream","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":12,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.QLDB/Stream@default","ScopeType":0,"Body":14}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Arn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "KinesisConfiguration", + "properties": { + "AggregationEnabled": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "StreamArn": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "BooleanType" + }, + { + "$type": "ObjectType", + "name": "Stream_Arn", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.QLDB/StreamProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ObjectType", + "name": "AWS.QLDB/StreamProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/3" + }, + "flags": 2 + }, + "ExclusiveEndTime": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "Id": { + "type": { + "$ref": "#/3" + }, + "flags": 18 + }, + "InclusiveStartTime": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + }, + "KinesisConfiguration": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "LedgerName": { + "type": { + "$ref": "#/3" + }, + "flags": 17 + }, + "RoleArn": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + }, + "StreamName": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.QLDB/Stream", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/8" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.QLDB/Stream@default", + "scopeType": 0, + "body": { + "$ref": "#/9" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.qldb/default/types.md b/artifacts/bicep/aws/aws.qldb/default/types.md index d54aeb9d..51246a4a 100644 --- a/artifacts/bicep/aws/aws.qldb/default/types.md +++ b/artifacts/bicep/aws/aws.qldb/default/types.md @@ -3,9 +3,9 @@ ## Resource AWS.QLDB/Stream@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.QLDB/StreamProperties](#awsqldbstreamproperties) (Required): properties of the resource +* **properties**: [AWS.QLDB/StreamProperties](#awsqldbstreamproperties) (Required, Identifier): properties of the resource ## AWS.QLDB/StreamProperties ### Properties diff --git a/artifacts/bicep/aws/aws.quicksight/default/types.json b/artifacts/bicep/aws/aws.quicksight/default/types.json index c431d698..4f43bdca 100644 --- a/artifacts/bicep/aws/aws.quicksight/default/types.json +++ b/artifacts/bicep/aws/aws.quicksight/default/types.json @@ -1 +1,49223 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"AggregationFunction","Properties":{"AttributeAggregationFunction":{"Type":26,"Flags":0},"CategoricalAggregationFunction":{"Type":4,"Flags":0},"DateAggregationFunction":{"Type":4,"Flags":0},"NumericalAggregationFunction":{"Type":341,"Flags":0}}}},{"2":{"Name":"AggregationSortConfiguration","Properties":{"AggregationFunction":{"Type":8,"Flags":0},"Column":{"Type":79,"Flags":1},"SortDirection":{"Type":4,"Flags":1}}}},{"2":{"Name":"AllSheetsFilterScopeConfiguration","Properties":{}}},{"2":{"Name":"AnalysisDefaults","Properties":{"DefaultNewSheetConfiguration":{"Type":154,"Flags":1}}}},{"2":{"Name":"AnalysisDefinition","Properties":{"AnalysisDefaults":{"Type":11,"Flags":0},"CalculatedFields":{"Type":597,"Flags":0},"ColumnConfigurations":{"Type":598,"Flags":0},"DataSetIdentifierDeclarations":{"Type":599,"Flags":1},"FilterGroups":{"Type":600,"Flags":0},"Options":{"Type":25,"Flags":0},"ParameterDeclarations":{"Type":601,"Flags":0},"Sheets":{"Type":602,"Flags":0}}}},{"2":{"Name":"AnalysisError","Properties":{"Message":{"Type":4,"Flags":0},"Type":{"Type":4,"Flags":0},"ViolatedEntities":{"Type":603,"Flags":0}}}},{"2":{"Name":"AnalysisErrorType"}},{"2":{"Name":"AnalysisSourceEntity","Properties":{"SourceTemplate":{"Type":16,"Flags":0}}}},{"2":{"Name":"AnalysisSourceTemplate","Properties":{"Arn":{"Type":4,"Flags":1},"DataSetReferences":{"Type":604,"Flags":1}}}},{"2":{"Name":"AnchorDateConfiguration","Properties":{"AnchorOption":{"Type":4,"Flags":0},"ParameterName":{"Type":4,"Flags":0}}}},{"2":{"Name":"AnchorOption"}},{"2":{"Name":"ArcAxisConfiguration","Properties":{"Range":{"Type":20,"Flags":0},"ReserveRange":{"Type":3,"Flags":0}}}},{"2":{"Name":"ArcAxisDisplayRange","Properties":{"Max":{"Type":3,"Flags":0},"Min":{"Type":3,"Flags":0}}}},{"2":{"Name":"ArcConfiguration","Properties":{"ArcAngle":{"Type":3,"Flags":0},"ArcThickness":{"Type":4,"Flags":0}}}},{"2":{"Name":"ArcOptions","Properties":{"ArcThickness":{"Type":4,"Flags":0}}}},{"2":{"Name":"ArcThickness"}},{"2":{"Name":"ArcThicknessOptions"}},{"2":{"Name":"AssetOptions","Properties":{"Timezone":{"Type":4,"Flags":0},"WeekStart":{"Type":4,"Flags":0}}}},{"2":{"Name":"AttributeAggregationFunction","Properties":{"SimpleAttributeAggregation":{"Type":4,"Flags":0},"ValueForMultipleValues":{"Type":4,"Flags":0}}}},{"2":{"Name":"AxisBinding"}},{"2":{"Name":"AxisDataOptions","Properties":{"DateAxisOptions":{"Type":135,"Flags":0},"NumericAxisOptions":{"Type":331,"Flags":0}}}},{"2":{"Name":"AxisDisplayDataDrivenRange","Properties":{}}},{"2":{"Name":"AxisDisplayMinMaxRange","Properties":{"Maximum":{"Type":3,"Flags":0},"Minimum":{"Type":3,"Flags":0}}}},{"2":{"Name":"AxisDisplayOptions","Properties":{"AxisLineVisibility":{"Type":4,"Flags":0},"AxisOffset":{"Type":4,"Flags":0,"Description":"String based length that is composed of value and unit in px"},"DataOptions":{"Type":28,"Flags":0},"GridLineVisibility":{"Type":4,"Flags":0},"ScrollbarOptions":{"Type":446,"Flags":0},"TickLabelOptions":{"Type":38,"Flags":0}}}},{"2":{"Name":"AxisDisplayRange","Properties":{"DataDriven":{"Type":29,"Flags":0},"MinMax":{"Type":30,"Flags":0}}}},{"2":{"Name":"AxisLabelOptions","Properties":{"ApplyTo":{"Type":34,"Flags":0},"CustomLabel":{"Type":4,"Flags":0},"FontConfiguration":{"Type":199,"Flags":0}}}},{"2":{"Name":"AxisLabelReferenceOptions","Properties":{"Column":{"Type":79,"Flags":1},"FieldId":{"Type":4,"Flags":1}}}},{"2":{"Name":"AxisLinearScale","Properties":{"StepCount":{"Type":3,"Flags":0},"StepSize":{"Type":3,"Flags":0}}}},{"2":{"Name":"AxisLogarithmicScale","Properties":{"Base":{"Type":3,"Flags":0}}}},{"2":{"Name":"AxisScale","Properties":{"Linear":{"Type":35,"Flags":0},"Logarithmic":{"Type":36,"Flags":0}}}},{"2":{"Name":"AxisTickLabelOptions","Properties":{"LabelOptions":{"Type":289,"Flags":0},"RotationAngle":{"Type":3,"Flags":0}}}},{"2":{"Name":"BarChartAggregatedFieldWells","Properties":{"Category":{"Type":605,"Flags":0},"Colors":{"Type":606,"Flags":0},"SmallMultiples":{"Type":607,"Flags":0},"Values":{"Type":608,"Flags":0}}}},{"2":{"Name":"BarChartConfiguration","Properties":{"BarsArrangement":{"Type":4,"Flags":0},"CategoryAxis":{"Type":31,"Flags":0},"CategoryLabelOptions":{"Type":71,"Flags":0},"ColorLabelOptions":{"Type":71,"Flags":0},"ContributionAnalysisDefaults":{"Type":609,"Flags":0},"DataLabels":{"Type":123,"Flags":0},"FieldWells":{"Type":41,"Flags":0},"Legend":{"Type":293,"Flags":0},"Orientation":{"Type":4,"Flags":0},"ReferenceLines":{"Type":610,"Flags":0},"SmallMultiplesOptions":{"Type":485,"Flags":0},"SortConfiguration":{"Type":43,"Flags":0},"Tooltip":{"Type":544,"Flags":0},"ValueAxis":{"Type":31,"Flags":0},"ValueLabelOptions":{"Type":71,"Flags":0},"VisualPalette":{"Type":574,"Flags":0}}}},{"2":{"Name":"BarChartFieldWells","Properties":{"BarChartAggregatedFieldWells":{"Type":39,"Flags":0}}}},{"2":{"Name":"BarChartOrientation"}},{"2":{"Name":"BarChartSortConfiguration","Properties":{"CategoryItemsLimit":{"Type":272,"Flags":0},"CategorySort":{"Type":611,"Flags":0},"ColorItemsLimit":{"Type":272,"Flags":0},"ColorSort":{"Type":612,"Flags":0},"SmallMultiplesLimitConfiguration":{"Type":272,"Flags":0},"SmallMultiplesSort":{"Type":613,"Flags":0}}}},{"2":{"Name":"BarChartVisual","Properties":{"Actions":{"Type":614,"Flags":0},"ChartConfiguration":{"Type":40,"Flags":0},"ColumnHierarchies":{"Type":615,"Flags":0},"Subtitle":{"Type":575,"Flags":0},"Title":{"Type":576,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"BarsArrangement"}},{"2":{"Name":"BaseMapStyleType"}},{"2":{"Name":"BinCountOptions","Properties":{"Value":{"Type":3,"Flags":0}}}},{"2":{"Name":"BinWidthOptions","Properties":{"BinCountLimit":{"Type":3,"Flags":0},"Value":{"Type":3,"Flags":0}}}},{"2":{"Name":"BodySectionConfiguration","Properties":{"Content":{"Type":50,"Flags":1},"PageBreakConfiguration":{"Type":453,"Flags":0},"SectionId":{"Type":4,"Flags":1},"Style":{"Type":455,"Flags":0}}}},{"2":{"Name":"BodySectionContent","Properties":{"Layout":{"Type":452,"Flags":0}}}},{"2":{"Name":"BoxPlotAggregatedFieldWells","Properties":{"GroupBy":{"Type":616,"Flags":0},"Values":{"Type":617,"Flags":0}}}},{"2":{"Name":"BoxPlotChartConfiguration","Properties":{"BoxPlotOptions":{"Type":55,"Flags":0},"CategoryAxis":{"Type":31,"Flags":0},"CategoryLabelOptions":{"Type":71,"Flags":0},"FieldWells":{"Type":53,"Flags":0},"Legend":{"Type":293,"Flags":0},"PrimaryYAxisDisplayOptions":{"Type":31,"Flags":0},"PrimaryYAxisLabelOptions":{"Type":71,"Flags":0},"ReferenceLines":{"Type":618,"Flags":0},"SortConfiguration":{"Type":56,"Flags":0},"Tooltip":{"Type":544,"Flags":0},"VisualPalette":{"Type":574,"Flags":0}}}},{"2":{"Name":"BoxPlotFieldWells","Properties":{"BoxPlotAggregatedFieldWells":{"Type":51,"Flags":0}}}},{"2":{"Name":"BoxPlotFillStyle"}},{"2":{"Name":"BoxPlotOptions","Properties":{"AllDataPointsVisibility":{"Type":4,"Flags":0},"OutlierVisibility":{"Type":4,"Flags":0},"StyleOptions":{"Type":57,"Flags":0}}}},{"2":{"Name":"BoxPlotSortConfiguration","Properties":{"CategorySort":{"Type":619,"Flags":0},"PaginationConfiguration":{"Type":345,"Flags":0}}}},{"2":{"Name":"BoxPlotStyleOptions","Properties":{"FillStyle":{"Type":4,"Flags":0}}}},{"2":{"Name":"BoxPlotVisual","Properties":{"Actions":{"Type":620,"Flags":0},"ChartConfiguration":{"Type":52,"Flags":0},"ColumnHierarchies":{"Type":621,"Flags":0},"Subtitle":{"Type":575,"Flags":0},"Title":{"Type":576,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"CalculatedField","Properties":{"DataSetIdentifier":{"Type":4,"Flags":1},"Expression":{"Type":4,"Flags":1},"Name":{"Type":4,"Flags":1}}}},{"2":{"Name":"CalculatedMeasureField","Properties":{"Expression":{"Type":4,"Flags":1},"FieldId":{"Type":4,"Flags":1}}}},{"2":{"Name":"CascadingControlConfiguration","Properties":{"SourceControls":{"Type":622,"Flags":0}}}},{"2":{"Name":"CascadingControlSource","Properties":{"ColumnToMatch":{"Type":79,"Flags":0},"SourceSheetControlId":{"Type":4,"Flags":0}}}},{"2":{"Name":"CategoricalAggregationFunction"}},{"2":{"Name":"CategoricalDimensionField","Properties":{"Column":{"Type":79,"Flags":1},"FieldId":{"Type":4,"Flags":1},"FormatConfiguration":{"Type":490,"Flags":0},"HierarchyId":{"Type":4,"Flags":0}}}},{"2":{"Name":"CategoricalMeasureField","Properties":{"AggregationFunction":{"Type":4,"Flags":0},"Column":{"Type":79,"Flags":1},"FieldId":{"Type":4,"Flags":1},"FormatConfiguration":{"Type":490,"Flags":0}}}},{"2":{"Name":"CategoryDrillDownFilter","Properties":{"CategoryValues":{"Type":623,"Flags":1},"Column":{"Type":79,"Flags":1}}}},{"2":{"Name":"CategoryFilter","Properties":{"Column":{"Type":79,"Flags":1},"Configuration":{"Type":68,"Flags":1},"FilterId":{"Type":4,"Flags":1}}}},{"2":{"Name":"CategoryFilterConfiguration","Properties":{"CustomFilterConfiguration":{"Type":114,"Flags":0},"CustomFilterListConfiguration":{"Type":115,"Flags":0},"FilterListConfiguration":{"Type":187,"Flags":0}}}},{"2":{"Name":"CategoryFilterMatchOperator"}},{"2":{"Name":"CategoryFilterSelectAllOptions"}},{"2":{"Name":"ChartAxisLabelOptions","Properties":{"AxisLabelOptions":{"Type":624,"Flags":0},"SortIconVisibility":{"Type":4,"Flags":0},"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"ClusterMarker","Properties":{"SimpleClusterMarker":{"Type":478,"Flags":0}}}},{"2":{"Name":"ClusterMarkerConfiguration","Properties":{"ClusterMarker":{"Type":72,"Flags":0}}}},{"2":{"Name":"ColorFillType"}},{"2":{"Name":"ColorScale","Properties":{"ColorFillType":{"Type":4,"Flags":1},"Colors":{"Type":625,"Flags":1},"NullValueColor":{"Type":120,"Flags":0}}}},{"2":{"Name":"ColorsConfiguration","Properties":{"CustomColors":{"Type":626,"Flags":0}}}},{"2":{"Name":"ColumnConfiguration","Properties":{"ColorsConfiguration":{"Type":76,"Flags":0},"Column":{"Type":79,"Flags":1},"FormatConfiguration":{"Type":209,"Flags":0},"Role":{"Type":4,"Flags":0}}}},{"2":{"Name":"ColumnHierarchy","Properties":{"DateTimeHierarchy":{"Type":140,"Flags":0},"ExplicitHierarchy":{"Type":167,"Flags":0},"PredefinedHierarchy":{"Type":400,"Flags":0}}}},{"2":{"Name":"ColumnIdentifier","Properties":{"ColumnName":{"Type":4,"Flags":1},"DataSetIdentifier":{"Type":4,"Flags":1}}}},{"2":{"Name":"ColumnRole"}},{"2":{"Name":"ColumnSort","Properties":{"AggregationFunction":{"Type":8,"Flags":0},"Direction":{"Type":4,"Flags":1},"SortBy":{"Type":79,"Flags":1}}}},{"2":{"Name":"ColumnTooltipItem","Properties":{"Aggregation":{"Type":8,"Flags":0},"Column":{"Type":79,"Flags":1},"Label":{"Type":4,"Flags":0},"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"ComboChartAggregatedFieldWells","Properties":{"BarValues":{"Type":627,"Flags":0},"Category":{"Type":628,"Flags":0},"Colors":{"Type":629,"Flags":0},"LineValues":{"Type":630,"Flags":0}}}},{"2":{"Name":"ComboChartConfiguration","Properties":{"BarDataLabels":{"Type":123,"Flags":0},"BarsArrangement":{"Type":4,"Flags":0},"CategoryAxis":{"Type":31,"Flags":0},"CategoryLabelOptions":{"Type":71,"Flags":0},"ColorLabelOptions":{"Type":71,"Flags":0},"FieldWells":{"Type":85,"Flags":0},"Legend":{"Type":293,"Flags":0},"LineDataLabels":{"Type":123,"Flags":0},"PrimaryYAxisDisplayOptions":{"Type":31,"Flags":0},"PrimaryYAxisLabelOptions":{"Type":71,"Flags":0},"ReferenceLines":{"Type":631,"Flags":0},"SecondaryYAxisDisplayOptions":{"Type":31,"Flags":0},"SecondaryYAxisLabelOptions":{"Type":71,"Flags":0},"SortConfiguration":{"Type":86,"Flags":0},"Tooltip":{"Type":544,"Flags":0},"VisualPalette":{"Type":574,"Flags":0}}}},{"2":{"Name":"ComboChartFieldWells","Properties":{"ComboChartAggregatedFieldWells":{"Type":83,"Flags":0}}}},{"2":{"Name":"ComboChartSortConfiguration","Properties":{"CategoryItemsLimit":{"Type":272,"Flags":0},"CategorySort":{"Type":632,"Flags":0},"ColorItemsLimit":{"Type":272,"Flags":0},"ColorSort":{"Type":633,"Flags":0}}}},{"2":{"Name":"ComboChartVisual","Properties":{"Actions":{"Type":634,"Flags":0},"ChartConfiguration":{"Type":84,"Flags":0},"ColumnHierarchies":{"Type":635,"Flags":0},"Subtitle":{"Type":575,"Flags":0},"Title":{"Type":576,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"ComparisonConfiguration","Properties":{"ComparisonFormat":{"Type":89,"Flags":0},"ComparisonMethod":{"Type":4,"Flags":0}}}},{"2":{"Name":"ComparisonFormatConfiguration","Properties":{"NumberDisplayFormatConfiguration":{"Type":328,"Flags":0},"PercentageDisplayFormatConfiguration":{"Type":363,"Flags":0}}}},{"2":{"Name":"ComparisonMethod"}},{"2":{"Name":"Computation","Properties":{"Forecast":{"Type":205,"Flags":0},"GrowthRate":{"Type":251,"Flags":0},"MaximumMinimum":{"Type":318,"Flags":0},"MetricComparison":{"Type":321,"Flags":0},"PeriodOverPeriod":{"Type":365,"Flags":0},"PeriodToDate":{"Type":366,"Flags":0},"TopBottomMovers":{"Type":548,"Flags":0},"TopBottomRanked":{"Type":549,"Flags":0},"TotalAggregation":{"Type":551,"Flags":0},"UniqueValues":{"Type":563,"Flags":0}}}},{"2":{"Name":"ConditionalFormattingColor","Properties":{"Gradient":{"Type":95,"Flags":0},"Solid":{"Type":101,"Flags":0}}}},{"2":{"Name":"ConditionalFormattingCustomIconCondition","Properties":{"Color":{"Type":4,"Flags":0},"DisplayConfiguration":{"Type":97,"Flags":0},"Expression":{"Type":4,"Flags":1},"IconOptions":{"Type":94,"Flags":1}}}},{"2":{"Name":"ConditionalFormattingCustomIconOptions","Properties":{"Icon":{"Type":4,"Flags":0},"UnicodeIcon":{"Type":4,"Flags":0}}}},{"2":{"Name":"ConditionalFormattingGradientColor","Properties":{"Color":{"Type":245,"Flags":1},"Expression":{"Type":4,"Flags":1}}}},{"2":{"Name":"ConditionalFormattingIcon","Properties":{"CustomCondition":{"Type":93,"Flags":0},"IconSet":{"Type":99,"Flags":0}}}},{"2":{"Name":"ConditionalFormattingIconDisplayConfiguration","Properties":{"IconDisplayOption":{"Type":4,"Flags":0}}}},{"2":{"Name":"ConditionalFormattingIconDisplayOption"}},{"2":{"Name":"ConditionalFormattingIconSet","Properties":{"Expression":{"Type":4,"Flags":1},"IconSetType":{"Type":4,"Flags":0}}}},{"2":{"Name":"ConditionalFormattingIconSetType"}},{"2":{"Name":"ConditionalFormattingSolidColor","Properties":{"Color":{"Type":4,"Flags":0},"Expression":{"Type":4,"Flags":1}}}},{"2":{"Name":"ContributionAnalysisDefault","Properties":{"ContributorDimensions":{"Type":636,"Flags":1},"MeasureFieldId":{"Type":4,"Flags":1}}}},{"2":{"Name":"CrossDatasetTypes"}},{"2":{"Name":"CurrencyDisplayFormatConfiguration","Properties":{"DecimalPlacesConfiguration":{"Type":149,"Flags":0},"NegativeValueConfiguration":{"Type":325,"Flags":0},"NullValueFormatConfiguration":{"Type":327,"Flags":0},"NumberScale":{"Type":4,"Flags":0},"Prefix":{"Type":4,"Flags":0},"SeparatorConfiguration":{"Type":339,"Flags":0},"Suffix":{"Type":4,"Flags":0},"Symbol":{"Type":4,"Flags":0}}}},{"2":{"Name":"CustomActionFilterOperation","Properties":{"SelectedFieldsConfiguration":{"Type":190,"Flags":1},"TargetVisualsConfiguration":{"Type":191,"Flags":1}}}},{"2":{"Name":"CustomActionNavigationOperation","Properties":{"LocalNavigationConfiguration":{"Type":313,"Flags":0}}}},{"2":{"Name":"CustomActionSetParametersOperation","Properties":{"ParameterValueConfigurations":{"Type":637,"Flags":1}}}},{"2":{"Name":"CustomActionURLOperation","Properties":{"URLTarget":{"Type":4,"Flags":1},"URLTemplate":{"Type":4,"Flags":1}}}},{"2":{"Name":"CustomColor","Properties":{"Color":{"Type":4,"Flags":1},"FieldValue":{"Type":4,"Flags":0},"SpecialValue":{"Type":4,"Flags":0}}}},{"2":{"Name":"CustomContentConfiguration","Properties":{"ContentType":{"Type":4,"Flags":0},"ContentUrl":{"Type":4,"Flags":0},"ImageScaling":{"Type":4,"Flags":0}}}},{"2":{"Name":"CustomContentImageScalingConfiguration"}},{"2":{"Name":"CustomContentType"}},{"2":{"Name":"CustomContentVisual","Properties":{"Actions":{"Type":638,"Flags":0},"ChartConfiguration":{"Type":110,"Flags":0},"DataSetIdentifier":{"Type":4,"Flags":1},"Subtitle":{"Type":575,"Flags":0},"Title":{"Type":576,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"CustomFilterConfiguration","Properties":{"CategoryValue":{"Type":4,"Flags":0},"MatchOperator":{"Type":4,"Flags":1},"NullOption":{"Type":4,"Flags":1},"ParameterName":{"Type":4,"Flags":0},"SelectAllOptions":{"Type":4,"Flags":0}}}},{"2":{"Name":"CustomFilterListConfiguration","Properties":{"CategoryValues":{"Type":639,"Flags":0},"MatchOperator":{"Type":4,"Flags":1},"NullOption":{"Type":4,"Flags":1},"SelectAllOptions":{"Type":4,"Flags":0}}}},{"2":{"Name":"CustomNarrativeOptions","Properties":{"Narrative":{"Type":4,"Flags":1}}}},{"2":{"Name":"CustomParameterValues","Properties":{"DateTimeValues":{"Type":640,"Flags":0},"DecimalValues":{"Type":641,"Flags":0},"IntegerValues":{"Type":642,"Flags":0},"StringValues":{"Type":643,"Flags":0}}}},{"2":{"Name":"CustomValuesConfiguration","Properties":{"CustomValues":{"Type":117,"Flags":1},"IncludeNullValue":{"Type":2,"Flags":0}}}},{"2":{"Name":"DataBarsOptions","Properties":{"FieldId":{"Type":4,"Flags":1},"NegativeColor":{"Type":4,"Flags":0},"PositiveColor":{"Type":4,"Flags":0}}}},{"2":{"Name":"DataColor","Properties":{"Color":{"Type":4,"Flags":0},"DataValue":{"Type":3,"Flags":0}}}},{"2":{"Name":"DataFieldSeriesItem","Properties":{"AxisBinding":{"Type":4,"Flags":1},"FieldId":{"Type":4,"Flags":1},"FieldValue":{"Type":4,"Flags":0},"Settings":{"Type":303,"Flags":0}}}},{"2":{"Name":"DataLabelContent"}},{"2":{"Name":"DataLabelOptions","Properties":{"CategoryLabelVisibility":{"Type":4,"Flags":0},"DataLabelTypes":{"Type":644,"Flags":0},"LabelColor":{"Type":4,"Flags":0},"LabelContent":{"Type":4,"Flags":0},"LabelFontConfiguration":{"Type":199,"Flags":0},"MeasureLabelVisibility":{"Type":4,"Flags":0},"Overlap":{"Type":4,"Flags":0},"Position":{"Type":4,"Flags":0},"TotalsVisibility":{"Type":4,"Flags":0},"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"DataLabelOverlap"}},{"2":{"Name":"DataLabelPosition"}},{"2":{"Name":"DataLabelType","Properties":{"DataPathLabelType":{"Type":128,"Flags":0},"FieldLabelType":{"Type":169,"Flags":0},"MaximumLabelType":{"Type":317,"Flags":0},"MinimumLabelType":{"Type":322,"Flags":0},"RangeEndsLabelType":{"Type":412,"Flags":0}}}},{"2":{"Name":"DataPathColor","Properties":{"Color":{"Type":4,"Flags":1},"Element":{"Type":131,"Flags":1},"TimeGranularity":{"Type":4,"Flags":0}}}},{"2":{"Name":"DataPathLabelType","Properties":{"FieldId":{"Type":4,"Flags":0},"FieldValue":{"Type":4,"Flags":0},"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"DataPathSort","Properties":{"Direction":{"Type":4,"Flags":1},"SortPaths":{"Type":645,"Flags":1}}}},{"2":{"Name":"DataPathType","Properties":{"PivotTableDataPathType":{"Type":4,"Flags":0}}}},{"2":{"Name":"DataPathValue","Properties":{"DataPathType":{"Type":130,"Flags":0},"FieldId":{"Type":4,"Flags":0},"FieldValue":{"Type":4,"Flags":0}}}},{"2":{"Name":"DataSetIdentifierDeclaration","Properties":{"DataSetArn":{"Type":4,"Flags":1},"Identifier":{"Type":4,"Flags":1}}}},{"2":{"Name":"DataSetReference","Properties":{"DataSetArn":{"Type":4,"Flags":1},"DataSetPlaceholder":{"Type":4,"Flags":1}}}},{"2":{"Name":"DateAggregationFunction"}},{"2":{"Name":"DateAxisOptions","Properties":{"MissingDateVisibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"DateDimensionField","Properties":{"Column":{"Type":79,"Flags":1},"DateGranularity":{"Type":4,"Flags":0},"FieldId":{"Type":4,"Flags":1},"FormatConfiguration":{"Type":139,"Flags":0},"HierarchyId":{"Type":4,"Flags":0}}}},{"2":{"Name":"DateMeasureField","Properties":{"AggregationFunction":{"Type":4,"Flags":0},"Column":{"Type":79,"Flags":1},"FieldId":{"Type":4,"Flags":1},"FormatConfiguration":{"Type":139,"Flags":0}}}},{"2":{"Name":"DateTimeDefaultValues","Properties":{"DynamicValue":{"Type":163,"Flags":0},"RollingDate":{"Type":433,"Flags":0},"StaticValues":{"Type":646,"Flags":0}}}},{"2":{"Name":"DateTimeFormatConfiguration","Properties":{"DateTimeFormat":{"Type":4,"Flags":0},"NullValueFormatConfiguration":{"Type":327,"Flags":0},"NumericFormatConfiguration":{"Type":336,"Flags":0}}}},{"2":{"Name":"DateTimeHierarchy","Properties":{"DrillDownFilters":{"Type":647,"Flags":0},"HierarchyId":{"Type":4,"Flags":1}}}},{"2":{"Name":"DateTimeParameter","Properties":{"Name":{"Type":4,"Flags":1},"Values":{"Type":648,"Flags":1}}}},{"2":{"Name":"DateTimeParameterDeclaration","Properties":{"DefaultValues":{"Type":138,"Flags":0},"MappedDataSetParameters":{"Type":649,"Flags":0},"Name":{"Type":4,"Flags":1},"TimeGranularity":{"Type":4,"Flags":0},"ValueWhenUnset":{"Type":144,"Flags":0}}}},{"2":{"Name":"DateTimePickerControlDisplayOptions","Properties":{"DateTimeFormat":{"Type":4,"Flags":0},"InfoIconLabelOptions":{"Type":466,"Flags":0},"TitleOptions":{"Type":289,"Flags":0}}}},{"2":{"Name":"DateTimeValueWhenUnsetConfiguration","Properties":{"CustomValue":{"Type":4,"Flags":0},"ValueWhenUnsetOption":{"Type":4,"Flags":0}}}},{"2":{"Name":"DayOfTheWeek"}},{"2":{"Name":"DecimalDefaultValues","Properties":{"DynamicValue":{"Type":163,"Flags":0},"StaticValues":{"Type":650,"Flags":0}}}},{"2":{"Name":"DecimalParameter","Properties":{"Name":{"Type":4,"Flags":1},"Values":{"Type":651,"Flags":1}}}},{"2":{"Name":"DecimalParameterDeclaration","Properties":{"DefaultValues":{"Type":146,"Flags":0},"MappedDataSetParameters":{"Type":652,"Flags":0},"Name":{"Type":4,"Flags":1},"ParameterValueType":{"Type":4,"Flags":1},"ValueWhenUnset":{"Type":150,"Flags":0}}}},{"2":{"Name":"DecimalPlacesConfiguration","Properties":{"DecimalPlaces":{"Type":3,"Flags":1}}}},{"2":{"Name":"DecimalValueWhenUnsetConfiguration","Properties":{"CustomValue":{"Type":3,"Flags":0},"ValueWhenUnsetOption":{"Type":4,"Flags":0}}}},{"2":{"Name":"DefaultFreeFormLayoutConfiguration","Properties":{"CanvasSizeOptions":{"Type":210,"Flags":1}}}},{"2":{"Name":"DefaultGridLayoutConfiguration","Properties":{"CanvasSizeOptions":{"Type":247,"Flags":1}}}},{"2":{"Name":"DefaultInteractiveLayoutConfiguration","Properties":{"FreeForm":{"Type":151,"Flags":0},"Grid":{"Type":152,"Flags":0}}}},{"2":{"Name":"DefaultNewSheetConfiguration","Properties":{"InteractiveLayoutConfiguration":{"Type":153,"Flags":0},"PaginatedLayoutConfiguration":{"Type":155,"Flags":0},"SheetContentType":{"Type":4,"Flags":0}}}},{"2":{"Name":"DefaultPaginatedLayoutConfiguration","Properties":{"SectionBased":{"Type":156,"Flags":0}}}},{"2":{"Name":"DefaultSectionBasedLayoutConfiguration","Properties":{"CanvasSizeOptions":{"Type":449,"Flags":1}}}},{"2":{"Name":"DestinationParameterValueConfiguration","Properties":{"CustomValuesConfiguration":{"Type":118,"Flags":0},"SelectAllValueOptions":{"Type":4,"Flags":0},"SourceColumn":{"Type":79,"Flags":0},"SourceField":{"Type":4,"Flags":0},"SourceParameterName":{"Type":4,"Flags":0}}}},{"2":{"Name":"DimensionField","Properties":{"CategoricalDimensionField":{"Type":64,"Flags":0},"DateDimensionField":{"Type":136,"Flags":0},"NumericalDimensionField":{"Type":342,"Flags":0}}}},{"2":{"Name":"DonutCenterOptions","Properties":{"LabelVisibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"DonutOptions","Properties":{"ArcOptions":{"Type":22,"Flags":0},"DonutCenterOptions":{"Type":159,"Flags":0}}}},{"2":{"Name":"DrillDownFilter","Properties":{"CategoryFilter":{"Type":66,"Flags":0},"NumericEqualityFilter":{"Type":332,"Flags":0},"TimeRangeFilter":{"Type":540,"Flags":0}}}},{"2":{"Name":"DropDownControlDisplayOptions","Properties":{"InfoIconLabelOptions":{"Type":466,"Flags":0},"SelectAllOptions":{"Type":311,"Flags":0},"TitleOptions":{"Type":289,"Flags":0}}}},{"2":{"Name":"DynamicDefaultValue","Properties":{"DefaultValueColumn":{"Type":79,"Flags":1},"GroupNameColumn":{"Type":79,"Flags":0},"UserNameColumn":{"Type":79,"Flags":0}}}},{"2":{"Name":"EmptyVisual","Properties":{"Actions":{"Type":653,"Flags":0},"DataSetIdentifier":{"Type":4,"Flags":1},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"Entity","Properties":{"Path":{"Type":4,"Flags":0}}}},{"2":{"Name":"ExcludePeriodConfiguration","Properties":{"Amount":{"Type":3,"Flags":1},"Granularity":{"Type":4,"Flags":1},"Status":{"Type":4,"Flags":0}}}},{"2":{"Name":"ExplicitHierarchy","Properties":{"Columns":{"Type":654,"Flags":1},"DrillDownFilters":{"Type":655,"Flags":0},"HierarchyId":{"Type":4,"Flags":1}}}},{"2":{"Name":"FieldBasedTooltip","Properties":{"AggregationVisibility":{"Type":4,"Flags":0},"TooltipFields":{"Type":656,"Flags":0},"TooltipTitleType":{"Type":4,"Flags":0}}}},{"2":{"Name":"FieldLabelType","Properties":{"FieldId":{"Type":4,"Flags":0},"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"FieldSeriesItem","Properties":{"AxisBinding":{"Type":4,"Flags":1},"FieldId":{"Type":4,"Flags":1},"Settings":{"Type":303,"Flags":0}}}},{"2":{"Name":"FieldSort","Properties":{"Direction":{"Type":4,"Flags":1},"FieldId":{"Type":4,"Flags":1}}}},{"2":{"Name":"FieldSortOptions","Properties":{"ColumnSort":{"Type":81,"Flags":0},"FieldSort":{"Type":171,"Flags":0}}}},{"2":{"Name":"FieldTooltipItem","Properties":{"FieldId":{"Type":4,"Flags":1},"Label":{"Type":4,"Flags":0},"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"FilledMapAggregatedFieldWells","Properties":{"Geospatial":{"Type":657,"Flags":0},"Values":{"Type":658,"Flags":0}}}},{"2":{"Name":"FilledMapConditionalFormatting","Properties":{"ConditionalFormattingOptions":{"Type":659,"Flags":1}}}},{"2":{"Name":"FilledMapConditionalFormattingOption","Properties":{"Shape":{"Type":179,"Flags":1}}}},{"2":{"Name":"FilledMapConfiguration","Properties":{"FieldWells":{"Type":178,"Flags":0},"Legend":{"Type":293,"Flags":0},"MapStyleOptions":{"Type":239,"Flags":0},"SortConfiguration":{"Type":180,"Flags":0},"Tooltip":{"Type":544,"Flags":0},"WindowOptions":{"Type":243,"Flags":0}}}},{"2":{"Name":"FilledMapFieldWells","Properties":{"FilledMapAggregatedFieldWells":{"Type":174,"Flags":0}}}},{"2":{"Name":"FilledMapShapeConditionalFormatting","Properties":{"FieldId":{"Type":4,"Flags":1},"Format":{"Type":462,"Flags":0}}}},{"2":{"Name":"FilledMapSortConfiguration","Properties":{"CategorySort":{"Type":660,"Flags":0}}}},{"2":{"Name":"FilledMapVisual","Properties":{"Actions":{"Type":661,"Flags":0},"ChartConfiguration":{"Type":177,"Flags":0},"ColumnHierarchies":{"Type":662,"Flags":0},"ConditionalFormatting":{"Type":175,"Flags":0},"Subtitle":{"Type":575,"Flags":0},"Title":{"Type":576,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"Filter","Properties":{"CategoryFilter":{"Type":67,"Flags":0},"NumericEqualityFilter":{"Type":333,"Flags":0},"NumericRangeFilter":{"Type":337,"Flags":0},"RelativeDatesFilter":{"Type":428,"Flags":0},"TimeEqualityFilter":{"Type":538,"Flags":0},"TimeRangeFilter":{"Type":541,"Flags":0},"TopBottomFilter":{"Type":547,"Flags":0}}}},{"2":{"Name":"FilterControl","Properties":{"DateTimePicker":{"Type":184,"Flags":0},"Dropdown":{"Type":185,"Flags":0},"List":{"Type":188,"Flags":0},"RelativeDateTime":{"Type":192,"Flags":0},"Slider":{"Type":195,"Flags":0},"TextArea":{"Type":196,"Flags":0},"TextField":{"Type":197,"Flags":0}}}},{"2":{"Name":"FilterDateTimePickerControl","Properties":{"DisplayOptions":{"Type":143,"Flags":0},"FilterControlId":{"Type":4,"Flags":1},"SourceFilterId":{"Type":4,"Flags":1},"Title":{"Type":4,"Flags":1},"Type":{"Type":4,"Flags":0}}}},{"2":{"Name":"FilterDropDownControl","Properties":{"CascadingControlConfiguration":{"Type":61,"Flags":0},"DisplayOptions":{"Type":162,"Flags":0},"FilterControlId":{"Type":4,"Flags":1},"SelectableValues":{"Type":194,"Flags":0},"SourceFilterId":{"Type":4,"Flags":1},"Title":{"Type":4,"Flags":1},"Type":{"Type":4,"Flags":0}}}},{"2":{"Name":"FilterGroup","Properties":{"CrossDataset":{"Type":4,"Flags":1},"FilterGroupId":{"Type":4,"Flags":1},"Filters":{"Type":663,"Flags":1},"ScopeConfiguration":{"Type":193,"Flags":1},"Status":{"Type":4,"Flags":0}}}},{"2":{"Name":"FilterListConfiguration","Properties":{"CategoryValues":{"Type":664,"Flags":0},"MatchOperator":{"Type":4,"Flags":1},"NullOption":{"Type":4,"Flags":0},"SelectAllOptions":{"Type":4,"Flags":0}}}},{"2":{"Name":"FilterListControl","Properties":{"CascadingControlConfiguration":{"Type":61,"Flags":0},"DisplayOptions":{"Type":309,"Flags":0},"FilterControlId":{"Type":4,"Flags":1},"SelectableValues":{"Type":194,"Flags":0},"SourceFilterId":{"Type":4,"Flags":1},"Title":{"Type":4,"Flags":1},"Type":{"Type":4,"Flags":0}}}},{"2":{"Name":"FilterNullOption"}},{"2":{"Name":"FilterOperationSelectedFieldsConfiguration","Properties":{"SelectedColumns":{"Type":665,"Flags":0},"SelectedFieldOptions":{"Type":4,"Flags":0},"SelectedFields":{"Type":666,"Flags":0}}}},{"2":{"Name":"FilterOperationTargetVisualsConfiguration","Properties":{"SameSheetTargetVisualConfiguration":{"Type":435,"Flags":0}}}},{"2":{"Name":"FilterRelativeDateTimeControl","Properties":{"DisplayOptions":{"Type":426,"Flags":0},"FilterControlId":{"Type":4,"Flags":1},"SourceFilterId":{"Type":4,"Flags":1},"Title":{"Type":4,"Flags":1}}}},{"2":{"Name":"FilterScopeConfiguration","Properties":{"AllSheets":{"Type":10,"Flags":0},"SelectedSheets":{"Type":458,"Flags":0}}}},{"2":{"Name":"FilterSelectableValues","Properties":{"Values":{"Type":667,"Flags":0}}}},{"2":{"Name":"FilterSliderControl","Properties":{"DisplayOptions":{"Type":481,"Flags":0},"FilterControlId":{"Type":4,"Flags":1},"MaximumValue":{"Type":3,"Flags":1},"MinimumValue":{"Type":3,"Flags":1},"SourceFilterId":{"Type":4,"Flags":1},"StepSize":{"Type":3,"Flags":1},"Title":{"Type":4,"Flags":1},"Type":{"Type":4,"Flags":0}}}},{"2":{"Name":"FilterTextAreaControl","Properties":{"Delimiter":{"Type":4,"Flags":0},"DisplayOptions":{"Type":531,"Flags":0},"FilterControlId":{"Type":4,"Flags":1},"SourceFilterId":{"Type":4,"Flags":1},"Title":{"Type":4,"Flags":1}}}},{"2":{"Name":"FilterTextFieldControl","Properties":{"DisplayOptions":{"Type":534,"Flags":0},"FilterControlId":{"Type":4,"Flags":1},"SourceFilterId":{"Type":4,"Flags":1},"Title":{"Type":4,"Flags":1}}}},{"2":{"Name":"FilterVisualScope"}},{"2":{"Name":"FontConfiguration","Properties":{"FontColor":{"Type":4,"Flags":0},"FontDecoration":{"Type":4,"Flags":0},"FontSize":{"Type":201,"Flags":0},"FontStyle":{"Type":4,"Flags":0},"FontWeight":{"Type":203,"Flags":0}}}},{"2":{"Name":"FontDecoration"}},{"2":{"Name":"FontSize","Properties":{"Relative":{"Type":4,"Flags":0}}}},{"2":{"Name":"FontStyle"}},{"2":{"Name":"FontWeight","Properties":{"Name":{"Type":4,"Flags":0}}}},{"2":{"Name":"FontWeightName"}},{"2":{"Name":"ForecastComputation","Properties":{"ComputationId":{"Type":4,"Flags":1},"CustomSeasonalityValue":{"Type":3,"Flags":0},"LowerBoundary":{"Type":3,"Flags":0},"Name":{"Type":4,"Flags":0},"PeriodsBackward":{"Type":3,"Flags":0},"PeriodsForward":{"Type":3,"Flags":0},"PredictionInterval":{"Type":3,"Flags":0},"Seasonality":{"Type":4,"Flags":0},"Time":{"Type":158,"Flags":0},"UpperBoundary":{"Type":3,"Flags":0},"Value":{"Type":320,"Flags":0}}}},{"2":{"Name":"ForecastComputationSeasonality"}},{"2":{"Name":"ForecastConfiguration","Properties":{"ForecastProperties":{"Type":537,"Flags":0},"Scenario":{"Type":208,"Flags":0}}}},{"2":{"Name":"ForecastScenario","Properties":{"WhatIfPointScenario":{"Type":583,"Flags":0},"WhatIfRangeScenario":{"Type":584,"Flags":0}}}},{"2":{"Name":"FormatConfiguration","Properties":{"DateTimeFormatConfiguration":{"Type":139,"Flags":0},"NumberFormatConfiguration":{"Type":329,"Flags":0},"StringFormatConfiguration":{"Type":490,"Flags":0}}}},{"2":{"Name":"FreeFormLayoutCanvasSizeOptions","Properties":{"ScreenCanvasSizeOptions":{"Type":215,"Flags":0}}}},{"2":{"Name":"FreeFormLayoutConfiguration","Properties":{"CanvasSizeOptions":{"Type":210,"Flags":0},"Elements":{"Type":668,"Flags":1}}}},{"2":{"Name":"FreeFormLayoutElement","Properties":{"BackgroundStyle":{"Type":213,"Flags":0},"BorderStyle":{"Type":214,"Flags":0},"ElementId":{"Type":4,"Flags":1},"ElementType":{"Type":4,"Flags":1},"Height":{"Type":4,"Flags":1,"Description":"String based length that is composed of value and unit in px"},"LoadingAnimation":{"Type":312,"Flags":0},"RenderingRules":{"Type":669,"Flags":0},"SelectedBorderStyle":{"Type":214,"Flags":0},"Visibility":{"Type":4,"Flags":0},"Width":{"Type":4,"Flags":1,"Description":"String based length that is composed of value and unit in px"},"XAxisLocation":{"Type":4,"Flags":1,"Description":"String based length that is composed of value and unit in px"},"YAxisLocation":{"Type":4,"Flags":1,"Description":"String based length that is composed of value and unit in px with Integer.MAX_VALUE as maximum value"}}}},{"2":{"Name":"FreeFormLayoutElementBackgroundStyle","Properties":{"Color":{"Type":4,"Flags":0},"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"FreeFormLayoutElementBorderStyle","Properties":{"Color":{"Type":4,"Flags":0},"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"FreeFormLayoutScreenCanvasSizeOptions","Properties":{"OptimizedViewPortWidth":{"Type":4,"Flags":1,"Description":"String based length that is composed of value and unit in px"}}}},{"2":{"Name":"FreeFormSectionLayoutConfiguration","Properties":{"Elements":{"Type":670,"Flags":1}}}},{"2":{"Name":"FunnelChartAggregatedFieldWells","Properties":{"Category":{"Type":671,"Flags":0},"Values":{"Type":672,"Flags":0}}}},{"2":{"Name":"FunnelChartConfiguration","Properties":{"CategoryLabelOptions":{"Type":71,"Flags":0},"DataLabelOptions":{"Type":219,"Flags":0},"FieldWells":{"Type":220,"Flags":0},"SortConfiguration":{"Type":222,"Flags":0},"Tooltip":{"Type":544,"Flags":0},"ValueLabelOptions":{"Type":71,"Flags":0},"VisualPalette":{"Type":574,"Flags":0}}}},{"2":{"Name":"FunnelChartDataLabelOptions","Properties":{"CategoryLabelVisibility":{"Type":4,"Flags":0},"LabelColor":{"Type":4,"Flags":0},"LabelFontConfiguration":{"Type":199,"Flags":0},"MeasureDataLabelStyle":{"Type":4,"Flags":0},"MeasureLabelVisibility":{"Type":4,"Flags":0},"Position":{"Type":4,"Flags":0},"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"FunnelChartFieldWells","Properties":{"FunnelChartAggregatedFieldWells":{"Type":217,"Flags":0}}}},{"2":{"Name":"FunnelChartMeasureDataLabelStyle"}},{"2":{"Name":"FunnelChartSortConfiguration","Properties":{"CategoryItemsLimit":{"Type":272,"Flags":0},"CategorySort":{"Type":673,"Flags":0}}}},{"2":{"Name":"FunnelChartVisual","Properties":{"Actions":{"Type":674,"Flags":0},"ChartConfiguration":{"Type":218,"Flags":0},"ColumnHierarchies":{"Type":675,"Flags":0},"Subtitle":{"Type":575,"Flags":0},"Title":{"Type":576,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"GaugeChartArcConditionalFormatting","Properties":{"ForegroundColor":{"Type":92,"Flags":0}}}},{"2":{"Name":"GaugeChartConditionalFormatting","Properties":{"ConditionalFormattingOptions":{"Type":676,"Flags":0}}}},{"2":{"Name":"GaugeChartConditionalFormattingOption","Properties":{"Arc":{"Type":224,"Flags":0},"PrimaryValue":{"Type":230,"Flags":0}}}},{"2":{"Name":"GaugeChartConfiguration","Properties":{"DataLabels":{"Type":123,"Flags":0},"FieldWells":{"Type":228,"Flags":0},"GaugeChartOptions":{"Type":229,"Flags":0},"TooltipOptions":{"Type":544,"Flags":0},"VisualPalette":{"Type":574,"Flags":0}}}},{"2":{"Name":"GaugeChartFieldWells","Properties":{"TargetValues":{"Type":677,"Flags":0},"Values":{"Type":678,"Flags":0}}}},{"2":{"Name":"GaugeChartOptions","Properties":{"Arc":{"Type":21,"Flags":0},"ArcAxis":{"Type":19,"Flags":0},"Comparison":{"Type":88,"Flags":0},"PrimaryValueDisplayType":{"Type":4,"Flags":0},"PrimaryValueFontConfiguration":{"Type":199,"Flags":0}}}},{"2":{"Name":"GaugeChartPrimaryValueConditionalFormatting","Properties":{"Icon":{"Type":96,"Flags":0},"TextColor":{"Type":92,"Flags":0}}}},{"2":{"Name":"GaugeChartVisual","Properties":{"Actions":{"Type":679,"Flags":0},"ChartConfiguration":{"Type":227,"Flags":0},"ConditionalFormatting":{"Type":225,"Flags":0},"Subtitle":{"Type":575,"Flags":0},"Title":{"Type":576,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"GeospatialCoordinateBounds","Properties":{"East":{"Type":3,"Flags":1},"North":{"Type":3,"Flags":1},"South":{"Type":3,"Flags":1},"West":{"Type":3,"Flags":1}}}},{"2":{"Name":"GeospatialHeatmapColorScale","Properties":{"Colors":{"Type":680,"Flags":0}}}},{"2":{"Name":"GeospatialHeatmapConfiguration","Properties":{"HeatmapColor":{"Type":233,"Flags":0}}}},{"2":{"Name":"GeospatialHeatmapDataColor","Properties":{"Color":{"Type":4,"Flags":1}}}},{"2":{"Name":"GeospatialMapAggregatedFieldWells","Properties":{"Colors":{"Type":681,"Flags":0},"Geospatial":{"Type":682,"Flags":0},"Values":{"Type":683,"Flags":0}}}},{"2":{"Name":"GeospatialMapConfiguration","Properties":{"FieldWells":{"Type":238,"Flags":0},"Legend":{"Type":293,"Flags":0},"MapStyleOptions":{"Type":239,"Flags":0},"PointStyleOptions":{"Type":241,"Flags":0},"Tooltip":{"Type":544,"Flags":0},"VisualPalette":{"Type":574,"Flags":0},"WindowOptions":{"Type":243,"Flags":0}}}},{"2":{"Name":"GeospatialMapFieldWells","Properties":{"GeospatialMapAggregatedFieldWells":{"Type":236,"Flags":0}}}},{"2":{"Name":"GeospatialMapStyleOptions","Properties":{"BaseMapStyle":{"Type":4,"Flags":0}}}},{"2":{"Name":"GeospatialMapVisual","Properties":{"Actions":{"Type":684,"Flags":0},"ChartConfiguration":{"Type":237,"Flags":0},"ColumnHierarchies":{"Type":685,"Flags":0},"Subtitle":{"Type":575,"Flags":0},"Title":{"Type":576,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"GeospatialPointStyleOptions","Properties":{"ClusterMarkerConfiguration":{"Type":73,"Flags":0},"HeatmapConfiguration":{"Type":234,"Flags":0},"SelectedPointStyle":{"Type":4,"Flags":0}}}},{"2":{"Name":"GeospatialSelectedPointStyle"}},{"2":{"Name":"GeospatialWindowOptions","Properties":{"Bounds":{"Type":232,"Flags":0},"MapZoomMode":{"Type":4,"Flags":0}}}},{"2":{"Name":"GlobalTableBorderOptions","Properties":{"SideSpecificBorder":{"Type":522,"Flags":0},"UniformBorder":{"Type":497,"Flags":0}}}},{"2":{"Name":"GradientColor","Properties":{"Stops":{"Type":686,"Flags":0}}}},{"2":{"Name":"GradientStop","Properties":{"Color":{"Type":4,"Flags":0},"DataValue":{"Type":3,"Flags":0},"GradientOffset":{"Type":3,"Flags":1}}}},{"2":{"Name":"GridLayoutCanvasSizeOptions","Properties":{"ScreenCanvasSizeOptions":{"Type":250,"Flags":0}}}},{"2":{"Name":"GridLayoutConfiguration","Properties":{"CanvasSizeOptions":{"Type":247,"Flags":0},"Elements":{"Type":687,"Flags":1}}}},{"2":{"Name":"GridLayoutElement","Properties":{"ColumnIndex":{"Type":3,"Flags":0},"ColumnSpan":{"Type":3,"Flags":1},"ElementId":{"Type":4,"Flags":1},"ElementType":{"Type":4,"Flags":1},"RowIndex":{"Type":3,"Flags":0},"RowSpan":{"Type":3,"Flags":1}}}},{"2":{"Name":"GridLayoutScreenCanvasSizeOptions","Properties":{"OptimizedViewPortWidth":{"Type":4,"Flags":0,"Description":"String based length that is composed of value and unit in px"},"ResizeOption":{"Type":4,"Flags":1}}}},{"2":{"Name":"GrowthRateComputation","Properties":{"ComputationId":{"Type":4,"Flags":1},"Name":{"Type":4,"Flags":0},"PeriodSize":{"Type":3,"Flags":0},"Time":{"Type":158,"Flags":0},"Value":{"Type":320,"Flags":0}}}},{"2":{"Name":"HeaderFooterSectionConfiguration","Properties":{"Layout":{"Type":452,"Flags":1},"SectionId":{"Type":4,"Flags":1},"Style":{"Type":455,"Flags":0}}}},{"2":{"Name":"HeatMapAggregatedFieldWells","Properties":{"Columns":{"Type":688,"Flags":0},"Rows":{"Type":689,"Flags":0},"Values":{"Type":690,"Flags":0}}}},{"2":{"Name":"HeatMapConfiguration","Properties":{"ColorScale":{"Type":75,"Flags":0},"ColumnLabelOptions":{"Type":71,"Flags":0},"DataLabels":{"Type":123,"Flags":0},"FieldWells":{"Type":255,"Flags":0},"Legend":{"Type":293,"Flags":0},"RowLabelOptions":{"Type":71,"Flags":0},"SortConfiguration":{"Type":256,"Flags":0},"Tooltip":{"Type":544,"Flags":0}}}},{"2":{"Name":"HeatMapFieldWells","Properties":{"HeatMapAggregatedFieldWells":{"Type":253,"Flags":0}}}},{"2":{"Name":"HeatMapSortConfiguration","Properties":{"HeatMapColumnItemsLimitConfiguration":{"Type":272,"Flags":0},"HeatMapColumnSort":{"Type":691,"Flags":0},"HeatMapRowItemsLimitConfiguration":{"Type":272,"Flags":0},"HeatMapRowSort":{"Type":692,"Flags":0}}}},{"2":{"Name":"HeatMapVisual","Properties":{"Actions":{"Type":693,"Flags":0},"ChartConfiguration":{"Type":254,"Flags":0},"ColumnHierarchies":{"Type":694,"Flags":0},"Subtitle":{"Type":575,"Flags":0},"Title":{"Type":576,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"HistogramAggregatedFieldWells","Properties":{"Values":{"Type":695,"Flags":0}}}},{"2":{"Name":"HistogramBinOptions","Properties":{"BinCount":{"Type":47,"Flags":0},"BinWidth":{"Type":48,"Flags":0},"SelectedBinType":{"Type":4,"Flags":0},"StartValue":{"Type":3,"Flags":0}}}},{"2":{"Name":"HistogramBinType"}},{"2":{"Name":"HistogramConfiguration","Properties":{"BinOptions":{"Type":259,"Flags":0},"DataLabels":{"Type":123,"Flags":0},"FieldWells":{"Type":262,"Flags":0},"Tooltip":{"Type":544,"Flags":0},"VisualPalette":{"Type":574,"Flags":0},"XAxisDisplayOptions":{"Type":31,"Flags":0},"XAxisLabelOptions":{"Type":71,"Flags":0},"YAxisDisplayOptions":{"Type":31,"Flags":0}}}},{"2":{"Name":"HistogramFieldWells","Properties":{"HistogramAggregatedFieldWells":{"Type":258,"Flags":0}}}},{"2":{"Name":"HistogramVisual","Properties":{"Actions":{"Type":696,"Flags":0},"ChartConfiguration":{"Type":261,"Flags":0},"Subtitle":{"Type":575,"Flags":0},"Title":{"Type":576,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"HorizontalTextAlignment"}},{"2":{"Name":"Icon"}},{"2":{"Name":"InsightConfiguration","Properties":{"Computations":{"Type":697,"Flags":0},"CustomNarrative":{"Type":116,"Flags":0}}}},{"2":{"Name":"InsightVisual","Properties":{"Actions":{"Type":698,"Flags":0},"DataSetIdentifier":{"Type":4,"Flags":1},"InsightConfiguration":{"Type":266,"Flags":0},"Subtitle":{"Type":575,"Flags":0},"Title":{"Type":576,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"IntegerDefaultValues","Properties":{"DynamicValue":{"Type":163,"Flags":0},"StaticValues":{"Type":699,"Flags":0}}}},{"2":{"Name":"IntegerParameter","Properties":{"Name":{"Type":4,"Flags":1},"Values":{"Type":700,"Flags":1}}}},{"2":{"Name":"IntegerParameterDeclaration","Properties":{"DefaultValues":{"Type":268,"Flags":0},"MappedDataSetParameters":{"Type":701,"Flags":0},"Name":{"Type":4,"Flags":1},"ParameterValueType":{"Type":4,"Flags":1},"ValueWhenUnset":{"Type":271,"Flags":0}}}},{"2":{"Name":"IntegerValueWhenUnsetConfiguration","Properties":{"CustomValue":{"Type":3,"Flags":0},"ValueWhenUnsetOption":{"Type":4,"Flags":0}}}},{"2":{"Name":"ItemsLimitConfiguration","Properties":{"ItemsLimit":{"Type":3,"Flags":0},"OtherCategories":{"Type":4,"Flags":0}}}},{"2":{"Name":"KPIActualValueConditionalFormatting","Properties":{"Icon":{"Type":96,"Flags":0},"TextColor":{"Type":92,"Flags":0}}}},{"2":{"Name":"KPIComparisonValueConditionalFormatting","Properties":{"Icon":{"Type":96,"Flags":0},"TextColor":{"Type":92,"Flags":0}}}},{"2":{"Name":"KPIConditionalFormatting","Properties":{"ConditionalFormattingOptions":{"Type":702,"Flags":0}}}},{"2":{"Name":"KPIConditionalFormattingOption","Properties":{"ActualValue":{"Type":273,"Flags":0},"ComparisonValue":{"Type":274,"Flags":0},"PrimaryValue":{"Type":280,"Flags":0},"ProgressBar":{"Type":281,"Flags":0}}}},{"2":{"Name":"KPIConfiguration","Properties":{"FieldWells":{"Type":278,"Flags":0},"KPIOptions":{"Type":279,"Flags":0},"SortConfiguration":{"Type":282,"Flags":0}}}},{"2":{"Name":"KPIFieldWells","Properties":{"TargetValues":{"Type":703,"Flags":0},"TrendGroups":{"Type":704,"Flags":0},"Values":{"Type":705,"Flags":0}}}},{"2":{"Name":"KPIOptions","Properties":{"Comparison":{"Type":88,"Flags":0},"PrimaryValueDisplayType":{"Type":4,"Flags":0},"PrimaryValueFontConfiguration":{"Type":199,"Flags":0},"ProgressBar":{"Type":402,"Flags":0},"SecondaryValue":{"Type":447,"Flags":0},"SecondaryValueFontConfiguration":{"Type":199,"Flags":0},"Sparkline":{"Type":283,"Flags":0},"TrendArrows":{"Type":560,"Flags":0},"VisualLayoutOptions":{"Type":286,"Flags":0}}}},{"2":{"Name":"KPIPrimaryValueConditionalFormatting","Properties":{"Icon":{"Type":96,"Flags":0},"TextColor":{"Type":92,"Flags":0}}}},{"2":{"Name":"KPIProgressBarConditionalFormatting","Properties":{"ForegroundColor":{"Type":92,"Flags":0}}}},{"2":{"Name":"KPISortConfiguration","Properties":{"TrendGroupSort":{"Type":706,"Flags":0}}}},{"2":{"Name":"KPISparklineOptions","Properties":{"Color":{"Type":4,"Flags":0},"TooltipVisibility":{"Type":4,"Flags":0},"Type":{"Type":4,"Flags":1},"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"KPISparklineType"}},{"2":{"Name":"KPIVisual","Properties":{"Actions":{"Type":707,"Flags":0},"ChartConfiguration":{"Type":277,"Flags":0},"ColumnHierarchies":{"Type":708,"Flags":0},"ConditionalFormatting":{"Type":275,"Flags":0},"Subtitle":{"Type":575,"Flags":0},"Title":{"Type":576,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"KPIVisualLayoutOptions","Properties":{"StandardLayout":{"Type":287,"Flags":0}}}},{"2":{"Name":"KPIVisualStandardLayout","Properties":{"Type":{"Type":4,"Flags":1}}}},{"2":{"Name":"KPIVisualStandardLayoutType"}},{"2":{"Name":"LabelOptions","Properties":{"CustomLabel":{"Type":4,"Flags":0},"FontConfiguration":{"Type":199,"Flags":0},"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"Layout","Properties":{"Configuration":{"Type":291,"Flags":1}}}},{"2":{"Name":"LayoutConfiguration","Properties":{"FreeFormLayout":{"Type":211,"Flags":0},"GridLayout":{"Type":248,"Flags":0},"SectionBasedLayout":{"Type":450,"Flags":0}}}},{"2":{"Name":"LayoutElementType"}},{"2":{"Name":"LegendOptions","Properties":{"Height":{"Type":4,"Flags":0,"Description":"String based length that is composed of value and unit in px"},"Position":{"Type":4,"Flags":0},"Title":{"Type":289,"Flags":0},"Visibility":{"Type":4,"Flags":0},"Width":{"Type":4,"Flags":0,"Description":"String based length that is composed of value and unit in px"}}}},{"2":{"Name":"LegendPosition"}},{"2":{"Name":"LineChartAggregatedFieldWells","Properties":{"Category":{"Type":709,"Flags":0},"Colors":{"Type":710,"Flags":0},"SmallMultiples":{"Type":711,"Flags":0},"Values":{"Type":712,"Flags":0}}}},{"2":{"Name":"LineChartConfiguration","Properties":{"ContributionAnalysisDefaults":{"Type":713,"Flags":0},"DataLabels":{"Type":123,"Flags":0},"DefaultSeriesSettings":{"Type":297,"Flags":0},"FieldWells":{"Type":298,"Flags":0},"ForecastConfigurations":{"Type":714,"Flags":0},"Legend":{"Type":293,"Flags":0},"PrimaryYAxisDisplayOptions":{"Type":308,"Flags":0},"PrimaryYAxisLabelOptions":{"Type":71,"Flags":0},"ReferenceLines":{"Type":715,"Flags":0},"SecondaryYAxisDisplayOptions":{"Type":308,"Flags":0},"SecondaryYAxisLabelOptions":{"Type":71,"Flags":0},"Series":{"Type":716,"Flags":0},"SmallMultiplesOptions":{"Type":485,"Flags":0},"SortConfiguration":{"Type":304,"Flags":0},"Tooltip":{"Type":544,"Flags":0},"Type":{"Type":4,"Flags":0},"VisualPalette":{"Type":574,"Flags":0},"XAxisDisplayOptions":{"Type":31,"Flags":0},"XAxisLabelOptions":{"Type":71,"Flags":0}}}},{"2":{"Name":"LineChartDefaultSeriesSettings","Properties":{"AxisBinding":{"Type":4,"Flags":0},"LineStyleSettings":{"Type":300,"Flags":0},"MarkerStyleSettings":{"Type":302,"Flags":0}}}},{"2":{"Name":"LineChartFieldWells","Properties":{"LineChartAggregatedFieldWells":{"Type":295,"Flags":0}}}},{"2":{"Name":"LineChartLineStyle"}},{"2":{"Name":"LineChartLineStyleSettings","Properties":{"LineInterpolation":{"Type":4,"Flags":0},"LineStyle":{"Type":4,"Flags":0},"LineVisibility":{"Type":4,"Flags":0},"LineWidth":{"Type":4,"Flags":0,"Description":"String based length that is composed of value and unit in px"}}}},{"2":{"Name":"LineChartMarkerShape"}},{"2":{"Name":"LineChartMarkerStyleSettings","Properties":{"MarkerColor":{"Type":4,"Flags":0},"MarkerShape":{"Type":4,"Flags":0},"MarkerSize":{"Type":4,"Flags":0,"Description":"String based length that is composed of value and unit in px"},"MarkerVisibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"LineChartSeriesSettings","Properties":{"LineStyleSettings":{"Type":300,"Flags":0},"MarkerStyleSettings":{"Type":302,"Flags":0}}}},{"2":{"Name":"LineChartSortConfiguration","Properties":{"CategoryItemsLimitConfiguration":{"Type":272,"Flags":0},"CategorySort":{"Type":717,"Flags":0},"ColorItemsLimitConfiguration":{"Type":272,"Flags":0},"SmallMultiplesLimitConfiguration":{"Type":272,"Flags":0},"SmallMultiplesSort":{"Type":718,"Flags":0}}}},{"2":{"Name":"LineChartType"}},{"2":{"Name":"LineChartVisual","Properties":{"Actions":{"Type":719,"Flags":0},"ChartConfiguration":{"Type":296,"Flags":0},"ColumnHierarchies":{"Type":720,"Flags":0},"Subtitle":{"Type":575,"Flags":0},"Title":{"Type":576,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"LineInterpolation"}},{"2":{"Name":"LineSeriesAxisDisplayOptions","Properties":{"AxisOptions":{"Type":31,"Flags":0},"MissingDataConfigurations":{"Type":721,"Flags":0}}}},{"2":{"Name":"ListControlDisplayOptions","Properties":{"InfoIconLabelOptions":{"Type":466,"Flags":0},"SearchOptions":{"Type":310,"Flags":0},"SelectAllOptions":{"Type":311,"Flags":0},"TitleOptions":{"Type":289,"Flags":0}}}},{"2":{"Name":"ListControlSearchOptions","Properties":{"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"ListControlSelectAllOptions","Properties":{"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"LoadingAnimation","Properties":{"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"LocalNavigationConfiguration","Properties":{"TargetSheetId":{"Type":4,"Flags":1}}}},{"2":{"Name":"LongFormatText","Properties":{"PlainText":{"Type":4,"Flags":0},"RichText":{"Type":4,"Flags":0}}}},{"2":{"Name":"MapZoomMode"}},{"2":{"Name":"MappedDataSetParameter","Properties":{"DataSetIdentifier":{"Type":4,"Flags":1},"DataSetParameterName":{"Type":4,"Flags":1}}}},{"2":{"Name":"MaximumLabelType","Properties":{"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"MaximumMinimumComputation","Properties":{"ComputationId":{"Type":4,"Flags":1},"Name":{"Type":4,"Flags":0},"Time":{"Type":158,"Flags":0},"Type":{"Type":4,"Flags":1},"Value":{"Type":320,"Flags":0}}}},{"2":{"Name":"MaximumMinimumComputationType"}},{"2":{"Name":"MeasureField","Properties":{"CalculatedMeasureField":{"Type":60,"Flags":0},"CategoricalMeasureField":{"Type":65,"Flags":0},"DateMeasureField":{"Type":137,"Flags":0},"NumericalMeasureField":{"Type":343,"Flags":0}}}},{"2":{"Name":"MetricComparisonComputation","Properties":{"ComputationId":{"Type":4,"Flags":1},"FromValue":{"Type":320,"Flags":0},"Name":{"Type":4,"Flags":0},"TargetValue":{"Type":320,"Flags":0},"Time":{"Type":158,"Flags":0}}}},{"2":{"Name":"MinimumLabelType","Properties":{"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"MissingDataConfiguration","Properties":{"TreatmentOption":{"Type":4,"Flags":0}}}},{"2":{"Name":"MissingDataTreatmentOption"}},{"2":{"Name":"NegativeValueConfiguration","Properties":{"DisplayMode":{"Type":4,"Flags":1}}}},{"2":{"Name":"NegativeValueDisplayMode"}},{"2":{"Name":"NullValueFormatConfiguration","Properties":{"NullString":{"Type":4,"Flags":1}}}},{"2":{"Name":"NumberDisplayFormatConfiguration","Properties":{"DecimalPlacesConfiguration":{"Type":149,"Flags":0},"NegativeValueConfiguration":{"Type":325,"Flags":0},"NullValueFormatConfiguration":{"Type":327,"Flags":0},"NumberScale":{"Type":4,"Flags":0},"Prefix":{"Type":4,"Flags":0},"SeparatorConfiguration":{"Type":339,"Flags":0},"Suffix":{"Type":4,"Flags":0}}}},{"2":{"Name":"NumberFormatConfiguration","Properties":{"FormatConfiguration":{"Type":336,"Flags":0}}}},{"2":{"Name":"NumberScale"}},{"2":{"Name":"NumericAxisOptions","Properties":{"Range":{"Type":32,"Flags":0},"Scale":{"Type":37,"Flags":0}}}},{"2":{"Name":"NumericEqualityDrillDownFilter","Properties":{"Column":{"Type":79,"Flags":1},"Value":{"Type":3,"Flags":1}}}},{"2":{"Name":"NumericEqualityFilter","Properties":{"AggregationFunction":{"Type":8,"Flags":0},"Column":{"Type":79,"Flags":1},"FilterId":{"Type":4,"Flags":1},"MatchOperator":{"Type":4,"Flags":1},"NullOption":{"Type":4,"Flags":1},"ParameterName":{"Type":4,"Flags":0},"SelectAllOptions":{"Type":4,"Flags":0},"Value":{"Type":3,"Flags":0}}}},{"2":{"Name":"NumericEqualityMatchOperator"}},{"2":{"Name":"NumericFilterSelectAllOptions"}},{"2":{"Name":"NumericFormatConfiguration","Properties":{"CurrencyDisplayFormatConfiguration":{"Type":104,"Flags":0},"NumberDisplayFormatConfiguration":{"Type":328,"Flags":0},"PercentageDisplayFormatConfiguration":{"Type":363,"Flags":0}}}},{"2":{"Name":"NumericRangeFilter","Properties":{"AggregationFunction":{"Type":8,"Flags":0},"Column":{"Type":79,"Flags":1},"FilterId":{"Type":4,"Flags":1},"IncludeMaximum":{"Type":2,"Flags":0},"IncludeMinimum":{"Type":2,"Flags":0},"NullOption":{"Type":4,"Flags":1},"RangeMaximum":{"Type":338,"Flags":0},"RangeMinimum":{"Type":338,"Flags":0},"SelectAllOptions":{"Type":4,"Flags":0}}}},{"2":{"Name":"NumericRangeFilterValue","Properties":{"Parameter":{"Type":4,"Flags":0},"StaticValue":{"Type":3,"Flags":0}}}},{"2":{"Name":"NumericSeparatorConfiguration","Properties":{"DecimalSeparator":{"Type":4,"Flags":0},"ThousandsSeparator":{"Type":536,"Flags":0}}}},{"2":{"Name":"NumericSeparatorSymbol"}},{"2":{"Name":"NumericalAggregationFunction","Properties":{"PercentileAggregation":{"Type":364,"Flags":0},"SimpleNumericalAggregation":{"Type":4,"Flags":0}}}},{"2":{"Name":"NumericalDimensionField","Properties":{"Column":{"Type":79,"Flags":1},"FieldId":{"Type":4,"Flags":1},"FormatConfiguration":{"Type":329,"Flags":0},"HierarchyId":{"Type":4,"Flags":0}}}},{"2":{"Name":"NumericalMeasureField","Properties":{"AggregationFunction":{"Type":341,"Flags":0},"Column":{"Type":79,"Flags":1},"FieldId":{"Type":4,"Flags":1},"FormatConfiguration":{"Type":329,"Flags":0}}}},{"2":{"Name":"OtherCategories"}},{"2":{"Name":"PaginationConfiguration","Properties":{"PageNumber":{"Type":3,"Flags":1},"PageSize":{"Type":3,"Flags":1}}}},{"2":{"Name":"PanelBorderStyle"}},{"2":{"Name":"PanelConfiguration","Properties":{"BackgroundColor":{"Type":4,"Flags":0},"BackgroundVisibility":{"Type":4,"Flags":0},"BorderColor":{"Type":4,"Flags":0},"BorderStyle":{"Type":4,"Flags":0},"BorderThickness":{"Type":4,"Flags":0,"Description":"String based length that is composed of value and unit in px"},"BorderVisibility":{"Type":4,"Flags":0},"GutterSpacing":{"Type":4,"Flags":0,"Description":"String based length that is composed of value and unit in px"},"GutterVisibility":{"Type":4,"Flags":0},"Title":{"Type":348,"Flags":0}}}},{"2":{"Name":"PanelTitleOptions","Properties":{"FontConfiguration":{"Type":199,"Flags":0},"HorizontalTextAlignment":{"Type":4,"Flags":0},"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"PaperOrientation"}},{"2":{"Name":"PaperSize"}},{"2":{"Name":"ParameterControl","Properties":{"DateTimePicker":{"Type":352,"Flags":0},"Dropdown":{"Type":354,"Flags":0},"List":{"Type":355,"Flags":0},"Slider":{"Type":357,"Flags":0},"TextArea":{"Type":358,"Flags":0},"TextField":{"Type":359,"Flags":0}}}},{"2":{"Name":"ParameterDateTimePickerControl","Properties":{"DisplayOptions":{"Type":143,"Flags":0},"ParameterControlId":{"Type":4,"Flags":1},"SourceParameterName":{"Type":4,"Flags":1},"Title":{"Type":4,"Flags":1}}}},{"2":{"Name":"ParameterDeclaration","Properties":{"DateTimeParameterDeclaration":{"Type":142,"Flags":0},"DecimalParameterDeclaration":{"Type":148,"Flags":0},"IntegerParameterDeclaration":{"Type":270,"Flags":0},"StringParameterDeclaration":{"Type":492,"Flags":0}}}},{"2":{"Name":"ParameterDropDownControl","Properties":{"CascadingControlConfiguration":{"Type":61,"Flags":0},"DisplayOptions":{"Type":162,"Flags":0},"ParameterControlId":{"Type":4,"Flags":1},"SelectableValues":{"Type":356,"Flags":0},"SourceParameterName":{"Type":4,"Flags":1},"Title":{"Type":4,"Flags":1},"Type":{"Type":4,"Flags":0}}}},{"2":{"Name":"ParameterListControl","Properties":{"CascadingControlConfiguration":{"Type":61,"Flags":0},"DisplayOptions":{"Type":309,"Flags":0},"ParameterControlId":{"Type":4,"Flags":1},"SelectableValues":{"Type":356,"Flags":0},"SourceParameterName":{"Type":4,"Flags":1},"Title":{"Type":4,"Flags":1},"Type":{"Type":4,"Flags":0}}}},{"2":{"Name":"ParameterSelectableValues","Properties":{"LinkToDataSetColumn":{"Type":79,"Flags":0},"Values":{"Type":722,"Flags":0}}}},{"2":{"Name":"ParameterSliderControl","Properties":{"DisplayOptions":{"Type":481,"Flags":0},"MaximumValue":{"Type":3,"Flags":1},"MinimumValue":{"Type":3,"Flags":1},"ParameterControlId":{"Type":4,"Flags":1},"SourceParameterName":{"Type":4,"Flags":1},"StepSize":{"Type":3,"Flags":1},"Title":{"Type":4,"Flags":1}}}},{"2":{"Name":"ParameterTextAreaControl","Properties":{"Delimiter":{"Type":4,"Flags":0},"DisplayOptions":{"Type":531,"Flags":0},"ParameterControlId":{"Type":4,"Flags":1},"SourceParameterName":{"Type":4,"Flags":1},"Title":{"Type":4,"Flags":1}}}},{"2":{"Name":"ParameterTextFieldControl","Properties":{"DisplayOptions":{"Type":534,"Flags":0},"ParameterControlId":{"Type":4,"Flags":1},"SourceParameterName":{"Type":4,"Flags":1},"Title":{"Type":4,"Flags":1}}}},{"2":{"Name":"ParameterValueType"}},{"2":{"Name":"Parameters","Properties":{"DateTimeParameters":{"Type":723,"Flags":0},"DecimalParameters":{"Type":724,"Flags":0},"IntegerParameters":{"Type":725,"Flags":0},"StringParameters":{"Type":726,"Flags":0}}}},{"2":{"Name":"PercentVisibleRange","Properties":{"From":{"Type":3,"Flags":0},"To":{"Type":3,"Flags":0}}}},{"2":{"Name":"PercentageDisplayFormatConfiguration","Properties":{"DecimalPlacesConfiguration":{"Type":149,"Flags":0},"NegativeValueConfiguration":{"Type":325,"Flags":0},"NullValueFormatConfiguration":{"Type":327,"Flags":0},"Prefix":{"Type":4,"Flags":0},"SeparatorConfiguration":{"Type":339,"Flags":0},"Suffix":{"Type":4,"Flags":0}}}},{"2":{"Name":"PercentileAggregation","Properties":{"PercentileValue":{"Type":3,"Flags":0}}}},{"2":{"Name":"PeriodOverPeriodComputation","Properties":{"ComputationId":{"Type":4,"Flags":1},"Name":{"Type":4,"Flags":0},"Time":{"Type":158,"Flags":0},"Value":{"Type":320,"Flags":0}}}},{"2":{"Name":"PeriodToDateComputation","Properties":{"ComputationId":{"Type":4,"Flags":1},"Name":{"Type":4,"Flags":0},"PeriodTimeGranularity":{"Type":4,"Flags":0},"Time":{"Type":158,"Flags":0},"Value":{"Type":320,"Flags":0}}}},{"2":{"Name":"PieChartAggregatedFieldWells","Properties":{"Category":{"Type":727,"Flags":0},"SmallMultiples":{"Type":728,"Flags":0},"Values":{"Type":729,"Flags":0}}}},{"2":{"Name":"PieChartConfiguration","Properties":{"CategoryLabelOptions":{"Type":71,"Flags":0},"ContributionAnalysisDefaults":{"Type":730,"Flags":0},"DataLabels":{"Type":123,"Flags":0},"DonutOptions":{"Type":160,"Flags":0},"FieldWells":{"Type":369,"Flags":0},"Legend":{"Type":293,"Flags":0},"SmallMultiplesOptions":{"Type":485,"Flags":0},"SortConfiguration":{"Type":370,"Flags":0},"Tooltip":{"Type":544,"Flags":0},"ValueLabelOptions":{"Type":71,"Flags":0},"VisualPalette":{"Type":574,"Flags":0}}}},{"2":{"Name":"PieChartFieldWells","Properties":{"PieChartAggregatedFieldWells":{"Type":367,"Flags":0}}}},{"2":{"Name":"PieChartSortConfiguration","Properties":{"CategoryItemsLimit":{"Type":272,"Flags":0},"CategorySort":{"Type":731,"Flags":0},"SmallMultiplesLimitConfiguration":{"Type":272,"Flags":0},"SmallMultiplesSort":{"Type":732,"Flags":0}}}},{"2":{"Name":"PieChartVisual","Properties":{"Actions":{"Type":733,"Flags":0},"ChartConfiguration":{"Type":368,"Flags":0},"ColumnHierarchies":{"Type":734,"Flags":0},"Subtitle":{"Type":575,"Flags":0},"Title":{"Type":576,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"PivotFieldSortOptions","Properties":{"FieldId":{"Type":4,"Flags":1},"SortBy":{"Type":394,"Flags":1}}}},{"2":{"Name":"PivotTableAggregatedFieldWells","Properties":{"Columns":{"Type":735,"Flags":0},"Rows":{"Type":736,"Flags":0},"Values":{"Type":737,"Flags":0}}}},{"2":{"Name":"PivotTableCellConditionalFormatting","Properties":{"FieldId":{"Type":4,"Flags":1},"Scope":{"Type":377,"Flags":0},"Scopes":{"Type":738,"Flags":0},"TextFormat":{"Type":532,"Flags":0}}}},{"2":{"Name":"PivotTableConditionalFormatting","Properties":{"ConditionalFormattingOptions":{"Type":739,"Flags":0}}}},{"2":{"Name":"PivotTableConditionalFormattingOption","Properties":{"Cell":{"Type":374,"Flags":0}}}},{"2":{"Name":"PivotTableConditionalFormattingScope","Properties":{"Role":{"Type":4,"Flags":0}}}},{"2":{"Name":"PivotTableConditionalFormattingScopeRole"}},{"2":{"Name":"PivotTableConfiguration","Properties":{"FieldOptions":{"Type":386,"Flags":0},"FieldWells":{"Type":388,"Flags":0},"PaginatedReportOptions":{"Type":391,"Flags":0},"SortConfiguration":{"Type":395,"Flags":0},"TableOptions":{"Type":390,"Flags":0},"TotalOptions":{"Type":397,"Flags":0}}}},{"2":{"Name":"PivotTableDataPathOption","Properties":{"DataPathList":{"Type":740,"Flags":1},"Width":{"Type":4,"Flags":0,"Description":"String based length that is composed of value and unit in px"}}}},{"2":{"Name":"PivotTableDataPathType"}},{"2":{"Name":"PivotTableFieldCollapseState"}},{"2":{"Name":"PivotTableFieldCollapseStateOption","Properties":{"State":{"Type":4,"Flags":0},"Target":{"Type":384,"Flags":1}}}},{"2":{"Name":"PivotTableFieldCollapseStateTarget","Properties":{"FieldDataPathValues":{"Type":741,"Flags":0},"FieldId":{"Type":4,"Flags":0}}}},{"2":{"Name":"PivotTableFieldOption","Properties":{"CustomLabel":{"Type":4,"Flags":0},"FieldId":{"Type":4,"Flags":1},"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"PivotTableFieldOptions","Properties":{"CollapseStateOptions":{"Type":742,"Flags":0},"DataPathOptions":{"Type":743,"Flags":0},"SelectedFieldOptions":{"Type":744,"Flags":0}}}},{"2":{"Name":"PivotTableFieldSubtotalOptions","Properties":{"FieldId":{"Type":4,"Flags":0}}}},{"2":{"Name":"PivotTableFieldWells","Properties":{"PivotTableAggregatedFieldWells":{"Type":373,"Flags":0}}}},{"2":{"Name":"PivotTableMetricPlacement"}},{"2":{"Name":"PivotTableOptions","Properties":{"CellStyle":{"Type":502,"Flags":0},"CollapsedRowDimensionsVisibility":{"Type":4,"Flags":0},"ColumnHeaderStyle":{"Type":502,"Flags":0},"ColumnNamesVisibility":{"Type":4,"Flags":0},"DefaultCellWidth":{"Type":4,"Flags":0,"Description":"String based length that is composed of value and unit in px"},"MetricPlacement":{"Type":4,"Flags":0},"RowAlternateColorOptions":{"Type":434,"Flags":0},"RowFieldNamesStyle":{"Type":502,"Flags":0},"RowHeaderStyle":{"Type":502,"Flags":0},"RowsLabelOptions":{"Type":392,"Flags":0},"RowsLayout":{"Type":4,"Flags":0},"SingleMetricVisibility":{"Type":4,"Flags":0},"ToggleButtonsVisibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"PivotTablePaginatedReportOptions","Properties":{"OverflowColumnHeaderVisibility":{"Type":4,"Flags":0},"VerticalOverflowVisibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"PivotTableRowsLabelOptions","Properties":{"CustomLabel":{"Type":4,"Flags":0},"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"PivotTableRowsLayout"}},{"2":{"Name":"PivotTableSortBy","Properties":{"Column":{"Type":81,"Flags":0},"DataPath":{"Type":129,"Flags":0},"Field":{"Type":171,"Flags":0}}}},{"2":{"Name":"PivotTableSortConfiguration","Properties":{"FieldSortOptions":{"Type":745,"Flags":0}}}},{"2":{"Name":"PivotTableSubtotalLevel"}},{"2":{"Name":"PivotTableTotalOptions","Properties":{"ColumnSubtotalOptions":{"Type":495,"Flags":0},"ColumnTotalOptions":{"Type":399,"Flags":0},"RowSubtotalOptions":{"Type":495,"Flags":0},"RowTotalOptions":{"Type":399,"Flags":0}}}},{"2":{"Name":"PivotTableVisual","Properties":{"Actions":{"Type":746,"Flags":0},"ChartConfiguration":{"Type":379,"Flags":0},"ConditionalFormatting":{"Type":375,"Flags":0},"Subtitle":{"Type":575,"Flags":0},"Title":{"Type":576,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"PivotTotalOptions","Properties":{"CustomLabel":{"Type":4,"Flags":0},"MetricHeaderCellStyle":{"Type":502,"Flags":0},"Placement":{"Type":4,"Flags":0},"ScrollStatus":{"Type":4,"Flags":0},"TotalAggregationOptions":{"Type":747,"Flags":0},"TotalCellStyle":{"Type":502,"Flags":0},"TotalsVisibility":{"Type":4,"Flags":0},"ValueCellStyle":{"Type":502,"Flags":0}}}},{"2":{"Name":"PredefinedHierarchy","Properties":{"Columns":{"Type":748,"Flags":1},"DrillDownFilters":{"Type":749,"Flags":0},"HierarchyId":{"Type":4,"Flags":1}}}},{"2":{"Name":"PrimaryValueDisplayType"}},{"2":{"Name":"ProgressBarOptions","Properties":{"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"RadarChartAggregatedFieldWells","Properties":{"Category":{"Type":750,"Flags":0},"Color":{"Type":751,"Flags":0},"Values":{"Type":752,"Flags":0}}}},{"2":{"Name":"RadarChartAreaStyleSettings","Properties":{"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"RadarChartAxesRangeScale"}},{"2":{"Name":"RadarChartConfiguration","Properties":{"AlternateBandColorsVisibility":{"Type":4,"Flags":0},"AlternateBandEvenColor":{"Type":4,"Flags":0},"AlternateBandOddColor":{"Type":4,"Flags":0},"AxesRangeScale":{"Type":4,"Flags":0},"BaseSeriesSettings":{"Type":408,"Flags":0},"CategoryAxis":{"Type":31,"Flags":0},"CategoryLabelOptions":{"Type":71,"Flags":0},"ColorAxis":{"Type":31,"Flags":0},"ColorLabelOptions":{"Type":71,"Flags":0},"FieldWells":{"Type":407,"Flags":0},"Legend":{"Type":293,"Flags":0},"Shape":{"Type":4,"Flags":0},"SortConfiguration":{"Type":410,"Flags":0},"StartAngle":{"Type":3,"Flags":0},"VisualPalette":{"Type":574,"Flags":0}}}},{"2":{"Name":"RadarChartFieldWells","Properties":{"RadarChartAggregatedFieldWells":{"Type":403,"Flags":0}}}},{"2":{"Name":"RadarChartSeriesSettings","Properties":{"AreaStyleSettings":{"Type":404,"Flags":0}}}},{"2":{"Name":"RadarChartShape"}},{"2":{"Name":"RadarChartSortConfiguration","Properties":{"CategoryItemsLimit":{"Type":272,"Flags":0},"CategorySort":{"Type":753,"Flags":0},"ColorItemsLimit":{"Type":272,"Flags":0},"ColorSort":{"Type":754,"Flags":0}}}},{"2":{"Name":"RadarChartVisual","Properties":{"Actions":{"Type":755,"Flags":0},"ChartConfiguration":{"Type":406,"Flags":0},"ColumnHierarchies":{"Type":756,"Flags":0},"Subtitle":{"Type":575,"Flags":0},"Title":{"Type":576,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"RangeEndsLabelType","Properties":{"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"ReferenceLine","Properties":{"DataConfiguration":{"Type":415,"Flags":1},"LabelConfiguration":{"Type":417,"Flags":0},"Status":{"Type":4,"Flags":0},"StyleConfiguration":{"Type":423,"Flags":0}}}},{"2":{"Name":"ReferenceLineCustomLabelConfiguration","Properties":{"CustomLabel":{"Type":4,"Flags":1}}}},{"2":{"Name":"ReferenceLineDataConfiguration","Properties":{"AxisBinding":{"Type":4,"Flags":0},"DynamicConfiguration":{"Type":416,"Flags":0},"SeriesType":{"Type":4,"Flags":0},"StaticConfiguration":{"Type":422,"Flags":0}}}},{"2":{"Name":"ReferenceLineDynamicDataConfiguration","Properties":{"Calculation":{"Type":341,"Flags":1},"Column":{"Type":79,"Flags":1},"MeasureAggregationFunction":{"Type":8,"Flags":0}}}},{"2":{"Name":"ReferenceLineLabelConfiguration","Properties":{"CustomLabelConfiguration":{"Type":414,"Flags":0},"FontColor":{"Type":4,"Flags":0},"FontConfiguration":{"Type":199,"Flags":0},"HorizontalPosition":{"Type":4,"Flags":0},"ValueLabelConfiguration":{"Type":424,"Flags":0},"VerticalPosition":{"Type":4,"Flags":0}}}},{"2":{"Name":"ReferenceLineLabelHorizontalPosition"}},{"2":{"Name":"ReferenceLineLabelVerticalPosition"}},{"2":{"Name":"ReferenceLinePatternType"}},{"2":{"Name":"ReferenceLineSeriesType"}},{"2":{"Name":"ReferenceLineStaticDataConfiguration","Properties":{"Value":{"Type":3,"Flags":1}}}},{"2":{"Name":"ReferenceLineStyleConfiguration","Properties":{"Color":{"Type":4,"Flags":0},"Pattern":{"Type":4,"Flags":0}}}},{"2":{"Name":"ReferenceLineValueLabelConfiguration","Properties":{"FormatConfiguration":{"Type":336,"Flags":0},"RelativePosition":{"Type":4,"Flags":0}}}},{"2":{"Name":"ReferenceLineValueLabelRelativePosition"}},{"2":{"Name":"RelativeDateTimeControlDisplayOptions","Properties":{"DateTimeFormat":{"Type":4,"Flags":0},"InfoIconLabelOptions":{"Type":466,"Flags":0},"TitleOptions":{"Type":289,"Flags":0}}}},{"2":{"Name":"RelativeDateType"}},{"2":{"Name":"RelativeDatesFilter","Properties":{"AnchorDateConfiguration":{"Type":17,"Flags":1},"Column":{"Type":79,"Flags":1},"ExcludePeriodConfiguration":{"Type":166,"Flags":0},"FilterId":{"Type":4,"Flags":1},"MinimumGranularity":{"Type":4,"Flags":0},"NullOption":{"Type":4,"Flags":1},"ParameterName":{"Type":4,"Flags":0},"RelativeDateType":{"Type":4,"Flags":1},"RelativeDateValue":{"Type":3,"Flags":0},"TimeGranularity":{"Type":4,"Flags":1}}}},{"2":{"Name":"RelativeFontSize"}},{"2":{"Name":"ResizeOption"}},{"2":{"Name":"ResourcePermission","Properties":{"Actions":{"Type":757,"Flags":1},"Principal":{"Type":4,"Flags":1}}}},{"2":{"Name":"ResourceStatus"}},{"2":{"Name":"RollingDateConfiguration","Properties":{"DataSetIdentifier":{"Type":4,"Flags":0},"Expression":{"Type":4,"Flags":1}}}},{"2":{"Name":"RowAlternateColorOptions","Properties":{"RowAlternateColors":{"Type":758,"Flags":0},"Status":{"Type":4,"Flags":0},"UsePrimaryBackgroundColor":{"Type":4,"Flags":0}}}},{"2":{"Name":"SameSheetTargetVisualConfiguration","Properties":{"TargetVisualOptions":{"Type":4,"Flags":0},"TargetVisuals":{"Type":759,"Flags":0}}}},{"2":{"Name":"SankeyDiagramAggregatedFieldWells","Properties":{"Destination":{"Type":760,"Flags":0},"Source":{"Type":761,"Flags":0},"Weight":{"Type":762,"Flags":0}}}},{"2":{"Name":"SankeyDiagramChartConfiguration","Properties":{"DataLabels":{"Type":123,"Flags":0},"FieldWells":{"Type":438,"Flags":0},"SortConfiguration":{"Type":439,"Flags":0}}}},{"2":{"Name":"SankeyDiagramFieldWells","Properties":{"SankeyDiagramAggregatedFieldWells":{"Type":436,"Flags":0}}}},{"2":{"Name":"SankeyDiagramSortConfiguration","Properties":{"DestinationItemsLimit":{"Type":272,"Flags":0},"SourceItemsLimit":{"Type":272,"Flags":0},"WeightSort":{"Type":763,"Flags":0}}}},{"2":{"Name":"SankeyDiagramVisual","Properties":{"Actions":{"Type":764,"Flags":0},"ChartConfiguration":{"Type":437,"Flags":0},"Subtitle":{"Type":575,"Flags":0},"Title":{"Type":576,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"ScatterPlotCategoricallyAggregatedFieldWells","Properties":{"Category":{"Type":765,"Flags":0},"Label":{"Type":766,"Flags":0},"Size":{"Type":767,"Flags":0},"XAxis":{"Type":768,"Flags":0},"YAxis":{"Type":769,"Flags":0}}}},{"2":{"Name":"ScatterPlotConfiguration","Properties":{"DataLabels":{"Type":123,"Flags":0},"FieldWells":{"Type":443,"Flags":0},"Legend":{"Type":293,"Flags":0},"Tooltip":{"Type":544,"Flags":0},"VisualPalette":{"Type":574,"Flags":0},"XAxisDisplayOptions":{"Type":31,"Flags":0},"XAxisLabelOptions":{"Type":71,"Flags":0},"YAxisDisplayOptions":{"Type":31,"Flags":0},"YAxisLabelOptions":{"Type":71,"Flags":0}}}},{"2":{"Name":"ScatterPlotFieldWells","Properties":{"ScatterPlotCategoricallyAggregatedFieldWells":{"Type":441,"Flags":0},"ScatterPlotUnaggregatedFieldWells":{"Type":444,"Flags":0}}}},{"2":{"Name":"ScatterPlotUnaggregatedFieldWells","Properties":{"Category":{"Type":770,"Flags":0},"Label":{"Type":771,"Flags":0},"Size":{"Type":772,"Flags":0},"XAxis":{"Type":773,"Flags":0},"YAxis":{"Type":774,"Flags":0}}}},{"2":{"Name":"ScatterPlotVisual","Properties":{"Actions":{"Type":775,"Flags":0},"ChartConfiguration":{"Type":442,"Flags":0},"ColumnHierarchies":{"Type":776,"Flags":0},"Subtitle":{"Type":575,"Flags":0},"Title":{"Type":576,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"ScrollBarOptions","Properties":{"Visibility":{"Type":4,"Flags":0},"VisibleRange":{"Type":569,"Flags":0}}}},{"2":{"Name":"SecondaryValueOptions","Properties":{"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"SectionAfterPageBreak","Properties":{"Status":{"Type":4,"Flags":0}}}},{"2":{"Name":"SectionBasedLayoutCanvasSizeOptions","Properties":{"PaperCanvasSizeOptions":{"Type":451,"Flags":0}}}},{"2":{"Name":"SectionBasedLayoutConfiguration","Properties":{"BodySections":{"Type":777,"Flags":1},"CanvasSizeOptions":{"Type":449,"Flags":1},"FooterSections":{"Type":778,"Flags":1},"HeaderSections":{"Type":779,"Flags":1}}}},{"2":{"Name":"SectionBasedLayoutPaperCanvasSizeOptions","Properties":{"PaperMargin":{"Type":487,"Flags":0},"PaperOrientation":{"Type":4,"Flags":0},"PaperSize":{"Type":4,"Flags":0}}}},{"2":{"Name":"SectionLayoutConfiguration","Properties":{"FreeFormLayout":{"Type":216,"Flags":1}}}},{"2":{"Name":"SectionPageBreakConfiguration","Properties":{"After":{"Type":448,"Flags":0}}}},{"2":{"Name":"SectionPageBreakStatus"}},{"2":{"Name":"SectionStyle","Properties":{"Height":{"Type":4,"Flags":0,"Description":"String based length that is composed of value and unit in px"},"Padding":{"Type":487,"Flags":0}}}},{"2":{"Name":"SelectAllValueOptions"}},{"2":{"Name":"SelectedFieldOptions"}},{"2":{"Name":"SelectedSheetsFilterScopeConfiguration","Properties":{"SheetVisualScopingConfigurations":{"Type":780,"Flags":0}}}},{"2":{"Name":"SelectedTooltipType"}},{"2":{"Name":"SeriesItem","Properties":{"DataFieldSeriesItem":{"Type":121,"Flags":0},"FieldSeriesItem":{"Type":170,"Flags":0}}}},{"2":{"Name":"SetParameterValueConfiguration","Properties":{"DestinationParameterName":{"Type":4,"Flags":1},"Value":{"Type":157,"Flags":1}}}},{"2":{"Name":"ShapeConditionalFormat","Properties":{"BackgroundColor":{"Type":92,"Flags":1}}}},{"2":{"Name":"Sheet","Properties":{"Name":{"Type":4,"Flags":0},"SheetId":{"Type":4,"Flags":0}}}},{"2":{"Name":"SheetContentType"}},{"2":{"Name":"SheetControlDateTimePickerType"}},{"2":{"Name":"SheetControlInfoIconLabelOptions","Properties":{"InfoIconText":{"Type":4,"Flags":0},"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"SheetControlLayout","Properties":{"Configuration":{"Type":468,"Flags":1}}}},{"2":{"Name":"SheetControlLayoutConfiguration","Properties":{"GridLayout":{"Type":248,"Flags":0}}}},{"2":{"Name":"SheetControlListType"}},{"2":{"Name":"SheetControlSliderType"}},{"2":{"Name":"SheetDefinition","Properties":{"ContentType":{"Type":4,"Flags":0},"Description":{"Type":4,"Flags":0},"FilterControls":{"Type":781,"Flags":0},"Layouts":{"Type":782,"Flags":0},"Name":{"Type":4,"Flags":0},"ParameterControls":{"Type":783,"Flags":0},"SheetControlLayouts":{"Type":784,"Flags":0},"SheetId":{"Type":4,"Flags":1},"TextBoxes":{"Type":785,"Flags":0},"Title":{"Type":4,"Flags":0},"Visuals":{"Type":786,"Flags":0}}}},{"2":{"Name":"SheetElementConfigurationOverrides","Properties":{"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"SheetElementRenderingRule","Properties":{"ConfigurationOverrides":{"Type":472,"Flags":1},"Expression":{"Type":4,"Flags":1}}}},{"2":{"Name":"SheetTextBox","Properties":{"Content":{"Type":4,"Flags":0},"SheetTextBoxId":{"Type":4,"Flags":1}}}},{"2":{"Name":"SheetVisualScopingConfiguration","Properties":{"Scope":{"Type":4,"Flags":1},"SheetId":{"Type":4,"Flags":1},"VisualIds":{"Type":787,"Flags":0}}}},{"2":{"Name":"ShortFormatText","Properties":{"PlainText":{"Type":4,"Flags":0},"RichText":{"Type":4,"Flags":0}}}},{"2":{"Name":"SimpleAttributeAggregationFunction"}},{"2":{"Name":"SimpleClusterMarker","Properties":{"Color":{"Type":4,"Flags":0}}}},{"2":{"Name":"SimpleNumericalAggregationFunction"}},{"2":{"Name":"SimpleTotalAggregationFunction"}},{"2":{"Name":"SliderControlDisplayOptions","Properties":{"InfoIconLabelOptions":{"Type":466,"Flags":0},"TitleOptions":{"Type":289,"Flags":0}}}},{"2":{"Name":"SmallMultiplesAxisPlacement"}},{"2":{"Name":"SmallMultiplesAxisProperties","Properties":{"Placement":{"Type":4,"Flags":0},"Scale":{"Type":4,"Flags":0}}}},{"2":{"Name":"SmallMultiplesAxisScale"}},{"2":{"Name":"SmallMultiplesOptions","Properties":{"MaxVisibleColumns":{"Type":3,"Flags":0},"MaxVisibleRows":{"Type":3,"Flags":0},"PanelConfiguration":{"Type":347,"Flags":0},"XAxis":{"Type":483,"Flags":0},"YAxis":{"Type":483,"Flags":0}}}},{"2":{"Name":"SortDirection"}},{"2":{"Name":"Spacing","Properties":{"Bottom":{"Type":4,"Flags":0,"Description":"String based length that is composed of value and unit"},"Left":{"Type":4,"Flags":0,"Description":"String based length that is composed of value and unit"},"Right":{"Type":4,"Flags":0,"Description":"String based length that is composed of value and unit"},"Top":{"Type":4,"Flags":0,"Description":"String based length that is composed of value and unit"}}}},{"2":{"Name":"SpecialValue"}},{"2":{"Name":"StringDefaultValues","Properties":{"DynamicValue":{"Type":163,"Flags":0},"StaticValues":{"Type":788,"Flags":0}}}},{"2":{"Name":"StringFormatConfiguration","Properties":{"NullValueFormatConfiguration":{"Type":327,"Flags":0},"NumericFormatConfiguration":{"Type":336,"Flags":0}}}},{"2":{"Name":"StringParameter","Properties":{"Name":{"Type":4,"Flags":1},"Values":{"Type":789,"Flags":1}}}},{"2":{"Name":"StringParameterDeclaration","Properties":{"DefaultValues":{"Type":489,"Flags":0},"MappedDataSetParameters":{"Type":790,"Flags":0},"Name":{"Type":4,"Flags":1},"ParameterValueType":{"Type":4,"Flags":1},"ValueWhenUnset":{"Type":493,"Flags":0}}}},{"2":{"Name":"StringValueWhenUnsetConfiguration","Properties":{"CustomValue":{"Type":4,"Flags":0},"ValueWhenUnsetOption":{"Type":4,"Flags":0}}}},{"2":{"Name":"StyledCellType"}},{"2":{"Name":"SubtotalOptions","Properties":{"CustomLabel":{"Type":4,"Flags":0},"FieldLevel":{"Type":4,"Flags":0},"FieldLevelOptions":{"Type":791,"Flags":0},"MetricHeaderCellStyle":{"Type":502,"Flags":0},"StyleTargets":{"Type":792,"Flags":0},"TotalCellStyle":{"Type":502,"Flags":0},"TotalsVisibility":{"Type":4,"Flags":0},"ValueCellStyle":{"Type":502,"Flags":0}}}},{"2":{"Name":"TableAggregatedFieldWells","Properties":{"GroupBy":{"Type":793,"Flags":0},"Values":{"Type":794,"Flags":0}}}},{"2":{"Name":"TableBorderOptions","Properties":{"Color":{"Type":4,"Flags":0},"Style":{"Type":4,"Flags":0},"Thickness":{"Type":3,"Flags":0}}}},{"2":{"Name":"TableBorderStyle"}},{"2":{"Name":"TableCellConditionalFormatting","Properties":{"FieldId":{"Type":4,"Flags":1},"TextFormat":{"Type":532,"Flags":0}}}},{"2":{"Name":"TableCellImageScalingConfiguration"}},{"2":{"Name":"TableCellImageSizingConfiguration","Properties":{"TableCellImageScalingConfiguration":{"Type":4,"Flags":0}}}},{"2":{"Name":"TableCellStyle","Properties":{"BackgroundColor":{"Type":4,"Flags":0},"Border":{"Type":244,"Flags":0},"FontConfiguration":{"Type":199,"Flags":0},"Height":{"Type":3,"Flags":0},"HorizontalTextAlignment":{"Type":4,"Flags":0},"TextWrap":{"Type":4,"Flags":0},"VerticalTextAlignment":{"Type":4,"Flags":0},"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"TableConditionalFormatting","Properties":{"ConditionalFormattingOptions":{"Type":795,"Flags":0}}}},{"2":{"Name":"TableConditionalFormattingOption","Properties":{"Cell":{"Type":499,"Flags":0},"Row":{"Type":521,"Flags":0}}}},{"2":{"Name":"TableConfiguration","Properties":{"FieldOptions":{"Type":513,"Flags":0},"FieldWells":{"Type":515,"Flags":0},"PaginatedReportOptions":{"Type":519,"Flags":0},"SortConfiguration":{"Type":523,"Flags":0},"TableInlineVisualizations":{"Type":796,"Flags":0},"TableOptions":{"Type":517,"Flags":0},"TotalOptions":{"Type":554,"Flags":0}}}},{"2":{"Name":"TableFieldCustomIconContent","Properties":{"Icon":{"Type":4,"Flags":0}}}},{"2":{"Name":"TableFieldCustomTextContent","Properties":{"FontConfiguration":{"Type":199,"Flags":1},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"TableFieldIconSetType"}},{"2":{"Name":"TableFieldImageConfiguration","Properties":{"SizingOptions":{"Type":501,"Flags":0}}}},{"2":{"Name":"TableFieldLinkConfiguration","Properties":{"Content":{"Type":511,"Flags":1},"Target":{"Type":4,"Flags":1}}}},{"2":{"Name":"TableFieldLinkContentConfiguration","Properties":{"CustomIconContent":{"Type":506,"Flags":0},"CustomTextContent":{"Type":507,"Flags":0}}}},{"2":{"Name":"TableFieldOption","Properties":{"CustomLabel":{"Type":4,"Flags":0},"FieldId":{"Type":4,"Flags":1},"URLStyling":{"Type":514,"Flags":0},"Visibility":{"Type":4,"Flags":0},"Width":{"Type":4,"Flags":0,"Description":"String based length that is composed of value and unit in px"}}}},{"2":{"Name":"TableFieldOptions","Properties":{"Order":{"Type":797,"Flags":0},"PinnedFieldOptions":{"Type":520,"Flags":0},"SelectedFieldOptions":{"Type":798,"Flags":0}}}},{"2":{"Name":"TableFieldURLConfiguration","Properties":{"ImageConfiguration":{"Type":509,"Flags":0},"LinkConfiguration":{"Type":510,"Flags":0}}}},{"2":{"Name":"TableFieldWells","Properties":{"TableAggregatedFieldWells":{"Type":496,"Flags":0},"TableUnaggregatedFieldWells":{"Type":527,"Flags":0}}}},{"2":{"Name":"TableInlineVisualization","Properties":{"DataBars":{"Type":119,"Flags":0}}}},{"2":{"Name":"TableOptions","Properties":{"CellStyle":{"Type":502,"Flags":0},"HeaderStyle":{"Type":502,"Flags":0},"Orientation":{"Type":4,"Flags":0},"RowAlternateColorOptions":{"Type":434,"Flags":0}}}},{"2":{"Name":"TableOrientation"}},{"2":{"Name":"TablePaginatedReportOptions","Properties":{"OverflowColumnHeaderVisibility":{"Type":4,"Flags":0},"VerticalOverflowVisibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"TablePinnedFieldOptions","Properties":{"PinnedLeftFields":{"Type":799,"Flags":0}}}},{"2":{"Name":"TableRowConditionalFormatting","Properties":{"BackgroundColor":{"Type":92,"Flags":0},"TextColor":{"Type":92,"Flags":0}}}},{"2":{"Name":"TableSideBorderOptions","Properties":{"Bottom":{"Type":497,"Flags":0},"InnerHorizontal":{"Type":497,"Flags":0},"InnerVertical":{"Type":497,"Flags":0},"Left":{"Type":497,"Flags":0},"Right":{"Type":497,"Flags":0},"Top":{"Type":497,"Flags":0}}}},{"2":{"Name":"TableSortConfiguration","Properties":{"PaginationConfiguration":{"Type":345,"Flags":0},"RowSort":{"Type":800,"Flags":0}}}},{"2":{"Name":"TableStyleTarget","Properties":{"CellType":{"Type":4,"Flags":1}}}},{"2":{"Name":"TableTotalsPlacement"}},{"2":{"Name":"TableTotalsScrollStatus"}},{"2":{"Name":"TableUnaggregatedFieldWells","Properties":{"Values":{"Type":801,"Flags":0}}}},{"2":{"Name":"TableVisual","Properties":{"Actions":{"Type":802,"Flags":0},"ChartConfiguration":{"Type":505,"Flags":0},"ConditionalFormatting":{"Type":503,"Flags":0},"Subtitle":{"Type":575,"Flags":0},"Title":{"Type":576,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"TargetVisualOptions"}},{"2":{"Name":"TextAreaControlDisplayOptions","Properties":{"InfoIconLabelOptions":{"Type":466,"Flags":0},"PlaceholderOptions":{"Type":533,"Flags":0},"TitleOptions":{"Type":289,"Flags":0}}}},{"2":{"Name":"TextConditionalFormat","Properties":{"BackgroundColor":{"Type":92,"Flags":0},"Icon":{"Type":96,"Flags":0},"TextColor":{"Type":92,"Flags":0}}}},{"2":{"Name":"TextControlPlaceholderOptions","Properties":{"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"TextFieldControlDisplayOptions","Properties":{"InfoIconLabelOptions":{"Type":466,"Flags":0},"PlaceholderOptions":{"Type":533,"Flags":0},"TitleOptions":{"Type":289,"Flags":0}}}},{"2":{"Name":"TextWrap"}},{"2":{"Name":"ThousandSeparatorOptions","Properties":{"Symbol":{"Type":4,"Flags":0},"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"TimeBasedForecastProperties","Properties":{"LowerBoundary":{"Type":3,"Flags":0},"PeriodsBackward":{"Type":3,"Flags":0},"PeriodsForward":{"Type":3,"Flags":0},"PredictionInterval":{"Type":3,"Flags":0},"Seasonality":{"Type":3,"Flags":0},"UpperBoundary":{"Type":3,"Flags":0}}}},{"2":{"Name":"TimeEqualityFilter","Properties":{"Column":{"Type":79,"Flags":1},"FilterId":{"Type":4,"Flags":1},"ParameterName":{"Type":4,"Flags":0},"RollingDate":{"Type":433,"Flags":0},"TimeGranularity":{"Type":4,"Flags":0},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"TimeGranularity"}},{"2":{"Name":"TimeRangeDrillDownFilter","Properties":{"Column":{"Type":79,"Flags":1},"RangeMaximum":{"Type":4,"Flags":1},"RangeMinimum":{"Type":4,"Flags":1},"TimeGranularity":{"Type":4,"Flags":1}}}},{"2":{"Name":"TimeRangeFilter","Properties":{"Column":{"Type":79,"Flags":1},"ExcludePeriodConfiguration":{"Type":166,"Flags":0},"FilterId":{"Type":4,"Flags":1},"IncludeMaximum":{"Type":2,"Flags":0},"IncludeMinimum":{"Type":2,"Flags":0},"NullOption":{"Type":4,"Flags":1},"RangeMaximumValue":{"Type":542,"Flags":0},"RangeMinimumValue":{"Type":542,"Flags":0},"TimeGranularity":{"Type":4,"Flags":0}}}},{"2":{"Name":"TimeRangeFilterValue","Properties":{"Parameter":{"Type":4,"Flags":0},"RollingDate":{"Type":433,"Flags":0},"StaticValue":{"Type":4,"Flags":0}}}},{"2":{"Name":"TooltipItem","Properties":{"ColumnTooltipItem":{"Type":82,"Flags":0},"FieldTooltipItem":{"Type":173,"Flags":0}}}},{"2":{"Name":"TooltipOptions","Properties":{"FieldBasedTooltip":{"Type":168,"Flags":0},"SelectedTooltipType":{"Type":4,"Flags":0},"TooltipVisibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"TooltipTitleType"}},{"2":{"Name":"TopBottomComputationType"}},{"2":{"Name":"TopBottomFilter","Properties":{"AggregationSortConfigurations":{"Type":803,"Flags":1},"Column":{"Type":79,"Flags":1},"FilterId":{"Type":4,"Flags":1},"Limit":{"Type":3,"Flags":0},"ParameterName":{"Type":4,"Flags":0},"TimeGranularity":{"Type":4,"Flags":0}}}},{"2":{"Name":"TopBottomMoversComputation","Properties":{"Category":{"Type":158,"Flags":0},"ComputationId":{"Type":4,"Flags":1},"MoverSize":{"Type":3,"Flags":0},"Name":{"Type":4,"Flags":0},"SortOrder":{"Type":4,"Flags":0},"Time":{"Type":158,"Flags":0},"Type":{"Type":4,"Flags":1},"Value":{"Type":320,"Flags":0}}}},{"2":{"Name":"TopBottomRankedComputation","Properties":{"Category":{"Type":158,"Flags":0},"ComputationId":{"Type":4,"Flags":1},"Name":{"Type":4,"Flags":0},"ResultSize":{"Type":3,"Flags":0},"Type":{"Type":4,"Flags":1},"Value":{"Type":320,"Flags":0}}}},{"2":{"Name":"TopBottomSortOrder"}},{"2":{"Name":"TotalAggregationComputation","Properties":{"ComputationId":{"Type":4,"Flags":1},"Name":{"Type":4,"Flags":0},"Value":{"Type":320,"Flags":0}}}},{"2":{"Name":"TotalAggregationFunction","Properties":{"SimpleTotalAggregationFunction":{"Type":4,"Flags":0}}}},{"2":{"Name":"TotalAggregationOption","Properties":{"FieldId":{"Type":4,"Flags":1},"TotalAggregationFunction":{"Type":552,"Flags":1}}}},{"2":{"Name":"TotalOptions","Properties":{"CustomLabel":{"Type":4,"Flags":0},"Placement":{"Type":4,"Flags":0},"ScrollStatus":{"Type":4,"Flags":0},"TotalAggregationOptions":{"Type":804,"Flags":0},"TotalCellStyle":{"Type":502,"Flags":0},"TotalsVisibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"TreeMapAggregatedFieldWells","Properties":{"Colors":{"Type":805,"Flags":0},"Groups":{"Type":806,"Flags":0},"Sizes":{"Type":807,"Flags":0}}}},{"2":{"Name":"TreeMapConfiguration","Properties":{"ColorLabelOptions":{"Type":71,"Flags":0},"ColorScale":{"Type":75,"Flags":0},"DataLabels":{"Type":123,"Flags":0},"FieldWells":{"Type":557,"Flags":0},"GroupLabelOptions":{"Type":71,"Flags":0},"Legend":{"Type":293,"Flags":0},"SizeLabelOptions":{"Type":71,"Flags":0},"SortConfiguration":{"Type":558,"Flags":0},"Tooltip":{"Type":544,"Flags":0}}}},{"2":{"Name":"TreeMapFieldWells","Properties":{"TreeMapAggregatedFieldWells":{"Type":555,"Flags":0}}}},{"2":{"Name":"TreeMapSortConfiguration","Properties":{"TreeMapGroupItemsLimitConfiguration":{"Type":272,"Flags":0},"TreeMapSort":{"Type":808,"Flags":0}}}},{"2":{"Name":"TreeMapVisual","Properties":{"Actions":{"Type":809,"Flags":0},"ChartConfiguration":{"Type":556,"Flags":0},"ColumnHierarchies":{"Type":810,"Flags":0},"Subtitle":{"Type":575,"Flags":0},"Title":{"Type":576,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"TrendArrowOptions","Properties":{"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"URLTargetConfiguration"}},{"2":{"Name":"UnaggregatedField","Properties":{"Column":{"Type":79,"Flags":1},"FieldId":{"Type":4,"Flags":1},"FormatConfiguration":{"Type":209,"Flags":0}}}},{"2":{"Name":"UniqueValuesComputation","Properties":{"Category":{"Type":158,"Flags":0},"ComputationId":{"Type":4,"Flags":1},"Name":{"Type":4,"Flags":0}}}},{"2":{"Name":"ValidationStrategy","Properties":{"Mode":{"Type":4,"Flags":1}}}},{"2":{"Name":"ValidationStrategyMode"}},{"2":{"Name":"ValueWhenUnsetOption"}},{"2":{"Name":"VerticalTextAlignment"}},{"2":{"Name":"Visibility"}},{"2":{"Name":"VisibleRangeOptions","Properties":{"PercentRange":{"Type":362,"Flags":0}}}},{"2":{"Name":"Visual","Properties":{"BarChartVisual":{"Type":44,"Flags":0},"BoxPlotVisual":{"Type":58,"Flags":0},"ComboChartVisual":{"Type":87,"Flags":0},"CustomContentVisual":{"Type":113,"Flags":0},"EmptyVisual":{"Type":164,"Flags":0},"FilledMapVisual":{"Type":181,"Flags":0},"FunnelChartVisual":{"Type":223,"Flags":0},"GaugeChartVisual":{"Type":231,"Flags":0},"GeospatialMapVisual":{"Type":240,"Flags":0},"HeatMapVisual":{"Type":257,"Flags":0},"HistogramVisual":{"Type":263,"Flags":0},"InsightVisual":{"Type":267,"Flags":0},"KPIVisual":{"Type":285,"Flags":0},"LineChartVisual":{"Type":306,"Flags":0},"PieChartVisual":{"Type":371,"Flags":0},"PivotTableVisual":{"Type":398,"Flags":0},"RadarChartVisual":{"Type":411,"Flags":0},"SankeyDiagramVisual":{"Type":440,"Flags":0},"ScatterPlotVisual":{"Type":445,"Flags":0},"TableVisual":{"Type":528,"Flags":0},"TreeMapVisual":{"Type":559,"Flags":0},"WaterfallVisual":{"Type":582,"Flags":0},"WordCloudVisual":{"Type":592,"Flags":0}}}},{"2":{"Name":"VisualCustomAction","Properties":{"ActionOperations":{"Type":811,"Flags":1},"CustomActionId":{"Type":4,"Flags":1},"Name":{"Type":4,"Flags":1},"Status":{"Type":4,"Flags":0},"Trigger":{"Type":4,"Flags":1}}}},{"2":{"Name":"VisualCustomActionOperation","Properties":{"FilterOperation":{"Type":105,"Flags":0},"NavigationOperation":{"Type":106,"Flags":0},"SetParametersOperation":{"Type":107,"Flags":0},"URLOperation":{"Type":108,"Flags":0}}}},{"2":{"Name":"VisualCustomActionTrigger"}},{"2":{"Name":"VisualPalette","Properties":{"ChartColor":{"Type":4,"Flags":0},"ColorMap":{"Type":812,"Flags":0}}}},{"2":{"Name":"VisualSubtitleLabelOptions","Properties":{"FormatText":{"Type":314,"Flags":0},"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"VisualTitleLabelOptions","Properties":{"FormatText":{"Type":476,"Flags":0},"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"WaterfallChartAggregatedFieldWells","Properties":{"Breakdowns":{"Type":813,"Flags":0},"Categories":{"Type":814,"Flags":0},"Values":{"Type":815,"Flags":0}}}},{"2":{"Name":"WaterfallChartConfiguration","Properties":{"CategoryAxisDisplayOptions":{"Type":31,"Flags":0},"CategoryAxisLabelOptions":{"Type":71,"Flags":0},"DataLabels":{"Type":123,"Flags":0},"FieldWells":{"Type":579,"Flags":0},"Legend":{"Type":293,"Flags":0},"PrimaryYAxisDisplayOptions":{"Type":31,"Flags":0},"PrimaryYAxisLabelOptions":{"Type":71,"Flags":0},"SortConfiguration":{"Type":581,"Flags":0},"VisualPalette":{"Type":574,"Flags":0},"WaterfallChartOptions":{"Type":580,"Flags":0}}}},{"2":{"Name":"WaterfallChartFieldWells","Properties":{"WaterfallChartAggregatedFieldWells":{"Type":577,"Flags":0}}}},{"2":{"Name":"WaterfallChartOptions","Properties":{"TotalBarLabel":{"Type":4,"Flags":0}}}},{"2":{"Name":"WaterfallChartSortConfiguration","Properties":{"BreakdownItemsLimit":{"Type":272,"Flags":0},"CategorySort":{"Type":816,"Flags":0}}}},{"2":{"Name":"WaterfallVisual","Properties":{"Actions":{"Type":817,"Flags":0},"ChartConfiguration":{"Type":578,"Flags":0},"ColumnHierarchies":{"Type":818,"Flags":0},"Subtitle":{"Type":575,"Flags":0},"Title":{"Type":576,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"WhatIfPointScenario","Properties":{"Date":{"Type":4,"Flags":1},"Value":{"Type":3,"Flags":1}}}},{"2":{"Name":"WhatIfRangeScenario","Properties":{"EndDate":{"Type":4,"Flags":1},"StartDate":{"Type":4,"Flags":1},"Value":{"Type":3,"Flags":1}}}},{"2":{"Name":"WidgetStatus"}},{"2":{"Name":"WordCloudAggregatedFieldWells","Properties":{"GroupBy":{"Type":819,"Flags":0},"Size":{"Type":820,"Flags":0}}}},{"2":{"Name":"WordCloudChartConfiguration","Properties":{"CategoryLabelOptions":{"Type":71,"Flags":0},"FieldWells":{"Type":589,"Flags":0},"SortConfiguration":{"Type":591,"Flags":0},"WordCloudOptions":{"Type":590,"Flags":0}}}},{"2":{"Name":"WordCloudCloudLayout"}},{"2":{"Name":"WordCloudFieldWells","Properties":{"WordCloudAggregatedFieldWells":{"Type":586,"Flags":0}}}},{"2":{"Name":"WordCloudOptions","Properties":{"CloudLayout":{"Type":4,"Flags":0},"MaximumStringLength":{"Type":3,"Flags":0},"WordCasing":{"Type":4,"Flags":0},"WordOrientation":{"Type":4,"Flags":0},"WordPadding":{"Type":4,"Flags":0},"WordScaling":{"Type":4,"Flags":0}}}},{"2":{"Name":"WordCloudSortConfiguration","Properties":{"CategoryItemsLimit":{"Type":272,"Flags":0},"CategorySort":{"Type":821,"Flags":0}}}},{"2":{"Name":"WordCloudVisual","Properties":{"Actions":{"Type":822,"Flags":0},"ChartConfiguration":{"Type":587,"Flags":0},"ColumnHierarchies":{"Type":823,"Flags":0},"Subtitle":{"Type":575,"Flags":0},"Title":{"Type":576,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"WordCloudWordCasing"}},{"2":{"Name":"WordCloudWordOrientation"}},{"2":{"Name":"WordCloudWordPadding"}},{"2":{"Name":"WordCloudWordScaling"}},{"3":{"ItemType":59}},{"3":{"ItemType":77}},{"3":{"ItemType":132}},{"3":{"ItemType":186}},{"3":{"ItemType":353}},{"3":{"ItemType":471}},{"3":{"ItemType":165}},{"3":{"ItemType":133}},{"3":{"ItemType":158}},{"3":{"ItemType":158}},{"3":{"ItemType":158}},{"3":{"ItemType":320}},{"3":{"ItemType":102}},{"3":{"ItemType":413}},{"3":{"ItemType":172}},{"3":{"ItemType":172}},{"3":{"ItemType":172}},{"3":{"ItemType":571}},{"3":{"ItemType":78}},{"3":{"ItemType":158}},{"3":{"ItemType":320}},{"3":{"ItemType":413}},{"3":{"ItemType":172}},{"3":{"ItemType":571}},{"3":{"ItemType":78}},{"3":{"ItemType":62}},{"3":{"ItemType":4}},{"3":{"ItemType":33}},{"3":{"ItemType":120}},{"3":{"ItemType":109}},{"3":{"ItemType":320}},{"3":{"ItemType":158}},{"3":{"ItemType":158}},{"3":{"ItemType":320}},{"3":{"ItemType":413}},{"3":{"ItemType":172}},{"3":{"ItemType":172}},{"3":{"ItemType":571}},{"3":{"ItemType":78}},{"3":{"ItemType":79}},{"3":{"ItemType":461}},{"3":{"ItemType":571}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":3}},{"3":{"ItemType":3}},{"3":{"ItemType":4}},{"3":{"ItemType":126}},{"3":{"ItemType":131}},{"3":{"ItemType":4}},{"3":{"ItemType":161}},{"3":{"ItemType":4}},{"3":{"ItemType":316}},{"3":{"ItemType":3}},{"3":{"ItemType":3}},{"3":{"ItemType":316}},{"3":{"ItemType":571}},{"3":{"ItemType":79}},{"3":{"ItemType":161}},{"3":{"ItemType":543}},{"3":{"ItemType":158}},{"3":{"ItemType":320}},{"3":{"ItemType":176}},{"3":{"ItemType":172}},{"3":{"ItemType":571}},{"3":{"ItemType":78}},{"3":{"ItemType":182}},{"3":{"ItemType":4}},{"3":{"ItemType":79}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":212}},{"3":{"ItemType":473}},{"3":{"ItemType":212}},{"3":{"ItemType":158}},{"3":{"ItemType":320}},{"3":{"ItemType":172}},{"3":{"ItemType":571}},{"3":{"ItemType":78}},{"3":{"ItemType":226}},{"3":{"ItemType":320}},{"3":{"ItemType":320}},{"3":{"ItemType":571}},{"3":{"ItemType":235}},{"3":{"ItemType":158}},{"3":{"ItemType":158}},{"3":{"ItemType":320}},{"3":{"ItemType":571}},{"3":{"ItemType":78}},{"3":{"ItemType":246}},{"3":{"ItemType":249}},{"3":{"ItemType":158}},{"3":{"ItemType":158}},{"3":{"ItemType":320}},{"3":{"ItemType":172}},{"3":{"ItemType":172}},{"3":{"ItemType":571}},{"3":{"ItemType":78}},{"3":{"ItemType":320}},{"3":{"ItemType":571}},{"3":{"ItemType":91}},{"3":{"ItemType":571}},{"3":{"ItemType":3}},{"3":{"ItemType":3}},{"3":{"ItemType":316}},{"3":{"ItemType":276}},{"3":{"ItemType":320}},{"3":{"ItemType":158}},{"3":{"ItemType":320}},{"3":{"ItemType":172}},{"3":{"ItemType":571}},{"3":{"ItemType":78}},{"3":{"ItemType":158}},{"3":{"ItemType":158}},{"3":{"ItemType":158}},{"3":{"ItemType":320}},{"3":{"ItemType":102}},{"3":{"ItemType":207}},{"3":{"ItemType":413}},{"3":{"ItemType":460}},{"3":{"ItemType":172}},{"3":{"ItemType":172}},{"3":{"ItemType":571}},{"3":{"ItemType":78}},{"3":{"ItemType":323}},{"3":{"ItemType":4}},{"3":{"ItemType":141}},{"3":{"ItemType":147}},{"3":{"ItemType":269}},{"3":{"ItemType":491}},{"3":{"ItemType":158}},{"3":{"ItemType":158}},{"3":{"ItemType":320}},{"3":{"ItemType":102}},{"3":{"ItemType":172}},{"3":{"ItemType":172}},{"3":{"ItemType":571}},{"3":{"ItemType":78}},{"3":{"ItemType":158}},{"3":{"ItemType":158}},{"3":{"ItemType":320}},{"3":{"ItemType":377}},{"3":{"ItemType":376}},{"3":{"ItemType":131}},{"3":{"ItemType":131}},{"3":{"ItemType":383}},{"3":{"ItemType":380}},{"3":{"ItemType":385}},{"3":{"ItemType":372}},{"3":{"ItemType":571}},{"3":{"ItemType":553}},{"3":{"ItemType":79}},{"3":{"ItemType":161}},{"3":{"ItemType":158}},{"3":{"ItemType":158}},{"3":{"ItemType":320}},{"3":{"ItemType":172}},{"3":{"ItemType":172}},{"3":{"ItemType":571}},{"3":{"ItemType":78}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":158}},{"3":{"ItemType":158}},{"3":{"ItemType":320}},{"3":{"ItemType":172}},{"3":{"ItemType":571}},{"3":{"ItemType":158}},{"3":{"ItemType":158}},{"3":{"ItemType":320}},{"3":{"ItemType":320}},{"3":{"ItemType":320}},{"3":{"ItemType":158}},{"3":{"ItemType":158}},{"3":{"ItemType":320}},{"3":{"ItemType":158}},{"3":{"ItemType":158}},{"3":{"ItemType":571}},{"3":{"ItemType":78}},{"3":{"ItemType":49}},{"3":{"ItemType":252}},{"3":{"ItemType":252}},{"3":{"ItemType":475}},{"3":{"ItemType":183}},{"3":{"ItemType":290}},{"3":{"ItemType":351}},{"3":{"ItemType":467}},{"3":{"ItemType":474}},{"3":{"ItemType":570}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":316}},{"3":{"ItemType":387}},{"3":{"ItemType":524}},{"3":{"ItemType":158}},{"3":{"ItemType":320}},{"3":{"ItemType":504}},{"3":{"ItemType":516}},{"3":{"ItemType":4}},{"3":{"ItemType":512}},{"3":{"ItemType":4}},{"3":{"ItemType":172}},{"3":{"ItemType":562}},{"3":{"ItemType":571}},{"3":{"ItemType":9}},{"3":{"ItemType":553}},{"3":{"ItemType":320}},{"3":{"ItemType":158}},{"3":{"ItemType":320}},{"3":{"ItemType":172}},{"3":{"ItemType":571}},{"3":{"ItemType":78}},{"3":{"ItemType":572}},{"3":{"ItemType":127}},{"3":{"ItemType":158}},{"3":{"ItemType":158}},{"3":{"ItemType":320}},{"3":{"ItemType":172}},{"3":{"ItemType":571}},{"3":{"ItemType":78}},{"3":{"ItemType":158}},{"3":{"ItemType":320}},{"3":{"ItemType":172}},{"3":{"ItemType":571}},{"3":{"ItemType":78}},{"2":{"Name":"AWS.QuickSight/AnalysisProperties","Properties":{"AnalysisId":{"Type":4,"Flags":17},"Arn":{"Type":4,"Flags":2},"AwsAccountId":{"Type":4,"Flags":17},"CreatedTime":{"Type":4,"Flags":2},"DataSetArns":{"Type":825,"Flags":2},"Definition":{"Type":12,"Flags":4},"Errors":{"Type":826,"Flags":0},"LastUpdatedTime":{"Type":4,"Flags":2},"Name":{"Type":4,"Flags":1},"Parameters":{"Type":361,"Flags":4},"Permissions":{"Type":827,"Flags":0},"Sheets":{"Type":828,"Flags":0},"SourceEntity":{"Type":15,"Flags":4},"Status":{"Type":4,"Flags":4},"Tags":{"Type":829,"Flags":0},"ThemeArn":{"Type":4,"Flags":0},"ValidationStrategy":{"Type":564,"Flags":4}}}},{"3":{"ItemType":4}},{"3":{"ItemType":13}},{"3":{"ItemType":431}},{"3":{"ItemType":463}},{"3":{"ItemType":529}},{"2":{"Name":"AWS.QuickSight/Analysis","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":824,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.QuickSight/Analysis@default","ScopeType":0,"Body":830}},{"2":{"Name":"AdHocFilteringOption","Properties":{"AvailabilityStatus":{"Type":4,"Flags":0}}}},{"2":{"Name":"AggregationFunction","Properties":{"AttributeAggregationFunction":{"Type":846,"Flags":0},"CategoricalAggregationFunction":{"Type":4,"Flags":0},"DateAggregationFunction":{"Type":4,"Flags":0},"NumericalAggregationFunction":{"Type":1178,"Flags":0}}}},{"2":{"Name":"AggregationSortConfiguration","Properties":{"AggregationFunction":{"Type":833,"Flags":0},"Column":{"Type":899,"Flags":1},"SortDirection":{"Type":4,"Flags":1}}}},{"2":{"Name":"AllSheetsFilterScopeConfiguration","Properties":{}}},{"2":{"Name":"AnalysisDefaults","Properties":{"DefaultNewSheetConfiguration":{"Type":987,"Flags":1}}}},{"2":{"Name":"AnchorDateConfiguration","Properties":{"AnchorOption":{"Type":4,"Flags":0},"ParameterName":{"Type":4,"Flags":0}}}},{"2":{"Name":"AnchorOption"}},{"2":{"Name":"ArcAxisConfiguration","Properties":{"Range":{"Type":840,"Flags":0},"ReserveRange":{"Type":3,"Flags":0}}}},{"2":{"Name":"ArcAxisDisplayRange","Properties":{"Max":{"Type":3,"Flags":0},"Min":{"Type":3,"Flags":0}}}},{"2":{"Name":"ArcConfiguration","Properties":{"ArcAngle":{"Type":3,"Flags":0},"ArcThickness":{"Type":4,"Flags":0}}}},{"2":{"Name":"ArcOptions","Properties":{"ArcThickness":{"Type":4,"Flags":0}}}},{"2":{"Name":"ArcThickness"}},{"2":{"Name":"ArcThicknessOptions"}},{"2":{"Name":"AssetOptions","Properties":{"Timezone":{"Type":4,"Flags":0},"WeekStart":{"Type":4,"Flags":0}}}},{"2":{"Name":"AttributeAggregationFunction","Properties":{"SimpleAttributeAggregation":{"Type":4,"Flags":0},"ValueForMultipleValues":{"Type":4,"Flags":0}}}},{"2":{"Name":"AxisBinding"}},{"2":{"Name":"AxisDataOptions","Properties":{"DateAxisOptions":{"Type":968,"Flags":0},"NumericAxisOptions":{"Type":1168,"Flags":0}}}},{"2":{"Name":"AxisDisplayDataDrivenRange","Properties":{}}},{"2":{"Name":"AxisDisplayMinMaxRange","Properties":{"Maximum":{"Type":3,"Flags":0},"Minimum":{"Type":3,"Flags":0}}}},{"2":{"Name":"AxisDisplayOptions","Properties":{"AxisLineVisibility":{"Type":4,"Flags":0},"AxisOffset":{"Type":4,"Flags":0,"Description":"String based length that is composed of value and unit in px"},"DataOptions":{"Type":848,"Flags":0},"GridLineVisibility":{"Type":4,"Flags":0},"ScrollbarOptions":{"Type":1283,"Flags":0},"TickLabelOptions":{"Type":858,"Flags":0}}}},{"2":{"Name":"AxisDisplayRange","Properties":{"DataDriven":{"Type":849,"Flags":0},"MinMax":{"Type":850,"Flags":0}}}},{"2":{"Name":"AxisLabelOptions","Properties":{"ApplyTo":{"Type":854,"Flags":0},"CustomLabel":{"Type":4,"Flags":0},"FontConfiguration":{"Type":1035,"Flags":0}}}},{"2":{"Name":"AxisLabelReferenceOptions","Properties":{"Column":{"Type":899,"Flags":1},"FieldId":{"Type":4,"Flags":1}}}},{"2":{"Name":"AxisLinearScale","Properties":{"StepCount":{"Type":3,"Flags":0},"StepSize":{"Type":3,"Flags":0}}}},{"2":{"Name":"AxisLogarithmicScale","Properties":{"Base":{"Type":3,"Flags":0}}}},{"2":{"Name":"AxisScale","Properties":{"Linear":{"Type":855,"Flags":0},"Logarithmic":{"Type":856,"Flags":0}}}},{"2":{"Name":"AxisTickLabelOptions","Properties":{"LabelOptions":{"Type":1125,"Flags":0},"RotationAngle":{"Type":3,"Flags":0}}}},{"2":{"Name":"BarChartAggregatedFieldWells","Properties":{"Category":{"Type":1438,"Flags":0},"Colors":{"Type":1439,"Flags":0},"SmallMultiples":{"Type":1440,"Flags":0},"Values":{"Type":1441,"Flags":0}}}},{"2":{"Name":"BarChartConfiguration","Properties":{"BarsArrangement":{"Type":4,"Flags":0},"CategoryAxis":{"Type":851,"Flags":0},"CategoryLabelOptions":{"Type":891,"Flags":0},"ColorLabelOptions":{"Type":891,"Flags":0},"ContributionAnalysisDefaults":{"Type":1442,"Flags":0},"DataLabels":{"Type":953,"Flags":0},"FieldWells":{"Type":861,"Flags":0},"Legend":{"Type":1129,"Flags":0},"Orientation":{"Type":4,"Flags":0},"ReferenceLines":{"Type":1443,"Flags":0},"SmallMultiplesOptions":{"Type":1324,"Flags":0},"SortConfiguration":{"Type":863,"Flags":0},"Tooltip":{"Type":1383,"Flags":0},"ValueAxis":{"Type":851,"Flags":0},"ValueLabelOptions":{"Type":891,"Flags":0},"VisualPalette":{"Type":1415,"Flags":0}}}},{"2":{"Name":"BarChartFieldWells","Properties":{"BarChartAggregatedFieldWells":{"Type":859,"Flags":0}}}},{"2":{"Name":"BarChartOrientation"}},{"2":{"Name":"BarChartSortConfiguration","Properties":{"CategoryItemsLimit":{"Type":1108,"Flags":0},"CategorySort":{"Type":1444,"Flags":0},"ColorItemsLimit":{"Type":1108,"Flags":0},"ColorSort":{"Type":1445,"Flags":0},"SmallMultiplesLimitConfiguration":{"Type":1108,"Flags":0},"SmallMultiplesSort":{"Type":1446,"Flags":0}}}},{"2":{"Name":"BarChartVisual","Properties":{"Actions":{"Type":1447,"Flags":0},"ChartConfiguration":{"Type":860,"Flags":0},"ColumnHierarchies":{"Type":1448,"Flags":0},"Subtitle":{"Type":1416,"Flags":0},"Title":{"Type":1417,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"BarsArrangement"}},{"2":{"Name":"BaseMapStyleType"}},{"2":{"Name":"BinCountOptions","Properties":{"Value":{"Type":3,"Flags":0}}}},{"2":{"Name":"BinWidthOptions","Properties":{"BinCountLimit":{"Type":3,"Flags":0},"Value":{"Type":3,"Flags":0}}}},{"2":{"Name":"BodySectionConfiguration","Properties":{"Content":{"Type":870,"Flags":1},"PageBreakConfiguration":{"Type":1290,"Flags":0},"SectionId":{"Type":4,"Flags":1},"Style":{"Type":1292,"Flags":0}}}},{"2":{"Name":"BodySectionContent","Properties":{"Layout":{"Type":1289,"Flags":0}}}},{"2":{"Name":"BoxPlotAggregatedFieldWells","Properties":{"GroupBy":{"Type":1449,"Flags":0},"Values":{"Type":1450,"Flags":0}}}},{"2":{"Name":"BoxPlotChartConfiguration","Properties":{"BoxPlotOptions":{"Type":875,"Flags":0},"CategoryAxis":{"Type":851,"Flags":0},"CategoryLabelOptions":{"Type":891,"Flags":0},"FieldWells":{"Type":873,"Flags":0},"Legend":{"Type":1129,"Flags":0},"PrimaryYAxisDisplayOptions":{"Type":851,"Flags":0},"PrimaryYAxisLabelOptions":{"Type":891,"Flags":0},"ReferenceLines":{"Type":1451,"Flags":0},"SortConfiguration":{"Type":876,"Flags":0},"Tooltip":{"Type":1383,"Flags":0},"VisualPalette":{"Type":1415,"Flags":0}}}},{"2":{"Name":"BoxPlotFieldWells","Properties":{"BoxPlotAggregatedFieldWells":{"Type":871,"Flags":0}}}},{"2":{"Name":"BoxPlotFillStyle"}},{"2":{"Name":"BoxPlotOptions","Properties":{"AllDataPointsVisibility":{"Type":4,"Flags":0},"OutlierVisibility":{"Type":4,"Flags":0},"StyleOptions":{"Type":877,"Flags":0}}}},{"2":{"Name":"BoxPlotSortConfiguration","Properties":{"CategorySort":{"Type":1452,"Flags":0},"PaginationConfiguration":{"Type":1182,"Flags":0}}}},{"2":{"Name":"BoxPlotStyleOptions","Properties":{"FillStyle":{"Type":4,"Flags":0}}}},{"2":{"Name":"BoxPlotVisual","Properties":{"Actions":{"Type":1453,"Flags":0},"ChartConfiguration":{"Type":872,"Flags":0},"ColumnHierarchies":{"Type":1454,"Flags":0},"Subtitle":{"Type":1416,"Flags":0},"Title":{"Type":1417,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"CalculatedField","Properties":{"DataSetIdentifier":{"Type":4,"Flags":1},"Expression":{"Type":4,"Flags":1},"Name":{"Type":4,"Flags":1}}}},{"2":{"Name":"CalculatedMeasureField","Properties":{"Expression":{"Type":4,"Flags":1},"FieldId":{"Type":4,"Flags":1}}}},{"2":{"Name":"CascadingControlConfiguration","Properties":{"SourceControls":{"Type":1455,"Flags":0}}}},{"2":{"Name":"CascadingControlSource","Properties":{"ColumnToMatch":{"Type":899,"Flags":0},"SourceSheetControlId":{"Type":4,"Flags":0}}}},{"2":{"Name":"CategoricalAggregationFunction"}},{"2":{"Name":"CategoricalDimensionField","Properties":{"Column":{"Type":899,"Flags":1},"FieldId":{"Type":4,"Flags":1},"FormatConfiguration":{"Type":1329,"Flags":0},"HierarchyId":{"Type":4,"Flags":0}}}},{"2":{"Name":"CategoricalMeasureField","Properties":{"AggregationFunction":{"Type":4,"Flags":0},"Column":{"Type":899,"Flags":1},"FieldId":{"Type":4,"Flags":1},"FormatConfiguration":{"Type":1329,"Flags":0}}}},{"2":{"Name":"CategoryDrillDownFilter","Properties":{"CategoryValues":{"Type":1456,"Flags":1},"Column":{"Type":899,"Flags":1}}}},{"2":{"Name":"CategoryFilter","Properties":{"Column":{"Type":899,"Flags":1},"Configuration":{"Type":888,"Flags":1},"FilterId":{"Type":4,"Flags":1}}}},{"2":{"Name":"CategoryFilterConfiguration","Properties":{"CustomFilterConfiguration":{"Type":934,"Flags":0},"CustomFilterListConfiguration":{"Type":935,"Flags":0},"FilterListConfiguration":{"Type":1023,"Flags":0}}}},{"2":{"Name":"CategoryFilterMatchOperator"}},{"2":{"Name":"CategoryFilterSelectAllOptions"}},{"2":{"Name":"ChartAxisLabelOptions","Properties":{"AxisLabelOptions":{"Type":1457,"Flags":0},"SortIconVisibility":{"Type":4,"Flags":0},"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"ClusterMarker","Properties":{"SimpleClusterMarker":{"Type":1317,"Flags":0}}}},{"2":{"Name":"ClusterMarkerConfiguration","Properties":{"ClusterMarker":{"Type":892,"Flags":0}}}},{"2":{"Name":"ColorFillType"}},{"2":{"Name":"ColorScale","Properties":{"ColorFillType":{"Type":4,"Flags":1},"Colors":{"Type":1458,"Flags":1},"NullValueColor":{"Type":950,"Flags":0}}}},{"2":{"Name":"ColorsConfiguration","Properties":{"CustomColors":{"Type":1459,"Flags":0}}}},{"2":{"Name":"ColumnConfiguration","Properties":{"ColorsConfiguration":{"Type":896,"Flags":0},"Column":{"Type":899,"Flags":1},"FormatConfiguration":{"Type":1045,"Flags":0},"Role":{"Type":4,"Flags":0}}}},{"2":{"Name":"ColumnHierarchy","Properties":{"DateTimeHierarchy":{"Type":973,"Flags":0},"ExplicitHierarchy":{"Type":1000,"Flags":0},"PredefinedHierarchy":{"Type":1237,"Flags":0}}}},{"2":{"Name":"ColumnIdentifier","Properties":{"ColumnName":{"Type":4,"Flags":1},"DataSetIdentifier":{"Type":4,"Flags":1}}}},{"2":{"Name":"ColumnRole"}},{"2":{"Name":"ColumnSort","Properties":{"AggregationFunction":{"Type":833,"Flags":0},"Direction":{"Type":4,"Flags":1},"SortBy":{"Type":899,"Flags":1}}}},{"2":{"Name":"ColumnTooltipItem","Properties":{"Aggregation":{"Type":833,"Flags":0},"Column":{"Type":899,"Flags":1},"Label":{"Type":4,"Flags":0},"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"ComboChartAggregatedFieldWells","Properties":{"BarValues":{"Type":1460,"Flags":0},"Category":{"Type":1461,"Flags":0},"Colors":{"Type":1462,"Flags":0},"LineValues":{"Type":1463,"Flags":0}}}},{"2":{"Name":"ComboChartConfiguration","Properties":{"BarDataLabels":{"Type":953,"Flags":0},"BarsArrangement":{"Type":4,"Flags":0},"CategoryAxis":{"Type":851,"Flags":0},"CategoryLabelOptions":{"Type":891,"Flags":0},"ColorLabelOptions":{"Type":891,"Flags":0},"FieldWells":{"Type":905,"Flags":0},"Legend":{"Type":1129,"Flags":0},"LineDataLabels":{"Type":953,"Flags":0},"PrimaryYAxisDisplayOptions":{"Type":851,"Flags":0},"PrimaryYAxisLabelOptions":{"Type":891,"Flags":0},"ReferenceLines":{"Type":1464,"Flags":0},"SecondaryYAxisDisplayOptions":{"Type":851,"Flags":0},"SecondaryYAxisLabelOptions":{"Type":891,"Flags":0},"SortConfiguration":{"Type":906,"Flags":0},"Tooltip":{"Type":1383,"Flags":0},"VisualPalette":{"Type":1415,"Flags":0}}}},{"2":{"Name":"ComboChartFieldWells","Properties":{"ComboChartAggregatedFieldWells":{"Type":903,"Flags":0}}}},{"2":{"Name":"ComboChartSortConfiguration","Properties":{"CategoryItemsLimit":{"Type":1108,"Flags":0},"CategorySort":{"Type":1465,"Flags":0},"ColorItemsLimit":{"Type":1108,"Flags":0},"ColorSort":{"Type":1466,"Flags":0}}}},{"2":{"Name":"ComboChartVisual","Properties":{"Actions":{"Type":1467,"Flags":0},"ChartConfiguration":{"Type":904,"Flags":0},"ColumnHierarchies":{"Type":1468,"Flags":0},"Subtitle":{"Type":1416,"Flags":0},"Title":{"Type":1417,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"ComparisonConfiguration","Properties":{"ComparisonFormat":{"Type":909,"Flags":0},"ComparisonMethod":{"Type":4,"Flags":0}}}},{"2":{"Name":"ComparisonFormatConfiguration","Properties":{"NumberDisplayFormatConfiguration":{"Type":1165,"Flags":0},"PercentageDisplayFormatConfiguration":{"Type":1200,"Flags":0}}}},{"2":{"Name":"ComparisonMethod"}},{"2":{"Name":"Computation","Properties":{"Forecast":{"Type":1041,"Flags":0},"GrowthRate":{"Type":1087,"Flags":0},"MaximumMinimum":{"Type":1155,"Flags":0},"MetricComparison":{"Type":1158,"Flags":0},"PeriodOverPeriod":{"Type":1202,"Flags":0},"PeriodToDate":{"Type":1203,"Flags":0},"TopBottomMovers":{"Type":1387,"Flags":0},"TopBottomRanked":{"Type":1388,"Flags":0},"TotalAggregation":{"Type":1390,"Flags":0},"UniqueValues":{"Type":1402,"Flags":0}}}},{"2":{"Name":"ConditionalFormattingColor","Properties":{"Gradient":{"Type":915,"Flags":0},"Solid":{"Type":921,"Flags":0}}}},{"2":{"Name":"ConditionalFormattingCustomIconCondition","Properties":{"Color":{"Type":4,"Flags":0},"DisplayConfiguration":{"Type":917,"Flags":0},"Expression":{"Type":4,"Flags":1},"IconOptions":{"Type":914,"Flags":1}}}},{"2":{"Name":"ConditionalFormattingCustomIconOptions","Properties":{"Icon":{"Type":4,"Flags":0},"UnicodeIcon":{"Type":4,"Flags":0}}}},{"2":{"Name":"ConditionalFormattingGradientColor","Properties":{"Color":{"Type":1081,"Flags":1},"Expression":{"Type":4,"Flags":1}}}},{"2":{"Name":"ConditionalFormattingIcon","Properties":{"CustomCondition":{"Type":913,"Flags":0},"IconSet":{"Type":919,"Flags":0}}}},{"2":{"Name":"ConditionalFormattingIconDisplayConfiguration","Properties":{"IconDisplayOption":{"Type":4,"Flags":0}}}},{"2":{"Name":"ConditionalFormattingIconDisplayOption"}},{"2":{"Name":"ConditionalFormattingIconSet","Properties":{"Expression":{"Type":4,"Flags":1},"IconSetType":{"Type":4,"Flags":0}}}},{"2":{"Name":"ConditionalFormattingIconSetType"}},{"2":{"Name":"ConditionalFormattingSolidColor","Properties":{"Color":{"Type":4,"Flags":0},"Expression":{"Type":4,"Flags":1}}}},{"2":{"Name":"ContributionAnalysisDefault","Properties":{"ContributorDimensions":{"Type":1469,"Flags":1},"MeasureFieldId":{"Type":4,"Flags":1}}}},{"2":{"Name":"CrossDatasetTypes"}},{"2":{"Name":"CurrencyDisplayFormatConfiguration","Properties":{"DecimalPlacesConfiguration":{"Type":982,"Flags":0},"NegativeValueConfiguration":{"Type":1162,"Flags":0},"NullValueFormatConfiguration":{"Type":1164,"Flags":0},"NumberScale":{"Type":4,"Flags":0},"Prefix":{"Type":4,"Flags":0},"SeparatorConfiguration":{"Type":1176,"Flags":0},"Suffix":{"Type":4,"Flags":0},"Symbol":{"Type":4,"Flags":0}}}},{"2":{"Name":"CustomActionFilterOperation","Properties":{"SelectedFieldsConfiguration":{"Type":1026,"Flags":1},"TargetVisualsConfiguration":{"Type":1027,"Flags":1}}}},{"2":{"Name":"CustomActionNavigationOperation","Properties":{"LocalNavigationConfiguration":{"Type":1150,"Flags":0}}}},{"2":{"Name":"CustomActionSetParametersOperation","Properties":{"ParameterValueConfigurations":{"Type":1470,"Flags":1}}}},{"2":{"Name":"CustomActionURLOperation","Properties":{"URLTarget":{"Type":4,"Flags":1},"URLTemplate":{"Type":4,"Flags":1}}}},{"2":{"Name":"CustomColor","Properties":{"Color":{"Type":4,"Flags":1},"FieldValue":{"Type":4,"Flags":0},"SpecialValue":{"Type":4,"Flags":0}}}},{"2":{"Name":"CustomContentConfiguration","Properties":{"ContentType":{"Type":4,"Flags":0},"ContentUrl":{"Type":4,"Flags":0},"ImageScaling":{"Type":4,"Flags":0}}}},{"2":{"Name":"CustomContentImageScalingConfiguration"}},{"2":{"Name":"CustomContentType"}},{"2":{"Name":"CustomContentVisual","Properties":{"Actions":{"Type":1471,"Flags":0},"ChartConfiguration":{"Type":930,"Flags":0},"DataSetIdentifier":{"Type":4,"Flags":1},"Subtitle":{"Type":1416,"Flags":0},"Title":{"Type":1417,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"CustomFilterConfiguration","Properties":{"CategoryValue":{"Type":4,"Flags":0},"MatchOperator":{"Type":4,"Flags":1},"NullOption":{"Type":4,"Flags":1},"ParameterName":{"Type":4,"Flags":0},"SelectAllOptions":{"Type":4,"Flags":0}}}},{"2":{"Name":"CustomFilterListConfiguration","Properties":{"CategoryValues":{"Type":1472,"Flags":0},"MatchOperator":{"Type":4,"Flags":1},"NullOption":{"Type":4,"Flags":1},"SelectAllOptions":{"Type":4,"Flags":0}}}},{"2":{"Name":"CustomNarrativeOptions","Properties":{"Narrative":{"Type":4,"Flags":1}}}},{"2":{"Name":"CustomParameterValues","Properties":{"DateTimeValues":{"Type":1473,"Flags":0},"DecimalValues":{"Type":1474,"Flags":0},"IntegerValues":{"Type":1475,"Flags":0},"StringValues":{"Type":1476,"Flags":0}}}},{"2":{"Name":"CustomValuesConfiguration","Properties":{"CustomValues":{"Type":937,"Flags":1},"IncludeNullValue":{"Type":2,"Flags":0}}}},{"2":{"Name":"DashboardBehavior"}},{"2":{"Name":"DashboardError","Properties":{"Message":{"Type":4,"Flags":0},"Type":{"Type":4,"Flags":0},"ViolatedEntities":{"Type":1477,"Flags":0}}}},{"2":{"Name":"DashboardErrorType"}},{"2":{"Name":"DashboardPublishOptions","Properties":{"AdHocFilteringOption":{"Type":832,"Flags":0},"DataPointDrillUpDownOption":{"Type":962,"Flags":0},"DataPointMenuLabelOption":{"Type":963,"Flags":0},"DataPointTooltipOption":{"Type":964,"Flags":0},"ExportToCSVOption":{"Type":1002,"Flags":0},"ExportWithHiddenFieldsOption":{"Type":1003,"Flags":0},"SheetControlsOption":{"Type":1308,"Flags":0},"SheetLayoutElementMaximizationOption":{"Type":1312,"Flags":0},"VisualAxisSortOption":{"Type":1410,"Flags":0},"VisualMenuOption":{"Type":1414,"Flags":0},"VisualPublishOptions":{"Type":948,"Flags":0}}}},{"2":{"Name":"DashboardSourceEntity","Properties":{"SourceTemplate":{"Type":944,"Flags":0}}}},{"2":{"Name":"DashboardSourceTemplate","Properties":{"Arn":{"Type":4,"Flags":1},"DataSetReferences":{"Type":1478,"Flags":1}}}},{"2":{"Name":"DashboardUIState"}},{"2":{"Name":"DashboardVersion","Properties":{"Arn":{"Type":4,"Flags":0},"CreatedTime":{"Type":4,"Flags":0},"DataSetArns":{"Type":1479,"Flags":0},"Description":{"Type":4,"Flags":0},"Errors":{"Type":1480,"Flags":0},"Sheets":{"Type":1481,"Flags":0},"SourceEntityArn":{"Type":4,"Flags":0},"Status":{"Type":4,"Flags":0},"ThemeArn":{"Type":4,"Flags":0},"VersionNumber":{"Type":3,"Flags":0}}}},{"2":{"Name":"DashboardVersionDefinition","Properties":{"AnalysisDefaults":{"Type":836,"Flags":0},"CalculatedFields":{"Type":1482,"Flags":0},"ColumnConfigurations":{"Type":1483,"Flags":0},"DataSetIdentifierDeclarations":{"Type":1484,"Flags":1},"FilterGroups":{"Type":1485,"Flags":0},"Options":{"Type":845,"Flags":0},"ParameterDeclarations":{"Type":1486,"Flags":0},"Sheets":{"Type":1487,"Flags":0}}}},{"2":{"Name":"DashboardVisualPublishOptions","Properties":{"ExportHiddenFieldsOption":{"Type":1001,"Flags":0}}}},{"2":{"Name":"DataBarsOptions","Properties":{"FieldId":{"Type":4,"Flags":1},"NegativeColor":{"Type":4,"Flags":0},"PositiveColor":{"Type":4,"Flags":0}}}},{"2":{"Name":"DataColor","Properties":{"Color":{"Type":4,"Flags":0},"DataValue":{"Type":3,"Flags":0}}}},{"2":{"Name":"DataFieldSeriesItem","Properties":{"AxisBinding":{"Type":4,"Flags":1},"FieldId":{"Type":4,"Flags":1},"FieldValue":{"Type":4,"Flags":0},"Settings":{"Type":1139,"Flags":0}}}},{"2":{"Name":"DataLabelContent"}},{"2":{"Name":"DataLabelOptions","Properties":{"CategoryLabelVisibility":{"Type":4,"Flags":0},"DataLabelTypes":{"Type":1488,"Flags":0},"LabelColor":{"Type":4,"Flags":0},"LabelContent":{"Type":4,"Flags":0},"LabelFontConfiguration":{"Type":1035,"Flags":0},"MeasureLabelVisibility":{"Type":4,"Flags":0},"Overlap":{"Type":4,"Flags":0},"Position":{"Type":4,"Flags":0},"TotalsVisibility":{"Type":4,"Flags":0},"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"DataLabelOverlap"}},{"2":{"Name":"DataLabelPosition"}},{"2":{"Name":"DataLabelType","Properties":{"DataPathLabelType":{"Type":958,"Flags":0},"FieldLabelType":{"Type":1005,"Flags":0},"MaximumLabelType":{"Type":1154,"Flags":0},"MinimumLabelType":{"Type":1159,"Flags":0},"RangeEndsLabelType":{"Type":1249,"Flags":0}}}},{"2":{"Name":"DataPathColor","Properties":{"Color":{"Type":4,"Flags":1},"Element":{"Type":961,"Flags":1},"TimeGranularity":{"Type":4,"Flags":0}}}},{"2":{"Name":"DataPathLabelType","Properties":{"FieldId":{"Type":4,"Flags":0},"FieldValue":{"Type":4,"Flags":0},"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"DataPathSort","Properties":{"Direction":{"Type":4,"Flags":1},"SortPaths":{"Type":1489,"Flags":1}}}},{"2":{"Name":"DataPathType","Properties":{"PivotTableDataPathType":{"Type":4,"Flags":0}}}},{"2":{"Name":"DataPathValue","Properties":{"DataPathType":{"Type":960,"Flags":0},"FieldId":{"Type":4,"Flags":0},"FieldValue":{"Type":4,"Flags":0}}}},{"2":{"Name":"DataPointDrillUpDownOption","Properties":{"AvailabilityStatus":{"Type":4,"Flags":0}}}},{"2":{"Name":"DataPointMenuLabelOption","Properties":{"AvailabilityStatus":{"Type":4,"Flags":0}}}},{"2":{"Name":"DataPointTooltipOption","Properties":{"AvailabilityStatus":{"Type":4,"Flags":0}}}},{"2":{"Name":"DataSetIdentifierDeclaration","Properties":{"DataSetArn":{"Type":4,"Flags":1},"Identifier":{"Type":4,"Flags":1}}}},{"2":{"Name":"DataSetReference","Properties":{"DataSetArn":{"Type":4,"Flags":1},"DataSetPlaceholder":{"Type":4,"Flags":1}}}},{"2":{"Name":"DateAggregationFunction"}},{"2":{"Name":"DateAxisOptions","Properties":{"MissingDateVisibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"DateDimensionField","Properties":{"Column":{"Type":899,"Flags":1},"DateGranularity":{"Type":4,"Flags":0},"FieldId":{"Type":4,"Flags":1},"FormatConfiguration":{"Type":972,"Flags":0},"HierarchyId":{"Type":4,"Flags":0}}}},{"2":{"Name":"DateMeasureField","Properties":{"AggregationFunction":{"Type":4,"Flags":0},"Column":{"Type":899,"Flags":1},"FieldId":{"Type":4,"Flags":1},"FormatConfiguration":{"Type":972,"Flags":0}}}},{"2":{"Name":"DateTimeDefaultValues","Properties":{"DynamicValue":{"Type":996,"Flags":0},"RollingDate":{"Type":1270,"Flags":0},"StaticValues":{"Type":1490,"Flags":0}}}},{"2":{"Name":"DateTimeFormatConfiguration","Properties":{"DateTimeFormat":{"Type":4,"Flags":0},"NullValueFormatConfiguration":{"Type":1164,"Flags":0},"NumericFormatConfiguration":{"Type":1173,"Flags":0}}}},{"2":{"Name":"DateTimeHierarchy","Properties":{"DrillDownFilters":{"Type":1491,"Flags":0},"HierarchyId":{"Type":4,"Flags":1}}}},{"2":{"Name":"DateTimeParameter","Properties":{"Name":{"Type":4,"Flags":1},"Values":{"Type":1492,"Flags":1}}}},{"2":{"Name":"DateTimeParameterDeclaration","Properties":{"DefaultValues":{"Type":971,"Flags":0},"MappedDataSetParameters":{"Type":1493,"Flags":0},"Name":{"Type":4,"Flags":1},"TimeGranularity":{"Type":4,"Flags":0},"ValueWhenUnset":{"Type":977,"Flags":0}}}},{"2":{"Name":"DateTimePickerControlDisplayOptions","Properties":{"DateTimeFormat":{"Type":4,"Flags":0},"InfoIconLabelOptions":{"Type":1303,"Flags":0},"TitleOptions":{"Type":1125,"Flags":0}}}},{"2":{"Name":"DateTimeValueWhenUnsetConfiguration","Properties":{"CustomValue":{"Type":4,"Flags":0},"ValueWhenUnsetOption":{"Type":4,"Flags":0}}}},{"2":{"Name":"DayOfTheWeek"}},{"2":{"Name":"DecimalDefaultValues","Properties":{"DynamicValue":{"Type":996,"Flags":0},"StaticValues":{"Type":1494,"Flags":0}}}},{"2":{"Name":"DecimalParameter","Properties":{"Name":{"Type":4,"Flags":1},"Values":{"Type":1495,"Flags":1}}}},{"2":{"Name":"DecimalParameterDeclaration","Properties":{"DefaultValues":{"Type":979,"Flags":0},"MappedDataSetParameters":{"Type":1496,"Flags":0},"Name":{"Type":4,"Flags":1},"ParameterValueType":{"Type":4,"Flags":1},"ValueWhenUnset":{"Type":983,"Flags":0}}}},{"2":{"Name":"DecimalPlacesConfiguration","Properties":{"DecimalPlaces":{"Type":3,"Flags":1}}}},{"2":{"Name":"DecimalValueWhenUnsetConfiguration","Properties":{"CustomValue":{"Type":3,"Flags":0},"ValueWhenUnsetOption":{"Type":4,"Flags":0}}}},{"2":{"Name":"DefaultFreeFormLayoutConfiguration","Properties":{"CanvasSizeOptions":{"Type":1046,"Flags":1}}}},{"2":{"Name":"DefaultGridLayoutConfiguration","Properties":{"CanvasSizeOptions":{"Type":1083,"Flags":1}}}},{"2":{"Name":"DefaultInteractiveLayoutConfiguration","Properties":{"FreeForm":{"Type":984,"Flags":0},"Grid":{"Type":985,"Flags":0}}}},{"2":{"Name":"DefaultNewSheetConfiguration","Properties":{"InteractiveLayoutConfiguration":{"Type":986,"Flags":0},"PaginatedLayoutConfiguration":{"Type":988,"Flags":0},"SheetContentType":{"Type":4,"Flags":0}}}},{"2":{"Name":"DefaultPaginatedLayoutConfiguration","Properties":{"SectionBased":{"Type":989,"Flags":0}}}},{"2":{"Name":"DefaultSectionBasedLayoutConfiguration","Properties":{"CanvasSizeOptions":{"Type":1286,"Flags":1}}}},{"2":{"Name":"DestinationParameterValueConfiguration","Properties":{"CustomValuesConfiguration":{"Type":938,"Flags":0},"SelectAllValueOptions":{"Type":4,"Flags":0},"SourceColumn":{"Type":899,"Flags":0},"SourceField":{"Type":4,"Flags":0},"SourceParameterName":{"Type":4,"Flags":0}}}},{"2":{"Name":"DimensionField","Properties":{"CategoricalDimensionField":{"Type":884,"Flags":0},"DateDimensionField":{"Type":969,"Flags":0},"NumericalDimensionField":{"Type":1179,"Flags":0}}}},{"2":{"Name":"DonutCenterOptions","Properties":{"LabelVisibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"DonutOptions","Properties":{"ArcOptions":{"Type":842,"Flags":0},"DonutCenterOptions":{"Type":992,"Flags":0}}}},{"2":{"Name":"DrillDownFilter","Properties":{"CategoryFilter":{"Type":886,"Flags":0},"NumericEqualityFilter":{"Type":1169,"Flags":0},"TimeRangeFilter":{"Type":1379,"Flags":0}}}},{"2":{"Name":"DropDownControlDisplayOptions","Properties":{"InfoIconLabelOptions":{"Type":1303,"Flags":0},"SelectAllOptions":{"Type":1148,"Flags":0},"TitleOptions":{"Type":1125,"Flags":0}}}},{"2":{"Name":"DynamicDefaultValue","Properties":{"DefaultValueColumn":{"Type":899,"Flags":1},"GroupNameColumn":{"Type":899,"Flags":0},"UserNameColumn":{"Type":899,"Flags":0}}}},{"2":{"Name":"EmptyVisual","Properties":{"Actions":{"Type":1497,"Flags":0},"DataSetIdentifier":{"Type":4,"Flags":1},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"Entity","Properties":{"Path":{"Type":4,"Flags":0}}}},{"2":{"Name":"ExcludePeriodConfiguration","Properties":{"Amount":{"Type":3,"Flags":1},"Granularity":{"Type":4,"Flags":1},"Status":{"Type":4,"Flags":0}}}},{"2":{"Name":"ExplicitHierarchy","Properties":{"Columns":{"Type":1498,"Flags":1},"DrillDownFilters":{"Type":1499,"Flags":0},"HierarchyId":{"Type":4,"Flags":1}}}},{"2":{"Name":"ExportHiddenFieldsOption","Properties":{"AvailabilityStatus":{"Type":4,"Flags":0}}}},{"2":{"Name":"ExportToCSVOption","Properties":{"AvailabilityStatus":{"Type":4,"Flags":0}}}},{"2":{"Name":"ExportWithHiddenFieldsOption","Properties":{"AvailabilityStatus":{"Type":4,"Flags":0}}}},{"2":{"Name":"FieldBasedTooltip","Properties":{"AggregationVisibility":{"Type":4,"Flags":0},"TooltipFields":{"Type":1500,"Flags":0},"TooltipTitleType":{"Type":4,"Flags":0}}}},{"2":{"Name":"FieldLabelType","Properties":{"FieldId":{"Type":4,"Flags":0},"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"FieldSeriesItem","Properties":{"AxisBinding":{"Type":4,"Flags":1},"FieldId":{"Type":4,"Flags":1},"Settings":{"Type":1139,"Flags":0}}}},{"2":{"Name":"FieldSort","Properties":{"Direction":{"Type":4,"Flags":1},"FieldId":{"Type":4,"Flags":1}}}},{"2":{"Name":"FieldSortOptions","Properties":{"ColumnSort":{"Type":901,"Flags":0},"FieldSort":{"Type":1007,"Flags":0}}}},{"2":{"Name":"FieldTooltipItem","Properties":{"FieldId":{"Type":4,"Flags":1},"Label":{"Type":4,"Flags":0},"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"FilledMapAggregatedFieldWells","Properties":{"Geospatial":{"Type":1501,"Flags":0},"Values":{"Type":1502,"Flags":0}}}},{"2":{"Name":"FilledMapConditionalFormatting","Properties":{"ConditionalFormattingOptions":{"Type":1503,"Flags":1}}}},{"2":{"Name":"FilledMapConditionalFormattingOption","Properties":{"Shape":{"Type":1015,"Flags":1}}}},{"2":{"Name":"FilledMapConfiguration","Properties":{"FieldWells":{"Type":1014,"Flags":0},"Legend":{"Type":1129,"Flags":0},"MapStyleOptions":{"Type":1075,"Flags":0},"SortConfiguration":{"Type":1016,"Flags":0},"Tooltip":{"Type":1383,"Flags":0},"WindowOptions":{"Type":1079,"Flags":0}}}},{"2":{"Name":"FilledMapFieldWells","Properties":{"FilledMapAggregatedFieldWells":{"Type":1010,"Flags":0}}}},{"2":{"Name":"FilledMapShapeConditionalFormatting","Properties":{"FieldId":{"Type":4,"Flags":1},"Format":{"Type":1299,"Flags":0}}}},{"2":{"Name":"FilledMapSortConfiguration","Properties":{"CategorySort":{"Type":1504,"Flags":0}}}},{"2":{"Name":"FilledMapVisual","Properties":{"Actions":{"Type":1505,"Flags":0},"ChartConfiguration":{"Type":1013,"Flags":0},"ColumnHierarchies":{"Type":1506,"Flags":0},"ConditionalFormatting":{"Type":1011,"Flags":0},"Subtitle":{"Type":1416,"Flags":0},"Title":{"Type":1417,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"Filter","Properties":{"CategoryFilter":{"Type":887,"Flags":0},"NumericEqualityFilter":{"Type":1170,"Flags":0},"NumericRangeFilter":{"Type":1174,"Flags":0},"RelativeDatesFilter":{"Type":1265,"Flags":0},"TimeEqualityFilter":{"Type":1377,"Flags":0},"TimeRangeFilter":{"Type":1380,"Flags":0},"TopBottomFilter":{"Type":1386,"Flags":0}}}},{"2":{"Name":"FilterControl","Properties":{"DateTimePicker":{"Type":1020,"Flags":0},"Dropdown":{"Type":1021,"Flags":0},"List":{"Type":1024,"Flags":0},"RelativeDateTime":{"Type":1028,"Flags":0},"Slider":{"Type":1031,"Flags":0},"TextArea":{"Type":1032,"Flags":0},"TextField":{"Type":1033,"Flags":0}}}},{"2":{"Name":"FilterDateTimePickerControl","Properties":{"DisplayOptions":{"Type":976,"Flags":0},"FilterControlId":{"Type":4,"Flags":1},"SourceFilterId":{"Type":4,"Flags":1},"Title":{"Type":4,"Flags":1},"Type":{"Type":4,"Flags":0}}}},{"2":{"Name":"FilterDropDownControl","Properties":{"CascadingControlConfiguration":{"Type":881,"Flags":0},"DisplayOptions":{"Type":995,"Flags":0},"FilterControlId":{"Type":4,"Flags":1},"SelectableValues":{"Type":1030,"Flags":0},"SourceFilterId":{"Type":4,"Flags":1},"Title":{"Type":4,"Flags":1},"Type":{"Type":4,"Flags":0}}}},{"2":{"Name":"FilterGroup","Properties":{"CrossDataset":{"Type":4,"Flags":1},"FilterGroupId":{"Type":4,"Flags":1},"Filters":{"Type":1507,"Flags":1},"ScopeConfiguration":{"Type":1029,"Flags":1},"Status":{"Type":4,"Flags":0}}}},{"2":{"Name":"FilterListConfiguration","Properties":{"CategoryValues":{"Type":1508,"Flags":0},"MatchOperator":{"Type":4,"Flags":1},"NullOption":{"Type":4,"Flags":0},"SelectAllOptions":{"Type":4,"Flags":0}}}},{"2":{"Name":"FilterListControl","Properties":{"CascadingControlConfiguration":{"Type":881,"Flags":0},"DisplayOptions":{"Type":1146,"Flags":0},"FilterControlId":{"Type":4,"Flags":1},"SelectableValues":{"Type":1030,"Flags":0},"SourceFilterId":{"Type":4,"Flags":1},"Title":{"Type":4,"Flags":1},"Type":{"Type":4,"Flags":0}}}},{"2":{"Name":"FilterNullOption"}},{"2":{"Name":"FilterOperationSelectedFieldsConfiguration","Properties":{"SelectedColumns":{"Type":1509,"Flags":0},"SelectedFieldOptions":{"Type":4,"Flags":0},"SelectedFields":{"Type":1510,"Flags":0}}}},{"2":{"Name":"FilterOperationTargetVisualsConfiguration","Properties":{"SameSheetTargetVisualConfiguration":{"Type":1272,"Flags":0}}}},{"2":{"Name":"FilterRelativeDateTimeControl","Properties":{"DisplayOptions":{"Type":1263,"Flags":0},"FilterControlId":{"Type":4,"Flags":1},"SourceFilterId":{"Type":4,"Flags":1},"Title":{"Type":4,"Flags":1}}}},{"2":{"Name":"FilterScopeConfiguration","Properties":{"AllSheets":{"Type":835,"Flags":0},"SelectedSheets":{"Type":1295,"Flags":0}}}},{"2":{"Name":"FilterSelectableValues","Properties":{"Values":{"Type":1511,"Flags":0}}}},{"2":{"Name":"FilterSliderControl","Properties":{"DisplayOptions":{"Type":1320,"Flags":0},"FilterControlId":{"Type":4,"Flags":1},"MaximumValue":{"Type":3,"Flags":1},"MinimumValue":{"Type":3,"Flags":1},"SourceFilterId":{"Type":4,"Flags":1},"StepSize":{"Type":3,"Flags":1},"Title":{"Type":4,"Flags":1},"Type":{"Type":4,"Flags":0}}}},{"2":{"Name":"FilterTextAreaControl","Properties":{"Delimiter":{"Type":4,"Flags":0},"DisplayOptions":{"Type":1370,"Flags":0},"FilterControlId":{"Type":4,"Flags":1},"SourceFilterId":{"Type":4,"Flags":1},"Title":{"Type":4,"Flags":1}}}},{"2":{"Name":"FilterTextFieldControl","Properties":{"DisplayOptions":{"Type":1373,"Flags":0},"FilterControlId":{"Type":4,"Flags":1},"SourceFilterId":{"Type":4,"Flags":1},"Title":{"Type":4,"Flags":1}}}},{"2":{"Name":"FilterVisualScope"}},{"2":{"Name":"FontConfiguration","Properties":{"FontColor":{"Type":4,"Flags":0},"FontDecoration":{"Type":4,"Flags":0},"FontSize":{"Type":1037,"Flags":0},"FontStyle":{"Type":4,"Flags":0},"FontWeight":{"Type":1039,"Flags":0}}}},{"2":{"Name":"FontDecoration"}},{"2":{"Name":"FontSize","Properties":{"Relative":{"Type":4,"Flags":0}}}},{"2":{"Name":"FontStyle"}},{"2":{"Name":"FontWeight","Properties":{"Name":{"Type":4,"Flags":0}}}},{"2":{"Name":"FontWeightName"}},{"2":{"Name":"ForecastComputation","Properties":{"ComputationId":{"Type":4,"Flags":1},"CustomSeasonalityValue":{"Type":3,"Flags":0},"LowerBoundary":{"Type":3,"Flags":0},"Name":{"Type":4,"Flags":0},"PeriodsBackward":{"Type":3,"Flags":0},"PeriodsForward":{"Type":3,"Flags":0},"PredictionInterval":{"Type":3,"Flags":0},"Seasonality":{"Type":4,"Flags":0},"Time":{"Type":991,"Flags":0},"UpperBoundary":{"Type":3,"Flags":0},"Value":{"Type":1157,"Flags":0}}}},{"2":{"Name":"ForecastComputationSeasonality"}},{"2":{"Name":"ForecastConfiguration","Properties":{"ForecastProperties":{"Type":1376,"Flags":0},"Scenario":{"Type":1044,"Flags":0}}}},{"2":{"Name":"ForecastScenario","Properties":{"WhatIfPointScenario":{"Type":1424,"Flags":0},"WhatIfRangeScenario":{"Type":1425,"Flags":0}}}},{"2":{"Name":"FormatConfiguration","Properties":{"DateTimeFormatConfiguration":{"Type":972,"Flags":0},"NumberFormatConfiguration":{"Type":1166,"Flags":0},"StringFormatConfiguration":{"Type":1329,"Flags":0}}}},{"2":{"Name":"FreeFormLayoutCanvasSizeOptions","Properties":{"ScreenCanvasSizeOptions":{"Type":1051,"Flags":0}}}},{"2":{"Name":"FreeFormLayoutConfiguration","Properties":{"CanvasSizeOptions":{"Type":1046,"Flags":0},"Elements":{"Type":1512,"Flags":1}}}},{"2":{"Name":"FreeFormLayoutElement","Properties":{"BackgroundStyle":{"Type":1049,"Flags":0},"BorderStyle":{"Type":1050,"Flags":0},"ElementId":{"Type":4,"Flags":1},"ElementType":{"Type":4,"Flags":1},"Height":{"Type":4,"Flags":1,"Description":"String based length that is composed of value and unit in px"},"LoadingAnimation":{"Type":1149,"Flags":0},"RenderingRules":{"Type":1513,"Flags":0},"SelectedBorderStyle":{"Type":1050,"Flags":0},"Visibility":{"Type":4,"Flags":0},"Width":{"Type":4,"Flags":1,"Description":"String based length that is composed of value and unit in px"},"XAxisLocation":{"Type":4,"Flags":1,"Description":"String based length that is composed of value and unit in px"},"YAxisLocation":{"Type":4,"Flags":1,"Description":"String based length that is composed of value and unit in px with Integer.MAX_VALUE as maximum value"}}}},{"2":{"Name":"FreeFormLayoutElementBackgroundStyle","Properties":{"Color":{"Type":4,"Flags":0},"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"FreeFormLayoutElementBorderStyle","Properties":{"Color":{"Type":4,"Flags":0},"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"FreeFormLayoutScreenCanvasSizeOptions","Properties":{"OptimizedViewPortWidth":{"Type":4,"Flags":1,"Description":"String based length that is composed of value and unit in px"}}}},{"2":{"Name":"FreeFormSectionLayoutConfiguration","Properties":{"Elements":{"Type":1514,"Flags":1}}}},{"2":{"Name":"FunnelChartAggregatedFieldWells","Properties":{"Category":{"Type":1515,"Flags":0},"Values":{"Type":1516,"Flags":0}}}},{"2":{"Name":"FunnelChartConfiguration","Properties":{"CategoryLabelOptions":{"Type":891,"Flags":0},"DataLabelOptions":{"Type":1055,"Flags":0},"FieldWells":{"Type":1056,"Flags":0},"SortConfiguration":{"Type":1058,"Flags":0},"Tooltip":{"Type":1383,"Flags":0},"ValueLabelOptions":{"Type":891,"Flags":0},"VisualPalette":{"Type":1415,"Flags":0}}}},{"2":{"Name":"FunnelChartDataLabelOptions","Properties":{"CategoryLabelVisibility":{"Type":4,"Flags":0},"LabelColor":{"Type":4,"Flags":0},"LabelFontConfiguration":{"Type":1035,"Flags":0},"MeasureDataLabelStyle":{"Type":4,"Flags":0},"MeasureLabelVisibility":{"Type":4,"Flags":0},"Position":{"Type":4,"Flags":0},"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"FunnelChartFieldWells","Properties":{"FunnelChartAggregatedFieldWells":{"Type":1053,"Flags":0}}}},{"2":{"Name":"FunnelChartMeasureDataLabelStyle"}},{"2":{"Name":"FunnelChartSortConfiguration","Properties":{"CategoryItemsLimit":{"Type":1108,"Flags":0},"CategorySort":{"Type":1517,"Flags":0}}}},{"2":{"Name":"FunnelChartVisual","Properties":{"Actions":{"Type":1518,"Flags":0},"ChartConfiguration":{"Type":1054,"Flags":0},"ColumnHierarchies":{"Type":1519,"Flags":0},"Subtitle":{"Type":1416,"Flags":0},"Title":{"Type":1417,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"GaugeChartArcConditionalFormatting","Properties":{"ForegroundColor":{"Type":912,"Flags":0}}}},{"2":{"Name":"GaugeChartConditionalFormatting","Properties":{"ConditionalFormattingOptions":{"Type":1520,"Flags":0}}}},{"2":{"Name":"GaugeChartConditionalFormattingOption","Properties":{"Arc":{"Type":1060,"Flags":0},"PrimaryValue":{"Type":1066,"Flags":0}}}},{"2":{"Name":"GaugeChartConfiguration","Properties":{"DataLabels":{"Type":953,"Flags":0},"FieldWells":{"Type":1064,"Flags":0},"GaugeChartOptions":{"Type":1065,"Flags":0},"TooltipOptions":{"Type":1383,"Flags":0},"VisualPalette":{"Type":1415,"Flags":0}}}},{"2":{"Name":"GaugeChartFieldWells","Properties":{"TargetValues":{"Type":1521,"Flags":0},"Values":{"Type":1522,"Flags":0}}}},{"2":{"Name":"GaugeChartOptions","Properties":{"Arc":{"Type":841,"Flags":0},"ArcAxis":{"Type":839,"Flags":0},"Comparison":{"Type":908,"Flags":0},"PrimaryValueDisplayType":{"Type":4,"Flags":0},"PrimaryValueFontConfiguration":{"Type":1035,"Flags":0}}}},{"2":{"Name":"GaugeChartPrimaryValueConditionalFormatting","Properties":{"Icon":{"Type":916,"Flags":0},"TextColor":{"Type":912,"Flags":0}}}},{"2":{"Name":"GaugeChartVisual","Properties":{"Actions":{"Type":1523,"Flags":0},"ChartConfiguration":{"Type":1063,"Flags":0},"ConditionalFormatting":{"Type":1061,"Flags":0},"Subtitle":{"Type":1416,"Flags":0},"Title":{"Type":1417,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"GeospatialCoordinateBounds","Properties":{"East":{"Type":3,"Flags":1},"North":{"Type":3,"Flags":1},"South":{"Type":3,"Flags":1},"West":{"Type":3,"Flags":1}}}},{"2":{"Name":"GeospatialHeatmapColorScale","Properties":{"Colors":{"Type":1524,"Flags":0}}}},{"2":{"Name":"GeospatialHeatmapConfiguration","Properties":{"HeatmapColor":{"Type":1069,"Flags":0}}}},{"2":{"Name":"GeospatialHeatmapDataColor","Properties":{"Color":{"Type":4,"Flags":1}}}},{"2":{"Name":"GeospatialMapAggregatedFieldWells","Properties":{"Colors":{"Type":1525,"Flags":0},"Geospatial":{"Type":1526,"Flags":0},"Values":{"Type":1527,"Flags":0}}}},{"2":{"Name":"GeospatialMapConfiguration","Properties":{"FieldWells":{"Type":1074,"Flags":0},"Legend":{"Type":1129,"Flags":0},"MapStyleOptions":{"Type":1075,"Flags":0},"PointStyleOptions":{"Type":1077,"Flags":0},"Tooltip":{"Type":1383,"Flags":0},"VisualPalette":{"Type":1415,"Flags":0},"WindowOptions":{"Type":1079,"Flags":0}}}},{"2":{"Name":"GeospatialMapFieldWells","Properties":{"GeospatialMapAggregatedFieldWells":{"Type":1072,"Flags":0}}}},{"2":{"Name":"GeospatialMapStyleOptions","Properties":{"BaseMapStyle":{"Type":4,"Flags":0}}}},{"2":{"Name":"GeospatialMapVisual","Properties":{"Actions":{"Type":1528,"Flags":0},"ChartConfiguration":{"Type":1073,"Flags":0},"ColumnHierarchies":{"Type":1529,"Flags":0},"Subtitle":{"Type":1416,"Flags":0},"Title":{"Type":1417,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"GeospatialPointStyleOptions","Properties":{"ClusterMarkerConfiguration":{"Type":893,"Flags":0},"HeatmapConfiguration":{"Type":1070,"Flags":0},"SelectedPointStyle":{"Type":4,"Flags":0}}}},{"2":{"Name":"GeospatialSelectedPointStyle"}},{"2":{"Name":"GeospatialWindowOptions","Properties":{"Bounds":{"Type":1068,"Flags":0},"MapZoomMode":{"Type":4,"Flags":0}}}},{"2":{"Name":"GlobalTableBorderOptions","Properties":{"SideSpecificBorder":{"Type":1361,"Flags":0},"UniformBorder":{"Type":1336,"Flags":0}}}},{"2":{"Name":"GradientColor","Properties":{"Stops":{"Type":1530,"Flags":0}}}},{"2":{"Name":"GradientStop","Properties":{"Color":{"Type":4,"Flags":0},"DataValue":{"Type":3,"Flags":0},"GradientOffset":{"Type":3,"Flags":1}}}},{"2":{"Name":"GridLayoutCanvasSizeOptions","Properties":{"ScreenCanvasSizeOptions":{"Type":1086,"Flags":0}}}},{"2":{"Name":"GridLayoutConfiguration","Properties":{"CanvasSizeOptions":{"Type":1083,"Flags":0},"Elements":{"Type":1531,"Flags":1}}}},{"2":{"Name":"GridLayoutElement","Properties":{"ColumnIndex":{"Type":3,"Flags":0},"ColumnSpan":{"Type":3,"Flags":1},"ElementId":{"Type":4,"Flags":1},"ElementType":{"Type":4,"Flags":1},"RowIndex":{"Type":3,"Flags":0},"RowSpan":{"Type":3,"Flags":1}}}},{"2":{"Name":"GridLayoutScreenCanvasSizeOptions","Properties":{"OptimizedViewPortWidth":{"Type":4,"Flags":0,"Description":"String based length that is composed of value and unit in px"},"ResizeOption":{"Type":4,"Flags":1}}}},{"2":{"Name":"GrowthRateComputation","Properties":{"ComputationId":{"Type":4,"Flags":1},"Name":{"Type":4,"Flags":0},"PeriodSize":{"Type":3,"Flags":0},"Time":{"Type":991,"Flags":0},"Value":{"Type":1157,"Flags":0}}}},{"2":{"Name":"HeaderFooterSectionConfiguration","Properties":{"Layout":{"Type":1289,"Flags":1},"SectionId":{"Type":4,"Flags":1},"Style":{"Type":1292,"Flags":0}}}},{"2":{"Name":"HeatMapAggregatedFieldWells","Properties":{"Columns":{"Type":1532,"Flags":0},"Rows":{"Type":1533,"Flags":0},"Values":{"Type":1534,"Flags":0}}}},{"2":{"Name":"HeatMapConfiguration","Properties":{"ColorScale":{"Type":895,"Flags":0},"ColumnLabelOptions":{"Type":891,"Flags":0},"DataLabels":{"Type":953,"Flags":0},"FieldWells":{"Type":1091,"Flags":0},"Legend":{"Type":1129,"Flags":0},"RowLabelOptions":{"Type":891,"Flags":0},"SortConfiguration":{"Type":1092,"Flags":0},"Tooltip":{"Type":1383,"Flags":0}}}},{"2":{"Name":"HeatMapFieldWells","Properties":{"HeatMapAggregatedFieldWells":{"Type":1089,"Flags":0}}}},{"2":{"Name":"HeatMapSortConfiguration","Properties":{"HeatMapColumnItemsLimitConfiguration":{"Type":1108,"Flags":0},"HeatMapColumnSort":{"Type":1535,"Flags":0},"HeatMapRowItemsLimitConfiguration":{"Type":1108,"Flags":0},"HeatMapRowSort":{"Type":1536,"Flags":0}}}},{"2":{"Name":"HeatMapVisual","Properties":{"Actions":{"Type":1537,"Flags":0},"ChartConfiguration":{"Type":1090,"Flags":0},"ColumnHierarchies":{"Type":1538,"Flags":0},"Subtitle":{"Type":1416,"Flags":0},"Title":{"Type":1417,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"HistogramAggregatedFieldWells","Properties":{"Values":{"Type":1539,"Flags":0}}}},{"2":{"Name":"HistogramBinOptions","Properties":{"BinCount":{"Type":867,"Flags":0},"BinWidth":{"Type":868,"Flags":0},"SelectedBinType":{"Type":4,"Flags":0},"StartValue":{"Type":3,"Flags":0}}}},{"2":{"Name":"HistogramBinType"}},{"2":{"Name":"HistogramConfiguration","Properties":{"BinOptions":{"Type":1095,"Flags":0},"DataLabels":{"Type":953,"Flags":0},"FieldWells":{"Type":1098,"Flags":0},"Tooltip":{"Type":1383,"Flags":0},"VisualPalette":{"Type":1415,"Flags":0},"XAxisDisplayOptions":{"Type":851,"Flags":0},"XAxisLabelOptions":{"Type":891,"Flags":0},"YAxisDisplayOptions":{"Type":851,"Flags":0}}}},{"2":{"Name":"HistogramFieldWells","Properties":{"HistogramAggregatedFieldWells":{"Type":1094,"Flags":0}}}},{"2":{"Name":"HistogramVisual","Properties":{"Actions":{"Type":1540,"Flags":0},"ChartConfiguration":{"Type":1097,"Flags":0},"Subtitle":{"Type":1416,"Flags":0},"Title":{"Type":1417,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"HorizontalTextAlignment"}},{"2":{"Name":"Icon"}},{"2":{"Name":"InsightConfiguration","Properties":{"Computations":{"Type":1541,"Flags":0},"CustomNarrative":{"Type":936,"Flags":0}}}},{"2":{"Name":"InsightVisual","Properties":{"Actions":{"Type":1542,"Flags":0},"DataSetIdentifier":{"Type":4,"Flags":1},"InsightConfiguration":{"Type":1102,"Flags":0},"Subtitle":{"Type":1416,"Flags":0},"Title":{"Type":1417,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"IntegerDefaultValues","Properties":{"DynamicValue":{"Type":996,"Flags":0},"StaticValues":{"Type":1543,"Flags":0}}}},{"2":{"Name":"IntegerParameter","Properties":{"Name":{"Type":4,"Flags":1},"Values":{"Type":1544,"Flags":1}}}},{"2":{"Name":"IntegerParameterDeclaration","Properties":{"DefaultValues":{"Type":1104,"Flags":0},"MappedDataSetParameters":{"Type":1545,"Flags":0},"Name":{"Type":4,"Flags":1},"ParameterValueType":{"Type":4,"Flags":1},"ValueWhenUnset":{"Type":1107,"Flags":0}}}},{"2":{"Name":"IntegerValueWhenUnsetConfiguration","Properties":{"CustomValue":{"Type":3,"Flags":0},"ValueWhenUnsetOption":{"Type":4,"Flags":0}}}},{"2":{"Name":"ItemsLimitConfiguration","Properties":{"ItemsLimit":{"Type":3,"Flags":0},"OtherCategories":{"Type":4,"Flags":0}}}},{"2":{"Name":"KPIActualValueConditionalFormatting","Properties":{"Icon":{"Type":916,"Flags":0},"TextColor":{"Type":912,"Flags":0}}}},{"2":{"Name":"KPIComparisonValueConditionalFormatting","Properties":{"Icon":{"Type":916,"Flags":0},"TextColor":{"Type":912,"Flags":0}}}},{"2":{"Name":"KPIConditionalFormatting","Properties":{"ConditionalFormattingOptions":{"Type":1546,"Flags":0}}}},{"2":{"Name":"KPIConditionalFormattingOption","Properties":{"ActualValue":{"Type":1109,"Flags":0},"ComparisonValue":{"Type":1110,"Flags":0},"PrimaryValue":{"Type":1116,"Flags":0},"ProgressBar":{"Type":1117,"Flags":0}}}},{"2":{"Name":"KPIConfiguration","Properties":{"FieldWells":{"Type":1114,"Flags":0},"KPIOptions":{"Type":1115,"Flags":0},"SortConfiguration":{"Type":1118,"Flags":0}}}},{"2":{"Name":"KPIFieldWells","Properties":{"TargetValues":{"Type":1547,"Flags":0},"TrendGroups":{"Type":1548,"Flags":0},"Values":{"Type":1549,"Flags":0}}}},{"2":{"Name":"KPIOptions","Properties":{"Comparison":{"Type":908,"Flags":0},"PrimaryValueDisplayType":{"Type":4,"Flags":0},"PrimaryValueFontConfiguration":{"Type":1035,"Flags":0},"ProgressBar":{"Type":1239,"Flags":0},"SecondaryValue":{"Type":1284,"Flags":0},"SecondaryValueFontConfiguration":{"Type":1035,"Flags":0},"Sparkline":{"Type":1119,"Flags":0},"TrendArrows":{"Type":1399,"Flags":0},"VisualLayoutOptions":{"Type":1122,"Flags":0}}}},{"2":{"Name":"KPIPrimaryValueConditionalFormatting","Properties":{"Icon":{"Type":916,"Flags":0},"TextColor":{"Type":912,"Flags":0}}}},{"2":{"Name":"KPIProgressBarConditionalFormatting","Properties":{"ForegroundColor":{"Type":912,"Flags":0}}}},{"2":{"Name":"KPISortConfiguration","Properties":{"TrendGroupSort":{"Type":1550,"Flags":0}}}},{"2":{"Name":"KPISparklineOptions","Properties":{"Color":{"Type":4,"Flags":0},"TooltipVisibility":{"Type":4,"Flags":0},"Type":{"Type":4,"Flags":1},"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"KPISparklineType"}},{"2":{"Name":"KPIVisual","Properties":{"Actions":{"Type":1551,"Flags":0},"ChartConfiguration":{"Type":1113,"Flags":0},"ColumnHierarchies":{"Type":1552,"Flags":0},"ConditionalFormatting":{"Type":1111,"Flags":0},"Subtitle":{"Type":1416,"Flags":0},"Title":{"Type":1417,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"KPIVisualLayoutOptions","Properties":{"StandardLayout":{"Type":1123,"Flags":0}}}},{"2":{"Name":"KPIVisualStandardLayout","Properties":{"Type":{"Type":4,"Flags":1}}}},{"2":{"Name":"KPIVisualStandardLayoutType"}},{"2":{"Name":"LabelOptions","Properties":{"CustomLabel":{"Type":4,"Flags":0},"FontConfiguration":{"Type":1035,"Flags":0},"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"Layout","Properties":{"Configuration":{"Type":1127,"Flags":1}}}},{"2":{"Name":"LayoutConfiguration","Properties":{"FreeFormLayout":{"Type":1047,"Flags":0},"GridLayout":{"Type":1084,"Flags":0},"SectionBasedLayout":{"Type":1287,"Flags":0}}}},{"2":{"Name":"LayoutElementType"}},{"2":{"Name":"LegendOptions","Properties":{"Height":{"Type":4,"Flags":0,"Description":"String based length that is composed of value and unit in px"},"Position":{"Type":4,"Flags":0},"Title":{"Type":1125,"Flags":0},"Visibility":{"Type":4,"Flags":0},"Width":{"Type":4,"Flags":0,"Description":"String based length that is composed of value and unit in px"}}}},{"2":{"Name":"LegendPosition"}},{"2":{"Name":"LineChartAggregatedFieldWells","Properties":{"Category":{"Type":1553,"Flags":0},"Colors":{"Type":1554,"Flags":0},"SmallMultiples":{"Type":1555,"Flags":0},"Values":{"Type":1556,"Flags":0}}}},{"2":{"Name":"LineChartConfiguration","Properties":{"ContributionAnalysisDefaults":{"Type":1557,"Flags":0},"DataLabels":{"Type":953,"Flags":0},"DefaultSeriesSettings":{"Type":1133,"Flags":0},"FieldWells":{"Type":1134,"Flags":0},"ForecastConfigurations":{"Type":1558,"Flags":0},"Legend":{"Type":1129,"Flags":0},"PrimaryYAxisDisplayOptions":{"Type":1144,"Flags":0},"PrimaryYAxisLabelOptions":{"Type":891,"Flags":0},"ReferenceLines":{"Type":1559,"Flags":0},"SecondaryYAxisDisplayOptions":{"Type":1144,"Flags":0},"SecondaryYAxisLabelOptions":{"Type":891,"Flags":0},"Series":{"Type":1560,"Flags":0},"SmallMultiplesOptions":{"Type":1324,"Flags":0},"SortConfiguration":{"Type":1140,"Flags":0},"Tooltip":{"Type":1383,"Flags":0},"Type":{"Type":4,"Flags":0},"VisualPalette":{"Type":1415,"Flags":0},"XAxisDisplayOptions":{"Type":851,"Flags":0},"XAxisLabelOptions":{"Type":891,"Flags":0}}}},{"2":{"Name":"LineChartDefaultSeriesSettings","Properties":{"AxisBinding":{"Type":4,"Flags":0},"LineStyleSettings":{"Type":1136,"Flags":0},"MarkerStyleSettings":{"Type":1138,"Flags":0}}}},{"2":{"Name":"LineChartFieldWells","Properties":{"LineChartAggregatedFieldWells":{"Type":1131,"Flags":0}}}},{"2":{"Name":"LineChartLineStyle"}},{"2":{"Name":"LineChartLineStyleSettings","Properties":{"LineInterpolation":{"Type":4,"Flags":0},"LineStyle":{"Type":4,"Flags":0},"LineVisibility":{"Type":4,"Flags":0},"LineWidth":{"Type":4,"Flags":0,"Description":"String based length that is composed of value and unit in px"}}}},{"2":{"Name":"LineChartMarkerShape"}},{"2":{"Name":"LineChartMarkerStyleSettings","Properties":{"MarkerColor":{"Type":4,"Flags":0},"MarkerShape":{"Type":4,"Flags":0},"MarkerSize":{"Type":4,"Flags":0,"Description":"String based length that is composed of value and unit in px"},"MarkerVisibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"LineChartSeriesSettings","Properties":{"LineStyleSettings":{"Type":1136,"Flags":0},"MarkerStyleSettings":{"Type":1138,"Flags":0}}}},{"2":{"Name":"LineChartSortConfiguration","Properties":{"CategoryItemsLimitConfiguration":{"Type":1108,"Flags":0},"CategorySort":{"Type":1561,"Flags":0},"ColorItemsLimitConfiguration":{"Type":1108,"Flags":0},"SmallMultiplesLimitConfiguration":{"Type":1108,"Flags":0},"SmallMultiplesSort":{"Type":1562,"Flags":0}}}},{"2":{"Name":"LineChartType"}},{"2":{"Name":"LineChartVisual","Properties":{"Actions":{"Type":1563,"Flags":0},"ChartConfiguration":{"Type":1132,"Flags":0},"ColumnHierarchies":{"Type":1564,"Flags":0},"Subtitle":{"Type":1416,"Flags":0},"Title":{"Type":1417,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"LineInterpolation"}},{"2":{"Name":"LineSeriesAxisDisplayOptions","Properties":{"AxisOptions":{"Type":851,"Flags":0},"MissingDataConfigurations":{"Type":1565,"Flags":0}}}},{"2":{"Name":"LinkSharingConfiguration","Properties":{"Permissions":{"Type":1566,"Flags":0}}}},{"2":{"Name":"ListControlDisplayOptions","Properties":{"InfoIconLabelOptions":{"Type":1303,"Flags":0},"SearchOptions":{"Type":1147,"Flags":0},"SelectAllOptions":{"Type":1148,"Flags":0},"TitleOptions":{"Type":1125,"Flags":0}}}},{"2":{"Name":"ListControlSearchOptions","Properties":{"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"ListControlSelectAllOptions","Properties":{"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"LoadingAnimation","Properties":{"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"LocalNavigationConfiguration","Properties":{"TargetSheetId":{"Type":4,"Flags":1}}}},{"2":{"Name":"LongFormatText","Properties":{"PlainText":{"Type":4,"Flags":0},"RichText":{"Type":4,"Flags":0}}}},{"2":{"Name":"MapZoomMode"}},{"2":{"Name":"MappedDataSetParameter","Properties":{"DataSetIdentifier":{"Type":4,"Flags":1},"DataSetParameterName":{"Type":4,"Flags":1}}}},{"2":{"Name":"MaximumLabelType","Properties":{"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"MaximumMinimumComputation","Properties":{"ComputationId":{"Type":4,"Flags":1},"Name":{"Type":4,"Flags":0},"Time":{"Type":991,"Flags":0},"Type":{"Type":4,"Flags":1},"Value":{"Type":1157,"Flags":0}}}},{"2":{"Name":"MaximumMinimumComputationType"}},{"2":{"Name":"MeasureField","Properties":{"CalculatedMeasureField":{"Type":880,"Flags":0},"CategoricalMeasureField":{"Type":885,"Flags":0},"DateMeasureField":{"Type":970,"Flags":0},"NumericalMeasureField":{"Type":1180,"Flags":0}}}},{"2":{"Name":"MetricComparisonComputation","Properties":{"ComputationId":{"Type":4,"Flags":1},"FromValue":{"Type":1157,"Flags":0},"Name":{"Type":4,"Flags":0},"TargetValue":{"Type":1157,"Flags":0},"Time":{"Type":991,"Flags":0}}}},{"2":{"Name":"MinimumLabelType","Properties":{"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"MissingDataConfiguration","Properties":{"TreatmentOption":{"Type":4,"Flags":0}}}},{"2":{"Name":"MissingDataTreatmentOption"}},{"2":{"Name":"NegativeValueConfiguration","Properties":{"DisplayMode":{"Type":4,"Flags":1}}}},{"2":{"Name":"NegativeValueDisplayMode"}},{"2":{"Name":"NullValueFormatConfiguration","Properties":{"NullString":{"Type":4,"Flags":1}}}},{"2":{"Name":"NumberDisplayFormatConfiguration","Properties":{"DecimalPlacesConfiguration":{"Type":982,"Flags":0},"NegativeValueConfiguration":{"Type":1162,"Flags":0},"NullValueFormatConfiguration":{"Type":1164,"Flags":0},"NumberScale":{"Type":4,"Flags":0},"Prefix":{"Type":4,"Flags":0},"SeparatorConfiguration":{"Type":1176,"Flags":0},"Suffix":{"Type":4,"Flags":0}}}},{"2":{"Name":"NumberFormatConfiguration","Properties":{"FormatConfiguration":{"Type":1173,"Flags":0}}}},{"2":{"Name":"NumberScale"}},{"2":{"Name":"NumericAxisOptions","Properties":{"Range":{"Type":852,"Flags":0},"Scale":{"Type":857,"Flags":0}}}},{"2":{"Name":"NumericEqualityDrillDownFilter","Properties":{"Column":{"Type":899,"Flags":1},"Value":{"Type":3,"Flags":1}}}},{"2":{"Name":"NumericEqualityFilter","Properties":{"AggregationFunction":{"Type":833,"Flags":0},"Column":{"Type":899,"Flags":1},"FilterId":{"Type":4,"Flags":1},"MatchOperator":{"Type":4,"Flags":1},"NullOption":{"Type":4,"Flags":1},"ParameterName":{"Type":4,"Flags":0},"SelectAllOptions":{"Type":4,"Flags":0},"Value":{"Type":3,"Flags":0}}}},{"2":{"Name":"NumericEqualityMatchOperator"}},{"2":{"Name":"NumericFilterSelectAllOptions"}},{"2":{"Name":"NumericFormatConfiguration","Properties":{"CurrencyDisplayFormatConfiguration":{"Type":924,"Flags":0},"NumberDisplayFormatConfiguration":{"Type":1165,"Flags":0},"PercentageDisplayFormatConfiguration":{"Type":1200,"Flags":0}}}},{"2":{"Name":"NumericRangeFilter","Properties":{"AggregationFunction":{"Type":833,"Flags":0},"Column":{"Type":899,"Flags":1},"FilterId":{"Type":4,"Flags":1},"IncludeMaximum":{"Type":2,"Flags":0},"IncludeMinimum":{"Type":2,"Flags":0},"NullOption":{"Type":4,"Flags":1},"RangeMaximum":{"Type":1175,"Flags":0},"RangeMinimum":{"Type":1175,"Flags":0},"SelectAllOptions":{"Type":4,"Flags":0}}}},{"2":{"Name":"NumericRangeFilterValue","Properties":{"Parameter":{"Type":4,"Flags":0},"StaticValue":{"Type":3,"Flags":0}}}},{"2":{"Name":"NumericSeparatorConfiguration","Properties":{"DecimalSeparator":{"Type":4,"Flags":0},"ThousandsSeparator":{"Type":1375,"Flags":0}}}},{"2":{"Name":"NumericSeparatorSymbol"}},{"2":{"Name":"NumericalAggregationFunction","Properties":{"PercentileAggregation":{"Type":1201,"Flags":0},"SimpleNumericalAggregation":{"Type":4,"Flags":0}}}},{"2":{"Name":"NumericalDimensionField","Properties":{"Column":{"Type":899,"Flags":1},"FieldId":{"Type":4,"Flags":1},"FormatConfiguration":{"Type":1166,"Flags":0},"HierarchyId":{"Type":4,"Flags":0}}}},{"2":{"Name":"NumericalMeasureField","Properties":{"AggregationFunction":{"Type":1178,"Flags":0},"Column":{"Type":899,"Flags":1},"FieldId":{"Type":4,"Flags":1},"FormatConfiguration":{"Type":1166,"Flags":0}}}},{"2":{"Name":"OtherCategories"}},{"2":{"Name":"PaginationConfiguration","Properties":{"PageNumber":{"Type":3,"Flags":1},"PageSize":{"Type":3,"Flags":1}}}},{"2":{"Name":"PanelBorderStyle"}},{"2":{"Name":"PanelConfiguration","Properties":{"BackgroundColor":{"Type":4,"Flags":0},"BackgroundVisibility":{"Type":4,"Flags":0},"BorderColor":{"Type":4,"Flags":0},"BorderStyle":{"Type":4,"Flags":0},"BorderThickness":{"Type":4,"Flags":0,"Description":"String based length that is composed of value and unit in px"},"BorderVisibility":{"Type":4,"Flags":0},"GutterSpacing":{"Type":4,"Flags":0,"Description":"String based length that is composed of value and unit in px"},"GutterVisibility":{"Type":4,"Flags":0},"Title":{"Type":1185,"Flags":0}}}},{"2":{"Name":"PanelTitleOptions","Properties":{"FontConfiguration":{"Type":1035,"Flags":0},"HorizontalTextAlignment":{"Type":4,"Flags":0},"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"PaperOrientation"}},{"2":{"Name":"PaperSize"}},{"2":{"Name":"ParameterControl","Properties":{"DateTimePicker":{"Type":1189,"Flags":0},"Dropdown":{"Type":1191,"Flags":0},"List":{"Type":1192,"Flags":0},"Slider":{"Type":1194,"Flags":0},"TextArea":{"Type":1195,"Flags":0},"TextField":{"Type":1196,"Flags":0}}}},{"2":{"Name":"ParameterDateTimePickerControl","Properties":{"DisplayOptions":{"Type":976,"Flags":0},"ParameterControlId":{"Type":4,"Flags":1},"SourceParameterName":{"Type":4,"Flags":1},"Title":{"Type":4,"Flags":1}}}},{"2":{"Name":"ParameterDeclaration","Properties":{"DateTimeParameterDeclaration":{"Type":975,"Flags":0},"DecimalParameterDeclaration":{"Type":981,"Flags":0},"IntegerParameterDeclaration":{"Type":1106,"Flags":0},"StringParameterDeclaration":{"Type":1331,"Flags":0}}}},{"2":{"Name":"ParameterDropDownControl","Properties":{"CascadingControlConfiguration":{"Type":881,"Flags":0},"DisplayOptions":{"Type":995,"Flags":0},"ParameterControlId":{"Type":4,"Flags":1},"SelectableValues":{"Type":1193,"Flags":0},"SourceParameterName":{"Type":4,"Flags":1},"Title":{"Type":4,"Flags":1},"Type":{"Type":4,"Flags":0}}}},{"2":{"Name":"ParameterListControl","Properties":{"CascadingControlConfiguration":{"Type":881,"Flags":0},"DisplayOptions":{"Type":1146,"Flags":0},"ParameterControlId":{"Type":4,"Flags":1},"SelectableValues":{"Type":1193,"Flags":0},"SourceParameterName":{"Type":4,"Flags":1},"Title":{"Type":4,"Flags":1},"Type":{"Type":4,"Flags":0}}}},{"2":{"Name":"ParameterSelectableValues","Properties":{"LinkToDataSetColumn":{"Type":899,"Flags":0},"Values":{"Type":1567,"Flags":0}}}},{"2":{"Name":"ParameterSliderControl","Properties":{"DisplayOptions":{"Type":1320,"Flags":0},"MaximumValue":{"Type":3,"Flags":1},"MinimumValue":{"Type":3,"Flags":1},"ParameterControlId":{"Type":4,"Flags":1},"SourceParameterName":{"Type":4,"Flags":1},"StepSize":{"Type":3,"Flags":1},"Title":{"Type":4,"Flags":1}}}},{"2":{"Name":"ParameterTextAreaControl","Properties":{"Delimiter":{"Type":4,"Flags":0},"DisplayOptions":{"Type":1370,"Flags":0},"ParameterControlId":{"Type":4,"Flags":1},"SourceParameterName":{"Type":4,"Flags":1},"Title":{"Type":4,"Flags":1}}}},{"2":{"Name":"ParameterTextFieldControl","Properties":{"DisplayOptions":{"Type":1373,"Flags":0},"ParameterControlId":{"Type":4,"Flags":1},"SourceParameterName":{"Type":4,"Flags":1},"Title":{"Type":4,"Flags":1}}}},{"2":{"Name":"ParameterValueType"}},{"2":{"Name":"Parameters","Properties":{"DateTimeParameters":{"Type":1568,"Flags":0},"DecimalParameters":{"Type":1569,"Flags":0},"IntegerParameters":{"Type":1570,"Flags":0},"StringParameters":{"Type":1571,"Flags":0}}}},{"2":{"Name":"PercentVisibleRange","Properties":{"From":{"Type":3,"Flags":0},"To":{"Type":3,"Flags":0}}}},{"2":{"Name":"PercentageDisplayFormatConfiguration","Properties":{"DecimalPlacesConfiguration":{"Type":982,"Flags":0},"NegativeValueConfiguration":{"Type":1162,"Flags":0},"NullValueFormatConfiguration":{"Type":1164,"Flags":0},"Prefix":{"Type":4,"Flags":0},"SeparatorConfiguration":{"Type":1176,"Flags":0},"Suffix":{"Type":4,"Flags":0}}}},{"2":{"Name":"PercentileAggregation","Properties":{"PercentileValue":{"Type":3,"Flags":0}}}},{"2":{"Name":"PeriodOverPeriodComputation","Properties":{"ComputationId":{"Type":4,"Flags":1},"Name":{"Type":4,"Flags":0},"Time":{"Type":991,"Flags":0},"Value":{"Type":1157,"Flags":0}}}},{"2":{"Name":"PeriodToDateComputation","Properties":{"ComputationId":{"Type":4,"Flags":1},"Name":{"Type":4,"Flags":0},"PeriodTimeGranularity":{"Type":4,"Flags":0},"Time":{"Type":991,"Flags":0},"Value":{"Type":1157,"Flags":0}}}},{"2":{"Name":"PieChartAggregatedFieldWells","Properties":{"Category":{"Type":1572,"Flags":0},"SmallMultiples":{"Type":1573,"Flags":0},"Values":{"Type":1574,"Flags":0}}}},{"2":{"Name":"PieChartConfiguration","Properties":{"CategoryLabelOptions":{"Type":891,"Flags":0},"ContributionAnalysisDefaults":{"Type":1575,"Flags":0},"DataLabels":{"Type":953,"Flags":0},"DonutOptions":{"Type":993,"Flags":0},"FieldWells":{"Type":1206,"Flags":0},"Legend":{"Type":1129,"Flags":0},"SmallMultiplesOptions":{"Type":1324,"Flags":0},"SortConfiguration":{"Type":1207,"Flags":0},"Tooltip":{"Type":1383,"Flags":0},"ValueLabelOptions":{"Type":891,"Flags":0},"VisualPalette":{"Type":1415,"Flags":0}}}},{"2":{"Name":"PieChartFieldWells","Properties":{"PieChartAggregatedFieldWells":{"Type":1204,"Flags":0}}}},{"2":{"Name":"PieChartSortConfiguration","Properties":{"CategoryItemsLimit":{"Type":1108,"Flags":0},"CategorySort":{"Type":1576,"Flags":0},"SmallMultiplesLimitConfiguration":{"Type":1108,"Flags":0},"SmallMultiplesSort":{"Type":1577,"Flags":0}}}},{"2":{"Name":"PieChartVisual","Properties":{"Actions":{"Type":1578,"Flags":0},"ChartConfiguration":{"Type":1205,"Flags":0},"ColumnHierarchies":{"Type":1579,"Flags":0},"Subtitle":{"Type":1416,"Flags":0},"Title":{"Type":1417,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"PivotFieldSortOptions","Properties":{"FieldId":{"Type":4,"Flags":1},"SortBy":{"Type":1231,"Flags":1}}}},{"2":{"Name":"PivotTableAggregatedFieldWells","Properties":{"Columns":{"Type":1580,"Flags":0},"Rows":{"Type":1581,"Flags":0},"Values":{"Type":1582,"Flags":0}}}},{"2":{"Name":"PivotTableCellConditionalFormatting","Properties":{"FieldId":{"Type":4,"Flags":1},"Scope":{"Type":1214,"Flags":0},"Scopes":{"Type":1583,"Flags":0},"TextFormat":{"Type":1371,"Flags":0}}}},{"2":{"Name":"PivotTableConditionalFormatting","Properties":{"ConditionalFormattingOptions":{"Type":1584,"Flags":0}}}},{"2":{"Name":"PivotTableConditionalFormattingOption","Properties":{"Cell":{"Type":1211,"Flags":0}}}},{"2":{"Name":"PivotTableConditionalFormattingScope","Properties":{"Role":{"Type":4,"Flags":0}}}},{"2":{"Name":"PivotTableConditionalFormattingScopeRole"}},{"2":{"Name":"PivotTableConfiguration","Properties":{"FieldOptions":{"Type":1223,"Flags":0},"FieldWells":{"Type":1225,"Flags":0},"PaginatedReportOptions":{"Type":1228,"Flags":0},"SortConfiguration":{"Type":1232,"Flags":0},"TableOptions":{"Type":1227,"Flags":0},"TotalOptions":{"Type":1234,"Flags":0}}}},{"2":{"Name":"PivotTableDataPathOption","Properties":{"DataPathList":{"Type":1585,"Flags":1},"Width":{"Type":4,"Flags":0,"Description":"String based length that is composed of value and unit in px"}}}},{"2":{"Name":"PivotTableDataPathType"}},{"2":{"Name":"PivotTableFieldCollapseState"}},{"2":{"Name":"PivotTableFieldCollapseStateOption","Properties":{"State":{"Type":4,"Flags":0},"Target":{"Type":1221,"Flags":1}}}},{"2":{"Name":"PivotTableFieldCollapseStateTarget","Properties":{"FieldDataPathValues":{"Type":1586,"Flags":0},"FieldId":{"Type":4,"Flags":0}}}},{"2":{"Name":"PivotTableFieldOption","Properties":{"CustomLabel":{"Type":4,"Flags":0},"FieldId":{"Type":4,"Flags":1},"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"PivotTableFieldOptions","Properties":{"CollapseStateOptions":{"Type":1587,"Flags":0},"DataPathOptions":{"Type":1588,"Flags":0},"SelectedFieldOptions":{"Type":1589,"Flags":0}}}},{"2":{"Name":"PivotTableFieldSubtotalOptions","Properties":{"FieldId":{"Type":4,"Flags":0}}}},{"2":{"Name":"PivotTableFieldWells","Properties":{"PivotTableAggregatedFieldWells":{"Type":1210,"Flags":0}}}},{"2":{"Name":"PivotTableMetricPlacement"}},{"2":{"Name":"PivotTableOptions","Properties":{"CellStyle":{"Type":1341,"Flags":0},"CollapsedRowDimensionsVisibility":{"Type":4,"Flags":0},"ColumnHeaderStyle":{"Type":1341,"Flags":0},"ColumnNamesVisibility":{"Type":4,"Flags":0},"DefaultCellWidth":{"Type":4,"Flags":0,"Description":"String based length that is composed of value and unit in px"},"MetricPlacement":{"Type":4,"Flags":0},"RowAlternateColorOptions":{"Type":1271,"Flags":0},"RowFieldNamesStyle":{"Type":1341,"Flags":0},"RowHeaderStyle":{"Type":1341,"Flags":0},"RowsLabelOptions":{"Type":1229,"Flags":0},"RowsLayout":{"Type":4,"Flags":0},"SingleMetricVisibility":{"Type":4,"Flags":0},"ToggleButtonsVisibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"PivotTablePaginatedReportOptions","Properties":{"OverflowColumnHeaderVisibility":{"Type":4,"Flags":0},"VerticalOverflowVisibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"PivotTableRowsLabelOptions","Properties":{"CustomLabel":{"Type":4,"Flags":0},"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"PivotTableRowsLayout"}},{"2":{"Name":"PivotTableSortBy","Properties":{"Column":{"Type":901,"Flags":0},"DataPath":{"Type":959,"Flags":0},"Field":{"Type":1007,"Flags":0}}}},{"2":{"Name":"PivotTableSortConfiguration","Properties":{"FieldSortOptions":{"Type":1590,"Flags":0}}}},{"2":{"Name":"PivotTableSubtotalLevel"}},{"2":{"Name":"PivotTableTotalOptions","Properties":{"ColumnSubtotalOptions":{"Type":1334,"Flags":0},"ColumnTotalOptions":{"Type":1236,"Flags":0},"RowSubtotalOptions":{"Type":1334,"Flags":0},"RowTotalOptions":{"Type":1236,"Flags":0}}}},{"2":{"Name":"PivotTableVisual","Properties":{"Actions":{"Type":1591,"Flags":0},"ChartConfiguration":{"Type":1216,"Flags":0},"ConditionalFormatting":{"Type":1212,"Flags":0},"Subtitle":{"Type":1416,"Flags":0},"Title":{"Type":1417,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"PivotTotalOptions","Properties":{"CustomLabel":{"Type":4,"Flags":0},"MetricHeaderCellStyle":{"Type":1341,"Flags":0},"Placement":{"Type":4,"Flags":0},"ScrollStatus":{"Type":4,"Flags":0},"TotalAggregationOptions":{"Type":1592,"Flags":0},"TotalCellStyle":{"Type":1341,"Flags":0},"TotalsVisibility":{"Type":4,"Flags":0},"ValueCellStyle":{"Type":1341,"Flags":0}}}},{"2":{"Name":"PredefinedHierarchy","Properties":{"Columns":{"Type":1593,"Flags":1},"DrillDownFilters":{"Type":1594,"Flags":0},"HierarchyId":{"Type":4,"Flags":1}}}},{"2":{"Name":"PrimaryValueDisplayType"}},{"2":{"Name":"ProgressBarOptions","Properties":{"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"RadarChartAggregatedFieldWells","Properties":{"Category":{"Type":1595,"Flags":0},"Color":{"Type":1596,"Flags":0},"Values":{"Type":1597,"Flags":0}}}},{"2":{"Name":"RadarChartAreaStyleSettings","Properties":{"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"RadarChartAxesRangeScale"}},{"2":{"Name":"RadarChartConfiguration","Properties":{"AlternateBandColorsVisibility":{"Type":4,"Flags":0},"AlternateBandEvenColor":{"Type":4,"Flags":0},"AlternateBandOddColor":{"Type":4,"Flags":0},"AxesRangeScale":{"Type":4,"Flags":0},"BaseSeriesSettings":{"Type":1245,"Flags":0},"CategoryAxis":{"Type":851,"Flags":0},"CategoryLabelOptions":{"Type":891,"Flags":0},"ColorAxis":{"Type":851,"Flags":0},"ColorLabelOptions":{"Type":891,"Flags":0},"FieldWells":{"Type":1244,"Flags":0},"Legend":{"Type":1129,"Flags":0},"Shape":{"Type":4,"Flags":0},"SortConfiguration":{"Type":1247,"Flags":0},"StartAngle":{"Type":3,"Flags":0},"VisualPalette":{"Type":1415,"Flags":0}}}},{"2":{"Name":"RadarChartFieldWells","Properties":{"RadarChartAggregatedFieldWells":{"Type":1240,"Flags":0}}}},{"2":{"Name":"RadarChartSeriesSettings","Properties":{"AreaStyleSettings":{"Type":1241,"Flags":0}}}},{"2":{"Name":"RadarChartShape"}},{"2":{"Name":"RadarChartSortConfiguration","Properties":{"CategoryItemsLimit":{"Type":1108,"Flags":0},"CategorySort":{"Type":1598,"Flags":0},"ColorItemsLimit":{"Type":1108,"Flags":0},"ColorSort":{"Type":1599,"Flags":0}}}},{"2":{"Name":"RadarChartVisual","Properties":{"Actions":{"Type":1600,"Flags":0},"ChartConfiguration":{"Type":1243,"Flags":0},"ColumnHierarchies":{"Type":1601,"Flags":0},"Subtitle":{"Type":1416,"Flags":0},"Title":{"Type":1417,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"RangeEndsLabelType","Properties":{"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"ReferenceLine","Properties":{"DataConfiguration":{"Type":1252,"Flags":1},"LabelConfiguration":{"Type":1254,"Flags":0},"Status":{"Type":4,"Flags":0},"StyleConfiguration":{"Type":1260,"Flags":0}}}},{"2":{"Name":"ReferenceLineCustomLabelConfiguration","Properties":{"CustomLabel":{"Type":4,"Flags":1}}}},{"2":{"Name":"ReferenceLineDataConfiguration","Properties":{"AxisBinding":{"Type":4,"Flags":0},"DynamicConfiguration":{"Type":1253,"Flags":0},"SeriesType":{"Type":4,"Flags":0},"StaticConfiguration":{"Type":1259,"Flags":0}}}},{"2":{"Name":"ReferenceLineDynamicDataConfiguration","Properties":{"Calculation":{"Type":1178,"Flags":1},"Column":{"Type":899,"Flags":1},"MeasureAggregationFunction":{"Type":833,"Flags":0}}}},{"2":{"Name":"ReferenceLineLabelConfiguration","Properties":{"CustomLabelConfiguration":{"Type":1251,"Flags":0},"FontColor":{"Type":4,"Flags":0},"FontConfiguration":{"Type":1035,"Flags":0},"HorizontalPosition":{"Type":4,"Flags":0},"ValueLabelConfiguration":{"Type":1261,"Flags":0},"VerticalPosition":{"Type":4,"Flags":0}}}},{"2":{"Name":"ReferenceLineLabelHorizontalPosition"}},{"2":{"Name":"ReferenceLineLabelVerticalPosition"}},{"2":{"Name":"ReferenceLinePatternType"}},{"2":{"Name":"ReferenceLineSeriesType"}},{"2":{"Name":"ReferenceLineStaticDataConfiguration","Properties":{"Value":{"Type":3,"Flags":1}}}},{"2":{"Name":"ReferenceLineStyleConfiguration","Properties":{"Color":{"Type":4,"Flags":0},"Pattern":{"Type":4,"Flags":0}}}},{"2":{"Name":"ReferenceLineValueLabelConfiguration","Properties":{"FormatConfiguration":{"Type":1173,"Flags":0},"RelativePosition":{"Type":4,"Flags":0}}}},{"2":{"Name":"ReferenceLineValueLabelRelativePosition"}},{"2":{"Name":"RelativeDateTimeControlDisplayOptions","Properties":{"DateTimeFormat":{"Type":4,"Flags":0},"InfoIconLabelOptions":{"Type":1303,"Flags":0},"TitleOptions":{"Type":1125,"Flags":0}}}},{"2":{"Name":"RelativeDateType"}},{"2":{"Name":"RelativeDatesFilter","Properties":{"AnchorDateConfiguration":{"Type":837,"Flags":1},"Column":{"Type":899,"Flags":1},"ExcludePeriodConfiguration":{"Type":999,"Flags":0},"FilterId":{"Type":4,"Flags":1},"MinimumGranularity":{"Type":4,"Flags":0},"NullOption":{"Type":4,"Flags":1},"ParameterName":{"Type":4,"Flags":0},"RelativeDateType":{"Type":4,"Flags":1},"RelativeDateValue":{"Type":3,"Flags":0},"TimeGranularity":{"Type":4,"Flags":1}}}},{"2":{"Name":"RelativeFontSize"}},{"2":{"Name":"ResizeOption"}},{"2":{"Name":"ResourcePermission","Properties":{"Actions":{"Type":1602,"Flags":1},"Principal":{"Type":4,"Flags":1}}}},{"2":{"Name":"ResourceStatus"}},{"2":{"Name":"RollingDateConfiguration","Properties":{"DataSetIdentifier":{"Type":4,"Flags":0},"Expression":{"Type":4,"Flags":1}}}},{"2":{"Name":"RowAlternateColorOptions","Properties":{"RowAlternateColors":{"Type":1603,"Flags":0},"Status":{"Type":4,"Flags":0},"UsePrimaryBackgroundColor":{"Type":4,"Flags":0}}}},{"2":{"Name":"SameSheetTargetVisualConfiguration","Properties":{"TargetVisualOptions":{"Type":4,"Flags":0},"TargetVisuals":{"Type":1604,"Flags":0}}}},{"2":{"Name":"SankeyDiagramAggregatedFieldWells","Properties":{"Destination":{"Type":1605,"Flags":0},"Source":{"Type":1606,"Flags":0},"Weight":{"Type":1607,"Flags":0}}}},{"2":{"Name":"SankeyDiagramChartConfiguration","Properties":{"DataLabels":{"Type":953,"Flags":0},"FieldWells":{"Type":1275,"Flags":0},"SortConfiguration":{"Type":1276,"Flags":0}}}},{"2":{"Name":"SankeyDiagramFieldWells","Properties":{"SankeyDiagramAggregatedFieldWells":{"Type":1273,"Flags":0}}}},{"2":{"Name":"SankeyDiagramSortConfiguration","Properties":{"DestinationItemsLimit":{"Type":1108,"Flags":0},"SourceItemsLimit":{"Type":1108,"Flags":0},"WeightSort":{"Type":1608,"Flags":0}}}},{"2":{"Name":"SankeyDiagramVisual","Properties":{"Actions":{"Type":1609,"Flags":0},"ChartConfiguration":{"Type":1274,"Flags":0},"Subtitle":{"Type":1416,"Flags":0},"Title":{"Type":1417,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"ScatterPlotCategoricallyAggregatedFieldWells","Properties":{"Category":{"Type":1610,"Flags":0},"Label":{"Type":1611,"Flags":0},"Size":{"Type":1612,"Flags":0},"XAxis":{"Type":1613,"Flags":0},"YAxis":{"Type":1614,"Flags":0}}}},{"2":{"Name":"ScatterPlotConfiguration","Properties":{"DataLabels":{"Type":953,"Flags":0},"FieldWells":{"Type":1280,"Flags":0},"Legend":{"Type":1129,"Flags":0},"Tooltip":{"Type":1383,"Flags":0},"VisualPalette":{"Type":1415,"Flags":0},"XAxisDisplayOptions":{"Type":851,"Flags":0},"XAxisLabelOptions":{"Type":891,"Flags":0},"YAxisDisplayOptions":{"Type":851,"Flags":0},"YAxisLabelOptions":{"Type":891,"Flags":0}}}},{"2":{"Name":"ScatterPlotFieldWells","Properties":{"ScatterPlotCategoricallyAggregatedFieldWells":{"Type":1278,"Flags":0},"ScatterPlotUnaggregatedFieldWells":{"Type":1281,"Flags":0}}}},{"2":{"Name":"ScatterPlotUnaggregatedFieldWells","Properties":{"Category":{"Type":1615,"Flags":0},"Label":{"Type":1616,"Flags":0},"Size":{"Type":1617,"Flags":0},"XAxis":{"Type":1618,"Flags":0},"YAxis":{"Type":1619,"Flags":0}}}},{"2":{"Name":"ScatterPlotVisual","Properties":{"Actions":{"Type":1620,"Flags":0},"ChartConfiguration":{"Type":1279,"Flags":0},"ColumnHierarchies":{"Type":1621,"Flags":0},"Subtitle":{"Type":1416,"Flags":0},"Title":{"Type":1417,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"ScrollBarOptions","Properties":{"Visibility":{"Type":4,"Flags":0},"VisibleRange":{"Type":1408,"Flags":0}}}},{"2":{"Name":"SecondaryValueOptions","Properties":{"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"SectionAfterPageBreak","Properties":{"Status":{"Type":4,"Flags":0}}}},{"2":{"Name":"SectionBasedLayoutCanvasSizeOptions","Properties":{"PaperCanvasSizeOptions":{"Type":1288,"Flags":0}}}},{"2":{"Name":"SectionBasedLayoutConfiguration","Properties":{"BodySections":{"Type":1622,"Flags":1},"CanvasSizeOptions":{"Type":1286,"Flags":1},"FooterSections":{"Type":1623,"Flags":1},"HeaderSections":{"Type":1624,"Flags":1}}}},{"2":{"Name":"SectionBasedLayoutPaperCanvasSizeOptions","Properties":{"PaperMargin":{"Type":1326,"Flags":0},"PaperOrientation":{"Type":4,"Flags":0},"PaperSize":{"Type":4,"Flags":0}}}},{"2":{"Name":"SectionLayoutConfiguration","Properties":{"FreeFormLayout":{"Type":1052,"Flags":1}}}},{"2":{"Name":"SectionPageBreakConfiguration","Properties":{"After":{"Type":1285,"Flags":0}}}},{"2":{"Name":"SectionPageBreakStatus"}},{"2":{"Name":"SectionStyle","Properties":{"Height":{"Type":4,"Flags":0,"Description":"String based length that is composed of value and unit in px"},"Padding":{"Type":1326,"Flags":0}}}},{"2":{"Name":"SelectAllValueOptions"}},{"2":{"Name":"SelectedFieldOptions"}},{"2":{"Name":"SelectedSheetsFilterScopeConfiguration","Properties":{"SheetVisualScopingConfigurations":{"Type":1625,"Flags":0}}}},{"2":{"Name":"SelectedTooltipType"}},{"2":{"Name":"SeriesItem","Properties":{"DataFieldSeriesItem":{"Type":951,"Flags":0},"FieldSeriesItem":{"Type":1006,"Flags":0}}}},{"2":{"Name":"SetParameterValueConfiguration","Properties":{"DestinationParameterName":{"Type":4,"Flags":1},"Value":{"Type":990,"Flags":1}}}},{"2":{"Name":"ShapeConditionalFormat","Properties":{"BackgroundColor":{"Type":912,"Flags":1}}}},{"2":{"Name":"Sheet","Properties":{"Name":{"Type":4,"Flags":0},"SheetId":{"Type":4,"Flags":0}}}},{"2":{"Name":"SheetContentType"}},{"2":{"Name":"SheetControlDateTimePickerType"}},{"2":{"Name":"SheetControlInfoIconLabelOptions","Properties":{"InfoIconText":{"Type":4,"Flags":0},"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"SheetControlLayout","Properties":{"Configuration":{"Type":1305,"Flags":1}}}},{"2":{"Name":"SheetControlLayoutConfiguration","Properties":{"GridLayout":{"Type":1084,"Flags":0}}}},{"2":{"Name":"SheetControlListType"}},{"2":{"Name":"SheetControlSliderType"}},{"2":{"Name":"SheetControlsOption","Properties":{"VisibilityState":{"Type":4,"Flags":0}}}},{"2":{"Name":"SheetDefinition","Properties":{"ContentType":{"Type":4,"Flags":0},"Description":{"Type":4,"Flags":0},"FilterControls":{"Type":1626,"Flags":0},"Layouts":{"Type":1627,"Flags":0},"Name":{"Type":4,"Flags":0},"ParameterControls":{"Type":1628,"Flags":0},"SheetControlLayouts":{"Type":1629,"Flags":0},"SheetId":{"Type":4,"Flags":1},"TextBoxes":{"Type":1630,"Flags":0},"Title":{"Type":4,"Flags":0},"Visuals":{"Type":1631,"Flags":0}}}},{"2":{"Name":"SheetElementConfigurationOverrides","Properties":{"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"SheetElementRenderingRule","Properties":{"ConfigurationOverrides":{"Type":1310,"Flags":1},"Expression":{"Type":4,"Flags":1}}}},{"2":{"Name":"SheetLayoutElementMaximizationOption","Properties":{"AvailabilityStatus":{"Type":4,"Flags":0}}}},{"2":{"Name":"SheetTextBox","Properties":{"Content":{"Type":4,"Flags":0},"SheetTextBoxId":{"Type":4,"Flags":1}}}},{"2":{"Name":"SheetVisualScopingConfiguration","Properties":{"Scope":{"Type":4,"Flags":1},"SheetId":{"Type":4,"Flags":1},"VisualIds":{"Type":1632,"Flags":0}}}},{"2":{"Name":"ShortFormatText","Properties":{"PlainText":{"Type":4,"Flags":0},"RichText":{"Type":4,"Flags":0}}}},{"2":{"Name":"SimpleAttributeAggregationFunction"}},{"2":{"Name":"SimpleClusterMarker","Properties":{"Color":{"Type":4,"Flags":0}}}},{"2":{"Name":"SimpleNumericalAggregationFunction"}},{"2":{"Name":"SimpleTotalAggregationFunction"}},{"2":{"Name":"SliderControlDisplayOptions","Properties":{"InfoIconLabelOptions":{"Type":1303,"Flags":0},"TitleOptions":{"Type":1125,"Flags":0}}}},{"2":{"Name":"SmallMultiplesAxisPlacement"}},{"2":{"Name":"SmallMultiplesAxisProperties","Properties":{"Placement":{"Type":4,"Flags":0},"Scale":{"Type":4,"Flags":0}}}},{"2":{"Name":"SmallMultiplesAxisScale"}},{"2":{"Name":"SmallMultiplesOptions","Properties":{"MaxVisibleColumns":{"Type":3,"Flags":0},"MaxVisibleRows":{"Type":3,"Flags":0},"PanelConfiguration":{"Type":1184,"Flags":0},"XAxis":{"Type":1322,"Flags":0},"YAxis":{"Type":1322,"Flags":0}}}},{"2":{"Name":"SortDirection"}},{"2":{"Name":"Spacing","Properties":{"Bottom":{"Type":4,"Flags":0,"Description":"String based length that is composed of value and unit"},"Left":{"Type":4,"Flags":0,"Description":"String based length that is composed of value and unit"},"Right":{"Type":4,"Flags":0,"Description":"String based length that is composed of value and unit"},"Top":{"Type":4,"Flags":0,"Description":"String based length that is composed of value and unit"}}}},{"2":{"Name":"SpecialValue"}},{"2":{"Name":"StringDefaultValues","Properties":{"DynamicValue":{"Type":996,"Flags":0},"StaticValues":{"Type":1633,"Flags":0}}}},{"2":{"Name":"StringFormatConfiguration","Properties":{"NullValueFormatConfiguration":{"Type":1164,"Flags":0},"NumericFormatConfiguration":{"Type":1173,"Flags":0}}}},{"2":{"Name":"StringParameter","Properties":{"Name":{"Type":4,"Flags":1},"Values":{"Type":1634,"Flags":1}}}},{"2":{"Name":"StringParameterDeclaration","Properties":{"DefaultValues":{"Type":1328,"Flags":0},"MappedDataSetParameters":{"Type":1635,"Flags":0},"Name":{"Type":4,"Flags":1},"ParameterValueType":{"Type":4,"Flags":1},"ValueWhenUnset":{"Type":1332,"Flags":0}}}},{"2":{"Name":"StringValueWhenUnsetConfiguration","Properties":{"CustomValue":{"Type":4,"Flags":0},"ValueWhenUnsetOption":{"Type":4,"Flags":0}}}},{"2":{"Name":"StyledCellType"}},{"2":{"Name":"SubtotalOptions","Properties":{"CustomLabel":{"Type":4,"Flags":0},"FieldLevel":{"Type":4,"Flags":0},"FieldLevelOptions":{"Type":1636,"Flags":0},"MetricHeaderCellStyle":{"Type":1341,"Flags":0},"StyleTargets":{"Type":1637,"Flags":0},"TotalCellStyle":{"Type":1341,"Flags":0},"TotalsVisibility":{"Type":4,"Flags":0},"ValueCellStyle":{"Type":1341,"Flags":0}}}},{"2":{"Name":"TableAggregatedFieldWells","Properties":{"GroupBy":{"Type":1638,"Flags":0},"Values":{"Type":1639,"Flags":0}}}},{"2":{"Name":"TableBorderOptions","Properties":{"Color":{"Type":4,"Flags":0},"Style":{"Type":4,"Flags":0},"Thickness":{"Type":3,"Flags":0}}}},{"2":{"Name":"TableBorderStyle"}},{"2":{"Name":"TableCellConditionalFormatting","Properties":{"FieldId":{"Type":4,"Flags":1},"TextFormat":{"Type":1371,"Flags":0}}}},{"2":{"Name":"TableCellImageScalingConfiguration"}},{"2":{"Name":"TableCellImageSizingConfiguration","Properties":{"TableCellImageScalingConfiguration":{"Type":4,"Flags":0}}}},{"2":{"Name":"TableCellStyle","Properties":{"BackgroundColor":{"Type":4,"Flags":0},"Border":{"Type":1080,"Flags":0},"FontConfiguration":{"Type":1035,"Flags":0},"Height":{"Type":3,"Flags":0},"HorizontalTextAlignment":{"Type":4,"Flags":0},"TextWrap":{"Type":4,"Flags":0},"VerticalTextAlignment":{"Type":4,"Flags":0},"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"TableConditionalFormatting","Properties":{"ConditionalFormattingOptions":{"Type":1640,"Flags":0}}}},{"2":{"Name":"TableConditionalFormattingOption","Properties":{"Cell":{"Type":1338,"Flags":0},"Row":{"Type":1360,"Flags":0}}}},{"2":{"Name":"TableConfiguration","Properties":{"FieldOptions":{"Type":1352,"Flags":0},"FieldWells":{"Type":1354,"Flags":0},"PaginatedReportOptions":{"Type":1358,"Flags":0},"SortConfiguration":{"Type":1362,"Flags":0},"TableInlineVisualizations":{"Type":1641,"Flags":0},"TableOptions":{"Type":1356,"Flags":0},"TotalOptions":{"Type":1393,"Flags":0}}}},{"2":{"Name":"TableFieldCustomIconContent","Properties":{"Icon":{"Type":4,"Flags":0}}}},{"2":{"Name":"TableFieldCustomTextContent","Properties":{"FontConfiguration":{"Type":1035,"Flags":1},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"TableFieldIconSetType"}},{"2":{"Name":"TableFieldImageConfiguration","Properties":{"SizingOptions":{"Type":1340,"Flags":0}}}},{"2":{"Name":"TableFieldLinkConfiguration","Properties":{"Content":{"Type":1350,"Flags":1},"Target":{"Type":4,"Flags":1}}}},{"2":{"Name":"TableFieldLinkContentConfiguration","Properties":{"CustomIconContent":{"Type":1345,"Flags":0},"CustomTextContent":{"Type":1346,"Flags":0}}}},{"2":{"Name":"TableFieldOption","Properties":{"CustomLabel":{"Type":4,"Flags":0},"FieldId":{"Type":4,"Flags":1},"URLStyling":{"Type":1353,"Flags":0},"Visibility":{"Type":4,"Flags":0},"Width":{"Type":4,"Flags":0,"Description":"String based length that is composed of value and unit in px"}}}},{"2":{"Name":"TableFieldOptions","Properties":{"Order":{"Type":1642,"Flags":0},"PinnedFieldOptions":{"Type":1359,"Flags":0},"SelectedFieldOptions":{"Type":1643,"Flags":0}}}},{"2":{"Name":"TableFieldURLConfiguration","Properties":{"ImageConfiguration":{"Type":1348,"Flags":0},"LinkConfiguration":{"Type":1349,"Flags":0}}}},{"2":{"Name":"TableFieldWells","Properties":{"TableAggregatedFieldWells":{"Type":1335,"Flags":0},"TableUnaggregatedFieldWells":{"Type":1366,"Flags":0}}}},{"2":{"Name":"TableInlineVisualization","Properties":{"DataBars":{"Type":949,"Flags":0}}}},{"2":{"Name":"TableOptions","Properties":{"CellStyle":{"Type":1341,"Flags":0},"HeaderStyle":{"Type":1341,"Flags":0},"Orientation":{"Type":4,"Flags":0},"RowAlternateColorOptions":{"Type":1271,"Flags":0}}}},{"2":{"Name":"TableOrientation"}},{"2":{"Name":"TablePaginatedReportOptions","Properties":{"OverflowColumnHeaderVisibility":{"Type":4,"Flags":0},"VerticalOverflowVisibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"TablePinnedFieldOptions","Properties":{"PinnedLeftFields":{"Type":1644,"Flags":0}}}},{"2":{"Name":"TableRowConditionalFormatting","Properties":{"BackgroundColor":{"Type":912,"Flags":0},"TextColor":{"Type":912,"Flags":0}}}},{"2":{"Name":"TableSideBorderOptions","Properties":{"Bottom":{"Type":1336,"Flags":0},"InnerHorizontal":{"Type":1336,"Flags":0},"InnerVertical":{"Type":1336,"Flags":0},"Left":{"Type":1336,"Flags":0},"Right":{"Type":1336,"Flags":0},"Top":{"Type":1336,"Flags":0}}}},{"2":{"Name":"TableSortConfiguration","Properties":{"PaginationConfiguration":{"Type":1182,"Flags":0},"RowSort":{"Type":1645,"Flags":0}}}},{"2":{"Name":"TableStyleTarget","Properties":{"CellType":{"Type":4,"Flags":1}}}},{"2":{"Name":"TableTotalsPlacement"}},{"2":{"Name":"TableTotalsScrollStatus"}},{"2":{"Name":"TableUnaggregatedFieldWells","Properties":{"Values":{"Type":1646,"Flags":0}}}},{"2":{"Name":"TableVisual","Properties":{"Actions":{"Type":1647,"Flags":0},"ChartConfiguration":{"Type":1344,"Flags":0},"ConditionalFormatting":{"Type":1342,"Flags":0},"Subtitle":{"Type":1416,"Flags":0},"Title":{"Type":1417,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"TargetVisualOptions"}},{"2":{"Name":"TextAreaControlDisplayOptions","Properties":{"InfoIconLabelOptions":{"Type":1303,"Flags":0},"PlaceholderOptions":{"Type":1372,"Flags":0},"TitleOptions":{"Type":1125,"Flags":0}}}},{"2":{"Name":"TextConditionalFormat","Properties":{"BackgroundColor":{"Type":912,"Flags":0},"Icon":{"Type":916,"Flags":0},"TextColor":{"Type":912,"Flags":0}}}},{"2":{"Name":"TextControlPlaceholderOptions","Properties":{"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"TextFieldControlDisplayOptions","Properties":{"InfoIconLabelOptions":{"Type":1303,"Flags":0},"PlaceholderOptions":{"Type":1372,"Flags":0},"TitleOptions":{"Type":1125,"Flags":0}}}},{"2":{"Name":"TextWrap"}},{"2":{"Name":"ThousandSeparatorOptions","Properties":{"Symbol":{"Type":4,"Flags":0},"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"TimeBasedForecastProperties","Properties":{"LowerBoundary":{"Type":3,"Flags":0},"PeriodsBackward":{"Type":3,"Flags":0},"PeriodsForward":{"Type":3,"Flags":0},"PredictionInterval":{"Type":3,"Flags":0},"Seasonality":{"Type":3,"Flags":0},"UpperBoundary":{"Type":3,"Flags":0}}}},{"2":{"Name":"TimeEqualityFilter","Properties":{"Column":{"Type":899,"Flags":1},"FilterId":{"Type":4,"Flags":1},"ParameterName":{"Type":4,"Flags":0},"RollingDate":{"Type":1270,"Flags":0},"TimeGranularity":{"Type":4,"Flags":0},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"TimeGranularity"}},{"2":{"Name":"TimeRangeDrillDownFilter","Properties":{"Column":{"Type":899,"Flags":1},"RangeMaximum":{"Type":4,"Flags":1},"RangeMinimum":{"Type":4,"Flags":1},"TimeGranularity":{"Type":4,"Flags":1}}}},{"2":{"Name":"TimeRangeFilter","Properties":{"Column":{"Type":899,"Flags":1},"ExcludePeriodConfiguration":{"Type":999,"Flags":0},"FilterId":{"Type":4,"Flags":1},"IncludeMaximum":{"Type":2,"Flags":0},"IncludeMinimum":{"Type":2,"Flags":0},"NullOption":{"Type":4,"Flags":1},"RangeMaximumValue":{"Type":1381,"Flags":0},"RangeMinimumValue":{"Type":1381,"Flags":0},"TimeGranularity":{"Type":4,"Flags":0}}}},{"2":{"Name":"TimeRangeFilterValue","Properties":{"Parameter":{"Type":4,"Flags":0},"RollingDate":{"Type":1270,"Flags":0},"StaticValue":{"Type":4,"Flags":0}}}},{"2":{"Name":"TooltipItem","Properties":{"ColumnTooltipItem":{"Type":902,"Flags":0},"FieldTooltipItem":{"Type":1009,"Flags":0}}}},{"2":{"Name":"TooltipOptions","Properties":{"FieldBasedTooltip":{"Type":1004,"Flags":0},"SelectedTooltipType":{"Type":4,"Flags":0},"TooltipVisibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"TooltipTitleType"}},{"2":{"Name":"TopBottomComputationType"}},{"2":{"Name":"TopBottomFilter","Properties":{"AggregationSortConfigurations":{"Type":1648,"Flags":1},"Column":{"Type":899,"Flags":1},"FilterId":{"Type":4,"Flags":1},"Limit":{"Type":3,"Flags":0},"ParameterName":{"Type":4,"Flags":0},"TimeGranularity":{"Type":4,"Flags":0}}}},{"2":{"Name":"TopBottomMoversComputation","Properties":{"Category":{"Type":991,"Flags":0},"ComputationId":{"Type":4,"Flags":1},"MoverSize":{"Type":3,"Flags":0},"Name":{"Type":4,"Flags":0},"SortOrder":{"Type":4,"Flags":0},"Time":{"Type":991,"Flags":0},"Type":{"Type":4,"Flags":1},"Value":{"Type":1157,"Flags":0}}}},{"2":{"Name":"TopBottomRankedComputation","Properties":{"Category":{"Type":991,"Flags":0},"ComputationId":{"Type":4,"Flags":1},"Name":{"Type":4,"Flags":0},"ResultSize":{"Type":3,"Flags":0},"Type":{"Type":4,"Flags":1},"Value":{"Type":1157,"Flags":0}}}},{"2":{"Name":"TopBottomSortOrder"}},{"2":{"Name":"TotalAggregationComputation","Properties":{"ComputationId":{"Type":4,"Flags":1},"Name":{"Type":4,"Flags":0},"Value":{"Type":1157,"Flags":0}}}},{"2":{"Name":"TotalAggregationFunction","Properties":{"SimpleTotalAggregationFunction":{"Type":4,"Flags":0}}}},{"2":{"Name":"TotalAggregationOption","Properties":{"FieldId":{"Type":4,"Flags":1},"TotalAggregationFunction":{"Type":1391,"Flags":1}}}},{"2":{"Name":"TotalOptions","Properties":{"CustomLabel":{"Type":4,"Flags":0},"Placement":{"Type":4,"Flags":0},"ScrollStatus":{"Type":4,"Flags":0},"TotalAggregationOptions":{"Type":1649,"Flags":0},"TotalCellStyle":{"Type":1341,"Flags":0},"TotalsVisibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"TreeMapAggregatedFieldWells","Properties":{"Colors":{"Type":1650,"Flags":0},"Groups":{"Type":1651,"Flags":0},"Sizes":{"Type":1652,"Flags":0}}}},{"2":{"Name":"TreeMapConfiguration","Properties":{"ColorLabelOptions":{"Type":891,"Flags":0},"ColorScale":{"Type":895,"Flags":0},"DataLabels":{"Type":953,"Flags":0},"FieldWells":{"Type":1396,"Flags":0},"GroupLabelOptions":{"Type":891,"Flags":0},"Legend":{"Type":1129,"Flags":0},"SizeLabelOptions":{"Type":891,"Flags":0},"SortConfiguration":{"Type":1397,"Flags":0},"Tooltip":{"Type":1383,"Flags":0}}}},{"2":{"Name":"TreeMapFieldWells","Properties":{"TreeMapAggregatedFieldWells":{"Type":1394,"Flags":0}}}},{"2":{"Name":"TreeMapSortConfiguration","Properties":{"TreeMapGroupItemsLimitConfiguration":{"Type":1108,"Flags":0},"TreeMapSort":{"Type":1653,"Flags":0}}}},{"2":{"Name":"TreeMapVisual","Properties":{"Actions":{"Type":1654,"Flags":0},"ChartConfiguration":{"Type":1395,"Flags":0},"ColumnHierarchies":{"Type":1655,"Flags":0},"Subtitle":{"Type":1416,"Flags":0},"Title":{"Type":1417,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"TrendArrowOptions","Properties":{"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"URLTargetConfiguration"}},{"2":{"Name":"UnaggregatedField","Properties":{"Column":{"Type":899,"Flags":1},"FieldId":{"Type":4,"Flags":1},"FormatConfiguration":{"Type":1045,"Flags":0}}}},{"2":{"Name":"UniqueValuesComputation","Properties":{"Category":{"Type":991,"Flags":0},"ComputationId":{"Type":4,"Flags":1},"Name":{"Type":4,"Flags":0}}}},{"2":{"Name":"ValidationStrategy","Properties":{"Mode":{"Type":4,"Flags":1}}}},{"2":{"Name":"ValidationStrategyMode"}},{"2":{"Name":"ValueWhenUnsetOption"}},{"2":{"Name":"VerticalTextAlignment"}},{"2":{"Name":"Visibility"}},{"2":{"Name":"VisibleRangeOptions","Properties":{"PercentRange":{"Type":1199,"Flags":0}}}},{"2":{"Name":"Visual","Properties":{"BarChartVisual":{"Type":864,"Flags":0},"BoxPlotVisual":{"Type":878,"Flags":0},"ComboChartVisual":{"Type":907,"Flags":0},"CustomContentVisual":{"Type":933,"Flags":0},"EmptyVisual":{"Type":997,"Flags":0},"FilledMapVisual":{"Type":1017,"Flags":0},"FunnelChartVisual":{"Type":1059,"Flags":0},"GaugeChartVisual":{"Type":1067,"Flags":0},"GeospatialMapVisual":{"Type":1076,"Flags":0},"HeatMapVisual":{"Type":1093,"Flags":0},"HistogramVisual":{"Type":1099,"Flags":0},"InsightVisual":{"Type":1103,"Flags":0},"KPIVisual":{"Type":1121,"Flags":0},"LineChartVisual":{"Type":1142,"Flags":0},"PieChartVisual":{"Type":1208,"Flags":0},"PivotTableVisual":{"Type":1235,"Flags":0},"RadarChartVisual":{"Type":1248,"Flags":0},"SankeyDiagramVisual":{"Type":1277,"Flags":0},"ScatterPlotVisual":{"Type":1282,"Flags":0},"TableVisual":{"Type":1367,"Flags":0},"TreeMapVisual":{"Type":1398,"Flags":0},"WaterfallVisual":{"Type":1423,"Flags":0},"WordCloudVisual":{"Type":1433,"Flags":0}}}},{"2":{"Name":"VisualAxisSortOption","Properties":{"AvailabilityStatus":{"Type":4,"Flags":0}}}},{"2":{"Name":"VisualCustomAction","Properties":{"ActionOperations":{"Type":1656,"Flags":1},"CustomActionId":{"Type":4,"Flags":1},"Name":{"Type":4,"Flags":1},"Status":{"Type":4,"Flags":0},"Trigger":{"Type":4,"Flags":1}}}},{"2":{"Name":"VisualCustomActionOperation","Properties":{"FilterOperation":{"Type":925,"Flags":0},"NavigationOperation":{"Type":926,"Flags":0},"SetParametersOperation":{"Type":927,"Flags":0},"URLOperation":{"Type":928,"Flags":0}}}},{"2":{"Name":"VisualCustomActionTrigger"}},{"2":{"Name":"VisualMenuOption","Properties":{"AvailabilityStatus":{"Type":4,"Flags":0}}}},{"2":{"Name":"VisualPalette","Properties":{"ChartColor":{"Type":4,"Flags":0},"ColorMap":{"Type":1657,"Flags":0}}}},{"2":{"Name":"VisualSubtitleLabelOptions","Properties":{"FormatText":{"Type":1151,"Flags":0},"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"VisualTitleLabelOptions","Properties":{"FormatText":{"Type":1315,"Flags":0},"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"WaterfallChartAggregatedFieldWells","Properties":{"Breakdowns":{"Type":1658,"Flags":0},"Categories":{"Type":1659,"Flags":0},"Values":{"Type":1660,"Flags":0}}}},{"2":{"Name":"WaterfallChartConfiguration","Properties":{"CategoryAxisDisplayOptions":{"Type":851,"Flags":0},"CategoryAxisLabelOptions":{"Type":891,"Flags":0},"DataLabels":{"Type":953,"Flags":0},"FieldWells":{"Type":1420,"Flags":0},"Legend":{"Type":1129,"Flags":0},"PrimaryYAxisDisplayOptions":{"Type":851,"Flags":0},"PrimaryYAxisLabelOptions":{"Type":891,"Flags":0},"SortConfiguration":{"Type":1422,"Flags":0},"VisualPalette":{"Type":1415,"Flags":0},"WaterfallChartOptions":{"Type":1421,"Flags":0}}}},{"2":{"Name":"WaterfallChartFieldWells","Properties":{"WaterfallChartAggregatedFieldWells":{"Type":1418,"Flags":0}}}},{"2":{"Name":"WaterfallChartOptions","Properties":{"TotalBarLabel":{"Type":4,"Flags":0}}}},{"2":{"Name":"WaterfallChartSortConfiguration","Properties":{"BreakdownItemsLimit":{"Type":1108,"Flags":0},"CategorySort":{"Type":1661,"Flags":0}}}},{"2":{"Name":"WaterfallVisual","Properties":{"Actions":{"Type":1662,"Flags":0},"ChartConfiguration":{"Type":1419,"Flags":0},"ColumnHierarchies":{"Type":1663,"Flags":0},"Subtitle":{"Type":1416,"Flags":0},"Title":{"Type":1417,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"WhatIfPointScenario","Properties":{"Date":{"Type":4,"Flags":1},"Value":{"Type":3,"Flags":1}}}},{"2":{"Name":"WhatIfRangeScenario","Properties":{"EndDate":{"Type":4,"Flags":1},"StartDate":{"Type":4,"Flags":1},"Value":{"Type":3,"Flags":1}}}},{"2":{"Name":"WidgetStatus"}},{"2":{"Name":"WordCloudAggregatedFieldWells","Properties":{"GroupBy":{"Type":1664,"Flags":0},"Size":{"Type":1665,"Flags":0}}}},{"2":{"Name":"WordCloudChartConfiguration","Properties":{"CategoryLabelOptions":{"Type":891,"Flags":0},"FieldWells":{"Type":1430,"Flags":0},"SortConfiguration":{"Type":1432,"Flags":0},"WordCloudOptions":{"Type":1431,"Flags":0}}}},{"2":{"Name":"WordCloudCloudLayout"}},{"2":{"Name":"WordCloudFieldWells","Properties":{"WordCloudAggregatedFieldWells":{"Type":1427,"Flags":0}}}},{"2":{"Name":"WordCloudOptions","Properties":{"CloudLayout":{"Type":4,"Flags":0},"MaximumStringLength":{"Type":3,"Flags":0},"WordCasing":{"Type":4,"Flags":0},"WordOrientation":{"Type":4,"Flags":0},"WordPadding":{"Type":4,"Flags":0},"WordScaling":{"Type":4,"Flags":0}}}},{"2":{"Name":"WordCloudSortConfiguration","Properties":{"CategoryItemsLimit":{"Type":1108,"Flags":0},"CategorySort":{"Type":1666,"Flags":0}}}},{"2":{"Name":"WordCloudVisual","Properties":{"Actions":{"Type":1667,"Flags":0},"ChartConfiguration":{"Type":1428,"Flags":0},"ColumnHierarchies":{"Type":1668,"Flags":0},"Subtitle":{"Type":1416,"Flags":0},"Title":{"Type":1417,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"WordCloudWordCasing"}},{"2":{"Name":"WordCloudWordOrientation"}},{"2":{"Name":"WordCloudWordPadding"}},{"2":{"Name":"WordCloudWordScaling"}},{"3":{"ItemType":991}},{"3":{"ItemType":991}},{"3":{"ItemType":991}},{"3":{"ItemType":1157}},{"3":{"ItemType":922}},{"3":{"ItemType":1250}},{"3":{"ItemType":1008}},{"3":{"ItemType":1008}},{"3":{"ItemType":1008}},{"3":{"ItemType":1411}},{"3":{"ItemType":898}},{"3":{"ItemType":991}},{"3":{"ItemType":1157}},{"3":{"ItemType":1250}},{"3":{"ItemType":1008}},{"3":{"ItemType":1411}},{"3":{"ItemType":898}},{"3":{"ItemType":882}},{"3":{"ItemType":4}},{"3":{"ItemType":853}},{"3":{"ItemType":950}},{"3":{"ItemType":929}},{"3":{"ItemType":1157}},{"3":{"ItemType":991}},{"3":{"ItemType":991}},{"3":{"ItemType":1157}},{"3":{"ItemType":1250}},{"3":{"ItemType":1008}},{"3":{"ItemType":1008}},{"3":{"ItemType":1411}},{"3":{"ItemType":898}},{"3":{"ItemType":899}},{"3":{"ItemType":1298}},{"3":{"ItemType":1411}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":3}},{"3":{"ItemType":3}},{"3":{"ItemType":4}},{"3":{"ItemType":998}},{"3":{"ItemType":966}},{"3":{"ItemType":4}},{"3":{"ItemType":940}},{"3":{"ItemType":1300}},{"3":{"ItemType":879}},{"3":{"ItemType":897}},{"3":{"ItemType":965}},{"3":{"ItemType":1022}},{"3":{"ItemType":1190}},{"3":{"ItemType":1309}},{"3":{"ItemType":956}},{"3":{"ItemType":961}},{"3":{"ItemType":4}},{"3":{"ItemType":994}},{"3":{"ItemType":4}},{"3":{"ItemType":1153}},{"3":{"ItemType":3}},{"3":{"ItemType":3}},{"3":{"ItemType":1153}},{"3":{"ItemType":1411}},{"3":{"ItemType":899}},{"3":{"ItemType":994}},{"3":{"ItemType":1382}},{"3":{"ItemType":991}},{"3":{"ItemType":1157}},{"3":{"ItemType":1012}},{"3":{"ItemType":1008}},{"3":{"ItemType":1411}},{"3":{"ItemType":898}},{"3":{"ItemType":1018}},{"3":{"ItemType":4}},{"3":{"ItemType":899}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":1048}},{"3":{"ItemType":1311}},{"3":{"ItemType":1048}},{"3":{"ItemType":991}},{"3":{"ItemType":1157}},{"3":{"ItemType":1008}},{"3":{"ItemType":1411}},{"3":{"ItemType":898}},{"3":{"ItemType":1062}},{"3":{"ItemType":1157}},{"3":{"ItemType":1157}},{"3":{"ItemType":1411}},{"3":{"ItemType":1071}},{"3":{"ItemType":991}},{"3":{"ItemType":991}},{"3":{"ItemType":1157}},{"3":{"ItemType":1411}},{"3":{"ItemType":898}},{"3":{"ItemType":1082}},{"3":{"ItemType":1085}},{"3":{"ItemType":991}},{"3":{"ItemType":991}},{"3":{"ItemType":1157}},{"3":{"ItemType":1008}},{"3":{"ItemType":1008}},{"3":{"ItemType":1411}},{"3":{"ItemType":898}},{"3":{"ItemType":1157}},{"3":{"ItemType":1411}},{"3":{"ItemType":911}},{"3":{"ItemType":1411}},{"3":{"ItemType":3}},{"3":{"ItemType":3}},{"3":{"ItemType":1153}},{"3":{"ItemType":1112}},{"3":{"ItemType":1157}},{"3":{"ItemType":991}},{"3":{"ItemType":1157}},{"3":{"ItemType":1008}},{"3":{"ItemType":1411}},{"3":{"ItemType":898}},{"3":{"ItemType":991}},{"3":{"ItemType":991}},{"3":{"ItemType":991}},{"3":{"ItemType":1157}},{"3":{"ItemType":922}},{"3":{"ItemType":1043}},{"3":{"ItemType":1250}},{"3":{"ItemType":1297}},{"3":{"ItemType":1008}},{"3":{"ItemType":1008}},{"3":{"ItemType":1411}},{"3":{"ItemType":898}},{"3":{"ItemType":1160}},{"3":{"ItemType":1268}},{"3":{"ItemType":4}},{"3":{"ItemType":974}},{"3":{"ItemType":980}},{"3":{"ItemType":1105}},{"3":{"ItemType":1330}},{"3":{"ItemType":991}},{"3":{"ItemType":991}},{"3":{"ItemType":1157}},{"3":{"ItemType":922}},{"3":{"ItemType":1008}},{"3":{"ItemType":1008}},{"3":{"ItemType":1411}},{"3":{"ItemType":898}},{"3":{"ItemType":991}},{"3":{"ItemType":991}},{"3":{"ItemType":1157}},{"3":{"ItemType":1214}},{"3":{"ItemType":1213}},{"3":{"ItemType":961}},{"3":{"ItemType":961}},{"3":{"ItemType":1220}},{"3":{"ItemType":1217}},{"3":{"ItemType":1222}},{"3":{"ItemType":1209}},{"3":{"ItemType":1411}},{"3":{"ItemType":1392}},{"3":{"ItemType":899}},{"3":{"ItemType":994}},{"3":{"ItemType":991}},{"3":{"ItemType":991}},{"3":{"ItemType":1157}},{"3":{"ItemType":1008}},{"3":{"ItemType":1008}},{"3":{"ItemType":1411}},{"3":{"ItemType":898}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":991}},{"3":{"ItemType":991}},{"3":{"ItemType":1157}},{"3":{"ItemType":1008}},{"3":{"ItemType":1411}},{"3":{"ItemType":991}},{"3":{"ItemType":991}},{"3":{"ItemType":1157}},{"3":{"ItemType":1157}},{"3":{"ItemType":1157}},{"3":{"ItemType":991}},{"3":{"ItemType":991}},{"3":{"ItemType":1157}},{"3":{"ItemType":991}},{"3":{"ItemType":991}},{"3":{"ItemType":1411}},{"3":{"ItemType":898}},{"3":{"ItemType":869}},{"3":{"ItemType":1088}},{"3":{"ItemType":1088}},{"3":{"ItemType":1314}},{"3":{"ItemType":1019}},{"3":{"ItemType":1126}},{"3":{"ItemType":1188}},{"3":{"ItemType":1304}},{"3":{"ItemType":1313}},{"3":{"ItemType":1409}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":1153}},{"3":{"ItemType":1224}},{"3":{"ItemType":1363}},{"3":{"ItemType":991}},{"3":{"ItemType":1157}},{"3":{"ItemType":1343}},{"3":{"ItemType":1355}},{"3":{"ItemType":4}},{"3":{"ItemType":1351}},{"3":{"ItemType":4}},{"3":{"ItemType":1008}},{"3":{"ItemType":1401}},{"3":{"ItemType":1411}},{"3":{"ItemType":834}},{"3":{"ItemType":1392}},{"3":{"ItemType":1157}},{"3":{"ItemType":991}},{"3":{"ItemType":1157}},{"3":{"ItemType":1008}},{"3":{"ItemType":1411}},{"3":{"ItemType":898}},{"3":{"ItemType":1412}},{"3":{"ItemType":957}},{"3":{"ItemType":991}},{"3":{"ItemType":991}},{"3":{"ItemType":1157}},{"3":{"ItemType":1008}},{"3":{"ItemType":1411}},{"3":{"ItemType":898}},{"3":{"ItemType":991}},{"3":{"ItemType":1157}},{"3":{"ItemType":1008}},{"3":{"ItemType":1411}},{"3":{"ItemType":898}},{"2":{"Name":"AWS.QuickSight/DashboardProperties","Properties":{"Arn":{"Type":4,"Flags":2},"AwsAccountId":{"Type":4,"Flags":17},"CreatedTime":{"Type":4,"Flags":2},"DashboardId":{"Type":4,"Flags":17},"DashboardPublishOptions":{"Type":942,"Flags":4},"Definition":{"Type":947,"Flags":4},"LastPublishedTime":{"Type":4,"Flags":2},"LastUpdatedTime":{"Type":4,"Flags":2},"LinkSharingConfiguration":{"Type":1145,"Flags":4},"Name":{"Type":4,"Flags":1},"Parameters":{"Type":1198,"Flags":4},"Permissions":{"Type":1670,"Flags":0},"SourceEntity":{"Type":943,"Flags":4},"Tags":{"Type":1671,"Flags":0},"ThemeArn":{"Type":4,"Flags":4},"ValidationStrategy":{"Type":1403,"Flags":4},"Version":{"Type":946,"Flags":2},"VersionDescription":{"Type":4,"Flags":4}}}},{"3":{"ItemType":1268}},{"3":{"ItemType":1368}},{"2":{"Name":"AWS.QuickSight/Dashboard","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":1669,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.QuickSight/Dashboard@default","ScopeType":0,"Body":1672}},{"2":{"Name":"CalculatedColumn","Properties":{"ColumnId":{"Type":4,"Flags":1,"Description":"

A unique ID to identify a calculated column. During a dataset update, if the column ID\n of a calculated column matches that of an existing calculated column, Amazon QuickSight\n preserves the existing calculated column.

"},"ColumnName":{"Type":4,"Flags":1,"Description":"

Column name.

"},"Expression":{"Type":4,"Flags":1,"Description":"

An expression that defines the calculated column.

"}}}},{"2":{"Name":"CastColumnTypeOperation","Properties":{"ColumnName":{"Type":4,"Flags":1,"Description":"

Column name.

"},"Format":{"Type":4,"Flags":0,"Description":"

When casting a column from string to datetime type, you can supply a string in a\n format supported by Amazon QuickSight to denote the source data format.

"},"NewColumnType":{"Type":4,"Flags":1},"SubType":{"Type":4,"Flags":0}}}},{"2":{"Name":"ColumnDataType"}},{"2":{"Name":"ColumnDescription","Properties":{"Text":{"Type":4,"Flags":0,"Description":"

The text of a description for a column.

"}}}},{"2":{"Name":"ColumnGroup","Properties":{"GeoSpatialColumnGroup":{"Type":1701,"Flags":0}}}},{"2":{"Name":"ColumnLevelPermissionRule","Properties":{"ColumnNames":{"Type":1746,"Flags":0},"Principals":{"Type":1747,"Flags":0}}}},{"2":{"Name":"ColumnSubDataType"}},{"2":{"Name":"ColumnTag","Properties":{"ColumnDescription":{"Type":1677,"Flags":0},"ColumnGeographicRole":{"Type":4,"Flags":0}}}},{"2":{"Name":"CreateColumnsOperation","Properties":{"Columns":{"Type":1748,"Flags":1,"Description":"

Calculated columns to create.

"}}}},{"2":{"Name":"CustomSql","Properties":{"Columns":{"Type":1749,"Flags":1,"Description":"

The column schema from the SQL query result set.

"},"DataSourceArn":{"Type":4,"Flags":1,"Description":"

The Amazon Resource Name (ARN) of the data source.

"},"Name":{"Type":4,"Flags":1,"Description":"

A display name for the SQL query result.

"},"SqlQuery":{"Type":4,"Flags":1,"Description":"

The SQL query.

"}}}},{"2":{"Name":"DataSetImportMode"}},{"2":{"Name":"DataSetRefreshProperties","Properties":{"RefreshConfiguration":{"Type":1724,"Flags":0}}}},{"2":{"Name":"DataSetUsageConfiguration","Properties":{"DisableUseAsDirectQuerySource":{"Type":2,"Flags":0},"DisableUseAsImportedSource":{"Type":2,"Flags":0}}}},{"2":{"Name":"DatasetParameter","Properties":{"DateTimeDatasetParameter":{"Type":1691,"Flags":0},"DecimalDatasetParameter":{"Type":1694,"Flags":0},"IntegerDatasetParameter":{"Type":1708,"Flags":0},"StringDatasetParameter":{"Type":1737,"Flags":0}}}},{"2":{"Name":"DatasetParameterId"}},{"2":{"Name":"DatasetParameterName"}},{"2":{"Name":"DatasetParameterValueType"}},{"2":{"Name":"DateTimeDatasetParameter","Properties":{"DefaultValues":{"Type":1692,"Flags":0},"Id":{"Type":4,"Flags":1},"Name":{"Type":4,"Flags":1},"TimeGranularity":{"Type":4,"Flags":0},"ValueType":{"Type":4,"Flags":1}}}},{"2":{"Name":"DateTimeDatasetParameterDefaultValues","Properties":{"StaticValues":{"Type":1750,"Flags":0,"Description":"

List of static default values defined for a given string date time parameter type.

"}}}},{"2":{"Name":"DateTimeDatasetParameterValueList"}},{"2":{"Name":"DecimalDatasetParameter","Properties":{"DefaultValues":{"Type":1695,"Flags":0},"Id":{"Type":4,"Flags":1},"Name":{"Type":4,"Flags":1},"ValueType":{"Type":4,"Flags":1}}}},{"2":{"Name":"DecimalDatasetParameterDefaultValues","Properties":{"StaticValues":{"Type":1752,"Flags":0,"Description":"

List of static default values defined for a given decimal dataset parameter type.

"}}}},{"2":{"Name":"DecimalDatasetParameterValueList"}},{"2":{"Name":"FieldFolder","Properties":{"Columns":{"Type":1754,"Flags":0},"Description":{"Type":4,"Flags":0}}}},{"2":{"Name":"FieldFolderMap","Properties":{}}},{"2":{"Name":"FileFormat"}},{"2":{"Name":"FilterOperation","Properties":{"ConditionExpression":{"Type":4,"Flags":1,"Description":"

An expression that must evaluate to a Boolean value. Rows for which the expression\n evaluates to true are kept in the dataset.

"}}}},{"2":{"Name":"GeoSpatialColumnGroup","Properties":{"Columns":{"Type":1755,"Flags":1,"Description":"

Columns in this hierarchy.

"},"CountryCode":{"Type":4,"Flags":0},"Name":{"Type":4,"Flags":1,"Description":"

A display name for the hierarchy.

"}}}},{"2":{"Name":"GeoSpatialCountryCode"}},{"2":{"Name":"GeoSpatialDataRole"}},{"2":{"Name":"IncrementalRefresh","Properties":{"LookbackWindow":{"Type":1717,"Flags":0}}}},{"2":{"Name":"IngestionWaitPolicy","Properties":{"IngestionWaitTimeInHours":{"Type":3,"Flags":0,"Description":"

The maximum time (in hours) to wait for Ingestion to complete. Default timeout is 36 hours.\n Applicable only when DataSetImportMode mode is set to SPICE and WaitForSpiceIngestion is set to true.

"},"WaitForSpiceIngestion":{"Type":2,"Flags":0,"Description":"

Wait for SPICE ingestion to finish to mark dataset creation/update successful. Default (true).\n Applicable only when DataSetImportMode mode is set to SPICE.

"}}}},{"2":{"Name":"InputColumn","Properties":{"Name":{"Type":4,"Flags":1,"Description":"

The name of this column in the underlying data source.

"},"SubType":{"Type":4,"Flags":0},"Type":{"Type":4,"Flags":1}}}},{"2":{"Name":"InputColumnDataType"}},{"2":{"Name":"IntegerDatasetParameter","Properties":{"DefaultValues":{"Type":1709,"Flags":0},"Id":{"Type":4,"Flags":1},"Name":{"Type":4,"Flags":1},"ValueType":{"Type":4,"Flags":1}}}},{"2":{"Name":"IntegerDatasetParameterDefaultValues","Properties":{"StaticValues":{"Type":1756,"Flags":0,"Description":"

List of static default values defined for a given integer dataset parameter type.

"}}}},{"2":{"Name":"IntegerDatasetParameterValueList"}},{"2":{"Name":"JoinInstruction","Properties":{"LeftJoinKeyProperties":{"Type":1712,"Flags":0},"LeftOperand":{"Type":4,"Flags":1,"Description":"

Left operand.

"},"OnClause":{"Type":4,"Flags":1,"Description":"

On Clause.

"},"RightJoinKeyProperties":{"Type":1712,"Flags":0},"RightOperand":{"Type":4,"Flags":1,"Description":"

Right operand.

"},"Type":{"Type":4,"Flags":1}}}},{"2":{"Name":"JoinKeyProperties","Properties":{"UniqueKey":{"Type":2,"Flags":0}}}},{"2":{"Name":"JoinType"}},{"2":{"Name":"LogicalTable","Properties":{"Alias":{"Type":4,"Flags":1,"Description":"

A display name for the logical table.

"},"DataTransforms":{"Type":1758,"Flags":0,"Description":"

Transform operations that act on this logical table.

"},"Source":{"Type":1716,"Flags":1}}}},{"2":{"Name":"LogicalTableMap","Properties":{}}},{"2":{"Name":"LogicalTableSource","Properties":{"DataSetArn":{"Type":4,"Flags":0,"Description":"

The Amazon Resource Name (ARN) for the dataset.

"},"JoinInstruction":{"Type":1711,"Flags":0},"PhysicalTableId":{"Type":4,"Flags":0,"Description":"

Physical table ID.

"}}}},{"2":{"Name":"LookbackWindow","Properties":{"ColumnName":{"Type":4,"Flags":0,"Description":"

Column Name

"},"Size":{"Type":3,"Flags":0,"Description":"

Size

"},"SizeUnit":{"Type":4,"Flags":0}}}},{"2":{"Name":"NewDefaultValues","Properties":{"DateTimeStaticValues":{"Type":1759,"Flags":0},"DecimalStaticValues":{"Type":1760,"Flags":0},"IntegerStaticValues":{"Type":1761,"Flags":0},"StringStaticValues":{"Type":1762,"Flags":0}}}},{"2":{"Name":"OutputColumn","Properties":{"Description":{"Type":4,"Flags":0,"Description":"

A description for a column.

"},"Name":{"Type":4,"Flags":0,"Description":"

A display name for the dataset.

"},"SubType":{"Type":4,"Flags":0},"Type":{"Type":4,"Flags":0}}}},{"2":{"Name":"OverrideDatasetParameterOperation","Properties":{"NewDefaultValues":{"Type":1718,"Flags":0,"Description":"

The new default values for the parameter.

"},"NewParameterName":{"Type":4,"Flags":0,"Description":"

The new name for the parameter.

"},"ParameterName":{"Type":4,"Flags":1,"Description":"

The name of the parameter to be overridden with different values.

"}}}},{"2":{"Name":"PhysicalTable","Properties":{"CustomSql":{"Type":1683,"Flags":0},"RelationalTable":{"Type":1725,"Flags":0},"S3Source":{"Type":1734,"Flags":0}}}},{"2":{"Name":"PhysicalTableMap","Properties":{}}},{"2":{"Name":"ProjectOperation","Properties":{"ProjectedColumns":{"Type":1763,"Flags":1,"Description":"

Projected columns.

"}}}},{"2":{"Name":"RefreshConfiguration","Properties":{"IncrementalRefresh":{"Type":1704,"Flags":0}}}},{"2":{"Name":"RelationalTable","Properties":{"Catalog":{"Type":4,"Flags":0,"Description":"

The catalog associated with a table.

"},"DataSourceArn":{"Type":4,"Flags":1,"Description":"

The Amazon Resource Name (ARN) for the data source.

"},"InputColumns":{"Type":1764,"Flags":1,"Description":"

The column schema of the table.

"},"Name":{"Type":4,"Flags":1,"Description":"

The name of the relational table.

"},"Schema":{"Type":4,"Flags":0,"Description":"

The schema name. This name applies to certain relational database engines.

"}}}},{"2":{"Name":"RenameColumnOperation","Properties":{"ColumnName":{"Type":4,"Flags":1,"Description":"

The name of the column to be renamed.

"},"NewColumnName":{"Type":4,"Flags":1,"Description":"

The new name for the column.

"}}}},{"2":{"Name":"ResourcePermission","Properties":{"Actions":{"Type":1765,"Flags":1,"Description":"

The IAM action to grant or revoke permissions on.

"},"Principal":{"Type":4,"Flags":1,"Description":"

The Amazon Resource Name (ARN) of the principal. This can be one of the\n following:

\n
    \n
  • \n

    The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

    \n
    • \n
  • \n

    The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)

    \n
    • \n
  • \n

    The ARN of an AWS account root: This is an IAM ARN rather than a QuickSight\n ARN. Use this option only to share resources (templates) across AWS accounts.\n (This is less common.)

    \n
    • \n
"}}}},{"2":{"Name":"RowLevelPermissionDataSet","Properties":{"Arn":{"Type":4,"Flags":1,"Description":"

The Amazon Resource Name (ARN) of the permission dataset.

"},"FormatVersion":{"Type":4,"Flags":0},"Namespace":{"Type":4,"Flags":0,"Description":"

The namespace associated with the row-level permissions dataset.

"},"PermissionPolicy":{"Type":4,"Flags":1},"Status":{"Type":4,"Flags":0}}}},{"2":{"Name":"RowLevelPermissionFormatVersion"}},{"2":{"Name":"RowLevelPermissionPolicy"}},{"2":{"Name":"RowLevelPermissionTagConfiguration","Properties":{"Status":{"Type":4,"Flags":0},"TagRuleConfigurations":{"Type":1767,"Flags":0,"Description":"

A list of tag configuration rules to apply to a dataset. All tag configurations have the OR condition. Tags within each tile will be joined (AND). At least one rule in this structure must have all tag values assigned to it to apply Row-level security (RLS) to the dataset.

"},"TagRules":{"Type":1768,"Flags":1,"Description":"

A set of rules associated with row-level security, such as the tag names and columns that they are assigned to.

"}}}},{"2":{"Name":"RowLevelPermissionTagRule","Properties":{"ColumnName":{"Type":4,"Flags":1,"Description":"

The column name that a tag key is assigned to.

"},"MatchAllValue":{"Type":4,"Flags":0,"Description":"

A string that you want to use to filter by all the values in a column in the dataset and don?t want to list the values one by one. For example, you can use an asterisk as your match all value.

"},"TagKey":{"Type":4,"Flags":1,"Description":"

The unique key for a tag.

"},"TagMultiValueDelimiter":{"Type":4,"Flags":0,"Description":"

A 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.

"}}}},{"2":{"Name":"RowLevelPermissionTagRuleConfiguration"}},{"2":{"Name":"S3Source","Properties":{"DataSourceArn":{"Type":4,"Flags":1,"Description":"

The amazon Resource Name (ARN) for the data source.

"},"InputColumns":{"Type":1770,"Flags":1,"Description":"

A physical table type for as S3 data source.

"},"UploadSettings":{"Type":1745,"Flags":0}}}},{"2":{"Name":"SizeUnit"}},{"2":{"Name":"Status"}},{"2":{"Name":"StringDatasetParameter","Properties":{"DefaultValues":{"Type":1738,"Flags":0},"Id":{"Type":4,"Flags":1},"Name":{"Type":4,"Flags":1},"ValueType":{"Type":4,"Flags":1}}}},{"2":{"Name":"StringDatasetParameterDefaultValues","Properties":{"StaticValues":{"Type":1771,"Flags":0,"Description":"

List of static default values defined for a given string dataset parameter type.

"}}}},{"2":{"Name":"StringDatasetParameterValueList"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"

Tag key.

"},"Value":{"Type":4,"Flags":1,"Description":"

Tag value.

"}}}},{"2":{"Name":"TagColumnOperation","Properties":{"ColumnName":{"Type":4,"Flags":1,"Description":"

The column that this operation acts on.

"},"Tags":{"Type":1773,"Flags":1,"Description":"

The dataset column tag, currently only used for geospatial type tagging. .

\n \n

This is not tags for the AWS tagging feature. .

\n "}}}},{"2":{"Name":"TextQualifier"}},{"2":{"Name":"TimeGranularity"}},{"2":{"Name":"TransformOperation","Properties":{"CastColumnTypeOperation":{"Type":1675,"Flags":0},"CreateColumnsOperation":{"Type":1682,"Flags":0},"FilterOperation":{"Type":1700,"Flags":0},"OverrideDatasetParameterOperation":{"Type":1720,"Flags":0},"ProjectOperation":{"Type":1723,"Flags":0},"RenameColumnOperation":{"Type":1726,"Flags":0},"TagColumnOperation":{"Type":1741,"Flags":0}}}},{"2":{"Name":"UploadSettings","Properties":{"ContainsHeader":{"Type":2,"Flags":0,"Description":"

Whether the file has a header row, or the files each have a header row.

"},"Delimiter":{"Type":4,"Flags":0,"Description":"

The delimiter between values in the file.

"},"Format":{"Type":4,"Flags":0},"StartFromRow":{"Type":3,"Flags":0,"Description":"

A row number to start reading data from.

"},"TextQualifier":{"Type":4,"Flags":0}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":1674}},{"3":{"ItemType":1706}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":3}},{"3":{"ItemType":3}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":3}},{"3":{"ItemType":3}},{"3":{"ItemType":1744}},{"3":{"ItemType":4}},{"3":{"ItemType":3}},{"3":{"ItemType":3}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":1706}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":1766}},{"3":{"ItemType":1732}},{"3":{"ItemType":4}},{"3":{"ItemType":1706}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":1681}},{"2":{"Name":"AWS.QuickSight/DataSetProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"

The Amazon Resource Name (ARN) of the resource.

"},"AwsAccountId":{"Type":4,"Flags":16},"ColumnGroups":{"Type":1775,"Flags":0,"Description":"

Groupings of columns that work together in certain QuickSight features. Currently, only geospatial hierarchy is supported.

"},"ColumnLevelPermissionRules":{"Type":1776,"Flags":0},"ConsumedSpiceCapacityInBytes":{"Type":3,"Flags":2,"Description":"

The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't\n imported into SPICE.

"},"CreatedTime":{"Type":4,"Flags":2,"Description":"

The time that this dataset was created.

"},"DataSetId":{"Type":4,"Flags":16},"DataSetRefreshProperties":{"Type":1685,"Flags":0},"DataSetUsageConfiguration":{"Type":1686,"Flags":0},"DatasetParameters":{"Type":1777,"Flags":0,"Description":"

The parameters declared in the dataset.

"},"FieldFolders":{"Type":1698,"Flags":4},"ImportMode":{"Type":4,"Flags":0},"IngestionWaitPolicy":{"Type":1705,"Flags":4},"LastUpdatedTime":{"Type":4,"Flags":2,"Description":"

The last time that this dataset was updated.

"},"LogicalTableMap":{"Type":1715,"Flags":0},"Name":{"Type":4,"Flags":0,"Description":"

The display name for the dataset.

"},"OutputColumns":{"Type":1778,"Flags":2,"Description":"

The list of columns after all transforms. These columns are available in templates,\n analyses, and dashboards.

"},"Permissions":{"Type":1779,"Flags":0,"Description":"

A list of resource permissions on the dataset.

"},"PhysicalTableMap":{"Type":1722,"Flags":0},"RowLevelPermissionDataSet":{"Type":1728,"Flags":0},"RowLevelPermissionTagConfiguration":{"Type":1731,"Flags":0},"Tags":{"Type":1780,"Flags":0,"Description":"

Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.

"}}}},{"3":{"ItemType":1678}},{"3":{"ItemType":1679}},{"3":{"ItemType":1687}},{"3":{"ItemType":1719}},{"3":{"ItemType":1727}},{"3":{"ItemType":1740}},{"2":{"Name":"AWS.QuickSight/DataSet","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":1774,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.QuickSight/DataSet@default","ScopeType":0,"Body":1781}},{"2":{"Name":"AmazonElasticsearchParameters","Properties":{"Domain":{"Type":4,"Flags":1,"Description":"

The Amazon Elasticsearch Service domain.

"}}}},{"2":{"Name":"AmazonOpenSearchParameters","Properties":{"Domain":{"Type":4,"Flags":1,"Description":"

The Amazon OpenSearch Service domain.

"}}}},{"2":{"Name":"AthenaParameters","Properties":{"RoleArn":{"Type":4,"Flags":0,"Description":"

Use 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.

"},"WorkGroup":{"Type":4,"Flags":0,"Description":"

The workgroup that Amazon Athena uses.

"}}}},{"2":{"Name":"AuroraParameters","Properties":{"Database":{"Type":4,"Flags":1,"Description":"

Database.

"},"Host":{"Type":4,"Flags":1,"Description":"

Host.

"},"Port":{"Type":3,"Flags":1,"Description":"

Port.

"}}}},{"2":{"Name":"AuroraPostgreSqlParameters","Properties":{"Database":{"Type":4,"Flags":1,"Description":"

Database.

"},"Host":{"Type":4,"Flags":1,"Description":"

Host.

"},"Port":{"Type":3,"Flags":1,"Description":"

Port.

"}}}},{"2":{"Name":"AwsIotAnalyticsParameters","Properties":{"DataSetName":{"Type":4,"Flags":1,"Description":"

Dataset name.

"}}}},{"2":{"Name":"CredentialPair","Properties":{"AlternateDataSourceParameters":{"Type":1817,"Flags":0,"Description":"

A set of alternate data source parameters that you want to share for these\n credentials. The credentials are applied in tandem with the data source parameters when\n you copy a data source by using a create or update request. The API operation compares\n the DataSourceParameters structure that's in the request with the\n structures in the AlternateDataSourceParameters allow list. If the\n structures are an exact match, the request is allowed to use the new data source with\n the existing credentials. If the AlternateDataSourceParameters list is\n null, the DataSourceParameters originally used with these\n Credentials is automatically allowed.

"},"Password":{"Type":4,"Flags":1,"Description":"

Password.

"},"Username":{"Type":4,"Flags":1,"Description":"

User name.

"}}}},{"2":{"Name":"DataSourceCredentials","Properties":{"CopySourceArn":{"Type":4,"Flags":0,"Description":"

The Amazon Resource Name (ARN) of a data source that has the credential pair that you\n want to use. When CopySourceArn is not null, the credential pair from the\n data source in the ARN is used as the credentials for the\n DataSourceCredentials structure.

"},"CredentialPair":{"Type":1789,"Flags":0},"SecretArn":{"Type":4,"Flags":0,"Description":"

The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.

"}}}},{"2":{"Name":"DataSourceErrorInfo","Properties":{"Message":{"Type":4,"Flags":0,"Description":"

Error message.

"},"Type":{"Type":4,"Flags":0}}}},{"2":{"Name":"DataSourceErrorInfoType"}},{"2":{"Name":"DataSourceParameters","Properties":{"AmazonElasticsearchParameters":{"Type":1783,"Flags":0},"AmazonOpenSearchParameters":{"Type":1784,"Flags":0},"AthenaParameters":{"Type":1785,"Flags":0},"AuroraParameters":{"Type":1786,"Flags":0},"AuroraPostgreSqlParameters":{"Type":1787,"Flags":0},"DatabricksParameters":{"Type":1795,"Flags":0},"MariaDbParameters":{"Type":1797,"Flags":0},"MySqlParameters":{"Type":1798,"Flags":0},"OracleParameters":{"Type":1799,"Flags":0},"PostgreSqlParameters":{"Type":1800,"Flags":0},"PrestoParameters":{"Type":1801,"Flags":0},"RdsParameters":{"Type":1802,"Flags":0},"RedshiftParameters":{"Type":1803,"Flags":0},"S3Parameters":{"Type":1806,"Flags":0},"SnowflakeParameters":{"Type":1807,"Flags":0},"SparkParameters":{"Type":1808,"Flags":0},"SqlServerParameters":{"Type":1809,"Flags":0},"StarburstParameters":{"Type":1811,"Flags":0},"TeradataParameters":{"Type":1814,"Flags":0},"TrinoParameters":{"Type":1815,"Flags":0}}}},{"2":{"Name":"DataSourceType"}},{"2":{"Name":"DatabricksParameters","Properties":{"Host":{"Type":4,"Flags":1,"Description":"

Host.

"},"Port":{"Type":3,"Flags":1,"Description":"

Port.

"},"SqlEndpointPath":{"Type":4,"Flags":1,"Description":"

The HTTP Path of the Databricks data source.

"}}}},{"2":{"Name":"ManifestFileLocation","Properties":{"Bucket":{"Type":4,"Flags":1,"Description":"

Amazon S3 bucket.

"},"Key":{"Type":4,"Flags":1,"Description":"

Amazon S3 key that identifies an object.

"}}}},{"2":{"Name":"MariaDbParameters","Properties":{"Database":{"Type":4,"Flags":1,"Description":"

Database.

"},"Host":{"Type":4,"Flags":1,"Description":"

Host.

"},"Port":{"Type":3,"Flags":1,"Description":"

Port.

"}}}},{"2":{"Name":"MySqlParameters","Properties":{"Database":{"Type":4,"Flags":1,"Description":"

Database.

"},"Host":{"Type":4,"Flags":1,"Description":"

Host.

"},"Port":{"Type":3,"Flags":1,"Description":"

Port.

"}}}},{"2":{"Name":"OracleParameters","Properties":{"Database":{"Type":4,"Flags":1},"Host":{"Type":4,"Flags":1},"Port":{"Type":3,"Flags":1}}}},{"2":{"Name":"PostgreSqlParameters","Properties":{"Database":{"Type":4,"Flags":1,"Description":"

Database.

"},"Host":{"Type":4,"Flags":1,"Description":"

Host.

"},"Port":{"Type":3,"Flags":1,"Description":"

Port.

"}}}},{"2":{"Name":"PrestoParameters","Properties":{"Catalog":{"Type":4,"Flags":1,"Description":"

Catalog.

"},"Host":{"Type":4,"Flags":1,"Description":"

Host.

"},"Port":{"Type":3,"Flags":1,"Description":"

Port.

"}}}},{"2":{"Name":"RdsParameters","Properties":{"Database":{"Type":4,"Flags":1,"Description":"

Database.

"},"InstanceId":{"Type":4,"Flags":1,"Description":"

Instance ID.

"}}}},{"2":{"Name":"RedshiftParameters","Properties":{"ClusterId":{"Type":4,"Flags":0,"Description":"

Cluster ID. This field can be blank if the Host and Port are\n provided.

"},"Database":{"Type":4,"Flags":1,"Description":"

Database.

"},"Host":{"Type":4,"Flags":0,"Description":"

Host. This field can be blank if ClusterId is provided.

"},"Port":{"Type":3,"Flags":0,"Description":"

Port. This field can be blank if the ClusterId is provided.

"}}}},{"2":{"Name":"ResourcePermission","Properties":{"Actions":{"Type":1818,"Flags":1,"Description":"

The IAM action to grant or revoke permissions on.

"},"Principal":{"Type":4,"Flags":1,"Description":"

The Amazon Resource Name (ARN) of the principal. This can be one of the\n following:

\n
    \n
  • \n

    The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

    \n
    • \n
  • \n

    The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)

    \n
    • \n
  • \n

    The ARN of an AWS account root: This is an IAM ARN rather than a QuickSight\n ARN. Use this option only to share resources (templates) across AWS accounts.\n (This is less common.)

    \n
    • \n
"}}}},{"2":{"Name":"ResourceStatus"}},{"2":{"Name":"S3Parameters","Properties":{"ManifestFileLocation":{"Type":1796,"Flags":1},"RoleArn":{"Type":4,"Flags":0,"Description":"

Use 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.

"}}}},{"2":{"Name":"SnowflakeParameters","Properties":{"Database":{"Type":4,"Flags":1,"Description":"

Database.

"},"Host":{"Type":4,"Flags":1,"Description":"

Host.

"},"Warehouse":{"Type":4,"Flags":1,"Description":"

Warehouse.

"}}}},{"2":{"Name":"SparkParameters","Properties":{"Host":{"Type":4,"Flags":1,"Description":"

Host.

"},"Port":{"Type":3,"Flags":1,"Description":"

Port.

"}}}},{"2":{"Name":"SqlServerParameters","Properties":{"Database":{"Type":4,"Flags":1,"Description":"

Database.

"},"Host":{"Type":4,"Flags":1,"Description":"

Host.

"},"Port":{"Type":3,"Flags":1,"Description":"

Port.

"}}}},{"2":{"Name":"SslProperties","Properties":{"DisableSsl":{"Type":2,"Flags":0,"Description":"

A Boolean option to control whether SSL should be disabled.

"}}}},{"2":{"Name":"StarburstParameters","Properties":{"Catalog":{"Type":4,"Flags":1,"Description":"

Catalog.

"},"Host":{"Type":4,"Flags":1,"Description":"

Host.

"},"Port":{"Type":3,"Flags":1,"Description":"

Port.

"},"ProductType":{"Type":4,"Flags":0}}}},{"2":{"Name":"StarburstProductType"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"

Tag key.

"},"Value":{"Type":4,"Flags":1,"Description":"

Tag value.

"}}}},{"2":{"Name":"TeradataParameters","Properties":{"Database":{"Type":4,"Flags":1,"Description":"

Database.

"},"Host":{"Type":4,"Flags":1,"Description":"

Host.

"},"Port":{"Type":3,"Flags":1,"Description":"

Port.

"}}}},{"2":{"Name":"TrinoParameters","Properties":{"Catalog":{"Type":4,"Flags":1,"Description":"

Catalog.

"},"Host":{"Type":4,"Flags":1,"Description":"

Host.

"},"Port":{"Type":3,"Flags":1,"Description":"

Port.

"}}}},{"2":{"Name":"VpcConnectionProperties","Properties":{"VpcConnectionArn":{"Type":4,"Flags":1,"Description":"

The Amazon Resource Name (ARN) for the VPC connection.

"}}}},{"3":{"ItemType":1793}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.QuickSight/DataSourceProperties","Properties":{"AlternateDataSourceParameters":{"Type":1820,"Flags":0,"Description":"

A set of alternate data source parameters that you want to share for the credentials\n stored with this data source. The credentials are applied in tandem with the data source\n parameters when you copy a data source by using a create or update request. The API\n operation compares the DataSourceParameters structure that's in the request\n with the structures in the AlternateDataSourceParameters allow list. If the\n structures are an exact match, the request is allowed to use the credentials from this\n existing data source. If the AlternateDataSourceParameters list is null,\n the Credentials originally used with this DataSourceParameters\n are automatically allowed.

"},"Arn":{"Type":4,"Flags":2,"Description":"

The Amazon Resource Name (ARN) of the data source.

"},"AwsAccountId":{"Type":4,"Flags":16},"CreatedTime":{"Type":4,"Flags":2,"Description":"

The time that this data source was created.

"},"Credentials":{"Type":1790,"Flags":4},"DataSourceId":{"Type":4,"Flags":16},"DataSourceParameters":{"Type":1793,"Flags":0},"ErrorInfo":{"Type":1791,"Flags":0},"LastUpdatedTime":{"Type":4,"Flags":2,"Description":"

The last time that this data source was updated.

"},"Name":{"Type":4,"Flags":0,"Description":"

A display name for the data source.

"},"Permissions":{"Type":1821,"Flags":0,"Description":"

A list of resource permissions on the data source.

"},"SslProperties":{"Type":1810,"Flags":0},"Status":{"Type":4,"Flags":2},"Tags":{"Type":1822,"Flags":0,"Description":"

Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.

"},"Type":{"Type":4,"Flags":0},"VpcConnectionProperties":{"Type":1816,"Flags":0}}}},{"3":{"ItemType":1793}},{"3":{"ItemType":1804}},{"3":{"ItemType":1813}},{"2":{"Name":"AWS.QuickSight/DataSource","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":1819,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.QuickSight/DataSource@default","ScopeType":0,"Body":1823}},{"2":{"Name":"RefreshScheduleMap","Properties":{"RefreshType":{"Type":4,"Flags":0},"ScheduleFrequency":{"Type":1827,"Flags":0,"Description":"

Information about the schedule frequency.

"},"ScheduleId":{"Type":4,"Flags":0,"Description":"

An unique identifier for the refresh schedule.

"},"StartAfterDateTime":{"Type":4,"Flags":0,"Description":"

The date time after which refresh is to be scheduled

"}}}},{"2":{"Name":"RefreshSchedule_ScheduleFrequency_RefreshOnDay","Properties":{"DayOfMonth":{"Type":4,"Flags":0,"Description":"

The Day Of Month for scheduled refresh.

"},"DayOfWeek":{"Type":4,"Flags":0}}}},{"2":{"Name":"RefreshSchedule_ScheduleFrequency","Properties":{"Interval":{"Type":4,"Flags":0},"RefreshOnDay":{"Type":1826,"Flags":0,"Description":"

The day scheduled for refresh.

"},"TimeOfTheDay":{"Type":4,"Flags":0,"Description":"

The time of the day for scheduled refresh.

"},"TimeZone":{"Type":4,"Flags":0,"Description":"

The timezone for scheduled refresh.

"}}}},{"2":{"Name":"AWS.QuickSight/RefreshScheduleProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"

The Amazon Resource Name (ARN) of the data source.

"},"AwsAccountId":{"Type":4,"Flags":16},"DataSetId":{"Type":4,"Flags":16},"Schedule":{"Type":1825,"Flags":0}}}},{"2":{"Name":"AWS.QuickSight/RefreshSchedule","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":1828,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.QuickSight/RefreshSchedule@default","ScopeType":0,"Body":1829}},{"2":{"Name":"AggregationFunction","Properties":{"AttributeAggregationFunction":{"Type":1844,"Flags":0},"CategoricalAggregationFunction":{"Type":4,"Flags":0},"DateAggregationFunction":{"Type":4,"Flags":0},"NumericalAggregationFunction":{"Type":2160,"Flags":0}}}},{"2":{"Name":"AggregationSortConfiguration","Properties":{"AggregationFunction":{"Type":1831,"Flags":0},"Column":{"Type":1899,"Flags":1},"SortDirection":{"Type":4,"Flags":1}}}},{"2":{"Name":"AllSheetsFilterScopeConfiguration","Properties":{}}},{"2":{"Name":"AnalysisDefaults","Properties":{"DefaultNewSheetConfiguration":{"Type":1974,"Flags":1}}}},{"2":{"Name":"AnchorDateConfiguration","Properties":{"AnchorOption":{"Type":4,"Flags":0},"ParameterName":{"Type":4,"Flags":0}}}},{"2":{"Name":"AnchorOption"}},{"2":{"Name":"ArcAxisConfiguration","Properties":{"Range":{"Type":1838,"Flags":0},"ReserveRange":{"Type":3,"Flags":0}}}},{"2":{"Name":"ArcAxisDisplayRange","Properties":{"Max":{"Type":3,"Flags":0},"Min":{"Type":3,"Flags":0}}}},{"2":{"Name":"ArcConfiguration","Properties":{"ArcAngle":{"Type":3,"Flags":0},"ArcThickness":{"Type":4,"Flags":0}}}},{"2":{"Name":"ArcOptions","Properties":{"ArcThickness":{"Type":4,"Flags":0}}}},{"2":{"Name":"ArcThickness"}},{"2":{"Name":"ArcThicknessOptions"}},{"2":{"Name":"AssetOptions","Properties":{"Timezone":{"Type":4,"Flags":0},"WeekStart":{"Type":4,"Flags":0}}}},{"2":{"Name":"AttributeAggregationFunction","Properties":{"SimpleAttributeAggregation":{"Type":4,"Flags":0},"ValueForMultipleValues":{"Type":4,"Flags":0}}}},{"2":{"Name":"AxisBinding"}},{"2":{"Name":"AxisDataOptions","Properties":{"DateAxisOptions":{"Type":1957,"Flags":0},"NumericAxisOptions":{"Type":2150,"Flags":0}}}},{"2":{"Name":"AxisDisplayDataDrivenRange","Properties":{}}},{"2":{"Name":"AxisDisplayMinMaxRange","Properties":{"Maximum":{"Type":3,"Flags":0},"Minimum":{"Type":3,"Flags":0}}}},{"2":{"Name":"AxisDisplayOptions","Properties":{"AxisLineVisibility":{"Type":4,"Flags":0},"AxisOffset":{"Type":4,"Flags":0,"Description":"String based length that is composed of value and unit in px"},"DataOptions":{"Type":1846,"Flags":0},"GridLineVisibility":{"Type":4,"Flags":0},"ScrollbarOptions":{"Type":2264,"Flags":0},"TickLabelOptions":{"Type":1856,"Flags":0}}}},{"2":{"Name":"AxisDisplayRange","Properties":{"DataDriven":{"Type":1847,"Flags":0},"MinMax":{"Type":1848,"Flags":0}}}},{"2":{"Name":"AxisLabelOptions","Properties":{"ApplyTo":{"Type":1852,"Flags":0},"CustomLabel":{"Type":4,"Flags":0},"FontConfiguration":{"Type":2019,"Flags":0}}}},{"2":{"Name":"AxisLabelReferenceOptions","Properties":{"Column":{"Type":1899,"Flags":1},"FieldId":{"Type":4,"Flags":1}}}},{"2":{"Name":"AxisLinearScale","Properties":{"StepCount":{"Type":3,"Flags":0},"StepSize":{"Type":3,"Flags":0}}}},{"2":{"Name":"AxisLogarithmicScale","Properties":{"Base":{"Type":3,"Flags":0}}}},{"2":{"Name":"AxisScale","Properties":{"Linear":{"Type":1853,"Flags":0},"Logarithmic":{"Type":1854,"Flags":0}}}},{"2":{"Name":"AxisTickLabelOptions","Properties":{"LabelOptions":{"Type":2108,"Flags":0},"RotationAngle":{"Type":3,"Flags":0}}}},{"2":{"Name":"BarChartAggregatedFieldWells","Properties":{"Category":{"Type":2421,"Flags":0},"Colors":{"Type":2422,"Flags":0},"SmallMultiples":{"Type":2423,"Flags":0},"Values":{"Type":2424,"Flags":0}}}},{"2":{"Name":"BarChartConfiguration","Properties":{"BarsArrangement":{"Type":4,"Flags":0},"CategoryAxis":{"Type":1849,"Flags":0},"CategoryLabelOptions":{"Type":1889,"Flags":0},"ColorLabelOptions":{"Type":1889,"Flags":0},"ContributionAnalysisDefaults":{"Type":2425,"Flags":0},"DataLabels":{"Type":1944,"Flags":0},"FieldWells":{"Type":1859,"Flags":0},"Legend":{"Type":2112,"Flags":0},"Orientation":{"Type":4,"Flags":0},"ReferenceLines":{"Type":2426,"Flags":0},"SmallMultiplesOptions":{"Type":2303,"Flags":0},"SortConfiguration":{"Type":1861,"Flags":0},"Tooltip":{"Type":2368,"Flags":0},"ValueAxis":{"Type":1849,"Flags":0},"ValueLabelOptions":{"Type":1889,"Flags":0},"VisualPalette":{"Type":2398,"Flags":0}}}},{"2":{"Name":"BarChartFieldWells","Properties":{"BarChartAggregatedFieldWells":{"Type":1857,"Flags":0}}}},{"2":{"Name":"BarChartOrientation"}},{"2":{"Name":"BarChartSortConfiguration","Properties":{"CategoryItemsLimit":{"Type":2091,"Flags":0},"CategorySort":{"Type":2427,"Flags":0},"ColorItemsLimit":{"Type":2091,"Flags":0},"ColorSort":{"Type":2428,"Flags":0},"SmallMultiplesLimitConfiguration":{"Type":2091,"Flags":0},"SmallMultiplesSort":{"Type":2429,"Flags":0}}}},{"2":{"Name":"BarChartVisual","Properties":{"Actions":{"Type":2430,"Flags":0},"ChartConfiguration":{"Type":1858,"Flags":0},"ColumnHierarchies":{"Type":2431,"Flags":0},"Subtitle":{"Type":2399,"Flags":0},"Title":{"Type":2400,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"BarsArrangement"}},{"2":{"Name":"BaseMapStyleType"}},{"2":{"Name":"BinCountOptions","Properties":{"Value":{"Type":3,"Flags":0}}}},{"2":{"Name":"BinWidthOptions","Properties":{"BinCountLimit":{"Type":3,"Flags":0},"Value":{"Type":3,"Flags":0}}}},{"2":{"Name":"BodySectionConfiguration","Properties":{"Content":{"Type":1868,"Flags":1},"PageBreakConfiguration":{"Type":2271,"Flags":0},"SectionId":{"Type":4,"Flags":1},"Style":{"Type":2273,"Flags":0}}}},{"2":{"Name":"BodySectionContent","Properties":{"Layout":{"Type":2270,"Flags":0}}}},{"2":{"Name":"BoxPlotAggregatedFieldWells","Properties":{"GroupBy":{"Type":2432,"Flags":0},"Values":{"Type":2433,"Flags":0}}}},{"2":{"Name":"BoxPlotChartConfiguration","Properties":{"BoxPlotOptions":{"Type":1873,"Flags":0},"CategoryAxis":{"Type":1849,"Flags":0},"CategoryLabelOptions":{"Type":1889,"Flags":0},"FieldWells":{"Type":1871,"Flags":0},"Legend":{"Type":2112,"Flags":0},"PrimaryYAxisDisplayOptions":{"Type":1849,"Flags":0},"PrimaryYAxisLabelOptions":{"Type":1889,"Flags":0},"ReferenceLines":{"Type":2434,"Flags":0},"SortConfiguration":{"Type":1874,"Flags":0},"Tooltip":{"Type":2368,"Flags":0},"VisualPalette":{"Type":2398,"Flags":0}}}},{"2":{"Name":"BoxPlotFieldWells","Properties":{"BoxPlotAggregatedFieldWells":{"Type":1869,"Flags":0}}}},{"2":{"Name":"BoxPlotFillStyle"}},{"2":{"Name":"BoxPlotOptions","Properties":{"AllDataPointsVisibility":{"Type":4,"Flags":0},"OutlierVisibility":{"Type":4,"Flags":0},"StyleOptions":{"Type":1875,"Flags":0}}}},{"2":{"Name":"BoxPlotSortConfiguration","Properties":{"CategorySort":{"Type":2435,"Flags":0},"PaginationConfiguration":{"Type":2164,"Flags":0}}}},{"2":{"Name":"BoxPlotStyleOptions","Properties":{"FillStyle":{"Type":4,"Flags":0}}}},{"2":{"Name":"BoxPlotVisual","Properties":{"Actions":{"Type":2436,"Flags":0},"ChartConfiguration":{"Type":1870,"Flags":0},"ColumnHierarchies":{"Type":2437,"Flags":0},"Subtitle":{"Type":2399,"Flags":0},"Title":{"Type":2400,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"CalculatedField","Properties":{"DataSetIdentifier":{"Type":4,"Flags":1},"Expression":{"Type":4,"Flags":1},"Name":{"Type":4,"Flags":1}}}},{"2":{"Name":"CalculatedMeasureField","Properties":{"Expression":{"Type":4,"Flags":1},"FieldId":{"Type":4,"Flags":1}}}},{"2":{"Name":"CascadingControlConfiguration","Properties":{"SourceControls":{"Type":2438,"Flags":0}}}},{"2":{"Name":"CascadingControlSource","Properties":{"ColumnToMatch":{"Type":1899,"Flags":0},"SourceSheetControlId":{"Type":4,"Flags":0}}}},{"2":{"Name":"CategoricalAggregationFunction"}},{"2":{"Name":"CategoricalDimensionField","Properties":{"Column":{"Type":1899,"Flags":1},"FieldId":{"Type":4,"Flags":1},"FormatConfiguration":{"Type":2308,"Flags":0},"HierarchyId":{"Type":4,"Flags":0}}}},{"2":{"Name":"CategoricalMeasureField","Properties":{"AggregationFunction":{"Type":4,"Flags":0},"Column":{"Type":1899,"Flags":1},"FieldId":{"Type":4,"Flags":1},"FormatConfiguration":{"Type":2308,"Flags":0}}}},{"2":{"Name":"CategoryDrillDownFilter","Properties":{"CategoryValues":{"Type":2439,"Flags":1},"Column":{"Type":1899,"Flags":1}}}},{"2":{"Name":"CategoryFilter","Properties":{"Column":{"Type":1899,"Flags":1},"Configuration":{"Type":1886,"Flags":1},"FilterId":{"Type":4,"Flags":1}}}},{"2":{"Name":"CategoryFilterConfiguration","Properties":{"CustomFilterConfiguration":{"Type":1935,"Flags":0},"CustomFilterListConfiguration":{"Type":1936,"Flags":0},"FilterListConfiguration":{"Type":2007,"Flags":0}}}},{"2":{"Name":"CategoryFilterMatchOperator"}},{"2":{"Name":"CategoryFilterSelectAllOptions"}},{"2":{"Name":"ChartAxisLabelOptions","Properties":{"AxisLabelOptions":{"Type":2440,"Flags":0},"SortIconVisibility":{"Type":4,"Flags":0},"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"ClusterMarker","Properties":{"SimpleClusterMarker":{"Type":2296,"Flags":0}}}},{"2":{"Name":"ClusterMarkerConfiguration","Properties":{"ClusterMarker":{"Type":1890,"Flags":0}}}},{"2":{"Name":"ColorFillType"}},{"2":{"Name":"ColorScale","Properties":{"ColorFillType":{"Type":4,"Flags":1},"Colors":{"Type":2441,"Flags":1},"NullValueColor":{"Type":1941,"Flags":0}}}},{"2":{"Name":"ColorsConfiguration","Properties":{"CustomColors":{"Type":2442,"Flags":0}}}},{"2":{"Name":"ColumnConfiguration","Properties":{"ColorsConfiguration":{"Type":1894,"Flags":0},"Column":{"Type":1899,"Flags":1},"FormatConfiguration":{"Type":2029,"Flags":0},"Role":{"Type":4,"Flags":0}}}},{"2":{"Name":"ColumnGroupColumnSchema","Properties":{"Name":{"Type":4,"Flags":0}}}},{"2":{"Name":"ColumnGroupSchema","Properties":{"ColumnGroupColumnSchemaList":{"Type":2443,"Flags":0},"Name":{"Type":4,"Flags":0}}}},{"2":{"Name":"ColumnHierarchy","Properties":{"DateTimeHierarchy":{"Type":1962,"Flags":0},"ExplicitHierarchy":{"Type":1987,"Flags":0},"PredefinedHierarchy":{"Type":2218,"Flags":0}}}},{"2":{"Name":"ColumnIdentifier","Properties":{"ColumnName":{"Type":4,"Flags":1},"DataSetIdentifier":{"Type":4,"Flags":1}}}},{"2":{"Name":"ColumnRole"}},{"2":{"Name":"ColumnSchema","Properties":{"DataType":{"Type":4,"Flags":0},"GeographicRole":{"Type":4,"Flags":0},"Name":{"Type":4,"Flags":0}}}},{"2":{"Name":"ColumnSort","Properties":{"AggregationFunction":{"Type":1831,"Flags":0},"Direction":{"Type":4,"Flags":1},"SortBy":{"Type":1899,"Flags":1}}}},{"2":{"Name":"ColumnTooltipItem","Properties":{"Aggregation":{"Type":1831,"Flags":0},"Column":{"Type":1899,"Flags":1},"Label":{"Type":4,"Flags":0},"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"ComboChartAggregatedFieldWells","Properties":{"BarValues":{"Type":2444,"Flags":0},"Category":{"Type":2445,"Flags":0},"Colors":{"Type":2446,"Flags":0},"LineValues":{"Type":2447,"Flags":0}}}},{"2":{"Name":"ComboChartConfiguration","Properties":{"BarDataLabels":{"Type":1944,"Flags":0},"BarsArrangement":{"Type":4,"Flags":0},"CategoryAxis":{"Type":1849,"Flags":0},"CategoryLabelOptions":{"Type":1889,"Flags":0},"ColorLabelOptions":{"Type":1889,"Flags":0},"FieldWells":{"Type":1906,"Flags":0},"Legend":{"Type":2112,"Flags":0},"LineDataLabels":{"Type":1944,"Flags":0},"PrimaryYAxisDisplayOptions":{"Type":1849,"Flags":0},"PrimaryYAxisLabelOptions":{"Type":1889,"Flags":0},"ReferenceLines":{"Type":2448,"Flags":0},"SecondaryYAxisDisplayOptions":{"Type":1849,"Flags":0},"SecondaryYAxisLabelOptions":{"Type":1889,"Flags":0},"SortConfiguration":{"Type":1907,"Flags":0},"Tooltip":{"Type":2368,"Flags":0},"VisualPalette":{"Type":2398,"Flags":0}}}},{"2":{"Name":"ComboChartFieldWells","Properties":{"ComboChartAggregatedFieldWells":{"Type":1904,"Flags":0}}}},{"2":{"Name":"ComboChartSortConfiguration","Properties":{"CategoryItemsLimit":{"Type":2091,"Flags":0},"CategorySort":{"Type":2449,"Flags":0},"ColorItemsLimit":{"Type":2091,"Flags":0},"ColorSort":{"Type":2450,"Flags":0}}}},{"2":{"Name":"ComboChartVisual","Properties":{"Actions":{"Type":2451,"Flags":0},"ChartConfiguration":{"Type":1905,"Flags":0},"ColumnHierarchies":{"Type":2452,"Flags":0},"Subtitle":{"Type":2399,"Flags":0},"Title":{"Type":2400,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"ComparisonConfiguration","Properties":{"ComparisonFormat":{"Type":1910,"Flags":0},"ComparisonMethod":{"Type":4,"Flags":0}}}},{"2":{"Name":"ComparisonFormatConfiguration","Properties":{"NumberDisplayFormatConfiguration":{"Type":2147,"Flags":0},"PercentageDisplayFormatConfiguration":{"Type":2181,"Flags":0}}}},{"2":{"Name":"ComparisonMethod"}},{"2":{"Name":"Computation","Properties":{"Forecast":{"Type":2025,"Flags":0},"GrowthRate":{"Type":2071,"Flags":0},"MaximumMinimum":{"Type":2137,"Flags":0},"MetricComparison":{"Type":2140,"Flags":0},"PeriodOverPeriod":{"Type":2183,"Flags":0},"PeriodToDate":{"Type":2184,"Flags":0},"TopBottomMovers":{"Type":2372,"Flags":0},"TopBottomRanked":{"Type":2373,"Flags":0},"TotalAggregation":{"Type":2375,"Flags":0},"UniqueValues":{"Type":2387,"Flags":0}}}},{"2":{"Name":"ConditionalFormattingColor","Properties":{"Gradient":{"Type":1916,"Flags":0},"Solid":{"Type":1922,"Flags":0}}}},{"2":{"Name":"ConditionalFormattingCustomIconCondition","Properties":{"Color":{"Type":4,"Flags":0},"DisplayConfiguration":{"Type":1918,"Flags":0},"Expression":{"Type":4,"Flags":1},"IconOptions":{"Type":1915,"Flags":1}}}},{"2":{"Name":"ConditionalFormattingCustomIconOptions","Properties":{"Icon":{"Type":4,"Flags":0},"UnicodeIcon":{"Type":4,"Flags":0}}}},{"2":{"Name":"ConditionalFormattingGradientColor","Properties":{"Color":{"Type":2065,"Flags":1},"Expression":{"Type":4,"Flags":1}}}},{"2":{"Name":"ConditionalFormattingIcon","Properties":{"CustomCondition":{"Type":1914,"Flags":0},"IconSet":{"Type":1920,"Flags":0}}}},{"2":{"Name":"ConditionalFormattingIconDisplayConfiguration","Properties":{"IconDisplayOption":{"Type":4,"Flags":0}}}},{"2":{"Name":"ConditionalFormattingIconDisplayOption"}},{"2":{"Name":"ConditionalFormattingIconSet","Properties":{"Expression":{"Type":4,"Flags":1},"IconSetType":{"Type":4,"Flags":0}}}},{"2":{"Name":"ConditionalFormattingIconSetType"}},{"2":{"Name":"ConditionalFormattingSolidColor","Properties":{"Color":{"Type":4,"Flags":0},"Expression":{"Type":4,"Flags":1}}}},{"2":{"Name":"ContributionAnalysisDefault","Properties":{"ContributorDimensions":{"Type":2453,"Flags":1},"MeasureFieldId":{"Type":4,"Flags":1}}}},{"2":{"Name":"CrossDatasetTypes"}},{"2":{"Name":"CurrencyDisplayFormatConfiguration","Properties":{"DecimalPlacesConfiguration":{"Type":1969,"Flags":0},"NegativeValueConfiguration":{"Type":2144,"Flags":0},"NullValueFormatConfiguration":{"Type":2146,"Flags":0},"NumberScale":{"Type":4,"Flags":0},"Prefix":{"Type":4,"Flags":0},"SeparatorConfiguration":{"Type":2158,"Flags":0},"Suffix":{"Type":4,"Flags":0},"Symbol":{"Type":4,"Flags":0}}}},{"2":{"Name":"CustomActionFilterOperation","Properties":{"SelectedFieldsConfiguration":{"Type":2010,"Flags":1},"TargetVisualsConfiguration":{"Type":2011,"Flags":1}}}},{"2":{"Name":"CustomActionNavigationOperation","Properties":{"LocalNavigationConfiguration":{"Type":2132,"Flags":0}}}},{"2":{"Name":"CustomActionSetParametersOperation","Properties":{"ParameterValueConfigurations":{"Type":2454,"Flags":1}}}},{"2":{"Name":"CustomActionURLOperation","Properties":{"URLTarget":{"Type":4,"Flags":1},"URLTemplate":{"Type":4,"Flags":1}}}},{"2":{"Name":"CustomColor","Properties":{"Color":{"Type":4,"Flags":1},"FieldValue":{"Type":4,"Flags":0},"SpecialValue":{"Type":4,"Flags":0}}}},{"2":{"Name":"CustomContentConfiguration","Properties":{"ContentType":{"Type":4,"Flags":0},"ContentUrl":{"Type":4,"Flags":0},"ImageScaling":{"Type":4,"Flags":0}}}},{"2":{"Name":"CustomContentImageScalingConfiguration"}},{"2":{"Name":"CustomContentType"}},{"2":{"Name":"CustomContentVisual","Properties":{"Actions":{"Type":2455,"Flags":0},"ChartConfiguration":{"Type":1931,"Flags":0},"DataSetIdentifier":{"Type":4,"Flags":1},"Subtitle":{"Type":2399,"Flags":0},"Title":{"Type":2400,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"CustomFilterConfiguration","Properties":{"CategoryValue":{"Type":4,"Flags":0},"MatchOperator":{"Type":4,"Flags":1},"NullOption":{"Type":4,"Flags":1},"ParameterName":{"Type":4,"Flags":0},"SelectAllOptions":{"Type":4,"Flags":0}}}},{"2":{"Name":"CustomFilterListConfiguration","Properties":{"CategoryValues":{"Type":2456,"Flags":0},"MatchOperator":{"Type":4,"Flags":1},"NullOption":{"Type":4,"Flags":1},"SelectAllOptions":{"Type":4,"Flags":0}}}},{"2":{"Name":"CustomNarrativeOptions","Properties":{"Narrative":{"Type":4,"Flags":1}}}},{"2":{"Name":"CustomParameterValues","Properties":{"DateTimeValues":{"Type":2457,"Flags":0},"DecimalValues":{"Type":2458,"Flags":0},"IntegerValues":{"Type":2459,"Flags":0},"StringValues":{"Type":2460,"Flags":0}}}},{"2":{"Name":"CustomValuesConfiguration","Properties":{"CustomValues":{"Type":1938,"Flags":1},"IncludeNullValue":{"Type":2,"Flags":0}}}},{"2":{"Name":"DataBarsOptions","Properties":{"FieldId":{"Type":4,"Flags":1},"NegativeColor":{"Type":4,"Flags":0},"PositiveColor":{"Type":4,"Flags":0}}}},{"2":{"Name":"DataColor","Properties":{"Color":{"Type":4,"Flags":0},"DataValue":{"Type":3,"Flags":0}}}},{"2":{"Name":"DataFieldSeriesItem","Properties":{"AxisBinding":{"Type":4,"Flags":1},"FieldId":{"Type":4,"Flags":1},"FieldValue":{"Type":4,"Flags":0},"Settings":{"Type":2122,"Flags":0}}}},{"2":{"Name":"DataLabelContent"}},{"2":{"Name":"DataLabelOptions","Properties":{"CategoryLabelVisibility":{"Type":4,"Flags":0},"DataLabelTypes":{"Type":2461,"Flags":0},"LabelColor":{"Type":4,"Flags":0},"LabelContent":{"Type":4,"Flags":0},"LabelFontConfiguration":{"Type":2019,"Flags":0},"MeasureLabelVisibility":{"Type":4,"Flags":0},"Overlap":{"Type":4,"Flags":0},"Position":{"Type":4,"Flags":0},"TotalsVisibility":{"Type":4,"Flags":0},"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"DataLabelOverlap"}},{"2":{"Name":"DataLabelPosition"}},{"2":{"Name":"DataLabelType","Properties":{"DataPathLabelType":{"Type":1949,"Flags":0},"FieldLabelType":{"Type":1989,"Flags":0},"MaximumLabelType":{"Type":2136,"Flags":0},"MinimumLabelType":{"Type":2141,"Flags":0},"RangeEndsLabelType":{"Type":2230,"Flags":0}}}},{"2":{"Name":"DataPathColor","Properties":{"Color":{"Type":4,"Flags":1},"Element":{"Type":1952,"Flags":1},"TimeGranularity":{"Type":4,"Flags":0}}}},{"2":{"Name":"DataPathLabelType","Properties":{"FieldId":{"Type":4,"Flags":0},"FieldValue":{"Type":4,"Flags":0},"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"DataPathSort","Properties":{"Direction":{"Type":4,"Flags":1},"SortPaths":{"Type":2462,"Flags":1}}}},{"2":{"Name":"DataPathType","Properties":{"PivotTableDataPathType":{"Type":4,"Flags":0}}}},{"2":{"Name":"DataPathValue","Properties":{"DataPathType":{"Type":1951,"Flags":0},"FieldId":{"Type":4,"Flags":0},"FieldValue":{"Type":4,"Flags":0}}}},{"2":{"Name":"DataSetConfiguration","Properties":{"ColumnGroupSchemaList":{"Type":2463,"Flags":0},"DataSetSchema":{"Type":1955,"Flags":0},"Placeholder":{"Type":4,"Flags":0}}}},{"2":{"Name":"DataSetReference","Properties":{"DataSetArn":{"Type":4,"Flags":1},"DataSetPlaceholder":{"Type":4,"Flags":1}}}},{"2":{"Name":"DataSetSchema","Properties":{"ColumnSchemaList":{"Type":2464,"Flags":0}}}},{"2":{"Name":"DateAggregationFunction"}},{"2":{"Name":"DateAxisOptions","Properties":{"MissingDateVisibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"DateDimensionField","Properties":{"Column":{"Type":1899,"Flags":1},"DateGranularity":{"Type":4,"Flags":0},"FieldId":{"Type":4,"Flags":1},"FormatConfiguration":{"Type":1961,"Flags":0},"HierarchyId":{"Type":4,"Flags":0}}}},{"2":{"Name":"DateMeasureField","Properties":{"AggregationFunction":{"Type":4,"Flags":0},"Column":{"Type":1899,"Flags":1},"FieldId":{"Type":4,"Flags":1},"FormatConfiguration":{"Type":1961,"Flags":0}}}},{"2":{"Name":"DateTimeDefaultValues","Properties":{"DynamicValue":{"Type":1983,"Flags":0},"RollingDate":{"Type":2251,"Flags":0},"StaticValues":{"Type":2465,"Flags":0}}}},{"2":{"Name":"DateTimeFormatConfiguration","Properties":{"DateTimeFormat":{"Type":4,"Flags":0},"NullValueFormatConfiguration":{"Type":2146,"Flags":0},"NumericFormatConfiguration":{"Type":2155,"Flags":0}}}},{"2":{"Name":"DateTimeHierarchy","Properties":{"DrillDownFilters":{"Type":2466,"Flags":0},"HierarchyId":{"Type":4,"Flags":1}}}},{"2":{"Name":"DateTimeParameterDeclaration","Properties":{"DefaultValues":{"Type":1960,"Flags":0},"MappedDataSetParameters":{"Type":2467,"Flags":0},"Name":{"Type":4,"Flags":1},"TimeGranularity":{"Type":4,"Flags":0},"ValueWhenUnset":{"Type":1965,"Flags":0}}}},{"2":{"Name":"DateTimePickerControlDisplayOptions","Properties":{"DateTimeFormat":{"Type":4,"Flags":0},"InfoIconLabelOptions":{"Type":2284,"Flags":0},"TitleOptions":{"Type":2108,"Flags":0}}}},{"2":{"Name":"DateTimeValueWhenUnsetConfiguration","Properties":{"CustomValue":{"Type":4,"Flags":0},"ValueWhenUnsetOption":{"Type":4,"Flags":0}}}},{"2":{"Name":"DayOfTheWeek"}},{"2":{"Name":"DecimalDefaultValues","Properties":{"DynamicValue":{"Type":1983,"Flags":0},"StaticValues":{"Type":2468,"Flags":0}}}},{"2":{"Name":"DecimalParameterDeclaration","Properties":{"DefaultValues":{"Type":1967,"Flags":0},"MappedDataSetParameters":{"Type":2469,"Flags":0},"Name":{"Type":4,"Flags":1},"ParameterValueType":{"Type":4,"Flags":1},"ValueWhenUnset":{"Type":1970,"Flags":0}}}},{"2":{"Name":"DecimalPlacesConfiguration","Properties":{"DecimalPlaces":{"Type":3,"Flags":1}}}},{"2":{"Name":"DecimalValueWhenUnsetConfiguration","Properties":{"CustomValue":{"Type":3,"Flags":0},"ValueWhenUnsetOption":{"Type":4,"Flags":0}}}},{"2":{"Name":"DefaultFreeFormLayoutConfiguration","Properties":{"CanvasSizeOptions":{"Type":2030,"Flags":1}}}},{"2":{"Name":"DefaultGridLayoutConfiguration","Properties":{"CanvasSizeOptions":{"Type":2067,"Flags":1}}}},{"2":{"Name":"DefaultInteractiveLayoutConfiguration","Properties":{"FreeForm":{"Type":1971,"Flags":0},"Grid":{"Type":1972,"Flags":0}}}},{"2":{"Name":"DefaultNewSheetConfiguration","Properties":{"InteractiveLayoutConfiguration":{"Type":1973,"Flags":0},"PaginatedLayoutConfiguration":{"Type":1975,"Flags":0},"SheetContentType":{"Type":4,"Flags":0}}}},{"2":{"Name":"DefaultPaginatedLayoutConfiguration","Properties":{"SectionBased":{"Type":1976,"Flags":0}}}},{"2":{"Name":"DefaultSectionBasedLayoutConfiguration","Properties":{"CanvasSizeOptions":{"Type":2267,"Flags":1}}}},{"2":{"Name":"DestinationParameterValueConfiguration","Properties":{"CustomValuesConfiguration":{"Type":1939,"Flags":0},"SelectAllValueOptions":{"Type":4,"Flags":0},"SourceColumn":{"Type":1899,"Flags":0},"SourceField":{"Type":4,"Flags":0},"SourceParameterName":{"Type":4,"Flags":0}}}},{"2":{"Name":"DimensionField","Properties":{"CategoricalDimensionField":{"Type":1882,"Flags":0},"DateDimensionField":{"Type":1958,"Flags":0},"NumericalDimensionField":{"Type":2161,"Flags":0}}}},{"2":{"Name":"DonutCenterOptions","Properties":{"LabelVisibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"DonutOptions","Properties":{"ArcOptions":{"Type":1840,"Flags":0},"DonutCenterOptions":{"Type":1979,"Flags":0}}}},{"2":{"Name":"DrillDownFilter","Properties":{"CategoryFilter":{"Type":1884,"Flags":0},"NumericEqualityFilter":{"Type":2151,"Flags":0},"TimeRangeFilter":{"Type":2364,"Flags":0}}}},{"2":{"Name":"DropDownControlDisplayOptions","Properties":{"InfoIconLabelOptions":{"Type":2284,"Flags":0},"SelectAllOptions":{"Type":2130,"Flags":0},"TitleOptions":{"Type":2108,"Flags":0}}}},{"2":{"Name":"DynamicDefaultValue","Properties":{"DefaultValueColumn":{"Type":1899,"Flags":1},"GroupNameColumn":{"Type":1899,"Flags":0},"UserNameColumn":{"Type":1899,"Flags":0}}}},{"2":{"Name":"EmptyVisual","Properties":{"Actions":{"Type":2470,"Flags":0},"DataSetIdentifier":{"Type":4,"Flags":1},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"Entity","Properties":{"Path":{"Type":4,"Flags":0}}}},{"2":{"Name":"ExcludePeriodConfiguration","Properties":{"Amount":{"Type":3,"Flags":1},"Granularity":{"Type":4,"Flags":1},"Status":{"Type":4,"Flags":0}}}},{"2":{"Name":"ExplicitHierarchy","Properties":{"Columns":{"Type":2471,"Flags":1},"DrillDownFilters":{"Type":2472,"Flags":0},"HierarchyId":{"Type":4,"Flags":1}}}},{"2":{"Name":"FieldBasedTooltip","Properties":{"AggregationVisibility":{"Type":4,"Flags":0},"TooltipFields":{"Type":2473,"Flags":0},"TooltipTitleType":{"Type":4,"Flags":0}}}},{"2":{"Name":"FieldLabelType","Properties":{"FieldId":{"Type":4,"Flags":0},"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"FieldSeriesItem","Properties":{"AxisBinding":{"Type":4,"Flags":1},"FieldId":{"Type":4,"Flags":1},"Settings":{"Type":2122,"Flags":0}}}},{"2":{"Name":"FieldSort","Properties":{"Direction":{"Type":4,"Flags":1},"FieldId":{"Type":4,"Flags":1}}}},{"2":{"Name":"FieldSortOptions","Properties":{"ColumnSort":{"Type":1902,"Flags":0},"FieldSort":{"Type":1991,"Flags":0}}}},{"2":{"Name":"FieldTooltipItem","Properties":{"FieldId":{"Type":4,"Flags":1},"Label":{"Type":4,"Flags":0},"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"FilledMapAggregatedFieldWells","Properties":{"Geospatial":{"Type":2474,"Flags":0},"Values":{"Type":2475,"Flags":0}}}},{"2":{"Name":"FilledMapConditionalFormatting","Properties":{"ConditionalFormattingOptions":{"Type":2476,"Flags":1}}}},{"2":{"Name":"FilledMapConditionalFormattingOption","Properties":{"Shape":{"Type":1999,"Flags":1}}}},{"2":{"Name":"FilledMapConfiguration","Properties":{"FieldWells":{"Type":1998,"Flags":0},"Legend":{"Type":2112,"Flags":0},"MapStyleOptions":{"Type":2059,"Flags":0},"SortConfiguration":{"Type":2000,"Flags":0},"Tooltip":{"Type":2368,"Flags":0},"WindowOptions":{"Type":2063,"Flags":0}}}},{"2":{"Name":"FilledMapFieldWells","Properties":{"FilledMapAggregatedFieldWells":{"Type":1994,"Flags":0}}}},{"2":{"Name":"FilledMapShapeConditionalFormatting","Properties":{"FieldId":{"Type":4,"Flags":1},"Format":{"Type":2280,"Flags":0}}}},{"2":{"Name":"FilledMapSortConfiguration","Properties":{"CategorySort":{"Type":2477,"Flags":0}}}},{"2":{"Name":"FilledMapVisual","Properties":{"Actions":{"Type":2478,"Flags":0},"ChartConfiguration":{"Type":1997,"Flags":0},"ColumnHierarchies":{"Type":2479,"Flags":0},"ConditionalFormatting":{"Type":1995,"Flags":0},"Subtitle":{"Type":2399,"Flags":0},"Title":{"Type":2400,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"Filter","Properties":{"CategoryFilter":{"Type":1885,"Flags":0},"NumericEqualityFilter":{"Type":2152,"Flags":0},"NumericRangeFilter":{"Type":2156,"Flags":0},"RelativeDatesFilter":{"Type":2246,"Flags":0},"TimeEqualityFilter":{"Type":2362,"Flags":0},"TimeRangeFilter":{"Type":2365,"Flags":0},"TopBottomFilter":{"Type":2371,"Flags":0}}}},{"2":{"Name":"FilterControl","Properties":{"DateTimePicker":{"Type":2004,"Flags":0},"Dropdown":{"Type":2005,"Flags":0},"List":{"Type":2008,"Flags":0},"RelativeDateTime":{"Type":2012,"Flags":0},"Slider":{"Type":2015,"Flags":0},"TextArea":{"Type":2016,"Flags":0},"TextField":{"Type":2017,"Flags":0}}}},{"2":{"Name":"FilterDateTimePickerControl","Properties":{"DisplayOptions":{"Type":1964,"Flags":0},"FilterControlId":{"Type":4,"Flags":1},"SourceFilterId":{"Type":4,"Flags":1},"Title":{"Type":4,"Flags":1},"Type":{"Type":4,"Flags":0}}}},{"2":{"Name":"FilterDropDownControl","Properties":{"CascadingControlConfiguration":{"Type":1879,"Flags":0},"DisplayOptions":{"Type":1982,"Flags":0},"FilterControlId":{"Type":4,"Flags":1},"SelectableValues":{"Type":2014,"Flags":0},"SourceFilterId":{"Type":4,"Flags":1},"Title":{"Type":4,"Flags":1},"Type":{"Type":4,"Flags":0}}}},{"2":{"Name":"FilterGroup","Properties":{"CrossDataset":{"Type":4,"Flags":1},"FilterGroupId":{"Type":4,"Flags":1},"Filters":{"Type":2480,"Flags":1},"ScopeConfiguration":{"Type":2013,"Flags":1},"Status":{"Type":4,"Flags":0}}}},{"2":{"Name":"FilterListConfiguration","Properties":{"CategoryValues":{"Type":2481,"Flags":0},"MatchOperator":{"Type":4,"Flags":1},"NullOption":{"Type":4,"Flags":0},"SelectAllOptions":{"Type":4,"Flags":0}}}},{"2":{"Name":"FilterListControl","Properties":{"CascadingControlConfiguration":{"Type":1879,"Flags":0},"DisplayOptions":{"Type":2128,"Flags":0},"FilterControlId":{"Type":4,"Flags":1},"SelectableValues":{"Type":2014,"Flags":0},"SourceFilterId":{"Type":4,"Flags":1},"Title":{"Type":4,"Flags":1},"Type":{"Type":4,"Flags":0}}}},{"2":{"Name":"FilterNullOption"}},{"2":{"Name":"FilterOperationSelectedFieldsConfiguration","Properties":{"SelectedColumns":{"Type":2482,"Flags":0},"SelectedFieldOptions":{"Type":4,"Flags":0},"SelectedFields":{"Type":2483,"Flags":0}}}},{"2":{"Name":"FilterOperationTargetVisualsConfiguration","Properties":{"SameSheetTargetVisualConfiguration":{"Type":2253,"Flags":0}}}},{"2":{"Name":"FilterRelativeDateTimeControl","Properties":{"DisplayOptions":{"Type":2244,"Flags":0},"FilterControlId":{"Type":4,"Flags":1},"SourceFilterId":{"Type":4,"Flags":1},"Title":{"Type":4,"Flags":1}}}},{"2":{"Name":"FilterScopeConfiguration","Properties":{"AllSheets":{"Type":1833,"Flags":0},"SelectedSheets":{"Type":2276,"Flags":0}}}},{"2":{"Name":"FilterSelectableValues","Properties":{"Values":{"Type":2484,"Flags":0}}}},{"2":{"Name":"FilterSliderControl","Properties":{"DisplayOptions":{"Type":2299,"Flags":0},"FilterControlId":{"Type":4,"Flags":1},"MaximumValue":{"Type":3,"Flags":1},"MinimumValue":{"Type":3,"Flags":1},"SourceFilterId":{"Type":4,"Flags":1},"StepSize":{"Type":3,"Flags":1},"Title":{"Type":4,"Flags":1},"Type":{"Type":4,"Flags":0}}}},{"2":{"Name":"FilterTextAreaControl","Properties":{"Delimiter":{"Type":4,"Flags":0},"DisplayOptions":{"Type":2355,"Flags":0},"FilterControlId":{"Type":4,"Flags":1},"SourceFilterId":{"Type":4,"Flags":1},"Title":{"Type":4,"Flags":1}}}},{"2":{"Name":"FilterTextFieldControl","Properties":{"DisplayOptions":{"Type":2358,"Flags":0},"FilterControlId":{"Type":4,"Flags":1},"SourceFilterId":{"Type":4,"Flags":1},"Title":{"Type":4,"Flags":1}}}},{"2":{"Name":"FilterVisualScope"}},{"2":{"Name":"FontConfiguration","Properties":{"FontColor":{"Type":4,"Flags":0},"FontDecoration":{"Type":4,"Flags":0},"FontSize":{"Type":2021,"Flags":0},"FontStyle":{"Type":4,"Flags":0},"FontWeight":{"Type":2023,"Flags":0}}}},{"2":{"Name":"FontDecoration"}},{"2":{"Name":"FontSize","Properties":{"Relative":{"Type":4,"Flags":0}}}},{"2":{"Name":"FontStyle"}},{"2":{"Name":"FontWeight","Properties":{"Name":{"Type":4,"Flags":0}}}},{"2":{"Name":"FontWeightName"}},{"2":{"Name":"ForecastComputation","Properties":{"ComputationId":{"Type":4,"Flags":1},"CustomSeasonalityValue":{"Type":3,"Flags":0},"LowerBoundary":{"Type":3,"Flags":0},"Name":{"Type":4,"Flags":0},"PeriodsBackward":{"Type":3,"Flags":0},"PeriodsForward":{"Type":3,"Flags":0},"PredictionInterval":{"Type":3,"Flags":0},"Seasonality":{"Type":4,"Flags":0},"Time":{"Type":1978,"Flags":0},"UpperBoundary":{"Type":3,"Flags":0},"Value":{"Type":2139,"Flags":0}}}},{"2":{"Name":"ForecastComputationSeasonality"}},{"2":{"Name":"ForecastConfiguration","Properties":{"ForecastProperties":{"Type":2361,"Flags":0},"Scenario":{"Type":2028,"Flags":0}}}},{"2":{"Name":"ForecastScenario","Properties":{"WhatIfPointScenario":{"Type":2407,"Flags":0},"WhatIfRangeScenario":{"Type":2408,"Flags":0}}}},{"2":{"Name":"FormatConfiguration","Properties":{"DateTimeFormatConfiguration":{"Type":1961,"Flags":0},"NumberFormatConfiguration":{"Type":2148,"Flags":0},"StringFormatConfiguration":{"Type":2308,"Flags":0}}}},{"2":{"Name":"FreeFormLayoutCanvasSizeOptions","Properties":{"ScreenCanvasSizeOptions":{"Type":2035,"Flags":0}}}},{"2":{"Name":"FreeFormLayoutConfiguration","Properties":{"CanvasSizeOptions":{"Type":2030,"Flags":0},"Elements":{"Type":2485,"Flags":1}}}},{"2":{"Name":"FreeFormLayoutElement","Properties":{"BackgroundStyle":{"Type":2033,"Flags":0},"BorderStyle":{"Type":2034,"Flags":0},"ElementId":{"Type":4,"Flags":1},"ElementType":{"Type":4,"Flags":1},"Height":{"Type":4,"Flags":1,"Description":"String based length that is composed of value and unit in px"},"LoadingAnimation":{"Type":2131,"Flags":0},"RenderingRules":{"Type":2486,"Flags":0},"SelectedBorderStyle":{"Type":2034,"Flags":0},"Visibility":{"Type":4,"Flags":0},"Width":{"Type":4,"Flags":1,"Description":"String based length that is composed of value and unit in px"},"XAxisLocation":{"Type":4,"Flags":1,"Description":"String based length that is composed of value and unit in px"},"YAxisLocation":{"Type":4,"Flags":1,"Description":"String based length that is composed of value and unit in px with Integer.MAX_VALUE as maximum value"}}}},{"2":{"Name":"FreeFormLayoutElementBackgroundStyle","Properties":{"Color":{"Type":4,"Flags":0},"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"FreeFormLayoutElementBorderStyle","Properties":{"Color":{"Type":4,"Flags":0},"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"FreeFormLayoutScreenCanvasSizeOptions","Properties":{"OptimizedViewPortWidth":{"Type":4,"Flags":1,"Description":"String based length that is composed of value and unit in px"}}}},{"2":{"Name":"FreeFormSectionLayoutConfiguration","Properties":{"Elements":{"Type":2487,"Flags":1}}}},{"2":{"Name":"FunnelChartAggregatedFieldWells","Properties":{"Category":{"Type":2488,"Flags":0},"Values":{"Type":2489,"Flags":0}}}},{"2":{"Name":"FunnelChartConfiguration","Properties":{"CategoryLabelOptions":{"Type":1889,"Flags":0},"DataLabelOptions":{"Type":2039,"Flags":0},"FieldWells":{"Type":2040,"Flags":0},"SortConfiguration":{"Type":2042,"Flags":0},"Tooltip":{"Type":2368,"Flags":0},"ValueLabelOptions":{"Type":1889,"Flags":0},"VisualPalette":{"Type":2398,"Flags":0}}}},{"2":{"Name":"FunnelChartDataLabelOptions","Properties":{"CategoryLabelVisibility":{"Type":4,"Flags":0},"LabelColor":{"Type":4,"Flags":0},"LabelFontConfiguration":{"Type":2019,"Flags":0},"MeasureDataLabelStyle":{"Type":4,"Flags":0},"MeasureLabelVisibility":{"Type":4,"Flags":0},"Position":{"Type":4,"Flags":0},"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"FunnelChartFieldWells","Properties":{"FunnelChartAggregatedFieldWells":{"Type":2037,"Flags":0}}}},{"2":{"Name":"FunnelChartMeasureDataLabelStyle"}},{"2":{"Name":"FunnelChartSortConfiguration","Properties":{"CategoryItemsLimit":{"Type":2091,"Flags":0},"CategorySort":{"Type":2490,"Flags":0}}}},{"2":{"Name":"FunnelChartVisual","Properties":{"Actions":{"Type":2491,"Flags":0},"ChartConfiguration":{"Type":2038,"Flags":0},"ColumnHierarchies":{"Type":2492,"Flags":0},"Subtitle":{"Type":2399,"Flags":0},"Title":{"Type":2400,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"GaugeChartArcConditionalFormatting","Properties":{"ForegroundColor":{"Type":1913,"Flags":0}}}},{"2":{"Name":"GaugeChartConditionalFormatting","Properties":{"ConditionalFormattingOptions":{"Type":2493,"Flags":0}}}},{"2":{"Name":"GaugeChartConditionalFormattingOption","Properties":{"Arc":{"Type":2044,"Flags":0},"PrimaryValue":{"Type":2050,"Flags":0}}}},{"2":{"Name":"GaugeChartConfiguration","Properties":{"DataLabels":{"Type":1944,"Flags":0},"FieldWells":{"Type":2048,"Flags":0},"GaugeChartOptions":{"Type":2049,"Flags":0},"TooltipOptions":{"Type":2368,"Flags":0},"VisualPalette":{"Type":2398,"Flags":0}}}},{"2":{"Name":"GaugeChartFieldWells","Properties":{"TargetValues":{"Type":2494,"Flags":0},"Values":{"Type":2495,"Flags":0}}}},{"2":{"Name":"GaugeChartOptions","Properties":{"Arc":{"Type":1839,"Flags":0},"ArcAxis":{"Type":1837,"Flags":0},"Comparison":{"Type":1909,"Flags":0},"PrimaryValueDisplayType":{"Type":4,"Flags":0},"PrimaryValueFontConfiguration":{"Type":2019,"Flags":0}}}},{"2":{"Name":"GaugeChartPrimaryValueConditionalFormatting","Properties":{"Icon":{"Type":1917,"Flags":0},"TextColor":{"Type":1913,"Flags":0}}}},{"2":{"Name":"GaugeChartVisual","Properties":{"Actions":{"Type":2496,"Flags":0},"ChartConfiguration":{"Type":2047,"Flags":0},"ConditionalFormatting":{"Type":2045,"Flags":0},"Subtitle":{"Type":2399,"Flags":0},"Title":{"Type":2400,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"GeospatialCoordinateBounds","Properties":{"East":{"Type":3,"Flags":1},"North":{"Type":3,"Flags":1},"South":{"Type":3,"Flags":1},"West":{"Type":3,"Flags":1}}}},{"2":{"Name":"GeospatialHeatmapColorScale","Properties":{"Colors":{"Type":2497,"Flags":0}}}},{"2":{"Name":"GeospatialHeatmapConfiguration","Properties":{"HeatmapColor":{"Type":2053,"Flags":0}}}},{"2":{"Name":"GeospatialHeatmapDataColor","Properties":{"Color":{"Type":4,"Flags":1}}}},{"2":{"Name":"GeospatialMapAggregatedFieldWells","Properties":{"Colors":{"Type":2498,"Flags":0},"Geospatial":{"Type":2499,"Flags":0},"Values":{"Type":2500,"Flags":0}}}},{"2":{"Name":"GeospatialMapConfiguration","Properties":{"FieldWells":{"Type":2058,"Flags":0},"Legend":{"Type":2112,"Flags":0},"MapStyleOptions":{"Type":2059,"Flags":0},"PointStyleOptions":{"Type":2061,"Flags":0},"Tooltip":{"Type":2368,"Flags":0},"VisualPalette":{"Type":2398,"Flags":0},"WindowOptions":{"Type":2063,"Flags":0}}}},{"2":{"Name":"GeospatialMapFieldWells","Properties":{"GeospatialMapAggregatedFieldWells":{"Type":2056,"Flags":0}}}},{"2":{"Name":"GeospatialMapStyleOptions","Properties":{"BaseMapStyle":{"Type":4,"Flags":0}}}},{"2":{"Name":"GeospatialMapVisual","Properties":{"Actions":{"Type":2501,"Flags":0},"ChartConfiguration":{"Type":2057,"Flags":0},"ColumnHierarchies":{"Type":2502,"Flags":0},"Subtitle":{"Type":2399,"Flags":0},"Title":{"Type":2400,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"GeospatialPointStyleOptions","Properties":{"ClusterMarkerConfiguration":{"Type":1891,"Flags":0},"HeatmapConfiguration":{"Type":2054,"Flags":0},"SelectedPointStyle":{"Type":4,"Flags":0}}}},{"2":{"Name":"GeospatialSelectedPointStyle"}},{"2":{"Name":"GeospatialWindowOptions","Properties":{"Bounds":{"Type":2052,"Flags":0},"MapZoomMode":{"Type":4,"Flags":0}}}},{"2":{"Name":"GlobalTableBorderOptions","Properties":{"SideSpecificBorder":{"Type":2339,"Flags":0},"UniformBorder":{"Type":2314,"Flags":0}}}},{"2":{"Name":"GradientColor","Properties":{"Stops":{"Type":2503,"Flags":0}}}},{"2":{"Name":"GradientStop","Properties":{"Color":{"Type":4,"Flags":0},"DataValue":{"Type":3,"Flags":0},"GradientOffset":{"Type":3,"Flags":1}}}},{"2":{"Name":"GridLayoutCanvasSizeOptions","Properties":{"ScreenCanvasSizeOptions":{"Type":2070,"Flags":0}}}},{"2":{"Name":"GridLayoutConfiguration","Properties":{"CanvasSizeOptions":{"Type":2067,"Flags":0},"Elements":{"Type":2504,"Flags":1}}}},{"2":{"Name":"GridLayoutElement","Properties":{"ColumnIndex":{"Type":3,"Flags":0},"ColumnSpan":{"Type":3,"Flags":1},"ElementId":{"Type":4,"Flags":1},"ElementType":{"Type":4,"Flags":1},"RowIndex":{"Type":3,"Flags":0},"RowSpan":{"Type":3,"Flags":1}}}},{"2":{"Name":"GridLayoutScreenCanvasSizeOptions","Properties":{"OptimizedViewPortWidth":{"Type":4,"Flags":0,"Description":"String based length that is composed of value and unit in px"},"ResizeOption":{"Type":4,"Flags":1}}}},{"2":{"Name":"GrowthRateComputation","Properties":{"ComputationId":{"Type":4,"Flags":1},"Name":{"Type":4,"Flags":0},"PeriodSize":{"Type":3,"Flags":0},"Time":{"Type":1978,"Flags":0},"Value":{"Type":2139,"Flags":0}}}},{"2":{"Name":"HeaderFooterSectionConfiguration","Properties":{"Layout":{"Type":2270,"Flags":1},"SectionId":{"Type":4,"Flags":1},"Style":{"Type":2273,"Flags":0}}}},{"2":{"Name":"HeatMapAggregatedFieldWells","Properties":{"Columns":{"Type":2505,"Flags":0},"Rows":{"Type":2506,"Flags":0},"Values":{"Type":2507,"Flags":0}}}},{"2":{"Name":"HeatMapConfiguration","Properties":{"ColorScale":{"Type":1893,"Flags":0},"ColumnLabelOptions":{"Type":1889,"Flags":0},"DataLabels":{"Type":1944,"Flags":0},"FieldWells":{"Type":2075,"Flags":0},"Legend":{"Type":2112,"Flags":0},"RowLabelOptions":{"Type":1889,"Flags":0},"SortConfiguration":{"Type":2076,"Flags":0},"Tooltip":{"Type":2368,"Flags":0}}}},{"2":{"Name":"HeatMapFieldWells","Properties":{"HeatMapAggregatedFieldWells":{"Type":2073,"Flags":0}}}},{"2":{"Name":"HeatMapSortConfiguration","Properties":{"HeatMapColumnItemsLimitConfiguration":{"Type":2091,"Flags":0},"HeatMapColumnSort":{"Type":2508,"Flags":0},"HeatMapRowItemsLimitConfiguration":{"Type":2091,"Flags":0},"HeatMapRowSort":{"Type":2509,"Flags":0}}}},{"2":{"Name":"HeatMapVisual","Properties":{"Actions":{"Type":2510,"Flags":0},"ChartConfiguration":{"Type":2074,"Flags":0},"ColumnHierarchies":{"Type":2511,"Flags":0},"Subtitle":{"Type":2399,"Flags":0},"Title":{"Type":2400,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"HistogramAggregatedFieldWells","Properties":{"Values":{"Type":2512,"Flags":0}}}},{"2":{"Name":"HistogramBinOptions","Properties":{"BinCount":{"Type":1865,"Flags":0},"BinWidth":{"Type":1866,"Flags":0},"SelectedBinType":{"Type":4,"Flags":0},"StartValue":{"Type":3,"Flags":0}}}},{"2":{"Name":"HistogramBinType"}},{"2":{"Name":"HistogramConfiguration","Properties":{"BinOptions":{"Type":2079,"Flags":0},"DataLabels":{"Type":1944,"Flags":0},"FieldWells":{"Type":2082,"Flags":0},"Tooltip":{"Type":2368,"Flags":0},"VisualPalette":{"Type":2398,"Flags":0},"XAxisDisplayOptions":{"Type":1849,"Flags":0},"XAxisLabelOptions":{"Type":1889,"Flags":0},"YAxisDisplayOptions":{"Type":1849,"Flags":0}}}},{"2":{"Name":"HistogramFieldWells","Properties":{"HistogramAggregatedFieldWells":{"Type":2078,"Flags":0}}}},{"2":{"Name":"HistogramVisual","Properties":{"Actions":{"Type":2513,"Flags":0},"ChartConfiguration":{"Type":2081,"Flags":0},"Subtitle":{"Type":2399,"Flags":0},"Title":{"Type":2400,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"HorizontalTextAlignment"}},{"2":{"Name":"Icon"}},{"2":{"Name":"InsightConfiguration","Properties":{"Computations":{"Type":2514,"Flags":0},"CustomNarrative":{"Type":1937,"Flags":0}}}},{"2":{"Name":"InsightVisual","Properties":{"Actions":{"Type":2515,"Flags":0},"DataSetIdentifier":{"Type":4,"Flags":1},"InsightConfiguration":{"Type":2086,"Flags":0},"Subtitle":{"Type":2399,"Flags":0},"Title":{"Type":2400,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"IntegerDefaultValues","Properties":{"DynamicValue":{"Type":1983,"Flags":0},"StaticValues":{"Type":2516,"Flags":0}}}},{"2":{"Name":"IntegerParameterDeclaration","Properties":{"DefaultValues":{"Type":2088,"Flags":0},"MappedDataSetParameters":{"Type":2517,"Flags":0},"Name":{"Type":4,"Flags":1},"ParameterValueType":{"Type":4,"Flags":1},"ValueWhenUnset":{"Type":2090,"Flags":0}}}},{"2":{"Name":"IntegerValueWhenUnsetConfiguration","Properties":{"CustomValue":{"Type":3,"Flags":0},"ValueWhenUnsetOption":{"Type":4,"Flags":0}}}},{"2":{"Name":"ItemsLimitConfiguration","Properties":{"ItemsLimit":{"Type":3,"Flags":0},"OtherCategories":{"Type":4,"Flags":0}}}},{"2":{"Name":"KPIActualValueConditionalFormatting","Properties":{"Icon":{"Type":1917,"Flags":0},"TextColor":{"Type":1913,"Flags":0}}}},{"2":{"Name":"KPIComparisonValueConditionalFormatting","Properties":{"Icon":{"Type":1917,"Flags":0},"TextColor":{"Type":1913,"Flags":0}}}},{"2":{"Name":"KPIConditionalFormatting","Properties":{"ConditionalFormattingOptions":{"Type":2518,"Flags":0}}}},{"2":{"Name":"KPIConditionalFormattingOption","Properties":{"ActualValue":{"Type":2092,"Flags":0},"ComparisonValue":{"Type":2093,"Flags":0},"PrimaryValue":{"Type":2099,"Flags":0},"ProgressBar":{"Type":2100,"Flags":0}}}},{"2":{"Name":"KPIConfiguration","Properties":{"FieldWells":{"Type":2097,"Flags":0},"KPIOptions":{"Type":2098,"Flags":0},"SortConfiguration":{"Type":2101,"Flags":0}}}},{"2":{"Name":"KPIFieldWells","Properties":{"TargetValues":{"Type":2519,"Flags":0},"TrendGroups":{"Type":2520,"Flags":0},"Values":{"Type":2521,"Flags":0}}}},{"2":{"Name":"KPIOptions","Properties":{"Comparison":{"Type":1909,"Flags":0},"PrimaryValueDisplayType":{"Type":4,"Flags":0},"PrimaryValueFontConfiguration":{"Type":2019,"Flags":0},"ProgressBar":{"Type":2220,"Flags":0},"SecondaryValue":{"Type":2265,"Flags":0},"SecondaryValueFontConfiguration":{"Type":2019,"Flags":0},"Sparkline":{"Type":2102,"Flags":0},"TrendArrows":{"Type":2384,"Flags":0},"VisualLayoutOptions":{"Type":2105,"Flags":0}}}},{"2":{"Name":"KPIPrimaryValueConditionalFormatting","Properties":{"Icon":{"Type":1917,"Flags":0},"TextColor":{"Type":1913,"Flags":0}}}},{"2":{"Name":"KPIProgressBarConditionalFormatting","Properties":{"ForegroundColor":{"Type":1913,"Flags":0}}}},{"2":{"Name":"KPISortConfiguration","Properties":{"TrendGroupSort":{"Type":2522,"Flags":0}}}},{"2":{"Name":"KPISparklineOptions","Properties":{"Color":{"Type":4,"Flags":0},"TooltipVisibility":{"Type":4,"Flags":0},"Type":{"Type":4,"Flags":1},"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"KPISparklineType"}},{"2":{"Name":"KPIVisual","Properties":{"Actions":{"Type":2523,"Flags":0},"ChartConfiguration":{"Type":2096,"Flags":0},"ColumnHierarchies":{"Type":2524,"Flags":0},"ConditionalFormatting":{"Type":2094,"Flags":0},"Subtitle":{"Type":2399,"Flags":0},"Title":{"Type":2400,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"KPIVisualLayoutOptions","Properties":{"StandardLayout":{"Type":2106,"Flags":0}}}},{"2":{"Name":"KPIVisualStandardLayout","Properties":{"Type":{"Type":4,"Flags":1}}}},{"2":{"Name":"KPIVisualStandardLayoutType"}},{"2":{"Name":"LabelOptions","Properties":{"CustomLabel":{"Type":4,"Flags":0},"FontConfiguration":{"Type":2019,"Flags":0},"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"Layout","Properties":{"Configuration":{"Type":2110,"Flags":1}}}},{"2":{"Name":"LayoutConfiguration","Properties":{"FreeFormLayout":{"Type":2031,"Flags":0},"GridLayout":{"Type":2068,"Flags":0},"SectionBasedLayout":{"Type":2268,"Flags":0}}}},{"2":{"Name":"LayoutElementType"}},{"2":{"Name":"LegendOptions","Properties":{"Height":{"Type":4,"Flags":0,"Description":"String based length that is composed of value and unit in px"},"Position":{"Type":4,"Flags":0},"Title":{"Type":2108,"Flags":0},"Visibility":{"Type":4,"Flags":0},"Width":{"Type":4,"Flags":0,"Description":"String based length that is composed of value and unit in px"}}}},{"2":{"Name":"LegendPosition"}},{"2":{"Name":"LineChartAggregatedFieldWells","Properties":{"Category":{"Type":2525,"Flags":0},"Colors":{"Type":2526,"Flags":0},"SmallMultiples":{"Type":2527,"Flags":0},"Values":{"Type":2528,"Flags":0}}}},{"2":{"Name":"LineChartConfiguration","Properties":{"ContributionAnalysisDefaults":{"Type":2529,"Flags":0},"DataLabels":{"Type":1944,"Flags":0},"DefaultSeriesSettings":{"Type":2116,"Flags":0},"FieldWells":{"Type":2117,"Flags":0},"ForecastConfigurations":{"Type":2530,"Flags":0},"Legend":{"Type":2112,"Flags":0},"PrimaryYAxisDisplayOptions":{"Type":2127,"Flags":0},"PrimaryYAxisLabelOptions":{"Type":1889,"Flags":0},"ReferenceLines":{"Type":2531,"Flags":0},"SecondaryYAxisDisplayOptions":{"Type":2127,"Flags":0},"SecondaryYAxisLabelOptions":{"Type":1889,"Flags":0},"Series":{"Type":2532,"Flags":0},"SmallMultiplesOptions":{"Type":2303,"Flags":0},"SortConfiguration":{"Type":2123,"Flags":0},"Tooltip":{"Type":2368,"Flags":0},"Type":{"Type":4,"Flags":0},"VisualPalette":{"Type":2398,"Flags":0},"XAxisDisplayOptions":{"Type":1849,"Flags":0},"XAxisLabelOptions":{"Type":1889,"Flags":0}}}},{"2":{"Name":"LineChartDefaultSeriesSettings","Properties":{"AxisBinding":{"Type":4,"Flags":0},"LineStyleSettings":{"Type":2119,"Flags":0},"MarkerStyleSettings":{"Type":2121,"Flags":0}}}},{"2":{"Name":"LineChartFieldWells","Properties":{"LineChartAggregatedFieldWells":{"Type":2114,"Flags":0}}}},{"2":{"Name":"LineChartLineStyle"}},{"2":{"Name":"LineChartLineStyleSettings","Properties":{"LineInterpolation":{"Type":4,"Flags":0},"LineStyle":{"Type":4,"Flags":0},"LineVisibility":{"Type":4,"Flags":0},"LineWidth":{"Type":4,"Flags":0,"Description":"String based length that is composed of value and unit in px"}}}},{"2":{"Name":"LineChartMarkerShape"}},{"2":{"Name":"LineChartMarkerStyleSettings","Properties":{"MarkerColor":{"Type":4,"Flags":0},"MarkerShape":{"Type":4,"Flags":0},"MarkerSize":{"Type":4,"Flags":0,"Description":"String based length that is composed of value and unit in px"},"MarkerVisibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"LineChartSeriesSettings","Properties":{"LineStyleSettings":{"Type":2119,"Flags":0},"MarkerStyleSettings":{"Type":2121,"Flags":0}}}},{"2":{"Name":"LineChartSortConfiguration","Properties":{"CategoryItemsLimitConfiguration":{"Type":2091,"Flags":0},"CategorySort":{"Type":2533,"Flags":0},"ColorItemsLimitConfiguration":{"Type":2091,"Flags":0},"SmallMultiplesLimitConfiguration":{"Type":2091,"Flags":0},"SmallMultiplesSort":{"Type":2534,"Flags":0}}}},{"2":{"Name":"LineChartType"}},{"2":{"Name":"LineChartVisual","Properties":{"Actions":{"Type":2535,"Flags":0},"ChartConfiguration":{"Type":2115,"Flags":0},"ColumnHierarchies":{"Type":2536,"Flags":0},"Subtitle":{"Type":2399,"Flags":0},"Title":{"Type":2400,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"LineInterpolation"}},{"2":{"Name":"LineSeriesAxisDisplayOptions","Properties":{"AxisOptions":{"Type":1849,"Flags":0},"MissingDataConfigurations":{"Type":2537,"Flags":0}}}},{"2":{"Name":"ListControlDisplayOptions","Properties":{"InfoIconLabelOptions":{"Type":2284,"Flags":0},"SearchOptions":{"Type":2129,"Flags":0},"SelectAllOptions":{"Type":2130,"Flags":0},"TitleOptions":{"Type":2108,"Flags":0}}}},{"2":{"Name":"ListControlSearchOptions","Properties":{"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"ListControlSelectAllOptions","Properties":{"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"LoadingAnimation","Properties":{"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"LocalNavigationConfiguration","Properties":{"TargetSheetId":{"Type":4,"Flags":1}}}},{"2":{"Name":"LongFormatText","Properties":{"PlainText":{"Type":4,"Flags":0},"RichText":{"Type":4,"Flags":0}}}},{"2":{"Name":"MapZoomMode"}},{"2":{"Name":"MappedDataSetParameter","Properties":{"DataSetIdentifier":{"Type":4,"Flags":1},"DataSetParameterName":{"Type":4,"Flags":1}}}},{"2":{"Name":"MaximumLabelType","Properties":{"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"MaximumMinimumComputation","Properties":{"ComputationId":{"Type":4,"Flags":1},"Name":{"Type":4,"Flags":0},"Time":{"Type":1978,"Flags":0},"Type":{"Type":4,"Flags":1},"Value":{"Type":2139,"Flags":0}}}},{"2":{"Name":"MaximumMinimumComputationType"}},{"2":{"Name":"MeasureField","Properties":{"CalculatedMeasureField":{"Type":1878,"Flags":0},"CategoricalMeasureField":{"Type":1883,"Flags":0},"DateMeasureField":{"Type":1959,"Flags":0},"NumericalMeasureField":{"Type":2162,"Flags":0}}}},{"2":{"Name":"MetricComparisonComputation","Properties":{"ComputationId":{"Type":4,"Flags":1},"FromValue":{"Type":2139,"Flags":0},"Name":{"Type":4,"Flags":0},"TargetValue":{"Type":2139,"Flags":0},"Time":{"Type":1978,"Flags":0}}}},{"2":{"Name":"MinimumLabelType","Properties":{"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"MissingDataConfiguration","Properties":{"TreatmentOption":{"Type":4,"Flags":0}}}},{"2":{"Name":"MissingDataTreatmentOption"}},{"2":{"Name":"NegativeValueConfiguration","Properties":{"DisplayMode":{"Type":4,"Flags":1}}}},{"2":{"Name":"NegativeValueDisplayMode"}},{"2":{"Name":"NullValueFormatConfiguration","Properties":{"NullString":{"Type":4,"Flags":1}}}},{"2":{"Name":"NumberDisplayFormatConfiguration","Properties":{"DecimalPlacesConfiguration":{"Type":1969,"Flags":0},"NegativeValueConfiguration":{"Type":2144,"Flags":0},"NullValueFormatConfiguration":{"Type":2146,"Flags":0},"NumberScale":{"Type":4,"Flags":0},"Prefix":{"Type":4,"Flags":0},"SeparatorConfiguration":{"Type":2158,"Flags":0},"Suffix":{"Type":4,"Flags":0}}}},{"2":{"Name":"NumberFormatConfiguration","Properties":{"FormatConfiguration":{"Type":2155,"Flags":0}}}},{"2":{"Name":"NumberScale"}},{"2":{"Name":"NumericAxisOptions","Properties":{"Range":{"Type":1850,"Flags":0},"Scale":{"Type":1855,"Flags":0}}}},{"2":{"Name":"NumericEqualityDrillDownFilter","Properties":{"Column":{"Type":1899,"Flags":1},"Value":{"Type":3,"Flags":1}}}},{"2":{"Name":"NumericEqualityFilter","Properties":{"AggregationFunction":{"Type":1831,"Flags":0},"Column":{"Type":1899,"Flags":1},"FilterId":{"Type":4,"Flags":1},"MatchOperator":{"Type":4,"Flags":1},"NullOption":{"Type":4,"Flags":1},"ParameterName":{"Type":4,"Flags":0},"SelectAllOptions":{"Type":4,"Flags":0},"Value":{"Type":3,"Flags":0}}}},{"2":{"Name":"NumericEqualityMatchOperator"}},{"2":{"Name":"NumericFilterSelectAllOptions"}},{"2":{"Name":"NumericFormatConfiguration","Properties":{"CurrencyDisplayFormatConfiguration":{"Type":1925,"Flags":0},"NumberDisplayFormatConfiguration":{"Type":2147,"Flags":0},"PercentageDisplayFormatConfiguration":{"Type":2181,"Flags":0}}}},{"2":{"Name":"NumericRangeFilter","Properties":{"AggregationFunction":{"Type":1831,"Flags":0},"Column":{"Type":1899,"Flags":1},"FilterId":{"Type":4,"Flags":1},"IncludeMaximum":{"Type":2,"Flags":0},"IncludeMinimum":{"Type":2,"Flags":0},"NullOption":{"Type":4,"Flags":1},"RangeMaximum":{"Type":2157,"Flags":0},"RangeMinimum":{"Type":2157,"Flags":0},"SelectAllOptions":{"Type":4,"Flags":0}}}},{"2":{"Name":"NumericRangeFilterValue","Properties":{"Parameter":{"Type":4,"Flags":0},"StaticValue":{"Type":3,"Flags":0}}}},{"2":{"Name":"NumericSeparatorConfiguration","Properties":{"DecimalSeparator":{"Type":4,"Flags":0},"ThousandsSeparator":{"Type":2360,"Flags":0}}}},{"2":{"Name":"NumericSeparatorSymbol"}},{"2":{"Name":"NumericalAggregationFunction","Properties":{"PercentileAggregation":{"Type":2182,"Flags":0},"SimpleNumericalAggregation":{"Type":4,"Flags":0}}}},{"2":{"Name":"NumericalDimensionField","Properties":{"Column":{"Type":1899,"Flags":1},"FieldId":{"Type":4,"Flags":1},"FormatConfiguration":{"Type":2148,"Flags":0},"HierarchyId":{"Type":4,"Flags":0}}}},{"2":{"Name":"NumericalMeasureField","Properties":{"AggregationFunction":{"Type":2160,"Flags":0},"Column":{"Type":1899,"Flags":1},"FieldId":{"Type":4,"Flags":1},"FormatConfiguration":{"Type":2148,"Flags":0}}}},{"2":{"Name":"OtherCategories"}},{"2":{"Name":"PaginationConfiguration","Properties":{"PageNumber":{"Type":3,"Flags":1},"PageSize":{"Type":3,"Flags":1}}}},{"2":{"Name":"PanelBorderStyle"}},{"2":{"Name":"PanelConfiguration","Properties":{"BackgroundColor":{"Type":4,"Flags":0},"BackgroundVisibility":{"Type":4,"Flags":0},"BorderColor":{"Type":4,"Flags":0},"BorderStyle":{"Type":4,"Flags":0},"BorderThickness":{"Type":4,"Flags":0,"Description":"String based length that is composed of value and unit in px"},"BorderVisibility":{"Type":4,"Flags":0},"GutterSpacing":{"Type":4,"Flags":0,"Description":"String based length that is composed of value and unit in px"},"GutterVisibility":{"Type":4,"Flags":0},"Title":{"Type":2167,"Flags":0}}}},{"2":{"Name":"PanelTitleOptions","Properties":{"FontConfiguration":{"Type":2019,"Flags":0},"HorizontalTextAlignment":{"Type":4,"Flags":0},"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"PaperOrientation"}},{"2":{"Name":"PaperSize"}},{"2":{"Name":"ParameterControl","Properties":{"DateTimePicker":{"Type":2171,"Flags":0},"Dropdown":{"Type":2173,"Flags":0},"List":{"Type":2174,"Flags":0},"Slider":{"Type":2176,"Flags":0},"TextArea":{"Type":2177,"Flags":0},"TextField":{"Type":2178,"Flags":0}}}},{"2":{"Name":"ParameterDateTimePickerControl","Properties":{"DisplayOptions":{"Type":1964,"Flags":0},"ParameterControlId":{"Type":4,"Flags":1},"SourceParameterName":{"Type":4,"Flags":1},"Title":{"Type":4,"Flags":1}}}},{"2":{"Name":"ParameterDeclaration","Properties":{"DateTimeParameterDeclaration":{"Type":1963,"Flags":0},"DecimalParameterDeclaration":{"Type":1968,"Flags":0},"IntegerParameterDeclaration":{"Type":2089,"Flags":0},"StringParameterDeclaration":{"Type":2309,"Flags":0}}}},{"2":{"Name":"ParameterDropDownControl","Properties":{"CascadingControlConfiguration":{"Type":1879,"Flags":0},"DisplayOptions":{"Type":1982,"Flags":0},"ParameterControlId":{"Type":4,"Flags":1},"SelectableValues":{"Type":2175,"Flags":0},"SourceParameterName":{"Type":4,"Flags":1},"Title":{"Type":4,"Flags":1},"Type":{"Type":4,"Flags":0}}}},{"2":{"Name":"ParameterListControl","Properties":{"CascadingControlConfiguration":{"Type":1879,"Flags":0},"DisplayOptions":{"Type":2128,"Flags":0},"ParameterControlId":{"Type":4,"Flags":1},"SelectableValues":{"Type":2175,"Flags":0},"SourceParameterName":{"Type":4,"Flags":1},"Title":{"Type":4,"Flags":1},"Type":{"Type":4,"Flags":0}}}},{"2":{"Name":"ParameterSelectableValues","Properties":{"LinkToDataSetColumn":{"Type":1899,"Flags":0},"Values":{"Type":2538,"Flags":0}}}},{"2":{"Name":"ParameterSliderControl","Properties":{"DisplayOptions":{"Type":2299,"Flags":0},"MaximumValue":{"Type":3,"Flags":1},"MinimumValue":{"Type":3,"Flags":1},"ParameterControlId":{"Type":4,"Flags":1},"SourceParameterName":{"Type":4,"Flags":1},"StepSize":{"Type":3,"Flags":1},"Title":{"Type":4,"Flags":1}}}},{"2":{"Name":"ParameterTextAreaControl","Properties":{"Delimiter":{"Type":4,"Flags":0},"DisplayOptions":{"Type":2355,"Flags":0},"ParameterControlId":{"Type":4,"Flags":1},"SourceParameterName":{"Type":4,"Flags":1},"Title":{"Type":4,"Flags":1}}}},{"2":{"Name":"ParameterTextFieldControl","Properties":{"DisplayOptions":{"Type":2358,"Flags":0},"ParameterControlId":{"Type":4,"Flags":1},"SourceParameterName":{"Type":4,"Flags":1},"Title":{"Type":4,"Flags":1}}}},{"2":{"Name":"ParameterValueType"}},{"2":{"Name":"PercentVisibleRange","Properties":{"From":{"Type":3,"Flags":0},"To":{"Type":3,"Flags":0}}}},{"2":{"Name":"PercentageDisplayFormatConfiguration","Properties":{"DecimalPlacesConfiguration":{"Type":1969,"Flags":0},"NegativeValueConfiguration":{"Type":2144,"Flags":0},"NullValueFormatConfiguration":{"Type":2146,"Flags":0},"Prefix":{"Type":4,"Flags":0},"SeparatorConfiguration":{"Type":2158,"Flags":0},"Suffix":{"Type":4,"Flags":0}}}},{"2":{"Name":"PercentileAggregation","Properties":{"PercentileValue":{"Type":3,"Flags":0}}}},{"2":{"Name":"PeriodOverPeriodComputation","Properties":{"ComputationId":{"Type":4,"Flags":1},"Name":{"Type":4,"Flags":0},"Time":{"Type":1978,"Flags":0},"Value":{"Type":2139,"Flags":0}}}},{"2":{"Name":"PeriodToDateComputation","Properties":{"ComputationId":{"Type":4,"Flags":1},"Name":{"Type":4,"Flags":0},"PeriodTimeGranularity":{"Type":4,"Flags":0},"Time":{"Type":1978,"Flags":0},"Value":{"Type":2139,"Flags":0}}}},{"2":{"Name":"PieChartAggregatedFieldWells","Properties":{"Category":{"Type":2539,"Flags":0},"SmallMultiples":{"Type":2540,"Flags":0},"Values":{"Type":2541,"Flags":0}}}},{"2":{"Name":"PieChartConfiguration","Properties":{"CategoryLabelOptions":{"Type":1889,"Flags":0},"ContributionAnalysisDefaults":{"Type":2542,"Flags":0},"DataLabels":{"Type":1944,"Flags":0},"DonutOptions":{"Type":1980,"Flags":0},"FieldWells":{"Type":2187,"Flags":0},"Legend":{"Type":2112,"Flags":0},"SmallMultiplesOptions":{"Type":2303,"Flags":0},"SortConfiguration":{"Type":2188,"Flags":0},"Tooltip":{"Type":2368,"Flags":0},"ValueLabelOptions":{"Type":1889,"Flags":0},"VisualPalette":{"Type":2398,"Flags":0}}}},{"2":{"Name":"PieChartFieldWells","Properties":{"PieChartAggregatedFieldWells":{"Type":2185,"Flags":0}}}},{"2":{"Name":"PieChartSortConfiguration","Properties":{"CategoryItemsLimit":{"Type":2091,"Flags":0},"CategorySort":{"Type":2543,"Flags":0},"SmallMultiplesLimitConfiguration":{"Type":2091,"Flags":0},"SmallMultiplesSort":{"Type":2544,"Flags":0}}}},{"2":{"Name":"PieChartVisual","Properties":{"Actions":{"Type":2545,"Flags":0},"ChartConfiguration":{"Type":2186,"Flags":0},"ColumnHierarchies":{"Type":2546,"Flags":0},"Subtitle":{"Type":2399,"Flags":0},"Title":{"Type":2400,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"PivotFieldSortOptions","Properties":{"FieldId":{"Type":4,"Flags":1},"SortBy":{"Type":2212,"Flags":1}}}},{"2":{"Name":"PivotTableAggregatedFieldWells","Properties":{"Columns":{"Type":2547,"Flags":0},"Rows":{"Type":2548,"Flags":0},"Values":{"Type":2549,"Flags":0}}}},{"2":{"Name":"PivotTableCellConditionalFormatting","Properties":{"FieldId":{"Type":4,"Flags":1},"Scope":{"Type":2195,"Flags":0},"Scopes":{"Type":2550,"Flags":0},"TextFormat":{"Type":2356,"Flags":0}}}},{"2":{"Name":"PivotTableConditionalFormatting","Properties":{"ConditionalFormattingOptions":{"Type":2551,"Flags":0}}}},{"2":{"Name":"PivotTableConditionalFormattingOption","Properties":{"Cell":{"Type":2192,"Flags":0}}}},{"2":{"Name":"PivotTableConditionalFormattingScope","Properties":{"Role":{"Type":4,"Flags":0}}}},{"2":{"Name":"PivotTableConditionalFormattingScopeRole"}},{"2":{"Name":"PivotTableConfiguration","Properties":{"FieldOptions":{"Type":2204,"Flags":0},"FieldWells":{"Type":2206,"Flags":0},"PaginatedReportOptions":{"Type":2209,"Flags":0},"SortConfiguration":{"Type":2213,"Flags":0},"TableOptions":{"Type":2208,"Flags":0},"TotalOptions":{"Type":2215,"Flags":0}}}},{"2":{"Name":"PivotTableDataPathOption","Properties":{"DataPathList":{"Type":2552,"Flags":1},"Width":{"Type":4,"Flags":0,"Description":"String based length that is composed of value and unit in px"}}}},{"2":{"Name":"PivotTableDataPathType"}},{"2":{"Name":"PivotTableFieldCollapseState"}},{"2":{"Name":"PivotTableFieldCollapseStateOption","Properties":{"State":{"Type":4,"Flags":0},"Target":{"Type":2202,"Flags":1}}}},{"2":{"Name":"PivotTableFieldCollapseStateTarget","Properties":{"FieldDataPathValues":{"Type":2553,"Flags":0},"FieldId":{"Type":4,"Flags":0}}}},{"2":{"Name":"PivotTableFieldOption","Properties":{"CustomLabel":{"Type":4,"Flags":0},"FieldId":{"Type":4,"Flags":1},"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"PivotTableFieldOptions","Properties":{"CollapseStateOptions":{"Type":2554,"Flags":0},"DataPathOptions":{"Type":2555,"Flags":0},"SelectedFieldOptions":{"Type":2556,"Flags":0}}}},{"2":{"Name":"PivotTableFieldSubtotalOptions","Properties":{"FieldId":{"Type":4,"Flags":0}}}},{"2":{"Name":"PivotTableFieldWells","Properties":{"PivotTableAggregatedFieldWells":{"Type":2191,"Flags":0}}}},{"2":{"Name":"PivotTableMetricPlacement"}},{"2":{"Name":"PivotTableOptions","Properties":{"CellStyle":{"Type":2319,"Flags":0},"CollapsedRowDimensionsVisibility":{"Type":4,"Flags":0},"ColumnHeaderStyle":{"Type":2319,"Flags":0},"ColumnNamesVisibility":{"Type":4,"Flags":0},"DefaultCellWidth":{"Type":4,"Flags":0,"Description":"String based length that is composed of value and unit in px"},"MetricPlacement":{"Type":4,"Flags":0},"RowAlternateColorOptions":{"Type":2252,"Flags":0},"RowFieldNamesStyle":{"Type":2319,"Flags":0},"RowHeaderStyle":{"Type":2319,"Flags":0},"RowsLabelOptions":{"Type":2210,"Flags":0},"RowsLayout":{"Type":4,"Flags":0},"SingleMetricVisibility":{"Type":4,"Flags":0},"ToggleButtonsVisibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"PivotTablePaginatedReportOptions","Properties":{"OverflowColumnHeaderVisibility":{"Type":4,"Flags":0},"VerticalOverflowVisibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"PivotTableRowsLabelOptions","Properties":{"CustomLabel":{"Type":4,"Flags":0},"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"PivotTableRowsLayout"}},{"2":{"Name":"PivotTableSortBy","Properties":{"Column":{"Type":1902,"Flags":0},"DataPath":{"Type":1950,"Flags":0},"Field":{"Type":1991,"Flags":0}}}},{"2":{"Name":"PivotTableSortConfiguration","Properties":{"FieldSortOptions":{"Type":2557,"Flags":0}}}},{"2":{"Name":"PivotTableSubtotalLevel"}},{"2":{"Name":"PivotTableTotalOptions","Properties":{"ColumnSubtotalOptions":{"Type":2312,"Flags":0},"ColumnTotalOptions":{"Type":2217,"Flags":0},"RowSubtotalOptions":{"Type":2312,"Flags":0},"RowTotalOptions":{"Type":2217,"Flags":0}}}},{"2":{"Name":"PivotTableVisual","Properties":{"Actions":{"Type":2558,"Flags":0},"ChartConfiguration":{"Type":2197,"Flags":0},"ConditionalFormatting":{"Type":2193,"Flags":0},"Subtitle":{"Type":2399,"Flags":0},"Title":{"Type":2400,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"PivotTotalOptions","Properties":{"CustomLabel":{"Type":4,"Flags":0},"MetricHeaderCellStyle":{"Type":2319,"Flags":0},"Placement":{"Type":4,"Flags":0},"ScrollStatus":{"Type":4,"Flags":0},"TotalAggregationOptions":{"Type":2559,"Flags":0},"TotalCellStyle":{"Type":2319,"Flags":0},"TotalsVisibility":{"Type":4,"Flags":0},"ValueCellStyle":{"Type":2319,"Flags":0}}}},{"2":{"Name":"PredefinedHierarchy","Properties":{"Columns":{"Type":2560,"Flags":1},"DrillDownFilters":{"Type":2561,"Flags":0},"HierarchyId":{"Type":4,"Flags":1}}}},{"2":{"Name":"PrimaryValueDisplayType"}},{"2":{"Name":"ProgressBarOptions","Properties":{"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"RadarChartAggregatedFieldWells","Properties":{"Category":{"Type":2562,"Flags":0},"Color":{"Type":2563,"Flags":0},"Values":{"Type":2564,"Flags":0}}}},{"2":{"Name":"RadarChartAreaStyleSettings","Properties":{"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"RadarChartAxesRangeScale"}},{"2":{"Name":"RadarChartConfiguration","Properties":{"AlternateBandColorsVisibility":{"Type":4,"Flags":0},"AlternateBandEvenColor":{"Type":4,"Flags":0},"AlternateBandOddColor":{"Type":4,"Flags":0},"AxesRangeScale":{"Type":4,"Flags":0},"BaseSeriesSettings":{"Type":2226,"Flags":0},"CategoryAxis":{"Type":1849,"Flags":0},"CategoryLabelOptions":{"Type":1889,"Flags":0},"ColorAxis":{"Type":1849,"Flags":0},"ColorLabelOptions":{"Type":1889,"Flags":0},"FieldWells":{"Type":2225,"Flags":0},"Legend":{"Type":2112,"Flags":0},"Shape":{"Type":4,"Flags":0},"SortConfiguration":{"Type":2228,"Flags":0},"StartAngle":{"Type":3,"Flags":0},"VisualPalette":{"Type":2398,"Flags":0}}}},{"2":{"Name":"RadarChartFieldWells","Properties":{"RadarChartAggregatedFieldWells":{"Type":2221,"Flags":0}}}},{"2":{"Name":"RadarChartSeriesSettings","Properties":{"AreaStyleSettings":{"Type":2222,"Flags":0}}}},{"2":{"Name":"RadarChartShape"}},{"2":{"Name":"RadarChartSortConfiguration","Properties":{"CategoryItemsLimit":{"Type":2091,"Flags":0},"CategorySort":{"Type":2565,"Flags":0},"ColorItemsLimit":{"Type":2091,"Flags":0},"ColorSort":{"Type":2566,"Flags":0}}}},{"2":{"Name":"RadarChartVisual","Properties":{"Actions":{"Type":2567,"Flags":0},"ChartConfiguration":{"Type":2224,"Flags":0},"ColumnHierarchies":{"Type":2568,"Flags":0},"Subtitle":{"Type":2399,"Flags":0},"Title":{"Type":2400,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"RangeEndsLabelType","Properties":{"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"ReferenceLine","Properties":{"DataConfiguration":{"Type":2233,"Flags":1},"LabelConfiguration":{"Type":2235,"Flags":0},"Status":{"Type":4,"Flags":0},"StyleConfiguration":{"Type":2241,"Flags":0}}}},{"2":{"Name":"ReferenceLineCustomLabelConfiguration","Properties":{"CustomLabel":{"Type":4,"Flags":1}}}},{"2":{"Name":"ReferenceLineDataConfiguration","Properties":{"AxisBinding":{"Type":4,"Flags":0},"DynamicConfiguration":{"Type":2234,"Flags":0},"SeriesType":{"Type":4,"Flags":0},"StaticConfiguration":{"Type":2240,"Flags":0}}}},{"2":{"Name":"ReferenceLineDynamicDataConfiguration","Properties":{"Calculation":{"Type":2160,"Flags":1},"Column":{"Type":1899,"Flags":1},"MeasureAggregationFunction":{"Type":1831,"Flags":0}}}},{"2":{"Name":"ReferenceLineLabelConfiguration","Properties":{"CustomLabelConfiguration":{"Type":2232,"Flags":0},"FontColor":{"Type":4,"Flags":0},"FontConfiguration":{"Type":2019,"Flags":0},"HorizontalPosition":{"Type":4,"Flags":0},"ValueLabelConfiguration":{"Type":2242,"Flags":0},"VerticalPosition":{"Type":4,"Flags":0}}}},{"2":{"Name":"ReferenceLineLabelHorizontalPosition"}},{"2":{"Name":"ReferenceLineLabelVerticalPosition"}},{"2":{"Name":"ReferenceLinePatternType"}},{"2":{"Name":"ReferenceLineSeriesType"}},{"2":{"Name":"ReferenceLineStaticDataConfiguration","Properties":{"Value":{"Type":3,"Flags":1}}}},{"2":{"Name":"ReferenceLineStyleConfiguration","Properties":{"Color":{"Type":4,"Flags":0},"Pattern":{"Type":4,"Flags":0}}}},{"2":{"Name":"ReferenceLineValueLabelConfiguration","Properties":{"FormatConfiguration":{"Type":2155,"Flags":0},"RelativePosition":{"Type":4,"Flags":0}}}},{"2":{"Name":"ReferenceLineValueLabelRelativePosition"}},{"2":{"Name":"RelativeDateTimeControlDisplayOptions","Properties":{"DateTimeFormat":{"Type":4,"Flags":0},"InfoIconLabelOptions":{"Type":2284,"Flags":0},"TitleOptions":{"Type":2108,"Flags":0}}}},{"2":{"Name":"RelativeDateType"}},{"2":{"Name":"RelativeDatesFilter","Properties":{"AnchorDateConfiguration":{"Type":1835,"Flags":1},"Column":{"Type":1899,"Flags":1},"ExcludePeriodConfiguration":{"Type":1986,"Flags":0},"FilterId":{"Type":4,"Flags":1},"MinimumGranularity":{"Type":4,"Flags":0},"NullOption":{"Type":4,"Flags":1},"ParameterName":{"Type":4,"Flags":0},"RelativeDateType":{"Type":4,"Flags":1},"RelativeDateValue":{"Type":3,"Flags":0},"TimeGranularity":{"Type":4,"Flags":1}}}},{"2":{"Name":"RelativeFontSize"}},{"2":{"Name":"ResizeOption"}},{"2":{"Name":"ResourcePermission","Properties":{"Actions":{"Type":2569,"Flags":1},"Principal":{"Type":4,"Flags":1}}}},{"2":{"Name":"ResourceStatus"}},{"2":{"Name":"RollingDateConfiguration","Properties":{"DataSetIdentifier":{"Type":4,"Flags":0},"Expression":{"Type":4,"Flags":1}}}},{"2":{"Name":"RowAlternateColorOptions","Properties":{"RowAlternateColors":{"Type":2570,"Flags":0},"Status":{"Type":4,"Flags":0},"UsePrimaryBackgroundColor":{"Type":4,"Flags":0}}}},{"2":{"Name":"SameSheetTargetVisualConfiguration","Properties":{"TargetVisualOptions":{"Type":4,"Flags":0},"TargetVisuals":{"Type":2571,"Flags":0}}}},{"2":{"Name":"SankeyDiagramAggregatedFieldWells","Properties":{"Destination":{"Type":2572,"Flags":0},"Source":{"Type":2573,"Flags":0},"Weight":{"Type":2574,"Flags":0}}}},{"2":{"Name":"SankeyDiagramChartConfiguration","Properties":{"DataLabels":{"Type":1944,"Flags":0},"FieldWells":{"Type":2256,"Flags":0},"SortConfiguration":{"Type":2257,"Flags":0}}}},{"2":{"Name":"SankeyDiagramFieldWells","Properties":{"SankeyDiagramAggregatedFieldWells":{"Type":2254,"Flags":0}}}},{"2":{"Name":"SankeyDiagramSortConfiguration","Properties":{"DestinationItemsLimit":{"Type":2091,"Flags":0},"SourceItemsLimit":{"Type":2091,"Flags":0},"WeightSort":{"Type":2575,"Flags":0}}}},{"2":{"Name":"SankeyDiagramVisual","Properties":{"Actions":{"Type":2576,"Flags":0},"ChartConfiguration":{"Type":2255,"Flags":0},"Subtitle":{"Type":2399,"Flags":0},"Title":{"Type":2400,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"ScatterPlotCategoricallyAggregatedFieldWells","Properties":{"Category":{"Type":2577,"Flags":0},"Label":{"Type":2578,"Flags":0},"Size":{"Type":2579,"Flags":0},"XAxis":{"Type":2580,"Flags":0},"YAxis":{"Type":2581,"Flags":0}}}},{"2":{"Name":"ScatterPlotConfiguration","Properties":{"DataLabels":{"Type":1944,"Flags":0},"FieldWells":{"Type":2261,"Flags":0},"Legend":{"Type":2112,"Flags":0},"Tooltip":{"Type":2368,"Flags":0},"VisualPalette":{"Type":2398,"Flags":0},"XAxisDisplayOptions":{"Type":1849,"Flags":0},"XAxisLabelOptions":{"Type":1889,"Flags":0},"YAxisDisplayOptions":{"Type":1849,"Flags":0},"YAxisLabelOptions":{"Type":1889,"Flags":0}}}},{"2":{"Name":"ScatterPlotFieldWells","Properties":{"ScatterPlotCategoricallyAggregatedFieldWells":{"Type":2259,"Flags":0},"ScatterPlotUnaggregatedFieldWells":{"Type":2262,"Flags":0}}}},{"2":{"Name":"ScatterPlotUnaggregatedFieldWells","Properties":{"Category":{"Type":2582,"Flags":0},"Label":{"Type":2583,"Flags":0},"Size":{"Type":2584,"Flags":0},"XAxis":{"Type":2585,"Flags":0},"YAxis":{"Type":2586,"Flags":0}}}},{"2":{"Name":"ScatterPlotVisual","Properties":{"Actions":{"Type":2587,"Flags":0},"ChartConfiguration":{"Type":2260,"Flags":0},"ColumnHierarchies":{"Type":2588,"Flags":0},"Subtitle":{"Type":2399,"Flags":0},"Title":{"Type":2400,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"ScrollBarOptions","Properties":{"Visibility":{"Type":4,"Flags":0},"VisibleRange":{"Type":2393,"Flags":0}}}},{"2":{"Name":"SecondaryValueOptions","Properties":{"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"SectionAfterPageBreak","Properties":{"Status":{"Type":4,"Flags":0}}}},{"2":{"Name":"SectionBasedLayoutCanvasSizeOptions","Properties":{"PaperCanvasSizeOptions":{"Type":2269,"Flags":0}}}},{"2":{"Name":"SectionBasedLayoutConfiguration","Properties":{"BodySections":{"Type":2589,"Flags":1},"CanvasSizeOptions":{"Type":2267,"Flags":1},"FooterSections":{"Type":2590,"Flags":1},"HeaderSections":{"Type":2591,"Flags":1}}}},{"2":{"Name":"SectionBasedLayoutPaperCanvasSizeOptions","Properties":{"PaperMargin":{"Type":2305,"Flags":0},"PaperOrientation":{"Type":4,"Flags":0},"PaperSize":{"Type":4,"Flags":0}}}},{"2":{"Name":"SectionLayoutConfiguration","Properties":{"FreeFormLayout":{"Type":2036,"Flags":1}}}},{"2":{"Name":"SectionPageBreakConfiguration","Properties":{"After":{"Type":2266,"Flags":0}}}},{"2":{"Name":"SectionPageBreakStatus"}},{"2":{"Name":"SectionStyle","Properties":{"Height":{"Type":4,"Flags":0,"Description":"String based length that is composed of value and unit in px"},"Padding":{"Type":2305,"Flags":0}}}},{"2":{"Name":"SelectAllValueOptions"}},{"2":{"Name":"SelectedFieldOptions"}},{"2":{"Name":"SelectedSheetsFilterScopeConfiguration","Properties":{"SheetVisualScopingConfigurations":{"Type":2592,"Flags":0}}}},{"2":{"Name":"SelectedTooltipType"}},{"2":{"Name":"SeriesItem","Properties":{"DataFieldSeriesItem":{"Type":1942,"Flags":0},"FieldSeriesItem":{"Type":1990,"Flags":0}}}},{"2":{"Name":"SetParameterValueConfiguration","Properties":{"DestinationParameterName":{"Type":4,"Flags":1},"Value":{"Type":1977,"Flags":1}}}},{"2":{"Name":"ShapeConditionalFormat","Properties":{"BackgroundColor":{"Type":1913,"Flags":1}}}},{"2":{"Name":"Sheet","Properties":{"Name":{"Type":4,"Flags":0},"SheetId":{"Type":4,"Flags":0}}}},{"2":{"Name":"SheetContentType"}},{"2":{"Name":"SheetControlDateTimePickerType"}},{"2":{"Name":"SheetControlInfoIconLabelOptions","Properties":{"InfoIconText":{"Type":4,"Flags":0},"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"SheetControlLayout","Properties":{"Configuration":{"Type":2286,"Flags":1}}}},{"2":{"Name":"SheetControlLayoutConfiguration","Properties":{"GridLayout":{"Type":2068,"Flags":0}}}},{"2":{"Name":"SheetControlListType"}},{"2":{"Name":"SheetControlSliderType"}},{"2":{"Name":"SheetDefinition","Properties":{"ContentType":{"Type":4,"Flags":0},"Description":{"Type":4,"Flags":0},"FilterControls":{"Type":2593,"Flags":0},"Layouts":{"Type":2594,"Flags":0},"Name":{"Type":4,"Flags":0},"ParameterControls":{"Type":2595,"Flags":0},"SheetControlLayouts":{"Type":2596,"Flags":0},"SheetId":{"Type":4,"Flags":1},"TextBoxes":{"Type":2597,"Flags":0},"Title":{"Type":4,"Flags":0},"Visuals":{"Type":2598,"Flags":0}}}},{"2":{"Name":"SheetElementConfigurationOverrides","Properties":{"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"SheetElementRenderingRule","Properties":{"ConfigurationOverrides":{"Type":2290,"Flags":1},"Expression":{"Type":4,"Flags":1}}}},{"2":{"Name":"SheetTextBox","Properties":{"Content":{"Type":4,"Flags":0},"SheetTextBoxId":{"Type":4,"Flags":1}}}},{"2":{"Name":"SheetVisualScopingConfiguration","Properties":{"Scope":{"Type":4,"Flags":1},"SheetId":{"Type":4,"Flags":1},"VisualIds":{"Type":2599,"Flags":0}}}},{"2":{"Name":"ShortFormatText","Properties":{"PlainText":{"Type":4,"Flags":0},"RichText":{"Type":4,"Flags":0}}}},{"2":{"Name":"SimpleAttributeAggregationFunction"}},{"2":{"Name":"SimpleClusterMarker","Properties":{"Color":{"Type":4,"Flags":0}}}},{"2":{"Name":"SimpleNumericalAggregationFunction"}},{"2":{"Name":"SimpleTotalAggregationFunction"}},{"2":{"Name":"SliderControlDisplayOptions","Properties":{"InfoIconLabelOptions":{"Type":2284,"Flags":0},"TitleOptions":{"Type":2108,"Flags":0}}}},{"2":{"Name":"SmallMultiplesAxisPlacement"}},{"2":{"Name":"SmallMultiplesAxisProperties","Properties":{"Placement":{"Type":4,"Flags":0},"Scale":{"Type":4,"Flags":0}}}},{"2":{"Name":"SmallMultiplesAxisScale"}},{"2":{"Name":"SmallMultiplesOptions","Properties":{"MaxVisibleColumns":{"Type":3,"Flags":0},"MaxVisibleRows":{"Type":3,"Flags":0},"PanelConfiguration":{"Type":2166,"Flags":0},"XAxis":{"Type":2301,"Flags":0},"YAxis":{"Type":2301,"Flags":0}}}},{"2":{"Name":"SortDirection"}},{"2":{"Name":"Spacing","Properties":{"Bottom":{"Type":4,"Flags":0,"Description":"String based length that is composed of value and unit"},"Left":{"Type":4,"Flags":0,"Description":"String based length that is composed of value and unit"},"Right":{"Type":4,"Flags":0,"Description":"String based length that is composed of value and unit"},"Top":{"Type":4,"Flags":0,"Description":"String based length that is composed of value and unit"}}}},{"2":{"Name":"SpecialValue"}},{"2":{"Name":"StringDefaultValues","Properties":{"DynamicValue":{"Type":1983,"Flags":0},"StaticValues":{"Type":2600,"Flags":0}}}},{"2":{"Name":"StringFormatConfiguration","Properties":{"NullValueFormatConfiguration":{"Type":2146,"Flags":0},"NumericFormatConfiguration":{"Type":2155,"Flags":0}}}},{"2":{"Name":"StringParameterDeclaration","Properties":{"DefaultValues":{"Type":2307,"Flags":0},"MappedDataSetParameters":{"Type":2601,"Flags":0},"Name":{"Type":4,"Flags":1},"ParameterValueType":{"Type":4,"Flags":1},"ValueWhenUnset":{"Type":2310,"Flags":0}}}},{"2":{"Name":"StringValueWhenUnsetConfiguration","Properties":{"CustomValue":{"Type":4,"Flags":0},"ValueWhenUnsetOption":{"Type":4,"Flags":0}}}},{"2":{"Name":"StyledCellType"}},{"2":{"Name":"SubtotalOptions","Properties":{"CustomLabel":{"Type":4,"Flags":0},"FieldLevel":{"Type":4,"Flags":0},"FieldLevelOptions":{"Type":2602,"Flags":0},"MetricHeaderCellStyle":{"Type":2319,"Flags":0},"StyleTargets":{"Type":2603,"Flags":0},"TotalCellStyle":{"Type":2319,"Flags":0},"TotalsVisibility":{"Type":4,"Flags":0},"ValueCellStyle":{"Type":2319,"Flags":0}}}},{"2":{"Name":"TableAggregatedFieldWells","Properties":{"GroupBy":{"Type":2604,"Flags":0},"Values":{"Type":2605,"Flags":0}}}},{"2":{"Name":"TableBorderOptions","Properties":{"Color":{"Type":4,"Flags":0},"Style":{"Type":4,"Flags":0},"Thickness":{"Type":3,"Flags":0}}}},{"2":{"Name":"TableBorderStyle"}},{"2":{"Name":"TableCellConditionalFormatting","Properties":{"FieldId":{"Type":4,"Flags":1},"TextFormat":{"Type":2356,"Flags":0}}}},{"2":{"Name":"TableCellImageScalingConfiguration"}},{"2":{"Name":"TableCellImageSizingConfiguration","Properties":{"TableCellImageScalingConfiguration":{"Type":4,"Flags":0}}}},{"2":{"Name":"TableCellStyle","Properties":{"BackgroundColor":{"Type":4,"Flags":0},"Border":{"Type":2064,"Flags":0},"FontConfiguration":{"Type":2019,"Flags":0},"Height":{"Type":3,"Flags":0},"HorizontalTextAlignment":{"Type":4,"Flags":0},"TextWrap":{"Type":4,"Flags":0},"VerticalTextAlignment":{"Type":4,"Flags":0},"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"TableConditionalFormatting","Properties":{"ConditionalFormattingOptions":{"Type":2606,"Flags":0}}}},{"2":{"Name":"TableConditionalFormattingOption","Properties":{"Cell":{"Type":2316,"Flags":0},"Row":{"Type":2338,"Flags":0}}}},{"2":{"Name":"TableConfiguration","Properties":{"FieldOptions":{"Type":2330,"Flags":0},"FieldWells":{"Type":2332,"Flags":0},"PaginatedReportOptions":{"Type":2336,"Flags":0},"SortConfiguration":{"Type":2340,"Flags":0},"TableInlineVisualizations":{"Type":2607,"Flags":0},"TableOptions":{"Type":2334,"Flags":0},"TotalOptions":{"Type":2378,"Flags":0}}}},{"2":{"Name":"TableFieldCustomIconContent","Properties":{"Icon":{"Type":4,"Flags":0}}}},{"2":{"Name":"TableFieldCustomTextContent","Properties":{"FontConfiguration":{"Type":2019,"Flags":1},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"TableFieldIconSetType"}},{"2":{"Name":"TableFieldImageConfiguration","Properties":{"SizingOptions":{"Type":2318,"Flags":0}}}},{"2":{"Name":"TableFieldLinkConfiguration","Properties":{"Content":{"Type":2328,"Flags":1},"Target":{"Type":4,"Flags":1}}}},{"2":{"Name":"TableFieldLinkContentConfiguration","Properties":{"CustomIconContent":{"Type":2323,"Flags":0},"CustomTextContent":{"Type":2324,"Flags":0}}}},{"2":{"Name":"TableFieldOption","Properties":{"CustomLabel":{"Type":4,"Flags":0},"FieldId":{"Type":4,"Flags":1},"URLStyling":{"Type":2331,"Flags":0},"Visibility":{"Type":4,"Flags":0},"Width":{"Type":4,"Flags":0,"Description":"String based length that is composed of value and unit in px"}}}},{"2":{"Name":"TableFieldOptions","Properties":{"Order":{"Type":2608,"Flags":0},"PinnedFieldOptions":{"Type":2337,"Flags":0},"SelectedFieldOptions":{"Type":2609,"Flags":0}}}},{"2":{"Name":"TableFieldURLConfiguration","Properties":{"ImageConfiguration":{"Type":2326,"Flags":0},"LinkConfiguration":{"Type":2327,"Flags":0}}}},{"2":{"Name":"TableFieldWells","Properties":{"TableAggregatedFieldWells":{"Type":2313,"Flags":0},"TableUnaggregatedFieldWells":{"Type":2344,"Flags":0}}}},{"2":{"Name":"TableInlineVisualization","Properties":{"DataBars":{"Type":1940,"Flags":0}}}},{"2":{"Name":"TableOptions","Properties":{"CellStyle":{"Type":2319,"Flags":0},"HeaderStyle":{"Type":2319,"Flags":0},"Orientation":{"Type":4,"Flags":0},"RowAlternateColorOptions":{"Type":2252,"Flags":0}}}},{"2":{"Name":"TableOrientation"}},{"2":{"Name":"TablePaginatedReportOptions","Properties":{"OverflowColumnHeaderVisibility":{"Type":4,"Flags":0},"VerticalOverflowVisibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"TablePinnedFieldOptions","Properties":{"PinnedLeftFields":{"Type":2610,"Flags":0}}}},{"2":{"Name":"TableRowConditionalFormatting","Properties":{"BackgroundColor":{"Type":1913,"Flags":0},"TextColor":{"Type":1913,"Flags":0}}}},{"2":{"Name":"TableSideBorderOptions","Properties":{"Bottom":{"Type":2314,"Flags":0},"InnerHorizontal":{"Type":2314,"Flags":0},"InnerVertical":{"Type":2314,"Flags":0},"Left":{"Type":2314,"Flags":0},"Right":{"Type":2314,"Flags":0},"Top":{"Type":2314,"Flags":0}}}},{"2":{"Name":"TableSortConfiguration","Properties":{"PaginationConfiguration":{"Type":2164,"Flags":0},"RowSort":{"Type":2611,"Flags":0}}}},{"2":{"Name":"TableStyleTarget","Properties":{"CellType":{"Type":4,"Flags":1}}}},{"2":{"Name":"TableTotalsPlacement"}},{"2":{"Name":"TableTotalsScrollStatus"}},{"2":{"Name":"TableUnaggregatedFieldWells","Properties":{"Values":{"Type":2612,"Flags":0}}}},{"2":{"Name":"TableVisual","Properties":{"Actions":{"Type":2613,"Flags":0},"ChartConfiguration":{"Type":2322,"Flags":0},"ConditionalFormatting":{"Type":2320,"Flags":0},"Subtitle":{"Type":2399,"Flags":0},"Title":{"Type":2400,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"TargetVisualOptions"}},{"2":{"Name":"TemplateError","Properties":{"Message":{"Type":4,"Flags":0},"Type":{"Type":4,"Flags":0},"ViolatedEntities":{"Type":2614,"Flags":0}}}},{"2":{"Name":"TemplateErrorType"}},{"2":{"Name":"TemplateSourceAnalysis","Properties":{"Arn":{"Type":4,"Flags":1},"DataSetReferences":{"Type":2615,"Flags":1}}}},{"2":{"Name":"TemplateSourceEntity","Properties":{"SourceAnalysis":{"Type":2350,"Flags":0},"SourceTemplate":{"Type":2352,"Flags":0}}}},{"2":{"Name":"TemplateSourceTemplate","Properties":{"Arn":{"Type":4,"Flags":1}}}},{"2":{"Name":"TemplateVersion","Properties":{"CreatedTime":{"Type":4,"Flags":0},"DataSetConfigurations":{"Type":2616,"Flags":0},"Description":{"Type":4,"Flags":0},"Errors":{"Type":2617,"Flags":0},"Sheets":{"Type":2618,"Flags":0},"SourceEntityArn":{"Type":4,"Flags":0},"Status":{"Type":4,"Flags":0},"ThemeArn":{"Type":4,"Flags":0},"VersionNumber":{"Type":3,"Flags":0}}}},{"2":{"Name":"TemplateVersionDefinition","Properties":{"AnalysisDefaults":{"Type":1834,"Flags":0},"CalculatedFields":{"Type":2619,"Flags":0},"ColumnConfigurations":{"Type":2620,"Flags":0},"DataSetConfigurations":{"Type":2621,"Flags":1},"FilterGroups":{"Type":2622,"Flags":0},"Options":{"Type":1843,"Flags":0},"ParameterDeclarations":{"Type":2623,"Flags":0},"Sheets":{"Type":2624,"Flags":0}}}},{"2":{"Name":"TextAreaControlDisplayOptions","Properties":{"InfoIconLabelOptions":{"Type":2284,"Flags":0},"PlaceholderOptions":{"Type":2357,"Flags":0},"TitleOptions":{"Type":2108,"Flags":0}}}},{"2":{"Name":"TextConditionalFormat","Properties":{"BackgroundColor":{"Type":1913,"Flags":0},"Icon":{"Type":1917,"Flags":0},"TextColor":{"Type":1913,"Flags":0}}}},{"2":{"Name":"TextControlPlaceholderOptions","Properties":{"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"TextFieldControlDisplayOptions","Properties":{"InfoIconLabelOptions":{"Type":2284,"Flags":0},"PlaceholderOptions":{"Type":2357,"Flags":0},"TitleOptions":{"Type":2108,"Flags":0}}}},{"2":{"Name":"TextWrap"}},{"2":{"Name":"ThousandSeparatorOptions","Properties":{"Symbol":{"Type":4,"Flags":0},"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"TimeBasedForecastProperties","Properties":{"LowerBoundary":{"Type":3,"Flags":0},"PeriodsBackward":{"Type":3,"Flags":0},"PeriodsForward":{"Type":3,"Flags":0},"PredictionInterval":{"Type":3,"Flags":0},"Seasonality":{"Type":3,"Flags":0},"UpperBoundary":{"Type":3,"Flags":0}}}},{"2":{"Name":"TimeEqualityFilter","Properties":{"Column":{"Type":1899,"Flags":1},"FilterId":{"Type":4,"Flags":1},"ParameterName":{"Type":4,"Flags":0},"RollingDate":{"Type":2251,"Flags":0},"TimeGranularity":{"Type":4,"Flags":0},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"TimeGranularity"}},{"2":{"Name":"TimeRangeDrillDownFilter","Properties":{"Column":{"Type":1899,"Flags":1},"RangeMaximum":{"Type":4,"Flags":1},"RangeMinimum":{"Type":4,"Flags":1},"TimeGranularity":{"Type":4,"Flags":1}}}},{"2":{"Name":"TimeRangeFilter","Properties":{"Column":{"Type":1899,"Flags":1},"ExcludePeriodConfiguration":{"Type":1986,"Flags":0},"FilterId":{"Type":4,"Flags":1},"IncludeMaximum":{"Type":2,"Flags":0},"IncludeMinimum":{"Type":2,"Flags":0},"NullOption":{"Type":4,"Flags":1},"RangeMaximumValue":{"Type":2366,"Flags":0},"RangeMinimumValue":{"Type":2366,"Flags":0},"TimeGranularity":{"Type":4,"Flags":0}}}},{"2":{"Name":"TimeRangeFilterValue","Properties":{"Parameter":{"Type":4,"Flags":0},"RollingDate":{"Type":2251,"Flags":0},"StaticValue":{"Type":4,"Flags":0}}}},{"2":{"Name":"TooltipItem","Properties":{"ColumnTooltipItem":{"Type":1903,"Flags":0},"FieldTooltipItem":{"Type":1993,"Flags":0}}}},{"2":{"Name":"TooltipOptions","Properties":{"FieldBasedTooltip":{"Type":1988,"Flags":0},"SelectedTooltipType":{"Type":4,"Flags":0},"TooltipVisibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"TooltipTitleType"}},{"2":{"Name":"TopBottomComputationType"}},{"2":{"Name":"TopBottomFilter","Properties":{"AggregationSortConfigurations":{"Type":2625,"Flags":1},"Column":{"Type":1899,"Flags":1},"FilterId":{"Type":4,"Flags":1},"Limit":{"Type":3,"Flags":0},"ParameterName":{"Type":4,"Flags":0},"TimeGranularity":{"Type":4,"Flags":0}}}},{"2":{"Name":"TopBottomMoversComputation","Properties":{"Category":{"Type":1978,"Flags":0},"ComputationId":{"Type":4,"Flags":1},"MoverSize":{"Type":3,"Flags":0},"Name":{"Type":4,"Flags":0},"SortOrder":{"Type":4,"Flags":0},"Time":{"Type":1978,"Flags":0},"Type":{"Type":4,"Flags":1},"Value":{"Type":2139,"Flags":0}}}},{"2":{"Name":"TopBottomRankedComputation","Properties":{"Category":{"Type":1978,"Flags":0},"ComputationId":{"Type":4,"Flags":1},"Name":{"Type":4,"Flags":0},"ResultSize":{"Type":3,"Flags":0},"Type":{"Type":4,"Flags":1},"Value":{"Type":2139,"Flags":0}}}},{"2":{"Name":"TopBottomSortOrder"}},{"2":{"Name":"TotalAggregationComputation","Properties":{"ComputationId":{"Type":4,"Flags":1},"Name":{"Type":4,"Flags":0},"Value":{"Type":2139,"Flags":0}}}},{"2":{"Name":"TotalAggregationFunction","Properties":{"SimpleTotalAggregationFunction":{"Type":4,"Flags":0}}}},{"2":{"Name":"TotalAggregationOption","Properties":{"FieldId":{"Type":4,"Flags":1},"TotalAggregationFunction":{"Type":2376,"Flags":1}}}},{"2":{"Name":"TotalOptions","Properties":{"CustomLabel":{"Type":4,"Flags":0},"Placement":{"Type":4,"Flags":0},"ScrollStatus":{"Type":4,"Flags":0},"TotalAggregationOptions":{"Type":2626,"Flags":0},"TotalCellStyle":{"Type":2319,"Flags":0},"TotalsVisibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"TreeMapAggregatedFieldWells","Properties":{"Colors":{"Type":2627,"Flags":0},"Groups":{"Type":2628,"Flags":0},"Sizes":{"Type":2629,"Flags":0}}}},{"2":{"Name":"TreeMapConfiguration","Properties":{"ColorLabelOptions":{"Type":1889,"Flags":0},"ColorScale":{"Type":1893,"Flags":0},"DataLabels":{"Type":1944,"Flags":0},"FieldWells":{"Type":2381,"Flags":0},"GroupLabelOptions":{"Type":1889,"Flags":0},"Legend":{"Type":2112,"Flags":0},"SizeLabelOptions":{"Type":1889,"Flags":0},"SortConfiguration":{"Type":2382,"Flags":0},"Tooltip":{"Type":2368,"Flags":0}}}},{"2":{"Name":"TreeMapFieldWells","Properties":{"TreeMapAggregatedFieldWells":{"Type":2379,"Flags":0}}}},{"2":{"Name":"TreeMapSortConfiguration","Properties":{"TreeMapGroupItemsLimitConfiguration":{"Type":2091,"Flags":0},"TreeMapSort":{"Type":2630,"Flags":0}}}},{"2":{"Name":"TreeMapVisual","Properties":{"Actions":{"Type":2631,"Flags":0},"ChartConfiguration":{"Type":2380,"Flags":0},"ColumnHierarchies":{"Type":2632,"Flags":0},"Subtitle":{"Type":2399,"Flags":0},"Title":{"Type":2400,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"TrendArrowOptions","Properties":{"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"URLTargetConfiguration"}},{"2":{"Name":"UnaggregatedField","Properties":{"Column":{"Type":1899,"Flags":1},"FieldId":{"Type":4,"Flags":1},"FormatConfiguration":{"Type":2029,"Flags":0}}}},{"2":{"Name":"UniqueValuesComputation","Properties":{"Category":{"Type":1978,"Flags":0},"ComputationId":{"Type":4,"Flags":1},"Name":{"Type":4,"Flags":0}}}},{"2":{"Name":"ValidationStrategy","Properties":{"Mode":{"Type":4,"Flags":1}}}},{"2":{"Name":"ValidationStrategyMode"}},{"2":{"Name":"ValueWhenUnsetOption"}},{"2":{"Name":"VerticalTextAlignment"}},{"2":{"Name":"Visibility"}},{"2":{"Name":"VisibleRangeOptions","Properties":{"PercentRange":{"Type":2180,"Flags":0}}}},{"2":{"Name":"Visual","Properties":{"BarChartVisual":{"Type":1862,"Flags":0},"BoxPlotVisual":{"Type":1876,"Flags":0},"ComboChartVisual":{"Type":1908,"Flags":0},"CustomContentVisual":{"Type":1934,"Flags":0},"EmptyVisual":{"Type":1984,"Flags":0},"FilledMapVisual":{"Type":2001,"Flags":0},"FunnelChartVisual":{"Type":2043,"Flags":0},"GaugeChartVisual":{"Type":2051,"Flags":0},"GeospatialMapVisual":{"Type":2060,"Flags":0},"HeatMapVisual":{"Type":2077,"Flags":0},"HistogramVisual":{"Type":2083,"Flags":0},"InsightVisual":{"Type":2087,"Flags":0},"KPIVisual":{"Type":2104,"Flags":0},"LineChartVisual":{"Type":2125,"Flags":0},"PieChartVisual":{"Type":2189,"Flags":0},"PivotTableVisual":{"Type":2216,"Flags":0},"RadarChartVisual":{"Type":2229,"Flags":0},"SankeyDiagramVisual":{"Type":2258,"Flags":0},"ScatterPlotVisual":{"Type":2263,"Flags":0},"TableVisual":{"Type":2345,"Flags":0},"TreeMapVisual":{"Type":2383,"Flags":0},"WaterfallVisual":{"Type":2406,"Flags":0},"WordCloudVisual":{"Type":2416,"Flags":0}}}},{"2":{"Name":"VisualCustomAction","Properties":{"ActionOperations":{"Type":2633,"Flags":1},"CustomActionId":{"Type":4,"Flags":1},"Name":{"Type":4,"Flags":1},"Status":{"Type":4,"Flags":0},"Trigger":{"Type":4,"Flags":1}}}},{"2":{"Name":"VisualCustomActionOperation","Properties":{"FilterOperation":{"Type":1926,"Flags":0},"NavigationOperation":{"Type":1927,"Flags":0},"SetParametersOperation":{"Type":1928,"Flags":0},"URLOperation":{"Type":1929,"Flags":0}}}},{"2":{"Name":"VisualCustomActionTrigger"}},{"2":{"Name":"VisualPalette","Properties":{"ChartColor":{"Type":4,"Flags":0},"ColorMap":{"Type":2634,"Flags":0}}}},{"2":{"Name":"VisualSubtitleLabelOptions","Properties":{"FormatText":{"Type":2133,"Flags":0},"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"VisualTitleLabelOptions","Properties":{"FormatText":{"Type":2294,"Flags":0},"Visibility":{"Type":4,"Flags":0}}}},{"2":{"Name":"WaterfallChartAggregatedFieldWells","Properties":{"Breakdowns":{"Type":2635,"Flags":0},"Categories":{"Type":2636,"Flags":0},"Values":{"Type":2637,"Flags":0}}}},{"2":{"Name":"WaterfallChartConfiguration","Properties":{"CategoryAxisDisplayOptions":{"Type":1849,"Flags":0},"CategoryAxisLabelOptions":{"Type":1889,"Flags":0},"DataLabels":{"Type":1944,"Flags":0},"FieldWells":{"Type":2403,"Flags":0},"Legend":{"Type":2112,"Flags":0},"PrimaryYAxisDisplayOptions":{"Type":1849,"Flags":0},"PrimaryYAxisLabelOptions":{"Type":1889,"Flags":0},"SortConfiguration":{"Type":2405,"Flags":0},"VisualPalette":{"Type":2398,"Flags":0},"WaterfallChartOptions":{"Type":2404,"Flags":0}}}},{"2":{"Name":"WaterfallChartFieldWells","Properties":{"WaterfallChartAggregatedFieldWells":{"Type":2401,"Flags":0}}}},{"2":{"Name":"WaterfallChartOptions","Properties":{"TotalBarLabel":{"Type":4,"Flags":0}}}},{"2":{"Name":"WaterfallChartSortConfiguration","Properties":{"BreakdownItemsLimit":{"Type":2091,"Flags":0},"CategorySort":{"Type":2638,"Flags":0}}}},{"2":{"Name":"WaterfallVisual","Properties":{"Actions":{"Type":2639,"Flags":0},"ChartConfiguration":{"Type":2402,"Flags":0},"ColumnHierarchies":{"Type":2640,"Flags":0},"Subtitle":{"Type":2399,"Flags":0},"Title":{"Type":2400,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"WhatIfPointScenario","Properties":{"Date":{"Type":4,"Flags":1},"Value":{"Type":3,"Flags":1}}}},{"2":{"Name":"WhatIfRangeScenario","Properties":{"EndDate":{"Type":4,"Flags":1},"StartDate":{"Type":4,"Flags":1},"Value":{"Type":3,"Flags":1}}}},{"2":{"Name":"WidgetStatus"}},{"2":{"Name":"WordCloudAggregatedFieldWells","Properties":{"GroupBy":{"Type":2641,"Flags":0},"Size":{"Type":2642,"Flags":0}}}},{"2":{"Name":"WordCloudChartConfiguration","Properties":{"CategoryLabelOptions":{"Type":1889,"Flags":0},"FieldWells":{"Type":2413,"Flags":0},"SortConfiguration":{"Type":2415,"Flags":0},"WordCloudOptions":{"Type":2414,"Flags":0}}}},{"2":{"Name":"WordCloudCloudLayout"}},{"2":{"Name":"WordCloudFieldWells","Properties":{"WordCloudAggregatedFieldWells":{"Type":2410,"Flags":0}}}},{"2":{"Name":"WordCloudOptions","Properties":{"CloudLayout":{"Type":4,"Flags":0},"MaximumStringLength":{"Type":3,"Flags":0},"WordCasing":{"Type":4,"Flags":0},"WordOrientation":{"Type":4,"Flags":0},"WordPadding":{"Type":4,"Flags":0},"WordScaling":{"Type":4,"Flags":0}}}},{"2":{"Name":"WordCloudSortConfiguration","Properties":{"CategoryItemsLimit":{"Type":2091,"Flags":0},"CategorySort":{"Type":2643,"Flags":0}}}},{"2":{"Name":"WordCloudVisual","Properties":{"Actions":{"Type":2644,"Flags":0},"ChartConfiguration":{"Type":2411,"Flags":0},"ColumnHierarchies":{"Type":2645,"Flags":0},"Subtitle":{"Type":2399,"Flags":0},"Title":{"Type":2400,"Flags":0},"VisualId":{"Type":4,"Flags":1}}}},{"2":{"Name":"WordCloudWordCasing"}},{"2":{"Name":"WordCloudWordOrientation"}},{"2":{"Name":"WordCloudWordPadding"}},{"2":{"Name":"WordCloudWordScaling"}},{"3":{"ItemType":1978}},{"3":{"ItemType":1978}},{"3":{"ItemType":1978}},{"3":{"ItemType":2139}},{"3":{"ItemType":1923}},{"3":{"ItemType":2231}},{"3":{"ItemType":1992}},{"3":{"ItemType":1992}},{"3":{"ItemType":1992}},{"3":{"ItemType":2395}},{"3":{"ItemType":1898}},{"3":{"ItemType":1978}},{"3":{"ItemType":2139}},{"3":{"ItemType":2231}},{"3":{"ItemType":1992}},{"3":{"ItemType":2395}},{"3":{"ItemType":1898}},{"3":{"ItemType":1880}},{"3":{"ItemType":4}},{"3":{"ItemType":1851}},{"3":{"ItemType":1941}},{"3":{"ItemType":1930}},{"3":{"ItemType":1896}},{"3":{"ItemType":2139}},{"3":{"ItemType":1978}},{"3":{"ItemType":1978}},{"3":{"ItemType":2139}},{"3":{"ItemType":2231}},{"3":{"ItemType":1992}},{"3":{"ItemType":1992}},{"3":{"ItemType":2395}},{"3":{"ItemType":1898}},{"3":{"ItemType":1899}},{"3":{"ItemType":2279}},{"3":{"ItemType":2395}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":3}},{"3":{"ItemType":3}},{"3":{"ItemType":4}},{"3":{"ItemType":1947}},{"3":{"ItemType":1952}},{"3":{"ItemType":1897}},{"3":{"ItemType":1901}},{"3":{"ItemType":4}},{"3":{"ItemType":1981}},{"3":{"ItemType":2135}},{"3":{"ItemType":3}},{"3":{"ItemType":2135}},{"3":{"ItemType":2395}},{"3":{"ItemType":1899}},{"3":{"ItemType":1981}},{"3":{"ItemType":2367}},{"3":{"ItemType":1978}},{"3":{"ItemType":2139}},{"3":{"ItemType":1996}},{"3":{"ItemType":1992}},{"3":{"ItemType":2395}},{"3":{"ItemType":1898}},{"3":{"ItemType":2002}},{"3":{"ItemType":4}},{"3":{"ItemType":1899}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":2032}},{"3":{"ItemType":2291}},{"3":{"ItemType":2032}},{"3":{"ItemType":1978}},{"3":{"ItemType":2139}},{"3":{"ItemType":1992}},{"3":{"ItemType":2395}},{"3":{"ItemType":1898}},{"3":{"ItemType":2046}},{"3":{"ItemType":2139}},{"3":{"ItemType":2139}},{"3":{"ItemType":2395}},{"3":{"ItemType":2055}},{"3":{"ItemType":1978}},{"3":{"ItemType":1978}},{"3":{"ItemType":2139}},{"3":{"ItemType":2395}},{"3":{"ItemType":1898}},{"3":{"ItemType":2066}},{"3":{"ItemType":2069}},{"3":{"ItemType":1978}},{"3":{"ItemType":1978}},{"3":{"ItemType":2139}},{"3":{"ItemType":1992}},{"3":{"ItemType":1992}},{"3":{"ItemType":2395}},{"3":{"ItemType":1898}},{"3":{"ItemType":2139}},{"3":{"ItemType":2395}},{"3":{"ItemType":1912}},{"3":{"ItemType":2395}},{"3":{"ItemType":3}},{"3":{"ItemType":2135}},{"3":{"ItemType":2095}},{"3":{"ItemType":2139}},{"3":{"ItemType":1978}},{"3":{"ItemType":2139}},{"3":{"ItemType":1992}},{"3":{"ItemType":2395}},{"3":{"ItemType":1898}},{"3":{"ItemType":1978}},{"3":{"ItemType":1978}},{"3":{"ItemType":1978}},{"3":{"ItemType":2139}},{"3":{"ItemType":1923}},{"3":{"ItemType":2027}},{"3":{"ItemType":2231}},{"3":{"ItemType":2278}},{"3":{"ItemType":1992}},{"3":{"ItemType":1992}},{"3":{"ItemType":2395}},{"3":{"ItemType":1898}},{"3":{"ItemType":2142}},{"3":{"ItemType":4}},{"3":{"ItemType":1978}},{"3":{"ItemType":1978}},{"3":{"ItemType":2139}},{"3":{"ItemType":1923}},{"3":{"ItemType":1992}},{"3":{"ItemType":1992}},{"3":{"ItemType":2395}},{"3":{"ItemType":1898}},{"3":{"ItemType":1978}},{"3":{"ItemType":1978}},{"3":{"ItemType":2139}},{"3":{"ItemType":2195}},{"3":{"ItemType":2194}},{"3":{"ItemType":1952}},{"3":{"ItemType":1952}},{"3":{"ItemType":2201}},{"3":{"ItemType":2198}},{"3":{"ItemType":2203}},{"3":{"ItemType":2190}},{"3":{"ItemType":2395}},{"3":{"ItemType":2377}},{"3":{"ItemType":1899}},{"3":{"ItemType":1981}},{"3":{"ItemType":1978}},{"3":{"ItemType":1978}},{"3":{"ItemType":2139}},{"3":{"ItemType":1992}},{"3":{"ItemType":1992}},{"3":{"ItemType":2395}},{"3":{"ItemType":1898}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":1978}},{"3":{"ItemType":1978}},{"3":{"ItemType":2139}},{"3":{"ItemType":1992}},{"3":{"ItemType":2395}},{"3":{"ItemType":1978}},{"3":{"ItemType":1978}},{"3":{"ItemType":2139}},{"3":{"ItemType":2139}},{"3":{"ItemType":2139}},{"3":{"ItemType":1978}},{"3":{"ItemType":1978}},{"3":{"ItemType":2139}},{"3":{"ItemType":1978}},{"3":{"ItemType":1978}},{"3":{"ItemType":2395}},{"3":{"ItemType":1898}},{"3":{"ItemType":1867}},{"3":{"ItemType":2072}},{"3":{"ItemType":2072}},{"3":{"ItemType":2293}},{"3":{"ItemType":2003}},{"3":{"ItemType":2109}},{"3":{"ItemType":2170}},{"3":{"ItemType":2285}},{"3":{"ItemType":2292}},{"3":{"ItemType":2394}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":2135}},{"3":{"ItemType":2205}},{"3":{"ItemType":2341}},{"3":{"ItemType":1978}},{"3":{"ItemType":2139}},{"3":{"ItemType":2321}},{"3":{"ItemType":2333}},{"3":{"ItemType":4}},{"3":{"ItemType":2329}},{"3":{"ItemType":4}},{"3":{"ItemType":1992}},{"3":{"ItemType":2386}},{"3":{"ItemType":2395}},{"3":{"ItemType":1985}},{"3":{"ItemType":1954}},{"3":{"ItemType":1953}},{"3":{"ItemType":2348}},{"3":{"ItemType":2281}},{"3":{"ItemType":1877}},{"3":{"ItemType":1895}},{"3":{"ItemType":1953}},{"3":{"ItemType":2006}},{"3":{"ItemType":2172}},{"3":{"ItemType":2289}},{"3":{"ItemType":1832}},{"3":{"ItemType":2377}},{"3":{"ItemType":2139}},{"3":{"ItemType":1978}},{"3":{"ItemType":2139}},{"3":{"ItemType":1992}},{"3":{"ItemType":2395}},{"3":{"ItemType":1898}},{"3":{"ItemType":2396}},{"3":{"ItemType":1948}},{"3":{"ItemType":1978}},{"3":{"ItemType":1978}},{"3":{"ItemType":2139}},{"3":{"ItemType":1992}},{"3":{"ItemType":2395}},{"3":{"ItemType":1898}},{"3":{"ItemType":1978}},{"3":{"ItemType":2139}},{"3":{"ItemType":1992}},{"3":{"ItemType":2395}},{"3":{"ItemType":1898}},{"2":{"Name":"AWS.QuickSight/TemplateProperties","Properties":{"Arn":{"Type":4,"Flags":2},"AwsAccountId":{"Type":4,"Flags":17},"CreatedTime":{"Type":4,"Flags":2},"Definition":{"Type":2354,"Flags":4},"LastUpdatedTime":{"Type":4,"Flags":2},"Name":{"Type":4,"Flags":0},"Permissions":{"Type":2647,"Flags":0},"SourceEntity":{"Type":2351,"Flags":4},"Tags":{"Type":2648,"Flags":0},"TemplateId":{"Type":4,"Flags":17},"ValidationStrategy":{"Type":2388,"Flags":4},"Version":{"Type":2353,"Flags":2},"VersionDescription":{"Type":4,"Flags":4}}}},{"3":{"ItemType":2249}},{"3":{"ItemType":2346}},{"2":{"Name":"AWS.QuickSight/Template","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":2646,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.QuickSight/Template@default","ScopeType":0,"Body":2649}},{"2":{"Name":"BorderStyle","Properties":{"Show":{"Type":2,"Flags":0}}}},{"2":{"Name":"DataColorPalette","Properties":{"Colors":{"Type":2669,"Flags":0},"EmptyFillColor":{"Type":4,"Flags":0},"MinMaxGradient":{"Type":2670,"Flags":0}}}},{"2":{"Name":"Font","Properties":{"FontFamily":{"Type":4,"Flags":0}}}},{"2":{"Name":"GutterStyle","Properties":{"Show":{"Type":2,"Flags":0}}}},{"2":{"Name":"MarginStyle","Properties":{"Show":{"Type":2,"Flags":0}}}},{"2":{"Name":"ResourcePermission","Properties":{"Actions":{"Type":2671,"Flags":1},"Principal":{"Type":4,"Flags":1}}}},{"2":{"Name":"ResourceStatus"}},{"2":{"Name":"SheetStyle","Properties":{"Tile":{"Type":2666,"Flags":0},"TileLayout":{"Type":2665,"Flags":0}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"ThemeConfiguration","Properties":{"DataColorPalette":{"Type":2652,"Flags":0},"Sheet":{"Type":2658,"Flags":0},"Typography":{"Type":2667,"Flags":0},"UIColorPalette":{"Type":2668,"Flags":0}}}},{"2":{"Name":"ThemeError","Properties":{"Message":{"Type":4,"Flags":0},"Type":{"Type":4,"Flags":0}}}},{"2":{"Name":"ThemeErrorType"}},{"2":{"Name":"ThemeType"}},{"2":{"Name":"ThemeVersion","Properties":{"Arn":{"Type":4,"Flags":0},"BaseThemeId":{"Type":4,"Flags":0},"Configuration":{"Type":2660,"Flags":0},"CreatedTime":{"Type":4,"Flags":0},"Description":{"Type":4,"Flags":0},"Errors":{"Type":2672,"Flags":0},"Status":{"Type":4,"Flags":0},"VersionNumber":{"Type":3,"Flags":0}}}},{"2":{"Name":"TileLayoutStyle","Properties":{"Gutter":{"Type":2654,"Flags":0},"Margin":{"Type":2655,"Flags":0}}}},{"2":{"Name":"TileStyle","Properties":{"Border":{"Type":2651,"Flags":0}}}},{"2":{"Name":"Typography","Properties":{"FontFamilies":{"Type":2673,"Flags":0}}}},{"2":{"Name":"UIColorPalette","Properties":{"Accent":{"Type":4,"Flags":0},"AccentForeground":{"Type":4,"Flags":0},"Danger":{"Type":4,"Flags":0},"DangerForeground":{"Type":4,"Flags":0},"Dimension":{"Type":4,"Flags":0},"DimensionForeground":{"Type":4,"Flags":0},"Measure":{"Type":4,"Flags":0},"MeasureForeground":{"Type":4,"Flags":0},"PrimaryBackground":{"Type":4,"Flags":0},"PrimaryForeground":{"Type":4,"Flags":0},"SecondaryBackground":{"Type":4,"Flags":0},"SecondaryForeground":{"Type":4,"Flags":0},"Success":{"Type":4,"Flags":0},"SuccessForeground":{"Type":4,"Flags":0},"Warning":{"Type":4,"Flags":0},"WarningForeground":{"Type":4,"Flags":0}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":2661}},{"3":{"ItemType":2653}},{"2":{"Name":"AWS.QuickSight/ThemeProperties","Properties":{"Arn":{"Type":4,"Flags":2},"AwsAccountId":{"Type":4,"Flags":17},"BaseThemeId":{"Type":4,"Flags":5},"Configuration":{"Type":2660,"Flags":5},"CreatedTime":{"Type":4,"Flags":2},"LastUpdatedTime":{"Type":4,"Flags":2},"Name":{"Type":4,"Flags":1},"Permissions":{"Type":2675,"Flags":0},"Tags":{"Type":2676,"Flags":0},"ThemeId":{"Type":4,"Flags":17},"Type":{"Type":4,"Flags":2},"Version":{"Type":2664,"Flags":2},"VersionDescription":{"Type":4,"Flags":4}}}},{"3":{"ItemType":2656}},{"3":{"ItemType":2659}},{"2":{"Name":"AWS.QuickSight/Theme","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":2674,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.QuickSight/Theme@default","ScopeType":0,"Body":2677}},{"2":{"Name":"AggregationFunctionParameters","Properties":{}}},{"2":{"Name":"AuthorSpecifiedAggregation"}},{"2":{"Name":"CategoryFilterFunction"}},{"2":{"Name":"CategoryFilterType"}},{"2":{"Name":"CellValueSynonym","Properties":{"CellValue":{"Type":4,"Flags":0},"Synonyms":{"Type":2726,"Flags":0}}}},{"2":{"Name":"CollectiveConstant","Properties":{"ValueList":{"Type":2727,"Flags":0}}}},{"2":{"Name":"ColumnDataRole"}},{"2":{"Name":"ColumnOrderingType"}},{"2":{"Name":"ComparativeOrder","Properties":{"SpecifedOrder":{"Type":2728,"Flags":0},"TreatUndefinedSpecifiedValues":{"Type":4,"Flags":0},"UseOrdering":{"Type":4,"Flags":0}}}},{"2":{"Name":"ConstantType"}},{"2":{"Name":"DataAggregation","Properties":{"DatasetRowDateGranularity":{"Type":4,"Flags":0},"DefaultDateColumnName":{"Type":4,"Flags":0}}}},{"2":{"Name":"DatasetMetadata","Properties":{"CalculatedFields":{"Type":2729,"Flags":0},"Columns":{"Type":2730,"Flags":0},"DataAggregation":{"Type":2689,"Flags":0},"DatasetArn":{"Type":4,"Flags":1},"DatasetDescription":{"Type":4,"Flags":0},"DatasetName":{"Type":4,"Flags":0},"Filters":{"Type":2731,"Flags":0},"NamedEntities":{"Type":2732,"Flags":0}}}},{"2":{"Name":"DefaultAggregation"}},{"2":{"Name":"DefaultFormatting","Properties":{"DisplayFormat":{"Type":4,"Flags":0},"DisplayFormatOptions":{"Type":2694,"Flags":0}}}},{"2":{"Name":"DisplayFormat"}},{"2":{"Name":"DisplayFormatOptions","Properties":{"BlankCellFormat":{"Type":4,"Flags":0},"CurrencySymbol":{"Type":4,"Flags":0},"DateFormat":{"Type":4,"Flags":0},"DecimalSeparator":{"Type":4,"Flags":0},"FractionDigits":{"Type":3,"Flags":0},"GroupingSeparator":{"Type":4,"Flags":0},"NegativeFormat":{"Type":2701,"Flags":0},"Prefix":{"Type":4,"Flags":0},"Suffix":{"Type":4,"Flags":0},"UnitScaler":{"Type":4,"Flags":0},"UseBlankCellFormat":{"Type":2,"Flags":0},"UseGrouping":{"Type":2,"Flags":0}}}},{"2":{"Name":"FilterClass"}},{"2":{"Name":"NamedEntityAggType"}},{"2":{"Name":"NamedEntityDefinition","Properties":{"FieldName":{"Type":4,"Flags":0},"Metric":{"Type":2698,"Flags":0},"PropertyName":{"Type":4,"Flags":0},"PropertyRole":{"Type":4,"Flags":0},"PropertyUsage":{"Type":4,"Flags":0}}}},{"2":{"Name":"NamedEntityDefinitionMetric","Properties":{"Aggregation":{"Type":4,"Flags":0},"AggregationFunctionParameters":{"Type":2679,"Flags":0}}}},{"2":{"Name":"NamedFilterAggType"}},{"2":{"Name":"NamedFilterType"}},{"2":{"Name":"NegativeFormat","Properties":{"Prefix":{"Type":4,"Flags":0},"Suffix":{"Type":4,"Flags":0}}}},{"2":{"Name":"NumberScale"}},{"2":{"Name":"PropertyRole"}},{"2":{"Name":"PropertyUsage"}},{"2":{"Name":"RangeConstant","Properties":{"Maximum":{"Type":4,"Flags":0},"Minimum":{"Type":4,"Flags":0}}}},{"2":{"Name":"SemanticEntityType","Properties":{"SubTypeName":{"Type":4,"Flags":0},"TypeName":{"Type":4,"Flags":0},"TypeParameters":{"Type":2724,"Flags":0}}}},{"2":{"Name":"SemanticType","Properties":{"FalseyCellValue":{"Type":4,"Flags":0},"FalseyCellValueSynonyms":{"Type":2733,"Flags":0},"SubTypeName":{"Type":4,"Flags":0},"TruthyCellValue":{"Type":4,"Flags":0},"TruthyCellValueSynonyms":{"Type":2734,"Flags":0},"TypeName":{"Type":4,"Flags":0},"TypeParameters":{"Type":2724,"Flags":0}}}},{"2":{"Name":"TopicCalculatedField","Properties":{"Aggregation":{"Type":4,"Flags":0},"AllowedAggregations":{"Type":2735,"Flags":0},"CalculatedFieldDescription":{"Type":4,"Flags":0},"CalculatedFieldName":{"Type":4,"Flags":1},"CalculatedFieldSynonyms":{"Type":2736,"Flags":0},"CellValueSynonyms":{"Type":2737,"Flags":0},"ColumnDataRole":{"Type":4,"Flags":0},"ComparativeOrder":{"Type":2687,"Flags":0},"DefaultFormatting":{"Type":2692,"Flags":0},"Expression":{"Type":4,"Flags":1},"IsIncludedInTopic":{"Type":2,"Flags":0},"NeverAggregateInFilter":{"Type":2,"Flags":0},"NonAdditive":{"Type":2,"Flags":0},"NotAllowedAggregations":{"Type":2738,"Flags":0},"SemanticType":{"Type":2707,"Flags":0},"TimeGranularity":{"Type":4,"Flags":0}}}},{"2":{"Name":"TopicCategoryFilter","Properties":{"CategoryFilterFunction":{"Type":4,"Flags":0},"CategoryFilterType":{"Type":4,"Flags":0},"Constant":{"Type":2710,"Flags":0},"Inverse":{"Type":2,"Flags":0}}}},{"2":{"Name":"TopicCategoryFilterConstant","Properties":{"CollectiveConstant":{"Type":2684,"Flags":0},"ConstantType":{"Type":4,"Flags":0},"SingularConstant":{"Type":4,"Flags":0}}}},{"2":{"Name":"TopicColumn","Properties":{"Aggregation":{"Type":4,"Flags":0},"AllowedAggregations":{"Type":2739,"Flags":0},"CellValueSynonyms":{"Type":2740,"Flags":0},"ColumnDataRole":{"Type":4,"Flags":0},"ColumnDescription":{"Type":4,"Flags":0},"ColumnFriendlyName":{"Type":4,"Flags":0},"ColumnName":{"Type":4,"Flags":1},"ColumnSynonyms":{"Type":2741,"Flags":0},"ComparativeOrder":{"Type":2687,"Flags":0},"DefaultFormatting":{"Type":2692,"Flags":0},"IsIncludedInTopic":{"Type":2,"Flags":0},"NeverAggregateInFilter":{"Type":2,"Flags":0},"NonAdditive":{"Type":2,"Flags":0},"NotAllowedAggregations":{"Type":2742,"Flags":0},"SemanticType":{"Type":2707,"Flags":0},"TimeGranularity":{"Type":4,"Flags":0}}}},{"2":{"Name":"TopicDateRangeFilter","Properties":{"Constant":{"Type":2719,"Flags":0},"Inclusive":{"Type":2,"Flags":0}}}},{"2":{"Name":"TopicDetails","Properties":{"DataSets":{"Type":2743,"Flags":0},"Description":{"Type":4,"Flags":0},"Name":{"Type":4,"Flags":0}}}},{"2":{"Name":"TopicFilter","Properties":{"CategoryFilter":{"Type":2709,"Flags":0},"DateRangeFilter":{"Type":2712,"Flags":0},"FilterClass":{"Type":4,"Flags":0},"FilterDescription":{"Type":4,"Flags":0},"FilterName":{"Type":4,"Flags":1},"FilterSynonyms":{"Type":2744,"Flags":0},"FilterType":{"Type":4,"Flags":0},"NumericEqualityFilter":{"Type":2716,"Flags":0},"NumericRangeFilter":{"Type":2717,"Flags":0},"OperandFieldName":{"Type":4,"Flags":1},"RelativeDateFilter":{"Type":2720,"Flags":0}}}},{"2":{"Name":"TopicNamedEntity","Properties":{"Definition":{"Type":2745,"Flags":0},"EntityDescription":{"Type":4,"Flags":0},"EntityName":{"Type":4,"Flags":1},"EntitySynonyms":{"Type":2746,"Flags":0},"SemanticEntityType":{"Type":2706,"Flags":0}}}},{"2":{"Name":"TopicNumericEqualityFilter","Properties":{"Aggregation":{"Type":4,"Flags":0},"Constant":{"Type":2722,"Flags":0}}}},{"2":{"Name":"TopicNumericRangeFilter","Properties":{"Aggregation":{"Type":4,"Flags":0},"Constant":{"Type":2719,"Flags":0},"Inclusive":{"Type":2,"Flags":0}}}},{"2":{"Name":"TopicNumericSeparatorSymbol"}},{"2":{"Name":"TopicRangeFilterConstant","Properties":{"ConstantType":{"Type":4,"Flags":0},"RangeConstant":{"Type":2705,"Flags":0}}}},{"2":{"Name":"TopicRelativeDateFilter","Properties":{"Constant":{"Type":2722,"Flags":0},"RelativeDateFilterFunction":{"Type":4,"Flags":0},"TimeGranularity":{"Type":4,"Flags":0}}}},{"2":{"Name":"TopicRelativeDateFilterFunction"}},{"2":{"Name":"TopicSingularFilterConstant","Properties":{"ConstantType":{"Type":4,"Flags":0},"SingularConstant":{"Type":4,"Flags":0}}}},{"2":{"Name":"TopicTimeGranularity"}},{"2":{"Name":"TypeParameters","Properties":{}}},{"2":{"Name":"UndefinedSpecifiedValueType"}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":2708}},{"3":{"ItemType":2711}},{"3":{"ItemType":2714}},{"3":{"ItemType":2715}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":2683}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":2683}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":2690}},{"3":{"ItemType":4}},{"3":{"ItemType":2697}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.QuickSight/TopicProperties","Properties":{"Arn":{"Type":4,"Flags":2},"AwsAccountId":{"Type":4,"Flags":16},"DataSets":{"Type":2748,"Flags":0},"Description":{"Type":4,"Flags":0},"Name":{"Type":4,"Flags":0},"TopicId":{"Type":4,"Flags":16}}}},{"3":{"ItemType":2690}},{"2":{"Name":"AWS.QuickSight/Topic","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":2747,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.QuickSight/Topic@default","ScopeType":0,"Body":2749}},{"2":{"Name":"Arn"}},{"2":{"Name":"DnsResolvers"}},{"2":{"Name":"NetworkInterface","Properties":{"AvailabilityZone":{"Type":4,"Flags":0},"ErrorMessage":{"Type":4,"Flags":0},"NetworkInterfaceId":{"Type":4,"Flags":0},"Status":{"Type":4,"Flags":0},"SubnetId":{"Type":4,"Flags":0}}}},{"2":{"Name":"NetworkInterfaceId"}},{"2":{"Name":"NetworkInterfaces"}},{"2":{"Name":"RoleArn"}},{"2":{"Name":"SecurityGroupId"}},{"2":{"Name":"SecurityGroupIds"}},{"2":{"Name":"SubnetId"}},{"2":{"Name":"SubnetIds"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"Tags"}},{"2":{"Name":"VPCConnectionAvailabilityStatus"}},{"2":{"Name":"VPCConnectionId"}},{"2":{"Name":"VPCConnectionResourceStatus"}},{"2":{"Name":"VPCId"}},{"3":{"ItemType":4}},{"3":{"ItemType":2753}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":2761}},{"2":{"Name":"AWS.QuickSight/VPCConnectionProperties","Properties":{"Arn":{"Type":4,"Flags":2},"AvailabilityStatus":{"Type":4,"Flags":0},"AwsAccountId":{"Type":4,"Flags":16},"CreatedTime":{"Type":4,"Flags":2},"DnsResolvers":{"Type":2773,"Flags":0},"LastUpdatedTime":{"Type":4,"Flags":2},"Name":{"Type":4,"Flags":0},"NetworkInterfaces":{"Type":2774,"Flags":2},"RoleArn":{"Type":4,"Flags":0},"SecurityGroupIds":{"Type":2775,"Flags":0},"Status":{"Type":4,"Flags":2},"SubnetIds":{"Type":2776,"Flags":4},"Tags":{"Type":2777,"Flags":0},"VPCConnectionId":{"Type":4,"Flags":16},"VPCId":{"Type":4,"Flags":2}}}},{"3":{"ItemType":4}},{"3":{"ItemType":2753}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":2761}},{"2":{"Name":"AWS.QuickSight/VPCConnection","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":2772,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.QuickSight/VPCConnection@default","ScopeType":0,"Body":2778}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "AggregationFunction", + "properties": { + "AttributeAggregationFunction": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "CategoricalAggregationFunction": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "DateAggregationFunction": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "NumericalAggregationFunction": { + "type": { + "$ref": "#/343" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AggregationSortConfiguration", + "properties": { + "AggregationFunction": { + "type": { + "$ref": "#/0" + }, + "flags": 0 + }, + "Column": { + "type": { + "$ref": "#/71" + }, + "flags": 1 + }, + "SortDirection": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AllSheetsFilterScopeConfiguration", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AnalysisDefaults", + "properties": { + "DefaultNewSheetConfiguration": { + "type": { + "$ref": "#/151" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AnalysisDefinition", + "properties": { + "AnalysisDefaults": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "CalculatedFields": { + "type": { + "$ref": "#/602" + }, + "flags": 0 + }, + "ColumnConfigurations": { + "type": { + "$ref": "#/603" + }, + "flags": 0 + }, + "DataSetIdentifierDeclarations": { + "type": { + "$ref": "#/604" + }, + "flags": 1 + }, + "FilterGroups": { + "type": { + "$ref": "#/605" + }, + "flags": 0 + }, + "Options": { + "type": { + "$ref": "#/17" + }, + "flags": 0 + }, + "ParameterDeclarations": { + "type": { + "$ref": "#/606" + }, + "flags": 0 + }, + "Sheets": { + "type": { + "$ref": "#/607" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AnalysisError", + "properties": { + "Message": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The message associated with the analysis error.

" + }, + "Type": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ViolatedEntities": { + "type": { + "$ref": "#/608" + }, + "flags": 0, + "description": "

Lists the violated entities that caused the analysis error

" + } + } + }, + { + "$type": "ObjectType", + "name": "AnalysisErrorType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AnalysisSourceEntity", + "properties": { + "SourceTemplate": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AnalysisSourceTemplate", + "properties": { + "Arn": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

The Amazon Resource Name (ARN) of the source template of an analysis.

" + }, + "DataSetReferences": { + "type": { + "$ref": "#/609" + }, + "flags": 1, + "description": "

The dataset references of the source template of an analysis.

" + } + } + }, + { + "$type": "ObjectType", + "name": "AnchorDateConfiguration", + "properties": { + "AnchorOption": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ParameterName": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AnchorOption", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ArcAxisConfiguration", + "properties": { + "Range": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + }, + "ReserveRange": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ArcAxisDisplayRange", + "properties": { + "Max": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "Min": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ArcConfiguration", + "properties": { + "ArcAngle": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "ArcThickness": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ArcOptions", + "properties": { + "ArcThickness": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ArcThickness", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ArcThicknessOptions", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AssetOptions", + "properties": { + "Timezone": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "WeekStart": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AttributeAggregationFunction", + "properties": { + "SimpleAttributeAggregation": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ValueForMultipleValues": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AxisBinding", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AxisDataOptions", + "properties": { + "DateAxisOptions": { + "type": { + "$ref": "#/127" + }, + "flags": 0 + }, + "NumericAxisOptions": { + "type": { + "$ref": "#/333" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AxisDisplayDataDrivenRange", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AxisDisplayMinMaxRange", + "properties": { + "Maximum": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "Minimum": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AxisDisplayOptions", + "properties": { + "AxisLineVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "AxisOffset": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "String based length that is composed of value and unit in px" + }, + "DataOptions": { + "type": { + "$ref": "#/20" + }, + "flags": 0 + }, + "GridLineVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ScrollbarOptions": { + "type": { + "$ref": "#/448" + }, + "flags": 0 + }, + "TickLabelOptions": { + "type": { + "$ref": "#/30" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AxisDisplayRange", + "properties": { + "DataDriven": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "MinMax": { + "type": { + "$ref": "#/22" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AxisLabelOptions", + "properties": { + "ApplyTo": { + "type": { + "$ref": "#/26" + }, + "flags": 0 + }, + "CustomLabel": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "FontConfiguration": { + "type": { + "$ref": "#/201" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AxisLabelReferenceOptions", + "properties": { + "Column": { + "type": { + "$ref": "#/71" + }, + "flags": 1 + }, + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AxisLinearScale", + "properties": { + "StepCount": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "StepSize": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AxisLogarithmicScale", + "properties": { + "Base": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AxisScale", + "properties": { + "Linear": { + "type": { + "$ref": "#/27" + }, + "flags": 0 + }, + "Logarithmic": { + "type": { + "$ref": "#/28" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AxisTickLabelOptions", + "properties": { + "LabelOptions": { + "type": { + "$ref": "#/291" + }, + "flags": 0 + }, + "RotationAngle": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BarChartAggregatedFieldWells", + "properties": { + "Category": { + "type": { + "$ref": "#/611" + }, + "flags": 0 + }, + "Colors": { + "type": { + "$ref": "#/612" + }, + "flags": 0 + }, + "SmallMultiples": { + "type": { + "$ref": "#/613" + }, + "flags": 0 + }, + "Values": { + "type": { + "$ref": "#/614" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BarChartConfiguration", + "properties": { + "BarsArrangement": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "CategoryAxis": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "CategoryLabelOptions": { + "type": { + "$ref": "#/63" + }, + "flags": 0 + }, + "ColorLabelOptions": { + "type": { + "$ref": "#/63" + }, + "flags": 0 + }, + "ContributionAnalysisDefaults": { + "type": { + "$ref": "#/615" + }, + "flags": 0 + }, + "DataLabels": { + "type": { + "$ref": "#/115" + }, + "flags": 0 + }, + "FieldWells": { + "type": { + "$ref": "#/33" + }, + "flags": 0 + }, + "Legend": { + "type": { + "$ref": "#/295" + }, + "flags": 0 + }, + "Orientation": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ReferenceLines": { + "type": { + "$ref": "#/616" + }, + "flags": 0 + }, + "SmallMultiplesOptions": { + "type": { + "$ref": "#/487" + }, + "flags": 0 + }, + "SortConfiguration": { + "type": { + "$ref": "#/35" + }, + "flags": 0 + }, + "Tooltip": { + "type": { + "$ref": "#/546" + }, + "flags": 0 + }, + "ValueAxis": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "ValueLabelOptions": { + "type": { + "$ref": "#/63" + }, + "flags": 0 + }, + "VisualPalette": { + "type": { + "$ref": "#/576" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BarChartFieldWells", + "properties": { + "BarChartAggregatedFieldWells": { + "type": { + "$ref": "#/31" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BarChartOrientation", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "BarChartSortConfiguration", + "properties": { + "CategoryItemsLimit": { + "type": { + "$ref": "#/274" + }, + "flags": 0 + }, + "CategorySort": { + "type": { + "$ref": "#/617" + }, + "flags": 0 + }, + "ColorItemsLimit": { + "type": { + "$ref": "#/274" + }, + "flags": 0 + }, + "ColorSort": { + "type": { + "$ref": "#/618" + }, + "flags": 0 + }, + "SmallMultiplesLimitConfiguration": { + "type": { + "$ref": "#/274" + }, + "flags": 0 + }, + "SmallMultiplesSort": { + "type": { + "$ref": "#/619" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BarChartVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/620" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/32" + }, + "flags": 0 + }, + "ColumnHierarchies": { + "type": { + "$ref": "#/621" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/577" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/578" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "BarsArrangement", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "BaseMapStyleType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "BinCountOptions", + "properties": { + "Value": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BinWidthOptions", + "properties": { + "BinCountLimit": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BodySectionConfiguration", + "properties": { + "Content": { + "type": { + "$ref": "#/42" + }, + "flags": 1 + }, + "PageBreakConfiguration": { + "type": { + "$ref": "#/455" + }, + "flags": 0 + }, + "SectionId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Style": { + "type": { + "$ref": "#/457" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BodySectionContent", + "properties": { + "Layout": { + "type": { + "$ref": "#/454" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BoxPlotAggregatedFieldWells", + "properties": { + "GroupBy": { + "type": { + "$ref": "#/622" + }, + "flags": 0 + }, + "Values": { + "type": { + "$ref": "#/623" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BoxPlotChartConfiguration", + "properties": { + "BoxPlotOptions": { + "type": { + "$ref": "#/47" + }, + "flags": 0 + }, + "CategoryAxis": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "CategoryLabelOptions": { + "type": { + "$ref": "#/63" + }, + "flags": 0 + }, + "FieldWells": { + "type": { + "$ref": "#/45" + }, + "flags": 0 + }, + "Legend": { + "type": { + "$ref": "#/295" + }, + "flags": 0 + }, + "PrimaryYAxisDisplayOptions": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "PrimaryYAxisLabelOptions": { + "type": { + "$ref": "#/63" + }, + "flags": 0 + }, + "ReferenceLines": { + "type": { + "$ref": "#/624" + }, + "flags": 0 + }, + "SortConfiguration": { + "type": { + "$ref": "#/48" + }, + "flags": 0 + }, + "Tooltip": { + "type": { + "$ref": "#/546" + }, + "flags": 0 + }, + "VisualPalette": { + "type": { + "$ref": "#/576" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BoxPlotFieldWells", + "properties": { + "BoxPlotAggregatedFieldWells": { + "type": { + "$ref": "#/43" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BoxPlotFillStyle", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "BoxPlotOptions", + "properties": { + "AllDataPointsVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "OutlierVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "StyleOptions": { + "type": { + "$ref": "#/49" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BoxPlotSortConfiguration", + "properties": { + "CategorySort": { + "type": { + "$ref": "#/625" + }, + "flags": 0 + }, + "PaginationConfiguration": { + "type": { + "$ref": "#/347" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BoxPlotStyleOptions", + "properties": { + "FillStyle": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BoxPlotVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/626" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/44" + }, + "flags": 0 + }, + "ColumnHierarchies": { + "type": { + "$ref": "#/627" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/577" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/578" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CalculatedField", + "properties": { + "DataSetIdentifier": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Expression": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CalculatedMeasureField", + "properties": { + "Expression": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CascadingControlConfiguration", + "properties": { + "SourceControls": { + "type": { + "$ref": "#/628" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CascadingControlSource", + "properties": { + "ColumnToMatch": { + "type": { + "$ref": "#/71" + }, + "flags": 0 + }, + "SourceSheetControlId": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CategoricalAggregationFunction", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CategoricalDimensionField", + "properties": { + "Column": { + "type": { + "$ref": "#/71" + }, + "flags": 1 + }, + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "FormatConfiguration": { + "type": { + "$ref": "#/492" + }, + "flags": 0 + }, + "HierarchyId": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CategoricalMeasureField", + "properties": { + "AggregationFunction": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Column": { + "type": { + "$ref": "#/71" + }, + "flags": 1 + }, + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "FormatConfiguration": { + "type": { + "$ref": "#/492" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CategoryDrillDownFilter", + "properties": { + "CategoryValues": { + "type": { + "$ref": "#/629" + }, + "flags": 1 + }, + "Column": { + "type": { + "$ref": "#/71" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CategoryFilter", + "properties": { + "Column": { + "type": { + "$ref": "#/71" + }, + "flags": 1 + }, + "Configuration": { + "type": { + "$ref": "#/60" + }, + "flags": 1 + }, + "DefaultFilterControlConfiguration": { + "type": { + "$ref": "#/144" + }, + "flags": 0 + }, + "FilterId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CategoryFilterConfiguration", + "properties": { + "CustomFilterConfiguration": { + "type": { + "$ref": "#/106" + }, + "flags": 0 + }, + "CustomFilterListConfiguration": { + "type": { + "$ref": "#/107" + }, + "flags": 0 + }, + "FilterListConfiguration": { + "type": { + "$ref": "#/189" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CategoryFilterMatchOperator", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CategoryFilterSelectAllOptions", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ChartAxisLabelOptions", + "properties": { + "AxisLabelOptions": { + "type": { + "$ref": "#/630" + }, + "flags": 0 + }, + "SortIconVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ClusterMarker", + "properties": { + "SimpleClusterMarker": { + "type": { + "$ref": "#/480" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ClusterMarkerConfiguration", + "properties": { + "ClusterMarker": { + "type": { + "$ref": "#/64" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ColorFillType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ColorScale", + "properties": { + "ColorFillType": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Colors": { + "type": { + "$ref": "#/631" + }, + "flags": 1 + }, + "NullValueColor": { + "type": { + "$ref": "#/112" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ColorsConfiguration", + "properties": { + "CustomColors": { + "type": { + "$ref": "#/632" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ColumnConfiguration", + "properties": { + "ColorsConfiguration": { + "type": { + "$ref": "#/68" + }, + "flags": 0 + }, + "Column": { + "type": { + "$ref": "#/71" + }, + "flags": 1 + }, + "FormatConfiguration": { + "type": { + "$ref": "#/211" + }, + "flags": 0 + }, + "Role": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ColumnHierarchy", + "properties": { + "DateTimeHierarchy": { + "type": { + "$ref": "#/132" + }, + "flags": 0 + }, + "ExplicitHierarchy": { + "type": { + "$ref": "#/168" + }, + "flags": 0 + }, + "PredefinedHierarchy": { + "type": { + "$ref": "#/402" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ColumnIdentifier", + "properties": { + "ColumnName": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "DataSetIdentifier": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ColumnRole", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ColumnSort", + "properties": { + "AggregationFunction": { + "type": { + "$ref": "#/0" + }, + "flags": 0 + }, + "Direction": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "SortBy": { + "type": { + "$ref": "#/71" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ColumnTooltipItem", + "properties": { + "Aggregation": { + "type": { + "$ref": "#/0" + }, + "flags": 0 + }, + "Column": { + "type": { + "$ref": "#/71" + }, + "flags": 1 + }, + "Label": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ComboChartAggregatedFieldWells", + "properties": { + "BarValues": { + "type": { + "$ref": "#/633" + }, + "flags": 0 + }, + "Category": { + "type": { + "$ref": "#/634" + }, + "flags": 0 + }, + "Colors": { + "type": { + "$ref": "#/635" + }, + "flags": 0 + }, + "LineValues": { + "type": { + "$ref": "#/636" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ComboChartConfiguration", + "properties": { + "BarDataLabels": { + "type": { + "$ref": "#/115" + }, + "flags": 0 + }, + "BarsArrangement": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "CategoryAxis": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "CategoryLabelOptions": { + "type": { + "$ref": "#/63" + }, + "flags": 0 + }, + "ColorLabelOptions": { + "type": { + "$ref": "#/63" + }, + "flags": 0 + }, + "FieldWells": { + "type": { + "$ref": "#/77" + }, + "flags": 0 + }, + "Legend": { + "type": { + "$ref": "#/295" + }, + "flags": 0 + }, + "LineDataLabels": { + "type": { + "$ref": "#/115" + }, + "flags": 0 + }, + "PrimaryYAxisDisplayOptions": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "PrimaryYAxisLabelOptions": { + "type": { + "$ref": "#/63" + }, + "flags": 0 + }, + "ReferenceLines": { + "type": { + "$ref": "#/637" + }, + "flags": 0 + }, + "SecondaryYAxisDisplayOptions": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "SecondaryYAxisLabelOptions": { + "type": { + "$ref": "#/63" + }, + "flags": 0 + }, + "SortConfiguration": { + "type": { + "$ref": "#/78" + }, + "flags": 0 + }, + "Tooltip": { + "type": { + "$ref": "#/546" + }, + "flags": 0 + }, + "VisualPalette": { + "type": { + "$ref": "#/576" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ComboChartFieldWells", + "properties": { + "ComboChartAggregatedFieldWells": { + "type": { + "$ref": "#/75" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ComboChartSortConfiguration", + "properties": { + "CategoryItemsLimit": { + "type": { + "$ref": "#/274" + }, + "flags": 0 + }, + "CategorySort": { + "type": { + "$ref": "#/638" + }, + "flags": 0 + }, + "ColorItemsLimit": { + "type": { + "$ref": "#/274" + }, + "flags": 0 + }, + "ColorSort": { + "type": { + "$ref": "#/639" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ComboChartVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/640" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/76" + }, + "flags": 0 + }, + "ColumnHierarchies": { + "type": { + "$ref": "#/641" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/577" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/578" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ComparisonConfiguration", + "properties": { + "ComparisonFormat": { + "type": { + "$ref": "#/81" + }, + "flags": 0 + }, + "ComparisonMethod": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ComparisonFormatConfiguration", + "properties": { + "NumberDisplayFormatConfiguration": { + "type": { + "$ref": "#/330" + }, + "flags": 0 + }, + "PercentageDisplayFormatConfiguration": { + "type": { + "$ref": "#/365" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ComparisonMethod", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Computation", + "properties": { + "Forecast": { + "type": { + "$ref": "#/207" + }, + "flags": 0 + }, + "GrowthRate": { + "type": { + "$ref": "#/253" + }, + "flags": 0 + }, + "MaximumMinimum": { + "type": { + "$ref": "#/320" + }, + "flags": 0 + }, + "MetricComparison": { + "type": { + "$ref": "#/323" + }, + "flags": 0 + }, + "PeriodOverPeriod": { + "type": { + "$ref": "#/367" + }, + "flags": 0 + }, + "PeriodToDate": { + "type": { + "$ref": "#/368" + }, + "flags": 0 + }, + "TopBottomMovers": { + "type": { + "$ref": "#/550" + }, + "flags": 0 + }, + "TopBottomRanked": { + "type": { + "$ref": "#/551" + }, + "flags": 0 + }, + "TotalAggregation": { + "type": { + "$ref": "#/553" + }, + "flags": 0 + }, + "UniqueValues": { + "type": { + "$ref": "#/565" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ConditionalFormattingColor", + "properties": { + "Gradient": { + "type": { + "$ref": "#/87" + }, + "flags": 0 + }, + "Solid": { + "type": { + "$ref": "#/93" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ConditionalFormattingCustomIconCondition", + "properties": { + "Color": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "DisplayConfiguration": { + "type": { + "$ref": "#/89" + }, + "flags": 0 + }, + "Expression": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "IconOptions": { + "type": { + "$ref": "#/86" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ConditionalFormattingCustomIconOptions", + "properties": { + "Icon": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "UnicodeIcon": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ConditionalFormattingGradientColor", + "properties": { + "Color": { + "type": { + "$ref": "#/247" + }, + "flags": 1 + }, + "Expression": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ConditionalFormattingIcon", + "properties": { + "CustomCondition": { + "type": { + "$ref": "#/85" + }, + "flags": 0 + }, + "IconSet": { + "type": { + "$ref": "#/91" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ConditionalFormattingIconDisplayConfiguration", + "properties": { + "IconDisplayOption": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ConditionalFormattingIconDisplayOption", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ConditionalFormattingIconSet", + "properties": { + "Expression": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "IconSetType": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ConditionalFormattingIconSetType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ConditionalFormattingSolidColor", + "properties": { + "Color": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Expression": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ContributionAnalysisDefault", + "properties": { + "ContributorDimensions": { + "type": { + "$ref": "#/642" + }, + "flags": 1 + }, + "MeasureFieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CrossDatasetTypes", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CurrencyDisplayFormatConfiguration", + "properties": { + "DecimalPlacesConfiguration": { + "type": { + "$ref": "#/141" + }, + "flags": 0 + }, + "NegativeValueConfiguration": { + "type": { + "$ref": "#/327" + }, + "flags": 0 + }, + "NullValueFormatConfiguration": { + "type": { + "$ref": "#/329" + }, + "flags": 0 + }, + "NumberScale": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Prefix": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "SeparatorConfiguration": { + "type": { + "$ref": "#/341" + }, + "flags": 0 + }, + "Suffix": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Symbol": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomActionFilterOperation", + "properties": { + "SelectedFieldsConfiguration": { + "type": { + "$ref": "#/192" + }, + "flags": 1 + }, + "TargetVisualsConfiguration": { + "type": { + "$ref": "#/193" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomActionNavigationOperation", + "properties": { + "LocalNavigationConfiguration": { + "type": { + "$ref": "#/315" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomActionSetParametersOperation", + "properties": { + "ParameterValueConfigurations": { + "type": { + "$ref": "#/643" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomActionURLOperation", + "properties": { + "URLTarget": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "URLTemplate": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomColor", + "properties": { + "Color": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "FieldValue": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "SpecialValue": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomContentConfiguration", + "properties": { + "ContentType": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ContentUrl": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ImageScaling": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomContentImageScalingConfiguration", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CustomContentType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CustomContentVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/644" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/102" + }, + "flags": 0 + }, + "DataSetIdentifier": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Subtitle": { + "type": { + "$ref": "#/577" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/578" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomFilterConfiguration", + "properties": { + "CategoryValue": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "MatchOperator": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "NullOption": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "ParameterName": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "SelectAllOptions": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomFilterListConfiguration", + "properties": { + "CategoryValues": { + "type": { + "$ref": "#/645" + }, + "flags": 0 + }, + "MatchOperator": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "NullOption": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "SelectAllOptions": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomNarrativeOptions", + "properties": { + "Narrative": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomParameterValues", + "properties": { + "DateTimeValues": { + "type": { + "$ref": "#/646" + }, + "flags": 0 + }, + "DecimalValues": { + "type": { + "$ref": "#/647" + }, + "flags": 0 + }, + "IntegerValues": { + "type": { + "$ref": "#/648" + }, + "flags": 0 + }, + "StringValues": { + "type": { + "$ref": "#/649" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomValuesConfiguration", + "properties": { + "CustomValues": { + "type": { + "$ref": "#/109" + }, + "flags": 1 + }, + "IncludeNullValue": { + "type": { + "$ref": "#/650" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DataBarsOptions", + "properties": { + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "NegativeColor": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "PositiveColor": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DataColor", + "properties": { + "Color": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "DataValue": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DataFieldSeriesItem", + "properties": { + "AxisBinding": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "FieldValue": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Settings": { + "type": { + "$ref": "#/305" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DataLabelContent", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DataLabelOptions", + "properties": { + "CategoryLabelVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "DataLabelTypes": { + "type": { + "$ref": "#/651" + }, + "flags": 0 + }, + "LabelColor": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "LabelContent": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "LabelFontConfiguration": { + "type": { + "$ref": "#/201" + }, + "flags": 0 + }, + "MeasureLabelVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Overlap": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Position": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "TotalsVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DataLabelOverlap", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DataLabelPosition", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DataLabelType", + "properties": { + "DataPathLabelType": { + "type": { + "$ref": "#/120" + }, + "flags": 0 + }, + "FieldLabelType": { + "type": { + "$ref": "#/170" + }, + "flags": 0 + }, + "MaximumLabelType": { + "type": { + "$ref": "#/319" + }, + "flags": 0 + }, + "MinimumLabelType": { + "type": { + "$ref": "#/324" + }, + "flags": 0 + }, + "RangeEndsLabelType": { + "type": { + "$ref": "#/414" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DataPathColor", + "properties": { + "Color": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Element": { + "type": { + "$ref": "#/123" + }, + "flags": 1 + }, + "TimeGranularity": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DataPathLabelType", + "properties": { + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "FieldValue": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DataPathSort", + "properties": { + "Direction": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "SortPaths": { + "type": { + "$ref": "#/652" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DataPathType", + "properties": { + "PivotTableDataPathType": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DataPathValue", + "properties": { + "DataPathType": { + "type": { + "$ref": "#/122" + }, + "flags": 0 + }, + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "FieldValue": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DataSetIdentifierDeclaration", + "properties": { + "DataSetArn": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Identifier": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DataSetReference", + "properties": { + "DataSetArn": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

Dataset Amazon Resource Name (ARN).

" + }, + "DataSetPlaceholder": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

Dataset placeholder.

" + } + } + }, + { + "$type": "ObjectType", + "name": "DateAggregationFunction", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DateAxisOptions", + "properties": { + "MissingDateVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DateDimensionField", + "properties": { + "Column": { + "type": { + "$ref": "#/71" + }, + "flags": 1 + }, + "DateGranularity": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "FormatConfiguration": { + "type": { + "$ref": "#/131" + }, + "flags": 0 + }, + "HierarchyId": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DateMeasureField", + "properties": { + "AggregationFunction": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Column": { + "type": { + "$ref": "#/71" + }, + "flags": 1 + }, + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "FormatConfiguration": { + "type": { + "$ref": "#/131" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DateTimeDefaultValues", + "properties": { + "DynamicValue": { + "type": { + "$ref": "#/164" + }, + "flags": 0 + }, + "RollingDate": { + "type": { + "$ref": "#/435" + }, + "flags": 0 + }, + "StaticValues": { + "type": { + "$ref": "#/653" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DateTimeFormatConfiguration", + "properties": { + "DateTimeFormat": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "NullValueFormatConfiguration": { + "type": { + "$ref": "#/329" + }, + "flags": 0 + }, + "NumericFormatConfiguration": { + "type": { + "$ref": "#/338" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DateTimeHierarchy", + "properties": { + "DrillDownFilters": { + "type": { + "$ref": "#/654" + }, + "flags": 0 + }, + "HierarchyId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DateTimeParameter", + "properties": { + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

A display name for the date-time parameter.

" + }, + "Values": { + "type": { + "$ref": "#/655" + }, + "flags": 1, + "description": "

The values for the date-time parameter.

" + } + } + }, + { + "$type": "ObjectType", + "name": "DateTimeParameterDeclaration", + "properties": { + "DefaultValues": { + "type": { + "$ref": "#/130" + }, + "flags": 0 + }, + "MappedDataSetParameters": { + "type": { + "$ref": "#/656" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "TimeGranularity": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ValueWhenUnset": { + "type": { + "$ref": "#/136" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DateTimePickerControlDisplayOptions", + "properties": { + "DateTimeFormat": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "InfoIconLabelOptions": { + "type": { + "$ref": "#/468" + }, + "flags": 0 + }, + "TitleOptions": { + "type": { + "$ref": "#/291" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DateTimeValueWhenUnsetConfiguration", + "properties": { + "CustomValue": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ValueWhenUnsetOption": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DayOfTheWeek", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DecimalDefaultValues", + "properties": { + "DynamicValue": { + "type": { + "$ref": "#/164" + }, + "flags": 0 + }, + "StaticValues": { + "type": { + "$ref": "#/657" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DecimalParameter", + "properties": { + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

A display name for the decimal parameter.

" + }, + "Values": { + "type": { + "$ref": "#/658" + }, + "flags": 1, + "description": "

The values for the decimal parameter.

" + } + } + }, + { + "$type": "ObjectType", + "name": "DecimalParameterDeclaration", + "properties": { + "DefaultValues": { + "type": { + "$ref": "#/138" + }, + "flags": 0 + }, + "MappedDataSetParameters": { + "type": { + "$ref": "#/659" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "ParameterValueType": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "ValueWhenUnset": { + "type": { + "$ref": "#/142" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DecimalPlacesConfiguration", + "properties": { + "DecimalPlaces": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DecimalValueWhenUnsetConfiguration", + "properties": { + "CustomValue": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "ValueWhenUnsetOption": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DefaultDateTimePickerControlOptions", + "properties": { + "DisplayOptions": { + "type": { + "$ref": "#/135" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DefaultFilterControlConfiguration", + "properties": { + "ControlOptions": { + "type": { + "$ref": "#/145" + }, + "flags": 1 + }, + "Title": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DefaultFilterControlOptions", + "properties": { + "DefaultDateTimePickerOptions": { + "type": { + "$ref": "#/143" + }, + "flags": 0 + }, + "DefaultDropdownOptions": { + "type": { + "$ref": "#/146" + }, + "flags": 0 + }, + "DefaultListOptions": { + "type": { + "$ref": "#/147" + }, + "flags": 0 + }, + "DefaultRelativeDateTimeOptions": { + "type": { + "$ref": "#/153" + }, + "flags": 0 + }, + "DefaultSliderOptions": { + "type": { + "$ref": "#/155" + }, + "flags": 0 + }, + "DefaultTextAreaOptions": { + "type": { + "$ref": "#/156" + }, + "flags": 0 + }, + "DefaultTextFieldOptions": { + "type": { + "$ref": "#/157" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DefaultFilterDropDownControlOptions", + "properties": { + "DisplayOptions": { + "type": { + "$ref": "#/163" + }, + "flags": 0 + }, + "SelectableValues": { + "type": { + "$ref": "#/196" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DefaultFilterListControlOptions", + "properties": { + "DisplayOptions": { + "type": { + "$ref": "#/311" + }, + "flags": 0 + }, + "SelectableValues": { + "type": { + "$ref": "#/196" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DefaultFreeFormLayoutConfiguration", + "properties": { + "CanvasSizeOptions": { + "type": { + "$ref": "#/212" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DefaultGridLayoutConfiguration", + "properties": { + "CanvasSizeOptions": { + "type": { + "$ref": "#/249" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DefaultInteractiveLayoutConfiguration", + "properties": { + "FreeForm": { + "type": { + "$ref": "#/148" + }, + "flags": 0 + }, + "Grid": { + "type": { + "$ref": "#/149" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DefaultNewSheetConfiguration", + "properties": { + "InteractiveLayoutConfiguration": { + "type": { + "$ref": "#/150" + }, + "flags": 0 + }, + "PaginatedLayoutConfiguration": { + "type": { + "$ref": "#/152" + }, + "flags": 0 + }, + "SheetContentType": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DefaultPaginatedLayoutConfiguration", + "properties": { + "SectionBased": { + "type": { + "$ref": "#/154" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DefaultRelativeDateTimeControlOptions", + "properties": { + "DisplayOptions": { + "type": { + "$ref": "#/428" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DefaultSectionBasedLayoutConfiguration", + "properties": { + "CanvasSizeOptions": { + "type": { + "$ref": "#/451" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DefaultSliderControlOptions", + "properties": { + "DisplayOptions": { + "type": { + "$ref": "#/483" + }, + "flags": 0 + }, + "MaximumValue": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + }, + "MinimumValue": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + }, + "StepSize": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + }, + "Type": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DefaultTextAreaControlOptions", + "properties": { + "Delimiter": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "DisplayOptions": { + "type": { + "$ref": "#/533" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DefaultTextFieldControlOptions", + "properties": { + "DisplayOptions": { + "type": { + "$ref": "#/536" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DestinationParameterValueConfiguration", + "properties": { + "CustomValuesConfiguration": { + "type": { + "$ref": "#/110" + }, + "flags": 0 + }, + "SelectAllValueOptions": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "SourceColumn": { + "type": { + "$ref": "#/71" + }, + "flags": 0 + }, + "SourceField": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "SourceParameterName": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DimensionField", + "properties": { + "CategoricalDimensionField": { + "type": { + "$ref": "#/56" + }, + "flags": 0 + }, + "DateDimensionField": { + "type": { + "$ref": "#/128" + }, + "flags": 0 + }, + "NumericalDimensionField": { + "type": { + "$ref": "#/344" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DonutCenterOptions", + "properties": { + "LabelVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DonutOptions", + "properties": { + "ArcOptions": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + }, + "DonutCenterOptions": { + "type": { + "$ref": "#/160" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DrillDownFilter", + "properties": { + "CategoryFilter": { + "type": { + "$ref": "#/58" + }, + "flags": 0 + }, + "NumericEqualityFilter": { + "type": { + "$ref": "#/334" + }, + "flags": 0 + }, + "TimeRangeFilter": { + "type": { + "$ref": "#/542" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DropDownControlDisplayOptions", + "properties": { + "InfoIconLabelOptions": { + "type": { + "$ref": "#/468" + }, + "flags": 0 + }, + "SelectAllOptions": { + "type": { + "$ref": "#/313" + }, + "flags": 0 + }, + "TitleOptions": { + "type": { + "$ref": "#/291" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DynamicDefaultValue", + "properties": { + "DefaultValueColumn": { + "type": { + "$ref": "#/71" + }, + "flags": 1 + }, + "GroupNameColumn": { + "type": { + "$ref": "#/71" + }, + "flags": 0 + }, + "UserNameColumn": { + "type": { + "$ref": "#/71" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "EmptyVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/660" + }, + "flags": 0 + }, + "DataSetIdentifier": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Entity", + "properties": { + "Path": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ExcludePeriodConfiguration", + "properties": { + "Amount": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + }, + "Granularity": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Status": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ExplicitHierarchy", + "properties": { + "Columns": { + "type": { + "$ref": "#/661" + }, + "flags": 1 + }, + "DrillDownFilters": { + "type": { + "$ref": "#/662" + }, + "flags": 0 + }, + "HierarchyId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "FieldBasedTooltip", + "properties": { + "AggregationVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "TooltipFields": { + "type": { + "$ref": "#/663" + }, + "flags": 0 + }, + "TooltipTitleType": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FieldLabelType", + "properties": { + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FieldSeriesItem", + "properties": { + "AxisBinding": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Settings": { + "type": { + "$ref": "#/305" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FieldSort", + "properties": { + "Direction": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "FieldSortOptions", + "properties": { + "ColumnSort": { + "type": { + "$ref": "#/73" + }, + "flags": 0 + }, + "FieldSort": { + "type": { + "$ref": "#/172" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FieldTooltipItem", + "properties": { + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Label": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FilledMapAggregatedFieldWells", + "properties": { + "Geospatial": { + "type": { + "$ref": "#/664" + }, + "flags": 0 + }, + "Values": { + "type": { + "$ref": "#/665" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FilledMapConditionalFormatting", + "properties": { + "ConditionalFormattingOptions": { + "type": { + "$ref": "#/666" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "FilledMapConditionalFormattingOption", + "properties": { + "Shape": { + "type": { + "$ref": "#/180" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "FilledMapConfiguration", + "properties": { + "FieldWells": { + "type": { + "$ref": "#/179" + }, + "flags": 0 + }, + "Legend": { + "type": { + "$ref": "#/295" + }, + "flags": 0 + }, + "MapStyleOptions": { + "type": { + "$ref": "#/241" + }, + "flags": 0 + }, + "SortConfiguration": { + "type": { + "$ref": "#/181" + }, + "flags": 0 + }, + "Tooltip": { + "type": { + "$ref": "#/546" + }, + "flags": 0 + }, + "WindowOptions": { + "type": { + "$ref": "#/245" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FilledMapFieldWells", + "properties": { + "FilledMapAggregatedFieldWells": { + "type": { + "$ref": "#/175" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FilledMapShapeConditionalFormatting", + "properties": { + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Format": { + "type": { + "$ref": "#/464" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FilledMapSortConfiguration", + "properties": { + "CategorySort": { + "type": { + "$ref": "#/667" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FilledMapVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/668" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/178" + }, + "flags": 0 + }, + "ColumnHierarchies": { + "type": { + "$ref": "#/669" + }, + "flags": 0 + }, + "ConditionalFormatting": { + "type": { + "$ref": "#/176" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/577" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/578" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Filter", + "properties": { + "CategoryFilter": { + "type": { + "$ref": "#/59" + }, + "flags": 0 + }, + "NumericEqualityFilter": { + "type": { + "$ref": "#/335" + }, + "flags": 0 + }, + "NumericRangeFilter": { + "type": { + "$ref": "#/339" + }, + "flags": 0 + }, + "RelativeDatesFilter": { + "type": { + "$ref": "#/430" + }, + "flags": 0 + }, + "TimeEqualityFilter": { + "type": { + "$ref": "#/540" + }, + "flags": 0 + }, + "TimeRangeFilter": { + "type": { + "$ref": "#/543" + }, + "flags": 0 + }, + "TopBottomFilter": { + "type": { + "$ref": "#/549" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FilterControl", + "properties": { + "CrossSheet": { + "type": { + "$ref": "#/185" + }, + "flags": 0 + }, + "DateTimePicker": { + "type": { + "$ref": "#/186" + }, + "flags": 0 + }, + "Dropdown": { + "type": { + "$ref": "#/187" + }, + "flags": 0 + }, + "List": { + "type": { + "$ref": "#/190" + }, + "flags": 0 + }, + "RelativeDateTime": { + "type": { + "$ref": "#/194" + }, + "flags": 0 + }, + "Slider": { + "type": { + "$ref": "#/197" + }, + "flags": 0 + }, + "TextArea": { + "type": { + "$ref": "#/198" + }, + "flags": 0 + }, + "TextField": { + "type": { + "$ref": "#/199" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FilterCrossSheetControl", + "properties": { + "CascadingControlConfiguration": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "FilterControlId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "SourceFilterId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "FilterDateTimePickerControl", + "properties": { + "DisplayOptions": { + "type": { + "$ref": "#/135" + }, + "flags": 0 + }, + "FilterControlId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "SourceFilterId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Title": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Type": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FilterDropDownControl", + "properties": { + "CascadingControlConfiguration": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "DisplayOptions": { + "type": { + "$ref": "#/163" + }, + "flags": 0 + }, + "FilterControlId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "SelectableValues": { + "type": { + "$ref": "#/196" + }, + "flags": 0 + }, + "SourceFilterId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Title": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Type": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FilterGroup", + "properties": { + "CrossDataset": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "FilterGroupId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Filters": { + "type": { + "$ref": "#/670" + }, + "flags": 1 + }, + "ScopeConfiguration": { + "type": { + "$ref": "#/195" + }, + "flags": 1 + }, + "Status": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FilterListConfiguration", + "properties": { + "CategoryValues": { + "type": { + "$ref": "#/671" + }, + "flags": 0 + }, + "MatchOperator": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "NullOption": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "SelectAllOptions": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FilterListControl", + "properties": { + "CascadingControlConfiguration": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "DisplayOptions": { + "type": { + "$ref": "#/311" + }, + "flags": 0 + }, + "FilterControlId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "SelectableValues": { + "type": { + "$ref": "#/196" + }, + "flags": 0 + }, + "SourceFilterId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Title": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Type": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FilterNullOption", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "FilterOperationSelectedFieldsConfiguration", + "properties": { + "SelectedColumns": { + "type": { + "$ref": "#/672" + }, + "flags": 0, + "description": "

The selected columns of a dataset.

" + }, + "SelectedFieldOptions": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "SelectedFields": { + "type": { + "$ref": "#/673" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FilterOperationTargetVisualsConfiguration", + "properties": { + "SameSheetTargetVisualConfiguration": { + "type": { + "$ref": "#/437" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FilterRelativeDateTimeControl", + "properties": { + "DisplayOptions": { + "type": { + "$ref": "#/428" + }, + "flags": 0 + }, + "FilterControlId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "SourceFilterId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Title": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "FilterScopeConfiguration", + "properties": { + "AllSheets": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "SelectedSheets": { + "type": { + "$ref": "#/460" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FilterSelectableValues", + "properties": { + "Values": { + "type": { + "$ref": "#/674" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FilterSliderControl", + "properties": { + "DisplayOptions": { + "type": { + "$ref": "#/483" + }, + "flags": 0 + }, + "FilterControlId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "MaximumValue": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + }, + "MinimumValue": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + }, + "SourceFilterId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "StepSize": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + }, + "Title": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Type": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FilterTextAreaControl", + "properties": { + "Delimiter": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "DisplayOptions": { + "type": { + "$ref": "#/533" + }, + "flags": 0 + }, + "FilterControlId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "SourceFilterId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Title": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "FilterTextFieldControl", + "properties": { + "DisplayOptions": { + "type": { + "$ref": "#/536" + }, + "flags": 0 + }, + "FilterControlId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "SourceFilterId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Title": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "FilterVisualScope", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "FontConfiguration", + "properties": { + "FontColor": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "FontDecoration": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "FontSize": { + "type": { + "$ref": "#/203" + }, + "flags": 0 + }, + "FontStyle": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "FontWeight": { + "type": { + "$ref": "#/205" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FontDecoration", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "FontSize", + "properties": { + "Relative": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FontStyle", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "FontWeight", + "properties": { + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FontWeightName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ForecastComputation", + "properties": { + "ComputationId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "CustomSeasonalityValue": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "LowerBoundary": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "PeriodsBackward": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "PeriodsForward": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "PredictionInterval": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "Seasonality": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Time": { + "type": { + "$ref": "#/159" + }, + "flags": 0 + }, + "UpperBoundary": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/322" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ForecastComputationSeasonality", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ForecastConfiguration", + "properties": { + "ForecastProperties": { + "type": { + "$ref": "#/539" + }, + "flags": 0 + }, + "Scenario": { + "type": { + "$ref": "#/210" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ForecastScenario", + "properties": { + "WhatIfPointScenario": { + "type": { + "$ref": "#/587" + }, + "flags": 0 + }, + "WhatIfRangeScenario": { + "type": { + "$ref": "#/588" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FormatConfiguration", + "properties": { + "DateTimeFormatConfiguration": { + "type": { + "$ref": "#/131" + }, + "flags": 0 + }, + "NumberFormatConfiguration": { + "type": { + "$ref": "#/331" + }, + "flags": 0 + }, + "StringFormatConfiguration": { + "type": { + "$ref": "#/492" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FreeFormLayoutCanvasSizeOptions", + "properties": { + "ScreenCanvasSizeOptions": { + "type": { + "$ref": "#/217" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FreeFormLayoutConfiguration", + "properties": { + "CanvasSizeOptions": { + "type": { + "$ref": "#/212" + }, + "flags": 0 + }, + "Elements": { + "type": { + "$ref": "#/675" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "FreeFormLayoutElement", + "properties": { + "BackgroundStyle": { + "type": { + "$ref": "#/215" + }, + "flags": 0 + }, + "BorderStyle": { + "type": { + "$ref": "#/216" + }, + "flags": 0 + }, + "ElementId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "ElementType": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Height": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "String based length that is composed of value and unit in px" + }, + "LoadingAnimation": { + "type": { + "$ref": "#/314" + }, + "flags": 0 + }, + "RenderingRules": { + "type": { + "$ref": "#/676" + }, + "flags": 0 + }, + "SelectedBorderStyle": { + "type": { + "$ref": "#/216" + }, + "flags": 0 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Width": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "String based length that is composed of value and unit in px" + }, + "XAxisLocation": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "String based length that is composed of value and unit in px" + }, + "YAxisLocation": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "String based length that is composed of value and unit in px with Integer.MAX_VALUE as maximum value" + } + } + }, + { + "$type": "ObjectType", + "name": "FreeFormLayoutElementBackgroundStyle", + "properties": { + "Color": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FreeFormLayoutElementBorderStyle", + "properties": { + "Color": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FreeFormLayoutScreenCanvasSizeOptions", + "properties": { + "OptimizedViewPortWidth": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "String based length that is composed of value and unit in px" + } + } + }, + { + "$type": "ObjectType", + "name": "FreeFormSectionLayoutConfiguration", + "properties": { + "Elements": { + "type": { + "$ref": "#/677" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "FunnelChartAggregatedFieldWells", + "properties": { + "Category": { + "type": { + "$ref": "#/678" + }, + "flags": 0 + }, + "Values": { + "type": { + "$ref": "#/679" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FunnelChartConfiguration", + "properties": { + "CategoryLabelOptions": { + "type": { + "$ref": "#/63" + }, + "flags": 0 + }, + "DataLabelOptions": { + "type": { + "$ref": "#/221" + }, + "flags": 0 + }, + "FieldWells": { + "type": { + "$ref": "#/222" + }, + "flags": 0 + }, + "SortConfiguration": { + "type": { + "$ref": "#/224" + }, + "flags": 0 + }, + "Tooltip": { + "type": { + "$ref": "#/546" + }, + "flags": 0 + }, + "ValueLabelOptions": { + "type": { + "$ref": "#/63" + }, + "flags": 0 + }, + "VisualPalette": { + "type": { + "$ref": "#/576" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FunnelChartDataLabelOptions", + "properties": { + "CategoryLabelVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "LabelColor": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "LabelFontConfiguration": { + "type": { + "$ref": "#/201" + }, + "flags": 0 + }, + "MeasureDataLabelStyle": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "MeasureLabelVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Position": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FunnelChartFieldWells", + "properties": { + "FunnelChartAggregatedFieldWells": { + "type": { + "$ref": "#/219" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FunnelChartMeasureDataLabelStyle", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "FunnelChartSortConfiguration", + "properties": { + "CategoryItemsLimit": { + "type": { + "$ref": "#/274" + }, + "flags": 0 + }, + "CategorySort": { + "type": { + "$ref": "#/680" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FunnelChartVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/681" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/220" + }, + "flags": 0 + }, + "ColumnHierarchies": { + "type": { + "$ref": "#/682" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/577" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/578" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "GaugeChartArcConditionalFormatting", + "properties": { + "ForegroundColor": { + "type": { + "$ref": "#/84" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GaugeChartConditionalFormatting", + "properties": { + "ConditionalFormattingOptions": { + "type": { + "$ref": "#/683" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GaugeChartConditionalFormattingOption", + "properties": { + "Arc": { + "type": { + "$ref": "#/226" + }, + "flags": 0 + }, + "PrimaryValue": { + "type": { + "$ref": "#/232" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GaugeChartConfiguration", + "properties": { + "DataLabels": { + "type": { + "$ref": "#/115" + }, + "flags": 0 + }, + "FieldWells": { + "type": { + "$ref": "#/230" + }, + "flags": 0 + }, + "GaugeChartOptions": { + "type": { + "$ref": "#/231" + }, + "flags": 0 + }, + "TooltipOptions": { + "type": { + "$ref": "#/546" + }, + "flags": 0 + }, + "VisualPalette": { + "type": { + "$ref": "#/576" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GaugeChartFieldWells", + "properties": { + "TargetValues": { + "type": { + "$ref": "#/684" + }, + "flags": 0 + }, + "Values": { + "type": { + "$ref": "#/685" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GaugeChartOptions", + "properties": { + "Arc": { + "type": { + "$ref": "#/13" + }, + "flags": 0 + }, + "ArcAxis": { + "type": { + "$ref": "#/11" + }, + "flags": 0 + }, + "Comparison": { + "type": { + "$ref": "#/80" + }, + "flags": 0 + }, + "PrimaryValueDisplayType": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "PrimaryValueFontConfiguration": { + "type": { + "$ref": "#/201" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GaugeChartPrimaryValueConditionalFormatting", + "properties": { + "Icon": { + "type": { + "$ref": "#/88" + }, + "flags": 0 + }, + "TextColor": { + "type": { + "$ref": "#/84" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GaugeChartVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/686" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/229" + }, + "flags": 0 + }, + "ConditionalFormatting": { + "type": { + "$ref": "#/227" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/577" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/578" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "GeospatialCoordinateBounds", + "properties": { + "East": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + }, + "North": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + }, + "South": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + }, + "West": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "GeospatialHeatmapColorScale", + "properties": { + "Colors": { + "type": { + "$ref": "#/687" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GeospatialHeatmapConfiguration", + "properties": { + "HeatmapColor": { + "type": { + "$ref": "#/235" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GeospatialHeatmapDataColor", + "properties": { + "Color": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "GeospatialMapAggregatedFieldWells", + "properties": { + "Colors": { + "type": { + "$ref": "#/688" + }, + "flags": 0 + }, + "Geospatial": { + "type": { + "$ref": "#/689" + }, + "flags": 0 + }, + "Values": { + "type": { + "$ref": "#/690" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GeospatialMapConfiguration", + "properties": { + "FieldWells": { + "type": { + "$ref": "#/240" + }, + "flags": 0 + }, + "Legend": { + "type": { + "$ref": "#/295" + }, + "flags": 0 + }, + "MapStyleOptions": { + "type": { + "$ref": "#/241" + }, + "flags": 0 + }, + "PointStyleOptions": { + "type": { + "$ref": "#/243" + }, + "flags": 0 + }, + "Tooltip": { + "type": { + "$ref": "#/546" + }, + "flags": 0 + }, + "VisualPalette": { + "type": { + "$ref": "#/576" + }, + "flags": 0 + }, + "WindowOptions": { + "type": { + "$ref": "#/245" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GeospatialMapFieldWells", + "properties": { + "GeospatialMapAggregatedFieldWells": { + "type": { + "$ref": "#/238" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GeospatialMapStyleOptions", + "properties": { + "BaseMapStyle": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GeospatialMapVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/691" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/239" + }, + "flags": 0 + }, + "ColumnHierarchies": { + "type": { + "$ref": "#/692" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/577" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/578" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "GeospatialPointStyleOptions", + "properties": { + "ClusterMarkerConfiguration": { + "type": { + "$ref": "#/65" + }, + "flags": 0 + }, + "HeatmapConfiguration": { + "type": { + "$ref": "#/236" + }, + "flags": 0 + }, + "SelectedPointStyle": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GeospatialSelectedPointStyle", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "GeospatialWindowOptions", + "properties": { + "Bounds": { + "type": { + "$ref": "#/234" + }, + "flags": 0 + }, + "MapZoomMode": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GlobalTableBorderOptions", + "properties": { + "SideSpecificBorder": { + "type": { + "$ref": "#/524" + }, + "flags": 0 + }, + "UniformBorder": { + "type": { + "$ref": "#/499" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GradientColor", + "properties": { + "Stops": { + "type": { + "$ref": "#/693" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GradientStop", + "properties": { + "Color": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "DataValue": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "GradientOffset": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "GridLayoutCanvasSizeOptions", + "properties": { + "ScreenCanvasSizeOptions": { + "type": { + "$ref": "#/252" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GridLayoutConfiguration", + "properties": { + "CanvasSizeOptions": { + "type": { + "$ref": "#/249" + }, + "flags": 0 + }, + "Elements": { + "type": { + "$ref": "#/694" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "GridLayoutElement", + "properties": { + "ColumnIndex": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "ColumnSpan": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + }, + "ElementId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "ElementType": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "RowIndex": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "RowSpan": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "GridLayoutScreenCanvasSizeOptions", + "properties": { + "OptimizedViewPortWidth": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "String based length that is composed of value and unit in px" + }, + "ResizeOption": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "GrowthRateComputation", + "properties": { + "ComputationId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "PeriodSize": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "Time": { + "type": { + "$ref": "#/159" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/322" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "HeaderFooterSectionConfiguration", + "properties": { + "Layout": { + "type": { + "$ref": "#/454" + }, + "flags": 1 + }, + "SectionId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Style": { + "type": { + "$ref": "#/457" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "HeatMapAggregatedFieldWells", + "properties": { + "Columns": { + "type": { + "$ref": "#/695" + }, + "flags": 0 + }, + "Rows": { + "type": { + "$ref": "#/696" + }, + "flags": 0 + }, + "Values": { + "type": { + "$ref": "#/697" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "HeatMapConfiguration", + "properties": { + "ColorScale": { + "type": { + "$ref": "#/67" + }, + "flags": 0 + }, + "ColumnLabelOptions": { + "type": { + "$ref": "#/63" + }, + "flags": 0 + }, + "DataLabels": { + "type": { + "$ref": "#/115" + }, + "flags": 0 + }, + "FieldWells": { + "type": { + "$ref": "#/257" + }, + "flags": 0 + }, + "Legend": { + "type": { + "$ref": "#/295" + }, + "flags": 0 + }, + "RowLabelOptions": { + "type": { + "$ref": "#/63" + }, + "flags": 0 + }, + "SortConfiguration": { + "type": { + "$ref": "#/258" + }, + "flags": 0 + }, + "Tooltip": { + "type": { + "$ref": "#/546" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "HeatMapFieldWells", + "properties": { + "HeatMapAggregatedFieldWells": { + "type": { + "$ref": "#/255" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "HeatMapSortConfiguration", + "properties": { + "HeatMapColumnItemsLimitConfiguration": { + "type": { + "$ref": "#/274" + }, + "flags": 0 + }, + "HeatMapColumnSort": { + "type": { + "$ref": "#/698" + }, + "flags": 0 + }, + "HeatMapRowItemsLimitConfiguration": { + "type": { + "$ref": "#/274" + }, + "flags": 0 + }, + "HeatMapRowSort": { + "type": { + "$ref": "#/699" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "HeatMapVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/700" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/256" + }, + "flags": 0 + }, + "ColumnHierarchies": { + "type": { + "$ref": "#/701" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/577" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/578" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "HistogramAggregatedFieldWells", + "properties": { + "Values": { + "type": { + "$ref": "#/702" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "HistogramBinOptions", + "properties": { + "BinCount": { + "type": { + "$ref": "#/39" + }, + "flags": 0 + }, + "BinWidth": { + "type": { + "$ref": "#/40" + }, + "flags": 0 + }, + "SelectedBinType": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "StartValue": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "HistogramBinType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "HistogramConfiguration", + "properties": { + "BinOptions": { + "type": { + "$ref": "#/261" + }, + "flags": 0 + }, + "DataLabels": { + "type": { + "$ref": "#/115" + }, + "flags": 0 + }, + "FieldWells": { + "type": { + "$ref": "#/264" + }, + "flags": 0 + }, + "Tooltip": { + "type": { + "$ref": "#/546" + }, + "flags": 0 + }, + "VisualPalette": { + "type": { + "$ref": "#/576" + }, + "flags": 0 + }, + "XAxisDisplayOptions": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "XAxisLabelOptions": { + "type": { + "$ref": "#/63" + }, + "flags": 0 + }, + "YAxisDisplayOptions": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "HistogramFieldWells", + "properties": { + "HistogramAggregatedFieldWells": { + "type": { + "$ref": "#/260" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "HistogramVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/703" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/263" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/577" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/578" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "HorizontalTextAlignment", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Icon", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "InsightConfiguration", + "properties": { + "Computations": { + "type": { + "$ref": "#/704" + }, + "flags": 0 + }, + "CustomNarrative": { + "type": { + "$ref": "#/108" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "InsightVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/705" + }, + "flags": 0 + }, + "DataSetIdentifier": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "InsightConfiguration": { + "type": { + "$ref": "#/268" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/577" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/578" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "IntegerDefaultValues", + "properties": { + "DynamicValue": { + "type": { + "$ref": "#/164" + }, + "flags": 0 + }, + "StaticValues": { + "type": { + "$ref": "#/706" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "IntegerParameter", + "properties": { + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

The name of the integer parameter.

" + }, + "Values": { + "type": { + "$ref": "#/707" + }, + "flags": 1, + "description": "

The values for the integer parameter.

" + } + } + }, + { + "$type": "ObjectType", + "name": "IntegerParameterDeclaration", + "properties": { + "DefaultValues": { + "type": { + "$ref": "#/270" + }, + "flags": 0 + }, + "MappedDataSetParameters": { + "type": { + "$ref": "#/708" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "ParameterValueType": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "ValueWhenUnset": { + "type": { + "$ref": "#/273" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "IntegerValueWhenUnsetConfiguration", + "properties": { + "CustomValue": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "ValueWhenUnsetOption": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ItemsLimitConfiguration", + "properties": { + "ItemsLimit": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "OtherCategories": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "KPIActualValueConditionalFormatting", + "properties": { + "Icon": { + "type": { + "$ref": "#/88" + }, + "flags": 0 + }, + "TextColor": { + "type": { + "$ref": "#/84" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "KPIComparisonValueConditionalFormatting", + "properties": { + "Icon": { + "type": { + "$ref": "#/88" + }, + "flags": 0 + }, + "TextColor": { + "type": { + "$ref": "#/84" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "KPIConditionalFormatting", + "properties": { + "ConditionalFormattingOptions": { + "type": { + "$ref": "#/709" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "KPIConditionalFormattingOption", + "properties": { + "ActualValue": { + "type": { + "$ref": "#/275" + }, + "flags": 0 + }, + "ComparisonValue": { + "type": { + "$ref": "#/276" + }, + "flags": 0 + }, + "PrimaryValue": { + "type": { + "$ref": "#/282" + }, + "flags": 0 + }, + "ProgressBar": { + "type": { + "$ref": "#/283" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "KPIConfiguration", + "properties": { + "FieldWells": { + "type": { + "$ref": "#/280" + }, + "flags": 0 + }, + "KPIOptions": { + "type": { + "$ref": "#/281" + }, + "flags": 0 + }, + "SortConfiguration": { + "type": { + "$ref": "#/284" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "KPIFieldWells", + "properties": { + "TargetValues": { + "type": { + "$ref": "#/710" + }, + "flags": 0 + }, + "TrendGroups": { + "type": { + "$ref": "#/711" + }, + "flags": 0 + }, + "Values": { + "type": { + "$ref": "#/712" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "KPIOptions", + "properties": { + "Comparison": { + "type": { + "$ref": "#/80" + }, + "flags": 0 + }, + "PrimaryValueDisplayType": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "PrimaryValueFontConfiguration": { + "type": { + "$ref": "#/201" + }, + "flags": 0 + }, + "ProgressBar": { + "type": { + "$ref": "#/404" + }, + "flags": 0 + }, + "SecondaryValue": { + "type": { + "$ref": "#/449" + }, + "flags": 0 + }, + "SecondaryValueFontConfiguration": { + "type": { + "$ref": "#/201" + }, + "flags": 0 + }, + "Sparkline": { + "type": { + "$ref": "#/285" + }, + "flags": 0 + }, + "TrendArrows": { + "type": { + "$ref": "#/562" + }, + "flags": 0 + }, + "VisualLayoutOptions": { + "type": { + "$ref": "#/288" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "KPIPrimaryValueConditionalFormatting", + "properties": { + "Icon": { + "type": { + "$ref": "#/88" + }, + "flags": 0 + }, + "TextColor": { + "type": { + "$ref": "#/84" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "KPIProgressBarConditionalFormatting", + "properties": { + "ForegroundColor": { + "type": { + "$ref": "#/84" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "KPISortConfiguration", + "properties": { + "TrendGroupSort": { + "type": { + "$ref": "#/713" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "KPISparklineOptions", + "properties": { + "Color": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "TooltipVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "KPISparklineType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "KPIVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/714" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/279" + }, + "flags": 0 + }, + "ColumnHierarchies": { + "type": { + "$ref": "#/715" + }, + "flags": 0 + }, + "ConditionalFormatting": { + "type": { + "$ref": "#/277" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/577" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/578" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "KPIVisualLayoutOptions", + "properties": { + "StandardLayout": { + "type": { + "$ref": "#/289" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "KPIVisualStandardLayout", + "properties": { + "Type": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "KPIVisualStandardLayoutType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LabelOptions", + "properties": { + "CustomLabel": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "FontConfiguration": { + "type": { + "$ref": "#/201" + }, + "flags": 0 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Layout", + "properties": { + "Configuration": { + "type": { + "$ref": "#/293" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "LayoutConfiguration", + "properties": { + "FreeFormLayout": { + "type": { + "$ref": "#/213" + }, + "flags": 0 + }, + "GridLayout": { + "type": { + "$ref": "#/250" + }, + "flags": 0 + }, + "SectionBasedLayout": { + "type": { + "$ref": "#/452" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "LayoutElementType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LegendOptions", + "properties": { + "Height": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "String based length that is composed of value and unit in px" + }, + "Position": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/291" + }, + "flags": 0 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Width": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "String based length that is composed of value and unit in px" + } + } + }, + { + "$type": "ObjectType", + "name": "LegendPosition", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LineChartAggregatedFieldWells", + "properties": { + "Category": { + "type": { + "$ref": "#/716" + }, + "flags": 0 + }, + "Colors": { + "type": { + "$ref": "#/717" + }, + "flags": 0 + }, + "SmallMultiples": { + "type": { + "$ref": "#/718" + }, + "flags": 0 + }, + "Values": { + "type": { + "$ref": "#/719" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "LineChartConfiguration", + "properties": { + "ContributionAnalysisDefaults": { + "type": { + "$ref": "#/720" + }, + "flags": 0 + }, + "DataLabels": { + "type": { + "$ref": "#/115" + }, + "flags": 0 + }, + "DefaultSeriesSettings": { + "type": { + "$ref": "#/299" + }, + "flags": 0 + }, + "FieldWells": { + "type": { + "$ref": "#/300" + }, + "flags": 0 + }, + "ForecastConfigurations": { + "type": { + "$ref": "#/721" + }, + "flags": 0 + }, + "Legend": { + "type": { + "$ref": "#/295" + }, + "flags": 0 + }, + "PrimaryYAxisDisplayOptions": { + "type": { + "$ref": "#/310" + }, + "flags": 0 + }, + "PrimaryYAxisLabelOptions": { + "type": { + "$ref": "#/63" + }, + "flags": 0 + }, + "ReferenceLines": { + "type": { + "$ref": "#/722" + }, + "flags": 0 + }, + "SecondaryYAxisDisplayOptions": { + "type": { + "$ref": "#/310" + }, + "flags": 0 + }, + "SecondaryYAxisLabelOptions": { + "type": { + "$ref": "#/63" + }, + "flags": 0 + }, + "Series": { + "type": { + "$ref": "#/723" + }, + "flags": 0 + }, + "SmallMultiplesOptions": { + "type": { + "$ref": "#/487" + }, + "flags": 0 + }, + "SortConfiguration": { + "type": { + "$ref": "#/306" + }, + "flags": 0 + }, + "Tooltip": { + "type": { + "$ref": "#/546" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "VisualPalette": { + "type": { + "$ref": "#/576" + }, + "flags": 0 + }, + "XAxisDisplayOptions": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "XAxisLabelOptions": { + "type": { + "$ref": "#/63" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "LineChartDefaultSeriesSettings", + "properties": { + "AxisBinding": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "LineStyleSettings": { + "type": { + "$ref": "#/302" + }, + "flags": 0 + }, + "MarkerStyleSettings": { + "type": { + "$ref": "#/304" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "LineChartFieldWells", + "properties": { + "LineChartAggregatedFieldWells": { + "type": { + "$ref": "#/297" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "LineChartLineStyle", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LineChartLineStyleSettings", + "properties": { + "LineInterpolation": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "LineStyle": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "LineVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "LineWidth": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "String based length that is composed of value and unit in px" + } + } + }, + { + "$type": "ObjectType", + "name": "LineChartMarkerShape", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LineChartMarkerStyleSettings", + "properties": { + "MarkerColor": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "MarkerShape": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "MarkerSize": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "String based length that is composed of value and unit in px" + }, + "MarkerVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "LineChartSeriesSettings", + "properties": { + "LineStyleSettings": { + "type": { + "$ref": "#/302" + }, + "flags": 0 + }, + "MarkerStyleSettings": { + "type": { + "$ref": "#/304" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "LineChartSortConfiguration", + "properties": { + "CategoryItemsLimitConfiguration": { + "type": { + "$ref": "#/274" + }, + "flags": 0 + }, + "CategorySort": { + "type": { + "$ref": "#/724" + }, + "flags": 0 + }, + "ColorItemsLimitConfiguration": { + "type": { + "$ref": "#/274" + }, + "flags": 0 + }, + "SmallMultiplesLimitConfiguration": { + "type": { + "$ref": "#/274" + }, + "flags": 0 + }, + "SmallMultiplesSort": { + "type": { + "$ref": "#/725" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "LineChartType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LineChartVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/726" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/298" + }, + "flags": 0 + }, + "ColumnHierarchies": { + "type": { + "$ref": "#/727" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/577" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/578" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "LineInterpolation", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LineSeriesAxisDisplayOptions", + "properties": { + "AxisOptions": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "MissingDataConfigurations": { + "type": { + "$ref": "#/728" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ListControlDisplayOptions", + "properties": { + "InfoIconLabelOptions": { + "type": { + "$ref": "#/468" + }, + "flags": 0 + }, + "SearchOptions": { + "type": { + "$ref": "#/312" + }, + "flags": 0 + }, + "SelectAllOptions": { + "type": { + "$ref": "#/313" + }, + "flags": 0 + }, + "TitleOptions": { + "type": { + "$ref": "#/291" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ListControlSearchOptions", + "properties": { + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ListControlSelectAllOptions", + "properties": { + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "LoadingAnimation", + "properties": { + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "LocalNavigationConfiguration", + "properties": { + "TargetSheetId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "LongFormatText", + "properties": { + "PlainText": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "RichText": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "MapZoomMode", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MappedDataSetParameter", + "properties": { + "DataSetIdentifier": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "DataSetParameterName": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "MaximumLabelType", + "properties": { + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "MaximumMinimumComputation", + "properties": { + "ComputationId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Time": { + "type": { + "$ref": "#/159" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/322" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "MaximumMinimumComputationType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MeasureField", + "properties": { + "CalculatedMeasureField": { + "type": { + "$ref": "#/52" + }, + "flags": 0 + }, + "CategoricalMeasureField": { + "type": { + "$ref": "#/57" + }, + "flags": 0 + }, + "DateMeasureField": { + "type": { + "$ref": "#/129" + }, + "flags": 0 + }, + "NumericalMeasureField": { + "type": { + "$ref": "#/345" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "MetricComparisonComputation", + "properties": { + "ComputationId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "FromValue": { + "type": { + "$ref": "#/322" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "TargetValue": { + "type": { + "$ref": "#/322" + }, + "flags": 0 + }, + "Time": { + "type": { + "$ref": "#/159" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "MinimumLabelType", + "properties": { + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "MissingDataConfiguration", + "properties": { + "TreatmentOption": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "MissingDataTreatmentOption", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "NegativeValueConfiguration", + "properties": { + "DisplayMode": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "NegativeValueDisplayMode", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "NullValueFormatConfiguration", + "properties": { + "NullString": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "NumberDisplayFormatConfiguration", + "properties": { + "DecimalPlacesConfiguration": { + "type": { + "$ref": "#/141" + }, + "flags": 0 + }, + "NegativeValueConfiguration": { + "type": { + "$ref": "#/327" + }, + "flags": 0 + }, + "NullValueFormatConfiguration": { + "type": { + "$ref": "#/329" + }, + "flags": 0 + }, + "NumberScale": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Prefix": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "SeparatorConfiguration": { + "type": { + "$ref": "#/341" + }, + "flags": 0 + }, + "Suffix": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "NumberFormatConfiguration", + "properties": { + "FormatConfiguration": { + "type": { + "$ref": "#/338" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "NumberScale", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "NumericAxisOptions", + "properties": { + "Range": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "Scale": { + "type": { + "$ref": "#/29" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "NumericEqualityDrillDownFilter", + "properties": { + "Column": { + "type": { + "$ref": "#/71" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "NumericEqualityFilter", + "properties": { + "AggregationFunction": { + "type": { + "$ref": "#/0" + }, + "flags": 0 + }, + "Column": { + "type": { + "$ref": "#/71" + }, + "flags": 1 + }, + "DefaultFilterControlConfiguration": { + "type": { + "$ref": "#/144" + }, + "flags": 0 + }, + "FilterId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "MatchOperator": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "NullOption": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "ParameterName": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "SelectAllOptions": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "NumericEqualityMatchOperator", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "NumericFilterSelectAllOptions", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "NumericFormatConfiguration", + "properties": { + "CurrencyDisplayFormatConfiguration": { + "type": { + "$ref": "#/96" + }, + "flags": 0 + }, + "NumberDisplayFormatConfiguration": { + "type": { + "$ref": "#/330" + }, + "flags": 0 + }, + "PercentageDisplayFormatConfiguration": { + "type": { + "$ref": "#/365" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "NumericRangeFilter", + "properties": { + "AggregationFunction": { + "type": { + "$ref": "#/0" + }, + "flags": 0 + }, + "Column": { + "type": { + "$ref": "#/71" + }, + "flags": 1 + }, + "DefaultFilterControlConfiguration": { + "type": { + "$ref": "#/144" + }, + "flags": 0 + }, + "FilterId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "IncludeMaximum": { + "type": { + "$ref": "#/650" + }, + "flags": 0 + }, + "IncludeMinimum": { + "type": { + "$ref": "#/650" + }, + "flags": 0 + }, + "NullOption": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "RangeMaximum": { + "type": { + "$ref": "#/340" + }, + "flags": 0 + }, + "RangeMinimum": { + "type": { + "$ref": "#/340" + }, + "flags": 0 + }, + "SelectAllOptions": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "NumericRangeFilterValue", + "properties": { + "Parameter": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "StaticValue": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "NumericSeparatorConfiguration", + "properties": { + "DecimalSeparator": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ThousandsSeparator": { + "type": { + "$ref": "#/538" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "NumericSeparatorSymbol", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "NumericalAggregationFunction", + "properties": { + "PercentileAggregation": { + "type": { + "$ref": "#/366" + }, + "flags": 0 + }, + "SimpleNumericalAggregation": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "NumericalDimensionField", + "properties": { + "Column": { + "type": { + "$ref": "#/71" + }, + "flags": 1 + }, + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "FormatConfiguration": { + "type": { + "$ref": "#/331" + }, + "flags": 0 + }, + "HierarchyId": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "NumericalMeasureField", + "properties": { + "AggregationFunction": { + "type": { + "$ref": "#/343" + }, + "flags": 0 + }, + "Column": { + "type": { + "$ref": "#/71" + }, + "flags": 1 + }, + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "FormatConfiguration": { + "type": { + "$ref": "#/331" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "OtherCategories", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PaginationConfiguration", + "properties": { + "PageNumber": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + }, + "PageSize": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "PanelBorderStyle", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PanelConfiguration", + "properties": { + "BackgroundColor": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "BackgroundVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "BorderColor": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "BorderStyle": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "BorderThickness": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "String based length that is composed of value and unit in px" + }, + "BorderVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "GutterSpacing": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "String based length that is composed of value and unit in px" + }, + "GutterVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/350" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PanelTitleOptions", + "properties": { + "FontConfiguration": { + "type": { + "$ref": "#/201" + }, + "flags": 0 + }, + "HorizontalTextAlignment": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PaperOrientation", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PaperSize", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ParameterControl", + "properties": { + "DateTimePicker": { + "type": { + "$ref": "#/354" + }, + "flags": 0 + }, + "Dropdown": { + "type": { + "$ref": "#/356" + }, + "flags": 0 + }, + "List": { + "type": { + "$ref": "#/357" + }, + "flags": 0 + }, + "Slider": { + "type": { + "$ref": "#/359" + }, + "flags": 0 + }, + "TextArea": { + "type": { + "$ref": "#/360" + }, + "flags": 0 + }, + "TextField": { + "type": { + "$ref": "#/361" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ParameterDateTimePickerControl", + "properties": { + "DisplayOptions": { + "type": { + "$ref": "#/135" + }, + "flags": 0 + }, + "ParameterControlId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "SourceParameterName": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Title": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ParameterDeclaration", + "properties": { + "DateTimeParameterDeclaration": { + "type": { + "$ref": "#/134" + }, + "flags": 0 + }, + "DecimalParameterDeclaration": { + "type": { + "$ref": "#/140" + }, + "flags": 0 + }, + "IntegerParameterDeclaration": { + "type": { + "$ref": "#/272" + }, + "flags": 0 + }, + "StringParameterDeclaration": { + "type": { + "$ref": "#/494" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ParameterDropDownControl", + "properties": { + "CascadingControlConfiguration": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "DisplayOptions": { + "type": { + "$ref": "#/163" + }, + "flags": 0 + }, + "ParameterControlId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "SelectableValues": { + "type": { + "$ref": "#/358" + }, + "flags": 0 + }, + "SourceParameterName": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Title": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Type": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ParameterListControl", + "properties": { + "CascadingControlConfiguration": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "DisplayOptions": { + "type": { + "$ref": "#/311" + }, + "flags": 0 + }, + "ParameterControlId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "SelectableValues": { + "type": { + "$ref": "#/358" + }, + "flags": 0 + }, + "SourceParameterName": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Title": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Type": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ParameterSelectableValues", + "properties": { + "LinkToDataSetColumn": { + "type": { + "$ref": "#/71" + }, + "flags": 0 + }, + "Values": { + "type": { + "$ref": "#/729" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ParameterSliderControl", + "properties": { + "DisplayOptions": { + "type": { + "$ref": "#/483" + }, + "flags": 0 + }, + "MaximumValue": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + }, + "MinimumValue": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + }, + "ParameterControlId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "SourceParameterName": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "StepSize": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + }, + "Title": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ParameterTextAreaControl", + "properties": { + "Delimiter": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "DisplayOptions": { + "type": { + "$ref": "#/533" + }, + "flags": 0 + }, + "ParameterControlId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "SourceParameterName": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Title": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ParameterTextFieldControl", + "properties": { + "DisplayOptions": { + "type": { + "$ref": "#/536" + }, + "flags": 0 + }, + "ParameterControlId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "SourceParameterName": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Title": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ParameterValueType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Parameters", + "properties": { + "DateTimeParameters": { + "type": { + "$ref": "#/730" + }, + "flags": 0, + "description": "

The parameters that have a data type of date-time.

" + }, + "DecimalParameters": { + "type": { + "$ref": "#/731" + }, + "flags": 0, + "description": "

The parameters that have a data type of decimal.

" + }, + "IntegerParameters": { + "type": { + "$ref": "#/732" + }, + "flags": 0, + "description": "

The parameters that have a data type of integer.

" + }, + "StringParameters": { + "type": { + "$ref": "#/733" + }, + "flags": 0, + "description": "

The parameters that have a data type of string.

" + } + } + }, + { + "$type": "ObjectType", + "name": "PercentVisibleRange", + "properties": { + "From": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "To": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PercentageDisplayFormatConfiguration", + "properties": { + "DecimalPlacesConfiguration": { + "type": { + "$ref": "#/141" + }, + "flags": 0 + }, + "NegativeValueConfiguration": { + "type": { + "$ref": "#/327" + }, + "flags": 0 + }, + "NullValueFormatConfiguration": { + "type": { + "$ref": "#/329" + }, + "flags": 0 + }, + "Prefix": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "SeparatorConfiguration": { + "type": { + "$ref": "#/341" + }, + "flags": 0 + }, + "Suffix": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PercentileAggregation", + "properties": { + "PercentileValue": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PeriodOverPeriodComputation", + "properties": { + "ComputationId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Time": { + "type": { + "$ref": "#/159" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/322" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PeriodToDateComputation", + "properties": { + "ComputationId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "PeriodTimeGranularity": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Time": { + "type": { + "$ref": "#/159" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/322" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PieChartAggregatedFieldWells", + "properties": { + "Category": { + "type": { + "$ref": "#/734" + }, + "flags": 0 + }, + "SmallMultiples": { + "type": { + "$ref": "#/735" + }, + "flags": 0 + }, + "Values": { + "type": { + "$ref": "#/736" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PieChartConfiguration", + "properties": { + "CategoryLabelOptions": { + "type": { + "$ref": "#/63" + }, + "flags": 0 + }, + "ContributionAnalysisDefaults": { + "type": { + "$ref": "#/737" + }, + "flags": 0 + }, + "DataLabels": { + "type": { + "$ref": "#/115" + }, + "flags": 0 + }, + "DonutOptions": { + "type": { + "$ref": "#/161" + }, + "flags": 0 + }, + "FieldWells": { + "type": { + "$ref": "#/371" + }, + "flags": 0 + }, + "Legend": { + "type": { + "$ref": "#/295" + }, + "flags": 0 + }, + "SmallMultiplesOptions": { + "type": { + "$ref": "#/487" + }, + "flags": 0 + }, + "SortConfiguration": { + "type": { + "$ref": "#/372" + }, + "flags": 0 + }, + "Tooltip": { + "type": { + "$ref": "#/546" + }, + "flags": 0 + }, + "ValueLabelOptions": { + "type": { + "$ref": "#/63" + }, + "flags": 0 + }, + "VisualPalette": { + "type": { + "$ref": "#/576" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PieChartFieldWells", + "properties": { + "PieChartAggregatedFieldWells": { + "type": { + "$ref": "#/369" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PieChartSortConfiguration", + "properties": { + "CategoryItemsLimit": { + "type": { + "$ref": "#/274" + }, + "flags": 0 + }, + "CategorySort": { + "type": { + "$ref": "#/738" + }, + "flags": 0 + }, + "SmallMultiplesLimitConfiguration": { + "type": { + "$ref": "#/274" + }, + "flags": 0 + }, + "SmallMultiplesSort": { + "type": { + "$ref": "#/739" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PieChartVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/740" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/370" + }, + "flags": 0 + }, + "ColumnHierarchies": { + "type": { + "$ref": "#/741" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/577" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/578" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotFieldSortOptions", + "properties": { + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "SortBy": { + "type": { + "$ref": "#/396" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTableAggregatedFieldWells", + "properties": { + "Columns": { + "type": { + "$ref": "#/742" + }, + "flags": 0 + }, + "Rows": { + "type": { + "$ref": "#/743" + }, + "flags": 0 + }, + "Values": { + "type": { + "$ref": "#/744" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTableCellConditionalFormatting", + "properties": { + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Scope": { + "type": { + "$ref": "#/379" + }, + "flags": 0 + }, + "Scopes": { + "type": { + "$ref": "#/745" + }, + "flags": 0 + }, + "TextFormat": { + "type": { + "$ref": "#/534" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTableConditionalFormatting", + "properties": { + "ConditionalFormattingOptions": { + "type": { + "$ref": "#/746" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTableConditionalFormattingOption", + "properties": { + "Cell": { + "type": { + "$ref": "#/376" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTableConditionalFormattingScope", + "properties": { + "Role": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTableConditionalFormattingScopeRole", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PivotTableConfiguration", + "properties": { + "FieldOptions": { + "type": { + "$ref": "#/388" + }, + "flags": 0 + }, + "FieldWells": { + "type": { + "$ref": "#/390" + }, + "flags": 0 + }, + "PaginatedReportOptions": { + "type": { + "$ref": "#/393" + }, + "flags": 0 + }, + "SortConfiguration": { + "type": { + "$ref": "#/397" + }, + "flags": 0 + }, + "TableOptions": { + "type": { + "$ref": "#/392" + }, + "flags": 0 + }, + "TotalOptions": { + "type": { + "$ref": "#/399" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTableDataPathOption", + "properties": { + "DataPathList": { + "type": { + "$ref": "#/747" + }, + "flags": 1 + }, + "Width": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "String based length that is composed of value and unit in px" + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTableDataPathType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PivotTableFieldCollapseState", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PivotTableFieldCollapseStateOption", + "properties": { + "State": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Target": { + "type": { + "$ref": "#/386" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTableFieldCollapseStateTarget", + "properties": { + "FieldDataPathValues": { + "type": { + "$ref": "#/748" + }, + "flags": 0 + }, + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTableFieldOption", + "properties": { + "CustomLabel": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTableFieldOptions", + "properties": { + "CollapseStateOptions": { + "type": { + "$ref": "#/749" + }, + "flags": 0 + }, + "DataPathOptions": { + "type": { + "$ref": "#/750" + }, + "flags": 0 + }, + "SelectedFieldOptions": { + "type": { + "$ref": "#/751" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTableFieldSubtotalOptions", + "properties": { + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTableFieldWells", + "properties": { + "PivotTableAggregatedFieldWells": { + "type": { + "$ref": "#/375" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTableMetricPlacement", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PivotTableOptions", + "properties": { + "CellStyle": { + "type": { + "$ref": "#/504" + }, + "flags": 0 + }, + "CollapsedRowDimensionsVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ColumnHeaderStyle": { + "type": { + "$ref": "#/504" + }, + "flags": 0 + }, + "ColumnNamesVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "DefaultCellWidth": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "String based length that is composed of value and unit in px" + }, + "MetricPlacement": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "RowAlternateColorOptions": { + "type": { + "$ref": "#/436" + }, + "flags": 0 + }, + "RowFieldNamesStyle": { + "type": { + "$ref": "#/504" + }, + "flags": 0 + }, + "RowHeaderStyle": { + "type": { + "$ref": "#/504" + }, + "flags": 0 + }, + "RowsLabelOptions": { + "type": { + "$ref": "#/394" + }, + "flags": 0 + }, + "RowsLayout": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "SingleMetricVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ToggleButtonsVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTablePaginatedReportOptions", + "properties": { + "OverflowColumnHeaderVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "VerticalOverflowVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTableRowsLabelOptions", + "properties": { + "CustomLabel": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTableRowsLayout", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PivotTableSortBy", + "properties": { + "Column": { + "type": { + "$ref": "#/73" + }, + "flags": 0 + }, + "DataPath": { + "type": { + "$ref": "#/121" + }, + "flags": 0 + }, + "Field": { + "type": { + "$ref": "#/172" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTableSortConfiguration", + "properties": { + "FieldSortOptions": { + "type": { + "$ref": "#/752" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTableSubtotalLevel", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PivotTableTotalOptions", + "properties": { + "ColumnSubtotalOptions": { + "type": { + "$ref": "#/497" + }, + "flags": 0 + }, + "ColumnTotalOptions": { + "type": { + "$ref": "#/401" + }, + "flags": 0 + }, + "RowSubtotalOptions": { + "type": { + "$ref": "#/497" + }, + "flags": 0 + }, + "RowTotalOptions": { + "type": { + "$ref": "#/401" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTableVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/753" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/381" + }, + "flags": 0 + }, + "ConditionalFormatting": { + "type": { + "$ref": "#/377" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/577" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/578" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTotalOptions", + "properties": { + "CustomLabel": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "MetricHeaderCellStyle": { + "type": { + "$ref": "#/504" + }, + "flags": 0 + }, + "Placement": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ScrollStatus": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "TotalAggregationOptions": { + "type": { + "$ref": "#/754" + }, + "flags": 0 + }, + "TotalCellStyle": { + "type": { + "$ref": "#/504" + }, + "flags": 0 + }, + "TotalsVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ValueCellStyle": { + "type": { + "$ref": "#/504" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PredefinedHierarchy", + "properties": { + "Columns": { + "type": { + "$ref": "#/755" + }, + "flags": 1 + }, + "DrillDownFilters": { + "type": { + "$ref": "#/756" + }, + "flags": 0 + }, + "HierarchyId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "PrimaryValueDisplayType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ProgressBarOptions", + "properties": { + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "RadarChartAggregatedFieldWells", + "properties": { + "Category": { + "type": { + "$ref": "#/757" + }, + "flags": 0 + }, + "Color": { + "type": { + "$ref": "#/758" + }, + "flags": 0 + }, + "Values": { + "type": { + "$ref": "#/759" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "RadarChartAreaStyleSettings", + "properties": { + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "RadarChartAxesRangeScale", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RadarChartConfiguration", + "properties": { + "AlternateBandColorsVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "AlternateBandEvenColor": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "AlternateBandOddColor": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "AxesRangeScale": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "BaseSeriesSettings": { + "type": { + "$ref": "#/410" + }, + "flags": 0 + }, + "CategoryAxis": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "CategoryLabelOptions": { + "type": { + "$ref": "#/63" + }, + "flags": 0 + }, + "ColorAxis": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "ColorLabelOptions": { + "type": { + "$ref": "#/63" + }, + "flags": 0 + }, + "FieldWells": { + "type": { + "$ref": "#/409" + }, + "flags": 0 + }, + "Legend": { + "type": { + "$ref": "#/295" + }, + "flags": 0 + }, + "Shape": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "SortConfiguration": { + "type": { + "$ref": "#/412" + }, + "flags": 0 + }, + "StartAngle": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "VisualPalette": { + "type": { + "$ref": "#/576" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "RadarChartFieldWells", + "properties": { + "RadarChartAggregatedFieldWells": { + "type": { + "$ref": "#/405" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "RadarChartSeriesSettings", + "properties": { + "AreaStyleSettings": { + "type": { + "$ref": "#/406" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "RadarChartShape", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RadarChartSortConfiguration", + "properties": { + "CategoryItemsLimit": { + "type": { + "$ref": "#/274" + }, + "flags": 0 + }, + "CategorySort": { + "type": { + "$ref": "#/760" + }, + "flags": 0 + }, + "ColorItemsLimit": { + "type": { + "$ref": "#/274" + }, + "flags": 0 + }, + "ColorSort": { + "type": { + "$ref": "#/761" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "RadarChartVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/762" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/408" + }, + "flags": 0 + }, + "ColumnHierarchies": { + "type": { + "$ref": "#/763" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/577" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/578" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "RangeEndsLabelType", + "properties": { + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ReferenceLine", + "properties": { + "DataConfiguration": { + "type": { + "$ref": "#/417" + }, + "flags": 1 + }, + "LabelConfiguration": { + "type": { + "$ref": "#/419" + }, + "flags": 0 + }, + "Status": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "StyleConfiguration": { + "type": { + "$ref": "#/425" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ReferenceLineCustomLabelConfiguration", + "properties": { + "CustomLabel": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ReferenceLineDataConfiguration", + "properties": { + "AxisBinding": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "DynamicConfiguration": { + "type": { + "$ref": "#/418" + }, + "flags": 0 + }, + "SeriesType": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "StaticConfiguration": { + "type": { + "$ref": "#/424" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ReferenceLineDynamicDataConfiguration", + "properties": { + "Calculation": { + "type": { + "$ref": "#/343" + }, + "flags": 1 + }, + "Column": { + "type": { + "$ref": "#/71" + }, + "flags": 1 + }, + "MeasureAggregationFunction": { + "type": { + "$ref": "#/0" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ReferenceLineLabelConfiguration", + "properties": { + "CustomLabelConfiguration": { + "type": { + "$ref": "#/416" + }, + "flags": 0 + }, + "FontColor": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "FontConfiguration": { + "type": { + "$ref": "#/201" + }, + "flags": 0 + }, + "HorizontalPosition": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ValueLabelConfiguration": { + "type": { + "$ref": "#/426" + }, + "flags": 0 + }, + "VerticalPosition": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ReferenceLineLabelHorizontalPosition", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ReferenceLineLabelVerticalPosition", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ReferenceLinePatternType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ReferenceLineSeriesType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ReferenceLineStaticDataConfiguration", + "properties": { + "Value": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ReferenceLineStyleConfiguration", + "properties": { + "Color": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Pattern": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ReferenceLineValueLabelConfiguration", + "properties": { + "FormatConfiguration": { + "type": { + "$ref": "#/338" + }, + "flags": 0 + }, + "RelativePosition": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ReferenceLineValueLabelRelativePosition", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RelativeDateTimeControlDisplayOptions", + "properties": { + "DateTimeFormat": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "InfoIconLabelOptions": { + "type": { + "$ref": "#/468" + }, + "flags": 0 + }, + "TitleOptions": { + "type": { + "$ref": "#/291" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "RelativeDateType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RelativeDatesFilter", + "properties": { + "AnchorDateConfiguration": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + }, + "Column": { + "type": { + "$ref": "#/71" + }, + "flags": 1 + }, + "DefaultFilterControlConfiguration": { + "type": { + "$ref": "#/144" + }, + "flags": 0 + }, + "ExcludePeriodConfiguration": { + "type": { + "$ref": "#/167" + }, + "flags": 0 + }, + "FilterId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "MinimumGranularity": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "NullOption": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "ParameterName": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "RelativeDateType": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "RelativeDateValue": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "TimeGranularity": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "RelativeFontSize", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ResizeOption", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ResourcePermission", + "properties": { + "Actions": { + "type": { + "$ref": "#/764" + }, + "flags": 1, + "description": "

The IAM action to grant or revoke permissions on.

" + }, + "Principal": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

The Amazon Resource Name (ARN) of the principal. This can be one of the\n following:

\n
    \n
  • \n

    The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

    \n
    • \n
  • \n

    The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)

    \n
    • \n
  • \n

    The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight\n ARN. Use this option only to share resources (templates) across Amazon Web Services accounts.\n (This is less common.)

    \n
    • \n
" + } + } + }, + { + "$type": "ObjectType", + "name": "ResourceStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RollingDateConfiguration", + "properties": { + "DataSetIdentifier": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Expression": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "RowAlternateColorOptions", + "properties": { + "RowAlternateColors": { + "type": { + "$ref": "#/765" + }, + "flags": 0 + }, + "Status": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "UsePrimaryBackgroundColor": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SameSheetTargetVisualConfiguration", + "properties": { + "TargetVisualOptions": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "TargetVisuals": { + "type": { + "$ref": "#/766" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SankeyDiagramAggregatedFieldWells", + "properties": { + "Destination": { + "type": { + "$ref": "#/767" + }, + "flags": 0 + }, + "Source": { + "type": { + "$ref": "#/768" + }, + "flags": 0 + }, + "Weight": { + "type": { + "$ref": "#/769" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SankeyDiagramChartConfiguration", + "properties": { + "DataLabels": { + "type": { + "$ref": "#/115" + }, + "flags": 0 + }, + "FieldWells": { + "type": { + "$ref": "#/440" + }, + "flags": 0 + }, + "SortConfiguration": { + "type": { + "$ref": "#/441" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SankeyDiagramFieldWells", + "properties": { + "SankeyDiagramAggregatedFieldWells": { + "type": { + "$ref": "#/438" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SankeyDiagramSortConfiguration", + "properties": { + "DestinationItemsLimit": { + "type": { + "$ref": "#/274" + }, + "flags": 0 + }, + "SourceItemsLimit": { + "type": { + "$ref": "#/274" + }, + "flags": 0 + }, + "WeightSort": { + "type": { + "$ref": "#/770" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SankeyDiagramVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/771" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/439" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/577" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/578" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ScatterPlotCategoricallyAggregatedFieldWells", + "properties": { + "Category": { + "type": { + "$ref": "#/772" + }, + "flags": 0 + }, + "Label": { + "type": { + "$ref": "#/773" + }, + "flags": 0 + }, + "Size": { + "type": { + "$ref": "#/774" + }, + "flags": 0 + }, + "XAxis": { + "type": { + "$ref": "#/775" + }, + "flags": 0 + }, + "YAxis": { + "type": { + "$ref": "#/776" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ScatterPlotConfiguration", + "properties": { + "DataLabels": { + "type": { + "$ref": "#/115" + }, + "flags": 0 + }, + "FieldWells": { + "type": { + "$ref": "#/445" + }, + "flags": 0 + }, + "Legend": { + "type": { + "$ref": "#/295" + }, + "flags": 0 + }, + "Tooltip": { + "type": { + "$ref": "#/546" + }, + "flags": 0 + }, + "VisualPalette": { + "type": { + "$ref": "#/576" + }, + "flags": 0 + }, + "XAxisDisplayOptions": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "XAxisLabelOptions": { + "type": { + "$ref": "#/63" + }, + "flags": 0 + }, + "YAxisDisplayOptions": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "YAxisLabelOptions": { + "type": { + "$ref": "#/63" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ScatterPlotFieldWells", + "properties": { + "ScatterPlotCategoricallyAggregatedFieldWells": { + "type": { + "$ref": "#/443" + }, + "flags": 0 + }, + "ScatterPlotUnaggregatedFieldWells": { + "type": { + "$ref": "#/446" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ScatterPlotUnaggregatedFieldWells", + "properties": { + "Category": { + "type": { + "$ref": "#/777" + }, + "flags": 0 + }, + "Label": { + "type": { + "$ref": "#/778" + }, + "flags": 0 + }, + "Size": { + "type": { + "$ref": "#/779" + }, + "flags": 0 + }, + "XAxis": { + "type": { + "$ref": "#/780" + }, + "flags": 0 + }, + "YAxis": { + "type": { + "$ref": "#/781" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ScatterPlotVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/782" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/444" + }, + "flags": 0 + }, + "ColumnHierarchies": { + "type": { + "$ref": "#/783" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/577" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/578" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ScrollBarOptions", + "properties": { + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "VisibleRange": { + "type": { + "$ref": "#/571" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SecondaryValueOptions", + "properties": { + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SectionAfterPageBreak", + "properties": { + "Status": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SectionBasedLayoutCanvasSizeOptions", + "properties": { + "PaperCanvasSizeOptions": { + "type": { + "$ref": "#/453" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SectionBasedLayoutConfiguration", + "properties": { + "BodySections": { + "type": { + "$ref": "#/784" + }, + "flags": 1 + }, + "CanvasSizeOptions": { + "type": { + "$ref": "#/451" + }, + "flags": 1 + }, + "FooterSections": { + "type": { + "$ref": "#/785" + }, + "flags": 1 + }, + "HeaderSections": { + "type": { + "$ref": "#/786" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "SectionBasedLayoutPaperCanvasSizeOptions", + "properties": { + "PaperMargin": { + "type": { + "$ref": "#/489" + }, + "flags": 0 + }, + "PaperOrientation": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "PaperSize": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SectionLayoutConfiguration", + "properties": { + "FreeFormLayout": { + "type": { + "$ref": "#/218" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "SectionPageBreakConfiguration", + "properties": { + "After": { + "type": { + "$ref": "#/450" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SectionPageBreakStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SectionStyle", + "properties": { + "Height": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "String based length that is composed of value and unit in px" + }, + "Padding": { + "type": { + "$ref": "#/489" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SelectAllValueOptions", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SelectedFieldOptions", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SelectedSheetsFilterScopeConfiguration", + "properties": { + "SheetVisualScopingConfigurations": { + "type": { + "$ref": "#/787" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SelectedTooltipType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SeriesItem", + "properties": { + "DataFieldSeriesItem": { + "type": { + "$ref": "#/113" + }, + "flags": 0 + }, + "FieldSeriesItem": { + "type": { + "$ref": "#/171" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SetParameterValueConfiguration", + "properties": { + "DestinationParameterName": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/158" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ShapeConditionalFormat", + "properties": { + "BackgroundColor": { + "type": { + "$ref": "#/84" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Sheet", + "properties": { + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The name of a sheet. This name is displayed on the sheet's tab in the Amazon QuickSight\n console.

" + }, + "SheetId": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The unique identifier associated with a sheet.

" + } + } + }, + { + "$type": "ObjectType", + "name": "SheetContentType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SheetControlDateTimePickerType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SheetControlInfoIconLabelOptions", + "properties": { + "InfoIconText": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SheetControlLayout", + "properties": { + "Configuration": { + "type": { + "$ref": "#/470" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "SheetControlLayoutConfiguration", + "properties": { + "GridLayout": { + "type": { + "$ref": "#/250" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SheetControlListType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SheetControlSliderType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SheetDefinition", + "properties": { + "ContentType": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Description": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "FilterControls": { + "type": { + "$ref": "#/788" + }, + "flags": 0 + }, + "Layouts": { + "type": { + "$ref": "#/789" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ParameterControls": { + "type": { + "$ref": "#/790" + }, + "flags": 0 + }, + "SheetControlLayouts": { + "type": { + "$ref": "#/791" + }, + "flags": 0 + }, + "SheetId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "TextBoxes": { + "type": { + "$ref": "#/792" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Visuals": { + "type": { + "$ref": "#/793" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SheetElementConfigurationOverrides", + "properties": { + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SheetElementRenderingRule", + "properties": { + "ConfigurationOverrides": { + "type": { + "$ref": "#/474" + }, + "flags": 1 + }, + "Expression": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "SheetTextBox", + "properties": { + "Content": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "SheetTextBoxId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "SheetVisualScopingConfiguration", + "properties": { + "Scope": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "SheetId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "VisualIds": { + "type": { + "$ref": "#/794" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ShortFormatText", + "properties": { + "PlainText": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "RichText": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SimpleAttributeAggregationFunction", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SimpleClusterMarker", + "properties": { + "Color": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SimpleNumericalAggregationFunction", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SimpleTotalAggregationFunction", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SliderControlDisplayOptions", + "properties": { + "InfoIconLabelOptions": { + "type": { + "$ref": "#/468" + }, + "flags": 0 + }, + "TitleOptions": { + "type": { + "$ref": "#/291" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SmallMultiplesAxisPlacement", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SmallMultiplesAxisProperties", + "properties": { + "Placement": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Scale": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SmallMultiplesAxisScale", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SmallMultiplesOptions", + "properties": { + "MaxVisibleColumns": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "MaxVisibleRows": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "PanelConfiguration": { + "type": { + "$ref": "#/349" + }, + "flags": 0 + }, + "XAxis": { + "type": { + "$ref": "#/485" + }, + "flags": 0 + }, + "YAxis": { + "type": { + "$ref": "#/485" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SortDirection", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Spacing", + "properties": { + "Bottom": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "String based length that is composed of value and unit" + }, + "Left": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "String based length that is composed of value and unit" + }, + "Right": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "String based length that is composed of value and unit" + }, + "Top": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "String based length that is composed of value and unit" + } + } + }, + { + "$type": "ObjectType", + "name": "SpecialValue", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "StringDefaultValues", + "properties": { + "DynamicValue": { + "type": { + "$ref": "#/164" + }, + "flags": 0 + }, + "StaticValues": { + "type": { + "$ref": "#/795" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "StringFormatConfiguration", + "properties": { + "NullValueFormatConfiguration": { + "type": { + "$ref": "#/329" + }, + "flags": 0 + }, + "NumericFormatConfiguration": { + "type": { + "$ref": "#/338" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "StringParameter", + "properties": { + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

A display name for a string parameter.

" + }, + "Values": { + "type": { + "$ref": "#/796" + }, + "flags": 1, + "description": "

The values of a string parameter.

" + } + } + }, + { + "$type": "ObjectType", + "name": "StringParameterDeclaration", + "properties": { + "DefaultValues": { + "type": { + "$ref": "#/491" + }, + "flags": 0 + }, + "MappedDataSetParameters": { + "type": { + "$ref": "#/797" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "ParameterValueType": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "ValueWhenUnset": { + "type": { + "$ref": "#/495" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "StringValueWhenUnsetConfiguration", + "properties": { + "CustomValue": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ValueWhenUnsetOption": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "StyledCellType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SubtotalOptions", + "properties": { + "CustomLabel": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "FieldLevel": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "FieldLevelOptions": { + "type": { + "$ref": "#/798" + }, + "flags": 0 + }, + "MetricHeaderCellStyle": { + "type": { + "$ref": "#/504" + }, + "flags": 0 + }, + "StyleTargets": { + "type": { + "$ref": "#/799" + }, + "flags": 0 + }, + "TotalCellStyle": { + "type": { + "$ref": "#/504" + }, + "flags": 0 + }, + "TotalsVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ValueCellStyle": { + "type": { + "$ref": "#/504" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableAggregatedFieldWells", + "properties": { + "GroupBy": { + "type": { + "$ref": "#/800" + }, + "flags": 0 + }, + "Values": { + "type": { + "$ref": "#/801" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableBorderOptions", + "properties": { + "Color": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Style": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Thickness": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableBorderStyle", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TableCellConditionalFormatting", + "properties": { + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "TextFormat": { + "type": { + "$ref": "#/534" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableCellImageScalingConfiguration", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TableCellImageSizingConfiguration", + "properties": { + "TableCellImageScalingConfiguration": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableCellStyle", + "properties": { + "BackgroundColor": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Border": { + "type": { + "$ref": "#/246" + }, + "flags": 0 + }, + "FontConfiguration": { + "type": { + "$ref": "#/201" + }, + "flags": 0 + }, + "Height": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "HorizontalTextAlignment": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "TextWrap": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "VerticalTextAlignment": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableConditionalFormatting", + "properties": { + "ConditionalFormattingOptions": { + "type": { + "$ref": "#/802" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableConditionalFormattingOption", + "properties": { + "Cell": { + "type": { + "$ref": "#/501" + }, + "flags": 0 + }, + "Row": { + "type": { + "$ref": "#/523" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableConfiguration", + "properties": { + "FieldOptions": { + "type": { + "$ref": "#/515" + }, + "flags": 0 + }, + "FieldWells": { + "type": { + "$ref": "#/517" + }, + "flags": 0 + }, + "PaginatedReportOptions": { + "type": { + "$ref": "#/521" + }, + "flags": 0 + }, + "SortConfiguration": { + "type": { + "$ref": "#/525" + }, + "flags": 0 + }, + "TableInlineVisualizations": { + "type": { + "$ref": "#/803" + }, + "flags": 0 + }, + "TableOptions": { + "type": { + "$ref": "#/519" + }, + "flags": 0 + }, + "TotalOptions": { + "type": { + "$ref": "#/556" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableFieldCustomIconContent", + "properties": { + "Icon": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableFieldCustomTextContent", + "properties": { + "FontConfiguration": { + "type": { + "$ref": "#/201" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableFieldIconSetType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TableFieldImageConfiguration", + "properties": { + "SizingOptions": { + "type": { + "$ref": "#/503" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableFieldLinkConfiguration", + "properties": { + "Content": { + "type": { + "$ref": "#/513" + }, + "flags": 1 + }, + "Target": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TableFieldLinkContentConfiguration", + "properties": { + "CustomIconContent": { + "type": { + "$ref": "#/508" + }, + "flags": 0 + }, + "CustomTextContent": { + "type": { + "$ref": "#/509" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableFieldOption", + "properties": { + "CustomLabel": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "URLStyling": { + "type": { + "$ref": "#/516" + }, + "flags": 0 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Width": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "String based length that is composed of value and unit in px" + } + } + }, + { + "$type": "ObjectType", + "name": "TableFieldOptions", + "properties": { + "Order": { + "type": { + "$ref": "#/804" + }, + "flags": 0 + }, + "PinnedFieldOptions": { + "type": { + "$ref": "#/522" + }, + "flags": 0 + }, + "SelectedFieldOptions": { + "type": { + "$ref": "#/805" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableFieldURLConfiguration", + "properties": { + "ImageConfiguration": { + "type": { + "$ref": "#/511" + }, + "flags": 0 + }, + "LinkConfiguration": { + "type": { + "$ref": "#/512" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableFieldWells", + "properties": { + "TableAggregatedFieldWells": { + "type": { + "$ref": "#/498" + }, + "flags": 0 + }, + "TableUnaggregatedFieldWells": { + "type": { + "$ref": "#/529" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableInlineVisualization", + "properties": { + "DataBars": { + "type": { + "$ref": "#/111" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableOptions", + "properties": { + "CellStyle": { + "type": { + "$ref": "#/504" + }, + "flags": 0 + }, + "HeaderStyle": { + "type": { + "$ref": "#/504" + }, + "flags": 0 + }, + "Orientation": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "RowAlternateColorOptions": { + "type": { + "$ref": "#/436" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableOrientation", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TablePaginatedReportOptions", + "properties": { + "OverflowColumnHeaderVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "VerticalOverflowVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TablePinnedFieldOptions", + "properties": { + "PinnedLeftFields": { + "type": { + "$ref": "#/806" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableRowConditionalFormatting", + "properties": { + "BackgroundColor": { + "type": { + "$ref": "#/84" + }, + "flags": 0 + }, + "TextColor": { + "type": { + "$ref": "#/84" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableSideBorderOptions", + "properties": { + "Bottom": { + "type": { + "$ref": "#/499" + }, + "flags": 0 + }, + "InnerHorizontal": { + "type": { + "$ref": "#/499" + }, + "flags": 0 + }, + "InnerVertical": { + "type": { + "$ref": "#/499" + }, + "flags": 0 + }, + "Left": { + "type": { + "$ref": "#/499" + }, + "flags": 0 + }, + "Right": { + "type": { + "$ref": "#/499" + }, + "flags": 0 + }, + "Top": { + "type": { + "$ref": "#/499" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableSortConfiguration", + "properties": { + "PaginationConfiguration": { + "type": { + "$ref": "#/347" + }, + "flags": 0 + }, + "RowSort": { + "type": { + "$ref": "#/807" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableStyleTarget", + "properties": { + "CellType": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TableTotalsPlacement", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TableTotalsScrollStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TableUnaggregatedFieldWells", + "properties": { + "Values": { + "type": { + "$ref": "#/808" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/809" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/507" + }, + "flags": 0 + }, + "ConditionalFormatting": { + "type": { + "$ref": "#/505" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/577" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/578" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

Tag key.

" + }, + "Value": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

Tag value.

" + } + } + }, + { + "$type": "ObjectType", + "name": "TargetVisualOptions", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TextAreaControlDisplayOptions", + "properties": { + "InfoIconLabelOptions": { + "type": { + "$ref": "#/468" + }, + "flags": 0 + }, + "PlaceholderOptions": { + "type": { + "$ref": "#/535" + }, + "flags": 0 + }, + "TitleOptions": { + "type": { + "$ref": "#/291" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TextConditionalFormat", + "properties": { + "BackgroundColor": { + "type": { + "$ref": "#/84" + }, + "flags": 0 + }, + "Icon": { + "type": { + "$ref": "#/88" + }, + "flags": 0 + }, + "TextColor": { + "type": { + "$ref": "#/84" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TextControlPlaceholderOptions", + "properties": { + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TextFieldControlDisplayOptions", + "properties": { + "InfoIconLabelOptions": { + "type": { + "$ref": "#/468" + }, + "flags": 0 + }, + "PlaceholderOptions": { + "type": { + "$ref": "#/535" + }, + "flags": 0 + }, + "TitleOptions": { + "type": { + "$ref": "#/291" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TextWrap", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ThousandSeparatorOptions", + "properties": { + "Symbol": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TimeBasedForecastProperties", + "properties": { + "LowerBoundary": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "PeriodsBackward": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "PeriodsForward": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "PredictionInterval": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "Seasonality": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "UpperBoundary": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TimeEqualityFilter", + "properties": { + "Column": { + "type": { + "$ref": "#/71" + }, + "flags": 1 + }, + "DefaultFilterControlConfiguration": { + "type": { + "$ref": "#/144" + }, + "flags": 0 + }, + "FilterId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "ParameterName": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "RollingDate": { + "type": { + "$ref": "#/435" + }, + "flags": 0 + }, + "TimeGranularity": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TimeGranularity", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TimeRangeDrillDownFilter", + "properties": { + "Column": { + "type": { + "$ref": "#/71" + }, + "flags": 1 + }, + "RangeMaximum": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "RangeMinimum": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "TimeGranularity": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TimeRangeFilter", + "properties": { + "Column": { + "type": { + "$ref": "#/71" + }, + "flags": 1 + }, + "DefaultFilterControlConfiguration": { + "type": { + "$ref": "#/144" + }, + "flags": 0 + }, + "ExcludePeriodConfiguration": { + "type": { + "$ref": "#/167" + }, + "flags": 0 + }, + "FilterId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "IncludeMaximum": { + "type": { + "$ref": "#/650" + }, + "flags": 0 + }, + "IncludeMinimum": { + "type": { + "$ref": "#/650" + }, + "flags": 0 + }, + "NullOption": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "RangeMaximumValue": { + "type": { + "$ref": "#/544" + }, + "flags": 0 + }, + "RangeMinimumValue": { + "type": { + "$ref": "#/544" + }, + "flags": 0 + }, + "TimeGranularity": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TimeRangeFilterValue", + "properties": { + "Parameter": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "RollingDate": { + "type": { + "$ref": "#/435" + }, + "flags": 0 + }, + "StaticValue": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TooltipItem", + "properties": { + "ColumnTooltipItem": { + "type": { + "$ref": "#/74" + }, + "flags": 0 + }, + "FieldTooltipItem": { + "type": { + "$ref": "#/174" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TooltipOptions", + "properties": { + "FieldBasedTooltip": { + "type": { + "$ref": "#/169" + }, + "flags": 0 + }, + "SelectedTooltipType": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "TooltipVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TooltipTitleType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TopBottomComputationType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TopBottomFilter", + "properties": { + "AggregationSortConfigurations": { + "type": { + "$ref": "#/810" + }, + "flags": 1 + }, + "Column": { + "type": { + "$ref": "#/71" + }, + "flags": 1 + }, + "DefaultFilterControlConfiguration": { + "type": { + "$ref": "#/144" + }, + "flags": 0 + }, + "FilterId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Limit": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "ParameterName": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "TimeGranularity": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TopBottomMoversComputation", + "properties": { + "Category": { + "type": { + "$ref": "#/159" + }, + "flags": 0 + }, + "ComputationId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "MoverSize": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "SortOrder": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Time": { + "type": { + "$ref": "#/159" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/322" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TopBottomRankedComputation", + "properties": { + "Category": { + "type": { + "$ref": "#/159" + }, + "flags": 0 + }, + "ComputationId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ResultSize": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/322" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TopBottomSortOrder", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TotalAggregationComputation", + "properties": { + "ComputationId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/322" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TotalAggregationFunction", + "properties": { + "SimpleTotalAggregationFunction": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TotalAggregationOption", + "properties": { + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "TotalAggregationFunction": { + "type": { + "$ref": "#/554" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TotalOptions", + "properties": { + "CustomLabel": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Placement": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ScrollStatus": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "TotalAggregationOptions": { + "type": { + "$ref": "#/811" + }, + "flags": 0 + }, + "TotalCellStyle": { + "type": { + "$ref": "#/504" + }, + "flags": 0 + }, + "TotalsVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TreeMapAggregatedFieldWells", + "properties": { + "Colors": { + "type": { + "$ref": "#/812" + }, + "flags": 0 + }, + "Groups": { + "type": { + "$ref": "#/813" + }, + "flags": 0 + }, + "Sizes": { + "type": { + "$ref": "#/814" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TreeMapConfiguration", + "properties": { + "ColorLabelOptions": { + "type": { + "$ref": "#/63" + }, + "flags": 0 + }, + "ColorScale": { + "type": { + "$ref": "#/67" + }, + "flags": 0 + }, + "DataLabels": { + "type": { + "$ref": "#/115" + }, + "flags": 0 + }, + "FieldWells": { + "type": { + "$ref": "#/559" + }, + "flags": 0 + }, + "GroupLabelOptions": { + "type": { + "$ref": "#/63" + }, + "flags": 0 + }, + "Legend": { + "type": { + "$ref": "#/295" + }, + "flags": 0 + }, + "SizeLabelOptions": { + "type": { + "$ref": "#/63" + }, + "flags": 0 + }, + "SortConfiguration": { + "type": { + "$ref": "#/560" + }, + "flags": 0 + }, + "Tooltip": { + "type": { + "$ref": "#/546" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TreeMapFieldWells", + "properties": { + "TreeMapAggregatedFieldWells": { + "type": { + "$ref": "#/557" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TreeMapSortConfiguration", + "properties": { + "TreeMapGroupItemsLimitConfiguration": { + "type": { + "$ref": "#/274" + }, + "flags": 0 + }, + "TreeMapSort": { + "type": { + "$ref": "#/815" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TreeMapVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/816" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/558" + }, + "flags": 0 + }, + "ColumnHierarchies": { + "type": { + "$ref": "#/817" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/577" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/578" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TrendArrowOptions", + "properties": { + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "URLTargetConfiguration", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "UnaggregatedField", + "properties": { + "Column": { + "type": { + "$ref": "#/71" + }, + "flags": 1 + }, + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "FormatConfiguration": { + "type": { + "$ref": "#/211" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "UniqueValuesComputation", + "properties": { + "Category": { + "type": { + "$ref": "#/159" + }, + "flags": 0 + }, + "ComputationId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ValidationStrategy", + "properties": { + "Mode": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ValidationStrategyMode", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ValueWhenUnsetOption", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "VerticalTextAlignment", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Visibility", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "VisibleRangeOptions", + "properties": { + "PercentRange": { + "type": { + "$ref": "#/364" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Visual", + "properties": { + "BarChartVisual": { + "type": { + "$ref": "#/36" + }, + "flags": 0 + }, + "BoxPlotVisual": { + "type": { + "$ref": "#/50" + }, + "flags": 0 + }, + "ComboChartVisual": { + "type": { + "$ref": "#/79" + }, + "flags": 0 + }, + "CustomContentVisual": { + "type": { + "$ref": "#/105" + }, + "flags": 0 + }, + "EmptyVisual": { + "type": { + "$ref": "#/165" + }, + "flags": 0 + }, + "FilledMapVisual": { + "type": { + "$ref": "#/182" + }, + "flags": 0 + }, + "FunnelChartVisual": { + "type": { + "$ref": "#/225" + }, + "flags": 0 + }, + "GaugeChartVisual": { + "type": { + "$ref": "#/233" + }, + "flags": 0 + }, + "GeospatialMapVisual": { + "type": { + "$ref": "#/242" + }, + "flags": 0 + }, + "HeatMapVisual": { + "type": { + "$ref": "#/259" + }, + "flags": 0 + }, + "HistogramVisual": { + "type": { + "$ref": "#/265" + }, + "flags": 0 + }, + "InsightVisual": { + "type": { + "$ref": "#/269" + }, + "flags": 0 + }, + "KPIVisual": { + "type": { + "$ref": "#/287" + }, + "flags": 0 + }, + "LineChartVisual": { + "type": { + "$ref": "#/308" + }, + "flags": 0 + }, + "PieChartVisual": { + "type": { + "$ref": "#/373" + }, + "flags": 0 + }, + "PivotTableVisual": { + "type": { + "$ref": "#/400" + }, + "flags": 0 + }, + "RadarChartVisual": { + "type": { + "$ref": "#/413" + }, + "flags": 0 + }, + "SankeyDiagramVisual": { + "type": { + "$ref": "#/442" + }, + "flags": 0 + }, + "ScatterPlotVisual": { + "type": { + "$ref": "#/447" + }, + "flags": 0 + }, + "TableVisual": { + "type": { + "$ref": "#/530" + }, + "flags": 0 + }, + "TreeMapVisual": { + "type": { + "$ref": "#/561" + }, + "flags": 0 + }, + "WaterfallVisual": { + "type": { + "$ref": "#/586" + }, + "flags": 0 + }, + "WordCloudVisual": { + "type": { + "$ref": "#/596" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "VisualCustomAction", + "properties": { + "ActionOperations": { + "type": { + "$ref": "#/818" + }, + "flags": 1 + }, + "CustomActionId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Status": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Trigger": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "VisualCustomActionOperation", + "properties": { + "FilterOperation": { + "type": { + "$ref": "#/97" + }, + "flags": 0 + }, + "NavigationOperation": { + "type": { + "$ref": "#/98" + }, + "flags": 0 + }, + "SetParametersOperation": { + "type": { + "$ref": "#/99" + }, + "flags": 0 + }, + "URLOperation": { + "type": { + "$ref": "#/100" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "VisualCustomActionTrigger", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "VisualPalette", + "properties": { + "ChartColor": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ColorMap": { + "type": { + "$ref": "#/819" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "VisualSubtitleLabelOptions", + "properties": { + "FormatText": { + "type": { + "$ref": "#/316" + }, + "flags": 0 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "VisualTitleLabelOptions", + "properties": { + "FormatText": { + "type": { + "$ref": "#/478" + }, + "flags": 0 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "WaterfallChartAggregatedFieldWells", + "properties": { + "Breakdowns": { + "type": { + "$ref": "#/820" + }, + "flags": 0 + }, + "Categories": { + "type": { + "$ref": "#/821" + }, + "flags": 0 + }, + "Values": { + "type": { + "$ref": "#/822" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "WaterfallChartColorConfiguration", + "properties": { + "GroupColorConfiguration": { + "type": { + "$ref": "#/583" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "WaterfallChartConfiguration", + "properties": { + "CategoryAxisDisplayOptions": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "CategoryAxisLabelOptions": { + "type": { + "$ref": "#/63" + }, + "flags": 0 + }, + "ColorConfiguration": { + "type": { + "$ref": "#/580" + }, + "flags": 0 + }, + "DataLabels": { + "type": { + "$ref": "#/115" + }, + "flags": 0 + }, + "FieldWells": { + "type": { + "$ref": "#/582" + }, + "flags": 0 + }, + "Legend": { + "type": { + "$ref": "#/295" + }, + "flags": 0 + }, + "PrimaryYAxisDisplayOptions": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "PrimaryYAxisLabelOptions": { + "type": { + "$ref": "#/63" + }, + "flags": 0 + }, + "SortConfiguration": { + "type": { + "$ref": "#/585" + }, + "flags": 0 + }, + "VisualPalette": { + "type": { + "$ref": "#/576" + }, + "flags": 0 + }, + "WaterfallChartOptions": { + "type": { + "$ref": "#/584" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "WaterfallChartFieldWells", + "properties": { + "WaterfallChartAggregatedFieldWells": { + "type": { + "$ref": "#/579" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "WaterfallChartGroupColorConfiguration", + "properties": { + "NegativeBarColor": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "PositiveBarColor": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "TotalBarColor": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "WaterfallChartOptions", + "properties": { + "TotalBarLabel": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "WaterfallChartSortConfiguration", + "properties": { + "BreakdownItemsLimit": { + "type": { + "$ref": "#/274" + }, + "flags": 0 + }, + "CategorySort": { + "type": { + "$ref": "#/823" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "WaterfallVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/824" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/581" + }, + "flags": 0 + }, + "ColumnHierarchies": { + "type": { + "$ref": "#/825" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/577" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/578" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "WhatIfPointScenario", + "properties": { + "Date": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "WhatIfRangeScenario", + "properties": { + "EndDate": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "StartDate": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "WidgetStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "WordCloudAggregatedFieldWells", + "properties": { + "GroupBy": { + "type": { + "$ref": "#/826" + }, + "flags": 0 + }, + "Size": { + "type": { + "$ref": "#/827" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "WordCloudChartConfiguration", + "properties": { + "CategoryLabelOptions": { + "type": { + "$ref": "#/63" + }, + "flags": 0 + }, + "FieldWells": { + "type": { + "$ref": "#/593" + }, + "flags": 0 + }, + "SortConfiguration": { + "type": { + "$ref": "#/595" + }, + "flags": 0 + }, + "WordCloudOptions": { + "type": { + "$ref": "#/594" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "WordCloudCloudLayout", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "WordCloudFieldWells", + "properties": { + "WordCloudAggregatedFieldWells": { + "type": { + "$ref": "#/590" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "WordCloudOptions", + "properties": { + "CloudLayout": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "MaximumStringLength": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "WordCasing": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "WordOrientation": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "WordPadding": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "WordScaling": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "WordCloudSortConfiguration", + "properties": { + "CategoryItemsLimit": { + "type": { + "$ref": "#/274" + }, + "flags": 0 + }, + "CategorySort": { + "type": { + "$ref": "#/828" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "WordCloudVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/829" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/591" + }, + "flags": 0 + }, + "ColumnHierarchies": { + "type": { + "$ref": "#/830" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/577" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/578" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "WordCloudWordCasing", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "WordCloudWordOrientation", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "WordCloudWordPadding", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "WordCloudWordScaling", + "properties": {} + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/51" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/69" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/124" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/188" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/355" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/473" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/166" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/125" + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/159" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/159" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/159" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/322" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/94" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/415" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/173" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/173" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/173" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/573" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/70" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/159" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/322" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/415" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/173" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/573" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/70" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/54" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/25" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/112" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/101" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/322" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/159" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/159" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/322" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/415" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/173" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/173" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/573" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/70" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/71" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/463" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/573" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/610" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/610" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/118" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/123" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/162" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/318" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/610" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/610" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/318" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/573" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/71" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/162" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/545" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/159" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/322" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/177" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/173" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/573" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/70" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/183" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/71" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/214" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/475" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/214" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/159" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/322" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/173" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/573" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/70" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/228" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/322" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/322" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/573" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/237" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/159" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/159" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/322" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/573" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/70" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/248" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/251" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/159" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/159" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/322" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/173" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/173" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/573" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/70" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/322" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/573" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/83" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/573" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/610" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/610" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/318" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/278" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/322" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/159" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/322" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/173" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/573" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/70" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/159" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/159" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/159" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/322" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/94" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/209" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/415" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/462" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/173" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/173" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/573" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/70" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/325" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/133" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/139" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/271" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/493" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/159" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/159" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/322" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/94" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/173" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/173" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/573" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/70" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/159" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/159" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/322" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/379" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/378" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/123" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/123" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/385" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/382" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/387" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/374" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/573" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/555" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/71" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/162" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/159" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/159" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/322" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/173" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/173" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/573" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/70" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/159" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/159" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/322" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/173" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/573" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/159" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/159" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/322" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/322" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/322" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/159" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/159" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/322" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/159" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/159" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/573" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/70" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/41" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/254" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/254" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/477" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/184" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/292" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/353" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/469" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/476" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/572" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/318" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/389" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/526" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/159" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/322" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/506" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/518" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/514" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/173" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/564" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/573" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/555" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/322" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/159" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/322" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/173" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/573" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/70" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/574" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/119" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/159" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/159" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/322" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/173" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/573" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/70" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/159" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/322" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/173" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/573" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/70" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.QuickSight/AnalysisProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/433" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/465" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/531" + } + }, + { + "$type": "ObjectType", + "name": "AWS.QuickSight/AnalysisProperties", + "properties": { + "AnalysisId": { + "type": { + "$ref": "#/601" + }, + "flags": 17 + }, + "Arn": { + "type": { + "$ref": "#/601" + }, + "flags": 2, + "description": "

The Amazon Resource Name (ARN) of the analysis.

" + }, + "AwsAccountId": { + "type": { + "$ref": "#/601" + }, + "flags": 17 + }, + "CreatedTime": { + "type": { + "$ref": "#/601" + }, + "flags": 2, + "description": "

The time that the analysis was created.

" + }, + "DataSetArns": { + "type": { + "$ref": "#/832" + }, + "flags": 2, + "description": "

The ARNs of the datasets of the analysis.

" + }, + "Definition": { + "type": { + "$ref": "#/4" + }, + "flags": 4 + }, + "Errors": { + "type": { + "$ref": "#/833" + }, + "flags": 0, + "description": "

Errors associated with the analysis.

" + }, + "LastUpdatedTime": { + "type": { + "$ref": "#/601" + }, + "flags": 2, + "description": "

The time that the analysis was last updated.

" + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

The descriptive name of the analysis.

" + }, + "Parameters": { + "type": { + "$ref": "#/363" + }, + "flags": 4 + }, + "Permissions": { + "type": { + "$ref": "#/834" + }, + "flags": 0 + }, + "Sheets": { + "type": { + "$ref": "#/835" + }, + "flags": 0, + "description": "

A list of the associated sheets with the unique identifier and name of each sheet.

" + }, + "SourceEntity": { + "type": { + "$ref": "#/7" + }, + "flags": 4 + }, + "Status": { + "type": { + "$ref": "#/601" + }, + "flags": 4 + }, + "Tags": { + "type": { + "$ref": "#/836" + }, + "flags": 0 + }, + "ThemeArn": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The ARN of the theme of the analysis.

" + }, + "ValidationStrategy": { + "type": { + "$ref": "#/566" + }, + "flags": 4 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.QuickSight/Analysis", + "properties": { + "name": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/601" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/837" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.QuickSight/Analysis@default", + "scopeType": 0, + "body": { + "$ref": "#/838" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AdHocFilteringOption", + "properties": { + "AvailabilityStatus": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AggregationFunction", + "properties": { + "AttributeAggregationFunction": { + "type": { + "$ref": "#/854" + }, + "flags": 0 + }, + "CategoricalAggregationFunction": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "DateAggregationFunction": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "NumericalAggregationFunction": { + "type": { + "$ref": "#/1196" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AggregationSortConfiguration", + "properties": { + "AggregationFunction": { + "type": { + "$ref": "#/841" + }, + "flags": 0 + }, + "Column": { + "type": { + "$ref": "#/907" + }, + "flags": 1 + }, + "SortDirection": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AllSheetsFilterScopeConfiguration", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AnalysisDefaults", + "properties": { + "DefaultNewSheetConfiguration": { + "type": { + "$ref": "#/1000" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AnchorDateConfiguration", + "properties": { + "AnchorOption": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ParameterName": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AnchorOption", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ArcAxisConfiguration", + "properties": { + "Range": { + "type": { + "$ref": "#/848" + }, + "flags": 0 + }, + "ReserveRange": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ArcAxisDisplayRange", + "properties": { + "Max": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "Min": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ArcConfiguration", + "properties": { + "ArcAngle": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "ArcThickness": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ArcOptions", + "properties": { + "ArcThickness": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ArcThickness", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ArcThicknessOptions", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AssetOptions", + "properties": { + "Timezone": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "WeekStart": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AttributeAggregationFunction", + "properties": { + "SimpleAttributeAggregation": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ValueForMultipleValues": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AxisBinding", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AxisDataOptions", + "properties": { + "DateAxisOptions": { + "type": { + "$ref": "#/976" + }, + "flags": 0 + }, + "NumericAxisOptions": { + "type": { + "$ref": "#/1186" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AxisDisplayDataDrivenRange", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AxisDisplayMinMaxRange", + "properties": { + "Maximum": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "Minimum": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AxisDisplayOptions", + "properties": { + "AxisLineVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "AxisOffset": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "String based length that is composed of value and unit in px" + }, + "DataOptions": { + "type": { + "$ref": "#/856" + }, + "flags": 0 + }, + "GridLineVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ScrollbarOptions": { + "type": { + "$ref": "#/1301" + }, + "flags": 0 + }, + "TickLabelOptions": { + "type": { + "$ref": "#/866" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AxisDisplayRange", + "properties": { + "DataDriven": { + "type": { + "$ref": "#/857" + }, + "flags": 0 + }, + "MinMax": { + "type": { + "$ref": "#/858" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AxisLabelOptions", + "properties": { + "ApplyTo": { + "type": { + "$ref": "#/862" + }, + "flags": 0 + }, + "CustomLabel": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "FontConfiguration": { + "type": { + "$ref": "#/1053" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AxisLabelReferenceOptions", + "properties": { + "Column": { + "type": { + "$ref": "#/907" + }, + "flags": 1 + }, + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AxisLinearScale", + "properties": { + "StepCount": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "StepSize": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AxisLogarithmicScale", + "properties": { + "Base": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AxisScale", + "properties": { + "Linear": { + "type": { + "$ref": "#/863" + }, + "flags": 0 + }, + "Logarithmic": { + "type": { + "$ref": "#/864" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AxisTickLabelOptions", + "properties": { + "LabelOptions": { + "type": { + "$ref": "#/1143" + }, + "flags": 0 + }, + "RotationAngle": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BarChartAggregatedFieldWells", + "properties": { + "Category": { + "type": { + "$ref": "#/1458" + }, + "flags": 0 + }, + "Colors": { + "type": { + "$ref": "#/1459" + }, + "flags": 0 + }, + "SmallMultiples": { + "type": { + "$ref": "#/1460" + }, + "flags": 0 + }, + "Values": { + "type": { + "$ref": "#/1461" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BarChartConfiguration", + "properties": { + "BarsArrangement": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "CategoryAxis": { + "type": { + "$ref": "#/859" + }, + "flags": 0 + }, + "CategoryLabelOptions": { + "type": { + "$ref": "#/899" + }, + "flags": 0 + }, + "ColorLabelOptions": { + "type": { + "$ref": "#/899" + }, + "flags": 0 + }, + "ContributionAnalysisDefaults": { + "type": { + "$ref": "#/1462" + }, + "flags": 0 + }, + "DataLabels": { + "type": { + "$ref": "#/961" + }, + "flags": 0 + }, + "FieldWells": { + "type": { + "$ref": "#/869" + }, + "flags": 0 + }, + "Legend": { + "type": { + "$ref": "#/1147" + }, + "flags": 0 + }, + "Orientation": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ReferenceLines": { + "type": { + "$ref": "#/1463" + }, + "flags": 0 + }, + "SmallMultiplesOptions": { + "type": { + "$ref": "#/1342" + }, + "flags": 0 + }, + "SortConfiguration": { + "type": { + "$ref": "#/871" + }, + "flags": 0 + }, + "Tooltip": { + "type": { + "$ref": "#/1401" + }, + "flags": 0 + }, + "ValueAxis": { + "type": { + "$ref": "#/859" + }, + "flags": 0 + }, + "ValueLabelOptions": { + "type": { + "$ref": "#/899" + }, + "flags": 0 + }, + "VisualPalette": { + "type": { + "$ref": "#/1433" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BarChartFieldWells", + "properties": { + "BarChartAggregatedFieldWells": { + "type": { + "$ref": "#/867" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BarChartOrientation", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "BarChartSortConfiguration", + "properties": { + "CategoryItemsLimit": { + "type": { + "$ref": "#/1126" + }, + "flags": 0 + }, + "CategorySort": { + "type": { + "$ref": "#/1464" + }, + "flags": 0 + }, + "ColorItemsLimit": { + "type": { + "$ref": "#/1126" + }, + "flags": 0 + }, + "ColorSort": { + "type": { + "$ref": "#/1465" + }, + "flags": 0 + }, + "SmallMultiplesLimitConfiguration": { + "type": { + "$ref": "#/1126" + }, + "flags": 0 + }, + "SmallMultiplesSort": { + "type": { + "$ref": "#/1466" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BarChartVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/1467" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/868" + }, + "flags": 0 + }, + "ColumnHierarchies": { + "type": { + "$ref": "#/1468" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/1434" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/1435" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "BarsArrangement", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "BaseMapStyleType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "BinCountOptions", + "properties": { + "Value": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BinWidthOptions", + "properties": { + "BinCountLimit": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BodySectionConfiguration", + "properties": { + "Content": { + "type": { + "$ref": "#/878" + }, + "flags": 1 + }, + "PageBreakConfiguration": { + "type": { + "$ref": "#/1308" + }, + "flags": 0 + }, + "SectionId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Style": { + "type": { + "$ref": "#/1310" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BodySectionContent", + "properties": { + "Layout": { + "type": { + "$ref": "#/1307" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BoxPlotAggregatedFieldWells", + "properties": { + "GroupBy": { + "type": { + "$ref": "#/1469" + }, + "flags": 0 + }, + "Values": { + "type": { + "$ref": "#/1470" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BoxPlotChartConfiguration", + "properties": { + "BoxPlotOptions": { + "type": { + "$ref": "#/883" + }, + "flags": 0 + }, + "CategoryAxis": { + "type": { + "$ref": "#/859" + }, + "flags": 0 + }, + "CategoryLabelOptions": { + "type": { + "$ref": "#/899" + }, + "flags": 0 + }, + "FieldWells": { + "type": { + "$ref": "#/881" + }, + "flags": 0 + }, + "Legend": { + "type": { + "$ref": "#/1147" + }, + "flags": 0 + }, + "PrimaryYAxisDisplayOptions": { + "type": { + "$ref": "#/859" + }, + "flags": 0 + }, + "PrimaryYAxisLabelOptions": { + "type": { + "$ref": "#/899" + }, + "flags": 0 + }, + "ReferenceLines": { + "type": { + "$ref": "#/1471" + }, + "flags": 0 + }, + "SortConfiguration": { + "type": { + "$ref": "#/884" + }, + "flags": 0 + }, + "Tooltip": { + "type": { + "$ref": "#/1401" + }, + "flags": 0 + }, + "VisualPalette": { + "type": { + "$ref": "#/1433" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BoxPlotFieldWells", + "properties": { + "BoxPlotAggregatedFieldWells": { + "type": { + "$ref": "#/879" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BoxPlotFillStyle", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "BoxPlotOptions", + "properties": { + "AllDataPointsVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "OutlierVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "StyleOptions": { + "type": { + "$ref": "#/885" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BoxPlotSortConfiguration", + "properties": { + "CategorySort": { + "type": { + "$ref": "#/1472" + }, + "flags": 0 + }, + "PaginationConfiguration": { + "type": { + "$ref": "#/1200" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BoxPlotStyleOptions", + "properties": { + "FillStyle": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BoxPlotVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/1473" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/880" + }, + "flags": 0 + }, + "ColumnHierarchies": { + "type": { + "$ref": "#/1474" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/1434" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/1435" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CalculatedField", + "properties": { + "DataSetIdentifier": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Expression": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CalculatedMeasureField", + "properties": { + "Expression": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CascadingControlConfiguration", + "properties": { + "SourceControls": { + "type": { + "$ref": "#/1475" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CascadingControlSource", + "properties": { + "ColumnToMatch": { + "type": { + "$ref": "#/907" + }, + "flags": 0 + }, + "SourceSheetControlId": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CategoricalAggregationFunction", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CategoricalDimensionField", + "properties": { + "Column": { + "type": { + "$ref": "#/907" + }, + "flags": 1 + }, + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "FormatConfiguration": { + "type": { + "$ref": "#/1347" + }, + "flags": 0 + }, + "HierarchyId": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CategoricalMeasureField", + "properties": { + "AggregationFunction": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Column": { + "type": { + "$ref": "#/907" + }, + "flags": 1 + }, + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "FormatConfiguration": { + "type": { + "$ref": "#/1347" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CategoryDrillDownFilter", + "properties": { + "CategoryValues": { + "type": { + "$ref": "#/1476" + }, + "flags": 1 + }, + "Column": { + "type": { + "$ref": "#/907" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CategoryFilter", + "properties": { + "Column": { + "type": { + "$ref": "#/907" + }, + "flags": 1 + }, + "Configuration": { + "type": { + "$ref": "#/896" + }, + "flags": 1 + }, + "DefaultFilterControlConfiguration": { + "type": { + "$ref": "#/993" + }, + "flags": 0 + }, + "FilterId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CategoryFilterConfiguration", + "properties": { + "CustomFilterConfiguration": { + "type": { + "$ref": "#/942" + }, + "flags": 0 + }, + "CustomFilterListConfiguration": { + "type": { + "$ref": "#/943" + }, + "flags": 0 + }, + "FilterListConfiguration": { + "type": { + "$ref": "#/1041" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CategoryFilterMatchOperator", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CategoryFilterSelectAllOptions", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ChartAxisLabelOptions", + "properties": { + "AxisLabelOptions": { + "type": { + "$ref": "#/1477" + }, + "flags": 0 + }, + "SortIconVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ClusterMarker", + "properties": { + "SimpleClusterMarker": { + "type": { + "$ref": "#/1335" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ClusterMarkerConfiguration", + "properties": { + "ClusterMarker": { + "type": { + "$ref": "#/900" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ColorFillType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ColorScale", + "properties": { + "ColorFillType": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Colors": { + "type": { + "$ref": "#/1478" + }, + "flags": 1 + }, + "NullValueColor": { + "type": { + "$ref": "#/958" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ColorsConfiguration", + "properties": { + "CustomColors": { + "type": { + "$ref": "#/1479" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ColumnConfiguration", + "properties": { + "ColorsConfiguration": { + "type": { + "$ref": "#/904" + }, + "flags": 0 + }, + "Column": { + "type": { + "$ref": "#/907" + }, + "flags": 1 + }, + "FormatConfiguration": { + "type": { + "$ref": "#/1063" + }, + "flags": 0 + }, + "Role": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ColumnHierarchy", + "properties": { + "DateTimeHierarchy": { + "type": { + "$ref": "#/981" + }, + "flags": 0 + }, + "ExplicitHierarchy": { + "type": { + "$ref": "#/1017" + }, + "flags": 0 + }, + "PredefinedHierarchy": { + "type": { + "$ref": "#/1255" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ColumnIdentifier", + "properties": { + "ColumnName": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "DataSetIdentifier": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ColumnRole", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ColumnSort", + "properties": { + "AggregationFunction": { + "type": { + "$ref": "#/841" + }, + "flags": 0 + }, + "Direction": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "SortBy": { + "type": { + "$ref": "#/907" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ColumnTooltipItem", + "properties": { + "Aggregation": { + "type": { + "$ref": "#/841" + }, + "flags": 0 + }, + "Column": { + "type": { + "$ref": "#/907" + }, + "flags": 1 + }, + "Label": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ComboChartAggregatedFieldWells", + "properties": { + "BarValues": { + "type": { + "$ref": "#/1480" + }, + "flags": 0 + }, + "Category": { + "type": { + "$ref": "#/1481" + }, + "flags": 0 + }, + "Colors": { + "type": { + "$ref": "#/1482" + }, + "flags": 0 + }, + "LineValues": { + "type": { + "$ref": "#/1483" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ComboChartConfiguration", + "properties": { + "BarDataLabels": { + "type": { + "$ref": "#/961" + }, + "flags": 0 + }, + "BarsArrangement": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "CategoryAxis": { + "type": { + "$ref": "#/859" + }, + "flags": 0 + }, + "CategoryLabelOptions": { + "type": { + "$ref": "#/899" + }, + "flags": 0 + }, + "ColorLabelOptions": { + "type": { + "$ref": "#/899" + }, + "flags": 0 + }, + "FieldWells": { + "type": { + "$ref": "#/913" + }, + "flags": 0 + }, + "Legend": { + "type": { + "$ref": "#/1147" + }, + "flags": 0 + }, + "LineDataLabels": { + "type": { + "$ref": "#/961" + }, + "flags": 0 + }, + "PrimaryYAxisDisplayOptions": { + "type": { + "$ref": "#/859" + }, + "flags": 0 + }, + "PrimaryYAxisLabelOptions": { + "type": { + "$ref": "#/899" + }, + "flags": 0 + }, + "ReferenceLines": { + "type": { + "$ref": "#/1484" + }, + "flags": 0 + }, + "SecondaryYAxisDisplayOptions": { + "type": { + "$ref": "#/859" + }, + "flags": 0 + }, + "SecondaryYAxisLabelOptions": { + "type": { + "$ref": "#/899" + }, + "flags": 0 + }, + "SortConfiguration": { + "type": { + "$ref": "#/914" + }, + "flags": 0 + }, + "Tooltip": { + "type": { + "$ref": "#/1401" + }, + "flags": 0 + }, + "VisualPalette": { + "type": { + "$ref": "#/1433" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ComboChartFieldWells", + "properties": { + "ComboChartAggregatedFieldWells": { + "type": { + "$ref": "#/911" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ComboChartSortConfiguration", + "properties": { + "CategoryItemsLimit": { + "type": { + "$ref": "#/1126" + }, + "flags": 0 + }, + "CategorySort": { + "type": { + "$ref": "#/1485" + }, + "flags": 0 + }, + "ColorItemsLimit": { + "type": { + "$ref": "#/1126" + }, + "flags": 0 + }, + "ColorSort": { + "type": { + "$ref": "#/1486" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ComboChartVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/1487" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/912" + }, + "flags": 0 + }, + "ColumnHierarchies": { + "type": { + "$ref": "#/1488" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/1434" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/1435" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ComparisonConfiguration", + "properties": { + "ComparisonFormat": { + "type": { + "$ref": "#/917" + }, + "flags": 0 + }, + "ComparisonMethod": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ComparisonFormatConfiguration", + "properties": { + "NumberDisplayFormatConfiguration": { + "type": { + "$ref": "#/1183" + }, + "flags": 0 + }, + "PercentageDisplayFormatConfiguration": { + "type": { + "$ref": "#/1218" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ComparisonMethod", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Computation", + "properties": { + "Forecast": { + "type": { + "$ref": "#/1059" + }, + "flags": 0 + }, + "GrowthRate": { + "type": { + "$ref": "#/1105" + }, + "flags": 0 + }, + "MaximumMinimum": { + "type": { + "$ref": "#/1173" + }, + "flags": 0 + }, + "MetricComparison": { + "type": { + "$ref": "#/1176" + }, + "flags": 0 + }, + "PeriodOverPeriod": { + "type": { + "$ref": "#/1220" + }, + "flags": 0 + }, + "PeriodToDate": { + "type": { + "$ref": "#/1221" + }, + "flags": 0 + }, + "TopBottomMovers": { + "type": { + "$ref": "#/1405" + }, + "flags": 0 + }, + "TopBottomRanked": { + "type": { + "$ref": "#/1406" + }, + "flags": 0 + }, + "TotalAggregation": { + "type": { + "$ref": "#/1408" + }, + "flags": 0 + }, + "UniqueValues": { + "type": { + "$ref": "#/1420" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ConditionalFormattingColor", + "properties": { + "Gradient": { + "type": { + "$ref": "#/923" + }, + "flags": 0 + }, + "Solid": { + "type": { + "$ref": "#/929" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ConditionalFormattingCustomIconCondition", + "properties": { + "Color": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "DisplayConfiguration": { + "type": { + "$ref": "#/925" + }, + "flags": 0 + }, + "Expression": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "IconOptions": { + "type": { + "$ref": "#/922" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ConditionalFormattingCustomIconOptions", + "properties": { + "Icon": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "UnicodeIcon": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ConditionalFormattingGradientColor", + "properties": { + "Color": { + "type": { + "$ref": "#/1099" + }, + "flags": 1 + }, + "Expression": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ConditionalFormattingIcon", + "properties": { + "CustomCondition": { + "type": { + "$ref": "#/921" + }, + "flags": 0 + }, + "IconSet": { + "type": { + "$ref": "#/927" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ConditionalFormattingIconDisplayConfiguration", + "properties": { + "IconDisplayOption": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ConditionalFormattingIconDisplayOption", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ConditionalFormattingIconSet", + "properties": { + "Expression": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "IconSetType": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ConditionalFormattingIconSetType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ConditionalFormattingSolidColor", + "properties": { + "Color": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Expression": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ContributionAnalysisDefault", + "properties": { + "ContributorDimensions": { + "type": { + "$ref": "#/1489" + }, + "flags": 1 + }, + "MeasureFieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CrossDatasetTypes", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CurrencyDisplayFormatConfiguration", + "properties": { + "DecimalPlacesConfiguration": { + "type": { + "$ref": "#/990" + }, + "flags": 0 + }, + "NegativeValueConfiguration": { + "type": { + "$ref": "#/1180" + }, + "flags": 0 + }, + "NullValueFormatConfiguration": { + "type": { + "$ref": "#/1182" + }, + "flags": 0 + }, + "NumberScale": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Prefix": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "SeparatorConfiguration": { + "type": { + "$ref": "#/1194" + }, + "flags": 0 + }, + "Suffix": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Symbol": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomActionFilterOperation", + "properties": { + "SelectedFieldsConfiguration": { + "type": { + "$ref": "#/1044" + }, + "flags": 1 + }, + "TargetVisualsConfiguration": { + "type": { + "$ref": "#/1045" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomActionNavigationOperation", + "properties": { + "LocalNavigationConfiguration": { + "type": { + "$ref": "#/1168" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomActionSetParametersOperation", + "properties": { + "ParameterValueConfigurations": { + "type": { + "$ref": "#/1490" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomActionURLOperation", + "properties": { + "URLTarget": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "URLTemplate": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomColor", + "properties": { + "Color": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "FieldValue": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "SpecialValue": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomContentConfiguration", + "properties": { + "ContentType": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ContentUrl": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ImageScaling": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomContentImageScalingConfiguration", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CustomContentType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CustomContentVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/1491" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/938" + }, + "flags": 0 + }, + "DataSetIdentifier": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Subtitle": { + "type": { + "$ref": "#/1434" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/1435" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomFilterConfiguration", + "properties": { + "CategoryValue": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "MatchOperator": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "NullOption": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "ParameterName": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "SelectAllOptions": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomFilterListConfiguration", + "properties": { + "CategoryValues": { + "type": { + "$ref": "#/1492" + }, + "flags": 0 + }, + "MatchOperator": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "NullOption": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "SelectAllOptions": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomNarrativeOptions", + "properties": { + "Narrative": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomParameterValues", + "properties": { + "DateTimeValues": { + "type": { + "$ref": "#/1493" + }, + "flags": 0 + }, + "DecimalValues": { + "type": { + "$ref": "#/1494" + }, + "flags": 0 + }, + "IntegerValues": { + "type": { + "$ref": "#/1495" + }, + "flags": 0 + }, + "StringValues": { + "type": { + "$ref": "#/1496" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomValuesConfiguration", + "properties": { + "CustomValues": { + "type": { + "$ref": "#/945" + }, + "flags": 1 + }, + "IncludeNullValue": { + "type": { + "$ref": "#/650" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DashboardBehavior", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DashboardError", + "properties": { + "Message": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

Message.

" + }, + "Type": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ViolatedEntities": { + "type": { + "$ref": "#/1497" + }, + "flags": 0, + "description": "

Lists the violated entities that caused the dashboard error.

" + } + } + }, + { + "$type": "ObjectType", + "name": "DashboardErrorType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DashboardPublishOptions", + "properties": { + "AdHocFilteringOption": { + "type": { + "$ref": "#/840" + }, + "flags": 0 + }, + "DataPointDrillUpDownOption": { + "type": { + "$ref": "#/970" + }, + "flags": 0 + }, + "DataPointMenuLabelOption": { + "type": { + "$ref": "#/971" + }, + "flags": 0 + }, + "DataPointTooltipOption": { + "type": { + "$ref": "#/972" + }, + "flags": 0 + }, + "ExportToCSVOption": { + "type": { + "$ref": "#/1019" + }, + "flags": 0 + }, + "ExportWithHiddenFieldsOption": { + "type": { + "$ref": "#/1020" + }, + "flags": 0 + }, + "SheetControlsOption": { + "type": { + "$ref": "#/1326" + }, + "flags": 0 + }, + "SheetLayoutElementMaximizationOption": { + "type": { + "$ref": "#/1330" + }, + "flags": 0 + }, + "VisualAxisSortOption": { + "type": { + "$ref": "#/1428" + }, + "flags": 0 + }, + "VisualMenuOption": { + "type": { + "$ref": "#/1432" + }, + "flags": 0 + }, + "VisualPublishOptions": { + "type": { + "$ref": "#/956" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DashboardSourceEntity", + "properties": { + "SourceTemplate": { + "type": { + "$ref": "#/952" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DashboardSourceTemplate", + "properties": { + "Arn": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

The Amazon Resource Name (ARN) of the resource.

" + }, + "DataSetReferences": { + "type": { + "$ref": "#/1498" + }, + "flags": 1, + "description": "

Dataset references.

" + } + } + }, + { + "$type": "ObjectType", + "name": "DashboardUIState", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DashboardVersion", + "properties": { + "Arn": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The Amazon Resource Name (ARN) of the resource.

" + }, + "CreatedTime": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The time that this dashboard version was created.

" + }, + "DataSetArns": { + "type": { + "$ref": "#/1499" + }, + "flags": 0, + "description": "

The Amazon Resource Numbers (ARNs) for the datasets that are associated with this\n version of the dashboard.

" + }, + "Description": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

Description.

" + }, + "Errors": { + "type": { + "$ref": "#/1500" + }, + "flags": 0, + "description": "

Errors associated with this dashboard version.

" + }, + "Sheets": { + "type": { + "$ref": "#/1501" + }, + "flags": 0, + "description": "

A list of the associated sheets with the unique identifier and name of each sheet.

" + }, + "SourceEntityArn": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

Source entity ARN.

" + }, + "Status": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ThemeArn": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The ARN of the theme associated with a version of the dashboard.

" + }, + "VersionNumber": { + "type": { + "$ref": "#/610" + }, + "flags": 0, + "description": "

Version number for this version of the dashboard.

" + } + } + }, + { + "$type": "ObjectType", + "name": "DashboardVersionDefinition", + "properties": { + "AnalysisDefaults": { + "type": { + "$ref": "#/844" + }, + "flags": 0 + }, + "CalculatedFields": { + "type": { + "$ref": "#/1502" + }, + "flags": 0 + }, + "ColumnConfigurations": { + "type": { + "$ref": "#/1503" + }, + "flags": 0 + }, + "DataSetIdentifierDeclarations": { + "type": { + "$ref": "#/1504" + }, + "flags": 1 + }, + "FilterGroups": { + "type": { + "$ref": "#/1505" + }, + "flags": 0 + }, + "Options": { + "type": { + "$ref": "#/853" + }, + "flags": 0 + }, + "ParameterDeclarations": { + "type": { + "$ref": "#/1506" + }, + "flags": 0 + }, + "Sheets": { + "type": { + "$ref": "#/1507" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DashboardVisualPublishOptions", + "properties": { + "ExportHiddenFieldsOption": { + "type": { + "$ref": "#/1018" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DataBarsOptions", + "properties": { + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "NegativeColor": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "PositiveColor": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DataColor", + "properties": { + "Color": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "DataValue": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DataFieldSeriesItem", + "properties": { + "AxisBinding": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "FieldValue": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Settings": { + "type": { + "$ref": "#/1157" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DataLabelContent", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DataLabelOptions", + "properties": { + "CategoryLabelVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "DataLabelTypes": { + "type": { + "$ref": "#/1508" + }, + "flags": 0 + }, + "LabelColor": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "LabelContent": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "LabelFontConfiguration": { + "type": { + "$ref": "#/1053" + }, + "flags": 0 + }, + "MeasureLabelVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Overlap": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Position": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "TotalsVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DataLabelOverlap", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DataLabelPosition", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DataLabelType", + "properties": { + "DataPathLabelType": { + "type": { + "$ref": "#/966" + }, + "flags": 0 + }, + "FieldLabelType": { + "type": { + "$ref": "#/1022" + }, + "flags": 0 + }, + "MaximumLabelType": { + "type": { + "$ref": "#/1172" + }, + "flags": 0 + }, + "MinimumLabelType": { + "type": { + "$ref": "#/1177" + }, + "flags": 0 + }, + "RangeEndsLabelType": { + "type": { + "$ref": "#/1267" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DataPathColor", + "properties": { + "Color": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Element": { + "type": { + "$ref": "#/969" + }, + "flags": 1 + }, + "TimeGranularity": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DataPathLabelType", + "properties": { + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "FieldValue": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DataPathSort", + "properties": { + "Direction": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "SortPaths": { + "type": { + "$ref": "#/1509" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DataPathType", + "properties": { + "PivotTableDataPathType": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DataPathValue", + "properties": { + "DataPathType": { + "type": { + "$ref": "#/968" + }, + "flags": 0 + }, + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "FieldValue": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DataPointDrillUpDownOption", + "properties": { + "AvailabilityStatus": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DataPointMenuLabelOption", + "properties": { + "AvailabilityStatus": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DataPointTooltipOption", + "properties": { + "AvailabilityStatus": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DataSetIdentifierDeclaration", + "properties": { + "DataSetArn": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Identifier": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DataSetReference", + "properties": { + "DataSetArn": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

Dataset Amazon Resource Name (ARN).

" + }, + "DataSetPlaceholder": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

Dataset placeholder.

" + } + } + }, + { + "$type": "ObjectType", + "name": "DateAggregationFunction", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DateAxisOptions", + "properties": { + "MissingDateVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DateDimensionField", + "properties": { + "Column": { + "type": { + "$ref": "#/907" + }, + "flags": 1 + }, + "DateGranularity": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "FormatConfiguration": { + "type": { + "$ref": "#/980" + }, + "flags": 0 + }, + "HierarchyId": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DateMeasureField", + "properties": { + "AggregationFunction": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Column": { + "type": { + "$ref": "#/907" + }, + "flags": 1 + }, + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "FormatConfiguration": { + "type": { + "$ref": "#/980" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DateTimeDefaultValues", + "properties": { + "DynamicValue": { + "type": { + "$ref": "#/1013" + }, + "flags": 0 + }, + "RollingDate": { + "type": { + "$ref": "#/1288" + }, + "flags": 0 + }, + "StaticValues": { + "type": { + "$ref": "#/1510" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DateTimeFormatConfiguration", + "properties": { + "DateTimeFormat": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "NullValueFormatConfiguration": { + "type": { + "$ref": "#/1182" + }, + "flags": 0 + }, + "NumericFormatConfiguration": { + "type": { + "$ref": "#/1191" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DateTimeHierarchy", + "properties": { + "DrillDownFilters": { + "type": { + "$ref": "#/1511" + }, + "flags": 0 + }, + "HierarchyId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DateTimeParameter", + "properties": { + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

A display name for the date-time parameter.

" + }, + "Values": { + "type": { + "$ref": "#/1512" + }, + "flags": 1, + "description": "

The values for the date-time parameter.

" + } + } + }, + { + "$type": "ObjectType", + "name": "DateTimeParameterDeclaration", + "properties": { + "DefaultValues": { + "type": { + "$ref": "#/979" + }, + "flags": 0 + }, + "MappedDataSetParameters": { + "type": { + "$ref": "#/1513" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "TimeGranularity": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ValueWhenUnset": { + "type": { + "$ref": "#/985" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DateTimePickerControlDisplayOptions", + "properties": { + "DateTimeFormat": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "InfoIconLabelOptions": { + "type": { + "$ref": "#/1321" + }, + "flags": 0 + }, + "TitleOptions": { + "type": { + "$ref": "#/1143" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DateTimeValueWhenUnsetConfiguration", + "properties": { + "CustomValue": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ValueWhenUnsetOption": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DayOfTheWeek", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DecimalDefaultValues", + "properties": { + "DynamicValue": { + "type": { + "$ref": "#/1013" + }, + "flags": 0 + }, + "StaticValues": { + "type": { + "$ref": "#/1514" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DecimalParameter", + "properties": { + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

A display name for the decimal parameter.

" + }, + "Values": { + "type": { + "$ref": "#/1515" + }, + "flags": 1, + "description": "

The values for the decimal parameter.

" + } + } + }, + { + "$type": "ObjectType", + "name": "DecimalParameterDeclaration", + "properties": { + "DefaultValues": { + "type": { + "$ref": "#/987" + }, + "flags": 0 + }, + "MappedDataSetParameters": { + "type": { + "$ref": "#/1516" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "ParameterValueType": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "ValueWhenUnset": { + "type": { + "$ref": "#/991" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DecimalPlacesConfiguration", + "properties": { + "DecimalPlaces": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DecimalValueWhenUnsetConfiguration", + "properties": { + "CustomValue": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "ValueWhenUnsetOption": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DefaultDateTimePickerControlOptions", + "properties": { + "DisplayOptions": { + "type": { + "$ref": "#/984" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DefaultFilterControlConfiguration", + "properties": { + "ControlOptions": { + "type": { + "$ref": "#/994" + }, + "flags": 1 + }, + "Title": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DefaultFilterControlOptions", + "properties": { + "DefaultDateTimePickerOptions": { + "type": { + "$ref": "#/992" + }, + "flags": 0 + }, + "DefaultDropdownOptions": { + "type": { + "$ref": "#/995" + }, + "flags": 0 + }, + "DefaultListOptions": { + "type": { + "$ref": "#/996" + }, + "flags": 0 + }, + "DefaultRelativeDateTimeOptions": { + "type": { + "$ref": "#/1002" + }, + "flags": 0 + }, + "DefaultSliderOptions": { + "type": { + "$ref": "#/1004" + }, + "flags": 0 + }, + "DefaultTextAreaOptions": { + "type": { + "$ref": "#/1005" + }, + "flags": 0 + }, + "DefaultTextFieldOptions": { + "type": { + "$ref": "#/1006" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DefaultFilterDropDownControlOptions", + "properties": { + "DisplayOptions": { + "type": { + "$ref": "#/1012" + }, + "flags": 0 + }, + "SelectableValues": { + "type": { + "$ref": "#/1048" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DefaultFilterListControlOptions", + "properties": { + "DisplayOptions": { + "type": { + "$ref": "#/1164" + }, + "flags": 0 + }, + "SelectableValues": { + "type": { + "$ref": "#/1048" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DefaultFreeFormLayoutConfiguration", + "properties": { + "CanvasSizeOptions": { + "type": { + "$ref": "#/1064" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DefaultGridLayoutConfiguration", + "properties": { + "CanvasSizeOptions": { + "type": { + "$ref": "#/1101" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DefaultInteractiveLayoutConfiguration", + "properties": { + "FreeForm": { + "type": { + "$ref": "#/997" + }, + "flags": 0 + }, + "Grid": { + "type": { + "$ref": "#/998" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DefaultNewSheetConfiguration", + "properties": { + "InteractiveLayoutConfiguration": { + "type": { + "$ref": "#/999" + }, + "flags": 0 + }, + "PaginatedLayoutConfiguration": { + "type": { + "$ref": "#/1001" + }, + "flags": 0 + }, + "SheetContentType": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DefaultPaginatedLayoutConfiguration", + "properties": { + "SectionBased": { + "type": { + "$ref": "#/1003" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DefaultRelativeDateTimeControlOptions", + "properties": { + "DisplayOptions": { + "type": { + "$ref": "#/1281" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DefaultSectionBasedLayoutConfiguration", + "properties": { + "CanvasSizeOptions": { + "type": { + "$ref": "#/1304" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DefaultSliderControlOptions", + "properties": { + "DisplayOptions": { + "type": { + "$ref": "#/1338" + }, + "flags": 0 + }, + "MaximumValue": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + }, + "MinimumValue": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + }, + "StepSize": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + }, + "Type": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DefaultTextAreaControlOptions", + "properties": { + "Delimiter": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "DisplayOptions": { + "type": { + "$ref": "#/1388" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DefaultTextFieldControlOptions", + "properties": { + "DisplayOptions": { + "type": { + "$ref": "#/1391" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DestinationParameterValueConfiguration", + "properties": { + "CustomValuesConfiguration": { + "type": { + "$ref": "#/946" + }, + "flags": 0 + }, + "SelectAllValueOptions": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "SourceColumn": { + "type": { + "$ref": "#/907" + }, + "flags": 0 + }, + "SourceField": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "SourceParameterName": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DimensionField", + "properties": { + "CategoricalDimensionField": { + "type": { + "$ref": "#/892" + }, + "flags": 0 + }, + "DateDimensionField": { + "type": { + "$ref": "#/977" + }, + "flags": 0 + }, + "NumericalDimensionField": { + "type": { + "$ref": "#/1197" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DonutCenterOptions", + "properties": { + "LabelVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DonutOptions", + "properties": { + "ArcOptions": { + "type": { + "$ref": "#/850" + }, + "flags": 0 + }, + "DonutCenterOptions": { + "type": { + "$ref": "#/1009" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DrillDownFilter", + "properties": { + "CategoryFilter": { + "type": { + "$ref": "#/894" + }, + "flags": 0 + }, + "NumericEqualityFilter": { + "type": { + "$ref": "#/1187" + }, + "flags": 0 + }, + "TimeRangeFilter": { + "type": { + "$ref": "#/1397" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DropDownControlDisplayOptions", + "properties": { + "InfoIconLabelOptions": { + "type": { + "$ref": "#/1321" + }, + "flags": 0 + }, + "SelectAllOptions": { + "type": { + "$ref": "#/1166" + }, + "flags": 0 + }, + "TitleOptions": { + "type": { + "$ref": "#/1143" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DynamicDefaultValue", + "properties": { + "DefaultValueColumn": { + "type": { + "$ref": "#/907" + }, + "flags": 1 + }, + "GroupNameColumn": { + "type": { + "$ref": "#/907" + }, + "flags": 0 + }, + "UserNameColumn": { + "type": { + "$ref": "#/907" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "EmptyVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/1517" + }, + "flags": 0 + }, + "DataSetIdentifier": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Entity", + "properties": { + "Path": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ExcludePeriodConfiguration", + "properties": { + "Amount": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + }, + "Granularity": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Status": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ExplicitHierarchy", + "properties": { + "Columns": { + "type": { + "$ref": "#/1518" + }, + "flags": 1 + }, + "DrillDownFilters": { + "type": { + "$ref": "#/1519" + }, + "flags": 0 + }, + "HierarchyId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ExportHiddenFieldsOption", + "properties": { + "AvailabilityStatus": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ExportToCSVOption", + "properties": { + "AvailabilityStatus": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ExportWithHiddenFieldsOption", + "properties": { + "AvailabilityStatus": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FieldBasedTooltip", + "properties": { + "AggregationVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "TooltipFields": { + "type": { + "$ref": "#/1520" + }, + "flags": 0 + }, + "TooltipTitleType": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FieldLabelType", + "properties": { + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FieldSeriesItem", + "properties": { + "AxisBinding": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Settings": { + "type": { + "$ref": "#/1157" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FieldSort", + "properties": { + "Direction": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "FieldSortOptions", + "properties": { + "ColumnSort": { + "type": { + "$ref": "#/909" + }, + "flags": 0 + }, + "FieldSort": { + "type": { + "$ref": "#/1024" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FieldTooltipItem", + "properties": { + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Label": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FilledMapAggregatedFieldWells", + "properties": { + "Geospatial": { + "type": { + "$ref": "#/1521" + }, + "flags": 0 + }, + "Values": { + "type": { + "$ref": "#/1522" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FilledMapConditionalFormatting", + "properties": { + "ConditionalFormattingOptions": { + "type": { + "$ref": "#/1523" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "FilledMapConditionalFormattingOption", + "properties": { + "Shape": { + "type": { + "$ref": "#/1032" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "FilledMapConfiguration", + "properties": { + "FieldWells": { + "type": { + "$ref": "#/1031" + }, + "flags": 0 + }, + "Legend": { + "type": { + "$ref": "#/1147" + }, + "flags": 0 + }, + "MapStyleOptions": { + "type": { + "$ref": "#/1093" + }, + "flags": 0 + }, + "SortConfiguration": { + "type": { + "$ref": "#/1033" + }, + "flags": 0 + }, + "Tooltip": { + "type": { + "$ref": "#/1401" + }, + "flags": 0 + }, + "WindowOptions": { + "type": { + "$ref": "#/1097" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FilledMapFieldWells", + "properties": { + "FilledMapAggregatedFieldWells": { + "type": { + "$ref": "#/1027" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FilledMapShapeConditionalFormatting", + "properties": { + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Format": { + "type": { + "$ref": "#/1317" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FilledMapSortConfiguration", + "properties": { + "CategorySort": { + "type": { + "$ref": "#/1524" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FilledMapVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/1525" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/1030" + }, + "flags": 0 + }, + "ColumnHierarchies": { + "type": { + "$ref": "#/1526" + }, + "flags": 0 + }, + "ConditionalFormatting": { + "type": { + "$ref": "#/1028" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/1434" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/1435" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Filter", + "properties": { + "CategoryFilter": { + "type": { + "$ref": "#/895" + }, + "flags": 0 + }, + "NumericEqualityFilter": { + "type": { + "$ref": "#/1188" + }, + "flags": 0 + }, + "NumericRangeFilter": { + "type": { + "$ref": "#/1192" + }, + "flags": 0 + }, + "RelativeDatesFilter": { + "type": { + "$ref": "#/1283" + }, + "flags": 0 + }, + "TimeEqualityFilter": { + "type": { + "$ref": "#/1395" + }, + "flags": 0 + }, + "TimeRangeFilter": { + "type": { + "$ref": "#/1398" + }, + "flags": 0 + }, + "TopBottomFilter": { + "type": { + "$ref": "#/1404" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FilterControl", + "properties": { + "CrossSheet": { + "type": { + "$ref": "#/1037" + }, + "flags": 0 + }, + "DateTimePicker": { + "type": { + "$ref": "#/1038" + }, + "flags": 0 + }, + "Dropdown": { + "type": { + "$ref": "#/1039" + }, + "flags": 0 + }, + "List": { + "type": { + "$ref": "#/1042" + }, + "flags": 0 + }, + "RelativeDateTime": { + "type": { + "$ref": "#/1046" + }, + "flags": 0 + }, + "Slider": { + "type": { + "$ref": "#/1049" + }, + "flags": 0 + }, + "TextArea": { + "type": { + "$ref": "#/1050" + }, + "flags": 0 + }, + "TextField": { + "type": { + "$ref": "#/1051" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FilterCrossSheetControl", + "properties": { + "CascadingControlConfiguration": { + "type": { + "$ref": "#/889" + }, + "flags": 0 + }, + "FilterControlId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "SourceFilterId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "FilterDateTimePickerControl", + "properties": { + "DisplayOptions": { + "type": { + "$ref": "#/984" + }, + "flags": 0 + }, + "FilterControlId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "SourceFilterId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Title": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Type": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FilterDropDownControl", + "properties": { + "CascadingControlConfiguration": { + "type": { + "$ref": "#/889" + }, + "flags": 0 + }, + "DisplayOptions": { + "type": { + "$ref": "#/1012" + }, + "flags": 0 + }, + "FilterControlId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "SelectableValues": { + "type": { + "$ref": "#/1048" + }, + "flags": 0 + }, + "SourceFilterId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Title": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Type": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FilterGroup", + "properties": { + "CrossDataset": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "FilterGroupId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Filters": { + "type": { + "$ref": "#/1527" + }, + "flags": 1 + }, + "ScopeConfiguration": { + "type": { + "$ref": "#/1047" + }, + "flags": 1 + }, + "Status": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FilterListConfiguration", + "properties": { + "CategoryValues": { + "type": { + "$ref": "#/1528" + }, + "flags": 0 + }, + "MatchOperator": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "NullOption": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "SelectAllOptions": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FilterListControl", + "properties": { + "CascadingControlConfiguration": { + "type": { + "$ref": "#/889" + }, + "flags": 0 + }, + "DisplayOptions": { + "type": { + "$ref": "#/1164" + }, + "flags": 0 + }, + "FilterControlId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "SelectableValues": { + "type": { + "$ref": "#/1048" + }, + "flags": 0 + }, + "SourceFilterId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Title": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Type": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FilterNullOption", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "FilterOperationSelectedFieldsConfiguration", + "properties": { + "SelectedColumns": { + "type": { + "$ref": "#/1529" + }, + "flags": 0, + "description": "

The selected columns of a dataset.

" + }, + "SelectedFieldOptions": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "SelectedFields": { + "type": { + "$ref": "#/1530" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FilterOperationTargetVisualsConfiguration", + "properties": { + "SameSheetTargetVisualConfiguration": { + "type": { + "$ref": "#/1290" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FilterRelativeDateTimeControl", + "properties": { + "DisplayOptions": { + "type": { + "$ref": "#/1281" + }, + "flags": 0 + }, + "FilterControlId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "SourceFilterId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Title": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "FilterScopeConfiguration", + "properties": { + "AllSheets": { + "type": { + "$ref": "#/843" + }, + "flags": 0 + }, + "SelectedSheets": { + "type": { + "$ref": "#/1313" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FilterSelectableValues", + "properties": { + "Values": { + "type": { + "$ref": "#/1531" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FilterSliderControl", + "properties": { + "DisplayOptions": { + "type": { + "$ref": "#/1338" + }, + "flags": 0 + }, + "FilterControlId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "MaximumValue": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + }, + "MinimumValue": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + }, + "SourceFilterId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "StepSize": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + }, + "Title": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Type": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FilterTextAreaControl", + "properties": { + "Delimiter": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "DisplayOptions": { + "type": { + "$ref": "#/1388" + }, + "flags": 0 + }, + "FilterControlId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "SourceFilterId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Title": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "FilterTextFieldControl", + "properties": { + "DisplayOptions": { + "type": { + "$ref": "#/1391" + }, + "flags": 0 + }, + "FilterControlId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "SourceFilterId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Title": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "FilterVisualScope", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "FontConfiguration", + "properties": { + "FontColor": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "FontDecoration": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "FontSize": { + "type": { + "$ref": "#/1055" + }, + "flags": 0 + }, + "FontStyle": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "FontWeight": { + "type": { + "$ref": "#/1057" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FontDecoration", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "FontSize", + "properties": { + "Relative": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FontStyle", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "FontWeight", + "properties": { + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FontWeightName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ForecastComputation", + "properties": { + "ComputationId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "CustomSeasonalityValue": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "LowerBoundary": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "PeriodsBackward": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "PeriodsForward": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "PredictionInterval": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "Seasonality": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Time": { + "type": { + "$ref": "#/1008" + }, + "flags": 0 + }, + "UpperBoundary": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/1175" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ForecastComputationSeasonality", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ForecastConfiguration", + "properties": { + "ForecastProperties": { + "type": { + "$ref": "#/1394" + }, + "flags": 0 + }, + "Scenario": { + "type": { + "$ref": "#/1062" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ForecastScenario", + "properties": { + "WhatIfPointScenario": { + "type": { + "$ref": "#/1444" + }, + "flags": 0 + }, + "WhatIfRangeScenario": { + "type": { + "$ref": "#/1445" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FormatConfiguration", + "properties": { + "DateTimeFormatConfiguration": { + "type": { + "$ref": "#/980" + }, + "flags": 0 + }, + "NumberFormatConfiguration": { + "type": { + "$ref": "#/1184" + }, + "flags": 0 + }, + "StringFormatConfiguration": { + "type": { + "$ref": "#/1347" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FreeFormLayoutCanvasSizeOptions", + "properties": { + "ScreenCanvasSizeOptions": { + "type": { + "$ref": "#/1069" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FreeFormLayoutConfiguration", + "properties": { + "CanvasSizeOptions": { + "type": { + "$ref": "#/1064" + }, + "flags": 0 + }, + "Elements": { + "type": { + "$ref": "#/1532" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "FreeFormLayoutElement", + "properties": { + "BackgroundStyle": { + "type": { + "$ref": "#/1067" + }, + "flags": 0 + }, + "BorderStyle": { + "type": { + "$ref": "#/1068" + }, + "flags": 0 + }, + "ElementId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "ElementType": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Height": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "String based length that is composed of value and unit in px" + }, + "LoadingAnimation": { + "type": { + "$ref": "#/1167" + }, + "flags": 0 + }, + "RenderingRules": { + "type": { + "$ref": "#/1533" + }, + "flags": 0 + }, + "SelectedBorderStyle": { + "type": { + "$ref": "#/1068" + }, + "flags": 0 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Width": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "String based length that is composed of value and unit in px" + }, + "XAxisLocation": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "String based length that is composed of value and unit in px" + }, + "YAxisLocation": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "String based length that is composed of value and unit in px with Integer.MAX_VALUE as maximum value" + } + } + }, + { + "$type": "ObjectType", + "name": "FreeFormLayoutElementBackgroundStyle", + "properties": { + "Color": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FreeFormLayoutElementBorderStyle", + "properties": { + "Color": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FreeFormLayoutScreenCanvasSizeOptions", + "properties": { + "OptimizedViewPortWidth": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "String based length that is composed of value and unit in px" + } + } + }, + { + "$type": "ObjectType", + "name": "FreeFormSectionLayoutConfiguration", + "properties": { + "Elements": { + "type": { + "$ref": "#/1534" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "FunnelChartAggregatedFieldWells", + "properties": { + "Category": { + "type": { + "$ref": "#/1535" + }, + "flags": 0 + }, + "Values": { + "type": { + "$ref": "#/1536" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FunnelChartConfiguration", + "properties": { + "CategoryLabelOptions": { + "type": { + "$ref": "#/899" + }, + "flags": 0 + }, + "DataLabelOptions": { + "type": { + "$ref": "#/1073" + }, + "flags": 0 + }, + "FieldWells": { + "type": { + "$ref": "#/1074" + }, + "flags": 0 + }, + "SortConfiguration": { + "type": { + "$ref": "#/1076" + }, + "flags": 0 + }, + "Tooltip": { + "type": { + "$ref": "#/1401" + }, + "flags": 0 + }, + "ValueLabelOptions": { + "type": { + "$ref": "#/899" + }, + "flags": 0 + }, + "VisualPalette": { + "type": { + "$ref": "#/1433" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FunnelChartDataLabelOptions", + "properties": { + "CategoryLabelVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "LabelColor": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "LabelFontConfiguration": { + "type": { + "$ref": "#/1053" + }, + "flags": 0 + }, + "MeasureDataLabelStyle": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "MeasureLabelVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Position": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FunnelChartFieldWells", + "properties": { + "FunnelChartAggregatedFieldWells": { + "type": { + "$ref": "#/1071" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FunnelChartMeasureDataLabelStyle", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "FunnelChartSortConfiguration", + "properties": { + "CategoryItemsLimit": { + "type": { + "$ref": "#/1126" + }, + "flags": 0 + }, + "CategorySort": { + "type": { + "$ref": "#/1537" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FunnelChartVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/1538" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/1072" + }, + "flags": 0 + }, + "ColumnHierarchies": { + "type": { + "$ref": "#/1539" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/1434" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/1435" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "GaugeChartArcConditionalFormatting", + "properties": { + "ForegroundColor": { + "type": { + "$ref": "#/920" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GaugeChartConditionalFormatting", + "properties": { + "ConditionalFormattingOptions": { + "type": { + "$ref": "#/1540" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GaugeChartConditionalFormattingOption", + "properties": { + "Arc": { + "type": { + "$ref": "#/1078" + }, + "flags": 0 + }, + "PrimaryValue": { + "type": { + "$ref": "#/1084" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GaugeChartConfiguration", + "properties": { + "DataLabels": { + "type": { + "$ref": "#/961" + }, + "flags": 0 + }, + "FieldWells": { + "type": { + "$ref": "#/1082" + }, + "flags": 0 + }, + "GaugeChartOptions": { + "type": { + "$ref": "#/1083" + }, + "flags": 0 + }, + "TooltipOptions": { + "type": { + "$ref": "#/1401" + }, + "flags": 0 + }, + "VisualPalette": { + "type": { + "$ref": "#/1433" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GaugeChartFieldWells", + "properties": { + "TargetValues": { + "type": { + "$ref": "#/1541" + }, + "flags": 0 + }, + "Values": { + "type": { + "$ref": "#/1542" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GaugeChartOptions", + "properties": { + "Arc": { + "type": { + "$ref": "#/849" + }, + "flags": 0 + }, + "ArcAxis": { + "type": { + "$ref": "#/847" + }, + "flags": 0 + }, + "Comparison": { + "type": { + "$ref": "#/916" + }, + "flags": 0 + }, + "PrimaryValueDisplayType": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "PrimaryValueFontConfiguration": { + "type": { + "$ref": "#/1053" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GaugeChartPrimaryValueConditionalFormatting", + "properties": { + "Icon": { + "type": { + "$ref": "#/924" + }, + "flags": 0 + }, + "TextColor": { + "type": { + "$ref": "#/920" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GaugeChartVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/1543" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/1081" + }, + "flags": 0 + }, + "ConditionalFormatting": { + "type": { + "$ref": "#/1079" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/1434" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/1435" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "GeospatialCoordinateBounds", + "properties": { + "East": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + }, + "North": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + }, + "South": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + }, + "West": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "GeospatialHeatmapColorScale", + "properties": { + "Colors": { + "type": { + "$ref": "#/1544" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GeospatialHeatmapConfiguration", + "properties": { + "HeatmapColor": { + "type": { + "$ref": "#/1087" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GeospatialHeatmapDataColor", + "properties": { + "Color": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "GeospatialMapAggregatedFieldWells", + "properties": { + "Colors": { + "type": { + "$ref": "#/1545" + }, + "flags": 0 + }, + "Geospatial": { + "type": { + "$ref": "#/1546" + }, + "flags": 0 + }, + "Values": { + "type": { + "$ref": "#/1547" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GeospatialMapConfiguration", + "properties": { + "FieldWells": { + "type": { + "$ref": "#/1092" + }, + "flags": 0 + }, + "Legend": { + "type": { + "$ref": "#/1147" + }, + "flags": 0 + }, + "MapStyleOptions": { + "type": { + "$ref": "#/1093" + }, + "flags": 0 + }, + "PointStyleOptions": { + "type": { + "$ref": "#/1095" + }, + "flags": 0 + }, + "Tooltip": { + "type": { + "$ref": "#/1401" + }, + "flags": 0 + }, + "VisualPalette": { + "type": { + "$ref": "#/1433" + }, + "flags": 0 + }, + "WindowOptions": { + "type": { + "$ref": "#/1097" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GeospatialMapFieldWells", + "properties": { + "GeospatialMapAggregatedFieldWells": { + "type": { + "$ref": "#/1090" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GeospatialMapStyleOptions", + "properties": { + "BaseMapStyle": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GeospatialMapVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/1548" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/1091" + }, + "flags": 0 + }, + "ColumnHierarchies": { + "type": { + "$ref": "#/1549" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/1434" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/1435" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "GeospatialPointStyleOptions", + "properties": { + "ClusterMarkerConfiguration": { + "type": { + "$ref": "#/901" + }, + "flags": 0 + }, + "HeatmapConfiguration": { + "type": { + "$ref": "#/1088" + }, + "flags": 0 + }, + "SelectedPointStyle": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GeospatialSelectedPointStyle", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "GeospatialWindowOptions", + "properties": { + "Bounds": { + "type": { + "$ref": "#/1086" + }, + "flags": 0 + }, + "MapZoomMode": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GlobalTableBorderOptions", + "properties": { + "SideSpecificBorder": { + "type": { + "$ref": "#/1379" + }, + "flags": 0 + }, + "UniformBorder": { + "type": { + "$ref": "#/1354" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GradientColor", + "properties": { + "Stops": { + "type": { + "$ref": "#/1550" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GradientStop", + "properties": { + "Color": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "DataValue": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "GradientOffset": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "GridLayoutCanvasSizeOptions", + "properties": { + "ScreenCanvasSizeOptions": { + "type": { + "$ref": "#/1104" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GridLayoutConfiguration", + "properties": { + "CanvasSizeOptions": { + "type": { + "$ref": "#/1101" + }, + "flags": 0 + }, + "Elements": { + "type": { + "$ref": "#/1551" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "GridLayoutElement", + "properties": { + "ColumnIndex": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "ColumnSpan": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + }, + "ElementId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "ElementType": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "RowIndex": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "RowSpan": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "GridLayoutScreenCanvasSizeOptions", + "properties": { + "OptimizedViewPortWidth": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "String based length that is composed of value and unit in px" + }, + "ResizeOption": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "GrowthRateComputation", + "properties": { + "ComputationId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "PeriodSize": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "Time": { + "type": { + "$ref": "#/1008" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/1175" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "HeaderFooterSectionConfiguration", + "properties": { + "Layout": { + "type": { + "$ref": "#/1307" + }, + "flags": 1 + }, + "SectionId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Style": { + "type": { + "$ref": "#/1310" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "HeatMapAggregatedFieldWells", + "properties": { + "Columns": { + "type": { + "$ref": "#/1552" + }, + "flags": 0 + }, + "Rows": { + "type": { + "$ref": "#/1553" + }, + "flags": 0 + }, + "Values": { + "type": { + "$ref": "#/1554" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "HeatMapConfiguration", + "properties": { + "ColorScale": { + "type": { + "$ref": "#/903" + }, + "flags": 0 + }, + "ColumnLabelOptions": { + "type": { + "$ref": "#/899" + }, + "flags": 0 + }, + "DataLabels": { + "type": { + "$ref": "#/961" + }, + "flags": 0 + }, + "FieldWells": { + "type": { + "$ref": "#/1109" + }, + "flags": 0 + }, + "Legend": { + "type": { + "$ref": "#/1147" + }, + "flags": 0 + }, + "RowLabelOptions": { + "type": { + "$ref": "#/899" + }, + "flags": 0 + }, + "SortConfiguration": { + "type": { + "$ref": "#/1110" + }, + "flags": 0 + }, + "Tooltip": { + "type": { + "$ref": "#/1401" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "HeatMapFieldWells", + "properties": { + "HeatMapAggregatedFieldWells": { + "type": { + "$ref": "#/1107" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "HeatMapSortConfiguration", + "properties": { + "HeatMapColumnItemsLimitConfiguration": { + "type": { + "$ref": "#/1126" + }, + "flags": 0 + }, + "HeatMapColumnSort": { + "type": { + "$ref": "#/1555" + }, + "flags": 0 + }, + "HeatMapRowItemsLimitConfiguration": { + "type": { + "$ref": "#/1126" + }, + "flags": 0 + }, + "HeatMapRowSort": { + "type": { + "$ref": "#/1556" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "HeatMapVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/1557" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/1108" + }, + "flags": 0 + }, + "ColumnHierarchies": { + "type": { + "$ref": "#/1558" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/1434" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/1435" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "HistogramAggregatedFieldWells", + "properties": { + "Values": { + "type": { + "$ref": "#/1559" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "HistogramBinOptions", + "properties": { + "BinCount": { + "type": { + "$ref": "#/875" + }, + "flags": 0 + }, + "BinWidth": { + "type": { + "$ref": "#/876" + }, + "flags": 0 + }, + "SelectedBinType": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "StartValue": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "HistogramBinType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "HistogramConfiguration", + "properties": { + "BinOptions": { + "type": { + "$ref": "#/1113" + }, + "flags": 0 + }, + "DataLabels": { + "type": { + "$ref": "#/961" + }, + "flags": 0 + }, + "FieldWells": { + "type": { + "$ref": "#/1116" + }, + "flags": 0 + }, + "Tooltip": { + "type": { + "$ref": "#/1401" + }, + "flags": 0 + }, + "VisualPalette": { + "type": { + "$ref": "#/1433" + }, + "flags": 0 + }, + "XAxisDisplayOptions": { + "type": { + "$ref": "#/859" + }, + "flags": 0 + }, + "XAxisLabelOptions": { + "type": { + "$ref": "#/899" + }, + "flags": 0 + }, + "YAxisDisplayOptions": { + "type": { + "$ref": "#/859" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "HistogramFieldWells", + "properties": { + "HistogramAggregatedFieldWells": { + "type": { + "$ref": "#/1112" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "HistogramVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/1560" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/1115" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/1434" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/1435" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "HorizontalTextAlignment", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Icon", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "InsightConfiguration", + "properties": { + "Computations": { + "type": { + "$ref": "#/1561" + }, + "flags": 0 + }, + "CustomNarrative": { + "type": { + "$ref": "#/944" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "InsightVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/1562" + }, + "flags": 0 + }, + "DataSetIdentifier": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "InsightConfiguration": { + "type": { + "$ref": "#/1120" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/1434" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/1435" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "IntegerDefaultValues", + "properties": { + "DynamicValue": { + "type": { + "$ref": "#/1013" + }, + "flags": 0 + }, + "StaticValues": { + "type": { + "$ref": "#/1563" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "IntegerParameter", + "properties": { + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

The name of the integer parameter.

" + }, + "Values": { + "type": { + "$ref": "#/1564" + }, + "flags": 1, + "description": "

The values for the integer parameter.

" + } + } + }, + { + "$type": "ObjectType", + "name": "IntegerParameterDeclaration", + "properties": { + "DefaultValues": { + "type": { + "$ref": "#/1122" + }, + "flags": 0 + }, + "MappedDataSetParameters": { + "type": { + "$ref": "#/1565" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "ParameterValueType": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "ValueWhenUnset": { + "type": { + "$ref": "#/1125" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "IntegerValueWhenUnsetConfiguration", + "properties": { + "CustomValue": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "ValueWhenUnsetOption": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ItemsLimitConfiguration", + "properties": { + "ItemsLimit": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "OtherCategories": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "KPIActualValueConditionalFormatting", + "properties": { + "Icon": { + "type": { + "$ref": "#/924" + }, + "flags": 0 + }, + "TextColor": { + "type": { + "$ref": "#/920" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "KPIComparisonValueConditionalFormatting", + "properties": { + "Icon": { + "type": { + "$ref": "#/924" + }, + "flags": 0 + }, + "TextColor": { + "type": { + "$ref": "#/920" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "KPIConditionalFormatting", + "properties": { + "ConditionalFormattingOptions": { + "type": { + "$ref": "#/1566" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "KPIConditionalFormattingOption", + "properties": { + "ActualValue": { + "type": { + "$ref": "#/1127" + }, + "flags": 0 + }, + "ComparisonValue": { + "type": { + "$ref": "#/1128" + }, + "flags": 0 + }, + "PrimaryValue": { + "type": { + "$ref": "#/1134" + }, + "flags": 0 + }, + "ProgressBar": { + "type": { + "$ref": "#/1135" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "KPIConfiguration", + "properties": { + "FieldWells": { + "type": { + "$ref": "#/1132" + }, + "flags": 0 + }, + "KPIOptions": { + "type": { + "$ref": "#/1133" + }, + "flags": 0 + }, + "SortConfiguration": { + "type": { + "$ref": "#/1136" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "KPIFieldWells", + "properties": { + "TargetValues": { + "type": { + "$ref": "#/1567" + }, + "flags": 0 + }, + "TrendGroups": { + "type": { + "$ref": "#/1568" + }, + "flags": 0 + }, + "Values": { + "type": { + "$ref": "#/1569" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "KPIOptions", + "properties": { + "Comparison": { + "type": { + "$ref": "#/916" + }, + "flags": 0 + }, + "PrimaryValueDisplayType": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "PrimaryValueFontConfiguration": { + "type": { + "$ref": "#/1053" + }, + "flags": 0 + }, + "ProgressBar": { + "type": { + "$ref": "#/1257" + }, + "flags": 0 + }, + "SecondaryValue": { + "type": { + "$ref": "#/1302" + }, + "flags": 0 + }, + "SecondaryValueFontConfiguration": { + "type": { + "$ref": "#/1053" + }, + "flags": 0 + }, + "Sparkline": { + "type": { + "$ref": "#/1137" + }, + "flags": 0 + }, + "TrendArrows": { + "type": { + "$ref": "#/1417" + }, + "flags": 0 + }, + "VisualLayoutOptions": { + "type": { + "$ref": "#/1140" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "KPIPrimaryValueConditionalFormatting", + "properties": { + "Icon": { + "type": { + "$ref": "#/924" + }, + "flags": 0 + }, + "TextColor": { + "type": { + "$ref": "#/920" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "KPIProgressBarConditionalFormatting", + "properties": { + "ForegroundColor": { + "type": { + "$ref": "#/920" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "KPISortConfiguration", + "properties": { + "TrendGroupSort": { + "type": { + "$ref": "#/1570" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "KPISparklineOptions", + "properties": { + "Color": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "TooltipVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "KPISparklineType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "KPIVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/1571" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/1131" + }, + "flags": 0 + }, + "ColumnHierarchies": { + "type": { + "$ref": "#/1572" + }, + "flags": 0 + }, + "ConditionalFormatting": { + "type": { + "$ref": "#/1129" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/1434" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/1435" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "KPIVisualLayoutOptions", + "properties": { + "StandardLayout": { + "type": { + "$ref": "#/1141" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "KPIVisualStandardLayout", + "properties": { + "Type": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "KPIVisualStandardLayoutType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LabelOptions", + "properties": { + "CustomLabel": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "FontConfiguration": { + "type": { + "$ref": "#/1053" + }, + "flags": 0 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Layout", + "properties": { + "Configuration": { + "type": { + "$ref": "#/1145" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "LayoutConfiguration", + "properties": { + "FreeFormLayout": { + "type": { + "$ref": "#/1065" + }, + "flags": 0 + }, + "GridLayout": { + "type": { + "$ref": "#/1102" + }, + "flags": 0 + }, + "SectionBasedLayout": { + "type": { + "$ref": "#/1305" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "LayoutElementType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LegendOptions", + "properties": { + "Height": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "String based length that is composed of value and unit in px" + }, + "Position": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/1143" + }, + "flags": 0 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Width": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "String based length that is composed of value and unit in px" + } + } + }, + { + "$type": "ObjectType", + "name": "LegendPosition", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LineChartAggregatedFieldWells", + "properties": { + "Category": { + "type": { + "$ref": "#/1573" + }, + "flags": 0 + }, + "Colors": { + "type": { + "$ref": "#/1574" + }, + "flags": 0 + }, + "SmallMultiples": { + "type": { + "$ref": "#/1575" + }, + "flags": 0 + }, + "Values": { + "type": { + "$ref": "#/1576" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "LineChartConfiguration", + "properties": { + "ContributionAnalysisDefaults": { + "type": { + "$ref": "#/1577" + }, + "flags": 0 + }, + "DataLabels": { + "type": { + "$ref": "#/961" + }, + "flags": 0 + }, + "DefaultSeriesSettings": { + "type": { + "$ref": "#/1151" + }, + "flags": 0 + }, + "FieldWells": { + "type": { + "$ref": "#/1152" + }, + "flags": 0 + }, + "ForecastConfigurations": { + "type": { + "$ref": "#/1578" + }, + "flags": 0 + }, + "Legend": { + "type": { + "$ref": "#/1147" + }, + "flags": 0 + }, + "PrimaryYAxisDisplayOptions": { + "type": { + "$ref": "#/1162" + }, + "flags": 0 + }, + "PrimaryYAxisLabelOptions": { + "type": { + "$ref": "#/899" + }, + "flags": 0 + }, + "ReferenceLines": { + "type": { + "$ref": "#/1579" + }, + "flags": 0 + }, + "SecondaryYAxisDisplayOptions": { + "type": { + "$ref": "#/1162" + }, + "flags": 0 + }, + "SecondaryYAxisLabelOptions": { + "type": { + "$ref": "#/899" + }, + "flags": 0 + }, + "Series": { + "type": { + "$ref": "#/1580" + }, + "flags": 0 + }, + "SmallMultiplesOptions": { + "type": { + "$ref": "#/1342" + }, + "flags": 0 + }, + "SortConfiguration": { + "type": { + "$ref": "#/1158" + }, + "flags": 0 + }, + "Tooltip": { + "type": { + "$ref": "#/1401" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "VisualPalette": { + "type": { + "$ref": "#/1433" + }, + "flags": 0 + }, + "XAxisDisplayOptions": { + "type": { + "$ref": "#/859" + }, + "flags": 0 + }, + "XAxisLabelOptions": { + "type": { + "$ref": "#/899" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "LineChartDefaultSeriesSettings", + "properties": { + "AxisBinding": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "LineStyleSettings": { + "type": { + "$ref": "#/1154" + }, + "flags": 0 + }, + "MarkerStyleSettings": { + "type": { + "$ref": "#/1156" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "LineChartFieldWells", + "properties": { + "LineChartAggregatedFieldWells": { + "type": { + "$ref": "#/1149" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "LineChartLineStyle", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LineChartLineStyleSettings", + "properties": { + "LineInterpolation": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "LineStyle": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "LineVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "LineWidth": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "String based length that is composed of value and unit in px" + } + } + }, + { + "$type": "ObjectType", + "name": "LineChartMarkerShape", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LineChartMarkerStyleSettings", + "properties": { + "MarkerColor": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "MarkerShape": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "MarkerSize": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "String based length that is composed of value and unit in px" + }, + "MarkerVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "LineChartSeriesSettings", + "properties": { + "LineStyleSettings": { + "type": { + "$ref": "#/1154" + }, + "flags": 0 + }, + "MarkerStyleSettings": { + "type": { + "$ref": "#/1156" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "LineChartSortConfiguration", + "properties": { + "CategoryItemsLimitConfiguration": { + "type": { + "$ref": "#/1126" + }, + "flags": 0 + }, + "CategorySort": { + "type": { + "$ref": "#/1581" + }, + "flags": 0 + }, + "ColorItemsLimitConfiguration": { + "type": { + "$ref": "#/1126" + }, + "flags": 0 + }, + "SmallMultiplesLimitConfiguration": { + "type": { + "$ref": "#/1126" + }, + "flags": 0 + }, + "SmallMultiplesSort": { + "type": { + "$ref": "#/1582" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "LineChartType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LineChartVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/1583" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/1150" + }, + "flags": 0 + }, + "ColumnHierarchies": { + "type": { + "$ref": "#/1584" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/1434" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/1435" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "LineInterpolation", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LineSeriesAxisDisplayOptions", + "properties": { + "AxisOptions": { + "type": { + "$ref": "#/859" + }, + "flags": 0 + }, + "MissingDataConfigurations": { + "type": { + "$ref": "#/1585" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "LinkSharingConfiguration", + "properties": { + "Permissions": { + "type": { + "$ref": "#/1586" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ListControlDisplayOptions", + "properties": { + "InfoIconLabelOptions": { + "type": { + "$ref": "#/1321" + }, + "flags": 0 + }, + "SearchOptions": { + "type": { + "$ref": "#/1165" + }, + "flags": 0 + }, + "SelectAllOptions": { + "type": { + "$ref": "#/1166" + }, + "flags": 0 + }, + "TitleOptions": { + "type": { + "$ref": "#/1143" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ListControlSearchOptions", + "properties": { + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ListControlSelectAllOptions", + "properties": { + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "LoadingAnimation", + "properties": { + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "LocalNavigationConfiguration", + "properties": { + "TargetSheetId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "LongFormatText", + "properties": { + "PlainText": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "RichText": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "MapZoomMode", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MappedDataSetParameter", + "properties": { + "DataSetIdentifier": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "DataSetParameterName": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "MaximumLabelType", + "properties": { + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "MaximumMinimumComputation", + "properties": { + "ComputationId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Time": { + "type": { + "$ref": "#/1008" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/1175" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "MaximumMinimumComputationType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MeasureField", + "properties": { + "CalculatedMeasureField": { + "type": { + "$ref": "#/888" + }, + "flags": 0 + }, + "CategoricalMeasureField": { + "type": { + "$ref": "#/893" + }, + "flags": 0 + }, + "DateMeasureField": { + "type": { + "$ref": "#/978" + }, + "flags": 0 + }, + "NumericalMeasureField": { + "type": { + "$ref": "#/1198" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "MetricComparisonComputation", + "properties": { + "ComputationId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "FromValue": { + "type": { + "$ref": "#/1175" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "TargetValue": { + "type": { + "$ref": "#/1175" + }, + "flags": 0 + }, + "Time": { + "type": { + "$ref": "#/1008" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "MinimumLabelType", + "properties": { + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "MissingDataConfiguration", + "properties": { + "TreatmentOption": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "MissingDataTreatmentOption", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "NegativeValueConfiguration", + "properties": { + "DisplayMode": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "NegativeValueDisplayMode", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "NullValueFormatConfiguration", + "properties": { + "NullString": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "NumberDisplayFormatConfiguration", + "properties": { + "DecimalPlacesConfiguration": { + "type": { + "$ref": "#/990" + }, + "flags": 0 + }, + "NegativeValueConfiguration": { + "type": { + "$ref": "#/1180" + }, + "flags": 0 + }, + "NullValueFormatConfiguration": { + "type": { + "$ref": "#/1182" + }, + "flags": 0 + }, + "NumberScale": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Prefix": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "SeparatorConfiguration": { + "type": { + "$ref": "#/1194" + }, + "flags": 0 + }, + "Suffix": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "NumberFormatConfiguration", + "properties": { + "FormatConfiguration": { + "type": { + "$ref": "#/1191" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "NumberScale", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "NumericAxisOptions", + "properties": { + "Range": { + "type": { + "$ref": "#/860" + }, + "flags": 0 + }, + "Scale": { + "type": { + "$ref": "#/865" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "NumericEqualityDrillDownFilter", + "properties": { + "Column": { + "type": { + "$ref": "#/907" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "NumericEqualityFilter", + "properties": { + "AggregationFunction": { + "type": { + "$ref": "#/841" + }, + "flags": 0 + }, + "Column": { + "type": { + "$ref": "#/907" + }, + "flags": 1 + }, + "DefaultFilterControlConfiguration": { + "type": { + "$ref": "#/993" + }, + "flags": 0 + }, + "FilterId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "MatchOperator": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "NullOption": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "ParameterName": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "SelectAllOptions": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "NumericEqualityMatchOperator", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "NumericFilterSelectAllOptions", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "NumericFormatConfiguration", + "properties": { + "CurrencyDisplayFormatConfiguration": { + "type": { + "$ref": "#/932" + }, + "flags": 0 + }, + "NumberDisplayFormatConfiguration": { + "type": { + "$ref": "#/1183" + }, + "flags": 0 + }, + "PercentageDisplayFormatConfiguration": { + "type": { + "$ref": "#/1218" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "NumericRangeFilter", + "properties": { + "AggregationFunction": { + "type": { + "$ref": "#/841" + }, + "flags": 0 + }, + "Column": { + "type": { + "$ref": "#/907" + }, + "flags": 1 + }, + "DefaultFilterControlConfiguration": { + "type": { + "$ref": "#/993" + }, + "flags": 0 + }, + "FilterId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "IncludeMaximum": { + "type": { + "$ref": "#/650" + }, + "flags": 0 + }, + "IncludeMinimum": { + "type": { + "$ref": "#/650" + }, + "flags": 0 + }, + "NullOption": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "RangeMaximum": { + "type": { + "$ref": "#/1193" + }, + "flags": 0 + }, + "RangeMinimum": { + "type": { + "$ref": "#/1193" + }, + "flags": 0 + }, + "SelectAllOptions": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "NumericRangeFilterValue", + "properties": { + "Parameter": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "StaticValue": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "NumericSeparatorConfiguration", + "properties": { + "DecimalSeparator": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ThousandsSeparator": { + "type": { + "$ref": "#/1393" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "NumericSeparatorSymbol", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "NumericalAggregationFunction", + "properties": { + "PercentileAggregation": { + "type": { + "$ref": "#/1219" + }, + "flags": 0 + }, + "SimpleNumericalAggregation": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "NumericalDimensionField", + "properties": { + "Column": { + "type": { + "$ref": "#/907" + }, + "flags": 1 + }, + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "FormatConfiguration": { + "type": { + "$ref": "#/1184" + }, + "flags": 0 + }, + "HierarchyId": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "NumericalMeasureField", + "properties": { + "AggregationFunction": { + "type": { + "$ref": "#/1196" + }, + "flags": 0 + }, + "Column": { + "type": { + "$ref": "#/907" + }, + "flags": 1 + }, + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "FormatConfiguration": { + "type": { + "$ref": "#/1184" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "OtherCategories", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PaginationConfiguration", + "properties": { + "PageNumber": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + }, + "PageSize": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "PanelBorderStyle", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PanelConfiguration", + "properties": { + "BackgroundColor": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "BackgroundVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "BorderColor": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "BorderStyle": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "BorderThickness": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "String based length that is composed of value and unit in px" + }, + "BorderVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "GutterSpacing": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "String based length that is composed of value and unit in px" + }, + "GutterVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/1203" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PanelTitleOptions", + "properties": { + "FontConfiguration": { + "type": { + "$ref": "#/1053" + }, + "flags": 0 + }, + "HorizontalTextAlignment": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PaperOrientation", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PaperSize", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ParameterControl", + "properties": { + "DateTimePicker": { + "type": { + "$ref": "#/1207" + }, + "flags": 0 + }, + "Dropdown": { + "type": { + "$ref": "#/1209" + }, + "flags": 0 + }, + "List": { + "type": { + "$ref": "#/1210" + }, + "flags": 0 + }, + "Slider": { + "type": { + "$ref": "#/1212" + }, + "flags": 0 + }, + "TextArea": { + "type": { + "$ref": "#/1213" + }, + "flags": 0 + }, + "TextField": { + "type": { + "$ref": "#/1214" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ParameterDateTimePickerControl", + "properties": { + "DisplayOptions": { + "type": { + "$ref": "#/984" + }, + "flags": 0 + }, + "ParameterControlId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "SourceParameterName": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Title": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ParameterDeclaration", + "properties": { + "DateTimeParameterDeclaration": { + "type": { + "$ref": "#/983" + }, + "flags": 0 + }, + "DecimalParameterDeclaration": { + "type": { + "$ref": "#/989" + }, + "flags": 0 + }, + "IntegerParameterDeclaration": { + "type": { + "$ref": "#/1124" + }, + "flags": 0 + }, + "StringParameterDeclaration": { + "type": { + "$ref": "#/1349" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ParameterDropDownControl", + "properties": { + "CascadingControlConfiguration": { + "type": { + "$ref": "#/889" + }, + "flags": 0 + }, + "DisplayOptions": { + "type": { + "$ref": "#/1012" + }, + "flags": 0 + }, + "ParameterControlId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "SelectableValues": { + "type": { + "$ref": "#/1211" + }, + "flags": 0 + }, + "SourceParameterName": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Title": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Type": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ParameterListControl", + "properties": { + "CascadingControlConfiguration": { + "type": { + "$ref": "#/889" + }, + "flags": 0 + }, + "DisplayOptions": { + "type": { + "$ref": "#/1164" + }, + "flags": 0 + }, + "ParameterControlId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "SelectableValues": { + "type": { + "$ref": "#/1211" + }, + "flags": 0 + }, + "SourceParameterName": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Title": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Type": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ParameterSelectableValues", + "properties": { + "LinkToDataSetColumn": { + "type": { + "$ref": "#/907" + }, + "flags": 0 + }, + "Values": { + "type": { + "$ref": "#/1587" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ParameterSliderControl", + "properties": { + "DisplayOptions": { + "type": { + "$ref": "#/1338" + }, + "flags": 0 + }, + "MaximumValue": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + }, + "MinimumValue": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + }, + "ParameterControlId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "SourceParameterName": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "StepSize": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + }, + "Title": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ParameterTextAreaControl", + "properties": { + "Delimiter": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "DisplayOptions": { + "type": { + "$ref": "#/1388" + }, + "flags": 0 + }, + "ParameterControlId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "SourceParameterName": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Title": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ParameterTextFieldControl", + "properties": { + "DisplayOptions": { + "type": { + "$ref": "#/1391" + }, + "flags": 0 + }, + "ParameterControlId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "SourceParameterName": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Title": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ParameterValueType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Parameters", + "properties": { + "DateTimeParameters": { + "type": { + "$ref": "#/1588" + }, + "flags": 0, + "description": "

The parameters that have a data type of date-time.

" + }, + "DecimalParameters": { + "type": { + "$ref": "#/1589" + }, + "flags": 0, + "description": "

The parameters that have a data type of decimal.

" + }, + "IntegerParameters": { + "type": { + "$ref": "#/1590" + }, + "flags": 0, + "description": "

The parameters that have a data type of integer.

" + }, + "StringParameters": { + "type": { + "$ref": "#/1591" + }, + "flags": 0, + "description": "

The parameters that have a data type of string.

" + } + } + }, + { + "$type": "ObjectType", + "name": "PercentVisibleRange", + "properties": { + "From": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "To": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PercentageDisplayFormatConfiguration", + "properties": { + "DecimalPlacesConfiguration": { + "type": { + "$ref": "#/990" + }, + "flags": 0 + }, + "NegativeValueConfiguration": { + "type": { + "$ref": "#/1180" + }, + "flags": 0 + }, + "NullValueFormatConfiguration": { + "type": { + "$ref": "#/1182" + }, + "flags": 0 + }, + "Prefix": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "SeparatorConfiguration": { + "type": { + "$ref": "#/1194" + }, + "flags": 0 + }, + "Suffix": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PercentileAggregation", + "properties": { + "PercentileValue": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PeriodOverPeriodComputation", + "properties": { + "ComputationId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Time": { + "type": { + "$ref": "#/1008" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/1175" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PeriodToDateComputation", + "properties": { + "ComputationId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "PeriodTimeGranularity": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Time": { + "type": { + "$ref": "#/1008" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/1175" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PieChartAggregatedFieldWells", + "properties": { + "Category": { + "type": { + "$ref": "#/1592" + }, + "flags": 0 + }, + "SmallMultiples": { + "type": { + "$ref": "#/1593" + }, + "flags": 0 + }, + "Values": { + "type": { + "$ref": "#/1594" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PieChartConfiguration", + "properties": { + "CategoryLabelOptions": { + "type": { + "$ref": "#/899" + }, + "flags": 0 + }, + "ContributionAnalysisDefaults": { + "type": { + "$ref": "#/1595" + }, + "flags": 0 + }, + "DataLabels": { + "type": { + "$ref": "#/961" + }, + "flags": 0 + }, + "DonutOptions": { + "type": { + "$ref": "#/1010" + }, + "flags": 0 + }, + "FieldWells": { + "type": { + "$ref": "#/1224" + }, + "flags": 0 + }, + "Legend": { + "type": { + "$ref": "#/1147" + }, + "flags": 0 + }, + "SmallMultiplesOptions": { + "type": { + "$ref": "#/1342" + }, + "flags": 0 + }, + "SortConfiguration": { + "type": { + "$ref": "#/1225" + }, + "flags": 0 + }, + "Tooltip": { + "type": { + "$ref": "#/1401" + }, + "flags": 0 + }, + "ValueLabelOptions": { + "type": { + "$ref": "#/899" + }, + "flags": 0 + }, + "VisualPalette": { + "type": { + "$ref": "#/1433" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PieChartFieldWells", + "properties": { + "PieChartAggregatedFieldWells": { + "type": { + "$ref": "#/1222" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PieChartSortConfiguration", + "properties": { + "CategoryItemsLimit": { + "type": { + "$ref": "#/1126" + }, + "flags": 0 + }, + "CategorySort": { + "type": { + "$ref": "#/1596" + }, + "flags": 0 + }, + "SmallMultiplesLimitConfiguration": { + "type": { + "$ref": "#/1126" + }, + "flags": 0 + }, + "SmallMultiplesSort": { + "type": { + "$ref": "#/1597" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PieChartVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/1598" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/1223" + }, + "flags": 0 + }, + "ColumnHierarchies": { + "type": { + "$ref": "#/1599" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/1434" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/1435" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotFieldSortOptions", + "properties": { + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "SortBy": { + "type": { + "$ref": "#/1249" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTableAggregatedFieldWells", + "properties": { + "Columns": { + "type": { + "$ref": "#/1600" + }, + "flags": 0 + }, + "Rows": { + "type": { + "$ref": "#/1601" + }, + "flags": 0 + }, + "Values": { + "type": { + "$ref": "#/1602" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTableCellConditionalFormatting", + "properties": { + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Scope": { + "type": { + "$ref": "#/1232" + }, + "flags": 0 + }, + "Scopes": { + "type": { + "$ref": "#/1603" + }, + "flags": 0 + }, + "TextFormat": { + "type": { + "$ref": "#/1389" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTableConditionalFormatting", + "properties": { + "ConditionalFormattingOptions": { + "type": { + "$ref": "#/1604" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTableConditionalFormattingOption", + "properties": { + "Cell": { + "type": { + "$ref": "#/1229" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTableConditionalFormattingScope", + "properties": { + "Role": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTableConditionalFormattingScopeRole", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PivotTableConfiguration", + "properties": { + "FieldOptions": { + "type": { + "$ref": "#/1241" + }, + "flags": 0 + }, + "FieldWells": { + "type": { + "$ref": "#/1243" + }, + "flags": 0 + }, + "PaginatedReportOptions": { + "type": { + "$ref": "#/1246" + }, + "flags": 0 + }, + "SortConfiguration": { + "type": { + "$ref": "#/1250" + }, + "flags": 0 + }, + "TableOptions": { + "type": { + "$ref": "#/1245" + }, + "flags": 0 + }, + "TotalOptions": { + "type": { + "$ref": "#/1252" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTableDataPathOption", + "properties": { + "DataPathList": { + "type": { + "$ref": "#/1605" + }, + "flags": 1 + }, + "Width": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "String based length that is composed of value and unit in px" + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTableDataPathType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PivotTableFieldCollapseState", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PivotTableFieldCollapseStateOption", + "properties": { + "State": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Target": { + "type": { + "$ref": "#/1239" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTableFieldCollapseStateTarget", + "properties": { + "FieldDataPathValues": { + "type": { + "$ref": "#/1606" + }, + "flags": 0 + }, + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTableFieldOption", + "properties": { + "CustomLabel": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTableFieldOptions", + "properties": { + "CollapseStateOptions": { + "type": { + "$ref": "#/1607" + }, + "flags": 0 + }, + "DataPathOptions": { + "type": { + "$ref": "#/1608" + }, + "flags": 0 + }, + "SelectedFieldOptions": { + "type": { + "$ref": "#/1609" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTableFieldSubtotalOptions", + "properties": { + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTableFieldWells", + "properties": { + "PivotTableAggregatedFieldWells": { + "type": { + "$ref": "#/1228" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTableMetricPlacement", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PivotTableOptions", + "properties": { + "CellStyle": { + "type": { + "$ref": "#/1359" + }, + "flags": 0 + }, + "CollapsedRowDimensionsVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ColumnHeaderStyle": { + "type": { + "$ref": "#/1359" + }, + "flags": 0 + }, + "ColumnNamesVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "DefaultCellWidth": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "String based length that is composed of value and unit in px" + }, + "MetricPlacement": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "RowAlternateColorOptions": { + "type": { + "$ref": "#/1289" + }, + "flags": 0 + }, + "RowFieldNamesStyle": { + "type": { + "$ref": "#/1359" + }, + "flags": 0 + }, + "RowHeaderStyle": { + "type": { + "$ref": "#/1359" + }, + "flags": 0 + }, + "RowsLabelOptions": { + "type": { + "$ref": "#/1247" + }, + "flags": 0 + }, + "RowsLayout": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "SingleMetricVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ToggleButtonsVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTablePaginatedReportOptions", + "properties": { + "OverflowColumnHeaderVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "VerticalOverflowVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTableRowsLabelOptions", + "properties": { + "CustomLabel": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTableRowsLayout", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PivotTableSortBy", + "properties": { + "Column": { + "type": { + "$ref": "#/909" + }, + "flags": 0 + }, + "DataPath": { + "type": { + "$ref": "#/967" + }, + "flags": 0 + }, + "Field": { + "type": { + "$ref": "#/1024" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTableSortConfiguration", + "properties": { + "FieldSortOptions": { + "type": { + "$ref": "#/1610" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTableSubtotalLevel", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PivotTableTotalOptions", + "properties": { + "ColumnSubtotalOptions": { + "type": { + "$ref": "#/1352" + }, + "flags": 0 + }, + "ColumnTotalOptions": { + "type": { + "$ref": "#/1254" + }, + "flags": 0 + }, + "RowSubtotalOptions": { + "type": { + "$ref": "#/1352" + }, + "flags": 0 + }, + "RowTotalOptions": { + "type": { + "$ref": "#/1254" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTableVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/1611" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/1234" + }, + "flags": 0 + }, + "ConditionalFormatting": { + "type": { + "$ref": "#/1230" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/1434" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/1435" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTotalOptions", + "properties": { + "CustomLabel": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "MetricHeaderCellStyle": { + "type": { + "$ref": "#/1359" + }, + "flags": 0 + }, + "Placement": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ScrollStatus": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "TotalAggregationOptions": { + "type": { + "$ref": "#/1612" + }, + "flags": 0 + }, + "TotalCellStyle": { + "type": { + "$ref": "#/1359" + }, + "flags": 0 + }, + "TotalsVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ValueCellStyle": { + "type": { + "$ref": "#/1359" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PredefinedHierarchy", + "properties": { + "Columns": { + "type": { + "$ref": "#/1613" + }, + "flags": 1 + }, + "DrillDownFilters": { + "type": { + "$ref": "#/1614" + }, + "flags": 0 + }, + "HierarchyId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "PrimaryValueDisplayType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ProgressBarOptions", + "properties": { + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "RadarChartAggregatedFieldWells", + "properties": { + "Category": { + "type": { + "$ref": "#/1615" + }, + "flags": 0 + }, + "Color": { + "type": { + "$ref": "#/1616" + }, + "flags": 0 + }, + "Values": { + "type": { + "$ref": "#/1617" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "RadarChartAreaStyleSettings", + "properties": { + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "RadarChartAxesRangeScale", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RadarChartConfiguration", + "properties": { + "AlternateBandColorsVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "AlternateBandEvenColor": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "AlternateBandOddColor": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "AxesRangeScale": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "BaseSeriesSettings": { + "type": { + "$ref": "#/1263" + }, + "flags": 0 + }, + "CategoryAxis": { + "type": { + "$ref": "#/859" + }, + "flags": 0 + }, + "CategoryLabelOptions": { + "type": { + "$ref": "#/899" + }, + "flags": 0 + }, + "ColorAxis": { + "type": { + "$ref": "#/859" + }, + "flags": 0 + }, + "ColorLabelOptions": { + "type": { + "$ref": "#/899" + }, + "flags": 0 + }, + "FieldWells": { + "type": { + "$ref": "#/1262" + }, + "flags": 0 + }, + "Legend": { + "type": { + "$ref": "#/1147" + }, + "flags": 0 + }, + "Shape": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "SortConfiguration": { + "type": { + "$ref": "#/1265" + }, + "flags": 0 + }, + "StartAngle": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "VisualPalette": { + "type": { + "$ref": "#/1433" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "RadarChartFieldWells", + "properties": { + "RadarChartAggregatedFieldWells": { + "type": { + "$ref": "#/1258" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "RadarChartSeriesSettings", + "properties": { + "AreaStyleSettings": { + "type": { + "$ref": "#/1259" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "RadarChartShape", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RadarChartSortConfiguration", + "properties": { + "CategoryItemsLimit": { + "type": { + "$ref": "#/1126" + }, + "flags": 0 + }, + "CategorySort": { + "type": { + "$ref": "#/1618" + }, + "flags": 0 + }, + "ColorItemsLimit": { + "type": { + "$ref": "#/1126" + }, + "flags": 0 + }, + "ColorSort": { + "type": { + "$ref": "#/1619" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "RadarChartVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/1620" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/1261" + }, + "flags": 0 + }, + "ColumnHierarchies": { + "type": { + "$ref": "#/1621" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/1434" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/1435" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "RangeEndsLabelType", + "properties": { + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ReferenceLine", + "properties": { + "DataConfiguration": { + "type": { + "$ref": "#/1270" + }, + "flags": 1 + }, + "LabelConfiguration": { + "type": { + "$ref": "#/1272" + }, + "flags": 0 + }, + "Status": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "StyleConfiguration": { + "type": { + "$ref": "#/1278" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ReferenceLineCustomLabelConfiguration", + "properties": { + "CustomLabel": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ReferenceLineDataConfiguration", + "properties": { + "AxisBinding": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "DynamicConfiguration": { + "type": { + "$ref": "#/1271" + }, + "flags": 0 + }, + "SeriesType": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "StaticConfiguration": { + "type": { + "$ref": "#/1277" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ReferenceLineDynamicDataConfiguration", + "properties": { + "Calculation": { + "type": { + "$ref": "#/1196" + }, + "flags": 1 + }, + "Column": { + "type": { + "$ref": "#/907" + }, + "flags": 1 + }, + "MeasureAggregationFunction": { + "type": { + "$ref": "#/841" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ReferenceLineLabelConfiguration", + "properties": { + "CustomLabelConfiguration": { + "type": { + "$ref": "#/1269" + }, + "flags": 0 + }, + "FontColor": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "FontConfiguration": { + "type": { + "$ref": "#/1053" + }, + "flags": 0 + }, + "HorizontalPosition": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ValueLabelConfiguration": { + "type": { + "$ref": "#/1279" + }, + "flags": 0 + }, + "VerticalPosition": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ReferenceLineLabelHorizontalPosition", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ReferenceLineLabelVerticalPosition", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ReferenceLinePatternType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ReferenceLineSeriesType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ReferenceLineStaticDataConfiguration", + "properties": { + "Value": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ReferenceLineStyleConfiguration", + "properties": { + "Color": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Pattern": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ReferenceLineValueLabelConfiguration", + "properties": { + "FormatConfiguration": { + "type": { + "$ref": "#/1191" + }, + "flags": 0 + }, + "RelativePosition": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ReferenceLineValueLabelRelativePosition", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RelativeDateTimeControlDisplayOptions", + "properties": { + "DateTimeFormat": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "InfoIconLabelOptions": { + "type": { + "$ref": "#/1321" + }, + "flags": 0 + }, + "TitleOptions": { + "type": { + "$ref": "#/1143" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "RelativeDateType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RelativeDatesFilter", + "properties": { + "AnchorDateConfiguration": { + "type": { + "$ref": "#/845" + }, + "flags": 1 + }, + "Column": { + "type": { + "$ref": "#/907" + }, + "flags": 1 + }, + "DefaultFilterControlConfiguration": { + "type": { + "$ref": "#/993" + }, + "flags": 0 + }, + "ExcludePeriodConfiguration": { + "type": { + "$ref": "#/1016" + }, + "flags": 0 + }, + "FilterId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "MinimumGranularity": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "NullOption": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "ParameterName": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "RelativeDateType": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "RelativeDateValue": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "TimeGranularity": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "RelativeFontSize", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ResizeOption", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ResourcePermission", + "properties": { + "Actions": { + "type": { + "$ref": "#/1622" + }, + "flags": 1, + "description": "

The IAM action to grant or revoke permissions on.

" + }, + "Principal": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

The Amazon Resource Name (ARN) of the principal. This can be one of the\n following:

\n
    \n
  • \n

    The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

    \n
    • \n
  • \n

    The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)

    \n
    • \n
  • \n

    The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight\n ARN. Use this option only to share resources (templates) across Amazon Web Services accounts.\n (This is less common.)

    \n
    • \n
" + } + } + }, + { + "$type": "ObjectType", + "name": "ResourceStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RollingDateConfiguration", + "properties": { + "DataSetIdentifier": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Expression": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "RowAlternateColorOptions", + "properties": { + "RowAlternateColors": { + "type": { + "$ref": "#/1623" + }, + "flags": 0 + }, + "Status": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "UsePrimaryBackgroundColor": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SameSheetTargetVisualConfiguration", + "properties": { + "TargetVisualOptions": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "TargetVisuals": { + "type": { + "$ref": "#/1624" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SankeyDiagramAggregatedFieldWells", + "properties": { + "Destination": { + "type": { + "$ref": "#/1625" + }, + "flags": 0 + }, + "Source": { + "type": { + "$ref": "#/1626" + }, + "flags": 0 + }, + "Weight": { + "type": { + "$ref": "#/1627" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SankeyDiagramChartConfiguration", + "properties": { + "DataLabels": { + "type": { + "$ref": "#/961" + }, + "flags": 0 + }, + "FieldWells": { + "type": { + "$ref": "#/1293" + }, + "flags": 0 + }, + "SortConfiguration": { + "type": { + "$ref": "#/1294" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SankeyDiagramFieldWells", + "properties": { + "SankeyDiagramAggregatedFieldWells": { + "type": { + "$ref": "#/1291" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SankeyDiagramSortConfiguration", + "properties": { + "DestinationItemsLimit": { + "type": { + "$ref": "#/1126" + }, + "flags": 0 + }, + "SourceItemsLimit": { + "type": { + "$ref": "#/1126" + }, + "flags": 0 + }, + "WeightSort": { + "type": { + "$ref": "#/1628" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SankeyDiagramVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/1629" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/1292" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/1434" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/1435" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ScatterPlotCategoricallyAggregatedFieldWells", + "properties": { + "Category": { + "type": { + "$ref": "#/1630" + }, + "flags": 0 + }, + "Label": { + "type": { + "$ref": "#/1631" + }, + "flags": 0 + }, + "Size": { + "type": { + "$ref": "#/1632" + }, + "flags": 0 + }, + "XAxis": { + "type": { + "$ref": "#/1633" + }, + "flags": 0 + }, + "YAxis": { + "type": { + "$ref": "#/1634" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ScatterPlotConfiguration", + "properties": { + "DataLabels": { + "type": { + "$ref": "#/961" + }, + "flags": 0 + }, + "FieldWells": { + "type": { + "$ref": "#/1298" + }, + "flags": 0 + }, + "Legend": { + "type": { + "$ref": "#/1147" + }, + "flags": 0 + }, + "Tooltip": { + "type": { + "$ref": "#/1401" + }, + "flags": 0 + }, + "VisualPalette": { + "type": { + "$ref": "#/1433" + }, + "flags": 0 + }, + "XAxisDisplayOptions": { + "type": { + "$ref": "#/859" + }, + "flags": 0 + }, + "XAxisLabelOptions": { + "type": { + "$ref": "#/899" + }, + "flags": 0 + }, + "YAxisDisplayOptions": { + "type": { + "$ref": "#/859" + }, + "flags": 0 + }, + "YAxisLabelOptions": { + "type": { + "$ref": "#/899" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ScatterPlotFieldWells", + "properties": { + "ScatterPlotCategoricallyAggregatedFieldWells": { + "type": { + "$ref": "#/1296" + }, + "flags": 0 + }, + "ScatterPlotUnaggregatedFieldWells": { + "type": { + "$ref": "#/1299" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ScatterPlotUnaggregatedFieldWells", + "properties": { + "Category": { + "type": { + "$ref": "#/1635" + }, + "flags": 0 + }, + "Label": { + "type": { + "$ref": "#/1636" + }, + "flags": 0 + }, + "Size": { + "type": { + "$ref": "#/1637" + }, + "flags": 0 + }, + "XAxis": { + "type": { + "$ref": "#/1638" + }, + "flags": 0 + }, + "YAxis": { + "type": { + "$ref": "#/1639" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ScatterPlotVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/1640" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/1297" + }, + "flags": 0 + }, + "ColumnHierarchies": { + "type": { + "$ref": "#/1641" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/1434" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/1435" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ScrollBarOptions", + "properties": { + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "VisibleRange": { + "type": { + "$ref": "#/1426" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SecondaryValueOptions", + "properties": { + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SectionAfterPageBreak", + "properties": { + "Status": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SectionBasedLayoutCanvasSizeOptions", + "properties": { + "PaperCanvasSizeOptions": { + "type": { + "$ref": "#/1306" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SectionBasedLayoutConfiguration", + "properties": { + "BodySections": { + "type": { + "$ref": "#/1642" + }, + "flags": 1 + }, + "CanvasSizeOptions": { + "type": { + "$ref": "#/1304" + }, + "flags": 1 + }, + "FooterSections": { + "type": { + "$ref": "#/1643" + }, + "flags": 1 + }, + "HeaderSections": { + "type": { + "$ref": "#/1644" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "SectionBasedLayoutPaperCanvasSizeOptions", + "properties": { + "PaperMargin": { + "type": { + "$ref": "#/1344" + }, + "flags": 0 + }, + "PaperOrientation": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "PaperSize": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SectionLayoutConfiguration", + "properties": { + "FreeFormLayout": { + "type": { + "$ref": "#/1070" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "SectionPageBreakConfiguration", + "properties": { + "After": { + "type": { + "$ref": "#/1303" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SectionPageBreakStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SectionStyle", + "properties": { + "Height": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "String based length that is composed of value and unit in px" + }, + "Padding": { + "type": { + "$ref": "#/1344" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SelectAllValueOptions", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SelectedFieldOptions", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SelectedSheetsFilterScopeConfiguration", + "properties": { + "SheetVisualScopingConfigurations": { + "type": { + "$ref": "#/1645" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SelectedTooltipType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SeriesItem", + "properties": { + "DataFieldSeriesItem": { + "type": { + "$ref": "#/959" + }, + "flags": 0 + }, + "FieldSeriesItem": { + "type": { + "$ref": "#/1023" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SetParameterValueConfiguration", + "properties": { + "DestinationParameterName": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/1007" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ShapeConditionalFormat", + "properties": { + "BackgroundColor": { + "type": { + "$ref": "#/920" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Sheet", + "properties": { + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The name of a sheet. This name is displayed on the sheet's tab in the Amazon QuickSight\n console.

" + }, + "SheetId": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The unique identifier associated with a sheet.

" + } + } + }, + { + "$type": "ObjectType", + "name": "SheetContentType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SheetControlDateTimePickerType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SheetControlInfoIconLabelOptions", + "properties": { + "InfoIconText": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SheetControlLayout", + "properties": { + "Configuration": { + "type": { + "$ref": "#/1323" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "SheetControlLayoutConfiguration", + "properties": { + "GridLayout": { + "type": { + "$ref": "#/1102" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SheetControlListType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SheetControlSliderType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SheetControlsOption", + "properties": { + "VisibilityState": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SheetDefinition", + "properties": { + "ContentType": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Description": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "FilterControls": { + "type": { + "$ref": "#/1646" + }, + "flags": 0 + }, + "Layouts": { + "type": { + "$ref": "#/1647" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ParameterControls": { + "type": { + "$ref": "#/1648" + }, + "flags": 0 + }, + "SheetControlLayouts": { + "type": { + "$ref": "#/1649" + }, + "flags": 0 + }, + "SheetId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "TextBoxes": { + "type": { + "$ref": "#/1650" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Visuals": { + "type": { + "$ref": "#/1651" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SheetElementConfigurationOverrides", + "properties": { + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SheetElementRenderingRule", + "properties": { + "ConfigurationOverrides": { + "type": { + "$ref": "#/1328" + }, + "flags": 1 + }, + "Expression": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "SheetLayoutElementMaximizationOption", + "properties": { + "AvailabilityStatus": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SheetTextBox", + "properties": { + "Content": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "SheetTextBoxId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "SheetVisualScopingConfiguration", + "properties": { + "Scope": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "SheetId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "VisualIds": { + "type": { + "$ref": "#/1652" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ShortFormatText", + "properties": { + "PlainText": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "RichText": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SimpleAttributeAggregationFunction", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SimpleClusterMarker", + "properties": { + "Color": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SimpleNumericalAggregationFunction", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SimpleTotalAggregationFunction", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SliderControlDisplayOptions", + "properties": { + "InfoIconLabelOptions": { + "type": { + "$ref": "#/1321" + }, + "flags": 0 + }, + "TitleOptions": { + "type": { + "$ref": "#/1143" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SmallMultiplesAxisPlacement", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SmallMultiplesAxisProperties", + "properties": { + "Placement": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Scale": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SmallMultiplesAxisScale", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SmallMultiplesOptions", + "properties": { + "MaxVisibleColumns": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "MaxVisibleRows": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "PanelConfiguration": { + "type": { + "$ref": "#/1202" + }, + "flags": 0 + }, + "XAxis": { + "type": { + "$ref": "#/1340" + }, + "flags": 0 + }, + "YAxis": { + "type": { + "$ref": "#/1340" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SortDirection", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Spacing", + "properties": { + "Bottom": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "String based length that is composed of value and unit" + }, + "Left": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "String based length that is composed of value and unit" + }, + "Right": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "String based length that is composed of value and unit" + }, + "Top": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "String based length that is composed of value and unit" + } + } + }, + { + "$type": "ObjectType", + "name": "SpecialValue", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "StringDefaultValues", + "properties": { + "DynamicValue": { + "type": { + "$ref": "#/1013" + }, + "flags": 0 + }, + "StaticValues": { + "type": { + "$ref": "#/1653" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "StringFormatConfiguration", + "properties": { + "NullValueFormatConfiguration": { + "type": { + "$ref": "#/1182" + }, + "flags": 0 + }, + "NumericFormatConfiguration": { + "type": { + "$ref": "#/1191" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "StringParameter", + "properties": { + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

A display name for a string parameter.

" + }, + "Values": { + "type": { + "$ref": "#/1654" + }, + "flags": 1, + "description": "

The values of a string parameter.

" + } + } + }, + { + "$type": "ObjectType", + "name": "StringParameterDeclaration", + "properties": { + "DefaultValues": { + "type": { + "$ref": "#/1346" + }, + "flags": 0 + }, + "MappedDataSetParameters": { + "type": { + "$ref": "#/1655" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "ParameterValueType": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "ValueWhenUnset": { + "type": { + "$ref": "#/1350" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "StringValueWhenUnsetConfiguration", + "properties": { + "CustomValue": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ValueWhenUnsetOption": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "StyledCellType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SubtotalOptions", + "properties": { + "CustomLabel": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "FieldLevel": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "FieldLevelOptions": { + "type": { + "$ref": "#/1656" + }, + "flags": 0 + }, + "MetricHeaderCellStyle": { + "type": { + "$ref": "#/1359" + }, + "flags": 0 + }, + "StyleTargets": { + "type": { + "$ref": "#/1657" + }, + "flags": 0 + }, + "TotalCellStyle": { + "type": { + "$ref": "#/1359" + }, + "flags": 0 + }, + "TotalsVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ValueCellStyle": { + "type": { + "$ref": "#/1359" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableAggregatedFieldWells", + "properties": { + "GroupBy": { + "type": { + "$ref": "#/1658" + }, + "flags": 0 + }, + "Values": { + "type": { + "$ref": "#/1659" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableBorderOptions", + "properties": { + "Color": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Style": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Thickness": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableBorderStyle", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TableCellConditionalFormatting", + "properties": { + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "TextFormat": { + "type": { + "$ref": "#/1389" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableCellImageScalingConfiguration", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TableCellImageSizingConfiguration", + "properties": { + "TableCellImageScalingConfiguration": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableCellStyle", + "properties": { + "BackgroundColor": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Border": { + "type": { + "$ref": "#/1098" + }, + "flags": 0 + }, + "FontConfiguration": { + "type": { + "$ref": "#/1053" + }, + "flags": 0 + }, + "Height": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "HorizontalTextAlignment": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "TextWrap": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "VerticalTextAlignment": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableConditionalFormatting", + "properties": { + "ConditionalFormattingOptions": { + "type": { + "$ref": "#/1660" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableConditionalFormattingOption", + "properties": { + "Cell": { + "type": { + "$ref": "#/1356" + }, + "flags": 0 + }, + "Row": { + "type": { + "$ref": "#/1378" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableConfiguration", + "properties": { + "FieldOptions": { + "type": { + "$ref": "#/1370" + }, + "flags": 0 + }, + "FieldWells": { + "type": { + "$ref": "#/1372" + }, + "flags": 0 + }, + "PaginatedReportOptions": { + "type": { + "$ref": "#/1376" + }, + "flags": 0 + }, + "SortConfiguration": { + "type": { + "$ref": "#/1380" + }, + "flags": 0 + }, + "TableInlineVisualizations": { + "type": { + "$ref": "#/1661" + }, + "flags": 0 + }, + "TableOptions": { + "type": { + "$ref": "#/1374" + }, + "flags": 0 + }, + "TotalOptions": { + "type": { + "$ref": "#/1411" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableFieldCustomIconContent", + "properties": { + "Icon": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableFieldCustomTextContent", + "properties": { + "FontConfiguration": { + "type": { + "$ref": "#/1053" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableFieldIconSetType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TableFieldImageConfiguration", + "properties": { + "SizingOptions": { + "type": { + "$ref": "#/1358" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableFieldLinkConfiguration", + "properties": { + "Content": { + "type": { + "$ref": "#/1368" + }, + "flags": 1 + }, + "Target": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TableFieldLinkContentConfiguration", + "properties": { + "CustomIconContent": { + "type": { + "$ref": "#/1363" + }, + "flags": 0 + }, + "CustomTextContent": { + "type": { + "$ref": "#/1364" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableFieldOption", + "properties": { + "CustomLabel": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "URLStyling": { + "type": { + "$ref": "#/1371" + }, + "flags": 0 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Width": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "String based length that is composed of value and unit in px" + } + } + }, + { + "$type": "ObjectType", + "name": "TableFieldOptions", + "properties": { + "Order": { + "type": { + "$ref": "#/1662" + }, + "flags": 0 + }, + "PinnedFieldOptions": { + "type": { + "$ref": "#/1377" + }, + "flags": 0 + }, + "SelectedFieldOptions": { + "type": { + "$ref": "#/1663" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableFieldURLConfiguration", + "properties": { + "ImageConfiguration": { + "type": { + "$ref": "#/1366" + }, + "flags": 0 + }, + "LinkConfiguration": { + "type": { + "$ref": "#/1367" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableFieldWells", + "properties": { + "TableAggregatedFieldWells": { + "type": { + "$ref": "#/1353" + }, + "flags": 0 + }, + "TableUnaggregatedFieldWells": { + "type": { + "$ref": "#/1384" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableInlineVisualization", + "properties": { + "DataBars": { + "type": { + "$ref": "#/957" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableOptions", + "properties": { + "CellStyle": { + "type": { + "$ref": "#/1359" + }, + "flags": 0 + }, + "HeaderStyle": { + "type": { + "$ref": "#/1359" + }, + "flags": 0 + }, + "Orientation": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "RowAlternateColorOptions": { + "type": { + "$ref": "#/1289" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableOrientation", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TablePaginatedReportOptions", + "properties": { + "OverflowColumnHeaderVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "VerticalOverflowVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TablePinnedFieldOptions", + "properties": { + "PinnedLeftFields": { + "type": { + "$ref": "#/1664" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableRowConditionalFormatting", + "properties": { + "BackgroundColor": { + "type": { + "$ref": "#/920" + }, + "flags": 0 + }, + "TextColor": { + "type": { + "$ref": "#/920" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableSideBorderOptions", + "properties": { + "Bottom": { + "type": { + "$ref": "#/1354" + }, + "flags": 0 + }, + "InnerHorizontal": { + "type": { + "$ref": "#/1354" + }, + "flags": 0 + }, + "InnerVertical": { + "type": { + "$ref": "#/1354" + }, + "flags": 0 + }, + "Left": { + "type": { + "$ref": "#/1354" + }, + "flags": 0 + }, + "Right": { + "type": { + "$ref": "#/1354" + }, + "flags": 0 + }, + "Top": { + "type": { + "$ref": "#/1354" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableSortConfiguration", + "properties": { + "PaginationConfiguration": { + "type": { + "$ref": "#/1200" + }, + "flags": 0 + }, + "RowSort": { + "type": { + "$ref": "#/1665" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableStyleTarget", + "properties": { + "CellType": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TableTotalsPlacement", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TableTotalsScrollStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TableUnaggregatedFieldWells", + "properties": { + "Values": { + "type": { + "$ref": "#/1666" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/1667" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/1362" + }, + "flags": 0 + }, + "ConditionalFormatting": { + "type": { + "$ref": "#/1360" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/1434" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/1435" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

Tag key.

" + }, + "Value": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

Tag value.

" + } + } + }, + { + "$type": "ObjectType", + "name": "TargetVisualOptions", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TextAreaControlDisplayOptions", + "properties": { + "InfoIconLabelOptions": { + "type": { + "$ref": "#/1321" + }, + "flags": 0 + }, + "PlaceholderOptions": { + "type": { + "$ref": "#/1390" + }, + "flags": 0 + }, + "TitleOptions": { + "type": { + "$ref": "#/1143" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TextConditionalFormat", + "properties": { + "BackgroundColor": { + "type": { + "$ref": "#/920" + }, + "flags": 0 + }, + "Icon": { + "type": { + "$ref": "#/924" + }, + "flags": 0 + }, + "TextColor": { + "type": { + "$ref": "#/920" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TextControlPlaceholderOptions", + "properties": { + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TextFieldControlDisplayOptions", + "properties": { + "InfoIconLabelOptions": { + "type": { + "$ref": "#/1321" + }, + "flags": 0 + }, + "PlaceholderOptions": { + "type": { + "$ref": "#/1390" + }, + "flags": 0 + }, + "TitleOptions": { + "type": { + "$ref": "#/1143" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TextWrap", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ThousandSeparatorOptions", + "properties": { + "Symbol": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TimeBasedForecastProperties", + "properties": { + "LowerBoundary": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "PeriodsBackward": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "PeriodsForward": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "PredictionInterval": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "Seasonality": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "UpperBoundary": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TimeEqualityFilter", + "properties": { + "Column": { + "type": { + "$ref": "#/907" + }, + "flags": 1 + }, + "DefaultFilterControlConfiguration": { + "type": { + "$ref": "#/993" + }, + "flags": 0 + }, + "FilterId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "ParameterName": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "RollingDate": { + "type": { + "$ref": "#/1288" + }, + "flags": 0 + }, + "TimeGranularity": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TimeGranularity", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TimeRangeDrillDownFilter", + "properties": { + "Column": { + "type": { + "$ref": "#/907" + }, + "flags": 1 + }, + "RangeMaximum": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "RangeMinimum": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "TimeGranularity": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TimeRangeFilter", + "properties": { + "Column": { + "type": { + "$ref": "#/907" + }, + "flags": 1 + }, + "DefaultFilterControlConfiguration": { + "type": { + "$ref": "#/993" + }, + "flags": 0 + }, + "ExcludePeriodConfiguration": { + "type": { + "$ref": "#/1016" + }, + "flags": 0 + }, + "FilterId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "IncludeMaximum": { + "type": { + "$ref": "#/650" + }, + "flags": 0 + }, + "IncludeMinimum": { + "type": { + "$ref": "#/650" + }, + "flags": 0 + }, + "NullOption": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "RangeMaximumValue": { + "type": { + "$ref": "#/1399" + }, + "flags": 0 + }, + "RangeMinimumValue": { + "type": { + "$ref": "#/1399" + }, + "flags": 0 + }, + "TimeGranularity": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TimeRangeFilterValue", + "properties": { + "Parameter": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "RollingDate": { + "type": { + "$ref": "#/1288" + }, + "flags": 0 + }, + "StaticValue": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TooltipItem", + "properties": { + "ColumnTooltipItem": { + "type": { + "$ref": "#/910" + }, + "flags": 0 + }, + "FieldTooltipItem": { + "type": { + "$ref": "#/1026" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TooltipOptions", + "properties": { + "FieldBasedTooltip": { + "type": { + "$ref": "#/1021" + }, + "flags": 0 + }, + "SelectedTooltipType": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "TooltipVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TooltipTitleType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TopBottomComputationType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TopBottomFilter", + "properties": { + "AggregationSortConfigurations": { + "type": { + "$ref": "#/1668" + }, + "flags": 1 + }, + "Column": { + "type": { + "$ref": "#/907" + }, + "flags": 1 + }, + "DefaultFilterControlConfiguration": { + "type": { + "$ref": "#/993" + }, + "flags": 0 + }, + "FilterId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Limit": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "ParameterName": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "TimeGranularity": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TopBottomMoversComputation", + "properties": { + "Category": { + "type": { + "$ref": "#/1008" + }, + "flags": 0 + }, + "ComputationId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "MoverSize": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "SortOrder": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Time": { + "type": { + "$ref": "#/1008" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/1175" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TopBottomRankedComputation", + "properties": { + "Category": { + "type": { + "$ref": "#/1008" + }, + "flags": 0 + }, + "ComputationId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ResultSize": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/1175" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TopBottomSortOrder", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TotalAggregationComputation", + "properties": { + "ComputationId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/1175" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TotalAggregationFunction", + "properties": { + "SimpleTotalAggregationFunction": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TotalAggregationOption", + "properties": { + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "TotalAggregationFunction": { + "type": { + "$ref": "#/1409" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TotalOptions", + "properties": { + "CustomLabel": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Placement": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ScrollStatus": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "TotalAggregationOptions": { + "type": { + "$ref": "#/1669" + }, + "flags": 0 + }, + "TotalCellStyle": { + "type": { + "$ref": "#/1359" + }, + "flags": 0 + }, + "TotalsVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TreeMapAggregatedFieldWells", + "properties": { + "Colors": { + "type": { + "$ref": "#/1670" + }, + "flags": 0 + }, + "Groups": { + "type": { + "$ref": "#/1671" + }, + "flags": 0 + }, + "Sizes": { + "type": { + "$ref": "#/1672" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TreeMapConfiguration", + "properties": { + "ColorLabelOptions": { + "type": { + "$ref": "#/899" + }, + "flags": 0 + }, + "ColorScale": { + "type": { + "$ref": "#/903" + }, + "flags": 0 + }, + "DataLabels": { + "type": { + "$ref": "#/961" + }, + "flags": 0 + }, + "FieldWells": { + "type": { + "$ref": "#/1414" + }, + "flags": 0 + }, + "GroupLabelOptions": { + "type": { + "$ref": "#/899" + }, + "flags": 0 + }, + "Legend": { + "type": { + "$ref": "#/1147" + }, + "flags": 0 + }, + "SizeLabelOptions": { + "type": { + "$ref": "#/899" + }, + "flags": 0 + }, + "SortConfiguration": { + "type": { + "$ref": "#/1415" + }, + "flags": 0 + }, + "Tooltip": { + "type": { + "$ref": "#/1401" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TreeMapFieldWells", + "properties": { + "TreeMapAggregatedFieldWells": { + "type": { + "$ref": "#/1412" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TreeMapSortConfiguration", + "properties": { + "TreeMapGroupItemsLimitConfiguration": { + "type": { + "$ref": "#/1126" + }, + "flags": 0 + }, + "TreeMapSort": { + "type": { + "$ref": "#/1673" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TreeMapVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/1674" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/1413" + }, + "flags": 0 + }, + "ColumnHierarchies": { + "type": { + "$ref": "#/1675" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/1434" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/1435" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TrendArrowOptions", + "properties": { + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "URLTargetConfiguration", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "UnaggregatedField", + "properties": { + "Column": { + "type": { + "$ref": "#/907" + }, + "flags": 1 + }, + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "FormatConfiguration": { + "type": { + "$ref": "#/1063" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "UniqueValuesComputation", + "properties": { + "Category": { + "type": { + "$ref": "#/1008" + }, + "flags": 0 + }, + "ComputationId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ValidationStrategy", + "properties": { + "Mode": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ValidationStrategyMode", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ValueWhenUnsetOption", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "VerticalTextAlignment", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Visibility", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "VisibleRangeOptions", + "properties": { + "PercentRange": { + "type": { + "$ref": "#/1217" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Visual", + "properties": { + "BarChartVisual": { + "type": { + "$ref": "#/872" + }, + "flags": 0 + }, + "BoxPlotVisual": { + "type": { + "$ref": "#/886" + }, + "flags": 0 + }, + "ComboChartVisual": { + "type": { + "$ref": "#/915" + }, + "flags": 0 + }, + "CustomContentVisual": { + "type": { + "$ref": "#/941" + }, + "flags": 0 + }, + "EmptyVisual": { + "type": { + "$ref": "#/1014" + }, + "flags": 0 + }, + "FilledMapVisual": { + "type": { + "$ref": "#/1034" + }, + "flags": 0 + }, + "FunnelChartVisual": { + "type": { + "$ref": "#/1077" + }, + "flags": 0 + }, + "GaugeChartVisual": { + "type": { + "$ref": "#/1085" + }, + "flags": 0 + }, + "GeospatialMapVisual": { + "type": { + "$ref": "#/1094" + }, + "flags": 0 + }, + "HeatMapVisual": { + "type": { + "$ref": "#/1111" + }, + "flags": 0 + }, + "HistogramVisual": { + "type": { + "$ref": "#/1117" + }, + "flags": 0 + }, + "InsightVisual": { + "type": { + "$ref": "#/1121" + }, + "flags": 0 + }, + "KPIVisual": { + "type": { + "$ref": "#/1139" + }, + "flags": 0 + }, + "LineChartVisual": { + "type": { + "$ref": "#/1160" + }, + "flags": 0 + }, + "PieChartVisual": { + "type": { + "$ref": "#/1226" + }, + "flags": 0 + }, + "PivotTableVisual": { + "type": { + "$ref": "#/1253" + }, + "flags": 0 + }, + "RadarChartVisual": { + "type": { + "$ref": "#/1266" + }, + "flags": 0 + }, + "SankeyDiagramVisual": { + "type": { + "$ref": "#/1295" + }, + "flags": 0 + }, + "ScatterPlotVisual": { + "type": { + "$ref": "#/1300" + }, + "flags": 0 + }, + "TableVisual": { + "type": { + "$ref": "#/1385" + }, + "flags": 0 + }, + "TreeMapVisual": { + "type": { + "$ref": "#/1416" + }, + "flags": 0 + }, + "WaterfallVisual": { + "type": { + "$ref": "#/1443" + }, + "flags": 0 + }, + "WordCloudVisual": { + "type": { + "$ref": "#/1453" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "VisualAxisSortOption", + "properties": { + "AvailabilityStatus": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "VisualCustomAction", + "properties": { + "ActionOperations": { + "type": { + "$ref": "#/1676" + }, + "flags": 1 + }, + "CustomActionId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Status": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Trigger": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "VisualCustomActionOperation", + "properties": { + "FilterOperation": { + "type": { + "$ref": "#/933" + }, + "flags": 0 + }, + "NavigationOperation": { + "type": { + "$ref": "#/934" + }, + "flags": 0 + }, + "SetParametersOperation": { + "type": { + "$ref": "#/935" + }, + "flags": 0 + }, + "URLOperation": { + "type": { + "$ref": "#/936" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "VisualCustomActionTrigger", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "VisualMenuOption", + "properties": { + "AvailabilityStatus": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "VisualPalette", + "properties": { + "ChartColor": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ColorMap": { + "type": { + "$ref": "#/1677" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "VisualSubtitleLabelOptions", + "properties": { + "FormatText": { + "type": { + "$ref": "#/1169" + }, + "flags": 0 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "VisualTitleLabelOptions", + "properties": { + "FormatText": { + "type": { + "$ref": "#/1333" + }, + "flags": 0 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "WaterfallChartAggregatedFieldWells", + "properties": { + "Breakdowns": { + "type": { + "$ref": "#/1678" + }, + "flags": 0 + }, + "Categories": { + "type": { + "$ref": "#/1679" + }, + "flags": 0 + }, + "Values": { + "type": { + "$ref": "#/1680" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "WaterfallChartColorConfiguration", + "properties": { + "GroupColorConfiguration": { + "type": { + "$ref": "#/1440" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "WaterfallChartConfiguration", + "properties": { + "CategoryAxisDisplayOptions": { + "type": { + "$ref": "#/859" + }, + "flags": 0 + }, + "CategoryAxisLabelOptions": { + "type": { + "$ref": "#/899" + }, + "flags": 0 + }, + "ColorConfiguration": { + "type": { + "$ref": "#/1437" + }, + "flags": 0 + }, + "DataLabels": { + "type": { + "$ref": "#/961" + }, + "flags": 0 + }, + "FieldWells": { + "type": { + "$ref": "#/1439" + }, + "flags": 0 + }, + "Legend": { + "type": { + "$ref": "#/1147" + }, + "flags": 0 + }, + "PrimaryYAxisDisplayOptions": { + "type": { + "$ref": "#/859" + }, + "flags": 0 + }, + "PrimaryYAxisLabelOptions": { + "type": { + "$ref": "#/899" + }, + "flags": 0 + }, + "SortConfiguration": { + "type": { + "$ref": "#/1442" + }, + "flags": 0 + }, + "VisualPalette": { + "type": { + "$ref": "#/1433" + }, + "flags": 0 + }, + "WaterfallChartOptions": { + "type": { + "$ref": "#/1441" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "WaterfallChartFieldWells", + "properties": { + "WaterfallChartAggregatedFieldWells": { + "type": { + "$ref": "#/1436" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "WaterfallChartGroupColorConfiguration", + "properties": { + "NegativeBarColor": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "PositiveBarColor": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "TotalBarColor": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "WaterfallChartOptions", + "properties": { + "TotalBarLabel": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "WaterfallChartSortConfiguration", + "properties": { + "BreakdownItemsLimit": { + "type": { + "$ref": "#/1126" + }, + "flags": 0 + }, + "CategorySort": { + "type": { + "$ref": "#/1681" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "WaterfallVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/1682" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/1438" + }, + "flags": 0 + }, + "ColumnHierarchies": { + "type": { + "$ref": "#/1683" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/1434" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/1435" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "WhatIfPointScenario", + "properties": { + "Date": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "WhatIfRangeScenario", + "properties": { + "EndDate": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "StartDate": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "WidgetStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "WordCloudAggregatedFieldWells", + "properties": { + "GroupBy": { + "type": { + "$ref": "#/1684" + }, + "flags": 0 + }, + "Size": { + "type": { + "$ref": "#/1685" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "WordCloudChartConfiguration", + "properties": { + "CategoryLabelOptions": { + "type": { + "$ref": "#/899" + }, + "flags": 0 + }, + "FieldWells": { + "type": { + "$ref": "#/1450" + }, + "flags": 0 + }, + "SortConfiguration": { + "type": { + "$ref": "#/1452" + }, + "flags": 0 + }, + "WordCloudOptions": { + "type": { + "$ref": "#/1451" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "WordCloudCloudLayout", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "WordCloudFieldWells", + "properties": { + "WordCloudAggregatedFieldWells": { + "type": { + "$ref": "#/1447" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "WordCloudOptions", + "properties": { + "CloudLayout": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "MaximumStringLength": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "WordCasing": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "WordOrientation": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "WordPadding": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "WordScaling": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "WordCloudSortConfiguration", + "properties": { + "CategoryItemsLimit": { + "type": { + "$ref": "#/1126" + }, + "flags": 0 + }, + "CategorySort": { + "type": { + "$ref": "#/1686" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "WordCloudVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/1687" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/1448" + }, + "flags": 0 + }, + "ColumnHierarchies": { + "type": { + "$ref": "#/1688" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/1434" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/1435" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "WordCloudWordCasing", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "WordCloudWordOrientation", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "WordCloudWordPadding", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "WordCloudWordScaling", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1008" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1008" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1008" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1175" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/930" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1268" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1025" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1025" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1025" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1429" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/906" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1008" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1175" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1268" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1025" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1429" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/906" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/890" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/861" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/958" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/937" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1175" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1008" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1008" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1175" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1268" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1025" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1025" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1429" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/906" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/907" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1316" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1429" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/610" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/610" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1015" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/974" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/948" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1318" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/887" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/905" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/973" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1040" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1208" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1327" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/964" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/969" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1011" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1171" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/610" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/610" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1171" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1429" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/907" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1011" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1400" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1008" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1175" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1029" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1025" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1429" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/906" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1035" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/907" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1066" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1329" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1066" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1008" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1175" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1025" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1429" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/906" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1080" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1175" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1175" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1429" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1089" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1008" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1008" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1175" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1429" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/906" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1100" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1103" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1008" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1008" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1175" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1025" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1025" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1429" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/906" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1175" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1429" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/919" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1429" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/610" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/610" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1171" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1130" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1175" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1008" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1175" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1025" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1429" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/906" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1008" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1008" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1008" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1175" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/930" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1061" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1268" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1315" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1025" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1025" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1429" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/906" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1178" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1286" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/982" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/988" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1123" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1348" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1008" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1008" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1175" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/930" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1025" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1025" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1429" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/906" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1008" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1008" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1175" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1232" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1231" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/969" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/969" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1238" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1235" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1240" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1227" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1429" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1410" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/907" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1011" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1008" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1008" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1175" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1025" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1025" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1429" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/906" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1008" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1008" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1175" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1025" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1429" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1008" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1008" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1175" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1175" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1175" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1008" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1008" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1175" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1008" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1008" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1429" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/906" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/877" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1106" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1106" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1332" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1036" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1144" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1206" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1322" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1331" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1427" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1171" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1242" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1381" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1008" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1175" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1361" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1373" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1369" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1025" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1419" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1429" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/842" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1410" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1175" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1008" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1175" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1025" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1429" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/906" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1430" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/965" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1008" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1008" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1175" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1025" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1429" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/906" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1008" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1175" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1025" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1429" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/906" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.QuickSight/DashboardProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1286" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1386" + } + }, + { + "$type": "ObjectType", + "name": "AWS.QuickSight/DashboardProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/601" + }, + "flags": 2, + "description": "

The Amazon Resource Name (ARN) of the resource.

" + }, + "AwsAccountId": { + "type": { + "$ref": "#/601" + }, + "flags": 17 + }, + "CreatedTime": { + "type": { + "$ref": "#/601" + }, + "flags": 2, + "description": "

The time that this dashboard was created.

" + }, + "DashboardId": { + "type": { + "$ref": "#/601" + }, + "flags": 17 + }, + "DashboardPublishOptions": { + "type": { + "$ref": "#/950" + }, + "flags": 4 + }, + "Definition": { + "type": { + "$ref": "#/955" + }, + "flags": 4 + }, + "LastPublishedTime": { + "type": { + "$ref": "#/601" + }, + "flags": 2, + "description": "

The last time that this dashboard was published.

" + }, + "LastUpdatedTime": { + "type": { + "$ref": "#/601" + }, + "flags": 2, + "description": "

The last time that this dashboard was updated.

" + }, + "LinkEntities": { + "type": { + "$ref": "#/1690" + }, + "flags": 0 + }, + "LinkSharingConfiguration": { + "type": { + "$ref": "#/1163" + }, + "flags": 4 + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Parameters": { + "type": { + "$ref": "#/1216" + }, + "flags": 4 + }, + "Permissions": { + "type": { + "$ref": "#/1691" + }, + "flags": 0 + }, + "SourceEntity": { + "type": { + "$ref": "#/951" + }, + "flags": 4 + }, + "Tags": { + "type": { + "$ref": "#/1692" + }, + "flags": 0 + }, + "ThemeArn": { + "type": { + "$ref": "#/601" + }, + "flags": 4 + }, + "ValidationStrategy": { + "type": { + "$ref": "#/1421" + }, + "flags": 4 + }, + "Version": { + "type": { + "$ref": "#/954" + }, + "flags": 2 + }, + "VersionDescription": { + "type": { + "$ref": "#/601" + }, + "flags": 4 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.QuickSight/Dashboard", + "properties": { + "name": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/601" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/1693" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.QuickSight/Dashboard@default", + "scopeType": 0, + "body": { + "$ref": "#/1694" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "CalculatedColumn", + "properties": { + "ColumnId": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

A unique ID to identify a calculated column. During a dataset update, if the column ID\n of a calculated column matches that of an existing calculated column, Amazon QuickSight\n preserves the existing calculated column.

" + }, + "ColumnName": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

Column name.

" + }, + "Expression": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

An expression that defines the calculated column.

" + } + } + }, + { + "$type": "ObjectType", + "name": "CastColumnTypeOperation", + "properties": { + "ColumnName": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

Column name.

" + }, + "Format": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

When casting a column from string to datetime type, you can supply a string in a\n format supported by Amazon QuickSight to denote the source data format.

" + }, + "NewColumnType": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "SubType": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ColumnDataSubType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ColumnDataType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ColumnDescription", + "properties": { + "Text": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The text of a description for a column.

" + } + } + }, + { + "$type": "ObjectType", + "name": "ColumnGroup", + "properties": { + "GeoSpatialColumnGroup": { + "type": { + "$ref": "#/1720" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ColumnLevelPermissionRule", + "properties": { + "ColumnNames": { + "type": { + "$ref": "#/1763" + }, + "flags": 0, + "description": "

An array of column names.

" + }, + "Principals": { + "type": { + "$ref": "#/1764" + }, + "flags": 0, + "description": "

An array of Amazon Resource Names (ARNs) for Amazon QuickSight users or groups.

" + } + } + }, + { + "$type": "ObjectType", + "name": "ColumnTag", + "properties": { + "ColumnDescription": { + "type": { + "$ref": "#/1700" + }, + "flags": 0 + }, + "ColumnGeographicRole": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ColumnTagName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CreateColumnsOperation", + "properties": { + "Columns": { + "type": { + "$ref": "#/1765" + }, + "flags": 1, + "description": "

Calculated columns to create.

" + } + } + }, + { + "$type": "ObjectType", + "name": "CustomSql", + "properties": { + "Columns": { + "type": { + "$ref": "#/1766" + }, + "flags": 1, + "description": "

The column schema from the SQL query result set.

" + }, + "DataSourceArn": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

The Amazon Resource Name (ARN) of the data source.

" + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

A display name for the SQL query result.

" + }, + "SqlQuery": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

The SQL query.

" + } + } + }, + { + "$type": "ObjectType", + "name": "DataSetImportMode", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DataSetRefreshProperties", + "properties": { + "RefreshConfiguration": { + "type": { + "$ref": "#/1743" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DataSetUsageConfiguration", + "properties": { + "DisableUseAsDirectQuerySource": { + "type": { + "$ref": "#/650" + }, + "flags": 0, + "description": "

An option that controls whether a child dataset of a direct query can use this dataset as a source.

" + }, + "DisableUseAsImportedSource": { + "type": { + "$ref": "#/650" + }, + "flags": 0, + "description": "

An option that controls whether a child dataset that's stored in QuickSight can use this dataset as a source.

" + } + } + }, + { + "$type": "ObjectType", + "name": "DatasetParameter", + "properties": { + "DateTimeDatasetParameter": { + "type": { + "$ref": "#/1712" + }, + "flags": 0 + }, + "DecimalDatasetParameter": { + "type": { + "$ref": "#/1714" + }, + "flags": 0 + }, + "IntegerDatasetParameter": { + "type": { + "$ref": "#/1727" + }, + "flags": 0 + }, + "StringDatasetParameter": { + "type": { + "$ref": "#/1754" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DatasetParameterValueType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DateTimeDatasetParameter", + "properties": { + "DefaultValues": { + "type": { + "$ref": "#/1713" + }, + "flags": 0 + }, + "Id": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

An identifier for the parameter that is created in the dataset.

" + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

The name of the date time parameter that is created in the dataset.

" + }, + "TimeGranularity": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ValueType": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DateTimeDatasetParameterDefaultValues", + "properties": { + "StaticValues": { + "type": { + "$ref": "#/1767" + }, + "flags": 0, + "description": "

A list of static default values for a given date time parameter.

" + } + } + }, + { + "$type": "ObjectType", + "name": "DecimalDatasetParameter", + "properties": { + "DefaultValues": { + "type": { + "$ref": "#/1715" + }, + "flags": 0 + }, + "Id": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

An identifier for the decimal parameter created in the dataset.

" + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

The name of the decimal parameter that is created in the dataset.

" + }, + "ValueType": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DecimalDatasetParameterDefaultValues", + "properties": { + "StaticValues": { + "type": { + "$ref": "#/1768" + }, + "flags": 0, + "description": "

A list of static default values for a given decimal parameter.

" + } + } + }, + { + "$type": "ObjectType", + "name": "FieldFolder", + "properties": { + "Columns": { + "type": { + "$ref": "#/1769" + }, + "flags": 0, + "description": "

A folder has a list of columns. A column can only be in one folder.

" + }, + "Description": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The description for a field folder.

" + } + } + }, + { + "$type": "ObjectType", + "name": "FieldFolderMap", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "FileFormat", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "FilterOperation", + "properties": { + "ConditionExpression": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

An expression that must evaluate to a Boolean value. Rows for which the expression\n evaluates to true are kept in the dataset.

" + } + } + }, + { + "$type": "ObjectType", + "name": "GeoSpatialColumnGroup", + "properties": { + "Columns": { + "type": { + "$ref": "#/1770" + }, + "flags": 1, + "description": "

Columns in this hierarchy.

" + }, + "CountryCode": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

A display name for the hierarchy.

" + } + } + }, + { + "$type": "ObjectType", + "name": "GeoSpatialCountryCode", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "GeoSpatialDataRole", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "IncrementalRefresh", + "properties": { + "LookbackWindow": { + "type": { + "$ref": "#/1735" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "IngestionWaitPolicy", + "properties": { + "IngestionWaitTimeInHours": { + "type": { + "$ref": "#/610" + }, + "flags": 0, + "description": "

The maximum time (in hours) to wait for Ingestion to complete. Default timeout is 36 hours.\n Applicable only when DataSetImportMode mode is set to SPICE and WaitForSpiceIngestion is set to true.

" + }, + "WaitForSpiceIngestion": { + "type": { + "$ref": "#/650" + }, + "flags": 0, + "description": "

Wait for SPICE ingestion to finish to mark dataset creation/update successful. Default (true).\n Applicable only when DataSetImportMode mode is set to SPICE.

" + } + } + }, + { + "$type": "ObjectType", + "name": "InputColumn", + "properties": { + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

The name of this column in the underlying data source.

" + }, + "SubType": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "InputColumnDataType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "IntegerDatasetParameter", + "properties": { + "DefaultValues": { + "type": { + "$ref": "#/1728" + }, + "flags": 0 + }, + "Id": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

An identifier for the integer parameter created in the dataset.

" + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

The name of the integer parameter that is created in the dataset.

" + }, + "ValueType": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "IntegerDatasetParameterDefaultValues", + "properties": { + "StaticValues": { + "type": { + "$ref": "#/1771" + }, + "flags": 0, + "description": "

A list of static default values for a given integer parameter.

" + } + } + }, + { + "$type": "ObjectType", + "name": "JoinInstruction", + "properties": { + "LeftJoinKeyProperties": { + "type": { + "$ref": "#/1730" + }, + "flags": 0 + }, + "LeftOperand": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

The operand on the left side of a join.

" + }, + "OnClause": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

The join instructions provided in the ON clause of a join.

" + }, + "RightJoinKeyProperties": { + "type": { + "$ref": "#/1730" + }, + "flags": 0 + }, + "RightOperand": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

The operand on the right side of a join.

" + }, + "Type": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "JoinKeyProperties", + "properties": { + "UniqueKey": { + "type": { + "$ref": "#/650" + }, + "flags": 0, + "description": "

A value that indicates that a row in a table is uniquely identified by the columns in\n a join key. This is used by Amazon QuickSight to optimize query performance.

" + } + } + }, + { + "$type": "ObjectType", + "name": "JoinType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LogicalTable", + "properties": { + "Alias": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

A display name for the logical table.

" + }, + "DataTransforms": { + "type": { + "$ref": "#/1772" + }, + "flags": 0, + "description": "

Transform operations that act on this logical table. For this structure to be valid, only one of the attributes can be non-null.

" + }, + "Source": { + "type": { + "$ref": "#/1734" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "LogicalTableMap", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LogicalTableSource", + "properties": { + "DataSetArn": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The Amazon Resource Number (ARN) of the parent dataset.

" + }, + "JoinInstruction": { + "type": { + "$ref": "#/1729" + }, + "flags": 0 + }, + "PhysicalTableId": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

Physical table ID.

" + } + } + }, + { + "$type": "ObjectType", + "name": "LookbackWindow", + "properties": { + "ColumnName": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

The name of the lookback window column.

" + }, + "Size": { + "type": { + "$ref": "#/610" + }, + "flags": 1, + "description": "

The lookback window column size.

" + }, + "SizeUnit": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "LookbackWindowSizeUnit", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "NewDefaultValues", + "properties": { + "DateTimeStaticValues": { + "type": { + "$ref": "#/1773" + }, + "flags": 0, + "description": "

A list of static default values for a given date time parameter.

" + }, + "DecimalStaticValues": { + "type": { + "$ref": "#/1774" + }, + "flags": 0, + "description": "

A list of static default values for a given decimal parameter.

" + }, + "IntegerStaticValues": { + "type": { + "$ref": "#/1775" + }, + "flags": 0, + "description": "

A list of static default values for a given integer parameter.

" + }, + "StringStaticValues": { + "type": { + "$ref": "#/1776" + }, + "flags": 0, + "description": "

A list of static default values for a given string parameter.

" + } + } + }, + { + "$type": "ObjectType", + "name": "OutputColumn", + "properties": { + "Description": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

A description for a column.

" + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The display name of the column..

" + }, + "SubType": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "OverrideDatasetParameterOperation", + "properties": { + "NewDefaultValues": { + "type": { + "$ref": "#/1737" + }, + "flags": 0 + }, + "NewParameterName": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The new name for the parameter.

" + }, + "ParameterName": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

The name of the parameter to be overridden with different values.

" + } + } + }, + { + "$type": "ObjectType", + "name": "PhysicalTable", + "properties": { + "CustomSql": { + "type": { + "$ref": "#/1706" + }, + "flags": 0 + }, + "RelationalTable": { + "type": { + "$ref": "#/1744" + }, + "flags": 0 + }, + "S3Source": { + "type": { + "$ref": "#/1752" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PhysicalTableMap", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ProjectOperation", + "properties": { + "ProjectedColumns": { + "type": { + "$ref": "#/1777" + }, + "flags": 1, + "description": "

Projected columns.

" + } + } + }, + { + "$type": "ObjectType", + "name": "RefreshConfiguration", + "properties": { + "IncrementalRefresh": { + "type": { + "$ref": "#/1723" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "RelationalTable", + "properties": { + "Catalog": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The catalog associated with a table.

" + }, + "DataSourceArn": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

The Amazon Resource Name (ARN) for the data source.

" + }, + "InputColumns": { + "type": { + "$ref": "#/1778" + }, + "flags": 1, + "description": "

The column schema of the table.

" + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

The name of the relational table.

" + }, + "Schema": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The schema name. This name applies to certain relational database engines.

" + } + } + }, + { + "$type": "ObjectType", + "name": "RenameColumnOperation", + "properties": { + "ColumnName": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

The name of the column to be renamed.

" + }, + "NewColumnName": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

The new name for the column.

" + } + } + }, + { + "$type": "ObjectType", + "name": "ResourcePermission", + "properties": { + "Actions": { + "type": { + "$ref": "#/1779" + }, + "flags": 1, + "description": "

The IAM action to grant or revoke permissions on.

" + }, + "Principal": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

The Amazon Resource Name (ARN) of the principal. This can be one of the\n following:

\n
    \n
  • \n

    The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

    \n
    • \n
  • \n

    The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)

    \n
    • \n
  • \n

    The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight\n ARN. Use this option only to share resources (templates) across Amazon Web Services accounts.\n (This is less common.)

    \n
    • \n
" + } + } + }, + { + "$type": "ObjectType", + "name": "RowLevelPermissionDataSet", + "properties": { + "Arn": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.

" + }, + "FormatVersion": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Namespace": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The namespace associated with the dataset that contains permissions for RLS.

" + }, + "PermissionPolicy": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Status": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "RowLevelPermissionFormatVersion", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RowLevelPermissionPolicy", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RowLevelPermissionTagConfiguration", + "properties": { + "Status": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "TagRuleConfigurations": { + "type": { + "$ref": "#/1781" + }, + "flags": 0, + "description": "

A list of tag configuration rules to apply to a dataset. All tag configurations have the OR condition. Tags within each tile will be joined (AND). At least one rule in this structure must have all tag values assigned to it to apply Row-level security (RLS) to the dataset.

" + }, + "TagRules": { + "type": { + "$ref": "#/1782" + }, + "flags": 1, + "description": "

A set of rules associated with row-level security, such as the tag names and columns that they are assigned to.

" + } + } + }, + { + "$type": "ObjectType", + "name": "RowLevelPermissionTagRule", + "properties": { + "ColumnName": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

The column name that a tag key is assigned to.

" + }, + "MatchAllValue": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

A string that you want to use to filter by all the values in a column in the dataset and don?t want to list the values one by one. For example, you can use an asterisk as your match all value.

" + }, + "TagKey": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

The unique key for a tag.

" + }, + "TagMultiValueDelimiter": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

A 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.

" + } + } + }, + { + "$type": "ObjectType", + "name": "S3Source", + "properties": { + "DataSourceArn": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

The Amazon Resource Name (ARN) for the data source.

" + }, + "InputColumns": { + "type": { + "$ref": "#/1783" + }, + "flags": 1, + "description": "

A physical table type for an S3 data source.

\n \n

For files that aren't JSON, only STRING data types are supported in input columns.

\n " + }, + "UploadSettings": { + "type": { + "$ref": "#/1762" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Status", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "StringDatasetParameter", + "properties": { + "DefaultValues": { + "type": { + "$ref": "#/1755" + }, + "flags": 0 + }, + "Id": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

An identifier for the string parameter that is created in the dataset.

" + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

The name of the string parameter that is created in the dataset.

" + }, + "ValueType": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "StringDatasetParameterDefaultValues", + "properties": { + "StaticValues": { + "type": { + "$ref": "#/1784" + }, + "flags": 0, + "description": "

A list of static default values for a given string parameter.

" + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

Tag key.

" + }, + "Value": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

Tag value.

" + } + } + }, + { + "$type": "ObjectType", + "name": "TagColumnOperation", + "properties": { + "ColumnName": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

The column that this operation acts on.

" + }, + "Tags": { + "type": { + "$ref": "#/1785" + }, + "flags": 1, + "description": "

The dataset column tag, currently only used for geospatial type tagging.

\n \n

This is not tags for the Amazon Web Services tagging feature.

\n " + } + } + }, + { + "$type": "ObjectType", + "name": "TextQualifier", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TimeGranularity", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TransformOperation", + "properties": { + "CastColumnTypeOperation": { + "type": { + "$ref": "#/1697" + }, + "flags": 0 + }, + "CreateColumnsOperation": { + "type": { + "$ref": "#/1705" + }, + "flags": 0 + }, + "FilterOperation": { + "type": { + "$ref": "#/1719" + }, + "flags": 0 + }, + "OverrideDatasetParameterOperation": { + "type": { + "$ref": "#/1739" + }, + "flags": 0 + }, + "ProjectOperation": { + "type": { + "$ref": "#/1742" + }, + "flags": 0 + }, + "RenameColumnOperation": { + "type": { + "$ref": "#/1745" + }, + "flags": 0 + }, + "TagColumnOperation": { + "type": { + "$ref": "#/1757" + }, + "flags": 0 + }, + "UntagColumnOperation": { + "type": { + "$ref": "#/1761" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "UntagColumnOperation", + "properties": { + "ColumnName": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

The column that this operation acts on.

" + }, + "TagNames": { + "type": { + "$ref": "#/1786" + }, + "flags": 1, + "description": "

The column tags to remove from this column.

" + } + } + }, + { + "$type": "ObjectType", + "name": "UploadSettings", + "properties": { + "ContainsHeader": { + "type": { + "$ref": "#/650" + }, + "flags": 0, + "description": "

Whether the file has a header row, or the files each have a header row.

" + }, + "Delimiter": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The delimiter between values in the file.

" + }, + "Format": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "StartFromRow": { + "type": { + "$ref": "#/610" + }, + "flags": 0, + "description": "

A row number to start reading data from.

" + }, + "TextQualifier": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1696" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1725" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/610" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/610" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1760" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/610" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/610" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1725" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1780" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1751" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1725" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1703" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.QuickSight/DataSetProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1701" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1702" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1710" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1738" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1746" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1756" + } + }, + { + "$type": "ObjectType", + "name": "AWS.QuickSight/DataSetProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/601" + }, + "flags": 2, + "description": "

The Amazon Resource Name (ARN) of the resource.

" + }, + "AwsAccountId": { + "type": { + "$ref": "#/601" + }, + "flags": 16 + }, + "ColumnGroups": { + "type": { + "$ref": "#/1788" + }, + "flags": 0, + "description": "

Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.

" + }, + "ColumnLevelPermissionRules": { + "type": { + "$ref": "#/1789" + }, + "flags": 0, + "description": "

A set of one or more definitions of a \n ColumnLevelPermissionRule\n .

" + }, + "ConsumedSpiceCapacityInBytes": { + "type": { + "$ref": "#/610" + }, + "flags": 2, + "description": "

The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't\n imported into SPICE.

" + }, + "CreatedTime": { + "type": { + "$ref": "#/601" + }, + "flags": 2, + "description": "

The time that this dataset was created.

" + }, + "DataSetId": { + "type": { + "$ref": "#/601" + }, + "flags": 16 + }, + "DataSetRefreshProperties": { + "type": { + "$ref": "#/1708" + }, + "flags": 0 + }, + "DataSetUsageConfiguration": { + "type": { + "$ref": "#/1709" + }, + "flags": 0 + }, + "DatasetParameters": { + "type": { + "$ref": "#/1790" + }, + "flags": 0, + "description": "

The parameter declarations of the dataset.

" + }, + "FieldFolders": { + "type": { + "$ref": "#/1717" + }, + "flags": 4 + }, + "ImportMode": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "IngestionWaitPolicy": { + "type": { + "$ref": "#/1724" + }, + "flags": 4 + }, + "LastUpdatedTime": { + "type": { + "$ref": "#/601" + }, + "flags": 2, + "description": "

The last time that this dataset was updated.

" + }, + "LogicalTableMap": { + "type": { + "$ref": "#/1733" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The display name for the dataset.

" + }, + "OutputColumns": { + "type": { + "$ref": "#/1791" + }, + "flags": 2, + "description": "

The list of columns after all transforms. These columns are available in templates,\n analyses, and dashboards.

" + }, + "Permissions": { + "type": { + "$ref": "#/1792" + }, + "flags": 0, + "description": "

A list of resource permissions on the dataset.

" + }, + "PhysicalTableMap": { + "type": { + "$ref": "#/1741" + }, + "flags": 0 + }, + "RowLevelPermissionDataSet": { + "type": { + "$ref": "#/1747" + }, + "flags": 0 + }, + "RowLevelPermissionTagConfiguration": { + "type": { + "$ref": "#/1750" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/1793" + }, + "flags": 0, + "description": "

Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.

" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.QuickSight/DataSet", + "properties": { + "name": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/601" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/1794" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.QuickSight/DataSet@default", + "scopeType": 0, + "body": { + "$ref": "#/1795" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AmazonElasticsearchParameters", + "properties": { + "Domain": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

The OpenSearch domain.

" + } + } + }, + { + "$type": "ObjectType", + "name": "AmazonOpenSearchParameters", + "properties": { + "Domain": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

The OpenSearch domain.

" + } + } + }, + { + "$type": "ObjectType", + "name": "AthenaParameters", + "properties": { + "RoleArn": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

Use 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.

" + }, + "WorkGroup": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The workgroup that Amazon Athena uses.

" + } + } + }, + { + "$type": "ObjectType", + "name": "AuroraParameters", + "properties": { + "Database": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

Database.

" + }, + "Host": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

Host.

" + }, + "Port": { + "type": { + "$ref": "#/610" + }, + "flags": 1, + "description": "

Port.

" + } + } + }, + { + "$type": "ObjectType", + "name": "AuroraPostgreSqlParameters", + "properties": { + "Database": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

The Amazon Aurora PostgreSQL database to connect to.

" + }, + "Host": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

The Amazon Aurora PostgreSQL-Compatible host to connect to.

" + }, + "Port": { + "type": { + "$ref": "#/610" + }, + "flags": 1, + "description": "

The port that Amazon Aurora PostgreSQL is listening on.

" + } + } + }, + { + "$type": "ObjectType", + "name": "AwsIotAnalyticsParameters", + "properties": { + "DataSetName": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

Dataset name.

" + } + } + }, + { + "$type": "ObjectType", + "name": "CredentialPair", + "properties": { + "AlternateDataSourceParameters": { + "type": { + "$ref": "#/1833" + }, + "flags": 0, + "description": "

A set of alternate data source parameters that you want to share for these\n credentials. The credentials are applied in tandem with the data source parameters when\n you copy a data source by using a create or update request. The API operation compares\n the DataSourceParameters structure that's in the request with the\n structures in the AlternateDataSourceParameters allow list. If the\n structures are an exact match, the request is allowed to use the new data source with\n the existing credentials. If the AlternateDataSourceParameters list is\n null, the DataSourceParameters originally used with these\n Credentials is automatically allowed.

" + }, + "Password": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

Password.

" + }, + "Username": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

User name.

" + } + } + }, + { + "$type": "ObjectType", + "name": "DataSourceCredentials", + "properties": { + "CopySourceArn": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The Amazon Resource Name (ARN) of a data source that has the credential pair that you\n want to use. When CopySourceArn is not null, the credential pair from the\n data source in the ARN is used as the credentials for the\n DataSourceCredentials structure.

" + }, + "CredentialPair": { + "type": { + "$ref": "#/1803" + }, + "flags": 0 + }, + "SecretArn": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.

" + } + } + }, + { + "$type": "ObjectType", + "name": "DataSourceErrorInfo", + "properties": { + "Message": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

Error message.

" + }, + "Type": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DataSourceErrorInfoType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DataSourceParameters", + "properties": { + "AmazonElasticsearchParameters": { + "type": { + "$ref": "#/1797" + }, + "flags": 0 + }, + "AmazonOpenSearchParameters": { + "type": { + "$ref": "#/1798" + }, + "flags": 0 + }, + "AthenaParameters": { + "type": { + "$ref": "#/1799" + }, + "flags": 0 + }, + "AuroraParameters": { + "type": { + "$ref": "#/1800" + }, + "flags": 0 + }, + "AuroraPostgreSqlParameters": { + "type": { + "$ref": "#/1801" + }, + "flags": 0 + }, + "DatabricksParameters": { + "type": { + "$ref": "#/1809" + }, + "flags": 0 + }, + "MariaDbParameters": { + "type": { + "$ref": "#/1812" + }, + "flags": 0 + }, + "MySqlParameters": { + "type": { + "$ref": "#/1813" + }, + "flags": 0 + }, + "OracleParameters": { + "type": { + "$ref": "#/1814" + }, + "flags": 0 + }, + "PostgreSqlParameters": { + "type": { + "$ref": "#/1815" + }, + "flags": 0 + }, + "PrestoParameters": { + "type": { + "$ref": "#/1816" + }, + "flags": 0 + }, + "RdsParameters": { + "type": { + "$ref": "#/1817" + }, + "flags": 0 + }, + "RedshiftParameters": { + "type": { + "$ref": "#/1819" + }, + "flags": 0 + }, + "S3Parameters": { + "type": { + "$ref": "#/1822" + }, + "flags": 0 + }, + "SnowflakeParameters": { + "type": { + "$ref": "#/1823" + }, + "flags": 0 + }, + "SparkParameters": { + "type": { + "$ref": "#/1824" + }, + "flags": 0 + }, + "SqlServerParameters": { + "type": { + "$ref": "#/1825" + }, + "flags": 0 + }, + "StarburstParameters": { + "type": { + "$ref": "#/1827" + }, + "flags": 0 + }, + "TeradataParameters": { + "type": { + "$ref": "#/1830" + }, + "flags": 0 + }, + "TrinoParameters": { + "type": { + "$ref": "#/1831" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DataSourceType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DatabricksParameters", + "properties": { + "Host": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

The host name of the Databricks data source.

" + }, + "Port": { + "type": { + "$ref": "#/610" + }, + "flags": 1, + "description": "

The port for the Databricks data source.

" + }, + "SqlEndpointPath": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

The HTTP path of the Databricks data source.

" + } + } + }, + { + "$type": "ObjectType", + "name": "IdentityCenterConfiguration", + "properties": { + "EnableIdentityPropagation": { + "type": { + "$ref": "#/650" + }, + "flags": 0, + "description": "

A Boolean option that controls whether Trusted Identity Propagation should be used.

" + } + } + }, + { + "$type": "ObjectType", + "name": "ManifestFileLocation", + "properties": { + "Bucket": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

Amazon S3 bucket.

" + }, + "Key": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

Amazon S3 key that identifies an object.

" + } + } + }, + { + "$type": "ObjectType", + "name": "MariaDbParameters", + "properties": { + "Database": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

Database.

" + }, + "Host": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

Host.

" + }, + "Port": { + "type": { + "$ref": "#/610" + }, + "flags": 1, + "description": "

Port.

" + } + } + }, + { + "$type": "ObjectType", + "name": "MySqlParameters", + "properties": { + "Database": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

Database.

" + }, + "Host": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

Host.

" + }, + "Port": { + "type": { + "$ref": "#/610" + }, + "flags": 1, + "description": "

Port.

" + } + } + }, + { + "$type": "ObjectType", + "name": "OracleParameters", + "properties": { + "Database": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

The database.

" + }, + "Host": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

An Oracle host.

" + }, + "Port": { + "type": { + "$ref": "#/610" + }, + "flags": 1, + "description": "

The port.

" + } + } + }, + { + "$type": "ObjectType", + "name": "PostgreSqlParameters", + "properties": { + "Database": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

Database.

" + }, + "Host": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

Host.

" + }, + "Port": { + "type": { + "$ref": "#/610" + }, + "flags": 1, + "description": "

Port.

" + } + } + }, + { + "$type": "ObjectType", + "name": "PrestoParameters", + "properties": { + "Catalog": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

Catalog.

" + }, + "Host": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

Host.

" + }, + "Port": { + "type": { + "$ref": "#/610" + }, + "flags": 1, + "description": "

Port.

" + } + } + }, + { + "$type": "ObjectType", + "name": "RdsParameters", + "properties": { + "Database": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

Database.

" + }, + "InstanceId": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

Instance ID.

" + } + } + }, + { + "$type": "ObjectType", + "name": "RedshiftIAMParameters", + "properties": { + "AutoCreateDatabaseUser": { + "type": { + "$ref": "#/650" + }, + "flags": 0, + "description": "

Automatically creates a database user. If your database doesn't have a DatabaseUser, set this parameter to True. If there is no DatabaseUser, Amazon QuickSight 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.

" + }, + "DatabaseGroups": { + "type": { + "$ref": "#/1834" + }, + "flags": 0, + "description": "

A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the DatabaseUser. If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup.

" + }, + "DatabaseUser": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight 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.

" + }, + "RoleArn": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

Use the RoleArn structure to allow Amazon QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.

" + } + } + }, + { + "$type": "ObjectType", + "name": "RedshiftParameters", + "properties": { + "ClusterId": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

Cluster ID. This field can be blank if the Host and Port are\n provided.

" + }, + "Database": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

Database.

" + }, + "Host": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

Host. This field can be blank if ClusterId is provided.

" + }, + "IAMParameters": { + "type": { + "$ref": "#/1818" + }, + "flags": 0 + }, + "IdentityCenterConfiguration": { + "type": { + "$ref": "#/1810" + }, + "flags": 0 + }, + "Port": { + "type": { + "$ref": "#/610" + }, + "flags": 0, + "description": "

Port. This field can be blank if the ClusterId is provided.

" + } + } + }, + { + "$type": "ObjectType", + "name": "ResourcePermission", + "properties": { + "Actions": { + "type": { + "$ref": "#/1835" + }, + "flags": 1, + "description": "

The IAM action to grant or revoke permissions on.

" + }, + "Principal": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

The Amazon Resource Name (ARN) of the principal. This can be one of the\n following:

\n
    \n
  • \n

    The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

    \n
    • \n
  • \n

    The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)

    \n
    • \n
  • \n

    The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight\n ARN. Use this option only to share resources (templates) across Amazon Web Services accounts.\n (This is less common.)

    \n
    • \n
" + }, + "Resource": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ResourceStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "S3Parameters", + "properties": { + "ManifestFileLocation": { + "type": { + "$ref": "#/1811" + }, + "flags": 1 + }, + "RoleArn": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

Use 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.

" + } + } + }, + { + "$type": "ObjectType", + "name": "SnowflakeParameters", + "properties": { + "Database": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

Database.

" + }, + "Host": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

Host.

" + }, + "Warehouse": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

Warehouse.

" + } + } + }, + { + "$type": "ObjectType", + "name": "SparkParameters", + "properties": { + "Host": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

Host.

" + }, + "Port": { + "type": { + "$ref": "#/610" + }, + "flags": 1, + "description": "

Port.

" + } + } + }, + { + "$type": "ObjectType", + "name": "SqlServerParameters", + "properties": { + "Database": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

Database.

" + }, + "Host": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

Host.

" + }, + "Port": { + "type": { + "$ref": "#/610" + }, + "flags": 1, + "description": "

Port.

" + } + } + }, + { + "$type": "ObjectType", + "name": "SslProperties", + "properties": { + "DisableSsl": { + "type": { + "$ref": "#/650" + }, + "flags": 0, + "description": "

A Boolean option to control whether SSL should be disabled.

" + } + } + }, + { + "$type": "ObjectType", + "name": "StarburstParameters", + "properties": { + "Catalog": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

The catalog name for the Starburst data source.

" + }, + "Host": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

The host name of the Starburst data source.

" + }, + "Port": { + "type": { + "$ref": "#/610" + }, + "flags": 1, + "description": "

The port for the Starburst data source.

" + }, + "ProductType": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "StarburstProductType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

Tag key.

" + }, + "Value": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

Tag value.

" + } + } + }, + { + "$type": "ObjectType", + "name": "TeradataParameters", + "properties": { + "Database": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

Database.

" + }, + "Host": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

Host.

" + }, + "Port": { + "type": { + "$ref": "#/610" + }, + "flags": 1, + "description": "

Port.

" + } + } + }, + { + "$type": "ObjectType", + "name": "TrinoParameters", + "properties": { + "Catalog": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

The catalog name for the Trino data source.

" + }, + "Host": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

The host name of the Trino data source.

" + }, + "Port": { + "type": { + "$ref": "#/610" + }, + "flags": 1, + "description": "

The port for the Trino data source.

" + } + } + }, + { + "$type": "ObjectType", + "name": "VpcConnectionProperties", + "properties": { + "VpcConnectionArn": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

The Amazon Resource Name (ARN) for the VPC connection.

" + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1807" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.QuickSight/DataSourceProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1807" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1820" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1829" + } + }, + { + "$type": "ObjectType", + "name": "AWS.QuickSight/DataSourceProperties", + "properties": { + "AlternateDataSourceParameters": { + "type": { + "$ref": "#/1837" + }, + "flags": 0, + "description": "

A set of alternate data source parameters that you want to share for the credentials\n stored with this data source. The credentials are applied in tandem with the data source\n parameters when you copy a data source by using a create or update request. The API\n operation compares the DataSourceParameters structure that's in the request\n with the structures in the AlternateDataSourceParameters allow list. If the\n structures are an exact match, the request is allowed to use the credentials from this\n existing data source. If the AlternateDataSourceParameters list is null,\n the Credentials originally used with this DataSourceParameters\n are automatically allowed.

" + }, + "Arn": { + "type": { + "$ref": "#/601" + }, + "flags": 2, + "description": "

The Amazon Resource Name (ARN) of the data source.

" + }, + "AwsAccountId": { + "type": { + "$ref": "#/601" + }, + "flags": 16 + }, + "CreatedTime": { + "type": { + "$ref": "#/601" + }, + "flags": 2, + "description": "

The time that this data source was created.

" + }, + "Credentials": { + "type": { + "$ref": "#/1804" + }, + "flags": 4 + }, + "DataSourceId": { + "type": { + "$ref": "#/601" + }, + "flags": 16 + }, + "DataSourceParameters": { + "type": { + "$ref": "#/1807" + }, + "flags": 0 + }, + "ErrorInfo": { + "type": { + "$ref": "#/1805" + }, + "flags": 0 + }, + "LastUpdatedTime": { + "type": { + "$ref": "#/601" + }, + "flags": 2, + "description": "

The last time that this data source was updated.

" + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Permissions": { + "type": { + "$ref": "#/1838" + }, + "flags": 0 + }, + "SslProperties": { + "type": { + "$ref": "#/1826" + }, + "flags": 0 + }, + "Status": { + "type": { + "$ref": "#/601" + }, + "flags": 2 + }, + "Tags": { + "type": { + "$ref": "#/1839" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "VpcConnectionProperties": { + "type": { + "$ref": "#/1832" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.QuickSight/DataSource", + "properties": { + "name": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/601" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/1840" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.QuickSight/DataSource@default", + "scopeType": 0, + "body": { + "$ref": "#/1841" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "RefreshScheduleMap", + "properties": { + "RefreshType": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ScheduleFrequency": { + "type": { + "$ref": "#/1845" + }, + "flags": 0, + "description": "

Information about the schedule frequency.

" + }, + "ScheduleId": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

An unique identifier for the refresh schedule.

" + }, + "StartAfterDateTime": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The date time after which refresh is to be scheduled

" + } + } + }, + { + "$type": "ObjectType", + "name": "RefreshSchedule_ScheduleFrequency_RefreshOnDay", + "properties": { + "DayOfMonth": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The Day Of Month for scheduled refresh.

" + }, + "DayOfWeek": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "RefreshSchedule_ScheduleFrequency", + "properties": { + "Interval": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "RefreshOnDay": { + "type": { + "$ref": "#/1844" + }, + "flags": 0, + "description": "

The day scheduled for refresh.

" + }, + "TimeOfTheDay": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The time of the day for scheduled refresh.

" + }, + "TimeZone": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The timezone for scheduled refresh.

" + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.QuickSight/RefreshScheduleProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.QuickSight/RefreshScheduleProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/601" + }, + "flags": 2, + "description": "

The Amazon Resource Name (ARN) of the data source.

" + }, + "AwsAccountId": { + "type": { + "$ref": "#/601" + }, + "flags": 16 + }, + "DataSetId": { + "type": { + "$ref": "#/601" + }, + "flags": 16 + }, + "Schedule": { + "type": { + "$ref": "#/1843" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.QuickSight/RefreshSchedule", + "properties": { + "name": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/601" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/1847" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.QuickSight/RefreshSchedule@default", + "scopeType": 0, + "body": { + "$ref": "#/1848" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AggregationFunction", + "properties": { + "AttributeAggregationFunction": { + "type": { + "$ref": "#/1863" + }, + "flags": 0 + }, + "CategoricalAggregationFunction": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "DateAggregationFunction": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "NumericalAggregationFunction": { + "type": { + "$ref": "#/2189" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AggregationSortConfiguration", + "properties": { + "AggregationFunction": { + "type": { + "$ref": "#/1850" + }, + "flags": 0 + }, + "Column": { + "type": { + "$ref": "#/1918" + }, + "flags": 1 + }, + "SortDirection": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AllSheetsFilterScopeConfiguration", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AnalysisDefaults", + "properties": { + "DefaultNewSheetConfiguration": { + "type": { + "$ref": "#/1998" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AnchorDateConfiguration", + "properties": { + "AnchorOption": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ParameterName": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AnchorOption", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ArcAxisConfiguration", + "properties": { + "Range": { + "type": { + "$ref": "#/1857" + }, + "flags": 0 + }, + "ReserveRange": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ArcAxisDisplayRange", + "properties": { + "Max": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "Min": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ArcConfiguration", + "properties": { + "ArcAngle": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "ArcThickness": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ArcOptions", + "properties": { + "ArcThickness": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ArcThickness", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ArcThicknessOptions", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AssetOptions", + "properties": { + "Timezone": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "WeekStart": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AttributeAggregationFunction", + "properties": { + "SimpleAttributeAggregation": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ValueForMultipleValues": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AxisBinding", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AxisDataOptions", + "properties": { + "DateAxisOptions": { + "type": { + "$ref": "#/1976" + }, + "flags": 0 + }, + "NumericAxisOptions": { + "type": { + "$ref": "#/2179" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AxisDisplayDataDrivenRange", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AxisDisplayMinMaxRange", + "properties": { + "Maximum": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "Minimum": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AxisDisplayOptions", + "properties": { + "AxisLineVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "AxisOffset": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "String based length that is composed of value and unit in px" + }, + "DataOptions": { + "type": { + "$ref": "#/1865" + }, + "flags": 0 + }, + "GridLineVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ScrollbarOptions": { + "type": { + "$ref": "#/2293" + }, + "flags": 0 + }, + "TickLabelOptions": { + "type": { + "$ref": "#/1875" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AxisDisplayRange", + "properties": { + "DataDriven": { + "type": { + "$ref": "#/1866" + }, + "flags": 0 + }, + "MinMax": { + "type": { + "$ref": "#/1867" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AxisLabelOptions", + "properties": { + "ApplyTo": { + "type": { + "$ref": "#/1871" + }, + "flags": 0 + }, + "CustomLabel": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "FontConfiguration": { + "type": { + "$ref": "#/2048" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AxisLabelReferenceOptions", + "properties": { + "Column": { + "type": { + "$ref": "#/1918" + }, + "flags": 1 + }, + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AxisLinearScale", + "properties": { + "StepCount": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "StepSize": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AxisLogarithmicScale", + "properties": { + "Base": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AxisScale", + "properties": { + "Linear": { + "type": { + "$ref": "#/1872" + }, + "flags": 0 + }, + "Logarithmic": { + "type": { + "$ref": "#/1873" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AxisTickLabelOptions", + "properties": { + "LabelOptions": { + "type": { + "$ref": "#/2137" + }, + "flags": 0 + }, + "RotationAngle": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BarChartAggregatedFieldWells", + "properties": { + "Category": { + "type": { + "$ref": "#/2452" + }, + "flags": 0 + }, + "Colors": { + "type": { + "$ref": "#/2453" + }, + "flags": 0 + }, + "SmallMultiples": { + "type": { + "$ref": "#/2454" + }, + "flags": 0 + }, + "Values": { + "type": { + "$ref": "#/2455" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BarChartConfiguration", + "properties": { + "BarsArrangement": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "CategoryAxis": { + "type": { + "$ref": "#/1868" + }, + "flags": 0 + }, + "CategoryLabelOptions": { + "type": { + "$ref": "#/1908" + }, + "flags": 0 + }, + "ColorLabelOptions": { + "type": { + "$ref": "#/1908" + }, + "flags": 0 + }, + "ContributionAnalysisDefaults": { + "type": { + "$ref": "#/2456" + }, + "flags": 0 + }, + "DataLabels": { + "type": { + "$ref": "#/1963" + }, + "flags": 0 + }, + "FieldWells": { + "type": { + "$ref": "#/1878" + }, + "flags": 0 + }, + "Legend": { + "type": { + "$ref": "#/2141" + }, + "flags": 0 + }, + "Orientation": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ReferenceLines": { + "type": { + "$ref": "#/2457" + }, + "flags": 0 + }, + "SmallMultiplesOptions": { + "type": { + "$ref": "#/2332" + }, + "flags": 0 + }, + "SortConfiguration": { + "type": { + "$ref": "#/1880" + }, + "flags": 0 + }, + "Tooltip": { + "type": { + "$ref": "#/2397" + }, + "flags": 0 + }, + "ValueAxis": { + "type": { + "$ref": "#/1868" + }, + "flags": 0 + }, + "ValueLabelOptions": { + "type": { + "$ref": "#/1908" + }, + "flags": 0 + }, + "VisualPalette": { + "type": { + "$ref": "#/2427" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BarChartFieldWells", + "properties": { + "BarChartAggregatedFieldWells": { + "type": { + "$ref": "#/1876" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BarChartOrientation", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "BarChartSortConfiguration", + "properties": { + "CategoryItemsLimit": { + "type": { + "$ref": "#/2120" + }, + "flags": 0 + }, + "CategorySort": { + "type": { + "$ref": "#/2458" + }, + "flags": 0 + }, + "ColorItemsLimit": { + "type": { + "$ref": "#/2120" + }, + "flags": 0 + }, + "ColorSort": { + "type": { + "$ref": "#/2459" + }, + "flags": 0 + }, + "SmallMultiplesLimitConfiguration": { + "type": { + "$ref": "#/2120" + }, + "flags": 0 + }, + "SmallMultiplesSort": { + "type": { + "$ref": "#/2460" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BarChartVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/2461" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/1877" + }, + "flags": 0 + }, + "ColumnHierarchies": { + "type": { + "$ref": "#/2462" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/2428" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/2429" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "BarsArrangement", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "BaseMapStyleType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "BinCountOptions", + "properties": { + "Value": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BinWidthOptions", + "properties": { + "BinCountLimit": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BodySectionConfiguration", + "properties": { + "Content": { + "type": { + "$ref": "#/1887" + }, + "flags": 1 + }, + "PageBreakConfiguration": { + "type": { + "$ref": "#/2300" + }, + "flags": 0 + }, + "SectionId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Style": { + "type": { + "$ref": "#/2302" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BodySectionContent", + "properties": { + "Layout": { + "type": { + "$ref": "#/2299" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BoxPlotAggregatedFieldWells", + "properties": { + "GroupBy": { + "type": { + "$ref": "#/2463" + }, + "flags": 0 + }, + "Values": { + "type": { + "$ref": "#/2464" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BoxPlotChartConfiguration", + "properties": { + "BoxPlotOptions": { + "type": { + "$ref": "#/1892" + }, + "flags": 0 + }, + "CategoryAxis": { + "type": { + "$ref": "#/1868" + }, + "flags": 0 + }, + "CategoryLabelOptions": { + "type": { + "$ref": "#/1908" + }, + "flags": 0 + }, + "FieldWells": { + "type": { + "$ref": "#/1890" + }, + "flags": 0 + }, + "Legend": { + "type": { + "$ref": "#/2141" + }, + "flags": 0 + }, + "PrimaryYAxisDisplayOptions": { + "type": { + "$ref": "#/1868" + }, + "flags": 0 + }, + "PrimaryYAxisLabelOptions": { + "type": { + "$ref": "#/1908" + }, + "flags": 0 + }, + "ReferenceLines": { + "type": { + "$ref": "#/2465" + }, + "flags": 0 + }, + "SortConfiguration": { + "type": { + "$ref": "#/1893" + }, + "flags": 0 + }, + "Tooltip": { + "type": { + "$ref": "#/2397" + }, + "flags": 0 + }, + "VisualPalette": { + "type": { + "$ref": "#/2427" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BoxPlotFieldWells", + "properties": { + "BoxPlotAggregatedFieldWells": { + "type": { + "$ref": "#/1888" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BoxPlotFillStyle", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "BoxPlotOptions", + "properties": { + "AllDataPointsVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "OutlierVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "StyleOptions": { + "type": { + "$ref": "#/1894" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BoxPlotSortConfiguration", + "properties": { + "CategorySort": { + "type": { + "$ref": "#/2466" + }, + "flags": 0 + }, + "PaginationConfiguration": { + "type": { + "$ref": "#/2193" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BoxPlotStyleOptions", + "properties": { + "FillStyle": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BoxPlotVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/2467" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/1889" + }, + "flags": 0 + }, + "ColumnHierarchies": { + "type": { + "$ref": "#/2468" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/2428" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/2429" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CalculatedField", + "properties": { + "DataSetIdentifier": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Expression": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CalculatedMeasureField", + "properties": { + "Expression": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CascadingControlConfiguration", + "properties": { + "SourceControls": { + "type": { + "$ref": "#/2469" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CascadingControlSource", + "properties": { + "ColumnToMatch": { + "type": { + "$ref": "#/1918" + }, + "flags": 0 + }, + "SourceSheetControlId": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CategoricalAggregationFunction", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CategoricalDimensionField", + "properties": { + "Column": { + "type": { + "$ref": "#/1918" + }, + "flags": 1 + }, + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "FormatConfiguration": { + "type": { + "$ref": "#/2337" + }, + "flags": 0 + }, + "HierarchyId": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CategoricalMeasureField", + "properties": { + "AggregationFunction": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Column": { + "type": { + "$ref": "#/1918" + }, + "flags": 1 + }, + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "FormatConfiguration": { + "type": { + "$ref": "#/2337" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CategoryDrillDownFilter", + "properties": { + "CategoryValues": { + "type": { + "$ref": "#/2470" + }, + "flags": 1 + }, + "Column": { + "type": { + "$ref": "#/1918" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CategoryFilter", + "properties": { + "Column": { + "type": { + "$ref": "#/1918" + }, + "flags": 1 + }, + "Configuration": { + "type": { + "$ref": "#/1905" + }, + "flags": 1 + }, + "DefaultFilterControlConfiguration": { + "type": { + "$ref": "#/1991" + }, + "flags": 0 + }, + "FilterId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CategoryFilterConfiguration", + "properties": { + "CustomFilterConfiguration": { + "type": { + "$ref": "#/1954" + }, + "flags": 0 + }, + "CustomFilterListConfiguration": { + "type": { + "$ref": "#/1955" + }, + "flags": 0 + }, + "FilterListConfiguration": { + "type": { + "$ref": "#/2036" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CategoryFilterMatchOperator", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CategoryFilterSelectAllOptions", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ChartAxisLabelOptions", + "properties": { + "AxisLabelOptions": { + "type": { + "$ref": "#/2471" + }, + "flags": 0 + }, + "SortIconVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ClusterMarker", + "properties": { + "SimpleClusterMarker": { + "type": { + "$ref": "#/2325" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ClusterMarkerConfiguration", + "properties": { + "ClusterMarker": { + "type": { + "$ref": "#/1909" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ColorFillType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ColorScale", + "properties": { + "ColorFillType": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Colors": { + "type": { + "$ref": "#/2472" + }, + "flags": 1 + }, + "NullValueColor": { + "type": { + "$ref": "#/1960" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ColorsConfiguration", + "properties": { + "CustomColors": { + "type": { + "$ref": "#/2473" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ColumnConfiguration", + "properties": { + "ColorsConfiguration": { + "type": { + "$ref": "#/1913" + }, + "flags": 0 + }, + "Column": { + "type": { + "$ref": "#/1918" + }, + "flags": 1 + }, + "FormatConfiguration": { + "type": { + "$ref": "#/2058" + }, + "flags": 0 + }, + "Role": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ColumnGroupColumnSchema", + "properties": { + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The name of the column group's column schema.

" + } + } + }, + { + "$type": "ObjectType", + "name": "ColumnGroupSchema", + "properties": { + "ColumnGroupColumnSchemaList": { + "type": { + "$ref": "#/2474" + }, + "flags": 0, + "description": "

A structure containing the list of schemas for column group columns.

" + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The name of the column group schema.

" + } + } + }, + { + "$type": "ObjectType", + "name": "ColumnHierarchy", + "properties": { + "DateTimeHierarchy": { + "type": { + "$ref": "#/1981" + }, + "flags": 0 + }, + "ExplicitHierarchy": { + "type": { + "$ref": "#/2015" + }, + "flags": 0 + }, + "PredefinedHierarchy": { + "type": { + "$ref": "#/2247" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ColumnIdentifier", + "properties": { + "ColumnName": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "DataSetIdentifier": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ColumnRole", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ColumnSchema", + "properties": { + "DataType": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The data type of the column schema.

" + }, + "GeographicRole": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The geographic role of the column schema.

" + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The name of the column schema.

" + } + } + }, + { + "$type": "ObjectType", + "name": "ColumnSort", + "properties": { + "AggregationFunction": { + "type": { + "$ref": "#/1850" + }, + "flags": 0 + }, + "Direction": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "SortBy": { + "type": { + "$ref": "#/1918" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ColumnTooltipItem", + "properties": { + "Aggregation": { + "type": { + "$ref": "#/1850" + }, + "flags": 0 + }, + "Column": { + "type": { + "$ref": "#/1918" + }, + "flags": 1 + }, + "Label": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ComboChartAggregatedFieldWells", + "properties": { + "BarValues": { + "type": { + "$ref": "#/2475" + }, + "flags": 0 + }, + "Category": { + "type": { + "$ref": "#/2476" + }, + "flags": 0 + }, + "Colors": { + "type": { + "$ref": "#/2477" + }, + "flags": 0 + }, + "LineValues": { + "type": { + "$ref": "#/2478" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ComboChartConfiguration", + "properties": { + "BarDataLabels": { + "type": { + "$ref": "#/1963" + }, + "flags": 0 + }, + "BarsArrangement": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "CategoryAxis": { + "type": { + "$ref": "#/1868" + }, + "flags": 0 + }, + "CategoryLabelOptions": { + "type": { + "$ref": "#/1908" + }, + "flags": 0 + }, + "ColorLabelOptions": { + "type": { + "$ref": "#/1908" + }, + "flags": 0 + }, + "FieldWells": { + "type": { + "$ref": "#/1925" + }, + "flags": 0 + }, + "Legend": { + "type": { + "$ref": "#/2141" + }, + "flags": 0 + }, + "LineDataLabels": { + "type": { + "$ref": "#/1963" + }, + "flags": 0 + }, + "PrimaryYAxisDisplayOptions": { + "type": { + "$ref": "#/1868" + }, + "flags": 0 + }, + "PrimaryYAxisLabelOptions": { + "type": { + "$ref": "#/1908" + }, + "flags": 0 + }, + "ReferenceLines": { + "type": { + "$ref": "#/2479" + }, + "flags": 0 + }, + "SecondaryYAxisDisplayOptions": { + "type": { + "$ref": "#/1868" + }, + "flags": 0 + }, + "SecondaryYAxisLabelOptions": { + "type": { + "$ref": "#/1908" + }, + "flags": 0 + }, + "SortConfiguration": { + "type": { + "$ref": "#/1926" + }, + "flags": 0 + }, + "Tooltip": { + "type": { + "$ref": "#/2397" + }, + "flags": 0 + }, + "VisualPalette": { + "type": { + "$ref": "#/2427" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ComboChartFieldWells", + "properties": { + "ComboChartAggregatedFieldWells": { + "type": { + "$ref": "#/1923" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ComboChartSortConfiguration", + "properties": { + "CategoryItemsLimit": { + "type": { + "$ref": "#/2120" + }, + "flags": 0 + }, + "CategorySort": { + "type": { + "$ref": "#/2480" + }, + "flags": 0 + }, + "ColorItemsLimit": { + "type": { + "$ref": "#/2120" + }, + "flags": 0 + }, + "ColorSort": { + "type": { + "$ref": "#/2481" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ComboChartVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/2482" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/1924" + }, + "flags": 0 + }, + "ColumnHierarchies": { + "type": { + "$ref": "#/2483" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/2428" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/2429" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ComparisonConfiguration", + "properties": { + "ComparisonFormat": { + "type": { + "$ref": "#/1929" + }, + "flags": 0 + }, + "ComparisonMethod": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ComparisonFormatConfiguration", + "properties": { + "NumberDisplayFormatConfiguration": { + "type": { + "$ref": "#/2176" + }, + "flags": 0 + }, + "PercentageDisplayFormatConfiguration": { + "type": { + "$ref": "#/2210" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ComparisonMethod", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Computation", + "properties": { + "Forecast": { + "type": { + "$ref": "#/2054" + }, + "flags": 0 + }, + "GrowthRate": { + "type": { + "$ref": "#/2100" + }, + "flags": 0 + }, + "MaximumMinimum": { + "type": { + "$ref": "#/2166" + }, + "flags": 0 + }, + "MetricComparison": { + "type": { + "$ref": "#/2169" + }, + "flags": 0 + }, + "PeriodOverPeriod": { + "type": { + "$ref": "#/2212" + }, + "flags": 0 + }, + "PeriodToDate": { + "type": { + "$ref": "#/2213" + }, + "flags": 0 + }, + "TopBottomMovers": { + "type": { + "$ref": "#/2401" + }, + "flags": 0 + }, + "TopBottomRanked": { + "type": { + "$ref": "#/2402" + }, + "flags": 0 + }, + "TotalAggregation": { + "type": { + "$ref": "#/2404" + }, + "flags": 0 + }, + "UniqueValues": { + "type": { + "$ref": "#/2416" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ConditionalFormattingColor", + "properties": { + "Gradient": { + "type": { + "$ref": "#/1935" + }, + "flags": 0 + }, + "Solid": { + "type": { + "$ref": "#/1941" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ConditionalFormattingCustomIconCondition", + "properties": { + "Color": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "DisplayConfiguration": { + "type": { + "$ref": "#/1937" + }, + "flags": 0 + }, + "Expression": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "IconOptions": { + "type": { + "$ref": "#/1934" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ConditionalFormattingCustomIconOptions", + "properties": { + "Icon": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "UnicodeIcon": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ConditionalFormattingGradientColor", + "properties": { + "Color": { + "type": { + "$ref": "#/2094" + }, + "flags": 1 + }, + "Expression": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ConditionalFormattingIcon", + "properties": { + "CustomCondition": { + "type": { + "$ref": "#/1933" + }, + "flags": 0 + }, + "IconSet": { + "type": { + "$ref": "#/1939" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ConditionalFormattingIconDisplayConfiguration", + "properties": { + "IconDisplayOption": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ConditionalFormattingIconDisplayOption", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ConditionalFormattingIconSet", + "properties": { + "Expression": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "IconSetType": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ConditionalFormattingIconSetType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ConditionalFormattingSolidColor", + "properties": { + "Color": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Expression": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ContributionAnalysisDefault", + "properties": { + "ContributorDimensions": { + "type": { + "$ref": "#/2484" + }, + "flags": 1 + }, + "MeasureFieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CrossDatasetTypes", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CurrencyDisplayFormatConfiguration", + "properties": { + "DecimalPlacesConfiguration": { + "type": { + "$ref": "#/1988" + }, + "flags": 0 + }, + "NegativeValueConfiguration": { + "type": { + "$ref": "#/2173" + }, + "flags": 0 + }, + "NullValueFormatConfiguration": { + "type": { + "$ref": "#/2175" + }, + "flags": 0 + }, + "NumberScale": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Prefix": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "SeparatorConfiguration": { + "type": { + "$ref": "#/2187" + }, + "flags": 0 + }, + "Suffix": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Symbol": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomActionFilterOperation", + "properties": { + "SelectedFieldsConfiguration": { + "type": { + "$ref": "#/2039" + }, + "flags": 1 + }, + "TargetVisualsConfiguration": { + "type": { + "$ref": "#/2040" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomActionNavigationOperation", + "properties": { + "LocalNavigationConfiguration": { + "type": { + "$ref": "#/2161" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomActionSetParametersOperation", + "properties": { + "ParameterValueConfigurations": { + "type": { + "$ref": "#/2485" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomActionURLOperation", + "properties": { + "URLTarget": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "URLTemplate": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomColor", + "properties": { + "Color": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "FieldValue": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "SpecialValue": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomContentConfiguration", + "properties": { + "ContentType": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ContentUrl": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ImageScaling": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomContentImageScalingConfiguration", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CustomContentType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CustomContentVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/2486" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/1950" + }, + "flags": 0 + }, + "DataSetIdentifier": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Subtitle": { + "type": { + "$ref": "#/2428" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/2429" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomFilterConfiguration", + "properties": { + "CategoryValue": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "MatchOperator": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "NullOption": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "ParameterName": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "SelectAllOptions": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomFilterListConfiguration", + "properties": { + "CategoryValues": { + "type": { + "$ref": "#/2487" + }, + "flags": 0 + }, + "MatchOperator": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "NullOption": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "SelectAllOptions": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomNarrativeOptions", + "properties": { + "Narrative": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomParameterValues", + "properties": { + "DateTimeValues": { + "type": { + "$ref": "#/2488" + }, + "flags": 0 + }, + "DecimalValues": { + "type": { + "$ref": "#/2489" + }, + "flags": 0 + }, + "IntegerValues": { + "type": { + "$ref": "#/2490" + }, + "flags": 0 + }, + "StringValues": { + "type": { + "$ref": "#/2491" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomValuesConfiguration", + "properties": { + "CustomValues": { + "type": { + "$ref": "#/1957" + }, + "flags": 1 + }, + "IncludeNullValue": { + "type": { + "$ref": "#/650" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DataBarsOptions", + "properties": { + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "NegativeColor": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "PositiveColor": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DataColor", + "properties": { + "Color": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "DataValue": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DataFieldSeriesItem", + "properties": { + "AxisBinding": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "FieldValue": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Settings": { + "type": { + "$ref": "#/2151" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DataLabelContent", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DataLabelOptions", + "properties": { + "CategoryLabelVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "DataLabelTypes": { + "type": { + "$ref": "#/2492" + }, + "flags": 0 + }, + "LabelColor": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "LabelContent": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "LabelFontConfiguration": { + "type": { + "$ref": "#/2048" + }, + "flags": 0 + }, + "MeasureLabelVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Overlap": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Position": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "TotalsVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DataLabelOverlap", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DataLabelPosition", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DataLabelType", + "properties": { + "DataPathLabelType": { + "type": { + "$ref": "#/1968" + }, + "flags": 0 + }, + "FieldLabelType": { + "type": { + "$ref": "#/2017" + }, + "flags": 0 + }, + "MaximumLabelType": { + "type": { + "$ref": "#/2165" + }, + "flags": 0 + }, + "MinimumLabelType": { + "type": { + "$ref": "#/2170" + }, + "flags": 0 + }, + "RangeEndsLabelType": { + "type": { + "$ref": "#/2259" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DataPathColor", + "properties": { + "Color": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Element": { + "type": { + "$ref": "#/1971" + }, + "flags": 1 + }, + "TimeGranularity": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DataPathLabelType", + "properties": { + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "FieldValue": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DataPathSort", + "properties": { + "Direction": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "SortPaths": { + "type": { + "$ref": "#/2493" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DataPathType", + "properties": { + "PivotTableDataPathType": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DataPathValue", + "properties": { + "DataPathType": { + "type": { + "$ref": "#/1970" + }, + "flags": 0 + }, + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "FieldValue": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DataSetConfiguration", + "properties": { + "ColumnGroupSchemaList": { + "type": { + "$ref": "#/2494" + }, + "flags": 0, + "description": "

A structure containing the list of column group schemas.

" + }, + "DataSetSchema": { + "type": { + "$ref": "#/1974" + }, + "flags": 0 + }, + "Placeholder": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

Placeholder.

" + } + } + }, + { + "$type": "ObjectType", + "name": "DataSetReference", + "properties": { + "DataSetArn": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

Dataset Amazon Resource Name (ARN).

" + }, + "DataSetPlaceholder": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

Dataset placeholder.

" + } + } + }, + { + "$type": "ObjectType", + "name": "DataSetSchema", + "properties": { + "ColumnSchemaList": { + "type": { + "$ref": "#/2495" + }, + "flags": 0, + "description": "

A structure containing the list of column schemas.

" + } + } + }, + { + "$type": "ObjectType", + "name": "DateAggregationFunction", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DateAxisOptions", + "properties": { + "MissingDateVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DateDimensionField", + "properties": { + "Column": { + "type": { + "$ref": "#/1918" + }, + "flags": 1 + }, + "DateGranularity": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "FormatConfiguration": { + "type": { + "$ref": "#/1980" + }, + "flags": 0 + }, + "HierarchyId": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DateMeasureField", + "properties": { + "AggregationFunction": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Column": { + "type": { + "$ref": "#/1918" + }, + "flags": 1 + }, + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "FormatConfiguration": { + "type": { + "$ref": "#/1980" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DateTimeDefaultValues", + "properties": { + "DynamicValue": { + "type": { + "$ref": "#/2011" + }, + "flags": 0 + }, + "RollingDate": { + "type": { + "$ref": "#/2280" + }, + "flags": 0 + }, + "StaticValues": { + "type": { + "$ref": "#/2496" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DateTimeFormatConfiguration", + "properties": { + "DateTimeFormat": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "NullValueFormatConfiguration": { + "type": { + "$ref": "#/2175" + }, + "flags": 0 + }, + "NumericFormatConfiguration": { + "type": { + "$ref": "#/2184" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DateTimeHierarchy", + "properties": { + "DrillDownFilters": { + "type": { + "$ref": "#/2497" + }, + "flags": 0 + }, + "HierarchyId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DateTimeParameterDeclaration", + "properties": { + "DefaultValues": { + "type": { + "$ref": "#/1979" + }, + "flags": 0 + }, + "MappedDataSetParameters": { + "type": { + "$ref": "#/2498" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "TimeGranularity": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ValueWhenUnset": { + "type": { + "$ref": "#/1984" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DateTimePickerControlDisplayOptions", + "properties": { + "DateTimeFormat": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "InfoIconLabelOptions": { + "type": { + "$ref": "#/2313" + }, + "flags": 0 + }, + "TitleOptions": { + "type": { + "$ref": "#/2137" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DateTimeValueWhenUnsetConfiguration", + "properties": { + "CustomValue": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ValueWhenUnsetOption": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DayOfTheWeek", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DecimalDefaultValues", + "properties": { + "DynamicValue": { + "type": { + "$ref": "#/2011" + }, + "flags": 0 + }, + "StaticValues": { + "type": { + "$ref": "#/2499" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DecimalParameterDeclaration", + "properties": { + "DefaultValues": { + "type": { + "$ref": "#/1986" + }, + "flags": 0 + }, + "MappedDataSetParameters": { + "type": { + "$ref": "#/2500" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "ParameterValueType": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "ValueWhenUnset": { + "type": { + "$ref": "#/1989" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DecimalPlacesConfiguration", + "properties": { + "DecimalPlaces": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DecimalValueWhenUnsetConfiguration", + "properties": { + "CustomValue": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "ValueWhenUnsetOption": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DefaultDateTimePickerControlOptions", + "properties": { + "DisplayOptions": { + "type": { + "$ref": "#/1983" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DefaultFilterControlConfiguration", + "properties": { + "ControlOptions": { + "type": { + "$ref": "#/1992" + }, + "flags": 1 + }, + "Title": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DefaultFilterControlOptions", + "properties": { + "DefaultDateTimePickerOptions": { + "type": { + "$ref": "#/1990" + }, + "flags": 0 + }, + "DefaultDropdownOptions": { + "type": { + "$ref": "#/1993" + }, + "flags": 0 + }, + "DefaultListOptions": { + "type": { + "$ref": "#/1994" + }, + "flags": 0 + }, + "DefaultRelativeDateTimeOptions": { + "type": { + "$ref": "#/2000" + }, + "flags": 0 + }, + "DefaultSliderOptions": { + "type": { + "$ref": "#/2002" + }, + "flags": 0 + }, + "DefaultTextAreaOptions": { + "type": { + "$ref": "#/2003" + }, + "flags": 0 + }, + "DefaultTextFieldOptions": { + "type": { + "$ref": "#/2004" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DefaultFilterDropDownControlOptions", + "properties": { + "DisplayOptions": { + "type": { + "$ref": "#/2010" + }, + "flags": 0 + }, + "SelectableValues": { + "type": { + "$ref": "#/2043" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DefaultFilterListControlOptions", + "properties": { + "DisplayOptions": { + "type": { + "$ref": "#/2157" + }, + "flags": 0 + }, + "SelectableValues": { + "type": { + "$ref": "#/2043" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DefaultFreeFormLayoutConfiguration", + "properties": { + "CanvasSizeOptions": { + "type": { + "$ref": "#/2059" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DefaultGridLayoutConfiguration", + "properties": { + "CanvasSizeOptions": { + "type": { + "$ref": "#/2096" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DefaultInteractiveLayoutConfiguration", + "properties": { + "FreeForm": { + "type": { + "$ref": "#/1995" + }, + "flags": 0 + }, + "Grid": { + "type": { + "$ref": "#/1996" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DefaultNewSheetConfiguration", + "properties": { + "InteractiveLayoutConfiguration": { + "type": { + "$ref": "#/1997" + }, + "flags": 0 + }, + "PaginatedLayoutConfiguration": { + "type": { + "$ref": "#/1999" + }, + "flags": 0 + }, + "SheetContentType": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DefaultPaginatedLayoutConfiguration", + "properties": { + "SectionBased": { + "type": { + "$ref": "#/2001" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DefaultRelativeDateTimeControlOptions", + "properties": { + "DisplayOptions": { + "type": { + "$ref": "#/2273" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DefaultSectionBasedLayoutConfiguration", + "properties": { + "CanvasSizeOptions": { + "type": { + "$ref": "#/2296" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DefaultSliderControlOptions", + "properties": { + "DisplayOptions": { + "type": { + "$ref": "#/2328" + }, + "flags": 0 + }, + "MaximumValue": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + }, + "MinimumValue": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + }, + "StepSize": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + }, + "Type": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DefaultTextAreaControlOptions", + "properties": { + "Delimiter": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "DisplayOptions": { + "type": { + "$ref": "#/2384" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DefaultTextFieldControlOptions", + "properties": { + "DisplayOptions": { + "type": { + "$ref": "#/2387" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DestinationParameterValueConfiguration", + "properties": { + "CustomValuesConfiguration": { + "type": { + "$ref": "#/1958" + }, + "flags": 0 + }, + "SelectAllValueOptions": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "SourceColumn": { + "type": { + "$ref": "#/1918" + }, + "flags": 0 + }, + "SourceField": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "SourceParameterName": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DimensionField", + "properties": { + "CategoricalDimensionField": { + "type": { + "$ref": "#/1901" + }, + "flags": 0 + }, + "DateDimensionField": { + "type": { + "$ref": "#/1977" + }, + "flags": 0 + }, + "NumericalDimensionField": { + "type": { + "$ref": "#/2190" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DonutCenterOptions", + "properties": { + "LabelVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DonutOptions", + "properties": { + "ArcOptions": { + "type": { + "$ref": "#/1859" + }, + "flags": 0 + }, + "DonutCenterOptions": { + "type": { + "$ref": "#/2007" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DrillDownFilter", + "properties": { + "CategoryFilter": { + "type": { + "$ref": "#/1903" + }, + "flags": 0 + }, + "NumericEqualityFilter": { + "type": { + "$ref": "#/2180" + }, + "flags": 0 + }, + "TimeRangeFilter": { + "type": { + "$ref": "#/2393" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DropDownControlDisplayOptions", + "properties": { + "InfoIconLabelOptions": { + "type": { + "$ref": "#/2313" + }, + "flags": 0 + }, + "SelectAllOptions": { + "type": { + "$ref": "#/2159" + }, + "flags": 0 + }, + "TitleOptions": { + "type": { + "$ref": "#/2137" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DynamicDefaultValue", + "properties": { + "DefaultValueColumn": { + "type": { + "$ref": "#/1918" + }, + "flags": 1 + }, + "GroupNameColumn": { + "type": { + "$ref": "#/1918" + }, + "flags": 0 + }, + "UserNameColumn": { + "type": { + "$ref": "#/1918" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "EmptyVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/2501" + }, + "flags": 0 + }, + "DataSetIdentifier": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Entity", + "properties": { + "Path": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ExcludePeriodConfiguration", + "properties": { + "Amount": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + }, + "Granularity": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Status": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ExplicitHierarchy", + "properties": { + "Columns": { + "type": { + "$ref": "#/2502" + }, + "flags": 1 + }, + "DrillDownFilters": { + "type": { + "$ref": "#/2503" + }, + "flags": 0 + }, + "HierarchyId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "FieldBasedTooltip", + "properties": { + "AggregationVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "TooltipFields": { + "type": { + "$ref": "#/2504" + }, + "flags": 0 + }, + "TooltipTitleType": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FieldLabelType", + "properties": { + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FieldSeriesItem", + "properties": { + "AxisBinding": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Settings": { + "type": { + "$ref": "#/2151" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FieldSort", + "properties": { + "Direction": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "FieldSortOptions", + "properties": { + "ColumnSort": { + "type": { + "$ref": "#/1921" + }, + "flags": 0 + }, + "FieldSort": { + "type": { + "$ref": "#/2019" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FieldTooltipItem", + "properties": { + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Label": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FilledMapAggregatedFieldWells", + "properties": { + "Geospatial": { + "type": { + "$ref": "#/2505" + }, + "flags": 0 + }, + "Values": { + "type": { + "$ref": "#/2506" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FilledMapConditionalFormatting", + "properties": { + "ConditionalFormattingOptions": { + "type": { + "$ref": "#/2507" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "FilledMapConditionalFormattingOption", + "properties": { + "Shape": { + "type": { + "$ref": "#/2027" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "FilledMapConfiguration", + "properties": { + "FieldWells": { + "type": { + "$ref": "#/2026" + }, + "flags": 0 + }, + "Legend": { + "type": { + "$ref": "#/2141" + }, + "flags": 0 + }, + "MapStyleOptions": { + "type": { + "$ref": "#/2088" + }, + "flags": 0 + }, + "SortConfiguration": { + "type": { + "$ref": "#/2028" + }, + "flags": 0 + }, + "Tooltip": { + "type": { + "$ref": "#/2397" + }, + "flags": 0 + }, + "WindowOptions": { + "type": { + "$ref": "#/2092" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FilledMapFieldWells", + "properties": { + "FilledMapAggregatedFieldWells": { + "type": { + "$ref": "#/2022" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FilledMapShapeConditionalFormatting", + "properties": { + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Format": { + "type": { + "$ref": "#/2309" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FilledMapSortConfiguration", + "properties": { + "CategorySort": { + "type": { + "$ref": "#/2508" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FilledMapVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/2509" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/2025" + }, + "flags": 0 + }, + "ColumnHierarchies": { + "type": { + "$ref": "#/2510" + }, + "flags": 0 + }, + "ConditionalFormatting": { + "type": { + "$ref": "#/2023" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/2428" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/2429" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Filter", + "properties": { + "CategoryFilter": { + "type": { + "$ref": "#/1904" + }, + "flags": 0 + }, + "NumericEqualityFilter": { + "type": { + "$ref": "#/2181" + }, + "flags": 0 + }, + "NumericRangeFilter": { + "type": { + "$ref": "#/2185" + }, + "flags": 0 + }, + "RelativeDatesFilter": { + "type": { + "$ref": "#/2275" + }, + "flags": 0 + }, + "TimeEqualityFilter": { + "type": { + "$ref": "#/2391" + }, + "flags": 0 + }, + "TimeRangeFilter": { + "type": { + "$ref": "#/2394" + }, + "flags": 0 + }, + "TopBottomFilter": { + "type": { + "$ref": "#/2400" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FilterControl", + "properties": { + "CrossSheet": { + "type": { + "$ref": "#/2032" + }, + "flags": 0 + }, + "DateTimePicker": { + "type": { + "$ref": "#/2033" + }, + "flags": 0 + }, + "Dropdown": { + "type": { + "$ref": "#/2034" + }, + "flags": 0 + }, + "List": { + "type": { + "$ref": "#/2037" + }, + "flags": 0 + }, + "RelativeDateTime": { + "type": { + "$ref": "#/2041" + }, + "flags": 0 + }, + "Slider": { + "type": { + "$ref": "#/2044" + }, + "flags": 0 + }, + "TextArea": { + "type": { + "$ref": "#/2045" + }, + "flags": 0 + }, + "TextField": { + "type": { + "$ref": "#/2046" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FilterCrossSheetControl", + "properties": { + "CascadingControlConfiguration": { + "type": { + "$ref": "#/1898" + }, + "flags": 0 + }, + "FilterControlId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "SourceFilterId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "FilterDateTimePickerControl", + "properties": { + "DisplayOptions": { + "type": { + "$ref": "#/1983" + }, + "flags": 0 + }, + "FilterControlId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "SourceFilterId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Title": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Type": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FilterDropDownControl", + "properties": { + "CascadingControlConfiguration": { + "type": { + "$ref": "#/1898" + }, + "flags": 0 + }, + "DisplayOptions": { + "type": { + "$ref": "#/2010" + }, + "flags": 0 + }, + "FilterControlId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "SelectableValues": { + "type": { + "$ref": "#/2043" + }, + "flags": 0 + }, + "SourceFilterId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Title": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Type": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FilterGroup", + "properties": { + "CrossDataset": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "FilterGroupId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Filters": { + "type": { + "$ref": "#/2511" + }, + "flags": 1 + }, + "ScopeConfiguration": { + "type": { + "$ref": "#/2042" + }, + "flags": 1 + }, + "Status": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FilterListConfiguration", + "properties": { + "CategoryValues": { + "type": { + "$ref": "#/2512" + }, + "flags": 0 + }, + "MatchOperator": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "NullOption": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "SelectAllOptions": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FilterListControl", + "properties": { + "CascadingControlConfiguration": { + "type": { + "$ref": "#/1898" + }, + "flags": 0 + }, + "DisplayOptions": { + "type": { + "$ref": "#/2157" + }, + "flags": 0 + }, + "FilterControlId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "SelectableValues": { + "type": { + "$ref": "#/2043" + }, + "flags": 0 + }, + "SourceFilterId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Title": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Type": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FilterNullOption", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "FilterOperationSelectedFieldsConfiguration", + "properties": { + "SelectedColumns": { + "type": { + "$ref": "#/2513" + }, + "flags": 0, + "description": "

The selected columns of a dataset.

" + }, + "SelectedFieldOptions": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "SelectedFields": { + "type": { + "$ref": "#/2514" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FilterOperationTargetVisualsConfiguration", + "properties": { + "SameSheetTargetVisualConfiguration": { + "type": { + "$ref": "#/2282" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FilterRelativeDateTimeControl", + "properties": { + "DisplayOptions": { + "type": { + "$ref": "#/2273" + }, + "flags": 0 + }, + "FilterControlId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "SourceFilterId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Title": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "FilterScopeConfiguration", + "properties": { + "AllSheets": { + "type": { + "$ref": "#/1852" + }, + "flags": 0 + }, + "SelectedSheets": { + "type": { + "$ref": "#/2305" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FilterSelectableValues", + "properties": { + "Values": { + "type": { + "$ref": "#/2515" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FilterSliderControl", + "properties": { + "DisplayOptions": { + "type": { + "$ref": "#/2328" + }, + "flags": 0 + }, + "FilterControlId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "MaximumValue": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + }, + "MinimumValue": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + }, + "SourceFilterId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "StepSize": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + }, + "Title": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Type": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FilterTextAreaControl", + "properties": { + "Delimiter": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "DisplayOptions": { + "type": { + "$ref": "#/2384" + }, + "flags": 0 + }, + "FilterControlId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "SourceFilterId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Title": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "FilterTextFieldControl", + "properties": { + "DisplayOptions": { + "type": { + "$ref": "#/2387" + }, + "flags": 0 + }, + "FilterControlId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "SourceFilterId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Title": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "FilterVisualScope", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "FontConfiguration", + "properties": { + "FontColor": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "FontDecoration": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "FontSize": { + "type": { + "$ref": "#/2050" + }, + "flags": 0 + }, + "FontStyle": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "FontWeight": { + "type": { + "$ref": "#/2052" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FontDecoration", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "FontSize", + "properties": { + "Relative": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FontStyle", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "FontWeight", + "properties": { + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FontWeightName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ForecastComputation", + "properties": { + "ComputationId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "CustomSeasonalityValue": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "LowerBoundary": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "PeriodsBackward": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "PeriodsForward": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "PredictionInterval": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "Seasonality": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Time": { + "type": { + "$ref": "#/2006" + }, + "flags": 0 + }, + "UpperBoundary": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/2168" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ForecastComputationSeasonality", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ForecastConfiguration", + "properties": { + "ForecastProperties": { + "type": { + "$ref": "#/2390" + }, + "flags": 0 + }, + "Scenario": { + "type": { + "$ref": "#/2057" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ForecastScenario", + "properties": { + "WhatIfPointScenario": { + "type": { + "$ref": "#/2438" + }, + "flags": 0 + }, + "WhatIfRangeScenario": { + "type": { + "$ref": "#/2439" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FormatConfiguration", + "properties": { + "DateTimeFormatConfiguration": { + "type": { + "$ref": "#/1980" + }, + "flags": 0 + }, + "NumberFormatConfiguration": { + "type": { + "$ref": "#/2177" + }, + "flags": 0 + }, + "StringFormatConfiguration": { + "type": { + "$ref": "#/2337" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FreeFormLayoutCanvasSizeOptions", + "properties": { + "ScreenCanvasSizeOptions": { + "type": { + "$ref": "#/2064" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FreeFormLayoutConfiguration", + "properties": { + "CanvasSizeOptions": { + "type": { + "$ref": "#/2059" + }, + "flags": 0 + }, + "Elements": { + "type": { + "$ref": "#/2516" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "FreeFormLayoutElement", + "properties": { + "BackgroundStyle": { + "type": { + "$ref": "#/2062" + }, + "flags": 0 + }, + "BorderStyle": { + "type": { + "$ref": "#/2063" + }, + "flags": 0 + }, + "ElementId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "ElementType": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Height": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "String based length that is composed of value and unit in px" + }, + "LoadingAnimation": { + "type": { + "$ref": "#/2160" + }, + "flags": 0 + }, + "RenderingRules": { + "type": { + "$ref": "#/2517" + }, + "flags": 0 + }, + "SelectedBorderStyle": { + "type": { + "$ref": "#/2063" + }, + "flags": 0 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Width": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "String based length that is composed of value and unit in px" + }, + "XAxisLocation": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "String based length that is composed of value and unit in px" + }, + "YAxisLocation": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "String based length that is composed of value and unit in px with Integer.MAX_VALUE as maximum value" + } + } + }, + { + "$type": "ObjectType", + "name": "FreeFormLayoutElementBackgroundStyle", + "properties": { + "Color": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FreeFormLayoutElementBorderStyle", + "properties": { + "Color": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FreeFormLayoutScreenCanvasSizeOptions", + "properties": { + "OptimizedViewPortWidth": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "String based length that is composed of value and unit in px" + } + } + }, + { + "$type": "ObjectType", + "name": "FreeFormSectionLayoutConfiguration", + "properties": { + "Elements": { + "type": { + "$ref": "#/2518" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "FunnelChartAggregatedFieldWells", + "properties": { + "Category": { + "type": { + "$ref": "#/2519" + }, + "flags": 0 + }, + "Values": { + "type": { + "$ref": "#/2520" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FunnelChartConfiguration", + "properties": { + "CategoryLabelOptions": { + "type": { + "$ref": "#/1908" + }, + "flags": 0 + }, + "DataLabelOptions": { + "type": { + "$ref": "#/2068" + }, + "flags": 0 + }, + "FieldWells": { + "type": { + "$ref": "#/2069" + }, + "flags": 0 + }, + "SortConfiguration": { + "type": { + "$ref": "#/2071" + }, + "flags": 0 + }, + "Tooltip": { + "type": { + "$ref": "#/2397" + }, + "flags": 0 + }, + "ValueLabelOptions": { + "type": { + "$ref": "#/1908" + }, + "flags": 0 + }, + "VisualPalette": { + "type": { + "$ref": "#/2427" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FunnelChartDataLabelOptions", + "properties": { + "CategoryLabelVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "LabelColor": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "LabelFontConfiguration": { + "type": { + "$ref": "#/2048" + }, + "flags": 0 + }, + "MeasureDataLabelStyle": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "MeasureLabelVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Position": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FunnelChartFieldWells", + "properties": { + "FunnelChartAggregatedFieldWells": { + "type": { + "$ref": "#/2066" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FunnelChartMeasureDataLabelStyle", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "FunnelChartSortConfiguration", + "properties": { + "CategoryItemsLimit": { + "type": { + "$ref": "#/2120" + }, + "flags": 0 + }, + "CategorySort": { + "type": { + "$ref": "#/2521" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FunnelChartVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/2522" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/2067" + }, + "flags": 0 + }, + "ColumnHierarchies": { + "type": { + "$ref": "#/2523" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/2428" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/2429" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "GaugeChartArcConditionalFormatting", + "properties": { + "ForegroundColor": { + "type": { + "$ref": "#/1932" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GaugeChartConditionalFormatting", + "properties": { + "ConditionalFormattingOptions": { + "type": { + "$ref": "#/2524" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GaugeChartConditionalFormattingOption", + "properties": { + "Arc": { + "type": { + "$ref": "#/2073" + }, + "flags": 0 + }, + "PrimaryValue": { + "type": { + "$ref": "#/2079" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GaugeChartConfiguration", + "properties": { + "DataLabels": { + "type": { + "$ref": "#/1963" + }, + "flags": 0 + }, + "FieldWells": { + "type": { + "$ref": "#/2077" + }, + "flags": 0 + }, + "GaugeChartOptions": { + "type": { + "$ref": "#/2078" + }, + "flags": 0 + }, + "TooltipOptions": { + "type": { + "$ref": "#/2397" + }, + "flags": 0 + }, + "VisualPalette": { + "type": { + "$ref": "#/2427" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GaugeChartFieldWells", + "properties": { + "TargetValues": { + "type": { + "$ref": "#/2525" + }, + "flags": 0 + }, + "Values": { + "type": { + "$ref": "#/2526" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GaugeChartOptions", + "properties": { + "Arc": { + "type": { + "$ref": "#/1858" + }, + "flags": 0 + }, + "ArcAxis": { + "type": { + "$ref": "#/1856" + }, + "flags": 0 + }, + "Comparison": { + "type": { + "$ref": "#/1928" + }, + "flags": 0 + }, + "PrimaryValueDisplayType": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "PrimaryValueFontConfiguration": { + "type": { + "$ref": "#/2048" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GaugeChartPrimaryValueConditionalFormatting", + "properties": { + "Icon": { + "type": { + "$ref": "#/1936" + }, + "flags": 0 + }, + "TextColor": { + "type": { + "$ref": "#/1932" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GaugeChartVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/2527" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/2076" + }, + "flags": 0 + }, + "ConditionalFormatting": { + "type": { + "$ref": "#/2074" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/2428" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/2429" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "GeospatialCoordinateBounds", + "properties": { + "East": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + }, + "North": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + }, + "South": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + }, + "West": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "GeospatialHeatmapColorScale", + "properties": { + "Colors": { + "type": { + "$ref": "#/2528" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GeospatialHeatmapConfiguration", + "properties": { + "HeatmapColor": { + "type": { + "$ref": "#/2082" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GeospatialHeatmapDataColor", + "properties": { + "Color": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "GeospatialMapAggregatedFieldWells", + "properties": { + "Colors": { + "type": { + "$ref": "#/2529" + }, + "flags": 0 + }, + "Geospatial": { + "type": { + "$ref": "#/2530" + }, + "flags": 0 + }, + "Values": { + "type": { + "$ref": "#/2531" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GeospatialMapConfiguration", + "properties": { + "FieldWells": { + "type": { + "$ref": "#/2087" + }, + "flags": 0 + }, + "Legend": { + "type": { + "$ref": "#/2141" + }, + "flags": 0 + }, + "MapStyleOptions": { + "type": { + "$ref": "#/2088" + }, + "flags": 0 + }, + "PointStyleOptions": { + "type": { + "$ref": "#/2090" + }, + "flags": 0 + }, + "Tooltip": { + "type": { + "$ref": "#/2397" + }, + "flags": 0 + }, + "VisualPalette": { + "type": { + "$ref": "#/2427" + }, + "flags": 0 + }, + "WindowOptions": { + "type": { + "$ref": "#/2092" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GeospatialMapFieldWells", + "properties": { + "GeospatialMapAggregatedFieldWells": { + "type": { + "$ref": "#/2085" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GeospatialMapStyleOptions", + "properties": { + "BaseMapStyle": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GeospatialMapVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/2532" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/2086" + }, + "flags": 0 + }, + "ColumnHierarchies": { + "type": { + "$ref": "#/2533" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/2428" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/2429" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "GeospatialPointStyleOptions", + "properties": { + "ClusterMarkerConfiguration": { + "type": { + "$ref": "#/1910" + }, + "flags": 0 + }, + "HeatmapConfiguration": { + "type": { + "$ref": "#/2083" + }, + "flags": 0 + }, + "SelectedPointStyle": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GeospatialSelectedPointStyle", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "GeospatialWindowOptions", + "properties": { + "Bounds": { + "type": { + "$ref": "#/2081" + }, + "flags": 0 + }, + "MapZoomMode": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GlobalTableBorderOptions", + "properties": { + "SideSpecificBorder": { + "type": { + "$ref": "#/2368" + }, + "flags": 0 + }, + "UniformBorder": { + "type": { + "$ref": "#/2343" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GradientColor", + "properties": { + "Stops": { + "type": { + "$ref": "#/2534" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GradientStop", + "properties": { + "Color": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "DataValue": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "GradientOffset": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "GridLayoutCanvasSizeOptions", + "properties": { + "ScreenCanvasSizeOptions": { + "type": { + "$ref": "#/2099" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GridLayoutConfiguration", + "properties": { + "CanvasSizeOptions": { + "type": { + "$ref": "#/2096" + }, + "flags": 0 + }, + "Elements": { + "type": { + "$ref": "#/2535" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "GridLayoutElement", + "properties": { + "ColumnIndex": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "ColumnSpan": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + }, + "ElementId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "ElementType": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "RowIndex": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "RowSpan": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "GridLayoutScreenCanvasSizeOptions", + "properties": { + "OptimizedViewPortWidth": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "String based length that is composed of value and unit in px" + }, + "ResizeOption": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "GrowthRateComputation", + "properties": { + "ComputationId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "PeriodSize": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "Time": { + "type": { + "$ref": "#/2006" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/2168" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "HeaderFooterSectionConfiguration", + "properties": { + "Layout": { + "type": { + "$ref": "#/2299" + }, + "flags": 1 + }, + "SectionId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Style": { + "type": { + "$ref": "#/2302" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "HeatMapAggregatedFieldWells", + "properties": { + "Columns": { + "type": { + "$ref": "#/2536" + }, + "flags": 0 + }, + "Rows": { + "type": { + "$ref": "#/2537" + }, + "flags": 0 + }, + "Values": { + "type": { + "$ref": "#/2538" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "HeatMapConfiguration", + "properties": { + "ColorScale": { + "type": { + "$ref": "#/1912" + }, + "flags": 0 + }, + "ColumnLabelOptions": { + "type": { + "$ref": "#/1908" + }, + "flags": 0 + }, + "DataLabels": { + "type": { + "$ref": "#/1963" + }, + "flags": 0 + }, + "FieldWells": { + "type": { + "$ref": "#/2104" + }, + "flags": 0 + }, + "Legend": { + "type": { + "$ref": "#/2141" + }, + "flags": 0 + }, + "RowLabelOptions": { + "type": { + "$ref": "#/1908" + }, + "flags": 0 + }, + "SortConfiguration": { + "type": { + "$ref": "#/2105" + }, + "flags": 0 + }, + "Tooltip": { + "type": { + "$ref": "#/2397" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "HeatMapFieldWells", + "properties": { + "HeatMapAggregatedFieldWells": { + "type": { + "$ref": "#/2102" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "HeatMapSortConfiguration", + "properties": { + "HeatMapColumnItemsLimitConfiguration": { + "type": { + "$ref": "#/2120" + }, + "flags": 0 + }, + "HeatMapColumnSort": { + "type": { + "$ref": "#/2539" + }, + "flags": 0 + }, + "HeatMapRowItemsLimitConfiguration": { + "type": { + "$ref": "#/2120" + }, + "flags": 0 + }, + "HeatMapRowSort": { + "type": { + "$ref": "#/2540" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "HeatMapVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/2541" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/2103" + }, + "flags": 0 + }, + "ColumnHierarchies": { + "type": { + "$ref": "#/2542" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/2428" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/2429" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "HistogramAggregatedFieldWells", + "properties": { + "Values": { + "type": { + "$ref": "#/2543" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "HistogramBinOptions", + "properties": { + "BinCount": { + "type": { + "$ref": "#/1884" + }, + "flags": 0 + }, + "BinWidth": { + "type": { + "$ref": "#/1885" + }, + "flags": 0 + }, + "SelectedBinType": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "StartValue": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "HistogramBinType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "HistogramConfiguration", + "properties": { + "BinOptions": { + "type": { + "$ref": "#/2108" + }, + "flags": 0 + }, + "DataLabels": { + "type": { + "$ref": "#/1963" + }, + "flags": 0 + }, + "FieldWells": { + "type": { + "$ref": "#/2111" + }, + "flags": 0 + }, + "Tooltip": { + "type": { + "$ref": "#/2397" + }, + "flags": 0 + }, + "VisualPalette": { + "type": { + "$ref": "#/2427" + }, + "flags": 0 + }, + "XAxisDisplayOptions": { + "type": { + "$ref": "#/1868" + }, + "flags": 0 + }, + "XAxisLabelOptions": { + "type": { + "$ref": "#/1908" + }, + "flags": 0 + }, + "YAxisDisplayOptions": { + "type": { + "$ref": "#/1868" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "HistogramFieldWells", + "properties": { + "HistogramAggregatedFieldWells": { + "type": { + "$ref": "#/2107" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "HistogramVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/2544" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/2110" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/2428" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/2429" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "HorizontalTextAlignment", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Icon", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "InsightConfiguration", + "properties": { + "Computations": { + "type": { + "$ref": "#/2545" + }, + "flags": 0 + }, + "CustomNarrative": { + "type": { + "$ref": "#/1956" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "InsightVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/2546" + }, + "flags": 0 + }, + "DataSetIdentifier": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "InsightConfiguration": { + "type": { + "$ref": "#/2115" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/2428" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/2429" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "IntegerDefaultValues", + "properties": { + "DynamicValue": { + "type": { + "$ref": "#/2011" + }, + "flags": 0 + }, + "StaticValues": { + "type": { + "$ref": "#/2547" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "IntegerParameterDeclaration", + "properties": { + "DefaultValues": { + "type": { + "$ref": "#/2117" + }, + "flags": 0 + }, + "MappedDataSetParameters": { + "type": { + "$ref": "#/2548" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "ParameterValueType": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "ValueWhenUnset": { + "type": { + "$ref": "#/2119" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "IntegerValueWhenUnsetConfiguration", + "properties": { + "CustomValue": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "ValueWhenUnsetOption": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ItemsLimitConfiguration", + "properties": { + "ItemsLimit": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "OtherCategories": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "KPIActualValueConditionalFormatting", + "properties": { + "Icon": { + "type": { + "$ref": "#/1936" + }, + "flags": 0 + }, + "TextColor": { + "type": { + "$ref": "#/1932" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "KPIComparisonValueConditionalFormatting", + "properties": { + "Icon": { + "type": { + "$ref": "#/1936" + }, + "flags": 0 + }, + "TextColor": { + "type": { + "$ref": "#/1932" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "KPIConditionalFormatting", + "properties": { + "ConditionalFormattingOptions": { + "type": { + "$ref": "#/2549" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "KPIConditionalFormattingOption", + "properties": { + "ActualValue": { + "type": { + "$ref": "#/2121" + }, + "flags": 0 + }, + "ComparisonValue": { + "type": { + "$ref": "#/2122" + }, + "flags": 0 + }, + "PrimaryValue": { + "type": { + "$ref": "#/2128" + }, + "flags": 0 + }, + "ProgressBar": { + "type": { + "$ref": "#/2129" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "KPIConfiguration", + "properties": { + "FieldWells": { + "type": { + "$ref": "#/2126" + }, + "flags": 0 + }, + "KPIOptions": { + "type": { + "$ref": "#/2127" + }, + "flags": 0 + }, + "SortConfiguration": { + "type": { + "$ref": "#/2130" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "KPIFieldWells", + "properties": { + "TargetValues": { + "type": { + "$ref": "#/2550" + }, + "flags": 0 + }, + "TrendGroups": { + "type": { + "$ref": "#/2551" + }, + "flags": 0 + }, + "Values": { + "type": { + "$ref": "#/2552" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "KPIOptions", + "properties": { + "Comparison": { + "type": { + "$ref": "#/1928" + }, + "flags": 0 + }, + "PrimaryValueDisplayType": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "PrimaryValueFontConfiguration": { + "type": { + "$ref": "#/2048" + }, + "flags": 0 + }, + "ProgressBar": { + "type": { + "$ref": "#/2249" + }, + "flags": 0 + }, + "SecondaryValue": { + "type": { + "$ref": "#/2294" + }, + "flags": 0 + }, + "SecondaryValueFontConfiguration": { + "type": { + "$ref": "#/2048" + }, + "flags": 0 + }, + "Sparkline": { + "type": { + "$ref": "#/2131" + }, + "flags": 0 + }, + "TrendArrows": { + "type": { + "$ref": "#/2413" + }, + "flags": 0 + }, + "VisualLayoutOptions": { + "type": { + "$ref": "#/2134" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "KPIPrimaryValueConditionalFormatting", + "properties": { + "Icon": { + "type": { + "$ref": "#/1936" + }, + "flags": 0 + }, + "TextColor": { + "type": { + "$ref": "#/1932" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "KPIProgressBarConditionalFormatting", + "properties": { + "ForegroundColor": { + "type": { + "$ref": "#/1932" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "KPISortConfiguration", + "properties": { + "TrendGroupSort": { + "type": { + "$ref": "#/2553" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "KPISparklineOptions", + "properties": { + "Color": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "TooltipVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "KPISparklineType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "KPIVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/2554" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/2125" + }, + "flags": 0 + }, + "ColumnHierarchies": { + "type": { + "$ref": "#/2555" + }, + "flags": 0 + }, + "ConditionalFormatting": { + "type": { + "$ref": "#/2123" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/2428" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/2429" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "KPIVisualLayoutOptions", + "properties": { + "StandardLayout": { + "type": { + "$ref": "#/2135" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "KPIVisualStandardLayout", + "properties": { + "Type": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "KPIVisualStandardLayoutType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LabelOptions", + "properties": { + "CustomLabel": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "FontConfiguration": { + "type": { + "$ref": "#/2048" + }, + "flags": 0 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Layout", + "properties": { + "Configuration": { + "type": { + "$ref": "#/2139" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "LayoutConfiguration", + "properties": { + "FreeFormLayout": { + "type": { + "$ref": "#/2060" + }, + "flags": 0 + }, + "GridLayout": { + "type": { + "$ref": "#/2097" + }, + "flags": 0 + }, + "SectionBasedLayout": { + "type": { + "$ref": "#/2297" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "LayoutElementType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LegendOptions", + "properties": { + "Height": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "String based length that is composed of value and unit in px" + }, + "Position": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/2137" + }, + "flags": 0 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Width": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "String based length that is composed of value and unit in px" + } + } + }, + { + "$type": "ObjectType", + "name": "LegendPosition", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LineChartAggregatedFieldWells", + "properties": { + "Category": { + "type": { + "$ref": "#/2556" + }, + "flags": 0 + }, + "Colors": { + "type": { + "$ref": "#/2557" + }, + "flags": 0 + }, + "SmallMultiples": { + "type": { + "$ref": "#/2558" + }, + "flags": 0 + }, + "Values": { + "type": { + "$ref": "#/2559" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "LineChartConfiguration", + "properties": { + "ContributionAnalysisDefaults": { + "type": { + "$ref": "#/2560" + }, + "flags": 0 + }, + "DataLabels": { + "type": { + "$ref": "#/1963" + }, + "flags": 0 + }, + "DefaultSeriesSettings": { + "type": { + "$ref": "#/2145" + }, + "flags": 0 + }, + "FieldWells": { + "type": { + "$ref": "#/2146" + }, + "flags": 0 + }, + "ForecastConfigurations": { + "type": { + "$ref": "#/2561" + }, + "flags": 0 + }, + "Legend": { + "type": { + "$ref": "#/2141" + }, + "flags": 0 + }, + "PrimaryYAxisDisplayOptions": { + "type": { + "$ref": "#/2156" + }, + "flags": 0 + }, + "PrimaryYAxisLabelOptions": { + "type": { + "$ref": "#/1908" + }, + "flags": 0 + }, + "ReferenceLines": { + "type": { + "$ref": "#/2562" + }, + "flags": 0 + }, + "SecondaryYAxisDisplayOptions": { + "type": { + "$ref": "#/2156" + }, + "flags": 0 + }, + "SecondaryYAxisLabelOptions": { + "type": { + "$ref": "#/1908" + }, + "flags": 0 + }, + "Series": { + "type": { + "$ref": "#/2563" + }, + "flags": 0 + }, + "SmallMultiplesOptions": { + "type": { + "$ref": "#/2332" + }, + "flags": 0 + }, + "SortConfiguration": { + "type": { + "$ref": "#/2152" + }, + "flags": 0 + }, + "Tooltip": { + "type": { + "$ref": "#/2397" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "VisualPalette": { + "type": { + "$ref": "#/2427" + }, + "flags": 0 + }, + "XAxisDisplayOptions": { + "type": { + "$ref": "#/1868" + }, + "flags": 0 + }, + "XAxisLabelOptions": { + "type": { + "$ref": "#/1908" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "LineChartDefaultSeriesSettings", + "properties": { + "AxisBinding": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "LineStyleSettings": { + "type": { + "$ref": "#/2148" + }, + "flags": 0 + }, + "MarkerStyleSettings": { + "type": { + "$ref": "#/2150" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "LineChartFieldWells", + "properties": { + "LineChartAggregatedFieldWells": { + "type": { + "$ref": "#/2143" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "LineChartLineStyle", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LineChartLineStyleSettings", + "properties": { + "LineInterpolation": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "LineStyle": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "LineVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "LineWidth": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "String based length that is composed of value and unit in px" + } + } + }, + { + "$type": "ObjectType", + "name": "LineChartMarkerShape", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LineChartMarkerStyleSettings", + "properties": { + "MarkerColor": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "MarkerShape": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "MarkerSize": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "String based length that is composed of value and unit in px" + }, + "MarkerVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "LineChartSeriesSettings", + "properties": { + "LineStyleSettings": { + "type": { + "$ref": "#/2148" + }, + "flags": 0 + }, + "MarkerStyleSettings": { + "type": { + "$ref": "#/2150" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "LineChartSortConfiguration", + "properties": { + "CategoryItemsLimitConfiguration": { + "type": { + "$ref": "#/2120" + }, + "flags": 0 + }, + "CategorySort": { + "type": { + "$ref": "#/2564" + }, + "flags": 0 + }, + "ColorItemsLimitConfiguration": { + "type": { + "$ref": "#/2120" + }, + "flags": 0 + }, + "SmallMultiplesLimitConfiguration": { + "type": { + "$ref": "#/2120" + }, + "flags": 0 + }, + "SmallMultiplesSort": { + "type": { + "$ref": "#/2565" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "LineChartType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LineChartVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/2566" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/2144" + }, + "flags": 0 + }, + "ColumnHierarchies": { + "type": { + "$ref": "#/2567" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/2428" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/2429" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "LineInterpolation", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LineSeriesAxisDisplayOptions", + "properties": { + "AxisOptions": { + "type": { + "$ref": "#/1868" + }, + "flags": 0 + }, + "MissingDataConfigurations": { + "type": { + "$ref": "#/2568" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ListControlDisplayOptions", + "properties": { + "InfoIconLabelOptions": { + "type": { + "$ref": "#/2313" + }, + "flags": 0 + }, + "SearchOptions": { + "type": { + "$ref": "#/2158" + }, + "flags": 0 + }, + "SelectAllOptions": { + "type": { + "$ref": "#/2159" + }, + "flags": 0 + }, + "TitleOptions": { + "type": { + "$ref": "#/2137" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ListControlSearchOptions", + "properties": { + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ListControlSelectAllOptions", + "properties": { + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "LoadingAnimation", + "properties": { + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "LocalNavigationConfiguration", + "properties": { + "TargetSheetId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "LongFormatText", + "properties": { + "PlainText": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "RichText": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "MapZoomMode", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MappedDataSetParameter", + "properties": { + "DataSetIdentifier": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "DataSetParameterName": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "MaximumLabelType", + "properties": { + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "MaximumMinimumComputation", + "properties": { + "ComputationId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Time": { + "type": { + "$ref": "#/2006" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/2168" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "MaximumMinimumComputationType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MeasureField", + "properties": { + "CalculatedMeasureField": { + "type": { + "$ref": "#/1897" + }, + "flags": 0 + }, + "CategoricalMeasureField": { + "type": { + "$ref": "#/1902" + }, + "flags": 0 + }, + "DateMeasureField": { + "type": { + "$ref": "#/1978" + }, + "flags": 0 + }, + "NumericalMeasureField": { + "type": { + "$ref": "#/2191" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "MetricComparisonComputation", + "properties": { + "ComputationId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "FromValue": { + "type": { + "$ref": "#/2168" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "TargetValue": { + "type": { + "$ref": "#/2168" + }, + "flags": 0 + }, + "Time": { + "type": { + "$ref": "#/2006" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "MinimumLabelType", + "properties": { + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "MissingDataConfiguration", + "properties": { + "TreatmentOption": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "MissingDataTreatmentOption", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "NegativeValueConfiguration", + "properties": { + "DisplayMode": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "NegativeValueDisplayMode", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "NullValueFormatConfiguration", + "properties": { + "NullString": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "NumberDisplayFormatConfiguration", + "properties": { + "DecimalPlacesConfiguration": { + "type": { + "$ref": "#/1988" + }, + "flags": 0 + }, + "NegativeValueConfiguration": { + "type": { + "$ref": "#/2173" + }, + "flags": 0 + }, + "NullValueFormatConfiguration": { + "type": { + "$ref": "#/2175" + }, + "flags": 0 + }, + "NumberScale": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Prefix": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "SeparatorConfiguration": { + "type": { + "$ref": "#/2187" + }, + "flags": 0 + }, + "Suffix": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "NumberFormatConfiguration", + "properties": { + "FormatConfiguration": { + "type": { + "$ref": "#/2184" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "NumberScale", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "NumericAxisOptions", + "properties": { + "Range": { + "type": { + "$ref": "#/1869" + }, + "flags": 0 + }, + "Scale": { + "type": { + "$ref": "#/1874" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "NumericEqualityDrillDownFilter", + "properties": { + "Column": { + "type": { + "$ref": "#/1918" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "NumericEqualityFilter", + "properties": { + "AggregationFunction": { + "type": { + "$ref": "#/1850" + }, + "flags": 0 + }, + "Column": { + "type": { + "$ref": "#/1918" + }, + "flags": 1 + }, + "DefaultFilterControlConfiguration": { + "type": { + "$ref": "#/1991" + }, + "flags": 0 + }, + "FilterId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "MatchOperator": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "NullOption": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "ParameterName": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "SelectAllOptions": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "NumericEqualityMatchOperator", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "NumericFilterSelectAllOptions", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "NumericFormatConfiguration", + "properties": { + "CurrencyDisplayFormatConfiguration": { + "type": { + "$ref": "#/1944" + }, + "flags": 0 + }, + "NumberDisplayFormatConfiguration": { + "type": { + "$ref": "#/2176" + }, + "flags": 0 + }, + "PercentageDisplayFormatConfiguration": { + "type": { + "$ref": "#/2210" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "NumericRangeFilter", + "properties": { + "AggregationFunction": { + "type": { + "$ref": "#/1850" + }, + "flags": 0 + }, + "Column": { + "type": { + "$ref": "#/1918" + }, + "flags": 1 + }, + "DefaultFilterControlConfiguration": { + "type": { + "$ref": "#/1991" + }, + "flags": 0 + }, + "FilterId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "IncludeMaximum": { + "type": { + "$ref": "#/650" + }, + "flags": 0 + }, + "IncludeMinimum": { + "type": { + "$ref": "#/650" + }, + "flags": 0 + }, + "NullOption": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "RangeMaximum": { + "type": { + "$ref": "#/2186" + }, + "flags": 0 + }, + "RangeMinimum": { + "type": { + "$ref": "#/2186" + }, + "flags": 0 + }, + "SelectAllOptions": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "NumericRangeFilterValue", + "properties": { + "Parameter": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "StaticValue": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "NumericSeparatorConfiguration", + "properties": { + "DecimalSeparator": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ThousandsSeparator": { + "type": { + "$ref": "#/2389" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "NumericSeparatorSymbol", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "NumericalAggregationFunction", + "properties": { + "PercentileAggregation": { + "type": { + "$ref": "#/2211" + }, + "flags": 0 + }, + "SimpleNumericalAggregation": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "NumericalDimensionField", + "properties": { + "Column": { + "type": { + "$ref": "#/1918" + }, + "flags": 1 + }, + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "FormatConfiguration": { + "type": { + "$ref": "#/2177" + }, + "flags": 0 + }, + "HierarchyId": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "NumericalMeasureField", + "properties": { + "AggregationFunction": { + "type": { + "$ref": "#/2189" + }, + "flags": 0 + }, + "Column": { + "type": { + "$ref": "#/1918" + }, + "flags": 1 + }, + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "FormatConfiguration": { + "type": { + "$ref": "#/2177" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "OtherCategories", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PaginationConfiguration", + "properties": { + "PageNumber": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + }, + "PageSize": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "PanelBorderStyle", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PanelConfiguration", + "properties": { + "BackgroundColor": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "BackgroundVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "BorderColor": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "BorderStyle": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "BorderThickness": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "String based length that is composed of value and unit in px" + }, + "BorderVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "GutterSpacing": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "String based length that is composed of value and unit in px" + }, + "GutterVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/2196" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PanelTitleOptions", + "properties": { + "FontConfiguration": { + "type": { + "$ref": "#/2048" + }, + "flags": 0 + }, + "HorizontalTextAlignment": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PaperOrientation", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PaperSize", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ParameterControl", + "properties": { + "DateTimePicker": { + "type": { + "$ref": "#/2200" + }, + "flags": 0 + }, + "Dropdown": { + "type": { + "$ref": "#/2202" + }, + "flags": 0 + }, + "List": { + "type": { + "$ref": "#/2203" + }, + "flags": 0 + }, + "Slider": { + "type": { + "$ref": "#/2205" + }, + "flags": 0 + }, + "TextArea": { + "type": { + "$ref": "#/2206" + }, + "flags": 0 + }, + "TextField": { + "type": { + "$ref": "#/2207" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ParameterDateTimePickerControl", + "properties": { + "DisplayOptions": { + "type": { + "$ref": "#/1983" + }, + "flags": 0 + }, + "ParameterControlId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "SourceParameterName": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Title": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ParameterDeclaration", + "properties": { + "DateTimeParameterDeclaration": { + "type": { + "$ref": "#/1982" + }, + "flags": 0 + }, + "DecimalParameterDeclaration": { + "type": { + "$ref": "#/1987" + }, + "flags": 0 + }, + "IntegerParameterDeclaration": { + "type": { + "$ref": "#/2118" + }, + "flags": 0 + }, + "StringParameterDeclaration": { + "type": { + "$ref": "#/2338" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ParameterDropDownControl", + "properties": { + "CascadingControlConfiguration": { + "type": { + "$ref": "#/1898" + }, + "flags": 0 + }, + "DisplayOptions": { + "type": { + "$ref": "#/2010" + }, + "flags": 0 + }, + "ParameterControlId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "SelectableValues": { + "type": { + "$ref": "#/2204" + }, + "flags": 0 + }, + "SourceParameterName": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Title": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Type": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ParameterListControl", + "properties": { + "CascadingControlConfiguration": { + "type": { + "$ref": "#/1898" + }, + "flags": 0 + }, + "DisplayOptions": { + "type": { + "$ref": "#/2157" + }, + "flags": 0 + }, + "ParameterControlId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "SelectableValues": { + "type": { + "$ref": "#/2204" + }, + "flags": 0 + }, + "SourceParameterName": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Title": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Type": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ParameterSelectableValues", + "properties": { + "LinkToDataSetColumn": { + "type": { + "$ref": "#/1918" + }, + "flags": 0 + }, + "Values": { + "type": { + "$ref": "#/2569" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ParameterSliderControl", + "properties": { + "DisplayOptions": { + "type": { + "$ref": "#/2328" + }, + "flags": 0 + }, + "MaximumValue": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + }, + "MinimumValue": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + }, + "ParameterControlId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "SourceParameterName": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "StepSize": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + }, + "Title": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ParameterTextAreaControl", + "properties": { + "Delimiter": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "DisplayOptions": { + "type": { + "$ref": "#/2384" + }, + "flags": 0 + }, + "ParameterControlId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "SourceParameterName": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Title": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ParameterTextFieldControl", + "properties": { + "DisplayOptions": { + "type": { + "$ref": "#/2387" + }, + "flags": 0 + }, + "ParameterControlId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "SourceParameterName": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Title": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ParameterValueType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PercentVisibleRange", + "properties": { + "From": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "To": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PercentageDisplayFormatConfiguration", + "properties": { + "DecimalPlacesConfiguration": { + "type": { + "$ref": "#/1988" + }, + "flags": 0 + }, + "NegativeValueConfiguration": { + "type": { + "$ref": "#/2173" + }, + "flags": 0 + }, + "NullValueFormatConfiguration": { + "type": { + "$ref": "#/2175" + }, + "flags": 0 + }, + "Prefix": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "SeparatorConfiguration": { + "type": { + "$ref": "#/2187" + }, + "flags": 0 + }, + "Suffix": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PercentileAggregation", + "properties": { + "PercentileValue": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PeriodOverPeriodComputation", + "properties": { + "ComputationId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Time": { + "type": { + "$ref": "#/2006" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/2168" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PeriodToDateComputation", + "properties": { + "ComputationId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "PeriodTimeGranularity": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Time": { + "type": { + "$ref": "#/2006" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/2168" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PieChartAggregatedFieldWells", + "properties": { + "Category": { + "type": { + "$ref": "#/2570" + }, + "flags": 0 + }, + "SmallMultiples": { + "type": { + "$ref": "#/2571" + }, + "flags": 0 + }, + "Values": { + "type": { + "$ref": "#/2572" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PieChartConfiguration", + "properties": { + "CategoryLabelOptions": { + "type": { + "$ref": "#/1908" + }, + "flags": 0 + }, + "ContributionAnalysisDefaults": { + "type": { + "$ref": "#/2573" + }, + "flags": 0 + }, + "DataLabels": { + "type": { + "$ref": "#/1963" + }, + "flags": 0 + }, + "DonutOptions": { + "type": { + "$ref": "#/2008" + }, + "flags": 0 + }, + "FieldWells": { + "type": { + "$ref": "#/2216" + }, + "flags": 0 + }, + "Legend": { + "type": { + "$ref": "#/2141" + }, + "flags": 0 + }, + "SmallMultiplesOptions": { + "type": { + "$ref": "#/2332" + }, + "flags": 0 + }, + "SortConfiguration": { + "type": { + "$ref": "#/2217" + }, + "flags": 0 + }, + "Tooltip": { + "type": { + "$ref": "#/2397" + }, + "flags": 0 + }, + "ValueLabelOptions": { + "type": { + "$ref": "#/1908" + }, + "flags": 0 + }, + "VisualPalette": { + "type": { + "$ref": "#/2427" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PieChartFieldWells", + "properties": { + "PieChartAggregatedFieldWells": { + "type": { + "$ref": "#/2214" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PieChartSortConfiguration", + "properties": { + "CategoryItemsLimit": { + "type": { + "$ref": "#/2120" + }, + "flags": 0 + }, + "CategorySort": { + "type": { + "$ref": "#/2574" + }, + "flags": 0 + }, + "SmallMultiplesLimitConfiguration": { + "type": { + "$ref": "#/2120" + }, + "flags": 0 + }, + "SmallMultiplesSort": { + "type": { + "$ref": "#/2575" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PieChartVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/2576" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/2215" + }, + "flags": 0 + }, + "ColumnHierarchies": { + "type": { + "$ref": "#/2577" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/2428" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/2429" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotFieldSortOptions", + "properties": { + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "SortBy": { + "type": { + "$ref": "#/2241" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTableAggregatedFieldWells", + "properties": { + "Columns": { + "type": { + "$ref": "#/2578" + }, + "flags": 0 + }, + "Rows": { + "type": { + "$ref": "#/2579" + }, + "flags": 0 + }, + "Values": { + "type": { + "$ref": "#/2580" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTableCellConditionalFormatting", + "properties": { + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Scope": { + "type": { + "$ref": "#/2224" + }, + "flags": 0 + }, + "Scopes": { + "type": { + "$ref": "#/2581" + }, + "flags": 0 + }, + "TextFormat": { + "type": { + "$ref": "#/2385" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTableConditionalFormatting", + "properties": { + "ConditionalFormattingOptions": { + "type": { + "$ref": "#/2582" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTableConditionalFormattingOption", + "properties": { + "Cell": { + "type": { + "$ref": "#/2221" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTableConditionalFormattingScope", + "properties": { + "Role": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTableConditionalFormattingScopeRole", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PivotTableConfiguration", + "properties": { + "FieldOptions": { + "type": { + "$ref": "#/2233" + }, + "flags": 0 + }, + "FieldWells": { + "type": { + "$ref": "#/2235" + }, + "flags": 0 + }, + "PaginatedReportOptions": { + "type": { + "$ref": "#/2238" + }, + "flags": 0 + }, + "SortConfiguration": { + "type": { + "$ref": "#/2242" + }, + "flags": 0 + }, + "TableOptions": { + "type": { + "$ref": "#/2237" + }, + "flags": 0 + }, + "TotalOptions": { + "type": { + "$ref": "#/2244" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTableDataPathOption", + "properties": { + "DataPathList": { + "type": { + "$ref": "#/2583" + }, + "flags": 1 + }, + "Width": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "String based length that is composed of value and unit in px" + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTableDataPathType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PivotTableFieldCollapseState", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PivotTableFieldCollapseStateOption", + "properties": { + "State": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Target": { + "type": { + "$ref": "#/2231" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTableFieldCollapseStateTarget", + "properties": { + "FieldDataPathValues": { + "type": { + "$ref": "#/2584" + }, + "flags": 0 + }, + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTableFieldOption", + "properties": { + "CustomLabel": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTableFieldOptions", + "properties": { + "CollapseStateOptions": { + "type": { + "$ref": "#/2585" + }, + "flags": 0 + }, + "DataPathOptions": { + "type": { + "$ref": "#/2586" + }, + "flags": 0 + }, + "SelectedFieldOptions": { + "type": { + "$ref": "#/2587" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTableFieldSubtotalOptions", + "properties": { + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTableFieldWells", + "properties": { + "PivotTableAggregatedFieldWells": { + "type": { + "$ref": "#/2220" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTableMetricPlacement", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PivotTableOptions", + "properties": { + "CellStyle": { + "type": { + "$ref": "#/2348" + }, + "flags": 0 + }, + "CollapsedRowDimensionsVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ColumnHeaderStyle": { + "type": { + "$ref": "#/2348" + }, + "flags": 0 + }, + "ColumnNamesVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "DefaultCellWidth": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "String based length that is composed of value and unit in px" + }, + "MetricPlacement": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "RowAlternateColorOptions": { + "type": { + "$ref": "#/2281" + }, + "flags": 0 + }, + "RowFieldNamesStyle": { + "type": { + "$ref": "#/2348" + }, + "flags": 0 + }, + "RowHeaderStyle": { + "type": { + "$ref": "#/2348" + }, + "flags": 0 + }, + "RowsLabelOptions": { + "type": { + "$ref": "#/2239" + }, + "flags": 0 + }, + "RowsLayout": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "SingleMetricVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ToggleButtonsVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTablePaginatedReportOptions", + "properties": { + "OverflowColumnHeaderVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "VerticalOverflowVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTableRowsLabelOptions", + "properties": { + "CustomLabel": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTableRowsLayout", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PivotTableSortBy", + "properties": { + "Column": { + "type": { + "$ref": "#/1921" + }, + "flags": 0 + }, + "DataPath": { + "type": { + "$ref": "#/1969" + }, + "flags": 0 + }, + "Field": { + "type": { + "$ref": "#/2019" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTableSortConfiguration", + "properties": { + "FieldSortOptions": { + "type": { + "$ref": "#/2588" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTableSubtotalLevel", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PivotTableTotalOptions", + "properties": { + "ColumnSubtotalOptions": { + "type": { + "$ref": "#/2341" + }, + "flags": 0 + }, + "ColumnTotalOptions": { + "type": { + "$ref": "#/2246" + }, + "flags": 0 + }, + "RowSubtotalOptions": { + "type": { + "$ref": "#/2341" + }, + "flags": 0 + }, + "RowTotalOptions": { + "type": { + "$ref": "#/2246" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTableVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/2589" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/2226" + }, + "flags": 0 + }, + "ConditionalFormatting": { + "type": { + "$ref": "#/2222" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/2428" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/2429" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "PivotTotalOptions", + "properties": { + "CustomLabel": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "MetricHeaderCellStyle": { + "type": { + "$ref": "#/2348" + }, + "flags": 0 + }, + "Placement": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ScrollStatus": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "TotalAggregationOptions": { + "type": { + "$ref": "#/2590" + }, + "flags": 0 + }, + "TotalCellStyle": { + "type": { + "$ref": "#/2348" + }, + "flags": 0 + }, + "TotalsVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ValueCellStyle": { + "type": { + "$ref": "#/2348" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PredefinedHierarchy", + "properties": { + "Columns": { + "type": { + "$ref": "#/2591" + }, + "flags": 1 + }, + "DrillDownFilters": { + "type": { + "$ref": "#/2592" + }, + "flags": 0 + }, + "HierarchyId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "PrimaryValueDisplayType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ProgressBarOptions", + "properties": { + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "RadarChartAggregatedFieldWells", + "properties": { + "Category": { + "type": { + "$ref": "#/2593" + }, + "flags": 0 + }, + "Color": { + "type": { + "$ref": "#/2594" + }, + "flags": 0 + }, + "Values": { + "type": { + "$ref": "#/2595" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "RadarChartAreaStyleSettings", + "properties": { + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "RadarChartAxesRangeScale", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RadarChartConfiguration", + "properties": { + "AlternateBandColorsVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "AlternateBandEvenColor": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "AlternateBandOddColor": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "AxesRangeScale": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "BaseSeriesSettings": { + "type": { + "$ref": "#/2255" + }, + "flags": 0 + }, + "CategoryAxis": { + "type": { + "$ref": "#/1868" + }, + "flags": 0 + }, + "CategoryLabelOptions": { + "type": { + "$ref": "#/1908" + }, + "flags": 0 + }, + "ColorAxis": { + "type": { + "$ref": "#/1868" + }, + "flags": 0 + }, + "ColorLabelOptions": { + "type": { + "$ref": "#/1908" + }, + "flags": 0 + }, + "FieldWells": { + "type": { + "$ref": "#/2254" + }, + "flags": 0 + }, + "Legend": { + "type": { + "$ref": "#/2141" + }, + "flags": 0 + }, + "Shape": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "SortConfiguration": { + "type": { + "$ref": "#/2257" + }, + "flags": 0 + }, + "StartAngle": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "VisualPalette": { + "type": { + "$ref": "#/2427" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "RadarChartFieldWells", + "properties": { + "RadarChartAggregatedFieldWells": { + "type": { + "$ref": "#/2250" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "RadarChartSeriesSettings", + "properties": { + "AreaStyleSettings": { + "type": { + "$ref": "#/2251" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "RadarChartShape", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RadarChartSortConfiguration", + "properties": { + "CategoryItemsLimit": { + "type": { + "$ref": "#/2120" + }, + "flags": 0 + }, + "CategorySort": { + "type": { + "$ref": "#/2596" + }, + "flags": 0 + }, + "ColorItemsLimit": { + "type": { + "$ref": "#/2120" + }, + "flags": 0 + }, + "ColorSort": { + "type": { + "$ref": "#/2597" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "RadarChartVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/2598" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/2253" + }, + "flags": 0 + }, + "ColumnHierarchies": { + "type": { + "$ref": "#/2599" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/2428" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/2429" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "RangeEndsLabelType", + "properties": { + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ReferenceLine", + "properties": { + "DataConfiguration": { + "type": { + "$ref": "#/2262" + }, + "flags": 1 + }, + "LabelConfiguration": { + "type": { + "$ref": "#/2264" + }, + "flags": 0 + }, + "Status": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "StyleConfiguration": { + "type": { + "$ref": "#/2270" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ReferenceLineCustomLabelConfiguration", + "properties": { + "CustomLabel": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ReferenceLineDataConfiguration", + "properties": { + "AxisBinding": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "DynamicConfiguration": { + "type": { + "$ref": "#/2263" + }, + "flags": 0 + }, + "SeriesType": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "StaticConfiguration": { + "type": { + "$ref": "#/2269" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ReferenceLineDynamicDataConfiguration", + "properties": { + "Calculation": { + "type": { + "$ref": "#/2189" + }, + "flags": 1 + }, + "Column": { + "type": { + "$ref": "#/1918" + }, + "flags": 1 + }, + "MeasureAggregationFunction": { + "type": { + "$ref": "#/1850" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ReferenceLineLabelConfiguration", + "properties": { + "CustomLabelConfiguration": { + "type": { + "$ref": "#/2261" + }, + "flags": 0 + }, + "FontColor": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "FontConfiguration": { + "type": { + "$ref": "#/2048" + }, + "flags": 0 + }, + "HorizontalPosition": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ValueLabelConfiguration": { + "type": { + "$ref": "#/2271" + }, + "flags": 0 + }, + "VerticalPosition": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ReferenceLineLabelHorizontalPosition", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ReferenceLineLabelVerticalPosition", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ReferenceLinePatternType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ReferenceLineSeriesType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ReferenceLineStaticDataConfiguration", + "properties": { + "Value": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ReferenceLineStyleConfiguration", + "properties": { + "Color": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Pattern": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ReferenceLineValueLabelConfiguration", + "properties": { + "FormatConfiguration": { + "type": { + "$ref": "#/2184" + }, + "flags": 0 + }, + "RelativePosition": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ReferenceLineValueLabelRelativePosition", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RelativeDateTimeControlDisplayOptions", + "properties": { + "DateTimeFormat": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "InfoIconLabelOptions": { + "type": { + "$ref": "#/2313" + }, + "flags": 0 + }, + "TitleOptions": { + "type": { + "$ref": "#/2137" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "RelativeDateType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RelativeDatesFilter", + "properties": { + "AnchorDateConfiguration": { + "type": { + "$ref": "#/1854" + }, + "flags": 1 + }, + "Column": { + "type": { + "$ref": "#/1918" + }, + "flags": 1 + }, + "DefaultFilterControlConfiguration": { + "type": { + "$ref": "#/1991" + }, + "flags": 0 + }, + "ExcludePeriodConfiguration": { + "type": { + "$ref": "#/2014" + }, + "flags": 0 + }, + "FilterId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "MinimumGranularity": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "NullOption": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "ParameterName": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "RelativeDateType": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "RelativeDateValue": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "TimeGranularity": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "RelativeFontSize", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ResizeOption", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ResourcePermission", + "properties": { + "Actions": { + "type": { + "$ref": "#/2600" + }, + "flags": 1, + "description": "

The IAM action to grant or revoke permissions on.

" + }, + "Principal": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

The Amazon Resource Name (ARN) of the principal. This can be one of the\n following:

\n
    \n
  • \n

    The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

    \n
    • \n
  • \n

    The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)

    \n
    • \n
  • \n

    The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight\n ARN. Use this option only to share resources (templates) across Amazon Web Services accounts.\n (This is less common.)

    \n
    • \n
" + } + } + }, + { + "$type": "ObjectType", + "name": "ResourceStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RollingDateConfiguration", + "properties": { + "DataSetIdentifier": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Expression": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "RowAlternateColorOptions", + "properties": { + "RowAlternateColors": { + "type": { + "$ref": "#/2601" + }, + "flags": 0 + }, + "Status": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "UsePrimaryBackgroundColor": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SameSheetTargetVisualConfiguration", + "properties": { + "TargetVisualOptions": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "TargetVisuals": { + "type": { + "$ref": "#/2602" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SankeyDiagramAggregatedFieldWells", + "properties": { + "Destination": { + "type": { + "$ref": "#/2603" + }, + "flags": 0 + }, + "Source": { + "type": { + "$ref": "#/2604" + }, + "flags": 0 + }, + "Weight": { + "type": { + "$ref": "#/2605" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SankeyDiagramChartConfiguration", + "properties": { + "DataLabels": { + "type": { + "$ref": "#/1963" + }, + "flags": 0 + }, + "FieldWells": { + "type": { + "$ref": "#/2285" + }, + "flags": 0 + }, + "SortConfiguration": { + "type": { + "$ref": "#/2286" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SankeyDiagramFieldWells", + "properties": { + "SankeyDiagramAggregatedFieldWells": { + "type": { + "$ref": "#/2283" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SankeyDiagramSortConfiguration", + "properties": { + "DestinationItemsLimit": { + "type": { + "$ref": "#/2120" + }, + "flags": 0 + }, + "SourceItemsLimit": { + "type": { + "$ref": "#/2120" + }, + "flags": 0 + }, + "WeightSort": { + "type": { + "$ref": "#/2606" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SankeyDiagramVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/2607" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/2284" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/2428" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/2429" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ScatterPlotCategoricallyAggregatedFieldWells", + "properties": { + "Category": { + "type": { + "$ref": "#/2608" + }, + "flags": 0 + }, + "Label": { + "type": { + "$ref": "#/2609" + }, + "flags": 0 + }, + "Size": { + "type": { + "$ref": "#/2610" + }, + "flags": 0 + }, + "XAxis": { + "type": { + "$ref": "#/2611" + }, + "flags": 0 + }, + "YAxis": { + "type": { + "$ref": "#/2612" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ScatterPlotConfiguration", + "properties": { + "DataLabels": { + "type": { + "$ref": "#/1963" + }, + "flags": 0 + }, + "FieldWells": { + "type": { + "$ref": "#/2290" + }, + "flags": 0 + }, + "Legend": { + "type": { + "$ref": "#/2141" + }, + "flags": 0 + }, + "Tooltip": { + "type": { + "$ref": "#/2397" + }, + "flags": 0 + }, + "VisualPalette": { + "type": { + "$ref": "#/2427" + }, + "flags": 0 + }, + "XAxisDisplayOptions": { + "type": { + "$ref": "#/1868" + }, + "flags": 0 + }, + "XAxisLabelOptions": { + "type": { + "$ref": "#/1908" + }, + "flags": 0 + }, + "YAxisDisplayOptions": { + "type": { + "$ref": "#/1868" + }, + "flags": 0 + }, + "YAxisLabelOptions": { + "type": { + "$ref": "#/1908" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ScatterPlotFieldWells", + "properties": { + "ScatterPlotCategoricallyAggregatedFieldWells": { + "type": { + "$ref": "#/2288" + }, + "flags": 0 + }, + "ScatterPlotUnaggregatedFieldWells": { + "type": { + "$ref": "#/2291" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ScatterPlotUnaggregatedFieldWells", + "properties": { + "Category": { + "type": { + "$ref": "#/2613" + }, + "flags": 0 + }, + "Label": { + "type": { + "$ref": "#/2614" + }, + "flags": 0 + }, + "Size": { + "type": { + "$ref": "#/2615" + }, + "flags": 0 + }, + "XAxis": { + "type": { + "$ref": "#/2616" + }, + "flags": 0 + }, + "YAxis": { + "type": { + "$ref": "#/2617" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ScatterPlotVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/2618" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/2289" + }, + "flags": 0 + }, + "ColumnHierarchies": { + "type": { + "$ref": "#/2619" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/2428" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/2429" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ScrollBarOptions", + "properties": { + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "VisibleRange": { + "type": { + "$ref": "#/2422" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SecondaryValueOptions", + "properties": { + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SectionAfterPageBreak", + "properties": { + "Status": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SectionBasedLayoutCanvasSizeOptions", + "properties": { + "PaperCanvasSizeOptions": { + "type": { + "$ref": "#/2298" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SectionBasedLayoutConfiguration", + "properties": { + "BodySections": { + "type": { + "$ref": "#/2620" + }, + "flags": 1 + }, + "CanvasSizeOptions": { + "type": { + "$ref": "#/2296" + }, + "flags": 1 + }, + "FooterSections": { + "type": { + "$ref": "#/2621" + }, + "flags": 1 + }, + "HeaderSections": { + "type": { + "$ref": "#/2622" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "SectionBasedLayoutPaperCanvasSizeOptions", + "properties": { + "PaperMargin": { + "type": { + "$ref": "#/2334" + }, + "flags": 0 + }, + "PaperOrientation": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "PaperSize": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SectionLayoutConfiguration", + "properties": { + "FreeFormLayout": { + "type": { + "$ref": "#/2065" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "SectionPageBreakConfiguration", + "properties": { + "After": { + "type": { + "$ref": "#/2295" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SectionPageBreakStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SectionStyle", + "properties": { + "Height": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "String based length that is composed of value and unit in px" + }, + "Padding": { + "type": { + "$ref": "#/2334" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SelectAllValueOptions", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SelectedFieldOptions", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SelectedSheetsFilterScopeConfiguration", + "properties": { + "SheetVisualScopingConfigurations": { + "type": { + "$ref": "#/2623" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SelectedTooltipType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SeriesItem", + "properties": { + "DataFieldSeriesItem": { + "type": { + "$ref": "#/1961" + }, + "flags": 0 + }, + "FieldSeriesItem": { + "type": { + "$ref": "#/2018" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SetParameterValueConfiguration", + "properties": { + "DestinationParameterName": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/2005" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ShapeConditionalFormat", + "properties": { + "BackgroundColor": { + "type": { + "$ref": "#/1932" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Sheet", + "properties": { + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The name of a sheet. This name is displayed on the sheet's tab in the Amazon QuickSight\n console.

" + }, + "SheetId": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The unique identifier associated with a sheet.

" + } + } + }, + { + "$type": "ObjectType", + "name": "SheetContentType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SheetControlDateTimePickerType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SheetControlInfoIconLabelOptions", + "properties": { + "InfoIconText": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SheetControlLayout", + "properties": { + "Configuration": { + "type": { + "$ref": "#/2315" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "SheetControlLayoutConfiguration", + "properties": { + "GridLayout": { + "type": { + "$ref": "#/2097" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SheetControlListType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SheetControlSliderType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SheetDefinition", + "properties": { + "ContentType": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Description": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "FilterControls": { + "type": { + "$ref": "#/2624" + }, + "flags": 0 + }, + "Layouts": { + "type": { + "$ref": "#/2625" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ParameterControls": { + "type": { + "$ref": "#/2626" + }, + "flags": 0 + }, + "SheetControlLayouts": { + "type": { + "$ref": "#/2627" + }, + "flags": 0 + }, + "SheetId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "TextBoxes": { + "type": { + "$ref": "#/2628" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Visuals": { + "type": { + "$ref": "#/2629" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SheetElementConfigurationOverrides", + "properties": { + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SheetElementRenderingRule", + "properties": { + "ConfigurationOverrides": { + "type": { + "$ref": "#/2319" + }, + "flags": 1 + }, + "Expression": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "SheetTextBox", + "properties": { + "Content": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "SheetTextBoxId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "SheetVisualScopingConfiguration", + "properties": { + "Scope": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "SheetId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "VisualIds": { + "type": { + "$ref": "#/2630" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ShortFormatText", + "properties": { + "PlainText": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "RichText": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SimpleAttributeAggregationFunction", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SimpleClusterMarker", + "properties": { + "Color": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SimpleNumericalAggregationFunction", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SimpleTotalAggregationFunction", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SliderControlDisplayOptions", + "properties": { + "InfoIconLabelOptions": { + "type": { + "$ref": "#/2313" + }, + "flags": 0 + }, + "TitleOptions": { + "type": { + "$ref": "#/2137" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SmallMultiplesAxisPlacement", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SmallMultiplesAxisProperties", + "properties": { + "Placement": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Scale": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SmallMultiplesAxisScale", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SmallMultiplesOptions", + "properties": { + "MaxVisibleColumns": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "MaxVisibleRows": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "PanelConfiguration": { + "type": { + "$ref": "#/2195" + }, + "flags": 0 + }, + "XAxis": { + "type": { + "$ref": "#/2330" + }, + "flags": 0 + }, + "YAxis": { + "type": { + "$ref": "#/2330" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SortDirection", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Spacing", + "properties": { + "Bottom": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "String based length that is composed of value and unit" + }, + "Left": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "String based length that is composed of value and unit" + }, + "Right": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "String based length that is composed of value and unit" + }, + "Top": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "String based length that is composed of value and unit" + } + } + }, + { + "$type": "ObjectType", + "name": "SpecialValue", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "StringDefaultValues", + "properties": { + "DynamicValue": { + "type": { + "$ref": "#/2011" + }, + "flags": 0 + }, + "StaticValues": { + "type": { + "$ref": "#/2631" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "StringFormatConfiguration", + "properties": { + "NullValueFormatConfiguration": { + "type": { + "$ref": "#/2175" + }, + "flags": 0 + }, + "NumericFormatConfiguration": { + "type": { + "$ref": "#/2184" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "StringParameterDeclaration", + "properties": { + "DefaultValues": { + "type": { + "$ref": "#/2336" + }, + "flags": 0 + }, + "MappedDataSetParameters": { + "type": { + "$ref": "#/2632" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "ParameterValueType": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "ValueWhenUnset": { + "type": { + "$ref": "#/2339" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "StringValueWhenUnsetConfiguration", + "properties": { + "CustomValue": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ValueWhenUnsetOption": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "StyledCellType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SubtotalOptions", + "properties": { + "CustomLabel": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "FieldLevel": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "FieldLevelOptions": { + "type": { + "$ref": "#/2633" + }, + "flags": 0 + }, + "MetricHeaderCellStyle": { + "type": { + "$ref": "#/2348" + }, + "flags": 0 + }, + "StyleTargets": { + "type": { + "$ref": "#/2634" + }, + "flags": 0 + }, + "TotalCellStyle": { + "type": { + "$ref": "#/2348" + }, + "flags": 0 + }, + "TotalsVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ValueCellStyle": { + "type": { + "$ref": "#/2348" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableAggregatedFieldWells", + "properties": { + "GroupBy": { + "type": { + "$ref": "#/2635" + }, + "flags": 0 + }, + "Values": { + "type": { + "$ref": "#/2636" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableBorderOptions", + "properties": { + "Color": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Style": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Thickness": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableBorderStyle", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TableCellConditionalFormatting", + "properties": { + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "TextFormat": { + "type": { + "$ref": "#/2385" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableCellImageScalingConfiguration", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TableCellImageSizingConfiguration", + "properties": { + "TableCellImageScalingConfiguration": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableCellStyle", + "properties": { + "BackgroundColor": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Border": { + "type": { + "$ref": "#/2093" + }, + "flags": 0 + }, + "FontConfiguration": { + "type": { + "$ref": "#/2048" + }, + "flags": 0 + }, + "Height": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "HorizontalTextAlignment": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "TextWrap": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "VerticalTextAlignment": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableConditionalFormatting", + "properties": { + "ConditionalFormattingOptions": { + "type": { + "$ref": "#/2637" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableConditionalFormattingOption", + "properties": { + "Cell": { + "type": { + "$ref": "#/2345" + }, + "flags": 0 + }, + "Row": { + "type": { + "$ref": "#/2367" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableConfiguration", + "properties": { + "FieldOptions": { + "type": { + "$ref": "#/2359" + }, + "flags": 0 + }, + "FieldWells": { + "type": { + "$ref": "#/2361" + }, + "flags": 0 + }, + "PaginatedReportOptions": { + "type": { + "$ref": "#/2365" + }, + "flags": 0 + }, + "SortConfiguration": { + "type": { + "$ref": "#/2369" + }, + "flags": 0 + }, + "TableInlineVisualizations": { + "type": { + "$ref": "#/2638" + }, + "flags": 0 + }, + "TableOptions": { + "type": { + "$ref": "#/2363" + }, + "flags": 0 + }, + "TotalOptions": { + "type": { + "$ref": "#/2407" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableFieldCustomIconContent", + "properties": { + "Icon": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableFieldCustomTextContent", + "properties": { + "FontConfiguration": { + "type": { + "$ref": "#/2048" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableFieldIconSetType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TableFieldImageConfiguration", + "properties": { + "SizingOptions": { + "type": { + "$ref": "#/2347" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableFieldLinkConfiguration", + "properties": { + "Content": { + "type": { + "$ref": "#/2357" + }, + "flags": 1 + }, + "Target": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TableFieldLinkContentConfiguration", + "properties": { + "CustomIconContent": { + "type": { + "$ref": "#/2352" + }, + "flags": 0 + }, + "CustomTextContent": { + "type": { + "$ref": "#/2353" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableFieldOption", + "properties": { + "CustomLabel": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "URLStyling": { + "type": { + "$ref": "#/2360" + }, + "flags": 0 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Width": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "String based length that is composed of value and unit in px" + } + } + }, + { + "$type": "ObjectType", + "name": "TableFieldOptions", + "properties": { + "Order": { + "type": { + "$ref": "#/2639" + }, + "flags": 0 + }, + "PinnedFieldOptions": { + "type": { + "$ref": "#/2366" + }, + "flags": 0 + }, + "SelectedFieldOptions": { + "type": { + "$ref": "#/2640" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableFieldURLConfiguration", + "properties": { + "ImageConfiguration": { + "type": { + "$ref": "#/2355" + }, + "flags": 0 + }, + "LinkConfiguration": { + "type": { + "$ref": "#/2356" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableFieldWells", + "properties": { + "TableAggregatedFieldWells": { + "type": { + "$ref": "#/2342" + }, + "flags": 0 + }, + "TableUnaggregatedFieldWells": { + "type": { + "$ref": "#/2373" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableInlineVisualization", + "properties": { + "DataBars": { + "type": { + "$ref": "#/1959" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableOptions", + "properties": { + "CellStyle": { + "type": { + "$ref": "#/2348" + }, + "flags": 0 + }, + "HeaderStyle": { + "type": { + "$ref": "#/2348" + }, + "flags": 0 + }, + "Orientation": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "RowAlternateColorOptions": { + "type": { + "$ref": "#/2281" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableOrientation", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TablePaginatedReportOptions", + "properties": { + "OverflowColumnHeaderVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "VerticalOverflowVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TablePinnedFieldOptions", + "properties": { + "PinnedLeftFields": { + "type": { + "$ref": "#/2641" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableRowConditionalFormatting", + "properties": { + "BackgroundColor": { + "type": { + "$ref": "#/1932" + }, + "flags": 0 + }, + "TextColor": { + "type": { + "$ref": "#/1932" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableSideBorderOptions", + "properties": { + "Bottom": { + "type": { + "$ref": "#/2343" + }, + "flags": 0 + }, + "InnerHorizontal": { + "type": { + "$ref": "#/2343" + }, + "flags": 0 + }, + "InnerVertical": { + "type": { + "$ref": "#/2343" + }, + "flags": 0 + }, + "Left": { + "type": { + "$ref": "#/2343" + }, + "flags": 0 + }, + "Right": { + "type": { + "$ref": "#/2343" + }, + "flags": 0 + }, + "Top": { + "type": { + "$ref": "#/2343" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableSortConfiguration", + "properties": { + "PaginationConfiguration": { + "type": { + "$ref": "#/2193" + }, + "flags": 0 + }, + "RowSort": { + "type": { + "$ref": "#/2642" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableStyleTarget", + "properties": { + "CellType": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TableTotalsPlacement", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TableTotalsScrollStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TableUnaggregatedFieldWells", + "properties": { + "Values": { + "type": { + "$ref": "#/2643" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TableVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/2644" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/2351" + }, + "flags": 0 + }, + "ConditionalFormatting": { + "type": { + "$ref": "#/2349" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/2428" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/2429" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

Tag key.

" + }, + "Value": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

Tag value.

" + } + } + }, + { + "$type": "ObjectType", + "name": "TargetVisualOptions", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TemplateError", + "properties": { + "Message": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

Description of the error type.

" + }, + "Type": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ViolatedEntities": { + "type": { + "$ref": "#/2645" + }, + "flags": 0, + "description": "

An error path that shows which entities caused the template error.

" + } + } + }, + { + "$type": "ObjectType", + "name": "TemplateErrorType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TemplateSourceAnalysis", + "properties": { + "Arn": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

The Amazon Resource Name (ARN) of the resource.

" + }, + "DataSetReferences": { + "type": { + "$ref": "#/2646" + }, + "flags": 1, + "description": "

A structure containing information about the dataset references used as placeholders\n in the template.

" + } + } + }, + { + "$type": "ObjectType", + "name": "TemplateSourceEntity", + "properties": { + "SourceAnalysis": { + "type": { + "$ref": "#/2379" + }, + "flags": 0 + }, + "SourceTemplate": { + "type": { + "$ref": "#/2381" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TemplateSourceTemplate", + "properties": { + "Arn": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

The Amazon Resource Name (ARN) of the resource.

" + } + } + }, + { + "$type": "ObjectType", + "name": "TemplateVersion", + "properties": { + "CreatedTime": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The time that this template version was created.

" + }, + "DataSetConfigurations": { + "type": { + "$ref": "#/2647" + }, + "flags": 0, + "description": "

Schema of the dataset identified by the placeholder. Any dashboard created from this\n template should be bound to new datasets matching the same schema described through this\n API operation.

" + }, + "Description": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The description of the template.

" + }, + "Errors": { + "type": { + "$ref": "#/2648" + }, + "flags": 0, + "description": "

Errors associated with this template version.

" + }, + "Sheets": { + "type": { + "$ref": "#/2649" + }, + "flags": 0, + "description": "

A list of the associated sheets with the unique identifier and name of each sheet.

" + }, + "SourceEntityArn": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The Amazon Resource Name (ARN) of an analysis or template that was used to create this\n template.

" + }, + "Status": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ThemeArn": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The ARN of the theme associated with this version of the template.

" + }, + "VersionNumber": { + "type": { + "$ref": "#/610" + }, + "flags": 0, + "description": "

The version number of the template version.

" + } + } + }, + { + "$type": "ObjectType", + "name": "TemplateVersionDefinition", + "properties": { + "AnalysisDefaults": { + "type": { + "$ref": "#/1853" + }, + "flags": 0 + }, + "CalculatedFields": { + "type": { + "$ref": "#/2650" + }, + "flags": 0 + }, + "ColumnConfigurations": { + "type": { + "$ref": "#/2651" + }, + "flags": 0 + }, + "DataSetConfigurations": { + "type": { + "$ref": "#/2652" + }, + "flags": 1 + }, + "FilterGroups": { + "type": { + "$ref": "#/2653" + }, + "flags": 0 + }, + "Options": { + "type": { + "$ref": "#/1862" + }, + "flags": 0 + }, + "ParameterDeclarations": { + "type": { + "$ref": "#/2654" + }, + "flags": 0 + }, + "Sheets": { + "type": { + "$ref": "#/2655" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TextAreaControlDisplayOptions", + "properties": { + "InfoIconLabelOptions": { + "type": { + "$ref": "#/2313" + }, + "flags": 0 + }, + "PlaceholderOptions": { + "type": { + "$ref": "#/2386" + }, + "flags": 0 + }, + "TitleOptions": { + "type": { + "$ref": "#/2137" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TextConditionalFormat", + "properties": { + "BackgroundColor": { + "type": { + "$ref": "#/1932" + }, + "flags": 0 + }, + "Icon": { + "type": { + "$ref": "#/1936" + }, + "flags": 0 + }, + "TextColor": { + "type": { + "$ref": "#/1932" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TextControlPlaceholderOptions", + "properties": { + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TextFieldControlDisplayOptions", + "properties": { + "InfoIconLabelOptions": { + "type": { + "$ref": "#/2313" + }, + "flags": 0 + }, + "PlaceholderOptions": { + "type": { + "$ref": "#/2386" + }, + "flags": 0 + }, + "TitleOptions": { + "type": { + "$ref": "#/2137" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TextWrap", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ThousandSeparatorOptions", + "properties": { + "Symbol": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TimeBasedForecastProperties", + "properties": { + "LowerBoundary": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "PeriodsBackward": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "PeriodsForward": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "PredictionInterval": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "Seasonality": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "UpperBoundary": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TimeEqualityFilter", + "properties": { + "Column": { + "type": { + "$ref": "#/1918" + }, + "flags": 1 + }, + "DefaultFilterControlConfiguration": { + "type": { + "$ref": "#/1991" + }, + "flags": 0 + }, + "FilterId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "ParameterName": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "RollingDate": { + "type": { + "$ref": "#/2280" + }, + "flags": 0 + }, + "TimeGranularity": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TimeGranularity", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TimeRangeDrillDownFilter", + "properties": { + "Column": { + "type": { + "$ref": "#/1918" + }, + "flags": 1 + }, + "RangeMaximum": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "RangeMinimum": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "TimeGranularity": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TimeRangeFilter", + "properties": { + "Column": { + "type": { + "$ref": "#/1918" + }, + "flags": 1 + }, + "DefaultFilterControlConfiguration": { + "type": { + "$ref": "#/1991" + }, + "flags": 0 + }, + "ExcludePeriodConfiguration": { + "type": { + "$ref": "#/2014" + }, + "flags": 0 + }, + "FilterId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "IncludeMaximum": { + "type": { + "$ref": "#/650" + }, + "flags": 0 + }, + "IncludeMinimum": { + "type": { + "$ref": "#/650" + }, + "flags": 0 + }, + "NullOption": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "RangeMaximumValue": { + "type": { + "$ref": "#/2395" + }, + "flags": 0 + }, + "RangeMinimumValue": { + "type": { + "$ref": "#/2395" + }, + "flags": 0 + }, + "TimeGranularity": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TimeRangeFilterValue", + "properties": { + "Parameter": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "RollingDate": { + "type": { + "$ref": "#/2280" + }, + "flags": 0 + }, + "StaticValue": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TooltipItem", + "properties": { + "ColumnTooltipItem": { + "type": { + "$ref": "#/1922" + }, + "flags": 0 + }, + "FieldTooltipItem": { + "type": { + "$ref": "#/2021" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TooltipOptions", + "properties": { + "FieldBasedTooltip": { + "type": { + "$ref": "#/2016" + }, + "flags": 0 + }, + "SelectedTooltipType": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "TooltipVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TooltipTitleType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TopBottomComputationType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TopBottomFilter", + "properties": { + "AggregationSortConfigurations": { + "type": { + "$ref": "#/2656" + }, + "flags": 1 + }, + "Column": { + "type": { + "$ref": "#/1918" + }, + "flags": 1 + }, + "DefaultFilterControlConfiguration": { + "type": { + "$ref": "#/1991" + }, + "flags": 0 + }, + "FilterId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Limit": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "ParameterName": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "TimeGranularity": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TopBottomMoversComputation", + "properties": { + "Category": { + "type": { + "$ref": "#/2006" + }, + "flags": 0 + }, + "ComputationId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "MoverSize": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "SortOrder": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Time": { + "type": { + "$ref": "#/2006" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/2168" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TopBottomRankedComputation", + "properties": { + "Category": { + "type": { + "$ref": "#/2006" + }, + "flags": 0 + }, + "ComputationId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ResultSize": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/2168" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TopBottomSortOrder", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TotalAggregationComputation", + "properties": { + "ComputationId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/2168" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TotalAggregationFunction", + "properties": { + "SimpleTotalAggregationFunction": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TotalAggregationOption", + "properties": { + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "TotalAggregationFunction": { + "type": { + "$ref": "#/2405" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TotalOptions", + "properties": { + "CustomLabel": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Placement": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ScrollStatus": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "TotalAggregationOptions": { + "type": { + "$ref": "#/2657" + }, + "flags": 0 + }, + "TotalCellStyle": { + "type": { + "$ref": "#/2348" + }, + "flags": 0 + }, + "TotalsVisibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TreeMapAggregatedFieldWells", + "properties": { + "Colors": { + "type": { + "$ref": "#/2658" + }, + "flags": 0 + }, + "Groups": { + "type": { + "$ref": "#/2659" + }, + "flags": 0 + }, + "Sizes": { + "type": { + "$ref": "#/2660" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TreeMapConfiguration", + "properties": { + "ColorLabelOptions": { + "type": { + "$ref": "#/1908" + }, + "flags": 0 + }, + "ColorScale": { + "type": { + "$ref": "#/1912" + }, + "flags": 0 + }, + "DataLabels": { + "type": { + "$ref": "#/1963" + }, + "flags": 0 + }, + "FieldWells": { + "type": { + "$ref": "#/2410" + }, + "flags": 0 + }, + "GroupLabelOptions": { + "type": { + "$ref": "#/1908" + }, + "flags": 0 + }, + "Legend": { + "type": { + "$ref": "#/2141" + }, + "flags": 0 + }, + "SizeLabelOptions": { + "type": { + "$ref": "#/1908" + }, + "flags": 0 + }, + "SortConfiguration": { + "type": { + "$ref": "#/2411" + }, + "flags": 0 + }, + "Tooltip": { + "type": { + "$ref": "#/2397" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TreeMapFieldWells", + "properties": { + "TreeMapAggregatedFieldWells": { + "type": { + "$ref": "#/2408" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TreeMapSortConfiguration", + "properties": { + "TreeMapGroupItemsLimitConfiguration": { + "type": { + "$ref": "#/2120" + }, + "flags": 0 + }, + "TreeMapSort": { + "type": { + "$ref": "#/2661" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TreeMapVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/2662" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/2409" + }, + "flags": 0 + }, + "ColumnHierarchies": { + "type": { + "$ref": "#/2663" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/2428" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/2429" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TrendArrowOptions", + "properties": { + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "URLTargetConfiguration", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "UnaggregatedField", + "properties": { + "Column": { + "type": { + "$ref": "#/1918" + }, + "flags": 1 + }, + "FieldId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "FormatConfiguration": { + "type": { + "$ref": "#/2058" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "UniqueValuesComputation", + "properties": { + "Category": { + "type": { + "$ref": "#/2006" + }, + "flags": 0 + }, + "ComputationId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ValidationStrategy", + "properties": { + "Mode": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ValidationStrategyMode", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ValueWhenUnsetOption", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "VerticalTextAlignment", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Visibility", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "VisibleRangeOptions", + "properties": { + "PercentRange": { + "type": { + "$ref": "#/2209" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Visual", + "properties": { + "BarChartVisual": { + "type": { + "$ref": "#/1881" + }, + "flags": 0 + }, + "BoxPlotVisual": { + "type": { + "$ref": "#/1895" + }, + "flags": 0 + }, + "ComboChartVisual": { + "type": { + "$ref": "#/1927" + }, + "flags": 0 + }, + "CustomContentVisual": { + "type": { + "$ref": "#/1953" + }, + "flags": 0 + }, + "EmptyVisual": { + "type": { + "$ref": "#/2012" + }, + "flags": 0 + }, + "FilledMapVisual": { + "type": { + "$ref": "#/2029" + }, + "flags": 0 + }, + "FunnelChartVisual": { + "type": { + "$ref": "#/2072" + }, + "flags": 0 + }, + "GaugeChartVisual": { + "type": { + "$ref": "#/2080" + }, + "flags": 0 + }, + "GeospatialMapVisual": { + "type": { + "$ref": "#/2089" + }, + "flags": 0 + }, + "HeatMapVisual": { + "type": { + "$ref": "#/2106" + }, + "flags": 0 + }, + "HistogramVisual": { + "type": { + "$ref": "#/2112" + }, + "flags": 0 + }, + "InsightVisual": { + "type": { + "$ref": "#/2116" + }, + "flags": 0 + }, + "KPIVisual": { + "type": { + "$ref": "#/2133" + }, + "flags": 0 + }, + "LineChartVisual": { + "type": { + "$ref": "#/2154" + }, + "flags": 0 + }, + "PieChartVisual": { + "type": { + "$ref": "#/2218" + }, + "flags": 0 + }, + "PivotTableVisual": { + "type": { + "$ref": "#/2245" + }, + "flags": 0 + }, + "RadarChartVisual": { + "type": { + "$ref": "#/2258" + }, + "flags": 0 + }, + "SankeyDiagramVisual": { + "type": { + "$ref": "#/2287" + }, + "flags": 0 + }, + "ScatterPlotVisual": { + "type": { + "$ref": "#/2292" + }, + "flags": 0 + }, + "TableVisual": { + "type": { + "$ref": "#/2374" + }, + "flags": 0 + }, + "TreeMapVisual": { + "type": { + "$ref": "#/2412" + }, + "flags": 0 + }, + "WaterfallVisual": { + "type": { + "$ref": "#/2437" + }, + "flags": 0 + }, + "WordCloudVisual": { + "type": { + "$ref": "#/2447" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "VisualCustomAction", + "properties": { + "ActionOperations": { + "type": { + "$ref": "#/2664" + }, + "flags": 1 + }, + "CustomActionId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Status": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Trigger": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "VisualCustomActionOperation", + "properties": { + "FilterOperation": { + "type": { + "$ref": "#/1945" + }, + "flags": 0 + }, + "NavigationOperation": { + "type": { + "$ref": "#/1946" + }, + "flags": 0 + }, + "SetParametersOperation": { + "type": { + "$ref": "#/1947" + }, + "flags": 0 + }, + "URLOperation": { + "type": { + "$ref": "#/1948" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "VisualCustomActionTrigger", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "VisualPalette", + "properties": { + "ChartColor": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ColorMap": { + "type": { + "$ref": "#/2665" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "VisualSubtitleLabelOptions", + "properties": { + "FormatText": { + "type": { + "$ref": "#/2162" + }, + "flags": 0 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "VisualTitleLabelOptions", + "properties": { + "FormatText": { + "type": { + "$ref": "#/2323" + }, + "flags": 0 + }, + "Visibility": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "WaterfallChartAggregatedFieldWells", + "properties": { + "Breakdowns": { + "type": { + "$ref": "#/2666" + }, + "flags": 0 + }, + "Categories": { + "type": { + "$ref": "#/2667" + }, + "flags": 0 + }, + "Values": { + "type": { + "$ref": "#/2668" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "WaterfallChartColorConfiguration", + "properties": { + "GroupColorConfiguration": { + "type": { + "$ref": "#/2434" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "WaterfallChartConfiguration", + "properties": { + "CategoryAxisDisplayOptions": { + "type": { + "$ref": "#/1868" + }, + "flags": 0 + }, + "CategoryAxisLabelOptions": { + "type": { + "$ref": "#/1908" + }, + "flags": 0 + }, + "ColorConfiguration": { + "type": { + "$ref": "#/2431" + }, + "flags": 0 + }, + "DataLabels": { + "type": { + "$ref": "#/1963" + }, + "flags": 0 + }, + "FieldWells": { + "type": { + "$ref": "#/2433" + }, + "flags": 0 + }, + "Legend": { + "type": { + "$ref": "#/2141" + }, + "flags": 0 + }, + "PrimaryYAxisDisplayOptions": { + "type": { + "$ref": "#/1868" + }, + "flags": 0 + }, + "PrimaryYAxisLabelOptions": { + "type": { + "$ref": "#/1908" + }, + "flags": 0 + }, + "SortConfiguration": { + "type": { + "$ref": "#/2436" + }, + "flags": 0 + }, + "VisualPalette": { + "type": { + "$ref": "#/2427" + }, + "flags": 0 + }, + "WaterfallChartOptions": { + "type": { + "$ref": "#/2435" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "WaterfallChartFieldWells", + "properties": { + "WaterfallChartAggregatedFieldWells": { + "type": { + "$ref": "#/2430" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "WaterfallChartGroupColorConfiguration", + "properties": { + "NegativeBarColor": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "PositiveBarColor": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "TotalBarColor": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "WaterfallChartOptions", + "properties": { + "TotalBarLabel": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "WaterfallChartSortConfiguration", + "properties": { + "BreakdownItemsLimit": { + "type": { + "$ref": "#/2120" + }, + "flags": 0 + }, + "CategorySort": { + "type": { + "$ref": "#/2669" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "WaterfallVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/2670" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/2432" + }, + "flags": 0 + }, + "ColumnHierarchies": { + "type": { + "$ref": "#/2671" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/2428" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/2429" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "WhatIfPointScenario", + "properties": { + "Date": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "WhatIfRangeScenario", + "properties": { + "EndDate": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "StartDate": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/610" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "WidgetStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "WordCloudAggregatedFieldWells", + "properties": { + "GroupBy": { + "type": { + "$ref": "#/2672" + }, + "flags": 0 + }, + "Size": { + "type": { + "$ref": "#/2673" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "WordCloudChartConfiguration", + "properties": { + "CategoryLabelOptions": { + "type": { + "$ref": "#/1908" + }, + "flags": 0 + }, + "FieldWells": { + "type": { + "$ref": "#/2444" + }, + "flags": 0 + }, + "SortConfiguration": { + "type": { + "$ref": "#/2446" + }, + "flags": 0 + }, + "WordCloudOptions": { + "type": { + "$ref": "#/2445" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "WordCloudCloudLayout", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "WordCloudFieldWells", + "properties": { + "WordCloudAggregatedFieldWells": { + "type": { + "$ref": "#/2441" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "WordCloudOptions", + "properties": { + "CloudLayout": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "MaximumStringLength": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "WordCasing": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "WordOrientation": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "WordPadding": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "WordScaling": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "WordCloudSortConfiguration", + "properties": { + "CategoryItemsLimit": { + "type": { + "$ref": "#/2120" + }, + "flags": 0 + }, + "CategorySort": { + "type": { + "$ref": "#/2674" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "WordCloudVisual", + "properties": { + "Actions": { + "type": { + "$ref": "#/2675" + }, + "flags": 0 + }, + "ChartConfiguration": { + "type": { + "$ref": "#/2442" + }, + "flags": 0 + }, + "ColumnHierarchies": { + "type": { + "$ref": "#/2676" + }, + "flags": 0 + }, + "Subtitle": { + "type": { + "$ref": "#/2428" + }, + "flags": 0 + }, + "Title": { + "type": { + "$ref": "#/2429" + }, + "flags": 0 + }, + "VisualId": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "WordCloudWordCasing", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "WordCloudWordOrientation", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "WordCloudWordPadding", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "WordCloudWordScaling", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2006" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2006" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2006" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2168" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1942" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2260" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2020" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2020" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2020" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2424" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1917" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2006" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2168" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2260" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2020" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2424" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1917" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1899" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1870" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1960" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1949" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1915" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2168" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2006" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2006" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2168" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2260" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2020" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2020" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2424" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1917" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1918" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2308" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2424" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/610" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/610" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1966" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1971" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1916" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1920" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2009" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2164" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/610" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2164" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2424" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1918" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2009" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2396" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2006" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2168" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2024" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2020" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2424" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1917" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2030" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1918" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2061" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2320" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2061" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2006" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2168" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2020" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2424" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1917" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2075" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2168" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2168" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2424" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2084" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2006" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2006" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2168" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2424" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1917" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2095" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2098" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2006" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2006" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2168" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2020" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2020" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2424" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1917" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2168" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2424" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1931" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2424" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/610" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2164" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2124" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2168" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2006" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2168" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2020" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2424" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1917" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2006" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2006" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2006" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2168" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1942" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2056" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2260" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2307" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2020" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2020" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2424" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1917" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2171" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2006" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2006" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2168" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1942" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2020" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2020" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2424" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1917" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2006" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2006" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2168" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2224" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2223" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1971" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1971" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2230" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2227" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2232" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2219" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2424" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2406" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1918" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2009" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2006" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2006" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2168" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2020" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2020" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2424" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1917" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2006" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2006" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2168" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2020" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2424" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2006" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2006" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2168" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2168" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2168" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2006" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2006" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2168" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2006" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2006" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2424" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1917" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1886" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2101" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2101" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2322" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2031" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2138" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2199" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2314" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2321" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2423" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2164" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2234" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2370" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2006" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2168" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2350" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2362" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2358" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2020" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2415" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2424" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2013" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1973" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1972" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2377" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2310" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1896" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1914" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1972" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2035" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2201" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2318" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1851" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2406" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2168" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2006" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2168" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2020" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2424" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1917" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2425" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1967" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2006" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2006" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2168" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2020" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2424" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1917" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2006" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2168" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2020" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2424" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1917" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.QuickSight/TemplateProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2278" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2375" + } + }, + { + "$type": "ObjectType", + "name": "AWS.QuickSight/TemplateProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/601" + }, + "flags": 2, + "description": "

The Amazon Resource Name (ARN) of the template.

" + }, + "AwsAccountId": { + "type": { + "$ref": "#/601" + }, + "flags": 17 + }, + "CreatedTime": { + "type": { + "$ref": "#/601" + }, + "flags": 2, + "description": "

Time when this was created.

" + }, + "Definition": { + "type": { + "$ref": "#/2383" + }, + "flags": 4 + }, + "LastUpdatedTime": { + "type": { + "$ref": "#/601" + }, + "flags": 2, + "description": "

Time when this was last updated.

" + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Permissions": { + "type": { + "$ref": "#/2678" + }, + "flags": 0 + }, + "SourceEntity": { + "type": { + "$ref": "#/2380" + }, + "flags": 4 + }, + "Tags": { + "type": { + "$ref": "#/2679" + }, + "flags": 0 + }, + "TemplateId": { + "type": { + "$ref": "#/601" + }, + "flags": 17 + }, + "ValidationStrategy": { + "type": { + "$ref": "#/2417" + }, + "flags": 4 + }, + "Version": { + "type": { + "$ref": "#/2382" + }, + "flags": 2 + }, + "VersionDescription": { + "type": { + "$ref": "#/601" + }, + "flags": 4 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.QuickSight/Template", + "properties": { + "name": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/601" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/2680" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.QuickSight/Template@default", + "scopeType": 0, + "body": { + "$ref": "#/2681" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "BorderStyle", + "properties": { + "Show": { + "type": { + "$ref": "#/650" + }, + "flags": 0, + "description": "

The option to enable display of borders for visuals.

" + } + } + }, + { + "$type": "ObjectType", + "name": "DataColorPalette", + "properties": { + "Colors": { + "type": { + "$ref": "#/2701" + }, + "flags": 0, + "description": "

The hexadecimal codes for the colors.

" + }, + "EmptyFillColor": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The hexadecimal code of a color that applies to charts where a lack of data is\n highlighted.

" + }, + "MinMaxGradient": { + "type": { + "$ref": "#/2702" + }, + "flags": 0, + "description": "

The minimum and maximum hexadecimal codes that describe a color gradient.

" + } + } + }, + { + "$type": "ObjectType", + "name": "Font", + "properties": { + "FontFamily": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "GutterStyle", + "properties": { + "Show": { + "type": { + "$ref": "#/650" + }, + "flags": 0, + "description": "

This Boolean value controls whether to display a gutter space between sheet tiles.\n

" + } + } + }, + { + "$type": "ObjectType", + "name": "MarginStyle", + "properties": { + "Show": { + "type": { + "$ref": "#/650" + }, + "flags": 0, + "description": "

This Boolean value controls whether to display sheet margins.

" + } + } + }, + { + "$type": "ObjectType", + "name": "ResourcePermission", + "properties": { + "Actions": { + "type": { + "$ref": "#/2703" + }, + "flags": 1, + "description": "

The IAM action to grant or revoke permissions on.

" + }, + "Principal": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

The Amazon Resource Name (ARN) of the principal. This can be one of the\n following:

\n
    \n
  • \n

    The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

    \n
    • \n
  • \n

    The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)

    \n
    • \n
  • \n

    The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight\n ARN. Use this option only to share resources (templates) across Amazon Web Services accounts.\n (This is less common.)

    \n
    • \n
" + } + } + }, + { + "$type": "ObjectType", + "name": "ResourceStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SheetStyle", + "properties": { + "Tile": { + "type": { + "$ref": "#/2698" + }, + "flags": 0 + }, + "TileLayout": { + "type": { + "$ref": "#/2697" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

Tag key.

" + }, + "Value": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

Tag value.

" + } + } + }, + { + "$type": "ObjectType", + "name": "ThemeConfiguration", + "properties": { + "DataColorPalette": { + "type": { + "$ref": "#/2684" + }, + "flags": 0 + }, + "Sheet": { + "type": { + "$ref": "#/2690" + }, + "flags": 0 + }, + "Typography": { + "type": { + "$ref": "#/2699" + }, + "flags": 0 + }, + "UIColorPalette": { + "type": { + "$ref": "#/2700" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ThemeError", + "properties": { + "Message": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The error message.

" + }, + "Type": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ThemeErrorType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ThemeType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ThemeVersion", + "properties": { + "Arn": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The Amazon Resource Name (ARN) of the resource.

" + }, + "BaseThemeId": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The Amazon QuickSight-defined ID of the theme that a custom theme inherits from. All\n themes initially inherit from a default Amazon QuickSight theme.

" + }, + "Configuration": { + "type": { + "$ref": "#/2692" + }, + "flags": 0 + }, + "CreatedTime": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The date and time that this theme version was created.

" + }, + "Description": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The description of the theme.

" + }, + "Errors": { + "type": { + "$ref": "#/2704" + }, + "flags": 0, + "description": "

Errors associated with the theme.

" + }, + "Status": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "VersionNumber": { + "type": { + "$ref": "#/610" + }, + "flags": 0, + "description": "

The version number of the theme.

" + } + } + }, + { + "$type": "ObjectType", + "name": "TileLayoutStyle", + "properties": { + "Gutter": { + "type": { + "$ref": "#/2686" + }, + "flags": 0 + }, + "Margin": { + "type": { + "$ref": "#/2687" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TileStyle", + "properties": { + "Border": { + "type": { + "$ref": "#/2683" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Typography", + "properties": { + "FontFamilies": { + "type": { + "$ref": "#/2705" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "UIColorPalette", + "properties": { + "Accent": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

This color is that applies to selected states and buttons.

" + }, + "AccentForeground": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The foreground color that applies to any text or other elements that appear over the\n accent color.

" + }, + "Danger": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The color that applies to error messages.

" + }, + "DangerForeground": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The foreground color that applies to any text or other elements that appear over the\n error color.

" + }, + "Dimension": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The color that applies to the names of fields that are identified as\n dimensions.

" + }, + "DimensionForeground": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The foreground color that applies to any text or other elements that appear over the\n dimension color.

" + }, + "Measure": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The color that applies to the names of fields that are identified as measures.

" + }, + "MeasureForeground": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The foreground color that applies to any text or other elements that appear over the\n measure color.

" + }, + "PrimaryBackground": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The background color that applies to visuals and other high emphasis UI.

" + }, + "PrimaryForeground": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The color of text and other foreground elements that appear over the primary\n background regions, such as grid lines, borders, table banding, icons, and so on.

" + }, + "SecondaryBackground": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The background color that applies to the sheet background and sheet controls.

" + }, + "SecondaryForeground": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The foreground color that applies to any sheet title, sheet control text, or UI that\n appears over the secondary background.

" + }, + "Success": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The color that applies to success messages, for example the check mark for a\n successful download.

" + }, + "SuccessForeground": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The foreground color that applies to any text or other elements that appear over the\n success color.

" + }, + "Warning": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

This color that applies to warning and informational messages.

" + }, + "WarningForeground": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The foreground color that applies to any text or other elements that appear over the\n warning color.

" + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2693" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2685" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.QuickSight/ThemeProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2688" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2691" + } + }, + { + "$type": "ObjectType", + "name": "AWS.QuickSight/ThemeProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/601" + }, + "flags": 2, + "description": "

The Amazon Resource Name (ARN) of the theme.

" + }, + "AwsAccountId": { + "type": { + "$ref": "#/601" + }, + "flags": 17 + }, + "BaseThemeId": { + "type": { + "$ref": "#/601" + }, + "flags": 5 + }, + "Configuration": { + "type": { + "$ref": "#/2692" + }, + "flags": 5 + }, + "CreatedTime": { + "type": { + "$ref": "#/601" + }, + "flags": 2, + "description": "

The date and time that the theme was created.

" + }, + "LastUpdatedTime": { + "type": { + "$ref": "#/601" + }, + "flags": 2, + "description": "

The date and time that the theme was last updated.

" + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "Permissions": { + "type": { + "$ref": "#/2707" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/2708" + }, + "flags": 0 + }, + "ThemeId": { + "type": { + "$ref": "#/601" + }, + "flags": 17 + }, + "Type": { + "type": { + "$ref": "#/601" + }, + "flags": 2 + }, + "Version": { + "type": { + "$ref": "#/2696" + }, + "flags": 2 + }, + "VersionDescription": { + "type": { + "$ref": "#/601" + }, + "flags": 4 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.QuickSight/Theme", + "properties": { + "name": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/601" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/2709" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.QuickSight/Theme@default", + "scopeType": 0, + "body": { + "$ref": "#/2710" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AggregationFunctionParameters", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AuthorSpecifiedAggregation", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CategoryFilterFunction", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CategoryFilterType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CellValueSynonym", + "properties": { + "CellValue": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Synonyms": { + "type": { + "$ref": "#/2760" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CollectiveConstant", + "properties": { + "ValueList": { + "type": { + "$ref": "#/2761" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ColumnDataRole", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ColumnOrderingType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ComparativeOrder", + "properties": { + "SpecifedOrder": { + "type": { + "$ref": "#/2762" + }, + "flags": 0 + }, + "TreatUndefinedSpecifiedValues": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "UseOrdering": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ConstantType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DataAggregation", + "properties": { + "DatasetRowDateGranularity": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "DefaultDateColumnName": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DatasetMetadata", + "properties": { + "CalculatedFields": { + "type": { + "$ref": "#/2763" + }, + "flags": 0 + }, + "Columns": { + "type": { + "$ref": "#/2764" + }, + "flags": 0 + }, + "DataAggregation": { + "type": { + "$ref": "#/2722" + }, + "flags": 0 + }, + "DatasetArn": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "DatasetDescription": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "DatasetName": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Filters": { + "type": { + "$ref": "#/2765" + }, + "flags": 0 + }, + "NamedEntities": { + "type": { + "$ref": "#/2766" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DefaultAggregation", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DefaultFormatting", + "properties": { + "DisplayFormat": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "DisplayFormatOptions": { + "type": { + "$ref": "#/2727" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DisplayFormat", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DisplayFormatOptions", + "properties": { + "BlankCellFormat": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "CurrencySymbol": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "DateFormat": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "DecimalSeparator": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "FractionDigits": { + "type": { + "$ref": "#/610" + }, + "flags": 0 + }, + "GroupingSeparator": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "NegativeFormat": { + "type": { + "$ref": "#/2734" + }, + "flags": 0 + }, + "Prefix": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Suffix": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "UnitScaler": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "UseBlankCellFormat": { + "type": { + "$ref": "#/650" + }, + "flags": 0 + }, + "UseGrouping": { + "type": { + "$ref": "#/650" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FilterClass", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "NamedEntityAggType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "NamedEntityDefinition", + "properties": { + "FieldName": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Metric": { + "type": { + "$ref": "#/2731" + }, + "flags": 0 + }, + "PropertyName": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "PropertyRole": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "PropertyUsage": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "NamedEntityDefinitionMetric", + "properties": { + "Aggregation": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "AggregationFunctionParameters": { + "type": { + "$ref": "#/2712" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "NamedFilterAggType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "NamedFilterType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "NegativeFormat", + "properties": { + "Prefix": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Suffix": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "NumberScale", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PropertyRole", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PropertyUsage", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RangeConstant", + "properties": { + "Maximum": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Minimum": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SemanticEntityType", + "properties": { + "SubTypeName": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "TypeName": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "TypeParameters": { + "type": { + "$ref": "#/2758" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SemanticType", + "properties": { + "FalseyCellValue": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "FalseyCellValueSynonyms": { + "type": { + "$ref": "#/2767" + }, + "flags": 0 + }, + "SubTypeName": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "TruthyCellValue": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "TruthyCellValueSynonyms": { + "type": { + "$ref": "#/2768" + }, + "flags": 0 + }, + "TypeName": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "TypeParameters": { + "type": { + "$ref": "#/2758" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TopicCalculatedField", + "properties": { + "Aggregation": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "AllowedAggregations": { + "type": { + "$ref": "#/2769" + }, + "flags": 0 + }, + "CalculatedFieldDescription": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "CalculatedFieldName": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "CalculatedFieldSynonyms": { + "type": { + "$ref": "#/2770" + }, + "flags": 0 + }, + "CellValueSynonyms": { + "type": { + "$ref": "#/2771" + }, + "flags": 0 + }, + "ColumnDataRole": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ComparativeOrder": { + "type": { + "$ref": "#/2720" + }, + "flags": 0 + }, + "DefaultFormatting": { + "type": { + "$ref": "#/2725" + }, + "flags": 0 + }, + "DisableIndexing": { + "type": { + "$ref": "#/650" + }, + "flags": 0 + }, + "Expression": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "IsIncludedInTopic": { + "type": { + "$ref": "#/650" + }, + "flags": 0 + }, + "NeverAggregateInFilter": { + "type": { + "$ref": "#/650" + }, + "flags": 0 + }, + "NonAdditive": { + "type": { + "$ref": "#/650" + }, + "flags": 0 + }, + "NotAllowedAggregations": { + "type": { + "$ref": "#/2772" + }, + "flags": 0 + }, + "SemanticType": { + "type": { + "$ref": "#/2740" + }, + "flags": 0 + }, + "TimeGranularity": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TopicCategoryFilter", + "properties": { + "CategoryFilterFunction": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "CategoryFilterType": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Constant": { + "type": { + "$ref": "#/2743" + }, + "flags": 0 + }, + "Inverse": { + "type": { + "$ref": "#/650" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TopicCategoryFilterConstant", + "properties": { + "CollectiveConstant": { + "type": { + "$ref": "#/2717" + }, + "flags": 0 + }, + "ConstantType": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "SingularConstant": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TopicColumn", + "properties": { + "Aggregation": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "AllowedAggregations": { + "type": { + "$ref": "#/2773" + }, + "flags": 0 + }, + "CellValueSynonyms": { + "type": { + "$ref": "#/2774" + }, + "flags": 0 + }, + "ColumnDataRole": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ColumnDescription": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ColumnFriendlyName": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "ColumnName": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "ColumnSynonyms": { + "type": { + "$ref": "#/2775" + }, + "flags": 0 + }, + "ComparativeOrder": { + "type": { + "$ref": "#/2720" + }, + "flags": 0 + }, + "DefaultFormatting": { + "type": { + "$ref": "#/2725" + }, + "flags": 0 + }, + "DisableIndexing": { + "type": { + "$ref": "#/650" + }, + "flags": 0 + }, + "IsIncludedInTopic": { + "type": { + "$ref": "#/650" + }, + "flags": 0 + }, + "NeverAggregateInFilter": { + "type": { + "$ref": "#/650" + }, + "flags": 0 + }, + "NonAdditive": { + "type": { + "$ref": "#/650" + }, + "flags": 0 + }, + "NotAllowedAggregations": { + "type": { + "$ref": "#/2776" + }, + "flags": 0 + }, + "SemanticType": { + "type": { + "$ref": "#/2740" + }, + "flags": 0 + }, + "TimeGranularity": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TopicDateRangeFilter", + "properties": { + "Constant": { + "type": { + "$ref": "#/2752" + }, + "flags": 0 + }, + "Inclusive": { + "type": { + "$ref": "#/650" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TopicDetails", + "properties": { + "DataSets": { + "type": { + "$ref": "#/2777" + }, + "flags": 0 + }, + "Description": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "UserExperienceVersion": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TopicFilter", + "properties": { + "CategoryFilter": { + "type": { + "$ref": "#/2742" + }, + "flags": 0 + }, + "DateRangeFilter": { + "type": { + "$ref": "#/2745" + }, + "flags": 0 + }, + "FilterClass": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "FilterDescription": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "FilterName": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "FilterSynonyms": { + "type": { + "$ref": "#/2778" + }, + "flags": 0 + }, + "FilterType": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "NumericEqualityFilter": { + "type": { + "$ref": "#/2749" + }, + "flags": 0 + }, + "NumericRangeFilter": { + "type": { + "$ref": "#/2750" + }, + "flags": 0 + }, + "OperandFieldName": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "RelativeDateFilter": { + "type": { + "$ref": "#/2753" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TopicNamedEntity", + "properties": { + "Definition": { + "type": { + "$ref": "#/2779" + }, + "flags": 0 + }, + "EntityDescription": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "EntityName": { + "type": { + "$ref": "#/601" + }, + "flags": 1 + }, + "EntitySynonyms": { + "type": { + "$ref": "#/2780" + }, + "flags": 0 + }, + "SemanticEntityType": { + "type": { + "$ref": "#/2739" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TopicNumericEqualityFilter", + "properties": { + "Aggregation": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Constant": { + "type": { + "$ref": "#/2755" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TopicNumericRangeFilter", + "properties": { + "Aggregation": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Constant": { + "type": { + "$ref": "#/2752" + }, + "flags": 0 + }, + "Inclusive": { + "type": { + "$ref": "#/650" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TopicNumericSeparatorSymbol", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TopicRangeFilterConstant", + "properties": { + "ConstantType": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "RangeConstant": { + "type": { + "$ref": "#/2738" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TopicRelativeDateFilter", + "properties": { + "Constant": { + "type": { + "$ref": "#/2755" + }, + "flags": 0 + }, + "RelativeDateFilterFunction": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "TimeGranularity": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TopicRelativeDateFilterFunction", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TopicSingularFilterConstant", + "properties": { + "ConstantType": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "SingularConstant": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TopicTimeGranularity", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TopicUserExperienceVersion", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TypeParameters", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "UndefinedSpecifiedValueType", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2741" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2744" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2747" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2748" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2716" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2716" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2723" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2730" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.QuickSight/TopicProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2723" + } + }, + { + "$type": "ObjectType", + "name": "AWS.QuickSight/TopicProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/601" + }, + "flags": 2 + }, + "AwsAccountId": { + "type": { + "$ref": "#/601" + }, + "flags": 16 + }, + "DataSets": { + "type": { + "$ref": "#/2782" + }, + "flags": 0 + }, + "Description": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "TopicId": { + "type": { + "$ref": "#/601" + }, + "flags": 16 + }, + "UserExperienceVersion": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.QuickSight/Topic", + "properties": { + "name": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/601" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/2783" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.QuickSight/Topic@default", + "scopeType": 0, + "body": { + "$ref": "#/2784" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "NetworkInterface", + "properties": { + "AvailabilityZone": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The availability zone that the network interface resides in.

" + }, + "ErrorMessage": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

An error message.

" + }, + "NetworkInterfaceId": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The network interface ID.

" + }, + "Status": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "SubnetId": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "

The subnet ID associated with the network interface.

" + } + } + }, + { + "$type": "ObjectType", + "name": "NetworkInterfaceStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

Tag key.

" + }, + "Value": { + "type": { + "$ref": "#/601" + }, + "flags": 1, + "description": "

Tag value.

" + } + } + }, + { + "$type": "ObjectType", + "name": "VPCConnectionAvailabilityStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "VPCConnectionResourceStatus", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.QuickSight/VPCConnectionProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2786" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/601" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2788" + } + }, + { + "$type": "ObjectType", + "name": "AWS.QuickSight/VPCConnectionProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/601" + }, + "flags": 2, + "description": "

The Amazon Resource Name (ARN) of the VPC connection.

" + }, + "AvailabilityStatus": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "AwsAccountId": { + "type": { + "$ref": "#/601" + }, + "flags": 16 + }, + "CreatedTime": { + "type": { + "$ref": "#/601" + }, + "flags": 2, + "description": "

The time that the VPC connection was created.

" + }, + "DnsResolvers": { + "type": { + "$ref": "#/2792" + }, + "flags": 0 + }, + "LastUpdatedTime": { + "type": { + "$ref": "#/601" + }, + "flags": 2, + "description": "

The time that the VPC connection was last updated.

" + }, + "Name": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "NetworkInterfaces": { + "type": { + "$ref": "#/2793" + }, + "flags": 2, + "description": "

A list of network interfaces.

" + }, + "RoleArn": { + "type": { + "$ref": "#/601" + }, + "flags": 0 + }, + "SecurityGroupIds": { + "type": { + "$ref": "#/2794" + }, + "flags": 0 + }, + "Status": { + "type": { + "$ref": "#/601" + }, + "flags": 2 + }, + "SubnetIds": { + "type": { + "$ref": "#/2795" + }, + "flags": 4 + }, + "Tags": { + "type": { + "$ref": "#/2796" + }, + "flags": 0 + }, + "VPCConnectionId": { + "type": { + "$ref": "#/601" + }, + "flags": 16 + }, + "VPCId": { + "type": { + "$ref": "#/601" + }, + "flags": 2, + "description": "

The Amazon EC2 VPC ID associated with the VPC connection.

" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.QuickSight/VPCConnection", + "properties": { + "name": { + "type": { + "$ref": "#/601" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/601" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/2797" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.QuickSight/VPCConnection@default", + "scopeType": 0, + "body": { + "$ref": "#/2798" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.quicksight/default/types.md b/artifacts/bicep/aws/aws.quicksight/default/types.md index 027733f9..468b7b8a 100644 --- a/artifacts/bicep/aws/aws.quicksight/default/types.md +++ b/artifacts/bicep/aws/aws.quicksight/default/types.md @@ -3,1598 +3,1812 @@ ## Resource AWS.QuickSight/Analysis@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.QuickSight/AnalysisProperties](#awsquicksightanalysisproperties) (Required): properties of the resource +* **properties**: [AWS.QuickSight/AnalysisProperties](#awsquicksightanalysisproperties) (Required, Identifier): properties of the resource ## Resource AWS.QuickSight/Dashboard@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.QuickSight/DashboardProperties](#awsquicksightdashboardproperties) (Required): properties of the resource +* **properties**: [AWS.QuickSight/DashboardProperties](#awsquicksightdashboardproperties) (Required, Identifier): properties of the resource ## Resource AWS.QuickSight/DataSet@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.QuickSight/DataSetProperties](#awsquicksightdatasetproperties): properties of the resource +* **properties**: [AWS.QuickSight/DataSetProperties](#awsquicksightdatasetproperties) (Identifier): properties of the resource ## Resource AWS.QuickSight/DataSource@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.QuickSight/DataSourceProperties](#awsquicksightdatasourceproperties): properties of the resource +* **properties**: [AWS.QuickSight/DataSourceProperties](#awsquicksightdatasourceproperties) (Required, Identifier): properties of the resource ## Resource AWS.QuickSight/RefreshSchedule@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.QuickSight/RefreshScheduleProperties](#awsquicksightrefreshscheduleproperties): properties of the resource +* **properties**: [AWS.QuickSight/RefreshScheduleProperties](#awsquicksightrefreshscheduleproperties) (Identifier): properties of the resource ## Resource AWS.QuickSight/Template@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.QuickSight/TemplateProperties](#awsquicksighttemplateproperties) (Required): properties of the resource +* **properties**: [AWS.QuickSight/TemplateProperties](#awsquicksighttemplateproperties) (Required, Identifier): properties of the resource ## Resource AWS.QuickSight/Theme@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.QuickSight/ThemeProperties](#awsquicksightthemeproperties) (Required): properties of the resource +* **properties**: [AWS.QuickSight/ThemeProperties](#awsquicksightthemeproperties) (Required, Identifier): properties of the resource ## Resource AWS.QuickSight/Topic@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.QuickSight/TopicProperties](#awsquicksighttopicproperties): properties of the resource +* **properties**: [AWS.QuickSight/TopicProperties](#awsquicksighttopicproperties) (Identifier): properties of the resource ## Resource AWS.QuickSight/VPCConnection@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.QuickSight/VPCConnectionProperties](#awsquicksightvpcconnectionproperties): properties of the resource +* **properties**: [AWS.QuickSight/VPCConnectionProperties](#awsquicksightvpcconnectionproperties) (Identifier): properties of the resource -## AWS.QuickSight/AnalysisProperties +## AdHocFilteringOption ### Properties -* **AnalysisId**: string (Required, Identifier) -* **Arn**: string (ReadOnly) -* **AwsAccountId**: string (Required, Identifier) -* **CreatedTime**: string (ReadOnly) -* **DataSetArns**: string[] (ReadOnly) -* **Definition**: [AnalysisDefinition](#analysisdefinition) (WriteOnly) -* **Errors**: [AnalysisError](#analysiserror)[] -* **LastUpdatedTime**: string (ReadOnly) -* **Name**: string (Required) -* **Parameters**: [Parameters](#parameters) (WriteOnly) -* **Permissions**: [ResourcePermission](#resourcepermission)[] -* **Sheets**: [Sheet](#sheet)[] -* **SourceEntity**: [AnalysisSourceEntity](#analysissourceentity) (WriteOnly) -* **Status**: string (WriteOnly) -* **Tags**: [Tag](#tag)[] -* **ThemeArn**: string -* **ValidationStrategy**: [ValidationStrategy](#validationstrategy) (WriteOnly) +* **AvailabilityStatus**: string -## AnalysisDefinition +## AggregationFunction ### Properties -* **AnalysisDefaults**: [AnalysisDefaults](#analysisdefaults) -* **CalculatedFields**: [CalculatedField](#calculatedfield)[] -* **ColumnConfigurations**: [ColumnConfiguration](#columnconfiguration)[] -* **DataSetIdentifierDeclarations**: [DataSetIdentifierDeclaration](#datasetidentifierdeclaration)[] (Required) -* **FilterGroups**: [FilterGroup](#filtergroup)[] -* **Options**: [AssetOptions](#assetoptions) -* **ParameterDeclarations**: [ParameterDeclaration](#parameterdeclaration)[] -* **Sheets**: [SheetDefinition](#sheetdefinition)[] +* **AttributeAggregationFunction**: [AttributeAggregationFunction](#attributeaggregationfunction) +* **CategoricalAggregationFunction**: string +* **DateAggregationFunction**: string +* **NumericalAggregationFunction**: [NumericalAggregationFunction](#numericalaggregationfunction) -## AnalysisDefaults +## AggregationFunction ### Properties -* **DefaultNewSheetConfiguration**: [DefaultNewSheetConfiguration](#defaultnewsheetconfiguration) (Required) +* **AttributeAggregationFunction**: [AttributeAggregationFunction](#attributeaggregationfunction) +* **CategoricalAggregationFunction**: string +* **DateAggregationFunction**: string +* **NumericalAggregationFunction**: [NumericalAggregationFunction](#numericalaggregationfunction) -## DefaultNewSheetConfiguration +## AggregationFunction ### Properties -* **InteractiveLayoutConfiguration**: [DefaultInteractiveLayoutConfiguration](#defaultinteractivelayoutconfiguration) -* **PaginatedLayoutConfiguration**: [DefaultPaginatedLayoutConfiguration](#defaultpaginatedlayoutconfiguration) -* **SheetContentType**: string +* **AttributeAggregationFunction**: [AttributeAggregationFunction](#attributeaggregationfunction) +* **CategoricalAggregationFunction**: string +* **DateAggregationFunction**: string +* **NumericalAggregationFunction**: [NumericalAggregationFunction](#numericalaggregationfunction) -## DefaultInteractiveLayoutConfiguration +## AggregationFunctionParameters ### Properties -* **FreeForm**: [DefaultFreeFormLayoutConfiguration](#defaultfreeformlayoutconfiguration) -* **Grid**: [DefaultGridLayoutConfiguration](#defaultgridlayoutconfiguration) -## DefaultFreeFormLayoutConfiguration +## AggregationSortConfiguration ### Properties -* **CanvasSizeOptions**: [FreeFormLayoutCanvasSizeOptions](#freeformlayoutcanvassizeoptions) (Required) +* **AggregationFunction**: [AggregationFunction](#aggregationfunction) +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) +* **SortDirection**: string (Required) -## FreeFormLayoutCanvasSizeOptions +## AggregationSortConfiguration ### Properties -* **ScreenCanvasSizeOptions**: [FreeFormLayoutScreenCanvasSizeOptions](#freeformlayoutscreencanvassizeoptions) +* **AggregationFunction**: [AggregationFunction](#aggregationfunction) +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) +* **SortDirection**: string (Required) -## FreeFormLayoutScreenCanvasSizeOptions +## AggregationSortConfiguration ### Properties -* **OptimizedViewPortWidth**: string (Required): String based length that is composed of value and unit in px +* **AggregationFunction**: [AggregationFunction](#aggregationfunction) +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) +* **SortDirection**: string (Required) -## DefaultGridLayoutConfiguration +## AllSheetsFilterScopeConfiguration ### Properties -* **CanvasSizeOptions**: [GridLayoutCanvasSizeOptions](#gridlayoutcanvassizeoptions) (Required) -## GridLayoutCanvasSizeOptions +## AllSheetsFilterScopeConfiguration ### Properties -* **ScreenCanvasSizeOptions**: [GridLayoutScreenCanvasSizeOptions](#gridlayoutscreencanvassizeoptions) -## GridLayoutScreenCanvasSizeOptions +## AllSheetsFilterScopeConfiguration ### Properties -* **OptimizedViewPortWidth**: string: String based length that is composed of value and unit in px -* **ResizeOption**: string (Required) -## DefaultPaginatedLayoutConfiguration +## AmazonElasticsearchParameters ### Properties -* **SectionBased**: [DefaultSectionBasedLayoutConfiguration](#defaultsectionbasedlayoutconfiguration) +* **Domain**: string (Required):

The OpenSearch domain.

-## DefaultSectionBasedLayoutConfiguration +## AmazonOpenSearchParameters ### Properties -* **CanvasSizeOptions**: [SectionBasedLayoutCanvasSizeOptions](#sectionbasedlayoutcanvassizeoptions) (Required) +* **Domain**: string (Required):

The OpenSearch domain.

-## SectionBasedLayoutCanvasSizeOptions +## AnalysisDefaults ### Properties -* **PaperCanvasSizeOptions**: [SectionBasedLayoutPaperCanvasSizeOptions](#sectionbasedlayoutpapercanvassizeoptions) +* **DefaultNewSheetConfiguration**: [DefaultNewSheetConfiguration](#defaultnewsheetconfiguration) (Required) -## SectionBasedLayoutPaperCanvasSizeOptions +## AnalysisDefaults ### Properties -* **PaperMargin**: [Spacing](#spacing) -* **PaperOrientation**: string -* **PaperSize**: string +* **DefaultNewSheetConfiguration**: [DefaultNewSheetConfiguration](#defaultnewsheetconfiguration) (Required) -## Spacing +## AnalysisDefaults ### Properties -* **Bottom**: string: String based length that is composed of value and unit -* **Left**: string: String based length that is composed of value and unit -* **Right**: string: String based length that is composed of value and unit -* **Top**: string: String based length that is composed of value and unit +* **DefaultNewSheetConfiguration**: [DefaultNewSheetConfiguration](#defaultnewsheetconfiguration) (Required) -## CalculatedField +## AnalysisDefinition ### Properties -* **DataSetIdentifier**: string (Required) -* **Expression**: string (Required) -* **Name**: string (Required) +* **AnalysisDefaults**: [AnalysisDefaults](#analysisdefaults) +* **CalculatedFields**: [CalculatedField](#calculatedfield)[] +* **ColumnConfigurations**: [ColumnConfiguration](#columnconfiguration)[] +* **DataSetIdentifierDeclarations**: [DataSetIdentifierDeclaration](#datasetidentifierdeclaration)[] (Required) +* **FilterGroups**: [FilterGroup](#filtergroup)[] +* **Options**: [AssetOptions](#assetoptions) +* **ParameterDeclarations**: [ParameterDeclaration](#parameterdeclaration)[] +* **Sheets**: [SheetDefinition](#sheetdefinition)[] -## ColumnConfiguration +## AnalysisError ### Properties -* **ColorsConfiguration**: [ColorsConfiguration](#colorsconfiguration) -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **FormatConfiguration**: [FormatConfiguration](#formatconfiguration) -* **Role**: string +* **Message**: string:

The message associated with the analysis error.

+* **Type**: string +* **ViolatedEntities**: [Entity](#entity)[]:

Lists the violated entities that caused the analysis error

-## ColorsConfiguration +## AnalysisSourceEntity ### Properties -* **CustomColors**: [CustomColor](#customcolor)[] +* **SourceTemplate**: [AnalysisSourceTemplate](#analysissourcetemplate) -## CustomColor +## AnalysisSourceTemplate ### Properties -* **Color**: string (Required) -* **FieldValue**: string -* **SpecialValue**: string +* **Arn**: string (Required):

The Amazon Resource Name (ARN) of the source template of an analysis.

+* **DataSetReferences**: [DataSetReference](#datasetreference)[] (Required):

The dataset references of the source template of an analysis.

-## ColumnIdentifier +## AnchorDateConfiguration ### Properties -* **ColumnName**: string (Required) -* **DataSetIdentifier**: string (Required) +* **AnchorOption**: string +* **ParameterName**: string -## FormatConfiguration +## AnchorDateConfiguration ### Properties -* **DateTimeFormatConfiguration**: [DateTimeFormatConfiguration](#datetimeformatconfiguration) -* **NumberFormatConfiguration**: [NumberFormatConfiguration](#numberformatconfiguration) -* **StringFormatConfiguration**: [StringFormatConfiguration](#stringformatconfiguration) +* **AnchorOption**: string +* **ParameterName**: string -## DateTimeFormatConfiguration +## AnchorDateConfiguration ### Properties -* **DateTimeFormat**: string -* **NullValueFormatConfiguration**: [NullValueFormatConfiguration](#nullvalueformatconfiguration) -* **NumericFormatConfiguration**: [NumericFormatConfiguration](#numericformatconfiguration) +* **AnchorOption**: string +* **ParameterName**: string -## NullValueFormatConfiguration +## ArcAxisConfiguration ### Properties -* **NullString**: string (Required) +* **Range**: [ArcAxisDisplayRange](#arcaxisdisplayrange) +* **ReserveRange**: int -## NumericFormatConfiguration +## ArcAxisConfiguration ### Properties -* **CurrencyDisplayFormatConfiguration**: [CurrencyDisplayFormatConfiguration](#currencydisplayformatconfiguration) -* **NumberDisplayFormatConfiguration**: [NumberDisplayFormatConfiguration](#numberdisplayformatconfiguration) -* **PercentageDisplayFormatConfiguration**: [PercentageDisplayFormatConfiguration](#percentagedisplayformatconfiguration) +* **Range**: [ArcAxisDisplayRange](#arcaxisdisplayrange) +* **ReserveRange**: int -## CurrencyDisplayFormatConfiguration +## ArcAxisConfiguration ### Properties -* **DecimalPlacesConfiguration**: [DecimalPlacesConfiguration](#decimalplacesconfiguration) -* **NegativeValueConfiguration**: [NegativeValueConfiguration](#negativevalueconfiguration) -* **NullValueFormatConfiguration**: [NullValueFormatConfiguration](#nullvalueformatconfiguration) -* **NumberScale**: string -* **Prefix**: string -* **SeparatorConfiguration**: [NumericSeparatorConfiguration](#numericseparatorconfiguration) -* **Suffix**: string -* **Symbol**: string +* **Range**: [ArcAxisDisplayRange](#arcaxisdisplayrange) +* **ReserveRange**: int -## DecimalPlacesConfiguration +## ArcAxisDisplayRange ### Properties -* **DecimalPlaces**: int (Required) +* **Max**: int +* **Min**: int -## NegativeValueConfiguration +## ArcAxisDisplayRange ### Properties -* **DisplayMode**: string (Required) +* **Max**: int +* **Min**: int -## NumericSeparatorConfiguration +## ArcAxisDisplayRange ### Properties -* **DecimalSeparator**: string -* **ThousandsSeparator**: [ThousandSeparatorOptions](#thousandseparatoroptions) +* **Max**: int +* **Min**: int -## ThousandSeparatorOptions +## ArcConfiguration ### Properties -* **Symbol**: string -* **Visibility**: string +* **ArcAngle**: int +* **ArcThickness**: string -## NumberDisplayFormatConfiguration +## ArcConfiguration ### Properties -* **DecimalPlacesConfiguration**: [DecimalPlacesConfiguration](#decimalplacesconfiguration) -* **NegativeValueConfiguration**: [NegativeValueConfiguration](#negativevalueconfiguration) -* **NullValueFormatConfiguration**: [NullValueFormatConfiguration](#nullvalueformatconfiguration) -* **NumberScale**: string -* **Prefix**: string -* **SeparatorConfiguration**: [NumericSeparatorConfiguration](#numericseparatorconfiguration) -* **Suffix**: string +* **ArcAngle**: int +* **ArcThickness**: string -## PercentageDisplayFormatConfiguration +## ArcConfiguration ### Properties -* **DecimalPlacesConfiguration**: [DecimalPlacesConfiguration](#decimalplacesconfiguration) -* **NegativeValueConfiguration**: [NegativeValueConfiguration](#negativevalueconfiguration) -* **NullValueFormatConfiguration**: [NullValueFormatConfiguration](#nullvalueformatconfiguration) -* **Prefix**: string -* **SeparatorConfiguration**: [NumericSeparatorConfiguration](#numericseparatorconfiguration) -* **Suffix**: string +* **ArcAngle**: int +* **ArcThickness**: string -## NumberFormatConfiguration +## ArcOptions ### Properties -* **FormatConfiguration**: [NumericFormatConfiguration](#numericformatconfiguration) +* **ArcThickness**: string -## StringFormatConfiguration +## ArcOptions ### Properties -* **NullValueFormatConfiguration**: [NullValueFormatConfiguration](#nullvalueformatconfiguration) -* **NumericFormatConfiguration**: [NumericFormatConfiguration](#numericformatconfiguration) +* **ArcThickness**: string -## DataSetIdentifierDeclaration +## ArcOptions ### Properties -* **DataSetArn**: string (Required) -* **Identifier**: string (Required) +* **ArcThickness**: string -## FilterGroup +## AssetOptions ### Properties -* **CrossDataset**: string (Required) -* **FilterGroupId**: string (Required) -* **Filters**: [Filter](#filter)[] (Required) -* **ScopeConfiguration**: [FilterScopeConfiguration](#filterscopeconfiguration) (Required) -* **Status**: string +* **Timezone**: string +* **WeekStart**: string -## Filter +## AssetOptions ### Properties -* **CategoryFilter**: [CategoryFilter](#categoryfilter) -* **NumericEqualityFilter**: [NumericEqualityFilter](#numericequalityfilter) -* **NumericRangeFilter**: [NumericRangeFilter](#numericrangefilter) -* **RelativeDatesFilter**: [RelativeDatesFilter](#relativedatesfilter) -* **TimeEqualityFilter**: [TimeEqualityFilter](#timeequalityfilter) -* **TimeRangeFilter**: [TimeRangeFilter](#timerangefilter) -* **TopBottomFilter**: [TopBottomFilter](#topbottomfilter) +* **Timezone**: string +* **WeekStart**: string -## CategoryFilter +## AssetOptions ### Properties -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **Configuration**: [CategoryFilterConfiguration](#categoryfilterconfiguration) (Required) -* **FilterId**: string (Required) +* **Timezone**: string +* **WeekStart**: string -## CategoryFilterConfiguration +## AthenaParameters ### Properties -* **CustomFilterConfiguration**: [CustomFilterConfiguration](#customfilterconfiguration) -* **CustomFilterListConfiguration**: [CustomFilterListConfiguration](#customfilterlistconfiguration) -* **FilterListConfiguration**: [FilterListConfiguration](#filterlistconfiguration) +* **RoleArn**: string:

Use 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.

+* **WorkGroup**: string:

The workgroup that Amazon Athena uses.

-## CustomFilterConfiguration +## AttributeAggregationFunction ### Properties -* **CategoryValue**: string -* **MatchOperator**: string (Required) -* **NullOption**: string (Required) -* **ParameterName**: string -* **SelectAllOptions**: string +* **SimpleAttributeAggregation**: string +* **ValueForMultipleValues**: string -## CustomFilterListConfiguration +## AttributeAggregationFunction ### Properties -* **CategoryValues**: string[] -* **MatchOperator**: string (Required) -* **NullOption**: string (Required) -* **SelectAllOptions**: string +* **SimpleAttributeAggregation**: string +* **ValueForMultipleValues**: string -## FilterListConfiguration +## AttributeAggregationFunction ### Properties -* **CategoryValues**: string[] -* **MatchOperator**: string (Required) -* **NullOption**: string -* **SelectAllOptions**: string +* **SimpleAttributeAggregation**: string +* **ValueForMultipleValues**: string -## NumericEqualityFilter +## AuroraParameters ### Properties -* **AggregationFunction**: [AggregationFunction](#aggregationfunction) -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **FilterId**: string (Required) -* **MatchOperator**: string (Required) -* **NullOption**: string (Required) -* **ParameterName**: string -* **SelectAllOptions**: string -* **Value**: int +* **Database**: string (Required):

Database.

+* **Host**: string (Required):

Host.

+* **Port**: int (Required):

Port.

-## AggregationFunction +## AuroraPostgreSqlParameters ### Properties -* **AttributeAggregationFunction**: [AttributeAggregationFunction](#attributeaggregationfunction) -* **CategoricalAggregationFunction**: string -* **DateAggregationFunction**: string -* **NumericalAggregationFunction**: [NumericalAggregationFunction](#numericalaggregationfunction) +* **Database**: string (Required):

The Amazon Aurora PostgreSQL database to connect to.

+* **Host**: string (Required):

The Amazon Aurora PostgreSQL-Compatible host to connect to.

+* **Port**: int (Required):

The port that Amazon Aurora PostgreSQL is listening on.

-## AttributeAggregationFunction +## AWS.QuickSight/AnalysisProperties ### Properties -* **SimpleAttributeAggregation**: string -* **ValueForMultipleValues**: string +* **AnalysisId**: string (Required, Identifier) +* **Arn**: string (ReadOnly):

The Amazon Resource Name (ARN) of the analysis.

+* **AwsAccountId**: string (Required, Identifier) +* **CreatedTime**: string (ReadOnly):

The time that the analysis was created.

+* **DataSetArns**: string[] (ReadOnly):

The ARNs of the datasets of the analysis.

+* **Definition**: [AnalysisDefinition](#analysisdefinition) (WriteOnly) +* **Errors**: [AnalysisError](#analysiserror)[]:

Errors associated with the analysis.

+* **LastUpdatedTime**: string (ReadOnly):

The time that the analysis was last updated.

+* **Name**: string (Required):

The descriptive name of the analysis.

+* **Parameters**: [Parameters](#parameters) (WriteOnly) +* **Permissions**: [ResourcePermission](#resourcepermission)[] +* **Sheets**: [Sheet](#sheet)[]:

A list of the associated sheets with the unique identifier and name of each sheet.

+* **SourceEntity**: [AnalysisSourceEntity](#analysissourceentity) (WriteOnly) +* **Status**: string (WriteOnly) +* **Tags**: [Tag](#tag)[] +* **ThemeArn**: string:

The ARN of the theme of the analysis.

+* **ValidationStrategy**: [ValidationStrategy](#validationstrategy) (WriteOnly) -## NumericalAggregationFunction +## AWS.QuickSight/DashboardProperties ### Properties -* **PercentileAggregation**: [PercentileAggregation](#percentileaggregation) -* **SimpleNumericalAggregation**: string +* **Arn**: string (ReadOnly):

The Amazon Resource Name (ARN) of the resource.

+* **AwsAccountId**: string (Required, Identifier) +* **CreatedTime**: string (ReadOnly):

The time that this dashboard was created.

+* **DashboardId**: string (Required, Identifier) +* **DashboardPublishOptions**: [DashboardPublishOptions](#dashboardpublishoptions) (WriteOnly) +* **Definition**: [DashboardVersionDefinition](#dashboardversiondefinition) (WriteOnly) +* **LastPublishedTime**: string (ReadOnly):

The last time that this dashboard was published.

+* **LastUpdatedTime**: string (ReadOnly):

The last time that this dashboard was updated.

+* **LinkEntities**: string[] +* **LinkSharingConfiguration**: [LinkSharingConfiguration](#linksharingconfiguration) (WriteOnly) +* **Name**: string (Required) +* **Parameters**: [Parameters](#parameters) (WriteOnly) +* **Permissions**: [ResourcePermission](#resourcepermission)[] +* **SourceEntity**: [DashboardSourceEntity](#dashboardsourceentity) (WriteOnly) +* **Tags**: [Tag](#tag)[] +* **ThemeArn**: string (WriteOnly) +* **ValidationStrategy**: [ValidationStrategy](#validationstrategy) (WriteOnly) +* **Version**: [DashboardVersion](#dashboardversion) (ReadOnly) +* **VersionDescription**: string (WriteOnly) -## PercentileAggregation +## AWS.QuickSight/DataSetProperties ### Properties -* **PercentileValue**: int +* **Arn**: string (ReadOnly):

The Amazon Resource Name (ARN) of the resource.

+* **AwsAccountId**: string (Identifier) +* **ColumnGroups**: [ColumnGroup](#columngroup)[]:

Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.

+* **ColumnLevelPermissionRules**: [ColumnLevelPermissionRule](#columnlevelpermissionrule)[]:

A set of one or more definitions of a + ColumnLevelPermissionRule + .

+* **ConsumedSpiceCapacityInBytes**: int (ReadOnly):

The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't + imported into SPICE.

+* **CreatedTime**: string (ReadOnly):

The time that this dataset was created.

+* **DataSetId**: string (Identifier) +* **DatasetParameters**: [DatasetParameter](#datasetparameter)[]:

The parameter declarations of the dataset.

+* **DataSetRefreshProperties**: [DataSetRefreshProperties](#datasetrefreshproperties) +* **DataSetUsageConfiguration**: [DataSetUsageConfiguration](#datasetusageconfiguration) +* **FieldFolders**: [FieldFolderMap](#fieldfoldermap) (WriteOnly) +* **ImportMode**: string +* **IngestionWaitPolicy**: [IngestionWaitPolicy](#ingestionwaitpolicy) (WriteOnly) +* **LastUpdatedTime**: string (ReadOnly):

The last time that this dataset was updated.

+* **LogicalTableMap**: [LogicalTableMap](#logicaltablemap) +* **Name**: string:

The display name for the dataset.

+* **OutputColumns**: [OutputColumn](#outputcolumn)[] (ReadOnly):

The list of columns after all transforms. These columns are available in templates, + analyses, and dashboards.

+* **Permissions**: [ResourcePermission](#resourcepermission)[]:

A list of resource permissions on the dataset.

+* **PhysicalTableMap**: [PhysicalTableMap](#physicaltablemap) +* **RowLevelPermissionDataSet**: [RowLevelPermissionDataSet](#rowlevelpermissiondataset) +* **RowLevelPermissionTagConfiguration**: [RowLevelPermissionTagConfiguration](#rowlevelpermissiontagconfiguration) +* **Tags**: [Tag](#tag)[]:

Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.

-## NumericRangeFilter +## AWS.QuickSight/DataSourceProperties ### Properties -* **AggregationFunction**: [AggregationFunction](#aggregationfunction) -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **FilterId**: string (Required) -* **IncludeMaximum**: bool -* **IncludeMinimum**: bool -* **NullOption**: string (Required) -* **RangeMaximum**: [NumericRangeFilterValue](#numericrangefiltervalue) -* **RangeMinimum**: [NumericRangeFilterValue](#numericrangefiltervalue) -* **SelectAllOptions**: string +* **AlternateDataSourceParameters**: [DataSourceParameters](#datasourceparameters)[]:

A set of alternate data source parameters that you want to share for the credentials + stored with this data source. The credentials are applied in tandem with the data source + parameters when you copy a data source by using a create or update request. The API + operation compares the DataSourceParameters structure that's in the request + with the structures in the AlternateDataSourceParameters allow list. If the + structures are an exact match, the request is allowed to use the credentials from this + existing data source. If the AlternateDataSourceParameters list is null, + the Credentials originally used with this DataSourceParameters + are automatically allowed.

+* **Arn**: string (ReadOnly):

The Amazon Resource Name (ARN) of the data source.

+* **AwsAccountId**: string (Identifier) +* **CreatedTime**: string (ReadOnly):

The time that this data source was created.

+* **Credentials**: [DataSourceCredentials](#datasourcecredentials) (WriteOnly) +* **DataSourceId**: string (Identifier) +* **DataSourceParameters**: [DataSourceParameters](#datasourceparameters) +* **ErrorInfo**: [DataSourceErrorInfo](#datasourceerrorinfo) +* **LastUpdatedTime**: string (ReadOnly):

The last time that this data source was updated.

+* **Name**: string (Required) +* **Permissions**: [ResourcePermission](#resourcepermission)[] +* **SslProperties**: [SslProperties](#sslproperties) +* **Status**: string (ReadOnly) +* **Tags**: [Tag](#tag)[] +* **Type**: string (Required) +* **VpcConnectionProperties**: [VpcConnectionProperties](#vpcconnectionproperties) -## NumericRangeFilterValue +## AWS.QuickSight/RefreshScheduleProperties ### Properties -* **Parameter**: string -* **StaticValue**: int +* **Arn**: string (ReadOnly):

The Amazon Resource Name (ARN) of the data source.

+* **AwsAccountId**: string (Identifier) +* **DataSetId**: string (Identifier) +* **Schedule**: [RefreshScheduleMap](#refreshschedulemap) -## RelativeDatesFilter +## AWS.QuickSight/TemplateProperties ### Properties -* **AnchorDateConfiguration**: [AnchorDateConfiguration](#anchordateconfiguration) (Required) -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **ExcludePeriodConfiguration**: [ExcludePeriodConfiguration](#excludeperiodconfiguration) -* **FilterId**: string (Required) -* **MinimumGranularity**: string -* **NullOption**: string (Required) -* **ParameterName**: string -* **RelativeDateType**: string (Required) -* **RelativeDateValue**: int -* **TimeGranularity**: string (Required) +* **Arn**: string (ReadOnly):

The Amazon Resource Name (ARN) of the template.

+* **AwsAccountId**: string (Required, Identifier) +* **CreatedTime**: string (ReadOnly):

Time when this was created.

+* **Definition**: [TemplateVersionDefinition](#templateversiondefinition) (WriteOnly) +* **LastUpdatedTime**: string (ReadOnly):

Time when this was last updated.

+* **Name**: string +* **Permissions**: [ResourcePermission](#resourcepermission)[] +* **SourceEntity**: [TemplateSourceEntity](#templatesourceentity) (WriteOnly) +* **Tags**: [Tag](#tag)[] +* **TemplateId**: string (Required, Identifier) +* **ValidationStrategy**: [ValidationStrategy](#validationstrategy) (WriteOnly) +* **Version**: [TemplateVersion](#templateversion) (ReadOnly) +* **VersionDescription**: string (WriteOnly) -## AnchorDateConfiguration +## AWS.QuickSight/ThemeProperties ### Properties -* **AnchorOption**: string -* **ParameterName**: string +* **Arn**: string (ReadOnly):

The Amazon Resource Name (ARN) of the theme.

+* **AwsAccountId**: string (Required, Identifier) +* **BaseThemeId**: string (Required, WriteOnly) +* **Configuration**: [ThemeConfiguration](#themeconfiguration) (Required, WriteOnly) +* **CreatedTime**: string (ReadOnly):

The date and time that the theme was created.

+* **LastUpdatedTime**: string (ReadOnly):

The date and time that the theme was last updated.

+* **Name**: string (Required) +* **Permissions**: [ResourcePermission](#resourcepermission)[] +* **Tags**: [Tag](#tag)[] +* **ThemeId**: string (Required, Identifier) +* **Type**: string (ReadOnly) +* **Version**: [ThemeVersion](#themeversion) (ReadOnly) +* **VersionDescription**: string (WriteOnly) -## ExcludePeriodConfiguration +## AWS.QuickSight/TopicProperties ### Properties -* **Amount**: int (Required) -* **Granularity**: string (Required) -* **Status**: string +* **Arn**: string (ReadOnly) +* **AwsAccountId**: string (Identifier) +* **DataSets**: [DatasetMetadata](#datasetmetadata)[] +* **Description**: string +* **Name**: string +* **TopicId**: string (Identifier) +* **UserExperienceVersion**: string -## TimeEqualityFilter +## AWS.QuickSight/VPCConnectionProperties ### Properties -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **FilterId**: string (Required) -* **ParameterName**: string -* **RollingDate**: [RollingDateConfiguration](#rollingdateconfiguration) -* **TimeGranularity**: string -* **Value**: string +* **Arn**: string (ReadOnly):

The Amazon Resource Name (ARN) of the VPC connection.

+* **AvailabilityStatus**: string +* **AwsAccountId**: string (Identifier) +* **CreatedTime**: string (ReadOnly):

The time that the VPC connection was created.

+* **DnsResolvers**: string[] +* **LastUpdatedTime**: string (ReadOnly):

The time that the VPC connection was last updated.

+* **Name**: string +* **NetworkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly):

A list of network interfaces.

+* **RoleArn**: string +* **SecurityGroupIds**: string[] +* **Status**: string (ReadOnly) +* **SubnetIds**: string[] (WriteOnly) +* **Tags**: [Tag](#tag)[] +* **VPCConnectionId**: string (Identifier) +* **VPCId**: string (ReadOnly):

The Amazon EC2 VPC ID associated with the VPC connection.

-## RollingDateConfiguration +## AxisDataOptions ### Properties -* **DataSetIdentifier**: string -* **Expression**: string (Required) +* **DateAxisOptions**: [DateAxisOptions](#dateaxisoptions) +* **NumericAxisOptions**: [NumericAxisOptions](#numericaxisoptions) -## TimeRangeFilter +## AxisDataOptions ### Properties -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **ExcludePeriodConfiguration**: [ExcludePeriodConfiguration](#excludeperiodconfiguration) -* **FilterId**: string (Required) -* **IncludeMaximum**: bool -* **IncludeMinimum**: bool -* **NullOption**: string (Required) -* **RangeMaximumValue**: [TimeRangeFilterValue](#timerangefiltervalue) -* **RangeMinimumValue**: [TimeRangeFilterValue](#timerangefiltervalue) -* **TimeGranularity**: string +* **DateAxisOptions**: [DateAxisOptions](#dateaxisoptions) +* **NumericAxisOptions**: [NumericAxisOptions](#numericaxisoptions) -## TimeRangeFilterValue +## AxisDataOptions ### Properties -* **Parameter**: string -* **RollingDate**: [RollingDateConfiguration](#rollingdateconfiguration) -* **StaticValue**: string +* **DateAxisOptions**: [DateAxisOptions](#dateaxisoptions) +* **NumericAxisOptions**: [NumericAxisOptions](#numericaxisoptions) -## TopBottomFilter +## AxisDisplayDataDrivenRange +### Properties + +## AxisDisplayDataDrivenRange +### Properties + +## AxisDisplayDataDrivenRange +### Properties + +## AxisDisplayMinMaxRange +### Properties +* **Maximum**: int +* **Minimum**: int + +## AxisDisplayMinMaxRange +### Properties +* **Maximum**: int +* **Minimum**: int + +## AxisDisplayMinMaxRange +### Properties +* **Maximum**: int +* **Minimum**: int + +## AxisDisplayOptions +### Properties +* **AxisLineVisibility**: string +* **AxisOffset**: string: String based length that is composed of value and unit in px +* **DataOptions**: [AxisDataOptions](#axisdataoptions) +* **GridLineVisibility**: string +* **ScrollbarOptions**: [ScrollBarOptions](#scrollbaroptions) +* **TickLabelOptions**: [AxisTickLabelOptions](#axisticklabeloptions) + +## AxisDisplayOptions +### Properties +* **AxisLineVisibility**: string +* **AxisOffset**: string: String based length that is composed of value and unit in px +* **DataOptions**: [AxisDataOptions](#axisdataoptions) +* **GridLineVisibility**: string +* **ScrollbarOptions**: [ScrollBarOptions](#scrollbaroptions) +* **TickLabelOptions**: [AxisTickLabelOptions](#axisticklabeloptions) + +## AxisDisplayOptions +### Properties +* **AxisLineVisibility**: string +* **AxisOffset**: string: String based length that is composed of value and unit in px +* **DataOptions**: [AxisDataOptions](#axisdataoptions) +* **GridLineVisibility**: string +* **ScrollbarOptions**: [ScrollBarOptions](#scrollbaroptions) +* **TickLabelOptions**: [AxisTickLabelOptions](#axisticklabeloptions) + +## AxisDisplayRange +### Properties +* **DataDriven**: [AxisDisplayDataDrivenRange](#axisdisplaydatadrivenrange) +* **MinMax**: [AxisDisplayMinMaxRange](#axisdisplayminmaxrange) + +## AxisDisplayRange +### Properties +* **DataDriven**: [AxisDisplayDataDrivenRange](#axisdisplaydatadrivenrange) +* **MinMax**: [AxisDisplayMinMaxRange](#axisdisplayminmaxrange) + +## AxisDisplayRange +### Properties +* **DataDriven**: [AxisDisplayDataDrivenRange](#axisdisplaydatadrivenrange) +* **MinMax**: [AxisDisplayMinMaxRange](#axisdisplayminmaxrange) + +## AxisLabelOptions +### Properties +* **ApplyTo**: [AxisLabelReferenceOptions](#axislabelreferenceoptions) +* **CustomLabel**: string +* **FontConfiguration**: [FontConfiguration](#fontconfiguration) + +## AxisLabelOptions +### Properties +* **ApplyTo**: [AxisLabelReferenceOptions](#axislabelreferenceoptions) +* **CustomLabel**: string +* **FontConfiguration**: [FontConfiguration](#fontconfiguration) + +## AxisLabelOptions +### Properties +* **ApplyTo**: [AxisLabelReferenceOptions](#axislabelreferenceoptions) +* **CustomLabel**: string +* **FontConfiguration**: [FontConfiguration](#fontconfiguration) + +## AxisLabelReferenceOptions ### Properties -* **AggregationSortConfigurations**: [AggregationSortConfiguration](#aggregationsortconfiguration)[] (Required) * **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **FilterId**: string (Required) -* **Limit**: int -* **ParameterName**: string -* **TimeGranularity**: string +* **FieldId**: string (Required) -## AggregationSortConfiguration +## AxisLabelReferenceOptions ### Properties -* **AggregationFunction**: [AggregationFunction](#aggregationfunction) * **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **SortDirection**: string (Required) +* **FieldId**: string (Required) -## FilterScopeConfiguration +## AxisLabelReferenceOptions ### Properties -* **AllSheets**: [AllSheetsFilterScopeConfiguration](#allsheetsfilterscopeconfiguration) -* **SelectedSheets**: [SelectedSheetsFilterScopeConfiguration](#selectedsheetsfilterscopeconfiguration) +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) +* **FieldId**: string (Required) -## AllSheetsFilterScopeConfiguration +## AxisLinearScale +### Properties +* **StepCount**: int +* **StepSize**: int + +## AxisLinearScale +### Properties +* **StepCount**: int +* **StepSize**: int + +## AxisLinearScale +### Properties +* **StepCount**: int +* **StepSize**: int + +## AxisLogarithmicScale +### Properties +* **Base**: int + +## AxisLogarithmicScale +### Properties +* **Base**: int + +## AxisLogarithmicScale +### Properties +* **Base**: int + +## AxisScale +### Properties +* **Linear**: [AxisLinearScale](#axislinearscale) +* **Logarithmic**: [AxisLogarithmicScale](#axislogarithmicscale) + +## AxisScale +### Properties +* **Linear**: [AxisLinearScale](#axislinearscale) +* **Logarithmic**: [AxisLogarithmicScale](#axislogarithmicscale) + +## AxisScale +### Properties +* **Linear**: [AxisLinearScale](#axislinearscale) +* **Logarithmic**: [AxisLogarithmicScale](#axislogarithmicscale) + +## AxisTickLabelOptions +### Properties +* **LabelOptions**: [LabelOptions](#labeloptions) +* **RotationAngle**: int + +## AxisTickLabelOptions +### Properties +* **LabelOptions**: [LabelOptions](#labeloptions) +* **RotationAngle**: int + +## AxisTickLabelOptions +### Properties +* **LabelOptions**: [LabelOptions](#labeloptions) +* **RotationAngle**: int + +## BarChartAggregatedFieldWells +### Properties +* **Category**: [DimensionField](#dimensionfield)[] +* **Colors**: [DimensionField](#dimensionfield)[] +* **SmallMultiples**: [DimensionField](#dimensionfield)[] +* **Values**: [MeasureField](#measurefield)[] + +## BarChartAggregatedFieldWells +### Properties +* **Category**: [DimensionField](#dimensionfield)[] +* **Colors**: [DimensionField](#dimensionfield)[] +* **SmallMultiples**: [DimensionField](#dimensionfield)[] +* **Values**: [MeasureField](#measurefield)[] + +## BarChartAggregatedFieldWells +### Properties +* **Category**: [DimensionField](#dimensionfield)[] +* **Colors**: [DimensionField](#dimensionfield)[] +* **SmallMultiples**: [DimensionField](#dimensionfield)[] +* **Values**: [MeasureField](#measurefield)[] + +## BarChartConfiguration +### Properties +* **BarsArrangement**: string +* **CategoryAxis**: [AxisDisplayOptions](#axisdisplayoptions) +* **CategoryLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **ColorLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **ContributionAnalysisDefaults**: [ContributionAnalysisDefault](#contributionanalysisdefault)[] +* **DataLabels**: [DataLabelOptions](#datalabeloptions) +* **FieldWells**: [BarChartFieldWells](#barchartfieldwells) +* **Legend**: [LegendOptions](#legendoptions) +* **Orientation**: string +* **ReferenceLines**: [ReferenceLine](#referenceline)[] +* **SmallMultiplesOptions**: [SmallMultiplesOptions](#smallmultiplesoptions) +* **SortConfiguration**: [BarChartSortConfiguration](#barchartsortconfiguration) +* **Tooltip**: [TooltipOptions](#tooltipoptions) +* **ValueAxis**: [AxisDisplayOptions](#axisdisplayoptions) +* **ValueLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **VisualPalette**: [VisualPalette](#visualpalette) + +## BarChartConfiguration ### Properties +* **BarsArrangement**: string +* **CategoryAxis**: [AxisDisplayOptions](#axisdisplayoptions) +* **CategoryLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **ColorLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **ContributionAnalysisDefaults**: [ContributionAnalysisDefault](#contributionanalysisdefault)[] +* **DataLabels**: [DataLabelOptions](#datalabeloptions) +* **FieldWells**: [BarChartFieldWells](#barchartfieldwells) +* **Legend**: [LegendOptions](#legendoptions) +* **Orientation**: string +* **ReferenceLines**: [ReferenceLine](#referenceline)[] +* **SmallMultiplesOptions**: [SmallMultiplesOptions](#smallmultiplesoptions) +* **SortConfiguration**: [BarChartSortConfiguration](#barchartsortconfiguration) +* **Tooltip**: [TooltipOptions](#tooltipoptions) +* **ValueAxis**: [AxisDisplayOptions](#axisdisplayoptions) +* **ValueLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **VisualPalette**: [VisualPalette](#visualpalette) -## SelectedSheetsFilterScopeConfiguration +## BarChartConfiguration ### Properties -* **SheetVisualScopingConfigurations**: [SheetVisualScopingConfiguration](#sheetvisualscopingconfiguration)[] +* **BarsArrangement**: string +* **CategoryAxis**: [AxisDisplayOptions](#axisdisplayoptions) +* **CategoryLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **ColorLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **ContributionAnalysisDefaults**: [ContributionAnalysisDefault](#contributionanalysisdefault)[] +* **DataLabels**: [DataLabelOptions](#datalabeloptions) +* **FieldWells**: [BarChartFieldWells](#barchartfieldwells) +* **Legend**: [LegendOptions](#legendoptions) +* **Orientation**: string +* **ReferenceLines**: [ReferenceLine](#referenceline)[] +* **SmallMultiplesOptions**: [SmallMultiplesOptions](#smallmultiplesoptions) +* **SortConfiguration**: [BarChartSortConfiguration](#barchartsortconfiguration) +* **Tooltip**: [TooltipOptions](#tooltipoptions) +* **ValueAxis**: [AxisDisplayOptions](#axisdisplayoptions) +* **ValueLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **VisualPalette**: [VisualPalette](#visualpalette) -## SheetVisualScopingConfiguration +## BarChartFieldWells ### Properties -* **Scope**: string (Required) -* **SheetId**: string (Required) -* **VisualIds**: string[] +* **BarChartAggregatedFieldWells**: [BarChartAggregatedFieldWells](#barchartaggregatedfieldwells) -## AssetOptions +## BarChartFieldWells ### Properties -* **Timezone**: string -* **WeekStart**: string +* **BarChartAggregatedFieldWells**: [BarChartAggregatedFieldWells](#barchartaggregatedfieldwells) -## ParameterDeclaration +## BarChartFieldWells ### Properties -* **DateTimeParameterDeclaration**: [DateTimeParameterDeclaration](#datetimeparameterdeclaration) -* **DecimalParameterDeclaration**: [DecimalParameterDeclaration](#decimalparameterdeclaration) -* **IntegerParameterDeclaration**: [IntegerParameterDeclaration](#integerparameterdeclaration) -* **StringParameterDeclaration**: [StringParameterDeclaration](#stringparameterdeclaration) +* **BarChartAggregatedFieldWells**: [BarChartAggregatedFieldWells](#barchartaggregatedfieldwells) -## DateTimeParameterDeclaration +## BarChartSortConfiguration ### Properties -* **DefaultValues**: [DateTimeDefaultValues](#datetimedefaultvalues) -* **MappedDataSetParameters**: [MappedDataSetParameter](#mappeddatasetparameter)[] -* **Name**: string (Required) -* **TimeGranularity**: string -* **ValueWhenUnset**: [DateTimeValueWhenUnsetConfiguration](#datetimevaluewhenunsetconfiguration) +* **CategoryItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) +* **CategorySort**: [FieldSortOptions](#fieldsortoptions)[] +* **ColorItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) +* **ColorSort**: [FieldSortOptions](#fieldsortoptions)[] +* **SmallMultiplesLimitConfiguration**: [ItemsLimitConfiguration](#itemslimitconfiguration) +* **SmallMultiplesSort**: [FieldSortOptions](#fieldsortoptions)[] -## DateTimeDefaultValues +## BarChartSortConfiguration ### Properties -* **DynamicValue**: [DynamicDefaultValue](#dynamicdefaultvalue) -* **RollingDate**: [RollingDateConfiguration](#rollingdateconfiguration) -* **StaticValues**: string[] +* **CategoryItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) +* **CategorySort**: [FieldSortOptions](#fieldsortoptions)[] +* **ColorItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) +* **ColorSort**: [FieldSortOptions](#fieldsortoptions)[] +* **SmallMultiplesLimitConfiguration**: [ItemsLimitConfiguration](#itemslimitconfiguration) +* **SmallMultiplesSort**: [FieldSortOptions](#fieldsortoptions)[] -## DynamicDefaultValue +## BarChartSortConfiguration ### Properties -* **DefaultValueColumn**: [ColumnIdentifier](#columnidentifier) (Required) -* **GroupNameColumn**: [ColumnIdentifier](#columnidentifier) -* **UserNameColumn**: [ColumnIdentifier](#columnidentifier) +* **CategoryItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) +* **CategorySort**: [FieldSortOptions](#fieldsortoptions)[] +* **ColorItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) +* **ColorSort**: [FieldSortOptions](#fieldsortoptions)[] +* **SmallMultiplesLimitConfiguration**: [ItemsLimitConfiguration](#itemslimitconfiguration) +* **SmallMultiplesSort**: [FieldSortOptions](#fieldsortoptions)[] -## MappedDataSetParameter +## BarChartVisual ### Properties -* **DataSetIdentifier**: string (Required) -* **DataSetParameterName**: string (Required) +* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **ChartConfiguration**: [BarChartConfiguration](#barchartconfiguration) +* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] +* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) +* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) +* **VisualId**: string (Required) -## DateTimeValueWhenUnsetConfiguration +## BarChartVisual ### Properties -* **CustomValue**: string -* **ValueWhenUnsetOption**: string +* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **ChartConfiguration**: [BarChartConfiguration](#barchartconfiguration) +* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] +* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) +* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) +* **VisualId**: string (Required) -## DecimalParameterDeclaration +## BarChartVisual ### Properties -* **DefaultValues**: [DecimalDefaultValues](#decimaldefaultvalues) -* **MappedDataSetParameters**: [MappedDataSetParameter](#mappeddatasetparameter)[] -* **Name**: string (Required) -* **ParameterValueType**: string (Required) -* **ValueWhenUnset**: [DecimalValueWhenUnsetConfiguration](#decimalvaluewhenunsetconfiguration) +* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **ChartConfiguration**: [BarChartConfiguration](#barchartconfiguration) +* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] +* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) +* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) +* **VisualId**: string (Required) -## DecimalDefaultValues +## BinCountOptions ### Properties -* **DynamicValue**: [DynamicDefaultValue](#dynamicdefaultvalue) -* **StaticValues**: int[] +* **Value**: int -## DecimalValueWhenUnsetConfiguration +## BinCountOptions ### Properties -* **CustomValue**: int -* **ValueWhenUnsetOption**: string +* **Value**: int -## IntegerParameterDeclaration +## BinCountOptions ### Properties -* **DefaultValues**: [IntegerDefaultValues](#integerdefaultvalues) -* **MappedDataSetParameters**: [MappedDataSetParameter](#mappeddatasetparameter)[] -* **Name**: string (Required) -* **ParameterValueType**: string (Required) -* **ValueWhenUnset**: [IntegerValueWhenUnsetConfiguration](#integervaluewhenunsetconfiguration) +* **Value**: int -## IntegerDefaultValues +## BinWidthOptions ### Properties -* **DynamicValue**: [DynamicDefaultValue](#dynamicdefaultvalue) -* **StaticValues**: int[] +* **BinCountLimit**: int +* **Value**: int -## IntegerValueWhenUnsetConfiguration +## BinWidthOptions ### Properties -* **CustomValue**: int -* **ValueWhenUnsetOption**: string +* **BinCountLimit**: int +* **Value**: int -## StringParameterDeclaration +## BinWidthOptions ### Properties -* **DefaultValues**: [StringDefaultValues](#stringdefaultvalues) -* **MappedDataSetParameters**: [MappedDataSetParameter](#mappeddatasetparameter)[] -* **Name**: string (Required) -* **ParameterValueType**: string (Required) -* **ValueWhenUnset**: [StringValueWhenUnsetConfiguration](#stringvaluewhenunsetconfiguration) +* **BinCountLimit**: int +* **Value**: int -## StringDefaultValues +## BodySectionConfiguration ### Properties -* **DynamicValue**: [DynamicDefaultValue](#dynamicdefaultvalue) -* **StaticValues**: string[] +* **Content**: [BodySectionContent](#bodysectioncontent) (Required) +* **PageBreakConfiguration**: [SectionPageBreakConfiguration](#sectionpagebreakconfiguration) +* **SectionId**: string (Required) +* **Style**: [SectionStyle](#sectionstyle) -## StringValueWhenUnsetConfiguration +## BodySectionConfiguration ### Properties -* **CustomValue**: string -* **ValueWhenUnsetOption**: string +* **Content**: [BodySectionContent](#bodysectioncontent) (Required) +* **PageBreakConfiguration**: [SectionPageBreakConfiguration](#sectionpagebreakconfiguration) +* **SectionId**: string (Required) +* **Style**: [SectionStyle](#sectionstyle) -## SheetDefinition +## BodySectionConfiguration ### Properties -* **ContentType**: string -* **Description**: string -* **FilterControls**: [FilterControl](#filtercontrol)[] -* **Layouts**: [Layout](#layout)[] -* **Name**: string -* **ParameterControls**: [ParameterControl](#parametercontrol)[] -* **SheetControlLayouts**: [SheetControlLayout](#sheetcontrollayout)[] -* **SheetId**: string (Required) -* **TextBoxes**: [SheetTextBox](#sheettextbox)[] -* **Title**: string -* **Visuals**: [Visual](#visual)[] +* **Content**: [BodySectionContent](#bodysectioncontent) (Required) +* **PageBreakConfiguration**: [SectionPageBreakConfiguration](#sectionpagebreakconfiguration) +* **SectionId**: string (Required) +* **Style**: [SectionStyle](#sectionstyle) -## FilterControl +## BodySectionContent ### Properties -* **DateTimePicker**: [FilterDateTimePickerControl](#filterdatetimepickercontrol) -* **Dropdown**: [FilterDropDownControl](#filterdropdowncontrol) -* **List**: [FilterListControl](#filterlistcontrol) -* **RelativeDateTime**: [FilterRelativeDateTimeControl](#filterrelativedatetimecontrol) -* **Slider**: [FilterSliderControl](#filterslidercontrol) -* **TextArea**: [FilterTextAreaControl](#filtertextareacontrol) -* **TextField**: [FilterTextFieldControl](#filtertextfieldcontrol) +* **Layout**: [SectionLayoutConfiguration](#sectionlayoutconfiguration) -## FilterDateTimePickerControl +## BodySectionContent ### Properties -* **DisplayOptions**: [DateTimePickerControlDisplayOptions](#datetimepickercontroldisplayoptions) -* **FilterControlId**: string (Required) -* **SourceFilterId**: string (Required) -* **Title**: string (Required) -* **Type**: string +* **Layout**: [SectionLayoutConfiguration](#sectionlayoutconfiguration) -## DateTimePickerControlDisplayOptions +## BodySectionContent ### Properties -* **DateTimeFormat**: string -* **InfoIconLabelOptions**: [SheetControlInfoIconLabelOptions](#sheetcontrolinfoiconlabeloptions) -* **TitleOptions**: [LabelOptions](#labeloptions) +* **Layout**: [SectionLayoutConfiguration](#sectionlayoutconfiguration) -## SheetControlInfoIconLabelOptions +## BorderStyle ### Properties -* **InfoIconText**: string -* **Visibility**: string +* **Show**: bool:

The option to enable display of borders for visuals.

-## LabelOptions +## BoxPlotAggregatedFieldWells ### Properties -* **CustomLabel**: string -* **FontConfiguration**: [FontConfiguration](#fontconfiguration) -* **Visibility**: string +* **GroupBy**: [DimensionField](#dimensionfield)[] +* **Values**: [MeasureField](#measurefield)[] -## FontConfiguration +## BoxPlotAggregatedFieldWells ### Properties -* **FontColor**: string -* **FontDecoration**: string -* **FontSize**: [FontSize](#fontsize) -* **FontStyle**: string -* **FontWeight**: [FontWeight](#fontweight) +* **GroupBy**: [DimensionField](#dimensionfield)[] +* **Values**: [MeasureField](#measurefield)[] -## FontSize +## BoxPlotAggregatedFieldWells ### Properties -* **Relative**: string +* **GroupBy**: [DimensionField](#dimensionfield)[] +* **Values**: [MeasureField](#measurefield)[] -## FontWeight +## BoxPlotChartConfiguration ### Properties -* **Name**: string +* **BoxPlotOptions**: [BoxPlotOptions](#boxplotoptions) +* **CategoryAxis**: [AxisDisplayOptions](#axisdisplayoptions) +* **CategoryLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **FieldWells**: [BoxPlotFieldWells](#boxplotfieldwells) +* **Legend**: [LegendOptions](#legendoptions) +* **PrimaryYAxisDisplayOptions**: [AxisDisplayOptions](#axisdisplayoptions) +* **PrimaryYAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **ReferenceLines**: [ReferenceLine](#referenceline)[] +* **SortConfiguration**: [BoxPlotSortConfiguration](#boxplotsortconfiguration) +* **Tooltip**: [TooltipOptions](#tooltipoptions) +* **VisualPalette**: [VisualPalette](#visualpalette) -## FilterDropDownControl +## BoxPlotChartConfiguration ### Properties -* **CascadingControlConfiguration**: [CascadingControlConfiguration](#cascadingcontrolconfiguration) -* **DisplayOptions**: [DropDownControlDisplayOptions](#dropdowncontroldisplayoptions) -* **FilterControlId**: string (Required) -* **SelectableValues**: [FilterSelectableValues](#filterselectablevalues) -* **SourceFilterId**: string (Required) -* **Title**: string (Required) -* **Type**: string +* **BoxPlotOptions**: [BoxPlotOptions](#boxplotoptions) +* **CategoryAxis**: [AxisDisplayOptions](#axisdisplayoptions) +* **CategoryLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **FieldWells**: [BoxPlotFieldWells](#boxplotfieldwells) +* **Legend**: [LegendOptions](#legendoptions) +* **PrimaryYAxisDisplayOptions**: [AxisDisplayOptions](#axisdisplayoptions) +* **PrimaryYAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **ReferenceLines**: [ReferenceLine](#referenceline)[] +* **SortConfiguration**: [BoxPlotSortConfiguration](#boxplotsortconfiguration) +* **Tooltip**: [TooltipOptions](#tooltipoptions) +* **VisualPalette**: [VisualPalette](#visualpalette) -## CascadingControlConfiguration +## BoxPlotChartConfiguration ### Properties -* **SourceControls**: [CascadingControlSource](#cascadingcontrolsource)[] +* **BoxPlotOptions**: [BoxPlotOptions](#boxplotoptions) +* **CategoryAxis**: [AxisDisplayOptions](#axisdisplayoptions) +* **CategoryLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **FieldWells**: [BoxPlotFieldWells](#boxplotfieldwells) +* **Legend**: [LegendOptions](#legendoptions) +* **PrimaryYAxisDisplayOptions**: [AxisDisplayOptions](#axisdisplayoptions) +* **PrimaryYAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **ReferenceLines**: [ReferenceLine](#referenceline)[] +* **SortConfiguration**: [BoxPlotSortConfiguration](#boxplotsortconfiguration) +* **Tooltip**: [TooltipOptions](#tooltipoptions) +* **VisualPalette**: [VisualPalette](#visualpalette) -## CascadingControlSource +## BoxPlotFieldWells ### Properties -* **ColumnToMatch**: [ColumnIdentifier](#columnidentifier) -* **SourceSheetControlId**: string +* **BoxPlotAggregatedFieldWells**: [BoxPlotAggregatedFieldWells](#boxplotaggregatedfieldwells) -## DropDownControlDisplayOptions +## BoxPlotFieldWells ### Properties -* **InfoIconLabelOptions**: [SheetControlInfoIconLabelOptions](#sheetcontrolinfoiconlabeloptions) -* **SelectAllOptions**: [ListControlSelectAllOptions](#listcontrolselectalloptions) -* **TitleOptions**: [LabelOptions](#labeloptions) +* **BoxPlotAggregatedFieldWells**: [BoxPlotAggregatedFieldWells](#boxplotaggregatedfieldwells) -## ListControlSelectAllOptions +## BoxPlotFieldWells ### Properties -* **Visibility**: string +* **BoxPlotAggregatedFieldWells**: [BoxPlotAggregatedFieldWells](#boxplotaggregatedfieldwells) -## FilterSelectableValues +## BoxPlotOptions ### Properties -* **Values**: string[] +* **AllDataPointsVisibility**: string +* **OutlierVisibility**: string +* **StyleOptions**: [BoxPlotStyleOptions](#boxplotstyleoptions) -## FilterListControl +## BoxPlotOptions ### Properties -* **CascadingControlConfiguration**: [CascadingControlConfiguration](#cascadingcontrolconfiguration) -* **DisplayOptions**: [ListControlDisplayOptions](#listcontroldisplayoptions) -* **FilterControlId**: string (Required) -* **SelectableValues**: [FilterSelectableValues](#filterselectablevalues) -* **SourceFilterId**: string (Required) -* **Title**: string (Required) -* **Type**: string +* **AllDataPointsVisibility**: string +* **OutlierVisibility**: string +* **StyleOptions**: [BoxPlotStyleOptions](#boxplotstyleoptions) -## ListControlDisplayOptions +## BoxPlotOptions ### Properties -* **InfoIconLabelOptions**: [SheetControlInfoIconLabelOptions](#sheetcontrolinfoiconlabeloptions) -* **SearchOptions**: [ListControlSearchOptions](#listcontrolsearchoptions) -* **SelectAllOptions**: [ListControlSelectAllOptions](#listcontrolselectalloptions) -* **TitleOptions**: [LabelOptions](#labeloptions) +* **AllDataPointsVisibility**: string +* **OutlierVisibility**: string +* **StyleOptions**: [BoxPlotStyleOptions](#boxplotstyleoptions) -## ListControlSearchOptions +## BoxPlotSortConfiguration ### Properties -* **Visibility**: string +* **CategorySort**: [FieldSortOptions](#fieldsortoptions)[] +* **PaginationConfiguration**: [PaginationConfiguration](#paginationconfiguration) -## FilterRelativeDateTimeControl +## BoxPlotSortConfiguration ### Properties -* **DisplayOptions**: [RelativeDateTimeControlDisplayOptions](#relativedatetimecontroldisplayoptions) -* **FilterControlId**: string (Required) -* **SourceFilterId**: string (Required) -* **Title**: string (Required) +* **CategorySort**: [FieldSortOptions](#fieldsortoptions)[] +* **PaginationConfiguration**: [PaginationConfiguration](#paginationconfiguration) -## RelativeDateTimeControlDisplayOptions +## BoxPlotSortConfiguration ### Properties -* **DateTimeFormat**: string -* **InfoIconLabelOptions**: [SheetControlInfoIconLabelOptions](#sheetcontrolinfoiconlabeloptions) -* **TitleOptions**: [LabelOptions](#labeloptions) +* **CategorySort**: [FieldSortOptions](#fieldsortoptions)[] +* **PaginationConfiguration**: [PaginationConfiguration](#paginationconfiguration) -## FilterSliderControl +## BoxPlotStyleOptions ### Properties -* **DisplayOptions**: [SliderControlDisplayOptions](#slidercontroldisplayoptions) -* **FilterControlId**: string (Required) -* **MaximumValue**: int (Required) -* **MinimumValue**: int (Required) -* **SourceFilterId**: string (Required) -* **StepSize**: int (Required) -* **Title**: string (Required) -* **Type**: string +* **FillStyle**: string -## SliderControlDisplayOptions +## BoxPlotStyleOptions ### Properties -* **InfoIconLabelOptions**: [SheetControlInfoIconLabelOptions](#sheetcontrolinfoiconlabeloptions) -* **TitleOptions**: [LabelOptions](#labeloptions) +* **FillStyle**: string -## FilterTextAreaControl +## BoxPlotStyleOptions ### Properties -* **Delimiter**: string -* **DisplayOptions**: [TextAreaControlDisplayOptions](#textareacontroldisplayoptions) -* **FilterControlId**: string (Required) -* **SourceFilterId**: string (Required) -* **Title**: string (Required) +* **FillStyle**: string -## TextAreaControlDisplayOptions +## BoxPlotVisual ### Properties -* **InfoIconLabelOptions**: [SheetControlInfoIconLabelOptions](#sheetcontrolinfoiconlabeloptions) -* **PlaceholderOptions**: [TextControlPlaceholderOptions](#textcontrolplaceholderoptions) -* **TitleOptions**: [LabelOptions](#labeloptions) +* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **ChartConfiguration**: [BoxPlotChartConfiguration](#boxplotchartconfiguration) +* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] +* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) +* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) +* **VisualId**: string (Required) -## TextControlPlaceholderOptions +## BoxPlotVisual ### Properties -* **Visibility**: string +* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **ChartConfiguration**: [BoxPlotChartConfiguration](#boxplotchartconfiguration) +* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] +* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) +* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) +* **VisualId**: string (Required) -## FilterTextFieldControl +## BoxPlotVisual ### Properties -* **DisplayOptions**: [TextFieldControlDisplayOptions](#textfieldcontroldisplayoptions) -* **FilterControlId**: string (Required) -* **SourceFilterId**: string (Required) -* **Title**: string (Required) +* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **ChartConfiguration**: [BoxPlotChartConfiguration](#boxplotchartconfiguration) +* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] +* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) +* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) +* **VisualId**: string (Required) -## TextFieldControlDisplayOptions +## CalculatedField ### Properties -* **InfoIconLabelOptions**: [SheetControlInfoIconLabelOptions](#sheetcontrolinfoiconlabeloptions) -* **PlaceholderOptions**: [TextControlPlaceholderOptions](#textcontrolplaceholderoptions) -* **TitleOptions**: [LabelOptions](#labeloptions) +* **DataSetIdentifier**: string (Required) +* **Expression**: string (Required) +* **Name**: string (Required) -## Layout +## CalculatedField ### Properties -* **Configuration**: [LayoutConfiguration](#layoutconfiguration) (Required) +* **DataSetIdentifier**: string (Required) +* **Expression**: string (Required) +* **Name**: string (Required) -## LayoutConfiguration +## CalculatedField ### Properties -* **FreeFormLayout**: [FreeFormLayoutConfiguration](#freeformlayoutconfiguration) -* **GridLayout**: [GridLayoutConfiguration](#gridlayoutconfiguration) -* **SectionBasedLayout**: [SectionBasedLayoutConfiguration](#sectionbasedlayoutconfiguration) +* **DataSetIdentifier**: string (Required) +* **Expression**: string (Required) +* **Name**: string (Required) -## FreeFormLayoutConfiguration +## CalculatedMeasureField ### Properties -* **CanvasSizeOptions**: [FreeFormLayoutCanvasSizeOptions](#freeformlayoutcanvassizeoptions) -* **Elements**: [FreeFormLayoutElement](#freeformlayoutelement)[] (Required) +* **Expression**: string (Required) +* **FieldId**: string (Required) -## FreeFormLayoutElement +## CalculatedMeasureField ### Properties -* **BackgroundStyle**: [FreeFormLayoutElementBackgroundStyle](#freeformlayoutelementbackgroundstyle) -* **BorderStyle**: [FreeFormLayoutElementBorderStyle](#freeformlayoutelementborderstyle) -* **ElementId**: string (Required) -* **ElementType**: string (Required) -* **Height**: string (Required): String based length that is composed of value and unit in px -* **LoadingAnimation**: [LoadingAnimation](#loadinganimation) -* **RenderingRules**: [SheetElementRenderingRule](#sheetelementrenderingrule)[] -* **SelectedBorderStyle**: [FreeFormLayoutElementBorderStyle](#freeformlayoutelementborderstyle) -* **Visibility**: string -* **Width**: string (Required): String based length that is composed of value and unit in px -* **XAxisLocation**: string (Required): String based length that is composed of value and unit in px -* **YAxisLocation**: string (Required): String based length that is composed of value and unit in px with Integer.MAX_VALUE as maximum value +* **Expression**: string (Required) +* **FieldId**: string (Required) -## FreeFormLayoutElementBackgroundStyle +## CalculatedMeasureField ### Properties -* **Color**: string -* **Visibility**: string +* **Expression**: string (Required) +* **FieldId**: string (Required) -## FreeFormLayoutElementBorderStyle +## CascadingControlConfiguration ### Properties -* **Color**: string -* **Visibility**: string +* **SourceControls**: [CascadingControlSource](#cascadingcontrolsource)[] -## LoadingAnimation +## CascadingControlConfiguration ### Properties -* **Visibility**: string +* **SourceControls**: [CascadingControlSource](#cascadingcontrolsource)[] -## SheetElementRenderingRule +## CascadingControlConfiguration ### Properties -* **ConfigurationOverrides**: [SheetElementConfigurationOverrides](#sheetelementconfigurationoverrides) (Required) -* **Expression**: string (Required) +* **SourceControls**: [CascadingControlSource](#cascadingcontrolsource)[] -## SheetElementConfigurationOverrides +## CascadingControlSource ### Properties -* **Visibility**: string +* **ColumnToMatch**: [ColumnIdentifier](#columnidentifier) +* **SourceSheetControlId**: string -## GridLayoutConfiguration +## CascadingControlSource ### Properties -* **CanvasSizeOptions**: [GridLayoutCanvasSizeOptions](#gridlayoutcanvassizeoptions) -* **Elements**: [GridLayoutElement](#gridlayoutelement)[] (Required) +* **ColumnToMatch**: [ColumnIdentifier](#columnidentifier) +* **SourceSheetControlId**: string -## GridLayoutElement +## CascadingControlSource ### Properties -* **ColumnIndex**: int -* **ColumnSpan**: int (Required) -* **ElementId**: string (Required) -* **ElementType**: string (Required) -* **RowIndex**: int -* **RowSpan**: int (Required) +* **ColumnToMatch**: [ColumnIdentifier](#columnidentifier) +* **SourceSheetControlId**: string -## SectionBasedLayoutConfiguration +## CategoricalDimensionField ### Properties -* **BodySections**: [BodySectionConfiguration](#bodysectionconfiguration)[] (Required) -* **CanvasSizeOptions**: [SectionBasedLayoutCanvasSizeOptions](#sectionbasedlayoutcanvassizeoptions) (Required) -* **FooterSections**: [HeaderFooterSectionConfiguration](#headerfootersectionconfiguration)[] (Required) -* **HeaderSections**: [HeaderFooterSectionConfiguration](#headerfootersectionconfiguration)[] (Required) +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) +* **FieldId**: string (Required) +* **FormatConfiguration**: [StringFormatConfiguration](#stringformatconfiguration) +* **HierarchyId**: string -## BodySectionConfiguration +## CategoricalDimensionField ### Properties -* **Content**: [BodySectionContent](#bodysectioncontent) (Required) -* **PageBreakConfiguration**: [SectionPageBreakConfiguration](#sectionpagebreakconfiguration) -* **SectionId**: string (Required) -* **Style**: [SectionStyle](#sectionstyle) +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) +* **FieldId**: string (Required) +* **FormatConfiguration**: [StringFormatConfiguration](#stringformatconfiguration) +* **HierarchyId**: string -## BodySectionContent +## CategoricalDimensionField ### Properties -* **Layout**: [SectionLayoutConfiguration](#sectionlayoutconfiguration) +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) +* **FieldId**: string (Required) +* **FormatConfiguration**: [StringFormatConfiguration](#stringformatconfiguration) +* **HierarchyId**: string -## SectionLayoutConfiguration +## CategoricalMeasureField ### Properties -* **FreeFormLayout**: [FreeFormSectionLayoutConfiguration](#freeformsectionlayoutconfiguration) (Required) +* **AggregationFunction**: string +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) +* **FieldId**: string (Required) +* **FormatConfiguration**: [StringFormatConfiguration](#stringformatconfiguration) -## FreeFormSectionLayoutConfiguration +## CategoricalMeasureField ### Properties -* **Elements**: [FreeFormLayoutElement](#freeformlayoutelement)[] (Required) +* **AggregationFunction**: string +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) +* **FieldId**: string (Required) +* **FormatConfiguration**: [StringFormatConfiguration](#stringformatconfiguration) -## SectionPageBreakConfiguration +## CategoricalMeasureField ### Properties -* **After**: [SectionAfterPageBreak](#sectionafterpagebreak) +* **AggregationFunction**: string +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) +* **FieldId**: string (Required) +* **FormatConfiguration**: [StringFormatConfiguration](#stringformatconfiguration) -## SectionAfterPageBreak +## CategoryDrillDownFilter ### Properties -* **Status**: string +* **CategoryValues**: string[] (Required) +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -## SectionStyle +## CategoryDrillDownFilter ### Properties -* **Height**: string: String based length that is composed of value and unit in px -* **Padding**: [Spacing](#spacing) +* **CategoryValues**: string[] (Required) +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -## HeaderFooterSectionConfiguration +## CategoryDrillDownFilter ### Properties -* **Layout**: [SectionLayoutConfiguration](#sectionlayoutconfiguration) (Required) -* **SectionId**: string (Required) -* **Style**: [SectionStyle](#sectionstyle) +* **CategoryValues**: string[] (Required) +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -## ParameterControl +## CategoryFilter ### Properties -* **DateTimePicker**: [ParameterDateTimePickerControl](#parameterdatetimepickercontrol) -* **Dropdown**: [ParameterDropDownControl](#parameterdropdowncontrol) -* **List**: [ParameterListControl](#parameterlistcontrol) -* **Slider**: [ParameterSliderControl](#parameterslidercontrol) -* **TextArea**: [ParameterTextAreaControl](#parametertextareacontrol) -* **TextField**: [ParameterTextFieldControl](#parametertextfieldcontrol) +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) +* **Configuration**: [CategoryFilterConfiguration](#categoryfilterconfiguration) (Required) +* **DefaultFilterControlConfiguration**: [DefaultFilterControlConfiguration](#defaultfiltercontrolconfiguration) +* **FilterId**: string (Required) -## ParameterDateTimePickerControl +## CategoryFilter ### Properties -* **DisplayOptions**: [DateTimePickerControlDisplayOptions](#datetimepickercontroldisplayoptions) -* **ParameterControlId**: string (Required) -* **SourceParameterName**: string (Required) -* **Title**: string (Required) +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) +* **Configuration**: [CategoryFilterConfiguration](#categoryfilterconfiguration) (Required) +* **DefaultFilterControlConfiguration**: [DefaultFilterControlConfiguration](#defaultfiltercontrolconfiguration) +* **FilterId**: string (Required) -## ParameterDropDownControl +## CategoryFilter ### Properties -* **CascadingControlConfiguration**: [CascadingControlConfiguration](#cascadingcontrolconfiguration) -* **DisplayOptions**: [DropDownControlDisplayOptions](#dropdowncontroldisplayoptions) -* **ParameterControlId**: string (Required) -* **SelectableValues**: [ParameterSelectableValues](#parameterselectablevalues) -* **SourceParameterName**: string (Required) -* **Title**: string (Required) -* **Type**: string +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) +* **Configuration**: [CategoryFilterConfiguration](#categoryfilterconfiguration) (Required) +* **DefaultFilterControlConfiguration**: [DefaultFilterControlConfiguration](#defaultfiltercontrolconfiguration) +* **FilterId**: string (Required) -## ParameterSelectableValues +## CategoryFilterConfiguration ### Properties -* **LinkToDataSetColumn**: [ColumnIdentifier](#columnidentifier) -* **Values**: string[] +* **CustomFilterConfiguration**: [CustomFilterConfiguration](#customfilterconfiguration) +* **CustomFilterListConfiguration**: [CustomFilterListConfiguration](#customfilterlistconfiguration) +* **FilterListConfiguration**: [FilterListConfiguration](#filterlistconfiguration) -## ParameterListControl +## CategoryFilterConfiguration ### Properties -* **CascadingControlConfiguration**: [CascadingControlConfiguration](#cascadingcontrolconfiguration) -* **DisplayOptions**: [ListControlDisplayOptions](#listcontroldisplayoptions) -* **ParameterControlId**: string (Required) -* **SelectableValues**: [ParameterSelectableValues](#parameterselectablevalues) -* **SourceParameterName**: string (Required) -* **Title**: string (Required) -* **Type**: string +* **CustomFilterConfiguration**: [CustomFilterConfiguration](#customfilterconfiguration) +* **CustomFilterListConfiguration**: [CustomFilterListConfiguration](#customfilterlistconfiguration) +* **FilterListConfiguration**: [FilterListConfiguration](#filterlistconfiguration) -## ParameterSliderControl +## CategoryFilterConfiguration ### Properties -* **DisplayOptions**: [SliderControlDisplayOptions](#slidercontroldisplayoptions) -* **MaximumValue**: int (Required) -* **MinimumValue**: int (Required) -* **ParameterControlId**: string (Required) -* **SourceParameterName**: string (Required) -* **StepSize**: int (Required) -* **Title**: string (Required) +* **CustomFilterConfiguration**: [CustomFilterConfiguration](#customfilterconfiguration) +* **CustomFilterListConfiguration**: [CustomFilterListConfiguration](#customfilterlistconfiguration) +* **FilterListConfiguration**: [FilterListConfiguration](#filterlistconfiguration) -## ParameterTextAreaControl +## CellValueSynonym ### Properties -* **Delimiter**: string -* **DisplayOptions**: [TextAreaControlDisplayOptions](#textareacontroldisplayoptions) -* **ParameterControlId**: string (Required) -* **SourceParameterName**: string (Required) -* **Title**: string (Required) +* **CellValue**: string +* **Synonyms**: string[] -## ParameterTextFieldControl +## ChartAxisLabelOptions ### Properties -* **DisplayOptions**: [TextFieldControlDisplayOptions](#textfieldcontroldisplayoptions) -* **ParameterControlId**: string (Required) -* **SourceParameterName**: string (Required) -* **Title**: string (Required) +* **AxisLabelOptions**: [AxisLabelOptions](#axislabeloptions)[] +* **SortIconVisibility**: string +* **Visibility**: string -## SheetControlLayout +## ChartAxisLabelOptions ### Properties -* **Configuration**: [SheetControlLayoutConfiguration](#sheetcontrollayoutconfiguration) (Required) +* **AxisLabelOptions**: [AxisLabelOptions](#axislabeloptions)[] +* **SortIconVisibility**: string +* **Visibility**: string -## SheetControlLayoutConfiguration +## ChartAxisLabelOptions ### Properties -* **GridLayout**: [GridLayoutConfiguration](#gridlayoutconfiguration) +* **AxisLabelOptions**: [AxisLabelOptions](#axislabeloptions)[] +* **SortIconVisibility**: string +* **Visibility**: string -## SheetTextBox +## ClusterMarker ### Properties -* **Content**: string -* **SheetTextBoxId**: string (Required) +* **SimpleClusterMarker**: [SimpleClusterMarker](#simpleclustermarker) -## Visual +## ClusterMarker ### Properties -* **BarChartVisual**: [BarChartVisual](#barchartvisual) -* **BoxPlotVisual**: [BoxPlotVisual](#boxplotvisual) -* **ComboChartVisual**: [ComboChartVisual](#combochartvisual) -* **CustomContentVisual**: [CustomContentVisual](#customcontentvisual) -* **EmptyVisual**: [EmptyVisual](#emptyvisual) -* **FilledMapVisual**: [FilledMapVisual](#filledmapvisual) -* **FunnelChartVisual**: [FunnelChartVisual](#funnelchartvisual) -* **GaugeChartVisual**: [GaugeChartVisual](#gaugechartvisual) -* **GeospatialMapVisual**: [GeospatialMapVisual](#geospatialmapvisual) -* **HeatMapVisual**: [HeatMapVisual](#heatmapvisual) -* **HistogramVisual**: [HistogramVisual](#histogramvisual) -* **InsightVisual**: [InsightVisual](#insightvisual) -* **KPIVisual**: [KPIVisual](#kpivisual) -* **LineChartVisual**: [LineChartVisual](#linechartvisual) -* **PieChartVisual**: [PieChartVisual](#piechartvisual) -* **PivotTableVisual**: [PivotTableVisual](#pivottablevisual) -* **RadarChartVisual**: [RadarChartVisual](#radarchartvisual) -* **SankeyDiagramVisual**: [SankeyDiagramVisual](#sankeydiagramvisual) -* **ScatterPlotVisual**: [ScatterPlotVisual](#scatterplotvisual) -* **TableVisual**: [TableVisual](#tablevisual) -* **TreeMapVisual**: [TreeMapVisual](#treemapvisual) -* **WaterfallVisual**: [WaterfallVisual](#waterfallvisual) -* **WordCloudVisual**: [WordCloudVisual](#wordcloudvisual) +* **SimpleClusterMarker**: [SimpleClusterMarker](#simpleclustermarker) -## BarChartVisual +## ClusterMarker ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [BarChartConfiguration](#barchartconfiguration) -* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] -* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) -* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) -* **VisualId**: string (Required) +* **SimpleClusterMarker**: [SimpleClusterMarker](#simpleclustermarker) -## VisualCustomAction +## ClusterMarkerConfiguration ### Properties -* **ActionOperations**: [VisualCustomActionOperation](#visualcustomactionoperation)[] (Required) -* **CustomActionId**: string (Required) -* **Name**: string (Required) -* **Status**: string -* **Trigger**: string (Required) +* **ClusterMarker**: [ClusterMarker](#clustermarker) -## VisualCustomActionOperation +## ClusterMarkerConfiguration ### Properties -* **FilterOperation**: [CustomActionFilterOperation](#customactionfilteroperation) -* **NavigationOperation**: [CustomActionNavigationOperation](#customactionnavigationoperation) -* **SetParametersOperation**: [CustomActionSetParametersOperation](#customactionsetparametersoperation) -* **URLOperation**: [CustomActionURLOperation](#customactionurloperation) +* **ClusterMarker**: [ClusterMarker](#clustermarker) -## CustomActionFilterOperation +## ClusterMarkerConfiguration ### Properties -* **SelectedFieldsConfiguration**: [FilterOperationSelectedFieldsConfiguration](#filteroperationselectedfieldsconfiguration) (Required) -* **TargetVisualsConfiguration**: [FilterOperationTargetVisualsConfiguration](#filteroperationtargetvisualsconfiguration) (Required) +* **ClusterMarker**: [ClusterMarker](#clustermarker) -## FilterOperationSelectedFieldsConfiguration +## CollectiveConstant ### Properties -* **SelectedColumns**: [ColumnIdentifier](#columnidentifier)[] -* **SelectedFieldOptions**: string -* **SelectedFields**: string[] +* **ValueList**: string[] -## FilterOperationTargetVisualsConfiguration +## ColorScale ### Properties -* **SameSheetTargetVisualConfiguration**: [SameSheetTargetVisualConfiguration](#samesheettargetvisualconfiguration) +* **ColorFillType**: string (Required) +* **Colors**: [DataColor](#datacolor)[] (Required) +* **NullValueColor**: [DataColor](#datacolor) -## SameSheetTargetVisualConfiguration +## ColorScale ### Properties -* **TargetVisualOptions**: string -* **TargetVisuals**: string[] +* **ColorFillType**: string (Required) +* **Colors**: [DataColor](#datacolor)[] (Required) +* **NullValueColor**: [DataColor](#datacolor) -## CustomActionNavigationOperation +## ColorScale ### Properties -* **LocalNavigationConfiguration**: [LocalNavigationConfiguration](#localnavigationconfiguration) +* **ColorFillType**: string (Required) +* **Colors**: [DataColor](#datacolor)[] (Required) +* **NullValueColor**: [DataColor](#datacolor) -## LocalNavigationConfiguration +## ColorsConfiguration ### Properties -* **TargetSheetId**: string (Required) +* **CustomColors**: [CustomColor](#customcolor)[] -## CustomActionSetParametersOperation +## ColorsConfiguration ### Properties -* **ParameterValueConfigurations**: [SetParameterValueConfiguration](#setparametervalueconfiguration)[] (Required) +* **CustomColors**: [CustomColor](#customcolor)[] -## SetParameterValueConfiguration +## ColorsConfiguration ### Properties -* **DestinationParameterName**: string (Required) -* **Value**: [DestinationParameterValueConfiguration](#destinationparametervalueconfiguration) (Required) +* **CustomColors**: [CustomColor](#customcolor)[] -## DestinationParameterValueConfiguration +## ColumnConfiguration ### Properties -* **CustomValuesConfiguration**: [CustomValuesConfiguration](#customvaluesconfiguration) -* **SelectAllValueOptions**: string -* **SourceColumn**: [ColumnIdentifier](#columnidentifier) -* **SourceField**: string -* **SourceParameterName**: string +* **ColorsConfiguration**: [ColorsConfiguration](#colorsconfiguration) +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) +* **FormatConfiguration**: [FormatConfiguration](#formatconfiguration) +* **Role**: string -## CustomValuesConfiguration +## ColumnConfiguration ### Properties -* **CustomValues**: [CustomParameterValues](#customparametervalues) (Required) -* **IncludeNullValue**: bool +* **ColorsConfiguration**: [ColorsConfiguration](#colorsconfiguration) +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) +* **FormatConfiguration**: [FormatConfiguration](#formatconfiguration) +* **Role**: string -## CustomParameterValues +## ColumnConfiguration ### Properties -* **DateTimeValues**: string[] -* **DecimalValues**: int[] -* **IntegerValues**: int[] -* **StringValues**: string[] +* **ColorsConfiguration**: [ColorsConfiguration](#colorsconfiguration) +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) +* **FormatConfiguration**: [FormatConfiguration](#formatconfiguration) +* **Role**: string -## CustomActionURLOperation +## ColumnGroup ### Properties -* **URLTarget**: string (Required) -* **URLTemplate**: string (Required) +* **GeoSpatialColumnGroup**: [GeoSpatialColumnGroup](#geospatialcolumngroup) -## BarChartConfiguration +## ColumnGroupColumnSchema ### Properties -* **BarsArrangement**: string -* **CategoryAxis**: [AxisDisplayOptions](#axisdisplayoptions) -* **CategoryLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **ColorLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **ContributionAnalysisDefaults**: [ContributionAnalysisDefault](#contributionanalysisdefault)[] -* **DataLabels**: [DataLabelOptions](#datalabeloptions) -* **FieldWells**: [BarChartFieldWells](#barchartfieldwells) -* **Legend**: [LegendOptions](#legendoptions) -* **Orientation**: string -* **ReferenceLines**: [ReferenceLine](#referenceline)[] -* **SmallMultiplesOptions**: [SmallMultiplesOptions](#smallmultiplesoptions) -* **SortConfiguration**: [BarChartSortConfiguration](#barchartsortconfiguration) -* **Tooltip**: [TooltipOptions](#tooltipoptions) -* **ValueAxis**: [AxisDisplayOptions](#axisdisplayoptions) -* **ValueLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **VisualPalette**: [VisualPalette](#visualpalette) +* **Name**: string:

The name of the column group's column schema.

-## AxisDisplayOptions +## ColumnGroupSchema ### Properties -* **AxisLineVisibility**: string -* **AxisOffset**: string: String based length that is composed of value and unit in px -* **DataOptions**: [AxisDataOptions](#axisdataoptions) -* **GridLineVisibility**: string -* **ScrollbarOptions**: [ScrollBarOptions](#scrollbaroptions) -* **TickLabelOptions**: [AxisTickLabelOptions](#axisticklabeloptions) +* **ColumnGroupColumnSchemaList**: [ColumnGroupColumnSchema](#columngroupcolumnschema)[]:

A structure containing the list of schemas for column group columns.

+* **Name**: string:

The name of the column group schema.

-## AxisDataOptions +## ColumnHierarchy ### Properties -* **DateAxisOptions**: [DateAxisOptions](#dateaxisoptions) -* **NumericAxisOptions**: [NumericAxisOptions](#numericaxisoptions) +* **DateTimeHierarchy**: [DateTimeHierarchy](#datetimehierarchy) +* **ExplicitHierarchy**: [ExplicitHierarchy](#explicithierarchy) +* **PredefinedHierarchy**: [PredefinedHierarchy](#predefinedhierarchy) -## DateAxisOptions +## ColumnHierarchy ### Properties -* **MissingDateVisibility**: string +* **DateTimeHierarchy**: [DateTimeHierarchy](#datetimehierarchy) +* **ExplicitHierarchy**: [ExplicitHierarchy](#explicithierarchy) +* **PredefinedHierarchy**: [PredefinedHierarchy](#predefinedhierarchy) -## NumericAxisOptions +## ColumnHierarchy ### Properties -* **Range**: [AxisDisplayRange](#axisdisplayrange) -* **Scale**: [AxisScale](#axisscale) +* **DateTimeHierarchy**: [DateTimeHierarchy](#datetimehierarchy) +* **ExplicitHierarchy**: [ExplicitHierarchy](#explicithierarchy) +* **PredefinedHierarchy**: [PredefinedHierarchy](#predefinedhierarchy) -## AxisDisplayRange +## ColumnIdentifier ### Properties -* **DataDriven**: [AxisDisplayDataDrivenRange](#axisdisplaydatadrivenrange) -* **MinMax**: [AxisDisplayMinMaxRange](#axisdisplayminmaxrange) +* **ColumnName**: string (Required) +* **DataSetIdentifier**: string (Required) -## AxisDisplayDataDrivenRange +## ColumnIdentifier ### Properties +* **ColumnName**: string (Required) +* **DataSetIdentifier**: string (Required) -## AxisDisplayMinMaxRange +## ColumnIdentifier ### Properties -* **Maximum**: int -* **Minimum**: int +* **ColumnName**: string (Required) +* **DataSetIdentifier**: string (Required) -## AxisScale +## ColumnLevelPermissionRule ### Properties -* **Linear**: [AxisLinearScale](#axislinearscale) -* **Logarithmic**: [AxisLogarithmicScale](#axislogarithmicscale) +* **ColumnNames**: string[]:

An array of column names.

+* **Principals**: string[]:

An array of Amazon Resource Names (ARNs) for Amazon QuickSight users or groups.

-## AxisLinearScale +## ColumnSchema ### Properties -* **StepCount**: int -* **StepSize**: int +* **DataType**: string:

The data type of the column schema.

+* **GeographicRole**: string:

The geographic role of the column schema.

+* **Name**: string:

The name of the column schema.

-## AxisLogarithmicScale +## ColumnSort ### Properties -* **Base**: int +* **AggregationFunction**: [AggregationFunction](#aggregationfunction) +* **Direction**: string (Required) +* **SortBy**: [ColumnIdentifier](#columnidentifier) (Required) -## ScrollBarOptions +## ColumnSort ### Properties -* **Visibility**: string -* **VisibleRange**: [VisibleRangeOptions](#visiblerangeoptions) +* **AggregationFunction**: [AggregationFunction](#aggregationfunction) +* **Direction**: string (Required) +* **SortBy**: [ColumnIdentifier](#columnidentifier) (Required) -## VisibleRangeOptions +## ColumnSort ### Properties -* **PercentRange**: [PercentVisibleRange](#percentvisiblerange) +* **AggregationFunction**: [AggregationFunction](#aggregationfunction) +* **Direction**: string (Required) +* **SortBy**: [ColumnIdentifier](#columnidentifier) (Required) -## PercentVisibleRange +## ColumnTooltipItem ### Properties -* **From**: int -* **To**: int +* **Aggregation**: [AggregationFunction](#aggregationfunction) +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) +* **Label**: string +* **Visibility**: string -## AxisTickLabelOptions +## ColumnTooltipItem ### Properties -* **LabelOptions**: [LabelOptions](#labeloptions) -* **RotationAngle**: int +* **Aggregation**: [AggregationFunction](#aggregationfunction) +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) +* **Label**: string +* **Visibility**: string -## ChartAxisLabelOptions +## ColumnTooltipItem ### Properties -* **AxisLabelOptions**: [AxisLabelOptions](#axislabeloptions)[] -* **SortIconVisibility**: string +* **Aggregation**: [AggregationFunction](#aggregationfunction) +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) +* **Label**: string * **Visibility**: string -## AxisLabelOptions +## ComboChartAggregatedFieldWells ### Properties -* **ApplyTo**: [AxisLabelReferenceOptions](#axislabelreferenceoptions) -* **CustomLabel**: string -* **FontConfiguration**: [FontConfiguration](#fontconfiguration) +* **BarValues**: [MeasureField](#measurefield)[] +* **Category**: [DimensionField](#dimensionfield)[] +* **Colors**: [DimensionField](#dimensionfield)[] +* **LineValues**: [MeasureField](#measurefield)[] -## AxisLabelReferenceOptions +## ComboChartAggregatedFieldWells ### Properties -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **FieldId**: string (Required) +* **BarValues**: [MeasureField](#measurefield)[] +* **Category**: [DimensionField](#dimensionfield)[] +* **Colors**: [DimensionField](#dimensionfield)[] +* **LineValues**: [MeasureField](#measurefield)[] -## ContributionAnalysisDefault +## ComboChartAggregatedFieldWells ### Properties -* **ContributorDimensions**: [ColumnIdentifier](#columnidentifier)[] (Required) -* **MeasureFieldId**: string (Required) +* **BarValues**: [MeasureField](#measurefield)[] +* **Category**: [DimensionField](#dimensionfield)[] +* **Colors**: [DimensionField](#dimensionfield)[] +* **LineValues**: [MeasureField](#measurefield)[] -## DataLabelOptions +## ComboChartConfiguration ### Properties -* **CategoryLabelVisibility**: string -* **DataLabelTypes**: [DataLabelType](#datalabeltype)[] -* **LabelColor**: string -* **LabelContent**: string -* **LabelFontConfiguration**: [FontConfiguration](#fontconfiguration) -* **MeasureLabelVisibility**: string -* **Overlap**: string -* **Position**: string -* **TotalsVisibility**: string -* **Visibility**: string +* **BarDataLabels**: [DataLabelOptions](#datalabeloptions) +* **BarsArrangement**: string +* **CategoryAxis**: [AxisDisplayOptions](#axisdisplayoptions) +* **CategoryLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **ColorLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **FieldWells**: [ComboChartFieldWells](#combochartfieldwells) +* **Legend**: [LegendOptions](#legendoptions) +* **LineDataLabels**: [DataLabelOptions](#datalabeloptions) +* **PrimaryYAxisDisplayOptions**: [AxisDisplayOptions](#axisdisplayoptions) +* **PrimaryYAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **ReferenceLines**: [ReferenceLine](#referenceline)[] +* **SecondaryYAxisDisplayOptions**: [AxisDisplayOptions](#axisdisplayoptions) +* **SecondaryYAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **SortConfiguration**: [ComboChartSortConfiguration](#combochartsortconfiguration) +* **Tooltip**: [TooltipOptions](#tooltipoptions) +* **VisualPalette**: [VisualPalette](#visualpalette) -## DataLabelType +## ComboChartConfiguration ### Properties -* **DataPathLabelType**: [DataPathLabelType](#datapathlabeltype) -* **FieldLabelType**: [FieldLabelType](#fieldlabeltype) -* **MaximumLabelType**: [MaximumLabelType](#maximumlabeltype) -* **MinimumLabelType**: [MinimumLabelType](#minimumlabeltype) -* **RangeEndsLabelType**: [RangeEndsLabelType](#rangeendslabeltype) +* **BarDataLabels**: [DataLabelOptions](#datalabeloptions) +* **BarsArrangement**: string +* **CategoryAxis**: [AxisDisplayOptions](#axisdisplayoptions) +* **CategoryLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **ColorLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **FieldWells**: [ComboChartFieldWells](#combochartfieldwells) +* **Legend**: [LegendOptions](#legendoptions) +* **LineDataLabels**: [DataLabelOptions](#datalabeloptions) +* **PrimaryYAxisDisplayOptions**: [AxisDisplayOptions](#axisdisplayoptions) +* **PrimaryYAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **ReferenceLines**: [ReferenceLine](#referenceline)[] +* **SecondaryYAxisDisplayOptions**: [AxisDisplayOptions](#axisdisplayoptions) +* **SecondaryYAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **SortConfiguration**: [ComboChartSortConfiguration](#combochartsortconfiguration) +* **Tooltip**: [TooltipOptions](#tooltipoptions) +* **VisualPalette**: [VisualPalette](#visualpalette) -## DataPathLabelType +## ComboChartConfiguration ### Properties -* **FieldId**: string -* **FieldValue**: string -* **Visibility**: string +* **BarDataLabels**: [DataLabelOptions](#datalabeloptions) +* **BarsArrangement**: string +* **CategoryAxis**: [AxisDisplayOptions](#axisdisplayoptions) +* **CategoryLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **ColorLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **FieldWells**: [ComboChartFieldWells](#combochartfieldwells) +* **Legend**: [LegendOptions](#legendoptions) +* **LineDataLabels**: [DataLabelOptions](#datalabeloptions) +* **PrimaryYAxisDisplayOptions**: [AxisDisplayOptions](#axisdisplayoptions) +* **PrimaryYAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **ReferenceLines**: [ReferenceLine](#referenceline)[] +* **SecondaryYAxisDisplayOptions**: [AxisDisplayOptions](#axisdisplayoptions) +* **SecondaryYAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **SortConfiguration**: [ComboChartSortConfiguration](#combochartsortconfiguration) +* **Tooltip**: [TooltipOptions](#tooltipoptions) +* **VisualPalette**: [VisualPalette](#visualpalette) -## FieldLabelType +## ComboChartFieldWells ### Properties -* **FieldId**: string -* **Visibility**: string +* **ComboChartAggregatedFieldWells**: [ComboChartAggregatedFieldWells](#combochartaggregatedfieldwells) -## MaximumLabelType +## ComboChartFieldWells ### Properties -* **Visibility**: string +* **ComboChartAggregatedFieldWells**: [ComboChartAggregatedFieldWells](#combochartaggregatedfieldwells) -## MinimumLabelType +## ComboChartFieldWells ### Properties -* **Visibility**: string +* **ComboChartAggregatedFieldWells**: [ComboChartAggregatedFieldWells](#combochartaggregatedfieldwells) -## RangeEndsLabelType +## ComboChartSortConfiguration ### Properties -* **Visibility**: string +* **CategoryItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) +* **CategorySort**: [FieldSortOptions](#fieldsortoptions)[] +* **ColorItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) +* **ColorSort**: [FieldSortOptions](#fieldsortoptions)[] -## BarChartFieldWells +## ComboChartSortConfiguration ### Properties -* **BarChartAggregatedFieldWells**: [BarChartAggregatedFieldWells](#barchartaggregatedfieldwells) +* **CategoryItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) +* **CategorySort**: [FieldSortOptions](#fieldsortoptions)[] +* **ColorItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) +* **ColorSort**: [FieldSortOptions](#fieldsortoptions)[] + +## ComboChartSortConfiguration +### Properties +* **CategoryItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) +* **CategorySort**: [FieldSortOptions](#fieldsortoptions)[] +* **ColorItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) +* **ColorSort**: [FieldSortOptions](#fieldsortoptions)[] -## BarChartAggregatedFieldWells +## ComboChartVisual ### Properties -* **Category**: [DimensionField](#dimensionfield)[] -* **Colors**: [DimensionField](#dimensionfield)[] -* **SmallMultiples**: [DimensionField](#dimensionfield)[] -* **Values**: [MeasureField](#measurefield)[] +* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **ChartConfiguration**: [ComboChartConfiguration](#combochartconfiguration) +* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] +* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) +* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) +* **VisualId**: string (Required) -## DimensionField +## ComboChartVisual ### Properties -* **CategoricalDimensionField**: [CategoricalDimensionField](#categoricaldimensionfield) -* **DateDimensionField**: [DateDimensionField](#datedimensionfield) -* **NumericalDimensionField**: [NumericalDimensionField](#numericaldimensionfield) +* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **ChartConfiguration**: [ComboChartConfiguration](#combochartconfiguration) +* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] +* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) +* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) +* **VisualId**: string (Required) -## CategoricalDimensionField +## ComboChartVisual ### Properties -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **FieldId**: string (Required) -* **FormatConfiguration**: [StringFormatConfiguration](#stringformatconfiguration) -* **HierarchyId**: string +* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **ChartConfiguration**: [ComboChartConfiguration](#combochartconfiguration) +* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] +* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) +* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) +* **VisualId**: string (Required) -## DateDimensionField +## ComparativeOrder ### Properties -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **DateGranularity**: string -* **FieldId**: string (Required) -* **FormatConfiguration**: [DateTimeFormatConfiguration](#datetimeformatconfiguration) -* **HierarchyId**: string +* **SpecifedOrder**: string[] +* **TreatUndefinedSpecifiedValues**: string +* **UseOrdering**: string -## NumericalDimensionField +## ComparisonConfiguration ### Properties -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **FieldId**: string (Required) -* **FormatConfiguration**: [NumberFormatConfiguration](#numberformatconfiguration) -* **HierarchyId**: string +* **ComparisonFormat**: [ComparisonFormatConfiguration](#comparisonformatconfiguration) +* **ComparisonMethod**: string -## MeasureField +## ComparisonConfiguration ### Properties -* **CalculatedMeasureField**: [CalculatedMeasureField](#calculatedmeasurefield) -* **CategoricalMeasureField**: [CategoricalMeasureField](#categoricalmeasurefield) -* **DateMeasureField**: [DateMeasureField](#datemeasurefield) -* **NumericalMeasureField**: [NumericalMeasureField](#numericalmeasurefield) +* **ComparisonFormat**: [ComparisonFormatConfiguration](#comparisonformatconfiguration) +* **ComparisonMethod**: string -## CalculatedMeasureField +## ComparisonConfiguration ### Properties -* **Expression**: string (Required) -* **FieldId**: string (Required) +* **ComparisonFormat**: [ComparisonFormatConfiguration](#comparisonformatconfiguration) +* **ComparisonMethod**: string -## CategoricalMeasureField +## ComparisonFormatConfiguration ### Properties -* **AggregationFunction**: string -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **FieldId**: string (Required) -* **FormatConfiguration**: [StringFormatConfiguration](#stringformatconfiguration) +* **NumberDisplayFormatConfiguration**: [NumberDisplayFormatConfiguration](#numberdisplayformatconfiguration) +* **PercentageDisplayFormatConfiguration**: [PercentageDisplayFormatConfiguration](#percentagedisplayformatconfiguration) -## DateMeasureField +## ComparisonFormatConfiguration ### Properties -* **AggregationFunction**: string -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **FieldId**: string (Required) -* **FormatConfiguration**: [DateTimeFormatConfiguration](#datetimeformatconfiguration) +* **NumberDisplayFormatConfiguration**: [NumberDisplayFormatConfiguration](#numberdisplayformatconfiguration) +* **PercentageDisplayFormatConfiguration**: [PercentageDisplayFormatConfiguration](#percentagedisplayformatconfiguration) -## NumericalMeasureField +## ComparisonFormatConfiguration ### Properties -* **AggregationFunction**: [NumericalAggregationFunction](#numericalaggregationfunction) -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **FieldId**: string (Required) -* **FormatConfiguration**: [NumberFormatConfiguration](#numberformatconfiguration) +* **NumberDisplayFormatConfiguration**: [NumberDisplayFormatConfiguration](#numberdisplayformatconfiguration) +* **PercentageDisplayFormatConfiguration**: [PercentageDisplayFormatConfiguration](#percentagedisplayformatconfiguration) -## LegendOptions +## Computation ### Properties -* **Height**: string: String based length that is composed of value and unit in px -* **Position**: string -* **Title**: [LabelOptions](#labeloptions) -* **Visibility**: string -* **Width**: string: String based length that is composed of value and unit in px +* **Forecast**: [ForecastComputation](#forecastcomputation) +* **GrowthRate**: [GrowthRateComputation](#growthratecomputation) +* **MaximumMinimum**: [MaximumMinimumComputation](#maximumminimumcomputation) +* **MetricComparison**: [MetricComparisonComputation](#metriccomparisoncomputation) +* **PeriodOverPeriod**: [PeriodOverPeriodComputation](#periodoverperiodcomputation) +* **PeriodToDate**: [PeriodToDateComputation](#periodtodatecomputation) +* **TopBottomMovers**: [TopBottomMoversComputation](#topbottommoverscomputation) +* **TopBottomRanked**: [TopBottomRankedComputation](#topbottomrankedcomputation) +* **TotalAggregation**: [TotalAggregationComputation](#totalaggregationcomputation) +* **UniqueValues**: [UniqueValuesComputation](#uniquevaluescomputation) -## ReferenceLine +## Computation ### Properties -* **DataConfiguration**: [ReferenceLineDataConfiguration](#referencelinedataconfiguration) (Required) -* **LabelConfiguration**: [ReferenceLineLabelConfiguration](#referencelinelabelconfiguration) -* **Status**: string -* **StyleConfiguration**: [ReferenceLineStyleConfiguration](#referencelinestyleconfiguration) +* **Forecast**: [ForecastComputation](#forecastcomputation) +* **GrowthRate**: [GrowthRateComputation](#growthratecomputation) +* **MaximumMinimum**: [MaximumMinimumComputation](#maximumminimumcomputation) +* **MetricComparison**: [MetricComparisonComputation](#metriccomparisoncomputation) +* **PeriodOverPeriod**: [PeriodOverPeriodComputation](#periodoverperiodcomputation) +* **PeriodToDate**: [PeriodToDateComputation](#periodtodatecomputation) +* **TopBottomMovers**: [TopBottomMoversComputation](#topbottommoverscomputation) +* **TopBottomRanked**: [TopBottomRankedComputation](#topbottomrankedcomputation) +* **TotalAggregation**: [TotalAggregationComputation](#totalaggregationcomputation) +* **UniqueValues**: [UniqueValuesComputation](#uniquevaluescomputation) -## ReferenceLineDataConfiguration +## Computation ### Properties -* **AxisBinding**: string -* **DynamicConfiguration**: [ReferenceLineDynamicDataConfiguration](#referencelinedynamicdataconfiguration) -* **SeriesType**: string -* **StaticConfiguration**: [ReferenceLineStaticDataConfiguration](#referencelinestaticdataconfiguration) +* **Forecast**: [ForecastComputation](#forecastcomputation) +* **GrowthRate**: [GrowthRateComputation](#growthratecomputation) +* **MaximumMinimum**: [MaximumMinimumComputation](#maximumminimumcomputation) +* **MetricComparison**: [MetricComparisonComputation](#metriccomparisoncomputation) +* **PeriodOverPeriod**: [PeriodOverPeriodComputation](#periodoverperiodcomputation) +* **PeriodToDate**: [PeriodToDateComputation](#periodtodatecomputation) +* **TopBottomMovers**: [TopBottomMoversComputation](#topbottommoverscomputation) +* **TopBottomRanked**: [TopBottomRankedComputation](#topbottomrankedcomputation) +* **TotalAggregation**: [TotalAggregationComputation](#totalaggregationcomputation) +* **UniqueValues**: [UniqueValuesComputation](#uniquevaluescomputation) -## ReferenceLineDynamicDataConfiguration +## ConditionalFormattingColor ### Properties -* **Calculation**: [NumericalAggregationFunction](#numericalaggregationfunction) (Required) -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **MeasureAggregationFunction**: [AggregationFunction](#aggregationfunction) +* **Gradient**: [ConditionalFormattingGradientColor](#conditionalformattinggradientcolor) +* **Solid**: [ConditionalFormattingSolidColor](#conditionalformattingsolidcolor) -## ReferenceLineStaticDataConfiguration +## ConditionalFormattingColor ### Properties -* **Value**: int (Required) +* **Gradient**: [ConditionalFormattingGradientColor](#conditionalformattinggradientcolor) +* **Solid**: [ConditionalFormattingSolidColor](#conditionalformattingsolidcolor) -## ReferenceLineLabelConfiguration +## ConditionalFormattingColor ### Properties -* **CustomLabelConfiguration**: [ReferenceLineCustomLabelConfiguration](#referencelinecustomlabelconfiguration) -* **FontColor**: string -* **FontConfiguration**: [FontConfiguration](#fontconfiguration) -* **HorizontalPosition**: string -* **ValueLabelConfiguration**: [ReferenceLineValueLabelConfiguration](#referencelinevaluelabelconfiguration) -* **VerticalPosition**: string +* **Gradient**: [ConditionalFormattingGradientColor](#conditionalformattinggradientcolor) +* **Solid**: [ConditionalFormattingSolidColor](#conditionalformattingsolidcolor) -## ReferenceLineCustomLabelConfiguration +## ConditionalFormattingCustomIconCondition ### Properties -* **CustomLabel**: string (Required) +* **Color**: string +* **DisplayConfiguration**: [ConditionalFormattingIconDisplayConfiguration](#conditionalformattingicondisplayconfiguration) +* **Expression**: string (Required) +* **IconOptions**: [ConditionalFormattingCustomIconOptions](#conditionalformattingcustomiconoptions) (Required) -## ReferenceLineValueLabelConfiguration +## ConditionalFormattingCustomIconCondition ### Properties -* **FormatConfiguration**: [NumericFormatConfiguration](#numericformatconfiguration) -* **RelativePosition**: string +* **Color**: string +* **DisplayConfiguration**: [ConditionalFormattingIconDisplayConfiguration](#conditionalformattingicondisplayconfiguration) +* **Expression**: string (Required) +* **IconOptions**: [ConditionalFormattingCustomIconOptions](#conditionalformattingcustomiconoptions) (Required) -## ReferenceLineStyleConfiguration +## ConditionalFormattingCustomIconCondition ### Properties * **Color**: string -* **Pattern**: string +* **DisplayConfiguration**: [ConditionalFormattingIconDisplayConfiguration](#conditionalformattingicondisplayconfiguration) +* **Expression**: string (Required) +* **IconOptions**: [ConditionalFormattingCustomIconOptions](#conditionalformattingcustomiconoptions) (Required) -## SmallMultiplesOptions +## ConditionalFormattingCustomIconOptions ### Properties -* **MaxVisibleColumns**: int -* **MaxVisibleRows**: int -* **PanelConfiguration**: [PanelConfiguration](#panelconfiguration) -* **XAxis**: [SmallMultiplesAxisProperties](#smallmultiplesaxisproperties) -* **YAxis**: [SmallMultiplesAxisProperties](#smallmultiplesaxisproperties) +* **Icon**: string +* **UnicodeIcon**: string -## PanelConfiguration +## ConditionalFormattingCustomIconOptions ### Properties -* **BackgroundColor**: string -* **BackgroundVisibility**: string -* **BorderColor**: string -* **BorderStyle**: string -* **BorderThickness**: string: String based length that is composed of value and unit in px -* **BorderVisibility**: string -* **GutterSpacing**: string: String based length that is composed of value and unit in px -* **GutterVisibility**: string -* **Title**: [PanelTitleOptions](#paneltitleoptions) +* **Icon**: string +* **UnicodeIcon**: string -## PanelTitleOptions +## ConditionalFormattingCustomIconOptions ### Properties -* **FontConfiguration**: [FontConfiguration](#fontconfiguration) -* **HorizontalTextAlignment**: string -* **Visibility**: string +* **Icon**: string +* **UnicodeIcon**: string -## SmallMultiplesAxisProperties +## ConditionalFormattingGradientColor ### Properties -* **Placement**: string -* **Scale**: string +* **Color**: [GradientColor](#gradientcolor) (Required) +* **Expression**: string (Required) -## BarChartSortConfiguration +## ConditionalFormattingGradientColor ### Properties -* **CategoryItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) -* **CategorySort**: [FieldSortOptions](#fieldsortoptions)[] -* **ColorItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) -* **ColorSort**: [FieldSortOptions](#fieldsortoptions)[] -* **SmallMultiplesLimitConfiguration**: [ItemsLimitConfiguration](#itemslimitconfiguration) -* **SmallMultiplesSort**: [FieldSortOptions](#fieldsortoptions)[] +* **Color**: [GradientColor](#gradientcolor) (Required) +* **Expression**: string (Required) -## ItemsLimitConfiguration +## ConditionalFormattingGradientColor ### Properties -* **ItemsLimit**: int -* **OtherCategories**: string +* **Color**: [GradientColor](#gradientcolor) (Required) +* **Expression**: string (Required) -## FieldSortOptions +## ConditionalFormattingIcon ### Properties -* **ColumnSort**: [ColumnSort](#columnsort) -* **FieldSort**: [FieldSort](#fieldsort) +* **CustomCondition**: [ConditionalFormattingCustomIconCondition](#conditionalformattingcustomiconcondition) +* **IconSet**: [ConditionalFormattingIconSet](#conditionalformattingiconset) -## ColumnSort +## ConditionalFormattingIcon ### Properties -* **AggregationFunction**: [AggregationFunction](#aggregationfunction) -* **Direction**: string (Required) -* **SortBy**: [ColumnIdentifier](#columnidentifier) (Required) +* **CustomCondition**: [ConditionalFormattingCustomIconCondition](#conditionalformattingcustomiconcondition) +* **IconSet**: [ConditionalFormattingIconSet](#conditionalformattingiconset) -## FieldSort +## ConditionalFormattingIcon ### Properties -* **Direction**: string (Required) -* **FieldId**: string (Required) +* **CustomCondition**: [ConditionalFormattingCustomIconCondition](#conditionalformattingcustomiconcondition) +* **IconSet**: [ConditionalFormattingIconSet](#conditionalformattingiconset) -## TooltipOptions +## ConditionalFormattingIconDisplayConfiguration ### Properties -* **FieldBasedTooltip**: [FieldBasedTooltip](#fieldbasedtooltip) -* **SelectedTooltipType**: string -* **TooltipVisibility**: string +* **IconDisplayOption**: string -## FieldBasedTooltip +## ConditionalFormattingIconDisplayConfiguration ### Properties -* **AggregationVisibility**: string -* **TooltipFields**: [TooltipItem](#tooltipitem)[] -* **TooltipTitleType**: string +* **IconDisplayOption**: string -## TooltipItem +## ConditionalFormattingIconDisplayConfiguration ### Properties -* **ColumnTooltipItem**: [ColumnTooltipItem](#columntooltipitem) -* **FieldTooltipItem**: [FieldTooltipItem](#fieldtooltipitem) +* **IconDisplayOption**: string -## ColumnTooltipItem +## ConditionalFormattingIconSet ### Properties -* **Aggregation**: [AggregationFunction](#aggregationfunction) -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **Label**: string -* **Visibility**: string +* **Expression**: string (Required) +* **IconSetType**: string -## FieldTooltipItem +## ConditionalFormattingIconSet ### Properties -* **FieldId**: string (Required) -* **Label**: string -* **Visibility**: string +* **Expression**: string (Required) +* **IconSetType**: string -## VisualPalette +## ConditionalFormattingIconSet ### Properties -* **ChartColor**: string -* **ColorMap**: [DataPathColor](#datapathcolor)[] +* **Expression**: string (Required) +* **IconSetType**: string -## DataPathColor +## ConditionalFormattingSolidColor ### Properties -* **Color**: string (Required) -* **Element**: [DataPathValue](#datapathvalue) (Required) -* **TimeGranularity**: string +* **Color**: string +* **Expression**: string (Required) -## DataPathValue +## ConditionalFormattingSolidColor ### Properties -* **DataPathType**: [DataPathType](#datapathtype) -* **FieldId**: string -* **FieldValue**: string +* **Color**: string +* **Expression**: string (Required) -## DataPathType +## ConditionalFormattingSolidColor ### Properties -* **PivotTableDataPathType**: string +* **Color**: string +* **Expression**: string (Required) -## ColumnHierarchy +## ContributionAnalysisDefault ### Properties -* **DateTimeHierarchy**: [DateTimeHierarchy](#datetimehierarchy) -* **ExplicitHierarchy**: [ExplicitHierarchy](#explicithierarchy) -* **PredefinedHierarchy**: [PredefinedHierarchy](#predefinedhierarchy) +* **ContributorDimensions**: [ColumnIdentifier](#columnidentifier)[] (Required) +* **MeasureFieldId**: string (Required) -## DateTimeHierarchy +## ContributionAnalysisDefault ### Properties -* **DrillDownFilters**: [DrillDownFilter](#drilldownfilter)[] -* **HierarchyId**: string (Required) +* **ContributorDimensions**: [ColumnIdentifier](#columnidentifier)[] (Required) +* **MeasureFieldId**: string (Required) -## DrillDownFilter +## ContributionAnalysisDefault ### Properties -* **CategoryFilter**: [CategoryDrillDownFilter](#categorydrilldownfilter) -* **NumericEqualityFilter**: [NumericEqualityDrillDownFilter](#numericequalitydrilldownfilter) -* **TimeRangeFilter**: [TimeRangeDrillDownFilter](#timerangedrilldownfilter) +* **ContributorDimensions**: [ColumnIdentifier](#columnidentifier)[] (Required) +* **MeasureFieldId**: string (Required) -## CategoryDrillDownFilter +## CredentialPair ### Properties -* **CategoryValues**: string[] (Required) -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) +* **AlternateDataSourceParameters**: [DataSourceParameters](#datasourceparameters)[]:

A set of alternate data source parameters that you want to share for these + credentials. The credentials are applied in tandem with the data source parameters when + you copy a data source by using a create or update request. The API operation compares + the DataSourceParameters structure that's in the request with the + structures in the AlternateDataSourceParameters allow list. If the + structures are an exact match, the request is allowed to use the new data source with + the existing credentials. If the AlternateDataSourceParameters list is + null, the DataSourceParameters originally used with these + Credentials is automatically allowed.

+* **Password**: string (Required):

Password.

+* **Username**: string (Required):

User name.

-## NumericEqualityDrillDownFilter +## CurrencyDisplayFormatConfiguration ### Properties -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **Value**: int (Required) +* **DecimalPlacesConfiguration**: [DecimalPlacesConfiguration](#decimalplacesconfiguration) +* **NegativeValueConfiguration**: [NegativeValueConfiguration](#negativevalueconfiguration) +* **NullValueFormatConfiguration**: [NullValueFormatConfiguration](#nullvalueformatconfiguration) +* **NumberScale**: string +* **Prefix**: string +* **SeparatorConfiguration**: [NumericSeparatorConfiguration](#numericseparatorconfiguration) +* **Suffix**: string +* **Symbol**: string -## TimeRangeDrillDownFilter +## CurrencyDisplayFormatConfiguration ### Properties -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **RangeMaximum**: string (Required) -* **RangeMinimum**: string (Required) -* **TimeGranularity**: string (Required) +* **DecimalPlacesConfiguration**: [DecimalPlacesConfiguration](#decimalplacesconfiguration) +* **NegativeValueConfiguration**: [NegativeValueConfiguration](#negativevalueconfiguration) +* **NullValueFormatConfiguration**: [NullValueFormatConfiguration](#nullvalueformatconfiguration) +* **NumberScale**: string +* **Prefix**: string +* **SeparatorConfiguration**: [NumericSeparatorConfiguration](#numericseparatorconfiguration) +* **Suffix**: string +* **Symbol**: string -## ExplicitHierarchy +## CurrencyDisplayFormatConfiguration ### Properties -* **Columns**: [ColumnIdentifier](#columnidentifier)[] (Required) -* **DrillDownFilters**: [DrillDownFilter](#drilldownfilter)[] -* **HierarchyId**: string (Required) +* **DecimalPlacesConfiguration**: [DecimalPlacesConfiguration](#decimalplacesconfiguration) +* **NegativeValueConfiguration**: [NegativeValueConfiguration](#negativevalueconfiguration) +* **NullValueFormatConfiguration**: [NullValueFormatConfiguration](#nullvalueformatconfiguration) +* **NumberScale**: string +* **Prefix**: string +* **SeparatorConfiguration**: [NumericSeparatorConfiguration](#numericseparatorconfiguration) +* **Suffix**: string +* **Symbol**: string -## PredefinedHierarchy +## CustomActionFilterOperation ### Properties -* **Columns**: [ColumnIdentifier](#columnidentifier)[] (Required) -* **DrillDownFilters**: [DrillDownFilter](#drilldownfilter)[] -* **HierarchyId**: string (Required) +* **SelectedFieldsConfiguration**: [FilterOperationSelectedFieldsConfiguration](#filteroperationselectedfieldsconfiguration) (Required) +* **TargetVisualsConfiguration**: [FilterOperationTargetVisualsConfiguration](#filteroperationtargetvisualsconfiguration) (Required) -## VisualSubtitleLabelOptions +## CustomActionFilterOperation ### Properties -* **FormatText**: [LongFormatText](#longformattext) -* **Visibility**: string +* **SelectedFieldsConfiguration**: [FilterOperationSelectedFieldsConfiguration](#filteroperationselectedfieldsconfiguration) (Required) +* **TargetVisualsConfiguration**: [FilterOperationTargetVisualsConfiguration](#filteroperationtargetvisualsconfiguration) (Required) -## LongFormatText +## CustomActionFilterOperation ### Properties -* **PlainText**: string -* **RichText**: string +* **SelectedFieldsConfiguration**: [FilterOperationSelectedFieldsConfiguration](#filteroperationselectedfieldsconfiguration) (Required) +* **TargetVisualsConfiguration**: [FilterOperationTargetVisualsConfiguration](#filteroperationtargetvisualsconfiguration) (Required) -## VisualTitleLabelOptions +## CustomActionNavigationOperation ### Properties -* **FormatText**: [ShortFormatText](#shortformattext) -* **Visibility**: string +* **LocalNavigationConfiguration**: [LocalNavigationConfiguration](#localnavigationconfiguration) -## ShortFormatText +## CustomActionNavigationOperation ### Properties -* **PlainText**: string -* **RichText**: string +* **LocalNavigationConfiguration**: [LocalNavigationConfiguration](#localnavigationconfiguration) -## BoxPlotVisual +## CustomActionNavigationOperation ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [BoxPlotChartConfiguration](#boxplotchartconfiguration) -* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] -* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) -* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) -* **VisualId**: string (Required) +* **LocalNavigationConfiguration**: [LocalNavigationConfiguration](#localnavigationconfiguration) -## BoxPlotChartConfiguration +## CustomActionSetParametersOperation ### Properties -* **BoxPlotOptions**: [BoxPlotOptions](#boxplotoptions) -* **CategoryAxis**: [AxisDisplayOptions](#axisdisplayoptions) -* **CategoryLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **FieldWells**: [BoxPlotFieldWells](#boxplotfieldwells) -* **Legend**: [LegendOptions](#legendoptions) -* **PrimaryYAxisDisplayOptions**: [AxisDisplayOptions](#axisdisplayoptions) -* **PrimaryYAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **ReferenceLines**: [ReferenceLine](#referenceline)[] -* **SortConfiguration**: [BoxPlotSortConfiguration](#boxplotsortconfiguration) -* **Tooltip**: [TooltipOptions](#tooltipoptions) -* **VisualPalette**: [VisualPalette](#visualpalette) +* **ParameterValueConfigurations**: [SetParameterValueConfiguration](#setparametervalueconfiguration)[] (Required) -## BoxPlotOptions +## CustomActionSetParametersOperation ### Properties -* **AllDataPointsVisibility**: string -* **OutlierVisibility**: string -* **StyleOptions**: [BoxPlotStyleOptions](#boxplotstyleoptions) +* **ParameterValueConfigurations**: [SetParameterValueConfiguration](#setparametervalueconfiguration)[] (Required) -## BoxPlotStyleOptions +## CustomActionSetParametersOperation ### Properties -* **FillStyle**: string +* **ParameterValueConfigurations**: [SetParameterValueConfiguration](#setparametervalueconfiguration)[] (Required) -## BoxPlotFieldWells +## CustomActionURLOperation ### Properties -* **BoxPlotAggregatedFieldWells**: [BoxPlotAggregatedFieldWells](#boxplotaggregatedfieldwells) +* **URLTarget**: string (Required) +* **URLTemplate**: string (Required) -## BoxPlotAggregatedFieldWells +## CustomActionURLOperation ### Properties -* **GroupBy**: [DimensionField](#dimensionfield)[] -* **Values**: [MeasureField](#measurefield)[] +* **URLTarget**: string (Required) +* **URLTemplate**: string (Required) -## BoxPlotSortConfiguration +## CustomActionURLOperation ### Properties -* **CategorySort**: [FieldSortOptions](#fieldsortoptions)[] -* **PaginationConfiguration**: [PaginationConfiguration](#paginationconfiguration) +* **URLTarget**: string (Required) +* **URLTemplate**: string (Required) -## PaginationConfiguration +## CustomColor ### Properties -* **PageNumber**: int (Required) -* **PageSize**: int (Required) +* **Color**: string (Required) +* **FieldValue**: string +* **SpecialValue**: string -## ComboChartVisual +## CustomColor ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [ComboChartConfiguration](#combochartconfiguration) -* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] -* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) -* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) -* **VisualId**: string (Required) +* **Color**: string (Required) +* **FieldValue**: string +* **SpecialValue**: string -## ComboChartConfiguration +## CustomColor ### Properties -* **BarDataLabels**: [DataLabelOptions](#datalabeloptions) -* **BarsArrangement**: string -* **CategoryAxis**: [AxisDisplayOptions](#axisdisplayoptions) -* **CategoryLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **ColorLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **FieldWells**: [ComboChartFieldWells](#combochartfieldwells) -* **Legend**: [LegendOptions](#legendoptions) -* **LineDataLabels**: [DataLabelOptions](#datalabeloptions) -* **PrimaryYAxisDisplayOptions**: [AxisDisplayOptions](#axisdisplayoptions) -* **PrimaryYAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **ReferenceLines**: [ReferenceLine](#referenceline)[] -* **SecondaryYAxisDisplayOptions**: [AxisDisplayOptions](#axisdisplayoptions) -* **SecondaryYAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **SortConfiguration**: [ComboChartSortConfiguration](#combochartsortconfiguration) -* **Tooltip**: [TooltipOptions](#tooltipoptions) -* **VisualPalette**: [VisualPalette](#visualpalette) +* **Color**: string (Required) +* **FieldValue**: string +* **SpecialValue**: string -## ComboChartFieldWells +## CustomContentConfiguration ### Properties -* **ComboChartAggregatedFieldWells**: [ComboChartAggregatedFieldWells](#combochartaggregatedfieldwells) +* **ContentType**: string +* **ContentUrl**: string +* **ImageScaling**: string -## ComboChartAggregatedFieldWells +## CustomContentConfiguration ### Properties -* **BarValues**: [MeasureField](#measurefield)[] -* **Category**: [DimensionField](#dimensionfield)[] -* **Colors**: [DimensionField](#dimensionfield)[] -* **LineValues**: [MeasureField](#measurefield)[] +* **ContentType**: string +* **ContentUrl**: string +* **ImageScaling**: string -## ComboChartSortConfiguration +## CustomContentConfiguration ### Properties -* **CategoryItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) -* **CategorySort**: [FieldSortOptions](#fieldsortoptions)[] -* **ColorItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) -* **ColorSort**: [FieldSortOptions](#fieldsortoptions)[] +* **ContentType**: string +* **ContentUrl**: string +* **ImageScaling**: string ## CustomContentVisual ### Properties @@ -1605,7738 +1819,7895 @@ * **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) * **VisualId**: string (Required) -## CustomContentConfiguration -### Properties -* **ContentType**: string -* **ContentUrl**: string -* **ImageScaling**: string - -## EmptyVisual +## CustomContentVisual ### Properties * **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **ChartConfiguration**: [CustomContentConfiguration](#customcontentconfiguration) * **DataSetIdentifier**: string (Required) +* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) +* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) * **VisualId**: string (Required) -## FilledMapVisual +## CustomContentVisual ### Properties * **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [FilledMapConfiguration](#filledmapconfiguration) -* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] -* **ConditionalFormatting**: [FilledMapConditionalFormatting](#filledmapconditionalformatting) +* **ChartConfiguration**: [CustomContentConfiguration](#customcontentconfiguration) +* **DataSetIdentifier**: string (Required) * **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) * **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) * **VisualId**: string (Required) -## FilledMapConfiguration -### Properties -* **FieldWells**: [FilledMapFieldWells](#filledmapfieldwells) -* **Legend**: [LegendOptions](#legendoptions) -* **MapStyleOptions**: [GeospatialMapStyleOptions](#geospatialmapstyleoptions) -* **SortConfiguration**: [FilledMapSortConfiguration](#filledmapsortconfiguration) -* **Tooltip**: [TooltipOptions](#tooltipoptions) -* **WindowOptions**: [GeospatialWindowOptions](#geospatialwindowoptions) - -## FilledMapFieldWells -### Properties -* **FilledMapAggregatedFieldWells**: [FilledMapAggregatedFieldWells](#filledmapaggregatedfieldwells) - -## FilledMapAggregatedFieldWells -### Properties -* **Geospatial**: [DimensionField](#dimensionfield)[] -* **Values**: [MeasureField](#measurefield)[] - -## GeospatialMapStyleOptions -### Properties -* **BaseMapStyle**: string - -## FilledMapSortConfiguration -### Properties -* **CategorySort**: [FieldSortOptions](#fieldsortoptions)[] - -## GeospatialWindowOptions -### Properties -* **Bounds**: [GeospatialCoordinateBounds](#geospatialcoordinatebounds) -* **MapZoomMode**: string - -## GeospatialCoordinateBounds -### Properties -* **East**: int (Required) -* **North**: int (Required) -* **South**: int (Required) -* **West**: int (Required) - -## FilledMapConditionalFormatting -### Properties -* **ConditionalFormattingOptions**: [FilledMapConditionalFormattingOption](#filledmapconditionalformattingoption)[] (Required) - -## FilledMapConditionalFormattingOption +## CustomFilterConfiguration ### Properties -* **Shape**: [FilledMapShapeConditionalFormatting](#filledmapshapeconditionalformatting) (Required) +* **CategoryValue**: string +* **MatchOperator**: string (Required) +* **NullOption**: string (Required) +* **ParameterName**: string +* **SelectAllOptions**: string -## FilledMapShapeConditionalFormatting +## CustomFilterConfiguration ### Properties -* **FieldId**: string (Required) -* **Format**: [ShapeConditionalFormat](#shapeconditionalformat) +* **CategoryValue**: string +* **MatchOperator**: string (Required) +* **NullOption**: string (Required) +* **ParameterName**: string +* **SelectAllOptions**: string -## ShapeConditionalFormat +## CustomFilterConfiguration ### Properties -* **BackgroundColor**: [ConditionalFormattingColor](#conditionalformattingcolor) (Required) +* **CategoryValue**: string +* **MatchOperator**: string (Required) +* **NullOption**: string (Required) +* **ParameterName**: string +* **SelectAllOptions**: string -## ConditionalFormattingColor +## CustomFilterListConfiguration ### Properties -* **Gradient**: [ConditionalFormattingGradientColor](#conditionalformattinggradientcolor) -* **Solid**: [ConditionalFormattingSolidColor](#conditionalformattingsolidcolor) +* **CategoryValues**: string[] +* **MatchOperator**: string (Required) +* **NullOption**: string (Required) +* **SelectAllOptions**: string -## ConditionalFormattingGradientColor +## CustomFilterListConfiguration ### Properties -* **Color**: [GradientColor](#gradientcolor) (Required) -* **Expression**: string (Required) +* **CategoryValues**: string[] +* **MatchOperator**: string (Required) +* **NullOption**: string (Required) +* **SelectAllOptions**: string -## GradientColor +## CustomFilterListConfiguration ### Properties -* **Stops**: [GradientStop](#gradientstop)[] +* **CategoryValues**: string[] +* **MatchOperator**: string (Required) +* **NullOption**: string (Required) +* **SelectAllOptions**: string -## GradientStop +## CustomNarrativeOptions ### Properties -* **Color**: string -* **DataValue**: int -* **GradientOffset**: int (Required) +* **Narrative**: string (Required) -## ConditionalFormattingSolidColor +## CustomNarrativeOptions ### Properties -* **Color**: string -* **Expression**: string (Required) +* **Narrative**: string (Required) -## FunnelChartVisual +## CustomNarrativeOptions ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [FunnelChartConfiguration](#funnelchartconfiguration) -* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] -* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) -* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) -* **VisualId**: string (Required) +* **Narrative**: string (Required) -## FunnelChartConfiguration +## CustomParameterValues ### Properties -* **CategoryLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **DataLabelOptions**: [FunnelChartDataLabelOptions](#funnelchartdatalabeloptions) -* **FieldWells**: [FunnelChartFieldWells](#funnelchartfieldwells) -* **SortConfiguration**: [FunnelChartSortConfiguration](#funnelchartsortconfiguration) -* **Tooltip**: [TooltipOptions](#tooltipoptions) -* **ValueLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **VisualPalette**: [VisualPalette](#visualpalette) +* **DateTimeValues**: string[] +* **DecimalValues**: int[] +* **IntegerValues**: int[] +* **StringValues**: string[] -## FunnelChartDataLabelOptions +## CustomParameterValues ### Properties -* **CategoryLabelVisibility**: string -* **LabelColor**: string -* **LabelFontConfiguration**: [FontConfiguration](#fontconfiguration) -* **MeasureDataLabelStyle**: string -* **MeasureLabelVisibility**: string -* **Position**: string -* **Visibility**: string +* **DateTimeValues**: string[] +* **DecimalValues**: int[] +* **IntegerValues**: int[] +* **StringValues**: string[] -## FunnelChartFieldWells +## CustomParameterValues ### Properties -* **FunnelChartAggregatedFieldWells**: [FunnelChartAggregatedFieldWells](#funnelchartaggregatedfieldwells) +* **DateTimeValues**: string[] +* **DecimalValues**: int[] +* **IntegerValues**: int[] +* **StringValues**: string[] -## FunnelChartAggregatedFieldWells +## CustomValuesConfiguration ### Properties -* **Category**: [DimensionField](#dimensionfield)[] -* **Values**: [MeasureField](#measurefield)[] +* **CustomValues**: [CustomParameterValues](#customparametervalues) (Required) +* **IncludeNullValue**: bool -## FunnelChartSortConfiguration +## CustomValuesConfiguration ### Properties -* **CategoryItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) -* **CategorySort**: [FieldSortOptions](#fieldsortoptions)[] +* **CustomValues**: [CustomParameterValues](#customparametervalues) (Required) +* **IncludeNullValue**: bool -## GaugeChartVisual +## CustomValuesConfiguration ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [GaugeChartConfiguration](#gaugechartconfiguration) -* **ConditionalFormatting**: [GaugeChartConditionalFormatting](#gaugechartconditionalformatting) -* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) -* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) -* **VisualId**: string (Required) +* **CustomValues**: [CustomParameterValues](#customparametervalues) (Required) +* **IncludeNullValue**: bool -## GaugeChartConfiguration +## DashboardError ### Properties -* **DataLabels**: [DataLabelOptions](#datalabeloptions) -* **FieldWells**: [GaugeChartFieldWells](#gaugechartfieldwells) -* **GaugeChartOptions**: [GaugeChartOptions](#gaugechartoptions) -* **TooltipOptions**: [TooltipOptions](#tooltipoptions) -* **VisualPalette**: [VisualPalette](#visualpalette) +* **Message**: string:

Message.

+* **Type**: string +* **ViolatedEntities**: [Entity](#entity)[]:

Lists the violated entities that caused the dashboard error.

-## GaugeChartFieldWells +## DashboardPublishOptions ### Properties -* **TargetValues**: [MeasureField](#measurefield)[] -* **Values**: [MeasureField](#measurefield)[] +* **AdHocFilteringOption**: [AdHocFilteringOption](#adhocfilteringoption) +* **DataPointDrillUpDownOption**: [DataPointDrillUpDownOption](#datapointdrillupdownoption) +* **DataPointMenuLabelOption**: [DataPointMenuLabelOption](#datapointmenulabeloption) +* **DataPointTooltipOption**: [DataPointTooltipOption](#datapointtooltipoption) +* **ExportToCSVOption**: [ExportToCSVOption](#exporttocsvoption) +* **ExportWithHiddenFieldsOption**: [ExportWithHiddenFieldsOption](#exportwithhiddenfieldsoption) +* **SheetControlsOption**: [SheetControlsOption](#sheetcontrolsoption) +* **SheetLayoutElementMaximizationOption**: [SheetLayoutElementMaximizationOption](#sheetlayoutelementmaximizationoption) +* **VisualAxisSortOption**: [VisualAxisSortOption](#visualaxissortoption) +* **VisualMenuOption**: [VisualMenuOption](#visualmenuoption) +* **VisualPublishOptions**: [DashboardVisualPublishOptions](#dashboardvisualpublishoptions) -## GaugeChartOptions +## DashboardSourceEntity ### Properties -* **Arc**: [ArcConfiguration](#arcconfiguration) -* **ArcAxis**: [ArcAxisConfiguration](#arcaxisconfiguration) -* **Comparison**: [ComparisonConfiguration](#comparisonconfiguration) -* **PrimaryValueDisplayType**: string -* **PrimaryValueFontConfiguration**: [FontConfiguration](#fontconfiguration) +* **SourceTemplate**: [DashboardSourceTemplate](#dashboardsourcetemplate) -## ArcConfiguration +## DashboardSourceTemplate ### Properties -* **ArcAngle**: int -* **ArcThickness**: string +* **Arn**: string (Required):

The Amazon Resource Name (ARN) of the resource.

+* **DataSetReferences**: [DataSetReference](#datasetreference)[] (Required):

Dataset references.

-## ArcAxisConfiguration +## DashboardVersion ### Properties -* **Range**: [ArcAxisDisplayRange](#arcaxisdisplayrange) -* **ReserveRange**: int +* **Arn**: string:

The Amazon Resource Name (ARN) of the resource.

+* **CreatedTime**: string:

The time that this dashboard version was created.

+* **DataSetArns**: string[]:

The Amazon Resource Numbers (ARNs) for the datasets that are associated with this + version of the dashboard.

+* **Description**: string:

Description.

+* **Errors**: [DashboardError](#dashboarderror)[]:

Errors associated with this dashboard version.

+* **Sheets**: [Sheet](#sheet)[]:

A list of the associated sheets with the unique identifier and name of each sheet.

+* **SourceEntityArn**: string:

Source entity ARN.

+* **Status**: string +* **ThemeArn**: string:

The ARN of the theme associated with a version of the dashboard.

+* **VersionNumber**: int:

Version number for this version of the dashboard.

-## ArcAxisDisplayRange +## DashboardVersionDefinition ### Properties -* **Max**: int -* **Min**: int +* **AnalysisDefaults**: [AnalysisDefaults](#analysisdefaults) +* **CalculatedFields**: [CalculatedField](#calculatedfield)[] +* **ColumnConfigurations**: [ColumnConfiguration](#columnconfiguration)[] +* **DataSetIdentifierDeclarations**: [DataSetIdentifierDeclaration](#datasetidentifierdeclaration)[] (Required) +* **FilterGroups**: [FilterGroup](#filtergroup)[] +* **Options**: [AssetOptions](#assetoptions) +* **ParameterDeclarations**: [ParameterDeclaration](#parameterdeclaration)[] +* **Sheets**: [SheetDefinition](#sheetdefinition)[] -## ComparisonConfiguration +## DashboardVisualPublishOptions ### Properties -* **ComparisonFormat**: [ComparisonFormatConfiguration](#comparisonformatconfiguration) -* **ComparisonMethod**: string +* **ExportHiddenFieldsOption**: [ExportHiddenFieldsOption](#exporthiddenfieldsoption) -## ComparisonFormatConfiguration +## DataAggregation ### Properties -* **NumberDisplayFormatConfiguration**: [NumberDisplayFormatConfiguration](#numberdisplayformatconfiguration) -* **PercentageDisplayFormatConfiguration**: [PercentageDisplayFormatConfiguration](#percentagedisplayformatconfiguration) +* **DatasetRowDateGranularity**: string +* **DefaultDateColumnName**: string -## GaugeChartConditionalFormatting +## DataBarsOptions ### Properties -* **ConditionalFormattingOptions**: [GaugeChartConditionalFormattingOption](#gaugechartconditionalformattingoption)[] +* **FieldId**: string (Required) +* **NegativeColor**: string +* **PositiveColor**: string -## GaugeChartConditionalFormattingOption +## DataBarsOptions ### Properties -* **Arc**: [GaugeChartArcConditionalFormatting](#gaugechartarcconditionalformatting) -* **PrimaryValue**: [GaugeChartPrimaryValueConditionalFormatting](#gaugechartprimaryvalueconditionalformatting) +* **FieldId**: string (Required) +* **NegativeColor**: string +* **PositiveColor**: string -## GaugeChartArcConditionalFormatting +## DataBarsOptions ### Properties -* **ForegroundColor**: [ConditionalFormattingColor](#conditionalformattingcolor) +* **FieldId**: string (Required) +* **NegativeColor**: string +* **PositiveColor**: string -## GaugeChartPrimaryValueConditionalFormatting +## DatabricksParameters ### Properties -* **Icon**: [ConditionalFormattingIcon](#conditionalformattingicon) -* **TextColor**: [ConditionalFormattingColor](#conditionalformattingcolor) +* **Host**: string (Required):

The host name of the Databricks data source.

+* **Port**: int (Required):

The port for the Databricks data source.

+* **SqlEndpointPath**: string (Required):

The HTTP path of the Databricks data source.

-## ConditionalFormattingIcon +## DataColor ### Properties -* **CustomCondition**: [ConditionalFormattingCustomIconCondition](#conditionalformattingcustomiconcondition) -* **IconSet**: [ConditionalFormattingIconSet](#conditionalformattingiconset) +* **Color**: string +* **DataValue**: int -## ConditionalFormattingCustomIconCondition +## DataColor ### Properties * **Color**: string -* **DisplayConfiguration**: [ConditionalFormattingIconDisplayConfiguration](#conditionalformattingicondisplayconfiguration) -* **Expression**: string (Required) -* **IconOptions**: [ConditionalFormattingCustomIconOptions](#conditionalformattingcustomiconoptions) (Required) +* **DataValue**: int -## ConditionalFormattingIconDisplayConfiguration +## DataColor ### Properties -* **IconDisplayOption**: string +* **Color**: string +* **DataValue**: int -## ConditionalFormattingCustomIconOptions +## DataColorPalette ### Properties -* **Icon**: string -* **UnicodeIcon**: string +* **Colors**: string[]:

The hexadecimal codes for the colors.

+* **EmptyFillColor**: string:

The hexadecimal code of a color that applies to charts where a lack of data is + highlighted.

+* **MinMaxGradient**: string[]:

The minimum and maximum hexadecimal codes that describe a color gradient.

-## ConditionalFormattingIconSet +## DataFieldSeriesItem ### Properties -* **Expression**: string (Required) -* **IconSetType**: string +* **AxisBinding**: string (Required) +* **FieldId**: string (Required) +* **FieldValue**: string +* **Settings**: [LineChartSeriesSettings](#linechartseriessettings) -## GeospatialMapVisual +## DataFieldSeriesItem ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [GeospatialMapConfiguration](#geospatialmapconfiguration) -* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] -* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) -* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) -* **VisualId**: string (Required) +* **AxisBinding**: string (Required) +* **FieldId**: string (Required) +* **FieldValue**: string +* **Settings**: [LineChartSeriesSettings](#linechartseriessettings) -## GeospatialMapConfiguration +## DataFieldSeriesItem ### Properties -* **FieldWells**: [GeospatialMapFieldWells](#geospatialmapfieldwells) -* **Legend**: [LegendOptions](#legendoptions) -* **MapStyleOptions**: [GeospatialMapStyleOptions](#geospatialmapstyleoptions) -* **PointStyleOptions**: [GeospatialPointStyleOptions](#geospatialpointstyleoptions) -* **Tooltip**: [TooltipOptions](#tooltipoptions) -* **VisualPalette**: [VisualPalette](#visualpalette) -* **WindowOptions**: [GeospatialWindowOptions](#geospatialwindowoptions) +* **AxisBinding**: string (Required) +* **FieldId**: string (Required) +* **FieldValue**: string +* **Settings**: [LineChartSeriesSettings](#linechartseriessettings) -## GeospatialMapFieldWells +## DataLabelOptions ### Properties -* **GeospatialMapAggregatedFieldWells**: [GeospatialMapAggregatedFieldWells](#geospatialmapaggregatedfieldwells) +* **CategoryLabelVisibility**: string +* **DataLabelTypes**: [DataLabelType](#datalabeltype)[] +* **LabelColor**: string +* **LabelContent**: string +* **LabelFontConfiguration**: [FontConfiguration](#fontconfiguration) +* **MeasureLabelVisibility**: string +* **Overlap**: string +* **Position**: string +* **TotalsVisibility**: string +* **Visibility**: string -## GeospatialMapAggregatedFieldWells +## DataLabelOptions ### Properties -* **Colors**: [DimensionField](#dimensionfield)[] -* **Geospatial**: [DimensionField](#dimensionfield)[] -* **Values**: [MeasureField](#measurefield)[] +* **CategoryLabelVisibility**: string +* **DataLabelTypes**: [DataLabelType](#datalabeltype)[] +* **LabelColor**: string +* **LabelContent**: string +* **LabelFontConfiguration**: [FontConfiguration](#fontconfiguration) +* **MeasureLabelVisibility**: string +* **Overlap**: string +* **Position**: string +* **TotalsVisibility**: string +* **Visibility**: string -## GeospatialPointStyleOptions +## DataLabelOptions ### Properties -* **ClusterMarkerConfiguration**: [ClusterMarkerConfiguration](#clustermarkerconfiguration) -* **HeatmapConfiguration**: [GeospatialHeatmapConfiguration](#geospatialheatmapconfiguration) -* **SelectedPointStyle**: string +* **CategoryLabelVisibility**: string +* **DataLabelTypes**: [DataLabelType](#datalabeltype)[] +* **LabelColor**: string +* **LabelContent**: string +* **LabelFontConfiguration**: [FontConfiguration](#fontconfiguration) +* **MeasureLabelVisibility**: string +* **Overlap**: string +* **Position**: string +* **TotalsVisibility**: string +* **Visibility**: string -## ClusterMarkerConfiguration +## DataLabelType ### Properties -* **ClusterMarker**: [ClusterMarker](#clustermarker) +* **DataPathLabelType**: [DataPathLabelType](#datapathlabeltype) +* **FieldLabelType**: [FieldLabelType](#fieldlabeltype) +* **MaximumLabelType**: [MaximumLabelType](#maximumlabeltype) +* **MinimumLabelType**: [MinimumLabelType](#minimumlabeltype) +* **RangeEndsLabelType**: [RangeEndsLabelType](#rangeendslabeltype) -## ClusterMarker +## DataLabelType ### Properties -* **SimpleClusterMarker**: [SimpleClusterMarker](#simpleclustermarker) +* **DataPathLabelType**: [DataPathLabelType](#datapathlabeltype) +* **FieldLabelType**: [FieldLabelType](#fieldlabeltype) +* **MaximumLabelType**: [MaximumLabelType](#maximumlabeltype) +* **MinimumLabelType**: [MinimumLabelType](#minimumlabeltype) +* **RangeEndsLabelType**: [RangeEndsLabelType](#rangeendslabeltype) -## SimpleClusterMarker +## DataLabelType ### Properties -* **Color**: string +* **DataPathLabelType**: [DataPathLabelType](#datapathlabeltype) +* **FieldLabelType**: [FieldLabelType](#fieldlabeltype) +* **MaximumLabelType**: [MaximumLabelType](#maximumlabeltype) +* **MinimumLabelType**: [MinimumLabelType](#minimumlabeltype) +* **RangeEndsLabelType**: [RangeEndsLabelType](#rangeendslabeltype) -## GeospatialHeatmapConfiguration +## DataPathColor ### Properties -* **HeatmapColor**: [GeospatialHeatmapColorScale](#geospatialheatmapcolorscale) +* **Color**: string (Required) +* **Element**: [DataPathValue](#datapathvalue) (Required) +* **TimeGranularity**: string -## GeospatialHeatmapColorScale +## DataPathColor ### Properties -* **Colors**: [GeospatialHeatmapDataColor](#geospatialheatmapdatacolor)[] +* **Color**: string (Required) +* **Element**: [DataPathValue](#datapathvalue) (Required) +* **TimeGranularity**: string -## GeospatialHeatmapDataColor +## DataPathColor ### Properties * **Color**: string (Required) +* **Element**: [DataPathValue](#datapathvalue) (Required) +* **TimeGranularity**: string -## HeatMapVisual +## DataPathLabelType ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [HeatMapConfiguration](#heatmapconfiguration) -* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] -* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) -* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) -* **VisualId**: string (Required) +* **FieldId**: string +* **FieldValue**: string +* **Visibility**: string -## HeatMapConfiguration +## DataPathLabelType ### Properties -* **ColorScale**: [ColorScale](#colorscale) -* **ColumnLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **DataLabels**: [DataLabelOptions](#datalabeloptions) -* **FieldWells**: [HeatMapFieldWells](#heatmapfieldwells) -* **Legend**: [LegendOptions](#legendoptions) -* **RowLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **SortConfiguration**: [HeatMapSortConfiguration](#heatmapsortconfiguration) -* **Tooltip**: [TooltipOptions](#tooltipoptions) +* **FieldId**: string +* **FieldValue**: string +* **Visibility**: string -## ColorScale +## DataPathLabelType ### Properties -* **ColorFillType**: string (Required) -* **Colors**: [DataColor](#datacolor)[] (Required) -* **NullValueColor**: [DataColor](#datacolor) +* **FieldId**: string +* **FieldValue**: string +* **Visibility**: string -## DataColor +## DataPathSort ### Properties -* **Color**: string -* **DataValue**: int +* **Direction**: string (Required) +* **SortPaths**: [DataPathValue](#datapathvalue)[] (Required) -## HeatMapFieldWells +## DataPathSort ### Properties -* **HeatMapAggregatedFieldWells**: [HeatMapAggregatedFieldWells](#heatmapaggregatedfieldwells) +* **Direction**: string (Required) +* **SortPaths**: [DataPathValue](#datapathvalue)[] (Required) -## HeatMapAggregatedFieldWells +## DataPathSort ### Properties -* **Columns**: [DimensionField](#dimensionfield)[] -* **Rows**: [DimensionField](#dimensionfield)[] -* **Values**: [MeasureField](#measurefield)[] +* **Direction**: string (Required) +* **SortPaths**: [DataPathValue](#datapathvalue)[] (Required) -## HeatMapSortConfiguration +## DataPathType ### Properties -* **HeatMapColumnItemsLimitConfiguration**: [ItemsLimitConfiguration](#itemslimitconfiguration) -* **HeatMapColumnSort**: [FieldSortOptions](#fieldsortoptions)[] -* **HeatMapRowItemsLimitConfiguration**: [ItemsLimitConfiguration](#itemslimitconfiguration) -* **HeatMapRowSort**: [FieldSortOptions](#fieldsortoptions)[] +* **PivotTableDataPathType**: string -## HistogramVisual +## DataPathType ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [HistogramConfiguration](#histogramconfiguration) -* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) -* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) -* **VisualId**: string (Required) +* **PivotTableDataPathType**: string -## HistogramConfiguration +## DataPathType ### Properties -* **BinOptions**: [HistogramBinOptions](#histogrambinoptions) -* **DataLabels**: [DataLabelOptions](#datalabeloptions) -* **FieldWells**: [HistogramFieldWells](#histogramfieldwells) -* **Tooltip**: [TooltipOptions](#tooltipoptions) -* **VisualPalette**: [VisualPalette](#visualpalette) -* **XAxisDisplayOptions**: [AxisDisplayOptions](#axisdisplayoptions) -* **XAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **YAxisDisplayOptions**: [AxisDisplayOptions](#axisdisplayoptions) +* **PivotTableDataPathType**: string + +## DataPathValue +### Properties +* **DataPathType**: [DataPathType](#datapathtype) +* **FieldId**: string +* **FieldValue**: string + +## DataPathValue +### Properties +* **DataPathType**: [DataPathType](#datapathtype) +* **FieldId**: string +* **FieldValue**: string + +## DataPathValue +### Properties +* **DataPathType**: [DataPathType](#datapathtype) +* **FieldId**: string +* **FieldValue**: string -## HistogramBinOptions +## DataPointDrillUpDownOption ### Properties -* **BinCount**: [BinCountOptions](#bincountoptions) -* **BinWidth**: [BinWidthOptions](#binwidthoptions) -* **SelectedBinType**: string -* **StartValue**: int +* **AvailabilityStatus**: string -## BinCountOptions +## DataPointMenuLabelOption ### Properties -* **Value**: int +* **AvailabilityStatus**: string -## BinWidthOptions +## DataPointTooltipOption ### Properties -* **BinCountLimit**: int -* **Value**: int +* **AvailabilityStatus**: string -## HistogramFieldWells +## DataSetConfiguration ### Properties -* **HistogramAggregatedFieldWells**: [HistogramAggregatedFieldWells](#histogramaggregatedfieldwells) +* **ColumnGroupSchemaList**: [ColumnGroupSchema](#columngroupschema)[]:

A structure containing the list of column group schemas.

+* **DataSetSchema**: [DataSetSchema](#datasetschema) +* **Placeholder**: string:

Placeholder.

-## HistogramAggregatedFieldWells +## DataSetIdentifierDeclaration ### Properties -* **Values**: [MeasureField](#measurefield)[] +* **DataSetArn**: string (Required) +* **Identifier**: string (Required) -## InsightVisual +## DataSetIdentifierDeclaration ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **DataSetIdentifier**: string (Required) -* **InsightConfiguration**: [InsightConfiguration](#insightconfiguration) -* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) -* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) -* **VisualId**: string (Required) +* **DataSetArn**: string (Required) +* **Identifier**: string (Required) -## InsightConfiguration +## DatasetMetadata ### Properties -* **Computations**: [Computation](#computation)[] -* **CustomNarrative**: [CustomNarrativeOptions](#customnarrativeoptions) +* **CalculatedFields**: [TopicCalculatedField](#topiccalculatedfield)[] +* **Columns**: [TopicColumn](#topiccolumn)[] +* **DataAggregation**: [DataAggregation](#dataaggregation) +* **DatasetArn**: string (Required) +* **DatasetDescription**: string +* **DatasetName**: string +* **Filters**: [TopicFilter](#topicfilter)[] +* **NamedEntities**: [TopicNamedEntity](#topicnamedentity)[] -## Computation +## DatasetParameter ### Properties -* **Forecast**: [ForecastComputation](#forecastcomputation) -* **GrowthRate**: [GrowthRateComputation](#growthratecomputation) -* **MaximumMinimum**: [MaximumMinimumComputation](#maximumminimumcomputation) -* **MetricComparison**: [MetricComparisonComputation](#metriccomparisoncomputation) -* **PeriodOverPeriod**: [PeriodOverPeriodComputation](#periodoverperiodcomputation) -* **PeriodToDate**: [PeriodToDateComputation](#periodtodatecomputation) -* **TopBottomMovers**: [TopBottomMoversComputation](#topbottommoverscomputation) -* **TopBottomRanked**: [TopBottomRankedComputation](#topbottomrankedcomputation) -* **TotalAggregation**: [TotalAggregationComputation](#totalaggregationcomputation) -* **UniqueValues**: [UniqueValuesComputation](#uniquevaluescomputation) +* **DateTimeDatasetParameter**: [DateTimeDatasetParameter](#datetimedatasetparameter) +* **DecimalDatasetParameter**: [DecimalDatasetParameter](#decimaldatasetparameter) +* **IntegerDatasetParameter**: [IntegerDatasetParameter](#integerdatasetparameter) +* **StringDatasetParameter**: [StringDatasetParameter](#stringdatasetparameter) -## ForecastComputation +## DataSetReference ### Properties -* **ComputationId**: string (Required) -* **CustomSeasonalityValue**: int -* **LowerBoundary**: int -* **Name**: string -* **PeriodsBackward**: int -* **PeriodsForward**: int -* **PredictionInterval**: int -* **Seasonality**: string -* **Time**: [DimensionField](#dimensionfield) -* **UpperBoundary**: int -* **Value**: [MeasureField](#measurefield) +* **DataSetArn**: string (Required):

Dataset Amazon Resource Name (ARN).

+* **DataSetPlaceholder**: string (Required):

Dataset placeholder.

-## GrowthRateComputation +## DataSetReference ### Properties -* **ComputationId**: string (Required) -* **Name**: string -* **PeriodSize**: int -* **Time**: [DimensionField](#dimensionfield) -* **Value**: [MeasureField](#measurefield) +* **DataSetArn**: string (Required):

Dataset Amazon Resource Name (ARN).

+* **DataSetPlaceholder**: string (Required):

Dataset placeholder.

-## MaximumMinimumComputation +## DataSetReference ### Properties -* **ComputationId**: string (Required) -* **Name**: string -* **Time**: [DimensionField](#dimensionfield) -* **Type**: string (Required) -* **Value**: [MeasureField](#measurefield) +* **DataSetArn**: string (Required):

Dataset Amazon Resource Name (ARN).

+* **DataSetPlaceholder**: string (Required):

Dataset placeholder.

-## MetricComparisonComputation +## DataSetRefreshProperties ### Properties -* **ComputationId**: string (Required) -* **FromValue**: [MeasureField](#measurefield) -* **Name**: string -* **TargetValue**: [MeasureField](#measurefield) -* **Time**: [DimensionField](#dimensionfield) +* **RefreshConfiguration**: [RefreshConfiguration](#refreshconfiguration) (Required) -## PeriodOverPeriodComputation +## DataSetSchema ### Properties -* **ComputationId**: string (Required) -* **Name**: string -* **Time**: [DimensionField](#dimensionfield) -* **Value**: [MeasureField](#measurefield) +* **ColumnSchemaList**: [ColumnSchema](#columnschema)[]:

A structure containing the list of column schemas.

-## PeriodToDateComputation +## DataSetUsageConfiguration ### Properties -* **ComputationId**: string (Required) -* **Name**: string -* **PeriodTimeGranularity**: string -* **Time**: [DimensionField](#dimensionfield) -* **Value**: [MeasureField](#measurefield) +* **DisableUseAsDirectQuerySource**: bool:

An option that controls whether a child dataset of a direct query can use this dataset as a source.

+* **DisableUseAsImportedSource**: bool:

An option that controls whether a child dataset that's stored in QuickSight can use this dataset as a source.

-## TopBottomMoversComputation +## DataSourceCredentials ### Properties -* **Category**: [DimensionField](#dimensionfield) -* **ComputationId**: string (Required) -* **MoverSize**: int -* **Name**: string -* **SortOrder**: string -* **Time**: [DimensionField](#dimensionfield) -* **Type**: string (Required) -* **Value**: [MeasureField](#measurefield) +* **CopySourceArn**: string:

The Amazon Resource Name (ARN) of a data source that has the credential pair that you + want to use. When CopySourceArn is not null, the credential pair from the + data source in the ARN is used as the credentials for the + DataSourceCredentials structure.

+* **CredentialPair**: [CredentialPair](#credentialpair) +* **SecretArn**: string:

The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.

-## TopBottomRankedComputation +## DataSourceErrorInfo ### Properties -* **Category**: [DimensionField](#dimensionfield) -* **ComputationId**: string (Required) -* **Name**: string -* **ResultSize**: int -* **Type**: string (Required) -* **Value**: [MeasureField](#measurefield) +* **Message**: string:

Error message.

+* **Type**: string -## TotalAggregationComputation +## DataSourceParameters ### Properties -* **ComputationId**: string (Required) -* **Name**: string -* **Value**: [MeasureField](#measurefield) +* **AmazonElasticsearchParameters**: [AmazonElasticsearchParameters](#amazonelasticsearchparameters) +* **AmazonOpenSearchParameters**: [AmazonOpenSearchParameters](#amazonopensearchparameters) +* **AthenaParameters**: [AthenaParameters](#athenaparameters) +* **AuroraParameters**: [AuroraParameters](#auroraparameters) +* **AuroraPostgreSqlParameters**: [AuroraPostgreSqlParameters](#aurorapostgresqlparameters) +* **DatabricksParameters**: [DatabricksParameters](#databricksparameters) +* **MariaDbParameters**: [MariaDbParameters](#mariadbparameters) +* **MySqlParameters**: [MySqlParameters](#mysqlparameters) +* **OracleParameters**: [OracleParameters](#oracleparameters) +* **PostgreSqlParameters**: [PostgreSqlParameters](#postgresqlparameters) +* **PrestoParameters**: [PrestoParameters](#prestoparameters) +* **RdsParameters**: [RdsParameters](#rdsparameters) +* **RedshiftParameters**: [RedshiftParameters](#redshiftparameters) +* **S3Parameters**: [S3Parameters](#s3parameters) +* **SnowflakeParameters**: [SnowflakeParameters](#snowflakeparameters) +* **SparkParameters**: [SparkParameters](#sparkparameters) +* **SqlServerParameters**: [SqlServerParameters](#sqlserverparameters) +* **StarburstParameters**: [StarburstParameters](#starburstparameters) +* **TeradataParameters**: [TeradataParameters](#teradataparameters) +* **TrinoParameters**: [TrinoParameters](#trinoparameters) -## UniqueValuesComputation +## DateAxisOptions ### Properties -* **Category**: [DimensionField](#dimensionfield) -* **ComputationId**: string (Required) -* **Name**: string +* **MissingDateVisibility**: string -## CustomNarrativeOptions +## DateAxisOptions ### Properties -* **Narrative**: string (Required) +* **MissingDateVisibility**: string -## KPIVisual +## DateAxisOptions ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [KPIConfiguration](#kpiconfiguration) -* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] -* **ConditionalFormatting**: [KPIConditionalFormatting](#kpiconditionalformatting) -* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) -* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) -* **VisualId**: string (Required) +* **MissingDateVisibility**: string -## KPIConfiguration +## DateDimensionField ### Properties -* **FieldWells**: [KPIFieldWells](#kpifieldwells) -* **KPIOptions**: [KPIOptions](#kpioptions) -* **SortConfiguration**: [KPISortConfiguration](#kpisortconfiguration) +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) +* **DateGranularity**: string +* **FieldId**: string (Required) +* **FormatConfiguration**: [DateTimeFormatConfiguration](#datetimeformatconfiguration) +* **HierarchyId**: string -## KPIFieldWells +## DateDimensionField ### Properties -* **TargetValues**: [MeasureField](#measurefield)[] -* **TrendGroups**: [DimensionField](#dimensionfield)[] -* **Values**: [MeasureField](#measurefield)[] +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) +* **DateGranularity**: string +* **FieldId**: string (Required) +* **FormatConfiguration**: [DateTimeFormatConfiguration](#datetimeformatconfiguration) +* **HierarchyId**: string -## KPIOptions +## DateDimensionField ### Properties -* **Comparison**: [ComparisonConfiguration](#comparisonconfiguration) -* **PrimaryValueDisplayType**: string -* **PrimaryValueFontConfiguration**: [FontConfiguration](#fontconfiguration) -* **ProgressBar**: [ProgressBarOptions](#progressbaroptions) -* **SecondaryValue**: [SecondaryValueOptions](#secondaryvalueoptions) -* **SecondaryValueFontConfiguration**: [FontConfiguration](#fontconfiguration) -* **Sparkline**: [KPISparklineOptions](#kpisparklineoptions) -* **TrendArrows**: [TrendArrowOptions](#trendarrowoptions) -* **VisualLayoutOptions**: [KPIVisualLayoutOptions](#kpivisuallayoutoptions) +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) +* **DateGranularity**: string +* **FieldId**: string (Required) +* **FormatConfiguration**: [DateTimeFormatConfiguration](#datetimeformatconfiguration) +* **HierarchyId**: string -## ProgressBarOptions +## DateMeasureField ### Properties -* **Visibility**: string +* **AggregationFunction**: string +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) +* **FieldId**: string (Required) +* **FormatConfiguration**: [DateTimeFormatConfiguration](#datetimeformatconfiguration) -## SecondaryValueOptions +## DateMeasureField ### Properties -* **Visibility**: string +* **AggregationFunction**: string +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) +* **FieldId**: string (Required) +* **FormatConfiguration**: [DateTimeFormatConfiguration](#datetimeformatconfiguration) -## KPISparklineOptions +## DateMeasureField ### Properties -* **Color**: string -* **TooltipVisibility**: string -* **Type**: string (Required) -* **Visibility**: string +* **AggregationFunction**: string +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) +* **FieldId**: string (Required) +* **FormatConfiguration**: [DateTimeFormatConfiguration](#datetimeformatconfiguration) -## TrendArrowOptions +## DateTimeDatasetParameter ### Properties -* **Visibility**: string +* **DefaultValues**: [DateTimeDatasetParameterDefaultValues](#datetimedatasetparameterdefaultvalues) +* **Id**: string (Required):

An identifier for the parameter that is created in the dataset.

+* **Name**: string (Required):

The name of the date time parameter that is created in the dataset.

+* **TimeGranularity**: string +* **ValueType**: string (Required) -## KPIVisualLayoutOptions +## DateTimeDatasetParameterDefaultValues ### Properties -* **StandardLayout**: [KPIVisualStandardLayout](#kpivisualstandardlayout) +* **StaticValues**: string[]:

A list of static default values for a given date time parameter.

-## KPIVisualStandardLayout +## DateTimeDefaultValues ### Properties -* **Type**: string (Required) +* **DynamicValue**: [DynamicDefaultValue](#dynamicdefaultvalue) +* **RollingDate**: [RollingDateConfiguration](#rollingdateconfiguration) +* **StaticValues**: string[] -## KPISortConfiguration +## DateTimeDefaultValues ### Properties -* **TrendGroupSort**: [FieldSortOptions](#fieldsortoptions)[] +* **DynamicValue**: [DynamicDefaultValue](#dynamicdefaultvalue) +* **RollingDate**: [RollingDateConfiguration](#rollingdateconfiguration) +* **StaticValues**: string[] -## KPIConditionalFormatting +## DateTimeDefaultValues ### Properties -* **ConditionalFormattingOptions**: [KPIConditionalFormattingOption](#kpiconditionalformattingoption)[] +* **DynamicValue**: [DynamicDefaultValue](#dynamicdefaultvalue) +* **RollingDate**: [RollingDateConfiguration](#rollingdateconfiguration) +* **StaticValues**: string[] -## KPIConditionalFormattingOption +## DateTimeFormatConfiguration ### Properties -* **ActualValue**: [KPIActualValueConditionalFormatting](#kpiactualvalueconditionalformatting) -* **ComparisonValue**: [KPIComparisonValueConditionalFormatting](#kpicomparisonvalueconditionalformatting) -* **PrimaryValue**: [KPIPrimaryValueConditionalFormatting](#kpiprimaryvalueconditionalformatting) -* **ProgressBar**: [KPIProgressBarConditionalFormatting](#kpiprogressbarconditionalformatting) +* **DateTimeFormat**: string +* **NullValueFormatConfiguration**: [NullValueFormatConfiguration](#nullvalueformatconfiguration) +* **NumericFormatConfiguration**: [NumericFormatConfiguration](#numericformatconfiguration) -## KPIActualValueConditionalFormatting +## DateTimeFormatConfiguration ### Properties -* **Icon**: [ConditionalFormattingIcon](#conditionalformattingicon) -* **TextColor**: [ConditionalFormattingColor](#conditionalformattingcolor) +* **DateTimeFormat**: string +* **NullValueFormatConfiguration**: [NullValueFormatConfiguration](#nullvalueformatconfiguration) +* **NumericFormatConfiguration**: [NumericFormatConfiguration](#numericformatconfiguration) -## KPIComparisonValueConditionalFormatting +## DateTimeFormatConfiguration ### Properties -* **Icon**: [ConditionalFormattingIcon](#conditionalformattingicon) -* **TextColor**: [ConditionalFormattingColor](#conditionalformattingcolor) +* **DateTimeFormat**: string +* **NullValueFormatConfiguration**: [NullValueFormatConfiguration](#nullvalueformatconfiguration) +* **NumericFormatConfiguration**: [NumericFormatConfiguration](#numericformatconfiguration) -## KPIPrimaryValueConditionalFormatting +## DateTimeHierarchy ### Properties -* **Icon**: [ConditionalFormattingIcon](#conditionalformattingicon) -* **TextColor**: [ConditionalFormattingColor](#conditionalformattingcolor) +* **DrillDownFilters**: [DrillDownFilter](#drilldownfilter)[] +* **HierarchyId**: string (Required) -## KPIProgressBarConditionalFormatting +## DateTimeHierarchy ### Properties -* **ForegroundColor**: [ConditionalFormattingColor](#conditionalformattingcolor) +* **DrillDownFilters**: [DrillDownFilter](#drilldownfilter)[] +* **HierarchyId**: string (Required) -## LineChartVisual +## DateTimeHierarchy ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [LineChartConfiguration](#linechartconfiguration) -* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] -* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) -* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) -* **VisualId**: string (Required) +* **DrillDownFilters**: [DrillDownFilter](#drilldownfilter)[] +* **HierarchyId**: string (Required) -## LineChartConfiguration +## DateTimeParameter ### Properties -* **ContributionAnalysisDefaults**: [ContributionAnalysisDefault](#contributionanalysisdefault)[] -* **DataLabels**: [DataLabelOptions](#datalabeloptions) -* **DefaultSeriesSettings**: [LineChartDefaultSeriesSettings](#linechartdefaultseriessettings) -* **FieldWells**: [LineChartFieldWells](#linechartfieldwells) -* **ForecastConfigurations**: [ForecastConfiguration](#forecastconfiguration)[] -* **Legend**: [LegendOptions](#legendoptions) -* **PrimaryYAxisDisplayOptions**: [LineSeriesAxisDisplayOptions](#lineseriesaxisdisplayoptions) -* **PrimaryYAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **ReferenceLines**: [ReferenceLine](#referenceline)[] -* **SecondaryYAxisDisplayOptions**: [LineSeriesAxisDisplayOptions](#lineseriesaxisdisplayoptions) -* **SecondaryYAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **Series**: [SeriesItem](#seriesitem)[] -* **SmallMultiplesOptions**: [SmallMultiplesOptions](#smallmultiplesoptions) -* **SortConfiguration**: [LineChartSortConfiguration](#linechartsortconfiguration) -* **Tooltip**: [TooltipOptions](#tooltipoptions) -* **Type**: string -* **VisualPalette**: [VisualPalette](#visualpalette) -* **XAxisDisplayOptions**: [AxisDisplayOptions](#axisdisplayoptions) -* **XAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **Name**: string (Required):

A display name for the date-time parameter.

+* **Values**: string[] (Required):

The values for the date-time parameter.

-## LineChartDefaultSeriesSettings +## DateTimeParameter ### Properties -* **AxisBinding**: string -* **LineStyleSettings**: [LineChartLineStyleSettings](#linechartlinestylesettings) -* **MarkerStyleSettings**: [LineChartMarkerStyleSettings](#linechartmarkerstylesettings) +* **Name**: string (Required):

A display name for the date-time parameter.

+* **Values**: string[] (Required):

The values for the date-time parameter.

-## LineChartLineStyleSettings +## DateTimeParameterDeclaration ### Properties -* **LineInterpolation**: string -* **LineStyle**: string -* **LineVisibility**: string -* **LineWidth**: string: String based length that is composed of value and unit in px +* **DefaultValues**: [DateTimeDefaultValues](#datetimedefaultvalues) +* **MappedDataSetParameters**: [MappedDataSetParameter](#mappeddatasetparameter)[] +* **Name**: string (Required) +* **TimeGranularity**: string +* **ValueWhenUnset**: [DateTimeValueWhenUnsetConfiguration](#datetimevaluewhenunsetconfiguration) -## LineChartMarkerStyleSettings +## DateTimeParameterDeclaration ### Properties -* **MarkerColor**: string -* **MarkerShape**: string -* **MarkerSize**: string: String based length that is composed of value and unit in px -* **MarkerVisibility**: string +* **DefaultValues**: [DateTimeDefaultValues](#datetimedefaultvalues) +* **MappedDataSetParameters**: [MappedDataSetParameter](#mappeddatasetparameter)[] +* **Name**: string (Required) +* **TimeGranularity**: string +* **ValueWhenUnset**: [DateTimeValueWhenUnsetConfiguration](#datetimevaluewhenunsetconfiguration) -## LineChartFieldWells +## DateTimeParameterDeclaration ### Properties -* **LineChartAggregatedFieldWells**: [LineChartAggregatedFieldWells](#linechartaggregatedfieldwells) +* **DefaultValues**: [DateTimeDefaultValues](#datetimedefaultvalues) +* **MappedDataSetParameters**: [MappedDataSetParameter](#mappeddatasetparameter)[] +* **Name**: string (Required) +* **TimeGranularity**: string +* **ValueWhenUnset**: [DateTimeValueWhenUnsetConfiguration](#datetimevaluewhenunsetconfiguration) -## LineChartAggregatedFieldWells +## DateTimePickerControlDisplayOptions ### Properties -* **Category**: [DimensionField](#dimensionfield)[] -* **Colors**: [DimensionField](#dimensionfield)[] -* **SmallMultiples**: [DimensionField](#dimensionfield)[] -* **Values**: [MeasureField](#measurefield)[] +* **DateTimeFormat**: string +* **InfoIconLabelOptions**: [SheetControlInfoIconLabelOptions](#sheetcontrolinfoiconlabeloptions) +* **TitleOptions**: [LabelOptions](#labeloptions) -## ForecastConfiguration +## DateTimePickerControlDisplayOptions ### Properties -* **ForecastProperties**: [TimeBasedForecastProperties](#timebasedforecastproperties) -* **Scenario**: [ForecastScenario](#forecastscenario) +* **DateTimeFormat**: string +* **InfoIconLabelOptions**: [SheetControlInfoIconLabelOptions](#sheetcontrolinfoiconlabeloptions) +* **TitleOptions**: [LabelOptions](#labeloptions) -## TimeBasedForecastProperties +## DateTimePickerControlDisplayOptions ### Properties -* **LowerBoundary**: int -* **PeriodsBackward**: int -* **PeriodsForward**: int -* **PredictionInterval**: int -* **Seasonality**: int -* **UpperBoundary**: int +* **DateTimeFormat**: string +* **InfoIconLabelOptions**: [SheetControlInfoIconLabelOptions](#sheetcontrolinfoiconlabeloptions) +* **TitleOptions**: [LabelOptions](#labeloptions) -## ForecastScenario +## DateTimeValueWhenUnsetConfiguration ### Properties -* **WhatIfPointScenario**: [WhatIfPointScenario](#whatifpointscenario) -* **WhatIfRangeScenario**: [WhatIfRangeScenario](#whatifrangescenario) +* **CustomValue**: string +* **ValueWhenUnsetOption**: string -## WhatIfPointScenario +## DateTimeValueWhenUnsetConfiguration ### Properties -* **Date**: string (Required) -* **Value**: int (Required) +* **CustomValue**: string +* **ValueWhenUnsetOption**: string -## WhatIfRangeScenario +## DateTimeValueWhenUnsetConfiguration ### Properties -* **EndDate**: string (Required) -* **StartDate**: string (Required) -* **Value**: int (Required) +* **CustomValue**: string +* **ValueWhenUnsetOption**: string -## LineSeriesAxisDisplayOptions +## DecimalDatasetParameter ### Properties -* **AxisOptions**: [AxisDisplayOptions](#axisdisplayoptions) -* **MissingDataConfigurations**: [MissingDataConfiguration](#missingdataconfiguration)[] +* **DefaultValues**: [DecimalDatasetParameterDefaultValues](#decimaldatasetparameterdefaultvalues) +* **Id**: string (Required):

An identifier for the decimal parameter created in the dataset.

+* **Name**: string (Required):

The name of the decimal parameter that is created in the dataset.

+* **ValueType**: string (Required) -## MissingDataConfiguration +## DecimalDatasetParameterDefaultValues ### Properties -* **TreatmentOption**: string +* **StaticValues**: int[]:

A list of static default values for a given decimal parameter.

-## SeriesItem +## DecimalDefaultValues ### Properties -* **DataFieldSeriesItem**: [DataFieldSeriesItem](#datafieldseriesitem) -* **FieldSeriesItem**: [FieldSeriesItem](#fieldseriesitem) +* **DynamicValue**: [DynamicDefaultValue](#dynamicdefaultvalue) +* **StaticValues**: int[] -## DataFieldSeriesItem +## DecimalDefaultValues ### Properties -* **AxisBinding**: string (Required) -* **FieldId**: string (Required) -* **FieldValue**: string -* **Settings**: [LineChartSeriesSettings](#linechartseriessettings) +* **DynamicValue**: [DynamicDefaultValue](#dynamicdefaultvalue) +* **StaticValues**: int[] -## LineChartSeriesSettings +## DecimalDefaultValues ### Properties -* **LineStyleSettings**: [LineChartLineStyleSettings](#linechartlinestylesettings) -* **MarkerStyleSettings**: [LineChartMarkerStyleSettings](#linechartmarkerstylesettings) +* **DynamicValue**: [DynamicDefaultValue](#dynamicdefaultvalue) +* **StaticValues**: int[] -## FieldSeriesItem +## DecimalParameter ### Properties -* **AxisBinding**: string (Required) -* **FieldId**: string (Required) -* **Settings**: [LineChartSeriesSettings](#linechartseriessettings) +* **Name**: string (Required):

A display name for the decimal parameter.

+* **Values**: int[] (Required):

The values for the decimal parameter.

-## LineChartSortConfiguration +## DecimalParameter ### Properties -* **CategoryItemsLimitConfiguration**: [ItemsLimitConfiguration](#itemslimitconfiguration) -* **CategorySort**: [FieldSortOptions](#fieldsortoptions)[] -* **ColorItemsLimitConfiguration**: [ItemsLimitConfiguration](#itemslimitconfiguration) -* **SmallMultiplesLimitConfiguration**: [ItemsLimitConfiguration](#itemslimitconfiguration) -* **SmallMultiplesSort**: [FieldSortOptions](#fieldsortoptions)[] +* **Name**: string (Required):

A display name for the decimal parameter.

+* **Values**: int[] (Required):

The values for the decimal parameter.

-## PieChartVisual +## DecimalParameterDeclaration ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [PieChartConfiguration](#piechartconfiguration) -* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] -* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) -* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) -* **VisualId**: string (Required) +* **DefaultValues**: [DecimalDefaultValues](#decimaldefaultvalues) +* **MappedDataSetParameters**: [MappedDataSetParameter](#mappeddatasetparameter)[] +* **Name**: string (Required) +* **ParameterValueType**: string (Required) +* **ValueWhenUnset**: [DecimalValueWhenUnsetConfiguration](#decimalvaluewhenunsetconfiguration) -## PieChartConfiguration +## DecimalParameterDeclaration ### Properties -* **CategoryLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **ContributionAnalysisDefaults**: [ContributionAnalysisDefault](#contributionanalysisdefault)[] -* **DataLabels**: [DataLabelOptions](#datalabeloptions) -* **DonutOptions**: [DonutOptions](#donutoptions) -* **FieldWells**: [PieChartFieldWells](#piechartfieldwells) -* **Legend**: [LegendOptions](#legendoptions) -* **SmallMultiplesOptions**: [SmallMultiplesOptions](#smallmultiplesoptions) -* **SortConfiguration**: [PieChartSortConfiguration](#piechartsortconfiguration) -* **Tooltip**: [TooltipOptions](#tooltipoptions) -* **ValueLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **VisualPalette**: [VisualPalette](#visualpalette) +* **DefaultValues**: [DecimalDefaultValues](#decimaldefaultvalues) +* **MappedDataSetParameters**: [MappedDataSetParameter](#mappeddatasetparameter)[] +* **Name**: string (Required) +* **ParameterValueType**: string (Required) +* **ValueWhenUnset**: [DecimalValueWhenUnsetConfiguration](#decimalvaluewhenunsetconfiguration) -## DonutOptions +## DecimalParameterDeclaration ### Properties -* **ArcOptions**: [ArcOptions](#arcoptions) -* **DonutCenterOptions**: [DonutCenterOptions](#donutcenteroptions) +* **DefaultValues**: [DecimalDefaultValues](#decimaldefaultvalues) +* **MappedDataSetParameters**: [MappedDataSetParameter](#mappeddatasetparameter)[] +* **Name**: string (Required) +* **ParameterValueType**: string (Required) +* **ValueWhenUnset**: [DecimalValueWhenUnsetConfiguration](#decimalvaluewhenunsetconfiguration) -## ArcOptions +## DecimalPlacesConfiguration ### Properties -* **ArcThickness**: string +* **DecimalPlaces**: int (Required) -## DonutCenterOptions +## DecimalPlacesConfiguration ### Properties -* **LabelVisibility**: string +* **DecimalPlaces**: int (Required) -## PieChartFieldWells +## DecimalPlacesConfiguration ### Properties -* **PieChartAggregatedFieldWells**: [PieChartAggregatedFieldWells](#piechartaggregatedfieldwells) +* **DecimalPlaces**: int (Required) -## PieChartAggregatedFieldWells +## DecimalValueWhenUnsetConfiguration ### Properties -* **Category**: [DimensionField](#dimensionfield)[] -* **SmallMultiples**: [DimensionField](#dimensionfield)[] -* **Values**: [MeasureField](#measurefield)[] +* **CustomValue**: int +* **ValueWhenUnsetOption**: string -## PieChartSortConfiguration +## DecimalValueWhenUnsetConfiguration ### Properties -* **CategoryItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) -* **CategorySort**: [FieldSortOptions](#fieldsortoptions)[] -* **SmallMultiplesLimitConfiguration**: [ItemsLimitConfiguration](#itemslimitconfiguration) -* **SmallMultiplesSort**: [FieldSortOptions](#fieldsortoptions)[] +* **CustomValue**: int +* **ValueWhenUnsetOption**: string -## PivotTableVisual +## DecimalValueWhenUnsetConfiguration ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [PivotTableConfiguration](#pivottableconfiguration) -* **ConditionalFormatting**: [PivotTableConditionalFormatting](#pivottableconditionalformatting) -* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) -* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) -* **VisualId**: string (Required) +* **CustomValue**: int +* **ValueWhenUnsetOption**: string -## PivotTableConfiguration +## DefaultDateTimePickerControlOptions ### Properties -* **FieldOptions**: [PivotTableFieldOptions](#pivottablefieldoptions) -* **FieldWells**: [PivotTableFieldWells](#pivottablefieldwells) -* **PaginatedReportOptions**: [PivotTablePaginatedReportOptions](#pivottablepaginatedreportoptions) -* **SortConfiguration**: [PivotTableSortConfiguration](#pivottablesortconfiguration) -* **TableOptions**: [PivotTableOptions](#pivottableoptions) -* **TotalOptions**: [PivotTableTotalOptions](#pivottabletotaloptions) +* **DisplayOptions**: [DateTimePickerControlDisplayOptions](#datetimepickercontroldisplayoptions) +* **Type**: string -## PivotTableFieldOptions +## DefaultDateTimePickerControlOptions ### Properties -* **CollapseStateOptions**: [PivotTableFieldCollapseStateOption](#pivottablefieldcollapsestateoption)[] -* **DataPathOptions**: [PivotTableDataPathOption](#pivottabledatapathoption)[] -* **SelectedFieldOptions**: [PivotTableFieldOption](#pivottablefieldoption)[] +* **DisplayOptions**: [DateTimePickerControlDisplayOptions](#datetimepickercontroldisplayoptions) +* **Type**: string -## PivotTableFieldCollapseStateOption +## DefaultDateTimePickerControlOptions ### Properties -* **State**: string -* **Target**: [PivotTableFieldCollapseStateTarget](#pivottablefieldcollapsestatetarget) (Required) +* **DisplayOptions**: [DateTimePickerControlDisplayOptions](#datetimepickercontroldisplayoptions) +* **Type**: string -## PivotTableFieldCollapseStateTarget +## DefaultFilterControlConfiguration ### Properties -* **FieldDataPathValues**: [DataPathValue](#datapathvalue)[] -* **FieldId**: string +* **ControlOptions**: [DefaultFilterControlOptions](#defaultfiltercontroloptions) (Required) +* **Title**: string (Required) -## PivotTableDataPathOption +## DefaultFilterControlConfiguration ### Properties -* **DataPathList**: [DataPathValue](#datapathvalue)[] (Required) -* **Width**: string: String based length that is composed of value and unit in px +* **ControlOptions**: [DefaultFilterControlOptions](#defaultfiltercontroloptions) (Required) +* **Title**: string (Required) -## PivotTableFieldOption +## DefaultFilterControlConfiguration ### Properties -* **CustomLabel**: string -* **FieldId**: string (Required) -* **Visibility**: string +* **ControlOptions**: [DefaultFilterControlOptions](#defaultfiltercontroloptions) (Required) +* **Title**: string (Required) -## PivotTableFieldWells +## DefaultFilterControlOptions ### Properties -* **PivotTableAggregatedFieldWells**: [PivotTableAggregatedFieldWells](#pivottableaggregatedfieldwells) +* **DefaultDateTimePickerOptions**: [DefaultDateTimePickerControlOptions](#defaultdatetimepickercontroloptions) +* **DefaultDropdownOptions**: [DefaultFilterDropDownControlOptions](#defaultfilterdropdowncontroloptions) +* **DefaultListOptions**: [DefaultFilterListControlOptions](#defaultfilterlistcontroloptions) +* **DefaultRelativeDateTimeOptions**: [DefaultRelativeDateTimeControlOptions](#defaultrelativedatetimecontroloptions) +* **DefaultSliderOptions**: [DefaultSliderControlOptions](#defaultslidercontroloptions) +* **DefaultTextAreaOptions**: [DefaultTextAreaControlOptions](#defaulttextareacontroloptions) +* **DefaultTextFieldOptions**: [DefaultTextFieldControlOptions](#defaulttextfieldcontroloptions) -## PivotTableAggregatedFieldWells +## DefaultFilterControlOptions ### Properties -* **Columns**: [DimensionField](#dimensionfield)[] -* **Rows**: [DimensionField](#dimensionfield)[] -* **Values**: [MeasureField](#measurefield)[] +* **DefaultDateTimePickerOptions**: [DefaultDateTimePickerControlOptions](#defaultdatetimepickercontroloptions) +* **DefaultDropdownOptions**: [DefaultFilterDropDownControlOptions](#defaultfilterdropdowncontroloptions) +* **DefaultListOptions**: [DefaultFilterListControlOptions](#defaultfilterlistcontroloptions) +* **DefaultRelativeDateTimeOptions**: [DefaultRelativeDateTimeControlOptions](#defaultrelativedatetimecontroloptions) +* **DefaultSliderOptions**: [DefaultSliderControlOptions](#defaultslidercontroloptions) +* **DefaultTextAreaOptions**: [DefaultTextAreaControlOptions](#defaulttextareacontroloptions) +* **DefaultTextFieldOptions**: [DefaultTextFieldControlOptions](#defaulttextfieldcontroloptions) -## PivotTablePaginatedReportOptions +## DefaultFilterControlOptions ### Properties -* **OverflowColumnHeaderVisibility**: string -* **VerticalOverflowVisibility**: string +* **DefaultDateTimePickerOptions**: [DefaultDateTimePickerControlOptions](#defaultdatetimepickercontroloptions) +* **DefaultDropdownOptions**: [DefaultFilterDropDownControlOptions](#defaultfilterdropdowncontroloptions) +* **DefaultListOptions**: [DefaultFilterListControlOptions](#defaultfilterlistcontroloptions) +* **DefaultRelativeDateTimeOptions**: [DefaultRelativeDateTimeControlOptions](#defaultrelativedatetimecontroloptions) +* **DefaultSliderOptions**: [DefaultSliderControlOptions](#defaultslidercontroloptions) +* **DefaultTextAreaOptions**: [DefaultTextAreaControlOptions](#defaulttextareacontroloptions) +* **DefaultTextFieldOptions**: [DefaultTextFieldControlOptions](#defaulttextfieldcontroloptions) -## PivotTableSortConfiguration +## DefaultFilterDropDownControlOptions ### Properties -* **FieldSortOptions**: [PivotFieldSortOptions](#pivotfieldsortoptions)[] +* **DisplayOptions**: [DropDownControlDisplayOptions](#dropdowncontroldisplayoptions) +* **SelectableValues**: [FilterSelectableValues](#filterselectablevalues) +* **Type**: string -## PivotFieldSortOptions +## DefaultFilterDropDownControlOptions ### Properties -* **FieldId**: string (Required) -* **SortBy**: [PivotTableSortBy](#pivottablesortby) (Required) +* **DisplayOptions**: [DropDownControlDisplayOptions](#dropdowncontroldisplayoptions) +* **SelectableValues**: [FilterSelectableValues](#filterselectablevalues) +* **Type**: string -## PivotTableSortBy +## DefaultFilterDropDownControlOptions ### Properties -* **Column**: [ColumnSort](#columnsort) -* **DataPath**: [DataPathSort](#datapathsort) -* **Field**: [FieldSort](#fieldsort) +* **DisplayOptions**: [DropDownControlDisplayOptions](#dropdowncontroldisplayoptions) +* **SelectableValues**: [FilterSelectableValues](#filterselectablevalues) +* **Type**: string -## DataPathSort +## DefaultFilterListControlOptions ### Properties -* **Direction**: string (Required) -* **SortPaths**: [DataPathValue](#datapathvalue)[] (Required) +* **DisplayOptions**: [ListControlDisplayOptions](#listcontroldisplayoptions) +* **SelectableValues**: [FilterSelectableValues](#filterselectablevalues) +* **Type**: string -## PivotTableOptions +## DefaultFilterListControlOptions ### Properties -* **CellStyle**: [TableCellStyle](#tablecellstyle) -* **CollapsedRowDimensionsVisibility**: string -* **ColumnHeaderStyle**: [TableCellStyle](#tablecellstyle) -* **ColumnNamesVisibility**: string -* **DefaultCellWidth**: string: String based length that is composed of value and unit in px -* **MetricPlacement**: string -* **RowAlternateColorOptions**: [RowAlternateColorOptions](#rowalternatecoloroptions) -* **RowFieldNamesStyle**: [TableCellStyle](#tablecellstyle) -* **RowHeaderStyle**: [TableCellStyle](#tablecellstyle) -* **RowsLabelOptions**: [PivotTableRowsLabelOptions](#pivottablerowslabeloptions) -* **RowsLayout**: string -* **SingleMetricVisibility**: string -* **ToggleButtonsVisibility**: string +* **DisplayOptions**: [ListControlDisplayOptions](#listcontroldisplayoptions) +* **SelectableValues**: [FilterSelectableValues](#filterselectablevalues) +* **Type**: string -## TableCellStyle +## DefaultFilterListControlOptions ### Properties -* **BackgroundColor**: string -* **Border**: [GlobalTableBorderOptions](#globaltableborderoptions) -* **FontConfiguration**: [FontConfiguration](#fontconfiguration) -* **Height**: int -* **HorizontalTextAlignment**: string -* **TextWrap**: string -* **VerticalTextAlignment**: string -* **Visibility**: string +* **DisplayOptions**: [ListControlDisplayOptions](#listcontroldisplayoptions) +* **SelectableValues**: [FilterSelectableValues](#filterselectablevalues) +* **Type**: string -## GlobalTableBorderOptions +## DefaultFormatting ### Properties -* **SideSpecificBorder**: [TableSideBorderOptions](#tablesideborderoptions) -* **UniformBorder**: [TableBorderOptions](#tableborderoptions) +* **DisplayFormat**: string +* **DisplayFormatOptions**: [DisplayFormatOptions](#displayformatoptions) -## TableSideBorderOptions +## DefaultFreeFormLayoutConfiguration ### Properties -* **Bottom**: [TableBorderOptions](#tableborderoptions) -* **InnerHorizontal**: [TableBorderOptions](#tableborderoptions) -* **InnerVertical**: [TableBorderOptions](#tableborderoptions) -* **Left**: [TableBorderOptions](#tableborderoptions) -* **Right**: [TableBorderOptions](#tableborderoptions) -* **Top**: [TableBorderOptions](#tableborderoptions) +* **CanvasSizeOptions**: [FreeFormLayoutCanvasSizeOptions](#freeformlayoutcanvassizeoptions) (Required) -## TableBorderOptions +## DefaultFreeFormLayoutConfiguration ### Properties -* **Color**: string -* **Style**: string -* **Thickness**: int +* **CanvasSizeOptions**: [FreeFormLayoutCanvasSizeOptions](#freeformlayoutcanvassizeoptions) (Required) -## RowAlternateColorOptions +## DefaultFreeFormLayoutConfiguration ### Properties -* **RowAlternateColors**: string[] -* **Status**: string -* **UsePrimaryBackgroundColor**: string +* **CanvasSizeOptions**: [FreeFormLayoutCanvasSizeOptions](#freeformlayoutcanvassizeoptions) (Required) -## PivotTableRowsLabelOptions +## DefaultGridLayoutConfiguration ### Properties -* **CustomLabel**: string -* **Visibility**: string +* **CanvasSizeOptions**: [GridLayoutCanvasSizeOptions](#gridlayoutcanvassizeoptions) (Required) -## PivotTableTotalOptions +## DefaultGridLayoutConfiguration ### Properties -* **ColumnSubtotalOptions**: [SubtotalOptions](#subtotaloptions) -* **ColumnTotalOptions**: [PivotTotalOptions](#pivottotaloptions) -* **RowSubtotalOptions**: [SubtotalOptions](#subtotaloptions) -* **RowTotalOptions**: [PivotTotalOptions](#pivottotaloptions) +* **CanvasSizeOptions**: [GridLayoutCanvasSizeOptions](#gridlayoutcanvassizeoptions) (Required) -## SubtotalOptions +## DefaultGridLayoutConfiguration ### Properties -* **CustomLabel**: string -* **FieldLevel**: string -* **FieldLevelOptions**: [PivotTableFieldSubtotalOptions](#pivottablefieldsubtotaloptions)[] -* **MetricHeaderCellStyle**: [TableCellStyle](#tablecellstyle) -* **StyleTargets**: [TableStyleTarget](#tablestyletarget)[] -* **TotalCellStyle**: [TableCellStyle](#tablecellstyle) -* **TotalsVisibility**: string -* **ValueCellStyle**: [TableCellStyle](#tablecellstyle) +* **CanvasSizeOptions**: [GridLayoutCanvasSizeOptions](#gridlayoutcanvassizeoptions) (Required) -## PivotTableFieldSubtotalOptions +## DefaultInteractiveLayoutConfiguration ### Properties -* **FieldId**: string +* **FreeForm**: [DefaultFreeFormLayoutConfiguration](#defaultfreeformlayoutconfiguration) +* **Grid**: [DefaultGridLayoutConfiguration](#defaultgridlayoutconfiguration) -## TableStyleTarget +## DefaultInteractiveLayoutConfiguration ### Properties -* **CellType**: string (Required) +* **FreeForm**: [DefaultFreeFormLayoutConfiguration](#defaultfreeformlayoutconfiguration) +* **Grid**: [DefaultGridLayoutConfiguration](#defaultgridlayoutconfiguration) -## PivotTotalOptions +## DefaultInteractiveLayoutConfiguration ### Properties -* **CustomLabel**: string -* **MetricHeaderCellStyle**: [TableCellStyle](#tablecellstyle) -* **Placement**: string -* **ScrollStatus**: string -* **TotalAggregationOptions**: [TotalAggregationOption](#totalaggregationoption)[] -* **TotalCellStyle**: [TableCellStyle](#tablecellstyle) -* **TotalsVisibility**: string -* **ValueCellStyle**: [TableCellStyle](#tablecellstyle) +* **FreeForm**: [DefaultFreeFormLayoutConfiguration](#defaultfreeformlayoutconfiguration) +* **Grid**: [DefaultGridLayoutConfiguration](#defaultgridlayoutconfiguration) -## TotalAggregationOption +## DefaultNewSheetConfiguration ### Properties -* **FieldId**: string (Required) -* **TotalAggregationFunction**: [TotalAggregationFunction](#totalaggregationfunction) (Required) +* **InteractiveLayoutConfiguration**: [DefaultInteractiveLayoutConfiguration](#defaultinteractivelayoutconfiguration) +* **PaginatedLayoutConfiguration**: [DefaultPaginatedLayoutConfiguration](#defaultpaginatedlayoutconfiguration) +* **SheetContentType**: string -## TotalAggregationFunction +## DefaultNewSheetConfiguration ### Properties -* **SimpleTotalAggregationFunction**: string +* **InteractiveLayoutConfiguration**: [DefaultInteractiveLayoutConfiguration](#defaultinteractivelayoutconfiguration) +* **PaginatedLayoutConfiguration**: [DefaultPaginatedLayoutConfiguration](#defaultpaginatedlayoutconfiguration) +* **SheetContentType**: string -## PivotTableConditionalFormatting +## DefaultNewSheetConfiguration ### Properties -* **ConditionalFormattingOptions**: [PivotTableConditionalFormattingOption](#pivottableconditionalformattingoption)[] +* **InteractiveLayoutConfiguration**: [DefaultInteractiveLayoutConfiguration](#defaultinteractivelayoutconfiguration) +* **PaginatedLayoutConfiguration**: [DefaultPaginatedLayoutConfiguration](#defaultpaginatedlayoutconfiguration) +* **SheetContentType**: string -## PivotTableConditionalFormattingOption +## DefaultPaginatedLayoutConfiguration ### Properties -* **Cell**: [PivotTableCellConditionalFormatting](#pivottablecellconditionalformatting) +* **SectionBased**: [DefaultSectionBasedLayoutConfiguration](#defaultsectionbasedlayoutconfiguration) -## PivotTableCellConditionalFormatting +## DefaultPaginatedLayoutConfiguration ### Properties -* **FieldId**: string (Required) -* **Scope**: [PivotTableConditionalFormattingScope](#pivottableconditionalformattingscope) -* **Scopes**: [PivotTableConditionalFormattingScope](#pivottableconditionalformattingscope)[] -* **TextFormat**: [TextConditionalFormat](#textconditionalformat) +* **SectionBased**: [DefaultSectionBasedLayoutConfiguration](#defaultsectionbasedlayoutconfiguration) -## PivotTableConditionalFormattingScope +## DefaultPaginatedLayoutConfiguration ### Properties -* **Role**: string +* **SectionBased**: [DefaultSectionBasedLayoutConfiguration](#defaultsectionbasedlayoutconfiguration) -## TextConditionalFormat +## DefaultRelativeDateTimeControlOptions ### Properties -* **BackgroundColor**: [ConditionalFormattingColor](#conditionalformattingcolor) -* **Icon**: [ConditionalFormattingIcon](#conditionalformattingicon) -* **TextColor**: [ConditionalFormattingColor](#conditionalformattingcolor) +* **DisplayOptions**: [RelativeDateTimeControlDisplayOptions](#relativedatetimecontroldisplayoptions) -## RadarChartVisual +## DefaultRelativeDateTimeControlOptions ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [RadarChartConfiguration](#radarchartconfiguration) -* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] -* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) -* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) -* **VisualId**: string (Required) +* **DisplayOptions**: [RelativeDateTimeControlDisplayOptions](#relativedatetimecontroldisplayoptions) -## RadarChartConfiguration +## DefaultRelativeDateTimeControlOptions ### Properties -* **AlternateBandColorsVisibility**: string -* **AlternateBandEvenColor**: string -* **AlternateBandOddColor**: string -* **AxesRangeScale**: string -* **BaseSeriesSettings**: [RadarChartSeriesSettings](#radarchartseriessettings) -* **CategoryAxis**: [AxisDisplayOptions](#axisdisplayoptions) -* **CategoryLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **ColorAxis**: [AxisDisplayOptions](#axisdisplayoptions) -* **ColorLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **FieldWells**: [RadarChartFieldWells](#radarchartfieldwells) -* **Legend**: [LegendOptions](#legendoptions) -* **Shape**: string -* **SortConfiguration**: [RadarChartSortConfiguration](#radarchartsortconfiguration) -* **StartAngle**: int -* **VisualPalette**: [VisualPalette](#visualpalette) +* **DisplayOptions**: [RelativeDateTimeControlDisplayOptions](#relativedatetimecontroldisplayoptions) -## RadarChartSeriesSettings +## DefaultSectionBasedLayoutConfiguration ### Properties -* **AreaStyleSettings**: [RadarChartAreaStyleSettings](#radarchartareastylesettings) +* **CanvasSizeOptions**: [SectionBasedLayoutCanvasSizeOptions](#sectionbasedlayoutcanvassizeoptions) (Required) -## RadarChartAreaStyleSettings +## DefaultSectionBasedLayoutConfiguration ### Properties -* **Visibility**: string +* **CanvasSizeOptions**: [SectionBasedLayoutCanvasSizeOptions](#sectionbasedlayoutcanvassizeoptions) (Required) -## RadarChartFieldWells +## DefaultSectionBasedLayoutConfiguration ### Properties -* **RadarChartAggregatedFieldWells**: [RadarChartAggregatedFieldWells](#radarchartaggregatedfieldwells) +* **CanvasSizeOptions**: [SectionBasedLayoutCanvasSizeOptions](#sectionbasedlayoutcanvassizeoptions) (Required) -## RadarChartAggregatedFieldWells +## DefaultSliderControlOptions ### Properties -* **Category**: [DimensionField](#dimensionfield)[] -* **Color**: [DimensionField](#dimensionfield)[] -* **Values**: [MeasureField](#measurefield)[] +* **DisplayOptions**: [SliderControlDisplayOptions](#slidercontroldisplayoptions) +* **MaximumValue**: int (Required) +* **MinimumValue**: int (Required) +* **StepSize**: int (Required) +* **Type**: string -## RadarChartSortConfiguration +## DefaultSliderControlOptions ### Properties -* **CategoryItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) -* **CategorySort**: [FieldSortOptions](#fieldsortoptions)[] -* **ColorItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) -* **ColorSort**: [FieldSortOptions](#fieldsortoptions)[] +* **DisplayOptions**: [SliderControlDisplayOptions](#slidercontroldisplayoptions) +* **MaximumValue**: int (Required) +* **MinimumValue**: int (Required) +* **StepSize**: int (Required) +* **Type**: string -## SankeyDiagramVisual +## DefaultSliderControlOptions ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [SankeyDiagramChartConfiguration](#sankeydiagramchartconfiguration) -* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) -* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) -* **VisualId**: string (Required) +* **DisplayOptions**: [SliderControlDisplayOptions](#slidercontroldisplayoptions) +* **MaximumValue**: int (Required) +* **MinimumValue**: int (Required) +* **StepSize**: int (Required) +* **Type**: string -## SankeyDiagramChartConfiguration +## DefaultTextAreaControlOptions ### Properties -* **DataLabels**: [DataLabelOptions](#datalabeloptions) -* **FieldWells**: [SankeyDiagramFieldWells](#sankeydiagramfieldwells) -* **SortConfiguration**: [SankeyDiagramSortConfiguration](#sankeydiagramsortconfiguration) +* **Delimiter**: string +* **DisplayOptions**: [TextAreaControlDisplayOptions](#textareacontroldisplayoptions) -## SankeyDiagramFieldWells +## DefaultTextAreaControlOptions ### Properties -* **SankeyDiagramAggregatedFieldWells**: [SankeyDiagramAggregatedFieldWells](#sankeydiagramaggregatedfieldwells) +* **Delimiter**: string +* **DisplayOptions**: [TextAreaControlDisplayOptions](#textareacontroldisplayoptions) -## SankeyDiagramAggregatedFieldWells +## DefaultTextAreaControlOptions ### Properties -* **Destination**: [DimensionField](#dimensionfield)[] -* **Source**: [DimensionField](#dimensionfield)[] -* **Weight**: [MeasureField](#measurefield)[] +* **Delimiter**: string +* **DisplayOptions**: [TextAreaControlDisplayOptions](#textareacontroldisplayoptions) -## SankeyDiagramSortConfiguration +## DefaultTextFieldControlOptions ### Properties -* **DestinationItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) -* **SourceItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) -* **WeightSort**: [FieldSortOptions](#fieldsortoptions)[] +* **DisplayOptions**: [TextFieldControlDisplayOptions](#textfieldcontroldisplayoptions) -## ScatterPlotVisual +## DefaultTextFieldControlOptions ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [ScatterPlotConfiguration](#scatterplotconfiguration) -* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] -* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) -* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) -* **VisualId**: string (Required) +* **DisplayOptions**: [TextFieldControlDisplayOptions](#textfieldcontroldisplayoptions) -## ScatterPlotConfiguration +## DefaultTextFieldControlOptions ### Properties -* **DataLabels**: [DataLabelOptions](#datalabeloptions) -* **FieldWells**: [ScatterPlotFieldWells](#scatterplotfieldwells) -* **Legend**: [LegendOptions](#legendoptions) -* **Tooltip**: [TooltipOptions](#tooltipoptions) -* **VisualPalette**: [VisualPalette](#visualpalette) -* **XAxisDisplayOptions**: [AxisDisplayOptions](#axisdisplayoptions) -* **XAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **YAxisDisplayOptions**: [AxisDisplayOptions](#axisdisplayoptions) -* **YAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **DisplayOptions**: [TextFieldControlDisplayOptions](#textfieldcontroldisplayoptions) -## ScatterPlotFieldWells +## DestinationParameterValueConfiguration ### Properties -* **ScatterPlotCategoricallyAggregatedFieldWells**: [ScatterPlotCategoricallyAggregatedFieldWells](#scatterplotcategoricallyaggregatedfieldwells) -* **ScatterPlotUnaggregatedFieldWells**: [ScatterPlotUnaggregatedFieldWells](#scatterplotunaggregatedfieldwells) +* **CustomValuesConfiguration**: [CustomValuesConfiguration](#customvaluesconfiguration) +* **SelectAllValueOptions**: string +* **SourceColumn**: [ColumnIdentifier](#columnidentifier) +* **SourceField**: string +* **SourceParameterName**: string -## ScatterPlotCategoricallyAggregatedFieldWells +## DestinationParameterValueConfiguration ### Properties -* **Category**: [DimensionField](#dimensionfield)[] -* **Label**: [DimensionField](#dimensionfield)[] -* **Size**: [MeasureField](#measurefield)[] -* **XAxis**: [MeasureField](#measurefield)[] -* **YAxis**: [MeasureField](#measurefield)[] +* **CustomValuesConfiguration**: [CustomValuesConfiguration](#customvaluesconfiguration) +* **SelectAllValueOptions**: string +* **SourceColumn**: [ColumnIdentifier](#columnidentifier) +* **SourceField**: string +* **SourceParameterName**: string -## ScatterPlotUnaggregatedFieldWells +## DestinationParameterValueConfiguration ### Properties -* **Category**: [DimensionField](#dimensionfield)[] -* **Label**: [DimensionField](#dimensionfield)[] -* **Size**: [MeasureField](#measurefield)[] -* **XAxis**: [DimensionField](#dimensionfield)[] -* **YAxis**: [DimensionField](#dimensionfield)[] +* **CustomValuesConfiguration**: [CustomValuesConfiguration](#customvaluesconfiguration) +* **SelectAllValueOptions**: string +* **SourceColumn**: [ColumnIdentifier](#columnidentifier) +* **SourceField**: string +* **SourceParameterName**: string -## TableVisual +## DimensionField ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [TableConfiguration](#tableconfiguration) -* **ConditionalFormatting**: [TableConditionalFormatting](#tableconditionalformatting) -* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) -* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) -* **VisualId**: string (Required) +* **CategoricalDimensionField**: [CategoricalDimensionField](#categoricaldimensionfield) +* **DateDimensionField**: [DateDimensionField](#datedimensionfield) +* **NumericalDimensionField**: [NumericalDimensionField](#numericaldimensionfield) -## TableConfiguration +## DimensionField ### Properties -* **FieldOptions**: [TableFieldOptions](#tablefieldoptions) -* **FieldWells**: [TableFieldWells](#tablefieldwells) -* **PaginatedReportOptions**: [TablePaginatedReportOptions](#tablepaginatedreportoptions) -* **SortConfiguration**: [TableSortConfiguration](#tablesortconfiguration) -* **TableInlineVisualizations**: [TableInlineVisualization](#tableinlinevisualization)[] -* **TableOptions**: [TableOptions](#tableoptions) -* **TotalOptions**: [TotalOptions](#totaloptions) +* **CategoricalDimensionField**: [CategoricalDimensionField](#categoricaldimensionfield) +* **DateDimensionField**: [DateDimensionField](#datedimensionfield) +* **NumericalDimensionField**: [NumericalDimensionField](#numericaldimensionfield) -## TableFieldOptions +## DimensionField ### Properties -* **Order**: string[] -* **PinnedFieldOptions**: [TablePinnedFieldOptions](#tablepinnedfieldoptions) -* **SelectedFieldOptions**: [TableFieldOption](#tablefieldoption)[] +* **CategoricalDimensionField**: [CategoricalDimensionField](#categoricaldimensionfield) +* **DateDimensionField**: [DateDimensionField](#datedimensionfield) +* **NumericalDimensionField**: [NumericalDimensionField](#numericaldimensionfield) -## TablePinnedFieldOptions +## DisplayFormatOptions ### Properties -* **PinnedLeftFields**: string[] +* **BlankCellFormat**: string +* **CurrencySymbol**: string +* **DateFormat**: string +* **DecimalSeparator**: string +* **FractionDigits**: int +* **GroupingSeparator**: string +* **NegativeFormat**: [NegativeFormat](#negativeformat) +* **Prefix**: string +* **Suffix**: string +* **UnitScaler**: string +* **UseBlankCellFormat**: bool +* **UseGrouping**: bool -## TableFieldOption +## DonutCenterOptions ### Properties -* **CustomLabel**: string -* **FieldId**: string (Required) -* **URLStyling**: [TableFieldURLConfiguration](#tablefieldurlconfiguration) -* **Visibility**: string -* **Width**: string: String based length that is composed of value and unit in px +* **LabelVisibility**: string -## TableFieldURLConfiguration +## DonutCenterOptions ### Properties -* **ImageConfiguration**: [TableFieldImageConfiguration](#tablefieldimageconfiguration) -* **LinkConfiguration**: [TableFieldLinkConfiguration](#tablefieldlinkconfiguration) +* **LabelVisibility**: string -## TableFieldImageConfiguration +## DonutCenterOptions ### Properties -* **SizingOptions**: [TableCellImageSizingConfiguration](#tablecellimagesizingconfiguration) +* **LabelVisibility**: string -## TableCellImageSizingConfiguration +## DonutOptions ### Properties -* **TableCellImageScalingConfiguration**: string +* **ArcOptions**: [ArcOptions](#arcoptions) +* **DonutCenterOptions**: [DonutCenterOptions](#donutcenteroptions) -## TableFieldLinkConfiguration +## DonutOptions ### Properties -* **Content**: [TableFieldLinkContentConfiguration](#tablefieldlinkcontentconfiguration) (Required) -* **Target**: string (Required) +* **ArcOptions**: [ArcOptions](#arcoptions) +* **DonutCenterOptions**: [DonutCenterOptions](#donutcenteroptions) -## TableFieldLinkContentConfiguration +## DonutOptions ### Properties -* **CustomIconContent**: [TableFieldCustomIconContent](#tablefieldcustomiconcontent) -* **CustomTextContent**: [TableFieldCustomTextContent](#tablefieldcustomtextcontent) +* **ArcOptions**: [ArcOptions](#arcoptions) +* **DonutCenterOptions**: [DonutCenterOptions](#donutcenteroptions) -## TableFieldCustomIconContent +## DrillDownFilter ### Properties -* **Icon**: string +* **CategoryFilter**: [CategoryDrillDownFilter](#categorydrilldownfilter) +* **NumericEqualityFilter**: [NumericEqualityDrillDownFilter](#numericequalitydrilldownfilter) +* **TimeRangeFilter**: [TimeRangeDrillDownFilter](#timerangedrilldownfilter) -## TableFieldCustomTextContent +## DrillDownFilter ### Properties -* **FontConfiguration**: [FontConfiguration](#fontconfiguration) (Required) -* **Value**: string +* **CategoryFilter**: [CategoryDrillDownFilter](#categorydrilldownfilter) +* **NumericEqualityFilter**: [NumericEqualityDrillDownFilter](#numericequalitydrilldownfilter) +* **TimeRangeFilter**: [TimeRangeDrillDownFilter](#timerangedrilldownfilter) -## TableFieldWells +## DrillDownFilter ### Properties -* **TableAggregatedFieldWells**: [TableAggregatedFieldWells](#tableaggregatedfieldwells) -* **TableUnaggregatedFieldWells**: [TableUnaggregatedFieldWells](#tableunaggregatedfieldwells) +* **CategoryFilter**: [CategoryDrillDownFilter](#categorydrilldownfilter) +* **NumericEqualityFilter**: [NumericEqualityDrillDownFilter](#numericequalitydrilldownfilter) +* **TimeRangeFilter**: [TimeRangeDrillDownFilter](#timerangedrilldownfilter) -## TableAggregatedFieldWells +## DropDownControlDisplayOptions ### Properties -* **GroupBy**: [DimensionField](#dimensionfield)[] -* **Values**: [MeasureField](#measurefield)[] +* **InfoIconLabelOptions**: [SheetControlInfoIconLabelOptions](#sheetcontrolinfoiconlabeloptions) +* **SelectAllOptions**: [ListControlSelectAllOptions](#listcontrolselectalloptions) +* **TitleOptions**: [LabelOptions](#labeloptions) -## TableUnaggregatedFieldWells +## DropDownControlDisplayOptions ### Properties -* **Values**: [UnaggregatedField](#unaggregatedfield)[] +* **InfoIconLabelOptions**: [SheetControlInfoIconLabelOptions](#sheetcontrolinfoiconlabeloptions) +* **SelectAllOptions**: [ListControlSelectAllOptions](#listcontrolselectalloptions) +* **TitleOptions**: [LabelOptions](#labeloptions) -## UnaggregatedField +## DropDownControlDisplayOptions ### Properties -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **FieldId**: string (Required) -* **FormatConfiguration**: [FormatConfiguration](#formatconfiguration) +* **InfoIconLabelOptions**: [SheetControlInfoIconLabelOptions](#sheetcontrolinfoiconlabeloptions) +* **SelectAllOptions**: [ListControlSelectAllOptions](#listcontrolselectalloptions) +* **TitleOptions**: [LabelOptions](#labeloptions) -## TablePaginatedReportOptions +## DynamicDefaultValue ### Properties -* **OverflowColumnHeaderVisibility**: string -* **VerticalOverflowVisibility**: string +* **DefaultValueColumn**: [ColumnIdentifier](#columnidentifier) (Required) +* **GroupNameColumn**: [ColumnIdentifier](#columnidentifier) +* **UserNameColumn**: [ColumnIdentifier](#columnidentifier) -## TableSortConfiguration +## DynamicDefaultValue +### Properties +* **DefaultValueColumn**: [ColumnIdentifier](#columnidentifier) (Required) +* **GroupNameColumn**: [ColumnIdentifier](#columnidentifier) +* **UserNameColumn**: [ColumnIdentifier](#columnidentifier) + +## DynamicDefaultValue +### Properties +* **DefaultValueColumn**: [ColumnIdentifier](#columnidentifier) (Required) +* **GroupNameColumn**: [ColumnIdentifier](#columnidentifier) +* **UserNameColumn**: [ColumnIdentifier](#columnidentifier) + +## EmptyVisual ### Properties -* **PaginationConfiguration**: [PaginationConfiguration](#paginationconfiguration) -* **RowSort**: [FieldSortOptions](#fieldsortoptions)[] +* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **DataSetIdentifier**: string (Required) +* **VisualId**: string (Required) -## TableInlineVisualization +## EmptyVisual ### Properties -* **DataBars**: [DataBarsOptions](#databarsoptions) +* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **DataSetIdentifier**: string (Required) +* **VisualId**: string (Required) -## DataBarsOptions +## EmptyVisual ### Properties -* **FieldId**: string (Required) -* **NegativeColor**: string -* **PositiveColor**: string +* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **DataSetIdentifier**: string (Required) +* **VisualId**: string (Required) -## TableOptions +## Entity ### Properties -* **CellStyle**: [TableCellStyle](#tablecellstyle) -* **HeaderStyle**: [TableCellStyle](#tablecellstyle) -* **Orientation**: string -* **RowAlternateColorOptions**: [RowAlternateColorOptions](#rowalternatecoloroptions) +* **Path**: string -## TotalOptions +## Entity ### Properties -* **CustomLabel**: string -* **Placement**: string -* **ScrollStatus**: string -* **TotalAggregationOptions**: [TotalAggregationOption](#totalaggregationoption)[] -* **TotalCellStyle**: [TableCellStyle](#tablecellstyle) -* **TotalsVisibility**: string +* **Path**: string -## TableConditionalFormatting +## Entity ### Properties -* **ConditionalFormattingOptions**: [TableConditionalFormattingOption](#tableconditionalformattingoption)[] +* **Path**: string -## TableConditionalFormattingOption +## ExcludePeriodConfiguration ### Properties -* **Cell**: [TableCellConditionalFormatting](#tablecellconditionalformatting) -* **Row**: [TableRowConditionalFormatting](#tablerowconditionalformatting) +* **Amount**: int (Required) +* **Granularity**: string (Required) +* **Status**: string -## TableCellConditionalFormatting +## ExcludePeriodConfiguration ### Properties -* **FieldId**: string (Required) -* **TextFormat**: [TextConditionalFormat](#textconditionalformat) +* **Amount**: int (Required) +* **Granularity**: string (Required) +* **Status**: string -## TableRowConditionalFormatting +## ExcludePeriodConfiguration ### Properties -* **BackgroundColor**: [ConditionalFormattingColor](#conditionalformattingcolor) -* **TextColor**: [ConditionalFormattingColor](#conditionalformattingcolor) +* **Amount**: int (Required) +* **Granularity**: string (Required) +* **Status**: string -## TreeMapVisual +## ExplicitHierarchy ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [TreeMapConfiguration](#treemapconfiguration) -* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] -* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) -* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) -* **VisualId**: string (Required) +* **Columns**: [ColumnIdentifier](#columnidentifier)[] (Required) +* **DrillDownFilters**: [DrillDownFilter](#drilldownfilter)[] +* **HierarchyId**: string (Required) -## TreeMapConfiguration +## ExplicitHierarchy ### Properties -* **ColorLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **ColorScale**: [ColorScale](#colorscale) -* **DataLabels**: [DataLabelOptions](#datalabeloptions) -* **FieldWells**: [TreeMapFieldWells](#treemapfieldwells) -* **GroupLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **Legend**: [LegendOptions](#legendoptions) -* **SizeLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **SortConfiguration**: [TreeMapSortConfiguration](#treemapsortconfiguration) -* **Tooltip**: [TooltipOptions](#tooltipoptions) +* **Columns**: [ColumnIdentifier](#columnidentifier)[] (Required) +* **DrillDownFilters**: [DrillDownFilter](#drilldownfilter)[] +* **HierarchyId**: string (Required) -## TreeMapFieldWells +## ExplicitHierarchy ### Properties -* **TreeMapAggregatedFieldWells**: [TreeMapAggregatedFieldWells](#treemapaggregatedfieldwells) +* **Columns**: [ColumnIdentifier](#columnidentifier)[] (Required) +* **DrillDownFilters**: [DrillDownFilter](#drilldownfilter)[] +* **HierarchyId**: string (Required) -## TreeMapAggregatedFieldWells +## ExportHiddenFieldsOption ### Properties -* **Colors**: [MeasureField](#measurefield)[] -* **Groups**: [DimensionField](#dimensionfield)[] -* **Sizes**: [MeasureField](#measurefield)[] +* **AvailabilityStatus**: string -## TreeMapSortConfiguration +## ExportToCSVOption ### Properties -* **TreeMapGroupItemsLimitConfiguration**: [ItemsLimitConfiguration](#itemslimitconfiguration) -* **TreeMapSort**: [FieldSortOptions](#fieldsortoptions)[] +* **AvailabilityStatus**: string -## WaterfallVisual +## ExportWithHiddenFieldsOption ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [WaterfallChartConfiguration](#waterfallchartconfiguration) -* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] -* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) -* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) -* **VisualId**: string (Required) +* **AvailabilityStatus**: string -## WaterfallChartConfiguration +## FieldBasedTooltip ### Properties -* **CategoryAxisDisplayOptions**: [AxisDisplayOptions](#axisdisplayoptions) -* **CategoryAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **DataLabels**: [DataLabelOptions](#datalabeloptions) -* **FieldWells**: [WaterfallChartFieldWells](#waterfallchartfieldwells) -* **Legend**: [LegendOptions](#legendoptions) -* **PrimaryYAxisDisplayOptions**: [AxisDisplayOptions](#axisdisplayoptions) -* **PrimaryYAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **SortConfiguration**: [WaterfallChartSortConfiguration](#waterfallchartsortconfiguration) -* **VisualPalette**: [VisualPalette](#visualpalette) -* **WaterfallChartOptions**: [WaterfallChartOptions](#waterfallchartoptions) +* **AggregationVisibility**: string +* **TooltipFields**: [TooltipItem](#tooltipitem)[] +* **TooltipTitleType**: string -## WaterfallChartFieldWells +## FieldBasedTooltip ### Properties -* **WaterfallChartAggregatedFieldWells**: [WaterfallChartAggregatedFieldWells](#waterfallchartaggregatedfieldwells) +* **AggregationVisibility**: string +* **TooltipFields**: [TooltipItem](#tooltipitem)[] +* **TooltipTitleType**: string -## WaterfallChartAggregatedFieldWells +## FieldBasedTooltip ### Properties -* **Breakdowns**: [DimensionField](#dimensionfield)[] -* **Categories**: [DimensionField](#dimensionfield)[] -* **Values**: [MeasureField](#measurefield)[] +* **AggregationVisibility**: string +* **TooltipFields**: [TooltipItem](#tooltipitem)[] +* **TooltipTitleType**: string -## WaterfallChartSortConfiguration +## FieldFolderMap ### Properties -* **BreakdownItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) -* **CategorySort**: [FieldSortOptions](#fieldsortoptions)[] -## WaterfallChartOptions +## FieldLabelType ### Properties -* **TotalBarLabel**: string +* **FieldId**: string +* **Visibility**: string -## WordCloudVisual +## FieldLabelType ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [WordCloudChartConfiguration](#wordcloudchartconfiguration) -* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] -* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) -* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) -* **VisualId**: string (Required) +* **FieldId**: string +* **Visibility**: string -## WordCloudChartConfiguration +## FieldLabelType ### Properties -* **CategoryLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **FieldWells**: [WordCloudFieldWells](#wordcloudfieldwells) -* **SortConfiguration**: [WordCloudSortConfiguration](#wordcloudsortconfiguration) -* **WordCloudOptions**: [WordCloudOptions](#wordcloudoptions) +* **FieldId**: string +* **Visibility**: string -## WordCloudFieldWells +## FieldSeriesItem ### Properties -* **WordCloudAggregatedFieldWells**: [WordCloudAggregatedFieldWells](#wordcloudaggregatedfieldwells) +* **AxisBinding**: string (Required) +* **FieldId**: string (Required) +* **Settings**: [LineChartSeriesSettings](#linechartseriessettings) -## WordCloudAggregatedFieldWells +## FieldSeriesItem ### Properties -* **GroupBy**: [DimensionField](#dimensionfield)[] -* **Size**: [MeasureField](#measurefield)[] +* **AxisBinding**: string (Required) +* **FieldId**: string (Required) +* **Settings**: [LineChartSeriesSettings](#linechartseriessettings) -## WordCloudSortConfiguration +## FieldSeriesItem ### Properties -* **CategoryItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) -* **CategorySort**: [FieldSortOptions](#fieldsortoptions)[] +* **AxisBinding**: string (Required) +* **FieldId**: string (Required) +* **Settings**: [LineChartSeriesSettings](#linechartseriessettings) -## WordCloudOptions +## FieldSort ### Properties -* **CloudLayout**: string -* **MaximumStringLength**: int -* **WordCasing**: string -* **WordOrientation**: string -* **WordPadding**: string -* **WordScaling**: string +* **Direction**: string (Required) +* **FieldId**: string (Required) -## AnalysisError +## FieldSort ### Properties -* **Message**: string -* **Type**: string -* **ViolatedEntities**: [Entity](#entity)[] +* **Direction**: string (Required) +* **FieldId**: string (Required) -## Entity +## FieldSort ### Properties -* **Path**: string +* **Direction**: string (Required) +* **FieldId**: string (Required) -## Parameters +## FieldSortOptions ### Properties -* **DateTimeParameters**: [DateTimeParameter](#datetimeparameter)[] -* **DecimalParameters**: [DecimalParameter](#decimalparameter)[] -* **IntegerParameters**: [IntegerParameter](#integerparameter)[] -* **StringParameters**: [StringParameter](#stringparameter)[] +* **ColumnSort**: [ColumnSort](#columnsort) +* **FieldSort**: [FieldSort](#fieldsort) -## DateTimeParameter +## FieldSortOptions ### Properties -* **Name**: string (Required) -* **Values**: string[] (Required) +* **ColumnSort**: [ColumnSort](#columnsort) +* **FieldSort**: [FieldSort](#fieldsort) -## DecimalParameter +## FieldSortOptions ### Properties -* **Name**: string (Required) -* **Values**: int[] (Required) +* **ColumnSort**: [ColumnSort](#columnsort) +* **FieldSort**: [FieldSort](#fieldsort) -## IntegerParameter +## FieldTooltipItem ### Properties -* **Name**: string (Required) -* **Values**: int[] (Required) +* **FieldId**: string (Required) +* **Label**: string +* **Visibility**: string -## StringParameter +## FieldTooltipItem ### Properties -* **Name**: string (Required) -* **Values**: string[] (Required) +* **FieldId**: string (Required) +* **Label**: string +* **Visibility**: string -## ResourcePermission +## FieldTooltipItem ### Properties -* **Actions**: string[] (Required) -* **Principal**: string (Required) +* **FieldId**: string (Required) +* **Label**: string +* **Visibility**: string -## Sheet +## FilledMapAggregatedFieldWells ### Properties -* **Name**: string -* **SheetId**: string +* **Geospatial**: [DimensionField](#dimensionfield)[] +* **Values**: [MeasureField](#measurefield)[] -## AnalysisSourceEntity +## FilledMapAggregatedFieldWells ### Properties -* **SourceTemplate**: [AnalysisSourceTemplate](#analysissourcetemplate) +* **Geospatial**: [DimensionField](#dimensionfield)[] +* **Values**: [MeasureField](#measurefield)[] -## AnalysisSourceTemplate +## FilledMapAggregatedFieldWells ### Properties -* **Arn**: string (Required) -* **DataSetReferences**: [DataSetReference](#datasetreference)[] (Required) +* **Geospatial**: [DimensionField](#dimensionfield)[] +* **Values**: [MeasureField](#measurefield)[] -## DataSetReference +## FilledMapConditionalFormatting ### Properties -* **DataSetArn**: string (Required) -* **DataSetPlaceholder**: string (Required) +* **ConditionalFormattingOptions**: [FilledMapConditionalFormattingOption](#filledmapconditionalformattingoption)[] (Required) -## Tag +## FilledMapConditionalFormatting ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **ConditionalFormattingOptions**: [FilledMapConditionalFormattingOption](#filledmapconditionalformattingoption)[] (Required) -## ValidationStrategy +## FilledMapConditionalFormatting ### Properties -* **Mode**: string (Required) +* **ConditionalFormattingOptions**: [FilledMapConditionalFormattingOption](#filledmapconditionalformattingoption)[] (Required) -## AWS.QuickSight/DashboardProperties +## FilledMapConditionalFormattingOption ### Properties -* **Arn**: string (ReadOnly) -* **AwsAccountId**: string (Required, Identifier) -* **CreatedTime**: string (ReadOnly) -* **DashboardId**: string (Required, Identifier) -* **DashboardPublishOptions**: [DashboardPublishOptions](#dashboardpublishoptions) (WriteOnly) -* **Definition**: [DashboardVersionDefinition](#dashboardversiondefinition) (WriteOnly) -* **LastPublishedTime**: string (ReadOnly) -* **LastUpdatedTime**: string (ReadOnly) -* **LinkSharingConfiguration**: [LinkSharingConfiguration](#linksharingconfiguration) (WriteOnly) -* **Name**: string (Required) -* **Parameters**: [Parameters](#parameters) (WriteOnly) -* **Permissions**: [ResourcePermission](#resourcepermission)[] -* **SourceEntity**: [DashboardSourceEntity](#dashboardsourceentity) (WriteOnly) -* **Tags**: [Tag](#tag)[] -* **ThemeArn**: string (WriteOnly) -* **ValidationStrategy**: [ValidationStrategy](#validationstrategy) (WriteOnly) -* **Version**: [DashboardVersion](#dashboardversion) (ReadOnly) -* **VersionDescription**: string (WriteOnly) +* **Shape**: [FilledMapShapeConditionalFormatting](#filledmapshapeconditionalformatting) (Required) -## DashboardPublishOptions +## FilledMapConditionalFormattingOption ### Properties -* **AdHocFilteringOption**: [AdHocFilteringOption](#adhocfilteringoption) -* **DataPointDrillUpDownOption**: [DataPointDrillUpDownOption](#datapointdrillupdownoption) -* **DataPointMenuLabelOption**: [DataPointMenuLabelOption](#datapointmenulabeloption) -* **DataPointTooltipOption**: [DataPointTooltipOption](#datapointtooltipoption) -* **ExportToCSVOption**: [ExportToCSVOption](#exporttocsvoption) -* **ExportWithHiddenFieldsOption**: [ExportWithHiddenFieldsOption](#exportwithhiddenfieldsoption) -* **SheetControlsOption**: [SheetControlsOption](#sheetcontrolsoption) -* **SheetLayoutElementMaximizationOption**: [SheetLayoutElementMaximizationOption](#sheetlayoutelementmaximizationoption) -* **VisualAxisSortOption**: [VisualAxisSortOption](#visualaxissortoption) -* **VisualMenuOption**: [VisualMenuOption](#visualmenuoption) -* **VisualPublishOptions**: [DashboardVisualPublishOptions](#dashboardvisualpublishoptions) +* **Shape**: [FilledMapShapeConditionalFormatting](#filledmapshapeconditionalformatting) (Required) -## AdHocFilteringOption +## FilledMapConditionalFormattingOption ### Properties -* **AvailabilityStatus**: string +* **Shape**: [FilledMapShapeConditionalFormatting](#filledmapshapeconditionalformatting) (Required) -## DataPointDrillUpDownOption +## FilledMapConfiguration ### Properties -* **AvailabilityStatus**: string +* **FieldWells**: [FilledMapFieldWells](#filledmapfieldwells) +* **Legend**: [LegendOptions](#legendoptions) +* **MapStyleOptions**: [GeospatialMapStyleOptions](#geospatialmapstyleoptions) +* **SortConfiguration**: [FilledMapSortConfiguration](#filledmapsortconfiguration) +* **Tooltip**: [TooltipOptions](#tooltipoptions) +* **WindowOptions**: [GeospatialWindowOptions](#geospatialwindowoptions) -## DataPointMenuLabelOption +## FilledMapConfiguration ### Properties -* **AvailabilityStatus**: string +* **FieldWells**: [FilledMapFieldWells](#filledmapfieldwells) +* **Legend**: [LegendOptions](#legendoptions) +* **MapStyleOptions**: [GeospatialMapStyleOptions](#geospatialmapstyleoptions) +* **SortConfiguration**: [FilledMapSortConfiguration](#filledmapsortconfiguration) +* **Tooltip**: [TooltipOptions](#tooltipoptions) +* **WindowOptions**: [GeospatialWindowOptions](#geospatialwindowoptions) -## DataPointTooltipOption +## FilledMapConfiguration ### Properties -* **AvailabilityStatus**: string +* **FieldWells**: [FilledMapFieldWells](#filledmapfieldwells) +* **Legend**: [LegendOptions](#legendoptions) +* **MapStyleOptions**: [GeospatialMapStyleOptions](#geospatialmapstyleoptions) +* **SortConfiguration**: [FilledMapSortConfiguration](#filledmapsortconfiguration) +* **Tooltip**: [TooltipOptions](#tooltipoptions) +* **WindowOptions**: [GeospatialWindowOptions](#geospatialwindowoptions) -## ExportToCSVOption +## FilledMapFieldWells ### Properties -* **AvailabilityStatus**: string +* **FilledMapAggregatedFieldWells**: [FilledMapAggregatedFieldWells](#filledmapaggregatedfieldwells) -## ExportWithHiddenFieldsOption +## FilledMapFieldWells ### Properties -* **AvailabilityStatus**: string +* **FilledMapAggregatedFieldWells**: [FilledMapAggregatedFieldWells](#filledmapaggregatedfieldwells) -## SheetControlsOption +## FilledMapFieldWells ### Properties -* **VisibilityState**: string +* **FilledMapAggregatedFieldWells**: [FilledMapAggregatedFieldWells](#filledmapaggregatedfieldwells) -## SheetLayoutElementMaximizationOption +## FilledMapShapeConditionalFormatting ### Properties -* **AvailabilityStatus**: string +* **FieldId**: string (Required) +* **Format**: [ShapeConditionalFormat](#shapeconditionalformat) -## VisualAxisSortOption +## FilledMapShapeConditionalFormatting ### Properties -* **AvailabilityStatus**: string +* **FieldId**: string (Required) +* **Format**: [ShapeConditionalFormat](#shapeconditionalformat) -## VisualMenuOption +## FilledMapShapeConditionalFormatting ### Properties -* **AvailabilityStatus**: string +* **FieldId**: string (Required) +* **Format**: [ShapeConditionalFormat](#shapeconditionalformat) -## DashboardVisualPublishOptions +## FilledMapSortConfiguration ### Properties -* **ExportHiddenFieldsOption**: [ExportHiddenFieldsOption](#exporthiddenfieldsoption) +* **CategorySort**: [FieldSortOptions](#fieldsortoptions)[] -## ExportHiddenFieldsOption +## FilledMapSortConfiguration ### Properties -* **AvailabilityStatus**: string +* **CategorySort**: [FieldSortOptions](#fieldsortoptions)[] -## DashboardVersionDefinition +## FilledMapSortConfiguration ### Properties -* **AnalysisDefaults**: [AnalysisDefaults](#analysisdefaults) -* **CalculatedFields**: [CalculatedField](#calculatedfield)[] -* **ColumnConfigurations**: [ColumnConfiguration](#columnconfiguration)[] -* **DataSetIdentifierDeclarations**: [DataSetIdentifierDeclaration](#datasetidentifierdeclaration)[] (Required) -* **FilterGroups**: [FilterGroup](#filtergroup)[] -* **Options**: [AssetOptions](#assetoptions) -* **ParameterDeclarations**: [ParameterDeclaration](#parameterdeclaration)[] -* **Sheets**: [SheetDefinition](#sheetdefinition)[] +* **CategorySort**: [FieldSortOptions](#fieldsortoptions)[] -## AnalysisDefaults +## FilledMapVisual ### Properties -* **DefaultNewSheetConfiguration**: [DefaultNewSheetConfiguration](#defaultnewsheetconfiguration) (Required) +* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **ChartConfiguration**: [FilledMapConfiguration](#filledmapconfiguration) +* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] +* **ConditionalFormatting**: [FilledMapConditionalFormatting](#filledmapconditionalformatting) +* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) +* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) +* **VisualId**: string (Required) -## DefaultNewSheetConfiguration +## FilledMapVisual ### Properties -* **InteractiveLayoutConfiguration**: [DefaultInteractiveLayoutConfiguration](#defaultinteractivelayoutconfiguration) -* **PaginatedLayoutConfiguration**: [DefaultPaginatedLayoutConfiguration](#defaultpaginatedlayoutconfiguration) -* **SheetContentType**: string +* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **ChartConfiguration**: [FilledMapConfiguration](#filledmapconfiguration) +* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] +* **ConditionalFormatting**: [FilledMapConditionalFormatting](#filledmapconditionalformatting) +* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) +* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) +* **VisualId**: string (Required) -## DefaultInteractiveLayoutConfiguration +## FilledMapVisual ### Properties -* **FreeForm**: [DefaultFreeFormLayoutConfiguration](#defaultfreeformlayoutconfiguration) -* **Grid**: [DefaultGridLayoutConfiguration](#defaultgridlayoutconfiguration) +* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **ChartConfiguration**: [FilledMapConfiguration](#filledmapconfiguration) +* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] +* **ConditionalFormatting**: [FilledMapConditionalFormatting](#filledmapconditionalformatting) +* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) +* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) +* **VisualId**: string (Required) -## DefaultFreeFormLayoutConfiguration +## Filter ### Properties -* **CanvasSizeOptions**: [FreeFormLayoutCanvasSizeOptions](#freeformlayoutcanvassizeoptions) (Required) +* **CategoryFilter**: [CategoryFilter](#categoryfilter) +* **NumericEqualityFilter**: [NumericEqualityFilter](#numericequalityfilter) +* **NumericRangeFilter**: [NumericRangeFilter](#numericrangefilter) +* **RelativeDatesFilter**: [RelativeDatesFilter](#relativedatesfilter) +* **TimeEqualityFilter**: [TimeEqualityFilter](#timeequalityfilter) +* **TimeRangeFilter**: [TimeRangeFilter](#timerangefilter) +* **TopBottomFilter**: [TopBottomFilter](#topbottomfilter) -## FreeFormLayoutCanvasSizeOptions +## Filter ### Properties -* **ScreenCanvasSizeOptions**: [FreeFormLayoutScreenCanvasSizeOptions](#freeformlayoutscreencanvassizeoptions) +* **CategoryFilter**: [CategoryFilter](#categoryfilter) +* **NumericEqualityFilter**: [NumericEqualityFilter](#numericequalityfilter) +* **NumericRangeFilter**: [NumericRangeFilter](#numericrangefilter) +* **RelativeDatesFilter**: [RelativeDatesFilter](#relativedatesfilter) +* **TimeEqualityFilter**: [TimeEqualityFilter](#timeequalityfilter) +* **TimeRangeFilter**: [TimeRangeFilter](#timerangefilter) +* **TopBottomFilter**: [TopBottomFilter](#topbottomfilter) -## FreeFormLayoutScreenCanvasSizeOptions +## Filter ### Properties -* **OptimizedViewPortWidth**: string (Required): String based length that is composed of value and unit in px +* **CategoryFilter**: [CategoryFilter](#categoryfilter) +* **NumericEqualityFilter**: [NumericEqualityFilter](#numericequalityfilter) +* **NumericRangeFilter**: [NumericRangeFilter](#numericrangefilter) +* **RelativeDatesFilter**: [RelativeDatesFilter](#relativedatesfilter) +* **TimeEqualityFilter**: [TimeEqualityFilter](#timeequalityfilter) +* **TimeRangeFilter**: [TimeRangeFilter](#timerangefilter) +* **TopBottomFilter**: [TopBottomFilter](#topbottomfilter) -## DefaultGridLayoutConfiguration +## FilterControl ### Properties -* **CanvasSizeOptions**: [GridLayoutCanvasSizeOptions](#gridlayoutcanvassizeoptions) (Required) +* **CrossSheet**: [FilterCrossSheetControl](#filtercrosssheetcontrol) +* **DateTimePicker**: [FilterDateTimePickerControl](#filterdatetimepickercontrol) +* **Dropdown**: [FilterDropDownControl](#filterdropdowncontrol) +* **List**: [FilterListControl](#filterlistcontrol) +* **RelativeDateTime**: [FilterRelativeDateTimeControl](#filterrelativedatetimecontrol) +* **Slider**: [FilterSliderControl](#filterslidercontrol) +* **TextArea**: [FilterTextAreaControl](#filtertextareacontrol) +* **TextField**: [FilterTextFieldControl](#filtertextfieldcontrol) -## GridLayoutCanvasSizeOptions +## FilterControl ### Properties -* **ScreenCanvasSizeOptions**: [GridLayoutScreenCanvasSizeOptions](#gridlayoutscreencanvassizeoptions) +* **CrossSheet**: [FilterCrossSheetControl](#filtercrosssheetcontrol) +* **DateTimePicker**: [FilterDateTimePickerControl](#filterdatetimepickercontrol) +* **Dropdown**: [FilterDropDownControl](#filterdropdowncontrol) +* **List**: [FilterListControl](#filterlistcontrol) +* **RelativeDateTime**: [FilterRelativeDateTimeControl](#filterrelativedatetimecontrol) +* **Slider**: [FilterSliderControl](#filterslidercontrol) +* **TextArea**: [FilterTextAreaControl](#filtertextareacontrol) +* **TextField**: [FilterTextFieldControl](#filtertextfieldcontrol) -## GridLayoutScreenCanvasSizeOptions +## FilterControl ### Properties -* **OptimizedViewPortWidth**: string: String based length that is composed of value and unit in px -* **ResizeOption**: string (Required) +* **CrossSheet**: [FilterCrossSheetControl](#filtercrosssheetcontrol) +* **DateTimePicker**: [FilterDateTimePickerControl](#filterdatetimepickercontrol) +* **Dropdown**: [FilterDropDownControl](#filterdropdowncontrol) +* **List**: [FilterListControl](#filterlistcontrol) +* **RelativeDateTime**: [FilterRelativeDateTimeControl](#filterrelativedatetimecontrol) +* **Slider**: [FilterSliderControl](#filterslidercontrol) +* **TextArea**: [FilterTextAreaControl](#filtertextareacontrol) +* **TextField**: [FilterTextFieldControl](#filtertextfieldcontrol) -## DefaultPaginatedLayoutConfiguration +## FilterCrossSheetControl ### Properties -* **SectionBased**: [DefaultSectionBasedLayoutConfiguration](#defaultsectionbasedlayoutconfiguration) +* **CascadingControlConfiguration**: [CascadingControlConfiguration](#cascadingcontrolconfiguration) +* **FilterControlId**: string (Required) +* **SourceFilterId**: string (Required) -## DefaultSectionBasedLayoutConfiguration +## FilterCrossSheetControl ### Properties -* **CanvasSizeOptions**: [SectionBasedLayoutCanvasSizeOptions](#sectionbasedlayoutcanvassizeoptions) (Required) +* **CascadingControlConfiguration**: [CascadingControlConfiguration](#cascadingcontrolconfiguration) +* **FilterControlId**: string (Required) +* **SourceFilterId**: string (Required) -## SectionBasedLayoutCanvasSizeOptions +## FilterCrossSheetControl ### Properties -* **PaperCanvasSizeOptions**: [SectionBasedLayoutPaperCanvasSizeOptions](#sectionbasedlayoutpapercanvassizeoptions) +* **CascadingControlConfiguration**: [CascadingControlConfiguration](#cascadingcontrolconfiguration) +* **FilterControlId**: string (Required) +* **SourceFilterId**: string (Required) -## SectionBasedLayoutPaperCanvasSizeOptions +## FilterDateTimePickerControl ### Properties -* **PaperMargin**: [Spacing](#spacing) -* **PaperOrientation**: string -* **PaperSize**: string +* **DisplayOptions**: [DateTimePickerControlDisplayOptions](#datetimepickercontroldisplayoptions) +* **FilterControlId**: string (Required) +* **SourceFilterId**: string (Required) +* **Title**: string (Required) +* **Type**: string -## Spacing +## FilterDateTimePickerControl ### Properties -* **Bottom**: string: String based length that is composed of value and unit -* **Left**: string: String based length that is composed of value and unit -* **Right**: string: String based length that is composed of value and unit -* **Top**: string: String based length that is composed of value and unit +* **DisplayOptions**: [DateTimePickerControlDisplayOptions](#datetimepickercontroldisplayoptions) +* **FilterControlId**: string (Required) +* **SourceFilterId**: string (Required) +* **Title**: string (Required) +* **Type**: string -## CalculatedField +## FilterDateTimePickerControl ### Properties -* **DataSetIdentifier**: string (Required) -* **Expression**: string (Required) -* **Name**: string (Required) +* **DisplayOptions**: [DateTimePickerControlDisplayOptions](#datetimepickercontroldisplayoptions) +* **FilterControlId**: string (Required) +* **SourceFilterId**: string (Required) +* **Title**: string (Required) +* **Type**: string -## ColumnConfiguration +## FilterDropDownControl ### Properties -* **ColorsConfiguration**: [ColorsConfiguration](#colorsconfiguration) -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **FormatConfiguration**: [FormatConfiguration](#formatconfiguration) -* **Role**: string +* **CascadingControlConfiguration**: [CascadingControlConfiguration](#cascadingcontrolconfiguration) +* **DisplayOptions**: [DropDownControlDisplayOptions](#dropdowncontroldisplayoptions) +* **FilterControlId**: string (Required) +* **SelectableValues**: [FilterSelectableValues](#filterselectablevalues) +* **SourceFilterId**: string (Required) +* **Title**: string (Required) +* **Type**: string -## ColorsConfiguration +## FilterDropDownControl ### Properties -* **CustomColors**: [CustomColor](#customcolor)[] +* **CascadingControlConfiguration**: [CascadingControlConfiguration](#cascadingcontrolconfiguration) +* **DisplayOptions**: [DropDownControlDisplayOptions](#dropdowncontroldisplayoptions) +* **FilterControlId**: string (Required) +* **SelectableValues**: [FilterSelectableValues](#filterselectablevalues) +* **SourceFilterId**: string (Required) +* **Title**: string (Required) +* **Type**: string -## CustomColor +## FilterDropDownControl ### Properties -* **Color**: string (Required) -* **FieldValue**: string -* **SpecialValue**: string +* **CascadingControlConfiguration**: [CascadingControlConfiguration](#cascadingcontrolconfiguration) +* **DisplayOptions**: [DropDownControlDisplayOptions](#dropdowncontroldisplayoptions) +* **FilterControlId**: string (Required) +* **SelectableValues**: [FilterSelectableValues](#filterselectablevalues) +* **SourceFilterId**: string (Required) +* **Title**: string (Required) +* **Type**: string -## ColumnIdentifier +## FilterGroup ### Properties -* **ColumnName**: string (Required) -* **DataSetIdentifier**: string (Required) +* **CrossDataset**: string (Required) +* **FilterGroupId**: string (Required) +* **Filters**: [Filter](#filter)[] (Required) +* **ScopeConfiguration**: [FilterScopeConfiguration](#filterscopeconfiguration) (Required) +* **Status**: string -## FormatConfiguration +## FilterGroup ### Properties -* **DateTimeFormatConfiguration**: [DateTimeFormatConfiguration](#datetimeformatconfiguration) -* **NumberFormatConfiguration**: [NumberFormatConfiguration](#numberformatconfiguration) -* **StringFormatConfiguration**: [StringFormatConfiguration](#stringformatconfiguration) +* **CrossDataset**: string (Required) +* **FilterGroupId**: string (Required) +* **Filters**: [Filter](#filter)[] (Required) +* **ScopeConfiguration**: [FilterScopeConfiguration](#filterscopeconfiguration) (Required) +* **Status**: string -## DateTimeFormatConfiguration +## FilterGroup ### Properties -* **DateTimeFormat**: string -* **NullValueFormatConfiguration**: [NullValueFormatConfiguration](#nullvalueformatconfiguration) -* **NumericFormatConfiguration**: [NumericFormatConfiguration](#numericformatconfiguration) +* **CrossDataset**: string (Required) +* **FilterGroupId**: string (Required) +* **Filters**: [Filter](#filter)[] (Required) +* **ScopeConfiguration**: [FilterScopeConfiguration](#filterscopeconfiguration) (Required) +* **Status**: string -## NullValueFormatConfiguration +## FilterListConfiguration ### Properties -* **NullString**: string (Required) +* **CategoryValues**: string[] +* **MatchOperator**: string (Required) +* **NullOption**: string +* **SelectAllOptions**: string -## NumericFormatConfiguration +## FilterListConfiguration ### Properties -* **CurrencyDisplayFormatConfiguration**: [CurrencyDisplayFormatConfiguration](#currencydisplayformatconfiguration) -* **NumberDisplayFormatConfiguration**: [NumberDisplayFormatConfiguration](#numberdisplayformatconfiguration) -* **PercentageDisplayFormatConfiguration**: [PercentageDisplayFormatConfiguration](#percentagedisplayformatconfiguration) +* **CategoryValues**: string[] +* **MatchOperator**: string (Required) +* **NullOption**: string +* **SelectAllOptions**: string -## CurrencyDisplayFormatConfiguration +## FilterListConfiguration ### Properties -* **DecimalPlacesConfiguration**: [DecimalPlacesConfiguration](#decimalplacesconfiguration) -* **NegativeValueConfiguration**: [NegativeValueConfiguration](#negativevalueconfiguration) -* **NullValueFormatConfiguration**: [NullValueFormatConfiguration](#nullvalueformatconfiguration) -* **NumberScale**: string -* **Prefix**: string -* **SeparatorConfiguration**: [NumericSeparatorConfiguration](#numericseparatorconfiguration) -* **Suffix**: string -* **Symbol**: string +* **CategoryValues**: string[] +* **MatchOperator**: string (Required) +* **NullOption**: string +* **SelectAllOptions**: string -## DecimalPlacesConfiguration +## FilterListControl ### Properties -* **DecimalPlaces**: int (Required) +* **CascadingControlConfiguration**: [CascadingControlConfiguration](#cascadingcontrolconfiguration) +* **DisplayOptions**: [ListControlDisplayOptions](#listcontroldisplayoptions) +* **FilterControlId**: string (Required) +* **SelectableValues**: [FilterSelectableValues](#filterselectablevalues) +* **SourceFilterId**: string (Required) +* **Title**: string (Required) +* **Type**: string -## NegativeValueConfiguration +## FilterListControl ### Properties -* **DisplayMode**: string (Required) +* **CascadingControlConfiguration**: [CascadingControlConfiguration](#cascadingcontrolconfiguration) +* **DisplayOptions**: [ListControlDisplayOptions](#listcontroldisplayoptions) +* **FilterControlId**: string (Required) +* **SelectableValues**: [FilterSelectableValues](#filterselectablevalues) +* **SourceFilterId**: string (Required) +* **Title**: string (Required) +* **Type**: string -## NumericSeparatorConfiguration +## FilterListControl ### Properties -* **DecimalSeparator**: string -* **ThousandsSeparator**: [ThousandSeparatorOptions](#thousandseparatoroptions) +* **CascadingControlConfiguration**: [CascadingControlConfiguration](#cascadingcontrolconfiguration) +* **DisplayOptions**: [ListControlDisplayOptions](#listcontroldisplayoptions) +* **FilterControlId**: string (Required) +* **SelectableValues**: [FilterSelectableValues](#filterselectablevalues) +* **SourceFilterId**: string (Required) +* **Title**: string (Required) +* **Type**: string -## ThousandSeparatorOptions +## FilterOperationSelectedFieldsConfiguration ### Properties -* **Symbol**: string -* **Visibility**: string +* **SelectedColumns**: [ColumnIdentifier](#columnidentifier)[]:

The selected columns of a dataset.

+* **SelectedFieldOptions**: string +* **SelectedFields**: string[] -## NumberDisplayFormatConfiguration +## FilterOperationSelectedFieldsConfiguration ### Properties -* **DecimalPlacesConfiguration**: [DecimalPlacesConfiguration](#decimalplacesconfiguration) -* **NegativeValueConfiguration**: [NegativeValueConfiguration](#negativevalueconfiguration) -* **NullValueFormatConfiguration**: [NullValueFormatConfiguration](#nullvalueformatconfiguration) -* **NumberScale**: string -* **Prefix**: string -* **SeparatorConfiguration**: [NumericSeparatorConfiguration](#numericseparatorconfiguration) -* **Suffix**: string +* **SelectedColumns**: [ColumnIdentifier](#columnidentifier)[]:

The selected columns of a dataset.

+* **SelectedFieldOptions**: string +* **SelectedFields**: string[] -## PercentageDisplayFormatConfiguration +## FilterOperationSelectedFieldsConfiguration ### Properties -* **DecimalPlacesConfiguration**: [DecimalPlacesConfiguration](#decimalplacesconfiguration) -* **NegativeValueConfiguration**: [NegativeValueConfiguration](#negativevalueconfiguration) -* **NullValueFormatConfiguration**: [NullValueFormatConfiguration](#nullvalueformatconfiguration) -* **Prefix**: string -* **SeparatorConfiguration**: [NumericSeparatorConfiguration](#numericseparatorconfiguration) -* **Suffix**: string +* **SelectedColumns**: [ColumnIdentifier](#columnidentifier)[]:

The selected columns of a dataset.

+* **SelectedFieldOptions**: string +* **SelectedFields**: string[] -## NumberFormatConfiguration +## FilterOperationTargetVisualsConfiguration ### Properties -* **FormatConfiguration**: [NumericFormatConfiguration](#numericformatconfiguration) +* **SameSheetTargetVisualConfiguration**: [SameSheetTargetVisualConfiguration](#samesheettargetvisualconfiguration) -## StringFormatConfiguration +## FilterOperationTargetVisualsConfiguration ### Properties -* **NullValueFormatConfiguration**: [NullValueFormatConfiguration](#nullvalueformatconfiguration) -* **NumericFormatConfiguration**: [NumericFormatConfiguration](#numericformatconfiguration) +* **SameSheetTargetVisualConfiguration**: [SameSheetTargetVisualConfiguration](#samesheettargetvisualconfiguration) -## DataSetIdentifierDeclaration +## FilterOperationTargetVisualsConfiguration ### Properties -* **DataSetArn**: string (Required) -* **Identifier**: string (Required) +* **SameSheetTargetVisualConfiguration**: [SameSheetTargetVisualConfiguration](#samesheettargetvisualconfiguration) -## FilterGroup +## FilterRelativeDateTimeControl ### Properties -* **CrossDataset**: string (Required) -* **FilterGroupId**: string (Required) -* **Filters**: [Filter](#filter)[] (Required) -* **ScopeConfiguration**: [FilterScopeConfiguration](#filterscopeconfiguration) (Required) -* **Status**: string +* **DisplayOptions**: [RelativeDateTimeControlDisplayOptions](#relativedatetimecontroldisplayoptions) +* **FilterControlId**: string (Required) +* **SourceFilterId**: string (Required) +* **Title**: string (Required) -## Filter +## FilterRelativeDateTimeControl ### Properties -* **CategoryFilter**: [CategoryFilter](#categoryfilter) -* **NumericEqualityFilter**: [NumericEqualityFilter](#numericequalityfilter) -* **NumericRangeFilter**: [NumericRangeFilter](#numericrangefilter) -* **RelativeDatesFilter**: [RelativeDatesFilter](#relativedatesfilter) -* **TimeEqualityFilter**: [TimeEqualityFilter](#timeequalityfilter) -* **TimeRangeFilter**: [TimeRangeFilter](#timerangefilter) -* **TopBottomFilter**: [TopBottomFilter](#topbottomfilter) +* **DisplayOptions**: [RelativeDateTimeControlDisplayOptions](#relativedatetimecontroldisplayoptions) +* **FilterControlId**: string (Required) +* **SourceFilterId**: string (Required) +* **Title**: string (Required) -## CategoryFilter +## FilterRelativeDateTimeControl ### Properties -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **Configuration**: [CategoryFilterConfiguration](#categoryfilterconfiguration) (Required) -* **FilterId**: string (Required) +* **DisplayOptions**: [RelativeDateTimeControlDisplayOptions](#relativedatetimecontroldisplayoptions) +* **FilterControlId**: string (Required) +* **SourceFilterId**: string (Required) +* **Title**: string (Required) -## CategoryFilterConfiguration +## FilterScopeConfiguration ### Properties -* **CustomFilterConfiguration**: [CustomFilterConfiguration](#customfilterconfiguration) -* **CustomFilterListConfiguration**: [CustomFilterListConfiguration](#customfilterlistconfiguration) -* **FilterListConfiguration**: [FilterListConfiguration](#filterlistconfiguration) +* **AllSheets**: [AllSheetsFilterScopeConfiguration](#allsheetsfilterscopeconfiguration) +* **SelectedSheets**: [SelectedSheetsFilterScopeConfiguration](#selectedsheetsfilterscopeconfiguration) -## CustomFilterConfiguration +## FilterScopeConfiguration ### Properties -* **CategoryValue**: string -* **MatchOperator**: string (Required) -* **NullOption**: string (Required) -* **ParameterName**: string -* **SelectAllOptions**: string +* **AllSheets**: [AllSheetsFilterScopeConfiguration](#allsheetsfilterscopeconfiguration) +* **SelectedSheets**: [SelectedSheetsFilterScopeConfiguration](#selectedsheetsfilterscopeconfiguration) -## CustomFilterListConfiguration +## FilterScopeConfiguration ### Properties -* **CategoryValues**: string[] -* **MatchOperator**: string (Required) -* **NullOption**: string (Required) -* **SelectAllOptions**: string +* **AllSheets**: [AllSheetsFilterScopeConfiguration](#allsheetsfilterscopeconfiguration) +* **SelectedSheets**: [SelectedSheetsFilterScopeConfiguration](#selectedsheetsfilterscopeconfiguration) -## FilterListConfiguration +## FilterSelectableValues ### Properties -* **CategoryValues**: string[] -* **MatchOperator**: string (Required) -* **NullOption**: string -* **SelectAllOptions**: string +* **Values**: string[] -## NumericEqualityFilter +## FilterSelectableValues ### Properties -* **AggregationFunction**: [AggregationFunction](#aggregationfunction) -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **FilterId**: string (Required) -* **MatchOperator**: string (Required) -* **NullOption**: string (Required) -* **ParameterName**: string -* **SelectAllOptions**: string -* **Value**: int +* **Values**: string[] -## AggregationFunction +## FilterSelectableValues ### Properties -* **AttributeAggregationFunction**: [AttributeAggregationFunction](#attributeaggregationfunction) -* **CategoricalAggregationFunction**: string -* **DateAggregationFunction**: string -* **NumericalAggregationFunction**: [NumericalAggregationFunction](#numericalaggregationfunction) +* **Values**: string[] -## AttributeAggregationFunction +## FilterSliderControl ### Properties -* **SimpleAttributeAggregation**: string -* **ValueForMultipleValues**: string +* **DisplayOptions**: [SliderControlDisplayOptions](#slidercontroldisplayoptions) +* **FilterControlId**: string (Required) +* **MaximumValue**: int (Required) +* **MinimumValue**: int (Required) +* **SourceFilterId**: string (Required) +* **StepSize**: int (Required) +* **Title**: string (Required) +* **Type**: string -## NumericalAggregationFunction +## FilterSliderControl ### Properties -* **PercentileAggregation**: [PercentileAggregation](#percentileaggregation) -* **SimpleNumericalAggregation**: string +* **DisplayOptions**: [SliderControlDisplayOptions](#slidercontroldisplayoptions) +* **FilterControlId**: string (Required) +* **MaximumValue**: int (Required) +* **MinimumValue**: int (Required) +* **SourceFilterId**: string (Required) +* **StepSize**: int (Required) +* **Title**: string (Required) +* **Type**: string -## PercentileAggregation +## FilterSliderControl ### Properties -* **PercentileValue**: int +* **DisplayOptions**: [SliderControlDisplayOptions](#slidercontroldisplayoptions) +* **FilterControlId**: string (Required) +* **MaximumValue**: int (Required) +* **MinimumValue**: int (Required) +* **SourceFilterId**: string (Required) +* **StepSize**: int (Required) +* **Title**: string (Required) +* **Type**: string -## NumericRangeFilter +## FilterTextAreaControl ### Properties -* **AggregationFunction**: [AggregationFunction](#aggregationfunction) -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **FilterId**: string (Required) -* **IncludeMaximum**: bool -* **IncludeMinimum**: bool -* **NullOption**: string (Required) -* **RangeMaximum**: [NumericRangeFilterValue](#numericrangefiltervalue) -* **RangeMinimum**: [NumericRangeFilterValue](#numericrangefiltervalue) -* **SelectAllOptions**: string +* **Delimiter**: string +* **DisplayOptions**: [TextAreaControlDisplayOptions](#textareacontroldisplayoptions) +* **FilterControlId**: string (Required) +* **SourceFilterId**: string (Required) +* **Title**: string (Required) -## NumericRangeFilterValue +## FilterTextAreaControl ### Properties -* **Parameter**: string -* **StaticValue**: int +* **Delimiter**: string +* **DisplayOptions**: [TextAreaControlDisplayOptions](#textareacontroldisplayoptions) +* **FilterControlId**: string (Required) +* **SourceFilterId**: string (Required) +* **Title**: string (Required) -## RelativeDatesFilter +## FilterTextAreaControl ### Properties -* **AnchorDateConfiguration**: [AnchorDateConfiguration](#anchordateconfiguration) (Required) -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **ExcludePeriodConfiguration**: [ExcludePeriodConfiguration](#excludeperiodconfiguration) -* **FilterId**: string (Required) -* **MinimumGranularity**: string -* **NullOption**: string (Required) -* **ParameterName**: string -* **RelativeDateType**: string (Required) -* **RelativeDateValue**: int -* **TimeGranularity**: string (Required) +* **Delimiter**: string +* **DisplayOptions**: [TextAreaControlDisplayOptions](#textareacontroldisplayoptions) +* **FilterControlId**: string (Required) +* **SourceFilterId**: string (Required) +* **Title**: string (Required) -## AnchorDateConfiguration +## FilterTextFieldControl ### Properties -* **AnchorOption**: string -* **ParameterName**: string +* **DisplayOptions**: [TextFieldControlDisplayOptions](#textfieldcontroldisplayoptions) +* **FilterControlId**: string (Required) +* **SourceFilterId**: string (Required) +* **Title**: string (Required) -## ExcludePeriodConfiguration +## FilterTextFieldControl ### Properties -* **Amount**: int (Required) -* **Granularity**: string (Required) -* **Status**: string +* **DisplayOptions**: [TextFieldControlDisplayOptions](#textfieldcontroldisplayoptions) +* **FilterControlId**: string (Required) +* **SourceFilterId**: string (Required) +* **Title**: string (Required) -## TimeEqualityFilter +## FilterTextFieldControl ### Properties -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **FilterId**: string (Required) -* **ParameterName**: string -* **RollingDate**: [RollingDateConfiguration](#rollingdateconfiguration) -* **TimeGranularity**: string -* **Value**: string +* **DisplayOptions**: [TextFieldControlDisplayOptions](#textfieldcontroldisplayoptions) +* **FilterControlId**: string (Required) +* **SourceFilterId**: string (Required) +* **Title**: string (Required) -## RollingDateConfiguration +## Font ### Properties -* **DataSetIdentifier**: string -* **Expression**: string (Required) +* **FontFamily**: string -## TimeRangeFilter +## FontConfiguration ### Properties -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **ExcludePeriodConfiguration**: [ExcludePeriodConfiguration](#excludeperiodconfiguration) -* **FilterId**: string (Required) -* **IncludeMaximum**: bool -* **IncludeMinimum**: bool -* **NullOption**: string (Required) -* **RangeMaximumValue**: [TimeRangeFilterValue](#timerangefiltervalue) -* **RangeMinimumValue**: [TimeRangeFilterValue](#timerangefiltervalue) -* **TimeGranularity**: string +* **FontColor**: string +* **FontDecoration**: string +* **FontSize**: [FontSize](#fontsize) +* **FontStyle**: string +* **FontWeight**: [FontWeight](#fontweight) -## TimeRangeFilterValue +## FontConfiguration ### Properties -* **Parameter**: string -* **RollingDate**: [RollingDateConfiguration](#rollingdateconfiguration) -* **StaticValue**: string +* **FontColor**: string +* **FontDecoration**: string +* **FontSize**: [FontSize](#fontsize) +* **FontStyle**: string +* **FontWeight**: [FontWeight](#fontweight) -## TopBottomFilter +## FontConfiguration ### Properties -* **AggregationSortConfigurations**: [AggregationSortConfiguration](#aggregationsortconfiguration)[] (Required) -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **FilterId**: string (Required) -* **Limit**: int -* **ParameterName**: string -* **TimeGranularity**: string +* **FontColor**: string +* **FontDecoration**: string +* **FontSize**: [FontSize](#fontsize) +* **FontStyle**: string +* **FontWeight**: [FontWeight](#fontweight) -## AggregationSortConfiguration +## FontSize ### Properties -* **AggregationFunction**: [AggregationFunction](#aggregationfunction) -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **SortDirection**: string (Required) +* **Relative**: string -## FilterScopeConfiguration +## FontSize ### Properties -* **AllSheets**: [AllSheetsFilterScopeConfiguration](#allsheetsfilterscopeconfiguration) -* **SelectedSheets**: [SelectedSheetsFilterScopeConfiguration](#selectedsheetsfilterscopeconfiguration) +* **Relative**: string -## AllSheetsFilterScopeConfiguration +## FontSize ### Properties +* **Relative**: string -## SelectedSheetsFilterScopeConfiguration +## FontWeight ### Properties -* **SheetVisualScopingConfigurations**: [SheetVisualScopingConfiguration](#sheetvisualscopingconfiguration)[] +* **Name**: string -## SheetVisualScopingConfiguration +## FontWeight ### Properties -* **Scope**: string (Required) -* **SheetId**: string (Required) -* **VisualIds**: string[] +* **Name**: string -## AssetOptions +## FontWeight ### Properties -* **Timezone**: string -* **WeekStart**: string +* **Name**: string -## ParameterDeclaration +## ForecastComputation ### Properties -* **DateTimeParameterDeclaration**: [DateTimeParameterDeclaration](#datetimeparameterdeclaration) -* **DecimalParameterDeclaration**: [DecimalParameterDeclaration](#decimalparameterdeclaration) -* **IntegerParameterDeclaration**: [IntegerParameterDeclaration](#integerparameterdeclaration) -* **StringParameterDeclaration**: [StringParameterDeclaration](#stringparameterdeclaration) +* **ComputationId**: string (Required) +* **CustomSeasonalityValue**: int +* **LowerBoundary**: int +* **Name**: string +* **PeriodsBackward**: int +* **PeriodsForward**: int +* **PredictionInterval**: int +* **Seasonality**: string +* **Time**: [DimensionField](#dimensionfield) +* **UpperBoundary**: int +* **Value**: [MeasureField](#measurefield) -## DateTimeParameterDeclaration +## ForecastComputation ### Properties -* **DefaultValues**: [DateTimeDefaultValues](#datetimedefaultvalues) -* **MappedDataSetParameters**: [MappedDataSetParameter](#mappeddatasetparameter)[] -* **Name**: string (Required) -* **TimeGranularity**: string -* **ValueWhenUnset**: [DateTimeValueWhenUnsetConfiguration](#datetimevaluewhenunsetconfiguration) +* **ComputationId**: string (Required) +* **CustomSeasonalityValue**: int +* **LowerBoundary**: int +* **Name**: string +* **PeriodsBackward**: int +* **PeriodsForward**: int +* **PredictionInterval**: int +* **Seasonality**: string +* **Time**: [DimensionField](#dimensionfield) +* **UpperBoundary**: int +* **Value**: [MeasureField](#measurefield) -## DateTimeDefaultValues +## ForecastComputation ### Properties -* **DynamicValue**: [DynamicDefaultValue](#dynamicdefaultvalue) -* **RollingDate**: [RollingDateConfiguration](#rollingdateconfiguration) -* **StaticValues**: string[] +* **ComputationId**: string (Required) +* **CustomSeasonalityValue**: int +* **LowerBoundary**: int +* **Name**: string +* **PeriodsBackward**: int +* **PeriodsForward**: int +* **PredictionInterval**: int +* **Seasonality**: string +* **Time**: [DimensionField](#dimensionfield) +* **UpperBoundary**: int +* **Value**: [MeasureField](#measurefield) -## DynamicDefaultValue +## ForecastConfiguration ### Properties -* **DefaultValueColumn**: [ColumnIdentifier](#columnidentifier) (Required) -* **GroupNameColumn**: [ColumnIdentifier](#columnidentifier) -* **UserNameColumn**: [ColumnIdentifier](#columnidentifier) +* **ForecastProperties**: [TimeBasedForecastProperties](#timebasedforecastproperties) +* **Scenario**: [ForecastScenario](#forecastscenario) -## MappedDataSetParameter +## ForecastConfiguration ### Properties -* **DataSetIdentifier**: string (Required) -* **DataSetParameterName**: string (Required) +* **ForecastProperties**: [TimeBasedForecastProperties](#timebasedforecastproperties) +* **Scenario**: [ForecastScenario](#forecastscenario) -## DateTimeValueWhenUnsetConfiguration +## ForecastConfiguration ### Properties -* **CustomValue**: string -* **ValueWhenUnsetOption**: string +* **ForecastProperties**: [TimeBasedForecastProperties](#timebasedforecastproperties) +* **Scenario**: [ForecastScenario](#forecastscenario) -## DecimalParameterDeclaration +## ForecastScenario ### Properties -* **DefaultValues**: [DecimalDefaultValues](#decimaldefaultvalues) -* **MappedDataSetParameters**: [MappedDataSetParameter](#mappeddatasetparameter)[] -* **Name**: string (Required) -* **ParameterValueType**: string (Required) -* **ValueWhenUnset**: [DecimalValueWhenUnsetConfiguration](#decimalvaluewhenunsetconfiguration) +* **WhatIfPointScenario**: [WhatIfPointScenario](#whatifpointscenario) +* **WhatIfRangeScenario**: [WhatIfRangeScenario](#whatifrangescenario) -## DecimalDefaultValues -### Properties -* **DynamicValue**: [DynamicDefaultValue](#dynamicdefaultvalue) -* **StaticValues**: int[] +## ForecastScenario +### Properties +* **WhatIfPointScenario**: [WhatIfPointScenario](#whatifpointscenario) +* **WhatIfRangeScenario**: [WhatIfRangeScenario](#whatifrangescenario) -## DecimalValueWhenUnsetConfiguration +## ForecastScenario ### Properties -* **CustomValue**: int -* **ValueWhenUnsetOption**: string +* **WhatIfPointScenario**: [WhatIfPointScenario](#whatifpointscenario) +* **WhatIfRangeScenario**: [WhatIfRangeScenario](#whatifrangescenario) -## IntegerParameterDeclaration +## FormatConfiguration ### Properties -* **DefaultValues**: [IntegerDefaultValues](#integerdefaultvalues) -* **MappedDataSetParameters**: [MappedDataSetParameter](#mappeddatasetparameter)[] -* **Name**: string (Required) -* **ParameterValueType**: string (Required) -* **ValueWhenUnset**: [IntegerValueWhenUnsetConfiguration](#integervaluewhenunsetconfiguration) +* **DateTimeFormatConfiguration**: [DateTimeFormatConfiguration](#datetimeformatconfiguration) +* **NumberFormatConfiguration**: [NumberFormatConfiguration](#numberformatconfiguration) +* **StringFormatConfiguration**: [StringFormatConfiguration](#stringformatconfiguration) -## IntegerDefaultValues +## FormatConfiguration ### Properties -* **DynamicValue**: [DynamicDefaultValue](#dynamicdefaultvalue) -* **StaticValues**: int[] +* **DateTimeFormatConfiguration**: [DateTimeFormatConfiguration](#datetimeformatconfiguration) +* **NumberFormatConfiguration**: [NumberFormatConfiguration](#numberformatconfiguration) +* **StringFormatConfiguration**: [StringFormatConfiguration](#stringformatconfiguration) -## IntegerValueWhenUnsetConfiguration +## FormatConfiguration ### Properties -* **CustomValue**: int -* **ValueWhenUnsetOption**: string +* **DateTimeFormatConfiguration**: [DateTimeFormatConfiguration](#datetimeformatconfiguration) +* **NumberFormatConfiguration**: [NumberFormatConfiguration](#numberformatconfiguration) +* **StringFormatConfiguration**: [StringFormatConfiguration](#stringformatconfiguration) -## StringParameterDeclaration +## FreeFormLayoutCanvasSizeOptions ### Properties -* **DefaultValues**: [StringDefaultValues](#stringdefaultvalues) -* **MappedDataSetParameters**: [MappedDataSetParameter](#mappeddatasetparameter)[] -* **Name**: string (Required) -* **ParameterValueType**: string (Required) -* **ValueWhenUnset**: [StringValueWhenUnsetConfiguration](#stringvaluewhenunsetconfiguration) +* **ScreenCanvasSizeOptions**: [FreeFormLayoutScreenCanvasSizeOptions](#freeformlayoutscreencanvassizeoptions) -## StringDefaultValues +## FreeFormLayoutCanvasSizeOptions ### Properties -* **DynamicValue**: [DynamicDefaultValue](#dynamicdefaultvalue) -* **StaticValues**: string[] +* **ScreenCanvasSizeOptions**: [FreeFormLayoutScreenCanvasSizeOptions](#freeformlayoutscreencanvassizeoptions) -## StringValueWhenUnsetConfiguration +## FreeFormLayoutCanvasSizeOptions ### Properties -* **CustomValue**: string -* **ValueWhenUnsetOption**: string +* **ScreenCanvasSizeOptions**: [FreeFormLayoutScreenCanvasSizeOptions](#freeformlayoutscreencanvassizeoptions) -## SheetDefinition +## FreeFormLayoutConfiguration ### Properties -* **ContentType**: string -* **Description**: string -* **FilterControls**: [FilterControl](#filtercontrol)[] -* **Layouts**: [Layout](#layout)[] -* **Name**: string -* **ParameterControls**: [ParameterControl](#parametercontrol)[] -* **SheetControlLayouts**: [SheetControlLayout](#sheetcontrollayout)[] -* **SheetId**: string (Required) -* **TextBoxes**: [SheetTextBox](#sheettextbox)[] -* **Title**: string -* **Visuals**: [Visual](#visual)[] +* **CanvasSizeOptions**: [FreeFormLayoutCanvasSizeOptions](#freeformlayoutcanvassizeoptions) +* **Elements**: [FreeFormLayoutElement](#freeformlayoutelement)[] (Required) -## FilterControl +## FreeFormLayoutConfiguration ### Properties -* **DateTimePicker**: [FilterDateTimePickerControl](#filterdatetimepickercontrol) -* **Dropdown**: [FilterDropDownControl](#filterdropdowncontrol) -* **List**: [FilterListControl](#filterlistcontrol) -* **RelativeDateTime**: [FilterRelativeDateTimeControl](#filterrelativedatetimecontrol) -* **Slider**: [FilterSliderControl](#filterslidercontrol) -* **TextArea**: [FilterTextAreaControl](#filtertextareacontrol) -* **TextField**: [FilterTextFieldControl](#filtertextfieldcontrol) +* **CanvasSizeOptions**: [FreeFormLayoutCanvasSizeOptions](#freeformlayoutcanvassizeoptions) +* **Elements**: [FreeFormLayoutElement](#freeformlayoutelement)[] (Required) -## FilterDateTimePickerControl +## FreeFormLayoutConfiguration ### Properties -* **DisplayOptions**: [DateTimePickerControlDisplayOptions](#datetimepickercontroldisplayoptions) -* **FilterControlId**: string (Required) -* **SourceFilterId**: string (Required) -* **Title**: string (Required) -* **Type**: string +* **CanvasSizeOptions**: [FreeFormLayoutCanvasSizeOptions](#freeformlayoutcanvassizeoptions) +* **Elements**: [FreeFormLayoutElement](#freeformlayoutelement)[] (Required) -## DateTimePickerControlDisplayOptions +## FreeFormLayoutElement ### Properties -* **DateTimeFormat**: string -* **InfoIconLabelOptions**: [SheetControlInfoIconLabelOptions](#sheetcontrolinfoiconlabeloptions) -* **TitleOptions**: [LabelOptions](#labeloptions) +* **BackgroundStyle**: [FreeFormLayoutElementBackgroundStyle](#freeformlayoutelementbackgroundstyle) +* **BorderStyle**: [FreeFormLayoutElementBorderStyle](#freeformlayoutelementborderstyle) +* **ElementId**: string (Required) +* **ElementType**: string (Required) +* **Height**: string (Required): String based length that is composed of value and unit in px +* **LoadingAnimation**: [LoadingAnimation](#loadinganimation) +* **RenderingRules**: [SheetElementRenderingRule](#sheetelementrenderingrule)[] +* **SelectedBorderStyle**: [FreeFormLayoutElementBorderStyle](#freeformlayoutelementborderstyle) +* **Visibility**: string +* **Width**: string (Required): String based length that is composed of value and unit in px +* **XAxisLocation**: string (Required): String based length that is composed of value and unit in px +* **YAxisLocation**: string (Required): String based length that is composed of value and unit in px with Integer.MAX_VALUE as maximum value -## SheetControlInfoIconLabelOptions +## FreeFormLayoutElement ### Properties -* **InfoIconText**: string +* **BackgroundStyle**: [FreeFormLayoutElementBackgroundStyle](#freeformlayoutelementbackgroundstyle) +* **BorderStyle**: [FreeFormLayoutElementBorderStyle](#freeformlayoutelementborderstyle) +* **ElementId**: string (Required) +* **ElementType**: string (Required) +* **Height**: string (Required): String based length that is composed of value and unit in px +* **LoadingAnimation**: [LoadingAnimation](#loadinganimation) +* **RenderingRules**: [SheetElementRenderingRule](#sheetelementrenderingrule)[] +* **SelectedBorderStyle**: [FreeFormLayoutElementBorderStyle](#freeformlayoutelementborderstyle) * **Visibility**: string +* **Width**: string (Required): String based length that is composed of value and unit in px +* **XAxisLocation**: string (Required): String based length that is composed of value and unit in px +* **YAxisLocation**: string (Required): String based length that is composed of value and unit in px with Integer.MAX_VALUE as maximum value -## LabelOptions +## FreeFormLayoutElement ### Properties -* **CustomLabel**: string -* **FontConfiguration**: [FontConfiguration](#fontconfiguration) +* **BackgroundStyle**: [FreeFormLayoutElementBackgroundStyle](#freeformlayoutelementbackgroundstyle) +* **BorderStyle**: [FreeFormLayoutElementBorderStyle](#freeformlayoutelementborderstyle) +* **ElementId**: string (Required) +* **ElementType**: string (Required) +* **Height**: string (Required): String based length that is composed of value and unit in px +* **LoadingAnimation**: [LoadingAnimation](#loadinganimation) +* **RenderingRules**: [SheetElementRenderingRule](#sheetelementrenderingrule)[] +* **SelectedBorderStyle**: [FreeFormLayoutElementBorderStyle](#freeformlayoutelementborderstyle) * **Visibility**: string +* **Width**: string (Required): String based length that is composed of value and unit in px +* **XAxisLocation**: string (Required): String based length that is composed of value and unit in px +* **YAxisLocation**: string (Required): String based length that is composed of value and unit in px with Integer.MAX_VALUE as maximum value -## FontConfiguration +## FreeFormLayoutElementBackgroundStyle ### Properties -* **FontColor**: string -* **FontDecoration**: string -* **FontSize**: [FontSize](#fontsize) -* **FontStyle**: string -* **FontWeight**: [FontWeight](#fontweight) +* **Color**: string +* **Visibility**: string -## FontSize +## FreeFormLayoutElementBackgroundStyle ### Properties -* **Relative**: string +* **Color**: string +* **Visibility**: string -## FontWeight +## FreeFormLayoutElementBackgroundStyle ### Properties -* **Name**: string +* **Color**: string +* **Visibility**: string -## FilterDropDownControl +## FreeFormLayoutElementBorderStyle ### Properties -* **CascadingControlConfiguration**: [CascadingControlConfiguration](#cascadingcontrolconfiguration) -* **DisplayOptions**: [DropDownControlDisplayOptions](#dropdowncontroldisplayoptions) -* **FilterControlId**: string (Required) -* **SelectableValues**: [FilterSelectableValues](#filterselectablevalues) -* **SourceFilterId**: string (Required) -* **Title**: string (Required) -* **Type**: string +* **Color**: string +* **Visibility**: string -## CascadingControlConfiguration +## FreeFormLayoutElementBorderStyle ### Properties -* **SourceControls**: [CascadingControlSource](#cascadingcontrolsource)[] +* **Color**: string +* **Visibility**: string -## CascadingControlSource +## FreeFormLayoutElementBorderStyle ### Properties -* **ColumnToMatch**: [ColumnIdentifier](#columnidentifier) -* **SourceSheetControlId**: string +* **Color**: string +* **Visibility**: string -## DropDownControlDisplayOptions +## FreeFormLayoutScreenCanvasSizeOptions ### Properties -* **InfoIconLabelOptions**: [SheetControlInfoIconLabelOptions](#sheetcontrolinfoiconlabeloptions) -* **SelectAllOptions**: [ListControlSelectAllOptions](#listcontrolselectalloptions) -* **TitleOptions**: [LabelOptions](#labeloptions) +* **OptimizedViewPortWidth**: string (Required): String based length that is composed of value and unit in px -## ListControlSelectAllOptions +## FreeFormLayoutScreenCanvasSizeOptions ### Properties -* **Visibility**: string +* **OptimizedViewPortWidth**: string (Required): String based length that is composed of value and unit in px -## FilterSelectableValues +## FreeFormLayoutScreenCanvasSizeOptions ### Properties -* **Values**: string[] +* **OptimizedViewPortWidth**: string (Required): String based length that is composed of value and unit in px -## FilterListControl +## FreeFormSectionLayoutConfiguration ### Properties -* **CascadingControlConfiguration**: [CascadingControlConfiguration](#cascadingcontrolconfiguration) -* **DisplayOptions**: [ListControlDisplayOptions](#listcontroldisplayoptions) -* **FilterControlId**: string (Required) -* **SelectableValues**: [FilterSelectableValues](#filterselectablevalues) -* **SourceFilterId**: string (Required) -* **Title**: string (Required) -* **Type**: string +* **Elements**: [FreeFormLayoutElement](#freeformlayoutelement)[] (Required) -## ListControlDisplayOptions +## FreeFormSectionLayoutConfiguration ### Properties -* **InfoIconLabelOptions**: [SheetControlInfoIconLabelOptions](#sheetcontrolinfoiconlabeloptions) -* **SearchOptions**: [ListControlSearchOptions](#listcontrolsearchoptions) -* **SelectAllOptions**: [ListControlSelectAllOptions](#listcontrolselectalloptions) -* **TitleOptions**: [LabelOptions](#labeloptions) +* **Elements**: [FreeFormLayoutElement](#freeformlayoutelement)[] (Required) -## ListControlSearchOptions +## FreeFormSectionLayoutConfiguration ### Properties -* **Visibility**: string +* **Elements**: [FreeFormLayoutElement](#freeformlayoutelement)[] (Required) -## FilterRelativeDateTimeControl +## FunnelChartAggregatedFieldWells ### Properties -* **DisplayOptions**: [RelativeDateTimeControlDisplayOptions](#relativedatetimecontroldisplayoptions) -* **FilterControlId**: string (Required) -* **SourceFilterId**: string (Required) -* **Title**: string (Required) +* **Category**: [DimensionField](#dimensionfield)[] +* **Values**: [MeasureField](#measurefield)[] -## RelativeDateTimeControlDisplayOptions +## FunnelChartAggregatedFieldWells ### Properties -* **DateTimeFormat**: string -* **InfoIconLabelOptions**: [SheetControlInfoIconLabelOptions](#sheetcontrolinfoiconlabeloptions) -* **TitleOptions**: [LabelOptions](#labeloptions) +* **Category**: [DimensionField](#dimensionfield)[] +* **Values**: [MeasureField](#measurefield)[] -## FilterSliderControl +## FunnelChartAggregatedFieldWells ### Properties -* **DisplayOptions**: [SliderControlDisplayOptions](#slidercontroldisplayoptions) -* **FilterControlId**: string (Required) -* **MaximumValue**: int (Required) -* **MinimumValue**: int (Required) -* **SourceFilterId**: string (Required) -* **StepSize**: int (Required) -* **Title**: string (Required) -* **Type**: string +* **Category**: [DimensionField](#dimensionfield)[] +* **Values**: [MeasureField](#measurefield)[] -## SliderControlDisplayOptions +## FunnelChartConfiguration ### Properties -* **InfoIconLabelOptions**: [SheetControlInfoIconLabelOptions](#sheetcontrolinfoiconlabeloptions) -* **TitleOptions**: [LabelOptions](#labeloptions) +* **CategoryLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **DataLabelOptions**: [FunnelChartDataLabelOptions](#funnelchartdatalabeloptions) +* **FieldWells**: [FunnelChartFieldWells](#funnelchartfieldwells) +* **SortConfiguration**: [FunnelChartSortConfiguration](#funnelchartsortconfiguration) +* **Tooltip**: [TooltipOptions](#tooltipoptions) +* **ValueLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **VisualPalette**: [VisualPalette](#visualpalette) -## FilterTextAreaControl +## FunnelChartConfiguration ### Properties -* **Delimiter**: string -* **DisplayOptions**: [TextAreaControlDisplayOptions](#textareacontroldisplayoptions) -* **FilterControlId**: string (Required) -* **SourceFilterId**: string (Required) -* **Title**: string (Required) +* **CategoryLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **DataLabelOptions**: [FunnelChartDataLabelOptions](#funnelchartdatalabeloptions) +* **FieldWells**: [FunnelChartFieldWells](#funnelchartfieldwells) +* **SortConfiguration**: [FunnelChartSortConfiguration](#funnelchartsortconfiguration) +* **Tooltip**: [TooltipOptions](#tooltipoptions) +* **ValueLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **VisualPalette**: [VisualPalette](#visualpalette) -## TextAreaControlDisplayOptions +## FunnelChartConfiguration ### Properties -* **InfoIconLabelOptions**: [SheetControlInfoIconLabelOptions](#sheetcontrolinfoiconlabeloptions) -* **PlaceholderOptions**: [TextControlPlaceholderOptions](#textcontrolplaceholderoptions) -* **TitleOptions**: [LabelOptions](#labeloptions) +* **CategoryLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **DataLabelOptions**: [FunnelChartDataLabelOptions](#funnelchartdatalabeloptions) +* **FieldWells**: [FunnelChartFieldWells](#funnelchartfieldwells) +* **SortConfiguration**: [FunnelChartSortConfiguration](#funnelchartsortconfiguration) +* **Tooltip**: [TooltipOptions](#tooltipoptions) +* **ValueLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **VisualPalette**: [VisualPalette](#visualpalette) -## TextControlPlaceholderOptions +## FunnelChartDataLabelOptions ### Properties +* **CategoryLabelVisibility**: string +* **LabelColor**: string +* **LabelFontConfiguration**: [FontConfiguration](#fontconfiguration) +* **MeasureDataLabelStyle**: string +* **MeasureLabelVisibility**: string +* **Position**: string * **Visibility**: string -## FilterTextFieldControl +## FunnelChartDataLabelOptions ### Properties -* **DisplayOptions**: [TextFieldControlDisplayOptions](#textfieldcontroldisplayoptions) -* **FilterControlId**: string (Required) -* **SourceFilterId**: string (Required) -* **Title**: string (Required) +* **CategoryLabelVisibility**: string +* **LabelColor**: string +* **LabelFontConfiguration**: [FontConfiguration](#fontconfiguration) +* **MeasureDataLabelStyle**: string +* **MeasureLabelVisibility**: string +* **Position**: string +* **Visibility**: string -## TextFieldControlDisplayOptions +## FunnelChartDataLabelOptions ### Properties -* **InfoIconLabelOptions**: [SheetControlInfoIconLabelOptions](#sheetcontrolinfoiconlabeloptions) -* **PlaceholderOptions**: [TextControlPlaceholderOptions](#textcontrolplaceholderoptions) -* **TitleOptions**: [LabelOptions](#labeloptions) +* **CategoryLabelVisibility**: string +* **LabelColor**: string +* **LabelFontConfiguration**: [FontConfiguration](#fontconfiguration) +* **MeasureDataLabelStyle**: string +* **MeasureLabelVisibility**: string +* **Position**: string +* **Visibility**: string -## Layout +## FunnelChartFieldWells ### Properties -* **Configuration**: [LayoutConfiguration](#layoutconfiguration) (Required) +* **FunnelChartAggregatedFieldWells**: [FunnelChartAggregatedFieldWells](#funnelchartaggregatedfieldwells) -## LayoutConfiguration +## FunnelChartFieldWells ### Properties -* **FreeFormLayout**: [FreeFormLayoutConfiguration](#freeformlayoutconfiguration) -* **GridLayout**: [GridLayoutConfiguration](#gridlayoutconfiguration) -* **SectionBasedLayout**: [SectionBasedLayoutConfiguration](#sectionbasedlayoutconfiguration) +* **FunnelChartAggregatedFieldWells**: [FunnelChartAggregatedFieldWells](#funnelchartaggregatedfieldwells) -## FreeFormLayoutConfiguration +## FunnelChartFieldWells ### Properties -* **CanvasSizeOptions**: [FreeFormLayoutCanvasSizeOptions](#freeformlayoutcanvassizeoptions) -* **Elements**: [FreeFormLayoutElement](#freeformlayoutelement)[] (Required) +* **FunnelChartAggregatedFieldWells**: [FunnelChartAggregatedFieldWells](#funnelchartaggregatedfieldwells) -## FreeFormLayoutElement +## FunnelChartSortConfiguration ### Properties -* **BackgroundStyle**: [FreeFormLayoutElementBackgroundStyle](#freeformlayoutelementbackgroundstyle) -* **BorderStyle**: [FreeFormLayoutElementBorderStyle](#freeformlayoutelementborderstyle) -* **ElementId**: string (Required) -* **ElementType**: string (Required) -* **Height**: string (Required): String based length that is composed of value and unit in px -* **LoadingAnimation**: [LoadingAnimation](#loadinganimation) -* **RenderingRules**: [SheetElementRenderingRule](#sheetelementrenderingrule)[] -* **SelectedBorderStyle**: [FreeFormLayoutElementBorderStyle](#freeformlayoutelementborderstyle) -* **Visibility**: string -* **Width**: string (Required): String based length that is composed of value and unit in px -* **XAxisLocation**: string (Required): String based length that is composed of value and unit in px -* **YAxisLocation**: string (Required): String based length that is composed of value and unit in px with Integer.MAX_VALUE as maximum value +* **CategoryItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) +* **CategorySort**: [FieldSortOptions](#fieldsortoptions)[] -## FreeFormLayoutElementBackgroundStyle +## FunnelChartSortConfiguration ### Properties -* **Color**: string -* **Visibility**: string +* **CategoryItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) +* **CategorySort**: [FieldSortOptions](#fieldsortoptions)[] -## FreeFormLayoutElementBorderStyle +## FunnelChartSortConfiguration ### Properties -* **Color**: string -* **Visibility**: string +* **CategoryItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) +* **CategorySort**: [FieldSortOptions](#fieldsortoptions)[] -## LoadingAnimation +## FunnelChartVisual ### Properties -* **Visibility**: string +* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **ChartConfiguration**: [FunnelChartConfiguration](#funnelchartconfiguration) +* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] +* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) +* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) +* **VisualId**: string (Required) -## SheetElementRenderingRule +## FunnelChartVisual ### Properties -* **ConfigurationOverrides**: [SheetElementConfigurationOverrides](#sheetelementconfigurationoverrides) (Required) -* **Expression**: string (Required) +* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **ChartConfiguration**: [FunnelChartConfiguration](#funnelchartconfiguration) +* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] +* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) +* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) +* **VisualId**: string (Required) -## SheetElementConfigurationOverrides +## FunnelChartVisual ### Properties -* **Visibility**: string +* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **ChartConfiguration**: [FunnelChartConfiguration](#funnelchartconfiguration) +* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] +* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) +* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) +* **VisualId**: string (Required) -## GridLayoutConfiguration +## GaugeChartArcConditionalFormatting ### Properties -* **CanvasSizeOptions**: [GridLayoutCanvasSizeOptions](#gridlayoutcanvassizeoptions) -* **Elements**: [GridLayoutElement](#gridlayoutelement)[] (Required) +* **ForegroundColor**: [ConditionalFormattingColor](#conditionalformattingcolor) -## GridLayoutElement +## GaugeChartArcConditionalFormatting ### Properties -* **ColumnIndex**: int -* **ColumnSpan**: int (Required) -* **ElementId**: string (Required) -* **ElementType**: string (Required) -* **RowIndex**: int -* **RowSpan**: int (Required) +* **ForegroundColor**: [ConditionalFormattingColor](#conditionalformattingcolor) -## SectionBasedLayoutConfiguration +## GaugeChartArcConditionalFormatting ### Properties -* **BodySections**: [BodySectionConfiguration](#bodysectionconfiguration)[] (Required) -* **CanvasSizeOptions**: [SectionBasedLayoutCanvasSizeOptions](#sectionbasedlayoutcanvassizeoptions) (Required) -* **FooterSections**: [HeaderFooterSectionConfiguration](#headerfootersectionconfiguration)[] (Required) -* **HeaderSections**: [HeaderFooterSectionConfiguration](#headerfootersectionconfiguration)[] (Required) +* **ForegroundColor**: [ConditionalFormattingColor](#conditionalformattingcolor) -## BodySectionConfiguration +## GaugeChartConditionalFormatting ### Properties -* **Content**: [BodySectionContent](#bodysectioncontent) (Required) -* **PageBreakConfiguration**: [SectionPageBreakConfiguration](#sectionpagebreakconfiguration) -* **SectionId**: string (Required) -* **Style**: [SectionStyle](#sectionstyle) +* **ConditionalFormattingOptions**: [GaugeChartConditionalFormattingOption](#gaugechartconditionalformattingoption)[] -## BodySectionContent +## GaugeChartConditionalFormatting ### Properties -* **Layout**: [SectionLayoutConfiguration](#sectionlayoutconfiguration) +* **ConditionalFormattingOptions**: [GaugeChartConditionalFormattingOption](#gaugechartconditionalformattingoption)[] -## SectionLayoutConfiguration +## GaugeChartConditionalFormatting ### Properties -* **FreeFormLayout**: [FreeFormSectionLayoutConfiguration](#freeformsectionlayoutconfiguration) (Required) +* **ConditionalFormattingOptions**: [GaugeChartConditionalFormattingOption](#gaugechartconditionalformattingoption)[] -## FreeFormSectionLayoutConfiguration +## GaugeChartConditionalFormattingOption ### Properties -* **Elements**: [FreeFormLayoutElement](#freeformlayoutelement)[] (Required) +* **Arc**: [GaugeChartArcConditionalFormatting](#gaugechartarcconditionalformatting) +* **PrimaryValue**: [GaugeChartPrimaryValueConditionalFormatting](#gaugechartprimaryvalueconditionalformatting) -## SectionPageBreakConfiguration +## GaugeChartConditionalFormattingOption ### Properties -* **After**: [SectionAfterPageBreak](#sectionafterpagebreak) +* **Arc**: [GaugeChartArcConditionalFormatting](#gaugechartarcconditionalformatting) +* **PrimaryValue**: [GaugeChartPrimaryValueConditionalFormatting](#gaugechartprimaryvalueconditionalformatting) -## SectionAfterPageBreak +## GaugeChartConditionalFormattingOption ### Properties -* **Status**: string +* **Arc**: [GaugeChartArcConditionalFormatting](#gaugechartarcconditionalformatting) +* **PrimaryValue**: [GaugeChartPrimaryValueConditionalFormatting](#gaugechartprimaryvalueconditionalformatting) -## SectionStyle +## GaugeChartConfiguration ### Properties -* **Height**: string: String based length that is composed of value and unit in px -* **Padding**: [Spacing](#spacing) +* **DataLabels**: [DataLabelOptions](#datalabeloptions) +* **FieldWells**: [GaugeChartFieldWells](#gaugechartfieldwells) +* **GaugeChartOptions**: [GaugeChartOptions](#gaugechartoptions) +* **TooltipOptions**: [TooltipOptions](#tooltipoptions) +* **VisualPalette**: [VisualPalette](#visualpalette) -## HeaderFooterSectionConfiguration +## GaugeChartConfiguration ### Properties -* **Layout**: [SectionLayoutConfiguration](#sectionlayoutconfiguration) (Required) -* **SectionId**: string (Required) -* **Style**: [SectionStyle](#sectionstyle) +* **DataLabels**: [DataLabelOptions](#datalabeloptions) +* **FieldWells**: [GaugeChartFieldWells](#gaugechartfieldwells) +* **GaugeChartOptions**: [GaugeChartOptions](#gaugechartoptions) +* **TooltipOptions**: [TooltipOptions](#tooltipoptions) +* **VisualPalette**: [VisualPalette](#visualpalette) -## ParameterControl +## GaugeChartConfiguration ### Properties -* **DateTimePicker**: [ParameterDateTimePickerControl](#parameterdatetimepickercontrol) -* **Dropdown**: [ParameterDropDownControl](#parameterdropdowncontrol) -* **List**: [ParameterListControl](#parameterlistcontrol) -* **Slider**: [ParameterSliderControl](#parameterslidercontrol) -* **TextArea**: [ParameterTextAreaControl](#parametertextareacontrol) -* **TextField**: [ParameterTextFieldControl](#parametertextfieldcontrol) +* **DataLabels**: [DataLabelOptions](#datalabeloptions) +* **FieldWells**: [GaugeChartFieldWells](#gaugechartfieldwells) +* **GaugeChartOptions**: [GaugeChartOptions](#gaugechartoptions) +* **TooltipOptions**: [TooltipOptions](#tooltipoptions) +* **VisualPalette**: [VisualPalette](#visualpalette) -## ParameterDateTimePickerControl +## GaugeChartFieldWells ### Properties -* **DisplayOptions**: [DateTimePickerControlDisplayOptions](#datetimepickercontroldisplayoptions) -* **ParameterControlId**: string (Required) -* **SourceParameterName**: string (Required) -* **Title**: string (Required) +* **TargetValues**: [MeasureField](#measurefield)[] +* **Values**: [MeasureField](#measurefield)[] -## ParameterDropDownControl +## GaugeChartFieldWells ### Properties -* **CascadingControlConfiguration**: [CascadingControlConfiguration](#cascadingcontrolconfiguration) -* **DisplayOptions**: [DropDownControlDisplayOptions](#dropdowncontroldisplayoptions) -* **ParameterControlId**: string (Required) -* **SelectableValues**: [ParameterSelectableValues](#parameterselectablevalues) -* **SourceParameterName**: string (Required) -* **Title**: string (Required) -* **Type**: string +* **TargetValues**: [MeasureField](#measurefield)[] +* **Values**: [MeasureField](#measurefield)[] -## ParameterSelectableValues +## GaugeChartFieldWells ### Properties -* **LinkToDataSetColumn**: [ColumnIdentifier](#columnidentifier) -* **Values**: string[] +* **TargetValues**: [MeasureField](#measurefield)[] +* **Values**: [MeasureField](#measurefield)[] -## ParameterListControl +## GaugeChartOptions ### Properties -* **CascadingControlConfiguration**: [CascadingControlConfiguration](#cascadingcontrolconfiguration) -* **DisplayOptions**: [ListControlDisplayOptions](#listcontroldisplayoptions) -* **ParameterControlId**: string (Required) -* **SelectableValues**: [ParameterSelectableValues](#parameterselectablevalues) -* **SourceParameterName**: string (Required) -* **Title**: string (Required) -* **Type**: string +* **Arc**: [ArcConfiguration](#arcconfiguration) +* **ArcAxis**: [ArcAxisConfiguration](#arcaxisconfiguration) +* **Comparison**: [ComparisonConfiguration](#comparisonconfiguration) +* **PrimaryValueDisplayType**: string +* **PrimaryValueFontConfiguration**: [FontConfiguration](#fontconfiguration) -## ParameterSliderControl +## GaugeChartOptions ### Properties -* **DisplayOptions**: [SliderControlDisplayOptions](#slidercontroldisplayoptions) -* **MaximumValue**: int (Required) -* **MinimumValue**: int (Required) -* **ParameterControlId**: string (Required) -* **SourceParameterName**: string (Required) -* **StepSize**: int (Required) -* **Title**: string (Required) +* **Arc**: [ArcConfiguration](#arcconfiguration) +* **ArcAxis**: [ArcAxisConfiguration](#arcaxisconfiguration) +* **Comparison**: [ComparisonConfiguration](#comparisonconfiguration) +* **PrimaryValueDisplayType**: string +* **PrimaryValueFontConfiguration**: [FontConfiguration](#fontconfiguration) -## ParameterTextAreaControl +## GaugeChartOptions ### Properties -* **Delimiter**: string -* **DisplayOptions**: [TextAreaControlDisplayOptions](#textareacontroldisplayoptions) -* **ParameterControlId**: string (Required) -* **SourceParameterName**: string (Required) -* **Title**: string (Required) +* **Arc**: [ArcConfiguration](#arcconfiguration) +* **ArcAxis**: [ArcAxisConfiguration](#arcaxisconfiguration) +* **Comparison**: [ComparisonConfiguration](#comparisonconfiguration) +* **PrimaryValueDisplayType**: string +* **PrimaryValueFontConfiguration**: [FontConfiguration](#fontconfiguration) -## ParameterTextFieldControl +## GaugeChartPrimaryValueConditionalFormatting ### Properties -* **DisplayOptions**: [TextFieldControlDisplayOptions](#textfieldcontroldisplayoptions) -* **ParameterControlId**: string (Required) -* **SourceParameterName**: string (Required) -* **Title**: string (Required) +* **Icon**: [ConditionalFormattingIcon](#conditionalformattingicon) +* **TextColor**: [ConditionalFormattingColor](#conditionalformattingcolor) -## SheetControlLayout +## GaugeChartPrimaryValueConditionalFormatting ### Properties -* **Configuration**: [SheetControlLayoutConfiguration](#sheetcontrollayoutconfiguration) (Required) +* **Icon**: [ConditionalFormattingIcon](#conditionalformattingicon) +* **TextColor**: [ConditionalFormattingColor](#conditionalformattingcolor) -## SheetControlLayoutConfiguration +## GaugeChartPrimaryValueConditionalFormatting ### Properties -* **GridLayout**: [GridLayoutConfiguration](#gridlayoutconfiguration) +* **Icon**: [ConditionalFormattingIcon](#conditionalformattingicon) +* **TextColor**: [ConditionalFormattingColor](#conditionalformattingcolor) -## SheetTextBox +## GaugeChartVisual ### Properties -* **Content**: string -* **SheetTextBoxId**: string (Required) +* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **ChartConfiguration**: [GaugeChartConfiguration](#gaugechartconfiguration) +* **ConditionalFormatting**: [GaugeChartConditionalFormatting](#gaugechartconditionalformatting) +* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) +* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) +* **VisualId**: string (Required) -## Visual +## GaugeChartVisual ### Properties -* **BarChartVisual**: [BarChartVisual](#barchartvisual) -* **BoxPlotVisual**: [BoxPlotVisual](#boxplotvisual) -* **ComboChartVisual**: [ComboChartVisual](#combochartvisual) -* **CustomContentVisual**: [CustomContentVisual](#customcontentvisual) -* **EmptyVisual**: [EmptyVisual](#emptyvisual) -* **FilledMapVisual**: [FilledMapVisual](#filledmapvisual) -* **FunnelChartVisual**: [FunnelChartVisual](#funnelchartvisual) -* **GaugeChartVisual**: [GaugeChartVisual](#gaugechartvisual) -* **GeospatialMapVisual**: [GeospatialMapVisual](#geospatialmapvisual) -* **HeatMapVisual**: [HeatMapVisual](#heatmapvisual) -* **HistogramVisual**: [HistogramVisual](#histogramvisual) -* **InsightVisual**: [InsightVisual](#insightvisual) -* **KPIVisual**: [KPIVisual](#kpivisual) -* **LineChartVisual**: [LineChartVisual](#linechartvisual) -* **PieChartVisual**: [PieChartVisual](#piechartvisual) -* **PivotTableVisual**: [PivotTableVisual](#pivottablevisual) -* **RadarChartVisual**: [RadarChartVisual](#radarchartvisual) -* **SankeyDiagramVisual**: [SankeyDiagramVisual](#sankeydiagramvisual) -* **ScatterPlotVisual**: [ScatterPlotVisual](#scatterplotvisual) -* **TableVisual**: [TableVisual](#tablevisual) -* **TreeMapVisual**: [TreeMapVisual](#treemapvisual) -* **WaterfallVisual**: [WaterfallVisual](#waterfallvisual) -* **WordCloudVisual**: [WordCloudVisual](#wordcloudvisual) +* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **ChartConfiguration**: [GaugeChartConfiguration](#gaugechartconfiguration) +* **ConditionalFormatting**: [GaugeChartConditionalFormatting](#gaugechartconditionalformatting) +* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) +* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) +* **VisualId**: string (Required) -## BarChartVisual +## GaugeChartVisual ### Properties * **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [BarChartConfiguration](#barchartconfiguration) -* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] +* **ChartConfiguration**: [GaugeChartConfiguration](#gaugechartconfiguration) +* **ConditionalFormatting**: [GaugeChartConditionalFormatting](#gaugechartconditionalformatting) * **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) * **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) * **VisualId**: string (Required) -## VisualCustomAction +## GeoSpatialColumnGroup ### Properties -* **ActionOperations**: [VisualCustomActionOperation](#visualcustomactionoperation)[] (Required) -* **CustomActionId**: string (Required) -* **Name**: string (Required) -* **Status**: string -* **Trigger**: string (Required) +* **Columns**: string[] (Required):

Columns in this hierarchy.

+* **CountryCode**: string +* **Name**: string (Required):

A display name for the hierarchy.

-## VisualCustomActionOperation +## GeospatialCoordinateBounds ### Properties -* **FilterOperation**: [CustomActionFilterOperation](#customactionfilteroperation) -* **NavigationOperation**: [CustomActionNavigationOperation](#customactionnavigationoperation) -* **SetParametersOperation**: [CustomActionSetParametersOperation](#customactionsetparametersoperation) -* **URLOperation**: [CustomActionURLOperation](#customactionurloperation) +* **East**: int (Required) +* **North**: int (Required) +* **South**: int (Required) +* **West**: int (Required) -## CustomActionFilterOperation +## GeospatialCoordinateBounds ### Properties -* **SelectedFieldsConfiguration**: [FilterOperationSelectedFieldsConfiguration](#filteroperationselectedfieldsconfiguration) (Required) -* **TargetVisualsConfiguration**: [FilterOperationTargetVisualsConfiguration](#filteroperationtargetvisualsconfiguration) (Required) +* **East**: int (Required) +* **North**: int (Required) +* **South**: int (Required) +* **West**: int (Required) -## FilterOperationSelectedFieldsConfiguration +## GeospatialCoordinateBounds ### Properties -* **SelectedColumns**: [ColumnIdentifier](#columnidentifier)[] -* **SelectedFieldOptions**: string -* **SelectedFields**: string[] +* **East**: int (Required) +* **North**: int (Required) +* **South**: int (Required) +* **West**: int (Required) -## FilterOperationTargetVisualsConfiguration +## GeospatialHeatmapColorScale ### Properties -* **SameSheetTargetVisualConfiguration**: [SameSheetTargetVisualConfiguration](#samesheettargetvisualconfiguration) +* **Colors**: [GeospatialHeatmapDataColor](#geospatialheatmapdatacolor)[] -## SameSheetTargetVisualConfiguration +## GeospatialHeatmapColorScale ### Properties -* **TargetVisualOptions**: string -* **TargetVisuals**: string[] +* **Colors**: [GeospatialHeatmapDataColor](#geospatialheatmapdatacolor)[] -## CustomActionNavigationOperation +## GeospatialHeatmapColorScale ### Properties -* **LocalNavigationConfiguration**: [LocalNavigationConfiguration](#localnavigationconfiguration) +* **Colors**: [GeospatialHeatmapDataColor](#geospatialheatmapdatacolor)[] -## LocalNavigationConfiguration +## GeospatialHeatmapConfiguration ### Properties -* **TargetSheetId**: string (Required) +* **HeatmapColor**: [GeospatialHeatmapColorScale](#geospatialheatmapcolorscale) -## CustomActionSetParametersOperation +## GeospatialHeatmapConfiguration ### Properties -* **ParameterValueConfigurations**: [SetParameterValueConfiguration](#setparametervalueconfiguration)[] (Required) +* **HeatmapColor**: [GeospatialHeatmapColorScale](#geospatialheatmapcolorscale) -## SetParameterValueConfiguration +## GeospatialHeatmapConfiguration ### Properties -* **DestinationParameterName**: string (Required) -* **Value**: [DestinationParameterValueConfiguration](#destinationparametervalueconfiguration) (Required) +* **HeatmapColor**: [GeospatialHeatmapColorScale](#geospatialheatmapcolorscale) -## DestinationParameterValueConfiguration +## GeospatialHeatmapDataColor ### Properties -* **CustomValuesConfiguration**: [CustomValuesConfiguration](#customvaluesconfiguration) -* **SelectAllValueOptions**: string -* **SourceColumn**: [ColumnIdentifier](#columnidentifier) -* **SourceField**: string -* **SourceParameterName**: string +* **Color**: string (Required) -## CustomValuesConfiguration +## GeospatialHeatmapDataColor ### Properties -* **CustomValues**: [CustomParameterValues](#customparametervalues) (Required) -* **IncludeNullValue**: bool +* **Color**: string (Required) -## CustomParameterValues +## GeospatialHeatmapDataColor ### Properties -* **DateTimeValues**: string[] -* **DecimalValues**: int[] -* **IntegerValues**: int[] -* **StringValues**: string[] +* **Color**: string (Required) -## CustomActionURLOperation +## GeospatialMapAggregatedFieldWells ### Properties -* **URLTarget**: string (Required) -* **URLTemplate**: string (Required) +* **Colors**: [DimensionField](#dimensionfield)[] +* **Geospatial**: [DimensionField](#dimensionfield)[] +* **Values**: [MeasureField](#measurefield)[] -## BarChartConfiguration +## GeospatialMapAggregatedFieldWells ### Properties -* **BarsArrangement**: string -* **CategoryAxis**: [AxisDisplayOptions](#axisdisplayoptions) -* **CategoryLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **ColorLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **ContributionAnalysisDefaults**: [ContributionAnalysisDefault](#contributionanalysisdefault)[] -* **DataLabels**: [DataLabelOptions](#datalabeloptions) -* **FieldWells**: [BarChartFieldWells](#barchartfieldwells) +* **Colors**: [DimensionField](#dimensionfield)[] +* **Geospatial**: [DimensionField](#dimensionfield)[] +* **Values**: [MeasureField](#measurefield)[] + +## GeospatialMapAggregatedFieldWells +### Properties +* **Colors**: [DimensionField](#dimensionfield)[] +* **Geospatial**: [DimensionField](#dimensionfield)[] +* **Values**: [MeasureField](#measurefield)[] + +## GeospatialMapConfiguration +### Properties +* **FieldWells**: [GeospatialMapFieldWells](#geospatialmapfieldwells) * **Legend**: [LegendOptions](#legendoptions) -* **Orientation**: string -* **ReferenceLines**: [ReferenceLine](#referenceline)[] -* **SmallMultiplesOptions**: [SmallMultiplesOptions](#smallmultiplesoptions) -* **SortConfiguration**: [BarChartSortConfiguration](#barchartsortconfiguration) +* **MapStyleOptions**: [GeospatialMapStyleOptions](#geospatialmapstyleoptions) +* **PointStyleOptions**: [GeospatialPointStyleOptions](#geospatialpointstyleoptions) * **Tooltip**: [TooltipOptions](#tooltipoptions) -* **ValueAxis**: [AxisDisplayOptions](#axisdisplayoptions) -* **ValueLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) * **VisualPalette**: [VisualPalette](#visualpalette) +* **WindowOptions**: [GeospatialWindowOptions](#geospatialwindowoptions) -## AxisDisplayOptions -### Properties -* **AxisLineVisibility**: string -* **AxisOffset**: string: String based length that is composed of value and unit in px -* **DataOptions**: [AxisDataOptions](#axisdataoptions) -* **GridLineVisibility**: string -* **ScrollbarOptions**: [ScrollBarOptions](#scrollbaroptions) -* **TickLabelOptions**: [AxisTickLabelOptions](#axisticklabeloptions) - -## AxisDataOptions +## GeospatialMapConfiguration ### Properties -* **DateAxisOptions**: [DateAxisOptions](#dateaxisoptions) -* **NumericAxisOptions**: [NumericAxisOptions](#numericaxisoptions) +* **FieldWells**: [GeospatialMapFieldWells](#geospatialmapfieldwells) +* **Legend**: [LegendOptions](#legendoptions) +* **MapStyleOptions**: [GeospatialMapStyleOptions](#geospatialmapstyleoptions) +* **PointStyleOptions**: [GeospatialPointStyleOptions](#geospatialpointstyleoptions) +* **Tooltip**: [TooltipOptions](#tooltipoptions) +* **VisualPalette**: [VisualPalette](#visualpalette) +* **WindowOptions**: [GeospatialWindowOptions](#geospatialwindowoptions) -## DateAxisOptions +## GeospatialMapConfiguration ### Properties -* **MissingDateVisibility**: string +* **FieldWells**: [GeospatialMapFieldWells](#geospatialmapfieldwells) +* **Legend**: [LegendOptions](#legendoptions) +* **MapStyleOptions**: [GeospatialMapStyleOptions](#geospatialmapstyleoptions) +* **PointStyleOptions**: [GeospatialPointStyleOptions](#geospatialpointstyleoptions) +* **Tooltip**: [TooltipOptions](#tooltipoptions) +* **VisualPalette**: [VisualPalette](#visualpalette) +* **WindowOptions**: [GeospatialWindowOptions](#geospatialwindowoptions) -## NumericAxisOptions +## GeospatialMapFieldWells ### Properties -* **Range**: [AxisDisplayRange](#axisdisplayrange) -* **Scale**: [AxisScale](#axisscale) +* **GeospatialMapAggregatedFieldWells**: [GeospatialMapAggregatedFieldWells](#geospatialmapaggregatedfieldwells) -## AxisDisplayRange +## GeospatialMapFieldWells ### Properties -* **DataDriven**: [AxisDisplayDataDrivenRange](#axisdisplaydatadrivenrange) -* **MinMax**: [AxisDisplayMinMaxRange](#axisdisplayminmaxrange) +* **GeospatialMapAggregatedFieldWells**: [GeospatialMapAggregatedFieldWells](#geospatialmapaggregatedfieldwells) -## AxisDisplayDataDrivenRange +## GeospatialMapFieldWells ### Properties +* **GeospatialMapAggregatedFieldWells**: [GeospatialMapAggregatedFieldWells](#geospatialmapaggregatedfieldwells) -## AxisDisplayMinMaxRange +## GeospatialMapStyleOptions ### Properties -* **Maximum**: int -* **Minimum**: int +* **BaseMapStyle**: string -## AxisScale +## GeospatialMapStyleOptions ### Properties -* **Linear**: [AxisLinearScale](#axislinearscale) -* **Logarithmic**: [AxisLogarithmicScale](#axislogarithmicscale) +* **BaseMapStyle**: string -## AxisLinearScale +## GeospatialMapStyleOptions ### Properties -* **StepCount**: int -* **StepSize**: int +* **BaseMapStyle**: string -## AxisLogarithmicScale +## GeospatialMapVisual ### Properties -* **Base**: int +* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **ChartConfiguration**: [GeospatialMapConfiguration](#geospatialmapconfiguration) +* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] +* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) +* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) +* **VisualId**: string (Required) -## ScrollBarOptions +## GeospatialMapVisual ### Properties -* **Visibility**: string -* **VisibleRange**: [VisibleRangeOptions](#visiblerangeoptions) +* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **ChartConfiguration**: [GeospatialMapConfiguration](#geospatialmapconfiguration) +* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] +* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) +* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) +* **VisualId**: string (Required) -## VisibleRangeOptions +## GeospatialMapVisual ### Properties -* **PercentRange**: [PercentVisibleRange](#percentvisiblerange) +* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **ChartConfiguration**: [GeospatialMapConfiguration](#geospatialmapconfiguration) +* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] +* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) +* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) +* **VisualId**: string (Required) -## PercentVisibleRange +## GeospatialPointStyleOptions ### Properties -* **From**: int -* **To**: int +* **ClusterMarkerConfiguration**: [ClusterMarkerConfiguration](#clustermarkerconfiguration) +* **HeatmapConfiguration**: [GeospatialHeatmapConfiguration](#geospatialheatmapconfiguration) +* **SelectedPointStyle**: string -## AxisTickLabelOptions +## GeospatialPointStyleOptions ### Properties -* **LabelOptions**: [LabelOptions](#labeloptions) -* **RotationAngle**: int +* **ClusterMarkerConfiguration**: [ClusterMarkerConfiguration](#clustermarkerconfiguration) +* **HeatmapConfiguration**: [GeospatialHeatmapConfiguration](#geospatialheatmapconfiguration) +* **SelectedPointStyle**: string -## ChartAxisLabelOptions +## GeospatialPointStyleOptions ### Properties -* **AxisLabelOptions**: [AxisLabelOptions](#axislabeloptions)[] -* **SortIconVisibility**: string -* **Visibility**: string +* **ClusterMarkerConfiguration**: [ClusterMarkerConfiguration](#clustermarkerconfiguration) +* **HeatmapConfiguration**: [GeospatialHeatmapConfiguration](#geospatialheatmapconfiguration) +* **SelectedPointStyle**: string -## AxisLabelOptions +## GeospatialWindowOptions ### Properties -* **ApplyTo**: [AxisLabelReferenceOptions](#axislabelreferenceoptions) -* **CustomLabel**: string -* **FontConfiguration**: [FontConfiguration](#fontconfiguration) +* **Bounds**: [GeospatialCoordinateBounds](#geospatialcoordinatebounds) +* **MapZoomMode**: string -## AxisLabelReferenceOptions +## GeospatialWindowOptions ### Properties -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **FieldId**: string (Required) +* **Bounds**: [GeospatialCoordinateBounds](#geospatialcoordinatebounds) +* **MapZoomMode**: string -## ContributionAnalysisDefault +## GeospatialWindowOptions ### Properties -* **ContributorDimensions**: [ColumnIdentifier](#columnidentifier)[] (Required) -* **MeasureFieldId**: string (Required) +* **Bounds**: [GeospatialCoordinateBounds](#geospatialcoordinatebounds) +* **MapZoomMode**: string -## DataLabelOptions +## GlobalTableBorderOptions ### Properties -* **CategoryLabelVisibility**: string -* **DataLabelTypes**: [DataLabelType](#datalabeltype)[] -* **LabelColor**: string -* **LabelContent**: string -* **LabelFontConfiguration**: [FontConfiguration](#fontconfiguration) -* **MeasureLabelVisibility**: string -* **Overlap**: string -* **Position**: string -* **TotalsVisibility**: string -* **Visibility**: string +* **SideSpecificBorder**: [TableSideBorderOptions](#tablesideborderoptions) +* **UniformBorder**: [TableBorderOptions](#tableborderoptions) -## DataLabelType +## GlobalTableBorderOptions ### Properties -* **DataPathLabelType**: [DataPathLabelType](#datapathlabeltype) -* **FieldLabelType**: [FieldLabelType](#fieldlabeltype) -* **MaximumLabelType**: [MaximumLabelType](#maximumlabeltype) -* **MinimumLabelType**: [MinimumLabelType](#minimumlabeltype) -* **RangeEndsLabelType**: [RangeEndsLabelType](#rangeendslabeltype) +* **SideSpecificBorder**: [TableSideBorderOptions](#tablesideborderoptions) +* **UniformBorder**: [TableBorderOptions](#tableborderoptions) -## DataPathLabelType +## GlobalTableBorderOptions ### Properties -* **FieldId**: string -* **FieldValue**: string -* **Visibility**: string +* **SideSpecificBorder**: [TableSideBorderOptions](#tablesideborderoptions) +* **UniformBorder**: [TableBorderOptions](#tableborderoptions) -## FieldLabelType +## GradientColor ### Properties -* **FieldId**: string -* **Visibility**: string +* **Stops**: [GradientStop](#gradientstop)[] -## MaximumLabelType +## GradientColor ### Properties -* **Visibility**: string +* **Stops**: [GradientStop](#gradientstop)[] -## MinimumLabelType +## GradientColor ### Properties -* **Visibility**: string +* **Stops**: [GradientStop](#gradientstop)[] -## RangeEndsLabelType +## GradientStop ### Properties -* **Visibility**: string +* **Color**: string +* **DataValue**: int +* **GradientOffset**: int (Required) -## BarChartFieldWells +## GradientStop ### Properties -* **BarChartAggregatedFieldWells**: [BarChartAggregatedFieldWells](#barchartaggregatedfieldwells) +* **Color**: string +* **DataValue**: int +* **GradientOffset**: int (Required) -## BarChartAggregatedFieldWells +## GradientStop ### Properties -* **Category**: [DimensionField](#dimensionfield)[] -* **Colors**: [DimensionField](#dimensionfield)[] -* **SmallMultiples**: [DimensionField](#dimensionfield)[] -* **Values**: [MeasureField](#measurefield)[] +* **Color**: string +* **DataValue**: int +* **GradientOffset**: int (Required) -## DimensionField +## GridLayoutCanvasSizeOptions ### Properties -* **CategoricalDimensionField**: [CategoricalDimensionField](#categoricaldimensionfield) -* **DateDimensionField**: [DateDimensionField](#datedimensionfield) -* **NumericalDimensionField**: [NumericalDimensionField](#numericaldimensionfield) +* **ScreenCanvasSizeOptions**: [GridLayoutScreenCanvasSizeOptions](#gridlayoutscreencanvassizeoptions) -## CategoricalDimensionField +## GridLayoutCanvasSizeOptions ### Properties -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **FieldId**: string (Required) -* **FormatConfiguration**: [StringFormatConfiguration](#stringformatconfiguration) -* **HierarchyId**: string +* **ScreenCanvasSizeOptions**: [GridLayoutScreenCanvasSizeOptions](#gridlayoutscreencanvassizeoptions) -## DateDimensionField +## GridLayoutCanvasSizeOptions ### Properties -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **DateGranularity**: string -* **FieldId**: string (Required) -* **FormatConfiguration**: [DateTimeFormatConfiguration](#datetimeformatconfiguration) -* **HierarchyId**: string +* **ScreenCanvasSizeOptions**: [GridLayoutScreenCanvasSizeOptions](#gridlayoutscreencanvassizeoptions) -## NumericalDimensionField +## GridLayoutConfiguration ### Properties -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **FieldId**: string (Required) -* **FormatConfiguration**: [NumberFormatConfiguration](#numberformatconfiguration) -* **HierarchyId**: string +* **CanvasSizeOptions**: [GridLayoutCanvasSizeOptions](#gridlayoutcanvassizeoptions) +* **Elements**: [GridLayoutElement](#gridlayoutelement)[] (Required) -## MeasureField +## GridLayoutConfiguration ### Properties -* **CalculatedMeasureField**: [CalculatedMeasureField](#calculatedmeasurefield) -* **CategoricalMeasureField**: [CategoricalMeasureField](#categoricalmeasurefield) -* **DateMeasureField**: [DateMeasureField](#datemeasurefield) -* **NumericalMeasureField**: [NumericalMeasureField](#numericalmeasurefield) +* **CanvasSizeOptions**: [GridLayoutCanvasSizeOptions](#gridlayoutcanvassizeoptions) +* **Elements**: [GridLayoutElement](#gridlayoutelement)[] (Required) -## CalculatedMeasureField +## GridLayoutConfiguration ### Properties -* **Expression**: string (Required) -* **FieldId**: string (Required) +* **CanvasSizeOptions**: [GridLayoutCanvasSizeOptions](#gridlayoutcanvassizeoptions) +* **Elements**: [GridLayoutElement](#gridlayoutelement)[] (Required) -## CategoricalMeasureField +## GridLayoutElement ### Properties -* **AggregationFunction**: string -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **FieldId**: string (Required) -* **FormatConfiguration**: [StringFormatConfiguration](#stringformatconfiguration) +* **ColumnIndex**: int +* **ColumnSpan**: int (Required) +* **ElementId**: string (Required) +* **ElementType**: string (Required) +* **RowIndex**: int +* **RowSpan**: int (Required) -## DateMeasureField +## GridLayoutElement ### Properties -* **AggregationFunction**: string -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **FieldId**: string (Required) -* **FormatConfiguration**: [DateTimeFormatConfiguration](#datetimeformatconfiguration) +* **ColumnIndex**: int +* **ColumnSpan**: int (Required) +* **ElementId**: string (Required) +* **ElementType**: string (Required) +* **RowIndex**: int +* **RowSpan**: int (Required) -## NumericalMeasureField +## GridLayoutElement ### Properties -* **AggregationFunction**: [NumericalAggregationFunction](#numericalaggregationfunction) -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **FieldId**: string (Required) -* **FormatConfiguration**: [NumberFormatConfiguration](#numberformatconfiguration) +* **ColumnIndex**: int +* **ColumnSpan**: int (Required) +* **ElementId**: string (Required) +* **ElementType**: string (Required) +* **RowIndex**: int +* **RowSpan**: int (Required) -## LegendOptions +## GridLayoutScreenCanvasSizeOptions ### Properties -* **Height**: string: String based length that is composed of value and unit in px -* **Position**: string -* **Title**: [LabelOptions](#labeloptions) -* **Visibility**: string -* **Width**: string: String based length that is composed of value and unit in px +* **OptimizedViewPortWidth**: string: String based length that is composed of value and unit in px +* **ResizeOption**: string (Required) -## ReferenceLine +## GridLayoutScreenCanvasSizeOptions ### Properties -* **DataConfiguration**: [ReferenceLineDataConfiguration](#referencelinedataconfiguration) (Required) -* **LabelConfiguration**: [ReferenceLineLabelConfiguration](#referencelinelabelconfiguration) -* **Status**: string -* **StyleConfiguration**: [ReferenceLineStyleConfiguration](#referencelinestyleconfiguration) +* **OptimizedViewPortWidth**: string: String based length that is composed of value and unit in px +* **ResizeOption**: string (Required) -## ReferenceLineDataConfiguration +## GridLayoutScreenCanvasSizeOptions ### Properties -* **AxisBinding**: string -* **DynamicConfiguration**: [ReferenceLineDynamicDataConfiguration](#referencelinedynamicdataconfiguration) -* **SeriesType**: string -* **StaticConfiguration**: [ReferenceLineStaticDataConfiguration](#referencelinestaticdataconfiguration) +* **OptimizedViewPortWidth**: string: String based length that is composed of value and unit in px +* **ResizeOption**: string (Required) -## ReferenceLineDynamicDataConfiguration +## GrowthRateComputation ### Properties -* **Calculation**: [NumericalAggregationFunction](#numericalaggregationfunction) (Required) -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **MeasureAggregationFunction**: [AggregationFunction](#aggregationfunction) +* **ComputationId**: string (Required) +* **Name**: string +* **PeriodSize**: int +* **Time**: [DimensionField](#dimensionfield) +* **Value**: [MeasureField](#measurefield) -## ReferenceLineStaticDataConfiguration +## GrowthRateComputation ### Properties -* **Value**: int (Required) +* **ComputationId**: string (Required) +* **Name**: string +* **PeriodSize**: int +* **Time**: [DimensionField](#dimensionfield) +* **Value**: [MeasureField](#measurefield) -## ReferenceLineLabelConfiguration +## GrowthRateComputation ### Properties -* **CustomLabelConfiguration**: [ReferenceLineCustomLabelConfiguration](#referencelinecustomlabelconfiguration) -* **FontColor**: string -* **FontConfiguration**: [FontConfiguration](#fontconfiguration) -* **HorizontalPosition**: string -* **ValueLabelConfiguration**: [ReferenceLineValueLabelConfiguration](#referencelinevaluelabelconfiguration) -* **VerticalPosition**: string +* **ComputationId**: string (Required) +* **Name**: string +* **PeriodSize**: int +* **Time**: [DimensionField](#dimensionfield) +* **Value**: [MeasureField](#measurefield) -## ReferenceLineCustomLabelConfiguration +## GutterStyle ### Properties -* **CustomLabel**: string (Required) +* **Show**: bool:

This Boolean value controls whether to display a gutter space between sheet tiles. +

-## ReferenceLineValueLabelConfiguration +## HeaderFooterSectionConfiguration ### Properties -* **FormatConfiguration**: [NumericFormatConfiguration](#numericformatconfiguration) -* **RelativePosition**: string +* **Layout**: [SectionLayoutConfiguration](#sectionlayoutconfiguration) (Required) +* **SectionId**: string (Required) +* **Style**: [SectionStyle](#sectionstyle) -## ReferenceLineStyleConfiguration +## HeaderFooterSectionConfiguration ### Properties -* **Color**: string -* **Pattern**: string +* **Layout**: [SectionLayoutConfiguration](#sectionlayoutconfiguration) (Required) +* **SectionId**: string (Required) +* **Style**: [SectionStyle](#sectionstyle) -## SmallMultiplesOptions +## HeaderFooterSectionConfiguration ### Properties -* **MaxVisibleColumns**: int -* **MaxVisibleRows**: int -* **PanelConfiguration**: [PanelConfiguration](#panelconfiguration) -* **XAxis**: [SmallMultiplesAxisProperties](#smallmultiplesaxisproperties) -* **YAxis**: [SmallMultiplesAxisProperties](#smallmultiplesaxisproperties) +* **Layout**: [SectionLayoutConfiguration](#sectionlayoutconfiguration) (Required) +* **SectionId**: string (Required) +* **Style**: [SectionStyle](#sectionstyle) -## PanelConfiguration +## HeatMapAggregatedFieldWells ### Properties -* **BackgroundColor**: string -* **BackgroundVisibility**: string -* **BorderColor**: string -* **BorderStyle**: string -* **BorderThickness**: string: String based length that is composed of value and unit in px -* **BorderVisibility**: string -* **GutterSpacing**: string: String based length that is composed of value and unit in px -* **GutterVisibility**: string -* **Title**: [PanelTitleOptions](#paneltitleoptions) +* **Columns**: [DimensionField](#dimensionfield)[] +* **Rows**: [DimensionField](#dimensionfield)[] +* **Values**: [MeasureField](#measurefield)[] -## PanelTitleOptions +## HeatMapAggregatedFieldWells ### Properties -* **FontConfiguration**: [FontConfiguration](#fontconfiguration) -* **HorizontalTextAlignment**: string -* **Visibility**: string +* **Columns**: [DimensionField](#dimensionfield)[] +* **Rows**: [DimensionField](#dimensionfield)[] +* **Values**: [MeasureField](#measurefield)[] -## SmallMultiplesAxisProperties +## HeatMapAggregatedFieldWells ### Properties -* **Placement**: string -* **Scale**: string +* **Columns**: [DimensionField](#dimensionfield)[] +* **Rows**: [DimensionField](#dimensionfield)[] +* **Values**: [MeasureField](#measurefield)[] -## BarChartSortConfiguration +## HeatMapConfiguration ### Properties -* **CategoryItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) -* **CategorySort**: [FieldSortOptions](#fieldsortoptions)[] -* **ColorItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) -* **ColorSort**: [FieldSortOptions](#fieldsortoptions)[] -* **SmallMultiplesLimitConfiguration**: [ItemsLimitConfiguration](#itemslimitconfiguration) -* **SmallMultiplesSort**: [FieldSortOptions](#fieldsortoptions)[] +* **ColorScale**: [ColorScale](#colorscale) +* **ColumnLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **DataLabels**: [DataLabelOptions](#datalabeloptions) +* **FieldWells**: [HeatMapFieldWells](#heatmapfieldwells) +* **Legend**: [LegendOptions](#legendoptions) +* **RowLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **SortConfiguration**: [HeatMapSortConfiguration](#heatmapsortconfiguration) +* **Tooltip**: [TooltipOptions](#tooltipoptions) -## ItemsLimitConfiguration +## HeatMapConfiguration ### Properties -* **ItemsLimit**: int -* **OtherCategories**: string +* **ColorScale**: [ColorScale](#colorscale) +* **ColumnLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **DataLabels**: [DataLabelOptions](#datalabeloptions) +* **FieldWells**: [HeatMapFieldWells](#heatmapfieldwells) +* **Legend**: [LegendOptions](#legendoptions) +* **RowLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **SortConfiguration**: [HeatMapSortConfiguration](#heatmapsortconfiguration) +* **Tooltip**: [TooltipOptions](#tooltipoptions) -## FieldSortOptions +## HeatMapConfiguration ### Properties -* **ColumnSort**: [ColumnSort](#columnsort) -* **FieldSort**: [FieldSort](#fieldsort) +* **ColorScale**: [ColorScale](#colorscale) +* **ColumnLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **DataLabels**: [DataLabelOptions](#datalabeloptions) +* **FieldWells**: [HeatMapFieldWells](#heatmapfieldwells) +* **Legend**: [LegendOptions](#legendoptions) +* **RowLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **SortConfiguration**: [HeatMapSortConfiguration](#heatmapsortconfiguration) +* **Tooltip**: [TooltipOptions](#tooltipoptions) -## ColumnSort +## HeatMapFieldWells ### Properties -* **AggregationFunction**: [AggregationFunction](#aggregationfunction) -* **Direction**: string (Required) -* **SortBy**: [ColumnIdentifier](#columnidentifier) (Required) +* **HeatMapAggregatedFieldWells**: [HeatMapAggregatedFieldWells](#heatmapaggregatedfieldwells) -## FieldSort +## HeatMapFieldWells ### Properties -* **Direction**: string (Required) -* **FieldId**: string (Required) +* **HeatMapAggregatedFieldWells**: [HeatMapAggregatedFieldWells](#heatmapaggregatedfieldwells) -## TooltipOptions +## HeatMapFieldWells ### Properties -* **FieldBasedTooltip**: [FieldBasedTooltip](#fieldbasedtooltip) -* **SelectedTooltipType**: string -* **TooltipVisibility**: string +* **HeatMapAggregatedFieldWells**: [HeatMapAggregatedFieldWells](#heatmapaggregatedfieldwells) -## FieldBasedTooltip +## HeatMapSortConfiguration ### Properties -* **AggregationVisibility**: string -* **TooltipFields**: [TooltipItem](#tooltipitem)[] -* **TooltipTitleType**: string +* **HeatMapColumnItemsLimitConfiguration**: [ItemsLimitConfiguration](#itemslimitconfiguration) +* **HeatMapColumnSort**: [FieldSortOptions](#fieldsortoptions)[] +* **HeatMapRowItemsLimitConfiguration**: [ItemsLimitConfiguration](#itemslimitconfiguration) +* **HeatMapRowSort**: [FieldSortOptions](#fieldsortoptions)[] -## TooltipItem +## HeatMapSortConfiguration ### Properties -* **ColumnTooltipItem**: [ColumnTooltipItem](#columntooltipitem) -* **FieldTooltipItem**: [FieldTooltipItem](#fieldtooltipitem) +* **HeatMapColumnItemsLimitConfiguration**: [ItemsLimitConfiguration](#itemslimitconfiguration) +* **HeatMapColumnSort**: [FieldSortOptions](#fieldsortoptions)[] +* **HeatMapRowItemsLimitConfiguration**: [ItemsLimitConfiguration](#itemslimitconfiguration) +* **HeatMapRowSort**: [FieldSortOptions](#fieldsortoptions)[] -## ColumnTooltipItem +## HeatMapSortConfiguration ### Properties -* **Aggregation**: [AggregationFunction](#aggregationfunction) -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **Label**: string -* **Visibility**: string +* **HeatMapColumnItemsLimitConfiguration**: [ItemsLimitConfiguration](#itemslimitconfiguration) +* **HeatMapColumnSort**: [FieldSortOptions](#fieldsortoptions)[] +* **HeatMapRowItemsLimitConfiguration**: [ItemsLimitConfiguration](#itemslimitconfiguration) +* **HeatMapRowSort**: [FieldSortOptions](#fieldsortoptions)[] -## FieldTooltipItem +## HeatMapVisual ### Properties -* **FieldId**: string (Required) -* **Label**: string -* **Visibility**: string +* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **ChartConfiguration**: [HeatMapConfiguration](#heatmapconfiguration) +* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] +* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) +* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) +* **VisualId**: string (Required) -## VisualPalette +## HeatMapVisual ### Properties -* **ChartColor**: string -* **ColorMap**: [DataPathColor](#datapathcolor)[] +* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **ChartConfiguration**: [HeatMapConfiguration](#heatmapconfiguration) +* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] +* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) +* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) +* **VisualId**: string (Required) -## DataPathColor +## HeatMapVisual ### Properties -* **Color**: string (Required) -* **Element**: [DataPathValue](#datapathvalue) (Required) -* **TimeGranularity**: string +* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **ChartConfiguration**: [HeatMapConfiguration](#heatmapconfiguration) +* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] +* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) +* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) +* **VisualId**: string (Required) -## DataPathValue +## HistogramAggregatedFieldWells ### Properties -* **DataPathType**: [DataPathType](#datapathtype) -* **FieldId**: string -* **FieldValue**: string +* **Values**: [MeasureField](#measurefield)[] -## DataPathType +## HistogramAggregatedFieldWells ### Properties -* **PivotTableDataPathType**: string +* **Values**: [MeasureField](#measurefield)[] -## ColumnHierarchy +## HistogramAggregatedFieldWells ### Properties -* **DateTimeHierarchy**: [DateTimeHierarchy](#datetimehierarchy) -* **ExplicitHierarchy**: [ExplicitHierarchy](#explicithierarchy) -* **PredefinedHierarchy**: [PredefinedHierarchy](#predefinedhierarchy) +* **Values**: [MeasureField](#measurefield)[] -## DateTimeHierarchy +## HistogramBinOptions ### Properties -* **DrillDownFilters**: [DrillDownFilter](#drilldownfilter)[] -* **HierarchyId**: string (Required) +* **BinCount**: [BinCountOptions](#bincountoptions) +* **BinWidth**: [BinWidthOptions](#binwidthoptions) +* **SelectedBinType**: string +* **StartValue**: int -## DrillDownFilter +## HistogramBinOptions ### Properties -* **CategoryFilter**: [CategoryDrillDownFilter](#categorydrilldownfilter) -* **NumericEqualityFilter**: [NumericEqualityDrillDownFilter](#numericequalitydrilldownfilter) -* **TimeRangeFilter**: [TimeRangeDrillDownFilter](#timerangedrilldownfilter) +* **BinCount**: [BinCountOptions](#bincountoptions) +* **BinWidth**: [BinWidthOptions](#binwidthoptions) +* **SelectedBinType**: string +* **StartValue**: int -## CategoryDrillDownFilter +## HistogramBinOptions ### Properties -* **CategoryValues**: string[] (Required) -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) +* **BinCount**: [BinCountOptions](#bincountoptions) +* **BinWidth**: [BinWidthOptions](#binwidthoptions) +* **SelectedBinType**: string +* **StartValue**: int -## NumericEqualityDrillDownFilter +## HistogramConfiguration ### Properties -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **Value**: int (Required) +* **BinOptions**: [HistogramBinOptions](#histogrambinoptions) +* **DataLabels**: [DataLabelOptions](#datalabeloptions) +* **FieldWells**: [HistogramFieldWells](#histogramfieldwells) +* **Tooltip**: [TooltipOptions](#tooltipoptions) +* **VisualPalette**: [VisualPalette](#visualpalette) +* **XAxisDisplayOptions**: [AxisDisplayOptions](#axisdisplayoptions) +* **XAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **YAxisDisplayOptions**: [AxisDisplayOptions](#axisdisplayoptions) -## TimeRangeDrillDownFilter +## HistogramConfiguration ### Properties -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **RangeMaximum**: string (Required) -* **RangeMinimum**: string (Required) -* **TimeGranularity**: string (Required) +* **BinOptions**: [HistogramBinOptions](#histogrambinoptions) +* **DataLabels**: [DataLabelOptions](#datalabeloptions) +* **FieldWells**: [HistogramFieldWells](#histogramfieldwells) +* **Tooltip**: [TooltipOptions](#tooltipoptions) +* **VisualPalette**: [VisualPalette](#visualpalette) +* **XAxisDisplayOptions**: [AxisDisplayOptions](#axisdisplayoptions) +* **XAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **YAxisDisplayOptions**: [AxisDisplayOptions](#axisdisplayoptions) -## ExplicitHierarchy +## HistogramConfiguration ### Properties -* **Columns**: [ColumnIdentifier](#columnidentifier)[] (Required) -* **DrillDownFilters**: [DrillDownFilter](#drilldownfilter)[] -* **HierarchyId**: string (Required) +* **BinOptions**: [HistogramBinOptions](#histogrambinoptions) +* **DataLabels**: [DataLabelOptions](#datalabeloptions) +* **FieldWells**: [HistogramFieldWells](#histogramfieldwells) +* **Tooltip**: [TooltipOptions](#tooltipoptions) +* **VisualPalette**: [VisualPalette](#visualpalette) +* **XAxisDisplayOptions**: [AxisDisplayOptions](#axisdisplayoptions) +* **XAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **YAxisDisplayOptions**: [AxisDisplayOptions](#axisdisplayoptions) -## PredefinedHierarchy +## HistogramFieldWells ### Properties -* **Columns**: [ColumnIdentifier](#columnidentifier)[] (Required) -* **DrillDownFilters**: [DrillDownFilter](#drilldownfilter)[] -* **HierarchyId**: string (Required) +* **HistogramAggregatedFieldWells**: [HistogramAggregatedFieldWells](#histogramaggregatedfieldwells) -## VisualSubtitleLabelOptions +## HistogramFieldWells ### Properties -* **FormatText**: [LongFormatText](#longformattext) -* **Visibility**: string +* **HistogramAggregatedFieldWells**: [HistogramAggregatedFieldWells](#histogramaggregatedfieldwells) -## LongFormatText +## HistogramFieldWells ### Properties -* **PlainText**: string -* **RichText**: string +* **HistogramAggregatedFieldWells**: [HistogramAggregatedFieldWells](#histogramaggregatedfieldwells) -## VisualTitleLabelOptions +## HistogramVisual ### Properties -* **FormatText**: [ShortFormatText](#shortformattext) -* **Visibility**: string +* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **ChartConfiguration**: [HistogramConfiguration](#histogramconfiguration) +* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) +* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) +* **VisualId**: string (Required) -## ShortFormatText +## HistogramVisual ### Properties -* **PlainText**: string -* **RichText**: string +* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **ChartConfiguration**: [HistogramConfiguration](#histogramconfiguration) +* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) +* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) +* **VisualId**: string (Required) -## BoxPlotVisual +## HistogramVisual ### Properties * **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [BoxPlotChartConfiguration](#boxplotchartconfiguration) -* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] +* **ChartConfiguration**: [HistogramConfiguration](#histogramconfiguration) * **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) * **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) * **VisualId**: string (Required) -## BoxPlotChartConfiguration +## IdentityCenterConfiguration ### Properties -* **BoxPlotOptions**: [BoxPlotOptions](#boxplotoptions) -* **CategoryAxis**: [AxisDisplayOptions](#axisdisplayoptions) -* **CategoryLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **FieldWells**: [BoxPlotFieldWells](#boxplotfieldwells) -* **Legend**: [LegendOptions](#legendoptions) -* **PrimaryYAxisDisplayOptions**: [AxisDisplayOptions](#axisdisplayoptions) -* **PrimaryYAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **ReferenceLines**: [ReferenceLine](#referenceline)[] -* **SortConfiguration**: [BoxPlotSortConfiguration](#boxplotsortconfiguration) -* **Tooltip**: [TooltipOptions](#tooltipoptions) -* **VisualPalette**: [VisualPalette](#visualpalette) +* **EnableIdentityPropagation**: bool:

A Boolean option that controls whether Trusted Identity Propagation should be used.

-## BoxPlotOptions +## IncrementalRefresh ### Properties -* **AllDataPointsVisibility**: string -* **OutlierVisibility**: string -* **StyleOptions**: [BoxPlotStyleOptions](#boxplotstyleoptions) +* **LookbackWindow**: [LookbackWindow](#lookbackwindow) (Required) -## BoxPlotStyleOptions +## IngestionWaitPolicy ### Properties -* **FillStyle**: string +* **IngestionWaitTimeInHours**: int:

The maximum time (in hours) to wait for Ingestion to complete. Default timeout is 36 hours. + Applicable only when DataSetImportMode mode is set to SPICE and WaitForSpiceIngestion is set to true.

+* **WaitForSpiceIngestion**: bool:

Wait for SPICE ingestion to finish to mark dataset creation/update successful. Default (true). + Applicable only when DataSetImportMode mode is set to SPICE.

-## BoxPlotFieldWells +## InsightConfiguration ### Properties -* **BoxPlotAggregatedFieldWells**: [BoxPlotAggregatedFieldWells](#boxplotaggregatedfieldwells) +* **Computations**: [Computation](#computation)[] +* **CustomNarrative**: [CustomNarrativeOptions](#customnarrativeoptions) -## BoxPlotAggregatedFieldWells +## InsightConfiguration ### Properties -* **GroupBy**: [DimensionField](#dimensionfield)[] -* **Values**: [MeasureField](#measurefield)[] +* **Computations**: [Computation](#computation)[] +* **CustomNarrative**: [CustomNarrativeOptions](#customnarrativeoptions) -## BoxPlotSortConfiguration +## InsightConfiguration ### Properties -* **CategorySort**: [FieldSortOptions](#fieldsortoptions)[] -* **PaginationConfiguration**: [PaginationConfiguration](#paginationconfiguration) +* **Computations**: [Computation](#computation)[] +* **CustomNarrative**: [CustomNarrativeOptions](#customnarrativeoptions) -## PaginationConfiguration +## InsightVisual ### Properties -* **PageNumber**: int (Required) -* **PageSize**: int (Required) +* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **DataSetIdentifier**: string (Required) +* **InsightConfiguration**: [InsightConfiguration](#insightconfiguration) +* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) +* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) +* **VisualId**: string (Required) -## ComboChartVisual +## InsightVisual ### Properties * **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [ComboChartConfiguration](#combochartconfiguration) -* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] +* **DataSetIdentifier**: string (Required) +* **InsightConfiguration**: [InsightConfiguration](#insightconfiguration) * **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) * **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) * **VisualId**: string (Required) -## ComboChartConfiguration +## InsightVisual ### Properties -* **BarDataLabels**: [DataLabelOptions](#datalabeloptions) -* **BarsArrangement**: string -* **CategoryAxis**: [AxisDisplayOptions](#axisdisplayoptions) -* **CategoryLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **ColorLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **FieldWells**: [ComboChartFieldWells](#combochartfieldwells) -* **Legend**: [LegendOptions](#legendoptions) -* **LineDataLabels**: [DataLabelOptions](#datalabeloptions) -* **PrimaryYAxisDisplayOptions**: [AxisDisplayOptions](#axisdisplayoptions) -* **PrimaryYAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **ReferenceLines**: [ReferenceLine](#referenceline)[] -* **SecondaryYAxisDisplayOptions**: [AxisDisplayOptions](#axisdisplayoptions) -* **SecondaryYAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **SortConfiguration**: [ComboChartSortConfiguration](#combochartsortconfiguration) -* **Tooltip**: [TooltipOptions](#tooltipoptions) -* **VisualPalette**: [VisualPalette](#visualpalette) +* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **DataSetIdentifier**: string (Required) +* **InsightConfiguration**: [InsightConfiguration](#insightconfiguration) +* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) +* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) +* **VisualId**: string (Required) -## ComboChartFieldWells +## IntegerDatasetParameter ### Properties -* **ComboChartAggregatedFieldWells**: [ComboChartAggregatedFieldWells](#combochartaggregatedfieldwells) +* **DefaultValues**: [IntegerDatasetParameterDefaultValues](#integerdatasetparameterdefaultvalues) +* **Id**: string (Required):

An identifier for the integer parameter created in the dataset.

+* **Name**: string (Required):

The name of the integer parameter that is created in the dataset.

+* **ValueType**: string (Required) -## ComboChartAggregatedFieldWells +## IntegerDatasetParameterDefaultValues ### Properties -* **BarValues**: [MeasureField](#measurefield)[] -* **Category**: [DimensionField](#dimensionfield)[] -* **Colors**: [DimensionField](#dimensionfield)[] -* **LineValues**: [MeasureField](#measurefield)[] +* **StaticValues**: int[]:

A list of static default values for a given integer parameter.

-## ComboChartSortConfiguration +## IntegerDefaultValues ### Properties -* **CategoryItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) -* **CategorySort**: [FieldSortOptions](#fieldsortoptions)[] -* **ColorItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) -* **ColorSort**: [FieldSortOptions](#fieldsortoptions)[] +* **DynamicValue**: [DynamicDefaultValue](#dynamicdefaultvalue) +* **StaticValues**: int[] -## CustomContentVisual +## IntegerDefaultValues ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [CustomContentConfiguration](#customcontentconfiguration) -* **DataSetIdentifier**: string (Required) -* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) -* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) -* **VisualId**: string (Required) +* **DynamicValue**: [DynamicDefaultValue](#dynamicdefaultvalue) +* **StaticValues**: int[] -## CustomContentConfiguration +## IntegerDefaultValues ### Properties -* **ContentType**: string -* **ContentUrl**: string -* **ImageScaling**: string +* **DynamicValue**: [DynamicDefaultValue](#dynamicdefaultvalue) +* **StaticValues**: int[] -## EmptyVisual +## IntegerParameter ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **DataSetIdentifier**: string (Required) -* **VisualId**: string (Required) +* **Name**: string (Required):

The name of the integer parameter.

+* **Values**: int[] (Required):

The values for the integer parameter.

-## FilledMapVisual +## IntegerParameter ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [FilledMapConfiguration](#filledmapconfiguration) -* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] -* **ConditionalFormatting**: [FilledMapConditionalFormatting](#filledmapconditionalformatting) -* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) -* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) -* **VisualId**: string (Required) +* **Name**: string (Required):

The name of the integer parameter.

+* **Values**: int[] (Required):

The values for the integer parameter.

-## FilledMapConfiguration +## IntegerParameterDeclaration ### Properties -* **FieldWells**: [FilledMapFieldWells](#filledmapfieldwells) -* **Legend**: [LegendOptions](#legendoptions) -* **MapStyleOptions**: [GeospatialMapStyleOptions](#geospatialmapstyleoptions) -* **SortConfiguration**: [FilledMapSortConfiguration](#filledmapsortconfiguration) -* **Tooltip**: [TooltipOptions](#tooltipoptions) -* **WindowOptions**: [GeospatialWindowOptions](#geospatialwindowoptions) +* **DefaultValues**: [IntegerDefaultValues](#integerdefaultvalues) +* **MappedDataSetParameters**: [MappedDataSetParameter](#mappeddatasetparameter)[] +* **Name**: string (Required) +* **ParameterValueType**: string (Required) +* **ValueWhenUnset**: [IntegerValueWhenUnsetConfiguration](#integervaluewhenunsetconfiguration) -## FilledMapFieldWells +## IntegerParameterDeclaration ### Properties -* **FilledMapAggregatedFieldWells**: [FilledMapAggregatedFieldWells](#filledmapaggregatedfieldwells) +* **DefaultValues**: [IntegerDefaultValues](#integerdefaultvalues) +* **MappedDataSetParameters**: [MappedDataSetParameter](#mappeddatasetparameter)[] +* **Name**: string (Required) +* **ParameterValueType**: string (Required) +* **ValueWhenUnset**: [IntegerValueWhenUnsetConfiguration](#integervaluewhenunsetconfiguration) -## FilledMapAggregatedFieldWells +## IntegerParameterDeclaration ### Properties -* **Geospatial**: [DimensionField](#dimensionfield)[] -* **Values**: [MeasureField](#measurefield)[] +* **DefaultValues**: [IntegerDefaultValues](#integerdefaultvalues) +* **MappedDataSetParameters**: [MappedDataSetParameter](#mappeddatasetparameter)[] +* **Name**: string (Required) +* **ParameterValueType**: string (Required) +* **ValueWhenUnset**: [IntegerValueWhenUnsetConfiguration](#integervaluewhenunsetconfiguration) -## GeospatialMapStyleOptions +## IntegerValueWhenUnsetConfiguration ### Properties -* **BaseMapStyle**: string +* **CustomValue**: int +* **ValueWhenUnsetOption**: string -## FilledMapSortConfiguration +## IntegerValueWhenUnsetConfiguration ### Properties -* **CategorySort**: [FieldSortOptions](#fieldsortoptions)[] +* **CustomValue**: int +* **ValueWhenUnsetOption**: string -## GeospatialWindowOptions +## IntegerValueWhenUnsetConfiguration ### Properties -* **Bounds**: [GeospatialCoordinateBounds](#geospatialcoordinatebounds) -* **MapZoomMode**: string +* **CustomValue**: int +* **ValueWhenUnsetOption**: string -## GeospatialCoordinateBounds +## ItemsLimitConfiguration ### Properties -* **East**: int (Required) -* **North**: int (Required) -* **South**: int (Required) -* **West**: int (Required) +* **ItemsLimit**: int +* **OtherCategories**: string -## FilledMapConditionalFormatting +## ItemsLimitConfiguration ### Properties -* **ConditionalFormattingOptions**: [FilledMapConditionalFormattingOption](#filledmapconditionalformattingoption)[] (Required) +* **ItemsLimit**: int +* **OtherCategories**: string -## FilledMapConditionalFormattingOption +## ItemsLimitConfiguration ### Properties -* **Shape**: [FilledMapShapeConditionalFormatting](#filledmapshapeconditionalformatting) (Required) +* **ItemsLimit**: int +* **OtherCategories**: string -## FilledMapShapeConditionalFormatting +## KPIActualValueConditionalFormatting ### Properties -* **FieldId**: string (Required) -* **Format**: [ShapeConditionalFormat](#shapeconditionalformat) +* **Icon**: [ConditionalFormattingIcon](#conditionalformattingicon) +* **TextColor**: [ConditionalFormattingColor](#conditionalformattingcolor) + +## KPIActualValueConditionalFormatting +### Properties +* **Icon**: [ConditionalFormattingIcon](#conditionalformattingicon) +* **TextColor**: [ConditionalFormattingColor](#conditionalformattingcolor) + +## KPIActualValueConditionalFormatting +### Properties +* **Icon**: [ConditionalFormattingIcon](#conditionalformattingicon) +* **TextColor**: [ConditionalFormattingColor](#conditionalformattingcolor) -## ShapeConditionalFormat +## KPIComparisonValueConditionalFormatting ### Properties -* **BackgroundColor**: [ConditionalFormattingColor](#conditionalformattingcolor) (Required) +* **Icon**: [ConditionalFormattingIcon](#conditionalformattingicon) +* **TextColor**: [ConditionalFormattingColor](#conditionalformattingcolor) -## ConditionalFormattingColor +## KPIComparisonValueConditionalFormatting ### Properties -* **Gradient**: [ConditionalFormattingGradientColor](#conditionalformattinggradientcolor) -* **Solid**: [ConditionalFormattingSolidColor](#conditionalformattingsolidcolor) +* **Icon**: [ConditionalFormattingIcon](#conditionalformattingicon) +* **TextColor**: [ConditionalFormattingColor](#conditionalformattingcolor) -## ConditionalFormattingGradientColor +## KPIComparisonValueConditionalFormatting ### Properties -* **Color**: [GradientColor](#gradientcolor) (Required) -* **Expression**: string (Required) +* **Icon**: [ConditionalFormattingIcon](#conditionalformattingicon) +* **TextColor**: [ConditionalFormattingColor](#conditionalformattingcolor) -## GradientColor +## KPIConditionalFormatting ### Properties -* **Stops**: [GradientStop](#gradientstop)[] +* **ConditionalFormattingOptions**: [KPIConditionalFormattingOption](#kpiconditionalformattingoption)[] -## GradientStop +## KPIConditionalFormatting ### Properties -* **Color**: string -* **DataValue**: int -* **GradientOffset**: int (Required) +* **ConditionalFormattingOptions**: [KPIConditionalFormattingOption](#kpiconditionalformattingoption)[] -## ConditionalFormattingSolidColor +## KPIConditionalFormatting ### Properties -* **Color**: string -* **Expression**: string (Required) +* **ConditionalFormattingOptions**: [KPIConditionalFormattingOption](#kpiconditionalformattingoption)[] -## FunnelChartVisual +## KPIConditionalFormattingOption ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [FunnelChartConfiguration](#funnelchartconfiguration) -* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] -* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) -* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) -* **VisualId**: string (Required) +* **ActualValue**: [KPIActualValueConditionalFormatting](#kpiactualvalueconditionalformatting) +* **ComparisonValue**: [KPIComparisonValueConditionalFormatting](#kpicomparisonvalueconditionalformatting) +* **PrimaryValue**: [KPIPrimaryValueConditionalFormatting](#kpiprimaryvalueconditionalformatting) +* **ProgressBar**: [KPIProgressBarConditionalFormatting](#kpiprogressbarconditionalformatting) -## FunnelChartConfiguration +## KPIConditionalFormattingOption ### Properties -* **CategoryLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **DataLabelOptions**: [FunnelChartDataLabelOptions](#funnelchartdatalabeloptions) -* **FieldWells**: [FunnelChartFieldWells](#funnelchartfieldwells) -* **SortConfiguration**: [FunnelChartSortConfiguration](#funnelchartsortconfiguration) -* **Tooltip**: [TooltipOptions](#tooltipoptions) -* **ValueLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **VisualPalette**: [VisualPalette](#visualpalette) +* **ActualValue**: [KPIActualValueConditionalFormatting](#kpiactualvalueconditionalformatting) +* **ComparisonValue**: [KPIComparisonValueConditionalFormatting](#kpicomparisonvalueconditionalformatting) +* **PrimaryValue**: [KPIPrimaryValueConditionalFormatting](#kpiprimaryvalueconditionalformatting) +* **ProgressBar**: [KPIProgressBarConditionalFormatting](#kpiprogressbarconditionalformatting) -## FunnelChartDataLabelOptions +## KPIConditionalFormattingOption ### Properties -* **CategoryLabelVisibility**: string -* **LabelColor**: string -* **LabelFontConfiguration**: [FontConfiguration](#fontconfiguration) -* **MeasureDataLabelStyle**: string -* **MeasureLabelVisibility**: string -* **Position**: string -* **Visibility**: string +* **ActualValue**: [KPIActualValueConditionalFormatting](#kpiactualvalueconditionalformatting) +* **ComparisonValue**: [KPIComparisonValueConditionalFormatting](#kpicomparisonvalueconditionalformatting) +* **PrimaryValue**: [KPIPrimaryValueConditionalFormatting](#kpiprimaryvalueconditionalformatting) +* **ProgressBar**: [KPIProgressBarConditionalFormatting](#kpiprogressbarconditionalformatting) -## FunnelChartFieldWells +## KPIConfiguration ### Properties -* **FunnelChartAggregatedFieldWells**: [FunnelChartAggregatedFieldWells](#funnelchartaggregatedfieldwells) +* **FieldWells**: [KPIFieldWells](#kpifieldwells) +* **KPIOptions**: [KPIOptions](#kpioptions) +* **SortConfiguration**: [KPISortConfiguration](#kpisortconfiguration) -## FunnelChartAggregatedFieldWells +## KPIConfiguration ### Properties -* **Category**: [DimensionField](#dimensionfield)[] -* **Values**: [MeasureField](#measurefield)[] +* **FieldWells**: [KPIFieldWells](#kpifieldwells) +* **KPIOptions**: [KPIOptions](#kpioptions) +* **SortConfiguration**: [KPISortConfiguration](#kpisortconfiguration) -## FunnelChartSortConfiguration +## KPIConfiguration ### Properties -* **CategoryItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) -* **CategorySort**: [FieldSortOptions](#fieldsortoptions)[] +* **FieldWells**: [KPIFieldWells](#kpifieldwells) +* **KPIOptions**: [KPIOptions](#kpioptions) +* **SortConfiguration**: [KPISortConfiguration](#kpisortconfiguration) -## GaugeChartVisual +## KPIFieldWells ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [GaugeChartConfiguration](#gaugechartconfiguration) -* **ConditionalFormatting**: [GaugeChartConditionalFormatting](#gaugechartconditionalformatting) -* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) -* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) -* **VisualId**: string (Required) +* **TargetValues**: [MeasureField](#measurefield)[] +* **TrendGroups**: [DimensionField](#dimensionfield)[] +* **Values**: [MeasureField](#measurefield)[] -## GaugeChartConfiguration +## KPIFieldWells ### Properties -* **DataLabels**: [DataLabelOptions](#datalabeloptions) -* **FieldWells**: [GaugeChartFieldWells](#gaugechartfieldwells) -* **GaugeChartOptions**: [GaugeChartOptions](#gaugechartoptions) -* **TooltipOptions**: [TooltipOptions](#tooltipoptions) -* **VisualPalette**: [VisualPalette](#visualpalette) +* **TargetValues**: [MeasureField](#measurefield)[] +* **TrendGroups**: [DimensionField](#dimensionfield)[] +* **Values**: [MeasureField](#measurefield)[] -## GaugeChartFieldWells +## KPIFieldWells ### Properties * **TargetValues**: [MeasureField](#measurefield)[] +* **TrendGroups**: [DimensionField](#dimensionfield)[] * **Values**: [MeasureField](#measurefield)[] -## GaugeChartOptions +## KPIOptions ### Properties -* **Arc**: [ArcConfiguration](#arcconfiguration) -* **ArcAxis**: [ArcAxisConfiguration](#arcaxisconfiguration) * **Comparison**: [ComparisonConfiguration](#comparisonconfiguration) * **PrimaryValueDisplayType**: string * **PrimaryValueFontConfiguration**: [FontConfiguration](#fontconfiguration) +* **ProgressBar**: [ProgressBarOptions](#progressbaroptions) +* **SecondaryValue**: [SecondaryValueOptions](#secondaryvalueoptions) +* **SecondaryValueFontConfiguration**: [FontConfiguration](#fontconfiguration) +* **Sparkline**: [KPISparklineOptions](#kpisparklineoptions) +* **TrendArrows**: [TrendArrowOptions](#trendarrowoptions) +* **VisualLayoutOptions**: [KPIVisualLayoutOptions](#kpivisuallayoutoptions) -## ArcConfiguration +## KPIOptions ### Properties -* **ArcAngle**: int -* **ArcThickness**: string +* **Comparison**: [ComparisonConfiguration](#comparisonconfiguration) +* **PrimaryValueDisplayType**: string +* **PrimaryValueFontConfiguration**: [FontConfiguration](#fontconfiguration) +* **ProgressBar**: [ProgressBarOptions](#progressbaroptions) +* **SecondaryValue**: [SecondaryValueOptions](#secondaryvalueoptions) +* **SecondaryValueFontConfiguration**: [FontConfiguration](#fontconfiguration) +* **Sparkline**: [KPISparklineOptions](#kpisparklineoptions) +* **TrendArrows**: [TrendArrowOptions](#trendarrowoptions) +* **VisualLayoutOptions**: [KPIVisualLayoutOptions](#kpivisuallayoutoptions) -## ArcAxisConfiguration +## KPIOptions ### Properties -* **Range**: [ArcAxisDisplayRange](#arcaxisdisplayrange) -* **ReserveRange**: int +* **Comparison**: [ComparisonConfiguration](#comparisonconfiguration) +* **PrimaryValueDisplayType**: string +* **PrimaryValueFontConfiguration**: [FontConfiguration](#fontconfiguration) +* **ProgressBar**: [ProgressBarOptions](#progressbaroptions) +* **SecondaryValue**: [SecondaryValueOptions](#secondaryvalueoptions) +* **SecondaryValueFontConfiguration**: [FontConfiguration](#fontconfiguration) +* **Sparkline**: [KPISparklineOptions](#kpisparklineoptions) +* **TrendArrows**: [TrendArrowOptions](#trendarrowoptions) +* **VisualLayoutOptions**: [KPIVisualLayoutOptions](#kpivisuallayoutoptions) -## ArcAxisDisplayRange +## KPIPrimaryValueConditionalFormatting ### Properties -* **Max**: int -* **Min**: int +* **Icon**: [ConditionalFormattingIcon](#conditionalformattingicon) +* **TextColor**: [ConditionalFormattingColor](#conditionalformattingcolor) -## ComparisonConfiguration +## KPIPrimaryValueConditionalFormatting ### Properties -* **ComparisonFormat**: [ComparisonFormatConfiguration](#comparisonformatconfiguration) -* **ComparisonMethod**: string +* **Icon**: [ConditionalFormattingIcon](#conditionalformattingicon) +* **TextColor**: [ConditionalFormattingColor](#conditionalformattingcolor) -## ComparisonFormatConfiguration +## KPIPrimaryValueConditionalFormatting ### Properties -* **NumberDisplayFormatConfiguration**: [NumberDisplayFormatConfiguration](#numberdisplayformatconfiguration) -* **PercentageDisplayFormatConfiguration**: [PercentageDisplayFormatConfiguration](#percentagedisplayformatconfiguration) +* **Icon**: [ConditionalFormattingIcon](#conditionalformattingicon) +* **TextColor**: [ConditionalFormattingColor](#conditionalformattingcolor) -## GaugeChartConditionalFormatting +## KPIProgressBarConditionalFormatting ### Properties -* **ConditionalFormattingOptions**: [GaugeChartConditionalFormattingOption](#gaugechartconditionalformattingoption)[] +* **ForegroundColor**: [ConditionalFormattingColor](#conditionalformattingcolor) -## GaugeChartConditionalFormattingOption +## KPIProgressBarConditionalFormatting ### Properties -* **Arc**: [GaugeChartArcConditionalFormatting](#gaugechartarcconditionalformatting) -* **PrimaryValue**: [GaugeChartPrimaryValueConditionalFormatting](#gaugechartprimaryvalueconditionalformatting) +* **ForegroundColor**: [ConditionalFormattingColor](#conditionalformattingcolor) -## GaugeChartArcConditionalFormatting +## KPIProgressBarConditionalFormatting ### Properties * **ForegroundColor**: [ConditionalFormattingColor](#conditionalformattingcolor) -## GaugeChartPrimaryValueConditionalFormatting +## KPISortConfiguration ### Properties -* **Icon**: [ConditionalFormattingIcon](#conditionalformattingicon) -* **TextColor**: [ConditionalFormattingColor](#conditionalformattingcolor) +* **TrendGroupSort**: [FieldSortOptions](#fieldsortoptions)[] -## ConditionalFormattingIcon +## KPISortConfiguration ### Properties -* **CustomCondition**: [ConditionalFormattingCustomIconCondition](#conditionalformattingcustomiconcondition) -* **IconSet**: [ConditionalFormattingIconSet](#conditionalformattingiconset) +* **TrendGroupSort**: [FieldSortOptions](#fieldsortoptions)[] -## ConditionalFormattingCustomIconCondition +## KPISortConfiguration +### Properties +* **TrendGroupSort**: [FieldSortOptions](#fieldsortoptions)[] + +## KPISparklineOptions ### Properties * **Color**: string -* **DisplayConfiguration**: [ConditionalFormattingIconDisplayConfiguration](#conditionalformattingicondisplayconfiguration) -* **Expression**: string (Required) -* **IconOptions**: [ConditionalFormattingCustomIconOptions](#conditionalformattingcustomiconoptions) (Required) +* **TooltipVisibility**: string +* **Type**: string (Required) +* **Visibility**: string -## ConditionalFormattingIconDisplayConfiguration +## KPISparklineOptions ### Properties -* **IconDisplayOption**: string +* **Color**: string +* **TooltipVisibility**: string +* **Type**: string (Required) +* **Visibility**: string -## ConditionalFormattingCustomIconOptions +## KPISparklineOptions +### Properties +* **Color**: string +* **TooltipVisibility**: string +* **Type**: string (Required) +* **Visibility**: string + +## KPIVisual +### Properties +* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **ChartConfiguration**: [KPIConfiguration](#kpiconfiguration) +* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] +* **ConditionalFormatting**: [KPIConditionalFormatting](#kpiconditionalformatting) +* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) +* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) +* **VisualId**: string (Required) + +## KPIVisual +### Properties +* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **ChartConfiguration**: [KPIConfiguration](#kpiconfiguration) +* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] +* **ConditionalFormatting**: [KPIConditionalFormatting](#kpiconditionalformatting) +* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) +* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) +* **VisualId**: string (Required) + +## KPIVisual +### Properties +* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **ChartConfiguration**: [KPIConfiguration](#kpiconfiguration) +* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] +* **ConditionalFormatting**: [KPIConditionalFormatting](#kpiconditionalformatting) +* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) +* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) +* **VisualId**: string (Required) + +## KPIVisualLayoutOptions +### Properties +* **StandardLayout**: [KPIVisualStandardLayout](#kpivisualstandardlayout) + +## KPIVisualLayoutOptions +### Properties +* **StandardLayout**: [KPIVisualStandardLayout](#kpivisualstandardlayout) + +## KPIVisualLayoutOptions ### Properties -* **Icon**: string -* **UnicodeIcon**: string +* **StandardLayout**: [KPIVisualStandardLayout](#kpivisualstandardlayout) -## ConditionalFormattingIconSet +## KPIVisualStandardLayout ### Properties -* **Expression**: string (Required) -* **IconSetType**: string +* **Type**: string (Required) -## GeospatialMapVisual +## KPIVisualStandardLayout ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [GeospatialMapConfiguration](#geospatialmapconfiguration) -* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] -* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) -* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) -* **VisualId**: string (Required) +* **Type**: string (Required) -## GeospatialMapConfiguration +## KPIVisualStandardLayout ### Properties -* **FieldWells**: [GeospatialMapFieldWells](#geospatialmapfieldwells) -* **Legend**: [LegendOptions](#legendoptions) -* **MapStyleOptions**: [GeospatialMapStyleOptions](#geospatialmapstyleoptions) -* **PointStyleOptions**: [GeospatialPointStyleOptions](#geospatialpointstyleoptions) -* **Tooltip**: [TooltipOptions](#tooltipoptions) -* **VisualPalette**: [VisualPalette](#visualpalette) -* **WindowOptions**: [GeospatialWindowOptions](#geospatialwindowoptions) +* **Type**: string (Required) -## GeospatialMapFieldWells +## LabelOptions ### Properties -* **GeospatialMapAggregatedFieldWells**: [GeospatialMapAggregatedFieldWells](#geospatialmapaggregatedfieldwells) +* **CustomLabel**: string +* **FontConfiguration**: [FontConfiguration](#fontconfiguration) +* **Visibility**: string -## GeospatialMapAggregatedFieldWells +## LabelOptions ### Properties -* **Colors**: [DimensionField](#dimensionfield)[] -* **Geospatial**: [DimensionField](#dimensionfield)[] -* **Values**: [MeasureField](#measurefield)[] +* **CustomLabel**: string +* **FontConfiguration**: [FontConfiguration](#fontconfiguration) +* **Visibility**: string -## GeospatialPointStyleOptions +## LabelOptions ### Properties -* **ClusterMarkerConfiguration**: [ClusterMarkerConfiguration](#clustermarkerconfiguration) -* **HeatmapConfiguration**: [GeospatialHeatmapConfiguration](#geospatialheatmapconfiguration) -* **SelectedPointStyle**: string +* **CustomLabel**: string +* **FontConfiguration**: [FontConfiguration](#fontconfiguration) +* **Visibility**: string -## ClusterMarkerConfiguration +## Layout ### Properties -* **ClusterMarker**: [ClusterMarker](#clustermarker) +* **Configuration**: [LayoutConfiguration](#layoutconfiguration) (Required) -## ClusterMarker +## Layout ### Properties -* **SimpleClusterMarker**: [SimpleClusterMarker](#simpleclustermarker) +* **Configuration**: [LayoutConfiguration](#layoutconfiguration) (Required) -## SimpleClusterMarker +## Layout ### Properties -* **Color**: string +* **Configuration**: [LayoutConfiguration](#layoutconfiguration) (Required) -## GeospatialHeatmapConfiguration +## LayoutConfiguration ### Properties -* **HeatmapColor**: [GeospatialHeatmapColorScale](#geospatialheatmapcolorscale) +* **FreeFormLayout**: [FreeFormLayoutConfiguration](#freeformlayoutconfiguration) +* **GridLayout**: [GridLayoutConfiguration](#gridlayoutconfiguration) +* **SectionBasedLayout**: [SectionBasedLayoutConfiguration](#sectionbasedlayoutconfiguration) -## GeospatialHeatmapColorScale +## LayoutConfiguration ### Properties -* **Colors**: [GeospatialHeatmapDataColor](#geospatialheatmapdatacolor)[] +* **FreeFormLayout**: [FreeFormLayoutConfiguration](#freeformlayoutconfiguration) +* **GridLayout**: [GridLayoutConfiguration](#gridlayoutconfiguration) +* **SectionBasedLayout**: [SectionBasedLayoutConfiguration](#sectionbasedlayoutconfiguration) -## GeospatialHeatmapDataColor +## LayoutConfiguration ### Properties -* **Color**: string (Required) +* **FreeFormLayout**: [FreeFormLayoutConfiguration](#freeformlayoutconfiguration) +* **GridLayout**: [GridLayoutConfiguration](#gridlayoutconfiguration) +* **SectionBasedLayout**: [SectionBasedLayoutConfiguration](#sectionbasedlayoutconfiguration) -## HeatMapVisual +## LegendOptions ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [HeatMapConfiguration](#heatmapconfiguration) -* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] -* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) -* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) -* **VisualId**: string (Required) +* **Height**: string: String based length that is composed of value and unit in px +* **Position**: string +* **Title**: [LabelOptions](#labeloptions) +* **Visibility**: string +* **Width**: string: String based length that is composed of value and unit in px -## HeatMapConfiguration +## LegendOptions ### Properties -* **ColorScale**: [ColorScale](#colorscale) -* **ColumnLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **DataLabels**: [DataLabelOptions](#datalabeloptions) -* **FieldWells**: [HeatMapFieldWells](#heatmapfieldwells) -* **Legend**: [LegendOptions](#legendoptions) -* **RowLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **SortConfiguration**: [HeatMapSortConfiguration](#heatmapsortconfiguration) -* **Tooltip**: [TooltipOptions](#tooltipoptions) +* **Height**: string: String based length that is composed of value and unit in px +* **Position**: string +* **Title**: [LabelOptions](#labeloptions) +* **Visibility**: string +* **Width**: string: String based length that is composed of value and unit in px -## ColorScale +## LegendOptions ### Properties -* **ColorFillType**: string (Required) -* **Colors**: [DataColor](#datacolor)[] (Required) -* **NullValueColor**: [DataColor](#datacolor) +* **Height**: string: String based length that is composed of value and unit in px +* **Position**: string +* **Title**: [LabelOptions](#labeloptions) +* **Visibility**: string +* **Width**: string: String based length that is composed of value and unit in px -## DataColor +## LineChartAggregatedFieldWells ### Properties -* **Color**: string -* **DataValue**: int +* **Category**: [DimensionField](#dimensionfield)[] +* **Colors**: [DimensionField](#dimensionfield)[] +* **SmallMultiples**: [DimensionField](#dimensionfield)[] +* **Values**: [MeasureField](#measurefield)[] -## HeatMapFieldWells +## LineChartAggregatedFieldWells ### Properties -* **HeatMapAggregatedFieldWells**: [HeatMapAggregatedFieldWells](#heatmapaggregatedfieldwells) +* **Category**: [DimensionField](#dimensionfield)[] +* **Colors**: [DimensionField](#dimensionfield)[] +* **SmallMultiples**: [DimensionField](#dimensionfield)[] +* **Values**: [MeasureField](#measurefield)[] -## HeatMapAggregatedFieldWells +## LineChartAggregatedFieldWells ### Properties -* **Columns**: [DimensionField](#dimensionfield)[] -* **Rows**: [DimensionField](#dimensionfield)[] +* **Category**: [DimensionField](#dimensionfield)[] +* **Colors**: [DimensionField](#dimensionfield)[] +* **SmallMultiples**: [DimensionField](#dimensionfield)[] * **Values**: [MeasureField](#measurefield)[] -## HeatMapSortConfiguration +## LineChartConfiguration ### Properties -* **HeatMapColumnItemsLimitConfiguration**: [ItemsLimitConfiguration](#itemslimitconfiguration) -* **HeatMapColumnSort**: [FieldSortOptions](#fieldsortoptions)[] -* **HeatMapRowItemsLimitConfiguration**: [ItemsLimitConfiguration](#itemslimitconfiguration) -* **HeatMapRowSort**: [FieldSortOptions](#fieldsortoptions)[] +* **ContributionAnalysisDefaults**: [ContributionAnalysisDefault](#contributionanalysisdefault)[] +* **DataLabels**: [DataLabelOptions](#datalabeloptions) +* **DefaultSeriesSettings**: [LineChartDefaultSeriesSettings](#linechartdefaultseriessettings) +* **FieldWells**: [LineChartFieldWells](#linechartfieldwells) +* **ForecastConfigurations**: [ForecastConfiguration](#forecastconfiguration)[] +* **Legend**: [LegendOptions](#legendoptions) +* **PrimaryYAxisDisplayOptions**: [LineSeriesAxisDisplayOptions](#lineseriesaxisdisplayoptions) +* **PrimaryYAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **ReferenceLines**: [ReferenceLine](#referenceline)[] +* **SecondaryYAxisDisplayOptions**: [LineSeriesAxisDisplayOptions](#lineseriesaxisdisplayoptions) +* **SecondaryYAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **Series**: [SeriesItem](#seriesitem)[] +* **SmallMultiplesOptions**: [SmallMultiplesOptions](#smallmultiplesoptions) +* **SortConfiguration**: [LineChartSortConfiguration](#linechartsortconfiguration) +* **Tooltip**: [TooltipOptions](#tooltipoptions) +* **Type**: string +* **VisualPalette**: [VisualPalette](#visualpalette) +* **XAxisDisplayOptions**: [AxisDisplayOptions](#axisdisplayoptions) +* **XAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -## HistogramVisual +## LineChartConfiguration ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [HistogramConfiguration](#histogramconfiguration) -* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) -* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) -* **VisualId**: string (Required) +* **ContributionAnalysisDefaults**: [ContributionAnalysisDefault](#contributionanalysisdefault)[] +* **DataLabels**: [DataLabelOptions](#datalabeloptions) +* **DefaultSeriesSettings**: [LineChartDefaultSeriesSettings](#linechartdefaultseriessettings) +* **FieldWells**: [LineChartFieldWells](#linechartfieldwells) +* **ForecastConfigurations**: [ForecastConfiguration](#forecastconfiguration)[] +* **Legend**: [LegendOptions](#legendoptions) +* **PrimaryYAxisDisplayOptions**: [LineSeriesAxisDisplayOptions](#lineseriesaxisdisplayoptions) +* **PrimaryYAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **ReferenceLines**: [ReferenceLine](#referenceline)[] +* **SecondaryYAxisDisplayOptions**: [LineSeriesAxisDisplayOptions](#lineseriesaxisdisplayoptions) +* **SecondaryYAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **Series**: [SeriesItem](#seriesitem)[] +* **SmallMultiplesOptions**: [SmallMultiplesOptions](#smallmultiplesoptions) +* **SortConfiguration**: [LineChartSortConfiguration](#linechartsortconfiguration) +* **Tooltip**: [TooltipOptions](#tooltipoptions) +* **Type**: string +* **VisualPalette**: [VisualPalette](#visualpalette) +* **XAxisDisplayOptions**: [AxisDisplayOptions](#axisdisplayoptions) +* **XAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -## HistogramConfiguration +## LineChartConfiguration ### Properties -* **BinOptions**: [HistogramBinOptions](#histogrambinoptions) +* **ContributionAnalysisDefaults**: [ContributionAnalysisDefault](#contributionanalysisdefault)[] * **DataLabels**: [DataLabelOptions](#datalabeloptions) -* **FieldWells**: [HistogramFieldWells](#histogramfieldwells) +* **DefaultSeriesSettings**: [LineChartDefaultSeriesSettings](#linechartdefaultseriessettings) +* **FieldWells**: [LineChartFieldWells](#linechartfieldwells) +* **ForecastConfigurations**: [ForecastConfiguration](#forecastconfiguration)[] +* **Legend**: [LegendOptions](#legendoptions) +* **PrimaryYAxisDisplayOptions**: [LineSeriesAxisDisplayOptions](#lineseriesaxisdisplayoptions) +* **PrimaryYAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **ReferenceLines**: [ReferenceLine](#referenceline)[] +* **SecondaryYAxisDisplayOptions**: [LineSeriesAxisDisplayOptions](#lineseriesaxisdisplayoptions) +* **SecondaryYAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **Series**: [SeriesItem](#seriesitem)[] +* **SmallMultiplesOptions**: [SmallMultiplesOptions](#smallmultiplesoptions) +* **SortConfiguration**: [LineChartSortConfiguration](#linechartsortconfiguration) * **Tooltip**: [TooltipOptions](#tooltipoptions) +* **Type**: string * **VisualPalette**: [VisualPalette](#visualpalette) * **XAxisDisplayOptions**: [AxisDisplayOptions](#axisdisplayoptions) * **XAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **YAxisDisplayOptions**: [AxisDisplayOptions](#axisdisplayoptions) -## HistogramBinOptions +## LineChartDefaultSeriesSettings ### Properties -* **BinCount**: [BinCountOptions](#bincountoptions) -* **BinWidth**: [BinWidthOptions](#binwidthoptions) -* **SelectedBinType**: string -* **StartValue**: int +* **AxisBinding**: string +* **LineStyleSettings**: [LineChartLineStyleSettings](#linechartlinestylesettings) +* **MarkerStyleSettings**: [LineChartMarkerStyleSettings](#linechartmarkerstylesettings) -## BinCountOptions +## LineChartDefaultSeriesSettings ### Properties -* **Value**: int +* **AxisBinding**: string +* **LineStyleSettings**: [LineChartLineStyleSettings](#linechartlinestylesettings) +* **MarkerStyleSettings**: [LineChartMarkerStyleSettings](#linechartmarkerstylesettings) -## BinWidthOptions +## LineChartDefaultSeriesSettings ### Properties -* **BinCountLimit**: int -* **Value**: int +* **AxisBinding**: string +* **LineStyleSettings**: [LineChartLineStyleSettings](#linechartlinestylesettings) +* **MarkerStyleSettings**: [LineChartMarkerStyleSettings](#linechartmarkerstylesettings) -## HistogramFieldWells +## LineChartFieldWells ### Properties -* **HistogramAggregatedFieldWells**: [HistogramAggregatedFieldWells](#histogramaggregatedfieldwells) +* **LineChartAggregatedFieldWells**: [LineChartAggregatedFieldWells](#linechartaggregatedfieldwells) -## HistogramAggregatedFieldWells +## LineChartFieldWells ### Properties -* **Values**: [MeasureField](#measurefield)[] +* **LineChartAggregatedFieldWells**: [LineChartAggregatedFieldWells](#linechartaggregatedfieldwells) -## InsightVisual +## LineChartFieldWells ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **DataSetIdentifier**: string (Required) -* **InsightConfiguration**: [InsightConfiguration](#insightconfiguration) -* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) -* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) -* **VisualId**: string (Required) +* **LineChartAggregatedFieldWells**: [LineChartAggregatedFieldWells](#linechartaggregatedfieldwells) -## InsightConfiguration +## LineChartLineStyleSettings +### Properties +* **LineInterpolation**: string +* **LineStyle**: string +* **LineVisibility**: string +* **LineWidth**: string: String based length that is composed of value and unit in px + +## LineChartLineStyleSettings ### Properties -* **Computations**: [Computation](#computation)[] -* **CustomNarrative**: [CustomNarrativeOptions](#customnarrativeoptions) +* **LineInterpolation**: string +* **LineStyle**: string +* **LineVisibility**: string +* **LineWidth**: string: String based length that is composed of value and unit in px -## Computation +## LineChartLineStyleSettings ### Properties -* **Forecast**: [ForecastComputation](#forecastcomputation) -* **GrowthRate**: [GrowthRateComputation](#growthratecomputation) -* **MaximumMinimum**: [MaximumMinimumComputation](#maximumminimumcomputation) -* **MetricComparison**: [MetricComparisonComputation](#metriccomparisoncomputation) -* **PeriodOverPeriod**: [PeriodOverPeriodComputation](#periodoverperiodcomputation) -* **PeriodToDate**: [PeriodToDateComputation](#periodtodatecomputation) -* **TopBottomMovers**: [TopBottomMoversComputation](#topbottommoverscomputation) -* **TopBottomRanked**: [TopBottomRankedComputation](#topbottomrankedcomputation) -* **TotalAggregation**: [TotalAggregationComputation](#totalaggregationcomputation) -* **UniqueValues**: [UniqueValuesComputation](#uniquevaluescomputation) +* **LineInterpolation**: string +* **LineStyle**: string +* **LineVisibility**: string +* **LineWidth**: string: String based length that is composed of value and unit in px -## ForecastComputation +## LineChartMarkerStyleSettings ### Properties -* **ComputationId**: string (Required) -* **CustomSeasonalityValue**: int -* **LowerBoundary**: int -* **Name**: string -* **PeriodsBackward**: int -* **PeriodsForward**: int -* **PredictionInterval**: int -* **Seasonality**: string -* **Time**: [DimensionField](#dimensionfield) -* **UpperBoundary**: int -* **Value**: [MeasureField](#measurefield) +* **MarkerColor**: string +* **MarkerShape**: string +* **MarkerSize**: string: String based length that is composed of value and unit in px +* **MarkerVisibility**: string -## GrowthRateComputation +## LineChartMarkerStyleSettings ### Properties -* **ComputationId**: string (Required) -* **Name**: string -* **PeriodSize**: int -* **Time**: [DimensionField](#dimensionfield) -* **Value**: [MeasureField](#measurefield) +* **MarkerColor**: string +* **MarkerShape**: string +* **MarkerSize**: string: String based length that is composed of value and unit in px +* **MarkerVisibility**: string -## MaximumMinimumComputation +## LineChartMarkerStyleSettings ### Properties -* **ComputationId**: string (Required) -* **Name**: string -* **Time**: [DimensionField](#dimensionfield) -* **Type**: string (Required) -* **Value**: [MeasureField](#measurefield) +* **MarkerColor**: string +* **MarkerShape**: string +* **MarkerSize**: string: String based length that is composed of value and unit in px +* **MarkerVisibility**: string -## MetricComparisonComputation +## LineChartSeriesSettings ### Properties -* **ComputationId**: string (Required) -* **FromValue**: [MeasureField](#measurefield) -* **Name**: string -* **TargetValue**: [MeasureField](#measurefield) -* **Time**: [DimensionField](#dimensionfield) +* **LineStyleSettings**: [LineChartLineStyleSettings](#linechartlinestylesettings) +* **MarkerStyleSettings**: [LineChartMarkerStyleSettings](#linechartmarkerstylesettings) -## PeriodOverPeriodComputation +## LineChartSeriesSettings ### Properties -* **ComputationId**: string (Required) -* **Name**: string -* **Time**: [DimensionField](#dimensionfield) -* **Value**: [MeasureField](#measurefield) +* **LineStyleSettings**: [LineChartLineStyleSettings](#linechartlinestylesettings) +* **MarkerStyleSettings**: [LineChartMarkerStyleSettings](#linechartmarkerstylesettings) -## PeriodToDateComputation +## LineChartSeriesSettings ### Properties -* **ComputationId**: string (Required) -* **Name**: string -* **PeriodTimeGranularity**: string -* **Time**: [DimensionField](#dimensionfield) -* **Value**: [MeasureField](#measurefield) +* **LineStyleSettings**: [LineChartLineStyleSettings](#linechartlinestylesettings) +* **MarkerStyleSettings**: [LineChartMarkerStyleSettings](#linechartmarkerstylesettings) -## TopBottomMoversComputation +## LineChartSortConfiguration ### Properties -* **Category**: [DimensionField](#dimensionfield) -* **ComputationId**: string (Required) -* **MoverSize**: int -* **Name**: string -* **SortOrder**: string -* **Time**: [DimensionField](#dimensionfield) -* **Type**: string (Required) -* **Value**: [MeasureField](#measurefield) +* **CategoryItemsLimitConfiguration**: [ItemsLimitConfiguration](#itemslimitconfiguration) +* **CategorySort**: [FieldSortOptions](#fieldsortoptions)[] +* **ColorItemsLimitConfiguration**: [ItemsLimitConfiguration](#itemslimitconfiguration) +* **SmallMultiplesLimitConfiguration**: [ItemsLimitConfiguration](#itemslimitconfiguration) +* **SmallMultiplesSort**: [FieldSortOptions](#fieldsortoptions)[] -## TopBottomRankedComputation +## LineChartSortConfiguration ### Properties -* **Category**: [DimensionField](#dimensionfield) -* **ComputationId**: string (Required) -* **Name**: string -* **ResultSize**: int -* **Type**: string (Required) -* **Value**: [MeasureField](#measurefield) +* **CategoryItemsLimitConfiguration**: [ItemsLimitConfiguration](#itemslimitconfiguration) +* **CategorySort**: [FieldSortOptions](#fieldsortoptions)[] +* **ColorItemsLimitConfiguration**: [ItemsLimitConfiguration](#itemslimitconfiguration) +* **SmallMultiplesLimitConfiguration**: [ItemsLimitConfiguration](#itemslimitconfiguration) +* **SmallMultiplesSort**: [FieldSortOptions](#fieldsortoptions)[] -## TotalAggregationComputation +## LineChartSortConfiguration ### Properties -* **ComputationId**: string (Required) -* **Name**: string -* **Value**: [MeasureField](#measurefield) +* **CategoryItemsLimitConfiguration**: [ItemsLimitConfiguration](#itemslimitconfiguration) +* **CategorySort**: [FieldSortOptions](#fieldsortoptions)[] +* **ColorItemsLimitConfiguration**: [ItemsLimitConfiguration](#itemslimitconfiguration) +* **SmallMultiplesLimitConfiguration**: [ItemsLimitConfiguration](#itemslimitconfiguration) +* **SmallMultiplesSort**: [FieldSortOptions](#fieldsortoptions)[] -## UniqueValuesComputation +## LineChartVisual ### Properties -* **Category**: [DimensionField](#dimensionfield) -* **ComputationId**: string (Required) -* **Name**: string +* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **ChartConfiguration**: [LineChartConfiguration](#linechartconfiguration) +* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] +* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) +* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) +* **VisualId**: string (Required) -## CustomNarrativeOptions +## LineChartVisual ### Properties -* **Narrative**: string (Required) +* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **ChartConfiguration**: [LineChartConfiguration](#linechartconfiguration) +* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] +* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) +* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) +* **VisualId**: string (Required) -## KPIVisual +## LineChartVisual ### Properties * **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [KPIConfiguration](#kpiconfiguration) +* **ChartConfiguration**: [LineChartConfiguration](#linechartconfiguration) * **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] -* **ConditionalFormatting**: [KPIConditionalFormatting](#kpiconditionalformatting) * **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) * **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) * **VisualId**: string (Required) -## KPIConfiguration +## LineSeriesAxisDisplayOptions ### Properties -* **FieldWells**: [KPIFieldWells](#kpifieldwells) -* **KPIOptions**: [KPIOptions](#kpioptions) -* **SortConfiguration**: [KPISortConfiguration](#kpisortconfiguration) +* **AxisOptions**: [AxisDisplayOptions](#axisdisplayoptions) +* **MissingDataConfigurations**: [MissingDataConfiguration](#missingdataconfiguration)[] -## KPIFieldWells +## LineSeriesAxisDisplayOptions ### Properties -* **TargetValues**: [MeasureField](#measurefield)[] -* **TrendGroups**: [DimensionField](#dimensionfield)[] -* **Values**: [MeasureField](#measurefield)[] +* **AxisOptions**: [AxisDisplayOptions](#axisdisplayoptions) +* **MissingDataConfigurations**: [MissingDataConfiguration](#missingdataconfiguration)[] -## KPIOptions +## LineSeriesAxisDisplayOptions ### Properties -* **Comparison**: [ComparisonConfiguration](#comparisonconfiguration) -* **PrimaryValueDisplayType**: string -* **PrimaryValueFontConfiguration**: [FontConfiguration](#fontconfiguration) -* **ProgressBar**: [ProgressBarOptions](#progressbaroptions) -* **SecondaryValue**: [SecondaryValueOptions](#secondaryvalueoptions) -* **SecondaryValueFontConfiguration**: [FontConfiguration](#fontconfiguration) -* **Sparkline**: [KPISparklineOptions](#kpisparklineoptions) -* **TrendArrows**: [TrendArrowOptions](#trendarrowoptions) -* **VisualLayoutOptions**: [KPIVisualLayoutOptions](#kpivisuallayoutoptions) +* **AxisOptions**: [AxisDisplayOptions](#axisdisplayoptions) +* **MissingDataConfigurations**: [MissingDataConfiguration](#missingdataconfiguration)[] -## ProgressBarOptions +## LinkSharingConfiguration ### Properties -* **Visibility**: string +* **Permissions**: [ResourcePermission](#resourcepermission)[] -## SecondaryValueOptions +## ListControlDisplayOptions ### Properties -* **Visibility**: string +* **InfoIconLabelOptions**: [SheetControlInfoIconLabelOptions](#sheetcontrolinfoiconlabeloptions) +* **SearchOptions**: [ListControlSearchOptions](#listcontrolsearchoptions) +* **SelectAllOptions**: [ListControlSelectAllOptions](#listcontrolselectalloptions) +* **TitleOptions**: [LabelOptions](#labeloptions) -## KPISparklineOptions +## ListControlDisplayOptions ### Properties -* **Color**: string -* **TooltipVisibility**: string -* **Type**: string (Required) -* **Visibility**: string +* **InfoIconLabelOptions**: [SheetControlInfoIconLabelOptions](#sheetcontrolinfoiconlabeloptions) +* **SearchOptions**: [ListControlSearchOptions](#listcontrolsearchoptions) +* **SelectAllOptions**: [ListControlSelectAllOptions](#listcontrolselectalloptions) +* **TitleOptions**: [LabelOptions](#labeloptions) -## TrendArrowOptions +## ListControlDisplayOptions ### Properties -* **Visibility**: string +* **InfoIconLabelOptions**: [SheetControlInfoIconLabelOptions](#sheetcontrolinfoiconlabeloptions) +* **SearchOptions**: [ListControlSearchOptions](#listcontrolsearchoptions) +* **SelectAllOptions**: [ListControlSelectAllOptions](#listcontrolselectalloptions) +* **TitleOptions**: [LabelOptions](#labeloptions) -## KPIVisualLayoutOptions +## ListControlSearchOptions ### Properties -* **StandardLayout**: [KPIVisualStandardLayout](#kpivisualstandardlayout) +* **Visibility**: string -## KPIVisualStandardLayout +## ListControlSearchOptions ### Properties -* **Type**: string (Required) +* **Visibility**: string -## KPISortConfiguration +## ListControlSearchOptions ### Properties -* **TrendGroupSort**: [FieldSortOptions](#fieldsortoptions)[] +* **Visibility**: string -## KPIConditionalFormatting +## ListControlSelectAllOptions ### Properties -* **ConditionalFormattingOptions**: [KPIConditionalFormattingOption](#kpiconditionalformattingoption)[] +* **Visibility**: string -## KPIConditionalFormattingOption +## ListControlSelectAllOptions ### Properties -* **ActualValue**: [KPIActualValueConditionalFormatting](#kpiactualvalueconditionalformatting) -* **ComparisonValue**: [KPIComparisonValueConditionalFormatting](#kpicomparisonvalueconditionalformatting) -* **PrimaryValue**: [KPIPrimaryValueConditionalFormatting](#kpiprimaryvalueconditionalformatting) -* **ProgressBar**: [KPIProgressBarConditionalFormatting](#kpiprogressbarconditionalformatting) +* **Visibility**: string -## KPIActualValueConditionalFormatting +## ListControlSelectAllOptions ### Properties -* **Icon**: [ConditionalFormattingIcon](#conditionalformattingicon) -* **TextColor**: [ConditionalFormattingColor](#conditionalformattingcolor) +* **Visibility**: string -## KPIComparisonValueConditionalFormatting +## LoadingAnimation ### Properties -* **Icon**: [ConditionalFormattingIcon](#conditionalformattingicon) -* **TextColor**: [ConditionalFormattingColor](#conditionalformattingcolor) +* **Visibility**: string -## KPIPrimaryValueConditionalFormatting +## LoadingAnimation ### Properties -* **Icon**: [ConditionalFormattingIcon](#conditionalformattingicon) -* **TextColor**: [ConditionalFormattingColor](#conditionalformattingcolor) +* **Visibility**: string -## KPIProgressBarConditionalFormatting +## LoadingAnimation ### Properties -* **ForegroundColor**: [ConditionalFormattingColor](#conditionalformattingcolor) +* **Visibility**: string -## LineChartVisual +## LocalNavigationConfiguration ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [LineChartConfiguration](#linechartconfiguration) -* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] -* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) -* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) -* **VisualId**: string (Required) +* **TargetSheetId**: string (Required) -## LineChartConfiguration +## LocalNavigationConfiguration ### Properties -* **ContributionAnalysisDefaults**: [ContributionAnalysisDefault](#contributionanalysisdefault)[] -* **DataLabels**: [DataLabelOptions](#datalabeloptions) -* **DefaultSeriesSettings**: [LineChartDefaultSeriesSettings](#linechartdefaultseriessettings) -* **FieldWells**: [LineChartFieldWells](#linechartfieldwells) -* **ForecastConfigurations**: [ForecastConfiguration](#forecastconfiguration)[] -* **Legend**: [LegendOptions](#legendoptions) -* **PrimaryYAxisDisplayOptions**: [LineSeriesAxisDisplayOptions](#lineseriesaxisdisplayoptions) -* **PrimaryYAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **ReferenceLines**: [ReferenceLine](#referenceline)[] -* **SecondaryYAxisDisplayOptions**: [LineSeriesAxisDisplayOptions](#lineseriesaxisdisplayoptions) -* **SecondaryYAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **Series**: [SeriesItem](#seriesitem)[] -* **SmallMultiplesOptions**: [SmallMultiplesOptions](#smallmultiplesoptions) -* **SortConfiguration**: [LineChartSortConfiguration](#linechartsortconfiguration) -* **Tooltip**: [TooltipOptions](#tooltipoptions) -* **Type**: string -* **VisualPalette**: [VisualPalette](#visualpalette) -* **XAxisDisplayOptions**: [AxisDisplayOptions](#axisdisplayoptions) -* **XAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **TargetSheetId**: string (Required) -## LineChartDefaultSeriesSettings +## LocalNavigationConfiguration ### Properties -* **AxisBinding**: string -* **LineStyleSettings**: [LineChartLineStyleSettings](#linechartlinestylesettings) -* **MarkerStyleSettings**: [LineChartMarkerStyleSettings](#linechartmarkerstylesettings) +* **TargetSheetId**: string (Required) -## LineChartLineStyleSettings +## LogicalTableMap ### Properties -* **LineInterpolation**: string -* **LineStyle**: string -* **LineVisibility**: string -* **LineWidth**: string: String based length that is composed of value and unit in px -## LineChartMarkerStyleSettings +## LongFormatText ### Properties -* **MarkerColor**: string -* **MarkerShape**: string -* **MarkerSize**: string: String based length that is composed of value and unit in px -* **MarkerVisibility**: string +* **PlainText**: string +* **RichText**: string -## LineChartFieldWells +## LongFormatText ### Properties -* **LineChartAggregatedFieldWells**: [LineChartAggregatedFieldWells](#linechartaggregatedfieldwells) +* **PlainText**: string +* **RichText**: string -## LineChartAggregatedFieldWells +## LongFormatText ### Properties -* **Category**: [DimensionField](#dimensionfield)[] -* **Colors**: [DimensionField](#dimensionfield)[] -* **SmallMultiples**: [DimensionField](#dimensionfield)[] -* **Values**: [MeasureField](#measurefield)[] +* **PlainText**: string +* **RichText**: string -## ForecastConfiguration +## LookbackWindow ### Properties -* **ForecastProperties**: [TimeBasedForecastProperties](#timebasedforecastproperties) -* **Scenario**: [ForecastScenario](#forecastscenario) +* **ColumnName**: string (Required):

The name of the lookback window column.

+* **Size**: int (Required):

The lookback window column size.

+* **SizeUnit**: string (Required) -## TimeBasedForecastProperties +## ManifestFileLocation ### Properties -* **LowerBoundary**: int -* **PeriodsBackward**: int -* **PeriodsForward**: int -* **PredictionInterval**: int -* **Seasonality**: int -* **UpperBoundary**: int +* **Bucket**: string (Required):

Amazon S3 bucket.

+* **Key**: string (Required):

Amazon S3 key that identifies an object.

-## ForecastScenario +## MappedDataSetParameter ### Properties -* **WhatIfPointScenario**: [WhatIfPointScenario](#whatifpointscenario) -* **WhatIfRangeScenario**: [WhatIfRangeScenario](#whatifrangescenario) +* **DataSetIdentifier**: string (Required) +* **DataSetParameterName**: string (Required) -## WhatIfPointScenario +## MappedDataSetParameter ### Properties -* **Date**: string (Required) -* **Value**: int (Required) +* **DataSetIdentifier**: string (Required) +* **DataSetParameterName**: string (Required) -## WhatIfRangeScenario +## MappedDataSetParameter ### Properties -* **EndDate**: string (Required) -* **StartDate**: string (Required) -* **Value**: int (Required) +* **DataSetIdentifier**: string (Required) +* **DataSetParameterName**: string (Required) -## LineSeriesAxisDisplayOptions +## MarginStyle ### Properties -* **AxisOptions**: [AxisDisplayOptions](#axisdisplayoptions) -* **MissingDataConfigurations**: [MissingDataConfiguration](#missingdataconfiguration)[] +* **Show**: bool:

This Boolean value controls whether to display sheet margins.

-## MissingDataConfiguration +## MariaDbParameters ### Properties -* **TreatmentOption**: string +* **Database**: string (Required):

Database.

+* **Host**: string (Required):

Host.

+* **Port**: int (Required):

Port.

-## SeriesItem +## MaximumLabelType ### Properties -* **DataFieldSeriesItem**: [DataFieldSeriesItem](#datafieldseriesitem) -* **FieldSeriesItem**: [FieldSeriesItem](#fieldseriesitem) +* **Visibility**: string -## DataFieldSeriesItem +## MaximumLabelType ### Properties -* **AxisBinding**: string (Required) -* **FieldId**: string (Required) -* **FieldValue**: string -* **Settings**: [LineChartSeriesSettings](#linechartseriessettings) +* **Visibility**: string -## LineChartSeriesSettings +## MaximumLabelType ### Properties -* **LineStyleSettings**: [LineChartLineStyleSettings](#linechartlinestylesettings) -* **MarkerStyleSettings**: [LineChartMarkerStyleSettings](#linechartmarkerstylesettings) +* **Visibility**: string -## FieldSeriesItem +## MaximumMinimumComputation ### Properties -* **AxisBinding**: string (Required) -* **FieldId**: string (Required) -* **Settings**: [LineChartSeriesSettings](#linechartseriessettings) +* **ComputationId**: string (Required) +* **Name**: string +* **Time**: [DimensionField](#dimensionfield) +* **Type**: string (Required) +* **Value**: [MeasureField](#measurefield) -## LineChartSortConfiguration +## MaximumMinimumComputation ### Properties -* **CategoryItemsLimitConfiguration**: [ItemsLimitConfiguration](#itemslimitconfiguration) -* **CategorySort**: [FieldSortOptions](#fieldsortoptions)[] -* **ColorItemsLimitConfiguration**: [ItemsLimitConfiguration](#itemslimitconfiguration) -* **SmallMultiplesLimitConfiguration**: [ItemsLimitConfiguration](#itemslimitconfiguration) -* **SmallMultiplesSort**: [FieldSortOptions](#fieldsortoptions)[] +* **ComputationId**: string (Required) +* **Name**: string +* **Time**: [DimensionField](#dimensionfield) +* **Type**: string (Required) +* **Value**: [MeasureField](#measurefield) -## PieChartVisual +## MaximumMinimumComputation ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [PieChartConfiguration](#piechartconfiguration) -* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] -* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) -* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) -* **VisualId**: string (Required) +* **ComputationId**: string (Required) +* **Name**: string +* **Time**: [DimensionField](#dimensionfield) +* **Type**: string (Required) +* **Value**: [MeasureField](#measurefield) -## PieChartConfiguration +## MeasureField ### Properties -* **CategoryLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **ContributionAnalysisDefaults**: [ContributionAnalysisDefault](#contributionanalysisdefault)[] -* **DataLabels**: [DataLabelOptions](#datalabeloptions) -* **DonutOptions**: [DonutOptions](#donutoptions) -* **FieldWells**: [PieChartFieldWells](#piechartfieldwells) -* **Legend**: [LegendOptions](#legendoptions) -* **SmallMultiplesOptions**: [SmallMultiplesOptions](#smallmultiplesoptions) -* **SortConfiguration**: [PieChartSortConfiguration](#piechartsortconfiguration) -* **Tooltip**: [TooltipOptions](#tooltipoptions) -* **ValueLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **VisualPalette**: [VisualPalette](#visualpalette) +* **CalculatedMeasureField**: [CalculatedMeasureField](#calculatedmeasurefield) +* **CategoricalMeasureField**: [CategoricalMeasureField](#categoricalmeasurefield) +* **DateMeasureField**: [DateMeasureField](#datemeasurefield) +* **NumericalMeasureField**: [NumericalMeasureField](#numericalmeasurefield) -## DonutOptions +## MeasureField ### Properties -* **ArcOptions**: [ArcOptions](#arcoptions) -* **DonutCenterOptions**: [DonutCenterOptions](#donutcenteroptions) +* **CalculatedMeasureField**: [CalculatedMeasureField](#calculatedmeasurefield) +* **CategoricalMeasureField**: [CategoricalMeasureField](#categoricalmeasurefield) +* **DateMeasureField**: [DateMeasureField](#datemeasurefield) +* **NumericalMeasureField**: [NumericalMeasureField](#numericalmeasurefield) -## ArcOptions +## MeasureField ### Properties -* **ArcThickness**: string +* **CalculatedMeasureField**: [CalculatedMeasureField](#calculatedmeasurefield) +* **CategoricalMeasureField**: [CategoricalMeasureField](#categoricalmeasurefield) +* **DateMeasureField**: [DateMeasureField](#datemeasurefield) +* **NumericalMeasureField**: [NumericalMeasureField](#numericalmeasurefield) -## DonutCenterOptions +## MetricComparisonComputation ### Properties -* **LabelVisibility**: string +* **ComputationId**: string (Required) +* **FromValue**: [MeasureField](#measurefield) +* **Name**: string +* **TargetValue**: [MeasureField](#measurefield) +* **Time**: [DimensionField](#dimensionfield) -## PieChartFieldWells +## MetricComparisonComputation ### Properties -* **PieChartAggregatedFieldWells**: [PieChartAggregatedFieldWells](#piechartaggregatedfieldwells) +* **ComputationId**: string (Required) +* **FromValue**: [MeasureField](#measurefield) +* **Name**: string +* **TargetValue**: [MeasureField](#measurefield) +* **Time**: [DimensionField](#dimensionfield) -## PieChartAggregatedFieldWells +## MetricComparisonComputation ### Properties -* **Category**: [DimensionField](#dimensionfield)[] -* **SmallMultiples**: [DimensionField](#dimensionfield)[] -* **Values**: [MeasureField](#measurefield)[] +* **ComputationId**: string (Required) +* **FromValue**: [MeasureField](#measurefield) +* **Name**: string +* **TargetValue**: [MeasureField](#measurefield) +* **Time**: [DimensionField](#dimensionfield) -## PieChartSortConfiguration +## MinimumLabelType ### Properties -* **CategoryItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) -* **CategorySort**: [FieldSortOptions](#fieldsortoptions)[] -* **SmallMultiplesLimitConfiguration**: [ItemsLimitConfiguration](#itemslimitconfiguration) -* **SmallMultiplesSort**: [FieldSortOptions](#fieldsortoptions)[] +* **Visibility**: string -## PivotTableVisual +## MinimumLabelType ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [PivotTableConfiguration](#pivottableconfiguration) -* **ConditionalFormatting**: [PivotTableConditionalFormatting](#pivottableconditionalformatting) -* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) -* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) -* **VisualId**: string (Required) +* **Visibility**: string -## PivotTableConfiguration +## MinimumLabelType ### Properties -* **FieldOptions**: [PivotTableFieldOptions](#pivottablefieldoptions) -* **FieldWells**: [PivotTableFieldWells](#pivottablefieldwells) -* **PaginatedReportOptions**: [PivotTablePaginatedReportOptions](#pivottablepaginatedreportoptions) -* **SortConfiguration**: [PivotTableSortConfiguration](#pivottablesortconfiguration) -* **TableOptions**: [PivotTableOptions](#pivottableoptions) -* **TotalOptions**: [PivotTableTotalOptions](#pivottabletotaloptions) +* **Visibility**: string -## PivotTableFieldOptions +## MissingDataConfiguration ### Properties -* **CollapseStateOptions**: [PivotTableFieldCollapseStateOption](#pivottablefieldcollapsestateoption)[] -* **DataPathOptions**: [PivotTableDataPathOption](#pivottabledatapathoption)[] -* **SelectedFieldOptions**: [PivotTableFieldOption](#pivottablefieldoption)[] +* **TreatmentOption**: string -## PivotTableFieldCollapseStateOption +## MissingDataConfiguration ### Properties -* **State**: string -* **Target**: [PivotTableFieldCollapseStateTarget](#pivottablefieldcollapsestatetarget) (Required) +* **TreatmentOption**: string -## PivotTableFieldCollapseStateTarget +## MissingDataConfiguration ### Properties -* **FieldDataPathValues**: [DataPathValue](#datapathvalue)[] -* **FieldId**: string +* **TreatmentOption**: string -## PivotTableDataPathOption +## MySqlParameters ### Properties -* **DataPathList**: [DataPathValue](#datapathvalue)[] (Required) -* **Width**: string: String based length that is composed of value and unit in px +* **Database**: string (Required):

Database.

+* **Host**: string (Required):

Host.

+* **Port**: int (Required):

Port.

-## PivotTableFieldOption +## NamedEntityDefinition ### Properties -* **CustomLabel**: string -* **FieldId**: string (Required) -* **Visibility**: string +* **FieldName**: string +* **Metric**: [NamedEntityDefinitionMetric](#namedentitydefinitionmetric) +* **PropertyName**: string +* **PropertyRole**: string +* **PropertyUsage**: string -## PivotTableFieldWells +## NamedEntityDefinitionMetric ### Properties -* **PivotTableAggregatedFieldWells**: [PivotTableAggregatedFieldWells](#pivottableaggregatedfieldwells) +* **Aggregation**: string +* **AggregationFunctionParameters**: [AggregationFunctionParameters](#aggregationfunctionparameters) -## PivotTableAggregatedFieldWells +## NegativeFormat ### Properties -* **Columns**: [DimensionField](#dimensionfield)[] -* **Rows**: [DimensionField](#dimensionfield)[] -* **Values**: [MeasureField](#measurefield)[] +* **Prefix**: string +* **Suffix**: string -## PivotTablePaginatedReportOptions +## NegativeValueConfiguration ### Properties -* **OverflowColumnHeaderVisibility**: string -* **VerticalOverflowVisibility**: string +* **DisplayMode**: string (Required) -## PivotTableSortConfiguration +## NegativeValueConfiguration ### Properties -* **FieldSortOptions**: [PivotFieldSortOptions](#pivotfieldsortoptions)[] +* **DisplayMode**: string (Required) -## PivotFieldSortOptions +## NegativeValueConfiguration ### Properties -* **FieldId**: string (Required) -* **SortBy**: [PivotTableSortBy](#pivottablesortby) (Required) +* **DisplayMode**: string (Required) -## PivotTableSortBy +## NetworkInterface ### Properties -* **Column**: [ColumnSort](#columnsort) -* **DataPath**: [DataPathSort](#datapathsort) -* **Field**: [FieldSort](#fieldsort) +* **AvailabilityZone**: string:

The availability zone that the network interface resides in.

+* **ErrorMessage**: string:

An error message.

+* **NetworkInterfaceId**: string:

The network interface ID.

+* **Status**: string +* **SubnetId**: string:

The subnet ID associated with the network interface.

-## DataPathSort +## NullValueFormatConfiguration ### Properties -* **Direction**: string (Required) -* **SortPaths**: [DataPathValue](#datapathvalue)[] (Required) +* **NullString**: string (Required) -## PivotTableOptions +## NullValueFormatConfiguration ### Properties -* **CellStyle**: [TableCellStyle](#tablecellstyle) -* **CollapsedRowDimensionsVisibility**: string -* **ColumnHeaderStyle**: [TableCellStyle](#tablecellstyle) -* **ColumnNamesVisibility**: string -* **DefaultCellWidth**: string: String based length that is composed of value and unit in px -* **MetricPlacement**: string -* **RowAlternateColorOptions**: [RowAlternateColorOptions](#rowalternatecoloroptions) -* **RowFieldNamesStyle**: [TableCellStyle](#tablecellstyle) -* **RowHeaderStyle**: [TableCellStyle](#tablecellstyle) -* **RowsLabelOptions**: [PivotTableRowsLabelOptions](#pivottablerowslabeloptions) -* **RowsLayout**: string -* **SingleMetricVisibility**: string -* **ToggleButtonsVisibility**: string +* **NullString**: string (Required) -## TableCellStyle +## NullValueFormatConfiguration ### Properties -* **BackgroundColor**: string -* **Border**: [GlobalTableBorderOptions](#globaltableborderoptions) -* **FontConfiguration**: [FontConfiguration](#fontconfiguration) -* **Height**: int -* **HorizontalTextAlignment**: string -* **TextWrap**: string -* **VerticalTextAlignment**: string -* **Visibility**: string +* **NullString**: string (Required) -## GlobalTableBorderOptions +## NumberDisplayFormatConfiguration ### Properties -* **SideSpecificBorder**: [TableSideBorderOptions](#tablesideborderoptions) -* **UniformBorder**: [TableBorderOptions](#tableborderoptions) +* **DecimalPlacesConfiguration**: [DecimalPlacesConfiguration](#decimalplacesconfiguration) +* **NegativeValueConfiguration**: [NegativeValueConfiguration](#negativevalueconfiguration) +* **NullValueFormatConfiguration**: [NullValueFormatConfiguration](#nullvalueformatconfiguration) +* **NumberScale**: string +* **Prefix**: string +* **SeparatorConfiguration**: [NumericSeparatorConfiguration](#numericseparatorconfiguration) +* **Suffix**: string -## TableSideBorderOptions +## NumberDisplayFormatConfiguration ### Properties -* **Bottom**: [TableBorderOptions](#tableborderoptions) -* **InnerHorizontal**: [TableBorderOptions](#tableborderoptions) -* **InnerVertical**: [TableBorderOptions](#tableborderoptions) -* **Left**: [TableBorderOptions](#tableborderoptions) -* **Right**: [TableBorderOptions](#tableborderoptions) -* **Top**: [TableBorderOptions](#tableborderoptions) +* **DecimalPlacesConfiguration**: [DecimalPlacesConfiguration](#decimalplacesconfiguration) +* **NegativeValueConfiguration**: [NegativeValueConfiguration](#negativevalueconfiguration) +* **NullValueFormatConfiguration**: [NullValueFormatConfiguration](#nullvalueformatconfiguration) +* **NumberScale**: string +* **Prefix**: string +* **SeparatorConfiguration**: [NumericSeparatorConfiguration](#numericseparatorconfiguration) +* **Suffix**: string -## TableBorderOptions +## NumberDisplayFormatConfiguration ### Properties -* **Color**: string -* **Style**: string -* **Thickness**: int +* **DecimalPlacesConfiguration**: [DecimalPlacesConfiguration](#decimalplacesconfiguration) +* **NegativeValueConfiguration**: [NegativeValueConfiguration](#negativevalueconfiguration) +* **NullValueFormatConfiguration**: [NullValueFormatConfiguration](#nullvalueformatconfiguration) +* **NumberScale**: string +* **Prefix**: string +* **SeparatorConfiguration**: [NumericSeparatorConfiguration](#numericseparatorconfiguration) +* **Suffix**: string -## RowAlternateColorOptions +## NumberFormatConfiguration ### Properties -* **RowAlternateColors**: string[] -* **Status**: string -* **UsePrimaryBackgroundColor**: string +* **FormatConfiguration**: [NumericFormatConfiguration](#numericformatconfiguration) -## PivotTableRowsLabelOptions +## NumberFormatConfiguration ### Properties -* **CustomLabel**: string -* **Visibility**: string +* **FormatConfiguration**: [NumericFormatConfiguration](#numericformatconfiguration) -## PivotTableTotalOptions +## NumberFormatConfiguration ### Properties -* **ColumnSubtotalOptions**: [SubtotalOptions](#subtotaloptions) -* **ColumnTotalOptions**: [PivotTotalOptions](#pivottotaloptions) -* **RowSubtotalOptions**: [SubtotalOptions](#subtotaloptions) -* **RowTotalOptions**: [PivotTotalOptions](#pivottotaloptions) +* **FormatConfiguration**: [NumericFormatConfiguration](#numericformatconfiguration) -## SubtotalOptions +## NumericalAggregationFunction ### Properties -* **CustomLabel**: string -* **FieldLevel**: string -* **FieldLevelOptions**: [PivotTableFieldSubtotalOptions](#pivottablefieldsubtotaloptions)[] -* **MetricHeaderCellStyle**: [TableCellStyle](#tablecellstyle) -* **StyleTargets**: [TableStyleTarget](#tablestyletarget)[] -* **TotalCellStyle**: [TableCellStyle](#tablecellstyle) -* **TotalsVisibility**: string -* **ValueCellStyle**: [TableCellStyle](#tablecellstyle) +* **PercentileAggregation**: [PercentileAggregation](#percentileaggregation) +* **SimpleNumericalAggregation**: string -## PivotTableFieldSubtotalOptions +## NumericalAggregationFunction ### Properties -* **FieldId**: string +* **PercentileAggregation**: [PercentileAggregation](#percentileaggregation) +* **SimpleNumericalAggregation**: string -## TableStyleTarget +## NumericalAggregationFunction ### Properties -* **CellType**: string (Required) +* **PercentileAggregation**: [PercentileAggregation](#percentileaggregation) +* **SimpleNumericalAggregation**: string -## PivotTotalOptions +## NumericalDimensionField ### Properties -* **CustomLabel**: string -* **MetricHeaderCellStyle**: [TableCellStyle](#tablecellstyle) -* **Placement**: string -* **ScrollStatus**: string -* **TotalAggregationOptions**: [TotalAggregationOption](#totalaggregationoption)[] -* **TotalCellStyle**: [TableCellStyle](#tablecellstyle) -* **TotalsVisibility**: string -* **ValueCellStyle**: [TableCellStyle](#tablecellstyle) +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) +* **FieldId**: string (Required) +* **FormatConfiguration**: [NumberFormatConfiguration](#numberformatconfiguration) +* **HierarchyId**: string -## TotalAggregationOption +## NumericalDimensionField ### Properties +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) * **FieldId**: string (Required) -* **TotalAggregationFunction**: [TotalAggregationFunction](#totalaggregationfunction) (Required) +* **FormatConfiguration**: [NumberFormatConfiguration](#numberformatconfiguration) +* **HierarchyId**: string -## TotalAggregationFunction +## NumericalDimensionField ### Properties -* **SimpleTotalAggregationFunction**: string +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) +* **FieldId**: string (Required) +* **FormatConfiguration**: [NumberFormatConfiguration](#numberformatconfiguration) +* **HierarchyId**: string -## PivotTableConditionalFormatting +## NumericalMeasureField ### Properties -* **ConditionalFormattingOptions**: [PivotTableConditionalFormattingOption](#pivottableconditionalformattingoption)[] +* **AggregationFunction**: [NumericalAggregationFunction](#numericalaggregationfunction) +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) +* **FieldId**: string (Required) +* **FormatConfiguration**: [NumberFormatConfiguration](#numberformatconfiguration) -## PivotTableConditionalFormattingOption +## NumericalMeasureField ### Properties -* **Cell**: [PivotTableCellConditionalFormatting](#pivottablecellconditionalformatting) +* **AggregationFunction**: [NumericalAggregationFunction](#numericalaggregationfunction) +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) +* **FieldId**: string (Required) +* **FormatConfiguration**: [NumberFormatConfiguration](#numberformatconfiguration) -## PivotTableCellConditionalFormatting +## NumericalMeasureField ### Properties +* **AggregationFunction**: [NumericalAggregationFunction](#numericalaggregationfunction) +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) * **FieldId**: string (Required) -* **Scope**: [PivotTableConditionalFormattingScope](#pivottableconditionalformattingscope) -* **Scopes**: [PivotTableConditionalFormattingScope](#pivottableconditionalformattingscope)[] -* **TextFormat**: [TextConditionalFormat](#textconditionalformat) +* **FormatConfiguration**: [NumberFormatConfiguration](#numberformatconfiguration) -## PivotTableConditionalFormattingScope +## NumericAxisOptions ### Properties -* **Role**: string +* **Range**: [AxisDisplayRange](#axisdisplayrange) +* **Scale**: [AxisScale](#axisscale) -## TextConditionalFormat +## NumericAxisOptions ### Properties -* **BackgroundColor**: [ConditionalFormattingColor](#conditionalformattingcolor) -* **Icon**: [ConditionalFormattingIcon](#conditionalformattingicon) -* **TextColor**: [ConditionalFormattingColor](#conditionalformattingcolor) +* **Range**: [AxisDisplayRange](#axisdisplayrange) +* **Scale**: [AxisScale](#axisscale) -## RadarChartVisual +## NumericAxisOptions ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [RadarChartConfiguration](#radarchartconfiguration) -* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] -* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) -* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) -* **VisualId**: string (Required) +* **Range**: [AxisDisplayRange](#axisdisplayrange) +* **Scale**: [AxisScale](#axisscale) -## RadarChartConfiguration +## NumericEqualityDrillDownFilter ### Properties -* **AlternateBandColorsVisibility**: string -* **AlternateBandEvenColor**: string -* **AlternateBandOddColor**: string -* **AxesRangeScale**: string -* **BaseSeriesSettings**: [RadarChartSeriesSettings](#radarchartseriessettings) -* **CategoryAxis**: [AxisDisplayOptions](#axisdisplayoptions) -* **CategoryLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **ColorAxis**: [AxisDisplayOptions](#axisdisplayoptions) -* **ColorLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **FieldWells**: [RadarChartFieldWells](#radarchartfieldwells) -* **Legend**: [LegendOptions](#legendoptions) -* **Shape**: string -* **SortConfiguration**: [RadarChartSortConfiguration](#radarchartsortconfiguration) -* **StartAngle**: int -* **VisualPalette**: [VisualPalette](#visualpalette) +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) +* **Value**: int (Required) -## RadarChartSeriesSettings +## NumericEqualityDrillDownFilter ### Properties -* **AreaStyleSettings**: [RadarChartAreaStyleSettings](#radarchartareastylesettings) +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) +* **Value**: int (Required) -## RadarChartAreaStyleSettings +## NumericEqualityDrillDownFilter ### Properties -* **Visibility**: string +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) +* **Value**: int (Required) -## RadarChartFieldWells +## NumericEqualityFilter ### Properties -* **RadarChartAggregatedFieldWells**: [RadarChartAggregatedFieldWells](#radarchartaggregatedfieldwells) +* **AggregationFunction**: [AggregationFunction](#aggregationfunction) +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) +* **DefaultFilterControlConfiguration**: [DefaultFilterControlConfiguration](#defaultfiltercontrolconfiguration) +* **FilterId**: string (Required) +* **MatchOperator**: string (Required) +* **NullOption**: string (Required) +* **ParameterName**: string +* **SelectAllOptions**: string +* **Value**: int -## RadarChartAggregatedFieldWells +## NumericEqualityFilter ### Properties -* **Category**: [DimensionField](#dimensionfield)[] -* **Color**: [DimensionField](#dimensionfield)[] -* **Values**: [MeasureField](#measurefield)[] +* **AggregationFunction**: [AggregationFunction](#aggregationfunction) +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) +* **DefaultFilterControlConfiguration**: [DefaultFilterControlConfiguration](#defaultfiltercontrolconfiguration) +* **FilterId**: string (Required) +* **MatchOperator**: string (Required) +* **NullOption**: string (Required) +* **ParameterName**: string +* **SelectAllOptions**: string +* **Value**: int -## RadarChartSortConfiguration +## NumericEqualityFilter ### Properties -* **CategoryItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) -* **CategorySort**: [FieldSortOptions](#fieldsortoptions)[] -* **ColorItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) -* **ColorSort**: [FieldSortOptions](#fieldsortoptions)[] +* **AggregationFunction**: [AggregationFunction](#aggregationfunction) +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) +* **DefaultFilterControlConfiguration**: [DefaultFilterControlConfiguration](#defaultfiltercontrolconfiguration) +* **FilterId**: string (Required) +* **MatchOperator**: string (Required) +* **NullOption**: string (Required) +* **ParameterName**: string +* **SelectAllOptions**: string +* **Value**: int -## SankeyDiagramVisual +## NumericFormatConfiguration ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [SankeyDiagramChartConfiguration](#sankeydiagramchartconfiguration) -* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) -* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) -* **VisualId**: string (Required) +* **CurrencyDisplayFormatConfiguration**: [CurrencyDisplayFormatConfiguration](#currencydisplayformatconfiguration) +* **NumberDisplayFormatConfiguration**: [NumberDisplayFormatConfiguration](#numberdisplayformatconfiguration) +* **PercentageDisplayFormatConfiguration**: [PercentageDisplayFormatConfiguration](#percentagedisplayformatconfiguration) -## SankeyDiagramChartConfiguration +## NumericFormatConfiguration ### Properties -* **DataLabels**: [DataLabelOptions](#datalabeloptions) -* **FieldWells**: [SankeyDiagramFieldWells](#sankeydiagramfieldwells) -* **SortConfiguration**: [SankeyDiagramSortConfiguration](#sankeydiagramsortconfiguration) +* **CurrencyDisplayFormatConfiguration**: [CurrencyDisplayFormatConfiguration](#currencydisplayformatconfiguration) +* **NumberDisplayFormatConfiguration**: [NumberDisplayFormatConfiguration](#numberdisplayformatconfiguration) +* **PercentageDisplayFormatConfiguration**: [PercentageDisplayFormatConfiguration](#percentagedisplayformatconfiguration) -## SankeyDiagramFieldWells +## NumericFormatConfiguration ### Properties -* **SankeyDiagramAggregatedFieldWells**: [SankeyDiagramAggregatedFieldWells](#sankeydiagramaggregatedfieldwells) +* **CurrencyDisplayFormatConfiguration**: [CurrencyDisplayFormatConfiguration](#currencydisplayformatconfiguration) +* **NumberDisplayFormatConfiguration**: [NumberDisplayFormatConfiguration](#numberdisplayformatconfiguration) +* **PercentageDisplayFormatConfiguration**: [PercentageDisplayFormatConfiguration](#percentagedisplayformatconfiguration) -## SankeyDiagramAggregatedFieldWells +## NumericRangeFilter ### Properties -* **Destination**: [DimensionField](#dimensionfield)[] -* **Source**: [DimensionField](#dimensionfield)[] -* **Weight**: [MeasureField](#measurefield)[] +* **AggregationFunction**: [AggregationFunction](#aggregationfunction) +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) +* **DefaultFilterControlConfiguration**: [DefaultFilterControlConfiguration](#defaultfiltercontrolconfiguration) +* **FilterId**: string (Required) +* **IncludeMaximum**: bool +* **IncludeMinimum**: bool +* **NullOption**: string (Required) +* **RangeMaximum**: [NumericRangeFilterValue](#numericrangefiltervalue) +* **RangeMinimum**: [NumericRangeFilterValue](#numericrangefiltervalue) +* **SelectAllOptions**: string -## SankeyDiagramSortConfiguration +## NumericRangeFilter ### Properties -* **DestinationItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) -* **SourceItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) -* **WeightSort**: [FieldSortOptions](#fieldsortoptions)[] +* **AggregationFunction**: [AggregationFunction](#aggregationfunction) +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) +* **DefaultFilterControlConfiguration**: [DefaultFilterControlConfiguration](#defaultfiltercontrolconfiguration) +* **FilterId**: string (Required) +* **IncludeMaximum**: bool +* **IncludeMinimum**: bool +* **NullOption**: string (Required) +* **RangeMaximum**: [NumericRangeFilterValue](#numericrangefiltervalue) +* **RangeMinimum**: [NumericRangeFilterValue](#numericrangefiltervalue) +* **SelectAllOptions**: string -## ScatterPlotVisual +## NumericRangeFilter ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [ScatterPlotConfiguration](#scatterplotconfiguration) -* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] -* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) -* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) -* **VisualId**: string (Required) +* **AggregationFunction**: [AggregationFunction](#aggregationfunction) +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) +* **DefaultFilterControlConfiguration**: [DefaultFilterControlConfiguration](#defaultfiltercontrolconfiguration) +* **FilterId**: string (Required) +* **IncludeMaximum**: bool +* **IncludeMinimum**: bool +* **NullOption**: string (Required) +* **RangeMaximum**: [NumericRangeFilterValue](#numericrangefiltervalue) +* **RangeMinimum**: [NumericRangeFilterValue](#numericrangefiltervalue) +* **SelectAllOptions**: string -## ScatterPlotConfiguration +## NumericRangeFilterValue ### Properties -* **DataLabels**: [DataLabelOptions](#datalabeloptions) -* **FieldWells**: [ScatterPlotFieldWells](#scatterplotfieldwells) -* **Legend**: [LegendOptions](#legendoptions) -* **Tooltip**: [TooltipOptions](#tooltipoptions) -* **VisualPalette**: [VisualPalette](#visualpalette) -* **XAxisDisplayOptions**: [AxisDisplayOptions](#axisdisplayoptions) -* **XAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **YAxisDisplayOptions**: [AxisDisplayOptions](#axisdisplayoptions) -* **YAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **Parameter**: string +* **StaticValue**: int -## ScatterPlotFieldWells +## NumericRangeFilterValue ### Properties -* **ScatterPlotCategoricallyAggregatedFieldWells**: [ScatterPlotCategoricallyAggregatedFieldWells](#scatterplotcategoricallyaggregatedfieldwells) -* **ScatterPlotUnaggregatedFieldWells**: [ScatterPlotUnaggregatedFieldWells](#scatterplotunaggregatedfieldwells) +* **Parameter**: string +* **StaticValue**: int -## ScatterPlotCategoricallyAggregatedFieldWells +## NumericRangeFilterValue ### Properties -* **Category**: [DimensionField](#dimensionfield)[] -* **Label**: [DimensionField](#dimensionfield)[] -* **Size**: [MeasureField](#measurefield)[] -* **XAxis**: [MeasureField](#measurefield)[] -* **YAxis**: [MeasureField](#measurefield)[] +* **Parameter**: string +* **StaticValue**: int -## ScatterPlotUnaggregatedFieldWells +## NumericSeparatorConfiguration ### Properties -* **Category**: [DimensionField](#dimensionfield)[] -* **Label**: [DimensionField](#dimensionfield)[] -* **Size**: [MeasureField](#measurefield)[] -* **XAxis**: [DimensionField](#dimensionfield)[] -* **YAxis**: [DimensionField](#dimensionfield)[] +* **DecimalSeparator**: string +* **ThousandsSeparator**: [ThousandSeparatorOptions](#thousandseparatoroptions) -## TableVisual +## NumericSeparatorConfiguration ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [TableConfiguration](#tableconfiguration) -* **ConditionalFormatting**: [TableConditionalFormatting](#tableconditionalformatting) -* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) -* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) -* **VisualId**: string (Required) +* **DecimalSeparator**: string +* **ThousandsSeparator**: [ThousandSeparatorOptions](#thousandseparatoroptions) -## TableConfiguration +## NumericSeparatorConfiguration ### Properties -* **FieldOptions**: [TableFieldOptions](#tablefieldoptions) -* **FieldWells**: [TableFieldWells](#tablefieldwells) -* **PaginatedReportOptions**: [TablePaginatedReportOptions](#tablepaginatedreportoptions) -* **SortConfiguration**: [TableSortConfiguration](#tablesortconfiguration) -* **TableInlineVisualizations**: [TableInlineVisualization](#tableinlinevisualization)[] -* **TableOptions**: [TableOptions](#tableoptions) -* **TotalOptions**: [TotalOptions](#totaloptions) +* **DecimalSeparator**: string +* **ThousandsSeparator**: [ThousandSeparatorOptions](#thousandseparatoroptions) -## TableFieldOptions +## OracleParameters ### Properties -* **Order**: string[] -* **PinnedFieldOptions**: [TablePinnedFieldOptions](#tablepinnedfieldoptions) -* **SelectedFieldOptions**: [TableFieldOption](#tablefieldoption)[] +* **Database**: string (Required):

The database.

+* **Host**: string (Required):

An Oracle host.

+* **Port**: int (Required):

The port.

-## TablePinnedFieldOptions +## OutputColumn ### Properties -* **PinnedLeftFields**: string[] +* **Description**: string:

A description for a column.

+* **Name**: string:

The display name of the column..

+* **SubType**: string +* **Type**: string -## TableFieldOption +## PaginationConfiguration ### Properties -* **CustomLabel**: string -* **FieldId**: string (Required) -* **URLStyling**: [TableFieldURLConfiguration](#tablefieldurlconfiguration) -* **Visibility**: string -* **Width**: string: String based length that is composed of value and unit in px +* **PageNumber**: int (Required) +* **PageSize**: int (Required) -## TableFieldURLConfiguration +## PaginationConfiguration ### Properties -* **ImageConfiguration**: [TableFieldImageConfiguration](#tablefieldimageconfiguration) -* **LinkConfiguration**: [TableFieldLinkConfiguration](#tablefieldlinkconfiguration) +* **PageNumber**: int (Required) +* **PageSize**: int (Required) -## TableFieldImageConfiguration +## PaginationConfiguration ### Properties -* **SizingOptions**: [TableCellImageSizingConfiguration](#tablecellimagesizingconfiguration) +* **PageNumber**: int (Required) +* **PageSize**: int (Required) -## TableCellImageSizingConfiguration +## PanelConfiguration ### Properties -* **TableCellImageScalingConfiguration**: string +* **BackgroundColor**: string +* **BackgroundVisibility**: string +* **BorderColor**: string +* **BorderStyle**: string +* **BorderThickness**: string: String based length that is composed of value and unit in px +* **BorderVisibility**: string +* **GutterSpacing**: string: String based length that is composed of value and unit in px +* **GutterVisibility**: string +* **Title**: [PanelTitleOptions](#paneltitleoptions) -## TableFieldLinkConfiguration +## PanelConfiguration ### Properties -* **Content**: [TableFieldLinkContentConfiguration](#tablefieldlinkcontentconfiguration) (Required) -* **Target**: string (Required) +* **BackgroundColor**: string +* **BackgroundVisibility**: string +* **BorderColor**: string +* **BorderStyle**: string +* **BorderThickness**: string: String based length that is composed of value and unit in px +* **BorderVisibility**: string +* **GutterSpacing**: string: String based length that is composed of value and unit in px +* **GutterVisibility**: string +* **Title**: [PanelTitleOptions](#paneltitleoptions) -## TableFieldLinkContentConfiguration +## PanelConfiguration ### Properties -* **CustomIconContent**: [TableFieldCustomIconContent](#tablefieldcustomiconcontent) -* **CustomTextContent**: [TableFieldCustomTextContent](#tablefieldcustomtextcontent) +* **BackgroundColor**: string +* **BackgroundVisibility**: string +* **BorderColor**: string +* **BorderStyle**: string +* **BorderThickness**: string: String based length that is composed of value and unit in px +* **BorderVisibility**: string +* **GutterSpacing**: string: String based length that is composed of value and unit in px +* **GutterVisibility**: string +* **Title**: [PanelTitleOptions](#paneltitleoptions) -## TableFieldCustomIconContent +## PanelTitleOptions ### Properties -* **Icon**: string +* **FontConfiguration**: [FontConfiguration](#fontconfiguration) +* **HorizontalTextAlignment**: string +* **Visibility**: string -## TableFieldCustomTextContent +## PanelTitleOptions ### Properties -* **FontConfiguration**: [FontConfiguration](#fontconfiguration) (Required) -* **Value**: string +* **FontConfiguration**: [FontConfiguration](#fontconfiguration) +* **HorizontalTextAlignment**: string +* **Visibility**: string -## TableFieldWells +## PanelTitleOptions ### Properties -* **TableAggregatedFieldWells**: [TableAggregatedFieldWells](#tableaggregatedfieldwells) -* **TableUnaggregatedFieldWells**: [TableUnaggregatedFieldWells](#tableunaggregatedfieldwells) +* **FontConfiguration**: [FontConfiguration](#fontconfiguration) +* **HorizontalTextAlignment**: string +* **Visibility**: string -## TableAggregatedFieldWells +## ParameterControl ### Properties -* **GroupBy**: [DimensionField](#dimensionfield)[] -* **Values**: [MeasureField](#measurefield)[] +* **DateTimePicker**: [ParameterDateTimePickerControl](#parameterdatetimepickercontrol) +* **Dropdown**: [ParameterDropDownControl](#parameterdropdowncontrol) +* **List**: [ParameterListControl](#parameterlistcontrol) +* **Slider**: [ParameterSliderControl](#parameterslidercontrol) +* **TextArea**: [ParameterTextAreaControl](#parametertextareacontrol) +* **TextField**: [ParameterTextFieldControl](#parametertextfieldcontrol) -## TableUnaggregatedFieldWells +## ParameterControl ### Properties -* **Values**: [UnaggregatedField](#unaggregatedfield)[] +* **DateTimePicker**: [ParameterDateTimePickerControl](#parameterdatetimepickercontrol) +* **Dropdown**: [ParameterDropDownControl](#parameterdropdowncontrol) +* **List**: [ParameterListControl](#parameterlistcontrol) +* **Slider**: [ParameterSliderControl](#parameterslidercontrol) +* **TextArea**: [ParameterTextAreaControl](#parametertextareacontrol) +* **TextField**: [ParameterTextFieldControl](#parametertextfieldcontrol) -## UnaggregatedField +## ParameterControl ### Properties -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **FieldId**: string (Required) -* **FormatConfiguration**: [FormatConfiguration](#formatconfiguration) +* **DateTimePicker**: [ParameterDateTimePickerControl](#parameterdatetimepickercontrol) +* **Dropdown**: [ParameterDropDownControl](#parameterdropdowncontrol) +* **List**: [ParameterListControl](#parameterlistcontrol) +* **Slider**: [ParameterSliderControl](#parameterslidercontrol) +* **TextArea**: [ParameterTextAreaControl](#parametertextareacontrol) +* **TextField**: [ParameterTextFieldControl](#parametertextfieldcontrol) -## TablePaginatedReportOptions +## ParameterDateTimePickerControl ### Properties -* **OverflowColumnHeaderVisibility**: string -* **VerticalOverflowVisibility**: string +* **DisplayOptions**: [DateTimePickerControlDisplayOptions](#datetimepickercontroldisplayoptions) +* **ParameterControlId**: string (Required) +* **SourceParameterName**: string (Required) +* **Title**: string (Required) -## TableSortConfiguration +## ParameterDateTimePickerControl ### Properties -* **PaginationConfiguration**: [PaginationConfiguration](#paginationconfiguration) -* **RowSort**: [FieldSortOptions](#fieldsortoptions)[] +* **DisplayOptions**: [DateTimePickerControlDisplayOptions](#datetimepickercontroldisplayoptions) +* **ParameterControlId**: string (Required) +* **SourceParameterName**: string (Required) +* **Title**: string (Required) -## TableInlineVisualization +## ParameterDateTimePickerControl ### Properties -* **DataBars**: [DataBarsOptions](#databarsoptions) +* **DisplayOptions**: [DateTimePickerControlDisplayOptions](#datetimepickercontroldisplayoptions) +* **ParameterControlId**: string (Required) +* **SourceParameterName**: string (Required) +* **Title**: string (Required) -## DataBarsOptions +## ParameterDeclaration ### Properties -* **FieldId**: string (Required) -* **NegativeColor**: string -* **PositiveColor**: string +* **DateTimeParameterDeclaration**: [DateTimeParameterDeclaration](#datetimeparameterdeclaration) +* **DecimalParameterDeclaration**: [DecimalParameterDeclaration](#decimalparameterdeclaration) +* **IntegerParameterDeclaration**: [IntegerParameterDeclaration](#integerparameterdeclaration) +* **StringParameterDeclaration**: [StringParameterDeclaration](#stringparameterdeclaration) -## TableOptions +## ParameterDeclaration ### Properties -* **CellStyle**: [TableCellStyle](#tablecellstyle) -* **HeaderStyle**: [TableCellStyle](#tablecellstyle) -* **Orientation**: string -* **RowAlternateColorOptions**: [RowAlternateColorOptions](#rowalternatecoloroptions) +* **DateTimeParameterDeclaration**: [DateTimeParameterDeclaration](#datetimeparameterdeclaration) +* **DecimalParameterDeclaration**: [DecimalParameterDeclaration](#decimalparameterdeclaration) +* **IntegerParameterDeclaration**: [IntegerParameterDeclaration](#integerparameterdeclaration) +* **StringParameterDeclaration**: [StringParameterDeclaration](#stringparameterdeclaration) -## TotalOptions +## ParameterDeclaration ### Properties -* **CustomLabel**: string -* **Placement**: string -* **ScrollStatus**: string -* **TotalAggregationOptions**: [TotalAggregationOption](#totalaggregationoption)[] -* **TotalCellStyle**: [TableCellStyle](#tablecellstyle) -* **TotalsVisibility**: string +* **DateTimeParameterDeclaration**: [DateTimeParameterDeclaration](#datetimeparameterdeclaration) +* **DecimalParameterDeclaration**: [DecimalParameterDeclaration](#decimalparameterdeclaration) +* **IntegerParameterDeclaration**: [IntegerParameterDeclaration](#integerparameterdeclaration) +* **StringParameterDeclaration**: [StringParameterDeclaration](#stringparameterdeclaration) -## TableConditionalFormatting +## ParameterDropDownControl ### Properties -* **ConditionalFormattingOptions**: [TableConditionalFormattingOption](#tableconditionalformattingoption)[] +* **CascadingControlConfiguration**: [CascadingControlConfiguration](#cascadingcontrolconfiguration) +* **DisplayOptions**: [DropDownControlDisplayOptions](#dropdowncontroldisplayoptions) +* **ParameterControlId**: string (Required) +* **SelectableValues**: [ParameterSelectableValues](#parameterselectablevalues) +* **SourceParameterName**: string (Required) +* **Title**: string (Required) +* **Type**: string -## TableConditionalFormattingOption +## ParameterDropDownControl ### Properties -* **Cell**: [TableCellConditionalFormatting](#tablecellconditionalformatting) -* **Row**: [TableRowConditionalFormatting](#tablerowconditionalformatting) +* **CascadingControlConfiguration**: [CascadingControlConfiguration](#cascadingcontrolconfiguration) +* **DisplayOptions**: [DropDownControlDisplayOptions](#dropdowncontroldisplayoptions) +* **ParameterControlId**: string (Required) +* **SelectableValues**: [ParameterSelectableValues](#parameterselectablevalues) +* **SourceParameterName**: string (Required) +* **Title**: string (Required) +* **Type**: string -## TableCellConditionalFormatting +## ParameterDropDownControl ### Properties -* **FieldId**: string (Required) -* **TextFormat**: [TextConditionalFormat](#textconditionalformat) +* **CascadingControlConfiguration**: [CascadingControlConfiguration](#cascadingcontrolconfiguration) +* **DisplayOptions**: [DropDownControlDisplayOptions](#dropdowncontroldisplayoptions) +* **ParameterControlId**: string (Required) +* **SelectableValues**: [ParameterSelectableValues](#parameterselectablevalues) +* **SourceParameterName**: string (Required) +* **Title**: string (Required) +* **Type**: string -## TableRowConditionalFormatting +## ParameterListControl ### Properties -* **BackgroundColor**: [ConditionalFormattingColor](#conditionalformattingcolor) -* **TextColor**: [ConditionalFormattingColor](#conditionalformattingcolor) +* **CascadingControlConfiguration**: [CascadingControlConfiguration](#cascadingcontrolconfiguration) +* **DisplayOptions**: [ListControlDisplayOptions](#listcontroldisplayoptions) +* **ParameterControlId**: string (Required) +* **SelectableValues**: [ParameterSelectableValues](#parameterselectablevalues) +* **SourceParameterName**: string (Required) +* **Title**: string (Required) +* **Type**: string -## TreeMapVisual +## ParameterListControl ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [TreeMapConfiguration](#treemapconfiguration) -* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] -* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) -* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) -* **VisualId**: string (Required) +* **CascadingControlConfiguration**: [CascadingControlConfiguration](#cascadingcontrolconfiguration) +* **DisplayOptions**: [ListControlDisplayOptions](#listcontroldisplayoptions) +* **ParameterControlId**: string (Required) +* **SelectableValues**: [ParameterSelectableValues](#parameterselectablevalues) +* **SourceParameterName**: string (Required) +* **Title**: string (Required) +* **Type**: string -## TreeMapConfiguration +## ParameterListControl ### Properties -* **ColorLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **ColorScale**: [ColorScale](#colorscale) -* **DataLabels**: [DataLabelOptions](#datalabeloptions) -* **FieldWells**: [TreeMapFieldWells](#treemapfieldwells) -* **GroupLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **Legend**: [LegendOptions](#legendoptions) -* **SizeLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **SortConfiguration**: [TreeMapSortConfiguration](#treemapsortconfiguration) -* **Tooltip**: [TooltipOptions](#tooltipoptions) +* **CascadingControlConfiguration**: [CascadingControlConfiguration](#cascadingcontrolconfiguration) +* **DisplayOptions**: [ListControlDisplayOptions](#listcontroldisplayoptions) +* **ParameterControlId**: string (Required) +* **SelectableValues**: [ParameterSelectableValues](#parameterselectablevalues) +* **SourceParameterName**: string (Required) +* **Title**: string (Required) +* **Type**: string -## TreeMapFieldWells +## Parameters ### Properties -* **TreeMapAggregatedFieldWells**: [TreeMapAggregatedFieldWells](#treemapaggregatedfieldwells) +* **DateTimeParameters**: [DateTimeParameter](#datetimeparameter)[]:

The parameters that have a data type of date-time.

+* **DecimalParameters**: [DecimalParameter](#decimalparameter)[]:

The parameters that have a data type of decimal.

+* **IntegerParameters**: [IntegerParameter](#integerparameter)[]:

The parameters that have a data type of integer.

+* **StringParameters**: [StringParameter](#stringparameter)[]:

The parameters that have a data type of string.

-## TreeMapAggregatedFieldWells +## Parameters ### Properties -* **Colors**: [MeasureField](#measurefield)[] -* **Groups**: [DimensionField](#dimensionfield)[] -* **Sizes**: [MeasureField](#measurefield)[] +* **DateTimeParameters**: [DateTimeParameter](#datetimeparameter)[]:

The parameters that have a data type of date-time.

+* **DecimalParameters**: [DecimalParameter](#decimalparameter)[]:

The parameters that have a data type of decimal.

+* **IntegerParameters**: [IntegerParameter](#integerparameter)[]:

The parameters that have a data type of integer.

+* **StringParameters**: [StringParameter](#stringparameter)[]:

The parameters that have a data type of string.

-## TreeMapSortConfiguration +## ParameterSelectableValues ### Properties -* **TreeMapGroupItemsLimitConfiguration**: [ItemsLimitConfiguration](#itemslimitconfiguration) -* **TreeMapSort**: [FieldSortOptions](#fieldsortoptions)[] +* **LinkToDataSetColumn**: [ColumnIdentifier](#columnidentifier) +* **Values**: string[] -## WaterfallVisual +## ParameterSelectableValues ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [WaterfallChartConfiguration](#waterfallchartconfiguration) -* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] -* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) -* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) -* **VisualId**: string (Required) +* **LinkToDataSetColumn**: [ColumnIdentifier](#columnidentifier) +* **Values**: string[] -## WaterfallChartConfiguration +## ParameterSelectableValues ### Properties -* **CategoryAxisDisplayOptions**: [AxisDisplayOptions](#axisdisplayoptions) -* **CategoryAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **DataLabels**: [DataLabelOptions](#datalabeloptions) -* **FieldWells**: [WaterfallChartFieldWells](#waterfallchartfieldwells) -* **Legend**: [LegendOptions](#legendoptions) -* **PrimaryYAxisDisplayOptions**: [AxisDisplayOptions](#axisdisplayoptions) -* **PrimaryYAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **SortConfiguration**: [WaterfallChartSortConfiguration](#waterfallchartsortconfiguration) -* **VisualPalette**: [VisualPalette](#visualpalette) -* **WaterfallChartOptions**: [WaterfallChartOptions](#waterfallchartoptions) +* **LinkToDataSetColumn**: [ColumnIdentifier](#columnidentifier) +* **Values**: string[] -## WaterfallChartFieldWells +## ParameterSliderControl ### Properties -* **WaterfallChartAggregatedFieldWells**: [WaterfallChartAggregatedFieldWells](#waterfallchartaggregatedfieldwells) +* **DisplayOptions**: [SliderControlDisplayOptions](#slidercontroldisplayoptions) +* **MaximumValue**: int (Required) +* **MinimumValue**: int (Required) +* **ParameterControlId**: string (Required) +* **SourceParameterName**: string (Required) +* **StepSize**: int (Required) +* **Title**: string (Required) -## WaterfallChartAggregatedFieldWells +## ParameterSliderControl ### Properties -* **Breakdowns**: [DimensionField](#dimensionfield)[] -* **Categories**: [DimensionField](#dimensionfield)[] -* **Values**: [MeasureField](#measurefield)[] +* **DisplayOptions**: [SliderControlDisplayOptions](#slidercontroldisplayoptions) +* **MaximumValue**: int (Required) +* **MinimumValue**: int (Required) +* **ParameterControlId**: string (Required) +* **SourceParameterName**: string (Required) +* **StepSize**: int (Required) +* **Title**: string (Required) -## WaterfallChartSortConfiguration +## ParameterSliderControl ### Properties -* **BreakdownItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) -* **CategorySort**: [FieldSortOptions](#fieldsortoptions)[] +* **DisplayOptions**: [SliderControlDisplayOptions](#slidercontroldisplayoptions) +* **MaximumValue**: int (Required) +* **MinimumValue**: int (Required) +* **ParameterControlId**: string (Required) +* **SourceParameterName**: string (Required) +* **StepSize**: int (Required) +* **Title**: string (Required) -## WaterfallChartOptions +## ParameterTextAreaControl ### Properties -* **TotalBarLabel**: string +* **Delimiter**: string +* **DisplayOptions**: [TextAreaControlDisplayOptions](#textareacontroldisplayoptions) +* **ParameterControlId**: string (Required) +* **SourceParameterName**: string (Required) +* **Title**: string (Required) -## WordCloudVisual +## ParameterTextAreaControl ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [WordCloudChartConfiguration](#wordcloudchartconfiguration) -* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] -* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) -* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) -* **VisualId**: string (Required) +* **Delimiter**: string +* **DisplayOptions**: [TextAreaControlDisplayOptions](#textareacontroldisplayoptions) +* **ParameterControlId**: string (Required) +* **SourceParameterName**: string (Required) +* **Title**: string (Required) -## WordCloudChartConfiguration +## ParameterTextAreaControl ### Properties -* **CategoryLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **FieldWells**: [WordCloudFieldWells](#wordcloudfieldwells) -* **SortConfiguration**: [WordCloudSortConfiguration](#wordcloudsortconfiguration) -* **WordCloudOptions**: [WordCloudOptions](#wordcloudoptions) +* **Delimiter**: string +* **DisplayOptions**: [TextAreaControlDisplayOptions](#textareacontroldisplayoptions) +* **ParameterControlId**: string (Required) +* **SourceParameterName**: string (Required) +* **Title**: string (Required) -## WordCloudFieldWells +## ParameterTextFieldControl ### Properties -* **WordCloudAggregatedFieldWells**: [WordCloudAggregatedFieldWells](#wordcloudaggregatedfieldwells) +* **DisplayOptions**: [TextFieldControlDisplayOptions](#textfieldcontroldisplayoptions) +* **ParameterControlId**: string (Required) +* **SourceParameterName**: string (Required) +* **Title**: string (Required) -## WordCloudAggregatedFieldWells +## ParameterTextFieldControl ### Properties -* **GroupBy**: [DimensionField](#dimensionfield)[] -* **Size**: [MeasureField](#measurefield)[] +* **DisplayOptions**: [TextFieldControlDisplayOptions](#textfieldcontroldisplayoptions) +* **ParameterControlId**: string (Required) +* **SourceParameterName**: string (Required) +* **Title**: string (Required) -## WordCloudSortConfiguration +## ParameterTextFieldControl ### Properties -* **CategoryItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) -* **CategorySort**: [FieldSortOptions](#fieldsortoptions)[] +* **DisplayOptions**: [TextFieldControlDisplayOptions](#textfieldcontroldisplayoptions) +* **ParameterControlId**: string (Required) +* **SourceParameterName**: string (Required) +* **Title**: string (Required) -## WordCloudOptions +## PercentageDisplayFormatConfiguration ### Properties -* **CloudLayout**: string -* **MaximumStringLength**: int -* **WordCasing**: string -* **WordOrientation**: string -* **WordPadding**: string -* **WordScaling**: string +* **DecimalPlacesConfiguration**: [DecimalPlacesConfiguration](#decimalplacesconfiguration) +* **NegativeValueConfiguration**: [NegativeValueConfiguration](#negativevalueconfiguration) +* **NullValueFormatConfiguration**: [NullValueFormatConfiguration](#nullvalueformatconfiguration) +* **Prefix**: string +* **SeparatorConfiguration**: [NumericSeparatorConfiguration](#numericseparatorconfiguration) +* **Suffix**: string -## LinkSharingConfiguration +## PercentageDisplayFormatConfiguration ### Properties -* **Permissions**: [ResourcePermission](#resourcepermission)[] +* **DecimalPlacesConfiguration**: [DecimalPlacesConfiguration](#decimalplacesconfiguration) +* **NegativeValueConfiguration**: [NegativeValueConfiguration](#negativevalueconfiguration) +* **NullValueFormatConfiguration**: [NullValueFormatConfiguration](#nullvalueformatconfiguration) +* **Prefix**: string +* **SeparatorConfiguration**: [NumericSeparatorConfiguration](#numericseparatorconfiguration) +* **Suffix**: string -## ResourcePermission +## PercentageDisplayFormatConfiguration ### Properties -* **Actions**: string[] (Required) -* **Principal**: string (Required) +* **DecimalPlacesConfiguration**: [DecimalPlacesConfiguration](#decimalplacesconfiguration) +* **NegativeValueConfiguration**: [NegativeValueConfiguration](#negativevalueconfiguration) +* **NullValueFormatConfiguration**: [NullValueFormatConfiguration](#nullvalueformatconfiguration) +* **Prefix**: string +* **SeparatorConfiguration**: [NumericSeparatorConfiguration](#numericseparatorconfiguration) +* **Suffix**: string -## Parameters +## PercentileAggregation ### Properties -* **DateTimeParameters**: [DateTimeParameter](#datetimeparameter)[] -* **DecimalParameters**: [DecimalParameter](#decimalparameter)[] -* **IntegerParameters**: [IntegerParameter](#integerparameter)[] -* **StringParameters**: [StringParameter](#stringparameter)[] +* **PercentileValue**: int -## DateTimeParameter +## PercentileAggregation ### Properties -* **Name**: string (Required) -* **Values**: string[] (Required) +* **PercentileValue**: int -## DecimalParameter +## PercentileAggregation ### Properties -* **Name**: string (Required) -* **Values**: int[] (Required) +* **PercentileValue**: int -## IntegerParameter +## PercentVisibleRange ### Properties -* **Name**: string (Required) -* **Values**: int[] (Required) +* **From**: int +* **To**: int -## StringParameter +## PercentVisibleRange ### Properties -* **Name**: string (Required) -* **Values**: string[] (Required) +* **From**: int +* **To**: int -## DashboardSourceEntity +## PercentVisibleRange ### Properties -* **SourceTemplate**: [DashboardSourceTemplate](#dashboardsourcetemplate) +* **From**: int +* **To**: int -## DashboardSourceTemplate +## PeriodOverPeriodComputation ### Properties -* **Arn**: string (Required) -* **DataSetReferences**: [DataSetReference](#datasetreference)[] (Required) +* **ComputationId**: string (Required) +* **Name**: string +* **Time**: [DimensionField](#dimensionfield) +* **Value**: [MeasureField](#measurefield) -## DataSetReference +## PeriodOverPeriodComputation ### Properties -* **DataSetArn**: string (Required) -* **DataSetPlaceholder**: string (Required) +* **ComputationId**: string (Required) +* **Name**: string +* **Time**: [DimensionField](#dimensionfield) +* **Value**: [MeasureField](#measurefield) -## Tag +## PeriodOverPeriodComputation ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **ComputationId**: string (Required) +* **Name**: string +* **Time**: [DimensionField](#dimensionfield) +* **Value**: [MeasureField](#measurefield) -## ValidationStrategy +## PeriodToDateComputation ### Properties -* **Mode**: string (Required) +* **ComputationId**: string (Required) +* **Name**: string +* **PeriodTimeGranularity**: string +* **Time**: [DimensionField](#dimensionfield) +* **Value**: [MeasureField](#measurefield) -## DashboardVersion +## PeriodToDateComputation ### Properties -* **Arn**: string -* **CreatedTime**: string -* **DataSetArns**: string[] -* **Description**: string -* **Errors**: [DashboardError](#dashboarderror)[] -* **Sheets**: [Sheet](#sheet)[] -* **SourceEntityArn**: string -* **Status**: string -* **ThemeArn**: string -* **VersionNumber**: int +* **ComputationId**: string (Required) +* **Name**: string +* **PeriodTimeGranularity**: string +* **Time**: [DimensionField](#dimensionfield) +* **Value**: [MeasureField](#measurefield) -## DashboardError +## PeriodToDateComputation ### Properties -* **Message**: string -* **Type**: string -* **ViolatedEntities**: [Entity](#entity)[] +* **ComputationId**: string (Required) +* **Name**: string +* **PeriodTimeGranularity**: string +* **Time**: [DimensionField](#dimensionfield) +* **Value**: [MeasureField](#measurefield) -## Entity +## PhysicalTableMap ### Properties -* **Path**: string -## Sheet +## PieChartAggregatedFieldWells ### Properties -* **Name**: string -* **SheetId**: string +* **Category**: [DimensionField](#dimensionfield)[] +* **SmallMultiples**: [DimensionField](#dimensionfield)[] +* **Values**: [MeasureField](#measurefield)[] -## AWS.QuickSight/DataSetProperties +## PieChartAggregatedFieldWells ### Properties -* **Arn**: string (ReadOnly):

The Amazon Resource Name (ARN) of the resource.

-* **AwsAccountId**: string (Identifier) -* **ColumnGroups**: [ColumnGroup](#columngroup)[]:

Groupings of columns that work together in certain QuickSight features. Currently, only geospatial hierarchy is supported.

-* **ColumnLevelPermissionRules**: [ColumnLevelPermissionRule](#columnlevelpermissionrule)[] -* **ConsumedSpiceCapacityInBytes**: int (ReadOnly):

The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't - imported into SPICE.

-* **CreatedTime**: string (ReadOnly):

The time that this dataset was created.

-* **DataSetId**: string (Identifier) -* **DatasetParameters**: [DatasetParameter](#datasetparameter)[]:

The parameters declared in the dataset.

-* **DataSetRefreshProperties**: [DataSetRefreshProperties](#datasetrefreshproperties) -* **DataSetUsageConfiguration**: [DataSetUsageConfiguration](#datasetusageconfiguration) -* **FieldFolders**: [FieldFolderMap](#fieldfoldermap) (WriteOnly) -* **ImportMode**: string -* **IngestionWaitPolicy**: [IngestionWaitPolicy](#ingestionwaitpolicy) (WriteOnly) -* **LastUpdatedTime**: string (ReadOnly):

The last time that this dataset was updated.

-* **LogicalTableMap**: [LogicalTableMap](#logicaltablemap) -* **Name**: string:

The display name for the dataset.

-* **OutputColumns**: [OutputColumn](#outputcolumn)[] (ReadOnly):

The list of columns after all transforms. These columns are available in templates, - analyses, and dashboards.

-* **Permissions**: [ResourcePermission](#resourcepermission)[]:

A list of resource permissions on the dataset.

-* **PhysicalTableMap**: [PhysicalTableMap](#physicaltablemap) -* **RowLevelPermissionDataSet**: [RowLevelPermissionDataSet](#rowlevelpermissiondataset) -* **RowLevelPermissionTagConfiguration**: [RowLevelPermissionTagConfiguration](#rowlevelpermissiontagconfiguration) -* **Tags**: [Tag](#tag)[]:

Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.

+* **Category**: [DimensionField](#dimensionfield)[] +* **SmallMultiples**: [DimensionField](#dimensionfield)[] +* **Values**: [MeasureField](#measurefield)[] -## ColumnGroup +## PieChartAggregatedFieldWells ### Properties -* **GeoSpatialColumnGroup**: [GeoSpatialColumnGroup](#geospatialcolumngroup) +* **Category**: [DimensionField](#dimensionfield)[] +* **SmallMultiples**: [DimensionField](#dimensionfield)[] +* **Values**: [MeasureField](#measurefield)[] -## GeoSpatialColumnGroup +## PieChartConfiguration ### Properties -* **Columns**: string[] (Required):

Columns in this hierarchy.

-* **CountryCode**: string -* **Name**: string (Required):

A display name for the hierarchy.

+* **CategoryLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **ContributionAnalysisDefaults**: [ContributionAnalysisDefault](#contributionanalysisdefault)[] +* **DataLabels**: [DataLabelOptions](#datalabeloptions) +* **DonutOptions**: [DonutOptions](#donutoptions) +* **FieldWells**: [PieChartFieldWells](#piechartfieldwells) +* **Legend**: [LegendOptions](#legendoptions) +* **SmallMultiplesOptions**: [SmallMultiplesOptions](#smallmultiplesoptions) +* **SortConfiguration**: [PieChartSortConfiguration](#piechartsortconfiguration) +* **Tooltip**: [TooltipOptions](#tooltipoptions) +* **ValueLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **VisualPalette**: [VisualPalette](#visualpalette) -## ColumnLevelPermissionRule +## PieChartConfiguration ### Properties -* **ColumnNames**: string[] -* **Principals**: string[] +* **CategoryLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **ContributionAnalysisDefaults**: [ContributionAnalysisDefault](#contributionanalysisdefault)[] +* **DataLabels**: [DataLabelOptions](#datalabeloptions) +* **DonutOptions**: [DonutOptions](#donutoptions) +* **FieldWells**: [PieChartFieldWells](#piechartfieldwells) +* **Legend**: [LegendOptions](#legendoptions) +* **SmallMultiplesOptions**: [SmallMultiplesOptions](#smallmultiplesoptions) +* **SortConfiguration**: [PieChartSortConfiguration](#piechartsortconfiguration) +* **Tooltip**: [TooltipOptions](#tooltipoptions) +* **ValueLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **VisualPalette**: [VisualPalette](#visualpalette) -## DatasetParameter +## PieChartConfiguration ### Properties -* **DateTimeDatasetParameter**: [DateTimeDatasetParameter](#datetimedatasetparameter) -* **DecimalDatasetParameter**: [DecimalDatasetParameter](#decimaldatasetparameter) -* **IntegerDatasetParameter**: [IntegerDatasetParameter](#integerdatasetparameter) -* **StringDatasetParameter**: [StringDatasetParameter](#stringdatasetparameter) +* **CategoryLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **ContributionAnalysisDefaults**: [ContributionAnalysisDefault](#contributionanalysisdefault)[] +* **DataLabels**: [DataLabelOptions](#datalabeloptions) +* **DonutOptions**: [DonutOptions](#donutoptions) +* **FieldWells**: [PieChartFieldWells](#piechartfieldwells) +* **Legend**: [LegendOptions](#legendoptions) +* **SmallMultiplesOptions**: [SmallMultiplesOptions](#smallmultiplesoptions) +* **SortConfiguration**: [PieChartSortConfiguration](#piechartsortconfiguration) +* **Tooltip**: [TooltipOptions](#tooltipoptions) +* **ValueLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **VisualPalette**: [VisualPalette](#visualpalette) -## DateTimeDatasetParameter +## PieChartFieldWells ### Properties -* **DefaultValues**: [DateTimeDatasetParameterDefaultValues](#datetimedatasetparameterdefaultvalues) -* **Id**: string (Required) -* **Name**: string (Required) -* **TimeGranularity**: string -* **ValueType**: string (Required) +* **PieChartAggregatedFieldWells**: [PieChartAggregatedFieldWells](#piechartaggregatedfieldwells) -## DateTimeDatasetParameterDefaultValues +## PieChartFieldWells ### Properties -* **StaticValues**: string[]:

List of static default values defined for a given string date time parameter type.

+* **PieChartAggregatedFieldWells**: [PieChartAggregatedFieldWells](#piechartaggregatedfieldwells) -## DecimalDatasetParameter +## PieChartFieldWells ### Properties -* **DefaultValues**: [DecimalDatasetParameterDefaultValues](#decimaldatasetparameterdefaultvalues) -* **Id**: string (Required) -* **Name**: string (Required) -* **ValueType**: string (Required) +* **PieChartAggregatedFieldWells**: [PieChartAggregatedFieldWells](#piechartaggregatedfieldwells) -## DecimalDatasetParameterDefaultValues +## PieChartSortConfiguration ### Properties -* **StaticValues**: int[]:

List of static default values defined for a given decimal dataset parameter type.

+* **CategoryItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) +* **CategorySort**: [FieldSortOptions](#fieldsortoptions)[] +* **SmallMultiplesLimitConfiguration**: [ItemsLimitConfiguration](#itemslimitconfiguration) +* **SmallMultiplesSort**: [FieldSortOptions](#fieldsortoptions)[] -## IntegerDatasetParameter +## PieChartSortConfiguration ### Properties -* **DefaultValues**: [IntegerDatasetParameterDefaultValues](#integerdatasetparameterdefaultvalues) -* **Id**: string (Required) -* **Name**: string (Required) -* **ValueType**: string (Required) +* **CategoryItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) +* **CategorySort**: [FieldSortOptions](#fieldsortoptions)[] +* **SmallMultiplesLimitConfiguration**: [ItemsLimitConfiguration](#itemslimitconfiguration) +* **SmallMultiplesSort**: [FieldSortOptions](#fieldsortoptions)[] -## IntegerDatasetParameterDefaultValues +## PieChartSortConfiguration ### Properties -* **StaticValues**: int[]:

List of static default values defined for a given integer dataset parameter type.

+* **CategoryItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) +* **CategorySort**: [FieldSortOptions](#fieldsortoptions)[] +* **SmallMultiplesLimitConfiguration**: [ItemsLimitConfiguration](#itemslimitconfiguration) +* **SmallMultiplesSort**: [FieldSortOptions](#fieldsortoptions)[] -## StringDatasetParameter -### Properties -* **DefaultValues**: [StringDatasetParameterDefaultValues](#stringdatasetparameterdefaultvalues) -* **Id**: string (Required) -* **Name**: string (Required) -* **ValueType**: string (Required) +## PieChartVisual +### Properties +* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **ChartConfiguration**: [PieChartConfiguration](#piechartconfiguration) +* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] +* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) +* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) +* **VisualId**: string (Required) -## StringDatasetParameterDefaultValues +## PieChartVisual ### Properties -* **StaticValues**: string[]:

List of static default values defined for a given string dataset parameter type.

+* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **ChartConfiguration**: [PieChartConfiguration](#piechartconfiguration) +* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] +* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) +* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) +* **VisualId**: string (Required) -## DataSetRefreshProperties +## PieChartVisual ### Properties -* **RefreshConfiguration**: [RefreshConfiguration](#refreshconfiguration) +* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **ChartConfiguration**: [PieChartConfiguration](#piechartconfiguration) +* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] +* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) +* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) +* **VisualId**: string (Required) -## RefreshConfiguration +## PivotFieldSortOptions ### Properties -* **IncrementalRefresh**: [IncrementalRefresh](#incrementalrefresh) +* **FieldId**: string (Required) +* **SortBy**: [PivotTableSortBy](#pivottablesortby) (Required) -## IncrementalRefresh +## PivotFieldSortOptions ### Properties -* **LookbackWindow**: [LookbackWindow](#lookbackwindow) +* **FieldId**: string (Required) +* **SortBy**: [PivotTableSortBy](#pivottablesortby) (Required) -## LookbackWindow +## PivotFieldSortOptions ### Properties -* **ColumnName**: string:

Column Name

-* **Size**: int:

Size

-* **SizeUnit**: string +* **FieldId**: string (Required) +* **SortBy**: [PivotTableSortBy](#pivottablesortby) (Required) -## DataSetUsageConfiguration +## PivotTableAggregatedFieldWells ### Properties -* **DisableUseAsDirectQuerySource**: bool -* **DisableUseAsImportedSource**: bool +* **Columns**: [DimensionField](#dimensionfield)[] +* **Rows**: [DimensionField](#dimensionfield)[] +* **Values**: [MeasureField](#measurefield)[] -## FieldFolderMap +## PivotTableAggregatedFieldWells ### Properties +* **Columns**: [DimensionField](#dimensionfield)[] +* **Rows**: [DimensionField](#dimensionfield)[] +* **Values**: [MeasureField](#measurefield)[] -## IngestionWaitPolicy +## PivotTableAggregatedFieldWells ### Properties -* **IngestionWaitTimeInHours**: int:

The maximum time (in hours) to wait for Ingestion to complete. Default timeout is 36 hours. - Applicable only when DataSetImportMode mode is set to SPICE and WaitForSpiceIngestion is set to true.

-* **WaitForSpiceIngestion**: bool:

Wait for SPICE ingestion to finish to mark dataset creation/update successful. Default (true). - Applicable only when DataSetImportMode mode is set to SPICE.

+* **Columns**: [DimensionField](#dimensionfield)[] +* **Rows**: [DimensionField](#dimensionfield)[] +* **Values**: [MeasureField](#measurefield)[] -## LogicalTableMap +## PivotTableCellConditionalFormatting ### Properties +* **FieldId**: string (Required) +* **Scope**: [PivotTableConditionalFormattingScope](#pivottableconditionalformattingscope) +* **Scopes**: [PivotTableConditionalFormattingScope](#pivottableconditionalformattingscope)[] +* **TextFormat**: [TextConditionalFormat](#textconditionalformat) -## OutputColumn +## PivotTableCellConditionalFormatting ### Properties -* **Description**: string:

A description for a column.

-* **Name**: string:

A display name for the dataset.

-* **SubType**: string -* **Type**: string +* **FieldId**: string (Required) +* **Scope**: [PivotTableConditionalFormattingScope](#pivottableconditionalformattingscope) +* **Scopes**: [PivotTableConditionalFormattingScope](#pivottableconditionalformattingscope)[] +* **TextFormat**: [TextConditionalFormat](#textconditionalformat) -## ResourcePermission +## PivotTableCellConditionalFormatting ### Properties -* **Actions**: string[] (Required):

The IAM action to grant or revoke permissions on.

-* **Principal**: string (Required):

The Amazon Resource Name (ARN) of the principal. This can be one of the - following:

-
    -
  • -

    The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

    -
    • -
  • -

    The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)

    -
    • -
  • -

    The ARN of an AWS account root: This is an IAM ARN rather than a QuickSight - ARN. Use this option only to share resources (templates) across AWS accounts. - (This is less common.)

    -
    • -
+* **FieldId**: string (Required) +* **Scope**: [PivotTableConditionalFormattingScope](#pivottableconditionalformattingscope) +* **Scopes**: [PivotTableConditionalFormattingScope](#pivottableconditionalformattingscope)[] +* **TextFormat**: [TextConditionalFormat](#textconditionalformat) -## PhysicalTableMap +## PivotTableConditionalFormatting ### Properties +* **ConditionalFormattingOptions**: [PivotTableConditionalFormattingOption](#pivottableconditionalformattingoption)[] -## RowLevelPermissionDataSet +## PivotTableConditionalFormatting ### Properties -* **Arn**: string (Required):

The Amazon Resource Name (ARN) of the permission dataset.

-* **FormatVersion**: string -* **Namespace**: string:

The namespace associated with the row-level permissions dataset.

-* **PermissionPolicy**: string (Required) -* **Status**: string +* **ConditionalFormattingOptions**: [PivotTableConditionalFormattingOption](#pivottableconditionalformattingoption)[] -## RowLevelPermissionTagConfiguration +## PivotTableConditionalFormatting ### Properties -* **Status**: string -* **TagRuleConfigurations**: string[][]:

A list of tag configuration rules to apply to a dataset. All tag configurations have the OR condition. Tags within each tile will be joined (AND). At least one rule in this structure must have all tag values assigned to it to apply Row-level security (RLS) to the dataset.

-* **TagRules**: [RowLevelPermissionTagRule](#rowlevelpermissiontagrule)[] (Required):

A set of rules associated with row-level security, such as the tag names and columns that they are assigned to.

+* **ConditionalFormattingOptions**: [PivotTableConditionalFormattingOption](#pivottableconditionalformattingoption)[] -## RowLevelPermissionTagRule +## PivotTableConditionalFormattingOption ### Properties -* **ColumnName**: string (Required):

The column name that a tag key is assigned to.

-* **MatchAllValue**: string:

A string that you want to use to filter by all the values in a column in the dataset and don?t want to list the values one by one. For example, you can use an asterisk as your match all value.

-* **TagKey**: string (Required):

The unique key for a tag.

-* **TagMultiValueDelimiter**: string:

A 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.

+* **Cell**: [PivotTableCellConditionalFormatting](#pivottablecellconditionalformatting) -## Tag +## PivotTableConditionalFormattingOption ### Properties -* **Key**: string (Required):

Tag key.

-* **Value**: string (Required):

Tag value.

+* **Cell**: [PivotTableCellConditionalFormatting](#pivottablecellconditionalformatting) -## AWS.QuickSight/DataSourceProperties +## PivotTableConditionalFormattingOption ### Properties -* **AlternateDataSourceParameters**: [DataSourceParameters](#datasourceparameters)[]:

A set of alternate data source parameters that you want to share for the credentials - stored with this data source. The credentials are applied in tandem with the data source - parameters when you copy a data source by using a create or update request. The API - operation compares the DataSourceParameters structure that's in the request - with the structures in the AlternateDataSourceParameters allow list. If the - structures are an exact match, the request is allowed to use the credentials from this - existing data source. If the AlternateDataSourceParameters list is null, - the Credentials originally used with this DataSourceParameters - are automatically allowed.

-* **Arn**: string (ReadOnly):

The Amazon Resource Name (ARN) of the data source.

-* **AwsAccountId**: string (Identifier) -* **CreatedTime**: string (ReadOnly):

The time that this data source was created.

-* **Credentials**: [DataSourceCredentials](#datasourcecredentials) (WriteOnly) -* **DataSourceId**: string (Identifier) -* **DataSourceParameters**: [DataSourceParameters](#datasourceparameters) -* **ErrorInfo**: [DataSourceErrorInfo](#datasourceerrorinfo) -* **LastUpdatedTime**: string (ReadOnly):

The last time that this data source was updated.

-* **Name**: string:

A display name for the data source.

-* **Permissions**: [ResourcePermission](#resourcepermission)[]:

A list of resource permissions on the data source.

-* **SslProperties**: [SslProperties](#sslproperties) -* **Status**: string (ReadOnly) -* **Tags**: [Tag](#tag)[]:

Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.

-* **Type**: string -* **VpcConnectionProperties**: [VpcConnectionProperties](#vpcconnectionproperties) +* **Cell**: [PivotTableCellConditionalFormatting](#pivottablecellconditionalformatting) -## DataSourceParameters +## PivotTableConditionalFormattingScope ### Properties -* **AmazonElasticsearchParameters**: [AmazonElasticsearchParameters](#amazonelasticsearchparameters) -* **AmazonOpenSearchParameters**: [AmazonOpenSearchParameters](#amazonopensearchparameters) -* **AthenaParameters**: [AthenaParameters](#athenaparameters) -* **AuroraParameters**: [AuroraParameters](#auroraparameters) -* **AuroraPostgreSqlParameters**: [AuroraPostgreSqlParameters](#aurorapostgresqlparameters) -* **DatabricksParameters**: [DatabricksParameters](#databricksparameters) -* **MariaDbParameters**: [MariaDbParameters](#mariadbparameters) -* **MySqlParameters**: [MySqlParameters](#mysqlparameters) -* **OracleParameters**: [OracleParameters](#oracleparameters) -* **PostgreSqlParameters**: [PostgreSqlParameters](#postgresqlparameters) -* **PrestoParameters**: [PrestoParameters](#prestoparameters) -* **RdsParameters**: [RdsParameters](#rdsparameters) -* **RedshiftParameters**: [RedshiftParameters](#redshiftparameters) -* **S3Parameters**: [S3Parameters](#s3parameters) -* **SnowflakeParameters**: [SnowflakeParameters](#snowflakeparameters) -* **SparkParameters**: [SparkParameters](#sparkparameters) -* **SqlServerParameters**: [SqlServerParameters](#sqlserverparameters) -* **StarburstParameters**: [StarburstParameters](#starburstparameters) -* **TeradataParameters**: [TeradataParameters](#teradataparameters) -* **TrinoParameters**: [TrinoParameters](#trinoparameters) +* **Role**: string -## AmazonElasticsearchParameters +## PivotTableConditionalFormattingScope ### Properties -* **Domain**: string (Required):

The Amazon Elasticsearch Service domain.

+* **Role**: string -## AmazonOpenSearchParameters +## PivotTableConditionalFormattingScope ### Properties -* **Domain**: string (Required):

The Amazon OpenSearch Service domain.

+* **Role**: string -## AthenaParameters +## PivotTableConfiguration ### Properties -* **RoleArn**: string:

Use 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.

-* **WorkGroup**: string:

The workgroup that Amazon Athena uses.

+* **FieldOptions**: [PivotTableFieldOptions](#pivottablefieldoptions) +* **FieldWells**: [PivotTableFieldWells](#pivottablefieldwells) +* **PaginatedReportOptions**: [PivotTablePaginatedReportOptions](#pivottablepaginatedreportoptions) +* **SortConfiguration**: [PivotTableSortConfiguration](#pivottablesortconfiguration) +* **TableOptions**: [PivotTableOptions](#pivottableoptions) +* **TotalOptions**: [PivotTableTotalOptions](#pivottabletotaloptions) -## AuroraParameters +## PivotTableConfiguration ### Properties -* **Database**: string (Required):

Database.

-* **Host**: string (Required):

Host.

-* **Port**: int (Required):

Port.

+* **FieldOptions**: [PivotTableFieldOptions](#pivottablefieldoptions) +* **FieldWells**: [PivotTableFieldWells](#pivottablefieldwells) +* **PaginatedReportOptions**: [PivotTablePaginatedReportOptions](#pivottablepaginatedreportoptions) +* **SortConfiguration**: [PivotTableSortConfiguration](#pivottablesortconfiguration) +* **TableOptions**: [PivotTableOptions](#pivottableoptions) +* **TotalOptions**: [PivotTableTotalOptions](#pivottabletotaloptions) -## AuroraPostgreSqlParameters +## PivotTableConfiguration ### Properties -* **Database**: string (Required):

Database.

-* **Host**: string (Required):

Host.

-* **Port**: int (Required):

Port.

+* **FieldOptions**: [PivotTableFieldOptions](#pivottablefieldoptions) +* **FieldWells**: [PivotTableFieldWells](#pivottablefieldwells) +* **PaginatedReportOptions**: [PivotTablePaginatedReportOptions](#pivottablepaginatedreportoptions) +* **SortConfiguration**: [PivotTableSortConfiguration](#pivottablesortconfiguration) +* **TableOptions**: [PivotTableOptions](#pivottableoptions) +* **TotalOptions**: [PivotTableTotalOptions](#pivottabletotaloptions) -## DatabricksParameters +## PivotTableDataPathOption ### Properties -* **Host**: string (Required):

Host.

-* **Port**: int (Required):

Port.

-* **SqlEndpointPath**: string (Required):

The HTTP Path of the Databricks data source.

+* **DataPathList**: [DataPathValue](#datapathvalue)[] (Required) +* **Width**: string: String based length that is composed of value and unit in px -## MariaDbParameters +## PivotTableDataPathOption ### Properties -* **Database**: string (Required):

Database.

-* **Host**: string (Required):

Host.

-* **Port**: int (Required):

Port.

+* **DataPathList**: [DataPathValue](#datapathvalue)[] (Required) +* **Width**: string: String based length that is composed of value and unit in px -## MySqlParameters +## PivotTableDataPathOption ### Properties -* **Database**: string (Required):

Database.

-* **Host**: string (Required):

Host.

-* **Port**: int (Required):

Port.

+* **DataPathList**: [DataPathValue](#datapathvalue)[] (Required) +* **Width**: string: String based length that is composed of value and unit in px -## OracleParameters +## PivotTableFieldCollapseStateOption ### Properties -* **Database**: string (Required) -* **Host**: string (Required) -* **Port**: int (Required) +* **State**: string +* **Target**: [PivotTableFieldCollapseStateTarget](#pivottablefieldcollapsestatetarget) (Required) -## PostgreSqlParameters +## PivotTableFieldCollapseStateOption ### Properties -* **Database**: string (Required):

Database.

-* **Host**: string (Required):

Host.

-* **Port**: int (Required):

Port.

+* **State**: string +* **Target**: [PivotTableFieldCollapseStateTarget](#pivottablefieldcollapsestatetarget) (Required) -## PrestoParameters +## PivotTableFieldCollapseStateOption ### Properties -* **Catalog**: string (Required):

Catalog.

-* **Host**: string (Required):

Host.

-* **Port**: int (Required):

Port.

+* **State**: string +* **Target**: [PivotTableFieldCollapseStateTarget](#pivottablefieldcollapsestatetarget) (Required) -## RdsParameters +## PivotTableFieldCollapseStateTarget ### Properties -* **Database**: string (Required):

Database.

-* **InstanceId**: string (Required):

Instance ID.

+* **FieldDataPathValues**: [DataPathValue](#datapathvalue)[] +* **FieldId**: string -## RedshiftParameters +## PivotTableFieldCollapseStateTarget ### Properties -* **ClusterId**: string:

Cluster ID. This field can be blank if the Host and Port are - provided.

-* **Database**: string (Required):

Database.

-* **Host**: string:

Host. This field can be blank if ClusterId is provided.

-* **Port**: int:

Port. This field can be blank if the ClusterId is provided.

+* **FieldDataPathValues**: [DataPathValue](#datapathvalue)[] +* **FieldId**: string -## S3Parameters +## PivotTableFieldCollapseStateTarget ### Properties -* **ManifestFileLocation**: [ManifestFileLocation](#manifestfilelocation) (Required) -* **RoleArn**: string:

Use 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.

+* **FieldDataPathValues**: [DataPathValue](#datapathvalue)[] +* **FieldId**: string -## ManifestFileLocation +## PivotTableFieldOption ### Properties -* **Bucket**: string (Required):

Amazon S3 bucket.

-* **Key**: string (Required):

Amazon S3 key that identifies an object.

+* **CustomLabel**: string +* **FieldId**: string (Required) +* **Visibility**: string -## SnowflakeParameters +## PivotTableFieldOption ### Properties -* **Database**: string (Required):

Database.

-* **Host**: string (Required):

Host.

-* **Warehouse**: string (Required):

Warehouse.

+* **CustomLabel**: string +* **FieldId**: string (Required) +* **Visibility**: string -## SparkParameters +## PivotTableFieldOption ### Properties -* **Host**: string (Required):

Host.

-* **Port**: int (Required):

Port.

+* **CustomLabel**: string +* **FieldId**: string (Required) +* **Visibility**: string -## SqlServerParameters +## PivotTableFieldOptions ### Properties -* **Database**: string (Required):

Database.

-* **Host**: string (Required):

Host.

-* **Port**: int (Required):

Port.

+* **CollapseStateOptions**: [PivotTableFieldCollapseStateOption](#pivottablefieldcollapsestateoption)[] +* **DataPathOptions**: [PivotTableDataPathOption](#pivottabledatapathoption)[] +* **SelectedFieldOptions**: [PivotTableFieldOption](#pivottablefieldoption)[] -## StarburstParameters +## PivotTableFieldOptions ### Properties -* **Catalog**: string (Required):

Catalog.

-* **Host**: string (Required):

Host.

-* **Port**: int (Required):

Port.

-* **ProductType**: string +* **CollapseStateOptions**: [PivotTableFieldCollapseStateOption](#pivottablefieldcollapsestateoption)[] +* **DataPathOptions**: [PivotTableDataPathOption](#pivottabledatapathoption)[] +* **SelectedFieldOptions**: [PivotTableFieldOption](#pivottablefieldoption)[] -## TeradataParameters +## PivotTableFieldOptions ### Properties -* **Database**: string (Required):

Database.

-* **Host**: string (Required):

Host.

-* **Port**: int (Required):

Port.

+* **CollapseStateOptions**: [PivotTableFieldCollapseStateOption](#pivottablefieldcollapsestateoption)[] +* **DataPathOptions**: [PivotTableDataPathOption](#pivottabledatapathoption)[] +* **SelectedFieldOptions**: [PivotTableFieldOption](#pivottablefieldoption)[] -## TrinoParameters +## PivotTableFieldSubtotalOptions ### Properties -* **Catalog**: string (Required):

Catalog.

-* **Host**: string (Required):

Host.

-* **Port**: int (Required):

Port.

+* **FieldId**: string -## DataSourceCredentials +## PivotTableFieldSubtotalOptions ### Properties -* **CopySourceArn**: string:

The Amazon Resource Name (ARN) of a data source that has the credential pair that you - want to use. When CopySourceArn is not null, the credential pair from the - data source in the ARN is used as the credentials for the - DataSourceCredentials structure.

-* **CredentialPair**: [CredentialPair](#credentialpair) -* **SecretArn**: string:

The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.

+* **FieldId**: string -## CredentialPair +## PivotTableFieldSubtotalOptions ### Properties -* **AlternateDataSourceParameters**: [DataSourceParameters](#datasourceparameters)[]:

A set of alternate data source parameters that you want to share for these - credentials. The credentials are applied in tandem with the data source parameters when - you copy a data source by using a create or update request. The API operation compares - the DataSourceParameters structure that's in the request with the - structures in the AlternateDataSourceParameters allow list. If the - structures are an exact match, the request is allowed to use the new data source with - the existing credentials. If the AlternateDataSourceParameters list is - null, the DataSourceParameters originally used with these - Credentials is automatically allowed.

-* **Password**: string (Required):

Password.

-* **Username**: string (Required):

User name.

+* **FieldId**: string -## DataSourceErrorInfo +## PivotTableFieldWells ### Properties -* **Message**: string:

Error message.

-* **Type**: string +* **PivotTableAggregatedFieldWells**: [PivotTableAggregatedFieldWells](#pivottableaggregatedfieldwells) -## ResourcePermission +## PivotTableFieldWells ### Properties -* **Actions**: string[] (Required):

The IAM action to grant or revoke permissions on.

-* **Principal**: string (Required):

The Amazon Resource Name (ARN) of the principal. This can be one of the - following:

-
    -
  • -

    The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

    -
    • -
  • -

    The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)

    -
    • -
  • -

    The ARN of an AWS account root: This is an IAM ARN rather than a QuickSight - ARN. Use this option only to share resources (templates) across AWS accounts. - (This is less common.)

    -
    • -
+* **PivotTableAggregatedFieldWells**: [PivotTableAggregatedFieldWells](#pivottableaggregatedfieldwells) -## SslProperties +## PivotTableFieldWells ### Properties -* **DisableSsl**: bool:

A Boolean option to control whether SSL should be disabled.

+* **PivotTableAggregatedFieldWells**: [PivotTableAggregatedFieldWells](#pivottableaggregatedfieldwells) -## Tag +## PivotTableOptions ### Properties -* **Key**: string (Required):

Tag key.

-* **Value**: string (Required):

Tag value.

+* **CellStyle**: [TableCellStyle](#tablecellstyle) +* **CollapsedRowDimensionsVisibility**: string +* **ColumnHeaderStyle**: [TableCellStyle](#tablecellstyle) +* **ColumnNamesVisibility**: string +* **DefaultCellWidth**: string: String based length that is composed of value and unit in px +* **MetricPlacement**: string +* **RowAlternateColorOptions**: [RowAlternateColorOptions](#rowalternatecoloroptions) +* **RowFieldNamesStyle**: [TableCellStyle](#tablecellstyle) +* **RowHeaderStyle**: [TableCellStyle](#tablecellstyle) +* **RowsLabelOptions**: [PivotTableRowsLabelOptions](#pivottablerowslabeloptions) +* **RowsLayout**: string +* **SingleMetricVisibility**: string +* **ToggleButtonsVisibility**: string -## VpcConnectionProperties +## PivotTableOptions ### Properties -* **VpcConnectionArn**: string (Required):

The Amazon Resource Name (ARN) for the VPC connection.

+* **CellStyle**: [TableCellStyle](#tablecellstyle) +* **CollapsedRowDimensionsVisibility**: string +* **ColumnHeaderStyle**: [TableCellStyle](#tablecellstyle) +* **ColumnNamesVisibility**: string +* **DefaultCellWidth**: string: String based length that is composed of value and unit in px +* **MetricPlacement**: string +* **RowAlternateColorOptions**: [RowAlternateColorOptions](#rowalternatecoloroptions) +* **RowFieldNamesStyle**: [TableCellStyle](#tablecellstyle) +* **RowHeaderStyle**: [TableCellStyle](#tablecellstyle) +* **RowsLabelOptions**: [PivotTableRowsLabelOptions](#pivottablerowslabeloptions) +* **RowsLayout**: string +* **SingleMetricVisibility**: string +* **ToggleButtonsVisibility**: string -## AWS.QuickSight/RefreshScheduleProperties +## PivotTableOptions ### Properties -* **Arn**: string (ReadOnly):

The Amazon Resource Name (ARN) of the data source.

-* **AwsAccountId**: string (Identifier) -* **DataSetId**: string (Identifier) -* **Schedule**: [RefreshScheduleMap](#refreshschedulemap) +* **CellStyle**: [TableCellStyle](#tablecellstyle) +* **CollapsedRowDimensionsVisibility**: string +* **ColumnHeaderStyle**: [TableCellStyle](#tablecellstyle) +* **ColumnNamesVisibility**: string +* **DefaultCellWidth**: string: String based length that is composed of value and unit in px +* **MetricPlacement**: string +* **RowAlternateColorOptions**: [RowAlternateColorOptions](#rowalternatecoloroptions) +* **RowFieldNamesStyle**: [TableCellStyle](#tablecellstyle) +* **RowHeaderStyle**: [TableCellStyle](#tablecellstyle) +* **RowsLabelOptions**: [PivotTableRowsLabelOptions](#pivottablerowslabeloptions) +* **RowsLayout**: string +* **SingleMetricVisibility**: string +* **ToggleButtonsVisibility**: string -## RefreshScheduleMap +## PivotTablePaginatedReportOptions ### Properties -* **RefreshType**: string -* **ScheduleFrequency**: [RefreshSchedule_ScheduleFrequency](#refreshscheduleschedulefrequency):

Information about the schedule frequency.

-* **ScheduleId**: string:

An unique identifier for the refresh schedule.

-* **StartAfterDateTime**: string:

The date time after which refresh is to be scheduled

+* **OverflowColumnHeaderVisibility**: string +* **VerticalOverflowVisibility**: string -## RefreshSchedule_ScheduleFrequency +## PivotTablePaginatedReportOptions ### Properties -* **Interval**: string -* **RefreshOnDay**: [RefreshSchedule_ScheduleFrequency_RefreshOnDay](#refreshscheduleschedulefrequencyrefreshonday):

The day scheduled for refresh.

-* **TimeOfTheDay**: string:

The time of the day for scheduled refresh.

-* **TimeZone**: string:

The timezone for scheduled refresh.

+* **OverflowColumnHeaderVisibility**: string +* **VerticalOverflowVisibility**: string -## RefreshSchedule_ScheduleFrequency_RefreshOnDay +## PivotTablePaginatedReportOptions ### Properties -* **DayOfMonth**: string:

The Day Of Month for scheduled refresh.

-* **DayOfWeek**: string +* **OverflowColumnHeaderVisibility**: string +* **VerticalOverflowVisibility**: string -## AWS.QuickSight/TemplateProperties +## PivotTableRowsLabelOptions ### Properties -* **Arn**: string (ReadOnly) -* **AwsAccountId**: string (Required, Identifier) -* **CreatedTime**: string (ReadOnly) -* **Definition**: [TemplateVersionDefinition](#templateversiondefinition) (WriteOnly) -* **LastUpdatedTime**: string (ReadOnly) -* **Name**: string -* **Permissions**: [ResourcePermission](#resourcepermission)[] -* **SourceEntity**: [TemplateSourceEntity](#templatesourceentity) (WriteOnly) -* **Tags**: [Tag](#tag)[] -* **TemplateId**: string (Required, Identifier) -* **ValidationStrategy**: [ValidationStrategy](#validationstrategy) (WriteOnly) -* **Version**: [TemplateVersion](#templateversion) (ReadOnly) -* **VersionDescription**: string (WriteOnly) +* **CustomLabel**: string +* **Visibility**: string -## TemplateVersionDefinition +## PivotTableRowsLabelOptions ### Properties -* **AnalysisDefaults**: [AnalysisDefaults](#analysisdefaults) -* **CalculatedFields**: [CalculatedField](#calculatedfield)[] -* **ColumnConfigurations**: [ColumnConfiguration](#columnconfiguration)[] -* **DataSetConfigurations**: [DataSetConfiguration](#datasetconfiguration)[] (Required) -* **FilterGroups**: [FilterGroup](#filtergroup)[] -* **Options**: [AssetOptions](#assetoptions) -* **ParameterDeclarations**: [ParameterDeclaration](#parameterdeclaration)[] -* **Sheets**: [SheetDefinition](#sheetdefinition)[] +* **CustomLabel**: string +* **Visibility**: string -## AnalysisDefaults +## PivotTableRowsLabelOptions ### Properties -* **DefaultNewSheetConfiguration**: [DefaultNewSheetConfiguration](#defaultnewsheetconfiguration) (Required) +* **CustomLabel**: string +* **Visibility**: string -## DefaultNewSheetConfiguration +## PivotTableSortBy ### Properties -* **InteractiveLayoutConfiguration**: [DefaultInteractiveLayoutConfiguration](#defaultinteractivelayoutconfiguration) -* **PaginatedLayoutConfiguration**: [DefaultPaginatedLayoutConfiguration](#defaultpaginatedlayoutconfiguration) -* **SheetContentType**: string +* **Column**: [ColumnSort](#columnsort) +* **DataPath**: [DataPathSort](#datapathsort) +* **Field**: [FieldSort](#fieldsort) -## DefaultInteractiveLayoutConfiguration +## PivotTableSortBy ### Properties -* **FreeForm**: [DefaultFreeFormLayoutConfiguration](#defaultfreeformlayoutconfiguration) -* **Grid**: [DefaultGridLayoutConfiguration](#defaultgridlayoutconfiguration) +* **Column**: [ColumnSort](#columnsort) +* **DataPath**: [DataPathSort](#datapathsort) +* **Field**: [FieldSort](#fieldsort) -## DefaultFreeFormLayoutConfiguration +## PivotTableSortBy ### Properties -* **CanvasSizeOptions**: [FreeFormLayoutCanvasSizeOptions](#freeformlayoutcanvassizeoptions) (Required) +* **Column**: [ColumnSort](#columnsort) +* **DataPath**: [DataPathSort](#datapathsort) +* **Field**: [FieldSort](#fieldsort) -## FreeFormLayoutCanvasSizeOptions +## PivotTableSortConfiguration ### Properties -* **ScreenCanvasSizeOptions**: [FreeFormLayoutScreenCanvasSizeOptions](#freeformlayoutscreencanvassizeoptions) +* **FieldSortOptions**: [PivotFieldSortOptions](#pivotfieldsortoptions)[] -## FreeFormLayoutScreenCanvasSizeOptions +## PivotTableSortConfiguration ### Properties -* **OptimizedViewPortWidth**: string (Required): String based length that is composed of value and unit in px +* **FieldSortOptions**: [PivotFieldSortOptions](#pivotfieldsortoptions)[] -## DefaultGridLayoutConfiguration +## PivotTableSortConfiguration ### Properties -* **CanvasSizeOptions**: [GridLayoutCanvasSizeOptions](#gridlayoutcanvassizeoptions) (Required) +* **FieldSortOptions**: [PivotFieldSortOptions](#pivotfieldsortoptions)[] -## GridLayoutCanvasSizeOptions +## PivotTableTotalOptions ### Properties -* **ScreenCanvasSizeOptions**: [GridLayoutScreenCanvasSizeOptions](#gridlayoutscreencanvassizeoptions) +* **ColumnSubtotalOptions**: [SubtotalOptions](#subtotaloptions) +* **ColumnTotalOptions**: [PivotTotalOptions](#pivottotaloptions) +* **RowSubtotalOptions**: [SubtotalOptions](#subtotaloptions) +* **RowTotalOptions**: [PivotTotalOptions](#pivottotaloptions) -## GridLayoutScreenCanvasSizeOptions +## PivotTableTotalOptions ### Properties -* **OptimizedViewPortWidth**: string: String based length that is composed of value and unit in px -* **ResizeOption**: string (Required) +* **ColumnSubtotalOptions**: [SubtotalOptions](#subtotaloptions) +* **ColumnTotalOptions**: [PivotTotalOptions](#pivottotaloptions) +* **RowSubtotalOptions**: [SubtotalOptions](#subtotaloptions) +* **RowTotalOptions**: [PivotTotalOptions](#pivottotaloptions) + +## PivotTableTotalOptions +### Properties +* **ColumnSubtotalOptions**: [SubtotalOptions](#subtotaloptions) +* **ColumnTotalOptions**: [PivotTotalOptions](#pivottotaloptions) +* **RowSubtotalOptions**: [SubtotalOptions](#subtotaloptions) +* **RowTotalOptions**: [PivotTotalOptions](#pivottotaloptions) -## DefaultPaginatedLayoutConfiguration +## PivotTableVisual ### Properties -* **SectionBased**: [DefaultSectionBasedLayoutConfiguration](#defaultsectionbasedlayoutconfiguration) +* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **ChartConfiguration**: [PivotTableConfiguration](#pivottableconfiguration) +* **ConditionalFormatting**: [PivotTableConditionalFormatting](#pivottableconditionalformatting) +* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) +* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) +* **VisualId**: string (Required) -## DefaultSectionBasedLayoutConfiguration +## PivotTableVisual ### Properties -* **CanvasSizeOptions**: [SectionBasedLayoutCanvasSizeOptions](#sectionbasedlayoutcanvassizeoptions) (Required) +* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **ChartConfiguration**: [PivotTableConfiguration](#pivottableconfiguration) +* **ConditionalFormatting**: [PivotTableConditionalFormatting](#pivottableconditionalformatting) +* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) +* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) +* **VisualId**: string (Required) -## SectionBasedLayoutCanvasSizeOptions +## PivotTableVisual ### Properties -* **PaperCanvasSizeOptions**: [SectionBasedLayoutPaperCanvasSizeOptions](#sectionbasedlayoutpapercanvassizeoptions) +* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **ChartConfiguration**: [PivotTableConfiguration](#pivottableconfiguration) +* **ConditionalFormatting**: [PivotTableConditionalFormatting](#pivottableconditionalformatting) +* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) +* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) +* **VisualId**: string (Required) -## SectionBasedLayoutPaperCanvasSizeOptions +## PivotTotalOptions ### Properties -* **PaperMargin**: [Spacing](#spacing) -* **PaperOrientation**: string -* **PaperSize**: string +* **CustomLabel**: string +* **MetricHeaderCellStyle**: [TableCellStyle](#tablecellstyle) +* **Placement**: string +* **ScrollStatus**: string +* **TotalAggregationOptions**: [TotalAggregationOption](#totalaggregationoption)[] +* **TotalCellStyle**: [TableCellStyle](#tablecellstyle) +* **TotalsVisibility**: string +* **ValueCellStyle**: [TableCellStyle](#tablecellstyle) -## Spacing +## PivotTotalOptions ### Properties -* **Bottom**: string: String based length that is composed of value and unit -* **Left**: string: String based length that is composed of value and unit -* **Right**: string: String based length that is composed of value and unit -* **Top**: string: String based length that is composed of value and unit +* **CustomLabel**: string +* **MetricHeaderCellStyle**: [TableCellStyle](#tablecellstyle) +* **Placement**: string +* **ScrollStatus**: string +* **TotalAggregationOptions**: [TotalAggregationOption](#totalaggregationoption)[] +* **TotalCellStyle**: [TableCellStyle](#tablecellstyle) +* **TotalsVisibility**: string +* **ValueCellStyle**: [TableCellStyle](#tablecellstyle) -## CalculatedField +## PivotTotalOptions ### Properties -* **DataSetIdentifier**: string (Required) -* **Expression**: string (Required) -* **Name**: string (Required) +* **CustomLabel**: string +* **MetricHeaderCellStyle**: [TableCellStyle](#tablecellstyle) +* **Placement**: string +* **ScrollStatus**: string +* **TotalAggregationOptions**: [TotalAggregationOption](#totalaggregationoption)[] +* **TotalCellStyle**: [TableCellStyle](#tablecellstyle) +* **TotalsVisibility**: string +* **ValueCellStyle**: [TableCellStyle](#tablecellstyle) -## ColumnConfiguration +## PostgreSqlParameters ### Properties -* **ColorsConfiguration**: [ColorsConfiguration](#colorsconfiguration) -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **FormatConfiguration**: [FormatConfiguration](#formatconfiguration) -* **Role**: string +* **Database**: string (Required):

Database.

+* **Host**: string (Required):

Host.

+* **Port**: int (Required):

Port.

-## ColorsConfiguration +## PredefinedHierarchy ### Properties -* **CustomColors**: [CustomColor](#customcolor)[] +* **Columns**: [ColumnIdentifier](#columnidentifier)[] (Required) +* **DrillDownFilters**: [DrillDownFilter](#drilldownfilter)[] +* **HierarchyId**: string (Required) -## CustomColor +## PredefinedHierarchy ### Properties -* **Color**: string (Required) -* **FieldValue**: string -* **SpecialValue**: string +* **Columns**: [ColumnIdentifier](#columnidentifier)[] (Required) +* **DrillDownFilters**: [DrillDownFilter](#drilldownfilter)[] +* **HierarchyId**: string (Required) -## ColumnIdentifier +## PredefinedHierarchy ### Properties -* **ColumnName**: string (Required) -* **DataSetIdentifier**: string (Required) +* **Columns**: [ColumnIdentifier](#columnidentifier)[] (Required) +* **DrillDownFilters**: [DrillDownFilter](#drilldownfilter)[] +* **HierarchyId**: string (Required) -## FormatConfiguration +## PrestoParameters ### Properties -* **DateTimeFormatConfiguration**: [DateTimeFormatConfiguration](#datetimeformatconfiguration) -* **NumberFormatConfiguration**: [NumberFormatConfiguration](#numberformatconfiguration) -* **StringFormatConfiguration**: [StringFormatConfiguration](#stringformatconfiguration) +* **Catalog**: string (Required):

Catalog.

+* **Host**: string (Required):

Host.

+* **Port**: int (Required):

Port.

-## DateTimeFormatConfiguration +## ProgressBarOptions ### Properties -* **DateTimeFormat**: string -* **NullValueFormatConfiguration**: [NullValueFormatConfiguration](#nullvalueformatconfiguration) -* **NumericFormatConfiguration**: [NumericFormatConfiguration](#numericformatconfiguration) +* **Visibility**: string -## NullValueFormatConfiguration +## ProgressBarOptions ### Properties -* **NullString**: string (Required) +* **Visibility**: string -## NumericFormatConfiguration +## ProgressBarOptions ### Properties -* **CurrencyDisplayFormatConfiguration**: [CurrencyDisplayFormatConfiguration](#currencydisplayformatconfiguration) -* **NumberDisplayFormatConfiguration**: [NumberDisplayFormatConfiguration](#numberdisplayformatconfiguration) -* **PercentageDisplayFormatConfiguration**: [PercentageDisplayFormatConfiguration](#percentagedisplayformatconfiguration) +* **Visibility**: string -## CurrencyDisplayFormatConfiguration +## RadarChartAggregatedFieldWells ### Properties -* **DecimalPlacesConfiguration**: [DecimalPlacesConfiguration](#decimalplacesconfiguration) -* **NegativeValueConfiguration**: [NegativeValueConfiguration](#negativevalueconfiguration) -* **NullValueFormatConfiguration**: [NullValueFormatConfiguration](#nullvalueformatconfiguration) -* **NumberScale**: string -* **Prefix**: string -* **SeparatorConfiguration**: [NumericSeparatorConfiguration](#numericseparatorconfiguration) -* **Suffix**: string -* **Symbol**: string +* **Category**: [DimensionField](#dimensionfield)[] +* **Color**: [DimensionField](#dimensionfield)[] +* **Values**: [MeasureField](#measurefield)[] -## DecimalPlacesConfiguration +## RadarChartAggregatedFieldWells ### Properties -* **DecimalPlaces**: int (Required) +* **Category**: [DimensionField](#dimensionfield)[] +* **Color**: [DimensionField](#dimensionfield)[] +* **Values**: [MeasureField](#measurefield)[] -## NegativeValueConfiguration +## RadarChartAggregatedFieldWells ### Properties -* **DisplayMode**: string (Required) +* **Category**: [DimensionField](#dimensionfield)[] +* **Color**: [DimensionField](#dimensionfield)[] +* **Values**: [MeasureField](#measurefield)[] -## NumericSeparatorConfiguration +## RadarChartAreaStyleSettings ### Properties -* **DecimalSeparator**: string -* **ThousandsSeparator**: [ThousandSeparatorOptions](#thousandseparatoroptions) +* **Visibility**: string -## ThousandSeparatorOptions +## RadarChartAreaStyleSettings ### Properties -* **Symbol**: string * **Visibility**: string -## NumberDisplayFormatConfiguration +## RadarChartAreaStyleSettings ### Properties -* **DecimalPlacesConfiguration**: [DecimalPlacesConfiguration](#decimalplacesconfiguration) -* **NegativeValueConfiguration**: [NegativeValueConfiguration](#negativevalueconfiguration) -* **NullValueFormatConfiguration**: [NullValueFormatConfiguration](#nullvalueformatconfiguration) -* **NumberScale**: string -* **Prefix**: string -* **SeparatorConfiguration**: [NumericSeparatorConfiguration](#numericseparatorconfiguration) -* **Suffix**: string +* **Visibility**: string -## PercentageDisplayFormatConfiguration +## RadarChartConfiguration ### Properties -* **DecimalPlacesConfiguration**: [DecimalPlacesConfiguration](#decimalplacesconfiguration) -* **NegativeValueConfiguration**: [NegativeValueConfiguration](#negativevalueconfiguration) -* **NullValueFormatConfiguration**: [NullValueFormatConfiguration](#nullvalueformatconfiguration) -* **Prefix**: string -* **SeparatorConfiguration**: [NumericSeparatorConfiguration](#numericseparatorconfiguration) -* **Suffix**: string +* **AlternateBandColorsVisibility**: string +* **AlternateBandEvenColor**: string +* **AlternateBandOddColor**: string +* **AxesRangeScale**: string +* **BaseSeriesSettings**: [RadarChartSeriesSettings](#radarchartseriessettings) +* **CategoryAxis**: [AxisDisplayOptions](#axisdisplayoptions) +* **CategoryLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **ColorAxis**: [AxisDisplayOptions](#axisdisplayoptions) +* **ColorLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **FieldWells**: [RadarChartFieldWells](#radarchartfieldwells) +* **Legend**: [LegendOptions](#legendoptions) +* **Shape**: string +* **SortConfiguration**: [RadarChartSortConfiguration](#radarchartsortconfiguration) +* **StartAngle**: int +* **VisualPalette**: [VisualPalette](#visualpalette) -## NumberFormatConfiguration +## RadarChartConfiguration ### Properties -* **FormatConfiguration**: [NumericFormatConfiguration](#numericformatconfiguration) +* **AlternateBandColorsVisibility**: string +* **AlternateBandEvenColor**: string +* **AlternateBandOddColor**: string +* **AxesRangeScale**: string +* **BaseSeriesSettings**: [RadarChartSeriesSettings](#radarchartseriessettings) +* **CategoryAxis**: [AxisDisplayOptions](#axisdisplayoptions) +* **CategoryLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **ColorAxis**: [AxisDisplayOptions](#axisdisplayoptions) +* **ColorLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **FieldWells**: [RadarChartFieldWells](#radarchartfieldwells) +* **Legend**: [LegendOptions](#legendoptions) +* **Shape**: string +* **SortConfiguration**: [RadarChartSortConfiguration](#radarchartsortconfiguration) +* **StartAngle**: int +* **VisualPalette**: [VisualPalette](#visualpalette) -## StringFormatConfiguration +## RadarChartConfiguration ### Properties -* **NullValueFormatConfiguration**: [NullValueFormatConfiguration](#nullvalueformatconfiguration) -* **NumericFormatConfiguration**: [NumericFormatConfiguration](#numericformatconfiguration) +* **AlternateBandColorsVisibility**: string +* **AlternateBandEvenColor**: string +* **AlternateBandOddColor**: string +* **AxesRangeScale**: string +* **BaseSeriesSettings**: [RadarChartSeriesSettings](#radarchartseriessettings) +* **CategoryAxis**: [AxisDisplayOptions](#axisdisplayoptions) +* **CategoryLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **ColorAxis**: [AxisDisplayOptions](#axisdisplayoptions) +* **ColorLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **FieldWells**: [RadarChartFieldWells](#radarchartfieldwells) +* **Legend**: [LegendOptions](#legendoptions) +* **Shape**: string +* **SortConfiguration**: [RadarChartSortConfiguration](#radarchartsortconfiguration) +* **StartAngle**: int +* **VisualPalette**: [VisualPalette](#visualpalette) -## DataSetConfiguration +## RadarChartFieldWells ### Properties -* **ColumnGroupSchemaList**: [ColumnGroupSchema](#columngroupschema)[] -* **DataSetSchema**: [DataSetSchema](#datasetschema) -* **Placeholder**: string +* **RadarChartAggregatedFieldWells**: [RadarChartAggregatedFieldWells](#radarchartaggregatedfieldwells) -## ColumnGroupSchema +## RadarChartFieldWells ### Properties -* **ColumnGroupColumnSchemaList**: [ColumnGroupColumnSchema](#columngroupcolumnschema)[] -* **Name**: string +* **RadarChartAggregatedFieldWells**: [RadarChartAggregatedFieldWells](#radarchartaggregatedfieldwells) -## ColumnGroupColumnSchema +## RadarChartFieldWells ### Properties -* **Name**: string +* **RadarChartAggregatedFieldWells**: [RadarChartAggregatedFieldWells](#radarchartaggregatedfieldwells) -## DataSetSchema +## RadarChartSeriesSettings ### Properties -* **ColumnSchemaList**: [ColumnSchema](#columnschema)[] +* **AreaStyleSettings**: [RadarChartAreaStyleSettings](#radarchartareastylesettings) -## ColumnSchema +## RadarChartSeriesSettings ### Properties -* **DataType**: string -* **GeographicRole**: string -* **Name**: string +* **AreaStyleSettings**: [RadarChartAreaStyleSettings](#radarchartareastylesettings) -## FilterGroup +## RadarChartSeriesSettings ### Properties -* **CrossDataset**: string (Required) -* **FilterGroupId**: string (Required) -* **Filters**: [Filter](#filter)[] (Required) -* **ScopeConfiguration**: [FilterScopeConfiguration](#filterscopeconfiguration) (Required) -* **Status**: string +* **AreaStyleSettings**: [RadarChartAreaStyleSettings](#radarchartareastylesettings) -## Filter +## RadarChartSortConfiguration ### Properties -* **CategoryFilter**: [CategoryFilter](#categoryfilter) -* **NumericEqualityFilter**: [NumericEqualityFilter](#numericequalityfilter) -* **NumericRangeFilter**: [NumericRangeFilter](#numericrangefilter) -* **RelativeDatesFilter**: [RelativeDatesFilter](#relativedatesfilter) -* **TimeEqualityFilter**: [TimeEqualityFilter](#timeequalityfilter) -* **TimeRangeFilter**: [TimeRangeFilter](#timerangefilter) -* **TopBottomFilter**: [TopBottomFilter](#topbottomfilter) +* **CategoryItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) +* **CategorySort**: [FieldSortOptions](#fieldsortoptions)[] +* **ColorItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) +* **ColorSort**: [FieldSortOptions](#fieldsortoptions)[] -## CategoryFilter +## RadarChartSortConfiguration ### Properties -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **Configuration**: [CategoryFilterConfiguration](#categoryfilterconfiguration) (Required) -* **FilterId**: string (Required) +* **CategoryItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) +* **CategorySort**: [FieldSortOptions](#fieldsortoptions)[] +* **ColorItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) +* **ColorSort**: [FieldSortOptions](#fieldsortoptions)[] -## CategoryFilterConfiguration +## RadarChartSortConfiguration ### Properties -* **CustomFilterConfiguration**: [CustomFilterConfiguration](#customfilterconfiguration) -* **CustomFilterListConfiguration**: [CustomFilterListConfiguration](#customfilterlistconfiguration) -* **FilterListConfiguration**: [FilterListConfiguration](#filterlistconfiguration) +* **CategoryItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) +* **CategorySort**: [FieldSortOptions](#fieldsortoptions)[] +* **ColorItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) +* **ColorSort**: [FieldSortOptions](#fieldsortoptions)[] -## CustomFilterConfiguration +## RadarChartVisual ### Properties -* **CategoryValue**: string -* **MatchOperator**: string (Required) -* **NullOption**: string (Required) -* **ParameterName**: string -* **SelectAllOptions**: string +* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **ChartConfiguration**: [RadarChartConfiguration](#radarchartconfiguration) +* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] +* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) +* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) +* **VisualId**: string (Required) -## CustomFilterListConfiguration +## RadarChartVisual ### Properties -* **CategoryValues**: string[] -* **MatchOperator**: string (Required) -* **NullOption**: string (Required) -* **SelectAllOptions**: string +* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **ChartConfiguration**: [RadarChartConfiguration](#radarchartconfiguration) +* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] +* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) +* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) +* **VisualId**: string (Required) -## FilterListConfiguration +## RadarChartVisual ### Properties -* **CategoryValues**: string[] -* **MatchOperator**: string (Required) -* **NullOption**: string -* **SelectAllOptions**: string +* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **ChartConfiguration**: [RadarChartConfiguration](#radarchartconfiguration) +* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] +* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) +* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) +* **VisualId**: string (Required) -## NumericEqualityFilter +## RangeConstant ### Properties -* **AggregationFunction**: [AggregationFunction](#aggregationfunction) -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **FilterId**: string (Required) -* **MatchOperator**: string (Required) -* **NullOption**: string (Required) -* **ParameterName**: string -* **SelectAllOptions**: string -* **Value**: int +* **Maximum**: string +* **Minimum**: string -## AggregationFunction +## RangeEndsLabelType ### Properties -* **AttributeAggregationFunction**: [AttributeAggregationFunction](#attributeaggregationfunction) -* **CategoricalAggregationFunction**: string -* **DateAggregationFunction**: string -* **NumericalAggregationFunction**: [NumericalAggregationFunction](#numericalaggregationfunction) +* **Visibility**: string -## AttributeAggregationFunction +## RangeEndsLabelType ### Properties -* **SimpleAttributeAggregation**: string -* **ValueForMultipleValues**: string +* **Visibility**: string -## NumericalAggregationFunction +## RangeEndsLabelType ### Properties -* **PercentileAggregation**: [PercentileAggregation](#percentileaggregation) -* **SimpleNumericalAggregation**: string +* **Visibility**: string -## PercentileAggregation +## RdsParameters ### Properties -* **PercentileValue**: int +* **Database**: string (Required):

Database.

+* **InstanceId**: string (Required):

Instance ID.

-## NumericRangeFilter +## RedshiftIAMParameters ### Properties -* **AggregationFunction**: [AggregationFunction](#aggregationfunction) -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **FilterId**: string (Required) -* **IncludeMaximum**: bool -* **IncludeMinimum**: bool -* **NullOption**: string (Required) -* **RangeMaximum**: [NumericRangeFilterValue](#numericrangefiltervalue) -* **RangeMinimum**: [NumericRangeFilterValue](#numericrangefiltervalue) -* **SelectAllOptions**: string +* **AutoCreateDatabaseUser**: bool:

Automatically creates a database user. If your database doesn't have a DatabaseUser, set this parameter to True. If there is no DatabaseUser, Amazon QuickSight 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.

+* **DatabaseGroups**: string[]:

A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the DatabaseUser. If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup.

+* **DatabaseUser**: string:

The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight 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.

+* **RoleArn**: string (Required):

Use the RoleArn structure to allow Amazon QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.

-## NumericRangeFilterValue +## RedshiftParameters ### Properties -* **Parameter**: string -* **StaticValue**: int +* **ClusterId**: string:

Cluster ID. This field can be blank if the Host and Port are + provided.

+* **Database**: string (Required):

Database.

+* **Host**: string:

Host. This field can be blank if ClusterId is provided.

+* **IAMParameters**: [RedshiftIAMParameters](#redshiftiamparameters) +* **IdentityCenterConfiguration**: [IdentityCenterConfiguration](#identitycenterconfiguration) +* **Port**: int:

Port. This field can be blank if the ClusterId is provided.

-## RelativeDatesFilter +## ReferenceLine ### Properties -* **AnchorDateConfiguration**: [AnchorDateConfiguration](#anchordateconfiguration) (Required) -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **ExcludePeriodConfiguration**: [ExcludePeriodConfiguration](#excludeperiodconfiguration) -* **FilterId**: string (Required) -* **MinimumGranularity**: string -* **NullOption**: string (Required) -* **ParameterName**: string -* **RelativeDateType**: string (Required) -* **RelativeDateValue**: int -* **TimeGranularity**: string (Required) +* **DataConfiguration**: [ReferenceLineDataConfiguration](#referencelinedataconfiguration) (Required) +* **LabelConfiguration**: [ReferenceLineLabelConfiguration](#referencelinelabelconfiguration) +* **Status**: string +* **StyleConfiguration**: [ReferenceLineStyleConfiguration](#referencelinestyleconfiguration) -## AnchorDateConfiguration +## ReferenceLine ### Properties -* **AnchorOption**: string -* **ParameterName**: string +* **DataConfiguration**: [ReferenceLineDataConfiguration](#referencelinedataconfiguration) (Required) +* **LabelConfiguration**: [ReferenceLineLabelConfiguration](#referencelinelabelconfiguration) +* **Status**: string +* **StyleConfiguration**: [ReferenceLineStyleConfiguration](#referencelinestyleconfiguration) -## ExcludePeriodConfiguration +## ReferenceLine ### Properties -* **Amount**: int (Required) -* **Granularity**: string (Required) +* **DataConfiguration**: [ReferenceLineDataConfiguration](#referencelinedataconfiguration) (Required) +* **LabelConfiguration**: [ReferenceLineLabelConfiguration](#referencelinelabelconfiguration) * **Status**: string +* **StyleConfiguration**: [ReferenceLineStyleConfiguration](#referencelinestyleconfiguration) -## TimeEqualityFilter +## ReferenceLineCustomLabelConfiguration ### Properties -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **FilterId**: string (Required) -* **ParameterName**: string -* **RollingDate**: [RollingDateConfiguration](#rollingdateconfiguration) -* **TimeGranularity**: string -* **Value**: string +* **CustomLabel**: string (Required) -## RollingDateConfiguration +## ReferenceLineCustomLabelConfiguration ### Properties -* **DataSetIdentifier**: string -* **Expression**: string (Required) +* **CustomLabel**: string (Required) -## TimeRangeFilter +## ReferenceLineCustomLabelConfiguration ### Properties -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **ExcludePeriodConfiguration**: [ExcludePeriodConfiguration](#excludeperiodconfiguration) -* **FilterId**: string (Required) -* **IncludeMaximum**: bool -* **IncludeMinimum**: bool -* **NullOption**: string (Required) -* **RangeMaximumValue**: [TimeRangeFilterValue](#timerangefiltervalue) -* **RangeMinimumValue**: [TimeRangeFilterValue](#timerangefiltervalue) -* **TimeGranularity**: string +* **CustomLabel**: string (Required) -## TimeRangeFilterValue +## ReferenceLineDataConfiguration ### Properties -* **Parameter**: string -* **RollingDate**: [RollingDateConfiguration](#rollingdateconfiguration) -* **StaticValue**: string +* **AxisBinding**: string +* **DynamicConfiguration**: [ReferenceLineDynamicDataConfiguration](#referencelinedynamicdataconfiguration) +* **SeriesType**: string +* **StaticConfiguration**: [ReferenceLineStaticDataConfiguration](#referencelinestaticdataconfiguration) -## TopBottomFilter +## ReferenceLineDataConfiguration ### Properties -* **AggregationSortConfigurations**: [AggregationSortConfiguration](#aggregationsortconfiguration)[] (Required) -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **FilterId**: string (Required) -* **Limit**: int -* **ParameterName**: string -* **TimeGranularity**: string +* **AxisBinding**: string +* **DynamicConfiguration**: [ReferenceLineDynamicDataConfiguration](#referencelinedynamicdataconfiguration) +* **SeriesType**: string +* **StaticConfiguration**: [ReferenceLineStaticDataConfiguration](#referencelinestaticdataconfiguration) -## AggregationSortConfiguration +## ReferenceLineDataConfiguration ### Properties -* **AggregationFunction**: [AggregationFunction](#aggregationfunction) +* **AxisBinding**: string +* **DynamicConfiguration**: [ReferenceLineDynamicDataConfiguration](#referencelinedynamicdataconfiguration) +* **SeriesType**: string +* **StaticConfiguration**: [ReferenceLineStaticDataConfiguration](#referencelinestaticdataconfiguration) + +## ReferenceLineDynamicDataConfiguration +### Properties +* **Calculation**: [NumericalAggregationFunction](#numericalaggregationfunction) (Required) * **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **SortDirection**: string (Required) +* **MeasureAggregationFunction**: [AggregationFunction](#aggregationfunction) -## FilterScopeConfiguration +## ReferenceLineDynamicDataConfiguration ### Properties -* **AllSheets**: [AllSheetsFilterScopeConfiguration](#allsheetsfilterscopeconfiguration) -* **SelectedSheets**: [SelectedSheetsFilterScopeConfiguration](#selectedsheetsfilterscopeconfiguration) +* **Calculation**: [NumericalAggregationFunction](#numericalaggregationfunction) (Required) +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) +* **MeasureAggregationFunction**: [AggregationFunction](#aggregationfunction) -## AllSheetsFilterScopeConfiguration +## ReferenceLineDynamicDataConfiguration ### Properties +* **Calculation**: [NumericalAggregationFunction](#numericalaggregationfunction) (Required) +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) +* **MeasureAggregationFunction**: [AggregationFunction](#aggregationfunction) -## SelectedSheetsFilterScopeConfiguration +## ReferenceLineLabelConfiguration ### Properties -* **SheetVisualScopingConfigurations**: [SheetVisualScopingConfiguration](#sheetvisualscopingconfiguration)[] +* **CustomLabelConfiguration**: [ReferenceLineCustomLabelConfiguration](#referencelinecustomlabelconfiguration) +* **FontColor**: string +* **FontConfiguration**: [FontConfiguration](#fontconfiguration) +* **HorizontalPosition**: string +* **ValueLabelConfiguration**: [ReferenceLineValueLabelConfiguration](#referencelinevaluelabelconfiguration) +* **VerticalPosition**: string -## SheetVisualScopingConfiguration +## ReferenceLineLabelConfiguration ### Properties -* **Scope**: string (Required) -* **SheetId**: string (Required) -* **VisualIds**: string[] +* **CustomLabelConfiguration**: [ReferenceLineCustomLabelConfiguration](#referencelinecustomlabelconfiguration) +* **FontColor**: string +* **FontConfiguration**: [FontConfiguration](#fontconfiguration) +* **HorizontalPosition**: string +* **ValueLabelConfiguration**: [ReferenceLineValueLabelConfiguration](#referencelinevaluelabelconfiguration) +* **VerticalPosition**: string -## AssetOptions +## ReferenceLineLabelConfiguration ### Properties -* **Timezone**: string -* **WeekStart**: string +* **CustomLabelConfiguration**: [ReferenceLineCustomLabelConfiguration](#referencelinecustomlabelconfiguration) +* **FontColor**: string +* **FontConfiguration**: [FontConfiguration](#fontconfiguration) +* **HorizontalPosition**: string +* **ValueLabelConfiguration**: [ReferenceLineValueLabelConfiguration](#referencelinevaluelabelconfiguration) +* **VerticalPosition**: string -## ParameterDeclaration +## ReferenceLineStaticDataConfiguration ### Properties -* **DateTimeParameterDeclaration**: [DateTimeParameterDeclaration](#datetimeparameterdeclaration) -* **DecimalParameterDeclaration**: [DecimalParameterDeclaration](#decimalparameterdeclaration) -* **IntegerParameterDeclaration**: [IntegerParameterDeclaration](#integerparameterdeclaration) -* **StringParameterDeclaration**: [StringParameterDeclaration](#stringparameterdeclaration) +* **Value**: int (Required) -## DateTimeParameterDeclaration +## ReferenceLineStaticDataConfiguration ### Properties -* **DefaultValues**: [DateTimeDefaultValues](#datetimedefaultvalues) -* **MappedDataSetParameters**: [MappedDataSetParameter](#mappeddatasetparameter)[] -* **Name**: string (Required) -* **TimeGranularity**: string -* **ValueWhenUnset**: [DateTimeValueWhenUnsetConfiguration](#datetimevaluewhenunsetconfiguration) +* **Value**: int (Required) -## DateTimeDefaultValues +## ReferenceLineStaticDataConfiguration ### Properties -* **DynamicValue**: [DynamicDefaultValue](#dynamicdefaultvalue) -* **RollingDate**: [RollingDateConfiguration](#rollingdateconfiguration) -* **StaticValues**: string[] +* **Value**: int (Required) -## DynamicDefaultValue +## ReferenceLineStyleConfiguration ### Properties -* **DefaultValueColumn**: [ColumnIdentifier](#columnidentifier) (Required) -* **GroupNameColumn**: [ColumnIdentifier](#columnidentifier) -* **UserNameColumn**: [ColumnIdentifier](#columnidentifier) +* **Color**: string +* **Pattern**: string -## MappedDataSetParameter +## ReferenceLineStyleConfiguration ### Properties -* **DataSetIdentifier**: string (Required) -* **DataSetParameterName**: string (Required) +* **Color**: string +* **Pattern**: string -## DateTimeValueWhenUnsetConfiguration +## ReferenceLineStyleConfiguration ### Properties -* **CustomValue**: string -* **ValueWhenUnsetOption**: string +* **Color**: string +* **Pattern**: string -## DecimalParameterDeclaration +## ReferenceLineValueLabelConfiguration ### Properties -* **DefaultValues**: [DecimalDefaultValues](#decimaldefaultvalues) -* **MappedDataSetParameters**: [MappedDataSetParameter](#mappeddatasetparameter)[] -* **Name**: string (Required) -* **ParameterValueType**: string (Required) -* **ValueWhenUnset**: [DecimalValueWhenUnsetConfiguration](#decimalvaluewhenunsetconfiguration) +* **FormatConfiguration**: [NumericFormatConfiguration](#numericformatconfiguration) +* **RelativePosition**: string -## DecimalDefaultValues +## ReferenceLineValueLabelConfiguration ### Properties -* **DynamicValue**: [DynamicDefaultValue](#dynamicdefaultvalue) -* **StaticValues**: int[] +* **FormatConfiguration**: [NumericFormatConfiguration](#numericformatconfiguration) +* **RelativePosition**: string -## DecimalValueWhenUnsetConfiguration +## ReferenceLineValueLabelConfiguration ### Properties -* **CustomValue**: int -* **ValueWhenUnsetOption**: string +* **FormatConfiguration**: [NumericFormatConfiguration](#numericformatconfiguration) +* **RelativePosition**: string -## IntegerParameterDeclaration +## RefreshConfiguration ### Properties -* **DefaultValues**: [IntegerDefaultValues](#integerdefaultvalues) -* **MappedDataSetParameters**: [MappedDataSetParameter](#mappeddatasetparameter)[] -* **Name**: string (Required) -* **ParameterValueType**: string (Required) -* **ValueWhenUnset**: [IntegerValueWhenUnsetConfiguration](#integervaluewhenunsetconfiguration) +* **IncrementalRefresh**: [IncrementalRefresh](#incrementalrefresh) (Required) -## IntegerDefaultValues +## RefreshSchedule_ScheduleFrequency ### Properties -* **DynamicValue**: [DynamicDefaultValue](#dynamicdefaultvalue) -* **StaticValues**: int[] +* **Interval**: string +* **RefreshOnDay**: [RefreshSchedule_ScheduleFrequency_RefreshOnDay](#refreshscheduleschedulefrequencyrefreshonday):

The day scheduled for refresh.

+* **TimeOfTheDay**: string:

The time of the day for scheduled refresh.

+* **TimeZone**: string:

The timezone for scheduled refresh.

-## IntegerValueWhenUnsetConfiguration +## RefreshSchedule_ScheduleFrequency_RefreshOnDay ### Properties -* **CustomValue**: int -* **ValueWhenUnsetOption**: string +* **DayOfMonth**: string:

The Day Of Month for scheduled refresh.

+* **DayOfWeek**: string -## StringParameterDeclaration +## RefreshScheduleMap ### Properties -* **DefaultValues**: [StringDefaultValues](#stringdefaultvalues) -* **MappedDataSetParameters**: [MappedDataSetParameter](#mappeddatasetparameter)[] -* **Name**: string (Required) -* **ParameterValueType**: string (Required) -* **ValueWhenUnset**: [StringValueWhenUnsetConfiguration](#stringvaluewhenunsetconfiguration) +* **RefreshType**: string +* **ScheduleFrequency**: [RefreshSchedule_ScheduleFrequency](#refreshscheduleschedulefrequency):

Information about the schedule frequency.

+* **ScheduleId**: string:

An unique identifier for the refresh schedule.

+* **StartAfterDateTime**: string:

The date time after which refresh is to be scheduled

-## StringDefaultValues +## RelativeDatesFilter ### Properties -* **DynamicValue**: [DynamicDefaultValue](#dynamicdefaultvalue) -* **StaticValues**: string[] +* **AnchorDateConfiguration**: [AnchorDateConfiguration](#anchordateconfiguration) (Required) +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) +* **DefaultFilterControlConfiguration**: [DefaultFilterControlConfiguration](#defaultfiltercontrolconfiguration) +* **ExcludePeriodConfiguration**: [ExcludePeriodConfiguration](#excludeperiodconfiguration) +* **FilterId**: string (Required) +* **MinimumGranularity**: string +* **NullOption**: string (Required) +* **ParameterName**: string +* **RelativeDateType**: string (Required) +* **RelativeDateValue**: int +* **TimeGranularity**: string (Required) -## StringValueWhenUnsetConfiguration +## RelativeDatesFilter ### Properties -* **CustomValue**: string -* **ValueWhenUnsetOption**: string +* **AnchorDateConfiguration**: [AnchorDateConfiguration](#anchordateconfiguration) (Required) +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) +* **DefaultFilterControlConfiguration**: [DefaultFilterControlConfiguration](#defaultfiltercontrolconfiguration) +* **ExcludePeriodConfiguration**: [ExcludePeriodConfiguration](#excludeperiodconfiguration) +* **FilterId**: string (Required) +* **MinimumGranularity**: string +* **NullOption**: string (Required) +* **ParameterName**: string +* **RelativeDateType**: string (Required) +* **RelativeDateValue**: int +* **TimeGranularity**: string (Required) -## SheetDefinition +## RelativeDatesFilter ### Properties -* **ContentType**: string -* **Description**: string -* **FilterControls**: [FilterControl](#filtercontrol)[] -* **Layouts**: [Layout](#layout)[] -* **Name**: string -* **ParameterControls**: [ParameterControl](#parametercontrol)[] -* **SheetControlLayouts**: [SheetControlLayout](#sheetcontrollayout)[] -* **SheetId**: string (Required) -* **TextBoxes**: [SheetTextBox](#sheettextbox)[] -* **Title**: string -* **Visuals**: [Visual](#visual)[] +* **AnchorDateConfiguration**: [AnchorDateConfiguration](#anchordateconfiguration) (Required) +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) +* **DefaultFilterControlConfiguration**: [DefaultFilterControlConfiguration](#defaultfiltercontrolconfiguration) +* **ExcludePeriodConfiguration**: [ExcludePeriodConfiguration](#excludeperiodconfiguration) +* **FilterId**: string (Required) +* **MinimumGranularity**: string +* **NullOption**: string (Required) +* **ParameterName**: string +* **RelativeDateType**: string (Required) +* **RelativeDateValue**: int +* **TimeGranularity**: string (Required) -## FilterControl +## RelativeDateTimeControlDisplayOptions ### Properties -* **DateTimePicker**: [FilterDateTimePickerControl](#filterdatetimepickercontrol) -* **Dropdown**: [FilterDropDownControl](#filterdropdowncontrol) -* **List**: [FilterListControl](#filterlistcontrol) -* **RelativeDateTime**: [FilterRelativeDateTimeControl](#filterrelativedatetimecontrol) -* **Slider**: [FilterSliderControl](#filterslidercontrol) -* **TextArea**: [FilterTextAreaControl](#filtertextareacontrol) -* **TextField**: [FilterTextFieldControl](#filtertextfieldcontrol) +* **DateTimeFormat**: string +* **InfoIconLabelOptions**: [SheetControlInfoIconLabelOptions](#sheetcontrolinfoiconlabeloptions) +* **TitleOptions**: [LabelOptions](#labeloptions) -## FilterDateTimePickerControl +## RelativeDateTimeControlDisplayOptions ### Properties -* **DisplayOptions**: [DateTimePickerControlDisplayOptions](#datetimepickercontroldisplayoptions) -* **FilterControlId**: string (Required) -* **SourceFilterId**: string (Required) -* **Title**: string (Required) -* **Type**: string +* **DateTimeFormat**: string +* **InfoIconLabelOptions**: [SheetControlInfoIconLabelOptions](#sheetcontrolinfoiconlabeloptions) +* **TitleOptions**: [LabelOptions](#labeloptions) -## DateTimePickerControlDisplayOptions +## RelativeDateTimeControlDisplayOptions ### Properties * **DateTimeFormat**: string * **InfoIconLabelOptions**: [SheetControlInfoIconLabelOptions](#sheetcontrolinfoiconlabeloptions) * **TitleOptions**: [LabelOptions](#labeloptions) -## SheetControlInfoIconLabelOptions +## ResourcePermission ### Properties -* **InfoIconText**: string -* **Visibility**: string +* **Actions**: string[] (Required):

The IAM action to grant or revoke permissions on.

+* **Principal**: string (Required):

The Amazon Resource Name (ARN) of the principal. This can be one of the + following:

+
    +
  • +

    The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

    +
    • +
  • +

    The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)

    +
    • +
  • +

    The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight + ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. + (This is less common.)

    +
    • +
-## LabelOptions +## ResourcePermission ### Properties -* **CustomLabel**: string -* **FontConfiguration**: [FontConfiguration](#fontconfiguration) -* **Visibility**: string +* **Actions**: string[] (Required):

The IAM action to grant or revoke permissions on.

+* **Principal**: string (Required):

The Amazon Resource Name (ARN) of the principal. This can be one of the + following:

+
    +
  • +

    The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

    +
    • +
  • +

    The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)

    +
    • +
  • +

    The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight + ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. + (This is less common.)

    +
    • +
-## FontConfiguration +## ResourcePermission ### Properties -* **FontColor**: string -* **FontDecoration**: string -* **FontSize**: [FontSize](#fontsize) -* **FontStyle**: string -* **FontWeight**: [FontWeight](#fontweight) +* **Actions**: string[] (Required):

The IAM action to grant or revoke permissions on.

+* **Principal**: string (Required):

The Amazon Resource Name (ARN) of the principal. This can be one of the + following:

+
    +
  • +

    The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

    +
    • +
  • +

    The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)

    +
    • +
  • +

    The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight + ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. + (This is less common.)

    +
    • +
-## FontSize +## ResourcePermission ### Properties -* **Relative**: string +* **Actions**: string[] (Required):

The IAM action to grant or revoke permissions on.

+* **Principal**: string (Required):

The Amazon Resource Name (ARN) of the principal. This can be one of the + following:

+
    +
  • +

    The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

    +
    • +
  • +

    The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)

    +
    • +
  • +

    The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight + ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. + (This is less common.)

    +
    • +
+* **Resource**: string -## FontWeight +## ResourcePermission ### Properties -* **Name**: string +* **Actions**: string[] (Required):

The IAM action to grant or revoke permissions on.

+* **Principal**: string (Required):

The Amazon Resource Name (ARN) of the principal. This can be one of the + following:

+
    +
  • +

    The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

    +
    • +
  • +

    The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)

    +
    • +
  • +

    The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight + ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. + (This is less common.)

    +
    • +
-## FilterDropDownControl +## ResourcePermission ### Properties -* **CascadingControlConfiguration**: [CascadingControlConfiguration](#cascadingcontrolconfiguration) -* **DisplayOptions**: [DropDownControlDisplayOptions](#dropdowncontroldisplayoptions) -* **FilterControlId**: string (Required) -* **SelectableValues**: [FilterSelectableValues](#filterselectablevalues) -* **SourceFilterId**: string (Required) -* **Title**: string (Required) -* **Type**: string +* **Actions**: string[] (Required):

The IAM action to grant or revoke permissions on.

+* **Principal**: string (Required):

The Amazon Resource Name (ARN) of the principal. This can be one of the + following:

+
    +
  • +

    The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

    +
    • +
  • +

    The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)

    +
    • +
  • +

    The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight + ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. + (This is less common.)

    +
    • +
-## CascadingControlConfiguration +## RollingDateConfiguration ### Properties -* **SourceControls**: [CascadingControlSource](#cascadingcontrolsource)[] +* **DataSetIdentifier**: string +* **Expression**: string (Required) -## CascadingControlSource +## RollingDateConfiguration ### Properties -* **ColumnToMatch**: [ColumnIdentifier](#columnidentifier) -* **SourceSheetControlId**: string +* **DataSetIdentifier**: string +* **Expression**: string (Required) -## DropDownControlDisplayOptions +## RollingDateConfiguration ### Properties -* **InfoIconLabelOptions**: [SheetControlInfoIconLabelOptions](#sheetcontrolinfoiconlabeloptions) -* **SelectAllOptions**: [ListControlSelectAllOptions](#listcontrolselectalloptions) -* **TitleOptions**: [LabelOptions](#labeloptions) +* **DataSetIdentifier**: string +* **Expression**: string (Required) -## ListControlSelectAllOptions +## RowAlternateColorOptions ### Properties -* **Visibility**: string +* **RowAlternateColors**: string[] +* **Status**: string +* **UsePrimaryBackgroundColor**: string -## FilterSelectableValues +## RowAlternateColorOptions ### Properties -* **Values**: string[] +* **RowAlternateColors**: string[] +* **Status**: string +* **UsePrimaryBackgroundColor**: string -## FilterListControl +## RowAlternateColorOptions ### Properties -* **CascadingControlConfiguration**: [CascadingControlConfiguration](#cascadingcontrolconfiguration) -* **DisplayOptions**: [ListControlDisplayOptions](#listcontroldisplayoptions) -* **FilterControlId**: string (Required) -* **SelectableValues**: [FilterSelectableValues](#filterselectablevalues) -* **SourceFilterId**: string (Required) -* **Title**: string (Required) -* **Type**: string +* **RowAlternateColors**: string[] +* **Status**: string +* **UsePrimaryBackgroundColor**: string -## ListControlDisplayOptions +## RowLevelPermissionDataSet ### Properties -* **InfoIconLabelOptions**: [SheetControlInfoIconLabelOptions](#sheetcontrolinfoiconlabeloptions) -* **SearchOptions**: [ListControlSearchOptions](#listcontrolsearchoptions) -* **SelectAllOptions**: [ListControlSelectAllOptions](#listcontrolselectalloptions) -* **TitleOptions**: [LabelOptions](#labeloptions) +* **Arn**: string (Required):

The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.

+* **FormatVersion**: string +* **Namespace**: string:

The namespace associated with the dataset that contains permissions for RLS.

+* **PermissionPolicy**: string (Required) +* **Status**: string -## ListControlSearchOptions +## RowLevelPermissionTagConfiguration ### Properties -* **Visibility**: string +* **Status**: string +* **TagRuleConfigurations**: string[][]:

A list of tag configuration rules to apply to a dataset. All tag configurations have the OR condition. Tags within each tile will be joined (AND). At least one rule in this structure must have all tag values assigned to it to apply Row-level security (RLS) to the dataset.

+* **TagRules**: [RowLevelPermissionTagRule](#rowlevelpermissiontagrule)[] (Required):

A set of rules associated with row-level security, such as the tag names and columns that they are assigned to.

-## FilterRelativeDateTimeControl +## RowLevelPermissionTagRule ### Properties -* **DisplayOptions**: [RelativeDateTimeControlDisplayOptions](#relativedatetimecontroldisplayoptions) -* **FilterControlId**: string (Required) -* **SourceFilterId**: string (Required) -* **Title**: string (Required) +* **ColumnName**: string (Required):

The column name that a tag key is assigned to.

+* **MatchAllValue**: string:

A string that you want to use to filter by all the values in a column in the dataset and don?t want to list the values one by one. For example, you can use an asterisk as your match all value.

+* **TagKey**: string (Required):

The unique key for a tag.

+* **TagMultiValueDelimiter**: string:

A 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.

-## RelativeDateTimeControlDisplayOptions +## S3Parameters ### Properties -* **DateTimeFormat**: string -* **InfoIconLabelOptions**: [SheetControlInfoIconLabelOptions](#sheetcontrolinfoiconlabeloptions) -* **TitleOptions**: [LabelOptions](#labeloptions) +* **ManifestFileLocation**: [ManifestFileLocation](#manifestfilelocation) (Required) +* **RoleArn**: string:

Use 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.

-## FilterSliderControl +## SameSheetTargetVisualConfiguration ### Properties -* **DisplayOptions**: [SliderControlDisplayOptions](#slidercontroldisplayoptions) -* **FilterControlId**: string (Required) -* **MaximumValue**: int (Required) -* **MinimumValue**: int (Required) -* **SourceFilterId**: string (Required) -* **StepSize**: int (Required) -* **Title**: string (Required) -* **Type**: string +* **TargetVisualOptions**: string +* **TargetVisuals**: string[] -## SliderControlDisplayOptions +## SameSheetTargetVisualConfiguration ### Properties -* **InfoIconLabelOptions**: [SheetControlInfoIconLabelOptions](#sheetcontrolinfoiconlabeloptions) -* **TitleOptions**: [LabelOptions](#labeloptions) +* **TargetVisualOptions**: string +* **TargetVisuals**: string[] -## FilterTextAreaControl +## SameSheetTargetVisualConfiguration ### Properties -* **Delimiter**: string -* **DisplayOptions**: [TextAreaControlDisplayOptions](#textareacontroldisplayoptions) -* **FilterControlId**: string (Required) -* **SourceFilterId**: string (Required) -* **Title**: string (Required) +* **TargetVisualOptions**: string +* **TargetVisuals**: string[] -## TextAreaControlDisplayOptions +## SankeyDiagramAggregatedFieldWells ### Properties -* **InfoIconLabelOptions**: [SheetControlInfoIconLabelOptions](#sheetcontrolinfoiconlabeloptions) -* **PlaceholderOptions**: [TextControlPlaceholderOptions](#textcontrolplaceholderoptions) -* **TitleOptions**: [LabelOptions](#labeloptions) +* **Destination**: [DimensionField](#dimensionfield)[] +* **Source**: [DimensionField](#dimensionfield)[] +* **Weight**: [MeasureField](#measurefield)[] -## TextControlPlaceholderOptions +## SankeyDiagramAggregatedFieldWells ### Properties -* **Visibility**: string +* **Destination**: [DimensionField](#dimensionfield)[] +* **Source**: [DimensionField](#dimensionfield)[] +* **Weight**: [MeasureField](#measurefield)[] -## FilterTextFieldControl +## SankeyDiagramAggregatedFieldWells ### Properties -* **DisplayOptions**: [TextFieldControlDisplayOptions](#textfieldcontroldisplayoptions) -* **FilterControlId**: string (Required) -* **SourceFilterId**: string (Required) -* **Title**: string (Required) +* **Destination**: [DimensionField](#dimensionfield)[] +* **Source**: [DimensionField](#dimensionfield)[] +* **Weight**: [MeasureField](#measurefield)[] -## TextFieldControlDisplayOptions +## SankeyDiagramChartConfiguration ### Properties -* **InfoIconLabelOptions**: [SheetControlInfoIconLabelOptions](#sheetcontrolinfoiconlabeloptions) -* **PlaceholderOptions**: [TextControlPlaceholderOptions](#textcontrolplaceholderoptions) -* **TitleOptions**: [LabelOptions](#labeloptions) +* **DataLabels**: [DataLabelOptions](#datalabeloptions) +* **FieldWells**: [SankeyDiagramFieldWells](#sankeydiagramfieldwells) +* **SortConfiguration**: [SankeyDiagramSortConfiguration](#sankeydiagramsortconfiguration) -## Layout +## SankeyDiagramChartConfiguration ### Properties -* **Configuration**: [LayoutConfiguration](#layoutconfiguration) (Required) +* **DataLabels**: [DataLabelOptions](#datalabeloptions) +* **FieldWells**: [SankeyDiagramFieldWells](#sankeydiagramfieldwells) +* **SortConfiguration**: [SankeyDiagramSortConfiguration](#sankeydiagramsortconfiguration) -## LayoutConfiguration +## SankeyDiagramChartConfiguration ### Properties -* **FreeFormLayout**: [FreeFormLayoutConfiguration](#freeformlayoutconfiguration) -* **GridLayout**: [GridLayoutConfiguration](#gridlayoutconfiguration) -* **SectionBasedLayout**: [SectionBasedLayoutConfiguration](#sectionbasedlayoutconfiguration) +* **DataLabels**: [DataLabelOptions](#datalabeloptions) +* **FieldWells**: [SankeyDiagramFieldWells](#sankeydiagramfieldwells) +* **SortConfiguration**: [SankeyDiagramSortConfiguration](#sankeydiagramsortconfiguration) -## FreeFormLayoutConfiguration +## SankeyDiagramFieldWells ### Properties -* **CanvasSizeOptions**: [FreeFormLayoutCanvasSizeOptions](#freeformlayoutcanvassizeoptions) -* **Elements**: [FreeFormLayoutElement](#freeformlayoutelement)[] (Required) +* **SankeyDiagramAggregatedFieldWells**: [SankeyDiagramAggregatedFieldWells](#sankeydiagramaggregatedfieldwells) -## FreeFormLayoutElement +## SankeyDiagramFieldWells ### Properties -* **BackgroundStyle**: [FreeFormLayoutElementBackgroundStyle](#freeformlayoutelementbackgroundstyle) -* **BorderStyle**: [FreeFormLayoutElementBorderStyle](#freeformlayoutelementborderstyle) -* **ElementId**: string (Required) -* **ElementType**: string (Required) -* **Height**: string (Required): String based length that is composed of value and unit in px -* **LoadingAnimation**: [LoadingAnimation](#loadinganimation) -* **RenderingRules**: [SheetElementRenderingRule](#sheetelementrenderingrule)[] -* **SelectedBorderStyle**: [FreeFormLayoutElementBorderStyle](#freeformlayoutelementborderstyle) -* **Visibility**: string -* **Width**: string (Required): String based length that is composed of value and unit in px -* **XAxisLocation**: string (Required): String based length that is composed of value and unit in px -* **YAxisLocation**: string (Required): String based length that is composed of value and unit in px with Integer.MAX_VALUE as maximum value +* **SankeyDiagramAggregatedFieldWells**: [SankeyDiagramAggregatedFieldWells](#sankeydiagramaggregatedfieldwells) -## FreeFormLayoutElementBackgroundStyle +## SankeyDiagramFieldWells ### Properties -* **Color**: string -* **Visibility**: string +* **SankeyDiagramAggregatedFieldWells**: [SankeyDiagramAggregatedFieldWells](#sankeydiagramaggregatedfieldwells) -## FreeFormLayoutElementBorderStyle +## SankeyDiagramSortConfiguration ### Properties -* **Color**: string -* **Visibility**: string +* **DestinationItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) +* **SourceItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) +* **WeightSort**: [FieldSortOptions](#fieldsortoptions)[] -## LoadingAnimation +## SankeyDiagramSortConfiguration ### Properties -* **Visibility**: string +* **DestinationItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) +* **SourceItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) +* **WeightSort**: [FieldSortOptions](#fieldsortoptions)[] -## SheetElementRenderingRule +## SankeyDiagramSortConfiguration ### Properties -* **ConfigurationOverrides**: [SheetElementConfigurationOverrides](#sheetelementconfigurationoverrides) (Required) -* **Expression**: string (Required) +* **DestinationItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) +* **SourceItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) +* **WeightSort**: [FieldSortOptions](#fieldsortoptions)[] -## SheetElementConfigurationOverrides +## SankeyDiagramVisual ### Properties -* **Visibility**: string +* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **ChartConfiguration**: [SankeyDiagramChartConfiguration](#sankeydiagramchartconfiguration) +* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) +* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) +* **VisualId**: string (Required) -## GridLayoutConfiguration +## SankeyDiagramVisual ### Properties -* **CanvasSizeOptions**: [GridLayoutCanvasSizeOptions](#gridlayoutcanvassizeoptions) -* **Elements**: [GridLayoutElement](#gridlayoutelement)[] (Required) +* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **ChartConfiguration**: [SankeyDiagramChartConfiguration](#sankeydiagramchartconfiguration) +* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) +* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) +* **VisualId**: string (Required) -## GridLayoutElement +## SankeyDiagramVisual ### Properties -* **ColumnIndex**: int -* **ColumnSpan**: int (Required) -* **ElementId**: string (Required) -* **ElementType**: string (Required) -* **RowIndex**: int -* **RowSpan**: int (Required) +* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **ChartConfiguration**: [SankeyDiagramChartConfiguration](#sankeydiagramchartconfiguration) +* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) +* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) +* **VisualId**: string (Required) -## SectionBasedLayoutConfiguration +## ScatterPlotCategoricallyAggregatedFieldWells ### Properties -* **BodySections**: [BodySectionConfiguration](#bodysectionconfiguration)[] (Required) -* **CanvasSizeOptions**: [SectionBasedLayoutCanvasSizeOptions](#sectionbasedlayoutcanvassizeoptions) (Required) -* **FooterSections**: [HeaderFooterSectionConfiguration](#headerfootersectionconfiguration)[] (Required) -* **HeaderSections**: [HeaderFooterSectionConfiguration](#headerfootersectionconfiguration)[] (Required) +* **Category**: [DimensionField](#dimensionfield)[] +* **Label**: [DimensionField](#dimensionfield)[] +* **Size**: [MeasureField](#measurefield)[] +* **XAxis**: [MeasureField](#measurefield)[] +* **YAxis**: [MeasureField](#measurefield)[] -## BodySectionConfiguration +## ScatterPlotCategoricallyAggregatedFieldWells ### Properties -* **Content**: [BodySectionContent](#bodysectioncontent) (Required) -* **PageBreakConfiguration**: [SectionPageBreakConfiguration](#sectionpagebreakconfiguration) -* **SectionId**: string (Required) -* **Style**: [SectionStyle](#sectionstyle) +* **Category**: [DimensionField](#dimensionfield)[] +* **Label**: [DimensionField](#dimensionfield)[] +* **Size**: [MeasureField](#measurefield)[] +* **XAxis**: [MeasureField](#measurefield)[] +* **YAxis**: [MeasureField](#measurefield)[] -## BodySectionContent +## ScatterPlotCategoricallyAggregatedFieldWells ### Properties -* **Layout**: [SectionLayoutConfiguration](#sectionlayoutconfiguration) +* **Category**: [DimensionField](#dimensionfield)[] +* **Label**: [DimensionField](#dimensionfield)[] +* **Size**: [MeasureField](#measurefield)[] +* **XAxis**: [MeasureField](#measurefield)[] +* **YAxis**: [MeasureField](#measurefield)[] -## SectionLayoutConfiguration +## ScatterPlotConfiguration ### Properties -* **FreeFormLayout**: [FreeFormSectionLayoutConfiguration](#freeformsectionlayoutconfiguration) (Required) +* **DataLabels**: [DataLabelOptions](#datalabeloptions) +* **FieldWells**: [ScatterPlotFieldWells](#scatterplotfieldwells) +* **Legend**: [LegendOptions](#legendoptions) +* **Tooltip**: [TooltipOptions](#tooltipoptions) +* **VisualPalette**: [VisualPalette](#visualpalette) +* **XAxisDisplayOptions**: [AxisDisplayOptions](#axisdisplayoptions) +* **XAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **YAxisDisplayOptions**: [AxisDisplayOptions](#axisdisplayoptions) +* **YAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -## FreeFormSectionLayoutConfiguration +## ScatterPlotConfiguration ### Properties -* **Elements**: [FreeFormLayoutElement](#freeformlayoutelement)[] (Required) +* **DataLabels**: [DataLabelOptions](#datalabeloptions) +* **FieldWells**: [ScatterPlotFieldWells](#scatterplotfieldwells) +* **Legend**: [LegendOptions](#legendoptions) +* **Tooltip**: [TooltipOptions](#tooltipoptions) +* **VisualPalette**: [VisualPalette](#visualpalette) +* **XAxisDisplayOptions**: [AxisDisplayOptions](#axisdisplayoptions) +* **XAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **YAxisDisplayOptions**: [AxisDisplayOptions](#axisdisplayoptions) +* **YAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -## SectionPageBreakConfiguration +## ScatterPlotConfiguration ### Properties -* **After**: [SectionAfterPageBreak](#sectionafterpagebreak) +* **DataLabels**: [DataLabelOptions](#datalabeloptions) +* **FieldWells**: [ScatterPlotFieldWells](#scatterplotfieldwells) +* **Legend**: [LegendOptions](#legendoptions) +* **Tooltip**: [TooltipOptions](#tooltipoptions) +* **VisualPalette**: [VisualPalette](#visualpalette) +* **XAxisDisplayOptions**: [AxisDisplayOptions](#axisdisplayoptions) +* **XAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **YAxisDisplayOptions**: [AxisDisplayOptions](#axisdisplayoptions) +* **YAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -## SectionAfterPageBreak +## ScatterPlotFieldWells ### Properties -* **Status**: string +* **ScatterPlotCategoricallyAggregatedFieldWells**: [ScatterPlotCategoricallyAggregatedFieldWells](#scatterplotcategoricallyaggregatedfieldwells) +* **ScatterPlotUnaggregatedFieldWells**: [ScatterPlotUnaggregatedFieldWells](#scatterplotunaggregatedfieldwells) -## SectionStyle +## ScatterPlotFieldWells ### Properties -* **Height**: string: String based length that is composed of value and unit in px -* **Padding**: [Spacing](#spacing) +* **ScatterPlotCategoricallyAggregatedFieldWells**: [ScatterPlotCategoricallyAggregatedFieldWells](#scatterplotcategoricallyaggregatedfieldwells) +* **ScatterPlotUnaggregatedFieldWells**: [ScatterPlotUnaggregatedFieldWells](#scatterplotunaggregatedfieldwells) -## HeaderFooterSectionConfiguration +## ScatterPlotFieldWells ### Properties -* **Layout**: [SectionLayoutConfiguration](#sectionlayoutconfiguration) (Required) -* **SectionId**: string (Required) -* **Style**: [SectionStyle](#sectionstyle) +* **ScatterPlotCategoricallyAggregatedFieldWells**: [ScatterPlotCategoricallyAggregatedFieldWells](#scatterplotcategoricallyaggregatedfieldwells) +* **ScatterPlotUnaggregatedFieldWells**: [ScatterPlotUnaggregatedFieldWells](#scatterplotunaggregatedfieldwells) -## ParameterControl +## ScatterPlotUnaggregatedFieldWells ### Properties -* **DateTimePicker**: [ParameterDateTimePickerControl](#parameterdatetimepickercontrol) -* **Dropdown**: [ParameterDropDownControl](#parameterdropdowncontrol) -* **List**: [ParameterListControl](#parameterlistcontrol) -* **Slider**: [ParameterSliderControl](#parameterslidercontrol) -* **TextArea**: [ParameterTextAreaControl](#parametertextareacontrol) -* **TextField**: [ParameterTextFieldControl](#parametertextfieldcontrol) +* **Category**: [DimensionField](#dimensionfield)[] +* **Label**: [DimensionField](#dimensionfield)[] +* **Size**: [MeasureField](#measurefield)[] +* **XAxis**: [DimensionField](#dimensionfield)[] +* **YAxis**: [DimensionField](#dimensionfield)[] -## ParameterDateTimePickerControl +## ScatterPlotUnaggregatedFieldWells ### Properties -* **DisplayOptions**: [DateTimePickerControlDisplayOptions](#datetimepickercontroldisplayoptions) -* **ParameterControlId**: string (Required) -* **SourceParameterName**: string (Required) -* **Title**: string (Required) +* **Category**: [DimensionField](#dimensionfield)[] +* **Label**: [DimensionField](#dimensionfield)[] +* **Size**: [MeasureField](#measurefield)[] +* **XAxis**: [DimensionField](#dimensionfield)[] +* **YAxis**: [DimensionField](#dimensionfield)[] -## ParameterDropDownControl +## ScatterPlotUnaggregatedFieldWells ### Properties -* **CascadingControlConfiguration**: [CascadingControlConfiguration](#cascadingcontrolconfiguration) -* **DisplayOptions**: [DropDownControlDisplayOptions](#dropdowncontroldisplayoptions) -* **ParameterControlId**: string (Required) -* **SelectableValues**: [ParameterSelectableValues](#parameterselectablevalues) -* **SourceParameterName**: string (Required) -* **Title**: string (Required) -* **Type**: string +* **Category**: [DimensionField](#dimensionfield)[] +* **Label**: [DimensionField](#dimensionfield)[] +* **Size**: [MeasureField](#measurefield)[] +* **XAxis**: [DimensionField](#dimensionfield)[] +* **YAxis**: [DimensionField](#dimensionfield)[] -## ParameterSelectableValues +## ScatterPlotVisual ### Properties -* **LinkToDataSetColumn**: [ColumnIdentifier](#columnidentifier) -* **Values**: string[] +* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **ChartConfiguration**: [ScatterPlotConfiguration](#scatterplotconfiguration) +* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] +* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) +* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) +* **VisualId**: string (Required) -## ParameterListControl +## ScatterPlotVisual ### Properties -* **CascadingControlConfiguration**: [CascadingControlConfiguration](#cascadingcontrolconfiguration) -* **DisplayOptions**: [ListControlDisplayOptions](#listcontroldisplayoptions) -* **ParameterControlId**: string (Required) -* **SelectableValues**: [ParameterSelectableValues](#parameterselectablevalues) -* **SourceParameterName**: string (Required) -* **Title**: string (Required) -* **Type**: string +* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **ChartConfiguration**: [ScatterPlotConfiguration](#scatterplotconfiguration) +* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] +* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) +* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) +* **VisualId**: string (Required) -## ParameterSliderControl +## ScatterPlotVisual ### Properties -* **DisplayOptions**: [SliderControlDisplayOptions](#slidercontroldisplayoptions) -* **MaximumValue**: int (Required) -* **MinimumValue**: int (Required) -* **ParameterControlId**: string (Required) -* **SourceParameterName**: string (Required) -* **StepSize**: int (Required) -* **Title**: string (Required) +* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **ChartConfiguration**: [ScatterPlotConfiguration](#scatterplotconfiguration) +* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] +* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) +* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) +* **VisualId**: string (Required) -## ParameterTextAreaControl +## ScrollBarOptions ### Properties -* **Delimiter**: string -* **DisplayOptions**: [TextAreaControlDisplayOptions](#textareacontroldisplayoptions) -* **ParameterControlId**: string (Required) -* **SourceParameterName**: string (Required) -* **Title**: string (Required) +* **Visibility**: string +* **VisibleRange**: [VisibleRangeOptions](#visiblerangeoptions) -## ParameterTextFieldControl +## ScrollBarOptions ### Properties -* **DisplayOptions**: [TextFieldControlDisplayOptions](#textfieldcontroldisplayoptions) -* **ParameterControlId**: string (Required) -* **SourceParameterName**: string (Required) -* **Title**: string (Required) +* **Visibility**: string +* **VisibleRange**: [VisibleRangeOptions](#visiblerangeoptions) -## SheetControlLayout +## ScrollBarOptions ### Properties -* **Configuration**: [SheetControlLayoutConfiguration](#sheetcontrollayoutconfiguration) (Required) +* **Visibility**: string +* **VisibleRange**: [VisibleRangeOptions](#visiblerangeoptions) -## SheetControlLayoutConfiguration +## SecondaryValueOptions ### Properties -* **GridLayout**: [GridLayoutConfiguration](#gridlayoutconfiguration) +* **Visibility**: string -## SheetTextBox +## SecondaryValueOptions ### Properties -* **Content**: string -* **SheetTextBoxId**: string (Required) +* **Visibility**: string -## Visual +## SecondaryValueOptions ### Properties -* **BarChartVisual**: [BarChartVisual](#barchartvisual) -* **BoxPlotVisual**: [BoxPlotVisual](#boxplotvisual) -* **ComboChartVisual**: [ComboChartVisual](#combochartvisual) -* **CustomContentVisual**: [CustomContentVisual](#customcontentvisual) -* **EmptyVisual**: [EmptyVisual](#emptyvisual) -* **FilledMapVisual**: [FilledMapVisual](#filledmapvisual) -* **FunnelChartVisual**: [FunnelChartVisual](#funnelchartvisual) -* **GaugeChartVisual**: [GaugeChartVisual](#gaugechartvisual) -* **GeospatialMapVisual**: [GeospatialMapVisual](#geospatialmapvisual) -* **HeatMapVisual**: [HeatMapVisual](#heatmapvisual) -* **HistogramVisual**: [HistogramVisual](#histogramvisual) -* **InsightVisual**: [InsightVisual](#insightvisual) -* **KPIVisual**: [KPIVisual](#kpivisual) -* **LineChartVisual**: [LineChartVisual](#linechartvisual) -* **PieChartVisual**: [PieChartVisual](#piechartvisual) -* **PivotTableVisual**: [PivotTableVisual](#pivottablevisual) -* **RadarChartVisual**: [RadarChartVisual](#radarchartvisual) -* **SankeyDiagramVisual**: [SankeyDiagramVisual](#sankeydiagramvisual) -* **ScatterPlotVisual**: [ScatterPlotVisual](#scatterplotvisual) -* **TableVisual**: [TableVisual](#tablevisual) -* **TreeMapVisual**: [TreeMapVisual](#treemapvisual) -* **WaterfallVisual**: [WaterfallVisual](#waterfallvisual) -* **WordCloudVisual**: [WordCloudVisual](#wordcloudvisual) +* **Visibility**: string -## BarChartVisual +## SectionAfterPageBreak ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [BarChartConfiguration](#barchartconfiguration) -* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] -* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) -* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) -* **VisualId**: string (Required) +* **Status**: string -## VisualCustomAction +## SectionAfterPageBreak ### Properties -* **ActionOperations**: [VisualCustomActionOperation](#visualcustomactionoperation)[] (Required) -* **CustomActionId**: string (Required) -* **Name**: string (Required) * **Status**: string -* **Trigger**: string (Required) -## VisualCustomActionOperation +## SectionAfterPageBreak ### Properties -* **FilterOperation**: [CustomActionFilterOperation](#customactionfilteroperation) -* **NavigationOperation**: [CustomActionNavigationOperation](#customactionnavigationoperation) -* **SetParametersOperation**: [CustomActionSetParametersOperation](#customactionsetparametersoperation) -* **URLOperation**: [CustomActionURLOperation](#customactionurloperation) +* **Status**: string -## CustomActionFilterOperation +## SectionBasedLayoutCanvasSizeOptions ### Properties -* **SelectedFieldsConfiguration**: [FilterOperationSelectedFieldsConfiguration](#filteroperationselectedfieldsconfiguration) (Required) -* **TargetVisualsConfiguration**: [FilterOperationTargetVisualsConfiguration](#filteroperationtargetvisualsconfiguration) (Required) +* **PaperCanvasSizeOptions**: [SectionBasedLayoutPaperCanvasSizeOptions](#sectionbasedlayoutpapercanvassizeoptions) -## FilterOperationSelectedFieldsConfiguration +## SectionBasedLayoutCanvasSizeOptions ### Properties -* **SelectedColumns**: [ColumnIdentifier](#columnidentifier)[] -* **SelectedFieldOptions**: string -* **SelectedFields**: string[] +* **PaperCanvasSizeOptions**: [SectionBasedLayoutPaperCanvasSizeOptions](#sectionbasedlayoutpapercanvassizeoptions) -## FilterOperationTargetVisualsConfiguration +## SectionBasedLayoutCanvasSizeOptions ### Properties -* **SameSheetTargetVisualConfiguration**: [SameSheetTargetVisualConfiguration](#samesheettargetvisualconfiguration) +* **PaperCanvasSizeOptions**: [SectionBasedLayoutPaperCanvasSizeOptions](#sectionbasedlayoutpapercanvassizeoptions) -## SameSheetTargetVisualConfiguration +## SectionBasedLayoutConfiguration ### Properties -* **TargetVisualOptions**: string -* **TargetVisuals**: string[] +* **BodySections**: [BodySectionConfiguration](#bodysectionconfiguration)[] (Required) +* **CanvasSizeOptions**: [SectionBasedLayoutCanvasSizeOptions](#sectionbasedlayoutcanvassizeoptions) (Required) +* **FooterSections**: [HeaderFooterSectionConfiguration](#headerfootersectionconfiguration)[] (Required) +* **HeaderSections**: [HeaderFooterSectionConfiguration](#headerfootersectionconfiguration)[] (Required) -## CustomActionNavigationOperation +## SectionBasedLayoutConfiguration ### Properties -* **LocalNavigationConfiguration**: [LocalNavigationConfiguration](#localnavigationconfiguration) +* **BodySections**: [BodySectionConfiguration](#bodysectionconfiguration)[] (Required) +* **CanvasSizeOptions**: [SectionBasedLayoutCanvasSizeOptions](#sectionbasedlayoutcanvassizeoptions) (Required) +* **FooterSections**: [HeaderFooterSectionConfiguration](#headerfootersectionconfiguration)[] (Required) +* **HeaderSections**: [HeaderFooterSectionConfiguration](#headerfootersectionconfiguration)[] (Required) -## LocalNavigationConfiguration +## SectionBasedLayoutConfiguration ### Properties -* **TargetSheetId**: string (Required) +* **BodySections**: [BodySectionConfiguration](#bodysectionconfiguration)[] (Required) +* **CanvasSizeOptions**: [SectionBasedLayoutCanvasSizeOptions](#sectionbasedlayoutcanvassizeoptions) (Required) +* **FooterSections**: [HeaderFooterSectionConfiguration](#headerfootersectionconfiguration)[] (Required) +* **HeaderSections**: [HeaderFooterSectionConfiguration](#headerfootersectionconfiguration)[] (Required) -## CustomActionSetParametersOperation +## SectionBasedLayoutPaperCanvasSizeOptions ### Properties -* **ParameterValueConfigurations**: [SetParameterValueConfiguration](#setparametervalueconfiguration)[] (Required) +* **PaperMargin**: [Spacing](#spacing) +* **PaperOrientation**: string +* **PaperSize**: string -## SetParameterValueConfiguration +## SectionBasedLayoutPaperCanvasSizeOptions ### Properties -* **DestinationParameterName**: string (Required) -* **Value**: [DestinationParameterValueConfiguration](#destinationparametervalueconfiguration) (Required) +* **PaperMargin**: [Spacing](#spacing) +* **PaperOrientation**: string +* **PaperSize**: string -## DestinationParameterValueConfiguration +## SectionBasedLayoutPaperCanvasSizeOptions ### Properties -* **CustomValuesConfiguration**: [CustomValuesConfiguration](#customvaluesconfiguration) -* **SelectAllValueOptions**: string -* **SourceColumn**: [ColumnIdentifier](#columnidentifier) -* **SourceField**: string -* **SourceParameterName**: string +* **PaperMargin**: [Spacing](#spacing) +* **PaperOrientation**: string +* **PaperSize**: string -## CustomValuesConfiguration +## SectionLayoutConfiguration ### Properties -* **CustomValues**: [CustomParameterValues](#customparametervalues) (Required) -* **IncludeNullValue**: bool +* **FreeFormLayout**: [FreeFormSectionLayoutConfiguration](#freeformsectionlayoutconfiguration) (Required) -## CustomParameterValues +## SectionLayoutConfiguration ### Properties -* **DateTimeValues**: string[] -* **DecimalValues**: int[] -* **IntegerValues**: int[] -* **StringValues**: string[] +* **FreeFormLayout**: [FreeFormSectionLayoutConfiguration](#freeformsectionlayoutconfiguration) (Required) -## CustomActionURLOperation +## SectionLayoutConfiguration ### Properties -* **URLTarget**: string (Required) -* **URLTemplate**: string (Required) +* **FreeFormLayout**: [FreeFormSectionLayoutConfiguration](#freeformsectionlayoutconfiguration) (Required) -## BarChartConfiguration +## SectionPageBreakConfiguration ### Properties -* **BarsArrangement**: string -* **CategoryAxis**: [AxisDisplayOptions](#axisdisplayoptions) -* **CategoryLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **ColorLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **ContributionAnalysisDefaults**: [ContributionAnalysisDefault](#contributionanalysisdefault)[] -* **DataLabels**: [DataLabelOptions](#datalabeloptions) -* **FieldWells**: [BarChartFieldWells](#barchartfieldwells) -* **Legend**: [LegendOptions](#legendoptions) -* **Orientation**: string -* **ReferenceLines**: [ReferenceLine](#referenceline)[] -* **SmallMultiplesOptions**: [SmallMultiplesOptions](#smallmultiplesoptions) -* **SortConfiguration**: [BarChartSortConfiguration](#barchartsortconfiguration) -* **Tooltip**: [TooltipOptions](#tooltipoptions) -* **ValueAxis**: [AxisDisplayOptions](#axisdisplayoptions) -* **ValueLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **VisualPalette**: [VisualPalette](#visualpalette) +* **After**: [SectionAfterPageBreak](#sectionafterpagebreak) -## AxisDisplayOptions +## SectionPageBreakConfiguration ### Properties -* **AxisLineVisibility**: string -* **AxisOffset**: string: String based length that is composed of value and unit in px -* **DataOptions**: [AxisDataOptions](#axisdataoptions) -* **GridLineVisibility**: string -* **ScrollbarOptions**: [ScrollBarOptions](#scrollbaroptions) -* **TickLabelOptions**: [AxisTickLabelOptions](#axisticklabeloptions) +* **After**: [SectionAfterPageBreak](#sectionafterpagebreak) -## AxisDataOptions +## SectionPageBreakConfiguration ### Properties -* **DateAxisOptions**: [DateAxisOptions](#dateaxisoptions) -* **NumericAxisOptions**: [NumericAxisOptions](#numericaxisoptions) +* **After**: [SectionAfterPageBreak](#sectionafterpagebreak) -## DateAxisOptions +## SectionStyle ### Properties -* **MissingDateVisibility**: string +* **Height**: string: String based length that is composed of value and unit in px +* **Padding**: [Spacing](#spacing) -## NumericAxisOptions +## SectionStyle ### Properties -* **Range**: [AxisDisplayRange](#axisdisplayrange) -* **Scale**: [AxisScale](#axisscale) +* **Height**: string: String based length that is composed of value and unit in px +* **Padding**: [Spacing](#spacing) -## AxisDisplayRange +## SectionStyle ### Properties -* **DataDriven**: [AxisDisplayDataDrivenRange](#axisdisplaydatadrivenrange) -* **MinMax**: [AxisDisplayMinMaxRange](#axisdisplayminmaxrange) +* **Height**: string: String based length that is composed of value and unit in px +* **Padding**: [Spacing](#spacing) -## AxisDisplayDataDrivenRange +## SelectedSheetsFilterScopeConfiguration ### Properties +* **SheetVisualScopingConfigurations**: [SheetVisualScopingConfiguration](#sheetvisualscopingconfiguration)[] -## AxisDisplayMinMaxRange +## SelectedSheetsFilterScopeConfiguration ### Properties -* **Maximum**: int -* **Minimum**: int +* **SheetVisualScopingConfigurations**: [SheetVisualScopingConfiguration](#sheetvisualscopingconfiguration)[] -## AxisScale +## SelectedSheetsFilterScopeConfiguration ### Properties -* **Linear**: [AxisLinearScale](#axislinearscale) -* **Logarithmic**: [AxisLogarithmicScale](#axislogarithmicscale) +* **SheetVisualScopingConfigurations**: [SheetVisualScopingConfiguration](#sheetvisualscopingconfiguration)[] -## AxisLinearScale +## SemanticEntityType ### Properties -* **StepCount**: int -* **StepSize**: int +* **SubTypeName**: string +* **TypeName**: string +* **TypeParameters**: [TypeParameters](#typeparameters) -## AxisLogarithmicScale +## SemanticType ### Properties -* **Base**: int +* **FalseyCellValue**: string +* **FalseyCellValueSynonyms**: string[] +* **SubTypeName**: string +* **TruthyCellValue**: string +* **TruthyCellValueSynonyms**: string[] +* **TypeName**: string +* **TypeParameters**: [TypeParameters](#typeparameters) -## ScrollBarOptions +## SeriesItem ### Properties -* **Visibility**: string -* **VisibleRange**: [VisibleRangeOptions](#visiblerangeoptions) +* **DataFieldSeriesItem**: [DataFieldSeriesItem](#datafieldseriesitem) +* **FieldSeriesItem**: [FieldSeriesItem](#fieldseriesitem) -## VisibleRangeOptions +## SeriesItem ### Properties -* **PercentRange**: [PercentVisibleRange](#percentvisiblerange) +* **DataFieldSeriesItem**: [DataFieldSeriesItem](#datafieldseriesitem) +* **FieldSeriesItem**: [FieldSeriesItem](#fieldseriesitem) -## PercentVisibleRange +## SeriesItem ### Properties -* **From**: int -* **To**: int +* **DataFieldSeriesItem**: [DataFieldSeriesItem](#datafieldseriesitem) +* **FieldSeriesItem**: [FieldSeriesItem](#fieldseriesitem) -## AxisTickLabelOptions +## SetParameterValueConfiguration ### Properties -* **LabelOptions**: [LabelOptions](#labeloptions) -* **RotationAngle**: int +* **DestinationParameterName**: string (Required) +* **Value**: [DestinationParameterValueConfiguration](#destinationparametervalueconfiguration) (Required) -## ChartAxisLabelOptions +## SetParameterValueConfiguration ### Properties -* **AxisLabelOptions**: [AxisLabelOptions](#axislabeloptions)[] -* **SortIconVisibility**: string -* **Visibility**: string +* **DestinationParameterName**: string (Required) +* **Value**: [DestinationParameterValueConfiguration](#destinationparametervalueconfiguration) (Required) -## AxisLabelOptions +## SetParameterValueConfiguration ### Properties -* **ApplyTo**: [AxisLabelReferenceOptions](#axislabelreferenceoptions) -* **CustomLabel**: string -* **FontConfiguration**: [FontConfiguration](#fontconfiguration) +* **DestinationParameterName**: string (Required) +* **Value**: [DestinationParameterValueConfiguration](#destinationparametervalueconfiguration) (Required) -## AxisLabelReferenceOptions +## ShapeConditionalFormat ### Properties -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **FieldId**: string (Required) +* **BackgroundColor**: [ConditionalFormattingColor](#conditionalformattingcolor) (Required) -## ContributionAnalysisDefault +## ShapeConditionalFormat ### Properties -* **ContributorDimensions**: [ColumnIdentifier](#columnidentifier)[] (Required) -* **MeasureFieldId**: string (Required) +* **BackgroundColor**: [ConditionalFormattingColor](#conditionalformattingcolor) (Required) -## DataLabelOptions +## ShapeConditionalFormat ### Properties -* **CategoryLabelVisibility**: string -* **DataLabelTypes**: [DataLabelType](#datalabeltype)[] -* **LabelColor**: string -* **LabelContent**: string -* **LabelFontConfiguration**: [FontConfiguration](#fontconfiguration) -* **MeasureLabelVisibility**: string -* **Overlap**: string -* **Position**: string -* **TotalsVisibility**: string -* **Visibility**: string +* **BackgroundColor**: [ConditionalFormattingColor](#conditionalformattingcolor) (Required) -## DataLabelType +## Sheet ### Properties -* **DataPathLabelType**: [DataPathLabelType](#datapathlabeltype) -* **FieldLabelType**: [FieldLabelType](#fieldlabeltype) -* **MaximumLabelType**: [MaximumLabelType](#maximumlabeltype) -* **MinimumLabelType**: [MinimumLabelType](#minimumlabeltype) -* **RangeEndsLabelType**: [RangeEndsLabelType](#rangeendslabeltype) +* **Name**: string:

The name of a sheet. This name is displayed on the sheet's tab in the Amazon QuickSight + console.

+* **SheetId**: string:

The unique identifier associated with a sheet.

-## DataPathLabelType +## Sheet ### Properties -* **FieldId**: string -* **FieldValue**: string -* **Visibility**: string +* **Name**: string:

The name of a sheet. This name is displayed on the sheet's tab in the Amazon QuickSight + console.

+* **SheetId**: string:

The unique identifier associated with a sheet.

-## FieldLabelType +## Sheet ### Properties -* **FieldId**: string -* **Visibility**: string +* **Name**: string:

The name of a sheet. This name is displayed on the sheet's tab in the Amazon QuickSight + console.

+* **SheetId**: string:

The unique identifier associated with a sheet.

-## MaximumLabelType +## SheetControlInfoIconLabelOptions ### Properties +* **InfoIconText**: string * **Visibility**: string -## MinimumLabelType +## SheetControlInfoIconLabelOptions ### Properties +* **InfoIconText**: string * **Visibility**: string -## RangeEndsLabelType +## SheetControlInfoIconLabelOptions ### Properties +* **InfoIconText**: string * **Visibility**: string -## BarChartFieldWells +## SheetControlLayout ### Properties -* **BarChartAggregatedFieldWells**: [BarChartAggregatedFieldWells](#barchartaggregatedfieldwells) +* **Configuration**: [SheetControlLayoutConfiguration](#sheetcontrollayoutconfiguration) (Required) -## BarChartAggregatedFieldWells +## SheetControlLayout ### Properties -* **Category**: [DimensionField](#dimensionfield)[] -* **Colors**: [DimensionField](#dimensionfield)[] -* **SmallMultiples**: [DimensionField](#dimensionfield)[] -* **Values**: [MeasureField](#measurefield)[] +* **Configuration**: [SheetControlLayoutConfiguration](#sheetcontrollayoutconfiguration) (Required) -## DimensionField +## SheetControlLayout ### Properties -* **CategoricalDimensionField**: [CategoricalDimensionField](#categoricaldimensionfield) -* **DateDimensionField**: [DateDimensionField](#datedimensionfield) -* **NumericalDimensionField**: [NumericalDimensionField](#numericaldimensionfield) +* **Configuration**: [SheetControlLayoutConfiguration](#sheetcontrollayoutconfiguration) (Required) -## CategoricalDimensionField +## SheetControlLayoutConfiguration ### Properties -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **FieldId**: string (Required) -* **FormatConfiguration**: [StringFormatConfiguration](#stringformatconfiguration) -* **HierarchyId**: string +* **GridLayout**: [GridLayoutConfiguration](#gridlayoutconfiguration) -## DateDimensionField +## SheetControlLayoutConfiguration ### Properties -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **DateGranularity**: string -* **FieldId**: string (Required) -* **FormatConfiguration**: [DateTimeFormatConfiguration](#datetimeformatconfiguration) -* **HierarchyId**: string +* **GridLayout**: [GridLayoutConfiguration](#gridlayoutconfiguration) -## NumericalDimensionField +## SheetControlLayoutConfiguration ### Properties -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **FieldId**: string (Required) -* **FormatConfiguration**: [NumberFormatConfiguration](#numberformatconfiguration) -* **HierarchyId**: string +* **GridLayout**: [GridLayoutConfiguration](#gridlayoutconfiguration) -## MeasureField +## SheetControlsOption ### Properties -* **CalculatedMeasureField**: [CalculatedMeasureField](#calculatedmeasurefield) -* **CategoricalMeasureField**: [CategoricalMeasureField](#categoricalmeasurefield) -* **DateMeasureField**: [DateMeasureField](#datemeasurefield) -* **NumericalMeasureField**: [NumericalMeasureField](#numericalmeasurefield) +* **VisibilityState**: string -## CalculatedMeasureField +## SheetDefinition ### Properties -* **Expression**: string (Required) -* **FieldId**: string (Required) +* **ContentType**: string +* **Description**: string +* **FilterControls**: [FilterControl](#filtercontrol)[] +* **Layouts**: [Layout](#layout)[] +* **Name**: string +* **ParameterControls**: [ParameterControl](#parametercontrol)[] +* **SheetControlLayouts**: [SheetControlLayout](#sheetcontrollayout)[] +* **SheetId**: string (Required) +* **TextBoxes**: [SheetTextBox](#sheettextbox)[] +* **Title**: string +* **Visuals**: [Visual](#visual)[] -## CategoricalMeasureField +## SheetDefinition ### Properties -* **AggregationFunction**: string -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **FieldId**: string (Required) -* **FormatConfiguration**: [StringFormatConfiguration](#stringformatconfiguration) +* **ContentType**: string +* **Description**: string +* **FilterControls**: [FilterControl](#filtercontrol)[] +* **Layouts**: [Layout](#layout)[] +* **Name**: string +* **ParameterControls**: [ParameterControl](#parametercontrol)[] +* **SheetControlLayouts**: [SheetControlLayout](#sheetcontrollayout)[] +* **SheetId**: string (Required) +* **TextBoxes**: [SheetTextBox](#sheettextbox)[] +* **Title**: string +* **Visuals**: [Visual](#visual)[] -## DateMeasureField +## SheetDefinition ### Properties -* **AggregationFunction**: string -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **FieldId**: string (Required) -* **FormatConfiguration**: [DateTimeFormatConfiguration](#datetimeformatconfiguration) +* **ContentType**: string +* **Description**: string +* **FilterControls**: [FilterControl](#filtercontrol)[] +* **Layouts**: [Layout](#layout)[] +* **Name**: string +* **ParameterControls**: [ParameterControl](#parametercontrol)[] +* **SheetControlLayouts**: [SheetControlLayout](#sheetcontrollayout)[] +* **SheetId**: string (Required) +* **TextBoxes**: [SheetTextBox](#sheettextbox)[] +* **Title**: string +* **Visuals**: [Visual](#visual)[] -## NumericalMeasureField +## SheetElementConfigurationOverrides ### Properties -* **AggregationFunction**: [NumericalAggregationFunction](#numericalaggregationfunction) -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **FieldId**: string (Required) -* **FormatConfiguration**: [NumberFormatConfiguration](#numberformatconfiguration) +* **Visibility**: string -## LegendOptions +## SheetElementConfigurationOverrides ### Properties -* **Height**: string: String based length that is composed of value and unit in px -* **Position**: string -* **Title**: [LabelOptions](#labeloptions) * **Visibility**: string -* **Width**: string: String based length that is composed of value and unit in px -## ReferenceLine +## SheetElementConfigurationOverrides ### Properties -* **DataConfiguration**: [ReferenceLineDataConfiguration](#referencelinedataconfiguration) (Required) -* **LabelConfiguration**: [ReferenceLineLabelConfiguration](#referencelinelabelconfiguration) -* **Status**: string -* **StyleConfiguration**: [ReferenceLineStyleConfiguration](#referencelinestyleconfiguration) +* **Visibility**: string -## ReferenceLineDataConfiguration +## SheetElementRenderingRule ### Properties -* **AxisBinding**: string -* **DynamicConfiguration**: [ReferenceLineDynamicDataConfiguration](#referencelinedynamicdataconfiguration) -* **SeriesType**: string -* **StaticConfiguration**: [ReferenceLineStaticDataConfiguration](#referencelinestaticdataconfiguration) +* **ConfigurationOverrides**: [SheetElementConfigurationOverrides](#sheetelementconfigurationoverrides) (Required) +* **Expression**: string (Required) -## ReferenceLineDynamicDataConfiguration +## SheetElementRenderingRule ### Properties -* **Calculation**: [NumericalAggregationFunction](#numericalaggregationfunction) (Required) -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **MeasureAggregationFunction**: [AggregationFunction](#aggregationfunction) +* **ConfigurationOverrides**: [SheetElementConfigurationOverrides](#sheetelementconfigurationoverrides) (Required) +* **Expression**: string (Required) -## ReferenceLineStaticDataConfiguration +## SheetElementRenderingRule ### Properties -* **Value**: int (Required) +* **ConfigurationOverrides**: [SheetElementConfigurationOverrides](#sheetelementconfigurationoverrides) (Required) +* **Expression**: string (Required) -## ReferenceLineLabelConfiguration +## SheetLayoutElementMaximizationOption ### Properties -* **CustomLabelConfiguration**: [ReferenceLineCustomLabelConfiguration](#referencelinecustomlabelconfiguration) -* **FontColor**: string -* **FontConfiguration**: [FontConfiguration](#fontconfiguration) -* **HorizontalPosition**: string -* **ValueLabelConfiguration**: [ReferenceLineValueLabelConfiguration](#referencelinevaluelabelconfiguration) -* **VerticalPosition**: string +* **AvailabilityStatus**: string -## ReferenceLineCustomLabelConfiguration +## SheetStyle ### Properties -* **CustomLabel**: string (Required) +* **Tile**: [TileStyle](#tilestyle) +* **TileLayout**: [TileLayoutStyle](#tilelayoutstyle) -## ReferenceLineValueLabelConfiguration +## SheetTextBox ### Properties -* **FormatConfiguration**: [NumericFormatConfiguration](#numericformatconfiguration) -* **RelativePosition**: string +* **Content**: string +* **SheetTextBoxId**: string (Required) -## ReferenceLineStyleConfiguration +## SheetTextBox ### Properties -* **Color**: string -* **Pattern**: string +* **Content**: string +* **SheetTextBoxId**: string (Required) -## SmallMultiplesOptions +## SheetTextBox ### Properties -* **MaxVisibleColumns**: int -* **MaxVisibleRows**: int -* **PanelConfiguration**: [PanelConfiguration](#panelconfiguration) -* **XAxis**: [SmallMultiplesAxisProperties](#smallmultiplesaxisproperties) -* **YAxis**: [SmallMultiplesAxisProperties](#smallmultiplesaxisproperties) +* **Content**: string +* **SheetTextBoxId**: string (Required) -## PanelConfiguration +## SheetVisualScopingConfiguration ### Properties -* **BackgroundColor**: string -* **BackgroundVisibility**: string -* **BorderColor**: string -* **BorderStyle**: string -* **BorderThickness**: string: String based length that is composed of value and unit in px -* **BorderVisibility**: string -* **GutterSpacing**: string: String based length that is composed of value and unit in px -* **GutterVisibility**: string -* **Title**: [PanelTitleOptions](#paneltitleoptions) +* **Scope**: string (Required) +* **SheetId**: string (Required) +* **VisualIds**: string[] -## PanelTitleOptions +## SheetVisualScopingConfiguration ### Properties -* **FontConfiguration**: [FontConfiguration](#fontconfiguration) -* **HorizontalTextAlignment**: string -* **Visibility**: string +* **Scope**: string (Required) +* **SheetId**: string (Required) +* **VisualIds**: string[] -## SmallMultiplesAxisProperties +## SheetVisualScopingConfiguration ### Properties -* **Placement**: string -* **Scale**: string +* **Scope**: string (Required) +* **SheetId**: string (Required) +* **VisualIds**: string[] -## BarChartSortConfiguration +## ShortFormatText ### Properties -* **CategoryItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) -* **CategorySort**: [FieldSortOptions](#fieldsortoptions)[] -* **ColorItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) -* **ColorSort**: [FieldSortOptions](#fieldsortoptions)[] -* **SmallMultiplesLimitConfiguration**: [ItemsLimitConfiguration](#itemslimitconfiguration) -* **SmallMultiplesSort**: [FieldSortOptions](#fieldsortoptions)[] +* **PlainText**: string +* **RichText**: string -## ItemsLimitConfiguration +## ShortFormatText ### Properties -* **ItemsLimit**: int -* **OtherCategories**: string +* **PlainText**: string +* **RichText**: string -## FieldSortOptions +## ShortFormatText ### Properties -* **ColumnSort**: [ColumnSort](#columnsort) -* **FieldSort**: [FieldSort](#fieldsort) +* **PlainText**: string +* **RichText**: string -## ColumnSort +## SimpleClusterMarker ### Properties -* **AggregationFunction**: [AggregationFunction](#aggregationfunction) -* **Direction**: string (Required) -* **SortBy**: [ColumnIdentifier](#columnidentifier) (Required) +* **Color**: string -## FieldSort +## SimpleClusterMarker ### Properties -* **Direction**: string (Required) -* **FieldId**: string (Required) +* **Color**: string -## TooltipOptions +## SimpleClusterMarker ### Properties -* **FieldBasedTooltip**: [FieldBasedTooltip](#fieldbasedtooltip) -* **SelectedTooltipType**: string -* **TooltipVisibility**: string +* **Color**: string -## FieldBasedTooltip +## SliderControlDisplayOptions ### Properties -* **AggregationVisibility**: string -* **TooltipFields**: [TooltipItem](#tooltipitem)[] -* **TooltipTitleType**: string +* **InfoIconLabelOptions**: [SheetControlInfoIconLabelOptions](#sheetcontrolinfoiconlabeloptions) +* **TitleOptions**: [LabelOptions](#labeloptions) -## TooltipItem +## SliderControlDisplayOptions ### Properties -* **ColumnTooltipItem**: [ColumnTooltipItem](#columntooltipitem) -* **FieldTooltipItem**: [FieldTooltipItem](#fieldtooltipitem) +* **InfoIconLabelOptions**: [SheetControlInfoIconLabelOptions](#sheetcontrolinfoiconlabeloptions) +* **TitleOptions**: [LabelOptions](#labeloptions) -## ColumnTooltipItem +## SliderControlDisplayOptions ### Properties -* **Aggregation**: [AggregationFunction](#aggregationfunction) -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **Label**: string -* **Visibility**: string +* **InfoIconLabelOptions**: [SheetControlInfoIconLabelOptions](#sheetcontrolinfoiconlabeloptions) +* **TitleOptions**: [LabelOptions](#labeloptions) -## FieldTooltipItem +## SmallMultiplesAxisProperties ### Properties -* **FieldId**: string (Required) -* **Label**: string -* **Visibility**: string +* **Placement**: string +* **Scale**: string -## VisualPalette +## SmallMultiplesAxisProperties ### Properties -* **ChartColor**: string -* **ColorMap**: [DataPathColor](#datapathcolor)[] +* **Placement**: string +* **Scale**: string -## DataPathColor +## SmallMultiplesAxisProperties ### Properties -* **Color**: string (Required) -* **Element**: [DataPathValue](#datapathvalue) (Required) -* **TimeGranularity**: string +* **Placement**: string +* **Scale**: string -## DataPathValue +## SmallMultiplesOptions ### Properties -* **DataPathType**: [DataPathType](#datapathtype) -* **FieldId**: string -* **FieldValue**: string +* **MaxVisibleColumns**: int +* **MaxVisibleRows**: int +* **PanelConfiguration**: [PanelConfiguration](#panelconfiguration) +* **XAxis**: [SmallMultiplesAxisProperties](#smallmultiplesaxisproperties) +* **YAxis**: [SmallMultiplesAxisProperties](#smallmultiplesaxisproperties) -## DataPathType +## SmallMultiplesOptions ### Properties -* **PivotTableDataPathType**: string +* **MaxVisibleColumns**: int +* **MaxVisibleRows**: int +* **PanelConfiguration**: [PanelConfiguration](#panelconfiguration) +* **XAxis**: [SmallMultiplesAxisProperties](#smallmultiplesaxisproperties) +* **YAxis**: [SmallMultiplesAxisProperties](#smallmultiplesaxisproperties) -## ColumnHierarchy +## SmallMultiplesOptions ### Properties -* **DateTimeHierarchy**: [DateTimeHierarchy](#datetimehierarchy) -* **ExplicitHierarchy**: [ExplicitHierarchy](#explicithierarchy) -* **PredefinedHierarchy**: [PredefinedHierarchy](#predefinedhierarchy) +* **MaxVisibleColumns**: int +* **MaxVisibleRows**: int +* **PanelConfiguration**: [PanelConfiguration](#panelconfiguration) +* **XAxis**: [SmallMultiplesAxisProperties](#smallmultiplesaxisproperties) +* **YAxis**: [SmallMultiplesAxisProperties](#smallmultiplesaxisproperties) -## DateTimeHierarchy +## SnowflakeParameters ### Properties -* **DrillDownFilters**: [DrillDownFilter](#drilldownfilter)[] -* **HierarchyId**: string (Required) +* **Database**: string (Required):

Database.

+* **Host**: string (Required):

Host.

+* **Warehouse**: string (Required):

Warehouse.

-## DrillDownFilter +## Spacing ### Properties -* **CategoryFilter**: [CategoryDrillDownFilter](#categorydrilldownfilter) -* **NumericEqualityFilter**: [NumericEqualityDrillDownFilter](#numericequalitydrilldownfilter) -* **TimeRangeFilter**: [TimeRangeDrillDownFilter](#timerangedrilldownfilter) +* **Bottom**: string: String based length that is composed of value and unit +* **Left**: string: String based length that is composed of value and unit +* **Right**: string: String based length that is composed of value and unit +* **Top**: string: String based length that is composed of value and unit -## CategoryDrillDownFilter +## Spacing ### Properties -* **CategoryValues**: string[] (Required) -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) +* **Bottom**: string: String based length that is composed of value and unit +* **Left**: string: String based length that is composed of value and unit +* **Right**: string: String based length that is composed of value and unit +* **Top**: string: String based length that is composed of value and unit -## NumericEqualityDrillDownFilter +## Spacing ### Properties -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **Value**: int (Required) +* **Bottom**: string: String based length that is composed of value and unit +* **Left**: string: String based length that is composed of value and unit +* **Right**: string: String based length that is composed of value and unit +* **Top**: string: String based length that is composed of value and unit -## TimeRangeDrillDownFilter +## SparkParameters ### Properties -* **Column**: [ColumnIdentifier](#columnidentifier) (Required) -* **RangeMaximum**: string (Required) -* **RangeMinimum**: string (Required) -* **TimeGranularity**: string (Required) +* **Host**: string (Required):

Host.

+* **Port**: int (Required):

Port.

-## ExplicitHierarchy +## SqlServerParameters ### Properties -* **Columns**: [ColumnIdentifier](#columnidentifier)[] (Required) -* **DrillDownFilters**: [DrillDownFilter](#drilldownfilter)[] -* **HierarchyId**: string (Required) +* **Database**: string (Required):

Database.

+* **Host**: string (Required):

Host.

+* **Port**: int (Required):

Port.

-## PredefinedHierarchy +## SslProperties ### Properties -* **Columns**: [ColumnIdentifier](#columnidentifier)[] (Required) -* **DrillDownFilters**: [DrillDownFilter](#drilldownfilter)[] -* **HierarchyId**: string (Required) +* **DisableSsl**: bool:

A Boolean option to control whether SSL should be disabled.

-## VisualSubtitleLabelOptions +## StarburstParameters ### Properties -* **FormatText**: [LongFormatText](#longformattext) -* **Visibility**: string +* **Catalog**: string (Required):

The catalog name for the Starburst data source.

+* **Host**: string (Required):

The host name of the Starburst data source.

+* **Port**: int (Required):

The port for the Starburst data source.

+* **ProductType**: string -## LongFormatText +## StringDatasetParameter ### Properties -* **PlainText**: string -* **RichText**: string +* **DefaultValues**: [StringDatasetParameterDefaultValues](#stringdatasetparameterdefaultvalues) +* **Id**: string (Required):

An identifier for the string parameter that is created in the dataset.

+* **Name**: string (Required):

The name of the string parameter that is created in the dataset.

+* **ValueType**: string (Required) -## VisualTitleLabelOptions +## StringDatasetParameterDefaultValues ### Properties -* **FormatText**: [ShortFormatText](#shortformattext) -* **Visibility**: string +* **StaticValues**: string[]:

A list of static default values for a given string parameter.

-## ShortFormatText +## StringDefaultValues ### Properties -* **PlainText**: string -* **RichText**: string +* **DynamicValue**: [DynamicDefaultValue](#dynamicdefaultvalue) +* **StaticValues**: string[] -## BoxPlotVisual +## StringDefaultValues ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [BoxPlotChartConfiguration](#boxplotchartconfiguration) -* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] -* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) -* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) -* **VisualId**: string (Required) +* **DynamicValue**: [DynamicDefaultValue](#dynamicdefaultvalue) +* **StaticValues**: string[] -## BoxPlotChartConfiguration +## StringDefaultValues ### Properties -* **BoxPlotOptions**: [BoxPlotOptions](#boxplotoptions) -* **CategoryAxis**: [AxisDisplayOptions](#axisdisplayoptions) -* **CategoryLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **FieldWells**: [BoxPlotFieldWells](#boxplotfieldwells) -* **Legend**: [LegendOptions](#legendoptions) -* **PrimaryYAxisDisplayOptions**: [AxisDisplayOptions](#axisdisplayoptions) -* **PrimaryYAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **ReferenceLines**: [ReferenceLine](#referenceline)[] -* **SortConfiguration**: [BoxPlotSortConfiguration](#boxplotsortconfiguration) -* **Tooltip**: [TooltipOptions](#tooltipoptions) -* **VisualPalette**: [VisualPalette](#visualpalette) +* **DynamicValue**: [DynamicDefaultValue](#dynamicdefaultvalue) +* **StaticValues**: string[] -## BoxPlotOptions +## StringFormatConfiguration ### Properties -* **AllDataPointsVisibility**: string -* **OutlierVisibility**: string -* **StyleOptions**: [BoxPlotStyleOptions](#boxplotstyleoptions) +* **NullValueFormatConfiguration**: [NullValueFormatConfiguration](#nullvalueformatconfiguration) +* **NumericFormatConfiguration**: [NumericFormatConfiguration](#numericformatconfiguration) -## BoxPlotStyleOptions +## StringFormatConfiguration ### Properties -* **FillStyle**: string +* **NullValueFormatConfiguration**: [NullValueFormatConfiguration](#nullvalueformatconfiguration) +* **NumericFormatConfiguration**: [NumericFormatConfiguration](#numericformatconfiguration) -## BoxPlotFieldWells +## StringFormatConfiguration ### Properties -* **BoxPlotAggregatedFieldWells**: [BoxPlotAggregatedFieldWells](#boxplotaggregatedfieldwells) +* **NullValueFormatConfiguration**: [NullValueFormatConfiguration](#nullvalueformatconfiguration) +* **NumericFormatConfiguration**: [NumericFormatConfiguration](#numericformatconfiguration) -## BoxPlotAggregatedFieldWells +## StringParameter ### Properties -* **GroupBy**: [DimensionField](#dimensionfield)[] -* **Values**: [MeasureField](#measurefield)[] +* **Name**: string (Required):

A display name for a string parameter.

+* **Values**: string[] (Required):

The values of a string parameter.

-## BoxPlotSortConfiguration +## StringParameter ### Properties -* **CategorySort**: [FieldSortOptions](#fieldsortoptions)[] -* **PaginationConfiguration**: [PaginationConfiguration](#paginationconfiguration) +* **Name**: string (Required):

A display name for a string parameter.

+* **Values**: string[] (Required):

The values of a string parameter.

-## PaginationConfiguration +## StringParameterDeclaration ### Properties -* **PageNumber**: int (Required) -* **PageSize**: int (Required) +* **DefaultValues**: [StringDefaultValues](#stringdefaultvalues) +* **MappedDataSetParameters**: [MappedDataSetParameter](#mappeddatasetparameter)[] +* **Name**: string (Required) +* **ParameterValueType**: string (Required) +* **ValueWhenUnset**: [StringValueWhenUnsetConfiguration](#stringvaluewhenunsetconfiguration) -## ComboChartVisual +## StringParameterDeclaration ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [ComboChartConfiguration](#combochartconfiguration) -* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] -* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) -* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) -* **VisualId**: string (Required) +* **DefaultValues**: [StringDefaultValues](#stringdefaultvalues) +* **MappedDataSetParameters**: [MappedDataSetParameter](#mappeddatasetparameter)[] +* **Name**: string (Required) +* **ParameterValueType**: string (Required) +* **ValueWhenUnset**: [StringValueWhenUnsetConfiguration](#stringvaluewhenunsetconfiguration) -## ComboChartConfiguration +## StringParameterDeclaration ### Properties -* **BarDataLabels**: [DataLabelOptions](#datalabeloptions) -* **BarsArrangement**: string -* **CategoryAxis**: [AxisDisplayOptions](#axisdisplayoptions) -* **CategoryLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **ColorLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **FieldWells**: [ComboChartFieldWells](#combochartfieldwells) -* **Legend**: [LegendOptions](#legendoptions) -* **LineDataLabels**: [DataLabelOptions](#datalabeloptions) -* **PrimaryYAxisDisplayOptions**: [AxisDisplayOptions](#axisdisplayoptions) -* **PrimaryYAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **ReferenceLines**: [ReferenceLine](#referenceline)[] -* **SecondaryYAxisDisplayOptions**: [AxisDisplayOptions](#axisdisplayoptions) -* **SecondaryYAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **SortConfiguration**: [ComboChartSortConfiguration](#combochartsortconfiguration) -* **Tooltip**: [TooltipOptions](#tooltipoptions) -* **VisualPalette**: [VisualPalette](#visualpalette) +* **DefaultValues**: [StringDefaultValues](#stringdefaultvalues) +* **MappedDataSetParameters**: [MappedDataSetParameter](#mappeddatasetparameter)[] +* **Name**: string (Required) +* **ParameterValueType**: string (Required) +* **ValueWhenUnset**: [StringValueWhenUnsetConfiguration](#stringvaluewhenunsetconfiguration) -## ComboChartFieldWells +## StringValueWhenUnsetConfiguration ### Properties -* **ComboChartAggregatedFieldWells**: [ComboChartAggregatedFieldWells](#combochartaggregatedfieldwells) +* **CustomValue**: string +* **ValueWhenUnsetOption**: string -## ComboChartAggregatedFieldWells +## StringValueWhenUnsetConfiguration ### Properties -* **BarValues**: [MeasureField](#measurefield)[] -* **Category**: [DimensionField](#dimensionfield)[] -* **Colors**: [DimensionField](#dimensionfield)[] -* **LineValues**: [MeasureField](#measurefield)[] +* **CustomValue**: string +* **ValueWhenUnsetOption**: string -## ComboChartSortConfiguration +## StringValueWhenUnsetConfiguration ### Properties -* **CategoryItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) -* **CategorySort**: [FieldSortOptions](#fieldsortoptions)[] -* **ColorItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) -* **ColorSort**: [FieldSortOptions](#fieldsortoptions)[] +* **CustomValue**: string +* **ValueWhenUnsetOption**: string -## CustomContentVisual +## SubtotalOptions ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [CustomContentConfiguration](#customcontentconfiguration) -* **DataSetIdentifier**: string (Required) -* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) -* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) -* **VisualId**: string (Required) +* **CustomLabel**: string +* **FieldLevel**: string +* **FieldLevelOptions**: [PivotTableFieldSubtotalOptions](#pivottablefieldsubtotaloptions)[] +* **MetricHeaderCellStyle**: [TableCellStyle](#tablecellstyle) +* **StyleTargets**: [TableStyleTarget](#tablestyletarget)[] +* **TotalCellStyle**: [TableCellStyle](#tablecellstyle) +* **TotalsVisibility**: string +* **ValueCellStyle**: [TableCellStyle](#tablecellstyle) -## CustomContentConfiguration +## SubtotalOptions ### Properties -* **ContentType**: string -* **ContentUrl**: string -* **ImageScaling**: string +* **CustomLabel**: string +* **FieldLevel**: string +* **FieldLevelOptions**: [PivotTableFieldSubtotalOptions](#pivottablefieldsubtotaloptions)[] +* **MetricHeaderCellStyle**: [TableCellStyle](#tablecellstyle) +* **StyleTargets**: [TableStyleTarget](#tablestyletarget)[] +* **TotalCellStyle**: [TableCellStyle](#tablecellstyle) +* **TotalsVisibility**: string +* **ValueCellStyle**: [TableCellStyle](#tablecellstyle) -## EmptyVisual +## SubtotalOptions ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **DataSetIdentifier**: string (Required) -* **VisualId**: string (Required) +* **CustomLabel**: string +* **FieldLevel**: string +* **FieldLevelOptions**: [PivotTableFieldSubtotalOptions](#pivottablefieldsubtotaloptions)[] +* **MetricHeaderCellStyle**: [TableCellStyle](#tablecellstyle) +* **StyleTargets**: [TableStyleTarget](#tablestyletarget)[] +* **TotalCellStyle**: [TableCellStyle](#tablecellstyle) +* **TotalsVisibility**: string +* **ValueCellStyle**: [TableCellStyle](#tablecellstyle) -## FilledMapVisual +## TableAggregatedFieldWells ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [FilledMapConfiguration](#filledmapconfiguration) -* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] -* **ConditionalFormatting**: [FilledMapConditionalFormatting](#filledmapconditionalformatting) -* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) -* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) -* **VisualId**: string (Required) +* **GroupBy**: [DimensionField](#dimensionfield)[] +* **Values**: [MeasureField](#measurefield)[] -## FilledMapConfiguration +## TableAggregatedFieldWells ### Properties -* **FieldWells**: [FilledMapFieldWells](#filledmapfieldwells) -* **Legend**: [LegendOptions](#legendoptions) -* **MapStyleOptions**: [GeospatialMapStyleOptions](#geospatialmapstyleoptions) -* **SortConfiguration**: [FilledMapSortConfiguration](#filledmapsortconfiguration) -* **Tooltip**: [TooltipOptions](#tooltipoptions) -* **WindowOptions**: [GeospatialWindowOptions](#geospatialwindowoptions) +* **GroupBy**: [DimensionField](#dimensionfield)[] +* **Values**: [MeasureField](#measurefield)[] -## FilledMapFieldWells +## TableAggregatedFieldWells ### Properties -* **FilledMapAggregatedFieldWells**: [FilledMapAggregatedFieldWells](#filledmapaggregatedfieldwells) +* **GroupBy**: [DimensionField](#dimensionfield)[] +* **Values**: [MeasureField](#measurefield)[] -## FilledMapAggregatedFieldWells +## TableBorderOptions ### Properties -* **Geospatial**: [DimensionField](#dimensionfield)[] -* **Values**: [MeasureField](#measurefield)[] +* **Color**: string +* **Style**: string +* **Thickness**: int -## GeospatialMapStyleOptions +## TableBorderOptions ### Properties -* **BaseMapStyle**: string +* **Color**: string +* **Style**: string +* **Thickness**: int -## FilledMapSortConfiguration +## TableBorderOptions ### Properties -* **CategorySort**: [FieldSortOptions](#fieldsortoptions)[] +* **Color**: string +* **Style**: string +* **Thickness**: int -## GeospatialWindowOptions +## TableCellConditionalFormatting ### Properties -* **Bounds**: [GeospatialCoordinateBounds](#geospatialcoordinatebounds) -* **MapZoomMode**: string +* **FieldId**: string (Required) +* **TextFormat**: [TextConditionalFormat](#textconditionalformat) -## GeospatialCoordinateBounds +## TableCellConditionalFormatting ### Properties -* **East**: int (Required) -* **North**: int (Required) -* **South**: int (Required) -* **West**: int (Required) +* **FieldId**: string (Required) +* **TextFormat**: [TextConditionalFormat](#textconditionalformat) -## FilledMapConditionalFormatting +## TableCellConditionalFormatting ### Properties -* **ConditionalFormattingOptions**: [FilledMapConditionalFormattingOption](#filledmapconditionalformattingoption)[] (Required) +* **FieldId**: string (Required) +* **TextFormat**: [TextConditionalFormat](#textconditionalformat) -## FilledMapConditionalFormattingOption +## TableCellImageSizingConfiguration ### Properties -* **Shape**: [FilledMapShapeConditionalFormatting](#filledmapshapeconditionalformatting) (Required) +* **TableCellImageScalingConfiguration**: string -## FilledMapShapeConditionalFormatting +## TableCellImageSizingConfiguration ### Properties -* **FieldId**: string (Required) -* **Format**: [ShapeConditionalFormat](#shapeconditionalformat) +* **TableCellImageScalingConfiguration**: string -## ShapeConditionalFormat +## TableCellImageSizingConfiguration ### Properties -* **BackgroundColor**: [ConditionalFormattingColor](#conditionalformattingcolor) (Required) +* **TableCellImageScalingConfiguration**: string -## ConditionalFormattingColor +## TableCellStyle ### Properties -* **Gradient**: [ConditionalFormattingGradientColor](#conditionalformattinggradientcolor) -* **Solid**: [ConditionalFormattingSolidColor](#conditionalformattingsolidcolor) +* **BackgroundColor**: string +* **Border**: [GlobalTableBorderOptions](#globaltableborderoptions) +* **FontConfiguration**: [FontConfiguration](#fontconfiguration) +* **Height**: int +* **HorizontalTextAlignment**: string +* **TextWrap**: string +* **VerticalTextAlignment**: string +* **Visibility**: string -## ConditionalFormattingGradientColor +## TableCellStyle ### Properties -* **Color**: [GradientColor](#gradientcolor) (Required) -* **Expression**: string (Required) +* **BackgroundColor**: string +* **Border**: [GlobalTableBorderOptions](#globaltableborderoptions) +* **FontConfiguration**: [FontConfiguration](#fontconfiguration) +* **Height**: int +* **HorizontalTextAlignment**: string +* **TextWrap**: string +* **VerticalTextAlignment**: string +* **Visibility**: string -## GradientColor +## TableCellStyle ### Properties -* **Stops**: [GradientStop](#gradientstop)[] +* **BackgroundColor**: string +* **Border**: [GlobalTableBorderOptions](#globaltableborderoptions) +* **FontConfiguration**: [FontConfiguration](#fontconfiguration) +* **Height**: int +* **HorizontalTextAlignment**: string +* **TextWrap**: string +* **VerticalTextAlignment**: string +* **Visibility**: string -## GradientStop +## TableConditionalFormatting ### Properties -* **Color**: string -* **DataValue**: int -* **GradientOffset**: int (Required) +* **ConditionalFormattingOptions**: [TableConditionalFormattingOption](#tableconditionalformattingoption)[] -## ConditionalFormattingSolidColor +## TableConditionalFormatting ### Properties -* **Color**: string -* **Expression**: string (Required) +* **ConditionalFormattingOptions**: [TableConditionalFormattingOption](#tableconditionalformattingoption)[] -## FunnelChartVisual +## TableConditionalFormatting ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [FunnelChartConfiguration](#funnelchartconfiguration) -* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] -* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) -* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) -* **VisualId**: string (Required) +* **ConditionalFormattingOptions**: [TableConditionalFormattingOption](#tableconditionalformattingoption)[] -## FunnelChartConfiguration +## TableConditionalFormattingOption ### Properties -* **CategoryLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **DataLabelOptions**: [FunnelChartDataLabelOptions](#funnelchartdatalabeloptions) -* **FieldWells**: [FunnelChartFieldWells](#funnelchartfieldwells) -* **SortConfiguration**: [FunnelChartSortConfiguration](#funnelchartsortconfiguration) -* **Tooltip**: [TooltipOptions](#tooltipoptions) -* **ValueLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **VisualPalette**: [VisualPalette](#visualpalette) +* **Cell**: [TableCellConditionalFormatting](#tablecellconditionalformatting) +* **Row**: [TableRowConditionalFormatting](#tablerowconditionalformatting) -## FunnelChartDataLabelOptions +## TableConditionalFormattingOption ### Properties -* **CategoryLabelVisibility**: string -* **LabelColor**: string -* **LabelFontConfiguration**: [FontConfiguration](#fontconfiguration) -* **MeasureDataLabelStyle**: string -* **MeasureLabelVisibility**: string -* **Position**: string -* **Visibility**: string +* **Cell**: [TableCellConditionalFormatting](#tablecellconditionalformatting) +* **Row**: [TableRowConditionalFormatting](#tablerowconditionalformatting) -## FunnelChartFieldWells +## TableConditionalFormattingOption ### Properties -* **FunnelChartAggregatedFieldWells**: [FunnelChartAggregatedFieldWells](#funnelchartaggregatedfieldwells) +* **Cell**: [TableCellConditionalFormatting](#tablecellconditionalformatting) +* **Row**: [TableRowConditionalFormatting](#tablerowconditionalformatting) -## FunnelChartAggregatedFieldWells +## TableConfiguration ### Properties -* **Category**: [DimensionField](#dimensionfield)[] -* **Values**: [MeasureField](#measurefield)[] +* **FieldOptions**: [TableFieldOptions](#tablefieldoptions) +* **FieldWells**: [TableFieldWells](#tablefieldwells) +* **PaginatedReportOptions**: [TablePaginatedReportOptions](#tablepaginatedreportoptions) +* **SortConfiguration**: [TableSortConfiguration](#tablesortconfiguration) +* **TableInlineVisualizations**: [TableInlineVisualization](#tableinlinevisualization)[] +* **TableOptions**: [TableOptions](#tableoptions) +* **TotalOptions**: [TotalOptions](#totaloptions) -## FunnelChartSortConfiguration +## TableConfiguration ### Properties -* **CategoryItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) -* **CategorySort**: [FieldSortOptions](#fieldsortoptions)[] +* **FieldOptions**: [TableFieldOptions](#tablefieldoptions) +* **FieldWells**: [TableFieldWells](#tablefieldwells) +* **PaginatedReportOptions**: [TablePaginatedReportOptions](#tablepaginatedreportoptions) +* **SortConfiguration**: [TableSortConfiguration](#tablesortconfiguration) +* **TableInlineVisualizations**: [TableInlineVisualization](#tableinlinevisualization)[] +* **TableOptions**: [TableOptions](#tableoptions) +* **TotalOptions**: [TotalOptions](#totaloptions) -## GaugeChartVisual +## TableConfiguration ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [GaugeChartConfiguration](#gaugechartconfiguration) -* **ConditionalFormatting**: [GaugeChartConditionalFormatting](#gaugechartconditionalformatting) -* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) -* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) -* **VisualId**: string (Required) +* **FieldOptions**: [TableFieldOptions](#tablefieldoptions) +* **FieldWells**: [TableFieldWells](#tablefieldwells) +* **PaginatedReportOptions**: [TablePaginatedReportOptions](#tablepaginatedreportoptions) +* **SortConfiguration**: [TableSortConfiguration](#tablesortconfiguration) +* **TableInlineVisualizations**: [TableInlineVisualization](#tableinlinevisualization)[] +* **TableOptions**: [TableOptions](#tableoptions) +* **TotalOptions**: [TotalOptions](#totaloptions) -## GaugeChartConfiguration +## TableFieldCustomIconContent ### Properties -* **DataLabels**: [DataLabelOptions](#datalabeloptions) -* **FieldWells**: [GaugeChartFieldWells](#gaugechartfieldwells) -* **GaugeChartOptions**: [GaugeChartOptions](#gaugechartoptions) -* **TooltipOptions**: [TooltipOptions](#tooltipoptions) -* **VisualPalette**: [VisualPalette](#visualpalette) +* **Icon**: string -## GaugeChartFieldWells +## TableFieldCustomIconContent ### Properties -* **TargetValues**: [MeasureField](#measurefield)[] -* **Values**: [MeasureField](#measurefield)[] +* **Icon**: string -## GaugeChartOptions +## TableFieldCustomIconContent ### Properties -* **Arc**: [ArcConfiguration](#arcconfiguration) -* **ArcAxis**: [ArcAxisConfiguration](#arcaxisconfiguration) -* **Comparison**: [ComparisonConfiguration](#comparisonconfiguration) -* **PrimaryValueDisplayType**: string -* **PrimaryValueFontConfiguration**: [FontConfiguration](#fontconfiguration) +* **Icon**: string -## ArcConfiguration +## TableFieldCustomTextContent ### Properties -* **ArcAngle**: int -* **ArcThickness**: string +* **FontConfiguration**: [FontConfiguration](#fontconfiguration) (Required) +* **Value**: string -## ArcAxisConfiguration +## TableFieldCustomTextContent ### Properties -* **Range**: [ArcAxisDisplayRange](#arcaxisdisplayrange) -* **ReserveRange**: int +* **FontConfiguration**: [FontConfiguration](#fontconfiguration) (Required) +* **Value**: string -## ArcAxisDisplayRange +## TableFieldCustomTextContent ### Properties -* **Max**: int -* **Min**: int +* **FontConfiguration**: [FontConfiguration](#fontconfiguration) (Required) +* **Value**: string -## ComparisonConfiguration +## TableFieldImageConfiguration ### Properties -* **ComparisonFormat**: [ComparisonFormatConfiguration](#comparisonformatconfiguration) -* **ComparisonMethod**: string +* **SizingOptions**: [TableCellImageSizingConfiguration](#tablecellimagesizingconfiguration) -## ComparisonFormatConfiguration +## TableFieldImageConfiguration ### Properties -* **NumberDisplayFormatConfiguration**: [NumberDisplayFormatConfiguration](#numberdisplayformatconfiguration) -* **PercentageDisplayFormatConfiguration**: [PercentageDisplayFormatConfiguration](#percentagedisplayformatconfiguration) +* **SizingOptions**: [TableCellImageSizingConfiguration](#tablecellimagesizingconfiguration) -## GaugeChartConditionalFormatting +## TableFieldImageConfiguration ### Properties -* **ConditionalFormattingOptions**: [GaugeChartConditionalFormattingOption](#gaugechartconditionalformattingoption)[] +* **SizingOptions**: [TableCellImageSizingConfiguration](#tablecellimagesizingconfiguration) -## GaugeChartConditionalFormattingOption +## TableFieldLinkConfiguration ### Properties -* **Arc**: [GaugeChartArcConditionalFormatting](#gaugechartarcconditionalformatting) -* **PrimaryValue**: [GaugeChartPrimaryValueConditionalFormatting](#gaugechartprimaryvalueconditionalformatting) +* **Content**: [TableFieldLinkContentConfiguration](#tablefieldlinkcontentconfiguration) (Required) +* **Target**: string (Required) -## GaugeChartArcConditionalFormatting +## TableFieldLinkConfiguration ### Properties -* **ForegroundColor**: [ConditionalFormattingColor](#conditionalformattingcolor) +* **Content**: [TableFieldLinkContentConfiguration](#tablefieldlinkcontentconfiguration) (Required) +* **Target**: string (Required) -## GaugeChartPrimaryValueConditionalFormatting +## TableFieldLinkConfiguration ### Properties -* **Icon**: [ConditionalFormattingIcon](#conditionalformattingicon) -* **TextColor**: [ConditionalFormattingColor](#conditionalformattingcolor) +* **Content**: [TableFieldLinkContentConfiguration](#tablefieldlinkcontentconfiguration) (Required) +* **Target**: string (Required) -## ConditionalFormattingIcon +## TableFieldLinkContentConfiguration ### Properties -* **CustomCondition**: [ConditionalFormattingCustomIconCondition](#conditionalformattingcustomiconcondition) -* **IconSet**: [ConditionalFormattingIconSet](#conditionalformattingiconset) +* **CustomIconContent**: [TableFieldCustomIconContent](#tablefieldcustomiconcontent) +* **CustomTextContent**: [TableFieldCustomTextContent](#tablefieldcustomtextcontent) -## ConditionalFormattingCustomIconCondition +## TableFieldLinkContentConfiguration ### Properties -* **Color**: string -* **DisplayConfiguration**: [ConditionalFormattingIconDisplayConfiguration](#conditionalformattingicondisplayconfiguration) -* **Expression**: string (Required) -* **IconOptions**: [ConditionalFormattingCustomIconOptions](#conditionalformattingcustomiconoptions) (Required) +* **CustomIconContent**: [TableFieldCustomIconContent](#tablefieldcustomiconcontent) +* **CustomTextContent**: [TableFieldCustomTextContent](#tablefieldcustomtextcontent) -## ConditionalFormattingIconDisplayConfiguration +## TableFieldLinkContentConfiguration ### Properties -* **IconDisplayOption**: string +* **CustomIconContent**: [TableFieldCustomIconContent](#tablefieldcustomiconcontent) +* **CustomTextContent**: [TableFieldCustomTextContent](#tablefieldcustomtextcontent) -## ConditionalFormattingCustomIconOptions +## TableFieldOption ### Properties -* **Icon**: string -* **UnicodeIcon**: string +* **CustomLabel**: string +* **FieldId**: string (Required) +* **URLStyling**: [TableFieldURLConfiguration](#tablefieldurlconfiguration) +* **Visibility**: string +* **Width**: string: String based length that is composed of value and unit in px -## ConditionalFormattingIconSet +## TableFieldOption ### Properties -* **Expression**: string (Required) -* **IconSetType**: string +* **CustomLabel**: string +* **FieldId**: string (Required) +* **URLStyling**: [TableFieldURLConfiguration](#tablefieldurlconfiguration) +* **Visibility**: string +* **Width**: string: String based length that is composed of value and unit in px -## GeospatialMapVisual +## TableFieldOption ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [GeospatialMapConfiguration](#geospatialmapconfiguration) -* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] -* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) -* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) -* **VisualId**: string (Required) +* **CustomLabel**: string +* **FieldId**: string (Required) +* **URLStyling**: [TableFieldURLConfiguration](#tablefieldurlconfiguration) +* **Visibility**: string +* **Width**: string: String based length that is composed of value and unit in px -## GeospatialMapConfiguration +## TableFieldOptions ### Properties -* **FieldWells**: [GeospatialMapFieldWells](#geospatialmapfieldwells) -* **Legend**: [LegendOptions](#legendoptions) -* **MapStyleOptions**: [GeospatialMapStyleOptions](#geospatialmapstyleoptions) -* **PointStyleOptions**: [GeospatialPointStyleOptions](#geospatialpointstyleoptions) -* **Tooltip**: [TooltipOptions](#tooltipoptions) -* **VisualPalette**: [VisualPalette](#visualpalette) -* **WindowOptions**: [GeospatialWindowOptions](#geospatialwindowoptions) +* **Order**: string[] +* **PinnedFieldOptions**: [TablePinnedFieldOptions](#tablepinnedfieldoptions) +* **SelectedFieldOptions**: [TableFieldOption](#tablefieldoption)[] -## GeospatialMapFieldWells +## TableFieldOptions ### Properties -* **GeospatialMapAggregatedFieldWells**: [GeospatialMapAggregatedFieldWells](#geospatialmapaggregatedfieldwells) +* **Order**: string[] +* **PinnedFieldOptions**: [TablePinnedFieldOptions](#tablepinnedfieldoptions) +* **SelectedFieldOptions**: [TableFieldOption](#tablefieldoption)[] -## GeospatialMapAggregatedFieldWells +## TableFieldOptions ### Properties -* **Colors**: [DimensionField](#dimensionfield)[] -* **Geospatial**: [DimensionField](#dimensionfield)[] -* **Values**: [MeasureField](#measurefield)[] +* **Order**: string[] +* **PinnedFieldOptions**: [TablePinnedFieldOptions](#tablepinnedfieldoptions) +* **SelectedFieldOptions**: [TableFieldOption](#tablefieldoption)[] -## GeospatialPointStyleOptions +## TableFieldURLConfiguration ### Properties -* **ClusterMarkerConfiguration**: [ClusterMarkerConfiguration](#clustermarkerconfiguration) -* **HeatmapConfiguration**: [GeospatialHeatmapConfiguration](#geospatialheatmapconfiguration) -* **SelectedPointStyle**: string +* **ImageConfiguration**: [TableFieldImageConfiguration](#tablefieldimageconfiguration) +* **LinkConfiguration**: [TableFieldLinkConfiguration](#tablefieldlinkconfiguration) -## ClusterMarkerConfiguration +## TableFieldURLConfiguration ### Properties -* **ClusterMarker**: [ClusterMarker](#clustermarker) +* **ImageConfiguration**: [TableFieldImageConfiguration](#tablefieldimageconfiguration) +* **LinkConfiguration**: [TableFieldLinkConfiguration](#tablefieldlinkconfiguration) -## ClusterMarker +## TableFieldURLConfiguration ### Properties -* **SimpleClusterMarker**: [SimpleClusterMarker](#simpleclustermarker) +* **ImageConfiguration**: [TableFieldImageConfiguration](#tablefieldimageconfiguration) +* **LinkConfiguration**: [TableFieldLinkConfiguration](#tablefieldlinkconfiguration) -## SimpleClusterMarker +## TableFieldWells ### Properties -* **Color**: string +* **TableAggregatedFieldWells**: [TableAggregatedFieldWells](#tableaggregatedfieldwells) +* **TableUnaggregatedFieldWells**: [TableUnaggregatedFieldWells](#tableunaggregatedfieldwells) -## GeospatialHeatmapConfiguration +## TableFieldWells ### Properties -* **HeatmapColor**: [GeospatialHeatmapColorScale](#geospatialheatmapcolorscale) +* **TableAggregatedFieldWells**: [TableAggregatedFieldWells](#tableaggregatedfieldwells) +* **TableUnaggregatedFieldWells**: [TableUnaggregatedFieldWells](#tableunaggregatedfieldwells) -## GeospatialHeatmapColorScale +## TableFieldWells ### Properties -* **Colors**: [GeospatialHeatmapDataColor](#geospatialheatmapdatacolor)[] +* **TableAggregatedFieldWells**: [TableAggregatedFieldWells](#tableaggregatedfieldwells) +* **TableUnaggregatedFieldWells**: [TableUnaggregatedFieldWells](#tableunaggregatedfieldwells) -## GeospatialHeatmapDataColor +## TableInlineVisualization ### Properties -* **Color**: string (Required) +* **DataBars**: [DataBarsOptions](#databarsoptions) -## HeatMapVisual +## TableInlineVisualization ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [HeatMapConfiguration](#heatmapconfiguration) -* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] -* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) -* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) -* **VisualId**: string (Required) +* **DataBars**: [DataBarsOptions](#databarsoptions) -## HeatMapConfiguration +## TableInlineVisualization ### Properties -* **ColorScale**: [ColorScale](#colorscale) -* **ColumnLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **DataLabels**: [DataLabelOptions](#datalabeloptions) -* **FieldWells**: [HeatMapFieldWells](#heatmapfieldwells) -* **Legend**: [LegendOptions](#legendoptions) -* **RowLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **SortConfiguration**: [HeatMapSortConfiguration](#heatmapsortconfiguration) -* **Tooltip**: [TooltipOptions](#tooltipoptions) +* **DataBars**: [DataBarsOptions](#databarsoptions) -## ColorScale +## TableOptions ### Properties -* **ColorFillType**: string (Required) -* **Colors**: [DataColor](#datacolor)[] (Required) -* **NullValueColor**: [DataColor](#datacolor) +* **CellStyle**: [TableCellStyle](#tablecellstyle) +* **HeaderStyle**: [TableCellStyle](#tablecellstyle) +* **Orientation**: string +* **RowAlternateColorOptions**: [RowAlternateColorOptions](#rowalternatecoloroptions) -## DataColor +## TableOptions ### Properties -* **Color**: string -* **DataValue**: int +* **CellStyle**: [TableCellStyle](#tablecellstyle) +* **HeaderStyle**: [TableCellStyle](#tablecellstyle) +* **Orientation**: string +* **RowAlternateColorOptions**: [RowAlternateColorOptions](#rowalternatecoloroptions) -## HeatMapFieldWells +## TableOptions ### Properties -* **HeatMapAggregatedFieldWells**: [HeatMapAggregatedFieldWells](#heatmapaggregatedfieldwells) +* **CellStyle**: [TableCellStyle](#tablecellstyle) +* **HeaderStyle**: [TableCellStyle](#tablecellstyle) +* **Orientation**: string +* **RowAlternateColorOptions**: [RowAlternateColorOptions](#rowalternatecoloroptions) -## HeatMapAggregatedFieldWells +## TablePaginatedReportOptions ### Properties -* **Columns**: [DimensionField](#dimensionfield)[] -* **Rows**: [DimensionField](#dimensionfield)[] -* **Values**: [MeasureField](#measurefield)[] +* **OverflowColumnHeaderVisibility**: string +* **VerticalOverflowVisibility**: string -## HeatMapSortConfiguration +## TablePaginatedReportOptions ### Properties -* **HeatMapColumnItemsLimitConfiguration**: [ItemsLimitConfiguration](#itemslimitconfiguration) -* **HeatMapColumnSort**: [FieldSortOptions](#fieldsortoptions)[] -* **HeatMapRowItemsLimitConfiguration**: [ItemsLimitConfiguration](#itemslimitconfiguration) -* **HeatMapRowSort**: [FieldSortOptions](#fieldsortoptions)[] +* **OverflowColumnHeaderVisibility**: string +* **VerticalOverflowVisibility**: string -## HistogramVisual +## TablePaginatedReportOptions ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [HistogramConfiguration](#histogramconfiguration) -* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) -* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) -* **VisualId**: string (Required) +* **OverflowColumnHeaderVisibility**: string +* **VerticalOverflowVisibility**: string -## HistogramConfiguration +## TablePinnedFieldOptions ### Properties -* **BinOptions**: [HistogramBinOptions](#histogrambinoptions) -* **DataLabels**: [DataLabelOptions](#datalabeloptions) -* **FieldWells**: [HistogramFieldWells](#histogramfieldwells) -* **Tooltip**: [TooltipOptions](#tooltipoptions) -* **VisualPalette**: [VisualPalette](#visualpalette) -* **XAxisDisplayOptions**: [AxisDisplayOptions](#axisdisplayoptions) -* **XAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **YAxisDisplayOptions**: [AxisDisplayOptions](#axisdisplayoptions) +* **PinnedLeftFields**: string[] -## HistogramBinOptions +## TablePinnedFieldOptions ### Properties -* **BinCount**: [BinCountOptions](#bincountoptions) -* **BinWidth**: [BinWidthOptions](#binwidthoptions) -* **SelectedBinType**: string -* **StartValue**: int +* **PinnedLeftFields**: string[] -## BinCountOptions +## TablePinnedFieldOptions ### Properties -* **Value**: int +* **PinnedLeftFields**: string[] -## BinWidthOptions +## TableRowConditionalFormatting ### Properties -* **BinCountLimit**: int -* **Value**: int +* **BackgroundColor**: [ConditionalFormattingColor](#conditionalformattingcolor) +* **TextColor**: [ConditionalFormattingColor](#conditionalformattingcolor) -## HistogramFieldWells +## TableRowConditionalFormatting ### Properties -* **HistogramAggregatedFieldWells**: [HistogramAggregatedFieldWells](#histogramaggregatedfieldwells) +* **BackgroundColor**: [ConditionalFormattingColor](#conditionalformattingcolor) +* **TextColor**: [ConditionalFormattingColor](#conditionalformattingcolor) -## HistogramAggregatedFieldWells +## TableRowConditionalFormatting ### Properties -* **Values**: [MeasureField](#measurefield)[] +* **BackgroundColor**: [ConditionalFormattingColor](#conditionalformattingcolor) +* **TextColor**: [ConditionalFormattingColor](#conditionalformattingcolor) -## InsightVisual +## TableSideBorderOptions ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **DataSetIdentifier**: string (Required) -* **InsightConfiguration**: [InsightConfiguration](#insightconfiguration) -* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) -* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) -* **VisualId**: string (Required) +* **Bottom**: [TableBorderOptions](#tableborderoptions) +* **InnerHorizontal**: [TableBorderOptions](#tableborderoptions) +* **InnerVertical**: [TableBorderOptions](#tableborderoptions) +* **Left**: [TableBorderOptions](#tableborderoptions) +* **Right**: [TableBorderOptions](#tableborderoptions) +* **Top**: [TableBorderOptions](#tableborderoptions) -## InsightConfiguration +## TableSideBorderOptions ### Properties -* **Computations**: [Computation](#computation)[] -* **CustomNarrative**: [CustomNarrativeOptions](#customnarrativeoptions) +* **Bottom**: [TableBorderOptions](#tableborderoptions) +* **InnerHorizontal**: [TableBorderOptions](#tableborderoptions) +* **InnerVertical**: [TableBorderOptions](#tableborderoptions) +* **Left**: [TableBorderOptions](#tableborderoptions) +* **Right**: [TableBorderOptions](#tableborderoptions) +* **Top**: [TableBorderOptions](#tableborderoptions) -## Computation +## TableSideBorderOptions ### Properties -* **Forecast**: [ForecastComputation](#forecastcomputation) -* **GrowthRate**: [GrowthRateComputation](#growthratecomputation) -* **MaximumMinimum**: [MaximumMinimumComputation](#maximumminimumcomputation) -* **MetricComparison**: [MetricComparisonComputation](#metriccomparisoncomputation) -* **PeriodOverPeriod**: [PeriodOverPeriodComputation](#periodoverperiodcomputation) -* **PeriodToDate**: [PeriodToDateComputation](#periodtodatecomputation) -* **TopBottomMovers**: [TopBottomMoversComputation](#topbottommoverscomputation) -* **TopBottomRanked**: [TopBottomRankedComputation](#topbottomrankedcomputation) -* **TotalAggregation**: [TotalAggregationComputation](#totalaggregationcomputation) -* **UniqueValues**: [UniqueValuesComputation](#uniquevaluescomputation) +* **Bottom**: [TableBorderOptions](#tableborderoptions) +* **InnerHorizontal**: [TableBorderOptions](#tableborderoptions) +* **InnerVertical**: [TableBorderOptions](#tableborderoptions) +* **Left**: [TableBorderOptions](#tableborderoptions) +* **Right**: [TableBorderOptions](#tableborderoptions) +* **Top**: [TableBorderOptions](#tableborderoptions) -## ForecastComputation +## TableSortConfiguration ### Properties -* **ComputationId**: string (Required) -* **CustomSeasonalityValue**: int -* **LowerBoundary**: int -* **Name**: string -* **PeriodsBackward**: int -* **PeriodsForward**: int -* **PredictionInterval**: int -* **Seasonality**: string -* **Time**: [DimensionField](#dimensionfield) -* **UpperBoundary**: int -* **Value**: [MeasureField](#measurefield) +* **PaginationConfiguration**: [PaginationConfiguration](#paginationconfiguration) +* **RowSort**: [FieldSortOptions](#fieldsortoptions)[] -## GrowthRateComputation +## TableSortConfiguration ### Properties -* **ComputationId**: string (Required) -* **Name**: string -* **PeriodSize**: int -* **Time**: [DimensionField](#dimensionfield) -* **Value**: [MeasureField](#measurefield) +* **PaginationConfiguration**: [PaginationConfiguration](#paginationconfiguration) +* **RowSort**: [FieldSortOptions](#fieldsortoptions)[] -## MaximumMinimumComputation +## TableSortConfiguration ### Properties -* **ComputationId**: string (Required) -* **Name**: string -* **Time**: [DimensionField](#dimensionfield) -* **Type**: string (Required) -* **Value**: [MeasureField](#measurefield) +* **PaginationConfiguration**: [PaginationConfiguration](#paginationconfiguration) +* **RowSort**: [FieldSortOptions](#fieldsortoptions)[] -## MetricComparisonComputation +## TableStyleTarget ### Properties -* **ComputationId**: string (Required) -* **FromValue**: [MeasureField](#measurefield) -* **Name**: string -* **TargetValue**: [MeasureField](#measurefield) -* **Time**: [DimensionField](#dimensionfield) +* **CellType**: string (Required) -## PeriodOverPeriodComputation +## TableStyleTarget ### Properties -* **ComputationId**: string (Required) -* **Name**: string -* **Time**: [DimensionField](#dimensionfield) -* **Value**: [MeasureField](#measurefield) +* **CellType**: string (Required) -## PeriodToDateComputation +## TableStyleTarget ### Properties -* **ComputationId**: string (Required) -* **Name**: string -* **PeriodTimeGranularity**: string -* **Time**: [DimensionField](#dimensionfield) -* **Value**: [MeasureField](#measurefield) +* **CellType**: string (Required) -## TopBottomMoversComputation +## TableUnaggregatedFieldWells ### Properties -* **Category**: [DimensionField](#dimensionfield) -* **ComputationId**: string (Required) -* **MoverSize**: int -* **Name**: string -* **SortOrder**: string -* **Time**: [DimensionField](#dimensionfield) -* **Type**: string (Required) -* **Value**: [MeasureField](#measurefield) +* **Values**: [UnaggregatedField](#unaggregatedfield)[] -## TopBottomRankedComputation +## TableUnaggregatedFieldWells ### Properties -* **Category**: [DimensionField](#dimensionfield) -* **ComputationId**: string (Required) -* **Name**: string -* **ResultSize**: int -* **Type**: string (Required) -* **Value**: [MeasureField](#measurefield) +* **Values**: [UnaggregatedField](#unaggregatedfield)[] -## TotalAggregationComputation +## TableUnaggregatedFieldWells ### Properties -* **ComputationId**: string (Required) -* **Name**: string -* **Value**: [MeasureField](#measurefield) +* **Values**: [UnaggregatedField](#unaggregatedfield)[] -## UniqueValuesComputation +## TableVisual ### Properties -* **Category**: [DimensionField](#dimensionfield) -* **ComputationId**: string (Required) -* **Name**: string +* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **ChartConfiguration**: [TableConfiguration](#tableconfiguration) +* **ConditionalFormatting**: [TableConditionalFormatting](#tableconditionalformatting) +* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) +* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) +* **VisualId**: string (Required) -## CustomNarrativeOptions +## TableVisual ### Properties -* **Narrative**: string (Required) +* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **ChartConfiguration**: [TableConfiguration](#tableconfiguration) +* **ConditionalFormatting**: [TableConditionalFormatting](#tableconditionalformatting) +* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) +* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) +* **VisualId**: string (Required) -## KPIVisual +## TableVisual ### Properties * **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [KPIConfiguration](#kpiconfiguration) -* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] -* **ConditionalFormatting**: [KPIConditionalFormatting](#kpiconditionalformatting) +* **ChartConfiguration**: [TableConfiguration](#tableconfiguration) +* **ConditionalFormatting**: [TableConditionalFormatting](#tableconditionalformatting) * **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) * **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) * **VisualId**: string (Required) -## KPIConfiguration +## Tag ### Properties -* **FieldWells**: [KPIFieldWells](#kpifieldwells) -* **KPIOptions**: [KPIOptions](#kpioptions) -* **SortConfiguration**: [KPISortConfiguration](#kpisortconfiguration) +* **Key**: string (Required):

Tag key.

+* **Value**: string (Required):

Tag value.

-## KPIFieldWells +## Tag ### Properties -* **TargetValues**: [MeasureField](#measurefield)[] -* **TrendGroups**: [DimensionField](#dimensionfield)[] -* **Values**: [MeasureField](#measurefield)[] +* **Key**: string (Required):

Tag key.

+* **Value**: string (Required):

Tag value.

-## KPIOptions +## Tag ### Properties -* **Comparison**: [ComparisonConfiguration](#comparisonconfiguration) -* **PrimaryValueDisplayType**: string -* **PrimaryValueFontConfiguration**: [FontConfiguration](#fontconfiguration) -* **ProgressBar**: [ProgressBarOptions](#progressbaroptions) -* **SecondaryValue**: [SecondaryValueOptions](#secondaryvalueoptions) -* **SecondaryValueFontConfiguration**: [FontConfiguration](#fontconfiguration) -* **Sparkline**: [KPISparklineOptions](#kpisparklineoptions) -* **TrendArrows**: [TrendArrowOptions](#trendarrowoptions) -* **VisualLayoutOptions**: [KPIVisualLayoutOptions](#kpivisuallayoutoptions) +* **Key**: string (Required):

Tag key.

+* **Value**: string (Required):

Tag value.

-## ProgressBarOptions +## Tag ### Properties -* **Visibility**: string +* **Key**: string (Required):

Tag key.

+* **Value**: string (Required):

Tag value.

-## SecondaryValueOptions +## Tag ### Properties -* **Visibility**: string +* **Key**: string (Required):

Tag key.

+* **Value**: string (Required):

Tag value.

-## KPISparklineOptions +## Tag ### Properties -* **Color**: string -* **TooltipVisibility**: string -* **Type**: string (Required) -* **Visibility**: string +* **Key**: string (Required):

Tag key.

+* **Value**: string (Required):

Tag value.

-## TrendArrowOptions +## Tag ### Properties -* **Visibility**: string +* **Key**: string (Required):

Tag key.

+* **Value**: string (Required):

Tag value.

-## KPIVisualLayoutOptions +## TemplateError ### Properties -* **StandardLayout**: [KPIVisualStandardLayout](#kpivisualstandardlayout) +* **Message**: string:

Description of the error type.

+* **Type**: string +* **ViolatedEntities**: [Entity](#entity)[]:

An error path that shows which entities caused the template error.

-## KPIVisualStandardLayout +## TemplateSourceAnalysis ### Properties -* **Type**: string (Required) +* **Arn**: string (Required):

The Amazon Resource Name (ARN) of the resource.

+* **DataSetReferences**: [DataSetReference](#datasetreference)[] (Required):

A structure containing information about the dataset references used as placeholders + in the template.

-## KPISortConfiguration +## TemplateSourceEntity ### Properties -* **TrendGroupSort**: [FieldSortOptions](#fieldsortoptions)[] +* **SourceAnalysis**: [TemplateSourceAnalysis](#templatesourceanalysis) +* **SourceTemplate**: [TemplateSourceTemplate](#templatesourcetemplate) -## KPIConditionalFormatting +## TemplateSourceTemplate ### Properties -* **ConditionalFormattingOptions**: [KPIConditionalFormattingOption](#kpiconditionalformattingoption)[] +* **Arn**: string (Required):

The Amazon Resource Name (ARN) of the resource.

-## KPIConditionalFormattingOption +## TemplateVersion ### Properties -* **ActualValue**: [KPIActualValueConditionalFormatting](#kpiactualvalueconditionalformatting) -* **ComparisonValue**: [KPIComparisonValueConditionalFormatting](#kpicomparisonvalueconditionalformatting) -* **PrimaryValue**: [KPIPrimaryValueConditionalFormatting](#kpiprimaryvalueconditionalformatting) -* **ProgressBar**: [KPIProgressBarConditionalFormatting](#kpiprogressbarconditionalformatting) +* **CreatedTime**: string:

The time that this template version was created.

+* **DataSetConfigurations**: [DataSetConfiguration](#datasetconfiguration)[]:

Schema of the dataset identified by the placeholder. Any dashboard created from this + template should be bound to new datasets matching the same schema described through this + API operation.

+* **Description**: string:

The description of the template.

+* **Errors**: [TemplateError](#templateerror)[]:

Errors associated with this template version.

+* **Sheets**: [Sheet](#sheet)[]:

A list of the associated sheets with the unique identifier and name of each sheet.

+* **SourceEntityArn**: string:

The Amazon Resource Name (ARN) of an analysis or template that was used to create this + template.

+* **Status**: string +* **ThemeArn**: string:

The ARN of the theme associated with this version of the template.

+* **VersionNumber**: int:

The version number of the template version.

-## KPIActualValueConditionalFormatting +## TemplateVersionDefinition ### Properties -* **Icon**: [ConditionalFormattingIcon](#conditionalformattingicon) -* **TextColor**: [ConditionalFormattingColor](#conditionalformattingcolor) +* **AnalysisDefaults**: [AnalysisDefaults](#analysisdefaults) +* **CalculatedFields**: [CalculatedField](#calculatedfield)[] +* **ColumnConfigurations**: [ColumnConfiguration](#columnconfiguration)[] +* **DataSetConfigurations**: [DataSetConfiguration](#datasetconfiguration)[] (Required) +* **FilterGroups**: [FilterGroup](#filtergroup)[] +* **Options**: [AssetOptions](#assetoptions) +* **ParameterDeclarations**: [ParameterDeclaration](#parameterdeclaration)[] +* **Sheets**: [SheetDefinition](#sheetdefinition)[] -## KPIComparisonValueConditionalFormatting +## TeradataParameters ### Properties -* **Icon**: [ConditionalFormattingIcon](#conditionalformattingicon) -* **TextColor**: [ConditionalFormattingColor](#conditionalformattingcolor) +* **Database**: string (Required):

Database.

+* **Host**: string (Required):

Host.

+* **Port**: int (Required):

Port.

-## KPIPrimaryValueConditionalFormatting +## TextAreaControlDisplayOptions ### Properties -* **Icon**: [ConditionalFormattingIcon](#conditionalformattingicon) -* **TextColor**: [ConditionalFormattingColor](#conditionalformattingcolor) +* **InfoIconLabelOptions**: [SheetControlInfoIconLabelOptions](#sheetcontrolinfoiconlabeloptions) +* **PlaceholderOptions**: [TextControlPlaceholderOptions](#textcontrolplaceholderoptions) +* **TitleOptions**: [LabelOptions](#labeloptions) -## KPIProgressBarConditionalFormatting +## TextAreaControlDisplayOptions ### Properties -* **ForegroundColor**: [ConditionalFormattingColor](#conditionalformattingcolor) +* **InfoIconLabelOptions**: [SheetControlInfoIconLabelOptions](#sheetcontrolinfoiconlabeloptions) +* **PlaceholderOptions**: [TextControlPlaceholderOptions](#textcontrolplaceholderoptions) +* **TitleOptions**: [LabelOptions](#labeloptions) -## LineChartVisual +## TextAreaControlDisplayOptions ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [LineChartConfiguration](#linechartconfiguration) -* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] -* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) -* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) -* **VisualId**: string (Required) +* **InfoIconLabelOptions**: [SheetControlInfoIconLabelOptions](#sheetcontrolinfoiconlabeloptions) +* **PlaceholderOptions**: [TextControlPlaceholderOptions](#textcontrolplaceholderoptions) +* **TitleOptions**: [LabelOptions](#labeloptions) -## LineChartConfiguration +## TextConditionalFormat ### Properties -* **ContributionAnalysisDefaults**: [ContributionAnalysisDefault](#contributionanalysisdefault)[] -* **DataLabels**: [DataLabelOptions](#datalabeloptions) -* **DefaultSeriesSettings**: [LineChartDefaultSeriesSettings](#linechartdefaultseriessettings) -* **FieldWells**: [LineChartFieldWells](#linechartfieldwells) -* **ForecastConfigurations**: [ForecastConfiguration](#forecastconfiguration)[] -* **Legend**: [LegendOptions](#legendoptions) -* **PrimaryYAxisDisplayOptions**: [LineSeriesAxisDisplayOptions](#lineseriesaxisdisplayoptions) -* **PrimaryYAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **ReferenceLines**: [ReferenceLine](#referenceline)[] -* **SecondaryYAxisDisplayOptions**: [LineSeriesAxisDisplayOptions](#lineseriesaxisdisplayoptions) -* **SecondaryYAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **Series**: [SeriesItem](#seriesitem)[] -* **SmallMultiplesOptions**: [SmallMultiplesOptions](#smallmultiplesoptions) -* **SortConfiguration**: [LineChartSortConfiguration](#linechartsortconfiguration) -* **Tooltip**: [TooltipOptions](#tooltipoptions) -* **Type**: string -* **VisualPalette**: [VisualPalette](#visualpalette) -* **XAxisDisplayOptions**: [AxisDisplayOptions](#axisdisplayoptions) -* **XAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **BackgroundColor**: [ConditionalFormattingColor](#conditionalformattingcolor) +* **Icon**: [ConditionalFormattingIcon](#conditionalformattingicon) +* **TextColor**: [ConditionalFormattingColor](#conditionalformattingcolor) -## LineChartDefaultSeriesSettings +## TextConditionalFormat ### Properties -* **AxisBinding**: string -* **LineStyleSettings**: [LineChartLineStyleSettings](#linechartlinestylesettings) -* **MarkerStyleSettings**: [LineChartMarkerStyleSettings](#linechartmarkerstylesettings) +* **BackgroundColor**: [ConditionalFormattingColor](#conditionalformattingcolor) +* **Icon**: [ConditionalFormattingIcon](#conditionalformattingicon) +* **TextColor**: [ConditionalFormattingColor](#conditionalformattingcolor) -## LineChartLineStyleSettings +## TextConditionalFormat ### Properties -* **LineInterpolation**: string -* **LineStyle**: string -* **LineVisibility**: string -* **LineWidth**: string: String based length that is composed of value and unit in px +* **BackgroundColor**: [ConditionalFormattingColor](#conditionalformattingcolor) +* **Icon**: [ConditionalFormattingIcon](#conditionalformattingicon) +* **TextColor**: [ConditionalFormattingColor](#conditionalformattingcolor) + +## TextControlPlaceholderOptions +### Properties +* **Visibility**: string + +## TextControlPlaceholderOptions +### Properties +* **Visibility**: string -## LineChartMarkerStyleSettings +## TextControlPlaceholderOptions ### Properties -* **MarkerColor**: string -* **MarkerShape**: string -* **MarkerSize**: string: String based length that is composed of value and unit in px -* **MarkerVisibility**: string +* **Visibility**: string -## LineChartFieldWells +## TextFieldControlDisplayOptions ### Properties -* **LineChartAggregatedFieldWells**: [LineChartAggregatedFieldWells](#linechartaggregatedfieldwells) +* **InfoIconLabelOptions**: [SheetControlInfoIconLabelOptions](#sheetcontrolinfoiconlabeloptions) +* **PlaceholderOptions**: [TextControlPlaceholderOptions](#textcontrolplaceholderoptions) +* **TitleOptions**: [LabelOptions](#labeloptions) -## LineChartAggregatedFieldWells +## TextFieldControlDisplayOptions ### Properties -* **Category**: [DimensionField](#dimensionfield)[] -* **Colors**: [DimensionField](#dimensionfield)[] -* **SmallMultiples**: [DimensionField](#dimensionfield)[] -* **Values**: [MeasureField](#measurefield)[] +* **InfoIconLabelOptions**: [SheetControlInfoIconLabelOptions](#sheetcontrolinfoiconlabeloptions) +* **PlaceholderOptions**: [TextControlPlaceholderOptions](#textcontrolplaceholderoptions) +* **TitleOptions**: [LabelOptions](#labeloptions) -## ForecastConfiguration +## TextFieldControlDisplayOptions ### Properties -* **ForecastProperties**: [TimeBasedForecastProperties](#timebasedforecastproperties) -* **Scenario**: [ForecastScenario](#forecastscenario) +* **InfoIconLabelOptions**: [SheetControlInfoIconLabelOptions](#sheetcontrolinfoiconlabeloptions) +* **PlaceholderOptions**: [TextControlPlaceholderOptions](#textcontrolplaceholderoptions) +* **TitleOptions**: [LabelOptions](#labeloptions) -## TimeBasedForecastProperties +## ThemeConfiguration ### Properties -* **LowerBoundary**: int -* **PeriodsBackward**: int -* **PeriodsForward**: int -* **PredictionInterval**: int -* **Seasonality**: int -* **UpperBoundary**: int +* **DataColorPalette**: [DataColorPalette](#datacolorpalette) +* **Sheet**: [SheetStyle](#sheetstyle) +* **Typography**: [Typography](#typography) +* **UIColorPalette**: [UIColorPalette](#uicolorpalette) -## ForecastScenario +## ThemeError ### Properties -* **WhatIfPointScenario**: [WhatIfPointScenario](#whatifpointscenario) -* **WhatIfRangeScenario**: [WhatIfRangeScenario](#whatifrangescenario) +* **Message**: string:

The error message.

+* **Type**: string -## WhatIfPointScenario +## ThemeVersion ### Properties -* **Date**: string (Required) -* **Value**: int (Required) +* **Arn**: string:

The Amazon Resource Name (ARN) of the resource.

+* **BaseThemeId**: string:

The Amazon QuickSight-defined ID of the theme that a custom theme inherits from. All + themes initially inherit from a default Amazon QuickSight theme.

+* **Configuration**: [ThemeConfiguration](#themeconfiguration) +* **CreatedTime**: string:

The date and time that this theme version was created.

+* **Description**: string:

The description of the theme.

+* **Errors**: [ThemeError](#themeerror)[]:

Errors associated with the theme.

+* **Status**: string +* **VersionNumber**: int:

The version number of the theme.

-## WhatIfRangeScenario +## ThousandSeparatorOptions ### Properties -* **EndDate**: string (Required) -* **StartDate**: string (Required) -* **Value**: int (Required) +* **Symbol**: string +* **Visibility**: string -## LineSeriesAxisDisplayOptions +## ThousandSeparatorOptions ### Properties -* **AxisOptions**: [AxisDisplayOptions](#axisdisplayoptions) -* **MissingDataConfigurations**: [MissingDataConfiguration](#missingdataconfiguration)[] +* **Symbol**: string +* **Visibility**: string -## MissingDataConfiguration +## ThousandSeparatorOptions ### Properties -* **TreatmentOption**: string +* **Symbol**: string +* **Visibility**: string -## SeriesItem +## TileLayoutStyle ### Properties -* **DataFieldSeriesItem**: [DataFieldSeriesItem](#datafieldseriesitem) -* **FieldSeriesItem**: [FieldSeriesItem](#fieldseriesitem) +* **Gutter**: [GutterStyle](#gutterstyle) +* **Margin**: [MarginStyle](#marginstyle) -## DataFieldSeriesItem +## TileStyle ### Properties -* **AxisBinding**: string (Required) -* **FieldId**: string (Required) -* **FieldValue**: string -* **Settings**: [LineChartSeriesSettings](#linechartseriessettings) +* **Border**: [BorderStyle](#borderstyle) -## LineChartSeriesSettings +## TimeBasedForecastProperties ### Properties -* **LineStyleSettings**: [LineChartLineStyleSettings](#linechartlinestylesettings) -* **MarkerStyleSettings**: [LineChartMarkerStyleSettings](#linechartmarkerstylesettings) +* **LowerBoundary**: int +* **PeriodsBackward**: int +* **PeriodsForward**: int +* **PredictionInterval**: int +* **Seasonality**: int +* **UpperBoundary**: int -## FieldSeriesItem +## TimeBasedForecastProperties ### Properties -* **AxisBinding**: string (Required) -* **FieldId**: string (Required) -* **Settings**: [LineChartSeriesSettings](#linechartseriessettings) +* **LowerBoundary**: int +* **PeriodsBackward**: int +* **PeriodsForward**: int +* **PredictionInterval**: int +* **Seasonality**: int +* **UpperBoundary**: int -## LineChartSortConfiguration +## TimeBasedForecastProperties ### Properties -* **CategoryItemsLimitConfiguration**: [ItemsLimitConfiguration](#itemslimitconfiguration) -* **CategorySort**: [FieldSortOptions](#fieldsortoptions)[] -* **ColorItemsLimitConfiguration**: [ItemsLimitConfiguration](#itemslimitconfiguration) -* **SmallMultiplesLimitConfiguration**: [ItemsLimitConfiguration](#itemslimitconfiguration) -* **SmallMultiplesSort**: [FieldSortOptions](#fieldsortoptions)[] +* **LowerBoundary**: int +* **PeriodsBackward**: int +* **PeriodsForward**: int +* **PredictionInterval**: int +* **Seasonality**: int +* **UpperBoundary**: int -## PieChartVisual +## TimeEqualityFilter ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [PieChartConfiguration](#piechartconfiguration) -* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] -* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) -* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) -* **VisualId**: string (Required) +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) +* **DefaultFilterControlConfiguration**: [DefaultFilterControlConfiguration](#defaultfiltercontrolconfiguration) +* **FilterId**: string (Required) +* **ParameterName**: string +* **RollingDate**: [RollingDateConfiguration](#rollingdateconfiguration) +* **TimeGranularity**: string +* **Value**: string -## PieChartConfiguration +## TimeEqualityFilter ### Properties -* **CategoryLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **ContributionAnalysisDefaults**: [ContributionAnalysisDefault](#contributionanalysisdefault)[] -* **DataLabels**: [DataLabelOptions](#datalabeloptions) -* **DonutOptions**: [DonutOptions](#donutoptions) -* **FieldWells**: [PieChartFieldWells](#piechartfieldwells) -* **Legend**: [LegendOptions](#legendoptions) -* **SmallMultiplesOptions**: [SmallMultiplesOptions](#smallmultiplesoptions) -* **SortConfiguration**: [PieChartSortConfiguration](#piechartsortconfiguration) -* **Tooltip**: [TooltipOptions](#tooltipoptions) -* **ValueLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **VisualPalette**: [VisualPalette](#visualpalette) +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) +* **DefaultFilterControlConfiguration**: [DefaultFilterControlConfiguration](#defaultfiltercontrolconfiguration) +* **FilterId**: string (Required) +* **ParameterName**: string +* **RollingDate**: [RollingDateConfiguration](#rollingdateconfiguration) +* **TimeGranularity**: string +* **Value**: string -## DonutOptions +## TimeEqualityFilter ### Properties -* **ArcOptions**: [ArcOptions](#arcoptions) -* **DonutCenterOptions**: [DonutCenterOptions](#donutcenteroptions) +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) +* **DefaultFilterControlConfiguration**: [DefaultFilterControlConfiguration](#defaultfiltercontrolconfiguration) +* **FilterId**: string (Required) +* **ParameterName**: string +* **RollingDate**: [RollingDateConfiguration](#rollingdateconfiguration) +* **TimeGranularity**: string +* **Value**: string -## ArcOptions +## TimeRangeDrillDownFilter ### Properties -* **ArcThickness**: string +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) +* **RangeMaximum**: string (Required) +* **RangeMinimum**: string (Required) +* **TimeGranularity**: string (Required) -## DonutCenterOptions +## TimeRangeDrillDownFilter ### Properties -* **LabelVisibility**: string +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) +* **RangeMaximum**: string (Required) +* **RangeMinimum**: string (Required) +* **TimeGranularity**: string (Required) -## PieChartFieldWells +## TimeRangeDrillDownFilter ### Properties -* **PieChartAggregatedFieldWells**: [PieChartAggregatedFieldWells](#piechartaggregatedfieldwells) +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) +* **RangeMaximum**: string (Required) +* **RangeMinimum**: string (Required) +* **TimeGranularity**: string (Required) -## PieChartAggregatedFieldWells +## TimeRangeFilter ### Properties -* **Category**: [DimensionField](#dimensionfield)[] -* **SmallMultiples**: [DimensionField](#dimensionfield)[] -* **Values**: [MeasureField](#measurefield)[] +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) +* **DefaultFilterControlConfiguration**: [DefaultFilterControlConfiguration](#defaultfiltercontrolconfiguration) +* **ExcludePeriodConfiguration**: [ExcludePeriodConfiguration](#excludeperiodconfiguration) +* **FilterId**: string (Required) +* **IncludeMaximum**: bool +* **IncludeMinimum**: bool +* **NullOption**: string (Required) +* **RangeMaximumValue**: [TimeRangeFilterValue](#timerangefiltervalue) +* **RangeMinimumValue**: [TimeRangeFilterValue](#timerangefiltervalue) +* **TimeGranularity**: string -## PieChartSortConfiguration +## TimeRangeFilter ### Properties -* **CategoryItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) -* **CategorySort**: [FieldSortOptions](#fieldsortoptions)[] -* **SmallMultiplesLimitConfiguration**: [ItemsLimitConfiguration](#itemslimitconfiguration) -* **SmallMultiplesSort**: [FieldSortOptions](#fieldsortoptions)[] +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) +* **DefaultFilterControlConfiguration**: [DefaultFilterControlConfiguration](#defaultfiltercontrolconfiguration) +* **ExcludePeriodConfiguration**: [ExcludePeriodConfiguration](#excludeperiodconfiguration) +* **FilterId**: string (Required) +* **IncludeMaximum**: bool +* **IncludeMinimum**: bool +* **NullOption**: string (Required) +* **RangeMaximumValue**: [TimeRangeFilterValue](#timerangefiltervalue) +* **RangeMinimumValue**: [TimeRangeFilterValue](#timerangefiltervalue) +* **TimeGranularity**: string -## PivotTableVisual +## TimeRangeFilter ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [PivotTableConfiguration](#pivottableconfiguration) -* **ConditionalFormatting**: [PivotTableConditionalFormatting](#pivottableconditionalformatting) -* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) -* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) -* **VisualId**: string (Required) +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) +* **DefaultFilterControlConfiguration**: [DefaultFilterControlConfiguration](#defaultfiltercontrolconfiguration) +* **ExcludePeriodConfiguration**: [ExcludePeriodConfiguration](#excludeperiodconfiguration) +* **FilterId**: string (Required) +* **IncludeMaximum**: bool +* **IncludeMinimum**: bool +* **NullOption**: string (Required) +* **RangeMaximumValue**: [TimeRangeFilterValue](#timerangefiltervalue) +* **RangeMinimumValue**: [TimeRangeFilterValue](#timerangefiltervalue) +* **TimeGranularity**: string -## PivotTableConfiguration +## TimeRangeFilterValue ### Properties -* **FieldOptions**: [PivotTableFieldOptions](#pivottablefieldoptions) -* **FieldWells**: [PivotTableFieldWells](#pivottablefieldwells) -* **PaginatedReportOptions**: [PivotTablePaginatedReportOptions](#pivottablepaginatedreportoptions) -* **SortConfiguration**: [PivotTableSortConfiguration](#pivottablesortconfiguration) -* **TableOptions**: [PivotTableOptions](#pivottableoptions) -* **TotalOptions**: [PivotTableTotalOptions](#pivottabletotaloptions) +* **Parameter**: string +* **RollingDate**: [RollingDateConfiguration](#rollingdateconfiguration) +* **StaticValue**: string -## PivotTableFieldOptions +## TimeRangeFilterValue ### Properties -* **CollapseStateOptions**: [PivotTableFieldCollapseStateOption](#pivottablefieldcollapsestateoption)[] -* **DataPathOptions**: [PivotTableDataPathOption](#pivottabledatapathoption)[] -* **SelectedFieldOptions**: [PivotTableFieldOption](#pivottablefieldoption)[] +* **Parameter**: string +* **RollingDate**: [RollingDateConfiguration](#rollingdateconfiguration) +* **StaticValue**: string -## PivotTableFieldCollapseStateOption +## TimeRangeFilterValue ### Properties -* **State**: string -* **Target**: [PivotTableFieldCollapseStateTarget](#pivottablefieldcollapsestatetarget) (Required) +* **Parameter**: string +* **RollingDate**: [RollingDateConfiguration](#rollingdateconfiguration) +* **StaticValue**: string -## PivotTableFieldCollapseStateTarget +## TooltipItem ### Properties -* **FieldDataPathValues**: [DataPathValue](#datapathvalue)[] -* **FieldId**: string +* **ColumnTooltipItem**: [ColumnTooltipItem](#columntooltipitem) +* **FieldTooltipItem**: [FieldTooltipItem](#fieldtooltipitem) -## PivotTableDataPathOption +## TooltipItem ### Properties -* **DataPathList**: [DataPathValue](#datapathvalue)[] (Required) -* **Width**: string: String based length that is composed of value and unit in px +* **ColumnTooltipItem**: [ColumnTooltipItem](#columntooltipitem) +* **FieldTooltipItem**: [FieldTooltipItem](#fieldtooltipitem) -## PivotTableFieldOption +## TooltipItem ### Properties -* **CustomLabel**: string -* **FieldId**: string (Required) -* **Visibility**: string +* **ColumnTooltipItem**: [ColumnTooltipItem](#columntooltipitem) +* **FieldTooltipItem**: [FieldTooltipItem](#fieldtooltipitem) -## PivotTableFieldWells +## TooltipOptions ### Properties -* **PivotTableAggregatedFieldWells**: [PivotTableAggregatedFieldWells](#pivottableaggregatedfieldwells) +* **FieldBasedTooltip**: [FieldBasedTooltip](#fieldbasedtooltip) +* **SelectedTooltipType**: string +* **TooltipVisibility**: string -## PivotTableAggregatedFieldWells +## TooltipOptions ### Properties -* **Columns**: [DimensionField](#dimensionfield)[] -* **Rows**: [DimensionField](#dimensionfield)[] -* **Values**: [MeasureField](#measurefield)[] +* **FieldBasedTooltip**: [FieldBasedTooltip](#fieldbasedtooltip) +* **SelectedTooltipType**: string +* **TooltipVisibility**: string -## PivotTablePaginatedReportOptions +## TooltipOptions ### Properties -* **OverflowColumnHeaderVisibility**: string -* **VerticalOverflowVisibility**: string +* **FieldBasedTooltip**: [FieldBasedTooltip](#fieldbasedtooltip) +* **SelectedTooltipType**: string +* **TooltipVisibility**: string -## PivotTableSortConfiguration +## TopBottomFilter ### Properties -* **FieldSortOptions**: [PivotFieldSortOptions](#pivotfieldsortoptions)[] +* **AggregationSortConfigurations**: [AggregationSortConfiguration](#aggregationsortconfiguration)[] (Required) +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) +* **DefaultFilterControlConfiguration**: [DefaultFilterControlConfiguration](#defaultfiltercontrolconfiguration) +* **FilterId**: string (Required) +* **Limit**: int +* **ParameterName**: string +* **TimeGranularity**: string -## PivotFieldSortOptions +## TopBottomFilter ### Properties -* **FieldId**: string (Required) -* **SortBy**: [PivotTableSortBy](#pivottablesortby) (Required) +* **AggregationSortConfigurations**: [AggregationSortConfiguration](#aggregationsortconfiguration)[] (Required) +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) +* **DefaultFilterControlConfiguration**: [DefaultFilterControlConfiguration](#defaultfiltercontrolconfiguration) +* **FilterId**: string (Required) +* **Limit**: int +* **ParameterName**: string +* **TimeGranularity**: string -## PivotTableSortBy +## TopBottomFilter ### Properties -* **Column**: [ColumnSort](#columnsort) -* **DataPath**: [DataPathSort](#datapathsort) -* **Field**: [FieldSort](#fieldsort) +* **AggregationSortConfigurations**: [AggregationSortConfiguration](#aggregationsortconfiguration)[] (Required) +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) +* **DefaultFilterControlConfiguration**: [DefaultFilterControlConfiguration](#defaultfiltercontrolconfiguration) +* **FilterId**: string (Required) +* **Limit**: int +* **ParameterName**: string +* **TimeGranularity**: string -## DataPathSort +## TopBottomMoversComputation ### Properties -* **Direction**: string (Required) -* **SortPaths**: [DataPathValue](#datapathvalue)[] (Required) +* **Category**: [DimensionField](#dimensionfield) +* **ComputationId**: string (Required) +* **MoverSize**: int +* **Name**: string +* **SortOrder**: string +* **Time**: [DimensionField](#dimensionfield) +* **Type**: string (Required) +* **Value**: [MeasureField](#measurefield) -## PivotTableOptions +## TopBottomMoversComputation ### Properties -* **CellStyle**: [TableCellStyle](#tablecellstyle) -* **CollapsedRowDimensionsVisibility**: string -* **ColumnHeaderStyle**: [TableCellStyle](#tablecellstyle) -* **ColumnNamesVisibility**: string -* **DefaultCellWidth**: string: String based length that is composed of value and unit in px -* **MetricPlacement**: string -* **RowAlternateColorOptions**: [RowAlternateColorOptions](#rowalternatecoloroptions) -* **RowFieldNamesStyle**: [TableCellStyle](#tablecellstyle) -* **RowHeaderStyle**: [TableCellStyle](#tablecellstyle) -* **RowsLabelOptions**: [PivotTableRowsLabelOptions](#pivottablerowslabeloptions) -* **RowsLayout**: string -* **SingleMetricVisibility**: string -* **ToggleButtonsVisibility**: string +* **Category**: [DimensionField](#dimensionfield) +* **ComputationId**: string (Required) +* **MoverSize**: int +* **Name**: string +* **SortOrder**: string +* **Time**: [DimensionField](#dimensionfield) +* **Type**: string (Required) +* **Value**: [MeasureField](#measurefield) -## TableCellStyle +## TopBottomMoversComputation ### Properties -* **BackgroundColor**: string -* **Border**: [GlobalTableBorderOptions](#globaltableborderoptions) -* **FontConfiguration**: [FontConfiguration](#fontconfiguration) -* **Height**: int -* **HorizontalTextAlignment**: string -* **TextWrap**: string -* **VerticalTextAlignment**: string -* **Visibility**: string +* **Category**: [DimensionField](#dimensionfield) +* **ComputationId**: string (Required) +* **MoverSize**: int +* **Name**: string +* **SortOrder**: string +* **Time**: [DimensionField](#dimensionfield) +* **Type**: string (Required) +* **Value**: [MeasureField](#measurefield) -## GlobalTableBorderOptions +## TopBottomRankedComputation ### Properties -* **SideSpecificBorder**: [TableSideBorderOptions](#tablesideborderoptions) -* **UniformBorder**: [TableBorderOptions](#tableborderoptions) +* **Category**: [DimensionField](#dimensionfield) +* **ComputationId**: string (Required) +* **Name**: string +* **ResultSize**: int +* **Type**: string (Required) +* **Value**: [MeasureField](#measurefield) -## TableSideBorderOptions +## TopBottomRankedComputation ### Properties -* **Bottom**: [TableBorderOptions](#tableborderoptions) -* **InnerHorizontal**: [TableBorderOptions](#tableborderoptions) -* **InnerVertical**: [TableBorderOptions](#tableborderoptions) -* **Left**: [TableBorderOptions](#tableborderoptions) -* **Right**: [TableBorderOptions](#tableborderoptions) -* **Top**: [TableBorderOptions](#tableborderoptions) +* **Category**: [DimensionField](#dimensionfield) +* **ComputationId**: string (Required) +* **Name**: string +* **ResultSize**: int +* **Type**: string (Required) +* **Value**: [MeasureField](#measurefield) -## TableBorderOptions +## TopBottomRankedComputation ### Properties -* **Color**: string -* **Style**: string -* **Thickness**: int +* **Category**: [DimensionField](#dimensionfield) +* **ComputationId**: string (Required) +* **Name**: string +* **ResultSize**: int +* **Type**: string (Required) +* **Value**: [MeasureField](#measurefield) -## RowAlternateColorOptions +## TopicCalculatedField ### Properties -* **RowAlternateColors**: string[] -* **Status**: string -* **UsePrimaryBackgroundColor**: string +* **Aggregation**: string +* **AllowedAggregations**: string[] +* **CalculatedFieldDescription**: string +* **CalculatedFieldName**: string (Required) +* **CalculatedFieldSynonyms**: string[] +* **CellValueSynonyms**: [CellValueSynonym](#cellvaluesynonym)[] +* **ColumnDataRole**: string +* **ComparativeOrder**: [ComparativeOrder](#comparativeorder) +* **DefaultFormatting**: [DefaultFormatting](#defaultformatting) +* **DisableIndexing**: bool +* **Expression**: string (Required) +* **IsIncludedInTopic**: bool +* **NeverAggregateInFilter**: bool +* **NonAdditive**: bool +* **NotAllowedAggregations**: string[] +* **SemanticType**: [SemanticType](#semantictype) +* **TimeGranularity**: string -## PivotTableRowsLabelOptions +## TopicCategoryFilter ### Properties -* **CustomLabel**: string -* **Visibility**: string +* **CategoryFilterFunction**: string +* **CategoryFilterType**: string +* **Constant**: [TopicCategoryFilterConstant](#topiccategoryfilterconstant) +* **Inverse**: bool -## PivotTableTotalOptions +## TopicCategoryFilterConstant ### Properties -* **ColumnSubtotalOptions**: [SubtotalOptions](#subtotaloptions) -* **ColumnTotalOptions**: [PivotTotalOptions](#pivottotaloptions) -* **RowSubtotalOptions**: [SubtotalOptions](#subtotaloptions) -* **RowTotalOptions**: [PivotTotalOptions](#pivottotaloptions) +* **CollectiveConstant**: [CollectiveConstant](#collectiveconstant) +* **ConstantType**: string +* **SingularConstant**: string -## SubtotalOptions +## TopicColumn ### Properties -* **CustomLabel**: string -* **FieldLevel**: string -* **FieldLevelOptions**: [PivotTableFieldSubtotalOptions](#pivottablefieldsubtotaloptions)[] -* **MetricHeaderCellStyle**: [TableCellStyle](#tablecellstyle) -* **StyleTargets**: [TableStyleTarget](#tablestyletarget)[] -* **TotalCellStyle**: [TableCellStyle](#tablecellstyle) -* **TotalsVisibility**: string -* **ValueCellStyle**: [TableCellStyle](#tablecellstyle) +* **Aggregation**: string +* **AllowedAggregations**: string[] +* **CellValueSynonyms**: [CellValueSynonym](#cellvaluesynonym)[] +* **ColumnDataRole**: string +* **ColumnDescription**: string +* **ColumnFriendlyName**: string +* **ColumnName**: string (Required) +* **ColumnSynonyms**: string[] +* **ComparativeOrder**: [ComparativeOrder](#comparativeorder) +* **DefaultFormatting**: [DefaultFormatting](#defaultformatting) +* **DisableIndexing**: bool +* **IsIncludedInTopic**: bool +* **NeverAggregateInFilter**: bool +* **NonAdditive**: bool +* **NotAllowedAggregations**: string[] +* **SemanticType**: [SemanticType](#semantictype) +* **TimeGranularity**: string -## PivotTableFieldSubtotalOptions +## TopicDateRangeFilter ### Properties -* **FieldId**: string +* **Constant**: [TopicRangeFilterConstant](#topicrangefilterconstant) +* **Inclusive**: bool -## TableStyleTarget +## TopicFilter ### Properties -* **CellType**: string (Required) +* **CategoryFilter**: [TopicCategoryFilter](#topiccategoryfilter) +* **DateRangeFilter**: [TopicDateRangeFilter](#topicdaterangefilter) +* **FilterClass**: string +* **FilterDescription**: string +* **FilterName**: string (Required) +* **FilterSynonyms**: string[] +* **FilterType**: string +* **NumericEqualityFilter**: [TopicNumericEqualityFilter](#topicnumericequalityfilter) +* **NumericRangeFilter**: [TopicNumericRangeFilter](#topicnumericrangefilter) +* **OperandFieldName**: string (Required) +* **RelativeDateFilter**: [TopicRelativeDateFilter](#topicrelativedatefilter) -## PivotTotalOptions +## TopicNamedEntity ### Properties -* **CustomLabel**: string -* **MetricHeaderCellStyle**: [TableCellStyle](#tablecellstyle) -* **Placement**: string -* **ScrollStatus**: string -* **TotalAggregationOptions**: [TotalAggregationOption](#totalaggregationoption)[] -* **TotalCellStyle**: [TableCellStyle](#tablecellstyle) -* **TotalsVisibility**: string -* **ValueCellStyle**: [TableCellStyle](#tablecellstyle) +* **Definition**: [NamedEntityDefinition](#namedentitydefinition)[] +* **EntityDescription**: string +* **EntityName**: string (Required) +* **EntitySynonyms**: string[] +* **SemanticEntityType**: [SemanticEntityType](#semanticentitytype) -## TotalAggregationOption +## TopicNumericEqualityFilter ### Properties -* **FieldId**: string (Required) -* **TotalAggregationFunction**: [TotalAggregationFunction](#totalaggregationfunction) (Required) +* **Aggregation**: string +* **Constant**: [TopicSingularFilterConstant](#topicsingularfilterconstant) -## TotalAggregationFunction +## TopicNumericRangeFilter ### Properties -* **SimpleTotalAggregationFunction**: string +* **Aggregation**: string +* **Constant**: [TopicRangeFilterConstant](#topicrangefilterconstant) +* **Inclusive**: bool -## PivotTableConditionalFormatting +## TopicRangeFilterConstant ### Properties -* **ConditionalFormattingOptions**: [PivotTableConditionalFormattingOption](#pivottableconditionalformattingoption)[] +* **ConstantType**: string +* **RangeConstant**: [RangeConstant](#rangeconstant) -## PivotTableConditionalFormattingOption +## TopicRelativeDateFilter ### Properties -* **Cell**: [PivotTableCellConditionalFormatting](#pivottablecellconditionalformatting) +* **Constant**: [TopicSingularFilterConstant](#topicsingularfilterconstant) +* **RelativeDateFilterFunction**: string +* **TimeGranularity**: string -## PivotTableCellConditionalFormatting +## TopicSingularFilterConstant ### Properties -* **FieldId**: string (Required) -* **Scope**: [PivotTableConditionalFormattingScope](#pivottableconditionalformattingscope) -* **Scopes**: [PivotTableConditionalFormattingScope](#pivottableconditionalformattingscope)[] -* **TextFormat**: [TextConditionalFormat](#textconditionalformat) +* **ConstantType**: string +* **SingularConstant**: string -## PivotTableConditionalFormattingScope +## TotalAggregationComputation ### Properties -* **Role**: string +* **ComputationId**: string (Required) +* **Name**: string +* **Value**: [MeasureField](#measurefield) -## TextConditionalFormat +## TotalAggregationComputation ### Properties -* **BackgroundColor**: [ConditionalFormattingColor](#conditionalformattingcolor) -* **Icon**: [ConditionalFormattingIcon](#conditionalformattingicon) -* **TextColor**: [ConditionalFormattingColor](#conditionalformattingcolor) +* **ComputationId**: string (Required) +* **Name**: string +* **Value**: [MeasureField](#measurefield) -## RadarChartVisual +## TotalAggregationComputation ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [RadarChartConfiguration](#radarchartconfiguration) -* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] -* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) -* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) -* **VisualId**: string (Required) +* **ComputationId**: string (Required) +* **Name**: string +* **Value**: [MeasureField](#measurefield) -## RadarChartConfiguration +## TotalAggregationFunction ### Properties -* **AlternateBandColorsVisibility**: string -* **AlternateBandEvenColor**: string -* **AlternateBandOddColor**: string -* **AxesRangeScale**: string -* **BaseSeriesSettings**: [RadarChartSeriesSettings](#radarchartseriessettings) -* **CategoryAxis**: [AxisDisplayOptions](#axisdisplayoptions) -* **CategoryLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **ColorAxis**: [AxisDisplayOptions](#axisdisplayoptions) -* **ColorLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **FieldWells**: [RadarChartFieldWells](#radarchartfieldwells) -* **Legend**: [LegendOptions](#legendoptions) -* **Shape**: string -* **SortConfiguration**: [RadarChartSortConfiguration](#radarchartsortconfiguration) -* **StartAngle**: int -* **VisualPalette**: [VisualPalette](#visualpalette) +* **SimpleTotalAggregationFunction**: string -## RadarChartSeriesSettings +## TotalAggregationFunction ### Properties -* **AreaStyleSettings**: [RadarChartAreaStyleSettings](#radarchartareastylesettings) +* **SimpleTotalAggregationFunction**: string -## RadarChartAreaStyleSettings +## TotalAggregationFunction ### Properties -* **Visibility**: string +* **SimpleTotalAggregationFunction**: string -## RadarChartFieldWells +## TotalAggregationOption ### Properties -* **RadarChartAggregatedFieldWells**: [RadarChartAggregatedFieldWells](#radarchartaggregatedfieldwells) +* **FieldId**: string (Required) +* **TotalAggregationFunction**: [TotalAggregationFunction](#totalaggregationfunction) (Required) -## RadarChartAggregatedFieldWells +## TotalAggregationOption ### Properties -* **Category**: [DimensionField](#dimensionfield)[] -* **Color**: [DimensionField](#dimensionfield)[] -* **Values**: [MeasureField](#measurefield)[] +* **FieldId**: string (Required) +* **TotalAggregationFunction**: [TotalAggregationFunction](#totalaggregationfunction) (Required) -## RadarChartSortConfiguration +## TotalAggregationOption ### Properties -* **CategoryItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) -* **CategorySort**: [FieldSortOptions](#fieldsortoptions)[] -* **ColorItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) -* **ColorSort**: [FieldSortOptions](#fieldsortoptions)[] +* **FieldId**: string (Required) +* **TotalAggregationFunction**: [TotalAggregationFunction](#totalaggregationfunction) (Required) -## SankeyDiagramVisual +## TotalOptions ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [SankeyDiagramChartConfiguration](#sankeydiagramchartconfiguration) -* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) -* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) -* **VisualId**: string (Required) +* **CustomLabel**: string +* **Placement**: string +* **ScrollStatus**: string +* **TotalAggregationOptions**: [TotalAggregationOption](#totalaggregationoption)[] +* **TotalCellStyle**: [TableCellStyle](#tablecellstyle) +* **TotalsVisibility**: string -## SankeyDiagramChartConfiguration +## TotalOptions ### Properties -* **DataLabels**: [DataLabelOptions](#datalabeloptions) -* **FieldWells**: [SankeyDiagramFieldWells](#sankeydiagramfieldwells) -* **SortConfiguration**: [SankeyDiagramSortConfiguration](#sankeydiagramsortconfiguration) +* **CustomLabel**: string +* **Placement**: string +* **ScrollStatus**: string +* **TotalAggregationOptions**: [TotalAggregationOption](#totalaggregationoption)[] +* **TotalCellStyle**: [TableCellStyle](#tablecellstyle) +* **TotalsVisibility**: string -## SankeyDiagramFieldWells +## TotalOptions ### Properties -* **SankeyDiagramAggregatedFieldWells**: [SankeyDiagramAggregatedFieldWells](#sankeydiagramaggregatedfieldwells) +* **CustomLabel**: string +* **Placement**: string +* **ScrollStatus**: string +* **TotalAggregationOptions**: [TotalAggregationOption](#totalaggregationoption)[] +* **TotalCellStyle**: [TableCellStyle](#tablecellstyle) +* **TotalsVisibility**: string -## SankeyDiagramAggregatedFieldWells +## TreeMapAggregatedFieldWells ### Properties -* **Destination**: [DimensionField](#dimensionfield)[] -* **Source**: [DimensionField](#dimensionfield)[] -* **Weight**: [MeasureField](#measurefield)[] +* **Colors**: [MeasureField](#measurefield)[] +* **Groups**: [DimensionField](#dimensionfield)[] +* **Sizes**: [MeasureField](#measurefield)[] -## SankeyDiagramSortConfiguration +## TreeMapAggregatedFieldWells ### Properties -* **DestinationItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) -* **SourceItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) -* **WeightSort**: [FieldSortOptions](#fieldsortoptions)[] +* **Colors**: [MeasureField](#measurefield)[] +* **Groups**: [DimensionField](#dimensionfield)[] +* **Sizes**: [MeasureField](#measurefield)[] -## ScatterPlotVisual +## TreeMapAggregatedFieldWells ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [ScatterPlotConfiguration](#scatterplotconfiguration) -* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] -* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) -* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) -* **VisualId**: string (Required) +* **Colors**: [MeasureField](#measurefield)[] +* **Groups**: [DimensionField](#dimensionfield)[] +* **Sizes**: [MeasureField](#measurefield)[] -## ScatterPlotConfiguration +## TreeMapConfiguration ### Properties +* **ColorLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **ColorScale**: [ColorScale](#colorscale) * **DataLabels**: [DataLabelOptions](#datalabeloptions) -* **FieldWells**: [ScatterPlotFieldWells](#scatterplotfieldwells) +* **FieldWells**: [TreeMapFieldWells](#treemapfieldwells) +* **GroupLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) * **Legend**: [LegendOptions](#legendoptions) +* **SizeLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **SortConfiguration**: [TreeMapSortConfiguration](#treemapsortconfiguration) * **Tooltip**: [TooltipOptions](#tooltipoptions) -* **VisualPalette**: [VisualPalette](#visualpalette) -* **XAxisDisplayOptions**: [AxisDisplayOptions](#axisdisplayoptions) -* **XAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **YAxisDisplayOptions**: [AxisDisplayOptions](#axisdisplayoptions) -* **YAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -## ScatterPlotFieldWells +## TreeMapConfiguration ### Properties -* **ScatterPlotCategoricallyAggregatedFieldWells**: [ScatterPlotCategoricallyAggregatedFieldWells](#scatterplotcategoricallyaggregatedfieldwells) -* **ScatterPlotUnaggregatedFieldWells**: [ScatterPlotUnaggregatedFieldWells](#scatterplotunaggregatedfieldwells) +* **ColorLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **ColorScale**: [ColorScale](#colorscale) +* **DataLabels**: [DataLabelOptions](#datalabeloptions) +* **FieldWells**: [TreeMapFieldWells](#treemapfieldwells) +* **GroupLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **Legend**: [LegendOptions](#legendoptions) +* **SizeLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **SortConfiguration**: [TreeMapSortConfiguration](#treemapsortconfiguration) +* **Tooltip**: [TooltipOptions](#tooltipoptions) -## ScatterPlotCategoricallyAggregatedFieldWells +## TreeMapConfiguration ### Properties -* **Category**: [DimensionField](#dimensionfield)[] -* **Label**: [DimensionField](#dimensionfield)[] -* **Size**: [MeasureField](#measurefield)[] -* **XAxis**: [MeasureField](#measurefield)[] -* **YAxis**: [MeasureField](#measurefield)[] +* **ColorLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **ColorScale**: [ColorScale](#colorscale) +* **DataLabels**: [DataLabelOptions](#datalabeloptions) +* **FieldWells**: [TreeMapFieldWells](#treemapfieldwells) +* **GroupLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **Legend**: [LegendOptions](#legendoptions) +* **SizeLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **SortConfiguration**: [TreeMapSortConfiguration](#treemapsortconfiguration) +* **Tooltip**: [TooltipOptions](#tooltipoptions) -## ScatterPlotUnaggregatedFieldWells +## TreeMapFieldWells ### Properties -* **Category**: [DimensionField](#dimensionfield)[] -* **Label**: [DimensionField](#dimensionfield)[] -* **Size**: [MeasureField](#measurefield)[] -* **XAxis**: [DimensionField](#dimensionfield)[] -* **YAxis**: [DimensionField](#dimensionfield)[] +* **TreeMapAggregatedFieldWells**: [TreeMapAggregatedFieldWells](#treemapaggregatedfieldwells) -## TableVisual +## TreeMapFieldWells ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [TableConfiguration](#tableconfiguration) -* **ConditionalFormatting**: [TableConditionalFormatting](#tableconditionalformatting) -* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) -* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) -* **VisualId**: string (Required) +* **TreeMapAggregatedFieldWells**: [TreeMapAggregatedFieldWells](#treemapaggregatedfieldwells) -## TableConfiguration +## TreeMapFieldWells ### Properties -* **FieldOptions**: [TableFieldOptions](#tablefieldoptions) -* **FieldWells**: [TableFieldWells](#tablefieldwells) -* **PaginatedReportOptions**: [TablePaginatedReportOptions](#tablepaginatedreportoptions) -* **SortConfiguration**: [TableSortConfiguration](#tablesortconfiguration) -* **TableInlineVisualizations**: [TableInlineVisualization](#tableinlinevisualization)[] -* **TableOptions**: [TableOptions](#tableoptions) -* **TotalOptions**: [TotalOptions](#totaloptions) +* **TreeMapAggregatedFieldWells**: [TreeMapAggregatedFieldWells](#treemapaggregatedfieldwells) -## TableFieldOptions +## TreeMapSortConfiguration ### Properties -* **Order**: string[] -* **PinnedFieldOptions**: [TablePinnedFieldOptions](#tablepinnedfieldoptions) -* **SelectedFieldOptions**: [TableFieldOption](#tablefieldoption)[] +* **TreeMapGroupItemsLimitConfiguration**: [ItemsLimitConfiguration](#itemslimitconfiguration) +* **TreeMapSort**: [FieldSortOptions](#fieldsortoptions)[] -## TablePinnedFieldOptions +## TreeMapSortConfiguration ### Properties -* **PinnedLeftFields**: string[] +* **TreeMapGroupItemsLimitConfiguration**: [ItemsLimitConfiguration](#itemslimitconfiguration) +* **TreeMapSort**: [FieldSortOptions](#fieldsortoptions)[] -## TableFieldOption +## TreeMapSortConfiguration ### Properties -* **CustomLabel**: string -* **FieldId**: string (Required) -* **URLStyling**: [TableFieldURLConfiguration](#tablefieldurlconfiguration) -* **Visibility**: string -* **Width**: string: String based length that is composed of value and unit in px +* **TreeMapGroupItemsLimitConfiguration**: [ItemsLimitConfiguration](#itemslimitconfiguration) +* **TreeMapSort**: [FieldSortOptions](#fieldsortoptions)[] -## TableFieldURLConfiguration +## TreeMapVisual ### Properties -* **ImageConfiguration**: [TableFieldImageConfiguration](#tablefieldimageconfiguration) -* **LinkConfiguration**: [TableFieldLinkConfiguration](#tablefieldlinkconfiguration) +* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **ChartConfiguration**: [TreeMapConfiguration](#treemapconfiguration) +* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] +* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) +* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) +* **VisualId**: string (Required) -## TableFieldImageConfiguration +## TreeMapVisual ### Properties -* **SizingOptions**: [TableCellImageSizingConfiguration](#tablecellimagesizingconfiguration) +* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **ChartConfiguration**: [TreeMapConfiguration](#treemapconfiguration) +* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] +* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) +* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) +* **VisualId**: string (Required) -## TableCellImageSizingConfiguration +## TreeMapVisual ### Properties -* **TableCellImageScalingConfiguration**: string +* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **ChartConfiguration**: [TreeMapConfiguration](#treemapconfiguration) +* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] +* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) +* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) +* **VisualId**: string (Required) -## TableFieldLinkConfiguration +## TrendArrowOptions ### Properties -* **Content**: [TableFieldLinkContentConfiguration](#tablefieldlinkcontentconfiguration) (Required) -* **Target**: string (Required) +* **Visibility**: string -## TableFieldLinkContentConfiguration +## TrendArrowOptions ### Properties -* **CustomIconContent**: [TableFieldCustomIconContent](#tablefieldcustomiconcontent) -* **CustomTextContent**: [TableFieldCustomTextContent](#tablefieldcustomtextcontent) +* **Visibility**: string -## TableFieldCustomIconContent +## TrendArrowOptions ### Properties -* **Icon**: string +* **Visibility**: string -## TableFieldCustomTextContent +## TrinoParameters ### Properties -* **FontConfiguration**: [FontConfiguration](#fontconfiguration) (Required) -* **Value**: string +* **Catalog**: string (Required):

The catalog name for the Trino data source.

+* **Host**: string (Required):

The host name of the Trino data source.

+* **Port**: int (Required):

The port for the Trino data source.

-## TableFieldWells +## TypeParameters ### Properties -* **TableAggregatedFieldWells**: [TableAggregatedFieldWells](#tableaggregatedfieldwells) -* **TableUnaggregatedFieldWells**: [TableUnaggregatedFieldWells](#tableunaggregatedfieldwells) -## TableAggregatedFieldWells +## Typography ### Properties -* **GroupBy**: [DimensionField](#dimensionfield)[] -* **Values**: [MeasureField](#measurefield)[] +* **FontFamilies**: [Font](#font)[] -## TableUnaggregatedFieldWells +## UIColorPalette ### Properties -* **Values**: [UnaggregatedField](#unaggregatedfield)[] +* **Accent**: string:

This color is that applies to selected states and buttons.

+* **AccentForeground**: string:

The foreground color that applies to any text or other elements that appear over the + accent color.

+* **Danger**: string:

The color that applies to error messages.

+* **DangerForeground**: string:

The foreground color that applies to any text or other elements that appear over the + error color.

+* **Dimension**: string:

The color that applies to the names of fields that are identified as + dimensions.

+* **DimensionForeground**: string:

The foreground color that applies to any text or other elements that appear over the + dimension color.

+* **Measure**: string:

The color that applies to the names of fields that are identified as measures.

+* **MeasureForeground**: string:

The foreground color that applies to any text or other elements that appear over the + measure color.

+* **PrimaryBackground**: string:

The background color that applies to visuals and other high emphasis UI.

+* **PrimaryForeground**: string:

The color of text and other foreground elements that appear over the primary + background regions, such as grid lines, borders, table banding, icons, and so on.

+* **SecondaryBackground**: string:

The background color that applies to the sheet background and sheet controls.

+* **SecondaryForeground**: string:

The foreground color that applies to any sheet title, sheet control text, or UI that + appears over the secondary background.

+* **Success**: string:

The color that applies to success messages, for example the check mark for a + successful download.

+* **SuccessForeground**: string:

The foreground color that applies to any text or other elements that appear over the + success color.

+* **Warning**: string:

This color that applies to warning and informational messages.

+* **WarningForeground**: string:

The foreground color that applies to any text or other elements that appear over the + warning color.

## UnaggregatedField ### Properties @@ -9344,583 +9715,543 @@ * **FieldId**: string (Required) * **FormatConfiguration**: [FormatConfiguration](#formatconfiguration) -## TablePaginatedReportOptions -### Properties -* **OverflowColumnHeaderVisibility**: string -* **VerticalOverflowVisibility**: string - -## TableSortConfiguration -### Properties -* **PaginationConfiguration**: [PaginationConfiguration](#paginationconfiguration) -* **RowSort**: [FieldSortOptions](#fieldsortoptions)[] - -## TableInlineVisualization -### Properties -* **DataBars**: [DataBarsOptions](#databarsoptions) - -## DataBarsOptions +## UnaggregatedField ### Properties +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) * **FieldId**: string (Required) -* **NegativeColor**: string -* **PositiveColor**: string - -## TableOptions -### Properties -* **CellStyle**: [TableCellStyle](#tablecellstyle) -* **HeaderStyle**: [TableCellStyle](#tablecellstyle) -* **Orientation**: string -* **RowAlternateColorOptions**: [RowAlternateColorOptions](#rowalternatecoloroptions) - -## TotalOptions -### Properties -* **CustomLabel**: string -* **Placement**: string -* **ScrollStatus**: string -* **TotalAggregationOptions**: [TotalAggregationOption](#totalaggregationoption)[] -* **TotalCellStyle**: [TableCellStyle](#tablecellstyle) -* **TotalsVisibility**: string +* **FormatConfiguration**: [FormatConfiguration](#formatconfiguration) -## TableConditionalFormatting +## UnaggregatedField ### Properties -* **ConditionalFormattingOptions**: [TableConditionalFormattingOption](#tableconditionalformattingoption)[] +* **Column**: [ColumnIdentifier](#columnidentifier) (Required) +* **FieldId**: string (Required) +* **FormatConfiguration**: [FormatConfiguration](#formatconfiguration) -## TableConditionalFormattingOption +## UniqueValuesComputation ### Properties -* **Cell**: [TableCellConditionalFormatting](#tablecellconditionalformatting) -* **Row**: [TableRowConditionalFormatting](#tablerowconditionalformatting) +* **Category**: [DimensionField](#dimensionfield) +* **ComputationId**: string (Required) +* **Name**: string -## TableCellConditionalFormatting +## UniqueValuesComputation ### Properties -* **FieldId**: string (Required) -* **TextFormat**: [TextConditionalFormat](#textconditionalformat) +* **Category**: [DimensionField](#dimensionfield) +* **ComputationId**: string (Required) +* **Name**: string -## TableRowConditionalFormatting +## UniqueValuesComputation ### Properties -* **BackgroundColor**: [ConditionalFormattingColor](#conditionalformattingcolor) -* **TextColor**: [ConditionalFormattingColor](#conditionalformattingcolor) +* **Category**: [DimensionField](#dimensionfield) +* **ComputationId**: string (Required) +* **Name**: string -## TreeMapVisual +## ValidationStrategy ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [TreeMapConfiguration](#treemapconfiguration) -* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] -* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) -* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) -* **VisualId**: string (Required) +* **Mode**: string (Required) -## TreeMapConfiguration +## ValidationStrategy ### Properties -* **ColorLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **ColorScale**: [ColorScale](#colorscale) -* **DataLabels**: [DataLabelOptions](#datalabeloptions) -* **FieldWells**: [TreeMapFieldWells](#treemapfieldwells) -* **GroupLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **Legend**: [LegendOptions](#legendoptions) -* **SizeLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **SortConfiguration**: [TreeMapSortConfiguration](#treemapsortconfiguration) -* **Tooltip**: [TooltipOptions](#tooltipoptions) +* **Mode**: string (Required) -## TreeMapFieldWells +## ValidationStrategy ### Properties -* **TreeMapAggregatedFieldWells**: [TreeMapAggregatedFieldWells](#treemapaggregatedfieldwells) +* **Mode**: string (Required) -## TreeMapAggregatedFieldWells +## VisibleRangeOptions ### Properties -* **Colors**: [MeasureField](#measurefield)[] -* **Groups**: [DimensionField](#dimensionfield)[] -* **Sizes**: [MeasureField](#measurefield)[] +* **PercentRange**: [PercentVisibleRange](#percentvisiblerange) -## TreeMapSortConfiguration +## VisibleRangeOptions ### Properties -* **TreeMapGroupItemsLimitConfiguration**: [ItemsLimitConfiguration](#itemslimitconfiguration) -* **TreeMapSort**: [FieldSortOptions](#fieldsortoptions)[] +* **PercentRange**: [PercentVisibleRange](#percentvisiblerange) -## WaterfallVisual +## VisibleRangeOptions ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [WaterfallChartConfiguration](#waterfallchartconfiguration) -* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] -* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) -* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) -* **VisualId**: string (Required) +* **PercentRange**: [PercentVisibleRange](#percentvisiblerange) -## WaterfallChartConfiguration +## Visual ### Properties -* **CategoryAxisDisplayOptions**: [AxisDisplayOptions](#axisdisplayoptions) -* **CategoryAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **DataLabels**: [DataLabelOptions](#datalabeloptions) -* **FieldWells**: [WaterfallChartFieldWells](#waterfallchartfieldwells) -* **Legend**: [LegendOptions](#legendoptions) -* **PrimaryYAxisDisplayOptions**: [AxisDisplayOptions](#axisdisplayoptions) -* **PrimaryYAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **SortConfiguration**: [WaterfallChartSortConfiguration](#waterfallchartsortconfiguration) -* **VisualPalette**: [VisualPalette](#visualpalette) -* **WaterfallChartOptions**: [WaterfallChartOptions](#waterfallchartoptions) +* **BarChartVisual**: [BarChartVisual](#barchartvisual) +* **BoxPlotVisual**: [BoxPlotVisual](#boxplotvisual) +* **ComboChartVisual**: [ComboChartVisual](#combochartvisual) +* **CustomContentVisual**: [CustomContentVisual](#customcontentvisual) +* **EmptyVisual**: [EmptyVisual](#emptyvisual) +* **FilledMapVisual**: [FilledMapVisual](#filledmapvisual) +* **FunnelChartVisual**: [FunnelChartVisual](#funnelchartvisual) +* **GaugeChartVisual**: [GaugeChartVisual](#gaugechartvisual) +* **GeospatialMapVisual**: [GeospatialMapVisual](#geospatialmapvisual) +* **HeatMapVisual**: [HeatMapVisual](#heatmapvisual) +* **HistogramVisual**: [HistogramVisual](#histogramvisual) +* **InsightVisual**: [InsightVisual](#insightvisual) +* **KPIVisual**: [KPIVisual](#kpivisual) +* **LineChartVisual**: [LineChartVisual](#linechartvisual) +* **PieChartVisual**: [PieChartVisual](#piechartvisual) +* **PivotTableVisual**: [PivotTableVisual](#pivottablevisual) +* **RadarChartVisual**: [RadarChartVisual](#radarchartvisual) +* **SankeyDiagramVisual**: [SankeyDiagramVisual](#sankeydiagramvisual) +* **ScatterPlotVisual**: [ScatterPlotVisual](#scatterplotvisual) +* **TableVisual**: [TableVisual](#tablevisual) +* **TreeMapVisual**: [TreeMapVisual](#treemapvisual) +* **WaterfallVisual**: [WaterfallVisual](#waterfallvisual) +* **WordCloudVisual**: [WordCloudVisual](#wordcloudvisual) -## WaterfallChartFieldWells +## Visual ### Properties -* **WaterfallChartAggregatedFieldWells**: [WaterfallChartAggregatedFieldWells](#waterfallchartaggregatedfieldwells) +* **BarChartVisual**: [BarChartVisual](#barchartvisual) +* **BoxPlotVisual**: [BoxPlotVisual](#boxplotvisual) +* **ComboChartVisual**: [ComboChartVisual](#combochartvisual) +* **CustomContentVisual**: [CustomContentVisual](#customcontentvisual) +* **EmptyVisual**: [EmptyVisual](#emptyvisual) +* **FilledMapVisual**: [FilledMapVisual](#filledmapvisual) +* **FunnelChartVisual**: [FunnelChartVisual](#funnelchartvisual) +* **GaugeChartVisual**: [GaugeChartVisual](#gaugechartvisual) +* **GeospatialMapVisual**: [GeospatialMapVisual](#geospatialmapvisual) +* **HeatMapVisual**: [HeatMapVisual](#heatmapvisual) +* **HistogramVisual**: [HistogramVisual](#histogramvisual) +* **InsightVisual**: [InsightVisual](#insightvisual) +* **KPIVisual**: [KPIVisual](#kpivisual) +* **LineChartVisual**: [LineChartVisual](#linechartvisual) +* **PieChartVisual**: [PieChartVisual](#piechartvisual) +* **PivotTableVisual**: [PivotTableVisual](#pivottablevisual) +* **RadarChartVisual**: [RadarChartVisual](#radarchartvisual) +* **SankeyDiagramVisual**: [SankeyDiagramVisual](#sankeydiagramvisual) +* **ScatterPlotVisual**: [ScatterPlotVisual](#scatterplotvisual) +* **TableVisual**: [TableVisual](#tablevisual) +* **TreeMapVisual**: [TreeMapVisual](#treemapvisual) +* **WaterfallVisual**: [WaterfallVisual](#waterfallvisual) +* **WordCloudVisual**: [WordCloudVisual](#wordcloudvisual) -## WaterfallChartAggregatedFieldWells +## Visual ### Properties -* **Breakdowns**: [DimensionField](#dimensionfield)[] -* **Categories**: [DimensionField](#dimensionfield)[] -* **Values**: [MeasureField](#measurefield)[] +* **BarChartVisual**: [BarChartVisual](#barchartvisual) +* **BoxPlotVisual**: [BoxPlotVisual](#boxplotvisual) +* **ComboChartVisual**: [ComboChartVisual](#combochartvisual) +* **CustomContentVisual**: [CustomContentVisual](#customcontentvisual) +* **EmptyVisual**: [EmptyVisual](#emptyvisual) +* **FilledMapVisual**: [FilledMapVisual](#filledmapvisual) +* **FunnelChartVisual**: [FunnelChartVisual](#funnelchartvisual) +* **GaugeChartVisual**: [GaugeChartVisual](#gaugechartvisual) +* **GeospatialMapVisual**: [GeospatialMapVisual](#geospatialmapvisual) +* **HeatMapVisual**: [HeatMapVisual](#heatmapvisual) +* **HistogramVisual**: [HistogramVisual](#histogramvisual) +* **InsightVisual**: [InsightVisual](#insightvisual) +* **KPIVisual**: [KPIVisual](#kpivisual) +* **LineChartVisual**: [LineChartVisual](#linechartvisual) +* **PieChartVisual**: [PieChartVisual](#piechartvisual) +* **PivotTableVisual**: [PivotTableVisual](#pivottablevisual) +* **RadarChartVisual**: [RadarChartVisual](#radarchartvisual) +* **SankeyDiagramVisual**: [SankeyDiagramVisual](#sankeydiagramvisual) +* **ScatterPlotVisual**: [ScatterPlotVisual](#scatterplotvisual) +* **TableVisual**: [TableVisual](#tablevisual) +* **TreeMapVisual**: [TreeMapVisual](#treemapvisual) +* **WaterfallVisual**: [WaterfallVisual](#waterfallvisual) +* **WordCloudVisual**: [WordCloudVisual](#wordcloudvisual) -## WaterfallChartSortConfiguration +## VisualAxisSortOption ### Properties -* **BreakdownItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) -* **CategorySort**: [FieldSortOptions](#fieldsortoptions)[] +* **AvailabilityStatus**: string -## WaterfallChartOptions +## VisualCustomAction ### Properties -* **TotalBarLabel**: string +* **ActionOperations**: [VisualCustomActionOperation](#visualcustomactionoperation)[] (Required) +* **CustomActionId**: string (Required) +* **Name**: string (Required) +* **Status**: string +* **Trigger**: string (Required) -## WordCloudVisual +## VisualCustomAction ### Properties -* **Actions**: [VisualCustomAction](#visualcustomaction)[] -* **ChartConfiguration**: [WordCloudChartConfiguration](#wordcloudchartconfiguration) -* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] -* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) -* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) -* **VisualId**: string (Required) +* **ActionOperations**: [VisualCustomActionOperation](#visualcustomactionoperation)[] (Required) +* **CustomActionId**: string (Required) +* **Name**: string (Required) +* **Status**: string +* **Trigger**: string (Required) -## WordCloudChartConfiguration +## VisualCustomAction ### Properties -* **CategoryLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) -* **FieldWells**: [WordCloudFieldWells](#wordcloudfieldwells) -* **SortConfiguration**: [WordCloudSortConfiguration](#wordcloudsortconfiguration) -* **WordCloudOptions**: [WordCloudOptions](#wordcloudoptions) +* **ActionOperations**: [VisualCustomActionOperation](#visualcustomactionoperation)[] (Required) +* **CustomActionId**: string (Required) +* **Name**: string (Required) +* **Status**: string +* **Trigger**: string (Required) -## WordCloudFieldWells +## VisualCustomActionOperation ### Properties -* **WordCloudAggregatedFieldWells**: [WordCloudAggregatedFieldWells](#wordcloudaggregatedfieldwells) +* **FilterOperation**: [CustomActionFilterOperation](#customactionfilteroperation) +* **NavigationOperation**: [CustomActionNavigationOperation](#customactionnavigationoperation) +* **SetParametersOperation**: [CustomActionSetParametersOperation](#customactionsetparametersoperation) +* **URLOperation**: [CustomActionURLOperation](#customactionurloperation) -## WordCloudAggregatedFieldWells +## VisualCustomActionOperation ### Properties -* **GroupBy**: [DimensionField](#dimensionfield)[] -* **Size**: [MeasureField](#measurefield)[] +* **FilterOperation**: [CustomActionFilterOperation](#customactionfilteroperation) +* **NavigationOperation**: [CustomActionNavigationOperation](#customactionnavigationoperation) +* **SetParametersOperation**: [CustomActionSetParametersOperation](#customactionsetparametersoperation) +* **URLOperation**: [CustomActionURLOperation](#customactionurloperation) -## WordCloudSortConfiguration +## VisualCustomActionOperation ### Properties -* **CategoryItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) -* **CategorySort**: [FieldSortOptions](#fieldsortoptions)[] +* **FilterOperation**: [CustomActionFilterOperation](#customactionfilteroperation) +* **NavigationOperation**: [CustomActionNavigationOperation](#customactionnavigationoperation) +* **SetParametersOperation**: [CustomActionSetParametersOperation](#customactionsetparametersoperation) +* **URLOperation**: [CustomActionURLOperation](#customactionurloperation) -## WordCloudOptions +## VisualMenuOption ### Properties -* **CloudLayout**: string -* **MaximumStringLength**: int -* **WordCasing**: string -* **WordOrientation**: string -* **WordPadding**: string -* **WordScaling**: string +* **AvailabilityStatus**: string -## ResourcePermission +## VisualPalette ### Properties -* **Actions**: string[] (Required) -* **Principal**: string (Required) +* **ChartColor**: string +* **ColorMap**: [DataPathColor](#datapathcolor)[] -## TemplateSourceEntity +## VisualPalette ### Properties -* **SourceAnalysis**: [TemplateSourceAnalysis](#templatesourceanalysis) -* **SourceTemplate**: [TemplateSourceTemplate](#templatesourcetemplate) +* **ChartColor**: string +* **ColorMap**: [DataPathColor](#datapathcolor)[] -## TemplateSourceAnalysis +## VisualPalette ### Properties -* **Arn**: string (Required) -* **DataSetReferences**: [DataSetReference](#datasetreference)[] (Required) +* **ChartColor**: string +* **ColorMap**: [DataPathColor](#datapathcolor)[] -## DataSetReference +## VisualSubtitleLabelOptions ### Properties -* **DataSetArn**: string (Required) -* **DataSetPlaceholder**: string (Required) +* **FormatText**: [LongFormatText](#longformattext) +* **Visibility**: string -## TemplateSourceTemplate +## VisualSubtitleLabelOptions ### Properties -* **Arn**: string (Required) +* **FormatText**: [LongFormatText](#longformattext) +* **Visibility**: string -## Tag +## VisualSubtitleLabelOptions ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **FormatText**: [LongFormatText](#longformattext) +* **Visibility**: string -## ValidationStrategy +## VisualTitleLabelOptions ### Properties -* **Mode**: string (Required) +* **FormatText**: [ShortFormatText](#shortformattext) +* **Visibility**: string -## TemplateVersion +## VisualTitleLabelOptions ### Properties -* **CreatedTime**: string -* **DataSetConfigurations**: [DataSetConfiguration](#datasetconfiguration)[] -* **Description**: string -* **Errors**: [TemplateError](#templateerror)[] -* **Sheets**: [Sheet](#sheet)[] -* **SourceEntityArn**: string -* **Status**: string -* **ThemeArn**: string -* **VersionNumber**: int +* **FormatText**: [ShortFormatText](#shortformattext) +* **Visibility**: string -## TemplateError +## VisualTitleLabelOptions ### Properties -* **Message**: string -* **Type**: string -* **ViolatedEntities**: [Entity](#entity)[] +* **FormatText**: [ShortFormatText](#shortformattext) +* **Visibility**: string -## Entity +## VpcConnectionProperties ### Properties -* **Path**: string +* **VpcConnectionArn**: string (Required):

The Amazon Resource Name (ARN) for the VPC connection.

-## Sheet +## WaterfallChartAggregatedFieldWells ### Properties -* **Name**: string -* **SheetId**: string +* **Breakdowns**: [DimensionField](#dimensionfield)[] +* **Categories**: [DimensionField](#dimensionfield)[] +* **Values**: [MeasureField](#measurefield)[] -## AWS.QuickSight/ThemeProperties +## WaterfallChartAggregatedFieldWells ### Properties -* **Arn**: string (ReadOnly) -* **AwsAccountId**: string (Required, Identifier) -* **BaseThemeId**: string (Required, WriteOnly) -* **Configuration**: [ThemeConfiguration](#themeconfiguration) (Required, WriteOnly) -* **CreatedTime**: string (ReadOnly) -* **LastUpdatedTime**: string (ReadOnly) -* **Name**: string (Required) -* **Permissions**: [ResourcePermission](#resourcepermission)[] -* **Tags**: [Tag](#tag)[] -* **ThemeId**: string (Required, Identifier) -* **Type**: string (ReadOnly) -* **Version**: [ThemeVersion](#themeversion) (ReadOnly) -* **VersionDescription**: string (WriteOnly) +* **Breakdowns**: [DimensionField](#dimensionfield)[] +* **Categories**: [DimensionField](#dimensionfield)[] +* **Values**: [MeasureField](#measurefield)[] -## ThemeConfiguration +## WaterfallChartAggregatedFieldWells ### Properties -* **DataColorPalette**: [DataColorPalette](#datacolorpalette) -* **Sheet**: [SheetStyle](#sheetstyle) -* **Typography**: [Typography](#typography) -* **UIColorPalette**: [UIColorPalette](#uicolorpalette) +* **Breakdowns**: [DimensionField](#dimensionfield)[] +* **Categories**: [DimensionField](#dimensionfield)[] +* **Values**: [MeasureField](#measurefield)[] -## DataColorPalette +## WaterfallChartColorConfiguration ### Properties -* **Colors**: string[] -* **EmptyFillColor**: string -* **MinMaxGradient**: string[] +* **GroupColorConfiguration**: [WaterfallChartGroupColorConfiguration](#waterfallchartgroupcolorconfiguration) -## SheetStyle +## WaterfallChartColorConfiguration ### Properties -* **Tile**: [TileStyle](#tilestyle) -* **TileLayout**: [TileLayoutStyle](#tilelayoutstyle) +* **GroupColorConfiguration**: [WaterfallChartGroupColorConfiguration](#waterfallchartgroupcolorconfiguration) -## TileStyle +## WaterfallChartColorConfiguration ### Properties -* **Border**: [BorderStyle](#borderstyle) +* **GroupColorConfiguration**: [WaterfallChartGroupColorConfiguration](#waterfallchartgroupcolorconfiguration) -## BorderStyle +## WaterfallChartConfiguration ### Properties -* **Show**: bool +* **CategoryAxisDisplayOptions**: [AxisDisplayOptions](#axisdisplayoptions) +* **CategoryAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **ColorConfiguration**: [WaterfallChartColorConfiguration](#waterfallchartcolorconfiguration) +* **DataLabels**: [DataLabelOptions](#datalabeloptions) +* **FieldWells**: [WaterfallChartFieldWells](#waterfallchartfieldwells) +* **Legend**: [LegendOptions](#legendoptions) +* **PrimaryYAxisDisplayOptions**: [AxisDisplayOptions](#axisdisplayoptions) +* **PrimaryYAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **SortConfiguration**: [WaterfallChartSortConfiguration](#waterfallchartsortconfiguration) +* **VisualPalette**: [VisualPalette](#visualpalette) +* **WaterfallChartOptions**: [WaterfallChartOptions](#waterfallchartoptions) -## TileLayoutStyle +## WaterfallChartConfiguration ### Properties -* **Gutter**: [GutterStyle](#gutterstyle) -* **Margin**: [MarginStyle](#marginstyle) +* **CategoryAxisDisplayOptions**: [AxisDisplayOptions](#axisdisplayoptions) +* **CategoryAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **ColorConfiguration**: [WaterfallChartColorConfiguration](#waterfallchartcolorconfiguration) +* **DataLabels**: [DataLabelOptions](#datalabeloptions) +* **FieldWells**: [WaterfallChartFieldWells](#waterfallchartfieldwells) +* **Legend**: [LegendOptions](#legendoptions) +* **PrimaryYAxisDisplayOptions**: [AxisDisplayOptions](#axisdisplayoptions) +* **PrimaryYAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **SortConfiguration**: [WaterfallChartSortConfiguration](#waterfallchartsortconfiguration) +* **VisualPalette**: [VisualPalette](#visualpalette) +* **WaterfallChartOptions**: [WaterfallChartOptions](#waterfallchartoptions) -## GutterStyle +## WaterfallChartConfiguration ### Properties -* **Show**: bool +* **CategoryAxisDisplayOptions**: [AxisDisplayOptions](#axisdisplayoptions) +* **CategoryAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **ColorConfiguration**: [WaterfallChartColorConfiguration](#waterfallchartcolorconfiguration) +* **DataLabels**: [DataLabelOptions](#datalabeloptions) +* **FieldWells**: [WaterfallChartFieldWells](#waterfallchartfieldwells) +* **Legend**: [LegendOptions](#legendoptions) +* **PrimaryYAxisDisplayOptions**: [AxisDisplayOptions](#axisdisplayoptions) +* **PrimaryYAxisLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **SortConfiguration**: [WaterfallChartSortConfiguration](#waterfallchartsortconfiguration) +* **VisualPalette**: [VisualPalette](#visualpalette) +* **WaterfallChartOptions**: [WaterfallChartOptions](#waterfallchartoptions) -## MarginStyle +## WaterfallChartFieldWells ### Properties -* **Show**: bool +* **WaterfallChartAggregatedFieldWells**: [WaterfallChartAggregatedFieldWells](#waterfallchartaggregatedfieldwells) -## Typography +## WaterfallChartFieldWells ### Properties -* **FontFamilies**: [Font](#font)[] +* **WaterfallChartAggregatedFieldWells**: [WaterfallChartAggregatedFieldWells](#waterfallchartaggregatedfieldwells) -## Font +## WaterfallChartFieldWells ### Properties -* **FontFamily**: string +* **WaterfallChartAggregatedFieldWells**: [WaterfallChartAggregatedFieldWells](#waterfallchartaggregatedfieldwells) -## UIColorPalette +## WaterfallChartGroupColorConfiguration ### Properties -* **Accent**: string -* **AccentForeground**: string -* **Danger**: string -* **DangerForeground**: string -* **Dimension**: string -* **DimensionForeground**: string -* **Measure**: string -* **MeasureForeground**: string -* **PrimaryBackground**: string -* **PrimaryForeground**: string -* **SecondaryBackground**: string -* **SecondaryForeground**: string -* **Success**: string -* **SuccessForeground**: string -* **Warning**: string -* **WarningForeground**: string +* **NegativeBarColor**: string +* **PositiveBarColor**: string +* **TotalBarColor**: string -## ResourcePermission +## WaterfallChartGroupColorConfiguration ### Properties -* **Actions**: string[] (Required) -* **Principal**: string (Required) +* **NegativeBarColor**: string +* **PositiveBarColor**: string +* **TotalBarColor**: string -## Tag +## WaterfallChartGroupColorConfiguration ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **NegativeBarColor**: string +* **PositiveBarColor**: string +* **TotalBarColor**: string -## ThemeVersion +## WaterfallChartOptions ### Properties -* **Arn**: string -* **BaseThemeId**: string -* **Configuration**: [ThemeConfiguration](#themeconfiguration) -* **CreatedTime**: string -* **Description**: string -* **Errors**: [ThemeError](#themeerror)[] -* **Status**: string -* **VersionNumber**: int +* **TotalBarLabel**: string -## ThemeError +## WaterfallChartOptions ### Properties -* **Message**: string -* **Type**: string +* **TotalBarLabel**: string -## AWS.QuickSight/TopicProperties +## WaterfallChartOptions ### Properties -* **Arn**: string (ReadOnly) -* **AwsAccountId**: string (Identifier) -* **DataSets**: [DatasetMetadata](#datasetmetadata)[] -* **Description**: string -* **Name**: string -* **TopicId**: string (Identifier) +* **TotalBarLabel**: string -## DatasetMetadata +## WaterfallChartSortConfiguration ### Properties -* **CalculatedFields**: [TopicCalculatedField](#topiccalculatedfield)[] -* **Columns**: [TopicColumn](#topiccolumn)[] -* **DataAggregation**: [DataAggregation](#dataaggregation) -* **DatasetArn**: string (Required) -* **DatasetDescription**: string -* **DatasetName**: string -* **Filters**: [TopicFilter](#topicfilter)[] -* **NamedEntities**: [TopicNamedEntity](#topicnamedentity)[] +* **BreakdownItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) +* **CategorySort**: [FieldSortOptions](#fieldsortoptions)[] -## TopicCalculatedField +## WaterfallChartSortConfiguration ### Properties -* **Aggregation**: string -* **AllowedAggregations**: string[] -* **CalculatedFieldDescription**: string -* **CalculatedFieldName**: string (Required) -* **CalculatedFieldSynonyms**: string[] -* **CellValueSynonyms**: [CellValueSynonym](#cellvaluesynonym)[] -* **ColumnDataRole**: string -* **ComparativeOrder**: [ComparativeOrder](#comparativeorder) -* **DefaultFormatting**: [DefaultFormatting](#defaultformatting) -* **Expression**: string (Required) -* **IsIncludedInTopic**: bool -* **NeverAggregateInFilter**: bool -* **NonAdditive**: bool -* **NotAllowedAggregations**: string[] -* **SemanticType**: [SemanticType](#semantictype) -* **TimeGranularity**: string +* **BreakdownItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) +* **CategorySort**: [FieldSortOptions](#fieldsortoptions)[] -## CellValueSynonym +## WaterfallChartSortConfiguration ### Properties -* **CellValue**: string -* **Synonyms**: string[] +* **BreakdownItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) +* **CategorySort**: [FieldSortOptions](#fieldsortoptions)[] -## ComparativeOrder +## WaterfallVisual ### Properties -* **SpecifedOrder**: string[] -* **TreatUndefinedSpecifiedValues**: string -* **UseOrdering**: string +* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **ChartConfiguration**: [WaterfallChartConfiguration](#waterfallchartconfiguration) +* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] +* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) +* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) +* **VisualId**: string (Required) -## DefaultFormatting +## WaterfallVisual ### Properties -* **DisplayFormat**: string -* **DisplayFormatOptions**: [DisplayFormatOptions](#displayformatoptions) +* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **ChartConfiguration**: [WaterfallChartConfiguration](#waterfallchartconfiguration) +* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] +* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) +* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) +* **VisualId**: string (Required) -## DisplayFormatOptions +## WaterfallVisual ### Properties -* **BlankCellFormat**: string -* **CurrencySymbol**: string -* **DateFormat**: string -* **DecimalSeparator**: string -* **FractionDigits**: int -* **GroupingSeparator**: string -* **NegativeFormat**: [NegativeFormat](#negativeformat) -* **Prefix**: string -* **Suffix**: string -* **UnitScaler**: string -* **UseBlankCellFormat**: bool -* **UseGrouping**: bool +* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **ChartConfiguration**: [WaterfallChartConfiguration](#waterfallchartconfiguration) +* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] +* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) +* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) +* **VisualId**: string (Required) -## NegativeFormat +## WhatIfPointScenario ### Properties -* **Prefix**: string -* **Suffix**: string +* **Date**: string (Required) +* **Value**: int (Required) -## SemanticType +## WhatIfPointScenario ### Properties -* **FalseyCellValue**: string -* **FalseyCellValueSynonyms**: string[] -* **SubTypeName**: string -* **TruthyCellValue**: string -* **TruthyCellValueSynonyms**: string[] -* **TypeName**: string -* **TypeParameters**: [TypeParameters](#typeparameters) +* **Date**: string (Required) +* **Value**: int (Required) -## TypeParameters +## WhatIfPointScenario ### Properties +* **Date**: string (Required) +* **Value**: int (Required) -## TopicColumn +## WhatIfRangeScenario ### Properties -* **Aggregation**: string -* **AllowedAggregations**: string[] -* **CellValueSynonyms**: [CellValueSynonym](#cellvaluesynonym)[] -* **ColumnDataRole**: string -* **ColumnDescription**: string -* **ColumnFriendlyName**: string -* **ColumnName**: string (Required) -* **ColumnSynonyms**: string[] -* **ComparativeOrder**: [ComparativeOrder](#comparativeorder) -* **DefaultFormatting**: [DefaultFormatting](#defaultformatting) -* **IsIncludedInTopic**: bool -* **NeverAggregateInFilter**: bool -* **NonAdditive**: bool -* **NotAllowedAggregations**: string[] -* **SemanticType**: [SemanticType](#semantictype) -* **TimeGranularity**: string +* **EndDate**: string (Required) +* **StartDate**: string (Required) +* **Value**: int (Required) -## DataAggregation +## WhatIfRangeScenario ### Properties -* **DatasetRowDateGranularity**: string -* **DefaultDateColumnName**: string +* **EndDate**: string (Required) +* **StartDate**: string (Required) +* **Value**: int (Required) -## TopicFilter +## WhatIfRangeScenario ### Properties -* **CategoryFilter**: [TopicCategoryFilter](#topiccategoryfilter) -* **DateRangeFilter**: [TopicDateRangeFilter](#topicdaterangefilter) -* **FilterClass**: string -* **FilterDescription**: string -* **FilterName**: string (Required) -* **FilterSynonyms**: string[] -* **FilterType**: string -* **NumericEqualityFilter**: [TopicNumericEqualityFilter](#topicnumericequalityfilter) -* **NumericRangeFilter**: [TopicNumericRangeFilter](#topicnumericrangefilter) -* **OperandFieldName**: string (Required) -* **RelativeDateFilter**: [TopicRelativeDateFilter](#topicrelativedatefilter) +* **EndDate**: string (Required) +* **StartDate**: string (Required) +* **Value**: int (Required) -## TopicCategoryFilter +## WordCloudAggregatedFieldWells ### Properties -* **CategoryFilterFunction**: string -* **CategoryFilterType**: string -* **Constant**: [TopicCategoryFilterConstant](#topiccategoryfilterconstant) -* **Inverse**: bool +* **GroupBy**: [DimensionField](#dimensionfield)[] +* **Size**: [MeasureField](#measurefield)[] -## TopicCategoryFilterConstant +## WordCloudAggregatedFieldWells ### Properties -* **CollectiveConstant**: [CollectiveConstant](#collectiveconstant) -* **ConstantType**: string -* **SingularConstant**: string +* **GroupBy**: [DimensionField](#dimensionfield)[] +* **Size**: [MeasureField](#measurefield)[] -## CollectiveConstant +## WordCloudAggregatedFieldWells ### Properties -* **ValueList**: string[] +* **GroupBy**: [DimensionField](#dimensionfield)[] +* **Size**: [MeasureField](#measurefield)[] -## TopicDateRangeFilter +## WordCloudChartConfiguration ### Properties -* **Constant**: [TopicRangeFilterConstant](#topicrangefilterconstant) -* **Inclusive**: bool +* **CategoryLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **FieldWells**: [WordCloudFieldWells](#wordcloudfieldwells) +* **SortConfiguration**: [WordCloudSortConfiguration](#wordcloudsortconfiguration) +* **WordCloudOptions**: [WordCloudOptions](#wordcloudoptions) -## TopicRangeFilterConstant +## WordCloudChartConfiguration ### Properties -* **ConstantType**: string -* **RangeConstant**: [RangeConstant](#rangeconstant) +* **CategoryLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **FieldWells**: [WordCloudFieldWells](#wordcloudfieldwells) +* **SortConfiguration**: [WordCloudSortConfiguration](#wordcloudsortconfiguration) +* **WordCloudOptions**: [WordCloudOptions](#wordcloudoptions) -## RangeConstant +## WordCloudChartConfiguration ### Properties -* **Maximum**: string -* **Minimum**: string +* **CategoryLabelOptions**: [ChartAxisLabelOptions](#chartaxislabeloptions) +* **FieldWells**: [WordCloudFieldWells](#wordcloudfieldwells) +* **SortConfiguration**: [WordCloudSortConfiguration](#wordcloudsortconfiguration) +* **WordCloudOptions**: [WordCloudOptions](#wordcloudoptions) -## TopicNumericEqualityFilter +## WordCloudFieldWells ### Properties -* **Aggregation**: string -* **Constant**: [TopicSingularFilterConstant](#topicsingularfilterconstant) +* **WordCloudAggregatedFieldWells**: [WordCloudAggregatedFieldWells](#wordcloudaggregatedfieldwells) -## TopicSingularFilterConstant +## WordCloudFieldWells ### Properties -* **ConstantType**: string -* **SingularConstant**: string +* **WordCloudAggregatedFieldWells**: [WordCloudAggregatedFieldWells](#wordcloudaggregatedfieldwells) -## TopicNumericRangeFilter +## WordCloudFieldWells ### Properties -* **Aggregation**: string -* **Constant**: [TopicRangeFilterConstant](#topicrangefilterconstant) -* **Inclusive**: bool +* **WordCloudAggregatedFieldWells**: [WordCloudAggregatedFieldWells](#wordcloudaggregatedfieldwells) -## TopicRelativeDateFilter +## WordCloudOptions ### Properties -* **Constant**: [TopicSingularFilterConstant](#topicsingularfilterconstant) -* **RelativeDateFilterFunction**: string -* **TimeGranularity**: string +* **CloudLayout**: string +* **MaximumStringLength**: int +* **WordCasing**: string +* **WordOrientation**: string +* **WordPadding**: string +* **WordScaling**: string -## TopicNamedEntity +## WordCloudOptions ### Properties -* **Definition**: [NamedEntityDefinition](#namedentitydefinition)[] -* **EntityDescription**: string -* **EntityName**: string (Required) -* **EntitySynonyms**: string[] -* **SemanticEntityType**: [SemanticEntityType](#semanticentitytype) +* **CloudLayout**: string +* **MaximumStringLength**: int +* **WordCasing**: string +* **WordOrientation**: string +* **WordPadding**: string +* **WordScaling**: string -## NamedEntityDefinition +## WordCloudOptions ### Properties -* **FieldName**: string -* **Metric**: [NamedEntityDefinitionMetric](#namedentitydefinitionmetric) -* **PropertyName**: string -* **PropertyRole**: string -* **PropertyUsage**: string +* **CloudLayout**: string +* **MaximumStringLength**: int +* **WordCasing**: string +* **WordOrientation**: string +* **WordPadding**: string +* **WordScaling**: string -## NamedEntityDefinitionMetric +## WordCloudSortConfiguration ### Properties -* **Aggregation**: string -* **AggregationFunctionParameters**: [AggregationFunctionParameters](#aggregationfunctionparameters) +* **CategoryItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) +* **CategorySort**: [FieldSortOptions](#fieldsortoptions)[] -## AggregationFunctionParameters +## WordCloudSortConfiguration ### Properties +* **CategoryItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) +* **CategorySort**: [FieldSortOptions](#fieldsortoptions)[] -## SemanticEntityType +## WordCloudSortConfiguration ### Properties -* **SubTypeName**: string -* **TypeName**: string -* **TypeParameters**: [TypeParameters](#typeparameters) +* **CategoryItemsLimit**: [ItemsLimitConfiguration](#itemslimitconfiguration) +* **CategorySort**: [FieldSortOptions](#fieldsortoptions)[] -## AWS.QuickSight/VPCConnectionProperties +## WordCloudVisual ### Properties -* **Arn**: string (ReadOnly) -* **AvailabilityStatus**: string -* **AwsAccountId**: string (Identifier) -* **CreatedTime**: string (ReadOnly) -* **DnsResolvers**: string[] -* **LastUpdatedTime**: string (ReadOnly) -* **Name**: string -* **NetworkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly) -* **RoleArn**: string -* **SecurityGroupIds**: string[] -* **Status**: string (ReadOnly) -* **SubnetIds**: string[] (WriteOnly) -* **Tags**: [Tag](#tag)[] -* **VPCConnectionId**: string (Identifier) -* **VPCId**: string (ReadOnly) +* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **ChartConfiguration**: [WordCloudChartConfiguration](#wordcloudchartconfiguration) +* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] +* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) +* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) +* **VisualId**: string (Required) -## NetworkInterface +## WordCloudVisual ### Properties -* **AvailabilityZone**: string -* **ErrorMessage**: string -* **NetworkInterfaceId**: string -* **Status**: string -* **SubnetId**: string +* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **ChartConfiguration**: [WordCloudChartConfiguration](#wordcloudchartconfiguration) +* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] +* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) +* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) +* **VisualId**: string (Required) -## Tag +## WordCloudVisual ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **Actions**: [VisualCustomAction](#visualcustomaction)[] +* **ChartConfiguration**: [WordCloudChartConfiguration](#wordcloudchartconfiguration) +* **ColumnHierarchies**: [ColumnHierarchy](#columnhierarchy)[] +* **Subtitle**: [VisualSubtitleLabelOptions](#visualsubtitlelabeloptions) +* **Title**: [VisualTitleLabelOptions](#visualtitlelabeloptions) +* **VisualId**: string (Required) diff --git a/artifacts/bicep/aws/aws.ram/default/types.json b/artifacts/bicep/aws/aws.ram/default/types.json index b4b4b30f..780ebd58 100644 --- a/artifacts/bicep/aws/aws.ram/default/types.json +++ b/artifacts/bicep/aws/aws.ram/default/types.json @@ -1 +1,138 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.RAM/PermissionProperties","Properties":{"Arn":{"Type":4,"Flags":18},"IsResourceTypeDefault":{"Type":2,"Flags":2,"Description":"Set to true to use this as the default permission."},"Name":{"Type":4,"Flags":1,"Description":"The name of the permission."},"PermissionType":{"Type":4,"Flags":2},"PolicyTemplate":{"Type":10,"Flags":1,"Description":"Policy template for the permission."},"ResourceType":{"Type":4,"Flags":1,"Description":"The resource type this permission can be used with."},"Tags":{"Type":11,"Flags":0},"Version":{"Type":4,"Flags":2,"Description":"Version of the permission."}}}},{"2":{"Name":"Permission_PolicyTemplate","Properties":{}}},{"3":{"ItemType":8}},{"2":{"Name":"AWS.RAM/Permission","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":9,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.RAM/Permission@default","ScopeType":0,"Body":12}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.RAM/PermissionProperties" + }, + { + "$type": "BooleanType" + }, + { + "$type": "ObjectType", + "name": "Permission_PolicyTemplate", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ObjectType", + "name": "AWS.RAM/PermissionProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 18 + }, + "IsResourceTypeDefault": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "Set to true to use this as the default permission." + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The name of the permission." + }, + "PermissionType": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "PolicyTemplate": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "Policy template for the permission." + }, + "ResourceType": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The resource type this permission can be used with." + }, + "Tags": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Version": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "Version of the permission." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.RAM/Permission", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/6" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.RAM/Permission@default", + "scopeType": 0, + "body": { + "$ref": "#/7" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.ram/default/types.md b/artifacts/bicep/aws/aws.ram/default/types.md index 8301c83c..1d672a57 100644 --- a/artifacts/bicep/aws/aws.ram/default/types.md +++ b/artifacts/bicep/aws/aws.ram/default/types.md @@ -3,9 +3,9 @@ ## Resource AWS.RAM/Permission@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.RAM/PermissionProperties](#awsrampermissionproperties) (Required): properties of the resource +* **properties**: [AWS.RAM/PermissionProperties](#awsrampermissionproperties) (Required, Identifier): properties of the resource ## AWS.RAM/PermissionProperties ### Properties diff --git a/artifacts/bicep/aws/aws.rds/default/types.json b/artifacts/bicep/aws/aws.rds/default/types.json index 20dc5b9a..4cbd910d 100644 --- a/artifacts/bicep/aws/aws.rds/default/types.json +++ b/artifacts/bicep/aws/aws.rds/default/types.json @@ -1 +1,3053 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":0,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.RDS/CustomDBEngineVersionProperties","Properties":{"DBEngineVersionArn":{"Type":4,"Flags":2,"Description":"The ARN of the custom engine version."},"DatabaseInstallationFilesS3BucketName":{"Type":4,"Flags":1,"Description":"The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is `my-custom-installation-files`."},"DatabaseInstallationFilesS3Prefix":{"Type":4,"Flags":0,"Description":"The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is `123456789012/cev1`. If this setting isn't specified, no prefix is assumed."},"Description":{"Type":4,"Flags":0,"Description":"An optional description of your CEV."},"Engine":{"Type":4,"Flags":17,"Description":"The database engine to use for your custom engine version (CEV). The only supported value is `custom-oracle-ee`."},"EngineVersion":{"Type":4,"Flags":17,"Description":"The name of your CEV. The name format is 19.customized_string . For example, a valid name is 19.my_cev1. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Region."},"KMSKeyId":{"Type":4,"Flags":0,"Description":"The AWS KMS key identifier for an encrypted CEV. A symmetric KMS key is required for RDS Custom, but optional for Amazon RDS."},"Manifest":{"Type":4,"Flags":4,"Description":"The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed."},"Status":{"Type":4,"Flags":0,"Description":"The availability status to be assigned to the CEV."},"Tags":{"Type":10,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."}}}},{"3":{"ItemType":8}},{"2":{"Name":"AWS.RDS/CustomDBEngineVersion","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":9,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.RDS/CustomDBEngineVersion@default","ScopeType":0,"Body":11}},{"2":{"Name":"DBClusterRole","Properties":{"FeatureName":{"Type":4,"Flags":0,"Description":"The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion in the Amazon RDS API Reference."},"RoleArn":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster."}}}},{"2":{"Name":"Endpoint","Properties":{"Address":{"Type":4,"Flags":2,"Description":"The connection endpoint for the DB cluster."},"Port":{"Type":4,"Flags":2,"Description":"The port number that will accept connections on this DB cluster."}}}},{"2":{"Name":"MasterUserSecret","Properties":{"KmsKeyId":{"Type":4,"Flags":0,"Description":"The AWS KMS key identifier that is used to encrypt the secret."},"SecretArn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) of the secret."}}}},{"2":{"Name":"ReadEndpoint","Properties":{"Address":{"Type":4,"Flags":2,"Description":"The reader endpoint for the DB cluster."}}}},{"2":{"Name":"ScalingConfiguration","Properties":{"AutoPause":{"Type":2,"Flags":0,"Description":"A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections)."},"MaxCapacity":{"Type":3,"Flags":0,"Description":"The maximum capacity for an Aurora DB cluster in serverless DB engine mode.\nFor Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.\nFor Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.\nThe maximum capacity must be greater than or equal to the minimum capacity."},"MinCapacity":{"Type":3,"Flags":0,"Description":"The minimum capacity for an Aurora DB cluster in serverless DB engine mode.\nFor Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.\nFor Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.\nThe minimum capacity must be less than or equal to the maximum capacity."},"SecondsBeforeTimeout":{"Type":3,"Flags":0,"Description":"The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action.\nThe default is 300."},"SecondsUntilAutoPause":{"Type":3,"Flags":0,"Description":"The time, in seconds, before an Aurora DB cluster in serverless mode is paused."},"TimeoutAction":{"Type":4,"Flags":0,"Description":"The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.\nForceApplyCapacityChange sets the capacity to the specified value as soon as possible.\nRollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period.\n\nFor more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide."}}}},{"2":{"Name":"ServerlessV2ScalingConfiguration","Properties":{"MaxCapacity":{"Type":3,"Flags":0,"Description":"The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128."},"MinCapacity":{"Type":3,"Flags":0,"Description":"The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"Value":{"Type":4,"Flags":0,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}}}},{"2":{"Name":"AWS.RDS/DBClusterProperties","Properties":{"AllocatedStorage":{"Type":3,"Flags":0,"Description":"The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster."},"AssociatedRoles":{"Type":21,"Flags":0,"Description":"Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf."},"AutoMinorVersionUpgrade":{"Type":2,"Flags":0,"Description":"A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically."},"AvailabilityZones":{"Type":22,"Flags":0,"Description":"A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide."},"BacktrackWindow":{"Type":3,"Flags":0,"Description":"The target backtrack window, in seconds. To disable backtracking, set this value to 0."},"BackupRetentionPeriod":{"Type":3,"Flags":0,"Description":"The number of days for which automated backups are retained."},"CopyTagsToSnapshot":{"Type":2,"Flags":0,"Description":"A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them."},"DBClusterArn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) for the DB cluster."},"DBClusterIdentifier":{"Type":4,"Flags":16,"Description":"The DB cluster identifier. This parameter is stored as a lowercase string."},"DBClusterInstanceClass":{"Type":4,"Flags":0,"Description":"The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge."},"DBClusterParameterGroupName":{"Type":4,"Flags":0,"Description":"The name of the DB cluster parameter group to associate with this DB cluster."},"DBClusterResourceId":{"Type":4,"Flags":2,"Description":"The AWS Region-unique, immutable identifier for the DB cluster."},"DBInstanceParameterGroupName":{"Type":4,"Flags":4,"Description":"The name of the DB parameter group to apply to all instances of the DB cluster."},"DBSubnetGroupName":{"Type":4,"Flags":0,"Description":"A DB subnet group that you want to associate with this DB cluster."},"DBSystemId":{"Type":4,"Flags":0,"Description":"Reserved for future use."},"DatabaseName":{"Type":4,"Flags":0,"Description":"The name of your database. If you don't provide a name, then Amazon RDS won't create a database in this DB cluster. For naming constraints, see Naming Constraints in the Amazon RDS User Guide."},"DeletionProtection":{"Type":2,"Flags":0,"Description":"A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled."},"Domain":{"Type":4,"Flags":0,"Description":"The Active Directory directory ID to create the DB cluster in."},"DomainIAMRoleName":{"Type":4,"Flags":0,"Description":"Specify the name of the IAM role to be used when making API calls to the Directory Service."},"EnableCloudwatchLogsExports":{"Type":23,"Flags":0,"Description":"The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide."},"EnableGlobalWriteForwarding":{"Type":2,"Flags":0,"Description":"Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database."},"EnableHttpEndpoint":{"Type":2,"Flags":0,"Description":"A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled."},"EnableIAMDatabaseAuthentication":{"Type":2,"Flags":0,"Description":"A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled."},"Endpoint":{"Type":14,"Flags":2},"Engine":{"Type":4,"Flags":0,"Description":"The name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql"},"EngineMode":{"Type":4,"Flags":0,"Description":"The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster."},"EngineVersion":{"Type":4,"Flags":0,"Description":"The version number of the database engine to use."},"GlobalClusterIdentifier":{"Type":4,"Flags":0,"Description":"If you are configuring an Aurora global database cluster and want your Aurora DB cluster to be a secondary member in the global database cluster, specify the global cluster ID of the global database cluster. To define the primary database cluster of the global cluster, use the AWS::RDS::GlobalCluster resource.\n\nIf you aren't configuring a global database cluster, don't specify this property."},"Iops":{"Type":3,"Flags":0,"Description":"The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster."},"KmsKeyId":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) of the AWS Key Management Service master key that is used to encrypt the database instances in the DB cluster, such as arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. If you enable the StorageEncrypted property but don't specify this property, the default master key is used. If you specify this property, you must set the StorageEncrypted property to true."},"ManageMasterUserPassword":{"Type":2,"Flags":0,"Description":"A value that indicates whether to manage the master user password with AWS Secrets Manager."},"MasterUserPassword":{"Type":4,"Flags":4,"Description":"The master password for the DB instance."},"MasterUserSecret":{"Type":15,"Flags":0,"Description":"Contains the secret managed by RDS in AWS Secrets Manager for the master user password."},"MasterUsername":{"Type":4,"Flags":0,"Description":"The name of the master user for the DB cluster. You must specify MasterUsername, unless you specify SnapshotIdentifier. In that case, don't specify MasterUsername."},"MonitoringInterval":{"Type":3,"Flags":0,"Description":"The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0."},"MonitoringRoleArn":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs."},"NetworkType":{"Type":4,"Flags":0,"Description":"The network type of the DB cluster."},"PerformanceInsightsEnabled":{"Type":2,"Flags":0,"Description":"A value that indicates whether to turn on Performance Insights for the DB cluster."},"PerformanceInsightsKmsKeyId":{"Type":4,"Flags":0,"Description":"The Amazon Web Services KMS key identifier for encryption of Performance Insights data."},"PerformanceInsightsRetentionPeriod":{"Type":3,"Flags":0,"Description":"The amount of time, in days, to retain Performance Insights data."},"Port":{"Type":3,"Flags":0,"Description":"The port number on which the instances in the DB cluster accept connections. Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql."},"PreferredBackupWindow":{"Type":4,"Flags":0,"Description":"The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide."},"PreferredMaintenanceWindow":{"Type":4,"Flags":0,"Description":"The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide."},"PubliclyAccessible":{"Type":2,"Flags":0,"Description":"A value that indicates whether the DB cluster is publicly accessible."},"ReadEndpoint":{"Type":16,"Flags":0},"ReplicationSourceIdentifier":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica."},"RestoreToTime":{"Type":4,"Flags":4,"Description":"The date and time to restore the DB cluster to. Value must be a time in Universal Coordinated Time (UTC) format. An example: 2015-03-07T23:45:00Z"},"RestoreType":{"Type":4,"Flags":4,"Description":"The type of restore to be performed. You can specify one of the following values:\nfull-copy - The new DB cluster is restored as a full copy of the source DB cluster.\ncopy-on-write - The new DB cluster is restored as a clone of the source DB cluster."},"ScalingConfiguration":{"Type":17,"Flags":0,"Description":"The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster."},"ServerlessV2ScalingConfiguration":{"Type":18,"Flags":0,"Description":"Contains the scaling configuration of an Aurora Serverless v2 DB cluster."},"SnapshotIdentifier":{"Type":4,"Flags":4,"Description":"The identifier for the DB snapshot or DB cluster snapshot to restore from.\nYou can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.\nAfter you restore a DB cluster with a SnapshotIdentifier property, you must specify the same SnapshotIdentifier property for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed. However, if you don't specify the SnapshotIdentifier property, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the specified SnapshotIdentifier property, and the original DB cluster is deleted."},"SourceDBClusterIdentifier":{"Type":4,"Flags":4,"Description":"The identifier of the source DB cluster from which to restore."},"SourceRegion":{"Type":4,"Flags":4,"Description":"The AWS Region which contains the source DB cluster when replicating a DB cluster. For example, us-east-1."},"StorageEncrypted":{"Type":2,"Flags":0,"Description":"Indicates whether the DB instance is encrypted.\nIf you specify the DBClusterIdentifier, SnapshotIdentifier, or SourceDBInstanceIdentifier property, don't specify this property. The value is inherited from the cluster, snapshot, or source DB instance."},"StorageType":{"Type":4,"Flags":0,"Description":"Specifies the storage type to be associated with the DB cluster."},"Tags":{"Type":24,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."},"UseLatestRestorableTime":{"Type":2,"Flags":4,"Description":"A value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster is not restored to the latest restorable backup time."},"VpcSecurityGroupIds":{"Type":25,"Flags":0,"Description":"A list of EC2 VPC security groups to associate with this DB cluster."}}}},{"3":{"ItemType":13}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":19}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.RDS/DBCluster","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":20,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.RDS/DBCluster@default","ScopeType":0,"Body":26}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":0,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.RDS/DBClusterParameterGroupProperties","Properties":{"DBClusterParameterGroupName":{"Type":4,"Flags":16},"Description":{"Type":4,"Flags":1,"Description":"A friendly description for this DB cluster parameter group."},"Family":{"Type":4,"Flags":1,"Description":"The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a DB engine and engine version compatible with that DB cluster parameter group family."},"Parameters":{"Type":30,"Flags":1,"Description":"An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request."},"Tags":{"Type":31,"Flags":0,"Description":"The list of tags for the cluster parameter group."}}}},{"2":{"Name":"DBClusterParameterGroup_Parameters","Properties":{}}},{"3":{"ItemType":28}},{"2":{"Name":"AWS.RDS/DBClusterParameterGroup","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":29,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.RDS/DBClusterParameterGroup@default","ScopeType":0,"Body":32}},{"2":{"Name":"CertificateDetails","Properties":{"CAIdentifier":{"Type":4,"Flags":2,"Description":"The CA identifier of the CA certificate used for the DB instance's server certificate."},"ValidTill":{"Type":4,"Flags":2,"Description":"The expiration date of the DB instance’s server certificate."}}}},{"2":{"Name":"DBInstanceRole","Properties":{"FeatureName":{"Type":4,"Flags":1,"Description":"The name of the feature associated with the AWS Identity and Access Management (IAM) role. IAM roles that are associated with a DB instance grant permission for the DB instance to access other AWS services on your behalf."},"RoleArn":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance."}}}},{"2":{"Name":"Endpoint","Properties":{"Address":{"Type":4,"Flags":2,"Description":"Specifies the DNS address of the DB instance."},"HostedZoneId":{"Type":4,"Flags":2,"Description":"Specifies the ID that Amazon Route 53 assigns when you create a hosted zone."},"Port":{"Type":4,"Flags":2,"Description":"Specifies the port that the database engine is listening on."}}}},{"2":{"Name":"MasterUserSecret","Properties":{"KmsKeyId":{"Type":4,"Flags":0,"Description":"The AWS KMS key identifier that is used to encrypt the secret."},"SecretArn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) of the secret."}}}},{"2":{"Name":"ProcessorFeature","Properties":{"Name":{"Type":4,"Flags":0,"Description":"The name of the processor feature. Valid names are coreCount and threadsPerCore."},"Value":{"Type":4,"Flags":0,"Description":"The value of a processor feature name."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"Value":{"Type":4,"Flags":0,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}}}},{"2":{"Name":"AWS.RDS/DBInstanceProperties","Properties":{"AllocatedStorage":{"Type":4,"Flags":0,"Description":"The amount of storage (in gigabytes) to be initially allocated for the database instance."},"AllowMajorVersionUpgrade":{"Type":2,"Flags":4,"Description":"A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible."},"AssociatedRoles":{"Type":41,"Flags":0,"Description":"The AWS Identity and Access Management (IAM) roles associated with the DB instance."},"AutoMinorVersionUpgrade":{"Type":2,"Flags":0,"Description":"A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically."},"AutomaticBackupReplicationRegion":{"Type":4,"Flags":0,"Description":"Enables replication of automated backups to a different Amazon Web Services Region."},"AvailabilityZone":{"Type":4,"Flags":0,"Description":"The Availability Zone (AZ) where the database will be created. For information on AWS Regions and Availability Zones."},"BackupRetentionPeriod":{"Type":3,"Flags":0,"Description":"The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups."},"CACertificateIdentifier":{"Type":4,"Flags":0,"Description":"The identifier of the CA certificate for this DB instance."},"CertificateDetails":{"Type":34,"Flags":0,"Description":"Returns the details of the DB instance's server certificate."},"CertificateRotationRestart":{"Type":2,"Flags":4,"Description":"A value that indicates whether the DB instance is restarted when you rotate your SSL/TLS certificate.\nBy default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.\nIf you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate\nThis setting doesn't apply to RDS Custom."},"CharacterSetName":{"Type":4,"Flags":0,"Description":"For supported engines, indicates that the DB instance should be associated with the specified character set."},"CopyTagsToSnapshot":{"Type":2,"Flags":0,"Description":"A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied."},"CustomIAMInstanceProfile":{"Type":4,"Flags":0,"Description":"The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:\n * The profile must exist in your account.\n * The profile must have an IAM role that Amazon EC2 has permissions to assume.\n * The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom .\nFor the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide .\n\nThis setting is required for RDS Custom."},"DBClusterIdentifier":{"Type":4,"Flags":0,"Description":"The identifier of the DB cluster that the instance will belong to."},"DBClusterSnapshotIdentifier":{"Type":4,"Flags":0,"Description":"The identifier for the RDS for MySQL Multi-AZ DB cluster snapshot to restore from. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide .\n\nConstraints:\n * Must match the identifier of an existing Multi-AZ DB cluster snapshot.\n * Can't be specified when DBSnapshotIdentifier is specified.\n * Must be specified when DBSnapshotIdentifier isn't specified.\n * If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the DBClusterSnapshotIdentifier must be the ARN of the shared snapshot.\n * Can't be the identifier of an Aurora DB cluster snapshot.\n * Can't be the identifier of an RDS for PostgreSQL Multi-AZ DB cluster snapshot."},"DBInstanceArn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) for the DB instance."},"DBInstanceClass":{"Type":4,"Flags":0,"Description":"The compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines."},"DBInstanceIdentifier":{"Type":4,"Flags":16,"Description":"A name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance."},"DBName":{"Type":4,"Flags":0,"Description":"The meaning of this parameter differs according to the database engine you use."},"DBParameterGroupName":{"Type":4,"Flags":0,"Description":"The name of an existing DB parameter group or a reference to an AWS::RDS::DBParameterGroup resource created in the template."},"DBSecurityGroups":{"Type":42,"Flags":0,"Description":"A list of the DB security groups to assign to the DB instance. The list can include both the name of existing DB security groups or references to AWS::RDS::DBSecurityGroup resources created in the template."},"DBSnapshotIdentifier":{"Type":4,"Flags":4,"Description":"The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot."},"DBSubnetGroupName":{"Type":4,"Flags":0,"Description":"A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new VPC."},"DBSystemId":{"Type":4,"Flags":2,"Description":"The Oracle system ID (Oracle SID) for a container database (CDB). The Oracle SID is also the name of the CDB. This setting is valid for RDS Custom only."},"DbiResourceId":{"Type":4,"Flags":2,"Description":"The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed."},"DedicatedLogVolume":{"Type":2,"Flags":0,"Description":"Indicates whether the DB instance has a dedicated log volume (DLV) enabled."},"DeleteAutomatedBackups":{"Type":2,"Flags":4,"Description":"A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted."},"DeletionProtection":{"Type":2,"Flags":0,"Description":"A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled."},"Domain":{"Type":4,"Flags":0,"Description":"The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain."},"DomainAuthSecretArn":{"Type":4,"Flags":0,"Description":"The ARN for the Secrets Manager secret with the credentials for the user joining the domain."},"DomainDnsIps":{"Type":43,"Flags":0,"Description":"The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers."},"DomainFqdn":{"Type":4,"Flags":0,"Description":"The fully qualified domain name (FQDN) of an Active Directory domain."},"DomainIAMRoleName":{"Type":4,"Flags":0,"Description":"Specify the name of the IAM role to be used when making API calls to the Directory Service."},"DomainOu":{"Type":4,"Flags":0,"Description":"The Active Directory organizational unit for your DB instance to join."},"EnableCloudwatchLogsExports":{"Type":44,"Flags":0,"Description":"The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used."},"EnableIAMDatabaseAuthentication":{"Type":2,"Flags":0,"Description":"A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled."},"EnablePerformanceInsights":{"Type":2,"Flags":0,"Description":"A value that indicates whether to enable Performance Insights for the DB instance."},"Endpoint":{"Type":36,"Flags":0,"Description":"Specifies the connection endpoint."},"Engine":{"Type":4,"Flags":0,"Description":"The name of the database engine that you want to use for this DB instance."},"EngineVersion":{"Type":4,"Flags":0,"Description":"The version number of the database engine to use."},"Iops":{"Type":3,"Flags":0,"Description":"The number of I/O operations per second (IOPS) that the database provisions."},"KmsKeyId":{"Type":4,"Flags":0,"Description":"The ARN of the AWS Key Management Service (AWS KMS) master key that's used to encrypt the DB instance."},"LicenseModel":{"Type":4,"Flags":0,"Description":"License model information for this DB instance."},"ManageMasterUserPassword":{"Type":2,"Flags":0,"Description":"A value that indicates whether to manage the master user password with AWS Secrets Manager."},"MasterUserPassword":{"Type":4,"Flags":4,"Description":"The password for the master user."},"MasterUserSecret":{"Type":37,"Flags":0,"Description":"Contains the secret managed by RDS in AWS Secrets Manager for the master user password."},"MasterUsername":{"Type":4,"Flags":0,"Description":"The master user name for the DB instance."},"MaxAllocatedStorage":{"Type":3,"Flags":0,"Description":"The upper limit to which Amazon RDS can automatically scale the storage of the DB instance."},"MonitoringInterval":{"Type":3,"Flags":0,"Description":"The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0."},"MonitoringRoleArn":{"Type":4,"Flags":0,"Description":"The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs."},"MultiAZ":{"Type":2,"Flags":0,"Description":"Specifies whether the database instance is a multiple Availability Zone deployment."},"NcharCharacterSetName":{"Type":4,"Flags":0,"Description":"The name of the NCHAR character set for the Oracle DB instance. This parameter doesn't apply to RDS Custom."},"NetworkType":{"Type":4,"Flags":0,"Description":"The network type of the DB cluster."},"OptionGroupName":{"Type":4,"Flags":0,"Description":"Indicates that the DB instance should be associated with the specified option group."},"PerformanceInsightsKMSKeyId":{"Type":4,"Flags":0,"Description":"The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key."},"PerformanceInsightsRetentionPeriod":{"Type":3,"Flags":0,"Description":"The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years)."},"Port":{"Type":4,"Flags":4,"Description":"The port number on which the database accepts connections."},"PreferredBackupWindow":{"Type":4,"Flags":0,"Description":"The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter."},"PreferredMaintenanceWindow":{"Type":4,"Flags":0,"Description":"he weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC)."},"ProcessorFeatures":{"Type":45,"Flags":0,"Description":"The number of CPU cores and the number of threads per core for the DB instance class of the DB instance."},"PromotionTier":{"Type":3,"Flags":0,"Description":"A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance."},"PubliclyAccessible":{"Type":2,"Flags":0,"Description":"Indicates whether the DB instance is an internet-facing instance. If you specify true, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address."},"ReplicaMode":{"Type":4,"Flags":0,"Description":"The open mode of an Oracle read replica. The default is open-read-only."},"RestoreTime":{"Type":4,"Flags":4,"Description":"The date and time to restore from."},"SourceDBClusterIdentifier":{"Type":4,"Flags":0,"Description":"The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas."},"SourceDBInstanceAutomatedBackupsArn":{"Type":4,"Flags":4,"Description":"The Amazon Resource Name (ARN) of the replicated automated backups from which to restore."},"SourceDBInstanceIdentifier":{"Type":4,"Flags":4,"Description":"If you want to create a Read Replica DB instance, specify the ID of the source DB instance. Each DB instance can have a limited number of Read Replicas."},"SourceDbiResourceId":{"Type":4,"Flags":4,"Description":"The resource ID of the source DB instance from which to restore."},"SourceRegion":{"Type":4,"Flags":4,"Description":"The ID of the region that contains the source DB instance for the Read Replica."},"StorageEncrypted":{"Type":2,"Flags":0,"Description":"A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted."},"StorageThroughput":{"Type":3,"Flags":0,"Description":"Specifies the storage throughput for the DB instance."},"StorageType":{"Type":4,"Flags":0,"Description":"Specifies the storage type to be associated with the DB instance."},"Tags":{"Type":46,"Flags":0,"Description":"Tags to assign to the DB instance."},"TdeCredentialArn":{"Type":4,"Flags":0,"Description":"The ARN from the key store with which to associate the instance for TDE encryption."},"TdeCredentialPassword":{"Type":4,"Flags":4,"Description":"The password for the given ARN from the key store in order to access the device."},"Timezone":{"Type":4,"Flags":0,"Description":"The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server."},"UseDefaultProcessorFeatures":{"Type":2,"Flags":4,"Description":"A value that indicates whether the DB instance class of the DB instance uses its default processor features."},"UseLatestRestorableTime":{"Type":2,"Flags":4,"Description":"A value that indicates whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time."},"VPCSecurityGroups":{"Type":47,"Flags":0,"Description":"A list of the VPC security group IDs to assign to the DB instance. The list can include both the physical IDs of existing VPC security groups and references to AWS::EC2::SecurityGroup resources created in the template."}}}},{"3":{"ItemType":35}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":38}},{"3":{"ItemType":39}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.RDS/DBInstance","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":40,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.RDS/DBInstance@default","ScopeType":0,"Body":48}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":0,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.RDS/DBParameterGroupProperties","Properties":{"DBParameterGroupName":{"Type":4,"Flags":16,"Description":"Specifies the name of the DB parameter group"},"Description":{"Type":4,"Flags":1,"Description":"Provides the customer-specified description for this DB parameter group."},"Family":{"Type":4,"Flags":1,"Description":"The DB parameter group family name."},"Parameters":{"Type":52,"Flags":0,"Description":"An array of parameter names and values for the parameter update."},"Tags":{"Type":53,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."}}}},{"2":{"Name":"DBParameterGroup_Parameters","Properties":{}}},{"3":{"ItemType":50}},{"2":{"Name":"AWS.RDS/DBParameterGroup","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":51,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.RDS/DBParameterGroup@default","ScopeType":0,"Body":54}},{"2":{"Name":"AuthFormat","Properties":{"AuthScheme":{"Type":4,"Flags":0,"Description":"The type of authentication that the proxy uses for connections from the proxy to the underlying database. "},"ClientPasswordAuthType":{"Type":4,"Flags":0,"Description":"The type of authentication the proxy uses for connections from clients."},"Description":{"Type":4,"Flags":0,"Description":"A user-specified description about the authentication used by a proxy to log in as a specific database user. "},"IAMAuth":{"Type":4,"Flags":0,"Description":"Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server."},"SecretArn":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager. "}}}},{"2":{"Name":"TagFormat","Properties":{"Key":{"Type":4,"Flags":0},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"AWS.RDS/DBProxyProperties","Properties":{"Auth":{"Type":59,"Flags":1,"Description":"The authorization mechanism that the proxy uses."},"DBProxyArn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) for the proxy."},"DBProxyName":{"Type":4,"Flags":17,"Description":"The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region."},"DebugLogging":{"Type":2,"Flags":0,"Description":"Whether the proxy includes detailed information about SQL statements in its logs."},"Endpoint":{"Type":4,"Flags":2,"Description":"The endpoint that you can use to connect to the proxy. You include the endpoint value in the connection string for a database client application."},"EngineFamily":{"Type":4,"Flags":1,"Description":"The kinds of databases that the proxy can connect to."},"IdleClientTimeout":{"Type":3,"Flags":0,"Description":"The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it."},"RequireTLS":{"Type":2,"Flags":0,"Description":"A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy."},"RoleArn":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager."},"Tags":{"Type":60,"Flags":0,"Description":"An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy."},"VpcId":{"Type":4,"Flags":2,"Description":"VPC ID to associate with the new DB proxy."},"VpcSecurityGroupIds":{"Type":61,"Flags":0,"Description":"VPC security group IDs to associate with the new proxy."},"VpcSubnetIds":{"Type":62,"Flags":1,"Description":"VPC subnet IDs to associate with the new proxy."}}}},{"3":{"ItemType":56}},{"3":{"ItemType":57}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.RDS/DBProxy","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":58,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.RDS/DBProxy@default","ScopeType":0,"Body":63}},{"2":{"Name":"TagFormat","Properties":{"Key":{"Type":4,"Flags":0},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"AWS.RDS/DBProxyEndpointProperties","Properties":{"DBProxyEndpointArn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) for the DB proxy endpoint."},"DBProxyEndpointName":{"Type":4,"Flags":17,"Description":"The identifier for the DB proxy endpoint. This name must be unique for all DB proxy endpoints owned by your AWS account in the specified AWS Region."},"DBProxyName":{"Type":4,"Flags":1,"Description":"The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region."},"Endpoint":{"Type":4,"Flags":2,"Description":"The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application."},"IsDefault":{"Type":2,"Flags":2,"Description":"A value that indicates whether this endpoint is the default endpoint for the associated DB proxy. Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the DB proxy can be either read/write or read-only."},"Tags":{"Type":67,"Flags":0,"Description":"An optional set of key-value pairs to associate arbitrary data of your choosing with the DB proxy endpoint."},"TargetRole":{"Type":4,"Flags":0,"Description":"A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations."},"VpcId":{"Type":4,"Flags":2,"Description":"VPC ID to associate with the new DB proxy endpoint."},"VpcSecurityGroupIds":{"Type":68,"Flags":0,"Description":"VPC security group IDs to associate with the new DB proxy endpoint."},"VpcSubnetIds":{"Type":69,"Flags":1,"Description":"VPC subnet IDs to associate with the new DB proxy endpoint."}}}},{"3":{"ItemType":65}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.RDS/DBProxyEndpoint","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":66,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.RDS/DBProxyEndpoint@default","ScopeType":0,"Body":70}},{"2":{"Name":"ConnectionPoolConfigurationInfoFormat","Properties":{"ConnectionBorrowTimeout":{"Type":3,"Flags":0,"Description":"The number of seconds for a proxy to wait for a connection to become available in the connection pool."},"InitQuery":{"Type":4,"Flags":0,"Description":"One or more SQL statements for the proxy to run when opening each new database connection."},"MaxConnectionsPercent":{"Type":3,"Flags":0,"Description":"The maximum size of the connection pool for each target in a target group."},"MaxIdleConnectionsPercent":{"Type":3,"Flags":0,"Description":"Controls how actively the proxy closes idle database connections in the connection pool."},"SessionPinningFilters":{"Type":73,"Flags":0,"Description":"Each item in the list represents a class of SQL operations that normally cause all later statements in a session using a proxy to be pinned to the same underlying database connection."}}}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.RDS/DBProxyTargetGroupProperties","Properties":{"ConnectionPoolConfigurationInfo":{"Type":72,"Flags":0},"DBClusterIdentifiers":{"Type":75,"Flags":0},"DBInstanceIdentifiers":{"Type":76,"Flags":0},"DBProxyName":{"Type":4,"Flags":1,"Description":"The identifier for the proxy."},"TargetGroupArn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN) representing the target group."},"TargetGroupName":{"Type":4,"Flags":1,"Description":"The identifier for the DBProxyTargetGroup"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.RDS/DBProxyTargetGroup","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":74,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.RDS/DBProxyTargetGroup@default","ScopeType":0,"Body":77}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"Value":{"Type":4,"Flags":0,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}}}},{"2":{"Name":"AWS.RDS/DBSubnetGroupProperties","Properties":{"DBSubnetGroupDescription":{"Type":4,"Flags":1},"DBSubnetGroupName":{"Type":4,"Flags":16},"SubnetIds":{"Type":81,"Flags":5},"Tags":{"Type":82,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":79}},{"2":{"Name":"AWS.RDS/DBSubnetGroup","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":80,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.RDS/DBSubnetGroup@default","ScopeType":0,"Body":83}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":0,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.RDS/EventSubscriptionProperties","Properties":{"Enabled":{"Type":2,"Flags":0,"Description":"A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it."},"EventCategories":{"Type":87,"Flags":0,"Description":"A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action."},"SnsTopicArn":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it."},"SourceIds":{"Type":88,"Flags":0,"Description":"The list of identifiers of the event sources for which events will be 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 cannot end with a hyphen or contain two consecutive hyphens."},"SourceType":{"Type":4,"Flags":0,"Description":"The type of source that will be generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned."},"SubscriptionName":{"Type":4,"Flags":16,"Description":"The name of the subscription."},"Tags":{"Type":89,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":85}},{"2":{"Name":"AWS.RDS/EventSubscription","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":86,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.RDS/EventSubscription@default","ScopeType":0,"Body":90}},{"2":{"Name":"AWS.RDS/GlobalClusterProperties","Properties":{"DeletionProtection":{"Type":2,"Flags":0,"Description":"The deletion protection setting for the new global database. The global database can't be deleted when deletion protection is enabled."},"Engine":{"Type":4,"Flags":0,"Description":"The name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora).\nIf you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the cluster."},"EngineVersion":{"Type":4,"Flags":0,"Description":"The version number of the database engine to use. If you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the cluster."},"GlobalClusterIdentifier":{"Type":4,"Flags":16,"Description":"The cluster identifier of the new global database cluster. This parameter is stored as a lowercase string."},"SourceDBClusterIdentifier":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) to use as the primary cluster of the global database. This parameter is optional. This parameter is stored as a lowercase string."},"StorageEncrypted":{"Type":2,"Flags":0,"Description":" The storage encryption setting for the new global database cluster.\nIf you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the cluster."}}}},{"2":{"Name":"AWS.RDS/GlobalCluster","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":92,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.RDS/GlobalCluster@default","ScopeType":0,"Body":93}},{"2":{"Name":"OptionConfiguration","Properties":{"DBSecurityGroupMemberships":{"Type":98,"Flags":0,"Description":"A list of DBSecurityGroupMembership name strings used for this option."},"OptionName":{"Type":4,"Flags":1,"Description":"The configuration of options to include in a group."},"OptionSettings":{"Type":99,"Flags":0,"Description":"The option settings to include in an option group."},"OptionVersion":{"Type":4,"Flags":0,"Description":"The version for the option."},"Port":{"Type":3,"Flags":0,"Description":"The optional port for the option."},"VpcSecurityGroupMemberships":{"Type":100,"Flags":0,"Description":"A list of VpcSecurityGroupMembership name strings used for this option."}}}},{"2":{"Name":"OptionSetting","Properties":{"Name":{"Type":4,"Flags":0,"Description":"The name of the option that has settings that you can set."},"Value":{"Type":4,"Flags":0,"Description":"The current value of the option setting."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"Value":{"Type":4,"Flags":0,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}}}},{"3":{"ItemType":4}},{"3":{"ItemType":96}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.RDS/OptionGroupProperties","Properties":{"EngineName":{"Type":4,"Flags":1,"Description":"Indicates the name of the engine that this option group can be applied to."},"MajorEngineVersion":{"Type":4,"Flags":1,"Description":"Indicates the major engine version associated with this option group."},"OptionConfigurations":{"Type":102,"Flags":0,"Description":"Indicates what options are available in the option group."},"OptionGroupDescription":{"Type":4,"Flags":1,"Description":"Provides a description of the option group."},"OptionGroupName":{"Type":4,"Flags":16,"Description":"Specifies the name of the option group."},"Tags":{"Type":103,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."}}}},{"3":{"ItemType":95}},{"3":{"ItemType":97}},{"2":{"Name":"AWS.RDS/OptionGroup","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":101,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.RDS/OptionGroup@default","ScopeType":0,"Body":104}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.RDS/CustomDBEngineVersionProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "ObjectType", + "name": "AWS.RDS/CustomDBEngineVersionProperties", + "properties": { + "DBEngineVersionArn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The ARN of the custom engine version." + }, + "DatabaseInstallationFilesS3BucketName": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is `my-custom-installation-files`." + }, + "DatabaseInstallationFilesS3Prefix": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is `123456789012/cev1`. If this setting isn't specified, no prefix is assumed." + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "An optional description of your CEV." + }, + "Engine": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The database engine to use for your custom engine version (CEV). The only supported value is `custom-oracle-ee`." + }, + "EngineVersion": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The name of your CEV. The name format is 19.customized_string . For example, a valid name is 19.my_cev1. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Region." + }, + "ImageId": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The identifier of Amazon Machine Image (AMI) used for CEV." + }, + "KMSKeyId": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The AWS KMS key identifier for an encrypted CEV. A symmetric KMS key is required for RDS Custom, but optional for Amazon RDS." + }, + "Manifest": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed." + }, + "SourceCustomDbEngineVersionIdentifier": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The identifier of the source custom engine version." + }, + "Status": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The availability status to be assigned to the CEV." + }, + "Tags": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + }, + "UseAwsProvidedLatestImage": { + "type": { + "$ref": "#/4" + }, + "flags": 4, + "description": "A value that indicates whether AWS provided latest image is applied automatically to the Custom Engine Version. By default, AWS provided latest image is applied automatically. This value is only applied on create." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.RDS/CustomDBEngineVersion", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.RDS/CustomDBEngineVersion@default", + "scopeType": 0, + "body": { + "$ref": "#/6" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "DBClusterRole", + "properties": { + "FeatureName": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion in the Amazon RDS API Reference." + }, + "RoleArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster." + } + } + }, + { + "$type": "ObjectType", + "name": "Endpoint", + "properties": { + "Address": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The connection endpoint for the DB cluster." + }, + "Port": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The port number that will accept connections on this DB cluster." + } + } + }, + { + "$type": "ObjectType", + "name": "MasterUserSecret", + "properties": { + "KmsKeyId": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The AWS KMS key identifier that is used to encrypt the secret." + }, + "SecretArn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) of the secret." + } + } + }, + { + "$type": "ObjectType", + "name": "ReadEndpoint", + "properties": { + "Address": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The reader endpoint for the DB cluster." + } + } + }, + { + "$type": "ObjectType", + "name": "ScalingConfiguration", + "properties": { + "AutoPause": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections)." + }, + "MaxCapacity": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "The maximum capacity for an Aurora DB cluster in serverless DB engine mode.\nFor Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.\nFor Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.\nThe maximum capacity must be greater than or equal to the minimum capacity." + }, + "MinCapacity": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "The minimum capacity for an Aurora DB cluster in serverless DB engine mode.\nFor Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.\nFor Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.\nThe minimum capacity must be less than or equal to the maximum capacity." + }, + "SecondsBeforeTimeout": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action.\nThe default is 300." + }, + "SecondsUntilAutoPause": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "The time, in seconds, before an Aurora DB cluster in serverless mode is paused." + }, + "TimeoutAction": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.\nForceApplyCapacityChange sets the capacity to the specified value as soon as possible.\nRollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period.\n\nFor more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide." + } + } + }, + { + "$type": "ObjectType", + "name": "ServerlessV2ScalingConfiguration", + "properties": { + "MaxCapacity": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128." + }, + "MinCapacity": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + } + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.RDS/DBClusterProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/8" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/14" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "AWS.RDS/DBClusterProperties", + "properties": { + "AllocatedStorage": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster." + }, + "AssociatedRoles": { + "type": { + "$ref": "#/17" + }, + "flags": 0, + "description": "Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf." + }, + "AutoMinorVersionUpgrade": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically." + }, + "AvailabilityZones": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide." + }, + "BacktrackWindow": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "The target backtrack window, in seconds. To disable backtracking, set this value to 0." + }, + "BackupRetentionPeriod": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "The number of days for which automated backups are retained." + }, + "CopyTagsToSnapshot": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them." + }, + "DBClusterArn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) for the DB cluster." + }, + "DBClusterIdentifier": { + "type": { + "$ref": "#/1" + }, + "flags": 16, + "description": "The DB cluster identifier. This parameter is stored as a lowercase string." + }, + "DBClusterInstanceClass": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge." + }, + "DBClusterParameterGroupName": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The name of the DB cluster parameter group to associate with this DB cluster." + }, + "DBClusterResourceId": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The AWS Region-unique, immutable identifier for the DB cluster." + }, + "DBInstanceParameterGroupName": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The name of the DB parameter group to apply to all instances of the DB cluster." + }, + "DBSubnetGroupName": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A DB subnet group that you want to associate with this DB cluster." + }, + "DBSystemId": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Reserved for future use." + }, + "DatabaseName": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The name of your database. If you don't provide a name, then Amazon RDS won't create a database in this DB cluster. For naming constraints, see Naming Constraints in the Amazon RDS User Guide." + }, + "DeletionProtection": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled." + }, + "Domain": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The Active Directory directory ID to create the DB cluster in." + }, + "DomainIAMRoleName": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Specify the name of the IAM role to be used when making API calls to the Directory Service." + }, + "EnableCloudwatchLogsExports": { + "type": { + "$ref": "#/19" + }, + "flags": 0, + "description": "The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide." + }, + "EnableGlobalWriteForwarding": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database." + }, + "EnableHttpEndpoint": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "A value that indicates whether to enable the HTTP endpoint for DB cluster. By default, the HTTP endpoint is disabled." + }, + "EnableIAMDatabaseAuthentication": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled." + }, + "EnableLocalWriteForwarding": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances." + }, + "Endpoint": { + "type": { + "$ref": "#/9" + }, + "flags": 2 + }, + "Engine": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql" + }, + "EngineLifecycleSupport": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The life cycle type of the DB cluster. You can use this setting to enroll your DB cluster into Amazon RDS Extended Support." + }, + "EngineMode": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster." + }, + "EngineVersion": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The version number of the database engine to use." + }, + "GlobalClusterIdentifier": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "If you are configuring an Aurora global database cluster and want your Aurora DB cluster to be a secondary member in the global database cluster, specify the global cluster ID of the global database cluster. To define the primary database cluster of the global cluster, use the AWS::RDS::GlobalCluster resource.\n\nIf you aren't configuring a global database cluster, don't specify this property." + }, + "Iops": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster." + }, + "KmsKeyId": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the AWS Key Management Service master key that is used to encrypt the database instances in the DB cluster, such as arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. If you enable the StorageEncrypted property but don't specify this property, the default master key is used. If you specify this property, you must set the StorageEncrypted property to true." + }, + "ManageMasterUserPassword": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "A value that indicates whether to manage the master user password with AWS Secrets Manager." + }, + "MasterUserPassword": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The master password for the DB instance." + }, + "MasterUserSecret": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "Contains the secret managed by RDS in AWS Secrets Manager for the master user password." + }, + "MasterUsername": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The name of the master user for the DB cluster. You must specify MasterUsername, unless you specify SnapshotIdentifier. In that case, don't specify MasterUsername." + }, + "MonitoringInterval": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0." + }, + "MonitoringRoleArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs." + }, + "NetworkType": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The network type of the DB cluster." + }, + "PerformanceInsightsEnabled": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "A value that indicates whether to turn on Performance Insights for the DB cluster." + }, + "PerformanceInsightsKmsKeyId": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The Amazon Web Services KMS key identifier for encryption of Performance Insights data." + }, + "PerformanceInsightsRetentionPeriod": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "The amount of time, in days, to retain Performance Insights data." + }, + "Port": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "The port number on which the instances in the DB cluster accept connections. Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql." + }, + "PreferredBackupWindow": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide." + }, + "PreferredMaintenanceWindow": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide." + }, + "PubliclyAccessible": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "A value that indicates whether the DB cluster is publicly accessible." + }, + "ReadEndpoint": { + "type": { + "$ref": "#/11" + }, + "flags": 0 + }, + "ReplicationSourceIdentifier": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica." + }, + "RestoreToTime": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The date and time to restore the DB cluster to. Value must be a time in Universal Coordinated Time (UTC) format. An example: 2015-03-07T23:45:00Z" + }, + "RestoreType": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The type of restore to be performed. You can specify one of the following values:\nfull-copy - The new DB cluster is restored as a full copy of the source DB cluster.\ncopy-on-write - The new DB cluster is restored as a clone of the source DB cluster." + }, + "ScalingConfiguration": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster." + }, + "ServerlessV2ScalingConfiguration": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "Contains the scaling configuration of an Aurora Serverless v2 DB cluster." + }, + "SnapshotIdentifier": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The identifier for the DB snapshot or DB cluster snapshot to restore from.\nYou can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.\nAfter you restore a DB cluster with a SnapshotIdentifier property, you must specify the same SnapshotIdentifier property for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed. However, if you don't specify the SnapshotIdentifier property, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the specified SnapshotIdentifier property, and the original DB cluster is deleted." + }, + "SourceDBClusterIdentifier": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The identifier of the source DB cluster from which to restore." + }, + "SourceRegion": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The AWS Region which contains the source DB cluster when replicating a DB cluster. For example, us-east-1." + }, + "StorageEncrypted": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Indicates whether the DB instance is encrypted.\nIf you specify the DBClusterIdentifier, SnapshotIdentifier, or SourceDBInstanceIdentifier property, don't specify this property. The value is inherited from the cluster, snapshot, or source DB instance." + }, + "StorageThroughput": { + "type": { + "$ref": "#/15" + }, + "flags": 2, + "description": "Specifies the storage throughput value for the DB cluster. This setting applies only to the gp3 storage type." + }, + "StorageType": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Specifies the storage type to be associated with the DB cluster." + }, + "Tags": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + }, + "UseLatestRestorableTime": { + "type": { + "$ref": "#/4" + }, + "flags": 4, + "description": "A value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster is not restored to the latest restorable backup time." + }, + "VpcSecurityGroupIds": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "A list of EC2 VPC security groups to associate with this DB cluster." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.RDS/DBCluster", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/22" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.RDS/DBCluster@default", + "scopeType": 0, + "body": { + "$ref": "#/23" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.RDS/DBClusterParameterGroupProperties" + }, + { + "$type": "ObjectType", + "name": "DBClusterParameterGroup_Parameters", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/25" + } + }, + { + "$type": "ObjectType", + "name": "AWS.RDS/DBClusterParameterGroupProperties", + "properties": { + "DBClusterParameterGroupName": { + "type": { + "$ref": "#/1" + }, + "flags": 16 + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "A friendly description for this DB cluster parameter group." + }, + "Family": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a DB engine and engine version compatible with that DB cluster parameter group family." + }, + "Parameters": { + "type": { + "$ref": "#/27" + }, + "flags": 1, + "description": "An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request." + }, + "Tags": { + "type": { + "$ref": "#/28" + }, + "flags": 0, + "description": "The list of tags for the cluster parameter group." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.RDS/DBClusterParameterGroup", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/29" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.RDS/DBClusterParameterGroup@default", + "scopeType": 0, + "body": { + "$ref": "#/30" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "CertificateDetails", + "properties": { + "CAIdentifier": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The CA identifier of the CA certificate used for the DB instance's server certificate." + }, + "ValidTill": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The expiration date of the DB instance?s server certificate." + } + } + }, + { + "$type": "ObjectType", + "name": "DBInstanceRole", + "properties": { + "FeatureName": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The name of the feature associated with the AWS Identity and Access Management (IAM) role. IAM roles that are associated with a DB instance grant permission for the DB instance to access other AWS services on your behalf. For the list of supported feature names, see the ``SupportedFeatureNames`` description in [DBEngineVersion](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DBEngineVersion.html) in the *Amazon RDS API Reference*." + }, + "RoleArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance." + } + } + }, + { + "$type": "ObjectType", + "name": "Endpoint", + "properties": { + "Address": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "Specifies the DNS address of the DB instance." + }, + "HostedZoneId": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "Specifies the ID that Amazon Route 53 assigns when you create a hosted zone." + }, + "Port": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "Specifies the port that the database engine is listening on." + } + } + }, + { + "$type": "ObjectType", + "name": "MasterUserSecret", + "properties": { + "KmsKeyId": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The AWS KMS key identifier that is used to encrypt the secret." + }, + "SecretArn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) of the secret." + } + } + }, + { + "$type": "ObjectType", + "name": "ProcessorFeature", + "properties": { + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The name of the processor feature. Valid names are ``coreCount`` and ``threadsPerCore``." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The value of a processor feature name." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "A 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}_.:/=+\\\\-@]*)$\")." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A 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}_.:/=+\\\\-@]*)$\")." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.RDS/DBInstanceProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/33" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/36" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/37" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "AWS.RDS/DBInstanceProperties", + "properties": { + "AllocatedStorage": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The amount of storage in gibibytes (GiB) to be initially allocated for the database instance.\n If any value is set in the ``Iops`` parameter, ``AllocatedStorage`` must be at least 100 GiB, which corresponds to the minimum Iops value of 1,000. If you increase the ``Iops`` value (in 1,000 IOPS increments), then you must also increase the ``AllocatedStorage`` value (in 100-GiB increments). \n *Amazon Aurora* \n Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.\n *Db2* \n Constraints 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 \n *MySQL* \n Constraints 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 \n *MariaDB* \n Constraints 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 \n *PostgreSQL* \n Constraints 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 \n *Oracle* \n Constraints 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 \n *SQL Server* \n Constraints to the amount of storage for each storage type are the following: \n + General Purpose (SSD) storage (gp2):\n + Enterprise and Standard editions: Must be an integer from 20 to 16384.\n + Web and Express editions: Must be an integer from 20 to 16384.\n \n + Provisioned IOPS storage (io1):\n + Enterprise and Standard editions: Must be an integer from 20 to 16384.\n + Web and Express editions: Must be an integer from 20 to 16384.\n \n + Magnetic storage (standard):\n + Enterprise and Standard editions: Must be an integer from 20 to 1024.\n + Web and Express editions: Must be an integer from 20 to 1024." + }, + "AllowMajorVersionUpgrade": { + "type": { + "$ref": "#/4" + }, + "flags": 4, + "description": "A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.\n Constraints: Major version upgrades must be allowed when specifying a value for the ``EngineVersion`` parameter that is a different major version than the DB instance's current version." + }, + "AssociatedRoles": { + "type": { + "$ref": "#/39" + }, + "flags": 0, + "description": "The IAMlong (IAM) roles associated with the DB instance. \n *Amazon Aurora* \n Not applicable. The associated roles are managed by the DB cluster." + }, + "AutoMinorVersionUpgrade": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically." + }, + "AutomaticBackupReplicationKmsKeyId": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The AWS KMS key identifier for encryption of the replicated automated backups. The KMS key ID is the Amazon Resource Name (ARN) for the KMS encryption key in the destination AWS-Region, for example, ``arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE``." + }, + "AutomaticBackupReplicationRegion": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The destination region for the backup replication of the DB instance. For more info, see [Replicating automated backups to another Region](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReplicateBackups.html) in the *Amazon RDS User Guide*." + }, + "AvailabilityZone": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The Availability Zone (AZ) where the database will be created. For information on AWS-Regions and Availability Zones, see [Regions and Availability Zones](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html).\n For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one.\n Default: A random, system-chosen Availability Zone in the endpoint's AWS-Region.\n Constraints:\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.\n \n Example: ``us-east-1d``" + }, + "BackupRetentionPeriod": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.\n *Amazon Aurora* \n Not applicable. The retention period for automated backups is managed by the DB cluster.\n Default: 1\n Constraints:\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" + }, + "CACertificateIdentifier": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The identifier of the CA certificate for this DB instance.\n For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the *Amazon RDS User Guide* and [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 User Guide*." + }, + "CertificateDetails": { + "type": { + "$ref": "#/32" + }, + "flags": 0, + "description": "The details of the DB instance's server certificate." + }, + "CertificateRotationRestart": { + "type": { + "$ref": "#/4" + }, + "flags": 4, + "description": "Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.\n By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.\n Set this parameter only if you are *not* using SSL/TLS to connect to the DB instance.\n If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate:\n + For more information about rotating your SSL/TLS certificate for RDS DB engines, see [Rotating Your SSL/TLS Certificate.](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon RDS User Guide.* \n + For more information about rotating your SSL/TLS certificate for Aurora DB engines, see [Rotating Your SSL/TLS Certificate](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon Aurora User Guide*.\n \n This setting doesn't apply to RDS Custom DB instances." + }, + "CharacterSetName": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "For supported engines, indicates that the DB instance should be associated with the specified character set.\n *Amazon Aurora* \n Not applicable. The character set is managed by the DB cluster. For more information, see [AWS::RDS::DBCluster](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html)." + }, + "CopyTagsToSnapshot": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Specifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.\n This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting." + }, + "CustomIAMInstanceProfile": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.\n This setting is required for RDS Custom.\n Constraints:\n + The profile must exist in your account.\n + The profile must have an IAM role that Amazon EC2 has permissions to assume.\n + The instance profile name and the associated IAM role name must start with the prefix ``AWSRDSCustom``.\n \n For the list of permissions required for the IAM role, see [Configure IAM and your VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc) in the *Amazon RDS User Guide*." + }, + "DBClusterIdentifier": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The identifier of the DB cluster that the instance will belong to." + }, + "DBClusterSnapshotIdentifier": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The identifier for the Multi-AZ DB cluster snapshot to restore from.\n For more information on Multi-AZ DB clusters, see [Multi-AZ DB cluster deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide*.\n Constraints:\n + Must match the identifier of an existing Multi-AZ DB cluster snapshot.\n + Can't be specified when ``DBSnapshotIdentifier`` is specified.\n + Must be specified when ``DBSnapshotIdentifier`` isn't specified.\n + If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the ``DBClusterSnapshotIdentifier`` must be the ARN of the shared snapshot.\n + Can't be the identifier of an Aurora DB cluster snapshot." + }, + "DBInstanceArn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "" + }, + "DBInstanceClass": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The compute and memory capacity of the DB instance, for example ``db.m5.large``. Not all DB instance classes are available in all AWS-Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see [DB instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide* or [Aurora DB instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.DBInstanceClass.html) in the *Amazon Aurora User Guide*." + }, + "DBInstanceIdentifier": { + "type": { + "$ref": "#/1" + }, + "flags": 16, + "description": "A name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).\n For information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide*.\n If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name." + }, + "DBName": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The meaning of this parameter differs according to the database engine you use.\n If you specify the ``DBSnapshotIdentifier`` property, this property only applies to RDS for Oracle.\n *Amazon Aurora* \n Not applicable. The database name is managed by the DB cluster.\n *Db2* \n The 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.\n Constraints:\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 \n *MySQL* \n The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.\n Constraints:\n + Must contain 1 to 64 letters or numbers.\n + Can't be a word reserved by the specified database engine\n \n *MariaDB* \n The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.\n Constraints:\n + Must contain 1 to 64 letters or numbers.\n + Can't be a word reserved by the specified database engine\n \n *PostgreSQL* \n The name of the database to create when the DB instance is created. If this parameter is not specified, the default ``postgres`` database is created in the DB instance.\n Constraints:\n + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).\n + Must contain 1 to 63 characters.\n + Can't be a word reserved by the specified database engine\n \n *Oracle* \n The Oracle System ID (SID) of the created DB instance. If you specify ``null``, the default value ``ORCL`` is used. You can't specify the string NULL, or any other reserved word, for ``DBName``. \n Default: ``ORCL`` \n Constraints:\n + Can't be longer than 8 characters\n \n *SQL Server* \n Not applicable. Must be null." + }, + "DBParameterGroupName": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The name of an existing DB parameter group or a reference to an [AWS::RDS::DBParameterGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html) resource created in the template.\n To list all of the available DB parameter group names, use the following command:\n ``aws rds describe-db-parameter-groups --query \"DBParameterGroups[].DBParameterGroupName\" --output text`` \n If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot.\n If you don't specify a value for ``DBParameterGroupName`` property, the default DB parameter group for the specified engine and engine version is used." + }, + "DBSecurityGroups": { + "type": { + "$ref": "#/40" + }, + "flags": 0, + "description": "A list of the DB security groups to assign to the DB instance. The list can include both the name of existing DB security groups or references to AWS::RDS::DBSecurityGroup resources created in the template.\n If you set DBSecurityGroups, you must not set VPCSecurityGroups, and vice versa. Also, note that the DBSecurityGroups property exists only for backwards compatibility with older regions and is no longer recommended for providing security information to an RDS DB instance. Instead, use VPCSecurityGroups.\n If you specify this property, AWS CloudFormation sends only the following properties (if specified) to Amazon RDS during create operations:\n + ``AllocatedStorage`` \n + ``AutoMinorVersionUpgrade`` \n + ``AvailabilityZone`` \n + ``BackupRetentionPeriod`` \n + ``CharacterSetName`` \n + ``DBInstanceClass`` \n + ``DBName`` \n + ``DBParameterGroupName`` \n + ``DBSecurityGroups`` \n + ``DBSubnetGroupName`` \n + ``Engine`` \n + ``EngineVersion`` \n + ``Iops`` \n + ``LicenseModel`` \n + ``MasterUsername`` \n + ``MasterUserPassword`` \n + ``MultiAZ`` \n + ``OptionGroupName`` \n + ``PreferredBackupWindow`` \n + ``PreferredMaintenanceWindow`` \n \n All other properties are ignored. Specify a virtual private cloud (VPC) security group if you want to submit other properties, such as ``StorageType``, ``StorageEncrypted``, or ``KmsKeyId``. If you're already using the ``DBSecurityGroups`` property, you can't use these other properties by updating your DB instance to use a VPC security group. You must recreate the DB instance." + }, + "DBSnapshotIdentifier": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot.\n By specifying this property, you can create a DB instance from the specified DB snapshot. If the ``DBSnapshotIdentifier`` property is an empty string or the ``AWS::RDS::DBInstance`` declaration has no ``DBSnapshotIdentifier`` property, AWS CloudFormation creates a new database. If the property contains a value (other than an empty string), AWS CloudFormation creates a database from the specified snapshot. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack.\n Some DB instance properties aren't valid when you restore from a snapshot, such as the ``MasterUsername`` and ``MasterUserPassword`` properties. For information about the properties that you can specify, see the ``RestoreDBInstanceFromDBSnapshot`` action in the *Amazon RDS API Reference*.\n After you restore a DB instance with a ``DBSnapshotIdentifier`` property, you must specify the same ``DBSnapshotIdentifier`` property for any future updates to the DB instance. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify the ``DBSnapshotIdentifier`` property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specified ``DBSnapshotIdentifier`` property, and the original DB instance is deleted.\n If you specify the ``DBSnapshotIdentifier`` property to restore a DB instance (as opposed to specifying it for DB instance updates), then don't specify the following properties:\n + ``CharacterSetName`` \n + ``DBClusterIdentifier`` \n + ``DBName`` \n + ``DeleteAutomatedBackups`` \n + ``EnablePerformanceInsights`` \n + ``KmsKeyId`` \n + ``MasterUsername`` \n + ``MasterUserPassword`` \n + ``PerformanceInsightsKMSKeyId`` \n + ``PerformanceInsightsRetentionPeriod`` \n + ``PromotionTier`` \n + ``SourceDBInstanceIdentifier`` \n + ``SourceRegion`` \n + ``StorageEncrypted`` (for an encrypted snapshot)\n + ``Timezone`` \n \n *Amazon Aurora* \n Not applicable. Snapshot restore is managed by the DB cluster." + }, + "DBSubnetGroupName": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new VPC. \n If there's no DB subnet group, then the DB instance isn't a VPC DB instance.\n For more information about using Amazon RDS in a VPC, see [Using Amazon RDS with Amazon Virtual Private Cloud (VPC)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html) in the *Amazon RDS User Guide*. \n *Amazon Aurora* \n Not applicable. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting." + }, + "DBSystemId": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. In this context, the term \"Oracle database instance\" refers exclusively to the system global area (SGA) and Oracle background processes. If you don't specify a SID, the value defaults to ``RDSCDB``. The Oracle SID is also the name of your CDB." + }, + "DbiResourceId": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "" + }, + "DedicatedLogVolume": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Indicates whether the DB instance has a dedicated log volume (DLV) enabled." + }, + "DeleteAutomatedBackups": { + "type": { + "$ref": "#/4" + }, + "flags": 4, + "description": "A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted.\n *Amazon Aurora* \n Not applicable. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the DB cluster are not deleted." + }, + "DeletionProtection": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see [Deleting a DB Instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html). \n *Amazon Aurora* \n Not applicable. You can enable or disable deletion protection for the DB cluster. For more information, see ``CreateDBCluster``. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster." + }, + "Domain": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The 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.\n For more information, see [Kerberos Authentication](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html) in the *Amazon RDS User Guide*." + }, + "DomainAuthSecretArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The ARN for the Secrets Manager secret with the credentials for the user joining the domain.\n Example: ``arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456``" + }, + "DomainDnsIps": { + "type": { + "$ref": "#/41" + }, + "flags": 0, + "description": "The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.\n Constraints:\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.\n \n Example: ``123.124.125.126,234.235.236.237``" + }, + "DomainFqdn": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The fully qualified domain name (FQDN) of an Active Directory domain.\n Constraints:\n + Can't be longer than 64 characters.\n \n Example: ``mymanagedADtest.mymanagedAD.mydomain``" + }, + "DomainIAMRoleName": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The name of the IAM role to use when making API calls to the Directory Service.\n This setting doesn't apply to the following DB instances:\n + Amazon Aurora (The domain is managed by the DB cluster.)\n + RDS Custom" + }, + "DomainOu": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The Active Directory organizational unit for your DB instance to join.\n Constraints:\n + Must be in the distinguished name format.\n + Can't be longer than 64 characters.\n \n Example: ``OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain``" + }, + "EnableCloudwatchLogsExports": { + "type": { + "$ref": "#/42" + }, + "flags": 0, + "description": "The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see [Publishing Database Logs to Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the *Amazon Relational Database Service User Guide*.\n *Amazon Aurora* \n Not applicable. CloudWatch Logs exports are managed by the DB cluster. \n *Db2* \n Valid values: ``diag.log``, ``notify.log`` \n *MariaDB* \n Valid values: ``audit``, ``error``, ``general``, ``slowquery`` \n *Microsoft SQL Server* \n Valid values: ``agent``, ``error`` \n *MySQL* \n Valid values: ``audit``, ``error``, ``general``, ``slowquery`` \n *Oracle* \n Valid values: ``alert``, ``audit``, ``listener``, ``trace``, ``oemagent`` \n *PostgreSQL* \n Valid values: ``postgresql``, ``upgrade``" + }, + "EnableIAMDatabaseAuthentication": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.\n This property is supported for RDS for MariaDB, RDS for MySQL, and RDS for PostgreSQL. For more information, see [IAM Database Authentication for MariaDB, MySQL, and PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon RDS User Guide.* \n *Amazon Aurora* \n Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster." + }, + "EnablePerformanceInsights": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Specifies whether to enable Performance Insights for the DB instance. For more information, see [Using Amazon Performance Insights](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) in the *Amazon RDS User Guide*.\n This setting doesn't apply to RDS Custom DB instances." + }, + "Endpoint": { + "type": { + "$ref": "#/34" + }, + "flags": 0, + "description": "The connection endpoint for the DB instance.\n The endpoint might not be shown for instances with the status of ``creating``." + }, + "Engine": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The name of the database engine to use for this DB instance. Not every database engine is available in every AWS Region.\n This property is required when creating a DB instance.\n You can convert an Oracle database from the non-CDB architecture to the container database (CDB) architecture by updating the ``Engine`` value in your templates from ``oracle-ee`` to ``oracle-ee-cdb`` or from ``oracle-se2`` to ``oracle-se2-cdb``. Converting to the CDB architecture requires an interruption.\n Valid 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``" + }, + "EngineLifecycleSupport": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "" + }, + "EngineVersion": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The version number of the database engine to use.\n For a list of valid engine versions, use the ``DescribeDBEngineVersions`` action.\n The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region.\n *Amazon Aurora* \n Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster.\n *Db2* \n See [Amazon RDS for Db2](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Db2.html#Db2.Concepts.VersionMgmt) in the *Amazon RDS User Guide.* \n *MariaDB* \n See [MariaDB on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt) in the *Amazon RDS User Guide.* \n *Microsoft SQL Server* \n See [Microsoft SQL Server Versions on Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport) in the *Amazon RDS User Guide.* \n *MySQL* \n See [MySQL on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt) in the *Amazon RDS User Guide.* \n *Oracle* \n See [Oracle Database Engine Release Notes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html) in the *Amazon RDS User Guide.* \n *PostgreSQL* \n See [Supported PostgreSQL Database Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts.General.DBVersions) in the *Amazon RDS User Guide.*" + }, + "Iops": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "The number of I/O operations per second (IOPS) that the database provisions. The value must be equal to or greater than 1000. \n If you specify this property, you must follow the range of allowed ratios of your requested IOPS rate to the amount of storage that you allocate (IOPS to allocated storage). For example, you can provision an Oracle database instance with 1000 IOPS and 200 GiB of storage (a ratio of 5:1), or specify 2000 IOPS with 200 GiB of storage (a ratio of 10:1). For more information, see [Amazon RDS Provisioned IOPS Storage to Improve Performance](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/CHAP_Storage.html#USER_PIOPS) in the *Amazon RDS User Guide*.\n If you specify ``io1`` for the ``StorageType`` property, then you must also specify the ``Iops`` property.\n Constraints:\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." + }, + "KmsKeyId": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The ARN of the AWS KMS key that's used to encrypt the DB instance, such as ``arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef``. If you enable the StorageEncrypted property but don't specify this property, AWS CloudFormation uses the default KMS key. If you specify this property, you must set the StorageEncrypted property to true. \n If you specify the ``SourceDBInstanceIdentifier`` or ``SourceDbiResourceId`` property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specified ``KmsKeyId`` property is used. However, if the source DB instance is in a different AWS Region, you must specify a KMS key ID.\n If you specify the ``SourceDBInstanceAutomatedBackupsArn`` property, don't specify this property. The value is inherited from the source DB instance automated backup, and if the automated backup is encrypted, the specified ``KmsKeyId`` property is used.\n If you create an encrypted read replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the region that they're created in, and you can't use encryption keys from one region in another region.\n If you specify the ``DBSnapshotIdentifier`` property, don't specify this property. The ``StorageEncrypted`` property value is inherited from the snapshot. If the DB instance is encrypted, the specified ``KmsKeyId`` property is also inherited from the snapshot.\n If you specify ``DBSecurityGroups``, AWS CloudFormation ignores this property. To specify both a security group and this property, you must use a VPC security group. For more information about Amazon RDS and VPC, see [Using Amazon RDS with Amazon VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html) in the *Amazon RDS User Guide*.\n *Amazon Aurora* \n Not applicable. The KMS key identifier is managed by the DB cluster." + }, + "LicenseModel": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "License model information for this DB instance.\n Valid 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 [](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-licensing.html) in the *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 \n If you've specified ``DBSecurityGroups`` and then you update the license model, AWS CloudFormation replaces the underlying DB instance. This will incur some interruptions to database availability." + }, + "ManageMasterUserPassword": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Specifies whether to manage the master user password with AWS Secrets Manager.\n For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide.* \n Constraints:\n + Can't manage the master user password with AWS Secrets Manager if ``MasterUserPassword`` is specified." + }, + "MasterUserPassword": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The password for the master user. The password can include any printable ASCII character except \"/\", \"\"\", or \"@\".\n *Amazon Aurora* \n Not applicable. The password for the master user is managed by the DB cluster.\n *RDS for Db2* \n Must contain from 8 to 255 characters.\n *RDS for MariaDB* \n Constraints: Must contain from 8 to 41 characters.\n *RDS for Microsoft SQL Server* \n Constraints: Must contain from 8 to 128 characters.\n *RDS for MySQL* \n Constraints: Must contain from 8 to 41 characters.\n *RDS for Oracle* \n Constraints: Must contain from 8 to 30 characters.\n *RDS for PostgreSQL* \n Constraints: Must contain from 8 to 128 characters." + }, + "MasterUserSecret": { + "type": { + "$ref": "#/35" + }, + "flags": 0, + "description": "The secret managed by RDS in AWS Secrets Manager for the master user password.\n For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide.*" + }, + "MasterUsername": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The master user name for the DB instance.\n If you specify the ``SourceDBInstanceIdentifier`` or ``DBSnapshotIdentifier`` property, don't specify this property. The value is inherited from the source DB instance or snapshot.\n When 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* \n Not applicable. The name for the master user is managed by the DB cluster. \n *RDS for Db2* \n Constraints:\n + Must be 1 to 16 letters or numbers.\n + First character must be a letter.\n + Can't be a reserved word for the chosen database engine.\n \n *RDS for MariaDB* \n Constraints:\n + Must be 1 to 16 letters or numbers.\n + Can't be a reserved word for the chosen database engine.\n \n *RDS for Microsoft SQL Server* \n Constraints:\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 \n *RDS for MySQL* \n Constraints:\n + Must be 1 to 16 letters or numbers.\n + First character must be a letter.\n + Can't be a reserved word for the chosen database engine.\n \n *RDS for Oracle* \n Constraints:\n + Must be 1 to 30 letters or numbers.\n + First character must be a letter.\n + Can't be a reserved word for the chosen database engine.\n \n *RDS for PostgreSQL* \n Constraints:\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." + }, + "MaxAllocatedStorage": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.\n For more information about this setting, including limitations that apply to it, see [Managing capacity automatically with Amazon RDS storage autoscaling](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling) in the *Amazon RDS User Guide*.\n This setting doesn't apply to the following DB instances:\n + Amazon Aurora (Storage is managed by the DB cluster.)\n + RDS Custom" + }, + "MonitoringInterval": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0. The default is 0.\n If ``MonitoringRoleArn`` is specified, then you must set ``MonitoringInterval`` to a value other than 0.\n This setting doesn't apply to RDS Custom.\n Valid Values: ``0, 1, 5, 10, 15, 30, 60``" + }, + "MonitoringRoleArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, ``arn:aws:iam:123456789012:role/emaccess``. For information on creating a monitoring role, see [Setting Up and Enabling Enhanced Monitoring](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling) in the *Amazon RDS User Guide*.\n If ``MonitoringInterval`` is set to a value other than ``0``, then you must supply a ``MonitoringRoleArn`` value.\n This setting doesn't apply to RDS Custom DB instances." + }, + "MultiAZ": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Specifies whether the database instance is a Multi-AZ DB instance deployment. You can't set the ``AvailabilityZone`` parameter if the ``MultiAZ`` parameter is set to true. \n For more information, see [Multi-AZ deployments for high availability](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.MultiAZ.html) in the *Amazon RDS User Guide*.\n *Amazon Aurora* \n Not applicable. Amazon Aurora storage is replicated across all of the Availability Zones and doesn't require the ``MultiAZ`` option to be set." + }, + "NcharCharacterSetName": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The name of the NCHAR character set for the Oracle DB instance.\n This setting doesn't apply to RDS Custom DB instances." + }, + "NetworkType": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The network type of the DB instance.\n Valid values:\n + ``IPV4`` \n + ``DUAL`` \n \n The network type is determined by the ``DBSubnetGroup`` specified for the DB instance. A ``DBSubnetGroup`` can support only the IPv4 protocol or the IPv4 and IPv6 protocols (``DUAL``).\n For more information, see [Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the *Amazon RDS User Guide.*" + }, + "OptionGroupName": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Indicates that the DB instance should be associated with the specified option group.\n Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance." + }, + "PerformanceInsightsKMSKeyId": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The AWS KMS key identifier for encryption of Performance Insights data.\n The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n If you do not specify a value for ``PerformanceInsightsKMSKeyId``, then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region.\n For 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)." + }, + "PerformanceInsightsRetentionPeriod": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "The number of days to retain Performance Insights data.\n This setting doesn't apply to RDS Custom DB instances.\n Valid Values:\n + ``7`` \n + *month* * 31, where *month* is a number of months from 1-23. Examples: ``93`` (3 months * 31), ``341`` (11 months * 31), ``589`` (19 months * 31)\n + ``731`` \n \n Default: ``7`` days\n If you specify a retention period that isn't valid, such as ``94``, Amazon RDS returns an error." + }, + "Port": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The port number on which the database accepts connections.\n *Amazon Aurora* \n Not applicable. The port number is managed by the DB cluster.\n *Db2* \n Default value: ``50000``" + }, + "PreferredBackupWindow": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The daily time range during which automated backups are created if automated backups are enabled, using the ``BackupRetentionPeriod`` parameter. For more information, see [Backup Window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow) in the *Amazon RDS User Guide.* \n Constraints:\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 \n *Amazon Aurora* \n Not applicable. The daily time range for creating automated backups is managed by the DB cluster." + }, + "PreferredMaintenanceWindow": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).\n Format: ``ddd:hh24:mi-ddd:hh24:mi`` \n The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see [Adjusting the Preferred DB Instance Maintenance Window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow) in the *Amazon RDS User Guide.* \n This property applies when AWS CloudFormation initially creates the DB instance. If you use AWS CloudFormation to update the DB instance, those updates are applied immediately.\n Constraints: Minimum 30-minute window." + }, + "ProcessorFeatures": { + "type": { + "$ref": "#/43" + }, + "flags": 0, + "description": "The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.\n This setting doesn't apply to Amazon Aurora or RDS Custom DB instances." + }, + "PromotionTier": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see [Fault Tolerance for an Aurora DB Cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.AuroraHighAvailability.html#Aurora.Managing.FaultTolerance) in the *Amazon Aurora User Guide*.\n This setting doesn't apply to RDS Custom DB instances.\n Default: ``1`` \n Valid Values: ``0 - 15``" + }, + "PubliclyAccessible": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Indicates whether the DB instance is an internet-facing instance. If you specify true, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address. \n The default behavior value depends on your VPC setup and the database subnet group. For more information, see the ``PubliclyAccessible`` parameter in the [CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) in the *Amazon RDS API Reference*." + }, + "ReplicaMode": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The open mode of an Oracle read replica. For more information, see [Working with Oracle Read Replicas for Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html) in the *Amazon RDS User Guide*.\n This setting is only supported in RDS for Oracle.\n Default: ``open-read-only`` \n Valid Values: ``open-read-only`` or ``mounted``" + }, + "RestoreTime": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The date and time to restore from.\n Constraints:\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.\n \n Example: ``2009-09-07T23:45:00Z``" + }, + "SourceDBClusterIdentifier": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas.\n Constraints:\n + Must be the identifier of an existing Multi-AZ DB cluster.\n + Can't be specified if the ``SourceDBInstanceIdentifier`` parameter is also specified.\n + The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0.\n + The source DB cluster must be in the same AWS-Region as the read replica. Cross-Region replication isn't supported." + }, + "SourceDBInstanceAutomatedBackupsArn": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, ``arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE``.\n This setting doesn't apply to RDS Custom." + }, + "SourceDBInstanceIdentifier": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "If you want to create a read replica DB instance, specify the ID of the source DB instance. Each DB instance can have a limited number of read replicas. For more information, see [Working with Read Replicas](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/USER_ReadRepl.html) in the *Amazon RDS User Guide*.\n For information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide*.\n The ``SourceDBInstanceIdentifier`` property determines whether a DB instance is a read replica. If you remove the ``SourceDBInstanceIdentifier`` property from your template and then update your stack, AWS CloudFormation promotes the read replica to a standalone DB instance.\n If you specify the ``UseLatestRestorableTime`` or ``RestoreTime`` properties in conjunction with the ``SourceDBInstanceIdentifier`` property, RDS restores the DB instance to the requested point in time, thereby creating a new DB instance.\n + If you specify a source DB instance that uses VPC security groups, we recommend that you specify the ``VPCSecurityGroups`` property. If you don't specify the property, the read replica inherits the value of the ``VPCSecurityGroups`` property from the source DB when you create the replica. However, if you update the stack, AWS CloudFormation reverts the replica's ``VPCSecurityGroups`` property to the default value because it's not defined in the stack's template. This change might cause unexpected issues.\n + Read replicas don't support deletion policies. AWS CloudFormation ignores any deletion policy that's associated with a read replica.\n + If you specify ``SourceDBInstanceIdentifier``, don't specify the ``DBSnapshotIdentifier`` property. You can't create a read replica from a snapshot.\n + Don't set the ``BackupRetentionPeriod``, ``DBName``, ``MasterUsername``, ``MasterUserPassword``, and ``PreferredBackupWindow`` properties. The database attributes are inherited from the source DB instance, and backups are disabled for read replicas.\n + If the source DB instance is in a different region than the read replica, specify the source region in ``SourceRegion``, and specify an ARN for a valid DB instance in ``SourceDBInstanceIdentifier``. For more information, see [Constructing a Amazon RDS Amazon Resource Name (ARN)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html#USER_Tagging.ARN) in the *Amazon RDS User Guide*.\n + For DB instances in Amazon Aurora clusters, don't specify this property. Amazon RDS automatically assigns writer and reader DB instances." + }, + "SourceDbiResourceId": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The resource ID of the source DB instance from which to restore." + }, + "SourceRegion": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The ID of the region that contains the source DB instance for the read replica." + }, + "StorageEncrypted": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.\n If you specify the ``KmsKeyId`` property, then you must enable encryption.\n If you specify the ``SourceDBInstanceIdentifier`` or ``SourceDbiResourceId`` property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specified ``KmsKeyId`` property is used.\n If you specify the ``SourceDBInstanceAutomatedBackupsArn`` property, don't specify this property. The value is inherited from the source DB instance automated backup. \n If you specify ``DBSnapshotIdentifier`` property, don't specify this property. The value is inherited from the snapshot.\n *Amazon Aurora* \n Not applicable. The encryption for DB instances is managed by the DB cluster." + }, + "StorageThroughput": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "Specifies the storage throughput value for the DB instance. This setting applies only to the ``gp3`` storage type. \n This setting doesn't apply to RDS Custom or Amazon Aurora." + }, + "StorageType": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The storage type to associate with the DB instance.\n If you specify ``io1``, ``io2``, or ``gp3``, you must also include a value for the ``Iops`` parameter.\n This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster.\n Valid Values: ``gp2 | gp3 | io1 | io2 | standard`` \n Default: ``io1``, if the ``Iops`` parameter is specified. Otherwise, ``gp2``." + }, + "Tags": { + "type": { + "$ref": "#/44" + }, + "flags": 0, + "description": "An optional array of key-value pairs to apply to this DB instance." + }, + "TdeCredentialArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "" + }, + "TdeCredentialPassword": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "" + }, + "Timezone": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The time zone of the DB instance. The time zone parameter is currently supported only by [RDS for Db2](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-time-zone) and [RDS for SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone)." + }, + "UseDefaultProcessorFeatures": { + "type": { + "$ref": "#/4" + }, + "flags": 4, + "description": "Specifies whether the DB instance class of the DB instance uses its default processor features.\n This setting doesn't apply to RDS Custom DB instances." + }, + "UseLatestRestorableTime": { + "type": { + "$ref": "#/4" + }, + "flags": 4, + "description": "Specifies whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time.\n Constraints:\n + Can't be specified if the ``RestoreTime`` parameter is provided." + }, + "VPCSecurityGroups": { + "type": { + "$ref": "#/45" + }, + "flags": 0, + "description": "A list of the VPC security group IDs to assign to the DB instance. The list can include both the physical IDs of existing VPC security groups and references to [AWS::EC2::SecurityGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html) resources created in the template.\n If you plan to update the resource, don't specify VPC security groups in a shared VPC.\n If you set ``VPCSecurityGroups``, you must not set [DBSecurityGroups](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups), and vice versa.\n You can migrate a DB instance in your stack from an RDS DB security group to a VPC security group, but keep the following in mind:\n + You can't revert to using an RDS security group after you establish a VPC security group membership.\n + When you migrate your DB instance to VPC security groups, if your stack update rolls back because the DB instance update fails or because an update fails in another AWS CloudFormation resource, the rollback fails because it can't revert to an RDS security group.\n + To use the properties that are available when you use a VPC security group, you must recreate the DB instance. If you don't, AWS CloudFormation submits only the property values that are listed in the [DBSecurityGroups](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups) property.\n \n To avoid this situation, migrate your DB instance to using VPC security groups only when that is the only change in your stack template. \n *Amazon Aurora* \n Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. If specified, the setting must match the DB cluster setting." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.RDS/DBInstance", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/46" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.RDS/DBInstance@default", + "scopeType": 0, + "body": { + "$ref": "#/47" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "A 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}_.:/=+\\\\-@]*)$\")." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A 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}_.:/=+\\\\-@]*)$\")." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.RDS/DBParameterGroupProperties" + }, + { + "$type": "ObjectType", + "name": "DBParameterGroup_Parameters", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/49" + } + }, + { + "$type": "ObjectType", + "name": "AWS.RDS/DBParameterGroupProperties", + "properties": { + "DBParameterGroupName": { + "type": { + "$ref": "#/1" + }, + "flags": 16, + "description": "The name of the DB parameter group.\n Constraints:\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\n \n If you don't specify a value for ``DBParameterGroupName`` property, a name is automatically created for the DB parameter group.\n This value is stored as a lowercase string." + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Provides the customer-specified description for this DB parameter group." + }, + "Family": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a DB engine and engine version compatible with that DB parameter group family.\n The DB parameter group family can't be changed when updating a DB parameter group.\n To list all of the available parameter group families, use the following command:\n ``aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\"`` \n The output contains duplicates.\n For more information, see ``CreateDBParameterGroup``." + }, + "Parameters": { + "type": { + "$ref": "#/51" + }, + "flags": 0, + "description": "An array of parameter names and values for the parameter update. At least one parameter name and value must be supplied. Subsequent arguments are optional.\n RDS for Db2 requires you to bring your own Db2 license. You must enter your IBM customer ID (``rds.ibm_customer_id``) and site number (``rds.ibm_site_id``) before starting a Db2 instance.\n For more information about DB parameters and DB parameter groups for Amazon RDS DB engines, see [Working with DB Parameter Groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the *Amazon RDS User Guide*.\n For more information about DB cluster and DB instance parameters and parameter groups for Amazon Aurora DB engines, see [Working with DB Parameter Groups and DB Cluster Parameter Groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*.\n AWS CloudFormation doesn't support specifying an apply method for each individual parameter. The default apply method for each parameter is used." + }, + "Tags": { + "type": { + "$ref": "#/52" + }, + "flags": 0, + "description": "An optional array of key-value pairs to apply to this DB parameter group.\n Currently, this is the only property that supports drift detection." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.RDS/DBParameterGroup", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/53" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.RDS/DBParameterGroup@default", + "scopeType": 0, + "body": { + "$ref": "#/54" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AuthFormat", + "properties": { + "AuthScheme": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The type of authentication that the proxy uses for connections from the proxy to the underlying database. " + }, + "ClientPasswordAuthType": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The type of authentication the proxy uses for connections from clients." + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A user-specified description about the authentication used by a proxy to log in as a specific database user. " + }, + "IAMAuth": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server." + }, + "SecretArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager. " + } + } + }, + { + "$type": "ObjectType", + "name": "TagFormat", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.RDS/DBProxyProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/56" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/57" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "AWS.RDS/DBProxyProperties", + "properties": { + "Auth": { + "type": { + "$ref": "#/59" + }, + "flags": 1, + "description": "The authorization mechanism that the proxy uses." + }, + "DBProxyArn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) for the proxy." + }, + "DBProxyName": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region." + }, + "DebugLogging": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Whether the proxy includes detailed information about SQL statements in its logs." + }, + "Endpoint": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The endpoint that you can use to connect to the proxy. You include the endpoint value in the connection string for a database client application." + }, + "EngineFamily": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The kinds of databases that the proxy can connect to." + }, + "IdleClientTimeout": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it." + }, + "RequireTLS": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy." + }, + "RoleArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager." + }, + "Tags": { + "type": { + "$ref": "#/60" + }, + "flags": 0, + "description": "An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy." + }, + "VpcId": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "VPC ID to associate with the new DB proxy." + }, + "VpcSecurityGroupIds": { + "type": { + "$ref": "#/61" + }, + "flags": 0, + "description": "VPC security group IDs to associate with the new proxy." + }, + "VpcSubnetIds": { + "type": { + "$ref": "#/62" + }, + "flags": 1, + "description": "VPC subnet IDs to associate with the new proxy." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.RDS/DBProxy", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/63" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.RDS/DBProxy@default", + "scopeType": 0, + "body": { + "$ref": "#/64" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "TagFormat", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.RDS/DBProxyEndpointProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/66" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "AWS.RDS/DBProxyEndpointProperties", + "properties": { + "DBProxyEndpointArn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) for the DB proxy endpoint." + }, + "DBProxyEndpointName": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The identifier for the DB proxy endpoint. This name must be unique for all DB proxy endpoints owned by your AWS account in the specified AWS Region." + }, + "DBProxyName": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region." + }, + "Endpoint": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application." + }, + "IsDefault": { + "type": { + "$ref": "#/4" + }, + "flags": 2, + "description": "A value that indicates whether this endpoint is the default endpoint for the associated DB proxy. Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the DB proxy can be either read/write or read-only." + }, + "Tags": { + "type": { + "$ref": "#/68" + }, + "flags": 0, + "description": "An optional set of key-value pairs to associate arbitrary data of your choosing with the DB proxy endpoint." + }, + "TargetRole": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations." + }, + "VpcId": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "VPC ID to associate with the new DB proxy endpoint." + }, + "VpcSecurityGroupIds": { + "type": { + "$ref": "#/69" + }, + "flags": 0, + "description": "VPC security group IDs to associate with the new DB proxy endpoint." + }, + "VpcSubnetIds": { + "type": { + "$ref": "#/70" + }, + "flags": 1, + "description": "VPC subnet IDs to associate with the new DB proxy endpoint." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.RDS/DBProxyEndpoint", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/71" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.RDS/DBProxyEndpoint@default", + "scopeType": 0, + "body": { + "$ref": "#/72" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "ConnectionPoolConfigurationInfoFormat", + "properties": { + "ConnectionBorrowTimeout": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "The number of seconds for a proxy to wait for a connection to become available in the connection pool." + }, + "InitQuery": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "One or more SQL statements for the proxy to run when opening each new database connection." + }, + "MaxConnectionsPercent": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "The maximum size of the connection pool for each target in a target group." + }, + "MaxIdleConnectionsPercent": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "Controls how actively the proxy closes idle database connections in the connection pool." + }, + "SessionPinningFilters": { + "type": { + "$ref": "#/75" + }, + "flags": 0, + "description": "Each item in the list represents a class of SQL operations that normally cause all later statements in a session using a proxy to be pinned to the same underlying database connection." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.RDS/DBProxyTargetGroupProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "AWS.RDS/DBProxyTargetGroupProperties", + "properties": { + "ConnectionPoolConfigurationInfo": { + "type": { + "$ref": "#/74" + }, + "flags": 0 + }, + "DBClusterIdentifiers": { + "type": { + "$ref": "#/77" + }, + "flags": 0 + }, + "DBInstanceIdentifiers": { + "type": { + "$ref": "#/78" + }, + "flags": 0 + }, + "DBProxyName": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The identifier for the proxy." + }, + "TargetGroupArn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) representing the target group." + }, + "TargetGroupName": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The identifier for the DBProxyTargetGroup" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.RDS/DBProxyTargetGroup", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/79" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.RDS/DBProxyTargetGroup@default", + "scopeType": 0, + "body": { + "$ref": "#/80" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "A 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}_.:/=+\\\\-@]*)$\")." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A 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}_.:/=+\\\\-@]*)$\")." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.RDS/DBSubnetGroupProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/82" + } + }, + { + "$type": "ObjectType", + "name": "AWS.RDS/DBSubnetGroupProperties", + "properties": { + "DBSubnetGroupDescription": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The description for the DB subnet group." + }, + "DBSubnetGroupName": { + "type": { + "$ref": "#/1" + }, + "flags": 16, + "description": "The name for the DB subnet group. This value is stored as a lowercase string.\n Constraints: Must contain no more than 255 lowercase alphanumeric characters or hyphens. Must not be \"Default\".\n Example: ``mysubnetgroup``" + }, + "SubnetIds": { + "type": { + "$ref": "#/84" + }, + "flags": 5, + "description": "The EC2 Subnet IDs for the DB subnet group." + }, + "Tags": { + "type": { + "$ref": "#/85" + }, + "flags": 0, + "description": "An optional array of key-value pairs to apply to this DB subnet group." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.RDS/DBSubnetGroup", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/86" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.RDS/DBSubnetGroup@default", + "scopeType": 0, + "body": { + "$ref": "#/87" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.RDS/EventSubscriptionProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/89" + } + }, + { + "$type": "ObjectType", + "name": "AWS.RDS/EventSubscriptionProperties", + "properties": { + "Enabled": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it." + }, + "EventCategories": { + "type": { + "$ref": "#/91" + }, + "flags": 0, + "description": "A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action." + }, + "SnsTopicArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it." + }, + "SourceIds": { + "type": { + "$ref": "#/92" + }, + "flags": 0, + "description": "The list of identifiers of the event sources for which events will be 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 cannot end with a hyphen or contain two consecutive hyphens." + }, + "SourceType": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The type of source that will be generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned." + }, + "SubscriptionName": { + "type": { + "$ref": "#/1" + }, + "flags": 16, + "description": "The name of the subscription." + }, + "Tags": { + "type": { + "$ref": "#/93" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.RDS/EventSubscription", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/94" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.RDS/EventSubscription@default", + "scopeType": 0, + "body": { + "$ref": "#/95" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.RDS/GlobalClusterProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.RDS/GlobalClusterProperties", + "properties": { + "DeletionProtection": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The deletion protection setting for the new global database. The global database can't be deleted when deletion protection is enabled." + }, + "Engine": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora).\nIf you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the cluster." + }, + "EngineLifecycleSupport": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The life cycle type of the global cluster. You can use this setting to enroll your global cluster into Amazon RDS Extended Support." + }, + "EngineVersion": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The version number of the database engine to use. If you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the cluster." + }, + "GlobalClusterIdentifier": { + "type": { + "$ref": "#/1" + }, + "flags": 16, + "description": "The cluster identifier of the new global database cluster. This parameter is stored as a lowercase string." + }, + "SourceDBClusterIdentifier": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) to use as the primary cluster of the global database. This parameter is optional. This parameter is stored as a lowercase string." + }, + "StorageEncrypted": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": " The storage encryption setting for the new global database cluster.\nIf you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the cluster." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.RDS/GlobalCluster", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/98" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.RDS/GlobalCluster@default", + "scopeType": 0, + "body": { + "$ref": "#/99" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "EncryptionContextMap", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + } + } + }, + { + "$type": "ObjectType", + "name": "Tags", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/102" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.RDS/IntegrationProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/102" + } + }, + { + "$type": "ObjectType", + "name": "AWS.RDS/IntegrationProperties", + "properties": { + "AdditionalEncryptionContext": { + "type": { + "$ref": "#/101" + }, + "flags": 0 + }, + "CreateTime": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "DataFilter": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The data filter for the integration." + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The description of the integration." + }, + "IntegrationArn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The ARN of the integration." + }, + "IntegrationName": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The name of the integration." + }, + "KMSKeyId": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "An optional AWS Key Management System (AWS KMS) key ARN for the key used to to encrypt the integration. The resource accepts the key ID and the key ARN forms. The key ID form can be used if the KMS key is owned by te same account. If the KMS key belongs to a different account than the calling account, the full key ARN must be specified. Do not use the key alias or the key alias ARN as this will cause a false drift of the resource." + }, + "SourceArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of the Aurora DB cluster to use as the source for replication." + }, + "Tags": { + "type": { + "$ref": "#/106" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + }, + "TargetArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The ARN of the Redshift data warehouse to use as the target for replication." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.RDS/Integration", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/107" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.RDS/Integration@default", + "scopeType": 0, + "body": { + "$ref": "#/108" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "OptionConfiguration", + "properties": { + "DBSecurityGroupMemberships": { + "type": { + "$ref": "#/113" + }, + "flags": 0, + "description": "A list of DBSecurityGroupMembership name strings used for this option." + }, + "OptionName": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The configuration of options to include in a group." + }, + "OptionSettings": { + "type": { + "$ref": "#/114" + }, + "flags": 0, + "description": "The option settings to include in an option group." + }, + "OptionVersion": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The version for the option." + }, + "Port": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "The optional port for the option." + }, + "VpcSecurityGroupMemberships": { + "type": { + "$ref": "#/115" + }, + "flags": 0, + "description": "A list of VpcSecurityGroupMembership name strings used for this option." + } + } + }, + { + "$type": "ObjectType", + "name": "OptionSetting", + "properties": { + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The name of the option that has settings that you can set." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The current value of the option setting." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/111" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.RDS/OptionGroupProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/110" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/112" + } + }, + { + "$type": "ObjectType", + "name": "AWS.RDS/OptionGroupProperties", + "properties": { + "EngineName": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Indicates the name of the engine that this option group can be applied to." + }, + "MajorEngineVersion": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Indicates the major engine version associated with this option group." + }, + "OptionConfigurations": { + "type": { + "$ref": "#/117" + }, + "flags": 0, + "description": "Indicates what options are available in the option group." + }, + "OptionGroupDescription": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Provides a description of the option group." + }, + "OptionGroupName": { + "type": { + "$ref": "#/1" + }, + "flags": 16, + "description": "Specifies the name of the option group." + }, + "Tags": { + "type": { + "$ref": "#/118" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.RDS/OptionGroup", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/119" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.RDS/OptionGroup@default", + "scopeType": 0, + "body": { + "$ref": "#/120" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.rds/default/types.md b/artifacts/bicep/aws/aws.rds/default/types.md index d52b89df..a0e4163c 100644 --- a/artifacts/bicep/aws/aws.rds/default/types.md +++ b/artifacts/bicep/aws/aws.rds/default/types.md @@ -3,104 +3,125 @@ ## Resource AWS.RDS/CustomDBEngineVersion@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.RDS/CustomDBEngineVersionProperties](#awsrdscustomdbengineversionproperties) (Required): properties of the resource +* **properties**: [AWS.RDS/CustomDBEngineVersionProperties](#awsrdscustomdbengineversionproperties) (Required, Identifier): properties of the resource ## Resource AWS.RDS/DBCluster@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.RDS/DBClusterProperties](#awsrdsdbclusterproperties): properties of the resource +* **properties**: [AWS.RDS/DBClusterProperties](#awsrdsdbclusterproperties) (Identifier): properties of the resource ## Resource AWS.RDS/DBClusterParameterGroup@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.RDS/DBClusterParameterGroupProperties](#awsrdsdbclusterparametergroupproperties) (Required): properties of the resource +* **properties**: [AWS.RDS/DBClusterParameterGroupProperties](#awsrdsdbclusterparametergroupproperties) (Required, Identifier): properties of the resource ## Resource AWS.RDS/DBInstance@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.RDS/DBInstanceProperties](#awsrdsdbinstanceproperties): properties of the resource +* **properties**: [AWS.RDS/DBInstanceProperties](#awsrdsdbinstanceproperties) (Identifier): properties of the resource ## Resource AWS.RDS/DBParameterGroup@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.RDS/DBParameterGroupProperties](#awsrdsdbparametergroupproperties) (Required): properties of the resource +* **properties**: [AWS.RDS/DBParameterGroupProperties](#awsrdsdbparametergroupproperties) (Required, Identifier): properties of the resource ## Resource AWS.RDS/DBProxy@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.RDS/DBProxyProperties](#awsrdsdbproxyproperties) (Required): properties of the resource +* **properties**: [AWS.RDS/DBProxyProperties](#awsrdsdbproxyproperties) (Required, Identifier): properties of the resource ## Resource AWS.RDS/DBProxyEndpoint@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.RDS/DBProxyEndpointProperties](#awsrdsdbproxyendpointproperties) (Required): properties of the resource +* **properties**: [AWS.RDS/DBProxyEndpointProperties](#awsrdsdbproxyendpointproperties) (Required, Identifier): properties of the resource ## Resource AWS.RDS/DBProxyTargetGroup@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.RDS/DBProxyTargetGroupProperties](#awsrdsdbproxytargetgroupproperties) (Required): properties of the resource +* **properties**: [AWS.RDS/DBProxyTargetGroupProperties](#awsrdsdbproxytargetgroupproperties) (Required, Identifier): properties of the resource ## Resource AWS.RDS/DBSubnetGroup@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.RDS/DBSubnetGroupProperties](#awsrdsdbsubnetgroupproperties) (Required): properties of the resource +* **properties**: [AWS.RDS/DBSubnetGroupProperties](#awsrdsdbsubnetgroupproperties) (Required, Identifier): properties of the resource ## Resource AWS.RDS/EventSubscription@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.RDS/EventSubscriptionProperties](#awsrdseventsubscriptionproperties) (Required): properties of the resource +* **properties**: [AWS.RDS/EventSubscriptionProperties](#awsrdseventsubscriptionproperties) (Required, Identifier): properties of the resource ## Resource AWS.RDS/GlobalCluster@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.RDS/GlobalClusterProperties](#awsrdsglobalclusterproperties): properties of the resource +* **properties**: [AWS.RDS/GlobalClusterProperties](#awsrdsglobalclusterproperties) (Identifier): properties of the resource + +## Resource AWS.RDS/Integration@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.RDS/IntegrationProperties](#awsrdsintegrationproperties) (Required, Identifier): properties of the resource ## Resource AWS.RDS/OptionGroup@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.RDS/OptionGroupProperties](#awsrdsoptiongroupproperties) (Required): properties of the resource +* **properties**: [AWS.RDS/OptionGroupProperties](#awsrdsoptiongroupproperties) (Required, Identifier): properties of the resource + +## AuthFormat +### Properties +* **AuthScheme**: string: The type of authentication that the proxy uses for connections from the proxy to the underlying database. +* **ClientPasswordAuthType**: string: The type of authentication the proxy uses for connections from clients. +* **Description**: string: A user-specified description about the authentication used by a proxy to log in as a specific database user. +* **IAMAuth**: string: Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server. +* **SecretArn**: string: The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager. ## AWS.RDS/CustomDBEngineVersionProperties ### Properties -* **DatabaseInstallationFilesS3BucketName**: string (Required): The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is `my-custom-installation-files`. +* **DatabaseInstallationFilesS3BucketName**: string: The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is `my-custom-installation-files`. * **DatabaseInstallationFilesS3Prefix**: string: The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is `123456789012/cev1`. If this setting isn't specified, no prefix is assumed. * **DBEngineVersionArn**: string (ReadOnly): The ARN of the custom engine version. * **Description**: string: An optional description of your CEV. * **Engine**: string (Required, Identifier): The database engine to use for your custom engine version (CEV). The only supported value is `custom-oracle-ee`. * **EngineVersion**: string (Required, Identifier): The name of your CEV. The name format is 19.customized_string . For example, a valid name is 19.my_cev1. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Region. +* **ImageId**: string: The identifier of Amazon Machine Image (AMI) used for CEV. * **KMSKeyId**: string: The AWS KMS key identifier for an encrypted CEV. A symmetric KMS key is required for RDS Custom, but optional for Amazon RDS. * **Manifest**: string (WriteOnly): The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed. +* **SourceCustomDbEngineVersionIdentifier**: string (WriteOnly): The identifier of the source custom engine version. * **Status**: string: The availability status to be assigned to the CEV. * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. +* **UseAwsProvidedLatestImage**: bool (WriteOnly): A value that indicates whether AWS provided latest image is applied automatically to the Custom Engine Version. By default, AWS provided latest image is applied automatically. This value is only applied on create. -## Tag +## AWS.RDS/DBClusterParameterGroupProperties ### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **DBClusterParameterGroupName**: string (Identifier) +* **Description**: string (Required): A friendly description for this DB cluster parameter group. +* **Family**: string (Required): The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a DB engine and engine version compatible with that DB cluster parameter group family. +* **Parameters**: [DBClusterParameterGroup_Parameters](#dbclusterparametergroupparameters) (Required): An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request. +* **Tags**: [Tag](#tag)[]: The list of tags for the cluster parameter group. ## AWS.RDS/DBClusterProperties ### Properties @@ -125,10 +146,12 @@ * **DomainIAMRoleName**: string: Specify the name of the IAM role to be used when making API calls to the Directory Service. * **EnableCloudwatchLogsExports**: string[]: The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide. * **EnableGlobalWriteForwarding**: bool: Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database. -* **EnableHttpEndpoint**: bool: A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled. +* **EnableHttpEndpoint**: bool: A value that indicates whether to enable the HTTP endpoint for DB cluster. By default, the HTTP endpoint is disabled. * **EnableIAMDatabaseAuthentication**: bool: A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. +* **EnableLocalWriteForwarding**: bool: Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances. * **Endpoint**: [Endpoint](#endpoint) (ReadOnly) * **Engine**: string: The name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql +* **EngineLifecycleSupport**: string: The life cycle type of the DB cluster. You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. * **EngineMode**: string: The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster. * **EngineVersion**: string: The version number of the database engine to use. * **GlobalClusterIdentifier**: string: If you are configuring an Aurora global database cluster and want your Aurora DB cluster to be a secondary member in the global database cluster, specify the global cluster ID of the global database cluster. To define the primary database cluster of the global cluster, use the AWS::RDS::GlobalCluster resource. @@ -165,221 +188,571 @@ After you restore a DB cluster with a SnapshotIdentifier property, you must spec * **SourceRegion**: string (WriteOnly): The AWS Region which contains the source DB cluster when replicating a DB cluster. For example, us-east-1. * **StorageEncrypted**: bool: Indicates whether the DB instance is encrypted. If you specify the DBClusterIdentifier, SnapshotIdentifier, or SourceDBInstanceIdentifier property, don't specify this property. The value is inherited from the cluster, snapshot, or source DB instance. +* **StorageThroughput**: int (ReadOnly): Specifies the storage throughput value for the DB cluster. This setting applies only to the gp3 storage type. * **StorageType**: string: Specifies the storage type to be associated with the DB cluster. * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. * **UseLatestRestorableTime**: bool (WriteOnly): A value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster is not restored to the latest restorable backup time. * **VpcSecurityGroupIds**: string[]: A list of EC2 VPC security groups to associate with this DB cluster. -## DBClusterRole -### Properties -* **FeatureName**: string: The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion in the Amazon RDS API Reference. -* **RoleArn**: string (Required): The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster. - -## Endpoint -### Properties -* **Address**: string (ReadOnly): The connection endpoint for the DB cluster. -* **Port**: string (ReadOnly): The port number that will accept connections on this DB cluster. - -## MasterUserSecret -### Properties -* **KmsKeyId**: string: The AWS KMS key identifier that is used to encrypt the secret. -* **SecretArn**: string (ReadOnly): The Amazon Resource Name (ARN) of the secret. - -## ReadEndpoint -### Properties -* **Address**: string (ReadOnly): The reader endpoint for the DB cluster. - -## ScalingConfiguration -### Properties -* **AutoPause**: bool: A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections). -* **MaxCapacity**: int: The maximum capacity for an Aurora DB cluster in serverless DB engine mode. -For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. -For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384. -The maximum capacity must be greater than or equal to the minimum capacity. -* **MinCapacity**: int: The minimum capacity for an Aurora DB cluster in serverless DB engine mode. -For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. -For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384. -The minimum capacity must be less than or equal to the maximum capacity. -* **SecondsBeforeTimeout**: int: The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. -The default is 300. -* **SecondsUntilAutoPause**: int: The time, in seconds, before an Aurora DB cluster in serverless mode is paused. -* **TimeoutAction**: string: The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange. -ForceApplyCapacityChange sets the capacity to the specified value as soon as possible. -RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period. - -For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide. - -## ServerlessV2ScalingConfiguration -### Properties -* **MaxCapacity**: int: The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128. -* **MinCapacity**: int: The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5. - -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - -## AWS.RDS/DBClusterParameterGroupProperties -### Properties -* **DBClusterParameterGroupName**: string (Identifier) -* **Description**: string (Required): A friendly description for this DB cluster parameter group. -* **Family**: string (Required): The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a DB engine and engine version compatible with that DB cluster parameter group family. -* **Parameters**: [DBClusterParameterGroup_Parameters](#dbclusterparametergroupparameters) (Required): An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request. -* **Tags**: [Tag](#tag)[]: The list of tags for the cluster parameter group. - -## DBClusterParameterGroup_Parameters -### Properties - -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## AWS.RDS/DBInstanceProperties ### Properties -* **AllocatedStorage**: string: The amount of storage (in gigabytes) to be initially allocated for the database instance. +* **AllocatedStorage**: string: The amount of storage in gibibytes (GiB) to be initially allocated for the database instance. + If any value is set in the ``Iops`` parameter, ``AllocatedStorage`` must be at least 100 GiB, which corresponds to the minimum Iops value of 1,000. If you increase the ``Iops`` value (in 1,000 IOPS increments), then you must also increase the ``AllocatedStorage`` value (in 100-GiB increments). + *Amazon Aurora* + Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume. + *Db2* + Constraints to the amount of storage for each storage type are the following: + + General Purpose (SSD) storage (gp3): Must be an integer from 20 to 64000. + + Provisioned IOPS storage (io1): Must be an integer from 100 to 64000. + + *MySQL* + Constraints to the amount of storage for each storage type are the following: + + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + + Magnetic storage (standard): Must be an integer from 5 to 3072. + + *MariaDB* + Constraints to the amount of storage for each storage type are the following: + + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + + Magnetic storage (standard): Must be an integer from 5 to 3072. + + *PostgreSQL* + Constraints to the amount of storage for each storage type are the following: + + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + + Magnetic storage (standard): Must be an integer from 5 to 3072. + + *Oracle* + Constraints to the amount of storage for each storage type are the following: + + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + + Magnetic storage (standard): Must be an integer from 10 to 3072. + + *SQL Server* + Constraints to the amount of storage for each storage type are the following: + + General Purpose (SSD) storage (gp2): + + Enterprise and Standard editions: Must be an integer from 20 to 16384. + + Web and Express editions: Must be an integer from 20 to 16384. + + + Provisioned IOPS storage (io1): + + Enterprise and Standard editions: Must be an integer from 20 to 16384. + + Web and Express editions: Must be an integer from 20 to 16384. + + + Magnetic storage (standard): + + Enterprise and Standard editions: Must be an integer from 20 to 1024. + + Web and Express editions: Must be an integer from 20 to 1024. * **AllowMajorVersionUpgrade**: bool (WriteOnly): A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. -* **AssociatedRoles**: [DBInstanceRole](#dbinstancerole)[]: The AWS Identity and Access Management (IAM) roles associated with the DB instance. -* **AutomaticBackupReplicationRegion**: string: Enables replication of automated backups to a different Amazon Web Services Region. + Constraints: Major version upgrades must be allowed when specifying a value for the ``EngineVersion`` parameter that is a different major version than the DB instance's current version. +* **AssociatedRoles**: [DBInstanceRole](#dbinstancerole)[]: The IAMlong (IAM) roles associated with the DB instance. + *Amazon Aurora* + Not applicable. The associated roles are managed by the DB cluster. +* **AutomaticBackupReplicationKmsKeyId**: string (WriteOnly): The AWS KMS key identifier for encryption of the replicated automated backups. The KMS key ID is the Amazon Resource Name (ARN) for the KMS encryption key in the destination AWS-Region, for example, ``arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE``. +* **AutomaticBackupReplicationRegion**: string: The destination region for the backup replication of the DB instance. For more info, see [Replicating automated backups to another Region](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReplicateBackups.html) in the *Amazon RDS User Guide*. * **AutoMinorVersionUpgrade**: bool: A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically. -* **AvailabilityZone**: string: The Availability Zone (AZ) where the database will be created. For information on AWS Regions and Availability Zones. +* **AvailabilityZone**: string: The Availability Zone (AZ) where the database will be created. For information on AWS-Regions and Availability Zones, see [Regions and Availability Zones](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html). + For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one. + Default: A random, system-chosen Availability Zone in the endpoint's AWS-Region. + Constraints: + + The ``AvailabilityZone`` parameter can't be specified if the DB instance is a Multi-AZ deployment. + + The specified Availability Zone must be in the same AWS-Region as the current endpoint. + + Example: ``us-east-1d`` * **BackupRetentionPeriod**: int: The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. + *Amazon Aurora* + Not applicable. The retention period for automated backups is managed by the DB cluster. + Default: 1 + Constraints: + + Must be a value from 0 to 35 + + Can't be set to 0 if the DB instance is a source to read replicas * **CACertificateIdentifier**: string: The identifier of the CA certificate for this DB instance. -* **CertificateDetails**: [CertificateDetails](#certificatedetails): Returns the details of the DB instance's server certificate. -* **CertificateRotationRestart**: bool (WriteOnly): A value that indicates whether the DB instance is restarted when you rotate your SSL/TLS certificate. -By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted. -If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate -This setting doesn't apply to RDS Custom. + For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the *Amazon RDS User Guide* and [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 User Guide*. +* **CertificateDetails**: [CertificateDetails](#certificatedetails): The details of the DB instance's server certificate. +* **CertificateRotationRestart**: bool (WriteOnly): Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate. + By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted. + Set this parameter only if you are *not* using SSL/TLS to connect to the DB instance. + If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate: + + For more information about rotating your SSL/TLS certificate for RDS DB engines, see [Rotating Your SSL/TLS Certificate.](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon RDS User Guide.* + + For more information about rotating your SSL/TLS certificate for Aurora DB engines, see [Rotating Your SSL/TLS Certificate](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon Aurora User Guide*. + + This setting doesn't apply to RDS Custom DB instances. * **CharacterSetName**: string: For supported engines, indicates that the DB instance should be associated with the specified character set. -* **CopyTagsToSnapshot**: bool: A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied. -* **CustomIAMInstanceProfile**: string: The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements: - * The profile must exist in your account. - * The profile must have an IAM role that Amazon EC2 has permissions to assume. - * The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom . -For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide . - -This setting is required for RDS Custom. + *Amazon Aurora* + Not applicable. The character set is managed by the DB cluster. For more information, see [AWS::RDS::DBCluster](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html). +* **CopyTagsToSnapshot**: bool: Specifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied. + This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. +* **CustomIAMInstanceProfile**: string: The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. + This setting is required for RDS Custom. + Constraints: + + The profile must exist in your account. + + The profile must have an IAM role that Amazon EC2 has permissions to assume. + + The instance profile name and the associated IAM role name must start with the prefix ``AWSRDSCustom``. + + For the list of permissions required for the IAM role, see [Configure IAM and your VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc) in the *Amazon RDS User Guide*. * **DBClusterIdentifier**: string: The identifier of the DB cluster that the instance will belong to. -* **DBClusterSnapshotIdentifier**: string: The identifier for the RDS for MySQL Multi-AZ DB cluster snapshot to restore from. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide . - -Constraints: - * Must match the identifier of an existing Multi-AZ DB cluster snapshot. - * Can't be specified when DBSnapshotIdentifier is specified. - * Must be specified when DBSnapshotIdentifier isn't specified. - * If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the DBClusterSnapshotIdentifier must be the ARN of the shared snapshot. - * Can't be the identifier of an Aurora DB cluster snapshot. - * Can't be the identifier of an RDS for PostgreSQL Multi-AZ DB cluster snapshot. -* **DBInstanceArn**: string (ReadOnly): The Amazon Resource Name (ARN) for the DB instance. -* **DBInstanceClass**: string: The compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. -* **DBInstanceIdentifier**: string (Identifier): A name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance. -* **DbiResourceId**: string (ReadOnly): The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed. +* **DBClusterSnapshotIdentifier**: string: The identifier for the Multi-AZ DB cluster snapshot to restore from. + For more information on Multi-AZ DB clusters, see [Multi-AZ DB cluster deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide*. + Constraints: + + Must match the identifier of an existing Multi-AZ DB cluster snapshot. + + Can't be specified when ``DBSnapshotIdentifier`` is specified. + + Must be specified when ``DBSnapshotIdentifier`` isn't specified. + + If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the ``DBClusterSnapshotIdentifier`` must be the ARN of the shared snapshot. + + Can't be the identifier of an Aurora DB cluster snapshot. +* **DBInstanceArn**: string (ReadOnly) +* **DBInstanceClass**: string: The compute and memory capacity of the DB instance, for example ``db.m5.large``. Not all DB instance classes are available in all AWS-Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see [DB instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide* or [Aurora DB instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.DBInstanceClass.html) in the *Amazon Aurora User Guide*. +* **DBInstanceIdentifier**: string (Identifier): A name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html). + For information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide*. + If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. +* **DbiResourceId**: string (ReadOnly) * **DBName**: string: The meaning of this parameter differs according to the database engine you use. -* **DBParameterGroupName**: string: The name of an existing DB parameter group or a reference to an AWS::RDS::DBParameterGroup resource created in the template. + If you specify the ``DBSnapshotIdentifier`` property, this property only applies to RDS for Oracle. + *Amazon Aurora* + Not applicable. The database name is managed by the DB cluster. + *Db2* + The 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. + Constraints: + + Must contain 1 to 64 letters or numbers. + + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). + + Can't be a word reserved by the specified database engine. + + *MySQL* + The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. + Constraints: + + Must contain 1 to 64 letters or numbers. + + Can't be a word reserved by the specified database engine + + *MariaDB* + The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. + Constraints: + + Must contain 1 to 64 letters or numbers. + + Can't be a word reserved by the specified database engine + + *PostgreSQL* + The name of the database to create when the DB instance is created. If this parameter is not specified, the default ``postgres`` database is created in the DB instance. + Constraints: + + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). + + Must contain 1 to 63 characters. + + Can't be a word reserved by the specified database engine + + *Oracle* + The Oracle System ID (SID) of the created DB instance. If you specify ``null``, the default value ``ORCL`` is used. You can't specify the string NULL, or any other reserved word, for ``DBName``. + Default: ``ORCL`` + Constraints: + + Can't be longer than 8 characters + + *SQL Server* + Not applicable. Must be null. +* **DBParameterGroupName**: string: The name of an existing DB parameter group or a reference to an [AWS::RDS::DBParameterGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html) resource created in the template. + To list all of the available DB parameter group names, use the following command: + ``aws rds describe-db-parameter-groups --query "DBParameterGroups[].DBParameterGroupName" --output text`` + If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot. + If you don't specify a value for ``DBParameterGroupName`` property, the default DB parameter group for the specified engine and engine version is used. * **DBSecurityGroups**: string[]: A list of the DB security groups to assign to the DB instance. The list can include both the name of existing DB security groups or references to AWS::RDS::DBSecurityGroup resources created in the template. + If you set DBSecurityGroups, you must not set VPCSecurityGroups, and vice versa. Also, note that the DBSecurityGroups property exists only for backwards compatibility with older regions and is no longer recommended for providing security information to an RDS DB instance. Instead, use VPCSecurityGroups. + If you specify this property, AWS CloudFormation sends only the following properties (if specified) to Amazon RDS during create operations: + + ``AllocatedStorage`` + + ``AutoMinorVersionUpgrade`` + + ``AvailabilityZone`` + + ``BackupRetentionPeriod`` + + ``CharacterSetName`` + + ``DBInstanceClass`` + + ``DBName`` + + ``DBParameterGroupName`` + + ``DBSecurityGroups`` + + ``DBSubnetGroupName`` + + ``Engine`` + + ``EngineVersion`` + + ``Iops`` + + ``LicenseModel`` + + ``MasterUsername`` + + ``MasterUserPassword`` + + ``MultiAZ`` + + ``OptionGroupName`` + + ``PreferredBackupWindow`` + + ``PreferredMaintenanceWindow`` + + All other properties are ignored. Specify a virtual private cloud (VPC) security group if you want to submit other properties, such as ``StorageType``, ``StorageEncrypted``, or ``KmsKeyId``. If you're already using the ``DBSecurityGroups`` property, you can't use these other properties by updating your DB instance to use a VPC security group. You must recreate the DB instance. * **DBSnapshotIdentifier**: string (WriteOnly): The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot. -* **DBSubnetGroupName**: string: A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new VPC. -* **DBSystemId**: string (ReadOnly): The Oracle system ID (Oracle SID) for a container database (CDB). The Oracle SID is also the name of the CDB. This setting is valid for RDS Custom only. + By specifying this property, you can create a DB instance from the specified DB snapshot. If the ``DBSnapshotIdentifier`` property is an empty string or the ``AWS::RDS::DBInstance`` declaration has no ``DBSnapshotIdentifier`` property, AWS CloudFormation creates a new database. If the property contains a value (other than an empty string), AWS CloudFormation creates a database from the specified snapshot. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack. + Some DB instance properties aren't valid when you restore from a snapshot, such as the ``MasterUsername`` and ``MasterUserPassword`` properties. For information about the properties that you can specify, see the ``RestoreDBInstanceFromDBSnapshot`` action in the *Amazon RDS API Reference*. + After you restore a DB instance with a ``DBSnapshotIdentifier`` property, you must specify the same ``DBSnapshotIdentifier`` property for any future updates to the DB instance. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify the ``DBSnapshotIdentifier`` property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specified ``DBSnapshotIdentifier`` property, and the original DB instance is deleted. + If you specify the ``DBSnapshotIdentifier`` property to restore a DB instance (as opposed to specifying it for DB instance updates), then don't specify the following properties: + + ``CharacterSetName`` + + ``DBClusterIdentifier`` + + ``DBName`` + + ``DeleteAutomatedBackups`` + + ``EnablePerformanceInsights`` + + ``KmsKeyId`` + + ``MasterUsername`` + + ``MasterUserPassword`` + + ``PerformanceInsightsKMSKeyId`` + + ``PerformanceInsightsRetentionPeriod`` + + ``PromotionTier`` + + ``SourceDBInstanceIdentifier`` + + ``SourceRegion`` + + ``StorageEncrypted`` (for an encrypted snapshot) + + ``Timezone`` + + *Amazon Aurora* + Not applicable. Snapshot restore is managed by the DB cluster. +* **DBSubnetGroupName**: string: A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new VPC. + If there's no DB subnet group, then the DB instance isn't a VPC DB instance. + For more information about using Amazon RDS in a VPC, see [Using Amazon RDS with Amazon Virtual Private Cloud (VPC)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html) in the *Amazon RDS User Guide*. + *Amazon Aurora* + Not applicable. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting. +* **DBSystemId**: string (ReadOnly): The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. In this context, the term "Oracle database instance" refers exclusively to the system global area (SGA) and Oracle background processes. If you don't specify a SID, the value defaults to ``RDSCDB``. The Oracle SID is also the name of your CDB. * **DedicatedLogVolume**: bool: Indicates whether the DB instance has a dedicated log volume (DLV) enabled. * **DeleteAutomatedBackups**: bool (WriteOnly): A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted. -* **DeletionProtection**: bool: A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. -* **Domain**: string: The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain. + *Amazon Aurora* + Not applicable. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the DB cluster are not deleted. +* **DeletionProtection**: bool: A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see [Deleting a DB Instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html). + *Amazon Aurora* + Not applicable. You can enable or disable deletion protection for the DB cluster. For more information, see ``CreateDBCluster``. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster. +* **Domain**: string: The 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. + For more information, see [Kerberos Authentication](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html) in the *Amazon RDS User Guide*. * **DomainAuthSecretArn**: string: The ARN for the Secrets Manager secret with the credentials for the user joining the domain. + Example: ``arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456`` * **DomainDnsIps**: string[]: The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers. + Constraints: + + 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. + + Example: ``123.124.125.126,234.235.236.237`` * **DomainFqdn**: string: The fully qualified domain name (FQDN) of an Active Directory domain. -* **DomainIAMRoleName**: string: Specify the name of the IAM role to be used when making API calls to the Directory Service. + Constraints: + + Can't be longer than 64 characters. + + Example: ``mymanagedADtest.mymanagedAD.mydomain`` +* **DomainIAMRoleName**: string: The name of the IAM role to use when making API calls to the Directory Service. + This setting doesn't apply to the following DB instances: + + Amazon Aurora (The domain is managed by the DB cluster.) + + RDS Custom * **DomainOu**: string: The Active Directory organizational unit for your DB instance to join. -* **EnableCloudwatchLogsExports**: string[]: The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. + Constraints: + + Must be in the distinguished name format. + + Can't be longer than 64 characters. + + Example: ``OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain`` +* **EnableCloudwatchLogsExports**: string[]: The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see [Publishing Database Logs to Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the *Amazon Relational Database Service User Guide*. + *Amazon Aurora* + Not applicable. CloudWatch Logs exports are managed by the DB cluster. + *Db2* + Valid values: ``diag.log``, ``notify.log`` + *MariaDB* + Valid values: ``audit``, ``error``, ``general``, ``slowquery`` + *Microsoft SQL Server* + Valid values: ``agent``, ``error`` + *MySQL* + Valid values: ``audit``, ``error``, ``general``, ``slowquery`` + *Oracle* + Valid values: ``alert``, ``audit``, ``listener``, ``trace``, ``oemagent`` + *PostgreSQL* + Valid values: ``postgresql``, ``upgrade`` * **EnableIAMDatabaseAuthentication**: bool: A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. -* **EnablePerformanceInsights**: bool: A value that indicates whether to enable Performance Insights for the DB instance. -* **Endpoint**: [Endpoint](#endpoint): Specifies the connection endpoint. -* **Engine**: string: The name of the database engine that you want to use for this DB instance. + This property is supported for RDS for MariaDB, RDS for MySQL, and RDS for PostgreSQL. For more information, see [IAM Database Authentication for MariaDB, MySQL, and PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon RDS User Guide.* + *Amazon Aurora* + Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster. +* **EnablePerformanceInsights**: bool: Specifies whether to enable Performance Insights for the DB instance. For more information, see [Using Amazon Performance Insights](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) in the *Amazon RDS User Guide*. + This setting doesn't apply to RDS Custom DB instances. +* **Endpoint**: [Endpoint](#endpoint): The connection endpoint for the DB instance. + The endpoint might not be shown for instances with the status of ``creating``. +* **Engine**: string: The name of the database engine to use for this DB instance. Not every database engine is available in every AWS Region. + This property is required when creating a DB instance. + You can convert an Oracle database from the non-CDB architecture to the container database (CDB) architecture by updating the ``Engine`` value in your templates from ``oracle-ee`` to ``oracle-ee-cdb`` or from ``oracle-se2`` to ``oracle-se2-cdb``. Converting to the CDB architecture requires an interruption. + Valid Values: + + ``aurora-mysql`` (for Aurora MySQL DB instances) + + ``aurora-postgresql`` (for Aurora PostgreSQL DB instances) + + ``custom-oracle-ee`` (for RDS Custom for Oracle DB instances) + + ``custom-oracle-ee-cdb`` (for RDS Custom for Oracle DB instances) + + ``custom-sqlserver-ee`` (for RDS Custom for SQL Server DB instances) + + ``custom-sqlserver-se`` (for RDS Custom for SQL Server DB instances) + + ``custom-sqlserver-web`` (for RDS Custom for SQL Server DB instances) + + ``db2-ae`` + + ``db2-se`` + + ``mariadb`` + + ``mysql`` + + ``oracle-ee`` + + ``oracle-ee-cdb`` + + ``oracle-se2`` + + ``oracle-se2-cdb`` + + ``postgres`` + + ``sqlserver-ee`` + + ``sqlserver-se`` + + ``sqlserver-ex`` + + ``sqlserver-web`` +* **EngineLifecycleSupport**: string * **EngineVersion**: string: The version number of the database engine to use. -* **Iops**: int: The number of I/O operations per second (IOPS) that the database provisions. -* **KmsKeyId**: string: The ARN of the AWS Key Management Service (AWS KMS) master key that's used to encrypt the DB instance. + For a list of valid engine versions, use the ``DescribeDBEngineVersions`` action. + The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region. + *Amazon Aurora* + Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. + *Db2* + See [Amazon RDS for Db2](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Db2.html#Db2.Concepts.VersionMgmt) in the *Amazon RDS User Guide.* + *MariaDB* + See [MariaDB on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt) in the *Amazon RDS User Guide.* + *Microsoft SQL Server* + See [Microsoft SQL Server Versions on Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport) in the *Amazon RDS User Guide.* + *MySQL* + See [MySQL on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt) in the *Amazon RDS User Guide.* + *Oracle* + See [Oracle Database Engine Release Notes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html) in the *Amazon RDS User Guide.* + *PostgreSQL* + See [Supported PostgreSQL Database Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts.General.DBVersions) in the *Amazon RDS User Guide.* +* **Iops**: int: The number of I/O operations per second (IOPS) that the database provisions. The value must be equal to or greater than 1000. + If you specify this property, you must follow the range of allowed ratios of your requested IOPS rate to the amount of storage that you allocate (IOPS to allocated storage). For example, you can provision an Oracle database instance with 1000 IOPS and 200 GiB of storage (a ratio of 5:1), or specify 2000 IOPS with 200 GiB of storage (a ratio of 10:1). For more information, see [Amazon RDS Provisioned IOPS Storage to Improve Performance](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/CHAP_Storage.html#USER_PIOPS) in the *Amazon RDS User Guide*. + If you specify ``io1`` for the ``StorageType`` property, then you must also specify the ``Iops`` property. + Constraints: + + 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. + + For RDS for SQL Server - Must be a multiple between 1 and 50 of the storage amount for the DB instance. +* **KmsKeyId**: string: The ARN of the AWS KMS key that's used to encrypt the DB instance, such as ``arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef``. If you enable the StorageEncrypted property but don't specify this property, AWS CloudFormation uses the default KMS key. If you specify this property, you must set the StorageEncrypted property to true. + If you specify the ``SourceDBInstanceIdentifier`` or ``SourceDbiResourceId`` property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specified ``KmsKeyId`` property is used. However, if the source DB instance is in a different AWS Region, you must specify a KMS key ID. + If you specify the ``SourceDBInstanceAutomatedBackupsArn`` property, don't specify this property. The value is inherited from the source DB instance automated backup, and if the automated backup is encrypted, the specified ``KmsKeyId`` property is used. + If you create an encrypted read replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the region that they're created in, and you can't use encryption keys from one region in another region. + If you specify the ``DBSnapshotIdentifier`` property, don't specify this property. The ``StorageEncrypted`` property value is inherited from the snapshot. If the DB instance is encrypted, the specified ``KmsKeyId`` property is also inherited from the snapshot. + If you specify ``DBSecurityGroups``, AWS CloudFormation ignores this property. To specify both a security group and this property, you must use a VPC security group. For more information about Amazon RDS and VPC, see [Using Amazon RDS with Amazon VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html) in the *Amazon RDS User Guide*. + *Amazon Aurora* + Not applicable. The KMS key identifier is managed by the DB cluster. * **LicenseModel**: string: License model information for this DB instance. -* **ManageMasterUserPassword**: bool: A value that indicates whether to manage the master user password with AWS Secrets Manager. + Valid Values: + + Aurora MySQL - ``general-public-license`` + + Aurora PostgreSQL - ``postgresql-license`` + + RDS for Db2 - ``bring-your-own-license``. For more information about RDS for Db2 licensing, see [](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-licensing.html) in the *Amazon RDS User Guide.* + + RDS for MariaDB - ``general-public-license`` + + RDS for Microsoft SQL Server - ``license-included`` + + RDS for MySQL - ``general-public-license`` + + RDS for Oracle - ``bring-your-own-license`` or ``license-included`` + + RDS for PostgreSQL - ``postgresql-license`` + + If you've specified ``DBSecurityGroups`` and then you update the license model, AWS CloudFormation replaces the underlying DB instance. This will incur some interruptions to database availability. +* **ManageMasterUserPassword**: bool: Specifies whether to manage the master user password with AWS Secrets Manager. + For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide.* + Constraints: + + Can't manage the master user password with AWS Secrets Manager if ``MasterUserPassword`` is specified. * **MasterUsername**: string: The master user name for the DB instance. -* **MasterUserPassword**: string (WriteOnly): The password for the master user. -* **MasterUserSecret**: [MasterUserSecret](#masterusersecret): Contains the secret managed by RDS in AWS Secrets Manager for the master user password. -* **MaxAllocatedStorage**: int: The upper limit to which Amazon RDS can automatically scale the storage of the DB instance. -* **MonitoringInterval**: int: The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. -* **MonitoringRoleArn**: string: The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. -* **MultiAZ**: bool: Specifies whether the database instance is a multiple Availability Zone deployment. -* **NcharCharacterSetName**: string: The name of the NCHAR character set for the Oracle DB instance. This parameter doesn't apply to RDS Custom. -* **NetworkType**: string: The network type of the DB cluster. + If you specify the ``SourceDBInstanceIdentifier`` or ``DBSnapshotIdentifier`` property, don't specify this property. The value is inherited from the source DB instance or snapshot. + When migrating a self-managed Db2 database, we recommend that you use the same master username as your self-managed Db2 instance name. + *Amazon Aurora* + Not applicable. The name for the master user is managed by the DB cluster. + *RDS for Db2* + Constraints: + + Must be 1 to 16 letters or numbers. + + First character must be a letter. + + Can't be a reserved word for the chosen database engine. + + *RDS for MariaDB* + Constraints: + + Must be 1 to 16 letters or numbers. + + Can't be a reserved word for the chosen database engine. + + *RDS for Microsoft SQL Server* + Constraints: + + Must be 1 to 128 letters or numbers. + + First character must be a letter. + + Can't be a reserved word for the chosen database engine. + + *RDS for MySQL* + Constraints: + + Must be 1 to 16 letters or numbers. + + First character must be a letter. + + Can't be a reserved word for the chosen database engine. + + *RDS for Oracle* + Constraints: + + Must be 1 to 30 letters or numbers. + + First character must be a letter. + + Can't be a reserved word for the chosen database engine. + + *RDS for PostgreSQL* + Constraints: + + Must be 1 to 63 letters or numbers. + + First character must be a letter. + + Can't be a reserved word for the chosen database engine. +* **MasterUserPassword**: string (WriteOnly): The password for the master user. The password can include any printable ASCII character except "/", """, or "@". + *Amazon Aurora* + Not applicable. The password for the master user is managed by the DB cluster. + *RDS for Db2* + Must contain from 8 to 255 characters. + *RDS for MariaDB* + Constraints: Must contain from 8 to 41 characters. + *RDS for Microsoft SQL Server* + Constraints: Must contain from 8 to 128 characters. + *RDS for MySQL* + Constraints: Must contain from 8 to 41 characters. + *RDS for Oracle* + Constraints: Must contain from 8 to 30 characters. + *RDS for PostgreSQL* + Constraints: Must contain from 8 to 128 characters. +* **MasterUserSecret**: [MasterUserSecret](#masterusersecret): The secret managed by RDS in AWS Secrets Manager for the master user password. + For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide.* +* **MaxAllocatedStorage**: int: The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. + For more information about this setting, including limitations that apply to it, see [Managing capacity automatically with Amazon RDS storage autoscaling](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling) in the *Amazon RDS User Guide*. + This setting doesn't apply to the following DB instances: + + Amazon Aurora (Storage is managed by the DB cluster.) + + RDS Custom +* **MonitoringInterval**: int: The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0. The default is 0. + If ``MonitoringRoleArn`` is specified, then you must set ``MonitoringInterval`` to a value other than 0. + This setting doesn't apply to RDS Custom. + Valid Values: ``0, 1, 5, 10, 15, 30, 60`` +* **MonitoringRoleArn**: string: The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, ``arn:aws:iam:123456789012:role/emaccess``. For information on creating a monitoring role, see [Setting Up and Enabling Enhanced Monitoring](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling) in the *Amazon RDS User Guide*. + If ``MonitoringInterval`` is set to a value other than ``0``, then you must supply a ``MonitoringRoleArn`` value. + This setting doesn't apply to RDS Custom DB instances. +* **MultiAZ**: bool: Specifies whether the database instance is a Multi-AZ DB instance deployment. You can't set the ``AvailabilityZone`` parameter if the ``MultiAZ`` parameter is set to true. + For more information, see [Multi-AZ deployments for high availability](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.MultiAZ.html) in the *Amazon RDS User Guide*. + *Amazon Aurora* + Not applicable. Amazon Aurora storage is replicated across all of the Availability Zones and doesn't require the ``MultiAZ`` option to be set. +* **NcharCharacterSetName**: string: The name of the NCHAR character set for the Oracle DB instance. + This setting doesn't apply to RDS Custom DB instances. +* **NetworkType**: string: The network type of the DB instance. + Valid values: + + ``IPV4`` + + ``DUAL`` + + The network type is determined by the ``DBSubnetGroup`` specified for the DB instance. A ``DBSubnetGroup`` can support only the IPv4 protocol or the IPv4 and IPv6 protocols (``DUAL``). + For more information, see [Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the *Amazon RDS User Guide.* * **OptionGroupName**: string: Indicates that the DB instance should be associated with the specified option group. -* **PerformanceInsightsKMSKeyId**: string: The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key. -* **PerformanceInsightsRetentionPeriod**: int: The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years). + Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance. +* **PerformanceInsightsKMSKeyId**: string: The AWS KMS key identifier for encryption of Performance Insights data. + The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. + If you do not specify a value for ``PerformanceInsightsKMSKeyId``, then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region. + For 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). +* **PerformanceInsightsRetentionPeriod**: int: The number of days to retain Performance Insights data. + This setting doesn't apply to RDS Custom DB instances. + Valid Values: + + ``7`` + + *month* * 31, where *month* is a number of months from 1-23. Examples: ``93`` (3 months * 31), ``341`` (11 months * 31), ``589`` (19 months * 31) + + ``731`` + + Default: ``7`` days + If you specify a retention period that isn't valid, such as ``94``, Amazon RDS returns an error. * **Port**: string (WriteOnly): The port number on which the database accepts connections. -* **PreferredBackupWindow**: string: The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. -* **PreferredMaintenanceWindow**: string: he weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). + *Amazon Aurora* + Not applicable. The port number is managed by the DB cluster. + *Db2* + Default value: ``50000`` +* **PreferredBackupWindow**: string: The daily time range during which automated backups are created if automated backups are enabled, using the ``BackupRetentionPeriod`` parameter. For more information, see [Backup Window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow) in the *Amazon RDS User Guide.* + Constraints: + + Must be in the format ``hh24:mi-hh24:mi``. + + Must be in Universal Coordinated Time (UTC). + + Must not conflict with the preferred maintenance window. + + Must be at least 30 minutes. + + *Amazon Aurora* + Not applicable. The daily time range for creating automated backups is managed by the DB cluster. +* **PreferredMaintenanceWindow**: string: The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). + Format: ``ddd:hh24:mi-ddd:hh24:mi`` + The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see [Adjusting the Preferred DB Instance Maintenance Window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow) in the *Amazon RDS User Guide.* + This property applies when AWS CloudFormation initially creates the DB instance. If you use AWS CloudFormation to update the DB instance, those updates are applied immediately. + Constraints: Minimum 30-minute window. * **ProcessorFeatures**: [ProcessorFeature](#processorfeature)[]: The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. -* **PromotionTier**: int: A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. -* **PubliclyAccessible**: bool: Indicates whether the DB instance is an internet-facing instance. If you specify true, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address. -* **ReplicaMode**: string: The open mode of an Oracle read replica. The default is open-read-only. + This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. +* **PromotionTier**: int: The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see [Fault Tolerance for an Aurora DB Cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.AuroraHighAvailability.html#Aurora.Managing.FaultTolerance) in the *Amazon Aurora User Guide*. + This setting doesn't apply to RDS Custom DB instances. + Default: ``1`` + Valid Values: ``0 - 15`` +* **PubliclyAccessible**: bool: Indicates whether the DB instance is an internet-facing instance. If you specify true, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address. + The default behavior value depends on your VPC setup and the database subnet group. For more information, see the ``PubliclyAccessible`` parameter in the [CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) in the *Amazon RDS API Reference*. +* **ReplicaMode**: string: The open mode of an Oracle read replica. For more information, see [Working with Oracle Read Replicas for Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html) in the *Amazon RDS User Guide*. + This setting is only supported in RDS for Oracle. + Default: ``open-read-only`` + Valid Values: ``open-read-only`` or ``mounted`` * **RestoreTime**: string (WriteOnly): The date and time to restore from. + Constraints: + + Must be a time in Universal Coordinated Time (UTC) format. + + Must be before the latest restorable time for the DB instance. + + Can't be specified if the ``UseLatestRestorableTime`` parameter is enabled. + + Example: ``2009-09-07T23:45:00Z`` * **SourceDBClusterIdentifier**: string: The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas. -* **SourceDBInstanceAutomatedBackupsArn**: string (WriteOnly): The Amazon Resource Name (ARN) of the replicated automated backups from which to restore. -* **SourceDBInstanceIdentifier**: string (WriteOnly): If you want to create a Read Replica DB instance, specify the ID of the source DB instance. Each DB instance can have a limited number of Read Replicas. + Constraints: + + Must be the identifier of an existing Multi-AZ DB cluster. + + Can't be specified if the ``SourceDBInstanceIdentifier`` parameter is also specified. + + The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0. + + The source DB cluster must be in the same AWS-Region as the read replica. Cross-Region replication isn't supported. +* **SourceDBInstanceAutomatedBackupsArn**: string (WriteOnly): The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, ``arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE``. + This setting doesn't apply to RDS Custom. +* **SourceDBInstanceIdentifier**: string (WriteOnly): If you want to create a read replica DB instance, specify the ID of the source DB instance. Each DB instance can have a limited number of read replicas. For more information, see [Working with Read Replicas](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/USER_ReadRepl.html) in the *Amazon RDS User Guide*. + For information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide*. + The ``SourceDBInstanceIdentifier`` property determines whether a DB instance is a read replica. If you remove the ``SourceDBInstanceIdentifier`` property from your template and then update your stack, AWS CloudFormation promotes the read replica to a standalone DB instance. + If you specify the ``UseLatestRestorableTime`` or ``RestoreTime`` properties in conjunction with the ``SourceDBInstanceIdentifier`` property, RDS restores the DB instance to the requested point in time, thereby creating a new DB instance. + + If you specify a source DB instance that uses VPC security groups, we recommend that you specify the ``VPCSecurityGroups`` property. If you don't specify the property, the read replica inherits the value of the ``VPCSecurityGroups`` property from the source DB when you create the replica. However, if you update the stack, AWS CloudFormation reverts the replica's ``VPCSecurityGroups`` property to the default value because it's not defined in the stack's template. This change might cause unexpected issues. + + Read replicas don't support deletion policies. AWS CloudFormation ignores any deletion policy that's associated with a read replica. + + If you specify ``SourceDBInstanceIdentifier``, don't specify the ``DBSnapshotIdentifier`` property. You can't create a read replica from a snapshot. + + Don't set the ``BackupRetentionPeriod``, ``DBName``, ``MasterUsername``, ``MasterUserPassword``, and ``PreferredBackupWindow`` properties. The database attributes are inherited from the source DB instance, and backups are disabled for read replicas. + + If the source DB instance is in a different region than the read replica, specify the source region in ``SourceRegion``, and specify an ARN for a valid DB instance in ``SourceDBInstanceIdentifier``. For more information, see [Constructing a Amazon RDS Amazon Resource Name (ARN)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html#USER_Tagging.ARN) in the *Amazon RDS User Guide*. + + For DB instances in Amazon Aurora clusters, don't specify this property. Amazon RDS automatically assigns writer and reader DB instances. * **SourceDbiResourceId**: string (WriteOnly): The resource ID of the source DB instance from which to restore. -* **SourceRegion**: string (WriteOnly): The ID of the region that contains the source DB instance for the Read Replica. +* **SourceRegion**: string (WriteOnly): The ID of the region that contains the source DB instance for the read replica. * **StorageEncrypted**: bool: A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted. -* **StorageThroughput**: int: Specifies the storage throughput for the DB instance. -* **StorageType**: string: Specifies the storage type to be associated with the DB instance. -* **Tags**: [Tag](#tag)[]: Tags to assign to the DB instance. -* **TdeCredentialArn**: string: The ARN from the key store with which to associate the instance for TDE encryption. -* **TdeCredentialPassword**: string (WriteOnly): The password for the given ARN from the key store in order to access the device. -* **Timezone**: string: The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server. -* **UseDefaultProcessorFeatures**: bool (WriteOnly): A value that indicates whether the DB instance class of the DB instance uses its default processor features. -* **UseLatestRestorableTime**: bool (WriteOnly): A value that indicates whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time. -* **VPCSecurityGroups**: string[]: A list of the VPC security group IDs to assign to the DB instance. The list can include both the physical IDs of existing VPC security groups and references to AWS::EC2::SecurityGroup resources created in the template. - -## DBInstanceRole -### Properties -* **FeatureName**: string (Required): The name of the feature associated with the AWS Identity and Access Management (IAM) role. IAM roles that are associated with a DB instance grant permission for the DB instance to access other AWS services on your behalf. -* **RoleArn**: string (Required): The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance. - -## CertificateDetails -### Properties -* **CAIdentifier**: string (ReadOnly): The CA identifier of the CA certificate used for the DB instance's server certificate. -* **ValidTill**: string (ReadOnly): The expiration date of the DB instance’s server certificate. - -## Endpoint -### Properties -* **Address**: string (ReadOnly): Specifies the DNS address of the DB instance. -* **HostedZoneId**: string (ReadOnly): Specifies the ID that Amazon Route 53 assigns when you create a hosted zone. -* **Port**: string (ReadOnly): Specifies the port that the database engine is listening on. - -## MasterUserSecret -### Properties -* **KmsKeyId**: string: The AWS KMS key identifier that is used to encrypt the secret. -* **SecretArn**: string (ReadOnly): The Amazon Resource Name (ARN) of the secret. - -## ProcessorFeature -### Properties -* **Name**: string: The name of the processor feature. Valid names are coreCount and threadsPerCore. -* **Value**: string: The value of a processor feature name. - -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + If you specify the ``KmsKeyId`` property, then you must enable encryption. + If you specify the ``SourceDBInstanceIdentifier`` or ``SourceDbiResourceId`` property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specified ``KmsKeyId`` property is used. + If you specify the ``SourceDBInstanceAutomatedBackupsArn`` property, don't specify this property. The value is inherited from the source DB instance automated backup. + If you specify ``DBSnapshotIdentifier`` property, don't specify this property. The value is inherited from the snapshot. + *Amazon Aurora* + Not applicable. The encryption for DB instances is managed by the DB cluster. +* **StorageThroughput**: int: Specifies the storage throughput value for the DB instance. This setting applies only to the ``gp3`` storage type. + This setting doesn't apply to RDS Custom or Amazon Aurora. +* **StorageType**: string: The storage type to associate with the DB instance. + If you specify ``io1``, ``io2``, or ``gp3``, you must also include a value for the ``Iops`` parameter. + This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster. + Valid Values: ``gp2 | gp3 | io1 | io2 | standard`` + Default: ``io1``, if the ``Iops`` parameter is specified. Otherwise, ``gp2``. +* **Tags**: [Tag](#tag)[]: An optional array of key-value pairs to apply to this DB instance. +* **TdeCredentialArn**: string +* **TdeCredentialPassword**: string (WriteOnly) +* **Timezone**: string: The time zone of the DB instance. The time zone parameter is currently supported only by [RDS for Db2](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-time-zone) and [RDS for SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone). +* **UseDefaultProcessorFeatures**: bool (WriteOnly): Specifies whether the DB instance class of the DB instance uses its default processor features. + This setting doesn't apply to RDS Custom DB instances. +* **UseLatestRestorableTime**: bool (WriteOnly): Specifies whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time. + Constraints: + + Can't be specified if the ``RestoreTime`` parameter is provided. +* **VPCSecurityGroups**: string[]: A list of the VPC security group IDs to assign to the DB instance. The list can include both the physical IDs of existing VPC security groups and references to [AWS::EC2::SecurityGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html) resources created in the template. + If you plan to update the resource, don't specify VPC security groups in a shared VPC. + If 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. + You can migrate a DB instance in your stack from an RDS DB security group to a VPC security group, but keep the following in mind: + + You can't revert to using an RDS security group after you establish a VPC security group membership. + + When you migrate your DB instance to VPC security groups, if your stack update rolls back because the DB instance update fails or because an update fails in another AWS CloudFormation resource, the rollback fails because it can't revert to an RDS security group. + + To use the properties that are available when you use a VPC security group, you must recreate the DB instance. If you don't, AWS CloudFormation submits only the property values that are listed in the [DBSecurityGroups](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups) property. + + To avoid this situation, migrate your DB instance to using VPC security groups only when that is the only change in your stack template. + *Amazon Aurora* + Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. If specified, the setting must match the DB cluster setting. ## AWS.RDS/DBParameterGroupProperties ### Properties -* **DBParameterGroupName**: string (Identifier): Specifies the name of the DB parameter group +* **DBParameterGroupName**: string (Identifier): The name of the DB parameter group. + Constraints: + + Must be 1 to 255 letters, numbers, or hyphens. + + First character must be a letter + + Can't end with a hyphen or contain two consecutive hyphens + + If you don't specify a value for ``DBParameterGroupName`` property, a name is automatically created for the DB parameter group. + This value is stored as a lowercase string. * **Description**: string (Required): Provides the customer-specified description for this DB parameter group. -* **Family**: string (Required): The DB parameter group family name. -* **Parameters**: [DBParameterGroup_Parameters](#dbparametergroupparameters): An array of parameter names and values for the parameter update. -* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. +* **Family**: string (Required): The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a DB engine and engine version compatible with that DB parameter group family. + The DB parameter group family can't be changed when updating a DB parameter group. + To list all of the available parameter group families, use the following command: + ``aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily"`` + The output contains duplicates. + For more information, see ``CreateDBParameterGroup``. +* **Parameters**: [DBParameterGroup_Parameters](#dbparametergroupparameters): An array of parameter names and values for the parameter update. At least one parameter name and value must be supplied. Subsequent arguments are optional. + RDS for Db2 requires you to bring your own Db2 license. You must enter your IBM customer ID (``rds.ibm_customer_id``) and site number (``rds.ibm_site_id``) before starting a Db2 instance. + For more information about DB parameters and DB parameter groups for Amazon RDS DB engines, see [Working with DB Parameter Groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the *Amazon RDS User Guide*. + For more information about DB cluster and DB instance parameters and parameter groups for Amazon Aurora DB engines, see [Working with DB Parameter Groups and DB Cluster Parameter Groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*. + AWS CloudFormation doesn't support specifying an apply method for each individual parameter. The default apply method for each parameter is used. +* **Tags**: [Tag](#tag)[]: An optional array of key-value pairs to apply to this DB parameter group. + Currently, this is the only property that supports drift detection. -## DBParameterGroup_Parameters -### Properties - -## Tag +## AWS.RDS/DBProxyEndpointProperties ### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **DBProxyEndpointArn**: string (ReadOnly): The Amazon Resource Name (ARN) for the DB proxy endpoint. +* **DBProxyEndpointName**: string (Required, Identifier): The identifier for the DB proxy endpoint. This name must be unique for all DB proxy endpoints owned by your AWS account in the specified AWS Region. +* **DBProxyName**: string (Required): The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region. +* **Endpoint**: string (ReadOnly): The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application. +* **IsDefault**: bool (ReadOnly): A value that indicates whether this endpoint is the default endpoint for the associated DB proxy. Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the DB proxy can be either read/write or read-only. +* **Tags**: [TagFormat](#tagformat)[]: An optional set of key-value pairs to associate arbitrary data of your choosing with the DB proxy endpoint. +* **TargetRole**: string: A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations. +* **VpcId**: string (ReadOnly): VPC ID to associate with the new DB proxy endpoint. +* **VpcSecurityGroupIds**: string[]: VPC security group IDs to associate with the new DB proxy endpoint. +* **VpcSubnetIds**: string[] (Required): VPC subnet IDs to associate with the new DB proxy endpoint. ## AWS.RDS/DBProxyProperties ### Properties @@ -397,37 +770,6 @@ Constraints: * **VpcSecurityGroupIds**: string[]: VPC security group IDs to associate with the new proxy. * **VpcSubnetIds**: string[] (Required): VPC subnet IDs to associate with the new proxy. -## AuthFormat -### Properties -* **AuthScheme**: string: The type of authentication that the proxy uses for connections from the proxy to the underlying database. -* **ClientPasswordAuthType**: string: The type of authentication the proxy uses for connections from clients. -* **Description**: string: A user-specified description about the authentication used by a proxy to log in as a specific database user. -* **IAMAuth**: string: Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server. -* **SecretArn**: string: The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager. - -## TagFormat -### Properties -* **Key**: string -* **Value**: string - -## AWS.RDS/DBProxyEndpointProperties -### Properties -* **DBProxyEndpointArn**: string (ReadOnly): The Amazon Resource Name (ARN) for the DB proxy endpoint. -* **DBProxyEndpointName**: string (Required, Identifier): The identifier for the DB proxy endpoint. This name must be unique for all DB proxy endpoints owned by your AWS account in the specified AWS Region. -* **DBProxyName**: string (Required): The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region. -* **Endpoint**: string (ReadOnly): The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application. -* **IsDefault**: bool (ReadOnly): A value that indicates whether this endpoint is the default endpoint for the associated DB proxy. Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the DB proxy can be either read/write or read-only. -* **Tags**: [TagFormat](#tagformat)[]: An optional set of key-value pairs to associate arbitrary data of your choosing with the DB proxy endpoint. -* **TargetRole**: string: A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations. -* **VpcId**: string (ReadOnly): VPC ID to associate with the new DB proxy endpoint. -* **VpcSecurityGroupIds**: string[]: VPC security group IDs to associate with the new DB proxy endpoint. -* **VpcSubnetIds**: string[] (Required): VPC subnet IDs to associate with the new DB proxy endpoint. - -## TagFormat -### Properties -* **Key**: string -* **Value**: string - ## AWS.RDS/DBProxyTargetGroupProperties ### Properties * **ConnectionPoolConfigurationInfo**: [ConnectionPoolConfigurationInfoFormat](#connectionpoolconfigurationinfoformat) @@ -437,25 +779,14 @@ Constraints: * **TargetGroupArn**: string (ReadOnly, Identifier): The Amazon Resource Name (ARN) representing the target group. * **TargetGroupName**: string (Required): The identifier for the DBProxyTargetGroup -## ConnectionPoolConfigurationInfoFormat -### Properties -* **ConnectionBorrowTimeout**: int: The number of seconds for a proxy to wait for a connection to become available in the connection pool. -* **InitQuery**: string: One or more SQL statements for the proxy to run when opening each new database connection. -* **MaxConnectionsPercent**: int: The maximum size of the connection pool for each target in a target group. -* **MaxIdleConnectionsPercent**: int: Controls how actively the proxy closes idle database connections in the connection pool. -* **SessionPinningFilters**: string[]: Each item in the list represents a class of SQL operations that normally cause all later statements in a session using a proxy to be pinned to the same underlying database connection. - ## AWS.RDS/DBSubnetGroupProperties ### Properties -* **DBSubnetGroupDescription**: string (Required) -* **DBSubnetGroupName**: string (Identifier) -* **SubnetIds**: string[] (Required, WriteOnly) -* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. - -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **DBSubnetGroupDescription**: string (Required): The description for the DB subnet group. +* **DBSubnetGroupName**: string (Identifier): The name for the DB subnet group. This value is stored as a lowercase string. + Constraints: Must contain no more than 255 lowercase alphanumeric characters or hyphens. Must not be "Default". + Example: ``mysubnetgroup`` +* **SubnetIds**: string[] (Required, WriteOnly): The EC2 Subnet IDs for the DB subnet group. +* **Tags**: [Tag](#tag)[]: An optional array of key-value pairs to apply to this DB subnet group. ## AWS.RDS/EventSubscriptionProperties ### Properties @@ -467,22 +798,31 @@ Constraints: * **SubscriptionName**: string (Identifier): The name of the subscription. * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## AWS.RDS/GlobalClusterProperties ### Properties * **DeletionProtection**: bool: The deletion protection setting for the new global database. The global database can't be deleted when deletion protection is enabled. * **Engine**: string: The name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora). If you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the cluster. +* **EngineLifecycleSupport**: string: The life cycle type of the global cluster. You can use this setting to enroll your global cluster into Amazon RDS Extended Support. * **EngineVersion**: string: The version number of the database engine to use. If you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the cluster. * **GlobalClusterIdentifier**: string (Identifier): The cluster identifier of the new global database cluster. This parameter is stored as a lowercase string. * **SourceDBClusterIdentifier**: string: The Amazon Resource Name (ARN) to use as the primary cluster of the global database. This parameter is optional. This parameter is stored as a lowercase string. * **StorageEncrypted**: bool: The storage encryption setting for the new global database cluster. If you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the cluster. +## AWS.RDS/IntegrationProperties +### Properties +* **AdditionalEncryptionContext**: [EncryptionContextMap](#encryptioncontextmap) +* **CreateTime**: string (ReadOnly) +* **DataFilter**: string: The data filter for the integration. +* **Description**: string: The description of the integration. +* **IntegrationArn**: string (ReadOnly, Identifier): The ARN of the integration. +* **IntegrationName**: string: The name of the integration. +* **KMSKeyId**: string: An optional AWS Key Management System (AWS KMS) key ARN for the key used to to encrypt the integration. The resource accepts the key ID and the key ARN forms. The key ID form can be used if the KMS key is owned by te same account. If the KMS key belongs to a different account than the calling account, the full key ARN must be specified. Do not use the key alias or the key alias ARN as this will cause a false drift of the resource. +* **SourceArn**: string (Required): The Amazon Resource Name (ARN) of the Aurora DB cluster to use as the source for replication. +* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. +* **TargetArn**: string (Required): The ARN of the Redshift data warehouse to use as the target for replication. + ## AWS.RDS/OptionGroupProperties ### Properties * **EngineName**: string (Required): Indicates the name of the engine that this option group can be applied to. @@ -492,6 +832,59 @@ If you specify the SourceDBClusterIdentifier property, don't specify this proper * **OptionGroupName**: string (Identifier): Specifies the name of the option group. * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. +## CertificateDetails +### Properties +* **CAIdentifier**: string (ReadOnly): The CA identifier of the CA certificate used for the DB instance's server certificate. +* **ValidTill**: string (ReadOnly): The expiration date of the DB instance?s server certificate. + +## ConnectionPoolConfigurationInfoFormat +### Properties +* **ConnectionBorrowTimeout**: int: The number of seconds for a proxy to wait for a connection to become available in the connection pool. +* **InitQuery**: string: One or more SQL statements for the proxy to run when opening each new database connection. +* **MaxConnectionsPercent**: int: The maximum size of the connection pool for each target in a target group. +* **MaxIdleConnectionsPercent**: int: Controls how actively the proxy closes idle database connections in the connection pool. +* **SessionPinningFilters**: string[]: Each item in the list represents a class of SQL operations that normally cause all later statements in a session using a proxy to be pinned to the same underlying database connection. + +## DBClusterParameterGroup_Parameters +### Properties + +## DBClusterRole +### Properties +* **FeatureName**: string: The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion in the Amazon RDS API Reference. +* **RoleArn**: string (Required): The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster. + +## DBInstanceRole +### Properties +* **FeatureName**: string (Required): The name of the feature associated with the AWS Identity and Access Management (IAM) role. IAM roles that are associated with a DB instance grant permission for the DB instance to access other AWS services on your behalf. For the list of supported feature names, see the ``SupportedFeatureNames`` description in [DBEngineVersion](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DBEngineVersion.html) in the *Amazon RDS API Reference*. +* **RoleArn**: string (Required): The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance. + +## DBParameterGroup_Parameters +### Properties + +## EncryptionContextMap +### Properties + +## Endpoint +### Properties +* **Address**: string (ReadOnly): The connection endpoint for the DB cluster. +* **Port**: string (ReadOnly): The port number that will accept connections on this DB cluster. + +## Endpoint +### Properties +* **Address**: string (ReadOnly): Specifies the DNS address of the DB instance. +* **HostedZoneId**: string (ReadOnly): Specifies the ID that Amazon Route 53 assigns when you create a hosted zone. +* **Port**: string (ReadOnly): Specifies the port that the database engine is listening on. + +## MasterUserSecret +### Properties +* **KmsKeyId**: string: The AWS KMS key identifier that is used to encrypt the secret. +* **SecretArn**: string (ReadOnly): The Amazon Resource Name (ARN) of the secret. + +## MasterUserSecret +### Properties +* **KmsKeyId**: string: The AWS KMS key identifier that is used to encrypt the secret. +* **SecretArn**: string (ReadOnly): The Amazon Resource Name (ARN) of the secret. + ## OptionConfiguration ### Properties * **DBSecurityGroupMemberships**: string[]: A list of DBSecurityGroupMembership name strings used for this option. @@ -506,8 +899,92 @@ If you specify the SourceDBClusterIdentifier property, don't specify this proper * **Name**: string: The name of the option that has settings that you can set. * **Value**: string: The current value of the option setting. +## ProcessorFeature +### Properties +* **Name**: string: The name of the processor feature. Valid names are ``coreCount`` and ``threadsPerCore``. +* **Value**: string: The value of a processor feature name. + +## ReadEndpoint +### Properties +* **Address**: string (ReadOnly): The reader endpoint for the DB cluster. + +## ScalingConfiguration +### Properties +* **AutoPause**: bool: A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections). +* **MaxCapacity**: int: The maximum capacity for an Aurora DB cluster in serverless DB engine mode. +For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. +For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384. +The maximum capacity must be greater than or equal to the minimum capacity. +* **MinCapacity**: int: The minimum capacity for an Aurora DB cluster in serverless DB engine mode. +For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. +For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384. +The minimum capacity must be less than or equal to the maximum capacity. +* **SecondsBeforeTimeout**: int: The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. +The default is 300. +* **SecondsUntilAutoPause**: int: The time, in seconds, before an Aurora DB cluster in serverless mode is paused. +* **TimeoutAction**: string: The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange. +ForceApplyCapacityChange sets the capacity to the specified value as soon as possible. +RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period. + +For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide. + +## ServerlessV2ScalingConfiguration +### Properties +* **MaxCapacity**: int: The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128. +* **MinCapacity**: int: The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5. + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + ## Tag ### Properties * **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. * **Value**: string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## Tag +### Properties +* **Key**: string (Required): A 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}_.:/=+\\-@]*)$"). +* **Value**: string: A 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}_.:/=+\\-@]*)$"). + +## Tag +### Properties +* **Key**: string (Required): A 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}_.:/=+\\-@]*)$"). +* **Value**: string: A 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}_.:/=+\\-@]*)$"). + +## Tag +### Properties +* **Key**: string (Required): A 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}_.:/=+\\-@]*)$"). +* **Value**: string: A 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}_.:/=+\\-@]*)$"). + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## TagFormat +### Properties +* **Key**: string +* **Value**: string + +## TagFormat +### Properties +* **Key**: string +* **Value**: string + diff --git a/artifacts/bicep/aws/aws.redshift/default/types.json b/artifacts/bicep/aws/aws.redshift/default/types.json index d1d60f29..bbff29f9 100644 --- a/artifacts/bicep/aws/aws.redshift/default/types.json +++ b/artifacts/bicep/aws/aws.redshift/default/types.json @@ -1 +1,1542 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"Endpoint","Properties":{"Address":{"Type":4,"Flags":2},"Port":{"Type":4,"Flags":2}}}},{"2":{"Name":"LoggingProperties","Properties":{"BucketName":{"Type":4,"Flags":0},"S3KeyPrefix":{"Type":4,"Flags":0}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.Redshift/ClusterProperties","Properties":{"AllowVersionUpgrade":{"Type":2,"Flags":0,"Description":"Major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default value is True"},"AquaConfigurationStatus":{"Type":4,"Flags":0,"Description":"The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. Possible values include the following.\n\nenabled - Use AQUA if it is available for the current Region and Amazon Redshift node type.\ndisabled - Don't use AQUA.\nauto - Amazon Redshift determines whether to use AQUA.\n"},"AutomatedSnapshotRetentionPeriod":{"Type":3,"Flags":0,"Description":"The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Default value is 1"},"AvailabilityZone":{"Type":4,"Flags":0,"Description":"The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint"},"AvailabilityZoneRelocation":{"Type":2,"Flags":0,"Description":"The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete."},"AvailabilityZoneRelocationStatus":{"Type":4,"Flags":0,"Description":"The availability zone relocation status of the cluster"},"Classic":{"Type":2,"Flags":4,"Description":"A boolean value indicating whether the resize operation is using the classic resize process. If you don't provide this parameter or set the value to false , the resize type is elastic."},"ClusterIdentifier":{"Type":4,"Flags":16,"Description":"A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. All alphabetical characters must be lower case, no hypens at the end, no two consecutive hyphens. Cluster name should be unique for all clusters within an AWS account"},"ClusterNamespaceArn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) of the cluster namespace."},"ClusterParameterGroupName":{"Type":4,"Flags":0,"Description":"The name of the parameter group to be associated with this cluster."},"ClusterSecurityGroups":{"Type":12,"Flags":0,"Description":"A list of security groups to be associated with this cluster."},"ClusterSubnetGroupName":{"Type":4,"Flags":0,"Description":"The name of a cluster subnet group to be associated with this cluster."},"ClusterType":{"Type":4,"Flags":1,"Description":"The type of the cluster. When cluster type is specified as single-node, the NumberOfNodes parameter is not required and if multi-node, the NumberOfNodes parameter is required"},"ClusterVersion":{"Type":4,"Flags":0,"Description":"The version of the Amazon Redshift engine software that you want to deploy on the cluster.The version selected runs on all the nodes in the cluster."},"DBName":{"Type":4,"Flags":1,"Description":"The name of the first database to be created when the cluster is created. To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database."},"DeferMaintenance":{"Type":2,"Flags":4,"Description":"A boolean indicating whether to enable the deferred maintenance window."},"DeferMaintenanceDuration":{"Type":3,"Flags":4,"Description":"An integer indicating the duration of the maintenance window in days. If you specify a duration, you can't specify an end time. The duration must be 45 days or less."},"DeferMaintenanceEndTime":{"Type":4,"Flags":0,"Description":"A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration."},"DeferMaintenanceIdentifier":{"Type":4,"Flags":2,"Description":"A unique identifier for the deferred maintenance window."},"DeferMaintenanceStartTime":{"Type":4,"Flags":0,"Description":"A timestamp indicating the start time for the deferred maintenance window."},"DestinationRegion":{"Type":4,"Flags":0,"Description":"The destination AWS Region that you want to copy snapshots to. Constraints: Must be the name of a valid AWS Region. For more information, see Regions and Endpoints in the Amazon Web Services [https://docs.aws.amazon.com/general/latest/gr/rande.html#redshift_region] General Reference"},"ElasticIp":{"Type":4,"Flags":0,"Description":"The Elastic IP (EIP) address for the cluster."},"Encrypted":{"Type":2,"Flags":0,"Description":"If true, the data in the cluster is encrypted at rest."},"Endpoint":{"Type":8,"Flags":0},"EnhancedVpcRouting":{"Type":2,"Flags":0,"Description":"An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.\n\nIf this option is true , enhanced VPC routing is enabled.\n\nDefault: false"},"HsmClientCertificateIdentifier":{"Type":4,"Flags":0,"Description":"Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM"},"HsmConfigurationIdentifier":{"Type":4,"Flags":0,"Description":"Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM."},"IamRoles":{"Type":13,"Flags":0,"Description":"A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 50 IAM roles in a single request"},"KmsKeyId":{"Type":4,"Flags":0,"Description":"The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster."},"LoggingProperties":{"Type":9,"Flags":0},"MaintenanceTrackName":{"Type":4,"Flags":0,"Description":"The name for the maintenance track that you want to assign for the cluster. This name change is asynchronous. The new track name stays in the PendingModifiedValues for the cluster until the next maintenance window. When the maintenance track changes, the cluster is switched to the latest cluster release available for the maintenance track. At this point, the maintenance track name is applied."},"ManageMasterPassword":{"Type":2,"Flags":4,"Description":"A boolean indicating if the redshift cluster's admin user credentials is managed by Redshift or not. You can't use MasterUserPassword if ManageMasterPassword is true. If ManageMasterPassword is false or not set, Amazon Redshift uses MasterUserPassword for the admin user account's password."},"ManualSnapshotRetentionPeriod":{"Type":3,"Flags":0,"Description":"The number of days to retain newly copied snapshots in the destination AWS Region after they are copied from the source AWS Region. If the value is -1, the manual snapshot is retained indefinitely.\n\nThe value must be either -1 or an integer between 1 and 3,653."},"MasterPasswordSecretArn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) for the cluster's admin user credentials secret."},"MasterPasswordSecretKmsKeyId":{"Type":4,"Flags":0,"Description":"The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin user credentials secret."},"MasterUserPassword":{"Type":4,"Flags":4,"Description":"The password associated with the master user account for the cluster that is being created. You can't use MasterUserPassword if ManageMasterPassword is true. Password must be between 8 and 64 characters in length, should have at least one uppercase letter.Must contain at least one lowercase letter.Must contain one number.Can be any printable ASCII character."},"MasterUsername":{"Type":4,"Flags":1,"Description":"The user name associated with the master user account for the cluster that is being created. The user name can't be PUBLIC and first character must be a letter."},"MultiAZ":{"Type":2,"Flags":0,"Description":"A boolean indicating if the redshift cluster is multi-az or not. If you don't provide this parameter or set the value to false, the redshift cluster will be single-az."},"NamespaceResourcePolicy":{"Type":14,"Flags":0,"Description":"The namespace resource policy document that will be attached to a Redshift cluster."},"NodeType":{"Type":4,"Flags":1,"Description":"The node type to be provisioned for the cluster.Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.4xlarge | ra3.16xlarge"},"NumberOfNodes":{"Type":3,"Flags":0,"Description":"The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node."},"OwnerAccount":{"Type":4,"Flags":0},"Port":{"Type":3,"Flags":0,"Description":"The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings"},"PreferredMaintenanceWindow":{"Type":4,"Flags":0,"Description":"The weekly time range (in UTC) during which automated cluster maintenance can occur."},"PubliclyAccessible":{"Type":2,"Flags":0,"Description":"If true, the cluster can be accessed from a public network."},"ResourceAction":{"Type":4,"Flags":0,"Description":"The Redshift operation to be performed. Resource Action supports pause-cluster, resume-cluster, failover-primary-compute APIs"},"RevisionTarget":{"Type":4,"Flags":0,"Description":"The identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request."},"RotateEncryptionKey":{"Type":2,"Flags":0,"Description":"A boolean indicating if we want to rotate Encryption Keys."},"SnapshotClusterIdentifier":{"Type":4,"Flags":0,"Description":"The name of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name."},"SnapshotCopyGrantName":{"Type":4,"Flags":0,"Description":"The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region."},"SnapshotCopyManual":{"Type":2,"Flags":0,"Description":"Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots."},"SnapshotCopyRetentionPeriod":{"Type":3,"Flags":0,"Description":"The number of days to retain automated snapshots in the destination region after they are copied from the source region. \n\n Default is 7. \n\n Constraints: Must be at least 1 and no more than 35."},"SnapshotIdentifier":{"Type":4,"Flags":4,"Description":"The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive."},"Tags":{"Type":15,"Flags":0,"Description":"The list of tags for the cluster parameter group."},"VpcSecurityGroupIds":{"Type":16,"Flags":0,"Description":"A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"Cluster_NamespaceResourcePolicy","Properties":{}}},{"3":{"ItemType":10}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.Redshift/Cluster","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":11,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Redshift/Cluster@default","ScopeType":0,"Body":17}},{"2":{"Name":"Parameter","Properties":{"ParameterName":{"Type":4,"Flags":1,"Description":"The name of the parameter."},"ParameterValue":{"Type":4,"Flags":1,"Description":"The value of the parameter. If `ParameterName` is `wlm_json_configuration`, then the maximum size of `ParameterValue` is 8000 characters."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.Redshift/ClusterParameterGroupProperties","Properties":{"Description":{"Type":4,"Flags":1,"Description":"A description of the parameter group."},"ParameterGroupFamily":{"Type":4,"Flags":1,"Description":"The Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters."},"ParameterGroupName":{"Type":4,"Flags":16,"Description":"The name of the cluster parameter group."},"Parameters":{"Type":22,"Flags":0,"Description":"An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request."},"Tags":{"Type":23,"Flags":4,"Description":"An array of key-value pairs to apply to this resource."}}}},{"3":{"ItemType":19}},{"3":{"ItemType":20}},{"2":{"Name":"AWS.Redshift/ClusterParameterGroup","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":21,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Redshift/ClusterParameterGroup@default","ScopeType":0,"Body":24}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.Redshift/ClusterSubnetGroupProperties","Properties":{"ClusterSubnetGroupName":{"Type":4,"Flags":18,"Description":"This name must be unique for all subnet groups that are created by your AWS account. If costumer do not provide it, cloudformation will generate it. Must not be \"Default\". "},"Description":{"Type":4,"Flags":1,"Description":"The description of the parameter group."},"SubnetIds":{"Type":28,"Flags":1,"Description":"The list of VPC subnet IDs"},"Tags":{"Type":29,"Flags":4,"Description":"The list of tags for the cluster parameter group."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":26}},{"2":{"Name":"AWS.Redshift/ClusterSubnetGroup","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":27,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Redshift/ClusterSubnetGroup@default","ScopeType":0,"Body":30}},{"2":{"Name":"NetworkInterface","Properties":{"AvailabilityZone":{"Type":4,"Flags":0,"Description":"The Availability Zone."},"NetworkInterfaceId":{"Type":4,"Flags":0,"Description":"The network interface identifier."},"PrivateIpAddress":{"Type":4,"Flags":0,"Description":"The IPv4 address of the network interface within the subnet."},"SubnetId":{"Type":4,"Flags":0,"Description":"The subnet identifier."}}}},{"2":{"Name":"VpcSecurityGroup","Properties":{"Status":{"Type":4,"Flags":0,"Description":"The status of the VPC security group."},"VpcSecurityGroupId":{"Type":4,"Flags":0,"Description":"The identifier of the VPC security group."}}}},{"2":{"Name":"AWS.Redshift/EndpointAccessProperties","Properties":{"Address":{"Type":4,"Flags":2,"Description":"The DNS address of the endpoint."},"ClusterIdentifier":{"Type":4,"Flags":1,"Description":"A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. All alphabetical characters must be lower case, no hypens at the end, no two consecutive hyphens. Cluster name should be unique for all clusters within an AWS account"},"EndpointCreateTime":{"Type":4,"Flags":2,"Description":"The time (UTC) that the endpoint was created."},"EndpointName":{"Type":4,"Flags":17,"Description":"The name of the endpoint."},"EndpointStatus":{"Type":4,"Flags":2,"Description":"The status of the endpoint."},"Port":{"Type":3,"Flags":2,"Description":"The port number on which the cluster accepts incoming connections."},"ResourceOwner":{"Type":4,"Flags":0,"Description":"The AWS account ID of the owner of the cluster."},"SubnetGroupName":{"Type":4,"Flags":1,"Description":"The subnet group name where Amazon Redshift chooses to deploy the endpoint."},"VpcEndpoint":{"Type":36,"Flags":2,"Description":"The connection endpoint for connecting to an Amazon Redshift cluster through the proxy."},"VpcSecurityGroupIds":{"Type":37,"Flags":1,"Description":"A list of vpc security group ids to apply to the created endpoint access."},"VpcSecurityGroups":{"Type":38,"Flags":2,"Description":"A list of Virtual Private Cloud (VPC) security groups to be associated with the endpoint."}}}},{"3":{"ItemType":32}},{"2":{"Name":"EndpointAccess_VpcEndpoint","Properties":{"NetworkInterfaces":{"Type":35,"Flags":2,"Description":"One or more network interfaces of the endpoint. Also known as an interface endpoint."},"VpcEndpointId":{"Type":4,"Flags":2,"Description":"The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy."},"VpcId":{"Type":4,"Flags":2,"Description":"The VPC identifier that the endpoint is associated."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":33}},{"2":{"Name":"AWS.Redshift/EndpointAccess","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":34,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Redshift/EndpointAccess@default","ScopeType":0,"Body":39}},{"2":{"Name":"AwsAccount"}},{"2":{"Name":"VpcId"}},{"2":{"Name":"AWS.Redshift/EndpointAuthorizationProperties","Properties":{"Account":{"Type":4,"Flags":17,"Description":"The target AWS account ID to grant or revoke access for."},"AllowedAllVPCs":{"Type":2,"Flags":2,"Description":"Indicates whether all VPCs in the grantee account are allowed access to the cluster."},"AllowedVPCs":{"Type":44,"Flags":2,"Description":"The VPCs allowed access to the cluster."},"AuthorizeTime":{"Type":4,"Flags":2,"Description":"The time (UTC) when the authorization was created."},"ClusterIdentifier":{"Type":4,"Flags":17,"Description":"The cluster identifier."},"ClusterStatus":{"Type":4,"Flags":2,"Description":"The status of the cluster."},"EndpointCount":{"Type":3,"Flags":2,"Description":"The number of Redshift-managed VPC endpoints created for the authorization."},"Force":{"Type":2,"Flags":4,"Description":" Indicates whether to force the revoke action. If true, the Redshift-managed VPC endpoints associated with the endpoint authorization are also deleted."},"Grantee":{"Type":4,"Flags":2,"Description":"The AWS account ID of the grantee of the cluster."},"Grantor":{"Type":4,"Flags":2,"Description":"The AWS account ID of the cluster owner."},"Status":{"Type":4,"Flags":2,"Description":"The status of the authorization action."},"VpcIds":{"Type":45,"Flags":0,"Description":"The virtual private cloud (VPC) identifiers to grant or revoke access to."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.Redshift/EndpointAuthorization","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":43,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Redshift/EndpointAuthorization@default","ScopeType":0,"Body":46}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.Redshift/EventSubscriptionProperties","Properties":{"CustSubscriptionId":{"Type":4,"Flags":2,"Description":"The name of the Amazon Redshift event notification subscription."},"CustomerAwsId":{"Type":4,"Flags":2,"Description":"The AWS account associated with the Amazon Redshift event notification subscription."},"Enabled":{"Type":2,"Flags":0,"Description":"A boolean value; set to true to activate the subscription, and set to false to create the subscription but not activate it."},"EventCategories":{"Type":50,"Flags":0,"Description":"Specifies the Amazon Redshift event categories to be published by the event notification subscription."},"EventCategoriesList":{"Type":51,"Flags":2,"Description":"The list of Amazon Redshift event categories specified in the event notification subscription."},"Severity":{"Type":4,"Flags":0,"Description":"Specifies the Amazon Redshift event severity to be published by the event notification subscription."},"SnsTopicArn":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications."},"SourceIds":{"Type":52,"Flags":0,"Description":"A list of one or more identifiers of Amazon Redshift source objects."},"SourceIdsList":{"Type":53,"Flags":2,"Description":"A list of the sources that publish events to the Amazon Redshift event notification subscription."},"SourceType":{"Type":4,"Flags":0,"Description":"The type of source that will be generating the events."},"Status":{"Type":4,"Flags":2,"Description":"The status of the Amazon Redshift event notification subscription."},"SubscriptionCreationTime":{"Type":4,"Flags":2,"Description":"The date and time the Amazon Redshift event notification subscription was created."},"SubscriptionName":{"Type":4,"Flags":17,"Description":"The name of the Amazon Redshift event notification subscription"},"Tags":{"Type":54,"Flags":4,"Description":"An array of key-value pairs to apply to this resource."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":48}},{"2":{"Name":"AWS.Redshift/EventSubscription","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":49,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Redshift/EventSubscription@default","ScopeType":0,"Body":55}},{"2":{"Name":"PauseClusterMessage","Properties":{"ClusterIdentifier":{"Type":4,"Flags":1}}}},{"2":{"Name":"ResizeClusterMessage","Properties":{"Classic":{"Type":2,"Flags":0},"ClusterIdentifier":{"Type":4,"Flags":1},"ClusterType":{"Type":4,"Flags":0},"NodeType":{"Type":4,"Flags":0},"NumberOfNodes":{"Type":3,"Flags":0}}}},{"2":{"Name":"ResumeClusterMessage","Properties":{"ClusterIdentifier":{"Type":4,"Flags":1}}}},{"2":{"Name":"ScheduledActionType","Properties":{"ResizeCluster":{"Type":58,"Flags":0},"PauseCluster":{"Type":57,"Flags":0},"ResumeCluster":{"Type":59,"Flags":0}}}},{"2":{"Name":"timestamp"}},{"2":{"Name":"AWS.Redshift/ScheduledActionProperties","Properties":{"Enable":{"Type":2,"Flags":0,"Description":"If true, the schedule is enabled. If false, the scheduled action does not trigger."},"EndTime":{"Type":4,"Flags":0,"Description":"The end time in UTC of the scheduled action. After this time, the scheduled action does not trigger."},"IamRole":{"Type":4,"Flags":0,"Description":"The IAM role to assume to run the target action."},"NextInvocations":{"Type":63,"Flags":2,"Description":"List of times when the scheduled action will run."},"Schedule":{"Type":4,"Flags":0,"Description":"The schedule in `at( )` or `cron( )` format."},"ScheduledActionDescription":{"Type":4,"Flags":0,"Description":"The description of the scheduled action."},"ScheduledActionName":{"Type":4,"Flags":17,"Description":"The name of the scheduled action. The name must be unique within an account."},"StartTime":{"Type":4,"Flags":0,"Description":"The start time in UTC of the scheduled action. Before this time, the scheduled action does not trigger."},"State":{"Type":4,"Flags":2,"Description":"The state of the scheduled action."},"TargetAction":{"Type":60,"Flags":0,"Description":"A JSON format string of the Amazon Redshift API operation with input parameters."}}}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.Redshift/ScheduledAction","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":62,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Redshift/ScheduledAction@default","ScopeType":0,"Body":64}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Endpoint", + "properties": { + "Address": { + "type": { + "$ref": "#/3" + }, + "flags": 2 + }, + "Port": { + "type": { + "$ref": "#/3" + }, + "flags": 2 + } + } + }, + { + "$type": "ObjectType", + "name": "LoggingProperties", + "properties": { + "BucketName": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "S3KeyPrefix": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.Redshift/ClusterProperties" + }, + { + "$type": "BooleanType" + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ObjectType", + "name": "Cluster_NamespaceResourcePolicy", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Redshift/ClusterProperties", + "properties": { + "AllowVersionUpgrade": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "Major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default value is True" + }, + "AquaConfigurationStatus": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. Possible values include the following.\n\nenabled - Use AQUA if it is available for the current Region and Amazon Redshift node type.\ndisabled - Don't use AQUA.\nauto - Amazon Redshift determines whether to use AQUA.\n" + }, + "AutomatedSnapshotRetentionPeriod": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Default value is 1" + }, + "AvailabilityZone": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint" + }, + "AvailabilityZoneRelocation": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete." + }, + "AvailabilityZoneRelocationStatus": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The availability zone relocation status of the cluster" + }, + "Classic": { + "type": { + "$ref": "#/5" + }, + "flags": 4, + "description": "A boolean value indicating whether the resize operation is using the classic resize process. If you don't provide this parameter or set the value to false , the resize type is elastic." + }, + "ClusterIdentifier": { + "type": { + "$ref": "#/3" + }, + "flags": 16, + "description": "A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. All alphabetical characters must be lower case, no hypens at the end, no two consecutive hyphens. Cluster name should be unique for all clusters within an AWS account" + }, + "ClusterNamespaceArn": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) of the cluster namespace." + }, + "ClusterParameterGroupName": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The name of the parameter group to be associated with this cluster." + }, + "ClusterSecurityGroups": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "A list of security groups to be associated with this cluster." + }, + "ClusterSubnetGroupName": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The name of a cluster subnet group to be associated with this cluster." + }, + "ClusterType": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The type of the cluster. When cluster type is specified as single-node, the NumberOfNodes parameter is not required and if multi-node, the NumberOfNodes parameter is required" + }, + "ClusterVersion": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The version of the Amazon Redshift engine software that you want to deploy on the cluster.The version selected runs on all the nodes in the cluster." + }, + "DBName": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The name of the first database to be created when the cluster is created. To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database." + }, + "DeferMaintenance": { + "type": { + "$ref": "#/5" + }, + "flags": 4, + "description": "A boolean indicating whether to enable the deferred maintenance window." + }, + "DeferMaintenanceDuration": { + "type": { + "$ref": "#/6" + }, + "flags": 4, + "description": "An integer indicating the duration of the maintenance window in days. If you specify a duration, you can't specify an end time. The duration must be 45 days or less." + }, + "DeferMaintenanceEndTime": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration." + }, + "DeferMaintenanceIdentifier": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "A unique identifier for the deferred maintenance window." + }, + "DeferMaintenanceStartTime": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "A timestamp indicating the start time for the deferred maintenance window." + }, + "DestinationRegion": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The destination AWS Region that you want to copy snapshots to. Constraints: Must be the name of a valid AWS Region. For more information, see Regions and Endpoints in the Amazon Web Services [https://docs.aws.amazon.com/general/latest/gr/rande.html#redshift_region] General Reference" + }, + "ElasticIp": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The Elastic IP (EIP) address for the cluster." + }, + "Encrypted": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "If true, the data in the cluster is encrypted at rest." + }, + "Endpoint": { + "type": { + "$ref": "#/0" + }, + "flags": 0 + }, + "EnhancedVpcRouting": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.\n\nIf this option is true , enhanced VPC routing is enabled.\n\nDefault: false" + }, + "HsmClientCertificateIdentifier": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM" + }, + "HsmConfigurationIdentifier": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM." + }, + "IamRoles": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 50 IAM roles in a single request" + }, + "KmsKeyId": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster." + }, + "LoggingProperties": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "MaintenanceTrackName": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The name for the maintenance track that you want to assign for the cluster. This name change is asynchronous. The new track name stays in the PendingModifiedValues for the cluster until the next maintenance window. When the maintenance track changes, the cluster is switched to the latest cluster release available for the maintenance track. At this point, the maintenance track name is applied." + }, + "ManageMasterPassword": { + "type": { + "$ref": "#/5" + }, + "flags": 4, + "description": "A boolean indicating if the redshift cluster's admin user credentials is managed by Redshift or not. You can't use MasterUserPassword if ManageMasterPassword is true. If ManageMasterPassword is false or not set, Amazon Redshift uses MasterUserPassword for the admin user account's password." + }, + "ManualSnapshotRetentionPeriod": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "The number of days to retain newly copied snapshots in the destination AWS Region after they are copied from the source AWS Region. If the value is -1, the manual snapshot is retained indefinitely.\n\nThe value must be either -1 or an integer between 1 and 3,653." + }, + "MasterPasswordSecretArn": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) for the cluster's admin user credentials secret." + }, + "MasterPasswordSecretKmsKeyId": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin user credentials secret." + }, + "MasterUserPassword": { + "type": { + "$ref": "#/3" + }, + "flags": 4, + "description": "The password associated with the master user account for the cluster that is being created. You can't use MasterUserPassword if ManageMasterPassword is true. Password must be between 8 and 64 characters in length, should have at least one uppercase letter.Must contain at least one lowercase letter.Must contain one number.Can be any printable ASCII character." + }, + "MasterUsername": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The user name associated with the master user account for the cluster that is being created. The user name can't be PUBLIC and first character must be a letter." + }, + "MultiAZ": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "A boolean indicating if the redshift cluster is multi-az or not. If you don't provide this parameter or set the value to false, the redshift cluster will be single-az." + }, + "NamespaceResourcePolicy": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "The namespace resource policy document that will be attached to a Redshift cluster." + }, + "NodeType": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The node type to be provisioned for the cluster.Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.4xlarge | ra3.16xlarge" + }, + "NumberOfNodes": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node." + }, + "OwnerAccount": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "Port": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings" + }, + "PreferredMaintenanceWindow": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The weekly time range (in UTC) during which automated cluster maintenance can occur." + }, + "PubliclyAccessible": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "If true, the cluster can be accessed from a public network." + }, + "ResourceAction": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The Redshift operation to be performed. Resource Action supports pause-cluster, resume-cluster, failover-primary-compute APIs" + }, + "RevisionTarget": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request." + }, + "RotateEncryptionKey": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "A boolean indicating if we want to rotate Encryption Keys." + }, + "SnapshotClusterIdentifier": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The name of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name." + }, + "SnapshotCopyGrantName": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region." + }, + "SnapshotCopyManual": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots." + }, + "SnapshotCopyRetentionPeriod": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "The number of days to retain automated snapshots in the destination region after they are copied from the source region. \n\n Default is 7. \n\n Constraints: Must be at least 1 and no more than 35." + }, + "SnapshotIdentifier": { + "type": { + "$ref": "#/3" + }, + "flags": 4, + "description": "The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive." + }, + "Tags": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The list of tags for the cluster parameter group." + }, + "VpcSecurityGroupIds": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Redshift/Cluster", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/12" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Redshift/Cluster@default", + "scopeType": 0, + "body": { + "$ref": "#/13" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Parameter", + "properties": { + "ParameterName": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The name of the parameter." + }, + "ParameterValue": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The value of the parameter. If `ParameterName` is `wlm_json_configuration`, then the maximum size of `ParameterValue` is 8000 characters." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Redshift/ClusterParameterGroupProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/15" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/16" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Redshift/ClusterParameterGroupProperties", + "properties": { + "Description": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "A description of the parameter group." + }, + "ParameterGroupFamily": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters." + }, + "ParameterGroupName": { + "type": { + "$ref": "#/3" + }, + "flags": 16, + "description": "The name of the cluster parameter group." + }, + "Parameters": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request." + }, + "Tags": { + "type": { + "$ref": "#/19" + }, + "flags": 4, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Redshift/ClusterParameterGroup", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/20" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Redshift/ClusterParameterGroup@default", + "scopeType": 0, + "body": { + "$ref": "#/21" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Redshift/ClusterSubnetGroupProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/23" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Redshift/ClusterSubnetGroupProperties", + "properties": { + "ClusterSubnetGroupName": { + "type": { + "$ref": "#/3" + }, + "flags": 18, + "description": "This name must be unique for all subnet groups that are created by your AWS account. If costumer do not provide it, cloudformation will generate it. Must not be \"Default\". " + }, + "Description": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The description of the parameter group." + }, + "SubnetIds": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "The list of VPC subnet IDs" + }, + "Tags": { + "type": { + "$ref": "#/26" + }, + "flags": 4, + "description": "The list of tags for the cluster parameter group." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Redshift/ClusterSubnetGroup", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/27" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Redshift/ClusterSubnetGroup@default", + "scopeType": 0, + "body": { + "$ref": "#/28" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "NetworkInterface", + "properties": { + "AvailabilityZone": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The Availability Zone." + }, + "NetworkInterfaceId": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The network interface identifier." + }, + "PrivateIpAddress": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The IPv4 address of the network interface within the subnet." + }, + "SubnetId": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The subnet identifier." + } + } + }, + { + "$type": "ObjectType", + "name": "VpcSecurityGroup", + "properties": { + "Status": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The status of the VPC security group." + }, + "VpcSecurityGroupId": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The identifier of the VPC security group." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Redshift/EndpointAccessProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/30" + } + }, + { + "$type": "ObjectType", + "name": "EndpointAccess_VpcEndpoint", + "properties": { + "NetworkInterfaces": { + "type": { + "$ref": "#/33" + }, + "flags": 2, + "description": "One or more network interfaces of the endpoint. Also known as an interface endpoint." + }, + "VpcEndpointId": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy." + }, + "VpcId": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The VPC identifier that the endpoint is associated." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/31" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Redshift/EndpointAccessProperties", + "properties": { + "Address": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The DNS address of the endpoint." + }, + "ClusterIdentifier": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. All alphabetical characters must be lower case, no hypens at the end, no two consecutive hyphens. Cluster name should be unique for all clusters within an AWS account" + }, + "EndpointCreateTime": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The time (UTC) that the endpoint was created." + }, + "EndpointName": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "The name of the endpoint." + }, + "EndpointStatus": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The status of the endpoint." + }, + "Port": { + "type": { + "$ref": "#/6" + }, + "flags": 2, + "description": "The port number on which the cluster accepts incoming connections." + }, + "ResourceOwner": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The AWS account ID of the owner of the cluster." + }, + "SubnetGroupName": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The subnet group name where Amazon Redshift chooses to deploy the endpoint." + }, + "VpcEndpoint": { + "type": { + "$ref": "#/34" + }, + "flags": 2, + "description": "The connection endpoint for connecting to an Amazon Redshift cluster through the proxy." + }, + "VpcSecurityGroupIds": { + "type": { + "$ref": "#/35" + }, + "flags": 1, + "description": "A list of vpc security group ids to apply to the created endpoint access." + }, + "VpcSecurityGroups": { + "type": { + "$ref": "#/36" + }, + "flags": 2, + "description": "A list of Virtual Private Cloud (VPC) security groups to be associated with the endpoint." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Redshift/EndpointAccess", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/37" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Redshift/EndpointAccess@default", + "scopeType": 0, + "body": { + "$ref": "#/38" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AwsAccount", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "VpcId", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.Redshift/EndpointAuthorizationProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Redshift/EndpointAuthorizationProperties", + "properties": { + "Account": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "The target AWS account ID to grant or revoke access for." + }, + "AllowedAllVPCs": { + "type": { + "$ref": "#/5" + }, + "flags": 2, + "description": "Indicates whether all VPCs in the grantee account are allowed access to the cluster." + }, + "AllowedVPCs": { + "type": { + "$ref": "#/43" + }, + "flags": 2, + "description": "The VPCs allowed access to the cluster." + }, + "AuthorizeTime": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The time (UTC) when the authorization was created." + }, + "ClusterIdentifier": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "The cluster identifier." + }, + "ClusterStatus": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The status of the cluster." + }, + "EndpointCount": { + "type": { + "$ref": "#/6" + }, + "flags": 2, + "description": "The number of Redshift-managed VPC endpoints created for the authorization." + }, + "Force": { + "type": { + "$ref": "#/5" + }, + "flags": 4, + "description": " Indicates whether to force the revoke action. If true, the Redshift-managed VPC endpoints associated with the endpoint authorization are also deleted." + }, + "Grantee": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The AWS account ID of the grantee of the cluster." + }, + "Grantor": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The AWS account ID of the cluster owner." + }, + "Status": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The status of the authorization action." + }, + "VpcIds": { + "type": { + "$ref": "#/44" + }, + "flags": 0, + "description": "The virtual private cloud (VPC) identifiers to grant or revoke access to." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Redshift/EndpointAuthorization", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/45" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Redshift/EndpointAuthorization@default", + "scopeType": 0, + "body": { + "$ref": "#/46" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Redshift/EventSubscriptionProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/48" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Redshift/EventSubscriptionProperties", + "properties": { + "CustSubscriptionId": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The name of the Amazon Redshift event notification subscription." + }, + "CustomerAwsId": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The AWS account associated with the Amazon Redshift event notification subscription." + }, + "Enabled": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "A boolean value; set to true to activate the subscription, and set to false to create the subscription but not activate it." + }, + "EventCategories": { + "type": { + "$ref": "#/50" + }, + "flags": 0, + "description": "Specifies the Amazon Redshift event categories to be published by the event notification subscription." + }, + "EventCategoriesList": { + "type": { + "$ref": "#/51" + }, + "flags": 2, + "description": "The list of Amazon Redshift event categories specified in the event notification subscription." + }, + "Severity": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "Specifies the Amazon Redshift event severity to be published by the event notification subscription." + }, + "SnsTopicArn": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications." + }, + "SourceIds": { + "type": { + "$ref": "#/52" + }, + "flags": 0, + "description": "A list of one or more identifiers of Amazon Redshift source objects." + }, + "SourceIdsList": { + "type": { + "$ref": "#/53" + }, + "flags": 2, + "description": "A list of the sources that publish events to the Amazon Redshift event notification subscription." + }, + "SourceType": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The type of source that will be generating the events." + }, + "Status": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The status of the Amazon Redshift event notification subscription." + }, + "SubscriptionCreationTime": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The date and time the Amazon Redshift event notification subscription was created." + }, + "SubscriptionName": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "The name of the Amazon Redshift event notification subscription" + }, + "Tags": { + "type": { + "$ref": "#/54" + }, + "flags": 4, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Redshift/EventSubscription", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/55" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Redshift/EventSubscription@default", + "scopeType": 0, + "body": { + "$ref": "#/56" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "PauseClusterMessage", + "properties": { + "ClusterIdentifier": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ResizeClusterMessage", + "properties": { + "Classic": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "ClusterIdentifier": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + }, + "ClusterType": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "NodeType": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "NumberOfNodes": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ResumeClusterMessage", + "properties": { + "ClusterIdentifier": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ScheduledActionType", + "properties": { + "ResizeCluster": { + "type": { + "$ref": "#/59" + }, + "flags": 0 + }, + "PauseCluster": { + "type": { + "$ref": "#/58" + }, + "flags": 0 + }, + "ResumeCluster": { + "type": { + "$ref": "#/60" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "timestamp", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.Redshift/ScheduledActionProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Redshift/ScheduledActionProperties", + "properties": { + "Enable": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "If true, the schedule is enabled. If false, the scheduled action does not trigger." + }, + "EndTime": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The end time in UTC of the scheduled action. After this time, the scheduled action does not trigger." + }, + "IamRole": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The IAM role to assume to run the target action." + }, + "NextInvocations": { + "type": { + "$ref": "#/64" + }, + "flags": 2, + "description": "List of times when the scheduled action will run." + }, + "Schedule": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The schedule in `at( )` or `cron( )` format." + }, + "ScheduledActionDescription": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The description of the scheduled action." + }, + "ScheduledActionName": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "The name of the scheduled action. The name must be unique within an account." + }, + "StartTime": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The start time in UTC of the scheduled action. Before this time, the scheduled action does not trigger." + }, + "State": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The state of the scheduled action." + }, + "TargetAction": { + "type": { + "$ref": "#/61" + }, + "flags": 0, + "description": "A JSON format string of the Amazon Redshift API operation with input parameters." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Redshift/ScheduledAction", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/65" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Redshift/ScheduledAction@default", + "scopeType": 0, + "body": { + "$ref": "#/66" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.redshift/default/types.md b/artifacts/bicep/aws/aws.redshift/default/types.md index ac291db7..e90f45ae 100644 --- a/artifacts/bicep/aws/aws.redshift/default/types.md +++ b/artifacts/bicep/aws/aws.redshift/default/types.md @@ -3,51 +3,59 @@ ## Resource AWS.Redshift/Cluster@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Redshift/ClusterProperties](#awsredshiftclusterproperties) (Required): properties of the resource +* **properties**: [AWS.Redshift/ClusterProperties](#awsredshiftclusterproperties) (Required, Identifier): properties of the resource ## Resource AWS.Redshift/ClusterParameterGroup@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Redshift/ClusterParameterGroupProperties](#awsredshiftclusterparametergroupproperties) (Required): properties of the resource +* **properties**: [AWS.Redshift/ClusterParameterGroupProperties](#awsredshiftclusterparametergroupproperties) (Required, Identifier): properties of the resource ## Resource AWS.Redshift/ClusterSubnetGroup@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Redshift/ClusterSubnetGroupProperties](#awsredshiftclustersubnetgroupproperties) (Required): properties of the resource +* **properties**: [AWS.Redshift/ClusterSubnetGroupProperties](#awsredshiftclustersubnetgroupproperties) (Required, Identifier): properties of the resource ## Resource AWS.Redshift/EndpointAccess@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Redshift/EndpointAccessProperties](#awsredshiftendpointaccessproperties) (Required): properties of the resource +* **properties**: [AWS.Redshift/EndpointAccessProperties](#awsredshiftendpointaccessproperties) (Required, Identifier): properties of the resource ## Resource AWS.Redshift/EndpointAuthorization@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Redshift/EndpointAuthorizationProperties](#awsredshiftendpointauthorizationproperties) (Required): properties of the resource +* **properties**: [AWS.Redshift/EndpointAuthorizationProperties](#awsredshiftendpointauthorizationproperties) (Required, Identifier): properties of the resource ## Resource AWS.Redshift/EventSubscription@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Redshift/EventSubscriptionProperties](#awsredshifteventsubscriptionproperties) (Required): properties of the resource +* **properties**: [AWS.Redshift/EventSubscriptionProperties](#awsredshifteventsubscriptionproperties) (Required, Identifier): properties of the resource ## Resource AWS.Redshift/ScheduledAction@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Redshift/ScheduledActionProperties](#awsredshiftscheduledactionproperties) (Required): properties of the resource +* **properties**: [AWS.Redshift/ScheduledActionProperties](#awsredshiftscheduledactionproperties) (Required, Identifier): properties of the resource + +## AWS.Redshift/ClusterParameterGroupProperties +### Properties +* **Description**: string (Required): A description of the parameter group. +* **ParameterGroupFamily**: string (Required): The Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters. +* **ParameterGroupName**: string (Identifier): The name of the cluster parameter group. +* **Parameters**: [Parameter](#parameter)[]: An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request. +* **Tags**: [Tag](#tag)[] (WriteOnly): An array of key-value pairs to apply to this resource. ## AWS.Redshift/ClusterProperties ### Properties @@ -122,42 +130,6 @@ The value must be either -1 or an integer between 1 and 3,653. * **Tags**: [Tag](#tag)[]: The list of tags for the cluster parameter group. * **VpcSecurityGroupIds**: string[]: A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster. -## Endpoint -### Properties -* **Address**: string (ReadOnly) -* **Port**: string (ReadOnly) - -## LoggingProperties -### Properties -* **BucketName**: string -* **S3KeyPrefix**: string - -## Cluster_NamespaceResourcePolicy -### Properties - -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - -## AWS.Redshift/ClusterParameterGroupProperties -### Properties -* **Description**: string (Required): A description of the parameter group. -* **ParameterGroupFamily**: string (Required): The Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters. -* **ParameterGroupName**: string (Identifier): The name of the cluster parameter group. -* **Parameters**: [Parameter](#parameter)[]: An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request. -* **Tags**: [Tag](#tag)[] (WriteOnly): An array of key-value pairs to apply to this resource. - -## Parameter -### Properties -* **ParameterName**: string (Required): The name of the parameter. -* **ParameterValue**: string (Required): The value of the parameter. If `ParameterName` is `wlm_json_configuration`, then the maximum size of `ParameterValue` is 8000 characters. - -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## AWS.Redshift/ClusterSubnetGroupProperties ### Properties * **ClusterSubnetGroupName**: string (ReadOnly, Identifier): This name must be unique for all subnet groups that are created by your AWS account. If costumer do not provide it, cloudformation will generate it. Must not be "Default". @@ -165,11 +137,6 @@ The value must be either -1 or an integer between 1 and 3,653. * **SubnetIds**: string[] (Required): The list of VPC subnet IDs * **Tags**: [Tag](#tag)[] (WriteOnly): The list of tags for the cluster parameter group. -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## AWS.Redshift/EndpointAccessProperties ### Properties * **Address**: string (ReadOnly): The DNS address of the endpoint. @@ -184,24 +151,6 @@ The value must be either -1 or an integer between 1 and 3,653. * **VpcSecurityGroupIds**: string[] (Required): A list of vpc security group ids to apply to the created endpoint access. * **VpcSecurityGroups**: [VpcSecurityGroup](#vpcsecuritygroup)[] (ReadOnly): A list of Virtual Private Cloud (VPC) security groups to be associated with the endpoint. -## EndpointAccess_VpcEndpoint -### Properties -* **NetworkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): One or more network interfaces of the endpoint. Also known as an interface endpoint. -* **VpcEndpointId**: string (ReadOnly): The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy. -* **VpcId**: string (ReadOnly): The VPC identifier that the endpoint is associated. - -## NetworkInterface -### Properties -* **AvailabilityZone**: string: The Availability Zone. -* **NetworkInterfaceId**: string: The network interface identifier. -* **PrivateIpAddress**: string: The IPv4 address of the network interface within the subnet. -* **SubnetId**: string: The subnet identifier. - -## VpcSecurityGroup -### Properties -* **Status**: string: The status of the VPC security group. -* **VpcSecurityGroupId**: string: The identifier of the VPC security group. - ## AWS.Redshift/EndpointAuthorizationProperties ### Properties * **Account**: string (Required, Identifier): The target AWS account ID to grant or revoke access for. @@ -234,11 +183,6 @@ The value must be either -1 or an integer between 1 and 3,653. * **SubscriptionName**: string (Required, Identifier): The name of the Amazon Redshift event notification subscription * **Tags**: [Tag](#tag)[] (WriteOnly): An array of key-value pairs to apply to this resource. -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## AWS.Redshift/ScheduledActionProperties ### Properties * **Enable**: bool: If true, the schedule is enabled. If false, the scheduled action does not trigger. @@ -252,11 +196,36 @@ The value must be either -1 or an integer between 1 and 3,653. * **State**: string (ReadOnly): The state of the scheduled action. * **TargetAction**: [ScheduledActionType](#scheduledactiontype): A JSON format string of the Amazon Redshift API operation with input parameters. -## ScheduledActionType +## Cluster_NamespaceResourcePolicy ### Properties -* **PauseCluster**: [PauseClusterMessage](#pauseclustermessage) -* **ResizeCluster**: [ResizeClusterMessage](#resizeclustermessage) -* **ResumeCluster**: [ResumeClusterMessage](#resumeclustermessage) + +## Endpoint +### Properties +* **Address**: string (ReadOnly) +* **Port**: string (ReadOnly) + +## EndpointAccess_VpcEndpoint +### Properties +* **NetworkInterfaces**: [NetworkInterface](#networkinterface)[] (ReadOnly): One or more network interfaces of the endpoint. Also known as an interface endpoint. +* **VpcEndpointId**: string (ReadOnly): The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy. +* **VpcId**: string (ReadOnly): The VPC identifier that the endpoint is associated. + +## LoggingProperties +### Properties +* **BucketName**: string +* **S3KeyPrefix**: string + +## NetworkInterface +### Properties +* **AvailabilityZone**: string: The Availability Zone. +* **NetworkInterfaceId**: string: The network interface identifier. +* **PrivateIpAddress**: string: The IPv4 address of the network interface within the subnet. +* **SubnetId**: string: The subnet identifier. + +## Parameter +### Properties +* **ParameterName**: string (Required): The name of the parameter. +* **ParameterValue**: string (Required): The value of the parameter. If `ParameterName` is `wlm_json_configuration`, then the maximum size of `ParameterValue` is 8000 characters. ## PauseClusterMessage ### Properties @@ -274,3 +243,34 @@ The value must be either -1 or an integer between 1 and 3,653. ### Properties * **ClusterIdentifier**: string (Required) +## ScheduledActionType +### Properties +* **PauseCluster**: [PauseClusterMessage](#pauseclustermessage) +* **ResizeCluster**: [ResizeClusterMessage](#resizeclustermessage) +* **ResumeCluster**: [ResumeClusterMessage](#resumeclustermessage) + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## VpcSecurityGroup +### Properties +* **Status**: string: The status of the VPC security group. +* **VpcSecurityGroupId**: string: The identifier of the VPC security group. + diff --git a/artifacts/bicep/aws/aws.redshiftserverless/default/types.json b/artifacts/bicep/aws/aws.redshiftserverless/default/types.json index bd00a38b..fad98944 100644 --- a/artifacts/bicep/aws/aws.redshiftserverless/default/types.json +++ b/artifacts/bicep/aws/aws.redshiftserverless/default/types.json @@ -1 +1,746 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"LogExport"}},{"2":{"Name":"Namespace","Properties":{"AdminUsername":{"Type":4,"Flags":2},"CreationDate":{"Type":4,"Flags":2},"DbName":{"Type":4,"Flags":2},"DefaultIamRoleArn":{"Type":4,"Flags":2},"IamRoles":{"Type":12,"Flags":2},"KmsKeyId":{"Type":4,"Flags":2},"LogExports":{"Type":13,"Flags":2},"NamespaceArn":{"Type":4,"Flags":2},"NamespaceId":{"Type":4,"Flags":2},"NamespaceName":{"Type":4,"Flags":18},"Status":{"Type":4,"Flags":2}}}},{"2":{"Name":"NamespaceStatus"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.RedshiftServerless/NamespaceProperties","Properties":{"AdminUserPassword":{"Type":4,"Flags":4,"Description":"The password associated with the admin user for the namespace that is being created. Password must be at least 8 characters in length, should be any printable ASCII character. Must contain at least one lowercase letter, one uppercase letter and one decimal digit."},"AdminUsername":{"Type":4,"Flags":0,"Description":"The user name associated with the admin user for the namespace that is being created. Only alphanumeric characters and underscores are allowed. It should start with an alphabet."},"DbName":{"Type":4,"Flags":0,"Description":"The database name associated for the namespace that is being created. Only alphanumeric characters and underscores are allowed. It should start with an alphabet."},"DefaultIamRoleArn":{"Type":4,"Flags":0,"Description":"The default IAM role ARN for the namespace that is being created."},"FinalSnapshotName":{"Type":4,"Flags":4,"Description":"The name of the namespace the source snapshot was created from. Please specify the name if needed before deleting namespace"},"FinalSnapshotRetentionPeriod":{"Type":3,"Flags":4,"Description":"The number of days to retain automated snapshot in the destination region after they are copied from the source region. If the value is -1, the manual snapshot is retained indefinitely. The value must be either -1 or an integer between 1 and 3,653."},"IamRoles":{"Type":15,"Flags":0,"Description":"A list of AWS Identity and Access Management (IAM) roles that can be used by the namespace to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. The Default role limit for each request is 10."},"KmsKeyId":{"Type":4,"Flags":0,"Description":"The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the namespace."},"LogExports":{"Type":16,"Flags":0,"Description":"The collection of log types to be exported provided by the customer. Should only be one of the three supported log types: userlog, useractivitylog and connectionlog"},"Namespace":{"Type":9,"Flags":2},"NamespaceName":{"Type":4,"Flags":17,"Description":"A unique identifier for the namespace. You use this identifier to refer to the namespace for any subsequent namespace operations such as deleting or modifying. All alphabetical characters must be lower case. Namespace name should be unique for all namespaces within an AWS account."},"Tags":{"Type":17,"Flags":4,"Description":"The list of tags for the namespace."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":11}},{"2":{"Name":"AWS.RedshiftServerless/Namespace","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":14,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.RedshiftServerless/Namespace@default","ScopeType":0,"Body":18}},{"2":{"Name":"ConfigParameter","Properties":{"ParameterKey":{"Type":4,"Flags":0},"ParameterValue":{"Type":4,"Flags":0}}}},{"2":{"Name":"Endpoint","Properties":{"Address":{"Type":4,"Flags":2},"Port":{"Type":3,"Flags":2},"VpcEndpoints":{"Type":27,"Flags":2}}}},{"2":{"Name":"NetworkInterface","Properties":{"AvailabilityZone":{"Type":4,"Flags":0},"NetworkInterfaceId":{"Type":4,"Flags":0},"PrivateIpAddress":{"Type":4,"Flags":0},"SubnetId":{"Type":4,"Flags":0}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"VpcEndpoint","Properties":{"NetworkInterfaces":{"Type":28,"Flags":0},"VpcEndpointId":{"Type":4,"Flags":0},"VpcId":{"Type":4,"Flags":0}}}},{"2":{"Name":"Workgroup","Properties":{"BaseCapacity":{"Type":3,"Flags":2},"ConfigParameters":{"Type":29,"Flags":2},"CreationDate":{"Type":4,"Flags":2},"Endpoint":{"Type":21,"Flags":0},"EnhancedVpcRouting":{"Type":2,"Flags":2},"NamespaceName":{"Type":4,"Flags":2},"PubliclyAccessible":{"Type":2,"Flags":2},"SecurityGroupIds":{"Type":30,"Flags":2},"Status":{"Type":4,"Flags":2},"SubnetIds":{"Type":31,"Flags":2},"WorkgroupArn":{"Type":4,"Flags":2},"WorkgroupId":{"Type":4,"Flags":2},"WorkgroupName":{"Type":4,"Flags":18}}}},{"2":{"Name":"WorkgroupStatus"}},{"3":{"ItemType":24}},{"3":{"ItemType":22}},{"3":{"ItemType":20}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.RedshiftServerless/WorkgroupProperties","Properties":{"BaseCapacity":{"Type":3,"Flags":4},"ConfigParameters":{"Type":33,"Flags":4},"EnhancedVpcRouting":{"Type":2,"Flags":0},"NamespaceName":{"Type":4,"Flags":0},"Port":{"Type":3,"Flags":0},"PubliclyAccessible":{"Type":2,"Flags":0},"SecurityGroupIds":{"Type":34,"Flags":4},"SubnetIds":{"Type":35,"Flags":4},"Tags":{"Type":36,"Flags":4},"Workgroup":{"Type":25,"Flags":2},"WorkgroupName":{"Type":4,"Flags":17}}}},{"3":{"ItemType":20}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":23}},{"2":{"Name":"AWS.RedshiftServerless/Workgroup","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":32,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.RedshiftServerless/Workgroup@default","ScopeType":0,"Body":37}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "LogExport", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Namespace", + "properties": { + "AdminPasswordSecretArn": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "AdminPasswordSecretKmsKeyId": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "AdminUsername": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "CreationDate": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "DbName": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "DefaultIamRoleArn": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "IamRoles": { + "type": { + "$ref": "#/6" + }, + "flags": 2 + }, + "KmsKeyId": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "LogExports": { + "type": { + "$ref": "#/7" + }, + "flags": 2 + }, + "NamespaceArn": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "NamespaceId": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "NamespaceName": { + "type": { + "$ref": "#/5" + }, + "flags": 18 + }, + "Status": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + } + } + }, + { + "$type": "ObjectType", + "name": "NamespaceStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SnapshotCopyConfiguration", + "properties": { + "DestinationKmsKeyId": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "DestinationRegion": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "SnapshotRetentionPeriod": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.RedshiftServerless/NamespaceProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "ObjectType", + "name": "Namespace_NamespaceResourcePolicy", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ObjectType", + "name": "AWS.RedshiftServerless/NamespaceProperties", + "properties": { + "AdminPasswordSecretKmsKeyId": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The 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." + }, + "AdminUserPassword": { + "type": { + "$ref": "#/5" + }, + "flags": 4, + "description": "The password associated with the admin user for the namespace that is being created. Password must be at least 8 characters in length, should be any printable ASCII character. Must contain at least one lowercase letter, one uppercase letter and one decimal digit. You can't use adminUserPassword if manageAdminPassword is true." + }, + "AdminUsername": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The user name associated with the admin user for the namespace that is being created. Only alphanumeric characters and underscores are allowed. It should start with an alphabet." + }, + "DbName": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The database name associated for the namespace that is being created. Only alphanumeric characters and underscores are allowed. It should start with an alphabet." + }, + "DefaultIamRoleArn": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The default IAM role ARN for the namespace that is being created." + }, + "FinalSnapshotName": { + "type": { + "$ref": "#/5" + }, + "flags": 4, + "description": "The name of the namespace the source snapshot was created from. Please specify the name if needed before deleting namespace" + }, + "FinalSnapshotRetentionPeriod": { + "type": { + "$ref": "#/8" + }, + "flags": 4, + "description": "The number of days to retain automated snapshot in the destination region after they are copied from the source region. If the value is -1, the manual snapshot is retained indefinitely. The value must be either -1 or an integer between 1 and 3,653." + }, + "IamRoles": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "A list of AWS Identity and Access Management (IAM) roles that can be used by the namespace to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. The Default role limit for each request is 10." + }, + "KmsKeyId": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the namespace." + }, + "LogExports": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "The collection of log types to be exported provided by the customer. Should only be one of the three supported log types: userlog, useractivitylog and connectionlog" + }, + "ManageAdminPassword": { + "type": { + "$ref": "#/12" + }, + "flags": 4, + "description": "If 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." + }, + "Namespace": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "Definition of Namespace resource." + }, + "NamespaceName": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "A unique identifier for the namespace. You use this identifier to refer to the namespace for any subsequent namespace operations such as deleting or modifying. All alphabetical characters must be lower case. Namespace name should be unique for all namespaces within an AWS account." + }, + "NamespaceResourcePolicy": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "The resource policy document that will be attached to the namespace." + }, + "RedshiftIdcApplicationArn": { + "type": { + "$ref": "#/5" + }, + "flags": 4, + "description": "The ARN for the Redshift application that integrates with IAM Identity Center." + }, + "SnapshotCopyConfigurations": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The snapshot copy configurations for the namespace." + }, + "Tags": { + "type": { + "$ref": "#/15" + }, + "flags": 4, + "description": "The list of tags for the namespace." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.RedshiftServerless/Namespace", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/16" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.RedshiftServerless/Namespace@default", + "scopeType": 0, + "body": { + "$ref": "#/17" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "ConfigParameter", + "properties": { + "ParameterKey": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "ParameterValue": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Endpoint", + "properties": { + "Address": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "Port": { + "type": { + "$ref": "#/8" + }, + "flags": 2 + }, + "VpcEndpoints": { + "type": { + "$ref": "#/26" + }, + "flags": 2 + } + } + }, + { + "$type": "ObjectType", + "name": "NetworkInterface", + "properties": { + "AvailabilityZone": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "NetworkInterfaceId": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "PrivateIpAddress": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "SubnetId": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "VpcEndpoint", + "properties": { + "NetworkInterfaces": { + "type": { + "$ref": "#/27" + }, + "flags": 0 + }, + "VpcEndpointId": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "VpcId": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Workgroup", + "properties": { + "BaseCapacity": { + "type": { + "$ref": "#/8" + }, + "flags": 2 + }, + "ConfigParameters": { + "type": { + "$ref": "#/28" + }, + "flags": 2 + }, + "CreationDate": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "Endpoint": { + "type": { + "$ref": "#/20" + }, + "flags": 0 + }, + "EnhancedVpcRouting": { + "type": { + "$ref": "#/12" + }, + "flags": 2 + }, + "MaxCapacity": { + "type": { + "$ref": "#/8" + }, + "flags": 2 + }, + "NamespaceName": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "PubliclyAccessible": { + "type": { + "$ref": "#/12" + }, + "flags": 2 + }, + "SecurityGroupIds": { + "type": { + "$ref": "#/29" + }, + "flags": 2 + }, + "Status": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "SubnetIds": { + "type": { + "$ref": "#/30" + }, + "flags": 2 + }, + "WorkgroupArn": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "WorkgroupId": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "WorkgroupName": { + "type": { + "$ref": "#/5" + }, + "flags": 18 + } + } + }, + { + "$type": "ObjectType", + "name": "WorkgroupStatus", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/23" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/21" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/19" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.RedshiftServerless/WorkgroupProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/19" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/22" + } + }, + { + "$type": "ObjectType", + "name": "AWS.RedshiftServerless/WorkgroupProperties", + "properties": { + "BaseCapacity": { + "type": { + "$ref": "#/8" + }, + "flags": 4, + "description": "The base compute capacity of the workgroup in Redshift Processing Units (RPUs)." + }, + "ConfigParameters": { + "type": { + "$ref": "#/32" + }, + "flags": 4, + "description": "A list of parameters to set for finer control over a database. Available options are datestyle, enable_user_activity_logging, query_group, search_path, max_query_execution_time, and require_ssl." + }, + "EnhancedVpcRouting": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC." + }, + "MaxCapacity": { + "type": { + "$ref": "#/8" + }, + "flags": 4, + "description": "The max compute capacity of the workgroup in Redshift Processing Units (RPUs)." + }, + "NamespaceName": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The namespace the workgroup is associated with." + }, + "Port": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439." + }, + "PubliclyAccessible": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "A value that specifies whether the workgroup can be accessible from a public network." + }, + "SecurityGroupIds": { + "type": { + "$ref": "#/33" + }, + "flags": 4, + "description": "A list of security group IDs to associate with the workgroup." + }, + "SubnetIds": { + "type": { + "$ref": "#/34" + }, + "flags": 4, + "description": "A list of subnet IDs the workgroup is associated with." + }, + "Tags": { + "type": { + "$ref": "#/35" + }, + "flags": 4, + "description": "The map of the key-value pairs used to tag the workgroup." + }, + "Workgroup": { + "type": { + "$ref": "#/24" + }, + "flags": 2, + "description": "Definition for workgroup resource" + }, + "WorkgroupName": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "The name of the workgroup." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.RedshiftServerless/Workgroup", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/36" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.RedshiftServerless/Workgroup@default", + "scopeType": 0, + "body": { + "$ref": "#/37" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.redshiftserverless/default/types.md b/artifacts/bicep/aws/aws.redshiftserverless/default/types.md index e357002e..b346639d 100644 --- a/artifacts/bicep/aws/aws.redshiftserverless/default/types.md +++ b/artifacts/bicep/aws/aws.redshiftserverless/default/types.md @@ -3,21 +3,22 @@ ## Resource AWS.RedshiftServerless/Namespace@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.RedshiftServerless/NamespaceProperties](#awsredshiftserverlessnamespaceproperties) (Required): properties of the resource +* **properties**: [AWS.RedshiftServerless/NamespaceProperties](#awsredshiftserverlessnamespaceproperties) (Required, Identifier): properties of the resource ## Resource AWS.RedshiftServerless/Workgroup@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.RedshiftServerless/WorkgroupProperties](#awsredshiftserverlessworkgroupproperties) (Required): properties of the resource +* **properties**: [AWS.RedshiftServerless/WorkgroupProperties](#awsredshiftserverlessworkgroupproperties) (Required, Identifier): properties of the resource ## AWS.RedshiftServerless/NamespaceProperties ### Properties +* **AdminPasswordSecretKmsKeyId**: string: The 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. * **AdminUsername**: string: The user name associated with the admin user for the namespace that is being created. Only alphanumeric characters and underscores are allowed. It should start with an alphabet. -* **AdminUserPassword**: string (WriteOnly): The password associated with the admin user for the namespace that is being created. Password must be at least 8 characters in length, should be any printable ASCII character. Must contain at least one lowercase letter, one uppercase letter and one decimal digit. +* **AdminUserPassword**: string (WriteOnly): The password associated with the admin user for the namespace that is being created. Password must be at least 8 characters in length, should be any printable ASCII character. Must contain at least one lowercase letter, one uppercase letter and one decimal digit. You can't use adminUserPassword if manageAdminPassword is true. * **DbName**: string: The database name associated for the namespace that is being created. Only alphanumeric characters and underscores are allowed. It should start with an alphabet. * **DefaultIamRoleArn**: string: The default IAM role ARN for the namespace that is being created. * **FinalSnapshotName**: string (WriteOnly): The name of the namespace the source snapshot was created from. Please specify the name if needed before deleting namespace @@ -25,12 +26,44 @@ * **IamRoles**: string[]: A list of AWS Identity and Access Management (IAM) roles that can be used by the namespace to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. The Default role limit for each request is 10. * **KmsKeyId**: string: The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the namespace. * **LogExports**: string[]: The collection of log types to be exported provided by the customer. Should only be one of the three supported log types: userlog, useractivitylog and connectionlog -* **Namespace**: [Namespace](#namespace) (ReadOnly) +* **ManageAdminPassword**: bool (WriteOnly): If 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. +* **Namespace**: [Namespace](#namespace) (ReadOnly): Definition of Namespace resource. * **NamespaceName**: string (Required, Identifier): A unique identifier for the namespace. You use this identifier to refer to the namespace for any subsequent namespace operations such as deleting or modifying. All alphabetical characters must be lower case. Namespace name should be unique for all namespaces within an AWS account. +* **NamespaceResourcePolicy**: [Namespace_NamespaceResourcePolicy](#namespacenamespaceresourcepolicy): The resource policy document that will be attached to the namespace. +* **RedshiftIdcApplicationArn**: string (WriteOnly): The ARN for the Redshift application that integrates with IAM Identity Center. +* **SnapshotCopyConfigurations**: [SnapshotCopyConfiguration](#snapshotcopyconfiguration)[]: The snapshot copy configurations for the namespace. * **Tags**: [Tag](#tag)[] (WriteOnly): The list of tags for the namespace. +## AWS.RedshiftServerless/WorkgroupProperties +### Properties +* **BaseCapacity**: int (WriteOnly): The base compute capacity of the workgroup in Redshift Processing Units (RPUs). +* **ConfigParameters**: [ConfigParameter](#configparameter)[] (WriteOnly): A list of parameters to set for finer control over a database. Available options are datestyle, enable_user_activity_logging, query_group, search_path, max_query_execution_time, and require_ssl. +* **EnhancedVpcRouting**: bool: The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC. +* **MaxCapacity**: int (WriteOnly): The max compute capacity of the workgroup in Redshift Processing Units (RPUs). +* **NamespaceName**: string: The namespace the workgroup is associated with. +* **Port**: int: The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439. +* **PubliclyAccessible**: bool: A value that specifies whether the workgroup can be accessible from a public network. +* **SecurityGroupIds**: string[] (WriteOnly): A list of security group IDs to associate with the workgroup. +* **SubnetIds**: string[] (WriteOnly): A list of subnet IDs the workgroup is associated with. +* **Tags**: [Tag](#tag)[] (WriteOnly): The map of the key-value pairs used to tag the workgroup. +* **Workgroup**: [Workgroup](#workgroup) (ReadOnly): Definition for workgroup resource +* **WorkgroupName**: string (Required, Identifier): The name of the workgroup. + +## ConfigParameter +### Properties +* **ParameterKey**: string +* **ParameterValue**: string + +## Endpoint +### Properties +* **Address**: string (ReadOnly) +* **Port**: int (ReadOnly) +* **VpcEndpoints**: [VpcEndpoint](#vpcendpoint)[] (ReadOnly) + ## Namespace ### Properties +* **AdminPasswordSecretArn**: string +* **AdminPasswordSecretKmsKeyId**: string * **AdminUsername**: string (ReadOnly) * **CreationDate**: string (ReadOnly) * **DbName**: string (ReadOnly) @@ -43,35 +76,38 @@ * **NamespaceName**: string (ReadOnly, Identifier) * **Status**: string (ReadOnly) -## Tag +## Namespace_NamespaceResourcePolicy ### Properties -* **Key**: string (Required) -* **Value**: string (Required) -## AWS.RedshiftServerless/WorkgroupProperties +## NetworkInterface ### Properties -* **BaseCapacity**: int (WriteOnly) -* **ConfigParameters**: [ConfigParameter](#configparameter)[] (WriteOnly) -* **EnhancedVpcRouting**: bool -* **NamespaceName**: string -* **Port**: int -* **PubliclyAccessible**: bool -* **SecurityGroupIds**: string[] (WriteOnly) -* **SubnetIds**: string[] (WriteOnly) -* **Tags**: [Tag](#tag)[] (WriteOnly) -* **Workgroup**: [Workgroup](#workgroup) (ReadOnly) -* **WorkgroupName**: string (Required, Identifier) +* **AvailabilityZone**: string +* **NetworkInterfaceId**: string +* **PrivateIpAddress**: string +* **SubnetId**: string -## ConfigParameter +## SnapshotCopyConfiguration ### Properties -* **ParameterKey**: string -* **ParameterValue**: string +* **DestinationKmsKeyId**: string +* **DestinationRegion**: string (Required) +* **SnapshotRetentionPeriod**: int + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) ## Tag ### Properties * **Key**: string (Required) * **Value**: string (Required) +## VpcEndpoint +### Properties +* **NetworkInterfaces**: [NetworkInterface](#networkinterface)[] +* **VpcEndpointId**: string +* **VpcId**: string + ## Workgroup ### Properties * **BaseCapacity**: int (ReadOnly) @@ -79,6 +115,7 @@ * **CreationDate**: string (ReadOnly) * **Endpoint**: [Endpoint](#endpoint) * **EnhancedVpcRouting**: bool (ReadOnly) +* **MaxCapacity**: int (ReadOnly) * **NamespaceName**: string (ReadOnly) * **PubliclyAccessible**: bool (ReadOnly) * **SecurityGroupIds**: string[] (ReadOnly) @@ -88,22 +125,3 @@ * **WorkgroupId**: string (ReadOnly) * **WorkgroupName**: string (ReadOnly, Identifier) -## Endpoint -### Properties -* **Address**: string (ReadOnly) -* **Port**: int (ReadOnly) -* **VpcEndpoints**: [VpcEndpoint](#vpcendpoint)[] (ReadOnly) - -## VpcEndpoint -### Properties -* **NetworkInterfaces**: [NetworkInterface](#networkinterface)[] -* **VpcEndpointId**: string -* **VpcId**: string - -## NetworkInterface -### Properties -* **AvailabilityZone**: string -* **NetworkInterfaceId**: string -* **PrivateIpAddress**: string -* **SubnetId**: string - diff --git a/artifacts/bicep/aws/aws.refactorspaces/default/types.json b/artifacts/bicep/aws/aws.refactorspaces/default/types.json index 67a25844..b84467ad 100644 --- a/artifacts/bicep/aws/aws.refactorspaces/default/types.json +++ b/artifacts/bicep/aws/aws.refactorspaces/default/types.json @@ -1 +1,210 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"DefaultRouteInput","Properties":{"ActivationState":{"Type":4,"Flags":1}}}},{"2":{"Name":"Method"}},{"2":{"Name":"RouteActivationState"}},{"2":{"Name":"RouteType"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"A string used to identify this tag"},"Value":{"Type":4,"Flags":1,"Description":"A string containing the value for the tag"}}}},{"2":{"Name":"UriPathRouteInput","Properties":{"ActivationState":{"Type":4,"Flags":1},"AppendSourcePath":{"Type":2,"Flags":0},"IncludeChildPaths":{"Type":2,"Flags":0},"Methods":{"Type":14,"Flags":0},"SourcePath":{"Type":4,"Flags":0}}}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.RefactorSpaces/RouteProperties","Properties":{"ApplicationIdentifier":{"Type":4,"Flags":17},"Arn":{"Type":4,"Flags":2},"DefaultRoute":{"Type":8,"Flags":4},"EnvironmentIdentifier":{"Type":4,"Flags":17},"PathResourceToId":{"Type":4,"Flags":2},"RouteIdentifier":{"Type":4,"Flags":18},"RouteType":{"Type":4,"Flags":5},"ServiceIdentifier":{"Type":4,"Flags":5},"Tags":{"Type":16,"Flags":0,"Description":"Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair."},"UriPathRoute":{"Type":13,"Flags":4}}}},{"3":{"ItemType":12}},{"2":{"Name":"AWS.RefactorSpaces/Route","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":15,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.RefactorSpaces/Route@default","ScopeType":0,"Body":17}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "DefaultRouteInput", + "properties": { + "ActivationState": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Method", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RouteActivationState", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RouteType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "A string used to identify this tag" + }, + "Value": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "A string containing the value for the tag" + } + } + }, + { + "$type": "ObjectType", + "name": "UriPathRouteInput", + "properties": { + "ActivationState": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "AppendSourcePath": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "IncludeChildPaths": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "Methods": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "SourcePath": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.RefactorSpaces/RouteProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ObjectType", + "name": "AWS.RefactorSpaces/RouteProperties", + "properties": { + "ApplicationIdentifier": { + "type": { + "$ref": "#/6" + }, + "flags": 17 + }, + "Arn": { + "type": { + "$ref": "#/6" + }, + "flags": 2 + }, + "DefaultRoute": { + "type": { + "$ref": "#/0" + }, + "flags": 4 + }, + "EnvironmentIdentifier": { + "type": { + "$ref": "#/6" + }, + "flags": 17 + }, + "PathResourceToId": { + "type": { + "$ref": "#/6" + }, + "flags": 2 + }, + "RouteIdentifier": { + "type": { + "$ref": "#/6" + }, + "flags": 18 + }, + "RouteType": { + "type": { + "$ref": "#/6" + }, + "flags": 5 + }, + "ServiceIdentifier": { + "type": { + "$ref": "#/6" + }, + "flags": 5 + }, + "Tags": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair." + }, + "UriPathRoute": { + "type": { + "$ref": "#/5" + }, + "flags": 4 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.RefactorSpaces/Route", + "properties": { + "name": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/6" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/11" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.RefactorSpaces/Route@default", + "scopeType": 0, + "body": { + "$ref": "#/12" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.refactorspaces/default/types.md b/artifacts/bicep/aws/aws.refactorspaces/default/types.md index d3d41020..7ee4ae13 100644 --- a/artifacts/bicep/aws/aws.refactorspaces/default/types.md +++ b/artifacts/bicep/aws/aws.refactorspaces/default/types.md @@ -3,9 +3,9 @@ ## Resource AWS.RefactorSpaces/Route@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.RefactorSpaces/RouteProperties](#awsrefactorspacesrouteproperties) (Required): properties of the resource +* **properties**: [AWS.RefactorSpaces/RouteProperties](#awsrefactorspacesrouteproperties) (Required, Identifier): properties of the resource ## AWS.RefactorSpaces/RouteProperties ### Properties diff --git a/artifacts/bicep/aws/aws.rekognition/default/types.json b/artifacts/bicep/aws/aws.rekognition/default/types.json index 53fd0857..230a6893 100644 --- a/artifacts/bicep/aws/aws.rekognition/default/types.json +++ b/artifacts/bicep/aws/aws.rekognition/default/types.json @@ -1 +1,568 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"Arn"}},{"2":{"Name":"CollectionId"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.Rekognition/CollectionProperties","Properties":{"Arn":{"Type":4,"Flags":2},"CollectionId":{"Type":4,"Flags":17},"Tags":{"Type":12,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."}}}},{"3":{"ItemType":10}},{"2":{"Name":"AWS.Rekognition/Collection","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":11,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Rekognition/Collection@default","ScopeType":0,"Body":13}},{"2":{"Name":"Arn"}},{"2":{"Name":"ProjectName"}},{"2":{"Name":"AWS.Rekognition/ProjectProperties","Properties":{"Arn":{"Type":4,"Flags":2},"ProjectName":{"Type":4,"Flags":17}}}},{"2":{"Name":"AWS.Rekognition/Project","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":17,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Rekognition/Project@default","ScopeType":0,"Body":18}},{"2":{"Name":"Arn"}},{"2":{"Name":"BoundingBox","Properties":{"Height":{"Type":3,"Flags":1},"Left":{"Type":3,"Flags":1},"Top":{"Type":3,"Flags":1},"Width":{"Type":3,"Flags":1}}}},{"2":{"Name":"ConnectedHomeSettings","Properties":{"Labels":{"Type":33,"Flags":1},"MinConfidence":{"Type":3,"Flags":0,"Description":"Minimum object class match confidence score that must be met to return a result for a recognized object."}}}},{"2":{"Name":"DataSharingPreference","Properties":{"OptIn":{"Type":2,"Flags":1,"Description":"Flag to enable data-sharing"}}}},{"2":{"Name":"FaceSearchSettings","Properties":{"CollectionId":{"Type":4,"Flags":1,"Description":"The ID of a collection that contains faces that you want to search for."},"FaceMatchThreshold":{"Type":3,"Flags":0,"Description":"Minimum face match confidence score percentage that must be met to return a result for a recognized face. The default is 80. 0 is the lowest confidence. 100 is the highest confidence. Values between 0 and 100 are accepted."}}}},{"2":{"Name":"KinesisDataStream","Properties":{"Arn":{"Type":4,"Flags":1,"Description":"ARN of the Kinesis Data Stream stream."}}}},{"2":{"Name":"KinesisVideoStream","Properties":{"Arn":{"Type":4,"Flags":1,"Description":"ARN of the Kinesis Video Stream that streams the source video."}}}},{"2":{"Name":"Labels"}},{"2":{"Name":"NotificationChannel","Properties":{"Arn":{"Type":4,"Flags":1,"Description":"ARN of the SNS topic."}}}},{"2":{"Name":"Point","Properties":{"X":{"Type":3,"Flags":1,"Description":"The X coordinate of the point."},"Y":{"Type":3,"Flags":1,"Description":"The Y coordinate of the point."}}}},{"2":{"Name":"Polygon"}},{"2":{"Name":"S3Destination","Properties":{"BucketName":{"Type":4,"Flags":1,"Description":"Name of the S3 bucket."},"ObjectKeyPrefix":{"Type":4,"Flags":0,"Description":"The object key prefix path where the results will be stored. Default is no prefix path"}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":29}},{"2":{"Name":"AWS.Rekognition/StreamProcessorProperties","Properties":{"Arn":{"Type":4,"Flags":2},"BoundingBoxRegionsOfInterest":{"Type":37,"Flags":0,"Description":"The BoundingBoxRegionsOfInterest specifies an array of bounding boxes of interest in the video frames to analyze, as part of connected home feature. If an object is partially in a region of interest, Rekognition will tag it as detected if the overlap of the object with the region-of-interest is greater than 20%."},"ConnectedHomeSettings":{"Type":22,"Flags":0},"DataSharingPreference":{"Type":23,"Flags":0},"FaceSearchSettings":{"Type":24,"Flags":0},"KinesisDataStream":{"Type":25,"Flags":0},"KinesisVideoStream":{"Type":26,"Flags":1},"KmsKeyId":{"Type":4,"Flags":0,"Description":"The KMS key that is used by Rekognition to encrypt any intermediate customer metadata and store in the customer's S3 bucket."},"Name":{"Type":4,"Flags":16,"Description":"Name of the stream processor. It's an identifier you assign to the stream processor. You can use it to manage the stream processor."},"NotificationChannel":{"Type":28,"Flags":0},"PolygonRegionsOfInterest":{"Type":39,"Flags":0,"Description":"The PolygonRegionsOfInterest specifies a set of polygon areas of interest in the video frames to analyze, as part of connected home feature. Each polygon is in turn, an ordered list of Point"},"RoleArn":{"Type":4,"Flags":1,"Description":"ARN of the IAM role that allows access to the stream processor, and provides Rekognition read permissions for KVS stream and write permissions to S3 bucket and SNS topic."},"S3Destination":{"Type":31,"Flags":0},"Status":{"Type":4,"Flags":2,"Description":"Current status of the stream processor."},"StatusMessage":{"Type":4,"Flags":2,"Description":"Detailed status message about the stream processor."},"Tags":{"Type":40,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."}}}},{"3":{"ItemType":21}},{"3":{"ItemType":29}},{"3":{"ItemType":38}},{"3":{"ItemType":32}},{"2":{"Name":"AWS.Rekognition/StreamProcessor","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":36,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Rekognition/StreamProcessor@default","ScopeType":0,"Body":41}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Arn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CollectionId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.Rekognition/CollectionProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Rekognition/CollectionProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/3" + }, + "flags": 2 + }, + "CollectionId": { + "type": { + "$ref": "#/3" + }, + "flags": 17 + }, + "Tags": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Rekognition/Collection", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/6" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Rekognition/Collection@default", + "scopeType": 0, + "body": { + "$ref": "#/7" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Arn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ProjectName", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.Rekognition/ProjectProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.Rekognition/ProjectProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/3" + }, + "flags": 2 + }, + "ProjectName": { + "type": { + "$ref": "#/3" + }, + "flags": 17 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Rekognition/Project", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/12" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Rekognition/Project@default", + "scopeType": 0, + "body": { + "$ref": "#/13" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Arn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "BoundingBox", + "properties": { + "Height": { + "type": { + "$ref": "#/28" + }, + "flags": 1 + }, + "Left": { + "type": { + "$ref": "#/28" + }, + "flags": 1 + }, + "Top": { + "type": { + "$ref": "#/28" + }, + "flags": 1 + }, + "Width": { + "type": { + "$ref": "#/28" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ConnectedHomeSettings", + "properties": { + "Labels": { + "type": { + "$ref": "#/29" + }, + "flags": 1 + }, + "MinConfidence": { + "type": { + "$ref": "#/28" + }, + "flags": 0, + "description": "Minimum object class match confidence score that must be met to return a result for a recognized object." + } + } + }, + { + "$type": "ObjectType", + "name": "DataSharingPreference", + "properties": { + "OptIn": { + "type": { + "$ref": "#/30" + }, + "flags": 1, + "description": "Flag to enable data-sharing" + } + } + }, + { + "$type": "ObjectType", + "name": "FaceSearchSettings", + "properties": { + "CollectionId": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The ID of a collection that contains faces that you want to search for." + }, + "FaceMatchThreshold": { + "type": { + "$ref": "#/28" + }, + "flags": 0, + "description": "Minimum face match confidence score percentage that must be met to return a result for a recognized face. The default is 80. 0 is the lowest confidence. 100 is the highest confidence. Values between 0 and 100 are accepted." + } + } + }, + { + "$type": "ObjectType", + "name": "KinesisDataStream", + "properties": { + "Arn": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "ARN of the Kinesis Data Stream stream." + } + } + }, + { + "$type": "ObjectType", + "name": "KinesisVideoStream", + "properties": { + "Arn": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "ARN of the Kinesis Video Stream that streams the source video." + } + } + }, + { + "$type": "ObjectType", + "name": "Labels", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "NotificationChannel", + "properties": { + "Arn": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "ARN of the SNS topic." + } + } + }, + { + "$type": "ObjectType", + "name": "Point", + "properties": { + "X": { + "type": { + "$ref": "#/28" + }, + "flags": 1, + "description": "The X coordinate of the point." + }, + "Y": { + "type": { + "$ref": "#/28" + }, + "flags": 1, + "description": "The Y coordinate of the point." + } + } + }, + { + "$type": "ObjectType", + "name": "Polygon", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "S3Destination", + "properties": { + "BucketName": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "Name of the S3 bucket." + }, + "ObjectKeyPrefix": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The object key prefix path where the results will be stored. Default is no prefix path" + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/24" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Rekognition/StreamProcessorProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/16" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/24" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/35" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/27" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Rekognition/StreamProcessorProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/3" + }, + "flags": 2 + }, + "BoundingBoxRegionsOfInterest": { + "type": { + "$ref": "#/34" + }, + "flags": 0, + "description": "The BoundingBoxRegionsOfInterest specifies an array of bounding boxes of interest in the video frames to analyze, as part of connected home feature. If an object is partially in a region of interest, Rekognition will tag it as detected if the overlap of the object with the region-of-interest is greater than 20%." + }, + "ConnectedHomeSettings": { + "type": { + "$ref": "#/17" + }, + "flags": 0 + }, + "DataSharingPreference": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "FaceSearchSettings": { + "type": { + "$ref": "#/19" + }, + "flags": 0 + }, + "KinesisDataStream": { + "type": { + "$ref": "#/20" + }, + "flags": 0 + }, + "KinesisVideoStream": { + "type": { + "$ref": "#/21" + }, + "flags": 1 + }, + "KmsKeyId": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The KMS key that is used by Rekognition to encrypt any intermediate customer metadata and store in the customer's S3 bucket." + }, + "Name": { + "type": { + "$ref": "#/3" + }, + "flags": 16, + "description": "Name of the stream processor. It's an identifier you assign to the stream processor. You can use it to manage the stream processor." + }, + "NotificationChannel": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "PolygonRegionsOfInterest": { + "type": { + "$ref": "#/36" + }, + "flags": 0, + "description": "The PolygonRegionsOfInterest specifies a set of polygon areas of interest in the video frames to analyze, as part of connected home feature. Each polygon is in turn, an ordered list of Point" + }, + "RoleArn": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "ARN of the IAM role that allows access to the stream processor, and provides Rekognition read permissions for KVS stream and write permissions to S3 bucket and SNS topic." + }, + "S3Destination": { + "type": { + "$ref": "#/26" + }, + "flags": 0 + }, + "Status": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "Current status of the stream processor." + }, + "StatusMessage": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "Detailed status message about the stream processor." + }, + "Tags": { + "type": { + "$ref": "#/37" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Rekognition/StreamProcessor", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/38" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Rekognition/StreamProcessor@default", + "scopeType": 0, + "body": { + "$ref": "#/39" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.rekognition/default/types.md b/artifacts/bicep/aws/aws.rekognition/default/types.md index d33d5137..9601302c 100644 --- a/artifacts/bicep/aws/aws.rekognition/default/types.md +++ b/artifacts/bicep/aws/aws.rekognition/default/types.md @@ -3,23 +3,23 @@ ## Resource AWS.Rekognition/Collection@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Rekognition/CollectionProperties](#awsrekognitioncollectionproperties) (Required): properties of the resource +* **properties**: [AWS.Rekognition/CollectionProperties](#awsrekognitioncollectionproperties) (Required, Identifier): properties of the resource ## Resource AWS.Rekognition/Project@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Rekognition/ProjectProperties](#awsrekognitionprojectproperties) (Required): properties of the resource +* **properties**: [AWS.Rekognition/ProjectProperties](#awsrekognitionprojectproperties) (Required, Identifier): properties of the resource ## Resource AWS.Rekognition/StreamProcessor@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Rekognition/StreamProcessorProperties](#awsrekognitionstreamprocessorproperties) (Required): properties of the resource +* **properties**: [AWS.Rekognition/StreamProcessorProperties](#awsrekognitionstreamprocessorproperties) (Required, Identifier): properties of the resource ## AWS.Rekognition/CollectionProperties ### Properties @@ -27,11 +27,6 @@ * **CollectionId**: string (Required, Identifier) * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## AWS.Rekognition/ProjectProperties ### Properties * **Arn**: string (ReadOnly) @@ -104,3 +99,8 @@ * **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. * **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + diff --git a/artifacts/bicep/aws/aws.resiliencehub/default/types.json b/artifacts/bicep/aws/aws.resiliencehub/default/types.json index 3662dfb9..40725efb 100644 --- a/artifacts/bicep/aws/aws.resiliencehub/default/types.json +++ b/artifacts/bicep/aws/aws.resiliencehub/default/types.json @@ -1 +1,441 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"EventSubscription","Properties":{"EventType":{"Type":4,"Flags":1,"Description":"The type of event you would like to subscribe and get notification for."},"Name":{"Type":4,"Flags":1,"Description":"Unique name to identify an event subscription."},"SnsTopicArn":{"Type":4,"Flags":0,"Description":"Amazon Resource Name (ARN) of the Amazon Simple Notification Service topic."}}}},{"2":{"Name":"IamRoleArn"}},{"2":{"Name":"PermissionModel","Properties":{"CrossAccountRoleArns":{"Type":15,"Flags":0,"Description":"Defines a list of role Amazon Resource Names (ARNs) to be used in other accounts. These ARNs are used for querying purposes while importing resources and assessing your application."},"InvokerRoleName":{"Type":4,"Flags":0,"Description":"Existing AWS IAM role name in the primary AWS account that will be assumed by AWS Resilience Hub Service Principle to obtain a read-only access to your application resources while running an assessment."},"Type":{"Type":4,"Flags":1,"Description":"Defines how AWS Resilience Hub scans your resources. It can scan for the resources by using a pre-existing role in your AWS account, or by using the credentials of the current IAM user."}}}},{"2":{"Name":"PhysicalResourceId","Properties":{"AwsAccountId":{"Type":4,"Flags":0},"AwsRegion":{"Type":4,"Flags":0},"Identifier":{"Type":4,"Flags":1},"Type":{"Type":4,"Flags":1}}}},{"2":{"Name":"ResourceMapping","Properties":{"EksSourceName":{"Type":4,"Flags":0},"LogicalStackName":{"Type":4,"Flags":0},"MappingType":{"Type":4,"Flags":1},"PhysicalResourceId":{"Type":11,"Flags":1},"ResourceName":{"Type":4,"Flags":0},"TerraformSourceName":{"Type":4,"Flags":0}}}},{"2":{"Name":"TagMap","Properties":{}}},{"2":{"Name":"TagValue"}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.ResilienceHub/AppProperties","Properties":{"AppArn":{"Type":4,"Flags":18,"Description":"Amazon Resource Name (ARN) of the App."},"AppAssessmentSchedule":{"Type":4,"Flags":0,"Description":"Assessment execution schedule."},"AppTemplateBody":{"Type":4,"Flags":1,"Description":"A string containing full ResilienceHub app template body."},"Description":{"Type":4,"Flags":0,"Description":"App description."},"DriftStatus":{"Type":4,"Flags":2,"Description":"Indicates if compliance drifts (deviations) were detected while running an assessment for your application."},"EventSubscriptions":{"Type":17,"Flags":0,"Description":"The list of events you would like to subscribe and get notification for."},"Name":{"Type":4,"Flags":1,"Description":"Name of the app."},"PermissionModel":{"Type":10,"Flags":0},"ResiliencyPolicyArn":{"Type":4,"Flags":0,"Description":"Amazon Resource Name (ARN) of the Resiliency Policy."},"ResourceMappings":{"Type":18,"Flags":1,"Description":"An array of ResourceMapping objects."},"Tags":{"Type":13,"Flags":0}}}},{"3":{"ItemType":8}},{"3":{"ItemType":12}},{"2":{"Name":"AWS.ResilienceHub/App","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":16,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ResilienceHub/App@default","ScopeType":0,"Body":19}},{"2":{"Name":"FailurePolicy","Properties":{"RpoInSecs":{"Type":3,"Flags":1,"Description":"RPO in seconds."},"RtoInSecs":{"Type":3,"Flags":1,"Description":"RTO in seconds."}}}},{"2":{"Name":"PolicyMap","Properties":{}}},{"2":{"Name":"TagMap","Properties":{}}},{"2":{"Name":"TagValue"}},{"2":{"Name":"AWS.ResilienceHub/ResiliencyPolicyProperties","Properties":{"DataLocationConstraint":{"Type":4,"Flags":0,"Description":"Data Location Constraint of the Policy."},"Policy":{"Type":22,"Flags":1},"PolicyArn":{"Type":4,"Flags":18,"Description":"Amazon Resource Name (ARN) of the Resiliency Policy."},"PolicyDescription":{"Type":4,"Flags":0,"Description":"Description of Resiliency Policy."},"PolicyName":{"Type":4,"Flags":1,"Description":"Name of Resiliency Policy."},"Tags":{"Type":23,"Flags":0},"Tier":{"Type":4,"Flags":1,"Description":"Resiliency Policy Tier."}}}},{"2":{"Name":"AWS.ResilienceHub/ResiliencyPolicy","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":25,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ResilienceHub/ResiliencyPolicy@default","ScopeType":0,"Body":26}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "EventSubscription", + "properties": { + "EventType": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "The type of event you would like to subscribe and get notification for." + }, + "Name": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "Unique name to identify an event subscription." + }, + "SnsTopicArn": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "Amazon Resource Name (ARN) of the Amazon Simple Notification Service topic." + } + } + }, + { + "$type": "ObjectType", + "name": "IamRoleArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PermissionModel", + "properties": { + "CrossAccountRoleArns": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "Defines a list of role Amazon Resource Names (ARNs) to be used in other accounts. These ARNs are used for querying purposes while importing resources and assessing your application." + }, + "InvokerRoleName": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "Existing AWS IAM role name in the primary AWS account that will be assumed by AWS Resilience Hub Service Principle to obtain a read-only access to your application resources while running an assessment." + }, + "Type": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "Defines how AWS Resilience Hub scans your resources. It can scan for the resources by using a pre-existing role in your AWS account, or by using the credentials of the current IAM user." + } + } + }, + { + "$type": "ObjectType", + "name": "PhysicalResourceId", + "properties": { + "AwsAccountId": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "AwsRegion": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "Identifier": { + "type": { + "$ref": "#/7" + }, + "flags": 1 + }, + "Type": { + "type": { + "$ref": "#/7" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ResourceMapping", + "properties": { + "EksSourceName": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "LogicalStackName": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "MappingType": { + "type": { + "$ref": "#/7" + }, + "flags": 1 + }, + "PhysicalResourceId": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + }, + "ResourceName": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "TerraformSourceName": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TagMap", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TagValue", + "properties": {} + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/7" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.ResilienceHub/AppProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ObjectType", + "name": "AWS.ResilienceHub/AppProperties", + "properties": { + "AppArn": { + "type": { + "$ref": "#/7" + }, + "flags": 18, + "description": "Amazon Resource Name (ARN) of the App." + }, + "AppAssessmentSchedule": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "Assessment execution schedule." + }, + "AppTemplateBody": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "A string containing full ResilienceHub app template body." + }, + "Description": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "App description." + }, + "DriftStatus": { + "type": { + "$ref": "#/7" + }, + "flags": 2, + "description": "Indicates if compliance drifts (deviations) were detected while running an assessment for your application." + }, + "EventSubscriptions": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The list of events you would like to subscribe and get notification for." + }, + "Name": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "Name of the app." + }, + "PermissionModel": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "ResiliencyPolicyArn": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "Amazon Resource Name (ARN) of the Resiliency Policy." + }, + "ResourceMappings": { + "type": { + "$ref": "#/11" + }, + "flags": 1, + "description": "An array of ResourceMapping objects." + }, + "Tags": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ResilienceHub/App", + "properties": { + "name": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/7" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/12" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ResilienceHub/App@default", + "scopeType": 0, + "body": { + "$ref": "#/13" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "FailurePolicy", + "properties": { + "RpoInSecs": { + "type": { + "$ref": "#/19" + }, + "flags": 1, + "description": "RPO in seconds." + }, + "RtoInSecs": { + "type": { + "$ref": "#/19" + }, + "flags": 1, + "description": "RTO in seconds." + } + } + }, + { + "$type": "ObjectType", + "name": "PolicyMap", + "properties": { + "AZ": { + "type": { + "$ref": "#/15" + }, + "flags": 1 + }, + "Hardware": { + "type": { + "$ref": "#/15" + }, + "flags": 1 + }, + "Region": { + "type": { + "$ref": "#/15" + }, + "flags": 0 + }, + "Software": { + "type": { + "$ref": "#/15" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TagMap", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TagValue", + "properties": {} + }, + { + "$type": "IntegerType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.ResilienceHub/ResiliencyPolicyProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.ResilienceHub/ResiliencyPolicyProperties", + "properties": { + "DataLocationConstraint": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "Data Location Constraint of the Policy." + }, + "Policy": { + "type": { + "$ref": "#/16" + }, + "flags": 1 + }, + "PolicyArn": { + "type": { + "$ref": "#/7" + }, + "flags": 18, + "description": "Amazon Resource Name (ARN) of the Resiliency Policy." + }, + "PolicyDescription": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "Description of Resiliency Policy." + }, + "PolicyName": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "Name of Resiliency Policy." + }, + "Tags": { + "type": { + "$ref": "#/17" + }, + "flags": 0 + }, + "Tier": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "Resiliency Policy Tier." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ResilienceHub/ResiliencyPolicy", + "properties": { + "name": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/7" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/21" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ResilienceHub/ResiliencyPolicy@default", + "scopeType": 0, + "body": { + "$ref": "#/22" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.resiliencehub/default/types.md b/artifacts/bicep/aws/aws.resiliencehub/default/types.md index 63f90e0f..20e9bf54 100644 --- a/artifacts/bicep/aws/aws.resiliencehub/default/types.md +++ b/artifacts/bicep/aws/aws.resiliencehub/default/types.md @@ -3,16 +3,16 @@ ## Resource AWS.ResilienceHub/App@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ResilienceHub/AppProperties](#awsresiliencehubappproperties) (Required): properties of the resource +* **properties**: [AWS.ResilienceHub/AppProperties](#awsresiliencehubappproperties) (Required, Identifier): properties of the resource ## Resource AWS.ResilienceHub/ResiliencyPolicy@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ResilienceHub/ResiliencyPolicyProperties](#awsresiliencehubresiliencypolicyproperties) (Required): properties of the resource +* **properties**: [AWS.ResilienceHub/ResiliencyPolicyProperties](#awsresiliencehubresiliencypolicyproperties) (Required, Identifier): properties of the resource ## AWS.ResilienceHub/AppProperties ### Properties @@ -28,27 +28,33 @@ * **ResourceMappings**: [ResourceMapping](#resourcemapping)[] (Required): An array of ResourceMapping objects. * **Tags**: [TagMap](#tagmap) +## AWS.ResilienceHub/ResiliencyPolicyProperties +### Properties +* **DataLocationConstraint**: string: Data Location Constraint of the Policy. +* **Policy**: [PolicyMap](#policymap) (Required) +* **PolicyArn**: string (ReadOnly, Identifier): Amazon Resource Name (ARN) of the Resiliency Policy. +* **PolicyDescription**: string: Description of Resiliency Policy. +* **PolicyName**: string (Required): Name of Resiliency Policy. +* **Tags**: [TagMap](#tagmap) +* **Tier**: string (Required): Resiliency Policy Tier. + ## EventSubscription ### Properties * **EventType**: string (Required): The type of event you would like to subscribe and get notification for. * **Name**: string (Required): Unique name to identify an event subscription. * **SnsTopicArn**: string: Amazon Resource Name (ARN) of the Amazon Simple Notification Service topic. +## FailurePolicy +### Properties +* **RpoInSecs**: int (Required): RPO in seconds. +* **RtoInSecs**: int (Required): RTO in seconds. + ## PermissionModel ### Properties * **CrossAccountRoleArns**: string[]: Defines a list of role Amazon Resource Names (ARNs) to be used in other accounts. These ARNs are used for querying purposes while importing resources and assessing your application. * **InvokerRoleName**: string: Existing AWS IAM role name in the primary AWS account that will be assumed by AWS Resilience Hub Service Principle to obtain a read-only access to your application resources while running an assessment. * **Type**: string (Required): Defines how AWS Resilience Hub scans your resources. It can scan for the resources by using a pre-existing role in your AWS account, or by using the credentials of the current IAM user. -## ResourceMapping -### Properties -* **EksSourceName**: string -* **LogicalStackName**: string -* **MappingType**: string (Required) -* **PhysicalResourceId**: [PhysicalResourceId](#physicalresourceid) (Required) -* **ResourceName**: string -* **TerraformSourceName**: string - ## PhysicalResourceId ### Properties * **AwsAccountId**: string @@ -56,20 +62,23 @@ * **Identifier**: string (Required) * **Type**: string (Required) -## TagMap +## PolicyMap ### Properties +* **AZ**: [FailurePolicy](#failurepolicy) (Required) +* **Hardware**: [FailurePolicy](#failurepolicy) (Required) +* **Region**: [FailurePolicy](#failurepolicy) +* **Software**: [FailurePolicy](#failurepolicy) (Required) -## AWS.ResilienceHub/ResiliencyPolicyProperties +## ResourceMapping ### Properties -* **DataLocationConstraint**: string: Data Location Constraint of the Policy. -* **Policy**: [PolicyMap](#policymap) (Required) -* **PolicyArn**: string (ReadOnly, Identifier): Amazon Resource Name (ARN) of the Resiliency Policy. -* **PolicyDescription**: string: Description of Resiliency Policy. -* **PolicyName**: string (Required): Name of Resiliency Policy. -* **Tags**: [TagMap](#tagmap) -* **Tier**: string (Required): Resiliency Policy Tier. +* **EksSourceName**: string +* **LogicalStackName**: string +* **MappingType**: string (Required) +* **PhysicalResourceId**: [PhysicalResourceId](#physicalresourceid) (Required) +* **ResourceName**: string +* **TerraformSourceName**: string -## PolicyMap +## TagMap ### Properties ## TagMap diff --git a/artifacts/bicep/aws/aws.resourceexplorer2/default/types.json b/artifacts/bicep/aws/aws.resourceexplorer2/default/types.json index 7a2024fe..38aac600 100644 --- a/artifacts/bicep/aws/aws.resourceexplorer2/default/types.json +++ b/artifacts/bicep/aws/aws.resourceexplorer2/default/types.json @@ -1 +1,266 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"AWS.ResourceExplorer2/DefaultViewAssociationProperties","Properties":{"AssociatedAwsPrincipal":{"Type":4,"Flags":18,"Description":"The AWS principal that the default view is associated with, used as the unique identifier for this resource."},"ViewArn":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.ResourceExplorer2/DefaultViewAssociation","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":8,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ResourceExplorer2/DefaultViewAssociation@default","ScopeType":0,"Body":9}},{"2":{"Name":"IndexState"}},{"2":{"Name":"IndexType"}},{"2":{"Name":"TagMap","Properties":{}}},{"2":{"Name":"AWS.ResourceExplorer2/IndexProperties","Properties":{"Arn":{"Type":4,"Flags":18},"IndexState":{"Type":4,"Flags":2},"Tags":{"Type":13,"Flags":0},"Type":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.ResourceExplorer2/Index","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":14,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ResourceExplorer2/Index@default","ScopeType":0,"Body":15}},{"2":{"Name":"IncludedProperty","Properties":{"Name":{"Type":4,"Flags":1}}}},{"2":{"Name":"SearchFilter","Properties":{"FilterString":{"Type":4,"Flags":1}}}},{"2":{"Name":"TagMap","Properties":{}}},{"2":{"Name":"AWS.ResourceExplorer2/ViewProperties","Properties":{"Filters":{"Type":18,"Flags":0},"IncludedProperties":{"Type":21,"Flags":0},"Scope":{"Type":4,"Flags":0},"Tags":{"Type":19,"Flags":0},"ViewArn":{"Type":4,"Flags":18},"ViewName":{"Type":4,"Flags":1}}}},{"3":{"ItemType":17}},{"2":{"Name":"AWS.ResourceExplorer2/View","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":20,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ResourceExplorer2/View@default","ScopeType":0,"Body":22}}] \ No newline at end of file +[ + { + "$type": "StringLiteralType", + "value": "AWS.ResourceExplorer2/DefaultViewAssociationProperties" + }, + { + "$type": "StringType" + }, + { + "$type": "ObjectType", + "name": "AWS.ResourceExplorer2/DefaultViewAssociationProperties", + "properties": { + "AssociatedAwsPrincipal": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The AWS principal that the default view is associated with, used as the unique identifier for this resource." + }, + "ViewArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ResourceExplorer2/DefaultViewAssociation", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ResourceExplorer2/DefaultViewAssociation@default", + "scopeType": 0, + "body": { + "$ref": "#/3" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "IndexState", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "IndexType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TagMap", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.ResourceExplorer2/IndexProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.ResourceExplorer2/IndexProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 18 + }, + "IndexState": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "Tags": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ResourceExplorer2/Index", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/9" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ResourceExplorer2/Index@default", + "scopeType": 0, + "body": { + "$ref": "#/10" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "IncludedProperty", + "properties": { + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "SearchFilter", + "properties": { + "FilterString": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TagMap", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.ResourceExplorer2/ViewProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/12" + } + }, + { + "$type": "ObjectType", + "name": "AWS.ResourceExplorer2/ViewProperties", + "properties": { + "Filters": { + "type": { + "$ref": "#/13" + }, + "flags": 0 + }, + "IncludedProperties": { + "type": { + "$ref": "#/16" + }, + "flags": 0 + }, + "Scope": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + }, + "ViewArn": { + "type": { + "$ref": "#/1" + }, + "flags": 18 + }, + "ViewName": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ResourceExplorer2/View", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/17" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ResourceExplorer2/View@default", + "scopeType": 0, + "body": { + "$ref": "#/18" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.resourceexplorer2/default/types.md b/artifacts/bicep/aws/aws.resourceexplorer2/default/types.md index 4af7c165..bca5c11f 100644 --- a/artifacts/bicep/aws/aws.resourceexplorer2/default/types.md +++ b/artifacts/bicep/aws/aws.resourceexplorer2/default/types.md @@ -3,23 +3,23 @@ ## Resource AWS.ResourceExplorer2/DefaultViewAssociation@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ResourceExplorer2/DefaultViewAssociationProperties](#awsresourceexplorer2defaultviewassociationproperties) (Required): properties of the resource +* **properties**: [AWS.ResourceExplorer2/DefaultViewAssociationProperties](#awsresourceexplorer2defaultviewassociationproperties) (Required, Identifier): properties of the resource ## Resource AWS.ResourceExplorer2/Index@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ResourceExplorer2/IndexProperties](#awsresourceexplorer2indexproperties) (Required): properties of the resource +* **properties**: [AWS.ResourceExplorer2/IndexProperties](#awsresourceexplorer2indexproperties) (Required, Identifier): properties of the resource ## Resource AWS.ResourceExplorer2/View@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ResourceExplorer2/ViewProperties](#awsresourceexplorer2viewproperties) (Required): properties of the resource +* **properties**: [AWS.ResourceExplorer2/ViewProperties](#awsresourceexplorer2viewproperties) (Required, Identifier): properties of the resource ## AWS.ResourceExplorer2/DefaultViewAssociationProperties ### Properties @@ -33,9 +33,6 @@ * **Tags**: [TagMap](#tagmap) * **Type**: string (Required) -## TagMap -### Properties - ## AWS.ResourceExplorer2/ViewProperties ### Properties * **Filters**: [SearchFilter](#searchfilter) @@ -45,13 +42,16 @@ * **ViewArn**: string (ReadOnly, Identifier) * **ViewName**: string (Required) +## IncludedProperty +### Properties +* **Name**: string (Required) + ## SearchFilter ### Properties * **FilterString**: string (Required) -## IncludedProperty +## TagMap ### Properties -* **Name**: string (Required) ## TagMap ### Properties diff --git a/artifacts/bicep/aws/aws.resourcegroups/default/types.json b/artifacts/bicep/aws/aws.resourcegroups/default/types.json index bb4d957b..bc8ee67e 100644 --- a/artifacts/bicep/aws/aws.resourcegroups/default/types.json +++ b/artifacts/bicep/aws/aws.resourcegroups/default/types.json @@ -1 +1,269 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"Configuration"}},{"2":{"Name":"ConfigurationItem","Properties":{"Parameters":{"Type":16,"Flags":0},"Type":{"Type":4,"Flags":0}}}},{"2":{"Name":"ConfigurationParameter","Properties":{"Name":{"Type":4,"Flags":16},"Values":{"Type":17,"Flags":0}}}},{"2":{"Name":"Query","Properties":{"ResourceTypeFilters":{"Type":18,"Flags":0},"StackIdentifier":{"Type":4,"Flags":0},"TagFilters":{"Type":19,"Flags":0}}}},{"2":{"Name":"ResourceQuery","Properties":{"Query":{"Type":11,"Flags":0},"Type":{"Type":4,"Flags":0}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":0},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"TagFilter","Properties":{"Key":{"Type":4,"Flags":0},"Values":{"Type":20,"Flags":0}}}},{"3":{"ItemType":9}},{"3":{"ItemType":10}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":14}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.ResourceGroups/GroupProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"The Resource Group ARN."},"Configuration":{"Type":22,"Flags":0},"Description":{"Type":4,"Flags":0,"Description":"The description of the resource group"},"Name":{"Type":4,"Flags":17,"Description":"The name of the resource group"},"ResourceQuery":{"Type":12,"Flags":0},"Resources":{"Type":23,"Flags":0},"Tags":{"Type":24,"Flags":0}}}},{"3":{"ItemType":9}},{"3":{"ItemType":4}},{"3":{"ItemType":13}},{"2":{"Name":"AWS.ResourceGroups/Group","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":21,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ResourceGroups/Group@default","ScopeType":0,"Body":25}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Configuration", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ConfigurationItem", + "properties": { + "Parameters": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ConfigurationParameter", + "properties": { + "Name": { + "type": { + "$ref": "#/9" + }, + "flags": 16 + }, + "Values": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Query", + "properties": { + "ResourceTypeFilters": { + "type": { + "$ref": "#/11" + }, + "flags": 0 + }, + "StackIdentifier": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "TagFilters": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ResourceQuery", + "properties": { + "Query": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TagFilter", + "properties": { + "Key": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "Values": { + "type": { + "$ref": "#/13" + }, + "flags": 0 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/9" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/9" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/9" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.ResourceGroups/GroupProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/9" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ObjectType", + "name": "AWS.ResourceGroups/GroupProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/9" + }, + "flags": 2, + "description": "The Resource Group ARN." + }, + "Configuration": { + "type": { + "$ref": "#/15" + }, + "flags": 0 + }, + "Description": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "The description of the resource group" + }, + "Name": { + "type": { + "$ref": "#/9" + }, + "flags": 17, + "description": "The name of the resource group" + }, + "ResourceQuery": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "Resources": { + "type": { + "$ref": "#/16" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/17" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ResourceGroups/Group", + "properties": { + "name": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/9" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/18" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ResourceGroups/Group@default", + "scopeType": 0, + "body": { + "$ref": "#/19" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.resourcegroups/default/types.md b/artifacts/bicep/aws/aws.resourcegroups/default/types.md index bba4e24f..8de510fb 100644 --- a/artifacts/bicep/aws/aws.resourcegroups/default/types.md +++ b/artifacts/bicep/aws/aws.resourcegroups/default/types.md @@ -3,9 +3,9 @@ ## Resource AWS.ResourceGroups/Group@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ResourceGroups/GroupProperties](#awsresourcegroupsgroupproperties) (Required): properties of the resource +* **properties**: [AWS.ResourceGroups/GroupProperties](#awsresourcegroupsgroupproperties) (Required, Identifier): properties of the resource ## AWS.ResourceGroups/GroupProperties ### Properties @@ -27,24 +27,24 @@ * **Name**: string (Identifier) * **Values**: string[] -## ResourceQuery -### Properties -* **Query**: [Query](#query) -* **Type**: string - ## Query ### Properties * **ResourceTypeFilters**: string[] * **StackIdentifier**: string * **TagFilters**: [TagFilter](#tagfilter)[] -## TagFilter +## ResourceQuery ### Properties -* **Key**: string -* **Values**: string[] +* **Query**: [Query](#query) +* **Type**: string ## Tag ### Properties * **Key**: string * **Value**: string +## TagFilter +### Properties +* **Key**: string +* **Values**: string[] + diff --git a/artifacts/bicep/aws/aws.robomaker/default/types.json b/artifacts/bicep/aws/aws.robomaker/default/types.json index 44d1b013..918d238a 100644 --- a/artifacts/bicep/aws/aws.robomaker/default/types.json +++ b/artifacts/bicep/aws/aws.robomaker/default/types.json @@ -1 +1,541 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"Arn"}},{"2":{"Name":"Tags","Properties":{}}},{"2":{"Name":"AWS.RoboMaker/FleetProperties","Properties":{"Arn":{"Type":4,"Flags":18},"Name":{"Type":4,"Flags":0,"Description":"The name of the fleet."},"Tags":{"Type":9,"Flags":0}}}},{"2":{"Name":"AWS.RoboMaker/Fleet","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":10,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.RoboMaker/Fleet@default","ScopeType":0,"Body":11}},{"2":{"Name":"Arn"}},{"2":{"Name":"Tags","Properties":{}}},{"2":{"Name":"AWS.RoboMaker/RobotProperties","Properties":{"Architecture":{"Type":4,"Flags":1,"Description":"The target architecture of the robot."},"Arn":{"Type":4,"Flags":18},"Fleet":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) of the fleet."},"GreengrassGroupId":{"Type":4,"Flags":1,"Description":"The Greengrass group id."},"Name":{"Type":4,"Flags":0,"Description":"The name for the robot."},"Tags":{"Type":14,"Flags":0}}}},{"2":{"Name":"AWS.RoboMaker/Robot","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":15,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.RoboMaker/Robot@default","ScopeType":0,"Body":16}},{"2":{"Name":"Arn"}},{"2":{"Name":"RobotSoftwareSuite","Properties":{"Name":{"Type":4,"Flags":1,"Description":"The name of robot software suite."},"Version":{"Type":4,"Flags":4,"Description":"The version of robot software suite."}}}},{"2":{"Name":"SourceConfig","Properties":{"Architecture":{"Type":4,"Flags":1,"Description":"The architecture of robot application."},"S3Bucket":{"Type":4,"Flags":1,"Description":"The Arn of the S3Bucket that stores the robot application source."},"S3Key":{"Type":4,"Flags":1,"Description":"The s3 key of robot application source."}}}},{"2":{"Name":"Tags","Properties":{}}},{"2":{"Name":"AWS.RoboMaker/RobotApplicationProperties","Properties":{"Arn":{"Type":4,"Flags":18},"CurrentRevisionId":{"Type":4,"Flags":0,"Description":"The revision ID of robot application."},"Environment":{"Type":4,"Flags":0,"Description":"The URI of the Docker image for the robot application."},"Name":{"Type":4,"Flags":0,"Description":"The name of the robot application."},"RobotSoftwareSuite":{"Type":19,"Flags":1},"Sources":{"Type":23,"Flags":4,"Description":"The sources of the robot application."},"Tags":{"Type":21,"Flags":0}}}},{"3":{"ItemType":20}},{"2":{"Name":"AWS.RoboMaker/RobotApplication","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":22,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.RoboMaker/RobotApplication@default","ScopeType":0,"Body":24}},{"2":{"Name":"Arn"}},{"2":{"Name":"RenderingEngine","Properties":{"Name":{"Type":4,"Flags":1,"Description":"The name of the rendering engine."},"Version":{"Type":4,"Flags":1,"Description":"The version of the rendering engine."}}}},{"2":{"Name":"RobotSoftwareSuite","Properties":{"Name":{"Type":4,"Flags":1,"Description":"The name of the robot software suite."},"Version":{"Type":4,"Flags":4,"Description":"The version of the robot software suite."}}}},{"2":{"Name":"SimulationSoftwareSuite","Properties":{"Name":{"Type":4,"Flags":1,"Description":"The name of the simulation software suite."},"Version":{"Type":4,"Flags":4,"Description":"The version of the simulation software suite."}}}},{"2":{"Name":"SourceConfig","Properties":{"Architecture":{"Type":4,"Flags":1,"Description":"The target processor architecture for the application."},"S3Bucket":{"Type":4,"Flags":1,"Description":"The Amazon S3 bucket name."},"S3Key":{"Type":4,"Flags":1,"Description":"The s3 object key."}}}},{"2":{"Name":"Tags","Properties":{}}},{"2":{"Name":"AWS.RoboMaker/SimulationApplicationProperties","Properties":{"Arn":{"Type":4,"Flags":18},"CurrentRevisionId":{"Type":4,"Flags":0,"Description":"The current revision id."},"Environment":{"Type":4,"Flags":0,"Description":"The URI of the Docker image for the robot application."},"Name":{"Type":4,"Flags":0,"Description":"The name of the simulation application."},"RenderingEngine":{"Type":27,"Flags":4,"Description":"The rendering engine for the simulation application."},"RobotSoftwareSuite":{"Type":28,"Flags":1,"Description":"The robot software suite used by the simulation application."},"SimulationSoftwareSuite":{"Type":29,"Flags":1,"Description":"The simulation software suite used by the simulation application."},"Sources":{"Type":33,"Flags":4,"Description":"The sources of the simulation application."},"Tags":{"Type":31,"Flags":0}}}},{"3":{"ItemType":30}},{"2":{"Name":"AWS.RoboMaker/SimulationApplication","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":32,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.RoboMaker/SimulationApplication@default","ScopeType":0,"Body":34}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Arn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tags", + "properties": {} + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.RoboMaker/FleetProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.RoboMaker/FleetProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/2" + }, + "flags": 18 + }, + "Name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The name of the fleet." + }, + "Tags": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.RoboMaker/Fleet", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/4" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.RoboMaker/Fleet@default", + "scopeType": 0, + "body": { + "$ref": "#/5" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Arn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tags", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.RoboMaker/RobotProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.RoboMaker/RobotProperties", + "properties": { + "Architecture": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The target architecture of the robot." + }, + "Arn": { + "type": { + "$ref": "#/2" + }, + "flags": 18 + }, + "Fleet": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the fleet." + }, + "GreengrassGroupId": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The Greengrass group id." + }, + "Name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The name for the robot." + }, + "Tags": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.RoboMaker/Robot", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/10" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.RoboMaker/Robot@default", + "scopeType": 0, + "body": { + "$ref": "#/11" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Arn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RobotSoftwareSuite", + "properties": { + "Name": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The name of robot software suite." + }, + "Version": { + "type": { + "$ref": "#/2" + }, + "flags": 4, + "description": "The version of robot software suite." + } + } + }, + { + "$type": "ObjectType", + "name": "SourceConfig", + "properties": { + "Architecture": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The architecture of robot application." + }, + "S3Bucket": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The Arn of the S3Bucket that stores the robot application source." + }, + "S3Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The s3 key of robot application source." + } + } + }, + { + "$type": "ObjectType", + "name": "Tags", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.RoboMaker/RobotApplicationProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/15" + } + }, + { + "$type": "ObjectType", + "name": "AWS.RoboMaker/RobotApplicationProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/2" + }, + "flags": 18 + }, + "CurrentRevisionId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The revision ID of robot application." + }, + "Environment": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The URI of the Docker image for the robot application." + }, + "Name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The name of the robot application." + }, + "RobotSoftwareSuite": { + "type": { + "$ref": "#/14" + }, + "flags": 1 + }, + "Sources": { + "type": { + "$ref": "#/18" + }, + "flags": 4, + "description": "The sources of the robot application." + }, + "Tags": { + "type": { + "$ref": "#/16" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.RoboMaker/RobotApplication", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/19" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.RoboMaker/RobotApplication@default", + "scopeType": 0, + "body": { + "$ref": "#/20" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Arn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RenderingEngine", + "properties": { + "Name": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The name of the rendering engine." + }, + "Version": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The version of the rendering engine." + } + } + }, + { + "$type": "ObjectType", + "name": "RobotSoftwareSuite", + "properties": { + "Name": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The name of the robot software suite." + }, + "Version": { + "type": { + "$ref": "#/2" + }, + "flags": 4, + "description": "The version of the robot software suite." + } + } + }, + { + "$type": "ObjectType", + "name": "SimulationSoftwareSuite", + "properties": { + "Name": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The name of the simulation software suite." + }, + "Version": { + "type": { + "$ref": "#/2" + }, + "flags": 4, + "description": "The version of the simulation software suite." + } + } + }, + { + "$type": "ObjectType", + "name": "SourceConfig", + "properties": { + "Architecture": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The target processor architecture for the application." + }, + "S3Bucket": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The Amazon S3 bucket name." + }, + "S3Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The s3 object key." + } + } + }, + { + "$type": "ObjectType", + "name": "Tags", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.RoboMaker/SimulationApplicationProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/26" + } + }, + { + "$type": "ObjectType", + "name": "AWS.RoboMaker/SimulationApplicationProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/2" + }, + "flags": 18 + }, + "CurrentRevisionId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The current revision id." + }, + "Environment": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The URI of the Docker image for the robot application." + }, + "Name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The name of the simulation application." + }, + "RenderingEngine": { + "type": { + "$ref": "#/23" + }, + "flags": 4, + "description": "The rendering engine for the simulation application." + }, + "RobotSoftwareSuite": { + "type": { + "$ref": "#/24" + }, + "flags": 1, + "description": "The robot software suite used by the simulation application." + }, + "SimulationSoftwareSuite": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "The simulation software suite used by the simulation application." + }, + "Sources": { + "type": { + "$ref": "#/29" + }, + "flags": 4, + "description": "The sources of the simulation application." + }, + "Tags": { + "type": { + "$ref": "#/27" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.RoboMaker/SimulationApplication", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/30" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.RoboMaker/SimulationApplication@default", + "scopeType": 0, + "body": { + "$ref": "#/31" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.robomaker/default/types.md b/artifacts/bicep/aws/aws.robomaker/default/types.md index 91618377..0aa7a2c9 100644 --- a/artifacts/bicep/aws/aws.robomaker/default/types.md +++ b/artifacts/bicep/aws/aws.robomaker/default/types.md @@ -3,30 +3,30 @@ ## Resource AWS.RoboMaker/Fleet@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.RoboMaker/FleetProperties](#awsrobomakerfleetproperties): properties of the resource +* **properties**: [AWS.RoboMaker/FleetProperties](#awsrobomakerfleetproperties) (Identifier): properties of the resource ## Resource AWS.RoboMaker/Robot@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.RoboMaker/RobotProperties](#awsrobomakerrobotproperties) (Required): properties of the resource +* **properties**: [AWS.RoboMaker/RobotProperties](#awsrobomakerrobotproperties) (Required, Identifier): properties of the resource ## Resource AWS.RoboMaker/RobotApplication@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.RoboMaker/RobotApplicationProperties](#awsrobomakerrobotapplicationproperties) (Required): properties of the resource +* **properties**: [AWS.RoboMaker/RobotApplicationProperties](#awsrobomakerrobotapplicationproperties) (Required, Identifier): properties of the resource ## Resource AWS.RoboMaker/SimulationApplication@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.RoboMaker/SimulationApplicationProperties](#awsrobomakersimulationapplicationproperties) (Required): properties of the resource +* **properties**: [AWS.RoboMaker/SimulationApplicationProperties](#awsrobomakersimulationapplicationproperties) (Required, Identifier): properties of the resource ## AWS.RoboMaker/FleetProperties ### Properties @@ -34,21 +34,6 @@ * **Name**: string: The name of the fleet. * **Tags**: [Tags](#tags) -## Tags -### Properties - -## AWS.RoboMaker/RobotProperties -### Properties -* **Architecture**: string (Required): The target architecture of the robot. -* **Arn**: string (ReadOnly, Identifier) -* **Fleet**: string: The Amazon Resource Name (ARN) of the fleet. -* **GreengrassGroupId**: string (Required): The Greengrass group id. -* **Name**: string: The name for the robot. -* **Tags**: [Tags](#tags) - -## Tags -### Properties - ## AWS.RoboMaker/RobotApplicationProperties ### Properties * **Arn**: string (ReadOnly, Identifier) @@ -59,19 +44,14 @@ * **Sources**: [SourceConfig](#sourceconfig)[] (WriteOnly): The sources of the robot application. * **Tags**: [Tags](#tags) -## RobotSoftwareSuite -### Properties -* **Name**: string (Required): The name of robot software suite. -* **Version**: string (WriteOnly): The version of robot software suite. - -## SourceConfig -### Properties -* **Architecture**: string (Required): The architecture of robot application. -* **S3Bucket**: string (Required): The Arn of the S3Bucket that stores the robot application source. -* **S3Key**: string (Required): The s3 key of robot application source. - -## Tags +## AWS.RoboMaker/RobotProperties ### Properties +* **Architecture**: string (Required): The target architecture of the robot. +* **Arn**: string (ReadOnly, Identifier) +* **Fleet**: string: The Amazon Resource Name (ARN) of the fleet. +* **GreengrassGroupId**: string (Required): The Greengrass group id. +* **Name**: string: The name for the robot. +* **Tags**: [Tags](#tags) ## AWS.RoboMaker/SimulationApplicationProperties ### Properties @@ -90,6 +70,11 @@ * **Name**: string (Required): The name of the rendering engine. * **Version**: string (Required): The version of the rendering engine. +## RobotSoftwareSuite +### Properties +* **Name**: string (Required): The name of robot software suite. +* **Version**: string (WriteOnly): The version of robot software suite. + ## RobotSoftwareSuite ### Properties * **Name**: string (Required): The name of the robot software suite. @@ -100,6 +85,12 @@ * **Name**: string (Required): The name of the simulation software suite. * **Version**: string (WriteOnly): The version of the simulation software suite. +## SourceConfig +### Properties +* **Architecture**: string (Required): The architecture of robot application. +* **S3Bucket**: string (Required): The Arn of the S3Bucket that stores the robot application source. +* **S3Key**: string (Required): The s3 key of robot application source. + ## SourceConfig ### Properties * **Architecture**: string (Required): The target processor architecture for the application. @@ -109,3 +100,12 @@ ## Tags ### Properties +## Tags +### Properties + +## Tags +### Properties + +## Tags +### Properties + diff --git a/artifacts/bicep/aws/aws.rolesanywhere/default/types.json b/artifacts/bicep/aws/aws.rolesanywhere/default/types.json index ba6c94d2..fec2dd48 100644 --- a/artifacts/bicep/aws/aws.rolesanywhere/default/types.json +++ b/artifacts/bicep/aws/aws.rolesanywhere/default/types.json @@ -1 +1,503 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.RolesAnywhere/CRLProperties","Properties":{"CrlData":{"Type":4,"Flags":1},"CrlId":{"Type":4,"Flags":18},"Enabled":{"Type":2,"Flags":0},"Name":{"Type":4,"Flags":1},"Tags":{"Type":10,"Flags":0},"TrustAnchorArn":{"Type":4,"Flags":0}}}},{"3":{"ItemType":8}},{"2":{"Name":"AWS.RolesAnywhere/CRL","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":9,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.RolesAnywhere/CRL@default","ScopeType":0,"Body":11}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.RolesAnywhere/ProfileProperties","Properties":{"DurationSeconds":{"Type":3,"Flags":0},"Enabled":{"Type":2,"Flags":0},"ManagedPolicyArns":{"Type":15,"Flags":0},"Name":{"Type":4,"Flags":1},"ProfileArn":{"Type":4,"Flags":2},"ProfileId":{"Type":4,"Flags":18},"RequireInstanceProperties":{"Type":2,"Flags":0},"RoleArns":{"Type":16,"Flags":1},"SessionPolicy":{"Type":4,"Flags":0},"Tags":{"Type":17,"Flags":0}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":13}},{"2":{"Name":"AWS.RolesAnywhere/Profile","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":14,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.RolesAnywhere/Profile@default","ScopeType":0,"Body":18}},{"2":{"Name":"NotificationChannel"}},{"2":{"Name":"NotificationEvent"}},{"2":{"Name":"NotificationSetting","Properties":{"Channel":{"Type":4,"Flags":0},"Enabled":{"Type":2,"Flags":1},"Event":{"Type":4,"Flags":1},"Threshold":{"Type":3,"Flags":0}}}},{"2":{"Name":"Source","Properties":{"SourceData":{"Type":27,"Flags":0},"SourceType":{"Type":4,"Flags":0}}}},{"2":{"Name":"SourceData","Properties":{}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"TrustAnchorType"}},{"2":{"Name":"TrustAnchor_SourceData","Properties":{}}},{"2":{"Name":"AWS.RolesAnywhere/TrustAnchorProperties","Properties":{"Enabled":{"Type":2,"Flags":0},"Name":{"Type":4,"Flags":1},"NotificationSettings":{"Type":29,"Flags":0},"Source":{"Type":23,"Flags":1},"Tags":{"Type":30,"Flags":0},"TrustAnchorArn":{"Type":4,"Flags":2},"TrustAnchorId":{"Type":4,"Flags":18}}}},{"3":{"ItemType":22}},{"3":{"ItemType":25}},{"2":{"Name":"AWS.RolesAnywhere/TrustAnchor","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":28,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.RolesAnywhere/TrustAnchor@default","ScopeType":0,"Body":31}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.RolesAnywhere/CRLProperties" + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ObjectType", + "name": "AWS.RolesAnywhere/CRLProperties", + "properties": { + "CrlData": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "CrlId": { + "type": { + "$ref": "#/1" + }, + "flags": 18 + }, + "Enabled": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "TrustAnchorArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.RolesAnywhere/CRL", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.RolesAnywhere/CRL@default", + "scopeType": 0, + "body": { + "$ref": "#/6" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AttributeMapping", + "properties": { + "CertificateField": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "MappingRules": { + "type": { + "$ref": "#/12" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CertificateField", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MappingRule", + "properties": { + "Specifier": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/10" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.RolesAnywhere/ProfileProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/8" + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/11" + } + }, + { + "$type": "ObjectType", + "name": "AWS.RolesAnywhere/ProfileProperties", + "properties": { + "AttributeMappings": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + }, + "DurationSeconds": { + "type": { + "$ref": "#/15" + }, + "flags": 0 + }, + "Enabled": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "ManagedPolicyArns": { + "type": { + "$ref": "#/16" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "ProfileArn": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "ProfileId": { + "type": { + "$ref": "#/1" + }, + "flags": 18 + }, + "RequireInstanceProperties": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "RoleArns": { + "type": { + "$ref": "#/17" + }, + "flags": 1 + }, + "SessionPolicy": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.RolesAnywhere/Profile", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/19" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.RolesAnywhere/Profile@default", + "scopeType": 0, + "body": { + "$ref": "#/20" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "NotificationChannel", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "NotificationEvent", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "NotificationSetting", + "properties": { + "Channel": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "Enabled": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + }, + "Event": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Threshold": { + "type": { + "$ref": "#/15" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Source", + "properties": { + "SourceData": { + "type": { + "$ref": "#/29" + }, + "flags": 0 + }, + "SourceType": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SourceData", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TrustAnchorType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TrustAnchor_SourceData", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.RolesAnywhere/TrustAnchorProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/24" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/27" + } + }, + { + "$type": "ObjectType", + "name": "AWS.RolesAnywhere/TrustAnchorProperties", + "properties": { + "Enabled": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "NotificationSettings": { + "type": { + "$ref": "#/31" + }, + "flags": 0 + }, + "Source": { + "type": { + "$ref": "#/25" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/32" + }, + "flags": 0 + }, + "TrustAnchorArn": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "TrustAnchorId": { + "type": { + "$ref": "#/1" + }, + "flags": 18 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.RolesAnywhere/TrustAnchor", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/33" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.RolesAnywhere/TrustAnchor@default", + "scopeType": 0, + "body": { + "$ref": "#/34" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.rolesanywhere/default/types.md b/artifacts/bicep/aws/aws.rolesanywhere/default/types.md index f3193606..7c3638ae 100644 --- a/artifacts/bicep/aws/aws.rolesanywhere/default/types.md +++ b/artifacts/bicep/aws/aws.rolesanywhere/default/types.md @@ -3,23 +3,28 @@ ## Resource AWS.RolesAnywhere/CRL@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.RolesAnywhere/CRLProperties](#awsrolesanywherecrlproperties) (Required): properties of the resource +* **properties**: [AWS.RolesAnywhere/CRLProperties](#awsrolesanywherecrlproperties) (Required, Identifier): properties of the resource ## Resource AWS.RolesAnywhere/Profile@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.RolesAnywhere/ProfileProperties](#awsrolesanywhereprofileproperties) (Required): properties of the resource +* **properties**: [AWS.RolesAnywhere/ProfileProperties](#awsrolesanywhereprofileproperties) (Required, Identifier): properties of the resource ## Resource AWS.RolesAnywhere/TrustAnchor@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.RolesAnywhere/TrustAnchorProperties](#awsrolesanywheretrustanchorproperties) (Required): properties of the resource +* **properties**: [AWS.RolesAnywhere/TrustAnchorProperties](#awsrolesanywheretrustanchorproperties) (Required, Identifier): properties of the resource + +## AttributeMapping +### Properties +* **CertificateField**: string (Required) +* **MappingRules**: [MappingRule](#mappingrule)[] (Required) ## AWS.RolesAnywhere/CRLProperties ### Properties @@ -30,13 +35,9 @@ * **Tags**: [Tag](#tag)[] * **TrustAnchorArn**: string -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - ## AWS.RolesAnywhere/ProfileProperties ### Properties +* **AttributeMappings**: [AttributeMapping](#attributemapping)[] * **DurationSeconds**: int * **Enabled**: bool * **ManagedPolicyArns**: string[] @@ -48,11 +49,6 @@ * **SessionPolicy**: string * **Tags**: [Tag](#tag)[] -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - ## AWS.RolesAnywhere/TrustAnchorProperties ### Properties * **Enabled**: bool @@ -63,6 +59,10 @@ * **TrustAnchorArn**: string (ReadOnly) * **TrustAnchorId**: string (ReadOnly, Identifier) +## MappingRule +### Properties +* **Specifier**: string (Required) + ## NotificationSetting ### Properties * **Channel**: string @@ -75,11 +75,21 @@ * **SourceData**: [TrustAnchor_SourceData](#trustanchorsourcedata) * **SourceType**: string -## TrustAnchor_SourceData +## Tag ### Properties +* **Key**: string (Required) +* **Value**: string (Required) ## Tag ### Properties * **Key**: string (Required) * **Value**: string (Required) +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + +## TrustAnchor_SourceData +### Properties + diff --git a/artifacts/bicep/aws/aws.route53/default/types.json b/artifacts/bicep/aws/aws.route53/default/types.json index 7efeb307..fc27899d 100644 --- a/artifacts/bicep/aws/aws.route53/default/types.json +++ b/artifacts/bicep/aws/aws.route53/default/types.json @@ -1 +1,602 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"Location","Properties":{"CidrList":{"Type":9,"Flags":1,"Description":"A list of CIDR blocks."},"LocationName":{"Type":4,"Flags":1,"Description":"The name of the location that is associated with the CIDR collection."}}}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.Route53/CidrCollectionProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"The Amazon resource name (ARN) to uniquely identify the AWS resource."},"Id":{"Type":4,"Flags":18,"Description":"UUID of the CIDR collection."},"Locations":{"Type":11,"Flags":0,"Description":"A complex type that contains information about the list of CIDR locations."},"Name":{"Type":4,"Flags":1,"Description":"A unique name for the CIDR collection."}}}},{"3":{"ItemType":8}},{"2":{"Name":"AWS.Route53/CidrCollection","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":10,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Route53/CidrCollection@default","ScopeType":0,"Body":12}},{"2":{"Name":"AlarmIdentifier","Properties":{"Name":{"Type":4,"Flags":1,"Description":"The name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy."},"Region":{"Type":4,"Flags":1,"Description":"For the CloudWatch alarm that you want Route 53 health checkers to use to determine whether this health check is healthy, the region that the alarm was created in."}}}},{"2":{"Name":"HealthCheckTag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag."}}}},{"2":{"Name":"AWS.Route53/HealthCheckProperties","Properties":{"HealthCheckConfig":{"Type":19,"Flags":1,"Description":"A complex type that contains information about the health check."},"HealthCheckId":{"Type":4,"Flags":18},"HealthCheckTags":{"Type":20,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"HealthCheck_HealthCheckConfig","Properties":{"AlarmIdentifier":{"Type":14,"Flags":0},"ChildHealthChecks":{"Type":17,"Flags":0},"EnableSNI":{"Type":2,"Flags":0},"FailureThreshold":{"Type":3,"Flags":0},"FullyQualifiedDomainName":{"Type":4,"Flags":0},"HealthThreshold":{"Type":3,"Flags":0},"IPAddress":{"Type":4,"Flags":0},"InsufficientDataHealthStatus":{"Type":4,"Flags":0},"Inverted":{"Type":2,"Flags":0},"MeasureLatency":{"Type":2,"Flags":0},"Port":{"Type":3,"Flags":0},"Regions":{"Type":18,"Flags":0},"RequestInterval":{"Type":3,"Flags":0},"ResourcePath":{"Type":4,"Flags":0},"RoutingControlArn":{"Type":4,"Flags":0},"SearchString":{"Type":4,"Flags":0},"Type":{"Type":4,"Flags":1}}}},{"3":{"ItemType":15}},{"2":{"Name":"AWS.Route53/HealthCheck","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":16,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Route53/HealthCheck@default","ScopeType":0,"Body":21}},{"2":{"Name":"HostedZoneConfig","Properties":{"Comment":{"Type":4,"Flags":0,"Description":"Any comments that you want to include about the hosted zone."}}}},{"2":{"Name":"HostedZoneTag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag."}}}},{"2":{"Name":"QueryLoggingConfig","Properties":{"CloudWatchLogsLogGroupArn":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) of the CloudWatch Logs log group that Amazon Route 53 is publishing logs to."}}}},{"2":{"Name":"VPC","Properties":{"VPCId":{"Type":4,"Flags":1,"Description":"The ID of an Amazon VPC."},"VPCRegion":{"Type":4,"Flags":1,"Description":"The region that an Amazon VPC was created in. See https://docs.aws.amazon.com/general/latest/gr/rande.html for a list of up to date regions."}}}},{"2":{"Name":"AWS.Route53/HostedZoneProperties","Properties":{"HostedZoneConfig":{"Type":23,"Flags":0},"HostedZoneTags":{"Type":28,"Flags":0,"Description":"Adds, edits, or deletes tags for a health check or a hosted zone.\n\nFor information about using tags for cost allocation, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide."},"Id":{"Type":4,"Flags":18},"Name":{"Type":4,"Flags":0,"Description":"The name of the domain. Specify a fully qualified domain name, for example, www.example.com. The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.\n\nIf you're creating a public hosted zone, this is the name you have registered with your DNS registrar. If your domain name is registered with a registrar other than Route 53, change the name servers for your domain to the set of NameServers that are returned by the Fn::GetAtt intrinsic function."},"NameServers":{"Type":29,"Flags":2},"QueryLoggingConfig":{"Type":25,"Flags":0},"VPCs":{"Type":30,"Flags":0,"Description":"A complex type that contains information about the VPCs that are associated with the specified hosted zone."}}}},{"3":{"ItemType":24}},{"3":{"ItemType":4}},{"3":{"ItemType":26}},{"2":{"Name":"AWS.Route53/HostedZone","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":27,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Route53/HostedZone@default","ScopeType":0,"Body":31}},{"2":{"Name":"AWS.Route53/KeySigningKeyProperties","Properties":{"HostedZoneId":{"Type":4,"Flags":17,"Description":"The unique string (ID) used to identify a hosted zone."},"KeyManagementServiceArn":{"Type":4,"Flags":1,"Description":"The Amazon resource name (ARN) for a customer managed key (CMK) in AWS Key Management Service (KMS). The KeyManagementServiceArn must be unique for each key signing key (KSK) in a single hosted zone."},"Name":{"Type":4,"Flags":17,"Description":"An alphanumeric string used to identify a key signing key (KSK). Name must be unique for each key signing key in the same hosted zone."},"Status":{"Type":4,"Flags":1,"Description":"A string specifying the initial status of the key signing key (KSK). You can set the value to ACTIVE or INACTIVE."}}}},{"2":{"Name":"AWS.Route53/KeySigningKey","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":33,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Route53/KeySigningKey@default","ScopeType":0,"Body":34}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Location", + "properties": { + "CidrList": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "A list of CIDR blocks." + }, + "LocationName": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The name of the location that is associated with the CIDR collection." + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Route53/CidrCollectionProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Route53/CidrCollectionProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The Amazon resource name (ARN) to uniquely identify the AWS resource." + }, + "Id": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "UUID of the CIDR collection." + }, + "Locations": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "A complex type that contains information about the list of CIDR locations." + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "A unique name for the CIDR collection." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Route53/CidrCollection", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Route53/CidrCollection@default", + "scopeType": 0, + "body": { + "$ref": "#/6" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AlarmIdentifier", + "properties": { + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy." + }, + "Region": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "For the CloudWatch alarm that you want Route 53 health checkers to use to determine whether this health check is healthy, the region that the alarm was created in." + } + } + }, + { + "$type": "ObjectType", + "name": "HealthCheckTag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for the tag." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Route53/HealthCheckProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "HealthCheck_HealthCheckConfig", + "properties": { + "AlarmIdentifier": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "ChildHealthChecks": { + "type": { + "$ref": "#/11" + }, + "flags": 0 + }, + "EnableSNI": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + }, + "FailureThreshold": { + "type": { + "$ref": "#/13" + }, + "flags": 0 + }, + "FullyQualifiedDomainName": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "HealthThreshold": { + "type": { + "$ref": "#/13" + }, + "flags": 0 + }, + "IPAddress": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "InsufficientDataHealthStatus": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "Inverted": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + }, + "MeasureLatency": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + }, + "Port": { + "type": { + "$ref": "#/13" + }, + "flags": 0 + }, + "Regions": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + }, + "RequestInterval": { + "type": { + "$ref": "#/13" + }, + "flags": 0 + }, + "ResourcePath": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "RoutingControlArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "SearchString": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/9" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Route53/HealthCheckProperties", + "properties": { + "HealthCheckConfig": { + "type": { + "$ref": "#/15" + }, + "flags": 1, + "description": "A complex type that contains information about the health check." + }, + "HealthCheckId": { + "type": { + "$ref": "#/1" + }, + "flags": 18 + }, + "HealthCheckTags": { + "type": { + "$ref": "#/16" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Route53/HealthCheck", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/17" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Route53/HealthCheck@default", + "scopeType": 0, + "body": { + "$ref": "#/18" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "HostedZoneConfig", + "properties": { + "Comment": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Any comments that you want to include about the hosted zone." + } + } + }, + { + "$type": "ObjectType", + "name": "HostedZoneTag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value of ``Key`` depends on the operation that you want to perform:\n + *Add a tag to a health check or hosted zone*: ``Key`` is the name that you want to give the new tag.\n + *Edit a tag*: ``Key`` is the name of the tag that you want to change the ``Value`` for.\n + *Delete a key*: ``Key`` is the name of the tag you want to remove.\n + *Give a name to a health check*: Edit the default ``Name`` tag. In the Amazon Route 53 console, the list of your health checks includes a *Name* column that lets you see the name that you've given to each health check." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value of ``Value`` depends on the operation that you want to perform:\n + *Add a tag to a health check or hosted zone*: ``Value`` is the value that you want to give the new tag.\n + *Edit a tag*: ``Value`` is the new value that you want to assign the tag." + } + } + }, + { + "$type": "ObjectType", + "name": "QueryLoggingConfig", + "properties": { + "CloudWatchLogsLogGroupArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of the CloudWatch Logs log group that Amazon Route 53 is publishing logs to." + } + } + }, + { + "$type": "ObjectType", + "name": "VPC", + "properties": { + "VPCId": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "*Private hosted zones only:* The ID of an Amazon VPC.\n For public hosted zones, omit ``VPCs``, ``VPCId``, and ``VPCRegion``." + }, + "VPCRegion": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "*Private hosted zones only:* The region that an Amazon VPC was created in.\n For public hosted zones, omit ``VPCs``, ``VPCId``, and ``VPCRegion``." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Route53/HostedZoneProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/21" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/23" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Route53/HostedZoneProperties", + "properties": { + "HostedZoneConfig": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "A complex type that contains an optional comment.\n If you don't want to specify a comment, omit the ``HostedZoneConfig`` and ``Comment`` elements." + }, + "HostedZoneTags": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "Adds, edits, or deletes tags for a health check or a hosted zone.\n For information about using tags for cost allocation, see [Using Cost Allocation Tags](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) in the *User Guide*." + }, + "Id": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "" + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The name of the domain. Specify a fully qualified domain name, for example, *www.example.com*. The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats *www.example.com* (without a trailing dot) and *www.example.com.* (with a trailing dot) as identical.\n If you're creating a public hosted zone, this is the name you have registered with your DNS registrar. If your domain name is registered with a registrar other than Route 53, change the name servers for your domain to the set of ``NameServers`` that are returned by the ``Fn::GetAtt`` intrinsic function." + }, + "NameServers": { + "type": { + "$ref": "#/26" + }, + "flags": 2, + "description": "" + }, + "QueryLoggingConfig": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "Creates 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 DNS query logs contain information about the queries that Route 53 receives for a specified 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 ``ServFail`` \n \n + Log Group and Resource Policy Before you create a query logging configuration, perform the following operations. If you create a query logging configuration using the Route 53 console, Route 53 performs these operations automatically. Create a CloudWatch Logs log group, and make note of the ARN, which you specify when you create a query logging configuration. Note the following: You must create the log group in the us-east-1 region. You must use the same to create the log group and the hosted zone that you want to configure query logging for. When you create log groups for query logging, we recommend that you use a consistent prefix, for example: /aws/route53/hosted zone name In the next step, you'll create a resource policy, which controls access to one or more log groups and the associated resources, such as Route 53 hosted zones. There's a limit on the number of resource policies that you can create, so we recommend that you use a consistent prefix so you can use the same resource policy for all the log groups that you create for query logging. Create a CloudWatch Logs resource policy, and give it the permissions that Route 53 needs to create log streams and to send query logs to log streams. You must create the CloudWatch Logs resource policy in the us-east-1 region. For the value of Resource, specify the ARN for the log group that you created in the previous step. To use the same resource policy for all the CloudWatch Logs log groups that you created for query logging configurations, replace the hosted zone name with *, for example: arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/* To avoid the confused deputy problem, a security issue where an entity without a permission for an action can coerce a more-privileged entity to perform it, you can optionally limit the permissions that a service has to a resource in a resource-based policy by supplying the following values: For aws:SourceArn, supply the hosted zone ARN used in creating the query logging configuration. For example, aws:SourceArn: arn:aws:route53:::hostedzone/hosted zone ID. For aws:SourceAccount, supply the account ID for the account that creates the query logging configuration. For example, aws:SourceAccount:111111111111. For more information, see The confused deputy problem in the IAM User Guide. You can't use the CloudWatch console to create or edit a resource policy. You must use the CloudWatch API, one of the SDKs, or the . + Log Streams and Edge Locations When Route 53 finishes creating the configuration for DNS query logging, it does the following: Creates a log stream for an edge location the first time that the edge location responds to DNS queries for the specified hosted zone. That log stream is used to log all queries that Route 53 responds to for that edge location. Begins to send query logs to the applicable log stream. The name of each log stream is in the following format: hosted zone ID/edge location code The edge location code is a three-letter code and an arbitrarily assigned number, for example, DFW3. The three-letter code typically corresponds with the International Air Transport Association airport code for an airport near the edge location. (These abbreviations might change in the future.) For a list of edge locations, see \"The Route 53 Global Network\" on the Route 53 Product Details page. + Queries That Are Logged Query logs contain only the queries that DNS resolvers forward to Route 53. If a DNS resolver has already cached the response to a query (such as the IP address for a load balancer for example.com), the resolver will continue to return the cached response. It doesn't forward another query to Route 53 until the TTL for the corresponding resource record set expires. Depending on how many DNS queries are submitted for a resource record set, and depending on the TTL for that resource record set, query logs might contain information about only one query out of every several thousand queries that are submitted to DNS. For more information about how DNS works, see Routing Internet Traffic to Your Website or Web Application in the Amazon Route 53 Developer Guide. + Log File Format For a list of the values in each query log and the format of each value, see Logging DNS Queries in the Amazon Route 53 Developer Guide. + Pricing For information about charges for query logs, see Amazon CloudWatch Pricing. + How to Stop Logging If you want Route 53 to stop sending query logs to CloudWatch Logs, delete the query logging configuration. For more information, see DeleteQueryLoggingConfig." + }, + "VPCs": { + "type": { + "$ref": "#/27" + }, + "flags": 0, + "description": "*Private hosted zones:* A complex type that contains information about the VPCs that are associated with the specified hosted zone.\n For public hosted zones, omit ``VPCs``, ``VPCId``, and ``VPCRegion``." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Route53/HostedZone", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/28" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Route53/HostedZone@default", + "scopeType": 0, + "body": { + "$ref": "#/29" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.Route53/KeySigningKeyProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.Route53/KeySigningKeyProperties", + "properties": { + "HostedZoneId": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The unique string (ID) used to identify a hosted zone." + }, + "KeyManagementServiceArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The Amazon resource name (ARN) for a customer managed key (CMK) in AWS Key Management Service (KMS). The KeyManagementServiceArn must be unique for each key signing key (KSK) in a single hosted zone." + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "An alphanumeric string used to identify a key signing key (KSK). Name must be unique for each key signing key in the same hosted zone." + }, + "Status": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "A string specifying the initial status of the key signing key (KSK). You can set the value to ACTIVE or INACTIVE." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Route53/KeySigningKey", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/32" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Route53/KeySigningKey@default", + "scopeType": 0, + "body": { + "$ref": "#/33" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.route53/default/types.md b/artifacts/bicep/aws/aws.route53/default/types.md index 61c66988..ffbe6912 100644 --- a/artifacts/bicep/aws/aws.route53/default/types.md +++ b/artifacts/bicep/aws/aws.route53/default/types.md @@ -3,30 +3,35 @@ ## Resource AWS.Route53/CidrCollection@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Route53/CidrCollectionProperties](#awsroute53cidrcollectionproperties) (Required): properties of the resource +* **properties**: [AWS.Route53/CidrCollectionProperties](#awsroute53cidrcollectionproperties) (Required, Identifier): properties of the resource ## Resource AWS.Route53/HealthCheck@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Route53/HealthCheckProperties](#awsroute53healthcheckproperties) (Required): properties of the resource +* **properties**: [AWS.Route53/HealthCheckProperties](#awsroute53healthcheckproperties) (Required, Identifier): properties of the resource ## Resource AWS.Route53/HostedZone@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Route53/HostedZoneProperties](#awsroute53hostedzoneproperties): properties of the resource +* **properties**: [AWS.Route53/HostedZoneProperties](#awsroute53hostedzoneproperties) (Identifier): properties of the resource ## Resource AWS.Route53/KeySigningKey@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Route53/KeySigningKeyProperties](#awsroute53keysigningkeyproperties) (Required): properties of the resource +* **properties**: [AWS.Route53/KeySigningKeyProperties](#awsroute53keysigningkeyproperties) (Required, Identifier): properties of the resource + +## AlarmIdentifier +### Properties +* **Name**: string (Required): The name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy. +* **Region**: string (Required): For the CloudWatch alarm that you want Route 53 health checkers to use to determine whether this health check is healthy, the region that the alarm was created in. ## AWS.Route53/CidrCollectionProperties ### Properties @@ -35,17 +40,40 @@ * **Locations**: [Location](#location)[]: A complex type that contains information about the list of CIDR locations. * **Name**: string (Required): A unique name for the CIDR collection. -## Location -### Properties -* **CidrList**: string[] (Required): A list of CIDR blocks. -* **LocationName**: string (Required): The name of the location that is associated with the CIDR collection. - ## AWS.Route53/HealthCheckProperties ### Properties * **HealthCheckConfig**: [HealthCheck_HealthCheckConfig](#healthcheckhealthcheckconfig) (Required): A complex type that contains information about the health check. * **HealthCheckId**: string (ReadOnly, Identifier) * **HealthCheckTags**: [HealthCheckTag](#healthchecktag)[]: An array of key-value pairs to apply to this resource. +## AWS.Route53/HostedZoneProperties +### Properties +* **HostedZoneConfig**: [HostedZoneConfig](#hostedzoneconfig): A complex type that contains an optional comment. + If you don't want to specify a comment, omit the ``HostedZoneConfig`` and ``Comment`` elements. +* **HostedZoneTags**: [HostedZoneTag](#hostedzonetag)[]: Adds, edits, or deletes tags for a health check or a hosted zone. + For information about using tags for cost allocation, see [Using Cost Allocation Tags](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) in the *User Guide*. +* **Id**: string (ReadOnly, Identifier) +* **Name**: string: The name of the domain. Specify a fully qualified domain name, for example, *www.example.com*. The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats *www.example.com* (without a trailing dot) and *www.example.com.* (with a trailing dot) as identical. + If you're creating a public hosted zone, this is the name you have registered with your DNS registrar. If your domain name is registered with a registrar other than Route 53, change the name servers for your domain to the set of ``NameServers`` that are returned by the ``Fn::GetAtt`` intrinsic function. +* **NameServers**: string[] (ReadOnly) +* **QueryLoggingConfig**: [QueryLoggingConfig](#queryloggingconfig): Creates 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. + DNS query logs contain information about the queries that Route 53 receives for a specified public hosted zone, such as the following: + + Route 53 edge location that responded to the DNS query + + Domain or subdomain that was requested + + DNS record type, such as A or AAAA + + DNS response code, such as ``NoError`` or ``ServFail`` + + + Log Group and Resource Policy Before you create a query logging configuration, perform the following operations. If you create a query logging configuration using the Route 53 console, Route 53 performs these operations automatically. Create a CloudWatch Logs log group, and make note of the ARN, which you specify when you create a query logging configuration. Note the following: You must create the log group in the us-east-1 region. You must use the same to create the log group and the hosted zone that you want to configure query logging for. When you create log groups for query logging, we recommend that you use a consistent prefix, for example: /aws/route53/hosted zone name In the next step, you'll create a resource policy, which controls access to one or more log groups and the associated resources, such as Route 53 hosted zones. There's a limit on the number of resource policies that you can create, so we recommend that you use a consistent prefix so you can use the same resource policy for all the log groups that you create for query logging. Create a CloudWatch Logs resource policy, and give it the permissions that Route 53 needs to create log streams and to send query logs to log streams. You must create the CloudWatch Logs resource policy in the us-east-1 region. For the value of Resource, specify the ARN for the log group that you created in the previous step. To use the same resource policy for all the CloudWatch Logs log groups that you created for query logging configurations, replace the hosted zone name with *, for example: arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/* To avoid the confused deputy problem, a security issue where an entity without a permission for an action can coerce a more-privileged entity to perform it, you can optionally limit the permissions that a service has to a resource in a resource-based policy by supplying the following values: For aws:SourceArn, supply the hosted zone ARN used in creating the query logging configuration. For example, aws:SourceArn: arn:aws:route53:::hostedzone/hosted zone ID. For aws:SourceAccount, supply the account ID for the account that creates the query logging configuration. For example, aws:SourceAccount:111111111111. For more information, see The confused deputy problem in the IAM User Guide. You can't use the CloudWatch console to create or edit a resource policy. You must use the CloudWatch API, one of the SDKs, or the . + Log Streams and Edge Locations When Route 53 finishes creating the configuration for DNS query logging, it does the following: Creates a log stream for an edge location the first time that the edge location responds to DNS queries for the specified hosted zone. That log stream is used to log all queries that Route 53 responds to for that edge location. Begins to send query logs to the applicable log stream. The name of each log stream is in the following format: hosted zone ID/edge location code The edge location code is a three-letter code and an arbitrarily assigned number, for example, DFW3. The three-letter code typically corresponds with the International Air Transport Association airport code for an airport near the edge location. (These abbreviations might change in the future.) For a list of edge locations, see "The Route 53 Global Network" on the Route 53 Product Details page. + Queries That Are Logged Query logs contain only the queries that DNS resolvers forward to Route 53. If a DNS resolver has already cached the response to a query (such as the IP address for a load balancer for example.com), the resolver will continue to return the cached response. It doesn't forward another query to Route 53 until the TTL for the corresponding resource record set expires. Depending on how many DNS queries are submitted for a resource record set, and depending on the TTL for that resource record set, query logs might contain information about only one query out of every several thousand queries that are submitted to DNS. For more information about how DNS works, see Routing Internet Traffic to Your Website or Web Application in the Amazon Route 53 Developer Guide. + Log File Format For a list of the values in each query log and the format of each value, see Logging DNS Queries in the Amazon Route 53 Developer Guide. + Pricing For information about charges for query logs, see Amazon CloudWatch Pricing. + How to Stop Logging If you want Route 53 to stop sending query logs to CloudWatch Logs, delete the query logging configuration. For more information, see DeleteQueryLoggingConfig. +* **VPCs**: [VPC](#vpc)[]: *Private hosted zones:* A complex type that contains information about the VPCs that are associated with the specified hosted zone. + For public hosted zones, omit ``VPCs``, ``VPCId``, and ``VPCRegion``. + +## AWS.Route53/KeySigningKeyProperties +### Properties +* **HostedZoneId**: string (Required, Identifier): The unique string (ID) used to identify a hosted zone. +* **KeyManagementServiceArn**: string (Required): The Amazon resource name (ARN) for a customer managed key (CMK) in AWS Key Management Service (KMS). The KeyManagementServiceArn must be unique for each key signing key (KSK) in a single hosted zone. +* **Name**: string (Required, Identifier): An alphanumeric string used to identify a key signing key (KSK). Name must be unique for each key signing key in the same hosted zone. +* **Status**: string (Required): A string specifying the initial status of the key signing key (KSK). You can set the value to ACTIVE or INACTIVE. + ## HealthCheck_HealthCheckConfig ### Properties * **AlarmIdentifier**: [AlarmIdentifier](#alarmidentifier) @@ -66,38 +94,30 @@ * **SearchString**: string * **Type**: string (Required) -## AlarmIdentifier -### Properties -* **Name**: string (Required): The name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy. -* **Region**: string (Required): For the CloudWatch alarm that you want Route 53 health checkers to use to determine whether this health check is healthy, the region that the alarm was created in. - ## HealthCheckTag ### Properties * **Key**: string (Required): The key name of the tag. * **Value**: string (Required): The value for the tag. -## AWS.Route53/HostedZoneProperties -### Properties -* **HostedZoneConfig**: [HostedZoneConfig](#hostedzoneconfig) -* **HostedZoneTags**: [HostedZoneTag](#hostedzonetag)[]: Adds, edits, or deletes tags for a health check or a hosted zone. - -For information about using tags for cost allocation, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide. -* **Id**: string (ReadOnly, Identifier) -* **Name**: string: The name of the domain. Specify a fully qualified domain name, for example, www.example.com. The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical. - -If you're creating a public hosted zone, this is the name you have registered with your DNS registrar. If your domain name is registered with a registrar other than Route 53, change the name servers for your domain to the set of NameServers that are returned by the Fn::GetAtt intrinsic function. -* **NameServers**: string[] (ReadOnly) -* **QueryLoggingConfig**: [QueryLoggingConfig](#queryloggingconfig) -* **VPCs**: [VPC](#vpc)[]: A complex type that contains information about the VPCs that are associated with the specified hosted zone. - ## HostedZoneConfig ### Properties * **Comment**: string: Any comments that you want to include about the hosted zone. ## HostedZoneTag ### Properties -* **Key**: string (Required): The key name of the tag. -* **Value**: string (Required): The value for the tag. +* **Key**: string (Required): The value of ``Key`` depends on the operation that you want to perform: + + *Add a tag to a health check or hosted zone*: ``Key`` is the name that you want to give the new tag. + + *Edit a tag*: ``Key`` is the name of the tag that you want to change the ``Value`` for. + + *Delete a key*: ``Key`` is the name of the tag you want to remove. + + *Give a name to a health check*: Edit the default ``Name`` tag. In the Amazon Route 53 console, the list of your health checks includes a *Name* column that lets you see the name that you've given to each health check. +* **Value**: string (Required): The value of ``Value`` depends on the operation that you want to perform: + + *Add a tag to a health check or hosted zone*: ``Value`` is the value that you want to give the new tag. + + *Edit a tag*: ``Value`` is the new value that you want to assign the tag. + +## Location +### Properties +* **CidrList**: string[] (Required): A list of CIDR blocks. +* **LocationName**: string (Required): The name of the location that is associated with the CIDR collection. ## QueryLoggingConfig ### Properties @@ -105,13 +125,8 @@ If you're creating a public hosted zone, this is the name you have registered wi ## VPC ### Properties -* **VPCId**: string (Required): The ID of an Amazon VPC. -* **VPCRegion**: string (Required): The region that an Amazon VPC was created in. See https://docs.aws.amazon.com/general/latest/gr/rande.html for a list of up to date regions. - -## AWS.Route53/KeySigningKeyProperties -### Properties -* **HostedZoneId**: string (Required, Identifier): The unique string (ID) used to identify a hosted zone. -* **KeyManagementServiceArn**: string (Required): The Amazon resource name (ARN) for a customer managed key (CMK) in AWS Key Management Service (KMS). The KeyManagementServiceArn must be unique for each key signing key (KSK) in a single hosted zone. -* **Name**: string (Required, Identifier): An alphanumeric string used to identify a key signing key (KSK). Name must be unique for each key signing key in the same hosted zone. -* **Status**: string (Required): A string specifying the initial status of the key signing key (KSK). You can set the value to ACTIVE or INACTIVE. +* **VPCId**: string (Required): *Private hosted zones only:* The ID of an Amazon VPC. + For public hosted zones, omit ``VPCs``, ``VPCId``, and ``VPCRegion``. +* **VPCRegion**: string (Required): *Private hosted zones only:* The region that an Amazon VPC was created in. + For public hosted zones, omit ``VPCs``, ``VPCId``, and ``VPCRegion``. diff --git a/artifacts/bicep/aws/aws.route53profiles/default/types.json b/artifacts/bicep/aws/aws.route53profiles/default/types.json new file mode 100644 index 00000000..8eee9006 --- /dev/null +++ b/artifacts/bicep/aws/aws.route53profiles/default/types.json @@ -0,0 +1,314 @@ +[ + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.Route53Profiles/ProfileProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Route53Profiles/ProfileProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) of the resolver profile." + }, + "ClientToken": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The id of the creator request" + }, + "Id": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The ID of the profile." + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The name of the profile." + }, + "Tags": { + "type": { + "$ref": "#/3" + }, + "flags": 4, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Route53Profiles/Profile", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Route53Profiles/Profile@default", + "scopeType": 0, + "body": { + "$ref": "#/5" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Route53Profiles/ProfileAssociationProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/7" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Route53Profiles/ProfileAssociationProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The Amazon Resource Name (ARN) of the profile association." + }, + "Id": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "Primary Identifier for Profile Association" + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The name of an association between a Profile and a VPC." + }, + "ProfileId": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The ID of the profile that you associated with the resource that is specified by ResourceId." + }, + "ResourceId": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The resource that you associated the profile with." + }, + "Tags": { + "type": { + "$ref": "#/9" + }, + "flags": 4, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Route53Profiles/ProfileAssociation", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/10" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Route53Profiles/ProfileAssociation@default", + "scopeType": 0, + "body": { + "$ref": "#/11" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.Route53Profiles/ProfileResourceAssociationProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.Route53Profiles/ProfileResourceAssociationProperties", + "properties": { + "Id": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "Primary Identifier for Profile Resource Association" + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The name of an association between the Profile and resource." + }, + "ProfileId": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The ID of the profile that you associated the resource to that is specified by ResourceArn." + }, + "ResourceArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The arn of the resource that you associated to the Profile." + }, + "ResourceProperties": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A JSON-formatted string with key-value pairs specifying the properties of the associated resource." + }, + "ResourceType": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The type of the resource associated to the Profile." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Route53Profiles/ProfileResourceAssociation", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/14" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Route53Profiles/ProfileResourceAssociation@default", + "scopeType": 0, + "body": { + "$ref": "#/15" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.route53profiles/default/types.md b/artifacts/bicep/aws/aws.route53profiles/default/types.md new file mode 100644 index 00000000..f6bba971 --- /dev/null +++ b/artifacts/bicep/aws/aws.route53profiles/default/types.md @@ -0,0 +1,59 @@ +# AWS.Route53Profiles @ default + +## Resource AWS.Route53Profiles/Profile@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.Route53Profiles/ProfileProperties](#awsroute53profilesprofileproperties) (Required, Identifier): properties of the resource + +## Resource AWS.Route53Profiles/ProfileAssociation@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.Route53Profiles/ProfileAssociationProperties](#awsroute53profilesprofileassociationproperties) (Required, Identifier): properties of the resource + +## Resource AWS.Route53Profiles/ProfileResourceAssociation@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.Route53Profiles/ProfileResourceAssociationProperties](#awsroute53profilesprofileresourceassociationproperties) (Required, Identifier): properties of the resource + +## AWS.Route53Profiles/ProfileAssociationProperties +### Properties +* **Arn**: string (WriteOnly): The Amazon Resource Name (ARN) of the profile association. +* **Id**: string (ReadOnly, Identifier): Primary Identifier for Profile Association +* **Name**: string (Required): The name of an association between a Profile and a VPC. +* **ProfileId**: string (Required): The ID of the profile that you associated with the resource that is specified by ResourceId. +* **ResourceId**: string (Required): The resource that you associated the profile with. +* **Tags**: [Tag](#tag)[] (WriteOnly): An array of key-value pairs to apply to this resource. + +## AWS.Route53Profiles/ProfileProperties +### Properties +* **Arn**: string (ReadOnly): The Amazon Resource Name (ARN) of the resolver profile. +* **ClientToken**: string (ReadOnly): The id of the creator request +* **Id**: string (ReadOnly, Identifier): The ID of the profile. +* **Name**: string (Required): The name of the profile. +* **Tags**: [Tag](#tag)[] (WriteOnly): An array of key-value pairs to apply to this resource. + +## AWS.Route53Profiles/ProfileResourceAssociationProperties +### Properties +* **Id**: string (ReadOnly, Identifier): Primary Identifier for Profile Resource Association +* **Name**: string (Required): The name of an association between the Profile and resource. +* **ProfileId**: string (Required): The ID of the profile that you associated the resource to that is specified by ResourceArn. +* **ResourceArn**: string (Required): The arn of the resource that you associated to the Profile. +* **ResourceProperties**: string: A JSON-formatted string with key-value pairs specifying the properties of the associated resource. +* **ResourceType**: string (ReadOnly): The type of the resource associated to the Profile. + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + diff --git a/artifacts/bicep/aws/aws.route53recoverycontrol/default/types.json b/artifacts/bicep/aws/aws.route53recoverycontrol/default/types.json index 454ac4f8..1f339ff8 100644 --- a/artifacts/bicep/aws/aws.route53recoverycontrol/default/types.json +++ b/artifacts/bicep/aws/aws.route53recoverycontrol/default/types.json @@ -1 +1,434 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.Route53RecoveryControl/ControlPanelProperties","Properties":{"ClusterArn":{"Type":4,"Flags":0,"Description":"Cluster to associate with the Control Panel"},"ControlPanelArn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN) of the cluster."},"DefaultControlPanel":{"Type":2,"Flags":2,"Description":"A flag that Amazon Route 53 Application Recovery Controller sets to true to designate the default control panel for a cluster. When you create a cluster, Amazon Route 53 Application Recovery Controller creates a control panel, and sets this flag for that control panel. If you create a control panel yourself, this flag is set to false."},"Name":{"Type":4,"Flags":1,"Description":"The name of the control panel. You can use any non-white space character in the name."},"RoutingControlCount":{"Type":3,"Flags":2,"Description":"Count of associated routing controls"},"Status":{"Type":4,"Flags":2,"Description":"The deployment status of control panel. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION."},"Tags":{"Type":10,"Flags":4,"Description":"A collection of tags associated with a resource"}}}},{"3":{"ItemType":8}},{"2":{"Name":"AWS.Route53RecoveryControl/ControlPanel","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":9,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Route53RecoveryControl/ControlPanel@default","ScopeType":0,"Body":11}},{"2":{"Name":"AWS.Route53RecoveryControl/RoutingControlProperties","Properties":{"ClusterArn":{"Type":4,"Flags":4,"Description":"Arn associated with Control Panel"},"ControlPanelArn":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) of the control panel."},"Name":{"Type":4,"Flags":1,"Description":"The name of the routing control. You can use any non-white space character in the name."},"RoutingControlArn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN) of the routing control."},"Status":{"Type":4,"Flags":2,"Description":"The deployment status of the routing control. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION."}}}},{"2":{"Name":"AWS.Route53RecoveryControl/RoutingControl","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":13,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Route53RecoveryControl/RoutingControl@default","ScopeType":0,"Body":14}},{"2":{"Name":"AssertionRule","Properties":{"AssertedControls":{"Type":22,"Flags":1,"Description":"The routing controls that are part of transactions that are evaluated to determine if a request to change a routing control state is allowed. For example, you might include three routing controls, one for each of three AWS Regions."},"WaitPeriodMs":{"Type":3,"Flags":1,"Description":"An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent \"flapping\" of state. The wait period is 5000 ms by default, but you can choose a custom value."}}}},{"2":{"Name":"GatingRule","Properties":{"GatingControls":{"Type":23,"Flags":1,"Description":"The gating controls for the gating rule. That is, routing controls that are evaluated by the rule configuration that you specify."},"TargetControls":{"Type":24,"Flags":1,"Description":"Routing controls that can only be set or unset if the specified RuleConfig evaluates to true for the specified GatingControls. For example, say you have three gating controls, one for each of three AWS Regions. Now you specify AtLeast 2 as your RuleConfig. With these settings, you can only change (set or unset) the routing controls that you have specified as TargetControls if that rule evaluates to true. \nIn other words, your ability to change the routing controls that you have specified as TargetControls is gated by the rule that you set for the routing controls in GatingControls."},"WaitPeriodMs":{"Type":3,"Flags":1,"Description":"An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent \"flapping\" of state. The wait period is 5000 ms by default, but you can choose a custom value."}}}},{"2":{"Name":"RuleConfig","Properties":{"Inverted":{"Type":2,"Flags":1,"Description":"Logical negation of the rule. If the rule would usually evaluate true, it's evaluated as false, and vice versa."},"Threshold":{"Type":3,"Flags":1,"Description":"The value of N, when you specify an ATLEAST rule type. That is, Threshold is the number of controls that must be set when you specify an ATLEAST type."},"Type":{"Type":4,"Flags":1}}}},{"2":{"Name":"RuleType"}},{"2":{"Name":"SafetyRuleName"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.Route53RecoveryControl/SafetyRuleProperties","Properties":{"AssertionRule":{"Type":16,"Flags":0},"ControlPanelArn":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) of the control panel."},"GatingRule":{"Type":17,"Flags":0},"Name":{"Type":4,"Flags":1},"RuleConfig":{"Type":18,"Flags":1},"SafetyRuleArn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN) of the safety rule."},"Status":{"Type":4,"Flags":2,"Description":"The deployment status of the routing control. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION."},"Tags":{"Type":26,"Flags":4,"Description":"A collection of tags associated with a resource"}}}},{"3":{"ItemType":21}},{"2":{"Name":"AWS.Route53RecoveryControl/SafetyRule","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":25,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Route53RecoveryControl/SafetyRule@default","ScopeType":0,"Body":27}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.Route53RecoveryControl/ControlPanelProperties" + }, + { + "$type": "BooleanType" + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Route53RecoveryControl/ControlPanelProperties", + "properties": { + "ClusterArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Cluster to associate with the Control Panel" + }, + "ControlPanelArn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) of the cluster." + }, + "DefaultControlPanel": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "A flag that Amazon Route 53 Application Recovery Controller sets to true to designate the default control panel for a cluster. When you create a cluster, Amazon Route 53 Application Recovery Controller creates a control panel, and sets this flag for that control panel. If you create a control panel yourself, this flag is set to false." + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The name of the control panel. You can use any non-white space character in the name." + }, + "RoutingControlCount": { + "type": { + "$ref": "#/4" + }, + "flags": 2, + "description": "Count of associated routing controls" + }, + "Status": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The deployment status of control panel. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION." + }, + "Tags": { + "type": { + "$ref": "#/5" + }, + "flags": 4, + "description": "A collection of tags associated with a resource" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Route53RecoveryControl/ControlPanel", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/6" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Route53RecoveryControl/ControlPanel@default", + "scopeType": 0, + "body": { + "$ref": "#/7" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.Route53RecoveryControl/RoutingControlProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.Route53RecoveryControl/RoutingControlProperties", + "properties": { + "ClusterArn": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "Arn associated with Control Panel" + }, + "ControlPanelArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the control panel." + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The name of the routing control. You can use any non-white space character in the name." + }, + "RoutingControlArn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) of the routing control." + }, + "Status": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The deployment status of the routing control. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Route53RecoveryControl/RoutingControl", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/10" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Route53RecoveryControl/RoutingControl@default", + "scopeType": 0, + "body": { + "$ref": "#/11" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AssertionRule", + "properties": { + "AssertedControls": { + "type": { + "$ref": "#/19" + }, + "flags": 1, + "description": "The routing controls that are part of transactions that are evaluated to determine if a request to change a routing control state is allowed. For example, you might include three routing controls, one for each of three AWS Regions." + }, + "WaitPeriodMs": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent \"flapping\" of state. The wait period is 5000 ms by default, but you can choose a custom value." + } + } + }, + { + "$type": "ObjectType", + "name": "GatingRule", + "properties": { + "GatingControls": { + "type": { + "$ref": "#/20" + }, + "flags": 1, + "description": "The gating controls for the gating rule. That is, routing controls that are evaluated by the rule configuration that you specify." + }, + "TargetControls": { + "type": { + "$ref": "#/21" + }, + "flags": 1, + "description": "Routing controls that can only be set or unset if the specified RuleConfig evaluates to true for the specified GatingControls. For example, say you have three gating controls, one for each of three AWS Regions. Now you specify AtLeast 2 as your RuleConfig. With these settings, you can only change (set or unset) the routing controls that you have specified as TargetControls if that rule evaluates to true. \nIn other words, your ability to change the routing controls that you have specified as TargetControls is gated by the rule that you set for the routing controls in GatingControls." + }, + "WaitPeriodMs": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent \"flapping\" of state. The wait period is 5000 ms by default, but you can choose a custom value." + } + } + }, + { + "$type": "ObjectType", + "name": "RuleConfig", + "properties": { + "Inverted": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "Logical negation of the rule. If the rule would usually evaluate true, it's evaluated as false, and vice versa." + }, + "Threshold": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The value of N, when you specify an ATLEAST rule type. That is, Threshold is the number of controls that must be set when you specify an ATLEAST type." + }, + "Type": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "RuleType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SafetyRuleName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Route53RecoveryControl/SafetyRuleProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/18" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Route53RecoveryControl/SafetyRuleProperties", + "properties": { + "AssertionRule": { + "type": { + "$ref": "#/13" + }, + "flags": 0 + }, + "ControlPanelArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of the control panel." + }, + "GatingRule": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "RuleConfig": { + "type": { + "$ref": "#/15" + }, + "flags": 1 + }, + "SafetyRuleArn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) of the safety rule." + }, + "Status": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The deployment status of the routing control. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION." + }, + "Tags": { + "type": { + "$ref": "#/23" + }, + "flags": 4, + "description": "A collection of tags associated with a resource" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Route53RecoveryControl/SafetyRule", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/24" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Route53RecoveryControl/SafetyRule@default", + "scopeType": 0, + "body": { + "$ref": "#/25" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.route53recoverycontrol/default/types.md b/artifacts/bicep/aws/aws.route53recoverycontrol/default/types.md index 701a2ea0..9e045f68 100644 --- a/artifacts/bicep/aws/aws.route53recoverycontrol/default/types.md +++ b/artifacts/bicep/aws/aws.route53recoverycontrol/default/types.md @@ -3,23 +3,28 @@ ## Resource AWS.Route53RecoveryControl/ControlPanel@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Route53RecoveryControl/ControlPanelProperties](#awsroute53recoverycontrolcontrolpanelproperties) (Required): properties of the resource +* **properties**: [AWS.Route53RecoveryControl/ControlPanelProperties](#awsroute53recoverycontrolcontrolpanelproperties) (Required, Identifier): properties of the resource ## Resource AWS.Route53RecoveryControl/RoutingControl@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Route53RecoveryControl/RoutingControlProperties](#awsroute53recoverycontrolroutingcontrolproperties) (Required): properties of the resource +* **properties**: [AWS.Route53RecoveryControl/RoutingControlProperties](#awsroute53recoverycontrolroutingcontrolproperties) (Required, Identifier): properties of the resource ## Resource AWS.Route53RecoveryControl/SafetyRule@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Route53RecoveryControl/SafetyRuleProperties](#awsroute53recoverycontrolsafetyruleproperties) (Required): properties of the resource +* **properties**: [AWS.Route53RecoveryControl/SafetyRuleProperties](#awsroute53recoverycontrolsafetyruleproperties) (Required, Identifier): properties of the resource + +## AssertionRule +### Properties +* **AssertedControls**: string[] (Required): The routing controls that are part of transactions that are evaluated to determine if a request to change a routing control state is allowed. For example, you might include three routing controls, one for each of three AWS Regions. +* **WaitPeriodMs**: int (Required): An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value. ## AWS.Route53RecoveryControl/ControlPanelProperties ### Properties @@ -31,11 +36,6 @@ * **Status**: string (ReadOnly): The deployment status of control panel. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION. * **Tags**: [Tag](#tag)[] (WriteOnly): A collection of tags associated with a resource -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - ## AWS.Route53RecoveryControl/RoutingControlProperties ### Properties * **ClusterArn**: string (WriteOnly): Arn associated with Control Panel @@ -55,11 +55,6 @@ * **Status**: string (ReadOnly): The deployment status of the routing control. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION. * **Tags**: [Tag](#tag)[] (WriteOnly): A collection of tags associated with a resource -## AssertionRule -### Properties -* **AssertedControls**: string[] (Required): The routing controls that are part of transactions that are evaluated to determine if a request to change a routing control state is allowed. For example, you might include three routing controls, one for each of three AWS Regions. -* **WaitPeriodMs**: int (Required): An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value. - ## GatingRule ### Properties * **GatingControls**: string[] (Required): The gating controls for the gating rule. That is, routing controls that are evaluated by the rule configuration that you specify. @@ -78,3 +73,8 @@ In other words, your ability to change the routing controls that you have specif * **Key**: string (Required) * **Value**: string (Required) +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + diff --git a/artifacts/bicep/aws/aws.route53recoveryreadiness/default/types.json b/artifacts/bicep/aws/aws.route53recoveryreadiness/default/types.json index 548c5564..bbe872a8 100644 --- a/artifacts/bicep/aws/aws.route53recoveryreadiness/default/types.json +++ b/artifacts/bicep/aws/aws.route53recoveryreadiness/default/types.json @@ -1 +1,565 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.Route53RecoveryReadiness/CellProperties","Properties":{"CellArn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) of the cell."},"CellName":{"Type":4,"Flags":16,"Description":"The name of the cell to create."},"Cells":{"Type":10,"Flags":0,"Description":"A list of cell Amazon Resource Names (ARNs) contained within this cell, for use in nested cells. For example, Availability Zones within specific Regions."},"ParentReadinessScopes":{"Type":11,"Flags":2,"Description":"The readiness scope for the cell, which can be a cell Amazon Resource Name (ARN) or a recovery group ARN. This is a list but currently can have only one element."},"Tags":{"Type":12,"Flags":0,"Description":"A collection of tags associated with a resource"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":8}},{"2":{"Name":"AWS.Route53RecoveryReadiness/Cell","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":9,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Route53RecoveryReadiness/Cell@default","ScopeType":0,"Body":13}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.Route53RecoveryReadiness/ReadinessCheckProperties","Properties":{"ReadinessCheckArn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) of the readiness check."},"ReadinessCheckName":{"Type":4,"Flags":16,"Description":"Name of the ReadinessCheck to create."},"ResourceSetName":{"Type":4,"Flags":0,"Description":"The name of the resource set to check."},"Tags":{"Type":17,"Flags":0,"Description":"A collection of tags associated with a resource."}}}},{"3":{"ItemType":15}},{"2":{"Name":"AWS.Route53RecoveryReadiness/ReadinessCheck","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":16,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Route53RecoveryReadiness/ReadinessCheck@default","ScopeType":0,"Body":18}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.Route53RecoveryReadiness/RecoveryGroupProperties","Properties":{"Cells":{"Type":22,"Flags":0,"Description":"A list of the cell Amazon Resource Names (ARNs) in the recovery group."},"RecoveryGroupArn":{"Type":4,"Flags":2,"Description":"A collection of tags associated with a resource."},"RecoveryGroupName":{"Type":4,"Flags":16,"Description":"The name of the recovery group to create."},"Tags":{"Type":23,"Flags":0,"Description":"A collection of tags associated with a resource."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":20}},{"2":{"Name":"AWS.Route53RecoveryReadiness/RecoveryGroup","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":21,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Route53RecoveryReadiness/RecoveryGroup@default","ScopeType":0,"Body":24}},{"2":{"Name":"DNSTargetResource","Properties":{"DomainName":{"Type":4,"Flags":0,"Description":"The domain name that acts as an ingress point to a portion of the customer application."},"HostedZoneArn":{"Type":4,"Flags":0,"Description":"The hosted zone Amazon Resource Name (ARN) that contains the DNS record with the provided name of the target resource."},"RecordSetId":{"Type":4,"Flags":0,"Description":"The Route 53 record set ID that will uniquely identify a DNS record, given a name and a type."},"RecordType":{"Type":4,"Flags":0,"Description":"The type of DNS record of the target resource."},"TargetResource":{"Type":31,"Flags":0}}}},{"2":{"Name":"NLBResource","Properties":{"Arn":{"Type":4,"Flags":0,"Description":"A Network Load Balancer resource Amazon Resource Name (ARN)."}}}},{"2":{"Name":"R53ResourceRecord","Properties":{"DomainName":{"Type":4,"Flags":0,"Description":"The DNS target domain name."},"RecordSetId":{"Type":4,"Flags":0,"Description":"The Resource Record set id."}}}},{"2":{"Name":"Resource","Properties":{"ComponentId":{"Type":4,"Flags":0,"Description":"The component identifier of the resource, generated when DNS target resource is used."},"DnsTargetResource":{"Type":26,"Flags":0},"ReadinessScopes":{"Type":32,"Flags":0,"Description":"A list of recovery group Amazon Resource Names (ARNs) and cell ARNs that this resource is contained within."},"ResourceArn":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) of the AWS resource."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"TargetResource","Properties":{"NLBResource":{"Type":27,"Flags":0},"R53Resource":{"Type":28,"Flags":0}}}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.Route53RecoveryReadiness/ResourceSetProperties","Properties":{"ResourceSetArn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) of the resource set."},"ResourceSetName":{"Type":4,"Flags":16,"Description":"The name of the resource set to create."},"ResourceSetType":{"Type":4,"Flags":1,"Description":"The resource type of the resources in the resource set. Enter one of the following values for resource type: \n\nAWS: :AutoScaling: :AutoScalingGroup, AWS: :CloudWatch: :Alarm, AWS: :EC2: :CustomerGateway, AWS: :DynamoDB: :Table, AWS: :EC2: :Volume, AWS: :ElasticLoadBalancing: :LoadBalancer, AWS: :ElasticLoadBalancingV2: :LoadBalancer, AWS: :MSK: :Cluster, AWS: :RDS: :DBCluster, AWS: :Route53: :HealthCheck, AWS: :SQS: :Queue, AWS: :SNS: :Topic, AWS: :SNS: :Subscription, AWS: :EC2: :VPC, AWS: :EC2: :VPNConnection, AWS: :EC2: :VPNGateway, AWS::Route53RecoveryReadiness::DNSTargetResource"},"Resources":{"Type":34,"Flags":1,"Description":"A list of resource objects in the resource set."},"Tags":{"Type":35,"Flags":0,"Description":"A tag to associate with the parameters for a resource set."}}}},{"3":{"ItemType":29}},{"3":{"ItemType":30}},{"2":{"Name":"AWS.Route53RecoveryReadiness/ResourceSet","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":33,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Route53RecoveryReadiness/ResourceSet@default","ScopeType":0,"Body":36}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.Route53RecoveryReadiness/CellProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Route53RecoveryReadiness/CellProperties", + "properties": { + "CellArn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) of the cell." + }, + "CellName": { + "type": { + "$ref": "#/1" + }, + "flags": 16, + "description": "The name of the cell to create." + }, + "Cells": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "A list of cell Amazon Resource Names (ARNs) contained within this cell, for use in nested cells. For example, Availability Zones within specific Regions." + }, + "ParentReadinessScopes": { + "type": { + "$ref": "#/4" + }, + "flags": 2, + "description": "The readiness scope for the cell, which can be a cell Amazon Resource Name (ARN) or a recovery group ARN. This is a list but currently can have only one element." + }, + "Tags": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "A collection of tags associated with a resource" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Route53RecoveryReadiness/Cell", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/6" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Route53RecoveryReadiness/Cell@default", + "scopeType": 0, + "body": { + "$ref": "#/7" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Route53RecoveryReadiness/ReadinessCheckProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/9" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Route53RecoveryReadiness/ReadinessCheckProperties", + "properties": { + "ReadinessCheckArn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) of the readiness check." + }, + "ReadinessCheckName": { + "type": { + "$ref": "#/1" + }, + "flags": 16, + "description": "Name of the ReadinessCheck to create." + }, + "ResourceSetName": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The name of the resource set to check." + }, + "Tags": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "A collection of tags associated with a resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Route53RecoveryReadiness/ReadinessCheck", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/12" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Route53RecoveryReadiness/ReadinessCheck@default", + "scopeType": 0, + "body": { + "$ref": "#/13" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Route53RecoveryReadiness/RecoveryGroupProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/15" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Route53RecoveryReadiness/RecoveryGroupProperties", + "properties": { + "Cells": { + "type": { + "$ref": "#/17" + }, + "flags": 0, + "description": "A list of the cell Amazon Resource Names (ARNs) in the recovery group." + }, + "RecoveryGroupArn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "A collection of tags associated with a resource." + }, + "RecoveryGroupName": { + "type": { + "$ref": "#/1" + }, + "flags": 16, + "description": "The name of the recovery group to create." + }, + "Tags": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "A collection of tags associated with a resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Route53RecoveryReadiness/RecoveryGroup", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/19" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Route53RecoveryReadiness/RecoveryGroup@default", + "scopeType": 0, + "body": { + "$ref": "#/20" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "DNSTargetResource", + "properties": { + "DomainName": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The domain name that acts as an ingress point to a portion of the customer application." + }, + "HostedZoneArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The hosted zone Amazon Resource Name (ARN) that contains the DNS record with the provided name of the target resource." + }, + "RecordSetId": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The Route 53 record set ID that will uniquely identify a DNS record, given a name and a type." + }, + "RecordType": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The type of DNS record of the target resource." + }, + "TargetResource": { + "type": { + "$ref": "#/27" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "NLBResource", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A Network Load Balancer resource Amazon Resource Name (ARN)." + } + } + }, + { + "$type": "ObjectType", + "name": "R53ResourceRecord", + "properties": { + "DomainName": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The DNS target domain name." + }, + "RecordSetId": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The Resource Record set id." + } + } + }, + { + "$type": "ObjectType", + "name": "Resource", + "properties": { + "ComponentId": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The component identifier of the resource, generated when DNS target resource is used." + }, + "DnsTargetResource": { + "type": { + "$ref": "#/22" + }, + "flags": 0 + }, + "ReadinessScopes": { + "type": { + "$ref": "#/28" + }, + "flags": 0, + "description": "A list of recovery group Amazon Resource Names (ARNs) and cell ARNs that this resource is contained within." + }, + "ResourceArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the AWS resource." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TargetResource", + "properties": { + "NLBResource": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "R53Resource": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Route53RecoveryReadiness/ResourceSetProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/25" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/26" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Route53RecoveryReadiness/ResourceSetProperties", + "properties": { + "ResourceSetArn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) of the resource set." + }, + "ResourceSetName": { + "type": { + "$ref": "#/1" + }, + "flags": 16, + "description": "The name of the resource set to create." + }, + "ResourceSetType": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The resource type of the resources in the resource set. Enter one of the following values for resource type: \n\nAWS: :AutoScaling: :AutoScalingGroup, AWS: :CloudWatch: :Alarm, AWS: :EC2: :CustomerGateway, AWS: :DynamoDB: :Table, AWS: :EC2: :Volume, AWS: :ElasticLoadBalancing: :LoadBalancer, AWS: :ElasticLoadBalancingV2: :LoadBalancer, AWS: :MSK: :Cluster, AWS: :RDS: :DBCluster, AWS: :Route53: :HealthCheck, AWS: :SQS: :Queue, AWS: :SNS: :Topic, AWS: :SNS: :Subscription, AWS: :EC2: :VPC, AWS: :EC2: :VPNConnection, AWS: :EC2: :VPNGateway, AWS::Route53RecoveryReadiness::DNSTargetResource" + }, + "Resources": { + "type": { + "$ref": "#/30" + }, + "flags": 1, + "description": "A list of resource objects in the resource set." + }, + "Tags": { + "type": { + "$ref": "#/31" + }, + "flags": 0, + "description": "A tag to associate with the parameters for a resource set." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Route53RecoveryReadiness/ResourceSet", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/32" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Route53RecoveryReadiness/ResourceSet@default", + "scopeType": 0, + "body": { + "$ref": "#/33" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.route53recoveryreadiness/default/types.md b/artifacts/bicep/aws/aws.route53recoveryreadiness/default/types.md index 2d06684a..9b7d692a 100644 --- a/artifacts/bicep/aws/aws.route53recoveryreadiness/default/types.md +++ b/artifacts/bicep/aws/aws.route53recoveryreadiness/default/types.md @@ -3,30 +3,30 @@ ## Resource AWS.Route53RecoveryReadiness/Cell@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Route53RecoveryReadiness/CellProperties](#awsroute53recoveryreadinesscellproperties): properties of the resource +* **properties**: [AWS.Route53RecoveryReadiness/CellProperties](#awsroute53recoveryreadinesscellproperties) (Identifier): properties of the resource ## Resource AWS.Route53RecoveryReadiness/ReadinessCheck@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Route53RecoveryReadiness/ReadinessCheckProperties](#awsroute53recoveryreadinessreadinesscheckproperties): properties of the resource +* **properties**: [AWS.Route53RecoveryReadiness/ReadinessCheckProperties](#awsroute53recoveryreadinessreadinesscheckproperties) (Identifier): properties of the resource ## Resource AWS.Route53RecoveryReadiness/RecoveryGroup@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Route53RecoveryReadiness/RecoveryGroupProperties](#awsroute53recoveryreadinessrecoverygroupproperties): properties of the resource +* **properties**: [AWS.Route53RecoveryReadiness/RecoveryGroupProperties](#awsroute53recoveryreadinessrecoverygroupproperties) (Identifier): properties of the resource ## Resource AWS.Route53RecoveryReadiness/ResourceSet@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Route53RecoveryReadiness/ResourceSetProperties](#awsroute53recoveryreadinessresourcesetproperties) (Required): properties of the resource +* **properties**: [AWS.Route53RecoveryReadiness/ResourceSetProperties](#awsroute53recoveryreadinessresourcesetproperties) (Required, Identifier): properties of the resource ## AWS.Route53RecoveryReadiness/CellProperties ### Properties @@ -36,11 +36,6 @@ * **ParentReadinessScopes**: string[] (ReadOnly): The readiness scope for the cell, which can be a cell Amazon Resource Name (ARN) or a recovery group ARN. This is a list but currently can have only one element. * **Tags**: [Tag](#tag)[]: A collection of tags associated with a resource -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - ## AWS.Route53RecoveryReadiness/ReadinessCheckProperties ### Properties * **ReadinessCheckArn**: string (ReadOnly): The Amazon Resource Name (ARN) of the readiness check. @@ -48,11 +43,6 @@ * **ResourceSetName**: string: The name of the resource set to check. * **Tags**: [Tag](#tag)[]: A collection of tags associated with a resource. -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - ## AWS.Route53RecoveryReadiness/RecoveryGroupProperties ### Properties * **Cells**: string[]: A list of the cell Amazon Resource Names (ARNs) in the recovery group. @@ -60,11 +50,6 @@ * **RecoveryGroupName**: string (Identifier): The name of the recovery group to create. * **Tags**: [Tag](#tag)[]: A collection of tags associated with a resource. -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - ## AWS.Route53RecoveryReadiness/ResourceSetProperties ### Properties * **Resources**: [Resource](#resource)[] (Required): A list of resource objects in the resource set. @@ -75,13 +60,6 @@ AWS: :AutoScaling: :AutoScalingGroup, AWS: :CloudWatch: :Alarm, AWS: :EC2: :CustomerGateway, AWS: :DynamoDB: :Table, AWS: :EC2: :Volume, AWS: :ElasticLoadBalancing: :LoadBalancer, AWS: :ElasticLoadBalancingV2: :LoadBalancer, AWS: :MSK: :Cluster, AWS: :RDS: :DBCluster, AWS: :Route53: :HealthCheck, AWS: :SQS: :Queue, AWS: :SNS: :Topic, AWS: :SNS: :Subscription, AWS: :EC2: :VPC, AWS: :EC2: :VPNConnection, AWS: :EC2: :VPNGateway, AWS::Route53RecoveryReadiness::DNSTargetResource * **Tags**: [Tag](#tag)[]: A tag to associate with the parameters for a resource set. -## Resource -### Properties -* **ComponentId**: string: The component identifier of the resource, generated when DNS target resource is used. -* **DnsTargetResource**: [DNSTargetResource](#dnstargetresource) -* **ReadinessScopes**: string[]: A list of recovery group Amazon Resource Names (ARNs) and cell ARNs that this resource is contained within. -* **ResourceArn**: string: The Amazon Resource Name (ARN) of the AWS resource. - ## DNSTargetResource ### Properties * **DomainName**: string: The domain name that acts as an ingress point to a portion of the customer application. @@ -90,11 +68,6 @@ AWS: :AutoScaling: :AutoScalingGroup, AWS: :CloudWatch: :Alarm, AWS: :EC2: :Cust * **RecordType**: string: The type of DNS record of the target resource. * **TargetResource**: [TargetResource](#targetresource) -## TargetResource -### Properties -* **NLBResource**: [NLBResource](#nlbresource) -* **R53Resource**: [R53ResourceRecord](#r53resourcerecord) - ## NLBResource ### Properties * **Arn**: string: A Network Load Balancer resource Amazon Resource Name (ARN). @@ -104,8 +77,35 @@ AWS: :AutoScaling: :AutoScalingGroup, AWS: :CloudWatch: :Alarm, AWS: :EC2: :Cust * **DomainName**: string: The DNS target domain name. * **RecordSetId**: string: The Resource Record set id. +## Resource +### Properties +* **ComponentId**: string: The component identifier of the resource, generated when DNS target resource is used. +* **DnsTargetResource**: [DNSTargetResource](#dnstargetresource) +* **ReadinessScopes**: string[]: A list of recovery group Amazon Resource Names (ARNs) and cell ARNs that this resource is contained within. +* **ResourceArn**: string: The Amazon Resource Name (ARN) of the AWS resource. + ## Tag ### Properties * **Key**: string (Required) * **Value**: string (Required) +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + +## TargetResource +### Properties +* **NLBResource**: [NLBResource](#nlbresource) +* **R53Resource**: [R53ResourceRecord](#r53resourcerecord) + diff --git a/artifacts/bicep/aws/aws.route53resolver/default/types.json b/artifacts/bicep/aws/aws.route53resolver/default/types.json index 4c07f52a..aaf5c1c6 100644 --- a/artifacts/bicep/aws/aws.route53resolver/default/types.json +++ b/artifacts/bicep/aws/aws.route53resolver/default/types.json @@ -1 +1,919 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"Domains"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.Route53Resolver/FirewallDomainListProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"Arn"},"CreationTime":{"Type":4,"Flags":2,"Description":"Rfc3339TimeString"},"CreatorRequestId":{"Type":4,"Flags":2,"Description":"The id of the creator request."},"DomainCount":{"Type":3,"Flags":2,"Description":"Count"},"DomainFileUrl":{"Type":4,"Flags":4,"Description":"S3 URL to import domains from."},"Domains":{"Type":12,"Flags":4},"Id":{"Type":4,"Flags":18,"Description":"ResourceId"},"ManagedOwnerName":{"Type":4,"Flags":2,"Description":"ServicePrincipal"},"ModificationTime":{"Type":4,"Flags":2,"Description":"Rfc3339TimeString"},"Name":{"Type":4,"Flags":0,"Description":"FirewallDomainListName"},"Status":{"Type":4,"Flags":2,"Description":"ResolverFirewallDomainList, possible values are COMPLETE, DELETING, UPDATING, COMPLETE_IMPORT_FAILED, IMPORTING, and INACTIVE_OWNER_ACCOUNT_CLOSED."},"StatusMessage":{"Type":4,"Flags":2,"Description":"FirewallDomainListAssociationStatus"},"Tags":{"Type":13,"Flags":0,"Description":"Tags"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":9}},{"2":{"Name":"AWS.Route53Resolver/FirewallDomainList","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":11,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Route53Resolver/FirewallDomainList@default","ScopeType":0,"Body":14}},{"2":{"Name":"FirewallRule","Properties":{"Action":{"Type":4,"Flags":1,"Description":"Rule Action"},"BlockOverrideDnsType":{"Type":4,"Flags":0,"Description":"BlockOverrideDnsType"},"BlockOverrideDomain":{"Type":4,"Flags":0,"Description":"BlockOverrideDomain"},"BlockOverrideTtl":{"Type":3,"Flags":0,"Description":"BlockOverrideTtl"},"BlockResponse":{"Type":4,"Flags":0,"Description":"BlockResponse"},"FirewallDomainListId":{"Type":4,"Flags":1,"Description":"ResourceId"},"Priority":{"Type":3,"Flags":1,"Description":"Rule Priority"}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.Route53Resolver/FirewallRuleGroupProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"Arn"},"CreationTime":{"Type":4,"Flags":2,"Description":"Rfc3339TimeString"},"CreatorRequestId":{"Type":4,"Flags":2,"Description":"The id of the creator request."},"FirewallRules":{"Type":19,"Flags":0,"Description":"FirewallRules"},"Id":{"Type":4,"Flags":18,"Description":"ResourceId"},"ModificationTime":{"Type":4,"Flags":2,"Description":"Rfc3339TimeString"},"Name":{"Type":4,"Flags":0,"Description":"FirewallRuleGroupName"},"OwnerId":{"Type":4,"Flags":2,"Description":"AccountId"},"RuleCount":{"Type":3,"Flags":2,"Description":"Count"},"ShareStatus":{"Type":4,"Flags":2,"Description":"ShareStatus, possible values are NOT_SHARED, SHARED_WITH_ME, SHARED_BY_ME."},"Status":{"Type":4,"Flags":2,"Description":"ResolverFirewallRuleGroupAssociation, possible values are COMPLETE, DELETING, UPDATING, and INACTIVE_OWNER_ACCOUNT_CLOSED."},"StatusMessage":{"Type":4,"Flags":2,"Description":"FirewallRuleGroupStatus"},"Tags":{"Type":20,"Flags":0,"Description":"Tags"}}}},{"3":{"ItemType":16}},{"3":{"ItemType":17}},{"2":{"Name":"AWS.Route53Resolver/FirewallRuleGroup","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":18,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Route53Resolver/FirewallRuleGroup@default","ScopeType":0,"Body":21}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.Route53Resolver/FirewallRuleGroupAssociationProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"Arn"},"CreationTime":{"Type":4,"Flags":2,"Description":"Rfc3339TimeString"},"CreatorRequestId":{"Type":4,"Flags":2,"Description":"The id of the creator request."},"FirewallRuleGroupId":{"Type":4,"Flags":1,"Description":"FirewallRuleGroupId"},"Id":{"Type":4,"Flags":18,"Description":"Id"},"ManagedOwnerName":{"Type":4,"Flags":2,"Description":"ServicePrincipal"},"ModificationTime":{"Type":4,"Flags":2,"Description":"Rfc3339TimeString"},"MutationProtection":{"Type":4,"Flags":0,"Description":"MutationProtectionStatus"},"Name":{"Type":4,"Flags":0,"Description":"FirewallRuleGroupAssociationName"},"Priority":{"Type":3,"Flags":1,"Description":"Priority"},"Status":{"Type":4,"Flags":2,"Description":"ResolverFirewallRuleGroupAssociation, possible values are COMPLETE, DELETING, UPDATING, and INACTIVE_OWNER_ACCOUNT_CLOSED."},"StatusMessage":{"Type":4,"Flags":2,"Description":"FirewallDomainListAssociationStatus"},"Tags":{"Type":25,"Flags":0,"Description":"Tags"},"VpcId":{"Type":4,"Flags":1,"Description":"VpcId"}}}},{"3":{"ItemType":23}},{"2":{"Name":"AWS.Route53Resolver/FirewallRuleGroupAssociation","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":24,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Route53Resolver/FirewallRuleGroupAssociation@default","ScopeType":0,"Body":26}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.Route53Resolver/OutpostResolverProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"The OutpostResolver ARN."},"CreationTime":{"Type":4,"Flags":2,"Description":"The OutpostResolver creation time"},"CreatorRequestId":{"Type":4,"Flags":2,"Description":"The id of the creator request."},"Id":{"Type":4,"Flags":18,"Description":"Id"},"InstanceCount":{"Type":3,"Flags":0,"Description":"The number of OutpostResolvers."},"ModificationTime":{"Type":4,"Flags":2,"Description":"The OutpostResolver last modified time"},"Name":{"Type":4,"Flags":1,"Description":"The OutpostResolver name."},"OutpostArn":{"Type":4,"Flags":1,"Description":"The Outpost ARN."},"PreferredInstanceType":{"Type":4,"Flags":1,"Description":"The OutpostResolver instance type."},"Status":{"Type":4,"Flags":2,"Description":"The OutpostResolver status, possible values are CREATING, OPERATIONAL, UPDATING, DELETING, ACTION_NEEDED, FAILED_CREATION and FAILED_DELETION."},"StatusMessage":{"Type":4,"Flags":2,"Description":"The OutpostResolver status message."},"Tags":{"Type":30,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."}}}},{"3":{"ItemType":28}},{"2":{"Name":"AWS.Route53Resolver/OutpostResolver","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":29,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Route53Resolver/OutpostResolver@default","ScopeType":0,"Body":31}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"TargetAddress","Properties":{"Ip":{"Type":4,"Flags":0,"Description":"One IP address that you want to forward DNS queries to. You can specify only IPv4 addresses. "},"Ipv6":{"Type":4,"Flags":0,"Description":"One IPv6 address that you want to forward DNS queries to. You can specify only IPv6 addresses. "},"Port":{"Type":4,"Flags":0,"Description":"The port at Ip that you want to forward DNS queries to. "},"Protocol":{"Type":4,"Flags":0,"Description":"The protocol that you want to use to forward DNS queries. "}}}},{"2":{"Name":"AWS.Route53Resolver/ResolverRuleProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) of the resolver rule."},"DomainName":{"Type":4,"Flags":1,"Description":"DNS queries for this domain name are forwarded to the IP addresses that are specified in TargetIps"},"Name":{"Type":4,"Flags":0,"Description":"The name for the Resolver rule"},"ResolverEndpointId":{"Type":4,"Flags":0,"Description":"The ID of the endpoint that the rule is associated with."},"ResolverRuleId":{"Type":4,"Flags":18,"Description":"The ID of the endpoint that the rule is associated with."},"RuleType":{"Type":4,"Flags":1,"Description":"When you want to forward DNS queries for specified domain name to resolvers on your network, specify FORWARD. When you have a forwarding rule to forward DNS queries for a domain to your network and you want Resolver to process queries for a subdomain of that domain, specify SYSTEM."},"Tags":{"Type":36,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."},"TargetIps":{"Type":37,"Flags":0,"Description":"An array that contains the IP addresses and ports that an outbound endpoint forwards DNS queries to. Typically, these are the IP addresses of DNS resolvers on your network. Specify IPv4 addresses. IPv6 is not supported."}}}},{"3":{"ItemType":33}},{"3":{"ItemType":34}},{"2":{"Name":"AWS.Route53Resolver/ResolverRule","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":35,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Route53Resolver/ResolverRule@default","ScopeType":0,"Body":38}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Domains", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Route53Resolver/FirewallDomainListProperties" + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Route53Resolver/FirewallDomainListProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "Arn" + }, + "CreationTime": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "Rfc3339TimeString" + }, + "CreatorRequestId": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The id of the creator request." + }, + "DomainCount": { + "type": { + "$ref": "#/5" + }, + "flags": 2, + "description": "Count" + }, + "DomainFileUrl": { + "type": { + "$ref": "#/2" + }, + "flags": 4, + "description": "S3 URL to import domains from." + }, + "Domains": { + "type": { + "$ref": "#/6" + }, + "flags": 4 + }, + "Id": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "ResourceId" + }, + "ManagedOwnerName": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "ServicePrincipal" + }, + "ModificationTime": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "Rfc3339TimeString" + }, + "Name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "FirewallDomainListName" + }, + "Status": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "ResolverFirewallDomainList, possible values are COMPLETE, DELETING, UPDATING, COMPLETE_IMPORT_FAILED, IMPORTING, and INACTIVE_OWNER_ACCOUNT_CLOSED." + }, + "StatusMessage": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "FirewallDomainListAssociationStatus" + }, + "Tags": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "Tags" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Route53Resolver/FirewallDomainList", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/8" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Route53Resolver/FirewallDomainList@default", + "scopeType": 0, + "body": { + "$ref": "#/9" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "FirewallRule", + "properties": { + "Action": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "Rule Action" + }, + "BlockOverrideDnsType": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "BlockOverrideDnsType" + }, + "BlockOverrideDomain": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "BlockOverrideDomain" + }, + "BlockOverrideTtl": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "BlockOverrideTtl" + }, + "BlockResponse": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "BlockResponse" + }, + "FirewallDomainListId": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "ResourceId" + }, + "FirewallDomainRedirectionAction": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "FirewallDomainRedirectionAction" + }, + "Priority": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "Rule Priority" + }, + "Qtype": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "Qtype" + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Route53Resolver/FirewallRuleGroupProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/11" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/12" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Route53Resolver/FirewallRuleGroupProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "Arn" + }, + "CreationTime": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "Rfc3339TimeString" + }, + "CreatorRequestId": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The id of the creator request." + }, + "FirewallRules": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "FirewallRules" + }, + "Id": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "ResourceId" + }, + "ModificationTime": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "Rfc3339TimeString" + }, + "Name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "FirewallRuleGroupName" + }, + "OwnerId": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "AccountId" + }, + "RuleCount": { + "type": { + "$ref": "#/5" + }, + "flags": 2, + "description": "Count" + }, + "ShareStatus": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "ShareStatus, possible values are NOT_SHARED, SHARED_WITH_ME, SHARED_BY_ME." + }, + "Status": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "ResolverFirewallRuleGroupAssociation, possible values are COMPLETE, DELETING, UPDATING, and INACTIVE_OWNER_ACCOUNT_CLOSED." + }, + "StatusMessage": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "FirewallRuleGroupStatus" + }, + "Tags": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "Tags" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Route53Resolver/FirewallRuleGroup", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/16" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Route53Resolver/FirewallRuleGroup@default", + "scopeType": 0, + "body": { + "$ref": "#/17" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Route53Resolver/FirewallRuleGroupAssociationProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/19" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Route53Resolver/FirewallRuleGroupAssociationProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "Arn" + }, + "CreationTime": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "Rfc3339TimeString" + }, + "CreatorRequestId": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The id of the creator request." + }, + "FirewallRuleGroupId": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "FirewallRuleGroupId" + }, + "Id": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "Id" + }, + "ManagedOwnerName": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "ServicePrincipal" + }, + "ModificationTime": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "Rfc3339TimeString" + }, + "MutationProtection": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "MutationProtectionStatus" + }, + "Name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "FirewallRuleGroupAssociationName" + }, + "Priority": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "Priority" + }, + "Status": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "ResolverFirewallRuleGroupAssociation, possible values are COMPLETE, DELETING, UPDATING, and INACTIVE_OWNER_ACCOUNT_CLOSED." + }, + "StatusMessage": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "FirewallDomainListAssociationStatus" + }, + "Tags": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "Tags" + }, + "VpcId": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "VpcId" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Route53Resolver/FirewallRuleGroupAssociation", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/22" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Route53Resolver/FirewallRuleGroupAssociation@default", + "scopeType": 0, + "body": { + "$ref": "#/23" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Route53Resolver/OutpostResolverProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/25" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Route53Resolver/OutpostResolverProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The OutpostResolver ARN." + }, + "CreationTime": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The OutpostResolver creation time" + }, + "CreatorRequestId": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The id of the creator request." + }, + "Id": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "Id" + }, + "InstanceCount": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The number of OutpostResolvers." + }, + "ModificationTime": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The OutpostResolver last modified time" + }, + "Name": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The OutpostResolver name." + }, + "OutpostArn": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The Outpost ARN." + }, + "PreferredInstanceType": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The OutpostResolver instance type." + }, + "Status": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The OutpostResolver status, possible values are CREATING, OPERATIONAL, UPDATING, DELETING, ACTION_NEEDED, FAILED_CREATION and FAILED_DELETION." + }, + "StatusMessage": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The OutpostResolver status message." + }, + "Tags": { + "type": { + "$ref": "#/27" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Route53Resolver/OutpostResolver", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/28" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Route53Resolver/OutpostResolver@default", + "scopeType": 0, + "body": { + "$ref": "#/29" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "ObjectType", + "name": "TargetAddress", + "properties": { + "Ip": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "One IP address that you want to forward DNS queries to. You can specify only IPv4 addresses. " + }, + "Ipv6": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "One IPv6 address that you want to forward DNS queries to. You can specify only IPv6 addresses. " + }, + "Port": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The port at Ip that you want to forward DNS queries to. " + }, + "Protocol": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The protocol that you want to use to forward DNS queries. " + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Route53Resolver/ResolverRuleProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/31" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/32" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Route53Resolver/ResolverRuleProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) of the resolver rule." + }, + "DomainName": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "DNS queries for this domain name are forwarded to the IP addresses that are specified in TargetIps" + }, + "Name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The name for the Resolver rule" + }, + "ResolverEndpointId": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The ID of the endpoint that the rule is associated with." + }, + "ResolverRuleId": { + "type": { + "$ref": "#/2" + }, + "flags": 18, + "description": "The ID of the endpoint that the rule is associated with." + }, + "RuleType": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "When you want to forward DNS queries for specified domain name to resolvers on your network, specify FORWARD. When you have a forwarding rule to forward DNS queries for a domain to your network and you want Resolver to process queries for a subdomain of that domain, specify SYSTEM." + }, + "Tags": { + "type": { + "$ref": "#/34" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + }, + "TargetIps": { + "type": { + "$ref": "#/35" + }, + "flags": 0, + "description": "An array that contains the IP addresses and ports that an outbound endpoint forwards DNS queries to. Typically, these are the IP addresses of DNS resolvers on your network. Specify IPv4 addresses. IPv6 is not supported." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Route53Resolver/ResolverRule", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/36" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Route53Resolver/ResolverRule@default", + "scopeType": 0, + "body": { + "$ref": "#/37" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.route53resolver/default/types.md b/artifacts/bicep/aws/aws.route53resolver/default/types.md index bdb8e884..5a29596a 100644 --- a/artifacts/bicep/aws/aws.route53resolver/default/types.md +++ b/artifacts/bicep/aws/aws.route53resolver/default/types.md @@ -3,37 +3,37 @@ ## Resource AWS.Route53Resolver/FirewallDomainList@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Route53Resolver/FirewallDomainListProperties](#awsroute53resolverfirewalldomainlistproperties): properties of the resource +* **properties**: [AWS.Route53Resolver/FirewallDomainListProperties](#awsroute53resolverfirewalldomainlistproperties) (Identifier): properties of the resource ## Resource AWS.Route53Resolver/FirewallRuleGroup@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Route53Resolver/FirewallRuleGroupProperties](#awsroute53resolverfirewallrulegroupproperties): properties of the resource +* **properties**: [AWS.Route53Resolver/FirewallRuleGroupProperties](#awsroute53resolverfirewallrulegroupproperties) (Identifier): properties of the resource ## Resource AWS.Route53Resolver/FirewallRuleGroupAssociation@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Route53Resolver/FirewallRuleGroupAssociationProperties](#awsroute53resolverfirewallrulegroupassociationproperties) (Required): properties of the resource +* **properties**: [AWS.Route53Resolver/FirewallRuleGroupAssociationProperties](#awsroute53resolverfirewallrulegroupassociationproperties) (Required, Identifier): properties of the resource ## Resource AWS.Route53Resolver/OutpostResolver@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Route53Resolver/OutpostResolverProperties](#awsroute53resolveroutpostresolverproperties) (Required): properties of the resource +* **properties**: [AWS.Route53Resolver/OutpostResolverProperties](#awsroute53resolveroutpostresolverproperties) (Required, Identifier): properties of the resource ## Resource AWS.Route53Resolver/ResolverRule@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Route53Resolver/ResolverRuleProperties](#awsroute53resolverresolverruleproperties) (Required): properties of the resource +* **properties**: [AWS.Route53Resolver/ResolverRuleProperties](#awsroute53resolverresolverruleproperties) (Required, Identifier): properties of the resource ## AWS.Route53Resolver/FirewallDomainListProperties ### Properties @@ -51,42 +51,6 @@ * **StatusMessage**: string (ReadOnly): FirewallDomainListAssociationStatus * **Tags**: [Tag](#tag)[]: Tags -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - -## AWS.Route53Resolver/FirewallRuleGroupProperties -### Properties -* **Arn**: string (ReadOnly): Arn -* **CreationTime**: string (ReadOnly): Rfc3339TimeString -* **CreatorRequestId**: string (ReadOnly): The id of the creator request. -* **FirewallRules**: [FirewallRule](#firewallrule)[]: FirewallRules -* **Id**: string (ReadOnly, Identifier): ResourceId -* **ModificationTime**: string (ReadOnly): Rfc3339TimeString -* **Name**: string: FirewallRuleGroupName -* **OwnerId**: string (ReadOnly): AccountId -* **RuleCount**: int (ReadOnly): Count -* **ShareStatus**: string (ReadOnly): ShareStatus, possible values are NOT_SHARED, SHARED_WITH_ME, SHARED_BY_ME. -* **Status**: string (ReadOnly): ResolverFirewallRuleGroupAssociation, possible values are COMPLETE, DELETING, UPDATING, and INACTIVE_OWNER_ACCOUNT_CLOSED. -* **StatusMessage**: string (ReadOnly): FirewallRuleGroupStatus -* **Tags**: [Tag](#tag)[]: Tags - -## FirewallRule -### Properties -* **Action**: string (Required): Rule Action -* **BlockOverrideDnsType**: string: BlockOverrideDnsType -* **BlockOverrideDomain**: string: BlockOverrideDomain -* **BlockOverrideTtl**: int: BlockOverrideTtl -* **BlockResponse**: string: BlockResponse -* **FirewallDomainListId**: string (Required): ResourceId -* **Priority**: int (Required): Rule Priority - -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## AWS.Route53Resolver/FirewallRuleGroupAssociationProperties ### Properties * **Arn**: string (ReadOnly): Arn @@ -104,10 +68,21 @@ * **Tags**: [Tag](#tag)[]: Tags * **VpcId**: string (Required): VpcId -## Tag +## AWS.Route53Resolver/FirewallRuleGroupProperties ### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Arn**: string (ReadOnly): Arn +* **CreationTime**: string (ReadOnly): Rfc3339TimeString +* **CreatorRequestId**: string (ReadOnly): The id of the creator request. +* **FirewallRules**: [FirewallRule](#firewallrule)[]: FirewallRules +* **Id**: string (ReadOnly, Identifier): ResourceId +* **ModificationTime**: string (ReadOnly): Rfc3339TimeString +* **Name**: string: FirewallRuleGroupName +* **OwnerId**: string (ReadOnly): AccountId +* **RuleCount**: int (ReadOnly): Count +* **ShareStatus**: string (ReadOnly): ShareStatus, possible values are NOT_SHARED, SHARED_WITH_ME, SHARED_BY_ME. +* **Status**: string (ReadOnly): ResolverFirewallRuleGroupAssociation, possible values are COMPLETE, DELETING, UPDATING, and INACTIVE_OWNER_ACCOUNT_CLOSED. +* **StatusMessage**: string (ReadOnly): FirewallRuleGroupStatus +* **Tags**: [Tag](#tag)[]: Tags ## AWS.Route53Resolver/OutpostResolverProperties ### Properties @@ -124,11 +99,6 @@ * **StatusMessage**: string (ReadOnly): The OutpostResolver status message. * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## AWS.Route53Resolver/ResolverRuleProperties ### Properties * **Arn**: string (ReadOnly): The Amazon Resource Name (ARN) of the resolver rule. @@ -140,6 +110,38 @@ * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. * **TargetIps**: [TargetAddress](#targetaddress)[]: An array that contains the IP addresses and ports that an outbound endpoint forwards DNS queries to. Typically, these are the IP addresses of DNS resolvers on your network. Specify IPv4 addresses. IPv6 is not supported. +## FirewallRule +### Properties +* **Action**: string (Required): Rule Action +* **BlockOverrideDnsType**: string: BlockOverrideDnsType +* **BlockOverrideDomain**: string: BlockOverrideDomain +* **BlockOverrideTtl**: int: BlockOverrideTtl +* **BlockResponse**: string: BlockResponse +* **FirewallDomainListId**: string (Required): ResourceId +* **FirewallDomainRedirectionAction**: string: FirewallDomainRedirectionAction +* **Priority**: int (Required): Rule Priority +* **Qtype**: string: Qtype + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + ## Tag ### Properties * **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. diff --git a/artifacts/bicep/aws/aws.rum/default/types.json b/artifacts/bicep/aws/aws.rum/default/types.json index ddb35ae9..799016c5 100644 --- a/artifacts/bicep/aws/aws.rum/default/types.json +++ b/artifacts/bicep/aws/aws.rum/default/types.json @@ -1 +1,394 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"AppMonitorConfiguration","Properties":{"AllowCookies":{"Type":2,"Flags":0,"Description":"If you set this to true, the RUM web client sets two cookies, a session cookie and a user cookie. The cookies allow the RUM web client to collect data relating to the number of users an application has and the behavior of the application across a sequence of events. Cookies are stored in the top-level domain of the current page."},"EnableXRay":{"Type":2,"Flags":0,"Description":"If you set this to true, RUM enables xray tracing for the user sessions that RUM samples. RUM adds an xray trace header to allowed HTTP requests. It also records an xray segment for allowed HTTP requests. You can see traces and segments from these user sessions in the xray console and the CW ServiceLens console."},"ExcludedPages":{"Type":20,"Flags":0,"Description":"A list of URLs in your website or application to exclude from RUM data collection. You can't include both ExcludedPages and IncludedPages in the same operation."},"FavoritePages":{"Type":21,"Flags":0,"Description":"A list of pages in the RUM console that are to be displayed with a favorite icon."},"GuestRoleArn":{"Type":4,"Flags":0,"Description":"The ARN of the guest IAM role that is attached to the identity pool that is used to authorize the sending of data to RUM."},"IdentityPoolId":{"Type":4,"Flags":0,"Description":"The ID of the identity pool that is used to authorize the sending of data to RUM."},"IncludedPages":{"Type":22,"Flags":0,"Description":"If this app monitor is to collect data from only certain pages in your application, this structure lists those pages. You can't include both ExcludedPages and IncludedPages in the same operation."},"MetricDestinations":{"Type":23,"Flags":0,"Description":"An array of structures which define the destinations and the metrics that you want to send."},"SessionSampleRate":{"Type":3,"Flags":0,"Description":"Specifies the percentage of user sessions to use for RUM data collection. Choosing a higher percentage gives you more data but also incurs more costs. The number you specify is the percentage of user sessions that will be used. If you omit this parameter, the default of 10 is used."},"Telemetries":{"Type":24,"Flags":0,"Description":"An array that lists the types of telemetry data that this app monitor is to collect."}}}},{"2":{"Name":"Arn"}},{"2":{"Name":"CustomEvents","Properties":{"Status":{"Type":4,"Flags":0,"Description":"Indicates whether AppMonitor accepts custom events."}}}},{"2":{"Name":"CustomEventsStatus"}},{"2":{"Name":"FavoritePages"}},{"2":{"Name":"MetricDefinition","Properties":{"DimensionKeys":{"Type":26,"Flags":0,"Description":"Use this field only if you are sending the metric to CloudWatch.\n\nThis field is a map of field paths to dimension names. It defines the dimensions to associate with this metric in CloudWatch. For extended metrics, valid values for the entries in this field are the following:\n\n\"metadata.pageId\": \"PageId\"\n\n\"metadata.browserName\": \"BrowserName\"\n\n\"metadata.deviceType\": \"DeviceType\"\n\n\"metadata.osName\": \"OSName\"\n\n\"metadata.countryCode\": \"CountryCode\"\n\n\"event_details.fileType\": \"FileType\"\n\nAll dimensions listed in this field must also be included in EventPattern."},"EventPattern":{"Type":4,"Flags":0,"Description":"The pattern that defines the metric, specified as a JSON object. RUM checks events that happen in a user's session against the pattern, and events that match the pattern are sent to the metric destination.\n\nWhen you define extended metrics, the metric definition is not valid if EventPattern is omitted.\n\nExample event patterns:\n\n'{ \"event_type\": [\"com.amazon.rum.js_error_event\"], \"metadata\": { \"browserName\": [ \"Chrome\", \"Safari\" ], } }'\n\n'{ \"event_type\": [\"com.amazon.rum.performance_navigation_event\"], \"metadata\": { \"browserName\": [ \"Chrome\", \"Firefox\" ] }, \"event_details\": { \"duration\": [{ \"numeric\": [ \"<\", 2000 ] }] } }'\n\n'{ \"event_type\": [\"com.amazon.rum.performance_navigation_event\"], \"metadata\": { \"browserName\": [ \"Chrome\", \"Safari\" ], \"countryCode\": [ \"US\" ] }, \"event_details\": { \"duration\": [{ \"numeric\": [ \">=\", 2000, \"<\", 8000 ] }] } }'\n\nIf the metrics destination' is CloudWatch and the event also matches a value in DimensionKeys, then the metric is published with the specified dimensions."},"Name":{"Type":4,"Flags":17,"Description":"The name for the metric that is defined in this structure. For extended metrics, valid values are the following:\n\nPerformanceNavigationDuration\n\nPerformanceResourceDuration\n\nNavigationSatisfiedTransaction\n\nNavigationToleratedTransaction\n\nNavigationFrustratedTransaction\n\nWebVitalsCumulativeLayoutShift\n\nWebVitalsFirstInputDelay\n\nWebVitalsLargestContentfulPaint\n\nJsErrorCount\n\nHttpErrorCount\n\nSessionCount"},"Namespace":{"Type":4,"Flags":0,"Description":"The namespace used by CloudWatch Metrics for the metric that is defined in this structure"},"UnitLabel":{"Type":4,"Flags":0,"Description":"The CloudWatch metric unit to use for this metric. If you omit this field, the metric is recorded with no unit."},"ValueKey":{"Type":4,"Flags":0,"Description":"The field within the event object that the metric value is sourced from.\n\nIf you omit this field, a hardcoded value of 1 is pushed as the metric value. This is useful if you just want to count the number of events that the filter catches.\n\nIf this metric is sent to Evidently, this field will be passed to Evidently raw and Evidently will handle data extraction from the event."}}}},{"2":{"Name":"MetricDestination","Properties":{"Destination":{"Type":4,"Flags":1,"Description":"Defines the destination to send the metrics to. Valid values are CloudWatch and Evidently. If you specify Evidently, you must also specify the ARN of the Evidently experiment that is to be the destination and an IAM role that has permission to write to the experiment."},"DestinationArn":{"Type":4,"Flags":0,"Description":"Use this parameter only if Destination is Evidently. This parameter specifies the ARN of the Evidently experiment that will receive the extended metrics."},"IamRoleArn":{"Type":4,"Flags":0,"Description":"This parameter is required if Destination is Evidently. If Destination is CloudWatch, do not use this parameter.\n\nThis parameter specifies the ARN of an IAM role that RUM will assume to write to the Evidently experiment that you are sending metrics to. This role must have permission to write to that experiment."},"MetricDefinitions":{"Type":27,"Flags":0,"Description":"An array of structures which define the metrics that you want to send."}}}},{"2":{"Name":"Pages"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}}}},{"2":{"Name":"TagDef"}},{"2":{"Name":"Telemetry"}},{"2":{"Name":"Url"}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":14}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AppMonitor_DimensionKeys","Properties":{}}},{"3":{"ItemType":13}},{"3":{"ItemType":4}},{"3":{"ItemType":16}},{"2":{"Name":"AWS.RUM/AppMonitorProperties","Properties":{"AppMonitorConfiguration":{"Type":8,"Flags":0},"CustomEvents":{"Type":10,"Flags":0},"CwLogEnabled":{"Type":2,"Flags":0,"Description":"Data collected by RUM is kept by RUM for 30 days and then deleted. This parameter specifies whether RUM sends a copy of this telemetry data to CWLlong in your account. This enables you to keep the telemetry data for more than 30 days, but it does incur CWLlong charges. If you omit this parameter, the default is false"},"Domain":{"Type":4,"Flags":1,"Description":"The top-level internet domain name for which your application has administrative authority."},"Id":{"Type":4,"Flags":2,"Description":"The unique ID of the new app monitor."},"Name":{"Type":4,"Flags":17,"Description":"A name for the app monitor"},"Tags":{"Type":31,"Flags":0}}}},{"3":{"ItemType":16}},{"2":{"Name":"AWS.RUM/AppMonitor","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":30,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.RUM/AppMonitor@default","ScopeType":0,"Body":32}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "AppMonitorConfiguration", + "properties": { + "AllowCookies": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "If you set this to true, the RUM web client sets two cookies, a session cookie and a user cookie. The cookies allow the RUM web client to collect data relating to the number of users an application has and the behavior of the application across a sequence of events. Cookies are stored in the top-level domain of the current page." + }, + "EnableXRay": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "If you set this to true, RUM enables xray tracing for the user sessions that RUM samples. RUM adds an xray trace header to allowed HTTP requests. It also records an xray segment for allowed HTTP requests. You can see traces and segments from these user sessions in the xray console and the CW ServiceLens console." + }, + "ExcludedPages": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "A list of URLs in your website or application to exclude from RUM data collection. You can't include both ExcludedPages and IncludedPages in the same operation." + }, + "FavoritePages": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "A list of pages in the RUM console that are to be displayed with a favorite icon." + }, + "GuestRoleArn": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "The ARN of the guest IAM role that is attached to the identity pool that is used to authorize the sending of data to RUM." + }, + "IdentityPoolId": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "The ID of the identity pool that is used to authorize the sending of data to RUM." + }, + "IncludedPages": { + "type": { + "$ref": "#/16" + }, + "flags": 0, + "description": "If this app monitor is to collect data from only certain pages in your application, this structure lists those pages. You can't include both ExcludedPages and IncludedPages in the same operation." + }, + "MetricDestinations": { + "type": { + "$ref": "#/17" + }, + "flags": 0, + "description": "An array of structures which define the destinations and the metrics that you want to send." + }, + "SessionSampleRate": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "Specifies the percentage of user sessions to use for RUM data collection. Choosing a higher percentage gives you more data but also incurs more costs. The number you specify is the percentage of user sessions that will be used. If you omit this parameter, the default of 10 is used." + }, + "Telemetries": { + "type": { + "$ref": "#/19" + }, + "flags": 0, + "description": "An array that lists the types of telemetry data that this app monitor is to collect." + } + } + }, + { + "$type": "ObjectType", + "name": "Arn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CustomEvents", + "properties": { + "Status": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "Indicates whether AppMonitor accepts custom events." + } + } + }, + { + "$type": "ObjectType", + "name": "CustomEventsStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "FavoritePages", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MetricDefinition", + "properties": { + "DimensionKeys": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "Use this field only if you are sending the metric to CloudWatch.\n\nThis field is a map of field paths to dimension names. It defines the dimensions to associate with this metric in CloudWatch. For extended metrics, valid values for the entries in this field are the following:\n\n\"metadata.pageId\": \"PageId\"\n\n\"metadata.browserName\": \"BrowserName\"\n\n\"metadata.deviceType\": \"DeviceType\"\n\n\"metadata.osName\": \"OSName\"\n\n\"metadata.countryCode\": \"CountryCode\"\n\n\"event_details.fileType\": \"FileType\"\n\nAll dimensions listed in this field must also be included in EventPattern." + }, + "EventPattern": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "The pattern that defines the metric, specified as a JSON object. RUM checks events that happen in a user's session against the pattern, and events that match the pattern are sent to the metric destination.\n\nWhen you define extended metrics, the metric definition is not valid if EventPattern is omitted.\n\nExample event patterns:\n\n'{ \"event_type\": [\"com.amazon.rum.js_error_event\"], \"metadata\": { \"browserName\": [ \"Chrome\", \"Safari\" ], } }'\n\n'{ \"event_type\": [\"com.amazon.rum.performance_navigation_event\"], \"metadata\": { \"browserName\": [ \"Chrome\", \"Firefox\" ] }, \"event_details\": { \"duration\": [{ \"numeric\": [ \"<\", 2000 ] }] } }'\n\n'{ \"event_type\": [\"com.amazon.rum.performance_navigation_event\"], \"metadata\": { \"browserName\": [ \"Chrome\", \"Safari\" ], \"countryCode\": [ \"US\" ] }, \"event_details\": { \"duration\": [{ \"numeric\": [ \">=\", 2000, \"<\", 8000 ] }] } }'\n\nIf the metrics destination' is CloudWatch and the event also matches a value in DimensionKeys, then the metric is published with the specified dimensions." + }, + "Name": { + "type": { + "$ref": "#/13" + }, + "flags": 17, + "description": "The name for the metric that is defined in this structure. For extended metrics, valid values are the following:\n\nPerformanceNavigationDuration\n\nPerformanceResourceDuration\n\nNavigationSatisfiedTransaction\n\nNavigationToleratedTransaction\n\nNavigationFrustratedTransaction\n\nWebVitalsCumulativeLayoutShift\n\nWebVitalsFirstInputDelay\n\nWebVitalsLargestContentfulPaint\n\nJsErrorCount\n\nHttpErrorCount\n\nSessionCount" + }, + "Namespace": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "The namespace used by CloudWatch Metrics for the metric that is defined in this structure" + }, + "UnitLabel": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "The CloudWatch metric unit to use for this metric. If you omit this field, the metric is recorded with no unit." + }, + "ValueKey": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "The field within the event object that the metric value is sourced from.\n\nIf you omit this field, a hardcoded value of 1 is pushed as the metric value. This is useful if you just want to count the number of events that the filter catches.\n\nIf this metric is sent to Evidently, this field will be passed to Evidently raw and Evidently will handle data extraction from the event." + } + } + }, + { + "$type": "ObjectType", + "name": "MetricDestination", + "properties": { + "Destination": { + "type": { + "$ref": "#/13" + }, + "flags": 1, + "description": "Defines the destination to send the metrics to. Valid values are CloudWatch and Evidently. If you specify Evidently, you must also specify the ARN of the Evidently experiment that is to be the destination and an IAM role that has permission to write to the experiment." + }, + "DestinationArn": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "Use this parameter only if Destination is Evidently. This parameter specifies the ARN of the Evidently experiment that will receive the extended metrics." + }, + "IamRoleArn": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "This parameter is required if Destination is Evidently. If Destination is CloudWatch, do not use this parameter.\n\nThis parameter specifies the ARN of an IAM role that RUM will assume to write to the Evidently experiment that you are sending metrics to. This role must have permission to write to that experiment." + }, + "MetricDefinitions": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "An array of structures which define the metrics that you want to send." + } + } + }, + { + "$type": "ObjectType", + "name": "Pages", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/13" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + }, + "Value": { + "type": { + "$ref": "#/13" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + } + } + }, + { + "$type": "ObjectType", + "name": "TagDef", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Telemetry", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Url", + "properties": {} + }, + { + "$type": "BooleanType" + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "ObjectType", + "name": "AppMonitor_DimensionKeys", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/8" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.RUM/AppMonitorProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/8" + } + }, + { + "$type": "ObjectType", + "name": "AWS.RUM/AppMonitorProperties", + "properties": { + "AppMonitorConfiguration": { + "type": { + "$ref": "#/0" + }, + "flags": 0 + }, + "CustomEvents": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "CwLogEnabled": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "Data collected by RUM is kept by RUM for 30 days and then deleted. This parameter specifies whether RUM sends a copy of this telemetry data to CWLlong in your account. This enables you to keep the telemetry data for more than 30 days, but it does incur CWLlong charges. If you omit this parameter, the default is false" + }, + "Domain": { + "type": { + "$ref": "#/13" + }, + "flags": 1, + "description": "The top-level internet domain name for which your application has administrative authority." + }, + "Id": { + "type": { + "$ref": "#/13" + }, + "flags": 2, + "description": "The unique ID of the new app monitor." + }, + "Name": { + "type": { + "$ref": "#/13" + }, + "flags": 17, + "description": "A name for the app monitor" + }, + "Tags": { + "type": { + "$ref": "#/26" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.RUM/AppMonitor", + "properties": { + "name": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/13" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/27" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.RUM/AppMonitor@default", + "scopeType": 0, + "body": { + "$ref": "#/28" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.rum/default/types.md b/artifacts/bicep/aws/aws.rum/default/types.md index 60f35d94..565d8cd9 100644 --- a/artifacts/bicep/aws/aws.rum/default/types.md +++ b/artifacts/bicep/aws/aws.rum/default/types.md @@ -3,19 +3,12 @@ ## Resource AWS.RUM/AppMonitor@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.RUM/AppMonitorProperties](#awsrumappmonitorproperties) (Required): properties of the resource +* **properties**: [AWS.RUM/AppMonitorProperties](#awsrumappmonitorproperties) (Required, Identifier): properties of the resource -## AWS.RUM/AppMonitorProperties +## AppMonitor_DimensionKeys ### Properties -* **AppMonitorConfiguration**: [AppMonitorConfiguration](#appmonitorconfiguration) -* **CustomEvents**: [CustomEvents](#customevents) -* **CwLogEnabled**: bool: Data collected by RUM is kept by RUM for 30 days and then deleted. This parameter specifies whether RUM sends a copy of this telemetry data to CWLlong in your account. This enables you to keep the telemetry data for more than 30 days, but it does incur CWLlong charges. If you omit this parameter, the default is false -* **Domain**: string (Required): The top-level internet domain name for which your application has administrative authority. -* **Id**: string (ReadOnly): The unique ID of the new app monitor. -* **Name**: string (Required, Identifier): A name for the app monitor -* **Tags**: [Tag](#tag)[] ## AppMonitorConfiguration ### Properties @@ -30,14 +23,19 @@ * **SessionSampleRate**: int: Specifies the percentage of user sessions to use for RUM data collection. Choosing a higher percentage gives you more data but also incurs more costs. The number you specify is the percentage of user sessions that will be used. If you omit this parameter, the default of 10 is used. * **Telemetries**: string[]: An array that lists the types of telemetry data that this app monitor is to collect. -## MetricDestination +## AWS.RUM/AppMonitorProperties ### Properties -* **Destination**: string (Required): Defines the destination to send the metrics to. Valid values are CloudWatch and Evidently. If you specify Evidently, you must also specify the ARN of the Evidently experiment that is to be the destination and an IAM role that has permission to write to the experiment. -* **DestinationArn**: string: Use this parameter only if Destination is Evidently. This parameter specifies the ARN of the Evidently experiment that will receive the extended metrics. -* **IamRoleArn**: string: This parameter is required if Destination is Evidently. If Destination is CloudWatch, do not use this parameter. +* **AppMonitorConfiguration**: [AppMonitorConfiguration](#appmonitorconfiguration) +* **CustomEvents**: [CustomEvents](#customevents) +* **CwLogEnabled**: bool: Data collected by RUM is kept by RUM for 30 days and then deleted. This parameter specifies whether RUM sends a copy of this telemetry data to CWLlong in your account. This enables you to keep the telemetry data for more than 30 days, but it does incur CWLlong charges. If you omit this parameter, the default is false +* **Domain**: string (Required): The top-level internet domain name for which your application has administrative authority. +* **Id**: string (ReadOnly): The unique ID of the new app monitor. +* **Name**: string (Required, Identifier): A name for the app monitor +* **Tags**: [Tag](#tag)[] -This parameter specifies the ARN of an IAM role that RUM will assume to write to the Evidently experiment that you are sending metrics to. This role must have permission to write to that experiment. -* **MetricDefinitions**: [MetricDefinition](#metricdefinition)[]: An array of structures which define the metrics that you want to send. +## CustomEvents +### Properties +* **Status**: string: Indicates whether AppMonitor accepts custom events. ## MetricDefinition ### Properties @@ -102,12 +100,14 @@ If you omit this field, a hardcoded value of 1 is pushed as the metric value. Th If this metric is sent to Evidently, this field will be passed to Evidently raw and Evidently will handle data extraction from the event. -## AppMonitor_DimensionKeys +## MetricDestination ### Properties +* **Destination**: string (Required): Defines the destination to send the metrics to. Valid values are CloudWatch and Evidently. If you specify Evidently, you must also specify the ARN of the Evidently experiment that is to be the destination and an IAM role that has permission to write to the experiment. +* **DestinationArn**: string: Use this parameter only if Destination is Evidently. This parameter specifies the ARN of the Evidently experiment that will receive the extended metrics. +* **IamRoleArn**: string: This parameter is required if Destination is Evidently. If Destination is CloudWatch, do not use this parameter. -## CustomEvents -### Properties -* **Status**: string: Indicates whether AppMonitor accepts custom events. +This parameter specifies the ARN of an IAM role that RUM will assume to write to the Evidently experiment that you are sending metrics to. This role must have permission to write to that experiment. +* **MetricDefinitions**: [MetricDefinition](#metricdefinition)[]: An array of structures which define the metrics that you want to send. ## Tag ### Properties diff --git a/artifacts/bicep/aws/aws.s3/default/types.json b/artifacts/bicep/aws/aws.s3/default/types.json index 3a6fcb24..aacf24eb 100644 --- a/artifacts/bicep/aws/aws.s3/default/types.json +++ b/artifacts/bicep/aws/aws.s3/default/types.json @@ -1 +1,3440 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"AccessGrantArn"}},{"2":{"Name":"AccessGrantsLocationConfiguration","Properties":{"S3SubPrefix":{"Type":4,"Flags":1,"Description":"The S3 sub prefix of a registered location in your S3 Access Grants instance"}}}},{"2":{"Name":"Grantee","Properties":{"GranteeIdentifier":{"Type":4,"Flags":1,"Description":"The unique identifier of the Grantee"},"GranteeType":{"Type":4,"Flags":1,"Description":"Configures the transfer acceleration state for an Amazon S3 bucket."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.S3/AccessGrantProperties","Properties":{"AccessGrantArn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) of the specified access grant."},"AccessGrantId":{"Type":4,"Flags":18,"Description":"The ID assigned to this access grant."},"AccessGrantsLocationConfiguration":{"Type":9,"Flags":0,"Description":"The configuration options of the grant location, which is the S3 path to the data to which you are granting access."},"AccessGrantsLocationId":{"Type":4,"Flags":1,"Description":"The custom S3 location to be accessed by the grantee"},"ApplicationArn":{"Type":4,"Flags":0,"Description":"The ARN of the application grantees will use to access the location"},"GrantScope":{"Type":4,"Flags":2,"Description":"The S3 path of the data to which you are granting access. It is a combination of the S3 path of the registered location and the subprefix."},"Grantee":{"Type":10,"Flags":1,"Description":"The principal who will be granted permission to access S3."},"Permission":{"Type":4,"Flags":1,"Description":"The level of access to be afforded to the grantee"},"S3PrefixType":{"Type":4,"Flags":4,"Description":"The type of S3SubPrefix."},"Tags":{"Type":13,"Flags":4}}}},{"3":{"ItemType":11}},{"2":{"Name":"AWS.S3/AccessGrant","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":12,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.S3/AccessGrant@default","ScopeType":0,"Body":14}},{"2":{"Name":"AccessGrantsInstanceArn"}},{"2":{"Name":"IdentityCenterArn"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.S3/AccessGrantsInstanceProperties","Properties":{"AccessGrantsInstanceArn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN) of the specified Access Grants instance."},"AccessGrantsInstanceId":{"Type":4,"Flags":2,"Description":"A unique identifier for the specified access grants instance."},"IdentityCenterArn":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) of the specified AWS Identity Center."},"Tags":{"Type":20,"Flags":4}}}},{"3":{"ItemType":18}},{"2":{"Name":"AWS.S3/AccessGrantsInstance","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":19,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.S3/AccessGrantsInstance@default","ScopeType":0,"Body":21}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.S3/AccessGrantsLocationProperties","Properties":{"AccessGrantsLocationArn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) of the specified Access Grants location."},"AccessGrantsLocationId":{"Type":4,"Flags":18,"Description":"The unique identifier for the specified Access Grants location."},"IamRoleArn":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) of the access grant location's associated IAM role."},"LocationScope":{"Type":4,"Flags":0,"Description":"Descriptor for where the location actually points"},"Tags":{"Type":25,"Flags":4}}}},{"3":{"ItemType":23}},{"2":{"Name":"AWS.S3/AccessGrantsLocation","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":24,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.S3/AccessGrantsLocation@default","ScopeType":0,"Body":26}},{"2":{"Name":"Arn"}},{"2":{"Name":"PublicAccessBlockConfiguration","Properties":{"BlockPublicAcls":{"Type":2,"Flags":0,"Description":"Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in this account. Setting this element to TRUE causes the following behavior:\n- 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."},"BlockPublicPolicy":{"Type":2,"Flags":0,"Description":"Specifies whether Amazon S3 should block public bucket policies for buckets in this account. Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access. Enabling this setting doesn't affect existing bucket policies."},"IgnorePublicAcls":{"Type":2,"Flags":0,"Description":"Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on buckets in this account and any objects that they contain. Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set."},"RestrictPublicBuckets":{"Type":2,"Flags":0,"Description":"Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting this element to TRUE restricts access to this bucket to only AWS services and authorized 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 cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked."}}}},{"2":{"Name":"VpcConfiguration","Properties":{"VpcId":{"Type":4,"Flags":0,"Description":"If this field is specified, this access point will only allow connections from the specified VPC ID."}}}},{"2":{"Name":"AWS.S3/AccessPointProperties","Properties":{"Alias":{"Type":4,"Flags":2,"Description":"The alias of this Access Point. This alias can be used for compatibility purposes with other AWS services and third-party applications."},"Arn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) of the specified accesspoint."},"Bucket":{"Type":4,"Flags":1,"Description":"The name of the bucket that you want to associate this Access Point with."},"BucketAccountId":{"Type":4,"Flags":0,"Description":"The AWS account ID associated with the S3 bucket associated with this access point."},"Name":{"Type":4,"Flags":16,"Description":"The name you want to assign to this Access Point. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the access point name."},"NetworkOrigin":{"Type":4,"Flags":2,"Description":"Indicates whether this Access Point allows access from the public Internet. If VpcConfiguration is specified for this Access Point, then NetworkOrigin is VPC, and the Access Point doesn't allow access from the public Internet. Otherwise, NetworkOrigin is Internet, and the Access Point allows access from the public Internet, subject to the Access Point and bucket access policies."},"Policy":{"Type":32,"Flags":0,"Description":"The Access Point Policy you want to apply to this access point."},"PublicAccessBlockConfiguration":{"Type":29,"Flags":0,"Description":"The PublicAccessBlock configuration that you want to apply to this Access Point. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status 'The Meaning of Public' in the Amazon Simple Storage Service Developer Guide."},"VpcConfiguration":{"Type":30,"Flags":0,"Description":"If you include this field, Amazon S3 restricts access to this Access Point to requests from the specified Virtual Private Cloud (VPC)."}}}},{"2":{"Name":"AccessPoint_Policy","Properties":{}}},{"2":{"Name":"AWS.S3/AccessPoint","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":31,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.S3/AccessPoint@default","ScopeType":0,"Body":33}},{"2":{"Name":"AbortIncompleteMultipartUpload","Properties":{"DaysAfterInitiation":{"Type":3,"Flags":1,"Description":"Specifies the number of days after which Amazon S3 aborts an incomplete multipart upload."}}}},{"2":{"Name":"AccelerateConfiguration","Properties":{"AccelerationStatus":{"Type":4,"Flags":1,"Description":"Configures the transfer acceleration state for an Amazon S3 bucket."}}}},{"2":{"Name":"AccessControlTranslation","Properties":{"Owner":{"Type":4,"Flags":1}}}},{"2":{"Name":"AnalyticsConfiguration","Properties":{"Id":{"Type":4,"Flags":1,"Description":"The ID that identifies the analytics configuration."},"Prefix":{"Type":4,"Flags":0,"Description":"The prefix that an object must have to be included in the analytics results."},"StorageClassAnalysis":{"Type":86,"Flags":1},"TagFilters":{"Type":96,"Flags":0}}}},{"2":{"Name":"Arn"}},{"2":{"Name":"BucketEncryption","Properties":{"ServerSideEncryptionConfiguration":{"Type":97,"Flags":1,"Description":"Specifies the default server-side-encryption configuration."}}}},{"2":{"Name":"CorsConfiguration","Properties":{"CorsRules":{"Type":98,"Flags":1}}}},{"2":{"Name":"CorsRule","Properties":{"AllowedHeaders":{"Type":99,"Flags":0,"Description":"Headers that are specified in the Access-Control-Request-Headers header."},"AllowedMethods":{"Type":100,"Flags":1,"Description":"An HTTP method that you allow the origin to execute."},"AllowedOrigins":{"Type":101,"Flags":1,"Description":"One or more origins you want customers to be able to access the bucket from."},"ExposedHeaders":{"Type":102,"Flags":0,"Description":"One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object)."},"Id":{"Type":4,"Flags":0,"Description":"A unique identifier for this rule."},"MaxAge":{"Type":3,"Flags":0,"Description":"The time in seconds that your browser is to cache the preflight response for the specified resource."}}}},{"2":{"Name":"DataExport","Properties":{"Destination":{"Type":46,"Flags":1},"OutputSchemaVersion":{"Type":4,"Flags":1,"Description":"The version of the output schema to use when exporting data."}}}},{"2":{"Name":"DefaultRetention","Properties":{"Days":{"Type":3,"Flags":0},"Mode":{"Type":4,"Flags":0},"Years":{"Type":3,"Flags":0}}}},{"2":{"Name":"DeleteMarkerReplication","Properties":{"Status":{"Type":4,"Flags":0}}}},{"2":{"Name":"Destination","Properties":{"BucketAccountId":{"Type":4,"Flags":0,"Description":"The account ID that owns the destination S3 bucket. "},"BucketArn":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) of the bucket to which data is exported."},"Format":{"Type":4,"Flags":1,"Description":"Specifies the file format used when exporting data to Amazon S3."},"Prefix":{"Type":4,"Flags":0,"Description":"The prefix to use when exporting data. The prefix is prepended to all results."}}}},{"2":{"Name":"EncryptionConfiguration","Properties":{"ReplicaKmsKeyID":{"Type":4,"Flags":1,"Description":"Specifies the ID (Key ARN or Alias ARN) of the customer managed customer master key (CMK) stored in AWS Key Management Service (KMS) for the destination bucket."}}}},{"2":{"Name":"EventBridgeConfiguration","Properties":{"EventBridgeEnabled":{"Type":2,"Flags":1,"Description":"Specifies whether to send notifications to Amazon EventBridge when events occur in an Amazon S3 bucket."}}}},{"2":{"Name":"FilterRule","Properties":{"Name":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"IntelligentTieringConfiguration","Properties":{"Id":{"Type":4,"Flags":1,"Description":"The ID used to identify the S3 Intelligent-Tiering configuration."},"Prefix":{"Type":4,"Flags":0,"Description":"An object key name prefix that identifies the subset of objects to which the rule applies."},"Status":{"Type":4,"Flags":1,"Description":"Specifies the status of the configuration."},"TagFilters":{"Type":103,"Flags":0,"Description":"A container for a key-value pair."},"Tierings":{"Type":104,"Flags":1,"Description":"Specifies a list of S3 Intelligent-Tiering storage class tiers in the configuration. At least one tier must be defined in the list. At most, you can specify two tiers in the list, one for each available AccessTier: ARCHIVE_ACCESS and DEEP_ARCHIVE_ACCESS."}}}},{"2":{"Name":"InventoryConfiguration","Properties":{"Destination":{"Type":46,"Flags":1},"Enabled":{"Type":2,"Flags":1,"Description":"Specifies whether the inventory is enabled or disabled."},"Id":{"Type":4,"Flags":1,"Description":"The ID used to identify the inventory configuration."},"IncludedObjectVersions":{"Type":4,"Flags":1,"Description":"Object versions to include in the inventory list."},"OptionalFields":{"Type":105,"Flags":0,"Description":"Contains the optional fields that are included in the inventory results."},"Prefix":{"Type":4,"Flags":0,"Description":"The prefix that is prepended to all inventory results."},"ScheduleFrequency":{"Type":4,"Flags":1,"Description":"Specifies the schedule for generating inventory results."}}}},{"2":{"Name":"LambdaConfiguration","Properties":{"Event":{"Type":4,"Flags":1,"Description":"The Amazon S3 bucket event for which to invoke the AWS Lambda function."},"Filter":{"Type":60,"Flags":0,"Description":"The filtering rules that determine which objects invoke the AWS Lambda function."},"Function":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) of the AWS Lambda function that Amazon S3 invokes when the specified event type occurs."}}}},{"2":{"Name":"LifecycleConfiguration","Properties":{"Rules":{"Type":106,"Flags":5,"Description":"A lifecycle rule for individual objects in an Amazon S3 bucket."}}}},{"2":{"Name":"LoggingConfiguration","Properties":{"DestinationBucketName":{"Type":4,"Flags":0,"Description":"The name of an Amazon S3 bucket where Amazon S3 store server access log files. You can store log files in any bucket that you own. By default, logs are stored in the bucket where the LoggingConfiguration property is defined."},"LogFilePrefix":{"Type":4,"Flags":0},"TargetObjectKeyFormat":{"Type":89,"Flags":0}}}},{"2":{"Name":"Metrics","Properties":{"EventThreshold":{"Type":77,"Flags":0},"Status":{"Type":4,"Flags":1}}}},{"2":{"Name":"MetricsConfiguration","Properties":{"AccessPointArn":{"Type":4,"Flags":0},"Id":{"Type":4,"Flags":1},"Prefix":{"Type":4,"Flags":0},"TagFilters":{"Type":107,"Flags":0}}}},{"2":{"Name":"NoncurrentVersionExpiration","Properties":{"NewerNoncurrentVersions":{"Type":3,"Flags":0,"Description":"Specified the number of newer noncurrent and current versions that must exists before performing the associated action"},"NoncurrentDays":{"Type":3,"Flags":1,"Description":"Specified the number of days an object is noncurrent before Amazon S3 can perform the associated action"}}}},{"2":{"Name":"NoncurrentVersionTransition","Properties":{"NewerNoncurrentVersions":{"Type":3,"Flags":0,"Description":"Specified the number of newer noncurrent and current versions that must exists before performing the associated action"},"StorageClass":{"Type":4,"Flags":1,"Description":"The class of storage used to store the object."},"TransitionInDays":{"Type":3,"Flags":1,"Description":"Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action."}}}},{"2":{"Name":"NotificationConfiguration","Properties":{"EventBridgeConfiguration":{"Type":48,"Flags":0},"LambdaConfigurations":{"Type":108,"Flags":0},"QueueConfigurations":{"Type":109,"Flags":0},"TopicConfigurations":{"Type":110,"Flags":0}}}},{"2":{"Name":"NotificationFilter","Properties":{"S3Key":{"Type":81,"Flags":1}}}},{"2":{"Name":"ObjectLockConfiguration","Properties":{"ObjectLockEnabled":{"Type":4,"Flags":0},"Rule":{"Type":62,"Flags":0}}}},{"2":{"Name":"ObjectLockRule","Properties":{"DefaultRetention":{"Type":44,"Flags":0}}}},{"2":{"Name":"OwnershipControls","Properties":{"Rules":{"Type":111,"Flags":1}}}},{"2":{"Name":"OwnershipControlsRule","Properties":{"ObjectOwnership":{"Type":4,"Flags":0,"Description":"Specifies an object ownership rule."}}}},{"2":{"Name":"PartitionedPrefix","Properties":{"PartitionDateSource":{"Type":4,"Flags":0,"Description":"Date Source for creating a partitioned prefix. This can be event time or delivery time."}}}},{"2":{"Name":"PublicAccessBlockConfiguration","Properties":{"BlockPublicAcls":{"Type":2,"Flags":0,"Description":"Specifies whether Amazon S3 should block public access control lists (ACLs) for this bucket and objects in this bucket. Setting this element to TRUE causes the following behavior:\n- PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public.\n - PUT Object calls fail if the request includes a public ACL.\nEnabling this setting doesn't affect existing policies or ACLs."},"BlockPublicPolicy":{"Type":2,"Flags":0,"Description":"Specifies whether Amazon S3 should block public bucket policies for this bucket. Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access.\nEnabling this setting doesn't affect existing bucket policies."},"IgnorePublicAcls":{"Type":2,"Flags":0,"Description":"Specifies whether Amazon S3 should ignore public ACLs for this bucket and objects in this bucket. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on this bucket and objects in this bucket.\nEnabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set."},"RestrictPublicBuckets":{"Type":2,"Flags":0,"Description":"Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting this element to TRUE restricts access to this bucket to only AWS services and authorized 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 cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked."}}}},{"2":{"Name":"QueueConfiguration","Properties":{"Event":{"Type":4,"Flags":1,"Description":"The Amazon S3 bucket event about which you want to publish messages to Amazon SQS."},"Filter":{"Type":60,"Flags":0,"Description":"The filtering rules that determine which objects trigger notifications."},"Queue":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) of the Amazon SQS queue to which Amazon S3 publishes a message when it detects events of the specified type."}}}},{"2":{"Name":"RedirectAllRequestsTo","Properties":{"HostName":{"Type":4,"Flags":1,"Description":"Name of the host where requests are redirected."},"Protocol":{"Type":4,"Flags":0,"Description":"Protocol to use when redirecting requests. The default is the protocol that is used in the original request."}}}},{"2":{"Name":"RedirectRule","Properties":{"HostName":{"Type":4,"Flags":0,"Description":"The host name to use in the redirect request."},"HttpRedirectCode":{"Type":4,"Flags":0,"Description":"The HTTP redirect code to use on the response. Not required if one of the siblings is present."},"Protocol":{"Type":4,"Flags":0,"Description":"Protocol to use when redirecting requests. The default is the protocol that is used in the original request."},"ReplaceKeyPrefixWith":{"Type":4,"Flags":0,"Description":"The object key prefix to use in the redirect request."},"ReplaceKeyWith":{"Type":4,"Flags":0,"Description":"The specific object key to use in the redirect request.d"}}}},{"2":{"Name":"ReplicaModifications","Properties":{"Status":{"Type":4,"Flags":1,"Description":"Specifies whether Amazon S3 replicates modifications on replicas."}}}},{"2":{"Name":"ReplicationConfiguration","Properties":{"Role":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that Amazon S3 assumes when replicating objects."},"Rules":{"Type":112,"Flags":5,"Description":"A container for one or more replication rules."}}}},{"2":{"Name":"ReplicationDestination","Properties":{"AccessControlTranslation":{"Type":37,"Flags":0},"Account":{"Type":4,"Flags":0},"Bucket":{"Type":4,"Flags":1},"EncryptionConfiguration":{"Type":47,"Flags":0},"Metrics":{"Type":55,"Flags":0},"ReplicationTime":{"Type":76,"Flags":0},"StorageClass":{"Type":4,"Flags":0,"Description":"The storage class to use when replicating objects, such as S3 Standard or reduced redundancy."}}}},{"2":{"Name":"ReplicationRule","Properties":{"DeleteMarkerReplication":{"Type":45,"Flags":0},"Destination":{"Type":72,"Flags":1},"Filter":{"Type":75,"Flags":0},"Id":{"Type":4,"Flags":0,"Description":"A unique identifier for the rule."},"Prefix":{"Type":4,"Flags":0,"Description":"An object key name prefix that identifies the object or objects to which the rule applies."},"Priority":{"Type":3,"Flags":0},"SourceSelectionCriteria":{"Type":84,"Flags":0},"Status":{"Type":4,"Flags":1,"Description":"Specifies whether the rule is enabled."}}}},{"2":{"Name":"ReplicationRuleAndOperator","Properties":{"Prefix":{"Type":4,"Flags":0},"TagFilters":{"Type":113,"Flags":0}}}},{"2":{"Name":"ReplicationRuleFilter","Properties":{"And":{"Type":74,"Flags":0},"Prefix":{"Type":4,"Flags":0},"TagFilter":{"Type":88,"Flags":0}}}},{"2":{"Name":"ReplicationTime","Properties":{"Status":{"Type":4,"Flags":1},"Time":{"Type":77,"Flags":1}}}},{"2":{"Name":"ReplicationTimeValue","Properties":{"Minutes":{"Type":3,"Flags":1}}}},{"2":{"Name":"RoutingRule","Properties":{"RedirectRule":{"Type":69,"Flags":1,"Description":"Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event of an error, you can specify a different error code to return."},"RoutingRuleCondition":{"Type":79,"Flags":0}}}},{"2":{"Name":"RoutingRuleCondition","Properties":{"HttpErrorCodeReturnedEquals":{"Type":4,"Flags":0,"Description":"The HTTP error code when the redirect is applied. "},"KeyPrefixEquals":{"Type":4,"Flags":0,"Description":"The object key name prefix when the redirect is applied."}}}},{"2":{"Name":"Rule","Properties":{"AbortIncompleteMultipartUpload":{"Type":35,"Flags":0},"ExpirationDate":{"Type":4,"Flags":0},"ExpirationInDays":{"Type":3,"Flags":0},"ExpiredObjectDeleteMarker":{"Type":2,"Flags":0},"Id":{"Type":4,"Flags":0},"NoncurrentVersionExpiration":{"Type":57,"Flags":0},"NoncurrentVersionExpirationInDays":{"Type":3,"Flags":0},"NoncurrentVersionTransition":{"Type":58,"Flags":0},"NoncurrentVersionTransitions":{"Type":114,"Flags":0},"ObjectSizeGreaterThan":{"Type":4,"Flags":0},"ObjectSizeLessThan":{"Type":4,"Flags":0},"Prefix":{"Type":4,"Flags":0},"Status":{"Type":4,"Flags":1},"TagFilters":{"Type":115,"Flags":0},"Transition":{"Type":92,"Flags":0},"Transitions":{"Type":116,"Flags":0}}}},{"2":{"Name":"S3KeyFilter","Properties":{"Rules":{"Type":117,"Flags":1}}}},{"2":{"Name":"ServerSideEncryptionByDefault","Properties":{"KMSMasterKeyID":{"Type":4,"Flags":0,"Description":"\"KMSMasterKeyID\" can only be used when you set the value of SSEAlgorithm as aws:kms or aws:kms:dsse."},"SSEAlgorithm":{"Type":4,"Flags":1}}}},{"2":{"Name":"ServerSideEncryptionRule","Properties":{"BucketKeyEnabled":{"Type":2,"Flags":0,"Description":"Specifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS (SSE-KMS) for new objects in the bucket. Existing objects are not affected. Setting the BucketKeyEnabled element to true causes Amazon S3 to use an S3 Bucket Key. By default, S3 Bucket Key is not enabled."},"ServerSideEncryptionByDefault":{"Type":82,"Flags":0}}}},{"2":{"Name":"SourceSelectionCriteria","Properties":{"ReplicaModifications":{"Type":70,"Flags":0,"Description":"A filter that you can specify for selection for modifications on replicas."},"SseKmsEncryptedObjects":{"Type":85,"Flags":0,"Description":"A container for filter information for the selection of Amazon S3 objects encrypted with AWS KMS."}}}},{"2":{"Name":"SseKmsEncryptedObjects","Properties":{"Status":{"Type":4,"Flags":1,"Description":"Specifies whether Amazon S3 replicates objects created with server-side encryption using a customer master key (CMK) stored in AWS Key Management Service."}}}},{"2":{"Name":"StorageClassAnalysis","Properties":{"DataExport":{"Type":43,"Flags":0}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"TagFilter","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"TargetObjectKeyFormat","Properties":{}}},{"2":{"Name":"Tiering","Properties":{"AccessTier":{"Type":4,"Flags":1,"Description":"S3 Intelligent-Tiering access tier. See Storage class for automatically optimizing frequently and infrequently accessed objects for a list of access tiers in the S3 Intelligent-Tiering storage class."},"Days":{"Type":3,"Flags":1,"Description":"The number of consecutive days of no access after which an object will be eligible to be transitioned to the corresponding tier. The minimum number of days specified for Archive Access tier must be at least 90 days and Deep Archive Access tier must be at least 180 days. The maximum can be up to 2 years (730 days)."}}}},{"2":{"Name":"TopicConfiguration","Properties":{"Event":{"Type":4,"Flags":1,"Description":"The Amazon S3 bucket event about which to send notifications."},"Filter":{"Type":60,"Flags":0,"Description":"The filtering rules that determine for which objects to send notifications."},"Topic":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) of the Amazon SNS topic to which Amazon S3 publishes a message when it detects events of the specified type."}}}},{"2":{"Name":"Transition","Properties":{"StorageClass":{"Type":4,"Flags":1},"TransitionDate":{"Type":4,"Flags":0},"TransitionInDays":{"Type":3,"Flags":0}}}},{"2":{"Name":"VersioningConfiguration","Properties":{"Status":{"Type":4,"Flags":1,"Description":"The versioning state of the bucket."}}}},{"2":{"Name":"WebsiteConfiguration","Properties":{"ErrorDocument":{"Type":4,"Flags":0,"Description":"The name of the error document for the website."},"IndexDocument":{"Type":4,"Flags":0,"Description":"The name of the index document for the website."},"RedirectAllRequestsTo":{"Type":68,"Flags":0},"RoutingRules":{"Type":118,"Flags":0}}}},{"2":{"Name":"iso8601UTC"}},{"3":{"ItemType":88}},{"3":{"ItemType":83}},{"3":{"ItemType":42}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":88}},{"3":{"ItemType":90}},{"3":{"ItemType":4}},{"3":{"ItemType":80}},{"3":{"ItemType":88}},{"3":{"ItemType":52}},{"3":{"ItemType":67}},{"3":{"ItemType":91}},{"3":{"ItemType":64}},{"3":{"ItemType":73}},{"3":{"ItemType":88}},{"3":{"ItemType":58}},{"3":{"ItemType":88}},{"3":{"ItemType":92}},{"3":{"ItemType":49}},{"3":{"ItemType":78}},{"2":{"Name":"AWS.S3/BucketProperties","Properties":{"AccelerateConfiguration":{"Type":36,"Flags":0,"Description":"Configuration for the transfer acceleration state."},"AccessControl":{"Type":4,"Flags":4,"Description":"A canned access control list (ACL) that grants predefined permissions to the bucket."},"AnalyticsConfigurations":{"Type":120,"Flags":0,"Description":"The configuration and any analyses for the analytics filter of an Amazon S3 bucket."},"Arn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) of the specified bucket."},"BucketEncryption":{"Type":40,"Flags":0},"BucketName":{"Type":4,"Flags":16,"Description":"A name for the bucket. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name."},"CorsConfiguration":{"Type":41,"Flags":0,"Description":"Rules that define cross-origin resource sharing of objects in this bucket."},"DomainName":{"Type":4,"Flags":2,"Description":"The IPv4 DNS name of the specified bucket."},"DualStackDomainName":{"Type":4,"Flags":2,"Description":"The IPv6 DNS name of the specified bucket. For more information about dual-stack endpoints, see [Using Amazon S3 Dual-Stack Endpoints](https://docs.aws.amazon.com/AmazonS3/latest/dev/dual-stack-endpoints.html)."},"IntelligentTieringConfigurations":{"Type":121,"Flags":0,"Description":"Specifies the S3 Intelligent-Tiering configuration for an Amazon S3 bucket."},"InventoryConfigurations":{"Type":122,"Flags":0,"Description":"The inventory configuration for an Amazon S3 bucket."},"LifecycleConfiguration":{"Type":53,"Flags":0,"Description":"Rules that define how Amazon S3 manages objects during their lifetime."},"LoggingConfiguration":{"Type":54,"Flags":0,"Description":"Settings that define where logs are stored."},"MetricsConfigurations":{"Type":123,"Flags":0,"Description":"Settings that define a metrics configuration for the CloudWatch request metrics from the bucket."},"NotificationConfiguration":{"Type":59,"Flags":0,"Description":"Configuration that defines how Amazon S3 handles bucket notifications."},"ObjectLockConfiguration":{"Type":61,"Flags":0,"Description":"Places an Object Lock configuration on the specified bucket."},"ObjectLockEnabled":{"Type":2,"Flags":0,"Description":"Indicates whether this bucket has an Object Lock configuration enabled."},"OwnershipControls":{"Type":63,"Flags":0,"Description":"Specifies the container element for object ownership rules."},"PublicAccessBlockConfiguration":{"Type":66,"Flags":0},"RegionalDomainName":{"Type":4,"Flags":2,"Description":"Returns the regional domain name of the specified bucket."},"ReplicationConfiguration":{"Type":71,"Flags":0,"Description":"Configuration for replicating objects in an S3 bucket."},"Tags":{"Type":124,"Flags":0,"Description":"An arbitrary set of tags (key-value pairs) for this S3 bucket."},"VersioningConfiguration":{"Type":93,"Flags":0},"WebsiteConfiguration":{"Type":94,"Flags":0},"WebsiteURL":{"Type":4,"Flags":2,"Description":"The Amazon S3 website endpoint for the specified bucket."}}}},{"3":{"ItemType":38}},{"3":{"ItemType":50}},{"3":{"ItemType":51}},{"3":{"ItemType":56}},{"3":{"ItemType":87}},{"2":{"Name":"AWS.S3/Bucket","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":119,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.S3/Bucket@default","ScopeType":0,"Body":125}},{"2":{"Name":"AWS.S3/BucketPolicyProperties","Properties":{"Bucket":{"Type":4,"Flags":17,"Description":"The name of the Amazon S3 bucket to which the policy applies."},"PolicyDocument":{"Type":129,"Flags":1,"Description":"A policy document containing permissions to add to the specified 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."}}}},{"2":{"Name":"BucketPolicy_PolicyDocument","Properties":{}}},{"5":{"Elements":[128,4]}},{"2":{"Name":"AWS.S3/BucketPolicy","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":127,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.S3/BucketPolicy@default","ScopeType":0,"Body":130}},{"2":{"Name":"AWS.S3/MultiRegionAccessPointPolicyProperties","Properties":{"MrapName":{"Type":4,"Flags":17,"Description":"The name of the Multi Region Access Point to apply policy"},"Policy":{"Type":133,"Flags":1,"Description":"Policy document to apply to a Multi Region Access Point"},"PolicyStatus":{"Type":134,"Flags":2,"Description":"The Policy Status associated with this Multi Region Access Point"}}}},{"2":{"Name":"MultiRegionAccessPointPolicy_Policy","Properties":{}}},{"2":{"Name":"MultiRegionAccessPointPolicy_PolicyStatus","Properties":{"IsPublic":{"Type":4,"Flags":3,"Description":"Specifies whether the policy is public or not."}}}},{"2":{"Name":"AWS.S3/MultiRegionAccessPointPolicy","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":132,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.S3/MultiRegionAccessPointPolicy@default","ScopeType":0,"Body":135}},{"2":{"Name":"AccountLevel","Properties":{"ActivityMetrics":{"Type":138,"Flags":0},"AdvancedCostOptimizationMetrics":{"Type":139,"Flags":0},"AdvancedDataProtectionMetrics":{"Type":140,"Flags":0},"BucketLevel":{"Type":143,"Flags":1},"DetailedStatusCodesMetrics":{"Type":147,"Flags":0},"StorageLensGroupLevel":{"Type":157,"Flags":0}}}},{"2":{"Name":"ActivityMetrics","Properties":{"IsEnabled":{"Type":2,"Flags":0,"Description":"Specifies whether activity metrics are enabled or disabled."}}}},{"2":{"Name":"AdvancedCostOptimizationMetrics","Properties":{"IsEnabled":{"Type":2,"Flags":0,"Description":"Specifies whether advanced cost optimization metrics are enabled or disabled."}}}},{"2":{"Name":"AdvancedDataProtectionMetrics","Properties":{"IsEnabled":{"Type":2,"Flags":0,"Description":"Specifies whether advanced data protection metrics are enabled or disabled."}}}},{"2":{"Name":"Arn"}},{"2":{"Name":"AwsOrg","Properties":{"Arn":{"Type":4,"Flags":1}}}},{"2":{"Name":"BucketLevel","Properties":{"ActivityMetrics":{"Type":138,"Flags":0},"AdvancedCostOptimizationMetrics":{"Type":139,"Flags":0},"AdvancedDataProtectionMetrics":{"Type":140,"Flags":0},"DetailedStatusCodesMetrics":{"Type":147,"Flags":0},"PrefixLevel":{"Type":150,"Flags":0}}}},{"2":{"Name":"BucketsAndRegions","Properties":{"Buckets":{"Type":160,"Flags":0},"Regions":{"Type":161,"Flags":0}}}},{"2":{"Name":"CloudWatchMetrics","Properties":{"IsEnabled":{"Type":2,"Flags":1,"Description":"Specifies whether CloudWatch metrics are enabled or disabled."}}}},{"2":{"Name":"DataExport","Properties":{"CloudWatchMetrics":{"Type":145,"Flags":0},"S3BucketDestination":{"Type":152,"Flags":0}}}},{"2":{"Name":"DetailedStatusCodesMetrics","Properties":{"IsEnabled":{"Type":2,"Flags":0,"Description":"Specifies whether detailed status codes metrics are enabled or disabled."}}}},{"2":{"Name":"Encryption","Properties":{}}},{"2":{"Name":"Id"}},{"2":{"Name":"PrefixLevel","Properties":{"StorageMetrics":{"Type":151,"Flags":1}}}},{"2":{"Name":"PrefixLevelStorageMetrics","Properties":{"IsEnabled":{"Type":2,"Flags":0,"Description":"Specifies whether prefix-level storage metrics are enabled or disabled."},"SelectionCriteria":{"Type":154,"Flags":0}}}},{"2":{"Name":"S3BucketDestination","Properties":{"AccountId":{"Type":4,"Flags":1,"Description":"The AWS account ID that owns the destination S3 bucket."},"Arn":{"Type":4,"Flags":1,"Description":"The ARN of the bucket to which Amazon S3 Storage Lens exports will be placed."},"Encryption":{"Type":148,"Flags":0},"Format":{"Type":4,"Flags":1,"Description":"Specifies the file format to use when exporting Amazon S3 Storage Lens metrics export."},"OutputSchemaVersion":{"Type":4,"Flags":1,"Description":"The version of the output schema to use when exporting Amazon S3 Storage Lens metrics."},"Prefix":{"Type":4,"Flags":0,"Description":"The prefix to use for Amazon S3 Storage Lens export."}}}},{"2":{"Name":"SSEKMS","Properties":{"KeyId":{"Type":4,"Flags":1,"Description":"The ARN of the KMS key to use for encryption."}}}},{"2":{"Name":"SelectionCriteria","Properties":{"Delimiter":{"Type":4,"Flags":0,"Description":"Delimiter to divide S3 key into hierarchy of prefixes."},"MaxDepth":{"Type":3,"Flags":0,"Description":"Max depth of prefixes of S3 key that Amazon S3 Storage Lens will analyze."},"MinStorageBytesPercentage":{"Type":3,"Flags":0,"Description":"The minimum storage bytes threshold for the prefixes to be included in the analysis."}}}},{"2":{"Name":"StorageLensConfiguration","Properties":{"AccountLevel":{"Type":137,"Flags":1},"AwsOrg":{"Type":142,"Flags":0},"DataExport":{"Type":146,"Flags":0},"Exclude":{"Type":144,"Flags":0},"Id":{"Type":4,"Flags":1},"Include":{"Type":144,"Flags":0},"IsEnabled":{"Type":2,"Flags":1,"Description":"Specifies whether the Amazon S3 Storage Lens configuration is enabled or disabled."},"StorageLensArn":{"Type":4,"Flags":2,"Description":"The ARN for the Amazon S3 Storage Lens configuration."}}}},{"2":{"Name":"StorageLensGroupArn"}},{"2":{"Name":"StorageLensGroupLevel","Properties":{"StorageLensGroupSelectionCriteria":{"Type":158,"Flags":0}}}},{"2":{"Name":"StorageLensGroupSelectionCriteria","Properties":{"Exclude":{"Type":162,"Flags":0},"Include":{"Type":163,"Flags":0}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.S3/StorageLensProperties","Properties":{"StorageLensConfiguration":{"Type":155,"Flags":1},"Tags":{"Type":165,"Flags":0,"Description":"A set of tags (key-value pairs) for this Amazon S3 Storage Lens configuration."}}}},{"3":{"ItemType":159}},{"2":{"Name":"AWS.S3/StorageLens","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":164,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.S3/StorageLens@default","ScopeType":0,"Body":166}},{"2":{"Name":"And","Properties":{"MatchAnyPrefix":{"Type":178,"Flags":0},"MatchAnySuffix":{"Type":179,"Flags":0},"MatchAnyTag":{"Type":180,"Flags":0},"MatchObjectAge":{"Type":173,"Flags":0},"MatchObjectSize":{"Type":174,"Flags":0}}}},{"2":{"Name":"Filter","Properties":{"And":{"Type":168,"Flags":0},"MatchAnyPrefix":{"Type":181,"Flags":0},"MatchAnySuffix":{"Type":182,"Flags":0},"MatchAnyTag":{"Type":183,"Flags":0},"MatchObjectAge":{"Type":173,"Flags":0},"MatchObjectSize":{"Type":174,"Flags":0},"Or":{"Type":176,"Flags":0}}}},{"2":{"Name":"MatchAnyPrefix"}},{"2":{"Name":"MatchAnySuffix"}},{"2":{"Name":"MatchAnyTag"}},{"2":{"Name":"MatchObjectAge","Properties":{"DaysGreaterThan":{"Type":3,"Flags":0,"Description":"Minimum object age to which the rule applies."},"DaysLessThan":{"Type":3,"Flags":0,"Description":"Maximum object age to which the rule applies."}}}},{"2":{"Name":"MatchObjectSize","Properties":{"BytesGreaterThan":{"Type":3,"Flags":0,"Description":"Minimum object size to which the rule applies."},"BytesLessThan":{"Type":3,"Flags":0,"Description":"Maximum object size to which the rule applies."}}}},{"2":{"Name":"Name"}},{"2":{"Name":"Or","Properties":{"MatchAnyPrefix":{"Type":187,"Flags":0},"MatchAnySuffix":{"Type":188,"Flags":0},"MatchAnyTag":{"Type":189,"Flags":0},"MatchObjectAge":{"Type":173,"Flags":0},"MatchObjectSize":{"Type":174,"Flags":0}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":177}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":177}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":177}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":177}},{"2":{"Name":"AWS.S3/StorageLensGroupProperties","Properties":{"Filter":{"Type":169,"Flags":1},"Name":{"Type":4,"Flags":17},"StorageLensGroupArn":{"Type":4,"Flags":2,"Description":"The ARN for the Amazon S3 Storage Lens Group."},"Tags":{"Type":191,"Flags":0,"Description":"A set of tags (key-value pairs) for this Amazon S3 Storage Lens Group."}}}},{"3":{"ItemType":177}},{"2":{"Name":"AWS.S3/StorageLensGroup","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":190,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.S3/StorageLensGroup@default","ScopeType":0,"Body":192}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "AccessGrantArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AccessGrantsLocationConfiguration", + "properties": { + "S3SubPrefix": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The S3 sub prefix of a registered location in your S3 Access Grants instance" + } + } + }, + { + "$type": "ObjectType", + "name": "Grantee", + "properties": { + "GranteeIdentifier": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The unique identifier of the Grantee" + }, + "GranteeType": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "Configures the transfer acceleration state for an Amazon S3 bucket." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.S3/AccessGrantProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ObjectType", + "name": "AWS.S3/AccessGrantProperties", + "properties": { + "AccessGrantArn": { + "type": { + "$ref": "#/4" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) of the specified access grant." + }, + "AccessGrantId": { + "type": { + "$ref": "#/4" + }, + "flags": 18, + "description": "The ID assigned to this access grant." + }, + "AccessGrantsLocationConfiguration": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The configuration options of the grant location, which is the S3 path to the data to which you are granting access." + }, + "AccessGrantsLocationId": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The custom S3 location to be accessed by the grantee" + }, + "ApplicationArn": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The ARN of the application grantees will use to access the location" + }, + "GrantScope": { + "type": { + "$ref": "#/4" + }, + "flags": 2, + "description": "The S3 path of the data to which you are granting access. It is a combination of the S3 path of the registered location and the subprefix." + }, + "Grantee": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The principal who will be granted permission to access S3." + }, + "Permission": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The level of access to be afforded to the grantee" + }, + "S3PrefixType": { + "type": { + "$ref": "#/4" + }, + "flags": 4, + "description": "The type of S3SubPrefix." + }, + "Tags": { + "type": { + "$ref": "#/6" + }, + "flags": 4 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.S3/AccessGrant", + "properties": { + "name": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/7" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.S3/AccessGrant@default", + "scopeType": 0, + "body": { + "$ref": "#/8" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AccessGrantsInstanceArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "IdentityCenterArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.S3/AccessGrantsInstanceProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/12" + } + }, + { + "$type": "ObjectType", + "name": "AWS.S3/AccessGrantsInstanceProperties", + "properties": { + "AccessGrantsInstanceArn": { + "type": { + "$ref": "#/4" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) of the specified Access Grants instance." + }, + "AccessGrantsInstanceId": { + "type": { + "$ref": "#/4" + }, + "flags": 2, + "description": "A unique identifier for the specified access grants instance." + }, + "IdentityCenterArn": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the specified AWS Identity Center." + }, + "Tags": { + "type": { + "$ref": "#/14" + }, + "flags": 4 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.S3/AccessGrantsInstance", + "properties": { + "name": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/15" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.S3/AccessGrantsInstance@default", + "scopeType": 0, + "body": { + "$ref": "#/16" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.S3/AccessGrantsLocationProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/18" + } + }, + { + "$type": "ObjectType", + "name": "AWS.S3/AccessGrantsLocationProperties", + "properties": { + "AccessGrantsLocationArn": { + "type": { + "$ref": "#/4" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) of the specified Access Grants location." + }, + "AccessGrantsLocationId": { + "type": { + "$ref": "#/4" + }, + "flags": 18, + "description": "The unique identifier for the specified Access Grants location." + }, + "IamRoleArn": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the access grant location's associated IAM role." + }, + "LocationScope": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Descriptor for where the location actually points" + }, + "Tags": { + "type": { + "$ref": "#/20" + }, + "flags": 4 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.S3/AccessGrantsLocation", + "properties": { + "name": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/21" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.S3/AccessGrantsLocation@default", + "scopeType": 0, + "body": { + "$ref": "#/22" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Arn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PublicAccessBlockConfiguration", + "properties": { + "BlockPublicAcls": { + "type": { + "$ref": "#/27" + }, + "flags": 0, + "description": "Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in this account. Setting this element to TRUE causes the following behavior:\n- 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." + }, + "BlockPublicPolicy": { + "type": { + "$ref": "#/27" + }, + "flags": 0, + "description": "Specifies whether Amazon S3 should block public bucket policies for buckets in this account. Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access. Enabling this setting doesn't affect existing bucket policies." + }, + "IgnorePublicAcls": { + "type": { + "$ref": "#/27" + }, + "flags": 0, + "description": "Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on buckets in this account and any objects that they contain. Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set." + }, + "RestrictPublicBuckets": { + "type": { + "$ref": "#/27" + }, + "flags": 0, + "description": "Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting this element to TRUE restricts access to this bucket to only AWS services and authorized 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 cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked." + } + } + }, + { + "$type": "ObjectType", + "name": "VpcConfiguration", + "properties": { + "VpcId": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "If this field is specified, this access point will only allow connections from the specified VPC ID." + } + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.S3/AccessPointProperties" + }, + { + "$type": "ObjectType", + "name": "AccessPoint_Policy", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AWS.S3/AccessPointProperties", + "properties": { + "Alias": { + "type": { + "$ref": "#/4" + }, + "flags": 2, + "description": "The alias of this Access Point. This alias can be used for compatibility purposes with other AWS services and third-party applications." + }, + "Arn": { + "type": { + "$ref": "#/4" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) of the specified accesspoint." + }, + "Bucket": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The name of the bucket that you want to associate this Access Point with." + }, + "BucketAccountId": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The AWS account ID associated with the S3 bucket associated with this access point." + }, + "Name": { + "type": { + "$ref": "#/4" + }, + "flags": 16, + "description": "The name you want to assign to this Access Point. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the access point name." + }, + "NetworkOrigin": { + "type": { + "$ref": "#/4" + }, + "flags": 2, + "description": "Indicates whether this Access Point allows access from the public Internet. If VpcConfiguration is specified for this Access Point, then NetworkOrigin is VPC, and the Access Point doesn't allow access from the public Internet. Otherwise, NetworkOrigin is Internet, and the Access Point allows access from the public Internet, subject to the Access Point and bucket access policies." + }, + "Policy": { + "type": { + "$ref": "#/29" + }, + "flags": 0, + "description": "The Access Point Policy you want to apply to this access point." + }, + "PublicAccessBlockConfiguration": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "The PublicAccessBlock configuration that you want to apply to this Access Point. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status 'The Meaning of Public' in the Amazon Simple Storage Service Developer Guide." + }, + "VpcConfiguration": { + "type": { + "$ref": "#/26" + }, + "flags": 0, + "description": "If you include this field, Amazon S3 restricts access to this Access Point to requests from the specified Virtual Private Cloud (VPC)." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.S3/AccessPoint", + "properties": { + "name": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/30" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.S3/AccessPoint@default", + "scopeType": 0, + "body": { + "$ref": "#/31" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AbortIncompleteMultipartUpload", + "properties": { + "DaysAfterInitiation": { + "type": { + "$ref": "#/94" + }, + "flags": 1, + "description": "Specifies the number of days after which Amazon S3 stops an incomplete multipart upload." + } + } + }, + { + "$type": "ObjectType", + "name": "AccelerateConfiguration", + "properties": { + "AccelerationStatus": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "Specifies the transfer acceleration status of the bucket." + } + } + }, + { + "$type": "ObjectType", + "name": "AccessControlTranslation", + "properties": { + "Owner": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "Specifies the replica ownership. For default and valid values, see [PUT bucket replication](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTreplication.html) in the *Amazon S3 API Reference*." + } + } + }, + { + "$type": "ObjectType", + "name": "AnalyticsConfiguration", + "properties": { + "Id": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The ID that identifies the analytics configuration." + }, + "Prefix": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The prefix that an object must have to be included in the analytics results." + }, + "StorageClassAnalysis": { + "type": { + "$ref": "#/84" + }, + "flags": 1, + "description": "Contains data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes." + }, + "TagFilters": { + "type": { + "$ref": "#/95" + }, + "flags": 0, + "description": "The tags to use when evaluating an analytics filter.\n The analytics only includes objects that meet the filter's criteria. If no filter is specified, all of the contents of the bucket are included in the analysis." + } + } + }, + { + "$type": "ObjectType", + "name": "Arn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "BucketEncryption", + "properties": { + "ServerSideEncryptionConfiguration": { + "type": { + "$ref": "#/96" + }, + "flags": 1, + "description": "Specifies the default server-side-encryption configuration." + } + } + }, + { + "$type": "ObjectType", + "name": "CorsConfiguration", + "properties": { + "CorsRules": { + "type": { + "$ref": "#/97" + }, + "flags": 1, + "description": "A set of origins and methods (cross-origin access that you want to allow). You can add up to 100 rules to the configuration." + } + } + }, + { + "$type": "ObjectType", + "name": "CorsRule", + "properties": { + "AllowedHeaders": { + "type": { + "$ref": "#/98" + }, + "flags": 0, + "description": "Headers that are specified in the ``Access-Control-Request-Headers`` header. These headers are allowed in a preflight OPTIONS request. In response to any preflight OPTIONS request, Amazon S3 returns any requested headers that are allowed." + }, + "AllowedMethods": { + "type": { + "$ref": "#/99" + }, + "flags": 1, + "description": "An HTTP method that you allow the origin to run.\n *Allowed values*: ``GET`` | ``PUT`` | ``HEAD`` | ``POST`` | ``DELETE``" + }, + "AllowedOrigins": { + "type": { + "$ref": "#/100" + }, + "flags": 1, + "description": "One or more origins you want customers to be able to access the bucket from." + }, + "ExposedHeaders": { + "type": { + "$ref": "#/101" + }, + "flags": 0, + "description": "One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript ``XMLHttpRequest`` object)." + }, + "Id": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "A unique identifier for this rule. The value must be no more than 255 characters." + }, + "MaxAge": { + "type": { + "$ref": "#/94" + }, + "flags": 0, + "description": "The time in seconds that your browser is to cache the preflight response for the specified resource." + } + } + }, + { + "$type": "ObjectType", + "name": "DataExport", + "properties": { + "Destination": { + "type": { + "$ref": "#/44" + }, + "flags": 1, + "description": "The place to store the data for an analysis." + }, + "OutputSchemaVersion": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The version of the output schema to use when exporting data. Must be ``V_1``." + } + } + }, + { + "$type": "ObjectType", + "name": "DefaultRetention", + "properties": { + "Days": { + "type": { + "$ref": "#/94" + }, + "flags": 0, + "description": "The number of days that you want to specify for the default retention period. If Object Lock is turned on, you must specify ``Mode`` and specify either ``Days`` or ``Years``." + }, + "Mode": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The default Object Lock retention mode you want to apply to new objects placed in the specified bucket. If Object Lock is turned on, you must specify ``Mode`` and specify either ``Days`` or ``Years``." + }, + "Years": { + "type": { + "$ref": "#/94" + }, + "flags": 0, + "description": "The number of years that you want to specify for the default retention period. If Object Lock is turned on, you must specify ``Mode`` and specify either ``Days`` or ``Years``." + } + } + }, + { + "$type": "ObjectType", + "name": "DeleteMarkerReplication", + "properties": { + "Status": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Indicates whether to replicate delete markers. Disabled by default." + } + } + }, + { + "$type": "ObjectType", + "name": "Destination", + "properties": { + "BucketAccountId": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The account ID that owns the destination S3 bucket. If no account ID is provided, the owner is not validated before exporting data.\n Although this value is optional, we strongly recommend that you set it to help prevent problems if the destination bucket ownership changes." + }, + "BucketArn": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of the bucket to which data is exported." + }, + "Format": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "Specifies the file format used when exporting data to Amazon S3.\n *Allowed values*: ``CSV`` | ``ORC`` | ``Parquet``" + }, + "Prefix": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The prefix to use when exporting data. The prefix is prepended to all results." + } + } + }, + { + "$type": "ObjectType", + "name": "EncryptionConfiguration", + "properties": { + "ReplicaKmsKeyID": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "Specifies the ID (Key ARN or Alias ARN) of the customer managed AWS KMS key stored in AWS Key Management Service (KMS) for the destination bucket. Amazon S3 uses this key to encrypt replica objects. Amazon S3 only supports symmetric encryption KMS keys. For more information, see [Asymmetric keys in KMS](https://docs.aws.amazon.com//kms/latest/developerguide/symmetric-asymmetric.html) in the *Key Management Service Developer Guide*." + } + } + }, + { + "$type": "ObjectType", + "name": "EventBridgeConfiguration", + "properties": { + "EventBridgeEnabled": { + "type": { + "$ref": "#/27" + }, + "flags": 1, + "description": "Enables delivery of events to Amazon EventBridge." + } + } + }, + { + "$type": "ObjectType", + "name": "FilterRule", + "properties": { + "Name": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The object key name prefix or suffix identifying one or more objects to which the filtering rule applies. The maximum length is 1,024 characters. Overlapping prefixes and suffixes are not supported. For more information, see [Configuring Event Notifications](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the *Amazon S3 User Guide*." + }, + "Value": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The value that the filter searches for in object key names." + } + } + }, + { + "$type": "ObjectType", + "name": "IntelligentTieringConfiguration", + "properties": { + "Id": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The ID used to identify the S3 Intelligent-Tiering configuration." + }, + "Prefix": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "An object key name prefix that identifies the subset of objects to which the rule applies." + }, + "Status": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "Specifies the status of the configuration." + }, + "TagFilters": { + "type": { + "$ref": "#/102" + }, + "flags": 0, + "description": "A container for a key-value pair." + }, + "Tierings": { + "type": { + "$ref": "#/103" + }, + "flags": 1, + "description": "Specifies a list of S3 Intelligent-Tiering storage class tiers in the configuration. At least one tier must be defined in the list. At most, you can specify two tiers in the list, one for each available AccessTier: ``ARCHIVE_ACCESS`` and ``DEEP_ARCHIVE_ACCESS``.\n You only need Intelligent Tiering Configuration enabled on a bucket if you want to automatically move objects stored in the Intelligent-Tiering storage class to Archive Access or Deep Archive Access tiers." + } + } + }, + { + "$type": "ObjectType", + "name": "InventoryConfiguration", + "properties": { + "Destination": { + "type": { + "$ref": "#/44" + }, + "flags": 1, + "description": "Contains information about where to publish the inventory results." + }, + "Enabled": { + "type": { + "$ref": "#/27" + }, + "flags": 1, + "description": "Specifies whether the inventory is enabled or disabled. If set to ``True``, an inventory list is generated. If set to ``False``, no inventory list is generated." + }, + "Id": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The ID used to identify the inventory configuration." + }, + "IncludedObjectVersions": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "Object versions to include in the inventory list. If set to ``All``, the list includes all the object versions, which adds the version-related fields ``VersionId``, ``IsLatest``, and ``DeleteMarker`` to the list. If set to ``Current``, the list does not contain these version-related fields." + }, + "OptionalFields": { + "type": { + "$ref": "#/104" + }, + "flags": 0, + "description": "Contains the optional fields that are included in the inventory results." + }, + "Prefix": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Specifies the inventory filter prefix." + }, + "ScheduleFrequency": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "Specifies the schedule for generating inventory results." + } + } + }, + { + "$type": "ObjectType", + "name": "LambdaConfiguration", + "properties": { + "Event": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The Amazon S3 bucket event for which to invoke the LAMlong function. For more information, see [Supported Event Types](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the *Amazon S3 User Guide*." + }, + "Filter": { + "type": { + "$ref": "#/58" + }, + "flags": 0, + "description": "The filtering rules that determine which objects invoke the AWS Lambda function. For example, you can create a filter so that only image files with a ``.jpg`` extension invoke the function when they are added to the Amazon S3 bucket." + }, + "Function": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of the LAMlong function that Amazon S3 invokes when the specified event type occurs." + } + } + }, + { + "$type": "ObjectType", + "name": "LifecycleConfiguration", + "properties": { + "Rules": { + "type": { + "$ref": "#/105" + }, + "flags": 5, + "description": "A lifecycle rule for individual objects in an Amazon S3 bucket." + } + } + }, + { + "$type": "ObjectType", + "name": "LoggingConfiguration", + "properties": { + "DestinationBucketName": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The name of the bucket where Amazon S3 should store server access log files. You can store log files in any bucket that you own. By default, logs are stored in the bucket where the ``LoggingConfiguration`` property is defined." + }, + "LogFilePrefix": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "A prefix for all log object keys. If you store log files from multiple Amazon S3 buckets in a single bucket, you can use a prefix to distinguish which log files came from which bucket." + }, + "TargetObjectKeyFormat": { + "type": { + "$ref": "#/87" + }, + "flags": 0, + "description": "Amazon S3 key format for log objects. Only one format, either PartitionedPrefix or SimplePrefix, is allowed." + } + } + }, + { + "$type": "ObjectType", + "name": "Metrics", + "properties": { + "EventThreshold": { + "type": { + "$ref": "#/75" + }, + "flags": 0, + "description": "A container specifying the time threshold for emitting the ``s3:Replication:OperationMissedThreshold`` event." + }, + "Status": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "Specifies whether the replication metrics are enabled." + } + } + }, + { + "$type": "ObjectType", + "name": "MetricsConfiguration", + "properties": { + "AccessPointArn": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The access point that was used while performing operations on the object. The metrics configuration only includes objects that meet the filter's criteria." + }, + "Id": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The ID used to identify the metrics configuration. This can be any value you choose that helps you identify your metrics configuration." + }, + "Prefix": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The prefix that an object must have to be included in the metrics results." + }, + "TagFilters": { + "type": { + "$ref": "#/106" + }, + "flags": 0, + "description": "Specifies a list of tag filters to use as a metrics configuration filter. The metrics configuration includes only objects that meet the filter's criteria." + } + } + }, + { + "$type": "ObjectType", + "name": "NoncurrentVersionExpiration", + "properties": { + "NewerNoncurrentVersions": { + "type": { + "$ref": "#/94" + }, + "flags": 0, + "description": "Specifies how many noncurrent versions S3 will retain. If there are this many more recent noncurrent versions, S3 will take the associated action. For more information about noncurrent versions, see [Lifecycle configuration elements](https://docs.aws.amazon.com/AmazonS3/latest/userguide/intro-lifecycle-rules.html) in the *Amazon S3 User Guide*." + }, + "NoncurrentDays": { + "type": { + "$ref": "#/94" + }, + "flags": 1, + "description": "Specifies the number of days an object is noncurrent before S3 can perform the associated action. For information about the noncurrent days calculations, see [How Amazon 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 User Guide*." + } + } + }, + { + "$type": "ObjectType", + "name": "NoncurrentVersionTransition", + "properties": { + "NewerNoncurrentVersions": { + "type": { + "$ref": "#/94" + }, + "flags": 0, + "description": "Specifies how many noncurrent versions S3 will retain. If there are this many more recent noncurrent versions, S3 will take the associated action. For more information about noncurrent versions, see [Lifecycle configuration elements](https://docs.aws.amazon.com/AmazonS3/latest/userguide/intro-lifecycle-rules.html) in the *Amazon S3 User Guide*." + }, + "StorageClass": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The class of storage used to store the object." + }, + "TransitionInDays": { + "type": { + "$ref": "#/94" + }, + "flags": 1, + "description": "Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see [How Amazon S3 Calculates How 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*." + } + } + }, + { + "$type": "ObjectType", + "name": "NotificationConfiguration", + "properties": { + "EventBridgeConfiguration": { + "type": { + "$ref": "#/46" + }, + "flags": 0, + "description": "Enables delivery of events to Amazon EventBridge." + }, + "LambdaConfigurations": { + "type": { + "$ref": "#/107" + }, + "flags": 0, + "description": "Describes the LAMlong functions to invoke and the events for which to invoke them." + }, + "QueueConfigurations": { + "type": { + "$ref": "#/108" + }, + "flags": 0, + "description": "The Amazon Simple Queue Service queues to publish messages to and the events for which to publish messages." + }, + "TopicConfigurations": { + "type": { + "$ref": "#/109" + }, + "flags": 0, + "description": "The topic to which notifications are sent and the events for which notifications are generated." + } + } + }, + { + "$type": "ObjectType", + "name": "NotificationFilter", + "properties": { + "S3Key": { + "type": { + "$ref": "#/79" + }, + "flags": 1, + "description": "A container for object key name prefix and suffix filtering rules." + } + } + }, + { + "$type": "ObjectType", + "name": "ObjectLockConfiguration", + "properties": { + "ObjectLockEnabled": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Indicates whether this bucket has an Object Lock configuration enabled. Enable ``ObjectLockEnabled`` when you apply ``ObjectLockConfiguration`` to a bucket." + }, + "Rule": { + "type": { + "$ref": "#/60" + }, + "flags": 0, + "description": "Specifies the Object Lock rule for the specified object. Enable this rule when you apply ``ObjectLockConfiguration`` to a bucket. If Object Lock is turned on, bucket settings require both ``Mode`` and a period of either ``Days`` or ``Years``. You cannot specify ``Days`` and ``Years`` at the same time. For more information, see [ObjectLockRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-objectlockrule.html) and [DefaultRetention](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-defaultretention.html)." + } + } + }, + { + "$type": "ObjectType", + "name": "ObjectLockRule", + "properties": { + "DefaultRetention": { + "type": { + "$ref": "#/42" + }, + "flags": 0, + "description": "The default Object Lock retention mode and period that you want to apply to new objects placed in the specified bucket. If Object Lock is turned on, bucket settings require both ``Mode`` and a period of either ``Days`` or ``Years``. You cannot specify ``Days`` and ``Years`` at the same time. For more information about allowable values for mode and period, see [DefaultRetention](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-defaultretention.html)." + } + } + }, + { + "$type": "ObjectType", + "name": "OwnershipControls", + "properties": { + "Rules": { + "type": { + "$ref": "#/110" + }, + "flags": 1, + "description": "Specifies the container element for Object Ownership rules." + } + } + }, + { + "$type": "ObjectType", + "name": "OwnershipControlsRule", + "properties": { + "ObjectOwnership": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Specifies an object ownership rule." + } + } + }, + { + "$type": "ObjectType", + "name": "PartitionedPrefix", + "properties": { + "PartitionDateSource": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Specifies the partition date source for the partitioned prefix. PartitionDateSource can be EventTime or DeliveryTime." + } + } + }, + { + "$type": "ObjectType", + "name": "PublicAccessBlockConfiguration", + "properties": { + "BlockPublicAcls": { + "type": { + "$ref": "#/27" + }, + "flags": 0, + "description": "Specifies whether Amazon S3 should block public access control lists (ACLs) for this bucket and objects in this bucket. Setting this element to ``TRUE`` causes the following behavior:\n + PUT Bucket ACL and PUT Object ACL calls fail if the specified ACL is public.\n + PUT Object calls fail if the request includes a public ACL.\n + PUT Bucket calls fail if the request includes a public ACL.\n \n Enabling this setting doesn't affect existing policies or ACLs." + }, + "BlockPublicPolicy": { + "type": { + "$ref": "#/27" + }, + "flags": 0, + "description": "Specifies whether Amazon S3 should block public bucket policies for this bucket. Setting this element to ``TRUE`` causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access. \n Enabling this setting doesn't affect existing bucket policies." + }, + "IgnorePublicAcls": { + "type": { + "$ref": "#/27" + }, + "flags": 0, + "description": "Specifies whether Amazon S3 should ignore public ACLs for this bucket and objects in this bucket. Setting this element to ``TRUE`` causes Amazon S3 to ignore all public ACLs on this bucket and objects in this bucket.\n Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set." + }, + "RestrictPublicBuckets": { + "type": { + "$ref": "#/27" + }, + "flags": 0, + "description": "Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting this element to ``TRUE`` restricts access to this bucket to only AWS-service principals and authorized users within this account if the bucket has a public policy.\n Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked." + } + } + }, + { + "$type": "ObjectType", + "name": "QueueConfiguration", + "properties": { + "Event": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The Amazon S3 bucket event about which you want to publish messages to Amazon SQS. For more information, see [Supported Event Types](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the *Amazon S3 User Guide*." + }, + "Filter": { + "type": { + "$ref": "#/58" + }, + "flags": 0, + "description": "The filtering rules that determine which objects trigger notifications. For example, you can create a filter so that Amazon S3 sends notifications only when image files with a ``.jpg`` extension are added to the bucket. For more information, see [Configuring event notifications using object key name filtering](https://docs.aws.amazon.com/AmazonS3/latest/user-guide/notification-how-to-filtering.html) in the *Amazon S3 User Guide*." + }, + "Queue": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of the Amazon SQS queue to which Amazon S3 publishes a message when it detects events of the specified type. FIFO queues are not allowed when enabling an SQS queue as the event notification destination." + } + } + }, + { + "$type": "ObjectType", + "name": "RedirectAllRequestsTo", + "properties": { + "HostName": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "Name of the host where requests are redirected." + }, + "Protocol": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Protocol to use when redirecting requests. The default is the protocol that is used in the original request." + } + } + }, + { + "$type": "ObjectType", + "name": "RedirectRule", + "properties": { + "HostName": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The host name to use in the redirect request." + }, + "HttpRedirectCode": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The HTTP redirect code to use on the response. Not required if one of the siblings is present." + }, + "Protocol": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Protocol to use when redirecting requests. The default is the protocol that is used in the original request." + }, + "ReplaceKeyPrefixWith": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix ``docs/`` (objects in the ``docs/`` folder) to ``documents/``, you can set a condition block with ``KeyPrefixEquals`` set to ``docs/`` and in the Redirect set ``ReplaceKeyPrefixWith`` to ``/documents``. Not required if one of the siblings is present. Can be present only if ``ReplaceKeyWith`` is not provided.\n Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints)." + }, + "ReplaceKeyWith": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The specific object key to use in the redirect request. For example, redirect request to ``error.html``. Not required if one of the siblings is present. Can be present only if ``ReplaceKeyPrefixWith`` is not provided.\n Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints)." + } + } + }, + { + "$type": "ObjectType", + "name": "ReplicaModifications", + "properties": { + "Status": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "Specifies whether Amazon S3 replicates modifications on replicas.\n *Allowed values*: ``Enabled`` | ``Disabled``" + } + } + }, + { + "$type": "ObjectType", + "name": "ReplicationConfiguration", + "properties": { + "Role": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of the IAMlong (IAM) role that Amazon S3 assumes when replicating objects. For more information, see [How to Set Up Replication](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-how-setup.html) in the *Amazon S3 User Guide*." + }, + "Rules": { + "type": { + "$ref": "#/111" + }, + "flags": 5, + "description": "A container for one or more replication rules. A replication configuration must have at least one rule and can contain a maximum of 1,000 rules." + } + } + }, + { + "$type": "ObjectType", + "name": "ReplicationDestination", + "properties": { + "AccessControlTranslation": { + "type": { + "$ref": "#/35" + }, + "flags": 0, + "description": "Specify this only in a cross-account scenario (where source and destination bucket owners are not the same), and you want to change replica ownership to the AWS-account that owns the destination bucket. If this is not specified in the replication configuration, the replicas are owned by same AWS-account that owns the source object." + }, + "Account": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Destination bucket owner account ID. In a cross-account scenario, if you direct Amazon S3 to change replica ownership to the AWS-account that owns the destination bucket by specifying the ``AccessControlTranslation`` property, this is the account ID of the destination bucket owner. For more information, see [Cross-Region Replication Additional Configuration: Change Replica Owner](https://docs.aws.amazon.com/AmazonS3/latest/dev/crr-change-owner.html) in the *Amazon S3 User Guide*.\n If you specify the ``AccessControlTranslation`` property, the ``Account`` property is required." + }, + "Bucket": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of the bucket where you want Amazon S3 to store the results." + }, + "EncryptionConfiguration": { + "type": { + "$ref": "#/45" + }, + "flags": 0, + "description": "Specifies encryption-related information." + }, + "Metrics": { + "type": { + "$ref": "#/53" + }, + "flags": 0, + "description": "A container specifying replication metrics-related settings enabling replication metrics and events." + }, + "ReplicationTime": { + "type": { + "$ref": "#/74" + }, + "flags": 0, + "description": "A container specifying S3 Replication Time Control (S3 RTC), including whether S3 RTC is enabled and the time when all objects and operations on objects must be replicated. Must be specified together with a ``Metrics`` block." + }, + "StorageClass": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The storage class to use when replicating objects, such as S3 Standard or reduced redundancy. By default, Amazon S3 uses the storage class of the source object to create the object replica. \n For valid values, see the ``StorageClass`` element of the [PUT Bucket replication](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTreplication.html) action in the *Amazon S3 API Reference*." + } + } + }, + { + "$type": "ObjectType", + "name": "ReplicationRule", + "properties": { + "DeleteMarkerReplication": { + "type": { + "$ref": "#/43" + }, + "flags": 0, + "description": "Specifies whether Amazon S3 replicates delete markers. If you specify a ``Filter`` in your replication configuration, you must also include a ``DeleteMarkerReplication`` element. If your ``Filter`` includes a ``Tag`` element, the ``DeleteMarkerReplication`` ``Status`` must be set to Disabled, because Amazon S3 does not support replicating delete markers for tag-based rules. For an example configuration, see [Basic Rule Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-config-min-rule-config). \n For more information about delete marker replication, see [Basic Rule Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/delete-marker-replication.html). \n If you are using an earlier version of the replication configuration, Amazon S3 handles replication of delete markers differently. For more information, see [Backward Compatibility](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations)." + }, + "Destination": { + "type": { + "$ref": "#/70" + }, + "flags": 1, + "description": "A container for information about the replication destination and its configurations including enabling the S3 Replication Time Control (S3 RTC)." + }, + "Filter": { + "type": { + "$ref": "#/73" + }, + "flags": 0, + "description": "A filter that identifies the subset of objects to which the replication rule applies. A ``Filter`` must specify exactly one ``Prefix``, ``TagFilter``, or an ``And`` child element. The use of the filter field indicates that this is a V2 replication configuration. This field isn't supported in a V1 replication configuration.\n V1 replication configuration only supports filtering by key prefix. To filter using a V1 replication configuration, add the ``Prefix`` directly as a child element of the ``Rule`` element." + }, + "Id": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "A unique identifier for the rule. The maximum value is 255 characters. If you don't specify a value, AWS CloudFormation generates a random ID. When using a V2 replication configuration this property is capitalized as \"ID\"." + }, + "Prefix": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "An object key name prefix that identifies the object or objects to which the rule applies. The maximum prefix length is 1,024 characters. To include all objects in a bucket, specify an empty string. To filter using a V1 replication configuration, add the ``Prefix`` directly as a child element of the ``Rule`` element.\n Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints)." + }, + "Priority": { + "type": { + "$ref": "#/94" + }, + "flags": 0, + "description": "The priority indicates which rule has precedence whenever two or more replication rules conflict. Amazon S3 will attempt to replicate objects according to all replication rules. However, if there are two or more rules with the same destination bucket, then objects will be replicated according to the rule with the highest priority. The higher the number, the higher the priority. \n For more information, see [Replication](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html) in the *Amazon S3 User Guide*." + }, + "SourceSelectionCriteria": { + "type": { + "$ref": "#/82" + }, + "flags": 0, + "description": "A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects." + }, + "Status": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "Specifies whether the rule is enabled." + } + } + }, + { + "$type": "ObjectType", + "name": "ReplicationRuleAndOperator", + "properties": { + "Prefix": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "An object key name prefix that identifies the subset of objects to which the rule applies." + }, + "TagFilters": { + "type": { + "$ref": "#/112" + }, + "flags": 0, + "description": "An array of tags containing key and value pairs." + } + } + }, + { + "$type": "ObjectType", + "name": "ReplicationRuleFilter", + "properties": { + "And": { + "type": { + "$ref": "#/72" + }, + "flags": 0, + "description": "A container for specifying rule filters. The filters determine the subset of objects to which the rule applies. This element is required only if you specify more than one filter. For example: \n + If you specify both a ``Prefix`` and a ``TagFilter``, wrap these filters in an ``And`` tag.\n + If you specify a filter based on multiple tags, wrap the ``TagFilter`` elements in an ``And`` tag." + }, + "Prefix": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "An object key name prefix that identifies the subset of objects to which the rule applies.\n Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints)." + }, + "TagFilter": { + "type": { + "$ref": "#/86" + }, + "flags": 0, + "description": "A container for specifying a tag key and value. \n The rule applies only to objects that have the tag in their tag set." + } + } + }, + { + "$type": "ObjectType", + "name": "ReplicationTime", + "properties": { + "Status": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "Specifies whether the replication time is enabled." + }, + "Time": { + "type": { + "$ref": "#/75" + }, + "flags": 1, + "description": "A container specifying the time by which replication should be complete for all objects and operations on objects." + } + } + }, + { + "$type": "ObjectType", + "name": "ReplicationTimeValue", + "properties": { + "Minutes": { + "type": { + "$ref": "#/94" + }, + "flags": 1, + "description": "Contains an integer specifying time in minutes. \n Valid value: 15" + } + } + }, + { + "$type": "ObjectType", + "name": "RoutingRule", + "properties": { + "RedirectRule": { + "type": { + "$ref": "#/67" + }, + "flags": 1, + "description": "Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event of an error, you can specify a different error code to return." + }, + "RoutingRuleCondition": { + "type": { + "$ref": "#/77" + }, + "flags": 0, + "description": "A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the ``/docs`` folder, redirect to the ``/documents`` folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error." + } + } + }, + { + "$type": "ObjectType", + "name": "RoutingRuleCondition", + "properties": { + "HttpErrorCodeReturnedEquals": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The HTTP error code when the redirect is applied. In the event of an error, if the error code equals this value, then the specified redirect is applied.\n Required when parent element ``Condition`` is specified and sibling ``KeyPrefixEquals`` is not specified. If both are specified, then both must be true for the redirect to be applied." + }, + "KeyPrefixEquals": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The object key name prefix when the redirect is applied. For example, to redirect requests for ``ExamplePage.html``, the key prefix will be ``ExamplePage.html``. To redirect request for all pages with the prefix ``docs/``, the key prefix will be ``/docs``, which identifies all objects in the docs/ folder.\n Required when the parent element ``Condition`` is specified and sibling ``HttpErrorCodeReturnedEquals`` is not specified. If both conditions are specified, both must be true for the redirect to be applied." + } + } + }, + { + "$type": "ObjectType", + "name": "Rule", + "properties": { + "AbortIncompleteMultipartUpload": { + "type": { + "$ref": "#/33" + }, + "flags": 0, + "description": "Specifies a lifecycle rule that stops incomplete multipart uploads to an Amazon S3 bucket." + }, + "ExpirationDate": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Indicates when objects are deleted from Amazon S3 and Amazon S3 Glacier. The date value must be in ISO 8601 format. The time is always midnight UTC. If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time." + }, + "ExpirationInDays": { + "type": { + "$ref": "#/94" + }, + "flags": 0, + "description": "Indicates the number of days after creation when objects are deleted from Amazon S3 and Amazon S3 Glacier. If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time." + }, + "ExpiredObjectDeleteMarker": { + "type": { + "$ref": "#/27" + }, + "flags": 0, + "description": "Indicates whether Amazon S3 will remove a delete marker without any noncurrent versions. If set to true, the delete marker will be removed if there are no noncurrent versions. This cannot be specified with ``ExpirationInDays``, ``ExpirationDate``, or ``TagFilters``." + }, + "Id": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Unique identifier for the rule. The value can't be longer than 255 characters." + }, + "NoncurrentVersionExpiration": { + "type": { + "$ref": "#/55" + }, + "flags": 0, + "description": "Specifies when noncurrent object versions expire. Upon expiration, S3 permanently deletes the noncurrent object versions. You set this lifecycle configuration action on a bucket that has versioning enabled (or suspended) to request that S3 delete noncurrent object versions at a specific period in the object's lifetime." + }, + "NoncurrentVersionExpirationInDays": { + "type": { + "$ref": "#/94" + }, + "flags": 0, + "description": "(Deprecated.) For buckets with versioning enabled (or suspended), specifies the time, in days, between when a new version of the object is uploaded to the bucket and when old versions of the object expire. When object versions expire, Amazon S3 permanently deletes them. If you specify a transition and expiration time, the expiration time must be later than the transition time." + }, + "NoncurrentVersionTransition": { + "type": { + "$ref": "#/56" + }, + "flags": 0, + "description": "(Deprecated.) For buckets with versioning enabled (or suspended), specifies when non-current objects transition to a specified storage class. If you specify a transition and expiration time, the expiration time must be later than the transition time. If you specify this property, don't specify the ``NoncurrentVersionTransitions`` property." + }, + "NoncurrentVersionTransitions": { + "type": { + "$ref": "#/113" + }, + "flags": 0, + "description": "For buckets with versioning enabled (or suspended), one or more transition rules that specify when non-current objects transition to a specified storage class. If you specify a transition and expiration time, the expiration time must be later than the transition time. If you specify this property, don't specify the ``NoncurrentVersionTransition`` property." + }, + "ObjectSizeGreaterThan": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Specifies the minimum object size in bytes for this rule to apply to. Objects must be larger than this value in bytes. For more information about size based rules, see [Lifecycle configuration using size-based rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/lifecycle-configuration-examples.html#lc-size-rules) in the *Amazon S3 User Guide*." + }, + "ObjectSizeLessThan": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Specifies the maximum object size in bytes for this rule to apply to. Objects must be smaller than this value in bytes. For more information about sized based rules, see [Lifecycle configuration using size-based rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/lifecycle-configuration-examples.html#lc-size-rules) in the *Amazon S3 User Guide*." + }, + "Prefix": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Object key prefix that identifies one or more objects to which this rule applies.\n Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints)." + }, + "Status": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "If ``Enabled``, the rule is currently being applied. If ``Disabled``, the rule is not currently being applied." + }, + "TagFilters": { + "type": { + "$ref": "#/114" + }, + "flags": 0, + "description": "Tags to use to identify a subset of objects to which the lifecycle rule applies." + }, + "Transition": { + "type": { + "$ref": "#/90" + }, + "flags": 0, + "description": "(Deprecated.) Specifies when an object transitions to a specified storage class. If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time. If you specify this property, don't specify the ``Transitions`` property." + }, + "Transitions": { + "type": { + "$ref": "#/115" + }, + "flags": 0, + "description": "One or more transition rules that specify when an object transitions to a specified storage class. If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time. If you specify this property, don't specify the ``Transition`` property." + } + } + }, + { + "$type": "ObjectType", + "name": "S3KeyFilter", + "properties": { + "Rules": { + "type": { + "$ref": "#/116" + }, + "flags": 1, + "description": "A list of containers for the key-value pair that defines the criteria for the filter rule." + } + } + }, + { + "$type": "ObjectType", + "name": "ServerSideEncryptionByDefault", + "properties": { + "KMSMasterKeyID": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "AWS Key Management Service (KMS) customer AWS KMS key ID to use for the default encryption. This parameter is allowed if and only if ``SSEAlgorithm`` is set to ``aws:kms`` or ``aws:kms:dsse``.\n You 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: ``arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`` \n + Key Alias: ``alias/alias-name`` \n \n If you use a key ID, you can run into a LogDestination undeliverable error when creating a VPC flow log. \n If you are using encryption with cross-account or AWS service operations you 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/dev/bucket-encryption.html#bucket-encryption-update-bucket-policy).\n Amazon S3 only supports symmetric encryption KMS keys. For more information, see [Asymmetric keys in KMS](https://docs.aws.amazon.com//kms/latest/developerguide/symmetric-asymmetric.html) in the *Key Management Service Developer Guide*." + }, + "SSEAlgorithm": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "Server-side encryption algorithm to use for the default encryption." + } + } + }, + { + "$type": "ObjectType", + "name": "ServerSideEncryptionRule", + "properties": { + "BucketKeyEnabled": { + "type": { + "$ref": "#/27" + }, + "flags": 0, + "description": "Specifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS (SSE-KMS) for new objects in the bucket. Existing objects are not affected. Setting the ``BucketKeyEnabled`` element to ``true`` causes Amazon S3 to use an S3 Bucket Key. By default, S3 Bucket Key is not enabled.\n For more information, see [Amazon S3 Bucket Keys](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html) in the *Amazon S3 User Guide*." + }, + "ServerSideEncryptionByDefault": { + "type": { + "$ref": "#/80" + }, + "flags": 0, + "description": "Specifies the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied." + } + } + }, + { + "$type": "ObjectType", + "name": "SourceSelectionCriteria", + "properties": { + "ReplicaModifications": { + "type": { + "$ref": "#/68" + }, + "flags": 0, + "description": "A filter that you can specify for selection for modifications on replicas." + }, + "SseKmsEncryptedObjects": { + "type": { + "$ref": "#/83" + }, + "flags": 0, + "description": "A container for filter information for the selection of Amazon S3 objects encrypted with AWS KMS." + } + } + }, + { + "$type": "ObjectType", + "name": "SseKmsEncryptedObjects", + "properties": { + "Status": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "Specifies whether Amazon S3 replicates objects created with server-side encryption using an AWS KMS key stored in AWS Key Management Service." + } + } + }, + { + "$type": "ObjectType", + "name": "StorageClassAnalysis", + "properties": { + "DataExport": { + "type": { + "$ref": "#/41" + }, + "flags": 0, + "description": "Specifies how data related to the storage class analysis for an Amazon S3 bucket should be exported." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "Name of the object key." + }, + "Value": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "Value of the tag." + } + } + }, + { + "$type": "ObjectType", + "name": "TagFilter", + "properties": { + "Key": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The tag key." + }, + "Value": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The tag value." + } + } + }, + { + "$type": "ObjectType", + "name": "TargetObjectKeyFormat", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tiering", + "properties": { + "AccessTier": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "S3 Intelligent-Tiering access tier. See [Storage class for automatically 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 tiers in the S3 Intelligent-Tiering storage class." + }, + "Days": { + "type": { + "$ref": "#/94" + }, + "flags": 1, + "description": "The number of consecutive days of no access after which an object will be eligible to be transitioned to the corresponding tier. The minimum number of days specified for Archive Access tier must be at least 90 days and Deep Archive Access tier must be at least 180 days. The maximum can be up to 2 years (730 days)." + } + } + }, + { + "$type": "ObjectType", + "name": "TopicConfiguration", + "properties": { + "Event": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The 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 the *Amazon S3 User Guide*." + }, + "Filter": { + "type": { + "$ref": "#/58" + }, + "flags": 0, + "description": "The filtering rules that determine for which objects to send notifications. For example, you can create a filter so that Amazon S3 sends notifications only when image files with a ``.jpg`` extension are added to the bucket." + }, + "Topic": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of the Amazon SNS topic to which Amazon S3 publishes a message when it detects events of the specified type." + } + } + }, + { + "$type": "ObjectType", + "name": "Transition", + "properties": { + "StorageClass": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The storage class to which you want the object to transition." + }, + "TransitionDate": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Indicates when objects are transitioned to the specified storage class. The date value must be in ISO 8601 format. The time is always midnight UTC." + }, + "TransitionInDays": { + "type": { + "$ref": "#/94" + }, + "flags": 0, + "description": "Indicates the number of days after creation when objects are transitioned to the specified storage class. The value must be a positive integer." + } + } + }, + { + "$type": "ObjectType", + "name": "VersioningConfiguration", + "properties": { + "Status": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The versioning state of the bucket." + } + } + }, + { + "$type": "ObjectType", + "name": "WebsiteConfiguration", + "properties": { + "ErrorDocument": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The name of the error document for the website." + }, + "IndexDocument": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The name of the index document for the website." + }, + "RedirectAllRequestsTo": { + "type": { + "$ref": "#/66" + }, + "flags": 0, + "description": "The redirect behavior for every request to this bucket's website endpoint.\n If you specify this property, you can't specify any other property." + }, + "RoutingRules": { + "type": { + "$ref": "#/117" + }, + "flags": 0, + "description": "Rules that define when a redirect is applied and the redirect behavior." + } + } + }, + { + "$type": "ObjectType", + "name": "iso8601UTC", + "properties": {} + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/86" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/81" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/40" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/86" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/88" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/78" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/86" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/50" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/65" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/89" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/62" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/71" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/86" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/56" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/86" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/90" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/47" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/76" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.S3/BucketProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/36" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/48" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/49" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/54" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/85" + } + }, + { + "$type": "ObjectType", + "name": "AWS.S3/BucketProperties", + "properties": { + "AccelerateConfiguration": { + "type": { + "$ref": "#/34" + }, + "flags": 0, + "description": "Configures the transfer acceleration state for an Amazon S3 bucket. For more information, see [Amazon S3 Transfer Acceleration](https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html) in the *Amazon S3 User Guide*." + }, + "AccessControl": { + "type": { + "$ref": "#/4" + }, + "flags": 4, + "description": "This is a legacy property, and it is not recommended for most use cases. A majority of modern use cases in Amazon S3 no longer require the use of ACLs, and we recommend that you keep ACLs disabled. For more information, see [Controlling object ownership](https://docs.aws.amazon.com//AmazonS3/latest/userguide/about-object-ownership.html) in the *Amazon S3 User Guide*.\n A canned access control list (ACL) that grants predefined permissions to the bucket. For more information about canned ACLs, see [Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) in the *Amazon S3 User Guide*.\n S3 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 with any value other than Private. Use cases requiring ACLs are uncommon.\n The majority of access control configurations can be successfully and more easily achieved 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 Server Access Logs buckets and more, see [Bucket policy examples](https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html) in the *Amazon S3 User Guide*." + }, + "AnalyticsConfigurations": { + "type": { + "$ref": "#/119" + }, + "flags": 0, + "description": "Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket." + }, + "Arn": { + "type": { + "$ref": "#/4" + }, + "flags": 2, + "description": "" + }, + "BucketEncryption": { + "type": { + "$ref": "#/38" + }, + "flags": 0, + "description": "Specifies default encryption for a bucket using server-side encryption with Amazon S3-managed keys (SSE-S3), AWS KMS-managed keys (SSE-KMS), or dual-layer server-side encryption with KMS-managed keys (DSSE-KMS). For information about the Amazon S3 default encryption feature, see [Amazon S3 Default Encryption for S3 Buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html) in the *Amazon S3 User Guide*." + }, + "BucketName": { + "type": { + "$ref": "#/4" + }, + "flags": 16, + "description": "A name for the bucket. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the bucket name. The bucket name must contain only lowercase letters, numbers, periods (.), and dashes (-) and must follow [Amazon S3 bucket restrictions and limitations](https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html). For more information, see [Rules for naming Amazon S3 buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html#bucketnamingrules) in the *Amazon S3 User Guide*. \n If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you need to replace the resource, specify a new name." + }, + "CorsConfiguration": { + "type": { + "$ref": "#/39" + }, + "flags": 0, + "description": "Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see [Enabling Cross-Origin Resource Sharing](https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) in the *Amazon S3 User Guide*." + }, + "DomainName": { + "type": { + "$ref": "#/4" + }, + "flags": 2, + "description": "" + }, + "DualStackDomainName": { + "type": { + "$ref": "#/4" + }, + "flags": 2, + "description": "" + }, + "IntelligentTieringConfigurations": { + "type": { + "$ref": "#/120" + }, + "flags": 0, + "description": "Defines how Amazon S3 handles Intelligent-Tiering storage." + }, + "InventoryConfigurations": { + "type": { + "$ref": "#/121" + }, + "flags": 0, + "description": "Specifies the inventory configuration for an Amazon S3 bucket. For more information, see [GET Bucket inventory](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETInventoryConfig.html) in the *Amazon S3 API Reference*." + }, + "LifecycleConfiguration": { + "type": { + "$ref": "#/51" + }, + "flags": 0, + "description": "Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more information, see [Object Lifecycle Management](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) in the *Amazon S3 User Guide*." + }, + "LoggingConfiguration": { + "type": { + "$ref": "#/52" + }, + "flags": 0, + "description": "Settings that define where logs are stored." + }, + "MetricsConfigurations": { + "type": { + "$ref": "#/122" + }, + "flags": 0, + "description": "Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased. For more information, see [PutBucketMetricsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTMetricConfiguration.html)." + }, + "NotificationConfiguration": { + "type": { + "$ref": "#/57" + }, + "flags": 0, + "description": "Configuration that defines how Amazon S3 handles bucket notifications." + }, + "ObjectLockConfiguration": { + "type": { + "$ref": "#/59" + }, + "flags": 0, + "description": "This operation is not supported by directory buckets.\n Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see [Locking Objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html). \n + The ``DefaultRetention`` settings require both a mode and a period.\n + The ``DefaultRetention`` period can be either ``Days`` or ``Years`` but you must select one. You cannot specify ``Days`` and ``Years`` at the same time.\n + You can enable Object Lock for new or existing buckets. For more information, see [Configuring Object Lock](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-configure.html)." + }, + "ObjectLockEnabled": { + "type": { + "$ref": "#/27" + }, + "flags": 0, + "description": "Indicates whether this bucket has an Object Lock configuration enabled. Enable ``ObjectLockEnabled`` when you apply ``ObjectLockConfiguration`` to a bucket." + }, + "OwnershipControls": { + "type": { + "$ref": "#/61" + }, + "flags": 0, + "description": "Configuration that defines how Amazon S3 handles Object Ownership rules." + }, + "PublicAccessBlockConfiguration": { + "type": { + "$ref": "#/64" + }, + "flags": 0, + "description": "Configuration that defines how Amazon S3 handles public access." + }, + "RegionalDomainName": { + "type": { + "$ref": "#/4" + }, + "flags": 2, + "description": "" + }, + "ReplicationConfiguration": { + "type": { + "$ref": "#/69" + }, + "flags": 0, + "description": "Configuration for replicating objects in an S3 bucket. To enable replication, you must also enable versioning by using the ``VersioningConfiguration`` property.\n Amazon S3 can store replicated objects in a single destination bucket or multiple destination buckets. The destination bucket or buckets must already exist." + }, + "Tags": { + "type": { + "$ref": "#/123" + }, + "flags": 0, + "description": "An arbitrary set of tags (key-value pairs) for this S3 bucket." + }, + "VersioningConfiguration": { + "type": { + "$ref": "#/91" + }, + "flags": 0, + "description": "Enables multiple versions of all objects in this bucket. You might enable versioning to prevent objects from being deleted or overwritten by mistake or to archive objects so that you can retrieve previous versions of them." + }, + "WebsiteConfiguration": { + "type": { + "$ref": "#/92" + }, + "flags": 0, + "description": "Information used to configure the bucket as a static website. For more information, see [Hosting Websites on Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html)." + }, + "WebsiteURL": { + "type": { + "$ref": "#/4" + }, + "flags": 2, + "description": "" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.S3/Bucket", + "properties": { + "name": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/124" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.S3/Bucket@default", + "scopeType": 0, + "body": { + "$ref": "#/125" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.S3/BucketPolicyProperties" + }, + { + "$type": "ObjectType", + "name": "BucketPolicy_PolicyDocument", + "properties": {} + }, + { + "$type": "UnionType", + "elements": [ + { + "$ref": "#/128" + }, + { + "$ref": "#/4" + } + ] + }, + { + "$type": "ObjectType", + "name": "AWS.S3/BucketPolicyProperties", + "properties": { + "Bucket": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "The name of the Amazon S3 bucket to which the policy applies." + }, + "PolicyDocument": { + "type": { + "$ref": "#/129" + }, + "flags": 1, + "description": "A policy document containing permissions to add to the specified 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. 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 Overview](https://docs.aws.amazon.com/AmazonS3/latest/dev/access-policy-language-overview.html) in the *Amazon S3 User Guide*." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.S3/BucketPolicy", + "properties": { + "name": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/130" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.S3/BucketPolicy@default", + "scopeType": 0, + "body": { + "$ref": "#/131" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.S3/MultiRegionAccessPointPolicyProperties" + }, + { + "$type": "ObjectType", + "name": "MultiRegionAccessPointPolicy_Policy", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MultiRegionAccessPointPolicy_PolicyStatus", + "properties": { + "IsPublic": { + "type": { + "$ref": "#/4" + }, + "flags": 3, + "description": "Specifies whether the policy is public or not." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.S3/MultiRegionAccessPointPolicyProperties", + "properties": { + "MrapName": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "The name of the Multi Region Access Point to apply policy" + }, + "Policy": { + "type": { + "$ref": "#/134" + }, + "flags": 1, + "description": "Policy document to apply to a Multi Region Access Point" + }, + "PolicyStatus": { + "type": { + "$ref": "#/135" + }, + "flags": 2, + "description": "The Policy Status associated with this Multi Region Access Point" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.S3/MultiRegionAccessPointPolicy", + "properties": { + "name": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/136" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.S3/MultiRegionAccessPointPolicy@default", + "scopeType": 0, + "body": { + "$ref": "#/137" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AccountLevel", + "properties": { + "ActivityMetrics": { + "type": { + "$ref": "#/140" + }, + "flags": 0 + }, + "AdvancedCostOptimizationMetrics": { + "type": { + "$ref": "#/141" + }, + "flags": 0 + }, + "AdvancedDataProtectionMetrics": { + "type": { + "$ref": "#/142" + }, + "flags": 0 + }, + "BucketLevel": { + "type": { + "$ref": "#/145" + }, + "flags": 1 + }, + "DetailedStatusCodesMetrics": { + "type": { + "$ref": "#/149" + }, + "flags": 0 + }, + "StorageLensGroupLevel": { + "type": { + "$ref": "#/159" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ActivityMetrics", + "properties": { + "IsEnabled": { + "type": { + "$ref": "#/27" + }, + "flags": 0, + "description": "Specifies whether activity metrics are enabled or disabled." + } + } + }, + { + "$type": "ObjectType", + "name": "AdvancedCostOptimizationMetrics", + "properties": { + "IsEnabled": { + "type": { + "$ref": "#/27" + }, + "flags": 0, + "description": "Specifies whether advanced cost optimization metrics are enabled or disabled." + } + } + }, + { + "$type": "ObjectType", + "name": "AdvancedDataProtectionMetrics", + "properties": { + "IsEnabled": { + "type": { + "$ref": "#/27" + }, + "flags": 0, + "description": "Specifies whether advanced data protection metrics are enabled or disabled." + } + } + }, + { + "$type": "ObjectType", + "name": "Arn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AwsOrg", + "properties": { + "Arn": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "BucketLevel", + "properties": { + "ActivityMetrics": { + "type": { + "$ref": "#/140" + }, + "flags": 0 + }, + "AdvancedCostOptimizationMetrics": { + "type": { + "$ref": "#/141" + }, + "flags": 0 + }, + "AdvancedDataProtectionMetrics": { + "type": { + "$ref": "#/142" + }, + "flags": 0 + }, + "DetailedStatusCodesMetrics": { + "type": { + "$ref": "#/149" + }, + "flags": 0 + }, + "PrefixLevel": { + "type": { + "$ref": "#/152" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BucketsAndRegions", + "properties": { + "Buckets": { + "type": { + "$ref": "#/162" + }, + "flags": 0 + }, + "Regions": { + "type": { + "$ref": "#/163" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CloudWatchMetrics", + "properties": { + "IsEnabled": { + "type": { + "$ref": "#/27" + }, + "flags": 1, + "description": "Specifies whether CloudWatch metrics are enabled or disabled." + } + } + }, + { + "$type": "ObjectType", + "name": "DataExport", + "properties": { + "CloudWatchMetrics": { + "type": { + "$ref": "#/147" + }, + "flags": 0 + }, + "S3BucketDestination": { + "type": { + "$ref": "#/154" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DetailedStatusCodesMetrics", + "properties": { + "IsEnabled": { + "type": { + "$ref": "#/27" + }, + "flags": 0, + "description": "Specifies whether detailed status codes metrics are enabled or disabled." + } + } + }, + { + "$type": "ObjectType", + "name": "Encryption", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Id", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PrefixLevel", + "properties": { + "StorageMetrics": { + "type": { + "$ref": "#/153" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "PrefixLevelStorageMetrics", + "properties": { + "IsEnabled": { + "type": { + "$ref": "#/27" + }, + "flags": 0, + "description": "Specifies whether prefix-level storage metrics are enabled or disabled." + }, + "SelectionCriteria": { + "type": { + "$ref": "#/156" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "S3BucketDestination", + "properties": { + "AccountId": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The AWS account ID that owns the destination S3 bucket." + }, + "Arn": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The ARN of the bucket to which Amazon S3 Storage Lens exports will be placed." + }, + "Encryption": { + "type": { + "$ref": "#/150" + }, + "flags": 0 + }, + "Format": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "Specifies the file format to use when exporting Amazon S3 Storage Lens metrics export." + }, + "OutputSchemaVersion": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The version of the output schema to use when exporting Amazon S3 Storage Lens metrics." + }, + "Prefix": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The prefix to use for Amazon S3 Storage Lens export." + } + } + }, + { + "$type": "ObjectType", + "name": "SSEKMS", + "properties": { + "KeyId": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The ARN of the KMS key to use for encryption." + } + } + }, + { + "$type": "ObjectType", + "name": "SelectionCriteria", + "properties": { + "Delimiter": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Delimiter to divide S3 key into hierarchy of prefixes." + }, + "MaxDepth": { + "type": { + "$ref": "#/94" + }, + "flags": 0, + "description": "Max depth of prefixes of S3 key that Amazon S3 Storage Lens will analyze." + }, + "MinStorageBytesPercentage": { + "type": { + "$ref": "#/94" + }, + "flags": 0, + "description": "The minimum storage bytes threshold for the prefixes to be included in the analysis." + } + } + }, + { + "$type": "ObjectType", + "name": "StorageLensConfiguration", + "properties": { + "AccountLevel": { + "type": { + "$ref": "#/139" + }, + "flags": 1 + }, + "AwsOrg": { + "type": { + "$ref": "#/144" + }, + "flags": 0 + }, + "DataExport": { + "type": { + "$ref": "#/148" + }, + "flags": 0 + }, + "Exclude": { + "type": { + "$ref": "#/146" + }, + "flags": 0 + }, + "Id": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + }, + "Include": { + "type": { + "$ref": "#/146" + }, + "flags": 0 + }, + "IsEnabled": { + "type": { + "$ref": "#/27" + }, + "flags": 1, + "description": "Specifies whether the Amazon S3 Storage Lens configuration is enabled or disabled." + }, + "StorageLensArn": { + "type": { + "$ref": "#/4" + }, + "flags": 2, + "description": "The ARN for the Amazon S3 Storage Lens configuration." + } + } + }, + { + "$type": "ObjectType", + "name": "StorageLensGroupArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "StorageLensGroupLevel", + "properties": { + "StorageLensGroupSelectionCriteria": { + "type": { + "$ref": "#/160" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "StorageLensGroupSelectionCriteria", + "properties": { + "Exclude": { + "type": { + "$ref": "#/164" + }, + "flags": 0 + }, + "Include": { + "type": { + "$ref": "#/165" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.S3/StorageLensProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/161" + } + }, + { + "$type": "ObjectType", + "name": "AWS.S3/StorageLensProperties", + "properties": { + "StorageLensConfiguration": { + "type": { + "$ref": "#/157" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/167" + }, + "flags": 0, + "description": "A set of tags (key-value pairs) for this Amazon S3 Storage Lens configuration." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.S3/StorageLens", + "properties": { + "name": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/168" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.S3/StorageLens@default", + "scopeType": 0, + "body": { + "$ref": "#/169" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "And", + "properties": { + "MatchAnyPrefix": { + "type": { + "$ref": "#/181" + }, + "flags": 0 + }, + "MatchAnySuffix": { + "type": { + "$ref": "#/182" + }, + "flags": 0 + }, + "MatchAnyTag": { + "type": { + "$ref": "#/183" + }, + "flags": 0 + }, + "MatchObjectAge": { + "type": { + "$ref": "#/176" + }, + "flags": 0 + }, + "MatchObjectSize": { + "type": { + "$ref": "#/177" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Filter", + "properties": { + "And": { + "type": { + "$ref": "#/171" + }, + "flags": 0 + }, + "MatchAnyPrefix": { + "type": { + "$ref": "#/184" + }, + "flags": 0 + }, + "MatchAnySuffix": { + "type": { + "$ref": "#/185" + }, + "flags": 0 + }, + "MatchAnyTag": { + "type": { + "$ref": "#/186" + }, + "flags": 0 + }, + "MatchObjectAge": { + "type": { + "$ref": "#/176" + }, + "flags": 0 + }, + "MatchObjectSize": { + "type": { + "$ref": "#/177" + }, + "flags": 0 + }, + "Or": { + "type": { + "$ref": "#/179" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "MatchAnyPrefix", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MatchAnySuffix", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MatchAnyTag", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MatchObjectAge", + "properties": { + "DaysGreaterThan": { + "type": { + "$ref": "#/94" + }, + "flags": 0, + "description": "Minimum object age to which the rule applies." + }, + "DaysLessThan": { + "type": { + "$ref": "#/94" + }, + "flags": 0, + "description": "Maximum object age to which the rule applies." + } + } + }, + { + "$type": "ObjectType", + "name": "MatchObjectSize", + "properties": { + "BytesGreaterThan": { + "type": { + "$ref": "#/94" + }, + "flags": 0, + "description": "Minimum object size to which the rule applies." + }, + "BytesLessThan": { + "type": { + "$ref": "#/94" + }, + "flags": 0, + "description": "Maximum object size to which the rule applies." + } + } + }, + { + "$type": "ObjectType", + "name": "Name", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Or", + "properties": { + "MatchAnyPrefix": { + "type": { + "$ref": "#/190" + }, + "flags": 0 + }, + "MatchAnySuffix": { + "type": { + "$ref": "#/191" + }, + "flags": 0 + }, + "MatchAnyTag": { + "type": { + "$ref": "#/192" + }, + "flags": 0 + }, + "MatchObjectAge": { + "type": { + "$ref": "#/176" + }, + "flags": 0 + }, + "MatchObjectSize": { + "type": { + "$ref": "#/177" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/180" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/180" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/180" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/180" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.S3/StorageLensGroupProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/180" + } + }, + { + "$type": "ObjectType", + "name": "AWS.S3/StorageLensGroupProperties", + "properties": { + "Filter": { + "type": { + "$ref": "#/172" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/4" + }, + "flags": 17 + }, + "StorageLensGroupArn": { + "type": { + "$ref": "#/4" + }, + "flags": 2, + "description": "The ARN for the Amazon S3 Storage Lens Group." + }, + "Tags": { + "type": { + "$ref": "#/194" + }, + "flags": 0, + "description": "A set of tags (key-value pairs) for this Amazon S3 Storage Lens Group." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.S3/StorageLensGroup", + "properties": { + "name": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/195" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.S3/StorageLensGroup@default", + "scopeType": 0, + "body": { + "$ref": "#/196" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.s3/default/types.md b/artifacts/bicep/aws/aws.s3/default/types.md index 5dc9026d..eaf67974 100644 --- a/artifacts/bicep/aws/aws.s3/default/types.md +++ b/artifacts/bicep/aws/aws.s3/default/types.md @@ -3,65 +3,121 @@ ## Resource AWS.S3/AccessGrant@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.S3/AccessGrantProperties](#awss3accessgrantproperties) (Required): properties of the resource +* **properties**: [AWS.S3/AccessGrantProperties](#awss3accessgrantproperties) (Required, Identifier): properties of the resource ## Resource AWS.S3/AccessGrantsInstance@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.S3/AccessGrantsInstanceProperties](#awss3accessgrantsinstanceproperties): properties of the resource +* **properties**: [AWS.S3/AccessGrantsInstanceProperties](#awss3accessgrantsinstanceproperties) (Identifier): properties of the resource ## Resource AWS.S3/AccessGrantsLocation@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.S3/AccessGrantsLocationProperties](#awss3accessgrantslocationproperties): properties of the resource +* **properties**: [AWS.S3/AccessGrantsLocationProperties](#awss3accessgrantslocationproperties) (Identifier): properties of the resource ## Resource AWS.S3/AccessPoint@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.S3/AccessPointProperties](#awss3accesspointproperties) (Required): properties of the resource +* **properties**: [AWS.S3/AccessPointProperties](#awss3accesspointproperties) (Required, Identifier): properties of the resource ## Resource AWS.S3/Bucket@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.S3/BucketProperties](#awss3bucketproperties): properties of the resource +* **properties**: [AWS.S3/BucketProperties](#awss3bucketproperties) (Identifier): properties of the resource ## Resource AWS.S3/BucketPolicy@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.S3/BucketPolicyProperties](#awss3bucketpolicyproperties) (Required): properties of the resource +* **properties**: [AWS.S3/BucketPolicyProperties](#awss3bucketpolicyproperties) (Required, Identifier): properties of the resource ## Resource AWS.S3/MultiRegionAccessPointPolicy@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.S3/MultiRegionAccessPointPolicyProperties](#awss3multiregionaccesspointpolicyproperties) (Required): properties of the resource +* **properties**: [AWS.S3/MultiRegionAccessPointPolicyProperties](#awss3multiregionaccesspointpolicyproperties) (Required, Identifier): properties of the resource ## Resource AWS.S3/StorageLens@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.S3/StorageLensProperties](#awss3storagelensproperties) (Required): properties of the resource +* **properties**: [AWS.S3/StorageLensProperties](#awss3storagelensproperties) (Required, Identifier): properties of the resource ## Resource AWS.S3/StorageLensGroup@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.S3/StorageLensGroupProperties](#awss3storagelensgroupproperties) (Required): properties of the resource +* **properties**: [AWS.S3/StorageLensGroupProperties](#awss3storagelensgroupproperties) (Required, Identifier): properties of the resource + +## AbortIncompleteMultipartUpload +### Properties +* **DaysAfterInitiation**: int (Required): Specifies the number of days after which Amazon S3 stops an incomplete multipart upload. + +## AccelerateConfiguration +### Properties +* **AccelerationStatus**: string (Required): Specifies the transfer acceleration status of the bucket. + +## AccessControlTranslation +### Properties +* **Owner**: string (Required): Specifies the replica ownership. For default and valid values, see [PUT bucket replication](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTreplication.html) in the *Amazon S3 API Reference*. + +## AccessGrantsLocationConfiguration +### Properties +* **S3SubPrefix**: string (Required): The S3 sub prefix of a registered location in your S3 Access Grants instance + +## AccessPoint_Policy +### Properties + +## AccountLevel +### Properties +* **ActivityMetrics**: [ActivityMetrics](#activitymetrics) +* **AdvancedCostOptimizationMetrics**: [AdvancedCostOptimizationMetrics](#advancedcostoptimizationmetrics) +* **AdvancedDataProtectionMetrics**: [AdvancedDataProtectionMetrics](#advanceddataprotectionmetrics) +* **BucketLevel**: [BucketLevel](#bucketlevel) (Required) +* **DetailedStatusCodesMetrics**: [DetailedStatusCodesMetrics](#detailedstatuscodesmetrics) +* **StorageLensGroupLevel**: [StorageLensGroupLevel](#storagelensgrouplevel) + +## ActivityMetrics +### Properties +* **IsEnabled**: bool: Specifies whether activity metrics are enabled or disabled. + +## AdvancedCostOptimizationMetrics +### Properties +* **IsEnabled**: bool: Specifies whether advanced cost optimization metrics are enabled or disabled. + +## AdvancedDataProtectionMetrics +### Properties +* **IsEnabled**: bool: Specifies whether advanced data protection metrics are enabled or disabled. + +## AnalyticsConfiguration +### Properties +* **Id**: string (Required): The ID that identifies the analytics configuration. +* **Prefix**: string: The prefix that an object must have to be included in the analytics results. +* **StorageClassAnalysis**: [StorageClassAnalysis](#storageclassanalysis) (Required): Contains data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes. +* **TagFilters**: [TagFilter](#tagfilter)[]: The tags to use when evaluating an analytics filter. + The analytics only includes objects that meet the filter's criteria. If no filter is specified, all of the contents of the bucket are included in the analysis. + +## And +### Properties +* **MatchAnyPrefix**: string[] +* **MatchAnySuffix**: string[] +* **MatchAnyTag**: [Tag](#tag)[] +* **MatchObjectAge**: [MatchObjectAge](#matchobjectage) +* **MatchObjectSize**: [MatchObjectSize](#matchobjectsize) ## AWS.S3/AccessGrantProperties ### Properties @@ -76,20 +132,6 @@ * **S3PrefixType**: string (WriteOnly): The type of S3SubPrefix. * **Tags**: [Tag](#tag)[] (WriteOnly) -## AccessGrantsLocationConfiguration -### Properties -* **S3SubPrefix**: string (Required): The S3 sub prefix of a registered location in your S3 Access Grants instance - -## Grantee -### Properties -* **GranteeIdentifier**: string (Required): The unique identifier of the Grantee -* **GranteeType**: string (Required): Configures the transfer acceleration state for an Amazon S3 bucket. - -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - ## AWS.S3/AccessGrantsInstanceProperties ### Properties * **AccessGrantsInstanceArn**: string (ReadOnly, Identifier): The Amazon Resource Name (ARN) of the specified Access Grants instance. @@ -97,11 +139,6 @@ * **IdentityCenterArn**: string: The Amazon Resource Name (ARN) of the specified AWS Identity Center. * **Tags**: [Tag](#tag)[] (WriteOnly) -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - ## AWS.S3/AccessGrantsLocationProperties ### Properties * **AccessGrantsLocationArn**: string (ReadOnly): The Amazon Resource Name (ARN) of the specified Access Grants location. @@ -110,11 +147,6 @@ * **LocationScope**: string: Descriptor for where the location actually points * **Tags**: [Tag](#tag)[] (WriteOnly) -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - ## AWS.S3/AccessPointProperties ### Properties * **Alias**: string (ReadOnly): The alias of this Access Point. This alias can be used for compatibility purposes with other AWS services and third-party applications. @@ -127,111 +159,168 @@ * **PublicAccessBlockConfiguration**: [PublicAccessBlockConfiguration](#publicaccessblockconfiguration): The PublicAccessBlock configuration that you want to apply to this Access Point. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status 'The Meaning of Public' in the Amazon Simple Storage Service Developer Guide. * **VpcConfiguration**: [VpcConfiguration](#vpcconfiguration): If you include this field, Amazon S3 restricts access to this Access Point to requests from the specified Virtual Private Cloud (VPC). -## AccessPoint_Policy -### Properties - -## PublicAccessBlockConfiguration -### Properties -* **BlockPublicAcls**: bool: Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in this account. Setting this element to TRUE causes the following behavior: -- PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public. - - PUT Object calls fail if the request includes a public ACL. -. - PUT Bucket calls fail if the request includes a public ACL. -Enabling this setting doesn't affect existing policies or ACLs. -* **BlockPublicPolicy**: bool: Specifies whether Amazon S3 should block public bucket policies for buckets in this account. Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access. Enabling this setting doesn't affect existing bucket policies. -* **IgnorePublicAcls**: bool: Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on buckets in this account and any objects that they contain. Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set. -* **RestrictPublicBuckets**: bool: Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting this element to TRUE restricts access to this bucket to only AWS services and authorized users within this account if the bucket has a public policy. -Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked. - -## VpcConfiguration +## AWS.S3/BucketPolicyProperties ### Properties -* **VpcId**: string: If this field is specified, this access point will only allow connections from the specified VPC ID. +* **Bucket**: string (Required, Identifier): The name of the Amazon S3 bucket to which the policy applies. +* **PolicyDocument**: [BucketPolicy_PolicyDocument](#bucketpolicypolicydocument) | string (Required): A policy document containing permissions to add to the specified 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. 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 Overview](https://docs.aws.amazon.com/AmazonS3/latest/dev/access-policy-language-overview.html) in the *Amazon S3 User Guide*. ## AWS.S3/BucketProperties ### Properties -* **AccelerateConfiguration**: [AccelerateConfiguration](#accelerateconfiguration): Configuration for the transfer acceleration state. -* **AccessControl**: string (WriteOnly): A canned access control list (ACL) that grants predefined permissions to the bucket. -* **AnalyticsConfigurations**: [AnalyticsConfiguration](#analyticsconfiguration)[]: The configuration and any analyses for the analytics filter of an Amazon S3 bucket. -* **Arn**: string (ReadOnly): The Amazon Resource Name (ARN) of the specified bucket. -* **BucketEncryption**: [BucketEncryption](#bucketencryption) -* **BucketName**: string (Identifier): A name for the bucket. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name. -* **CorsConfiguration**: [CorsConfiguration](#corsconfiguration): Rules that define cross-origin resource sharing of objects in this bucket. -* **DomainName**: string (ReadOnly): The IPv4 DNS name of the specified bucket. -* **DualStackDomainName**: string (ReadOnly): The IPv6 DNS name of the specified bucket. For more information about dual-stack endpoints, see [Using Amazon S3 Dual-Stack Endpoints](https://docs.aws.amazon.com/AmazonS3/latest/dev/dual-stack-endpoints.html). -* **IntelligentTieringConfigurations**: [IntelligentTieringConfiguration](#intelligenttieringconfiguration)[]: Specifies the S3 Intelligent-Tiering configuration for an Amazon S3 bucket. -* **InventoryConfigurations**: [InventoryConfiguration](#inventoryconfiguration)[]: The inventory configuration for an Amazon S3 bucket. -* **LifecycleConfiguration**: [LifecycleConfiguration](#lifecycleconfiguration): Rules that define how Amazon S3 manages objects during their lifetime. +* **AccelerateConfiguration**: [AccelerateConfiguration](#accelerateconfiguration): Configures the transfer acceleration state for an Amazon S3 bucket. For more information, see [Amazon S3 Transfer Acceleration](https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html) in the *Amazon S3 User Guide*. +* **AccessControl**: string (WriteOnly): This is a legacy property, and it is not recommended for most use cases. A majority of modern use cases in Amazon S3 no longer require the use of ACLs, and we recommend that you keep ACLs disabled. For more information, see [Controlling object ownership](https://docs.aws.amazon.com//AmazonS3/latest/userguide/about-object-ownership.html) in the *Amazon S3 User Guide*. + A canned access control list (ACL) that grants predefined permissions to the bucket. For more information about canned ACLs, see [Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) in the *Amazon S3 User Guide*. + S3 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 with any value other than Private. Use cases requiring ACLs are uncommon. + The majority of access control configurations can be successfully and more easily achieved 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 Server Access Logs buckets and more, see [Bucket policy examples](https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html) in the *Amazon S3 User Guide*. +* **AnalyticsConfigurations**: [AnalyticsConfiguration](#analyticsconfiguration)[]: Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket. +* **Arn**: string (ReadOnly) +* **BucketEncryption**: [BucketEncryption](#bucketencryption): Specifies default encryption for a bucket using server-side encryption with Amazon S3-managed keys (SSE-S3), AWS KMS-managed keys (SSE-KMS), or dual-layer server-side encryption with KMS-managed keys (DSSE-KMS). For information about the Amazon S3 default encryption feature, see [Amazon S3 Default Encryption for S3 Buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html) in the *Amazon S3 User Guide*. +* **BucketName**: string (Identifier): A name for the bucket. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the bucket name. The bucket name must contain only lowercase letters, numbers, periods (.), and dashes (-) and must follow [Amazon S3 bucket restrictions and limitations](https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html). For more information, see [Rules for naming Amazon S3 buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html#bucketnamingrules) in the *Amazon S3 User Guide*. + If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you need to replace the resource, specify a new name. +* **CorsConfiguration**: [CorsConfiguration](#corsconfiguration): Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see [Enabling Cross-Origin Resource Sharing](https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) in the *Amazon S3 User Guide*. +* **DomainName**: string (ReadOnly) +* **DualStackDomainName**: string (ReadOnly) +* **IntelligentTieringConfigurations**: [IntelligentTieringConfiguration](#intelligenttieringconfiguration)[]: Defines how Amazon S3 handles Intelligent-Tiering storage. +* **InventoryConfigurations**: [InventoryConfiguration](#inventoryconfiguration)[]: Specifies the inventory configuration for an Amazon S3 bucket. For more information, see [GET Bucket inventory](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETInventoryConfig.html) in the *Amazon S3 API Reference*. +* **LifecycleConfiguration**: [LifecycleConfiguration](#lifecycleconfiguration): Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more information, see [Object Lifecycle Management](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) in the *Amazon S3 User Guide*. * **LoggingConfiguration**: [LoggingConfiguration](#loggingconfiguration): Settings that define where logs are stored. -* **MetricsConfigurations**: [MetricsConfiguration](#metricsconfiguration)[]: Settings that define a metrics configuration for the CloudWatch request metrics from the bucket. +* **MetricsConfigurations**: [MetricsConfiguration](#metricsconfiguration)[]: Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased. For more information, see [PutBucketMetricsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTMetricConfiguration.html). * **NotificationConfiguration**: [NotificationConfiguration](#notificationconfiguration): Configuration that defines how Amazon S3 handles bucket notifications. -* **ObjectLockConfiguration**: [ObjectLockConfiguration](#objectlockconfiguration): Places an Object Lock configuration on the specified bucket. -* **ObjectLockEnabled**: bool: Indicates whether this bucket has an Object Lock configuration enabled. -* **OwnershipControls**: [OwnershipControls](#ownershipcontrols): Specifies the container element for object ownership rules. -* **PublicAccessBlockConfiguration**: [PublicAccessBlockConfiguration](#publicaccessblockconfiguration) -* **RegionalDomainName**: string (ReadOnly): Returns the regional domain name of the specified bucket. -* **ReplicationConfiguration**: [ReplicationConfiguration](#replicationconfiguration): Configuration for replicating objects in an S3 bucket. +* **ObjectLockConfiguration**: [ObjectLockConfiguration](#objectlockconfiguration): This operation is not supported by directory buckets. + Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see [Locking Objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html). + + The ``DefaultRetention`` settings require both a mode and a period. + + The ``DefaultRetention`` period can be either ``Days`` or ``Years`` but you must select one. You cannot specify ``Days`` and ``Years`` at the same time. + + You can enable Object Lock for new or existing buckets. For more information, see [Configuring Object Lock](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-configure.html). +* **ObjectLockEnabled**: bool: Indicates whether this bucket has an Object Lock configuration enabled. Enable ``ObjectLockEnabled`` when you apply ``ObjectLockConfiguration`` to a bucket. +* **OwnershipControls**: [OwnershipControls](#ownershipcontrols): Configuration that defines how Amazon S3 handles Object Ownership rules. +* **PublicAccessBlockConfiguration**: [PublicAccessBlockConfiguration](#publicaccessblockconfiguration): Configuration that defines how Amazon S3 handles public access. +* **RegionalDomainName**: string (ReadOnly) +* **ReplicationConfiguration**: [ReplicationConfiguration](#replicationconfiguration): Configuration for replicating objects in an S3 bucket. To enable replication, you must also enable versioning by using the ``VersioningConfiguration`` property. + Amazon S3 can store replicated objects in a single destination bucket or multiple destination buckets. The destination bucket or buckets must already exist. * **Tags**: [Tag](#tag)[]: An arbitrary set of tags (key-value pairs) for this S3 bucket. -* **VersioningConfiguration**: [VersioningConfiguration](#versioningconfiguration) -* **WebsiteConfiguration**: [WebsiteConfiguration](#websiteconfiguration) -* **WebsiteURL**: string (ReadOnly): The Amazon S3 website endpoint for the specified bucket. +* **VersioningConfiguration**: [VersioningConfiguration](#versioningconfiguration): Enables multiple versions of all objects in this bucket. You might enable versioning to prevent objects from being deleted or overwritten by mistake or to archive objects so that you can retrieve previous versions of them. +* **WebsiteConfiguration**: [WebsiteConfiguration](#websiteconfiguration): Information used to configure the bucket as a static website. For more information, see [Hosting Websites on Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html). +* **WebsiteURL**: string (ReadOnly) -## AccelerateConfiguration +## AWS.S3/MultiRegionAccessPointPolicyProperties ### Properties -* **AccelerationStatus**: string (Required): Configures the transfer acceleration state for an Amazon S3 bucket. +* **MrapName**: string (Required, Identifier): The name of the Multi Region Access Point to apply policy +* **Policy**: [MultiRegionAccessPointPolicy_Policy](#multiregionaccesspointpolicypolicy) (Required): Policy document to apply to a Multi Region Access Point +* **PolicyStatus**: [MultiRegionAccessPointPolicy_PolicyStatus](#multiregionaccesspointpolicypolicystatus) (ReadOnly): The Policy Status associated with this Multi Region Access Point -## AnalyticsConfiguration +## AWS.S3/StorageLensGroupProperties ### Properties -* **Id**: string (Required): The ID that identifies the analytics configuration. -* **Prefix**: string: The prefix that an object must have to be included in the analytics results. -* **StorageClassAnalysis**: [StorageClassAnalysis](#storageclassanalysis) (Required) -* **TagFilters**: [TagFilter](#tagfilter)[] +* **Filter**: [Filter](#filter) (Required) +* **Name**: string (Required, Identifier) +* **StorageLensGroupArn**: string (ReadOnly): The ARN for the Amazon S3 Storage Lens Group. +* **Tags**: [Tag](#tag)[]: A set of tags (key-value pairs) for this Amazon S3 Storage Lens Group. -## StorageClassAnalysis +## AWS.S3/StorageLensProperties ### Properties -* **DataExport**: [DataExport](#dataexport) +* **StorageLensConfiguration**: [StorageLensConfiguration](#storagelensconfiguration) (Required) +* **Tags**: [Tag](#tag)[]: A set of tags (key-value pairs) for this Amazon S3 Storage Lens configuration. + +## AwsOrg +### Properties +* **Arn**: string (Required) + +## BucketEncryption +### Properties +* **ServerSideEncryptionConfiguration**: [ServerSideEncryptionRule](#serversideencryptionrule)[] (Required): Specifies the default server-side-encryption configuration. + +## BucketLevel +### Properties +* **ActivityMetrics**: [ActivityMetrics](#activitymetrics) +* **AdvancedCostOptimizationMetrics**: [AdvancedCostOptimizationMetrics](#advancedcostoptimizationmetrics) +* **AdvancedDataProtectionMetrics**: [AdvancedDataProtectionMetrics](#advanceddataprotectionmetrics) +* **DetailedStatusCodesMetrics**: [DetailedStatusCodesMetrics](#detailedstatuscodesmetrics) +* **PrefixLevel**: [PrefixLevel](#prefixlevel) + +## BucketsAndRegions +### Properties +* **Buckets**: string[] +* **Regions**: string[] + +## CloudWatchMetrics +### Properties +* **IsEnabled**: bool (Required): Specifies whether CloudWatch metrics are enabled or disabled. + +## CorsConfiguration +### Properties +* **CorsRules**: [CorsRule](#corsrule)[] (Required): A set of origins and methods (cross-origin access that you want to allow). You can add up to 100 rules to the configuration. + +## CorsRule +### Properties +* **AllowedHeaders**: string[]: Headers that are specified in the ``Access-Control-Request-Headers`` header. These headers are allowed in a preflight OPTIONS request. In response to any preflight OPTIONS request, Amazon S3 returns any requested headers that are allowed. +* **AllowedMethods**: string[] (Required): An HTTP method that you allow the origin to run. + *Allowed values*: ``GET`` | ``PUT`` | ``HEAD`` | ``POST`` | ``DELETE`` +* **AllowedOrigins**: string[] (Required): One or more origins you want customers to be able to access the bucket from. +* **ExposedHeaders**: string[]: One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript ``XMLHttpRequest`` object). +* **Id**: string: A unique identifier for this rule. The value must be no more than 255 characters. +* **MaxAge**: int: The time in seconds that your browser is to cache the preflight response for the specified resource. ## DataExport ### Properties -* **Destination**: [Destination](#destination) (Required) -* **OutputSchemaVersion**: string (Required): The version of the output schema to use when exporting data. +* **Destination**: [Destination](#destination) (Required): The place to store the data for an analysis. +* **OutputSchemaVersion**: string (Required): The version of the output schema to use when exporting data. Must be ``V_1``. + +## DataExport +### Properties +* **CloudWatchMetrics**: [CloudWatchMetrics](#cloudwatchmetrics) +* **S3BucketDestination**: [S3BucketDestination](#s3bucketdestination) + +## DefaultRetention +### Properties +* **Days**: int: The number of days that you want to specify for the default retention period. If Object Lock is turned on, you must specify ``Mode`` and specify either ``Days`` or ``Years``. +* **Mode**: string: The default Object Lock retention mode you want to apply to new objects placed in the specified bucket. If Object Lock is turned on, you must specify ``Mode`` and specify either ``Days`` or ``Years``. +* **Years**: int: The number of years that you want to specify for the default retention period. If Object Lock is turned on, you must specify ``Mode`` and specify either ``Days`` or ``Years``. + +## DeleteMarkerReplication +### Properties +* **Status**: string: Indicates whether to replicate delete markers. Disabled by default. ## Destination ### Properties -* **BucketAccountId**: string: The account ID that owns the destination S3 bucket. +* **BucketAccountId**: string: The account ID that owns the destination S3 bucket. If no account ID is provided, the owner is not validated before exporting data. + Although this value is optional, we strongly recommend that you set it to help prevent problems if the destination bucket ownership changes. * **BucketArn**: string (Required): The Amazon Resource Name (ARN) of the bucket to which data is exported. * **Format**: string (Required): Specifies the file format used when exporting data to Amazon S3. + *Allowed values*: ``CSV`` | ``ORC`` | ``Parquet`` * **Prefix**: string: The prefix to use when exporting data. The prefix is prepended to all results. -## TagFilter +## DetailedStatusCodesMetrics ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **IsEnabled**: bool: Specifies whether detailed status codes metrics are enabled or disabled. -## BucketEncryption +## Encryption ### Properties -* **ServerSideEncryptionConfiguration**: [ServerSideEncryptionRule](#serversideencryptionrule)[] (Required): Specifies the default server-side-encryption configuration. -## ServerSideEncryptionRule +## EncryptionConfiguration ### Properties -* **BucketKeyEnabled**: bool: Specifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS (SSE-KMS) for new objects in the bucket. Existing objects are not affected. Setting the BucketKeyEnabled element to true causes Amazon S3 to use an S3 Bucket Key. By default, S3 Bucket Key is not enabled. -* **ServerSideEncryptionByDefault**: [ServerSideEncryptionByDefault](#serversideencryptionbydefault) +* **ReplicaKmsKeyID**: string (Required): Specifies the ID (Key ARN or Alias ARN) of the customer managed AWS KMS key stored in AWS Key Management Service (KMS) for the destination bucket. Amazon S3 uses this key to encrypt replica objects. Amazon S3 only supports symmetric encryption KMS keys. For more information, see [Asymmetric keys in KMS](https://docs.aws.amazon.com//kms/latest/developerguide/symmetric-asymmetric.html) in the *Key Management Service Developer Guide*. -## ServerSideEncryptionByDefault +## EventBridgeConfiguration ### Properties -* **KMSMasterKeyID**: string: "KMSMasterKeyID" can only be used when you set the value of SSEAlgorithm as aws:kms or aws:kms:dsse. -* **SSEAlgorithm**: string (Required) +* **EventBridgeEnabled**: bool (Required): Enables delivery of events to Amazon EventBridge. -## CorsConfiguration +## Filter ### Properties -* **CorsRules**: [CorsRule](#corsrule)[] (Required) +* **And**: [And](#and) +* **MatchAnyPrefix**: string[] +* **MatchAnySuffix**: string[] +* **MatchAnyTag**: [Tag](#tag)[] +* **MatchObjectAge**: [MatchObjectAge](#matchobjectage) +* **MatchObjectSize**: [MatchObjectSize](#matchobjectsize) +* **Or**: [Or](#or) -## CorsRule +## FilterRule ### Properties -* **AllowedHeaders**: string[]: Headers that are specified in the Access-Control-Request-Headers header. -* **AllowedMethods**: string[] (Required): An HTTP method that you allow the origin to execute. -* **AllowedOrigins**: string[] (Required): One or more origins you want customers to be able to access the bucket from. -* **ExposedHeaders**: string[]: One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object). -* **Id**: string: A unique identifier for this rule. -* **MaxAge**: int: The time in seconds that your browser is to cache the preflight response for the specified resource. +* **Name**: string (Required): The object key name prefix or suffix identifying one or more objects to which the filtering rule applies. The maximum length is 1,024 characters. Overlapping prefixes and suffixes are not supported. For more information, see [Configuring Event Notifications](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the *Amazon S3 User Guide*. +* **Value**: string (Required): The value that the filter searches for in object key names. + +## Grantee +### Properties +* **GranteeIdentifier**: string (Required): The unique identifier of the Grantee +* **GranteeType**: string (Required): Configures the transfer acceleration state for an Amazon S3 bucket. ## IntelligentTieringConfiguration ### Properties @@ -239,298 +328,313 @@ Enabling this setting doesn't affect previously stored bucket policies, except t * **Prefix**: string: An object key name prefix that identifies the subset of objects to which the rule applies. * **Status**: string (Required): Specifies the status of the configuration. * **TagFilters**: [TagFilter](#tagfilter)[]: A container for a key-value pair. -* **Tierings**: [Tiering](#tiering)[] (Required): Specifies a list of S3 Intelligent-Tiering storage class tiers in the configuration. At least one tier must be defined in the list. At most, you can specify two tiers in the list, one for each available AccessTier: ARCHIVE_ACCESS and DEEP_ARCHIVE_ACCESS. - -## Tiering -### Properties -* **AccessTier**: string (Required): S3 Intelligent-Tiering access tier. See Storage class for automatically optimizing frequently and infrequently accessed objects for a list of access tiers in the S3 Intelligent-Tiering storage class. -* **Days**: int (Required): The number of consecutive days of no access after which an object will be eligible to be transitioned to the corresponding tier. The minimum number of days specified for Archive Access tier must be at least 90 days and Deep Archive Access tier must be at least 180 days. The maximum can be up to 2 years (730 days). +* **Tierings**: [Tiering](#tiering)[] (Required): Specifies a list of S3 Intelligent-Tiering storage class tiers in the configuration. At least one tier must be defined in the list. At most, you can specify two tiers in the list, one for each available AccessTier: ``ARCHIVE_ACCESS`` and ``DEEP_ARCHIVE_ACCESS``. + You only need Intelligent Tiering Configuration enabled on a bucket if you want to automatically move objects stored in the Intelligent-Tiering storage class to Archive Access or Deep Archive Access tiers. ## InventoryConfiguration ### Properties -* **Destination**: [Destination](#destination) (Required) -* **Enabled**: bool (Required): Specifies whether the inventory is enabled or disabled. +* **Destination**: [Destination](#destination) (Required): Contains information about where to publish the inventory results. +* **Enabled**: bool (Required): Specifies whether the inventory is enabled or disabled. If set to ``True``, an inventory list is generated. If set to ``False``, no inventory list is generated. * **Id**: string (Required): The ID used to identify the inventory configuration. -* **IncludedObjectVersions**: string (Required): Object versions to include in the inventory list. +* **IncludedObjectVersions**: string (Required): Object versions to include in the inventory list. If set to ``All``, the list includes all the object versions, which adds the version-related fields ``VersionId``, ``IsLatest``, and ``DeleteMarker`` to the list. If set to ``Current``, the list does not contain these version-related fields. * **OptionalFields**: string[]: Contains the optional fields that are included in the inventory results. -* **Prefix**: string: The prefix that is prepended to all inventory results. +* **Prefix**: string: Specifies the inventory filter prefix. * **ScheduleFrequency**: string (Required): Specifies the schedule for generating inventory results. -## LifecycleConfiguration -### Properties -* **Rules**: [Rule](#rule)[] (Required, WriteOnly): A lifecycle rule for individual objects in an Amazon S3 bucket. - -## Rule -### Properties -* **AbortIncompleteMultipartUpload**: [AbortIncompleteMultipartUpload](#abortincompletemultipartupload) -* **ExpirationDate**: string -* **ExpirationInDays**: int -* **ExpiredObjectDeleteMarker**: bool -* **Id**: string -* **NoncurrentVersionExpiration**: [NoncurrentVersionExpiration](#noncurrentversionexpiration) -* **NoncurrentVersionExpirationInDays**: int -* **NoncurrentVersionTransition**: [NoncurrentVersionTransition](#noncurrentversiontransition) -* **NoncurrentVersionTransitions**: [NoncurrentVersionTransition](#noncurrentversiontransition)[] -* **ObjectSizeGreaterThan**: string -* **ObjectSizeLessThan**: string -* **Prefix**: string -* **Status**: string (Required) -* **TagFilters**: [TagFilter](#tagfilter)[] -* **Transition**: [Transition](#transition) -* **Transitions**: [Transition](#transition)[] - -## AbortIncompleteMultipartUpload -### Properties -* **DaysAfterInitiation**: int (Required): Specifies the number of days after which Amazon S3 aborts an incomplete multipart upload. - -## NoncurrentVersionExpiration -### Properties -* **NewerNoncurrentVersions**: int: Specified the number of newer noncurrent and current versions that must exists before performing the associated action -* **NoncurrentDays**: int (Required): Specified the number of days an object is noncurrent before Amazon S3 can perform the associated action - -## NoncurrentVersionTransition +## LambdaConfiguration ### Properties -* **NewerNoncurrentVersions**: int: Specified the number of newer noncurrent and current versions that must exists before performing the associated action -* **StorageClass**: string (Required): The class of storage used to store the object. -* **TransitionInDays**: int (Required): Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. +* **Event**: string (Required): The Amazon S3 bucket event for which to invoke the LAMlong function. For more information, see [Supported Event Types](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the *Amazon S3 User Guide*. +* **Filter**: [NotificationFilter](#notificationfilter): The filtering rules that determine which objects invoke the AWS Lambda function. For example, you can create a filter so that only image files with a ``.jpg`` extension invoke the function when they are added to the Amazon S3 bucket. +* **Function**: string (Required): The Amazon Resource Name (ARN) of the LAMlong function that Amazon S3 invokes when the specified event type occurs. -## Transition +## LifecycleConfiguration ### Properties -* **StorageClass**: string (Required) -* **TransitionDate**: string -* **TransitionInDays**: int +* **Rules**: [Rule](#rule)[] (Required, WriteOnly): A lifecycle rule for individual objects in an Amazon S3 bucket. ## LoggingConfiguration ### Properties -* **DestinationBucketName**: string: The name of an Amazon S3 bucket where Amazon S3 store server access log files. You can store log files in any bucket that you own. By default, logs are stored in the bucket where the LoggingConfiguration property is defined. -* **LogFilePrefix**: string -* **TargetObjectKeyFormat**: [TargetObjectKeyFormat](#targetobjectkeyformat) +* **DestinationBucketName**: string: The name of the bucket where Amazon S3 should store server access log files. You can store log files in any bucket that you own. By default, logs are stored in the bucket where the ``LoggingConfiguration`` property is defined. +* **LogFilePrefix**: string: A prefix for all log object keys. If you store log files from multiple Amazon S3 buckets in a single bucket, you can use a prefix to distinguish which log files came from which bucket. +* **TargetObjectKeyFormat**: [TargetObjectKeyFormat](#targetobjectkeyformat): Amazon S3 key format for log objects. Only one format, either PartitionedPrefix or SimplePrefix, is allowed. -## TargetObjectKeyFormat +## MatchObjectAge ### Properties +* **DaysGreaterThan**: int: Minimum object age to which the rule applies. +* **DaysLessThan**: int: Maximum object age to which the rule applies. -## MetricsConfiguration +## MatchObjectSize ### Properties -* **AccessPointArn**: string -* **Id**: string (Required) -* **Prefix**: string -* **TagFilters**: [TagFilter](#tagfilter)[] +* **BytesGreaterThan**: int: Minimum object size to which the rule applies. +* **BytesLessThan**: int: Maximum object size to which the rule applies. -## NotificationConfiguration +## Metrics ### Properties -* **EventBridgeConfiguration**: [EventBridgeConfiguration](#eventbridgeconfiguration) -* **LambdaConfigurations**: [LambdaConfiguration](#lambdaconfiguration)[] -* **QueueConfigurations**: [QueueConfiguration](#queueconfiguration)[] -* **TopicConfigurations**: [TopicConfiguration](#topicconfiguration)[] +* **EventThreshold**: [ReplicationTimeValue](#replicationtimevalue): A container specifying the time threshold for emitting the ``s3:Replication:OperationMissedThreshold`` event. +* **Status**: string (Required): Specifies whether the replication metrics are enabled. -## EventBridgeConfiguration +## MetricsConfiguration ### Properties -* **EventBridgeEnabled**: bool (Required): Specifies whether to send notifications to Amazon EventBridge when events occur in an Amazon S3 bucket. +* **AccessPointArn**: string: The access point that was used while performing operations on the object. The metrics configuration only includes objects that meet the filter's criteria. +* **Id**: string (Required): The ID used to identify the metrics configuration. This can be any value you choose that helps you identify your metrics configuration. +* **Prefix**: string: The prefix that an object must have to be included in the metrics results. +* **TagFilters**: [TagFilter](#tagfilter)[]: Specifies a list of tag filters to use as a metrics configuration filter. The metrics configuration includes only objects that meet the filter's criteria. -## LambdaConfiguration +## MultiRegionAccessPointPolicy_Policy ### Properties -* **Event**: string (Required): The Amazon S3 bucket event for which to invoke the AWS Lambda function. -* **Filter**: [NotificationFilter](#notificationfilter): The filtering rules that determine which objects invoke the AWS Lambda function. -* **Function**: string (Required): The Amazon Resource Name (ARN) of the AWS Lambda function that Amazon S3 invokes when the specified event type occurs. -## NotificationFilter +## MultiRegionAccessPointPolicy_PolicyStatus ### Properties -* **S3Key**: [S3KeyFilter](#s3keyfilter) (Required) +* **IsPublic**: string (Required, ReadOnly): Specifies whether the policy is public or not. -## S3KeyFilter +## NoncurrentVersionExpiration ### Properties -* **Rules**: [FilterRule](#filterrule)[] (Required) +* **NewerNoncurrentVersions**: int: Specifies how many noncurrent versions S3 will retain. If there are this many more recent noncurrent versions, S3 will take the associated action. For more information about noncurrent versions, see [Lifecycle configuration elements](https://docs.aws.amazon.com/AmazonS3/latest/userguide/intro-lifecycle-rules.html) in the *Amazon S3 User Guide*. +* **NoncurrentDays**: int (Required): Specifies the number of days an object is noncurrent before S3 can perform the associated action. For information about the noncurrent days calculations, see [How Amazon 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 User Guide*. -## FilterRule +## NoncurrentVersionTransition ### Properties -* **Name**: string (Required) -* **Value**: string (Required) +* **NewerNoncurrentVersions**: int: Specifies how many noncurrent versions S3 will retain. If there are this many more recent noncurrent versions, S3 will take the associated action. For more information about noncurrent versions, see [Lifecycle configuration elements](https://docs.aws.amazon.com/AmazonS3/latest/userguide/intro-lifecycle-rules.html) in the *Amazon S3 User Guide*. +* **StorageClass**: string (Required): The class of storage used to store the object. +* **TransitionInDays**: int (Required): Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see [How Amazon S3 Calculates How 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*. -## QueueConfiguration +## NotificationConfiguration ### Properties -* **Event**: string (Required): The Amazon S3 bucket event about which you want to publish messages to Amazon SQS. -* **Filter**: [NotificationFilter](#notificationfilter): The filtering rules that determine which objects trigger notifications. -* **Queue**: string (Required): The Amazon Resource Name (ARN) of the Amazon SQS queue to which Amazon S3 publishes a message when it detects events of the specified type. +* **EventBridgeConfiguration**: [EventBridgeConfiguration](#eventbridgeconfiguration): Enables delivery of events to Amazon EventBridge. +* **LambdaConfigurations**: [LambdaConfiguration](#lambdaconfiguration)[]: Describes the LAMlong functions to invoke and the events for which to invoke them. +* **QueueConfigurations**: [QueueConfiguration](#queueconfiguration)[]: The Amazon Simple Queue Service queues to publish messages to and the events for which to publish messages. +* **TopicConfigurations**: [TopicConfiguration](#topicconfiguration)[]: The topic to which notifications are sent and the events for which notifications are generated. -## TopicConfiguration +## NotificationFilter ### Properties -* **Event**: string (Required): The Amazon S3 bucket event about which to send notifications. -* **Filter**: [NotificationFilter](#notificationfilter): The filtering rules that determine for which objects to send notifications. -* **Topic**: string (Required): The Amazon Resource Name (ARN) of the Amazon SNS topic to which Amazon S3 publishes a message when it detects events of the specified type. +* **S3Key**: [S3KeyFilter](#s3keyfilter) (Required): A container for object key name prefix and suffix filtering rules. ## ObjectLockConfiguration ### Properties -* **ObjectLockEnabled**: string -* **Rule**: [ObjectLockRule](#objectlockrule) +* **ObjectLockEnabled**: string: Indicates whether this bucket has an Object Lock configuration enabled. Enable ``ObjectLockEnabled`` when you apply ``ObjectLockConfiguration`` to a bucket. +* **Rule**: [ObjectLockRule](#objectlockrule): Specifies the Object Lock rule for the specified object. Enable this rule when you apply ``ObjectLockConfiguration`` to a bucket. If Object Lock is turned on, bucket settings require both ``Mode`` and a period of either ``Days`` or ``Years``. You cannot specify ``Days`` and ``Years`` at the same time. For more information, see [ObjectLockRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-objectlockrule.html) and [DefaultRetention](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-defaultretention.html). ## ObjectLockRule ### Properties -* **DefaultRetention**: [DefaultRetention](#defaultretention) +* **DefaultRetention**: [DefaultRetention](#defaultretention): The default Object Lock retention mode and period that you want to apply to new objects placed in the specified bucket. If Object Lock is turned on, bucket settings require both ``Mode`` and a period of either ``Days`` or ``Years``. You cannot specify ``Days`` and ``Years`` at the same time. For more information about allowable values for mode and period, see [DefaultRetention](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-defaultretention.html). -## DefaultRetention +## Or ### Properties -* **Days**: int -* **Mode**: string -* **Years**: int +* **MatchAnyPrefix**: string[] +* **MatchAnySuffix**: string[] +* **MatchAnyTag**: [Tag](#tag)[] +* **MatchObjectAge**: [MatchObjectAge](#matchobjectage) +* **MatchObjectSize**: [MatchObjectSize](#matchobjectsize) ## OwnershipControls ### Properties -* **Rules**: [OwnershipControlsRule](#ownershipcontrolsrule)[] (Required) +* **Rules**: [OwnershipControlsRule](#ownershipcontrolsrule)[] (Required): Specifies the container element for Object Ownership rules. ## OwnershipControlsRule ### Properties * **ObjectOwnership**: string: Specifies an object ownership rule. +## PrefixLevel +### Properties +* **StorageMetrics**: [PrefixLevelStorageMetrics](#prefixlevelstoragemetrics) (Required) + +## PrefixLevelStorageMetrics +### Properties +* **IsEnabled**: bool: Specifies whether prefix-level storage metrics are enabled or disabled. +* **SelectionCriteria**: [SelectionCriteria](#selectioncriteria) + ## PublicAccessBlockConfiguration ### Properties -* **BlockPublicAcls**: bool: Specifies whether Amazon S3 should block public access control lists (ACLs) for this bucket and objects in this bucket. Setting this element to TRUE causes the following behavior: +* **BlockPublicAcls**: bool: Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in this account. Setting this element to TRUE causes the following behavior: - PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public. - PUT Object calls fail if the request includes a public ACL. +. - PUT Bucket calls fail if the request includes a public ACL. Enabling this setting doesn't affect existing policies or ACLs. -* **BlockPublicPolicy**: bool: Specifies whether Amazon S3 should block public bucket policies for this bucket. Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access. -Enabling this setting doesn't affect existing bucket policies. -* **IgnorePublicAcls**: bool: Specifies whether Amazon S3 should ignore public ACLs for this bucket and objects in this bucket. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on this bucket and objects in this bucket. -Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set. +* **BlockPublicPolicy**: bool: Specifies whether Amazon S3 should block public bucket policies for buckets in this account. Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access. Enabling this setting doesn't affect existing bucket policies. +* **IgnorePublicAcls**: bool: Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on buckets in this account and any objects that they contain. Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set. * **RestrictPublicBuckets**: bool: Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting this element to TRUE restricts access to this bucket to only AWS services and authorized users within this account if the bucket has a public policy. Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked. -## ReplicationConfiguration -### Properties -* **Role**: string (Required): The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that Amazon S3 assumes when replicating objects. -* **Rules**: [ReplicationRule](#replicationrule)[] (Required, WriteOnly): A container for one or more replication rules. - -## ReplicationRule -### Properties -* **DeleteMarkerReplication**: [DeleteMarkerReplication](#deletemarkerreplication) -* **Destination**: [ReplicationDestination](#replicationdestination) (Required) -* **Filter**: [ReplicationRuleFilter](#replicationrulefilter) -* **Id**: string: A unique identifier for the rule. -* **Prefix**: string: An object key name prefix that identifies the object or objects to which the rule applies. -* **Priority**: int -* **SourceSelectionCriteria**: [SourceSelectionCriteria](#sourceselectioncriteria) -* **Status**: string (Required): Specifies whether the rule is enabled. - -## DeleteMarkerReplication +## PublicAccessBlockConfiguration ### Properties -* **Status**: string +* **BlockPublicAcls**: bool: Specifies whether Amazon S3 should block public access control lists (ACLs) for this bucket and objects in this bucket. Setting this element to ``TRUE`` causes the following behavior: + + PUT Bucket ACL and PUT Object ACL calls fail if the specified ACL is public. + + PUT Object calls fail if the request includes a public ACL. + + PUT Bucket calls fail if the request includes a public ACL. + + Enabling this setting doesn't affect existing policies or ACLs. +* **BlockPublicPolicy**: bool: Specifies whether Amazon S3 should block public bucket policies for this bucket. Setting this element to ``TRUE`` causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access. + Enabling this setting doesn't affect existing bucket policies. +* **IgnorePublicAcls**: bool: Specifies whether Amazon S3 should ignore public ACLs for this bucket and objects in this bucket. Setting this element to ``TRUE`` causes Amazon S3 to ignore all public ACLs on this bucket and objects in this bucket. + Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set. +* **RestrictPublicBuckets**: bool: Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting this element to ``TRUE`` restricts access to this bucket to only AWS-service principals and authorized users within this account if the bucket has a public policy. + Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked. -## ReplicationDestination +## QueueConfiguration ### Properties -* **AccessControlTranslation**: [AccessControlTranslation](#accesscontroltranslation) -* **Account**: string -* **Bucket**: string (Required) -* **EncryptionConfiguration**: [EncryptionConfiguration](#encryptionconfiguration) -* **Metrics**: [Metrics](#metrics) -* **ReplicationTime**: [ReplicationTime](#replicationtime) -* **StorageClass**: string: The storage class to use when replicating objects, such as S3 Standard or reduced redundancy. +* **Event**: string (Required): The Amazon S3 bucket event about which you want to publish messages to Amazon SQS. For more information, see [Supported Event Types](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the *Amazon S3 User Guide*. +* **Filter**: [NotificationFilter](#notificationfilter): The filtering rules that determine which objects trigger notifications. For example, you can create a filter so that Amazon S3 sends notifications only when image files with a ``.jpg`` extension are added to the bucket. For more information, see [Configuring event notifications using object key name filtering](https://docs.aws.amazon.com/AmazonS3/latest/user-guide/notification-how-to-filtering.html) in the *Amazon S3 User Guide*. +* **Queue**: string (Required): The Amazon Resource Name (ARN) of the Amazon SQS queue to which Amazon S3 publishes a message when it detects events of the specified type. FIFO queues are not allowed when enabling an SQS queue as the event notification destination. -## AccessControlTranslation +## RedirectAllRequestsTo ### Properties -* **Owner**: string (Required) +* **HostName**: string (Required): Name of the host where requests are redirected. +* **Protocol**: string: Protocol to use when redirecting requests. The default is the protocol that is used in the original request. -## EncryptionConfiguration +## RedirectRule ### Properties -* **ReplicaKmsKeyID**: string (Required): Specifies the ID (Key ARN or Alias ARN) of the customer managed customer master key (CMK) stored in AWS Key Management Service (KMS) for the destination bucket. +* **HostName**: string: The host name to use in the redirect request. +* **HttpRedirectCode**: string: The HTTP redirect code to use on the response. Not required if one of the siblings is present. +* **Protocol**: string: Protocol to use when redirecting requests. The default is the protocol that is used in the original request. +* **ReplaceKeyPrefixWith**: string: The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix ``docs/`` (objects in the ``docs/`` folder) to ``documents/``, you can set a condition block with ``KeyPrefixEquals`` set to ``docs/`` and in the Redirect set ``ReplaceKeyPrefixWith`` to ``/documents``. Not required if one of the siblings is present. Can be present only if ``ReplaceKeyWith`` is not provided. + Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints). +* **ReplaceKeyWith**: string: The specific object key to use in the redirect request. For example, redirect request to ``error.html``. Not required if one of the siblings is present. Can be present only if ``ReplaceKeyPrefixWith`` is not provided. + Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints). -## Metrics +## ReplicaModifications ### Properties -* **EventThreshold**: [ReplicationTimeValue](#replicationtimevalue) -* **Status**: string (Required) +* **Status**: string (Required): Specifies whether Amazon S3 replicates modifications on replicas. + *Allowed values*: ``Enabled`` | ``Disabled`` -## ReplicationTimeValue +## ReplicationConfiguration ### Properties -* **Minutes**: int (Required) +* **Role**: string (Required): The Amazon Resource Name (ARN) of the IAMlong (IAM) role that Amazon S3 assumes when replicating objects. For more information, see [How to Set Up Replication](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-how-setup.html) in the *Amazon S3 User Guide*. +* **Rules**: [ReplicationRule](#replicationrule)[] (Required, WriteOnly): A container for one or more replication rules. A replication configuration must have at least one rule and can contain a maximum of 1,000 rules. -## ReplicationTime +## ReplicationDestination ### Properties -* **Status**: string (Required) -* **Time**: [ReplicationTimeValue](#replicationtimevalue) (Required) +* **AccessControlTranslation**: [AccessControlTranslation](#accesscontroltranslation): Specify this only in a cross-account scenario (where source and destination bucket owners are not the same), and you want to change replica ownership to the AWS-account that owns the destination bucket. If this is not specified in the replication configuration, the replicas are owned by same AWS-account that owns the source object. +* **Account**: string: Destination bucket owner account ID. In a cross-account scenario, if you direct Amazon S3 to change replica ownership to the AWS-account that owns the destination bucket by specifying the ``AccessControlTranslation`` property, this is the account ID of the destination bucket owner. For more information, see [Cross-Region Replication Additional Configuration: Change Replica Owner](https://docs.aws.amazon.com/AmazonS3/latest/dev/crr-change-owner.html) in the *Amazon S3 User Guide*. + If you specify the ``AccessControlTranslation`` property, the ``Account`` property is required. +* **Bucket**: string (Required): The Amazon Resource Name (ARN) of the bucket where you want Amazon S3 to store the results. +* **EncryptionConfiguration**: [EncryptionConfiguration](#encryptionconfiguration): Specifies encryption-related information. +* **Metrics**: [Metrics](#metrics): A container specifying replication metrics-related settings enabling replication metrics and events. +* **ReplicationTime**: [ReplicationTime](#replicationtime): A container specifying S3 Replication Time Control (S3 RTC), including whether S3 RTC is enabled and the time when all objects and operations on objects must be replicated. Must be specified together with a ``Metrics`` block. +* **StorageClass**: string: The storage class to use when replicating objects, such as S3 Standard or reduced redundancy. By default, Amazon S3 uses the storage class of the source object to create the object replica. + For valid values, see the ``StorageClass`` element of the [PUT Bucket replication](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTreplication.html) action in the *Amazon S3 API Reference*. -## ReplicationRuleFilter +## ReplicationRule ### Properties -* **And**: [ReplicationRuleAndOperator](#replicationruleandoperator) -* **Prefix**: string -* **TagFilter**: [TagFilter](#tagfilter) +* **DeleteMarkerReplication**: [DeleteMarkerReplication](#deletemarkerreplication): Specifies whether Amazon S3 replicates delete markers. If you specify a ``Filter`` in your replication configuration, you must also include a ``DeleteMarkerReplication`` element. If your ``Filter`` includes a ``Tag`` element, the ``DeleteMarkerReplication`` ``Status`` must be set to Disabled, because Amazon S3 does not support replicating delete markers for tag-based rules. For an example configuration, see [Basic Rule Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-config-min-rule-config). + For more information about delete marker replication, see [Basic Rule Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/delete-marker-replication.html). + If you are using an earlier version of the replication configuration, Amazon S3 handles replication of delete markers differently. For more information, see [Backward Compatibility](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations). +* **Destination**: [ReplicationDestination](#replicationdestination) (Required): A container for information about the replication destination and its configurations including enabling the S3 Replication Time Control (S3 RTC). +* **Filter**: [ReplicationRuleFilter](#replicationrulefilter): A filter that identifies the subset of objects to which the replication rule applies. A ``Filter`` must specify exactly one ``Prefix``, ``TagFilter``, or an ``And`` child element. The use of the filter field indicates that this is a V2 replication configuration. This field isn't supported in a V1 replication configuration. + V1 replication configuration only supports filtering by key prefix. To filter using a V1 replication configuration, add the ``Prefix`` directly as a child element of the ``Rule`` element. +* **Id**: string: A unique identifier for the rule. The maximum value is 255 characters. If you don't specify a value, AWS CloudFormation generates a random ID. When using a V2 replication configuration this property is capitalized as "ID". +* **Prefix**: string: An object key name prefix that identifies the object or objects to which the rule applies. The maximum prefix length is 1,024 characters. To include all objects in a bucket, specify an empty string. To filter using a V1 replication configuration, add the ``Prefix`` directly as a child element of the ``Rule`` element. + Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints). +* **Priority**: int: The priority indicates which rule has precedence whenever two or more replication rules conflict. Amazon S3 will attempt to replicate objects according to all replication rules. However, if there are two or more rules with the same destination bucket, then objects will be replicated according to the rule with the highest priority. The higher the number, the higher the priority. + For more information, see [Replication](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html) in the *Amazon S3 User Guide*. +* **SourceSelectionCriteria**: [SourceSelectionCriteria](#sourceselectioncriteria): A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects. +* **Status**: string (Required): Specifies whether the rule is enabled. ## ReplicationRuleAndOperator ### Properties -* **Prefix**: string -* **TagFilters**: [TagFilter](#tagfilter)[] - -## SourceSelectionCriteria -### Properties -* **ReplicaModifications**: [ReplicaModifications](#replicamodifications): A filter that you can specify for selection for modifications on replicas. -* **SseKmsEncryptedObjects**: [SseKmsEncryptedObjects](#ssekmsencryptedobjects): A container for filter information for the selection of Amazon S3 objects encrypted with AWS KMS. +* **Prefix**: string: An object key name prefix that identifies the subset of objects to which the rule applies. +* **TagFilters**: [TagFilter](#tagfilter)[]: An array of tags containing key and value pairs. -## ReplicaModifications +## ReplicationRuleFilter ### Properties -* **Status**: string (Required): Specifies whether Amazon S3 replicates modifications on replicas. +* **And**: [ReplicationRuleAndOperator](#replicationruleandoperator): A container for specifying rule filters. The filters determine the subset of objects to which the rule applies. This element is required only if you specify more than one filter. For example: + + If you specify both a ``Prefix`` and a ``TagFilter``, wrap these filters in an ``And`` tag. + + If you specify a filter based on multiple tags, wrap the ``TagFilter`` elements in an ``And`` tag. +* **Prefix**: string: An object key name prefix that identifies the subset of objects to which the rule applies. + Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints). +* **TagFilter**: [TagFilter](#tagfilter): A container for specifying a tag key and value. + The rule applies only to objects that have the tag in their tag set. -## SseKmsEncryptedObjects +## ReplicationTime ### Properties -* **Status**: string (Required): Specifies whether Amazon S3 replicates objects created with server-side encryption using a customer master key (CMK) stored in AWS Key Management Service. +* **Status**: string (Required): Specifies whether the replication time is enabled. +* **Time**: [ReplicationTimeValue](#replicationtimevalue) (Required): A container specifying the time by which replication should be complete for all objects and operations on objects. -## Tag +## ReplicationTimeValue ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **Minutes**: int (Required): Contains an integer specifying time in minutes. + Valid value: 15 -## VersioningConfiguration +## RoutingRule ### Properties -* **Status**: string (Required): The versioning state of the bucket. +* **RedirectRule**: [RedirectRule](#redirectrule) (Required): Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event of an error, you can specify a different error code to return. +* **RoutingRuleCondition**: [RoutingRuleCondition](#routingrulecondition): A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the ``/docs`` folder, redirect to the ``/documents`` folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error. -## WebsiteConfiguration +## RoutingRuleCondition ### Properties -* **ErrorDocument**: string: The name of the error document for the website. -* **IndexDocument**: string: The name of the index document for the website. -* **RedirectAllRequestsTo**: [RedirectAllRequestsTo](#redirectallrequeststo) -* **RoutingRules**: [RoutingRule](#routingrule)[] +* **HttpErrorCodeReturnedEquals**: string: The HTTP error code when the redirect is applied. In the event of an error, if the error code equals this value, then the specified redirect is applied. + Required when parent element ``Condition`` is specified and sibling ``KeyPrefixEquals`` is not specified. If both are specified, then both must be true for the redirect to be applied. +* **KeyPrefixEquals**: string: The object key name prefix when the redirect is applied. For example, to redirect requests for ``ExamplePage.html``, the key prefix will be ``ExamplePage.html``. To redirect request for all pages with the prefix ``docs/``, the key prefix will be ``/docs``, which identifies all objects in the docs/ folder. + Required when the parent element ``Condition`` is specified and sibling ``HttpErrorCodeReturnedEquals`` is not specified. If both conditions are specified, both must be true for the redirect to be applied. -## RedirectAllRequestsTo +## Rule ### Properties -* **HostName**: string (Required): Name of the host where requests are redirected. -* **Protocol**: string: Protocol to use when redirecting requests. The default is the protocol that is used in the original request. +* **AbortIncompleteMultipartUpload**: [AbortIncompleteMultipartUpload](#abortincompletemultipartupload): Specifies a lifecycle rule that stops incomplete multipart uploads to an Amazon S3 bucket. +* **ExpirationDate**: string: Indicates when objects are deleted from Amazon S3 and Amazon S3 Glacier. The date value must be in ISO 8601 format. The time is always midnight UTC. If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time. +* **ExpirationInDays**: int: Indicates the number of days after creation when objects are deleted from Amazon S3 and Amazon S3 Glacier. If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time. +* **ExpiredObjectDeleteMarker**: bool: Indicates whether Amazon S3 will remove a delete marker without any noncurrent versions. If set to true, the delete marker will be removed if there are no noncurrent versions. This cannot be specified with ``ExpirationInDays``, ``ExpirationDate``, or ``TagFilters``. +* **Id**: string: Unique identifier for the rule. The value can't be longer than 255 characters. +* **NoncurrentVersionExpiration**: [NoncurrentVersionExpiration](#noncurrentversionexpiration): Specifies when noncurrent object versions expire. Upon expiration, S3 permanently deletes the noncurrent object versions. You set this lifecycle configuration action on a bucket that has versioning enabled (or suspended) to request that S3 delete noncurrent object versions at a specific period in the object's lifetime. +* **NoncurrentVersionExpirationInDays**: int: (Deprecated.) For buckets with versioning enabled (or suspended), specifies the time, in days, between when a new version of the object is uploaded to the bucket and when old versions of the object expire. When object versions expire, Amazon S3 permanently deletes them. If you specify a transition and expiration time, the expiration time must be later than the transition time. +* **NoncurrentVersionTransition**: [NoncurrentVersionTransition](#noncurrentversiontransition): (Deprecated.) For buckets with versioning enabled (or suspended), specifies when non-current objects transition to a specified storage class. If you specify a transition and expiration time, the expiration time must be later than the transition time. If you specify this property, don't specify the ``NoncurrentVersionTransitions`` property. +* **NoncurrentVersionTransitions**: [NoncurrentVersionTransition](#noncurrentversiontransition)[]: For buckets with versioning enabled (or suspended), one or more transition rules that specify when non-current objects transition to a specified storage class. If you specify a transition and expiration time, the expiration time must be later than the transition time. If you specify this property, don't specify the ``NoncurrentVersionTransition`` property. +* **ObjectSizeGreaterThan**: string: Specifies the minimum object size in bytes for this rule to apply to. Objects must be larger than this value in bytes. For more information about size based rules, see [Lifecycle configuration using size-based rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/lifecycle-configuration-examples.html#lc-size-rules) in the *Amazon S3 User Guide*. +* **ObjectSizeLessThan**: string: Specifies the maximum object size in bytes for this rule to apply to. Objects must be smaller than this value in bytes. For more information about sized based rules, see [Lifecycle configuration using size-based rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/lifecycle-configuration-examples.html#lc-size-rules) in the *Amazon S3 User Guide*. +* **Prefix**: string: Object key prefix that identifies one or more objects to which this rule applies. + Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints). +* **Status**: string (Required): If ``Enabled``, the rule is currently being applied. If ``Disabled``, the rule is not currently being applied. +* **TagFilters**: [TagFilter](#tagfilter)[]: Tags to use to identify a subset of objects to which the lifecycle rule applies. +* **Transition**: [Transition](#transition): (Deprecated.) Specifies when an object transitions to a specified storage class. If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time. If you specify this property, don't specify the ``Transitions`` property. +* **Transitions**: [Transition](#transition)[]: One or more transition rules that specify when an object transitions to a specified storage class. If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time. If you specify this property, don't specify the ``Transition`` property. -## RoutingRule +## S3BucketDestination ### Properties -* **RedirectRule**: [RedirectRule](#redirectrule) (Required): Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event of an error, you can specify a different error code to return. -* **RoutingRuleCondition**: [RoutingRuleCondition](#routingrulecondition) +* **AccountId**: string (Required): The AWS account ID that owns the destination S3 bucket. +* **Arn**: string (Required): The ARN of the bucket to which Amazon S3 Storage Lens exports will be placed. +* **Encryption**: [Encryption](#encryption) +* **Format**: string (Required): Specifies the file format to use when exporting Amazon S3 Storage Lens metrics export. +* **OutputSchemaVersion**: string (Required): The version of the output schema to use when exporting Amazon S3 Storage Lens metrics. +* **Prefix**: string: The prefix to use for Amazon S3 Storage Lens export. -## RedirectRule +## S3KeyFilter ### Properties -* **HostName**: string: The host name to use in the redirect request. -* **HttpRedirectCode**: string: The HTTP redirect code to use on the response. Not required if one of the siblings is present. -* **Protocol**: string: Protocol to use when redirecting requests. The default is the protocol that is used in the original request. -* **ReplaceKeyPrefixWith**: string: The object key prefix to use in the redirect request. -* **ReplaceKeyWith**: string: The specific object key to use in the redirect request.d +* **Rules**: [FilterRule](#filterrule)[] (Required): A list of containers for the key-value pair that defines the criteria for the filter rule. -## RoutingRuleCondition +## SelectionCriteria ### Properties -* **HttpErrorCodeReturnedEquals**: string: The HTTP error code when the redirect is applied. -* **KeyPrefixEquals**: string: The object key name prefix when the redirect is applied. +* **Delimiter**: string: Delimiter to divide S3 key into hierarchy of prefixes. +* **MaxDepth**: int: Max depth of prefixes of S3 key that Amazon S3 Storage Lens will analyze. +* **MinStorageBytesPercentage**: int: The minimum storage bytes threshold for the prefixes to be included in the analysis. -## AWS.S3/BucketPolicyProperties +## ServerSideEncryptionByDefault ### Properties -* **Bucket**: string (Required, Identifier): The name of the Amazon S3 bucket to which the policy applies. -* **PolicyDocument**: [BucketPolicy_PolicyDocument](#bucketpolicypolicydocument) | string (Required): A policy document containing permissions to add to the specified 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. +* **KMSMasterKeyID**: string: AWS Key Management Service (KMS) customer AWS KMS key ID to use for the default encryption. This parameter is allowed if and only if ``SSEAlgorithm`` is set to ``aws:kms`` or ``aws:kms:dsse``. + You can specify the key ID, key alias, or the Amazon Resource Name (ARN) of the KMS key. + + Key ID: ``1234abcd-12ab-34cd-56ef-1234567890ab`` + + Key ARN: ``arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`` + + Key Alias: ``alias/alias-name`` + + If you use a key ID, you can run into a LogDestination undeliverable error when creating a VPC flow log. + If you are using encryption with cross-account or AWS service operations you 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/dev/bucket-encryption.html#bucket-encryption-update-bucket-policy). + Amazon S3 only supports symmetric encryption KMS keys. For more information, see [Asymmetric keys in KMS](https://docs.aws.amazon.com//kms/latest/developerguide/symmetric-asymmetric.html) in the *Key Management Service Developer Guide*. +* **SSEAlgorithm**: string (Required): Server-side encryption algorithm to use for the default encryption. -## AWS.S3/MultiRegionAccessPointPolicyProperties +## ServerSideEncryptionRule ### Properties -* **MrapName**: string (Required, Identifier): The name of the Multi Region Access Point to apply policy -* **Policy**: [MultiRegionAccessPointPolicy_Policy](#multiregionaccesspointpolicypolicy) (Required): Policy document to apply to a Multi Region Access Point -* **PolicyStatus**: [MultiRegionAccessPointPolicy_PolicyStatus](#multiregionaccesspointpolicypolicystatus) (ReadOnly): The Policy Status associated with this Multi Region Access Point +* **BucketKeyEnabled**: bool: Specifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS (SSE-KMS) for new objects in the bucket. Existing objects are not affected. Setting the ``BucketKeyEnabled`` element to ``true`` causes Amazon S3 to use an S3 Bucket Key. By default, S3 Bucket Key is not enabled. + For more information, see [Amazon S3 Bucket Keys](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html) in the *Amazon S3 User Guide*. +* **ServerSideEncryptionByDefault**: [ServerSideEncryptionByDefault](#serversideencryptionbydefault): Specifies the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied. -## MultiRegionAccessPointPolicy_Policy +## SourceSelectionCriteria ### Properties +* **ReplicaModifications**: [ReplicaModifications](#replicamodifications): A filter that you can specify for selection for modifications on replicas. +* **SseKmsEncryptedObjects**: [SseKmsEncryptedObjects](#ssekmsencryptedobjects): A container for filter information for the selection of Amazon S3 objects encrypted with AWS KMS. -## MultiRegionAccessPointPolicy_PolicyStatus +## SseKmsEncryptedObjects ### Properties -* **IsPublic**: string (Required, ReadOnly): Specifies whether the policy is public or not. +* **Status**: string (Required): Specifies whether Amazon S3 replicates objects created with server-side encryption using an AWS KMS key stored in AWS Key Management Service. -## AWS.S3/StorageLensProperties +## StorageClassAnalysis ### Properties -* **StorageLensConfiguration**: [StorageLensConfiguration](#storagelensconfiguration) (Required) -* **Tags**: [Tag](#tag)[]: A set of tags (key-value pairs) for this Amazon S3 Storage Lens configuration. +* **DataExport**: [DataExport](#dataexport): Specifies how data related to the storage class analysis for an Amazon S3 bucket should be exported. ## StorageLensConfiguration ### Properties @@ -543,54 +647,6 @@ Enabling this setting doesn't affect previously stored bucket policies, except t * **IsEnabled**: bool (Required): Specifies whether the Amazon S3 Storage Lens configuration is enabled or disabled. * **StorageLensArn**: string (ReadOnly): The ARN for the Amazon S3 Storage Lens configuration. -## AccountLevel -### Properties -* **ActivityMetrics**: [ActivityMetrics](#activitymetrics) -* **AdvancedCostOptimizationMetrics**: [AdvancedCostOptimizationMetrics](#advancedcostoptimizationmetrics) -* **AdvancedDataProtectionMetrics**: [AdvancedDataProtectionMetrics](#advanceddataprotectionmetrics) -* **BucketLevel**: [BucketLevel](#bucketlevel) (Required) -* **DetailedStatusCodesMetrics**: [DetailedStatusCodesMetrics](#detailedstatuscodesmetrics) -* **StorageLensGroupLevel**: [StorageLensGroupLevel](#storagelensgrouplevel) - -## ActivityMetrics -### Properties -* **IsEnabled**: bool: Specifies whether activity metrics are enabled or disabled. - -## AdvancedCostOptimizationMetrics -### Properties -* **IsEnabled**: bool: Specifies whether advanced cost optimization metrics are enabled or disabled. - -## AdvancedDataProtectionMetrics -### Properties -* **IsEnabled**: bool: Specifies whether advanced data protection metrics are enabled or disabled. - -## BucketLevel -### Properties -* **ActivityMetrics**: [ActivityMetrics](#activitymetrics) -* **AdvancedCostOptimizationMetrics**: [AdvancedCostOptimizationMetrics](#advancedcostoptimizationmetrics) -* **AdvancedDataProtectionMetrics**: [AdvancedDataProtectionMetrics](#advanceddataprotectionmetrics) -* **DetailedStatusCodesMetrics**: [DetailedStatusCodesMetrics](#detailedstatuscodesmetrics) -* **PrefixLevel**: [PrefixLevel](#prefixlevel) - -## DetailedStatusCodesMetrics -### Properties -* **IsEnabled**: bool: Specifies whether detailed status codes metrics are enabled or disabled. - -## PrefixLevel -### Properties -* **StorageMetrics**: [PrefixLevelStorageMetrics](#prefixlevelstoragemetrics) (Required) - -## PrefixLevelStorageMetrics -### Properties -* **IsEnabled**: bool: Specifies whether prefix-level storage metrics are enabled or disabled. -* **SelectionCriteria**: [SelectionCriteria](#selectioncriteria) - -## SelectionCriteria -### Properties -* **Delimiter**: string: Delimiter to divide S3 key into hierarchy of prefixes. -* **MaxDepth**: int: Max depth of prefixes of S3 key that Amazon S3 Storage Lens will analyze. -* **MinStorageBytesPercentage**: int: The minimum storage bytes threshold for the prefixes to be included in the analysis. - ## StorageLensGroupLevel ### Properties * **StorageLensGroupSelectionCriteria**: [StorageLensGroupSelectionCriteria](#storagelensgroupselectioncriteria) @@ -600,86 +656,74 @@ Enabling this setting doesn't affect previously stored bucket policies, except t * **Exclude**: string[] * **Include**: string[] -## AwsOrg -### Properties -* **Arn**: string (Required) - -## DataExport +## Tag ### Properties -* **CloudWatchMetrics**: [CloudWatchMetrics](#cloudwatchmetrics) -* **S3BucketDestination**: [S3BucketDestination](#s3bucketdestination) +* **Key**: string (Required) +* **Value**: string (Required) -## CloudWatchMetrics +## Tag ### Properties -* **IsEnabled**: bool (Required): Specifies whether CloudWatch metrics are enabled or disabled. +* **Key**: string (Required) +* **Value**: string (Required) -## S3BucketDestination +## Tag ### Properties -* **AccountId**: string (Required): The AWS account ID that owns the destination S3 bucket. -* **Arn**: string (Required): The ARN of the bucket to which Amazon S3 Storage Lens exports will be placed. -* **Encryption**: [Encryption](#encryption) -* **Format**: string (Required): Specifies the file format to use when exporting Amazon S3 Storage Lens metrics export. -* **OutputSchemaVersion**: string (Required): The version of the output schema to use when exporting Amazon S3 Storage Lens metrics. -* **Prefix**: string: The prefix to use for Amazon S3 Storage Lens export. +* **Key**: string (Required) +* **Value**: string (Required) -## Encryption +## Tag ### Properties +* **Key**: string (Required): Name of the object key. +* **Value**: string (Required): Value of the tag. -## BucketsAndRegions +## Tag ### Properties -* **Buckets**: string[] -* **Regions**: string[] +* **Key**: string (Required) +* **Value**: string (Required) ## Tag ### Properties * **Key**: string (Required) * **Value**: string (Required) -## AWS.S3/StorageLensGroupProperties +## TagFilter ### Properties -* **Filter**: [Filter](#filter) (Required) -* **Name**: string (Required, Identifier) -* **StorageLensGroupArn**: string (ReadOnly): The ARN for the Amazon S3 Storage Lens Group. -* **Tags**: [Tag](#tag)[]: A set of tags (key-value pairs) for this Amazon S3 Storage Lens Group. +* **Key**: string (Required): The tag key. +* **Value**: string (Required): The tag value. -## Filter +## TargetObjectKeyFormat ### Properties -* **And**: [And](#and) -* **MatchAnyPrefix**: string[] -* **MatchAnySuffix**: string[] -* **MatchAnyTag**: [Tag](#tag)[] -* **MatchObjectAge**: [MatchObjectAge](#matchobjectage) -* **MatchObjectSize**: [MatchObjectSize](#matchobjectsize) -* **Or**: [Or](#or) -## And +## Tiering ### Properties -* **MatchAnyPrefix**: string[] -* **MatchAnySuffix**: string[] -* **MatchAnyTag**: [Tag](#tag)[] -* **MatchObjectAge**: [MatchObjectAge](#matchobjectage) -* **MatchObjectSize**: [MatchObjectSize](#matchobjectsize) +* **AccessTier**: string (Required): S3 Intelligent-Tiering access tier. See [Storage class for automatically 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 tiers in the S3 Intelligent-Tiering storage class. +* **Days**: int (Required): The number of consecutive days of no access after which an object will be eligible to be transitioned to the corresponding tier. The minimum number of days specified for Archive Access tier must be at least 90 days and Deep Archive Access tier must be at least 180 days. The maximum can be up to 2 years (730 days). -## Tag +## TopicConfiguration ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **Event**: string (Required): The 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 the *Amazon S3 User Guide*. +* **Filter**: [NotificationFilter](#notificationfilter): The filtering rules that determine for which objects to send notifications. For example, you can create a filter so that Amazon S3 sends notifications only when image files with a ``.jpg`` extension are added to the bucket. +* **Topic**: string (Required): The Amazon Resource Name (ARN) of the Amazon SNS topic to which Amazon S3 publishes a message when it detects events of the specified type. -## MatchObjectAge +## Transition ### Properties -* **DaysGreaterThan**: int: Minimum object age to which the rule applies. -* **DaysLessThan**: int: Maximum object age to which the rule applies. +* **StorageClass**: string (Required): The storage class to which you want the object to transition. +* **TransitionDate**: string: Indicates when objects are transitioned to the specified storage class. The date value must be in ISO 8601 format. The time is always midnight UTC. +* **TransitionInDays**: int: Indicates the number of days after creation when objects are transitioned to the specified storage class. The value must be a positive integer. -## MatchObjectSize +## VersioningConfiguration ### Properties -* **BytesGreaterThan**: int: Minimum object size to which the rule applies. -* **BytesLessThan**: int: Maximum object size to which the rule applies. +* **Status**: string (Required): The versioning state of the bucket. -## Or +## VpcConfiguration ### Properties -* **MatchAnyPrefix**: string[] -* **MatchAnySuffix**: string[] -* **MatchAnyTag**: [Tag](#tag)[] -* **MatchObjectAge**: [MatchObjectAge](#matchobjectage) -* **MatchObjectSize**: [MatchObjectSize](#matchobjectsize) +* **VpcId**: string: If this field is specified, this access point will only allow connections from the specified VPC ID. + +## WebsiteConfiguration +### Properties +* **ErrorDocument**: string: The name of the error document for the website. +* **IndexDocument**: string: The name of the index document for the website. +* **RedirectAllRequestsTo**: [RedirectAllRequestsTo](#redirectallrequeststo): The redirect behavior for every request to this bucket's website endpoint. + If you specify this property, you can't specify any other property. +* **RoutingRules**: [RoutingRule](#routingrule)[]: Rules that define when a redirect is applied and the redirect behavior. diff --git a/artifacts/bicep/aws/aws.s3express/default/types.json b/artifacts/bicep/aws/aws.s3express/default/types.json index 02a57402..f38eeb3b 100644 --- a/artifacts/bicep/aws/aws.s3express/default/types.json +++ b/artifacts/bicep/aws/aws.s3express/default/types.json @@ -1 +1,81 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"AWS.S3Express/BucketPolicyProperties","Properties":{"Bucket":{"Type":4,"Flags":17,"Description":"The name of the S3 directory bucket to which the policy applies."},"PolicyDocument":{"Type":10,"Flags":1,"Description":"A policy document containing permissions to add to the specified 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."}}}},{"2":{"Name":"BucketPolicy_PolicyDocument","Properties":{}}},{"5":{"Elements":[9,4]}},{"2":{"Name":"AWS.S3Express/BucketPolicy","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":8,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.S3Express/BucketPolicy@default","ScopeType":0,"Body":11}}] \ No newline at end of file +[ + { + "$type": "StringLiteralType", + "value": "AWS.S3Express/BucketPolicyProperties" + }, + { + "$type": "StringType" + }, + { + "$type": "ObjectType", + "name": "BucketPolicy_PolicyDocument", + "properties": {} + }, + { + "$type": "UnionType", + "elements": [ + { + "$ref": "#/2" + }, + { + "$ref": "#/1" + } + ] + }, + { + "$type": "ObjectType", + "name": "AWS.S3Express/BucketPolicyProperties", + "properties": { + "Bucket": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The name of the S3 directory bucket to which the policy applies." + }, + "PolicyDocument": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "A policy document containing permissions to add to the specified 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." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.S3Express/BucketPolicy", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.S3Express/BucketPolicy@default", + "scopeType": 0, + "body": { + "$ref": "#/5" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.s3express/default/types.md b/artifacts/bicep/aws/aws.s3express/default/types.md index 7f462520..aa567de9 100644 --- a/artifacts/bicep/aws/aws.s3express/default/types.md +++ b/artifacts/bicep/aws/aws.s3express/default/types.md @@ -3,9 +3,9 @@ ## Resource AWS.S3Express/BucketPolicy@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.S3Express/BucketPolicyProperties](#awss3expressbucketpolicyproperties) (Required): properties of the resource +* **properties**: [AWS.S3Express/BucketPolicyProperties](#awss3expressbucketpolicyproperties) (Required, Identifier): properties of the resource ## AWS.S3Express/BucketPolicyProperties ### Properties diff --git a/artifacts/bicep/aws/aws.s3objectlambda/default/types.json b/artifacts/bicep/aws/aws.s3objectlambda/default/types.json index bc5db77f..f7b62682 100644 --- a/artifacts/bicep/aws/aws.s3objectlambda/default/types.json +++ b/artifacts/bicep/aws/aws.s3objectlambda/default/types.json @@ -1 +1,326 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"Action"}},{"2":{"Name":"Alias","Properties":{"Status":{"Type":4,"Flags":2,"Description":"The status of the Object Lambda alias."},"Value":{"Type":4,"Flags":3,"Description":"The value of the Object Lambda alias."}}}},{"2":{"Name":"AwsLambda","Properties":{"FunctionArn":{"Type":4,"Flags":1},"FunctionPayload":{"Type":4,"Flags":0}}}},{"2":{"Name":"ObjectLambdaConfiguration","Properties":{"AllowedFeatures":{"Type":15,"Flags":0},"CloudWatchMetricsEnabled":{"Type":2,"Flags":0},"SupportingAccessPoint":{"Type":4,"Flags":1},"TransformationConfigurations":{"Type":16,"Flags":1}}}},{"2":{"Name":"PolicyStatus","Properties":{"IsPublic":{"Type":2,"Flags":2,"Description":"Specifies whether the Object lambda Access Point Policy is Public or not. Object lambda Access Points are private by default."}}}},{"2":{"Name":"PublicAccessBlockConfiguration","Properties":{"BlockPublicAcls":{"Type":2,"Flags":0,"Description":"Specifies whether Amazon S3 should block public access control lists (ACLs) to this object lambda access point. 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."},"BlockPublicPolicy":{"Type":2,"Flags":0,"Description":"Specifies whether Amazon S3 should block public bucket policies for buckets in this account. Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access. Enabling this setting doesn't affect existing bucket policies."},"IgnorePublicAcls":{"Type":2,"Flags":0,"Description":"Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on buckets in this account and any objects that they contain. Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set."},"RestrictPublicBuckets":{"Type":2,"Flags":0,"Description":"Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting this element to TRUE restricts access to this bucket to only AWS services and authorized 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 cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked."}}}},{"2":{"Name":"TransformationConfiguration","Properties":{"Actions":{"Type":17,"Flags":1},"ContentTransformation":{"Type":18,"Flags":1}}}},{"3":{"ItemType":4}},{"3":{"ItemType":14}},{"3":{"ItemType":4}},{"2":{"Name":"AccessPoint_ContentTransformation","Properties":{}}},{"2":{"Name":"AWS.S3ObjectLambda/AccessPointProperties","Properties":{"Alias":{"Type":9,"Flags":2},"Arn":{"Type":4,"Flags":2},"CreationDate":{"Type":4,"Flags":2,"Description":"The date and time when the Object lambda Access Point was created."},"Name":{"Type":4,"Flags":16,"Description":"The name you want to assign to this Object lambda Access Point."},"ObjectLambdaConfiguration":{"Type":11,"Flags":1,"Description":"The Object lambda Access Point Configuration that configures transformations to be applied on the objects on specified S3 Actions"},"PolicyStatus":{"Type":12,"Flags":2},"PublicAccessBlockConfiguration":{"Type":13,"Flags":2,"Description":"The PublicAccessBlock configuration that you want to apply to this Access Point. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status 'The Meaning of Public' in the Amazon Simple Storage Service Developer Guide."}}}},{"2":{"Name":"AWS.S3ObjectLambda/AccessPoint","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":19,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.S3ObjectLambda/AccessPoint@default","ScopeType":0,"Body":20}},{"2":{"Name":"AWS.S3ObjectLambda/AccessPointPolicyProperties","Properties":{"ObjectLambdaAccessPoint":{"Type":4,"Flags":17,"Description":"The name of the Amazon S3 ObjectLambdaAccessPoint to which the policy applies."},"PolicyDocument":{"Type":23,"Flags":1,"Description":"A policy document containing permissions to add to the specified ObjectLambdaAccessPoint. For more information, see Access Policy Language Overview (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-policy-language-overview.html) in the Amazon Simple Storage Service Developer Guide. "}}}},{"2":{"Name":"AccessPointPolicy_PolicyDocument","Properties":{}}},{"2":{"Name":"AWS.S3ObjectLambda/AccessPointPolicy","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":22,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.S3ObjectLambda/AccessPointPolicy@default","ScopeType":0,"Body":24}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Action", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Alias", + "properties": { + "Status": { + "type": { + "$ref": "#/7" + }, + "flags": 2, + "description": "The status of the Object Lambda alias." + }, + "Value": { + "type": { + "$ref": "#/7" + }, + "flags": 3, + "description": "The value of the Object Lambda alias." + } + } + }, + { + "$type": "ObjectType", + "name": "AwsLambda", + "properties": { + "FunctionArn": { + "type": { + "$ref": "#/7" + }, + "flags": 1 + }, + "FunctionPayload": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ObjectLambdaConfiguration", + "properties": { + "AllowedFeatures": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "CloudWatchMetricsEnabled": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "SupportingAccessPoint": { + "type": { + "$ref": "#/7" + }, + "flags": 1 + }, + "TransformationConfigurations": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "PolicyStatus", + "properties": { + "IsPublic": { + "type": { + "$ref": "#/9" + }, + "flags": 2, + "description": "Specifies whether the Object lambda Access Point Policy is Public or not. Object lambda Access Points are private by default." + } + } + }, + { + "$type": "ObjectType", + "name": "PublicAccessBlockConfiguration", + "properties": { + "BlockPublicAcls": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "Specifies whether Amazon S3 should block public access control lists (ACLs) to this object lambda access point. 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." + }, + "BlockPublicPolicy": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "Specifies whether Amazon S3 should block public bucket policies for buckets in this account. Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access. Enabling this setting doesn't affect existing bucket policies." + }, + "IgnorePublicAcls": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on buckets in this account and any objects that they contain. Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set." + }, + "RestrictPublicBuckets": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting this element to TRUE restricts access to this bucket to only AWS services and authorized 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 cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked." + } + } + }, + { + "$type": "ObjectType", + "name": "TransformationConfiguration", + "properties": { + "Actions": { + "type": { + "$ref": "#/11" + }, + "flags": 1 + }, + "ContentTransformation": { + "type": { + "$ref": "#/12" + }, + "flags": 1 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/7" + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/7" + } + }, + { + "$type": "ObjectType", + "name": "AccessPoint_ContentTransformation", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.S3ObjectLambda/AccessPointProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.S3ObjectLambda/AccessPointProperties", + "properties": { + "Alias": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "Arn": { + "type": { + "$ref": "#/7" + }, + "flags": 2 + }, + "CreationDate": { + "type": { + "$ref": "#/7" + }, + "flags": 2, + "description": "The date and time when the Object lambda Access Point was created." + }, + "Name": { + "type": { + "$ref": "#/7" + }, + "flags": 16, + "description": "The name you want to assign to this Object lambda Access Point." + }, + "ObjectLambdaConfiguration": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The Object lambda Access Point Configuration that configures transformations to be applied on the objects on specified S3 Actions" + }, + "PolicyStatus": { + "type": { + "$ref": "#/4" + }, + "flags": 2 + }, + "PublicAccessBlockConfiguration": { + "type": { + "$ref": "#/5" + }, + "flags": 2, + "description": "The PublicAccessBlock configuration that you want to apply to this Access Point. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status 'The Meaning of Public' in the Amazon Simple Storage Service Developer Guide." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.S3ObjectLambda/AccessPoint", + "properties": { + "name": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/7" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/14" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.S3ObjectLambda/AccessPoint@default", + "scopeType": 0, + "body": { + "$ref": "#/15" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.S3ObjectLambda/AccessPointPolicyProperties" + }, + { + "$type": "ObjectType", + "name": "AccessPointPolicy_PolicyDocument", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AWS.S3ObjectLambda/AccessPointPolicyProperties", + "properties": { + "ObjectLambdaAccessPoint": { + "type": { + "$ref": "#/7" + }, + "flags": 17, + "description": "The name of the Amazon S3 ObjectLambdaAccessPoint to which the policy applies." + }, + "PolicyDocument": { + "type": { + "$ref": "#/18" + }, + "flags": 1, + "description": "A policy document containing permissions to add to the specified ObjectLambdaAccessPoint. For more information, see Access Policy Language Overview (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-policy-language-overview.html) in the Amazon Simple Storage Service Developer Guide. " + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.S3ObjectLambda/AccessPointPolicy", + "properties": { + "name": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/7" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/19" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.S3ObjectLambda/AccessPointPolicy@default", + "scopeType": 0, + "body": { + "$ref": "#/20" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.s3objectlambda/default/types.md b/artifacts/bicep/aws/aws.s3objectlambda/default/types.md index dfa1ba96..b59f6397 100644 --- a/artifacts/bicep/aws/aws.s3objectlambda/default/types.md +++ b/artifacts/bicep/aws/aws.s3objectlambda/default/types.md @@ -3,16 +3,32 @@ ## Resource AWS.S3ObjectLambda/AccessPoint@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.S3ObjectLambda/AccessPointProperties](#awss3objectlambdaaccesspointproperties) (Required): properties of the resource +* **properties**: [AWS.S3ObjectLambda/AccessPointProperties](#awss3objectlambdaaccesspointproperties) (Required, Identifier): properties of the resource ## Resource AWS.S3ObjectLambda/AccessPointPolicy@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.S3ObjectLambda/AccessPointPolicyProperties](#awss3objectlambdaaccesspointpolicyproperties) (Required): properties of the resource +* **properties**: [AWS.S3ObjectLambda/AccessPointPolicyProperties](#awss3objectlambdaaccesspointpolicyproperties) (Required, Identifier): properties of the resource + +## AccessPoint_ContentTransformation +### Properties + +## AccessPointPolicy_PolicyDocument +### Properties + +## Alias +### Properties +* **Status**: string (ReadOnly): The status of the Object Lambda alias. +* **Value**: string (Required, ReadOnly): The value of the Object Lambda alias. + +## AWS.S3ObjectLambda/AccessPointPolicyProperties +### Properties +* **ObjectLambdaAccessPoint**: string (Required, Identifier): The name of the Amazon S3 ObjectLambdaAccessPoint to which the policy applies. +* **PolicyDocument**: [AccessPointPolicy_PolicyDocument](#accesspointpolicypolicydocument) (Required): A policy document containing permissions to add to the specified ObjectLambdaAccessPoint. For more information, see Access Policy Language Overview (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-policy-language-overview.html) in the Amazon Simple Storage Service Developer Guide. ## AWS.S3ObjectLambda/AccessPointProperties ### Properties @@ -24,11 +40,6 @@ * **PolicyStatus**: [PolicyStatus](#policystatus) (ReadOnly) * **PublicAccessBlockConfiguration**: [PublicAccessBlockConfiguration](#publicaccessblockconfiguration) (ReadOnly): The PublicAccessBlock configuration that you want to apply to this Access Point. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status 'The Meaning of Public' in the Amazon Simple Storage Service Developer Guide. -## Alias -### Properties -* **Status**: string (ReadOnly): The status of the Object Lambda alias. -* **Value**: string (Required, ReadOnly): The value of the Object Lambda alias. - ## ObjectLambdaConfiguration ### Properties * **AllowedFeatures**: string[] @@ -36,14 +47,6 @@ * **SupportingAccessPoint**: string (Required) * **TransformationConfigurations**: [TransformationConfiguration](#transformationconfiguration)[] (Required) -## TransformationConfiguration -### Properties -* **Actions**: string[] (Required) -* **ContentTransformation**: [AccessPoint_ContentTransformation](#accesspointcontenttransformation) (Required) - -## AccessPoint_ContentTransformation -### Properties - ## PolicyStatus ### Properties * **IsPublic**: bool (ReadOnly): Specifies whether the Object lambda Access Point Policy is Public or not. Object lambda Access Points are private by default. @@ -60,11 +63,8 @@ Enabling this setting doesn't affect existing policies or ACLs. * **RestrictPublicBuckets**: bool: Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting this element to TRUE restricts access to this bucket to only AWS services and authorized users within this account if the bucket has a public policy. Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked. -## AWS.S3ObjectLambda/AccessPointPolicyProperties -### Properties -* **ObjectLambdaAccessPoint**: string (Required, Identifier): The name of the Amazon S3 ObjectLambdaAccessPoint to which the policy applies. -* **PolicyDocument**: [AccessPointPolicy_PolicyDocument](#accesspointpolicypolicydocument) (Required): A policy document containing permissions to add to the specified ObjectLambdaAccessPoint. For more information, see Access Policy Language Overview (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-policy-language-overview.html) in the Amazon Simple Storage Service Developer Guide. - -## AccessPointPolicy_PolicyDocument +## TransformationConfiguration ### Properties +* **Actions**: string[] (Required) +* **ContentTransformation**: [AccessPoint_ContentTransformation](#accesspointcontenttransformation) (Required) diff --git a/artifacts/bicep/aws/aws.s3outposts/default/types.json b/artifacts/bicep/aws/aws.s3outposts/default/types.json index 282114e0..33e071bd 100644 --- a/artifacts/bicep/aws/aws.s3outposts/default/types.json +++ b/artifacts/bicep/aws/aws.s3outposts/default/types.json @@ -1 +1,416 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"VpcConfiguration","Properties":{"VpcId":{"Type":4,"Flags":0,"Description":"Virtual Private Cloud (VPC) Id from which AccessPoint will allow requests."}}}},{"2":{"Name":"AWS.S3Outposts/AccessPointProperties","Properties":{"Arn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN) of the specified AccessPoint."},"Bucket":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) of the bucket you want to associate this AccessPoint with."},"Name":{"Type":4,"Flags":1,"Description":"A name for the AccessPoint."},"Policy":{"Type":10,"Flags":0,"Description":"The access point policy associated with this access point."},"VpcConfiguration":{"Type":8,"Flags":1,"Description":"Virtual Private Cloud (VPC) from which requests can be made to the AccessPoint."}}}},{"2":{"Name":"AccessPoint_Policy","Properties":{}}},{"2":{"Name":"AWS.S3Outposts/AccessPoint","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":9,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.S3Outposts/AccessPoint@default","ScopeType":0,"Body":11}},{"2":{"Name":"AbortIncompleteMultipartUpload","Properties":{"DaysAfterInitiation":{"Type":3,"Flags":1,"Description":"Specifies the number of days after which Amazon S3Outposts aborts an incomplete multipart upload."}}}},{"2":{"Name":"FilterAndOperator","Properties":{}}},{"2":{"Name":"FilterPrefix"}},{"2":{"Name":"FilterTag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"LifecycleConfiguration","Properties":{"Rules":{"Type":21,"Flags":1,"Description":"A list of lifecycle rules for individual objects in an Amazon S3Outposts bucket."}}}},{"2":{"Name":"Rule","Properties":{"AbortIncompleteMultipartUpload":{"Type":13,"Flags":0,"Description":"Specifies a lifecycle rule that stops incomplete multipart uploads to an Amazon S3Outposts bucket."},"ExpirationDate":{"Type":4,"Flags":0,"Description":"Indicates when objects are deleted from Amazon S3Outposts. The date value must be in ISO 8601 format. The time is always midnight UTC."},"ExpirationInDays":{"Type":3,"Flags":0,"Description":"Indicates the number of days after creation when objects are deleted from Amazon S3Outposts."},"Filter":{"Type":22,"Flags":0,"Description":"The container for the filter of the lifecycle rule."},"Id":{"Type":4,"Flags":0,"Description":"Unique identifier for the lifecycle rule. The value can't be longer than 255 characters."},"Status":{"Type":4,"Flags":0}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"iso8601UTC"}},{"3":{"ItemType":18}},{"2":{"Name":"Bucket_Filter","Properties":{"AndOperator":{"Type":14,"Flags":0,"Description":"The container for the AND condition for the lifecycle rule. A combination of Prefix and 1 or more Tags OR a minimum of 2 or more tags."},"Prefix":{"Type":4,"Flags":0,"Description":"Object key prefix that identifies one or more objects to which this rule applies."},"Tag":{"Type":16,"Flags":0,"Description":"Specifies a tag used to identify a subset of objects for an Amazon S3Outposts bucket."}}}},{"2":{"Name":"AWS.S3Outposts/BucketProperties","Properties":{"Arn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN) of the specified bucket."},"BucketName":{"Type":4,"Flags":1,"Description":"A name for the bucket."},"LifecycleConfiguration":{"Type":17,"Flags":0,"Description":"Rules that define how Amazon S3Outposts manages objects during their lifetime."},"OutpostId":{"Type":4,"Flags":1,"Description":"The id of the customer outpost on which the bucket resides."},"Tags":{"Type":24,"Flags":0,"Description":"An arbitrary set of tags (key-value pairs) for this S3Outposts bucket."}}}},{"3":{"ItemType":19}},{"2":{"Name":"AWS.S3Outposts/Bucket","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":23,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.S3Outposts/Bucket@default","ScopeType":0,"Body":25}},{"2":{"Name":"AWS.S3Outposts/BucketPolicyProperties","Properties":{"Bucket":{"Type":4,"Flags":17,"Description":"The Amazon Resource Name (ARN) of the specified bucket."},"PolicyDocument":{"Type":28,"Flags":1,"Description":"A policy document containing permissions to add to the specified bucket."}}}},{"2":{"Name":"BucketPolicy_PolicyDocument","Properties":{}}},{"2":{"Name":"AWS.S3Outposts/BucketPolicy","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":27,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.S3Outposts/BucketPolicy@default","ScopeType":0,"Body":29}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "VpcConfiguration", + "properties": { + "VpcId": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Virtual Private Cloud (VPC) Id from which AccessPoint will allow requests." + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.S3Outposts/AccessPointProperties" + }, + { + "$type": "ObjectType", + "name": "AccessPoint_Policy", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AWS.S3Outposts/AccessPointProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) of the specified AccessPoint." + }, + "Bucket": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of the bucket you want to associate this AccessPoint with." + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "A name for the AccessPoint." + }, + "Policy": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The access point policy associated with this access point." + }, + "VpcConfiguration": { + "type": { + "$ref": "#/0" + }, + "flags": 1, + "description": "Virtual Private Cloud (VPC) from which requests can be made to the AccessPoint." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.S3Outposts/AccessPoint", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.S3Outposts/AccessPoint@default", + "scopeType": 0, + "body": { + "$ref": "#/5" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AbortIncompleteMultipartUpload", + "properties": { + "DaysAfterInitiation": { + "type": { + "$ref": "#/15" + }, + "flags": 1, + "description": "Specifies the number of days after which Amazon S3Outposts aborts an incomplete multipart upload." + } + } + }, + { + "$type": "ObjectType", + "name": "FilterAndOperator", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "FilterPrefix", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "FilterTag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "LifecycleConfiguration", + "properties": { + "Rules": { + "type": { + "$ref": "#/16" + }, + "flags": 1, + "description": "A list of lifecycle rules for individual objects in an Amazon S3Outposts bucket." + } + } + }, + { + "$type": "ObjectType", + "name": "Rule", + "properties": { + "AbortIncompleteMultipartUpload": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "Specifies a lifecycle rule that stops incomplete multipart uploads to an Amazon S3Outposts bucket." + }, + "ExpirationDate": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Indicates when objects are deleted from Amazon S3Outposts. The date value must be in ISO 8601 format. The time is always midnight UTC." + }, + "ExpirationInDays": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "Indicates the number of days after creation when objects are deleted from Amazon S3Outposts." + }, + "Filter": { + "type": { + "$ref": "#/17" + }, + "flags": 0, + "description": "The container for the filter of the lifecycle rule." + }, + "Id": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Unique identifier for the lifecycle rule. The value can't be longer than 255 characters." + }, + "Status": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "iso8601UTC", + "properties": {} + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/12" + } + }, + { + "$type": "ObjectType", + "name": "Bucket_Filter", + "properties": { + "AndOperator": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The container for the AND condition for the lifecycle rule. A combination of Prefix and 1 or more Tags OR a minimum of 2 or more tags." + }, + "Prefix": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Object key prefix that identifies one or more objects to which this rule applies." + }, + "Tag": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "Specifies a tag used to identify a subset of objects for an Amazon S3Outposts bucket." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.S3Outposts/BucketProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "ObjectType", + "name": "AWS.S3Outposts/BucketProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) of the specified bucket." + }, + "BucketName": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "A name for the bucket." + }, + "LifecycleConfiguration": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "Rules that define how Amazon S3Outposts manages objects during their lifetime." + }, + "OutpostId": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The id of the customer outpost on which the bucket resides." + }, + "Tags": { + "type": { + "$ref": "#/19" + }, + "flags": 0, + "description": "An arbitrary set of tags (key-value pairs) for this S3Outposts bucket." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.S3Outposts/Bucket", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/20" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.S3Outposts/Bucket@default", + "scopeType": 0, + "body": { + "$ref": "#/21" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.S3Outposts/BucketPolicyProperties" + }, + { + "$type": "ObjectType", + "name": "BucketPolicy_PolicyDocument", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AWS.S3Outposts/BucketPolicyProperties", + "properties": { + "Bucket": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The Amazon Resource Name (ARN) of the specified bucket." + }, + "PolicyDocument": { + "type": { + "$ref": "#/24" + }, + "flags": 1, + "description": "A policy document containing permissions to add to the specified bucket." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.S3Outposts/BucketPolicy", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/25" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.S3Outposts/BucketPolicy@default", + "scopeType": 0, + "body": { + "$ref": "#/26" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.s3outposts/default/types.md b/artifacts/bicep/aws/aws.s3outposts/default/types.md index 92131975..4e63e228 100644 --- a/artifacts/bicep/aws/aws.s3outposts/default/types.md +++ b/artifacts/bicep/aws/aws.s3outposts/default/types.md @@ -3,23 +3,30 @@ ## Resource AWS.S3Outposts/AccessPoint@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.S3Outposts/AccessPointProperties](#awss3outpostsaccesspointproperties) (Required): properties of the resource +* **properties**: [AWS.S3Outposts/AccessPointProperties](#awss3outpostsaccesspointproperties) (Required, Identifier): properties of the resource ## Resource AWS.S3Outposts/Bucket@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.S3Outposts/BucketProperties](#awss3outpostsbucketproperties) (Required): properties of the resource +* **properties**: [AWS.S3Outposts/BucketProperties](#awss3outpostsbucketproperties) (Required, Identifier): properties of the resource ## Resource AWS.S3Outposts/BucketPolicy@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.S3Outposts/BucketPolicyProperties](#awss3outpostsbucketpolicyproperties) (Required): properties of the resource +* **properties**: [AWS.S3Outposts/BucketPolicyProperties](#awss3outpostsbucketpolicyproperties) (Required, Identifier): properties of the resource + +## AbortIncompleteMultipartUpload +### Properties +* **DaysAfterInitiation**: int (Required): Specifies the number of days after which Amazon S3Outposts aborts an incomplete multipart upload. + +## AccessPoint_Policy +### Properties ## AWS.S3Outposts/AccessPointProperties ### Properties @@ -29,12 +36,10 @@ * **Policy**: [AccessPoint_Policy](#accesspointpolicy): The access point policy associated with this access point. * **VpcConfiguration**: [VpcConfiguration](#vpcconfiguration) (Required): Virtual Private Cloud (VPC) from which requests can be made to the AccessPoint. -## AccessPoint_Policy -### Properties - -## VpcConfiguration +## AWS.S3Outposts/BucketPolicyProperties ### Properties -* **VpcId**: string: Virtual Private Cloud (VPC) Id from which AccessPoint will allow requests. +* **Bucket**: string (Required, Identifier): The Amazon Resource Name (ARN) of the specified bucket. +* **PolicyDocument**: [BucketPolicy_PolicyDocument](#bucketpolicypolicydocument) (Required): A policy document containing permissions to add to the specified bucket. ## AWS.S3Outposts/BucketProperties ### Properties @@ -44,29 +49,15 @@ * **OutpostId**: string (Required): The id of the customer outpost on which the bucket resides. * **Tags**: [Tag](#tag)[]: An arbitrary set of tags (key-value pairs) for this S3Outposts bucket. -## LifecycleConfiguration -### Properties -* **Rules**: [Rule](#rule)[] (Required): A list of lifecycle rules for individual objects in an Amazon S3Outposts bucket. - -## Rule -### Properties -* **AbortIncompleteMultipartUpload**: [AbortIncompleteMultipartUpload](#abortincompletemultipartupload): Specifies a lifecycle rule that stops incomplete multipart uploads to an Amazon S3Outposts bucket. -* **ExpirationDate**: string: Indicates when objects are deleted from Amazon S3Outposts. The date value must be in ISO 8601 format. The time is always midnight UTC. -* **ExpirationInDays**: int: Indicates the number of days after creation when objects are deleted from Amazon S3Outposts. -* **Filter**: [Bucket_Filter](#bucketfilter): The container for the filter of the lifecycle rule. -* **Id**: string: Unique identifier for the lifecycle rule. The value can't be longer than 255 characters. -* **Status**: string - -## AbortIncompleteMultipartUpload -### Properties -* **DaysAfterInitiation**: int (Required): Specifies the number of days after which Amazon S3Outposts aborts an incomplete multipart upload. - ## Bucket_Filter ### Properties * **AndOperator**: [FilterAndOperator](#filterandoperator): The container for the AND condition for the lifecycle rule. A combination of Prefix and 1 or more Tags OR a minimum of 2 or more tags. * **Prefix**: string: Object key prefix that identifies one or more objects to which this rule applies. * **Tag**: [FilterTag](#filtertag): Specifies a tag used to identify a subset of objects for an Amazon S3Outposts bucket. +## BucketPolicy_PolicyDocument +### Properties + ## FilterAndOperator ### Properties @@ -75,16 +66,25 @@ * **Key**: string (Required) * **Value**: string (Required) +## LifecycleConfiguration +### Properties +* **Rules**: [Rule](#rule)[] (Required): A list of lifecycle rules for individual objects in an Amazon S3Outposts bucket. + +## Rule +### Properties +* **AbortIncompleteMultipartUpload**: [AbortIncompleteMultipartUpload](#abortincompletemultipartupload): Specifies a lifecycle rule that stops incomplete multipart uploads to an Amazon S3Outposts bucket. +* **ExpirationDate**: string: Indicates when objects are deleted from Amazon S3Outposts. The date value must be in ISO 8601 format. The time is always midnight UTC. +* **ExpirationInDays**: int: Indicates the number of days after creation when objects are deleted from Amazon S3Outposts. +* **Filter**: [Bucket_Filter](#bucketfilter): The container for the filter of the lifecycle rule. +* **Id**: string: Unique identifier for the lifecycle rule. The value can't be longer than 255 characters. +* **Status**: string + ## Tag ### Properties * **Key**: string (Required) * **Value**: string (Required) -## AWS.S3Outposts/BucketPolicyProperties -### Properties -* **Bucket**: string (Required, Identifier): The Amazon Resource Name (ARN) of the specified bucket. -* **PolicyDocument**: [BucketPolicy_PolicyDocument](#bucketpolicypolicydocument) (Required): A policy document containing permissions to add to the specified bucket. - -## BucketPolicy_PolicyDocument +## VpcConfiguration ### Properties +* **VpcId**: string: Virtual Private Cloud (VPC) Id from which AccessPoint will allow requests. diff --git a/artifacts/bicep/aws/aws.sagemaker/default/types.json b/artifacts/bicep/aws/aws.sagemaker/default/types.json index 81dc1178..e9b491de 100644 --- a/artifacts/bicep/aws/aws.sagemaker/default/types.json +++ b/artifacts/bicep/aws/aws.sagemaker/default/types.json @@ -1 +1,7647 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"FileSystemConfig","Properties":{"DefaultGid":{"Type":3,"Flags":0,"Description":"The default POSIX group ID (GID). If not specified, defaults to 100."},"DefaultUid":{"Type":3,"Flags":0,"Description":"The default POSIX user ID (UID). If not specified, defaults to 1000."},"MountPath":{"Type":4,"Flags":0,"Description":"The path within the image to mount the user's EFS home directory. The directory should be empty. If not specified, defaults to /home/sagemaker-user."}}}},{"2":{"Name":"KernelGatewayImageConfig","Properties":{"FileSystemConfig":{"Type":8,"Flags":0,"Description":"The Amazon Elastic File System (EFS) storage configuration for a SageMaker image."},"KernelSpecs":{"Type":12,"Flags":1,"Description":"The specification of the Jupyter kernels in the image."}}}},{"2":{"Name":"KernelSpec","Properties":{"DisplayName":{"Type":4,"Flags":0,"Description":"The display name of the kernel."},"Name":{"Type":4,"Flags":1,"Description":"The name of the kernel."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"3":{"ItemType":10}},{"2":{"Name":"AWS.SageMaker/AppImageConfigProperties","Properties":{"AppImageConfigArn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) of the AppImageConfig."},"AppImageConfigName":{"Type":4,"Flags":17,"Description":"The Name of the AppImageConfig."},"KernelGatewayImageConfig":{"Type":9,"Flags":0,"Description":"The KernelGatewayImageConfig."},"Tags":{"Type":14,"Flags":4,"Description":"A list of tags to apply to the AppImageConfig."}}}},{"3":{"ItemType":11}},{"2":{"Name":"AWS.SageMaker/AppImageConfig","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":13,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.SageMaker/AppImageConfig@default","ScopeType":0,"Body":15}},{"2":{"Name":"Device","Properties":{"Description":{"Type":4,"Flags":0,"Description":"Description of the device"},"DeviceName":{"Type":4,"Flags":1,"Description":"The name of the device"},"IotThingName":{"Type":4,"Flags":0,"Description":"AWS Internet of Things (IoT) object name."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"Value":{"Type":4,"Flags":1,"Description":"The key value of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}}}},{"2":{"Name":"AWS.SageMaker/DeviceProperties","Properties":{"Device":{"Type":17,"Flags":0,"Description":"The Edge Device you want to register against a device fleet"},"DeviceFleetName":{"Type":4,"Flags":1,"Description":"The name of the edge device fleet"},"Tags":{"Type":20,"Flags":0,"Description":"Associate tags with the resource"}}}},{"3":{"ItemType":18}},{"2":{"Name":"AWS.SageMaker/Device","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":19,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.SageMaker/Device@default","ScopeType":0,"Body":21}},{"2":{"Name":"EdgeOutputConfig","Properties":{"KmsKeyId":{"Type":4,"Flags":0,"Description":"The KMS key id used for encryption on the S3 bucket"},"S3OutputLocation":{"Type":4,"Flags":1,"Description":"The Amazon Simple Storage (S3) bucket URI"}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"Value":{"Type":4,"Flags":1,"Description":"The key value of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}}}},{"2":{"Name":"AWS.SageMaker/DeviceFleetProperties","Properties":{"Description":{"Type":4,"Flags":0,"Description":"Description for the edge device fleet"},"DeviceFleetName":{"Type":4,"Flags":17,"Description":"The name of the edge device fleet"},"OutputConfig":{"Type":23,"Flags":1,"Description":"S3 bucket and an ecryption key id (if available) to store outputs for the fleet"},"RoleArn":{"Type":4,"Flags":1,"Description":"Role associated with the device fleet"},"Tags":{"Type":26,"Flags":0,"Description":"Associate tags with the resource"}}}},{"3":{"ItemType":24}},{"2":{"Name":"AWS.SageMaker/DeviceFleet","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":25,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.SageMaker/DeviceFleet@default","ScopeType":0,"Body":27}},{"2":{"Name":"CodeEditorAppSettings","Properties":{"DefaultResourceSpec":{"Type":45,"Flags":0,"Description":"The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the CodeEditor app."},"LifecycleConfigArns":{"Type":51,"Flags":0,"Description":"A list of LifecycleConfigArns available for use with CodeEditor apps."}}}},{"2":{"Name":"CodeRepository","Properties":{"RepositoryUrl":{"Type":4,"Flags":1,"Description":"A CodeRepository (valid URL) to be used within Jupyter's Git extension."}}}},{"2":{"Name":"CustomFileSystemConfig","Properties":{"EFSFileSystemConfig":{"Type":38,"Flags":0}}}},{"2":{"Name":"CustomImage","Properties":{"AppImageConfigName":{"Type":4,"Flags":1,"Description":"The Name of the AppImageConfig."},"ImageName":{"Type":4,"Flags":1,"Description":"The name of the CustomImage. Must be unique to your account."},"ImageVersionNumber":{"Type":3,"Flags":0,"Description":"The version number of the CustomImage."}}}},{"2":{"Name":"CustomPosixUserConfig","Properties":{"Gid":{"Type":3,"Flags":1},"Uid":{"Type":3,"Flags":1}}}},{"2":{"Name":"DefaultEbsStorageSettings","Properties":{"DefaultEbsVolumeSizeInGb":{"Type":3,"Flags":1,"Description":"Default size of the Amazon EBS volume in Gb"},"MaximumEbsVolumeSizeInGb":{"Type":3,"Flags":1,"Description":"Maximum size of the Amazon EBS volume in Gb. Must be greater than or equal to the DefaultEbsVolumeSizeInGb."}}}},{"2":{"Name":"DefaultSpaceSettings","Properties":{"ExecutionRole":{"Type":4,"Flags":1,"Description":"The execution role for the space."},"JupyterServerAppSettings":{"Type":40,"Flags":0,"Description":"The Jupyter server's app settings."},"KernelGatewayAppSettings":{"Type":41,"Flags":0,"Description":"The kernel gateway app settings."},"SecurityGroups":{"Type":52,"Flags":0,"Description":"The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication."}}}},{"2":{"Name":"DefaultSpaceStorageSettings","Properties":{"DefaultEbsStorageSettings":{"Type":34,"Flags":0}}}},{"2":{"Name":"DomainSettings","Properties":{"RStudioServerProDomainSettings":{"Type":44,"Flags":0},"SecurityGroupIds":{"Type":53,"Flags":0,"Description":"The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps."}}}},{"2":{"Name":"EFSFileSystemConfig","Properties":{"FileSystemId":{"Type":4,"Flags":1},"FileSystemPath":{"Type":4,"Flags":0}}}},{"2":{"Name":"JupyterLabAppSettings","Properties":{"CodeRepositories":{"Type":54,"Flags":0,"Description":"A list of CodeRepositories available for use with JupyterLab apps."},"CustomImages":{"Type":55,"Flags":0,"Description":"A list of custom images for use for JupyterLab apps."},"DefaultResourceSpec":{"Type":45,"Flags":0,"Description":"The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterLab app."},"LifecycleConfigArns":{"Type":56,"Flags":0,"Description":"A list of LifecycleConfigArns available for use with JupyterLab apps."}}}},{"2":{"Name":"JupyterServerAppSettings","Properties":{"DefaultResourceSpec":{"Type":45,"Flags":0}}}},{"2":{"Name":"KernelGatewayAppSettings","Properties":{"CustomImages":{"Type":57,"Flags":0,"Description":"A list of custom SageMaker images that are configured to run as a KernelGateway app."},"DefaultResourceSpec":{"Type":45,"Flags":0,"Description":"The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app."}}}},{"2":{"Name":"RSessionAppSettings","Properties":{"CustomImages":{"Type":58,"Flags":0,"Description":"A list of custom SageMaker images that are configured to run as a KernelGateway app."},"DefaultResourceSpec":{"Type":45,"Flags":0}}}},{"2":{"Name":"RStudioServerProAppSettings","Properties":{"AccessStatus":{"Type":4,"Flags":0,"Description":"Indicates whether the current user has access to the RStudioServerPro app."},"UserGroup":{"Type":4,"Flags":0,"Description":"The level of permissions that the user has within the RStudioServerPro app. This value defaults to User. The Admin value allows the user access to the RStudio Administrative Dashboard."}}}},{"2":{"Name":"RStudioServerProDomainSettings","Properties":{"DefaultResourceSpec":{"Type":45,"Flags":0},"DomainExecutionRoleArn":{"Type":4,"Flags":1,"Description":"The ARN of the execution role for the RStudioServerPro Domain-level app."},"RStudioConnectUrl":{"Type":4,"Flags":0,"Description":"A URL pointing to an RStudio Connect server."},"RStudioPackageManagerUrl":{"Type":4,"Flags":0,"Description":"A URL pointing to an RStudio Package Manager server."}}}},{"2":{"Name":"ResourceSpec","Properties":{"InstanceType":{"Type":4,"Flags":0,"Description":"The instance type that the image version runs on."},"LifecycleConfigArn":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) of the Lifecycle Configuration to attach to the Resource."},"SageMakerImageArn":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) of the SageMaker image that the image version belongs to."},"SageMakerImageVersionArn":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) of the image version created on the instance."}}}},{"2":{"Name":"SharingSettings","Properties":{"NotebookOutputOption":{"Type":4,"Flags":0,"Description":"Whether to include the notebook cell output when sharing the notebook. The default is Disabled."},"S3KmsKeyId":{"Type":4,"Flags":0,"Description":"When NotebookOutputOption is Allowed, the AWS Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket."},"S3OutputPath":{"Type":4,"Flags":0,"Description":"When NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots."}}}},{"2":{"Name":"SpaceEbsVolumeSizeInGb"}},{"2":{"Name":"StudioLifecycleConfigArn"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"UserSettings","Properties":{"CodeEditorAppSettings":{"Type":29,"Flags":0},"CustomFileSystemConfigs":{"Type":59,"Flags":0},"CustomPosixUserConfig":{"Type":33,"Flags":0},"DefaultLandingUri":{"Type":4,"Flags":0,"Description":"Defines which Amazon SageMaker application users are directed to by default."},"ExecutionRole":{"Type":4,"Flags":1,"Description":"The execution role for the user."},"JupyterLabAppSettings":{"Type":39,"Flags":0},"JupyterServerAppSettings":{"Type":40,"Flags":0,"Description":"The Jupyter server's app settings."},"KernelGatewayAppSettings":{"Type":41,"Flags":0,"Description":"The kernel gateway app settings."},"RSessionAppSettings":{"Type":42,"Flags":0},"RStudioServerProAppSettings":{"Type":43,"Flags":0},"SecurityGroups":{"Type":60,"Flags":0,"Description":"The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication."},"SharingSettings":{"Type":46,"Flags":0,"Description":"The sharing settings."},"SpaceStorageSettings":{"Type":36,"Flags":0},"StudioWebPortal":{"Type":4,"Flags":0,"Description":"Indicates whether the Studio experience is available to users. If not, users cannot access Studio."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":30}},{"3":{"ItemType":32}},{"3":{"ItemType":4}},{"3":{"ItemType":32}},{"3":{"ItemType":32}},{"3":{"ItemType":31}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.SageMaker/DomainProperties","Properties":{"AppNetworkAccessType":{"Type":4,"Flags":0,"Description":"Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly."},"AppSecurityGroupManagement":{"Type":4,"Flags":0,"Description":"The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType is VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided."},"AuthMode":{"Type":4,"Flags":1,"Description":"The mode of authentication that members use to access the domain."},"DefaultSpaceSettings":{"Type":35,"Flags":0,"Description":"The default space settings."},"DefaultUserSettings":{"Type":50,"Flags":1,"Description":"The default user settings."},"DomainArn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) of the created domain."},"DomainId":{"Type":4,"Flags":18,"Description":"The domain name."},"DomainName":{"Type":4,"Flags":1,"Description":"A name for the domain."},"DomainSettings":{"Type":37,"Flags":0},"HomeEfsFileSystemId":{"Type":4,"Flags":2,"Description":"The ID of the Amazon Elastic File System (EFS) managed by this Domain."},"KmsKeyId":{"Type":4,"Flags":0,"Description":"SageMaker uses AWS KMS to encrypt the EFS volume attached to the domain with an AWS managed customer master key (CMK) by default."},"SecurityGroupIdForDomainBoundary":{"Type":4,"Flags":2,"Description":"The ID of the security group that authorizes traffic between the RSessionGateway apps and the RStudioServerPro app."},"SingleSignOnApplicationArn":{"Type":4,"Flags":2,"Description":"The ARN of the application managed by SageMaker in IAM Identity Center. This value is only returned for domains created after October 1, 2023."},"SingleSignOnManagedApplicationInstanceId":{"Type":4,"Flags":2,"Description":"The SSO managed application instance ID."},"SubnetIds":{"Type":62,"Flags":1,"Description":"The VPC subnets that Studio uses for communication."},"Tags":{"Type":63,"Flags":4,"Description":"A list of tags to apply to the user profile."},"Url":{"Type":4,"Flags":2,"Description":"The URL to the created domain."},"VpcId":{"Type":4,"Flags":1,"Description":"The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":49}},{"2":{"Name":"AWS.SageMaker/Domain","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":61,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.SageMaker/Domain@default","ScopeType":0,"Body":64}},{"2":{"Name":"DataCatalogConfig","Properties":{"Catalog":{"Type":4,"Flags":1},"Database":{"Type":4,"Flags":1},"TableName":{"Type":4,"Flags":1}}}},{"2":{"Name":"FeatureDefinition","Properties":{"FeatureName":{"Type":4,"Flags":1},"FeatureType":{"Type":4,"Flags":1}}}},{"2":{"Name":"KmsKeyId"}},{"2":{"Name":"OnlineStoreSecurityConfig","Properties":{"KmsKeyId":{"Type":4,"Flags":0}}}},{"2":{"Name":"S3StorageConfig","Properties":{"KmsKeyId":{"Type":4,"Flags":0},"S3Uri":{"Type":4,"Flags":1}}}},{"2":{"Name":"StorageType"}},{"2":{"Name":"TableFormat"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.SageMaker/FeatureGroupProperties","Properties":{"CreationTime":{"Type":4,"Flags":2,"Description":"A timestamp of FeatureGroup creation time."},"Description":{"Type":4,"Flags":0,"Description":"Description about the FeatureGroup."},"EventTimeFeatureName":{"Type":4,"Flags":1,"Description":"The Event Time Feature Name."},"FeatureDefinitions":{"Type":75,"Flags":1,"Description":"An Array of Feature Definition"},"FeatureGroupName":{"Type":4,"Flags":17,"Description":"The Name of the FeatureGroup."},"FeatureGroupStatus":{"Type":4,"Flags":2,"Description":"The status of the feature group."},"OfflineStoreConfig":{"Type":76,"Flags":0},"OnlineStoreConfig":{"Type":77,"Flags":0},"RecordIdentifierFeatureName":{"Type":4,"Flags":1,"Description":"The Record Identifier Feature Name."},"RoleArn":{"Type":4,"Flags":0,"Description":"Role Arn"},"Tags":{"Type":78,"Flags":0,"Description":"An array of key-value pair to apply to this resource."}}}},{"3":{"ItemType":67}},{"2":{"Name":"FeatureGroup_OfflineStoreConfig","Properties":{"DataCatalogConfig":{"Type":66,"Flags":0},"DisableGlueTableCreation":{"Type":2,"Flags":0},"S3StorageConfig":{"Type":70,"Flags":1},"TableFormat":{"Type":4,"Flags":0}}}},{"2":{"Name":"FeatureGroup_OnlineStoreConfig","Properties":{"EnableOnlineStore":{"Type":2,"Flags":0},"SecurityConfig":{"Type":69,"Flags":0},"StorageType":{"Type":4,"Flags":0}}}},{"3":{"ItemType":73}},{"2":{"Name":"AWS.SageMaker/FeatureGroup","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":74,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.SageMaker/FeatureGroup@default","ScopeType":0,"Body":79}},{"2":{"Name":"ImageArn"}},{"2":{"Name":"ImageDescription"}},{"2":{"Name":"ImageDisplayName"}},{"2":{"Name":"ImageName"}},{"2":{"Name":"ImageRoleArn"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}}}},{"2":{"Name":"AWS.SageMaker/ImageProperties","Properties":{"ImageArn":{"Type":4,"Flags":18},"ImageDescription":{"Type":4,"Flags":0},"ImageDisplayName":{"Type":4,"Flags":0},"ImageName":{"Type":4,"Flags":1},"ImageRoleArn":{"Type":4,"Flags":1},"Tags":{"Type":88,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."}}}},{"3":{"ItemType":86}},{"2":{"Name":"AWS.SageMaker/Image","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":87,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.SageMaker/Image@default","ScopeType":0,"Body":89}},{"2":{"Name":"Alias"}},{"2":{"Name":"Aliases"}},{"2":{"Name":"BaseImage"}},{"2":{"Name":"ContainerImage"}},{"2":{"Name":"Horovod"}},{"2":{"Name":"ImageArn"}},{"2":{"Name":"ImageName"}},{"2":{"Name":"ImageVersionArn"}},{"2":{"Name":"JobType"}},{"2":{"Name":"MLFramework"}},{"2":{"Name":"Processor"}},{"2":{"Name":"ProgrammingLang"}},{"2":{"Name":"ReleaseNotes"}},{"2":{"Name":"VendorGuidance"}},{"2":{"Name":"Version"}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.SageMaker/ImageVersionProperties","Properties":{"Alias":{"Type":4,"Flags":4},"Aliases":{"Type":108,"Flags":4},"BaseImage":{"Type":4,"Flags":1},"ContainerImage":{"Type":4,"Flags":2},"Horovod":{"Type":2,"Flags":0},"ImageArn":{"Type":4,"Flags":2},"ImageName":{"Type":4,"Flags":1},"ImageVersionArn":{"Type":4,"Flags":18},"JobType":{"Type":4,"Flags":0},"MLFramework":{"Type":4,"Flags":0},"Processor":{"Type":4,"Flags":0},"ProgrammingLang":{"Type":4,"Flags":0},"ReleaseNotes":{"Type":4,"Flags":0},"VendorGuidance":{"Type":4,"Flags":0},"Version":{"Type":3,"Flags":2}}}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.SageMaker/ImageVersion","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":107,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.SageMaker/ImageVersion@default","ScopeType":0,"Body":109}},{"2":{"Name":"ContainerImage"}},{"2":{"Name":"DeployedImage","Properties":{"ResolutionTime":{"Type":4,"Flags":0},"ResolvedImage":{"Type":4,"Flags":0},"SpecifiedImage":{"Type":4,"Flags":0}}}},{"2":{"Name":"EndpointArn"}},{"2":{"Name":"EndpointName"}},{"2":{"Name":"EnvironmentMap","Properties":{}}},{"2":{"Name":"FailureReason"}},{"2":{"Name":"InferenceComponentArn"}},{"2":{"Name":"InferenceComponentComputeResourceRequirements","Properties":{"MaxMemoryRequiredInMb":{"Type":3,"Flags":0},"MinMemoryRequiredInMb":{"Type":3,"Flags":0},"NumberOfAcceleratorDevicesRequired":{"Type":3,"Flags":0},"NumberOfCpuCoresRequired":{"Type":3,"Flags":0}}}},{"2":{"Name":"InferenceComponentContainerSpecification","Properties":{"ArtifactUrl":{"Type":4,"Flags":0},"DeployedImage":{"Type":112,"Flags":2},"Environment":{"Type":115,"Flags":0},"Image":{"Type":4,"Flags":4}}}},{"2":{"Name":"InferenceComponentCopyCount"}},{"2":{"Name":"InferenceComponentName"}},{"2":{"Name":"InferenceComponentRuntimeConfig","Properties":{"CopyCount":{"Type":3,"Flags":4},"CurrentCopyCount":{"Type":3,"Flags":2},"DesiredCopyCount":{"Type":3,"Flags":2}}}},{"2":{"Name":"InferenceComponentSpecification","Properties":{"ComputeResourceRequirements":{"Type":118,"Flags":1},"Container":{"Type":119,"Flags":0},"ModelName":{"Type":4,"Flags":0},"StartupParameters":{"Type":124,"Flags":0}}}},{"2":{"Name":"InferenceComponentStartupParameters","Properties":{"ContainerStartupHealthCheckTimeoutInSeconds":{"Type":3,"Flags":0},"ModelDataDownloadTimeoutInSeconds":{"Type":3,"Flags":0}}}},{"2":{"Name":"InferenceComponentStatus"}},{"2":{"Name":"MemoryInMb"}},{"2":{"Name":"ModelName"}},{"2":{"Name":"NumberOfAcceleratorDevices"}},{"2":{"Name":"NumberOfCpuCores"}},{"2":{"Name":"StartupParameterTimeoutInSeconds"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -"},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -"}}}},{"2":{"Name":"TagList"}},{"2":{"Name":"Timestamp"}},{"2":{"Name":"Url"}},{"2":{"Name":"VariantName"}},{"3":{"ItemType":131}},{"2":{"Name":"AWS.SageMaker/InferenceComponentProperties","Properties":{"CreationTime":{"Type":4,"Flags":2},"EndpointArn":{"Type":4,"Flags":0},"EndpointName":{"Type":4,"Flags":1},"FailureReason":{"Type":4,"Flags":2},"InferenceComponentArn":{"Type":4,"Flags":18},"InferenceComponentName":{"Type":4,"Flags":0},"InferenceComponentStatus":{"Type":4,"Flags":2},"LastModifiedTime":{"Type":4,"Flags":2},"RuntimeConfig":{"Type":122,"Flags":1},"Specification":{"Type":123,"Flags":1},"Tags":{"Type":138,"Flags":0},"VariantName":{"Type":4,"Flags":1}}}},{"3":{"ItemType":131}},{"2":{"Name":"AWS.SageMaker/InferenceComponent","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":137,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.SageMaker/InferenceComponent@default","ScopeType":0,"Body":139}},{"2":{"Name":"CaptureContentTypeHeader","Properties":{"CsvContentTypes":{"Type":152,"Flags":0,"Description":"The list of all content type headers that SageMaker will treat as CSV and capture accordingly."},"JsonContentTypes":{"Type":153,"Flags":0,"Description":"The list of all content type headers that SageMaker will treat as JSON and capture accordingly."}}}},{"2":{"Name":"DataStorageConfig","Properties":{"ContentType":{"Type":141,"Flags":0},"Destination":{"Type":4,"Flags":1,"Description":"The Amazon S3 bucket where the inference request and response data is stored."},"KmsKey":{"Type":4,"Flags":0,"Description":"The AWS Key Management Service key that Amazon SageMaker uses to encrypt captured data at rest using Amazon S3 server-side encryption."}}}},{"2":{"Name":"EndpointMetadata","Properties":{"EndpointConfigName":{"Type":4,"Flags":0,"Description":"The name of the endpoint configuration."},"EndpointName":{"Type":4,"Flags":1},"EndpointStatus":{"Type":4,"Flags":0,"Description":"The status of the endpoint. For possible values of the status of an endpoint."}}}},{"2":{"Name":"EndpointName"}},{"2":{"Name":"InferenceExperimentSchedule","Properties":{"EndTime":{"Type":4,"Flags":0,"Description":"The timestamp at which the inference experiment ended or will end."},"StartTime":{"Type":4,"Flags":0,"Description":"The timestamp at which the inference experiment started or will start."}}}},{"2":{"Name":"ModelInfrastructureConfig","Properties":{"InfrastructureType":{"Type":4,"Flags":1,"Description":"The type of the inference experiment that you want to run."},"RealTimeInferenceConfig":{"Type":148,"Flags":1}}}},{"2":{"Name":"ModelVariantConfig","Properties":{"InfrastructureConfig":{"Type":146,"Flags":1},"ModelName":{"Type":4,"Flags":1,"Description":"The name of the Amazon SageMaker Model entity."},"VariantName":{"Type":4,"Flags":1,"Description":"The name of the variant."}}}},{"2":{"Name":"RealTimeInferenceConfig","Properties":{"InstanceCount":{"Type":3,"Flags":1,"Description":"The number of instances of the type specified by InstanceType."},"InstanceType":{"Type":4,"Flags":1,"Description":"The instance type the model is deployed to."}}}},{"2":{"Name":"ShadowModeConfig","Properties":{"ShadowModelVariants":{"Type":154,"Flags":1,"Description":"List of shadow variant configurations."},"SourceModelVariantName":{"Type":4,"Flags":1,"Description":"The name of the production variant, which takes all the inference requests."}}}},{"2":{"Name":"ShadowModelVariantConfig","Properties":{"SamplingPercentage":{"Type":3,"Flags":1,"Description":"The percentage of inference requests that Amazon SageMaker replicates from the production variant to the shadow variant."},"ShadowModelVariantName":{"Type":4,"Flags":1,"Description":"The name of the shadow variant."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":150}},{"2":{"Name":"AWS.SageMaker/InferenceExperimentProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) of the inference experiment."},"CreationTime":{"Type":4,"Flags":2,"Description":"The timestamp at which you created the inference experiment."},"DataStorageConfig":{"Type":142,"Flags":0},"Description":{"Type":4,"Flags":0,"Description":"The description of the inference experiment."},"DesiredState":{"Type":4,"Flags":0,"Description":"The desired state of the experiment after starting or stopping operation."},"EndpointMetadata":{"Type":143,"Flags":2},"EndpointName":{"Type":4,"Flags":1},"KmsKey":{"Type":4,"Flags":0,"Description":"The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint."},"LastModifiedTime":{"Type":4,"Flags":2,"Description":"The timestamp at which you last modified the inference experiment."},"ModelVariants":{"Type":156,"Flags":1,"Description":"An array of ModelVariantConfig objects. Each ModelVariantConfig object in the array describes the infrastructure configuration for the corresponding variant."},"Name":{"Type":4,"Flags":17,"Description":"The name for the inference experiment."},"RoleArn":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment."},"Schedule":{"Type":145,"Flags":0},"ShadowModeConfig":{"Type":149,"Flags":0},"Status":{"Type":4,"Flags":2,"Description":"The status of the inference experiment."},"StatusReason":{"Type":4,"Flags":0,"Description":"The error message or client-specified reason from the StopInferenceExperiment API, that explains the status of the inference experiment."},"Tags":{"Type":157,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."},"Type":{"Type":4,"Flags":1,"Description":"The type of the inference experiment that you want to run."}}}},{"3":{"ItemType":147}},{"3":{"ItemType":151}},{"2":{"Name":"AWS.SageMaker/InferenceExperiment","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":155,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.SageMaker/InferenceExperiment@default","ScopeType":0,"Body":158}},{"2":{"Name":"AdditionalInformation","Properties":{"CaveatsAndRecommendations":{"Type":4,"Flags":0,"Description":"Caveats and recommendations for people who might use this model in their applications."},"CustomDetails":{"Type":188,"Flags":0,"Description":"customer details."},"EthicalConsiderations":{"Type":4,"Flags":0,"Description":"Any ethical considerations that the author wants to provide."}}}},{"2":{"Name":"AxisNameArray"}},{"2":{"Name":"AxisNameString"}},{"2":{"Name":"BarChartMetric","Properties":{"Name":{"Type":4,"Flags":1},"Notes":{"Type":4,"Flags":0},"Type":{"Type":4,"Flags":1},"Value":{"Type":190,"Flags":1},"XAxisName":{"Type":191,"Flags":0},"YAxisName":{"Type":4,"Flags":0}}}},{"2":{"Name":"BusinessDetails","Properties":{"BusinessProblem":{"Type":4,"Flags":0,"Description":"What business problem does the model solve?"},"BusinessStakeholders":{"Type":4,"Flags":0,"Description":"Business stakeholders."},"LineOfBusiness":{"Type":4,"Flags":0,"Description":"Line of business."}}}},{"2":{"Name":"Container","Properties":{"Image":{"Type":4,"Flags":1,"Description":"Inference environment path. The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored."},"ModelDataUrl":{"Type":4,"Flags":0,"Description":"The Amazon S3 path where the model artifacts, which result from model training, are stored."},"NearestModelName":{"Type":4,"Flags":0,"Description":"The name of a pre-trained machine learning benchmarked by Amazon SageMaker Inference Recommender model that matches your model."}}}},{"2":{"Name":"Content","Properties":{"AdditionalInformation":{"Type":160,"Flags":0},"BusinessDetails":{"Type":164,"Flags":0},"EvaluationDetails":{"Type":192,"Flags":0},"IntendedUses":{"Type":170,"Flags":0},"ModelOverview":{"Type":174,"Flags":0},"ModelPackageDetails":{"Type":176,"Flags":0},"TrainingDetails":{"Type":184,"Flags":0}}}},{"2":{"Name":"EvaluationDetail","Properties":{"Datasets":{"Type":193,"Flags":0},"EvaluationJobArn":{"Type":4,"Flags":0},"EvaluationObservation":{"Type":4,"Flags":0},"Metadata":{"Type":194,"Flags":0,"Description":"additional attributes associated with the evaluation results."},"MetricGroups":{"Type":195,"Flags":0},"Name":{"Type":4,"Flags":1}}}},{"2":{"Name":"EvaluationDetails"}},{"2":{"Name":"InferenceSpecification","Properties":{"Containers":{"Type":197,"Flags":1,"Description":"Contains inference related information which were used to create model package."}}}},{"2":{"Name":"IntendedUses","Properties":{"ExplanationsForRiskRating":{"Type":4,"Flags":0},"FactorsAffectingModelEfficiency":{"Type":4,"Flags":0},"IntendedUses":{"Type":4,"Flags":0,"Description":"intended use cases."},"PurposeOfModel":{"Type":4,"Flags":0,"Description":"Why the model was developed?"},"RiskRating":{"Type":4,"Flags":0}}}},{"2":{"Name":"LinearGraphMetric","Properties":{"Name":{"Type":4,"Flags":1},"Notes":{"Type":4,"Flags":0},"Type":{"Type":4,"Flags":1},"Value":{"Type":198,"Flags":1},"XAxisName":{"Type":4,"Flags":0},"YAxisName":{"Type":4,"Flags":0}}}},{"2":{"Name":"MatrixMetric","Properties":{"Name":{"Type":4,"Flags":1},"Notes":{"Type":4,"Flags":0},"Type":{"Type":4,"Flags":1},"Value":{"Type":199,"Flags":1},"XAxisName":{"Type":200,"Flags":0},"YAxisName":{"Type":201,"Flags":0}}}},{"2":{"Name":"MetricGroup","Properties":{"MetricData":{"Type":203,"Flags":1},"Name":{"Type":4,"Flags":1}}}},{"2":{"Name":"ModelOverview","Properties":{"AlgorithmType":{"Type":4,"Flags":0,"Description":"Algorithm used to solve the problem."},"InferenceEnvironment":{"Type":205,"Flags":0,"Description":"Overview about the inference."},"ModelArtifact":{"Type":206,"Flags":0,"Description":"Location of the model artifact."},"ModelCreator":{"Type":4,"Flags":0,"Description":"Creator of model."},"ModelDescription":{"Type":4,"Flags":0,"Description":"description of model."},"ModelId":{"Type":4,"Flags":0,"Description":"SageMaker Model Arn or Non SageMaker Model id."},"ModelName":{"Type":4,"Flags":0,"Description":"Name of the model."},"ModelOwner":{"Type":4,"Flags":0,"Description":"Owner of model."},"ModelVersion":{"Type":3,"Flags":0,"Description":"Version of the model."},"ProblemType":{"Type":4,"Flags":0,"Description":"Problem being solved with the model."}}}},{"2":{"Name":"ModelPackageCreator","Properties":{"UserProfileName":{"Type":4,"Flags":0,"Description":"The name of the user's profile in Studio"}}}},{"2":{"Name":"ModelPackageDetails","Properties":{"ApprovalDescription":{"Type":4,"Flags":0,"Description":"A description provided for the model approval"},"CreatedBy":{"Type":175,"Flags":0,"Description":"Information about the user who created model package."},"Domain":{"Type":4,"Flags":0,"Description":"The machine learning domain of the model package you specified. Common machine learning domains include computer vision and natural language processing."},"InferenceSpecification":{"Type":169,"Flags":0,"Description":"Details about inference jobs that can be run with models based on this model package."},"ModelApprovalStatus":{"Type":4,"Flags":0,"Description":"Current approval status of model package"},"ModelPackageArn":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) of the model package"},"ModelPackageDescription":{"Type":4,"Flags":0,"Description":"A brief summary of the model package"},"ModelPackageGroupName":{"Type":4,"Flags":0,"Description":"If the model is a versioned model, the name of the model group that the versioned model belongs to."},"ModelPackageName":{"Type":4,"Flags":0,"Description":"Name of the model package"},"ModelPackageStatus":{"Type":4,"Flags":0,"Description":"Current status of model package"},"ModelPackageVersion":{"Type":3,"Flags":0,"Description":"Version of the model package"},"SourceAlgorithms":{"Type":207,"Flags":0,"Description":"A list of algorithms that were used to create a model package."},"Task":{"Type":4,"Flags":0,"Description":"The machine learning task you specified that your model package accomplishes. Common machine learning tasks include object detection and image classification."}}}},{"2":{"Name":"ObjectiveFunction","Properties":{"Function":{"Type":208,"Flags":0,"Description":"objective function that training job is optimized for."},"Notes":{"Type":4,"Flags":0}}}},{"2":{"Name":"RiskRating"}},{"2":{"Name":"SecurityConfig","Properties":{"KmsKeyId":{"Type":4,"Flags":0,"Description":"A Key Management Service key ID to use for encrypting a model card."}}}},{"2":{"Name":"SimpleMetric","Properties":{"Name":{"Type":4,"Flags":1},"Notes":{"Type":4,"Flags":0},"Type":{"Type":4,"Flags":1},"Value":{"Type":209,"Flags":1},"XAxisName":{"Type":4,"Flags":0},"YAxisName":{"Type":4,"Flags":0}}}},{"2":{"Name":"SourceAlgorithm","Properties":{"AlgorithmName":{"Type":4,"Flags":1,"Description":"The name of an algorithm that was used to create the model package. The algorithm must be either an algorithm resource in your SageMaker account or an algorithm in AWS Marketplace that you are subscribed to."},"ModelDataUrl":{"Type":4,"Flags":0,"Description":"The Amazon S3 path where the model artifacts, which result from model training, are stored."}}}},{"2":{"Name":"SourceAlgorithms"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The tag key. Tag keys must be unique per resource."},"Value":{"Type":4,"Flags":1,"Description":"The tag value."}}}},{"2":{"Name":"TrainingDetails","Properties":{"ObjectiveFunction":{"Type":177,"Flags":0},"TrainingJobDetails":{"Type":218,"Flags":0},"TrainingObservations":{"Type":4,"Flags":0}}}},{"2":{"Name":"TrainingHyperParameter","Properties":{"Name":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"TrainingMetric","Properties":{"Name":{"Type":4,"Flags":1},"Notes":{"Type":4,"Flags":0},"Value":{"Type":3,"Flags":1}}}},{"2":{"Name":"UserContext","Properties":{"DomainId":{"Type":4,"Flags":2,"Description":"The domain associated with the user."},"UserProfileArn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) of the user's profile."},"UserProfileName":{"Type":4,"Flags":2,"Description":"The name of the user's profile."}}}},{"2":{"Name":"ModelCard_CustomDetails","Properties":{}}},{"3":{"ItemType":4}},{"2":{"Name":"ModelCard_Value","Properties":{}}},{"3":{"ItemType":4}},{"3":{"ItemType":167}},{"3":{"ItemType":4}},{"2":{"Name":"ModelCard_Metadata","Properties":{}}},{"3":{"ItemType":173}},{"3":{"ItemType":167}},{"3":{"ItemType":165}},{"2":{"Name":"ModelCard_Value","Properties":{}}},{"2":{"Name":"ModelCard_Value","Properties":{}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"ModelCard_MetricData","Properties":{}}},{"3":{"ItemType":202}},{"3":{"ItemType":4}},{"2":{"Name":"ModelCard_InferenceEnvironment","Properties":{"ContainerImage":{"Type":204,"Flags":0,"Description":"SageMaker inference image uri."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":181}},{"2":{"Name":"ModelCard_Function","Properties":{"Condition":{"Type":4,"Flags":0},"Facet":{"Type":4,"Flags":0},"Function":{"Type":4,"Flags":0}}}},{"2":{"Name":"ModelCard_Value","Properties":{}}},{"3":{"ItemType":181}},{"3":{"ItemType":185}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"ModelCard_TrainingJobDetails_TrainingEnvironment","Properties":{"ContainerImage":{"Type":213,"Flags":0,"Description":"SageMaker training image uri."}}}},{"3":{"ItemType":186}},{"3":{"ItemType":185}},{"3":{"ItemType":186}},{"2":{"Name":"ModelCard_TrainingJobDetails","Properties":{"HyperParameters":{"Type":211,"Flags":0},"TrainingArn":{"Type":4,"Flags":0,"Description":"SageMaker Training job arn."},"TrainingDatasets":{"Type":212,"Flags":0,"Description":"Location of the model datasets."},"TrainingEnvironment":{"Type":214,"Flags":0},"TrainingMetrics":{"Type":215,"Flags":0},"UserProvidedHyperParameters":{"Type":216,"Flags":0},"UserProvidedTrainingMetrics":{"Type":217,"Flags":0}}}},{"2":{"Name":"AWS.SageMaker/ModelCardProperties","Properties":{"Content":{"Type":166,"Flags":1},"CreatedBy":{"Type":187,"Flags":0,"Description":"Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card."},"CreationTime":{"Type":4,"Flags":2,"Description":"The date and time the model card was created."},"LastModifiedBy":{"Type":187,"Flags":0,"Description":"Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card."},"LastModifiedTime":{"Type":4,"Flags":2,"Description":"The date and time the model card was last modified."},"ModelCardArn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) of the successfully created model card."},"ModelCardName":{"Type":4,"Flags":17,"Description":"The unique name of the model card."},"ModelCardProcessingStatus":{"Type":4,"Flags":2,"Description":"The processing status of model card deletion. The ModelCardProcessingStatus updates throughout the different deletion steps."},"ModelCardStatus":{"Type":4,"Flags":1,"Description":"The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval."},"ModelCardVersion":{"Type":3,"Flags":2,"Description":"A version of the model card."},"SecurityConfig":{"Type":179,"Flags":0},"Tags":{"Type":220,"Flags":0,"Description":"Key-value pairs used to manage metadata for model cards."}}}},{"3":{"ItemType":183}},{"2":{"Name":"AWS.SageMaker/ModelCard","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":219,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.SageMaker/ModelCard@default","ScopeType":0,"Body":221}},{"2":{"Name":"AdditionalInferenceSpecificationDefinition","Properties":{"Containers":{"Type":275,"Flags":1,"Description":"The Amazon ECR registry path of the Docker image that contains the inference code."},"Description":{"Type":4,"Flags":0,"Description":"A description of the additional Inference specification."},"Name":{"Type":4,"Flags":1,"Description":"A unique name to identify the additional inference specification. The name must be unique within the list of your additional inference specifications for a particular model package."},"SupportedContentTypes":{"Type":276,"Flags":0,"Description":"The supported MIME types for the input data."},"SupportedRealtimeInferenceInstanceTypes":{"Type":277,"Flags":0,"Description":"A list of the instance types that are used to generate inferences in real-time"},"SupportedResponseMIMETypes":{"Type":278,"Flags":0,"Description":"The supported MIME types for the output data."},"SupportedTransformInstanceTypes":{"Type":279,"Flags":0,"Description":"A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed."}}}},{"2":{"Name":"AdditionalInferenceSpecifications"}},{"2":{"Name":"ApprovalDescription"}},{"2":{"Name":"Bias","Properties":{"PostTrainingReport":{"Type":246,"Flags":0},"PreTrainingReport":{"Type":246,"Flags":0},"Report":{"Type":246,"Flags":0}}}},{"2":{"Name":"CertifyForMarketplace"}},{"2":{"Name":"ClientToken"}},{"2":{"Name":"ContentType"}},{"2":{"Name":"CreationTime"}},{"2":{"Name":"CustomerMetadataProperties","Properties":{}}},{"2":{"Name":"DataSource","Properties":{"S3DataSource":{"Type":261,"Flags":1}}}},{"2":{"Name":"Domain"}},{"2":{"Name":"DriftCheckBaselines","Properties":{"Bias":{"Type":235,"Flags":0},"Explainability":{"Type":236,"Flags":0},"ModelDataQuality":{"Type":237,"Flags":0},"ModelQuality":{"Type":238,"Flags":0}}}},{"2":{"Name":"DriftCheckBias","Properties":{"ConfigFile":{"Type":241,"Flags":0},"PostTrainingConstraints":{"Type":246,"Flags":0},"PreTrainingConstraints":{"Type":246,"Flags":0}}}},{"2":{"Name":"DriftCheckExplainability","Properties":{"ConfigFile":{"Type":241,"Flags":0},"Constraints":{"Type":246,"Flags":0}}}},{"2":{"Name":"DriftCheckModelDataQuality","Properties":{"Constraints":{"Type":246,"Flags":0},"Statistics":{"Type":246,"Flags":0}}}},{"2":{"Name":"DriftCheckModelQuality","Properties":{"Constraints":{"Type":246,"Flags":0},"Statistics":{"Type":246,"Flags":0}}}},{"2":{"Name":"Environment","Properties":{}}},{"2":{"Name":"Explainability","Properties":{"Report":{"Type":246,"Flags":0}}}},{"2":{"Name":"FileSource","Properties":{"ContentDigest":{"Type":4,"Flags":0,"Description":"The digest of the file source."},"ContentType":{"Type":4,"Flags":0,"Description":"The type of content stored in the file source."},"S3Uri":{"Type":4,"Flags":1,"Description":"The Amazon S3 URI for the file source."}}}},{"2":{"Name":"InferenceInstanceType"}},{"2":{"Name":"InferenceSpecification","Properties":{"Containers":{"Type":281,"Flags":1,"Description":"The Amazon ECR registry path of the Docker image that contains the inference code."},"SupportedContentTypes":{"Type":282,"Flags":1,"Description":"The supported MIME types for the input data."},"SupportedRealtimeInferenceInstanceTypes":{"Type":283,"Flags":0,"Description":"A list of the instance types that are used to generate inferences in real-time"},"SupportedResponseMIMETypes":{"Type":284,"Flags":1,"Description":"The supported MIME types for the output data."},"SupportedTransformInstanceTypes":{"Type":285,"Flags":0,"Description":"A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed."}}}},{"2":{"Name":"LastModifiedTime"}},{"2":{"Name":"MetadataProperties","Properties":{"CommitId":{"Type":4,"Flags":0,"Description":"The commit ID."},"GeneratedBy":{"Type":4,"Flags":0,"Description":"The entity this entity was generated by."},"ProjectId":{"Type":4,"Flags":0,"Description":"The project ID metadata."},"Repository":{"Type":4,"Flags":0,"Description":"The repository metadata."}}}},{"2":{"Name":"MetricsSource","Properties":{"ContentDigest":{"Type":4,"Flags":0,"Description":"The digest of the metric source."},"ContentType":{"Type":4,"Flags":1,"Description":"The type of content stored in the metric source."},"S3Uri":{"Type":4,"Flags":1,"Description":"The Amazon S3 URI for the metric source."}}}},{"2":{"Name":"ModelApprovalStatus"}},{"2":{"Name":"ModelDataQuality","Properties":{"Constraints":{"Type":246,"Flags":0},"Statistics":{"Type":246,"Flags":0}}}},{"2":{"Name":"ModelMetrics","Properties":{"Bias":{"Type":226,"Flags":0},"Explainability":{"Type":240,"Flags":0},"ModelDataQuality":{"Type":248,"Flags":0},"ModelQuality":{"Type":259,"Flags":0}}}},{"2":{"Name":"ModelPackageArn"}},{"2":{"Name":"ModelPackageContainerDefinition","Properties":{"ContainerHostname":{"Type":4,"Flags":0,"Description":"The DNS host name for the Docker container."},"Environment":{"Type":239,"Flags":0},"Framework":{"Type":4,"Flags":0,"Description":"The machine learning framework of the model package container image."},"FrameworkVersion":{"Type":4,"Flags":0,"Description":"The framework version of the Model Package Container Image."},"Image":{"Type":4,"Flags":1,"Description":"The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored."},"ImageDigest":{"Type":4,"Flags":0,"Description":"An MD5 hash of the training algorithm that identifies the Docker image used for training."},"ModelDataUrl":{"Type":4,"Flags":0,"Description":"A structure with Model Input details."},"ModelInput":{"Type":286,"Flags":0},"NearestModelName":{"Type":4,"Flags":0,"Description":"The name of a pre-trained machine learning benchmarked by Amazon SageMaker Inference Recommender model that matches your model."}}}},{"2":{"Name":"ModelPackageDescription"}},{"2":{"Name":"ModelPackageGroupName"}},{"2":{"Name":"ModelPackageName"}},{"2":{"Name":"ModelPackageStatus"}},{"2":{"Name":"ModelPackageStatusDetails","Properties":{"ValidationStatuses":{"Type":287,"Flags":0}}}},{"2":{"Name":"ModelPackageStatusItem","Properties":{"FailureReason":{"Type":4,"Flags":0,"Description":"If the overall status is Failed, the reason for the failure."},"Name":{"Type":4,"Flags":1,"Description":"The name of the model package for which the overall status is being reported."},"Status":{"Type":4,"Flags":1,"Description":"The current status."}}}},{"2":{"Name":"ModelPackageVersion"}},{"2":{"Name":"ModelQuality","Properties":{"Constraints":{"Type":246,"Flags":0},"Statistics":{"Type":246,"Flags":0}}}},{"2":{"Name":"ResponseMIMEType"}},{"2":{"Name":"S3DataSource","Properties":{"S3DataType":{"Type":4,"Flags":1,"Description":"The S3 Data Source Type"},"S3Uri":{"Type":4,"Flags":1,"Description":"Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest."}}}},{"2":{"Name":"SamplePayloadUrl"}},{"2":{"Name":"SkipModelValidation"}},{"2":{"Name":"SourceAlgorithm","Properties":{"AlgorithmName":{"Type":4,"Flags":1,"Description":"The name of an algorithm that was used to create the model package. The algorithm must be either an algorithm resource in your Amazon SageMaker account or an algorithm in AWS Marketplace that you are subscribed to."},"ModelDataUrl":{"Type":4,"Flags":0,"Description":"The Amazon S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix)."}}}},{"2":{"Name":"SourceAlgorithmSpecification","Properties":{"SourceAlgorithms":{"Type":288,"Flags":1,"Description":"A list of algorithms that were used to create a model package."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"Task"}},{"2":{"Name":"TransformInput","Properties":{"CompressionType":{"Type":4,"Flags":0,"Description":"If your transform data is compressed, specify the compression type. Amazon SageMaker automatically decompresses the data for the transform job accordingly. The default value is None."},"ContentType":{"Type":4,"Flags":0,"Description":"The multipurpose internet mail extension (MIME) type of the data. Amazon SageMaker uses the MIME type with each http call to transfer data to the transform job."},"DataSource":{"Type":232,"Flags":1},"SplitType":{"Type":4,"Flags":0,"Description":"The method to use to split the transform job's data files into smaller batches. "}}}},{"2":{"Name":"TransformInstanceType"}},{"2":{"Name":"TransformJobDefinition","Properties":{"BatchStrategy":{"Type":4,"Flags":0,"Description":"A string that determines the number of records included in a single mini-batch."},"Environment":{"Type":239,"Flags":0},"MaxConcurrentTransforms":{"Type":3,"Flags":0,"Description":"The maximum number of parallel requests that can be sent to each instance in a transform job. The default value is 1."},"MaxPayloadInMB":{"Type":3,"Flags":0,"Description":"The maximum payload size allowed, in MB. A payload is the data portion of a record (without metadata)."},"TransformInput":{"Type":268,"Flags":1},"TransformOutput":{"Type":271,"Flags":1},"TransformResources":{"Type":272,"Flags":1}}}},{"2":{"Name":"TransformOutput","Properties":{"Accept":{"Type":4,"Flags":0,"Description":"The MIME type used to specify the output data. Amazon SageMaker uses the MIME type with each http call to transfer data from the transform job."},"AssembleWith":{"Type":4,"Flags":0,"Description":"Defines how to assemble the results of the transform job as a single S3 object."},"KmsKeyId":{"Type":4,"Flags":0,"Description":"The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption."},"S3OutputPath":{"Type":4,"Flags":1,"Description":"The Amazon S3 path where you want Amazon SageMaker to store the results of the transform job."}}}},{"2":{"Name":"TransformResources","Properties":{"InstanceCount":{"Type":3,"Flags":1,"Description":"The number of ML compute instances to use in the transform job. For distributed transform jobs, specify a value greater than 1. The default value is 1."},"InstanceType":{"Type":4,"Flags":1,"Description":"The ML compute instance type for the transform job."},"VolumeKmsKeyId":{"Type":4,"Flags":0,"Description":"The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt model data on the storage volume attached to the ML compute instance(s) that run the batch transform job."}}}},{"2":{"Name":"ValidationProfile","Properties":{"ProfileName":{"Type":4,"Flags":1,"Description":"The name of the profile for the model package."},"TransformJobDefinition":{"Type":270,"Flags":1}}}},{"2":{"Name":"ValidationSpecification","Properties":{"ValidationProfiles":{"Type":289,"Flags":1},"ValidationRole":{"Type":4,"Flags":1,"Description":"The IAM roles to be used for the validation of the model package."}}}},{"3":{"ItemType":251}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":223}},{"3":{"ItemType":251}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"ModelPackage_ModelInput","Properties":{"DataInputConfig":{"Type":4,"Flags":1,"Description":"The input configuration object for the model."}}}},{"3":{"ItemType":257}},{"3":{"ItemType":264}},{"3":{"ItemType":273}},{"2":{"Name":"AWS.SageMaker/ModelPackageProperties","Properties":{"AdditionalInferenceSpecifications":{"Type":291,"Flags":0},"AdditionalInferenceSpecificationsToAdd":{"Type":292,"Flags":4},"ApprovalDescription":{"Type":4,"Flags":0},"CertifyForMarketplace":{"Type":2,"Flags":0},"ClientToken":{"Type":4,"Flags":4},"CreationTime":{"Type":4,"Flags":2},"CustomerMetadataProperties":{"Type":231,"Flags":0},"Domain":{"Type":4,"Flags":0},"DriftCheckBaselines":{"Type":234,"Flags":0},"InferenceSpecification":{"Type":243,"Flags":0},"LastModifiedTime":{"Type":4,"Flags":0},"MetadataProperties":{"Type":245,"Flags":0},"ModelApprovalStatus":{"Type":4,"Flags":0},"ModelMetrics":{"Type":249,"Flags":0},"ModelPackageArn":{"Type":4,"Flags":18},"ModelPackageDescription":{"Type":4,"Flags":0},"ModelPackageGroupName":{"Type":4,"Flags":0},"ModelPackageName":{"Type":4,"Flags":0},"ModelPackageStatus":{"Type":4,"Flags":2},"ModelPackageStatusDetails":{"Type":256,"Flags":0},"ModelPackageVersion":{"Type":3,"Flags":0},"SamplePayloadUrl":{"Type":4,"Flags":0},"SkipModelValidation":{"Type":4,"Flags":0},"SourceAlgorithmSpecification":{"Type":265,"Flags":0},"Tags":{"Type":293,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."},"Task":{"Type":4,"Flags":0},"ValidationSpecification":{"Type":274,"Flags":0}}}},{"3":{"ItemType":223}},{"3":{"ItemType":223}},{"3":{"ItemType":266}},{"2":{"Name":"AWS.SageMaker/ModelPackage","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":290,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.SageMaker/ModelPackage@default","ScopeType":0,"Body":294}},{"2":{"Name":"ModelPackageGroupArn"}},{"2":{"Name":"ModelPackageGroupDescription"}},{"2":{"Name":"ModelPackageGroupName"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}}}},{"2":{"Name":"AWS.SageMaker/ModelPackageGroupProperties","Properties":{"CreationTime":{"Type":4,"Flags":2,"Description":"The time at which the model package group was created."},"ModelPackageGroupArn":{"Type":4,"Flags":18},"ModelPackageGroupDescription":{"Type":4,"Flags":0},"ModelPackageGroupName":{"Type":4,"Flags":1},"ModelPackageGroupPolicy":{"Type":302,"Flags":0},"ModelPackageGroupStatus":{"Type":4,"Flags":2,"Description":"The status of a modelpackage group job."},"Tags":{"Type":303,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."}}}},{"2":{"Name":"ModelPackageGroup_ModelPackageGroupPolicy","Properties":{}}},{"5":{"Elements":[301,4]}},{"3":{"ItemType":299}},{"2":{"Name":"AWS.SageMaker/ModelPackageGroup","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":300,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.SageMaker/ModelPackageGroup@default","ScopeType":0,"Body":304}},{"2":{"Name":"BaselineConfig","Properties":{"ConstraintsResource":{"Type":309,"Flags":0},"StatisticsResource":{"Type":333,"Flags":0}}}},{"2":{"Name":"BatchTransformInput","Properties":{"DataCapturedDestinationS3Uri":{"Type":4,"Flags":1,"Description":"A URI that identifies the Amazon S3 storage location where Batch Transform Job captures data."},"DatasetFormat":{"Type":313,"Flags":1},"ExcludeFeaturesAttribute":{"Type":4,"Flags":0,"Description":"Indexes or names of the features to be excluded from analysis"},"LocalPath":{"Type":4,"Flags":1,"Description":"Path to the filesystem where the endpoint data is available to the container."},"S3DataDistributionType":{"Type":4,"Flags":0,"Description":"Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defauts to FullyReplicated"},"S3InputMode":{"Type":4,"Flags":0,"Description":"Whether the Pipe or File is used as the input mode for transfering data for the monitoring job. Pipe mode is recommended for large datasets. File mode is useful for small files that fit in memory. Defaults to File."}}}},{"2":{"Name":"ClusterConfig","Properties":{"InstanceCount":{"Type":3,"Flags":1,"Description":"The number of ML compute instances to use in the model monitoring job. For distributed processing jobs, specify a value greater than 1. The default value is 1."},"InstanceType":{"Type":4,"Flags":1,"Description":"The ML compute instance type for the processing job."},"VolumeKmsKeyId":{"Type":4,"Flags":0,"Description":"The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the model monitoring job."},"VolumeSizeInGB":{"Type":3,"Flags":1,"Description":"The size of the ML storage volume, in gigabytes, that you want to provision. You must specify sufficient ML storage for your scenario."}}}},{"2":{"Name":"ConstraintsResource","Properties":{"S3Uri":{"Type":4,"Flags":0,"Description":"The Amazon S3 URI for baseline constraint file in Amazon S3 that the current monitoring job should validated against."}}}},{"2":{"Name":"ContainerArgument"}},{"2":{"Name":"Csv","Properties":{"Header":{"Type":2,"Flags":0,"Description":"A boolean flag indicating if given CSV has header"}}}},{"2":{"Name":"DataAnalysisTimeString"}},{"2":{"Name":"DatasetFormat","Properties":{"Csv":{"Type":311,"Flags":0},"Json":{"Type":316,"Flags":0},"Parquet":{"Type":2,"Flags":0}}}},{"2":{"Name":"EndpointInput","Properties":{"EndpointName":{"Type":4,"Flags":1},"ExcludeFeaturesAttribute":{"Type":4,"Flags":0,"Description":"Indexes or names of the features to be excluded from analysis"},"LocalPath":{"Type":4,"Flags":1,"Description":"Path to the filesystem where the endpoint data is available to the container."},"S3DataDistributionType":{"Type":4,"Flags":0,"Description":"Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defauts to FullyReplicated"},"S3InputMode":{"Type":4,"Flags":0,"Description":"Whether the Pipe or File is used as the input mode for transfering data for the monitoring job. Pipe mode is recommended for large datasets. File mode is useful for small files that fit in memory. Defaults to File."}}}},{"2":{"Name":"EndpointName"}},{"2":{"Name":"Json","Properties":{"Line":{"Type":2,"Flags":0,"Description":"A boolean flag indicating if it is JSON line format"}}}},{"2":{"Name":"MonitoringAppSpecification","Properties":{"ContainerArguments":{"Type":337,"Flags":0,"Description":"An array of arguments for the container used to run the monitoring job."},"ContainerEntrypoint":{"Type":338,"Flags":0,"Description":"Specifies the entrypoint for a container used to run the monitoring job."},"ImageUri":{"Type":4,"Flags":1,"Description":"The container image to be run by the monitoring job."},"PostAnalyticsProcessorSourceUri":{"Type":4,"Flags":0,"Description":"An Amazon S3 URI to a script that is called after analysis has been performed. Applicable only for the built-in (first party) containers."},"RecordPreprocessorSourceUri":{"Type":4,"Flags":0,"Description":"An Amazon S3 URI to a script that is called per row prior to running analysis. It can base64 decode the payload and convert it into a flatted json so that the built-in container can use the converted data. Applicable only for the built-in (first party) containers"}}}},{"2":{"Name":"MonitoringExecutionSummary","Properties":{"CreationTime":{"Type":4,"Flags":1,"Description":"The time at which the monitoring job was created."},"EndpointName":{"Type":4,"Flags":0},"FailureReason":{"Type":4,"Flags":0,"Description":"Contains the reason a monitoring job failed, if it failed."},"LastModifiedTime":{"Type":4,"Flags":1,"Description":"A timestamp that indicates the last time the monitoring job was modified."},"MonitoringExecutionStatus":{"Type":4,"Flags":1,"Description":"The status of the monitoring job."},"MonitoringScheduleName":{"Type":4,"Flags":1},"ProcessingJobArn":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) of the monitoring job."},"ScheduledTime":{"Type":4,"Flags":1,"Description":"The time the monitoring job was scheduled."}}}},{"2":{"Name":"MonitoringInput","Properties":{"BatchTransformInput":{"Type":307,"Flags":0},"EndpointInput":{"Type":314,"Flags":0}}}},{"2":{"Name":"MonitoringInputs"}},{"2":{"Name":"MonitoringJobDefinition","Properties":{"BaselineConfig":{"Type":306,"Flags":0},"Environment":{"Type":340,"Flags":0,"Description":"Sets the environment variables in the Docker container"},"MonitoringAppSpecification":{"Type":317,"Flags":1},"MonitoringInputs":{"Type":341,"Flags":1},"MonitoringOutputConfig":{"Type":323,"Flags":1},"MonitoringResources":{"Type":324,"Flags":1},"NetworkConfig":{"Type":328,"Flags":0},"RoleArn":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf."},"StoppingCondition":{"Type":334,"Flags":0}}}},{"2":{"Name":"MonitoringOutput","Properties":{"S3Output":{"Type":330,"Flags":1}}}},{"2":{"Name":"MonitoringOutputConfig","Properties":{"KmsKeyId":{"Type":4,"Flags":0,"Description":"The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption."},"MonitoringOutputs":{"Type":342,"Flags":1,"Description":"Monitoring outputs for monitoring jobs. This is where the output of the periodic monitoring jobs is uploaded."}}}},{"2":{"Name":"MonitoringResources","Properties":{"ClusterConfig":{"Type":308,"Flags":1}}}},{"2":{"Name":"MonitoringScheduleConfig","Properties":{"MonitoringJobDefinition":{"Type":321,"Flags":0},"MonitoringJobDefinitionName":{"Type":4,"Flags":0,"Description":"Name of the job definition"},"MonitoringType":{"Type":4,"Flags":0},"ScheduleConfig":{"Type":332,"Flags":0}}}},{"2":{"Name":"MonitoringScheduleName"}},{"2":{"Name":"MonitoringType"}},{"2":{"Name":"NetworkConfig","Properties":{"EnableInterContainerTrafficEncryption":{"Type":2,"Flags":0,"Description":"Whether to encrypt all communications between distributed processing jobs. Choose True to encrypt communications. Encryption provides greater security for distributed processing jobs, but the processing might take longer."},"EnableNetworkIsolation":{"Type":2,"Flags":0,"Description":"Whether to allow inbound and outbound network calls to and from the containers used for the processing job."},"VpcConfig":{"Type":336,"Flags":0}}}},{"2":{"Name":"Parquet"}},{"2":{"Name":"S3Output","Properties":{"LocalPath":{"Type":4,"Flags":1,"Description":"The local path to the Amazon S3 storage location where Amazon SageMaker saves the results of a monitoring job. LocalPath is an absolute path for the output data."},"S3UploadMode":{"Type":4,"Flags":0,"Description":"Whether to upload the results of the monitoring job continuously or after the job completes."},"S3Uri":{"Type":4,"Flags":1,"Description":"A URI that identifies the Amazon S3 storage location where Amazon SageMaker saves the results of a monitoring job."}}}},{"2":{"Name":"S3Uri"}},{"2":{"Name":"ScheduleConfig","Properties":{"DataAnalysisEndTime":{"Type":4,"Flags":0,"Description":"Data Analysis end time, e.g. PT0H"},"DataAnalysisStartTime":{"Type":4,"Flags":0,"Description":"Data Analysis start time, e.g. -PT1H"},"ScheduleExpression":{"Type":4,"Flags":1,"Description":"A cron expression or 'NOW' that describes details about the monitoring schedule."}}}},{"2":{"Name":"StatisticsResource","Properties":{"S3Uri":{"Type":4,"Flags":0,"Description":"The Amazon S3 URI for the baseline statistics file in Amazon S3 that the current monitoring job should be validated against."}}}},{"2":{"Name":"StoppingCondition","Properties":{"MaxRuntimeInSeconds":{"Type":3,"Flags":1,"Description":"The maximum runtime allowed in seconds."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}}}},{"2":{"Name":"VpcConfig","Properties":{"SecurityGroupIds":{"Type":343,"Flags":1,"Description":"The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field."},"Subnets":{"Type":344,"Flags":1,"Description":"The ID of the subnets in the VPC to which you want to connect to your monitoring jobs."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":319}},{"2":{"Name":"MonitoringSchedule_Environment","Properties":{}}},{"3":{"ItemType":319}},{"3":{"ItemType":322}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.SageMaker/MonitoringScheduleProperties","Properties":{"CreationTime":{"Type":4,"Flags":2,"Description":"The time at which the schedule was created."},"EndpointName":{"Type":4,"Flags":0},"FailureReason":{"Type":4,"Flags":0,"Description":"Contains the reason a monitoring job failed, if it failed."},"LastModifiedTime":{"Type":4,"Flags":2,"Description":"A timestamp that indicates the last time the monitoring job was modified."},"LastMonitoringExecutionSummary":{"Type":318,"Flags":0,"Description":"Describes metadata on the last execution to run, if there was one."},"MonitoringScheduleArn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN) of the monitoring schedule."},"MonitoringScheduleConfig":{"Type":325,"Flags":1},"MonitoringScheduleName":{"Type":4,"Flags":1},"MonitoringScheduleStatus":{"Type":4,"Flags":0,"Description":"The status of a schedule job."},"Tags":{"Type":346,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."}}}},{"3":{"ItemType":335}},{"2":{"Name":"AWS.SageMaker/MonitoringSchedule","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":345,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.SageMaker/MonitoringSchedule@default","ScopeType":0,"Body":347}},{"2":{"Name":"S3Location","Properties":{"Bucket":{"Type":4,"Flags":1,"Description":"The name of the S3 bucket where the PipelineDefinition file is stored."},"ETag":{"Type":4,"Flags":0,"Description":"The Amazon S3 ETag (a file checksum) of the PipelineDefinition file. If you don't specify a value, SageMaker skips ETag validation of your PipelineDefinition file."},"Key":{"Type":4,"Flags":1,"Description":"The file name of the PipelineDefinition file (Amazon S3 object name)."},"Version":{"Type":4,"Flags":0,"Description":"For versioning-enabled buckets, a specific version of the PipelineDefinition file."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.SageMaker/PipelineProperties","Properties":{"ParallelismConfiguration":{"Type":352,"Flags":0},"PipelineDefinition":{"Type":353,"Flags":1},"PipelineDescription":{"Type":4,"Flags":0,"Description":"The description of the Pipeline."},"PipelineDisplayName":{"Type":4,"Flags":0,"Description":"The display name of the Pipeline."},"PipelineName":{"Type":4,"Flags":17,"Description":"The name of the Pipeline."},"RoleArn":{"Type":4,"Flags":1,"Description":"Role Arn"},"Tags":{"Type":354,"Flags":0}}}},{"2":{"Name":"Pipeline_ParallelismConfiguration","Properties":{"MaxParallelExecutionSteps":{"Type":3,"Flags":1,"Description":"Maximum parallel execution steps"}}}},{"2":{"Name":"Pipeline_PipelineDefinition","Properties":{}}},{"3":{"ItemType":350}},{"2":{"Name":"AWS.SageMaker/Pipeline","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":351,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.SageMaker/Pipeline@default","ScopeType":0,"Body":355}},{"2":{"Name":"PathId"}},{"2":{"Name":"ProductId"}},{"2":{"Name":"ProjectArn"}},{"2":{"Name":"ProjectDescription"}},{"2":{"Name":"ProjectId"}},{"2":{"Name":"ProjectName"}},{"2":{"Name":"ProvisionedProductStatusMessage"}},{"2":{"Name":"ProvisioningArtifactId"}},{"2":{"Name":"ProvisioningParameter","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The parameter key."},"Value":{"Type":4,"Flags":1,"Description":"The parameter value."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}}}},{"2":{"Name":"AWS.SageMaker/ProjectProperties","Properties":{"CreationTime":{"Type":4,"Flags":2,"Description":"The time at which the project was created."},"ProjectArn":{"Type":4,"Flags":18},"ProjectDescription":{"Type":4,"Flags":0},"ProjectId":{"Type":4,"Flags":2},"ProjectName":{"Type":4,"Flags":1},"ProjectStatus":{"Type":4,"Flags":2,"Description":"The status of a project."},"ServiceCatalogProvisionedProductDetails":{"Type":368,"Flags":0,"Description":"Provisioned ServiceCatalog Details"},"ServiceCatalogProvisioningDetails":{"Type":370,"Flags":1,"Description":"Input ServiceCatalog Provisioning Details"},"Tags":{"Type":371,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."}}}},{"2":{"Name":"Project_ServiceCatalogProvisionedProductDetails","Properties":{"ProvisionedProductId":{"Type":4,"Flags":0},"ProvisionedProductStatusMessage":{"Type":4,"Flags":0}}}},{"3":{"ItemType":365}},{"2":{"Name":"Project_ServiceCatalogProvisioningDetails","Properties":{"PathId":{"Type":4,"Flags":0},"ProductId":{"Type":4,"Flags":1},"ProvisioningArtifactId":{"Type":4,"Flags":0},"ProvisioningParameters":{"Type":369,"Flags":0,"Description":"Parameters specified by the administrator that are required for provisioning the product."}}}},{"3":{"ItemType":366}},{"2":{"Name":"AWS.SageMaker/Project","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":367,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.SageMaker/Project@default","ScopeType":0,"Body":372}},{"2":{"Name":"CustomImage","Properties":{"AppImageConfigName":{"Type":4,"Flags":1,"Description":"The Name of the AppImageConfig."},"ImageName":{"Type":4,"Flags":1,"Description":"The name of the CustomImage. Must be unique to your account."},"ImageVersionNumber":{"Type":3,"Flags":0,"Description":"The version number of the CustomImage."}}}},{"2":{"Name":"JupyterServerAppSettings","Properties":{"DefaultResourceSpec":{"Type":377,"Flags":0}}}},{"2":{"Name":"KernelGatewayAppSettings","Properties":{"CustomImages":{"Type":380,"Flags":0,"Description":"A list of custom SageMaker images that are configured to run as a KernelGateway app."},"DefaultResourceSpec":{"Type":377,"Flags":0,"Description":"The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app."}}}},{"2":{"Name":"ResourceSpec","Properties":{"InstanceType":{"Type":4,"Flags":0,"Description":"The instance type that the image version runs on."},"SageMakerImageArn":{"Type":4,"Flags":0,"Description":"The ARN of the SageMaker image that the image version belongs to."},"SageMakerImageVersionArn":{"Type":4,"Flags":0,"Description":"The ARN of the image version created on the instance."}}}},{"2":{"Name":"SpaceSettings","Properties":{"JupyterServerAppSettings":{"Type":375,"Flags":0,"Description":"The Jupyter server's app settings."},"KernelGatewayAppSettings":{"Type":376,"Flags":0,"Description":"The kernel gateway app settings."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"3":{"ItemType":374}},{"2":{"Name":"AWS.SageMaker/SpaceProperties","Properties":{"DomainId":{"Type":4,"Flags":17,"Description":"The ID of the associated Domain."},"SpaceArn":{"Type":4,"Flags":2,"Description":"The space Amazon Resource Name (ARN)."},"SpaceName":{"Type":4,"Flags":17,"Description":"A name for the Space."},"SpaceSettings":{"Type":378,"Flags":4,"Description":"A collection of settings."},"Tags":{"Type":382,"Flags":4,"Description":"A list of tags to apply to the space."}}}},{"3":{"ItemType":379}},{"2":{"Name":"AWS.SageMaker/Space","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":381,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.SageMaker/Space@default","ScopeType":0,"Body":383}},{"2":{"Name":"CodeEditorAppSettings","Properties":{"DefaultResourceSpec":{"Type":397,"Flags":0,"Description":"The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the CodeEditor app."},"LifecycleConfigArns":{"Type":403,"Flags":0,"Description":"A list of LifecycleConfigArns available for use with CodeEditor apps."}}}},{"2":{"Name":"CodeRepository","Properties":{"RepositoryUrl":{"Type":4,"Flags":1,"Description":"A CodeRepository (valid URL) to be used within Jupyter's Git extension."}}}},{"2":{"Name":"CustomFileSystemConfig","Properties":{"EFSFileSystemConfig":{"Type":392,"Flags":0}}}},{"2":{"Name":"CustomImage","Properties":{"AppImageConfigName":{"Type":4,"Flags":1,"Description":"The Name of the AppImageConfig."},"ImageName":{"Type":4,"Flags":1,"Description":"The name of the CustomImage. Must be unique to your account."},"ImageVersionNumber":{"Type":3,"Flags":0,"Description":"The version number of the CustomImage."}}}},{"2":{"Name":"CustomPosixUserConfig","Properties":{"Gid":{"Type":3,"Flags":1},"Uid":{"Type":3,"Flags":1}}}},{"2":{"Name":"DefaultEbsStorageSettings","Properties":{"DefaultEbsVolumeSizeInGb":{"Type":3,"Flags":1,"Description":"Default size of the Amazon EBS volume in Gb"},"MaximumEbsVolumeSizeInGb":{"Type":3,"Flags":1,"Description":"Maximum size of the Amazon EBS volume in Gb. Must be greater than or equal to the DefaultEbsVolumeSizeInGb."}}}},{"2":{"Name":"DefaultSpaceStorageSettings","Properties":{"DefaultEbsStorageSettings":{"Type":390,"Flags":0}}}},{"2":{"Name":"EFSFileSystemConfig","Properties":{"FileSystemId":{"Type":4,"Flags":1},"FileSystemPath":{"Type":4,"Flags":0}}}},{"2":{"Name":"JupyterLabAppSettings","Properties":{"CodeRepositories":{"Type":404,"Flags":0,"Description":"A list of CodeRepositories available for use with JupyterLab apps."},"CustomImages":{"Type":405,"Flags":0,"Description":"A list of custom images available for use for JupyterLab apps"},"DefaultResourceSpec":{"Type":397,"Flags":0,"Description":"The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterLab app."},"LifecycleConfigArns":{"Type":406,"Flags":0,"Description":"A list of LifecycleConfigArns available for use with JupyterLab apps."}}}},{"2":{"Name":"JupyterServerAppSettings","Properties":{"DefaultResourceSpec":{"Type":397,"Flags":0}}}},{"2":{"Name":"KernelGatewayAppSettings","Properties":{"CustomImages":{"Type":407,"Flags":0,"Description":"A list of custom SageMaker images that are configured to run as a KernelGateway app."},"DefaultResourceSpec":{"Type":397,"Flags":0,"Description":"The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app."}}}},{"2":{"Name":"RStudioServerProAppSettings","Properties":{"AccessStatus":{"Type":4,"Flags":0,"Description":"Indicates whether the current user has access to the RStudioServerPro app."},"UserGroup":{"Type":4,"Flags":0,"Description":"The level of permissions that the user has within the RStudioServerPro app. This value defaults to User. The Admin value allows the user access to the RStudio Administrative Dashboard."}}}},{"2":{"Name":"ResourceSpec","Properties":{"InstanceType":{"Type":4,"Flags":0,"Description":"The instance type that the image version runs on."},"SageMakerImageArn":{"Type":4,"Flags":0,"Description":"The ARN of the SageMaker image that the image version belongs to."},"SageMakerImageVersionArn":{"Type":4,"Flags":0,"Description":"The ARN of the image version created on the instance."}}}},{"2":{"Name":"SharingSettings","Properties":{"NotebookOutputOption":{"Type":4,"Flags":0,"Description":"Whether to include the notebook cell output when sharing the notebook. The default is Disabled."},"S3KmsKeyId":{"Type":4,"Flags":0,"Description":"When NotebookOutputOption is Allowed, the AWS Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket."},"S3OutputPath":{"Type":4,"Flags":0,"Description":"When NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots."}}}},{"2":{"Name":"SpaceEbsVolumeSizeInGb"}},{"2":{"Name":"StudioLifecycleConfigArn"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"UserSettings","Properties":{"CodeEditorAppSettings":{"Type":385,"Flags":0},"CustomFileSystemConfigs":{"Type":408,"Flags":0},"CustomPosixUserConfig":{"Type":389,"Flags":0},"DefaultLandingUri":{"Type":4,"Flags":0,"Description":"Defines which Amazon SageMaker application users are directed to by default."},"ExecutionRole":{"Type":4,"Flags":0,"Description":"The user profile Amazon Resource Name (ARN)."},"JupyterLabAppSettings":{"Type":393,"Flags":0},"JupyterServerAppSettings":{"Type":394,"Flags":0,"Description":"The Jupyter server's app settings."},"KernelGatewayAppSettings":{"Type":395,"Flags":0,"Description":"The kernel gateway app settings."},"RStudioServerProAppSettings":{"Type":396,"Flags":0},"SecurityGroups":{"Type":409,"Flags":0,"Description":"The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication."},"SharingSettings":{"Type":398,"Flags":0,"Description":"The sharing settings."},"SpaceStorageSettings":{"Type":391,"Flags":0},"StudioWebPortal":{"Type":4,"Flags":0,"Description":"Indicates whether the Studio experience is available to users. If not, users cannot access Studio."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":386}},{"3":{"ItemType":388}},{"3":{"ItemType":4}},{"3":{"ItemType":388}},{"3":{"ItemType":387}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.SageMaker/UserProfileProperties","Properties":{"DomainId":{"Type":4,"Flags":17,"Description":"The ID of the associated Domain."},"SingleSignOnUserIdentifier":{"Type":4,"Flags":0,"Description":"A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only supported value is \"UserName\". If the Domain's AuthMode is SSO, this field is required. If the Domain's AuthMode is not SSO, this field cannot be specified."},"SingleSignOnUserValue":{"Type":4,"Flags":0,"Description":"The username of the associated AWS Single Sign-On User for this UserProfile. If the Domain's AuthMode is SSO, this field is required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not SSO, this field cannot be specified."},"Tags":{"Type":411,"Flags":4,"Description":"A list of tags to apply to the user profile."},"UserProfileArn":{"Type":4,"Flags":2,"Description":"The user profile Amazon Resource Name (ARN)."},"UserProfileName":{"Type":4,"Flags":17,"Description":"A name for the UserProfile."},"UserSettings":{"Type":402,"Flags":0,"Description":"A collection of settings."}}}},{"3":{"ItemType":401}},{"2":{"Name":"AWS.SageMaker/UserProfile","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":410,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.SageMaker/UserProfile@default","ScopeType":0,"Body":412}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "CodeEditorAppImageConfig", + "properties": { + "ContainerConfig": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The container configuration for a SageMaker image." + } + } + }, + { + "$type": "ObjectType", + "name": "ContainerConfig", + "properties": { + "ContainerArguments": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "A list of arguments to apply to the container." + }, + "ContainerEntrypoint": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "The custom entry point to use on container." + }, + "ContainerEnvironmentVariables": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "A list of variables to apply to the custom container." + } + } + }, + { + "$type": "ObjectType", + "name": "CustomImageContainerArguments", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CustomImageContainerEntrypoint", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CustomImageContainerEnvironmentVariable", + "properties": { + "Key": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "FileSystemConfig", + "properties": { + "DefaultGid": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The default POSIX group ID (GID). If not specified, defaults to 100." + }, + "DefaultUid": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The default POSIX user ID (UID). If not specified, defaults to 1000." + }, + "MountPath": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The path within the image to mount the user's EFS home directory. The directory should be empty. If not specified, defaults to /home/sagemaker-user." + } + } + }, + { + "$type": "ObjectType", + "name": "JupyterLabAppImageConfig", + "properties": { + "ContainerConfig": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The container configuration for a SageMaker image." + } + } + }, + { + "$type": "ObjectType", + "name": "KernelGatewayImageConfig", + "properties": { + "FileSystemConfig": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The Amazon Elastic File System (EFS) storage configuration for a SageMaker image." + }, + "KernelSpecs": { + "type": { + "$ref": "#/15" + }, + "flags": 1, + "description": "The specification of the Jupyter kernels in the image." + } + } + }, + { + "$type": "ObjectType", + "name": "KernelSpec", + "properties": { + "DisplayName": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The display name of the kernel." + }, + "Name": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The name of the kernel." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/10" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/10" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/8" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.SageMaker/AppImageConfigProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/9" + } + }, + { + "$type": "ObjectType", + "name": "AWS.SageMaker/AppImageConfigProperties", + "properties": { + "AppImageConfigArn": { + "type": { + "$ref": "#/10" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) of the AppImageConfig." + }, + "AppImageConfigName": { + "type": { + "$ref": "#/10" + }, + "flags": 17, + "description": "The Name of the AppImageConfig." + }, + "CodeEditorAppImageConfig": { + "type": { + "$ref": "#/0" + }, + "flags": 0, + "description": "The CodeEditorAppImageConfig." + }, + "JupyterLabAppImageConfig": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "The JupyterLabAppImageConfig." + }, + "KernelGatewayImageConfig": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "The KernelGatewayImageConfig." + }, + "Tags": { + "type": { + "$ref": "#/17" + }, + "flags": 4, + "description": "A list of tags to apply to the AppImageConfig." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SageMaker/AppImageConfig", + "properties": { + "name": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/10" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/18" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SageMaker/AppImageConfig@default", + "scopeType": 0, + "body": { + "$ref": "#/19" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Device", + "properties": { + "Description": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "Description of the device" + }, + "DeviceName": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The name of the device" + }, + "IotThingName": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "AWS Internet of Things (IoT) object name." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + }, + "Value": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The key value of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.SageMaker/DeviceProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/22" + } + }, + { + "$type": "ObjectType", + "name": "AWS.SageMaker/DeviceProperties", + "properties": { + "Device": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "The Edge Device you want to register against a device fleet" + }, + "DeviceFleetName": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The name of the edge device fleet" + }, + "Tags": { + "type": { + "$ref": "#/24" + }, + "flags": 0, + "description": "Associate tags with the resource" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SageMaker/Device", + "properties": { + "name": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/10" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/25" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SageMaker/Device@default", + "scopeType": 0, + "body": { + "$ref": "#/26" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "EdgeOutputConfig", + "properties": { + "KmsKeyId": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The KMS key id used for encryption on the S3 bucket" + }, + "S3OutputLocation": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The Amazon Simple Storage (S3) bucket URI" + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + }, + "Value": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The key value of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.SageMaker/DeviceFleetProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/29" + } + }, + { + "$type": "ObjectType", + "name": "AWS.SageMaker/DeviceFleetProperties", + "properties": { + "Description": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "Description for the edge device fleet" + }, + "DeviceFleetName": { + "type": { + "$ref": "#/10" + }, + "flags": 17, + "description": "The name of the edge device fleet" + }, + "OutputConfig": { + "type": { + "$ref": "#/28" + }, + "flags": 1, + "description": "S3 bucket and an ecryption key id (if available) to store outputs for the fleet" + }, + "RoleArn": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "Role associated with the device fleet" + }, + "Tags": { + "type": { + "$ref": "#/31" + }, + "flags": 0, + "description": "Associate tags with the resource" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SageMaker/DeviceFleet", + "properties": { + "name": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/10" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/32" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SageMaker/DeviceFleet@default", + "scopeType": 0, + "body": { + "$ref": "#/33" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "CodeEditorAppSettings", + "properties": { + "CustomImages": { + "type": { + "$ref": "#/58" + }, + "flags": 0, + "description": "A list of custom images for use for CodeEditor apps." + }, + "DefaultResourceSpec": { + "type": { + "$ref": "#/52" + }, + "flags": 0, + "description": "The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the CodeEditor app." + }, + "LifecycleConfigArns": { + "type": { + "$ref": "#/59" + }, + "flags": 0, + "description": "A list of LifecycleConfigArns available for use with CodeEditor apps." + } + } + }, + { + "$type": "ObjectType", + "name": "CodeRepository", + "properties": { + "RepositoryUrl": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "A CodeRepository (valid URL) to be used within Jupyter's Git extension." + } + } + }, + { + "$type": "ObjectType", + "name": "CustomFileSystemConfig", + "properties": { + "EFSFileSystemConfig": { + "type": { + "$ref": "#/45" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomImage", + "properties": { + "AppImageConfigName": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The Name of the AppImageConfig." + }, + "ImageName": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The name of the CustomImage. Must be unique to your account." + }, + "ImageVersionNumber": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The version number of the CustomImage." + } + } + }, + { + "$type": "ObjectType", + "name": "CustomPosixUserConfig", + "properties": { + "Gid": { + "type": { + "$ref": "#/14" + }, + "flags": 1 + }, + "Uid": { + "type": { + "$ref": "#/14" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DefaultEbsStorageSettings", + "properties": { + "DefaultEbsVolumeSizeInGb": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "Default size of the Amazon EBS volume in Gb" + }, + "MaximumEbsVolumeSizeInGb": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "Maximum size of the Amazon EBS volume in Gb. Must be greater than or equal to the DefaultEbsVolumeSizeInGb." + } + } + }, + { + "$type": "ObjectType", + "name": "DefaultSpaceSettings", + "properties": { + "CustomFileSystemConfigs": { + "type": { + "$ref": "#/60" + }, + "flags": 0 + }, + "CustomPosixUserConfig": { + "type": { + "$ref": "#/39" + }, + "flags": 0, + "description": "The Jupyter lab's custom posix user configurations." + }, + "ExecutionRole": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The execution role for the space." + }, + "JupyterLabAppSettings": { + "type": { + "$ref": "#/46" + }, + "flags": 0, + "description": "The Jupyter lab's app settings." + }, + "JupyterServerAppSettings": { + "type": { + "$ref": "#/47" + }, + "flags": 0, + "description": "The Jupyter server's app settings." + }, + "KernelGatewayAppSettings": { + "type": { + "$ref": "#/48" + }, + "flags": 0, + "description": "The kernel gateway app settings." + }, + "SecurityGroups": { + "type": { + "$ref": "#/61" + }, + "flags": 0, + "description": "The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication." + }, + "SpaceStorageSettings": { + "type": { + "$ref": "#/42" + }, + "flags": 0, + "description": "The Jupyter lab's space storage settings." + } + } + }, + { + "$type": "ObjectType", + "name": "DefaultSpaceStorageSettings", + "properties": { + "DefaultEbsStorageSettings": { + "type": { + "$ref": "#/40" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DockerSettings", + "properties": { + "EnableDockerAccess": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The flag to enable/disable docker-proxy server" + }, + "VpcOnlyTrustedAccounts": { + "type": { + "$ref": "#/62" + }, + "flags": 0, + "description": "A list of account id's that would be used to pull images from in VpcOnly mode" + } + } + }, + { + "$type": "ObjectType", + "name": "DomainSettings", + "properties": { + "DockerSettings": { + "type": { + "$ref": "#/43" + }, + "flags": 0 + }, + "RStudioServerProDomainSettings": { + "type": { + "$ref": "#/51" + }, + "flags": 0 + }, + "SecurityGroupIds": { + "type": { + "$ref": "#/63" + }, + "flags": 0, + "description": "The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps." + } + } + }, + { + "$type": "ObjectType", + "name": "EFSFileSystemConfig", + "properties": { + "FileSystemId": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + }, + "FileSystemPath": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "JupyterLabAppSettings", + "properties": { + "CodeRepositories": { + "type": { + "$ref": "#/64" + }, + "flags": 0, + "description": "A list of CodeRepositories available for use with JupyterLab apps." + }, + "CustomImages": { + "type": { + "$ref": "#/65" + }, + "flags": 0, + "description": "A list of custom images for use for JupyterLab apps." + }, + "DefaultResourceSpec": { + "type": { + "$ref": "#/52" + }, + "flags": 0, + "description": "The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterLab app." + }, + "LifecycleConfigArns": { + "type": { + "$ref": "#/66" + }, + "flags": 0, + "description": "A list of LifecycleConfigArns available for use with JupyterLab apps." + } + } + }, + { + "$type": "ObjectType", + "name": "JupyterServerAppSettings", + "properties": { + "DefaultResourceSpec": { + "type": { + "$ref": "#/52" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "KernelGatewayAppSettings", + "properties": { + "CustomImages": { + "type": { + "$ref": "#/67" + }, + "flags": 0, + "description": "A list of custom SageMaker images that are configured to run as a KernelGateway app." + }, + "DefaultResourceSpec": { + "type": { + "$ref": "#/52" + }, + "flags": 0, + "description": "The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app." + } + } + }, + { + "$type": "ObjectType", + "name": "RSessionAppSettings", + "properties": { + "CustomImages": { + "type": { + "$ref": "#/68" + }, + "flags": 0, + "description": "A list of custom SageMaker images that are configured to run as a KernelGateway app." + }, + "DefaultResourceSpec": { + "type": { + "$ref": "#/52" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "RStudioServerProAppSettings", + "properties": { + "AccessStatus": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "Indicates whether the current user has access to the RStudioServerPro app." + }, + "UserGroup": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The level of permissions that the user has within the RStudioServerPro app. This value defaults to User. The Admin value allows the user access to the RStudio Administrative Dashboard." + } + } + }, + { + "$type": "ObjectType", + "name": "RStudioServerProDomainSettings", + "properties": { + "DefaultResourceSpec": { + "type": { + "$ref": "#/52" + }, + "flags": 0 + }, + "DomainExecutionRoleArn": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The ARN of the execution role for the RStudioServerPro Domain-level app." + }, + "RStudioConnectUrl": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "A URL pointing to an RStudio Connect server." + }, + "RStudioPackageManagerUrl": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "A URL pointing to an RStudio Package Manager server." + } + } + }, + { + "$type": "ObjectType", + "name": "ResourceSpec", + "properties": { + "InstanceType": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The instance type that the image version runs on." + }, + "LifecycleConfigArn": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the Lifecycle Configuration to attach to the Resource." + }, + "SageMakerImageArn": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the SageMaker image that the image version belongs to." + }, + "SageMakerImageVersionArn": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the image version created on the instance." + } + } + }, + { + "$type": "ObjectType", + "name": "SharingSettings", + "properties": { + "NotebookOutputOption": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "Whether to include the notebook cell output when sharing the notebook. The default is Disabled." + }, + "S3KmsKeyId": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "When NotebookOutputOption is Allowed, the AWS Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket." + }, + "S3OutputPath": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "When NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots." + } + } + }, + { + "$type": "ObjectType", + "name": "SpaceEbsVolumeSizeInGb", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "StudioLifecycleConfigArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "UserSettings", + "properties": { + "CodeEditorAppSettings": { + "type": { + "$ref": "#/35" + }, + "flags": 0 + }, + "CustomFileSystemConfigs": { + "type": { + "$ref": "#/69" + }, + "flags": 0 + }, + "CustomPosixUserConfig": { + "type": { + "$ref": "#/39" + }, + "flags": 0 + }, + "DefaultLandingUri": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "Defines which Amazon SageMaker application users are directed to by default." + }, + "ExecutionRole": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The execution role for the user." + }, + "JupyterLabAppSettings": { + "type": { + "$ref": "#/46" + }, + "flags": 0 + }, + "JupyterServerAppSettings": { + "type": { + "$ref": "#/47" + }, + "flags": 0, + "description": "The Jupyter server's app settings." + }, + "KernelGatewayAppSettings": { + "type": { + "$ref": "#/48" + }, + "flags": 0, + "description": "The kernel gateway app settings." + }, + "RSessionAppSettings": { + "type": { + "$ref": "#/49" + }, + "flags": 0 + }, + "RStudioServerProAppSettings": { + "type": { + "$ref": "#/50" + }, + "flags": 0 + }, + "SecurityGroups": { + "type": { + "$ref": "#/70" + }, + "flags": 0, + "description": "The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication." + }, + "SharingSettings": { + "type": { + "$ref": "#/53" + }, + "flags": 0, + "description": "The sharing settings." + }, + "SpaceStorageSettings": { + "type": { + "$ref": "#/42" + }, + "flags": 0 + }, + "StudioWebPortal": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "Indicates whether the Studio experience is available to users. If not, users cannot access Studio." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/38" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/10" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/37" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/10" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/10" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/10" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/36" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/38" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/10" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/38" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/38" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/37" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/10" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.SageMaker/DomainProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/10" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/56" + } + }, + { + "$type": "ObjectType", + "name": "AWS.SageMaker/DomainProperties", + "properties": { + "AppNetworkAccessType": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly." + }, + "AppSecurityGroupManagement": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType is VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided." + }, + "AuthMode": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The mode of authentication that members use to access the domain." + }, + "DefaultSpaceSettings": { + "type": { + "$ref": "#/41" + }, + "flags": 0, + "description": "The default space settings." + }, + "DefaultUserSettings": { + "type": { + "$ref": "#/57" + }, + "flags": 1, + "description": "The default user settings." + }, + "DomainArn": { + "type": { + "$ref": "#/10" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) of the created domain." + }, + "DomainId": { + "type": { + "$ref": "#/10" + }, + "flags": 18, + "description": "The domain name." + }, + "DomainName": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "A name for the domain." + }, + "DomainSettings": { + "type": { + "$ref": "#/44" + }, + "flags": 0 + }, + "HomeEfsFileSystemId": { + "type": { + "$ref": "#/10" + }, + "flags": 2, + "description": "The ID of the Amazon Elastic File System (EFS) managed by this Domain." + }, + "KmsKeyId": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "SageMaker uses AWS KMS to encrypt the EFS volume attached to the domain with an AWS managed customer master key (CMK) by default." + }, + "SecurityGroupIdForDomainBoundary": { + "type": { + "$ref": "#/10" + }, + "flags": 2, + "description": "The ID of the security group that authorizes traffic between the RSessionGateway apps and the RStudioServerPro app." + }, + "SingleSignOnApplicationArn": { + "type": { + "$ref": "#/10" + }, + "flags": 2, + "description": "The ARN of the application managed by SageMaker in IAM Identity Center. This value is only returned for domains created after October 1, 2023." + }, + "SingleSignOnManagedApplicationInstanceId": { + "type": { + "$ref": "#/10" + }, + "flags": 2, + "description": "The SSO managed application instance ID." + }, + "SubnetIds": { + "type": { + "$ref": "#/72" + }, + "flags": 1, + "description": "The VPC subnets that Studio uses for communication." + }, + "Tags": { + "type": { + "$ref": "#/73" + }, + "flags": 4, + "description": "A list of tags to apply to the user profile." + }, + "Url": { + "type": { + "$ref": "#/10" + }, + "flags": 2, + "description": "The URL to the created domain." + }, + "VpcId": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SageMaker/Domain", + "properties": { + "name": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/10" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/74" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SageMaker/Domain@default", + "scopeType": 0, + "body": { + "$ref": "#/75" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "DataCatalogConfig", + "properties": { + "Catalog": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + }, + "Database": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + }, + "TableName": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "FeatureDefinition", + "properties": { + "FeatureName": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + }, + "FeatureType": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "KmsKeyId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "OnlineStoreSecurityConfig", + "properties": { + "KmsKeyId": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "S3StorageConfig", + "properties": { + "KmsKeyId": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "S3Uri": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "StorageType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TableFormat", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ThroughputConfig", + "properties": { + "ProvisionedReadCapacityUnits": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling." + }, + "ProvisionedWriteCapacityUnits": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling." + }, + "ThroughputMode": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ThroughputMode", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TtlDuration", + "properties": { + "Unit": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Unit", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Value", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.SageMaker/FeatureGroupProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/78" + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "ObjectType", + "name": "FeatureGroup_OfflineStoreConfig", + "properties": { + "DataCatalogConfig": { + "type": { + "$ref": "#/77" + }, + "flags": 0 + }, + "DisableGlueTableCreation": { + "type": { + "$ref": "#/92" + }, + "flags": 0 + }, + "S3StorageConfig": { + "type": { + "$ref": "#/81" + }, + "flags": 1 + }, + "TableFormat": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FeatureGroup_OnlineStoreConfig", + "properties": { + "EnableOnlineStore": { + "type": { + "$ref": "#/92" + }, + "flags": 0 + }, + "SecurityConfig": { + "type": { + "$ref": "#/80" + }, + "flags": 0 + }, + "StorageType": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "TtlDuration": { + "type": { + "$ref": "#/87" + }, + "flags": 0 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/84" + } + }, + { + "$type": "ObjectType", + "name": "AWS.SageMaker/FeatureGroupProperties", + "properties": { + "CreationTime": { + "type": { + "$ref": "#/10" + }, + "flags": 2, + "description": "A timestamp of FeatureGroup creation time." + }, + "Description": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "Description about the FeatureGroup." + }, + "EventTimeFeatureName": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The Event Time Feature Name." + }, + "FeatureDefinitions": { + "type": { + "$ref": "#/91" + }, + "flags": 1, + "description": "An Array of Feature Definition" + }, + "FeatureGroupName": { + "type": { + "$ref": "#/10" + }, + "flags": 17, + "description": "The Name of the FeatureGroup." + }, + "FeatureGroupStatus": { + "type": { + "$ref": "#/10" + }, + "flags": 2, + "description": "The status of the feature group." + }, + "OfflineStoreConfig": { + "type": { + "$ref": "#/93" + }, + "flags": 0 + }, + "OnlineStoreConfig": { + "type": { + "$ref": "#/94" + }, + "flags": 0 + }, + "RecordIdentifierFeatureName": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The Record Identifier Feature Name." + }, + "RoleArn": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "Role Arn" + }, + "Tags": { + "type": { + "$ref": "#/95" + }, + "flags": 0, + "description": "An array of key-value pair to apply to this resource." + }, + "ThroughputConfig": { + "type": { + "$ref": "#/85" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SageMaker/FeatureGroup", + "properties": { + "name": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/10" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/96" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SageMaker/FeatureGroup@default", + "scopeType": 0, + "body": { + "$ref": "#/97" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "ImageArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ImageDescription", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ImageDisplayName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ImageName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ImageRoleArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + }, + "Value": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.SageMaker/ImageProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/104" + } + }, + { + "$type": "ObjectType", + "name": "AWS.SageMaker/ImageProperties", + "properties": { + "ImageArn": { + "type": { + "$ref": "#/10" + }, + "flags": 18 + }, + "ImageDescription": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "ImageDisplayName": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "ImageName": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + }, + "ImageRoleArn": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/106" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SageMaker/Image", + "properties": { + "name": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/10" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/107" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SageMaker/Image@default", + "scopeType": 0, + "body": { + "$ref": "#/108" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Alias", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Aliases", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "BaseImage", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ContainerImage", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Horovod", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ImageArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ImageName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ImageVersionArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "JobType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MLFramework", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Processor", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ProgrammingLang", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ReleaseNotes", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "VendorGuidance", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Version", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/10" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.SageMaker/ImageVersionProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/10" + } + }, + { + "$type": "ObjectType", + "name": "AWS.SageMaker/ImageVersionProperties", + "properties": { + "Alias": { + "type": { + "$ref": "#/10" + }, + "flags": 4 + }, + "Aliases": { + "type": { + "$ref": "#/127" + }, + "flags": 4 + }, + "BaseImage": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + }, + "ContainerImage": { + "type": { + "$ref": "#/10" + }, + "flags": 2 + }, + "Horovod": { + "type": { + "$ref": "#/92" + }, + "flags": 0 + }, + "ImageArn": { + "type": { + "$ref": "#/10" + }, + "flags": 2 + }, + "ImageName": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + }, + "ImageVersionArn": { + "type": { + "$ref": "#/10" + }, + "flags": 18 + }, + "JobType": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "MLFramework": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "Processor": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "ProgrammingLang": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "ReleaseNotes": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "VendorGuidance": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "Version": { + "type": { + "$ref": "#/14" + }, + "flags": 2 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SageMaker/ImageVersion", + "properties": { + "name": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/10" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/128" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SageMaker/ImageVersion@default", + "scopeType": 0, + "body": { + "$ref": "#/129" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "ContainerImage", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DeployedImage", + "properties": { + "ResolutionTime": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "ResolvedImage": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "SpecifiedImage": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "EndpointArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "EndpointName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "EnvironmentMap", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "FailureReason", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "InferenceComponentArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "InferenceComponentComputeResourceRequirements", + "properties": { + "MaxMemoryRequiredInMb": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + }, + "MinMemoryRequiredInMb": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + }, + "NumberOfAcceleratorDevicesRequired": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + }, + "NumberOfCpuCoresRequired": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "InferenceComponentContainerSpecification", + "properties": { + "ArtifactUrl": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "DeployedImage": { + "type": { + "$ref": "#/132" + }, + "flags": 2 + }, + "Environment": { + "type": { + "$ref": "#/135" + }, + "flags": 0 + }, + "Image": { + "type": { + "$ref": "#/10" + }, + "flags": 4 + } + } + }, + { + "$type": "ObjectType", + "name": "InferenceComponentCopyCount", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "InferenceComponentName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "InferenceComponentRuntimeConfig", + "properties": { + "CopyCount": { + "type": { + "$ref": "#/14" + }, + "flags": 4 + }, + "CurrentCopyCount": { + "type": { + "$ref": "#/14" + }, + "flags": 2 + }, + "DesiredCopyCount": { + "type": { + "$ref": "#/14" + }, + "flags": 2 + } + } + }, + { + "$type": "ObjectType", + "name": "InferenceComponentSpecification", + "properties": { + "ComputeResourceRequirements": { + "type": { + "$ref": "#/138" + }, + "flags": 1 + }, + "Container": { + "type": { + "$ref": "#/139" + }, + "flags": 0 + }, + "ModelName": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "StartupParameters": { + "type": { + "$ref": "#/144" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "InferenceComponentStartupParameters", + "properties": { + "ContainerStartupHealthCheckTimeoutInSeconds": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + }, + "ModelDataDownloadTimeoutInSeconds": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "InferenceComponentStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MemoryInMb", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ModelName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "NumberOfAcceleratorDevices", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "NumberOfCpuCores", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "StartupParameterTimeoutInSeconds", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -" + }, + "Value": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -" + } + } + }, + { + "$type": "ObjectType", + "name": "TagList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Timestamp", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Url", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "VariantName", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/151" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.SageMaker/InferenceComponentProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/151" + } + }, + { + "$type": "ObjectType", + "name": "AWS.SageMaker/InferenceComponentProperties", + "properties": { + "CreationTime": { + "type": { + "$ref": "#/10" + }, + "flags": 2 + }, + "EndpointArn": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "EndpointName": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + }, + "FailureReason": { + "type": { + "$ref": "#/10" + }, + "flags": 2 + }, + "InferenceComponentArn": { + "type": { + "$ref": "#/10" + }, + "flags": 18 + }, + "InferenceComponentName": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "InferenceComponentStatus": { + "type": { + "$ref": "#/10" + }, + "flags": 2 + }, + "LastModifiedTime": { + "type": { + "$ref": "#/10" + }, + "flags": 2 + }, + "RuntimeConfig": { + "type": { + "$ref": "#/142" + }, + "flags": 1 + }, + "Specification": { + "type": { + "$ref": "#/143" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/158" + }, + "flags": 0 + }, + "VariantName": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SageMaker/InferenceComponent", + "properties": { + "name": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/10" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/159" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SageMaker/InferenceComponent@default", + "scopeType": 0, + "body": { + "$ref": "#/160" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "CaptureContentTypeHeader", + "properties": { + "CsvContentTypes": { + "type": { + "$ref": "#/173" + }, + "flags": 0, + "description": "The list of all content type headers that SageMaker will treat as CSV and capture accordingly." + }, + "JsonContentTypes": { + "type": { + "$ref": "#/174" + }, + "flags": 0, + "description": "The list of all content type headers that SageMaker will treat as JSON and capture accordingly." + } + } + }, + { + "$type": "ObjectType", + "name": "DataStorageConfig", + "properties": { + "ContentType": { + "type": { + "$ref": "#/162" + }, + "flags": 0 + }, + "Destination": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The Amazon S3 bucket where the inference request and response data is stored." + }, + "KmsKey": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The AWS Key Management Service key that Amazon SageMaker uses to encrypt captured data at rest using Amazon S3 server-side encryption." + } + } + }, + { + "$type": "ObjectType", + "name": "EndpointMetadata", + "properties": { + "EndpointConfigName": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The name of the endpoint configuration." + }, + "EndpointName": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + }, + "EndpointStatus": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The status of the endpoint. For possible values of the status of an endpoint." + } + } + }, + { + "$type": "ObjectType", + "name": "EndpointName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "InferenceExperimentSchedule", + "properties": { + "EndTime": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The timestamp at which the inference experiment ended or will end." + }, + "StartTime": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The timestamp at which the inference experiment started or will start." + } + } + }, + { + "$type": "ObjectType", + "name": "ModelInfrastructureConfig", + "properties": { + "InfrastructureType": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The type of the inference experiment that you want to run." + }, + "RealTimeInferenceConfig": { + "type": { + "$ref": "#/169" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ModelVariantConfig", + "properties": { + "InfrastructureConfig": { + "type": { + "$ref": "#/167" + }, + "flags": 1 + }, + "ModelName": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The name of the Amazon SageMaker Model entity." + }, + "VariantName": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The name of the variant." + } + } + }, + { + "$type": "ObjectType", + "name": "RealTimeInferenceConfig", + "properties": { + "InstanceCount": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The number of instances of the type specified by InstanceType." + }, + "InstanceType": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The instance type the model is deployed to." + } + } + }, + { + "$type": "ObjectType", + "name": "ShadowModeConfig", + "properties": { + "ShadowModelVariants": { + "type": { + "$ref": "#/175" + }, + "flags": 1, + "description": "List of shadow variant configurations." + }, + "SourceModelVariantName": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The name of the production variant, which takes all the inference requests." + } + } + }, + { + "$type": "ObjectType", + "name": "ShadowModelVariantConfig", + "properties": { + "SamplingPercentage": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The percentage of inference requests that Amazon SageMaker replicates from the production variant to the shadow variant." + }, + "ShadowModelVariantName": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The name of the shadow variant." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + }, + "Value": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/10" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/10" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/171" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.SageMaker/InferenceExperimentProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/168" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/172" + } + }, + { + "$type": "ObjectType", + "name": "AWS.SageMaker/InferenceExperimentProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/10" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) of the inference experiment." + }, + "CreationTime": { + "type": { + "$ref": "#/10" + }, + "flags": 2, + "description": "The timestamp at which you created the inference experiment." + }, + "DataStorageConfig": { + "type": { + "$ref": "#/163" + }, + "flags": 0 + }, + "Description": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The description of the inference experiment." + }, + "DesiredState": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The desired state of the experiment after starting or stopping operation." + }, + "EndpointMetadata": { + "type": { + "$ref": "#/164" + }, + "flags": 2 + }, + "EndpointName": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + }, + "KmsKey": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint." + }, + "LastModifiedTime": { + "type": { + "$ref": "#/10" + }, + "flags": 2, + "description": "The timestamp at which you last modified the inference experiment." + }, + "ModelVariants": { + "type": { + "$ref": "#/177" + }, + "flags": 1, + "description": "An array of ModelVariantConfig objects. Each ModelVariantConfig object in the array describes the infrastructure configuration for the corresponding variant." + }, + "Name": { + "type": { + "$ref": "#/10" + }, + "flags": 17, + "description": "The name for the inference experiment." + }, + "RoleArn": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment." + }, + "Schedule": { + "type": { + "$ref": "#/166" + }, + "flags": 0 + }, + "ShadowModeConfig": { + "type": { + "$ref": "#/170" + }, + "flags": 0 + }, + "Status": { + "type": { + "$ref": "#/10" + }, + "flags": 2, + "description": "The status of the inference experiment." + }, + "StatusReason": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The error message or client-specified reason from the StopInferenceExperiment API, that explains the status of the inference experiment." + }, + "Tags": { + "type": { + "$ref": "#/178" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + }, + "Type": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The type of the inference experiment that you want to run." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SageMaker/InferenceExperiment", + "properties": { + "name": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/10" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/179" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SageMaker/InferenceExperiment@default", + "scopeType": 0, + "body": { + "$ref": "#/180" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AdditionalInformation", + "properties": { + "CaveatsAndRecommendations": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "Caveats and recommendations for people who might use this model in their applications." + }, + "CustomDetails": { + "type": { + "$ref": "#/210" + }, + "flags": 0, + "description": "customer details." + }, + "EthicalConsiderations": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "Any ethical considerations that the author wants to provide." + } + } + }, + { + "$type": "ObjectType", + "name": "AxisNameArray", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AxisNameString", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "BarChartMetric", + "properties": { + "Name": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + }, + "Notes": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/212" + }, + "flags": 1 + }, + "XAxisName": { + "type": { + "$ref": "#/213" + }, + "flags": 0 + }, + "YAxisName": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BusinessDetails", + "properties": { + "BusinessProblem": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "What business problem does the model solve?" + }, + "BusinessStakeholders": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "Business stakeholders." + }, + "LineOfBusiness": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "Line of business." + } + } + }, + { + "$type": "ObjectType", + "name": "Container", + "properties": { + "Image": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "Inference environment path. The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored." + }, + "ModelDataUrl": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The Amazon S3 path where the model artifacts, which result from model training, are stored." + }, + "NearestModelName": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The name of a pre-trained machine learning benchmarked by Amazon SageMaker Inference Recommender model that matches your model." + } + } + }, + { + "$type": "ObjectType", + "name": "Content", + "properties": { + "AdditionalInformation": { + "type": { + "$ref": "#/182" + }, + "flags": 0 + }, + "BusinessDetails": { + "type": { + "$ref": "#/186" + }, + "flags": 0 + }, + "EvaluationDetails": { + "type": { + "$ref": "#/214" + }, + "flags": 0 + }, + "IntendedUses": { + "type": { + "$ref": "#/192" + }, + "flags": 0 + }, + "ModelOverview": { + "type": { + "$ref": "#/196" + }, + "flags": 0 + }, + "ModelPackageDetails": { + "type": { + "$ref": "#/198" + }, + "flags": 0 + }, + "TrainingDetails": { + "type": { + "$ref": "#/206" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "EvaluationDetail", + "properties": { + "Datasets": { + "type": { + "$ref": "#/215" + }, + "flags": 0 + }, + "EvaluationJobArn": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "EvaluationObservation": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "Metadata": { + "type": { + "$ref": "#/216" + }, + "flags": 0, + "description": "additional attributes associated with the evaluation results." + }, + "MetricGroups": { + "type": { + "$ref": "#/217" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "EvaluationDetails", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "InferenceSpecification", + "properties": { + "Containers": { + "type": { + "$ref": "#/219" + }, + "flags": 1, + "description": "Contains inference related information which were used to create model package." + } + } + }, + { + "$type": "ObjectType", + "name": "IntendedUses", + "properties": { + "ExplanationsForRiskRating": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "FactorsAffectingModelEfficiency": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "IntendedUses": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "intended use cases." + }, + "PurposeOfModel": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "Why the model was developed?" + }, + "RiskRating": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "LinearGraphMetric", + "properties": { + "Name": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + }, + "Notes": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/220" + }, + "flags": 1 + }, + "XAxisName": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "YAxisName": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "MatrixMetric", + "properties": { + "Name": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + }, + "Notes": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/221" + }, + "flags": 1 + }, + "XAxisName": { + "type": { + "$ref": "#/222" + }, + "flags": 0 + }, + "YAxisName": { + "type": { + "$ref": "#/223" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "MetricGroup", + "properties": { + "MetricData": { + "type": { + "$ref": "#/225" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ModelOverview", + "properties": { + "AlgorithmType": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "Algorithm used to solve the problem." + }, + "InferenceEnvironment": { + "type": { + "$ref": "#/227" + }, + "flags": 0, + "description": "Overview about the inference." + }, + "ModelArtifact": { + "type": { + "$ref": "#/228" + }, + "flags": 0, + "description": "Location of the model artifact." + }, + "ModelCreator": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "Creator of model." + }, + "ModelDescription": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "description of model." + }, + "ModelId": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "SageMaker Model Arn or Non SageMaker Model id." + }, + "ModelName": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "Name of the model." + }, + "ModelOwner": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "Owner of model." + }, + "ModelVersion": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "Version of the model." + }, + "ProblemType": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "Problem being solved with the model." + } + } + }, + { + "$type": "ObjectType", + "name": "ModelPackageCreator", + "properties": { + "UserProfileName": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The name of the user's profile in Studio" + } + } + }, + { + "$type": "ObjectType", + "name": "ModelPackageDetails", + "properties": { + "ApprovalDescription": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "A description provided for the model approval" + }, + "CreatedBy": { + "type": { + "$ref": "#/197" + }, + "flags": 0, + "description": "Information about the user who created model package." + }, + "Domain": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The machine learning domain of the model package you specified. Common machine learning domains include computer vision and natural language processing." + }, + "InferenceSpecification": { + "type": { + "$ref": "#/191" + }, + "flags": 0, + "description": "Details about inference jobs that can be run with models based on this model package." + }, + "ModelApprovalStatus": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "Current approval status of model package" + }, + "ModelPackageArn": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the model package" + }, + "ModelPackageDescription": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "A brief summary of the model package" + }, + "ModelPackageGroupName": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "If the model is a versioned model, the name of the model group that the versioned model belongs to." + }, + "ModelPackageName": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "Name of the model package" + }, + "ModelPackageStatus": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "Current status of model package" + }, + "ModelPackageVersion": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "Version of the model package" + }, + "SourceAlgorithms": { + "type": { + "$ref": "#/229" + }, + "flags": 0, + "description": "A list of algorithms that were used to create a model package." + }, + "Task": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The machine learning task you specified that your model package accomplishes. Common machine learning tasks include object detection and image classification." + } + } + }, + { + "$type": "ObjectType", + "name": "ObjectiveFunction", + "properties": { + "Function": { + "type": { + "$ref": "#/230" + }, + "flags": 0, + "description": "objective function that training job is optimized for." + }, + "Notes": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "RiskRating", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SecurityConfig", + "properties": { + "KmsKeyId": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "A Key Management Service key ID to use for encrypting a model card." + } + } + }, + { + "$type": "ObjectType", + "name": "SimpleMetric", + "properties": { + "Name": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + }, + "Notes": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/231" + }, + "flags": 1 + }, + "XAxisName": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "YAxisName": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SourceAlgorithm", + "properties": { + "AlgorithmName": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The name of an algorithm that was used to create the model package. The algorithm must be either an algorithm resource in your SageMaker account or an algorithm in AWS Marketplace that you are subscribed to." + }, + "ModelDataUrl": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The Amazon S3 path where the model artifacts, which result from model training, are stored." + } + } + }, + { + "$type": "ObjectType", + "name": "SourceAlgorithms", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The tag key. Tag keys must be unique per resource." + }, + "Value": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The tag value." + } + } + }, + { + "$type": "ObjectType", + "name": "TrainingDetails", + "properties": { + "ObjectiveFunction": { + "type": { + "$ref": "#/199" + }, + "flags": 0 + }, + "TrainingJobDetails": { + "type": { + "$ref": "#/240" + }, + "flags": 0 + }, + "TrainingObservations": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TrainingHyperParameter", + "properties": { + "Name": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TrainingMetric", + "properties": { + "Name": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + }, + "Notes": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/14" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "UserContext", + "properties": { + "DomainId": { + "type": { + "$ref": "#/10" + }, + "flags": 2, + "description": "The domain associated with the user." + }, + "UserProfileArn": { + "type": { + "$ref": "#/10" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) of the user's profile." + }, + "UserProfileName": { + "type": { + "$ref": "#/10" + }, + "flags": 2, + "description": "The name of the user's profile." + } + } + }, + { + "$type": "ObjectType", + "name": "ModelCard_CustomDetails", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/10" + } + }, + { + "$type": "ObjectType", + "name": "ModelCard_Value", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/10" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/189" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/10" + } + }, + { + "$type": "ObjectType", + "name": "ModelCard_Metadata", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/195" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/189" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/187" + } + }, + { + "$type": "ObjectType", + "name": "ModelCard_Value", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ModelCard_Value", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/10" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/10" + } + }, + { + "$type": "ObjectType", + "name": "ModelCard_MetricData", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/224" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/10" + } + }, + { + "$type": "ObjectType", + "name": "ModelCard_InferenceEnvironment", + "properties": { + "ContainerImage": { + "type": { + "$ref": "#/226" + }, + "flags": 0, + "description": "SageMaker inference image uri." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/10" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/203" + } + }, + { + "$type": "ObjectType", + "name": "ModelCard_Function", + "properties": { + "Condition": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "Facet": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "Function": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ModelCard_Value", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/203" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/207" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/10" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/10" + } + }, + { + "$type": "ObjectType", + "name": "ModelCard_TrainingJobDetails_TrainingEnvironment", + "properties": { + "ContainerImage": { + "type": { + "$ref": "#/235" + }, + "flags": 0, + "description": "SageMaker training image uri." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/208" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/207" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/208" + } + }, + { + "$type": "ObjectType", + "name": "ModelCard_TrainingJobDetails", + "properties": { + "HyperParameters": { + "type": { + "$ref": "#/233" + }, + "flags": 0 + }, + "TrainingArn": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "SageMaker Training job arn." + }, + "TrainingDatasets": { + "type": { + "$ref": "#/234" + }, + "flags": 0, + "description": "Location of the model datasets." + }, + "TrainingEnvironment": { + "type": { + "$ref": "#/236" + }, + "flags": 0 + }, + "TrainingMetrics": { + "type": { + "$ref": "#/237" + }, + "flags": 0 + }, + "UserProvidedHyperParameters": { + "type": { + "$ref": "#/238" + }, + "flags": 0 + }, + "UserProvidedTrainingMetrics": { + "type": { + "$ref": "#/239" + }, + "flags": 0 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.SageMaker/ModelCardProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/205" + } + }, + { + "$type": "ObjectType", + "name": "AWS.SageMaker/ModelCardProperties", + "properties": { + "Content": { + "type": { + "$ref": "#/188" + }, + "flags": 1 + }, + "CreatedBy": { + "type": { + "$ref": "#/209" + }, + "flags": 0, + "description": "Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card." + }, + "CreationTime": { + "type": { + "$ref": "#/10" + }, + "flags": 2, + "description": "The date and time the model card was created." + }, + "LastModifiedBy": { + "type": { + "$ref": "#/209" + }, + "flags": 0, + "description": "Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card." + }, + "LastModifiedTime": { + "type": { + "$ref": "#/10" + }, + "flags": 2, + "description": "The date and time the model card was last modified." + }, + "ModelCardArn": { + "type": { + "$ref": "#/10" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) of the successfully created model card." + }, + "ModelCardName": { + "type": { + "$ref": "#/10" + }, + "flags": 17, + "description": "The unique name of the model card." + }, + "ModelCardProcessingStatus": { + "type": { + "$ref": "#/10" + }, + "flags": 2, + "description": "The processing status of model card deletion. The ModelCardProcessingStatus updates throughout the different deletion steps." + }, + "ModelCardStatus": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval." + }, + "ModelCardVersion": { + "type": { + "$ref": "#/14" + }, + "flags": 2, + "description": "A version of the model card." + }, + "SecurityConfig": { + "type": { + "$ref": "#/201" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/242" + }, + "flags": 0, + "description": "Key-value pairs used to manage metadata for model cards." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SageMaker/ModelCard", + "properties": { + "name": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/10" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/243" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SageMaker/ModelCard@default", + "scopeType": 0, + "body": { + "$ref": "#/244" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AdditionalInferenceSpecificationDefinition", + "properties": { + "Containers": { + "type": { + "$ref": "#/298" + }, + "flags": 1, + "description": "The Amazon ECR registry path of the Docker image that contains the inference code." + }, + "Description": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "A description of the additional Inference specification." + }, + "Name": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "A unique name to identify the additional inference specification. The name must be unique within the list of your additional inference specifications for a particular model package." + }, + "SupportedContentTypes": { + "type": { + "$ref": "#/299" + }, + "flags": 0, + "description": "The supported MIME types for the input data." + }, + "SupportedRealtimeInferenceInstanceTypes": { + "type": { + "$ref": "#/300" + }, + "flags": 0, + "description": "A list of the instance types that are used to generate inferences in real-time" + }, + "SupportedResponseMIMETypes": { + "type": { + "$ref": "#/301" + }, + "flags": 0, + "description": "The supported MIME types for the output data." + }, + "SupportedTransformInstanceTypes": { + "type": { + "$ref": "#/302" + }, + "flags": 0, + "description": "A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed." + } + } + }, + { + "$type": "ObjectType", + "name": "AdditionalInferenceSpecifications", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ApprovalDescription", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Bias", + "properties": { + "PostTrainingReport": { + "type": { + "$ref": "#/269" + }, + "flags": 0 + }, + "PreTrainingReport": { + "type": { + "$ref": "#/269" + }, + "flags": 0 + }, + "Report": { + "type": { + "$ref": "#/269" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CertifyForMarketplace", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ClientToken", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ContentType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CreationTime", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CustomerMetadataProperties", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DataSource", + "properties": { + "S3DataSource": { + "type": { + "$ref": "#/284" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Domain", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DriftCheckBaselines", + "properties": { + "Bias": { + "type": { + "$ref": "#/258" + }, + "flags": 0 + }, + "Explainability": { + "type": { + "$ref": "#/259" + }, + "flags": 0 + }, + "ModelDataQuality": { + "type": { + "$ref": "#/260" + }, + "flags": 0 + }, + "ModelQuality": { + "type": { + "$ref": "#/261" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DriftCheckBias", + "properties": { + "ConfigFile": { + "type": { + "$ref": "#/264" + }, + "flags": 0 + }, + "PostTrainingConstraints": { + "type": { + "$ref": "#/269" + }, + "flags": 0 + }, + "PreTrainingConstraints": { + "type": { + "$ref": "#/269" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DriftCheckExplainability", + "properties": { + "ConfigFile": { + "type": { + "$ref": "#/264" + }, + "flags": 0 + }, + "Constraints": { + "type": { + "$ref": "#/269" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DriftCheckModelDataQuality", + "properties": { + "Constraints": { + "type": { + "$ref": "#/269" + }, + "flags": 0 + }, + "Statistics": { + "type": { + "$ref": "#/269" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DriftCheckModelQuality", + "properties": { + "Constraints": { + "type": { + "$ref": "#/269" + }, + "flags": 0 + }, + "Statistics": { + "type": { + "$ref": "#/269" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Environment", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Explainability", + "properties": { + "Report": { + "type": { + "$ref": "#/269" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FileSource", + "properties": { + "ContentDigest": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The digest of the file source." + }, + "ContentType": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The type of content stored in the file source." + }, + "S3Uri": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The Amazon S3 URI for the file source." + } + } + }, + { + "$type": "ObjectType", + "name": "InferenceInstanceType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "InferenceSpecification", + "properties": { + "Containers": { + "type": { + "$ref": "#/304" + }, + "flags": 1, + "description": "The Amazon ECR registry path of the Docker image that contains the inference code." + }, + "SupportedContentTypes": { + "type": { + "$ref": "#/305" + }, + "flags": 1, + "description": "The supported MIME types for the input data." + }, + "SupportedRealtimeInferenceInstanceTypes": { + "type": { + "$ref": "#/306" + }, + "flags": 0, + "description": "A list of the instance types that are used to generate inferences in real-time" + }, + "SupportedResponseMIMETypes": { + "type": { + "$ref": "#/307" + }, + "flags": 1, + "description": "The supported MIME types for the output data." + }, + "SupportedTransformInstanceTypes": { + "type": { + "$ref": "#/308" + }, + "flags": 0, + "description": "A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed." + } + } + }, + { + "$type": "ObjectType", + "name": "LastModifiedTime", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MetadataProperties", + "properties": { + "CommitId": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The commit ID." + }, + "GeneratedBy": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The entity this entity was generated by." + }, + "ProjectId": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The project ID metadata." + }, + "Repository": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The repository metadata." + } + } + }, + { + "$type": "ObjectType", + "name": "MetricsSource", + "properties": { + "ContentDigest": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The digest of the metric source." + }, + "ContentType": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The type of content stored in the metric source." + }, + "S3Uri": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The Amazon S3 URI for the metric source." + } + } + }, + { + "$type": "ObjectType", + "name": "ModelApprovalStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ModelDataQuality", + "properties": { + "Constraints": { + "type": { + "$ref": "#/269" + }, + "flags": 0 + }, + "Statistics": { + "type": { + "$ref": "#/269" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ModelMetrics", + "properties": { + "Bias": { + "type": { + "$ref": "#/249" + }, + "flags": 0 + }, + "Explainability": { + "type": { + "$ref": "#/263" + }, + "flags": 0 + }, + "ModelDataQuality": { + "type": { + "$ref": "#/271" + }, + "flags": 0 + }, + "ModelQuality": { + "type": { + "$ref": "#/282" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ModelPackageArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ModelPackageContainerDefinition", + "properties": { + "ContainerHostname": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The DNS host name for the Docker container." + }, + "Environment": { + "type": { + "$ref": "#/262" + }, + "flags": 0 + }, + "Framework": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The machine learning framework of the model package container image." + }, + "FrameworkVersion": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The framework version of the Model Package Container Image." + }, + "Image": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored." + }, + "ImageDigest": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "An MD5 hash of the training algorithm that identifies the Docker image used for training." + }, + "ModelDataUrl": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "A structure with Model Input details." + }, + "ModelInput": { + "type": { + "$ref": "#/309" + }, + "flags": 0 + }, + "NearestModelName": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The name of a pre-trained machine learning benchmarked by Amazon SageMaker Inference Recommender model that matches your model." + } + } + }, + { + "$type": "ObjectType", + "name": "ModelPackageDescription", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ModelPackageGroupName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ModelPackageName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ModelPackageStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ModelPackageStatusDetails", + "properties": { + "ValidationStatuses": { + "type": { + "$ref": "#/310" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ModelPackageStatusItem", + "properties": { + "FailureReason": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "If the overall status is Failed, the reason for the failure." + }, + "Name": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The name of the model package for which the overall status is being reported." + }, + "Status": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The current status." + } + } + }, + { + "$type": "ObjectType", + "name": "ModelPackageVersion", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ModelQuality", + "properties": { + "Constraints": { + "type": { + "$ref": "#/269" + }, + "flags": 0 + }, + "Statistics": { + "type": { + "$ref": "#/269" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ResponseMIMEType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "S3DataSource", + "properties": { + "S3DataType": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The S3 Data Source Type" + }, + "S3Uri": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest." + } + } + }, + { + "$type": "ObjectType", + "name": "SamplePayloadUrl", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SkipModelValidation", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SourceAlgorithm", + "properties": { + "AlgorithmName": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The name of an algorithm that was used to create the model package. The algorithm must be either an algorithm resource in your Amazon SageMaker account or an algorithm in AWS Marketplace that you are subscribed to." + }, + "ModelDataUrl": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The Amazon S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix)." + } + } + }, + { + "$type": "ObjectType", + "name": "SourceAlgorithmSpecification", + "properties": { + "SourceAlgorithms": { + "type": { + "$ref": "#/311" + }, + "flags": 1, + "description": "A list of algorithms that were used to create a model package." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "ObjectType", + "name": "Task", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TransformInput", + "properties": { + "CompressionType": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "If your transform data is compressed, specify the compression type. Amazon SageMaker automatically decompresses the data for the transform job accordingly. The default value is None." + }, + "ContentType": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The multipurpose internet mail extension (MIME) type of the data. Amazon SageMaker uses the MIME type with each http call to transfer data to the transform job." + }, + "DataSource": { + "type": { + "$ref": "#/255" + }, + "flags": 1 + }, + "SplitType": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The method to use to split the transform job's data files into smaller batches. " + } + } + }, + { + "$type": "ObjectType", + "name": "TransformInstanceType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TransformJobDefinition", + "properties": { + "BatchStrategy": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "A string that determines the number of records included in a single mini-batch." + }, + "Environment": { + "type": { + "$ref": "#/262" + }, + "flags": 0 + }, + "MaxConcurrentTransforms": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The maximum number of parallel requests that can be sent to each instance in a transform job. The default value is 1." + }, + "MaxPayloadInMB": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The maximum payload size allowed, in MB. A payload is the data portion of a record (without metadata)." + }, + "TransformInput": { + "type": { + "$ref": "#/291" + }, + "flags": 1 + }, + "TransformOutput": { + "type": { + "$ref": "#/294" + }, + "flags": 1 + }, + "TransformResources": { + "type": { + "$ref": "#/295" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TransformOutput", + "properties": { + "Accept": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The MIME type used to specify the output data. Amazon SageMaker uses the MIME type with each http call to transfer data from the transform job." + }, + "AssembleWith": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "Defines how to assemble the results of the transform job as a single S3 object." + }, + "KmsKeyId": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption." + }, + "S3OutputPath": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The Amazon S3 path where you want Amazon SageMaker to store the results of the transform job." + } + } + }, + { + "$type": "ObjectType", + "name": "TransformResources", + "properties": { + "InstanceCount": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The number of ML compute instances to use in the transform job. For distributed transform jobs, specify a value greater than 1. The default value is 1." + }, + "InstanceType": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The ML compute instance type for the transform job." + }, + "VolumeKmsKeyId": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt model data on the storage volume attached to the ML compute instance(s) that run the batch transform job." + } + } + }, + { + "$type": "ObjectType", + "name": "ValidationProfile", + "properties": { + "ProfileName": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The name of the profile for the model package." + }, + "TransformJobDefinition": { + "type": { + "$ref": "#/293" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ValidationSpecification", + "properties": { + "ValidationProfiles": { + "type": { + "$ref": "#/312" + }, + "flags": 1 + }, + "ValidationRole": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The IAM roles to be used for the validation of the model package." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/274" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/10" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/10" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/10" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/10" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/246" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/274" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/10" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/10" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/10" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/10" + } + }, + { + "$type": "ObjectType", + "name": "ModelPackage_ModelInput", + "properties": { + "DataInputConfig": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The input configuration object for the model." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/280" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/287" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/296" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.SageMaker/ModelPackageProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/246" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/246" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/289" + } + }, + { + "$type": "ObjectType", + "name": "AWS.SageMaker/ModelPackageProperties", + "properties": { + "AdditionalInferenceSpecifications": { + "type": { + "$ref": "#/314" + }, + "flags": 0 + }, + "AdditionalInferenceSpecificationsToAdd": { + "type": { + "$ref": "#/315" + }, + "flags": 4 + }, + "ApprovalDescription": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "CertifyForMarketplace": { + "type": { + "$ref": "#/92" + }, + "flags": 0 + }, + "ClientToken": { + "type": { + "$ref": "#/10" + }, + "flags": 4 + }, + "CreationTime": { + "type": { + "$ref": "#/10" + }, + "flags": 2 + }, + "CustomerMetadataProperties": { + "type": { + "$ref": "#/254" + }, + "flags": 0 + }, + "Domain": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "DriftCheckBaselines": { + "type": { + "$ref": "#/257" + }, + "flags": 0 + }, + "InferenceSpecification": { + "type": { + "$ref": "#/266" + }, + "flags": 0 + }, + "LastModifiedTime": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "MetadataProperties": { + "type": { + "$ref": "#/268" + }, + "flags": 0 + }, + "ModelApprovalStatus": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "ModelMetrics": { + "type": { + "$ref": "#/272" + }, + "flags": 0 + }, + "ModelPackageArn": { + "type": { + "$ref": "#/10" + }, + "flags": 18 + }, + "ModelPackageDescription": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "ModelPackageGroupName": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "ModelPackageName": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "ModelPackageStatus": { + "type": { + "$ref": "#/10" + }, + "flags": 2 + }, + "ModelPackageStatusDetails": { + "type": { + "$ref": "#/279" + }, + "flags": 0 + }, + "ModelPackageVersion": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + }, + "SamplePayloadUrl": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "SkipModelValidation": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "SourceAlgorithmSpecification": { + "type": { + "$ref": "#/288" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/316" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + }, + "Task": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "ValidationSpecification": { + "type": { + "$ref": "#/297" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SageMaker/ModelPackage", + "properties": { + "name": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/10" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/317" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SageMaker/ModelPackage@default", + "scopeType": 0, + "body": { + "$ref": "#/318" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "ModelPackageGroupArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ModelPackageGroupDescription", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ModelPackageGroupName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + }, + "Value": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.SageMaker/ModelPackageGroupProperties" + }, + { + "$type": "ObjectType", + "name": "ModelPackageGroup_ModelPackageGroupPolicy", + "properties": {} + }, + { + "$type": "UnionType", + "elements": [ + { + "$ref": "#/325" + }, + { + "$ref": "#/10" + } + ] + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/323" + } + }, + { + "$type": "ObjectType", + "name": "AWS.SageMaker/ModelPackageGroupProperties", + "properties": { + "CreationTime": { + "type": { + "$ref": "#/10" + }, + "flags": 2, + "description": "The time at which the model package group was created." + }, + "ModelPackageGroupArn": { + "type": { + "$ref": "#/10" + }, + "flags": 18 + }, + "ModelPackageGroupDescription": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "ModelPackageGroupName": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + }, + "ModelPackageGroupPolicy": { + "type": { + "$ref": "#/326" + }, + "flags": 0 + }, + "ModelPackageGroupStatus": { + "type": { + "$ref": "#/10" + }, + "flags": 2, + "description": "The status of a modelpackage group job." + }, + "Tags": { + "type": { + "$ref": "#/327" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SageMaker/ModelPackageGroup", + "properties": { + "name": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/10" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/328" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SageMaker/ModelPackageGroup@default", + "scopeType": 0, + "body": { + "$ref": "#/329" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "BaselineConfig", + "properties": { + "ConstraintsResource": { + "type": { + "$ref": "#/334" + }, + "flags": 0 + }, + "StatisticsResource": { + "type": { + "$ref": "#/358" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BatchTransformInput", + "properties": { + "DataCapturedDestinationS3Uri": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "A URI that identifies the Amazon S3 storage location where Batch Transform Job captures data." + }, + "DatasetFormat": { + "type": { + "$ref": "#/338" + }, + "flags": 1 + }, + "ExcludeFeaturesAttribute": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "Indexes or names of the features to be excluded from analysis" + }, + "LocalPath": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "Path to the filesystem where the endpoint data is available to the container." + }, + "S3DataDistributionType": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defauts to FullyReplicated" + }, + "S3InputMode": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "Whether the Pipe or File is used as the input mode for transfering data for the monitoring job. Pipe mode is recommended for large datasets. File mode is useful for small files that fit in memory. Defaults to File." + } + } + }, + { + "$type": "ObjectType", + "name": "ClusterConfig", + "properties": { + "InstanceCount": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The number of ML compute instances to use in the model monitoring job. For distributed processing jobs, specify a value greater than 1. The default value is 1." + }, + "InstanceType": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The ML compute instance type for the processing job." + }, + "VolumeKmsKeyId": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the model monitoring job." + }, + "VolumeSizeInGB": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The size of the ML storage volume, in gigabytes, that you want to provision. You must specify sufficient ML storage for your scenario." + } + } + }, + { + "$type": "ObjectType", + "name": "ConstraintsResource", + "properties": { + "S3Uri": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The Amazon S3 URI for baseline constraint file in Amazon S3 that the current monitoring job should validated against." + } + } + }, + { + "$type": "ObjectType", + "name": "ContainerArgument", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Csv", + "properties": { + "Header": { + "type": { + "$ref": "#/92" + }, + "flags": 0, + "description": "A boolean flag indicating if given CSV has header" + } + } + }, + { + "$type": "ObjectType", + "name": "DataAnalysisTimeString", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DatasetFormat", + "properties": { + "Csv": { + "type": { + "$ref": "#/336" + }, + "flags": 0 + }, + "Json": { + "type": { + "$ref": "#/341" + }, + "flags": 0 + }, + "Parquet": { + "type": { + "$ref": "#/92" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "EndpointInput", + "properties": { + "EndpointName": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + }, + "ExcludeFeaturesAttribute": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "Indexes or names of the features to be excluded from analysis" + }, + "LocalPath": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "Path to the filesystem where the endpoint data is available to the container." + }, + "S3DataDistributionType": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defauts to FullyReplicated" + }, + "S3InputMode": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "Whether the Pipe or File is used as the input mode for transfering data for the monitoring job. Pipe mode is recommended for large datasets. File mode is useful for small files that fit in memory. Defaults to File." + } + } + }, + { + "$type": "ObjectType", + "name": "EndpointName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Json", + "properties": { + "Line": { + "type": { + "$ref": "#/92" + }, + "flags": 0, + "description": "A boolean flag indicating if it is JSON line format" + } + } + }, + { + "$type": "ObjectType", + "name": "MonitoringAppSpecification", + "properties": { + "ContainerArguments": { + "type": { + "$ref": "#/362" + }, + "flags": 0, + "description": "An array of arguments for the container used to run the monitoring job." + }, + "ContainerEntrypoint": { + "type": { + "$ref": "#/363" + }, + "flags": 0, + "description": "Specifies the entrypoint for a container used to run the monitoring job." + }, + "ImageUri": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The container image to be run by the monitoring job." + }, + "PostAnalyticsProcessorSourceUri": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "An Amazon S3 URI to a script that is called after analysis has been performed. Applicable only for the built-in (first party) containers." + }, + "RecordPreprocessorSourceUri": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "An Amazon S3 URI to a script that is called per row prior to running analysis. It can base64 decode the payload and convert it into a flatted json so that the built-in container can use the converted data. Applicable only for the built-in (first party) containers" + } + } + }, + { + "$type": "ObjectType", + "name": "MonitoringExecutionSummary", + "properties": { + "CreationTime": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The time at which the monitoring job was created." + }, + "EndpointName": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "FailureReason": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "Contains the reason a monitoring job failed, if it failed." + }, + "LastModifiedTime": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "A timestamp that indicates the last time the monitoring job was modified." + }, + "MonitoringExecutionStatus": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The status of the monitoring job." + }, + "MonitoringScheduleName": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + }, + "ProcessingJobArn": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the monitoring job." + }, + "ScheduledTime": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The time the monitoring job was scheduled." + } + } + }, + { + "$type": "ObjectType", + "name": "MonitoringInput", + "properties": { + "BatchTransformInput": { + "type": { + "$ref": "#/332" + }, + "flags": 0 + }, + "EndpointInput": { + "type": { + "$ref": "#/339" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "MonitoringInputs", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MonitoringJobDefinition", + "properties": { + "BaselineConfig": { + "type": { + "$ref": "#/331" + }, + "flags": 0 + }, + "Environment": { + "type": { + "$ref": "#/365" + }, + "flags": 0, + "description": "Sets the environment variables in the Docker container" + }, + "MonitoringAppSpecification": { + "type": { + "$ref": "#/342" + }, + "flags": 1 + }, + "MonitoringInputs": { + "type": { + "$ref": "#/366" + }, + "flags": 1 + }, + "MonitoringOutputConfig": { + "type": { + "$ref": "#/348" + }, + "flags": 1 + }, + "MonitoringResources": { + "type": { + "$ref": "#/349" + }, + "flags": 1 + }, + "NetworkConfig": { + "type": { + "$ref": "#/353" + }, + "flags": 0 + }, + "RoleArn": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf." + }, + "StoppingCondition": { + "type": { + "$ref": "#/359" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "MonitoringOutput", + "properties": { + "S3Output": { + "type": { + "$ref": "#/355" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "MonitoringOutputConfig", + "properties": { + "KmsKeyId": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption." + }, + "MonitoringOutputs": { + "type": { + "$ref": "#/367" + }, + "flags": 1, + "description": "Monitoring outputs for monitoring jobs. This is where the output of the periodic monitoring jobs is uploaded." + } + } + }, + { + "$type": "ObjectType", + "name": "MonitoringResources", + "properties": { + "ClusterConfig": { + "type": { + "$ref": "#/333" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "MonitoringScheduleConfig", + "properties": { + "MonitoringJobDefinition": { + "type": { + "$ref": "#/346" + }, + "flags": 0 + }, + "MonitoringJobDefinitionName": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "Name of the job definition" + }, + "MonitoringType": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "ScheduleConfig": { + "type": { + "$ref": "#/357" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "MonitoringScheduleName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MonitoringType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "NetworkConfig", + "properties": { + "EnableInterContainerTrafficEncryption": { + "type": { + "$ref": "#/92" + }, + "flags": 0, + "description": "Whether to encrypt all communications between distributed processing jobs. Choose True to encrypt communications. Encryption provides greater security for distributed processing jobs, but the processing might take longer." + }, + "EnableNetworkIsolation": { + "type": { + "$ref": "#/92" + }, + "flags": 0, + "description": "Whether to allow inbound and outbound network calls to and from the containers used for the processing job." + }, + "VpcConfig": { + "type": { + "$ref": "#/361" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Parquet", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "S3Output", + "properties": { + "LocalPath": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The local path to the Amazon S3 storage location where Amazon SageMaker saves the results of a monitoring job. LocalPath is an absolute path for the output data." + }, + "S3UploadMode": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "Whether to upload the results of the monitoring job continuously or after the job completes." + }, + "S3Uri": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "A URI that identifies the Amazon S3 storage location where Amazon SageMaker saves the results of a monitoring job." + } + } + }, + { + "$type": "ObjectType", + "name": "S3Uri", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ScheduleConfig", + "properties": { + "DataAnalysisEndTime": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "Data Analysis end time, e.g. PT0H" + }, + "DataAnalysisStartTime": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "Data Analysis start time, e.g. -PT1H" + }, + "ScheduleExpression": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "A cron expression or 'NOW' that describes details about the monitoring schedule." + } + } + }, + { + "$type": "ObjectType", + "name": "StatisticsResource", + "properties": { + "S3Uri": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The Amazon S3 URI for the baseline statistics file in Amazon S3 that the current monitoring job should be validated against." + } + } + }, + { + "$type": "ObjectType", + "name": "StoppingCondition", + "properties": { + "MaxRuntimeInSeconds": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "The maximum runtime allowed in seconds." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + }, + "Value": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + } + } + }, + { + "$type": "ObjectType", + "name": "VpcConfig", + "properties": { + "SecurityGroupIds": { + "type": { + "$ref": "#/368" + }, + "flags": 1, + "description": "The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field." + }, + "Subnets": { + "type": { + "$ref": "#/369" + }, + "flags": 1, + "description": "The ID of the subnets in the VPC to which you want to connect to your monitoring jobs." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/10" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/10" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/344" + } + }, + { + "$type": "ObjectType", + "name": "MonitoringSchedule_Environment", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/344" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/347" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/10" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/10" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.SageMaker/MonitoringScheduleProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/360" + } + }, + { + "$type": "ObjectType", + "name": "AWS.SageMaker/MonitoringScheduleProperties", + "properties": { + "CreationTime": { + "type": { + "$ref": "#/10" + }, + "flags": 2, + "description": "The time at which the schedule was created." + }, + "EndpointName": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "FailureReason": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "Contains the reason a monitoring job failed, if it failed." + }, + "LastModifiedTime": { + "type": { + "$ref": "#/10" + }, + "flags": 2, + "description": "A timestamp that indicates the last time the monitoring job was modified." + }, + "LastMonitoringExecutionSummary": { + "type": { + "$ref": "#/343" + }, + "flags": 0, + "description": "Describes metadata on the last execution to run, if there was one." + }, + "MonitoringScheduleArn": { + "type": { + "$ref": "#/10" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) of the monitoring schedule." + }, + "MonitoringScheduleConfig": { + "type": { + "$ref": "#/350" + }, + "flags": 1 + }, + "MonitoringScheduleName": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + }, + "MonitoringScheduleStatus": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The status of a schedule job." + }, + "Tags": { + "type": { + "$ref": "#/371" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SageMaker/MonitoringSchedule", + "properties": { + "name": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/10" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/372" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SageMaker/MonitoringSchedule@default", + "scopeType": 0, + "body": { + "$ref": "#/373" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "S3Location", + "properties": { + "Bucket": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The name of the S3 bucket where the PipelineDefinition file is stored." + }, + "ETag": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The Amazon S3 ETag (a file checksum) of the PipelineDefinition file. If you don't specify a value, SageMaker skips ETag validation of your PipelineDefinition file." + }, + "Key": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The file name of the PipelineDefinition file (Amazon S3 object name)." + }, + "Version": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "For versioning-enabled buckets, a specific version of the PipelineDefinition file." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.SageMaker/PipelineProperties" + }, + { + "$type": "ObjectType", + "name": "Pipeline_ParallelismConfiguration", + "properties": { + "MaxParallelExecutionSteps": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "Maximum parallel execution steps" + } + } + }, + { + "$type": "ObjectType", + "name": "Pipeline_PipelineDefinition", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/376" + } + }, + { + "$type": "ObjectType", + "name": "AWS.SageMaker/PipelineProperties", + "properties": { + "ParallelismConfiguration": { + "type": { + "$ref": "#/378" + }, + "flags": 0 + }, + "PipelineDefinition": { + "type": { + "$ref": "#/379" + }, + "flags": 1 + }, + "PipelineDescription": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The description of the Pipeline." + }, + "PipelineDisplayName": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The display name of the Pipeline." + }, + "PipelineName": { + "type": { + "$ref": "#/10" + }, + "flags": 17, + "description": "The name of the Pipeline." + }, + "RoleArn": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "Role Arn" + }, + "Tags": { + "type": { + "$ref": "#/380" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SageMaker/Pipeline", + "properties": { + "name": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/10" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/381" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SageMaker/Pipeline@default", + "scopeType": 0, + "body": { + "$ref": "#/382" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "PathId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ProductId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ProjectArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ProjectDescription", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ProjectId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ProjectName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ProvisionedProductStatusMessage", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ProvisioningArtifactId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ProvisioningParameter", + "properties": { + "Key": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The parameter key." + }, + "Value": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The parameter value." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + }, + "Value": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.SageMaker/ProjectProperties" + }, + { + "$type": "ObjectType", + "name": "Project_ServiceCatalogProvisionedProductDetails", + "properties": { + "ProvisionedProductId": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "ProvisionedProductStatusMessage": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/392" + } + }, + { + "$type": "ObjectType", + "name": "Project_ServiceCatalogProvisioningDetails", + "properties": { + "PathId": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "ProductId": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + }, + "ProvisioningArtifactId": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "ProvisioningParameters": { + "type": { + "$ref": "#/396" + }, + "flags": 0, + "description": "Parameters specified by the administrator that are required for provisioning the product." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/393" + } + }, + { + "$type": "ObjectType", + "name": "AWS.SageMaker/ProjectProperties", + "properties": { + "CreationTime": { + "type": { + "$ref": "#/10" + }, + "flags": 2, + "description": "The time at which the project was created." + }, + "ProjectArn": { + "type": { + "$ref": "#/10" + }, + "flags": 18 + }, + "ProjectDescription": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "ProjectId": { + "type": { + "$ref": "#/10" + }, + "flags": 2 + }, + "ProjectName": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + }, + "ProjectStatus": { + "type": { + "$ref": "#/10" + }, + "flags": 2, + "description": "The status of a project." + }, + "ServiceCatalogProvisionedProductDetails": { + "type": { + "$ref": "#/395" + }, + "flags": 0, + "description": "Provisioned ServiceCatalog Details" + }, + "ServiceCatalogProvisioningDetails": { + "type": { + "$ref": "#/397" + }, + "flags": 1, + "description": "Input ServiceCatalog Provisioning Details" + }, + "Tags": { + "type": { + "$ref": "#/398" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SageMaker/Project", + "properties": { + "name": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/10" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/399" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SageMaker/Project@default", + "scopeType": 0, + "body": { + "$ref": "#/400" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AppType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CodeRepository", + "properties": { + "RepositoryUrl": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "A CodeRepository (valid URL) to be used within Jupyter's Git extension." + } + } + }, + { + "$type": "ObjectType", + "name": "CustomFileSystem", + "properties": { + "EFSFileSystem": { + "type": { + "$ref": "#/407" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomFileSystems", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CustomImage", + "properties": { + "AppImageConfigName": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The Name of the AppImageConfig." + }, + "ImageName": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The name of the CustomImage. Must be unique to your account." + }, + "ImageVersionNumber": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The version number of the CustomImage." + } + } + }, + { + "$type": "ObjectType", + "name": "EFSFileSystem", + "properties": { + "FileSystemId": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "EbsStorageSettings", + "properties": { + "EbsVolumeSizeInGb": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "Size of the Amazon EBS volume in Gb" + } + } + }, + { + "$type": "ObjectType", + "name": "JupyterServerAppSettings", + "properties": { + "DefaultResourceSpec": { + "type": { + "$ref": "#/412" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "KernelGatewayAppSettings", + "properties": { + "CustomImages": { + "type": { + "$ref": "#/421" + }, + "flags": 0, + "description": "A list of custom SageMaker images that are configured to run as a KernelGateway app." + }, + "DefaultResourceSpec": { + "type": { + "$ref": "#/412" + }, + "flags": 0, + "description": "The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app." + } + } + }, + { + "$type": "ObjectType", + "name": "OwnershipSettings", + "properties": { + "OwnerUserProfileName": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ResourceSpec", + "properties": { + "InstanceType": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The instance type that the image version runs on." + }, + "SageMakerImageArn": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The ARN of the SageMaker image that the image version belongs to." + }, + "SageMakerImageVersionArn": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The ARN of the image version created on the instance." + } + } + }, + { + "$type": "ObjectType", + "name": "SpaceCodeEditorAppSettings", + "properties": { + "DefaultResourceSpec": { + "type": { + "$ref": "#/412" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SpaceEbsVolumeSizeInGb", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SpaceJupyterLabAppSettings", + "properties": { + "CodeRepositories": { + "type": { + "$ref": "#/422" + }, + "flags": 0, + "description": "A list of CodeRepositories available for use with JupyterLab apps." + }, + "DefaultResourceSpec": { + "type": { + "$ref": "#/412" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SpaceSettings", + "properties": { + "AppType": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "CodeEditorAppSettings": { + "type": { + "$ref": "#/413" + }, + "flags": 0, + "description": "The CodeEditor app settings." + }, + "CustomFileSystems": { + "type": { + "$ref": "#/423" + }, + "flags": 0 + }, + "JupyterLabAppSettings": { + "type": { + "$ref": "#/415" + }, + "flags": 0, + "description": "The JupyterLab app settings." + }, + "JupyterServerAppSettings": { + "type": { + "$ref": "#/409" + }, + "flags": 0, + "description": "The Jupyter server's app settings." + }, + "KernelGatewayAppSettings": { + "type": { + "$ref": "#/410" + }, + "flags": 0, + "description": "The kernel gateway app settings." + }, + "SpaceStorageSettings": { + "type": { + "$ref": "#/418" + }, + "flags": 0, + "description": "Default storage settings for a space." + } + } + }, + { + "$type": "ObjectType", + "name": "SpaceSharingSettings", + "properties": { + "SharingType": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "SpaceStorageSettings", + "properties": { + "EbsStorageSettings": { + "type": { + "$ref": "#/408" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/404" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/406" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/403" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/404" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.SageMaker/SpaceProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/419" + } + }, + { + "$type": "ObjectType", + "name": "AWS.SageMaker/SpaceProperties", + "properties": { + "DomainId": { + "type": { + "$ref": "#/10" + }, + "flags": 17, + "description": "The ID of the associated Domain." + }, + "OwnershipSettings": { + "type": { + "$ref": "#/411" + }, + "flags": 0 + }, + "SpaceArn": { + "type": { + "$ref": "#/10" + }, + "flags": 2, + "description": "The space Amazon Resource Name (ARN)." + }, + "SpaceDisplayName": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "SpaceName": { + "type": { + "$ref": "#/10" + }, + "flags": 17, + "description": "A name for the Space." + }, + "SpaceSettings": { + "type": { + "$ref": "#/416" + }, + "flags": 4, + "description": "A collection of settings." + }, + "SpaceSharingSettings": { + "type": { + "$ref": "#/417" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/425" + }, + "flags": 4, + "description": "A list of tags to apply to the space." + }, + "Url": { + "type": { + "$ref": "#/10" + }, + "flags": 2 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SageMaker/Space", + "properties": { + "name": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/10" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/426" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SageMaker/Space@default", + "scopeType": 0, + "body": { + "$ref": "#/427" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "CodeEditorAppSettings", + "properties": { + "CustomImages": { + "type": { + "$ref": "#/447" + }, + "flags": 0, + "description": "A list of custom images for use for CodeEditor apps." + }, + "DefaultResourceSpec": { + "type": { + "$ref": "#/441" + }, + "flags": 0, + "description": "The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the CodeEditor app." + }, + "LifecycleConfigArns": { + "type": { + "$ref": "#/448" + }, + "flags": 0, + "description": "A list of LifecycleConfigArns available for use with CodeEditor apps." + } + } + }, + { + "$type": "ObjectType", + "name": "CodeRepository", + "properties": { + "RepositoryUrl": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "A CodeRepository (valid URL) to be used within Jupyter's Git extension." + } + } + }, + { + "$type": "ObjectType", + "name": "CustomFileSystemConfig", + "properties": { + "EFSFileSystemConfig": { + "type": { + "$ref": "#/436" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomImage", + "properties": { + "AppImageConfigName": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The Name of the AppImageConfig." + }, + "ImageName": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "The name of the CustomImage. Must be unique to your account." + }, + "ImageVersionNumber": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "The version number of the CustomImage." + } + } + }, + { + "$type": "ObjectType", + "name": "CustomPosixUserConfig", + "properties": { + "Gid": { + "type": { + "$ref": "#/14" + }, + "flags": 1 + }, + "Uid": { + "type": { + "$ref": "#/14" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DefaultEbsStorageSettings", + "properties": { + "DefaultEbsVolumeSizeInGb": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "Default size of the Amazon EBS volume in Gb" + }, + "MaximumEbsVolumeSizeInGb": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "Maximum size of the Amazon EBS volume in Gb. Must be greater than or equal to the DefaultEbsVolumeSizeInGb." + } + } + }, + { + "$type": "ObjectType", + "name": "DefaultSpaceStorageSettings", + "properties": { + "DefaultEbsStorageSettings": { + "type": { + "$ref": "#/434" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "EFSFileSystemConfig", + "properties": { + "FileSystemId": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + }, + "FileSystemPath": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "JupyterLabAppSettings", + "properties": { + "CodeRepositories": { + "type": { + "$ref": "#/449" + }, + "flags": 0, + "description": "A list of CodeRepositories available for use with JupyterLab apps." + }, + "CustomImages": { + "type": { + "$ref": "#/450" + }, + "flags": 0, + "description": "A list of custom images available for use for JupyterLab apps" + }, + "DefaultResourceSpec": { + "type": { + "$ref": "#/441" + }, + "flags": 0, + "description": "The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterLab app." + }, + "LifecycleConfigArns": { + "type": { + "$ref": "#/451" + }, + "flags": 0, + "description": "A list of LifecycleConfigArns available for use with JupyterLab apps." + } + } + }, + { + "$type": "ObjectType", + "name": "JupyterServerAppSettings", + "properties": { + "DefaultResourceSpec": { + "type": { + "$ref": "#/441" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "KernelGatewayAppSettings", + "properties": { + "CustomImages": { + "type": { + "$ref": "#/452" + }, + "flags": 0, + "description": "A list of custom SageMaker images that are configured to run as a KernelGateway app." + }, + "DefaultResourceSpec": { + "type": { + "$ref": "#/441" + }, + "flags": 0, + "description": "The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app." + } + } + }, + { + "$type": "ObjectType", + "name": "RStudioServerProAppSettings", + "properties": { + "AccessStatus": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "Indicates whether the current user has access to the RStudioServerPro app." + }, + "UserGroup": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The level of permissions that the user has within the RStudioServerPro app. This value defaults to User. The Admin value allows the user access to the RStudio Administrative Dashboard." + } + } + }, + { + "$type": "ObjectType", + "name": "ResourceSpec", + "properties": { + "InstanceType": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The instance type that the image version runs on." + }, + "SageMakerImageArn": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The ARN of the SageMaker image that the image version belongs to." + }, + "SageMakerImageVersionArn": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The ARN of the image version created on the instance." + } + } + }, + { + "$type": "ObjectType", + "name": "SharingSettings", + "properties": { + "NotebookOutputOption": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "Whether to include the notebook cell output when sharing the notebook. The default is Disabled." + }, + "S3KmsKeyId": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "When NotebookOutputOption is Allowed, the AWS Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket." + }, + "S3OutputPath": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "When NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots." + } + } + }, + { + "$type": "ObjectType", + "name": "SpaceEbsVolumeSizeInGb", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "StudioLifecycleConfigArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "UserSettings", + "properties": { + "CodeEditorAppSettings": { + "type": { + "$ref": "#/429" + }, + "flags": 0 + }, + "CustomFileSystemConfigs": { + "type": { + "$ref": "#/453" + }, + "flags": 0 + }, + "CustomPosixUserConfig": { + "type": { + "$ref": "#/433" + }, + "flags": 0 + }, + "DefaultLandingUri": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "Defines which Amazon SageMaker application users are directed to by default." + }, + "ExecutionRole": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The user profile Amazon Resource Name (ARN)." + }, + "JupyterLabAppSettings": { + "type": { + "$ref": "#/437" + }, + "flags": 0 + }, + "JupyterServerAppSettings": { + "type": { + "$ref": "#/438" + }, + "flags": 0, + "description": "The Jupyter server's app settings." + }, + "KernelGatewayAppSettings": { + "type": { + "$ref": "#/439" + }, + "flags": 0, + "description": "The kernel gateway app settings." + }, + "RStudioServerProAppSettings": { + "type": { + "$ref": "#/440" + }, + "flags": 0 + }, + "SecurityGroups": { + "type": { + "$ref": "#/454" + }, + "flags": 0, + "description": "The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication." + }, + "SharingSettings": { + "type": { + "$ref": "#/442" + }, + "flags": 0, + "description": "The sharing settings." + }, + "SpaceStorageSettings": { + "type": { + "$ref": "#/435" + }, + "flags": 0 + }, + "StudioWebPortal": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "Indicates whether the Studio experience is available to users. If not, users cannot access Studio." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/432" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/10" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/430" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/432" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/10" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/432" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/431" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/10" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.SageMaker/UserProfileProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/445" + } + }, + { + "$type": "ObjectType", + "name": "AWS.SageMaker/UserProfileProperties", + "properties": { + "DomainId": { + "type": { + "$ref": "#/10" + }, + "flags": 17, + "description": "The ID of the associated Domain." + }, + "SingleSignOnUserIdentifier": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only supported value is \"UserName\". If the Domain's AuthMode is SSO, this field is required. If the Domain's AuthMode is not SSO, this field cannot be specified." + }, + "SingleSignOnUserValue": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The username of the associated AWS Single Sign-On User for this UserProfile. If the Domain's AuthMode is SSO, this field is required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not SSO, this field cannot be specified." + }, + "Tags": { + "type": { + "$ref": "#/456" + }, + "flags": 4, + "description": "A list of tags to apply to the user profile." + }, + "UserProfileArn": { + "type": { + "$ref": "#/10" + }, + "flags": 2, + "description": "The user profile Amazon Resource Name (ARN)." + }, + "UserProfileName": { + "type": { + "$ref": "#/10" + }, + "flags": 17, + "description": "A name for the UserProfile." + }, + "UserSettings": { + "type": { + "$ref": "#/446" + }, + "flags": 0, + "description": "A collection of settings." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SageMaker/UserProfile", + "properties": { + "name": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/10" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/457" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SageMaker/UserProfile@default", + "scopeType": 0, + "body": { + "$ref": "#/458" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.sagemaker/default/types.md b/artifacts/bicep/aws/aws.sagemaker/default/types.md index aee5742e..61362c4d 100644 --- a/artifacts/bicep/aws/aws.sagemaker/default/types.md +++ b/artifacts/bicep/aws/aws.sagemaker/default/types.md @@ -3,167 +3,147 @@ ## Resource AWS.SageMaker/AppImageConfig@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.SageMaker/AppImageConfigProperties](#awssagemakerappimageconfigproperties) (Required): properties of the resource +* **properties**: [AWS.SageMaker/AppImageConfigProperties](#awssagemakerappimageconfigproperties) (Required, Identifier): properties of the resource ## Resource AWS.SageMaker/Device@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.SageMaker/DeviceProperties](#awssagemakerdeviceproperties) (Required): properties of the resource +* **properties**: [AWS.SageMaker/DeviceProperties](#awssagemakerdeviceproperties) (Required, Identifier): properties of the resource ## Resource AWS.SageMaker/DeviceFleet@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.SageMaker/DeviceFleetProperties](#awssagemakerdevicefleetproperties) (Required): properties of the resource +* **properties**: [AWS.SageMaker/DeviceFleetProperties](#awssagemakerdevicefleetproperties) (Required, Identifier): properties of the resource ## Resource AWS.SageMaker/Domain@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.SageMaker/DomainProperties](#awssagemakerdomainproperties) (Required): properties of the resource +* **properties**: [AWS.SageMaker/DomainProperties](#awssagemakerdomainproperties) (Required, Identifier): properties of the resource ## Resource AWS.SageMaker/FeatureGroup@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.SageMaker/FeatureGroupProperties](#awssagemakerfeaturegroupproperties) (Required): properties of the resource +* **properties**: [AWS.SageMaker/FeatureGroupProperties](#awssagemakerfeaturegroupproperties) (Required, Identifier): properties of the resource ## Resource AWS.SageMaker/Image@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.SageMaker/ImageProperties](#awssagemakerimageproperties) (Required): properties of the resource +* **properties**: [AWS.SageMaker/ImageProperties](#awssagemakerimageproperties) (Required, Identifier): properties of the resource ## Resource AWS.SageMaker/ImageVersion@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.SageMaker/ImageVersionProperties](#awssagemakerimageversionproperties) (Required): properties of the resource +* **properties**: [AWS.SageMaker/ImageVersionProperties](#awssagemakerimageversionproperties) (Required, Identifier): properties of the resource ## Resource AWS.SageMaker/InferenceComponent@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.SageMaker/InferenceComponentProperties](#awssagemakerinferencecomponentproperties) (Required): properties of the resource +* **properties**: [AWS.SageMaker/InferenceComponentProperties](#awssagemakerinferencecomponentproperties) (Required, Identifier): properties of the resource ## Resource AWS.SageMaker/InferenceExperiment@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.SageMaker/InferenceExperimentProperties](#awssagemakerinferenceexperimentproperties) (Required): properties of the resource +* **properties**: [AWS.SageMaker/InferenceExperimentProperties](#awssagemakerinferenceexperimentproperties) (Required, Identifier): properties of the resource ## Resource AWS.SageMaker/ModelCard@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.SageMaker/ModelCardProperties](#awssagemakermodelcardproperties) (Required): properties of the resource +* **properties**: [AWS.SageMaker/ModelCardProperties](#awssagemakermodelcardproperties) (Required, Identifier): properties of the resource ## Resource AWS.SageMaker/ModelPackage@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.SageMaker/ModelPackageProperties](#awssagemakermodelpackageproperties): properties of the resource +* **properties**: [AWS.SageMaker/ModelPackageProperties](#awssagemakermodelpackageproperties) (Identifier): properties of the resource ## Resource AWS.SageMaker/ModelPackageGroup@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.SageMaker/ModelPackageGroupProperties](#awssagemakermodelpackagegroupproperties) (Required): properties of the resource +* **properties**: [AWS.SageMaker/ModelPackageGroupProperties](#awssagemakermodelpackagegroupproperties) (Required, Identifier): properties of the resource ## Resource AWS.SageMaker/MonitoringSchedule@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.SageMaker/MonitoringScheduleProperties](#awssagemakermonitoringscheduleproperties) (Required): properties of the resource +* **properties**: [AWS.SageMaker/MonitoringScheduleProperties](#awssagemakermonitoringscheduleproperties) (Required, Identifier): properties of the resource ## Resource AWS.SageMaker/Pipeline@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.SageMaker/PipelineProperties](#awssagemakerpipelineproperties) (Required): properties of the resource +* **properties**: [AWS.SageMaker/PipelineProperties](#awssagemakerpipelineproperties) (Required, Identifier): properties of the resource ## Resource AWS.SageMaker/Project@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.SageMaker/ProjectProperties](#awssagemakerprojectproperties) (Required): properties of the resource +* **properties**: [AWS.SageMaker/ProjectProperties](#awssagemakerprojectproperties) (Required, Identifier): properties of the resource ## Resource AWS.SageMaker/Space@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.SageMaker/SpaceProperties](#awssagemakerspaceproperties) (Required): properties of the resource +* **properties**: [AWS.SageMaker/SpaceProperties](#awssagemakerspaceproperties) (Required, Identifier): properties of the resource ## Resource AWS.SageMaker/UserProfile@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.SageMaker/UserProfileProperties](#awssagemakeruserprofileproperties) (Required): properties of the resource +* **properties**: [AWS.SageMaker/UserProfileProperties](#awssagemakeruserprofileproperties) (Required, Identifier): properties of the resource + +## AdditionalInferenceSpecificationDefinition +### Properties +* **Containers**: [ModelPackageContainerDefinition](#modelpackagecontainerdefinition)[] (Required): The Amazon ECR registry path of the Docker image that contains the inference code. +* **Description**: string: A description of the additional Inference specification. +* **Name**: string (Required): A unique name to identify the additional inference specification. The name must be unique within the list of your additional inference specifications for a particular model package. +* **SupportedContentTypes**: string[]: The supported MIME types for the input data. +* **SupportedRealtimeInferenceInstanceTypes**: string[]: A list of the instance types that are used to generate inferences in real-time +* **SupportedResponseMIMETypes**: string[]: The supported MIME types for the output data. +* **SupportedTransformInstanceTypes**: string[]: A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed. + +## AdditionalInformation +### Properties +* **CaveatsAndRecommendations**: string: Caveats and recommendations for people who might use this model in their applications. +* **CustomDetails**: [ModelCard_CustomDetails](#modelcardcustomdetails): customer details. +* **EthicalConsiderations**: string: Any ethical considerations that the author wants to provide. ## AWS.SageMaker/AppImageConfigProperties ### Properties * **AppImageConfigArn**: string (ReadOnly): The Amazon Resource Name (ARN) of the AppImageConfig. * **AppImageConfigName**: string (Required, Identifier): The Name of the AppImageConfig. +* **CodeEditorAppImageConfig**: [CodeEditorAppImageConfig](#codeeditorappimageconfig): The CodeEditorAppImageConfig. +* **JupyterLabAppImageConfig**: [JupyterLabAppImageConfig](#jupyterlabappimageconfig): The JupyterLabAppImageConfig. * **KernelGatewayImageConfig**: [KernelGatewayImageConfig](#kernelgatewayimageconfig): The KernelGatewayImageConfig. * **Tags**: [Tag](#tag)[] (WriteOnly): A list of tags to apply to the AppImageConfig. -## KernelGatewayImageConfig -### Properties -* **FileSystemConfig**: [FileSystemConfig](#filesystemconfig): The Amazon Elastic File System (EFS) storage configuration for a SageMaker image. -* **KernelSpecs**: [KernelSpec](#kernelspec)[] (Required): The specification of the Jupyter kernels in the image. - -## FileSystemConfig -### Properties -* **DefaultGid**: int: The default POSIX group ID (GID). If not specified, defaults to 100. -* **DefaultUid**: int: The default POSIX user ID (UID). If not specified, defaults to 1000. -* **MountPath**: string: The path within the image to mount the user's EFS home directory. The directory should be empty. If not specified, defaults to /home/sagemaker-user. - -## KernelSpec -### Properties -* **DisplayName**: string: The display name of the kernel. -* **Name**: string (Required): The name of the kernel. - -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - -## AWS.SageMaker/DeviceProperties -### Properties -* **Device**: [Device](#device): The Edge Device you want to register against a device fleet -* **DeviceFleetName**: string (Required): The name of the edge device fleet -* **Tags**: [Tag](#tag)[]: Associate tags with the resource - -## Device -### Properties -* **Description**: string: Description of the device -* **DeviceName**: string (Required): The name of the device -* **IotThingName**: string: AWS Internet of Things (IoT) object name. - -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The key value of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## AWS.SageMaker/DeviceFleetProperties ### Properties * **Description**: string: Description for the edge device fleet @@ -172,15 +152,11 @@ * **RoleArn**: string (Required): Role associated with the device fleet * **Tags**: [Tag](#tag)[]: Associate tags with the resource -## EdgeOutputConfig -### Properties -* **KmsKeyId**: string: The KMS key id used for encryption on the S3 bucket -* **S3OutputLocation**: string (Required): The Amazon Simple Storage (S3) bucket URI - -## Tag +## AWS.SageMaker/DeviceProperties ### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The key value of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Device**: [Device](#device): The Edge Device you want to register against a device fleet +* **DeviceFleetName**: string (Required): The name of the edge device fleet +* **Tags**: [Tag](#tag)[]: Associate tags with the resource ## AWS.SageMaker/DomainProperties ### Properties @@ -203,124 +179,6 @@ * **Url**: string (ReadOnly): The URL to the created domain. * **VpcId**: string (Required): The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication. -## DefaultSpaceSettings -### Properties -* **ExecutionRole**: string (Required): The execution role for the space. -* **JupyterServerAppSettings**: [JupyterServerAppSettings](#jupyterserverappsettings): The Jupyter server's app settings. -* **KernelGatewayAppSettings**: [KernelGatewayAppSettings](#kernelgatewayappsettings): The kernel gateway app settings. -* **SecurityGroups**: string[]: The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication. - -## JupyterServerAppSettings -### Properties -* **DefaultResourceSpec**: [ResourceSpec](#resourcespec) - -## ResourceSpec -### Properties -* **InstanceType**: string: The instance type that the image version runs on. -* **LifecycleConfigArn**: string: The Amazon Resource Name (ARN) of the Lifecycle Configuration to attach to the Resource. -* **SageMakerImageArn**: string: The Amazon Resource Name (ARN) of the SageMaker image that the image version belongs to. -* **SageMakerImageVersionArn**: string: The Amazon Resource Name (ARN) of the image version created on the instance. - -## KernelGatewayAppSettings -### Properties -* **CustomImages**: [CustomImage](#customimage)[]: A list of custom SageMaker images that are configured to run as a KernelGateway app. -* **DefaultResourceSpec**: [ResourceSpec](#resourcespec): The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app. - -## CustomImage -### Properties -* **AppImageConfigName**: string (Required): The Name of the AppImageConfig. -* **ImageName**: string (Required): The name of the CustomImage. Must be unique to your account. -* **ImageVersionNumber**: int: The version number of the CustomImage. - -## UserSettings -### Properties -* **CodeEditorAppSettings**: [CodeEditorAppSettings](#codeeditorappsettings) -* **CustomFileSystemConfigs**: [CustomFileSystemConfig](#customfilesystemconfig)[] -* **CustomPosixUserConfig**: [CustomPosixUserConfig](#customposixuserconfig) -* **DefaultLandingUri**: string: Defines which Amazon SageMaker application users are directed to by default. -* **ExecutionRole**: string (Required): The execution role for the user. -* **JupyterLabAppSettings**: [JupyterLabAppSettings](#jupyterlabappsettings) -* **JupyterServerAppSettings**: [JupyterServerAppSettings](#jupyterserverappsettings): The Jupyter server's app settings. -* **KernelGatewayAppSettings**: [KernelGatewayAppSettings](#kernelgatewayappsettings): The kernel gateway app settings. -* **RSessionAppSettings**: [RSessionAppSettings](#rsessionappsettings) -* **RStudioServerProAppSettings**: [RStudioServerProAppSettings](#rstudioserverproappsettings) -* **SecurityGroups**: string[]: The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication. -* **SharingSettings**: [SharingSettings](#sharingsettings): The sharing settings. -* **SpaceStorageSettings**: [DefaultSpaceStorageSettings](#defaultspacestoragesettings) -* **StudioWebPortal**: string: Indicates whether the Studio experience is available to users. If not, users cannot access Studio. - -## CodeEditorAppSettings -### Properties -* **DefaultResourceSpec**: [ResourceSpec](#resourcespec): The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the CodeEditor app. -* **LifecycleConfigArns**: string[]: A list of LifecycleConfigArns available for use with CodeEditor apps. - -## CustomFileSystemConfig -### Properties -* **EFSFileSystemConfig**: [EFSFileSystemConfig](#efsfilesystemconfig) - -## EFSFileSystemConfig -### Properties -* **FileSystemId**: string (Required) -* **FileSystemPath**: string - -## CustomPosixUserConfig -### Properties -* **Gid**: int (Required) -* **Uid**: int (Required) - -## JupyterLabAppSettings -### Properties -* **CodeRepositories**: [CodeRepository](#coderepository)[]: A list of CodeRepositories available for use with JupyterLab apps. -* **CustomImages**: [CustomImage](#customimage)[]: A list of custom images for use for JupyterLab apps. -* **DefaultResourceSpec**: [ResourceSpec](#resourcespec): The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterLab app. -* **LifecycleConfigArns**: string[]: A list of LifecycleConfigArns available for use with JupyterLab apps. - -## CodeRepository -### Properties -* **RepositoryUrl**: string (Required): A CodeRepository (valid URL) to be used within Jupyter's Git extension. - -## RSessionAppSettings -### Properties -* **CustomImages**: [CustomImage](#customimage)[]: A list of custom SageMaker images that are configured to run as a KernelGateway app. -* **DefaultResourceSpec**: [ResourceSpec](#resourcespec) - -## RStudioServerProAppSettings -### Properties -* **AccessStatus**: string: Indicates whether the current user has access to the RStudioServerPro app. -* **UserGroup**: string: The level of permissions that the user has within the RStudioServerPro app. This value defaults to User. The Admin value allows the user access to the RStudio Administrative Dashboard. - -## SharingSettings -### Properties -* **NotebookOutputOption**: string: Whether to include the notebook cell output when sharing the notebook. The default is Disabled. -* **S3KmsKeyId**: string: When NotebookOutputOption is Allowed, the AWS Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket. -* **S3OutputPath**: string: When NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots. - -## DefaultSpaceStorageSettings -### Properties -* **DefaultEbsStorageSettings**: [DefaultEbsStorageSettings](#defaultebsstoragesettings) - -## DefaultEbsStorageSettings -### Properties -* **DefaultEbsVolumeSizeInGb**: int (Required): Default size of the Amazon EBS volume in Gb -* **MaximumEbsVolumeSizeInGb**: int (Required): Maximum size of the Amazon EBS volume in Gb. Must be greater than or equal to the DefaultEbsVolumeSizeInGb. - -## DomainSettings -### Properties -* **RStudioServerProDomainSettings**: [RStudioServerProDomainSettings](#rstudioserverprodomainsettings) -* **SecurityGroupIds**: string[]: The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps. - -## RStudioServerProDomainSettings -### Properties -* **DefaultResourceSpec**: [ResourceSpec](#resourcespec) -* **DomainExecutionRoleArn**: string (Required): The ARN of the execution role for the RStudioServerPro Domain-level app. -* **RStudioConnectUrl**: string: A URL pointing to an RStudio Connect server. -* **RStudioPackageManagerUrl**: string: A URL pointing to an RStudio Package Manager server. - -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - ## AWS.SageMaker/FeatureGroupProperties ### Properties * **CreationTime**: string (ReadOnly): A timestamp of FeatureGroup creation time. @@ -334,44 +192,7 @@ * **RecordIdentifierFeatureName**: string (Required): The Record Identifier Feature Name. * **RoleArn**: string: Role Arn * **Tags**: [Tag](#tag)[]: An array of key-value pair to apply to this resource. - -## FeatureDefinition -### Properties -* **FeatureName**: string (Required) -* **FeatureType**: string (Required) - -## FeatureGroup_OfflineStoreConfig -### Properties -* **DataCatalogConfig**: [DataCatalogConfig](#datacatalogconfig) -* **DisableGlueTableCreation**: bool -* **S3StorageConfig**: [S3StorageConfig](#s3storageconfig) (Required) -* **TableFormat**: string - -## DataCatalogConfig -### Properties -* **Catalog**: string (Required) -* **Database**: string (Required) -* **TableName**: string (Required) - -## S3StorageConfig -### Properties -* **KmsKeyId**: string -* **S3Uri**: string (Required) - -## FeatureGroup_OnlineStoreConfig -### Properties -* **EnableOnlineStore**: bool -* **SecurityConfig**: [OnlineStoreSecurityConfig](#onlinestoresecurityconfig) -* **StorageType**: string - -## OnlineStoreSecurityConfig -### Properties -* **KmsKeyId**: string - -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **ThroughputConfig**: [ThroughputConfig](#throughputconfig) ## AWS.SageMaker/ImageProperties ### Properties @@ -382,11 +203,6 @@ * **ImageRoleArn**: string (Required) * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## AWS.SageMaker/ImageVersionProperties ### Properties * **Alias**: string (WriteOnly) @@ -420,72 +236,298 @@ * **Tags**: [Tag](#tag)[] * **VariantName**: string (Required) -## InferenceComponentRuntimeConfig +## AWS.SageMaker/InferenceExperimentProperties ### Properties -* **CopyCount**: int (WriteOnly) -* **CurrentCopyCount**: int (ReadOnly) -* **DesiredCopyCount**: int (ReadOnly) +* **Arn**: string (ReadOnly): The Amazon Resource Name (ARN) of the inference experiment. +* **CreationTime**: string (ReadOnly): The timestamp at which you created the inference experiment. +* **DataStorageConfig**: [DataStorageConfig](#datastorageconfig) +* **Description**: string: The description of the inference experiment. +* **DesiredState**: string: The desired state of the experiment after starting or stopping operation. +* **EndpointMetadata**: [EndpointMetadata](#endpointmetadata) (ReadOnly) +* **EndpointName**: string (Required) +* **KmsKey**: string: The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. +* **LastModifiedTime**: string (ReadOnly): The timestamp at which you last modified the inference experiment. +* **ModelVariants**: [ModelVariantConfig](#modelvariantconfig)[] (Required): An array of ModelVariantConfig objects. Each ModelVariantConfig object in the array describes the infrastructure configuration for the corresponding variant. +* **Name**: string (Required, Identifier): The name for the inference experiment. +* **RoleArn**: string (Required): The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment. +* **Schedule**: [InferenceExperimentSchedule](#inferenceexperimentschedule) +* **ShadowModeConfig**: [ShadowModeConfig](#shadowmodeconfig) +* **Status**: string (ReadOnly): The status of the inference experiment. +* **StatusReason**: string: The error message or client-specified reason from the StopInferenceExperiment API, that explains the status of the inference experiment. +* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. +* **Type**: string (Required): The type of the inference experiment that you want to run. -## InferenceComponentSpecification +## AWS.SageMaker/ModelCardProperties ### Properties -* **ComputeResourceRequirements**: [InferenceComponentComputeResourceRequirements](#inferencecomponentcomputeresourcerequirements) (Required) -* **Container**: [InferenceComponentContainerSpecification](#inferencecomponentcontainerspecification) -* **ModelName**: string -* **StartupParameters**: [InferenceComponentStartupParameters](#inferencecomponentstartupparameters) +* **Content**: [Content](#content) (Required) +* **CreatedBy**: [UserContext](#usercontext): Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card. +* **CreationTime**: string (ReadOnly): The date and time the model card was created. +* **LastModifiedBy**: [UserContext](#usercontext): Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card. +* **LastModifiedTime**: string (ReadOnly): The date and time the model card was last modified. +* **ModelCardArn**: string (ReadOnly): The Amazon Resource Name (ARN) of the successfully created model card. +* **ModelCardName**: string (Required, Identifier): The unique name of the model card. +* **ModelCardProcessingStatus**: string (ReadOnly): The processing status of model card deletion. The ModelCardProcessingStatus updates throughout the different deletion steps. +* **ModelCardStatus**: string (Required): The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval. +* **ModelCardVersion**: int (ReadOnly): A version of the model card. +* **SecurityConfig**: [SecurityConfig](#securityconfig) +* **Tags**: [Tag](#tag)[]: Key-value pairs used to manage metadata for model cards. -## InferenceComponentComputeResourceRequirements +## AWS.SageMaker/ModelPackageGroupProperties ### Properties -* **MaxMemoryRequiredInMb**: int -* **MinMemoryRequiredInMb**: int -* **NumberOfAcceleratorDevicesRequired**: int -* **NumberOfCpuCoresRequired**: int +* **CreationTime**: string (ReadOnly): The time at which the model package group was created. +* **ModelPackageGroupArn**: string (ReadOnly, Identifier) +* **ModelPackageGroupDescription**: string +* **ModelPackageGroupName**: string (Required) +* **ModelPackageGroupPolicy**: [ModelPackageGroup_ModelPackageGroupPolicy](#modelpackagegroupmodelpackagegrouppolicy) | string +* **ModelPackageGroupStatus**: string (ReadOnly): The status of a modelpackage group job. +* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. -## InferenceComponentContainerSpecification +## AWS.SageMaker/ModelPackageProperties ### Properties -* **ArtifactUrl**: string -* **DeployedImage**: [DeployedImage](#deployedimage) (ReadOnly) -* **Environment**: [EnvironmentMap](#environmentmap) -* **Image**: string (WriteOnly) +* **AdditionalInferenceSpecifications**: [AdditionalInferenceSpecificationDefinition](#additionalinferencespecificationdefinition)[] +* **AdditionalInferenceSpecificationsToAdd**: [AdditionalInferenceSpecificationDefinition](#additionalinferencespecificationdefinition)[] (WriteOnly) +* **ApprovalDescription**: string +* **CertifyForMarketplace**: bool +* **ClientToken**: string (WriteOnly) +* **CreationTime**: string (ReadOnly) +* **CustomerMetadataProperties**: [CustomerMetadataProperties](#customermetadataproperties) +* **Domain**: string +* **DriftCheckBaselines**: [DriftCheckBaselines](#driftcheckbaselines) +* **InferenceSpecification**: [InferenceSpecification](#inferencespecification) +* **LastModifiedTime**: string +* **MetadataProperties**: [MetadataProperties](#metadataproperties) +* **ModelApprovalStatus**: string +* **ModelMetrics**: [ModelMetrics](#modelmetrics) +* **ModelPackageArn**: string (ReadOnly, Identifier) +* **ModelPackageDescription**: string +* **ModelPackageGroupName**: string +* **ModelPackageName**: string +* **ModelPackageStatus**: string (ReadOnly) +* **ModelPackageStatusDetails**: [ModelPackageStatusDetails](#modelpackagestatusdetails) +* **ModelPackageVersion**: int +* **SamplePayloadUrl**: string +* **SkipModelValidation**: string +* **SourceAlgorithmSpecification**: [SourceAlgorithmSpecification](#sourcealgorithmspecification) +* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. +* **Task**: string +* **ValidationSpecification**: [ValidationSpecification](#validationspecification) -## DeployedImage +## AWS.SageMaker/MonitoringScheduleProperties ### Properties -* **ResolutionTime**: string -* **ResolvedImage**: string -* **SpecifiedImage**: string +* **CreationTime**: string (ReadOnly): The time at which the schedule was created. +* **EndpointName**: string +* **FailureReason**: string: Contains the reason a monitoring job failed, if it failed. +* **LastModifiedTime**: string (ReadOnly): A timestamp that indicates the last time the monitoring job was modified. +* **LastMonitoringExecutionSummary**: [MonitoringExecutionSummary](#monitoringexecutionsummary): Describes metadata on the last execution to run, if there was one. +* **MonitoringScheduleArn**: string (ReadOnly, Identifier): The Amazon Resource Name (ARN) of the monitoring schedule. +* **MonitoringScheduleConfig**: [MonitoringScheduleConfig](#monitoringscheduleconfig) (Required) +* **MonitoringScheduleName**: string (Required) +* **MonitoringScheduleStatus**: string: The status of a schedule job. +* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. -## EnvironmentMap +## AWS.SageMaker/PipelineProperties ### Properties +* **ParallelismConfiguration**: [Pipeline_ParallelismConfiguration](#pipelineparallelismconfiguration) +* **PipelineDefinition**: [Pipeline_PipelineDefinition](#pipelinepipelinedefinition) (Required) +* **PipelineDescription**: string: The description of the Pipeline. +* **PipelineDisplayName**: string: The display name of the Pipeline. +* **PipelineName**: string (Required, Identifier): The name of the Pipeline. +* **RoleArn**: string (Required): Role Arn +* **Tags**: [Tag](#tag)[] -## InferenceComponentStartupParameters +## AWS.SageMaker/ProjectProperties ### Properties -* **ContainerStartupHealthCheckTimeoutInSeconds**: int -* **ModelDataDownloadTimeoutInSeconds**: int +* **CreationTime**: string (ReadOnly): The time at which the project was created. +* **ProjectArn**: string (ReadOnly, Identifier) +* **ProjectDescription**: string +* **ProjectId**: string (ReadOnly) +* **ProjectName**: string (Required) +* **ProjectStatus**: string (ReadOnly): The status of a project. +* **ServiceCatalogProvisionedProductDetails**: [Project_ServiceCatalogProvisionedProductDetails](#projectservicecatalogprovisionedproductdetails): Provisioned ServiceCatalog Details +* **ServiceCatalogProvisioningDetails**: [Project_ServiceCatalogProvisioningDetails](#projectservicecatalogprovisioningdetails) (Required): Input ServiceCatalog Provisioning Details +* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. -## Tag +## AWS.SageMaker/SpaceProperties ### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and - -* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and - +* **DomainId**: string (Required, Identifier): The ID of the associated Domain. +* **OwnershipSettings**: [OwnershipSettings](#ownershipsettings) +* **SpaceArn**: string (ReadOnly): The space Amazon Resource Name (ARN). +* **SpaceDisplayName**: string +* **SpaceName**: string (Required, Identifier): A name for the Space. +* **SpaceSettings**: [SpaceSettings](#spacesettings) (WriteOnly): A collection of settings. +* **SpaceSharingSettings**: [SpaceSharingSettings](#spacesharingsettings) +* **Tags**: [Tag](#tag)[] (WriteOnly): A list of tags to apply to the space. +* **Url**: string (ReadOnly) -## AWS.SageMaker/InferenceExperimentProperties +## AWS.SageMaker/UserProfileProperties ### Properties -* **Arn**: string (ReadOnly): The Amazon Resource Name (ARN) of the inference experiment. -* **CreationTime**: string (ReadOnly): The timestamp at which you created the inference experiment. -* **DataStorageConfig**: [DataStorageConfig](#datastorageconfig) -* **Description**: string: The description of the inference experiment. -* **DesiredState**: string: The desired state of the experiment after starting or stopping operation. -* **EndpointMetadata**: [EndpointMetadata](#endpointmetadata) (ReadOnly) -* **EndpointName**: string (Required) -* **KmsKey**: string: The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. -* **LastModifiedTime**: string (ReadOnly): The timestamp at which you last modified the inference experiment. -* **ModelVariants**: [ModelVariantConfig](#modelvariantconfig)[] (Required): An array of ModelVariantConfig objects. Each ModelVariantConfig object in the array describes the infrastructure configuration for the corresponding variant. -* **Name**: string (Required, Identifier): The name for the inference experiment. -* **RoleArn**: string (Required): The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment. -* **Schedule**: [InferenceExperimentSchedule](#inferenceexperimentschedule) -* **ShadowModeConfig**: [ShadowModeConfig](#shadowmodeconfig) -* **Status**: string (ReadOnly): The status of the inference experiment. -* **StatusReason**: string: The error message or client-specified reason from the StopInferenceExperiment API, that explains the status of the inference experiment. -* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. -* **Type**: string (Required): The type of the inference experiment that you want to run. +* **DomainId**: string (Required, Identifier): The ID of the associated Domain. +* **SingleSignOnUserIdentifier**: string: A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only supported value is "UserName". If the Domain's AuthMode is SSO, this field is required. If the Domain's AuthMode is not SSO, this field cannot be specified. +* **SingleSignOnUserValue**: string: The username of the associated AWS Single Sign-On User for this UserProfile. If the Domain's AuthMode is SSO, this field is required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not SSO, this field cannot be specified. +* **Tags**: [Tag](#tag)[] (WriteOnly): A list of tags to apply to the user profile. +* **UserProfileArn**: string (ReadOnly): The user profile Amazon Resource Name (ARN). +* **UserProfileName**: string (Required, Identifier): A name for the UserProfile. +* **UserSettings**: [UserSettings](#usersettings): A collection of settings. + +## BaselineConfig +### Properties +* **ConstraintsResource**: [ConstraintsResource](#constraintsresource) +* **StatisticsResource**: [StatisticsResource](#statisticsresource) + +## BatchTransformInput +### Properties +* **DataCapturedDestinationS3Uri**: string (Required): A URI that identifies the Amazon S3 storage location where Batch Transform Job captures data. +* **DatasetFormat**: [DatasetFormat](#datasetformat) (Required) +* **ExcludeFeaturesAttribute**: string: Indexes or names of the features to be excluded from analysis +* **LocalPath**: string (Required): Path to the filesystem where the endpoint data is available to the container. +* **S3DataDistributionType**: string: Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defauts to FullyReplicated +* **S3InputMode**: string: Whether the Pipe or File is used as the input mode for transfering data for the monitoring job. Pipe mode is recommended for large datasets. File mode is useful for small files that fit in memory. Defaults to File. + +## Bias +### Properties +* **PostTrainingReport**: [MetricsSource](#metricssource) +* **PreTrainingReport**: [MetricsSource](#metricssource) +* **Report**: [MetricsSource](#metricssource) + +## BusinessDetails +### Properties +* **BusinessProblem**: string: What business problem does the model solve? +* **BusinessStakeholders**: string: Business stakeholders. +* **LineOfBusiness**: string: Line of business. + +## CaptureContentTypeHeader +### Properties +* **CsvContentTypes**: string[]: The list of all content type headers that SageMaker will treat as CSV and capture accordingly. +* **JsonContentTypes**: string[]: The list of all content type headers that SageMaker will treat as JSON and capture accordingly. + +## ClusterConfig +### Properties +* **InstanceCount**: int (Required): The number of ML compute instances to use in the model monitoring job. For distributed processing jobs, specify a value greater than 1. The default value is 1. +* **InstanceType**: string (Required): The ML compute instance type for the processing job. +* **VolumeKmsKeyId**: string: The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the model monitoring job. +* **VolumeSizeInGB**: int (Required): The size of the ML storage volume, in gigabytes, that you want to provision. You must specify sufficient ML storage for your scenario. + +## CodeEditorAppImageConfig +### Properties +* **ContainerConfig**: [ContainerConfig](#containerconfig): The container configuration for a SageMaker image. + +## CodeEditorAppSettings +### Properties +* **CustomImages**: [CustomImage](#customimage)[]: A list of custom images for use for CodeEditor apps. +* **DefaultResourceSpec**: [ResourceSpec](#resourcespec): The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the CodeEditor app. +* **LifecycleConfigArns**: string[]: A list of LifecycleConfigArns available for use with CodeEditor apps. + +## CodeEditorAppSettings +### Properties +* **CustomImages**: [CustomImage](#customimage)[]: A list of custom images for use for CodeEditor apps. +* **DefaultResourceSpec**: [ResourceSpec](#resourcespec): The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the CodeEditor app. +* **LifecycleConfigArns**: string[]: A list of LifecycleConfigArns available for use with CodeEditor apps. + +## CodeRepository +### Properties +* **RepositoryUrl**: string (Required): A CodeRepository (valid URL) to be used within Jupyter's Git extension. + +## CodeRepository +### Properties +* **RepositoryUrl**: string (Required): A CodeRepository (valid URL) to be used within Jupyter's Git extension. + +## CodeRepository +### Properties +* **RepositoryUrl**: string (Required): A CodeRepository (valid URL) to be used within Jupyter's Git extension. + +## ConstraintsResource +### Properties +* **S3Uri**: string: The Amazon S3 URI for baseline constraint file in Amazon S3 that the current monitoring job should validated against. + +## Container +### Properties +* **Image**: string (Required): Inference environment path. The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored. +* **ModelDataUrl**: string: The Amazon S3 path where the model artifacts, which result from model training, are stored. +* **NearestModelName**: string: The name of a pre-trained machine learning benchmarked by Amazon SageMaker Inference Recommender model that matches your model. + +## ContainerConfig +### Properties +* **ContainerArguments**: string[]: A list of arguments to apply to the container. +* **ContainerEntrypoint**: string[]: The custom entry point to use on container. +* **ContainerEnvironmentVariables**: [CustomImageContainerEnvironmentVariable](#customimagecontainerenvironmentvariable)[]: A list of variables to apply to the custom container. + +## Content +### Properties +* **AdditionalInformation**: [AdditionalInformation](#additionalinformation) +* **BusinessDetails**: [BusinessDetails](#businessdetails) +* **EvaluationDetails**: [EvaluationDetail](#evaluationdetail)[] +* **IntendedUses**: [IntendedUses](#intendeduses) +* **ModelOverview**: [ModelOverview](#modeloverview) +* **ModelPackageDetails**: [ModelPackageDetails](#modelpackagedetails) +* **TrainingDetails**: [TrainingDetails](#trainingdetails) + +## Csv +### Properties +* **Header**: bool: A boolean flag indicating if given CSV has header + +## CustomerMetadataProperties +### Properties + +## CustomFileSystem +### Properties +* **EFSFileSystem**: [EFSFileSystem](#efsfilesystem) + +## CustomFileSystemConfig +### Properties +* **EFSFileSystemConfig**: [EFSFileSystemConfig](#efsfilesystemconfig) + +## CustomFileSystemConfig +### Properties +* **EFSFileSystemConfig**: [EFSFileSystemConfig](#efsfilesystemconfig) + +## CustomImage +### Properties +* **AppImageConfigName**: string (Required): The Name of the AppImageConfig. +* **ImageName**: string (Required): The name of the CustomImage. Must be unique to your account. +* **ImageVersionNumber**: int: The version number of the CustomImage. + +## CustomImage +### Properties +* **AppImageConfigName**: string (Required): The Name of the AppImageConfig. +* **ImageName**: string (Required): The name of the CustomImage. Must be unique to your account. +* **ImageVersionNumber**: int: The version number of the CustomImage. + +## CustomImage +### Properties +* **AppImageConfigName**: string (Required): The Name of the AppImageConfig. +* **ImageName**: string (Required): The name of the CustomImage. Must be unique to your account. +* **ImageVersionNumber**: int: The version number of the CustomImage. + +## CustomImageContainerEnvironmentVariable +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + +## CustomPosixUserConfig +### Properties +* **Gid**: int (Required) +* **Uid**: int (Required) + +## CustomPosixUserConfig +### Properties +* **Gid**: int (Required) +* **Uid**: int (Required) + +## DataCatalogConfig +### Properties +* **Catalog**: string (Required) +* **Database**: string (Required) +* **TableName**: string (Required) + +## DatasetFormat +### Properties +* **Csv**: [Csv](#csv) +* **Json**: [Json](#json) +* **Parquet**: bool + +## DataSource +### Properties +* **S3DataSource**: [S3DataSource](#s3datasource) (Required) ## DataStorageConfig ### Properties @@ -493,339 +535,288 @@ * **Destination**: string (Required): The Amazon S3 bucket where the inference request and response data is stored. * **KmsKey**: string: The AWS Key Management Service key that Amazon SageMaker uses to encrypt captured data at rest using Amazon S3 server-side encryption. -## CaptureContentTypeHeader +## DefaultEbsStorageSettings ### Properties -* **CsvContentTypes**: string[]: The list of all content type headers that SageMaker will treat as CSV and capture accordingly. -* **JsonContentTypes**: string[]: The list of all content type headers that SageMaker will treat as JSON and capture accordingly. +* **DefaultEbsVolumeSizeInGb**: int (Required): Default size of the Amazon EBS volume in Gb +* **MaximumEbsVolumeSizeInGb**: int (Required): Maximum size of the Amazon EBS volume in Gb. Must be greater than or equal to the DefaultEbsVolumeSizeInGb. -## EndpointMetadata +## DefaultEbsStorageSettings ### Properties -* **EndpointConfigName**: string: The name of the endpoint configuration. -* **EndpointName**: string (Required) -* **EndpointStatus**: string: The status of the endpoint. For possible values of the status of an endpoint. +* **DefaultEbsVolumeSizeInGb**: int (Required): Default size of the Amazon EBS volume in Gb +* **MaximumEbsVolumeSizeInGb**: int (Required): Maximum size of the Amazon EBS volume in Gb. Must be greater than or equal to the DefaultEbsVolumeSizeInGb. -## ModelVariantConfig +## DefaultSpaceSettings ### Properties -* **InfrastructureConfig**: [ModelInfrastructureConfig](#modelinfrastructureconfig) (Required) -* **ModelName**: string (Required): The name of the Amazon SageMaker Model entity. -* **VariantName**: string (Required): The name of the variant. +* **CustomFileSystemConfigs**: [CustomFileSystemConfig](#customfilesystemconfig)[] +* **CustomPosixUserConfig**: [CustomPosixUserConfig](#customposixuserconfig): The Jupyter lab's custom posix user configurations. +* **ExecutionRole**: string (Required): The execution role for the space. +* **JupyterLabAppSettings**: [JupyterLabAppSettings](#jupyterlabappsettings): The Jupyter lab's app settings. +* **JupyterServerAppSettings**: [JupyterServerAppSettings](#jupyterserverappsettings): The Jupyter server's app settings. +* **KernelGatewayAppSettings**: [KernelGatewayAppSettings](#kernelgatewayappsettings): The kernel gateway app settings. +* **SecurityGroups**: string[]: The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication. +* **SpaceStorageSettings**: [DefaultSpaceStorageSettings](#defaultspacestoragesettings): The Jupyter lab's space storage settings. -## ModelInfrastructureConfig +## DefaultSpaceStorageSettings ### Properties -* **InfrastructureType**: string (Required): The type of the inference experiment that you want to run. -* **RealTimeInferenceConfig**: [RealTimeInferenceConfig](#realtimeinferenceconfig) (Required) +* **DefaultEbsStorageSettings**: [DefaultEbsStorageSettings](#defaultebsstoragesettings) -## RealTimeInferenceConfig +## DefaultSpaceStorageSettings ### Properties -* **InstanceCount**: int (Required): The number of instances of the type specified by InstanceType. -* **InstanceType**: string (Required): The instance type the model is deployed to. +* **DefaultEbsStorageSettings**: [DefaultEbsStorageSettings](#defaultebsstoragesettings) -## InferenceExperimentSchedule +## DeployedImage ### Properties -* **EndTime**: string: The timestamp at which the inference experiment ended or will end. -* **StartTime**: string: The timestamp at which the inference experiment started or will start. +* **ResolutionTime**: string +* **ResolvedImage**: string +* **SpecifiedImage**: string -## ShadowModeConfig +## Device ### Properties -* **ShadowModelVariants**: [ShadowModelVariantConfig](#shadowmodelvariantconfig)[] (Required): List of shadow variant configurations. -* **SourceModelVariantName**: string (Required): The name of the production variant, which takes all the inference requests. +* **Description**: string: Description of the device +* **DeviceName**: string (Required): The name of the device +* **IotThingName**: string: AWS Internet of Things (IoT) object name. -## ShadowModelVariantConfig +## DockerSettings ### Properties -* **SamplingPercentage**: int (Required): The percentage of inference requests that Amazon SageMaker replicates from the production variant to the shadow variant. -* **ShadowModelVariantName**: string (Required): The name of the shadow variant. +* **EnableDockerAccess**: string: The flag to enable/disable docker-proxy server +* **VpcOnlyTrustedAccounts**: string[]: A list of account id's that would be used to pull images from in VpcOnly mode -## Tag +## DomainSettings ### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **DockerSettings**: [DockerSettings](#dockersettings) +* **RStudioServerProDomainSettings**: [RStudioServerProDomainSettings](#rstudioserverprodomainsettings) +* **SecurityGroupIds**: string[]: The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps. -## AWS.SageMaker/ModelCardProperties +## DriftCheckBaselines ### Properties -* **Content**: [Content](#content) (Required) -* **CreatedBy**: [UserContext](#usercontext): Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card. -* **CreationTime**: string (ReadOnly): The date and time the model card was created. -* **LastModifiedBy**: [UserContext](#usercontext): Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card. -* **LastModifiedTime**: string (ReadOnly): The date and time the model card was last modified. -* **ModelCardArn**: string (ReadOnly): The Amazon Resource Name (ARN) of the successfully created model card. -* **ModelCardName**: string (Required, Identifier): The unique name of the model card. -* **ModelCardProcessingStatus**: string (ReadOnly): The processing status of model card deletion. The ModelCardProcessingStatus updates throughout the different deletion steps. -* **ModelCardStatus**: string (Required): The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval. -* **ModelCardVersion**: int (ReadOnly): A version of the model card. -* **SecurityConfig**: [SecurityConfig](#securityconfig) -* **Tags**: [Tag](#tag)[]: Key-value pairs used to manage metadata for model cards. +* **Bias**: [DriftCheckBias](#driftcheckbias) +* **Explainability**: [DriftCheckExplainability](#driftcheckexplainability) +* **ModelDataQuality**: [DriftCheckModelDataQuality](#driftcheckmodeldataquality) +* **ModelQuality**: [DriftCheckModelQuality](#driftcheckmodelquality) -## Content +## DriftCheckBias ### Properties -* **AdditionalInformation**: [AdditionalInformation](#additionalinformation) -* **BusinessDetails**: [BusinessDetails](#businessdetails) -* **EvaluationDetails**: [EvaluationDetail](#evaluationdetail)[] -* **IntendedUses**: [IntendedUses](#intendeduses) -* **ModelOverview**: [ModelOverview](#modeloverview) -* **ModelPackageDetails**: [ModelPackageDetails](#modelpackagedetails) -* **TrainingDetails**: [TrainingDetails](#trainingdetails) +* **ConfigFile**: [FileSource](#filesource) +* **PostTrainingConstraints**: [MetricsSource](#metricssource) +* **PreTrainingConstraints**: [MetricsSource](#metricssource) -## AdditionalInformation +## DriftCheckExplainability ### Properties -* **CaveatsAndRecommendations**: string: Caveats and recommendations for people who might use this model in their applications. -* **CustomDetails**: [ModelCard_CustomDetails](#modelcardcustomdetails): customer details. -* **EthicalConsiderations**: string: Any ethical considerations that the author wants to provide. +* **ConfigFile**: [FileSource](#filesource) +* **Constraints**: [MetricsSource](#metricssource) -## ModelCard_CustomDetails +## DriftCheckModelDataQuality ### Properties +* **Constraints**: [MetricsSource](#metricssource) +* **Statistics**: [MetricsSource](#metricssource) -## BusinessDetails +## DriftCheckModelQuality ### Properties -* **BusinessProblem**: string: What business problem does the model solve? -* **BusinessStakeholders**: string: Business stakeholders. -* **LineOfBusiness**: string: Line of business. +* **Constraints**: [MetricsSource](#metricssource) +* **Statistics**: [MetricsSource](#metricssource) -## EvaluationDetail +## EbsStorageSettings ### Properties -* **Datasets**: string[] -* **EvaluationJobArn**: string -* **EvaluationObservation**: string -* **Metadata**: [ModelCard_Metadata](#modelcardmetadata): additional attributes associated with the evaluation results. -* **MetricGroups**: [MetricGroup](#metricgroup)[] -* **Name**: string (Required) +* **EbsVolumeSizeInGb**: int (Required): Size of the Amazon EBS volume in Gb -## ModelCard_Metadata +## EdgeOutputConfig ### Properties +* **KmsKeyId**: string: The KMS key id used for encryption on the S3 bucket +* **S3OutputLocation**: string (Required): The Amazon Simple Storage (S3) bucket URI -## MetricGroup +## EFSFileSystem ### Properties -* **MetricData**: [ModelCard_MetricData](#modelcardmetricdata)[] (Required) -* **Name**: string (Required) +* **FileSystemId**: string (Required) -## ModelCard_MetricData +## EFSFileSystemConfig ### Properties +* **FileSystemId**: string (Required) +* **FileSystemPath**: string -## IntendedUses +## EFSFileSystemConfig ### Properties -* **ExplanationsForRiskRating**: string -* **FactorsAffectingModelEfficiency**: string -* **IntendedUses**: string: intended use cases. -* **PurposeOfModel**: string: Why the model was developed? -* **RiskRating**: string +* **FileSystemId**: string (Required) +* **FileSystemPath**: string -## ModelOverview +## EndpointInput ### Properties -* **AlgorithmType**: string: Algorithm used to solve the problem. -* **InferenceEnvironment**: [ModelCard_InferenceEnvironment](#modelcardinferenceenvironment): Overview about the inference. -* **ModelArtifact**: string[]: Location of the model artifact. -* **ModelCreator**: string: Creator of model. -* **ModelDescription**: string: description of model. -* **ModelId**: string: SageMaker Model Arn or Non SageMaker Model id. -* **ModelName**: string: Name of the model. -* **ModelOwner**: string: Owner of model. -* **ModelVersion**: int: Version of the model. -* **ProblemType**: string: Problem being solved with the model. +* **EndpointName**: string (Required) +* **ExcludeFeaturesAttribute**: string: Indexes or names of the features to be excluded from analysis +* **LocalPath**: string (Required): Path to the filesystem where the endpoint data is available to the container. +* **S3DataDistributionType**: string: Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defauts to FullyReplicated +* **S3InputMode**: string: Whether the Pipe or File is used as the input mode for transfering data for the monitoring job. Pipe mode is recommended for large datasets. File mode is useful for small files that fit in memory. Defaults to File. -## ModelCard_InferenceEnvironment +## EndpointMetadata ### Properties -* **ContainerImage**: string[]: SageMaker inference image uri. +* **EndpointConfigName**: string: The name of the endpoint configuration. +* **EndpointName**: string (Required) +* **EndpointStatus**: string: The status of the endpoint. For possible values of the status of an endpoint. -## ModelPackageDetails +## Environment ### Properties -* **ApprovalDescription**: string: A description provided for the model approval -* **CreatedBy**: [ModelPackageCreator](#modelpackagecreator): Information about the user who created model package. -* **Domain**: string: The machine learning domain of the model package you specified. Common machine learning domains include computer vision and natural language processing. -* **InferenceSpecification**: [InferenceSpecification](#inferencespecification): Details about inference jobs that can be run with models based on this model package. -* **ModelApprovalStatus**: string: Current approval status of model package -* **ModelPackageArn**: string: The Amazon Resource Name (ARN) of the model package -* **ModelPackageDescription**: string: A brief summary of the model package -* **ModelPackageGroupName**: string: If the model is a versioned model, the name of the model group that the versioned model belongs to. -* **ModelPackageName**: string: Name of the model package -* **ModelPackageStatus**: string: Current status of model package -* **ModelPackageVersion**: int: Version of the model package -* **SourceAlgorithms**: [SourceAlgorithm](#sourcealgorithm)[]: A list of algorithms that were used to create a model package. -* **Task**: string: The machine learning task you specified that your model package accomplishes. Common machine learning tasks include object detection and image classification. -## ModelPackageCreator +## EnvironmentMap ### Properties -* **UserProfileName**: string: The name of the user's profile in Studio -## InferenceSpecification +## EvaluationDetail ### Properties -* **Containers**: [Container](#container)[] (Required): Contains inference related information which were used to create model package. +* **Datasets**: string[] +* **EvaluationJobArn**: string +* **EvaluationObservation**: string +* **Metadata**: [ModelCard_Metadata](#modelcardmetadata): additional attributes associated with the evaluation results. +* **MetricGroups**: [MetricGroup](#metricgroup)[] +* **Name**: string (Required) -## Container +## Explainability ### Properties -* **Image**: string (Required): Inference environment path. The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored. -* **ModelDataUrl**: string: The Amazon S3 path where the model artifacts, which result from model training, are stored. -* **NearestModelName**: string: The name of a pre-trained machine learning benchmarked by Amazon SageMaker Inference Recommender model that matches your model. +* **Report**: [MetricsSource](#metricssource) -## SourceAlgorithm +## FeatureDefinition ### Properties -* **AlgorithmName**: string (Required): The name of an algorithm that was used to create the model package. The algorithm must be either an algorithm resource in your SageMaker account or an algorithm in AWS Marketplace that you are subscribed to. -* **ModelDataUrl**: string: The Amazon S3 path where the model artifacts, which result from model training, are stored. +* **FeatureName**: string (Required) +* **FeatureType**: string (Required) -## TrainingDetails +## FeatureGroup_OfflineStoreConfig ### Properties -* **ObjectiveFunction**: [ObjectiveFunction](#objectivefunction) -* **TrainingJobDetails**: [ModelCard_TrainingJobDetails](#modelcardtrainingjobdetails) -* **TrainingObservations**: string +* **DataCatalogConfig**: [DataCatalogConfig](#datacatalogconfig) +* **DisableGlueTableCreation**: bool +* **S3StorageConfig**: [S3StorageConfig](#s3storageconfig) (Required) +* **TableFormat**: string -## ObjectiveFunction +## FeatureGroup_OnlineStoreConfig ### Properties -* **Function**: [ModelCard_Function](#modelcardfunction): objective function that training job is optimized for. -* **Notes**: string +* **EnableOnlineStore**: bool +* **SecurityConfig**: [OnlineStoreSecurityConfig](#onlinestoresecurityconfig) +* **StorageType**: string +* **TtlDuration**: [TtlDuration](#ttlduration) -## ModelCard_Function +## FileSource ### Properties -* **Condition**: string -* **Facet**: string -* **Function**: string +* **ContentDigest**: string: The digest of the file source. +* **ContentType**: string: The type of content stored in the file source. +* **S3Uri**: string (Required): The Amazon S3 URI for the file source. -## ModelCard_TrainingJobDetails +## FileSystemConfig ### Properties -* **HyperParameters**: [TrainingHyperParameter](#traininghyperparameter)[] -* **TrainingArn**: string: SageMaker Training job arn. -* **TrainingDatasets**: string[]: Location of the model datasets. -* **TrainingEnvironment**: [ModelCard_TrainingJobDetails_TrainingEnvironment](#modelcardtrainingjobdetailstrainingenvironment) -* **TrainingMetrics**: [TrainingMetric](#trainingmetric)[] -* **UserProvidedHyperParameters**: [TrainingHyperParameter](#traininghyperparameter)[] -* **UserProvidedTrainingMetrics**: [TrainingMetric](#trainingmetric)[] +* **DefaultGid**: int: The default POSIX group ID (GID). If not specified, defaults to 100. +* **DefaultUid**: int: The default POSIX user ID (UID). If not specified, defaults to 1000. +* **MountPath**: string: The path within the image to mount the user's EFS home directory. The directory should be empty. If not specified, defaults to /home/sagemaker-user. -## TrainingHyperParameter +## InferenceComponentComputeResourceRequirements ### Properties -* **Name**: string (Required) -* **Value**: string (Required) +* **MaxMemoryRequiredInMb**: int +* **MinMemoryRequiredInMb**: int +* **NumberOfAcceleratorDevicesRequired**: int +* **NumberOfCpuCoresRequired**: int -## ModelCard_TrainingJobDetails_TrainingEnvironment +## InferenceComponentContainerSpecification ### Properties -* **ContainerImage**: string[]: SageMaker training image uri. +* **ArtifactUrl**: string +* **DeployedImage**: [DeployedImage](#deployedimage) (ReadOnly) +* **Environment**: [EnvironmentMap](#environmentmap) +* **Image**: string (WriteOnly) -## TrainingMetric +## InferenceComponentRuntimeConfig ### Properties -* **Name**: string (Required) -* **Notes**: string -* **Value**: int (Required) +* **CopyCount**: int (WriteOnly) +* **CurrentCopyCount**: int (ReadOnly) +* **DesiredCopyCount**: int (ReadOnly) -## UserContext +## InferenceComponentSpecification ### Properties -* **DomainId**: string (ReadOnly): The domain associated with the user. -* **UserProfileArn**: string (ReadOnly): The Amazon Resource Name (ARN) of the user's profile. -* **UserProfileName**: string (ReadOnly): The name of the user's profile. +* **ComputeResourceRequirements**: [InferenceComponentComputeResourceRequirements](#inferencecomponentcomputeresourcerequirements) (Required) +* **Container**: [InferenceComponentContainerSpecification](#inferencecomponentcontainerspecification) +* **ModelName**: string +* **StartupParameters**: [InferenceComponentStartupParameters](#inferencecomponentstartupparameters) -## SecurityConfig +## InferenceComponentStartupParameters ### Properties -* **KmsKeyId**: string: A Key Management Service key ID to use for encrypting a model card. +* **ContainerStartupHealthCheckTimeoutInSeconds**: int +* **ModelDataDownloadTimeoutInSeconds**: int -## Tag +## InferenceExperimentSchedule ### Properties -* **Key**: string (Required): The tag key. Tag keys must be unique per resource. -* **Value**: string (Required): The tag value. +* **EndTime**: string: The timestamp at which the inference experiment ended or will end. +* **StartTime**: string: The timestamp at which the inference experiment started or will start. -## AWS.SageMaker/ModelPackageProperties +## InferenceSpecification ### Properties -* **AdditionalInferenceSpecifications**: [AdditionalInferenceSpecificationDefinition](#additionalinferencespecificationdefinition)[] -* **AdditionalInferenceSpecificationsToAdd**: [AdditionalInferenceSpecificationDefinition](#additionalinferencespecificationdefinition)[] (WriteOnly) -* **ApprovalDescription**: string -* **CertifyForMarketplace**: bool -* **ClientToken**: string (WriteOnly) -* **CreationTime**: string (ReadOnly) -* **CustomerMetadataProperties**: [CustomerMetadataProperties](#customermetadataproperties) -* **Domain**: string -* **DriftCheckBaselines**: [DriftCheckBaselines](#driftcheckbaselines) -* **InferenceSpecification**: [InferenceSpecification](#inferencespecification) -* **LastModifiedTime**: string -* **MetadataProperties**: [MetadataProperties](#metadataproperties) -* **ModelApprovalStatus**: string -* **ModelMetrics**: [ModelMetrics](#modelmetrics) -* **ModelPackageArn**: string (ReadOnly, Identifier) -* **ModelPackageDescription**: string -* **ModelPackageGroupName**: string -* **ModelPackageName**: string -* **ModelPackageStatus**: string (ReadOnly) -* **ModelPackageStatusDetails**: [ModelPackageStatusDetails](#modelpackagestatusdetails) -* **ModelPackageVersion**: int -* **SamplePayloadUrl**: string -* **SkipModelValidation**: string -* **SourceAlgorithmSpecification**: [SourceAlgorithmSpecification](#sourcealgorithmspecification) -* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. -* **Task**: string -* **ValidationSpecification**: [ValidationSpecification](#validationspecification) +* **Containers**: [Container](#container)[] (Required): Contains inference related information which were used to create model package. -## AdditionalInferenceSpecificationDefinition +## InferenceSpecification ### Properties * **Containers**: [ModelPackageContainerDefinition](#modelpackagecontainerdefinition)[] (Required): The Amazon ECR registry path of the Docker image that contains the inference code. -* **Description**: string: A description of the additional Inference specification. -* **Name**: string (Required): A unique name to identify the additional inference specification. The name must be unique within the list of your additional inference specifications for a particular model package. -* **SupportedContentTypes**: string[]: The supported MIME types for the input data. +* **SupportedContentTypes**: string[] (Required): The supported MIME types for the input data. * **SupportedRealtimeInferenceInstanceTypes**: string[]: A list of the instance types that are used to generate inferences in real-time -* **SupportedResponseMIMETypes**: string[]: The supported MIME types for the output data. +* **SupportedResponseMIMETypes**: string[] (Required): The supported MIME types for the output data. * **SupportedTransformInstanceTypes**: string[]: A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed. -## ModelPackageContainerDefinition +## IntendedUses ### Properties -* **ContainerHostname**: string: The DNS host name for the Docker container. -* **Environment**: [Environment](#environment) -* **Framework**: string: The machine learning framework of the model package container image. -* **FrameworkVersion**: string: The framework version of the Model Package Container Image. -* **Image**: string (Required): The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored. -* **ImageDigest**: string: An MD5 hash of the training algorithm that identifies the Docker image used for training. -* **ModelDataUrl**: string: A structure with Model Input details. -* **ModelInput**: [ModelPackage_ModelInput](#modelpackagemodelinput) -* **NearestModelName**: string: The name of a pre-trained machine learning benchmarked by Amazon SageMaker Inference Recommender model that matches your model. +* **ExplanationsForRiskRating**: string +* **FactorsAffectingModelEfficiency**: string +* **IntendedUses**: string: intended use cases. +* **PurposeOfModel**: string: Why the model was developed? +* **RiskRating**: string -## Environment +## Json ### Properties +* **Line**: bool: A boolean flag indicating if it is JSON line format -## ModelPackage_ModelInput +## JupyterLabAppImageConfig ### Properties -* **DataInputConfig**: string (Required): The input configuration object for the model. +* **ContainerConfig**: [ContainerConfig](#containerconfig): The container configuration for a SageMaker image. -## CustomerMetadataProperties +## JupyterLabAppSettings ### Properties +* **CodeRepositories**: [CodeRepository](#coderepository)[]: A list of CodeRepositories available for use with JupyterLab apps. +* **CustomImages**: [CustomImage](#customimage)[]: A list of custom images for use for JupyterLab apps. +* **DefaultResourceSpec**: [ResourceSpec](#resourcespec): The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterLab app. +* **LifecycleConfigArns**: string[]: A list of LifecycleConfigArns available for use with JupyterLab apps. -## DriftCheckBaselines +## JupyterLabAppSettings ### Properties -* **Bias**: [DriftCheckBias](#driftcheckbias) -* **Explainability**: [DriftCheckExplainability](#driftcheckexplainability) -* **ModelDataQuality**: [DriftCheckModelDataQuality](#driftcheckmodeldataquality) -* **ModelQuality**: [DriftCheckModelQuality](#driftcheckmodelquality) +* **CodeRepositories**: [CodeRepository](#coderepository)[]: A list of CodeRepositories available for use with JupyterLab apps. +* **CustomImages**: [CustomImage](#customimage)[]: A list of custom images available for use for JupyterLab apps +* **DefaultResourceSpec**: [ResourceSpec](#resourcespec): The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterLab app. +* **LifecycleConfigArns**: string[]: A list of LifecycleConfigArns available for use with JupyterLab apps. -## DriftCheckBias +## JupyterServerAppSettings ### Properties -* **ConfigFile**: [FileSource](#filesource) -* **PostTrainingConstraints**: [MetricsSource](#metricssource) -* **PreTrainingConstraints**: [MetricsSource](#metricssource) +* **DefaultResourceSpec**: [ResourceSpec](#resourcespec) -## FileSource +## JupyterServerAppSettings ### Properties -* **ContentDigest**: string: The digest of the file source. -* **ContentType**: string: The type of content stored in the file source. -* **S3Uri**: string (Required): The Amazon S3 URI for the file source. +* **DefaultResourceSpec**: [ResourceSpec](#resourcespec) -## MetricsSource +## JupyterServerAppSettings ### Properties -* **ContentDigest**: string: The digest of the metric source. -* **ContentType**: string (Required): The type of content stored in the metric source. -* **S3Uri**: string (Required): The Amazon S3 URI for the metric source. +* **DefaultResourceSpec**: [ResourceSpec](#resourcespec) -## DriftCheckExplainability +## KernelGatewayAppSettings ### Properties -* **ConfigFile**: [FileSource](#filesource) -* **Constraints**: [MetricsSource](#metricssource) +* **CustomImages**: [CustomImage](#customimage)[]: A list of custom SageMaker images that are configured to run as a KernelGateway app. +* **DefaultResourceSpec**: [ResourceSpec](#resourcespec): The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app. -## DriftCheckModelDataQuality +## KernelGatewayAppSettings ### Properties -* **Constraints**: [MetricsSource](#metricssource) -* **Statistics**: [MetricsSource](#metricssource) +* **CustomImages**: [CustomImage](#customimage)[]: A list of custom SageMaker images that are configured to run as a KernelGateway app. +* **DefaultResourceSpec**: [ResourceSpec](#resourcespec): The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app. -## DriftCheckModelQuality +## KernelGatewayAppSettings ### Properties -* **Constraints**: [MetricsSource](#metricssource) -* **Statistics**: [MetricsSource](#metricssource) +* **CustomImages**: [CustomImage](#customimage)[]: A list of custom SageMaker images that are configured to run as a KernelGateway app. +* **DefaultResourceSpec**: [ResourceSpec](#resourcespec): The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app. -## InferenceSpecification +## KernelGatewayImageConfig ### Properties -* **Containers**: [ModelPackageContainerDefinition](#modelpackagecontainerdefinition)[] (Required): The Amazon ECR registry path of the Docker image that contains the inference code. -* **SupportedContentTypes**: string[] (Required): The supported MIME types for the input data. -* **SupportedRealtimeInferenceInstanceTypes**: string[]: A list of the instance types that are used to generate inferences in real-time -* **SupportedResponseMIMETypes**: string[] (Required): The supported MIME types for the output data. -* **SupportedTransformInstanceTypes**: string[]: A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed. +* **FileSystemConfig**: [FileSystemConfig](#filesystemconfig): The Amazon Elastic File System (EFS) storage configuration for a SageMaker image. +* **KernelSpecs**: [KernelSpec](#kernelspec)[] (Required): The specification of the Jupyter kernels in the image. + +## KernelSpec +### Properties +* **DisplayName**: string: The display name of the kernel. +* **Name**: string (Required): The name of the kernel. ## MetadataProperties ### Properties @@ -834,133 +825,144 @@ * **ProjectId**: string: The project ID metadata. * **Repository**: string: The repository metadata. -## ModelMetrics +## MetricGroup ### Properties -* **Bias**: [Bias](#bias) -* **Explainability**: [Explainability](#explainability) -* **ModelDataQuality**: [ModelDataQuality](#modeldataquality) -* **ModelQuality**: [ModelQuality](#modelquality) +* **MetricData**: [ModelCard_MetricData](#modelcardmetricdata)[] (Required) +* **Name**: string (Required) -## Bias +## MetricsSource ### Properties -* **PostTrainingReport**: [MetricsSource](#metricssource) -* **PreTrainingReport**: [MetricsSource](#metricssource) -* **Report**: [MetricsSource](#metricssource) +* **ContentDigest**: string: The digest of the metric source. +* **ContentType**: string (Required): The type of content stored in the metric source. +* **S3Uri**: string (Required): The Amazon S3 URI for the metric source. -## Explainability +## ModelCard_CustomDetails ### Properties -* **Report**: [MetricsSource](#metricssource) -## ModelDataQuality +## ModelCard_Function ### Properties -* **Constraints**: [MetricsSource](#metricssource) -* **Statistics**: [MetricsSource](#metricssource) +* **Condition**: string +* **Facet**: string +* **Function**: string -## ModelQuality +## ModelCard_InferenceEnvironment ### Properties -* **Constraints**: [MetricsSource](#metricssource) -* **Statistics**: [MetricsSource](#metricssource) +* **ContainerImage**: string[]: SageMaker inference image uri. -## ModelPackageStatusDetails +## ModelCard_Metadata ### Properties -* **ValidationStatuses**: [ModelPackageStatusItem](#modelpackagestatusitem)[] -## ModelPackageStatusItem +## ModelCard_MetricData ### Properties -* **FailureReason**: string: If the overall status is Failed, the reason for the failure. -* **Name**: string (Required): The name of the model package for which the overall status is being reported. -* **Status**: string (Required): The current status. -## SourceAlgorithmSpecification +## ModelCard_TrainingJobDetails ### Properties -* **SourceAlgorithms**: [SourceAlgorithm](#sourcealgorithm)[] (Required): A list of algorithms that were used to create a model package. +* **HyperParameters**: [TrainingHyperParameter](#traininghyperparameter)[] +* **TrainingArn**: string: SageMaker Training job arn. +* **TrainingDatasets**: string[]: Location of the model datasets. +* **TrainingEnvironment**: [ModelCard_TrainingJobDetails_TrainingEnvironment](#modelcardtrainingjobdetailstrainingenvironment) +* **TrainingMetrics**: [TrainingMetric](#trainingmetric)[] +* **UserProvidedHyperParameters**: [TrainingHyperParameter](#traininghyperparameter)[] +* **UserProvidedTrainingMetrics**: [TrainingMetric](#trainingmetric)[] -## SourceAlgorithm +## ModelCard_TrainingJobDetails_TrainingEnvironment ### Properties -* **AlgorithmName**: string (Required): The name of an algorithm that was used to create the model package. The algorithm must be either an algorithm resource in your Amazon SageMaker account or an algorithm in AWS Marketplace that you are subscribed to. -* **ModelDataUrl**: string: The Amazon S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix). +* **ContainerImage**: string[]: SageMaker training image uri. -## Tag +## ModelDataQuality ### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Constraints**: [MetricsSource](#metricssource) +* **Statistics**: [MetricsSource](#metricssource) -## ValidationSpecification +## ModelInfrastructureConfig ### Properties -* **ValidationProfiles**: [ValidationProfile](#validationprofile)[] (Required) -* **ValidationRole**: string (Required): The IAM roles to be used for the validation of the model package. +* **InfrastructureType**: string (Required): The type of the inference experiment that you want to run. +* **RealTimeInferenceConfig**: [RealTimeInferenceConfig](#realtimeinferenceconfig) (Required) -## ValidationProfile +## ModelMetrics ### Properties -* **ProfileName**: string (Required): The name of the profile for the model package. -* **TransformJobDefinition**: [TransformJobDefinition](#transformjobdefinition) (Required) +* **Bias**: [Bias](#bias) +* **Explainability**: [Explainability](#explainability) +* **ModelDataQuality**: [ModelDataQuality](#modeldataquality) +* **ModelQuality**: [ModelQuality](#modelquality) -## TransformJobDefinition +## ModelOverview ### Properties -* **BatchStrategy**: string: A string that determines the number of records included in a single mini-batch. -* **Environment**: [Environment](#environment) -* **MaxConcurrentTransforms**: int: The maximum number of parallel requests that can be sent to each instance in a transform job. The default value is 1. -* **MaxPayloadInMB**: int: The maximum payload size allowed, in MB. A payload is the data portion of a record (without metadata). -* **TransformInput**: [TransformInput](#transforminput) (Required) -* **TransformOutput**: [TransformOutput](#transformoutput) (Required) -* **TransformResources**: [TransformResources](#transformresources) (Required) +* **AlgorithmType**: string: Algorithm used to solve the problem. +* **InferenceEnvironment**: [ModelCard_InferenceEnvironment](#modelcardinferenceenvironment): Overview about the inference. +* **ModelArtifact**: string[]: Location of the model artifact. +* **ModelCreator**: string: Creator of model. +* **ModelDescription**: string: description of model. +* **ModelId**: string: SageMaker Model Arn or Non SageMaker Model id. +* **ModelName**: string: Name of the model. +* **ModelOwner**: string: Owner of model. +* **ModelVersion**: int: Version of the model. +* **ProblemType**: string: Problem being solved with the model. -## TransformInput +## ModelPackage_ModelInput ### Properties -* **CompressionType**: string: If your transform data is compressed, specify the compression type. Amazon SageMaker automatically decompresses the data for the transform job accordingly. The default value is None. -* **ContentType**: string: The multipurpose internet mail extension (MIME) type of the data. Amazon SageMaker uses the MIME type with each http call to transfer data to the transform job. -* **DataSource**: [DataSource](#datasource) (Required) -* **SplitType**: string: The method to use to split the transform job's data files into smaller batches. +* **DataInputConfig**: string (Required): The input configuration object for the model. -## DataSource +## ModelPackageContainerDefinition ### Properties -* **S3DataSource**: [S3DataSource](#s3datasource) (Required) +* **ContainerHostname**: string: The DNS host name for the Docker container. +* **Environment**: [Environment](#environment) +* **Framework**: string: The machine learning framework of the model package container image. +* **FrameworkVersion**: string: The framework version of the Model Package Container Image. +* **Image**: string (Required): The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored. +* **ImageDigest**: string: An MD5 hash of the training algorithm that identifies the Docker image used for training. +* **ModelDataUrl**: string: A structure with Model Input details. +* **ModelInput**: [ModelPackage_ModelInput](#modelpackagemodelinput) +* **NearestModelName**: string: The name of a pre-trained machine learning benchmarked by Amazon SageMaker Inference Recommender model that matches your model. -## S3DataSource +## ModelPackageCreator ### Properties -* **S3DataType**: string (Required): The S3 Data Source Type -* **S3Uri**: string (Required): Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest. +* **UserProfileName**: string: The name of the user's profile in Studio + +## ModelPackageDetails +### Properties +* **ApprovalDescription**: string: A description provided for the model approval +* **CreatedBy**: [ModelPackageCreator](#modelpackagecreator): Information about the user who created model package. +* **Domain**: string: The machine learning domain of the model package you specified. Common machine learning domains include computer vision and natural language processing. +* **InferenceSpecification**: [InferenceSpecification](#inferencespecification): Details about inference jobs that can be run with models based on this model package. +* **ModelApprovalStatus**: string: Current approval status of model package +* **ModelPackageArn**: string: The Amazon Resource Name (ARN) of the model package +* **ModelPackageDescription**: string: A brief summary of the model package +* **ModelPackageGroupName**: string: If the model is a versioned model, the name of the model group that the versioned model belongs to. +* **ModelPackageName**: string: Name of the model package +* **ModelPackageStatus**: string: Current status of model package +* **ModelPackageVersion**: int: Version of the model package +* **SourceAlgorithms**: [SourceAlgorithm](#sourcealgorithm)[]: A list of algorithms that were used to create a model package. +* **Task**: string: The machine learning task you specified that your model package accomplishes. Common machine learning tasks include object detection and image classification. -## TransformOutput +## ModelPackageStatusDetails ### Properties -* **Accept**: string: The MIME type used to specify the output data. Amazon SageMaker uses the MIME type with each http call to transfer data from the transform job. -* **AssembleWith**: string: Defines how to assemble the results of the transform job as a single S3 object. -* **KmsKeyId**: string: The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. -* **S3OutputPath**: string (Required): The Amazon S3 path where you want Amazon SageMaker to store the results of the transform job. +* **ValidationStatuses**: [ModelPackageStatusItem](#modelpackagestatusitem)[] -## TransformResources +## ModelPackageStatusItem ### Properties -* **InstanceCount**: int (Required): The number of ML compute instances to use in the transform job. For distributed transform jobs, specify a value greater than 1. The default value is 1. -* **InstanceType**: string (Required): The ML compute instance type for the transform job. -* **VolumeKmsKeyId**: string: The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt model data on the storage volume attached to the ML compute instance(s) that run the batch transform job. +* **FailureReason**: string: If the overall status is Failed, the reason for the failure. +* **Name**: string (Required): The name of the model package for which the overall status is being reported. +* **Status**: string (Required): The current status. -## AWS.SageMaker/ModelPackageGroupProperties +## ModelQuality ### Properties -* **CreationTime**: string (ReadOnly): The time at which the model package group was created. -* **ModelPackageGroupArn**: string (ReadOnly, Identifier) -* **ModelPackageGroupDescription**: string -* **ModelPackageGroupName**: string (Required) -* **ModelPackageGroupPolicy**: [ModelPackageGroup_ModelPackageGroupPolicy](#modelpackagegroupmodelpackagegrouppolicy) | string -* **ModelPackageGroupStatus**: string (ReadOnly): The status of a modelpackage group job. -* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. +* **Constraints**: [MetricsSource](#metricssource) +* **Statistics**: [MetricsSource](#metricssource) -## Tag +## ModelVariantConfig ### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **InfrastructureConfig**: [ModelInfrastructureConfig](#modelinfrastructureconfig) (Required) +* **ModelName**: string (Required): The name of the Amazon SageMaker Model entity. +* **VariantName**: string (Required): The name of the variant. -## AWS.SageMaker/MonitoringScheduleProperties +## MonitoringAppSpecification ### Properties -* **CreationTime**: string (ReadOnly): The time at which the schedule was created. -* **EndpointName**: string -* **FailureReason**: string: Contains the reason a monitoring job failed, if it failed. -* **LastModifiedTime**: string (ReadOnly): A timestamp that indicates the last time the monitoring job was modified. -* **LastMonitoringExecutionSummary**: [MonitoringExecutionSummary](#monitoringexecutionsummary): Describes metadata on the last execution to run, if there was one. -* **MonitoringScheduleArn**: string (ReadOnly, Identifier): The Amazon Resource Name (ARN) of the monitoring schedule. -* **MonitoringScheduleConfig**: [MonitoringScheduleConfig](#monitoringscheduleconfig) (Required) -* **MonitoringScheduleName**: string (Required) -* **MonitoringScheduleStatus**: string: The status of a schedule job. -* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. +* **ContainerArguments**: string[]: An array of arguments for the container used to run the monitoring job. +* **ContainerEntrypoint**: string[]: Specifies the entrypoint for a container used to run the monitoring job. +* **ImageUri**: string (Required): The container image to be run by the monitoring job. +* **PostAnalyticsProcessorSourceUri**: string: An Amazon S3 URI to a script that is called after analysis has been performed. Applicable only for the built-in (first party) containers. +* **RecordPreprocessorSourceUri**: string: An Amazon S3 URI to a script that is called per row prior to running analysis. It can base64 decode the payload and convert it into a flatted json so that the built-in container can use the converted data. Applicable only for the built-in (first party) containers ## MonitoringExecutionSummary ### Properties @@ -973,12 +975,10 @@ * **ProcessingJobArn**: string: The Amazon Resource Name (ARN) of the monitoring job. * **ScheduledTime**: string (Required): The time the monitoring job was scheduled. -## MonitoringScheduleConfig +## MonitoringInput ### Properties -* **MonitoringJobDefinition**: [MonitoringJobDefinition](#monitoringjobdefinition) -* **MonitoringJobDefinitionName**: string: Name of the job definition -* **MonitoringType**: string -* **ScheduleConfig**: [ScheduleConfig](#scheduleconfig) +* **BatchTransformInput**: [BatchTransformInput](#batchtransforminput) +* **EndpointInput**: [EndpointInput](#endpointinput) ## MonitoringJobDefinition ### Properties @@ -992,74 +992,122 @@ * **RoleArn**: string (Required): The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf. * **StoppingCondition**: [StoppingCondition](#stoppingcondition) -## BaselineConfig +## MonitoringOutput ### Properties -* **ConstraintsResource**: [ConstraintsResource](#constraintsresource) -* **StatisticsResource**: [StatisticsResource](#statisticsresource) +* **S3Output**: [S3Output](#s3output) (Required) -## ConstraintsResource +## MonitoringOutputConfig ### Properties -* **S3Uri**: string: The Amazon S3 URI for baseline constraint file in Amazon S3 that the current monitoring job should validated against. +* **KmsKeyId**: string: The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. +* **MonitoringOutputs**: [MonitoringOutput](#monitoringoutput)[] (Required): Monitoring outputs for monitoring jobs. This is where the output of the periodic monitoring jobs is uploaded. -## StatisticsResource +## MonitoringResources ### Properties -* **S3Uri**: string: The Amazon S3 URI for the baseline statistics file in Amazon S3 that the current monitoring job should be validated against. +* **ClusterConfig**: [ClusterConfig](#clusterconfig) (Required) ## MonitoringSchedule_Environment ### Properties -## MonitoringAppSpecification +## MonitoringScheduleConfig ### Properties -* **ContainerArguments**: string[]: An array of arguments for the container used to run the monitoring job. -* **ContainerEntrypoint**: string[]: Specifies the entrypoint for a container used to run the monitoring job. -* **ImageUri**: string (Required): The container image to be run by the monitoring job. -* **PostAnalyticsProcessorSourceUri**: string: An Amazon S3 URI to a script that is called after analysis has been performed. Applicable only for the built-in (first party) containers. -* **RecordPreprocessorSourceUri**: string: An Amazon S3 URI to a script that is called per row prior to running analysis. It can base64 decode the payload and convert it into a flatted json so that the built-in container can use the converted data. Applicable only for the built-in (first party) containers +* **MonitoringJobDefinition**: [MonitoringJobDefinition](#monitoringjobdefinition) +* **MonitoringJobDefinitionName**: string: Name of the job definition +* **MonitoringType**: string +* **ScheduleConfig**: [ScheduleConfig](#scheduleconfig) -## MonitoringInput +## NetworkConfig ### Properties -* **BatchTransformInput**: [BatchTransformInput](#batchtransforminput) -* **EndpointInput**: [EndpointInput](#endpointinput) +* **EnableInterContainerTrafficEncryption**: bool: Whether to encrypt all communications between distributed processing jobs. Choose True to encrypt communications. Encryption provides greater security for distributed processing jobs, but the processing might take longer. +* **EnableNetworkIsolation**: bool: Whether to allow inbound and outbound network calls to and from the containers used for the processing job. +* **VpcConfig**: [VpcConfig](#vpcconfig) -## BatchTransformInput +## ObjectiveFunction ### Properties -* **DataCapturedDestinationS3Uri**: string (Required): A URI that identifies the Amazon S3 storage location where Batch Transform Job captures data. -* **DatasetFormat**: [DatasetFormat](#datasetformat) (Required) -* **ExcludeFeaturesAttribute**: string: Indexes or names of the features to be excluded from analysis -* **LocalPath**: string (Required): Path to the filesystem where the endpoint data is available to the container. -* **S3DataDistributionType**: string: Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defauts to FullyReplicated -* **S3InputMode**: string: Whether the Pipe or File is used as the input mode for transfering data for the monitoring job. Pipe mode is recommended for large datasets. File mode is useful for small files that fit in memory. Defaults to File. +* **Function**: [ModelCard_Function](#modelcardfunction): objective function that training job is optimized for. +* **Notes**: string -## DatasetFormat +## OnlineStoreSecurityConfig ### Properties -* **Csv**: [Csv](#csv) -* **Json**: [Json](#json) -* **Parquet**: bool +* **KmsKeyId**: string -## Csv +## OwnershipSettings ### Properties -* **Header**: bool: A boolean flag indicating if given CSV has header +* **OwnerUserProfileName**: string (Required) -## Json +## Pipeline_ParallelismConfiguration ### Properties -* **Line**: bool: A boolean flag indicating if it is JSON line format +* **MaxParallelExecutionSteps**: int (Required): Maximum parallel execution steps -## EndpointInput +## Pipeline_PipelineDefinition ### Properties -* **EndpointName**: string (Required) -* **ExcludeFeaturesAttribute**: string: Indexes or names of the features to be excluded from analysis -* **LocalPath**: string (Required): Path to the filesystem where the endpoint data is available to the container. -* **S3DataDistributionType**: string: Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defauts to FullyReplicated -* **S3InputMode**: string: Whether the Pipe or File is used as the input mode for transfering data for the monitoring job. Pipe mode is recommended for large datasets. File mode is useful for small files that fit in memory. Defaults to File. -## MonitoringOutputConfig +## Project_ServiceCatalogProvisionedProductDetails ### Properties -* **KmsKeyId**: string: The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. -* **MonitoringOutputs**: [MonitoringOutput](#monitoringoutput)[] (Required): Monitoring outputs for monitoring jobs. This is where the output of the periodic monitoring jobs is uploaded. +* **ProvisionedProductId**: string +* **ProvisionedProductStatusMessage**: string -## MonitoringOutput +## Project_ServiceCatalogProvisioningDetails ### Properties -* **S3Output**: [S3Output](#s3output) (Required) +* **PathId**: string +* **ProductId**: string (Required) +* **ProvisioningArtifactId**: string +* **ProvisioningParameters**: [ProvisioningParameter](#provisioningparameter)[]: Parameters specified by the administrator that are required for provisioning the product. + +## ProvisioningParameter +### Properties +* **Key**: string (Required): The parameter key. +* **Value**: string (Required): The parameter value. + +## RealTimeInferenceConfig +### Properties +* **InstanceCount**: int (Required): The number of instances of the type specified by InstanceType. +* **InstanceType**: string (Required): The instance type the model is deployed to. + +## ResourceSpec +### Properties +* **InstanceType**: string: The instance type that the image version runs on. +* **LifecycleConfigArn**: string: The Amazon Resource Name (ARN) of the Lifecycle Configuration to attach to the Resource. +* **SageMakerImageArn**: string: The Amazon Resource Name (ARN) of the SageMaker image that the image version belongs to. +* **SageMakerImageVersionArn**: string: The Amazon Resource Name (ARN) of the image version created on the instance. + +## ResourceSpec +### Properties +* **InstanceType**: string: The instance type that the image version runs on. +* **SageMakerImageArn**: string: The ARN of the SageMaker image that the image version belongs to. +* **SageMakerImageVersionArn**: string: The ARN of the image version created on the instance. + +## ResourceSpec +### Properties +* **InstanceType**: string: The instance type that the image version runs on. +* **SageMakerImageArn**: string: The ARN of the SageMaker image that the image version belongs to. +* **SageMakerImageVersionArn**: string: The ARN of the image version created on the instance. + +## RSessionAppSettings +### Properties +* **CustomImages**: [CustomImage](#customimage)[]: A list of custom SageMaker images that are configured to run as a KernelGateway app. +* **DefaultResourceSpec**: [ResourceSpec](#resourcespec) + +## RStudioServerProAppSettings +### Properties +* **AccessStatus**: string: Indicates whether the current user has access to the RStudioServerPro app. +* **UserGroup**: string: The level of permissions that the user has within the RStudioServerPro app. This value defaults to User. The Admin value allows the user access to the RStudio Administrative Dashboard. + +## RStudioServerProAppSettings +### Properties +* **AccessStatus**: string: Indicates whether the current user has access to the RStudioServerPro app. +* **UserGroup**: string: The level of permissions that the user has within the RStudioServerPro app. This value defaults to User. The Admin value allows the user access to the RStudio Administrative Dashboard. + +## RStudioServerProDomainSettings +### Properties +* **DefaultResourceSpec**: [ResourceSpec](#resourcespec) +* **DomainExecutionRoleArn**: string (Required): The ARN of the execution role for the RStudioServerPro Domain-level app. +* **RStudioConnectUrl**: string: A URL pointing to an RStudio Connect server. +* **RStudioPackageManagerUrl**: string: A URL pointing to an RStudio Package Manager server. + +## S3DataSource +### Properties +* **S3DataType**: string (Required): The S3 Data Source Type +* **S3Uri**: string (Required): Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest. ## S3Output ### Properties @@ -1067,237 +1115,281 @@ * **S3UploadMode**: string: Whether to upload the results of the monitoring job continuously or after the job completes. * **S3Uri**: string (Required): A URI that identifies the Amazon S3 storage location where Amazon SageMaker saves the results of a monitoring job. -## MonitoringResources +## S3StorageConfig ### Properties -* **ClusterConfig**: [ClusterConfig](#clusterconfig) (Required) +* **KmsKeyId**: string +* **S3Uri**: string (Required) -## ClusterConfig +## ScheduleConfig ### Properties -* **InstanceCount**: int (Required): The number of ML compute instances to use in the model monitoring job. For distributed processing jobs, specify a value greater than 1. The default value is 1. -* **InstanceType**: string (Required): The ML compute instance type for the processing job. -* **VolumeKmsKeyId**: string: The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the model monitoring job. -* **VolumeSizeInGB**: int (Required): The size of the ML storage volume, in gigabytes, that you want to provision. You must specify sufficient ML storage for your scenario. +* **DataAnalysisEndTime**: string: Data Analysis end time, e.g. PT0H +* **DataAnalysisStartTime**: string: Data Analysis start time, e.g. -PT1H +* **ScheduleExpression**: string (Required): A cron expression or 'NOW' that describes details about the monitoring schedule. -## NetworkConfig +## SecurityConfig ### Properties -* **EnableInterContainerTrafficEncryption**: bool: Whether to encrypt all communications between distributed processing jobs. Choose True to encrypt communications. Encryption provides greater security for distributed processing jobs, but the processing might take longer. -* **EnableNetworkIsolation**: bool: Whether to allow inbound and outbound network calls to and from the containers used for the processing job. -* **VpcConfig**: [VpcConfig](#vpcconfig) +* **KmsKeyId**: string: A Key Management Service key ID to use for encrypting a model card. + +## ShadowModeConfig +### Properties +* **ShadowModelVariants**: [ShadowModelVariantConfig](#shadowmodelvariantconfig)[] (Required): List of shadow variant configurations. +* **SourceModelVariantName**: string (Required): The name of the production variant, which takes all the inference requests. + +## ShadowModelVariantConfig +### Properties +* **SamplingPercentage**: int (Required): The percentage of inference requests that Amazon SageMaker replicates from the production variant to the shadow variant. +* **ShadowModelVariantName**: string (Required): The name of the shadow variant. + +## SharingSettings +### Properties +* **NotebookOutputOption**: string: Whether to include the notebook cell output when sharing the notebook. The default is Disabled. +* **S3KmsKeyId**: string: When NotebookOutputOption is Allowed, the AWS Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket. +* **S3OutputPath**: string: When NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots. + +## SharingSettings +### Properties +* **NotebookOutputOption**: string: Whether to include the notebook cell output when sharing the notebook. The default is Disabled. +* **S3KmsKeyId**: string: When NotebookOutputOption is Allowed, the AWS Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket. +* **S3OutputPath**: string: When NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots. + +## SourceAlgorithm +### Properties +* **AlgorithmName**: string (Required): The name of an algorithm that was used to create the model package. The algorithm must be either an algorithm resource in your SageMaker account or an algorithm in AWS Marketplace that you are subscribed to. +* **ModelDataUrl**: string: The Amazon S3 path where the model artifacts, which result from model training, are stored. + +## SourceAlgorithm +### Properties +* **AlgorithmName**: string (Required): The name of an algorithm that was used to create the model package. The algorithm must be either an algorithm resource in your Amazon SageMaker account or an algorithm in AWS Marketplace that you are subscribed to. +* **ModelDataUrl**: string: The Amazon S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix). + +## SourceAlgorithmSpecification +### Properties +* **SourceAlgorithms**: [SourceAlgorithm](#sourcealgorithm)[] (Required): A list of algorithms that were used to create a model package. -## VpcConfig +## SpaceCodeEditorAppSettings ### Properties -* **SecurityGroupIds**: string[] (Required): The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field. -* **Subnets**: string[] (Required): The ID of the subnets in the VPC to which you want to connect to your monitoring jobs. +* **DefaultResourceSpec**: [ResourceSpec](#resourcespec) -## StoppingCondition +## SpaceJupyterLabAppSettings ### Properties -* **MaxRuntimeInSeconds**: int (Required): The maximum runtime allowed in seconds. +* **CodeRepositories**: [CodeRepository](#coderepository)[]: A list of CodeRepositories available for use with JupyterLab apps. +* **DefaultResourceSpec**: [ResourceSpec](#resourcespec) -## ScheduleConfig +## SpaceSettings ### Properties -* **DataAnalysisEndTime**: string: Data Analysis end time, e.g. PT0H -* **DataAnalysisStartTime**: string: Data Analysis start time, e.g. -PT1H -* **ScheduleExpression**: string (Required): A cron expression or 'NOW' that describes details about the monitoring schedule. +* **AppType**: string +* **CodeEditorAppSettings**: [SpaceCodeEditorAppSettings](#spacecodeeditorappsettings): The CodeEditor app settings. +* **CustomFileSystems**: [CustomFileSystem](#customfilesystem)[] +* **JupyterLabAppSettings**: [SpaceJupyterLabAppSettings](#spacejupyterlabappsettings): The JupyterLab app settings. +* **JupyterServerAppSettings**: [JupyterServerAppSettings](#jupyterserverappsettings): The Jupyter server's app settings. +* **KernelGatewayAppSettings**: [KernelGatewayAppSettings](#kernelgatewayappsettings): The kernel gateway app settings. +* **SpaceStorageSettings**: [SpaceStorageSettings](#spacestoragesettings): Default storage settings for a space. -## Tag +## SpaceSharingSettings ### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **SharingType**: string (Required) -## AWS.SageMaker/PipelineProperties +## SpaceStorageSettings ### Properties -* **ParallelismConfiguration**: [Pipeline_ParallelismConfiguration](#pipelineparallelismconfiguration) -* **PipelineDefinition**: [Pipeline_PipelineDefinition](#pipelinepipelinedefinition) (Required) -* **PipelineDescription**: string: The description of the Pipeline. -* **PipelineDisplayName**: string: The display name of the Pipeline. -* **PipelineName**: string (Required, Identifier): The name of the Pipeline. -* **RoleArn**: string (Required): Role Arn -* **Tags**: [Tag](#tag)[] +* **EbsStorageSettings**: [EbsStorageSettings](#ebsstoragesettings) -## Pipeline_ParallelismConfiguration +## StatisticsResource ### Properties -* **MaxParallelExecutionSteps**: int (Required): Maximum parallel execution steps +* **S3Uri**: string: The Amazon S3 URI for the baseline statistics file in Amazon S3 that the current monitoring job should be validated against. -## Pipeline_PipelineDefinition +## StoppingCondition ### Properties +* **MaxRuntimeInSeconds**: int (Required): The maximum runtime allowed in seconds. ## Tag ### Properties * **Key**: string (Required) * **Value**: string (Required) -## AWS.SageMaker/ProjectProperties +## Tag ### Properties -* **CreationTime**: string (ReadOnly): The time at which the project was created. -* **ProjectArn**: string (ReadOnly, Identifier) -* **ProjectDescription**: string -* **ProjectId**: string (ReadOnly) -* **ProjectName**: string (Required) -* **ProjectStatus**: string (ReadOnly): The status of a project. -* **ServiceCatalogProvisionedProductDetails**: [Project_ServiceCatalogProvisionedProductDetails](#projectservicecatalogprovisionedproductdetails): Provisioned ServiceCatalog Details -* **ServiceCatalogProvisioningDetails**: [Project_ServiceCatalogProvisioningDetails](#projectservicecatalogprovisioningdetails) (Required): Input ServiceCatalog Provisioning Details -* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The key value of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -## Project_ServiceCatalogProvisionedProductDetails +## Tag ### Properties -* **ProvisionedProductId**: string -* **ProvisionedProductStatusMessage**: string +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The key value of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -## Project_ServiceCatalogProvisioningDetails +## Tag ### Properties -* **PathId**: string -* **ProductId**: string (Required) -* **ProvisioningArtifactId**: string -* **ProvisioningParameters**: [ProvisioningParameter](#provisioningparameter)[]: Parameters specified by the administrator that are required for provisioning the product. +* **Key**: string (Required) +* **Value**: string (Required) -## ProvisioningParameter +## Tag ### Properties -* **Key**: string (Required): The parameter key. -* **Value**: string (Required): The parameter value. +* **Key**: string (Required) +* **Value**: string (Required) ## Tag ### Properties * **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. * **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -## AWS.SageMaker/SpaceProperties +## Tag ### Properties -* **DomainId**: string (Required, Identifier): The ID of the associated Domain. -* **SpaceArn**: string (ReadOnly): The space Amazon Resource Name (ARN). -* **SpaceName**: string (Required, Identifier): A name for the Space. -* **SpaceSettings**: [SpaceSettings](#spacesettings) (WriteOnly): A collection of settings. -* **Tags**: [Tag](#tag)[] (WriteOnly): A list of tags to apply to the space. +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and - +* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and - -## SpaceSettings +## Tag ### Properties -* **JupyterServerAppSettings**: [JupyterServerAppSettings](#jupyterserverappsettings): The Jupyter server's app settings. -* **KernelGatewayAppSettings**: [KernelGatewayAppSettings](#kernelgatewayappsettings): The kernel gateway app settings. +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -## JupyterServerAppSettings +## Tag ### Properties -* **DefaultResourceSpec**: [ResourceSpec](#resourcespec) +* **Key**: string (Required): The tag key. Tag keys must be unique per resource. +* **Value**: string (Required): The tag value. -## ResourceSpec +## Tag ### Properties -* **InstanceType**: string: The instance type that the image version runs on. -* **SageMakerImageArn**: string: The ARN of the SageMaker image that the image version belongs to. -* **SageMakerImageVersionArn**: string: The ARN of the image version created on the instance. +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -## KernelGatewayAppSettings +## Tag ### Properties -* **CustomImages**: [CustomImage](#customimage)[]: A list of custom SageMaker images that are configured to run as a KernelGateway app. -* **DefaultResourceSpec**: [ResourceSpec](#resourcespec): The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app. +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -## CustomImage +## Tag ### Properties -* **AppImageConfigName**: string (Required): The Name of the AppImageConfig. -* **ImageName**: string (Required): The name of the CustomImage. Must be unique to your account. -* **ImageVersionNumber**: int: The version number of the CustomImage. +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ## Tag ### Properties * **Key**: string (Required) * **Value**: string (Required) -## AWS.SageMaker/UserProfileProperties +## Tag ### Properties -* **DomainId**: string (Required, Identifier): The ID of the associated Domain. -* **SingleSignOnUserIdentifier**: string: A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only supported value is "UserName". If the Domain's AuthMode is SSO, this field is required. If the Domain's AuthMode is not SSO, this field cannot be specified. -* **SingleSignOnUserValue**: string: The username of the associated AWS Single Sign-On User for this UserProfile. If the Domain's AuthMode is SSO, this field is required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not SSO, this field cannot be specified. -* **Tags**: [Tag](#tag)[] (WriteOnly): A list of tags to apply to the user profile. -* **UserProfileArn**: string (ReadOnly): The user profile Amazon Resource Name (ARN). -* **UserProfileName**: string (Required, Identifier): A name for the UserProfile. -* **UserSettings**: [UserSettings](#usersettings): A collection of settings. +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ## Tag ### Properties * **Key**: string (Required) * **Value**: string (Required) -## UserSettings +## Tag ### Properties -* **CodeEditorAppSettings**: [CodeEditorAppSettings](#codeeditorappsettings) -* **CustomFileSystemConfigs**: [CustomFileSystemConfig](#customfilesystemconfig)[] -* **CustomPosixUserConfig**: [CustomPosixUserConfig](#customposixuserconfig) -* **DefaultLandingUri**: string: Defines which Amazon SageMaker application users are directed to by default. -* **ExecutionRole**: string: The user profile Amazon Resource Name (ARN). -* **JupyterLabAppSettings**: [JupyterLabAppSettings](#jupyterlabappsettings) -* **JupyterServerAppSettings**: [JupyterServerAppSettings](#jupyterserverappsettings): The Jupyter server's app settings. -* **KernelGatewayAppSettings**: [KernelGatewayAppSettings](#kernelgatewayappsettings): The kernel gateway app settings. -* **RStudioServerProAppSettings**: [RStudioServerProAppSettings](#rstudioserverproappsettings) -* **SecurityGroups**: string[]: The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication. -* **SharingSettings**: [SharingSettings](#sharingsettings): The sharing settings. -* **SpaceStorageSettings**: [DefaultSpaceStorageSettings](#defaultspacestoragesettings) -* **StudioWebPortal**: string: Indicates whether the Studio experience is available to users. If not, users cannot access Studio. +* **Key**: string (Required) +* **Value**: string (Required) -## CodeEditorAppSettings +## ThroughputConfig ### Properties -* **DefaultResourceSpec**: [ResourceSpec](#resourcespec): The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the CodeEditor app. -* **LifecycleConfigArns**: string[]: A list of LifecycleConfigArns available for use with CodeEditor apps. +* **ProvisionedReadCapacityUnits**: int: For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling. +* **ProvisionedWriteCapacityUnits**: int: For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling. +* **ThroughputMode**: string (Required) -## ResourceSpec +## TrainingDetails ### Properties -* **InstanceType**: string: The instance type that the image version runs on. -* **SageMakerImageArn**: string: The ARN of the SageMaker image that the image version belongs to. -* **SageMakerImageVersionArn**: string: The ARN of the image version created on the instance. +* **ObjectiveFunction**: [ObjectiveFunction](#objectivefunction) +* **TrainingJobDetails**: [ModelCard_TrainingJobDetails](#modelcardtrainingjobdetails) +* **TrainingObservations**: string -## CustomFileSystemConfig +## TrainingHyperParameter ### Properties -* **EFSFileSystemConfig**: [EFSFileSystemConfig](#efsfilesystemconfig) +* **Name**: string (Required) +* **Value**: string (Required) -## EFSFileSystemConfig +## TrainingMetric ### Properties -* **FileSystemId**: string (Required) -* **FileSystemPath**: string +* **Name**: string (Required) +* **Notes**: string +* **Value**: int (Required) -## CustomPosixUserConfig +## TransformInput ### Properties -* **Gid**: int (Required) -* **Uid**: int (Required) +* **CompressionType**: string: If your transform data is compressed, specify the compression type. Amazon SageMaker automatically decompresses the data for the transform job accordingly. The default value is None. +* **ContentType**: string: The multipurpose internet mail extension (MIME) type of the data. Amazon SageMaker uses the MIME type with each http call to transfer data to the transform job. +* **DataSource**: [DataSource](#datasource) (Required) +* **SplitType**: string: The method to use to split the transform job's data files into smaller batches. -## JupyterLabAppSettings +## TransformJobDefinition ### Properties -* **CodeRepositories**: [CodeRepository](#coderepository)[]: A list of CodeRepositories available for use with JupyterLab apps. -* **CustomImages**: [CustomImage](#customimage)[]: A list of custom images available for use for JupyterLab apps -* **DefaultResourceSpec**: [ResourceSpec](#resourcespec): The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterLab app. -* **LifecycleConfigArns**: string[]: A list of LifecycleConfigArns available for use with JupyterLab apps. +* **BatchStrategy**: string: A string that determines the number of records included in a single mini-batch. +* **Environment**: [Environment](#environment) +* **MaxConcurrentTransforms**: int: The maximum number of parallel requests that can be sent to each instance in a transform job. The default value is 1. +* **MaxPayloadInMB**: int: The maximum payload size allowed, in MB. A payload is the data portion of a record (without metadata). +* **TransformInput**: [TransformInput](#transforminput) (Required) +* **TransformOutput**: [TransformOutput](#transformoutput) (Required) +* **TransformResources**: [TransformResources](#transformresources) (Required) -## CodeRepository +## TransformOutput ### Properties -* **RepositoryUrl**: string (Required): A CodeRepository (valid URL) to be used within Jupyter's Git extension. +* **Accept**: string: The MIME type used to specify the output data. Amazon SageMaker uses the MIME type with each http call to transfer data from the transform job. +* **AssembleWith**: string: Defines how to assemble the results of the transform job as a single S3 object. +* **KmsKeyId**: string: The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. +* **S3OutputPath**: string (Required): The Amazon S3 path where you want Amazon SageMaker to store the results of the transform job. -## CustomImage +## TransformResources ### Properties -* **AppImageConfigName**: string (Required): The Name of the AppImageConfig. -* **ImageName**: string (Required): The name of the CustomImage. Must be unique to your account. -* **ImageVersionNumber**: int: The version number of the CustomImage. +* **InstanceCount**: int (Required): The number of ML compute instances to use in the transform job. For distributed transform jobs, specify a value greater than 1. The default value is 1. +* **InstanceType**: string (Required): The ML compute instance type for the transform job. +* **VolumeKmsKeyId**: string: The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt model data on the storage volume attached to the ML compute instance(s) that run the batch transform job. -## JupyterServerAppSettings +## TtlDuration ### Properties -* **DefaultResourceSpec**: [ResourceSpec](#resourcespec) +* **Unit**: string +* **Value**: int -## KernelGatewayAppSettings +## UserContext ### Properties -* **CustomImages**: [CustomImage](#customimage)[]: A list of custom SageMaker images that are configured to run as a KernelGateway app. -* **DefaultResourceSpec**: [ResourceSpec](#resourcespec): The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app. +* **DomainId**: string (ReadOnly): The domain associated with the user. +* **UserProfileArn**: string (ReadOnly): The Amazon Resource Name (ARN) of the user's profile. +* **UserProfileName**: string (ReadOnly): The name of the user's profile. -## RStudioServerProAppSettings +## UserSettings ### Properties -* **AccessStatus**: string: Indicates whether the current user has access to the RStudioServerPro app. -* **UserGroup**: string: The level of permissions that the user has within the RStudioServerPro app. This value defaults to User. The Admin value allows the user access to the RStudio Administrative Dashboard. +* **CodeEditorAppSettings**: [CodeEditorAppSettings](#codeeditorappsettings) +* **CustomFileSystemConfigs**: [CustomFileSystemConfig](#customfilesystemconfig)[] +* **CustomPosixUserConfig**: [CustomPosixUserConfig](#customposixuserconfig) +* **DefaultLandingUri**: string: Defines which Amazon SageMaker application users are directed to by default. +* **ExecutionRole**: string (Required): The execution role for the user. +* **JupyterLabAppSettings**: [JupyterLabAppSettings](#jupyterlabappsettings) +* **JupyterServerAppSettings**: [JupyterServerAppSettings](#jupyterserverappsettings): The Jupyter server's app settings. +* **KernelGatewayAppSettings**: [KernelGatewayAppSettings](#kernelgatewayappsettings): The kernel gateway app settings. +* **RSessionAppSettings**: [RSessionAppSettings](#rsessionappsettings) +* **RStudioServerProAppSettings**: [RStudioServerProAppSettings](#rstudioserverproappsettings) +* **SecurityGroups**: string[]: The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication. +* **SharingSettings**: [SharingSettings](#sharingsettings): The sharing settings. +* **SpaceStorageSettings**: [DefaultSpaceStorageSettings](#defaultspacestoragesettings) +* **StudioWebPortal**: string: Indicates whether the Studio experience is available to users. If not, users cannot access Studio. -## SharingSettings +## UserSettings ### Properties -* **NotebookOutputOption**: string: Whether to include the notebook cell output when sharing the notebook. The default is Disabled. -* **S3KmsKeyId**: string: When NotebookOutputOption is Allowed, the AWS Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket. -* **S3OutputPath**: string: When NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots. +* **CodeEditorAppSettings**: [CodeEditorAppSettings](#codeeditorappsettings) +* **CustomFileSystemConfigs**: [CustomFileSystemConfig](#customfilesystemconfig)[] +* **CustomPosixUserConfig**: [CustomPosixUserConfig](#customposixuserconfig) +* **DefaultLandingUri**: string: Defines which Amazon SageMaker application users are directed to by default. +* **ExecutionRole**: string: The user profile Amazon Resource Name (ARN). +* **JupyterLabAppSettings**: [JupyterLabAppSettings](#jupyterlabappsettings) +* **JupyterServerAppSettings**: [JupyterServerAppSettings](#jupyterserverappsettings): The Jupyter server's app settings. +* **KernelGatewayAppSettings**: [KernelGatewayAppSettings](#kernelgatewayappsettings): The kernel gateway app settings. +* **RStudioServerProAppSettings**: [RStudioServerProAppSettings](#rstudioserverproappsettings) +* **SecurityGroups**: string[]: The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication. +* **SharingSettings**: [SharingSettings](#sharingsettings): The sharing settings. +* **SpaceStorageSettings**: [DefaultSpaceStorageSettings](#defaultspacestoragesettings) +* **StudioWebPortal**: string: Indicates whether the Studio experience is available to users. If not, users cannot access Studio. -## DefaultSpaceStorageSettings +## ValidationProfile ### Properties -* **DefaultEbsStorageSettings**: [DefaultEbsStorageSettings](#defaultebsstoragesettings) +* **ProfileName**: string (Required): The name of the profile for the model package. +* **TransformJobDefinition**: [TransformJobDefinition](#transformjobdefinition) (Required) -## DefaultEbsStorageSettings +## ValidationSpecification ### Properties -* **DefaultEbsVolumeSizeInGb**: int (Required): Default size of the Amazon EBS volume in Gb -* **MaximumEbsVolumeSizeInGb**: int (Required): Maximum size of the Amazon EBS volume in Gb. Must be greater than or equal to the DefaultEbsVolumeSizeInGb. +* **ValidationProfiles**: [ValidationProfile](#validationprofile)[] (Required) +* **ValidationRole**: string (Required): The IAM roles to be used for the validation of the model package. + +## VpcConfig +### Properties +* **SecurityGroupIds**: string[] (Required): The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field. +* **Subnets**: string[] (Required): The ID of the subnets in the VPC to which you want to connect to your monitoring jobs. diff --git a/artifacts/bicep/aws/aws.scheduler/default/types.json b/artifacts/bicep/aws/aws.scheduler/default/types.json index 430f38a0..5fb7bba2 100644 --- a/artifacts/bicep/aws/aws.scheduler/default/types.json +++ b/artifacts/bicep/aws/aws.scheduler/default/types.json @@ -1 +1,740 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"AssignPublicIp"}},{"2":{"Name":"AwsVpcConfiguration","Properties":{"AssignPublicIp":{"Type":4,"Flags":0},"SecurityGroups":{"Type":31,"Flags":0,"Description":"Specifies the security groups associated with the task. These security groups must all be in the same VPC. You can specify as many as five security groups. If you do not specify a security group, the default security group for the VPC is used."},"Subnets":{"Type":32,"Flags":1,"Description":"Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets."}}}},{"2":{"Name":"CapacityProviderStrategyItem","Properties":{"Base":{"Type":3,"Flags":0,"Description":"The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used."},"CapacityProvider":{"Type":4,"Flags":1,"Description":"The short name of the capacity provider."},"Weight":{"Type":3,"Flags":0,"Description":"The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied."}}}},{"2":{"Name":"DeadLetterConfig","Properties":{"Arn":{"Type":4,"Flags":0,"Description":"The ARN of the SQS queue specified as the target for the dead-letter queue."}}}},{"2":{"Name":"EcsParameters","Properties":{"CapacityProviderStrategy":{"Type":33,"Flags":0,"Description":"The capacity provider strategy to use for the task."},"EnableECSManagedTags":{"Type":2,"Flags":0,"Description":"Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide."},"EnableExecuteCommand":{"Type":2,"Flags":0,"Description":"Whether or not to enable the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task."},"Group":{"Type":4,"Flags":0,"Description":"Specifies an ECS task group for the task. The maximum length is 255 characters."},"LaunchType":{"Type":4,"Flags":0},"NetworkConfiguration":{"Type":18,"Flags":0},"PlacementConstraints":{"Type":34,"Flags":0,"Description":"An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime)."},"PlacementStrategy":{"Type":35,"Flags":0,"Description":"The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task."},"PlatformVersion":{"Type":4,"Flags":0,"Description":"Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as 1.1.0."},"PropagateTags":{"Type":4,"Flags":0},"ReferenceId":{"Type":4,"Flags":0,"Description":"The reference ID to use for the task."},"Tags":{"Type":36,"Flags":0,"Description":"The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. To learn more, see RunTask in the Amazon ECS API Reference."},"TaskCount":{"Type":3,"Flags":0,"Description":"The number of tasks to create based on TaskDefinition. The default is 1."},"TaskDefinitionArn":{"Type":4,"Flags":1,"Description":"The ARN of the task definition to use if the event target is an Amazon ECS task."}}}},{"2":{"Name":"EventBridgeParameters","Properties":{"DetailType":{"Type":4,"Flags":1,"Description":"Free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail."},"Source":{"Type":4,"Flags":1,"Description":"The source of the event."}}}},{"2":{"Name":"FlexibleTimeWindow","Properties":{"MaximumWindowInMinutes":{"Type":3,"Flags":0,"Description":"The maximum time window during which a schedule can be invoked."},"Mode":{"Type":4,"Flags":1}}}},{"2":{"Name":"FlexibleTimeWindowMode"}},{"2":{"Name":"KinesisParameters","Properties":{"PartitionKey":{"Type":4,"Flags":1,"Description":"The custom parameter used as the Kinesis partition key. For more information, see Amazon Kinesis Streams Key Concepts in the Amazon Kinesis Streams Developer Guide."}}}},{"2":{"Name":"LaunchType"}},{"2":{"Name":"NetworkConfiguration","Properties":{"AwsvpcConfiguration":{"Type":9,"Flags":0}}}},{"2":{"Name":"PlacementConstraint","Properties":{"Expression":{"Type":4,"Flags":0,"Description":"A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is distinctInstance. To learn more, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide."},"Type":{"Type":4,"Flags":0}}}},{"2":{"Name":"PlacementConstraintType"}},{"2":{"Name":"PlacementStrategy","Properties":{"Field":{"Type":4,"Flags":0,"Description":"The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this field is not used."},"Type":{"Type":4,"Flags":0}}}},{"2":{"Name":"PlacementStrategyType"}},{"2":{"Name":"PropagateTags"}},{"2":{"Name":"RetryPolicy","Properties":{"MaximumEventAgeInSeconds":{"Type":3,"Flags":0,"Description":"The maximum amount of time, in seconds, to continue to make retry attempts."},"MaximumRetryAttempts":{"Type":3,"Flags":0,"Description":"The 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 until the duration of the MaximumEventAgeInSeconds is reached."}}}},{"2":{"Name":"SageMakerPipelineParameter","Properties":{"Name":{"Type":4,"Flags":17,"Description":"Name of parameter to start execution of a SageMaker Model Building Pipeline."},"Value":{"Type":4,"Flags":1,"Description":"Value of parameter to start execution of a SageMaker Model Building Pipeline."}}}},{"2":{"Name":"SageMakerPipelineParameters","Properties":{"PipelineParameterList":{"Type":37,"Flags":0,"Description":"List of Parameter names and values for SageMaker Model Building Pipeline execution."}}}},{"2":{"Name":"ScheduleState"}},{"2":{"Name":"SqsParameters","Properties":{"MessageGroupId":{"Type":4,"Flags":0,"Description":"The FIFO message group ID to use as the target."}}}},{"2":{"Name":"TagMap","Properties":{}}},{"2":{"Name":"Target","Properties":{"Arn":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) of the target."},"DeadLetterConfig":{"Type":11,"Flags":0},"EcsParameters":{"Type":12,"Flags":0},"EventBridgeParameters":{"Type":13,"Flags":0},"Input":{"Type":4,"Flags":0,"Description":"The text, or well-formed JSON, passed to the target. If you are configuring a templated Lambda, AWS Step Functions, or Amazon EventBridge target, the 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, EventBridge Scheduler delivers a default notification to the target."},"KinesisParameters":{"Type":16,"Flags":0},"RetryPolicy":{"Type":24,"Flags":0},"RoleArn":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) of the IAM role to be used for this target when the schedule is triggered."},"SageMakerPipelineParameters":{"Type":26,"Flags":0},"SqsParameters":{"Type":28,"Flags":0}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":10}},{"3":{"ItemType":19}},{"3":{"ItemType":21}},{"3":{"ItemType":29}},{"3":{"ItemType":25}},{"2":{"Name":"AWS.Scheduler/ScheduleProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) of the schedule."},"Description":{"Type":4,"Flags":0,"Description":"The description of the schedule."},"EndDate":{"Type":4,"Flags":0,"Description":"The date, in UTC, before which the schedule can invoke its target. Depending on the schedule's recurrence expression, invocations might stop on, or before, the EndDate you specify."},"FlexibleTimeWindow":{"Type":14,"Flags":1},"GroupName":{"Type":4,"Flags":0,"Description":"The name of the schedule group to associate with this schedule. If you omit this, the default schedule group is used."},"KmsKeyArn":{"Type":4,"Flags":0,"Description":"The ARN for a KMS Key that will be used to encrypt customer data."},"Name":{"Type":4,"Flags":16},"ScheduleExpression":{"Type":4,"Flags":1,"Description":"The scheduling expression."},"ScheduleExpressionTimezone":{"Type":4,"Flags":0,"Description":"The timezone in which the scheduling expression is evaluated."},"StartDate":{"Type":4,"Flags":0,"Description":"The date, in UTC, after which the schedule can begin invoking its target. Depending on the schedule's recurrence expression, invocations might occur on, or after, the StartDate you specify."},"State":{"Type":4,"Flags":0},"Target":{"Type":30,"Flags":1}}}},{"2":{"Name":"AWS.Scheduler/Schedule","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":38,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Scheduler/Schedule@default","ScopeType":0,"Body":39}},{"2":{"Name":"ScheduleGroupState"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"Key for the tag"},"Value":{"Type":4,"Flags":1,"Description":"Value for the tag"}}}},{"2":{"Name":"AWS.Scheduler/ScheduleGroupProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) of the schedule group."},"CreationDate":{"Type":4,"Flags":2,"Description":"The time at which the schedule group was created."},"LastModificationDate":{"Type":4,"Flags":2,"Description":"The time at which the schedule group was last modified."},"Name":{"Type":4,"Flags":16},"State":{"Type":4,"Flags":2},"Tags":{"Type":44,"Flags":0,"Description":"The list of tags to associate with the schedule group."}}}},{"3":{"ItemType":42}},{"2":{"Name":"AWS.Scheduler/ScheduleGroup","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":43,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Scheduler/ScheduleGroup@default","ScopeType":0,"Body":45}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "AssignPublicIp", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AwsVpcConfiguration", + "properties": { + "AssignPublicIp": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "SecurityGroups": { + "type": { + "$ref": "#/24" + }, + "flags": 0, + "description": "Specifies the security groups associated with the task. These security groups must all be in the same VPC. You can specify as many as five security groups. If you do not specify a security group, the default security group for the VPC is used." + }, + "Subnets": { + "type": { + "$ref": "#/25" + }, + "flags": 1, + "description": "Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets." + } + } + }, + { + "$type": "ObjectType", + "name": "CapacityProviderStrategyItem", + "properties": { + "Base": { + "type": { + "$ref": "#/26" + }, + "flags": 0, + "description": "The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used." + }, + "CapacityProvider": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "The short name of the capacity provider." + }, + "Weight": { + "type": { + "$ref": "#/26" + }, + "flags": 0, + "description": "The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied." + } + } + }, + { + "$type": "ObjectType", + "name": "DeadLetterConfig", + "properties": { + "Arn": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "The ARN of the SQS queue specified as the target for the dead-letter queue." + } + } + }, + { + "$type": "ObjectType", + "name": "EcsParameters", + "properties": { + "CapacityProviderStrategy": { + "type": { + "$ref": "#/27" + }, + "flags": 0, + "description": "The capacity provider strategy to use for the task." + }, + "EnableECSManagedTags": { + "type": { + "$ref": "#/28" + }, + "flags": 0, + "description": "Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide." + }, + "EnableExecuteCommand": { + "type": { + "$ref": "#/28" + }, + "flags": 0, + "description": "Whether or not to enable the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task." + }, + "Group": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "Specifies an ECS task group for the task. The maximum length is 255 characters." + }, + "LaunchType": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "NetworkConfiguration": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "PlacementConstraints": { + "type": { + "$ref": "#/29" + }, + "flags": 0, + "description": "An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime)." + }, + "PlacementStrategy": { + "type": { + "$ref": "#/30" + }, + "flags": 0, + "description": "The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task." + }, + "PlatformVersion": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as 1.1.0." + }, + "PropagateTags": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "ReferenceId": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "The reference ID to use for the task." + }, + "Tags": { + "type": { + "$ref": "#/31" + }, + "flags": 0, + "description": "The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. To learn more, see RunTask in the Amazon ECS API Reference." + }, + "TaskCount": { + "type": { + "$ref": "#/26" + }, + "flags": 0, + "description": "The number of tasks to create based on TaskDefinition. The default is 1." + }, + "TaskDefinitionArn": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "The ARN of the task definition to use if the event target is an Amazon ECS task." + } + } + }, + { + "$type": "ObjectType", + "name": "EventBridgeParameters", + "properties": { + "DetailType": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "Free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail." + }, + "Source": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "The source of the event." + } + } + }, + { + "$type": "ObjectType", + "name": "FlexibleTimeWindow", + "properties": { + "MaximumWindowInMinutes": { + "type": { + "$ref": "#/26" + }, + "flags": 0, + "description": "The maximum time window during which a schedule can be invoked." + }, + "Mode": { + "type": { + "$ref": "#/23" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "FlexibleTimeWindowMode", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "KinesisParameters", + "properties": { + "PartitionKey": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "The custom parameter used as the Kinesis partition key. For more information, see Amazon Kinesis Streams Key Concepts in the Amazon Kinesis Streams Developer Guide." + } + } + }, + { + "$type": "ObjectType", + "name": "LaunchType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "NetworkConfiguration", + "properties": { + "AwsvpcConfiguration": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PlacementConstraint", + "properties": { + "Expression": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is distinctInstance. To learn more, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide." + }, + "Type": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PlacementConstraintType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PlacementStrategy", + "properties": { + "Field": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this field is not used." + }, + "Type": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PlacementStrategyType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PropagateTags", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RetryPolicy", + "properties": { + "MaximumEventAgeInSeconds": { + "type": { + "$ref": "#/26" + }, + "flags": 0, + "description": "The maximum amount of time, in seconds, to continue to make retry attempts." + }, + "MaximumRetryAttempts": { + "type": { + "$ref": "#/26" + }, + "flags": 0, + "description": "The 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 until the duration of the MaximumEventAgeInSeconds is reached." + } + } + }, + { + "$type": "ObjectType", + "name": "SageMakerPipelineParameter", + "properties": { + "Name": { + "type": { + "$ref": "#/23" + }, + "flags": 17, + "description": "Name of parameter to start execution of a SageMaker Model Building Pipeline." + }, + "Value": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "Value of parameter to start execution of a SageMaker Model Building Pipeline." + } + } + }, + { + "$type": "ObjectType", + "name": "SageMakerPipelineParameters", + "properties": { + "PipelineParameterList": { + "type": { + "$ref": "#/32" + }, + "flags": 0, + "description": "List of Parameter names and values for SageMaker Model Building Pipeline execution." + } + } + }, + { + "$type": "ObjectType", + "name": "ScheduleState", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SqsParameters", + "properties": { + "MessageGroupId": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "The FIFO message group ID to use as the target." + } + } + }, + { + "$type": "ObjectType", + "name": "TagMap", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Target", + "properties": { + "Arn": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of the target." + }, + "DeadLetterConfig": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "EcsParameters": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "EventBridgeParameters": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Input": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "The text, or well-formed JSON, passed to the target. If you are configuring a templated Lambda, AWS Step Functions, or Amazon EventBridge target, the 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, EventBridge Scheduler delivers a default notification to the target." + }, + "KinesisParameters": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "RetryPolicy": { + "type": { + "$ref": "#/16" + }, + "flags": 0 + }, + "RoleArn": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of the IAM role to be used for this target when the schedule is triggered." + }, + "SageMakerPipelineParameters": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "SqsParameters": { + "type": { + "$ref": "#/20" + }, + "flags": 0 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/23" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/23" + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/11" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/21" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/17" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Scheduler/ScheduleProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.Scheduler/ScheduleProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/23" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) of the schedule." + }, + "Description": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "The description of the schedule." + }, + "EndDate": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "The date, in UTC, before which the schedule can invoke its target. Depending on the schedule's recurrence expression, invocations might stop on, or before, the EndDate you specify." + }, + "FlexibleTimeWindow": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + }, + "GroupName": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "The name of the schedule group to associate with this schedule. If you omit this, the default schedule group is used." + }, + "KmsKeyArn": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "The ARN for a KMS Key that will be used to encrypt customer data." + }, + "Name": { + "type": { + "$ref": "#/23" + }, + "flags": 16 + }, + "ScheduleExpression": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "The scheduling expression." + }, + "ScheduleExpressionTimezone": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "The timezone in which the scheduling expression is evaluated." + }, + "StartDate": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "The date, in UTC, after which the schedule can begin invoking its target. Depending on the schedule's recurrence expression, invocations might occur on, or after, the StartDate you specify." + }, + "State": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + }, + "Target": { + "type": { + "$ref": "#/22" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Scheduler/Schedule", + "properties": { + "name": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/23" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/34" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Scheduler/Schedule@default", + "scopeType": 0, + "body": { + "$ref": "#/35" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "ScheduleGroupState", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "Key for the tag" + }, + "Value": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "Value for the tag" + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Scheduler/ScheduleGroupProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/38" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Scheduler/ScheduleGroupProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/23" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) of the schedule group." + }, + "CreationDate": { + "type": { + "$ref": "#/23" + }, + "flags": 2, + "description": "The time at which the schedule group was created." + }, + "LastModificationDate": { + "type": { + "$ref": "#/23" + }, + "flags": 2, + "description": "The time at which the schedule group was last modified." + }, + "Name": { + "type": { + "$ref": "#/23" + }, + "flags": 16 + }, + "State": { + "type": { + "$ref": "#/23" + }, + "flags": 2 + }, + "Tags": { + "type": { + "$ref": "#/40" + }, + "flags": 0, + "description": "The list of tags to associate with the schedule group." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Scheduler/ScheduleGroup", + "properties": { + "name": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/23" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/41" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Scheduler/ScheduleGroup@default", + "scopeType": 0, + "body": { + "$ref": "#/42" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.scheduler/default/types.md b/artifacts/bicep/aws/aws.scheduler/default/types.md index 1b44bc1a..bae6ac13 100644 --- a/artifacts/bicep/aws/aws.scheduler/default/types.md +++ b/artifacts/bicep/aws/aws.scheduler/default/types.md @@ -3,16 +3,25 @@ ## Resource AWS.Scheduler/Schedule@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Scheduler/ScheduleProperties](#awsschedulerscheduleproperties) (Required): properties of the resource +* **properties**: [AWS.Scheduler/ScheduleProperties](#awsschedulerscheduleproperties) (Required, Identifier): properties of the resource ## Resource AWS.Scheduler/ScheduleGroup@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Scheduler/ScheduleGroupProperties](#awsschedulerschedulegroupproperties): properties of the resource +* **properties**: [AWS.Scheduler/ScheduleGroupProperties](#awsschedulerschedulegroupproperties) (Identifier): properties of the resource + +## AWS.Scheduler/ScheduleGroupProperties +### Properties +* **Arn**: string (ReadOnly): The Amazon Resource Name (ARN) of the schedule group. +* **CreationDate**: string (ReadOnly): The time at which the schedule group was created. +* **LastModificationDate**: string (ReadOnly): The time at which the schedule group was last modified. +* **Name**: string (Identifier) +* **State**: string (ReadOnly) +* **Tags**: [Tag](#tag)[]: The list of tags to associate with the schedule group. ## AWS.Scheduler/ScheduleProperties ### Properties @@ -29,23 +38,17 @@ * **State**: string * **Target**: [Target](#target) (Required) -## FlexibleTimeWindow +## AwsVpcConfiguration ### Properties -* **MaximumWindowInMinutes**: int: The maximum time window during which a schedule can be invoked. -* **Mode**: string (Required) +* **AssignPublicIp**: string +* **SecurityGroups**: string[]: Specifies the security groups associated with the task. These security groups must all be in the same VPC. You can specify as many as five security groups. If you do not specify a security group, the default security group for the VPC is used. +* **Subnets**: string[] (Required): Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets. -## Target +## CapacityProviderStrategyItem ### Properties -* **Arn**: string (Required): The Amazon Resource Name (ARN) of the target. -* **DeadLetterConfig**: [DeadLetterConfig](#deadletterconfig) -* **EcsParameters**: [EcsParameters](#ecsparameters) -* **EventBridgeParameters**: [EventBridgeParameters](#eventbridgeparameters) -* **Input**: string: The text, or well-formed JSON, passed to the target. If you are configuring a templated Lambda, AWS Step Functions, or Amazon EventBridge target, the 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, EventBridge Scheduler delivers a default notification to the target. -* **KinesisParameters**: [KinesisParameters](#kinesisparameters) -* **RetryPolicy**: [RetryPolicy](#retrypolicy) -* **RoleArn**: string (Required): The Amazon Resource Name (ARN) of the IAM role to be used for this target when the schedule is triggered. -* **SageMakerPipelineParameters**: [SageMakerPipelineParameters](#sagemakerpipelineparameters) -* **SqsParameters**: [SqsParameters](#sqsparameters) +* **Base**: int: The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used. +* **CapacityProvider**: string (Required): The short name of the capacity provider. +* **Weight**: int: The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied. ## DeadLetterConfig ### Properties @@ -68,21 +71,23 @@ * **TaskCount**: int: The number of tasks to create based on TaskDefinition. The default is 1. * **TaskDefinitionArn**: string (Required): The ARN of the task definition to use if the event target is an Amazon ECS task. -## CapacityProviderStrategyItem +## EventBridgeParameters ### Properties -* **Base**: int: The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used. -* **CapacityProvider**: string (Required): The short name of the capacity provider. -* **Weight**: int: The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied. +* **DetailType**: string (Required): Free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail. +* **Source**: string (Required): The source of the event. -## NetworkConfiguration +## FlexibleTimeWindow ### Properties -* **AwsvpcConfiguration**: [AwsVpcConfiguration](#awsvpcconfiguration) +* **MaximumWindowInMinutes**: int: The maximum time window during which a schedule can be invoked. +* **Mode**: string (Required) -## AwsVpcConfiguration +## KinesisParameters ### Properties -* **AssignPublicIp**: string -* **SecurityGroups**: string[]: Specifies the security groups associated with the task. These security groups must all be in the same VPC. You can specify as many as five security groups. If you do not specify a security group, the default security group for the VPC is used. -* **Subnets**: string[] (Required): Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets. +* **PartitionKey**: string (Required): The custom parameter used as the Kinesis partition key. For more information, see Amazon Kinesis Streams Key Concepts in the Amazon Kinesis Streams Developer Guide. + +## NetworkConfiguration +### Properties +* **AwsvpcConfiguration**: [AwsVpcConfiguration](#awsvpcconfiguration) ## PlacementConstraint ### Properties @@ -94,47 +99,42 @@ * **Field**: string: The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this field is not used. * **Type**: string -## TagMap -### Properties - -## EventBridgeParameters -### Properties -* **DetailType**: string (Required): Free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail. -* **Source**: string (Required): The source of the event. - -## KinesisParameters -### Properties -* **PartitionKey**: string (Required): The custom parameter used as the Kinesis partition key. For more information, see Amazon Kinesis Streams Key Concepts in the Amazon Kinesis Streams Developer Guide. - ## RetryPolicy ### Properties * **MaximumEventAgeInSeconds**: int: The maximum amount of time, in seconds, to continue to make retry attempts. * **MaximumRetryAttempts**: int: The 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 until the duration of the MaximumEventAgeInSeconds is reached. -## SageMakerPipelineParameters -### Properties -* **PipelineParameterList**: [SageMakerPipelineParameter](#sagemakerpipelineparameter)[]: List of Parameter names and values for SageMaker Model Building Pipeline execution. - ## SageMakerPipelineParameter ### Properties * **Name**: string (Required, Identifier): Name of parameter to start execution of a SageMaker Model Building Pipeline. * **Value**: string (Required): Value of parameter to start execution of a SageMaker Model Building Pipeline. -## SqsParameters +## SageMakerPipelineParameters ### Properties -* **MessageGroupId**: string: The FIFO message group ID to use as the target. +* **PipelineParameterList**: [SageMakerPipelineParameter](#sagemakerpipelineparameter)[]: List of Parameter names and values for SageMaker Model Building Pipeline execution. -## AWS.Scheduler/ScheduleGroupProperties +## SqsParameters ### Properties -* **Arn**: string (ReadOnly): The Amazon Resource Name (ARN) of the schedule group. -* **CreationDate**: string (ReadOnly): The time at which the schedule group was created. -* **LastModificationDate**: string (ReadOnly): The time at which the schedule group was last modified. -* **Name**: string (Identifier) -* **State**: string (ReadOnly) -* **Tags**: [Tag](#tag)[]: The list of tags to associate with the schedule group. +* **MessageGroupId**: string: The FIFO message group ID to use as the target. ## Tag ### Properties * **Key**: string (Required): Key for the tag * **Value**: string (Required): Value for the tag +## TagMap +### Properties + +## Target +### Properties +* **Arn**: string (Required): The Amazon Resource Name (ARN) of the target. +* **DeadLetterConfig**: [DeadLetterConfig](#deadletterconfig) +* **EcsParameters**: [EcsParameters](#ecsparameters) +* **EventBridgeParameters**: [EventBridgeParameters](#eventbridgeparameters) +* **Input**: string: The text, or well-formed JSON, passed to the target. If you are configuring a templated Lambda, AWS Step Functions, or Amazon EventBridge target, the 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, EventBridge Scheduler delivers a default notification to the target. +* **KinesisParameters**: [KinesisParameters](#kinesisparameters) +* **RetryPolicy**: [RetryPolicy](#retrypolicy) +* **RoleArn**: string (Required): The Amazon Resource Name (ARN) of the IAM role to be used for this target when the schedule is triggered. +* **SageMakerPipelineParameters**: [SageMakerPipelineParameters](#sagemakerpipelineparameters) +* **SqsParameters**: [SqsParameters](#sqsparameters) + diff --git a/artifacts/bicep/aws/aws.secretsmanager/default/types.json b/artifacts/bicep/aws/aws.secretsmanager/default/types.json index 6441c15c..7866fd53 100644 --- a/artifacts/bicep/aws/aws.secretsmanager/default/types.json +++ b/artifacts/bicep/aws/aws.secretsmanager/default/types.json @@ -1 +1,241 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"GenerateSecretString","Properties":{"ExcludeCharacters":{"Type":4,"Flags":0,"Description":"A string that excludes characters in the generated password. By default, all characters from the included sets can be used. The string can be a minimum length of 0 characters and a maximum length of 7168 characters. "},"ExcludeLowercase":{"Type":2,"Flags":0,"Description":"Specifies the generated password should not include lowercase letters. By default, ecrets Manager disables this parameter, and the generated password can include lowercase False, and the generated password can include lowercase letters."},"ExcludeNumbers":{"Type":2,"Flags":0,"Description":"Specifies that the generated password should exclude digits. By default, Secrets Manager does not enable the parameter, False, and the generated password can include digits."},"ExcludePunctuation":{"Type":2,"Flags":0,"Description":"Specifies that the generated password should not include punctuation characters. The default if you do not include this switch parameter is that punctuation characters can be included. "},"ExcludeUppercase":{"Type":2,"Flags":0,"Description":"Specifies that the generated password should not include uppercase letters. The default behavior is False, and the generated password can include uppercase letters. "},"GenerateStringKey":{"Type":4,"Flags":0,"Description":"The JSON key name used to add the generated password to the JSON structure specified by the SecretStringTemplate parameter. If you specify this parameter, then you must also specify SecretStringTemplate. "},"IncludeSpace":{"Type":2,"Flags":0,"Description":"Specifies that the generated password can include the space character. By default, Secrets Manager disables this parameter, and the generated password doesn't include space"},"PasswordLength":{"Type":3,"Flags":0,"Description":"The desired length of the generated password. The default value if you do not include this parameter is 32 characters. "},"RequireEachIncludedType":{"Type":2,"Flags":0,"Description":"Specifies whether the generated password must include at least one of every allowed character type. By default, Secrets Manager enables this parameter, and the generated password includes at least one of every character type."},"SecretStringTemplate":{"Type":4,"Flags":0,"Description":"A properly structured JSON string that the generated password can be added to. If you specify this parameter, then you must also specify GenerateStringKey."}}}},{"2":{"Name":"ReplicaRegion","Properties":{"KmsKeyId":{"Type":4,"Flags":0,"Description":"The ARN, key ID, or alias of the KMS key to encrypt the secret. If you don't include this field, Secrets Manager uses aws/secretsmanager."},"Region":{"Type":4,"Flags":1,"Description":"(Optional) A string that represents a Region, for example \"us-east-1\"."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that's 1 to 256 characters in length."},"Value":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that's 1 to 128 Unicode characters in length and can't be prefixed with aws."}}}},{"2":{"Name":"AWS.SecretsManager/SecretProperties","Properties":{"Description":{"Type":4,"Flags":0,"Description":"(Optional) Specifies a user-provided description of the secret."},"GenerateSecretString":{"Type":8,"Flags":4,"Description":"(Optional) Specifies text data that you want to encrypt and store in this new version of the secret."},"Id":{"Type":4,"Flags":18,"Description":"secret Id, the Arn of the resource."},"KmsKeyId":{"Type":4,"Flags":0,"Description":"(Optional) Specifies the ARN, Key ID, or alias of the AWS KMS customer master key (CMK) used to encrypt the SecretString."},"Name":{"Type":4,"Flags":0,"Description":"The friendly name of the secret. You can use forward slashes in the name to represent a path hierarchy."},"ReplicaRegions":{"Type":12,"Flags":0,"Description":"(Optional) A list of ReplicaRegion objects. The ReplicaRegion type consists of a Region (required) and the KmsKeyId which can be an ARN, Key ID, or Alias."},"SecretString":{"Type":4,"Flags":4,"Description":"(Optional) Specifies text data that you want to encrypt and store in this new version of the secret."},"Tags":{"Type":13,"Flags":0,"Description":"The list of user-defined tags associated with the secret. Use tags to manage your AWS resources. For additional information about tags, see TagResource."}}}},{"3":{"ItemType":9}},{"3":{"ItemType":10}},{"2":{"Name":"AWS.SecretsManager/Secret","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":11,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.SecretsManager/Secret@default","ScopeType":0,"Body":14}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "GenerateSecretString", + "properties": { + "ExcludeCharacters": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "A string of the characters that you don't want in the password." + }, + "ExcludeLowercase": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters." + }, + "ExcludeNumbers": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers." + }, + "ExcludePunctuation": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Specifies whether to exclude the following punctuation characters from the password: ``! \" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \\ ] ^ _ ` { | } ~``. If you don't include this switch, the password can contain punctuation." + }, + "ExcludeUppercase": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters." + }, + "GenerateStringKey": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The JSON key name for the key/value pair, where the value is the generated password. This pair is added to the JSON structure specified by the ``SecretStringTemplate`` parameter. If you specify this parameter, then you must also specify ``SecretStringTemplate``." + }, + "IncludeSpace": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Specifies whether to include the space character. If you include this switch, the password can contain space characters." + }, + "PasswordLength": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The length of the password. If you don't include this parameter, the default length is 32 characters." + }, + "RequireEachIncludedType": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you don't include this switch, the password contains at least one of every character type." + }, + "SecretStringTemplate": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "A template that the generated string must match. When you make a change to this property, a new secret version is created." + } + } + }, + { + "$type": "ObjectType", + "name": "ReplicaRegion", + "properties": { + "KmsKeyId": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The ARN, key ID, or alias of the KMS key to encrypt the secret. If you don't include this field, Secrets Manager uses ``aws/secretsmanager``." + }, + "Region": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "A string that represents a ``Region``, for example \"us-east-1\"." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The key identifier, or name, of the tag." + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The string value associated with the key of the tag." + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "BooleanType" + }, + { + "$type": "IntegerType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.SecretsManager/SecretProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ObjectType", + "name": "AWS.SecretsManager/SecretProperties", + "properties": { + "Description": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The description of the secret." + }, + "GenerateSecretString": { + "type": { + "$ref": "#/0" + }, + "flags": 4, + "description": "A structure that specifies how to generate a password to encrypt and store in the secret. To include a specific string in the secret, use ``SecretString`` instead. If you omit both ``GenerateSecretString`` and ``SecretString``, you create an empty secret. When you make a change to this property, a new secret version is created.\n We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support." + }, + "Id": { + "type": { + "$ref": "#/3" + }, + "flags": 18, + "description": "" + }, + "KmsKeyId": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt the secret value in the secret. An alias is always prefixed by ``alias/``, for example ``alias/aws/secretsmanager``. For more information, see [About aliases](https://docs.aws.amazon.com/kms/latest/developerguide/alias-about.html).\n To use a KMS key in a different account, use the key ARN or the alias ARN.\n If you don't specify this value, then Secrets Manager uses the key ``aws/secretsmanager``. If that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value.\n If the secret is in a different AWS account from the credentials calling the API, then you can't use ``aws/secretsmanager`` to encrypt the secret, and you must create and use a customer managed KMS key." + }, + "Name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The name of the new secret.\n The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@-\n Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN." + }, + "ReplicaRegions": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "A custom type that specifies a ``Region`` and the ``KmsKeyId`` for a replica secret." + }, + "SecretString": { + "type": { + "$ref": "#/3" + }, + "flags": 4, + "description": "The text to encrypt and store in the secret. We recommend you use a JSON structure of key/value pairs for your secret value. To generate a random password, use ``GenerateSecretString`` instead. If you omit both ``GenerateSecretString`` and ``SecretString``, you create an empty secret. When you make a change to this property, a new secret version is created." + }, + "Tags": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "A list of tags to attach to the secret. Each tag is a key and value pair of strings in a JSON text string, for example:\n ``[{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]`` \n Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag from one with key \"abc\".\n Stack-level tags, tags you apply to the CloudFormation stack, are also attached to the secret. \n If you check tags in permissions policies as part of your security strategy, then adding or removing a tag can change permissions. If the completion of this operation would result in you losing your permissions for this secret, then Secrets Manager blocks the operation and returns an ``Access Denied`` error. For more information, see [Control access to secrets using tags](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#tag-secrets-abac) and [Limit access to identities with tags that match secrets' tags](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#auth-and-access_tags2).\n For information about how to format a JSON parameter for the various command line tool environments, see [Using JSON for Parameters](https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json). If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.\n The following restrictions apply to tags:\n + Maximum number of tags per secret: 50\n + Maximum key length: 127 Unicode characters in UTF-8\n + Maximum value length: 255 Unicode characters in UTF-8\n + Tag keys and values are case sensitive.\n + Do not use the ``aws:`` prefix in your tag names or values because AWS reserves it for AWS use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.\n + If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SecretsManager/Secret", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/9" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SecretsManager/Secret@default", + "scopeType": 0, + "body": { + "$ref": "#/10" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.secretsmanager/default/types.md b/artifacts/bicep/aws/aws.secretsmanager/default/types.md index 7b9f3a44..0f7bf993 100644 --- a/artifacts/bicep/aws/aws.secretsmanager/default/types.md +++ b/artifacts/bicep/aws/aws.secretsmanager/default/types.md @@ -3,41 +3,59 @@ ## Resource AWS.SecretsManager/Secret@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.SecretsManager/SecretProperties](#awssecretsmanagersecretproperties): properties of the resource +* **properties**: [AWS.SecretsManager/SecretProperties](#awssecretsmanagersecretproperties) (Identifier): properties of the resource ## AWS.SecretsManager/SecretProperties ### Properties -* **Description**: string: (Optional) Specifies a user-provided description of the secret. -* **GenerateSecretString**: [GenerateSecretString](#generatesecretstring) (WriteOnly): (Optional) Specifies text data that you want to encrypt and store in this new version of the secret. -* **Id**: string (ReadOnly, Identifier): secret Id, the Arn of the resource. -* **KmsKeyId**: string: (Optional) Specifies the ARN, Key ID, or alias of the AWS KMS customer master key (CMK) used to encrypt the SecretString. -* **Name**: string: The friendly name of the secret. You can use forward slashes in the name to represent a path hierarchy. -* **ReplicaRegions**: [ReplicaRegion](#replicaregion)[]: (Optional) A list of ReplicaRegion objects. The ReplicaRegion type consists of a Region (required) and the KmsKeyId which can be an ARN, Key ID, or Alias. -* **SecretString**: string (WriteOnly): (Optional) Specifies text data that you want to encrypt and store in this new version of the secret. -* **Tags**: [Tag](#tag)[]: The list of user-defined tags associated with the secret. Use tags to manage your AWS resources. For additional information about tags, see TagResource. +* **Description**: string: The description of the secret. +* **GenerateSecretString**: [GenerateSecretString](#generatesecretstring) (WriteOnly): A structure that specifies how to generate a password to encrypt and store in the secret. To include a specific string in the secret, use ``SecretString`` instead. If you omit both ``GenerateSecretString`` and ``SecretString``, you create an empty secret. When you make a change to this property, a new secret version is created. + We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support. +* **Id**: string (ReadOnly, Identifier) +* **KmsKeyId**: string: The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt the secret value in the secret. An alias is always prefixed by ``alias/``, for example ``alias/aws/secretsmanager``. For more information, see [About aliases](https://docs.aws.amazon.com/kms/latest/developerguide/alias-about.html). + To use a KMS key in a different account, use the key ARN or the alias ARN. + If you don't specify this value, then Secrets Manager uses the key ``aws/secretsmanager``. If that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value. + If the secret is in a different AWS account from the credentials calling the API, then you can't use ``aws/secretsmanager`` to encrypt the secret, and you must create and use a customer managed KMS key. +* **Name**: string: The name of the new secret. + The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@- + Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN. +* **ReplicaRegions**: [ReplicaRegion](#replicaregion)[]: A custom type that specifies a ``Region`` and the ``KmsKeyId`` for a replica secret. +* **SecretString**: string (WriteOnly): The text to encrypt and store in the secret. We recommend you use a JSON structure of key/value pairs for your secret value. To generate a random password, use ``GenerateSecretString`` instead. If you omit both ``GenerateSecretString`` and ``SecretString``, you create an empty secret. When you make a change to this property, a new secret version is created. +* **Tags**: [Tag](#tag)[]: A list of tags to attach to the secret. Each tag is a key and value pair of strings in a JSON text string, for example: + ``[{"Key":"CostCenter","Value":"12345"},{"Key":"environment","Value":"production"}]`` + Secrets Manager tag key names are case sensitive. A tag with the key "ABC" is a different tag from one with key "abc". + Stack-level tags, tags you apply to the CloudFormation stack, are also attached to the secret. + If you check tags in permissions policies as part of your security strategy, then adding or removing a tag can change permissions. If the completion of this operation would result in you losing your permissions for this secret, then Secrets Manager blocks the operation and returns an ``Access Denied`` error. For more information, see [Control access to secrets using tags](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#tag-secrets-abac) and [Limit access to identities with tags that match secrets' tags](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#auth-and-access_tags2). + For information about how to format a JSON parameter for the various command line tool environments, see [Using JSON for Parameters](https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json). If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text. + The following restrictions apply to tags: + + Maximum number of tags per secret: 50 + + Maximum key length: 127 Unicode characters in UTF-8 + + Maximum value length: 255 Unicode characters in UTF-8 + + Tag keys and values are case sensitive. + + Do not use the ``aws:`` prefix in your tag names or values because AWS reserves it for AWS use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit. + + If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @. ## GenerateSecretString ### Properties -* **ExcludeCharacters**: string: A string that excludes characters in the generated password. By default, all characters from the included sets can be used. The string can be a minimum length of 0 characters and a maximum length of 7168 characters. -* **ExcludeLowercase**: bool: Specifies the generated password should not include lowercase letters. By default, ecrets Manager disables this parameter, and the generated password can include lowercase False, and the generated password can include lowercase letters. -* **ExcludeNumbers**: bool: Specifies that the generated password should exclude digits. By default, Secrets Manager does not enable the parameter, False, and the generated password can include digits. -* **ExcludePunctuation**: bool: Specifies that the generated password should not include punctuation characters. The default if you do not include this switch parameter is that punctuation characters can be included. -* **ExcludeUppercase**: bool: Specifies that the generated password should not include uppercase letters. The default behavior is False, and the generated password can include uppercase letters. -* **GenerateStringKey**: string: The JSON key name used to add the generated password to the JSON structure specified by the SecretStringTemplate parameter. If you specify this parameter, then you must also specify SecretStringTemplate. -* **IncludeSpace**: bool: Specifies that the generated password can include the space character. By default, Secrets Manager disables this parameter, and the generated password doesn't include space -* **PasswordLength**: int: The desired length of the generated password. The default value if you do not include this parameter is 32 characters. -* **RequireEachIncludedType**: bool: Specifies whether the generated password must include at least one of every allowed character type. By default, Secrets Manager enables this parameter, and the generated password includes at least one of every character type. -* **SecretStringTemplate**: string: A properly structured JSON string that the generated password can be added to. If you specify this parameter, then you must also specify GenerateStringKey. +* **ExcludeCharacters**: string: A string of the characters that you don't want in the password. +* **ExcludeLowercase**: bool: Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters. +* **ExcludeNumbers**: bool: Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers. +* **ExcludePunctuation**: bool: Specifies whether to exclude the following punctuation characters from the password: ``! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~``. If you don't include this switch, the password can contain punctuation. +* **ExcludeUppercase**: bool: Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters. +* **GenerateStringKey**: string: The JSON key name for the key/value pair, where the value is the generated password. This pair is added to the JSON structure specified by the ``SecretStringTemplate`` parameter. If you specify this parameter, then you must also specify ``SecretStringTemplate``. +* **IncludeSpace**: bool: Specifies whether to include the space character. If you include this switch, the password can contain space characters. +* **PasswordLength**: int: The length of the password. If you don't include this parameter, the default length is 32 characters. +* **RequireEachIncludedType**: bool: Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you don't include this switch, the password contains at least one of every character type. +* **SecretStringTemplate**: string: A template that the generated string must match. When you make a change to this property, a new secret version is created. ## ReplicaRegion ### Properties -* **KmsKeyId**: string: The ARN, key ID, or alias of the KMS key to encrypt the secret. If you don't include this field, Secrets Manager uses aws/secretsmanager. -* **Region**: string (Required): (Optional) A string that represents a Region, for example "us-east-1". +* **KmsKeyId**: string: The ARN, key ID, or alias of the KMS key to encrypt the secret. If you don't include this field, Secrets Manager uses ``aws/secretsmanager``. +* **Region**: string (Required): A string that represents a ``Region``, for example "us-east-1". ## Tag ### Properties -* **Key**: string (Required): The value for the tag. You can specify a value that's 1 to 256 characters in length. -* **Value**: string (Required): The key name of the tag. You can specify a value that's 1 to 128 Unicode characters in length and can't be prefixed with aws. +* **Key**: string (Required): The key identifier, or name, of the tag. +* **Value**: string (Required): The string value associated with the key of the tag. diff --git a/artifacts/bicep/aws/aws.securityhub/default/types.json b/artifacts/bicep/aws/aws.securityhub/default/types.json index 62800b84..f34b4b9a 100644 --- a/artifacts/bicep/aws/aws.securityhub/default/types.json +++ b/artifacts/bicep/aws/aws.securityhub/default/types.json @@ -1 +1,3639 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"AutomationRulesAction","Properties":{"FindingFieldsUpdate":{"Type":9,"Flags":1},"Type":{"Type":4,"Flags":1}}}},{"2":{"Name":"AutomationRulesFindingFieldsUpdate","Properties":{"Confidence":{"Type":3,"Flags":0},"Criticality":{"Type":3,"Flags":0},"Note":{"Type":31,"Flags":0,"Description":"Note added to the finding"},"RelatedFindings":{"Type":32,"Flags":0},"Severity":{"Type":33,"Flags":0,"Description":"Severity of the finding"},"Types":{"Type":34,"Flags":0},"UserDefinedFields":{"Type":28,"Flags":0},"VerificationState":{"Type":4,"Flags":0},"Workflow":{"Type":35,"Flags":0,"Description":"Workflow status set for the finding"}}}},{"2":{"Name":"AutomationRulesFindingFilters","Properties":{"AwsAccountId":{"Type":36,"Flags":0},"CompanyName":{"Type":37,"Flags":0},"ComplianceAssociatedStandardsId":{"Type":38,"Flags":0},"ComplianceSecurityControlId":{"Type":39,"Flags":0},"ComplianceStatus":{"Type":40,"Flags":0},"Confidence":{"Type":41,"Flags":0},"CreatedAt":{"Type":42,"Flags":0},"Criticality":{"Type":43,"Flags":0},"Description":{"Type":44,"Flags":0},"FirstObservedAt":{"Type":45,"Flags":0},"GeneratorId":{"Type":46,"Flags":0},"Id":{"Type":47,"Flags":0},"LastObservedAt":{"Type":48,"Flags":0},"NoteText":{"Type":49,"Flags":0},"NoteUpdatedAt":{"Type":50,"Flags":0},"NoteUpdatedBy":{"Type":51,"Flags":0},"ProductArn":{"Type":52,"Flags":0},"ProductName":{"Type":53,"Flags":0},"RecordState":{"Type":54,"Flags":0},"RelatedFindingsId":{"Type":55,"Flags":0},"RelatedFindingsProductArn":{"Type":56,"Flags":0},"ResourceDetailsOther":{"Type":57,"Flags":0},"ResourceId":{"Type":58,"Flags":0},"ResourcePartition":{"Type":59,"Flags":0},"ResourceRegion":{"Type":60,"Flags":0},"ResourceTags":{"Type":61,"Flags":0},"ResourceType":{"Type":62,"Flags":0},"SeverityLabel":{"Type":63,"Flags":0},"SourceUrl":{"Type":64,"Flags":0},"Title":{"Type":65,"Flags":0},"Type":{"Type":66,"Flags":0},"UpdatedAt":{"Type":67,"Flags":0},"UserDefinedFields":{"Type":68,"Flags":0},"VerificationState":{"Type":69,"Flags":0},"WorkflowStatus":{"Type":70,"Flags":0}}}},{"2":{"Name":"BooleanFilter","Properties":{"Value":{"Type":2,"Flags":1}}}},{"2":{"Name":"DateFilter","Properties":{"DateRange":{"Type":13,"Flags":1},"End":{"Type":4,"Flags":0},"Start":{"Type":4,"Flags":0}}}},{"2":{"Name":"DateRange","Properties":{"Unit":{"Type":4,"Flags":1},"Value":{"Type":3,"Flags":1}}}},{"2":{"Name":"ISO8601DateString"}},{"2":{"Name":"MapFilter","Properties":{"Comparison":{"Type":4,"Flags":1},"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"NonEmptyString"}},{"2":{"Name":"NoteUpdate","Properties":{"Text":{"Type":4,"Flags":1},"UpdatedBy":{"Type":71,"Flags":1}}}},{"2":{"Name":"NumberFilter","Properties":{"Eq":{"Type":3,"Flags":1},"Gte":{"Type":3,"Flags":0},"Lte":{"Type":3,"Flags":0}}}},{"2":{"Name":"RelatedFinding","Properties":{"Id":{"Type":72,"Flags":1},"ProductArn":{"Type":4,"Flags":1}}}},{"2":{"Name":"SeverityUpdate","Properties":{"Label":{"Type":4,"Flags":0},"Normalized":{"Type":3,"Flags":0},"Product":{"Type":3,"Flags":0}}}},{"2":{"Name":"StringFilter","Properties":{"Comparison":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"StringFilterComparison"}},{"2":{"Name":"Tags","Properties":{}}},{"2":{"Name":"WorkflowUpdate","Properties":{"Status":{"Type":4,"Flags":1}}}},{"2":{"Name":"arn"}},{"2":{"Name":"arnOrId","Properties":{}}},{"2":{"Name":"int100"}},{"2":{"Name":"map","Properties":{}}},{"2":{"Name":"timestamp"}},{"2":{"Name":"AutomationRule_arnOrId","Properties":{}}},{"2":{"Name":"AutomationRule_NoteUpdate","Properties":{"Text":{"Type":4,"Flags":1},"UpdatedBy":{"Type":30,"Flags":1}}}},{"3":{"ItemType":19}},{"2":{"Name":"AutomationRule_SeverityUpdate","Properties":{"Label":{"Type":4,"Flags":0},"Normalized":{"Type":3,"Flags":0},"Product":{"Type":3,"Flags":0}}}},{"3":{"ItemType":4}},{"2":{"Name":"AutomationRule_WorkflowUpdate","Properties":{"Status":{"Type":4,"Flags":1}}}},{"3":{"ItemType":21}},{"3":{"ItemType":21}},{"3":{"ItemType":21}},{"3":{"ItemType":21}},{"3":{"ItemType":21}},{"3":{"ItemType":18}},{"3":{"ItemType":12}},{"3":{"ItemType":18}},{"3":{"ItemType":21}},{"3":{"ItemType":12}},{"3":{"ItemType":21}},{"3":{"ItemType":21}},{"3":{"ItemType":12}},{"3":{"ItemType":21}},{"3":{"ItemType":12}},{"3":{"ItemType":21}},{"3":{"ItemType":21}},{"3":{"ItemType":21}},{"3":{"ItemType":21}},{"3":{"ItemType":21}},{"3":{"ItemType":21}},{"3":{"ItemType":15}},{"3":{"ItemType":21}},{"3":{"ItemType":21}},{"3":{"ItemType":21}},{"3":{"ItemType":15}},{"3":{"ItemType":21}},{"3":{"ItemType":21}},{"3":{"ItemType":21}},{"3":{"ItemType":21}},{"3":{"ItemType":21}},{"3":{"ItemType":12}},{"3":{"ItemType":15}},{"3":{"ItemType":21}},{"3":{"ItemType":21}},{"2":{"Name":"AutomationRule_arnOrId","Properties":{}}},{"2":{"Name":"AutomationRule_arnOrId","Properties":{}}},{"2":{"Name":"AWS.SecurityHub/AutomationRuleProperties","Properties":{"Actions":{"Type":74,"Flags":0},"CreatedAt":{"Type":4,"Flags":2,"Description":"The date and time when Automation Rule was created"},"CreatedBy":{"Type":4,"Flags":2,"Description":"The identifier by which created the rule"},"Criteria":{"Type":10,"Flags":0,"Description":"The rule criteria for evaluating findings"},"Description":{"Type":4,"Flags":0,"Description":"Rule description"},"IsTerminal":{"Type":2,"Flags":0,"Description":"If Rule is a terminal rule"},"RuleArn":{"Type":4,"Flags":18,"Description":"An Automation Rule Arn is automatically created"},"RuleName":{"Type":4,"Flags":0,"Description":"Rule name"},"RuleOrder":{"Type":3,"Flags":0,"Description":"Rule order value"},"RuleStatus":{"Type":4,"Flags":0,"Description":"Status of the Rule upon creation"},"Tags":{"Type":23,"Flags":0},"UpdatedAt":{"Type":4,"Flags":2,"Description":"The date and time when Automation Rule was last updated"}}}},{"3":{"ItemType":8}},{"2":{"Name":"AWS.SecurityHub/AutomationRule","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":73,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.SecurityHub/AutomationRule@default","ScopeType":0,"Body":75}},{"2":{"Name":"Tags","Properties":{}}},{"2":{"Name":"AWS.SecurityHub/HubProperties","Properties":{"ARN":{"Type":4,"Flags":18,"Description":"An ARN is automatically created for the customer."},"AutoEnableControls":{"Type":2,"Flags":0,"Description":"Whether to automatically enable new controls when they are added to standards that are enabled"},"ControlFindingGenerator":{"Type":4,"Flags":0,"Description":"This field, used when enabling Security Hub, specifies whether the calling account has consolidated control findings turned on. If the value for this field is set to SECURITY_CONTROL, Security Hub generates a single finding for a control check even when the check applies to multiple enabled standards. If the value for this field is set to STANDARD_CONTROL, Security Hub generates separate findings for a control check when the check applies to multiple enabled standards."},"EnableDefaultStandards":{"Type":2,"Flags":4,"Description":"Whether to enable the security standards that Security Hub has designated as automatically enabled."},"SubscribedAt":{"Type":4,"Flags":2,"Description":"The date and time when Security Hub was enabled in the account."},"Tags":{"Type":77,"Flags":0}}}},{"2":{"Name":"AWS.SecurityHub/Hub","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":78,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.SecurityHub/Hub@default","ScopeType":0,"Body":79}},{"2":{"Name":"StandardsControl","Properties":{"Reason":{"Type":4,"Flags":0,"Description":"the reason the standard control is disabled"},"StandardsControlArn":{"Type":4,"Flags":1,"Description":"the Arn for the standard control."}}}},{"2":{"Name":"AWS.SecurityHub/StandardProperties","Properties":{"DisabledStandardsControls":{"Type":83,"Flags":0,"Description":"StandardsControls to disable from this Standard."},"StandardsArn":{"Type":4,"Flags":1,"Description":"The ARN of the Standard being enabled"},"StandardsSubscriptionArn":{"Type":4,"Flags":18,"Description":"The ARN of the StandardsSubscription for the account ID, region, and Standard."}}}},{"3":{"ItemType":81}},{"2":{"Name":"AWS.SecurityHub/Standard","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":82,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.SecurityHub/Standard@default","ScopeType":0,"Body":84}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "AutomationRulesAction", + "properties": { + "FindingFieldsUpdate": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "" + }, + "Type": { + "type": { + "$ref": "#/22" + }, + "flags": 1, + "description": "" + } + } + }, + { + "$type": "ObjectType", + "name": "AutomationRulesFindingFieldsUpdate", + "properties": { + "Confidence": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "" + }, + "Criticality": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "" + }, + "Note": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "The rule action will update the ``Note`` field of a finding." + }, + "RelatedFindings": { + "type": { + "$ref": "#/26" + }, + "flags": 0, + "description": "The rule action will update the ``RelatedFindings`` field of a finding." + }, + "Severity": { + "type": { + "$ref": "#/27" + }, + "flags": 0, + "description": "The rule action will update the ``Severity`` field of a finding." + }, + "Types": { + "type": { + "$ref": "#/28" + }, + "flags": 0, + "description": "" + }, + "UserDefinedFields": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "" + }, + "VerificationState": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "" + }, + "Workflow": { + "type": { + "$ref": "#/29" + }, + "flags": 0, + "description": "The rule action will update the ``Workflow`` field of a finding." + } + } + }, + { + "$type": "ObjectType", + "name": "AutomationRulesFindingFilters", + "properties": { + "AwsAccountId": { + "type": { + "$ref": "#/30" + }, + "flags": 0, + "description": "" + }, + "CompanyName": { + "type": { + "$ref": "#/31" + }, + "flags": 0, + "description": "" + }, + "ComplianceAssociatedStandardsId": { + "type": { + "$ref": "#/32" + }, + "flags": 0, + "description": "" + }, + "ComplianceSecurityControlId": { + "type": { + "$ref": "#/33" + }, + "flags": 0, + "description": "" + }, + "ComplianceStatus": { + "type": { + "$ref": "#/34" + }, + "flags": 0, + "description": "" + }, + "Confidence": { + "type": { + "$ref": "#/35" + }, + "flags": 0, + "description": "" + }, + "CreatedAt": { + "type": { + "$ref": "#/36" + }, + "flags": 0, + "description": "" + }, + "Criticality": { + "type": { + "$ref": "#/37" + }, + "flags": 0, + "description": "" + }, + "Description": { + "type": { + "$ref": "#/38" + }, + "flags": 0, + "description": "" + }, + "FirstObservedAt": { + "type": { + "$ref": "#/39" + }, + "flags": 0, + "description": "" + }, + "GeneratorId": { + "type": { + "$ref": "#/40" + }, + "flags": 0, + "description": "" + }, + "Id": { + "type": { + "$ref": "#/41" + }, + "flags": 0, + "description": "" + }, + "LastObservedAt": { + "type": { + "$ref": "#/42" + }, + "flags": 0, + "description": "" + }, + "NoteText": { + "type": { + "$ref": "#/43" + }, + "flags": 0, + "description": "" + }, + "NoteUpdatedAt": { + "type": { + "$ref": "#/44" + }, + "flags": 0, + "description": "" + }, + "NoteUpdatedBy": { + "type": { + "$ref": "#/45" + }, + "flags": 0, + "description": "" + }, + "ProductArn": { + "type": { + "$ref": "#/46" + }, + "flags": 0, + "description": "" + }, + "ProductName": { + "type": { + "$ref": "#/47" + }, + "flags": 0, + "description": "" + }, + "RecordState": { + "type": { + "$ref": "#/48" + }, + "flags": 0, + "description": "" + }, + "RelatedFindingsId": { + "type": { + "$ref": "#/49" + }, + "flags": 0, + "description": "" + }, + "RelatedFindingsProductArn": { + "type": { + "$ref": "#/50" + }, + "flags": 0, + "description": "" + }, + "ResourceDetailsOther": { + "type": { + "$ref": "#/51" + }, + "flags": 0, + "description": "" + }, + "ResourceId": { + "type": { + "$ref": "#/52" + }, + "flags": 0, + "description": "" + }, + "ResourcePartition": { + "type": { + "$ref": "#/53" + }, + "flags": 0, + "description": "" + }, + "ResourceRegion": { + "type": { + "$ref": "#/54" + }, + "flags": 0, + "description": "" + }, + "ResourceTags": { + "type": { + "$ref": "#/55" + }, + "flags": 0, + "description": "" + }, + "ResourceType": { + "type": { + "$ref": "#/56" + }, + "flags": 0, + "description": "" + }, + "SeverityLabel": { + "type": { + "$ref": "#/57" + }, + "flags": 0, + "description": "" + }, + "SourceUrl": { + "type": { + "$ref": "#/58" + }, + "flags": 0, + "description": "" + }, + "Title": { + "type": { + "$ref": "#/59" + }, + "flags": 0, + "description": "" + }, + "Type": { + "type": { + "$ref": "#/60" + }, + "flags": 0, + "description": "" + }, + "UpdatedAt": { + "type": { + "$ref": "#/61" + }, + "flags": 0, + "description": "" + }, + "UserDefinedFields": { + "type": { + "$ref": "#/62" + }, + "flags": 0, + "description": "" + }, + "VerificationState": { + "type": { + "$ref": "#/63" + }, + "flags": 0, + "description": "" + }, + "WorkflowStatus": { + "type": { + "$ref": "#/64" + }, + "flags": 0, + "description": "" + } + } + }, + { + "$type": "ObjectType", + "name": "BooleanFilter", + "properties": { + "Value": { + "type": { + "$ref": "#/65" + }, + "flags": 1, + "description": "The value of the boolean." + } + } + }, + { + "$type": "ObjectType", + "name": "DateFilter", + "properties": { + "DateRange": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "" + }, + "End": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "" + }, + "Start": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "" + } + } + }, + { + "$type": "ObjectType", + "name": "DateRange", + "properties": { + "Unit": { + "type": { + "$ref": "#/22" + }, + "flags": 1, + "description": "" + }, + "Value": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "" + } + } + }, + { + "$type": "ObjectType", + "name": "ISO8601DateString", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MapFilter", + "properties": { + "Comparison": { + "type": { + "$ref": "#/22" + }, + "flags": 1, + "description": "" + }, + "Key": { + "type": { + "$ref": "#/22" + }, + "flags": 1, + "description": "" + }, + "Value": { + "type": { + "$ref": "#/22" + }, + "flags": 1, + "description": "" + } + } + }, + { + "$type": "ObjectType", + "name": "NonEmptyString", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "NoteUpdate", + "properties": { + "Text": { + "type": { + "$ref": "#/22" + }, + "flags": 1, + "description": "" + }, + "UpdatedBy": { + "type": { + "$ref": "#/66" + }, + "flags": 1, + "description": "" + } + } + }, + { + "$type": "ObjectType", + "name": "NumberFilter", + "properties": { + "Eq": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "" + }, + "Gte": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "" + }, + "Lte": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "" + } + } + }, + { + "$type": "ObjectType", + "name": "RelatedFinding", + "properties": { + "Id": { + "type": { + "$ref": "#/67" + }, + "flags": 1, + "description": "" + }, + "ProductArn": { + "type": { + "$ref": "#/22" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) for the product that generated a related finding." + } + } + }, + { + "$type": "ObjectType", + "name": "SeverityUpdate", + "properties": { + "Label": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "" + }, + "Normalized": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "" + }, + "Product": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "" + } + } + }, + { + "$type": "ObjectType", + "name": "StringFilter", + "properties": { + "Comparison": { + "type": { + "$ref": "#/22" + }, + "flags": 1, + "description": "" + }, + "Value": { + "type": { + "$ref": "#/22" + }, + "flags": 1, + "description": "" + } + } + }, + { + "$type": "ObjectType", + "name": "StringFilterComparison", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tags", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "WorkflowUpdate", + "properties": { + "Status": { + "type": { + "$ref": "#/22" + }, + "flags": 1, + "description": "" + } + } + }, + { + "$type": "ObjectType", + "name": "arn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "arnOrId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "int100", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "map", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "timestamp", + "properties": {} + }, + { + "$type": "StringType" + }, + { + "$type": "IntegerType" + }, + { + "$type": "ObjectType", + "name": "AutomationRule_arnOrId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AutomationRule_NoteUpdate", + "properties": { + "Text": { + "type": { + "$ref": "#/22" + }, + "flags": 1, + "description": "" + }, + "UpdatedBy": { + "type": { + "$ref": "#/24" + }, + "flags": 1, + "description": "" + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/11" + } + }, + { + "$type": "ObjectType", + "name": "AutomationRule_SeverityUpdate", + "properties": { + "Label": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "" + }, + "Normalized": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "" + }, + "Product": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "" + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/22" + } + }, + { + "$type": "ObjectType", + "name": "AutomationRule_WorkflowUpdate", + "properties": { + "Status": { + "type": { + "$ref": "#/22" + }, + "flags": 1, + "description": "" + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/10" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/10" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/7" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/7" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/7" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "ObjectType", + "name": "AutomationRule_arnOrId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AutomationRule_arnOrId", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.SecurityHub/AutomationRuleProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ObjectType", + "name": "AWS.SecurityHub/AutomationRuleProperties", + "properties": { + "Actions": { + "type": { + "$ref": "#/69" + }, + "flags": 0, + "description": "" + }, + "CreatedAt": { + "type": { + "$ref": "#/22" + }, + "flags": 2, + "description": "" + }, + "CreatedBy": { + "type": { + "$ref": "#/22" + }, + "flags": 2, + "description": "" + }, + "Criteria": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "A set of [Security Finding Format (ASFF)](https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format.html) finding field attributes and corresponding expected values that ASH uses to filter findings. If a rule is enabled and a finding matches the criteria specified in this parameter, ASH applies the rule action to the finding." + }, + "Description": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "" + }, + "IsTerminal": { + "type": { + "$ref": "#/65" + }, + "flags": 0, + "description": "" + }, + "RuleArn": { + "type": { + "$ref": "#/22" + }, + "flags": 18, + "description": "" + }, + "RuleName": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "" + }, + "RuleOrder": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "" + }, + "RuleStatus": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "Whether the rule is active after it is created. If this parameter is equal to ``ENABLED``, ASH applies the rule to findings and finding updates after the rule is created." + }, + "Tags": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "" + }, + "UpdatedAt": { + "type": { + "$ref": "#/22" + }, + "flags": 2, + "description": "" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SecurityHub/AutomationRule", + "properties": { + "name": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/22" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/70" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SecurityHub/AutomationRule@default", + "scopeType": 0, + "body": { + "$ref": "#/71" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "ParameterConfiguration", + "properties": { + "Value": { + "type": { + "$ref": "#/74" + }, + "flags": 0 + }, + "ValueType": { + "type": { + "$ref": "#/22" + }, + "flags": 1, + "description": "Identifies whether a control parameter uses a custom user-defined value or subscribes to the default AWS Security Hub behavior." + } + } + }, + { + "$type": "ObjectType", + "name": "ParameterValue", + "properties": { + "Boolean": { + "type": { + "$ref": "#/65" + }, + "flags": 0, + "description": "A control parameter that is a boolean." + }, + "Double": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "A control parameter that is a double." + }, + "Enum": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "A control parameter that is an enum." + }, + "EnumList": { + "type": { + "$ref": "#/80" + }, + "flags": 0, + "description": "A control parameter that is a list of enums." + }, + "Integer": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "A control parameter that is an integer." + }, + "IntegerList": { + "type": { + "$ref": "#/81" + }, + "flags": 0, + "description": "A control parameter that is a list of integers." + }, + "String": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "A control parameter that is a string." + }, + "StringList": { + "type": { + "$ref": "#/82" + }, + "flags": 0, + "description": "A control parameter that is a list of strings." + } + } + }, + { + "$type": "ObjectType", + "name": "Policy", + "properties": { + "SecurityHub": { + "type": { + "$ref": "#/78" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SecurityControlCustomParameter", + "properties": { + "Parameters": { + "type": { + "$ref": "#/83" + }, + "flags": 0, + "description": "An object that specifies parameter values for a control in a configuration policy." + }, + "SecurityControlId": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "The ID of the security control." + } + } + }, + { + "$type": "ObjectType", + "name": "SecurityControlsConfiguration", + "properties": { + "DisabledSecurityControlIdentifiers": { + "type": { + "$ref": "#/84" + }, + "flags": 0, + "description": "A list of security controls that are disabled in the configuration policy" + }, + "EnabledSecurityControlIdentifiers": { + "type": { + "$ref": "#/85" + }, + "flags": 0, + "description": "A list of security controls that are enabled in the configuration policy." + }, + "SecurityControlCustomParameters": { + "type": { + "$ref": "#/86" + }, + "flags": 0, + "description": "A list of security controls and control parameter values that are included in a configuration policy." + } + } + }, + { + "$type": "ObjectType", + "name": "SecurityHubPolicy", + "properties": { + "EnabledStandardIdentifiers": { + "type": { + "$ref": "#/87" + }, + "flags": 0, + "description": "A list that defines which security standards are enabled in the configuration policy." + }, + "SecurityControlsConfiguration": { + "type": { + "$ref": "#/77" + }, + "flags": 0 + }, + "ServiceEnabled": { + "type": { + "$ref": "#/65" + }, + "flags": 0, + "description": "Indicates whether Security Hub is enabled in the policy." + } + } + }, + { + "$type": "ObjectType", + "name": "Tags", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/22" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/23" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/22" + } + }, + { + "$type": "ObjectType", + "name": "ConfigurationPolicy_Parameters", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/22" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/22" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/76" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/22" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.SecurityHub/ConfigurationPolicyProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.SecurityHub/ConfigurationPolicyProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/22" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) of the configuration policy." + }, + "ConfigurationPolicy": { + "type": { + "$ref": "#/75" + }, + "flags": 1 + }, + "CreatedAt": { + "type": { + "$ref": "#/22" + }, + "flags": 2, + "description": "The date and time, in UTC and ISO 8601 format." + }, + "Description": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "The description of the configuration policy." + }, + "Id": { + "type": { + "$ref": "#/22" + }, + "flags": 2, + "description": "The universally unique identifier (UUID) of the configuration policy." + }, + "Name": { + "type": { + "$ref": "#/22" + }, + "flags": 1, + "description": "The name of the configuration policy." + }, + "ServiceEnabled": { + "type": { + "$ref": "#/65" + }, + "flags": 2, + "description": "Indicates whether the service that the configuration policy applies to is enabled in the policy." + }, + "Tags": { + "type": { + "$ref": "#/79" + }, + "flags": 0 + }, + "UpdatedAt": { + "type": { + "$ref": "#/22" + }, + "flags": 2, + "description": "The date and time, in UTC and ISO 8601 format." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SecurityHub/ConfigurationPolicy", + "properties": { + "name": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/22" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/89" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SecurityHub/ConfigurationPolicy@default", + "scopeType": 0, + "body": { + "$ref": "#/90" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Region", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.SecurityHub/FindingAggregatorProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/22" + } + }, + { + "$type": "ObjectType", + "name": "AWS.SecurityHub/FindingAggregatorProperties", + "properties": { + "FindingAggregationRegion": { + "type": { + "$ref": "#/22" + }, + "flags": 2, + "description": "The aggregation Region of the FindingAggregator" + }, + "FindingAggregatorArn": { + "type": { + "$ref": "#/22" + }, + "flags": 18, + "description": "The ARN of the FindingAggregator being created and assigned as the unique identifier" + }, + "RegionLinkingMode": { + "type": { + "$ref": "#/22" + }, + "flags": 1, + "description": "Indicates whether to link all Regions, all Regions except for a list of excluded Regions, or a list of included Regions" + }, + "Regions": { + "type": { + "$ref": "#/94" + }, + "flags": 0, + "description": "The list of excluded Regions or included Regions" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SecurityHub/FindingAggregator", + "properties": { + "name": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/22" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/95" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SecurityHub/FindingAggregator@default", + "scopeType": 0, + "body": { + "$ref": "#/96" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tags", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.SecurityHub/HubProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.SecurityHub/HubProperties", + "properties": { + "ARN": { + "type": { + "$ref": "#/22" + }, + "flags": 18, + "description": "An ARN is automatically created for the customer." + }, + "AutoEnableControls": { + "type": { + "$ref": "#/65" + }, + "flags": 0, + "description": "Whether to automatically enable new controls when they are added to standards that are enabled" + }, + "ControlFindingGenerator": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "This field, used when enabling Security Hub, specifies whether the calling account has consolidated control findings turned on. If the value for this field is set to SECURITY_CONTROL, Security Hub generates a single finding for a control check even when the check applies to multiple enabled standards. If the value for this field is set to STANDARD_CONTROL, Security Hub generates separate findings for a control check when the check applies to multiple enabled standards." + }, + "EnableDefaultStandards": { + "type": { + "$ref": "#/65" + }, + "flags": 4, + "description": "Whether to enable the security standards that Security Hub has designated as automatically enabled." + }, + "SubscribedAt": { + "type": { + "$ref": "#/22" + }, + "flags": 2, + "description": "The date and time when Security Hub was enabled in the account." + }, + "Tags": { + "type": { + "$ref": "#/98" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SecurityHub/Hub", + "properties": { + "name": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/22" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/100" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SecurityHub/Hub@default", + "scopeType": 0, + "body": { + "$ref": "#/101" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AwsSecurityFindingFilters", + "properties": { + "AwsAccountId": { + "type": { + "$ref": "#/115" + }, + "flags": 0, + "description": "The AWS account ID in which a finding is generated." + }, + "AwsAccountName": { + "type": { + "$ref": "#/116" + }, + "flags": 0, + "description": "The name of the AWS account in which a finding is generated." + }, + "CompanyName": { + "type": { + "$ref": "#/117" + }, + "flags": 0, + "description": "The name of the findings provider (company) that owns the solution (product) that generates findings." + }, + "ComplianceAssociatedStandardsId": { + "type": { + "$ref": "#/118" + }, + "flags": 0, + "description": "The unique identifier of a standard in which a control is enabled." + }, + "ComplianceSecurityControlId": { + "type": { + "$ref": "#/119" + }, + "flags": 0, + "description": "The unique identifier of a control across standards." + }, + "ComplianceSecurityControlParametersName": { + "type": { + "$ref": "#/120" + }, + "flags": 0, + "description": "The name of a security control parameter." + }, + "ComplianceSecurityControlParametersValue": { + "type": { + "$ref": "#/121" + }, + "flags": 0, + "description": "The current value of a security control parameter." + }, + "ComplianceStatus": { + "type": { + "$ref": "#/122" + }, + "flags": 0, + "description": "Exclusive to findings that are generated as the result of a check run against a specific rule in a supported standard." + }, + "Confidence": { + "type": { + "$ref": "#/123" + }, + "flags": 0, + "description": "A finding's confidence." + }, + "CreatedAt": { + "type": { + "$ref": "#/124" + }, + "flags": 0, + "description": "An ISO8601-formatted timestamp that indicates when the security findings provider captured the potential security issue that a finding captured." + }, + "Criticality": { + "type": { + "$ref": "#/125" + }, + "flags": 0, + "description": "The level of importance assigned to the resources associated with the finding." + }, + "Description": { + "type": { + "$ref": "#/126" + }, + "flags": 0, + "description": "A finding's description." + }, + "FindingProviderFieldsConfidence": { + "type": { + "$ref": "#/127" + }, + "flags": 0, + "description": "The finding provider value for the finding confidence." + }, + "FindingProviderFieldsCriticality": { + "type": { + "$ref": "#/128" + }, + "flags": 0, + "description": "The finding provider value for the level of importance assigned to the resources associated with the findings." + }, + "FindingProviderFieldsRelatedFindingsId": { + "type": { + "$ref": "#/129" + }, + "flags": 0, + "description": "The finding identifier of a related finding that is identified by the finding provider." + }, + "FindingProviderFieldsRelatedFindingsProductArn": { + "type": { + "$ref": "#/130" + }, + "flags": 0, + "description": "The ARN of the solution that generated a related finding that is identified by the finding provider." + }, + "FindingProviderFieldsSeverityLabel": { + "type": { + "$ref": "#/131" + }, + "flags": 0, + "description": "The finding provider value for the severity label." + }, + "FindingProviderFieldsSeverityOriginal": { + "type": { + "$ref": "#/132" + }, + "flags": 0, + "description": "The finding provider's original value for the severity." + }, + "FindingProviderFieldsTypes": { + "type": { + "$ref": "#/133" + }, + "flags": 0, + "description": "One or more finding types that the finding provider assigned to the finding." + }, + "FirstObservedAt": { + "type": { + "$ref": "#/134" + }, + "flags": 0, + "description": "An ISO8601-formatted timestamp that indicates when the security findings provider first observed the potential security issue that a finding captured." + }, + "GeneratorId": { + "type": { + "$ref": "#/135" + }, + "flags": 0, + "description": "The identifier for the solution-specific component (a discrete unit of logic) that generated a finding." + }, + "Id": { + "type": { + "$ref": "#/136" + }, + "flags": 0, + "description": "The security findings provider-specific identifier for a finding." + }, + "Keyword": { + "type": { + "$ref": "#/137" + }, + "flags": 0, + "description": "A keyword for a finding." + }, + "LastObservedAt": { + "type": { + "$ref": "#/138" + }, + "flags": 0, + "description": "An ISO8601-formatted timestamp that indicates when the security findings provider most recently observed the potential security issue that a finding captured." + }, + "MalwareName": { + "type": { + "$ref": "#/139" + }, + "flags": 0, + "description": "The name of the malware that was observed." + }, + "MalwarePath": { + "type": { + "$ref": "#/140" + }, + "flags": 0, + "description": "The filesystem path of the malware that was observed." + }, + "MalwareState": { + "type": { + "$ref": "#/141" + }, + "flags": 0, + "description": "The state of the malware that was observed." + }, + "MalwareType": { + "type": { + "$ref": "#/142" + }, + "flags": 0, + "description": "The type of the malware that was observed." + }, + "NetworkDestinationDomain": { + "type": { + "$ref": "#/143" + }, + "flags": 0, + "description": "The destination domain of network-related information about a finding." + }, + "NetworkDestinationIpV4": { + "type": { + "$ref": "#/144" + }, + "flags": 0, + "description": "The destination IPv4 address of network-related information about a finding." + }, + "NetworkDestinationIpV6": { + "type": { + "$ref": "#/145" + }, + "flags": 0, + "description": "The destination IPv6 address of network-related information about a finding." + }, + "NetworkDestinationPort": { + "type": { + "$ref": "#/146" + }, + "flags": 0, + "description": "The destination port of network-related information about a finding." + }, + "NetworkDirection": { + "type": { + "$ref": "#/147" + }, + "flags": 0, + "description": "Indicates the direction of network traffic associated with a finding." + }, + "NetworkProtocol": { + "type": { + "$ref": "#/148" + }, + "flags": 0, + "description": "The protocol of network-related information about a finding." + }, + "NetworkSourceDomain": { + "type": { + "$ref": "#/149" + }, + "flags": 0, + "description": "The source domain of network-related information about a finding." + }, + "NetworkSourceIpV4": { + "type": { + "$ref": "#/150" + }, + "flags": 0, + "description": "The source IPv4 address of network-related information about a finding." + }, + "NetworkSourceIpV6": { + "type": { + "$ref": "#/151" + }, + "flags": 0, + "description": "The source IPv6 address of network-related information about a finding." + }, + "NetworkSourceMac": { + "type": { + "$ref": "#/152" + }, + "flags": 0, + "description": "The source media access control (MAC) address of network-related information about a finding." + }, + "NetworkSourcePort": { + "type": { + "$ref": "#/153" + }, + "flags": 0, + "description": "The source port of network-related information about a finding." + }, + "NoteText": { + "type": { + "$ref": "#/154" + }, + "flags": 0, + "description": "The text of a note." + }, + "NoteUpdatedAt": { + "type": { + "$ref": "#/155" + }, + "flags": 0, + "description": "The timestamp of when the note was updated." + }, + "NoteUpdatedBy": { + "type": { + "$ref": "#/156" + }, + "flags": 0, + "description": "The principal that created a note." + }, + "ProcessLaunchedAt": { + "type": { + "$ref": "#/157" + }, + "flags": 0, + "description": "A timestamp that identifies when the process was launched." + }, + "ProcessName": { + "type": { + "$ref": "#/158" + }, + "flags": 0, + "description": "The name of the process." + }, + "ProcessParentPid": { + "type": { + "$ref": "#/159" + }, + "flags": 0, + "description": "The parent process ID." + }, + "ProcessPath": { + "type": { + "$ref": "#/160" + }, + "flags": 0, + "description": "The path to the process executable." + }, + "ProcessPid": { + "type": { + "$ref": "#/161" + }, + "flags": 0, + "description": "The process ID." + }, + "ProcessTerminatedAt": { + "type": { + "$ref": "#/162" + }, + "flags": 0, + "description": "A timestamp that identifies when the process was terminated." + }, + "ProductArn": { + "type": { + "$ref": "#/163" + }, + "flags": 0, + "description": "The ARN generated by Security Hub that uniquely identifies a third-party company (security findings provider) after this provider's product (solution that generates findings) is registered with Security Hub." + }, + "ProductFields": { + "type": { + "$ref": "#/164" + }, + "flags": 0, + "description": "A data type where security findings providers can include additional solution-specific details that aren't part of the defined AwsSecurityFinding format." + }, + "ProductName": { + "type": { + "$ref": "#/165" + }, + "flags": 0, + "description": "The name of the solution (product) that generates findings." + }, + "RecommendationText": { + "type": { + "$ref": "#/166" + }, + "flags": 0, + "description": "The recommendation of what to do about the issue described in a finding." + }, + "RecordState": { + "type": { + "$ref": "#/167" + }, + "flags": 0, + "description": "The updated record state for the finding." + }, + "Region": { + "type": { + "$ref": "#/168" + }, + "flags": 0, + "description": "The Region from which the finding was generated." + }, + "RelatedFindingsId": { + "type": { + "$ref": "#/169" + }, + "flags": 0, + "description": "The solution-generated identifier for a related finding." + }, + "RelatedFindingsProductArn": { + "type": { + "$ref": "#/170" + }, + "flags": 0, + "description": "The ARN of the solution that generated a related finding." + }, + "ResourceApplicationArn": { + "type": { + "$ref": "#/171" + }, + "flags": 0, + "description": "The ARN of the application that is related to a finding." + }, + "ResourceApplicationName": { + "type": { + "$ref": "#/172" + }, + "flags": 0, + "description": "The name of the application that is related to a finding." + }, + "ResourceAwsEc2InstanceIamInstanceProfileArn": { + "type": { + "$ref": "#/173" + }, + "flags": 0, + "description": "The IAM profile ARN of the instance." + }, + "ResourceAwsEc2InstanceImageId": { + "type": { + "$ref": "#/174" + }, + "flags": 0, + "description": "The Amazon Machine Image (AMI) ID of the instance." + }, + "ResourceAwsEc2InstanceIpV4Addresses": { + "type": { + "$ref": "#/175" + }, + "flags": 0, + "description": "The IPv4 addresses associated with the instance." + }, + "ResourceAwsEc2InstanceIpV6Addresses": { + "type": { + "$ref": "#/176" + }, + "flags": 0, + "description": "The IPv6 addresses associated with the instance." + }, + "ResourceAwsEc2InstanceKeyName": { + "type": { + "$ref": "#/177" + }, + "flags": 0, + "description": "The key name associated with the instance." + }, + "ResourceAwsEc2InstanceLaunchedAt": { + "type": { + "$ref": "#/178" + }, + "flags": 0, + "description": "The date and time the instance was launched." + }, + "ResourceAwsEc2InstanceSubnetId": { + "type": { + "$ref": "#/179" + }, + "flags": 0, + "description": "The identifier of the subnet that the instance was launched in." + }, + "ResourceAwsEc2InstanceType": { + "type": { + "$ref": "#/180" + }, + "flags": 0, + "description": "The instance type of the instance." + }, + "ResourceAwsEc2InstanceVpcId": { + "type": { + "$ref": "#/181" + }, + "flags": 0, + "description": "The identifier of the VPC that the instance was launched in." + }, + "ResourceAwsIamAccessKeyCreatedAt": { + "type": { + "$ref": "#/182" + }, + "flags": 0, + "description": "The creation date/time of the IAM access key related to a finding." + }, + "ResourceAwsIamAccessKeyPrincipalName": { + "type": { + "$ref": "#/183" + }, + "flags": 0, + "description": "The name of the principal that is associated with an IAM access key." + }, + "ResourceAwsIamAccessKeyStatus": { + "type": { + "$ref": "#/184" + }, + "flags": 0, + "description": "The status of the IAM access key related to a finding." + }, + "ResourceAwsIamAccessKeyUserName": { + "type": { + "$ref": "#/185" + }, + "flags": 0, + "description": "The user associated with the IAM access key related to a finding." + }, + "ResourceAwsIamUserUserName": { + "type": { + "$ref": "#/186" + }, + "flags": 0, + "description": "The name of an IAM user." + }, + "ResourceAwsS3BucketOwnerId": { + "type": { + "$ref": "#/187" + }, + "flags": 0, + "description": "The canonical user ID of the owner of the S3 bucket." + }, + "ResourceAwsS3BucketOwnerName": { + "type": { + "$ref": "#/188" + }, + "flags": 0, + "description": "The display name of the owner of the S3 bucket." + }, + "ResourceContainerImageId": { + "type": { + "$ref": "#/189" + }, + "flags": 0, + "description": "The identifier of the image related to a finding." + }, + "ResourceContainerImageName": { + "type": { + "$ref": "#/190" + }, + "flags": 0, + "description": "The name of the image related to a finding." + }, + "ResourceContainerLaunchedAt": { + "type": { + "$ref": "#/191" + }, + "flags": 0, + "description": "A timestamp that identifies when the container was started." + }, + "ResourceContainerName": { + "type": { + "$ref": "#/192" + }, + "flags": 0, + "description": "The name of the container related to a finding." + }, + "ResourceDetailsOther": { + "type": { + "$ref": "#/193" + }, + "flags": 0, + "description": "The details of a resource that doesn't have a specific subfield for the resource type defined." + }, + "ResourceId": { + "type": { + "$ref": "#/194" + }, + "flags": 0, + "description": "The canonical identifier for the given resource type." + }, + "ResourcePartition": { + "type": { + "$ref": "#/195" + }, + "flags": 0, + "description": "The canonical AWS partition name that the Region is assigned to." + }, + "ResourceRegion": { + "type": { + "$ref": "#/196" + }, + "flags": 0, + "description": "The canonical AWS external Region name where this resource is located." + }, + "ResourceTags": { + "type": { + "$ref": "#/197" + }, + "flags": 0, + "description": "A list of AWS tags associated with a resource at the time the finding was processed." + }, + "ResourceType": { + "type": { + "$ref": "#/198" + }, + "flags": 0, + "description": "Specifies the type of the resource that details are provided for." + }, + "Sample": { + "type": { + "$ref": "#/199" + }, + "flags": 0, + "description": "Indicates whether or not sample findings are included in the filter results." + }, + "SeverityLabel": { + "type": { + "$ref": "#/200" + }, + "flags": 0, + "description": "The label of a finding's severity." + }, + "SeverityNormalized": { + "type": { + "$ref": "#/201" + }, + "flags": 0, + "description": "The normalized severity of a finding." + }, + "SeverityProduct": { + "type": { + "$ref": "#/202" + }, + "flags": 0, + "description": "The native severity as defined by the security findings provider's solution that generated the finding." + }, + "SourceUrl": { + "type": { + "$ref": "#/203" + }, + "flags": 0, + "description": "A URL that links to a page about the current finding in the security findings provider's solution." + }, + "ThreatIntelIndicatorCategory": { + "type": { + "$ref": "#/204" + }, + "flags": 0, + "description": "The category of a threat intelligence indicator." + }, + "ThreatIntelIndicatorLastObservedAt": { + "type": { + "$ref": "#/205" + }, + "flags": 0, + "description": "A timestamp that identifies the last observation of a threat intelligence indicator." + }, + "ThreatIntelIndicatorSource": { + "type": { + "$ref": "#/206" + }, + "flags": 0, + "description": "The source of the threat intelligence." + }, + "ThreatIntelIndicatorSourceUrl": { + "type": { + "$ref": "#/207" + }, + "flags": 0, + "description": "The URL for more details from the source of the threat intelligence." + }, + "ThreatIntelIndicatorType": { + "type": { + "$ref": "#/208" + }, + "flags": 0, + "description": "The type of a threat intelligence indicator." + }, + "ThreatIntelIndicatorValue": { + "type": { + "$ref": "#/209" + }, + "flags": 0, + "description": "The value of a threat intelligence indicator." + }, + "Title": { + "type": { + "$ref": "#/210" + }, + "flags": 0, + "description": "A finding's title." + }, + "Type": { + "type": { + "$ref": "#/211" + }, + "flags": 0, + "description": "A finding type in the format of namespace/category/classifier that classifies a finding." + }, + "UpdatedAt": { + "type": { + "$ref": "#/212" + }, + "flags": 0, + "description": "An ISO8601-formatted timestamp that indicates when the security findings provider last updated the finding record." + }, + "UserDefinedFields": { + "type": { + "$ref": "#/213" + }, + "flags": 0, + "description": "A list of name/value string pairs associated with the finding." + }, + "VerificationState": { + "type": { + "$ref": "#/214" + }, + "flags": 0, + "description": "The veracity of a finding." + }, + "VulnerabilitiesExploitAvailable": { + "type": { + "$ref": "#/215" + }, + "flags": 0, + "description": "Indicates whether a software vulnerability in your environment has a known exploit." + }, + "VulnerabilitiesFixAvailable": { + "type": { + "$ref": "#/216" + }, + "flags": 0, + "description": "Indicates whether a vulnerability is fixed in a newer version of the affected software packages." + }, + "WorkflowState": { + "type": { + "$ref": "#/217" + }, + "flags": 0, + "description": "The workflow state of a finding." + }, + "WorkflowStatus": { + "type": { + "$ref": "#/218" + }, + "flags": 0, + "description": "The status of the investigation into a finding." + } + } + }, + { + "$type": "ObjectType", + "name": "BooleanFilter", + "properties": { + "Value": { + "type": { + "$ref": "#/65" + }, + "flags": 1, + "description": "The value of the boolean." + } + } + }, + { + "$type": "ObjectType", + "name": "DateFilter", + "properties": { + "DateRange": { + "type": { + "$ref": "#/106" + }, + "flags": 0 + }, + "End": { + "type": { + "$ref": "#/22" + }, + "flags": 0 + }, + "Start": { + "type": { + "$ref": "#/22" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "DateRange", + "properties": { + "Unit": { + "type": { + "$ref": "#/22" + }, + "flags": 1, + "description": "A date range unit for the date filter." + }, + "Value": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "A date range value for the date filter." + } + } + }, + { + "$type": "ObjectType", + "name": "ISO8601DateString", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "IpFilter", + "properties": { + "Cidr": { + "type": { + "$ref": "#/22" + }, + "flags": 1, + "description": "A finding's CIDR value." + } + } + }, + { + "$type": "ObjectType", + "name": "KeywordFilter", + "properties": { + "Value": { + "type": { + "$ref": "#/22" + }, + "flags": 1, + "description": "A value for the keyword." + } + } + }, + { + "$type": "ObjectType", + "name": "MapFilter", + "properties": { + "Comparison": { + "type": { + "$ref": "#/22" + }, + "flags": 1, + "description": "The condition to apply to the key value when filtering Security Hub findings with a map filter." + }, + "Key": { + "type": { + "$ref": "#/22" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/22" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "NonEmptyString", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "NumberFilter", + "properties": { + "Eq": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "The equal-to condition to be applied to a single field when querying for findings." + }, + "Gte": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "The greater-than-equal condition to be applied to a single field when querying for findings." + }, + "Lte": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "The less-than-equal condition to be applied to a single field when querying for findings." + } + } + }, + { + "$type": "ObjectType", + "name": "StringFilter", + "properties": { + "Comparison": { + "type": { + "$ref": "#/22" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/22" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "StringFilterComparison", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/112" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/105" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/112" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/112" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/112" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/105" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/109" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/105" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/108" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/108" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/112" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/108" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/108" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/112" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/105" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/105" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/112" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/112" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/105" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/110" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/108" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/108" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/105" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/105" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/105" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/110" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/110" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/104" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/112" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/112" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/105" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/105" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/110" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/113" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.SecurityHub/InsightProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.SecurityHub/InsightProperties", + "properties": { + "Filters": { + "type": { + "$ref": "#/103" + }, + "flags": 1, + "description": "One or more attributes used to filter the findings included in the insight" + }, + "GroupByAttribute": { + "type": { + "$ref": "#/22" + }, + "flags": 1, + "description": "The grouping attribute for the insight's findings" + }, + "InsightArn": { + "type": { + "$ref": "#/22" + }, + "flags": 18, + "description": "The ARN of a Security Hub insight" + }, + "Name": { + "type": { + "$ref": "#/22" + }, + "flags": 1, + "description": "The name of a Security Hub insight" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SecurityHub/Insight", + "properties": { + "name": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/22" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/220" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SecurityHub/Insight@default", + "scopeType": 0, + "body": { + "$ref": "#/221" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.SecurityHub/OrganizationConfigurationProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.SecurityHub/OrganizationConfigurationProperties", + "properties": { + "AutoEnable": { + "type": { + "$ref": "#/65" + }, + "flags": 1, + "description": "Whether to automatically enable Security Hub in new member accounts when they join the organization." + }, + "AutoEnableStandards": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "Whether to automatically enable Security Hub default standards in new member accounts when they join the organization." + }, + "ConfigurationType": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "Indicates whether the organization uses local or central configuration." + }, + "MemberAccountLimitReached": { + "type": { + "$ref": "#/65" + }, + "flags": 2, + "description": "Whether the maximum number of allowed member accounts are already associated with the Security Hub administrator account." + }, + "OrganizationConfigurationIdentifier": { + "type": { + "$ref": "#/22" + }, + "flags": 18, + "description": "The identifier of the OrganizationConfiguration being created and assigned as the unique identifier." + }, + "Status": { + "type": { + "$ref": "#/22" + }, + "flags": 2, + "description": "Describes whether central configuration could be enabled as the ConfigurationType for the organization." + }, + "StatusMessage": { + "type": { + "$ref": "#/22" + }, + "flags": 2, + "description": "Provides an explanation if the value of Status is equal to FAILED when ConfigurationType is equal to CENTRAL." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SecurityHub/OrganizationConfiguration", + "properties": { + "name": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/22" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/224" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SecurityHub/OrganizationConfiguration@default", + "scopeType": 0, + "body": { + "$ref": "#/225" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.SecurityHub/PolicyAssociationProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.SecurityHub/PolicyAssociationProperties", + "properties": { + "AssociationIdentifier": { + "type": { + "$ref": "#/22" + }, + "flags": 18, + "description": "A unique identifier to indicates if the target has an association" + }, + "AssociationStatus": { + "type": { + "$ref": "#/22" + }, + "flags": 2, + "description": "The current status of the association between the specified target and the configuration" + }, + "AssociationStatusMessage": { + "type": { + "$ref": "#/22" + }, + "flags": 2, + "description": "An explanation for a FAILED value for AssociationStatus" + }, + "AssociationType": { + "type": { + "$ref": "#/22" + }, + "flags": 2, + "description": "Indicates whether the association between the specified target and the configuration was directly applied by the Security Hub delegated administrator or inherited from a parent" + }, + "ConfigurationPolicyId": { + "type": { + "$ref": "#/22" + }, + "flags": 1, + "description": "The universally unique identifier (UUID) of the configuration policy or a value of SELF_MANAGED_SECURITY_HUB for a self-managed configuration" + }, + "TargetId": { + "type": { + "$ref": "#/22" + }, + "flags": 1, + "description": "The identifier of the target account, organizational unit, or the root" + }, + "TargetType": { + "type": { + "$ref": "#/22" + }, + "flags": 1, + "description": "Indicates whether the target is an AWS account, organizational unit, or the organization root" + }, + "UpdatedAt": { + "type": { + "$ref": "#/22" + }, + "flags": 2, + "description": "The date and time, in UTC and ISO 8601 format, that the configuration policy association was last updated" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SecurityHub/PolicyAssociation", + "properties": { + "name": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/22" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/228" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SecurityHub/PolicyAssociation@default", + "scopeType": 0, + "body": { + "$ref": "#/229" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "IntegerList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "NonEmptyString", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "NonEmptyStringList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ParameterConfiguration", + "properties": { + "Value": { + "type": { + "$ref": "#/235" + }, + "flags": 0 + }, + "ValueType": { + "type": { + "$ref": "#/22" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ParameterValue", + "properties": { + "Boolean": { + "type": { + "$ref": "#/65" + }, + "flags": 0, + "description": "A control parameter that is a boolean." + }, + "Double": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "A control parameter that is a double." + }, + "Enum": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "A control parameter that is a enum." + }, + "EnumList": { + "type": { + "$ref": "#/239" + }, + "flags": 0, + "description": "A control parameter that is a list of enums." + }, + "Integer": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "A control parameter that is a integer." + }, + "IntegerList": { + "type": { + "$ref": "#/240" + }, + "flags": 0, + "description": "A control parameter that is a list of integers." + }, + "String": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "A control parameter that is a string." + }, + "StringList": { + "type": { + "$ref": "#/241" + }, + "flags": 0, + "description": "A control parameter that is a list of strings." + } + } + }, + { + "$type": "ObjectType", + "name": "Parameters", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/23" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/22" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/22" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/23" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/22" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.SecurityHub/SecurityControlProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.SecurityHub/SecurityControlProperties", + "properties": { + "LastUpdateReason": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "The most recent reason for updating the customizable properties of a security control. This differs from the UpdateReason field of the BatchUpdateStandardsControlAssociations API, which tracks the reason for updating the enablement status of a control. This field accepts alphanumeric characters in addition to white spaces, dashes, and underscores." + }, + "Parameters": { + "type": { + "$ref": "#/236" + }, + "flags": 1, + "description": "An object that identifies the name of a control parameter, its current value, and whether it has been customized." + }, + "SecurityControlArn": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) for a security control across standards, such as `arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1`. This parameter doesn't mention a specific standard." + }, + "SecurityControlId": { + "type": { + "$ref": "#/22" + }, + "flags": 16, + "description": "The unique identifier of a security control across standards. Values for this field typically consist of an AWS service name and a number, such as APIGateway.3." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SecurityHub/SecurityControl", + "properties": { + "name": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/22" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/243" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SecurityHub/SecurityControl@default", + "scopeType": 0, + "body": { + "$ref": "#/244" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "StandardsControl", + "properties": { + "Reason": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "A user-defined reason for changing a control's enablement status in a specified standard. If you are disabling a control, then this property is required." + }, + "StandardsControlArn": { + "type": { + "$ref": "#/22" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of the control." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.SecurityHub/StandardProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/246" + } + }, + { + "$type": "ObjectType", + "name": "AWS.SecurityHub/StandardProperties", + "properties": { + "DisabledStandardsControls": { + "type": { + "$ref": "#/248" + }, + "flags": 0, + "description": "Specifies which controls are to be disabled in a standard. \n *Maximum*: ``100``" + }, + "StandardsArn": { + "type": { + "$ref": "#/22" + }, + "flags": 1, + "description": "The ARN of the standard that you want to enable. To view a list of available ASH standards and their ARNs, use the [DescribeStandards](https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_DescribeStandards.html) API operation." + }, + "StandardsSubscriptionArn": { + "type": { + "$ref": "#/22" + }, + "flags": 18, + "description": "" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SecurityHub/Standard", + "properties": { + "name": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/22" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/249" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SecurityHub/Standard@default", + "scopeType": 0, + "body": { + "$ref": "#/250" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.securityhub/default/types.md b/artifacts/bicep/aws/aws.securityhub/default/types.md index ac7b8a2f..575d85d4 100644 --- a/artifacts/bicep/aws/aws.securityhub/default/types.md +++ b/artifacts/bicep/aws/aws.securityhub/default/types.md @@ -3,71 +3,76 @@ ## Resource AWS.SecurityHub/AutomationRule@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.SecurityHub/AutomationRuleProperties](#awssecurityhubautomationruleproperties): properties of the resource +* **properties**: [AWS.SecurityHub/AutomationRuleProperties](#awssecurityhubautomationruleproperties) (Identifier): properties of the resource + +## Resource AWS.SecurityHub/ConfigurationPolicy@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.SecurityHub/ConfigurationPolicyProperties](#awssecurityhubconfigurationpolicyproperties) (Required, Identifier): properties of the resource + +## Resource AWS.SecurityHub/FindingAggregator@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.SecurityHub/FindingAggregatorProperties](#awssecurityhubfindingaggregatorproperties) (Required, Identifier): properties of the resource ## Resource AWS.SecurityHub/Hub@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.SecurityHub/HubProperties](#awssecurityhubhubproperties): properties of the resource +* **properties**: [AWS.SecurityHub/HubProperties](#awssecurityhubhubproperties) (Identifier): properties of the resource -## Resource AWS.SecurityHub/Standard@default +## Resource AWS.SecurityHub/Insight@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.SecurityHub/StandardProperties](#awssecurityhubstandardproperties) (Required): properties of the resource +* **properties**: [AWS.SecurityHub/InsightProperties](#awssecurityhubinsightproperties) (Required, Identifier): properties of the resource -## AWS.SecurityHub/AutomationRuleProperties +## Resource AWS.SecurityHub/OrganizationConfiguration@default +* **Valid Scope(s)**: Unknown ### Properties -* **Actions**: [AutomationRulesAction](#automationrulesaction)[] -* **CreatedAt**: string (ReadOnly): The date and time when Automation Rule was created -* **CreatedBy**: string (ReadOnly): The identifier by which created the rule -* **Criteria**: [AutomationRulesFindingFilters](#automationrulesfindingfilters): The rule criteria for evaluating findings -* **Description**: string: Rule description -* **IsTerminal**: bool: If Rule is a terminal rule -* **RuleArn**: string (ReadOnly, Identifier): An Automation Rule Arn is automatically created -* **RuleName**: string: Rule name -* **RuleOrder**: int: Rule order value -* **RuleStatus**: string: Status of the Rule upon creation -* **Tags**: [Tags](#tags) -* **UpdatedAt**: string (ReadOnly): The date and time when Automation Rule was last updated +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.SecurityHub/OrganizationConfigurationProperties](#awssecurityhuborganizationconfigurationproperties) (Required, Identifier): properties of the resource -## AutomationRulesAction +## Resource AWS.SecurityHub/PolicyAssociation@default +* **Valid Scope(s)**: Unknown ### Properties -* **FindingFieldsUpdate**: [AutomationRulesFindingFieldsUpdate](#automationrulesfindingfieldsupdate) (Required) -* **Type**: string (Required) +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.SecurityHub/PolicyAssociationProperties](#awssecurityhubpolicyassociationproperties) (Required, Identifier): properties of the resource -## AutomationRulesFindingFieldsUpdate +## Resource AWS.SecurityHub/SecurityControl@default +* **Valid Scope(s)**: Unknown ### Properties -* **Confidence**: int -* **Criticality**: int -* **Note**: [AutomationRule_NoteUpdate](#automationrulenoteupdate): Note added to the finding -* **RelatedFindings**: [RelatedFinding](#relatedfinding)[] -* **Severity**: [AutomationRule_SeverityUpdate](#automationruleseverityupdate): Severity of the finding -* **Types**: string[] -* **UserDefinedFields**: [map](#map) -* **VerificationState**: string -* **Workflow**: [AutomationRule_WorkflowUpdate](#automationruleworkflowupdate): Workflow status set for the finding +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.SecurityHub/SecurityControlProperties](#awssecurityhubsecuritycontrolproperties) (Required, Identifier): properties of the resource -## AutomationRule_NoteUpdate +## Resource AWS.SecurityHub/Standard@default +* **Valid Scope(s)**: Unknown ### Properties -* **Text**: string (Required) -* **UpdatedBy**: [AutomationRule_arnOrId](#automationrulearnorid) (Required) +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.SecurityHub/StandardProperties](#awssecurityhubstandardproperties) (Required, Identifier): properties of the resource ## AutomationRule_arnOrId ### Properties -## RelatedFinding +## AutomationRule_arnOrId ### Properties -* **Id**: [AutomationRule_arnOrId](#automationrulearnorid) (Required) -* **ProductArn**: string (Required) -## AutomationRule_arnOrId +## AutomationRule_NoteUpdate ### Properties +* **Text**: string (Required) +* **UpdatedBy**: [AutomationRule_arnOrId](#automationrulearnorid) (Required) ## AutomationRule_SeverityUpdate ### Properties @@ -75,13 +80,27 @@ * **Normalized**: int * **Product**: int -## map -### Properties - ## AutomationRule_WorkflowUpdate ### Properties * **Status**: string (Required) +## AutomationRulesAction +### Properties +* **FindingFieldsUpdate**: [AutomationRulesFindingFieldsUpdate](#automationrulesfindingfieldsupdate) (Required) +* **Type**: string (Required) + +## AutomationRulesFindingFieldsUpdate +### Properties +* **Confidence**: int +* **Criticality**: int +* **Note**: [AutomationRule_NoteUpdate](#automationrulenoteupdate): The rule action will update the ``Note`` field of a finding. +* **RelatedFindings**: [RelatedFinding](#relatedfinding)[]: The rule action will update the ``RelatedFindings`` field of a finding. +* **Severity**: [AutomationRule_SeverityUpdate](#automationruleseverityupdate): The rule action will update the ``Severity`` field of a finding. +* **Types**: string[] +* **UserDefinedFields**: [map](#map) +* **VerificationState**: string +* **Workflow**: [AutomationRule_WorkflowUpdate](#automationruleworkflowupdate): The rule action will update the ``Workflow`` field of a finding. + ## AutomationRulesFindingFilters ### Properties * **AwsAccountId**: [StringFilter](#stringfilter)[] @@ -120,16 +139,204 @@ * **VerificationState**: [StringFilter](#stringfilter)[] * **WorkflowStatus**: [StringFilter](#stringfilter)[] -## StringFilter +## AWS.SecurityHub/AutomationRuleProperties ### Properties -* **Comparison**: string (Required) -* **Value**: string (Required) +* **Actions**: [AutomationRulesAction](#automationrulesaction)[] +* **CreatedAt**: string (ReadOnly) +* **CreatedBy**: string (ReadOnly) +* **Criteria**: [AutomationRulesFindingFilters](#automationrulesfindingfilters): A set of [Security Finding Format (ASFF)](https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format.html) finding field attributes and corresponding expected values that ASH uses to filter findings. If a rule is enabled and a finding matches the criteria specified in this parameter, ASH applies the rule action to the finding. +* **Description**: string +* **IsTerminal**: bool +* **RuleArn**: string (ReadOnly, Identifier) +* **RuleName**: string +* **RuleOrder**: int +* **RuleStatus**: string: Whether the rule is active after it is created. If this parameter is equal to ``ENABLED``, ASH applies the rule to findings and finding updates after the rule is created. +* **Tags**: [Tags](#tags) +* **UpdatedAt**: string (ReadOnly) -## NumberFilter +## AWS.SecurityHub/ConfigurationPolicyProperties +### Properties +* **Arn**: string (ReadOnly, Identifier): The Amazon Resource Name (ARN) of the configuration policy. +* **ConfigurationPolicy**: [Policy](#policy) (Required) +* **CreatedAt**: string (ReadOnly): The date and time, in UTC and ISO 8601 format. +* **Description**: string: The description of the configuration policy. +* **Id**: string (ReadOnly): The universally unique identifier (UUID) of the configuration policy. +* **Name**: string (Required): The name of the configuration policy. +* **ServiceEnabled**: bool (ReadOnly): Indicates whether the service that the configuration policy applies to is enabled in the policy. +* **Tags**: [Tags](#tags) +* **UpdatedAt**: string (ReadOnly): The date and time, in UTC and ISO 8601 format. + +## AWS.SecurityHub/FindingAggregatorProperties +### Properties +* **FindingAggregationRegion**: string (ReadOnly): The aggregation Region of the FindingAggregator +* **FindingAggregatorArn**: string (ReadOnly, Identifier): The ARN of the FindingAggregator being created and assigned as the unique identifier +* **RegionLinkingMode**: string (Required): Indicates whether to link all Regions, all Regions except for a list of excluded Regions, or a list of included Regions +* **Regions**: string[]: The list of excluded Regions or included Regions + +## AWS.SecurityHub/HubProperties +### Properties +* **ARN**: string (ReadOnly, Identifier): An ARN is automatically created for the customer. +* **AutoEnableControls**: bool: Whether to automatically enable new controls when they are added to standards that are enabled +* **ControlFindingGenerator**: string: This field, used when enabling Security Hub, specifies whether the calling account has consolidated control findings turned on. If the value for this field is set to SECURITY_CONTROL, Security Hub generates a single finding for a control check even when the check applies to multiple enabled standards. If the value for this field is set to STANDARD_CONTROL, Security Hub generates separate findings for a control check when the check applies to multiple enabled standards. +* **EnableDefaultStandards**: bool (WriteOnly): Whether to enable the security standards that Security Hub has designated as automatically enabled. +* **SubscribedAt**: string (ReadOnly): The date and time when Security Hub was enabled in the account. +* **Tags**: [Tags](#tags) + +## AWS.SecurityHub/InsightProperties +### Properties +* **Filters**: [AwsSecurityFindingFilters](#awssecurityfindingfilters) (Required): One or more attributes used to filter the findings included in the insight +* **GroupByAttribute**: string (Required): The grouping attribute for the insight's findings +* **InsightArn**: string (ReadOnly, Identifier): The ARN of a Security Hub insight +* **Name**: string (Required): The name of a Security Hub insight + +## AWS.SecurityHub/OrganizationConfigurationProperties +### Properties +* **AutoEnable**: bool (Required): Whether to automatically enable Security Hub in new member accounts when they join the organization. +* **AutoEnableStandards**: string: Whether to automatically enable Security Hub default standards in new member accounts when they join the organization. +* **ConfigurationType**: string: Indicates whether the organization uses local or central configuration. +* **MemberAccountLimitReached**: bool (ReadOnly): Whether the maximum number of allowed member accounts are already associated with the Security Hub administrator account. +* **OrganizationConfigurationIdentifier**: string (ReadOnly, Identifier): The identifier of the OrganizationConfiguration being created and assigned as the unique identifier. +* **Status**: string (ReadOnly): Describes whether central configuration could be enabled as the ConfigurationType for the organization. +* **StatusMessage**: string (ReadOnly): Provides an explanation if the value of Status is equal to FAILED when ConfigurationType is equal to CENTRAL. + +## AWS.SecurityHub/PolicyAssociationProperties +### Properties +* **AssociationIdentifier**: string (ReadOnly, Identifier): A unique identifier to indicates if the target has an association +* **AssociationStatus**: string (ReadOnly): The current status of the association between the specified target and the configuration +* **AssociationStatusMessage**: string (ReadOnly): An explanation for a FAILED value for AssociationStatus +* **AssociationType**: string (ReadOnly): Indicates whether the association between the specified target and the configuration was directly applied by the Security Hub delegated administrator or inherited from a parent +* **ConfigurationPolicyId**: string (Required): The universally unique identifier (UUID) of the configuration policy or a value of SELF_MANAGED_SECURITY_HUB for a self-managed configuration +* **TargetId**: string (Required): The identifier of the target account, organizational unit, or the root +* **TargetType**: string (Required): Indicates whether the target is an AWS account, organizational unit, or the organization root +* **UpdatedAt**: string (ReadOnly): The date and time, in UTC and ISO 8601 format, that the configuration policy association was last updated + +## AWS.SecurityHub/SecurityControlProperties +### Properties +* **LastUpdateReason**: string: The most recent reason for updating the customizable properties of a security control. This differs from the UpdateReason field of the BatchUpdateStandardsControlAssociations API, which tracks the reason for updating the enablement status of a control. This field accepts alphanumeric characters in addition to white spaces, dashes, and underscores. +* **Parameters**: [Parameters](#parameters) (Required): An object that identifies the name of a control parameter, its current value, and whether it has been customized. +* **SecurityControlArn**: string: The Amazon Resource Name (ARN) for a security control across standards, such as `arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1`. This parameter doesn't mention a specific standard. +* **SecurityControlId**: string (Identifier): The unique identifier of a security control across standards. Values for this field typically consist of an AWS service name and a number, such as APIGateway.3. + +## AWS.SecurityHub/StandardProperties +### Properties +* **DisabledStandardsControls**: [StandardsControl](#standardscontrol)[]: Specifies which controls are to be disabled in a standard. + *Maximum*: ``100`` +* **StandardsArn**: string (Required): The ARN of the standard that you want to enable. To view a list of available ASH standards and their ARNs, use the [DescribeStandards](https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_DescribeStandards.html) API operation. +* **StandardsSubscriptionArn**: string (ReadOnly, Identifier) + +## AwsSecurityFindingFilters +### Properties +* **AwsAccountId**: [StringFilter](#stringfilter)[]: The AWS account ID in which a finding is generated. +* **AwsAccountName**: [StringFilter](#stringfilter)[]: The name of the AWS account in which a finding is generated. +* **CompanyName**: [StringFilter](#stringfilter)[]: The name of the findings provider (company) that owns the solution (product) that generates findings. +* **ComplianceAssociatedStandardsId**: [StringFilter](#stringfilter)[]: The unique identifier of a standard in which a control is enabled. +* **ComplianceSecurityControlId**: [StringFilter](#stringfilter)[]: The unique identifier of a control across standards. +* **ComplianceSecurityControlParametersName**: [StringFilter](#stringfilter)[]: The name of a security control parameter. +* **ComplianceSecurityControlParametersValue**: [StringFilter](#stringfilter)[]: The current value of a security control parameter. +* **ComplianceStatus**: [StringFilter](#stringfilter)[]: Exclusive to findings that are generated as the result of a check run against a specific rule in a supported standard. +* **Confidence**: [NumberFilter](#numberfilter)[]: A finding's confidence. +* **CreatedAt**: [DateFilter](#datefilter)[]: An ISO8601-formatted timestamp that indicates when the security findings provider captured the potential security issue that a finding captured. +* **Criticality**: [NumberFilter](#numberfilter)[]: The level of importance assigned to the resources associated with the finding. +* **Description**: [StringFilter](#stringfilter)[]: A finding's description. +* **FindingProviderFieldsConfidence**: [NumberFilter](#numberfilter)[]: The finding provider value for the finding confidence. +* **FindingProviderFieldsCriticality**: [NumberFilter](#numberfilter)[]: The finding provider value for the level of importance assigned to the resources associated with the findings. +* **FindingProviderFieldsRelatedFindingsId**: [StringFilter](#stringfilter)[]: The finding identifier of a related finding that is identified by the finding provider. +* **FindingProviderFieldsRelatedFindingsProductArn**: [StringFilter](#stringfilter)[]: The ARN of the solution that generated a related finding that is identified by the finding provider. +* **FindingProviderFieldsSeverityLabel**: [StringFilter](#stringfilter)[]: The finding provider value for the severity label. +* **FindingProviderFieldsSeverityOriginal**: [StringFilter](#stringfilter)[]: The finding provider's original value for the severity. +* **FindingProviderFieldsTypes**: [StringFilter](#stringfilter)[]: One or more finding types that the finding provider assigned to the finding. +* **FirstObservedAt**: [DateFilter](#datefilter)[]: An ISO8601-formatted timestamp that indicates when the security findings provider first observed the potential security issue that a finding captured. +* **GeneratorId**: [StringFilter](#stringfilter)[]: The identifier for the solution-specific component (a discrete unit of logic) that generated a finding. +* **Id**: [StringFilter](#stringfilter)[]: The security findings provider-specific identifier for a finding. +* **Keyword**: [KeywordFilter](#keywordfilter)[]: A keyword for a finding. +* **LastObservedAt**: [DateFilter](#datefilter)[]: An ISO8601-formatted timestamp that indicates when the security findings provider most recently observed the potential security issue that a finding captured. +* **MalwareName**: [StringFilter](#stringfilter)[]: The name of the malware that was observed. +* **MalwarePath**: [StringFilter](#stringfilter)[]: The filesystem path of the malware that was observed. +* **MalwareState**: [StringFilter](#stringfilter)[]: The state of the malware that was observed. +* **MalwareType**: [StringFilter](#stringfilter)[]: The type of the malware that was observed. +* **NetworkDestinationDomain**: [StringFilter](#stringfilter)[]: The destination domain of network-related information about a finding. +* **NetworkDestinationIpV4**: [IpFilter](#ipfilter)[]: The destination IPv4 address of network-related information about a finding. +* **NetworkDestinationIpV6**: [IpFilter](#ipfilter)[]: The destination IPv6 address of network-related information about a finding. +* **NetworkDestinationPort**: [NumberFilter](#numberfilter)[]: The destination port of network-related information about a finding. +* **NetworkDirection**: [StringFilter](#stringfilter)[]: Indicates the direction of network traffic associated with a finding. +* **NetworkProtocol**: [StringFilter](#stringfilter)[]: The protocol of network-related information about a finding. +* **NetworkSourceDomain**: [StringFilter](#stringfilter)[]: The source domain of network-related information about a finding. +* **NetworkSourceIpV4**: [IpFilter](#ipfilter)[]: The source IPv4 address of network-related information about a finding. +* **NetworkSourceIpV6**: [IpFilter](#ipfilter)[]: The source IPv6 address of network-related information about a finding. +* **NetworkSourceMac**: [StringFilter](#stringfilter)[]: The source media access control (MAC) address of network-related information about a finding. +* **NetworkSourcePort**: [NumberFilter](#numberfilter)[]: The source port of network-related information about a finding. +* **NoteText**: [StringFilter](#stringfilter)[]: The text of a note. +* **NoteUpdatedAt**: [DateFilter](#datefilter)[]: The timestamp of when the note was updated. +* **NoteUpdatedBy**: [StringFilter](#stringfilter)[]: The principal that created a note. +* **ProcessLaunchedAt**: [DateFilter](#datefilter)[]: A timestamp that identifies when the process was launched. +* **ProcessName**: [StringFilter](#stringfilter)[]: The name of the process. +* **ProcessParentPid**: [NumberFilter](#numberfilter)[]: The parent process ID. +* **ProcessPath**: [StringFilter](#stringfilter)[]: The path to the process executable. +* **ProcessPid**: [NumberFilter](#numberfilter)[]: The process ID. +* **ProcessTerminatedAt**: [DateFilter](#datefilter)[]: A timestamp that identifies when the process was terminated. +* **ProductArn**: [StringFilter](#stringfilter)[]: The ARN generated by Security Hub that uniquely identifies a third-party company (security findings provider) after this provider's product (solution that generates findings) is registered with Security Hub. +* **ProductFields**: [MapFilter](#mapfilter)[]: A data type where security findings providers can include additional solution-specific details that aren't part of the defined AwsSecurityFinding format. +* **ProductName**: [StringFilter](#stringfilter)[]: The name of the solution (product) that generates findings. +* **RecommendationText**: [StringFilter](#stringfilter)[]: The recommendation of what to do about the issue described in a finding. +* **RecordState**: [StringFilter](#stringfilter)[]: The updated record state for the finding. +* **Region**: [StringFilter](#stringfilter)[]: The Region from which the finding was generated. +* **RelatedFindingsId**: [StringFilter](#stringfilter)[]: The solution-generated identifier for a related finding. +* **RelatedFindingsProductArn**: [StringFilter](#stringfilter)[]: The ARN of the solution that generated a related finding. +* **ResourceApplicationArn**: [StringFilter](#stringfilter)[]: The ARN of the application that is related to a finding. +* **ResourceApplicationName**: [StringFilter](#stringfilter)[]: The name of the application that is related to a finding. +* **ResourceAwsEc2InstanceIamInstanceProfileArn**: [StringFilter](#stringfilter)[]: The IAM profile ARN of the instance. +* **ResourceAwsEc2InstanceImageId**: [StringFilter](#stringfilter)[]: The Amazon Machine Image (AMI) ID of the instance. +* **ResourceAwsEc2InstanceIpV4Addresses**: [IpFilter](#ipfilter)[]: The IPv4 addresses associated with the instance. +* **ResourceAwsEc2InstanceIpV6Addresses**: [IpFilter](#ipfilter)[]: The IPv6 addresses associated with the instance. +* **ResourceAwsEc2InstanceKeyName**: [StringFilter](#stringfilter)[]: The key name associated with the instance. +* **ResourceAwsEc2InstanceLaunchedAt**: [DateFilter](#datefilter)[]: The date and time the instance was launched. +* **ResourceAwsEc2InstanceSubnetId**: [StringFilter](#stringfilter)[]: The identifier of the subnet that the instance was launched in. +* **ResourceAwsEc2InstanceType**: [StringFilter](#stringfilter)[]: The instance type of the instance. +* **ResourceAwsEc2InstanceVpcId**: [StringFilter](#stringfilter)[]: The identifier of the VPC that the instance was launched in. +* **ResourceAwsIamAccessKeyCreatedAt**: [DateFilter](#datefilter)[]: The creation date/time of the IAM access key related to a finding. +* **ResourceAwsIamAccessKeyPrincipalName**: [StringFilter](#stringfilter)[]: The name of the principal that is associated with an IAM access key. +* **ResourceAwsIamAccessKeyStatus**: [StringFilter](#stringfilter)[]: The status of the IAM access key related to a finding. +* **ResourceAwsIamAccessKeyUserName**: [StringFilter](#stringfilter)[]: The user associated with the IAM access key related to a finding. +* **ResourceAwsIamUserUserName**: [StringFilter](#stringfilter)[]: The name of an IAM user. +* **ResourceAwsS3BucketOwnerId**: [StringFilter](#stringfilter)[]: The canonical user ID of the owner of the S3 bucket. +* **ResourceAwsS3BucketOwnerName**: [StringFilter](#stringfilter)[]: The display name of the owner of the S3 bucket. +* **ResourceContainerImageId**: [StringFilter](#stringfilter)[]: The identifier of the image related to a finding. +* **ResourceContainerImageName**: [StringFilter](#stringfilter)[]: The name of the image related to a finding. +* **ResourceContainerLaunchedAt**: [DateFilter](#datefilter)[]: A timestamp that identifies when the container was started. +* **ResourceContainerName**: [StringFilter](#stringfilter)[]: The name of the container related to a finding. +* **ResourceDetailsOther**: [MapFilter](#mapfilter)[]: The details of a resource that doesn't have a specific subfield for the resource type defined. +* **ResourceId**: [StringFilter](#stringfilter)[]: The canonical identifier for the given resource type. +* **ResourcePartition**: [StringFilter](#stringfilter)[]: The canonical AWS partition name that the Region is assigned to. +* **ResourceRegion**: [StringFilter](#stringfilter)[]: The canonical AWS external Region name where this resource is located. +* **ResourceTags**: [MapFilter](#mapfilter)[]: A list of AWS tags associated with a resource at the time the finding was processed. +* **ResourceType**: [StringFilter](#stringfilter)[]: Specifies the type of the resource that details are provided for. +* **Sample**: [BooleanFilter](#booleanfilter)[]: Indicates whether or not sample findings are included in the filter results. +* **SeverityLabel**: [StringFilter](#stringfilter)[]: The label of a finding's severity. +* **SeverityNormalized**: [NumberFilter](#numberfilter)[]: The normalized severity of a finding. +* **SeverityProduct**: [NumberFilter](#numberfilter)[]: The native severity as defined by the security findings provider's solution that generated the finding. +* **SourceUrl**: [StringFilter](#stringfilter)[]: A URL that links to a page about the current finding in the security findings provider's solution. +* **ThreatIntelIndicatorCategory**: [StringFilter](#stringfilter)[]: The category of a threat intelligence indicator. +* **ThreatIntelIndicatorLastObservedAt**: [DateFilter](#datefilter)[]: A timestamp that identifies the last observation of a threat intelligence indicator. +* **ThreatIntelIndicatorSource**: [StringFilter](#stringfilter)[]: The source of the threat intelligence. +* **ThreatIntelIndicatorSourceUrl**: [StringFilter](#stringfilter)[]: The URL for more details from the source of the threat intelligence. +* **ThreatIntelIndicatorType**: [StringFilter](#stringfilter)[]: The type of a threat intelligence indicator. +* **ThreatIntelIndicatorValue**: [StringFilter](#stringfilter)[]: The value of a threat intelligence indicator. +* **Title**: [StringFilter](#stringfilter)[]: A finding's title. +* **Type**: [StringFilter](#stringfilter)[]: A finding type in the format of namespace/category/classifier that classifies a finding. +* **UpdatedAt**: [DateFilter](#datefilter)[]: An ISO8601-formatted timestamp that indicates when the security findings provider last updated the finding record. +* **UserDefinedFields**: [MapFilter](#mapfilter)[]: A list of name/value string pairs associated with the finding. +* **VerificationState**: [StringFilter](#stringfilter)[]: The veracity of a finding. +* **VulnerabilitiesExploitAvailable**: [StringFilter](#stringfilter)[]: Indicates whether a software vulnerability in your environment has a known exploit. +* **VulnerabilitiesFixAvailable**: [StringFilter](#stringfilter)[]: Indicates whether a vulnerability is fixed in a newer version of the affected software packages. +* **WorkflowState**: [StringFilter](#stringfilter)[]: The workflow state of a finding. +* **WorkflowStatus**: [StringFilter](#stringfilter)[]: The status of the investigation into a finding. + +## BooleanFilter +### Properties +* **Value**: bool (Required): The value of the boolean. + +## ConfigurationPolicy_Parameters ### Properties -* **Eq**: int (Required) -* **Gte**: int -* **Lte**: int ## DateFilter ### Properties @@ -137,40 +344,107 @@ * **End**: string * **Start**: string +## DateFilter +### Properties +* **DateRange**: [DateRange](#daterange) +* **End**: string +* **Start**: string + ## DateRange ### Properties * **Unit**: string (Required) * **Value**: int (Required) +## DateRange +### Properties +* **Unit**: string (Required): A date range unit for the date filter. +* **Value**: int (Required): A date range value for the date filter. + +## IpFilter +### Properties +* **Cidr**: string (Required): A finding's CIDR value. + +## KeywordFilter +### Properties +* **Value**: string (Required): A value for the keyword. + +## map +### Properties + ## MapFilter ### Properties * **Comparison**: string (Required) * **Key**: string (Required) * **Value**: string (Required) -## Tags +## MapFilter ### Properties +* **Comparison**: string (Required): The condition to apply to the key value when filtering Security Hub findings with a map filter. +* **Key**: string (Required) +* **Value**: string (Required) -## AWS.SecurityHub/HubProperties +## NumberFilter ### Properties -* **ARN**: string (ReadOnly, Identifier): An ARN is automatically created for the customer. -* **AutoEnableControls**: bool: Whether to automatically enable new controls when they are added to standards that are enabled -* **ControlFindingGenerator**: string: This field, used when enabling Security Hub, specifies whether the calling account has consolidated control findings turned on. If the value for this field is set to SECURITY_CONTROL, Security Hub generates a single finding for a control check even when the check applies to multiple enabled standards. If the value for this field is set to STANDARD_CONTROL, Security Hub generates separate findings for a control check when the check applies to multiple enabled standards. -* **EnableDefaultStandards**: bool (WriteOnly): Whether to enable the security standards that Security Hub has designated as automatically enabled. -* **SubscribedAt**: string (ReadOnly): The date and time when Security Hub was enabled in the account. -* **Tags**: [Tags](#tags) +* **Eq**: int (Required) +* **Gte**: int +* **Lte**: int -## Tags +## NumberFilter ### Properties +* **Eq**: int: The equal-to condition to be applied to a single field when querying for findings. +* **Gte**: int: The greater-than-equal condition to be applied to a single field when querying for findings. +* **Lte**: int: The less-than-equal condition to be applied to a single field when querying for findings. -## AWS.SecurityHub/StandardProperties +## Parameters +### Properties + +## Policy +### Properties +* **SecurityHub**: [SecurityHubPolicy](#securityhubpolicy) + +## RelatedFinding +### Properties +* **Id**: [AutomationRule_arnOrId](#automationrulearnorid) (Required) +* **ProductArn**: string (Required): The Amazon Resource Name (ARN) for the product that generated a related finding. + +## SecurityControlCustomParameter +### Properties +* **Parameters**: [ConfigurationPolicy_Parameters](#configurationpolicyparameters): An object that specifies parameter values for a control in a configuration policy. +* **SecurityControlId**: string: The ID of the security control. + +## SecurityControlsConfiguration +### Properties +* **DisabledSecurityControlIdentifiers**: string[]: A list of security controls that are disabled in the configuration policy +* **EnabledSecurityControlIdentifiers**: string[]: A list of security controls that are enabled in the configuration policy. +* **SecurityControlCustomParameters**: [SecurityControlCustomParameter](#securitycontrolcustomparameter)[]: A list of security controls and control parameter values that are included in a configuration policy. + +## SecurityHubPolicy ### Properties -* **DisabledStandardsControls**: [StandardsControl](#standardscontrol)[]: StandardsControls to disable from this Standard. -* **StandardsArn**: string (Required): The ARN of the Standard being enabled -* **StandardsSubscriptionArn**: string (ReadOnly, Identifier): The ARN of the StandardsSubscription for the account ID, region, and Standard. +* **EnabledStandardIdentifiers**: string[]: A list that defines which security standards are enabled in the configuration policy. +* **SecurityControlsConfiguration**: [SecurityControlsConfiguration](#securitycontrolsconfiguration) +* **ServiceEnabled**: bool: Indicates whether Security Hub is enabled in the policy. ## StandardsControl ### Properties -* **Reason**: string: the reason the standard control is disabled -* **StandardsControlArn**: string (Required): the Arn for the standard control. +* **Reason**: string: A user-defined reason for changing a control's enablement status in a specified standard. If you are disabling a control, then this property is required. +* **StandardsControlArn**: string (Required): The Amazon Resource Name (ARN) of the control. + +## StringFilter +### Properties +* **Comparison**: string (Required) +* **Value**: string (Required) + +## StringFilter +### Properties +* **Comparison**: string (Required) +* **Value**: string (Required) + +## Tags +### Properties + +## Tags +### Properties + +## Tags +### Properties diff --git a/artifacts/bicep/aws/aws.securitylake/default/types.json b/artifacts/bicep/aws/aws.securitylake/default/types.json new file mode 100644 index 00000000..9bcdead3 --- /dev/null +++ b/artifacts/bicep/aws/aws.securitylake/default/types.json @@ -0,0 +1,697 @@ +[ + { + "$type": "StringLiteralType", + "value": "AWS.SecurityLake/AwsLogSourceProperties" + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "AWS.SecurityLake/AwsLogSourceProperties", + "properties": { + "Accounts": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "AWS account where you want to collect logs from." + }, + "DataLakeArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The ARN for the data lake." + }, + "SourceName": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The name for a AWS source. This must be a Regionally unique value." + }, + "SourceVersion": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The version for a AWS source. This must be a Regionally unique value." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SecurityLake/AwsLogSource", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SecurityLake/AwsLogSource@default", + "scopeType": 0, + "body": { + "$ref": "#/4" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Days", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "EncryptionConfiguration", + "properties": { + "KmsKeyId": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The id of KMS encryption key used by Amazon Security Lake to encrypt the Security Lake object." + } + } + }, + { + "$type": "ObjectType", + "name": "Expiration", + "properties": { + "Days": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "LifecycleConfiguration", + "properties": { + "Expiration": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "Transitions": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "Provides data storage transition details of Amazon Security Lake object." + } + } + }, + { + "$type": "ObjectType", + "name": "Regions", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ReplicationConfiguration", + "properties": { + "Regions": { + "type": { + "$ref": "#/17" + }, + "flags": 0 + }, + "RoleArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Replication 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." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, `_`, `.`, `/`, `=`, `+`, and `-`." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 characters in length." + } + } + }, + { + "$type": "ObjectType", + "name": "Transitions", + "properties": { + "Days": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "Number of days before data transitions to a different S3 Storage Class in the Amazon Security Lake object." + }, + "StorageClass": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The range of storage classes that you can choose from based on the data access, resiliency, and cost requirements of your workloads." + } + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.SecurityLake/DataLakeProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/12" + } + }, + { + "$type": "ObjectType", + "name": "AWS.SecurityLake/DataLakeProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) created by you to provide to the subscriber." + }, + "EncryptionConfiguration": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "LifecycleConfiguration": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "MetaStoreManagerRoleArn": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The Amazon Resource Name (ARN) used to index AWS Glue table partitions that are generated by the ingestion and normalization of AWS log sources and custom sources." + }, + "ReplicationConfiguration": { + "type": { + "$ref": "#/11" + }, + "flags": 0 + }, + "S3BucketArn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The ARN for the Amazon Security Lake Amazon S3 bucket." + }, + "Tags": { + "type": { + "$ref": "#/19" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SecurityLake/DataLake", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/20" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SecurityLake/DataLake@default", + "scopeType": 0, + "body": { + "$ref": "#/21" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AccessTypes", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AwsLogSource", + "properties": { + "SourceName": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The name for a AWS source. This must be a Regionally unique value." + }, + "SourceVersion": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The version for a AWS source. This must be a Regionally unique value." + } + } + }, + { + "$type": "ObjectType", + "name": "CustomLogSource", + "properties": { + "SourceName": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The name for a third-party custom source. This must be a Regionally unique value." + }, + "SourceVersion": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The version for a third-party custom source. This must be a Regionally unique value." + } + } + }, + { + "$type": "ObjectType", + "name": "Source", + "properties": { + "AwsLogSource": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "CustomLogSource": { + "type": { + "$ref": "#/25" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The name of the tag. This is a general label that acts as a category for a more specific tag value (value)." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value that is associated with the specified tag key (key). This value acts as a descriptor for the tag key. A tag value cannot be null, but it can be an empty string." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.SecurityLake/SubscriberProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/26" + } + }, + { + "$type": "ObjectType", + "name": "Subscriber_SubscriberIdentity", + "properties": { + "ExternalId": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The external ID used to establish trust relationship with the AWS identity." + }, + "Principal": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The AWS identity principal." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/27" + } + }, + { + "$type": "ObjectType", + "name": "AWS.SecurityLake/SubscriberProperties", + "properties": { + "AccessTypes": { + "type": { + "$ref": "#/30" + }, + "flags": 1 + }, + "DataLakeArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The ARN for the data lake." + }, + "ResourceShareArn": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "ResourceShareName": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "S3BucketArn": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "Sources": { + "type": { + "$ref": "#/31" + }, + "flags": 1, + "description": "The supported AWS services from which logs and events are collected." + }, + "SubscriberArn": { + "type": { + "$ref": "#/1" + }, + "flags": 18 + }, + "SubscriberDescription": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The description for your subscriber account in Security Lake." + }, + "SubscriberIdentity": { + "type": { + "$ref": "#/32" + }, + "flags": 1, + "description": "The AWS identity used to access your data." + }, + "SubscriberName": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The name of your Security Lake subscriber account." + }, + "SubscriberRoleArn": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "Tags": { + "type": { + "$ref": "#/33" + }, + "flags": 0, + "description": "An array of objects, one for each tag to associate with the subscriber. For each tag, you must specify both a tag key and a tag value. A tag value cannot be null, but it can be an empty string." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SecurityLake/Subscriber", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/34" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SecurityLake/Subscriber@default", + "scopeType": 0, + "body": { + "$ref": "#/35" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "HttpsNotificationConfiguration", + "properties": { + "AuthorizationApiKeyName": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The key name for the notification subscription." + }, + "AuthorizationApiKeyValue": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The key value for the notification subscription." + }, + "Endpoint": { + "type": { + "$ref": "#/1" + }, + "flags": 5, + "description": "The subscription endpoint in Security Lake." + }, + "HttpMethod": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The HTTPS method used for the notification subscription." + }, + "TargetRoleArn": { + "type": { + "$ref": "#/1" + }, + "flags": 5, + "description": "The Amazon Resource Name (ARN) of the EventBridge API destinations IAM role that you created." + } + } + }, + { + "$type": "ObjectType", + "name": "NotificationConfiguration", + "properties": { + "HttpsNotificationConfiguration": { + "type": { + "$ref": "#/37" + }, + "flags": 0 + }, + "SqsNotificationConfiguration": { + "type": { + "$ref": "#/39" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SqsNotificationConfiguration", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.SecurityLake/SubscriberNotificationProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.SecurityLake/SubscriberNotificationProperties", + "properties": { + "NotificationConfiguration": { + "type": { + "$ref": "#/38" + }, + "flags": 1 + }, + "SubscriberArn": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The ARN for the subscriber" + }, + "SubscriberEndpoint": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The endpoint the subscriber should listen to for notifications" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SecurityLake/SubscriberNotification", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/41" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SecurityLake/SubscriberNotification@default", + "scopeType": 0, + "body": { + "$ref": "#/42" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.securitylake/default/types.md b/artifacts/bicep/aws/aws.securitylake/default/types.md new file mode 100644 index 00000000..83043b28 --- /dev/null +++ b/artifacts/bicep/aws/aws.securitylake/default/types.md @@ -0,0 +1,137 @@ +# AWS.SecurityLake @ default + +## Resource AWS.SecurityLake/AwsLogSource@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.SecurityLake/AwsLogSourceProperties](#awssecuritylakeawslogsourceproperties) (Required, Identifier): properties of the resource + +## Resource AWS.SecurityLake/DataLake@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.SecurityLake/DataLakeProperties](#awssecuritylakedatalakeproperties) (Identifier): properties of the resource + +## Resource AWS.SecurityLake/Subscriber@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.SecurityLake/SubscriberProperties](#awssecuritylakesubscriberproperties) (Required, Identifier): properties of the resource + +## Resource AWS.SecurityLake/SubscriberNotification@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.SecurityLake/SubscriberNotificationProperties](#awssecuritylakesubscribernotificationproperties) (Required, Identifier): properties of the resource + +## AWS.SecurityLake/AwsLogSourceProperties +### Properties +* **Accounts**: string[]: AWS account where you want to collect logs from. +* **DataLakeArn**: string (Required): The ARN for the data lake. +* **SourceName**: string (Required, Identifier): The name for a AWS source. This must be a Regionally unique value. +* **SourceVersion**: string (Required, Identifier): The version for a AWS source. This must be a Regionally unique value. + +## AWS.SecurityLake/DataLakeProperties +### Properties +* **Arn**: string (ReadOnly, Identifier): The Amazon Resource Name (ARN) created by you to provide to the subscriber. +* **EncryptionConfiguration**: [EncryptionConfiguration](#encryptionconfiguration) +* **LifecycleConfiguration**: [LifecycleConfiguration](#lifecycleconfiguration) +* **MetaStoreManagerRoleArn**: string (WriteOnly): The Amazon Resource Name (ARN) used to index AWS Glue table partitions that are generated by the ingestion and normalization of AWS log sources and custom sources. +* **ReplicationConfiguration**: [ReplicationConfiguration](#replicationconfiguration) +* **S3BucketArn**: string (ReadOnly): The ARN for the Amazon Security Lake Amazon S3 bucket. +* **Tags**: [Tag](#tag)[] + +## AWS.SecurityLake/SubscriberNotificationProperties +### Properties +* **NotificationConfiguration**: [NotificationConfiguration](#notificationconfiguration) (Required) +* **SubscriberArn**: string (Required, Identifier): The ARN for the subscriber +* **SubscriberEndpoint**: string (ReadOnly): The endpoint the subscriber should listen to for notifications + +## AWS.SecurityLake/SubscriberProperties +### Properties +* **AccessTypes**: string[] (Required) +* **DataLakeArn**: string (Required): The ARN for the data lake. +* **ResourceShareArn**: string (ReadOnly) +* **ResourceShareName**: string (ReadOnly) +* **S3BucketArn**: string (ReadOnly) +* **Sources**: [Source](#source)[] (Required): The supported AWS services from which logs and events are collected. +* **SubscriberArn**: string (ReadOnly, Identifier) +* **SubscriberDescription**: string: The description for your subscriber account in Security Lake. +* **SubscriberIdentity**: [Subscriber_SubscriberIdentity](#subscribersubscriberidentity) (Required): The AWS identity used to access your data. +* **SubscriberName**: string (Required): The name of your Security Lake subscriber account. +* **SubscriberRoleArn**: string (ReadOnly) +* **Tags**: [Tag](#tag)[]: An array of objects, one for each tag to associate with the subscriber. For each tag, you must specify both a tag key and a tag value. A tag value cannot be null, but it can be an empty string. + +## AwsLogSource +### Properties +* **SourceName**: string: The name for a AWS source. This must be a Regionally unique value. +* **SourceVersion**: string: The version for a AWS source. This must be a Regionally unique value. + +## CustomLogSource +### Properties +* **SourceName**: string: The name for a third-party custom source. This must be a Regionally unique value. +* **SourceVersion**: string: The version for a third-party custom source. This must be a Regionally unique value. + +## EncryptionConfiguration +### Properties +* **KmsKeyId**: string: The id of KMS encryption key used by Amazon Security Lake to encrypt the Security Lake object. + +## Expiration +### Properties +* **Days**: int + +## HttpsNotificationConfiguration +### Properties +* **AuthorizationApiKeyName**: string (WriteOnly): The key name for the notification subscription. +* **AuthorizationApiKeyValue**: string (WriteOnly): The key value for the notification subscription. +* **Endpoint**: string (Required, WriteOnly): The subscription endpoint in Security Lake. +* **HttpMethod**: string (WriteOnly): The HTTPS method used for the notification subscription. +* **TargetRoleArn**: string (Required, WriteOnly): The Amazon Resource Name (ARN) of the EventBridge API destinations IAM role that you created. + +## LifecycleConfiguration +### Properties +* **Expiration**: [Expiration](#expiration) +* **Transitions**: [Transitions](#transitions)[]: Provides data storage transition details of Amazon Security Lake object. + +## NotificationConfiguration +### Properties +* **HttpsNotificationConfiguration**: [HttpsNotificationConfiguration](#httpsnotificationconfiguration) +* **SqsNotificationConfiguration**: [SqsNotificationConfiguration](#sqsnotificationconfiguration) + +## ReplicationConfiguration +### Properties +* **Regions**: string[] +* **RoleArn**: string: Replication 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. + +## Source +### Properties +* **AwsLogSource**: [AwsLogSource](#awslogsource) +* **CustomLogSource**: [CustomLogSource](#customlogsource) + +## SqsNotificationConfiguration +### Properties + +## Subscriber_SubscriberIdentity +### Properties +* **ExternalId**: string (Required): The external ID used to establish trust relationship with the AWS identity. +* **Principal**: string (Required): The AWS identity principal. + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, `_`, `.`, `/`, `=`, `+`, and `-`. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 characters in length. + +## Tag +### Properties +* **Key**: string (Required): The name of the tag. This is a general label that acts as a category for a more specific tag value (value). +* **Value**: string (Required): The value that is associated with the specified tag key (key). This value acts as a descriptor for the tag key. A tag value cannot be null, but it can be an empty string. + +## Transitions +### Properties +* **Days**: int: Number of days before data transitions to a different S3 Storage Class in the Amazon Security Lake object. +* **StorageClass**: string: The range of storage classes that you can choose from based on the data access, resiliency, and cost requirements of your workloads. + diff --git a/artifacts/bicep/aws/aws.servicecatalog/default/types.json b/artifacts/bicep/aws/aws.servicecatalog/default/types.json index ed93d111..089022d1 100644 --- a/artifacts/bicep/aws/aws.servicecatalog/default/types.json +++ b/artifacts/bicep/aws/aws.servicecatalog/default/types.json @@ -1 +1,381 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"OutputType"}},{"2":{"Name":"ProvisioningParameter","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"ProvisioningPreferences","Properties":{"StackSetAccounts":{"Type":12,"Flags":0},"StackSetFailureToleranceCount":{"Type":3,"Flags":0},"StackSetFailureTolerancePercentage":{"Type":3,"Flags":0},"StackSetMaxConcurrencyCount":{"Type":3,"Flags":0},"StackSetMaxConcurrencyPercentage":{"Type":3,"Flags":0},"StackSetOperationType":{"Type":4,"Flags":0},"StackSetRegions":{"Type":13,"Flags":0}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.ServiceCatalog/CloudFormationProvisionedProductProperties","Properties":{"AcceptLanguage":{"Type":4,"Flags":0},"CloudformationStackArn":{"Type":4,"Flags":2},"NotificationArns":{"Type":15,"Flags":0},"Outputs":{"Type":16,"Flags":2,"Description":"List of key-value pair outputs."},"PathId":{"Type":4,"Flags":0},"PathName":{"Type":4,"Flags":0},"ProductId":{"Type":4,"Flags":0},"ProductName":{"Type":4,"Flags":0},"ProvisionedProductId":{"Type":4,"Flags":18},"ProvisionedProductName":{"Type":4,"Flags":0},"ProvisioningArtifactId":{"Type":4,"Flags":0},"ProvisioningArtifactName":{"Type":4,"Flags":0},"ProvisioningParameters":{"Type":17,"Flags":0},"ProvisioningPreferences":{"Type":10,"Flags":0},"RecordId":{"Type":4,"Flags":2},"Tags":{"Type":18,"Flags":0}}}},{"3":{"ItemType":4}},{"2":{"Name":"CloudFormationProvisionedProduct_Outputs","Properties":{}}},{"3":{"ItemType":9}},{"3":{"ItemType":11}},{"2":{"Name":"AWS.ServiceCatalog/CloudFormationProvisionedProduct","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":14,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ServiceCatalog/CloudFormationProvisionedProduct@default","ScopeType":0,"Body":19}},{"2":{"Name":"DefinitionParameter","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.ServiceCatalog/ServiceActionProperties","Properties":{"AcceptLanguage":{"Type":4,"Flags":4},"Definition":{"Type":23,"Flags":1},"DefinitionType":{"Type":4,"Flags":1},"Description":{"Type":4,"Flags":0},"Id":{"Type":4,"Flags":18},"Name":{"Type":4,"Flags":1}}}},{"3":{"ItemType":21}},{"2":{"Name":"AWS.ServiceCatalog/ServiceAction","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":22,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ServiceCatalog/ServiceAction@default","ScopeType":0,"Body":24}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "OutputType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ProvisioningParameter", + "properties": { + "Key": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ProvisioningPreferences", + "properties": { + "StackSetAccounts": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "StackSetFailureToleranceCount": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "StackSetFailureTolerancePercentage": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "StackSetMaxConcurrencyCount": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "StackSetMaxConcurrencyPercentage": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "StackSetOperationType": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "StackSetRegions": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.ServiceCatalog/CloudFormationProvisionedProductProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ObjectType", + "name": "CloudFormationProvisionedProduct_Outputs", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ObjectType", + "name": "AWS.ServiceCatalog/CloudFormationProvisionedProductProperties", + "properties": { + "AcceptLanguage": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "CloudformationStackArn": { + "type": { + "$ref": "#/4" + }, + "flags": 2 + }, + "NotificationArns": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "Outputs": { + "type": { + "$ref": "#/10" + }, + "flags": 2, + "description": "List of key-value pair outputs." + }, + "PathId": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "PathName": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "ProductId": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "ProductName": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "ProvisionedProductId": { + "type": { + "$ref": "#/4" + }, + "flags": 18 + }, + "ProvisionedProductName": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "ProvisioningArtifactId": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "ProvisioningArtifactName": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "ProvisioningParameters": { + "type": { + "$ref": "#/11" + }, + "flags": 0 + }, + "ProvisioningPreferences": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "RecordId": { + "type": { + "$ref": "#/4" + }, + "flags": 2 + }, + "Tags": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ServiceCatalog/CloudFormationProvisionedProduct", + "properties": { + "name": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/13" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ServiceCatalog/CloudFormationProvisionedProduct@default", + "scopeType": 0, + "body": { + "$ref": "#/14" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "DefinitionParameter", + "properties": { + "Key": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.ServiceCatalog/ServiceActionProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/16" + } + }, + { + "$type": "ObjectType", + "name": "AWS.ServiceCatalog/ServiceActionProperties", + "properties": { + "AcceptLanguage": { + "type": { + "$ref": "#/4" + }, + "flags": 4 + }, + "Definition": { + "type": { + "$ref": "#/18" + }, + "flags": 1 + }, + "DefinitionType": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + }, + "Description": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "Id": { + "type": { + "$ref": "#/4" + }, + "flags": 18 + }, + "Name": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ServiceCatalog/ServiceAction", + "properties": { + "name": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/19" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ServiceCatalog/ServiceAction@default", + "scopeType": 0, + "body": { + "$ref": "#/20" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.servicecatalog/default/types.md b/artifacts/bicep/aws/aws.servicecatalog/default/types.md index b5e3e330..780884f9 100644 --- a/artifacts/bicep/aws/aws.servicecatalog/default/types.md +++ b/artifacts/bicep/aws/aws.servicecatalog/default/types.md @@ -3,16 +3,16 @@ ## Resource AWS.ServiceCatalog/CloudFormationProvisionedProduct@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ServiceCatalog/CloudFormationProvisionedProductProperties](#awsservicecatalogcloudformationprovisionedproductproperties): properties of the resource +* **properties**: [AWS.ServiceCatalog/CloudFormationProvisionedProductProperties](#awsservicecatalogcloudformationprovisionedproductproperties) (Identifier): properties of the resource ## Resource AWS.ServiceCatalog/ServiceAction@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ServiceCatalog/ServiceActionProperties](#awsservicecatalogserviceactionproperties) (Required): properties of the resource +* **properties**: [AWS.ServiceCatalog/ServiceActionProperties](#awsservicecatalogserviceactionproperties) (Required, Identifier): properties of the resource ## AWS.ServiceCatalog/CloudFormationProvisionedProductProperties ### Properties @@ -33,9 +33,23 @@ * **RecordId**: string (ReadOnly) * **Tags**: [Tag](#tag)[] +## AWS.ServiceCatalog/ServiceActionProperties +### Properties +* **AcceptLanguage**: string (WriteOnly) +* **Definition**: [DefinitionParameter](#definitionparameter)[] (Required) +* **DefinitionType**: string (Required) +* **Description**: string +* **Id**: string (ReadOnly, Identifier) +* **Name**: string (Required) + ## CloudFormationProvisionedProduct_Outputs ### Properties +## DefinitionParameter +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + ## ProvisioningParameter ### Properties * **Key**: string (Required) @@ -56,17 +70,3 @@ * **Key**: string (Required) * **Value**: string (Required) -## AWS.ServiceCatalog/ServiceActionProperties -### Properties -* **AcceptLanguage**: string (WriteOnly) -* **Definition**: [DefinitionParameter](#definitionparameter)[] (Required) -* **DefinitionType**: string (Required) -* **Description**: string -* **Id**: string (ReadOnly, Identifier) -* **Name**: string (Required) - -## DefinitionParameter -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - diff --git a/artifacts/bicep/aws/aws.servicecatalogappregistry/default/types.json b/artifacts/bicep/aws/aws.servicecatalogappregistry/default/types.json index 72e3728a..058c237a 100644 --- a/artifacts/bicep/aws/aws.servicecatalogappregistry/default/types.json +++ b/artifacts/bicep/aws/aws.servicecatalogappregistry/default/types.json @@ -1 +1,203 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"Tags","Properties":{}}},{"2":{"Name":"AWS.ServiceCatalogAppRegistry/ApplicationProperties","Properties":{"ApplicationName":{"Type":4,"Flags":2,"Description":"The name of the application. "},"ApplicationTagKey":{"Type":4,"Flags":2,"Description":"The key of the AWS application tag, which is awsApplication. Applications created before 11/13/2023 or applications without the AWS application tag resource group return no value."},"ApplicationTagValue":{"Type":4,"Flags":2,"Description":"The value of the AWS application tag, which is the identifier of an associated resource. Applications created before 11/13/2023 or applications without the AWS application tag resource group return no value. "},"Arn":{"Type":4,"Flags":2},"Description":{"Type":4,"Flags":0,"Description":"The description of the application. "},"Id":{"Type":4,"Flags":18},"Name":{"Type":4,"Flags":1,"Description":"The name of the application. "},"Tags":{"Type":8,"Flags":0}}}},{"2":{"Name":"AWS.ServiceCatalogAppRegistry/Application","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":9,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ServiceCatalogAppRegistry/Application@default","ScopeType":0,"Body":10}},{"2":{"Name":"Tags","Properties":{}}},{"2":{"Name":"AWS.ServiceCatalogAppRegistry/AttributeGroupProperties","Properties":{"Arn":{"Type":4,"Flags":2},"Attributes":{"Type":14,"Flags":1},"Description":{"Type":4,"Flags":0,"Description":"The description of the attribute group. "},"Id":{"Type":4,"Flags":18},"Name":{"Type":4,"Flags":1,"Description":"The name of the attribute group. "},"Tags":{"Type":12,"Flags":0}}}},{"2":{"Name":"AttributeGroup_Attributes","Properties":{}}},{"2":{"Name":"AWS.ServiceCatalogAppRegistry/AttributeGroup","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":13,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.ServiceCatalogAppRegistry/AttributeGroup@default","ScopeType":0,"Body":15}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Tags", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.ServiceCatalogAppRegistry/ApplicationProperties" + }, + { + "$type": "StringType" + }, + { + "$type": "ObjectType", + "name": "AWS.ServiceCatalogAppRegistry/ApplicationProperties", + "properties": { + "ApplicationName": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The name of the application. " + }, + "ApplicationTagKey": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The key of the AWS application tag, which is awsApplication. Applications created before 11/13/2023 or applications without the AWS application tag resource group return no value." + }, + "ApplicationTagValue": { + "type": { + "$ref": "#/2" + }, + "flags": 2, + "description": "The value of the AWS application tag, which is the identifier of an associated resource. Applications created before 11/13/2023 or applications without the AWS application tag resource group return no value. " + }, + "Arn": { + "type": { + "$ref": "#/2" + }, + "flags": 2 + }, + "Description": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The description of the application. " + }, + "Id": { + "type": { + "$ref": "#/2" + }, + "flags": 18 + }, + "Name": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The name of the application. " + }, + "Tags": { + "type": { + "$ref": "#/0" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ServiceCatalogAppRegistry/Application", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ServiceCatalogAppRegistry/Application@default", + "scopeType": 0, + "body": { + "$ref": "#/4" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tags", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.ServiceCatalogAppRegistry/AttributeGroupProperties" + }, + { + "$type": "ObjectType", + "name": "AttributeGroup_Attributes", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AWS.ServiceCatalogAppRegistry/AttributeGroupProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/2" + }, + "flags": 2 + }, + "Attributes": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + }, + "Description": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "The description of the attribute group. " + }, + "Id": { + "type": { + "$ref": "#/2" + }, + "flags": 18 + }, + "Name": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "The name of the attribute group. " + }, + "Tags": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.ServiceCatalogAppRegistry/AttributeGroup", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/9" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.ServiceCatalogAppRegistry/AttributeGroup@default", + "scopeType": 0, + "body": { + "$ref": "#/10" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.servicecatalogappregistry/default/types.md b/artifacts/bicep/aws/aws.servicecatalogappregistry/default/types.md index c80b0127..5104fe6f 100644 --- a/artifacts/bicep/aws/aws.servicecatalogappregistry/default/types.md +++ b/artifacts/bicep/aws/aws.servicecatalogappregistry/default/types.md @@ -3,16 +3,19 @@ ## Resource AWS.ServiceCatalogAppRegistry/Application@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ServiceCatalogAppRegistry/ApplicationProperties](#awsservicecatalogappregistryapplicationproperties) (Required): properties of the resource +* **properties**: [AWS.ServiceCatalogAppRegistry/ApplicationProperties](#awsservicecatalogappregistryapplicationproperties) (Required, Identifier): properties of the resource ## Resource AWS.ServiceCatalogAppRegistry/AttributeGroup@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.ServiceCatalogAppRegistry/AttributeGroupProperties](#awsservicecatalogappregistryattributegroupproperties) (Required): properties of the resource +* **properties**: [AWS.ServiceCatalogAppRegistry/AttributeGroupProperties](#awsservicecatalogappregistryattributegroupproperties) (Required, Identifier): properties of the resource + +## AttributeGroup_Attributes +### Properties ## AWS.ServiceCatalogAppRegistry/ApplicationProperties ### Properties @@ -25,9 +28,6 @@ * **Name**: string (Required): The name of the application. * **Tags**: [Tags](#tags) -## Tags -### Properties - ## AWS.ServiceCatalogAppRegistry/AttributeGroupProperties ### Properties * **Arn**: string (ReadOnly) @@ -37,7 +37,7 @@ * **Name**: string (Required): The name of the attribute group. * **Tags**: [Tags](#tags) -## AttributeGroup_Attributes +## Tags ### Properties ## Tags diff --git a/artifacts/bicep/aws/aws.ses/default/types.json b/artifacts/bicep/aws/aws.ses/default/types.json index f3ac1f94..ee71d0dc 100644 --- a/artifacts/bicep/aws/aws.ses/default/types.json +++ b/artifacts/bicep/aws/aws.ses/default/types.json @@ -1 +1,1020 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"DashboardOptions","Properties":{"EngagementMetrics":{"Type":4,"Flags":1,"Description":"Whether emails sent with this configuration set have engagement tracking enabled."}}}},{"2":{"Name":"DeliveryOptions","Properties":{"SendingPoolName":{"Type":4,"Flags":0,"Description":"The name of the dedicated IP pool to associate with the configuration set."},"TlsPolicy":{"Type":4,"Flags":0,"Description":"Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS). If the value is Require , messages are only delivered if a TLS connection can be established. If the value is Optional , messages can be delivered in plain text if a TLS connection can't be established."}}}},{"2":{"Name":"GuardianOptions","Properties":{"OptimizedSharedDelivery":{"Type":4,"Flags":1,"Description":"Whether emails sent with this configuration set have optimized delivery algorithm enabled."}}}},{"2":{"Name":"ReputationOptions","Properties":{"ReputationMetricsEnabled":{"Type":2,"Flags":0,"Description":"If true , tracking of reputation metrics is enabled for the configuration set. If false , tracking of reputation metrics is disabled for the configuration set."}}}},{"2":{"Name":"SendingOptions","Properties":{"SendingEnabled":{"Type":2,"Flags":0}}}},{"2":{"Name":"SuppressionOptions","Properties":{"SuppressedReasons":{"Type":16,"Flags":0,"Description":"A list that contains the reasons that email addresses are automatically added to the suppression list for your account."}}}},{"2":{"Name":"TrackingOptions","Properties":{"CustomRedirectDomain":{"Type":4,"Flags":0,"Description":"The domain to use for tracking open and click events."}}}},{"2":{"Name":"VdmOptions","Properties":{"DashboardOptions":{"Type":8,"Flags":0},"GuardianOptions":{"Type":10,"Flags":0}}}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.SES/ConfigurationSetProperties","Properties":{"DeliveryOptions":{"Type":9,"Flags":0},"Name":{"Type":4,"Flags":16,"Description":"The name of the configuration set."},"ReputationOptions":{"Type":11,"Flags":0},"SendingOptions":{"Type":12,"Flags":0},"SuppressionOptions":{"Type":13,"Flags":0},"TrackingOptions":{"Type":14,"Flags":0},"VdmOptions":{"Type":15,"Flags":0}}}},{"2":{"Name":"AWS.SES/ConfigurationSet","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":17,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.SES/ConfigurationSet@default","ScopeType":0,"Body":18}},{"2":{"Name":"CloudWatchDestination","Properties":{"DimensionConfigurations":{"Type":25,"Flags":0,"Description":"A list of dimensions upon which to categorize your emails when you publish email sending events to Amazon CloudWatch."}}}},{"2":{"Name":"DimensionConfiguration","Properties":{"DefaultDimensionValue":{"Type":4,"Flags":1,"Description":"The default value of the dimension that is published to Amazon CloudWatch if you do not provide the value of the dimension when you send an email."},"DimensionName":{"Type":4,"Flags":1,"Description":"The name of an Amazon CloudWatch dimension associated with an email sending metric."},"DimensionValueSource":{"Type":4,"Flags":1,"Description":"The place where Amazon SES finds the value of a dimension to publish to Amazon CloudWatch. To use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail/SendRawEmail API, specify messageTag. To use your own email headers, specify emailHeader. To put a custom tag on any link included in your email, specify linkTag."}}}},{"2":{"Name":"EventDestination","Properties":{"CloudWatchDestination":{"Type":20,"Flags":0,"Description":"An object that contains the names, default values, and sources of the dimensions associated with an Amazon CloudWatch event destination."},"Enabled":{"Type":2,"Flags":0,"Description":"Sets whether Amazon SES publishes events to this destination when you send an email with the associated configuration set. Set to true to enable publishing to this destination; set to false to prevent publishing to this destination. The default value is false. "},"KinesisFirehoseDestination":{"Type":23,"Flags":0,"Description":"An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination."},"MatchingEventTypes":{"Type":26,"Flags":1,"Description":"The type of email sending events, send, reject, bounce, complaint, delivery, open, click, renderingFailure, deliveryDelay, and subscription."},"Name":{"Type":4,"Flags":0,"Description":"The name of the event destination set."},"SnsDestination":{"Type":24,"Flags":0,"Description":"An object that contains SNS topic ARN associated event destination."}}}},{"2":{"Name":"KinesisFirehoseDestination","Properties":{"DeliveryStreamARN":{"Type":4,"Flags":1,"Description":"The ARN of the Amazon Kinesis Firehose stream that email sending events should be published to."},"IAMRoleARN":{"Type":4,"Flags":1,"Description":"The ARN of the IAM role under which Amazon SES publishes email sending events to the Amazon Kinesis Firehose stream."}}}},{"2":{"Name":"SnsDestination","Properties":{"TopicARN":{"Type":4,"Flags":1}}}},{"3":{"ItemType":21}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.SES/ConfigurationSetEventDestinationProperties","Properties":{"ConfigurationSetName":{"Type":4,"Flags":1,"Description":"The name of the configuration set that contains the event destination."},"EventDestination":{"Type":22,"Flags":1,"Description":"The event destination object."},"Id":{"Type":4,"Flags":18}}}},{"2":{"Name":"AWS.SES/ConfigurationSetEventDestination","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":27,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.SES/ConfigurationSetEventDestination@default","ScopeType":0,"Body":28}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"Topic","Properties":{"DefaultSubscriptionStatus":{"Type":4,"Flags":1},"Description":{"Type":4,"Flags":0,"Description":"The description of the topic."},"DisplayName":{"Type":4,"Flags":1,"Description":"The display name of the topic."},"TopicName":{"Type":4,"Flags":1,"Description":"The name of the topic."}}}},{"2":{"Name":"AWS.SES/ContactListProperties","Properties":{"ContactListName":{"Type":4,"Flags":16,"Description":"The name of the contact list."},"Description":{"Type":4,"Flags":0,"Description":"The description of the contact list."},"Tags":{"Type":33,"Flags":0,"Description":"The tags (keys and values) associated with the contact list."},"Topics":{"Type":34,"Flags":0,"Description":"The topics associated with the contact list."}}}},{"3":{"ItemType":30}},{"3":{"ItemType":31}},{"2":{"Name":"AWS.SES/ContactList","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":32,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.SES/ContactList@default","ScopeType":0,"Body":35}},{"2":{"Name":"AWS.SES/DedicatedIpPoolProperties","Properties":{"PoolName":{"Type":4,"Flags":16,"Description":"The name of the dedicated IP pool."},"ScalingMode":{"Type":4,"Flags":0,"Description":"Specifies whether the dedicated IP pool is managed or not. The default value is STANDARD."}}}},{"2":{"Name":"AWS.SES/DedicatedIpPool","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":37,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.SES/DedicatedIpPool@default","ScopeType":0,"Body":38}},{"2":{"Name":"ConfigurationSetAttributes","Properties":{"ConfigurationSetName":{"Type":4,"Flags":0,"Description":"The configuration set to use by default when sending from this identity. Note that any configuration set defined in the email sending request takes precedence."}}}},{"2":{"Name":"DkimAttributes","Properties":{"SigningEnabled":{"Type":2,"Flags":0,"Description":"Sets the DKIM signing configuration for the identity. When you set this value true, then the messages that are sent from the identity are signed using DKIM. If you set this value to false, your messages are sent without DKIM signing."}}}},{"2":{"Name":"DkimSigningAttributes","Properties":{"DomainSigningPrivateKey":{"Type":4,"Flags":4,"Description":"[Bring Your Own DKIM] A private key that's used to generate a DKIM signature. The private key must use 1024 or 2048-bit RSA encryption, and must be encoded using base64 encoding."},"DomainSigningSelector":{"Type":4,"Flags":4,"Description":"[Bring Your Own DKIM] A string that's used to identify a public key in the DNS configuration for a domain."},"NextSigningKeyLength":{"Type":4,"Flags":0,"Description":"[Easy DKIM] The key length of the future DKIM key pair to be generated. This can be changed at most once per day."}}}},{"2":{"Name":"FeedbackAttributes","Properties":{"EmailForwardingEnabled":{"Type":2,"Flags":0,"Description":"If the value is true, you receive email notifications when bounce or complaint events occur"}}}},{"2":{"Name":"MailFromAttributes","Properties":{"BehaviorOnMxFailure":{"Type":4,"Flags":0,"Description":"The action to take if the required MX record isn't found when you send an email. When you set this value to UseDefaultValue , the mail is sent using amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage , the Amazon SES API v2 returns a MailFromDomainNotVerified error, and doesn't attempt to deliver the email."},"MailFromDomain":{"Type":4,"Flags":0,"Description":"The custom MAIL FROM domain that you want the verified identity to use"}}}},{"2":{"Name":"AWS.SES/EmailIdentityProperties","Properties":{"ConfigurationSetAttributes":{"Type":40,"Flags":0},"DkimAttributes":{"Type":41,"Flags":0},"DkimDNSTokenName1":{"Type":4,"Flags":2},"DkimDNSTokenName2":{"Type":4,"Flags":2},"DkimDNSTokenName3":{"Type":4,"Flags":2},"DkimDNSTokenValue1":{"Type":4,"Flags":2},"DkimDNSTokenValue2":{"Type":4,"Flags":2},"DkimDNSTokenValue3":{"Type":4,"Flags":2},"DkimSigningAttributes":{"Type":42,"Flags":0},"EmailIdentity":{"Type":4,"Flags":17,"Description":"The email address or domain to verify."},"FeedbackAttributes":{"Type":43,"Flags":0},"MailFromAttributes":{"Type":44,"Flags":0}}}},{"2":{"Name":"AWS.SES/EmailIdentity","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":45,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.SES/EmailIdentity@default","ScopeType":0,"Body":46}},{"2":{"Name":"Template","Properties":{"HtmlPart":{"Type":4,"Flags":0,"Description":"The HTML body of the email."},"SubjectPart":{"Type":4,"Flags":1,"Description":"The subject line of the email."},"TemplateName":{"Type":4,"Flags":0,"Description":"The name of the template."},"TextPart":{"Type":4,"Flags":0,"Description":"The email body that is visible to recipients whose email clients do not display HTML content."}}}},{"2":{"Name":"AWS.SES/TemplateProperties","Properties":{"Id":{"Type":4,"Flags":18},"Template":{"Type":48,"Flags":0}}}},{"2":{"Name":"AWS.SES/Template","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":49,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.SES/Template@default","ScopeType":0,"Body":50}},{"2":{"Name":"DashboardAttributes","Properties":{"EngagementMetrics":{"Type":4,"Flags":0,"Description":"Whether emails sent from this account have engagement tracking enabled."}}}},{"2":{"Name":"GuardianAttributes","Properties":{"OptimizedSharedDelivery":{"Type":4,"Flags":0,"Description":"Whether emails sent from this account have optimized delivery algorithm enabled."}}}},{"2":{"Name":"AWS.SES/VdmAttributesProperties","Properties":{"DashboardAttributes":{"Type":52,"Flags":0},"GuardianAttributes":{"Type":53,"Flags":0},"VdmAttributesResourceId":{"Type":4,"Flags":18,"Description":"Unique identifier for this resource"}}}},{"2":{"Name":"AWS.SES/VdmAttributes","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":54,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.SES/VdmAttributes@default","ScopeType":0,"Body":55}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "DashboardOptions", + "properties": { + "EngagementMetrics": { + "type": { + "$ref": "#/8" + }, + "flags": 1, + "description": "Whether emails sent with this configuration set have engagement tracking enabled." + } + } + }, + { + "$type": "ObjectType", + "name": "DeliveryOptions", + "properties": { + "SendingPoolName": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The name of the dedicated IP pool to associate with the configuration set." + }, + "TlsPolicy": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS). If the value is Require , messages are only delivered if a TLS connection can be established. If the value is Optional , messages can be delivered in plain text if a TLS connection can't be established." + } + } + }, + { + "$type": "ObjectType", + "name": "GuardianOptions", + "properties": { + "OptimizedSharedDelivery": { + "type": { + "$ref": "#/8" + }, + "flags": 1, + "description": "Whether emails sent with this configuration set have optimized delivery algorithm enabled." + } + } + }, + { + "$type": "ObjectType", + "name": "ReputationOptions", + "properties": { + "ReputationMetricsEnabled": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "If true , tracking of reputation metrics is enabled for the configuration set. If false , tracking of reputation metrics is disabled for the configuration set." + } + } + }, + { + "$type": "ObjectType", + "name": "SendingOptions", + "properties": { + "SendingEnabled": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SuppressionOptions", + "properties": { + "SuppressedReasons": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "A list that contains the reasons that email addresses are automatically added to the suppression list for your account." + } + } + }, + { + "$type": "ObjectType", + "name": "TrackingOptions", + "properties": { + "CustomRedirectDomain": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The domain to use for tracking open and click events." + } + } + }, + { + "$type": "ObjectType", + "name": "VdmOptions", + "properties": { + "DashboardOptions": { + "type": { + "$ref": "#/0" + }, + "flags": 0 + }, + "GuardianOptions": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/8" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.SES/ConfigurationSetProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.SES/ConfigurationSetProperties", + "properties": { + "DeliveryOptions": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/8" + }, + "flags": 16, + "description": "The name of the configuration set." + }, + "ReputationOptions": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "SendingOptions": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "SuppressionOptions": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "TrackingOptions": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "VdmOptions": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SES/ConfigurationSet", + "properties": { + "name": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/8" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/12" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SES/ConfigurationSet@default", + "scopeType": 0, + "body": { + "$ref": "#/13" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "CloudWatchDestination", + "properties": { + "DimensionConfigurations": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "A list of dimensions upon which to categorize your emails when you publish email sending events to Amazon CloudWatch." + } + } + }, + { + "$type": "ObjectType", + "name": "DimensionConfiguration", + "properties": { + "DefaultDimensionValue": { + "type": { + "$ref": "#/8" + }, + "flags": 1, + "description": "The default value of the dimension that is published to Amazon CloudWatch if you do not provide the value of the dimension when you send an email." + }, + "DimensionName": { + "type": { + "$ref": "#/8" + }, + "flags": 1, + "description": "The name of an Amazon CloudWatch dimension associated with an email sending metric." + }, + "DimensionValueSource": { + "type": { + "$ref": "#/8" + }, + "flags": 1, + "description": "The place where Amazon SES finds the value of a dimension to publish to Amazon CloudWatch. To use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail/SendRawEmail API, specify messageTag. To use your own email headers, specify emailHeader. To put a custom tag on any link included in your email, specify linkTag." + } + } + }, + { + "$type": "ObjectType", + "name": "EventBridgeDestination", + "properties": { + "EventBusArn": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "EventDestination", + "properties": { + "CloudWatchDestination": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "An object that contains the names, default values, and sources of the dimensions associated with an Amazon CloudWatch event destination." + }, + "Enabled": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "Sets whether Amazon SES publishes events to this destination when you send an email with the associated configuration set. Set to true to enable publishing to this destination; set to false to prevent publishing to this destination. The default value is false. " + }, + "EventBridgeDestination": { + "type": { + "$ref": "#/17" + }, + "flags": 0, + "description": "An object that contains Event bus ARN associated with the event bridge destination." + }, + "KinesisFirehoseDestination": { + "type": { + "$ref": "#/19" + }, + "flags": 0, + "description": "An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination." + }, + "MatchingEventTypes": { + "type": { + "$ref": "#/22" + }, + "flags": 1, + "description": "The type of email sending events, send, reject, bounce, complaint, delivery, open, click, renderingFailure, deliveryDelay, and subscription." + }, + "Name": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The name of the event destination set." + }, + "SnsDestination": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "An object that contains SNS topic ARN associated event destination." + } + } + }, + { + "$type": "ObjectType", + "name": "KinesisFirehoseDestination", + "properties": { + "DeliveryStreamARN": { + "type": { + "$ref": "#/8" + }, + "flags": 1, + "description": "The ARN of the Amazon Kinesis Firehose stream that email sending events should be published to." + }, + "IAMRoleARN": { + "type": { + "$ref": "#/8" + }, + "flags": 1, + "description": "The ARN of the IAM role under which Amazon SES publishes email sending events to the Amazon Kinesis Firehose stream." + } + } + }, + { + "$type": "ObjectType", + "name": "SnsDestination", + "properties": { + "TopicARN": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/16" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/8" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.SES/ConfigurationSetEventDestinationProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.SES/ConfigurationSetEventDestinationProperties", + "properties": { + "ConfigurationSetName": { + "type": { + "$ref": "#/8" + }, + "flags": 1, + "description": "The name of the configuration set that contains the event destination." + }, + "EventDestination": { + "type": { + "$ref": "#/18" + }, + "flags": 1, + "description": "The event destination object." + }, + "Id": { + "type": { + "$ref": "#/8" + }, + "flags": 18 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SES/ConfigurationSetEventDestination", + "properties": { + "name": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/8" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/24" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SES/ConfigurationSetEventDestination@default", + "scopeType": 0, + "body": { + "$ref": "#/25" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Topic", + "properties": { + "DefaultSubscriptionStatus": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + }, + "Description": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The description of the topic." + }, + "DisplayName": { + "type": { + "$ref": "#/8" + }, + "flags": 1, + "description": "The display name of the topic." + }, + "TopicName": { + "type": { + "$ref": "#/8" + }, + "flags": 1, + "description": "The name of the topic." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.SES/ContactListProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/27" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/28" + } + }, + { + "$type": "ObjectType", + "name": "AWS.SES/ContactListProperties", + "properties": { + "ContactListName": { + "type": { + "$ref": "#/8" + }, + "flags": 16, + "description": "The name of the contact list." + }, + "Description": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The description of the contact list." + }, + "Tags": { + "type": { + "$ref": "#/30" + }, + "flags": 0, + "description": "The tags (keys and values) associated with the contact list." + }, + "Topics": { + "type": { + "$ref": "#/31" + }, + "flags": 0, + "description": "The topics associated with the contact list." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SES/ContactList", + "properties": { + "name": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/8" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/32" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SES/ContactList@default", + "scopeType": 0, + "body": { + "$ref": "#/33" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.SES/DedicatedIpPoolProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.SES/DedicatedIpPoolProperties", + "properties": { + "PoolName": { + "type": { + "$ref": "#/8" + }, + "flags": 16, + "description": "The name of the dedicated IP pool." + }, + "ScalingMode": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "Specifies whether the dedicated IP pool is managed or not. The default value is STANDARD." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SES/DedicatedIpPool", + "properties": { + "name": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/8" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/36" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SES/DedicatedIpPool@default", + "scopeType": 0, + "body": { + "$ref": "#/37" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "ConfigurationSetAttributes", + "properties": { + "ConfigurationSetName": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The configuration set to use by default when sending from this identity. Note that any configuration set defined in the email sending request takes precedence." + } + } + }, + { + "$type": "ObjectType", + "name": "DkimAttributes", + "properties": { + "SigningEnabled": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "Sets the DKIM signing configuration for the identity. When you set this value true, then the messages that are sent from the identity are signed using DKIM. If you set this value to false, your messages are sent without DKIM signing." + } + } + }, + { + "$type": "ObjectType", + "name": "DkimSigningAttributes", + "properties": { + "DomainSigningPrivateKey": { + "type": { + "$ref": "#/8" + }, + "flags": 4, + "description": "[Bring Your Own DKIM] A private key that's used to generate a DKIM signature. The private key must use 1024 or 2048-bit RSA encryption, and must be encoded using base64 encoding." + }, + "DomainSigningSelector": { + "type": { + "$ref": "#/8" + }, + "flags": 4, + "description": "[Bring Your Own DKIM] A string that's used to identify a public key in the DNS configuration for a domain." + }, + "NextSigningKeyLength": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "[Easy DKIM] The key length of the future DKIM key pair to be generated. This can be changed at most once per day." + } + } + }, + { + "$type": "ObjectType", + "name": "FeedbackAttributes", + "properties": { + "EmailForwardingEnabled": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "If the value is true, you receive email notifications when bounce or complaint events occur" + } + } + }, + { + "$type": "ObjectType", + "name": "MailFromAttributes", + "properties": { + "BehaviorOnMxFailure": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The action to take if the required MX record isn't found when you send an email. When you set this value to UseDefaultValue , the mail is sent using amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage , the Amazon SES API v2 returns a MailFromDomainNotVerified error, and doesn't attempt to deliver the email." + }, + "MailFromDomain": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The custom MAIL FROM domain that you want the verified identity to use" + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.SES/EmailIdentityProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.SES/EmailIdentityProperties", + "properties": { + "ConfigurationSetAttributes": { + "type": { + "$ref": "#/39" + }, + "flags": 0 + }, + "DkimAttributes": { + "type": { + "$ref": "#/40" + }, + "flags": 0 + }, + "DkimDNSTokenName1": { + "type": { + "$ref": "#/8" + }, + "flags": 2 + }, + "DkimDNSTokenName2": { + "type": { + "$ref": "#/8" + }, + "flags": 2 + }, + "DkimDNSTokenName3": { + "type": { + "$ref": "#/8" + }, + "flags": 2 + }, + "DkimDNSTokenValue1": { + "type": { + "$ref": "#/8" + }, + "flags": 2 + }, + "DkimDNSTokenValue2": { + "type": { + "$ref": "#/8" + }, + "flags": 2 + }, + "DkimDNSTokenValue3": { + "type": { + "$ref": "#/8" + }, + "flags": 2 + }, + "DkimSigningAttributes": { + "type": { + "$ref": "#/41" + }, + "flags": 0 + }, + "EmailIdentity": { + "type": { + "$ref": "#/8" + }, + "flags": 17, + "description": "The email address or domain to verify." + }, + "FeedbackAttributes": { + "type": { + "$ref": "#/42" + }, + "flags": 0 + }, + "MailFromAttributes": { + "type": { + "$ref": "#/43" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SES/EmailIdentity", + "properties": { + "name": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/8" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/45" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SES/EmailIdentity@default", + "scopeType": 0, + "body": { + "$ref": "#/46" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Template", + "properties": { + "HtmlPart": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The HTML body of the email." + }, + "SubjectPart": { + "type": { + "$ref": "#/8" + }, + "flags": 1, + "description": "The subject line of the email." + }, + "TemplateName": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The name of the template." + }, + "TextPart": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The email body that is visible to recipients whose email clients do not display HTML content." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.SES/TemplateProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.SES/TemplateProperties", + "properties": { + "Id": { + "type": { + "$ref": "#/8" + }, + "flags": 18 + }, + "Template": { + "type": { + "$ref": "#/48" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SES/Template", + "properties": { + "name": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/8" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/50" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SES/Template@default", + "scopeType": 0, + "body": { + "$ref": "#/51" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "DashboardAttributes", + "properties": { + "EngagementMetrics": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "Whether emails sent from this account have engagement tracking enabled." + } + } + }, + { + "$type": "ObjectType", + "name": "GuardianAttributes", + "properties": { + "OptimizedSharedDelivery": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "Whether emails sent from this account have optimized delivery algorithm enabled." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.SES/VdmAttributesProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.SES/VdmAttributesProperties", + "properties": { + "DashboardAttributes": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + }, + "GuardianAttributes": { + "type": { + "$ref": "#/54" + }, + "flags": 0 + }, + "VdmAttributesResourceId": { + "type": { + "$ref": "#/8" + }, + "flags": 18, + "description": "Unique identifier for this resource" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SES/VdmAttributes", + "properties": { + "name": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/8" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/56" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SES/VdmAttributes@default", + "scopeType": 0, + "body": { + "$ref": "#/57" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.ses/default/types.md b/artifacts/bicep/aws/aws.ses/default/types.md index e46526c5..424804ce 100644 --- a/artifacts/bicep/aws/aws.ses/default/types.md +++ b/artifacts/bicep/aws/aws.ses/default/types.md @@ -3,51 +3,57 @@ ## Resource AWS.SES/ConfigurationSet@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.SES/ConfigurationSetProperties](#awssesconfigurationsetproperties): properties of the resource +* **properties**: [AWS.SES/ConfigurationSetProperties](#awssesconfigurationsetproperties) (Identifier): properties of the resource ## Resource AWS.SES/ConfigurationSetEventDestination@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.SES/ConfigurationSetEventDestinationProperties](#awssesconfigurationseteventdestinationproperties) (Required): properties of the resource +* **properties**: [AWS.SES/ConfigurationSetEventDestinationProperties](#awssesconfigurationseteventdestinationproperties) (Required, Identifier): properties of the resource ## Resource AWS.SES/ContactList@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.SES/ContactListProperties](#awssescontactlistproperties): properties of the resource +* **properties**: [AWS.SES/ContactListProperties](#awssescontactlistproperties) (Identifier): properties of the resource ## Resource AWS.SES/DedicatedIpPool@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.SES/DedicatedIpPoolProperties](#awssesdedicatedippoolproperties): properties of the resource +* **properties**: [AWS.SES/DedicatedIpPoolProperties](#awssesdedicatedippoolproperties) (Identifier): properties of the resource ## Resource AWS.SES/EmailIdentity@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.SES/EmailIdentityProperties](#awssesemailidentityproperties) (Required): properties of the resource +* **properties**: [AWS.SES/EmailIdentityProperties](#awssesemailidentityproperties) (Required, Identifier): properties of the resource ## Resource AWS.SES/Template@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.SES/TemplateProperties](#awssestemplateproperties): properties of the resource +* **properties**: [AWS.SES/TemplateProperties](#awssestemplateproperties) (Identifier): properties of the resource ## Resource AWS.SES/VdmAttributes@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.SES/VdmAttributesProperties](#awssesvdmattributesproperties): properties of the resource +* **properties**: [AWS.SES/VdmAttributesProperties](#awssesvdmattributesproperties) (Identifier): properties of the resource + +## AWS.SES/ConfigurationSetEventDestinationProperties +### Properties +* **ConfigurationSetName**: string (Required): The name of the configuration set that contains the event destination. +* **EventDestination**: [EventDestination](#eventdestination) (Required): The event destination object. +* **Id**: string (ReadOnly, Identifier) ## AWS.SES/ConfigurationSetProperties ### Properties @@ -59,74 +65,6 @@ * **TrackingOptions**: [TrackingOptions](#trackingoptions) * **VdmOptions**: [VdmOptions](#vdmoptions) -## DeliveryOptions -### Properties -* **SendingPoolName**: string: The name of the dedicated IP pool to associate with the configuration set. -* **TlsPolicy**: string: Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS). If the value is Require , messages are only delivered if a TLS connection can be established. If the value is Optional , messages can be delivered in plain text if a TLS connection can't be established. - -## ReputationOptions -### Properties -* **ReputationMetricsEnabled**: bool: If true , tracking of reputation metrics is enabled for the configuration set. If false , tracking of reputation metrics is disabled for the configuration set. - -## SendingOptions -### Properties -* **SendingEnabled**: bool - -## SuppressionOptions -### Properties -* **SuppressedReasons**: string[]: A list that contains the reasons that email addresses are automatically added to the suppression list for your account. - -## TrackingOptions -### Properties -* **CustomRedirectDomain**: string: The domain to use for tracking open and click events. - -## VdmOptions -### Properties -* **DashboardOptions**: [DashboardOptions](#dashboardoptions) -* **GuardianOptions**: [GuardianOptions](#guardianoptions) - -## DashboardOptions -### Properties -* **EngagementMetrics**: string (Required): Whether emails sent with this configuration set have engagement tracking enabled. - -## GuardianOptions -### Properties -* **OptimizedSharedDelivery**: string (Required): Whether emails sent with this configuration set have optimized delivery algorithm enabled. - -## AWS.SES/ConfigurationSetEventDestinationProperties -### Properties -* **ConfigurationSetName**: string (Required): The name of the configuration set that contains the event destination. -* **EventDestination**: [EventDestination](#eventdestination) (Required): The event destination object. -* **Id**: string (ReadOnly, Identifier) - -## EventDestination -### Properties -* **CloudWatchDestination**: [CloudWatchDestination](#cloudwatchdestination): An object that contains the names, default values, and sources of the dimensions associated with an Amazon CloudWatch event destination. -* **Enabled**: bool: Sets whether Amazon SES publishes events to this destination when you send an email with the associated configuration set. Set to true to enable publishing to this destination; set to false to prevent publishing to this destination. The default value is false. -* **KinesisFirehoseDestination**: [KinesisFirehoseDestination](#kinesisfirehosedestination): An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination. -* **MatchingEventTypes**: string[] (Required): The type of email sending events, send, reject, bounce, complaint, delivery, open, click, renderingFailure, deliveryDelay, and subscription. -* **Name**: string: The name of the event destination set. -* **SnsDestination**: [SnsDestination](#snsdestination): An object that contains SNS topic ARN associated event destination. - -## CloudWatchDestination -### Properties -* **DimensionConfigurations**: [DimensionConfiguration](#dimensionconfiguration)[]: A list of dimensions upon which to categorize your emails when you publish email sending events to Amazon CloudWatch. - -## DimensionConfiguration -### Properties -* **DefaultDimensionValue**: string (Required): The default value of the dimension that is published to Amazon CloudWatch if you do not provide the value of the dimension when you send an email. -* **DimensionName**: string (Required): The name of an Amazon CloudWatch dimension associated with an email sending metric. -* **DimensionValueSource**: string (Required): The place where Amazon SES finds the value of a dimension to publish to Amazon CloudWatch. To use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail/SendRawEmail API, specify messageTag. To use your own email headers, specify emailHeader. To put a custom tag on any link included in your email, specify linkTag. - -## KinesisFirehoseDestination -### Properties -* **DeliveryStreamARN**: string (Required): The ARN of the Amazon Kinesis Firehose stream that email sending events should be published to. -* **IAMRoleARN**: string (Required): The ARN of the IAM role under which Amazon SES publishes email sending events to the Amazon Kinesis Firehose stream. - -## SnsDestination -### Properties -* **TopicARN**: string (Required) - ## AWS.SES/ContactListProperties ### Properties * **ContactListName**: string (Identifier): The name of the contact list. @@ -134,18 +72,6 @@ * **Tags**: [Tag](#tag)[]: The tags (keys and values) associated with the contact list. * **Topics**: [Topic](#topic)[]: The topics associated with the contact list. -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - -## Topic -### Properties -* **DefaultSubscriptionStatus**: string (Required) -* **Description**: string: The description of the topic. -* **DisplayName**: string (Required): The display name of the topic. -* **TopicName**: string (Required): The name of the topic. - ## AWS.SES/DedicatedIpPoolProperties ### Properties * **PoolName**: string (Identifier): The name of the dedicated IP pool. @@ -166,10 +92,44 @@ * **FeedbackAttributes**: [FeedbackAttributes](#feedbackattributes) * **MailFromAttributes**: [MailFromAttributes](#mailfromattributes) +## AWS.SES/TemplateProperties +### Properties +* **Id**: string (ReadOnly, Identifier) +* **Template**: [Template](#template) + +## AWS.SES/VdmAttributesProperties +### Properties +* **DashboardAttributes**: [DashboardAttributes](#dashboardattributes) +* **GuardianAttributes**: [GuardianAttributes](#guardianattributes) +* **VdmAttributesResourceId**: string (ReadOnly, Identifier): Unique identifier for this resource + +## CloudWatchDestination +### Properties +* **DimensionConfigurations**: [DimensionConfiguration](#dimensionconfiguration)[]: A list of dimensions upon which to categorize your emails when you publish email sending events to Amazon CloudWatch. + ## ConfigurationSetAttributes ### Properties * **ConfigurationSetName**: string: The configuration set to use by default when sending from this identity. Note that any configuration set defined in the email sending request takes precedence. +## DashboardAttributes +### Properties +* **EngagementMetrics**: string: Whether emails sent from this account have engagement tracking enabled. + +## DashboardOptions +### Properties +* **EngagementMetrics**: string (Required): Whether emails sent with this configuration set have engagement tracking enabled. + +## DeliveryOptions +### Properties +* **SendingPoolName**: string: The name of the dedicated IP pool to associate with the configuration set. +* **TlsPolicy**: string: Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS). If the value is Require , messages are only delivered if a TLS connection can be established. If the value is Optional , messages can be delivered in plain text if a TLS connection can't be established. + +## DimensionConfiguration +### Properties +* **DefaultDimensionValue**: string (Required): The default value of the dimension that is published to Amazon CloudWatch if you do not provide the value of the dimension when you send an email. +* **DimensionName**: string (Required): The name of an Amazon CloudWatch dimension associated with an email sending metric. +* **DimensionValueSource**: string (Required): The place where Amazon SES finds the value of a dimension to publish to Amazon CloudWatch. To use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail/SendRawEmail API, specify messageTag. To use your own email headers, specify emailHeader. To put a custom tag on any link included in your email, specify linkTag. + ## DkimAttributes ### Properties * **SigningEnabled**: bool: Sets the DKIM signing configuration for the identity. When you set this value true, then the messages that are sent from the identity are signed using DKIM. If you set this value to false, your messages are sent without DKIM signing. @@ -180,19 +140,62 @@ * **DomainSigningSelector**: string (WriteOnly): [Bring Your Own DKIM] A string that's used to identify a public key in the DNS configuration for a domain. * **NextSigningKeyLength**: string: [Easy DKIM] The key length of the future DKIM key pair to be generated. This can be changed at most once per day. +## EventBridgeDestination +### Properties +* **EventBusArn**: string (Required) + +## EventDestination +### Properties +* **CloudWatchDestination**: [CloudWatchDestination](#cloudwatchdestination): An object that contains the names, default values, and sources of the dimensions associated with an Amazon CloudWatch event destination. +* **Enabled**: bool: Sets whether Amazon SES publishes events to this destination when you send an email with the associated configuration set. Set to true to enable publishing to this destination; set to false to prevent publishing to this destination. The default value is false. +* **EventBridgeDestination**: [EventBridgeDestination](#eventbridgedestination): An object that contains Event bus ARN associated with the event bridge destination. +* **KinesisFirehoseDestination**: [KinesisFirehoseDestination](#kinesisfirehosedestination): An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination. +* **MatchingEventTypes**: string[] (Required): The type of email sending events, send, reject, bounce, complaint, delivery, open, click, renderingFailure, deliveryDelay, and subscription. +* **Name**: string: The name of the event destination set. +* **SnsDestination**: [SnsDestination](#snsdestination): An object that contains SNS topic ARN associated event destination. + ## FeedbackAttributes ### Properties * **EmailForwardingEnabled**: bool: If the value is true, you receive email notifications when bounce or complaint events occur +## GuardianAttributes +### Properties +* **OptimizedSharedDelivery**: string: Whether emails sent from this account have optimized delivery algorithm enabled. + +## GuardianOptions +### Properties +* **OptimizedSharedDelivery**: string (Required): Whether emails sent with this configuration set have optimized delivery algorithm enabled. + +## KinesisFirehoseDestination +### Properties +* **DeliveryStreamARN**: string (Required): The ARN of the Amazon Kinesis Firehose stream that email sending events should be published to. +* **IAMRoleARN**: string (Required): The ARN of the IAM role under which Amazon SES publishes email sending events to the Amazon Kinesis Firehose stream. + ## MailFromAttributes ### Properties * **BehaviorOnMxFailure**: string: The action to take if the required MX record isn't found when you send an email. When you set this value to UseDefaultValue , the mail is sent using amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage , the Amazon SES API v2 returns a MailFromDomainNotVerified error, and doesn't attempt to deliver the email. * **MailFromDomain**: string: The custom MAIL FROM domain that you want the verified identity to use -## AWS.SES/TemplateProperties +## ReputationOptions ### Properties -* **Id**: string (ReadOnly, Identifier) -* **Template**: [Template](#template) +* **ReputationMetricsEnabled**: bool: If true , tracking of reputation metrics is enabled for the configuration set. If false , tracking of reputation metrics is disabled for the configuration set. + +## SendingOptions +### Properties +* **SendingEnabled**: bool + +## SnsDestination +### Properties +* **TopicARN**: string (Required) + +## SuppressionOptions +### Properties +* **SuppressedReasons**: string[]: A list that contains the reasons that email addresses are automatically added to the suppression list for your account. + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) ## Template ### Properties @@ -201,17 +204,19 @@ * **TemplateName**: string: The name of the template. * **TextPart**: string: The email body that is visible to recipients whose email clients do not display HTML content. -## AWS.SES/VdmAttributesProperties +## Topic ### Properties -* **DashboardAttributes**: [DashboardAttributes](#dashboardattributes) -* **GuardianAttributes**: [GuardianAttributes](#guardianattributes) -* **VdmAttributesResourceId**: string (ReadOnly, Identifier): Unique identifier for this resource +* **DefaultSubscriptionStatus**: string (Required) +* **Description**: string: The description of the topic. +* **DisplayName**: string (Required): The display name of the topic. +* **TopicName**: string (Required): The name of the topic. -## DashboardAttributes +## TrackingOptions ### Properties -* **EngagementMetrics**: string: Whether emails sent from this account have engagement tracking enabled. +* **CustomRedirectDomain**: string: The domain to use for tracking open and click events. -## GuardianAttributes +## VdmOptions ### Properties -* **OptimizedSharedDelivery**: string: Whether emails sent from this account have optimized delivery algorithm enabled. +* **DashboardOptions**: [DashboardOptions](#dashboardoptions) +* **GuardianOptions**: [GuardianOptions](#guardianoptions) diff --git a/artifacts/bicep/aws/aws.shield/default/types.json b/artifacts/bicep/aws/aws.shield/default/types.json index 07382c4e..dba09189 100644 --- a/artifacts/bicep/aws/aws.shield/default/types.json +++ b/artifacts/bicep/aws/aws.shield/default/types.json @@ -1 +1,454 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"AWS.Shield/DRTAccessProperties","Properties":{"AccountId":{"Type":4,"Flags":18},"LogBucketList":{"Type":9,"Flags":0,"Description":"Authorizes 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."},"RoleArn":{"Type":4,"Flags":1,"Description":"Authorizes 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 create or update AWS WAF rules and web ACLs."}}}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.Shield/DRTAccess","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":8,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Shield/DRTAccess@default","ScopeType":0,"Body":10}},{"2":{"Name":"EmergencyContact","Properties":{"ContactNotes":{"Type":4,"Flags":0,"Description":"Additional notes regarding the contact."},"EmailAddress":{"Type":4,"Flags":1,"Description":"The email address for the contact."},"PhoneNumber":{"Type":4,"Flags":0,"Description":"The phone number for the contact"}}}},{"2":{"Name":"AWS.Shield/ProactiveEngagementProperties","Properties":{"AccountId":{"Type":4,"Flags":18},"EmergencyContactList":{"Type":14,"Flags":1,"Description":"A list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you for escalations to the SRT and to initiate proactive customer support.\nTo enable proactive engagement, the contact list must include at least one phone number."},"ProactiveEngagementStatus":{"Type":4,"Flags":1,"Description":"If `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.\nIf `DISABLED`, the SRT will not proactively notify contacts about escalations or to initiate proactive customer support."}}}},{"3":{"ItemType":12}},{"2":{"Name":"AWS.Shield/ProactiveEngagement","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":13,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Shield/ProactiveEngagement@default","ScopeType":0,"Body":15}},{"2":{"Name":"ApplicationLayerAutomaticResponseConfiguration","Properties":{"Action":{"Type":19,"Flags":1,"Description":"Specifies the action setting that Shield Advanced should use in the AWS WAF rules that it creates on behalf of the protected resource in response to DDoS attacks. You specify this as part of the configuration for the automatic application layer DDoS mitigation feature, when 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."},"Status":{"Type":4,"Flags":1,"Description":"Indicates whether automatic application layer DDoS mitigation is enabled for the protection."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as \"customer.\" Tag keys are case-sensitive."},"Value":{"Type":4,"Flags":1,"Description":"Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as \"companyA\" or \"companyB.\" Tag values are case-sensitive."}}}},{"2":{"Name":"Protection_Action","Properties":{}}},{"2":{"Name":"AWS.Shield/ProtectionProperties","Properties":{"ApplicationLayerAutomaticResponseConfiguration":{"Type":17,"Flags":0},"HealthCheckArns":{"Type":21,"Flags":0,"Description":"The Amazon Resource Names (ARNs) of the health check to associate with the protection."},"Name":{"Type":4,"Flags":1,"Description":"Friendly name for the Protection."},"ProtectionArn":{"Type":4,"Flags":18,"Description":"The ARN (Amazon Resource Name) of the protection."},"ProtectionId":{"Type":4,"Flags":2,"Description":"The unique identifier (ID) of the protection."},"ResourceArn":{"Type":4,"Flags":1,"Description":"The ARN (Amazon Resource Name) of the resource to be protected."},"Tags":{"Type":22,"Flags":0,"Description":"One or more tag key-value pairs for the Protection object."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":18}},{"2":{"Name":"AWS.Shield/Protection","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":20,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Shield/Protection@default","ScopeType":0,"Body":23}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as \"customer.\" Tag keys are case-sensitive."},"Value":{"Type":4,"Flags":1,"Description":"Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as \"companyA\" or \"companyB.\" Tag values are case-sensitive."}}}},{"2":{"Name":"AWS.Shield/ProtectionGroupProperties","Properties":{"Aggregation":{"Type":4,"Flags":1,"Description":"Defines 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 and origin resources for CloudFront distributions."},"Members":{"Type":27,"Flags":0,"Description":"The Amazon Resource Names (ARNs) 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."},"Pattern":{"Type":4,"Flags":1,"Description":"The 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 Amazon Resource Names (ARNs), or include all resources of a specified resource type."},"ProtectionGroupArn":{"Type":4,"Flags":18,"Description":"The ARN (Amazon Resource Name) of the protection group."},"ProtectionGroupId":{"Type":4,"Flags":1,"Description":"The 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."},"ResourceType":{"Type":4,"Flags":0,"Description":"The resource type to include in the protection group. All protected resources of this type are included in the protection group. Newly protected resources of this type are automatically added to the group. You must set this when you set `Pattern` to `BY_RESOURCE_TYPE` and you must not set it for any other `Pattern` setting."},"Tags":{"Type":28,"Flags":0,"Description":"One or more tag key-value pairs for the Protection object."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":25}},{"2":{"Name":"AWS.Shield/ProtectionGroup","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":26,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Shield/ProtectionGroup@default","ScopeType":0,"Body":29}}] \ No newline at end of file +[ + { + "$type": "StringLiteralType", + "value": "AWS.Shield/DRTAccessProperties" + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Shield/DRTAccessProperties", + "properties": { + "AccountId": { + "type": { + "$ref": "#/1" + }, + "flags": 18 + }, + "LogBucketList": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "Authorizes 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." + }, + "RoleArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Authorizes 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 create or update AWS WAF rules and web ACLs." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Shield/DRTAccess", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Shield/DRTAccess@default", + "scopeType": 0, + "body": { + "$ref": "#/4" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "EmergencyContact", + "properties": { + "ContactNotes": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Additional notes regarding the contact." + }, + "EmailAddress": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The email address for the contact." + }, + "PhoneNumber": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The phone number for the contact" + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Shield/ProactiveEngagementProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Shield/ProactiveEngagementProperties", + "properties": { + "AccountId": { + "type": { + "$ref": "#/1" + }, + "flags": 18 + }, + "EmergencyContactList": { + "type": { + "$ref": "#/8" + }, + "flags": 1, + "description": "A list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you for escalations to the SRT and to initiate proactive customer support.\nTo enable proactive engagement, the contact list must include at least one phone number." + }, + "ProactiveEngagementStatus": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "If `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.\nIf `DISABLED`, the SRT will not proactively notify contacts about escalations or to initiate proactive customer support." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Shield/ProactiveEngagement", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/9" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Shield/ProactiveEngagement@default", + "scopeType": 0, + "body": { + "$ref": "#/10" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "ApplicationLayerAutomaticResponseConfiguration", + "properties": { + "Action": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "Specifies the action setting that Shield Advanced should use in the AWS WAF rules that it creates on behalf of the protected resource in response to DDoS attacks. You specify this as part of the configuration for the automatic application layer DDoS mitigation feature, when 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." + }, + "Status": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Indicates whether automatic application layer DDoS mitigation is enabled for the protection." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as \"customer.\" Tag keys are case-sensitive." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as \"companyA\" or \"companyB.\" Tag values are case-sensitive." + } + } + }, + { + "$type": "ObjectType", + "name": "Protection_Action", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.Shield/ProtectionProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Shield/ProtectionProperties", + "properties": { + "ApplicationLayerAutomaticResponseConfiguration": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + }, + "HealthCheckArns": { + "type": { + "$ref": "#/16" + }, + "flags": 0, + "description": "The Amazon Resource Names (ARNs) of the health check to associate with the protection." + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Friendly name for the Protection." + }, + "ProtectionArn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The ARN (Amazon Resource Name) of the protection." + }, + "ProtectionId": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The unique identifier (ID) of the protection." + }, + "ResourceArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The ARN (Amazon Resource Name) of the resource to be protected." + }, + "Tags": { + "type": { + "$ref": "#/17" + }, + "flags": 0, + "description": "One or more tag key-value pairs for the Protection object." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Shield/Protection", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/18" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Shield/Protection@default", + "scopeType": 0, + "body": { + "$ref": "#/19" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as \"customer.\" Tag keys are case-sensitive." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as \"companyA\" or \"companyB.\" Tag values are case-sensitive." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Shield/ProtectionGroupProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/21" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Shield/ProtectionGroupProperties", + "properties": { + "Aggregation": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Defines 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 and origin resources for CloudFront distributions." + }, + "Members": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "The Amazon Resource Names (ARNs) 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." + }, + "Pattern": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The 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 Amazon Resource Names (ARNs), or include all resources of a specified resource type." + }, + "ProtectionGroupArn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The ARN (Amazon Resource Name) of the protection group." + }, + "ProtectionGroupId": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The 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." + }, + "ResourceType": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The resource type to include in the protection group. All protected resources of this type are included in the protection group. Newly protected resources of this type are automatically added to the group. You must set this when you set `Pattern` to `BY_RESOURCE_TYPE` and you must not set it for any other `Pattern` setting." + }, + "Tags": { + "type": { + "$ref": "#/24" + }, + "flags": 0, + "description": "One or more tag key-value pairs for the Protection object." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Shield/ProtectionGroup", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/25" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Shield/ProtectionGroup@default", + "scopeType": 0, + "body": { + "$ref": "#/26" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.shield/default/types.md b/artifacts/bicep/aws/aws.shield/default/types.md index b9caed73..68b25614 100644 --- a/artifacts/bicep/aws/aws.shield/default/types.md +++ b/artifacts/bicep/aws/aws.shield/default/types.md @@ -3,30 +3,35 @@ ## Resource AWS.Shield/DRTAccess@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Shield/DRTAccessProperties](#awsshielddrtaccessproperties) (Required): properties of the resource +* **properties**: [AWS.Shield/DRTAccessProperties](#awsshielddrtaccessproperties) (Required, Identifier): properties of the resource ## Resource AWS.Shield/ProactiveEngagement@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Shield/ProactiveEngagementProperties](#awsshieldproactiveengagementproperties) (Required): properties of the resource +* **properties**: [AWS.Shield/ProactiveEngagementProperties](#awsshieldproactiveengagementproperties) (Required, Identifier): properties of the resource ## Resource AWS.Shield/Protection@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Shield/ProtectionProperties](#awsshieldprotectionproperties) (Required): properties of the resource +* **properties**: [AWS.Shield/ProtectionProperties](#awsshieldprotectionproperties) (Required, Identifier): properties of the resource ## Resource AWS.Shield/ProtectionGroup@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Shield/ProtectionGroupProperties](#awsshieldprotectiongroupproperties) (Required): properties of the resource +* **properties**: [AWS.Shield/ProtectionGroupProperties](#awsshieldprotectiongroupproperties) (Required, Identifier): properties of the resource + +## ApplicationLayerAutomaticResponseConfiguration +### Properties +* **Action**: [Protection_Action](#protectionaction) (Required): Specifies the action setting that Shield Advanced should use in the AWS WAF rules that it creates on behalf of the protected resource in response to DDoS attacks. You specify this as part of the configuration for the automatic application layer DDoS mitigation feature, when 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. +* **Status**: string (Required): Indicates whether automatic application layer DDoS mitigation is enabled for the protection. ## AWS.Shield/DRTAccessProperties ### Properties @@ -42,11 +47,18 @@ To enable proactive engagement, the contact list must include at least one phone * **ProactiveEngagementStatus**: string (Required): If `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. If `DISABLED`, the SRT will not proactively notify contacts about escalations or to initiate proactive customer support. -## EmergencyContact +## AWS.Shield/ProtectionGroupProperties ### Properties -* **ContactNotes**: string: Additional notes regarding the contact. -* **EmailAddress**: string (Required): The email address for the contact. -* **PhoneNumber**: string: The phone number for the contact +* **Aggregation**: string (Required): Defines how AWS Shield combines resource data for the group in order to detect, mitigate, and report events. +* 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. +* 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. +* 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 and origin resources for CloudFront distributions. +* **Members**: string[]: The Amazon Resource Names (ARNs) 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. +* **Pattern**: string (Required): The 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 Amazon Resource Names (ARNs), or include all resources of a specified resource type. +* **ProtectionGroupArn**: string (ReadOnly, Identifier): The ARN (Amazon Resource Name) of the protection group. +* **ProtectionGroupId**: string (Required): The 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. +* **ResourceType**: string: The resource type to include in the protection group. All protected resources of this type are included in the protection group. Newly protected resources of this type are automatically added to the group. You must set this when you set `Pattern` to `BY_RESOURCE_TYPE` and you must not set it for any other `Pattern` setting. +* **Tags**: [Tag](#tag)[]: One or more tag key-value pairs for the Protection object. ## AWS.Shield/ProtectionProperties ### Properties @@ -58,10 +70,11 @@ If `DISABLED`, the SRT will not proactively notify contacts about escalations or * **ResourceArn**: string (Required): The ARN (Amazon Resource Name) of the resource to be protected. * **Tags**: [Tag](#tag)[]: One or more tag key-value pairs for the Protection object. -## ApplicationLayerAutomaticResponseConfiguration +## EmergencyContact ### Properties -* **Action**: [Protection_Action](#protectionaction) (Required): Specifies the action setting that Shield Advanced should use in the AWS WAF rules that it creates on behalf of the protected resource in response to DDoS attacks. You specify this as part of the configuration for the automatic application layer DDoS mitigation feature, when 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. -* **Status**: string (Required): Indicates whether automatic application layer DDoS mitigation is enabled for the protection. +* **ContactNotes**: string: Additional notes regarding the contact. +* **EmailAddress**: string (Required): The email address for the contact. +* **PhoneNumber**: string: The phone number for the contact ## Protection_Action ### Properties @@ -71,19 +84,6 @@ If `DISABLED`, the SRT will not proactively notify contacts about escalations or * **Key**: string (Required): Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive. * **Value**: string (Required): Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive. -## AWS.Shield/ProtectionGroupProperties -### Properties -* **Aggregation**: string (Required): Defines how AWS Shield combines resource data for the group in order to detect, mitigate, and report events. -* 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. -* 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. -* 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 and origin resources for CloudFront distributions. -* **Members**: string[]: The Amazon Resource Names (ARNs) 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. -* **Pattern**: string (Required): The 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 Amazon Resource Names (ARNs), or include all resources of a specified resource type. -* **ProtectionGroupArn**: string (ReadOnly, Identifier): The ARN (Amazon Resource Name) of the protection group. -* **ProtectionGroupId**: string (Required): The 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. -* **ResourceType**: string: The resource type to include in the protection group. All protected resources of this type are included in the protection group. Newly protected resources of this type are automatically added to the group. You must set this when you set `Pattern` to `BY_RESOURCE_TYPE` and you must not set it for any other `Pattern` setting. -* **Tags**: [Tag](#tag)[]: One or more tag key-value pairs for the Protection object. - ## Tag ### Properties * **Key**: string (Required): Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive. diff --git a/artifacts/bicep/aws/aws.signer/default/types.json b/artifacts/bicep/aws/aws.signer/default/types.json index 4d8369a8..0867e10c 100644 --- a/artifacts/bicep/aws/aws.signer/default/types.json +++ b/artifacts/bicep/aws/aws.signer/default/types.json @@ -1 +1,165 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"Arn"}},{"2":{"Name":"PlatformId"}},{"2":{"Name":"ProfileVersion"}},{"2":{"Name":"SignatureValidityPeriod","Properties":{"Type":{"Type":4,"Flags":0},"Value":{"Type":3,"Flags":0}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":0},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"AWS.Signer/SigningProfileProperties","Properties":{"Arn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN) of the specified signing profile."},"PlatformId":{"Type":4,"Flags":1,"Description":"The ID of the target signing platform."},"ProfileName":{"Type":4,"Flags":2,"Description":"A name for the signing profile. AWS CloudFormation generates a unique physical ID and uses that ID for the signing profile name. "},"ProfileVersion":{"Type":4,"Flags":2,"Description":"A version for the signing profile. AWS Signer generates a unique version for each profile of the same profile name."},"ProfileVersionArn":{"Type":4,"Flags":2,"Description":"The Amazon Resource Name (ARN) of the specified signing profile version."},"SignatureValidityPeriod":{"Type":11,"Flags":0,"Description":"Signature validity period of the profile."},"Tags":{"Type":14,"Flags":0,"Description":"A list of tags associated with the signing profile."}}}},{"3":{"ItemType":12}},{"2":{"Name":"AWS.Signer/SigningProfile","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":13,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Signer/SigningProfile@default","ScopeType":0,"Body":15}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Arn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PlatformId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ProfileName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ProfileVersion", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SignatureValidityPeriod", + "properties": { + "Type": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "IntegerType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.Signer/SigningProfileProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Signer/SigningProfileProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/6" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) of the specified signing profile." + }, + "PlatformId": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "The ID of the target signing platform." + }, + "ProfileName": { + "type": { + "$ref": "#/6" + }, + "flags": 2, + "description": "A name for the signing profile. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the signing profile name. " + }, + "ProfileVersion": { + "type": { + "$ref": "#/6" + }, + "flags": 2, + "description": "A version for the signing profile. AWS Signer generates a unique version for each profile of the same profile name." + }, + "ProfileVersionArn": { + "type": { + "$ref": "#/6" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) of the specified signing profile version." + }, + "SignatureValidityPeriod": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Signature validity period of the profile." + }, + "Tags": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "A list of tags associated with the signing profile." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Signer/SigningProfile", + "properties": { + "name": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/6" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/10" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Signer/SigningProfile@default", + "scopeType": 0, + "body": { + "$ref": "#/11" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.signer/default/types.md b/artifacts/bicep/aws/aws.signer/default/types.md index 5ca6de6d..3eeb05c6 100644 --- a/artifacts/bicep/aws/aws.signer/default/types.md +++ b/artifacts/bicep/aws/aws.signer/default/types.md @@ -3,15 +3,15 @@ ## Resource AWS.Signer/SigningProfile@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Signer/SigningProfileProperties](#awssignersigningprofileproperties) (Required): properties of the resource +* **properties**: [AWS.Signer/SigningProfileProperties](#awssignersigningprofileproperties) (Required, Identifier): properties of the resource ## AWS.Signer/SigningProfileProperties ### Properties * **Arn**: string (ReadOnly, Identifier): The Amazon Resource Name (ARN) of the specified signing profile. * **PlatformId**: string (Required): The ID of the target signing platform. -* **ProfileName**: string (ReadOnly): A name for the signing profile. AWS CloudFormation generates a unique physical ID and uses that ID for the signing profile name. +* **ProfileName**: string (ReadOnly): A name for the signing profile. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the signing profile name. * **ProfileVersion**: string (ReadOnly): A version for the signing profile. AWS Signer generates a unique version for each profile of the same profile name. * **ProfileVersionArn**: string (ReadOnly): The Amazon Resource Name (ARN) of the specified signing profile version. * **SignatureValidityPeriod**: [SignatureValidityPeriod](#signaturevalidityperiod): Signature validity period of the profile. diff --git a/artifacts/bicep/aws/aws.simspaceweaver/default/types.json b/artifacts/bicep/aws/aws.simspaceweaver/default/types.json index 0c03ac3b..5bcb556a 100644 --- a/artifacts/bicep/aws/aws.simspaceweaver/default/types.json +++ b/artifacts/bicep/aws/aws.simspaceweaver/default/types.json @@ -1 +1,111 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"S3Location","Properties":{"BucketName":{"Type":4,"Flags":1,"Description":"The Schema S3 bucket name."},"ObjectKey":{"Type":4,"Flags":1,"Description":"This is the schema S3 object key, which includes the full path of \"folders\" from the bucket root to the schema."}}}},{"2":{"Name":"AWS.SimSpaceWeaver/SimulationProperties","Properties":{"DescribePayload":{"Type":4,"Flags":2,"Description":"Json object with all simulation details"},"MaximumDuration":{"Type":4,"Flags":0,"Description":"The maximum running time of the simulation."},"Name":{"Type":4,"Flags":17,"Description":"The name of the simulation."},"RoleArn":{"Type":4,"Flags":1,"Description":"Role ARN."},"SchemaS3Location":{"Type":8,"Flags":0},"SnapshotS3Location":{"Type":8,"Flags":0}}}},{"2":{"Name":"AWS.SimSpaceWeaver/Simulation","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":9,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.SimSpaceWeaver/Simulation@default","ScopeType":0,"Body":10}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "S3Location", + "properties": { + "BucketName": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The Schema S3 bucket name." + }, + "ObjectKey": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "This is the schema S3 object key, which includes the full path of \"folders\" from the bucket root to the schema." + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.SimSpaceWeaver/SimulationProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.SimSpaceWeaver/SimulationProperties", + "properties": { + "DescribePayload": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "Json object with all simulation details" + }, + "MaximumDuration": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The maximum running time of the simulation." + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The name of the simulation." + }, + "RoleArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Role ARN." + }, + "SchemaS3Location": { + "type": { + "$ref": "#/0" + }, + "flags": 0 + }, + "SnapshotS3Location": { + "type": { + "$ref": "#/0" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SimSpaceWeaver/Simulation", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SimSpaceWeaver/Simulation@default", + "scopeType": 0, + "body": { + "$ref": "#/4" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.simspaceweaver/default/types.md b/artifacts/bicep/aws/aws.simspaceweaver/default/types.md index 8e6f8d7e..fc1a50e0 100644 --- a/artifacts/bicep/aws/aws.simspaceweaver/default/types.md +++ b/artifacts/bicep/aws/aws.simspaceweaver/default/types.md @@ -3,9 +3,9 @@ ## Resource AWS.SimSpaceWeaver/Simulation@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.SimSpaceWeaver/SimulationProperties](#awssimspaceweaversimulationproperties) (Required): properties of the resource +* **properties**: [AWS.SimSpaceWeaver/SimulationProperties](#awssimspaceweaversimulationproperties) (Required, Identifier): properties of the resource ## AWS.SimSpaceWeaver/SimulationProperties ### Properties diff --git a/artifacts/bicep/aws/aws.sns/default/types.json b/artifacts/bicep/aws/aws.sns/default/types.json index 78ca13af..bae12991 100644 --- a/artifacts/bicep/aws/aws.sns/default/types.json +++ b/artifacts/bicep/aws/aws.sns/default/types.json @@ -1 +1,312 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"LoggingConfig","Properties":{"FailureFeedbackRoleArn":{"Type":4,"Flags":0,"Description":"The IAM role ARN to be used when logging failed message deliveries in Amazon CloudWatch"},"Protocol":{"Type":4,"Flags":1,"Description":"Indicates one of the supported protocols for the SNS topic"},"SuccessFeedbackRoleArn":{"Type":4,"Flags":0,"Description":"The IAM role ARN to be used when logging successful message deliveries in Amazon CloudWatch"},"SuccessFeedbackSampleRate":{"Type":4,"Flags":0,"Description":"The percentage of successful message deliveries to be logged in Amazon CloudWatch. Valid percentage values range from 0 to 100"}}}},{"2":{"Name":"Subscription","Properties":{"Endpoint":{"Type":4,"Flags":1},"Protocol":{"Type":4,"Flags":1}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, `_`, `.`, `/`, `=`, `+`, and `-`."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 characters in length."}}}},{"2":{"Name":"AWS.SNS/TopicProperties","Properties":{"ArchivePolicy":{"Type":12,"Flags":0,"Description":"The archive policy determines the number of days Amazon SNS retains messages. You can set a retention period from 1 to 365 days."},"ContentBasedDeduplication":{"Type":2,"Flags":0,"Description":"Enables content-based deduplication for FIFO topics. By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and this attribute is false, you must specify a value for the MessageDeduplicationId parameter for the Publish action.\n\nWhen you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).\n\n(Optional) To override the generated value, you can specify a value for the the MessageDeduplicationId parameter for the Publish action.\n\n"},"DataProtectionPolicy":{"Type":13,"Flags":0,"Description":"The body of the policy document you want to use for this topic.\n\nYou can only add one policy per topic.\n\nThe policy must be in JSON string format.\n\nLength Constraints: Maximum length of 30720"},"DeliveryStatusLogging":{"Type":14,"Flags":0,"Description":"Delivery status logging configuration for supported protocols for an Amazon SNS topic."},"DisplayName":{"Type":4,"Flags":0,"Description":"The display name to use for an Amazon SNS topic with SMS subscriptions."},"FifoTopic":{"Type":2,"Flags":0,"Description":"Set to true to create a FIFO topic."},"KmsMasterKeyId":{"Type":4,"Flags":0,"Description":"The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the AWS Key Management Service API Reference.\n\nThis property applies only to [server-side-encryption](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html)."},"SignatureVersion":{"Type":4,"Flags":0,"Description":"Version of the Amazon SNS signature used. If the SignatureVersion is 1, Signature is a Base64-encoded SHA1withRSA signature of the Message, MessageId, Type, Timestamp, and TopicArn values. If the SignatureVersion is 2, Signature is a Base64-encoded SHA256withRSA signature of the Message, MessageId, Type, Timestamp, and TopicArn values."},"Subscription":{"Type":15,"Flags":0,"Description":"The SNS subscriptions (endpoints) for this topic."},"Tags":{"Type":16,"Flags":0},"TopicArn":{"Type":4,"Flags":18},"TopicName":{"Type":4,"Flags":0,"Description":"The name of the topic you want to create. Topic names must include only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. FIFO topic names must end with .fifo.\n\nIf you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the topic name. For more information, see Name Type."},"TracingConfig":{"Type":4,"Flags":0,"Description":"Tracing mode of an Amazon SNS topic. By default TracingConfig is set to PassThrough, and the topic passes through the tracing header it receives from an SNS publisher to its subscriptions. If set to Active, SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. Only supported on standard topics."}}}},{"2":{"Name":"Topic_ArchivePolicy","Properties":{}}},{"2":{"Name":"Topic_DataProtectionPolicy","Properties":{}}},{"3":{"ItemType":8}},{"3":{"ItemType":9}},{"3":{"ItemType":10}},{"2":{"Name":"AWS.SNS/Topic","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":11,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.SNS/Topic@default","ScopeType":0,"Body":17}},{"2":{"Name":"AWS.SNS/TopicInlinePolicyProperties","Properties":{"PolicyDocument":{"Type":20,"Flags":1,"Description":"A policy document that contains permissions to add to the specified SNS topics."},"TopicArn":{"Type":4,"Flags":17,"Description":"The Amazon Resource Name (ARN) of the topic to which you want to add the policy."}}}},{"2":{"Name":"TopicInlinePolicy_PolicyDocument","Properties":{}}},{"2":{"Name":"AWS.SNS/TopicInlinePolicy","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":19,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.SNS/TopicInlinePolicy@default","ScopeType":0,"Body":21}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "LoggingConfig", + "properties": { + "FailureFeedbackRoleArn": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "" + }, + "Protocol": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "" + }, + "SuccessFeedbackRoleArn": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "" + }, + "SuccessFeedbackSampleRate": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "" + } + } + }, + { + "$type": "ObjectType", + "name": "Subscription", + "properties": { + "Endpoint": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The endpoint that receives notifications from the SNS topic. The endpoint value depends on the protocol that you specify. For more information, see the ``Endpoint`` parameter of the ``Subscribe`` action in the *API Reference*." + }, + "Protocol": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The subscription's protocol. For more information, see the ``Protocol`` parameter of the ``Subscribe`` action in the *API Reference*." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The required key portion of the tag." + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The optional value portion of the tag." + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.SNS/TopicProperties" + }, + { + "$type": "ObjectType", + "name": "Topic_ArchivePolicy", + "properties": {} + }, + { + "$type": "BooleanType" + }, + { + "$type": "ObjectType", + "name": "Topic_DataProtectionPolicy", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ObjectType", + "name": "AWS.SNS/TopicProperties", + "properties": { + "ArchivePolicy": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The archive policy determines the number of days SNS retains messages. You can set a retention period from 1 to 365 days." + }, + "ContentBasedDeduplication": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Enables content-based deduplication for FIFO topics.\n + By default, ``ContentBasedDeduplication`` is set to ``false``. If you create a FIFO topic and this attribute is ``false``, you must specify a value for the ``MessageDeduplicationId`` parameter for the [Publish](https://docs.aws.amazon.com/sns/latest/api/API_Publish.html) action. \n + When you set ``ContentBasedDeduplication`` to ``true``, SNS uses a SHA-256 hash to generate the ``MessageDeduplicationId`` using the body of the message (but not the attributes of the message).\n (Optional) To override the generated value, you can specify a value for the the ``MessageDeduplicationId`` parameter for the ``Publish`` action." + }, + "DataProtectionPolicy": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "The body of the policy document you want to use for this topic.\n You can only add one policy per topic.\n The policy must be in JSON string format.\n Length Constraints: Maximum length of 30,720." + }, + "DeliveryStatusLogging": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "" + }, + "DisplayName": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The display name to use for an SNS topic with SMS subscriptions. The display name must be maximum 100 characters long, including hyphens (-), underscores (_), spaces, and tabs." + }, + "FifoTopic": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Set to true to create a FIFO topic." + }, + "KmsMasterKeyId": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The ID of an AWS managed customer master key (CMK) for SNS or a custom CMK. For more information, see [Key terms](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms). For more examples, see ``KeyId`` in the *API Reference*.\n This property applies only to [server-side-encryption](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html)." + }, + "SignatureVersion": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By default, ``SignatureVersion`` is set to ``1``." + }, + "Subscription": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "The SNS subscriptions (endpoints) for this topic.\n If you specify the ``Subscription`` property in the ``AWS::SNS::Topic`` resource and it creates an associated subscription resource, the associated subscription is not deleted when the ``AWS::SNS::Topic`` resource is deleted." + }, + "Tags": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "The list of tags to add to a new topic.\n To be able to tag a topic on creation, you must have the ``sns:CreateTopic`` and ``sns:TagResource`` permissions." + }, + "TopicArn": { + "type": { + "$ref": "#/3" + }, + "flags": 18, + "description": "" + }, + "TopicName": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The name of the topic you want to create. Topic names must include only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. FIFO topic names must end with ``.fifo``.\n If you don't specify a name, CFN generates a unique physical ID and uses that ID for the topic name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).\n If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name." + }, + "TracingConfig": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "Tracing mode of an SNS topic. By default ``TracingConfig`` is set to ``PassThrough``, and the topic passes through the tracing header it receives from an SNS publisher to its subscriptions. If set to ``Active``, SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SNS/Topic", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/11" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SNS/Topic@default", + "scopeType": 0, + "body": { + "$ref": "#/12" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.SNS/TopicInlinePolicyProperties" + }, + { + "$type": "ObjectType", + "name": "TopicInlinePolicy_PolicyDocument", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AWS.SNS/TopicInlinePolicyProperties", + "properties": { + "PolicyDocument": { + "type": { + "$ref": "#/15" + }, + "flags": 1, + "description": "A policy document that contains permissions to add to the specified SNS topics." + }, + "TopicArn": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "The Amazon Resource Name (ARN) of the topic to which you want to add the policy." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SNS/TopicInlinePolicy", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/16" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SNS/TopicInlinePolicy@default", + "scopeType": 0, + "body": { + "$ref": "#/17" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.sns/default/types.md b/artifacts/bicep/aws/aws.sns/default/types.md index 0ae9549f..5ed857ec 100644 --- a/artifacts/bicep/aws/aws.sns/default/types.md +++ b/artifacts/bicep/aws/aws.sns/default/types.md @@ -3,76 +3,71 @@ ## Resource AWS.SNS/Topic@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.SNS/TopicProperties](#awssnstopicproperties): properties of the resource +* **properties**: [AWS.SNS/TopicProperties](#awssnstopicproperties) (Identifier): properties of the resource ## Resource AWS.SNS/TopicInlinePolicy@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.SNS/TopicInlinePolicyProperties](#awssnstopicinlinepolicyproperties) (Required): properties of the resource +* **properties**: [AWS.SNS/TopicInlinePolicyProperties](#awssnstopicinlinepolicyproperties) (Required, Identifier): properties of the resource -## AWS.SNS/TopicProperties +## AWS.SNS/TopicInlinePolicyProperties ### Properties -* **ArchivePolicy**: [Topic_ArchivePolicy](#topicarchivepolicy): The archive policy determines the number of days Amazon SNS retains messages. You can set a retention period from 1 to 365 days. -* **ContentBasedDeduplication**: bool: Enables content-based deduplication for FIFO topics. By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and this attribute is false, you must specify a value for the MessageDeduplicationId parameter for the Publish action. - -When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message). - -(Optional) To override the generated value, you can specify a value for the the MessageDeduplicationId parameter for the Publish action. - +* **PolicyDocument**: [TopicInlinePolicy_PolicyDocument](#topicinlinepolicypolicydocument) (Required): A policy document that contains permissions to add to the specified SNS topics. +* **TopicArn**: string (Required, Identifier): The Amazon Resource Name (ARN) of the topic to which you want to add the policy. +## AWS.SNS/TopicProperties +### Properties +* **ArchivePolicy**: [Topic_ArchivePolicy](#topicarchivepolicy): The archive policy determines the number of days SNS retains messages. You can set a retention period from 1 to 365 days. +* **ContentBasedDeduplication**: bool: Enables content-based deduplication for FIFO topics. + + By default, ``ContentBasedDeduplication`` is set to ``false``. If you create a FIFO topic and this attribute is ``false``, you must specify a value for the ``MessageDeduplicationId`` parameter for the [Publish](https://docs.aws.amazon.com/sns/latest/api/API_Publish.html) action. + + When you set ``ContentBasedDeduplication`` to ``true``, SNS uses a SHA-256 hash to generate the ``MessageDeduplicationId`` using the body of the message (but not the attributes of the message). + (Optional) To override the generated value, you can specify a value for the the ``MessageDeduplicationId`` parameter for the ``Publish`` action. * **DataProtectionPolicy**: [Topic_DataProtectionPolicy](#topicdataprotectionpolicy): The body of the policy document you want to use for this topic. - -You can only add one policy per topic. - -The policy must be in JSON string format. - -Length Constraints: Maximum length of 30720 -* **DeliveryStatusLogging**: [LoggingConfig](#loggingconfig)[]: Delivery status logging configuration for supported protocols for an Amazon SNS topic. -* **DisplayName**: string: The display name to use for an Amazon SNS topic with SMS subscriptions. + You can only add one policy per topic. + The policy must be in JSON string format. + Length Constraints: Maximum length of 30,720. +* **DeliveryStatusLogging**: [LoggingConfig](#loggingconfig)[] +* **DisplayName**: string: The display name to use for an SNS topic with SMS subscriptions. The display name must be maximum 100 characters long, including hyphens (-), underscores (_), spaces, and tabs. * **FifoTopic**: bool: Set to true to create a FIFO topic. -* **KmsMasterKeyId**: string: The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the AWS Key Management Service API Reference. - -This property applies only to [server-side-encryption](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html). -* **SignatureVersion**: string: Version of the Amazon SNS signature used. If the SignatureVersion is 1, Signature is a Base64-encoded SHA1withRSA signature of the Message, MessageId, Type, Timestamp, and TopicArn values. If the SignatureVersion is 2, Signature is a Base64-encoded SHA256withRSA signature of the Message, MessageId, Type, Timestamp, and TopicArn values. +* **KmsMasterKeyId**: string: The ID of an AWS managed customer master key (CMK) for SNS or a custom CMK. For more information, see [Key terms](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms). For more examples, see ``KeyId`` in the *API Reference*. + This property applies only to [server-side-encryption](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html). +* **SignatureVersion**: string: The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By default, ``SignatureVersion`` is set to ``1``. * **Subscription**: [Subscription](#subscription)[]: The SNS subscriptions (endpoints) for this topic. -* **Tags**: [Tag](#tag)[] + If you specify the ``Subscription`` property in the ``AWS::SNS::Topic`` resource and it creates an associated subscription resource, the associated subscription is not deleted when the ``AWS::SNS::Topic`` resource is deleted. +* **Tags**: [Tag](#tag)[]: The list of tags to add to a new topic. + To be able to tag a topic on creation, you must have the ``sns:CreateTopic`` and ``sns:TagResource`` permissions. * **TopicArn**: string (ReadOnly, Identifier) -* **TopicName**: string: The name of the topic you want to create. Topic names must include only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. FIFO topic names must end with .fifo. - -If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the topic name. For more information, see Name Type. -* **TracingConfig**: string: Tracing mode of an Amazon SNS topic. By default TracingConfig is set to PassThrough, and the topic passes through the tracing header it receives from an SNS publisher to its subscriptions. If set to Active, SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. Only supported on standard topics. - -## Topic_ArchivePolicy -### Properties - -## Topic_DataProtectionPolicy -### Properties +* **TopicName**: string: The name of the topic you want to create. Topic names must include only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. FIFO topic names must end with ``.fifo``. + If you don't specify a name, CFN generates a unique physical ID and uses that ID for the topic name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html). + If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. +* **TracingConfig**: string: Tracing mode of an SNS topic. By default ``TracingConfig`` is set to ``PassThrough``, and the topic passes through the tracing header it receives from an SNS publisher to its subscriptions. If set to ``Active``, SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. ## LoggingConfig ### Properties -* **FailureFeedbackRoleArn**: string: The IAM role ARN to be used when logging failed message deliveries in Amazon CloudWatch -* **Protocol**: string (Required): Indicates one of the supported protocols for the SNS topic -* **SuccessFeedbackRoleArn**: string: The IAM role ARN to be used when logging successful message deliveries in Amazon CloudWatch -* **SuccessFeedbackSampleRate**: string: The percentage of successful message deliveries to be logged in Amazon CloudWatch. Valid percentage values range from 0 to 100 +* **FailureFeedbackRoleArn**: string +* **Protocol**: string (Required) +* **SuccessFeedbackRoleArn**: string +* **SuccessFeedbackSampleRate**: string ## Subscription ### Properties -* **Endpoint**: string (Required) -* **Protocol**: string (Required) +* **Endpoint**: string (Required): The endpoint that receives notifications from the SNS topic. The endpoint value depends on the protocol that you specify. For more information, see the ``Endpoint`` parameter of the ``Subscribe`` action in the *API Reference*. +* **Protocol**: string (Required): The subscription's protocol. For more information, see the ``Protocol`` parameter of the ``Subscribe`` action in the *API Reference*. ## Tag ### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, `_`, `.`, `/`, `=`, `+`, and `-`. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 characters in length. +* **Key**: string (Required): The required key portion of the tag. +* **Value**: string (Required): The optional value portion of the tag. -## AWS.SNS/TopicInlinePolicyProperties +## Topic_ArchivePolicy +### Properties + +## Topic_DataProtectionPolicy ### Properties -* **PolicyDocument**: [TopicInlinePolicy_PolicyDocument](#topicinlinepolicypolicydocument) (Required): A policy document that contains permissions to add to the specified SNS topics. -* **TopicArn**: string (Required, Identifier): The Amazon Resource Name (ARN) of the topic to which you want to add the policy. ## TopicInlinePolicy_PolicyDocument ### Properties diff --git a/artifacts/bicep/aws/aws.sqs/default/types.json b/artifacts/bicep/aws/aws.sqs/default/types.json index ebfcbb9f..906895ec 100644 --- a/artifacts/bicep/aws/aws.sqs/default/types.json +++ b/artifacts/bicep/aws/aws.sqs/default/types.json @@ -1 +1,306 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.SQS/QueueProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"Amazon Resource Name (ARN) of the queue."},"ContentBasedDeduplication":{"Type":2,"Flags":0,"Description":"For first-in-first-out (FIFO) queues, specifies whether to enable content-based deduplication. During the deduplication interval, Amazon SQS treats messages that are sent with identical content as duplicates and delivers only one copy of the message."},"DeduplicationScope":{"Type":4,"Flags":0,"Description":"Specifies whether message deduplication occurs at the message group or queue level. Valid values are messageGroup and queue."},"DelaySeconds":{"Type":3,"Flags":0,"Description":"The time in seconds for which the delivery of all messages in the queue is delayed. You can specify an integer value of 0 to 900 (15 minutes). The default value is 0."},"FifoQueue":{"Type":2,"Flags":0,"Description":"If set to true, creates a FIFO queue. If you don't specify this property, Amazon SQS creates a standard queue."},"FifoThroughputLimit":{"Type":4,"Flags":0,"Description":"Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId. The perMessageGroupId value is allowed only when the value for DeduplicationScope is messageGroup."},"KmsDataKeyReusePeriodSeconds":{"Type":3,"Flags":0,"Description":"The length of time in seconds for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. The value must be an integer between 60 (1 minute) and 86,400 (24 hours). The default is 300 (5 minutes)."},"KmsMasterKeyId":{"Type":4,"Flags":0,"Description":"The ID of an AWS managed customer master key (CMK) for Amazon SQS or a custom CMK. To use the AWS managed CMK for Amazon SQS, specify the (default) alias alias/aws/sqs."},"MaximumMessageSize":{"Type":3,"Flags":0,"Description":"The limit of how many bytes that a message can contain before Amazon SQS rejects it. You can specify an integer value from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). The default value is 262,144 (256 KiB)."},"MessageRetentionPeriod":{"Type":3,"Flags":0,"Description":"The number of seconds that Amazon SQS retains a message. You can specify an integer value from 60 seconds (1 minute) to 1,209,600 seconds (14 days). The default value is 345,600 seconds (4 days)."},"QueueName":{"Type":4,"Flags":0,"Description":"A name for the queue. To create a FIFO queue, the name of your FIFO queue must end with the .fifo suffix."},"QueueUrl":{"Type":4,"Flags":18,"Description":"URL of the source queue."},"ReceiveMessageWaitTimeSeconds":{"Type":3,"Flags":0,"Description":"Specifies the duration, in seconds, that the ReceiveMessage action call waits until a message is in the queue in order to include it in the response, rather than returning an empty response if a message isn't yet available. You can specify an integer from 1 to 20. Short polling is used as the default or when you specify 0 for this property."},"RedriveAllowPolicy":{"Type":11,"Flags":0,"Description":"The string that includes the parameters for the permissions for the dead-letter queue redrive permission and which source queues can specify dead-letter queues as a JSON object."},"RedrivePolicy":{"Type":13,"Flags":0,"Description":"A string that includes the parameters for the dead-letter queue functionality (redrive policy) of the source queue."},"SqsManagedSseEnabled":{"Type":2,"Flags":0,"Description":"Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (e.g. SSE-KMS or SSE-SQS )."},"Tags":{"Type":14,"Flags":0,"Description":"The tags that you attach to this queue."},"VisibilityTimeout":{"Type":3,"Flags":0,"Description":"The length of time during which a message will be unavailable after a message is delivered from the queue. This blocks other components from receiving the same message and gives the initial component time to process and delete the message from the queue. Values 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."}}}},{"2":{"Name":"Queue_RedriveAllowPolicy","Properties":{}}},{"5":{"Elements":[10,4]}},{"2":{"Name":"Queue_RedrivePolicy","Properties":{}}},{"5":{"Elements":[12,4]}},{"3":{"ItemType":8}},{"2":{"Name":"AWS.SQS/Queue","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":9,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.SQS/Queue@default","ScopeType":0,"Body":15}},{"2":{"Name":"AWS.SQS/QueueInlinePolicyProperties","Properties":{"PolicyDocument":{"Type":18,"Flags":1,"Description":"A policy document that contains permissions to add to the specified SQS queue"},"Queue":{"Type":4,"Flags":17,"Description":"The URL of the SQS queue."}}}},{"2":{"Name":"QueueInlinePolicy_PolicyDocument","Properties":{}}},{"2":{"Name":"AWS.SQS/QueueInlinePolicy","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":17,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.SQS/QueueInlinePolicy@default","ScopeType":0,"Body":19}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.SQS/QueueProperties" + }, + { + "$type": "BooleanType" + }, + { + "$type": "IntegerType" + }, + { + "$type": "ObjectType", + "name": "Queue_RedriveAllowPolicy", + "properties": {} + }, + { + "$type": "UnionType", + "elements": [ + { + "$ref": "#/5" + }, + { + "$ref": "#/1" + } + ] + }, + { + "$type": "ObjectType", + "name": "Queue_RedrivePolicy", + "properties": {} + }, + { + "$type": "UnionType", + "elements": [ + { + "$ref": "#/7" + }, + { + "$ref": "#/1" + } + ] + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ObjectType", + "name": "AWS.SQS/QueueProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "" + }, + "ContentBasedDeduplication": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "For first-in-first-out (FIFO) queues, specifies whether to enable content-based deduplication. During the deduplication interval, SQS treats messages that are sent with identical content as duplicates and delivers only one copy of the message. For more information, see the ``ContentBasedDeduplication`` attribute for the ``CreateQueue`` action in the *API Reference*." + }, + "DeduplicationScope": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "For high throughput for FIFO queues, specifies whether message deduplication occurs at the message group or queue level. Valid values are ``messageGroup`` and ``queue``.\n To enable high throughput for a FIFO queue, set this attribute to ``messageGroup`` *and* set the ``FifoThroughputLimit`` attribute to ``perMessageGroupId``. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see [High throughput for FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html) and [Quotas related to messages](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) in the *Developer Guide*." + }, + "DelaySeconds": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The time in seconds for which the delivery of all messages in the queue is delayed. You can specify an integer value of ``0`` to ``900`` (15 minutes). The default value is ``0``." + }, + "FifoQueue": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "If set to true, creates a FIFO queue. If you don't specify this property, SQS creates a standard queue. For more information, see [FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html) in the *Developer Guide*." + }, + "FifoThroughputLimit": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "For high throughput for FIFO queues, specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are ``perQueue`` and ``perMessageGroupId``.\n To enable high throughput for a FIFO queue, set this attribute to ``perMessageGroupId`` *and* set the ``DeduplicationScope`` attribute to ``messageGroup``. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see [High throughput for FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html) and [Quotas related to messages](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) in the *Developer Guide*." + }, + "KmsDataKeyReusePeriodSeconds": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The length of time in seconds for which SQS can reuse a data key to encrypt or decrypt messages before calling KMS again. The value must be an integer between 60 (1 minute) and 86,400 (24 hours). The default is 300 (5 minutes).\n A shorter time period provides better security, but results in more calls to 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 *Developer Guide*." + }, + "KmsMasterKeyId": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The ID of an AWS Key Management Service (KMS) for SQS, or a custom KMS. To use the AWS managed KMS for SQS, specify a (default) alias ARN, alias name (e.g. ``alias/aws/sqs``), key ARN, or key ID. For more information, see the following:\n + [Encryption at rest](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html) in the *Developer Guide* \n + [CreateQueue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html) in the *API Reference* \n + [Request Parameters](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters) in the *Key Management Service API Reference* \n + The Key Management Service (KMS) section of the [Best Practices](https://docs.aws.amazon.com/https://d0.awsstatic.com/whitepapers/aws-kms-best-practices.pdf) whitepaper" + }, + "MaximumMessageSize": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The limit of how many bytes that a message can contain before SQS rejects it. You can specify an integer value from ``1,024`` bytes (1 KiB) to ``262,144`` bytes (256 KiB). The default value is ``262,144`` (256 KiB)." + }, + "MessageRetentionPeriod": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The number of seconds that SQS retains a message. You can specify an integer value from ``60`` seconds (1 minute) to ``1,209,600`` seconds (14 days). The default value is ``345,600`` seconds (4 days)." + }, + "QueueName": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A name for the queue. To create a FIFO queue, the name of your FIFO queue must end with the ``.fifo`` suffix. For more information, see [FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html) in the *Developer Guide*.\n If you don't specify a name, CFN generates a unique physical ID and uses that ID for the queue name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) in the *User Guide*. \n If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name." + }, + "QueueUrl": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "" + }, + "ReceiveMessageWaitTimeSeconds": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Specifies the duration, in seconds, that the ReceiveMessage action call waits until a message is in the queue in order to include it in the response, rather than returning an empty response if a message isn't yet available. You can specify an integer from 1 to 20. Short polling is used as the default or when you specify 0 for this property. For more information, see [Consuming messages using long polling](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-short-and-long-polling.html#sqs-long-polling) in the *Developer Guide*." + }, + "RedriveAllowPolicy": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "The string that includes the parameters for the permissions for the dead-letter queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:\n + ``redrivePermission``: The permission type that defines which source queues can specify the current queue as the dead-letter queue. Valid values are:\n + ``allowAll``: (Default) Any source queues in this AWS account in the same Region can specify this queue as the dead-letter queue.\n + ``denyAll``: No source queues can specify this queue as the dead-letter queue.\n + ``byQueue``: Only queues specified by the ``sourceQueueArns`` parameter can specify this queue as the dead-letter queue.\n \n + ``sourceQueueArns``: The Amazon Resource Names (ARN)s of the source queues that can specify this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the ``redrivePermission`` parameter is set to ``byQueue``. You can specify up to 10 source queue ARNs. To allow more than 10 source queues to specify dead-letter queues, set the ``redrivePermission`` parameter to ``allowAll``." + }, + "RedrivePolicy": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. The parameters are as follows:\n + ``deadLetterTargetArn``: The Amazon Resource Name (ARN) of the dead-letter queue to which SQS moves messages after the value of ``maxReceiveCount`` is exceeded.\n + ``maxReceiveCount``: The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the ``ReceiveCount`` for a message exceeds the ``maxReceiveCount`` for a queue, SQS moves the message to the dead-letter-queue.\n \n The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue.\n *JSON* \n ``{ \"deadLetterTargetArn\" : String, \"maxReceiveCount\" : Integer }`` \n *YAML* \n ``deadLetterTargetArn : String`` \n ``maxReceiveCount : Integer``" + }, + "SqsManagedSseEnabled": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (for example, [SSE-KMS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html) or [SSE-SQS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html)). When ``SqsManagedSseEnabled`` is not defined, ``SSE-SQS`` encryption is enabled by default." + }, + "Tags": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "The tags that you attach to this queue. For more information, see [Resource tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) in the *User Guide*." + }, + "VisibilityTimeout": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The length of time during which a message will be unavailable after a message is delivered from the queue. This blocks other components from receiving the same message and gives the initial component time to process and delete the message from the queue.\n Values 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.\n For more information about SQS queue visibility timeouts, see [Visibility timeout](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) in the *Developer Guide*." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SQS/Queue", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/10" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SQS/Queue@default", + "scopeType": 0, + "body": { + "$ref": "#/11" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.SQS/QueueInlinePolicyProperties" + }, + { + "$type": "ObjectType", + "name": "QueueInlinePolicy_PolicyDocument", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AWS.SQS/QueueInlinePolicyProperties", + "properties": { + "PolicyDocument": { + "type": { + "$ref": "#/14" + }, + "flags": 1, + "description": "A policy document that contains permissions to add to the specified SQS queue" + }, + "Queue": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The URL of the SQS queue." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SQS/QueueInlinePolicy", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/15" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SQS/QueueInlinePolicy@default", + "scopeType": 0, + "body": { + "$ref": "#/16" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.sqs/default/types.md b/artifacts/bicep/aws/aws.sqs/default/types.md index 575636e3..f944b995 100644 --- a/artifacts/bicep/aws/aws.sqs/default/types.md +++ b/artifacts/bicep/aws/aws.sqs/default/types.md @@ -3,48 +3,74 @@ ## Resource AWS.SQS/Queue@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.SQS/QueueProperties](#awssqsqueueproperties): properties of the resource +* **properties**: [AWS.SQS/QueueProperties](#awssqsqueueproperties) (Identifier): properties of the resource ## Resource AWS.SQS/QueueInlinePolicy@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.SQS/QueueInlinePolicyProperties](#awssqsqueueinlinepolicyproperties) (Required): properties of the resource - -## AWS.SQS/QueueProperties -### Properties -* **Arn**: string (ReadOnly): Amazon Resource Name (ARN) of the queue. -* **ContentBasedDeduplication**: bool: For first-in-first-out (FIFO) queues, specifies whether to enable content-based deduplication. During the deduplication interval, Amazon SQS treats messages that are sent with identical content as duplicates and delivers only one copy of the message. -* **DeduplicationScope**: string: Specifies whether message deduplication occurs at the message group or queue level. Valid values are messageGroup and queue. -* **DelaySeconds**: int: The time in seconds for which the delivery of all messages in the queue is delayed. You can specify an integer value of 0 to 900 (15 minutes). The default value is 0. -* **FifoQueue**: bool: If set to true, creates a FIFO queue. If you don't specify this property, Amazon SQS creates a standard queue. -* **FifoThroughputLimit**: string: Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId. The perMessageGroupId value is allowed only when the value for DeduplicationScope is messageGroup. -* **KmsDataKeyReusePeriodSeconds**: int: The length of time in seconds for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. The value must be an integer between 60 (1 minute) and 86,400 (24 hours). The default is 300 (5 minutes). -* **KmsMasterKeyId**: string: The ID of an AWS managed customer master key (CMK) for Amazon SQS or a custom CMK. To use the AWS managed CMK for Amazon SQS, specify the (default) alias alias/aws/sqs. -* **MaximumMessageSize**: int: The limit of how many bytes that a message can contain before Amazon SQS rejects it. You can specify an integer value from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). The default value is 262,144 (256 KiB). -* **MessageRetentionPeriod**: int: The number of seconds that Amazon SQS retains a message. You can specify an integer value from 60 seconds (1 minute) to 1,209,600 seconds (14 days). The default value is 345,600 seconds (4 days). -* **QueueName**: string: A name for the queue. To create a FIFO queue, the name of your FIFO queue must end with the .fifo suffix. -* **QueueUrl**: string (ReadOnly, Identifier): URL of the source queue. -* **ReceiveMessageWaitTimeSeconds**: int: Specifies the duration, in seconds, that the ReceiveMessage action call waits until a message is in the queue in order to include it in the response, rather than returning an empty response if a message isn't yet available. You can specify an integer from 1 to 20. Short polling is used as the default or when you specify 0 for this property. -* **RedriveAllowPolicy**: [Queue_RedriveAllowPolicy](#queueredriveallowpolicy) | string: The string that includes the parameters for the permissions for the dead-letter queue redrive permission and which source queues can specify dead-letter queues as a JSON object. -* **RedrivePolicy**: [Queue_RedrivePolicy](#queueredrivepolicy) | string: A string that includes the parameters for the dead-letter queue functionality (redrive policy) of the source queue. -* **SqsManagedSseEnabled**: bool: Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (e.g. SSE-KMS or SSE-SQS ). -* **Tags**: [Tag](#tag)[]: The tags that you attach to this queue. -* **VisibilityTimeout**: int: The length of time during which a message will be unavailable after a message is delivered from the queue. This blocks other components from receiving the same message and gives the initial component time to process and delete the message from the queue. Values 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. - -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **properties**: [AWS.SQS/QueueInlinePolicyProperties](#awssqsqueueinlinepolicyproperties) (Required, Identifier): properties of the resource ## AWS.SQS/QueueInlinePolicyProperties ### Properties * **PolicyDocument**: [QueueInlinePolicy_PolicyDocument](#queueinlinepolicypolicydocument) (Required): A policy document that contains permissions to add to the specified SQS queue * **Queue**: string (Required, Identifier): The URL of the SQS queue. +## AWS.SQS/QueueProperties +### Properties +* **Arn**: string (ReadOnly) +* **ContentBasedDeduplication**: bool: For first-in-first-out (FIFO) queues, specifies whether to enable content-based deduplication. During the deduplication interval, SQS treats messages that are sent with identical content as duplicates and delivers only one copy of the message. For more information, see the ``ContentBasedDeduplication`` attribute for the ``CreateQueue`` action in the *API Reference*. +* **DeduplicationScope**: string: For high throughput for FIFO queues, specifies whether message deduplication occurs at the message group or queue level. Valid values are ``messageGroup`` and ``queue``. + To enable high throughput for a FIFO queue, set this attribute to ``messageGroup`` *and* set the ``FifoThroughputLimit`` attribute to ``perMessageGroupId``. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see [High throughput for FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html) and [Quotas related to messages](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) in the *Developer Guide*. +* **DelaySeconds**: int: The time in seconds for which the delivery of all messages in the queue is delayed. You can specify an integer value of ``0`` to ``900`` (15 minutes). The default value is ``0``. +* **FifoQueue**: bool: If set to true, creates a FIFO queue. If you don't specify this property, SQS creates a standard queue. For more information, see [FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html) in the *Developer Guide*. +* **FifoThroughputLimit**: string: For high throughput for FIFO queues, specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are ``perQueue`` and ``perMessageGroupId``. + To enable high throughput for a FIFO queue, set this attribute to ``perMessageGroupId`` *and* set the ``DeduplicationScope`` attribute to ``messageGroup``. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see [High throughput for FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html) and [Quotas related to messages](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) in the *Developer Guide*. +* **KmsDataKeyReusePeriodSeconds**: int: The length of time in seconds for which SQS can reuse a data key to encrypt or decrypt messages before calling KMS again. The value must be an integer between 60 (1 minute) and 86,400 (24 hours). The default is 300 (5 minutes). + A shorter time period provides better security, but results in more calls to 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 *Developer Guide*. +* **KmsMasterKeyId**: string: The ID of an AWS Key Management Service (KMS) for SQS, or a custom KMS. To use the AWS managed KMS for SQS, specify a (default) alias ARN, alias name (e.g. ``alias/aws/sqs``), key ARN, or key ID. For more information, see the following: + + [Encryption at rest](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html) in the *Developer Guide* + + [CreateQueue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html) in the *API Reference* + + [Request Parameters](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters) in the *Key Management Service API Reference* + + The Key Management Service (KMS) section of the [Best Practices](https://docs.aws.amazon.com/https://d0.awsstatic.com/whitepapers/aws-kms-best-practices.pdf) whitepaper +* **MaximumMessageSize**: int: The limit of how many bytes that a message can contain before SQS rejects it. You can specify an integer value from ``1,024`` bytes (1 KiB) to ``262,144`` bytes (256 KiB). The default value is ``262,144`` (256 KiB). +* **MessageRetentionPeriod**: int: The number of seconds that SQS retains a message. You can specify an integer value from ``60`` seconds (1 minute) to ``1,209,600`` seconds (14 days). The default value is ``345,600`` seconds (4 days). +* **QueueName**: string: A name for the queue. To create a FIFO queue, the name of your FIFO queue must end with the ``.fifo`` suffix. For more information, see [FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html) in the *Developer Guide*. + If you don't specify a name, CFN generates a unique physical ID and uses that ID for the queue name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) in the *User Guide*. + If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. +* **QueueUrl**: string (ReadOnly, Identifier) +* **ReceiveMessageWaitTimeSeconds**: int: Specifies the duration, in seconds, that the ReceiveMessage action call waits until a message is in the queue in order to include it in the response, rather than returning an empty response if a message isn't yet available. You can specify an integer from 1 to 20. Short polling is used as the default or when you specify 0 for this property. For more information, see [Consuming messages using long polling](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-short-and-long-polling.html#sqs-long-polling) in the *Developer Guide*. +* **RedriveAllowPolicy**: [Queue_RedriveAllowPolicy](#queueredriveallowpolicy) | string: The string that includes the parameters for the permissions for the dead-letter queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows: + + ``redrivePermission``: The permission type that defines which source queues can specify the current queue as the dead-letter queue. Valid values are: + + ``allowAll``: (Default) Any source queues in this AWS account in the same Region can specify this queue as the dead-letter queue. + + ``denyAll``: No source queues can specify this queue as the dead-letter queue. + + ``byQueue``: Only queues specified by the ``sourceQueueArns`` parameter can specify this queue as the dead-letter queue. + + + ``sourceQueueArns``: The Amazon Resource Names (ARN)s of the source queues that can specify this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the ``redrivePermission`` parameter is set to ``byQueue``. You can specify up to 10 source queue ARNs. To allow more than 10 source queues to specify dead-letter queues, set the ``redrivePermission`` parameter to ``allowAll``. +* **RedrivePolicy**: [Queue_RedrivePolicy](#queueredrivepolicy) | string: The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. The parameters are as follows: + + ``deadLetterTargetArn``: The Amazon Resource Name (ARN) of the dead-letter queue to which SQS moves messages after the value of ``maxReceiveCount`` is exceeded. + + ``maxReceiveCount``: The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the ``ReceiveCount`` for a message exceeds the ``maxReceiveCount`` for a queue, SQS moves the message to the dead-letter-queue. + + The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue. + *JSON* + ``{ "deadLetterTargetArn" : String, "maxReceiveCount" : Integer }`` + *YAML* + ``deadLetterTargetArn : String`` + ``maxReceiveCount : Integer`` +* **SqsManagedSseEnabled**: bool: Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (for example, [SSE-KMS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html) or [SSE-SQS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html)). When ``SqsManagedSseEnabled`` is not defined, ``SSE-SQS`` encryption is enabled by default. +* **Tags**: [Tag](#tag)[]: The tags that you attach to this queue. For more information, see [Resource tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) in the *User Guide*. +* **VisibilityTimeout**: int: The length of time during which a message will be unavailable after a message is delivered from the queue. This blocks other components from receiving the same message and gives the initial component time to process and delete the message from the queue. + Values 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. + For more information about SQS queue visibility timeouts, see [Visibility timeout](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) in the *Developer Guide*. + ## QueueInlinePolicy_PolicyDocument ### Properties +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + diff --git a/artifacts/bicep/aws/aws.ssm/default/types.json b/artifacts/bicep/aws/aws.ssm/default/types.json index 2eb9523f..8f999c19 100644 --- a/artifacts/bicep/aws/aws.ssm/default/types.json +++ b/artifacts/bicep/aws/aws.ssm/default/types.json @@ -1 +1,1223 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"InstanceAssociationOutputLocation","Properties":{"S3Location":{"Type":12,"Flags":0}}}},{"2":{"Name":"ParameterValues"}},{"2":{"Name":"S3BucketName"}},{"2":{"Name":"S3KeyPrefix"}},{"2":{"Name":"S3OutputLocation","Properties":{"OutputS3BucketName":{"Type":4,"Flags":0},"OutputS3KeyPrefix":{"Type":4,"Flags":0},"OutputS3Region":{"Type":4,"Flags":0}}}},{"2":{"Name":"S3Region"}},{"2":{"Name":"Target","Properties":{"Key":{"Type":4,"Flags":1},"Values":{"Type":16,"Flags":1}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.SSM/AssociationProperties","Properties":{"ApplyOnlyAtCronInterval":{"Type":2,"Flags":0},"AssociationId":{"Type":4,"Flags":18,"Description":"Unique identifier of the association."},"AssociationName":{"Type":4,"Flags":0,"Description":"The name of the association."},"AutomationTargetParameterName":{"Type":4,"Flags":0},"CalendarNames":{"Type":18,"Flags":0},"ComplianceSeverity":{"Type":4,"Flags":0},"DocumentVersion":{"Type":4,"Flags":0,"Description":"The version of the SSM document to associate with the target."},"InstanceId":{"Type":4,"Flags":0,"Description":"The ID of the instance that the SSM document is associated with."},"MaxConcurrency":{"Type":4,"Flags":0},"MaxErrors":{"Type":4,"Flags":0},"Name":{"Type":4,"Flags":1,"Description":"The name of the SSM document."},"OutputLocation":{"Type":8,"Flags":0},"Parameters":{"Type":19,"Flags":0,"Description":"Parameter values that the SSM document uses at runtime."},"ScheduleExpression":{"Type":4,"Flags":0,"Description":"A Cron or Rate expression that specifies when the association is applied to the target."},"ScheduleOffset":{"Type":3,"Flags":0},"SyncCompliance":{"Type":4,"Flags":0},"Targets":{"Type":20,"Flags":0,"Description":"The targets that the SSM document sends commands to."},"WaitForSuccessTimeoutSeconds":{"Type":3,"Flags":4}}}},{"3":{"ItemType":4}},{"2":{"Name":"Association_Parameters","Properties":{}}},{"3":{"ItemType":14}},{"2":{"Name":"AWS.SSM/Association","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":17,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.SSM/Association@default","ScopeType":0,"Body":21}},{"2":{"Name":"AttachmentsSource","Properties":{"Key":{"Type":4,"Flags":0,"Description":"The key of a key-value pair that identifies the location of an attachment to a document."},"Name":{"Type":4,"Flags":16,"Description":"The name of the document attachment file."},"Values":{"Type":26,"Flags":0,"Description":"The value of a key-value pair that identifies the location of an attachment to a document. The format for Value depends on the type of key you specify."}}}},{"2":{"Name":"DocumentRequires","Properties":{"Name":{"Type":4,"Flags":16,"Description":"The name of the required SSM document. The name can be an Amazon Resource Name (ARN)."},"Version":{"Type":4,"Flags":0,"Description":"The document version required by the current document."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":0,"Description":"The name of the tag."},"Value":{"Type":4,"Flags":0,"Description":"The value of the tag."}}}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.SSM/DocumentProperties","Properties":{"Attachments":{"Type":28,"Flags":4,"Description":"A list of key and value pairs that describe attachments to a version of a document."},"Content":{"Type":30,"Flags":1,"Description":"The content for the Systems Manager document in JSON, YAML or String format."},"DocumentFormat":{"Type":4,"Flags":0,"Description":"Specify the document format for the request. The document format can be either JSON or YAML. JSON is the default format."},"DocumentType":{"Type":4,"Flags":0,"Description":"The type of document to create."},"Name":{"Type":4,"Flags":16,"Description":"A name for the Systems Manager document."},"Requires":{"Type":31,"Flags":0,"Description":"A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document."},"Tags":{"Type":32,"Flags":0,"Description":"Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment."},"TargetType":{"Type":4,"Flags":0,"Description":"Specify a target type to define the kinds of resources the document can run on."},"UpdateMethod":{"Type":4,"Flags":4,"Description":"Update method - when set to 'Replace', the update will replace the existing document; when set to 'NewVersion', the update will create a new version."},"VersionName":{"Type":4,"Flags":0,"Description":"An optional field specifying the version of the artifact you are creating with the document. This value is unique across all versions of a document, and cannot be changed."}}}},{"3":{"ItemType":23}},{"2":{"Name":"Document_Content","Properties":{}}},{"5":{"Elements":[29,4]}},{"3":{"ItemType":24}},{"3":{"ItemType":25}},{"2":{"Name":"AWS.SSM/Document","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":27,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.SSM/Document@default","ScopeType":0,"Body":33}},{"2":{"Name":"AWS.SSM/ParameterProperties","Properties":{"AllowedPattern":{"Type":4,"Flags":4,"Description":"The regular expression used to validate the parameter value."},"DataType":{"Type":4,"Flags":0,"Description":"The corresponding DataType of the parameter."},"Description":{"Type":4,"Flags":4,"Description":"The information about the parameter."},"Name":{"Type":4,"Flags":16,"Description":"The name of the parameter."},"Policies":{"Type":4,"Flags":4,"Description":"The policies attached to the parameter."},"Tags":{"Type":36,"Flags":4,"Description":"A key-value pair to associate with a resource."},"Tier":{"Type":4,"Flags":4,"Description":"The corresponding tier of the parameter."},"Type":{"Type":4,"Flags":1,"Description":"The type of the parameter."},"Value":{"Type":4,"Flags":1,"Description":"The value associated with the parameter."}}}},{"2":{"Name":"Parameter_Tags","Properties":{}}},{"2":{"Name":"AWS.SSM/Parameter","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":35,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.SSM/Parameter@default","ScopeType":0,"Body":37}},{"2":{"Name":"PatchFilter","Properties":{"Key":{"Type":4,"Flags":0},"Values":{"Type":45,"Flags":0}}}},{"2":{"Name":"PatchFilterGroup","Properties":{"PatchFilters":{"Type":46,"Flags":0}}}},{"2":{"Name":"PatchSource","Properties":{"Configuration":{"Type":4,"Flags":0},"Name":{"Type":4,"Flags":0},"Products":{"Type":47,"Flags":0}}}},{"2":{"Name":"Rule","Properties":{"ApproveAfterDays":{"Type":3,"Flags":0},"ApproveUntilDate":{"Type":4,"Flags":0},"ComplianceLevel":{"Type":4,"Flags":0},"EnableNonSecurity":{"Type":2,"Flags":0},"PatchFilterGroup":{"Type":40,"Flags":0}}}},{"2":{"Name":"RuleGroup","Properties":{"PatchRules":{"Type":48,"Flags":0}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"3":{"ItemType":4}},{"3":{"ItemType":39}},{"3":{"ItemType":4}},{"3":{"ItemType":42}},{"2":{"Name":"AWS.SSM/PatchBaselineProperties","Properties":{"ApprovalRules":{"Type":43,"Flags":0},"ApprovedPatches":{"Type":50,"Flags":0,"Description":"A list of explicitly approved patches for the baseline."},"ApprovedPatchesComplianceLevel":{"Type":4,"Flags":0,"Description":"Defines the compliance level for approved patches. This means that if an approved patch is reported as missing, this is the severity of the compliance violation. The default value is UNSPECIFIED."},"ApprovedPatchesEnableNonSecurity":{"Type":2,"Flags":0,"Description":"Indicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is 'false'. Applies to Linux instances only."},"DefaultBaseline":{"Type":2,"Flags":0,"Description":"Set the baseline as default baseline. Only registering to default patch baseline is allowed."},"Description":{"Type":4,"Flags":0,"Description":"The description of the patch baseline."},"GlobalFilters":{"Type":40,"Flags":0,"Description":"A set of global filters used to include patches in the baseline."},"Id":{"Type":4,"Flags":18,"Description":"The ID of the patch baseline."},"Name":{"Type":4,"Flags":1,"Description":"The name of the patch baseline."},"OperatingSystem":{"Type":4,"Flags":0,"Description":"Defines the operating system the patch baseline applies to. The Default value is WINDOWS."},"PatchGroups":{"Type":51,"Flags":0,"Description":"PatchGroups is used to associate instances with a specific patch baseline"},"RejectedPatches":{"Type":52,"Flags":0,"Description":"A list of explicitly rejected patches for the baseline."},"RejectedPatchesAction":{"Type":4,"Flags":0,"Description":"The action for Patch Manager to take on patches included in the RejectedPackages list."},"Sources":{"Type":53,"Flags":0,"Description":"Information about the patches to use to update the instances, including target operating systems and source repository. Applies to Linux instances only."},"Tags":{"Type":54,"Flags":0,"Description":"Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":41}},{"3":{"ItemType":44}},{"2":{"Name":"AWS.SSM/PatchBaseline","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":49,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.SSM/PatchBaseline@default","ScopeType":0,"Body":55}},{"2":{"Name":"AwsOrganizationsSource","Properties":{"OrganizationSourceType":{"Type":4,"Flags":1},"OrganizationalUnits":{"Type":60,"Flags":0}}}},{"2":{"Name":"S3Destination","Properties":{"BucketName":{"Type":4,"Flags":1},"BucketPrefix":{"Type":4,"Flags":0},"BucketRegion":{"Type":4,"Flags":1},"KMSKeyArn":{"Type":4,"Flags":0},"SyncFormat":{"Type":4,"Flags":1}}}},{"2":{"Name":"SyncSource","Properties":{"AwsOrganizationsSource":{"Type":57,"Flags":0},"IncludeFutureRegions":{"Type":2,"Flags":0},"SourceRegions":{"Type":61,"Flags":1},"SourceType":{"Type":4,"Flags":1}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.SSM/ResourceDataSyncProperties","Properties":{"BucketName":{"Type":4,"Flags":0},"BucketPrefix":{"Type":4,"Flags":0},"BucketRegion":{"Type":4,"Flags":0},"KMSKeyArn":{"Type":4,"Flags":0},"S3Destination":{"Type":58,"Flags":0},"SyncFormat":{"Type":4,"Flags":0},"SyncName":{"Type":4,"Flags":19},"SyncSource":{"Type":59,"Flags":0},"SyncType":{"Type":4,"Flags":0}}}},{"2":{"Name":"AWS.SSM/ResourceDataSync","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":62,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.SSM/ResourceDataSync@default","ScopeType":0,"Body":63}},{"2":{"Name":"AWS.SSM/ResourcePolicyProperties","Properties":{"Policy":{"Type":67,"Flags":1,"Description":"Actual policy statement."},"PolicyHash":{"Type":4,"Flags":2,"Description":"A snapshot identifier for the policy over time."},"PolicyId":{"Type":4,"Flags":18,"Description":"An unique identifier within the policies of a resource. "},"ResourceArn":{"Type":4,"Flags":17,"Description":"Arn of OpsItemGroup etc."}}}},{"2":{"Name":"ResourcePolicy_Policy","Properties":{}}},{"5":{"Elements":[66,4]}},{"2":{"Name":"AWS.SSM/ResourcePolicy","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":65,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.SSM/ResourcePolicy@default","ScopeType":0,"Body":68}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "InstanceAssociationOutputLocation", + "properties": { + "S3Location": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ParameterValues", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "S3BucketName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "S3KeyPrefix", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "S3OutputLocation", + "properties": { + "OutputS3BucketName": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "OutputS3KeyPrefix": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "OutputS3Region": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "S3Region", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Target", + "properties": { + "Key": { + "type": { + "$ref": "#/7" + }, + "flags": 1 + }, + "Values": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/7" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/7" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.SSM/AssociationProperties" + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/7" + } + }, + { + "$type": "ObjectType", + "name": "Association_Parameters", + "properties": {} + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ObjectType", + "name": "AWS.SSM/AssociationProperties", + "properties": { + "ApplyOnlyAtCronInterval": { + "type": { + "$ref": "#/11" + }, + "flags": 0 + }, + "AssociationId": { + "type": { + "$ref": "#/7" + }, + "flags": 18, + "description": "Unique identifier of the association." + }, + "AssociationName": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "The name of the association." + }, + "AutomationTargetParameterName": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "CalendarNames": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + }, + "ComplianceSeverity": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "DocumentVersion": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "The version of the SSM document to associate with the target." + }, + "InstanceId": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "The ID of the instance that the SSM document is associated with." + }, + "MaxConcurrency": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "MaxErrors": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "The name of the SSM document." + }, + "OutputLocation": { + "type": { + "$ref": "#/0" + }, + "flags": 0 + }, + "Parameters": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "Parameter values that the SSM document uses at runtime." + }, + "ScheduleExpression": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "A Cron or Rate expression that specifies when the association is applied to the target." + }, + "ScheduleOffset": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + }, + "SyncCompliance": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "Targets": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "The targets that the SSM document sends commands to." + }, + "WaitForSuccessTimeoutSeconds": { + "type": { + "$ref": "#/14" + }, + "flags": 4 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SSM/Association", + "properties": { + "name": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/7" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/16" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SSM/Association@default", + "scopeType": 0, + "body": { + "$ref": "#/17" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AttachmentsSource", + "properties": { + "Key": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "The key of a key-value pair that identifies the location of an attachment to a document." + }, + "Name": { + "type": { + "$ref": "#/7" + }, + "flags": 16, + "description": "The name of the document attachment file." + }, + "Values": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "The value of a key-value pair that identifies the location of an attachment to a document. The format for Value depends on the type of key you specify." + } + } + }, + { + "$type": "ObjectType", + "name": "DocumentRequires", + "properties": { + "Name": { + "type": { + "$ref": "#/7" + }, + "flags": 16, + "description": "The name of the required SSM document. The name can be an Amazon Resource Name (ARN)." + }, + "Version": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "The document version required by the current document." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "The name of the tag." + }, + "Value": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "The value of the tag." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/7" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.SSM/DocumentProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/19" + } + }, + { + "$type": "ObjectType", + "name": "Document_Content", + "properties": {} + }, + { + "$type": "UnionType", + "elements": [ + { + "$ref": "#/25" + }, + { + "$ref": "#/7" + } + ] + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/20" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/21" + } + }, + { + "$type": "ObjectType", + "name": "AWS.SSM/DocumentProperties", + "properties": { + "Attachments": { + "type": { + "$ref": "#/24" + }, + "flags": 4, + "description": "A list of key and value pairs that describe attachments to a version of a document." + }, + "Content": { + "type": { + "$ref": "#/26" + }, + "flags": 1, + "description": "The content for the Systems Manager document in JSON, YAML or String format." + }, + "DocumentFormat": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "Specify the document format for the request. The document format can be either JSON or YAML. JSON is the default format." + }, + "DocumentType": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "The type of document to create." + }, + "Name": { + "type": { + "$ref": "#/7" + }, + "flags": 16, + "description": "A name for the Systems Manager document." + }, + "Requires": { + "type": { + "$ref": "#/27" + }, + "flags": 0, + "description": "A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document." + }, + "Tags": { + "type": { + "$ref": "#/28" + }, + "flags": 0, + "description": "Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment." + }, + "TargetType": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "Specify a target type to define the kinds of resources the document can run on." + }, + "UpdateMethod": { + "type": { + "$ref": "#/7" + }, + "flags": 4, + "description": "Update method - when set to 'Replace', the update will replace the existing document; when set to 'NewVersion', the update will create a new version." + }, + "VersionName": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "An optional field specifying the version of the artifact you are creating with the document. This value is unique across all versions of a document, and cannot be changed." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SSM/Document", + "properties": { + "name": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/7" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/29" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SSM/Document@default", + "scopeType": 0, + "body": { + "$ref": "#/30" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.SSM/ParameterProperties" + }, + { + "$type": "ObjectType", + "name": "Parameter_Tags", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AWS.SSM/ParameterProperties", + "properties": { + "AllowedPattern": { + "type": { + "$ref": "#/7" + }, + "flags": 4, + "description": "A regular expression used to validate the parameter value. For example, for ``String`` types with values restricted to numbers, you can specify the following: ``AllowedPattern=^\\d+$``" + }, + "DataType": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "The data type of the parameter, such as ``text`` or ``aws:ec2:image``. The default is ``text``." + }, + "Description": { + "type": { + "$ref": "#/7" + }, + "flags": 4, + "description": "Information about the parameter." + }, + "Name": { + "type": { + "$ref": "#/7" + }, + "flags": 16, + "description": "The name of the parameter.\n The maximum length constraint listed below includes capacity for additional system attributes that aren't part of the name. The maximum length for a parameter name, including the full length of the parameter Amazon Resource Name (ARN), is 1011 characters. For example, the length of the following parameter name is 65 characters, not 20 characters: ``arn:aws:ssm:us-east-2:111222333444:parameter/ExampleParameterName``" + }, + "Policies": { + "type": { + "$ref": "#/7" + }, + "flags": 4, + "description": "Information about the policies assigned to a parameter.\n [Assigning parameter policies](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html) in the *User Guide*." + }, + "Tags": { + "type": { + "$ref": "#/33" + }, + "flags": 4, + "description": "Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs). Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a SYS parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter." + }, + "Tier": { + "type": { + "$ref": "#/7" + }, + "flags": 4, + "description": "The parameter tier." + }, + "Type": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "The type of parameter." + }, + "Value": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "The parameter value.\n If type is ``StringList``, the system returns a comma-separated string with no spaces between commas in the ``Value`` field." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SSM/Parameter", + "properties": { + "name": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/7" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/34" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SSM/Parameter@default", + "scopeType": 0, + "body": { + "$ref": "#/35" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "PatchFilter", + "properties": { + "Key": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "Values": { + "type": { + "$ref": "#/43" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PatchFilterGroup", + "properties": { + "PatchFilters": { + "type": { + "$ref": "#/44" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PatchSource", + "properties": { + "Configuration": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "Products": { + "type": { + "$ref": "#/45" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Rule", + "properties": { + "ApproveAfterDays": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + }, + "ApproveUntilDate": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "ComplianceLevel": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "EnableNonSecurity": { + "type": { + "$ref": "#/11" + }, + "flags": 0 + }, + "PatchFilterGroup": { + "type": { + "$ref": "#/38" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "RuleGroup", + "properties": { + "PatchRules": { + "type": { + "$ref": "#/46" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/7" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/7" + }, + "flags": 1 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/7" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/37" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/7" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/40" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.SSM/PatchBaselineProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/7" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/7" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/7" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/39" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/42" + } + }, + { + "$type": "ObjectType", + "name": "AWS.SSM/PatchBaselineProperties", + "properties": { + "ApprovalRules": { + "type": { + "$ref": "#/41" + }, + "flags": 0 + }, + "ApprovedPatches": { + "type": { + "$ref": "#/48" + }, + "flags": 0, + "description": "A list of explicitly approved patches for the baseline." + }, + "ApprovedPatchesComplianceLevel": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "Defines the compliance level for approved patches. This means that if an approved patch is reported as missing, this is the severity of the compliance violation. The default value is UNSPECIFIED." + }, + "ApprovedPatchesEnableNonSecurity": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "Indicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is 'false'. Applies to Linux instances only." + }, + "DefaultBaseline": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "Set the baseline as default baseline. Only registering to default patch baseline is allowed." + }, + "Description": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "The description of the patch baseline." + }, + "GlobalFilters": { + "type": { + "$ref": "#/38" + }, + "flags": 0, + "description": "A set of global filters used to include patches in the baseline." + }, + "Id": { + "type": { + "$ref": "#/7" + }, + "flags": 18, + "description": "The ID of the patch baseline." + }, + "Name": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "The name of the patch baseline." + }, + "OperatingSystem": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "Defines the operating system the patch baseline applies to. The Default value is WINDOWS." + }, + "PatchGroups": { + "type": { + "$ref": "#/49" + }, + "flags": 0, + "description": "PatchGroups is used to associate instances with a specific patch baseline" + }, + "RejectedPatches": { + "type": { + "$ref": "#/50" + }, + "flags": 0, + "description": "A list of explicitly rejected patches for the baseline." + }, + "RejectedPatchesAction": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "The action for Patch Manager to take on patches included in the RejectedPackages list." + }, + "Sources": { + "type": { + "$ref": "#/51" + }, + "flags": 0, + "description": "Information about the patches to use to update the instances, including target operating systems and source repository. Applies to Linux instances only." + }, + "Tags": { + "type": { + "$ref": "#/52" + }, + "flags": 0, + "description": "Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SSM/PatchBaseline", + "properties": { + "name": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/7" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/53" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SSM/PatchBaseline@default", + "scopeType": 0, + "body": { + "$ref": "#/54" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AwsOrganizationsSource", + "properties": { + "OrganizationSourceType": { + "type": { + "$ref": "#/7" + }, + "flags": 1 + }, + "OrganizationalUnits": { + "type": { + "$ref": "#/59" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "S3Destination", + "properties": { + "BucketName": { + "type": { + "$ref": "#/7" + }, + "flags": 1 + }, + "BucketPrefix": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "BucketRegion": { + "type": { + "$ref": "#/7" + }, + "flags": 1 + }, + "KMSKeyArn": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "SyncFormat": { + "type": { + "$ref": "#/7" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "SyncSource", + "properties": { + "AwsOrganizationsSource": { + "type": { + "$ref": "#/56" + }, + "flags": 0 + }, + "IncludeFutureRegions": { + "type": { + "$ref": "#/11" + }, + "flags": 0 + }, + "SourceRegions": { + "type": { + "$ref": "#/60" + }, + "flags": 1 + }, + "SourceType": { + "type": { + "$ref": "#/7" + }, + "flags": 1 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/7" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/7" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.SSM/ResourceDataSyncProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.SSM/ResourceDataSyncProperties", + "properties": { + "BucketName": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "BucketPrefix": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "BucketRegion": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "KMSKeyArn": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "S3Destination": { + "type": { + "$ref": "#/57" + }, + "flags": 0 + }, + "SyncFormat": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + }, + "SyncName": { + "type": { + "$ref": "#/7" + }, + "flags": 19 + }, + "SyncSource": { + "type": { + "$ref": "#/58" + }, + "flags": 0 + }, + "SyncType": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SSM/ResourceDataSync", + "properties": { + "name": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/7" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/62" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SSM/ResourceDataSync@default", + "scopeType": 0, + "body": { + "$ref": "#/63" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.SSM/ResourcePolicyProperties" + }, + { + "$type": "ObjectType", + "name": "ResourcePolicy_Policy", + "properties": {} + }, + { + "$type": "UnionType", + "elements": [ + { + "$ref": "#/66" + }, + { + "$ref": "#/7" + } + ] + }, + { + "$type": "ObjectType", + "name": "AWS.SSM/ResourcePolicyProperties", + "properties": { + "Policy": { + "type": { + "$ref": "#/67" + }, + "flags": 1, + "description": "Actual policy statement." + }, + "PolicyHash": { + "type": { + "$ref": "#/7" + }, + "flags": 2, + "description": "A snapshot identifier for the policy over time." + }, + "PolicyId": { + "type": { + "$ref": "#/7" + }, + "flags": 18, + "description": "An unique identifier within the policies of a resource. " + }, + "ResourceArn": { + "type": { + "$ref": "#/7" + }, + "flags": 17, + "description": "Arn of OpsItemGroup etc." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SSM/ResourcePolicy", + "properties": { + "name": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/7" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/68" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SSM/ResourcePolicy@default", + "scopeType": 0, + "body": { + "$ref": "#/69" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.ssm/default/types.md b/artifacts/bicep/aws/aws.ssm/default/types.md index 90f79d1d..f6c1cc67 100644 --- a/artifacts/bicep/aws/aws.ssm/default/types.md +++ b/artifacts/bicep/aws/aws.ssm/default/types.md @@ -3,44 +3,53 @@ ## Resource AWS.SSM/Association@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.SSM/AssociationProperties](#awsssmassociationproperties) (Required): properties of the resource +* **properties**: [AWS.SSM/AssociationProperties](#awsssmassociationproperties) (Required, Identifier): properties of the resource ## Resource AWS.SSM/Document@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.SSM/DocumentProperties](#awsssmdocumentproperties) (Required): properties of the resource +* **properties**: [AWS.SSM/DocumentProperties](#awsssmdocumentproperties) (Required, Identifier): properties of the resource ## Resource AWS.SSM/Parameter@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.SSM/ParameterProperties](#awsssmparameterproperties) (Required): properties of the resource +* **properties**: [AWS.SSM/ParameterProperties](#awsssmparameterproperties) (Required, Identifier): properties of the resource ## Resource AWS.SSM/PatchBaseline@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.SSM/PatchBaselineProperties](#awsssmpatchbaselineproperties) (Required): properties of the resource +* **properties**: [AWS.SSM/PatchBaselineProperties](#awsssmpatchbaselineproperties) (Required, Identifier): properties of the resource ## Resource AWS.SSM/ResourceDataSync@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.SSM/ResourceDataSyncProperties](#awsssmresourcedatasyncproperties) (Required): properties of the resource +* **properties**: [AWS.SSM/ResourceDataSyncProperties](#awsssmresourcedatasyncproperties) (Required, Identifier): properties of the resource ## Resource AWS.SSM/ResourcePolicy@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.SSM/ResourcePolicyProperties](#awsssmresourcepolicyproperties) (Required): properties of the resource +* **properties**: [AWS.SSM/ResourcePolicyProperties](#awsssmresourcepolicyproperties) (Required, Identifier): properties of the resource + +## Association_Parameters +### Properties + +## AttachmentsSource +### Properties +* **Key**: string: The key of a key-value pair that identifies the location of an attachment to a document. +* **Name**: string (Identifier): The name of the document attachment file. +* **Values**: string[]: The value of a key-value pair that identifies the location of an attachment to a document. The format for Value depends on the type of key you specify. ## AWS.SSM/AssociationProperties ### Properties @@ -63,24 +72,6 @@ * **Targets**: [Target](#target)[]: The targets that the SSM document sends commands to. * **WaitForSuccessTimeoutSeconds**: int (WriteOnly) -## InstanceAssociationOutputLocation -### Properties -* **S3Location**: [S3OutputLocation](#s3outputlocation) - -## S3OutputLocation -### Properties -* **OutputS3BucketName**: string -* **OutputS3KeyPrefix**: string -* **OutputS3Region**: string - -## Association_Parameters -### Properties - -## Target -### Properties -* **Key**: string (Required) -* **Values**: string[] (Required) - ## AWS.SSM/DocumentProperties ### Properties * **Attachments**: [AttachmentsSource](#attachmentssource)[] (WriteOnly): A list of key and value pairs that describe attachments to a version of a document. @@ -94,36 +85,20 @@ * **UpdateMethod**: string (WriteOnly): Update method - when set to 'Replace', the update will replace the existing document; when set to 'NewVersion', the update will create a new version. * **VersionName**: string: An optional field specifying the version of the artifact you are creating with the document. This value is unique across all versions of a document, and cannot be changed. -## AttachmentsSource -### Properties -* **Key**: string: The key of a key-value pair that identifies the location of an attachment to a document. -* **Name**: string (Identifier): The name of the document attachment file. -* **Values**: string[]: The value of a key-value pair that identifies the location of an attachment to a document. The format for Value depends on the type of key you specify. - -## DocumentRequires -### Properties -* **Name**: string (Identifier): The name of the required SSM document. The name can be an Amazon Resource Name (ARN). -* **Version**: string: The document version required by the current document. - -## Tag -### Properties -* **Key**: string: The name of the tag. -* **Value**: string: The value of the tag. - ## AWS.SSM/ParameterProperties ### Properties -* **AllowedPattern**: string (WriteOnly): The regular expression used to validate the parameter value. -* **DataType**: string: The corresponding DataType of the parameter. -* **Description**: string (WriteOnly): The information about the parameter. +* **AllowedPattern**: string (WriteOnly): A regular expression used to validate the parameter value. For example, for ``String`` types with values restricted to numbers, you can specify the following: ``AllowedPattern=^\d+$`` +* **DataType**: string: The data type of the parameter, such as ``text`` or ``aws:ec2:image``. The default is ``text``. +* **Description**: string (WriteOnly): Information about the parameter. * **Name**: string (Identifier): The name of the parameter. -* **Policies**: string (WriteOnly): The policies attached to the parameter. -* **Tags**: [Parameter_Tags](#parametertags) (WriteOnly): A key-value pair to associate with a resource. -* **Tier**: string (WriteOnly): The corresponding tier of the parameter. -* **Type**: string (Required): The type of the parameter. -* **Value**: string (Required): The value associated with the parameter. - -## Parameter_Tags -### Properties + The maximum length constraint listed below includes capacity for additional system attributes that aren't part of the name. The maximum length for a parameter name, including the full length of the parameter Amazon Resource Name (ARN), is 1011 characters. For example, the length of the following parameter name is 65 characters, not 20 characters: ``arn:aws:ssm:us-east-2:111222333444:parameter/ExampleParameterName`` +* **Policies**: string (WriteOnly): Information about the policies assigned to a parameter. + [Assigning parameter policies](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html) in the *User Guide*. +* **Tags**: [Parameter_Tags](#parametertags) (WriteOnly): Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs). Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a SYS parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter. +* **Tier**: string (WriteOnly): The parameter tier. +* **Type**: string (Required): The type of parameter. +* **Value**: string (Required): The parameter value. + If type is ``StringList``, the system returns a comma-separated string with no spaces between commas in the ``Value`` field. ## AWS.SSM/PatchBaselineProperties ### Properties @@ -143,49 +118,68 @@ * **Sources**: [PatchSource](#patchsource)[]: Information about the patches to use to update the instances, including target operating systems and source repository. Applies to Linux instances only. * **Tags**: [Tag](#tag)[]: Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways. -## RuleGroup +## AWS.SSM/ResourceDataSyncProperties ### Properties -* **PatchRules**: [Rule](#rule)[] +* **BucketName**: string +* **BucketPrefix**: string +* **BucketRegion**: string +* **KMSKeyArn**: string +* **S3Destination**: [S3Destination](#s3destination) +* **SyncFormat**: string +* **SyncName**: string (Required, ReadOnly, Identifier) +* **SyncSource**: [SyncSource](#syncsource) +* **SyncType**: string -## Rule +## AWS.SSM/ResourcePolicyProperties ### Properties -* **ApproveAfterDays**: int -* **ApproveUntilDate**: string -* **ComplianceLevel**: string -* **EnableNonSecurity**: bool -* **PatchFilterGroup**: [PatchFilterGroup](#patchfiltergroup) +* **Policy**: [ResourcePolicy_Policy](#resourcepolicypolicy) | string (Required): Actual policy statement. +* **PolicyHash**: string (ReadOnly): A snapshot identifier for the policy over time. +* **PolicyId**: string (ReadOnly, Identifier): An unique identifier within the policies of a resource. +* **ResourceArn**: string (Required, Identifier): Arn of OpsItemGroup etc. -## PatchFilterGroup +## AwsOrganizationsSource +### Properties +* **OrganizationalUnits**: string[] +* **OrganizationSourceType**: string (Required) + +## DocumentRequires +### Properties +* **Name**: string (Identifier): The name of the required SSM document. The name can be an Amazon Resource Name (ARN). +* **Version**: string: The document version required by the current document. + +## InstanceAssociationOutputLocation +### Properties +* **S3Location**: [S3OutputLocation](#s3outputlocation) + +## Parameter_Tags ### Properties -* **PatchFilters**: [PatchFilter](#patchfilter)[] ## PatchFilter ### Properties * **Key**: string * **Values**: string[] +## PatchFilterGroup +### Properties +* **PatchFilters**: [PatchFilter](#patchfilter)[] + ## PatchSource ### Properties * **Configuration**: string * **Name**: string * **Products**: string[] -## Tag +## Rule ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **ApproveAfterDays**: int +* **ApproveUntilDate**: string +* **ComplianceLevel**: string +* **EnableNonSecurity**: bool +* **PatchFilterGroup**: [PatchFilterGroup](#patchfiltergroup) -## AWS.SSM/ResourceDataSyncProperties +## RuleGroup ### Properties -* **BucketName**: string -* **BucketPrefix**: string -* **BucketRegion**: string -* **KMSKeyArn**: string -* **S3Destination**: [S3Destination](#s3destination) -* **SyncFormat**: string -* **SyncName**: string (Required, ReadOnly, Identifier) -* **SyncSource**: [SyncSource](#syncsource) -* **SyncType**: string +* **PatchRules**: [Rule](#rule)[] ## S3Destination ### Properties @@ -195,6 +189,12 @@ * **KMSKeyArn**: string * **SyncFormat**: string (Required) +## S3OutputLocation +### Properties +* **OutputS3BucketName**: string +* **OutputS3KeyPrefix**: string +* **OutputS3Region**: string + ## SyncSource ### Properties * **AwsOrganizationsSource**: [AwsOrganizationsSource](#awsorganizationssource) @@ -202,15 +202,18 @@ * **SourceRegions**: string[] (Required) * **SourceType**: string (Required) -## AwsOrganizationsSource +## Tag ### Properties -* **OrganizationalUnits**: string[] -* **OrganizationSourceType**: string (Required) +* **Key**: string: The name of the tag. +* **Value**: string: The value of the tag. -## AWS.SSM/ResourcePolicyProperties +## Tag ### Properties -* **Policy**: [ResourcePolicy_Policy](#resourcepolicypolicy) | string (Required): Actual policy statement. -* **PolicyHash**: string (ReadOnly): A snapshot identifier for the policy over time. -* **PolicyId**: string (ReadOnly, Identifier): An unique identifier within the policies of a resource. -* **ResourceArn**: string (Required, Identifier): Arn of OpsItemGroup etc. +* **Key**: string (Required) +* **Value**: string (Required) + +## Target +### Properties +* **Key**: string (Required) +* **Values**: string[] (Required) diff --git a/artifacts/bicep/aws/aws.ssmcontacts/default/types.json b/artifacts/bicep/aws/aws.ssmcontacts/default/types.json index 67315619..aff7080b 100644 --- a/artifacts/bicep/aws/aws.ssmcontacts/default/types.json +++ b/artifacts/bicep/aws/aws.ssmcontacts/default/types.json @@ -1 +1,752 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"ChannelTargetInfo","Properties":{"ChannelId":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) of the contact channel."},"RetryIntervalInMinutes":{"Type":3,"Flags":1,"Description":"The number of minutes to wait to retry sending engagement in the case the engagement initially fails."}}}},{"2":{"Name":"ContactTargetInfo","Properties":{"ContactId":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) of the contact."},"IsEssential":{"Type":2,"Flags":1,"Description":"A Boolean value determining if the contact's acknowledgement stops the progress of stages in the plan."}}}},{"2":{"Name":"Stage","Properties":{"DurationInMinutes":{"Type":3,"Flags":0,"Description":"The time to wait until beginning the next stage."},"RotationIds":{"Type":12,"Flags":0,"Description":"List of Rotation Ids to associate with Contact"},"Targets":{"Type":13,"Flags":0,"Description":"The contacts or contact methods that the escalation plan or engagement plan is engaging."}}}},{"2":{"Name":"Targets","Properties":{"ChannelTargetInfo":{"Type":8,"Flags":0},"ContactTargetInfo":{"Type":9,"Flags":0}}}},{"3":{"ItemType":4}},{"3":{"ItemType":11}},{"2":{"Name":"AWS.SSMContacts/ContactProperties","Properties":{"Alias":{"Type":4,"Flags":1,"Description":"Alias of the contact. String value with 20 to 256 characters. Only alphabetical, numeric characters, dash, or underscore allowed."},"Arn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN) of the contact."},"DisplayName":{"Type":4,"Flags":1,"Description":"Name of the contact. String value with 3 to 256 characters. Only alphabetical, space, numeric characters, dash, or underscore allowed."},"Plan":{"Type":15,"Flags":4,"Description":"The stages that an escalation plan or engagement plan engages contacts and contact methods in."},"Type":{"Type":4,"Flags":1,"Description":"Contact type, which specify type of contact. Currently supported values: ?PERSONAL?, ?SHARED?, ?OTHER?."}}}},{"3":{"ItemType":10}},{"2":{"Name":"AWS.SSMContacts/Contact","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":14,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.SSMContacts/Contact@default","ScopeType":0,"Body":16}},{"2":{"Name":"AWS.SSMContacts/ContactChannelProperties","Properties":{"Arn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN) of the engagement to a contact channel."},"ChannelAddress":{"Type":4,"Flags":1,"Description":"The details that SSM Incident Manager uses when trying to engage the contact channel."},"ChannelName":{"Type":4,"Flags":1,"Description":"The device name. String of 6 to 50 alphabetical, numeric, dash, and underscore characters."},"ChannelType":{"Type":4,"Flags":1,"Description":"Device type, which specify notification channel. Currently supported values: ?SMS?, ?VOICE?, ?EMAIL?, ?CHATBOT."},"ContactId":{"Type":4,"Flags":1,"Description":"ARN of the contact resource"},"DeferActivation":{"Type":2,"Flags":4,"Description":"If you want to activate the channel at a later time, you can choose to defer activation. SSM Incident Manager can't engage your contact channel until it has been activated."}}}},{"2":{"Name":"AWS.SSMContacts/ContactChannel","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":18,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.SSMContacts/ContactChannel@default","ScopeType":0,"Body":19}},{"2":{"Name":"ChannelTargetInfo","Properties":{"ChannelId":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) of the contact channel."},"RetryIntervalInMinutes":{"Type":3,"Flags":1,"Description":"The number of minutes to wait to retry sending engagement in the case the engagement initially fails."}}}},{"2":{"Name":"ContactTargetInfo","Properties":{"ContactId":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) of the contact."},"IsEssential":{"Type":2,"Flags":1,"Description":"A Boolean value determining if the contact's acknowledgement stops the progress of stages in the plan."}}}},{"2":{"Name":"Stage","Properties":{"DurationInMinutes":{"Type":3,"Flags":1,"Description":"The time to wait until beginning the next stage."},"Targets":{"Type":25,"Flags":0,"Description":"The contacts or contact methods that the escalation plan or engagement plan is engaging."}}}},{"2":{"Name":"Targets","Properties":{"ChannelTargetInfo":{"Type":21,"Flags":0},"ContactTargetInfo":{"Type":22,"Flags":0}}}},{"3":{"ItemType":24}},{"2":{"Name":"AWS.SSMContacts/PlanProperties","Properties":{"Arn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN) of the contact."},"ContactId":{"Type":4,"Flags":1,"Description":"Contact ID for the AWS SSM Incident Manager Contact to associate the plan."},"RotationIds":{"Type":27,"Flags":4,"Description":"Rotation Ids to associate with Oncall Contact for engagement."},"Stages":{"Type":28,"Flags":0,"Description":"The stages that an escalation plan or engagement plan engages contacts and contact methods in."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":23}},{"2":{"Name":"AWS.SSMContacts/Plan","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":26,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.SSMContacts/Plan@default","ScopeType":0,"Body":29}},{"2":{"Name":"CoverageTime","Properties":{"EndTime":{"Type":4,"Flags":1},"StartTime":{"Type":4,"Flags":1}}}},{"2":{"Name":"DailySetting","Properties":{"HandOffTime":{"Type":4,"Flags":1}}}},{"2":{"Name":"DayOfWeek"}},{"2":{"Name":"HandOffTime"}},{"2":{"Name":"MonthlySetting","Properties":{"DayOfMonth":{"Type":3,"Flags":1,"Description":"The day of the month when monthly recurring on-call rotations begin."},"HandOffTime":{"Type":4,"Flags":1}}}},{"2":{"Name":"RecurrenceSettings","Properties":{"DailySettings":{"Type":40,"Flags":0,"Description":"Information about on-call rotations that recur daily."},"MonthlySettings":{"Type":41,"Flags":0,"Description":"Information about on-call rotations that recur monthly."},"NumberOfOnCalls":{"Type":3,"Flags":1,"Description":"Number of Oncalls per shift."},"RecurrenceMultiplier":{"Type":3,"Flags":1,"Description":"The number of days, weeks, or months a single rotation lasts."},"ShiftCoverages":{"Type":42,"Flags":0,"Description":"Information about the days of the week included in on-call rotation coverage."},"WeeklySettings":{"Type":43,"Flags":0,"Description":"Information about on-call rotations that recur weekly."}}}},{"2":{"Name":"ShiftCoverage","Properties":{"CoverageTimes":{"Type":44,"Flags":1,"Description":"Information about when an on-call shift begins and ends."},"DayOfWeek":{"Type":4,"Flags":1}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag"},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag."}}}},{"2":{"Name":"WeeklySetting","Properties":{"DayOfWeek":{"Type":4,"Flags":1},"HandOffTime":{"Type":4,"Flags":1}}}},{"3":{"ItemType":4}},{"3":{"ItemType":35}},{"3":{"ItemType":37}},{"3":{"ItemType":39}},{"3":{"ItemType":31}},{"2":{"Name":"AWS.SSMContacts/RotationProperties","Properties":{"Arn":{"Type":4,"Flags":18,"Description":"The Amazon Resource Name (ARN) of the rotation."},"ContactIds":{"Type":46,"Flags":1,"Description":"Members of the rotation"},"Name":{"Type":4,"Flags":1,"Description":"Name of the Rotation"},"Recurrence":{"Type":36,"Flags":1},"StartTime":{"Type":4,"Flags":1,"Description":"Start time of the first shift of Oncall Schedule"},"Tags":{"Type":47,"Flags":0},"TimeZoneId":{"Type":4,"Flags":1,"Description":"TimeZone Identifier for the Oncall Schedule"}}}},{"3":{"ItemType":4}},{"3":{"ItemType":38}},{"2":{"Name":"AWS.SSMContacts/Rotation","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":45,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.SSMContacts/Rotation@default","ScopeType":0,"Body":48}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "ChannelTargetInfo", + "properties": { + "ChannelId": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of the contact channel." + }, + "RetryIntervalInMinutes": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The number of minutes to wait to retry sending engagement in the case the engagement initially fails." + } + } + }, + { + "$type": "ObjectType", + "name": "ContactTargetInfo", + "properties": { + "ContactId": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of the contact." + }, + "IsEssential": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "A Boolean value determining if the contact's acknowledgement stops the progress of stages in the plan." + } + } + }, + { + "$type": "ObjectType", + "name": "Stage", + "properties": { + "DurationInMinutes": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The time to wait until beginning the next stage." + }, + "RotationIds": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "List of Rotation Ids to associate with Contact" + }, + "Targets": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "The contacts or contact methods that the escalation plan or engagement plan is engaging." + } + } + }, + { + "$type": "ObjectType", + "name": "Targets", + "properties": { + "ChannelTargetInfo": { + "type": { + "$ref": "#/0" + }, + "flags": 0 + }, + "ContactTargetInfo": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "IntegerType" + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.SSMContacts/ContactProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ObjectType", + "name": "AWS.SSMContacts/ContactProperties", + "properties": { + "Alias": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "Alias of the contact. String value with 20 to 256 characters. Only alphabetical, numeric characters, dash, or underscore allowed." + }, + "Arn": { + "type": { + "$ref": "#/4" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) of the contact." + }, + "DisplayName": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "Name of the contact. String value with 3 to 256 characters. Only alphabetical, space, numeric characters, dash, or underscore allowed." + }, + "Plan": { + "type": { + "$ref": "#/10" + }, + "flags": 4, + "description": "The stages that an escalation plan or engagement plan engages contacts and contact methods in." + }, + "Type": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "Contact type, which specify type of contact. Currently supported values: ?PERSONAL?, ?SHARED?, ?OTHER?." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SSMContacts/Contact", + "properties": { + "name": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/11" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SSMContacts/Contact@default", + "scopeType": 0, + "body": { + "$ref": "#/12" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.SSMContacts/ContactChannelProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.SSMContacts/ContactChannelProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/4" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) of the engagement to a contact channel." + }, + "ChannelAddress": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The details that SSM Incident Manager uses when trying to engage the contact channel." + }, + "ChannelName": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The device name. String of 6 to 50 alphabetical, numeric, dash, and underscore characters." + }, + "ChannelType": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "Device type, which specify notification channel. Currently supported values: ?SMS?, ?VOICE?, ?EMAIL?, ?CHATBOT." + }, + "ContactId": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "ARN of the contact resource" + }, + "DeferActivation": { + "type": { + "$ref": "#/6" + }, + "flags": 4, + "description": "If you want to activate the channel at a later time, you can choose to defer activation. SSM Incident Manager can't engage your contact channel until it has been activated." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SSMContacts/ContactChannel", + "properties": { + "name": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/15" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SSMContacts/ContactChannel@default", + "scopeType": 0, + "body": { + "$ref": "#/16" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "ChannelTargetInfo", + "properties": { + "ChannelId": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of the contact channel." + }, + "RetryIntervalInMinutes": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The number of minutes to wait to retry sending engagement in the case the engagement initially fails." + } + } + }, + { + "$type": "ObjectType", + "name": "ContactTargetInfo", + "properties": { + "ContactId": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of the contact." + }, + "IsEssential": { + "type": { + "$ref": "#/6" + }, + "flags": 1, + "description": "A Boolean value determining if the contact's acknowledgement stops the progress of stages in the plan." + } + } + }, + { + "$type": "ObjectType", + "name": "Stage", + "properties": { + "DurationInMinutes": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The time to wait until beginning the next stage." + }, + "Targets": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "The contacts or contact methods that the escalation plan or engagement plan is engaging." + } + } + }, + { + "$type": "ObjectType", + "name": "Targets", + "properties": { + "ChannelTargetInfo": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "ContactTargetInfo": { + "type": { + "$ref": "#/19" + }, + "flags": 0 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/21" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.SSMContacts/PlanProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/20" + } + }, + { + "$type": "ObjectType", + "name": "AWS.SSMContacts/PlanProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/4" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) of the contact." + }, + "ContactId": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "Contact ID for the AWS SSM Incident Manager Contact to associate the plan." + }, + "RotationIds": { + "type": { + "$ref": "#/24" + }, + "flags": 4, + "description": "Rotation Ids to associate with Oncall Contact for engagement." + }, + "Stages": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "The stages that an escalation plan or engagement plan engages contacts and contact methods in." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SSMContacts/Plan", + "properties": { + "name": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/26" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SSMContacts/Plan@default", + "scopeType": 0, + "body": { + "$ref": "#/27" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "CoverageTime", + "properties": { + "EndTime": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + }, + "StartTime": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DailySetting", + "properties": { + "HandOffTime": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DayOfWeek", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "HandOffTime", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MonthlySetting", + "properties": { + "DayOfMonth": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The day of the month when monthly recurring on-call rotations begin." + }, + "HandOffTime": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "RecurrenceSettings", + "properties": { + "DailySettings": { + "type": { + "$ref": "#/38" + }, + "flags": 0, + "description": "Information about on-call rotations that recur daily." + }, + "MonthlySettings": { + "type": { + "$ref": "#/39" + }, + "flags": 0, + "description": "Information about on-call rotations that recur monthly." + }, + "NumberOfOnCalls": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "Number of Oncalls per shift." + }, + "RecurrenceMultiplier": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The number of days, weeks, or months a single rotation lasts." + }, + "ShiftCoverages": { + "type": { + "$ref": "#/40" + }, + "flags": 0, + "description": "Information about the days of the week included in on-call rotation coverage." + }, + "WeeklySettings": { + "type": { + "$ref": "#/41" + }, + "flags": 0, + "description": "Information about on-call rotations that recur weekly." + } + } + }, + { + "$type": "ObjectType", + "name": "ShiftCoverage", + "properties": { + "CoverageTimes": { + "type": { + "$ref": "#/42" + }, + "flags": 1, + "description": "Information about when an on-call shift begins and ends." + }, + "DayOfWeek": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The key name of the tag" + }, + "Value": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The value for the tag." + } + } + }, + { + "$type": "ObjectType", + "name": "WeeklySetting", + "properties": { + "DayOfWeek": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + }, + "HandOffTime": { + "type": { + "$ref": "#/4" + }, + "flags": 1 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/33" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/35" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/37" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/29" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.SSMContacts/RotationProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/36" + } + }, + { + "$type": "ObjectType", + "name": "AWS.SSMContacts/RotationProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/4" + }, + "flags": 18, + "description": "The Amazon Resource Name (ARN) of the rotation." + }, + "ContactIds": { + "type": { + "$ref": "#/44" + }, + "flags": 1, + "description": "Members of the rotation" + }, + "Name": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "Name of the Rotation" + }, + "Recurrence": { + "type": { + "$ref": "#/34" + }, + "flags": 1 + }, + "StartTime": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "Start time of the first shift of Oncall Schedule" + }, + "Tags": { + "type": { + "$ref": "#/45" + }, + "flags": 0 + }, + "TimeZoneId": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "TimeZone Identifier for the Oncall Schedule" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SSMContacts/Rotation", + "properties": { + "name": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/46" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SSMContacts/Rotation@default", + "scopeType": 0, + "body": { + "$ref": "#/47" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.ssmcontacts/default/types.md b/artifacts/bicep/aws/aws.ssmcontacts/default/types.md index f76dfc59..1d138bf1 100644 --- a/artifacts/bicep/aws/aws.ssmcontacts/default/types.md +++ b/artifacts/bicep/aws/aws.ssmcontacts/default/types.md @@ -3,59 +3,30 @@ ## Resource AWS.SSMContacts/Contact@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.SSMContacts/ContactProperties](#awsssmcontactscontactproperties) (Required): properties of the resource +* **properties**: [AWS.SSMContacts/ContactProperties](#awsssmcontactscontactproperties) (Required, Identifier): properties of the resource ## Resource AWS.SSMContacts/ContactChannel@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.SSMContacts/ContactChannelProperties](#awsssmcontactscontactchannelproperties) (Required): properties of the resource +* **properties**: [AWS.SSMContacts/ContactChannelProperties](#awsssmcontactscontactchannelproperties) (Required, Identifier): properties of the resource ## Resource AWS.SSMContacts/Plan@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.SSMContacts/PlanProperties](#awsssmcontactsplanproperties) (Required): properties of the resource +* **properties**: [AWS.SSMContacts/PlanProperties](#awsssmcontactsplanproperties) (Required, Identifier): properties of the resource ## Resource AWS.SSMContacts/Rotation@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.SSMContacts/RotationProperties](#awsssmcontactsrotationproperties) (Required): properties of the resource - -## AWS.SSMContacts/ContactProperties -### Properties -* **Alias**: string (Required): Alias of the contact. String value with 20 to 256 characters. Only alphabetical, numeric characters, dash, or underscore allowed. -* **Arn**: string (ReadOnly, Identifier): The Amazon Resource Name (ARN) of the contact. -* **DisplayName**: string (Required): Name of the contact. String value with 3 to 256 characters. Only alphabetical, space, numeric characters, dash, or underscore allowed. -* **Plan**: [Stage](#stage)[] (WriteOnly): The stages that an escalation plan or engagement plan engages contacts and contact methods in. -* **Type**: string (Required): Contact type, which specify type of contact. Currently supported values: ?PERSONAL?, ?SHARED?, ?OTHER?. - -## Stage -### Properties -* **DurationInMinutes**: int: The time to wait until beginning the next stage. -* **RotationIds**: string[]: List of Rotation Ids to associate with Contact -* **Targets**: [Targets](#targets)[]: The contacts or contact methods that the escalation plan or engagement plan is engaging. - -## Targets -### Properties -* **ChannelTargetInfo**: [ChannelTargetInfo](#channeltargetinfo) -* **ContactTargetInfo**: [ContactTargetInfo](#contacttargetinfo) - -## ChannelTargetInfo -### Properties -* **ChannelId**: string (Required): The Amazon Resource Name (ARN) of the contact channel. -* **RetryIntervalInMinutes**: int (Required): The number of minutes to wait to retry sending engagement in the case the engagement initially fails. - -## ContactTargetInfo -### Properties -* **ContactId**: string (Required): The Amazon Resource Name (ARN) of the contact. -* **IsEssential**: bool (Required): A Boolean value determining if the contact's acknowledgement stops the progress of stages in the plan. +* **properties**: [AWS.SSMContacts/RotationProperties](#awsssmcontactsrotationproperties) (Required, Identifier): properties of the resource ## AWS.SSMContacts/ContactChannelProperties ### Properties @@ -66,6 +37,14 @@ * **ContactId**: string (Required): ARN of the contact resource * **DeferActivation**: bool (WriteOnly): If you want to activate the channel at a later time, you can choose to defer activation. SSM Incident Manager can't engage your contact channel until it has been activated. +## AWS.SSMContacts/ContactProperties +### Properties +* **Alias**: string (Required): Alias of the contact. String value with 20 to 256 characters. Only alphabetical, numeric characters, dash, or underscore allowed. +* **Arn**: string (ReadOnly, Identifier): The Amazon Resource Name (ARN) of the contact. +* **DisplayName**: string (Required): Name of the contact. String value with 3 to 256 characters. Only alphabetical, space, numeric characters, dash, or underscore allowed. +* **Plan**: [Stage](#stage)[] (WriteOnly): The stages that an escalation plan or engagement plan engages contacts and contact methods in. +* **Type**: string (Required): Contact type, which specify type of contact. Currently supported values: ?PERSONAL?, ?SHARED?, ?OTHER?. + ## AWS.SSMContacts/PlanProperties ### Properties * **Arn**: string (ReadOnly, Identifier): The Amazon Resource Name (ARN) of the contact. @@ -73,15 +52,20 @@ * **RotationIds**: string[] (WriteOnly): Rotation Ids to associate with Oncall Contact for engagement. * **Stages**: [Stage](#stage)[]: The stages that an escalation plan or engagement plan engages contacts and contact methods in. -## Stage +## AWS.SSMContacts/RotationProperties ### Properties -* **DurationInMinutes**: int (Required): The time to wait until beginning the next stage. -* **Targets**: [Targets](#targets)[]: The contacts or contact methods that the escalation plan or engagement plan is engaging. +* **Arn**: string (ReadOnly, Identifier): The Amazon Resource Name (ARN) of the rotation. +* **ContactIds**: string[] (Required): Members of the rotation +* **Name**: string (Required): Name of the Rotation +* **Recurrence**: [RecurrenceSettings](#recurrencesettings) (Required) +* **StartTime**: string (Required): Start time of the first shift of Oncall Schedule +* **Tags**: [Tag](#tag)[] +* **TimeZoneId**: string (Required): TimeZone Identifier for the Oncall Schedule -## Targets +## ChannelTargetInfo ### Properties -* **ChannelTargetInfo**: [ChannelTargetInfo](#channeltargetinfo) -* **ContactTargetInfo**: [ContactTargetInfo](#contacttargetinfo) +* **ChannelId**: string (Required): The Amazon Resource Name (ARN) of the contact channel. +* **RetryIntervalInMinutes**: int (Required): The number of minutes to wait to retry sending engagement in the case the engagement initially fails. ## ChannelTargetInfo ### Properties @@ -93,15 +77,20 @@ * **ContactId**: string (Required): The Amazon Resource Name (ARN) of the contact. * **IsEssential**: bool (Required): A Boolean value determining if the contact's acknowledgement stops the progress of stages in the plan. -## AWS.SSMContacts/RotationProperties +## ContactTargetInfo ### Properties -* **Arn**: string (ReadOnly, Identifier): The Amazon Resource Name (ARN) of the rotation. -* **ContactIds**: string[] (Required): Members of the rotation -* **Name**: string (Required): Name of the Rotation -* **Recurrence**: [RecurrenceSettings](#recurrencesettings) (Required) -* **StartTime**: string (Required): Start time of the first shift of Oncall Schedule -* **Tags**: [Tag](#tag)[] -* **TimeZoneId**: string (Required): TimeZone Identifier for the Oncall Schedule +* **ContactId**: string (Required): The Amazon Resource Name (ARN) of the contact. +* **IsEssential**: bool (Required): A Boolean value determining if the contact's acknowledgement stops the progress of stages in the plan. + +## CoverageTime +### Properties +* **EndTime**: string (Required) +* **StartTime**: string (Required) + +## MonthlySetting +### Properties +* **DayOfMonth**: int (Required): The day of the month when monthly recurring on-call rotations begin. +* **HandOffTime**: string (Required) ## RecurrenceSettings ### Properties @@ -112,28 +101,39 @@ * **ShiftCoverages**: [ShiftCoverage](#shiftcoverage)[]: Information about the days of the week included in on-call rotation coverage. * **WeeklySettings**: [WeeklySetting](#weeklysetting)[]: Information about on-call rotations that recur weekly. -## MonthlySetting -### Properties -* **DayOfMonth**: int (Required): The day of the month when monthly recurring on-call rotations begin. -* **HandOffTime**: string (Required) - ## ShiftCoverage ### Properties * **CoverageTimes**: [CoverageTime](#coveragetime)[] (Required): Information about when an on-call shift begins and ends. * **DayOfWeek**: string (Required) -## CoverageTime +## Stage ### Properties -* **EndTime**: string (Required) -* **StartTime**: string (Required) +* **DurationInMinutes**: int: The time to wait until beginning the next stage. +* **RotationIds**: string[]: List of Rotation Ids to associate with Contact +* **Targets**: [Targets](#targets)[]: The contacts or contact methods that the escalation plan or engagement plan is engaging. -## WeeklySetting +## Stage ### Properties -* **DayOfWeek**: string (Required) -* **HandOffTime**: string (Required) +* **DurationInMinutes**: int (Required): The time to wait until beginning the next stage. +* **Targets**: [Targets](#targets)[]: The contacts or contact methods that the escalation plan or engagement plan is engaging. ## Tag ### Properties * **Key**: string (Required): The key name of the tag * **Value**: string (Required): The value for the tag. +## Targets +### Properties +* **ChannelTargetInfo**: [ChannelTargetInfo](#channeltargetinfo) +* **ContactTargetInfo**: [ContactTargetInfo](#contacttargetinfo) + +## Targets +### Properties +* **ChannelTargetInfo**: [ChannelTargetInfo](#channeltargetinfo) +* **ContactTargetInfo**: [ContactTargetInfo](#contacttargetinfo) + +## WeeklySetting +### Properties +* **DayOfWeek**: string (Required) +* **HandOffTime**: string (Required) + diff --git a/artifacts/bicep/aws/aws.ssmincidents/default/types.json b/artifacts/bicep/aws/aws.ssmincidents/default/types.json index 87965d88..230c82ac 100644 --- a/artifacts/bicep/aws/aws.ssmincidents/default/types.json +++ b/artifacts/bicep/aws/aws.ssmincidents/default/types.json @@ -1 +1,617 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"Arn"}},{"2":{"Name":"DeletionProtected"}},{"2":{"Name":"RegionConfiguration","Properties":{"SseKmsKeyId":{"Type":4,"Flags":1}}}},{"2":{"Name":"RegionList"}},{"2":{"Name":"RegionName"}},{"2":{"Name":"ReplicationRegion","Properties":{"RegionConfiguration":{"Type":10,"Flags":0},"RegionName":{"Type":4,"Flags":0}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"3":{"ItemType":13}},{"2":{"Name":"AWS.SSMIncidents/ReplicationSetProperties","Properties":{"Arn":{"Type":4,"Flags":18,"Description":"The ARN of the ReplicationSet."},"DeletionProtected":{"Type":2,"Flags":0},"Regions":{"Type":17,"Flags":1,"Description":"The ReplicationSet configuration."},"Tags":{"Type":18,"Flags":0,"Description":"The tags to apply to the replication set."}}}},{"3":{"ItemType":13}},{"3":{"ItemType":14}},{"2":{"Name":"AWS.SSMIncidents/ReplicationSet","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":16,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.SSMIncidents/ReplicationSet@default","ScopeType":0,"Body":19}},{"2":{"Name":"Action","Properties":{"SsmAutomation":{"Type":33,"Flags":0}}}},{"2":{"Name":"ChatChannel","Properties":{"ChatbotSns":{"Type":38,"Flags":0}}}},{"2":{"Name":"ChatbotSns"}},{"2":{"Name":"DynamicSsmParameter","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":25,"Flags":1}}}},{"2":{"Name":"DynamicSsmParameterValue","Properties":{"Variable":{"Type":4,"Flags":0}}}},{"2":{"Name":"IncidentTemplate","Properties":{"DedupeString":{"Type":4,"Flags":0,"Description":"The deduplication string."},"Impact":{"Type":3,"Flags":1,"Description":"The impact value."},"IncidentTags":{"Type":40,"Flags":0,"Description":"Tags that get applied to incidents created by the StartIncident API action."},"NotificationTargets":{"Type":41,"Flags":0,"Description":"The list of notification targets."},"Summary":{"Type":4,"Flags":0,"Description":"The summary string."},"Title":{"Type":4,"Flags":1,"Description":"The title string."}}}},{"2":{"Name":"Integration","Properties":{"PagerDutyConfiguration":{"Type":29,"Flags":1}}}},{"2":{"Name":"NotificationTargetItem","Properties":{"SnsTopicArn":{"Type":4,"Flags":0}}}},{"2":{"Name":"PagerDutyConfiguration","Properties":{"Name":{"Type":4,"Flags":1,"Description":"The name of the pagerDuty configuration."},"PagerDutyIncidentConfiguration":{"Type":30,"Flags":1},"SecretId":{"Type":4,"Flags":1,"Description":"The AWS secrets manager secretId storing the pagerDuty token."}}}},{"2":{"Name":"PagerDutyIncidentConfiguration","Properties":{"ServiceId":{"Type":4,"Flags":1,"Description":"The pagerDuty serviceId."}}}},{"2":{"Name":"SSMContact"}},{"2":{"Name":"SnsArn"}},{"2":{"Name":"SsmAutomation","Properties":{"DocumentName":{"Type":4,"Flags":1,"Description":"The document name to use when starting the SSM automation document."},"DocumentVersion":{"Type":4,"Flags":0,"Description":"The version of the document to use when starting the SSM automation document."},"DynamicParameters":{"Type":42,"Flags":0,"Description":"The parameters with dynamic values to set when starting the SSM automation document."},"Parameters":{"Type":43,"Flags":0,"Description":"The parameters to set when starting the SSM automation document."},"RoleArn":{"Type":4,"Flags":1,"Description":"The role ARN to use when starting the SSM automation document."},"TargetAccount":{"Type":4,"Flags":0,"Description":"The account type to use when starting the SSM automation document."}}}},{"2":{"Name":"SsmParameter","Properties":{"Key":{"Type":4,"Flags":1},"Values":{"Type":44,"Flags":1}}}},{"2":{"Name":"SsmParameterValue"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"VariableType"}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":36}},{"3":{"ItemType":28}},{"3":{"ItemType":24}},{"3":{"ItemType":34}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.SSMIncidents/ResponsePlanProperties","Properties":{"Actions":{"Type":46,"Flags":0,"Description":"The list of actions."},"Arn":{"Type":4,"Flags":18,"Description":"The ARN of the response plan."},"ChatChannel":{"Type":22,"Flags":0},"DisplayName":{"Type":4,"Flags":0,"Description":"The display name of the response plan."},"Engagements":{"Type":47,"Flags":0,"Description":"The list of engagements to use."},"IncidentTemplate":{"Type":26,"Flags":1},"Integrations":{"Type":48,"Flags":0,"Description":"The list of integrations."},"Name":{"Type":4,"Flags":1,"Description":"The name of the response plan."},"Tags":{"Type":49,"Flags":0,"Description":"The tags to apply to the response plan."}}}},{"3":{"ItemType":21}},{"3":{"ItemType":4}},{"3":{"ItemType":27}},{"3":{"ItemType":36}},{"2":{"Name":"AWS.SSMIncidents/ResponsePlan","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":45,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.SSMIncidents/ResponsePlan@default","ScopeType":0,"Body":50}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Arn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DeletionProtected", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RegionConfiguration", + "properties": { + "SseKmsKeyId": { + "type": { + "$ref": "#/7" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "RegionList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RegionName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ReplicationRegion", + "properties": { + "RegionConfiguration": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "RegionName": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/7" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/7" + }, + "flags": 1 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.SSMIncidents/ReplicationSetProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ObjectType", + "name": "AWS.SSMIncidents/ReplicationSetProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/7" + }, + "flags": 18, + "description": "The ARN of the ReplicationSet." + }, + "DeletionProtected": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "Regions": { + "type": { + "$ref": "#/11" + }, + "flags": 1, + "description": "The ReplicationSet configuration." + }, + "Tags": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "The tags to apply to the replication set." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SSMIncidents/ReplicationSet", + "properties": { + "name": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/7" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/13" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SSMIncidents/ReplicationSet@default", + "scopeType": 0, + "body": { + "$ref": "#/14" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Action", + "properties": { + "SsmAutomation": { + "type": { + "$ref": "#/28" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ChatChannel", + "properties": { + "ChatbotSns": { + "type": { + "$ref": "#/33" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ChatbotSns", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DynamicSsmParameter", + "properties": { + "Key": { + "type": { + "$ref": "#/7" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/20" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DynamicSsmParameterValue", + "properties": { + "Variable": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "IncidentTemplate", + "properties": { + "DedupeString": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "The deduplication string." + }, + "Impact": { + "type": { + "$ref": "#/35" + }, + "flags": 1, + "description": "The impact value." + }, + "IncidentTags": { + "type": { + "$ref": "#/36" + }, + "flags": 0, + "description": "Tags that get applied to incidents created by the StartIncident API action." + }, + "NotificationTargets": { + "type": { + "$ref": "#/37" + }, + "flags": 0, + "description": "The list of notification targets." + }, + "Summary": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "The summary string." + }, + "Title": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "The title string." + } + } + }, + { + "$type": "ObjectType", + "name": "Integration", + "properties": { + "PagerDutyConfiguration": { + "type": { + "$ref": "#/24" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "NotificationTargetItem", + "properties": { + "SnsTopicArn": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "PagerDutyConfiguration", + "properties": { + "Name": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "The name of the pagerDuty configuration." + }, + "PagerDutyIncidentConfiguration": { + "type": { + "$ref": "#/25" + }, + "flags": 1 + }, + "SecretId": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "The AWS secrets manager secretId storing the pagerDuty token." + } + } + }, + { + "$type": "ObjectType", + "name": "PagerDutyIncidentConfiguration", + "properties": { + "ServiceId": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "The pagerDuty serviceId." + } + } + }, + { + "$type": "ObjectType", + "name": "SSMContact", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SnsArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SsmAutomation", + "properties": { + "DocumentName": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "The document name to use when starting the SSM automation document." + }, + "DocumentVersion": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "The version of the document to use when starting the SSM automation document." + }, + "DynamicParameters": { + "type": { + "$ref": "#/38" + }, + "flags": 0, + "description": "The parameters with dynamic values to set when starting the SSM automation document." + }, + "Parameters": { + "type": { + "$ref": "#/39" + }, + "flags": 0, + "description": "The parameters to set when starting the SSM automation document." + }, + "RoleArn": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "The role ARN to use when starting the SSM automation document." + }, + "TargetAccount": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "The account type to use when starting the SSM automation document." + } + } + }, + { + "$type": "ObjectType", + "name": "SsmParameter", + "properties": { + "Key": { + "type": { + "$ref": "#/7" + }, + "flags": 1 + }, + "Values": { + "type": { + "$ref": "#/40" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "SsmParameterValue", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/7" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/7" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "VariableType", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/7" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/7" + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/31" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/23" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/19" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/29" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/7" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.SSMIncidents/ResponsePlanProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/16" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/7" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/22" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/31" + } + }, + { + "$type": "ObjectType", + "name": "AWS.SSMIncidents/ResponsePlanProperties", + "properties": { + "Actions": { + "type": { + "$ref": "#/42" + }, + "flags": 0, + "description": "The list of actions." + }, + "Arn": { + "type": { + "$ref": "#/7" + }, + "flags": 18, + "description": "The ARN of the response plan." + }, + "ChatChannel": { + "type": { + "$ref": "#/17" + }, + "flags": 0 + }, + "DisplayName": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "The display name of the response plan." + }, + "Engagements": { + "type": { + "$ref": "#/43" + }, + "flags": 0, + "description": "The list of engagements to use." + }, + "IncidentTemplate": { + "type": { + "$ref": "#/21" + }, + "flags": 1 + }, + "Integrations": { + "type": { + "$ref": "#/44" + }, + "flags": 0, + "description": "The list of integrations." + }, + "Name": { + "type": { + "$ref": "#/7" + }, + "flags": 1, + "description": "The name of the response plan." + }, + "Tags": { + "type": { + "$ref": "#/45" + }, + "flags": 0, + "description": "The tags to apply to the response plan." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SSMIncidents/ResponsePlan", + "properties": { + "name": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/7" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/46" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SSMIncidents/ResponsePlan@default", + "scopeType": 0, + "body": { + "$ref": "#/47" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.ssmincidents/default/types.md b/artifacts/bicep/aws/aws.ssmincidents/default/types.md index 308bdf3e..db415043 100644 --- a/artifacts/bicep/aws/aws.ssmincidents/default/types.md +++ b/artifacts/bicep/aws/aws.ssmincidents/default/types.md @@ -3,16 +3,20 @@ ## Resource AWS.SSMIncidents/ReplicationSet@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.SSMIncidents/ReplicationSetProperties](#awsssmincidentsreplicationsetproperties) (Required): properties of the resource +* **properties**: [AWS.SSMIncidents/ReplicationSetProperties](#awsssmincidentsreplicationsetproperties) (Required, Identifier): properties of the resource ## Resource AWS.SSMIncidents/ResponsePlan@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.SSMIncidents/ResponsePlanProperties](#awsssmincidentsresponseplanproperties) (Required): properties of the resource +* **properties**: [AWS.SSMIncidents/ResponsePlanProperties](#awsssmincidentsresponseplanproperties) (Required, Identifier): properties of the resource + +## Action +### Properties +* **SsmAutomation**: [SsmAutomation](#ssmautomation) ## AWS.SSMIncidents/ReplicationSetProperties ### Properties @@ -21,20 +25,6 @@ * **Regions**: [ReplicationRegion](#replicationregion)[] (Required): The ReplicationSet configuration. * **Tags**: [Tag](#tag)[]: The tags to apply to the replication set. -## ReplicationRegion -### Properties -* **RegionConfiguration**: [RegionConfiguration](#regionconfiguration) -* **RegionName**: string - -## RegionConfiguration -### Properties -* **SseKmsKeyId**: string (Required) - -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - ## AWS.SSMIncidents/ResponsePlanProperties ### Properties * **Actions**: [Action](#action)[]: The list of actions. @@ -47,18 +37,9 @@ * **Name**: string (Required): The name of the response plan. * **Tags**: [Tag](#tag)[]: The tags to apply to the response plan. -## Action -### Properties -* **SsmAutomation**: [SsmAutomation](#ssmautomation) - -## SsmAutomation +## ChatChannel ### Properties -* **DocumentName**: string (Required): The document name to use when starting the SSM automation document. -* **DocumentVersion**: string: The version of the document to use when starting the SSM automation document. -* **DynamicParameters**: [DynamicSsmParameter](#dynamicssmparameter)[]: The parameters with dynamic values to set when starting the SSM automation document. -* **Parameters**: [SsmParameter](#ssmparameter)[]: The parameters to set when starting the SSM automation document. -* **RoleArn**: string (Required): The role ARN to use when starting the SSM automation document. -* **TargetAccount**: string: The account type to use when starting the SSM automation document. +* **ChatbotSns**: string[] ## DynamicSsmParameter ### Properties @@ -69,15 +50,6 @@ ### Properties * **Variable**: string -## SsmParameter -### Properties -* **Key**: string (Required) -* **Values**: string[] (Required) - -## ChatChannel -### Properties -* **ChatbotSns**: string[] - ## IncidentTemplate ### Properties * **DedupeString**: string: The deduplication string. @@ -87,19 +59,14 @@ * **Summary**: string: The summary string. * **Title**: string (Required): The title string. -## Tag +## Integration ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **PagerDutyConfiguration**: [PagerDutyConfiguration](#pagerdutyconfiguration) (Required) ## NotificationTargetItem ### Properties * **SnsTopicArn**: string -## Integration -### Properties -* **PagerDutyConfiguration**: [PagerDutyConfiguration](#pagerdutyconfiguration) (Required) - ## PagerDutyConfiguration ### Properties * **Name**: string (Required): The name of the pagerDuty configuration. @@ -110,3 +77,36 @@ ### Properties * **ServiceId**: string (Required): The pagerDuty serviceId. +## RegionConfiguration +### Properties +* **SseKmsKeyId**: string (Required) + +## ReplicationRegion +### Properties +* **RegionConfiguration**: [RegionConfiguration](#regionconfiguration) +* **RegionName**: string + +## SsmAutomation +### Properties +* **DocumentName**: string (Required): The document name to use when starting the SSM automation document. +* **DocumentVersion**: string: The version of the document to use when starting the SSM automation document. +* **DynamicParameters**: [DynamicSsmParameter](#dynamicssmparameter)[]: The parameters with dynamic values to set when starting the SSM automation document. +* **Parameters**: [SsmParameter](#ssmparameter)[]: The parameters to set when starting the SSM automation document. +* **RoleArn**: string (Required): The role ARN to use when starting the SSM automation document. +* **TargetAccount**: string: The account type to use when starting the SSM automation document. + +## SsmParameter +### Properties +* **Key**: string (Required) +* **Values**: string[] (Required) + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + diff --git a/artifacts/bicep/aws/aws.sso/default/types.json b/artifacts/bicep/aws/aws.sso/default/types.json index 5206226c..a3e6b9e2 100644 --- a/artifacts/bicep/aws/aws.sso/default/types.json +++ b/artifacts/bicep/aws/aws.sso/default/types.json @@ -1 +1,646 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"AccessControlAttribute","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":10,"Flags":1}}}},{"2":{"Name":"AccessControlAttributeList"}},{"2":{"Name":"AccessControlAttributeValue","Properties":{"Source":{"Type":14,"Flags":1}}}},{"2":{"Name":"AccessControlAttributeValueSource"}},{"2":{"Name":"AccessControlAttributeValueSourceList"}},{"3":{"ItemType":8}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.SSO/InstanceAccessControlAttributeConfigurationProperties","Properties":{"AccessControlAttributes":{"Type":17,"Flags":0},"InstanceAccessControlAttributeConfiguration":{"Type":19,"Flags":0,"Description":"The InstanceAccessControlAttributeConfiguration property has been deprecated but is still supported for backwards compatibility purposes. We recomend that you use AccessControlAttributes property instead."},"InstanceArn":{"Type":4,"Flags":17,"Description":"The ARN of the AWS SSO instance under which the operation will be executed."}}}},{"3":{"ItemType":8}},{"3":{"ItemType":8}},{"2":{"Name":"InstanceAccessControlAttributeConfiguration_InstanceAccessControlAttributeConfiguration","Properties":{"AccessControlAttributes":{"Type":18,"Flags":1}}}},{"2":{"Name":"AWS.SSO/InstanceAccessControlAttributeConfiguration","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":16,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.SSO/InstanceAccessControlAttributeConfiguration@default","ScopeType":0,"Body":20}},{"2":{"Name":"CustomerManagedPolicyReference","Properties":{"Name":{"Type":4,"Flags":1},"Path":{"Type":4,"Flags":0}}}},{"2":{"Name":"ManagedPolicyArn"}},{"2":{"Name":"PermissionsBoundary","Properties":{"CustomerManagedPolicyReference":{"Type":22,"Flags":0},"ManagedPolicyArn":{"Type":4,"Flags":0}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.SSO/PermissionSetProperties","Properties":{"CustomerManagedPolicyReferences":{"Type":27,"Flags":0},"Description":{"Type":4,"Flags":0,"Description":"The permission set description."},"InlinePolicy":{"Type":29,"Flags":0,"Description":"The inline policy to put in permission set."},"InstanceArn":{"Type":4,"Flags":17,"Description":"The sso instance arn that the permission set is owned."},"ManagedPolicies":{"Type":30,"Flags":0},"Name":{"Type":4,"Flags":1,"Description":"The name you want to assign to this permission set."},"PermissionSetArn":{"Type":4,"Flags":18,"Description":"The permission set that the policy will be attached to"},"PermissionsBoundary":{"Type":24,"Flags":0},"RelayStateType":{"Type":4,"Flags":0,"Description":"The relay state URL that redirect links to any service in the AWS Management Console."},"SessionDuration":{"Type":4,"Flags":0,"Description":"The length of time that a user can be signed in to an AWS account."},"Tags":{"Type":31,"Flags":0}}}},{"3":{"ItemType":22}},{"2":{"Name":"PermissionSet_InlinePolicy","Properties":{}}},{"5":{"Elements":[28,4]}},{"3":{"ItemType":4}},{"3":{"ItemType":25}},{"2":{"Name":"AWS.SSO/PermissionSet","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":26,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.SSO/PermissionSet@default","ScopeType":0,"Body":32}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "PortalOptionsConfiguration", + "properties": { + "SignInOptions": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A structure that describes the sign-in options for the access portal" + }, + "Visibility": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "Indicates whether this application is visible in the access portal" + } + } + }, + { + "$type": "ObjectType", + "name": "SignInOptions", + "properties": { + "ApplicationUrl": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The URL that accepts authentication requests for an application, this is a required parameter if the Origin parameter is APPLICATION" + }, + "Origin": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "This determines how IAM Identity Center navigates the user to the target application" + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.SSO/ApplicationProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ObjectType", + "name": "AWS.SSO/ApplicationProperties", + "properties": { + "ApplicationArn": { + "type": { + "$ref": "#/3" + }, + "flags": 18, + "description": "The Application ARN that is returned upon creation of the Identity Center (SSO) Application" + }, + "ApplicationProviderArn": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The ARN of the application provider under which the operation will run" + }, + "Description": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The description information for the Identity Center (SSO) Application" + }, + "InstanceArn": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The ARN of the instance of IAM Identity Center under which the operation will run" + }, + "Name": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The name you want to assign to this Identity Center (SSO) Application" + }, + "PortalOptions": { + "type": { + "$ref": "#/0" + }, + "flags": 0, + "description": "A structure that describes the options for the portal associated with an application" + }, + "Status": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "Specifies whether the application is enabled or disabled" + }, + "Tags": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SSO/Application", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/6" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SSO/Application@default", + "scopeType": 0, + "body": { + "$ref": "#/7" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.SSO/InstanceProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/9" + } + }, + { + "$type": "ObjectType", + "name": "AWS.SSO/InstanceProperties", + "properties": { + "IdentityStoreId": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The ID of the identity store associated with the created Identity Center (SSO) Instance" + }, + "InstanceArn": { + "type": { + "$ref": "#/3" + }, + "flags": 18, + "description": "The SSO Instance ARN that is returned upon creation of the Identity Center (SSO) Instance" + }, + "Name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The name you want to assign to this Identity Center (SSO) Instance" + }, + "OwnerAccountId": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The AWS accountId of the owner of the Identity Center (SSO) Instance" + }, + "Status": { + "type": { + "$ref": "#/3" + }, + "flags": 2, + "description": "The status of the Identity Center (SSO) Instance, create_in_progress/delete_in_progress/active" + }, + "Tags": { + "type": { + "$ref": "#/11" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SSO/Instance", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/12" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SSO/Instance@default", + "scopeType": 0, + "body": { + "$ref": "#/13" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AccessControlAttribute", + "properties": { + "Key": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/17" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AccessControlAttributeList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AccessControlAttributeValue", + "properties": { + "Source": { + "type": { + "$ref": "#/21" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AccessControlAttributeValueSource", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AccessControlAttributeValueSourceList", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/15" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.SSO/InstanceAccessControlAttributeConfigurationProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/15" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/15" + } + }, + { + "$type": "ObjectType", + "name": "InstanceAccessControlAttributeConfiguration_InstanceAccessControlAttributeConfiguration", + "properties": { + "AccessControlAttributes": { + "type": { + "$ref": "#/25" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SSO/InstanceAccessControlAttributeConfigurationProperties", + "properties": { + "AccessControlAttributes": { + "type": { + "$ref": "#/24" + }, + "flags": 0 + }, + "InstanceAccessControlAttributeConfiguration": { + "type": { + "$ref": "#/26" + }, + "flags": 0, + "description": "The InstanceAccessControlAttributeConfiguration property has been deprecated but is still supported for backwards compatibility purposes. We recomend that you use AccessControlAttributes property instead." + }, + "InstanceArn": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "The ARN of the AWS SSO instance under which the operation will be executed." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SSO/InstanceAccessControlAttributeConfiguration", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/27" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SSO/InstanceAccessControlAttributeConfiguration@default", + "scopeType": 0, + "body": { + "$ref": "#/28" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "CustomerManagedPolicyReference", + "properties": { + "Name": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + }, + "Path": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ManagedPolicyArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PermissionsBoundary", + "properties": { + "CustomerManagedPolicyReference": { + "type": { + "$ref": "#/30" + }, + "flags": 0 + }, + "ManagedPolicyArn": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.SSO/PermissionSetProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/30" + } + }, + { + "$type": "ObjectType", + "name": "PermissionSet_InlinePolicy", + "properties": {} + }, + { + "$type": "UnionType", + "elements": [ + { + "$ref": "#/36" + }, + { + "$ref": "#/3" + } + ] + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/33" + } + }, + { + "$type": "ObjectType", + "name": "AWS.SSO/PermissionSetProperties", + "properties": { + "CustomerManagedPolicyReferences": { + "type": { + "$ref": "#/35" + }, + "flags": 0 + }, + "Description": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The permission set description." + }, + "InlinePolicy": { + "type": { + "$ref": "#/37" + }, + "flags": 0, + "description": "The inline policy to put in permission set." + }, + "InstanceArn": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "The sso instance arn that the permission set is owned." + }, + "ManagedPolicies": { + "type": { + "$ref": "#/38" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The name you want to assign to this permission set." + }, + "PermissionSetArn": { + "type": { + "$ref": "#/3" + }, + "flags": 18, + "description": "The permission set that the policy will be attached to" + }, + "PermissionsBoundary": { + "type": { + "$ref": "#/32" + }, + "flags": 0 + }, + "RelayStateType": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The relay state URL that redirect links to any service in the AWS Management Console." + }, + "SessionDuration": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "The length of time that a user can be signed in to an AWS account." + }, + "Tags": { + "type": { + "$ref": "#/39" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SSO/PermissionSet", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/40" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SSO/PermissionSet@default", + "scopeType": 0, + "body": { + "$ref": "#/41" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.sso/default/types.md b/artifacts/bicep/aws/aws.sso/default/types.md index e26335c4..58609e61 100644 --- a/artifacts/bicep/aws/aws.sso/default/types.md +++ b/artifacts/bicep/aws/aws.sso/default/types.md @@ -1,24 +1,32 @@ # AWS.SSO @ default -## Resource AWS.SSO/InstanceAccessControlAttributeConfiguration@default +## Resource AWS.SSO/Application@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.SSO/InstanceAccessControlAttributeConfigurationProperties](#awsssoinstanceaccesscontrolattributeconfigurationproperties) (Required): properties of the resource +* **properties**: [AWS.SSO/ApplicationProperties](#awsssoapplicationproperties) (Required, Identifier): properties of the resource -## Resource AWS.SSO/PermissionSet@default +## Resource AWS.SSO/Instance@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.SSO/PermissionSetProperties](#awsssopermissionsetproperties) (Required): properties of the resource +* **properties**: [AWS.SSO/InstanceProperties](#awsssoinstanceproperties) (Identifier): properties of the resource -## AWS.SSO/InstanceAccessControlAttributeConfigurationProperties +## Resource AWS.SSO/InstanceAccessControlAttributeConfiguration@default +* **Valid Scope(s)**: Unknown ### Properties -* **AccessControlAttributes**: [AccessControlAttribute](#accesscontrolattribute)[] -* **InstanceAccessControlAttributeConfiguration**: [InstanceAccessControlAttributeConfiguration_InstanceAccessControlAttributeConfiguration](#instanceaccesscontrolattributeconfigurationinstanceaccesscontrolattributeconfiguration): The InstanceAccessControlAttributeConfiguration property has been deprecated but is still supported for backwards compatibility purposes. We recomend that you use AccessControlAttributes property instead. -* **InstanceArn**: string (Required, Identifier): The ARN of the AWS SSO instance under which the operation will be executed. +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.SSO/InstanceAccessControlAttributeConfigurationProperties](#awsssoinstanceaccesscontrolattributeconfigurationproperties) (Required, Identifier): properties of the resource + +## Resource AWS.SSO/PermissionSet@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.SSO/PermissionSetProperties](#awsssopermissionsetproperties) (Required, Identifier): properties of the resource ## AccessControlAttribute ### Properties @@ -29,9 +37,31 @@ ### Properties * **Source**: string[] (Required) -## InstanceAccessControlAttributeConfiguration_InstanceAccessControlAttributeConfiguration +## AWS.SSO/ApplicationProperties ### Properties -* **AccessControlAttributes**: [AccessControlAttribute](#accesscontrolattribute)[] (Required) +* **ApplicationArn**: string (ReadOnly, Identifier): The Application ARN that is returned upon creation of the Identity Center (SSO) Application +* **ApplicationProviderArn**: string (Required): The ARN of the application provider under which the operation will run +* **Description**: string: The description information for the Identity Center (SSO) Application +* **InstanceArn**: string (Required): The ARN of the instance of IAM Identity Center under which the operation will run +* **Name**: string (Required): The name you want to assign to this Identity Center (SSO) Application +* **PortalOptions**: [PortalOptionsConfiguration](#portaloptionsconfiguration): A structure that describes the options for the portal associated with an application +* **Status**: string: Specifies whether the application is enabled or disabled +* **Tags**: [Tag](#tag)[] + +## AWS.SSO/InstanceAccessControlAttributeConfigurationProperties +### Properties +* **AccessControlAttributes**: [AccessControlAttribute](#accesscontrolattribute)[] +* **InstanceAccessControlAttributeConfiguration**: [InstanceAccessControlAttributeConfiguration_InstanceAccessControlAttributeConfiguration](#instanceaccesscontrolattributeconfigurationinstanceaccesscontrolattributeconfiguration): The InstanceAccessControlAttributeConfiguration property has been deprecated but is still supported for backwards compatibility purposes. We recomend that you use AccessControlAttributes property instead. +* **InstanceArn**: string (Required, Identifier): The ARN of the AWS SSO instance under which the operation will be executed. + +## AWS.SSO/InstanceProperties +### Properties +* **IdentityStoreId**: string (ReadOnly): The ID of the identity store associated with the created Identity Center (SSO) Instance +* **InstanceArn**: string (ReadOnly, Identifier): The SSO Instance ARN that is returned upon creation of the Identity Center (SSO) Instance +* **Name**: string: The name you want to assign to this Identity Center (SSO) Instance +* **OwnerAccountId**: string (ReadOnly): The AWS accountId of the owner of the Identity Center (SSO) Instance +* **Status**: string (ReadOnly): The status of the Identity Center (SSO) Instance, create_in_progress/delete_in_progress/active +* **Tags**: [Tag](#tag)[] ## AWS.SSO/PermissionSetProperties ### Properties @@ -52,11 +82,35 @@ * **Name**: string (Required) * **Path**: string +## InstanceAccessControlAttributeConfiguration_InstanceAccessControlAttributeConfiguration +### Properties +* **AccessControlAttributes**: [AccessControlAttribute](#accesscontrolattribute)[] (Required) + ## PermissionsBoundary ### Properties * **CustomerManagedPolicyReference**: [CustomerManagedPolicyReference](#customermanagedpolicyreference) * **ManagedPolicyArn**: string +## PortalOptionsConfiguration +### Properties +* **SignInOptions**: [SignInOptions](#signinoptions): A structure that describes the sign-in options for the access portal +* **Visibility**: string: Indicates whether this application is visible in the access portal + +## SignInOptions +### Properties +* **ApplicationUrl**: string: The URL that accepts authentication requests for an application, this is a required parameter if the Origin parameter is APPLICATION +* **Origin**: string (Required): This determines how IAM Identity Center navigates the user to the target application + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + ## Tag ### Properties * **Key**: string (Required) diff --git a/artifacts/bicep/aws/aws.stepfunctions/default/types.json b/artifacts/bicep/aws/aws.stepfunctions/default/types.json index 19cedd90..921371aa 100644 --- a/artifacts/bicep/aws/aws.stepfunctions/default/types.json +++ b/artifacts/bicep/aws/aws.stepfunctions/default/types.json @@ -1 +1,509 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"TagsEntry","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.StepFunctions/ActivityProperties","Properties":{"Arn":{"Type":4,"Flags":18},"Name":{"Type":4,"Flags":1},"Tags":{"Type":10,"Flags":0}}}},{"3":{"ItemType":8}},{"2":{"Name":"AWS.StepFunctions/Activity","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":9,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.StepFunctions/Activity@default","ScopeType":0,"Body":11}},{"2":{"Name":"CloudWatchLogsLogGroup","Properties":{"LogGroupArn":{"Type":4,"Flags":0}}}},{"2":{"Name":"Definition","Properties":{}}},{"2":{"Name":"DefinitionSubstitutions","Properties":{}}},{"2":{"Name":"LogDestination","Properties":{"CloudWatchLogsLogGroup":{"Type":13,"Flags":0}}}},{"2":{"Name":"LoggingConfiguration","Properties":{"Destinations":{"Type":21,"Flags":0},"IncludeExecutionData":{"Type":2,"Flags":0},"Level":{"Type":4,"Flags":0}}}},{"2":{"Name":"S3Location","Properties":{"Bucket":{"Type":4,"Flags":1},"Key":{"Type":4,"Flags":1},"Version":{"Type":4,"Flags":0}}}},{"2":{"Name":"TagsEntry","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"TracingConfiguration","Properties":{"Enabled":{"Type":2,"Flags":0}}}},{"3":{"ItemType":16}},{"2":{"Name":"AWS.StepFunctions/StateMachineProperties","Properties":{"Arn":{"Type":4,"Flags":18},"Definition":{"Type":14,"Flags":4},"DefinitionS3Location":{"Type":18,"Flags":4},"DefinitionString":{"Type":4,"Flags":0},"DefinitionSubstitutions":{"Type":15,"Flags":4},"LoggingConfiguration":{"Type":17,"Flags":0},"Name":{"Type":4,"Flags":2},"RoleArn":{"Type":4,"Flags":1},"StateMachineName":{"Type":4,"Flags":0},"StateMachineRevisionId":{"Type":4,"Flags":2},"StateMachineType":{"Type":4,"Flags":0},"Tags":{"Type":23,"Flags":0},"TracingConfiguration":{"Type":20,"Flags":0}}}},{"3":{"ItemType":19}},{"2":{"Name":"AWS.StepFunctions/StateMachine","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":22,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.StepFunctions/StateMachine@default","ScopeType":0,"Body":24}},{"2":{"Name":"DeploymentPreference","Properties":{"Alarms":{"Type":29,"Flags":0,"Description":"A list of CloudWatch alarm names that will be monitored during the deployment. The deployment will fail and rollback if any alarms go into ALARM state."},"Interval":{"Type":3,"Flags":0,"Description":"The time in minutes between each traffic shifting increment."},"Percentage":{"Type":3,"Flags":0,"Description":"The percentage of traffic to shift to the new version in each increment."},"StateMachineVersionArn":{"Type":4,"Flags":1},"Type":{"Type":4,"Flags":1,"Description":"The type of deployment to perform."}}}},{"2":{"Name":"RoutingConfiguration"}},{"2":{"Name":"RoutingConfigurationVersion","Properties":{"StateMachineVersionArn":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) that identifies one or two state machine versions defined in the routing configuration."},"Weight":{"Type":3,"Flags":1,"Description":"The 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."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":28}},{"2":{"Name":"AWS.StepFunctions/StateMachineAliasProperties","Properties":{"Arn":{"Type":4,"Flags":18,"Description":"The ARN of the alias."},"DeploymentPreference":{"Type":26,"Flags":4},"Description":{"Type":4,"Flags":0,"Description":"An optional description of the alias."},"Name":{"Type":4,"Flags":0,"Description":"The alias name."},"RoutingConfiguration":{"Type":32,"Flags":0}}}},{"3":{"ItemType":28}},{"2":{"Name":"AWS.StepFunctions/StateMachineAlias","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":31,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.StepFunctions/StateMachineAlias@default","ScopeType":0,"Body":33}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "TagsEntry", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.StepFunctions/ActivityProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ObjectType", + "name": "AWS.StepFunctions/ActivityProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 18 + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.StepFunctions/Activity", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.StepFunctions/Activity@default", + "scopeType": 0, + "body": { + "$ref": "#/5" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "CloudWatchLogsLogGroup", + "properties": { + "LogGroupArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Definition", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DefinitionSubstitutions", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LogDestination", + "properties": { + "CloudWatchLogsLogGroup": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "LoggingConfiguration", + "properties": { + "Destinations": { + "type": { + "$ref": "#/15" + }, + "flags": 0 + }, + "IncludeExecutionData": { + "type": { + "$ref": "#/16" + }, + "flags": 0 + }, + "Level": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "S3Location", + "properties": { + "Bucket": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Version": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TagsEntry", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TracingConfiguration", + "properties": { + "Enabled": { + "type": { + "$ref": "#/16" + }, + "flags": 0 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/10" + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.StepFunctions/StateMachineProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/13" + } + }, + { + "$type": "ObjectType", + "name": "AWS.StepFunctions/StateMachineProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 18 + }, + "Definition": { + "type": { + "$ref": "#/8" + }, + "flags": 4 + }, + "DefinitionS3Location": { + "type": { + "$ref": "#/12" + }, + "flags": 4 + }, + "DefinitionString": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "DefinitionSubstitutions": { + "type": { + "$ref": "#/9" + }, + "flags": 4 + }, + "LoggingConfiguration": { + "type": { + "$ref": "#/11" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "RoleArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "StateMachineName": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "StateMachineRevisionId": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "StateMachineType": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "TracingConfiguration": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.StepFunctions/StateMachine", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/19" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.StepFunctions/StateMachine@default", + "scopeType": 0, + "body": { + "$ref": "#/20" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "DeploymentPreference", + "properties": { + "Alarms": { + "type": { + "$ref": "#/25" + }, + "flags": 0, + "description": "A list of CloudWatch alarm names that will be monitored during the deployment. The deployment will fail and rollback if any alarms go into ALARM state." + }, + "Interval": { + "type": { + "$ref": "#/26" + }, + "flags": 0, + "description": "The time in minutes between each traffic shifting increment." + }, + "Percentage": { + "type": { + "$ref": "#/26" + }, + "flags": 0, + "description": "The percentage of traffic to shift to the new version in each increment." + }, + "StateMachineVersionArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Type": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The type of deployment to perform." + } + } + }, + { + "$type": "ObjectType", + "name": "RoutingConfiguration", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RoutingConfigurationVersion", + "properties": { + "StateMachineVersionArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) that identifies one or two state machine versions defined in the routing configuration." + }, + "Weight": { + "type": { + "$ref": "#/26" + }, + "flags": 1, + "description": "The 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." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/24" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.StepFunctions/StateMachineAliasProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/24" + } + }, + { + "$type": "ObjectType", + "name": "AWS.StepFunctions/StateMachineAliasProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The ARN of the alias." + }, + "DeploymentPreference": { + "type": { + "$ref": "#/22" + }, + "flags": 4 + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "An optional description of the alias." + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The alias name." + }, + "RoutingConfiguration": { + "type": { + "$ref": "#/29" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.StepFunctions/StateMachineAlias", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/30" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.StepFunctions/StateMachineAlias@default", + "scopeType": 0, + "body": { + "$ref": "#/31" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.stepfunctions/default/types.md b/artifacts/bicep/aws/aws.stepfunctions/default/types.md index c4073370..b4ea1147 100644 --- a/artifacts/bicep/aws/aws.stepfunctions/default/types.md +++ b/artifacts/bicep/aws/aws.stepfunctions/default/types.md @@ -3,23 +3,23 @@ ## Resource AWS.StepFunctions/Activity@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.StepFunctions/ActivityProperties](#awsstepfunctionsactivityproperties) (Required): properties of the resource +* **properties**: [AWS.StepFunctions/ActivityProperties](#awsstepfunctionsactivityproperties) (Required, Identifier): properties of the resource ## Resource AWS.StepFunctions/StateMachine@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.StepFunctions/StateMachineProperties](#awsstepfunctionsstatemachineproperties) (Required): properties of the resource +* **properties**: [AWS.StepFunctions/StateMachineProperties](#awsstepfunctionsstatemachineproperties) (Required, Identifier): properties of the resource ## Resource AWS.StepFunctions/StateMachineAlias@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.StepFunctions/StateMachineAliasProperties](#awsstepfunctionsstatemachinealiasproperties): properties of the resource +* **properties**: [AWS.StepFunctions/StateMachineAliasProperties](#awsstepfunctionsstatemachinealiasproperties) (Identifier): properties of the resource ## AWS.StepFunctions/ActivityProperties ### Properties @@ -27,10 +27,13 @@ * **Name**: string (Required) * **Tags**: [TagsEntry](#tagsentry)[] -## TagsEntry +## AWS.StepFunctions/StateMachineAliasProperties ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **Arn**: string (ReadOnly, Identifier): The ARN of the alias. +* **DeploymentPreference**: [DeploymentPreference](#deploymentpreference) (WriteOnly) +* **Description**: string: An optional description of the alias. +* **Name**: string: The alias name. +* **RoutingConfiguration**: [RoutingConfigurationVersion](#routingconfigurationversion)[] ## AWS.StepFunctions/StateMachineProperties ### Properties @@ -48,59 +51,56 @@ * **Tags**: [TagsEntry](#tagsentry)[] * **TracingConfiguration**: [TracingConfiguration](#tracingconfiguration) -## Definition +## CloudWatchLogsLogGroup ### Properties +* **LogGroupArn**: string -## S3Location +## Definition ### Properties -* **Bucket**: string (Required) -* **Key**: string (Required) -* **Version**: string ## DefinitionSubstitutions ### Properties +## DeploymentPreference +### Properties +* **Alarms**: string[]: A list of CloudWatch alarm names that will be monitored during the deployment. The deployment will fail and rollback if any alarms go into ALARM state. +* **Interval**: int: The time in minutes between each traffic shifting increment. +* **Percentage**: int: The percentage of traffic to shift to the new version in each increment. +* **StateMachineVersionArn**: string (Required) +* **Type**: string (Required): The type of deployment to perform. + +## LogDestination +### Properties +* **CloudWatchLogsLogGroup**: [CloudWatchLogsLogGroup](#cloudwatchlogsloggroup) + ## LoggingConfiguration ### Properties * **Destinations**: [LogDestination](#logdestination)[] * **IncludeExecutionData**: bool * **Level**: string -## LogDestination +## RoutingConfigurationVersion ### Properties -* **CloudWatchLogsLogGroup**: [CloudWatchLogsLogGroup](#cloudwatchlogsloggroup) +* **StateMachineVersionArn**: string (Required): The Amazon Resource Name (ARN) that identifies one or two state machine versions defined in the routing configuration. +* **Weight**: int (Required): The 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. -## CloudWatchLogsLogGroup +## S3Location ### Properties -* **LogGroupArn**: string +* **Bucket**: string (Required) +* **Key**: string (Required) +* **Version**: string ## TagsEntry ### Properties * **Key**: string (Required) * **Value**: string (Required) -## TracingConfiguration -### Properties -* **Enabled**: bool - -## AWS.StepFunctions/StateMachineAliasProperties -### Properties -* **Arn**: string (ReadOnly, Identifier): The ARN of the alias. -* **DeploymentPreference**: [DeploymentPreference](#deploymentpreference) (WriteOnly) -* **Description**: string: An optional description of the alias. -* **Name**: string: The alias name. -* **RoutingConfiguration**: [RoutingConfigurationVersion](#routingconfigurationversion)[] - -## DeploymentPreference +## TagsEntry ### Properties -* **Alarms**: string[]: A list of CloudWatch alarm names that will be monitored during the deployment. The deployment will fail and rollback if any alarms go into ALARM state. -* **Interval**: int: The time in minutes between each traffic shifting increment. -* **Percentage**: int: The percentage of traffic to shift to the new version in each increment. -* **StateMachineVersionArn**: string (Required) -* **Type**: string (Required): The type of deployment to perform. +* **Key**: string (Required) +* **Value**: string (Required) -## RoutingConfigurationVersion +## TracingConfiguration ### Properties -* **StateMachineVersionArn**: string (Required): The Amazon Resource Name (ARN) that identifies one or two state machine versions defined in the routing configuration. -* **Weight**: int (Required): The 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. +* **Enabled**: bool diff --git a/artifacts/bicep/aws/aws.supportapp/default/types.json b/artifacts/bicep/aws/aws.supportapp/default/types.json index 005060a2..e5a62cc2 100644 --- a/artifacts/bicep/aws/aws.supportapp/default/types.json +++ b/artifacts/bicep/aws/aws.supportapp/default/types.json @@ -1 +1,230 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"AWS.SupportApp/AccountAliasProperties","Properties":{"AccountAlias":{"Type":4,"Flags":1,"Description":"An account alias associated with a customer's account."},"AccountAliasResourceId":{"Type":4,"Flags":18,"Description":"Unique identifier representing an alias tied to an account"}}}},{"2":{"Name":"AWS.SupportApp/AccountAlias","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":8,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.SupportApp/AccountAlias@default","ScopeType":0,"Body":9}},{"2":{"Name":"AWS.SupportApp/SlackChannelConfigurationProperties","Properties":{"ChannelId":{"Type":4,"Flags":17,"Description":"The channel ID in Slack, which identifies a channel within a workspace."},"ChannelName":{"Type":4,"Flags":0,"Description":"The channel name in Slack."},"ChannelRoleArn":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) of an IAM role that grants the AWS Support App access to perform operations for AWS services."},"NotifyOnAddCorrespondenceToCase":{"Type":2,"Flags":0,"Description":"Whether to notify when a correspondence is added to a case."},"NotifyOnCaseSeverity":{"Type":4,"Flags":1,"Description":"The severity level of a support case that a customer wants to get notified for."},"NotifyOnCreateOrReopenCase":{"Type":2,"Flags":0,"Description":"Whether to notify when a case is created or reopened."},"NotifyOnResolveCase":{"Type":2,"Flags":0,"Description":"Whether to notify when a case is resolved."},"TeamId":{"Type":4,"Flags":17,"Description":"The team ID in Slack, which uniquely identifies a workspace."}}}},{"2":{"Name":"AWS.SupportApp/SlackChannelConfiguration","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":11,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.SupportApp/SlackChannelConfiguration@default","ScopeType":0,"Body":12}},{"2":{"Name":"AWS.SupportApp/SlackWorkspaceConfigurationProperties","Properties":{"TeamId":{"Type":4,"Flags":17,"Description":"The team ID in Slack, which uniquely identifies a workspace."},"VersionId":{"Type":4,"Flags":4,"Description":"An identifier used to update an existing Slack workspace configuration in AWS CloudFormation."}}}},{"2":{"Name":"AWS.SupportApp/SlackWorkspaceConfiguration","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":14,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.SupportApp/SlackWorkspaceConfiguration@default","ScopeType":0,"Body":15}}] \ No newline at end of file +[ + { + "$type": "StringLiteralType", + "value": "AWS.SupportApp/AccountAliasProperties" + }, + { + "$type": "StringType" + }, + { + "$type": "ObjectType", + "name": "AWS.SupportApp/AccountAliasProperties", + "properties": { + "AccountAlias": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "An account alias associated with a customer's account." + }, + "AccountAliasResourceId": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "Unique identifier representing an alias tied to an account" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SupportApp/AccountAlias", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SupportApp/AccountAlias@default", + "scopeType": 0, + "body": { + "$ref": "#/3" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.SupportApp/SlackChannelConfigurationProperties" + }, + { + "$type": "BooleanType" + }, + { + "$type": "ObjectType", + "name": "AWS.SupportApp/SlackChannelConfigurationProperties", + "properties": { + "ChannelId": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The channel ID in Slack, which identifies a channel within a workspace." + }, + "ChannelName": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The channel name in Slack." + }, + "ChannelRoleArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of an IAM role that grants the AWS Support App access to perform operations for AWS services." + }, + "NotifyOnAddCorrespondenceToCase": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Whether to notify when a correspondence is added to a case." + }, + "NotifyOnCaseSeverity": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The severity level of a support case that a customer wants to get notified for." + }, + "NotifyOnCreateOrReopenCase": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Whether to notify when a case is created or reopened." + }, + "NotifyOnResolveCase": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "Whether to notify when a case is resolved." + }, + "TeamId": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The team ID in Slack, which uniquely identifies a workspace." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SupportApp/SlackChannelConfiguration", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/7" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SupportApp/SlackChannelConfiguration@default", + "scopeType": 0, + "body": { + "$ref": "#/8" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.SupportApp/SlackWorkspaceConfigurationProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.SupportApp/SlackWorkspaceConfigurationProperties", + "properties": { + "TeamId": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The team ID in Slack, which uniquely identifies a workspace." + }, + "VersionId": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "An identifier used to update an existing Slack workspace configuration in AWS CloudFormation." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SupportApp/SlackWorkspaceConfiguration", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/11" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SupportApp/SlackWorkspaceConfiguration@default", + "scopeType": 0, + "body": { + "$ref": "#/12" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.supportapp/default/types.md b/artifacts/bicep/aws/aws.supportapp/default/types.md index 3099e837..7fd88098 100644 --- a/artifacts/bicep/aws/aws.supportapp/default/types.md +++ b/artifacts/bicep/aws/aws.supportapp/default/types.md @@ -3,23 +3,23 @@ ## Resource AWS.SupportApp/AccountAlias@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.SupportApp/AccountAliasProperties](#awssupportappaccountaliasproperties) (Required): properties of the resource +* **properties**: [AWS.SupportApp/AccountAliasProperties](#awssupportappaccountaliasproperties) (Required, Identifier): properties of the resource ## Resource AWS.SupportApp/SlackChannelConfiguration@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.SupportApp/SlackChannelConfigurationProperties](#awssupportappslackchannelconfigurationproperties) (Required): properties of the resource +* **properties**: [AWS.SupportApp/SlackChannelConfigurationProperties](#awssupportappslackchannelconfigurationproperties) (Required, Identifier): properties of the resource ## Resource AWS.SupportApp/SlackWorkspaceConfiguration@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.SupportApp/SlackWorkspaceConfigurationProperties](#awssupportappslackworkspaceconfigurationproperties) (Required): properties of the resource +* **properties**: [AWS.SupportApp/SlackWorkspaceConfigurationProperties](#awssupportappslackworkspaceconfigurationproperties) (Required, Identifier): properties of the resource ## AWS.SupportApp/AccountAliasProperties ### Properties diff --git a/artifacts/bicep/aws/aws.synthetics/default/types.json b/artifacts/bicep/aws/aws.synthetics/default/types.json index 990c924e..a7de7f37 100644 --- a/artifacts/bicep/aws/aws.synthetics/default/types.json +++ b/artifacts/bicep/aws/aws.synthetics/default/types.json @@ -1 +1,530 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"ArtifactConfig","Properties":{"S3Encryption":{"Type":12,"Flags":0,"Description":"Encryption configuration for uploading artifacts to S3"}}}},{"2":{"Name":"BaseScreenshot","Properties":{"IgnoreCoordinates":{"Type":17,"Flags":0,"Description":"List of coordinates of rectangles to be ignored during visual testing"},"ScreenshotName":{"Type":4,"Flags":1,"Description":"Name of the screenshot to be used as base reference for visual testing"}}}},{"2":{"Name":"Code","Properties":{"Handler":{"Type":4,"Flags":1},"S3Bucket":{"Type":4,"Flags":4},"S3Key":{"Type":4,"Flags":4},"S3ObjectVersion":{"Type":4,"Flags":4},"Script":{"Type":4,"Flags":4},"SourceLocationArn":{"Type":4,"Flags":2}}}},{"2":{"Name":"RunConfig","Properties":{"ActiveTracing":{"Type":2,"Flags":0,"Description":"Enable active tracing if set to true"},"EnvironmentVariables":{"Type":18,"Flags":4,"Description":"Environment variable key-value pairs."},"MemoryInMB":{"Type":3,"Flags":0,"Description":"Provide maximum memory available for canary in MB"},"TimeoutInSeconds":{"Type":3,"Flags":0,"Description":"Provide maximum canary timeout per run in seconds"}}}},{"2":{"Name":"S3Encryption","Properties":{"EncryptionMode":{"Type":4,"Flags":0,"Description":"Encryption mode for encrypting artifacts when uploading to S3. Valid values: SSE_S3 and SSE_KMS."},"KmsKeyArn":{"Type":4,"Flags":0,"Description":"KMS key Arn for encrypting artifacts when uploading to S3. You must specify KMS key Arn for SSE_KMS encryption mode only."}}}},{"2":{"Name":"Schedule","Properties":{"DurationInSeconds":{"Type":4,"Flags":0},"Expression":{"Type":4,"Flags":1}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}}}},{"2":{"Name":"VPCConfig","Properties":{"SecurityGroupIds":{"Type":19,"Flags":1},"SubnetIds":{"Type":20,"Flags":1},"VpcId":{"Type":4,"Flags":0}}}},{"2":{"Name":"VisualReference","Properties":{"BaseCanaryRunId":{"Type":4,"Flags":1,"Description":"Canary run id to be used as base reference for visual testing"},"BaseScreenshots":{"Type":21,"Flags":0,"Description":"List of screenshots used as base reference for visual testing"}}}},{"3":{"ItemType":4}},{"2":{"Name":"Canary_EnvironmentVariables","Properties":{}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":9}},{"2":{"Name":"AWS.Synthetics/CanaryProperties","Properties":{"ArtifactConfig":{"Type":8,"Flags":0,"Description":"Provide artifact configuration"},"ArtifactS3Location":{"Type":4,"Flags":1,"Description":"Provide the s3 bucket output location for test results"},"Code":{"Type":10,"Flags":1,"Description":"Provide the canary script source"},"DeleteLambdaResourcesOnCanaryDeletion":{"Type":2,"Flags":4,"Description":"Deletes associated lambda resources created by Synthetics if set to True. Default is False"},"ExecutionRoleArn":{"Type":4,"Flags":1,"Description":"Lambda Execution role used to run your canaries"},"FailureRetentionPeriod":{"Type":3,"Flags":0,"Description":"Retention period of failed canary runs represented in number of days"},"Id":{"Type":4,"Flags":2,"Description":"Id of the canary"},"Name":{"Type":4,"Flags":17,"Description":"Name of the canary."},"RunConfig":{"Type":11,"Flags":0,"Description":"Provide canary run configuration"},"RuntimeVersion":{"Type":4,"Flags":1,"Description":"Runtime version of Synthetics Library"},"Schedule":{"Type":13,"Flags":1,"Description":"Frequency to run your canaries"},"StartCanaryAfterCreation":{"Type":2,"Flags":4,"Description":"Runs canary if set to True. Default is False"},"State":{"Type":4,"Flags":2,"Description":"State of the canary"},"SuccessRetentionPeriod":{"Type":3,"Flags":0,"Description":"Retention period of successful canary runs represented in number of days"},"Tags":{"Type":23,"Flags":0},"VPCConfig":{"Type":15,"Flags":0,"Description":"Provide VPC Configuration if enabled."},"VisualReference":{"Type":16,"Flags":4,"Description":"Visual reference configuration for visual testing"}}}},{"3":{"ItemType":14}},{"2":{"Name":"AWS.Synthetics/Canary","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":22,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Synthetics/Canary@default","ScopeType":0,"Body":24}},{"2":{"Name":"ResourceArn"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}}}},{"2":{"Name":"AWS.Synthetics/GroupProperties","Properties":{"Id":{"Type":4,"Flags":2,"Description":"Id of the group."},"Name":{"Type":4,"Flags":17,"Description":"Name of the group."},"ResourceArns":{"Type":29,"Flags":0},"Tags":{"Type":30,"Flags":0}}}},{"3":{"ItemType":4}},{"3":{"ItemType":27}},{"2":{"Name":"AWS.Synthetics/Group","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":28,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Synthetics/Group@default","ScopeType":0,"Body":31}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "ArtifactConfig", + "properties": { + "S3Encryption": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Encryption configuration for uploading artifacts to S3" + } + } + }, + { + "$type": "ObjectType", + "name": "BaseScreenshot", + "properties": { + "IgnoreCoordinates": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "List of coordinates of rectangles to be ignored during visual testing" + }, + "ScreenshotName": { + "type": { + "$ref": "#/9" + }, + "flags": 1, + "description": "Name of the screenshot to be used as base reference for visual testing" + } + } + }, + { + "$type": "ObjectType", + "name": "Code", + "properties": { + "Handler": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + }, + "S3Bucket": { + "type": { + "$ref": "#/9" + }, + "flags": 4 + }, + "S3Key": { + "type": { + "$ref": "#/9" + }, + "flags": 4 + }, + "S3ObjectVersion": { + "type": { + "$ref": "#/9" + }, + "flags": 4 + }, + "Script": { + "type": { + "$ref": "#/9" + }, + "flags": 4 + }, + "SourceLocationArn": { + "type": { + "$ref": "#/9" + }, + "flags": 2 + } + } + }, + { + "$type": "ObjectType", + "name": "RunConfig", + "properties": { + "ActiveTracing": { + "type": { + "$ref": "#/11" + }, + "flags": 0, + "description": "Enable active tracing if set to true" + }, + "EnvironmentVariables": { + "type": { + "$ref": "#/12" + }, + "flags": 4, + "description": "Environment variable key-value pairs." + }, + "MemoryInMB": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "Provide maximum memory available for canary in MB" + }, + "TimeoutInSeconds": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "Provide maximum canary timeout per run in seconds" + } + } + }, + { + "$type": "ObjectType", + "name": "S3Encryption", + "properties": { + "EncryptionMode": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "Encryption mode for encrypting artifacts when uploading to S3. Valid values: SSE_S3 and SSE_KMS." + }, + "KmsKeyArn": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "KMS key Arn for encrypting artifacts when uploading to S3. You must specify KMS key Arn for SSE_KMS encryption mode only." + } + } + }, + { + "$type": "ObjectType", + "name": "Schedule", + "properties": { + "DurationInSeconds": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + }, + "Expression": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/9" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + }, + "Value": { + "type": { + "$ref": "#/9" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + } + } + }, + { + "$type": "ObjectType", + "name": "VPCConfig", + "properties": { + "SecurityGroupIds": { + "type": { + "$ref": "#/14" + }, + "flags": 1 + }, + "SubnetIds": { + "type": { + "$ref": "#/15" + }, + "flags": 1 + }, + "VpcId": { + "type": { + "$ref": "#/9" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "VisualReference", + "properties": { + "BaseCanaryRunId": { + "type": { + "$ref": "#/9" + }, + "flags": 1, + "description": "Canary run id to be used as base reference for visual testing" + }, + "BaseScreenshots": { + "type": { + "$ref": "#/16" + }, + "flags": 0, + "description": "List of screenshots used as base reference for visual testing" + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/9" + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "ObjectType", + "name": "Canary_EnvironmentVariables", + "properties": {} + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/9" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/9" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Synthetics/CanaryProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/6" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Synthetics/CanaryProperties", + "properties": { + "ArtifactConfig": { + "type": { + "$ref": "#/0" + }, + "flags": 0, + "description": "Provide artifact configuration" + }, + "ArtifactS3Location": { + "type": { + "$ref": "#/9" + }, + "flags": 1, + "description": "Provide the s3 bucket output location for test results" + }, + "Code": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "Provide the canary script source" + }, + "DeleteLambdaResourcesOnCanaryDeletion": { + "type": { + "$ref": "#/11" + }, + "flags": 4, + "description": "Deletes associated lambda resources created by Synthetics if set to True. Default is False" + }, + "ExecutionRoleArn": { + "type": { + "$ref": "#/9" + }, + "flags": 1, + "description": "Lambda Execution role used to run your canaries" + }, + "FailureRetentionPeriod": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "Retention period of failed canary runs represented in number of days" + }, + "Id": { + "type": { + "$ref": "#/9" + }, + "flags": 2, + "description": "Id of the canary" + }, + "Name": { + "type": { + "$ref": "#/9" + }, + "flags": 17, + "description": "Name of the canary." + }, + "RunConfig": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "Provide canary run configuration" + }, + "RuntimeVersion": { + "type": { + "$ref": "#/9" + }, + "flags": 1, + "description": "Runtime version of Synthetics Library" + }, + "Schedule": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "Frequency to run your canaries" + }, + "StartCanaryAfterCreation": { + "type": { + "$ref": "#/11" + }, + "flags": 4, + "description": "Runs canary if set to True. Default is False" + }, + "State": { + "type": { + "$ref": "#/9" + }, + "flags": 2, + "description": "State of the canary" + }, + "SuccessRetentionPeriod": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "Retention period of successful canary runs represented in number of days" + }, + "Tags": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "VPCConfig": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "Provide VPC Configuration if enabled." + }, + "VisualReference": { + "type": { + "$ref": "#/8" + }, + "flags": 4, + "description": "Visual reference configuration for visual testing" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Synthetics/Canary", + "properties": { + "name": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/9" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/19" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Synthetics/Canary@default", + "scopeType": 0, + "body": { + "$ref": "#/20" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "ResourceArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/9" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + }, + "Value": { + "type": { + "$ref": "#/9" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Synthetics/GroupProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/9" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/23" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Synthetics/GroupProperties", + "properties": { + "Id": { + "type": { + "$ref": "#/9" + }, + "flags": 2, + "description": "Id of the group." + }, + "Name": { + "type": { + "$ref": "#/9" + }, + "flags": 17, + "description": "Name of the group." + }, + "ResourceArns": { + "type": { + "$ref": "#/25" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/26" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Synthetics/Group", + "properties": { + "name": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/9" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/27" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Synthetics/Group@default", + "scopeType": 0, + "body": { + "$ref": "#/28" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.synthetics/default/types.md b/artifacts/bicep/aws/aws.synthetics/default/types.md index 020f1703..e16d69f7 100644 --- a/artifacts/bicep/aws/aws.synthetics/default/types.md +++ b/artifacts/bicep/aws/aws.synthetics/default/types.md @@ -3,16 +3,20 @@ ## Resource AWS.Synthetics/Canary@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Synthetics/CanaryProperties](#awssyntheticscanaryproperties) (Required): properties of the resource +* **properties**: [AWS.Synthetics/CanaryProperties](#awssyntheticscanaryproperties) (Required, Identifier): properties of the resource ## Resource AWS.Synthetics/Group@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Synthetics/GroupProperties](#awssyntheticsgroupproperties) (Required): properties of the resource +* **properties**: [AWS.Synthetics/GroupProperties](#awssyntheticsgroupproperties) (Required, Identifier): properties of the resource + +## ArtifactConfig +### Properties +* **S3Encryption**: [S3Encryption](#s3encryption): Encryption configuration for uploading artifacts to S3 ## AWS.Synthetics/CanaryProperties ### Properties @@ -34,14 +38,20 @@ * **VisualReference**: [VisualReference](#visualreference) (WriteOnly): Visual reference configuration for visual testing * **VPCConfig**: [VPCConfig](#vpcconfig): Provide VPC Configuration if enabled. -## ArtifactConfig +## AWS.Synthetics/GroupProperties ### Properties -* **S3Encryption**: [S3Encryption](#s3encryption): Encryption configuration for uploading artifacts to S3 +* **Id**: string (ReadOnly): Id of the group. +* **Name**: string (Required, Identifier): Name of the group. +* **ResourceArns**: string[] +* **Tags**: [Tag](#tag)[] -## S3Encryption +## BaseScreenshot +### Properties +* **IgnoreCoordinates**: string[]: List of coordinates of rectangles to be ignored during visual testing +* **ScreenshotName**: string (Required): Name of the screenshot to be used as base reference for visual testing + +## Canary_EnvironmentVariables ### Properties -* **EncryptionMode**: string: Encryption mode for encrypting artifacts when uploading to S3. Valid values: SSE_S3 and SSE_KMS. -* **KmsKeyArn**: string: KMS key Arn for encrypting artifacts when uploading to S3. You must specify KMS key Arn for SSE_KMS encryption mode only. ## Code ### Properties @@ -59,8 +69,10 @@ * **MemoryInMB**: int: Provide maximum memory available for canary in MB * **TimeoutInSeconds**: int: Provide maximum canary timeout per run in seconds -## Canary_EnvironmentVariables +## S3Encryption ### Properties +* **EncryptionMode**: string: Encryption mode for encrypting artifacts when uploading to S3. Valid values: SSE_S3 and SSE_KMS. +* **KmsKeyArn**: string: KMS key Arn for encrypting artifacts when uploading to S3. You must specify KMS key Arn for SSE_KMS encryption mode only. ## Schedule ### Properties @@ -72,31 +84,19 @@ * **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. * **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + ## VisualReference ### Properties * **BaseCanaryRunId**: string (Required): Canary run id to be used as base reference for visual testing * **BaseScreenshots**: [BaseScreenshot](#basescreenshot)[]: List of screenshots used as base reference for visual testing -## BaseScreenshot -### Properties -* **IgnoreCoordinates**: string[]: List of coordinates of rectangles to be ignored during visual testing -* **ScreenshotName**: string (Required): Name of the screenshot to be used as base reference for visual testing - ## VPCConfig ### Properties * **SecurityGroupIds**: string[] (Required) * **SubnetIds**: string[] (Required) * **VpcId**: string -## AWS.Synthetics/GroupProperties -### Properties -* **Id**: string (ReadOnly): Id of the group. -* **Name**: string (Required, Identifier): Name of the group. -* **ResourceArns**: string[] -* **Tags**: [Tag](#tag)[] - -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - diff --git a/artifacts/bicep/aws/aws.systemsmanagersap/default/types.json b/artifacts/bicep/aws/aws.systemsmanagersap/default/types.json index 5cb2c99e..bcce41a8 100644 --- a/artifacts/bicep/aws/aws.systemsmanagersap/default/types.json +++ b/artifacts/bicep/aws/aws.systemsmanagersap/default/types.json @@ -1 +1,168 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"Credential","Properties":{"CredentialType":{"Type":4,"Flags":0},"DatabaseName":{"Type":4,"Flags":0},"SecretId":{"Type":4,"Flags":0}}}},{"2":{"Name":"Instance"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}}}},{"2":{"Name":"AWS.SystemsManagerSAP/ApplicationProperties","Properties":{"ApplicationId":{"Type":4,"Flags":1},"ApplicationType":{"Type":4,"Flags":1},"Arn":{"Type":4,"Flags":18,"Description":"The ARN of the Helix application"},"Credentials":{"Type":12,"Flags":4},"Instances":{"Type":13,"Flags":4},"SapInstanceNumber":{"Type":4,"Flags":4},"Sid":{"Type":4,"Flags":4},"Tags":{"Type":14,"Flags":0,"Description":"The tags of a SystemsManagerSAP application."}}}},{"3":{"ItemType":8}},{"3":{"ItemType":4}},{"3":{"ItemType":10}},{"2":{"Name":"AWS.SystemsManagerSAP/Application","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":11,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.SystemsManagerSAP/Application@default","ScopeType":0,"Body":15}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Credential", + "properties": { + "CredentialType": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "DatabaseName": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "SecretId": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Instance", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.SystemsManagerSAP/ApplicationProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ObjectType", + "name": "AWS.SystemsManagerSAP/ApplicationProperties", + "properties": { + "ApplicationId": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + }, + "ApplicationType": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + }, + "Arn": { + "type": { + "$ref": "#/3" + }, + "flags": 18, + "description": "The ARN of the Helix application" + }, + "Credentials": { + "type": { + "$ref": "#/5" + }, + "flags": 4 + }, + "Instances": { + "type": { + "$ref": "#/6" + }, + "flags": 4 + }, + "SapInstanceNumber": { + "type": { + "$ref": "#/3" + }, + "flags": 4 + }, + "Sid": { + "type": { + "$ref": "#/3" + }, + "flags": 4 + }, + "Tags": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "The tags of a SystemsManagerSAP application." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.SystemsManagerSAP/Application", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/8" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.SystemsManagerSAP/Application@default", + "scopeType": 0, + "body": { + "$ref": "#/9" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.systemsmanagersap/default/types.md b/artifacts/bicep/aws/aws.systemsmanagersap/default/types.md index c16c9fd5..4bb6eaa4 100644 --- a/artifacts/bicep/aws/aws.systemsmanagersap/default/types.md +++ b/artifacts/bicep/aws/aws.systemsmanagersap/default/types.md @@ -3,9 +3,9 @@ ## Resource AWS.SystemsManagerSAP/Application@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.SystemsManagerSAP/ApplicationProperties](#awssystemsmanagersapapplicationproperties) (Required): properties of the resource +* **properties**: [AWS.SystemsManagerSAP/ApplicationProperties](#awssystemsmanagersapapplicationproperties) (Required, Identifier): properties of the resource ## AWS.SystemsManagerSAP/ApplicationProperties ### Properties diff --git a/artifacts/bicep/aws/aws.timestream/default/types.json b/artifacts/bicep/aws/aws.timestream/default/types.json index 2d228bff..001d9d2d 100644 --- a/artifacts/bicep/aws/aws.timestream/default/types.json +++ b/artifacts/bicep/aws/aws.timestream/default/types.json @@ -1 +1,1282 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":0},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"AWS.Timestream/DatabaseProperties","Properties":{"Arn":{"Type":4,"Flags":2},"DatabaseName":{"Type":4,"Flags":16,"Description":"The name for the database. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the database name."},"KmsKeyId":{"Type":4,"Flags":0,"Description":"The KMS key for the database. If the KMS key is not specified, the database will be encrypted with a Timestream managed KMS key located in your account."},"Tags":{"Type":10,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."}}}},{"3":{"ItemType":8}},{"2":{"Name":"AWS.Timestream/Database","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":9,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Timestream/Database@default","ScopeType":0,"Body":11}},{"2":{"Name":"Arn"}},{"2":{"Name":"BucketName"}},{"2":{"Name":"ClientToken"}},{"2":{"Name":"DatabaseName"}},{"2":{"Name":"DimensionMapping","Properties":{"DimensionValueType":{"Type":4,"Flags":1},"Name":{"Type":4,"Flags":1}}}},{"2":{"Name":"DimensionMappingName"}},{"2":{"Name":"DimensionMappings"}},{"2":{"Name":"DimensionValueType"}},{"2":{"Name":"EncryptionOption"}},{"2":{"Name":"ErrorReportConfiguration","Properties":{"S3Configuration":{"Type":40,"Flags":1}}}},{"2":{"Name":"Key"}},{"2":{"Name":"KmsKeyId"}},{"2":{"Name":"MeasureNameColumn"}},{"2":{"Name":"MixedMeasureMapping","Properties":{"MeasureName":{"Type":4,"Flags":0},"MeasureValueType":{"Type":4,"Flags":1},"MultiMeasureAttributeMappings":{"Type":57,"Flags":0},"SourceColumn":{"Type":4,"Flags":0},"TargetMeasureName":{"Type":4,"Flags":0}}}},{"2":{"Name":"MixedMeasureMappingMeasureName"}},{"2":{"Name":"MixedMeasureMappingMeasureValueType"}},{"2":{"Name":"MixedMeasureMappingSourceColumn"}},{"2":{"Name":"MixedMeasureMappingTargetMeasureName"}},{"2":{"Name":"MixedMeasureMappings"}},{"2":{"Name":"MultiMeasureAttributeMapping","Properties":{"MeasureValueType":{"Type":4,"Flags":1},"SourceColumn":{"Type":4,"Flags":1},"TargetMultiMeasureAttributeName":{"Type":4,"Flags":0}}}},{"2":{"Name":"MultiMeasureAttributeMappingList"}},{"2":{"Name":"MultiMeasureAttributeMappingMeasureValueType"}},{"2":{"Name":"MultiMeasureAttributeMappingSourceColumn"}},{"2":{"Name":"MultiMeasureMappings","Properties":{"MultiMeasureAttributeMappings":{"Type":60,"Flags":1},"TargetMultiMeasureName":{"Type":4,"Flags":0}}}},{"2":{"Name":"NotificationConfiguration","Properties":{"SnsConfiguration":{"Type":45,"Flags":1}}}},{"2":{"Name":"ObjectKeyPrefix"}},{"2":{"Name":"QueryString"}},{"2":{"Name":"S3Configuration","Properties":{"BucketName":{"Type":4,"Flags":1},"EncryptionOption":{"Type":4,"Flags":0},"ObjectKeyPrefix":{"Type":4,"Flags":0}}}},{"2":{"Name":"ScheduleConfiguration","Properties":{"ScheduleExpression":{"Type":4,"Flags":1}}}},{"2":{"Name":"ScheduleExpression"}},{"2":{"Name":"ScheduledQueryExecutionRoleArn"}},{"2":{"Name":"ScheduledQueryName"}},{"2":{"Name":"SnsConfiguration","Properties":{"TopicArn":{"Type":4,"Flags":1}}}},{"2":{"Name":"TableName"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"Tags"}},{"2":{"Name":"TargetConfiguration","Properties":{"TimestreamConfiguration":{"Type":53,"Flags":1}}}},{"2":{"Name":"TargetMultiMeasureAttributeName"}},{"2":{"Name":"TargetMultiMeasureName"}},{"2":{"Name":"TimeColumn"}},{"2":{"Name":"TimestreamConfiguration","Properties":{"DatabaseName":{"Type":4,"Flags":1},"DimensionMappings":{"Type":62,"Flags":1},"MeasureNameColumn":{"Type":4,"Flags":0},"MixedMeasureMappings":{"Type":63,"Flags":0},"MultiMeasureMappings":{"Type":36,"Flags":0},"TableName":{"Type":4,"Flags":1},"TimeColumn":{"Type":4,"Flags":1}}}},{"2":{"Name":"TopicArn"}},{"2":{"Name":"Value"}},{"3":{"ItemType":17}},{"3":{"ItemType":32}},{"3":{"ItemType":26}},{"3":{"ItemType":32}},{"3":{"ItemType":32}},{"3":{"ItemType":47}},{"3":{"ItemType":17}},{"3":{"ItemType":26}},{"2":{"Name":"AWS.Timestream/ScheduledQueryProperties","Properties":{"Arn":{"Type":4,"Flags":18},"ClientToken":{"Type":4,"Flags":0},"ErrorReportConfiguration":{"Type":22,"Flags":1},"KmsKeyId":{"Type":4,"Flags":0},"NotificationConfiguration":{"Type":37,"Flags":1},"QueryString":{"Type":4,"Flags":1},"SQErrorReportConfiguration":{"Type":4,"Flags":2,"Description":"Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results."},"SQKmsKeyId":{"Type":4,"Flags":2,"Description":"The Amazon KMS key used to encrypt the scheduled query resource, at-rest. If the Amazon KMS key is not specified, the scheduled query resource will be encrypted with a Timestream owned Amazon KMS key. To specify a KMS key, use the key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix the name with alias/. If ErrorReportConfiguration uses SSE_KMS as encryption type, the same KmsKeyId is used to encrypt the error report at rest."},"SQName":{"Type":4,"Flags":2,"Description":"The name of the scheduled query. Scheduled query names must be unique within each Region."},"SQNotificationConfiguration":{"Type":4,"Flags":2,"Description":"Notification configuration for the scheduled query. A notification is sent by Timestream when a query run finishes, when the state is updated or when you delete it."},"SQQueryString":{"Type":4,"Flags":2,"Description":"The query string to run. Parameter names can be specified in the query string @ character followed by an identifier. The named Parameter @scheduled_runtime is reserved and can be used in the query to get the time at which the query is scheduled to run. The timestamp calculated according to the ScheduleConfiguration parameter, will be the value of @scheduled_runtime paramater for each query run. For example, consider an instance of a scheduled query executing on 2021-12-01 00:00:00. For this instance, the @scheduled_runtime parameter is initialized to the timestamp 2021-12-01 00:00:00 when invoking the query."},"SQScheduleConfiguration":{"Type":4,"Flags":2,"Description":"Configuration for when the scheduled query is executed."},"SQScheduledQueryExecutionRoleArn":{"Type":4,"Flags":2,"Description":"The ARN for the IAM role that Timestream will assume when running the scheduled query."},"SQTargetConfiguration":{"Type":4,"Flags":2,"Description":"Configuration of target store where scheduled query results are written to."},"ScheduleConfiguration":{"Type":41,"Flags":1},"ScheduledQueryExecutionRoleArn":{"Type":4,"Flags":1},"ScheduledQueryName":{"Type":4,"Flags":0},"Tags":{"Type":65,"Flags":0},"TargetConfiguration":{"Type":49,"Flags":0}}}},{"3":{"ItemType":47}},{"2":{"Name":"AWS.Timestream/ScheduledQuery","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":64,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Timestream/ScheduledQuery@default","ScopeType":0,"Body":66}},{"2":{"Name":"PartitionKey","Properties":{"EnforcementInRecord":{"Type":4,"Flags":0},"Name":{"Type":4,"Flags":0},"Type":{"Type":4,"Flags":1}}}},{"2":{"Name":"PartitionKeyEnforcementLevel"}},{"2":{"Name":"PartitionKeyList"}},{"2":{"Name":"PartitionKeyType"}},{"2":{"Name":"SchemaName"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":0},"Value":{"Type":4,"Flags":0}}}},{"3":{"ItemType":68}},{"2":{"Name":"AWS.Timestream/TableProperties","Properties":{"Arn":{"Type":4,"Flags":2},"DatabaseName":{"Type":4,"Flags":17,"Description":"The name for the database which the table to be created belongs to."},"MagneticStoreWriteProperties":{"Type":78,"Flags":0,"Description":"The properties that determine whether magnetic store writes are enabled."},"Name":{"Type":4,"Flags":2,"Description":"The table name exposed as a read-only attribute."},"RetentionProperties":{"Type":79,"Flags":0,"Description":"The retention duration of the memory store and the magnetic store."},"Schema":{"Type":81,"Flags":0,"Description":"A Schema specifies the expected data model of the table."},"TableName":{"Type":4,"Flags":16,"Description":"The name for the table. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the table name."},"Tags":{"Type":82,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."}}}},{"2":{"Name":"Table_MagneticStoreWriteProperties_MagneticStoreRejectedDataLocation_S3Configuration","Properties":{"BucketName":{"Type":4,"Flags":1,"Description":"The bucket name used to store the data."},"EncryptionOption":{"Type":4,"Flags":1,"Description":"Either SSE_KMS or SSE_S3."},"KmsKeyId":{"Type":4,"Flags":0,"Description":"Must be provided if SSE_KMS is specified as the encryption option"},"ObjectKeyPrefix":{"Type":4,"Flags":0,"Description":"String used to prefix all data in the bucket."}}}},{"2":{"Name":"Table_MagneticStoreWriteProperties_MagneticStoreRejectedDataLocation","Properties":{"S3Configuration":{"Type":76,"Flags":0,"Description":"S3 configuration for location to store rejections from magnetic store writes"}}}},{"2":{"Name":"Table_MagneticStoreWriteProperties","Properties":{"EnableMagneticStoreWrites":{"Type":2,"Flags":1,"Description":"Boolean flag indicating whether magnetic store writes are enabled."},"MagneticStoreRejectedDataLocation":{"Type":77,"Flags":0,"Description":"Location to store information about records that were asynchronously rejected during magnetic store writes."}}}},{"2":{"Name":"Table_RetentionProperties","Properties":{"MagneticStoreRetentionPeriodInDays":{"Type":4,"Flags":0,"Description":"The duration for which data must be stored in the magnetic store."},"MemoryStoreRetentionPeriodInHours":{"Type":4,"Flags":0,"Description":"The duration for which data must be stored in the memory store."}}}},{"3":{"ItemType":68}},{"2":{"Name":"Table_Schema","Properties":{"CompositePartitionKey":{"Type":80,"Flags":0}}}},{"3":{"ItemType":73}},{"2":{"Name":"AWS.Timestream/Table","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":75,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Timestream/Table@default","ScopeType":0,"Body":83}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.Timestream/DatabaseProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Timestream/DatabaseProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "DatabaseName": { + "type": { + "$ref": "#/1" + }, + "flags": 16, + "description": "The name for the database. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the database name." + }, + "KmsKeyId": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The KMS key for the database. If the KMS key is not specified, the database will be encrypted with a Timestream managed KMS key located in your account." + }, + "Tags": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Timestream/Database", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/4" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Timestream/Database@default", + "scopeType": 0, + "body": { + "$ref": "#/5" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. " + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Timestream/InfluxDBInstanceProperties" + }, + { + "$type": "IntegerType" + }, + { + "$type": "BooleanType" + }, + { + "$type": "ObjectType", + "name": "InfluxDBInstance_LogDeliveryConfiguration_S3Configuration", + "properties": { + "BucketName": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The bucket name for logs to be sent from the InfluxDB instance" + }, + "Enabled": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "Specifies whether logging to customer specified bucket is enabled." + } + } + }, + { + "$type": "ObjectType", + "name": "InfluxDBInstance_LogDeliveryConfiguration", + "properties": { + "S3Configuration": { + "type": { + "$ref": "#/11" + }, + "flags": 1, + "description": "S3 configuration for sending logs to customer account from the InfluxDB instance." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/7" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Timestream/InfluxDBInstanceProperties", + "properties": { + "AllocatedStorage": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "The allocated storage for the InfluxDB instance." + }, + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The Amazon Resource Name (ARN) that is associated with the InfluxDB instance." + }, + "AvailabilityZone": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The Availability Zone (AZ) where the InfluxDB instance is created." + }, + "Bucket": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The bucket for the InfluxDB instance." + }, + "DbInstanceType": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The compute instance of the InfluxDB instance." + }, + "DbParameterGroupIdentifier": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The name of an existing InfluxDB parameter group." + }, + "DbStorageType": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The storage type of the InfluxDB instance." + }, + "DeploymentType": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Deployment type of the InfluxDB Instance." + }, + "Endpoint": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The connection endpoint for the InfluxDB instance." + }, + "Id": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "The service generated unique identifier for InfluxDB instance." + }, + "InfluxAuthParametersSecretArn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The Auth parameters secret Amazon Resource name (ARN) that is associated with the InfluxDB instance." + }, + "LogDeliveryConfiguration": { + "type": { + "$ref": "#/12" + }, + "flags": 0, + "description": "Configuration for sending logs to customer account from the InfluxDB instance." + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The unique name that is associated with the InfluxDB instance." + }, + "Organization": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The organization for the InfluxDB instance." + }, + "Password": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The password for the InfluxDB instance." + }, + "PubliclyAccessible": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "Attach a public IP to the customer ENI." + }, + "SecondaryAvailabilityZone": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The Secondary Availability Zone (AZ) where the InfluxDB instance is created, if DeploymentType is set as WITH_MULTIAZ_STANDBY." + }, + "Status": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "Status of the InfluxDB Instance." + }, + "Tags": { + "type": { + "$ref": "#/13" + }, + "flags": 0, + "description": "An arbitrary set of tags (key-value pairs) for this DB instance." + }, + "Username": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "The username for the InfluxDB instance." + }, + "VpcSecurityGroupIds": { + "type": { + "$ref": "#/14" + }, + "flags": 0, + "description": "A list of Amazon EC2 VPC security groups to associate with this InfluxDB instance." + }, + "VpcSubnetIds": { + "type": { + "$ref": "#/15" + }, + "flags": 0, + "description": "A list of EC2 subnet IDs for this InfluxDB instance." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Timestream/InfluxDBInstance", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/16" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Timestream/InfluxDBInstance@default", + "scopeType": 0, + "body": { + "$ref": "#/17" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Arn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "BucketName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ClientToken", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DatabaseName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DimensionMapping", + "properties": { + "DimensionValueType": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DimensionMappingName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DimensionMappings", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "DimensionValueType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "EncryptionOption", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ErrorReportConfiguration", + "properties": { + "S3Configuration": { + "type": { + "$ref": "#/46" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Key", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "KmsKeyId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MeasureNameColumn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MixedMeasureMapping", + "properties": { + "MeasureName": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "MeasureValueType": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "MultiMeasureAttributeMappings": { + "type": { + "$ref": "#/63" + }, + "flags": 0 + }, + "SourceColumn": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "TargetMeasureName": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "MixedMeasureMappingMeasureName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MixedMeasureMappingMeasureValueType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MixedMeasureMappingSourceColumn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MixedMeasureMappingTargetMeasureName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MixedMeasureMappings", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MultiMeasureAttributeMapping", + "properties": { + "MeasureValueType": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "SourceColumn": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "TargetMultiMeasureAttributeName": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "MultiMeasureAttributeMappingList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MultiMeasureAttributeMappingMeasureValueType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MultiMeasureAttributeMappingSourceColumn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MultiMeasureMappings", + "properties": { + "MultiMeasureAttributeMappings": { + "type": { + "$ref": "#/66" + }, + "flags": 1 + }, + "TargetMultiMeasureName": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "NotificationConfiguration", + "properties": { + "SnsConfiguration": { + "type": { + "$ref": "#/51" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ObjectKeyPrefix", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "QueryString", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "S3Configuration", + "properties": { + "BucketName": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "EncryptionOption": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "ObjectKeyPrefix": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ScheduleConfiguration", + "properties": { + "ScheduleExpression": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ScheduleExpression", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ScheduledQueryExecutionRoleArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ScheduledQueryName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SnsConfiguration", + "properties": { + "TopicArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TableName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Tags", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TargetConfiguration", + "properties": { + "TimestreamConfiguration": { + "type": { + "$ref": "#/59" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TargetMultiMeasureAttributeName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TargetMultiMeasureName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TimeColumn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TimestreamConfiguration", + "properties": { + "DatabaseName": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "DimensionMappings": { + "type": { + "$ref": "#/68" + }, + "flags": 1 + }, + "MeasureNameColumn": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "MixedMeasureMappings": { + "type": { + "$ref": "#/69" + }, + "flags": 0 + }, + "MultiMeasureMappings": { + "type": { + "$ref": "#/42" + }, + "flags": 0 + }, + "TableName": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "TimeColumn": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TopicArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Value", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/23" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/38" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/32" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/38" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/38" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/53" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/23" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/32" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Timestream/ScheduledQueryProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/53" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Timestream/ScheduledQueryProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 18 + }, + "ClientToken": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "ErrorReportConfiguration": { + "type": { + "$ref": "#/28" + }, + "flags": 1 + }, + "KmsKeyId": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "NotificationConfiguration": { + "type": { + "$ref": "#/43" + }, + "flags": 1 + }, + "QueryString": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "SQErrorReportConfiguration": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results." + }, + "SQKmsKeyId": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The Amazon KMS key used to encrypt the scheduled query resource, at-rest. If the Amazon KMS key is not specified, the scheduled query resource will be encrypted with a Timestream owned Amazon KMS key. To specify a KMS key, use the key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix the name with alias/. If ErrorReportConfiguration uses SSE_KMS as encryption type, the same KmsKeyId is used to encrypt the error report at rest." + }, + "SQName": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The name of the scheduled query. Scheduled query names must be unique within each Region." + }, + "SQNotificationConfiguration": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "Notification configuration for the scheduled query. A notification is sent by Timestream when a query run finishes, when the state is updated or when you delete it." + }, + "SQQueryString": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The query string to run. Parameter names can be specified in the query string @ character followed by an identifier. The named Parameter @scheduled_runtime is reserved and can be used in the query to get the time at which the query is scheduled to run. The timestamp calculated according to the ScheduleConfiguration parameter, will be the value of @scheduled_runtime paramater for each query run. For example, consider an instance of a scheduled query executing on 2021-12-01 00:00:00. For this instance, the @scheduled_runtime parameter is initialized to the timestamp 2021-12-01 00:00:00 when invoking the query." + }, + "SQScheduleConfiguration": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "Configuration for when the scheduled query is executed." + }, + "SQScheduledQueryExecutionRoleArn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The ARN for the IAM role that Timestream will assume when running the scheduled query." + }, + "SQTargetConfiguration": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "Configuration of target store where scheduled query results are written to." + }, + "ScheduleConfiguration": { + "type": { + "$ref": "#/47" + }, + "flags": 1 + }, + "ScheduledQueryExecutionRoleArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "ScheduledQueryName": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/71" + }, + "flags": 0 + }, + "TargetConfiguration": { + "type": { + "$ref": "#/55" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Timestream/ScheduledQuery", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/72" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Timestream/ScheduledQuery@default", + "scopeType": 0, + "body": { + "$ref": "#/73" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "PartitionKey", + "properties": { + "EnforcementInRecord": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "PartitionKeyEnforcementLevel", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PartitionKeyList", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PartitionKeyType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SchemaName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/75" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Timestream/TableProperties" + }, + { + "$type": "ObjectType", + "name": "Table_MagneticStoreWriteProperties_MagneticStoreRejectedDataLocation_S3Configuration", + "properties": { + "BucketName": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The bucket name used to store the data." + }, + "EncryptionOption": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Either SSE_KMS or SSE_S3." + }, + "KmsKeyId": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Must be provided if SSE_KMS is specified as the encryption option" + }, + "ObjectKeyPrefix": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "String used to prefix all data in the bucket." + } + } + }, + { + "$type": "ObjectType", + "name": "Table_MagneticStoreWriteProperties_MagneticStoreRejectedDataLocation", + "properties": { + "S3Configuration": { + "type": { + "$ref": "#/83" + }, + "flags": 0, + "description": "S3 configuration for location to store rejections from magnetic store writes" + } + } + }, + { + "$type": "ObjectType", + "name": "Table_MagneticStoreWriteProperties", + "properties": { + "EnableMagneticStoreWrites": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "Boolean flag indicating whether magnetic store writes are enabled." + }, + "MagneticStoreRejectedDataLocation": { + "type": { + "$ref": "#/84" + }, + "flags": 0, + "description": "Location to store information about records that were asynchronously rejected during magnetic store writes." + } + } + }, + { + "$type": "ObjectType", + "name": "Table_RetentionProperties", + "properties": { + "MagneticStoreRetentionPeriodInDays": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The duration for which data must be stored in the magnetic store." + }, + "MemoryStoreRetentionPeriodInHours": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The duration for which data must be stored in the memory store." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/75" + } + }, + { + "$type": "ObjectType", + "name": "Table_Schema", + "properties": { + "CompositePartitionKey": { + "type": { + "$ref": "#/87" + }, + "flags": 0 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/80" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Timestream/TableProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "DatabaseName": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "The name for the database which the table to be created belongs to." + }, + "MagneticStoreWriteProperties": { + "type": { + "$ref": "#/85" + }, + "flags": 0, + "description": "The properties that determine whether magnetic store writes are enabled." + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "The table name exposed as a read-only attribute." + }, + "RetentionProperties": { + "type": { + "$ref": "#/86" + }, + "flags": 0, + "description": "The retention duration of the memory store and the magnetic store." + }, + "Schema": { + "type": { + "$ref": "#/88" + }, + "flags": 0, + "description": "A Schema specifies the expected data model of the table." + }, + "TableName": { + "type": { + "$ref": "#/1" + }, + "flags": 16, + "description": "The name for the table. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the table name." + }, + "Tags": { + "type": { + "$ref": "#/89" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Timestream/Table", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/90" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Timestream/Table@default", + "scopeType": 0, + "body": { + "$ref": "#/91" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.timestream/default/types.md b/artifacts/bicep/aws/aws.timestream/default/types.md index a12f42f3..9d443fa4 100644 --- a/artifacts/bicep/aws/aws.timestream/default/types.md +++ b/artifacts/bicep/aws/aws.timestream/default/types.md @@ -3,23 +3,30 @@ ## Resource AWS.Timestream/Database@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Timestream/DatabaseProperties](#awstimestreamdatabaseproperties): properties of the resource +* **properties**: [AWS.Timestream/DatabaseProperties](#awstimestreamdatabaseproperties) (Identifier): properties of the resource + +## Resource AWS.Timestream/InfluxDBInstance@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.Timestream/InfluxDBInstanceProperties](#awstimestreaminfluxdbinstanceproperties) (Identifier): properties of the resource ## Resource AWS.Timestream/ScheduledQuery@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Timestream/ScheduledQueryProperties](#awstimestreamscheduledqueryproperties) (Required): properties of the resource +* **properties**: [AWS.Timestream/ScheduledQueryProperties](#awstimestreamscheduledqueryproperties) (Required, Identifier): properties of the resource ## Resource AWS.Timestream/Table@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Timestream/TableProperties](#awstimestreamtableproperties) (Required): properties of the resource +* **properties**: [AWS.Timestream/TableProperties](#awstimestreamtableproperties) (Required, Identifier): properties of the resource ## AWS.Timestream/DatabaseProperties ### Properties @@ -28,10 +35,30 @@ * **KmsKeyId**: string: The KMS key for the database. If the KMS key is not specified, the database will be encrypted with a Timestream managed KMS key located in your account. * **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. -## Tag -### Properties -* **Key**: string -* **Value**: string +## AWS.Timestream/InfluxDBInstanceProperties +### Properties +* **AllocatedStorage**: int: The allocated storage for the InfluxDB instance. +* **Arn**: string (ReadOnly): The Amazon Resource Name (ARN) that is associated with the InfluxDB instance. +* **AvailabilityZone**: string (ReadOnly): The Availability Zone (AZ) where the InfluxDB instance is created. +* **Bucket**: string (WriteOnly): The bucket for the InfluxDB instance. +* **DbInstanceType**: string: The compute instance of the InfluxDB instance. +* **DbParameterGroupIdentifier**: string: The name of an existing InfluxDB parameter group. +* **DbStorageType**: string: The storage type of the InfluxDB instance. +* **DeploymentType**: string: Deployment type of the InfluxDB Instance. +* **Endpoint**: string (ReadOnly): The connection endpoint for the InfluxDB instance. +* **Id**: string (ReadOnly, Identifier): The service generated unique identifier for InfluxDB instance. +* **InfluxAuthParametersSecretArn**: string (ReadOnly): The Auth parameters secret Amazon Resource name (ARN) that is associated with the InfluxDB instance. +* **LogDeliveryConfiguration**: [InfluxDBInstance_LogDeliveryConfiguration](#influxdbinstancelogdeliveryconfiguration): Configuration for sending logs to customer account from the InfluxDB instance. +* **Name**: string: The unique name that is associated with the InfluxDB instance. +* **Organization**: string (WriteOnly): The organization for the InfluxDB instance. +* **Password**: string (WriteOnly): The password for the InfluxDB instance. +* **PubliclyAccessible**: bool: Attach a public IP to the customer ENI. +* **SecondaryAvailabilityZone**: string (ReadOnly): The Secondary Availability Zone (AZ) where the InfluxDB instance is created, if DeploymentType is set as WITH_MULTIAZ_STANDBY. +* **Status**: string (ReadOnly): Status of the InfluxDB Instance. +* **Tags**: [Tag](#tag)[]: An arbitrary set of tags (key-value pairs) for this DB instance. +* **Username**: string (WriteOnly): The username for the InfluxDB instance. +* **VpcSecurityGroupIds**: string[]: A list of Amazon EC2 VPC security groups to associate with this InfluxDB instance. +* **VpcSubnetIds**: string[]: A list of EC2 subnet IDs for this InfluxDB instance. ## AWS.Timestream/ScheduledQueryProperties ### Properties @@ -55,51 +82,34 @@ * **Tags**: [Tag](#tag)[] * **TargetConfiguration**: [TargetConfiguration](#targetconfiguration) -## ErrorReportConfiguration -### Properties -* **S3Configuration**: [S3Configuration](#s3configuration) (Required) - -## S3Configuration -### Properties -* **BucketName**: string (Required) -* **EncryptionOption**: string -* **ObjectKeyPrefix**: string - -## NotificationConfiguration -### Properties -* **SnsConfiguration**: [SnsConfiguration](#snsconfiguration) (Required) - -## SnsConfiguration -### Properties -* **TopicArn**: string (Required) - -## ScheduleConfiguration +## AWS.Timestream/TableProperties ### Properties -* **ScheduleExpression**: string (Required) +* **Arn**: string (ReadOnly) +* **DatabaseName**: string (Required, Identifier): The name for the database which the table to be created belongs to. +* **MagneticStoreWriteProperties**: [Table_MagneticStoreWriteProperties](#tablemagneticstorewriteproperties): The properties that determine whether magnetic store writes are enabled. +* **Name**: string (ReadOnly): The table name exposed as a read-only attribute. +* **RetentionProperties**: [Table_RetentionProperties](#tableretentionproperties): The retention duration of the memory store and the magnetic store. +* **Schema**: [Table_Schema](#tableschema): A Schema specifies the expected data model of the table. +* **TableName**: string (Identifier): The name for the table. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the table name. +* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. -## Tag +## DimensionMapping ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **DimensionValueType**: string (Required) +* **Name**: string (Required) -## TargetConfiguration +## ErrorReportConfiguration ### Properties -* **TimestreamConfiguration**: [TimestreamConfiguration](#timestreamconfiguration) (Required) +* **S3Configuration**: [S3Configuration](#s3configuration) (Required) -## TimestreamConfiguration +## InfluxDBInstance_LogDeliveryConfiguration ### Properties -* **DatabaseName**: string (Required) -* **DimensionMappings**: [DimensionMapping](#dimensionmapping)[] (Required) -* **MeasureNameColumn**: string -* **MixedMeasureMappings**: [MixedMeasureMapping](#mixedmeasuremapping)[] -* **MultiMeasureMappings**: [MultiMeasureMappings](#multimeasuremappings) -* **TableName**: string (Required) -* **TimeColumn**: string (Required) +* **S3Configuration**: [InfluxDBInstance_LogDeliveryConfiguration_S3Configuration](#influxdbinstancelogdeliveryconfigurations3configuration) (Required): S3 configuration for sending logs to customer account from the InfluxDB instance. -## DimensionMapping +## InfluxDBInstance_LogDeliveryConfiguration_S3Configuration ### Properties -* **DimensionValueType**: string (Required) -* **Name**: string (Required) +* **BucketName**: string (Required): The bucket name for logs to be sent from the InfluxDB instance +* **Enabled**: bool (Required): Specifies whether logging to customer specified bucket is enabled. ## MixedMeasureMapping ### Properties @@ -120,16 +130,29 @@ * **MultiMeasureAttributeMappings**: [MultiMeasureAttributeMapping](#multimeasureattributemapping)[] (Required) * **TargetMultiMeasureName**: string -## AWS.Timestream/TableProperties +## NotificationConfiguration ### Properties -* **Arn**: string (ReadOnly) -* **DatabaseName**: string (Required, Identifier): The name for the database which the table to be created belongs to. -* **MagneticStoreWriteProperties**: [Table_MagneticStoreWriteProperties](#tablemagneticstorewriteproperties): The properties that determine whether magnetic store writes are enabled. -* **Name**: string (ReadOnly): The table name exposed as a read-only attribute. -* **RetentionProperties**: [Table_RetentionProperties](#tableretentionproperties): The retention duration of the memory store and the magnetic store. -* **Schema**: [Table_Schema](#tableschema): A Schema specifies the expected data model of the table. -* **TableName**: string (Identifier): The name for the table. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the table name. -* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. +* **SnsConfiguration**: [SnsConfiguration](#snsconfiguration) (Required) + +## PartitionKey +### Properties +* **EnforcementInRecord**: string +* **Name**: string +* **Type**: string (Required) + +## S3Configuration +### Properties +* **BucketName**: string (Required) +* **EncryptionOption**: string +* **ObjectKeyPrefix**: string + +## ScheduleConfiguration +### Properties +* **ScheduleExpression**: string (Required) + +## SnsConfiguration +### Properties +* **TopicArn**: string (Required) ## Table_MagneticStoreWriteProperties ### Properties @@ -156,14 +179,37 @@ ### Properties * **CompositePartitionKey**: [PartitionKey](#partitionkey)[] -## PartitionKey +## Tag ### Properties -* **EnforcementInRecord**: string -* **Name**: string -* **Type**: string (Required) +* **Key**: string +* **Value**: string + +## Tag +### Properties +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) ## Tag ### Properties * **Key**: string * **Value**: string +## TargetConfiguration +### Properties +* **TimestreamConfiguration**: [TimestreamConfiguration](#timestreamconfiguration) (Required) + +## TimestreamConfiguration +### Properties +* **DatabaseName**: string (Required) +* **DimensionMappings**: [DimensionMapping](#dimensionmapping)[] (Required) +* **MeasureNameColumn**: string +* **MixedMeasureMappings**: [MixedMeasureMapping](#mixedmeasuremapping)[] +* **MultiMeasureMappings**: [MultiMeasureMappings](#multimeasuremappings) +* **TableName**: string (Required) +* **TimeColumn**: string (Required) + diff --git a/artifacts/bicep/aws/aws.transfer/default/types.json b/artifacts/bicep/aws/aws.transfer/default/types.json index a453fa26..9f144696 100644 --- a/artifacts/bicep/aws/aws.transfer/default/types.json +++ b/artifacts/bicep/aws/aws.transfer/default/types.json @@ -1 +1,1123 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The name assigned to the tag that you create."},"Value":{"Type":4,"Flags":1,"Description":"Contains one or more values that you assigned to the key name you create."}}}},{"2":{"Name":"AWS.Transfer/AgreementProperties","Properties":{"AccessRole":{"Type":4,"Flags":1,"Description":"Specifies the access role for the agreement."},"AgreementId":{"Type":4,"Flags":18,"Description":"A unique identifier for the agreement."},"Arn":{"Type":4,"Flags":2,"Description":"Specifies the unique Amazon Resource Name (ARN) for the agreement."},"BaseDirectory":{"Type":4,"Flags":1,"Description":"Specifies the base directory for the agreement."},"Description":{"Type":4,"Flags":0,"Description":"A textual description for the agreement."},"LocalProfileId":{"Type":4,"Flags":1,"Description":"A unique identifier for the local profile."},"PartnerProfileId":{"Type":4,"Flags":1,"Description":"A unique identifier for the partner profile."},"ServerId":{"Type":4,"Flags":17,"Description":"A unique identifier for the server."},"Status":{"Type":4,"Flags":0,"Description":"Specifies the status of the agreement."},"Tags":{"Type":10,"Flags":0,"Description":"Key-value pairs that can be used to group and search for agreements. Tags are metadata attached to agreements for any purpose."}}}},{"3":{"ItemType":8}},{"2":{"Name":"AWS.Transfer/Agreement","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":9,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Transfer/Agreement@default","ScopeType":0,"Body":11}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"2":{"Name":"AWS.Transfer/CertificateProperties","Properties":{"ActiveDate":{"Type":4,"Flags":0,"Description":"Specifies the active date for the certificate."},"Arn":{"Type":4,"Flags":2,"Description":"Specifies the unique Amazon Resource Name (ARN) for the agreement."},"Certificate":{"Type":4,"Flags":1,"Description":"Specifies the certificate body to be imported."},"CertificateChain":{"Type":4,"Flags":0,"Description":"Specifies the certificate chain to be imported."},"CertificateId":{"Type":4,"Flags":18,"Description":"A unique identifier for the certificate."},"Description":{"Type":4,"Flags":0,"Description":"A textual description for the certificate."},"InactiveDate":{"Type":4,"Flags":0,"Description":"Specifies the inactive date for the certificate."},"NotAfterDate":{"Type":4,"Flags":2,"Description":"Specifies the not after date for the certificate."},"NotBeforeDate":{"Type":4,"Flags":2,"Description":"Specifies the not before date for the certificate."},"PrivateKey":{"Type":4,"Flags":4,"Description":"Specifies the private key for the certificate."},"Serial":{"Type":4,"Flags":2,"Description":"Specifies Certificate's serial."},"Status":{"Type":4,"Flags":2,"Description":"A status description for the certificate."},"Tags":{"Type":15,"Flags":0,"Description":"Key-value pairs that can be used to group and search for certificates. Tags are metadata attached to certificates for any purpose."},"Type":{"Type":4,"Flags":2,"Description":"Describing the type of certificate. With or without a private key."},"Usage":{"Type":4,"Flags":1,"Description":"Specifies the usage type for the certificate."}}}},{"3":{"ItemType":13}},{"2":{"Name":"AWS.Transfer/Certificate","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":14,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Transfer/Certificate@default","ScopeType":0,"Body":16}},{"2":{"Name":"SftpConnectorTrustedHostKey"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The name assigned to the tag that you create."},"Value":{"Type":4,"Flags":1,"Description":"Contains one or more values that you assigned to the key name you create."}}}},{"2":{"Name":"AWS.Transfer/ConnectorProperties","Properties":{"AccessRole":{"Type":4,"Flags":1,"Description":"Specifies the access role for the connector."},"Arn":{"Type":4,"Flags":2,"Description":"Specifies the unique Amazon Resource Name (ARN) for the connector."},"As2Config":{"Type":21,"Flags":0,"Description":"Configuration for an AS2 connector."},"ConnectorId":{"Type":4,"Flags":18,"Description":"A unique identifier for the connector."},"LoggingRole":{"Type":4,"Flags":0,"Description":"Specifies the logging role for the connector."},"SftpConfig":{"Type":23,"Flags":0,"Description":"Configuration for an SFTP connector."},"Tags":{"Type":24,"Flags":0,"Description":"Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors for any purpose."},"Url":{"Type":4,"Flags":1,"Description":"URL for Connector"}}}},{"2":{"Name":"Connector_As2Config","Properties":{"BasicAuthSecretId":{"Type":4,"Flags":0,"Description":"ARN or name of the secret in AWS Secrets Manager which contains the credentials for Basic authentication. If empty, Basic authentication is disabled for the AS2 connector"},"Compression":{"Type":4,"Flags":0,"Description":"Compression setting for this AS2 connector configuration."},"EncryptionAlgorithm":{"Type":4,"Flags":0,"Description":"Encryption algorithm for this AS2 connector configuration."},"LocalProfileId":{"Type":4,"Flags":0,"Description":"A unique identifier for the local profile."},"MdnResponse":{"Type":4,"Flags":0,"Description":"MDN Response setting for this AS2 connector configuration."},"MdnSigningAlgorithm":{"Type":4,"Flags":0,"Description":"MDN Signing algorithm for this AS2 connector configuration."},"MessageSubject":{"Type":4,"Flags":0,"Description":"The message subject for this AS2 connector configuration."},"PartnerProfileId":{"Type":4,"Flags":0,"Description":"A unique identifier for the partner profile."},"SigningAlgorithm":{"Type":4,"Flags":0,"Description":"Signing algorithm for this AS2 connector configuration."}}}},{"3":{"ItemType":4}},{"2":{"Name":"Connector_SftpConfig","Properties":{"TrustedHostKeys":{"Type":22,"Flags":0,"Description":"List of public host keys, for the external server to which you are connecting."},"UserSecretId":{"Type":4,"Flags":0,"Description":"ARN or name of the secret in AWS Secrets Manager which contains the SFTP user's private keys or passwords."}}}},{"3":{"ItemType":19}},{"2":{"Name":"AWS.Transfer/Connector","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":20,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Transfer/Connector@default","ScopeType":0,"Body":25}},{"2":{"Name":"CertificateId"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The name assigned to the tag that you create."},"Value":{"Type":4,"Flags":1,"Description":"Contains one or more values that you assigned to the key name you create."}}}},{"2":{"Name":"AWS.Transfer/ProfileProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"Specifies the unique Amazon Resource Name (ARN) for the profile."},"As2Id":{"Type":4,"Flags":1,"Description":"AS2 identifier agreed with a trading partner."},"CertificateIds":{"Type":30,"Flags":0,"Description":"List of the certificate IDs associated with this profile to be used for encryption and signing of AS2 messages."},"ProfileId":{"Type":4,"Flags":18,"Description":"A unique identifier for the profile"},"ProfileType":{"Type":4,"Flags":1,"Description":"Enum specifying whether the profile is local or associated with a trading partner."},"Tags":{"Type":31,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":28}},{"2":{"Name":"AWS.Transfer/Profile","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":29,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Transfer/Profile@default","ScopeType":0,"Body":32}},{"2":{"Name":"EfsInputFileLocation","Properties":{"FileSystemId":{"Type":4,"Flags":0,"Description":"Specifies the EFS filesystem that contains the file."},"Path":{"Type":4,"Flags":0,"Description":"The name assigned to the file when it was created in EFS. You use the object path to retrieve the object."}}}},{"2":{"Name":"InputFileLocation","Properties":{"EfsFileLocation":{"Type":34,"Flags":0},"S3FileLocation":{"Type":37,"Flags":0}}}},{"2":{"Name":"S3FileLocation","Properties":{"S3FileLocation":{"Type":37,"Flags":0}}}},{"2":{"Name":"S3InputFileLocation","Properties":{"Bucket":{"Type":4,"Flags":0,"Description":"Specifies the S3 bucket that contains the file."},"Key":{"Type":4,"Flags":0,"Description":"The name assigned to the file when it was created in S3. You use the object key to retrieve the object."}}}},{"2":{"Name":"S3Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The name assigned to the tag that you create."},"Value":{"Type":4,"Flags":1,"Description":"The value that corresponds to the key."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The name assigned to the tag that you create."},"Value":{"Type":4,"Flags":1,"Description":"Contains one or more values that you assigned to the key name you create."}}}},{"2":{"Name":"WorkflowStep","Properties":{"CopyStepDetails":{"Type":41,"Flags":0,"Description":"Details for a step that performs a file copy."},"CustomStepDetails":{"Type":42,"Flags":0,"Description":"Details for a step that invokes a lambda function."},"DecryptStepDetails":{"Type":43,"Flags":0,"Description":"Details for a step that performs a file decryption."},"DeleteStepDetails":{"Type":44,"Flags":0,"Description":"Details for a step that deletes the file."},"TagStepDetails":{"Type":46,"Flags":0,"Description":"Details for a step that creates one or more tags."},"Type":{"Type":4,"Flags":0}}}},{"2":{"Name":"Workflow_CopyStepDetails","Properties":{"DestinationFileLocation":{"Type":36,"Flags":0},"Name":{"Type":4,"Flags":0,"Description":"The name of the step, used as an identifier."},"OverwriteExisting":{"Type":4,"Flags":0,"Description":"A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE."},"SourceFileLocation":{"Type":4,"Flags":0,"Description":"Specifies which file to use as input to the workflow step."}}}},{"2":{"Name":"Workflow_CustomStepDetails","Properties":{"Name":{"Type":4,"Flags":0,"Description":"The name of the step, used as an identifier."},"SourceFileLocation":{"Type":4,"Flags":0,"Description":"Specifies which file to use as input to the workflow step."},"Target":{"Type":4,"Flags":0,"Description":"The ARN for the lambda function that is being called."},"TimeoutSeconds":{"Type":3,"Flags":0,"Description":"Timeout, in seconds, for the step."}}}},{"2":{"Name":"Workflow_DecryptStepDetails","Properties":{"DestinationFileLocation":{"Type":35,"Flags":0},"Name":{"Type":4,"Flags":0,"Description":"The name of the step, used as an identifier."},"OverwriteExisting":{"Type":4,"Flags":0,"Description":"A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE."},"SourceFileLocation":{"Type":4,"Flags":0,"Description":"Specifies which file to use as input to the workflow step."},"Type":{"Type":4,"Flags":0,"Description":"Specifies which encryption method to use."}}}},{"2":{"Name":"Workflow_DeleteStepDetails","Properties":{"Name":{"Type":4,"Flags":0,"Description":"The name of the step, used as an identifier."},"SourceFileLocation":{"Type":4,"Flags":0,"Description":"Specifies which file to use as input to the workflow step."}}}},{"3":{"ItemType":38}},{"2":{"Name":"Workflow_TagStepDetails","Properties":{"Name":{"Type":4,"Flags":0,"Description":"The name of the step, used as an identifier."},"SourceFileLocation":{"Type":4,"Flags":0,"Description":"Specifies which file to use as input to the workflow step."},"Tags":{"Type":45,"Flags":0,"Description":"Array that contains from 1 to 10 key/value pairs."}}}},{"2":{"Name":"AWS.Transfer/WorkflowProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"Specifies the unique Amazon Resource Name (ARN) for the workflow."},"Description":{"Type":4,"Flags":0,"Description":"A textual description for the workflow."},"OnExceptionSteps":{"Type":48,"Flags":0,"Description":"Specifies the steps (actions) to take if any errors are encountered during execution of the workflow."},"Steps":{"Type":49,"Flags":1,"Description":"Specifies the details for the steps that are in the specified workflow."},"Tags":{"Type":50,"Flags":0,"Description":"Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose."},"WorkflowId":{"Type":4,"Flags":18,"Description":"A unique identifier for the workflow."}}}},{"3":{"ItemType":40}},{"3":{"ItemType":40}},{"3":{"ItemType":39}},{"2":{"Name":"AWS.Transfer/Workflow","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":47,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Transfer/Workflow@default","ScopeType":0,"Body":51}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The name assigned to the tag that you create." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Contains one or more values that you assigned to the key name you create." + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.Transfer/AgreementProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Transfer/AgreementProperties", + "properties": { + "AccessRole": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Specifies the access role for the agreement." + }, + "AgreementId": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "A unique identifier for the agreement." + }, + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "Specifies the unique Amazon Resource Name (ARN) for the agreement." + }, + "BaseDirectory": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Specifies the base directory for the agreement." + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A textual description for the agreement." + }, + "LocalProfileId": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "A unique identifier for the local profile." + }, + "PartnerProfileId": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "A unique identifier for the partner profile." + }, + "ServerId": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "A unique identifier for the server." + }, + "Status": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Specifies the status of the agreement." + }, + "Tags": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "Key-value pairs that can be used to group and search for agreements. Tags are metadata attached to agreements for any purpose." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Transfer/Agreement", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Transfer/Agreement@default", + "scopeType": 0, + "body": { + "$ref": "#/5" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Transfer/CertificateProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/7" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Transfer/CertificateProperties", + "properties": { + "ActiveDate": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Specifies the active date for the certificate." + }, + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "Specifies the unique Amazon Resource Name (ARN) for the agreement." + }, + "Certificate": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Specifies the certificate body to be imported." + }, + "CertificateChain": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Specifies the certificate chain to be imported." + }, + "CertificateId": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "A unique identifier for the certificate." + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A textual description for the certificate." + }, + "InactiveDate": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Specifies the inactive date for the certificate." + }, + "NotAfterDate": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "Specifies the not after date for the certificate." + }, + "NotBeforeDate": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "Specifies the not before date for the certificate." + }, + "PrivateKey": { + "type": { + "$ref": "#/1" + }, + "flags": 4, + "description": "Specifies the private key for the certificate." + }, + "Serial": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "Specifies Certificate's serial." + }, + "Status": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "A status description for the certificate." + }, + "Tags": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "Key-value pairs that can be used to group and search for certificates. Tags are metadata attached to certificates for any purpose." + }, + "Type": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "Describing the type of certificate. With or without a private key." + }, + "Usage": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Specifies the usage type for the certificate." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Transfer/Certificate", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/10" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Transfer/Certificate@default", + "scopeType": 0, + "body": { + "$ref": "#/11" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "SftpConnectorTrustedHostKey", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The name assigned to the tag that you create." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Contains one or more values that you assigned to the key name you create." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Transfer/ConnectorProperties" + }, + { + "$type": "ObjectType", + "name": "Connector_As2Config", + "properties": { + "BasicAuthSecretId": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "ARN or name of the secret in AWS Secrets Manager which contains the credentials for Basic authentication. If empty, Basic authentication is disabled for the AS2 connector" + }, + "Compression": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Compression setting for this AS2 connector configuration." + }, + "EncryptionAlgorithm": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Encryption algorithm for this AS2 connector configuration." + }, + "LocalProfileId": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A unique identifier for the local profile." + }, + "MdnResponse": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "MDN Response setting for this AS2 connector configuration." + }, + "MdnSigningAlgorithm": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "MDN Signing algorithm for this AS2 connector configuration." + }, + "MessageSubject": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The message subject for this AS2 connector configuration." + }, + "PartnerProfileId": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A unique identifier for the partner profile." + }, + "SigningAlgorithm": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Signing algorithm for this AS2 connector configuration." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "Connector_SftpConfig", + "properties": { + "TrustedHostKeys": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "List of public host keys, for the external server to which you are connecting." + }, + "UserSecretId": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "ARN or name of the secret in AWS Secrets Manager which contains the SFTP user's private keys or passwords." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/14" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Transfer/ConnectorProperties", + "properties": { + "AccessRole": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Specifies the access role for the connector." + }, + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "Specifies the unique Amazon Resource Name (ARN) for the connector." + }, + "As2Config": { + "type": { + "$ref": "#/16" + }, + "flags": 0, + "description": "Configuration for an AS2 connector." + }, + "ConnectorId": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "A unique identifier for the connector." + }, + "LoggingRole": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Specifies the logging role for the connector." + }, + "SecurityPolicyName": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Security policy for SFTP Connector" + }, + "ServiceManagedEgressIpAddresses": { + "type": { + "$ref": "#/17" + }, + "flags": 2, + "description": "The list of egress IP addresses of this connector. These IP addresses are assigned automatically when you create the connector." + }, + "SftpConfig": { + "type": { + "$ref": "#/19" + }, + "flags": 0, + "description": "Configuration for an SFTP connector." + }, + "Tags": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors for any purpose." + }, + "Url": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "URL for Connector" + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Transfer/Connector", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/21" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Transfer/Connector@default", + "scopeType": 0, + "body": { + "$ref": "#/22" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "CertificateId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The name assigned to the tag that you create." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Contains one or more values that you assigned to the key name you create." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Transfer/ProfileProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/25" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Transfer/ProfileProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "Specifies the unique Amazon Resource Name (ARN) for the profile." + }, + "As2Id": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "AS2 identifier agreed with a trading partner." + }, + "CertificateIds": { + "type": { + "$ref": "#/27" + }, + "flags": 0, + "description": "List of the certificate IDs associated with this profile to be used for encryption and signing of AS2 messages." + }, + "ProfileId": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "A unique identifier for the profile" + }, + "ProfileType": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Enum specifying whether the profile is local or associated with a trading partner." + }, + "Tags": { + "type": { + "$ref": "#/28" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Transfer/Profile", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/29" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Transfer/Profile@default", + "scopeType": 0, + "body": { + "$ref": "#/30" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "EfsInputFileLocation", + "properties": { + "FileSystemId": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Specifies the EFS filesystem that contains the file." + }, + "Path": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The name assigned to the file when it was created in EFS. You use the object path to retrieve the object." + } + } + }, + { + "$type": "ObjectType", + "name": "InputFileLocation", + "properties": { + "EfsFileLocation": { + "type": { + "$ref": "#/32" + }, + "flags": 0 + }, + "S3FileLocation": { + "type": { + "$ref": "#/35" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "S3FileLocation", + "properties": { + "S3FileLocation": { + "type": { + "$ref": "#/35" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "S3InputFileLocation", + "properties": { + "Bucket": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Specifies the S3 bucket that contains the file." + }, + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The name assigned to the file when it was created in S3. You use the object key to retrieve the object." + } + } + }, + { + "$type": "ObjectType", + "name": "S3Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The name assigned to the tag that you create." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The value that corresponds to the key." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "The name assigned to the tag that you create." + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Contains one or more values that you assigned to the key name you create." + } + } + }, + { + "$type": "ObjectType", + "name": "WorkflowStep", + "properties": { + "CopyStepDetails": { + "type": { + "$ref": "#/39" + }, + "flags": 0, + "description": "Details for a step that performs a file copy." + }, + "CustomStepDetails": { + "type": { + "$ref": "#/41" + }, + "flags": 0, + "description": "Details for a step that invokes a lambda function." + }, + "DecryptStepDetails": { + "type": { + "$ref": "#/42" + }, + "flags": 0, + "description": "Details for a step that performs a file decryption." + }, + "DeleteStepDetails": { + "type": { + "$ref": "#/43" + }, + "flags": 0, + "description": "Details for a step that deletes the file." + }, + "TagStepDetails": { + "type": { + "$ref": "#/45" + }, + "flags": 0, + "description": "Details for a step that creates one or more tags." + }, + "Type": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Workflow_CopyStepDetails", + "properties": { + "DestinationFileLocation": { + "type": { + "$ref": "#/34" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The name of the step, used as an identifier." + }, + "OverwriteExisting": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE." + }, + "SourceFileLocation": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Specifies which file to use as input to the workflow step." + } + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "ObjectType", + "name": "Workflow_CustomStepDetails", + "properties": { + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The name of the step, used as an identifier." + }, + "SourceFileLocation": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Specifies which file to use as input to the workflow step." + }, + "Target": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The ARN for the lambda function that is being called." + }, + "TimeoutSeconds": { + "type": { + "$ref": "#/40" + }, + "flags": 0, + "description": "Timeout, in seconds, for the step." + } + } + }, + { + "$type": "ObjectType", + "name": "Workflow_DecryptStepDetails", + "properties": { + "DestinationFileLocation": { + "type": { + "$ref": "#/33" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The name of the step, used as an identifier." + }, + "OverwriteExisting": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE." + }, + "SourceFileLocation": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Specifies which file to use as input to the workflow step." + }, + "Type": { + "type": { + "$ref": "#/1" + }, + "flags": 1, + "description": "Specifies which encryption method to use." + } + } + }, + { + "$type": "ObjectType", + "name": "Workflow_DeleteStepDetails", + "properties": { + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The name of the step, used as an identifier." + }, + "SourceFileLocation": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Specifies which file to use as input to the workflow step." + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/36" + } + }, + { + "$type": "ObjectType", + "name": "Workflow_TagStepDetails", + "properties": { + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "The name of the step, used as an identifier." + }, + "SourceFileLocation": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "Specifies which file to use as input to the workflow step." + }, + "Tags": { + "type": { + "$ref": "#/44" + }, + "flags": 0, + "description": "Array that contains from 1 to 10 key/value pairs." + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Transfer/WorkflowProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/38" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/38" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/37" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Transfer/WorkflowProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 2, + "description": "Specifies the unique Amazon Resource Name (ARN) for the workflow." + }, + "Description": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "A textual description for the workflow." + }, + "OnExceptionSteps": { + "type": { + "$ref": "#/47" + }, + "flags": 0, + "description": "Specifies the steps (actions) to take if any errors are encountered during execution of the workflow." + }, + "Steps": { + "type": { + "$ref": "#/48" + }, + "flags": 1, + "description": "Specifies the details for the steps that are in the specified workflow." + }, + "Tags": { + "type": { + "$ref": "#/49" + }, + "flags": 0, + "description": "Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose." + }, + "WorkflowId": { + "type": { + "$ref": "#/1" + }, + "flags": 18, + "description": "A unique identifier for the workflow." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Transfer/Workflow", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/50" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Transfer/Workflow@default", + "scopeType": 0, + "body": { + "$ref": "#/51" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.transfer/default/types.md b/artifacts/bicep/aws/aws.transfer/default/types.md index 62fc6259..11312c17 100644 --- a/artifacts/bicep/aws/aws.transfer/default/types.md +++ b/artifacts/bicep/aws/aws.transfer/default/types.md @@ -3,37 +3,37 @@ ## Resource AWS.Transfer/Agreement@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Transfer/AgreementProperties](#awstransferagreementproperties) (Required): properties of the resource +* **properties**: [AWS.Transfer/AgreementProperties](#awstransferagreementproperties) (Required, Identifier): properties of the resource ## Resource AWS.Transfer/Certificate@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Transfer/CertificateProperties](#awstransfercertificateproperties) (Required): properties of the resource +* **properties**: [AWS.Transfer/CertificateProperties](#awstransfercertificateproperties) (Required, Identifier): properties of the resource ## Resource AWS.Transfer/Connector@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Transfer/ConnectorProperties](#awstransferconnectorproperties) (Required): properties of the resource +* **properties**: [AWS.Transfer/ConnectorProperties](#awstransferconnectorproperties) (Required, Identifier): properties of the resource ## Resource AWS.Transfer/Profile@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Transfer/ProfileProperties](#awstransferprofileproperties) (Required): properties of the resource +* **properties**: [AWS.Transfer/ProfileProperties](#awstransferprofileproperties) (Required, Identifier): properties of the resource ## Resource AWS.Transfer/Workflow@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Transfer/WorkflowProperties](#awstransferworkflowproperties) (Required): properties of the resource +* **properties**: [AWS.Transfer/WorkflowProperties](#awstransferworkflowproperties) (Required, Identifier): properties of the resource ## AWS.Transfer/AgreementProperties ### Properties @@ -48,11 +48,6 @@ * **Status**: string: Specifies the status of the agreement. * **Tags**: [Tag](#tag)[]: Key-value pairs that can be used to group and search for agreements. Tags are metadata attached to agreements for any purpose. -## Tag -### Properties -* **Key**: string (Required): The name assigned to the tag that you create. -* **Value**: string (Required): Contains one or more values that you assigned to the key name you create. - ## AWS.Transfer/CertificateProperties ### Properties * **ActiveDate**: string: Specifies the active date for the certificate. @@ -71,11 +66,6 @@ * **Type**: string (ReadOnly): Describing the type of certificate. With or without a private key. * **Usage**: string (Required): Specifies the usage type for the certificate. -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. -* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. - ## AWS.Transfer/ConnectorProperties ### Properties * **AccessRole**: string (Required): Specifies the access role for the connector. @@ -83,10 +73,30 @@ * **As2Config**: [Connector_As2Config](#connectoras2config): Configuration for an AS2 connector. * **ConnectorId**: string (ReadOnly, Identifier): A unique identifier for the connector. * **LoggingRole**: string: Specifies the logging role for the connector. +* **SecurityPolicyName**: string: Security policy for SFTP Connector +* **ServiceManagedEgressIpAddresses**: string[] (ReadOnly): The list of egress IP addresses of this connector. These IP addresses are assigned automatically when you create the connector. * **SftpConfig**: [Connector_SftpConfig](#connectorsftpconfig): Configuration for an SFTP connector. * **Tags**: [Tag](#tag)[]: Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors for any purpose. * **Url**: string (Required): URL for Connector +## AWS.Transfer/ProfileProperties +### Properties +* **Arn**: string (ReadOnly): Specifies the unique Amazon Resource Name (ARN) for the profile. +* **As2Id**: string (Required): AS2 identifier agreed with a trading partner. +* **CertificateIds**: string[]: List of the certificate IDs associated with this profile to be used for encryption and signing of AS2 messages. +* **ProfileId**: string (ReadOnly, Identifier): A unique identifier for the profile +* **ProfileType**: string (Required): Enum specifying whether the profile is local or associated with a trading partner. +* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. + +## AWS.Transfer/WorkflowProperties +### Properties +* **Arn**: string (ReadOnly): Specifies the unique Amazon Resource Name (ARN) for the workflow. +* **Description**: string: A textual description for the workflow. +* **OnExceptionSteps**: [WorkflowStep](#workflowstep)[]: Specifies the steps (actions) to take if any errors are encountered during execution of the workflow. +* **Steps**: [WorkflowStep](#workflowstep)[] (Required): Specifies the details for the steps that are in the specified workflow. +* **Tags**: [Tag](#tag)[]: Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose. +* **WorkflowId**: string (ReadOnly, Identifier): A unique identifier for the workflow. + ## Connector_As2Config ### Properties * **BasicAuthSecretId**: string: ARN or name of the secret in AWS Secrets Manager which contains the credentials for Basic authentication. If empty, Basic authentication is disabled for the AS2 connector @@ -104,42 +114,54 @@ * **TrustedHostKeys**: string[]: List of public host keys, for the external server to which you are connecting. * **UserSecretId**: string: ARN or name of the secret in AWS Secrets Manager which contains the SFTP user's private keys or passwords. +## EfsInputFileLocation +### Properties +* **FileSystemId**: string: Specifies the EFS filesystem that contains the file. +* **Path**: string: The name assigned to the file when it was created in EFS. You use the object path to retrieve the object. + +## InputFileLocation +### Properties +* **EfsFileLocation**: [EfsInputFileLocation](#efsinputfilelocation) +* **S3FileLocation**: [S3InputFileLocation](#s3inputfilelocation) + +## S3FileLocation +### Properties +* **S3FileLocation**: [S3InputFileLocation](#s3inputfilelocation) + +## S3InputFileLocation +### Properties +* **Bucket**: string: Specifies the S3 bucket that contains the file. +* **Key**: string: The name assigned to the file when it was created in S3. You use the object key to retrieve the object. + +## S3Tag +### Properties +* **Key**: string (Required): The name assigned to the tag that you create. +* **Value**: string (Required): The value that corresponds to the key. + ## Tag ### Properties * **Key**: string (Required): The name assigned to the tag that you create. * **Value**: string (Required): Contains one or more values that you assigned to the key name you create. -## AWS.Transfer/ProfileProperties +## Tag ### Properties -* **Arn**: string (ReadOnly): Specifies the unique Amazon Resource Name (ARN) for the profile. -* **As2Id**: string (Required): AS2 identifier agreed with a trading partner. -* **CertificateIds**: string[]: List of the certificate IDs associated with this profile to be used for encryption and signing of AS2 messages. -* **ProfileId**: string (ReadOnly, Identifier): A unique identifier for the profile -* **ProfileType**: string (Required): Enum specifying whether the profile is local or associated with a trading partner. -* **Tags**: [Tag](#tag)[]: An array of key-value pairs to apply to this resource. +* **Key**: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. +* **Value**: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ## Tag ### Properties * **Key**: string (Required): The name assigned to the tag that you create. * **Value**: string (Required): Contains one or more values that you assigned to the key name you create. -## AWS.Transfer/WorkflowProperties +## Tag ### Properties -* **Arn**: string (ReadOnly): Specifies the unique Amazon Resource Name (ARN) for the workflow. -* **Description**: string: A textual description for the workflow. -* **OnExceptionSteps**: [WorkflowStep](#workflowstep)[]: Specifies the steps (actions) to take if any errors are encountered during execution of the workflow. -* **Steps**: [WorkflowStep](#workflowstep)[] (Required): Specifies the details for the steps that are in the specified workflow. -* **Tags**: [Tag](#tag)[]: Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose. -* **WorkflowId**: string (ReadOnly, Identifier): A unique identifier for the workflow. +* **Key**: string (Required): The name assigned to the tag that you create. +* **Value**: string (Required): Contains one or more values that you assigned to the key name you create. -## WorkflowStep +## Tag ### Properties -* **CopyStepDetails**: [Workflow_CopyStepDetails](#workflowcopystepdetails): Details for a step that performs a file copy. -* **CustomStepDetails**: [Workflow_CustomStepDetails](#workflowcustomstepdetails): Details for a step that invokes a lambda function. -* **DecryptStepDetails**: [Workflow_DecryptStepDetails](#workflowdecryptstepdetails): Details for a step that performs a file decryption. -* **DeleteStepDetails**: [Workflow_DeleteStepDetails](#workflowdeletestepdetails): Details for a step that deletes the file. -* **TagStepDetails**: [Workflow_TagStepDetails](#workflowtagstepdetails): Details for a step that creates one or more tags. -* **Type**: string +* **Key**: string (Required): The name assigned to the tag that you create. +* **Value**: string (Required): Contains one or more values that you assigned to the key name you create. ## Workflow_CopyStepDetails ### Properties @@ -148,15 +170,6 @@ * **OverwriteExisting**: string: A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE. * **SourceFileLocation**: string: Specifies which file to use as input to the workflow step. -## S3FileLocation -### Properties -* **S3FileLocation**: [S3InputFileLocation](#s3inputfilelocation) - -## S3InputFileLocation -### Properties -* **Bucket**: string: Specifies the S3 bucket that contains the file. -* **Key**: string: The name assigned to the file when it was created in S3. You use the object key to retrieve the object. - ## Workflow_CustomStepDetails ### Properties * **Name**: string: The name of the step, used as an identifier. @@ -166,21 +179,11 @@ ## Workflow_DecryptStepDetails ### Properties -* **DestinationFileLocation**: [InputFileLocation](#inputfilelocation) +* **DestinationFileLocation**: [InputFileLocation](#inputfilelocation) (Required) * **Name**: string: The name of the step, used as an identifier. * **OverwriteExisting**: string: A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE. * **SourceFileLocation**: string: Specifies which file to use as input to the workflow step. -* **Type**: string: Specifies which encryption method to use. - -## InputFileLocation -### Properties -* **EfsFileLocation**: [EfsInputFileLocation](#efsinputfilelocation) -* **S3FileLocation**: [S3InputFileLocation](#s3inputfilelocation) - -## EfsInputFileLocation -### Properties -* **FileSystemId**: string: Specifies the EFS filesystem that contains the file. -* **Path**: string: The name assigned to the file when it was created in EFS. You use the object path to retrieve the object. +* **Type**: string (Required): Specifies which encryption method to use. ## Workflow_DeleteStepDetails ### Properties @@ -193,13 +196,12 @@ * **SourceFileLocation**: string: Specifies which file to use as input to the workflow step. * **Tags**: [S3Tag](#s3tag)[]: Array that contains from 1 to 10 key/value pairs. -## S3Tag -### Properties -* **Key**: string (Required): The name assigned to the tag that you create. -* **Value**: string (Required): The value that corresponds to the key. - -## Tag +## WorkflowStep ### Properties -* **Key**: string (Required): The name assigned to the tag that you create. -* **Value**: string (Required): Contains one or more values that you assigned to the key name you create. +* **CopyStepDetails**: [Workflow_CopyStepDetails](#workflowcopystepdetails): Details for a step that performs a file copy. +* **CustomStepDetails**: [Workflow_CustomStepDetails](#workflowcustomstepdetails): Details for a step that invokes a lambda function. +* **DecryptStepDetails**: [Workflow_DecryptStepDetails](#workflowdecryptstepdetails): Details for a step that performs a file decryption. +* **DeleteStepDetails**: [Workflow_DeleteStepDetails](#workflowdeletestepdetails): Details for a step that deletes the file. +* **TagStepDetails**: [Workflow_TagStepDetails](#workflowtagstepdetails): Details for a step that creates one or more tags. +* **Type**: string diff --git a/artifacts/bicep/aws/aws.verifiedpermissions/default/types.json b/artifacts/bicep/aws/aws.verifiedpermissions/default/types.json index f178195d..d0f456e3 100644 --- a/artifacts/bicep/aws/aws.verifiedpermissions/default/types.json +++ b/artifacts/bicep/aws/aws.verifiedpermissions/default/types.json @@ -1 +1,595 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"CognitoUserPoolConfiguration","Properties":{"ClientIds":{"Type":12,"Flags":0},"UserPoolArn":{"Type":4,"Flags":1}}}},{"2":{"Name":"IdentitySourceConfiguration","Properties":{"CognitoUserPoolConfiguration":{"Type":8,"Flags":1}}}},{"2":{"Name":"IdentitySourceDetails","Properties":{"ClientIds":{"Type":13,"Flags":0},"DiscoveryUrl":{"Type":4,"Flags":0},"OpenIdIssuer":{"Type":4,"Flags":0},"UserPoolArn":{"Type":4,"Flags":0}}}},{"2":{"Name":"OpenIdIssuer"}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.VerifiedPermissions/IdentitySourceProperties","Properties":{"Configuration":{"Type":9,"Flags":1},"Details":{"Type":10,"Flags":2},"IdentitySourceId":{"Type":4,"Flags":18},"PolicyStoreId":{"Type":4,"Flags":16},"PrincipalEntityType":{"Type":4,"Flags":0}}}},{"2":{"Name":"AWS.VerifiedPermissions/IdentitySource","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":14,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.VerifiedPermissions/IdentitySource@default","ScopeType":0,"Body":15}},{"2":{"Name":"EntityIdentifier","Properties":{"EntityId":{"Type":4,"Flags":1},"EntityType":{"Type":4,"Flags":1}}}},{"2":{"Name":"PolicyDefinition","Properties":{}}},{"2":{"Name":"PolicyType"}},{"2":{"Name":"StaticPolicyDefinition","Properties":{"Description":{"Type":4,"Flags":0},"Statement":{"Type":4,"Flags":1}}}},{"2":{"Name":"TemplateLinkedPolicyDefinition","Properties":{"PolicyTemplateId":{"Type":4,"Flags":1},"Principal":{"Type":17,"Flags":0},"Resource":{"Type":17,"Flags":0}}}},{"2":{"Name":"AWS.VerifiedPermissions/PolicyProperties","Properties":{"Definition":{"Type":18,"Flags":1},"PolicyId":{"Type":4,"Flags":18},"PolicyStoreId":{"Type":4,"Flags":16},"PolicyType":{"Type":4,"Flags":2}}}},{"2":{"Name":"AWS.VerifiedPermissions/Policy","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":22,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.VerifiedPermissions/Policy@default","ScopeType":0,"Body":23}},{"2":{"Name":"SchemaDefinition","Properties":{"CedarJson":{"Type":4,"Flags":0}}}},{"2":{"Name":"SchemaJson"}},{"2":{"Name":"ValidationMode"}},{"2":{"Name":"ValidationSettings","Properties":{"Mode":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.VerifiedPermissions/PolicyStoreProperties","Properties":{"Arn":{"Type":4,"Flags":2},"PolicyStoreId":{"Type":4,"Flags":18},"Schema":{"Type":25,"Flags":0},"ValidationSettings":{"Type":28,"Flags":1}}}},{"2":{"Name":"AWS.VerifiedPermissions/PolicyStore","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":29,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.VerifiedPermissions/PolicyStore@default","ScopeType":0,"Body":30}},{"2":{"Name":"AWS.VerifiedPermissions/PolicyTemplateProperties","Properties":{"Description":{"Type":4,"Flags":0},"PolicyStoreId":{"Type":4,"Flags":16},"PolicyTemplateId":{"Type":4,"Flags":18},"Statement":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.VerifiedPermissions/PolicyTemplate","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":32,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.VerifiedPermissions/PolicyTemplate@default","ScopeType":0,"Body":33}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "CognitoGroupConfiguration", + "properties": { + "GroupEntityType": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CognitoUserPoolConfiguration", + "properties": { + "ClientIds": { + "type": { + "$ref": "#/11" + }, + "flags": 0 + }, + "GroupConfiguration": { + "type": { + "$ref": "#/0" + }, + "flags": 0 + }, + "UserPoolArn": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "IdentitySourceConfiguration", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "IdentitySourceDetails", + "properties": { + "ClientIds": { + "type": { + "$ref": "#/12" + }, + "flags": 0 + }, + "DiscoveryUrl": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "OpenIdIssuer": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "UserPoolArn": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "OpenIdConnectAccessTokenConfiguration", + "properties": { + "Audiences": { + "type": { + "$ref": "#/13" + }, + "flags": 0 + }, + "PrincipalIdClaim": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "OpenIdConnectConfiguration", + "properties": { + "EntityIdPrefix": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "GroupConfiguration": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "Issuer": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + }, + "TokenSelection": { + "type": { + "$ref": "#/14" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "OpenIdConnectGroupConfiguration", + "properties": { + "GroupClaim": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + }, + "GroupEntityType": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "OpenIdConnectIdentityTokenConfiguration", + "properties": { + "ClientIds": { + "type": { + "$ref": "#/15" + }, + "flags": 0 + }, + "PrincipalIdClaim": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "OpenIdConnectTokenSelection", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "OpenIdIssuer", + "properties": {} + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/10" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/10" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/10" + } + }, + { + "$type": "ObjectType", + "name": "IdentitySource_OpenIdConnectTokenSelection", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/10" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.VerifiedPermissions/IdentitySourceProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.VerifiedPermissions/IdentitySourceProperties", + "properties": { + "Configuration": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Details": { + "type": { + "$ref": "#/3" + }, + "flags": 2 + }, + "IdentitySourceId": { + "type": { + "$ref": "#/10" + }, + "flags": 18 + }, + "PolicyStoreId": { + "type": { + "$ref": "#/10" + }, + "flags": 17 + }, + "PrincipalEntityType": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.VerifiedPermissions/IdentitySource", + "properties": { + "name": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/10" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/17" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.VerifiedPermissions/IdentitySource@default", + "scopeType": 0, + "body": { + "$ref": "#/18" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "EntityIdentifier", + "properties": { + "EntityId": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + }, + "EntityType": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "PolicyDefinition", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PolicyType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "StaticPolicyDefinition", + "properties": { + "Description": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "Statement": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TemplateLinkedPolicyDefinition", + "properties": { + "PolicyTemplateId": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + }, + "Principal": { + "type": { + "$ref": "#/20" + }, + "flags": 0 + }, + "Resource": { + "type": { + "$ref": "#/20" + }, + "flags": 0 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.VerifiedPermissions/PolicyProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.VerifiedPermissions/PolicyProperties", + "properties": { + "Definition": { + "type": { + "$ref": "#/21" + }, + "flags": 1 + }, + "PolicyId": { + "type": { + "$ref": "#/10" + }, + "flags": 18 + }, + "PolicyStoreId": { + "type": { + "$ref": "#/10" + }, + "flags": 17 + }, + "PolicyType": { + "type": { + "$ref": "#/10" + }, + "flags": 2 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.VerifiedPermissions/Policy", + "properties": { + "name": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/10" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/26" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.VerifiedPermissions/Policy@default", + "scopeType": 0, + "body": { + "$ref": "#/27" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "SchemaDefinition", + "properties": { + "CedarJson": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SchemaJson", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ValidationMode", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ValidationSettings", + "properties": { + "Mode": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.VerifiedPermissions/PolicyStoreProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.VerifiedPermissions/PolicyStoreProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/10" + }, + "flags": 2 + }, + "Description": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "PolicyStoreId": { + "type": { + "$ref": "#/10" + }, + "flags": 18 + }, + "Schema": { + "type": { + "$ref": "#/29" + }, + "flags": 0 + }, + "ValidationSettings": { + "type": { + "$ref": "#/32" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.VerifiedPermissions/PolicyStore", + "properties": { + "name": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/10" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/34" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.VerifiedPermissions/PolicyStore@default", + "scopeType": 0, + "body": { + "$ref": "#/35" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.VerifiedPermissions/PolicyTemplateProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.VerifiedPermissions/PolicyTemplateProperties", + "properties": { + "Description": { + "type": { + "$ref": "#/10" + }, + "flags": 0 + }, + "PolicyStoreId": { + "type": { + "$ref": "#/10" + }, + "flags": 17 + }, + "PolicyTemplateId": { + "type": { + "$ref": "#/10" + }, + "flags": 18 + }, + "Statement": { + "type": { + "$ref": "#/10" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.VerifiedPermissions/PolicyTemplate", + "properties": { + "name": { + "type": { + "$ref": "#/10" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/10" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/38" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.VerifiedPermissions/PolicyTemplate@default", + "scopeType": 0, + "body": { + "$ref": "#/39" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.verifiedpermissions/default/types.md b/artifacts/bicep/aws/aws.verifiedpermissions/default/types.md index f55a3f6f..30384645 100644 --- a/artifacts/bicep/aws/aws.verifiedpermissions/default/types.md +++ b/artifacts/bicep/aws/aws.verifiedpermissions/default/types.md @@ -3,47 +3,63 @@ ## Resource AWS.VerifiedPermissions/IdentitySource@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.VerifiedPermissions/IdentitySourceProperties](#awsverifiedpermissionsidentitysourceproperties) (Required): properties of the resource +* **properties**: [AWS.VerifiedPermissions/IdentitySourceProperties](#awsverifiedpermissionsidentitysourceproperties) (Required, Identifier): properties of the resource ## Resource AWS.VerifiedPermissions/Policy@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.VerifiedPermissions/PolicyProperties](#awsverifiedpermissionspolicyproperties) (Required): properties of the resource +* **properties**: [AWS.VerifiedPermissions/PolicyProperties](#awsverifiedpermissionspolicyproperties) (Required, Identifier): properties of the resource ## Resource AWS.VerifiedPermissions/PolicyStore@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.VerifiedPermissions/PolicyStoreProperties](#awsverifiedpermissionspolicystoreproperties) (Required): properties of the resource +* **properties**: [AWS.VerifiedPermissions/PolicyStoreProperties](#awsverifiedpermissionspolicystoreproperties) (Required, Identifier): properties of the resource ## Resource AWS.VerifiedPermissions/PolicyTemplate@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.VerifiedPermissions/PolicyTemplateProperties](#awsverifiedpermissionspolicytemplateproperties) (Required): properties of the resource +* **properties**: [AWS.VerifiedPermissions/PolicyTemplateProperties](#awsverifiedpermissionspolicytemplateproperties) (Required, Identifier): properties of the resource ## AWS.VerifiedPermissions/IdentitySourceProperties ### Properties * **Configuration**: [IdentitySourceConfiguration](#identitysourceconfiguration) (Required) * **Details**: [IdentitySourceDetails](#identitysourcedetails) (ReadOnly) * **IdentitySourceId**: string (ReadOnly, Identifier) -* **PolicyStoreId**: string (Identifier) +* **PolicyStoreId**: string (Required, Identifier) * **PrincipalEntityType**: string -## IdentitySourceConfiguration +## AWS.VerifiedPermissions/PolicyProperties ### Properties -* **CognitoUserPoolConfiguration**: [CognitoUserPoolConfiguration](#cognitouserpoolconfiguration) (Required) +* **Definition**: [PolicyDefinition](#policydefinition) (Required) +* **PolicyId**: string (ReadOnly, Identifier) +* **PolicyStoreId**: string (Required, Identifier) +* **PolicyType**: string (ReadOnly) -## CognitoUserPoolConfiguration +## AWS.VerifiedPermissions/PolicyStoreProperties +### Properties +* **Arn**: string (ReadOnly) +* **Description**: string +* **PolicyStoreId**: string (ReadOnly, Identifier) +* **Schema**: [SchemaDefinition](#schemadefinition) +* **ValidationSettings**: [ValidationSettings](#validationsettings) (Required) + +## AWS.VerifiedPermissions/PolicyTemplateProperties +### Properties +* **Description**: string +* **PolicyStoreId**: string (Required, Identifier) +* **PolicyTemplateId**: string (ReadOnly, Identifier) +* **Statement**: string (Required) + +## IdentitySourceConfiguration ### Properties -* **ClientIds**: string[] -* **UserPoolArn**: string (Required) ## IdentitySourceDetails ### Properties @@ -52,23 +68,9 @@ * **OpenIdIssuer**: string * **UserPoolArn**: string -## AWS.VerifiedPermissions/PolicyProperties -### Properties -* **Definition**: [PolicyDefinition](#policydefinition) (Required) -* **PolicyId**: string (ReadOnly, Identifier) -* **PolicyStoreId**: string (Identifier) -* **PolicyType**: string (ReadOnly) - ## PolicyDefinition ### Properties -## AWS.VerifiedPermissions/PolicyStoreProperties -### Properties -* **Arn**: string (ReadOnly) -* **PolicyStoreId**: string (ReadOnly, Identifier) -* **Schema**: [SchemaDefinition](#schemadefinition) -* **ValidationSettings**: [ValidationSettings](#validationsettings) (Required) - ## SchemaDefinition ### Properties * **CedarJson**: string @@ -77,10 +79,3 @@ ### Properties * **Mode**: string (Required) -## AWS.VerifiedPermissions/PolicyTemplateProperties -### Properties -* **Description**: string -* **PolicyStoreId**: string (Identifier) -* **PolicyTemplateId**: string (ReadOnly, Identifier) -* **Statement**: string (Required) - diff --git a/artifacts/bicep/aws/aws.voiceid/default/types.json b/artifacts/bicep/aws/aws.voiceid/default/types.json index 6c131654..0d1929ad 100644 --- a/artifacts/bicep/aws/aws.voiceid/default/types.json +++ b/artifacts/bicep/aws/aws.voiceid/default/types.json @@ -1 +1,117 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"ServerSideEncryptionConfiguration","Properties":{"KmsKeyId":{"Type":4,"Flags":1}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.VoiceID/DomainProperties","Properties":{"Description":{"Type":4,"Flags":4},"DomainId":{"Type":4,"Flags":18},"Name":{"Type":4,"Flags":5},"ServerSideEncryptionConfiguration":{"Type":8,"Flags":5},"Tags":{"Type":11,"Flags":0}}}},{"3":{"ItemType":9}},{"2":{"Name":"AWS.VoiceID/Domain","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":10,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.VoiceID/Domain@default","ScopeType":0,"Body":12}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "ServerSideEncryptionConfiguration", + "properties": { + "KmsKeyId": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.VoiceID/DomainProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "AWS.VoiceID/DomainProperties", + "properties": { + "Description": { + "type": { + "$ref": "#/2" + }, + "flags": 4 + }, + "DomainId": { + "type": { + "$ref": "#/2" + }, + "flags": 18 + }, + "Name": { + "type": { + "$ref": "#/2" + }, + "flags": 5 + }, + "ServerSideEncryptionConfiguration": { + "type": { + "$ref": "#/0" + }, + "flags": 5 + }, + "Tags": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.VoiceID/Domain", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.VoiceID/Domain@default", + "scopeType": 0, + "body": { + "$ref": "#/6" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.voiceid/default/types.md b/artifacts/bicep/aws/aws.voiceid/default/types.md index 73863fc2..8747f0e6 100644 --- a/artifacts/bicep/aws/aws.voiceid/default/types.md +++ b/artifacts/bicep/aws/aws.voiceid/default/types.md @@ -3,9 +3,9 @@ ## Resource AWS.VoiceID/Domain@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.VoiceID/DomainProperties](#awsvoiceiddomainproperties) (Required): properties of the resource +* **properties**: [AWS.VoiceID/DomainProperties](#awsvoiceiddomainproperties) (Required, Identifier): properties of the resource ## AWS.VoiceID/DomainProperties ### Properties diff --git a/artifacts/bicep/aws/aws.vpclattice/default/types.json b/artifacts/bicep/aws/aws.vpclattice/default/types.json index af722ffc..1b77bd6b 100644 --- a/artifacts/bicep/aws/aws.vpclattice/default/types.json +++ b/artifacts/bicep/aws/aws.vpclattice/default/types.json @@ -1 +1,1633 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.VpcLattice/AccessLogSubscriptionProperties","Properties":{"Arn":{"Type":4,"Flags":18},"DestinationArn":{"Type":4,"Flags":1},"Id":{"Type":4,"Flags":2},"ResourceArn":{"Type":4,"Flags":2},"ResourceId":{"Type":4,"Flags":2},"ResourceIdentifier":{"Type":4,"Flags":4},"Tags":{"Type":10,"Flags":0}}}},{"3":{"ItemType":8}},{"2":{"Name":"AWS.VpcLattice/AccessLogSubscription","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":9,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.VpcLattice/AccessLogSubscription@default","ScopeType":0,"Body":11}},{"2":{"Name":"AWS.VpcLattice/AuthPolicyProperties","Properties":{"Policy":{"Type":14,"Flags":1},"ResourceIdentifier":{"Type":4,"Flags":17},"State":{"Type":4,"Flags":2}}}},{"2":{"Name":"AuthPolicy_Policy","Properties":{}}},{"2":{"Name":"AWS.VpcLattice/AuthPolicy","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":13,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.VpcLattice/AuthPolicy@default","ScopeType":0,"Body":15}},{"2":{"Name":"DefaultAction","Properties":{"FixedResponse":{"Type":18,"Flags":0},"Forward":{"Type":19,"Flags":0}}}},{"2":{"Name":"FixedResponse","Properties":{"StatusCode":{"Type":3,"Flags":1}}}},{"2":{"Name":"Forward","Properties":{"TargetGroups":{"Type":22,"Flags":1}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"WeightedTargetGroup","Properties":{"TargetGroupIdentifier":{"Type":4,"Flags":1},"Weight":{"Type":3,"Flags":0}}}},{"3":{"ItemType":21}},{"2":{"Name":"AWS.VpcLattice/ListenerProperties","Properties":{"Arn":{"Type":4,"Flags":18},"DefaultAction":{"Type":17,"Flags":1},"Id":{"Type":4,"Flags":2},"Name":{"Type":4,"Flags":0},"Port":{"Type":3,"Flags":0},"Protocol":{"Type":4,"Flags":1},"ServiceArn":{"Type":4,"Flags":2},"ServiceId":{"Type":4,"Flags":2},"ServiceIdentifier":{"Type":4,"Flags":4},"Tags":{"Type":24,"Flags":0}}}},{"3":{"ItemType":20}},{"2":{"Name":"AWS.VpcLattice/Listener","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":23,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.VpcLattice/Listener@default","ScopeType":0,"Body":25}},{"2":{"Name":"AWS.VpcLattice/ResourcePolicyProperties","Properties":{"Policy":{"Type":28,"Flags":1},"ResourceArn":{"Type":4,"Flags":17}}}},{"2":{"Name":"ResourcePolicy_Policy","Properties":{}}},{"2":{"Name":"AWS.VpcLattice/ResourcePolicy","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":27,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.VpcLattice/ResourcePolicy@default","ScopeType":0,"Body":29}},{"2":{"Name":"Action","Properties":{"FixedResponse":{"Type":32,"Flags":0},"Forward":{"Type":33,"Flags":0}}}},{"2":{"Name":"FixedResponse","Properties":{"StatusCode":{"Type":3,"Flags":1}}}},{"2":{"Name":"Forward","Properties":{"TargetGroups":{"Type":42,"Flags":1}}}},{"2":{"Name":"HeaderMatch","Properties":{"CaseSensitive":{"Type":2,"Flags":0},"Match":{"Type":35,"Flags":1},"Name":{"Type":4,"Flags":1}}}},{"2":{"Name":"HeaderMatchType","Properties":{"Contains":{"Type":4,"Flags":0},"Exact":{"Type":4,"Flags":0},"Prefix":{"Type":4,"Flags":0}}}},{"2":{"Name":"HttpMatch","Properties":{"HeaderMatches":{"Type":43,"Flags":0},"Method":{"Type":4,"Flags":0},"PathMatch":{"Type":38,"Flags":0}}}},{"2":{"Name":"Match","Properties":{"HttpMatch":{"Type":36,"Flags":1}}}},{"2":{"Name":"PathMatch","Properties":{"CaseSensitive":{"Type":2,"Flags":0},"Match":{"Type":39,"Flags":1}}}},{"2":{"Name":"PathMatchType","Properties":{"Exact":{"Type":4,"Flags":0},"Prefix":{"Type":4,"Flags":0}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"WeightedTargetGroup","Properties":{"TargetGroupIdentifier":{"Type":4,"Flags":1},"Weight":{"Type":3,"Flags":0}}}},{"3":{"ItemType":41}},{"3":{"ItemType":34}},{"2":{"Name":"AWS.VpcLattice/RuleProperties","Properties":{"Action":{"Type":31,"Flags":1},"Arn":{"Type":4,"Flags":18},"Id":{"Type":4,"Flags":2},"ListenerIdentifier":{"Type":4,"Flags":4},"Match":{"Type":37,"Flags":1},"Name":{"Type":4,"Flags":0},"Priority":{"Type":3,"Flags":1},"ServiceIdentifier":{"Type":4,"Flags":4},"Tags":{"Type":45,"Flags":0}}}},{"3":{"ItemType":40}},{"2":{"Name":"AWS.VpcLattice/Rule","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":44,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.VpcLattice/Rule@default","ScopeType":0,"Body":46}},{"2":{"Name":"DnsEntry","Properties":{"DomainName":{"Type":4,"Flags":2},"HostedZoneId":{"Type":4,"Flags":2}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.VpcLattice/ServiceProperties","Properties":{"Arn":{"Type":4,"Flags":18},"AuthType":{"Type":4,"Flags":0},"CertificateArn":{"Type":4,"Flags":0},"CreatedAt":{"Type":4,"Flags":2},"CustomDomainName":{"Type":4,"Flags":0},"DnsEntry":{"Type":48,"Flags":0},"Id":{"Type":4,"Flags":2},"LastUpdatedAt":{"Type":4,"Flags":2},"Name":{"Type":4,"Flags":0},"Status":{"Type":4,"Flags":2},"Tags":{"Type":51,"Flags":0}}}},{"3":{"ItemType":49}},{"2":{"Name":"AWS.VpcLattice/Service","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":50,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.VpcLattice/Service@default","ScopeType":0,"Body":52}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.VpcLattice/ServiceNetworkProperties","Properties":{"Arn":{"Type":4,"Flags":18},"AuthType":{"Type":4,"Flags":0},"CreatedAt":{"Type":4,"Flags":2},"Id":{"Type":4,"Flags":2},"LastUpdatedAt":{"Type":4,"Flags":2},"Name":{"Type":4,"Flags":0},"Tags":{"Type":56,"Flags":0}}}},{"3":{"ItemType":54}},{"2":{"Name":"AWS.VpcLattice/ServiceNetwork","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":55,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.VpcLattice/ServiceNetwork@default","ScopeType":0,"Body":57}},{"2":{"Name":"DnsEntry","Properties":{"DomainName":{"Type":4,"Flags":2},"HostedZoneId":{"Type":4,"Flags":2}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.VpcLattice/ServiceNetworkServiceAssociationProperties","Properties":{"Arn":{"Type":4,"Flags":18},"CreatedAt":{"Type":4,"Flags":2},"DnsEntry":{"Type":59,"Flags":0},"Id":{"Type":4,"Flags":2},"ServiceArn":{"Type":4,"Flags":2},"ServiceId":{"Type":4,"Flags":2},"ServiceIdentifier":{"Type":4,"Flags":4},"ServiceName":{"Type":4,"Flags":2},"ServiceNetworkArn":{"Type":4,"Flags":2},"ServiceNetworkId":{"Type":4,"Flags":2},"ServiceNetworkIdentifier":{"Type":4,"Flags":4},"ServiceNetworkName":{"Type":4,"Flags":2},"Status":{"Type":4,"Flags":2},"Tags":{"Type":62,"Flags":0}}}},{"3":{"ItemType":60}},{"2":{"Name":"AWS.VpcLattice/ServiceNetworkServiceAssociation","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":61,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.VpcLattice/ServiceNetworkServiceAssociation@default","ScopeType":0,"Body":63}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.VpcLattice/ServiceNetworkVpcAssociationProperties","Properties":{"Arn":{"Type":4,"Flags":18},"CreatedAt":{"Type":4,"Flags":2},"Id":{"Type":4,"Flags":2},"SecurityGroupIds":{"Type":67,"Flags":0},"ServiceNetworkArn":{"Type":4,"Flags":2},"ServiceNetworkId":{"Type":4,"Flags":2},"ServiceNetworkIdentifier":{"Type":4,"Flags":4},"ServiceNetworkName":{"Type":4,"Flags":2},"Status":{"Type":4,"Flags":2},"Tags":{"Type":68,"Flags":0},"VpcId":{"Type":4,"Flags":2},"VpcIdentifier":{"Type":4,"Flags":4}}}},{"3":{"ItemType":4}},{"3":{"ItemType":65}},{"2":{"Name":"AWS.VpcLattice/ServiceNetworkVpcAssociation","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":66,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.VpcLattice/ServiceNetworkVpcAssociation@default","ScopeType":0,"Body":69}},{"2":{"Name":"HealthCheckConfig","Properties":{"Enabled":{"Type":2,"Flags":0},"HealthCheckIntervalSeconds":{"Type":3,"Flags":0},"HealthCheckTimeoutSeconds":{"Type":3,"Flags":0},"HealthyThresholdCount":{"Type":3,"Flags":0},"Matcher":{"Type":72,"Flags":0},"Path":{"Type":4,"Flags":0},"Port":{"Type":3,"Flags":0},"Protocol":{"Type":4,"Flags":0},"ProtocolVersion":{"Type":4,"Flags":0},"UnhealthyThresholdCount":{"Type":3,"Flags":0}}}},{"2":{"Name":"Matcher","Properties":{"HttpCode":{"Type":4,"Flags":1}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"Target","Properties":{"Id":{"Type":4,"Flags":1},"Port":{"Type":3,"Flags":0}}}},{"2":{"Name":"TargetGroupConfig","Properties":{"HealthCheck":{"Type":71,"Flags":0},"IpAddressType":{"Type":4,"Flags":0},"LambdaEventStructureVersion":{"Type":4,"Flags":0},"Port":{"Type":3,"Flags":0},"Protocol":{"Type":4,"Flags":0},"ProtocolVersion":{"Type":4,"Flags":0},"VpcIdentifier":{"Type":4,"Flags":0}}}},{"2":{"Name":"AWS.VpcLattice/TargetGroupProperties","Properties":{"Arn":{"Type":4,"Flags":18},"Config":{"Type":75,"Flags":0},"CreatedAt":{"Type":4,"Flags":2},"Id":{"Type":4,"Flags":2},"LastUpdatedAt":{"Type":4,"Flags":2},"Name":{"Type":4,"Flags":0},"Status":{"Type":4,"Flags":2},"Tags":{"Type":77,"Flags":0},"Targets":{"Type":78,"Flags":0},"Type":{"Type":4,"Flags":1}}}},{"3":{"ItemType":73}},{"3":{"ItemType":74}},{"2":{"Name":"AWS.VpcLattice/TargetGroup","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":76,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.VpcLattice/TargetGroup@default","ScopeType":0,"Body":79}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.VpcLattice/AccessLogSubscriptionProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/0" + } + }, + { + "$type": "ObjectType", + "name": "AWS.VpcLattice/AccessLogSubscriptionProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 18 + }, + "DestinationArn": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Id": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "ResourceArn": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "ResourceId": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "ResourceIdentifier": { + "type": { + "$ref": "#/1" + }, + "flags": 4 + }, + "Tags": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.VpcLattice/AccessLogSubscription", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.VpcLattice/AccessLogSubscription@default", + "scopeType": 0, + "body": { + "$ref": "#/5" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.VpcLattice/AuthPolicyProperties" + }, + { + "$type": "ObjectType", + "name": "AuthPolicy_Policy", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AWS.VpcLattice/AuthPolicyProperties", + "properties": { + "Policy": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + }, + "ResourceIdentifier": { + "type": { + "$ref": "#/1" + }, + "flags": 17 + }, + "State": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.VpcLattice/AuthPolicy", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/9" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.VpcLattice/AuthPolicy@default", + "scopeType": 0, + "body": { + "$ref": "#/10" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "DefaultAction", + "properties": { + "FixedResponse": { + "type": { + "$ref": "#/13" + }, + "flags": 0 + }, + "Forward": { + "type": { + "$ref": "#/14" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FixedResponse", + "properties": { + "StatusCode": { + "type": { + "$ref": "#/17" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Forward", + "properties": { + "TargetGroups": { + "type": { + "$ref": "#/18" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "WeightedTargetGroup", + "properties": { + "TargetGroupIdentifier": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Weight": { + "type": { + "$ref": "#/17" + }, + "flags": 0 + } + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/16" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.VpcLattice/ListenerProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/15" + } + }, + { + "$type": "ObjectType", + "name": "AWS.VpcLattice/ListenerProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 18 + }, + "DefaultAction": { + "type": { + "$ref": "#/12" + }, + "flags": 1 + }, + "Id": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "Port": { + "type": { + "$ref": "#/17" + }, + "flags": 0 + }, + "Protocol": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "ServiceArn": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "ServiceId": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "ServiceIdentifier": { + "type": { + "$ref": "#/1" + }, + "flags": 4 + }, + "Tags": { + "type": { + "$ref": "#/20" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.VpcLattice/Listener", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/21" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.VpcLattice/Listener@default", + "scopeType": 0, + "body": { + "$ref": "#/22" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.VpcLattice/ResourcePolicyProperties" + }, + { + "$type": "ObjectType", + "name": "ResourcePolicy_Policy", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AWS.VpcLattice/ResourcePolicyProperties", + "properties": { + "Policy": { + "type": { + "$ref": "#/25" + }, + "flags": 1 + }, + "ResourceArn": { + "type": { + "$ref": "#/1" + }, + "flags": 17 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.VpcLattice/ResourcePolicy", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/26" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.VpcLattice/ResourcePolicy@default", + "scopeType": 0, + "body": { + "$ref": "#/27" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Action", + "properties": { + "FixedResponse": { + "type": { + "$ref": "#/30" + }, + "flags": 0 + }, + "Forward": { + "type": { + "$ref": "#/31" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "FixedResponse", + "properties": { + "StatusCode": { + "type": { + "$ref": "#/17" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Forward", + "properties": { + "TargetGroups": { + "type": { + "$ref": "#/40" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "HeaderMatch", + "properties": { + "CaseSensitive": { + "type": { + "$ref": "#/41" + }, + "flags": 0 + }, + "Match": { + "type": { + "$ref": "#/33" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "HeaderMatchType", + "properties": { + "Contains": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "Exact": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "Prefix": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "HttpMatch", + "properties": { + "HeaderMatches": { + "type": { + "$ref": "#/42" + }, + "flags": 0 + }, + "Method": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "PathMatch": { + "type": { + "$ref": "#/36" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Match", + "properties": { + "HttpMatch": { + "type": { + "$ref": "#/34" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "PathMatch", + "properties": { + "CaseSensitive": { + "type": { + "$ref": "#/41" + }, + "flags": 0 + }, + "Match": { + "type": { + "$ref": "#/37" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "PathMatchType", + "properties": { + "Exact": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "Prefix": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "WeightedTargetGroup", + "properties": { + "TargetGroupIdentifier": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Weight": { + "type": { + "$ref": "#/17" + }, + "flags": 0 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/39" + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/32" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.VpcLattice/RuleProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/38" + } + }, + { + "$type": "ObjectType", + "name": "AWS.VpcLattice/RuleProperties", + "properties": { + "Action": { + "type": { + "$ref": "#/29" + }, + "flags": 1 + }, + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 18 + }, + "Id": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "ListenerIdentifier": { + "type": { + "$ref": "#/1" + }, + "flags": 4 + }, + "Match": { + "type": { + "$ref": "#/35" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "Priority": { + "type": { + "$ref": "#/17" + }, + "flags": 1 + }, + "ServiceIdentifier": { + "type": { + "$ref": "#/1" + }, + "flags": 4 + }, + "Tags": { + "type": { + "$ref": "#/44" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.VpcLattice/Rule", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/45" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.VpcLattice/Rule@default", + "scopeType": 0, + "body": { + "$ref": "#/46" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "DnsEntry", + "properties": { + "DomainName": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "HostedZoneId": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.VpcLattice/ServiceProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/49" + } + }, + { + "$type": "ObjectType", + "name": "AWS.VpcLattice/ServiceProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 18 + }, + "AuthType": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "CertificateArn": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "CreatedAt": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "CustomDomainName": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "DnsEntry": { + "type": { + "$ref": "#/48" + }, + "flags": 0 + }, + "Id": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "LastUpdatedAt": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "Status": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "Tags": { + "type": { + "$ref": "#/51" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.VpcLattice/Service", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/52" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.VpcLattice/Service@default", + "scopeType": 0, + "body": { + "$ref": "#/53" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.VpcLattice/ServiceNetworkProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/55" + } + }, + { + "$type": "ObjectType", + "name": "AWS.VpcLattice/ServiceNetworkProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 18 + }, + "AuthType": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "CreatedAt": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "Id": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "LastUpdatedAt": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/57" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.VpcLattice/ServiceNetwork", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/58" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.VpcLattice/ServiceNetwork@default", + "scopeType": 0, + "body": { + "$ref": "#/59" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "DnsEntry", + "properties": { + "DomainName": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "HostedZoneId": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.VpcLattice/ServiceNetworkServiceAssociationProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/62" + } + }, + { + "$type": "ObjectType", + "name": "AWS.VpcLattice/ServiceNetworkServiceAssociationProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 18 + }, + "CreatedAt": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "DnsEntry": { + "type": { + "$ref": "#/61" + }, + "flags": 0 + }, + "Id": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "ServiceArn": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "ServiceId": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "ServiceIdentifier": { + "type": { + "$ref": "#/1" + }, + "flags": 4 + }, + "ServiceName": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "ServiceNetworkArn": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "ServiceNetworkId": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "ServiceNetworkIdentifier": { + "type": { + "$ref": "#/1" + }, + "flags": 4 + }, + "ServiceNetworkName": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "Status": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "Tags": { + "type": { + "$ref": "#/64" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.VpcLattice/ServiceNetworkServiceAssociation", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/65" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.VpcLattice/ServiceNetworkServiceAssociation@default", + "scopeType": 0, + "body": { + "$ref": "#/66" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.VpcLattice/ServiceNetworkVpcAssociationProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/68" + } + }, + { + "$type": "ObjectType", + "name": "AWS.VpcLattice/ServiceNetworkVpcAssociationProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 18 + }, + "CreatedAt": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "Id": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "SecurityGroupIds": { + "type": { + "$ref": "#/70" + }, + "flags": 0 + }, + "ServiceNetworkArn": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "ServiceNetworkId": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "ServiceNetworkIdentifier": { + "type": { + "$ref": "#/1" + }, + "flags": 4 + }, + "ServiceNetworkName": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "Status": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "Tags": { + "type": { + "$ref": "#/71" + }, + "flags": 0 + }, + "VpcId": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "VpcIdentifier": { + "type": { + "$ref": "#/1" + }, + "flags": 4 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.VpcLattice/ServiceNetworkVpcAssociation", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/72" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.VpcLattice/ServiceNetworkVpcAssociation@default", + "scopeType": 0, + "body": { + "$ref": "#/73" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "HealthCheckConfig", + "properties": { + "Enabled": { + "type": { + "$ref": "#/41" + }, + "flags": 0 + }, + "HealthCheckIntervalSeconds": { + "type": { + "$ref": "#/17" + }, + "flags": 0 + }, + "HealthCheckTimeoutSeconds": { + "type": { + "$ref": "#/17" + }, + "flags": 0 + }, + "HealthyThresholdCount": { + "type": { + "$ref": "#/17" + }, + "flags": 0 + }, + "Matcher": { + "type": { + "$ref": "#/76" + }, + "flags": 0 + }, + "Path": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "Port": { + "type": { + "$ref": "#/17" + }, + "flags": 0 + }, + "Protocol": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "ProtocolVersion": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "UnhealthyThresholdCount": { + "type": { + "$ref": "#/17" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Matcher", + "properties": { + "HttpCode": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Target", + "properties": { + "Id": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + }, + "Port": { + "type": { + "$ref": "#/17" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TargetGroupConfig", + "properties": { + "HealthCheck": { + "type": { + "$ref": "#/75" + }, + "flags": 0 + }, + "IpAddressType": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "LambdaEventStructureVersion": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "Port": { + "type": { + "$ref": "#/17" + }, + "flags": 0 + }, + "Protocol": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "ProtocolVersion": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "VpcIdentifier": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.VpcLattice/TargetGroupProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/77" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/78" + } + }, + { + "$type": "ObjectType", + "name": "AWS.VpcLattice/TargetGroupProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/1" + }, + "flags": 18 + }, + "Config": { + "type": { + "$ref": "#/79" + }, + "flags": 0 + }, + "CreatedAt": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "Id": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "LastUpdatedAt": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "Name": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "Status": { + "type": { + "$ref": "#/1" + }, + "flags": 2 + }, + "Tags": { + "type": { + "$ref": "#/81" + }, + "flags": 0 + }, + "Targets": { + "type": { + "$ref": "#/82" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/1" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.VpcLattice/TargetGroup", + "properties": { + "name": { + "type": { + "$ref": "#/1" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/1" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/83" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.VpcLattice/TargetGroup@default", + "scopeType": 0, + "body": { + "$ref": "#/84" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.vpclattice/default/types.md b/artifacts/bicep/aws/aws.vpclattice/default/types.md index 584fa9f8..3009a6d5 100644 --- a/artifacts/bicep/aws/aws.vpclattice/default/types.md +++ b/artifacts/bicep/aws/aws.vpclattice/default/types.md @@ -3,72 +3,80 @@ ## Resource AWS.VpcLattice/AccessLogSubscription@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.VpcLattice/AccessLogSubscriptionProperties](#awsvpclatticeaccesslogsubscriptionproperties) (Required): properties of the resource +* **properties**: [AWS.VpcLattice/AccessLogSubscriptionProperties](#awsvpclatticeaccesslogsubscriptionproperties) (Required, Identifier): properties of the resource ## Resource AWS.VpcLattice/AuthPolicy@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.VpcLattice/AuthPolicyProperties](#awsvpclatticeauthpolicyproperties) (Required): properties of the resource +* **properties**: [AWS.VpcLattice/AuthPolicyProperties](#awsvpclatticeauthpolicyproperties) (Required, Identifier): properties of the resource ## Resource AWS.VpcLattice/Listener@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.VpcLattice/ListenerProperties](#awsvpclatticelistenerproperties) (Required): properties of the resource +* **properties**: [AWS.VpcLattice/ListenerProperties](#awsvpclatticelistenerproperties) (Required, Identifier): properties of the resource ## Resource AWS.VpcLattice/ResourcePolicy@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.VpcLattice/ResourcePolicyProperties](#awsvpclatticeresourcepolicyproperties) (Required): properties of the resource +* **properties**: [AWS.VpcLattice/ResourcePolicyProperties](#awsvpclatticeresourcepolicyproperties) (Required, Identifier): properties of the resource ## Resource AWS.VpcLattice/Rule@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.VpcLattice/RuleProperties](#awsvpclatticeruleproperties) (Required): properties of the resource +* **properties**: [AWS.VpcLattice/RuleProperties](#awsvpclatticeruleproperties) (Required, Identifier): properties of the resource ## Resource AWS.VpcLattice/Service@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.VpcLattice/ServiceProperties](#awsvpclatticeserviceproperties): properties of the resource +* **properties**: [AWS.VpcLattice/ServiceProperties](#awsvpclatticeserviceproperties) (Identifier): properties of the resource ## Resource AWS.VpcLattice/ServiceNetwork@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.VpcLattice/ServiceNetworkProperties](#awsvpclatticeservicenetworkproperties): properties of the resource +* **properties**: [AWS.VpcLattice/ServiceNetworkProperties](#awsvpclatticeservicenetworkproperties) (Identifier): properties of the resource ## Resource AWS.VpcLattice/ServiceNetworkServiceAssociation@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.VpcLattice/ServiceNetworkServiceAssociationProperties](#awsvpclatticeservicenetworkserviceassociationproperties): properties of the resource +* **properties**: [AWS.VpcLattice/ServiceNetworkServiceAssociationProperties](#awsvpclatticeservicenetworkserviceassociationproperties) (Identifier): properties of the resource ## Resource AWS.VpcLattice/ServiceNetworkVpcAssociation@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.VpcLattice/ServiceNetworkVpcAssociationProperties](#awsvpclatticeservicenetworkvpcassociationproperties): properties of the resource +* **properties**: [AWS.VpcLattice/ServiceNetworkVpcAssociationProperties](#awsvpclatticeservicenetworkvpcassociationproperties) (Identifier): properties of the resource ## Resource AWS.VpcLattice/TargetGroup@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.VpcLattice/TargetGroupProperties](#awsvpclatticetargetgroupproperties) (Required): properties of the resource +* **properties**: [AWS.VpcLattice/TargetGroupProperties](#awsvpclatticetargetgroupproperties) (Required, Identifier): properties of the resource + +## Action +### Properties +* **FixedResponse**: [FixedResponse](#fixedresponse) +* **Forward**: [Forward](#forward) + +## AuthPolicy_Policy +### Properties ## AWS.VpcLattice/AccessLogSubscriptionProperties ### Properties @@ -80,20 +88,12 @@ * **ResourceIdentifier**: string (WriteOnly) * **Tags**: [Tag](#tag)[] -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - ## AWS.VpcLattice/AuthPolicyProperties ### Properties * **Policy**: [AuthPolicy_Policy](#authpolicypolicy) (Required) * **ResourceIdentifier**: string (Required, Identifier) * **State**: string (ReadOnly) -## AuthPolicy_Policy -### Properties - ## AWS.VpcLattice/ListenerProperties ### Properties * **Arn**: string (ReadOnly, Identifier) @@ -107,37 +107,11 @@ * **ServiceIdentifier**: string (WriteOnly) * **Tags**: [Tag](#tag)[] -## DefaultAction -### Properties -* **FixedResponse**: [FixedResponse](#fixedresponse) -* **Forward**: [Forward](#forward) - -## FixedResponse -### Properties -* **StatusCode**: int (Required) - -## Forward -### Properties -* **TargetGroups**: [WeightedTargetGroup](#weightedtargetgroup)[] (Required) - -## WeightedTargetGroup -### Properties -* **TargetGroupIdentifier**: string (Required) -* **Weight**: int - -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - ## AWS.VpcLattice/ResourcePolicyProperties ### Properties * **Policy**: [ResourcePolicy_Policy](#resourcepolicypolicy) (Required) * **ResourceArn**: string (Required, Identifier) -## ResourcePolicy_Policy -### Properties - ## AWS.VpcLattice/RuleProperties ### Properties * **Action**: [Action](#action) (Required) @@ -150,85 +124,6 @@ * **ServiceIdentifier**: string (WriteOnly) * **Tags**: [Tag](#tag)[] -## Action -### Properties -* **FixedResponse**: [FixedResponse](#fixedresponse) -* **Forward**: [Forward](#forward) - -## FixedResponse -### Properties -* **StatusCode**: int (Required) - -## Forward -### Properties -* **TargetGroups**: [WeightedTargetGroup](#weightedtargetgroup)[] (Required) - -## WeightedTargetGroup -### Properties -* **TargetGroupIdentifier**: string (Required) -* **Weight**: int - -## Match -### Properties -* **HttpMatch**: [HttpMatch](#httpmatch) (Required) - -## HttpMatch -### Properties -* **HeaderMatches**: [HeaderMatch](#headermatch)[] -* **Method**: string -* **PathMatch**: [PathMatch](#pathmatch) - -## HeaderMatch -### Properties -* **CaseSensitive**: bool -* **Match**: [HeaderMatchType](#headermatchtype) (Required) -* **Name**: string (Required) - -## HeaderMatchType -### Properties -* **Contains**: string -* **Exact**: string -* **Prefix**: string - -## PathMatch -### Properties -* **CaseSensitive**: bool -* **Match**: [PathMatchType](#pathmatchtype) (Required) - -## PathMatchType -### Properties -* **Exact**: string -* **Prefix**: string - -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - -## AWS.VpcLattice/ServiceProperties -### Properties -* **Arn**: string (ReadOnly, Identifier) -* **AuthType**: string -* **CertificateArn**: string -* **CreatedAt**: string (ReadOnly) -* **CustomDomainName**: string -* **DnsEntry**: [DnsEntry](#dnsentry) -* **Id**: string (ReadOnly) -* **LastUpdatedAt**: string (ReadOnly) -* **Name**: string -* **Status**: string (ReadOnly) -* **Tags**: [Tag](#tag)[] - -## DnsEntry -### Properties -* **DomainName**: string (ReadOnly) -* **HostedZoneId**: string (ReadOnly) - -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - ## AWS.VpcLattice/ServiceNetworkProperties ### Properties * **Arn**: string (ReadOnly, Identifier) @@ -239,11 +134,6 @@ * **Name**: string * **Tags**: [Tag](#tag)[] -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - ## AWS.VpcLattice/ServiceNetworkServiceAssociationProperties ### Properties * **Arn**: string (ReadOnly, Identifier) @@ -261,16 +151,6 @@ * **Status**: string (ReadOnly) * **Tags**: [Tag](#tag)[] -## DnsEntry -### Properties -* **DomainName**: string (ReadOnly) -* **HostedZoneId**: string (ReadOnly) - -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - ## AWS.VpcLattice/ServiceNetworkVpcAssociationProperties ### Properties * **Arn**: string (ReadOnly, Identifier) @@ -286,10 +166,19 @@ * **VpcId**: string (ReadOnly) * **VpcIdentifier**: string (WriteOnly) -## Tag +## AWS.VpcLattice/ServiceProperties ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **Arn**: string (ReadOnly, Identifier) +* **AuthType**: string +* **CertificateArn**: string +* **CreatedAt**: string (ReadOnly) +* **CustomDomainName**: string +* **DnsEntry**: [DnsEntry](#dnsentry) +* **Id**: string (ReadOnly) +* **LastUpdatedAt**: string (ReadOnly) +* **Name**: string +* **Status**: string (ReadOnly) +* **Tags**: [Tag](#tag)[] ## AWS.VpcLattice/TargetGroupProperties ### Properties @@ -304,15 +193,48 @@ * **Targets**: [Target](#target)[] * **Type**: string (Required) -## TargetGroupConfig +## DefaultAction ### Properties -* **HealthCheck**: [HealthCheckConfig](#healthcheckconfig) -* **IpAddressType**: string -* **LambdaEventStructureVersion**: string -* **Port**: int -* **Protocol**: string -* **ProtocolVersion**: string -* **VpcIdentifier**: string +* **FixedResponse**: [FixedResponse](#fixedresponse) +* **Forward**: [Forward](#forward) + +## DnsEntry +### Properties +* **DomainName**: string (ReadOnly) +* **HostedZoneId**: string (ReadOnly) + +## DnsEntry +### Properties +* **DomainName**: string (ReadOnly) +* **HostedZoneId**: string (ReadOnly) + +## FixedResponse +### Properties +* **StatusCode**: int (Required) + +## FixedResponse +### Properties +* **StatusCode**: int (Required) + +## Forward +### Properties +* **TargetGroups**: [WeightedTargetGroup](#weightedtargetgroup)[] (Required) + +## Forward +### Properties +* **TargetGroups**: [WeightedTargetGroup](#weightedtargetgroup)[] (Required) + +## HeaderMatch +### Properties +* **CaseSensitive**: bool +* **Match**: [HeaderMatchType](#headermatchtype) (Required) +* **Name**: string (Required) + +## HeaderMatchType +### Properties +* **Contains**: string +* **Exact**: string +* **Prefix**: string ## HealthCheckConfig ### Properties @@ -327,10 +249,68 @@ * **ProtocolVersion**: string * **UnhealthyThresholdCount**: int +## HttpMatch +### Properties +* **HeaderMatches**: [HeaderMatch](#headermatch)[] +* **Method**: string +* **PathMatch**: [PathMatch](#pathmatch) + +## Match +### Properties +* **HttpMatch**: [HttpMatch](#httpmatch) (Required) + ## Matcher ### Properties * **HttpCode**: string (Required) +## PathMatch +### Properties +* **CaseSensitive**: bool +* **Match**: [PathMatchType](#pathmatchtype) (Required) + +## PathMatchType +### Properties +* **Exact**: string +* **Prefix**: string + +## ResourcePolicy_Policy +### Properties + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + ## Tag ### Properties * **Key**: string (Required) @@ -341,3 +321,23 @@ * **Id**: string (Required) * **Port**: int +## TargetGroupConfig +### Properties +* **HealthCheck**: [HealthCheckConfig](#healthcheckconfig) +* **IpAddressType**: string +* **LambdaEventStructureVersion**: string +* **Port**: int +* **Protocol**: string +* **ProtocolVersion**: string +* **VpcIdentifier**: string + +## WeightedTargetGroup +### Properties +* **TargetGroupIdentifier**: string (Required) +* **Weight**: int + +## WeightedTargetGroup +### Properties +* **TargetGroupIdentifier**: string (Required) +* **Weight**: int + diff --git a/artifacts/bicep/aws/aws.wafv2/default/types.json b/artifacts/bicep/aws/aws.wafv2/default/types.json index 51380efc..cdcae41f 100644 --- a/artifacts/bicep/aws/aws.wafv2/default/types.json +++ b/artifacts/bicep/aws/aws.wafv2/default/types.json @@ -1 +1,4708 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"EntityDescription"}},{"2":{"Name":"EntityId"}},{"2":{"Name":"EntityName"}},{"2":{"Name":"IPAddress"}},{"2":{"Name":"IPAddressVersion"}},{"2":{"Name":"ResourceArn"}},{"2":{"Name":"Scope"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":0},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"AWS.WAFv2/IPSetProperties","Properties":{"Addresses":{"Type":17,"Flags":1,"Description":"List of IPAddresses."},"Arn":{"Type":4,"Flags":2},"Description":{"Type":4,"Flags":0},"IPAddressVersion":{"Type":4,"Flags":1},"Id":{"Type":4,"Flags":18},"Name":{"Type":4,"Flags":16},"Scope":{"Type":4,"Flags":17},"Tags":{"Type":18,"Flags":0}}}},{"3":{"ItemType":4}},{"3":{"ItemType":15}},{"2":{"Name":"AWS.WAFv2/IPSet","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":16,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.WAFv2/IPSet@default","ScopeType":0,"Body":19}},{"2":{"Name":"Condition","Properties":{"ActionCondition":{"Type":24,"Flags":0,"Description":"A single action condition."},"LabelNameCondition":{"Type":25,"Flags":0,"Description":"A single label name condition."}}}},{"2":{"Name":"FieldToMatch","Properties":{"JsonBody":{"Type":29,"Flags":0,"Description":"Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. "},"Method":{"Type":30,"Flags":0,"Description":"Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform. "},"QueryString":{"Type":31,"Flags":0,"Description":"Inspect the query string. This is the part of a URL that appears after a ? character, if any. "},"SingleHeader":{"Type":32,"Flags":0,"Description":"Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive."},"UriPath":{"Type":33,"Flags":0,"Description":"Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg. "}}}},{"2":{"Name":"Filter","Properties":{"Behavior":{"Type":4,"Flags":1,"Description":"How to handle logs that satisfy the filter's conditions and requirement. "},"Conditions":{"Type":34,"Flags":1,"Description":"Match conditions for the filter."},"Requirement":{"Type":4,"Flags":1,"Description":"Logic to apply to the filtering conditions. You can specify that, in order to satisfy the filter, a log must match all conditions or must match at least one condition."}}}},{"2":{"Name":"LoggingConfiguration_ActionCondition","Properties":{"Action":{"Type":4,"Flags":1,"Description":"Logic to apply to the filtering conditions. You can specify that, in order to satisfy the filter, a log must match all conditions or must match at least one condition."}}}},{"2":{"Name":"LoggingConfiguration_LabelNameCondition","Properties":{"LabelName":{"Type":4,"Flags":1,"Description":"The label name that a log record must contain in order to meet the condition. This must be a fully qualified label name. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label. "}}}},{"2":{"Name":"LoggingConfiguration_JsonBody_MatchPattern_All","Properties":{}}},{"3":{"ItemType":4}},{"2":{"Name":"LoggingConfiguration_JsonBody_MatchPattern","Properties":{"All":{"Type":26,"Flags":0,"Description":"Match all of the elements. See also MatchScope in JsonBody. You must specify either this setting or the IncludedPaths setting, but not both."},"IncludedPaths":{"Type":27,"Flags":0,"Description":"Match only the specified include paths. See also MatchScope in JsonBody."}}}},{"2":{"Name":"LoggingConfiguration_JsonBody","Properties":{"InvalidFallbackBehavior":{"Type":4,"Flags":0,"Description":"What AWS WAF should do if it fails to completely parse the JSON body."},"MatchPattern":{"Type":28,"Flags":1,"Description":"The patterns to look for in the JSON body. AWS WAF inspects the results of these pattern matches against the rule inspection criteria. "},"MatchScope":{"Type":4,"Flags":1,"Description":"The parts of the JSON to match against using the MatchPattern. If you specify All, AWS WAF matches against keys and values. "}}}},{"2":{"Name":"LoggingConfiguration_Method","Properties":{}}},{"2":{"Name":"LoggingConfiguration_QueryString","Properties":{}}},{"2":{"Name":"LoggingConfiguration_SingleHeader","Properties":{"Name":{"Type":4,"Flags":1,"Description":"The name of the query header to inspect."}}}},{"2":{"Name":"LoggingConfiguration_UriPath","Properties":{}}},{"3":{"ItemType":21}},{"2":{"Name":"AWS.WAFv2/LoggingConfigurationProperties","Properties":{"LogDestinationConfigs":{"Type":36,"Flags":1,"Description":"The Amazon Resource Names (ARNs) of the logging destinations that you want to associate with the web ACL."},"LoggingFilter":{"Type":38,"Flags":0,"Description":"Filtering that specifies which web requests are kept in the logs and which are dropped. You can filter on the rule action and on the web request labels that were applied by matching rules during web ACL evaluation."},"ManagedByFirewallManager":{"Type":2,"Flags":2,"Description":"Indicates whether the logging configuration was created by AWS Firewall Manager, as part of an AWS WAF policy configuration. If true, only Firewall Manager can modify or delete the configuration."},"RedactedFields":{"Type":39,"Flags":0,"Description":"The parts of the request that you want to keep out of the logs. For example, if you redact the HEADER field, the HEADER field in the firehose will be xxx."},"ResourceArn":{"Type":4,"Flags":17,"Description":"The Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs."}}}},{"3":{"ItemType":4}},{"3":{"ItemType":23}},{"2":{"Name":"LoggingConfiguration_LoggingFilter","Properties":{"DefaultBehavior":{"Type":4,"Flags":1,"Description":"Default handling for logs that don't match any of the specified filtering conditions."},"Filters":{"Type":37,"Flags":1,"Description":"The filters that you want to apply to the logs."}}}},{"3":{"ItemType":22}},{"2":{"Name":"AWS.WAFv2/LoggingConfiguration","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":35,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.WAFv2/LoggingConfiguration@default","ScopeType":0,"Body":40}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":0},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"AWS.WAFv2/RegexPatternSetProperties","Properties":{"Arn":{"Type":4,"Flags":2,"Description":"ARN of the WAF entity."},"Description":{"Type":4,"Flags":0,"Description":"Description of the entity."},"Id":{"Type":4,"Flags":18,"Description":"Id of the RegexPatternSet"},"Name":{"Type":4,"Flags":16,"Description":"Name of the RegexPatternSet."},"RegularExpressionList":{"Type":44,"Flags":1},"Scope":{"Type":4,"Flags":17,"Description":"Use CLOUDFRONT for CloudFront RegexPatternSet, use REGIONAL for Application Load Balancer and API Gateway."},"Tags":{"Type":45,"Flags":0}}}},{"3":{"ItemType":4}},{"3":{"ItemType":42}},{"2":{"Name":"AWS.WAFv2/RegexPatternSet","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":43,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.WAFv2/RegexPatternSet@default","ScopeType":0,"Body":46}},{"2":{"Name":"AllowAction","Properties":{"CustomRequestHandling":{"Type":64,"Flags":0}}}},{"2":{"Name":"AndStatement","Properties":{"Statements":{"Type":129,"Flags":1}}}},{"2":{"Name":"BlockAction","Properties":{"CustomResponse":{"Type":65,"Flags":0}}}},{"2":{"Name":"Body","Properties":{"OversizeHandling":{"Type":4,"Flags":0}}}},{"2":{"Name":"BodyParsingFallbackBehavior"}},{"2":{"Name":"ByteMatchStatement","Properties":{"FieldToMatch":{"Type":71,"Flags":1},"PositionalConstraint":{"Type":4,"Flags":1},"SearchString":{"Type":4,"Flags":0},"SearchStringBase64":{"Type":4,"Flags":0},"TextTransformations":{"Type":130,"Flags":1}}}},{"2":{"Name":"CaptchaAction","Properties":{"CustomRequestHandling":{"Type":64,"Flags":0}}}},{"2":{"Name":"CaptchaConfig","Properties":{"ImmunityTimeProperty":{"Type":78,"Flags":0}}}},{"2":{"Name":"ChallengeAction","Properties":{"CustomRequestHandling":{"Type":64,"Flags":0}}}},{"2":{"Name":"ChallengeConfig","Properties":{"ImmunityTimeProperty":{"Type":78,"Flags":0}}}},{"2":{"Name":"CookieMatchPattern","Properties":{"All":{"Type":131,"Flags":0,"Description":"Inspect all parts of the web request cookies."},"ExcludedCookies":{"Type":132,"Flags":0},"IncludedCookies":{"Type":133,"Flags":0}}}},{"2":{"Name":"Cookies","Properties":{"MatchPattern":{"Type":58,"Flags":1},"MatchScope":{"Type":4,"Flags":1},"OversizeHandling":{"Type":4,"Flags":1}}}},{"2":{"Name":"CountAction","Properties":{"CustomRequestHandling":{"Type":64,"Flags":0}}}},{"2":{"Name":"CustomHTTPHeader","Properties":{"Name":{"Type":4,"Flags":17},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"CustomHTTPHeaderName"}},{"2":{"Name":"CustomHTTPHeaderValue"}},{"2":{"Name":"CustomRequestHandling","Properties":{"InsertHeaders":{"Type":134,"Flags":1,"Description":"Collection of HTTP headers."}}}},{"2":{"Name":"CustomResponse","Properties":{"CustomResponseBodyKey":{"Type":4,"Flags":0,"Description":"Custom response body key."},"ResponseCode":{"Type":3,"Flags":1},"ResponseHeaders":{"Type":135,"Flags":0,"Description":"Collection of HTTP headers."}}}},{"2":{"Name":"CustomResponseBodies","Properties":{}}},{"2":{"Name":"CustomResponseBody","Properties":{"Content":{"Type":4,"Flags":1},"ContentType":{"Type":4,"Flags":1}}}},{"2":{"Name":"EntityDescription"}},{"2":{"Name":"EntityId"}},{"2":{"Name":"EntityName"}},{"2":{"Name":"FieldToMatch","Properties":{"AllQueryArguments":{"Type":136,"Flags":0,"Description":"All query arguments of a web request."},"Body":{"Type":51,"Flags":0},"Cookies":{"Type":59,"Flags":0},"Headers":{"Type":75,"Flags":0},"JsonBody":{"Type":79,"Flags":0},"Method":{"Type":137,"Flags":0,"Description":"The HTTP method of a web request. The method indicates the type of operation that the request is asking the origin to perform."},"QueryString":{"Type":138,"Flags":0,"Description":"The query string of a web request. This is the part of a URL that appears after a ? character, if any."},"SingleHeader":{"Type":139,"Flags":0},"SingleQueryArgument":{"Type":140,"Flags":0,"Description":"One query argument in a web request, identified by name, for example UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive."},"UriPath":{"Type":141,"Flags":0,"Description":"The path component of the URI of a web request. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg."}}}},{"2":{"Name":"ForwardedIPConfiguration","Properties":{"FallbackBehavior":{"Type":4,"Flags":1},"HeaderName":{"Type":4,"Flags":1}}}},{"2":{"Name":"GeoMatchStatement","Properties":{"CountryCodes":{"Type":142,"Flags":0},"ForwardedIPConfig":{"Type":72,"Flags":0}}}},{"2":{"Name":"HeaderMatchPattern","Properties":{"All":{"Type":143,"Flags":0,"Description":"Inspect all parts of the web request headers."},"ExcludedHeaders":{"Type":144,"Flags":0},"IncludedHeaders":{"Type":145,"Flags":0}}}},{"2":{"Name":"Headers","Properties":{"MatchPattern":{"Type":74,"Flags":1},"MatchScope":{"Type":4,"Flags":1},"OversizeHandling":{"Type":4,"Flags":1}}}},{"2":{"Name":"IPSetForwardedIPConfiguration","Properties":{"FallbackBehavior":{"Type":4,"Flags":1},"HeaderName":{"Type":4,"Flags":1},"Position":{"Type":4,"Flags":1}}}},{"2":{"Name":"IPSetReferenceStatement","Properties":{"Arn":{"Type":4,"Flags":1},"IPSetForwardedIPConfig":{"Type":76,"Flags":0}}}},{"2":{"Name":"ImmunityTimeProperty","Properties":{"ImmunityTime":{"Type":3,"Flags":1}}}},{"2":{"Name":"JsonBody","Properties":{"InvalidFallbackBehavior":{"Type":4,"Flags":0},"MatchPattern":{"Type":80,"Flags":1},"MatchScope":{"Type":4,"Flags":1},"OversizeHandling":{"Type":4,"Flags":0}}}},{"2":{"Name":"JsonMatchPattern","Properties":{"All":{"Type":146,"Flags":0,"Description":"Inspect all parts of the web request's JSON body."},"IncludedPaths":{"Type":147,"Flags":0}}}},{"2":{"Name":"JsonMatchScope"}},{"2":{"Name":"JsonPointerPath"}},{"2":{"Name":"Label","Properties":{"Name":{"Type":4,"Flags":17}}}},{"2":{"Name":"LabelMatchKey"}},{"2":{"Name":"LabelMatchScope"}},{"2":{"Name":"LabelMatchStatement","Properties":{"Key":{"Type":4,"Flags":1},"Scope":{"Type":4,"Flags":17}}}},{"2":{"Name":"LabelName"}},{"2":{"Name":"LabelSummary","Properties":{"Name":{"Type":4,"Flags":16}}}},{"2":{"Name":"MapMatchScope"}},{"2":{"Name":"NotStatement","Properties":{"Statement":{"Type":122,"Flags":1}}}},{"2":{"Name":"OrStatement","Properties":{"Statements":{"Type":148,"Flags":1}}}},{"2":{"Name":"OversizeHandling"}},{"2":{"Name":"PositionalConstraint"}},{"2":{"Name":"RateBasedStatement","Properties":{"AggregateKeyType":{"Type":4,"Flags":1},"CustomKeys":{"Type":149,"Flags":0,"Description":"Specifies the aggregate keys to use in a rate-base rule."},"ForwardedIPConfig":{"Type":72,"Flags":0},"Limit":{"Type":3,"Flags":1},"ScopeDownStatement":{"Type":122,"Flags":0}}}},{"2":{"Name":"RateBasedStatementCustomKey","Properties":{"Cookie":{"Type":97,"Flags":0},"ForwardedIP":{"Type":98,"Flags":0},"HTTPMethod":{"Type":99,"Flags":0},"Header":{"Type":100,"Flags":0},"IP":{"Type":101,"Flags":0},"LabelNamespace":{"Type":102,"Flags":0},"QueryArgument":{"Type":103,"Flags":0},"QueryString":{"Type":104,"Flags":0},"UriPath":{"Type":105,"Flags":0}}}},{"2":{"Name":"RateLimit"}},{"2":{"Name":"RateLimitCookie","Properties":{"Name":{"Type":4,"Flags":17,"Description":"The name of the cookie to use."},"TextTransformations":{"Type":150,"Flags":1}}}},{"2":{"Name":"RateLimitForwardedIP","Properties":{}}},{"2":{"Name":"RateLimitHTTPMethod","Properties":{}}},{"2":{"Name":"RateLimitHeader","Properties":{"Name":{"Type":4,"Flags":17,"Description":"The name of the header to use."},"TextTransformations":{"Type":151,"Flags":1}}}},{"2":{"Name":"RateLimitIP","Properties":{}}},{"2":{"Name":"RateLimitLabelNamespace","Properties":{"Namespace":{"Type":4,"Flags":1,"Description":"The namespace to use for aggregation."}}}},{"2":{"Name":"RateLimitQueryArgument","Properties":{"Name":{"Type":4,"Flags":17,"Description":"The name of the query argument to use."},"TextTransformations":{"Type":152,"Flags":1}}}},{"2":{"Name":"RateLimitQueryString","Properties":{"TextTransformations":{"Type":153,"Flags":1}}}},{"2":{"Name":"RateLimitUriPath","Properties":{"TextTransformations":{"Type":154,"Flags":1}}}},{"2":{"Name":"RegexMatchStatement","Properties":{"FieldToMatch":{"Type":71,"Flags":1},"RegexString":{"Type":4,"Flags":1},"TextTransformations":{"Type":155,"Flags":1}}}},{"2":{"Name":"RegexPatternSetReferenceStatement","Properties":{"Arn":{"Type":4,"Flags":1},"FieldToMatch":{"Type":71,"Flags":1},"TextTransformations":{"Type":156,"Flags":1}}}},{"2":{"Name":"ResourceArn"}},{"2":{"Name":"ResponseContent"}},{"2":{"Name":"ResponseContentType"}},{"2":{"Name":"ResponseStatusCode"}},{"2":{"Name":"Rule","Properties":{"Action":{"Type":113,"Flags":0},"CaptchaConfig":{"Type":55,"Flags":0},"ChallengeConfig":{"Type":57,"Flags":0},"Name":{"Type":4,"Flags":17},"Priority":{"Type":3,"Flags":1},"RuleLabels":{"Type":157,"Flags":0,"Description":"Collection of Rule Labels."},"Statement":{"Type":122,"Flags":1},"VisibilityConfig":{"Type":127,"Flags":1}}}},{"2":{"Name":"RuleAction","Properties":{"Allow":{"Type":48,"Flags":0},"Block":{"Type":50,"Flags":0},"Captcha":{"Type":54,"Flags":0},"Challenge":{"Type":56,"Flags":0},"Count":{"Type":60,"Flags":0}}}},{"2":{"Name":"RuleGroup","Properties":{"Arn":{"Type":4,"Flags":0},"Capacity":{"Type":3,"Flags":0},"Description":{"Type":4,"Flags":0},"Id":{"Type":4,"Flags":16},"Name":{"Type":4,"Flags":16},"Rules":{"Type":158,"Flags":0,"Description":"Collection of Rules."},"VisibilityConfig":{"Type":127,"Flags":0}}}},{"2":{"Name":"RulePriority"}},{"2":{"Name":"Scope"}},{"2":{"Name":"SearchString"}},{"2":{"Name":"SearchStringBase64"}},{"2":{"Name":"SensitivityLevel"}},{"2":{"Name":"SizeConstraintStatement","Properties":{"ComparisonOperator":{"Type":4,"Flags":1},"FieldToMatch":{"Type":71,"Flags":1},"Size":{"Type":3,"Flags":1},"TextTransformations":{"Type":159,"Flags":1}}}},{"2":{"Name":"SqliMatchStatement","Properties":{"FieldToMatch":{"Type":71,"Flags":1},"SensitivityLevel":{"Type":4,"Flags":0},"TextTransformations":{"Type":160,"Flags":1}}}},{"2":{"Name":"Statement","Properties":{"AndStatement":{"Type":49,"Flags":0},"ByteMatchStatement":{"Type":53,"Flags":0},"GeoMatchStatement":{"Type":73,"Flags":0},"IPSetReferenceStatement":{"Type":77,"Flags":0},"LabelMatchStatement":{"Type":86,"Flags":0},"NotStatement":{"Type":90,"Flags":0},"OrStatement":{"Type":91,"Flags":0},"RateBasedStatement":{"Type":94,"Flags":0},"RegexMatchStatement":{"Type":106,"Flags":0},"RegexPatternSetReferenceStatement":{"Type":107,"Flags":0},"SizeConstraintStatement":{"Type":120,"Flags":0},"SqliMatchStatement":{"Type":121,"Flags":0},"XssMatchStatement":{"Type":128,"Flags":0}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":0},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"TextTransformation","Properties":{"Priority":{"Type":3,"Flags":1},"Type":{"Type":4,"Flags":1}}}},{"2":{"Name":"TextTransformationPriority"}},{"2":{"Name":"TextTransformationType"}},{"2":{"Name":"VisibilityConfig","Properties":{"CloudWatchMetricsEnabled":{"Type":2,"Flags":1},"MetricName":{"Type":4,"Flags":1},"SampledRequestsEnabled":{"Type":2,"Flags":1}}}},{"2":{"Name":"XssMatchStatement","Properties":{"FieldToMatch":{"Type":71,"Flags":1},"TextTransformations":{"Type":161,"Flags":1}}}},{"3":{"ItemType":122}},{"3":{"ItemType":124}},{"2":{"Name":"RuleGroup_All","Properties":{}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":61}},{"3":{"ItemType":61}},{"2":{"Name":"RuleGroup_AllQueryArguments","Properties":{}}},{"2":{"Name":"RuleGroup_Method","Properties":{}}},{"2":{"Name":"RuleGroup_QueryString","Properties":{}}},{"2":{"Name":"RuleGroup_SingleHeader","Properties":{"Name":{"Type":4,"Flags":17}}}},{"2":{"Name":"RuleGroup_SingleQueryArgument","Properties":{"Name":{"Type":4,"Flags":17}}}},{"2":{"Name":"RuleGroup_UriPath","Properties":{}}},{"3":{"ItemType":4}},{"2":{"Name":"RuleGroup_All","Properties":{}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"RuleGroup_All","Properties":{}}},{"3":{"ItemType":4}},{"3":{"ItemType":122}},{"3":{"ItemType":95}},{"3":{"ItemType":124}},{"3":{"ItemType":124}},{"3":{"ItemType":124}},{"3":{"ItemType":124}},{"3":{"ItemType":124}},{"3":{"ItemType":124}},{"3":{"ItemType":124}},{"3":{"ItemType":83}},{"3":{"ItemType":112}},{"3":{"ItemType":124}},{"3":{"ItemType":124}},{"3":{"ItemType":124}},{"2":{"Name":"AWS.WAFv2/RuleGroupProperties","Properties":{"Arn":{"Type":4,"Flags":2},"AvailableLabels":{"Type":163,"Flags":2,"Description":"Collection of Available Labels."},"Capacity":{"Type":3,"Flags":1},"ConsumedLabels":{"Type":164,"Flags":2,"Description":"Collection of Consumed Labels."},"CustomResponseBodies":{"Type":66,"Flags":0},"Description":{"Type":4,"Flags":0},"Id":{"Type":4,"Flags":18},"LabelNamespace":{"Type":4,"Flags":2},"Name":{"Type":4,"Flags":16},"Rules":{"Type":165,"Flags":0,"Description":"Collection of Rules."},"Scope":{"Type":4,"Flags":17},"Tags":{"Type":166,"Flags":0},"VisibilityConfig":{"Type":127,"Flags":1}}}},{"3":{"ItemType":88}},{"3":{"ItemType":88}},{"3":{"ItemType":112}},{"3":{"ItemType":123}},{"2":{"Name":"AWS.WAFv2/RuleGroup","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":162,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.WAFv2/RuleGroup@default","ScopeType":0,"Body":167}},{"2":{"Name":"AWSManagedRulesACFPRuleSet","Properties":{"CreationPath":{"Type":4,"Flags":1},"EnableRegexInPath":{"Type":2,"Flags":0},"RegistrationPagePath":{"Type":4,"Flags":1},"RequestInspection":{"Type":245,"Flags":1},"ResponseInspection":{"Type":249,"Flags":0}}}},{"2":{"Name":"AWSManagedRulesATPRuleSet","Properties":{"EnableRegexInPath":{"Type":2,"Flags":0},"LoginPath":{"Type":4,"Flags":1},"RequestInspection":{"Type":244,"Flags":0},"ResponseInspection":{"Type":249,"Flags":0}}}},{"2":{"Name":"AWSManagedRulesBotControlRuleSet","Properties":{"EnableMachineLearning":{"Type":2,"Flags":0},"InspectionLevel":{"Type":4,"Flags":1}}}},{"2":{"Name":"AddressField"}},{"2":{"Name":"AllowAction","Properties":{"CustomRequestHandling":{"Type":190,"Flags":0}}}},{"2":{"Name":"AndStatement","Properties":{"Statements":{"Type":279,"Flags":1}}}},{"2":{"Name":"AssociationConfig","Properties":{"RequestBody":{"Type":242,"Flags":0}}}},{"2":{"Name":"BlockAction","Properties":{"CustomResponse":{"Type":191,"Flags":0}}}},{"2":{"Name":"Body","Properties":{"OversizeHandling":{"Type":4,"Flags":0}}}},{"2":{"Name":"BodyParsingFallbackBehavior"}},{"2":{"Name":"ByteMatchStatement","Properties":{"FieldToMatch":{"Type":201,"Flags":1},"PositionalConstraint":{"Type":4,"Flags":1},"SearchString":{"Type":4,"Flags":0},"SearchStringBase64":{"Type":4,"Flags":0},"TextTransformations":{"Type":280,"Flags":1}}}},{"2":{"Name":"CaptchaAction","Properties":{"CustomRequestHandling":{"Type":190,"Flags":0}}}},{"2":{"Name":"CaptchaConfig","Properties":{"ImmunityTimeProperty":{"Type":208,"Flags":0}}}},{"2":{"Name":"ChallengeAction","Properties":{"CustomRequestHandling":{"Type":190,"Flags":0}}}},{"2":{"Name":"ChallengeConfig","Properties":{"ImmunityTimeProperty":{"Type":208,"Flags":0}}}},{"2":{"Name":"CookieMatchPattern","Properties":{"All":{"Type":281,"Flags":0,"Description":"Inspect all parts of the web request cookies."},"ExcludedCookies":{"Type":282,"Flags":0},"IncludedCookies":{"Type":283,"Flags":0}}}},{"2":{"Name":"Cookies","Properties":{"MatchPattern":{"Type":184,"Flags":1},"MatchScope":{"Type":4,"Flags":1},"OversizeHandling":{"Type":4,"Flags":1}}}},{"2":{"Name":"CountAction","Properties":{"CustomRequestHandling":{"Type":190,"Flags":0}}}},{"2":{"Name":"CustomHTTPHeader","Properties":{"Name":{"Type":4,"Flags":17},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"CustomHTTPHeaderName"}},{"2":{"Name":"CustomHTTPHeaderValue"}},{"2":{"Name":"CustomRequestHandling","Properties":{"InsertHeaders":{"Type":284,"Flags":1,"Description":"Collection of HTTP headers."}}}},{"2":{"Name":"CustomResponse","Properties":{"CustomResponseBodyKey":{"Type":4,"Flags":0,"Description":"Custom response body key."},"ResponseCode":{"Type":3,"Flags":1},"ResponseHeaders":{"Type":285,"Flags":0,"Description":"Collection of HTTP headers."}}}},{"2":{"Name":"CustomResponseBodies","Properties":{}}},{"2":{"Name":"CustomResponseBody","Properties":{"Content":{"Type":4,"Flags":1},"ContentType":{"Type":4,"Flags":1}}}},{"2":{"Name":"DefaultAction","Properties":{"Allow":{"Type":173,"Flags":0},"Block":{"Type":176,"Flags":0}}}},{"2":{"Name":"EntityDescription"}},{"2":{"Name":"EntityId"}},{"2":{"Name":"EntityName"}},{"2":{"Name":"ExcludedRule","Properties":{"Name":{"Type":4,"Flags":17}}}},{"2":{"Name":"ExcludedRules"}},{"2":{"Name":"FieldIdentifier","Properties":{"Identifier":{"Type":4,"Flags":1}}}},{"2":{"Name":"FieldToMatch","Properties":{"AllQueryArguments":{"Type":287,"Flags":0,"Description":"All query arguments of a web request."},"Body":{"Type":177,"Flags":0},"Cookies":{"Type":185,"Flags":0},"Headers":{"Type":205,"Flags":0},"JsonBody":{"Type":209,"Flags":0},"Method":{"Type":288,"Flags":0,"Description":"The HTTP method of a web request. The method indicates the type of operation that the request is asking the origin to perform."},"QueryString":{"Type":289,"Flags":0,"Description":"The query string of a web request. This is the part of a URL that appears after a ? character, if any."},"SingleHeader":{"Type":290,"Flags":0},"SingleQueryArgument":{"Type":291,"Flags":0,"Description":"One query argument in a web request, identified by name, for example UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive."},"UriPath":{"Type":292,"Flags":0,"Description":"The path component of the URI of a web request. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg."}}}},{"2":{"Name":"ForwardedIPConfiguration","Properties":{"FallbackBehavior":{"Type":4,"Flags":1},"HeaderName":{"Type":4,"Flags":1}}}},{"2":{"Name":"GeoMatchStatement","Properties":{"CountryCodes":{"Type":293,"Flags":0},"ForwardedIPConfig":{"Type":202,"Flags":0}}}},{"2":{"Name":"HeaderMatchPattern","Properties":{"All":{"Type":294,"Flags":0,"Description":"Inspect all parts of the web request headers."},"ExcludedHeaders":{"Type":295,"Flags":0},"IncludedHeaders":{"Type":296,"Flags":0}}}},{"2":{"Name":"Headers","Properties":{"MatchPattern":{"Type":204,"Flags":1},"MatchScope":{"Type":4,"Flags":1},"OversizeHandling":{"Type":4,"Flags":1}}}},{"2":{"Name":"IPSetForwardedIPConfiguration","Properties":{"FallbackBehavior":{"Type":4,"Flags":1},"HeaderName":{"Type":4,"Flags":1},"Position":{"Type":4,"Flags":1}}}},{"2":{"Name":"IPSetReferenceStatement","Properties":{"Arn":{"Type":4,"Flags":1},"IPSetForwardedIPConfig":{"Type":206,"Flags":0}}}},{"2":{"Name":"ImmunityTimeProperty","Properties":{"ImmunityTime":{"Type":3,"Flags":1}}}},{"2":{"Name":"JsonBody","Properties":{"InvalidFallbackBehavior":{"Type":4,"Flags":0},"MatchPattern":{"Type":210,"Flags":1},"MatchScope":{"Type":4,"Flags":1},"OversizeHandling":{"Type":4,"Flags":0}}}},{"2":{"Name":"JsonMatchPattern","Properties":{"All":{"Type":297,"Flags":0,"Description":"Inspect all parts of the web request's JSON body."},"IncludedPaths":{"Type":298,"Flags":0}}}},{"2":{"Name":"JsonMatchScope"}},{"2":{"Name":"JsonPointerPath"}},{"2":{"Name":"Label","Properties":{"Name":{"Type":4,"Flags":17}}}},{"2":{"Name":"LabelMatchKey"}},{"2":{"Name":"LabelMatchScope"}},{"2":{"Name":"LabelMatchStatement","Properties":{"Key":{"Type":4,"Flags":1},"Scope":{"Type":4,"Flags":17}}}},{"2":{"Name":"LabelName"}},{"2":{"Name":"ManagedRuleGroupConfig","Properties":{"AWSManagedRulesACFPRuleSet":{"Type":169,"Flags":0},"AWSManagedRulesATPRuleSet":{"Type":170,"Flags":0},"AWSManagedRulesBotControlRuleSet":{"Type":171,"Flags":0},"LoginPath":{"Type":4,"Flags":0},"PasswordField":{"Type":200,"Flags":0},"PayloadType":{"Type":4,"Flags":0},"UsernameField":{"Type":200,"Flags":0}}}},{"2":{"Name":"ManagedRuleGroupStatement","Properties":{"ExcludedRules":{"Type":299,"Flags":0},"ManagedRuleGroupConfigs":{"Type":300,"Flags":0,"Description":"Collection of ManagedRuleGroupConfig."},"Name":{"Type":4,"Flags":17},"RuleActionOverrides":{"Type":301,"Flags":0,"Description":"Action overrides for rules in the rule group."},"ScopeDownStatement":{"Type":270,"Flags":0},"VendorName":{"Type":4,"Flags":1},"Version":{"Type":4,"Flags":0}}}},{"2":{"Name":"MapMatchScope"}},{"2":{"Name":"NotStatement","Properties":{"Statement":{"Type":270,"Flags":1}}}},{"2":{"Name":"OrStatement","Properties":{"Statements":{"Type":302,"Flags":1}}}},{"2":{"Name":"OverrideAction","Properties":{"Count":{"Type":303,"Flags":0,"Description":"Count traffic towards application."},"None":{"Type":304,"Flags":0,"Description":"Keep the RuleGroup or ManagedRuleGroup behavior as is."}}}},{"2":{"Name":"OversizeHandling"}},{"2":{"Name":"PhoneNumberField"}},{"2":{"Name":"PositionalConstraint"}},{"2":{"Name":"QueryString","Properties":{}}},{"2":{"Name":"RateBasedStatement","Properties":{"AggregateKeyType":{"Type":4,"Flags":1},"CustomKeys":{"Type":305,"Flags":0,"Description":"Specifies the aggregate keys to use in a rate-base rule."},"ForwardedIPConfig":{"Type":202,"Flags":0},"Limit":{"Type":3,"Flags":1},"ScopeDownStatement":{"Type":270,"Flags":0}}}},{"2":{"Name":"RateBasedStatementCustomKey","Properties":{"Cookie":{"Type":231,"Flags":0},"ForwardedIP":{"Type":232,"Flags":0},"HTTPMethod":{"Type":233,"Flags":0},"Header":{"Type":234,"Flags":0},"IP":{"Type":235,"Flags":0},"LabelNamespace":{"Type":236,"Flags":0},"QueryArgument":{"Type":237,"Flags":0},"QueryString":{"Type":238,"Flags":0},"UriPath":{"Type":239,"Flags":0}}}},{"2":{"Name":"RateLimit"}},{"2":{"Name":"RateLimitCookie","Properties":{"Name":{"Type":4,"Flags":17,"Description":"The name of the cookie to use."},"TextTransformations":{"Type":306,"Flags":1}}}},{"2":{"Name":"RateLimitForwardedIP","Properties":{}}},{"2":{"Name":"RateLimitHTTPMethod","Properties":{}}},{"2":{"Name":"RateLimitHeader","Properties":{"Name":{"Type":4,"Flags":17,"Description":"The name of the header to use."},"TextTransformations":{"Type":307,"Flags":1}}}},{"2":{"Name":"RateLimitIP","Properties":{}}},{"2":{"Name":"RateLimitLabelNamespace","Properties":{"Namespace":{"Type":4,"Flags":1,"Description":"The namespace to use for aggregation."}}}},{"2":{"Name":"RateLimitQueryArgument","Properties":{"Name":{"Type":4,"Flags":17,"Description":"The name of the query argument to use."},"TextTransformations":{"Type":308,"Flags":1}}}},{"2":{"Name":"RateLimitQueryString","Properties":{"TextTransformations":{"Type":309,"Flags":1}}}},{"2":{"Name":"RateLimitUriPath","Properties":{"TextTransformations":{"Type":310,"Flags":1}}}},{"2":{"Name":"RegexMatchStatement","Properties":{"FieldToMatch":{"Type":201,"Flags":1},"RegexString":{"Type":4,"Flags":1},"TextTransformations":{"Type":311,"Flags":1}}}},{"2":{"Name":"RegexPatternSetReferenceStatement","Properties":{"Arn":{"Type":4,"Flags":1},"FieldToMatch":{"Type":201,"Flags":1},"TextTransformations":{"Type":312,"Flags":1}}}},{"2":{"Name":"RequestBody","Properties":{}}},{"2":{"Name":"RequestBodyAssociatedResourceTypeConfig","Properties":{"DefaultSizeInspectionLimit":{"Type":4,"Flags":1}}}},{"2":{"Name":"RequestInspection","Properties":{"PasswordField":{"Type":200,"Flags":1},"PayloadType":{"Type":4,"Flags":1},"UsernameField":{"Type":200,"Flags":1}}}},{"2":{"Name":"RequestInspectionACFP","Properties":{"AddressFields":{"Type":314,"Flags":0},"EmailField":{"Type":200,"Flags":0},"PasswordField":{"Type":200,"Flags":0},"PayloadType":{"Type":4,"Flags":1},"PhoneNumberFields":{"Type":316,"Flags":0},"UsernameField":{"Type":200,"Flags":0}}}},{"2":{"Name":"ResourceArn"}},{"2":{"Name":"ResponseContent"}},{"2":{"Name":"ResponseContentType"}},{"2":{"Name":"ResponseInspection","Properties":{"BodyContains":{"Type":250,"Flags":0},"Header":{"Type":251,"Flags":0},"Json":{"Type":252,"Flags":0},"StatusCode":{"Type":253,"Flags":0}}}},{"2":{"Name":"ResponseInspectionBodyContains","Properties":{"FailureStrings":{"Type":317,"Flags":1},"SuccessStrings":{"Type":318,"Flags":1}}}},{"2":{"Name":"ResponseInspectionHeader","Properties":{"FailureValues":{"Type":319,"Flags":1},"Name":{"Type":4,"Flags":17},"SuccessValues":{"Type":320,"Flags":1}}}},{"2":{"Name":"ResponseInspectionJson","Properties":{"FailureValues":{"Type":321,"Flags":1},"Identifier":{"Type":4,"Flags":1},"SuccessValues":{"Type":322,"Flags":1}}}},{"2":{"Name":"ResponseInspectionStatusCode","Properties":{"FailureCodes":{"Type":323,"Flags":1},"SuccessCodes":{"Type":324,"Flags":1}}}},{"2":{"Name":"ResponseStatusCode"}},{"2":{"Name":"Rule","Properties":{"Action":{"Type":256,"Flags":0},"CaptchaConfig":{"Type":181,"Flags":0},"ChallengeConfig":{"Type":183,"Flags":0},"Name":{"Type":4,"Flags":17},"OverrideAction":{"Type":223,"Flags":0},"Priority":{"Type":3,"Flags":1},"RuleLabels":{"Type":325,"Flags":0,"Description":"Collection of Rule Labels."},"Statement":{"Type":270,"Flags":1},"VisibilityConfig":{"Type":277,"Flags":1}}}},{"2":{"Name":"RuleAction","Properties":{"Allow":{"Type":173,"Flags":0},"Block":{"Type":176,"Flags":0},"Captcha":{"Type":180,"Flags":0},"Challenge":{"Type":182,"Flags":0},"Count":{"Type":186,"Flags":0}}}},{"2":{"Name":"RuleActionOverride","Properties":{"ActionToUse":{"Type":256,"Flags":1},"Name":{"Type":4,"Flags":17}}}},{"2":{"Name":"RuleGroupReferenceStatement","Properties":{"Arn":{"Type":4,"Flags":1},"ExcludedRules":{"Type":326,"Flags":0},"RuleActionOverrides":{"Type":327,"Flags":0,"Description":"Action overrides for rules in the rule group."}}}},{"2":{"Name":"RulePriority"}},{"2":{"Name":"Rules"}},{"2":{"Name":"Scope"}},{"2":{"Name":"SearchString"}},{"2":{"Name":"SearchStringBase64"}},{"2":{"Name":"SensitivityLevel"}},{"2":{"Name":"SingleHeader","Properties":{"Name":{"Type":4,"Flags":16}}}},{"2":{"Name":"SingleQueryArgument","Properties":{"Name":{"Type":4,"Flags":16}}}},{"2":{"Name":"SizeConstraintStatement","Properties":{"ComparisonOperator":{"Type":4,"Flags":1},"FieldToMatch":{"Type":201,"Flags":1},"Size":{"Type":3,"Flags":1},"TextTransformations":{"Type":329,"Flags":1}}}},{"2":{"Name":"SizeInspectionLimit"}},{"2":{"Name":"SqliMatchStatement","Properties":{"FieldToMatch":{"Type":201,"Flags":1},"SensitivityLevel":{"Type":4,"Flags":0},"TextTransformations":{"Type":330,"Flags":1}}}},{"2":{"Name":"Statement","Properties":{"AndStatement":{"Type":174,"Flags":0},"ByteMatchStatement":{"Type":179,"Flags":0},"GeoMatchStatement":{"Type":203,"Flags":0},"IPSetReferenceStatement":{"Type":207,"Flags":0},"LabelMatchStatement":{"Type":216,"Flags":0},"ManagedRuleGroupStatement":{"Type":219,"Flags":0},"NotStatement":{"Type":221,"Flags":0},"OrStatement":{"Type":222,"Flags":0},"RateBasedStatement":{"Type":228,"Flags":0},"RegexMatchStatement":{"Type":240,"Flags":0},"RegexPatternSetReferenceStatement":{"Type":241,"Flags":0},"RuleGroupReferenceStatement":{"Type":258,"Flags":0},"SizeConstraintStatement":{"Type":267,"Flags":0},"SqliMatchStatement":{"Type":269,"Flags":0},"XssMatchStatement":{"Type":278,"Flags":0}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":0},"Value":{"Type":4,"Flags":0}}}},{"2":{"Name":"TextTransformation","Properties":{"Priority":{"Type":3,"Flags":1},"Type":{"Type":4,"Flags":1}}}},{"2":{"Name":"TextTransformationPriority"}},{"2":{"Name":"TextTransformationType"}},{"2":{"Name":"TokenDomains"}},{"2":{"Name":"UriPath","Properties":{}}},{"2":{"Name":"VisibilityConfig","Properties":{"CloudWatchMetricsEnabled":{"Type":2,"Flags":1},"MetricName":{"Type":4,"Flags":1},"SampledRequestsEnabled":{"Type":2,"Flags":1}}}},{"2":{"Name":"XssMatchStatement","Properties":{"FieldToMatch":{"Type":201,"Flags":1},"TextTransformations":{"Type":332,"Flags":1}}}},{"3":{"ItemType":270}},{"3":{"ItemType":272}},{"2":{"Name":"WebACL_All","Properties":{}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":187}},{"3":{"ItemType":187}},{"3":{"ItemType":198}},{"2":{"Name":"WebACL_AllQueryArguments","Properties":{}}},{"2":{"Name":"WebACL_Method","Properties":{}}},{"2":{"Name":"WebACL_QueryString","Properties":{}}},{"2":{"Name":"WebACL_SingleHeader","Properties":{"Name":{"Type":4,"Flags":17}}}},{"2":{"Name":"WebACL_SingleQueryArgument","Properties":{"Name":{"Type":4,"Flags":17}}}},{"2":{"Name":"WebACL_UriPath","Properties":{}}},{"3":{"ItemType":4}},{"2":{"Name":"WebACL_All","Properties":{}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"2":{"Name":"WebACL_All","Properties":{}}},{"3":{"ItemType":4}},{"3":{"ItemType":198}},{"3":{"ItemType":218}},{"3":{"ItemType":257}},{"3":{"ItemType":270}},{"2":{"Name":"WebACL_Count","Properties":{}}},{"2":{"Name":"WebACL_None","Properties":{}}},{"3":{"ItemType":229}},{"3":{"ItemType":272}},{"3":{"ItemType":272}},{"3":{"ItemType":272}},{"3":{"ItemType":272}},{"3":{"ItemType":272}},{"3":{"ItemType":272}},{"3":{"ItemType":272}},{"2":{"Name":"WebACL_AddressField","Properties":{}}},{"3":{"ItemType":313}},{"2":{"Name":"WebACL_PhoneNumberField","Properties":{}}},{"3":{"ItemType":315}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":3}},{"3":{"ItemType":3}},{"3":{"ItemType":213}},{"3":{"ItemType":198}},{"3":{"ItemType":257}},{"3":{"ItemType":255}},{"3":{"ItemType":272}},{"3":{"ItemType":272}},{"3":{"ItemType":4}},{"3":{"ItemType":272}},{"2":{"Name":"AWS.WAFv2/WebACLProperties","Properties":{"Arn":{"Type":4,"Flags":2},"AssociationConfig":{"Type":175,"Flags":0},"Capacity":{"Type":3,"Flags":2},"CaptchaConfig":{"Type":181,"Flags":0},"ChallengeConfig":{"Type":183,"Flags":0},"CustomResponseBodies":{"Type":192,"Flags":0},"DefaultAction":{"Type":194,"Flags":1},"Description":{"Type":4,"Flags":0},"Id":{"Type":4,"Flags":18},"LabelNamespace":{"Type":4,"Flags":2},"Name":{"Type":4,"Flags":16},"Rules":{"Type":334,"Flags":0,"Description":"Collection of Rules."},"Scope":{"Type":4,"Flags":17},"Tags":{"Type":335,"Flags":0},"TokenDomains":{"Type":336,"Flags":0},"VisibilityConfig":{"Type":277,"Flags":1}}}},{"3":{"ItemType":255}},{"3":{"ItemType":271}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.WAFv2/WebACL","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":333,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.WAFv2/WebACL@default","ScopeType":0,"Body":337}},{"2":{"Name":"ResourceArn"}},{"2":{"Name":"AWS.WAFv2/WebACLAssociationProperties","Properties":{"ResourceArn":{"Type":4,"Flags":17},"WebACLArn":{"Type":4,"Flags":17}}}},{"2":{"Name":"AWS.WAFv2/WebACLAssociation","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":340,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.WAFv2/WebACLAssociation@default","ScopeType":0,"Body":341}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "EntityDescription", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "EntityId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "EntityName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "IPAddress", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "IPAddressVersion", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ResourceArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Scope", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.WAFv2/IPSetProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/8" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/7" + } + }, + { + "$type": "ObjectType", + "name": "AWS.WAFv2/IPSetProperties", + "properties": { + "Addresses": { + "type": { + "$ref": "#/10" + }, + "flags": 1, + "description": "List of IPAddresses." + }, + "Arn": { + "type": { + "$ref": "#/8" + }, + "flags": 2 + }, + "Description": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "IPAddressVersion": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + }, + "Id": { + "type": { + "$ref": "#/8" + }, + "flags": 18 + }, + "Name": { + "type": { + "$ref": "#/8" + }, + "flags": 16 + }, + "Scope": { + "type": { + "$ref": "#/8" + }, + "flags": 17 + }, + "Tags": { + "type": { + "$ref": "#/11" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.WAFv2/IPSet", + "properties": { + "name": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/8" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/12" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.WAFv2/IPSet@default", + "scopeType": 0, + "body": { + "$ref": "#/13" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Condition", + "properties": { + "ActionCondition": { + "type": { + "$ref": "#/18" + }, + "flags": 0, + "description": "A single action condition." + }, + "LabelNameCondition": { + "type": { + "$ref": "#/19" + }, + "flags": 0, + "description": "A single label name condition." + } + } + }, + { + "$type": "ObjectType", + "name": "FieldToMatch", + "properties": { + "Method": { + "type": { + "$ref": "#/20" + }, + "flags": 0, + "description": "Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform. " + }, + "QueryString": { + "type": { + "$ref": "#/21" + }, + "flags": 0, + "description": "Inspect the query string. This is the part of a URL that appears after a ? character, if any. " + }, + "SingleHeader": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive." + }, + "UriPath": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg. " + } + } + }, + { + "$type": "ObjectType", + "name": "Filter", + "properties": { + "Behavior": { + "type": { + "$ref": "#/8" + }, + "flags": 1, + "description": "How to handle logs that satisfy the filter's conditions and requirement. " + }, + "Conditions": { + "type": { + "$ref": "#/24" + }, + "flags": 1, + "description": "Match conditions for the filter." + }, + "Requirement": { + "type": { + "$ref": "#/8" + }, + "flags": 1, + "description": "Logic to apply to the filtering conditions. You can specify that, in order to satisfy the filter, a log must match all conditions or must match at least one condition." + } + } + }, + { + "$type": "ObjectType", + "name": "LoggingConfiguration_ActionCondition", + "properties": { + "Action": { + "type": { + "$ref": "#/8" + }, + "flags": 1, + "description": "Logic to apply to the filtering conditions. You can specify that, in order to satisfy the filter, a log must match all conditions or must match at least one condition." + } + } + }, + { + "$type": "ObjectType", + "name": "LoggingConfiguration_LabelNameCondition", + "properties": { + "LabelName": { + "type": { + "$ref": "#/8" + }, + "flags": 1, + "description": "The label name that a log record must contain in order to meet the condition. This must be a fully qualified label name. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label. " + } + } + }, + { + "$type": "ObjectType", + "name": "LoggingConfiguration_Method", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LoggingConfiguration_QueryString", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LoggingConfiguration_SingleHeader", + "properties": { + "Name": { + "type": { + "$ref": "#/8" + }, + "flags": 1, + "description": "The name of the query header to inspect." + } + } + }, + { + "$type": "ObjectType", + "name": "LoggingConfiguration_UriPath", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/15" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.WAFv2/LoggingConfigurationProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/8" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/17" + } + }, + { + "$type": "ObjectType", + "name": "LoggingConfiguration_LoggingFilter", + "properties": { + "DefaultBehavior": { + "type": { + "$ref": "#/8" + }, + "flags": 1, + "description": "Default handling for logs that don't match any of the specified filtering conditions." + }, + "Filters": { + "type": { + "$ref": "#/27" + }, + "flags": 1, + "description": "The filters that you want to apply to the logs." + } + } + }, + { + "$type": "BooleanType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/16" + } + }, + { + "$type": "ObjectType", + "name": "AWS.WAFv2/LoggingConfigurationProperties", + "properties": { + "LogDestinationConfigs": { + "type": { + "$ref": "#/26" + }, + "flags": 1, + "description": "The Amazon Resource Names (ARNs) of the logging destinations that you want to associate with the web ACL." + }, + "LoggingFilter": { + "type": { + "$ref": "#/28" + }, + "flags": 0, + "description": "Filtering that specifies which web requests are kept in the logs and which are dropped. You can filter on the rule action and on the web request labels that were applied by matching rules during web ACL evaluation." + }, + "ManagedByFirewallManager": { + "type": { + "$ref": "#/29" + }, + "flags": 2, + "description": "Indicates whether the logging configuration was created by AWS Firewall Manager, as part of an AWS WAF policy configuration. If true, only Firewall Manager can modify or delete the configuration." + }, + "RedactedFields": { + "type": { + "$ref": "#/30" + }, + "flags": 0, + "description": "The parts of the request that you want to keep out of the logs. For example, if you redact the HEADER field, the HEADER field in the firehose will be xxx." + }, + "ResourceArn": { + "type": { + "$ref": "#/8" + }, + "flags": 17, + "description": "The Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.WAFv2/LoggingConfiguration", + "properties": { + "name": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/8" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/31" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.WAFv2/LoggingConfiguration@default", + "scopeType": 0, + "body": { + "$ref": "#/32" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.WAFv2/RegexPatternSetProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/8" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/34" + } + }, + { + "$type": "ObjectType", + "name": "AWS.WAFv2/RegexPatternSetProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/8" + }, + "flags": 2, + "description": "ARN of the WAF entity." + }, + "Description": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "Description of the entity." + }, + "Id": { + "type": { + "$ref": "#/8" + }, + "flags": 18, + "description": "Id of the RegexPatternSet" + }, + "Name": { + "type": { + "$ref": "#/8" + }, + "flags": 16, + "description": "Name of the RegexPatternSet." + }, + "RegularExpressionList": { + "type": { + "$ref": "#/36" + }, + "flags": 1 + }, + "Scope": { + "type": { + "$ref": "#/8" + }, + "flags": 17, + "description": "Use CLOUDFRONT for CloudFront RegexPatternSet, use REGIONAL for Application Load Balancer and API Gateway." + }, + "Tags": { + "type": { + "$ref": "#/37" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.WAFv2/RegexPatternSet", + "properties": { + "name": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/8" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/38" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.WAFv2/RegexPatternSet@default", + "scopeType": 0, + "body": { + "$ref": "#/39" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AllowAction", + "properties": { + "CustomRequestHandling": { + "type": { + "$ref": "#/57" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AndStatement", + "properties": { + "Statements": { + "type": { + "$ref": "#/124" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "BlockAction", + "properties": { + "CustomResponse": { + "type": { + "$ref": "#/58" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Body", + "properties": { + "OversizeHandling": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BodyParsingFallbackBehavior", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ByteMatchStatement", + "properties": { + "FieldToMatch": { + "type": { + "$ref": "#/65" + }, + "flags": 1 + }, + "PositionalConstraint": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + }, + "SearchString": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "SearchStringBase64": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "TextTransformations": { + "type": { + "$ref": "#/125" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CaptchaAction", + "properties": { + "CustomRequestHandling": { + "type": { + "$ref": "#/57" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CaptchaConfig", + "properties": { + "ImmunityTimeProperty": { + "type": { + "$ref": "#/72" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ChallengeAction", + "properties": { + "CustomRequestHandling": { + "type": { + "$ref": "#/57" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ChallengeConfig", + "properties": { + "ImmunityTimeProperty": { + "type": { + "$ref": "#/72" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CookieMatchPattern", + "properties": { + "All": { + "type": { + "$ref": "#/126" + }, + "flags": 0, + "description": "Inspect all parts of the web request cookies." + }, + "ExcludedCookies": { + "type": { + "$ref": "#/127" + }, + "flags": 0 + }, + "IncludedCookies": { + "type": { + "$ref": "#/128" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Cookies", + "properties": { + "MatchPattern": { + "type": { + "$ref": "#/51" + }, + "flags": 1 + }, + "MatchScope": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + }, + "OversizeHandling": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CountAction", + "properties": { + "CustomRequestHandling": { + "type": { + "$ref": "#/57" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomHTTPHeader", + "properties": { + "Name": { + "type": { + "$ref": "#/8" + }, + "flags": 17 + }, + "Value": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomHTTPHeaderName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CustomHTTPHeaderValue", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CustomRequestHandling", + "properties": { + "InsertHeaders": { + "type": { + "$ref": "#/129" + }, + "flags": 1, + "description": "Collection of HTTP headers." + } + } + }, + { + "$type": "ObjectType", + "name": "CustomResponse", + "properties": { + "CustomResponseBodyKey": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "Custom response body key." + }, + "ResponseCode": { + "type": { + "$ref": "#/130" + }, + "flags": 1 + }, + "ResponseHeaders": { + "type": { + "$ref": "#/131" + }, + "flags": 0, + "description": "Collection of HTTP headers." + } + } + }, + { + "$type": "ObjectType", + "name": "CustomResponseBodies", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CustomResponseBody", + "properties": { + "Content": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + }, + "ContentType": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "EntityDescription", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "EntityId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "EntityName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "EvaluationWindowSec", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "FieldToMatch", + "properties": { + "AllQueryArguments": { + "type": { + "$ref": "#/132" + }, + "flags": 0, + "description": "All query arguments of a web request." + }, + "Body": { + "type": { + "$ref": "#/44" + }, + "flags": 0 + }, + "Cookies": { + "type": { + "$ref": "#/52" + }, + "flags": 0 + }, + "Headers": { + "type": { + "$ref": "#/69" + }, + "flags": 0 + }, + "JA3Fingerprint": { + "type": { + "$ref": "#/73" + }, + "flags": 0 + }, + "JsonBody": { + "type": { + "$ref": "#/74" + }, + "flags": 0 + }, + "Method": { + "type": { + "$ref": "#/133" + }, + "flags": 0, + "description": "The HTTP method of a web request. The method indicates the type of operation that the request is asking the origin to perform." + }, + "QueryString": { + "type": { + "$ref": "#/134" + }, + "flags": 0, + "description": "The query string of a web request. This is the part of a URL that appears after a ? character, if any." + }, + "SingleHeader": { + "type": { + "$ref": "#/135" + }, + "flags": 0 + }, + "SingleQueryArgument": { + "type": { + "$ref": "#/136" + }, + "flags": 0, + "description": "One query argument in a web request, identified by name, for example UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive." + }, + "UriPath": { + "type": { + "$ref": "#/137" + }, + "flags": 0, + "description": "The path component of the URI of a web request. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg." + } + } + }, + { + "$type": "ObjectType", + "name": "ForwardedIPConfiguration", + "properties": { + "FallbackBehavior": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + }, + "HeaderName": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "GeoMatchStatement", + "properties": { + "CountryCodes": { + "type": { + "$ref": "#/138" + }, + "flags": 0 + }, + "ForwardedIPConfig": { + "type": { + "$ref": "#/66" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "HeaderMatchPattern", + "properties": { + "All": { + "type": { + "$ref": "#/139" + }, + "flags": 0, + "description": "Inspect all parts of the web request headers." + }, + "ExcludedHeaders": { + "type": { + "$ref": "#/140" + }, + "flags": 0 + }, + "IncludedHeaders": { + "type": { + "$ref": "#/141" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Headers", + "properties": { + "MatchPattern": { + "type": { + "$ref": "#/68" + }, + "flags": 1 + }, + "MatchScope": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + }, + "OversizeHandling": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "IPSetForwardedIPConfiguration", + "properties": { + "FallbackBehavior": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + }, + "HeaderName": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + }, + "Position": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "IPSetReferenceStatement", + "properties": { + "Arn": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + }, + "IPSetForwardedIPConfig": { + "type": { + "$ref": "#/70" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ImmunityTimeProperty", + "properties": { + "ImmunityTime": { + "type": { + "$ref": "#/130" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "JA3Fingerprint", + "properties": { + "FallbackBehavior": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "JsonBody", + "properties": { + "InvalidFallbackBehavior": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "MatchPattern": { + "type": { + "$ref": "#/75" + }, + "flags": 1 + }, + "MatchScope": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + }, + "OversizeHandling": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "JsonMatchPattern", + "properties": { + "All": { + "type": { + "$ref": "#/142" + }, + "flags": 0, + "description": "Inspect all parts of the web request's JSON body." + }, + "IncludedPaths": { + "type": { + "$ref": "#/143" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "JsonMatchScope", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "JsonPointerPath", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Label", + "properties": { + "Name": { + "type": { + "$ref": "#/8" + }, + "flags": 17 + } + } + }, + { + "$type": "ObjectType", + "name": "LabelMatchKey", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LabelMatchScope", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LabelMatchStatement", + "properties": { + "Key": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + }, + "Scope": { + "type": { + "$ref": "#/8" + }, + "flags": 17 + } + } + }, + { + "$type": "ObjectType", + "name": "LabelName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LabelSummary", + "properties": { + "Name": { + "type": { + "$ref": "#/8" + }, + "flags": 16 + } + } + }, + { + "$type": "ObjectType", + "name": "MapMatchScope", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "NotStatement", + "properties": { + "Statement": { + "type": { + "$ref": "#/117" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "OrStatement", + "properties": { + "Statements": { + "type": { + "$ref": "#/144" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "OversizeHandling", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PositionalConstraint", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RateBasedStatement", + "properties": { + "AggregateKeyType": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + }, + "CustomKeys": { + "type": { + "$ref": "#/145" + }, + "flags": 0, + "description": "Specifies the aggregate keys to use in a rate-base rule." + }, + "EvaluationWindowSec": { + "type": { + "$ref": "#/130" + }, + "flags": 0 + }, + "ForwardedIPConfig": { + "type": { + "$ref": "#/66" + }, + "flags": 0 + }, + "Limit": { + "type": { + "$ref": "#/130" + }, + "flags": 1 + }, + "ScopeDownStatement": { + "type": { + "$ref": "#/117" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "RateBasedStatementCustomKey", + "properties": { + "Cookie": { + "type": { + "$ref": "#/92" + }, + "flags": 0 + }, + "ForwardedIP": { + "type": { + "$ref": "#/93" + }, + "flags": 0 + }, + "HTTPMethod": { + "type": { + "$ref": "#/94" + }, + "flags": 0 + }, + "Header": { + "type": { + "$ref": "#/95" + }, + "flags": 0 + }, + "IP": { + "type": { + "$ref": "#/96" + }, + "flags": 0 + }, + "LabelNamespace": { + "type": { + "$ref": "#/97" + }, + "flags": 0 + }, + "QueryArgument": { + "type": { + "$ref": "#/98" + }, + "flags": 0 + }, + "QueryString": { + "type": { + "$ref": "#/99" + }, + "flags": 0 + }, + "UriPath": { + "type": { + "$ref": "#/100" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "RateLimit", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RateLimitCookie", + "properties": { + "Name": { + "type": { + "$ref": "#/8" + }, + "flags": 17, + "description": "The name of the cookie to use." + }, + "TextTransformations": { + "type": { + "$ref": "#/146" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "RateLimitForwardedIP", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RateLimitHTTPMethod", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RateLimitHeader", + "properties": { + "Name": { + "type": { + "$ref": "#/8" + }, + "flags": 17, + "description": "The name of the header to use." + }, + "TextTransformations": { + "type": { + "$ref": "#/147" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "RateLimitIP", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RateLimitLabelNamespace", + "properties": { + "Namespace": { + "type": { + "$ref": "#/8" + }, + "flags": 1, + "description": "The namespace to use for aggregation." + } + } + }, + { + "$type": "ObjectType", + "name": "RateLimitQueryArgument", + "properties": { + "Name": { + "type": { + "$ref": "#/8" + }, + "flags": 17, + "description": "The name of the query argument to use." + }, + "TextTransformations": { + "type": { + "$ref": "#/148" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "RateLimitQueryString", + "properties": { + "TextTransformations": { + "type": { + "$ref": "#/149" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "RateLimitUriPath", + "properties": { + "TextTransformations": { + "type": { + "$ref": "#/150" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "RegexMatchStatement", + "properties": { + "FieldToMatch": { + "type": { + "$ref": "#/65" + }, + "flags": 1 + }, + "RegexString": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + }, + "TextTransformations": { + "type": { + "$ref": "#/151" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "RegexPatternSetReferenceStatement", + "properties": { + "Arn": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + }, + "FieldToMatch": { + "type": { + "$ref": "#/65" + }, + "flags": 1 + }, + "TextTransformations": { + "type": { + "$ref": "#/152" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ResourceArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ResponseContent", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ResponseContentType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ResponseStatusCode", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Rule", + "properties": { + "Action": { + "type": { + "$ref": "#/108" + }, + "flags": 0 + }, + "CaptchaConfig": { + "type": { + "$ref": "#/48" + }, + "flags": 0 + }, + "ChallengeConfig": { + "type": { + "$ref": "#/50" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/8" + }, + "flags": 17 + }, + "Priority": { + "type": { + "$ref": "#/130" + }, + "flags": 1 + }, + "RuleLabels": { + "type": { + "$ref": "#/153" + }, + "flags": 0, + "description": "Collection of Rule Labels." + }, + "Statement": { + "type": { + "$ref": "#/117" + }, + "flags": 1 + }, + "VisibilityConfig": { + "type": { + "$ref": "#/122" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "RuleAction", + "properties": { + "Allow": { + "type": { + "$ref": "#/41" + }, + "flags": 0 + }, + "Block": { + "type": { + "$ref": "#/43" + }, + "flags": 0 + }, + "Captcha": { + "type": { + "$ref": "#/47" + }, + "flags": 0 + }, + "Challenge": { + "type": { + "$ref": "#/49" + }, + "flags": 0 + }, + "Count": { + "type": { + "$ref": "#/53" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "RuleGroup", + "properties": { + "Arn": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "Capacity": { + "type": { + "$ref": "#/130" + }, + "flags": 0 + }, + "Description": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "Id": { + "type": { + "$ref": "#/8" + }, + "flags": 16 + }, + "Name": { + "type": { + "$ref": "#/8" + }, + "flags": 16 + }, + "Rules": { + "type": { + "$ref": "#/154" + }, + "flags": 0, + "description": "Collection of Rules." + }, + "VisibilityConfig": { + "type": { + "$ref": "#/122" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "RulePriority", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Scope", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SearchString", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SearchStringBase64", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SensitivityLevel", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SizeConstraintStatement", + "properties": { + "ComparisonOperator": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + }, + "FieldToMatch": { + "type": { + "$ref": "#/65" + }, + "flags": 1 + }, + "Size": { + "type": { + "$ref": "#/130" + }, + "flags": 1 + }, + "TextTransformations": { + "type": { + "$ref": "#/155" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "SqliMatchStatement", + "properties": { + "FieldToMatch": { + "type": { + "$ref": "#/65" + }, + "flags": 1 + }, + "SensitivityLevel": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "TextTransformations": { + "type": { + "$ref": "#/156" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Statement", + "properties": { + "AndStatement": { + "type": { + "$ref": "#/42" + }, + "flags": 0 + }, + "ByteMatchStatement": { + "type": { + "$ref": "#/46" + }, + "flags": 0 + }, + "GeoMatchStatement": { + "type": { + "$ref": "#/67" + }, + "flags": 0 + }, + "IPSetReferenceStatement": { + "type": { + "$ref": "#/71" + }, + "flags": 0 + }, + "LabelMatchStatement": { + "type": { + "$ref": "#/81" + }, + "flags": 0 + }, + "NotStatement": { + "type": { + "$ref": "#/85" + }, + "flags": 0 + }, + "OrStatement": { + "type": { + "$ref": "#/86" + }, + "flags": 0 + }, + "RateBasedStatement": { + "type": { + "$ref": "#/89" + }, + "flags": 0 + }, + "RegexMatchStatement": { + "type": { + "$ref": "#/101" + }, + "flags": 0 + }, + "RegexPatternSetReferenceStatement": { + "type": { + "$ref": "#/102" + }, + "flags": 0 + }, + "SizeConstraintStatement": { + "type": { + "$ref": "#/115" + }, + "flags": 0 + }, + "SqliMatchStatement": { + "type": { + "$ref": "#/116" + }, + "flags": 0 + }, + "XssMatchStatement": { + "type": { + "$ref": "#/123" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TextTransformation", + "properties": { + "Priority": { + "type": { + "$ref": "#/130" + }, + "flags": 1 + }, + "Type": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TextTransformationPriority", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TextTransformationType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "VisibilityConfig", + "properties": { + "CloudWatchMetricsEnabled": { + "type": { + "$ref": "#/29" + }, + "flags": 1 + }, + "MetricName": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + }, + "SampledRequestsEnabled": { + "type": { + "$ref": "#/29" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "XssMatchStatement", + "properties": { + "FieldToMatch": { + "type": { + "$ref": "#/65" + }, + "flags": 1 + }, + "TextTransformations": { + "type": { + "$ref": "#/157" + }, + "flags": 1 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/117" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/119" + } + }, + { + "$type": "ObjectType", + "name": "RuleGroup_All", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/8" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/8" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/54" + } + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/54" + } + }, + { + "$type": "ObjectType", + "name": "RuleGroup_AllQueryArguments", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RuleGroup_Method", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RuleGroup_QueryString", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RuleGroup_SingleHeader", + "properties": { + "Name": { + "type": { + "$ref": "#/8" + }, + "flags": 17 + } + } + }, + { + "$type": "ObjectType", + "name": "RuleGroup_SingleQueryArgument", + "properties": { + "Name": { + "type": { + "$ref": "#/8" + }, + "flags": 17 + } + } + }, + { + "$type": "ObjectType", + "name": "RuleGroup_UriPath", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/8" + } + }, + { + "$type": "ObjectType", + "name": "RuleGroup_All", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/8" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/8" + } + }, + { + "$type": "ObjectType", + "name": "RuleGroup_All", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/8" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/117" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/90" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/119" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/119" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/119" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/119" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/119" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/119" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/119" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/78" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/107" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/119" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/119" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/119" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.WAFv2/RuleGroupProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/83" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/83" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/107" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/118" + } + }, + { + "$type": "ObjectType", + "name": "AWS.WAFv2/RuleGroupProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/8" + }, + "flags": 2 + }, + "AvailableLabels": { + "type": { + "$ref": "#/159" + }, + "flags": 2, + "description": "Collection of Available Labels." + }, + "Capacity": { + "type": { + "$ref": "#/130" + }, + "flags": 1 + }, + "ConsumedLabels": { + "type": { + "$ref": "#/160" + }, + "flags": 2, + "description": "Collection of Consumed Labels." + }, + "CustomResponseBodies": { + "type": { + "$ref": "#/59" + }, + "flags": 0 + }, + "Description": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "Id": { + "type": { + "$ref": "#/8" + }, + "flags": 18 + }, + "LabelNamespace": { + "type": { + "$ref": "#/8" + }, + "flags": 2 + }, + "Name": { + "type": { + "$ref": "#/8" + }, + "flags": 16 + }, + "Rules": { + "type": { + "$ref": "#/161" + }, + "flags": 0, + "description": "Collection of Rules." + }, + "Scope": { + "type": { + "$ref": "#/8" + }, + "flags": 17 + }, + "Tags": { + "type": { + "$ref": "#/162" + }, + "flags": 0 + }, + "VisibilityConfig": { + "type": { + "$ref": "#/122" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.WAFv2/RuleGroup", + "properties": { + "name": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/8" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/163" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.WAFv2/RuleGroup@default", + "scopeType": 0, + "body": { + "$ref": "#/164" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AWSManagedRulesACFPRuleSet", + "properties": { + "CreationPath": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + }, + "EnableRegexInPath": { + "type": { + "$ref": "#/29" + }, + "flags": 0 + }, + "RegistrationPagePath": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + }, + "RequestInspection": { + "type": { + "$ref": "#/244" + }, + "flags": 1 + }, + "ResponseInspection": { + "type": { + "$ref": "#/248" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWSManagedRulesATPRuleSet", + "properties": { + "EnableRegexInPath": { + "type": { + "$ref": "#/29" + }, + "flags": 0 + }, + "LoginPath": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + }, + "RequestInspection": { + "type": { + "$ref": "#/243" + }, + "flags": 0 + }, + "ResponseInspection": { + "type": { + "$ref": "#/248" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWSManagedRulesBotControlRuleSet", + "properties": { + "EnableMachineLearning": { + "type": { + "$ref": "#/29" + }, + "flags": 0 + }, + "InspectionLevel": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AddressField", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "AllowAction", + "properties": { + "CustomRequestHandling": { + "type": { + "$ref": "#/187" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AndStatement", + "properties": { + "Statements": { + "type": { + "$ref": "#/278" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AssociationConfig", + "properties": { + "RequestBody": { + "type": { + "$ref": "#/241" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BlockAction", + "properties": { + "CustomResponse": { + "type": { + "$ref": "#/188" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Body", + "properties": { + "OversizeHandling": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "BodyParsingFallbackBehavior", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ByteMatchStatement", + "properties": { + "FieldToMatch": { + "type": { + "$ref": "#/199" + }, + "flags": 1 + }, + "PositionalConstraint": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + }, + "SearchString": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "SearchStringBase64": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "TextTransformations": { + "type": { + "$ref": "#/279" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CaptchaAction", + "properties": { + "CustomRequestHandling": { + "type": { + "$ref": "#/187" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CaptchaConfig", + "properties": { + "ImmunityTimeProperty": { + "type": { + "$ref": "#/206" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ChallengeAction", + "properties": { + "CustomRequestHandling": { + "type": { + "$ref": "#/187" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ChallengeConfig", + "properties": { + "ImmunityTimeProperty": { + "type": { + "$ref": "#/206" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CookieMatchPattern", + "properties": { + "All": { + "type": { + "$ref": "#/280" + }, + "flags": 0, + "description": "Inspect all parts of the web request cookies." + }, + "ExcludedCookies": { + "type": { + "$ref": "#/281" + }, + "flags": 0 + }, + "IncludedCookies": { + "type": { + "$ref": "#/282" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Cookies", + "properties": { + "MatchPattern": { + "type": { + "$ref": "#/181" + }, + "flags": 1 + }, + "MatchScope": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + }, + "OversizeHandling": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CountAction", + "properties": { + "CustomRequestHandling": { + "type": { + "$ref": "#/187" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomHTTPHeader", + "properties": { + "Name": { + "type": { + "$ref": "#/8" + }, + "flags": 17 + }, + "Value": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "CustomHTTPHeaderName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CustomHTTPHeaderValue", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CustomRequestHandling", + "properties": { + "InsertHeaders": { + "type": { + "$ref": "#/283" + }, + "flags": 1, + "description": "Collection of HTTP headers." + } + } + }, + { + "$type": "ObjectType", + "name": "CustomResponse", + "properties": { + "CustomResponseBodyKey": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "Custom response body key." + }, + "ResponseCode": { + "type": { + "$ref": "#/130" + }, + "flags": 1 + }, + "ResponseHeaders": { + "type": { + "$ref": "#/284" + }, + "flags": 0, + "description": "Collection of HTTP headers." + } + } + }, + { + "$type": "ObjectType", + "name": "CustomResponseBodies", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "CustomResponseBody", + "properties": { + "Content": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + }, + "ContentType": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "DefaultAction", + "properties": { + "Allow": { + "type": { + "$ref": "#/170" + }, + "flags": 0 + }, + "Block": { + "type": { + "$ref": "#/173" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "EntityDescription", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "EntityId", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "EntityName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "EvaluationWindowSec", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ExcludedRule", + "properties": { + "Name": { + "type": { + "$ref": "#/8" + }, + "flags": 17 + } + } + }, + { + "$type": "ObjectType", + "name": "ExcludedRules", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "FieldIdentifier", + "properties": { + "Identifier": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "FieldToMatch", + "properties": { + "AllQueryArguments": { + "type": { + "$ref": "#/286" + }, + "flags": 0, + "description": "All query arguments of a web request." + }, + "Body": { + "type": { + "$ref": "#/174" + }, + "flags": 0 + }, + "Cookies": { + "type": { + "$ref": "#/182" + }, + "flags": 0 + }, + "Headers": { + "type": { + "$ref": "#/203" + }, + "flags": 0 + }, + "JA3Fingerprint": { + "type": { + "$ref": "#/207" + }, + "flags": 0 + }, + "JsonBody": { + "type": { + "$ref": "#/208" + }, + "flags": 0 + }, + "Method": { + "type": { + "$ref": "#/287" + }, + "flags": 0, + "description": "The HTTP method of a web request. The method indicates the type of operation that the request is asking the origin to perform." + }, + "QueryString": { + "type": { + "$ref": "#/288" + }, + "flags": 0, + "description": "The query string of a web request. This is the part of a URL that appears after a ? character, if any." + }, + "SingleHeader": { + "type": { + "$ref": "#/289" + }, + "flags": 0 + }, + "SingleQueryArgument": { + "type": { + "$ref": "#/290" + }, + "flags": 0, + "description": "One query argument in a web request, identified by name, for example UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive." + }, + "UriPath": { + "type": { + "$ref": "#/291" + }, + "flags": 0, + "description": "The path component of the URI of a web request. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg." + } + } + }, + { + "$type": "ObjectType", + "name": "ForwardedIPConfiguration", + "properties": { + "FallbackBehavior": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + }, + "HeaderName": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "GeoMatchStatement", + "properties": { + "CountryCodes": { + "type": { + "$ref": "#/292" + }, + "flags": 0 + }, + "ForwardedIPConfig": { + "type": { + "$ref": "#/200" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "HeaderMatchPattern", + "properties": { + "All": { + "type": { + "$ref": "#/293" + }, + "flags": 0, + "description": "Inspect all parts of the web request headers." + }, + "ExcludedHeaders": { + "type": { + "$ref": "#/294" + }, + "flags": 0 + }, + "IncludedHeaders": { + "type": { + "$ref": "#/295" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Headers", + "properties": { + "MatchPattern": { + "type": { + "$ref": "#/202" + }, + "flags": 1 + }, + "MatchScope": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + }, + "OversizeHandling": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "IPSetForwardedIPConfiguration", + "properties": { + "FallbackBehavior": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + }, + "HeaderName": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + }, + "Position": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "IPSetReferenceStatement", + "properties": { + "Arn": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + }, + "IPSetForwardedIPConfig": { + "type": { + "$ref": "#/204" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ImmunityTimeProperty", + "properties": { + "ImmunityTime": { + "type": { + "$ref": "#/130" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "JA3Fingerprint", + "properties": { + "FallbackBehavior": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "JsonBody", + "properties": { + "InvalidFallbackBehavior": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "MatchPattern": { + "type": { + "$ref": "#/209" + }, + "flags": 1 + }, + "MatchScope": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + }, + "OversizeHandling": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "JsonMatchPattern", + "properties": { + "All": { + "type": { + "$ref": "#/296" + }, + "flags": 0, + "description": "Inspect all parts of the web request's JSON body." + }, + "IncludedPaths": { + "type": { + "$ref": "#/297" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "JsonMatchScope", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "JsonPointerPath", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Label", + "properties": { + "Name": { + "type": { + "$ref": "#/8" + }, + "flags": 17 + } + } + }, + { + "$type": "ObjectType", + "name": "LabelMatchKey", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LabelMatchScope", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "LabelMatchStatement", + "properties": { + "Key": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + }, + "Scope": { + "type": { + "$ref": "#/8" + }, + "flags": 17 + } + } + }, + { + "$type": "ObjectType", + "name": "LabelName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ManagedRuleGroupConfig", + "properties": { + "AWSManagedRulesACFPRuleSet": { + "type": { + "$ref": "#/166" + }, + "flags": 0 + }, + "AWSManagedRulesATPRuleSet": { + "type": { + "$ref": "#/167" + }, + "flags": 0 + }, + "AWSManagedRulesBotControlRuleSet": { + "type": { + "$ref": "#/168" + }, + "flags": 0 + }, + "LoginPath": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "PasswordField": { + "type": { + "$ref": "#/198" + }, + "flags": 0 + }, + "PayloadType": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "UsernameField": { + "type": { + "$ref": "#/198" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ManagedRuleGroupStatement", + "properties": { + "ExcludedRules": { + "type": { + "$ref": "#/298" + }, + "flags": 0 + }, + "ManagedRuleGroupConfigs": { + "type": { + "$ref": "#/299" + }, + "flags": 0, + "description": "Collection of ManagedRuleGroupConfig." + }, + "Name": { + "type": { + "$ref": "#/8" + }, + "flags": 17 + }, + "RuleActionOverrides": { + "type": { + "$ref": "#/300" + }, + "flags": 0, + "description": "Action overrides for rules in the rule group." + }, + "ScopeDownStatement": { + "type": { + "$ref": "#/269" + }, + "flags": 0 + }, + "VendorName": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + }, + "Version": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "MapMatchScope", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "NotStatement", + "properties": { + "Statement": { + "type": { + "$ref": "#/269" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "OrStatement", + "properties": { + "Statements": { + "type": { + "$ref": "#/301" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "OverrideAction", + "properties": { + "Count": { + "type": { + "$ref": "#/302" + }, + "flags": 0, + "description": "Count traffic towards application." + }, + "None": { + "type": { + "$ref": "#/303" + }, + "flags": 0, + "description": "Keep the RuleGroup or ManagedRuleGroup behavior as is." + } + } + }, + { + "$type": "ObjectType", + "name": "OversizeHandling", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PhoneNumberField", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PositionalConstraint", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "QueryString", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RateBasedStatement", + "properties": { + "AggregateKeyType": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + }, + "CustomKeys": { + "type": { + "$ref": "#/304" + }, + "flags": 0, + "description": "Specifies the aggregate keys to use in a rate-base rule." + }, + "EvaluationWindowSec": { + "type": { + "$ref": "#/130" + }, + "flags": 0 + }, + "ForwardedIPConfig": { + "type": { + "$ref": "#/200" + }, + "flags": 0 + }, + "Limit": { + "type": { + "$ref": "#/130" + }, + "flags": 1 + }, + "ScopeDownStatement": { + "type": { + "$ref": "#/269" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "RateBasedStatementCustomKey", + "properties": { + "Cookie": { + "type": { + "$ref": "#/230" + }, + "flags": 0 + }, + "ForwardedIP": { + "type": { + "$ref": "#/231" + }, + "flags": 0 + }, + "HTTPMethod": { + "type": { + "$ref": "#/232" + }, + "flags": 0 + }, + "Header": { + "type": { + "$ref": "#/233" + }, + "flags": 0 + }, + "IP": { + "type": { + "$ref": "#/234" + }, + "flags": 0 + }, + "LabelNamespace": { + "type": { + "$ref": "#/235" + }, + "flags": 0 + }, + "QueryArgument": { + "type": { + "$ref": "#/236" + }, + "flags": 0 + }, + "QueryString": { + "type": { + "$ref": "#/237" + }, + "flags": 0 + }, + "UriPath": { + "type": { + "$ref": "#/238" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "RateLimit", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RateLimitCookie", + "properties": { + "Name": { + "type": { + "$ref": "#/8" + }, + "flags": 17, + "description": "The name of the cookie to use." + }, + "TextTransformations": { + "type": { + "$ref": "#/305" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "RateLimitForwardedIP", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RateLimitHTTPMethod", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RateLimitHeader", + "properties": { + "Name": { + "type": { + "$ref": "#/8" + }, + "flags": 17, + "description": "The name of the header to use." + }, + "TextTransformations": { + "type": { + "$ref": "#/306" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "RateLimitIP", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RateLimitLabelNamespace", + "properties": { + "Namespace": { + "type": { + "$ref": "#/8" + }, + "flags": 1, + "description": "The namespace to use for aggregation." + } + } + }, + { + "$type": "ObjectType", + "name": "RateLimitQueryArgument", + "properties": { + "Name": { + "type": { + "$ref": "#/8" + }, + "flags": 17, + "description": "The name of the query argument to use." + }, + "TextTransformations": { + "type": { + "$ref": "#/307" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "RateLimitQueryString", + "properties": { + "TextTransformations": { + "type": { + "$ref": "#/308" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "RateLimitUriPath", + "properties": { + "TextTransformations": { + "type": { + "$ref": "#/309" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "RegexMatchStatement", + "properties": { + "FieldToMatch": { + "type": { + "$ref": "#/199" + }, + "flags": 1 + }, + "RegexString": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + }, + "TextTransformations": { + "type": { + "$ref": "#/310" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "RegexPatternSetReferenceStatement", + "properties": { + "Arn": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + }, + "FieldToMatch": { + "type": { + "$ref": "#/199" + }, + "flags": 1 + }, + "TextTransformations": { + "type": { + "$ref": "#/311" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "RequestBody", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RequestBodyAssociatedResourceTypeConfig", + "properties": { + "DefaultSizeInspectionLimit": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "RequestInspection", + "properties": { + "PasswordField": { + "type": { + "$ref": "#/198" + }, + "flags": 1 + }, + "PayloadType": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + }, + "UsernameField": { + "type": { + "$ref": "#/198" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "RequestInspectionACFP", + "properties": { + "AddressFields": { + "type": { + "$ref": "#/313" + }, + "flags": 0 + }, + "EmailField": { + "type": { + "$ref": "#/198" + }, + "flags": 0 + }, + "PasswordField": { + "type": { + "$ref": "#/198" + }, + "flags": 0 + }, + "PayloadType": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + }, + "PhoneNumberFields": { + "type": { + "$ref": "#/315" + }, + "flags": 0 + }, + "UsernameField": { + "type": { + "$ref": "#/198" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ResourceArn", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ResponseContent", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ResponseContentType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ResponseInspection", + "properties": { + "BodyContains": { + "type": { + "$ref": "#/249" + }, + "flags": 0 + }, + "Header": { + "type": { + "$ref": "#/250" + }, + "flags": 0 + }, + "Json": { + "type": { + "$ref": "#/251" + }, + "flags": 0 + }, + "StatusCode": { + "type": { + "$ref": "#/252" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ResponseInspectionBodyContains", + "properties": { + "FailureStrings": { + "type": { + "$ref": "#/316" + }, + "flags": 1 + }, + "SuccessStrings": { + "type": { + "$ref": "#/317" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ResponseInspectionHeader", + "properties": { + "FailureValues": { + "type": { + "$ref": "#/318" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/8" + }, + "flags": 17 + }, + "SuccessValues": { + "type": { + "$ref": "#/319" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ResponseInspectionJson", + "properties": { + "FailureValues": { + "type": { + "$ref": "#/320" + }, + "flags": 1 + }, + "Identifier": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + }, + "SuccessValues": { + "type": { + "$ref": "#/321" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ResponseInspectionStatusCode", + "properties": { + "FailureCodes": { + "type": { + "$ref": "#/322" + }, + "flags": 1 + }, + "SuccessCodes": { + "type": { + "$ref": "#/323" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ResponseStatusCode", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Rule", + "properties": { + "Action": { + "type": { + "$ref": "#/255" + }, + "flags": 0 + }, + "CaptchaConfig": { + "type": { + "$ref": "#/178" + }, + "flags": 0 + }, + "ChallengeConfig": { + "type": { + "$ref": "#/180" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/8" + }, + "flags": 17 + }, + "OverrideAction": { + "type": { + "$ref": "#/222" + }, + "flags": 0 + }, + "Priority": { + "type": { + "$ref": "#/130" + }, + "flags": 1 + }, + "RuleLabels": { + "type": { + "$ref": "#/324" + }, + "flags": 0, + "description": "Collection of Rule Labels." + }, + "Statement": { + "type": { + "$ref": "#/269" + }, + "flags": 1 + }, + "VisibilityConfig": { + "type": { + "$ref": "#/276" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "RuleAction", + "properties": { + "Allow": { + "type": { + "$ref": "#/170" + }, + "flags": 0 + }, + "Block": { + "type": { + "$ref": "#/173" + }, + "flags": 0 + }, + "Captcha": { + "type": { + "$ref": "#/177" + }, + "flags": 0 + }, + "Challenge": { + "type": { + "$ref": "#/179" + }, + "flags": 0 + }, + "Count": { + "type": { + "$ref": "#/183" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "RuleActionOverride", + "properties": { + "ActionToUse": { + "type": { + "$ref": "#/255" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/8" + }, + "flags": 17 + } + } + }, + { + "$type": "ObjectType", + "name": "RuleGroupReferenceStatement", + "properties": { + "Arn": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + }, + "ExcludedRules": { + "type": { + "$ref": "#/325" + }, + "flags": 0 + }, + "RuleActionOverrides": { + "type": { + "$ref": "#/326" + }, + "flags": 0, + "description": "Action overrides for rules in the rule group." + } + } + }, + { + "$type": "ObjectType", + "name": "RulePriority", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Rules", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Scope", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SearchString", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SearchStringBase64", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SensitivityLevel", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SingleHeader", + "properties": { + "Name": { + "type": { + "$ref": "#/8" + }, + "flags": 16 + } + } + }, + { + "$type": "ObjectType", + "name": "SingleQueryArgument", + "properties": { + "Name": { + "type": { + "$ref": "#/8" + }, + "flags": 16 + } + } + }, + { + "$type": "ObjectType", + "name": "SizeConstraintStatement", + "properties": { + "ComparisonOperator": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + }, + "FieldToMatch": { + "type": { + "$ref": "#/199" + }, + "flags": 1 + }, + "Size": { + "type": { + "$ref": "#/130" + }, + "flags": 1 + }, + "TextTransformations": { + "type": { + "$ref": "#/328" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "SizeInspectionLimit", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SqliMatchStatement", + "properties": { + "FieldToMatch": { + "type": { + "$ref": "#/199" + }, + "flags": 1 + }, + "SensitivityLevel": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "TextTransformations": { + "type": { + "$ref": "#/329" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Statement", + "properties": { + "AndStatement": { + "type": { + "$ref": "#/171" + }, + "flags": 0 + }, + "ByteMatchStatement": { + "type": { + "$ref": "#/176" + }, + "flags": 0 + }, + "GeoMatchStatement": { + "type": { + "$ref": "#/201" + }, + "flags": 0 + }, + "IPSetReferenceStatement": { + "type": { + "$ref": "#/205" + }, + "flags": 0 + }, + "LabelMatchStatement": { + "type": { + "$ref": "#/215" + }, + "flags": 0 + }, + "ManagedRuleGroupStatement": { + "type": { + "$ref": "#/218" + }, + "flags": 0 + }, + "NotStatement": { + "type": { + "$ref": "#/220" + }, + "flags": 0 + }, + "OrStatement": { + "type": { + "$ref": "#/221" + }, + "flags": 0 + }, + "RateBasedStatement": { + "type": { + "$ref": "#/227" + }, + "flags": 0 + }, + "RegexMatchStatement": { + "type": { + "$ref": "#/239" + }, + "flags": 0 + }, + "RegexPatternSetReferenceStatement": { + "type": { + "$ref": "#/240" + }, + "flags": 0 + }, + "RuleGroupReferenceStatement": { + "type": { + "$ref": "#/257" + }, + "flags": 0 + }, + "SizeConstraintStatement": { + "type": { + "$ref": "#/266" + }, + "flags": 0 + }, + "SqliMatchStatement": { + "type": { + "$ref": "#/268" + }, + "flags": 0 + }, + "XssMatchStatement": { + "type": { + "$ref": "#/277" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "Value": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "TextTransformation", + "properties": { + "Priority": { + "type": { + "$ref": "#/130" + }, + "flags": 1 + }, + "Type": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TextTransformationPriority", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TextTransformationType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "TokenDomains", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "UriPath", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "VisibilityConfig", + "properties": { + "CloudWatchMetricsEnabled": { + "type": { + "$ref": "#/29" + }, + "flags": 1 + }, + "MetricName": { + "type": { + "$ref": "#/8" + }, + "flags": 1 + }, + "SampledRequestsEnabled": { + "type": { + "$ref": "#/29" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "XssMatchStatement", + "properties": { + "FieldToMatch": { + "type": { + "$ref": "#/199" + }, + "flags": 1 + }, + "TextTransformations": { + "type": { + "$ref": "#/331" + }, + "flags": 1 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/269" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/271" + } + }, + { + "$type": "ObjectType", + "name": "WebACL_All", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/8" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/8" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/184" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/184" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/196" + } + }, + { + "$type": "ObjectType", + "name": "WebACL_AllQueryArguments", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "WebACL_Method", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "WebACL_QueryString", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "WebACL_SingleHeader", + "properties": { + "Name": { + "type": { + "$ref": "#/8" + }, + "flags": 17 + } + } + }, + { + "$type": "ObjectType", + "name": "WebACL_SingleQueryArgument", + "properties": { + "Name": { + "type": { + "$ref": "#/8" + }, + "flags": 17 + } + } + }, + { + "$type": "ObjectType", + "name": "WebACL_UriPath", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/8" + } + }, + { + "$type": "ObjectType", + "name": "WebACL_All", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/8" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/8" + } + }, + { + "$type": "ObjectType", + "name": "WebACL_All", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/8" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/196" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/217" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/256" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/269" + } + }, + { + "$type": "ObjectType", + "name": "WebACL_Count", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "WebACL_None", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/228" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/271" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/271" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/271" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/271" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/271" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/271" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/271" + } + }, + { + "$type": "ObjectType", + "name": "WebACL_AddressField", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/312" + } + }, + { + "$type": "ObjectType", + "name": "WebACL_PhoneNumberField", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/314" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/8" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/8" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/8" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/8" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/8" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/8" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/130" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/130" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/212" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/196" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/256" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/254" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/271" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/271" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/8" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/271" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.WAFv2/WebACLProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/254" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/270" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/8" + } + }, + { + "$type": "ObjectType", + "name": "AWS.WAFv2/WebACLProperties", + "properties": { + "Arn": { + "type": { + "$ref": "#/8" + }, + "flags": 2 + }, + "AssociationConfig": { + "type": { + "$ref": "#/172" + }, + "flags": 0 + }, + "Capacity": { + "type": { + "$ref": "#/130" + }, + "flags": 2 + }, + "CaptchaConfig": { + "type": { + "$ref": "#/178" + }, + "flags": 0 + }, + "ChallengeConfig": { + "type": { + "$ref": "#/180" + }, + "flags": 0 + }, + "CustomResponseBodies": { + "type": { + "$ref": "#/189" + }, + "flags": 0 + }, + "DefaultAction": { + "type": { + "$ref": "#/191" + }, + "flags": 1 + }, + "Description": { + "type": { + "$ref": "#/8" + }, + "flags": 0 + }, + "Id": { + "type": { + "$ref": "#/8" + }, + "flags": 18 + }, + "LabelNamespace": { + "type": { + "$ref": "#/8" + }, + "flags": 2 + }, + "Name": { + "type": { + "$ref": "#/8" + }, + "flags": 16 + }, + "Rules": { + "type": { + "$ref": "#/333" + }, + "flags": 0, + "description": "Collection of Rules." + }, + "Scope": { + "type": { + "$ref": "#/8" + }, + "flags": 17 + }, + "Tags": { + "type": { + "$ref": "#/334" + }, + "flags": 0 + }, + "TokenDomains": { + "type": { + "$ref": "#/335" + }, + "flags": 0 + }, + "VisibilityConfig": { + "type": { + "$ref": "#/276" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.WAFv2/WebACL", + "properties": { + "name": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/8" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/336" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.WAFv2/WebACL@default", + "scopeType": 0, + "body": { + "$ref": "#/337" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "ResourceArn", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.WAFv2/WebACLAssociationProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.WAFv2/WebACLAssociationProperties", + "properties": { + "ResourceArn": { + "type": { + "$ref": "#/8" + }, + "flags": 17 + }, + "WebACLArn": { + "type": { + "$ref": "#/8" + }, + "flags": 17 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.WAFv2/WebACLAssociation", + "properties": { + "name": { + "type": { + "$ref": "#/8" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/8" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/341" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.WAFv2/WebACLAssociation@default", + "scopeType": 0, + "body": { + "$ref": "#/342" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.wafv2/default/types.md b/artifacts/bicep/aws/aws.wafv2/default/types.md index c9e2b500..42ff9ac0 100644 --- a/artifacts/bicep/aws/aws.wafv2/default/types.md +++ b/artifacts/bicep/aws/aws.wafv2/default/types.md @@ -3,44 +3,64 @@ ## Resource AWS.WAFv2/IPSet@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.WAFv2/IPSetProperties](#awswafv2ipsetproperties) (Required): properties of the resource +* **properties**: [AWS.WAFv2/IPSetProperties](#awswafv2ipsetproperties) (Required, Identifier): properties of the resource ## Resource AWS.WAFv2/LoggingConfiguration@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.WAFv2/LoggingConfigurationProperties](#awswafv2loggingconfigurationproperties) (Required): properties of the resource +* **properties**: [AWS.WAFv2/LoggingConfigurationProperties](#awswafv2loggingconfigurationproperties) (Required, Identifier): properties of the resource ## Resource AWS.WAFv2/RegexPatternSet@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.WAFv2/RegexPatternSetProperties](#awswafv2regexpatternsetproperties) (Required): properties of the resource +* **properties**: [AWS.WAFv2/RegexPatternSetProperties](#awswafv2regexpatternsetproperties) (Required, Identifier): properties of the resource ## Resource AWS.WAFv2/RuleGroup@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.WAFv2/RuleGroupProperties](#awswafv2rulegroupproperties) (Required): properties of the resource +* **properties**: [AWS.WAFv2/RuleGroupProperties](#awswafv2rulegroupproperties) (Required, Identifier): properties of the resource ## Resource AWS.WAFv2/WebACL@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.WAFv2/WebACLProperties](#awswafv2webaclproperties) (Required): properties of the resource +* **properties**: [AWS.WAFv2/WebACLProperties](#awswafv2webaclproperties) (Required, Identifier): properties of the resource ## Resource AWS.WAFv2/WebACLAssociation@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.WAFv2/WebACLAssociationProperties](#awswafv2webaclassociationproperties) (Required): properties of the resource +* **properties**: [AWS.WAFv2/WebACLAssociationProperties](#awswafv2webaclassociationproperties) (Required, Identifier): properties of the resource + +## AllowAction +### Properties +* **CustomRequestHandling**: [CustomRequestHandling](#customrequesthandling) + +## AllowAction +### Properties +* **CustomRequestHandling**: [CustomRequestHandling](#customrequesthandling) + +## AndStatement +### Properties +* **Statements**: [Statement](#statement)[] (Required) + +## AndStatement +### Properties +* **Statements**: [Statement](#statement)[] (Required) + +## AssociationConfig +### Properties +* **RequestBody**: [RequestBody](#requestbody) ## AWS.WAFv2/IPSetProperties ### Properties @@ -53,11 +73,6 @@ * **Scope**: string (Required, Identifier) * **Tags**: [Tag](#tag)[] -## Tag -### Properties -* **Key**: string -* **Value**: string - ## AWS.WAFv2/LoggingConfigurationProperties ### Properties * **LogDestinationConfigs**: string[] (Required): The Amazon Resource Names (ARNs) of the logging destinations that you want to associate with the web ACL. @@ -66,65 +81,6 @@ * **RedactedFields**: [FieldToMatch](#fieldtomatch)[]: The parts of the request that you want to keep out of the logs. For example, if you redact the HEADER field, the HEADER field in the firehose will be xxx. * **ResourceArn**: string (Required, Identifier): The Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs. -## LoggingConfiguration_LoggingFilter -### Properties -* **DefaultBehavior**: string (Required): Default handling for logs that don't match any of the specified filtering conditions. -* **Filters**: [Filter](#filter)[] (Required): The filters that you want to apply to the logs. - -## Filter -### Properties -* **Behavior**: string (Required): How to handle logs that satisfy the filter's conditions and requirement. -* **Conditions**: [Condition](#condition)[] (Required): Match conditions for the filter. -* **Requirement**: string (Required): Logic to apply to the filtering conditions. You can specify that, in order to satisfy the filter, a log must match all conditions or must match at least one condition. - -## Condition -### Properties -* **ActionCondition**: [LoggingConfiguration_ActionCondition](#loggingconfigurationactioncondition): A single action condition. -* **LabelNameCondition**: [LoggingConfiguration_LabelNameCondition](#loggingconfigurationlabelnamecondition): A single label name condition. - -## LoggingConfiguration_ActionCondition -### Properties -* **Action**: string (Required): Logic to apply to the filtering conditions. You can specify that, in order to satisfy the filter, a log must match all conditions or must match at least one condition. - -## LoggingConfiguration_LabelNameCondition -### Properties -* **LabelName**: string (Required): The label name that a log record must contain in order to meet the condition. This must be a fully qualified label name. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label. - -## FieldToMatch -### Properties -* **JsonBody**: [LoggingConfiguration_JsonBody](#loggingconfigurationjsonbody): Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. -* **Method**: [LoggingConfiguration_Method](#loggingconfigurationmethod): Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform. -* **QueryString**: [LoggingConfiguration_QueryString](#loggingconfigurationquerystring): Inspect the query string. This is the part of a URL that appears after a ? character, if any. -* **SingleHeader**: [LoggingConfiguration_SingleHeader](#loggingconfigurationsingleheader): Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive. -* **UriPath**: [LoggingConfiguration_UriPath](#loggingconfigurationuripath): Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg. - -## LoggingConfiguration_JsonBody -### Properties -* **InvalidFallbackBehavior**: string: What AWS WAF should do if it fails to completely parse the JSON body. -* **MatchPattern**: [LoggingConfiguration_JsonBody_MatchPattern](#loggingconfigurationjsonbodymatchpattern) (Required): The patterns to look for in the JSON body. AWS WAF inspects the results of these pattern matches against the rule inspection criteria. -* **MatchScope**: string (Required): The parts of the JSON to match against using the MatchPattern. If you specify All, AWS WAF matches against keys and values. - -## LoggingConfiguration_JsonBody_MatchPattern -### Properties -* **All**: [LoggingConfiguration_JsonBody_MatchPattern_All](#loggingconfigurationjsonbodymatchpatternall): Match all of the elements. See also MatchScope in JsonBody. You must specify either this setting or the IncludedPaths setting, but not both. -* **IncludedPaths**: string[]: Match only the specified include paths. See also MatchScope in JsonBody. - -## LoggingConfiguration_JsonBody_MatchPattern_All -### Properties - -## LoggingConfiguration_Method -### Properties - -## LoggingConfiguration_QueryString -### Properties - -## LoggingConfiguration_SingleHeader -### Properties -* **Name**: string (Required): The name of the query header to inspect. - -## LoggingConfiguration_UriPath -### Properties - ## AWS.WAFv2/RegexPatternSetProperties ### Properties * **Arn**: string (ReadOnly): ARN of the WAF entity. @@ -135,11 +91,6 @@ * **Scope**: string (Required, Identifier): Use CLOUDFRONT for CloudFront RegexPatternSet, use REGIONAL for Application Load Balancer and API Gateway. * **Tags**: [Tag](#tag)[] -## Tag -### Properties -* **Key**: string -* **Value**: string - ## AWS.WAFv2/RuleGroupProperties ### Properties * **Arn**: string (ReadOnly) @@ -156,64 +107,87 @@ * **Tags**: [Tag](#tag)[] * **VisibilityConfig**: [VisibilityConfig](#visibilityconfig) (Required) -## LabelSummary -### Properties -* **Name**: string (Identifier) - -## CustomResponseBodies +## AWS.WAFv2/WebACLAssociationProperties ### Properties +* **ResourceArn**: string (Required, Identifier) +* **WebACLArn**: string (Required, Identifier) -## Rule +## AWS.WAFv2/WebACLProperties ### Properties -* **Action**: [RuleAction](#ruleaction) +* **Arn**: string (ReadOnly) +* **AssociationConfig**: [AssociationConfig](#associationconfig) +* **Capacity**: int (ReadOnly) * **CaptchaConfig**: [CaptchaConfig](#captchaconfig) * **ChallengeConfig**: [ChallengeConfig](#challengeconfig) -* **Name**: string (Required, Identifier) -* **Priority**: int (Required) -* **RuleLabels**: [Label](#label)[]: Collection of Rule Labels. -* **Statement**: [Statement](#statement) (Required) +* **CustomResponseBodies**: [CustomResponseBodies](#customresponsebodies) +* **DefaultAction**: [DefaultAction](#defaultaction) (Required) +* **Description**: string +* **Id**: string (ReadOnly, Identifier) +* **LabelNamespace**: string (ReadOnly) +* **Name**: string (Identifier) +* **Rules**: [Rule](#rule)[]: Collection of Rules. +* **Scope**: string (Required, Identifier) +* **Tags**: [Tag](#tag)[] +* **TokenDomains**: string[] * **VisibilityConfig**: [VisibilityConfig](#visibilityconfig) (Required) -## RuleAction +## AWSManagedRulesACFPRuleSet ### Properties -* **Allow**: [AllowAction](#allowaction) -* **Block**: [BlockAction](#blockaction) -* **Captcha**: [CaptchaAction](#captchaaction) -* **Challenge**: [ChallengeAction](#challengeaction) -* **Count**: [CountAction](#countaction) +* **CreationPath**: string (Required) +* **EnableRegexInPath**: bool +* **RegistrationPagePath**: string (Required) +* **RequestInspection**: [RequestInspectionACFP](#requestinspectionacfp) (Required) +* **ResponseInspection**: [ResponseInspection](#responseinspection) -## AllowAction +## AWSManagedRulesATPRuleSet ### Properties -* **CustomRequestHandling**: [CustomRequestHandling](#customrequesthandling) +* **EnableRegexInPath**: bool +* **LoginPath**: string (Required) +* **RequestInspection**: [RequestInspection](#requestinspection) +* **ResponseInspection**: [ResponseInspection](#responseinspection) -## CustomRequestHandling +## AWSManagedRulesBotControlRuleSet ### Properties -* **InsertHeaders**: [CustomHTTPHeader](#customhttpheader)[] (Required): Collection of HTTP headers. +* **EnableMachineLearning**: bool +* **InspectionLevel**: string (Required) -## CustomHTTPHeader +## BlockAction ### Properties -* **Name**: string (Required, Identifier) -* **Value**: string (Required) +* **CustomResponse**: [CustomResponse](#customresponse) ## BlockAction ### Properties * **CustomResponse**: [CustomResponse](#customresponse) -## CustomResponse +## Body ### Properties -* **CustomResponseBodyKey**: string: Custom response body key. -* **ResponseCode**: int (Required) -* **ResponseHeaders**: [CustomHTTPHeader](#customhttpheader)[]: Collection of HTTP headers. +* **OversizeHandling**: string -## CaptchaAction +## Body ### Properties -* **CustomRequestHandling**: [CustomRequestHandling](#customrequesthandling) +* **OversizeHandling**: string -## ChallengeAction +## ByteMatchStatement +### Properties +* **FieldToMatch**: [FieldToMatch](#fieldtomatch) (Required) +* **PositionalConstraint**: string (Required) +* **SearchString**: string +* **SearchStringBase64**: string +* **TextTransformations**: [TextTransformation](#texttransformation)[] (Required) + +## ByteMatchStatement +### Properties +* **FieldToMatch**: [FieldToMatch](#fieldtomatch) (Required) +* **PositionalConstraint**: string (Required) +* **SearchString**: string +* **SearchStringBase64**: string +* **TextTransformations**: [TextTransformation](#texttransformation)[] (Required) + +## CaptchaAction ### Properties * **CustomRequestHandling**: [CustomRequestHandling](#customrequesthandling) -## CountAction +## CaptchaAction ### Properties * **CustomRequestHandling**: [CustomRequestHandling](#customrequesthandling) @@ -221,65 +195,42 @@ ### Properties * **ImmunityTimeProperty**: [ImmunityTimeProperty](#immunitytimeproperty) -## ImmunityTimeProperty -### Properties -* **ImmunityTime**: int (Required) - -## ChallengeConfig +## CaptchaConfig ### Properties * **ImmunityTimeProperty**: [ImmunityTimeProperty](#immunitytimeproperty) -## Label +## ChallengeAction ### Properties -* **Name**: string (Required, Identifier) +* **CustomRequestHandling**: [CustomRequestHandling](#customrequesthandling) -## Statement +## ChallengeAction ### Properties -* **AndStatement**: [AndStatement](#andstatement) -* **ByteMatchStatement**: [ByteMatchStatement](#bytematchstatement) -* **GeoMatchStatement**: [GeoMatchStatement](#geomatchstatement) -* **IPSetReferenceStatement**: [IPSetReferenceStatement](#ipsetreferencestatement) -* **LabelMatchStatement**: [LabelMatchStatement](#labelmatchstatement) -* **NotStatement**: [NotStatement](#notstatement) -* **OrStatement**: [OrStatement](#orstatement) -* **RateBasedStatement**: [RateBasedStatement](#ratebasedstatement) -* **RegexMatchStatement**: [RegexMatchStatement](#regexmatchstatement) -* **RegexPatternSetReferenceStatement**: [RegexPatternSetReferenceStatement](#regexpatternsetreferencestatement) -* **SizeConstraintStatement**: [SizeConstraintStatement](#sizeconstraintstatement) -* **SqliMatchStatement**: [SqliMatchStatement](#sqlimatchstatement) -* **XssMatchStatement**: [XssMatchStatement](#xssmatchstatement) +* **CustomRequestHandling**: [CustomRequestHandling](#customrequesthandling) -## AndStatement +## ChallengeConfig ### Properties -* **Statements**: [Statement](#statement)[] (Required) +* **ImmunityTimeProperty**: [ImmunityTimeProperty](#immunitytimeproperty) -## ByteMatchStatement +## ChallengeConfig ### Properties -* **FieldToMatch**: [FieldToMatch](#fieldtomatch) (Required) -* **PositionalConstraint**: string (Required) -* **SearchString**: string -* **SearchStringBase64**: string -* **TextTransformations**: [TextTransformation](#texttransformation)[] (Required) +* **ImmunityTimeProperty**: [ImmunityTimeProperty](#immunitytimeproperty) -## FieldToMatch +## Condition ### Properties -* **AllQueryArguments**: [RuleGroup_AllQueryArguments](#rulegroupallqueryarguments): All query arguments of a web request. -* **Body**: [Body](#body) -* **Cookies**: [Cookies](#cookies) -* **Headers**: [Headers](#headers) -* **JsonBody**: [JsonBody](#jsonbody) -* **Method**: [RuleGroup_Method](#rulegroupmethod): The HTTP method of a web request. The method indicates the type of operation that the request is asking the origin to perform. -* **QueryString**: [RuleGroup_QueryString](#rulegroupquerystring): The query string of a web request. This is the part of a URL that appears after a ? character, if any. -* **SingleHeader**: [RuleGroup_SingleHeader](#rulegroupsingleheader) -* **SingleQueryArgument**: [RuleGroup_SingleQueryArgument](#rulegroupsinglequeryargument): One query argument in a web request, identified by name, for example UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive. -* **UriPath**: [RuleGroup_UriPath](#rulegroupuripath): The path component of the URI of a web request. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg. +* **ActionCondition**: [LoggingConfiguration_ActionCondition](#loggingconfigurationactioncondition): A single action condition. +* **LabelNameCondition**: [LoggingConfiguration_LabelNameCondition](#loggingconfigurationlabelnamecondition): A single label name condition. -## RuleGroup_AllQueryArguments +## CookieMatchPattern ### Properties +* **All**: [RuleGroup_All](#rulegroupall): Inspect all parts of the web request cookies. +* **ExcludedCookies**: string[] +* **IncludedCookies**: string[] -## Body +## CookieMatchPattern ### Properties -* **OversizeHandling**: string +* **All**: [WebACL_All](#webaclall): Inspect all parts of the web request cookies. +* **ExcludedCookies**: string[] +* **IncludedCookies**: string[] ## Cookies ### Properties @@ -287,488 +238,451 @@ * **MatchScope**: string (Required) * **OversizeHandling**: string (Required) -## CookieMatchPattern -### Properties -* **All**: [RuleGroup_All](#rulegroupall): Inspect all parts of the web request cookies. -* **ExcludedCookies**: string[] -* **IncludedCookies**: string[] - -## RuleGroup_All -### Properties - -## Headers +## Cookies ### Properties -* **MatchPattern**: [HeaderMatchPattern](#headermatchpattern) (Required) +* **MatchPattern**: [CookieMatchPattern](#cookiematchpattern) (Required) * **MatchScope**: string (Required) * **OversizeHandling**: string (Required) -## HeaderMatchPattern +## CountAction ### Properties -* **All**: [RuleGroup_All](#rulegroupall): Inspect all parts of the web request headers. -* **ExcludedHeaders**: string[] -* **IncludedHeaders**: string[] +* **CustomRequestHandling**: [CustomRequestHandling](#customrequesthandling) -## RuleGroup_All +## CountAction ### Properties +* **CustomRequestHandling**: [CustomRequestHandling](#customrequesthandling) -## JsonBody +## CustomHTTPHeader ### Properties -* **InvalidFallbackBehavior**: string -* **MatchPattern**: [JsonMatchPattern](#jsonmatchpattern) (Required) -* **MatchScope**: string (Required) -* **OversizeHandling**: string +* **Name**: string (Required, Identifier) +* **Value**: string (Required) -## JsonMatchPattern +## CustomHTTPHeader ### Properties -* **All**: [RuleGroup_All](#rulegroupall): Inspect all parts of the web request's JSON body. -* **IncludedPaths**: string[] +* **Name**: string (Required, Identifier) +* **Value**: string (Required) -## RuleGroup_All +## CustomRequestHandling ### Properties +* **InsertHeaders**: [CustomHTTPHeader](#customhttpheader)[] (Required): Collection of HTTP headers. -## RuleGroup_Method +## CustomRequestHandling ### Properties +* **InsertHeaders**: [CustomHTTPHeader](#customhttpheader)[] (Required): Collection of HTTP headers. -## RuleGroup_QueryString +## CustomResponse ### Properties +* **CustomResponseBodyKey**: string: Custom response body key. +* **ResponseCode**: int (Required) +* **ResponseHeaders**: [CustomHTTPHeader](#customhttpheader)[]: Collection of HTTP headers. -## RuleGroup_SingleHeader +## CustomResponse ### Properties -* **Name**: string (Required, Identifier) +* **CustomResponseBodyKey**: string: Custom response body key. +* **ResponseCode**: int (Required) +* **ResponseHeaders**: [CustomHTTPHeader](#customhttpheader)[]: Collection of HTTP headers. -## RuleGroup_SingleQueryArgument +## CustomResponseBodies ### Properties -* **Name**: string (Required, Identifier) -## RuleGroup_UriPath +## CustomResponseBodies ### Properties -## TextTransformation +## DefaultAction ### Properties -* **Priority**: int (Required) -* **Type**: string (Required) +* **Allow**: [AllowAction](#allowaction) +* **Block**: [BlockAction](#blockaction) -## GeoMatchStatement +## ExcludedRule ### Properties -* **CountryCodes**: string[] -* **ForwardedIPConfig**: [ForwardedIPConfiguration](#forwardedipconfiguration) +* **Name**: string (Required, Identifier) -## ForwardedIPConfiguration +## FieldIdentifier ### Properties -* **FallbackBehavior**: string (Required) -* **HeaderName**: string (Required) +* **Identifier**: string (Required) -## IPSetReferenceStatement +## FieldToMatch ### Properties -* **Arn**: string (Required) -* **IPSetForwardedIPConfig**: [IPSetForwardedIPConfiguration](#ipsetforwardedipconfiguration) +* **Method**: [LoggingConfiguration_Method](#loggingconfigurationmethod): Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform. +* **QueryString**: [LoggingConfiguration_QueryString](#loggingconfigurationquerystring): Inspect the query string. This is the part of a URL that appears after a ? character, if any. +* **SingleHeader**: [LoggingConfiguration_SingleHeader](#loggingconfigurationsingleheader): Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive. +* **UriPath**: [LoggingConfiguration_UriPath](#loggingconfigurationuripath): Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg. -## IPSetForwardedIPConfiguration +## FieldToMatch ### Properties -* **FallbackBehavior**: string (Required) -* **HeaderName**: string (Required) -* **Position**: string (Required) +* **AllQueryArguments**: [RuleGroup_AllQueryArguments](#rulegroupallqueryarguments): All query arguments of a web request. +* **Body**: [Body](#body) +* **Cookies**: [Cookies](#cookies) +* **Headers**: [Headers](#headers) +* **JA3Fingerprint**: [JA3Fingerprint](#ja3fingerprint) +* **JsonBody**: [JsonBody](#jsonbody) +* **Method**: [RuleGroup_Method](#rulegroupmethod): The HTTP method of a web request. The method indicates the type of operation that the request is asking the origin to perform. +* **QueryString**: [RuleGroup_QueryString](#rulegroupquerystring): The query string of a web request. This is the part of a URL that appears after a ? character, if any. +* **SingleHeader**: [RuleGroup_SingleHeader](#rulegroupsingleheader) +* **SingleQueryArgument**: [RuleGroup_SingleQueryArgument](#rulegroupsinglequeryargument): One query argument in a web request, identified by name, for example UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive. +* **UriPath**: [RuleGroup_UriPath](#rulegroupuripath): The path component of the URI of a web request. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg. -## LabelMatchStatement +## FieldToMatch ### Properties -* **Key**: string (Required) -* **Scope**: string (Required, Identifier) +* **AllQueryArguments**: [WebACL_AllQueryArguments](#webaclallqueryarguments): All query arguments of a web request. +* **Body**: [Body](#body) +* **Cookies**: [Cookies](#cookies) +* **Headers**: [Headers](#headers) +* **JA3Fingerprint**: [JA3Fingerprint](#ja3fingerprint) +* **JsonBody**: [JsonBody](#jsonbody) +* **Method**: [WebACL_Method](#webaclmethod): The HTTP method of a web request. The method indicates the type of operation that the request is asking the origin to perform. +* **QueryString**: [WebACL_QueryString](#webaclquerystring): The query string of a web request. This is the part of a URL that appears after a ? character, if any. +* **SingleHeader**: [WebACL_SingleHeader](#webaclsingleheader) +* **SingleQueryArgument**: [WebACL_SingleQueryArgument](#webaclsinglequeryargument): One query argument in a web request, identified by name, for example UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive. +* **UriPath**: [WebACL_UriPath](#webacluripath): The path component of the URI of a web request. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg. -## NotStatement +## Filter ### Properties -* **Statement**: [Statement](#statement) (Required) +* **Behavior**: string (Required): How to handle logs that satisfy the filter's conditions and requirement. +* **Conditions**: [Condition](#condition)[] (Required): Match conditions for the filter. +* **Requirement**: string (Required): Logic to apply to the filtering conditions. You can specify that, in order to satisfy the filter, a log must match all conditions or must match at least one condition. -## OrStatement +## ForwardedIPConfiguration ### Properties -* **Statements**: [Statement](#statement)[] (Required) +* **FallbackBehavior**: string (Required) +* **HeaderName**: string (Required) -## RateBasedStatement +## ForwardedIPConfiguration ### Properties -* **AggregateKeyType**: string (Required) -* **CustomKeys**: [RateBasedStatementCustomKey](#ratebasedstatementcustomkey)[]: Specifies the aggregate keys to use in a rate-base rule. -* **ForwardedIPConfig**: [ForwardedIPConfiguration](#forwardedipconfiguration) -* **Limit**: int (Required) -* **ScopeDownStatement**: [Statement](#statement) +* **FallbackBehavior**: string (Required) +* **HeaderName**: string (Required) -## RateBasedStatementCustomKey +## GeoMatchStatement ### Properties -* **Cookie**: [RateLimitCookie](#ratelimitcookie) -* **ForwardedIP**: [RateLimitForwardedIP](#ratelimitforwardedip) -* **Header**: [RateLimitHeader](#ratelimitheader) -* **HTTPMethod**: [RateLimitHTTPMethod](#ratelimithttpmethod) -* **IP**: [RateLimitIP](#ratelimitip) -* **LabelNamespace**: [RateLimitLabelNamespace](#ratelimitlabelnamespace) -* **QueryArgument**: [RateLimitQueryArgument](#ratelimitqueryargument) -* **QueryString**: [RateLimitQueryString](#ratelimitquerystring) -* **UriPath**: [RateLimitUriPath](#ratelimituripath) +* **CountryCodes**: string[] +* **ForwardedIPConfig**: [ForwardedIPConfiguration](#forwardedipconfiguration) -## RateLimitCookie +## GeoMatchStatement ### Properties -* **Name**: string (Required, Identifier): The name of the cookie to use. -* **TextTransformations**: [TextTransformation](#texttransformation)[] (Required) +* **CountryCodes**: string[] +* **ForwardedIPConfig**: [ForwardedIPConfiguration](#forwardedipconfiguration) -## RateLimitForwardedIP +## HeaderMatchPattern ### Properties +* **All**: [RuleGroup_All](#rulegroupall): Inspect all parts of the web request headers. +* **ExcludedHeaders**: string[] +* **IncludedHeaders**: string[] -## RateLimitHeader +## HeaderMatchPattern ### Properties -* **Name**: string (Required, Identifier): The name of the header to use. -* **TextTransformations**: [TextTransformation](#texttransformation)[] (Required) +* **All**: [WebACL_All](#webaclall): Inspect all parts of the web request headers. +* **ExcludedHeaders**: string[] +* **IncludedHeaders**: string[] -## RateLimitHTTPMethod +## Headers ### Properties +* **MatchPattern**: [HeaderMatchPattern](#headermatchpattern) (Required) +* **MatchScope**: string (Required) +* **OversizeHandling**: string (Required) -## RateLimitIP +## Headers ### Properties +* **MatchPattern**: [HeaderMatchPattern](#headermatchpattern) (Required) +* **MatchScope**: string (Required) +* **OversizeHandling**: string (Required) -## RateLimitLabelNamespace +## ImmunityTimeProperty ### Properties -* **Namespace**: string (Required): The namespace to use for aggregation. +* **ImmunityTime**: int (Required) -## RateLimitQueryArgument +## ImmunityTimeProperty ### Properties -* **Name**: string (Required, Identifier): The name of the query argument to use. -* **TextTransformations**: [TextTransformation](#texttransformation)[] (Required) +* **ImmunityTime**: int (Required) -## RateLimitQueryString +## IPSetForwardedIPConfiguration ### Properties -* **TextTransformations**: [TextTransformation](#texttransformation)[] (Required) +* **FallbackBehavior**: string (Required) +* **HeaderName**: string (Required) +* **Position**: string (Required) -## RateLimitUriPath +## IPSetForwardedIPConfiguration ### Properties -* **TextTransformations**: [TextTransformation](#texttransformation)[] (Required) +* **FallbackBehavior**: string (Required) +* **HeaderName**: string (Required) +* **Position**: string (Required) -## RegexMatchStatement +## IPSetReferenceStatement ### Properties -* **FieldToMatch**: [FieldToMatch](#fieldtomatch) (Required) -* **RegexString**: string (Required) -* **TextTransformations**: [TextTransformation](#texttransformation)[] (Required) +* **Arn**: string (Required) +* **IPSetForwardedIPConfig**: [IPSetForwardedIPConfiguration](#ipsetforwardedipconfiguration) -## RegexPatternSetReferenceStatement +## IPSetReferenceStatement ### Properties * **Arn**: string (Required) -* **FieldToMatch**: [FieldToMatch](#fieldtomatch) (Required) -* **TextTransformations**: [TextTransformation](#texttransformation)[] (Required) +* **IPSetForwardedIPConfig**: [IPSetForwardedIPConfiguration](#ipsetforwardedipconfiguration) -## SizeConstraintStatement +## JA3Fingerprint ### Properties -* **ComparisonOperator**: string (Required) -* **FieldToMatch**: [FieldToMatch](#fieldtomatch) (Required) -* **Size**: int (Required) -* **TextTransformations**: [TextTransformation](#texttransformation)[] (Required) +* **FallbackBehavior**: string (Required) -## SqliMatchStatement +## JA3Fingerprint ### Properties -* **FieldToMatch**: [FieldToMatch](#fieldtomatch) (Required) -* **SensitivityLevel**: string -* **TextTransformations**: [TextTransformation](#texttransformation)[] (Required) +* **FallbackBehavior**: string (Required) -## XssMatchStatement +## JsonBody ### Properties -* **FieldToMatch**: [FieldToMatch](#fieldtomatch) (Required) -* **TextTransformations**: [TextTransformation](#texttransformation)[] (Required) +* **InvalidFallbackBehavior**: string +* **MatchPattern**: [JsonMatchPattern](#jsonmatchpattern) (Required) +* **MatchScope**: string (Required) +* **OversizeHandling**: string -## VisibilityConfig +## JsonBody ### Properties -* **CloudWatchMetricsEnabled**: bool (Required) -* **MetricName**: string (Required) -* **SampledRequestsEnabled**: bool (Required) +* **InvalidFallbackBehavior**: string +* **MatchPattern**: [JsonMatchPattern](#jsonmatchpattern) (Required) +* **MatchScope**: string (Required) +* **OversizeHandling**: string -## Tag +## JsonMatchPattern ### Properties -* **Key**: string -* **Value**: string +* **All**: [RuleGroup_All](#rulegroupall): Inspect all parts of the web request's JSON body. +* **IncludedPaths**: string[] -## AWS.WAFv2/WebACLProperties +## JsonMatchPattern ### Properties -* **Arn**: string (ReadOnly) -* **AssociationConfig**: [AssociationConfig](#associationconfig) -* **Capacity**: int (ReadOnly) -* **CaptchaConfig**: [CaptchaConfig](#captchaconfig) -* **ChallengeConfig**: [ChallengeConfig](#challengeconfig) -* **CustomResponseBodies**: [CustomResponseBodies](#customresponsebodies) -* **DefaultAction**: [DefaultAction](#defaultaction) (Required) -* **Description**: string -* **Id**: string (ReadOnly, Identifier) -* **LabelNamespace**: string (ReadOnly) -* **Name**: string (Identifier) -* **Rules**: [Rule](#rule)[]: Collection of Rules. -* **Scope**: string (Required, Identifier) -* **Tags**: [Tag](#tag)[] -* **TokenDomains**: string[] -* **VisibilityConfig**: [VisibilityConfig](#visibilityconfig) (Required) +* **All**: [WebACL_All](#webaclall): Inspect all parts of the web request's JSON body. +* **IncludedPaths**: string[] -## AssociationConfig +## Label ### Properties -* **RequestBody**: [RequestBody](#requestbody) +* **Name**: string (Required, Identifier) -## RequestBody +## Label ### Properties +* **Name**: string (Required, Identifier) -## CaptchaConfig +## LabelMatchStatement ### Properties -* **ImmunityTimeProperty**: [ImmunityTimeProperty](#immunitytimeproperty) +* **Key**: string (Required) +* **Scope**: string (Required, Identifier) -## ImmunityTimeProperty +## LabelMatchStatement ### Properties -* **ImmunityTime**: int (Required) +* **Key**: string (Required) +* **Scope**: string (Required, Identifier) -## ChallengeConfig +## LabelSummary ### Properties -* **ImmunityTimeProperty**: [ImmunityTimeProperty](#immunitytimeproperty) +* **Name**: string (Identifier) -## CustomResponseBodies +## LoggingConfiguration_ActionCondition ### Properties +* **Action**: string (Required): Logic to apply to the filtering conditions. You can specify that, in order to satisfy the filter, a log must match all conditions or must match at least one condition. -## DefaultAction +## LoggingConfiguration_LabelNameCondition ### Properties -* **Allow**: [AllowAction](#allowaction) -* **Block**: [BlockAction](#blockaction) +* **LabelName**: string (Required): The label name that a log record must contain in order to meet the condition. This must be a fully qualified label name. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label. -## AllowAction +## LoggingConfiguration_LoggingFilter ### Properties -* **CustomRequestHandling**: [CustomRequestHandling](#customrequesthandling) +* **DefaultBehavior**: string (Required): Default handling for logs that don't match any of the specified filtering conditions. +* **Filters**: [Filter](#filter)[] (Required): The filters that you want to apply to the logs. -## CustomRequestHandling +## LoggingConfiguration_Method ### Properties -* **InsertHeaders**: [CustomHTTPHeader](#customhttpheader)[] (Required): Collection of HTTP headers. -## CustomHTTPHeader +## LoggingConfiguration_QueryString ### Properties -* **Name**: string (Required, Identifier) -* **Value**: string (Required) -## BlockAction +## LoggingConfiguration_SingleHeader ### Properties -* **CustomResponse**: [CustomResponse](#customresponse) +* **Name**: string (Required): The name of the query header to inspect. -## CustomResponse +## LoggingConfiguration_UriPath ### Properties -* **CustomResponseBodyKey**: string: Custom response body key. -* **ResponseCode**: int (Required) -* **ResponseHeaders**: [CustomHTTPHeader](#customhttpheader)[]: Collection of HTTP headers. -## Rule +## ManagedRuleGroupConfig ### Properties -* **Action**: [RuleAction](#ruleaction) -* **CaptchaConfig**: [CaptchaConfig](#captchaconfig) -* **ChallengeConfig**: [ChallengeConfig](#challengeconfig) +* **AWSManagedRulesACFPRuleSet**: [AWSManagedRulesACFPRuleSet](#awsmanagedrulesacfpruleset) +* **AWSManagedRulesATPRuleSet**: [AWSManagedRulesATPRuleSet](#awsmanagedrulesatpruleset) +* **AWSManagedRulesBotControlRuleSet**: [AWSManagedRulesBotControlRuleSet](#awsmanagedrulesbotcontrolruleset) +* **LoginPath**: string +* **PasswordField**: [FieldIdentifier](#fieldidentifier) +* **PayloadType**: string +* **UsernameField**: [FieldIdentifier](#fieldidentifier) + +## ManagedRuleGroupStatement +### Properties +* **ExcludedRules**: [ExcludedRule](#excludedrule)[] +* **ManagedRuleGroupConfigs**: [ManagedRuleGroupConfig](#managedrulegroupconfig)[]: Collection of ManagedRuleGroupConfig. * **Name**: string (Required, Identifier) -* **OverrideAction**: [OverrideAction](#overrideaction) -* **Priority**: int (Required) -* **RuleLabels**: [Label](#label)[]: Collection of Rule Labels. -* **Statement**: [Statement](#statement) (Required) -* **VisibilityConfig**: [VisibilityConfig](#visibilityconfig) (Required) +* **RuleActionOverrides**: [RuleActionOverride](#ruleactionoverride)[]: Action overrides for rules in the rule group. +* **ScopeDownStatement**: [Statement](#statement) +* **VendorName**: string (Required) +* **Version**: string -## RuleAction +## NotStatement ### Properties -* **Allow**: [AllowAction](#allowaction) -* **Block**: [BlockAction](#blockaction) -* **Captcha**: [CaptchaAction](#captchaaction) -* **Challenge**: [ChallengeAction](#challengeaction) -* **Count**: [CountAction](#countaction) +* **Statement**: [Statement](#statement) (Required) -## CaptchaAction +## NotStatement ### Properties -* **CustomRequestHandling**: [CustomRequestHandling](#customrequesthandling) +* **Statement**: [Statement](#statement) (Required) -## ChallengeAction +## OrStatement ### Properties -* **CustomRequestHandling**: [CustomRequestHandling](#customrequesthandling) +* **Statements**: [Statement](#statement)[] (Required) -## CountAction +## OrStatement ### Properties -* **CustomRequestHandling**: [CustomRequestHandling](#customrequesthandling) +* **Statements**: [Statement](#statement)[] (Required) ## OverrideAction ### Properties * **Count**: [WebACL_Count](#webaclcount): Count traffic towards application. * **None**: [WebACL_None](#webaclnone): Keep the RuleGroup or ManagedRuleGroup behavior as is. -## WebACL_Count -### Properties - -## WebACL_None +## RateBasedStatement ### Properties +* **AggregateKeyType**: string (Required) +* **CustomKeys**: [RateBasedStatementCustomKey](#ratebasedstatementcustomkey)[]: Specifies the aggregate keys to use in a rate-base rule. +* **EvaluationWindowSec**: int +* **ForwardedIPConfig**: [ForwardedIPConfiguration](#forwardedipconfiguration) +* **Limit**: int (Required) +* **ScopeDownStatement**: [Statement](#statement) -## Label +## RateBasedStatement ### Properties -* **Name**: string (Required, Identifier) +* **AggregateKeyType**: string (Required) +* **CustomKeys**: [RateBasedStatementCustomKey](#ratebasedstatementcustomkey)[]: Specifies the aggregate keys to use in a rate-base rule. +* **EvaluationWindowSec**: int +* **ForwardedIPConfig**: [ForwardedIPConfiguration](#forwardedipconfiguration) +* **Limit**: int (Required) +* **ScopeDownStatement**: [Statement](#statement) -## Statement +## RateBasedStatementCustomKey ### Properties -* **AndStatement**: [AndStatement](#andstatement) -* **ByteMatchStatement**: [ByteMatchStatement](#bytematchstatement) -* **GeoMatchStatement**: [GeoMatchStatement](#geomatchstatement) -* **IPSetReferenceStatement**: [IPSetReferenceStatement](#ipsetreferencestatement) -* **LabelMatchStatement**: [LabelMatchStatement](#labelmatchstatement) -* **ManagedRuleGroupStatement**: [ManagedRuleGroupStatement](#managedrulegroupstatement) -* **NotStatement**: [NotStatement](#notstatement) -* **OrStatement**: [OrStatement](#orstatement) -* **RateBasedStatement**: [RateBasedStatement](#ratebasedstatement) -* **RegexMatchStatement**: [RegexMatchStatement](#regexmatchstatement) -* **RegexPatternSetReferenceStatement**: [RegexPatternSetReferenceStatement](#regexpatternsetreferencestatement) -* **RuleGroupReferenceStatement**: [RuleGroupReferenceStatement](#rulegroupreferencestatement) -* **SizeConstraintStatement**: [SizeConstraintStatement](#sizeconstraintstatement) -* **SqliMatchStatement**: [SqliMatchStatement](#sqlimatchstatement) -* **XssMatchStatement**: [XssMatchStatement](#xssmatchstatement) +* **Cookie**: [RateLimitCookie](#ratelimitcookie) +* **ForwardedIP**: [RateLimitForwardedIP](#ratelimitforwardedip) +* **Header**: [RateLimitHeader](#ratelimitheader) +* **HTTPMethod**: [RateLimitHTTPMethod](#ratelimithttpmethod) +* **IP**: [RateLimitIP](#ratelimitip) +* **LabelNamespace**: [RateLimitLabelNamespace](#ratelimitlabelnamespace) +* **QueryArgument**: [RateLimitQueryArgument](#ratelimitqueryargument) +* **QueryString**: [RateLimitQueryString](#ratelimitquerystring) +* **UriPath**: [RateLimitUriPath](#ratelimituripath) -## AndStatement +## RateBasedStatementCustomKey ### Properties -* **Statements**: [Statement](#statement)[] (Required) +* **Cookie**: [RateLimitCookie](#ratelimitcookie) +* **ForwardedIP**: [RateLimitForwardedIP](#ratelimitforwardedip) +* **Header**: [RateLimitHeader](#ratelimitheader) +* **HTTPMethod**: [RateLimitHTTPMethod](#ratelimithttpmethod) +* **IP**: [RateLimitIP](#ratelimitip) +* **LabelNamespace**: [RateLimitLabelNamespace](#ratelimitlabelnamespace) +* **QueryArgument**: [RateLimitQueryArgument](#ratelimitqueryargument) +* **QueryString**: [RateLimitQueryString](#ratelimitquerystring) +* **UriPath**: [RateLimitUriPath](#ratelimituripath) -## ByteMatchStatement +## RateLimitCookie ### Properties -* **FieldToMatch**: [FieldToMatch](#fieldtomatch) (Required) -* **PositionalConstraint**: string (Required) -* **SearchString**: string -* **SearchStringBase64**: string +* **Name**: string (Required, Identifier): The name of the cookie to use. * **TextTransformations**: [TextTransformation](#texttransformation)[] (Required) -## FieldToMatch -### Properties -* **AllQueryArguments**: [WebACL_AllQueryArguments](#webaclallqueryarguments): All query arguments of a web request. -* **Body**: [Body](#body) -* **Cookies**: [Cookies](#cookies) -* **Headers**: [Headers](#headers) -* **JsonBody**: [JsonBody](#jsonbody) -* **Method**: [WebACL_Method](#webaclmethod): The HTTP method of a web request. The method indicates the type of operation that the request is asking the origin to perform. -* **QueryString**: [WebACL_QueryString](#webaclquerystring): The query string of a web request. This is the part of a URL that appears after a ? character, if any. -* **SingleHeader**: [WebACL_SingleHeader](#webaclsingleheader) -* **SingleQueryArgument**: [WebACL_SingleQueryArgument](#webaclsinglequeryargument): One query argument in a web request, identified by name, for example UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive. -* **UriPath**: [WebACL_UriPath](#webacluripath): The path component of the URI of a web request. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg. - -## WebACL_AllQueryArguments +## RateLimitCookie ### Properties +* **Name**: string (Required, Identifier): The name of the cookie to use. +* **TextTransformations**: [TextTransformation](#texttransformation)[] (Required) -## Body +## RateLimitForwardedIP ### Properties -* **OversizeHandling**: string -## Cookies +## RateLimitForwardedIP ### Properties -* **MatchPattern**: [CookieMatchPattern](#cookiematchpattern) (Required) -* **MatchScope**: string (Required) -* **OversizeHandling**: string (Required) -## CookieMatchPattern +## RateLimitHeader ### Properties -* **All**: [WebACL_All](#webaclall): Inspect all parts of the web request cookies. -* **ExcludedCookies**: string[] -* **IncludedCookies**: string[] +* **Name**: string (Required, Identifier): The name of the header to use. +* **TextTransformations**: [TextTransformation](#texttransformation)[] (Required) -## WebACL_All +## RateLimitHeader ### Properties +* **Name**: string (Required, Identifier): The name of the header to use. +* **TextTransformations**: [TextTransformation](#texttransformation)[] (Required) -## Headers +## RateLimitHTTPMethod ### Properties -* **MatchPattern**: [HeaderMatchPattern](#headermatchpattern) (Required) -* **MatchScope**: string (Required) -* **OversizeHandling**: string (Required) -## HeaderMatchPattern +## RateLimitHTTPMethod ### Properties -* **All**: [WebACL_All](#webaclall): Inspect all parts of the web request headers. -* **ExcludedHeaders**: string[] -* **IncludedHeaders**: string[] -## WebACL_All +## RateLimitIP ### Properties -## JsonBody +## RateLimitIP ### Properties -* **InvalidFallbackBehavior**: string -* **MatchPattern**: [JsonMatchPattern](#jsonmatchpattern) (Required) -* **MatchScope**: string (Required) -* **OversizeHandling**: string -## JsonMatchPattern +## RateLimitLabelNamespace ### Properties -* **All**: [WebACL_All](#webaclall): Inspect all parts of the web request's JSON body. -* **IncludedPaths**: string[] +* **Namespace**: string (Required): The namespace to use for aggregation. -## WebACL_All +## RateLimitLabelNamespace ### Properties +* **Namespace**: string (Required): The namespace to use for aggregation. -## WebACL_Method +## RateLimitQueryArgument ### Properties +* **Name**: string (Required, Identifier): The name of the query argument to use. +* **TextTransformations**: [TextTransformation](#texttransformation)[] (Required) -## WebACL_QueryString +## RateLimitQueryArgument ### Properties +* **Name**: string (Required, Identifier): The name of the query argument to use. +* **TextTransformations**: [TextTransformation](#texttransformation)[] (Required) -## WebACL_SingleHeader +## RateLimitQueryString ### Properties -* **Name**: string (Required, Identifier) +* **TextTransformations**: [TextTransformation](#texttransformation)[] (Required) -## WebACL_SingleQueryArgument +## RateLimitQueryString ### Properties -* **Name**: string (Required, Identifier) +* **TextTransformations**: [TextTransformation](#texttransformation)[] (Required) -## WebACL_UriPath +## RateLimitUriPath ### Properties +* **TextTransformations**: [TextTransformation](#texttransformation)[] (Required) -## TextTransformation +## RateLimitUriPath ### Properties -* **Priority**: int (Required) -* **Type**: string (Required) +* **TextTransformations**: [TextTransformation](#texttransformation)[] (Required) -## GeoMatchStatement +## RegexMatchStatement ### Properties -* **CountryCodes**: string[] -* **ForwardedIPConfig**: [ForwardedIPConfiguration](#forwardedipconfiguration) +* **FieldToMatch**: [FieldToMatch](#fieldtomatch) (Required) +* **RegexString**: string (Required) +* **TextTransformations**: [TextTransformation](#texttransformation)[] (Required) -## ForwardedIPConfiguration +## RegexMatchStatement ### Properties -* **FallbackBehavior**: string (Required) -* **HeaderName**: string (Required) +* **FieldToMatch**: [FieldToMatch](#fieldtomatch) (Required) +* **RegexString**: string (Required) +* **TextTransformations**: [TextTransformation](#texttransformation)[] (Required) -## IPSetReferenceStatement +## RegexPatternSetReferenceStatement ### Properties * **Arn**: string (Required) -* **IPSetForwardedIPConfig**: [IPSetForwardedIPConfiguration](#ipsetforwardedipconfiguration) - -## IPSetForwardedIPConfiguration -### Properties -* **FallbackBehavior**: string (Required) -* **HeaderName**: string (Required) -* **Position**: string (Required) - -## LabelMatchStatement -### Properties -* **Key**: string (Required) -* **Scope**: string (Required, Identifier) - -## ManagedRuleGroupStatement -### Properties -* **ExcludedRules**: [ExcludedRule](#excludedrule)[] -* **ManagedRuleGroupConfigs**: [ManagedRuleGroupConfig](#managedrulegroupconfig)[]: Collection of ManagedRuleGroupConfig. -* **Name**: string (Required, Identifier) -* **RuleActionOverrides**: [RuleActionOverride](#ruleactionoverride)[]: Action overrides for rules in the rule group. -* **ScopeDownStatement**: [Statement](#statement) -* **VendorName**: string (Required) -* **Version**: string +* **FieldToMatch**: [FieldToMatch](#fieldtomatch) (Required) +* **TextTransformations**: [TextTransformation](#texttransformation)[] (Required) -## ExcludedRule +## RegexPatternSetReferenceStatement ### Properties -* **Name**: string (Required, Identifier) +* **Arn**: string (Required) +* **FieldToMatch**: [FieldToMatch](#fieldtomatch) (Required) +* **TextTransformations**: [TextTransformation](#texttransformation)[] (Required) -## ManagedRuleGroupConfig +## RequestBody ### Properties -* **AWSManagedRulesACFPRuleSet**: [AWSManagedRulesACFPRuleSet](#awsmanagedrulesacfpruleset) -* **AWSManagedRulesATPRuleSet**: [AWSManagedRulesATPRuleSet](#awsmanagedrulesatpruleset) -* **AWSManagedRulesBotControlRuleSet**: [AWSManagedRulesBotControlRuleSet](#awsmanagedrulesbotcontrolruleset) -* **LoginPath**: string -* **PasswordField**: [FieldIdentifier](#fieldidentifier) -* **PayloadType**: string -* **UsernameField**: [FieldIdentifier](#fieldidentifier) -## AWSManagedRulesACFPRuleSet +## RequestInspection ### Properties -* **CreationPath**: string (Required) -* **EnableRegexInPath**: bool -* **RegistrationPagePath**: string (Required) -* **RequestInspection**: [RequestInspectionACFP](#requestinspectionacfp) (Required) -* **ResponseInspection**: [ResponseInspection](#responseinspection) +* **PasswordField**: [FieldIdentifier](#fieldidentifier) (Required) +* **PayloadType**: string (Required) +* **UsernameField**: [FieldIdentifier](#fieldidentifier) (Required) ## RequestInspectionACFP ### Properties @@ -779,16 +693,6 @@ * **PhoneNumberFields**: [WebACL_PhoneNumberField](#webaclphonenumberfield)[] * **UsernameField**: [FieldIdentifier](#fieldidentifier) -## WebACL_AddressField -### Properties - -## FieldIdentifier -### Properties -* **Identifier**: string (Required) - -## WebACL_PhoneNumberField -### Properties - ## ResponseInspection ### Properties * **BodyContains**: [ResponseInspectionBodyContains](#responseinspectionbodycontains) @@ -818,128 +722,174 @@ * **FailureCodes**: int[] (Required) * **SuccessCodes**: int[] (Required) -## AWSManagedRulesATPRuleSet +## Rule ### Properties -* **EnableRegexInPath**: bool -* **LoginPath**: string (Required) -* **RequestInspection**: [RequestInspection](#requestinspection) -* **ResponseInspection**: [ResponseInspection](#responseinspection) +* **Action**: [RuleAction](#ruleaction) +* **CaptchaConfig**: [CaptchaConfig](#captchaconfig) +* **ChallengeConfig**: [ChallengeConfig](#challengeconfig) +* **Name**: string (Required, Identifier) +* **Priority**: int (Required) +* **RuleLabels**: [Label](#label)[]: Collection of Rule Labels. +* **Statement**: [Statement](#statement) (Required) +* **VisibilityConfig**: [VisibilityConfig](#visibilityconfig) (Required) -## RequestInspection +## Rule ### Properties -* **PasswordField**: [FieldIdentifier](#fieldidentifier) (Required) -* **PayloadType**: string (Required) -* **UsernameField**: [FieldIdentifier](#fieldidentifier) (Required) +* **Action**: [RuleAction](#ruleaction) +* **CaptchaConfig**: [CaptchaConfig](#captchaconfig) +* **ChallengeConfig**: [ChallengeConfig](#challengeconfig) +* **Name**: string (Required, Identifier) +* **OverrideAction**: [OverrideAction](#overrideaction) +* **Priority**: int (Required) +* **RuleLabels**: [Label](#label)[]: Collection of Rule Labels. +* **Statement**: [Statement](#statement) (Required) +* **VisibilityConfig**: [VisibilityConfig](#visibilityconfig) (Required) -## AWSManagedRulesBotControlRuleSet +## RuleAction ### Properties -* **EnableMachineLearning**: bool -* **InspectionLevel**: string (Required) +* **Allow**: [AllowAction](#allowaction) +* **Block**: [BlockAction](#blockaction) +* **Captcha**: [CaptchaAction](#captchaaction) +* **Challenge**: [ChallengeAction](#challengeaction) +* **Count**: [CountAction](#countaction) + +## RuleAction +### Properties +* **Allow**: [AllowAction](#allowaction) +* **Block**: [BlockAction](#blockaction) +* **Captcha**: [CaptchaAction](#captchaaction) +* **Challenge**: [ChallengeAction](#challengeaction) +* **Count**: [CountAction](#countaction) ## RuleActionOverride ### Properties * **ActionToUse**: [RuleAction](#ruleaction) (Required) * **Name**: string (Required, Identifier) -## NotStatement +## RuleGroup_All ### Properties -* **Statement**: [Statement](#statement) (Required) -## OrStatement +## RuleGroup_All ### Properties -* **Statements**: [Statement](#statement)[] (Required) -## RateBasedStatement +## RuleGroup_All ### Properties -* **AggregateKeyType**: string (Required) -* **CustomKeys**: [RateBasedStatementCustomKey](#ratebasedstatementcustomkey)[]: Specifies the aggregate keys to use in a rate-base rule. -* **ForwardedIPConfig**: [ForwardedIPConfiguration](#forwardedipconfiguration) -* **Limit**: int (Required) -* **ScopeDownStatement**: [Statement](#statement) -## RateBasedStatementCustomKey +## RuleGroup_AllQueryArguments ### Properties -* **Cookie**: [RateLimitCookie](#ratelimitcookie) -* **ForwardedIP**: [RateLimitForwardedIP](#ratelimitforwardedip) -* **Header**: [RateLimitHeader](#ratelimitheader) -* **HTTPMethod**: [RateLimitHTTPMethod](#ratelimithttpmethod) -* **IP**: [RateLimitIP](#ratelimitip) -* **LabelNamespace**: [RateLimitLabelNamespace](#ratelimitlabelnamespace) -* **QueryArgument**: [RateLimitQueryArgument](#ratelimitqueryargument) -* **QueryString**: [RateLimitQueryString](#ratelimitquerystring) -* **UriPath**: [RateLimitUriPath](#ratelimituripath) -## RateLimitCookie +## RuleGroup_Method ### Properties -* **Name**: string (Required, Identifier): The name of the cookie to use. -* **TextTransformations**: [TextTransformation](#texttransformation)[] (Required) -## RateLimitForwardedIP +## RuleGroup_QueryString ### Properties -## RateLimitHeader +## RuleGroup_SingleHeader ### Properties -* **Name**: string (Required, Identifier): The name of the header to use. -* **TextTransformations**: [TextTransformation](#texttransformation)[] (Required) +* **Name**: string (Required, Identifier) -## RateLimitHTTPMethod +## RuleGroup_SingleQueryArgument ### Properties +* **Name**: string (Required, Identifier) -## RateLimitIP +## RuleGroup_UriPath ### Properties -## RateLimitLabelNamespace +## RuleGroupReferenceStatement ### Properties -* **Namespace**: string (Required): The namespace to use for aggregation. +* **Arn**: string (Required) +* **ExcludedRules**: [ExcludedRule](#excludedrule)[] +* **RuleActionOverrides**: [RuleActionOverride](#ruleactionoverride)[]: Action overrides for rules in the rule group. -## RateLimitQueryArgument +## SizeConstraintStatement ### Properties -* **Name**: string (Required, Identifier): The name of the query argument to use. +* **ComparisonOperator**: string (Required) +* **FieldToMatch**: [FieldToMatch](#fieldtomatch) (Required) +* **Size**: int (Required) * **TextTransformations**: [TextTransformation](#texttransformation)[] (Required) -## RateLimitQueryString +## SizeConstraintStatement ### Properties +* **ComparisonOperator**: string (Required) +* **FieldToMatch**: [FieldToMatch](#fieldtomatch) (Required) +* **Size**: int (Required) * **TextTransformations**: [TextTransformation](#texttransformation)[] (Required) -## RateLimitUriPath +## SqliMatchStatement ### Properties +* **FieldToMatch**: [FieldToMatch](#fieldtomatch) (Required) +* **SensitivityLevel**: string * **TextTransformations**: [TextTransformation](#texttransformation)[] (Required) -## RegexMatchStatement +## SqliMatchStatement ### Properties * **FieldToMatch**: [FieldToMatch](#fieldtomatch) (Required) -* **RegexString**: string (Required) +* **SensitivityLevel**: string * **TextTransformations**: [TextTransformation](#texttransformation)[] (Required) -## RegexPatternSetReferenceStatement +## Statement ### Properties -* **Arn**: string (Required) -* **FieldToMatch**: [FieldToMatch](#fieldtomatch) (Required) -* **TextTransformations**: [TextTransformation](#texttransformation)[] (Required) +* **AndStatement**: [AndStatement](#andstatement) +* **ByteMatchStatement**: [ByteMatchStatement](#bytematchstatement) +* **GeoMatchStatement**: [GeoMatchStatement](#geomatchstatement) +* **IPSetReferenceStatement**: [IPSetReferenceStatement](#ipsetreferencestatement) +* **LabelMatchStatement**: [LabelMatchStatement](#labelmatchstatement) +* **NotStatement**: [NotStatement](#notstatement) +* **OrStatement**: [OrStatement](#orstatement) +* **RateBasedStatement**: [RateBasedStatement](#ratebasedstatement) +* **RegexMatchStatement**: [RegexMatchStatement](#regexmatchstatement) +* **RegexPatternSetReferenceStatement**: [RegexPatternSetReferenceStatement](#regexpatternsetreferencestatement) +* **SizeConstraintStatement**: [SizeConstraintStatement](#sizeconstraintstatement) +* **SqliMatchStatement**: [SqliMatchStatement](#sqlimatchstatement) +* **XssMatchStatement**: [XssMatchStatement](#xssmatchstatement) -## RuleGroupReferenceStatement +## Statement ### Properties -* **Arn**: string (Required) -* **ExcludedRules**: [ExcludedRule](#excludedrule)[] -* **RuleActionOverrides**: [RuleActionOverride](#ruleactionoverride)[]: Action overrides for rules in the rule group. +* **AndStatement**: [AndStatement](#andstatement) +* **ByteMatchStatement**: [ByteMatchStatement](#bytematchstatement) +* **GeoMatchStatement**: [GeoMatchStatement](#geomatchstatement) +* **IPSetReferenceStatement**: [IPSetReferenceStatement](#ipsetreferencestatement) +* **LabelMatchStatement**: [LabelMatchStatement](#labelmatchstatement) +* **ManagedRuleGroupStatement**: [ManagedRuleGroupStatement](#managedrulegroupstatement) +* **NotStatement**: [NotStatement](#notstatement) +* **OrStatement**: [OrStatement](#orstatement) +* **RateBasedStatement**: [RateBasedStatement](#ratebasedstatement) +* **RegexMatchStatement**: [RegexMatchStatement](#regexmatchstatement) +* **RegexPatternSetReferenceStatement**: [RegexPatternSetReferenceStatement](#regexpatternsetreferencestatement) +* **RuleGroupReferenceStatement**: [RuleGroupReferenceStatement](#rulegroupreferencestatement) +* **SizeConstraintStatement**: [SizeConstraintStatement](#sizeconstraintstatement) +* **SqliMatchStatement**: [SqliMatchStatement](#sqlimatchstatement) +* **XssMatchStatement**: [XssMatchStatement](#xssmatchstatement) -## SizeConstraintStatement +## Tag ### Properties -* **ComparisonOperator**: string (Required) -* **FieldToMatch**: [FieldToMatch](#fieldtomatch) (Required) -* **Size**: int (Required) -* **TextTransformations**: [TextTransformation](#texttransformation)[] (Required) +* **Key**: string +* **Value**: string -## SqliMatchStatement +## Tag ### Properties -* **FieldToMatch**: [FieldToMatch](#fieldtomatch) (Required) -* **SensitivityLevel**: string -* **TextTransformations**: [TextTransformation](#texttransformation)[] (Required) +* **Key**: string +* **Value**: string -## XssMatchStatement +## Tag ### Properties -* **FieldToMatch**: [FieldToMatch](#fieldtomatch) (Required) -* **TextTransformations**: [TextTransformation](#texttransformation)[] (Required) +* **Key**: string +* **Value**: string + +## Tag +### Properties +* **Key**: string +* **Value**: string + +## TextTransformation +### Properties +* **Priority**: int (Required) +* **Type**: string (Required) + +## TextTransformation +### Properties +* **Priority**: int (Required) +* **Type**: string (Required) ## VisibilityConfig ### Properties @@ -947,13 +897,60 @@ * **MetricName**: string (Required) * **SampledRequestsEnabled**: bool (Required) -## Tag +## VisibilityConfig ### Properties -* **Key**: string -* **Value**: string +* **CloudWatchMetricsEnabled**: bool (Required) +* **MetricName**: string (Required) +* **SampledRequestsEnabled**: bool (Required) -## AWS.WAFv2/WebACLAssociationProperties +## WebACL_AddressField ### Properties -* **ResourceArn**: string (Required, Identifier) -* **WebACLArn**: string (Required, Identifier) + +## WebACL_All +### Properties + +## WebACL_All +### Properties + +## WebACL_All +### Properties + +## WebACL_AllQueryArguments +### Properties + +## WebACL_Count +### Properties + +## WebACL_Method +### Properties + +## WebACL_None +### Properties + +## WebACL_PhoneNumberField +### Properties + +## WebACL_QueryString +### Properties + +## WebACL_SingleHeader +### Properties +* **Name**: string (Required, Identifier) + +## WebACL_SingleQueryArgument +### Properties +* **Name**: string (Required, Identifier) + +## WebACL_UriPath +### Properties + +## XssMatchStatement +### Properties +* **FieldToMatch**: [FieldToMatch](#fieldtomatch) (Required) +* **TextTransformations**: [TextTransformation](#texttransformation)[] (Required) + +## XssMatchStatement +### Properties +* **FieldToMatch**: [FieldToMatch](#fieldtomatch) (Required) +* **TextTransformations**: [TextTransformation](#texttransformation)[] (Required) diff --git a/artifacts/bicep/aws/aws.wisdom/default/types.json b/artifacts/bicep/aws/aws.wisdom/default/types.json index f908e04d..faa8c9c5 100644 --- a/artifacts/bicep/aws/aws.wisdom/default/types.json +++ b/artifacts/bicep/aws/aws.wisdom/default/types.json @@ -1 +1,452 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"AssistantType"}},{"2":{"Name":"ServerSideEncryptionConfiguration","Properties":{"KmsKeyId":{"Type":4,"Flags":0}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.Wisdom/AssistantProperties","Properties":{"AssistantArn":{"Type":4,"Flags":2},"AssistantId":{"Type":4,"Flags":18},"Description":{"Type":4,"Flags":0},"Name":{"Type":4,"Flags":1},"ServerSideEncryptionConfiguration":{"Type":9,"Flags":0},"Tags":{"Type":12,"Flags":0},"Type":{"Type":4,"Flags":1}}}},{"3":{"ItemType":10}},{"2":{"Name":"AWS.Wisdom/Assistant","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":11,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Wisdom/Assistant@default","ScopeType":0,"Body":13}},{"2":{"Name":"AssociationData","Properties":{"KnowledgeBaseId":{"Type":4,"Flags":1}}}},{"2":{"Name":"AssociationType"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.Wisdom/AssistantAssociationProperties","Properties":{"AssistantArn":{"Type":4,"Flags":2},"AssistantAssociationArn":{"Type":4,"Flags":2},"AssistantAssociationId":{"Type":4,"Flags":18},"AssistantId":{"Type":4,"Flags":17},"Association":{"Type":15,"Flags":1},"AssociationType":{"Type":4,"Flags":1},"Tags":{"Type":19,"Flags":0}}}},{"3":{"ItemType":17}},{"2":{"Name":"AWS.Wisdom/AssistantAssociation","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":18,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Wisdom/AssistantAssociation@default","ScopeType":0,"Body":20}},{"2":{"Name":"AppIntegrationsConfiguration","Properties":{"AppIntegrationArn":{"Type":4,"Flags":1},"ObjectFields":{"Type":28,"Flags":0}}}},{"2":{"Name":"KnowledgeBaseType"}},{"2":{"Name":"RenderingConfiguration","Properties":{"TemplateUri":{"Type":4,"Flags":0}}}},{"2":{"Name":"ServerSideEncryptionConfiguration","Properties":{"KmsKeyId":{"Type":4,"Flags":0}}}},{"2":{"Name":"SourceConfiguration","Properties":{"AppIntegrations":{"Type":22,"Flags":1}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.Wisdom/KnowledgeBaseProperties","Properties":{"Description":{"Type":4,"Flags":0},"KnowledgeBaseArn":{"Type":4,"Flags":2},"KnowledgeBaseId":{"Type":4,"Flags":18},"KnowledgeBaseType":{"Type":4,"Flags":1},"Name":{"Type":4,"Flags":1},"RenderingConfiguration":{"Type":24,"Flags":0},"ServerSideEncryptionConfiguration":{"Type":25,"Flags":0},"SourceConfiguration":{"Type":26,"Flags":0},"Tags":{"Type":30,"Flags":0}}}},{"3":{"ItemType":27}},{"2":{"Name":"AWS.Wisdom/KnowledgeBase","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":29,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.Wisdom/KnowledgeBase@default","ScopeType":0,"Body":31}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "AssistantType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "ServerSideEncryptionConfiguration", + "properties": { + "KmsKeyId": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.Wisdom/AssistantProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Wisdom/AssistantProperties", + "properties": { + "AssistantArn": { + "type": { + "$ref": "#/3" + }, + "flags": 2 + }, + "AssistantId": { + "type": { + "$ref": "#/3" + }, + "flags": 18 + }, + "Description": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "Name": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + }, + "ServerSideEncryptionConfiguration": { + "type": { + "$ref": "#/1" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Type": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Wisdom/Assistant", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/6" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Wisdom/Assistant@default", + "scopeType": 0, + "body": { + "$ref": "#/7" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AssociationData", + "properties": { + "KnowledgeBaseId": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AssociationType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Wisdom/AssistantAssociationProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/11" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Wisdom/AssistantAssociationProperties", + "properties": { + "AssistantArn": { + "type": { + "$ref": "#/3" + }, + "flags": 2 + }, + "AssistantAssociationArn": { + "type": { + "$ref": "#/3" + }, + "flags": 2 + }, + "AssistantAssociationId": { + "type": { + "$ref": "#/3" + }, + "flags": 18 + }, + "AssistantId": { + "type": { + "$ref": "#/3" + }, + "flags": 17 + }, + "Association": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + }, + "AssociationType": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/13" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Wisdom/AssistantAssociation", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/14" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Wisdom/AssistantAssociation@default", + "scopeType": 0, + "body": { + "$ref": "#/15" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AppIntegrationsConfiguration", + "properties": { + "AppIntegrationArn": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + }, + "ObjectFields": { + "type": { + "$ref": "#/23" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "KnowledgeBaseType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RenderingConfiguration", + "properties": { + "TemplateUri": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "ServerSideEncryptionConfiguration", + "properties": { + "KmsKeyId": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SourceConfiguration", + "properties": { + "AppIntegrations": { + "type": { + "$ref": "#/17" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.Wisdom/KnowledgeBaseProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/22" + } + }, + { + "$type": "ObjectType", + "name": "AWS.Wisdom/KnowledgeBaseProperties", + "properties": { + "Description": { + "type": { + "$ref": "#/3" + }, + "flags": 0 + }, + "KnowledgeBaseArn": { + "type": { + "$ref": "#/3" + }, + "flags": 2 + }, + "KnowledgeBaseId": { + "type": { + "$ref": "#/3" + }, + "flags": 18 + }, + "KnowledgeBaseType": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/3" + }, + "flags": 1 + }, + "RenderingConfiguration": { + "type": { + "$ref": "#/19" + }, + "flags": 0 + }, + "ServerSideEncryptionConfiguration": { + "type": { + "$ref": "#/20" + }, + "flags": 0 + }, + "SourceConfiguration": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/25" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.Wisdom/KnowledgeBase", + "properties": { + "name": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/3" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/26" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.Wisdom/KnowledgeBase@default", + "scopeType": 0, + "body": { + "$ref": "#/27" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.wisdom/default/types.md b/artifacts/bicep/aws/aws.wisdom/default/types.md index 8c3fbd46..2e5693bd 100644 --- a/artifacts/bicep/aws/aws.wisdom/default/types.md +++ b/artifacts/bicep/aws/aws.wisdom/default/types.md @@ -3,42 +3,32 @@ ## Resource AWS.Wisdom/Assistant@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Wisdom/AssistantProperties](#awswisdomassistantproperties) (Required): properties of the resource +* **properties**: [AWS.Wisdom/AssistantProperties](#awswisdomassistantproperties) (Required, Identifier): properties of the resource ## Resource AWS.Wisdom/AssistantAssociation@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Wisdom/AssistantAssociationProperties](#awswisdomassistantassociationproperties) (Required): properties of the resource +* **properties**: [AWS.Wisdom/AssistantAssociationProperties](#awswisdomassistantassociationproperties) (Required, Identifier): properties of the resource ## Resource AWS.Wisdom/KnowledgeBase@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.Wisdom/KnowledgeBaseProperties](#awswisdomknowledgebaseproperties) (Required): properties of the resource +* **properties**: [AWS.Wisdom/KnowledgeBaseProperties](#awswisdomknowledgebaseproperties) (Required, Identifier): properties of the resource -## AWS.Wisdom/AssistantProperties -### Properties -* **AssistantArn**: string (ReadOnly) -* **AssistantId**: string (ReadOnly, Identifier) -* **Description**: string -* **Name**: string (Required) -* **ServerSideEncryptionConfiguration**: [ServerSideEncryptionConfiguration](#serversideencryptionconfiguration) -* **Tags**: [Tag](#tag)[] -* **Type**: string (Required) - -## ServerSideEncryptionConfiguration +## AppIntegrationsConfiguration ### Properties -* **KmsKeyId**: string +* **AppIntegrationArn**: string (Required) +* **ObjectFields**: string[] -## Tag +## AssociationData ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **KnowledgeBaseId**: string (Required) ## AWS.Wisdom/AssistantAssociationProperties ### Properties @@ -50,14 +40,15 @@ * **AssociationType**: string (Required) * **Tags**: [Tag](#tag)[] -## AssociationData -### Properties -* **KnowledgeBaseId**: string (Required) - -## Tag +## AWS.Wisdom/AssistantProperties ### Properties -* **Key**: string (Required) -* **Value**: string (Required) +* **AssistantArn**: string (ReadOnly) +* **AssistantId**: string (ReadOnly, Identifier) +* **Description**: string +* **Name**: string (Required) +* **ServerSideEncryptionConfiguration**: [ServerSideEncryptionConfiguration](#serversideencryptionconfiguration) +* **Tags**: [Tag](#tag)[] +* **Type**: string (Required) ## AWS.Wisdom/KnowledgeBaseProperties ### Properties @@ -79,14 +70,23 @@ ### Properties * **KmsKeyId**: string +## ServerSideEncryptionConfiguration +### Properties +* **KmsKeyId**: string + ## SourceConfiguration ### Properties * **AppIntegrations**: [AppIntegrationsConfiguration](#appintegrationsconfiguration) (Required) -## AppIntegrationsConfiguration +## Tag ### Properties -* **AppIntegrationArn**: string (Required) -* **ObjectFields**: string[] +* **Key**: string (Required) +* **Value**: string (Required) + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) ## Tag ### Properties diff --git a/artifacts/bicep/aws/aws.workspaces/default/types.json b/artifacts/bicep/aws/aws.workspaces/default/types.json new file mode 100644 index 00000000..79b3cbff --- /dev/null +++ b/artifacts/bicep/aws/aws.workspaces/default/types.json @@ -0,0 +1,203 @@ +[ + { + "$type": "ObjectType", + "name": "ApplicationSettings", + "properties": { + "SettingsGroup": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "Status": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "ApplicationSettingsStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Capacity", + "properties": { + "DesiredUserSessions": { + "type": { + "$ref": "#/6" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "TimeoutSettings", + "properties": { + "DisconnectTimeoutInSeconds": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "IdleDisconnectTimeoutInSeconds": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + }, + "MaxUserDurationInSeconds": { + "type": { + "$ref": "#/6" + }, + "flags": 0 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "IntegerType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.WorkSpaces/WorkspacesPoolProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/3" + } + }, + { + "$type": "ObjectType", + "name": "AWS.WorkSpaces/WorkspacesPoolProperties", + "properties": { + "ApplicationSettings": { + "type": { + "$ref": "#/0" + }, + "flags": 0 + }, + "BundleId": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Capacity": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "CreatedAt": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "Description": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + }, + "DirectoryId": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "PoolArn": { + "type": { + "$ref": "#/5" + }, + "flags": 2 + }, + "PoolId": { + "type": { + "$ref": "#/5" + }, + "flags": 18 + }, + "PoolName": { + "type": { + "$ref": "#/5" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/8" + }, + "flags": 4 + }, + "TimeoutSettings": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.WorkSpaces/WorkspacesPool", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/9" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.WorkSpaces/WorkspacesPool@default", + "scopeType": 0, + "body": { + "$ref": "#/10" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.workspaces/default/types.md b/artifacts/bicep/aws/aws.workspaces/default/types.md new file mode 100644 index 00000000..3838fbaf --- /dev/null +++ b/artifacts/bicep/aws/aws.workspaces/default/types.md @@ -0,0 +1,43 @@ +# AWS.WorkSpaces @ default + +## Resource AWS.WorkSpaces/WorkspacesPool@default +* **Valid Scope(s)**: Unknown +### Properties +* **alias**: string (Required, Identifier): the resource alias +* **name**: string: the resource name +* **properties**: [AWS.WorkSpaces/WorkspacesPoolProperties](#awsworkspacesworkspacespoolproperties) (Required, Identifier): properties of the resource + +## ApplicationSettings +### Properties +* **SettingsGroup**: string +* **Status**: string (Required) + +## AWS.WorkSpaces/WorkspacesPoolProperties +### Properties +* **ApplicationSettings**: [ApplicationSettings](#applicationsettings) +* **BundleId**: string (Required) +* **Capacity**: [Capacity](#capacity) (Required) +* **CreatedAt**: string (ReadOnly) +* **Description**: string +* **DirectoryId**: string (Required) +* **PoolArn**: string (ReadOnly) +* **PoolId**: string (ReadOnly, Identifier) +* **PoolName**: string (Required) +* **Tags**: [Tag](#tag)[] (WriteOnly) +* **TimeoutSettings**: [TimeoutSettings](#timeoutsettings) + +## Capacity +### Properties +* **DesiredUserSessions**: int (Required) + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + +## TimeoutSettings +### Properties +* **DisconnectTimeoutInSeconds**: int +* **IdleDisconnectTimeoutInSeconds**: int +* **MaxUserDurationInSeconds**: int + diff --git a/artifacts/bicep/aws/aws.workspacesthinclient/default/types.json b/artifacts/bicep/aws/aws.workspacesthinclient/default/types.json index 34d70968..271ec929 100644 --- a/artifacts/bicep/aws/aws.workspacesthinclient/default/types.json +++ b/artifacts/bicep/aws/aws.workspacesthinclient/default/types.json @@ -1 +1,289 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"DayOfWeek"}},{"2":{"Name":"Hour"}},{"2":{"Name":"MaintenanceWindow","Properties":{"ApplyTimeOf":{"Type":4,"Flags":0,"Description":"The desired time zone maintenance window."},"DaysOfTheWeek":{"Type":13,"Flags":0,"Description":"The date of maintenance window."},"EndTimeHour":{"Type":3,"Flags":0,"Description":"The hour end time of maintenance window."},"EndTimeMinute":{"Type":3,"Flags":0,"Description":"The minute end time of maintenance window."},"StartTimeHour":{"Type":3,"Flags":0,"Description":"The hour start time of maintenance window."},"StartTimeMinute":{"Type":3,"Flags":0,"Description":"The minute start time of maintenance window."},"Type":{"Type":4,"Flags":1,"Description":"The type of maintenance window."}}}},{"2":{"Name":"Minute"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}}}},{"3":{"ItemType":4}},{"2":{"Name":"AWS.WorkSpacesThinClient/EnvironmentProperties","Properties":{"ActivationCode":{"Type":4,"Flags":2,"Description":"Activation code for devices associated with environment."},"Arn":{"Type":4,"Flags":2,"Description":"The environment ARN."},"CreatedAt":{"Type":4,"Flags":2,"Description":"The timestamp in unix epoch format when environment was created."},"DesiredSoftwareSetId":{"Type":4,"Flags":0,"Description":"The ID of the software set to apply."},"DesktopArn":{"Type":4,"Flags":1,"Description":"The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0."},"DesktopEndpoint":{"Type":4,"Flags":0,"Description":"The URL for the identity provider login (only for environments that use AppStream 2.0)."},"DesktopType":{"Type":4,"Flags":2,"Description":"The type of VDI."},"Id":{"Type":4,"Flags":18,"Description":"Unique identifier of the environment."},"KmsKeyArn":{"Type":4,"Flags":0,"Description":"The Amazon Resource Name (ARN) of the AWS Key Management Service key used to encrypt the environment."},"MaintenanceWindow":{"Type":10,"Flags":0,"Description":"A specification for a time window to apply software updates."},"Name":{"Type":4,"Flags":0,"Description":"The name of the environment."},"PendingSoftwareSetId":{"Type":4,"Flags":2,"Description":"The ID of the software set that is pending to be installed."},"PendingSoftwareSetVersion":{"Type":4,"Flags":2,"Description":"The version of the software set that is pending to be installed."},"RegisteredDevicesCount":{"Type":3,"Flags":2,"Description":"Number of devices registered to the environment."},"SoftwareSetComplianceStatus":{"Type":4,"Flags":2,"Description":"Describes if the software currently installed on all devices in the environment is a supported version."},"SoftwareSetUpdateMode":{"Type":4,"Flags":0,"Description":"An option to define which software updates to apply."},"SoftwareSetUpdateSchedule":{"Type":4,"Flags":0,"Description":"An option to define if software updates should be applied within a maintenance window."},"Tags":{"Type":15,"Flags":0,"Description":"An array of key-value pairs to apply to this resource."},"UpdatedAt":{"Type":4,"Flags":2,"Description":"The timestamp in unix epoch format when environment was last updated."}}}},{"3":{"ItemType":12}},{"2":{"Name":"AWS.WorkSpacesThinClient/Environment","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":14,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.WorkSpacesThinClient/Environment@default","ScopeType":0,"Body":16}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "DayOfWeek", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Hour", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "MaintenanceWindow", + "properties": { + "ApplyTimeOf": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The desired time zone maintenance window." + }, + "DaysOfTheWeek": { + "type": { + "$ref": "#/7" + }, + "flags": 0, + "description": "The date of maintenance window." + }, + "EndTimeHour": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "The hour end time of maintenance window." + }, + "EndTimeMinute": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "The minute end time of maintenance window." + }, + "StartTimeHour": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "The hour start time of maintenance window." + }, + "StartTimeMinute": { + "type": { + "$ref": "#/6" + }, + "flags": 0, + "description": "The minute start time of maintenance window." + }, + "Type": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The type of maintenance window." + } + } + }, + { + "$type": "ObjectType", + "name": "Minute", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "Value": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/5" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.WorkSpacesThinClient/EnvironmentProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/4" + } + }, + { + "$type": "ObjectType", + "name": "AWS.WorkSpacesThinClient/EnvironmentProperties", + "properties": { + "ActivationCode": { + "type": { + "$ref": "#/5" + }, + "flags": 2, + "description": "Activation code for devices associated with environment." + }, + "Arn": { + "type": { + "$ref": "#/5" + }, + "flags": 2, + "description": "The environment ARN." + }, + "CreatedAt": { + "type": { + "$ref": "#/5" + }, + "flags": 2, + "description": "The timestamp in unix epoch format when environment was created." + }, + "DesiredSoftwareSetId": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The ID of the software set to apply." + }, + "DesktopArn": { + "type": { + "$ref": "#/5" + }, + "flags": 1, + "description": "The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0." + }, + "DesktopEndpoint": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The URL for the identity provider login (only for environments that use AppStream 2.0)." + }, + "DesktopType": { + "type": { + "$ref": "#/5" + }, + "flags": 2, + "description": "The type of VDI." + }, + "Id": { + "type": { + "$ref": "#/5" + }, + "flags": 18, + "description": "Unique identifier of the environment." + }, + "KmsKeyArn": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The Amazon Resource Name (ARN) of the AWS Key Management Service key used to encrypt the environment." + }, + "MaintenanceWindow": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "A specification for a time window to apply software updates." + }, + "Name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "The name of the environment." + }, + "PendingSoftwareSetId": { + "type": { + "$ref": "#/5" + }, + "flags": 2, + "description": "The ID of the software set that is pending to be installed." + }, + "PendingSoftwareSetVersion": { + "type": { + "$ref": "#/5" + }, + "flags": 2, + "description": "The version of the software set that is pending to be installed." + }, + "RegisteredDevicesCount": { + "type": { + "$ref": "#/6" + }, + "flags": 2, + "description": "Number of devices registered to the environment." + }, + "SoftwareSetComplianceStatus": { + "type": { + "$ref": "#/5" + }, + "flags": 2, + "description": "Describes if the software currently installed on all devices in the environment is a supported version." + }, + "SoftwareSetUpdateMode": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "An option to define which software updates to apply." + }, + "SoftwareSetUpdateSchedule": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "An option to define if software updates should be applied within a maintenance window." + }, + "Tags": { + "type": { + "$ref": "#/9" + }, + "flags": 0, + "description": "An array of key-value pairs to apply to this resource." + }, + "UpdatedAt": { + "type": { + "$ref": "#/5" + }, + "flags": 2, + "description": "The timestamp in unix epoch format when environment was last updated." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.WorkSpacesThinClient/Environment", + "properties": { + "name": { + "type": { + "$ref": "#/5" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/5" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/10" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.WorkSpacesThinClient/Environment@default", + "scopeType": 0, + "body": { + "$ref": "#/11" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.workspacesthinclient/default/types.md b/artifacts/bicep/aws/aws.workspacesthinclient/default/types.md index 1c6e9fb1..36bd0f7b 100644 --- a/artifacts/bicep/aws/aws.workspacesthinclient/default/types.md +++ b/artifacts/bicep/aws/aws.workspacesthinclient/default/types.md @@ -3,9 +3,9 @@ ## Resource AWS.WorkSpacesThinClient/Environment@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.WorkSpacesThinClient/EnvironmentProperties](#awsworkspacesthinclientenvironmentproperties) (Required): properties of the resource +* **properties**: [AWS.WorkSpacesThinClient/EnvironmentProperties](#awsworkspacesthinclientenvironmentproperties) (Required, Identifier): properties of the resource ## AWS.WorkSpacesThinClient/EnvironmentProperties ### Properties diff --git a/artifacts/bicep/aws/aws.workspacesweb/default/types.json b/artifacts/bicep/aws/aws.workspacesweb/default/types.json index 1a4347f4..f763a6f5 100644 --- a/artifacts/bicep/aws/aws.workspacesweb/default/types.json +++ b/artifacts/bicep/aws/aws.workspacesweb/default/types.json @@ -1 +1,1146 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"EncryptionContextMap","Properties":{}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.WorkSpacesWeb/BrowserSettingsProperties","Properties":{"AdditionalEncryptionContext":{"Type":8,"Flags":4},"AssociatedPortalArns":{"Type":11,"Flags":2},"BrowserPolicy":{"Type":4,"Flags":0},"BrowserSettingsArn":{"Type":4,"Flags":18},"CustomerManagedKey":{"Type":4,"Flags":4},"Tags":{"Type":12,"Flags":0}}}},{"3":{"ItemType":4}},{"3":{"ItemType":9}},{"2":{"Name":"AWS.WorkSpacesWeb/BrowserSettings","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":10,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.WorkSpacesWeb/BrowserSettings@default","ScopeType":0,"Body":13}},{"2":{"Name":"IdentityProviderDetails","Properties":{}}},{"2":{"Name":"IdentityProviderType"}},{"2":{"Name":"AWS.WorkSpacesWeb/IdentityProviderProperties","Properties":{"IdentityProviderArn":{"Type":4,"Flags":18},"IdentityProviderDetails":{"Type":15,"Flags":1},"IdentityProviderName":{"Type":4,"Flags":1},"IdentityProviderType":{"Type":4,"Flags":1},"PortalArn":{"Type":4,"Flags":4}}}},{"2":{"Name":"AWS.WorkSpacesWeb/IdentityProvider","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":17,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.WorkSpacesWeb/IdentityProvider@default","ScopeType":0,"Body":18}},{"2":{"Name":"EncryptionContextMap","Properties":{}}},{"2":{"Name":"IpRule","Properties":{"Description":{"Type":4,"Flags":0},"IpRange":{"Type":4,"Flags":1,"Description":"A single IP address or an IP address range in CIDR notation"}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.WorkSpacesWeb/IpAccessSettingsProperties","Properties":{"AdditionalEncryptionContext":{"Type":20,"Flags":4},"AssociatedPortalArns":{"Type":24,"Flags":2},"CreationDate":{"Type":4,"Flags":2},"CustomerManagedKey":{"Type":4,"Flags":4},"Description":{"Type":4,"Flags":0},"DisplayName":{"Type":4,"Flags":0},"IpAccessSettingsArn":{"Type":4,"Flags":18},"IpRules":{"Type":25,"Flags":1},"Tags":{"Type":26,"Flags":0}}}},{"3":{"ItemType":4}},{"3":{"ItemType":21}},{"3":{"ItemType":22}},{"2":{"Name":"AWS.WorkSpacesWeb/IpAccessSettings","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":23,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.WorkSpacesWeb/IpAccessSettings@default","ScopeType":0,"Body":27}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.WorkSpacesWeb/NetworkSettingsProperties","Properties":{"AssociatedPortalArns":{"Type":31,"Flags":2},"NetworkSettingsArn":{"Type":4,"Flags":18},"SecurityGroupIds":{"Type":32,"Flags":1},"SubnetIds":{"Type":33,"Flags":1},"Tags":{"Type":34,"Flags":0},"VpcId":{"Type":4,"Flags":1}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":29}},{"2":{"Name":"AWS.WorkSpacesWeb/NetworkSettings","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":30,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.WorkSpacesWeb/NetworkSettings@default","ScopeType":0,"Body":35}},{"2":{"Name":"AuthenticationType"}},{"2":{"Name":"BrowserType"}},{"2":{"Name":"EncryptionContextMap","Properties":{}}},{"2":{"Name":"PortalStatus"}},{"2":{"Name":"RendererType"}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.WorkSpacesWeb/PortalProperties","Properties":{"AdditionalEncryptionContext":{"Type":39,"Flags":4},"AuthenticationType":{"Type":4,"Flags":0},"BrowserSettingsArn":{"Type":4,"Flags":0},"BrowserType":{"Type":4,"Flags":2},"CreationDate":{"Type":4,"Flags":2},"CustomerManagedKey":{"Type":4,"Flags":4},"DisplayName":{"Type":4,"Flags":0},"IpAccessSettingsArn":{"Type":4,"Flags":0},"NetworkSettingsArn":{"Type":4,"Flags":0},"PortalArn":{"Type":4,"Flags":18},"PortalEndpoint":{"Type":4,"Flags":2},"PortalStatus":{"Type":4,"Flags":2},"RendererType":{"Type":4,"Flags":2},"ServiceProviderSamlMetadata":{"Type":4,"Flags":2},"StatusReason":{"Type":4,"Flags":2},"Tags":{"Type":44,"Flags":0},"TrustStoreArn":{"Type":4,"Flags":0},"UserAccessLoggingSettingsArn":{"Type":4,"Flags":0},"UserSettingsArn":{"Type":4,"Flags":0}}}},{"3":{"ItemType":42}},{"2":{"Name":"AWS.WorkSpacesWeb/Portal","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":43,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.WorkSpacesWeb/Portal@default","ScopeType":0,"Body":45}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.WorkSpacesWeb/TrustStoreProperties","Properties":{"AssociatedPortalArns":{"Type":49,"Flags":2},"CertificateList":{"Type":50,"Flags":1},"Tags":{"Type":51,"Flags":0},"TrustStoreArn":{"Type":4,"Flags":18}}}},{"3":{"ItemType":4}},{"3":{"ItemType":4}},{"3":{"ItemType":47}},{"2":{"Name":"AWS.WorkSpacesWeb/TrustStore","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":48,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.WorkSpacesWeb/TrustStore@default","ScopeType":0,"Body":52}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"2":{"Name":"AWS.WorkSpacesWeb/UserAccessLoggingSettingsProperties","Properties":{"AssociatedPortalArns":{"Type":56,"Flags":2},"KinesisStreamArn":{"Type":4,"Flags":1,"Description":"Kinesis stream ARN to which log events are published."},"Tags":{"Type":57,"Flags":0},"UserAccessLoggingSettingsArn":{"Type":4,"Flags":18}}}},{"3":{"ItemType":4}},{"3":{"ItemType":54}},{"2":{"Name":"AWS.WorkSpacesWeb/UserAccessLoggingSettings","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":55,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.WorkSpacesWeb/UserAccessLoggingSettings@default","ScopeType":0,"Body":58}},{"2":{"Name":"CookieSpecification","Properties":{"Domain":{"Type":4,"Flags":1},"Name":{"Type":4,"Flags":0},"Path":{"Type":4,"Flags":0}}}},{"2":{"Name":"CookieSynchronizationConfiguration","Properties":{"Allowlist":{"Type":65,"Flags":1},"Blocklist":{"Type":66,"Flags":0}}}},{"2":{"Name":"EnabledType"}},{"2":{"Name":"EncryptionContextMap","Properties":{}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1},"Value":{"Type":4,"Flags":1}}}},{"3":{"ItemType":60}},{"3":{"ItemType":60}},{"2":{"Name":"AWS.WorkSpacesWeb/UserSettingsProperties","Properties":{"AdditionalEncryptionContext":{"Type":63,"Flags":4},"AssociatedPortalArns":{"Type":68,"Flags":2},"CookieSynchronizationConfiguration":{"Type":61,"Flags":0},"CopyAllowed":{"Type":4,"Flags":1},"CustomerManagedKey":{"Type":4,"Flags":4},"DisconnectTimeoutInMinutes":{"Type":3,"Flags":0},"DownloadAllowed":{"Type":4,"Flags":1},"IdleDisconnectTimeoutInMinutes":{"Type":3,"Flags":0},"PasteAllowed":{"Type":4,"Flags":1},"PrintAllowed":{"Type":4,"Flags":1},"Tags":{"Type":69,"Flags":0},"UploadAllowed":{"Type":4,"Flags":1},"UserSettingsArn":{"Type":4,"Flags":18}}}},{"3":{"ItemType":4}},{"3":{"ItemType":64}},{"2":{"Name":"AWS.WorkSpacesWeb/UserSettings","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":67,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.WorkSpacesWeb/UserSettings@default","ScopeType":0,"Body":70}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "EncryptionContextMap", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "StringType" + }, + { + "$type": "StringLiteralType", + "value": "AWS.WorkSpacesWeb/BrowserSettingsProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "AWS.WorkSpacesWeb/BrowserSettingsProperties", + "properties": { + "AdditionalEncryptionContext": { + "type": { + "$ref": "#/0" + }, + "flags": 0 + }, + "AssociatedPortalArns": { + "type": { + "$ref": "#/4" + }, + "flags": 2 + }, + "BrowserPolicy": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "BrowserSettingsArn": { + "type": { + "$ref": "#/2" + }, + "flags": 18 + }, + "CustomerManagedKey": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/5" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.WorkSpacesWeb/BrowserSettings", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/6" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.WorkSpacesWeb/BrowserSettings@default", + "scopeType": 0, + "body": { + "$ref": "#/7" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "IdentityProviderDetails", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "IdentityProviderType", + "properties": {} + }, + { + "$type": "StringLiteralType", + "value": "AWS.WorkSpacesWeb/IdentityProviderProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.WorkSpacesWeb/IdentityProviderProperties", + "properties": { + "IdentityProviderArn": { + "type": { + "$ref": "#/2" + }, + "flags": 18 + }, + "IdentityProviderDetails": { + "type": { + "$ref": "#/9" + }, + "flags": 1 + }, + "IdentityProviderName": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "IdentityProviderType": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "PortalArn": { + "type": { + "$ref": "#/2" + }, + "flags": 4 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.WorkSpacesWeb/IdentityProvider", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/12" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.WorkSpacesWeb/IdentityProvider@default", + "scopeType": 0, + "body": { + "$ref": "#/13" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "EncryptionContextMap", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "IpRule", + "properties": { + "Description": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "IpRange": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "A single IP address or an IP address range in CIDR notation" + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.WorkSpacesWeb/IpAccessSettingsProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/16" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/17" + } + }, + { + "$type": "ObjectType", + "name": "AWS.WorkSpacesWeb/IpAccessSettingsProperties", + "properties": { + "AdditionalEncryptionContext": { + "type": { + "$ref": "#/15" + }, + "flags": 0 + }, + "AssociatedPortalArns": { + "type": { + "$ref": "#/19" + }, + "flags": 2 + }, + "CreationDate": { + "type": { + "$ref": "#/2" + }, + "flags": 2 + }, + "CustomerManagedKey": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Description": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "DisplayName": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "IpAccessSettingsArn": { + "type": { + "$ref": "#/2" + }, + "flags": 18 + }, + "IpRules": { + "type": { + "$ref": "#/20" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/21" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.WorkSpacesWeb/IpAccessSettings", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/22" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.WorkSpacesWeb/IpAccessSettings@default", + "scopeType": 0, + "body": { + "$ref": "#/23" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.WorkSpacesWeb/NetworkSettingsProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/25" + } + }, + { + "$type": "ObjectType", + "name": "AWS.WorkSpacesWeb/NetworkSettingsProperties", + "properties": { + "AssociatedPortalArns": { + "type": { + "$ref": "#/27" + }, + "flags": 2 + }, + "NetworkSettingsArn": { + "type": { + "$ref": "#/2" + }, + "flags": 18 + }, + "SecurityGroupIds": { + "type": { + "$ref": "#/28" + }, + "flags": 1 + }, + "SubnetIds": { + "type": { + "$ref": "#/29" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/30" + }, + "flags": 0 + }, + "VpcId": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.WorkSpacesWeb/NetworkSettings", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/31" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.WorkSpacesWeb/NetworkSettings@default", + "scopeType": 0, + "body": { + "$ref": "#/32" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "AuthenticationType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "BrowserType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "EncryptionContextMap", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "InstanceType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "PortalStatus", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RendererType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.WorkSpacesWeb/PortalProperties" + }, + { + "$type": "IntegerType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/40" + } + }, + { + "$type": "ObjectType", + "name": "AWS.WorkSpacesWeb/PortalProperties", + "properties": { + "AdditionalEncryptionContext": { + "type": { + "$ref": "#/36" + }, + "flags": 0 + }, + "AuthenticationType": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "BrowserSettingsArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "BrowserType": { + "type": { + "$ref": "#/2" + }, + "flags": 2 + }, + "CreationDate": { + "type": { + "$ref": "#/2" + }, + "flags": 2 + }, + "CustomerManagedKey": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "DisplayName": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "InstanceType": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "IpAccessSettingsArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "MaxConcurrentSessions": { + "type": { + "$ref": "#/42" + }, + "flags": 0 + }, + "NetworkSettingsArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "PortalArn": { + "type": { + "$ref": "#/2" + }, + "flags": 18 + }, + "PortalEndpoint": { + "type": { + "$ref": "#/2" + }, + "flags": 2 + }, + "PortalStatus": { + "type": { + "$ref": "#/2" + }, + "flags": 2 + }, + "RendererType": { + "type": { + "$ref": "#/2" + }, + "flags": 2 + }, + "ServiceProviderSamlMetadata": { + "type": { + "$ref": "#/2" + }, + "flags": 2 + }, + "StatusReason": { + "type": { + "$ref": "#/2" + }, + "flags": 2 + }, + "Tags": { + "type": { + "$ref": "#/43" + }, + "flags": 0 + }, + "TrustStoreArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "UserAccessLoggingSettingsArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "UserSettingsArn": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.WorkSpacesWeb/Portal", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/44" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.WorkSpacesWeb/Portal@default", + "scopeType": 0, + "body": { + "$ref": "#/45" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.WorkSpacesWeb/TrustStoreProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/47" + } + }, + { + "$type": "ObjectType", + "name": "AWS.WorkSpacesWeb/TrustStoreProperties", + "properties": { + "AssociatedPortalArns": { + "type": { + "$ref": "#/49" + }, + "flags": 2 + }, + "CertificateList": { + "type": { + "$ref": "#/50" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/51" + }, + "flags": 0 + }, + "TrustStoreArn": { + "type": { + "$ref": "#/2" + }, + "flags": 18 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.WorkSpacesWeb/TrustStore", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/52" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.WorkSpacesWeb/TrustStore@default", + "scopeType": 0, + "body": { + "$ref": "#/53" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.WorkSpacesWeb/UserAccessLoggingSettingsProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/55" + } + }, + { + "$type": "ObjectType", + "name": "AWS.WorkSpacesWeb/UserAccessLoggingSettingsProperties", + "properties": { + "AssociatedPortalArns": { + "type": { + "$ref": "#/57" + }, + "flags": 2 + }, + "KinesisStreamArn": { + "type": { + "$ref": "#/2" + }, + "flags": 1, + "description": "Kinesis stream ARN to which log events are published." + }, + "Tags": { + "type": { + "$ref": "#/58" + }, + "flags": 0 + }, + "UserAccessLoggingSettingsArn": { + "type": { + "$ref": "#/2" + }, + "flags": 18 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.WorkSpacesWeb/UserAccessLoggingSettings", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/59" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.WorkSpacesWeb/UserAccessLoggingSettings@default", + "scopeType": 0, + "body": { + "$ref": "#/60" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "CookieSpecification", + "properties": { + "Domain": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Name": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "Path": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "CookieSynchronizationConfiguration", + "properties": { + "Allowlist": { + "type": { + "$ref": "#/67" + }, + "flags": 1 + }, + "Blocklist": { + "type": { + "$ref": "#/68" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "EnabledType", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "EncryptionContextMap", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Value": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + } + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/62" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/62" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.WorkSpacesWeb/UserSettingsProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/2" + } + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/66" + } + }, + { + "$type": "ObjectType", + "name": "AWS.WorkSpacesWeb/UserSettingsProperties", + "properties": { + "AdditionalEncryptionContext": { + "type": { + "$ref": "#/65" + }, + "flags": 0 + }, + "AssociatedPortalArns": { + "type": { + "$ref": "#/70" + }, + "flags": 2 + }, + "CookieSynchronizationConfiguration": { + "type": { + "$ref": "#/63" + }, + "flags": 0 + }, + "CopyAllowed": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "CustomerManagedKey": { + "type": { + "$ref": "#/2" + }, + "flags": 0 + }, + "DisconnectTimeoutInMinutes": { + "type": { + "$ref": "#/42" + }, + "flags": 0 + }, + "DownloadAllowed": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "IdleDisconnectTimeoutInMinutes": { + "type": { + "$ref": "#/42" + }, + "flags": 0 + }, + "PasteAllowed": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "PrintAllowed": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "Tags": { + "type": { + "$ref": "#/71" + }, + "flags": 0 + }, + "UploadAllowed": { + "type": { + "$ref": "#/2" + }, + "flags": 1 + }, + "UserSettingsArn": { + "type": { + "$ref": "#/2" + }, + "flags": 18 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.WorkSpacesWeb/UserSettings", + "properties": { + "name": { + "type": { + "$ref": "#/2" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/2" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/72" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.WorkSpacesWeb/UserSettings@default", + "scopeType": 0, + "body": { + "$ref": "#/73" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.workspacesweb/default/types.md b/artifacts/bicep/aws/aws.workspacesweb/default/types.md index 67d6a675..9b51587d 100644 --- a/artifacts/bicep/aws/aws.workspacesweb/default/types.md +++ b/artifacts/bicep/aws/aws.workspacesweb/default/types.md @@ -3,76 +3,68 @@ ## Resource AWS.WorkSpacesWeb/BrowserSettings@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.WorkSpacesWeb/BrowserSettingsProperties](#awsworkspaceswebbrowsersettingsproperties): properties of the resource +* **properties**: [AWS.WorkSpacesWeb/BrowserSettingsProperties](#awsworkspaceswebbrowsersettingsproperties) (Identifier): properties of the resource ## Resource AWS.WorkSpacesWeb/IdentityProvider@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.WorkSpacesWeb/IdentityProviderProperties](#awsworkspaceswebidentityproviderproperties) (Required): properties of the resource +* **properties**: [AWS.WorkSpacesWeb/IdentityProviderProperties](#awsworkspaceswebidentityproviderproperties) (Required, Identifier): properties of the resource ## Resource AWS.WorkSpacesWeb/IpAccessSettings@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.WorkSpacesWeb/IpAccessSettingsProperties](#awsworkspaceswebipaccesssettingsproperties) (Required): properties of the resource +* **properties**: [AWS.WorkSpacesWeb/IpAccessSettingsProperties](#awsworkspaceswebipaccesssettingsproperties) (Required, Identifier): properties of the resource ## Resource AWS.WorkSpacesWeb/NetworkSettings@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.WorkSpacesWeb/NetworkSettingsProperties](#awsworkspaceswebnetworksettingsproperties) (Required): properties of the resource +* **properties**: [AWS.WorkSpacesWeb/NetworkSettingsProperties](#awsworkspaceswebnetworksettingsproperties) (Required, Identifier): properties of the resource ## Resource AWS.WorkSpacesWeb/Portal@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.WorkSpacesWeb/PortalProperties](#awsworkspaceswebportalproperties): properties of the resource +* **properties**: [AWS.WorkSpacesWeb/PortalProperties](#awsworkspaceswebportalproperties) (Identifier): properties of the resource ## Resource AWS.WorkSpacesWeb/TrustStore@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.WorkSpacesWeb/TrustStoreProperties](#awsworkspaceswebtruststoreproperties) (Required): properties of the resource +* **properties**: [AWS.WorkSpacesWeb/TrustStoreProperties](#awsworkspaceswebtruststoreproperties) (Required, Identifier): properties of the resource ## Resource AWS.WorkSpacesWeb/UserAccessLoggingSettings@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.WorkSpacesWeb/UserAccessLoggingSettingsProperties](#awsworkspaceswebuseraccessloggingsettingsproperties) (Required): properties of the resource +* **properties**: [AWS.WorkSpacesWeb/UserAccessLoggingSettingsProperties](#awsworkspaceswebuseraccessloggingsettingsproperties) (Required, Identifier): properties of the resource ## Resource AWS.WorkSpacesWeb/UserSettings@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.WorkSpacesWeb/UserSettingsProperties](#awsworkspaceswebusersettingsproperties) (Required): properties of the resource +* **properties**: [AWS.WorkSpacesWeb/UserSettingsProperties](#awsworkspaceswebusersettingsproperties) (Required, Identifier): properties of the resource ## AWS.WorkSpacesWeb/BrowserSettingsProperties ### Properties -* **AdditionalEncryptionContext**: [EncryptionContextMap](#encryptioncontextmap) (WriteOnly) +* **AdditionalEncryptionContext**: [EncryptionContextMap](#encryptioncontextmap) * **AssociatedPortalArns**: string[] (ReadOnly) * **BrowserPolicy**: string * **BrowserSettingsArn**: string (ReadOnly, Identifier) -* **CustomerManagedKey**: string (WriteOnly) +* **CustomerManagedKey**: string * **Tags**: [Tag](#tag)[] -## EncryptionContextMap -### Properties - -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - ## AWS.WorkSpacesWeb/IdentityProviderProperties ### Properties * **IdentityProviderArn**: string (ReadOnly, Identifier) @@ -81,34 +73,18 @@ * **IdentityProviderType**: string (Required) * **PortalArn**: string (WriteOnly) -## IdentityProviderDetails -### Properties - ## AWS.WorkSpacesWeb/IpAccessSettingsProperties ### Properties -* **AdditionalEncryptionContext**: [EncryptionContextMap](#encryptioncontextmap) (WriteOnly) +* **AdditionalEncryptionContext**: [EncryptionContextMap](#encryptioncontextmap) * **AssociatedPortalArns**: string[] (ReadOnly) * **CreationDate**: string (ReadOnly) -* **CustomerManagedKey**: string (WriteOnly) +* **CustomerManagedKey**: string * **Description**: string * **DisplayName**: string * **IpAccessSettingsArn**: string (ReadOnly, Identifier) * **IpRules**: [IpRule](#iprule)[] (Required) * **Tags**: [Tag](#tag)[] -## EncryptionContextMap -### Properties - -## IpRule -### Properties -* **Description**: string -* **IpRange**: string (Required): A single IP address or an IP address range in CIDR notation - -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - ## AWS.WorkSpacesWeb/NetworkSettingsProperties ### Properties * **AssociatedPortalArns**: string[] (ReadOnly) @@ -118,21 +94,18 @@ * **Tags**: [Tag](#tag)[] * **VpcId**: string (Required) -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - ## AWS.WorkSpacesWeb/PortalProperties ### Properties -* **AdditionalEncryptionContext**: [EncryptionContextMap](#encryptioncontextmap) (WriteOnly) +* **AdditionalEncryptionContext**: [EncryptionContextMap](#encryptioncontextmap) * **AuthenticationType**: string * **BrowserSettingsArn**: string * **BrowserType**: string (ReadOnly) * **CreationDate**: string (ReadOnly) -* **CustomerManagedKey**: string (WriteOnly) +* **CustomerManagedKey**: string * **DisplayName**: string +* **InstanceType**: string * **IpAccessSettingsArn**: string +* **MaxConcurrentSessions**: int * **NetworkSettingsArn**: string * **PortalArn**: string (ReadOnly, Identifier) * **PortalEndpoint**: string (ReadOnly) @@ -145,14 +118,6 @@ * **UserAccessLoggingSettingsArn**: string * **UserSettingsArn**: string -## EncryptionContextMap -### Properties - -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - ## AWS.WorkSpacesWeb/TrustStoreProperties ### Properties * **AssociatedPortalArns**: string[] (ReadOnly) @@ -160,11 +125,6 @@ * **Tags**: [Tag](#tag)[] * **TrustStoreArn**: string (ReadOnly, Identifier) -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - ## AWS.WorkSpacesWeb/UserAccessLoggingSettingsProperties ### Properties * **AssociatedPortalArns**: string[] (ReadOnly) @@ -172,18 +132,13 @@ * **Tags**: [Tag](#tag)[] * **UserAccessLoggingSettingsArn**: string (ReadOnly, Identifier) -## Tag -### Properties -* **Key**: string (Required) -* **Value**: string (Required) - ## AWS.WorkSpacesWeb/UserSettingsProperties ### Properties -* **AdditionalEncryptionContext**: [EncryptionContextMap](#encryptioncontextmap) (WriteOnly) +* **AdditionalEncryptionContext**: [EncryptionContextMap](#encryptioncontextmap) * **AssociatedPortalArns**: string[] (ReadOnly) * **CookieSynchronizationConfiguration**: [CookieSynchronizationConfiguration](#cookiesynchronizationconfiguration) * **CopyAllowed**: string (Required) -* **CustomerManagedKey**: string (WriteOnly) +* **CustomerManagedKey**: string * **DisconnectTimeoutInMinutes**: int * **DownloadAllowed**: string (Required) * **IdleDisconnectTimeoutInMinutes**: int @@ -193,19 +148,66 @@ * **UploadAllowed**: string (Required) * **UserSettingsArn**: string (ReadOnly, Identifier) -## EncryptionContextMap +## CookieSpecification ### Properties +* **Domain**: string (Required) +* **Name**: string +* **Path**: string ## CookieSynchronizationConfiguration ### Properties * **Allowlist**: [CookieSpecification](#cookiespecification)[] (Required) * **Blocklist**: [CookieSpecification](#cookiespecification)[] -## CookieSpecification +## EncryptionContextMap ### Properties -* **Domain**: string (Required) -* **Name**: string -* **Path**: string + +## EncryptionContextMap +### Properties + +## EncryptionContextMap +### Properties + +## EncryptionContextMap +### Properties + +## IdentityProviderDetails +### Properties + +## IpRule +### Properties +* **Description**: string +* **IpRange**: string (Required): A single IP address or an IP address range in CIDR notation + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) + +## Tag +### Properties +* **Key**: string (Required) +* **Value**: string (Required) ## Tag ### Properties diff --git a/artifacts/bicep/aws/aws.xray/default/types.json b/artifacts/bicep/aws/aws.xray/default/types.json index c92cfd79..1e9e2a66 100644 --- a/artifacts/bicep/aws/aws.xray/default/types.json +++ b/artifacts/bicep/aws/aws.xray/default/types.json @@ -1 +1,562 @@ -[{"1":{"Kind":1}},{"1":{"Kind":2}},{"1":{"Kind":3}},{"1":{"Kind":4}},{"1":{"Kind":5}},{"1":{"Kind":6}},{"1":{"Kind":7}},{"1":{"Kind":8}},{"2":{"Name":"InsightsConfiguration","Properties":{"InsightsEnabled":{"Type":2,"Flags":0,"Description":"Set the InsightsEnabled value to true to enable insights or false to disable insights."},"NotificationsEnabled":{"Type":2,"Flags":0,"Description":"Set the NotificationsEnabled value to true to enable insights notifications. Notifications can only be enabled on a group with InsightsEnabled set to true."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag."}}}},{"2":{"Name":"Tags"}},{"3":{"ItemType":9}},{"2":{"Name":"AWS.XRay/GroupProperties","Properties":{"FilterExpression":{"Type":4,"Flags":0,"Description":"The filter expression defining criteria by which to group traces."},"GroupARN":{"Type":4,"Flags":18,"Description":"The ARN of the group that was generated on creation."},"GroupName":{"Type":4,"Flags":1,"Description":"The case-sensitive name of the new group. Names must be unique."},"InsightsConfiguration":{"Type":8,"Flags":0},"Tags":{"Type":13,"Flags":0}}}},{"3":{"ItemType":9}},{"2":{"Name":"AWS.XRay/Group","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":12,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.XRay/Group@default","ScopeType":0,"Body":14}},{"2":{"Name":"AWS.XRay/ResourcePolicyProperties","Properties":{"BypassPolicyLockoutCheck":{"Type":2,"Flags":4,"Description":"A flag to indicate whether to bypass the resource policy lockout safety check"},"PolicyDocument":{"Type":4,"Flags":1,"Description":"The resource policy document, which can be up to 5kb in size."},"PolicyName":{"Type":4,"Flags":17,"Description":"The name of the resource policy. Must be unique within a specific AWS account."}}}},{"2":{"Name":"AWS.XRay/ResourcePolicy","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":16,"Flags":1,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.XRay/ResourcePolicy@default","ScopeType":0,"Body":17}},{"2":{"Name":"RuleARN"}},{"2":{"Name":"RuleName"}},{"2":{"Name":"SamplingRule","Properties":{"Attributes":{"Type":26,"Flags":0,"Description":"Matches attributes derived from the request."},"FixedRate":{"Type":3,"Flags":1,"Description":"The percentage of matching requests to instrument, after the reservoir is exhausted."},"HTTPMethod":{"Type":4,"Flags":1,"Description":"Matches the HTTP method from a request URL."},"Host":{"Type":4,"Flags":1,"Description":"Matches the hostname from a request URL."},"Priority":{"Type":3,"Flags":1,"Description":"The priority of the sampling rule."},"ReservoirSize":{"Type":3,"Flags":1,"Description":"A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively."},"ResourceARN":{"Type":4,"Flags":1,"Description":"Matches the ARN of the AWS resource on which the service runs."},"RuleARN":{"Type":4,"Flags":16},"RuleName":{"Type":4,"Flags":0},"ServiceName":{"Type":4,"Flags":1,"Description":"Matches the name that the service uses to identify itself in segments."},"ServiceType":{"Type":4,"Flags":1,"Description":"Matches the origin that the service uses to identify its type in segments."},"URLPath":{"Type":4,"Flags":1,"Description":"Matches the path from a request URL."},"Version":{"Type":3,"Flags":0,"Description":"The version of the sampling rule format (1)"}}}},{"2":{"Name":"SamplingRuleRecord","Properties":{"CreatedAt":{"Type":4,"Flags":0,"Description":"When the rule was created, in Unix time seconds."},"ModifiedAt":{"Type":4,"Flags":0,"Description":"When the rule was modified, in Unix time seconds."},"SamplingRule":{"Type":21,"Flags":0}}}},{"2":{"Name":"SamplingRuleUpdate","Properties":{"Attributes":{"Type":27,"Flags":0,"Description":"Matches attributes derived from the request."},"FixedRate":{"Type":3,"Flags":0,"Description":"The percentage of matching requests to instrument, after the reservoir is exhausted."},"HTTPMethod":{"Type":4,"Flags":0,"Description":"Matches the HTTP method from a request URL."},"Host":{"Type":4,"Flags":0,"Description":"Matches the hostname from a request URL."},"Priority":{"Type":3,"Flags":0,"Description":"The priority of the sampling rule."},"ReservoirSize":{"Type":3,"Flags":0,"Description":"A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively."},"ResourceARN":{"Type":4,"Flags":0,"Description":"Matches the ARN of the AWS resource on which the service runs."},"RuleARN":{"Type":4,"Flags":16},"RuleName":{"Type":4,"Flags":0},"ServiceName":{"Type":4,"Flags":0,"Description":"Matches the name that the service uses to identify itself in segments."},"ServiceType":{"Type":4,"Flags":0,"Description":"Matches the origin that the service uses to identify its type in segments."},"URLPath":{"Type":4,"Flags":0,"Description":"Matches the path from a request URL."}}}},{"2":{"Name":"Tag","Properties":{"Key":{"Type":4,"Flags":1,"Description":"The key name of the tag."},"Value":{"Type":4,"Flags":1,"Description":"The value for the tag."}}}},{"2":{"Name":"Tags"}},{"2":{"Name":"SamplingRule_Attributes","Properties":{}}},{"2":{"Name":"SamplingRule_Attributes","Properties":{}}},{"3":{"ItemType":24}},{"2":{"Name":"AWS.XRay/SamplingRuleProperties","Properties":{"RuleARN":{"Type":4,"Flags":18},"RuleName":{"Type":4,"Flags":0},"SamplingRule":{"Type":21,"Flags":0},"SamplingRuleRecord":{"Type":22,"Flags":0},"SamplingRuleUpdate":{"Type":23,"Flags":0},"Tags":{"Type":30,"Flags":0}}}},{"3":{"ItemType":24}},{"2":{"Name":"AWS.XRay/SamplingRule","Properties":{"name":{"Type":4,"Flags":0,"Description":"the resource name"},"alias":{"Type":4,"Flags":1,"Description":"the resource alias"},"properties":{"Type":29,"Flags":0,"Description":"properties of the resource"}}}},{"4":{"Name":"AWS.XRay/SamplingRule@default","ScopeType":0,"Body":31}}] \ No newline at end of file +[ + { + "$type": "ObjectType", + "name": "InsightsConfiguration", + "properties": { + "InsightsEnabled": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "Set the InsightsEnabled value to true to enable insights or false to disable insights." + }, + "NotificationsEnabled": { + "type": { + "$ref": "#/3" + }, + "flags": 0, + "description": "Set the NotificationsEnabled value to true to enable insights notifications. Notifications can only be enabled on a group with InsightsEnabled set to true." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The key name of the tag." + }, + "Value": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The value for the tag." + } + } + }, + { + "$type": "ObjectType", + "name": "Tags", + "properties": {} + }, + { + "$type": "BooleanType" + }, + { + "$type": "StringType" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.XRay/GroupProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/1" + } + }, + { + "$type": "ObjectType", + "name": "AWS.XRay/GroupProperties", + "properties": { + "FilterExpression": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "The filter expression defining criteria by which to group traces." + }, + "GroupARN": { + "type": { + "$ref": "#/4" + }, + "flags": 18, + "description": "The ARN of the group that was generated on creation." + }, + "GroupName": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The case-sensitive name of the new group. Names must be unique." + }, + "InsightsConfiguration": { + "type": { + "$ref": "#/0" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/7" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.XRay/Group", + "properties": { + "name": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/8" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.XRay/Group@default", + "scopeType": 0, + "body": { + "$ref": "#/9" + }, + "flags": 0 + }, + { + "$type": "StringLiteralType", + "value": "AWS.XRay/ResourcePolicyProperties" + }, + { + "$type": "ObjectType", + "name": "AWS.XRay/ResourcePolicyProperties", + "properties": { + "BypassPolicyLockoutCheck": { + "type": { + "$ref": "#/3" + }, + "flags": 4, + "description": "A flag to indicate whether to bypass the resource policy lockout safety check" + }, + "PolicyDocument": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The resource policy document, which can be up to 5kb in size." + }, + "PolicyName": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "The name of the resource policy. Must be unique within a specific AWS account." + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.XRay/ResourcePolicy", + "properties": { + "name": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/12" + }, + "flags": 17, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.XRay/ResourcePolicy@default", + "scopeType": 0, + "body": { + "$ref": "#/13" + }, + "flags": 0 + }, + { + "$type": "ObjectType", + "name": "RuleARN", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "RuleName", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SamplingRule", + "properties": { + "Attributes": { + "type": { + "$ref": "#/22" + }, + "flags": 0, + "description": "Matches attributes derived from the request." + }, + "FixedRate": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "The percentage of matching requests to instrument, after the reservoir is exhausted." + }, + "HTTPMethod": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "Matches the HTTP method from a request URL." + }, + "Host": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "Matches the hostname from a request URL." + }, + "Priority": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "The priority of the sampling rule." + }, + "ReservoirSize": { + "type": { + "$ref": "#/23" + }, + "flags": 1, + "description": "A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively." + }, + "ResourceARN": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "Matches the ARN of the AWS resource on which the service runs." + }, + "RuleARN": { + "type": { + "$ref": "#/4" + }, + "flags": 16 + }, + "RuleName": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "ServiceName": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "Matches the name that the service uses to identify itself in segments." + }, + "ServiceType": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "Matches the origin that the service uses to identify its type in segments." + }, + "URLPath": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "Matches the path from a request URL." + }, + "Version": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "The version of the sampling rule format (1)" + } + } + }, + { + "$type": "ObjectType", + "name": "SamplingRuleRecord", + "properties": { + "CreatedAt": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "When the rule was created, in Unix time seconds." + }, + "ModifiedAt": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "When the rule was modified, in Unix time seconds." + }, + "SamplingRule": { + "type": { + "$ref": "#/17" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "SamplingRuleUpdate", + "properties": { + "Attributes": { + "type": { + "$ref": "#/24" + }, + "flags": 0, + "description": "Matches attributes derived from the request." + }, + "FixedRate": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "The percentage of matching requests to instrument, after the reservoir is exhausted." + }, + "HTTPMethod": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Matches the HTTP method from a request URL." + }, + "Host": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Matches the hostname from a request URL." + }, + "Priority": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "The priority of the sampling rule." + }, + "ReservoirSize": { + "type": { + "$ref": "#/23" + }, + "flags": 0, + "description": "A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively." + }, + "ResourceARN": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Matches the ARN of the AWS resource on which the service runs." + }, + "RuleARN": { + "type": { + "$ref": "#/4" + }, + "flags": 16 + }, + "RuleName": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "ServiceName": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Matches the name that the service uses to identify itself in segments." + }, + "ServiceType": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Matches the origin that the service uses to identify its type in segments." + }, + "URLPath": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "Matches the path from a request URL." + } + } + }, + { + "$type": "ObjectType", + "name": "Tag", + "properties": { + "Key": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The key name of the tag." + }, + "Value": { + "type": { + "$ref": "#/4" + }, + "flags": 1, + "description": "The value for the tag." + } + } + }, + { + "$type": "ObjectType", + "name": "Tags", + "properties": {} + }, + { + "$type": "ObjectType", + "name": "SamplingRule_Attributes", + "properties": {} + }, + { + "$type": "IntegerType" + }, + { + "$type": "ObjectType", + "name": "SamplingRule_Attributes", + "properties": {} + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/20" + } + }, + { + "$type": "StringLiteralType", + "value": "AWS.XRay/SamplingRuleProperties" + }, + { + "$type": "ArrayType", + "itemType": { + "$ref": "#/20" + } + }, + { + "$type": "ObjectType", + "name": "AWS.XRay/SamplingRuleProperties", + "properties": { + "RuleARN": { + "type": { + "$ref": "#/4" + }, + "flags": 18 + }, + "RuleName": { + "type": { + "$ref": "#/4" + }, + "flags": 0 + }, + "SamplingRule": { + "type": { + "$ref": "#/17" + }, + "flags": 0 + }, + "SamplingRuleRecord": { + "type": { + "$ref": "#/18" + }, + "flags": 0 + }, + "SamplingRuleUpdate": { + "type": { + "$ref": "#/19" + }, + "flags": 0 + }, + "Tags": { + "type": { + "$ref": "#/27" + }, + "flags": 0 + } + } + }, + { + "$type": "ObjectType", + "name": "AWS.XRay/SamplingRule", + "properties": { + "name": { + "type": { + "$ref": "#/4" + }, + "flags": 0, + "description": "the resource name" + }, + "alias": { + "type": { + "$ref": "#/4" + }, + "flags": 17, + "description": "the resource alias" + }, + "properties": { + "type": { + "$ref": "#/28" + }, + "flags": 16, + "description": "properties of the resource" + } + } + }, + { + "$type": "ResourceType", + "name": "AWS.XRay/SamplingRule@default", + "scopeType": 0, + "body": { + "$ref": "#/29" + }, + "flags": 0 + } +] \ No newline at end of file diff --git a/artifacts/bicep/aws/aws.xray/default/types.md b/artifacts/bicep/aws/aws.xray/default/types.md index 64b07fc7..77782d48 100644 --- a/artifacts/bicep/aws/aws.xray/default/types.md +++ b/artifacts/bicep/aws/aws.xray/default/types.md @@ -3,23 +3,23 @@ ## Resource AWS.XRay/Group@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.XRay/GroupProperties](#awsxraygroupproperties) (Required): properties of the resource +* **properties**: [AWS.XRay/GroupProperties](#awsxraygroupproperties) (Required, Identifier): properties of the resource ## Resource AWS.XRay/ResourcePolicy@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.XRay/ResourcePolicyProperties](#awsxrayresourcepolicyproperties) (Required): properties of the resource +* **properties**: [AWS.XRay/ResourcePolicyProperties](#awsxrayresourcepolicyproperties) (Required, Identifier): properties of the resource ## Resource AWS.XRay/SamplingRule@default * **Valid Scope(s)**: Unknown ### Properties -* **alias**: string (Required): the resource alias +* **alias**: string (Required, Identifier): the resource alias * **name**: string: the resource name -* **properties**: [AWS.XRay/SamplingRuleProperties](#awsxraysamplingruleproperties): properties of the resource +* **properties**: [AWS.XRay/SamplingRuleProperties](#awsxraysamplingruleproperties) (Identifier): properties of the resource ## AWS.XRay/GroupProperties ### Properties @@ -29,16 +29,6 @@ * **InsightsConfiguration**: [InsightsConfiguration](#insightsconfiguration) * **Tags**: [Tag](#tag)[] -## InsightsConfiguration -### Properties -* **InsightsEnabled**: bool: Set the InsightsEnabled value to true to enable insights or false to disable insights. -* **NotificationsEnabled**: bool: Set the NotificationsEnabled value to true to enable insights notifications. Notifications can only be enabled on a group with InsightsEnabled set to true. - -## Tag -### Properties -* **Key**: string (Required): The key name of the tag. -* **Value**: string (Required): The value for the tag. - ## AWS.XRay/ResourcePolicyProperties ### Properties * **BypassPolicyLockoutCheck**: bool (WriteOnly): A flag to indicate whether to bypass the resource policy lockout safety check @@ -54,6 +44,11 @@ * **SamplingRuleUpdate**: [SamplingRuleUpdate](#samplingruleupdate) * **Tags**: [Tag](#tag)[] +## InsightsConfiguration +### Properties +* **InsightsEnabled**: bool: Set the InsightsEnabled value to true to enable insights or false to disable insights. +* **NotificationsEnabled**: bool: Set the NotificationsEnabled value to true to enable insights notifications. Notifications can only be enabled on a group with InsightsEnabled set to true. + ## SamplingRule ### Properties * **Attributes**: [SamplingRule_Attributes](#samplingruleattributes): Matches attributes derived from the request. @@ -73,6 +68,9 @@ ## SamplingRule_Attributes ### Properties +## SamplingRule_Attributes +### Properties + ## SamplingRuleRecord ### Properties * **CreatedAt**: string: When the rule was created, in Unix time seconds. @@ -94,8 +92,10 @@ * **ServiceType**: string: Matches the origin that the service uses to identify its type in segments. * **URLPath**: string: Matches the path from a request URL. -## SamplingRule_Attributes +## Tag ### Properties +* **Key**: string (Required): The key name of the tag. +* **Value**: string (Required): The value for the tag. ## Tag ### Properties diff --git a/artifacts/bicep/index.json b/artifacts/bicep/index.json index a5642c05..17a90602 100644 --- a/artifacts/bicep/index.json +++ b/artifacts/bicep/index.json @@ -1 +1,2635 @@ -{"Resources":{"AWS.AccessAnalyzer/Analyzer@default":{"RelativePath":"aws/aws.accessanalyzer/default/types.json","Index":21},"AWS.ACMPCA/Certificate@default":{"RelativePath":"aws/aws.acmpca/default/types.json","Index":48},"AWS.ACMPCA/CertificateAuthority@default":{"RelativePath":"aws/aws.acmpca/default/types.json","Index":78},"AWS.ACMPCA/CertificateAuthorityActivation@default":{"RelativePath":"aws/aws.acmpca/default/types.json","Index":81},"AWS.Amplify/App@default":{"RelativePath":"aws/aws.amplify/default/types.json","Index":20},"AWS.Amplify/Branch@default":{"RelativePath":"aws/aws.amplify/default/types.json","Index":29},"AWS.Amplify/Domain@default":{"RelativePath":"aws/aws.amplify/default/types.json","Index":35},"AWS.AmplifyUIBuilder/Component@default":{"RelativePath":"aws/aws.amplifyuibuilder/default/types.json","Index":43},"AWS.AmplifyUIBuilder/Form@default":{"RelativePath":"aws/aws.amplifyuibuilder/default/types.json","Index":78},"AWS.AmplifyUIBuilder/Theme@default":{"RelativePath":"aws/aws.amplifyuibuilder/default/types.json","Index":87},"AWS.ApiGateway/Account@default":{"RelativePath":"aws/aws.apigateway/default/types.json","Index":10},"AWS.ApiGateway/ApiKey@default":{"RelativePath":"aws/aws.apigateway/default/types.json","Index":17},"AWS.ApiGateway/Authorizer@default":{"RelativePath":"aws/aws.apigateway/default/types.json","Index":21},"AWS.ApiGateway/BasePathMapping@default":{"RelativePath":"aws/aws.apigateway/default/types.json","Index":24},"AWS.ApiGateway/ClientCertificate@default":{"RelativePath":"aws/aws.apigateway/default/types.json","Index":29},"AWS.ApiGateway/Deployment@default":{"RelativePath":"aws/aws.apigateway/default/types.json","Index":43},"AWS.ApiGateway/DocumentationPart@default":{"RelativePath":"aws/aws.apigateway/default/types.json","Index":47},"AWS.ApiGateway/DocumentationVersion@default":{"RelativePath":"aws/aws.apigateway/default/types.json","Index":50},"AWS.ApiGateway/DomainName@default":{"RelativePath":"aws/aws.apigateway/default/types.json","Index":58},"AWS.ApiGateway/Method@default":{"RelativePath":"aws/aws.apigateway/default/types.json","Index":76},"AWS.ApiGateway/Model@default":{"RelativePath":"aws/aws.apigateway/default/types.json","Index":81},"AWS.ApiGateway/RequestValidator@default":{"RelativePath":"aws/aws.apigateway/default/types.json","Index":84},"AWS.ApiGateway/Resource@default":{"RelativePath":"aws/aws.apigateway/default/types.json","Index":87},"AWS.ApiGateway/RestApi@default":{"RelativePath":"aws/aws.apigateway/default/types.json","Index":103},"AWS.ApiGateway/Stage@default":{"RelativePath":"aws/aws.apigateway/default/types.json","Index":114},"AWS.ApiGateway/UsagePlan@default":{"RelativePath":"aws/aws.apigateway/default/types.json","Index":124},"AWS.ApiGateway/VpcLink@default":{"RelativePath":"aws/aws.apigateway/default/types.json","Index":130},"AWS.ApiGatewayV2/Api@default":{"RelativePath":"aws/aws.apigatewayv2/default/types.json","Index":18},"AWS.ApiGatewayV2/ApiMapping@default":{"RelativePath":"aws/aws.apigatewayv2/default/types.json","Index":21},"AWS.ApiGatewayV2/Authorizer@default":{"RelativePath":"aws/aws.apigatewayv2/default/types.json","Index":27},"AWS.ApiGatewayV2/Deployment@default":{"RelativePath":"aws/aws.apigatewayv2/default/types.json","Index":30},"AWS.ApiGatewayV2/DomainName@default":{"RelativePath":"aws/aws.apigatewayv2/default/types.json","Index":37},"AWS.ApiGatewayV2/IntegrationResponse@default":{"RelativePath":"aws/aws.apigatewayv2/default/types.json","Index":42},"AWS.ApiGatewayV2/Model@default":{"RelativePath":"aws/aws.apigatewayv2/default/types.json","Index":46},"AWS.ApiGatewayV2/Route@default":{"RelativePath":"aws/aws.apigatewayv2/default/types.json","Index":53},"AWS.ApiGatewayV2/RouteResponse@default":{"RelativePath":"aws/aws.apigatewayv2/default/types.json","Index":59},"AWS.ApiGatewayV2/VpcLink@default":{"RelativePath":"aws/aws.apigatewayv2/default/types.json","Index":65},"AWS.AppConfig/Application@default":{"RelativePath":"aws/aws.appconfig/default/types.json","Index":12},"AWS.AppConfig/ConfigurationProfile@default":{"RelativePath":"aws/aws.appconfig/default/types.json","Index":19},"AWS.AppConfig/Extension@default":{"RelativePath":"aws/aws.appconfig/default/types.json","Index":30},"AWS.AppConfig/ExtensionAssociation@default":{"RelativePath":"aws/aws.appconfig/default/types.json","Index":36},"AWS.AppFlow/Connector@default":{"RelativePath":"aws/aws.appflow/default/types.json","Index":12},"AWS.AppFlow/ConnectorProfile@default":{"RelativePath":"aws/aws.appflow/default/types.json","Index":102},"AWS.AppFlow/Flow@default":{"RelativePath":"aws/aws.appflow/default/types.json","Index":217},"AWS.AppIntegrations/DataIntegration@default":{"RelativePath":"aws/aws.appintegrations/default/types.json","Index":17},"AWS.AppIntegrations/EventIntegration@default":{"RelativePath":"aws/aws.appintegrations/default/types.json","Index":24},"AWS.ApplicationAutoScaling/ScalableTarget@default":{"RelativePath":"aws/aws.applicationautoscaling/default/types.json","Index":14},"AWS.ApplicationAutoScaling/ScalingPolicy@default":{"RelativePath":"aws/aws.applicationautoscaling/default/types.json","Index":31},"AWS.ApplicationInsights/Application@default":{"RelativePath":"aws/aws.applicationinsights/default/types.json","Index":42},"AWS.AppRunner/Service@default":{"RelativePath":"aws/aws.apprunner/default/types.json","Index":33},"AWS.AppRunner/VpcIngressConnection@default":{"RelativePath":"aws/aws.apprunner/default/types.json","Index":39},"AWS.AppStream/AppBlockBuilder@default":{"RelativePath":"aws/aws.appstream/default/types.json","Index":20},"AWS.AppStream/Application@default":{"RelativePath":"aws/aws.appstream/default/types.json","Index":32},"AWS.AppStream/DirectoryConfig@default":{"RelativePath":"aws/aws.appstream/default/types.json","Index":38},"AWS.AppStream/Entitlement@default":{"RelativePath":"aws/aws.appstream/default/types.json","Index":43},"AWS.AppSync/DomainName@default":{"RelativePath":"aws/aws.appsync/default/types.json","Index":10},"AWS.AppSync/DomainNameApiAssociation@default":{"RelativePath":"aws/aws.appsync/default/types.json","Index":13},"AWS.AppSync/FunctionConfiguration@default":{"RelativePath":"aws/aws.appsync/default/types.json","Index":19},"AWS.AppSync/Resolver@default":{"RelativePath":"aws/aws.appsync/default/types.json","Index":29},"AWS.AppSync/SourceApiAssociation@default":{"RelativePath":"aws/aws.appsync/default/types.json","Index":33},"AWS.APS/RuleGroupsNamespace@default":{"RelativePath":"aws/aws.aps/default/types.json","Index":12},"AWS.APS/Workspace@default":{"RelativePath":"aws/aws.aps/default/types.json","Index":18},"AWS.ARCZonalShift/ZonalAutoshiftConfiguration@default":{"RelativePath":"aws/aws.arczonalshift/default/types.json","Index":18},"AWS.Athena/CapacityReservation@default":{"RelativePath":"aws/aws.athena/default/types.json","Index":23},"AWS.Athena/DataCatalog@default":{"RelativePath":"aws/aws.athena/default/types.json","Index":31},"AWS.Athena/PreparedStatement@default":{"RelativePath":"aws/aws.athena/default/types.json","Index":34},"AWS.Athena/WorkGroup@default":{"RelativePath":"aws/aws.athena/default/types.json","Index":68},"AWS.AuditManager/Assessment@default":{"RelativePath":"aws/aws.auditmanager/default/types.json","Index":41},"AWS.AutoScaling/AutoScalingGroup@default":{"RelativePath":"aws/aws.autoscaling/default/types.json","Index":52},"AWS.AutoScaling/LifecycleHook@default":{"RelativePath":"aws/aws.autoscaling/default/types.json","Index":55},"AWS.AutoScaling/ScalingPolicy@default":{"RelativePath":"aws/aws.autoscaling/default/types.json","Index":81},"AWS.AutoScaling/ScheduledAction@default":{"RelativePath":"aws/aws.autoscaling/default/types.json","Index":84},"AWS.AutoScaling/WarmPool@default":{"RelativePath":"aws/aws.autoscaling/default/types.json","Index":88},"AWS.B2BI/Capability@default":{"RelativePath":"aws/aws.b2bi/default/types.json","Index":22},"AWS.B2BI/Partnership@default":{"RelativePath":"aws/aws.b2bi/default/types.json","Index":28},"AWS.B2BI/Profile@default":{"RelativePath":"aws/aws.b2bi/default/types.json","Index":34},"AWS.B2BI/Transformer@default":{"RelativePath":"aws/aws.b2bi/default/types.json","Index":45},"AWS.Backup/BackupPlan@default":{"RelativePath":"aws/aws.backup/default/types.json","Index":21},"AWS.Backup/BackupVault@default":{"RelativePath":"aws/aws.backup/default/types.json","Index":31},"AWS.Backup/Framework@default":{"RelativePath":"aws/aws.backup/default/types.json","Index":44},"AWS.Backup/ReportPlan@default":{"RelativePath":"aws/aws.backup/default/types.json","Index":56},"AWS.Backup/RestoreTestingPlan@default":{"RelativePath":"aws/aws.backup/default/types.json","Index":67},"AWS.Backup/RestoreTestingSelection@default":{"RelativePath":"aws/aws.backup/default/types.json","Index":76},"AWS.BackupGateway/Hypervisor@default":{"RelativePath":"aws/aws.backupgateway/default/types.json","Index":14},"AWS.Batch/ComputeEnvironment@default":{"RelativePath":"aws/aws.batch/default/types.json","Index":21},"AWS.Batch/JobDefinition@default":{"RelativePath":"aws/aws.batch/default/types.json","Index":86},"AWS.Batch/JobQueue@default":{"RelativePath":"aws/aws.batch/default/types.json","Index":93},"AWS.Batch/SchedulingPolicy@default":{"RelativePath":"aws/aws.batch/default/types.json","Index":101},"AWS.Budgets/BudgetsAction@default":{"RelativePath":"aws/aws.budgets/default/types.json","Index":22},"AWS.Cassandra/Keyspace@default":{"RelativePath":"aws/aws.cassandra/default/types.json","Index":16},"AWS.Cassandra/Table@default":{"RelativePath":"aws/aws.cassandra/default/types.json","Index":32},"AWS.CE/AnomalyMonitor@default":{"RelativePath":"aws/aws.ce/default/types.json","Index":13},"AWS.CE/AnomalySubscription@default":{"RelativePath":"aws/aws.ce/default/types.json","Index":22},"AWS.CE/CostCategory@default":{"RelativePath":"aws/aws.ce/default/types.json","Index":26},"AWS.CertificateManager/Account@default":{"RelativePath":"aws/aws.certificatemanager/default/types.json","Index":12},"AWS.Chatbot/MicrosoftTeamsChannelConfiguration@default":{"RelativePath":"aws/aws.chatbot/default/types.json","Index":12},"AWS.Chatbot/SlackChannelConfiguration@default":{"RelativePath":"aws/aws.chatbot/default/types.json","Index":17},"AWS.CleanRooms/AnalysisTemplate@default":{"RelativePath":"aws/aws.cleanrooms/default/types.json","Index":20},"AWS.CleanRooms/Collaboration@default":{"RelativePath":"aws/aws.cleanrooms/default/types.json","Index":38},"AWS.CleanRooms/ConfiguredTable@default":{"RelativePath":"aws/aws.cleanrooms/default/types.json","Index":82},"AWS.CleanRooms/ConfiguredTableAssociation@default":{"RelativePath":"aws/aws.cleanrooms/default/types.json","Index":87},"AWS.CleanRooms/Membership@default":{"RelativePath":"aws/aws.cleanrooms/default/types.json","Index":100},"AWS.CloudFormation/HookDefaultVersion@default":{"RelativePath":"aws/aws.cloudformation/default/types.json","Index":10},"AWS.CloudFormation/HookTypeConfig@default":{"RelativePath":"aws/aws.cloudformation/default/types.json","Index":13},"AWS.CloudFormation/ResourceDefaultVersion@default":{"RelativePath":"aws/aws.cloudformation/default/types.json","Index":16},"AWS.CloudFormation/Stack@default":{"RelativePath":"aws/aws.cloudformation/default/types.json","Index":28},"AWS.CloudFormation/StackSet@default":{"RelativePath":"aws/aws.cloudformation/default/types.json","Index":53},"AWS.CloudFormation/TypeActivation@default":{"RelativePath":"aws/aws.cloudformation/default/types.json","Index":57},"AWS.CloudFront/CachePolicy@default":{"RelativePath":"aws/aws.cloudfront/default/types.json","Index":18},"AWS.CloudFront/CloudFrontOriginAccessIdentity@default":{"RelativePath":"aws/aws.cloudfront/default/types.json","Index":22},"AWS.CloudFront/ContinuousDeploymentPolicy@default":{"RelativePath":"aws/aws.cloudfront/default/types.json","Index":33},"AWS.CloudFront/Distribution@default":{"RelativePath":"aws/aws.cloudfront/default/types.json","Index":90},"AWS.CloudFront/Function@default":{"RelativePath":"aws/aws.cloudfront/default/types.json","Index":97},"AWS.CloudFront/KeyGroup@default":{"RelativePath":"aws/aws.cloudfront/default/types.json","Index":102},"AWS.CloudFront/KeyValueStore@default":{"RelativePath":"aws/aws.cloudfront/default/types.json","Index":106},"AWS.CloudFront/OriginAccessControl@default":{"RelativePath":"aws/aws.cloudfront/default/types.json","Index":110},"AWS.CloudFront/OriginRequestPolicy@default":{"RelativePath":"aws/aws.cloudfront/default/types.json","Index":120},"AWS.CloudFront/PublicKey@default":{"RelativePath":"aws/aws.cloudfront/default/types.json","Index":124},"AWS.CloudFront/RealtimeLogConfig@default":{"RelativePath":"aws/aws.cloudfront/default/types.json","Index":131},"AWS.CloudFront/ResponseHeadersPolicy@default":{"RelativePath":"aws/aws.cloudfront/default/types.json","Index":158},"AWS.CloudTrail/Channel@default":{"RelativePath":"aws/aws.cloudtrail/default/types.json","Index":18},"AWS.CloudTrail/EventDataStore@default":{"RelativePath":"aws/aws.cloudtrail/default/types.json","Index":36},"AWS.CloudTrail/ResourcePolicy@default":{"RelativePath":"aws/aws.cloudtrail/default/types.json","Index":41},"AWS.CloudTrail/Trail@default":{"RelativePath":"aws/aws.cloudtrail/default/types.json","Index":64},"AWS.CloudWatch/Alarm@default":{"RelativePath":"aws/aws.cloudwatch/default/types.json","Index":20},"AWS.CloudWatch/CompositeAlarm@default":{"RelativePath":"aws/aws.cloudwatch/default/types.json","Index":26},"AWS.CloudWatch/MetricStream@default":{"RelativePath":"aws/aws.cloudwatch/default/types.json","Index":40},"AWS.CodeArtifact/Domain@default":{"RelativePath":"aws/aws.codeartifact/default/types.json","Index":13},"AWS.CodeArtifact/Repository@default":{"RelativePath":"aws/aws.codeartifact/default/types.json","Index":21},"AWS.CodeDeploy/Application@default":{"RelativePath":"aws/aws.codedeploy/default/types.json","Index":12},"AWS.CodeGuruProfiler/ProfilingGroup@default":{"RelativePath":"aws/aws.codeguruprofiler/default/types.json","Index":20},"AWS.CodePipeline/CustomActionType@default":{"RelativePath":"aws/aws.codepipeline/default/types.json","Index":16},"AWS.CodeStarConnections/Connection@default":{"RelativePath":"aws/aws.codestarconnections/default/types.json","Index":12},"AWS.CodeStarConnections/RepositoryLink@default":{"RelativePath":"aws/aws.codestarconnections/default/types.json","Index":17},"AWS.CodeStarConnections/SyncConfiguration@default":{"RelativePath":"aws/aws.codestarconnections/default/types.json","Index":20},"AWS.CodeStarNotifications/NotificationRule@default":{"RelativePath":"aws/aws.codestarnotifications/default/types.json","Index":14},"AWS.Cognito/IdentityPoolPrincipalTag@default":{"RelativePath":"aws/aws.cognito/default/types.json","Index":11},"AWS.Cognito/LogDeliveryConfiguration@default":{"RelativePath":"aws/aws.cognito/default/types.json","Index":19},"AWS.Cognito/UserPool@default":{"RelativePath":"aws/aws.cognito/default/types.json","Index":50},"AWS.Cognito/UserPoolClient@default":{"RelativePath":"aws/aws.cognito/default/types.json","Index":63},"AWS.Cognito/UserPoolGroup@default":{"RelativePath":"aws/aws.cognito/default/types.json","Index":66},"AWS.Comprehend/DocumentClassifier@default":{"RelativePath":"aws/aws.comprehend/default/types.json","Index":25},"AWS.Comprehend/Flywheel@default":{"RelativePath":"aws/aws.comprehend/default/types.json","Index":41},"AWS.Config/AggregationAuthorization@default":{"RelativePath":"aws/aws.config/default/types.json","Index":12},"AWS.Config/ConfigRule@default":{"RelativePath":"aws/aws.config/default/types.json","Index":26},"AWS.Config/ConfigurationAggregator@default":{"RelativePath":"aws/aws.config/default/types.json","Index":37},"AWS.Config/ConformancePack@default":{"RelativePath":"aws/aws.config/default/types.json","Index":45},"AWS.Config/OrganizationConformancePack@default":{"RelativePath":"aws/aws.config/default/types.json","Index":54},"AWS.Config/StoredQuery@default":{"RelativePath":"aws/aws.config/default/types.json","Index":59},"AWS.Connect/ApprovedOrigin@default":{"RelativePath":"aws/aws.connect/default/types.json","Index":12},"AWS.Connect/ContactFlow@default":{"RelativePath":"aws/aws.connect/default/types.json","Index":17},"AWS.Connect/ContactFlowModule@default":{"RelativePath":"aws/aws.connect/default/types.json","Index":22},"AWS.Connect/EvaluationForm@default":{"RelativePath":"aws/aws.connect/default/types.json","Index":50},"AWS.Connect/HoursOfOperation@default":{"RelativePath":"aws/aws.connect/default/types.json","Index":58},"AWS.Connect/Instance@default":{"RelativePath":"aws/aws.connect/default/types.json","Index":71},"AWS.Connect/InstanceStorageConfig@default":{"RelativePath":"aws/aws.connect/default/types.json","Index":89},"AWS.Connect/IntegrationAssociation@default":{"RelativePath":"aws/aws.connect/default/types.json","Index":96},"AWS.Connect/PhoneNumber@default":{"RelativePath":"aws/aws.connect/default/types.json","Index":101},"AWS.Connect/PredefinedAttribute@default":{"RelativePath":"aws/aws.connect/default/types.json","Index":109},"AWS.Connect/Prompt@default":{"RelativePath":"aws/aws.connect/default/types.json","Index":114},"AWS.Connect/Queue@default":{"RelativePath":"aws/aws.connect/default/types.json","Index":127},"AWS.Connect/QuickConnect@default":{"RelativePath":"aws/aws.connect/default/types.json","Index":141},"AWS.Connect/RoutingProfile@default":{"RelativePath":"aws/aws.connect/default/types.json","Index":158},"AWS.Connect/Rule@default":{"RelativePath":"aws/aws.connect/default/types.json","Index":206},"AWS.Connect/SecurityKey@default":{"RelativePath":"aws/aws.connect/default/types.json","Index":212},"AWS.Connect/SecurityProfile@default":{"RelativePath":"aws/aws.connect/default/types.json","Index":222},"AWS.Connect/TaskTemplate@default":{"RelativePath":"aws/aws.connect/default/types.json","Index":251},"AWS.Connect/TrafficDistributionGroup@default":{"RelativePath":"aws/aws.connect/default/types.json","Index":256},"AWS.Connect/User@default":{"RelativePath":"aws/aws.connect/default/types.json","Index":279},"AWS.Connect/UserHierarchyGroup@default":{"RelativePath":"aws/aws.connect/default/types.json","Index":285},"AWS.Connect/View@default":{"RelativePath":"aws/aws.connect/default/types.json","Index":292},"AWS.Connect/ViewVersion@default":{"RelativePath":"aws/aws.connect/default/types.json","Index":295},"AWS.ConnectCampaigns/Campaign@default":{"RelativePath":"aws/aws.connectcampaigns/default/types.json","Index":18},"AWS.ControlTower/EnabledControl@default":{"RelativePath":"aws/aws.controltower/default/types.json","Index":13},"AWS.ControlTower/LandingZone@default":{"RelativePath":"aws/aws.controltower/default/types.json","Index":21},"AWS.CustomerProfiles/CalculatedAttributeDefinition@default":{"RelativePath":"aws/aws.customerprofiles/default/types.json","Index":34},"AWS.CustomerProfiles/Domain@default":{"RelativePath":"aws/aws.customerprofiles/default/types.json","Index":61},"AWS.CustomerProfiles/EventStream@default":{"RelativePath":"aws/aws.customerprofiles/default/types.json","Index":69},"AWS.CustomerProfiles/Integration@default":{"RelativePath":"aws/aws.customerprofiles/default/types.json","Index":107},"AWS.CustomerProfiles/ObjectType@default":{"RelativePath":"aws/aws.customerprofiles/default/types.json","Index":121},"AWS.DataBrew/Dataset@default":{"RelativePath":"aws/aws.databrew/default/types.json","Index":33},"AWS.DataBrew/Job@default":{"RelativePath":"aws/aws.databrew/default/types.json","Index":74},"AWS.DataBrew/Project@default":{"RelativePath":"aws/aws.databrew/default/types.json","Index":80},"AWS.DataBrew/Recipe@default":{"RelativePath":"aws/aws.databrew/default/types.json","Index":102},"AWS.DataBrew/Ruleset@default":{"RelativePath":"aws/aws.databrew/default/types.json","Index":121},"AWS.DataBrew/Schedule@default":{"RelativePath":"aws/aws.databrew/default/types.json","Index":128},"AWS.DataPipeline/Pipeline@default":{"RelativePath":"aws/aws.datapipeline/default/types.json","Index":22},"AWS.DataSync/Agent@default":{"RelativePath":"aws/aws.datasync/default/types.json","Index":14},"AWS.DataSync/LocationAzureBlob@default":{"RelativePath":"aws/aws.datasync/default/types.json","Index":21},"AWS.DataSync/LocationEFS@default":{"RelativePath":"aws/aws.datasync/default/types.json","Index":28},"AWS.DataSync/LocationFSxLustre@default":{"RelativePath":"aws/aws.datasync/default/types.json","Index":34},"AWS.DataSync/LocationFSxONTAP@default":{"RelativePath":"aws/aws.datasync/default/types.json","Index":45},"AWS.DataSync/LocationFSxOpenZFS@default":{"RelativePath":"aws/aws.datasync/default/types.json","Index":54},"AWS.DataSync/LocationFSxWindows@default":{"RelativePath":"aws/aws.datasync/default/types.json","Index":60},"AWS.DataSync/LocationHDFS@default":{"RelativePath":"aws/aws.datasync/default/types.json","Index":69},"AWS.DataSync/LocationNFS@default":{"RelativePath":"aws/aws.datasync/default/types.json","Index":77},"AWS.DataSync/LocationObjectStorage@default":{"RelativePath":"aws/aws.datasync/default/types.json","Index":83},"AWS.DataSync/LocationS3@default":{"RelativePath":"aws/aws.datasync/default/types.json","Index":89},"AWS.DataSync/LocationSMB@default":{"RelativePath":"aws/aws.datasync/default/types.json","Index":96},"AWS.DataSync/StorageSystem@default":{"RelativePath":"aws/aws.datasync/default/types.json","Index":104},"AWS.DataSync/Task@default":{"RelativePath":"aws/aws.datasync/default/types.json","Index":128},"AWS.Detective/Graph@default":{"RelativePath":"aws/aws.detective/default/types.json","Index":12},"AWS.Detective/MemberInvitation@default":{"RelativePath":"aws/aws.detective/default/types.json","Index":15},"AWS.Detective/OrganizationAdmin@default":{"RelativePath":"aws/aws.detective/default/types.json","Index":18},"AWS.DeviceFarm/DevicePool@default":{"RelativePath":"aws/aws.devicefarm/default/types.json","Index":14},"AWS.DeviceFarm/InstanceProfile@default":{"RelativePath":"aws/aws.devicefarm/default/types.json","Index":20},"AWS.DeviceFarm/NetworkProfile@default":{"RelativePath":"aws/aws.devicefarm/default/types.json","Index":25},"AWS.DeviceFarm/Project@default":{"RelativePath":"aws/aws.devicefarm/default/types.json","Index":33},"AWS.DeviceFarm/TestGridProject@default":{"RelativePath":"aws/aws.devicefarm/default/types.json","Index":41},"AWS.DeviceFarm/VPCEConfiguration@default":{"RelativePath":"aws/aws.devicefarm/default/types.json","Index":46},"AWS.DevOpsGuru/LogAnomalyDetectionIntegration@default":{"RelativePath":"aws/aws.devopsguru/default/types.json","Index":11},"AWS.DevOpsGuru/ResourceCollection@default":{"RelativePath":"aws/aws.devopsguru/default/types.json","Index":22},"AWS.DirectoryService/SimpleAD@default":{"RelativePath":"aws/aws.directoryservice/default/types.json","Index":13},"AWS.DMS/DataProvider@default":{"RelativePath":"aws/aws.dms/default/types.json","Index":14},"AWS.DMS/InstanceProfile@default":{"RelativePath":"aws/aws.dms/default/types.json","Index":20},"AWS.DMS/MigrationProject@default":{"RelativePath":"aws/aws.dms/default/types.json","Index":29},"AWS.DMS/ReplicationConfig@default":{"RelativePath":"aws/aws.dms/default/types.json","Index":39},"AWS.DocDBElastic/Cluster@default":{"RelativePath":"aws/aws.docdbelastic/default/types.json","Index":14},"AWS.DynamoDB/GlobalTable@default":{"RelativePath":"aws/aws.dynamodb/default/types.json","Index":39},"AWS.DynamoDB/Table@default":{"RelativePath":"aws/aws.dynamodb/default/types.json","Index":70},"AWS.EC2/CapacityReservation@default":{"RelativePath":"aws/aws.ec2/default/types.json","Index":14},"AWS.EC2/CapacityReservationFleet@default":{"RelativePath":"aws/aws.ec2/default/types.json","Index":23},"AWS.EC2/CarrierGateway@default":{"RelativePath":"aws/aws.ec2/default/types.json","Index":30},"AWS.EC2/CustomerGateway@default":{"RelativePath":"aws/aws.ec2/default/types.json","Index":35},"AWS.EC2/DHCPOptions@default":{"RelativePath":"aws/aws.ec2/default/types.json","Index":43},"AWS.EC2/EC2Fleet@default":{"RelativePath":"aws/aws.ec2/default/types.json","Index":80},"AWS.EC2/EIP@default":{"RelativePath":"aws/aws.ec2/default/types.json","Index":85},"AWS.EC2/FlowLog@default":{"RelativePath":"aws/aws.ec2/default/types.json","Index":91},"AWS.EC2/GatewayRouteTableAssociation@default":{"RelativePath":"aws/aws.ec2/default/types.json","Index":94},"AWS.EC2/Host@default":{"RelativePath":"aws/aws.ec2/default/types.json","Index":97},"AWS.EC2/IPAM@default":{"RelativePath":"aws/aws.ec2/default/types.json","Index":104},"AWS.EC2/IPAMPool@default":{"RelativePath":"aws/aws.ec2/default/types.json","Index":113},"AWS.EC2/IPAMResourceDiscovery@default":{"RelativePath":"aws/aws.ec2/default/types.json","Index":120},"AWS.EC2/IPAMResourceDiscoveryAssociation@default":{"RelativePath":"aws/aws.ec2/default/types.json","Index":125},"AWS.EC2/IPAMScope@default":{"RelativePath":"aws/aws.ec2/default/types.json","Index":130},"AWS.EC2/Instance@default":{"RelativePath":"aws/aws.ec2/default/types.json","Index":168},"AWS.EC2/InstanceConnectEndpoint@default":{"RelativePath":"aws/aws.ec2/default/types.json","Index":175},"AWS.EC2/InternetGateway@default":{"RelativePath":"aws/aws.ec2/default/types.json","Index":180},"AWS.EC2/LaunchTemplate@default":{"RelativePath":"aws/aws.ec2/default/types.json","Index":248},"AWS.EC2/LocalGatewayRoute@default":{"RelativePath":"aws/aws.ec2/default/types.json","Index":251},"AWS.EC2/LocalGatewayRouteTable@default":{"RelativePath":"aws/aws.ec2/default/types.json","Index":258},"AWS.EC2/LocalGatewayRouteTableVPCAssociation@default":{"RelativePath":"aws/aws.ec2/default/types.json","Index":265},"AWS.EC2/LocalGatewayRouteTableVirtualInterfaceGroupAssociation@default":{"RelativePath":"aws/aws.ec2/default/types.json","Index":272},"AWS.EC2/NatGateway@default":{"RelativePath":"aws/aws.ec2/default/types.json","Index":279},"AWS.EC2/NetworkAcl@default":{"RelativePath":"aws/aws.ec2/default/types.json","Index":284},"AWS.EC2/NetworkInsightsAccessScope@default":{"RelativePath":"aws/aws.ec2/default/types.json","Index":307},"AWS.EC2/NetworkInsightsAccessScopeAnalysis@default":{"RelativePath":"aws/aws.ec2/default/types.json","Index":312},"AWS.EC2/NetworkInsightsAnalysis@default":{"RelativePath":"aws/aws.ec2/default/types.json","Index":357},"AWS.EC2/NetworkInsightsPath@default":{"RelativePath":"aws/aws.ec2/default/types.json","Index":369},"AWS.EC2/NetworkInterface@default":{"RelativePath":"aws/aws.ec2/default/types.json","Index":384},"AWS.EC2/NetworkInterfaceAttachment@default":{"RelativePath":"aws/aws.ec2/default/types.json","Index":387},"AWS.EC2/PrefixList@default":{"RelativePath":"aws/aws.ec2/default/types.json","Index":394},"AWS.EC2/Route@default":{"RelativePath":"aws/aws.ec2/default/types.json","Index":397},"AWS.EC2/RouteTable@default":{"RelativePath":"aws/aws.ec2/default/types.json","Index":402},"AWS.EC2/SecurityGroup@default":{"RelativePath":"aws/aws.ec2/default/types.json","Index":411},"AWS.EC2/SecurityGroupEgress@default":{"RelativePath":"aws/aws.ec2/default/types.json","Index":414},"AWS.EC2/SnapshotBlockPublicAccess@default":{"RelativePath":"aws/aws.ec2/default/types.json","Index":417},"AWS.EC2/SpotFleet@default":{"RelativePath":"aws/aws.ec2/default/types.json","Index":475},"AWS.EC2/Subnet@default":{"RelativePath":"aws/aws.ec2/default/types.json","Index":482},"AWS.EC2/TransitGateway@default":{"RelativePath":"aws/aws.ec2/default/types.json","Index":488},"AWS.EC2/TransitGatewayAttachment@default":{"RelativePath":"aws/aws.ec2/default/types.json","Index":495},"AWS.EC2/TransitGatewayConnect@default":{"RelativePath":"aws/aws.ec2/default/types.json","Index":501},"AWS.EC2/TransitGatewayMulticastDomain@default":{"RelativePath":"aws/aws.ec2/default/types.json","Index":507},"AWS.EC2/TransitGatewayPeeringAttachment@default":{"RelativePath":"aws/aws.ec2/default/types.json","Index":513},"AWS.EC2/TransitGatewayVpcAttachment@default":{"RelativePath":"aws/aws.ec2/default/types.json","Index":522},"AWS.EC2/VPC@default":{"RelativePath":"aws/aws.ec2/default/types.json","Index":529},"AWS.EC2/VPCDHCPOptionsAssociation@default":{"RelativePath":"aws/aws.ec2/default/types.json","Index":532},"AWS.EC2/VPCEndpoint@default":{"RelativePath":"aws/aws.ec2/default/types.json","Index":542},"AWS.EC2/VPCEndpointConnectionNotification@default":{"RelativePath":"aws/aws.ec2/default/types.json","Index":546},"AWS.EC2/VPCEndpointService@default":{"RelativePath":"aws/aws.ec2/default/types.json","Index":551},"AWS.EC2/VPCEndpointServicePermissions@default":{"RelativePath":"aws/aws.ec2/default/types.json","Index":555},"AWS.EC2/VPCGatewayAttachment@default":{"RelativePath":"aws/aws.ec2/default/types.json","Index":558},"AWS.EC2/VPCPeeringConnection@default":{"RelativePath":"aws/aws.ec2/default/types.json","Index":563},"AWS.EC2/VPNConnection@default":{"RelativePath":"aws/aws.ec2/default/types.json","Index":570},"AWS.EC2/VPNGateway@default":{"RelativePath":"aws/aws.ec2/default/types.json","Index":575},"AWS.EC2/VerifiedAccessEndpoint@default":{"RelativePath":"aws/aws.ec2/default/types.json","Index":587},"AWS.EC2/VerifiedAccessGroup@default":{"RelativePath":"aws/aws.ec2/default/types.json","Index":593},"AWS.EC2/VerifiedAccessInstance@default":{"RelativePath":"aws/aws.ec2/default/types.json","Index":606},"AWS.EC2/VerifiedAccessTrustProvider@default":{"RelativePath":"aws/aws.ec2/default/types.json","Index":615},"AWS.EC2/Volume@default":{"RelativePath":"aws/aws.ec2/default/types.json","Index":620},"AWS.ECR/PullThroughCacheRule@default":{"RelativePath":"aws/aws.ecr/default/types.json","Index":16},"AWS.ECR/RegistryPolicy@default":{"RelativePath":"aws/aws.ecr/default/types.json","Index":21},"AWS.ECR/ReplicationConfiguration@default":{"RelativePath":"aws/aws.ecr/default/types.json","Index":35},"AWS.ECR/Repository@default":{"RelativePath":"aws/aws.ecr/default/types.json","Index":51},"AWS.ECS/CapacityProvider@default":{"RelativePath":"aws/aws.ecs/default/types.json","Index":14},"AWS.ECS/Cluster@default":{"RelativePath":"aws/aws.ecs/default/types.json","Index":28},"AWS.ECS/ClusterCapacityProviderAssociations@default":{"RelativePath":"aws/aws.ecs/default/types.json","Index":40},"AWS.ECS/PrimaryTaskSet@default":{"RelativePath":"aws/aws.ecs/default/types.json","Index":43},"AWS.ECS/Service@default":{"RelativePath":"aws/aws.ecs/default/types.json","Index":82},"AWS.ECS/TaskDefinition@default":{"RelativePath":"aws/aws.ecs/default/types.json","Index":153},"AWS.ECS/TaskSet@default":{"RelativePath":"aws/aws.ecs/default/types.json","Index":165},"AWS.EFS/AccessPoint@default":{"RelativePath":"aws/aws.efs/default/types.json","Index":16},"AWS.EFS/FileSystem@default":{"RelativePath":"aws/aws.efs/default/types.json","Index":30},"AWS.EFS/MountTarget@default":{"RelativePath":"aws/aws.efs/default/types.json","Index":34},"AWS.EKS/AccessEntry@default":{"RelativePath":"aws/aws.eks/default/types.json","Index":17},"AWS.EKS/Addon@default":{"RelativePath":"aws/aws.eks/default/types.json","Index":22},"AWS.EKS/Cluster@default":{"RelativePath":"aws/aws.eks/default/types.json","Index":46},"AWS.EKS/FargateProfile@default":{"RelativePath":"aws/aws.eks/default/types.json","Index":56},"AWS.EKS/IdentityProviderConfig@default":{"RelativePath":"aws/aws.eks/default/types.json","Index":64},"AWS.EKS/Nodegroup@default":{"RelativePath":"aws/aws.eks/default/types.json","Index":78},"AWS.EKS/PodIdentityAssociation@default":{"RelativePath":"aws/aws.eks/default/types.json","Index":83},"AWS.ElastiCache/GlobalReplicationGroup@default":{"RelativePath":"aws/aws.elasticache/default/types.json","Index":17},"AWS.ElastiCache/ServerlessCache@default":{"RelativePath":"aws/aws.elasticache/default/types.json","Index":29},"AWS.ElastiCache/SubnetGroup@default":{"RelativePath":"aws/aws.elasticache/default/types.json","Index":35},"AWS.ElastiCache/User@default":{"RelativePath":"aws/aws.elasticache/default/types.json","Index":43},"AWS.ElastiCache/UserGroup@default":{"RelativePath":"aws/aws.elasticache/default/types.json","Index":49},"AWS.ElasticBeanstalk/Application@default":{"RelativePath":"aws/aws.elasticbeanstalk/default/types.json","Index":14},"AWS.ElasticBeanstalk/ApplicationVersion@default":{"RelativePath":"aws/aws.elasticbeanstalk/default/types.json","Index":18},"AWS.ElasticBeanstalk/ConfigurationTemplate@default":{"RelativePath":"aws/aws.elasticbeanstalk/default/types.json","Index":24},"AWS.ElasticBeanstalk/Environment@default":{"RelativePath":"aws/aws.elasticbeanstalk/default/types.json","Index":32},"AWS.ElasticLoadBalancingV2/Listener@default":{"RelativePath":"aws/aws.elasticloadbalancingv2/default/types.json","Index":26},"AWS.ElasticLoadBalancingV2/ListenerRule@default":{"RelativePath":"aws/aws.elasticloadbalancingv2/default/types.json","Index":57},"AWS.ElasticLoadBalancingV2/LoadBalancer@default":{"RelativePath":"aws/aws.elasticloadbalancingv2/default/types.json","Index":68},"AWS.ElasticLoadBalancingV2/TargetGroup@default":{"RelativePath":"aws/aws.elasticloadbalancingv2/default/types.json","Index":79},"AWS.ElasticLoadBalancingV2/TrustStore@default":{"RelativePath":"aws/aws.elasticloadbalancingv2/default/types.json","Index":84},"AWS.EMR/Studio@default":{"RelativePath":"aws/aws.emr/default/types.json","Index":17},"AWS.EMR/StudioSessionMapping@default":{"RelativePath":"aws/aws.emr/default/types.json","Index":21},"AWS.EMR/WALWorkspace@default":{"RelativePath":"aws/aws.emr/default/types.json","Index":26},"AWS.EMRContainers/VirtualCluster@default":{"RelativePath":"aws/aws.emrcontainers/default/types.json","Index":15},"AWS.EMRServerless/Application@default":{"RelativePath":"aws/aws.emrserverless/default/types.json","Index":58},"AWS.EntityResolution/IdMappingWorkflow@default":{"RelativePath":"aws/aws.entityresolution/default/types.json","Index":28},"AWS.EntityResolution/MatchingWorkflow@default":{"RelativePath":"aws/aws.entityresolution/default/types.json","Index":55},"AWS.EntityResolution/SchemaMapping@default":{"RelativePath":"aws/aws.entityresolution/default/types.json","Index":72},"AWS.Events/ApiDestination@default":{"RelativePath":"aws/aws.events/default/types.json","Index":10},"AWS.Events/Archive@default":{"RelativePath":"aws/aws.events/default/types.json","Index":14},"AWS.Events/Connection@default":{"RelativePath":"aws/aws.events/default/types.json","Index":27},"AWS.Events/Endpoint@default":{"RelativePath":"aws/aws.events/default/types.json","Index":43},"AWS.Events/EventBus@default":{"RelativePath":"aws/aws.events/default/types.json","Index":50},"AWS.Events/Rule@default":{"RelativePath":"aws/aws.events/default/types.json","Index":93},"AWS.EventSchemas/Discoverer@default":{"RelativePath":"aws/aws.eventschemas/default/types.json","Index":12},"AWS.EventSchemas/Registry@default":{"RelativePath":"aws/aws.eventschemas/default/types.json","Index":17},"AWS.EventSchemas/RegistryPolicy@default":{"RelativePath":"aws/aws.eventschemas/default/types.json","Index":21},"AWS.EventSchemas/Schema@default":{"RelativePath":"aws/aws.eventschemas/default/types.json","Index":26},"AWS.Evidently/Experiment@default":{"RelativePath":"aws/aws.evidently/default/types.json","Index":20},"AWS.Evidently/Feature@default":{"RelativePath":"aws/aws.evidently/default/types.json","Index":29},"AWS.Evidently/Launch@default":{"RelativePath":"aws/aws.evidently/default/types.json","Index":46},"AWS.Evidently/Project@default":{"RelativePath":"aws/aws.evidently/default/types.json","Index":54},"AWS.FinSpace/Environment@default":{"RelativePath":"aws/aws.finspace/default/types.json","Index":18},"AWS.FIS/ExperimentTemplate@default":{"RelativePath":"aws/aws.fis/default/types.json","Index":55},"AWS.FIS/TargetAccountConfiguration@default":{"RelativePath":"aws/aws.fis/default/types.json","Index":62},"AWS.FMS/NotificationChannel@default":{"RelativePath":"aws/aws.fms/default/types.json","Index":11},"AWS.FMS/Policy@default":{"RelativePath":"aws/aws.fms/default/types.json","Index":35},"AWS.FMS/ResourceSet@default":{"RelativePath":"aws/aws.fms/default/types.json","Index":45},"AWS.Forecast/DatasetGroup@default":{"RelativePath":"aws/aws.forecast/default/types.json","Index":16},"AWS.FraudDetector/Detector@default":{"RelativePath":"aws/aws.frauddetector/default/types.json","Index":31},"AWS.FraudDetector/EntityType@default":{"RelativePath":"aws/aws.frauddetector/default/types.json","Index":36},"AWS.FraudDetector/EventType@default":{"RelativePath":"aws/aws.frauddetector/default/types.json","Index":50},"AWS.FraudDetector/Label@default":{"RelativePath":"aws/aws.frauddetector/default/types.json","Index":55},"AWS.FraudDetector/List@default":{"RelativePath":"aws/aws.frauddetector/default/types.json","Index":62},"AWS.FraudDetector/Outcome@default":{"RelativePath":"aws/aws.frauddetector/default/types.json","Index":67},"AWS.FraudDetector/Variable@default":{"RelativePath":"aws/aws.frauddetector/default/types.json","Index":72},"AWS.FSx/DataRepositoryAssociation@default":{"RelativePath":"aws/aws.fsx/default/types.json","Index":20},"AWS.GameLift/Alias@default":{"RelativePath":"aws/aws.gamelift/default/types.json","Index":11},"AWS.GameLift/Build@default":{"RelativePath":"aws/aws.gamelift/default/types.json","Index":15},"AWS.GameLift/Fleet@default":{"RelativePath":"aws/aws.gamelift/default/types.json","Index":35},"AWS.GameLift/GameServerGroup@default":{"RelativePath":"aws/aws.gamelift/default/types.json","Index":77},"AWS.GameLift/GameSessionQueue@default":{"RelativePath":"aws/aws.gamelift/default/types.json","Index":102},"AWS.GameLift/Location@default":{"RelativePath":"aws/aws.gamelift/default/types.json","Index":107},"AWS.GameLift/MatchmakingConfiguration@default":{"RelativePath":"aws/aws.gamelift/default/types.json","Index":115},"AWS.GameLift/MatchmakingRuleSet@default":{"RelativePath":"aws/aws.gamelift/default/types.json","Index":120},"AWS.GameLift/Script@default":{"RelativePath":"aws/aws.gamelift/default/types.json","Index":127},"AWS.GlobalAccelerator/Accelerator@default":{"RelativePath":"aws/aws.globalaccelerator/default/types.json","Index":16},"AWS.GlobalAccelerator/EndpointGroup@default":{"RelativePath":"aws/aws.globalaccelerator/default/types.json","Index":24},"AWS.GlobalAccelerator/Listener@default":{"RelativePath":"aws/aws.globalaccelerator/default/types.json","Index":30},"AWS.Glue/Registry@default":{"RelativePath":"aws/aws.glue/default/types.json","Index":12},"AWS.Glue/Schema@default":{"RelativePath":"aws/aws.glue/default/types.json","Index":19},"AWS.Grafana/Workspace@default":{"RelativePath":"aws/aws.grafana/default/types.json","Index":34},"AWS.GreengrassV2/ComponentVersion@default":{"RelativePath":"aws/aws.greengrassv2/default/types.json","Index":31},"AWS.GreengrassV2/Deployment@default":{"RelativePath":"aws/aws.greengrassv2/default/types.json","Index":53},"AWS.GroundStation/Config@default":{"RelativePath":"aws/aws.groundstation/default/types.json","Index":35},"AWS.GroundStation/MissionProfile@default":{"RelativePath":"aws/aws.groundstation/default/types.json","Index":43},"AWS.GuardDuty/Detector@default":{"RelativePath":"aws/aws.guardduty/default/types.json","Index":22},"AWS.GuardDuty/IPSet@default":{"RelativePath":"aws/aws.guardduty/default/types.json","Index":27},"AWS.GuardDuty/ThreatIntelSet@default":{"RelativePath":"aws/aws.guardduty/default/types.json","Index":32},"AWS.HealthLake/FHIRDatastore@default":{"RelativePath":"aws/aws.healthlake/default/types.json","Index":23},"AWS.IAM/Group@default":{"RelativePath":"aws/aws.iam/default/types.json","Index":15},"AWS.IAM/GroupPolicy@default":{"RelativePath":"aws/aws.iam/default/types.json","Index":19},"AWS.IAM/InstanceProfile@default":{"RelativePath":"aws/aws.iam/default/types.json","Index":23},"AWS.IAM/ManagedPolicy@default":{"RelativePath":"aws/aws.iam/default/types.json","Index":31},"AWS.IAM/OIDCProvider@default":{"RelativePath":"aws/aws.iam/default/types.json","Index":38},"AWS.IAM/Role@default":{"RelativePath":"aws/aws.iam/default/types.json","Index":50},"AWS.IAM/RolePolicy@default":{"RelativePath":"aws/aws.iam/default/types.json","Index":54},"AWS.IAM/SAMLProvider@default":{"RelativePath":"aws/aws.iam/default/types.json","Index":59},"AWS.IAM/ServerCertificate@default":{"RelativePath":"aws/aws.iam/default/types.json","Index":64},"AWS.IAM/ServiceLinkedRole@default":{"RelativePath":"aws/aws.iam/default/types.json","Index":67},"AWS.IAM/User@default":{"RelativePath":"aws/aws.iam/default/types.json","Index":79},"AWS.IAM/UserPolicy@default":{"RelativePath":"aws/aws.iam/default/types.json","Index":83},"AWS.IAM/VirtualMFADevice@default":{"RelativePath":"aws/aws.iam/default/types.json","Index":89},"AWS.IdentityStore/Group@default":{"RelativePath":"aws/aws.identitystore/default/types.json","Index":10},"AWS.ImageBuilder/DistributionConfiguration@default":{"RelativePath":"aws/aws.imagebuilder/default/types.json","Index":32},"AWS.ImageBuilder/ImagePipeline@default":{"RelativePath":"aws/aws.imagebuilder/default/types.json","Index":47},"AWS.ImageBuilder/InfrastructureConfiguration@default":{"RelativePath":"aws/aws.imagebuilder/default/types.json","Index":58},"AWS.ImageBuilder/LifecyclePolicy@default":{"RelativePath":"aws/aws.imagebuilder/default/types.json","Index":79},"AWS.Inspector/AssessmentTarget@default":{"RelativePath":"aws/aws.inspector/default/types.json","Index":10},"AWS.InspectorV2/Filter@default":{"RelativePath":"aws/aws.inspectorv2/default/types.json","Index":68},"AWS.InternetMonitor/Monitor@default":{"RelativePath":"aws/aws.internetmonitor/default/types.json","Index":22},"AWS.IoT/AccountAuditConfiguration@default":{"RelativePath":"aws/aws.iot/default/types.json","Index":14},"AWS.IoT/Authorizer@default":{"RelativePath":"aws/aws.iot/default/types.json","Index":20},"AWS.IoT/BillingGroup@default":{"RelativePath":"aws/aws.iot/default/types.json","Index":26},"AWS.IoT/CACertificate@default":{"RelativePath":"aws/aws.iot/default/types.json","Index":32},"AWS.IoT/Certificate@default":{"RelativePath":"aws/aws.iot/default/types.json","Index":35},"AWS.IoT/CertificateProvider@default":{"RelativePath":"aws/aws.iot/default/types.json","Index":42},"AWS.IoT/CustomMetric@default":{"RelativePath":"aws/aws.iot/default/types.json","Index":47},"AWS.IoT/Dimension@default":{"RelativePath":"aws/aws.iot/default/types.json","Index":53},"AWS.IoT/DomainConfiguration@default":{"RelativePath":"aws/aws.iot/default/types.json","Index":64},"AWS.IoT/FleetMetric@default":{"RelativePath":"aws/aws.iot/default/types.json","Index":71},"AWS.IoT/Logging@default":{"RelativePath":"aws/aws.iot/default/types.json","Index":74},"AWS.IoT/MitigationAction@default":{"RelativePath":"aws/aws.iot/default/types.json","Index":87},"AWS.IoT/Policy@default":{"RelativePath":"aws/aws.iot/default/types.json","Index":94},"AWS.IoT/ProvisioningTemplate@default":{"RelativePath":"aws/aws.iot/default/types.json","Index":100},"AWS.IoT/ResourceSpecificLogging@default":{"RelativePath":"aws/aws.iot/default/types.json","Index":103},"AWS.IoT/RoleAlias@default":{"RelativePath":"aws/aws.iot/default/types.json","Index":108},"AWS.IoT/ScheduledAudit@default":{"RelativePath":"aws/aws.iot/default/types.json","Index":114},"AWS.IoT/SecurityProfile@default":{"RelativePath":"aws/aws.iot/default/types.json","Index":137},"AWS.IoT/SoftwarePackage@default":{"RelativePath":"aws/aws.iot/default/types.json","Index":142},"AWS.IoT/SoftwarePackageVersion@default":{"RelativePath":"aws/aws.iot/default/types.json","Index":149},"AWS.IoT/Thing@default":{"RelativePath":"aws/aws.iot/default/types.json","Index":154},"AWS.IoT/ThingGroup@default":{"RelativePath":"aws/aws.iot/default/types.json","Index":162},"AWS.IoT/ThingType@default":{"RelativePath":"aws/aws.iot/default/types.json","Index":169},"AWS.IoT/TopicRule@default":{"RelativePath":"aws/aws.iot/default/types.json","Index":226},"AWS.IoT/TopicRuleDestination@default":{"RelativePath":"aws/aws.iot/default/types.json","Index":234},"AWS.IoTAnalytics/Channel@default":{"RelativePath":"aws/aws.iotanalytics/default/types.json","Index":16},"AWS.IoTAnalytics/Dataset@default":{"RelativePath":"aws/aws.iotanalytics/default/types.json","Index":49},"AWS.IoTAnalytics/Datastore@default":{"RelativePath":"aws/aws.iotanalytics/default/types.json","Index":71},"AWS.IoTAnalytics/Pipeline@default":{"RelativePath":"aws/aws.iotanalytics/default/types.json","Index":91},"AWS.IoTCoreDeviceAdvisor/SuiteDefinition@default":{"RelativePath":"aws/aws.iotcoredeviceadvisor/default/types.json","Index":21},"AWS.IoTEvents/AlarmModel@default":{"RelativePath":"aws/aws.iotevents/default/types.json","Index":35},"AWS.IoTEvents/DetectorModel@default":{"RelativePath":"aws/aws.iotevents/default/types.json","Index":72},"AWS.IoTEvents/Input@default":{"RelativePath":"aws/aws.iotevents/default/types.json","Index":80},"AWS.IoTFleetHub/Application@default":{"RelativePath":"aws/aws.iotfleethub/default/types.json","Index":12},"AWS.IoTSiteWise/AccessPolicy@default":{"RelativePath":"aws/aws.iotsitewise/default/types.json","Index":17},"AWS.IoTSiteWise/Asset@default":{"RelativePath":"aws/aws.iotsitewise/default/types.json","Index":26},"AWS.IoTSiteWise/AssetModel@default":{"RelativePath":"aws/aws.iotsitewise/default/types.json","Index":53},"AWS.IoTSiteWise/Dashboard@default":{"RelativePath":"aws/aws.iotsitewise/default/types.json","Index":58},"AWS.IoTSiteWise/Gateway@default":{"RelativePath":"aws/aws.iotsitewise/default/types.json","Index":70},"AWS.IoTSiteWise/Portal@default":{"RelativePath":"aws/aws.iotsitewise/default/types.json","Index":76},"AWS.IoTSiteWise/Project@default":{"RelativePath":"aws/aws.iotsitewise/default/types.json","Index":83},"AWS.IoTTwinMaker/ComponentType@default":{"RelativePath":"aws/aws.iottwinmaker/default/types.json","Index":38},"AWS.IoTTwinMaker/Entity@default":{"RelativePath":"aws/aws.iottwinmaker/default/types.json","Index":66},"AWS.IoTTwinMaker/Scene@default":{"RelativePath":"aws/aws.iottwinmaker/default/types.json","Index":74},"AWS.IoTTwinMaker/Workspace@default":{"RelativePath":"aws/aws.iottwinmaker/default/types.json","Index":79},"AWS.IoTWireless/Destination@default":{"RelativePath":"aws/aws.iotwireless/default/types.json","Index":12},"AWS.IoTWireless/FuotaTask@default":{"RelativePath":"aws/aws.iotwireless/default/types.json","Index":18},"AWS.IoTWireless/MulticastGroup@default":{"RelativePath":"aws/aws.iotwireless/default/types.json","Index":24},"AWS.IoTWireless/NetworkAnalyzerConfiguration@default":{"RelativePath":"aws/aws.iotwireless/default/types.json","Index":34},"AWS.IoTWireless/WirelessDevice@default":{"RelativePath":"aws/aws.iotwireless/default/types.json","Index":46},"AWS.IoTWireless/WirelessGateway@default":{"RelativePath":"aws/aws.iotwireless/default/types.json","Index":52},"AWS.IVS/Channel@default":{"RelativePath":"aws/aws.ivs/default/types.json","Index":12},"AWS.IVS/PlaybackKeyPair@default":{"RelativePath":"aws/aws.ivs/default/types.json","Index":17},"AWS.IVS/RecordingConfiguration@default":{"RelativePath":"aws/aws.ivs/default/types.json","Index":28},"AWS.IVS/StreamKey@default":{"RelativePath":"aws/aws.ivs/default/types.json","Index":33},"AWS.IVSChat/LoggingConfiguration@default":{"RelativePath":"aws/aws.ivschat/default/types.json","Index":16},"AWS.IVSChat/Room@default":{"RelativePath":"aws/aws.ivschat/default/types.json","Index":23},"AWS.KafkaConnect/Connector@default":{"RelativePath":"aws/aws.kafkaconnect/default/types.json","Index":34},"AWS.Kendra/DataSource@default":{"RelativePath":"aws/aws.kendra/default/types.json","Index":209},"AWS.Kendra/Faq@default":{"RelativePath":"aws/aws.kendra/default/types.json","Index":225},"AWS.Kendra/Index@default":{"RelativePath":"aws/aws.kendra/default/types.json","Index":273},"AWS.KendraRanking/ExecutionPlan@default":{"RelativePath":"aws/aws.kendraranking/default/types.json","Index":20},"AWS.Kinesis/Stream@default":{"RelativePath":"aws/aws.kinesis/default/types.json","Index":14},"AWS.KinesisAnalyticsV2/Application@default":{"RelativePath":"aws/aws.kinesisanalyticsv2/default/types.json","Index":62},"AWS.KinesisFirehose/DeliveryStream@default":{"RelativePath":"aws/aws.kinesisfirehose/default/types.json","Index":66},"AWS.KinesisVideo/SignalingChannel@default":{"RelativePath":"aws/aws.kinesisvideo/default/types.json","Index":12},"AWS.KinesisVideo/Stream@default":{"RelativePath":"aws/aws.kinesisvideo/default/types.json","Index":17},"AWS.KMS/Alias@default":{"RelativePath":"aws/aws.kms/default/types.json","Index":10},"AWS.KMS/Key@default":{"RelativePath":"aws/aws.kms/default/types.json","Index":17},"AWS.KMS/ReplicaKey@default":{"RelativePath":"aws/aws.kms/default/types.json","Index":24},"AWS.LakeFormation/Tag@default":{"RelativePath":"aws/aws.lakeformation/default/types.json","Index":16},"AWS.Lambda/CodeSigningConfig@default":{"RelativePath":"aws/aws.lambda/default/types.json","Index":13},"AWS.Lambda/EventInvokeConfig@default":{"RelativePath":"aws/aws.lambda/default/types.json","Index":19},"AWS.Lambda/EventSourceMapping@default":{"RelativePath":"aws/aws.lambda/default/types.json","Index":41},"AWS.Lambda/Function@default":{"RelativePath":"aws/aws.lambda/default/types.json","Index":66},"AWS.Lambda/Url@default":{"RelativePath":"aws/aws.lambda/default/types.json","Index":82},"AWS.Lambda/Version@default":{"RelativePath":"aws/aws.lambda/default/types.json","Index":87},"AWS.Lex/Bot@default":{"RelativePath":"aws/aws.lex/default/types.json","Index":182},"AWS.Lex/BotAlias@default":{"RelativePath":"aws/aws.lex/default/types.json","Index":215},"AWS.Lex/ResourcePolicy@default":{"RelativePath":"aws/aws.lex/default/types.json","Index":222},"AWS.LicenseManager/Grant@default":{"RelativePath":"aws/aws.licensemanager/default/types.json","Index":13},"AWS.LicenseManager/License@default":{"RelativePath":"aws/aws.licensemanager/default/types.json","Index":27},"AWS.Lightsail/Alarm@default":{"RelativePath":"aws/aws.lightsail/default/types.json","Index":12},"AWS.Lightsail/Bucket@default":{"RelativePath":"aws/aws.lightsail/default/types.json","Index":20},"AWS.Lightsail/Certificate@default":{"RelativePath":"aws/aws.lightsail/default/types.json","Index":26},"AWS.Lightsail/Container@default":{"RelativePath":"aws/aws.lightsail/default/types.json","Index":46},"AWS.Lightsail/Database@default":{"RelativePath":"aws/aws.lightsail/default/types.json","Index":53},"AWS.Lightsail/Disk@default":{"RelativePath":"aws/aws.lightsail/default/types.json","Index":62},"AWS.Lightsail/Instance@default":{"RelativePath":"aws/aws.lightsail/default/types.json","Index":88},"AWS.Lightsail/LoadBalancer@default":{"RelativePath":"aws/aws.lightsail/default/types.json","Index":94},"AWS.Lightsail/LoadBalancerTlsCertificate@default":{"RelativePath":"aws/aws.lightsail/default/types.json","Index":98},"AWS.Lightsail/StaticIp@default":{"RelativePath":"aws/aws.lightsail/default/types.json","Index":101},"AWS.Location/APIKey@default":{"RelativePath":"aws/aws.location/default/types.json","Index":18},"AWS.Location/GeofenceCollection@default":{"RelativePath":"aws/aws.location/default/types.json","Index":26},"AWS.Location/Map@default":{"RelativePath":"aws/aws.location/default/types.json","Index":35},"AWS.Location/PlaceIndex@default":{"RelativePath":"aws/aws.location/default/types.json","Index":45},"AWS.Location/RouteCalculator@default":{"RelativePath":"aws/aws.location/default/types.json","Index":53},"AWS.Location/Tracker@default":{"RelativePath":"aws/aws.location/default/types.json","Index":62},"AWS.Logs/AccountPolicy@default":{"RelativePath":"aws/aws.logs/default/types.json","Index":10},"AWS.Logs/Delivery@default":{"RelativePath":"aws/aws.logs/default/types.json","Index":16},"AWS.Logs/DeliveryDestination@default":{"RelativePath":"aws/aws.logs/default/types.json","Index":24},"AWS.Logs/DeliverySource@default":{"RelativePath":"aws/aws.logs/default/types.json","Index":31},"AWS.Logs/Destination@default":{"RelativePath":"aws/aws.logs/default/types.json","Index":34},"AWS.Logs/LogAnomalyDetector@default":{"RelativePath":"aws/aws.logs/default/types.json","Index":38},"AWS.Logs/LogGroup@default":{"RelativePath":"aws/aws.logs/default/types.json","Index":44},"AWS.Logs/MetricFilter@default":{"RelativePath":"aws/aws.logs/default/types.json","Index":51},"AWS.Logs/QueryDefinition@default":{"RelativePath":"aws/aws.logs/default/types.json","Index":56},"AWS.Logs/ResourcePolicy@default":{"RelativePath":"aws/aws.logs/default/types.json","Index":59},"AWS.Logs/SubscriptionFilter@default":{"RelativePath":"aws/aws.logs/default/types.json","Index":62},"AWS.LookoutMetrics/AnomalyDetector@default":{"RelativePath":"aws/aws.lookoutmetrics/default/types.json","Index":44},"AWS.LookoutVision/Project@default":{"RelativePath":"aws/aws.lookoutvision/default/types.json","Index":12},"AWS.M2/Application@default":{"RelativePath":"aws/aws.m2/default/types.json","Index":13},"AWS.M2/Environment@default":{"RelativePath":"aws/aws.m2/default/types.json","Index":25},"AWS.Macie/AllowList@default":{"RelativePath":"aws/aws.macie/default/types.json","Index":16},"AWS.Macie/CustomDataIdentifier@default":{"RelativePath":"aws/aws.macie/default/types.json","Index":23},"AWS.Macie/FindingsFilter@default":{"RelativePath":"aws/aws.macie/default/types.json","Index":35},"AWS.Macie/Session@default":{"RelativePath":"aws/aws.macie/default/types.json","Index":38},"AWS.MediaConnect/Bridge@default":{"RelativePath":"aws/aws.mediaconnect/default/types.json","Index":28},"AWS.MediaConnect/BridgeOutput@default":{"RelativePath":"aws/aws.mediaconnect/default/types.json","Index":32},"AWS.MediaConnect/BridgeSource@default":{"RelativePath":"aws/aws.mediaconnect/default/types.json","Index":39},"AWS.MediaConnect/Flow@default":{"RelativePath":"aws/aws.mediaconnect/default/types.json","Index":48},"AWS.MediaConnect/FlowEntitlement@default":{"RelativePath":"aws/aws.mediaconnect/default/types.json","Index":53},"AWS.MediaConnect/FlowOutput@default":{"RelativePath":"aws/aws.mediaconnect/default/types.json","Index":59},"AWS.MediaConnect/FlowSource@default":{"RelativePath":"aws/aws.mediaconnect/default/types.json","Index":65},"AWS.MediaConnect/FlowVpcInterface@default":{"RelativePath":"aws/aws.mediaconnect/default/types.json","Index":70},"AWS.MediaLive/Multiplex@default":{"RelativePath":"aws/aws.medialive/default/types.json","Index":17},"AWS.MediaLive/Multiplexprogram@default":{"RelativePath":"aws/aws.medialive/default/types.json","Index":32},"AWS.MediaPackage/Channel@default":{"RelativePath":"aws/aws.mediapackage/default/types.json","Index":16},"AWS.MediaPackage/OriginEndpoint@default":{"RelativePath":"aws/aws.mediapackage/default/types.json","Index":42},"AWS.MediaPackage/PackagingGroup@default":{"RelativePath":"aws/aws.mediapackage/default/types.json","Index":49},"AWS.MediaPackageV2/Channel@default":{"RelativePath":"aws/aws.mediapackagev2/default/types.json","Index":14},"AWS.MediaPackageV2/ChannelGroup@default":{"RelativePath":"aws/aws.mediapackagev2/default/types.json","Index":19},"AWS.MediaPackageV2/ChannelPolicy@default":{"RelativePath":"aws/aws.mediapackagev2/default/types.json","Index":24},"AWS.MediaPackageV2/OriginEndpoint@default":{"RelativePath":"aws/aws.mediapackagev2/default/types.json","Index":51},"AWS.MediaPackageV2/OriginEndpointPolicy@default":{"RelativePath":"aws/aws.mediapackagev2/default/types.json","Index":56},"AWS.MediaTailor/Channel@default":{"RelativePath":"aws/aws.mediatailor/default/types.json","Index":25},"AWS.MediaTailor/ChannelPolicy@default":{"RelativePath":"aws/aws.mediatailor/default/types.json","Index":30},"AWS.MediaTailor/LiveSource@default":{"RelativePath":"aws/aws.mediatailor/default/types.json","Index":38},"AWS.MediaTailor/PlaybackConfiguration@default":{"RelativePath":"aws/aws.mediatailor/default/types.json","Index":52},"AWS.MediaTailor/SourceLocation@default":{"RelativePath":"aws/aws.mediatailor/default/types.json","Index":64},"AWS.MediaTailor/VodSource@default":{"RelativePath":"aws/aws.mediatailor/default/types.json","Index":72},"AWS.MemoryDB/ACL@default":{"RelativePath":"aws/aws.memorydb/default/types.json","Index":13},"AWS.MemoryDB/Cluster@default":{"RelativePath":"aws/aws.memorydb/default/types.json","Index":23},"AWS.MemoryDB/ParameterGroup@default":{"RelativePath":"aws/aws.memorydb/default/types.json","Index":29},"AWS.MemoryDB/SubnetGroup@default":{"RelativePath":"aws/aws.memorydb/default/types.json","Index":35},"AWS.MemoryDB/User@default":{"RelativePath":"aws/aws.memorydb/default/types.json","Index":42},"AWS.MSK/BatchScramSecret@default":{"RelativePath":"aws/aws.msk/default/types.json","Index":13},"AWS.MSK/Cluster@default":{"RelativePath":"aws/aws.msk/default/types.json","Index":51},"AWS.MSK/ClusterPolicy@default":{"RelativePath":"aws/aws.msk/default/types.json","Index":55},"AWS.MSK/Configuration@default":{"RelativePath":"aws/aws.msk/default/types.json","Index":62},"AWS.MSK/Replicator@default":{"RelativePath":"aws/aws.msk/default/types.json","Index":81},"AWS.MSK/VpcConnection@default":{"RelativePath":"aws/aws.msk/default/types.json","Index":93},"AWS.MWAA/Environment@default":{"RelativePath":"aws/aws.mwaa/default/types.json","Index":55},"AWS.Neptune/DBCluster@default":{"RelativePath":"aws/aws.neptune/default/types.json","Index":18},"AWS.NeptuneGraph/Graph@default":{"RelativePath":"aws/aws.neptunegraph/default/types.json","Index":13},"AWS.NeptuneGraph/PrivateGraphEndpoint@default":{"RelativePath":"aws/aws.neptunegraph/default/types.json","Index":18},"AWS.NetworkFirewall/Firewall@default":{"RelativePath":"aws/aws.networkfirewall/default/types.json","Index":17},"AWS.NetworkFirewall/FirewallPolicy@default":{"RelativePath":"aws/aws.networkfirewall/default/types.json","Index":48},"AWS.NetworkFirewall/LoggingConfiguration@default":{"RelativePath":"aws/aws.networkfirewall/default/types.json","Index":56},"AWS.NetworkFirewall/RuleGroup@default":{"RelativePath":"aws/aws.networkfirewall/default/types.json","Index":117},"AWS.NetworkFirewall/TLSInspectionConfiguration@default":{"RelativePath":"aws/aws.networkfirewall/default/types.json","Index":142},"AWS.NetworkManager/ConnectAttachment@default":{"RelativePath":"aws/aws.networkmanager/default/types.json","Index":15},"AWS.NetworkManager/ConnectPeer@default":{"RelativePath":"aws/aws.networkmanager/default/types.json","Index":27},"AWS.NetworkManager/CoreNetwork@default":{"RelativePath":"aws/aws.networkmanager/default/types.json","Index":40},"AWS.NetworkManager/Device@default":{"RelativePath":"aws/aws.networkmanager/default/types.json","Index":47},"AWS.NetworkManager/GlobalNetwork@default":{"RelativePath":"aws/aws.networkmanager/default/types.json","Index":52},"AWS.NetworkManager/Link@default":{"RelativePath":"aws/aws.networkmanager/default/types.json","Index":58},"AWS.NetworkManager/Site@default":{"RelativePath":"aws/aws.networkmanager/default/types.json","Index":64},"AWS.NetworkManager/SiteToSiteVpnAttachment@default":{"RelativePath":"aws/aws.networkmanager/default/types.json","Index":71},"AWS.NetworkManager/TransitGatewayPeering@default":{"RelativePath":"aws/aws.networkmanager/default/types.json","Index":76},"AWS.NetworkManager/TransitGatewayRouteTableAttachment@default":{"RelativePath":"aws/aws.networkmanager/default/types.json","Index":83},"AWS.NetworkManager/VpcAttachment@default":{"RelativePath":"aws/aws.networkmanager/default/types.json","Index":92},"AWS.NimbleStudio/LaunchProfile@default":{"RelativePath":"aws/aws.nimblestudio/default/types.json","Index":28},"AWS.NimbleStudio/StreamingImage@default":{"RelativePath":"aws/aws.nimblestudio/default/types.json","Index":35},"AWS.NimbleStudio/Studio@default":{"RelativePath":"aws/aws.nimblestudio/default/types.json","Index":41},"AWS.NimbleStudio/StudioComponent@default":{"RelativePath":"aws/aws.nimblestudio/default/types.json","Index":61},"AWS.Oam/Link@default":{"RelativePath":"aws/aws.oam/default/types.json","Index":13},"AWS.Oam/Sink@default":{"RelativePath":"aws/aws.oam/default/types.json","Index":18},"AWS.Omics/AnnotationStore@default":{"RelativePath":"aws/aws.omics/default/types.json","Index":24},"AWS.Omics/RunGroup@default":{"RelativePath":"aws/aws.omics/default/types.json","Index":28},"AWS.Omics/VariantStore@default":{"RelativePath":"aws/aws.omics/default/types.json","Index":36},"AWS.Omics/Workflow@default":{"RelativePath":"aws/aws.omics/default/types.json","Index":46},"AWS.OpenSearchServerless/AccessPolicy@default":{"RelativePath":"aws/aws.opensearchserverless/default/types.json","Index":11},"AWS.OpenSearchServerless/Collection@default":{"RelativePath":"aws/aws.opensearchserverless/default/types.json","Index":18},"AWS.OpenSearchServerless/LifecyclePolicy@default":{"RelativePath":"aws/aws.opensearchserverless/default/types.json","Index":22},"AWS.OpenSearchServerless/SecurityConfig@default":{"RelativePath":"aws/aws.opensearchserverless/default/types.json","Index":27},"AWS.OpenSearchServerless/SecurityPolicy@default":{"RelativePath":"aws/aws.opensearchserverless/default/types.json","Index":31},"AWS.OpenSearchServerless/VpcEndpoint@default":{"RelativePath":"aws/aws.opensearchserverless/default/types.json","Index":36},"AWS.OpenSearchService/Domain@default":{"RelativePath":"aws/aws.opensearchservice/default/types.json","Index":37},"AWS.OpsWorksCM/Server@default":{"RelativePath":"aws/aws.opsworkscm/default/types.json","Index":16},"AWS.Organizations/Account@default":{"RelativePath":"aws/aws.organizations/default/types.json","Index":13},"AWS.Organizations/Organization@default":{"RelativePath":"aws/aws.organizations/default/types.json","Index":16},"AWS.Organizations/OrganizationalUnit@default":{"RelativePath":"aws/aws.organizations/default/types.json","Index":21},"AWS.Organizations/Policy@default":{"RelativePath":"aws/aws.organizations/default/types.json","Index":29},"AWS.Organizations/ResourcePolicy@default":{"RelativePath":"aws/aws.organizations/default/types.json","Index":36},"AWS.OSIS/Pipeline@default":{"RelativePath":"aws/aws.osis/default/types.json","Index":22},"AWS.Panorama/ApplicationInstance@default":{"RelativePath":"aws/aws.panorama/default/types.json","Index":31},"AWS.Panorama/Package@default":{"RelativePath":"aws/aws.panorama/default/types.json","Index":43},"AWS.Panorama/PackageVersion@default":{"RelativePath":"aws/aws.panorama/default/types.json","Index":55},"AWS.PCAConnectorAD/Connector@default":{"RelativePath":"aws/aws.pcaconnectorad/default/types.json","Index":13},"AWS.PCAConnectorAD/DirectoryRegistration@default":{"RelativePath":"aws/aws.pcaconnectorad/default/types.json","Index":17},"AWS.PCAConnectorAD/Template@default":{"RelativePath":"aws/aws.pcaconnectorad/default/types.json","Index":68},"AWS.PCAConnectorAD/TemplateGroupAccessControlEntry@default":{"RelativePath":"aws/aws.pcaconnectorad/default/types.json","Index":73},"AWS.Personalize/Dataset@default":{"RelativePath":"aws/aws.personalize/default/types.json","Index":12},"AWS.Pinpoint/InAppTemplate@default":{"RelativePath":"aws/aws.pinpoint/default/types.json","Index":21},"AWS.Pipes/Pipe@default":{"RelativePath":"aws/aws.pipes/default/types.json","Index":114},"AWS.Proton/EnvironmentAccountConnection@default":{"RelativePath":"aws/aws.proton/default/types.json","Index":13},"AWS.Proton/EnvironmentTemplate@default":{"RelativePath":"aws/aws.proton/default/types.json","Index":19},"AWS.Proton/ServiceTemplate@default":{"RelativePath":"aws/aws.proton/default/types.json","Index":25},"AWS.QLDB/Stream@default":{"RelativePath":"aws/aws.qldb/default/types.json","Index":15},"AWS.QuickSight/Analysis@default":{"RelativePath":"aws/aws.quicksight/default/types.json","Index":831},"AWS.QuickSight/Dashboard@default":{"RelativePath":"aws/aws.quicksight/default/types.json","Index":1673},"AWS.QuickSight/DataSet@default":{"RelativePath":"aws/aws.quicksight/default/types.json","Index":1782},"AWS.QuickSight/DataSource@default":{"RelativePath":"aws/aws.quicksight/default/types.json","Index":1824},"AWS.QuickSight/RefreshSchedule@default":{"RelativePath":"aws/aws.quicksight/default/types.json","Index":1830},"AWS.QuickSight/Template@default":{"RelativePath":"aws/aws.quicksight/default/types.json","Index":2650},"AWS.QuickSight/Theme@default":{"RelativePath":"aws/aws.quicksight/default/types.json","Index":2678},"AWS.QuickSight/Topic@default":{"RelativePath":"aws/aws.quicksight/default/types.json","Index":2750},"AWS.QuickSight/VPCConnection@default":{"RelativePath":"aws/aws.quicksight/default/types.json","Index":2779},"AWS.RAM/Permission@default":{"RelativePath":"aws/aws.ram/default/types.json","Index":13},"AWS.RDS/CustomDBEngineVersion@default":{"RelativePath":"aws/aws.rds/default/types.json","Index":12},"AWS.RDS/DBCluster@default":{"RelativePath":"aws/aws.rds/default/types.json","Index":27},"AWS.RDS/DBClusterParameterGroup@default":{"RelativePath":"aws/aws.rds/default/types.json","Index":33},"AWS.RDS/DBInstance@default":{"RelativePath":"aws/aws.rds/default/types.json","Index":49},"AWS.RDS/DBParameterGroup@default":{"RelativePath":"aws/aws.rds/default/types.json","Index":55},"AWS.RDS/DBProxy@default":{"RelativePath":"aws/aws.rds/default/types.json","Index":64},"AWS.RDS/DBProxyEndpoint@default":{"RelativePath":"aws/aws.rds/default/types.json","Index":71},"AWS.RDS/DBProxyTargetGroup@default":{"RelativePath":"aws/aws.rds/default/types.json","Index":78},"AWS.RDS/DBSubnetGroup@default":{"RelativePath":"aws/aws.rds/default/types.json","Index":84},"AWS.RDS/EventSubscription@default":{"RelativePath":"aws/aws.rds/default/types.json","Index":91},"AWS.RDS/GlobalCluster@default":{"RelativePath":"aws/aws.rds/default/types.json","Index":94},"AWS.RDS/OptionGroup@default":{"RelativePath":"aws/aws.rds/default/types.json","Index":105},"AWS.Redshift/Cluster@default":{"RelativePath":"aws/aws.redshift/default/types.json","Index":18},"AWS.Redshift/ClusterParameterGroup@default":{"RelativePath":"aws/aws.redshift/default/types.json","Index":25},"AWS.Redshift/ClusterSubnetGroup@default":{"RelativePath":"aws/aws.redshift/default/types.json","Index":31},"AWS.Redshift/EndpointAccess@default":{"RelativePath":"aws/aws.redshift/default/types.json","Index":40},"AWS.Redshift/EndpointAuthorization@default":{"RelativePath":"aws/aws.redshift/default/types.json","Index":47},"AWS.Redshift/EventSubscription@default":{"RelativePath":"aws/aws.redshift/default/types.json","Index":56},"AWS.Redshift/ScheduledAction@default":{"RelativePath":"aws/aws.redshift/default/types.json","Index":65},"AWS.RedshiftServerless/Namespace@default":{"RelativePath":"aws/aws.redshiftserverless/default/types.json","Index":19},"AWS.RedshiftServerless/Workgroup@default":{"RelativePath":"aws/aws.redshiftserverless/default/types.json","Index":38},"AWS.RefactorSpaces/Route@default":{"RelativePath":"aws/aws.refactorspaces/default/types.json","Index":18},"AWS.Rekognition/Collection@default":{"RelativePath":"aws/aws.rekognition/default/types.json","Index":14},"AWS.Rekognition/Project@default":{"RelativePath":"aws/aws.rekognition/default/types.json","Index":19},"AWS.Rekognition/StreamProcessor@default":{"RelativePath":"aws/aws.rekognition/default/types.json","Index":42},"AWS.ResilienceHub/App@default":{"RelativePath":"aws/aws.resiliencehub/default/types.json","Index":20},"AWS.ResilienceHub/ResiliencyPolicy@default":{"RelativePath":"aws/aws.resiliencehub/default/types.json","Index":27},"AWS.ResourceExplorer2/DefaultViewAssociation@default":{"RelativePath":"aws/aws.resourceexplorer2/default/types.json","Index":10},"AWS.ResourceExplorer2/Index@default":{"RelativePath":"aws/aws.resourceexplorer2/default/types.json","Index":16},"AWS.ResourceExplorer2/View@default":{"RelativePath":"aws/aws.resourceexplorer2/default/types.json","Index":23},"AWS.ResourceGroups/Group@default":{"RelativePath":"aws/aws.resourcegroups/default/types.json","Index":26},"AWS.RoboMaker/Fleet@default":{"RelativePath":"aws/aws.robomaker/default/types.json","Index":12},"AWS.RoboMaker/Robot@default":{"RelativePath":"aws/aws.robomaker/default/types.json","Index":17},"AWS.RoboMaker/RobotApplication@default":{"RelativePath":"aws/aws.robomaker/default/types.json","Index":25},"AWS.RoboMaker/SimulationApplication@default":{"RelativePath":"aws/aws.robomaker/default/types.json","Index":35},"AWS.RolesAnywhere/CRL@default":{"RelativePath":"aws/aws.rolesanywhere/default/types.json","Index":12},"AWS.RolesAnywhere/Profile@default":{"RelativePath":"aws/aws.rolesanywhere/default/types.json","Index":19},"AWS.RolesAnywhere/TrustAnchor@default":{"RelativePath":"aws/aws.rolesanywhere/default/types.json","Index":32},"AWS.Route53/CidrCollection@default":{"RelativePath":"aws/aws.route53/default/types.json","Index":13},"AWS.Route53/HealthCheck@default":{"RelativePath":"aws/aws.route53/default/types.json","Index":22},"AWS.Route53/HostedZone@default":{"RelativePath":"aws/aws.route53/default/types.json","Index":32},"AWS.Route53/KeySigningKey@default":{"RelativePath":"aws/aws.route53/default/types.json","Index":35},"AWS.Route53RecoveryControl/ControlPanel@default":{"RelativePath":"aws/aws.route53recoverycontrol/default/types.json","Index":12},"AWS.Route53RecoveryControl/RoutingControl@default":{"RelativePath":"aws/aws.route53recoverycontrol/default/types.json","Index":15},"AWS.Route53RecoveryControl/SafetyRule@default":{"RelativePath":"aws/aws.route53recoverycontrol/default/types.json","Index":28},"AWS.Route53RecoveryReadiness/Cell@default":{"RelativePath":"aws/aws.route53recoveryreadiness/default/types.json","Index":14},"AWS.Route53RecoveryReadiness/ReadinessCheck@default":{"RelativePath":"aws/aws.route53recoveryreadiness/default/types.json","Index":19},"AWS.Route53RecoveryReadiness/RecoveryGroup@default":{"RelativePath":"aws/aws.route53recoveryreadiness/default/types.json","Index":25},"AWS.Route53RecoveryReadiness/ResourceSet@default":{"RelativePath":"aws/aws.route53recoveryreadiness/default/types.json","Index":37},"AWS.Route53Resolver/FirewallDomainList@default":{"RelativePath":"aws/aws.route53resolver/default/types.json","Index":15},"AWS.Route53Resolver/FirewallRuleGroup@default":{"RelativePath":"aws/aws.route53resolver/default/types.json","Index":22},"AWS.Route53Resolver/FirewallRuleGroupAssociation@default":{"RelativePath":"aws/aws.route53resolver/default/types.json","Index":27},"AWS.Route53Resolver/OutpostResolver@default":{"RelativePath":"aws/aws.route53resolver/default/types.json","Index":32},"AWS.Route53Resolver/ResolverRule@default":{"RelativePath":"aws/aws.route53resolver/default/types.json","Index":39},"AWS.RUM/AppMonitor@default":{"RelativePath":"aws/aws.rum/default/types.json","Index":33},"AWS.S3/AccessGrant@default":{"RelativePath":"aws/aws.s3/default/types.json","Index":15},"AWS.S3/AccessGrantsInstance@default":{"RelativePath":"aws/aws.s3/default/types.json","Index":22},"AWS.S3/AccessGrantsLocation@default":{"RelativePath":"aws/aws.s3/default/types.json","Index":27},"AWS.S3/AccessPoint@default":{"RelativePath":"aws/aws.s3/default/types.json","Index":34},"AWS.S3/Bucket@default":{"RelativePath":"aws/aws.s3/default/types.json","Index":126},"AWS.S3/BucketPolicy@default":{"RelativePath":"aws/aws.s3/default/types.json","Index":131},"AWS.S3/MultiRegionAccessPointPolicy@default":{"RelativePath":"aws/aws.s3/default/types.json","Index":136},"AWS.S3/StorageLens@default":{"RelativePath":"aws/aws.s3/default/types.json","Index":167},"AWS.S3/StorageLensGroup@default":{"RelativePath":"aws/aws.s3/default/types.json","Index":193},"AWS.S3Express/BucketPolicy@default":{"RelativePath":"aws/aws.s3express/default/types.json","Index":12},"AWS.S3ObjectLambda/AccessPoint@default":{"RelativePath":"aws/aws.s3objectlambda/default/types.json","Index":21},"AWS.S3ObjectLambda/AccessPointPolicy@default":{"RelativePath":"aws/aws.s3objectlambda/default/types.json","Index":25},"AWS.S3Outposts/AccessPoint@default":{"RelativePath":"aws/aws.s3outposts/default/types.json","Index":12},"AWS.S3Outposts/Bucket@default":{"RelativePath":"aws/aws.s3outposts/default/types.json","Index":26},"AWS.S3Outposts/BucketPolicy@default":{"RelativePath":"aws/aws.s3outposts/default/types.json","Index":30},"AWS.SageMaker/AppImageConfig@default":{"RelativePath":"aws/aws.sagemaker/default/types.json","Index":16},"AWS.SageMaker/Device@default":{"RelativePath":"aws/aws.sagemaker/default/types.json","Index":22},"AWS.SageMaker/DeviceFleet@default":{"RelativePath":"aws/aws.sagemaker/default/types.json","Index":28},"AWS.SageMaker/Domain@default":{"RelativePath":"aws/aws.sagemaker/default/types.json","Index":65},"AWS.SageMaker/FeatureGroup@default":{"RelativePath":"aws/aws.sagemaker/default/types.json","Index":80},"AWS.SageMaker/Image@default":{"RelativePath":"aws/aws.sagemaker/default/types.json","Index":90},"AWS.SageMaker/ImageVersion@default":{"RelativePath":"aws/aws.sagemaker/default/types.json","Index":110},"AWS.SageMaker/InferenceComponent@default":{"RelativePath":"aws/aws.sagemaker/default/types.json","Index":140},"AWS.SageMaker/InferenceExperiment@default":{"RelativePath":"aws/aws.sagemaker/default/types.json","Index":159},"AWS.SageMaker/ModelCard@default":{"RelativePath":"aws/aws.sagemaker/default/types.json","Index":222},"AWS.SageMaker/ModelPackage@default":{"RelativePath":"aws/aws.sagemaker/default/types.json","Index":295},"AWS.SageMaker/ModelPackageGroup@default":{"RelativePath":"aws/aws.sagemaker/default/types.json","Index":305},"AWS.SageMaker/MonitoringSchedule@default":{"RelativePath":"aws/aws.sagemaker/default/types.json","Index":348},"AWS.SageMaker/Pipeline@default":{"RelativePath":"aws/aws.sagemaker/default/types.json","Index":356},"AWS.SageMaker/Project@default":{"RelativePath":"aws/aws.sagemaker/default/types.json","Index":373},"AWS.SageMaker/Space@default":{"RelativePath":"aws/aws.sagemaker/default/types.json","Index":384},"AWS.SageMaker/UserProfile@default":{"RelativePath":"aws/aws.sagemaker/default/types.json","Index":413},"AWS.Scheduler/Schedule@default":{"RelativePath":"aws/aws.scheduler/default/types.json","Index":40},"AWS.Scheduler/ScheduleGroup@default":{"RelativePath":"aws/aws.scheduler/default/types.json","Index":46},"AWS.SecretsManager/Secret@default":{"RelativePath":"aws/aws.secretsmanager/default/types.json","Index":15},"AWS.SecurityHub/AutomationRule@default":{"RelativePath":"aws/aws.securityhub/default/types.json","Index":76},"AWS.SecurityHub/Hub@default":{"RelativePath":"aws/aws.securityhub/default/types.json","Index":80},"AWS.SecurityHub/Standard@default":{"RelativePath":"aws/aws.securityhub/default/types.json","Index":85},"AWS.ServiceCatalog/CloudFormationProvisionedProduct@default":{"RelativePath":"aws/aws.servicecatalog/default/types.json","Index":20},"AWS.ServiceCatalog/ServiceAction@default":{"RelativePath":"aws/aws.servicecatalog/default/types.json","Index":25},"AWS.ServiceCatalogAppRegistry/Application@default":{"RelativePath":"aws/aws.servicecatalogappregistry/default/types.json","Index":11},"AWS.ServiceCatalogAppRegistry/AttributeGroup@default":{"RelativePath":"aws/aws.servicecatalogappregistry/default/types.json","Index":16},"AWS.SES/ConfigurationSet@default":{"RelativePath":"aws/aws.ses/default/types.json","Index":19},"AWS.SES/ConfigurationSetEventDestination@default":{"RelativePath":"aws/aws.ses/default/types.json","Index":29},"AWS.SES/ContactList@default":{"RelativePath":"aws/aws.ses/default/types.json","Index":36},"AWS.SES/DedicatedIpPool@default":{"RelativePath":"aws/aws.ses/default/types.json","Index":39},"AWS.SES/EmailIdentity@default":{"RelativePath":"aws/aws.ses/default/types.json","Index":47},"AWS.SES/Template@default":{"RelativePath":"aws/aws.ses/default/types.json","Index":51},"AWS.SES/VdmAttributes@default":{"RelativePath":"aws/aws.ses/default/types.json","Index":56},"AWS.Shield/DRTAccess@default":{"RelativePath":"aws/aws.shield/default/types.json","Index":11},"AWS.Shield/ProactiveEngagement@default":{"RelativePath":"aws/aws.shield/default/types.json","Index":16},"AWS.Shield/Protection@default":{"RelativePath":"aws/aws.shield/default/types.json","Index":24},"AWS.Shield/ProtectionGroup@default":{"RelativePath":"aws/aws.shield/default/types.json","Index":30},"AWS.Signer/SigningProfile@default":{"RelativePath":"aws/aws.signer/default/types.json","Index":16},"AWS.SimSpaceWeaver/Simulation@default":{"RelativePath":"aws/aws.simspaceweaver/default/types.json","Index":11},"AWS.SNS/Topic@default":{"RelativePath":"aws/aws.sns/default/types.json","Index":18},"AWS.SNS/TopicInlinePolicy@default":{"RelativePath":"aws/aws.sns/default/types.json","Index":22},"AWS.SQS/Queue@default":{"RelativePath":"aws/aws.sqs/default/types.json","Index":16},"AWS.SQS/QueueInlinePolicy@default":{"RelativePath":"aws/aws.sqs/default/types.json","Index":20},"AWS.SSM/Association@default":{"RelativePath":"aws/aws.ssm/default/types.json","Index":22},"AWS.SSM/Document@default":{"RelativePath":"aws/aws.ssm/default/types.json","Index":34},"AWS.SSM/Parameter@default":{"RelativePath":"aws/aws.ssm/default/types.json","Index":38},"AWS.SSM/PatchBaseline@default":{"RelativePath":"aws/aws.ssm/default/types.json","Index":56},"AWS.SSM/ResourceDataSync@default":{"RelativePath":"aws/aws.ssm/default/types.json","Index":64},"AWS.SSM/ResourcePolicy@default":{"RelativePath":"aws/aws.ssm/default/types.json","Index":69},"AWS.SSMContacts/Contact@default":{"RelativePath":"aws/aws.ssmcontacts/default/types.json","Index":17},"AWS.SSMContacts/ContactChannel@default":{"RelativePath":"aws/aws.ssmcontacts/default/types.json","Index":20},"AWS.SSMContacts/Plan@default":{"RelativePath":"aws/aws.ssmcontacts/default/types.json","Index":30},"AWS.SSMContacts/Rotation@default":{"RelativePath":"aws/aws.ssmcontacts/default/types.json","Index":49},"AWS.SSMIncidents/ReplicationSet@default":{"RelativePath":"aws/aws.ssmincidents/default/types.json","Index":20},"AWS.SSMIncidents/ResponsePlan@default":{"RelativePath":"aws/aws.ssmincidents/default/types.json","Index":51},"AWS.SSO/InstanceAccessControlAttributeConfiguration@default":{"RelativePath":"aws/aws.sso/default/types.json","Index":21},"AWS.SSO/PermissionSet@default":{"RelativePath":"aws/aws.sso/default/types.json","Index":33},"AWS.StepFunctions/Activity@default":{"RelativePath":"aws/aws.stepfunctions/default/types.json","Index":12},"AWS.StepFunctions/StateMachine@default":{"RelativePath":"aws/aws.stepfunctions/default/types.json","Index":25},"AWS.StepFunctions/StateMachineAlias@default":{"RelativePath":"aws/aws.stepfunctions/default/types.json","Index":34},"AWS.SupportApp/AccountAlias@default":{"RelativePath":"aws/aws.supportapp/default/types.json","Index":10},"AWS.SupportApp/SlackChannelConfiguration@default":{"RelativePath":"aws/aws.supportapp/default/types.json","Index":13},"AWS.SupportApp/SlackWorkspaceConfiguration@default":{"RelativePath":"aws/aws.supportapp/default/types.json","Index":16},"AWS.Synthetics/Canary@default":{"RelativePath":"aws/aws.synthetics/default/types.json","Index":25},"AWS.Synthetics/Group@default":{"RelativePath":"aws/aws.synthetics/default/types.json","Index":32},"AWS.SystemsManagerSAP/Application@default":{"RelativePath":"aws/aws.systemsmanagersap/default/types.json","Index":16},"AWS.Timestream/Database@default":{"RelativePath":"aws/aws.timestream/default/types.json","Index":12},"AWS.Timestream/ScheduledQuery@default":{"RelativePath":"aws/aws.timestream/default/types.json","Index":67},"AWS.Timestream/Table@default":{"RelativePath":"aws/aws.timestream/default/types.json","Index":84},"AWS.Transfer/Agreement@default":{"RelativePath":"aws/aws.transfer/default/types.json","Index":12},"AWS.Transfer/Certificate@default":{"RelativePath":"aws/aws.transfer/default/types.json","Index":17},"AWS.Transfer/Connector@default":{"RelativePath":"aws/aws.transfer/default/types.json","Index":26},"AWS.Transfer/Profile@default":{"RelativePath":"aws/aws.transfer/default/types.json","Index":33},"AWS.Transfer/Workflow@default":{"RelativePath":"aws/aws.transfer/default/types.json","Index":52},"AWS.VerifiedPermissions/IdentitySource@default":{"RelativePath":"aws/aws.verifiedpermissions/default/types.json","Index":16},"AWS.VerifiedPermissions/Policy@default":{"RelativePath":"aws/aws.verifiedpermissions/default/types.json","Index":24},"AWS.VerifiedPermissions/PolicyStore@default":{"RelativePath":"aws/aws.verifiedpermissions/default/types.json","Index":31},"AWS.VerifiedPermissions/PolicyTemplate@default":{"RelativePath":"aws/aws.verifiedpermissions/default/types.json","Index":34},"AWS.VoiceID/Domain@default":{"RelativePath":"aws/aws.voiceid/default/types.json","Index":13},"AWS.VpcLattice/AccessLogSubscription@default":{"RelativePath":"aws/aws.vpclattice/default/types.json","Index":12},"AWS.VpcLattice/AuthPolicy@default":{"RelativePath":"aws/aws.vpclattice/default/types.json","Index":16},"AWS.VpcLattice/Listener@default":{"RelativePath":"aws/aws.vpclattice/default/types.json","Index":26},"AWS.VpcLattice/ResourcePolicy@default":{"RelativePath":"aws/aws.vpclattice/default/types.json","Index":30},"AWS.VpcLattice/Rule@default":{"RelativePath":"aws/aws.vpclattice/default/types.json","Index":47},"AWS.VpcLattice/Service@default":{"RelativePath":"aws/aws.vpclattice/default/types.json","Index":53},"AWS.VpcLattice/ServiceNetwork@default":{"RelativePath":"aws/aws.vpclattice/default/types.json","Index":58},"AWS.VpcLattice/ServiceNetworkServiceAssociation@default":{"RelativePath":"aws/aws.vpclattice/default/types.json","Index":64},"AWS.VpcLattice/ServiceNetworkVpcAssociation@default":{"RelativePath":"aws/aws.vpclattice/default/types.json","Index":70},"AWS.VpcLattice/TargetGroup@default":{"RelativePath":"aws/aws.vpclattice/default/types.json","Index":80},"AWS.WAFv2/IPSet@default":{"RelativePath":"aws/aws.wafv2/default/types.json","Index":20},"AWS.WAFv2/LoggingConfiguration@default":{"RelativePath":"aws/aws.wafv2/default/types.json","Index":41},"AWS.WAFv2/RegexPatternSet@default":{"RelativePath":"aws/aws.wafv2/default/types.json","Index":47},"AWS.WAFv2/RuleGroup@default":{"RelativePath":"aws/aws.wafv2/default/types.json","Index":168},"AWS.WAFv2/WebACL@default":{"RelativePath":"aws/aws.wafv2/default/types.json","Index":338},"AWS.WAFv2/WebACLAssociation@default":{"RelativePath":"aws/aws.wafv2/default/types.json","Index":342},"AWS.Wisdom/Assistant@default":{"RelativePath":"aws/aws.wisdom/default/types.json","Index":14},"AWS.Wisdom/AssistantAssociation@default":{"RelativePath":"aws/aws.wisdom/default/types.json","Index":21},"AWS.Wisdom/KnowledgeBase@default":{"RelativePath":"aws/aws.wisdom/default/types.json","Index":32},"AWS.WorkSpacesThinClient/Environment@default":{"RelativePath":"aws/aws.workspacesthinclient/default/types.json","Index":17},"AWS.WorkSpacesWeb/BrowserSettings@default":{"RelativePath":"aws/aws.workspacesweb/default/types.json","Index":14},"AWS.WorkSpacesWeb/IdentityProvider@default":{"RelativePath":"aws/aws.workspacesweb/default/types.json","Index":19},"AWS.WorkSpacesWeb/IpAccessSettings@default":{"RelativePath":"aws/aws.workspacesweb/default/types.json","Index":28},"AWS.WorkSpacesWeb/NetworkSettings@default":{"RelativePath":"aws/aws.workspacesweb/default/types.json","Index":36},"AWS.WorkSpacesWeb/Portal@default":{"RelativePath":"aws/aws.workspacesweb/default/types.json","Index":46},"AWS.WorkSpacesWeb/TrustStore@default":{"RelativePath":"aws/aws.workspacesweb/default/types.json","Index":53},"AWS.WorkSpacesWeb/UserAccessLoggingSettings@default":{"RelativePath":"aws/aws.workspacesweb/default/types.json","Index":59},"AWS.WorkSpacesWeb/UserSettings@default":{"RelativePath":"aws/aws.workspacesweb/default/types.json","Index":71},"AWS.XRay/Group@default":{"RelativePath":"aws/aws.xray/default/types.json","Index":15},"AWS.XRay/ResourcePolicy@default":{"RelativePath":"aws/aws.xray/default/types.json","Index":18},"AWS.XRay/SamplingRule@default":{"RelativePath":"aws/aws.xray/default/types.json","Index":32}}} \ No newline at end of file +{ + "resources": { + "AWS.AccessAnalyzer/Analyzer@default": { + "$ref": "aws/aws.accessanalyzer/default/types.json#/17" + }, + "AWS.ACMPCA/CertificateAuthority@default": { + "$ref": "aws/aws.acmpca/default/types.json#/34" + }, + "AWS.ACMPCA/CertificateAuthorityActivation@default": { + "$ref": "aws/aws.acmpca/default/types.json#/38" + }, + "AWS.Amplify/App@default": { + "$ref": "aws/aws.amplify/default/types.json#/15" + }, + "AWS.Amplify/Branch@default": { + "$ref": "aws/aws.amplify/default/types.json#/25" + }, + "AWS.Amplify/Domain@default": { + "$ref": "aws/aws.amplify/default/types.json#/34" + }, + "AWS.AmplifyUIBuilder/Component@default": { + "$ref": "aws/aws.amplifyuibuilder/default/types.json#/38" + }, + "AWS.AmplifyUIBuilder/Form@default": { + "$ref": "aws/aws.amplifyuibuilder/default/types.json#/80" + }, + "AWS.AmplifyUIBuilder/Theme@default": { + "$ref": "aws/aws.amplifyuibuilder/default/types.json#/90" + }, + "AWS.ApiGateway/Account@default": { + "$ref": "aws/aws.apigateway/default/types.json#/4" + }, + "AWS.ApiGateway/ApiKey@default": { + "$ref": "aws/aws.apigateway/default/types.json#/13" + }, + "AWS.ApiGateway/Authorizer@default": { + "$ref": "aws/aws.apigateway/default/types.json#/19" + }, + "AWS.ApiGateway/BasePathMapping@default": { + "$ref": "aws/aws.apigateway/default/types.json#/23" + }, + "AWS.ApiGateway/ClientCertificate@default": { + "$ref": "aws/aws.apigateway/default/types.json#/29" + }, + "AWS.ApiGateway/Deployment@default": { + "$ref": "aws/aws.apigateway/default/types.json#/44" + }, + "AWS.ApiGateway/DocumentationPart@default": { + "$ref": "aws/aws.apigateway/default/types.json#/49" + }, + "AWS.ApiGateway/DocumentationVersion@default": { + "$ref": "aws/aws.apigateway/default/types.json#/53" + }, + "AWS.ApiGateway/DomainName@default": { + "$ref": "aws/aws.apigateway/default/types.json#/62" + }, + "AWS.ApiGateway/GatewayResponse@default": { + "$ref": "aws/aws.apigateway/default/types.json#/68" + }, + "AWS.ApiGateway/Method@default": { + "$ref": "aws/aws.apigateway/default/types.json#/87" + }, + "AWS.ApiGateway/Model@default": { + "$ref": "aws/aws.apigateway/default/types.json#/93" + }, + "AWS.ApiGateway/RequestValidator@default": { + "$ref": "aws/aws.apigateway/default/types.json#/97" + }, + "AWS.ApiGateway/Resource@default": { + "$ref": "aws/aws.apigateway/default/types.json#/101" + }, + "AWS.ApiGateway/RestApi@default": { + "$ref": "aws/aws.apigateway/default/types.json#/118" + }, + "AWS.ApiGateway/Stage@default": { + "$ref": "aws/aws.apigateway/default/types.json#/130" + }, + "AWS.ApiGateway/UsagePlan@default": { + "$ref": "aws/aws.apigateway/default/types.json#/141" + }, + "AWS.ApiGateway/VpcLink@default": { + "$ref": "aws/aws.apigateway/default/types.json#/148" + }, + "AWS.ApiGatewayV2/Api@default": { + "$ref": "aws/aws.apigatewayv2/default/types.json#/14" + }, + "AWS.ApiGatewayV2/ApiMapping@default": { + "$ref": "aws/aws.apigatewayv2/default/types.json#/18" + }, + "AWS.ApiGatewayV2/Authorizer@default": { + "$ref": "aws/aws.apigatewayv2/default/types.json#/25" + }, + "AWS.ApiGatewayV2/Deployment@default": { + "$ref": "aws/aws.apigatewayv2/default/types.json#/29" + }, + "AWS.ApiGatewayV2/DomainName@default": { + "$ref": "aws/aws.apigatewayv2/default/types.json#/37" + }, + "AWS.ApiGatewayV2/Integration@default": { + "$ref": "aws/aws.apigatewayv2/default/types.json#/45" + }, + "AWS.ApiGatewayV2/IntegrationResponse@default": { + "$ref": "aws/aws.apigatewayv2/default/types.json#/51" + }, + "AWS.ApiGatewayV2/Model@default": { + "$ref": "aws/aws.apigatewayv2/default/types.json#/56" + }, + "AWS.ApiGatewayV2/Route@default": { + "$ref": "aws/aws.apigatewayv2/default/types.json#/64" + }, + "AWS.ApiGatewayV2/RouteResponse@default": { + "$ref": "aws/aws.apigatewayv2/default/types.json#/71" + }, + "AWS.ApiGatewayV2/VpcLink@default": { + "$ref": "aws/aws.apigatewayv2/default/types.json#/78" + }, + "AWS.AppConfig/Application@default": { + "$ref": "aws/aws.appconfig/default/types.json#/6" + }, + "AWS.AppConfig/ConfigurationProfile@default": { + "$ref": "aws/aws.appconfig/default/types.json#/14" + }, + "AWS.AppConfig/Environment@default": { + "$ref": "aws/aws.appconfig/default/types.json#/22" + }, + "AWS.AppConfig/Extension@default": { + "$ref": "aws/aws.appconfig/default/types.json#/36" + }, + "AWS.AppConfig/ExtensionAssociation@default": { + "$ref": "aws/aws.appconfig/default/types.json#/43" + }, + "AWS.AppFlow/Connector@default": { + "$ref": "aws/aws.appflow/default/types.json#/6" + }, + "AWS.AppFlow/ConnectorProfile@default": { + "$ref": "aws/aws.appflow/default/types.json#/99" + }, + "AWS.AppFlow/Flow@default": { + "$ref": "aws/aws.appflow/default/types.json#/215" + }, + "AWS.AppIntegrations/Application@default": { + "$ref": "aws/aws.appintegrations/default/types.json#/12" + }, + "AWS.AppIntegrations/DataIntegration@default": { + "$ref": "aws/aws.appintegrations/default/types.json#/23" + }, + "AWS.AppIntegrations/EventIntegration@default": { + "$ref": "aws/aws.appintegrations/default/types.json#/31" + }, + "AWS.ApplicationAutoScaling/ScalableTarget@default": { + "$ref": "aws/aws.applicationautoscaling/default/types.json#/10" + }, + "AWS.ApplicationAutoScaling/ScalingPolicy@default": { + "$ref": "aws/aws.applicationautoscaling/default/types.json#/28" + }, + "AWS.ApplicationInsights/Application@default": { + "$ref": "aws/aws.applicationinsights/default/types.json#/45" + }, + "AWS.ApplicationSignals/ServiceLevelObjective@default": { + "$ref": "aws/aws.applicationsignals/default/types.json#/27" + }, + "AWS.AppRunner/Service@default": { + "$ref": "aws/aws.apprunner/default/types.json#/29" + }, + "AWS.AppRunner/VpcIngressConnection@default": { + "$ref": "aws/aws.apprunner/default/types.json#/36" + }, + "AWS.AppStream/AppBlockBuilder@default": { + "$ref": "aws/aws.appstream/default/types.json#/15" + }, + "AWS.AppStream/Application@default": { + "$ref": "aws/aws.appstream/default/types.json#/28" + }, + "AWS.AppStream/DirectoryConfig@default": { + "$ref": "aws/aws.appstream/default/types.json#/35" + }, + "AWS.AppStream/Entitlement@default": { + "$ref": "aws/aws.appstream/default/types.json#/41" + }, + "AWS.AppSync/DomainName@default": { + "$ref": "aws/aws.appsync/default/types.json#/4" + }, + "AWS.AppSync/DomainNameApiAssociation@default": { + "$ref": "aws/aws.appsync/default/types.json#/8" + }, + "AWS.AppSync/FunctionConfiguration@default": { + "$ref": "aws/aws.appsync/default/types.json#/16" + }, + "AWS.AppSync/Resolver@default": { + "$ref": "aws/aws.appsync/default/types.json#/27" + }, + "AWS.AppSync/SourceApiAssociation@default": { + "$ref": "aws/aws.appsync/default/types.json#/32" + }, + "AWS.APS/RuleGroupsNamespace@default": { + "$ref": "aws/aws.aps/default/types.json#/6" + }, + "AWS.APS/Scraper@default": { + "$ref": "aws/aws.aps/default/types.json#/21" + }, + "AWS.APS/Workspace@default": { + "$ref": "aws/aws.aps/default/types.json#/28" + }, + "AWS.ARCZonalShift/ZonalAutoshiftConfiguration@default": { + "$ref": "aws/aws.arczonalshift/default/types.json#/12" + }, + "AWS.Athena/CapacityReservation@default": { + "$ref": "aws/aws.athena/default/types.json#/18" + }, + "AWS.Athena/DataCatalog@default": { + "$ref": "aws/aws.athena/default/types.json#/27" + }, + "AWS.Athena/PreparedStatement@default": { + "$ref": "aws/aws.athena/default/types.json#/31" + }, + "AWS.Athena/WorkGroup@default": { + "$ref": "aws/aws.athena/default/types.json#/67" + }, + "AWS.AuditManager/Assessment@default": { + "$ref": "aws/aws.auditmanager/default/types.json#/36" + }, + "AWS.AutoScaling/AutoScalingGroup@default": { + "$ref": "aws/aws.autoscaling/default/types.json#/48" + }, + "AWS.AutoScaling/LifecycleHook@default": { + "$ref": "aws/aws.autoscaling/default/types.json#/52" + }, + "AWS.AutoScaling/ScalingPolicy@default": { + "$ref": "aws/aws.autoscaling/default/types.json#/82" + }, + "AWS.AutoScaling/ScheduledAction@default": { + "$ref": "aws/aws.autoscaling/default/types.json#/86" + }, + "AWS.AutoScaling/WarmPool@default": { + "$ref": "aws/aws.autoscaling/default/types.json#/91" + }, + "AWS.B2BI/Capability@default": { + "$ref": "aws/aws.b2bi/default/types.json#/16" + }, + "AWS.B2BI/Partnership@default": { + "$ref": "aws/aws.b2bi/default/types.json#/23" + }, + "AWS.B2BI/Profile@default": { + "$ref": "aws/aws.b2bi/default/types.json#/30" + }, + "AWS.B2BI/Transformer@default": { + "$ref": "aws/aws.b2bi/default/types.json#/42" + }, + "AWS.Backup/BackupPlan@default": { + "$ref": "aws/aws.backup/default/types.json#/17" + }, + "AWS.Backup/BackupVault@default": { + "$ref": "aws/aws.backup/default/types.json#/28" + }, + "AWS.Backup/Framework@default": { + "$ref": "aws/aws.backup/default/types.json#/42" + }, + "AWS.Backup/ReportPlan@default": { + "$ref": "aws/aws.backup/default/types.json#/55" + }, + "AWS.Backup/RestoreTestingPlan@default": { + "$ref": "aws/aws.backup/default/types.json#/67" + }, + "AWS.Backup/RestoreTestingSelection@default": { + "$ref": "aws/aws.backup/default/types.json#/77" + }, + "AWS.BackupGateway/Hypervisor@default": { + "$ref": "aws/aws.backupgateway/default/types.json#/8" + }, + "AWS.Batch/ComputeEnvironment@default": { + "$ref": "aws/aws.batch/default/types.json#/17" + }, + "AWS.Batch/JobQueue@default": { + "$ref": "aws/aws.batch/default/types.json#/27" + }, + "AWS.Batch/SchedulingPolicy@default": { + "$ref": "aws/aws.batch/default/types.json#/36" + }, + "AWS.Bedrock/Agent@default": { + "$ref": "aws/aws.bedrock/default/types.json#/36" + }, + "AWS.Bedrock/AgentAlias@default": { + "$ref": "aws/aws.bedrock/default/types.json#/47" + }, + "AWS.Bedrock/DataSource@default": { + "$ref": "aws/aws.bedrock/default/types.json#/63" + }, + "AWS.Bedrock/Guardrail@default": { + "$ref": "aws/aws.bedrock/default/types.json#/100" + }, + "AWS.Bedrock/KnowledgeBase@default": { + "$ref": "aws/aws.bedrock/default/types.json#/120" + }, + "AWS.Budgets/BudgetsAction@default": { + "$ref": "aws/aws.budgets/default/types.json#/19" + }, + "AWS.Cassandra/Keyspace@default": { + "$ref": "aws/aws.cassandra/default/types.json#/10" + }, + "AWS.Cassandra/Table@default": { + "$ref": "aws/aws.cassandra/default/types.json#/35" + }, + "AWS.CE/AnomalyMonitor@default": { + "$ref": "aws/aws.ce/default/types.json#/8" + }, + "AWS.CE/AnomalySubscription@default": { + "$ref": "aws/aws.ce/default/types.json#/18" + }, + "AWS.CE/CostCategory@default": { + "$ref": "aws/aws.ce/default/types.json#/23" + }, + "AWS.CertificateManager/Account@default": { + "$ref": "aws/aws.certificatemanager/default/types.json#/7" + }, + "AWS.Chatbot/MicrosoftTeamsChannelConfiguration@default": { + "$ref": "aws/aws.chatbot/default/types.json#/9" + }, + "AWS.Chatbot/SlackChannelConfiguration@default": { + "$ref": "aws/aws.chatbot/default/types.json#/17" + }, + "AWS.CleanRooms/AnalysisTemplate@default": { + "$ref": "aws/aws.cleanrooms/default/types.json#/14" + }, + "AWS.CleanRooms/Collaboration@default": { + "$ref": "aws/aws.cleanrooms/default/types.json#/34" + }, + "AWS.CleanRooms/ConfiguredTable@default": { + "$ref": "aws/aws.cleanrooms/default/types.json#/83" + }, + "AWS.CleanRooms/ConfiguredTableAssociation@default": { + "$ref": "aws/aws.cleanrooms/default/types.json#/89" + }, + "AWS.CleanRooms/Membership@default": { + "$ref": "aws/aws.cleanrooms/default/types.json#/103" + }, + "AWS.CleanRooms/PrivacyBudgetTemplate@default": { + "$ref": "aws/aws.cleanrooms/default/types.json#/110" + }, + "AWS.CleanRoomsML/TrainingDataset@default": { + "$ref": "aws/aws.cleanroomsml/default/types.json#/18" + }, + "AWS.CloudFormation/HookDefaultVersion@default": { + "$ref": "aws/aws.cloudformation/default/types.json#/4" + }, + "AWS.CloudFormation/HookTypeConfig@default": { + "$ref": "aws/aws.cloudformation/default/types.json#/8" + }, + "AWS.CloudFormation/ResourceDefaultVersion@default": { + "$ref": "aws/aws.cloudformation/default/types.json#/12" + }, + "AWS.CloudFormation/Stack@default": { + "$ref": "aws/aws.cloudformation/default/types.json#/27" + }, + "AWS.CloudFormation/StackSet@default": { + "$ref": "aws/aws.cloudformation/default/types.json#/53" + }, + "AWS.CloudFormation/TypeActivation@default": { + "$ref": "aws/aws.cloudformation/default/types.json#/58" + }, + "AWS.CloudFront/CachePolicy@default": { + "$ref": "aws/aws.cloudfront/default/types.json#/14" + }, + "AWS.CloudFront/CloudFrontOriginAccessIdentity@default": { + "$ref": "aws/aws.cloudfront/default/types.json#/19" + }, + "AWS.CloudFront/ContinuousDeploymentPolicy@default": { + "$ref": "aws/aws.cloudfront/default/types.json#/31" + }, + "AWS.CloudFront/Distribution@default": { + "$ref": "aws/aws.cloudfront/default/types.json#/89" + }, + "AWS.CloudFront/Function@default": { + "$ref": "aws/aws.cloudfront/default/types.json#/97" + }, + "AWS.CloudFront/KeyGroup@default": { + "$ref": "aws/aws.cloudfront/default/types.json#/103" + }, + "AWS.CloudFront/KeyValueStore@default": { + "$ref": "aws/aws.cloudfront/default/types.json#/108" + }, + "AWS.CloudFront/OriginAccessControl@default": { + "$ref": "aws/aws.cloudfront/default/types.json#/113" + }, + "AWS.CloudFront/OriginRequestPolicy@default": { + "$ref": "aws/aws.cloudfront/default/types.json#/124" + }, + "AWS.CloudFront/PublicKey@default": { + "$ref": "aws/aws.cloudfront/default/types.json#/129" + }, + "AWS.CloudFront/RealtimeLogConfig@default": { + "$ref": "aws/aws.cloudfront/default/types.json#/137" + }, + "AWS.CloudFront/ResponseHeadersPolicy@default": { + "$ref": "aws/aws.cloudfront/default/types.json#/165" + }, + "AWS.CloudTrail/Channel@default": { + "$ref": "aws/aws.cloudtrail/default/types.json#/12" + }, + "AWS.CloudTrail/EventDataStore@default": { + "$ref": "aws/aws.cloudtrail/default/types.json#/33" + }, + "AWS.CloudTrail/ResourcePolicy@default": { + "$ref": "aws/aws.cloudtrail/default/types.json#/39" + }, + "AWS.CloudTrail/Trail@default": { + "$ref": "aws/aws.cloudtrail/default/types.json#/63" + }, + "AWS.CloudWatch/Alarm@default": { + "$ref": "aws/aws.cloudwatch/default/types.json#/18" + }, + "AWS.CloudWatch/CompositeAlarm@default": { + "$ref": "aws/aws.cloudwatch/default/types.json#/28" + }, + "AWS.CloudWatch/MetricStream@default": { + "$ref": "aws/aws.cloudwatch/default/types.json#/43" + }, + "AWS.CodeArtifact/Domain@default": { + "$ref": "aws/aws.codeartifact/default/types.json#/7" + }, + "AWS.CodeArtifact/PackageGroup@default": { + "$ref": "aws/aws.codeartifact/default/types.json#/38" + }, + "AWS.CodeArtifact/Repository@default": { + "$ref": "aws/aws.codeartifact/default/types.json#/47" + }, + "AWS.CodeBuild/Fleet@default": { + "$ref": "aws/aws.codebuild/default/types.json#/10" + }, + "AWS.CodeConnections/Connection@default": { + "$ref": "aws/aws.codeconnections/default/types.json#/6" + }, + "AWS.CodeDeploy/Application@default": { + "$ref": "aws/aws.codedeploy/default/types.json#/6" + }, + "AWS.CodeGuruProfiler/ProfilingGroup@default": { + "$ref": "aws/aws.codeguruprofiler/default/types.json#/14" + }, + "AWS.CodePipeline/CustomActionType@default": { + "$ref": "aws/aws.codepipeline/default/types.json#/12" + }, + "AWS.CodeStarConnections/Connection@default": { + "$ref": "aws/aws.codestarconnections/default/types.json#/6" + }, + "AWS.CodeStarConnections/RepositoryLink@default": { + "$ref": "aws/aws.codestarconnections/default/types.json#/12" + }, + "AWS.CodeStarConnections/SyncConfiguration@default": { + "$ref": "aws/aws.codestarconnections/default/types.json#/16" + }, + "AWS.CodeStarNotifications/NotificationRule@default": { + "$ref": "aws/aws.codestarnotifications/default/types.json#/8" + }, + "AWS.Cognito/IdentityPool@default": { + "$ref": "aws/aws.cognito/default/types.json#/14" + }, + "AWS.Cognito/IdentityPoolPrincipalTag@default": { + "$ref": "aws/aws.cognito/default/types.json#/19" + }, + "AWS.Cognito/IdentityPoolRoleAttachment@default": { + "$ref": "aws/aws.cognito/default/types.json#/29" + }, + "AWS.Cognito/LogDeliveryConfiguration@default": { + "$ref": "aws/aws.cognito/default/types.json#/38" + }, + "AWS.Cognito/UserPool@default": { + "$ref": "aws/aws.cognito/default/types.json#/71" + }, + "AWS.Cognito/UserPoolClient@default": { + "$ref": "aws/aws.cognito/default/types.json#/85" + }, + "AWS.Cognito/UserPoolGroup@default": { + "$ref": "aws/aws.cognito/default/types.json#/89" + }, + "AWS.Cognito/UserPoolResourceServer@default": { + "$ref": "aws/aws.cognito/default/types.json#/95" + }, + "AWS.Cognito/UserPoolRiskConfigurationAttachment@default": { + "$ref": "aws/aws.cognito/default/types.json#/110" + }, + "AWS.Comprehend/DocumentClassifier@default": { + "$ref": "aws/aws.comprehend/default/types.json#/19" + }, + "AWS.Comprehend/Flywheel@default": { + "$ref": "aws/aws.comprehend/default/types.json#/36" + }, + "AWS.Config/AggregationAuthorization@default": { + "$ref": "aws/aws.config/default/types.json#/6" + }, + "AWS.Config/ConfigRule@default": { + "$ref": "aws/aws.config/default/types.json#/22" + }, + "AWS.Config/ConfigurationAggregator@default": { + "$ref": "aws/aws.config/default/types.json#/34" + }, + "AWS.Config/ConformancePack@default": { + "$ref": "aws/aws.config/default/types.json#/43" + }, + "AWS.Config/OrganizationConformancePack@default": { + "$ref": "aws/aws.config/default/types.json#/53" + }, + "AWS.Config/StoredQuery@default": { + "$ref": "aws/aws.config/default/types.json#/59" + }, + "AWS.Connect/ApprovedOrigin@default": { + "$ref": "aws/aws.connect/default/types.json#/6" + }, + "AWS.Connect/ContactFlow@default": { + "$ref": "aws/aws.connect/default/types.json#/12" + }, + "AWS.Connect/ContactFlowModule@default": { + "$ref": "aws/aws.connect/default/types.json#/18" + }, + "AWS.Connect/EvaluationForm@default": { + "$ref": "aws/aws.connect/default/types.json#/49" + }, + "AWS.Connect/HoursOfOperation@default": { + "$ref": "aws/aws.connect/default/types.json#/58" + }, + "AWS.Connect/Instance@default": { + "$ref": "aws/aws.connect/default/types.json#/72" + }, + "AWS.Connect/InstanceStorageConfig@default": { + "$ref": "aws/aws.connect/default/types.json#/91" + }, + "AWS.Connect/IntegrationAssociation@default": { + "$ref": "aws/aws.connect/default/types.json#/99" + }, + "AWS.Connect/PhoneNumber@default": { + "$ref": "aws/aws.connect/default/types.json#/105" + }, + "AWS.Connect/PredefinedAttribute@default": { + "$ref": "aws/aws.connect/default/types.json#/114" + }, + "AWS.Connect/Prompt@default": { + "$ref": "aws/aws.connect/default/types.json#/120" + }, + "AWS.Connect/Queue@default": { + "$ref": "aws/aws.connect/default/types.json#/134" + }, + "AWS.Connect/QuickConnect@default": { + "$ref": "aws/aws.connect/default/types.json#/149" + }, + "AWS.Connect/RoutingProfile@default": { + "$ref": "aws/aws.connect/default/types.json#/167" + }, + "AWS.Connect/Rule@default": { + "$ref": "aws/aws.connect/default/types.json#/220" + }, + "AWS.Connect/SecurityKey@default": { + "$ref": "aws/aws.connect/default/types.json#/227" + }, + "AWS.Connect/SecurityProfile@default": { + "$ref": "aws/aws.connect/default/types.json#/243" + }, + "AWS.Connect/TaskTemplate@default": { + "$ref": "aws/aws.connect/default/types.json#/273" + }, + "AWS.Connect/TrafficDistributionGroup@default": { + "$ref": "aws/aws.connect/default/types.json#/279" + }, + "AWS.Connect/User@default": { + "$ref": "aws/aws.connect/default/types.json#/303" + }, + "AWS.Connect/UserHierarchyGroup@default": { + "$ref": "aws/aws.connect/default/types.json#/310" + }, + "AWS.Connect/View@default": { + "$ref": "aws/aws.connect/default/types.json#/318" + }, + "AWS.Connect/ViewVersion@default": { + "$ref": "aws/aws.connect/default/types.json#/322" + }, + "AWS.ConnectCampaigns/Campaign@default": { + "$ref": "aws/aws.connectcampaigns/default/types.json#/14" + }, + "AWS.ControlTower/EnabledBaseline@default": { + "$ref": "aws/aws.controltower/default/types.json#/9" + }, + "AWS.ControlTower/EnabledControl@default": { + "$ref": "aws/aws.controltower/default/types.json#/18" + }, + "AWS.ControlTower/LandingZone@default": { + "$ref": "aws/aws.controltower/default/types.json#/27" + }, + "AWS.CustomerProfiles/CalculatedAttributeDefinition@default": { + "$ref": "aws/aws.customerprofiles/default/types.json#/29" + }, + "AWS.CustomerProfiles/Domain@default": { + "$ref": "aws/aws.customerprofiles/default/types.json#/58" + }, + "AWS.CustomerProfiles/EventStream@default": { + "$ref": "aws/aws.customerprofiles/default/types.json#/67" + }, + "AWS.CustomerProfiles/Integration@default": { + "$ref": "aws/aws.customerprofiles/default/types.json#/106" + }, + "AWS.CustomerProfiles/ObjectType@default": { + "$ref": "aws/aws.customerprofiles/default/types.json#/121" + }, + "AWS.DataBrew/Dataset@default": { + "$ref": "aws/aws.databrew/default/types.json#/29" + }, + "AWS.DataBrew/Job@default": { + "$ref": "aws/aws.databrew/default/types.json#/71" + }, + "AWS.DataBrew/Project@default": { + "$ref": "aws/aws.databrew/default/types.json#/78" + }, + "AWS.DataBrew/Recipe@default": { + "$ref": "aws/aws.databrew/default/types.json#/101" + }, + "AWS.DataBrew/Ruleset@default": { + "$ref": "aws/aws.databrew/default/types.json#/121" + }, + "AWS.DataBrew/Schedule@default": { + "$ref": "aws/aws.databrew/default/types.json#/129" + }, + "AWS.DataPipeline/Pipeline@default": { + "$ref": "aws/aws.datapipeline/default/types.json#/17" + }, + "AWS.DataSync/Agent@default": { + "$ref": "aws/aws.datasync/default/types.json#/8" + }, + "AWS.DataSync/LocationAzureBlob@default": { + "$ref": "aws/aws.datasync/default/types.json#/16" + }, + "AWS.DataSync/LocationEFS@default": { + "$ref": "aws/aws.datasync/default/types.json#/24" + }, + "AWS.DataSync/LocationFSxLustre@default": { + "$ref": "aws/aws.datasync/default/types.json#/31" + }, + "AWS.DataSync/LocationFSxONTAP@default": { + "$ref": "aws/aws.datasync/default/types.json#/43" + }, + "AWS.DataSync/LocationFSxOpenZFS@default": { + "$ref": "aws/aws.datasync/default/types.json#/53" + }, + "AWS.DataSync/LocationFSxWindows@default": { + "$ref": "aws/aws.datasync/default/types.json#/60" + }, + "AWS.DataSync/LocationHDFS@default": { + "$ref": "aws/aws.datasync/default/types.json#/71" + }, + "AWS.DataSync/LocationNFS@default": { + "$ref": "aws/aws.datasync/default/types.json#/80" + }, + "AWS.DataSync/LocationObjectStorage@default": { + "$ref": "aws/aws.datasync/default/types.json#/87" + }, + "AWS.DataSync/LocationS3@default": { + "$ref": "aws/aws.datasync/default/types.json#/94" + }, + "AWS.DataSync/LocationSMB@default": { + "$ref": "aws/aws.datasync/default/types.json#/102" + }, + "AWS.DataSync/StorageSystem@default": { + "$ref": "aws/aws.datasync/default/types.json#/111" + }, + "AWS.DataSync/Task@default": { + "$ref": "aws/aws.datasync/default/types.json#/139" + }, + "AWS.DataZone/DataSource@default": { + "$ref": "aws/aws.datazone/default/types.json#/34" + }, + "AWS.DataZone/Domain@default": { + "$ref": "aws/aws.datazone/default/types.json#/44" + }, + "AWS.DataZone/Environment@default": { + "$ref": "aws/aws.datazone/default/types.json#/52" + }, + "AWS.DataZone/EnvironmentBlueprintConfiguration@default": { + "$ref": "aws/aws.datazone/default/types.json#/60" + }, + "AWS.DataZone/EnvironmentProfile@default": { + "$ref": "aws/aws.datazone/default/types.json#/66" + }, + "AWS.DataZone/GroupProfile@default": { + "$ref": "aws/aws.datazone/default/types.json#/71" + }, + "AWS.DataZone/Project@default": { + "$ref": "aws/aws.datazone/default/types.json#/76" + }, + "AWS.DataZone/ProjectMembership@default": { + "$ref": "aws/aws.datazone/default/types.json#/83" + }, + "AWS.DataZone/SubscriptionTarget@default": { + "$ref": "aws/aws.datazone/default/types.json#/91" + }, + "AWS.DataZone/UserProfile@default": { + "$ref": "aws/aws.datazone/default/types.json#/101" + }, + "AWS.Deadline/Farm@default": { + "$ref": "aws/aws.deadline/default/types.json#/6" + }, + "AWS.Deadline/Fleet@default": { + "$ref": "aws/aws.deadline/default/types.json#/44" + }, + "AWS.Deadline/LicenseEndpoint@default": { + "$ref": "aws/aws.deadline/default/types.json#/53" + }, + "AWS.Deadline/Monitor@default": { + "$ref": "aws/aws.deadline/default/types.json#/57" + }, + "AWS.Deadline/Queue@default": { + "$ref": "aws/aws.deadline/default/types.json#/71" + }, + "AWS.Deadline/QueueEnvironment@default": { + "$ref": "aws/aws.deadline/default/types.json#/76" + }, + "AWS.Deadline/StorageProfile@default": { + "$ref": "aws/aws.deadline/default/types.json#/84" + }, + "AWS.Detective/Graph@default": { + "$ref": "aws/aws.detective/default/types.json#/7" + }, + "AWS.Detective/MemberInvitation@default": { + "$ref": "aws/aws.detective/default/types.json#/11" + }, + "AWS.Detective/OrganizationAdmin@default": { + "$ref": "aws/aws.detective/default/types.json#/15" + }, + "AWS.DeviceFarm/DevicePool@default": { + "$ref": "aws/aws.devicefarm/default/types.json#/9" + }, + "AWS.DeviceFarm/InstanceProfile@default": { + "$ref": "aws/aws.devicefarm/default/types.json#/17" + }, + "AWS.DeviceFarm/NetworkProfile@default": { + "$ref": "aws/aws.devicefarm/default/types.json#/23" + }, + "AWS.DeviceFarm/Project@default": { + "$ref": "aws/aws.devicefarm/default/types.json#/32" + }, + "AWS.DeviceFarm/TestGridProject@default": { + "$ref": "aws/aws.devicefarm/default/types.json#/41" + }, + "AWS.DeviceFarm/VPCEConfiguration@default": { + "$ref": "aws/aws.devicefarm/default/types.json#/47" + }, + "AWS.DevOpsGuru/LogAnomalyDetectionIntegration@default": { + "$ref": "aws/aws.devopsguru/default/types.json#/5" + }, + "AWS.DevOpsGuru/ResourceCollection@default": { + "$ref": "aws/aws.devopsguru/default/types.json#/17" + }, + "AWS.DirectoryService/SimpleAD@default": { + "$ref": "aws/aws.directoryservice/default/types.json#/8" + }, + "AWS.DMS/DataProvider@default": { + "$ref": "aws/aws.dms/default/types.json#/18" + }, + "AWS.DMS/InstanceProfile@default": { + "$ref": "aws/aws.dms/default/types.json#/25" + }, + "AWS.DMS/MigrationProject@default": { + "$ref": "aws/aws.dms/default/types.json#/35" + }, + "AWS.DMS/ReplicationConfig@default": { + "$ref": "aws/aws.dms/default/types.json#/46" + }, + "AWS.DocDBElastic/Cluster@default": { + "$ref": "aws/aws.docdbelastic/default/types.json#/9" + }, + "AWS.DynamoDB/GlobalTable@default": { + "$ref": "aws/aws.dynamodb/default/types.json#/40" + }, + "AWS.DynamoDB/Table@default": { + "$ref": "aws/aws.dynamodb/default/types.json#/75" + }, + "AWS.EC2/CapacityReservation@default": { + "$ref": "aws/aws.ec2/default/types.json#/10" + }, + "AWS.EC2/CapacityReservationFleet@default": { + "$ref": "aws/aws.ec2/default/types.json#/20" + }, + "AWS.EC2/CarrierGateway@default": { + "$ref": "aws/aws.ec2/default/types.json#/28" + }, + "AWS.EC2/CustomerGateway@default": { + "$ref": "aws/aws.ec2/default/types.json#/34" + }, + "AWS.EC2/DHCPOptions@default": { + "$ref": "aws/aws.ec2/default/types.json#/43" + }, + "AWS.EC2/EC2Fleet@default": { + "$ref": "aws/aws.ec2/default/types.json#/81" + }, + "AWS.EC2/EIP@default": { + "$ref": "aws/aws.ec2/default/types.json#/87" + }, + "AWS.EC2/FlowLog@default": { + "$ref": "aws/aws.ec2/default/types.json#/94" + }, + "AWS.EC2/GatewayRouteTableAssociation@default": { + "$ref": "aws/aws.ec2/default/types.json#/98" + }, + "AWS.EC2/Host@default": { + "$ref": "aws/aws.ec2/default/types.json#/102" + }, + "AWS.EC2/IPAM@default": { + "$ref": "aws/aws.ec2/default/types.json#/110" + }, + "AWS.EC2/IPAMPool@default": { + "$ref": "aws/aws.ec2/default/types.json#/121" + }, + "AWS.EC2/IPAMResourceDiscovery@default": { + "$ref": "aws/aws.ec2/default/types.json#/129" + }, + "AWS.EC2/IPAMResourceDiscoveryAssociation@default": { + "$ref": "aws/aws.ec2/default/types.json#/135" + }, + "AWS.EC2/IPAMScope@default": { + "$ref": "aws/aws.ec2/default/types.json#/141" + }, + "AWS.EC2/Instance@default": { + "$ref": "aws/aws.ec2/default/types.json#/184" + }, + "AWS.EC2/InstanceConnectEndpoint@default": { + "$ref": "aws/aws.ec2/default/types.json#/192" + }, + "AWS.EC2/InternetGateway@default": { + "$ref": "aws/aws.ec2/default/types.json#/198" + }, + "AWS.EC2/LaunchTemplate@default": { + "$ref": "aws/aws.ec2/default/types.json#/267" + }, + "AWS.EC2/LocalGatewayRoute@default": { + "$ref": "aws/aws.ec2/default/types.json#/271" + }, + "AWS.EC2/LocalGatewayRouteTable@default": { + "$ref": "aws/aws.ec2/default/types.json#/279" + }, + "AWS.EC2/LocalGatewayRouteTableVPCAssociation@default": { + "$ref": "aws/aws.ec2/default/types.json#/287" + }, + "AWS.EC2/LocalGatewayRouteTableVirtualInterfaceGroupAssociation@default": { + "$ref": "aws/aws.ec2/default/types.json#/295" + }, + "AWS.EC2/NatGateway@default": { + "$ref": "aws/aws.ec2/default/types.json#/303" + }, + "AWS.EC2/NetworkAcl@default": { + "$ref": "aws/aws.ec2/default/types.json#/309" + }, + "AWS.EC2/NetworkInsightsAccessScope@default": { + "$ref": "aws/aws.ec2/default/types.json#/333" + }, + "AWS.EC2/NetworkInsightsAccessScopeAnalysis@default": { + "$ref": "aws/aws.ec2/default/types.json#/339" + }, + "AWS.EC2/NetworkInsightsAnalysis@default": { + "$ref": "aws/aws.ec2/default/types.json#/385" + }, + "AWS.EC2/NetworkInsightsPath@default": { + "$ref": "aws/aws.ec2/default/types.json#/398" + }, + "AWS.EC2/NetworkInterface@default": { + "$ref": "aws/aws.ec2/default/types.json#/415" + }, + "AWS.EC2/NetworkInterfaceAttachment@default": { + "$ref": "aws/aws.ec2/default/types.json#/421" + }, + "AWS.EC2/PrefixList@default": { + "$ref": "aws/aws.ec2/default/types.json#/429" + }, + "AWS.EC2/Route@default": { + "$ref": "aws/aws.ec2/default/types.json#/433" + }, + "AWS.EC2/RouteTable@default": { + "$ref": "aws/aws.ec2/default/types.json#/439" + }, + "AWS.EC2/SecurityGroup@default": { + "$ref": "aws/aws.ec2/default/types.json#/449" + }, + "AWS.EC2/SecurityGroupEgress@default": { + "$ref": "aws/aws.ec2/default/types.json#/453" + }, + "AWS.EC2/SecurityGroupIngress@default": { + "$ref": "aws/aws.ec2/default/types.json#/457" + }, + "AWS.EC2/SnapshotBlockPublicAccess@default": { + "$ref": "aws/aws.ec2/default/types.json#/461" + }, + "AWS.EC2/SpotFleet@default": { + "$ref": "aws/aws.ec2/default/types.json#/520" + }, + "AWS.EC2/Subnet@default": { + "$ref": "aws/aws.ec2/default/types.json#/528" + }, + "AWS.EC2/TransitGateway@default": { + "$ref": "aws/aws.ec2/default/types.json#/535" + }, + "AWS.EC2/TransitGatewayAttachment@default": { + "$ref": "aws/aws.ec2/default/types.json#/543" + }, + "AWS.EC2/TransitGatewayConnect@default": { + "$ref": "aws/aws.ec2/default/types.json#/550" + }, + "AWS.EC2/TransitGatewayMulticastDomain@default": { + "$ref": "aws/aws.ec2/default/types.json#/557" + }, + "AWS.EC2/TransitGatewayPeeringAttachment@default": { + "$ref": "aws/aws.ec2/default/types.json#/564" + }, + "AWS.EC2/TransitGatewayVpcAttachment@default": { + "$ref": "aws/aws.ec2/default/types.json#/574" + }, + "AWS.EC2/VPC@default": { + "$ref": "aws/aws.ec2/default/types.json#/582" + }, + "AWS.EC2/VPCDHCPOptionsAssociation@default": { + "$ref": "aws/aws.ec2/default/types.json#/586" + }, + "AWS.EC2/VPCEndpoint@default": { + "$ref": "aws/aws.ec2/default/types.json#/597" + }, + "AWS.EC2/VPCEndpointConnectionNotification@default": { + "$ref": "aws/aws.ec2/default/types.json#/602" + }, + "AWS.EC2/VPCEndpointService@default": { + "$ref": "aws/aws.ec2/default/types.json#/608" + }, + "AWS.EC2/VPCEndpointServicePermissions@default": { + "$ref": "aws/aws.ec2/default/types.json#/613" + }, + "AWS.EC2/VPCGatewayAttachment@default": { + "$ref": "aws/aws.ec2/default/types.json#/617" + }, + "AWS.EC2/VPCPeeringConnection@default": { + "$ref": "aws/aws.ec2/default/types.json#/623" + }, + "AWS.EC2/VPNConnection@default": { + "$ref": "aws/aws.ec2/default/types.json#/631" + }, + "AWS.EC2/VPNGateway@default": { + "$ref": "aws/aws.ec2/default/types.json#/637" + }, + "AWS.EC2/VerifiedAccessEndpoint@default": { + "$ref": "aws/aws.ec2/default/types.json#/650" + }, + "AWS.EC2/VerifiedAccessGroup@default": { + "$ref": "aws/aws.ec2/default/types.json#/657" + }, + "AWS.EC2/VerifiedAccessInstance@default": { + "$ref": "aws/aws.ec2/default/types.json#/671" + }, + "AWS.EC2/VerifiedAccessTrustProvider@default": { + "$ref": "aws/aws.ec2/default/types.json#/681" + }, + "AWS.EC2/Volume@default": { + "$ref": "aws/aws.ec2/default/types.json#/687" + }, + "AWS.ECR/PullThroughCacheRule@default": { + "$ref": "aws/aws.ecr/default/types.json#/10" + }, + "AWS.ECR/RegistryPolicy@default": { + "$ref": "aws/aws.ecr/default/types.json#/16" + }, + "AWS.ECR/ReplicationConfiguration@default": { + "$ref": "aws/aws.ecr/default/types.json#/31" + }, + "AWS.ECR/Repository@default": { + "$ref": "aws/aws.ecr/default/types.json#/49" + }, + "AWS.ECR/RepositoryCreationTemplate@default": { + "$ref": "aws/aws.ecr/default/types.json#/60" + }, + "AWS.ECS/CapacityProvider@default": { + "$ref": "aws/aws.ecs/default/types.json#/9" + }, + "AWS.ECS/Cluster@default": { + "$ref": "aws/aws.ecs/default/types.json#/26" + }, + "AWS.ECS/ClusterCapacityProviderAssociations@default": { + "$ref": "aws/aws.ecs/default/types.json#/39" + }, + "AWS.ECS/PrimaryTaskSet@default": { + "$ref": "aws/aws.ecs/default/types.json#/43" + }, + "AWS.ECS/Service@default": { + "$ref": "aws/aws.ecs/default/types.json#/86" + }, + "AWS.ECS/TaskDefinition@default": { + "$ref": "aws/aws.ecs/default/types.json#/161" + }, + "AWS.ECS/TaskSet@default": { + "$ref": "aws/aws.ecs/default/types.json#/176" + }, + "AWS.EFS/AccessPoint@default": { + "$ref": "aws/aws.efs/default/types.json#/10" + }, + "AWS.EFS/FileSystem@default": { + "$ref": "aws/aws.efs/default/types.json#/27" + }, + "AWS.EFS/MountTarget@default": { + "$ref": "aws/aws.efs/default/types.json#/32" + }, + "AWS.EKS/AccessEntry@default": { + "$ref": "aws/aws.eks/default/types.json#/11" + }, + "AWS.EKS/Addon@default": { + "$ref": "aws/aws.eks/default/types.json#/20" + }, + "AWS.EKS/Cluster@default": { + "$ref": "aws/aws.eks/default/types.json#/45" + }, + "AWS.EKS/FargateProfile@default": { + "$ref": "aws/aws.eks/default/types.json#/56" + }, + "AWS.EKS/IdentityProviderConfig@default": { + "$ref": "aws/aws.eks/default/types.json#/65" + }, + "AWS.EKS/Nodegroup@default": { + "$ref": "aws/aws.eks/default/types.json#/81" + }, + "AWS.EKS/PodIdentityAssociation@default": { + "$ref": "aws/aws.eks/default/types.json#/87" + }, + "AWS.ElastiCache/GlobalReplicationGroup@default": { + "$ref": "aws/aws.elasticache/default/types.json#/13" + }, + "AWS.ElastiCache/ParameterGroup@default": { + "$ref": "aws/aws.elasticache/default/types.json#/20" + }, + "AWS.ElastiCache/ServerlessCache@default": { + "$ref": "aws/aws.elasticache/default/types.json#/33" + }, + "AWS.ElastiCache/SubnetGroup@default": { + "$ref": "aws/aws.elasticache/default/types.json#/40" + }, + "AWS.ElastiCache/User@default": { + "$ref": "aws/aws.elasticache/default/types.json#/49" + }, + "AWS.ElastiCache/UserGroup@default": { + "$ref": "aws/aws.elasticache/default/types.json#/56" + }, + "AWS.ElasticBeanstalk/Application@default": { + "$ref": "aws/aws.elasticbeanstalk/default/types.json#/10" + }, + "AWS.ElasticBeanstalk/ApplicationVersion@default": { + "$ref": "aws/aws.elasticbeanstalk/default/types.json#/15" + }, + "AWS.ElasticBeanstalk/ConfigurationTemplate@default": { + "$ref": "aws/aws.elasticbeanstalk/default/types.json#/22" + }, + "AWS.ElasticBeanstalk/Environment@default": { + "$ref": "aws/aws.elasticbeanstalk/default/types.json#/31" + }, + "AWS.ElasticLoadBalancingV2/Listener@default": { + "$ref": "aws/aws.elasticloadbalancingv2/default/types.json#/22" + }, + "AWS.ElasticLoadBalancingV2/ListenerRule@default": { + "$ref": "aws/aws.elasticloadbalancingv2/default/types.json#/54" + }, + "AWS.ElasticLoadBalancingV2/LoadBalancer@default": { + "$ref": "aws/aws.elasticloadbalancingv2/default/types.json#/66" + }, + "AWS.ElasticLoadBalancingV2/TargetGroup@default": { + "$ref": "aws/aws.elasticloadbalancingv2/default/types.json#/78" + }, + "AWS.ElasticLoadBalancingV2/TrustStore@default": { + "$ref": "aws/aws.elasticloadbalancingv2/default/types.json#/84" + }, + "AWS.EMR/Studio@default": { + "$ref": "aws/aws.emr/default/types.json#/12" + }, + "AWS.EMR/StudioSessionMapping@default": { + "$ref": "aws/aws.emr/default/types.json#/17" + }, + "AWS.EMR/WALWorkspace@default": { + "$ref": "aws/aws.emr/default/types.json#/23" + }, + "AWS.EMRContainers/VirtualCluster@default": { + "$ref": "aws/aws.emrcontainers/default/types.json#/9" + }, + "AWS.EMRServerless/Application@default": { + "$ref": "aws/aws.emrserverless/default/types.json#/55" + }, + "AWS.EntityResolution/IdMappingWorkflow@default": { + "$ref": "aws/aws.entityresolution/default/types.json#/22" + }, + "AWS.EntityResolution/IdNamespace@default": { + "$ref": "aws/aws.entityresolution/default/types.json#/36" + }, + "AWS.EntityResolution/MatchingWorkflow@default": { + "$ref": "aws/aws.entityresolution/default/types.json#/65" + }, + "AWS.EntityResolution/PolicyStatement@default": { + "$ref": "aws/aws.entityresolution/default/types.json#/81" + }, + "AWS.EntityResolution/SchemaMapping@default": { + "$ref": "aws/aws.entityresolution/default/types.json#/99" + }, + "AWS.Events/ApiDestination@default": { + "$ref": "aws/aws.events/default/types.json#/5" + }, + "AWS.Events/Archive@default": { + "$ref": "aws/aws.events/default/types.json#/10" + }, + "AWS.Events/Connection@default": { + "$ref": "aws/aws.events/default/types.json#/25" + }, + "AWS.Events/Endpoint@default": { + "$ref": "aws/aws.events/default/types.json#/42" + }, + "AWS.Events/EventBus@default": { + "$ref": "aws/aws.events/default/types.json#/51" + }, + "AWS.Events/Rule@default": { + "$ref": "aws/aws.events/default/types.json#/95" + }, + "AWS.EventSchemas/Discoverer@default": { + "$ref": "aws/aws.eventschemas/default/types.json#/7" + }, + "AWS.EventSchemas/Registry@default": { + "$ref": "aws/aws.eventschemas/default/types.json#/13" + }, + "AWS.EventSchemas/RegistryPolicy@default": { + "$ref": "aws/aws.eventschemas/default/types.json#/18" + }, + "AWS.EventSchemas/Schema@default": { + "$ref": "aws/aws.eventschemas/default/types.json#/24" + }, + "AWS.Evidently/Experiment@default": { + "$ref": "aws/aws.evidently/default/types.json#/16" + }, + "AWS.Evidently/Feature@default": { + "$ref": "aws/aws.evidently/default/types.json#/26" + }, + "AWS.Evidently/Launch@default": { + "$ref": "aws/aws.evidently/default/types.json#/44" + }, + "AWS.Evidently/Project@default": { + "$ref": "aws/aws.evidently/default/types.json#/53" + }, + "AWS.FinSpace/Environment@default": { + "$ref": "aws/aws.finspace/default/types.json#/12" + }, + "AWS.FIS/ExperimentTemplate@default": { + "$ref": "aws/aws.fis/default/types.json#/50" + }, + "AWS.FIS/TargetAccountConfiguration@default": { + "$ref": "aws/aws.fis/default/types.json#/58" + }, + "AWS.FMS/NotificationChannel@default": { + "$ref": "aws/aws.fms/default/types.json#/5" + }, + "AWS.FMS/Policy@default": { + "$ref": "aws/aws.fms/default/types.json#/41" + }, + "AWS.FMS/ResourceSet@default": { + "$ref": "aws/aws.fms/default/types.json#/52" + }, + "AWS.Forecast/DatasetGroup@default": { + "$ref": "aws/aws.forecast/default/types.json#/11" + }, + "AWS.FraudDetector/Detector@default": { + "$ref": "aws/aws.frauddetector/default/types.json#/26" + }, + "AWS.FraudDetector/EntityType@default": { + "$ref": "aws/aws.frauddetector/default/types.json#/32" + }, + "AWS.FraudDetector/EventType@default": { + "$ref": "aws/aws.frauddetector/default/types.json#/47" + }, + "AWS.FraudDetector/Label@default": { + "$ref": "aws/aws.frauddetector/default/types.json#/53" + }, + "AWS.FraudDetector/List@default": { + "$ref": "aws/aws.frauddetector/default/types.json#/61" + }, + "AWS.FraudDetector/Outcome@default": { + "$ref": "aws/aws.frauddetector/default/types.json#/67" + }, + "AWS.FraudDetector/Variable@default": { + "$ref": "aws/aws.frauddetector/default/types.json#/73" + }, + "AWS.FSx/DataRepositoryAssociation@default": { + "$ref": "aws/aws.fsx/default/types.json#/16" + }, + "AWS.GameLift/Alias@default": { + "$ref": "aws/aws.gamelift/default/types.json#/5" + }, + "AWS.GameLift/Build@default": { + "$ref": "aws/aws.gamelift/default/types.json#/10" + }, + "AWS.GameLift/ContainerGroupDefinition@default": { + "$ref": "aws/aws.gamelift/default/types.json#/32" + }, + "AWS.GameLift/Fleet@default": { + "$ref": "aws/aws.gamelift/default/types.json#/57" + }, + "AWS.GameLift/GameServerGroup@default": { + "$ref": "aws/aws.gamelift/default/types.json#/100" + }, + "AWS.GameLift/GameSessionQueue@default": { + "$ref": "aws/aws.gamelift/default/types.json#/126" + }, + "AWS.GameLift/Location@default": { + "$ref": "aws/aws.gamelift/default/types.json#/132" + }, + "AWS.GameLift/MatchmakingConfiguration@default": { + "$ref": "aws/aws.gamelift/default/types.json#/141" + }, + "AWS.GameLift/MatchmakingRuleSet@default": { + "$ref": "aws/aws.gamelift/default/types.json#/147" + }, + "AWS.GameLift/Script@default": { + "$ref": "aws/aws.gamelift/default/types.json#/155" + }, + "AWS.GlobalAccelerator/Accelerator@default": { + "$ref": "aws/aws.globalaccelerator/default/types.json#/11" + }, + "AWS.GlobalAccelerator/CrossAccountAttachment@default": { + "$ref": "aws/aws.globalaccelerator/default/types.json#/20" + }, + "AWS.GlobalAccelerator/EndpointGroup@default": { + "$ref": "aws/aws.globalaccelerator/default/types.json#/30" + }, + "AWS.GlobalAccelerator/Listener@default": { + "$ref": "aws/aws.globalaccelerator/default/types.json#/37" + }, + "AWS.Glue/Registry@default": { + "$ref": "aws/aws.glue/default/types.json#/6" + }, + "AWS.Glue/Schema@default": { + "$ref": "aws/aws.glue/default/types.json#/16" + }, + "AWS.Grafana/Workspace@default": { + "$ref": "aws/aws.grafana/default/types.json#/30" + }, + "AWS.GreengrassV2/ComponentVersion@default": { + "$ref": "aws/aws.greengrassv2/default/types.json#/27" + }, + "AWS.GreengrassV2/Deployment@default": { + "$ref": "aws/aws.greengrassv2/default/types.json#/50" + }, + "AWS.GroundStation/Config@default": { + "$ref": "aws/aws.groundstation/default/types.json#/31" + }, + "AWS.GroundStation/MissionProfile@default": { + "$ref": "aws/aws.groundstation/default/types.json#/40" + }, + "AWS.GuardDuty/Detector@default": { + "$ref": "aws/aws.guardduty/default/types.json#/17" + }, + "AWS.GuardDuty/Filter@default": { + "$ref": "aws/aws.guardduty/default/types.json#/31" + }, + "AWS.GuardDuty/IPSet@default": { + "$ref": "aws/aws.guardduty/default/types.json#/37" + }, + "AWS.GuardDuty/MalwareProtectionPlan@default": { + "$ref": "aws/aws.guardduty/default/types.json#/50" + }, + "AWS.GuardDuty/Member@default": { + "$ref": "aws/aws.guardduty/default/types.json#/54" + }, + "AWS.GuardDuty/ThreatIntelSet@default": { + "$ref": "aws/aws.guardduty/default/types.json#/60" + }, + "AWS.HealthLake/FHIRDatastore@default": { + "$ref": "aws/aws.healthlake/default/types.json#/19" + }, + "AWS.IAM/Group@default": { + "$ref": "aws/aws.iam/default/types.json#/9" + }, + "AWS.IAM/GroupPolicy@default": { + "$ref": "aws/aws.iam/default/types.json#/14" + }, + "AWS.IAM/InstanceProfile@default": { + "$ref": "aws/aws.iam/default/types.json#/19" + }, + "AWS.IAM/ManagedPolicy@default": { + "$ref": "aws/aws.iam/default/types.json#/30" + }, + "AWS.IAM/OIDCProvider@default": { + "$ref": "aws/aws.iam/default/types.json#/38" + }, + "AWS.IAM/Role@default": { + "$ref": "aws/aws.iam/default/types.json#/51" + }, + "AWS.IAM/RolePolicy@default": { + "$ref": "aws/aws.iam/default/types.json#/56" + }, + "AWS.IAM/SAMLProvider@default": { + "$ref": "aws/aws.iam/default/types.json#/62" + }, + "AWS.IAM/ServerCertificate@default": { + "$ref": "aws/aws.iam/default/types.json#/68" + }, + "AWS.IAM/ServiceLinkedRole@default": { + "$ref": "aws/aws.iam/default/types.json#/72" + }, + "AWS.IAM/User@default": { + "$ref": "aws/aws.iam/default/types.json#/85" + }, + "AWS.IAM/UserPolicy@default": { + "$ref": "aws/aws.iam/default/types.json#/90" + }, + "AWS.IAM/VirtualMFADevice@default": { + "$ref": "aws/aws.iam/default/types.json#/97" + }, + "AWS.IdentityStore/Group@default": { + "$ref": "aws/aws.identitystore/default/types.json#/4" + }, + "AWS.ImageBuilder/DistributionConfiguration@default": { + "$ref": "aws/aws.imagebuilder/default/types.json#/28" + }, + "AWS.ImageBuilder/ImagePipeline@default": { + "$ref": "aws/aws.imagebuilder/default/types.json#/44" + }, + "AWS.ImageBuilder/InfrastructureConfiguration@default": { + "$ref": "aws/aws.imagebuilder/default/types.json#/56" + }, + "AWS.ImageBuilder/LifecyclePolicy@default": { + "$ref": "aws/aws.imagebuilder/default/types.json#/78" + }, + "AWS.Inspector/AssessmentTarget@default": { + "$ref": "aws/aws.inspector/default/types.json#/4" + }, + "AWS.InspectorV2/CisScanConfiguration@default": { + "$ref": "aws/aws.inspectorv2/default/types.json#/22" + }, + "AWS.InspectorV2/Filter@default": { + "$ref": "aws/aws.inspectorv2/default/types.json#/85" + }, + "AWS.InternetMonitor/Monitor@default": { + "$ref": "aws/aws.internetmonitor/default/types.json#/18" + }, + "AWS.IoT/AccountAuditConfiguration@default": { + "$ref": "aws/aws.iot/default/types.json#/9" + }, + "AWS.IoT/Authorizer@default": { + "$ref": "aws/aws.iot/default/types.json#/16" + }, + "AWS.IoT/BillingGroup@default": { + "$ref": "aws/aws.iot/default/types.json#/23" + }, + "AWS.IoT/CACertificate@default": { + "$ref": "aws/aws.iot/default/types.json#/30" + }, + "AWS.IoT/Certificate@default": { + "$ref": "aws/aws.iot/default/types.json#/34" + }, + "AWS.IoT/CertificateProvider@default": { + "$ref": "aws/aws.iot/default/types.json#/42" + }, + "AWS.IoT/CustomMetric@default": { + "$ref": "aws/aws.iot/default/types.json#/48" + }, + "AWS.IoT/Dimension@default": { + "$ref": "aws/aws.iot/default/types.json#/55" + }, + "AWS.IoT/DomainConfiguration@default": { + "$ref": "aws/aws.iot/default/types.json#/67" + }, + "AWS.IoT/FleetMetric@default": { + "$ref": "aws/aws.iot/default/types.json#/77" + }, + "AWS.IoT/Logging@default": { + "$ref": "aws/aws.iot/default/types.json#/81" + }, + "AWS.IoT/MitigationAction@default": { + "$ref": "aws/aws.iot/default/types.json#/95" + }, + "AWS.IoT/Policy@default": { + "$ref": "aws/aws.iot/default/types.json#/103" + }, + "AWS.IoT/ProvisioningTemplate@default": { + "$ref": "aws/aws.iot/default/types.json#/110" + }, + "AWS.IoT/ResourceSpecificLogging@default": { + "$ref": "aws/aws.iot/default/types.json#/114" + }, + "AWS.IoT/RoleAlias@default": { + "$ref": "aws/aws.iot/default/types.json#/120" + }, + "AWS.IoT/ScheduledAudit@default": { + "$ref": "aws/aws.iot/default/types.json#/127" + }, + "AWS.IoT/SecurityProfile@default": { + "$ref": "aws/aws.iot/default/types.json#/151" + }, + "AWS.IoT/SoftwarePackage@default": { + "$ref": "aws/aws.iot/default/types.json#/157" + }, + "AWS.IoT/SoftwarePackageVersion@default": { + "$ref": "aws/aws.iot/default/types.json#/165" + }, + "AWS.IoT/Thing@default": { + "$ref": "aws/aws.iot/default/types.json#/171" + }, + "AWS.IoT/ThingGroup@default": { + "$ref": "aws/aws.iot/default/types.json#/180" + }, + "AWS.IoT/ThingType@default": { + "$ref": "aws/aws.iot/default/types.json#/188" + }, + "AWS.IoT/TopicRule@default": { + "$ref": "aws/aws.iot/default/types.json#/246" + }, + "AWS.IoT/TopicRuleDestination@default": { + "$ref": "aws/aws.iot/default/types.json#/255" + }, + "AWS.IoTAnalytics/Channel@default": { + "$ref": "aws/aws.iotanalytics/default/types.json#/12" + }, + "AWS.IoTAnalytics/Dataset@default": { + "$ref": "aws/aws.iotanalytics/default/types.json#/46" + }, + "AWS.IoTAnalytics/Datastore@default": { + "$ref": "aws/aws.iotanalytics/default/types.json#/69" + }, + "AWS.IoTAnalytics/Pipeline@default": { + "$ref": "aws/aws.iotanalytics/default/types.json#/90" + }, + "AWS.IoTCoreDeviceAdvisor/SuiteDefinition@default": { + "$ref": "aws/aws.iotcoredeviceadvisor/default/types.json#/16" + }, + "AWS.IoTEvents/AlarmModel@default": { + "$ref": "aws/aws.iotevents/default/types.json#/31" + }, + "AWS.IoTEvents/DetectorModel@default": { + "$ref": "aws/aws.iotevents/default/types.json#/69" + }, + "AWS.IoTEvents/Input@default": { + "$ref": "aws/aws.iotevents/default/types.json#/78" + }, + "AWS.IoTFleetHub/Application@default": { + "$ref": "aws/aws.iotfleethub/default/types.json#/7" + }, + "AWS.IoTSiteWise/AccessPolicy@default": { + "$ref": "aws/aws.iotsitewise/default/types.json#/11" + }, + "AWS.IoTSiteWise/Asset@default": { + "$ref": "aws/aws.iotsitewise/default/types.json#/21" + }, + "AWS.IoTSiteWise/AssetModel@default": { + "$ref": "aws/aws.iotsitewise/default/types.json#/52" + }, + "AWS.IoTSiteWise/Dashboard@default": { + "$ref": "aws/aws.iotsitewise/default/types.json#/58" + }, + "AWS.IoTSiteWise/Gateway@default": { + "$ref": "aws/aws.iotsitewise/default/types.json#/72" + }, + "AWS.IoTSiteWise/Portal@default": { + "$ref": "aws/aws.iotsitewise/default/types.json#/79" + }, + "AWS.IoTSiteWise/Project@default": { + "$ref": "aws/aws.iotsitewise/default/types.json#/87" + }, + "AWS.IoTTwinMaker/ComponentType@default": { + "$ref": "aws/aws.iottwinmaker/default/types.json#/34" + }, + "AWS.IoTTwinMaker/Entity@default": { + "$ref": "aws/aws.iottwinmaker/default/types.json#/63" + }, + "AWS.IoTTwinMaker/Scene@default": { + "$ref": "aws/aws.iottwinmaker/default/types.json#/72" + }, + "AWS.IoTTwinMaker/Workspace@default": { + "$ref": "aws/aws.iottwinmaker/default/types.json#/78" + }, + "AWS.IoTWireless/Destination@default": { + "$ref": "aws/aws.iotwireless/default/types.json#/6" + }, + "AWS.IoTWireless/FuotaTask@default": { + "$ref": "aws/aws.iotwireless/default/types.json#/13" + }, + "AWS.IoTWireless/MulticastGroup@default": { + "$ref": "aws/aws.iotwireless/default/types.json#/21" + }, + "AWS.IoTWireless/NetworkAnalyzerConfiguration@default": { + "$ref": "aws/aws.iotwireless/default/types.json#/32" + }, + "AWS.IoTWireless/WirelessDevice@default": { + "$ref": "aws/aws.iotwireless/default/types.json#/45" + }, + "AWS.IoTWireless/WirelessGateway@default": { + "$ref": "aws/aws.iotwireless/default/types.json#/52" + }, + "AWS.IVS/Channel@default": { + "$ref": "aws/aws.ivs/default/types.json#/7" + }, + "AWS.IVS/EncoderConfiguration@default": { + "$ref": "aws/aws.ivs/default/types.json#/15" + }, + "AWS.IVS/PlaybackKeyPair@default": { + "$ref": "aws/aws.ivs/default/types.json#/21" + }, + "AWS.IVS/PlaybackRestrictionPolicy@default": { + "$ref": "aws/aws.ivs/default/types.json#/29" + }, + "AWS.IVS/RecordingConfiguration@default": { + "$ref": "aws/aws.ivs/default/types.json#/41" + }, + "AWS.IVS/Stage@default": { + "$ref": "aws/aws.ivs/default/types.json#/47" + }, + "AWS.IVS/StorageConfiguration@default": { + "$ref": "aws/aws.ivs/default/types.json#/54" + }, + "AWS.IVS/StreamKey@default": { + "$ref": "aws/aws.ivs/default/types.json#/60" + }, + "AWS.IVSChat/LoggingConfiguration@default": { + "$ref": "aws/aws.ivschat/default/types.json#/10" + }, + "AWS.IVSChat/Room@default": { + "$ref": "aws/aws.ivschat/default/types.json#/19" + }, + "AWS.KafkaConnect/Connector@default": { + "$ref": "aws/aws.kafkaconnect/default/types.json#/32" + }, + "AWS.KafkaConnect/CustomPlugin@default": { + "$ref": "aws/aws.kafkaconnect/default/types.json#/41" + }, + "AWS.KafkaConnect/WorkerConfiguration@default": { + "$ref": "aws/aws.kafkaconnect/default/types.json#/47" + }, + "AWS.Kendra/DataSource@default": { + "$ref": "aws/aws.kendra/default/types.json#/205" + }, + "AWS.Kendra/Faq@default": { + "$ref": "aws/aws.kendra/default/types.json#/223" + }, + "AWS.Kendra/Index@default": { + "$ref": "aws/aws.kendra/default/types.json#/272" + }, + "AWS.KendraRanking/ExecutionPlan@default": { + "$ref": "aws/aws.kendraranking/default/types.json#/15" + }, + "AWS.Kinesis/Stream@default": { + "$ref": "aws/aws.kinesis/default/types.json#/9" + }, + "AWS.KinesisAnalyticsV2/Application@default": { + "$ref": "aws/aws.kinesisanalyticsv2/default/types.json#/59" + }, + "AWS.KinesisFirehose/DeliveryStream@default": { + "$ref": "aws/aws.kinesisfirehose/default/types.json#/67" + }, + "AWS.KinesisVideo/SignalingChannel@default": { + "$ref": "aws/aws.kinesisvideo/default/types.json#/7" + }, + "AWS.KinesisVideo/Stream@default": { + "$ref": "aws/aws.kinesisvideo/default/types.json#/13" + }, + "AWS.KMS/Alias@default": { + "$ref": "aws/aws.kms/default/types.json#/4" + }, + "AWS.KMS/Key@default": { + "$ref": "aws/aws.kms/default/types.json#/14" + }, + "AWS.KMS/ReplicaKey@default": { + "$ref": "aws/aws.kms/default/types.json#/22" + }, + "AWS.LakeFormation/Tag@default": { + "$ref": "aws/aws.lakeformation/default/types.json#/10" + }, + "AWS.Lambda/CodeSigningConfig@default": { + "$ref": "aws/aws.lambda/default/types.json#/7" + }, + "AWS.Lambda/EventInvokeConfig@default": { + "$ref": "aws/aws.lambda/default/types.json#/15" + }, + "AWS.Lambda/EventSourceMapping@default": { + "$ref": "aws/aws.lambda/default/types.json#/39" + }, + "AWS.Lambda/Function@default": { + "$ref": "aws/aws.lambda/default/types.json#/65" + }, + "AWS.Lambda/Url@default": { + "$ref": "aws/aws.lambda/default/types.json#/82" + }, + "AWS.Lex/Bot@default": { + "$ref": "aws/aws.lex/default/types.json#/178" + }, + "AWS.Lex/BotAlias@default": { + "$ref": "aws/aws.lex/default/types.json#/212" + }, + "AWS.Lex/ResourcePolicy@default": { + "$ref": "aws/aws.lex/default/types.json#/220" + }, + "AWS.LicenseManager/Grant@default": { + "$ref": "aws/aws.licensemanager/default/types.json#/7" + }, + "AWS.LicenseManager/License@default": { + "$ref": "aws/aws.licensemanager/default/types.json#/24" + }, + "AWS.Lightsail/Alarm@default": { + "$ref": "aws/aws.lightsail/default/types.json#/8" + }, + "AWS.Lightsail/Bucket@default": { + "$ref": "aws/aws.lightsail/default/types.json#/17" + }, + "AWS.Lightsail/Certificate@default": { + "$ref": "aws/aws.lightsail/default/types.json#/24" + }, + "AWS.Lightsail/Container@default": { + "$ref": "aws/aws.lightsail/default/types.json#/45" + }, + "AWS.Lightsail/Database@default": { + "$ref": "aws/aws.lightsail/default/types.json#/53" + }, + "AWS.Lightsail/Disk@default": { + "$ref": "aws/aws.lightsail/default/types.json#/63" + }, + "AWS.Lightsail/Instance@default": { + "$ref": "aws/aws.lightsail/default/types.json#/91" + }, + "AWS.Lightsail/LoadBalancer@default": { + "$ref": "aws/aws.lightsail/default/types.json#/98" + }, + "AWS.Lightsail/LoadBalancerTlsCertificate@default": { + "$ref": "aws/aws.lightsail/default/types.json#/103" + }, + "AWS.Lightsail/StaticIp@default": { + "$ref": "aws/aws.lightsail/default/types.json#/107" + }, + "AWS.Location/APIKey@default": { + "$ref": "aws/aws.location/default/types.json#/13" + }, + "AWS.Location/GeofenceCollection@default": { + "$ref": "aws/aws.location/default/types.json#/22" + }, + "AWS.Location/Map@default": { + "$ref": "aws/aws.location/default/types.json#/33" + }, + "AWS.Location/PlaceIndex@default": { + "$ref": "aws/aws.location/default/types.json#/44" + }, + "AWS.Location/RouteCalculator@default": { + "$ref": "aws/aws.location/default/types.json#/53" + }, + "AWS.Location/Tracker@default": { + "$ref": "aws/aws.location/default/types.json#/63" + }, + "AWS.Logs/AccountPolicy@default": { + "$ref": "aws/aws.logs/default/types.json#/4" + }, + "AWS.Logs/Delivery@default": { + "$ref": "aws/aws.logs/default/types.json#/11" + }, + "AWS.Logs/DeliveryDestination@default": { + "$ref": "aws/aws.logs/default/types.json#/20" + }, + "AWS.Logs/DeliverySource@default": { + "$ref": "aws/aws.logs/default/types.json#/28" + }, + "AWS.Logs/Destination@default": { + "$ref": "aws/aws.logs/default/types.json#/32" + }, + "AWS.Logs/LogAnomalyDetector@default": { + "$ref": "aws/aws.logs/default/types.json#/38" + }, + "AWS.Logs/LogGroup@default": { + "$ref": "aws/aws.logs/default/types.json#/45" + }, + "AWS.Logs/MetricFilter@default": { + "$ref": "aws/aws.logs/default/types.json#/53" + }, + "AWS.Logs/QueryDefinition@default": { + "$ref": "aws/aws.logs/default/types.json#/59" + }, + "AWS.Logs/ResourcePolicy@default": { + "$ref": "aws/aws.logs/default/types.json#/63" + }, + "AWS.Logs/SubscriptionFilter@default": { + "$ref": "aws/aws.logs/default/types.json#/67" + }, + "AWS.LookoutMetrics/AnomalyDetector@default": { + "$ref": "aws/aws.lookoutmetrics/default/types.json#/40" + }, + "AWS.LookoutVision/Project@default": { + "$ref": "aws/aws.lookoutvision/default/types.json#/6" + }, + "AWS.M2/Application@default": { + "$ref": "aws/aws.m2/default/types.json#/7" + }, + "AWS.M2/Environment@default": { + "$ref": "aws/aws.m2/default/types.json#/22" + }, + "AWS.Macie/AllowList@default": { + "$ref": "aws/aws.macie/default/types.json#/10" + }, + "AWS.Macie/CustomDataIdentifier@default": { + "$ref": "aws/aws.macie/default/types.json#/19" + }, + "AWS.Macie/FindingsFilter@default": { + "$ref": "aws/aws.macie/default/types.json#/32" + }, + "AWS.Macie/Session@default": { + "$ref": "aws/aws.macie/default/types.json#/36" + }, + "AWS.MediaConnect/Bridge@default": { + "$ref": "aws/aws.mediaconnect/default/types.json#/23" + }, + "AWS.MediaConnect/BridgeOutput@default": { + "$ref": "aws/aws.mediaconnect/default/types.json#/28" + }, + "AWS.MediaConnect/BridgeSource@default": { + "$ref": "aws/aws.mediaconnect/default/types.json#/36" + }, + "AWS.MediaConnect/Flow@default": { + "$ref": "aws/aws.mediaconnect/default/types.json#/60" + }, + "AWS.MediaConnect/FlowEntitlement@default": { + "$ref": "aws/aws.mediaconnect/default/types.json#/66" + }, + "AWS.MediaConnect/FlowOutput@default": { + "$ref": "aws/aws.mediaconnect/default/types.json#/79" + }, + "AWS.MediaConnect/FlowSource@default": { + "$ref": "aws/aws.mediaconnect/default/types.json#/86" + }, + "AWS.MediaConnect/FlowVpcInterface@default": { + "$ref": "aws/aws.mediaconnect/default/types.json#/92" + }, + "AWS.MediaLive/Multiplex@default": { + "$ref": "aws/aws.medialive/default/types.json#/12" + }, + "AWS.MediaLive/Multiplexprogram@default": { + "$ref": "aws/aws.medialive/default/types.json#/28" + }, + "AWS.MediaPackage/Channel@default": { + "$ref": "aws/aws.mediapackage/default/types.json#/10" + }, + "AWS.MediaPackage/OriginEndpoint@default": { + "$ref": "aws/aws.mediapackage/default/types.json#/39" + }, + "AWS.MediaPackage/PackagingGroup@default": { + "$ref": "aws/aws.mediapackage/default/types.json#/47" + }, + "AWS.MediaPackageV2/Channel@default": { + "$ref": "aws/aws.mediapackagev2/default/types.json#/9" + }, + "AWS.MediaPackageV2/ChannelGroup@default": { + "$ref": "aws/aws.mediapackagev2/default/types.json#/15" + }, + "AWS.MediaPackageV2/ChannelPolicy@default": { + "$ref": "aws/aws.mediapackagev2/default/types.json#/21" + }, + "AWS.MediaPackageV2/OriginEndpoint@default": { + "$ref": "aws/aws.mediapackagev2/default/types.json#/64" + }, + "AWS.MediaPackageV2/OriginEndpointPolicy@default": { + "$ref": "aws/aws.mediapackagev2/default/types.json#/70" + }, + "AWS.MediaTailor/Channel@default": { + "$ref": "aws/aws.mediatailor/default/types.json#/21" + }, + "AWS.MediaTailor/ChannelPolicy@default": { + "$ref": "aws/aws.mediatailor/default/types.json#/27" + }, + "AWS.MediaTailor/LiveSource@default": { + "$ref": "aws/aws.mediatailor/default/types.json#/36" + }, + "AWS.MediaTailor/PlaybackConfiguration@default": { + "$ref": "aws/aws.mediatailor/default/types.json#/52" + }, + "AWS.MediaTailor/SourceLocation@default": { + "$ref": "aws/aws.mediatailor/default/types.json#/65" + }, + "AWS.MediaTailor/VodSource@default": { + "$ref": "aws/aws.mediatailor/default/types.json#/74" + }, + "AWS.MemoryDB/ACL@default": { + "$ref": "aws/aws.memorydb/default/types.json#/7" + }, + "AWS.MemoryDB/Cluster@default": { + "$ref": "aws/aws.memorydb/default/types.json#/20" + }, + "AWS.MemoryDB/ParameterGroup@default": { + "$ref": "aws/aws.memorydb/default/types.json#/27" + }, + "AWS.MemoryDB/SubnetGroup@default": { + "$ref": "aws/aws.memorydb/default/types.json#/34" + }, + "AWS.MemoryDB/User@default": { + "$ref": "aws/aws.memorydb/default/types.json#/42" + }, + "AWS.MSK/BatchScramSecret@default": { + "$ref": "aws/aws.msk/default/types.json#/7" + }, + "AWS.MSK/Cluster@default": { + "$ref": "aws/aws.msk/default/types.json#/48" + }, + "AWS.MSK/ClusterPolicy@default": { + "$ref": "aws/aws.msk/default/types.json#/53" + }, + "AWS.MSK/Configuration@default": { + "$ref": "aws/aws.msk/default/types.json#/61" + }, + "AWS.MSK/Replicator@default": { + "$ref": "aws/aws.msk/default/types.json#/83" + }, + "AWS.MSK/VpcConnection@default": { + "$ref": "aws/aws.msk/default/types.json#/96" + }, + "AWS.MWAA/Environment@default": { + "$ref": "aws/aws.mwaa/default/types.json#/53" + }, + "AWS.Neptune/DBCluster@default": { + "$ref": "aws/aws.neptune/default/types.json#/14" + }, + "AWS.NeptuneGraph/Graph@default": { + "$ref": "aws/aws.neptunegraph/default/types.json#/9" + }, + "AWS.NeptuneGraph/PrivateGraphEndpoint@default": { + "$ref": "aws/aws.neptunegraph/default/types.json#/15" + }, + "AWS.NetworkFirewall/Firewall@default": { + "$ref": "aws/aws.networkfirewall/default/types.json#/12" + }, + "AWS.NetworkFirewall/FirewallPolicy@default": { + "$ref": "aws/aws.networkfirewall/default/types.json#/45" + }, + "AWS.NetworkFirewall/LoggingConfiguration@default": { + "$ref": "aws/aws.networkfirewall/default/types.json#/54" + }, + "AWS.NetworkFirewall/RuleGroup@default": { + "$ref": "aws/aws.networkfirewall/default/types.json#/116" + }, + "AWS.NetworkFirewall/TLSInspectionConfiguration@default": { + "$ref": "aws/aws.networkfirewall/default/types.json#/142" + }, + "AWS.NetworkManager/ConnectAttachment@default": { + "$ref": "aws/aws.networkmanager/default/types.json#/10" + }, + "AWS.NetworkManager/ConnectPeer@default": { + "$ref": "aws/aws.networkmanager/default/types.json#/23" + }, + "AWS.NetworkManager/CoreNetwork@default": { + "$ref": "aws/aws.networkmanager/default/types.json#/37" + }, + "AWS.NetworkManager/Device@default": { + "$ref": "aws/aws.networkmanager/default/types.json#/45" + }, + "AWS.NetworkManager/GlobalNetwork@default": { + "$ref": "aws/aws.networkmanager/default/types.json#/51" + }, + "AWS.NetworkManager/Link@default": { + "$ref": "aws/aws.networkmanager/default/types.json#/58" + }, + "AWS.NetworkManager/Site@default": { + "$ref": "aws/aws.networkmanager/default/types.json#/65" + }, + "AWS.NetworkManager/SiteToSiteVpnAttachment@default": { + "$ref": "aws/aws.networkmanager/default/types.json#/73" + }, + "AWS.NetworkManager/TransitGatewayPeering@default": { + "$ref": "aws/aws.networkmanager/default/types.json#/79" + }, + "AWS.NetworkManager/TransitGatewayRouteTableAttachment@default": { + "$ref": "aws/aws.networkmanager/default/types.json#/87" + }, + "AWS.NetworkManager/VpcAttachment@default": { + "$ref": "aws/aws.networkmanager/default/types.json#/98" + }, + "AWS.NimbleStudio/LaunchProfile@default": { + "$ref": "aws/aws.nimblestudio/default/types.json#/23" + }, + "AWS.NimbleStudio/StreamingImage@default": { + "$ref": "aws/aws.nimblestudio/default/types.json#/31" + }, + "AWS.NimbleStudio/Studio@default": { + "$ref": "aws/aws.nimblestudio/default/types.json#/38" + }, + "AWS.NimbleStudio/StudioComponent@default": { + "$ref": "aws/aws.nimblestudio/default/types.json#/59" + }, + "AWS.Oam/Link@default": { + "$ref": "aws/aws.oam/default/types.json#/9" + }, + "AWS.Oam/Sink@default": { + "$ref": "aws/aws.oam/default/types.json#/15" + }, + "AWS.Omics/AnnotationStore@default": { + "$ref": "aws/aws.omics/default/types.json#/19" + }, + "AWS.Omics/RunGroup@default": { + "$ref": "aws/aws.omics/default/types.json#/24" + }, + "AWS.Omics/VariantStore@default": { + "$ref": "aws/aws.omics/default/types.json#/33" + }, + "AWS.Omics/Workflow@default": { + "$ref": "aws/aws.omics/default/types.json#/45" + }, + "AWS.OpenSearchServerless/AccessPolicy@default": { + "$ref": "aws/aws.opensearchserverless/default/types.json#/5" + }, + "AWS.OpenSearchServerless/Collection@default": { + "$ref": "aws/aws.opensearchserverless/default/types.json#/13" + }, + "AWS.OpenSearchServerless/LifecyclePolicy@default": { + "$ref": "aws/aws.opensearchserverless/default/types.json#/18" + }, + "AWS.OpenSearchServerless/SecurityConfig@default": { + "$ref": "aws/aws.opensearchserverless/default/types.json#/25" + }, + "AWS.OpenSearchServerless/SecurityPolicy@default": { + "$ref": "aws/aws.opensearchserverless/default/types.json#/30" + }, + "AWS.OpenSearchServerless/VpcEndpoint@default": { + "$ref": "aws/aws.opensearchserverless/default/types.json#/36" + }, + "AWS.OpenSearchService/Domain@default": { + "$ref": "aws/aws.opensearchservice/default/types.json#/34" + }, + "AWS.OpsWorksCM/Server@default": { + "$ref": "aws/aws.opsworkscm/default/types.json#/12" + }, + "AWS.Organizations/Account@default": { + "$ref": "aws/aws.organizations/default/types.json#/7" + }, + "AWS.Organizations/Organization@default": { + "$ref": "aws/aws.organizations/default/types.json#/11" + }, + "AWS.Organizations/OrganizationalUnit@default": { + "$ref": "aws/aws.organizations/default/types.json#/17" + }, + "AWS.Organizations/Policy@default": { + "$ref": "aws/aws.organizations/default/types.json#/27" + }, + "AWS.Organizations/ResourcePolicy@default": { + "$ref": "aws/aws.organizations/default/types.json#/35" + }, + "AWS.OSIS/Pipeline@default": { + "$ref": "aws/aws.osis/default/types.json#/18" + }, + "AWS.Panorama/ApplicationInstance@default": { + "$ref": "aws/aws.panorama/default/types.json#/26" + }, + "AWS.Panorama/Package@default": { + "$ref": "aws/aws.panorama/default/types.json#/39" + }, + "AWS.Panorama/PackageVersion@default": { + "$ref": "aws/aws.panorama/default/types.json#/53" + }, + "AWS.PaymentCryptography/Alias@default": { + "$ref": "aws/aws.paymentcryptography/default/types.json#/4" + }, + "AWS.PaymentCryptography/Key@default": { + "$ref": "aws/aws.paymentcryptography/default/types.json#/19" + }, + "AWS.PCAConnectorAD/Connector@default": { + "$ref": "aws/aws.pcaconnectorad/default/types.json#/7" + }, + "AWS.PCAConnectorAD/DirectoryRegistration@default": { + "$ref": "aws/aws.pcaconnectorad/default/types.json#/12" + }, + "AWS.PCAConnectorAD/Template@default": { + "$ref": "aws/aws.pcaconnectorad/default/types.json#/66" + }, + "AWS.PCAConnectorAD/TemplateGroupAccessControlEntry@default": { + "$ref": "aws/aws.pcaconnectorad/default/types.json#/72" + }, + "AWS.Personalize/Dataset@default": { + "$ref": "aws/aws.personalize/default/types.json#/6" + }, + "AWS.Pinpoint/InAppTemplate@default": { + "$ref": "aws/aws.pinpoint/default/types.json#/16" + }, + "AWS.Pipes/Pipe@default": { + "$ref": "aws/aws.pipes/default/types.json#/123" + }, + "AWS.Proton/EnvironmentAccountConnection@default": { + "$ref": "aws/aws.proton/default/types.json#/7" + }, + "AWS.Proton/EnvironmentTemplate@default": { + "$ref": "aws/aws.proton/default/types.json#/14" + }, + "AWS.Proton/ServiceTemplate@default": { + "$ref": "aws/aws.proton/default/types.json#/21" + }, + "AWS.QBusiness/Application@default": { + "$ref": "aws/aws.qbusiness/default/types.json#/10" + }, + "AWS.QBusiness/DataSource@default": { + "$ref": "aws/aws.qbusiness/default/types.json#/33" + }, + "AWS.QBusiness/Index@default": { + "$ref": "aws/aws.qbusiness/default/types.json#/49" + }, + "AWS.QBusiness/Plugin@default": { + "$ref": "aws/aws.qbusiness/default/types.json#/66" + }, + "AWS.QBusiness/Retriever@default": { + "$ref": "aws/aws.qbusiness/default/types.json#/77" + }, + "AWS.QBusiness/WebExperience@default": { + "$ref": "aws/aws.qbusiness/default/types.json#/85" + }, + "AWS.QLDB/Stream@default": { + "$ref": "aws/aws.qldb/default/types.json#/10" + }, + "AWS.QuickSight/Analysis@default": { + "$ref": "aws/aws.quicksight/default/types.json#/839" + }, + "AWS.QuickSight/Dashboard@default": { + "$ref": "aws/aws.quicksight/default/types.json#/1695" + }, + "AWS.QuickSight/DataSet@default": { + "$ref": "aws/aws.quicksight/default/types.json#/1796" + }, + "AWS.QuickSight/DataSource@default": { + "$ref": "aws/aws.quicksight/default/types.json#/1842" + }, + "AWS.QuickSight/RefreshSchedule@default": { + "$ref": "aws/aws.quicksight/default/types.json#/1849" + }, + "AWS.QuickSight/Template@default": { + "$ref": "aws/aws.quicksight/default/types.json#/2682" + }, + "AWS.QuickSight/Theme@default": { + "$ref": "aws/aws.quicksight/default/types.json#/2711" + }, + "AWS.QuickSight/Topic@default": { + "$ref": "aws/aws.quicksight/default/types.json#/2785" + }, + "AWS.QuickSight/VPCConnection@default": { + "$ref": "aws/aws.quicksight/default/types.json#/2799" + }, + "AWS.RAM/Permission@default": { + "$ref": "aws/aws.ram/default/types.json#/8" + }, + "AWS.RDS/CustomDBEngineVersion@default": { + "$ref": "aws/aws.rds/default/types.json#/7" + }, + "AWS.RDS/DBCluster@default": { + "$ref": "aws/aws.rds/default/types.json#/24" + }, + "AWS.RDS/DBClusterParameterGroup@default": { + "$ref": "aws/aws.rds/default/types.json#/31" + }, + "AWS.RDS/DBInstance@default": { + "$ref": "aws/aws.rds/default/types.json#/48" + }, + "AWS.RDS/DBParameterGroup@default": { + "$ref": "aws/aws.rds/default/types.json#/55" + }, + "AWS.RDS/DBProxy@default": { + "$ref": "aws/aws.rds/default/types.json#/65" + }, + "AWS.RDS/DBProxyEndpoint@default": { + "$ref": "aws/aws.rds/default/types.json#/73" + }, + "AWS.RDS/DBProxyTargetGroup@default": { + "$ref": "aws/aws.rds/default/types.json#/81" + }, + "AWS.RDS/DBSubnetGroup@default": { + "$ref": "aws/aws.rds/default/types.json#/88" + }, + "AWS.RDS/EventSubscription@default": { + "$ref": "aws/aws.rds/default/types.json#/96" + }, + "AWS.RDS/GlobalCluster@default": { + "$ref": "aws/aws.rds/default/types.json#/100" + }, + "AWS.RDS/Integration@default": { + "$ref": "aws/aws.rds/default/types.json#/109" + }, + "AWS.RDS/OptionGroup@default": { + "$ref": "aws/aws.rds/default/types.json#/121" + }, + "AWS.Redshift/Cluster@default": { + "$ref": "aws/aws.redshift/default/types.json#/14" + }, + "AWS.Redshift/ClusterParameterGroup@default": { + "$ref": "aws/aws.redshift/default/types.json#/22" + }, + "AWS.Redshift/ClusterSubnetGroup@default": { + "$ref": "aws/aws.redshift/default/types.json#/29" + }, + "AWS.Redshift/EndpointAccess@default": { + "$ref": "aws/aws.redshift/default/types.json#/39" + }, + "AWS.Redshift/EndpointAuthorization@default": { + "$ref": "aws/aws.redshift/default/types.json#/47" + }, + "AWS.Redshift/EventSubscription@default": { + "$ref": "aws/aws.redshift/default/types.json#/57" + }, + "AWS.Redshift/ScheduledAction@default": { + "$ref": "aws/aws.redshift/default/types.json#/67" + }, + "AWS.RedshiftServerless/Namespace@default": { + "$ref": "aws/aws.redshiftserverless/default/types.json#/18" + }, + "AWS.RedshiftServerless/Workgroup@default": { + "$ref": "aws/aws.redshiftserverless/default/types.json#/38" + }, + "AWS.RefactorSpaces/Route@default": { + "$ref": "aws/aws.refactorspaces/default/types.json#/13" + }, + "AWS.Rekognition/Collection@default": { + "$ref": "aws/aws.rekognition/default/types.json#/8" + }, + "AWS.Rekognition/Project@default": { + "$ref": "aws/aws.rekognition/default/types.json#/14" + }, + "AWS.Rekognition/StreamProcessor@default": { + "$ref": "aws/aws.rekognition/default/types.json#/40" + }, + "AWS.ResilienceHub/App@default": { + "$ref": "aws/aws.resiliencehub/default/types.json#/14" + }, + "AWS.ResilienceHub/ResiliencyPolicy@default": { + "$ref": "aws/aws.resiliencehub/default/types.json#/23" + }, + "AWS.ResourceExplorer2/DefaultViewAssociation@default": { + "$ref": "aws/aws.resourceexplorer2/default/types.json#/4" + }, + "AWS.ResourceExplorer2/Index@default": { + "$ref": "aws/aws.resourceexplorer2/default/types.json#/11" + }, + "AWS.ResourceExplorer2/View@default": { + "$ref": "aws/aws.resourceexplorer2/default/types.json#/19" + }, + "AWS.ResourceGroups/Group@default": { + "$ref": "aws/aws.resourcegroups/default/types.json#/20" + }, + "AWS.RoboMaker/Fleet@default": { + "$ref": "aws/aws.robomaker/default/types.json#/6" + }, + "AWS.RoboMaker/Robot@default": { + "$ref": "aws/aws.robomaker/default/types.json#/12" + }, + "AWS.RoboMaker/RobotApplication@default": { + "$ref": "aws/aws.robomaker/default/types.json#/21" + }, + "AWS.RoboMaker/SimulationApplication@default": { + "$ref": "aws/aws.robomaker/default/types.json#/32" + }, + "AWS.RolesAnywhere/CRL@default": { + "$ref": "aws/aws.rolesanywhere/default/types.json#/7" + }, + "AWS.RolesAnywhere/Profile@default": { + "$ref": "aws/aws.rolesanywhere/default/types.json#/21" + }, + "AWS.RolesAnywhere/TrustAnchor@default": { + "$ref": "aws/aws.rolesanywhere/default/types.json#/35" + }, + "AWS.Route53/CidrCollection@default": { + "$ref": "aws/aws.route53/default/types.json#/7" + }, + "AWS.Route53/HealthCheck@default": { + "$ref": "aws/aws.route53/default/types.json#/19" + }, + "AWS.Route53/HostedZone@default": { + "$ref": "aws/aws.route53/default/types.json#/30" + }, + "AWS.Route53/KeySigningKey@default": { + "$ref": "aws/aws.route53/default/types.json#/34" + }, + "AWS.Route53Profiles/Profile@default": { + "$ref": "aws/aws.route53profiles/default/types.json#/6" + }, + "AWS.Route53Profiles/ProfileAssociation@default": { + "$ref": "aws/aws.route53profiles/default/types.json#/12" + }, + "AWS.Route53Profiles/ProfileResourceAssociation@default": { + "$ref": "aws/aws.route53profiles/default/types.json#/16" + }, + "AWS.Route53RecoveryControl/ControlPanel@default": { + "$ref": "aws/aws.route53recoverycontrol/default/types.json#/8" + }, + "AWS.Route53RecoveryControl/RoutingControl@default": { + "$ref": "aws/aws.route53recoverycontrol/default/types.json#/12" + }, + "AWS.Route53RecoveryControl/SafetyRule@default": { + "$ref": "aws/aws.route53recoverycontrol/default/types.json#/26" + }, + "AWS.Route53RecoveryReadiness/Cell@default": { + "$ref": "aws/aws.route53recoveryreadiness/default/types.json#/8" + }, + "AWS.Route53RecoveryReadiness/ReadinessCheck@default": { + "$ref": "aws/aws.route53recoveryreadiness/default/types.json#/14" + }, + "AWS.Route53RecoveryReadiness/RecoveryGroup@default": { + "$ref": "aws/aws.route53recoveryreadiness/default/types.json#/21" + }, + "AWS.Route53RecoveryReadiness/ResourceSet@default": { + "$ref": "aws/aws.route53recoveryreadiness/default/types.json#/34" + }, + "AWS.Route53Resolver/FirewallDomainList@default": { + "$ref": "aws/aws.route53resolver/default/types.json#/10" + }, + "AWS.Route53Resolver/FirewallRuleGroup@default": { + "$ref": "aws/aws.route53resolver/default/types.json#/18" + }, + "AWS.Route53Resolver/FirewallRuleGroupAssociation@default": { + "$ref": "aws/aws.route53resolver/default/types.json#/24" + }, + "AWS.Route53Resolver/OutpostResolver@default": { + "$ref": "aws/aws.route53resolver/default/types.json#/30" + }, + "AWS.Route53Resolver/ResolverRule@default": { + "$ref": "aws/aws.route53resolver/default/types.json#/38" + }, + "AWS.RUM/AppMonitor@default": { + "$ref": "aws/aws.rum/default/types.json#/29" + }, + "AWS.S3/AccessGrant@default": { + "$ref": "aws/aws.s3/default/types.json#/9" + }, + "AWS.S3/AccessGrantsInstance@default": { + "$ref": "aws/aws.s3/default/types.json#/17" + }, + "AWS.S3/AccessGrantsLocation@default": { + "$ref": "aws/aws.s3/default/types.json#/23" + }, + "AWS.S3/AccessPoint@default": { + "$ref": "aws/aws.s3/default/types.json#/32" + }, + "AWS.S3/Bucket@default": { + "$ref": "aws/aws.s3/default/types.json#/126" + }, + "AWS.S3/BucketPolicy@default": { + "$ref": "aws/aws.s3/default/types.json#/132" + }, + "AWS.S3/MultiRegionAccessPointPolicy@default": { + "$ref": "aws/aws.s3/default/types.json#/138" + }, + "AWS.S3/StorageLens@default": { + "$ref": "aws/aws.s3/default/types.json#/170" + }, + "AWS.S3/StorageLensGroup@default": { + "$ref": "aws/aws.s3/default/types.json#/197" + }, + "AWS.S3Express/BucketPolicy@default": { + "$ref": "aws/aws.s3express/default/types.json#/6" + }, + "AWS.S3ObjectLambda/AccessPoint@default": { + "$ref": "aws/aws.s3objectlambda/default/types.json#/16" + }, + "AWS.S3ObjectLambda/AccessPointPolicy@default": { + "$ref": "aws/aws.s3objectlambda/default/types.json#/21" + }, + "AWS.S3Outposts/AccessPoint@default": { + "$ref": "aws/aws.s3outposts/default/types.json#/6" + }, + "AWS.S3Outposts/Bucket@default": { + "$ref": "aws/aws.s3outposts/default/types.json#/22" + }, + "AWS.S3Outposts/BucketPolicy@default": { + "$ref": "aws/aws.s3outposts/default/types.json#/27" + }, + "AWS.SageMaker/AppImageConfig@default": { + "$ref": "aws/aws.sagemaker/default/types.json#/20" + }, + "AWS.SageMaker/Device@default": { + "$ref": "aws/aws.sagemaker/default/types.json#/27" + }, + "AWS.SageMaker/DeviceFleet@default": { + "$ref": "aws/aws.sagemaker/default/types.json#/34" + }, + "AWS.SageMaker/Domain@default": { + "$ref": "aws/aws.sagemaker/default/types.json#/76" + }, + "AWS.SageMaker/FeatureGroup@default": { + "$ref": "aws/aws.sagemaker/default/types.json#/98" + }, + "AWS.SageMaker/Image@default": { + "$ref": "aws/aws.sagemaker/default/types.json#/109" + }, + "AWS.SageMaker/ImageVersion@default": { + "$ref": "aws/aws.sagemaker/default/types.json#/130" + }, + "AWS.SageMaker/InferenceComponent@default": { + "$ref": "aws/aws.sagemaker/default/types.json#/161" + }, + "AWS.SageMaker/InferenceExperiment@default": { + "$ref": "aws/aws.sagemaker/default/types.json#/181" + }, + "AWS.SageMaker/ModelCard@default": { + "$ref": "aws/aws.sagemaker/default/types.json#/245" + }, + "AWS.SageMaker/ModelPackage@default": { + "$ref": "aws/aws.sagemaker/default/types.json#/319" + }, + "AWS.SageMaker/ModelPackageGroup@default": { + "$ref": "aws/aws.sagemaker/default/types.json#/330" + }, + "AWS.SageMaker/MonitoringSchedule@default": { + "$ref": "aws/aws.sagemaker/default/types.json#/374" + }, + "AWS.SageMaker/Pipeline@default": { + "$ref": "aws/aws.sagemaker/default/types.json#/383" + }, + "AWS.SageMaker/Project@default": { + "$ref": "aws/aws.sagemaker/default/types.json#/401" + }, + "AWS.SageMaker/Space@default": { + "$ref": "aws/aws.sagemaker/default/types.json#/428" + }, + "AWS.SageMaker/UserProfile@default": { + "$ref": "aws/aws.sagemaker/default/types.json#/459" + }, + "AWS.Scheduler/Schedule@default": { + "$ref": "aws/aws.scheduler/default/types.json#/36" + }, + "AWS.Scheduler/ScheduleGroup@default": { + "$ref": "aws/aws.scheduler/default/types.json#/43" + }, + "AWS.SecretsManager/Secret@default": { + "$ref": "aws/aws.secretsmanager/default/types.json#/11" + }, + "AWS.SecurityHub/AutomationRule@default": { + "$ref": "aws/aws.securityhub/default/types.json#/72" + }, + "AWS.SecurityHub/ConfigurationPolicy@default": { + "$ref": "aws/aws.securityhub/default/types.json#/91" + }, + "AWS.SecurityHub/FindingAggregator@default": { + "$ref": "aws/aws.securityhub/default/types.json#/97" + }, + "AWS.SecurityHub/Hub@default": { + "$ref": "aws/aws.securityhub/default/types.json#/102" + }, + "AWS.SecurityHub/Insight@default": { + "$ref": "aws/aws.securityhub/default/types.json#/222" + }, + "AWS.SecurityHub/OrganizationConfiguration@default": { + "$ref": "aws/aws.securityhub/default/types.json#/226" + }, + "AWS.SecurityHub/PolicyAssociation@default": { + "$ref": "aws/aws.securityhub/default/types.json#/230" + }, + "AWS.SecurityHub/SecurityControl@default": { + "$ref": "aws/aws.securityhub/default/types.json#/245" + }, + "AWS.SecurityHub/Standard@default": { + "$ref": "aws/aws.securityhub/default/types.json#/251" + }, + "AWS.SecurityLake/AwsLogSource@default": { + "$ref": "aws/aws.securitylake/default/types.json#/5" + }, + "AWS.SecurityLake/DataLake@default": { + "$ref": "aws/aws.securitylake/default/types.json#/22" + }, + "AWS.SecurityLake/Subscriber@default": { + "$ref": "aws/aws.securitylake/default/types.json#/36" + }, + "AWS.SecurityLake/SubscriberNotification@default": { + "$ref": "aws/aws.securitylake/default/types.json#/43" + }, + "AWS.ServiceCatalog/CloudFormationProvisionedProduct@default": { + "$ref": "aws/aws.servicecatalog/default/types.json#/15" + }, + "AWS.ServiceCatalog/ServiceAction@default": { + "$ref": "aws/aws.servicecatalog/default/types.json#/21" + }, + "AWS.ServiceCatalogAppRegistry/Application@default": { + "$ref": "aws/aws.servicecatalogappregistry/default/types.json#/5" + }, + "AWS.ServiceCatalogAppRegistry/AttributeGroup@default": { + "$ref": "aws/aws.servicecatalogappregistry/default/types.json#/11" + }, + "AWS.SES/ConfigurationSet@default": { + "$ref": "aws/aws.ses/default/types.json#/14" + }, + "AWS.SES/ConfigurationSetEventDestination@default": { + "$ref": "aws/aws.ses/default/types.json#/26" + }, + "AWS.SES/ContactList@default": { + "$ref": "aws/aws.ses/default/types.json#/34" + }, + "AWS.SES/DedicatedIpPool@default": { + "$ref": "aws/aws.ses/default/types.json#/38" + }, + "AWS.SES/EmailIdentity@default": { + "$ref": "aws/aws.ses/default/types.json#/47" + }, + "AWS.SES/Template@default": { + "$ref": "aws/aws.ses/default/types.json#/52" + }, + "AWS.SES/VdmAttributes@default": { + "$ref": "aws/aws.ses/default/types.json#/58" + }, + "AWS.Shield/DRTAccess@default": { + "$ref": "aws/aws.shield/default/types.json#/5" + }, + "AWS.Shield/ProactiveEngagement@default": { + "$ref": "aws/aws.shield/default/types.json#/11" + }, + "AWS.Shield/Protection@default": { + "$ref": "aws/aws.shield/default/types.json#/20" + }, + "AWS.Shield/ProtectionGroup@default": { + "$ref": "aws/aws.shield/default/types.json#/27" + }, + "AWS.Signer/SigningProfile@default": { + "$ref": "aws/aws.signer/default/types.json#/12" + }, + "AWS.SimSpaceWeaver/Simulation@default": { + "$ref": "aws/aws.simspaceweaver/default/types.json#/5" + }, + "AWS.SNS/Topic@default": { + "$ref": "aws/aws.sns/default/types.json#/13" + }, + "AWS.SNS/TopicInlinePolicy@default": { + "$ref": "aws/aws.sns/default/types.json#/18" + }, + "AWS.SQS/Queue@default": { + "$ref": "aws/aws.sqs/default/types.json#/12" + }, + "AWS.SQS/QueueInlinePolicy@default": { + "$ref": "aws/aws.sqs/default/types.json#/17" + }, + "AWS.SSM/Association@default": { + "$ref": "aws/aws.ssm/default/types.json#/18" + }, + "AWS.SSM/Document@default": { + "$ref": "aws/aws.ssm/default/types.json#/31" + }, + "AWS.SSM/Parameter@default": { + "$ref": "aws/aws.ssm/default/types.json#/36" + }, + "AWS.SSM/PatchBaseline@default": { + "$ref": "aws/aws.ssm/default/types.json#/55" + }, + "AWS.SSM/ResourceDataSync@default": { + "$ref": "aws/aws.ssm/default/types.json#/64" + }, + "AWS.SSM/ResourcePolicy@default": { + "$ref": "aws/aws.ssm/default/types.json#/70" + }, + "AWS.SSMContacts/Contact@default": { + "$ref": "aws/aws.ssmcontacts/default/types.json#/13" + }, + "AWS.SSMContacts/ContactChannel@default": { + "$ref": "aws/aws.ssmcontacts/default/types.json#/17" + }, + "AWS.SSMContacts/Plan@default": { + "$ref": "aws/aws.ssmcontacts/default/types.json#/28" + }, + "AWS.SSMContacts/Rotation@default": { + "$ref": "aws/aws.ssmcontacts/default/types.json#/48" + }, + "AWS.SSMIncidents/ReplicationSet@default": { + "$ref": "aws/aws.ssmincidents/default/types.json#/15" + }, + "AWS.SSMIncidents/ResponsePlan@default": { + "$ref": "aws/aws.ssmincidents/default/types.json#/48" + }, + "AWS.SSO/Application@default": { + "$ref": "aws/aws.sso/default/types.json#/8" + }, + "AWS.SSO/Instance@default": { + "$ref": "aws/aws.sso/default/types.json#/14" + }, + "AWS.SSO/InstanceAccessControlAttributeConfiguration@default": { + "$ref": "aws/aws.sso/default/types.json#/29" + }, + "AWS.SSO/PermissionSet@default": { + "$ref": "aws/aws.sso/default/types.json#/42" + }, + "AWS.StepFunctions/Activity@default": { + "$ref": "aws/aws.stepfunctions/default/types.json#/6" + }, + "AWS.StepFunctions/StateMachine@default": { + "$ref": "aws/aws.stepfunctions/default/types.json#/21" + }, + "AWS.StepFunctions/StateMachineAlias@default": { + "$ref": "aws/aws.stepfunctions/default/types.json#/32" + }, + "AWS.SupportApp/AccountAlias@default": { + "$ref": "aws/aws.supportapp/default/types.json#/4" + }, + "AWS.SupportApp/SlackChannelConfiguration@default": { + "$ref": "aws/aws.supportapp/default/types.json#/9" + }, + "AWS.SupportApp/SlackWorkspaceConfiguration@default": { + "$ref": "aws/aws.supportapp/default/types.json#/13" + }, + "AWS.Synthetics/Canary@default": { + "$ref": "aws/aws.synthetics/default/types.json#/21" + }, + "AWS.Synthetics/Group@default": { + "$ref": "aws/aws.synthetics/default/types.json#/29" + }, + "AWS.SystemsManagerSAP/Application@default": { + "$ref": "aws/aws.systemsmanagersap/default/types.json#/10" + }, + "AWS.Timestream/Database@default": { + "$ref": "aws/aws.timestream/default/types.json#/6" + }, + "AWS.Timestream/InfluxDBInstance@default": { + "$ref": "aws/aws.timestream/default/types.json#/18" + }, + "AWS.Timestream/ScheduledQuery@default": { + "$ref": "aws/aws.timestream/default/types.json#/74" + }, + "AWS.Timestream/Table@default": { + "$ref": "aws/aws.timestream/default/types.json#/92" + }, + "AWS.Transfer/Agreement@default": { + "$ref": "aws/aws.transfer/default/types.json#/6" + }, + "AWS.Transfer/Certificate@default": { + "$ref": "aws/aws.transfer/default/types.json#/12" + }, + "AWS.Transfer/Connector@default": { + "$ref": "aws/aws.transfer/default/types.json#/23" + }, + "AWS.Transfer/Profile@default": { + "$ref": "aws/aws.transfer/default/types.json#/31" + }, + "AWS.Transfer/Workflow@default": { + "$ref": "aws/aws.transfer/default/types.json#/52" + }, + "AWS.VerifiedPermissions/IdentitySource@default": { + "$ref": "aws/aws.verifiedpermissions/default/types.json#/19" + }, + "AWS.VerifiedPermissions/Policy@default": { + "$ref": "aws/aws.verifiedpermissions/default/types.json#/28" + }, + "AWS.VerifiedPermissions/PolicyStore@default": { + "$ref": "aws/aws.verifiedpermissions/default/types.json#/36" + }, + "AWS.VerifiedPermissions/PolicyTemplate@default": { + "$ref": "aws/aws.verifiedpermissions/default/types.json#/40" + }, + "AWS.VoiceID/Domain@default": { + "$ref": "aws/aws.voiceid/default/types.json#/7" + }, + "AWS.VpcLattice/AccessLogSubscription@default": { + "$ref": "aws/aws.vpclattice/default/types.json#/6" + }, + "AWS.VpcLattice/AuthPolicy@default": { + "$ref": "aws/aws.vpclattice/default/types.json#/11" + }, + "AWS.VpcLattice/Listener@default": { + "$ref": "aws/aws.vpclattice/default/types.json#/23" + }, + "AWS.VpcLattice/ResourcePolicy@default": { + "$ref": "aws/aws.vpclattice/default/types.json#/28" + }, + "AWS.VpcLattice/Rule@default": { + "$ref": "aws/aws.vpclattice/default/types.json#/47" + }, + "AWS.VpcLattice/Service@default": { + "$ref": "aws/aws.vpclattice/default/types.json#/54" + }, + "AWS.VpcLattice/ServiceNetwork@default": { + "$ref": "aws/aws.vpclattice/default/types.json#/60" + }, + "AWS.VpcLattice/ServiceNetworkServiceAssociation@default": { + "$ref": "aws/aws.vpclattice/default/types.json#/67" + }, + "AWS.VpcLattice/ServiceNetworkVpcAssociation@default": { + "$ref": "aws/aws.vpclattice/default/types.json#/74" + }, + "AWS.VpcLattice/TargetGroup@default": { + "$ref": "aws/aws.vpclattice/default/types.json#/85" + }, + "AWS.WAFv2/IPSet@default": { + "$ref": "aws/aws.wafv2/default/types.json#/14" + }, + "AWS.WAFv2/LoggingConfiguration@default": { + "$ref": "aws/aws.wafv2/default/types.json#/33" + }, + "AWS.WAFv2/RegexPatternSet@default": { + "$ref": "aws/aws.wafv2/default/types.json#/40" + }, + "AWS.WAFv2/RuleGroup@default": { + "$ref": "aws/aws.wafv2/default/types.json#/165" + }, + "AWS.WAFv2/WebACL@default": { + "$ref": "aws/aws.wafv2/default/types.json#/338" + }, + "AWS.WAFv2/WebACLAssociation@default": { + "$ref": "aws/aws.wafv2/default/types.json#/343" + }, + "AWS.Wisdom/Assistant@default": { + "$ref": "aws/aws.wisdom/default/types.json#/8" + }, + "AWS.Wisdom/AssistantAssociation@default": { + "$ref": "aws/aws.wisdom/default/types.json#/16" + }, + "AWS.Wisdom/KnowledgeBase@default": { + "$ref": "aws/aws.wisdom/default/types.json#/28" + }, + "AWS.WorkSpaces/WorkspacesPool@default": { + "$ref": "aws/aws.workspaces/default/types.json#/11" + }, + "AWS.WorkSpacesThinClient/Environment@default": { + "$ref": "aws/aws.workspacesthinclient/default/types.json#/12" + }, + "AWS.WorkSpacesWeb/BrowserSettings@default": { + "$ref": "aws/aws.workspacesweb/default/types.json#/8" + }, + "AWS.WorkSpacesWeb/IdentityProvider@default": { + "$ref": "aws/aws.workspacesweb/default/types.json#/14" + }, + "AWS.WorkSpacesWeb/IpAccessSettings@default": { + "$ref": "aws/aws.workspacesweb/default/types.json#/24" + }, + "AWS.WorkSpacesWeb/NetworkSettings@default": { + "$ref": "aws/aws.workspacesweb/default/types.json#/33" + }, + "AWS.WorkSpacesWeb/Portal@default": { + "$ref": "aws/aws.workspacesweb/default/types.json#/46" + }, + "AWS.WorkSpacesWeb/TrustStore@default": { + "$ref": "aws/aws.workspacesweb/default/types.json#/54" + }, + "AWS.WorkSpacesWeb/UserAccessLoggingSettings@default": { + "$ref": "aws/aws.workspacesweb/default/types.json#/61" + }, + "AWS.WorkSpacesWeb/UserSettings@default": { + "$ref": "aws/aws.workspacesweb/default/types.json#/74" + }, + "AWS.XRay/Group@default": { + "$ref": "aws/aws.xray/default/types.json#/10" + }, + "AWS.XRay/ResourcePolicy@default": { + "$ref": "aws/aws.xray/default/types.json#/14" + }, + "AWS.XRay/SamplingRule@default": { + "$ref": "aws/aws.xray/default/types.json#/30" + } + }, + "resourceFunctions": {}, + "settings": { + "name": "AWS", + "version": "latest", + "isSingleton": false + } +} \ No newline at end of file diff --git a/artifacts/bicep/index.md b/artifacts/bicep/index.md index 8d6cba9f..6030edcf 100644 --- a/artifacts/bicep/index.md +++ b/artifacts/bicep/index.md @@ -1,2590 +1,2836 @@ # Bicep Types ## aws.accessanalyzer ### aws.accessanalyzer/analyzer -* [default](aws/aws.accessanalyzer/default/types.md#resource-awsaccessanalyzeranalyzerdefault) +* **Link**: [default](aws/aws.accessanalyzer/default/types.md#resource-awsaccessanalyzeranalyzerdefault) ## aws.acmpca -### aws.acmpca/certificate -* [default](aws/aws.acmpca/default/types.md#resource-awsacmpcacertificatedefault) - ### aws.acmpca/certificateauthority -* [default](aws/aws.acmpca/default/types.md#resource-awsacmpcacertificateauthoritydefault) +* **Link**: [default](aws/aws.acmpca/default/types.md#resource-awsacmpcacertificateauthoritydefault) ### aws.acmpca/certificateauthorityactivation -* [default](aws/aws.acmpca/default/types.md#resource-awsacmpcacertificateauthorityactivationdefault) +* **Link**: [default](aws/aws.acmpca/default/types.md#resource-awsacmpcacertificateauthorityactivationdefault) ## aws.amplify ### aws.amplify/app -* [default](aws/aws.amplify/default/types.md#resource-awsamplifyappdefault) +* **Link**: [default](aws/aws.amplify/default/types.md#resource-awsamplifyappdefault) ### aws.amplify/branch -* [default](aws/aws.amplify/default/types.md#resource-awsamplifybranchdefault) +* **Link**: [default](aws/aws.amplify/default/types.md#resource-awsamplifybranchdefault) ### aws.amplify/domain -* [default](aws/aws.amplify/default/types.md#resource-awsamplifydomaindefault) +* **Link**: [default](aws/aws.amplify/default/types.md#resource-awsamplifydomaindefault) ## aws.amplifyuibuilder ### aws.amplifyuibuilder/component -* [default](aws/aws.amplifyuibuilder/default/types.md#resource-awsamplifyuibuildercomponentdefault) +* **Link**: [default](aws/aws.amplifyuibuilder/default/types.md#resource-awsamplifyuibuildercomponentdefault) ### aws.amplifyuibuilder/form -* [default](aws/aws.amplifyuibuilder/default/types.md#resource-awsamplifyuibuilderformdefault) +* **Link**: [default](aws/aws.amplifyuibuilder/default/types.md#resource-awsamplifyuibuilderformdefault) ### aws.amplifyuibuilder/theme -* [default](aws/aws.amplifyuibuilder/default/types.md#resource-awsamplifyuibuilderthemedefault) +* **Link**: [default](aws/aws.amplifyuibuilder/default/types.md#resource-awsamplifyuibuilderthemedefault) ## aws.apigateway ### aws.apigateway/account -* [default](aws/aws.apigateway/default/types.md#resource-awsapigatewayaccountdefault) +* **Link**: [default](aws/aws.apigateway/default/types.md#resource-awsapigatewayaccountdefault) ### aws.apigateway/apikey -* [default](aws/aws.apigateway/default/types.md#resource-awsapigatewayapikeydefault) +* **Link**: [default](aws/aws.apigateway/default/types.md#resource-awsapigatewayapikeydefault) ### aws.apigateway/authorizer -* [default](aws/aws.apigateway/default/types.md#resource-awsapigatewayauthorizerdefault) +* **Link**: [default](aws/aws.apigateway/default/types.md#resource-awsapigatewayauthorizerdefault) ### aws.apigateway/basepathmapping -* [default](aws/aws.apigateway/default/types.md#resource-awsapigatewaybasepathmappingdefault) +* **Link**: [default](aws/aws.apigateway/default/types.md#resource-awsapigatewaybasepathmappingdefault) ### aws.apigateway/clientcertificate -* [default](aws/aws.apigateway/default/types.md#resource-awsapigatewayclientcertificatedefault) +* **Link**: [default](aws/aws.apigateway/default/types.md#resource-awsapigatewayclientcertificatedefault) ### aws.apigateway/deployment -* [default](aws/aws.apigateway/default/types.md#resource-awsapigatewaydeploymentdefault) +* **Link**: [default](aws/aws.apigateway/default/types.md#resource-awsapigatewaydeploymentdefault) ### aws.apigateway/documentationpart -* [default](aws/aws.apigateway/default/types.md#resource-awsapigatewaydocumentationpartdefault) +* **Link**: [default](aws/aws.apigateway/default/types.md#resource-awsapigatewaydocumentationpartdefault) ### aws.apigateway/documentationversion -* [default](aws/aws.apigateway/default/types.md#resource-awsapigatewaydocumentationversiondefault) +* **Link**: [default](aws/aws.apigateway/default/types.md#resource-awsapigatewaydocumentationversiondefault) ### aws.apigateway/domainname -* [default](aws/aws.apigateway/default/types.md#resource-awsapigatewaydomainnamedefault) +* **Link**: [default](aws/aws.apigateway/default/types.md#resource-awsapigatewaydomainnamedefault) + +### aws.apigateway/gatewayresponse +* **Link**: [default](aws/aws.apigateway/default/types.md#resource-awsapigatewaygatewayresponsedefault) ### aws.apigateway/method -* [default](aws/aws.apigateway/default/types.md#resource-awsapigatewaymethoddefault) +* **Link**: [default](aws/aws.apigateway/default/types.md#resource-awsapigatewaymethoddefault) ### aws.apigateway/model -* [default](aws/aws.apigateway/default/types.md#resource-awsapigatewaymodeldefault) +* **Link**: [default](aws/aws.apigateway/default/types.md#resource-awsapigatewaymodeldefault) ### aws.apigateway/requestvalidator -* [default](aws/aws.apigateway/default/types.md#resource-awsapigatewayrequestvalidatordefault) +* **Link**: [default](aws/aws.apigateway/default/types.md#resource-awsapigatewayrequestvalidatordefault) ### aws.apigateway/resource -* [default](aws/aws.apigateway/default/types.md#resource-awsapigatewayresourcedefault) +* **Link**: [default](aws/aws.apigateway/default/types.md#resource-awsapigatewayresourcedefault) ### aws.apigateway/restapi -* [default](aws/aws.apigateway/default/types.md#resource-awsapigatewayrestapidefault) +* **Link**: [default](aws/aws.apigateway/default/types.md#resource-awsapigatewayrestapidefault) ### aws.apigateway/stage -* [default](aws/aws.apigateway/default/types.md#resource-awsapigatewaystagedefault) +* **Link**: [default](aws/aws.apigateway/default/types.md#resource-awsapigatewaystagedefault) ### aws.apigateway/usageplan -* [default](aws/aws.apigateway/default/types.md#resource-awsapigatewayusageplandefault) +* **Link**: [default](aws/aws.apigateway/default/types.md#resource-awsapigatewayusageplandefault) ### aws.apigateway/vpclink -* [default](aws/aws.apigateway/default/types.md#resource-awsapigatewayvpclinkdefault) +* **Link**: [default](aws/aws.apigateway/default/types.md#resource-awsapigatewayvpclinkdefault) ## aws.apigatewayv2 ### aws.apigatewayv2/api -* [default](aws/aws.apigatewayv2/default/types.md#resource-awsapigatewayv2apidefault) +* **Link**: [default](aws/aws.apigatewayv2/default/types.md#resource-awsapigatewayv2apidefault) ### aws.apigatewayv2/apimapping -* [default](aws/aws.apigatewayv2/default/types.md#resource-awsapigatewayv2apimappingdefault) +* **Link**: [default](aws/aws.apigatewayv2/default/types.md#resource-awsapigatewayv2apimappingdefault) ### aws.apigatewayv2/authorizer -* [default](aws/aws.apigatewayv2/default/types.md#resource-awsapigatewayv2authorizerdefault) +* **Link**: [default](aws/aws.apigatewayv2/default/types.md#resource-awsapigatewayv2authorizerdefault) ### aws.apigatewayv2/deployment -* [default](aws/aws.apigatewayv2/default/types.md#resource-awsapigatewayv2deploymentdefault) +* **Link**: [default](aws/aws.apigatewayv2/default/types.md#resource-awsapigatewayv2deploymentdefault) ### aws.apigatewayv2/domainname -* [default](aws/aws.apigatewayv2/default/types.md#resource-awsapigatewayv2domainnamedefault) +* **Link**: [default](aws/aws.apigatewayv2/default/types.md#resource-awsapigatewayv2domainnamedefault) + +### aws.apigatewayv2/integration +* **Link**: [default](aws/aws.apigatewayv2/default/types.md#resource-awsapigatewayv2integrationdefault) ### aws.apigatewayv2/integrationresponse -* [default](aws/aws.apigatewayv2/default/types.md#resource-awsapigatewayv2integrationresponsedefault) +* **Link**: [default](aws/aws.apigatewayv2/default/types.md#resource-awsapigatewayv2integrationresponsedefault) ### aws.apigatewayv2/model -* [default](aws/aws.apigatewayv2/default/types.md#resource-awsapigatewayv2modeldefault) +* **Link**: [default](aws/aws.apigatewayv2/default/types.md#resource-awsapigatewayv2modeldefault) ### aws.apigatewayv2/route -* [default](aws/aws.apigatewayv2/default/types.md#resource-awsapigatewayv2routedefault) +* **Link**: [default](aws/aws.apigatewayv2/default/types.md#resource-awsapigatewayv2routedefault) ### aws.apigatewayv2/routeresponse -* [default](aws/aws.apigatewayv2/default/types.md#resource-awsapigatewayv2routeresponsedefault) +* **Link**: [default](aws/aws.apigatewayv2/default/types.md#resource-awsapigatewayv2routeresponsedefault) ### aws.apigatewayv2/vpclink -* [default](aws/aws.apigatewayv2/default/types.md#resource-awsapigatewayv2vpclinkdefault) +* **Link**: [default](aws/aws.apigatewayv2/default/types.md#resource-awsapigatewayv2vpclinkdefault) ## aws.appconfig ### aws.appconfig/application -* [default](aws/aws.appconfig/default/types.md#resource-awsappconfigapplicationdefault) +* **Link**: [default](aws/aws.appconfig/default/types.md#resource-awsappconfigapplicationdefault) ### aws.appconfig/configurationprofile -* [default](aws/aws.appconfig/default/types.md#resource-awsappconfigconfigurationprofiledefault) +* **Link**: [default](aws/aws.appconfig/default/types.md#resource-awsappconfigconfigurationprofiledefault) + +### aws.appconfig/environment +* **Link**: [default](aws/aws.appconfig/default/types.md#resource-awsappconfigenvironmentdefault) ### aws.appconfig/extension -* [default](aws/aws.appconfig/default/types.md#resource-awsappconfigextensiondefault) +* **Link**: [default](aws/aws.appconfig/default/types.md#resource-awsappconfigextensiondefault) ### aws.appconfig/extensionassociation -* [default](aws/aws.appconfig/default/types.md#resource-awsappconfigextensionassociationdefault) +* **Link**: [default](aws/aws.appconfig/default/types.md#resource-awsappconfigextensionassociationdefault) ## aws.appflow ### aws.appflow/connector -* [default](aws/aws.appflow/default/types.md#resource-awsappflowconnectordefault) +* **Link**: [default](aws/aws.appflow/default/types.md#resource-awsappflowconnectordefault) ### aws.appflow/connectorprofile -* [default](aws/aws.appflow/default/types.md#resource-awsappflowconnectorprofiledefault) +* **Link**: [default](aws/aws.appflow/default/types.md#resource-awsappflowconnectorprofiledefault) ### aws.appflow/flow -* [default](aws/aws.appflow/default/types.md#resource-awsappflowflowdefault) +* **Link**: [default](aws/aws.appflow/default/types.md#resource-awsappflowflowdefault) ## aws.appintegrations +### aws.appintegrations/application +* **Link**: [default](aws/aws.appintegrations/default/types.md#resource-awsappintegrationsapplicationdefault) + ### aws.appintegrations/dataintegration -* [default](aws/aws.appintegrations/default/types.md#resource-awsappintegrationsdataintegrationdefault) +* **Link**: [default](aws/aws.appintegrations/default/types.md#resource-awsappintegrationsdataintegrationdefault) ### aws.appintegrations/eventintegration -* [default](aws/aws.appintegrations/default/types.md#resource-awsappintegrationseventintegrationdefault) +* **Link**: [default](aws/aws.appintegrations/default/types.md#resource-awsappintegrationseventintegrationdefault) ## aws.applicationautoscaling ### aws.applicationautoscaling/scalabletarget -* [default](aws/aws.applicationautoscaling/default/types.md#resource-awsapplicationautoscalingscalabletargetdefault) +* **Link**: [default](aws/aws.applicationautoscaling/default/types.md#resource-awsapplicationautoscalingscalabletargetdefault) ### aws.applicationautoscaling/scalingpolicy -* [default](aws/aws.applicationautoscaling/default/types.md#resource-awsapplicationautoscalingscalingpolicydefault) +* **Link**: [default](aws/aws.applicationautoscaling/default/types.md#resource-awsapplicationautoscalingscalingpolicydefault) ## aws.applicationinsights ### aws.applicationinsights/application -* [default](aws/aws.applicationinsights/default/types.md#resource-awsapplicationinsightsapplicationdefault) +* **Link**: [default](aws/aws.applicationinsights/default/types.md#resource-awsapplicationinsightsapplicationdefault) + +## aws.applicationsignals +### aws.applicationsignals/servicelevelobjective +* **Link**: [default](aws/aws.applicationsignals/default/types.md#resource-awsapplicationsignalsservicelevelobjectivedefault) ## aws.apprunner ### aws.apprunner/service -* [default](aws/aws.apprunner/default/types.md#resource-awsapprunnerservicedefault) +* **Link**: [default](aws/aws.apprunner/default/types.md#resource-awsapprunnerservicedefault) ### aws.apprunner/vpcingressconnection -* [default](aws/aws.apprunner/default/types.md#resource-awsapprunnervpcingressconnectiondefault) +* **Link**: [default](aws/aws.apprunner/default/types.md#resource-awsapprunnervpcingressconnectiondefault) ## aws.appstream ### aws.appstream/appblockbuilder -* [default](aws/aws.appstream/default/types.md#resource-awsappstreamappblockbuilderdefault) +* **Link**: [default](aws/aws.appstream/default/types.md#resource-awsappstreamappblockbuilderdefault) ### aws.appstream/application -* [default](aws/aws.appstream/default/types.md#resource-awsappstreamapplicationdefault) +* **Link**: [default](aws/aws.appstream/default/types.md#resource-awsappstreamapplicationdefault) ### aws.appstream/directoryconfig -* [default](aws/aws.appstream/default/types.md#resource-awsappstreamdirectoryconfigdefault) +* **Link**: [default](aws/aws.appstream/default/types.md#resource-awsappstreamdirectoryconfigdefault) ### aws.appstream/entitlement -* [default](aws/aws.appstream/default/types.md#resource-awsappstreamentitlementdefault) +* **Link**: [default](aws/aws.appstream/default/types.md#resource-awsappstreamentitlementdefault) ## aws.appsync ### aws.appsync/domainname -* [default](aws/aws.appsync/default/types.md#resource-awsappsyncdomainnamedefault) +* **Link**: [default](aws/aws.appsync/default/types.md#resource-awsappsyncdomainnamedefault) ### aws.appsync/domainnameapiassociation -* [default](aws/aws.appsync/default/types.md#resource-awsappsyncdomainnameapiassociationdefault) +* **Link**: [default](aws/aws.appsync/default/types.md#resource-awsappsyncdomainnameapiassociationdefault) ### aws.appsync/functionconfiguration -* [default](aws/aws.appsync/default/types.md#resource-awsappsyncfunctionconfigurationdefault) +* **Link**: [default](aws/aws.appsync/default/types.md#resource-awsappsyncfunctionconfigurationdefault) ### aws.appsync/resolver -* [default](aws/aws.appsync/default/types.md#resource-awsappsyncresolverdefault) +* **Link**: [default](aws/aws.appsync/default/types.md#resource-awsappsyncresolverdefault) ### aws.appsync/sourceapiassociation -* [default](aws/aws.appsync/default/types.md#resource-awsappsyncsourceapiassociationdefault) +* **Link**: [default](aws/aws.appsync/default/types.md#resource-awsappsyncsourceapiassociationdefault) ## aws.aps ### aws.aps/rulegroupsnamespace -* [default](aws/aws.aps/default/types.md#resource-awsapsrulegroupsnamespacedefault) +* **Link**: [default](aws/aws.aps/default/types.md#resource-awsapsrulegroupsnamespacedefault) + +### aws.aps/scraper +* **Link**: [default](aws/aws.aps/default/types.md#resource-awsapsscraperdefault) ### aws.aps/workspace -* [default](aws/aws.aps/default/types.md#resource-awsapsworkspacedefault) +* **Link**: [default](aws/aws.aps/default/types.md#resource-awsapsworkspacedefault) ## aws.arczonalshift ### aws.arczonalshift/zonalautoshiftconfiguration -* [default](aws/aws.arczonalshift/default/types.md#resource-awsarczonalshiftzonalautoshiftconfigurationdefault) +* **Link**: [default](aws/aws.arczonalshift/default/types.md#resource-awsarczonalshiftzonalautoshiftconfigurationdefault) ## aws.athena ### aws.athena/capacityreservation -* [default](aws/aws.athena/default/types.md#resource-awsathenacapacityreservationdefault) +* **Link**: [default](aws/aws.athena/default/types.md#resource-awsathenacapacityreservationdefault) ### aws.athena/datacatalog -* [default](aws/aws.athena/default/types.md#resource-awsathenadatacatalogdefault) +* **Link**: [default](aws/aws.athena/default/types.md#resource-awsathenadatacatalogdefault) ### aws.athena/preparedstatement -* [default](aws/aws.athena/default/types.md#resource-awsathenapreparedstatementdefault) +* **Link**: [default](aws/aws.athena/default/types.md#resource-awsathenapreparedstatementdefault) ### aws.athena/workgroup -* [default](aws/aws.athena/default/types.md#resource-awsathenaworkgroupdefault) +* **Link**: [default](aws/aws.athena/default/types.md#resource-awsathenaworkgroupdefault) ## aws.auditmanager ### aws.auditmanager/assessment -* [default](aws/aws.auditmanager/default/types.md#resource-awsauditmanagerassessmentdefault) +* **Link**: [default](aws/aws.auditmanager/default/types.md#resource-awsauditmanagerassessmentdefault) ## aws.autoscaling ### aws.autoscaling/autoscalinggroup -* [default](aws/aws.autoscaling/default/types.md#resource-awsautoscalingautoscalinggroupdefault) +* **Link**: [default](aws/aws.autoscaling/default/types.md#resource-awsautoscalingautoscalinggroupdefault) ### aws.autoscaling/lifecyclehook -* [default](aws/aws.autoscaling/default/types.md#resource-awsautoscalinglifecyclehookdefault) +* **Link**: [default](aws/aws.autoscaling/default/types.md#resource-awsautoscalinglifecyclehookdefault) ### aws.autoscaling/scalingpolicy -* [default](aws/aws.autoscaling/default/types.md#resource-awsautoscalingscalingpolicydefault) +* **Link**: [default](aws/aws.autoscaling/default/types.md#resource-awsautoscalingscalingpolicydefault) ### aws.autoscaling/scheduledaction -* [default](aws/aws.autoscaling/default/types.md#resource-awsautoscalingscheduledactiondefault) +* **Link**: [default](aws/aws.autoscaling/default/types.md#resource-awsautoscalingscheduledactiondefault) ### aws.autoscaling/warmpool -* [default](aws/aws.autoscaling/default/types.md#resource-awsautoscalingwarmpooldefault) +* **Link**: [default](aws/aws.autoscaling/default/types.md#resource-awsautoscalingwarmpooldefault) ## aws.b2bi ### aws.b2bi/capability -* [default](aws/aws.b2bi/default/types.md#resource-awsb2bicapabilitydefault) +* **Link**: [default](aws/aws.b2bi/default/types.md#resource-awsb2bicapabilitydefault) ### aws.b2bi/partnership -* [default](aws/aws.b2bi/default/types.md#resource-awsb2bipartnershipdefault) +* **Link**: [default](aws/aws.b2bi/default/types.md#resource-awsb2bipartnershipdefault) ### aws.b2bi/profile -* [default](aws/aws.b2bi/default/types.md#resource-awsb2biprofiledefault) +* **Link**: [default](aws/aws.b2bi/default/types.md#resource-awsb2biprofiledefault) ### aws.b2bi/transformer -* [default](aws/aws.b2bi/default/types.md#resource-awsb2bitransformerdefault) +* **Link**: [default](aws/aws.b2bi/default/types.md#resource-awsb2bitransformerdefault) ## aws.backup ### aws.backup/backupplan -* [default](aws/aws.backup/default/types.md#resource-awsbackupbackupplandefault) +* **Link**: [default](aws/aws.backup/default/types.md#resource-awsbackupbackupplandefault) ### aws.backup/backupvault -* [default](aws/aws.backup/default/types.md#resource-awsbackupbackupvaultdefault) +* **Link**: [default](aws/aws.backup/default/types.md#resource-awsbackupbackupvaultdefault) ### aws.backup/framework -* [default](aws/aws.backup/default/types.md#resource-awsbackupframeworkdefault) +* **Link**: [default](aws/aws.backup/default/types.md#resource-awsbackupframeworkdefault) ### aws.backup/reportplan -* [default](aws/aws.backup/default/types.md#resource-awsbackupreportplandefault) +* **Link**: [default](aws/aws.backup/default/types.md#resource-awsbackupreportplandefault) ### aws.backup/restoretestingplan -* [default](aws/aws.backup/default/types.md#resource-awsbackuprestoretestingplandefault) +* **Link**: [default](aws/aws.backup/default/types.md#resource-awsbackuprestoretestingplandefault) ### aws.backup/restoretestingselection -* [default](aws/aws.backup/default/types.md#resource-awsbackuprestoretestingselectiondefault) +* **Link**: [default](aws/aws.backup/default/types.md#resource-awsbackuprestoretestingselectiondefault) ## aws.backupgateway ### aws.backupgateway/hypervisor -* [default](aws/aws.backupgateway/default/types.md#resource-awsbackupgatewayhypervisordefault) +* **Link**: [default](aws/aws.backupgateway/default/types.md#resource-awsbackupgatewayhypervisordefault) ## aws.batch ### aws.batch/computeenvironment -* [default](aws/aws.batch/default/types.md#resource-awsbatchcomputeenvironmentdefault) - -### aws.batch/jobdefinition -* [default](aws/aws.batch/default/types.md#resource-awsbatchjobdefinitiondefault) +* **Link**: [default](aws/aws.batch/default/types.md#resource-awsbatchcomputeenvironmentdefault) ### aws.batch/jobqueue -* [default](aws/aws.batch/default/types.md#resource-awsbatchjobqueuedefault) +* **Link**: [default](aws/aws.batch/default/types.md#resource-awsbatchjobqueuedefault) ### aws.batch/schedulingpolicy -* [default](aws/aws.batch/default/types.md#resource-awsbatchschedulingpolicydefault) +* **Link**: [default](aws/aws.batch/default/types.md#resource-awsbatchschedulingpolicydefault) + +## aws.bedrock +### aws.bedrock/agent +* **Link**: [default](aws/aws.bedrock/default/types.md#resource-awsbedrockagentdefault) + +### aws.bedrock/agentalias +* **Link**: [default](aws/aws.bedrock/default/types.md#resource-awsbedrockagentaliasdefault) + +### aws.bedrock/datasource +* **Link**: [default](aws/aws.bedrock/default/types.md#resource-awsbedrockdatasourcedefault) + +### aws.bedrock/guardrail +* **Link**: [default](aws/aws.bedrock/default/types.md#resource-awsbedrockguardraildefault) + +### aws.bedrock/knowledgebase +* **Link**: [default](aws/aws.bedrock/default/types.md#resource-awsbedrockknowledgebasedefault) ## aws.budgets ### aws.budgets/budgetsaction -* [default](aws/aws.budgets/default/types.md#resource-awsbudgetsbudgetsactiondefault) +* **Link**: [default](aws/aws.budgets/default/types.md#resource-awsbudgetsbudgetsactiondefault) ## aws.cassandra ### aws.cassandra/keyspace -* [default](aws/aws.cassandra/default/types.md#resource-awscassandrakeyspacedefault) +* **Link**: [default](aws/aws.cassandra/default/types.md#resource-awscassandrakeyspacedefault) ### aws.cassandra/table -* [default](aws/aws.cassandra/default/types.md#resource-awscassandratabledefault) +* **Link**: [default](aws/aws.cassandra/default/types.md#resource-awscassandratabledefault) ## aws.ce ### aws.ce/anomalymonitor -* [default](aws/aws.ce/default/types.md#resource-awsceanomalymonitordefault) +* **Link**: [default](aws/aws.ce/default/types.md#resource-awsceanomalymonitordefault) ### aws.ce/anomalysubscription -* [default](aws/aws.ce/default/types.md#resource-awsceanomalysubscriptiondefault) +* **Link**: [default](aws/aws.ce/default/types.md#resource-awsceanomalysubscriptiondefault) ### aws.ce/costcategory -* [default](aws/aws.ce/default/types.md#resource-awscecostcategorydefault) +* **Link**: [default](aws/aws.ce/default/types.md#resource-awscecostcategorydefault) ## aws.certificatemanager ### aws.certificatemanager/account -* [default](aws/aws.certificatemanager/default/types.md#resource-awscertificatemanageraccountdefault) +* **Link**: [default](aws/aws.certificatemanager/default/types.md#resource-awscertificatemanageraccountdefault) ## aws.chatbot ### aws.chatbot/microsoftteamschannelconfiguration -* [default](aws/aws.chatbot/default/types.md#resource-awschatbotmicrosoftteamschannelconfigurationdefault) +* **Link**: [default](aws/aws.chatbot/default/types.md#resource-awschatbotmicrosoftteamschannelconfigurationdefault) ### aws.chatbot/slackchannelconfiguration -* [default](aws/aws.chatbot/default/types.md#resource-awschatbotslackchannelconfigurationdefault) +* **Link**: [default](aws/aws.chatbot/default/types.md#resource-awschatbotslackchannelconfigurationdefault) ## aws.cleanrooms ### aws.cleanrooms/analysistemplate -* [default](aws/aws.cleanrooms/default/types.md#resource-awscleanroomsanalysistemplatedefault) +* **Link**: [default](aws/aws.cleanrooms/default/types.md#resource-awscleanroomsanalysistemplatedefault) ### aws.cleanrooms/collaboration -* [default](aws/aws.cleanrooms/default/types.md#resource-awscleanroomscollaborationdefault) +* **Link**: [default](aws/aws.cleanrooms/default/types.md#resource-awscleanroomscollaborationdefault) ### aws.cleanrooms/configuredtable -* [default](aws/aws.cleanrooms/default/types.md#resource-awscleanroomsconfiguredtabledefault) +* **Link**: [default](aws/aws.cleanrooms/default/types.md#resource-awscleanroomsconfiguredtabledefault) ### aws.cleanrooms/configuredtableassociation -* [default](aws/aws.cleanrooms/default/types.md#resource-awscleanroomsconfiguredtableassociationdefault) +* **Link**: [default](aws/aws.cleanrooms/default/types.md#resource-awscleanroomsconfiguredtableassociationdefault) ### aws.cleanrooms/membership -* [default](aws/aws.cleanrooms/default/types.md#resource-awscleanroomsmembershipdefault) +* **Link**: [default](aws/aws.cleanrooms/default/types.md#resource-awscleanroomsmembershipdefault) + +### aws.cleanrooms/privacybudgettemplate +* **Link**: [default](aws/aws.cleanrooms/default/types.md#resource-awscleanroomsprivacybudgettemplatedefault) + +## aws.cleanroomsml +### aws.cleanroomsml/trainingdataset +* **Link**: [default](aws/aws.cleanroomsml/default/types.md#resource-awscleanroomsmltrainingdatasetdefault) ## aws.cloudformation ### aws.cloudformation/hookdefaultversion -* [default](aws/aws.cloudformation/default/types.md#resource-awscloudformationhookdefaultversiondefault) +* **Link**: [default](aws/aws.cloudformation/default/types.md#resource-awscloudformationhookdefaultversiondefault) ### aws.cloudformation/hooktypeconfig -* [default](aws/aws.cloudformation/default/types.md#resource-awscloudformationhooktypeconfigdefault) +* **Link**: [default](aws/aws.cloudformation/default/types.md#resource-awscloudformationhooktypeconfigdefault) ### aws.cloudformation/resourcedefaultversion -* [default](aws/aws.cloudformation/default/types.md#resource-awscloudformationresourcedefaultversiondefault) +* **Link**: [default](aws/aws.cloudformation/default/types.md#resource-awscloudformationresourcedefaultversiondefault) ### aws.cloudformation/stack -* [default](aws/aws.cloudformation/default/types.md#resource-awscloudformationstackdefault) +* **Link**: [default](aws/aws.cloudformation/default/types.md#resource-awscloudformationstackdefault) ### aws.cloudformation/stackset -* [default](aws/aws.cloudformation/default/types.md#resource-awscloudformationstacksetdefault) +* **Link**: [default](aws/aws.cloudformation/default/types.md#resource-awscloudformationstacksetdefault) ### aws.cloudformation/typeactivation -* [default](aws/aws.cloudformation/default/types.md#resource-awscloudformationtypeactivationdefault) +* **Link**: [default](aws/aws.cloudformation/default/types.md#resource-awscloudformationtypeactivationdefault) ## aws.cloudfront ### aws.cloudfront/cachepolicy -* [default](aws/aws.cloudfront/default/types.md#resource-awscloudfrontcachepolicydefault) +* **Link**: [default](aws/aws.cloudfront/default/types.md#resource-awscloudfrontcachepolicydefault) ### aws.cloudfront/cloudfrontoriginaccessidentity -* [default](aws/aws.cloudfront/default/types.md#resource-awscloudfrontcloudfrontoriginaccessidentitydefault) +* **Link**: [default](aws/aws.cloudfront/default/types.md#resource-awscloudfrontcloudfrontoriginaccessidentitydefault) ### aws.cloudfront/continuousdeploymentpolicy -* [default](aws/aws.cloudfront/default/types.md#resource-awscloudfrontcontinuousdeploymentpolicydefault) +* **Link**: [default](aws/aws.cloudfront/default/types.md#resource-awscloudfrontcontinuousdeploymentpolicydefault) ### aws.cloudfront/distribution -* [default](aws/aws.cloudfront/default/types.md#resource-awscloudfrontdistributiondefault) +* **Link**: [default](aws/aws.cloudfront/default/types.md#resource-awscloudfrontdistributiondefault) ### aws.cloudfront/function -* [default](aws/aws.cloudfront/default/types.md#resource-awscloudfrontfunctiondefault) +* **Link**: [default](aws/aws.cloudfront/default/types.md#resource-awscloudfrontfunctiondefault) ### aws.cloudfront/keygroup -* [default](aws/aws.cloudfront/default/types.md#resource-awscloudfrontkeygroupdefault) +* **Link**: [default](aws/aws.cloudfront/default/types.md#resource-awscloudfrontkeygroupdefault) ### aws.cloudfront/keyvaluestore -* [default](aws/aws.cloudfront/default/types.md#resource-awscloudfrontkeyvaluestoredefault) +* **Link**: [default](aws/aws.cloudfront/default/types.md#resource-awscloudfrontkeyvaluestoredefault) ### aws.cloudfront/originaccesscontrol -* [default](aws/aws.cloudfront/default/types.md#resource-awscloudfrontoriginaccesscontroldefault) +* **Link**: [default](aws/aws.cloudfront/default/types.md#resource-awscloudfrontoriginaccesscontroldefault) ### aws.cloudfront/originrequestpolicy -* [default](aws/aws.cloudfront/default/types.md#resource-awscloudfrontoriginrequestpolicydefault) +* **Link**: [default](aws/aws.cloudfront/default/types.md#resource-awscloudfrontoriginrequestpolicydefault) ### aws.cloudfront/publickey -* [default](aws/aws.cloudfront/default/types.md#resource-awscloudfrontpublickeydefault) +* **Link**: [default](aws/aws.cloudfront/default/types.md#resource-awscloudfrontpublickeydefault) ### aws.cloudfront/realtimelogconfig -* [default](aws/aws.cloudfront/default/types.md#resource-awscloudfrontrealtimelogconfigdefault) +* **Link**: [default](aws/aws.cloudfront/default/types.md#resource-awscloudfrontrealtimelogconfigdefault) ### aws.cloudfront/responseheaderspolicy -* [default](aws/aws.cloudfront/default/types.md#resource-awscloudfrontresponseheaderspolicydefault) +* **Link**: [default](aws/aws.cloudfront/default/types.md#resource-awscloudfrontresponseheaderspolicydefault) ## aws.cloudtrail ### aws.cloudtrail/channel -* [default](aws/aws.cloudtrail/default/types.md#resource-awscloudtrailchanneldefault) +* **Link**: [default](aws/aws.cloudtrail/default/types.md#resource-awscloudtrailchanneldefault) ### aws.cloudtrail/eventdatastore -* [default](aws/aws.cloudtrail/default/types.md#resource-awscloudtraileventdatastoredefault) +* **Link**: [default](aws/aws.cloudtrail/default/types.md#resource-awscloudtraileventdatastoredefault) ### aws.cloudtrail/resourcepolicy -* [default](aws/aws.cloudtrail/default/types.md#resource-awscloudtrailresourcepolicydefault) +* **Link**: [default](aws/aws.cloudtrail/default/types.md#resource-awscloudtrailresourcepolicydefault) ### aws.cloudtrail/trail -* [default](aws/aws.cloudtrail/default/types.md#resource-awscloudtrailtraildefault) +* **Link**: [default](aws/aws.cloudtrail/default/types.md#resource-awscloudtrailtraildefault) ## aws.cloudwatch ### aws.cloudwatch/alarm -* [default](aws/aws.cloudwatch/default/types.md#resource-awscloudwatchalarmdefault) +* **Link**: [default](aws/aws.cloudwatch/default/types.md#resource-awscloudwatchalarmdefault) ### aws.cloudwatch/compositealarm -* [default](aws/aws.cloudwatch/default/types.md#resource-awscloudwatchcompositealarmdefault) +* **Link**: [default](aws/aws.cloudwatch/default/types.md#resource-awscloudwatchcompositealarmdefault) ### aws.cloudwatch/metricstream -* [default](aws/aws.cloudwatch/default/types.md#resource-awscloudwatchmetricstreamdefault) +* **Link**: [default](aws/aws.cloudwatch/default/types.md#resource-awscloudwatchmetricstreamdefault) ## aws.codeartifact ### aws.codeartifact/domain -* [default](aws/aws.codeartifact/default/types.md#resource-awscodeartifactdomaindefault) +* **Link**: [default](aws/aws.codeartifact/default/types.md#resource-awscodeartifactdomaindefault) + +### aws.codeartifact/packagegroup +* **Link**: [default](aws/aws.codeartifact/default/types.md#resource-awscodeartifactpackagegroupdefault) ### aws.codeartifact/repository -* [default](aws/aws.codeartifact/default/types.md#resource-awscodeartifactrepositorydefault) +* **Link**: [default](aws/aws.codeartifact/default/types.md#resource-awscodeartifactrepositorydefault) + +## aws.codebuild +### aws.codebuild/fleet +* **Link**: [default](aws/aws.codebuild/default/types.md#resource-awscodebuildfleetdefault) + +## aws.codeconnections +### aws.codeconnections/connection +* **Link**: [default](aws/aws.codeconnections/default/types.md#resource-awscodeconnectionsconnectiondefault) ## aws.codedeploy ### aws.codedeploy/application -* [default](aws/aws.codedeploy/default/types.md#resource-awscodedeployapplicationdefault) +* **Link**: [default](aws/aws.codedeploy/default/types.md#resource-awscodedeployapplicationdefault) ## aws.codeguruprofiler ### aws.codeguruprofiler/profilinggroup -* [default](aws/aws.codeguruprofiler/default/types.md#resource-awscodeguruprofilerprofilinggroupdefault) +* **Link**: [default](aws/aws.codeguruprofiler/default/types.md#resource-awscodeguruprofilerprofilinggroupdefault) ## aws.codepipeline ### aws.codepipeline/customactiontype -* [default](aws/aws.codepipeline/default/types.md#resource-awscodepipelinecustomactiontypedefault) +* **Link**: [default](aws/aws.codepipeline/default/types.md#resource-awscodepipelinecustomactiontypedefault) ## aws.codestarconnections ### aws.codestarconnections/connection -* [default](aws/aws.codestarconnections/default/types.md#resource-awscodestarconnectionsconnectiondefault) +* **Link**: [default](aws/aws.codestarconnections/default/types.md#resource-awscodestarconnectionsconnectiondefault) ### aws.codestarconnections/repositorylink -* [default](aws/aws.codestarconnections/default/types.md#resource-awscodestarconnectionsrepositorylinkdefault) +* **Link**: [default](aws/aws.codestarconnections/default/types.md#resource-awscodestarconnectionsrepositorylinkdefault) ### aws.codestarconnections/syncconfiguration -* [default](aws/aws.codestarconnections/default/types.md#resource-awscodestarconnectionssyncconfigurationdefault) +* **Link**: [default](aws/aws.codestarconnections/default/types.md#resource-awscodestarconnectionssyncconfigurationdefault) ## aws.codestarnotifications ### aws.codestarnotifications/notificationrule -* [default](aws/aws.codestarnotifications/default/types.md#resource-awscodestarnotificationsnotificationruledefault) +* **Link**: [default](aws/aws.codestarnotifications/default/types.md#resource-awscodestarnotificationsnotificationruledefault) ## aws.cognito +### aws.cognito/identitypool +* **Link**: [default](aws/aws.cognito/default/types.md#resource-awscognitoidentitypooldefault) + ### aws.cognito/identitypoolprincipaltag -* [default](aws/aws.cognito/default/types.md#resource-awscognitoidentitypoolprincipaltagdefault) +* **Link**: [default](aws/aws.cognito/default/types.md#resource-awscognitoidentitypoolprincipaltagdefault) + +### aws.cognito/identitypoolroleattachment +* **Link**: [default](aws/aws.cognito/default/types.md#resource-awscognitoidentitypoolroleattachmentdefault) ### aws.cognito/logdeliveryconfiguration -* [default](aws/aws.cognito/default/types.md#resource-awscognitologdeliveryconfigurationdefault) +* **Link**: [default](aws/aws.cognito/default/types.md#resource-awscognitologdeliveryconfigurationdefault) ### aws.cognito/userpool -* [default](aws/aws.cognito/default/types.md#resource-awscognitouserpooldefault) +* **Link**: [default](aws/aws.cognito/default/types.md#resource-awscognitouserpooldefault) ### aws.cognito/userpoolclient -* [default](aws/aws.cognito/default/types.md#resource-awscognitouserpoolclientdefault) +* **Link**: [default](aws/aws.cognito/default/types.md#resource-awscognitouserpoolclientdefault) ### aws.cognito/userpoolgroup -* [default](aws/aws.cognito/default/types.md#resource-awscognitouserpoolgroupdefault) +* **Link**: [default](aws/aws.cognito/default/types.md#resource-awscognitouserpoolgroupdefault) + +### aws.cognito/userpoolresourceserver +* **Link**: [default](aws/aws.cognito/default/types.md#resource-awscognitouserpoolresourceserverdefault) + +### aws.cognito/userpoolriskconfigurationattachment +* **Link**: [default](aws/aws.cognito/default/types.md#resource-awscognitouserpoolriskconfigurationattachmentdefault) ## aws.comprehend ### aws.comprehend/documentclassifier -* [default](aws/aws.comprehend/default/types.md#resource-awscomprehenddocumentclassifierdefault) +* **Link**: [default](aws/aws.comprehend/default/types.md#resource-awscomprehenddocumentclassifierdefault) ### aws.comprehend/flywheel -* [default](aws/aws.comprehend/default/types.md#resource-awscomprehendflywheeldefault) +* **Link**: [default](aws/aws.comprehend/default/types.md#resource-awscomprehendflywheeldefault) ## aws.config ### aws.config/aggregationauthorization -* [default](aws/aws.config/default/types.md#resource-awsconfigaggregationauthorizationdefault) +* **Link**: [default](aws/aws.config/default/types.md#resource-awsconfigaggregationauthorizationdefault) ### aws.config/configrule -* [default](aws/aws.config/default/types.md#resource-awsconfigconfigruledefault) +* **Link**: [default](aws/aws.config/default/types.md#resource-awsconfigconfigruledefault) ### aws.config/configurationaggregator -* [default](aws/aws.config/default/types.md#resource-awsconfigconfigurationaggregatordefault) +* **Link**: [default](aws/aws.config/default/types.md#resource-awsconfigconfigurationaggregatordefault) ### aws.config/conformancepack -* [default](aws/aws.config/default/types.md#resource-awsconfigconformancepackdefault) +* **Link**: [default](aws/aws.config/default/types.md#resource-awsconfigconformancepackdefault) ### aws.config/organizationconformancepack -* [default](aws/aws.config/default/types.md#resource-awsconfigorganizationconformancepackdefault) +* **Link**: [default](aws/aws.config/default/types.md#resource-awsconfigorganizationconformancepackdefault) ### aws.config/storedquery -* [default](aws/aws.config/default/types.md#resource-awsconfigstoredquerydefault) +* **Link**: [default](aws/aws.config/default/types.md#resource-awsconfigstoredquerydefault) ## aws.connect ### aws.connect/approvedorigin -* [default](aws/aws.connect/default/types.md#resource-awsconnectapprovedorigindefault) +* **Link**: [default](aws/aws.connect/default/types.md#resource-awsconnectapprovedorigindefault) ### aws.connect/contactflow -* [default](aws/aws.connect/default/types.md#resource-awsconnectcontactflowdefault) +* **Link**: [default](aws/aws.connect/default/types.md#resource-awsconnectcontactflowdefault) ### aws.connect/contactflowmodule -* [default](aws/aws.connect/default/types.md#resource-awsconnectcontactflowmoduledefault) +* **Link**: [default](aws/aws.connect/default/types.md#resource-awsconnectcontactflowmoduledefault) ### aws.connect/evaluationform -* [default](aws/aws.connect/default/types.md#resource-awsconnectevaluationformdefault) +* **Link**: [default](aws/aws.connect/default/types.md#resource-awsconnectevaluationformdefault) ### aws.connect/hoursofoperation -* [default](aws/aws.connect/default/types.md#resource-awsconnecthoursofoperationdefault) +* **Link**: [default](aws/aws.connect/default/types.md#resource-awsconnecthoursofoperationdefault) ### aws.connect/instance -* [default](aws/aws.connect/default/types.md#resource-awsconnectinstancedefault) +* **Link**: [default](aws/aws.connect/default/types.md#resource-awsconnectinstancedefault) ### aws.connect/instancestorageconfig -* [default](aws/aws.connect/default/types.md#resource-awsconnectinstancestorageconfigdefault) +* **Link**: [default](aws/aws.connect/default/types.md#resource-awsconnectinstancestorageconfigdefault) ### aws.connect/integrationassociation -* [default](aws/aws.connect/default/types.md#resource-awsconnectintegrationassociationdefault) +* **Link**: [default](aws/aws.connect/default/types.md#resource-awsconnectintegrationassociationdefault) ### aws.connect/phonenumber -* [default](aws/aws.connect/default/types.md#resource-awsconnectphonenumberdefault) +* **Link**: [default](aws/aws.connect/default/types.md#resource-awsconnectphonenumberdefault) ### aws.connect/predefinedattribute -* [default](aws/aws.connect/default/types.md#resource-awsconnectpredefinedattributedefault) +* **Link**: [default](aws/aws.connect/default/types.md#resource-awsconnectpredefinedattributedefault) ### aws.connect/prompt -* [default](aws/aws.connect/default/types.md#resource-awsconnectpromptdefault) +* **Link**: [default](aws/aws.connect/default/types.md#resource-awsconnectpromptdefault) ### aws.connect/queue -* [default](aws/aws.connect/default/types.md#resource-awsconnectqueuedefault) +* **Link**: [default](aws/aws.connect/default/types.md#resource-awsconnectqueuedefault) ### aws.connect/quickconnect -* [default](aws/aws.connect/default/types.md#resource-awsconnectquickconnectdefault) +* **Link**: [default](aws/aws.connect/default/types.md#resource-awsconnectquickconnectdefault) ### aws.connect/routingprofile -* [default](aws/aws.connect/default/types.md#resource-awsconnectroutingprofiledefault) +* **Link**: [default](aws/aws.connect/default/types.md#resource-awsconnectroutingprofiledefault) ### aws.connect/rule -* [default](aws/aws.connect/default/types.md#resource-awsconnectruledefault) +* **Link**: [default](aws/aws.connect/default/types.md#resource-awsconnectruledefault) ### aws.connect/securitykey -* [default](aws/aws.connect/default/types.md#resource-awsconnectsecuritykeydefault) +* **Link**: [default](aws/aws.connect/default/types.md#resource-awsconnectsecuritykeydefault) ### aws.connect/securityprofile -* [default](aws/aws.connect/default/types.md#resource-awsconnectsecurityprofiledefault) +* **Link**: [default](aws/aws.connect/default/types.md#resource-awsconnectsecurityprofiledefault) ### aws.connect/tasktemplate -* [default](aws/aws.connect/default/types.md#resource-awsconnecttasktemplatedefault) +* **Link**: [default](aws/aws.connect/default/types.md#resource-awsconnecttasktemplatedefault) ### aws.connect/trafficdistributiongroup -* [default](aws/aws.connect/default/types.md#resource-awsconnecttrafficdistributiongroupdefault) +* **Link**: [default](aws/aws.connect/default/types.md#resource-awsconnecttrafficdistributiongroupdefault) ### aws.connect/user -* [default](aws/aws.connect/default/types.md#resource-awsconnectuserdefault) +* **Link**: [default](aws/aws.connect/default/types.md#resource-awsconnectuserdefault) ### aws.connect/userhierarchygroup -* [default](aws/aws.connect/default/types.md#resource-awsconnectuserhierarchygroupdefault) +* **Link**: [default](aws/aws.connect/default/types.md#resource-awsconnectuserhierarchygroupdefault) ### aws.connect/view -* [default](aws/aws.connect/default/types.md#resource-awsconnectviewdefault) +* **Link**: [default](aws/aws.connect/default/types.md#resource-awsconnectviewdefault) ### aws.connect/viewversion -* [default](aws/aws.connect/default/types.md#resource-awsconnectviewversiondefault) +* **Link**: [default](aws/aws.connect/default/types.md#resource-awsconnectviewversiondefault) ## aws.connectcampaigns ### aws.connectcampaigns/campaign -* [default](aws/aws.connectcampaigns/default/types.md#resource-awsconnectcampaignscampaigndefault) +* **Link**: [default](aws/aws.connectcampaigns/default/types.md#resource-awsconnectcampaignscampaigndefault) ## aws.controltower +### aws.controltower/enabledbaseline +* **Link**: [default](aws/aws.controltower/default/types.md#resource-awscontroltowerenabledbaselinedefault) + ### aws.controltower/enabledcontrol -* [default](aws/aws.controltower/default/types.md#resource-awscontroltowerenabledcontroldefault) +* **Link**: [default](aws/aws.controltower/default/types.md#resource-awscontroltowerenabledcontroldefault) ### aws.controltower/landingzone -* [default](aws/aws.controltower/default/types.md#resource-awscontroltowerlandingzonedefault) +* **Link**: [default](aws/aws.controltower/default/types.md#resource-awscontroltowerlandingzonedefault) ## aws.customerprofiles ### aws.customerprofiles/calculatedattributedefinition -* [default](aws/aws.customerprofiles/default/types.md#resource-awscustomerprofilescalculatedattributedefinitiondefault) +* **Link**: [default](aws/aws.customerprofiles/default/types.md#resource-awscustomerprofilescalculatedattributedefinitiondefault) ### aws.customerprofiles/domain -* [default](aws/aws.customerprofiles/default/types.md#resource-awscustomerprofilesdomaindefault) +* **Link**: [default](aws/aws.customerprofiles/default/types.md#resource-awscustomerprofilesdomaindefault) ### aws.customerprofiles/eventstream -* [default](aws/aws.customerprofiles/default/types.md#resource-awscustomerprofileseventstreamdefault) +* **Link**: [default](aws/aws.customerprofiles/default/types.md#resource-awscustomerprofileseventstreamdefault) ### aws.customerprofiles/integration -* [default](aws/aws.customerprofiles/default/types.md#resource-awscustomerprofilesintegrationdefault) +* **Link**: [default](aws/aws.customerprofiles/default/types.md#resource-awscustomerprofilesintegrationdefault) ### aws.customerprofiles/objecttype -* [default](aws/aws.customerprofiles/default/types.md#resource-awscustomerprofilesobjecttypedefault) +* **Link**: [default](aws/aws.customerprofiles/default/types.md#resource-awscustomerprofilesobjecttypedefault) ## aws.databrew ### aws.databrew/dataset -* [default](aws/aws.databrew/default/types.md#resource-awsdatabrewdatasetdefault) +* **Link**: [default](aws/aws.databrew/default/types.md#resource-awsdatabrewdatasetdefault) ### aws.databrew/job -* [default](aws/aws.databrew/default/types.md#resource-awsdatabrewjobdefault) +* **Link**: [default](aws/aws.databrew/default/types.md#resource-awsdatabrewjobdefault) ### aws.databrew/project -* [default](aws/aws.databrew/default/types.md#resource-awsdatabrewprojectdefault) +* **Link**: [default](aws/aws.databrew/default/types.md#resource-awsdatabrewprojectdefault) ### aws.databrew/recipe -* [default](aws/aws.databrew/default/types.md#resource-awsdatabrewrecipedefault) +* **Link**: [default](aws/aws.databrew/default/types.md#resource-awsdatabrewrecipedefault) ### aws.databrew/ruleset -* [default](aws/aws.databrew/default/types.md#resource-awsdatabrewrulesetdefault) +* **Link**: [default](aws/aws.databrew/default/types.md#resource-awsdatabrewrulesetdefault) ### aws.databrew/schedule -* [default](aws/aws.databrew/default/types.md#resource-awsdatabrewscheduledefault) +* **Link**: [default](aws/aws.databrew/default/types.md#resource-awsdatabrewscheduledefault) ## aws.datapipeline ### aws.datapipeline/pipeline -* [default](aws/aws.datapipeline/default/types.md#resource-awsdatapipelinepipelinedefault) +* **Link**: [default](aws/aws.datapipeline/default/types.md#resource-awsdatapipelinepipelinedefault) ## aws.datasync ### aws.datasync/agent -* [default](aws/aws.datasync/default/types.md#resource-awsdatasyncagentdefault) +* **Link**: [default](aws/aws.datasync/default/types.md#resource-awsdatasyncagentdefault) ### aws.datasync/locationazureblob -* [default](aws/aws.datasync/default/types.md#resource-awsdatasynclocationazureblobdefault) +* **Link**: [default](aws/aws.datasync/default/types.md#resource-awsdatasynclocationazureblobdefault) ### aws.datasync/locationefs -* [default](aws/aws.datasync/default/types.md#resource-awsdatasynclocationefsdefault) +* **Link**: [default](aws/aws.datasync/default/types.md#resource-awsdatasynclocationefsdefault) ### aws.datasync/locationfsxlustre -* [default](aws/aws.datasync/default/types.md#resource-awsdatasynclocationfsxlustredefault) +* **Link**: [default](aws/aws.datasync/default/types.md#resource-awsdatasynclocationfsxlustredefault) ### aws.datasync/locationfsxontap -* [default](aws/aws.datasync/default/types.md#resource-awsdatasynclocationfsxontapdefault) +* **Link**: [default](aws/aws.datasync/default/types.md#resource-awsdatasynclocationfsxontapdefault) ### aws.datasync/locationfsxopenzfs -* [default](aws/aws.datasync/default/types.md#resource-awsdatasynclocationfsxopenzfsdefault) +* **Link**: [default](aws/aws.datasync/default/types.md#resource-awsdatasynclocationfsxopenzfsdefault) ### aws.datasync/locationfsxwindows -* [default](aws/aws.datasync/default/types.md#resource-awsdatasynclocationfsxwindowsdefault) +* **Link**: [default](aws/aws.datasync/default/types.md#resource-awsdatasynclocationfsxwindowsdefault) ### aws.datasync/locationhdfs -* [default](aws/aws.datasync/default/types.md#resource-awsdatasynclocationhdfsdefault) +* **Link**: [default](aws/aws.datasync/default/types.md#resource-awsdatasynclocationhdfsdefault) ### aws.datasync/locationnfs -* [default](aws/aws.datasync/default/types.md#resource-awsdatasynclocationnfsdefault) +* **Link**: [default](aws/aws.datasync/default/types.md#resource-awsdatasynclocationnfsdefault) ### aws.datasync/locationobjectstorage -* [default](aws/aws.datasync/default/types.md#resource-awsdatasynclocationobjectstoragedefault) +* **Link**: [default](aws/aws.datasync/default/types.md#resource-awsdatasynclocationobjectstoragedefault) ### aws.datasync/locations3 -* [default](aws/aws.datasync/default/types.md#resource-awsdatasynclocations3default) +* **Link**: [default](aws/aws.datasync/default/types.md#resource-awsdatasynclocations3default) ### aws.datasync/locationsmb -* [default](aws/aws.datasync/default/types.md#resource-awsdatasynclocationsmbdefault) +* **Link**: [default](aws/aws.datasync/default/types.md#resource-awsdatasynclocationsmbdefault) ### aws.datasync/storagesystem -* [default](aws/aws.datasync/default/types.md#resource-awsdatasyncstoragesystemdefault) +* **Link**: [default](aws/aws.datasync/default/types.md#resource-awsdatasyncstoragesystemdefault) ### aws.datasync/task -* [default](aws/aws.datasync/default/types.md#resource-awsdatasynctaskdefault) +* **Link**: [default](aws/aws.datasync/default/types.md#resource-awsdatasynctaskdefault) + +## aws.datazone +### aws.datazone/datasource +* **Link**: [default](aws/aws.datazone/default/types.md#resource-awsdatazonedatasourcedefault) + +### aws.datazone/domain +* **Link**: [default](aws/aws.datazone/default/types.md#resource-awsdatazonedomaindefault) + +### aws.datazone/environment +* **Link**: [default](aws/aws.datazone/default/types.md#resource-awsdatazoneenvironmentdefault) + +### aws.datazone/environmentblueprintconfiguration +* **Link**: [default](aws/aws.datazone/default/types.md#resource-awsdatazoneenvironmentblueprintconfigurationdefault) + +### aws.datazone/environmentprofile +* **Link**: [default](aws/aws.datazone/default/types.md#resource-awsdatazoneenvironmentprofiledefault) + +### aws.datazone/groupprofile +* **Link**: [default](aws/aws.datazone/default/types.md#resource-awsdatazonegroupprofiledefault) + +### aws.datazone/project +* **Link**: [default](aws/aws.datazone/default/types.md#resource-awsdatazoneprojectdefault) + +### aws.datazone/projectmembership +* **Link**: [default](aws/aws.datazone/default/types.md#resource-awsdatazoneprojectmembershipdefault) + +### aws.datazone/subscriptiontarget +* **Link**: [default](aws/aws.datazone/default/types.md#resource-awsdatazonesubscriptiontargetdefault) + +### aws.datazone/userprofile +* **Link**: [default](aws/aws.datazone/default/types.md#resource-awsdatazoneuserprofiledefault) + +## aws.deadline +### aws.deadline/farm +* **Link**: [default](aws/aws.deadline/default/types.md#resource-awsdeadlinefarmdefault) + +### aws.deadline/fleet +* **Link**: [default](aws/aws.deadline/default/types.md#resource-awsdeadlinefleetdefault) + +### aws.deadline/licenseendpoint +* **Link**: [default](aws/aws.deadline/default/types.md#resource-awsdeadlinelicenseendpointdefault) + +### aws.deadline/monitor +* **Link**: [default](aws/aws.deadline/default/types.md#resource-awsdeadlinemonitordefault) + +### aws.deadline/queue +* **Link**: [default](aws/aws.deadline/default/types.md#resource-awsdeadlinequeuedefault) + +### aws.deadline/queueenvironment +* **Link**: [default](aws/aws.deadline/default/types.md#resource-awsdeadlinequeueenvironmentdefault) + +### aws.deadline/storageprofile +* **Link**: [default](aws/aws.deadline/default/types.md#resource-awsdeadlinestorageprofiledefault) ## aws.detective ### aws.detective/graph -* [default](aws/aws.detective/default/types.md#resource-awsdetectivegraphdefault) +* **Link**: [default](aws/aws.detective/default/types.md#resource-awsdetectivegraphdefault) ### aws.detective/memberinvitation -* [default](aws/aws.detective/default/types.md#resource-awsdetectivememberinvitationdefault) +* **Link**: [default](aws/aws.detective/default/types.md#resource-awsdetectivememberinvitationdefault) ### aws.detective/organizationadmin -* [default](aws/aws.detective/default/types.md#resource-awsdetectiveorganizationadmindefault) +* **Link**: [default](aws/aws.detective/default/types.md#resource-awsdetectiveorganizationadmindefault) ## aws.devicefarm ### aws.devicefarm/devicepool -* [default](aws/aws.devicefarm/default/types.md#resource-awsdevicefarmdevicepooldefault) +* **Link**: [default](aws/aws.devicefarm/default/types.md#resource-awsdevicefarmdevicepooldefault) ### aws.devicefarm/instanceprofile -* [default](aws/aws.devicefarm/default/types.md#resource-awsdevicefarminstanceprofiledefault) +* **Link**: [default](aws/aws.devicefarm/default/types.md#resource-awsdevicefarminstanceprofiledefault) ### aws.devicefarm/networkprofile -* [default](aws/aws.devicefarm/default/types.md#resource-awsdevicefarmnetworkprofiledefault) +* **Link**: [default](aws/aws.devicefarm/default/types.md#resource-awsdevicefarmnetworkprofiledefault) ### aws.devicefarm/project -* [default](aws/aws.devicefarm/default/types.md#resource-awsdevicefarmprojectdefault) +* **Link**: [default](aws/aws.devicefarm/default/types.md#resource-awsdevicefarmprojectdefault) ### aws.devicefarm/testgridproject -* [default](aws/aws.devicefarm/default/types.md#resource-awsdevicefarmtestgridprojectdefault) +* **Link**: [default](aws/aws.devicefarm/default/types.md#resource-awsdevicefarmtestgridprojectdefault) ### aws.devicefarm/vpceconfiguration -* [default](aws/aws.devicefarm/default/types.md#resource-awsdevicefarmvpceconfigurationdefault) +* **Link**: [default](aws/aws.devicefarm/default/types.md#resource-awsdevicefarmvpceconfigurationdefault) ## aws.devopsguru ### aws.devopsguru/loganomalydetectionintegration -* [default](aws/aws.devopsguru/default/types.md#resource-awsdevopsguruloganomalydetectionintegrationdefault) +* **Link**: [default](aws/aws.devopsguru/default/types.md#resource-awsdevopsguruloganomalydetectionintegrationdefault) ### aws.devopsguru/resourcecollection -* [default](aws/aws.devopsguru/default/types.md#resource-awsdevopsgururesourcecollectiondefault) +* **Link**: [default](aws/aws.devopsguru/default/types.md#resource-awsdevopsgururesourcecollectiondefault) ## aws.directoryservice ### aws.directoryservice/simplead -* [default](aws/aws.directoryservice/default/types.md#resource-awsdirectoryservicesimpleaddefault) +* **Link**: [default](aws/aws.directoryservice/default/types.md#resource-awsdirectoryservicesimpleaddefault) ## aws.dms ### aws.dms/dataprovider -* [default](aws/aws.dms/default/types.md#resource-awsdmsdataproviderdefault) +* **Link**: [default](aws/aws.dms/default/types.md#resource-awsdmsdataproviderdefault) ### aws.dms/instanceprofile -* [default](aws/aws.dms/default/types.md#resource-awsdmsinstanceprofiledefault) +* **Link**: [default](aws/aws.dms/default/types.md#resource-awsdmsinstanceprofiledefault) ### aws.dms/migrationproject -* [default](aws/aws.dms/default/types.md#resource-awsdmsmigrationprojectdefault) +* **Link**: [default](aws/aws.dms/default/types.md#resource-awsdmsmigrationprojectdefault) ### aws.dms/replicationconfig -* [default](aws/aws.dms/default/types.md#resource-awsdmsreplicationconfigdefault) +* **Link**: [default](aws/aws.dms/default/types.md#resource-awsdmsreplicationconfigdefault) ## aws.docdbelastic ### aws.docdbelastic/cluster -* [default](aws/aws.docdbelastic/default/types.md#resource-awsdocdbelasticclusterdefault) +* **Link**: [default](aws/aws.docdbelastic/default/types.md#resource-awsdocdbelasticclusterdefault) ## aws.dynamodb ### aws.dynamodb/globaltable -* [default](aws/aws.dynamodb/default/types.md#resource-awsdynamodbglobaltabledefault) +* **Link**: [default](aws/aws.dynamodb/default/types.md#resource-awsdynamodbglobaltabledefault) ### aws.dynamodb/table -* [default](aws/aws.dynamodb/default/types.md#resource-awsdynamodbtabledefault) +* **Link**: [default](aws/aws.dynamodb/default/types.md#resource-awsdynamodbtabledefault) ## aws.ec2 ### aws.ec2/capacityreservation -* [default](aws/aws.ec2/default/types.md#resource-awsec2capacityreservationdefault) +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2capacityreservationdefault) ### aws.ec2/capacityreservationfleet -* [default](aws/aws.ec2/default/types.md#resource-awsec2capacityreservationfleetdefault) +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2capacityreservationfleetdefault) ### aws.ec2/carriergateway -* [default](aws/aws.ec2/default/types.md#resource-awsec2carriergatewaydefault) +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2carriergatewaydefault) ### aws.ec2/customergateway -* [default](aws/aws.ec2/default/types.md#resource-awsec2customergatewaydefault) +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2customergatewaydefault) ### aws.ec2/dhcpoptions -* [default](aws/aws.ec2/default/types.md#resource-awsec2dhcpoptionsdefault) +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2dhcpoptionsdefault) ### aws.ec2/ec2fleet -* [default](aws/aws.ec2/default/types.md#resource-awsec2ec2fleetdefault) +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2ec2fleetdefault) ### aws.ec2/eip -* [default](aws/aws.ec2/default/types.md#resource-awsec2eipdefault) +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2eipdefault) ### aws.ec2/flowlog -* [default](aws/aws.ec2/default/types.md#resource-awsec2flowlogdefault) +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2flowlogdefault) ### aws.ec2/gatewayroutetableassociation -* [default](aws/aws.ec2/default/types.md#resource-awsec2gatewayroutetableassociationdefault) +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2gatewayroutetableassociationdefault) ### aws.ec2/host -* [default](aws/aws.ec2/default/types.md#resource-awsec2hostdefault) +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2hostdefault) ### aws.ec2/instance -* [default](aws/aws.ec2/default/types.md#resource-awsec2instancedefault) +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2instancedefault) ### aws.ec2/instanceconnectendpoint -* [default](aws/aws.ec2/default/types.md#resource-awsec2instanceconnectendpointdefault) +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2instanceconnectendpointdefault) ### aws.ec2/internetgateway -* [default](aws/aws.ec2/default/types.md#resource-awsec2internetgatewaydefault) +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2internetgatewaydefault) ### aws.ec2/ipam -* [default](aws/aws.ec2/default/types.md#resource-awsec2ipamdefault) +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2ipamdefault) ### aws.ec2/ipampool -* [default](aws/aws.ec2/default/types.md#resource-awsec2ipampooldefault) +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2ipampooldefault) ### aws.ec2/ipamresourcediscovery -* [default](aws/aws.ec2/default/types.md#resource-awsec2ipamresourcediscoverydefault) +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2ipamresourcediscoverydefault) ### aws.ec2/ipamresourcediscoveryassociation -* [default](aws/aws.ec2/default/types.md#resource-awsec2ipamresourcediscoveryassociationdefault) +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2ipamresourcediscoveryassociationdefault) ### aws.ec2/ipamscope -* [default](aws/aws.ec2/default/types.md#resource-awsec2ipamscopedefault) +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2ipamscopedefault) ### aws.ec2/launchtemplate -* [default](aws/aws.ec2/default/types.md#resource-awsec2launchtemplatedefault) +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2launchtemplatedefault) ### aws.ec2/localgatewayroute -* [default](aws/aws.ec2/default/types.md#resource-awsec2localgatewayroutedefault) +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2localgatewayroutedefault) ### aws.ec2/localgatewayroutetable -* [default](aws/aws.ec2/default/types.md#resource-awsec2localgatewayroutetabledefault) +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2localgatewayroutetabledefault) ### aws.ec2/localgatewayroutetablevirtualinterfacegroupassociation -* [default](aws/aws.ec2/default/types.md#resource-awsec2localgatewayroutetablevirtualinterfacegroupassociationdefault) +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2localgatewayroutetablevirtualinterfacegroupassociationdefault) ### aws.ec2/localgatewayroutetablevpcassociation -* [default](aws/aws.ec2/default/types.md#resource-awsec2localgatewayroutetablevpcassociationdefault) +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2localgatewayroutetablevpcassociationdefault) ### aws.ec2/natgateway -* [default](aws/aws.ec2/default/types.md#resource-awsec2natgatewaydefault) +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2natgatewaydefault) ### aws.ec2/networkacl -* [default](aws/aws.ec2/default/types.md#resource-awsec2networkacldefault) +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2networkacldefault) ### aws.ec2/networkinsightsaccessscope -* [default](aws/aws.ec2/default/types.md#resource-awsec2networkinsightsaccessscopedefault) +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2networkinsightsaccessscopedefault) ### aws.ec2/networkinsightsaccessscopeanalysis -* [default](aws/aws.ec2/default/types.md#resource-awsec2networkinsightsaccessscopeanalysisdefault) +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2networkinsightsaccessscopeanalysisdefault) ### aws.ec2/networkinsightsanalysis -* [default](aws/aws.ec2/default/types.md#resource-awsec2networkinsightsanalysisdefault) +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2networkinsightsanalysisdefault) ### aws.ec2/networkinsightspath -* [default](aws/aws.ec2/default/types.md#resource-awsec2networkinsightspathdefault) +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2networkinsightspathdefault) ### aws.ec2/networkinterface -* [default](aws/aws.ec2/default/types.md#resource-awsec2networkinterfacedefault) +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2networkinterfacedefault) ### aws.ec2/networkinterfaceattachment -* [default](aws/aws.ec2/default/types.md#resource-awsec2networkinterfaceattachmentdefault) +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2networkinterfaceattachmentdefault) ### aws.ec2/prefixlist -* [default](aws/aws.ec2/default/types.md#resource-awsec2prefixlistdefault) +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2prefixlistdefault) ### aws.ec2/route -* [default](aws/aws.ec2/default/types.md#resource-awsec2routedefault) +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2routedefault) ### aws.ec2/routetable -* [default](aws/aws.ec2/default/types.md#resource-awsec2routetabledefault) +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2routetabledefault) ### aws.ec2/securitygroup -* [default](aws/aws.ec2/default/types.md#resource-awsec2securitygroupdefault) +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2securitygroupdefault) ### aws.ec2/securitygroupegress -* [default](aws/aws.ec2/default/types.md#resource-awsec2securitygroupegressdefault) +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2securitygroupegressdefault) + +### aws.ec2/securitygroupingress +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2securitygroupingressdefault) ### aws.ec2/snapshotblockpublicaccess -* [default](aws/aws.ec2/default/types.md#resource-awsec2snapshotblockpublicaccessdefault) +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2snapshotblockpublicaccessdefault) ### aws.ec2/spotfleet -* [default](aws/aws.ec2/default/types.md#resource-awsec2spotfleetdefault) +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2spotfleetdefault) ### aws.ec2/subnet -* [default](aws/aws.ec2/default/types.md#resource-awsec2subnetdefault) +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2subnetdefault) ### aws.ec2/transitgateway -* [default](aws/aws.ec2/default/types.md#resource-awsec2transitgatewaydefault) +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2transitgatewaydefault) ### aws.ec2/transitgatewayattachment -* [default](aws/aws.ec2/default/types.md#resource-awsec2transitgatewayattachmentdefault) +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2transitgatewayattachmentdefault) ### aws.ec2/transitgatewayconnect -* [default](aws/aws.ec2/default/types.md#resource-awsec2transitgatewayconnectdefault) +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2transitgatewayconnectdefault) ### aws.ec2/transitgatewaymulticastdomain -* [default](aws/aws.ec2/default/types.md#resource-awsec2transitgatewaymulticastdomaindefault) +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2transitgatewaymulticastdomaindefault) ### aws.ec2/transitgatewaypeeringattachment -* [default](aws/aws.ec2/default/types.md#resource-awsec2transitgatewaypeeringattachmentdefault) +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2transitgatewaypeeringattachmentdefault) ### aws.ec2/transitgatewayvpcattachment -* [default](aws/aws.ec2/default/types.md#resource-awsec2transitgatewayvpcattachmentdefault) +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2transitgatewayvpcattachmentdefault) ### aws.ec2/verifiedaccessendpoint -* [default](aws/aws.ec2/default/types.md#resource-awsec2verifiedaccessendpointdefault) +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2verifiedaccessendpointdefault) ### aws.ec2/verifiedaccessgroup -* [default](aws/aws.ec2/default/types.md#resource-awsec2verifiedaccessgroupdefault) +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2verifiedaccessgroupdefault) ### aws.ec2/verifiedaccessinstance -* [default](aws/aws.ec2/default/types.md#resource-awsec2verifiedaccessinstancedefault) +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2verifiedaccessinstancedefault) ### aws.ec2/verifiedaccesstrustprovider -* [default](aws/aws.ec2/default/types.md#resource-awsec2verifiedaccesstrustproviderdefault) +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2verifiedaccesstrustproviderdefault) ### aws.ec2/volume -* [default](aws/aws.ec2/default/types.md#resource-awsec2volumedefault) +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2volumedefault) ### aws.ec2/vpc -* [default](aws/aws.ec2/default/types.md#resource-awsec2vpcdefault) +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2vpcdefault) ### aws.ec2/vpcdhcpoptionsassociation -* [default](aws/aws.ec2/default/types.md#resource-awsec2vpcdhcpoptionsassociationdefault) +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2vpcdhcpoptionsassociationdefault) ### aws.ec2/vpcendpoint -* [default](aws/aws.ec2/default/types.md#resource-awsec2vpcendpointdefault) +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2vpcendpointdefault) ### aws.ec2/vpcendpointconnectionnotification -* [default](aws/aws.ec2/default/types.md#resource-awsec2vpcendpointconnectionnotificationdefault) +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2vpcendpointconnectionnotificationdefault) ### aws.ec2/vpcendpointservice -* [default](aws/aws.ec2/default/types.md#resource-awsec2vpcendpointservicedefault) +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2vpcendpointservicedefault) ### aws.ec2/vpcendpointservicepermissions -* [default](aws/aws.ec2/default/types.md#resource-awsec2vpcendpointservicepermissionsdefault) +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2vpcendpointservicepermissionsdefault) ### aws.ec2/vpcgatewayattachment -* [default](aws/aws.ec2/default/types.md#resource-awsec2vpcgatewayattachmentdefault) +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2vpcgatewayattachmentdefault) ### aws.ec2/vpcpeeringconnection -* [default](aws/aws.ec2/default/types.md#resource-awsec2vpcpeeringconnectiondefault) +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2vpcpeeringconnectiondefault) ### aws.ec2/vpnconnection -* [default](aws/aws.ec2/default/types.md#resource-awsec2vpnconnectiondefault) +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2vpnconnectiondefault) ### aws.ec2/vpngateway -* [default](aws/aws.ec2/default/types.md#resource-awsec2vpngatewaydefault) +* **Link**: [default](aws/aws.ec2/default/types.md#resource-awsec2vpngatewaydefault) ## aws.ecr ### aws.ecr/pullthroughcacherule -* [default](aws/aws.ecr/default/types.md#resource-awsecrpullthroughcacheruledefault) +* **Link**: [default](aws/aws.ecr/default/types.md#resource-awsecrpullthroughcacheruledefault) ### aws.ecr/registrypolicy -* [default](aws/aws.ecr/default/types.md#resource-awsecrregistrypolicydefault) +* **Link**: [default](aws/aws.ecr/default/types.md#resource-awsecrregistrypolicydefault) ### aws.ecr/replicationconfiguration -* [default](aws/aws.ecr/default/types.md#resource-awsecrreplicationconfigurationdefault) +* **Link**: [default](aws/aws.ecr/default/types.md#resource-awsecrreplicationconfigurationdefault) ### aws.ecr/repository -* [default](aws/aws.ecr/default/types.md#resource-awsecrrepositorydefault) +* **Link**: [default](aws/aws.ecr/default/types.md#resource-awsecrrepositorydefault) + +### aws.ecr/repositorycreationtemplate +* **Link**: [default](aws/aws.ecr/default/types.md#resource-awsecrrepositorycreationtemplatedefault) ## aws.ecs ### aws.ecs/capacityprovider -* [default](aws/aws.ecs/default/types.md#resource-awsecscapacityproviderdefault) +* **Link**: [default](aws/aws.ecs/default/types.md#resource-awsecscapacityproviderdefault) ### aws.ecs/cluster -* [default](aws/aws.ecs/default/types.md#resource-awsecsclusterdefault) +* **Link**: [default](aws/aws.ecs/default/types.md#resource-awsecsclusterdefault) ### aws.ecs/clustercapacityproviderassociations -* [default](aws/aws.ecs/default/types.md#resource-awsecsclustercapacityproviderassociationsdefault) +* **Link**: [default](aws/aws.ecs/default/types.md#resource-awsecsclustercapacityproviderassociationsdefault) ### aws.ecs/primarytaskset -* [default](aws/aws.ecs/default/types.md#resource-awsecsprimarytasksetdefault) +* **Link**: [default](aws/aws.ecs/default/types.md#resource-awsecsprimarytasksetdefault) ### aws.ecs/service -* [default](aws/aws.ecs/default/types.md#resource-awsecsservicedefault) +* **Link**: [default](aws/aws.ecs/default/types.md#resource-awsecsservicedefault) ### aws.ecs/taskdefinition -* [default](aws/aws.ecs/default/types.md#resource-awsecstaskdefinitiondefault) +* **Link**: [default](aws/aws.ecs/default/types.md#resource-awsecstaskdefinitiondefault) ### aws.ecs/taskset -* [default](aws/aws.ecs/default/types.md#resource-awsecstasksetdefault) +* **Link**: [default](aws/aws.ecs/default/types.md#resource-awsecstasksetdefault) ## aws.efs ### aws.efs/accesspoint -* [default](aws/aws.efs/default/types.md#resource-awsefsaccesspointdefault) +* **Link**: [default](aws/aws.efs/default/types.md#resource-awsefsaccesspointdefault) ### aws.efs/filesystem -* [default](aws/aws.efs/default/types.md#resource-awsefsfilesystemdefault) +* **Link**: [default](aws/aws.efs/default/types.md#resource-awsefsfilesystemdefault) ### aws.efs/mounttarget -* [default](aws/aws.efs/default/types.md#resource-awsefsmounttargetdefault) +* **Link**: [default](aws/aws.efs/default/types.md#resource-awsefsmounttargetdefault) ## aws.eks ### aws.eks/accessentry -* [default](aws/aws.eks/default/types.md#resource-awseksaccessentrydefault) +* **Link**: [default](aws/aws.eks/default/types.md#resource-awseksaccessentrydefault) ### aws.eks/addon -* [default](aws/aws.eks/default/types.md#resource-awseksaddondefault) +* **Link**: [default](aws/aws.eks/default/types.md#resource-awseksaddondefault) ### aws.eks/cluster -* [default](aws/aws.eks/default/types.md#resource-awseksclusterdefault) +* **Link**: [default](aws/aws.eks/default/types.md#resource-awseksclusterdefault) ### aws.eks/fargateprofile -* [default](aws/aws.eks/default/types.md#resource-awseksfargateprofiledefault) +* **Link**: [default](aws/aws.eks/default/types.md#resource-awseksfargateprofiledefault) ### aws.eks/identityproviderconfig -* [default](aws/aws.eks/default/types.md#resource-awseksidentityproviderconfigdefault) +* **Link**: [default](aws/aws.eks/default/types.md#resource-awseksidentityproviderconfigdefault) ### aws.eks/nodegroup -* [default](aws/aws.eks/default/types.md#resource-awseksnodegroupdefault) +* **Link**: [default](aws/aws.eks/default/types.md#resource-awseksnodegroupdefault) ### aws.eks/podidentityassociation -* [default](aws/aws.eks/default/types.md#resource-awsekspodidentityassociationdefault) +* **Link**: [default](aws/aws.eks/default/types.md#resource-awsekspodidentityassociationdefault) ## aws.elasticache ### aws.elasticache/globalreplicationgroup -* [default](aws/aws.elasticache/default/types.md#resource-awselasticacheglobalreplicationgroupdefault) +* **Link**: [default](aws/aws.elasticache/default/types.md#resource-awselasticacheglobalreplicationgroupdefault) + +### aws.elasticache/parametergroup +* **Link**: [default](aws/aws.elasticache/default/types.md#resource-awselasticacheparametergroupdefault) ### aws.elasticache/serverlesscache -* [default](aws/aws.elasticache/default/types.md#resource-awselasticacheserverlesscachedefault) +* **Link**: [default](aws/aws.elasticache/default/types.md#resource-awselasticacheserverlesscachedefault) ### aws.elasticache/subnetgroup -* [default](aws/aws.elasticache/default/types.md#resource-awselasticachesubnetgroupdefault) +* **Link**: [default](aws/aws.elasticache/default/types.md#resource-awselasticachesubnetgroupdefault) ### aws.elasticache/user -* [default](aws/aws.elasticache/default/types.md#resource-awselasticacheuserdefault) +* **Link**: [default](aws/aws.elasticache/default/types.md#resource-awselasticacheuserdefault) ### aws.elasticache/usergroup -* [default](aws/aws.elasticache/default/types.md#resource-awselasticacheusergroupdefault) +* **Link**: [default](aws/aws.elasticache/default/types.md#resource-awselasticacheusergroupdefault) ## aws.elasticbeanstalk ### aws.elasticbeanstalk/application -* [default](aws/aws.elasticbeanstalk/default/types.md#resource-awselasticbeanstalkapplicationdefault) +* **Link**: [default](aws/aws.elasticbeanstalk/default/types.md#resource-awselasticbeanstalkapplicationdefault) ### aws.elasticbeanstalk/applicationversion -* [default](aws/aws.elasticbeanstalk/default/types.md#resource-awselasticbeanstalkapplicationversiondefault) +* **Link**: [default](aws/aws.elasticbeanstalk/default/types.md#resource-awselasticbeanstalkapplicationversiondefault) ### aws.elasticbeanstalk/configurationtemplate -* [default](aws/aws.elasticbeanstalk/default/types.md#resource-awselasticbeanstalkconfigurationtemplatedefault) +* **Link**: [default](aws/aws.elasticbeanstalk/default/types.md#resource-awselasticbeanstalkconfigurationtemplatedefault) ### aws.elasticbeanstalk/environment -* [default](aws/aws.elasticbeanstalk/default/types.md#resource-awselasticbeanstalkenvironmentdefault) +* **Link**: [default](aws/aws.elasticbeanstalk/default/types.md#resource-awselasticbeanstalkenvironmentdefault) ## aws.elasticloadbalancingv2 ### aws.elasticloadbalancingv2/listener -* [default](aws/aws.elasticloadbalancingv2/default/types.md#resource-awselasticloadbalancingv2listenerdefault) +* **Link**: [default](aws/aws.elasticloadbalancingv2/default/types.md#resource-awselasticloadbalancingv2listenerdefault) ### aws.elasticloadbalancingv2/listenerrule -* [default](aws/aws.elasticloadbalancingv2/default/types.md#resource-awselasticloadbalancingv2listenerruledefault) +* **Link**: [default](aws/aws.elasticloadbalancingv2/default/types.md#resource-awselasticloadbalancingv2listenerruledefault) ### aws.elasticloadbalancingv2/loadbalancer -* [default](aws/aws.elasticloadbalancingv2/default/types.md#resource-awselasticloadbalancingv2loadbalancerdefault) +* **Link**: [default](aws/aws.elasticloadbalancingv2/default/types.md#resource-awselasticloadbalancingv2loadbalancerdefault) ### aws.elasticloadbalancingv2/targetgroup -* [default](aws/aws.elasticloadbalancingv2/default/types.md#resource-awselasticloadbalancingv2targetgroupdefault) +* **Link**: [default](aws/aws.elasticloadbalancingv2/default/types.md#resource-awselasticloadbalancingv2targetgroupdefault) ### aws.elasticloadbalancingv2/truststore -* [default](aws/aws.elasticloadbalancingv2/default/types.md#resource-awselasticloadbalancingv2truststoredefault) +* **Link**: [default](aws/aws.elasticloadbalancingv2/default/types.md#resource-awselasticloadbalancingv2truststoredefault) ## aws.emr ### aws.emr/studio -* [default](aws/aws.emr/default/types.md#resource-awsemrstudiodefault) +* **Link**: [default](aws/aws.emr/default/types.md#resource-awsemrstudiodefault) ### aws.emr/studiosessionmapping -* [default](aws/aws.emr/default/types.md#resource-awsemrstudiosessionmappingdefault) +* **Link**: [default](aws/aws.emr/default/types.md#resource-awsemrstudiosessionmappingdefault) ### aws.emr/walworkspace -* [default](aws/aws.emr/default/types.md#resource-awsemrwalworkspacedefault) +* **Link**: [default](aws/aws.emr/default/types.md#resource-awsemrwalworkspacedefault) ## aws.emrcontainers ### aws.emrcontainers/virtualcluster -* [default](aws/aws.emrcontainers/default/types.md#resource-awsemrcontainersvirtualclusterdefault) +* **Link**: [default](aws/aws.emrcontainers/default/types.md#resource-awsemrcontainersvirtualclusterdefault) ## aws.emrserverless ### aws.emrserverless/application -* [default](aws/aws.emrserverless/default/types.md#resource-awsemrserverlessapplicationdefault) +* **Link**: [default](aws/aws.emrserverless/default/types.md#resource-awsemrserverlessapplicationdefault) ## aws.entityresolution ### aws.entityresolution/idmappingworkflow -* [default](aws/aws.entityresolution/default/types.md#resource-awsentityresolutionidmappingworkflowdefault) +* **Link**: [default](aws/aws.entityresolution/default/types.md#resource-awsentityresolutionidmappingworkflowdefault) + +### aws.entityresolution/idnamespace +* **Link**: [default](aws/aws.entityresolution/default/types.md#resource-awsentityresolutionidnamespacedefault) ### aws.entityresolution/matchingworkflow -* [default](aws/aws.entityresolution/default/types.md#resource-awsentityresolutionmatchingworkflowdefault) +* **Link**: [default](aws/aws.entityresolution/default/types.md#resource-awsentityresolutionmatchingworkflowdefault) + +### aws.entityresolution/policystatement +* **Link**: [default](aws/aws.entityresolution/default/types.md#resource-awsentityresolutionpolicystatementdefault) ### aws.entityresolution/schemamapping -* [default](aws/aws.entityresolution/default/types.md#resource-awsentityresolutionschemamappingdefault) +* **Link**: [default](aws/aws.entityresolution/default/types.md#resource-awsentityresolutionschemamappingdefault) ## aws.events ### aws.events/apidestination -* [default](aws/aws.events/default/types.md#resource-awseventsapidestinationdefault) +* **Link**: [default](aws/aws.events/default/types.md#resource-awseventsapidestinationdefault) ### aws.events/archive -* [default](aws/aws.events/default/types.md#resource-awseventsarchivedefault) +* **Link**: [default](aws/aws.events/default/types.md#resource-awseventsarchivedefault) ### aws.events/connection -* [default](aws/aws.events/default/types.md#resource-awseventsconnectiondefault) +* **Link**: [default](aws/aws.events/default/types.md#resource-awseventsconnectiondefault) ### aws.events/endpoint -* [default](aws/aws.events/default/types.md#resource-awseventsendpointdefault) +* **Link**: [default](aws/aws.events/default/types.md#resource-awseventsendpointdefault) ### aws.events/eventbus -* [default](aws/aws.events/default/types.md#resource-awseventseventbusdefault) +* **Link**: [default](aws/aws.events/default/types.md#resource-awseventseventbusdefault) ### aws.events/rule -* [default](aws/aws.events/default/types.md#resource-awseventsruledefault) +* **Link**: [default](aws/aws.events/default/types.md#resource-awseventsruledefault) ## aws.eventschemas ### aws.eventschemas/discoverer -* [default](aws/aws.eventschemas/default/types.md#resource-awseventschemasdiscovererdefault) +* **Link**: [default](aws/aws.eventschemas/default/types.md#resource-awseventschemasdiscovererdefault) ### aws.eventschemas/registry -* [default](aws/aws.eventschemas/default/types.md#resource-awseventschemasregistrydefault) +* **Link**: [default](aws/aws.eventschemas/default/types.md#resource-awseventschemasregistrydefault) ### aws.eventschemas/registrypolicy -* [default](aws/aws.eventschemas/default/types.md#resource-awseventschemasregistrypolicydefault) +* **Link**: [default](aws/aws.eventschemas/default/types.md#resource-awseventschemasregistrypolicydefault) ### aws.eventschemas/schema -* [default](aws/aws.eventschemas/default/types.md#resource-awseventschemasschemadefault) +* **Link**: [default](aws/aws.eventschemas/default/types.md#resource-awseventschemasschemadefault) ## aws.evidently ### aws.evidently/experiment -* [default](aws/aws.evidently/default/types.md#resource-awsevidentlyexperimentdefault) +* **Link**: [default](aws/aws.evidently/default/types.md#resource-awsevidentlyexperimentdefault) ### aws.evidently/feature -* [default](aws/aws.evidently/default/types.md#resource-awsevidentlyfeaturedefault) +* **Link**: [default](aws/aws.evidently/default/types.md#resource-awsevidentlyfeaturedefault) ### aws.evidently/launch -* [default](aws/aws.evidently/default/types.md#resource-awsevidentlylaunchdefault) +* **Link**: [default](aws/aws.evidently/default/types.md#resource-awsevidentlylaunchdefault) ### aws.evidently/project -* [default](aws/aws.evidently/default/types.md#resource-awsevidentlyprojectdefault) +* **Link**: [default](aws/aws.evidently/default/types.md#resource-awsevidentlyprojectdefault) ## aws.finspace ### aws.finspace/environment -* [default](aws/aws.finspace/default/types.md#resource-awsfinspaceenvironmentdefault) +* **Link**: [default](aws/aws.finspace/default/types.md#resource-awsfinspaceenvironmentdefault) ## aws.fis ### aws.fis/experimenttemplate -* [default](aws/aws.fis/default/types.md#resource-awsfisexperimenttemplatedefault) +* **Link**: [default](aws/aws.fis/default/types.md#resource-awsfisexperimenttemplatedefault) ### aws.fis/targetaccountconfiguration -* [default](aws/aws.fis/default/types.md#resource-awsfistargetaccountconfigurationdefault) +* **Link**: [default](aws/aws.fis/default/types.md#resource-awsfistargetaccountconfigurationdefault) ## aws.fms ### aws.fms/notificationchannel -* [default](aws/aws.fms/default/types.md#resource-awsfmsnotificationchanneldefault) +* **Link**: [default](aws/aws.fms/default/types.md#resource-awsfmsnotificationchanneldefault) ### aws.fms/policy -* [default](aws/aws.fms/default/types.md#resource-awsfmspolicydefault) +* **Link**: [default](aws/aws.fms/default/types.md#resource-awsfmspolicydefault) ### aws.fms/resourceset -* [default](aws/aws.fms/default/types.md#resource-awsfmsresourcesetdefault) +* **Link**: [default](aws/aws.fms/default/types.md#resource-awsfmsresourcesetdefault) ## aws.forecast ### aws.forecast/datasetgroup -* [default](aws/aws.forecast/default/types.md#resource-awsforecastdatasetgroupdefault) +* **Link**: [default](aws/aws.forecast/default/types.md#resource-awsforecastdatasetgroupdefault) ## aws.frauddetector ### aws.frauddetector/detector -* [default](aws/aws.frauddetector/default/types.md#resource-awsfrauddetectordetectordefault) +* **Link**: [default](aws/aws.frauddetector/default/types.md#resource-awsfrauddetectordetectordefault) ### aws.frauddetector/entitytype -* [default](aws/aws.frauddetector/default/types.md#resource-awsfrauddetectorentitytypedefault) +* **Link**: [default](aws/aws.frauddetector/default/types.md#resource-awsfrauddetectorentitytypedefault) ### aws.frauddetector/eventtype -* [default](aws/aws.frauddetector/default/types.md#resource-awsfrauddetectoreventtypedefault) +* **Link**: [default](aws/aws.frauddetector/default/types.md#resource-awsfrauddetectoreventtypedefault) ### aws.frauddetector/label -* [default](aws/aws.frauddetector/default/types.md#resource-awsfrauddetectorlabeldefault) +* **Link**: [default](aws/aws.frauddetector/default/types.md#resource-awsfrauddetectorlabeldefault) ### aws.frauddetector/list -* [default](aws/aws.frauddetector/default/types.md#resource-awsfrauddetectorlistdefault) +* **Link**: [default](aws/aws.frauddetector/default/types.md#resource-awsfrauddetectorlistdefault) ### aws.frauddetector/outcome -* [default](aws/aws.frauddetector/default/types.md#resource-awsfrauddetectoroutcomedefault) +* **Link**: [default](aws/aws.frauddetector/default/types.md#resource-awsfrauddetectoroutcomedefault) ### aws.frauddetector/variable -* [default](aws/aws.frauddetector/default/types.md#resource-awsfrauddetectorvariabledefault) +* **Link**: [default](aws/aws.frauddetector/default/types.md#resource-awsfrauddetectorvariabledefault) ## aws.fsx ### aws.fsx/datarepositoryassociation -* [default](aws/aws.fsx/default/types.md#resource-awsfsxdatarepositoryassociationdefault) +* **Link**: [default](aws/aws.fsx/default/types.md#resource-awsfsxdatarepositoryassociationdefault) ## aws.gamelift ### aws.gamelift/alias -* [default](aws/aws.gamelift/default/types.md#resource-awsgameliftaliasdefault) +* **Link**: [default](aws/aws.gamelift/default/types.md#resource-awsgameliftaliasdefault) ### aws.gamelift/build -* [default](aws/aws.gamelift/default/types.md#resource-awsgameliftbuilddefault) +* **Link**: [default](aws/aws.gamelift/default/types.md#resource-awsgameliftbuilddefault) + +### aws.gamelift/containergroupdefinition +* **Link**: [default](aws/aws.gamelift/default/types.md#resource-awsgameliftcontainergroupdefinitiondefault) ### aws.gamelift/fleet -* [default](aws/aws.gamelift/default/types.md#resource-awsgameliftfleetdefault) +* **Link**: [default](aws/aws.gamelift/default/types.md#resource-awsgameliftfleetdefault) ### aws.gamelift/gameservergroup -* [default](aws/aws.gamelift/default/types.md#resource-awsgameliftgameservergroupdefault) +* **Link**: [default](aws/aws.gamelift/default/types.md#resource-awsgameliftgameservergroupdefault) ### aws.gamelift/gamesessionqueue -* [default](aws/aws.gamelift/default/types.md#resource-awsgameliftgamesessionqueuedefault) +* **Link**: [default](aws/aws.gamelift/default/types.md#resource-awsgameliftgamesessionqueuedefault) ### aws.gamelift/location -* [default](aws/aws.gamelift/default/types.md#resource-awsgameliftlocationdefault) +* **Link**: [default](aws/aws.gamelift/default/types.md#resource-awsgameliftlocationdefault) ### aws.gamelift/matchmakingconfiguration -* [default](aws/aws.gamelift/default/types.md#resource-awsgameliftmatchmakingconfigurationdefault) +* **Link**: [default](aws/aws.gamelift/default/types.md#resource-awsgameliftmatchmakingconfigurationdefault) ### aws.gamelift/matchmakingruleset -* [default](aws/aws.gamelift/default/types.md#resource-awsgameliftmatchmakingrulesetdefault) +* **Link**: [default](aws/aws.gamelift/default/types.md#resource-awsgameliftmatchmakingrulesetdefault) ### aws.gamelift/script -* [default](aws/aws.gamelift/default/types.md#resource-awsgameliftscriptdefault) +* **Link**: [default](aws/aws.gamelift/default/types.md#resource-awsgameliftscriptdefault) ## aws.globalaccelerator ### aws.globalaccelerator/accelerator -* [default](aws/aws.globalaccelerator/default/types.md#resource-awsglobalacceleratoracceleratordefault) +* **Link**: [default](aws/aws.globalaccelerator/default/types.md#resource-awsglobalacceleratoracceleratordefault) + +### aws.globalaccelerator/crossaccountattachment +* **Link**: [default](aws/aws.globalaccelerator/default/types.md#resource-awsglobalacceleratorcrossaccountattachmentdefault) ### aws.globalaccelerator/endpointgroup -* [default](aws/aws.globalaccelerator/default/types.md#resource-awsglobalacceleratorendpointgroupdefault) +* **Link**: [default](aws/aws.globalaccelerator/default/types.md#resource-awsglobalacceleratorendpointgroupdefault) ### aws.globalaccelerator/listener -* [default](aws/aws.globalaccelerator/default/types.md#resource-awsglobalacceleratorlistenerdefault) +* **Link**: [default](aws/aws.globalaccelerator/default/types.md#resource-awsglobalacceleratorlistenerdefault) ## aws.glue ### aws.glue/registry -* [default](aws/aws.glue/default/types.md#resource-awsglueregistrydefault) +* **Link**: [default](aws/aws.glue/default/types.md#resource-awsglueregistrydefault) ### aws.glue/schema -* [default](aws/aws.glue/default/types.md#resource-awsglueschemadefault) +* **Link**: [default](aws/aws.glue/default/types.md#resource-awsglueschemadefault) ## aws.grafana ### aws.grafana/workspace -* [default](aws/aws.grafana/default/types.md#resource-awsgrafanaworkspacedefault) +* **Link**: [default](aws/aws.grafana/default/types.md#resource-awsgrafanaworkspacedefault) ## aws.greengrassv2 ### aws.greengrassv2/componentversion -* [default](aws/aws.greengrassv2/default/types.md#resource-awsgreengrassv2componentversiondefault) +* **Link**: [default](aws/aws.greengrassv2/default/types.md#resource-awsgreengrassv2componentversiondefault) ### aws.greengrassv2/deployment -* [default](aws/aws.greengrassv2/default/types.md#resource-awsgreengrassv2deploymentdefault) +* **Link**: [default](aws/aws.greengrassv2/default/types.md#resource-awsgreengrassv2deploymentdefault) ## aws.groundstation ### aws.groundstation/config -* [default](aws/aws.groundstation/default/types.md#resource-awsgroundstationconfigdefault) +* **Link**: [default](aws/aws.groundstation/default/types.md#resource-awsgroundstationconfigdefault) ### aws.groundstation/missionprofile -* [default](aws/aws.groundstation/default/types.md#resource-awsgroundstationmissionprofiledefault) +* **Link**: [default](aws/aws.groundstation/default/types.md#resource-awsgroundstationmissionprofiledefault) ## aws.guardduty ### aws.guardduty/detector -* [default](aws/aws.guardduty/default/types.md#resource-awsguarddutydetectordefault) +* **Link**: [default](aws/aws.guardduty/default/types.md#resource-awsguarddutydetectordefault) + +### aws.guardduty/filter +* **Link**: [default](aws/aws.guardduty/default/types.md#resource-awsguarddutyfilterdefault) ### aws.guardduty/ipset -* [default](aws/aws.guardduty/default/types.md#resource-awsguarddutyipsetdefault) +* **Link**: [default](aws/aws.guardduty/default/types.md#resource-awsguarddutyipsetdefault) + +### aws.guardduty/malwareprotectionplan +* **Link**: [default](aws/aws.guardduty/default/types.md#resource-awsguarddutymalwareprotectionplandefault) + +### aws.guardduty/member +* **Link**: [default](aws/aws.guardduty/default/types.md#resource-awsguarddutymemberdefault) ### aws.guardduty/threatintelset -* [default](aws/aws.guardduty/default/types.md#resource-awsguarddutythreatintelsetdefault) +* **Link**: [default](aws/aws.guardduty/default/types.md#resource-awsguarddutythreatintelsetdefault) ## aws.healthlake ### aws.healthlake/fhirdatastore -* [default](aws/aws.healthlake/default/types.md#resource-awshealthlakefhirdatastoredefault) +* **Link**: [default](aws/aws.healthlake/default/types.md#resource-awshealthlakefhirdatastoredefault) ## aws.iam ### aws.iam/group -* [default](aws/aws.iam/default/types.md#resource-awsiamgroupdefault) +* **Link**: [default](aws/aws.iam/default/types.md#resource-awsiamgroupdefault) ### aws.iam/grouppolicy -* [default](aws/aws.iam/default/types.md#resource-awsiamgrouppolicydefault) +* **Link**: [default](aws/aws.iam/default/types.md#resource-awsiamgrouppolicydefault) ### aws.iam/instanceprofile -* [default](aws/aws.iam/default/types.md#resource-awsiaminstanceprofiledefault) +* **Link**: [default](aws/aws.iam/default/types.md#resource-awsiaminstanceprofiledefault) ### aws.iam/managedpolicy -* [default](aws/aws.iam/default/types.md#resource-awsiammanagedpolicydefault) +* **Link**: [default](aws/aws.iam/default/types.md#resource-awsiammanagedpolicydefault) ### aws.iam/oidcprovider -* [default](aws/aws.iam/default/types.md#resource-awsiamoidcproviderdefault) +* **Link**: [default](aws/aws.iam/default/types.md#resource-awsiamoidcproviderdefault) ### aws.iam/role -* [default](aws/aws.iam/default/types.md#resource-awsiamroledefault) +* **Link**: [default](aws/aws.iam/default/types.md#resource-awsiamroledefault) ### aws.iam/rolepolicy -* [default](aws/aws.iam/default/types.md#resource-awsiamrolepolicydefault) +* **Link**: [default](aws/aws.iam/default/types.md#resource-awsiamrolepolicydefault) ### aws.iam/samlprovider -* [default](aws/aws.iam/default/types.md#resource-awsiamsamlproviderdefault) +* **Link**: [default](aws/aws.iam/default/types.md#resource-awsiamsamlproviderdefault) ### aws.iam/servercertificate -* [default](aws/aws.iam/default/types.md#resource-awsiamservercertificatedefault) +* **Link**: [default](aws/aws.iam/default/types.md#resource-awsiamservercertificatedefault) ### aws.iam/servicelinkedrole -* [default](aws/aws.iam/default/types.md#resource-awsiamservicelinkedroledefault) +* **Link**: [default](aws/aws.iam/default/types.md#resource-awsiamservicelinkedroledefault) ### aws.iam/user -* [default](aws/aws.iam/default/types.md#resource-awsiamuserdefault) +* **Link**: [default](aws/aws.iam/default/types.md#resource-awsiamuserdefault) ### aws.iam/userpolicy -* [default](aws/aws.iam/default/types.md#resource-awsiamuserpolicydefault) +* **Link**: [default](aws/aws.iam/default/types.md#resource-awsiamuserpolicydefault) ### aws.iam/virtualmfadevice -* [default](aws/aws.iam/default/types.md#resource-awsiamvirtualmfadevicedefault) +* **Link**: [default](aws/aws.iam/default/types.md#resource-awsiamvirtualmfadevicedefault) ## aws.identitystore ### aws.identitystore/group -* [default](aws/aws.identitystore/default/types.md#resource-awsidentitystoregroupdefault) +* **Link**: [default](aws/aws.identitystore/default/types.md#resource-awsidentitystoregroupdefault) ## aws.imagebuilder ### aws.imagebuilder/distributionconfiguration -* [default](aws/aws.imagebuilder/default/types.md#resource-awsimagebuilderdistributionconfigurationdefault) +* **Link**: [default](aws/aws.imagebuilder/default/types.md#resource-awsimagebuilderdistributionconfigurationdefault) ### aws.imagebuilder/imagepipeline -* [default](aws/aws.imagebuilder/default/types.md#resource-awsimagebuilderimagepipelinedefault) +* **Link**: [default](aws/aws.imagebuilder/default/types.md#resource-awsimagebuilderimagepipelinedefault) ### aws.imagebuilder/infrastructureconfiguration -* [default](aws/aws.imagebuilder/default/types.md#resource-awsimagebuilderinfrastructureconfigurationdefault) +* **Link**: [default](aws/aws.imagebuilder/default/types.md#resource-awsimagebuilderinfrastructureconfigurationdefault) ### aws.imagebuilder/lifecyclepolicy -* [default](aws/aws.imagebuilder/default/types.md#resource-awsimagebuilderlifecyclepolicydefault) +* **Link**: [default](aws/aws.imagebuilder/default/types.md#resource-awsimagebuilderlifecyclepolicydefault) ## aws.inspector ### aws.inspector/assessmenttarget -* [default](aws/aws.inspector/default/types.md#resource-awsinspectorassessmenttargetdefault) +* **Link**: [default](aws/aws.inspector/default/types.md#resource-awsinspectorassessmenttargetdefault) ## aws.inspectorv2 +### aws.inspectorv2/cisscanconfiguration +* **Link**: [default](aws/aws.inspectorv2/default/types.md#resource-awsinspectorv2cisscanconfigurationdefault) + ### aws.inspectorv2/filter -* [default](aws/aws.inspectorv2/default/types.md#resource-awsinspectorv2filterdefault) +* **Link**: [default](aws/aws.inspectorv2/default/types.md#resource-awsinspectorv2filterdefault) ## aws.internetmonitor ### aws.internetmonitor/monitor -* [default](aws/aws.internetmonitor/default/types.md#resource-awsinternetmonitormonitordefault) +* **Link**: [default](aws/aws.internetmonitor/default/types.md#resource-awsinternetmonitormonitordefault) ## aws.iot ### aws.iot/accountauditconfiguration -* [default](aws/aws.iot/default/types.md#resource-awsiotaccountauditconfigurationdefault) +* **Link**: [default](aws/aws.iot/default/types.md#resource-awsiotaccountauditconfigurationdefault) ### aws.iot/authorizer -* [default](aws/aws.iot/default/types.md#resource-awsiotauthorizerdefault) +* **Link**: [default](aws/aws.iot/default/types.md#resource-awsiotauthorizerdefault) ### aws.iot/billinggroup -* [default](aws/aws.iot/default/types.md#resource-awsiotbillinggroupdefault) +* **Link**: [default](aws/aws.iot/default/types.md#resource-awsiotbillinggroupdefault) ### aws.iot/cacertificate -* [default](aws/aws.iot/default/types.md#resource-awsiotcacertificatedefault) +* **Link**: [default](aws/aws.iot/default/types.md#resource-awsiotcacertificatedefault) ### aws.iot/certificate -* [default](aws/aws.iot/default/types.md#resource-awsiotcertificatedefault) +* **Link**: [default](aws/aws.iot/default/types.md#resource-awsiotcertificatedefault) ### aws.iot/certificateprovider -* [default](aws/aws.iot/default/types.md#resource-awsiotcertificateproviderdefault) +* **Link**: [default](aws/aws.iot/default/types.md#resource-awsiotcertificateproviderdefault) ### aws.iot/custommetric -* [default](aws/aws.iot/default/types.md#resource-awsiotcustommetricdefault) +* **Link**: [default](aws/aws.iot/default/types.md#resource-awsiotcustommetricdefault) ### aws.iot/dimension -* [default](aws/aws.iot/default/types.md#resource-awsiotdimensiondefault) +* **Link**: [default](aws/aws.iot/default/types.md#resource-awsiotdimensiondefault) ### aws.iot/domainconfiguration -* [default](aws/aws.iot/default/types.md#resource-awsiotdomainconfigurationdefault) +* **Link**: [default](aws/aws.iot/default/types.md#resource-awsiotdomainconfigurationdefault) ### aws.iot/fleetmetric -* [default](aws/aws.iot/default/types.md#resource-awsiotfleetmetricdefault) +* **Link**: [default](aws/aws.iot/default/types.md#resource-awsiotfleetmetricdefault) ### aws.iot/logging -* [default](aws/aws.iot/default/types.md#resource-awsiotloggingdefault) +* **Link**: [default](aws/aws.iot/default/types.md#resource-awsiotloggingdefault) ### aws.iot/mitigationaction -* [default](aws/aws.iot/default/types.md#resource-awsiotmitigationactiondefault) +* **Link**: [default](aws/aws.iot/default/types.md#resource-awsiotmitigationactiondefault) ### aws.iot/policy -* [default](aws/aws.iot/default/types.md#resource-awsiotpolicydefault) +* **Link**: [default](aws/aws.iot/default/types.md#resource-awsiotpolicydefault) ### aws.iot/provisioningtemplate -* [default](aws/aws.iot/default/types.md#resource-awsiotprovisioningtemplatedefault) +* **Link**: [default](aws/aws.iot/default/types.md#resource-awsiotprovisioningtemplatedefault) ### aws.iot/resourcespecificlogging -* [default](aws/aws.iot/default/types.md#resource-awsiotresourcespecificloggingdefault) +* **Link**: [default](aws/aws.iot/default/types.md#resource-awsiotresourcespecificloggingdefault) ### aws.iot/rolealias -* [default](aws/aws.iot/default/types.md#resource-awsiotrolealiasdefault) +* **Link**: [default](aws/aws.iot/default/types.md#resource-awsiotrolealiasdefault) ### aws.iot/scheduledaudit -* [default](aws/aws.iot/default/types.md#resource-awsiotscheduledauditdefault) +* **Link**: [default](aws/aws.iot/default/types.md#resource-awsiotscheduledauditdefault) ### aws.iot/securityprofile -* [default](aws/aws.iot/default/types.md#resource-awsiotsecurityprofiledefault) +* **Link**: [default](aws/aws.iot/default/types.md#resource-awsiotsecurityprofiledefault) ### aws.iot/softwarepackage -* [default](aws/aws.iot/default/types.md#resource-awsiotsoftwarepackagedefault) +* **Link**: [default](aws/aws.iot/default/types.md#resource-awsiotsoftwarepackagedefault) ### aws.iot/softwarepackageversion -* [default](aws/aws.iot/default/types.md#resource-awsiotsoftwarepackageversiondefault) +* **Link**: [default](aws/aws.iot/default/types.md#resource-awsiotsoftwarepackageversiondefault) ### aws.iot/thing -* [default](aws/aws.iot/default/types.md#resource-awsiotthingdefault) +* **Link**: [default](aws/aws.iot/default/types.md#resource-awsiotthingdefault) ### aws.iot/thinggroup -* [default](aws/aws.iot/default/types.md#resource-awsiotthinggroupdefault) +* **Link**: [default](aws/aws.iot/default/types.md#resource-awsiotthinggroupdefault) ### aws.iot/thingtype -* [default](aws/aws.iot/default/types.md#resource-awsiotthingtypedefault) +* **Link**: [default](aws/aws.iot/default/types.md#resource-awsiotthingtypedefault) ### aws.iot/topicrule -* [default](aws/aws.iot/default/types.md#resource-awsiottopicruledefault) +* **Link**: [default](aws/aws.iot/default/types.md#resource-awsiottopicruledefault) ### aws.iot/topicruledestination -* [default](aws/aws.iot/default/types.md#resource-awsiottopicruledestinationdefault) +* **Link**: [default](aws/aws.iot/default/types.md#resource-awsiottopicruledestinationdefault) ## aws.iotanalytics ### aws.iotanalytics/channel -* [default](aws/aws.iotanalytics/default/types.md#resource-awsiotanalyticschanneldefault) +* **Link**: [default](aws/aws.iotanalytics/default/types.md#resource-awsiotanalyticschanneldefault) ### aws.iotanalytics/dataset -* [default](aws/aws.iotanalytics/default/types.md#resource-awsiotanalyticsdatasetdefault) +* **Link**: [default](aws/aws.iotanalytics/default/types.md#resource-awsiotanalyticsdatasetdefault) ### aws.iotanalytics/datastore -* [default](aws/aws.iotanalytics/default/types.md#resource-awsiotanalyticsdatastoredefault) +* **Link**: [default](aws/aws.iotanalytics/default/types.md#resource-awsiotanalyticsdatastoredefault) ### aws.iotanalytics/pipeline -* [default](aws/aws.iotanalytics/default/types.md#resource-awsiotanalyticspipelinedefault) +* **Link**: [default](aws/aws.iotanalytics/default/types.md#resource-awsiotanalyticspipelinedefault) ## aws.iotcoredeviceadvisor ### aws.iotcoredeviceadvisor/suitedefinition -* [default](aws/aws.iotcoredeviceadvisor/default/types.md#resource-awsiotcoredeviceadvisorsuitedefinitiondefault) +* **Link**: [default](aws/aws.iotcoredeviceadvisor/default/types.md#resource-awsiotcoredeviceadvisorsuitedefinitiondefault) ## aws.iotevents ### aws.iotevents/alarmmodel -* [default](aws/aws.iotevents/default/types.md#resource-awsioteventsalarmmodeldefault) +* **Link**: [default](aws/aws.iotevents/default/types.md#resource-awsioteventsalarmmodeldefault) ### aws.iotevents/detectormodel -* [default](aws/aws.iotevents/default/types.md#resource-awsioteventsdetectormodeldefault) +* **Link**: [default](aws/aws.iotevents/default/types.md#resource-awsioteventsdetectormodeldefault) ### aws.iotevents/input -* [default](aws/aws.iotevents/default/types.md#resource-awsioteventsinputdefault) +* **Link**: [default](aws/aws.iotevents/default/types.md#resource-awsioteventsinputdefault) ## aws.iotfleethub ### aws.iotfleethub/application -* [default](aws/aws.iotfleethub/default/types.md#resource-awsiotfleethubapplicationdefault) +* **Link**: [default](aws/aws.iotfleethub/default/types.md#resource-awsiotfleethubapplicationdefault) ## aws.iotsitewise ### aws.iotsitewise/accesspolicy -* [default](aws/aws.iotsitewise/default/types.md#resource-awsiotsitewiseaccesspolicydefault) +* **Link**: [default](aws/aws.iotsitewise/default/types.md#resource-awsiotsitewiseaccesspolicydefault) ### aws.iotsitewise/asset -* [default](aws/aws.iotsitewise/default/types.md#resource-awsiotsitewiseassetdefault) +* **Link**: [default](aws/aws.iotsitewise/default/types.md#resource-awsiotsitewiseassetdefault) ### aws.iotsitewise/assetmodel -* [default](aws/aws.iotsitewise/default/types.md#resource-awsiotsitewiseassetmodeldefault) +* **Link**: [default](aws/aws.iotsitewise/default/types.md#resource-awsiotsitewiseassetmodeldefault) ### aws.iotsitewise/dashboard -* [default](aws/aws.iotsitewise/default/types.md#resource-awsiotsitewisedashboarddefault) +* **Link**: [default](aws/aws.iotsitewise/default/types.md#resource-awsiotsitewisedashboarddefault) ### aws.iotsitewise/gateway -* [default](aws/aws.iotsitewise/default/types.md#resource-awsiotsitewisegatewaydefault) +* **Link**: [default](aws/aws.iotsitewise/default/types.md#resource-awsiotsitewisegatewaydefault) ### aws.iotsitewise/portal -* [default](aws/aws.iotsitewise/default/types.md#resource-awsiotsitewiseportaldefault) +* **Link**: [default](aws/aws.iotsitewise/default/types.md#resource-awsiotsitewiseportaldefault) ### aws.iotsitewise/project -* [default](aws/aws.iotsitewise/default/types.md#resource-awsiotsitewiseprojectdefault) +* **Link**: [default](aws/aws.iotsitewise/default/types.md#resource-awsiotsitewiseprojectdefault) ## aws.iottwinmaker ### aws.iottwinmaker/componenttype -* [default](aws/aws.iottwinmaker/default/types.md#resource-awsiottwinmakercomponenttypedefault) +* **Link**: [default](aws/aws.iottwinmaker/default/types.md#resource-awsiottwinmakercomponenttypedefault) ### aws.iottwinmaker/entity -* [default](aws/aws.iottwinmaker/default/types.md#resource-awsiottwinmakerentitydefault) +* **Link**: [default](aws/aws.iottwinmaker/default/types.md#resource-awsiottwinmakerentitydefault) ### aws.iottwinmaker/scene -* [default](aws/aws.iottwinmaker/default/types.md#resource-awsiottwinmakerscenedefault) +* **Link**: [default](aws/aws.iottwinmaker/default/types.md#resource-awsiottwinmakerscenedefault) ### aws.iottwinmaker/workspace -* [default](aws/aws.iottwinmaker/default/types.md#resource-awsiottwinmakerworkspacedefault) +* **Link**: [default](aws/aws.iottwinmaker/default/types.md#resource-awsiottwinmakerworkspacedefault) ## aws.iotwireless ### aws.iotwireless/destination -* [default](aws/aws.iotwireless/default/types.md#resource-awsiotwirelessdestinationdefault) +* **Link**: [default](aws/aws.iotwireless/default/types.md#resource-awsiotwirelessdestinationdefault) ### aws.iotwireless/fuotatask -* [default](aws/aws.iotwireless/default/types.md#resource-awsiotwirelessfuotataskdefault) +* **Link**: [default](aws/aws.iotwireless/default/types.md#resource-awsiotwirelessfuotataskdefault) ### aws.iotwireless/multicastgroup -* [default](aws/aws.iotwireless/default/types.md#resource-awsiotwirelessmulticastgroupdefault) +* **Link**: [default](aws/aws.iotwireless/default/types.md#resource-awsiotwirelessmulticastgroupdefault) ### aws.iotwireless/networkanalyzerconfiguration -* [default](aws/aws.iotwireless/default/types.md#resource-awsiotwirelessnetworkanalyzerconfigurationdefault) +* **Link**: [default](aws/aws.iotwireless/default/types.md#resource-awsiotwirelessnetworkanalyzerconfigurationdefault) ### aws.iotwireless/wirelessdevice -* [default](aws/aws.iotwireless/default/types.md#resource-awsiotwirelesswirelessdevicedefault) +* **Link**: [default](aws/aws.iotwireless/default/types.md#resource-awsiotwirelesswirelessdevicedefault) ### aws.iotwireless/wirelessgateway -* [default](aws/aws.iotwireless/default/types.md#resource-awsiotwirelesswirelessgatewaydefault) +* **Link**: [default](aws/aws.iotwireless/default/types.md#resource-awsiotwirelesswirelessgatewaydefault) ## aws.ivs ### aws.ivs/channel -* [default](aws/aws.ivs/default/types.md#resource-awsivschanneldefault) +* **Link**: [default](aws/aws.ivs/default/types.md#resource-awsivschanneldefault) + +### aws.ivs/encoderconfiguration +* **Link**: [default](aws/aws.ivs/default/types.md#resource-awsivsencoderconfigurationdefault) ### aws.ivs/playbackkeypair -* [default](aws/aws.ivs/default/types.md#resource-awsivsplaybackkeypairdefault) +* **Link**: [default](aws/aws.ivs/default/types.md#resource-awsivsplaybackkeypairdefault) + +### aws.ivs/playbackrestrictionpolicy +* **Link**: [default](aws/aws.ivs/default/types.md#resource-awsivsplaybackrestrictionpolicydefault) ### aws.ivs/recordingconfiguration -* [default](aws/aws.ivs/default/types.md#resource-awsivsrecordingconfigurationdefault) +* **Link**: [default](aws/aws.ivs/default/types.md#resource-awsivsrecordingconfigurationdefault) + +### aws.ivs/stage +* **Link**: [default](aws/aws.ivs/default/types.md#resource-awsivsstagedefault) + +### aws.ivs/storageconfiguration +* **Link**: [default](aws/aws.ivs/default/types.md#resource-awsivsstorageconfigurationdefault) ### aws.ivs/streamkey -* [default](aws/aws.ivs/default/types.md#resource-awsivsstreamkeydefault) +* **Link**: [default](aws/aws.ivs/default/types.md#resource-awsivsstreamkeydefault) ## aws.ivschat ### aws.ivschat/loggingconfiguration -* [default](aws/aws.ivschat/default/types.md#resource-awsivschatloggingconfigurationdefault) +* **Link**: [default](aws/aws.ivschat/default/types.md#resource-awsivschatloggingconfigurationdefault) ### aws.ivschat/room -* [default](aws/aws.ivschat/default/types.md#resource-awsivschatroomdefault) +* **Link**: [default](aws/aws.ivschat/default/types.md#resource-awsivschatroomdefault) ## aws.kafkaconnect ### aws.kafkaconnect/connector -* [default](aws/aws.kafkaconnect/default/types.md#resource-awskafkaconnectconnectordefault) +* **Link**: [default](aws/aws.kafkaconnect/default/types.md#resource-awskafkaconnectconnectordefault) + +### aws.kafkaconnect/customplugin +* **Link**: [default](aws/aws.kafkaconnect/default/types.md#resource-awskafkaconnectcustomplugindefault) + +### aws.kafkaconnect/workerconfiguration +* **Link**: [default](aws/aws.kafkaconnect/default/types.md#resource-awskafkaconnectworkerconfigurationdefault) ## aws.kendra ### aws.kendra/datasource -* [default](aws/aws.kendra/default/types.md#resource-awskendradatasourcedefault) +* **Link**: [default](aws/aws.kendra/default/types.md#resource-awskendradatasourcedefault) ### aws.kendra/faq -* [default](aws/aws.kendra/default/types.md#resource-awskendrafaqdefault) +* **Link**: [default](aws/aws.kendra/default/types.md#resource-awskendrafaqdefault) ### aws.kendra/index -* [default](aws/aws.kendra/default/types.md#resource-awskendraindexdefault) +* **Link**: [default](aws/aws.kendra/default/types.md#resource-awskendraindexdefault) ## aws.kendraranking ### aws.kendraranking/executionplan -* [default](aws/aws.kendraranking/default/types.md#resource-awskendrarankingexecutionplandefault) +* **Link**: [default](aws/aws.kendraranking/default/types.md#resource-awskendrarankingexecutionplandefault) ## aws.kinesis ### aws.kinesis/stream -* [default](aws/aws.kinesis/default/types.md#resource-awskinesisstreamdefault) +* **Link**: [default](aws/aws.kinesis/default/types.md#resource-awskinesisstreamdefault) ## aws.kinesisanalyticsv2 ### aws.kinesisanalyticsv2/application -* [default](aws/aws.kinesisanalyticsv2/default/types.md#resource-awskinesisanalyticsv2applicationdefault) +* **Link**: [default](aws/aws.kinesisanalyticsv2/default/types.md#resource-awskinesisanalyticsv2applicationdefault) ## aws.kinesisfirehose ### aws.kinesisfirehose/deliverystream -* [default](aws/aws.kinesisfirehose/default/types.md#resource-awskinesisfirehosedeliverystreamdefault) +* **Link**: [default](aws/aws.kinesisfirehose/default/types.md#resource-awskinesisfirehosedeliverystreamdefault) ## aws.kinesisvideo ### aws.kinesisvideo/signalingchannel -* [default](aws/aws.kinesisvideo/default/types.md#resource-awskinesisvideosignalingchanneldefault) +* **Link**: [default](aws/aws.kinesisvideo/default/types.md#resource-awskinesisvideosignalingchanneldefault) ### aws.kinesisvideo/stream -* [default](aws/aws.kinesisvideo/default/types.md#resource-awskinesisvideostreamdefault) +* **Link**: [default](aws/aws.kinesisvideo/default/types.md#resource-awskinesisvideostreamdefault) ## aws.kms ### aws.kms/alias -* [default](aws/aws.kms/default/types.md#resource-awskmsaliasdefault) +* **Link**: [default](aws/aws.kms/default/types.md#resource-awskmsaliasdefault) ### aws.kms/key -* [default](aws/aws.kms/default/types.md#resource-awskmskeydefault) +* **Link**: [default](aws/aws.kms/default/types.md#resource-awskmskeydefault) ### aws.kms/replicakey -* [default](aws/aws.kms/default/types.md#resource-awskmsreplicakeydefault) +* **Link**: [default](aws/aws.kms/default/types.md#resource-awskmsreplicakeydefault) ## aws.lakeformation ### aws.lakeformation/tag -* [default](aws/aws.lakeformation/default/types.md#resource-awslakeformationtagdefault) +* **Link**: [default](aws/aws.lakeformation/default/types.md#resource-awslakeformationtagdefault) ## aws.lambda ### aws.lambda/codesigningconfig -* [default](aws/aws.lambda/default/types.md#resource-awslambdacodesigningconfigdefault) +* **Link**: [default](aws/aws.lambda/default/types.md#resource-awslambdacodesigningconfigdefault) ### aws.lambda/eventinvokeconfig -* [default](aws/aws.lambda/default/types.md#resource-awslambdaeventinvokeconfigdefault) +* **Link**: [default](aws/aws.lambda/default/types.md#resource-awslambdaeventinvokeconfigdefault) ### aws.lambda/eventsourcemapping -* [default](aws/aws.lambda/default/types.md#resource-awslambdaeventsourcemappingdefault) +* **Link**: [default](aws/aws.lambda/default/types.md#resource-awslambdaeventsourcemappingdefault) ### aws.lambda/function -* [default](aws/aws.lambda/default/types.md#resource-awslambdafunctiondefault) +* **Link**: [default](aws/aws.lambda/default/types.md#resource-awslambdafunctiondefault) ### aws.lambda/url -* [default](aws/aws.lambda/default/types.md#resource-awslambdaurldefault) - -### aws.lambda/version -* [default](aws/aws.lambda/default/types.md#resource-awslambdaversiondefault) +* **Link**: [default](aws/aws.lambda/default/types.md#resource-awslambdaurldefault) ## aws.lex ### aws.lex/bot -* [default](aws/aws.lex/default/types.md#resource-awslexbotdefault) +* **Link**: [default](aws/aws.lex/default/types.md#resource-awslexbotdefault) ### aws.lex/botalias -* [default](aws/aws.lex/default/types.md#resource-awslexbotaliasdefault) +* **Link**: [default](aws/aws.lex/default/types.md#resource-awslexbotaliasdefault) ### aws.lex/resourcepolicy -* [default](aws/aws.lex/default/types.md#resource-awslexresourcepolicydefault) +* **Link**: [default](aws/aws.lex/default/types.md#resource-awslexresourcepolicydefault) ## aws.licensemanager ### aws.licensemanager/grant -* [default](aws/aws.licensemanager/default/types.md#resource-awslicensemanagergrantdefault) +* **Link**: [default](aws/aws.licensemanager/default/types.md#resource-awslicensemanagergrantdefault) ### aws.licensemanager/license -* [default](aws/aws.licensemanager/default/types.md#resource-awslicensemanagerlicensedefault) +* **Link**: [default](aws/aws.licensemanager/default/types.md#resource-awslicensemanagerlicensedefault) ## aws.lightsail ### aws.lightsail/alarm -* [default](aws/aws.lightsail/default/types.md#resource-awslightsailalarmdefault) +* **Link**: [default](aws/aws.lightsail/default/types.md#resource-awslightsailalarmdefault) ### aws.lightsail/bucket -* [default](aws/aws.lightsail/default/types.md#resource-awslightsailbucketdefault) +* **Link**: [default](aws/aws.lightsail/default/types.md#resource-awslightsailbucketdefault) ### aws.lightsail/certificate -* [default](aws/aws.lightsail/default/types.md#resource-awslightsailcertificatedefault) +* **Link**: [default](aws/aws.lightsail/default/types.md#resource-awslightsailcertificatedefault) ### aws.lightsail/container -* [default](aws/aws.lightsail/default/types.md#resource-awslightsailcontainerdefault) +* **Link**: [default](aws/aws.lightsail/default/types.md#resource-awslightsailcontainerdefault) ### aws.lightsail/database -* [default](aws/aws.lightsail/default/types.md#resource-awslightsaildatabasedefault) +* **Link**: [default](aws/aws.lightsail/default/types.md#resource-awslightsaildatabasedefault) ### aws.lightsail/disk -* [default](aws/aws.lightsail/default/types.md#resource-awslightsaildiskdefault) +* **Link**: [default](aws/aws.lightsail/default/types.md#resource-awslightsaildiskdefault) ### aws.lightsail/instance -* [default](aws/aws.lightsail/default/types.md#resource-awslightsailinstancedefault) +* **Link**: [default](aws/aws.lightsail/default/types.md#resource-awslightsailinstancedefault) ### aws.lightsail/loadbalancer -* [default](aws/aws.lightsail/default/types.md#resource-awslightsailloadbalancerdefault) +* **Link**: [default](aws/aws.lightsail/default/types.md#resource-awslightsailloadbalancerdefault) ### aws.lightsail/loadbalancertlscertificate -* [default](aws/aws.lightsail/default/types.md#resource-awslightsailloadbalancertlscertificatedefault) +* **Link**: [default](aws/aws.lightsail/default/types.md#resource-awslightsailloadbalancertlscertificatedefault) ### aws.lightsail/staticip -* [default](aws/aws.lightsail/default/types.md#resource-awslightsailstaticipdefault) +* **Link**: [default](aws/aws.lightsail/default/types.md#resource-awslightsailstaticipdefault) ## aws.location ### aws.location/apikey -* [default](aws/aws.location/default/types.md#resource-awslocationapikeydefault) +* **Link**: [default](aws/aws.location/default/types.md#resource-awslocationapikeydefault) ### aws.location/geofencecollection -* [default](aws/aws.location/default/types.md#resource-awslocationgeofencecollectiondefault) +* **Link**: [default](aws/aws.location/default/types.md#resource-awslocationgeofencecollectiondefault) ### aws.location/map -* [default](aws/aws.location/default/types.md#resource-awslocationmapdefault) +* **Link**: [default](aws/aws.location/default/types.md#resource-awslocationmapdefault) ### aws.location/placeindex -* [default](aws/aws.location/default/types.md#resource-awslocationplaceindexdefault) +* **Link**: [default](aws/aws.location/default/types.md#resource-awslocationplaceindexdefault) ### aws.location/routecalculator -* [default](aws/aws.location/default/types.md#resource-awslocationroutecalculatordefault) +* **Link**: [default](aws/aws.location/default/types.md#resource-awslocationroutecalculatordefault) ### aws.location/tracker -* [default](aws/aws.location/default/types.md#resource-awslocationtrackerdefault) +* **Link**: [default](aws/aws.location/default/types.md#resource-awslocationtrackerdefault) ## aws.logs ### aws.logs/accountpolicy -* [default](aws/aws.logs/default/types.md#resource-awslogsaccountpolicydefault) +* **Link**: [default](aws/aws.logs/default/types.md#resource-awslogsaccountpolicydefault) ### aws.logs/delivery -* [default](aws/aws.logs/default/types.md#resource-awslogsdeliverydefault) +* **Link**: [default](aws/aws.logs/default/types.md#resource-awslogsdeliverydefault) ### aws.logs/deliverydestination -* [default](aws/aws.logs/default/types.md#resource-awslogsdeliverydestinationdefault) +* **Link**: [default](aws/aws.logs/default/types.md#resource-awslogsdeliverydestinationdefault) ### aws.logs/deliverysource -* [default](aws/aws.logs/default/types.md#resource-awslogsdeliverysourcedefault) +* **Link**: [default](aws/aws.logs/default/types.md#resource-awslogsdeliverysourcedefault) ### aws.logs/destination -* [default](aws/aws.logs/default/types.md#resource-awslogsdestinationdefault) +* **Link**: [default](aws/aws.logs/default/types.md#resource-awslogsdestinationdefault) ### aws.logs/loganomalydetector -* [default](aws/aws.logs/default/types.md#resource-awslogsloganomalydetectordefault) +* **Link**: [default](aws/aws.logs/default/types.md#resource-awslogsloganomalydetectordefault) ### aws.logs/loggroup -* [default](aws/aws.logs/default/types.md#resource-awslogsloggroupdefault) +* **Link**: [default](aws/aws.logs/default/types.md#resource-awslogsloggroupdefault) ### aws.logs/metricfilter -* [default](aws/aws.logs/default/types.md#resource-awslogsmetricfilterdefault) +* **Link**: [default](aws/aws.logs/default/types.md#resource-awslogsmetricfilterdefault) ### aws.logs/querydefinition -* [default](aws/aws.logs/default/types.md#resource-awslogsquerydefinitiondefault) +* **Link**: [default](aws/aws.logs/default/types.md#resource-awslogsquerydefinitiondefault) ### aws.logs/resourcepolicy -* [default](aws/aws.logs/default/types.md#resource-awslogsresourcepolicydefault) +* **Link**: [default](aws/aws.logs/default/types.md#resource-awslogsresourcepolicydefault) ### aws.logs/subscriptionfilter -* [default](aws/aws.logs/default/types.md#resource-awslogssubscriptionfilterdefault) +* **Link**: [default](aws/aws.logs/default/types.md#resource-awslogssubscriptionfilterdefault) ## aws.lookoutmetrics ### aws.lookoutmetrics/anomalydetector -* [default](aws/aws.lookoutmetrics/default/types.md#resource-awslookoutmetricsanomalydetectordefault) +* **Link**: [default](aws/aws.lookoutmetrics/default/types.md#resource-awslookoutmetricsanomalydetectordefault) ## aws.lookoutvision ### aws.lookoutvision/project -* [default](aws/aws.lookoutvision/default/types.md#resource-awslookoutvisionprojectdefault) +* **Link**: [default](aws/aws.lookoutvision/default/types.md#resource-awslookoutvisionprojectdefault) ## aws.m2 ### aws.m2/application -* [default](aws/aws.m2/default/types.md#resource-awsm2applicationdefault) +* **Link**: [default](aws/aws.m2/default/types.md#resource-awsm2applicationdefault) ### aws.m2/environment -* [default](aws/aws.m2/default/types.md#resource-awsm2environmentdefault) +* **Link**: [default](aws/aws.m2/default/types.md#resource-awsm2environmentdefault) ## aws.macie ### aws.macie/allowlist -* [default](aws/aws.macie/default/types.md#resource-awsmacieallowlistdefault) +* **Link**: [default](aws/aws.macie/default/types.md#resource-awsmacieallowlistdefault) ### aws.macie/customdataidentifier -* [default](aws/aws.macie/default/types.md#resource-awsmaciecustomdataidentifierdefault) +* **Link**: [default](aws/aws.macie/default/types.md#resource-awsmaciecustomdataidentifierdefault) ### aws.macie/findingsfilter -* [default](aws/aws.macie/default/types.md#resource-awsmaciefindingsfilterdefault) +* **Link**: [default](aws/aws.macie/default/types.md#resource-awsmaciefindingsfilterdefault) ### aws.macie/session -* [default](aws/aws.macie/default/types.md#resource-awsmaciesessiondefault) +* **Link**: [default](aws/aws.macie/default/types.md#resource-awsmaciesessiondefault) ## aws.mediaconnect ### aws.mediaconnect/bridge -* [default](aws/aws.mediaconnect/default/types.md#resource-awsmediaconnectbridgedefault) +* **Link**: [default](aws/aws.mediaconnect/default/types.md#resource-awsmediaconnectbridgedefault) ### aws.mediaconnect/bridgeoutput -* [default](aws/aws.mediaconnect/default/types.md#resource-awsmediaconnectbridgeoutputdefault) +* **Link**: [default](aws/aws.mediaconnect/default/types.md#resource-awsmediaconnectbridgeoutputdefault) ### aws.mediaconnect/bridgesource -* [default](aws/aws.mediaconnect/default/types.md#resource-awsmediaconnectbridgesourcedefault) +* **Link**: [default](aws/aws.mediaconnect/default/types.md#resource-awsmediaconnectbridgesourcedefault) ### aws.mediaconnect/flow -* [default](aws/aws.mediaconnect/default/types.md#resource-awsmediaconnectflowdefault) +* **Link**: [default](aws/aws.mediaconnect/default/types.md#resource-awsmediaconnectflowdefault) ### aws.mediaconnect/flowentitlement -* [default](aws/aws.mediaconnect/default/types.md#resource-awsmediaconnectflowentitlementdefault) +* **Link**: [default](aws/aws.mediaconnect/default/types.md#resource-awsmediaconnectflowentitlementdefault) ### aws.mediaconnect/flowoutput -* [default](aws/aws.mediaconnect/default/types.md#resource-awsmediaconnectflowoutputdefault) +* **Link**: [default](aws/aws.mediaconnect/default/types.md#resource-awsmediaconnectflowoutputdefault) ### aws.mediaconnect/flowsource -* [default](aws/aws.mediaconnect/default/types.md#resource-awsmediaconnectflowsourcedefault) +* **Link**: [default](aws/aws.mediaconnect/default/types.md#resource-awsmediaconnectflowsourcedefault) ### aws.mediaconnect/flowvpcinterface -* [default](aws/aws.mediaconnect/default/types.md#resource-awsmediaconnectflowvpcinterfacedefault) +* **Link**: [default](aws/aws.mediaconnect/default/types.md#resource-awsmediaconnectflowvpcinterfacedefault) ## aws.medialive ### aws.medialive/multiplex -* [default](aws/aws.medialive/default/types.md#resource-awsmedialivemultiplexdefault) +* **Link**: [default](aws/aws.medialive/default/types.md#resource-awsmedialivemultiplexdefault) ### aws.medialive/multiplexprogram -* [default](aws/aws.medialive/default/types.md#resource-awsmedialivemultiplexprogramdefault) +* **Link**: [default](aws/aws.medialive/default/types.md#resource-awsmedialivemultiplexprogramdefault) ## aws.mediapackage ### aws.mediapackage/channel -* [default](aws/aws.mediapackage/default/types.md#resource-awsmediapackagechanneldefault) +* **Link**: [default](aws/aws.mediapackage/default/types.md#resource-awsmediapackagechanneldefault) ### aws.mediapackage/originendpoint -* [default](aws/aws.mediapackage/default/types.md#resource-awsmediapackageoriginendpointdefault) +* **Link**: [default](aws/aws.mediapackage/default/types.md#resource-awsmediapackageoriginendpointdefault) ### aws.mediapackage/packaginggroup -* [default](aws/aws.mediapackage/default/types.md#resource-awsmediapackagepackaginggroupdefault) +* **Link**: [default](aws/aws.mediapackage/default/types.md#resource-awsmediapackagepackaginggroupdefault) ## aws.mediapackagev2 ### aws.mediapackagev2/channel -* [default](aws/aws.mediapackagev2/default/types.md#resource-awsmediapackagev2channeldefault) +* **Link**: [default](aws/aws.mediapackagev2/default/types.md#resource-awsmediapackagev2channeldefault) ### aws.mediapackagev2/channelgroup -* [default](aws/aws.mediapackagev2/default/types.md#resource-awsmediapackagev2channelgroupdefault) +* **Link**: [default](aws/aws.mediapackagev2/default/types.md#resource-awsmediapackagev2channelgroupdefault) ### aws.mediapackagev2/channelpolicy -* [default](aws/aws.mediapackagev2/default/types.md#resource-awsmediapackagev2channelpolicydefault) +* **Link**: [default](aws/aws.mediapackagev2/default/types.md#resource-awsmediapackagev2channelpolicydefault) ### aws.mediapackagev2/originendpoint -* [default](aws/aws.mediapackagev2/default/types.md#resource-awsmediapackagev2originendpointdefault) +* **Link**: [default](aws/aws.mediapackagev2/default/types.md#resource-awsmediapackagev2originendpointdefault) ### aws.mediapackagev2/originendpointpolicy -* [default](aws/aws.mediapackagev2/default/types.md#resource-awsmediapackagev2originendpointpolicydefault) +* **Link**: [default](aws/aws.mediapackagev2/default/types.md#resource-awsmediapackagev2originendpointpolicydefault) ## aws.mediatailor ### aws.mediatailor/channel -* [default](aws/aws.mediatailor/default/types.md#resource-awsmediatailorchanneldefault) +* **Link**: [default](aws/aws.mediatailor/default/types.md#resource-awsmediatailorchanneldefault) ### aws.mediatailor/channelpolicy -* [default](aws/aws.mediatailor/default/types.md#resource-awsmediatailorchannelpolicydefault) +* **Link**: [default](aws/aws.mediatailor/default/types.md#resource-awsmediatailorchannelpolicydefault) ### aws.mediatailor/livesource -* [default](aws/aws.mediatailor/default/types.md#resource-awsmediatailorlivesourcedefault) +* **Link**: [default](aws/aws.mediatailor/default/types.md#resource-awsmediatailorlivesourcedefault) ### aws.mediatailor/playbackconfiguration -* [default](aws/aws.mediatailor/default/types.md#resource-awsmediatailorplaybackconfigurationdefault) +* **Link**: [default](aws/aws.mediatailor/default/types.md#resource-awsmediatailorplaybackconfigurationdefault) ### aws.mediatailor/sourcelocation -* [default](aws/aws.mediatailor/default/types.md#resource-awsmediatailorsourcelocationdefault) +* **Link**: [default](aws/aws.mediatailor/default/types.md#resource-awsmediatailorsourcelocationdefault) ### aws.mediatailor/vodsource -* [default](aws/aws.mediatailor/default/types.md#resource-awsmediatailorvodsourcedefault) +* **Link**: [default](aws/aws.mediatailor/default/types.md#resource-awsmediatailorvodsourcedefault) ## aws.memorydb ### aws.memorydb/acl -* [default](aws/aws.memorydb/default/types.md#resource-awsmemorydbacldefault) +* **Link**: [default](aws/aws.memorydb/default/types.md#resource-awsmemorydbacldefault) ### aws.memorydb/cluster -* [default](aws/aws.memorydb/default/types.md#resource-awsmemorydbclusterdefault) +* **Link**: [default](aws/aws.memorydb/default/types.md#resource-awsmemorydbclusterdefault) ### aws.memorydb/parametergroup -* [default](aws/aws.memorydb/default/types.md#resource-awsmemorydbparametergroupdefault) +* **Link**: [default](aws/aws.memorydb/default/types.md#resource-awsmemorydbparametergroupdefault) ### aws.memorydb/subnetgroup -* [default](aws/aws.memorydb/default/types.md#resource-awsmemorydbsubnetgroupdefault) +* **Link**: [default](aws/aws.memorydb/default/types.md#resource-awsmemorydbsubnetgroupdefault) ### aws.memorydb/user -* [default](aws/aws.memorydb/default/types.md#resource-awsmemorydbuserdefault) +* **Link**: [default](aws/aws.memorydb/default/types.md#resource-awsmemorydbuserdefault) ## aws.msk ### aws.msk/batchscramsecret -* [default](aws/aws.msk/default/types.md#resource-awsmskbatchscramsecretdefault) +* **Link**: [default](aws/aws.msk/default/types.md#resource-awsmskbatchscramsecretdefault) ### aws.msk/cluster -* [default](aws/aws.msk/default/types.md#resource-awsmskclusterdefault) +* **Link**: [default](aws/aws.msk/default/types.md#resource-awsmskclusterdefault) ### aws.msk/clusterpolicy -* [default](aws/aws.msk/default/types.md#resource-awsmskclusterpolicydefault) +* **Link**: [default](aws/aws.msk/default/types.md#resource-awsmskclusterpolicydefault) ### aws.msk/configuration -* [default](aws/aws.msk/default/types.md#resource-awsmskconfigurationdefault) +* **Link**: [default](aws/aws.msk/default/types.md#resource-awsmskconfigurationdefault) ### aws.msk/replicator -* [default](aws/aws.msk/default/types.md#resource-awsmskreplicatordefault) +* **Link**: [default](aws/aws.msk/default/types.md#resource-awsmskreplicatordefault) ### aws.msk/vpcconnection -* [default](aws/aws.msk/default/types.md#resource-awsmskvpcconnectiondefault) +* **Link**: [default](aws/aws.msk/default/types.md#resource-awsmskvpcconnectiondefault) ## aws.mwaa ### aws.mwaa/environment -* [default](aws/aws.mwaa/default/types.md#resource-awsmwaaenvironmentdefault) +* **Link**: [default](aws/aws.mwaa/default/types.md#resource-awsmwaaenvironmentdefault) ## aws.neptune ### aws.neptune/dbcluster -* [default](aws/aws.neptune/default/types.md#resource-awsneptunedbclusterdefault) +* **Link**: [default](aws/aws.neptune/default/types.md#resource-awsneptunedbclusterdefault) ## aws.neptunegraph ### aws.neptunegraph/graph -* [default](aws/aws.neptunegraph/default/types.md#resource-awsneptunegraphgraphdefault) +* **Link**: [default](aws/aws.neptunegraph/default/types.md#resource-awsneptunegraphgraphdefault) ### aws.neptunegraph/privategraphendpoint -* [default](aws/aws.neptunegraph/default/types.md#resource-awsneptunegraphprivategraphendpointdefault) +* **Link**: [default](aws/aws.neptunegraph/default/types.md#resource-awsneptunegraphprivategraphendpointdefault) ## aws.networkfirewall ### aws.networkfirewall/firewall -* [default](aws/aws.networkfirewall/default/types.md#resource-awsnetworkfirewallfirewalldefault) +* **Link**: [default](aws/aws.networkfirewall/default/types.md#resource-awsnetworkfirewallfirewalldefault) ### aws.networkfirewall/firewallpolicy -* [default](aws/aws.networkfirewall/default/types.md#resource-awsnetworkfirewallfirewallpolicydefault) +* **Link**: [default](aws/aws.networkfirewall/default/types.md#resource-awsnetworkfirewallfirewallpolicydefault) ### aws.networkfirewall/loggingconfiguration -* [default](aws/aws.networkfirewall/default/types.md#resource-awsnetworkfirewallloggingconfigurationdefault) +* **Link**: [default](aws/aws.networkfirewall/default/types.md#resource-awsnetworkfirewallloggingconfigurationdefault) ### aws.networkfirewall/rulegroup -* [default](aws/aws.networkfirewall/default/types.md#resource-awsnetworkfirewallrulegroupdefault) +* **Link**: [default](aws/aws.networkfirewall/default/types.md#resource-awsnetworkfirewallrulegroupdefault) ### aws.networkfirewall/tlsinspectionconfiguration -* [default](aws/aws.networkfirewall/default/types.md#resource-awsnetworkfirewalltlsinspectionconfigurationdefault) +* **Link**: [default](aws/aws.networkfirewall/default/types.md#resource-awsnetworkfirewalltlsinspectionconfigurationdefault) ## aws.networkmanager ### aws.networkmanager/connectattachment -* [default](aws/aws.networkmanager/default/types.md#resource-awsnetworkmanagerconnectattachmentdefault) +* **Link**: [default](aws/aws.networkmanager/default/types.md#resource-awsnetworkmanagerconnectattachmentdefault) ### aws.networkmanager/connectpeer -* [default](aws/aws.networkmanager/default/types.md#resource-awsnetworkmanagerconnectpeerdefault) +* **Link**: [default](aws/aws.networkmanager/default/types.md#resource-awsnetworkmanagerconnectpeerdefault) ### aws.networkmanager/corenetwork -* [default](aws/aws.networkmanager/default/types.md#resource-awsnetworkmanagercorenetworkdefault) +* **Link**: [default](aws/aws.networkmanager/default/types.md#resource-awsnetworkmanagercorenetworkdefault) ### aws.networkmanager/device -* [default](aws/aws.networkmanager/default/types.md#resource-awsnetworkmanagerdevicedefault) +* **Link**: [default](aws/aws.networkmanager/default/types.md#resource-awsnetworkmanagerdevicedefault) ### aws.networkmanager/globalnetwork -* [default](aws/aws.networkmanager/default/types.md#resource-awsnetworkmanagerglobalnetworkdefault) +* **Link**: [default](aws/aws.networkmanager/default/types.md#resource-awsnetworkmanagerglobalnetworkdefault) ### aws.networkmanager/link -* [default](aws/aws.networkmanager/default/types.md#resource-awsnetworkmanagerlinkdefault) +* **Link**: [default](aws/aws.networkmanager/default/types.md#resource-awsnetworkmanagerlinkdefault) ### aws.networkmanager/site -* [default](aws/aws.networkmanager/default/types.md#resource-awsnetworkmanagersitedefault) +* **Link**: [default](aws/aws.networkmanager/default/types.md#resource-awsnetworkmanagersitedefault) ### aws.networkmanager/sitetositevpnattachment -* [default](aws/aws.networkmanager/default/types.md#resource-awsnetworkmanagersitetositevpnattachmentdefault) +* **Link**: [default](aws/aws.networkmanager/default/types.md#resource-awsnetworkmanagersitetositevpnattachmentdefault) ### aws.networkmanager/transitgatewaypeering -* [default](aws/aws.networkmanager/default/types.md#resource-awsnetworkmanagertransitgatewaypeeringdefault) +* **Link**: [default](aws/aws.networkmanager/default/types.md#resource-awsnetworkmanagertransitgatewaypeeringdefault) ### aws.networkmanager/transitgatewayroutetableattachment -* [default](aws/aws.networkmanager/default/types.md#resource-awsnetworkmanagertransitgatewayroutetableattachmentdefault) +* **Link**: [default](aws/aws.networkmanager/default/types.md#resource-awsnetworkmanagertransitgatewayroutetableattachmentdefault) ### aws.networkmanager/vpcattachment -* [default](aws/aws.networkmanager/default/types.md#resource-awsnetworkmanagervpcattachmentdefault) +* **Link**: [default](aws/aws.networkmanager/default/types.md#resource-awsnetworkmanagervpcattachmentdefault) ## aws.nimblestudio ### aws.nimblestudio/launchprofile -* [default](aws/aws.nimblestudio/default/types.md#resource-awsnimblestudiolaunchprofiledefault) +* **Link**: [default](aws/aws.nimblestudio/default/types.md#resource-awsnimblestudiolaunchprofiledefault) ### aws.nimblestudio/streamingimage -* [default](aws/aws.nimblestudio/default/types.md#resource-awsnimblestudiostreamingimagedefault) +* **Link**: [default](aws/aws.nimblestudio/default/types.md#resource-awsnimblestudiostreamingimagedefault) ### aws.nimblestudio/studio -* [default](aws/aws.nimblestudio/default/types.md#resource-awsnimblestudiostudiodefault) +* **Link**: [default](aws/aws.nimblestudio/default/types.md#resource-awsnimblestudiostudiodefault) ### aws.nimblestudio/studiocomponent -* [default](aws/aws.nimblestudio/default/types.md#resource-awsnimblestudiostudiocomponentdefault) +* **Link**: [default](aws/aws.nimblestudio/default/types.md#resource-awsnimblestudiostudiocomponentdefault) ## aws.oam ### aws.oam/link -* [default](aws/aws.oam/default/types.md#resource-awsoamlinkdefault) +* **Link**: [default](aws/aws.oam/default/types.md#resource-awsoamlinkdefault) ### aws.oam/sink -* [default](aws/aws.oam/default/types.md#resource-awsoamsinkdefault) +* **Link**: [default](aws/aws.oam/default/types.md#resource-awsoamsinkdefault) ## aws.omics ### aws.omics/annotationstore -* [default](aws/aws.omics/default/types.md#resource-awsomicsannotationstoredefault) +* **Link**: [default](aws/aws.omics/default/types.md#resource-awsomicsannotationstoredefault) ### aws.omics/rungroup -* [default](aws/aws.omics/default/types.md#resource-awsomicsrungroupdefault) +* **Link**: [default](aws/aws.omics/default/types.md#resource-awsomicsrungroupdefault) ### aws.omics/variantstore -* [default](aws/aws.omics/default/types.md#resource-awsomicsvariantstoredefault) +* **Link**: [default](aws/aws.omics/default/types.md#resource-awsomicsvariantstoredefault) ### aws.omics/workflow -* [default](aws/aws.omics/default/types.md#resource-awsomicsworkflowdefault) +* **Link**: [default](aws/aws.omics/default/types.md#resource-awsomicsworkflowdefault) ## aws.opensearchserverless ### aws.opensearchserverless/accesspolicy -* [default](aws/aws.opensearchserverless/default/types.md#resource-awsopensearchserverlessaccesspolicydefault) +* **Link**: [default](aws/aws.opensearchserverless/default/types.md#resource-awsopensearchserverlessaccesspolicydefault) ### aws.opensearchserverless/collection -* [default](aws/aws.opensearchserverless/default/types.md#resource-awsopensearchserverlesscollectiondefault) +* **Link**: [default](aws/aws.opensearchserverless/default/types.md#resource-awsopensearchserverlesscollectiondefault) ### aws.opensearchserverless/lifecyclepolicy -* [default](aws/aws.opensearchserverless/default/types.md#resource-awsopensearchserverlesslifecyclepolicydefault) +* **Link**: [default](aws/aws.opensearchserverless/default/types.md#resource-awsopensearchserverlesslifecyclepolicydefault) ### aws.opensearchserverless/securityconfig -* [default](aws/aws.opensearchserverless/default/types.md#resource-awsopensearchserverlesssecurityconfigdefault) +* **Link**: [default](aws/aws.opensearchserverless/default/types.md#resource-awsopensearchserverlesssecurityconfigdefault) ### aws.opensearchserverless/securitypolicy -* [default](aws/aws.opensearchserverless/default/types.md#resource-awsopensearchserverlesssecuritypolicydefault) +* **Link**: [default](aws/aws.opensearchserverless/default/types.md#resource-awsopensearchserverlesssecuritypolicydefault) ### aws.opensearchserverless/vpcendpoint -* [default](aws/aws.opensearchserverless/default/types.md#resource-awsopensearchserverlessvpcendpointdefault) +* **Link**: [default](aws/aws.opensearchserverless/default/types.md#resource-awsopensearchserverlessvpcendpointdefault) ## aws.opensearchservice ### aws.opensearchservice/domain -* [default](aws/aws.opensearchservice/default/types.md#resource-awsopensearchservicedomaindefault) +* **Link**: [default](aws/aws.opensearchservice/default/types.md#resource-awsopensearchservicedomaindefault) ## aws.opsworkscm ### aws.opsworkscm/server -* [default](aws/aws.opsworkscm/default/types.md#resource-awsopsworkscmserverdefault) +* **Link**: [default](aws/aws.opsworkscm/default/types.md#resource-awsopsworkscmserverdefault) ## aws.organizations ### aws.organizations/account -* [default](aws/aws.organizations/default/types.md#resource-awsorganizationsaccountdefault) +* **Link**: [default](aws/aws.organizations/default/types.md#resource-awsorganizationsaccountdefault) ### aws.organizations/organization -* [default](aws/aws.organizations/default/types.md#resource-awsorganizationsorganizationdefault) +* **Link**: [default](aws/aws.organizations/default/types.md#resource-awsorganizationsorganizationdefault) ### aws.organizations/organizationalunit -* [default](aws/aws.organizations/default/types.md#resource-awsorganizationsorganizationalunitdefault) +* **Link**: [default](aws/aws.organizations/default/types.md#resource-awsorganizationsorganizationalunitdefault) ### aws.organizations/policy -* [default](aws/aws.organizations/default/types.md#resource-awsorganizationspolicydefault) +* **Link**: [default](aws/aws.organizations/default/types.md#resource-awsorganizationspolicydefault) ### aws.organizations/resourcepolicy -* [default](aws/aws.organizations/default/types.md#resource-awsorganizationsresourcepolicydefault) +* **Link**: [default](aws/aws.organizations/default/types.md#resource-awsorganizationsresourcepolicydefault) ## aws.osis ### aws.osis/pipeline -* [default](aws/aws.osis/default/types.md#resource-awsosispipelinedefault) +* **Link**: [default](aws/aws.osis/default/types.md#resource-awsosispipelinedefault) ## aws.panorama ### aws.panorama/applicationinstance -* [default](aws/aws.panorama/default/types.md#resource-awspanoramaapplicationinstancedefault) +* **Link**: [default](aws/aws.panorama/default/types.md#resource-awspanoramaapplicationinstancedefault) ### aws.panorama/package -* [default](aws/aws.panorama/default/types.md#resource-awspanoramapackagedefault) +* **Link**: [default](aws/aws.panorama/default/types.md#resource-awspanoramapackagedefault) ### aws.panorama/packageversion -* [default](aws/aws.panorama/default/types.md#resource-awspanoramapackageversiondefault) +* **Link**: [default](aws/aws.panorama/default/types.md#resource-awspanoramapackageversiondefault) + +## aws.paymentcryptography +### aws.paymentcryptography/alias +* **Link**: [default](aws/aws.paymentcryptography/default/types.md#resource-awspaymentcryptographyaliasdefault) + +### aws.paymentcryptography/key +* **Link**: [default](aws/aws.paymentcryptography/default/types.md#resource-awspaymentcryptographykeydefault) ## aws.pcaconnectorad ### aws.pcaconnectorad/connector -* [default](aws/aws.pcaconnectorad/default/types.md#resource-awspcaconnectoradconnectordefault) +* **Link**: [default](aws/aws.pcaconnectorad/default/types.md#resource-awspcaconnectoradconnectordefault) ### aws.pcaconnectorad/directoryregistration -* [default](aws/aws.pcaconnectorad/default/types.md#resource-awspcaconnectoraddirectoryregistrationdefault) +* **Link**: [default](aws/aws.pcaconnectorad/default/types.md#resource-awspcaconnectoraddirectoryregistrationdefault) ### aws.pcaconnectorad/template -* [default](aws/aws.pcaconnectorad/default/types.md#resource-awspcaconnectoradtemplatedefault) +* **Link**: [default](aws/aws.pcaconnectorad/default/types.md#resource-awspcaconnectoradtemplatedefault) ### aws.pcaconnectorad/templategroupaccesscontrolentry -* [default](aws/aws.pcaconnectorad/default/types.md#resource-awspcaconnectoradtemplategroupaccesscontrolentrydefault) +* **Link**: [default](aws/aws.pcaconnectorad/default/types.md#resource-awspcaconnectoradtemplategroupaccesscontrolentrydefault) ## aws.personalize ### aws.personalize/dataset -* [default](aws/aws.personalize/default/types.md#resource-awspersonalizedatasetdefault) +* **Link**: [default](aws/aws.personalize/default/types.md#resource-awspersonalizedatasetdefault) ## aws.pinpoint ### aws.pinpoint/inapptemplate -* [default](aws/aws.pinpoint/default/types.md#resource-awspinpointinapptemplatedefault) +* **Link**: [default](aws/aws.pinpoint/default/types.md#resource-awspinpointinapptemplatedefault) ## aws.pipes ### aws.pipes/pipe -* [default](aws/aws.pipes/default/types.md#resource-awspipespipedefault) +* **Link**: [default](aws/aws.pipes/default/types.md#resource-awspipespipedefault) ## aws.proton ### aws.proton/environmentaccountconnection -* [default](aws/aws.proton/default/types.md#resource-awsprotonenvironmentaccountconnectiondefault) +* **Link**: [default](aws/aws.proton/default/types.md#resource-awsprotonenvironmentaccountconnectiondefault) ### aws.proton/environmenttemplate -* [default](aws/aws.proton/default/types.md#resource-awsprotonenvironmenttemplatedefault) +* **Link**: [default](aws/aws.proton/default/types.md#resource-awsprotonenvironmenttemplatedefault) ### aws.proton/servicetemplate -* [default](aws/aws.proton/default/types.md#resource-awsprotonservicetemplatedefault) +* **Link**: [default](aws/aws.proton/default/types.md#resource-awsprotonservicetemplatedefault) + +## aws.qbusiness +### aws.qbusiness/application +* **Link**: [default](aws/aws.qbusiness/default/types.md#resource-awsqbusinessapplicationdefault) + +### aws.qbusiness/datasource +* **Link**: [default](aws/aws.qbusiness/default/types.md#resource-awsqbusinessdatasourcedefault) + +### aws.qbusiness/index +* **Link**: [default](aws/aws.qbusiness/default/types.md#resource-awsqbusinessindexdefault) + +### aws.qbusiness/plugin +* **Link**: [default](aws/aws.qbusiness/default/types.md#resource-awsqbusinessplugindefault) + +### aws.qbusiness/retriever +* **Link**: [default](aws/aws.qbusiness/default/types.md#resource-awsqbusinessretrieverdefault) + +### aws.qbusiness/webexperience +* **Link**: [default](aws/aws.qbusiness/default/types.md#resource-awsqbusinesswebexperiencedefault) ## aws.qldb ### aws.qldb/stream -* [default](aws/aws.qldb/default/types.md#resource-awsqldbstreamdefault) +* **Link**: [default](aws/aws.qldb/default/types.md#resource-awsqldbstreamdefault) ## aws.quicksight ### aws.quicksight/analysis -* [default](aws/aws.quicksight/default/types.md#resource-awsquicksightanalysisdefault) +* **Link**: [default](aws/aws.quicksight/default/types.md#resource-awsquicksightanalysisdefault) ### aws.quicksight/dashboard -* [default](aws/aws.quicksight/default/types.md#resource-awsquicksightdashboarddefault) +* **Link**: [default](aws/aws.quicksight/default/types.md#resource-awsquicksightdashboarddefault) ### aws.quicksight/dataset -* [default](aws/aws.quicksight/default/types.md#resource-awsquicksightdatasetdefault) +* **Link**: [default](aws/aws.quicksight/default/types.md#resource-awsquicksightdatasetdefault) ### aws.quicksight/datasource -* [default](aws/aws.quicksight/default/types.md#resource-awsquicksightdatasourcedefault) +* **Link**: [default](aws/aws.quicksight/default/types.md#resource-awsquicksightdatasourcedefault) ### aws.quicksight/refreshschedule -* [default](aws/aws.quicksight/default/types.md#resource-awsquicksightrefreshscheduledefault) +* **Link**: [default](aws/aws.quicksight/default/types.md#resource-awsquicksightrefreshscheduledefault) ### aws.quicksight/template -* [default](aws/aws.quicksight/default/types.md#resource-awsquicksighttemplatedefault) +* **Link**: [default](aws/aws.quicksight/default/types.md#resource-awsquicksighttemplatedefault) ### aws.quicksight/theme -* [default](aws/aws.quicksight/default/types.md#resource-awsquicksightthemedefault) +* **Link**: [default](aws/aws.quicksight/default/types.md#resource-awsquicksightthemedefault) ### aws.quicksight/topic -* [default](aws/aws.quicksight/default/types.md#resource-awsquicksighttopicdefault) +* **Link**: [default](aws/aws.quicksight/default/types.md#resource-awsquicksighttopicdefault) ### aws.quicksight/vpcconnection -* [default](aws/aws.quicksight/default/types.md#resource-awsquicksightvpcconnectiondefault) +* **Link**: [default](aws/aws.quicksight/default/types.md#resource-awsquicksightvpcconnectiondefault) ## aws.ram ### aws.ram/permission -* [default](aws/aws.ram/default/types.md#resource-awsrampermissiondefault) +* **Link**: [default](aws/aws.ram/default/types.md#resource-awsrampermissiondefault) ## aws.rds ### aws.rds/customdbengineversion -* [default](aws/aws.rds/default/types.md#resource-awsrdscustomdbengineversiondefault) +* **Link**: [default](aws/aws.rds/default/types.md#resource-awsrdscustomdbengineversiondefault) ### aws.rds/dbcluster -* [default](aws/aws.rds/default/types.md#resource-awsrdsdbclusterdefault) +* **Link**: [default](aws/aws.rds/default/types.md#resource-awsrdsdbclusterdefault) ### aws.rds/dbclusterparametergroup -* [default](aws/aws.rds/default/types.md#resource-awsrdsdbclusterparametergroupdefault) +* **Link**: [default](aws/aws.rds/default/types.md#resource-awsrdsdbclusterparametergroupdefault) ### aws.rds/dbinstance -* [default](aws/aws.rds/default/types.md#resource-awsrdsdbinstancedefault) +* **Link**: [default](aws/aws.rds/default/types.md#resource-awsrdsdbinstancedefault) ### aws.rds/dbparametergroup -* [default](aws/aws.rds/default/types.md#resource-awsrdsdbparametergroupdefault) +* **Link**: [default](aws/aws.rds/default/types.md#resource-awsrdsdbparametergroupdefault) ### aws.rds/dbproxy -* [default](aws/aws.rds/default/types.md#resource-awsrdsdbproxydefault) +* **Link**: [default](aws/aws.rds/default/types.md#resource-awsrdsdbproxydefault) ### aws.rds/dbproxyendpoint -* [default](aws/aws.rds/default/types.md#resource-awsrdsdbproxyendpointdefault) +* **Link**: [default](aws/aws.rds/default/types.md#resource-awsrdsdbproxyendpointdefault) ### aws.rds/dbproxytargetgroup -* [default](aws/aws.rds/default/types.md#resource-awsrdsdbproxytargetgroupdefault) +* **Link**: [default](aws/aws.rds/default/types.md#resource-awsrdsdbproxytargetgroupdefault) ### aws.rds/dbsubnetgroup -* [default](aws/aws.rds/default/types.md#resource-awsrdsdbsubnetgroupdefault) +* **Link**: [default](aws/aws.rds/default/types.md#resource-awsrdsdbsubnetgroupdefault) ### aws.rds/eventsubscription -* [default](aws/aws.rds/default/types.md#resource-awsrdseventsubscriptiondefault) +* **Link**: [default](aws/aws.rds/default/types.md#resource-awsrdseventsubscriptiondefault) ### aws.rds/globalcluster -* [default](aws/aws.rds/default/types.md#resource-awsrdsglobalclusterdefault) +* **Link**: [default](aws/aws.rds/default/types.md#resource-awsrdsglobalclusterdefault) + +### aws.rds/integration +* **Link**: [default](aws/aws.rds/default/types.md#resource-awsrdsintegrationdefault) ### aws.rds/optiongroup -* [default](aws/aws.rds/default/types.md#resource-awsrdsoptiongroupdefault) +* **Link**: [default](aws/aws.rds/default/types.md#resource-awsrdsoptiongroupdefault) ## aws.redshift ### aws.redshift/cluster -* [default](aws/aws.redshift/default/types.md#resource-awsredshiftclusterdefault) +* **Link**: [default](aws/aws.redshift/default/types.md#resource-awsredshiftclusterdefault) ### aws.redshift/clusterparametergroup -* [default](aws/aws.redshift/default/types.md#resource-awsredshiftclusterparametergroupdefault) +* **Link**: [default](aws/aws.redshift/default/types.md#resource-awsredshiftclusterparametergroupdefault) ### aws.redshift/clustersubnetgroup -* [default](aws/aws.redshift/default/types.md#resource-awsredshiftclustersubnetgroupdefault) +* **Link**: [default](aws/aws.redshift/default/types.md#resource-awsredshiftclustersubnetgroupdefault) ### aws.redshift/endpointaccess -* [default](aws/aws.redshift/default/types.md#resource-awsredshiftendpointaccessdefault) +* **Link**: [default](aws/aws.redshift/default/types.md#resource-awsredshiftendpointaccessdefault) ### aws.redshift/endpointauthorization -* [default](aws/aws.redshift/default/types.md#resource-awsredshiftendpointauthorizationdefault) +* **Link**: [default](aws/aws.redshift/default/types.md#resource-awsredshiftendpointauthorizationdefault) ### aws.redshift/eventsubscription -* [default](aws/aws.redshift/default/types.md#resource-awsredshifteventsubscriptiondefault) +* **Link**: [default](aws/aws.redshift/default/types.md#resource-awsredshifteventsubscriptiondefault) ### aws.redshift/scheduledaction -* [default](aws/aws.redshift/default/types.md#resource-awsredshiftscheduledactiondefault) +* **Link**: [default](aws/aws.redshift/default/types.md#resource-awsredshiftscheduledactiondefault) ## aws.redshiftserverless ### aws.redshiftserverless/namespace -* [default](aws/aws.redshiftserverless/default/types.md#resource-awsredshiftserverlessnamespacedefault) +* **Link**: [default](aws/aws.redshiftserverless/default/types.md#resource-awsredshiftserverlessnamespacedefault) ### aws.redshiftserverless/workgroup -* [default](aws/aws.redshiftserverless/default/types.md#resource-awsredshiftserverlessworkgroupdefault) +* **Link**: [default](aws/aws.redshiftserverless/default/types.md#resource-awsredshiftserverlessworkgroupdefault) ## aws.refactorspaces ### aws.refactorspaces/route -* [default](aws/aws.refactorspaces/default/types.md#resource-awsrefactorspacesroutedefault) +* **Link**: [default](aws/aws.refactorspaces/default/types.md#resource-awsrefactorspacesroutedefault) ## aws.rekognition ### aws.rekognition/collection -* [default](aws/aws.rekognition/default/types.md#resource-awsrekognitioncollectiondefault) +* **Link**: [default](aws/aws.rekognition/default/types.md#resource-awsrekognitioncollectiondefault) ### aws.rekognition/project -* [default](aws/aws.rekognition/default/types.md#resource-awsrekognitionprojectdefault) +* **Link**: [default](aws/aws.rekognition/default/types.md#resource-awsrekognitionprojectdefault) ### aws.rekognition/streamprocessor -* [default](aws/aws.rekognition/default/types.md#resource-awsrekognitionstreamprocessordefault) +* **Link**: [default](aws/aws.rekognition/default/types.md#resource-awsrekognitionstreamprocessordefault) ## aws.resiliencehub ### aws.resiliencehub/app -* [default](aws/aws.resiliencehub/default/types.md#resource-awsresiliencehubappdefault) +* **Link**: [default](aws/aws.resiliencehub/default/types.md#resource-awsresiliencehubappdefault) ### aws.resiliencehub/resiliencypolicy -* [default](aws/aws.resiliencehub/default/types.md#resource-awsresiliencehubresiliencypolicydefault) +* **Link**: [default](aws/aws.resiliencehub/default/types.md#resource-awsresiliencehubresiliencypolicydefault) ## aws.resourceexplorer2 ### aws.resourceexplorer2/defaultviewassociation -* [default](aws/aws.resourceexplorer2/default/types.md#resource-awsresourceexplorer2defaultviewassociationdefault) +* **Link**: [default](aws/aws.resourceexplorer2/default/types.md#resource-awsresourceexplorer2defaultviewassociationdefault) ### aws.resourceexplorer2/index -* [default](aws/aws.resourceexplorer2/default/types.md#resource-awsresourceexplorer2indexdefault) +* **Link**: [default](aws/aws.resourceexplorer2/default/types.md#resource-awsresourceexplorer2indexdefault) ### aws.resourceexplorer2/view -* [default](aws/aws.resourceexplorer2/default/types.md#resource-awsresourceexplorer2viewdefault) +* **Link**: [default](aws/aws.resourceexplorer2/default/types.md#resource-awsresourceexplorer2viewdefault) ## aws.resourcegroups ### aws.resourcegroups/group -* [default](aws/aws.resourcegroups/default/types.md#resource-awsresourcegroupsgroupdefault) +* **Link**: [default](aws/aws.resourcegroups/default/types.md#resource-awsresourcegroupsgroupdefault) ## aws.robomaker ### aws.robomaker/fleet -* [default](aws/aws.robomaker/default/types.md#resource-awsrobomakerfleetdefault) +* **Link**: [default](aws/aws.robomaker/default/types.md#resource-awsrobomakerfleetdefault) ### aws.robomaker/robot -* [default](aws/aws.robomaker/default/types.md#resource-awsrobomakerrobotdefault) +* **Link**: [default](aws/aws.robomaker/default/types.md#resource-awsrobomakerrobotdefault) ### aws.robomaker/robotapplication -* [default](aws/aws.robomaker/default/types.md#resource-awsrobomakerrobotapplicationdefault) +* **Link**: [default](aws/aws.robomaker/default/types.md#resource-awsrobomakerrobotapplicationdefault) ### aws.robomaker/simulationapplication -* [default](aws/aws.robomaker/default/types.md#resource-awsrobomakersimulationapplicationdefault) +* **Link**: [default](aws/aws.robomaker/default/types.md#resource-awsrobomakersimulationapplicationdefault) ## aws.rolesanywhere ### aws.rolesanywhere/crl -* [default](aws/aws.rolesanywhere/default/types.md#resource-awsrolesanywherecrldefault) +* **Link**: [default](aws/aws.rolesanywhere/default/types.md#resource-awsrolesanywherecrldefault) ### aws.rolesanywhere/profile -* [default](aws/aws.rolesanywhere/default/types.md#resource-awsrolesanywhereprofiledefault) +* **Link**: [default](aws/aws.rolesanywhere/default/types.md#resource-awsrolesanywhereprofiledefault) ### aws.rolesanywhere/trustanchor -* [default](aws/aws.rolesanywhere/default/types.md#resource-awsrolesanywheretrustanchordefault) +* **Link**: [default](aws/aws.rolesanywhere/default/types.md#resource-awsrolesanywheretrustanchordefault) ## aws.route53 ### aws.route53/cidrcollection -* [default](aws/aws.route53/default/types.md#resource-awsroute53cidrcollectiondefault) +* **Link**: [default](aws/aws.route53/default/types.md#resource-awsroute53cidrcollectiondefault) ### aws.route53/healthcheck -* [default](aws/aws.route53/default/types.md#resource-awsroute53healthcheckdefault) +* **Link**: [default](aws/aws.route53/default/types.md#resource-awsroute53healthcheckdefault) ### aws.route53/hostedzone -* [default](aws/aws.route53/default/types.md#resource-awsroute53hostedzonedefault) +* **Link**: [default](aws/aws.route53/default/types.md#resource-awsroute53hostedzonedefault) ### aws.route53/keysigningkey -* [default](aws/aws.route53/default/types.md#resource-awsroute53keysigningkeydefault) +* **Link**: [default](aws/aws.route53/default/types.md#resource-awsroute53keysigningkeydefault) + +## aws.route53profiles +### aws.route53profiles/profile +* **Link**: [default](aws/aws.route53profiles/default/types.md#resource-awsroute53profilesprofiledefault) + +### aws.route53profiles/profileassociation +* **Link**: [default](aws/aws.route53profiles/default/types.md#resource-awsroute53profilesprofileassociationdefault) + +### aws.route53profiles/profileresourceassociation +* **Link**: [default](aws/aws.route53profiles/default/types.md#resource-awsroute53profilesprofileresourceassociationdefault) ## aws.route53recoverycontrol ### aws.route53recoverycontrol/controlpanel -* [default](aws/aws.route53recoverycontrol/default/types.md#resource-awsroute53recoverycontrolcontrolpaneldefault) +* **Link**: [default](aws/aws.route53recoverycontrol/default/types.md#resource-awsroute53recoverycontrolcontrolpaneldefault) ### aws.route53recoverycontrol/routingcontrol -* [default](aws/aws.route53recoverycontrol/default/types.md#resource-awsroute53recoverycontrolroutingcontroldefault) +* **Link**: [default](aws/aws.route53recoverycontrol/default/types.md#resource-awsroute53recoverycontrolroutingcontroldefault) ### aws.route53recoverycontrol/safetyrule -* [default](aws/aws.route53recoverycontrol/default/types.md#resource-awsroute53recoverycontrolsafetyruledefault) +* **Link**: [default](aws/aws.route53recoverycontrol/default/types.md#resource-awsroute53recoverycontrolsafetyruledefault) ## aws.route53recoveryreadiness ### aws.route53recoveryreadiness/cell -* [default](aws/aws.route53recoveryreadiness/default/types.md#resource-awsroute53recoveryreadinesscelldefault) +* **Link**: [default](aws/aws.route53recoveryreadiness/default/types.md#resource-awsroute53recoveryreadinesscelldefault) ### aws.route53recoveryreadiness/readinesscheck -* [default](aws/aws.route53recoveryreadiness/default/types.md#resource-awsroute53recoveryreadinessreadinesscheckdefault) +* **Link**: [default](aws/aws.route53recoveryreadiness/default/types.md#resource-awsroute53recoveryreadinessreadinesscheckdefault) ### aws.route53recoveryreadiness/recoverygroup -* [default](aws/aws.route53recoveryreadiness/default/types.md#resource-awsroute53recoveryreadinessrecoverygroupdefault) +* **Link**: [default](aws/aws.route53recoveryreadiness/default/types.md#resource-awsroute53recoveryreadinessrecoverygroupdefault) ### aws.route53recoveryreadiness/resourceset -* [default](aws/aws.route53recoveryreadiness/default/types.md#resource-awsroute53recoveryreadinessresourcesetdefault) +* **Link**: [default](aws/aws.route53recoveryreadiness/default/types.md#resource-awsroute53recoveryreadinessresourcesetdefault) ## aws.route53resolver ### aws.route53resolver/firewalldomainlist -* [default](aws/aws.route53resolver/default/types.md#resource-awsroute53resolverfirewalldomainlistdefault) +* **Link**: [default](aws/aws.route53resolver/default/types.md#resource-awsroute53resolverfirewalldomainlistdefault) ### aws.route53resolver/firewallrulegroup -* [default](aws/aws.route53resolver/default/types.md#resource-awsroute53resolverfirewallrulegroupdefault) +* **Link**: [default](aws/aws.route53resolver/default/types.md#resource-awsroute53resolverfirewallrulegroupdefault) ### aws.route53resolver/firewallrulegroupassociation -* [default](aws/aws.route53resolver/default/types.md#resource-awsroute53resolverfirewallrulegroupassociationdefault) +* **Link**: [default](aws/aws.route53resolver/default/types.md#resource-awsroute53resolverfirewallrulegroupassociationdefault) ### aws.route53resolver/outpostresolver -* [default](aws/aws.route53resolver/default/types.md#resource-awsroute53resolveroutpostresolverdefault) +* **Link**: [default](aws/aws.route53resolver/default/types.md#resource-awsroute53resolveroutpostresolverdefault) ### aws.route53resolver/resolverrule -* [default](aws/aws.route53resolver/default/types.md#resource-awsroute53resolverresolverruledefault) +* **Link**: [default](aws/aws.route53resolver/default/types.md#resource-awsroute53resolverresolverruledefault) ## aws.rum ### aws.rum/appmonitor -* [default](aws/aws.rum/default/types.md#resource-awsrumappmonitordefault) +* **Link**: [default](aws/aws.rum/default/types.md#resource-awsrumappmonitordefault) ## aws.s3 ### aws.s3/accessgrant -* [default](aws/aws.s3/default/types.md#resource-awss3accessgrantdefault) +* **Link**: [default](aws/aws.s3/default/types.md#resource-awss3accessgrantdefault) ### aws.s3/accessgrantsinstance -* [default](aws/aws.s3/default/types.md#resource-awss3accessgrantsinstancedefault) +* **Link**: [default](aws/aws.s3/default/types.md#resource-awss3accessgrantsinstancedefault) ### aws.s3/accessgrantslocation -* [default](aws/aws.s3/default/types.md#resource-awss3accessgrantslocationdefault) +* **Link**: [default](aws/aws.s3/default/types.md#resource-awss3accessgrantslocationdefault) ### aws.s3/accesspoint -* [default](aws/aws.s3/default/types.md#resource-awss3accesspointdefault) +* **Link**: [default](aws/aws.s3/default/types.md#resource-awss3accesspointdefault) ### aws.s3/bucket -* [default](aws/aws.s3/default/types.md#resource-awss3bucketdefault) +* **Link**: [default](aws/aws.s3/default/types.md#resource-awss3bucketdefault) ### aws.s3/bucketpolicy -* [default](aws/aws.s3/default/types.md#resource-awss3bucketpolicydefault) +* **Link**: [default](aws/aws.s3/default/types.md#resource-awss3bucketpolicydefault) ### aws.s3/multiregionaccesspointpolicy -* [default](aws/aws.s3/default/types.md#resource-awss3multiregionaccesspointpolicydefault) +* **Link**: [default](aws/aws.s3/default/types.md#resource-awss3multiregionaccesspointpolicydefault) ### aws.s3/storagelens -* [default](aws/aws.s3/default/types.md#resource-awss3storagelensdefault) +* **Link**: [default](aws/aws.s3/default/types.md#resource-awss3storagelensdefault) ### aws.s3/storagelensgroup -* [default](aws/aws.s3/default/types.md#resource-awss3storagelensgroupdefault) +* **Link**: [default](aws/aws.s3/default/types.md#resource-awss3storagelensgroupdefault) ## aws.s3express ### aws.s3express/bucketpolicy -* [default](aws/aws.s3express/default/types.md#resource-awss3expressbucketpolicydefault) +* **Link**: [default](aws/aws.s3express/default/types.md#resource-awss3expressbucketpolicydefault) ## aws.s3objectlambda ### aws.s3objectlambda/accesspoint -* [default](aws/aws.s3objectlambda/default/types.md#resource-awss3objectlambdaaccesspointdefault) +* **Link**: [default](aws/aws.s3objectlambda/default/types.md#resource-awss3objectlambdaaccesspointdefault) ### aws.s3objectlambda/accesspointpolicy -* [default](aws/aws.s3objectlambda/default/types.md#resource-awss3objectlambdaaccesspointpolicydefault) +* **Link**: [default](aws/aws.s3objectlambda/default/types.md#resource-awss3objectlambdaaccesspointpolicydefault) ## aws.s3outposts ### aws.s3outposts/accesspoint -* [default](aws/aws.s3outposts/default/types.md#resource-awss3outpostsaccesspointdefault) +* **Link**: [default](aws/aws.s3outposts/default/types.md#resource-awss3outpostsaccesspointdefault) ### aws.s3outposts/bucket -* [default](aws/aws.s3outposts/default/types.md#resource-awss3outpostsbucketdefault) +* **Link**: [default](aws/aws.s3outposts/default/types.md#resource-awss3outpostsbucketdefault) ### aws.s3outposts/bucketpolicy -* [default](aws/aws.s3outposts/default/types.md#resource-awss3outpostsbucketpolicydefault) +* **Link**: [default](aws/aws.s3outposts/default/types.md#resource-awss3outpostsbucketpolicydefault) ## aws.sagemaker ### aws.sagemaker/appimageconfig -* [default](aws/aws.sagemaker/default/types.md#resource-awssagemakerappimageconfigdefault) +* **Link**: [default](aws/aws.sagemaker/default/types.md#resource-awssagemakerappimageconfigdefault) ### aws.sagemaker/device -* [default](aws/aws.sagemaker/default/types.md#resource-awssagemakerdevicedefault) +* **Link**: [default](aws/aws.sagemaker/default/types.md#resource-awssagemakerdevicedefault) ### aws.sagemaker/devicefleet -* [default](aws/aws.sagemaker/default/types.md#resource-awssagemakerdevicefleetdefault) +* **Link**: [default](aws/aws.sagemaker/default/types.md#resource-awssagemakerdevicefleetdefault) ### aws.sagemaker/domain -* [default](aws/aws.sagemaker/default/types.md#resource-awssagemakerdomaindefault) +* **Link**: [default](aws/aws.sagemaker/default/types.md#resource-awssagemakerdomaindefault) ### aws.sagemaker/featuregroup -* [default](aws/aws.sagemaker/default/types.md#resource-awssagemakerfeaturegroupdefault) +* **Link**: [default](aws/aws.sagemaker/default/types.md#resource-awssagemakerfeaturegroupdefault) ### aws.sagemaker/image -* [default](aws/aws.sagemaker/default/types.md#resource-awssagemakerimagedefault) +* **Link**: [default](aws/aws.sagemaker/default/types.md#resource-awssagemakerimagedefault) ### aws.sagemaker/imageversion -* [default](aws/aws.sagemaker/default/types.md#resource-awssagemakerimageversiondefault) +* **Link**: [default](aws/aws.sagemaker/default/types.md#resource-awssagemakerimageversiondefault) ### aws.sagemaker/inferencecomponent -* [default](aws/aws.sagemaker/default/types.md#resource-awssagemakerinferencecomponentdefault) +* **Link**: [default](aws/aws.sagemaker/default/types.md#resource-awssagemakerinferencecomponentdefault) ### aws.sagemaker/inferenceexperiment -* [default](aws/aws.sagemaker/default/types.md#resource-awssagemakerinferenceexperimentdefault) +* **Link**: [default](aws/aws.sagemaker/default/types.md#resource-awssagemakerinferenceexperimentdefault) ### aws.sagemaker/modelcard -* [default](aws/aws.sagemaker/default/types.md#resource-awssagemakermodelcarddefault) +* **Link**: [default](aws/aws.sagemaker/default/types.md#resource-awssagemakermodelcarddefault) ### aws.sagemaker/modelpackage -* [default](aws/aws.sagemaker/default/types.md#resource-awssagemakermodelpackagedefault) +* **Link**: [default](aws/aws.sagemaker/default/types.md#resource-awssagemakermodelpackagedefault) ### aws.sagemaker/modelpackagegroup -* [default](aws/aws.sagemaker/default/types.md#resource-awssagemakermodelpackagegroupdefault) +* **Link**: [default](aws/aws.sagemaker/default/types.md#resource-awssagemakermodelpackagegroupdefault) ### aws.sagemaker/monitoringschedule -* [default](aws/aws.sagemaker/default/types.md#resource-awssagemakermonitoringscheduledefault) +* **Link**: [default](aws/aws.sagemaker/default/types.md#resource-awssagemakermonitoringscheduledefault) ### aws.sagemaker/pipeline -* [default](aws/aws.sagemaker/default/types.md#resource-awssagemakerpipelinedefault) +* **Link**: [default](aws/aws.sagemaker/default/types.md#resource-awssagemakerpipelinedefault) ### aws.sagemaker/project -* [default](aws/aws.sagemaker/default/types.md#resource-awssagemakerprojectdefault) +* **Link**: [default](aws/aws.sagemaker/default/types.md#resource-awssagemakerprojectdefault) ### aws.sagemaker/space -* [default](aws/aws.sagemaker/default/types.md#resource-awssagemakerspacedefault) +* **Link**: [default](aws/aws.sagemaker/default/types.md#resource-awssagemakerspacedefault) ### aws.sagemaker/userprofile -* [default](aws/aws.sagemaker/default/types.md#resource-awssagemakeruserprofiledefault) +* **Link**: [default](aws/aws.sagemaker/default/types.md#resource-awssagemakeruserprofiledefault) ## aws.scheduler ### aws.scheduler/schedule -* [default](aws/aws.scheduler/default/types.md#resource-awsschedulerscheduledefault) +* **Link**: [default](aws/aws.scheduler/default/types.md#resource-awsschedulerscheduledefault) ### aws.scheduler/schedulegroup -* [default](aws/aws.scheduler/default/types.md#resource-awsschedulerschedulegroupdefault) +* **Link**: [default](aws/aws.scheduler/default/types.md#resource-awsschedulerschedulegroupdefault) ## aws.secretsmanager ### aws.secretsmanager/secret -* [default](aws/aws.secretsmanager/default/types.md#resource-awssecretsmanagersecretdefault) +* **Link**: [default](aws/aws.secretsmanager/default/types.md#resource-awssecretsmanagersecretdefault) ## aws.securityhub ### aws.securityhub/automationrule -* [default](aws/aws.securityhub/default/types.md#resource-awssecurityhubautomationruledefault) +* **Link**: [default](aws/aws.securityhub/default/types.md#resource-awssecurityhubautomationruledefault) + +### aws.securityhub/configurationpolicy +* **Link**: [default](aws/aws.securityhub/default/types.md#resource-awssecurityhubconfigurationpolicydefault) + +### aws.securityhub/findingaggregator +* **Link**: [default](aws/aws.securityhub/default/types.md#resource-awssecurityhubfindingaggregatordefault) ### aws.securityhub/hub -* [default](aws/aws.securityhub/default/types.md#resource-awssecurityhubhubdefault) +* **Link**: [default](aws/aws.securityhub/default/types.md#resource-awssecurityhubhubdefault) + +### aws.securityhub/insight +* **Link**: [default](aws/aws.securityhub/default/types.md#resource-awssecurityhubinsightdefault) + +### aws.securityhub/organizationconfiguration +* **Link**: [default](aws/aws.securityhub/default/types.md#resource-awssecurityhuborganizationconfigurationdefault) + +### aws.securityhub/policyassociation +* **Link**: [default](aws/aws.securityhub/default/types.md#resource-awssecurityhubpolicyassociationdefault) + +### aws.securityhub/securitycontrol +* **Link**: [default](aws/aws.securityhub/default/types.md#resource-awssecurityhubsecuritycontroldefault) ### aws.securityhub/standard -* [default](aws/aws.securityhub/default/types.md#resource-awssecurityhubstandarddefault) +* **Link**: [default](aws/aws.securityhub/default/types.md#resource-awssecurityhubstandarddefault) + +## aws.securitylake +### aws.securitylake/awslogsource +* **Link**: [default](aws/aws.securitylake/default/types.md#resource-awssecuritylakeawslogsourcedefault) + +### aws.securitylake/datalake +* **Link**: [default](aws/aws.securitylake/default/types.md#resource-awssecuritylakedatalakedefault) + +### aws.securitylake/subscriber +* **Link**: [default](aws/aws.securitylake/default/types.md#resource-awssecuritylakesubscriberdefault) + +### aws.securitylake/subscribernotification +* **Link**: [default](aws/aws.securitylake/default/types.md#resource-awssecuritylakesubscribernotificationdefault) ## aws.servicecatalog ### aws.servicecatalog/cloudformationprovisionedproduct -* [default](aws/aws.servicecatalog/default/types.md#resource-awsservicecatalogcloudformationprovisionedproductdefault) +* **Link**: [default](aws/aws.servicecatalog/default/types.md#resource-awsservicecatalogcloudformationprovisionedproductdefault) ### aws.servicecatalog/serviceaction -* [default](aws/aws.servicecatalog/default/types.md#resource-awsservicecatalogserviceactiondefault) +* **Link**: [default](aws/aws.servicecatalog/default/types.md#resource-awsservicecatalogserviceactiondefault) ## aws.servicecatalogappregistry ### aws.servicecatalogappregistry/application -* [default](aws/aws.servicecatalogappregistry/default/types.md#resource-awsservicecatalogappregistryapplicationdefault) +* **Link**: [default](aws/aws.servicecatalogappregistry/default/types.md#resource-awsservicecatalogappregistryapplicationdefault) ### aws.servicecatalogappregistry/attributegroup -* [default](aws/aws.servicecatalogappregistry/default/types.md#resource-awsservicecatalogappregistryattributegroupdefault) +* **Link**: [default](aws/aws.servicecatalogappregistry/default/types.md#resource-awsservicecatalogappregistryattributegroupdefault) ## aws.ses ### aws.ses/configurationset -* [default](aws/aws.ses/default/types.md#resource-awssesconfigurationsetdefault) +* **Link**: [default](aws/aws.ses/default/types.md#resource-awssesconfigurationsetdefault) ### aws.ses/configurationseteventdestination -* [default](aws/aws.ses/default/types.md#resource-awssesconfigurationseteventdestinationdefault) +* **Link**: [default](aws/aws.ses/default/types.md#resource-awssesconfigurationseteventdestinationdefault) ### aws.ses/contactlist -* [default](aws/aws.ses/default/types.md#resource-awssescontactlistdefault) +* **Link**: [default](aws/aws.ses/default/types.md#resource-awssescontactlistdefault) ### aws.ses/dedicatedippool -* [default](aws/aws.ses/default/types.md#resource-awssesdedicatedippooldefault) +* **Link**: [default](aws/aws.ses/default/types.md#resource-awssesdedicatedippooldefault) ### aws.ses/emailidentity -* [default](aws/aws.ses/default/types.md#resource-awssesemailidentitydefault) +* **Link**: [default](aws/aws.ses/default/types.md#resource-awssesemailidentitydefault) ### aws.ses/template -* [default](aws/aws.ses/default/types.md#resource-awssestemplatedefault) +* **Link**: [default](aws/aws.ses/default/types.md#resource-awssestemplatedefault) ### aws.ses/vdmattributes -* [default](aws/aws.ses/default/types.md#resource-awssesvdmattributesdefault) +* **Link**: [default](aws/aws.ses/default/types.md#resource-awssesvdmattributesdefault) ## aws.shield ### aws.shield/drtaccess -* [default](aws/aws.shield/default/types.md#resource-awsshielddrtaccessdefault) +* **Link**: [default](aws/aws.shield/default/types.md#resource-awsshielddrtaccessdefault) ### aws.shield/proactiveengagement -* [default](aws/aws.shield/default/types.md#resource-awsshieldproactiveengagementdefault) +* **Link**: [default](aws/aws.shield/default/types.md#resource-awsshieldproactiveengagementdefault) ### aws.shield/protection -* [default](aws/aws.shield/default/types.md#resource-awsshieldprotectiondefault) +* **Link**: [default](aws/aws.shield/default/types.md#resource-awsshieldprotectiondefault) ### aws.shield/protectiongroup -* [default](aws/aws.shield/default/types.md#resource-awsshieldprotectiongroupdefault) +* **Link**: [default](aws/aws.shield/default/types.md#resource-awsshieldprotectiongroupdefault) ## aws.signer ### aws.signer/signingprofile -* [default](aws/aws.signer/default/types.md#resource-awssignersigningprofiledefault) +* **Link**: [default](aws/aws.signer/default/types.md#resource-awssignersigningprofiledefault) ## aws.simspaceweaver ### aws.simspaceweaver/simulation -* [default](aws/aws.simspaceweaver/default/types.md#resource-awssimspaceweaversimulationdefault) +* **Link**: [default](aws/aws.simspaceweaver/default/types.md#resource-awssimspaceweaversimulationdefault) ## aws.sns ### aws.sns/topic -* [default](aws/aws.sns/default/types.md#resource-awssnstopicdefault) +* **Link**: [default](aws/aws.sns/default/types.md#resource-awssnstopicdefault) ### aws.sns/topicinlinepolicy -* [default](aws/aws.sns/default/types.md#resource-awssnstopicinlinepolicydefault) +* **Link**: [default](aws/aws.sns/default/types.md#resource-awssnstopicinlinepolicydefault) ## aws.sqs ### aws.sqs/queue -* [default](aws/aws.sqs/default/types.md#resource-awssqsqueuedefault) +* **Link**: [default](aws/aws.sqs/default/types.md#resource-awssqsqueuedefault) ### aws.sqs/queueinlinepolicy -* [default](aws/aws.sqs/default/types.md#resource-awssqsqueueinlinepolicydefault) +* **Link**: [default](aws/aws.sqs/default/types.md#resource-awssqsqueueinlinepolicydefault) ## aws.ssm ### aws.ssm/association -* [default](aws/aws.ssm/default/types.md#resource-awsssmassociationdefault) +* **Link**: [default](aws/aws.ssm/default/types.md#resource-awsssmassociationdefault) ### aws.ssm/document -* [default](aws/aws.ssm/default/types.md#resource-awsssmdocumentdefault) +* **Link**: [default](aws/aws.ssm/default/types.md#resource-awsssmdocumentdefault) ### aws.ssm/parameter -* [default](aws/aws.ssm/default/types.md#resource-awsssmparameterdefault) +* **Link**: [default](aws/aws.ssm/default/types.md#resource-awsssmparameterdefault) ### aws.ssm/patchbaseline -* [default](aws/aws.ssm/default/types.md#resource-awsssmpatchbaselinedefault) +* **Link**: [default](aws/aws.ssm/default/types.md#resource-awsssmpatchbaselinedefault) ### aws.ssm/resourcedatasync -* [default](aws/aws.ssm/default/types.md#resource-awsssmresourcedatasyncdefault) +* **Link**: [default](aws/aws.ssm/default/types.md#resource-awsssmresourcedatasyncdefault) ### aws.ssm/resourcepolicy -* [default](aws/aws.ssm/default/types.md#resource-awsssmresourcepolicydefault) +* **Link**: [default](aws/aws.ssm/default/types.md#resource-awsssmresourcepolicydefault) ## aws.ssmcontacts ### aws.ssmcontacts/contact -* [default](aws/aws.ssmcontacts/default/types.md#resource-awsssmcontactscontactdefault) +* **Link**: [default](aws/aws.ssmcontacts/default/types.md#resource-awsssmcontactscontactdefault) ### aws.ssmcontacts/contactchannel -* [default](aws/aws.ssmcontacts/default/types.md#resource-awsssmcontactscontactchanneldefault) +* **Link**: [default](aws/aws.ssmcontacts/default/types.md#resource-awsssmcontactscontactchanneldefault) ### aws.ssmcontacts/plan -* [default](aws/aws.ssmcontacts/default/types.md#resource-awsssmcontactsplandefault) +* **Link**: [default](aws/aws.ssmcontacts/default/types.md#resource-awsssmcontactsplandefault) ### aws.ssmcontacts/rotation -* [default](aws/aws.ssmcontacts/default/types.md#resource-awsssmcontactsrotationdefault) +* **Link**: [default](aws/aws.ssmcontacts/default/types.md#resource-awsssmcontactsrotationdefault) ## aws.ssmincidents ### aws.ssmincidents/replicationset -* [default](aws/aws.ssmincidents/default/types.md#resource-awsssmincidentsreplicationsetdefault) +* **Link**: [default](aws/aws.ssmincidents/default/types.md#resource-awsssmincidentsreplicationsetdefault) ### aws.ssmincidents/responseplan -* [default](aws/aws.ssmincidents/default/types.md#resource-awsssmincidentsresponseplandefault) +* **Link**: [default](aws/aws.ssmincidents/default/types.md#resource-awsssmincidentsresponseplandefault) ## aws.sso +### aws.sso/application +* **Link**: [default](aws/aws.sso/default/types.md#resource-awsssoapplicationdefault) + +### aws.sso/instance +* **Link**: [default](aws/aws.sso/default/types.md#resource-awsssoinstancedefault) + ### aws.sso/instanceaccesscontrolattributeconfiguration -* [default](aws/aws.sso/default/types.md#resource-awsssoinstanceaccesscontrolattributeconfigurationdefault) +* **Link**: [default](aws/aws.sso/default/types.md#resource-awsssoinstanceaccesscontrolattributeconfigurationdefault) ### aws.sso/permissionset -* [default](aws/aws.sso/default/types.md#resource-awsssopermissionsetdefault) +* **Link**: [default](aws/aws.sso/default/types.md#resource-awsssopermissionsetdefault) ## aws.stepfunctions ### aws.stepfunctions/activity -* [default](aws/aws.stepfunctions/default/types.md#resource-awsstepfunctionsactivitydefault) +* **Link**: [default](aws/aws.stepfunctions/default/types.md#resource-awsstepfunctionsactivitydefault) ### aws.stepfunctions/statemachine -* [default](aws/aws.stepfunctions/default/types.md#resource-awsstepfunctionsstatemachinedefault) +* **Link**: [default](aws/aws.stepfunctions/default/types.md#resource-awsstepfunctionsstatemachinedefault) ### aws.stepfunctions/statemachinealias -* [default](aws/aws.stepfunctions/default/types.md#resource-awsstepfunctionsstatemachinealiasdefault) +* **Link**: [default](aws/aws.stepfunctions/default/types.md#resource-awsstepfunctionsstatemachinealiasdefault) ## aws.supportapp ### aws.supportapp/accountalias -* [default](aws/aws.supportapp/default/types.md#resource-awssupportappaccountaliasdefault) +* **Link**: [default](aws/aws.supportapp/default/types.md#resource-awssupportappaccountaliasdefault) ### aws.supportapp/slackchannelconfiguration -* [default](aws/aws.supportapp/default/types.md#resource-awssupportappslackchannelconfigurationdefault) +* **Link**: [default](aws/aws.supportapp/default/types.md#resource-awssupportappslackchannelconfigurationdefault) ### aws.supportapp/slackworkspaceconfiguration -* [default](aws/aws.supportapp/default/types.md#resource-awssupportappslackworkspaceconfigurationdefault) +* **Link**: [default](aws/aws.supportapp/default/types.md#resource-awssupportappslackworkspaceconfigurationdefault) ## aws.synthetics ### aws.synthetics/canary -* [default](aws/aws.synthetics/default/types.md#resource-awssyntheticscanarydefault) +* **Link**: [default](aws/aws.synthetics/default/types.md#resource-awssyntheticscanarydefault) ### aws.synthetics/group -* [default](aws/aws.synthetics/default/types.md#resource-awssyntheticsgroupdefault) +* **Link**: [default](aws/aws.synthetics/default/types.md#resource-awssyntheticsgroupdefault) ## aws.systemsmanagersap ### aws.systemsmanagersap/application -* [default](aws/aws.systemsmanagersap/default/types.md#resource-awssystemsmanagersapapplicationdefault) +* **Link**: [default](aws/aws.systemsmanagersap/default/types.md#resource-awssystemsmanagersapapplicationdefault) ## aws.timestream ### aws.timestream/database -* [default](aws/aws.timestream/default/types.md#resource-awstimestreamdatabasedefault) +* **Link**: [default](aws/aws.timestream/default/types.md#resource-awstimestreamdatabasedefault) + +### aws.timestream/influxdbinstance +* **Link**: [default](aws/aws.timestream/default/types.md#resource-awstimestreaminfluxdbinstancedefault) ### aws.timestream/scheduledquery -* [default](aws/aws.timestream/default/types.md#resource-awstimestreamscheduledquerydefault) +* **Link**: [default](aws/aws.timestream/default/types.md#resource-awstimestreamscheduledquerydefault) ### aws.timestream/table -* [default](aws/aws.timestream/default/types.md#resource-awstimestreamtabledefault) +* **Link**: [default](aws/aws.timestream/default/types.md#resource-awstimestreamtabledefault) ## aws.transfer ### aws.transfer/agreement -* [default](aws/aws.transfer/default/types.md#resource-awstransferagreementdefault) +* **Link**: [default](aws/aws.transfer/default/types.md#resource-awstransferagreementdefault) ### aws.transfer/certificate -* [default](aws/aws.transfer/default/types.md#resource-awstransfercertificatedefault) +* **Link**: [default](aws/aws.transfer/default/types.md#resource-awstransfercertificatedefault) ### aws.transfer/connector -* [default](aws/aws.transfer/default/types.md#resource-awstransferconnectordefault) +* **Link**: [default](aws/aws.transfer/default/types.md#resource-awstransferconnectordefault) ### aws.transfer/profile -* [default](aws/aws.transfer/default/types.md#resource-awstransferprofiledefault) +* **Link**: [default](aws/aws.transfer/default/types.md#resource-awstransferprofiledefault) ### aws.transfer/workflow -* [default](aws/aws.transfer/default/types.md#resource-awstransferworkflowdefault) +* **Link**: [default](aws/aws.transfer/default/types.md#resource-awstransferworkflowdefault) ## aws.verifiedpermissions ### aws.verifiedpermissions/identitysource -* [default](aws/aws.verifiedpermissions/default/types.md#resource-awsverifiedpermissionsidentitysourcedefault) +* **Link**: [default](aws/aws.verifiedpermissions/default/types.md#resource-awsverifiedpermissionsidentitysourcedefault) ### aws.verifiedpermissions/policy -* [default](aws/aws.verifiedpermissions/default/types.md#resource-awsverifiedpermissionspolicydefault) +* **Link**: [default](aws/aws.verifiedpermissions/default/types.md#resource-awsverifiedpermissionspolicydefault) ### aws.verifiedpermissions/policystore -* [default](aws/aws.verifiedpermissions/default/types.md#resource-awsverifiedpermissionspolicystoredefault) +* **Link**: [default](aws/aws.verifiedpermissions/default/types.md#resource-awsverifiedpermissionspolicystoredefault) ### aws.verifiedpermissions/policytemplate -* [default](aws/aws.verifiedpermissions/default/types.md#resource-awsverifiedpermissionspolicytemplatedefault) +* **Link**: [default](aws/aws.verifiedpermissions/default/types.md#resource-awsverifiedpermissionspolicytemplatedefault) ## aws.voiceid ### aws.voiceid/domain -* [default](aws/aws.voiceid/default/types.md#resource-awsvoiceiddomaindefault) +* **Link**: [default](aws/aws.voiceid/default/types.md#resource-awsvoiceiddomaindefault) ## aws.vpclattice ### aws.vpclattice/accesslogsubscription -* [default](aws/aws.vpclattice/default/types.md#resource-awsvpclatticeaccesslogsubscriptiondefault) +* **Link**: [default](aws/aws.vpclattice/default/types.md#resource-awsvpclatticeaccesslogsubscriptiondefault) ### aws.vpclattice/authpolicy -* [default](aws/aws.vpclattice/default/types.md#resource-awsvpclatticeauthpolicydefault) +* **Link**: [default](aws/aws.vpclattice/default/types.md#resource-awsvpclatticeauthpolicydefault) ### aws.vpclattice/listener -* [default](aws/aws.vpclattice/default/types.md#resource-awsvpclatticelistenerdefault) +* **Link**: [default](aws/aws.vpclattice/default/types.md#resource-awsvpclatticelistenerdefault) ### aws.vpclattice/resourcepolicy -* [default](aws/aws.vpclattice/default/types.md#resource-awsvpclatticeresourcepolicydefault) +* **Link**: [default](aws/aws.vpclattice/default/types.md#resource-awsvpclatticeresourcepolicydefault) ### aws.vpclattice/rule -* [default](aws/aws.vpclattice/default/types.md#resource-awsvpclatticeruledefault) +* **Link**: [default](aws/aws.vpclattice/default/types.md#resource-awsvpclatticeruledefault) ### aws.vpclattice/service -* [default](aws/aws.vpclattice/default/types.md#resource-awsvpclatticeservicedefault) +* **Link**: [default](aws/aws.vpclattice/default/types.md#resource-awsvpclatticeservicedefault) ### aws.vpclattice/servicenetwork -* [default](aws/aws.vpclattice/default/types.md#resource-awsvpclatticeservicenetworkdefault) +* **Link**: [default](aws/aws.vpclattice/default/types.md#resource-awsvpclatticeservicenetworkdefault) ### aws.vpclattice/servicenetworkserviceassociation -* [default](aws/aws.vpclattice/default/types.md#resource-awsvpclatticeservicenetworkserviceassociationdefault) +* **Link**: [default](aws/aws.vpclattice/default/types.md#resource-awsvpclatticeservicenetworkserviceassociationdefault) ### aws.vpclattice/servicenetworkvpcassociation -* [default](aws/aws.vpclattice/default/types.md#resource-awsvpclatticeservicenetworkvpcassociationdefault) +* **Link**: [default](aws/aws.vpclattice/default/types.md#resource-awsvpclatticeservicenetworkvpcassociationdefault) ### aws.vpclattice/targetgroup -* [default](aws/aws.vpclattice/default/types.md#resource-awsvpclatticetargetgroupdefault) +* **Link**: [default](aws/aws.vpclattice/default/types.md#resource-awsvpclatticetargetgroupdefault) ## aws.wafv2 ### aws.wafv2/ipset -* [default](aws/aws.wafv2/default/types.md#resource-awswafv2ipsetdefault) +* **Link**: [default](aws/aws.wafv2/default/types.md#resource-awswafv2ipsetdefault) ### aws.wafv2/loggingconfiguration -* [default](aws/aws.wafv2/default/types.md#resource-awswafv2loggingconfigurationdefault) +* **Link**: [default](aws/aws.wafv2/default/types.md#resource-awswafv2loggingconfigurationdefault) ### aws.wafv2/regexpatternset -* [default](aws/aws.wafv2/default/types.md#resource-awswafv2regexpatternsetdefault) +* **Link**: [default](aws/aws.wafv2/default/types.md#resource-awswafv2regexpatternsetdefault) ### aws.wafv2/rulegroup -* [default](aws/aws.wafv2/default/types.md#resource-awswafv2rulegroupdefault) +* **Link**: [default](aws/aws.wafv2/default/types.md#resource-awswafv2rulegroupdefault) ### aws.wafv2/webacl -* [default](aws/aws.wafv2/default/types.md#resource-awswafv2webacldefault) +* **Link**: [default](aws/aws.wafv2/default/types.md#resource-awswafv2webacldefault) ### aws.wafv2/webaclassociation -* [default](aws/aws.wafv2/default/types.md#resource-awswafv2webaclassociationdefault) +* **Link**: [default](aws/aws.wafv2/default/types.md#resource-awswafv2webaclassociationdefault) ## aws.wisdom ### aws.wisdom/assistant -* [default](aws/aws.wisdom/default/types.md#resource-awswisdomassistantdefault) +* **Link**: [default](aws/aws.wisdom/default/types.md#resource-awswisdomassistantdefault) ### aws.wisdom/assistantassociation -* [default](aws/aws.wisdom/default/types.md#resource-awswisdomassistantassociationdefault) +* **Link**: [default](aws/aws.wisdom/default/types.md#resource-awswisdomassistantassociationdefault) ### aws.wisdom/knowledgebase -* [default](aws/aws.wisdom/default/types.md#resource-awswisdomknowledgebasedefault) +* **Link**: [default](aws/aws.wisdom/default/types.md#resource-awswisdomknowledgebasedefault) + +## aws.workspaces +### aws.workspaces/workspacespool +* **Link**: [default](aws/aws.workspaces/default/types.md#resource-awsworkspacesworkspacespooldefault) ## aws.workspacesthinclient ### aws.workspacesthinclient/environment -* [default](aws/aws.workspacesthinclient/default/types.md#resource-awsworkspacesthinclientenvironmentdefault) +* **Link**: [default](aws/aws.workspacesthinclient/default/types.md#resource-awsworkspacesthinclientenvironmentdefault) ## aws.workspacesweb ### aws.workspacesweb/browsersettings -* [default](aws/aws.workspacesweb/default/types.md#resource-awsworkspaceswebbrowsersettingsdefault) +* **Link**: [default](aws/aws.workspacesweb/default/types.md#resource-awsworkspaceswebbrowsersettingsdefault) ### aws.workspacesweb/identityprovider -* [default](aws/aws.workspacesweb/default/types.md#resource-awsworkspaceswebidentityproviderdefault) +* **Link**: [default](aws/aws.workspacesweb/default/types.md#resource-awsworkspaceswebidentityproviderdefault) ### aws.workspacesweb/ipaccesssettings -* [default](aws/aws.workspacesweb/default/types.md#resource-awsworkspaceswebipaccesssettingsdefault) +* **Link**: [default](aws/aws.workspacesweb/default/types.md#resource-awsworkspaceswebipaccesssettingsdefault) ### aws.workspacesweb/networksettings -* [default](aws/aws.workspacesweb/default/types.md#resource-awsworkspaceswebnetworksettingsdefault) +* **Link**: [default](aws/aws.workspacesweb/default/types.md#resource-awsworkspaceswebnetworksettingsdefault) ### aws.workspacesweb/portal -* [default](aws/aws.workspacesweb/default/types.md#resource-awsworkspaceswebportaldefault) +* **Link**: [default](aws/aws.workspacesweb/default/types.md#resource-awsworkspaceswebportaldefault) ### aws.workspacesweb/truststore -* [default](aws/aws.workspacesweb/default/types.md#resource-awsworkspaceswebtruststoredefault) +* **Link**: [default](aws/aws.workspacesweb/default/types.md#resource-awsworkspaceswebtruststoredefault) ### aws.workspacesweb/useraccessloggingsettings -* [default](aws/aws.workspacesweb/default/types.md#resource-awsworkspaceswebuseraccessloggingsettingsdefault) +* **Link**: [default](aws/aws.workspacesweb/default/types.md#resource-awsworkspaceswebuseraccessloggingsettingsdefault) ### aws.workspacesweb/usersettings -* [default](aws/aws.workspacesweb/default/types.md#resource-awsworkspaceswebusersettingsdefault) +* **Link**: [default](aws/aws.workspacesweb/default/types.md#resource-awsworkspaceswebusersettingsdefault) ## aws.xray ### aws.xray/group -* [default](aws/aws.xray/default/types.md#resource-awsxraygroupdefault) +* **Link**: [default](aws/aws.xray/default/types.md#resource-awsxraygroupdefault) ### aws.xray/resourcepolicy -* [default](aws/aws.xray/default/types.md#resource-awsxrayresourcepolicydefault) +* **Link**: [default](aws/aws.xray/default/types.md#resource-awsxrayresourcepolicydefault) ### aws.xray/samplingrule -* [default](aws/aws.xray/default/types.md#resource-awsxraysamplingruledefault) +* **Link**: [default](aws/aws.xray/default/types.md#resource-awsxraysamplingruledefault) diff --git a/artifacts/types/AWS::ACMPCA::Certificate.json b/artifacts/types/AWS::ACMPCA::Certificate.json deleted file mode 100644 index 55a1837b..00000000 --- a/artifacts/types/AWS::ACMPCA::Certificate.json +++ /dev/null @@ -1,469 +0,0 @@ -{ - "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ACMPCA-Certificate", - "type": "AWS::ACMPCA::Certificate", - "time": "2023-12-27T14:22:10.824Z", - "schema": { - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/ApiPassthrough", - "/properties/CertificateAuthorityArn", - "/properties/CertificateSigningRequest", - "/properties/SigningAlgorithm", - "/properties/TemplateArn", - "/properties/Validity", - "/properties/ValidityNotBefore" - ], - "definitions": { - "ApiPassthrough": { - "additionalProperties": false, - "description": "Structure that specifies fields to be overridden in a certificate at the time of issuance. These requires an API Passthrough template be used or they will be ignored.", - "properties": { - "Extensions": { - "$ref": "#/definitions/Extensions" - }, - "Subject": { - "$ref": "#/definitions/Subject" - } - }, - "type": "object" - }, - "Arn": { - "type": "string" - }, - "CertificatePolicyList": { - "items": { - "$ref": "#/definitions/PolicyInformation" - }, - "type": "array" - }, - "CustomAttribute": { - "additionalProperties": false, - "description": "Structure that contains X.500 attribute type and value.", - "properties": { - "ObjectIdentifier": { - "$ref": "#/definitions/CustomObjectIdentifier" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "ObjectIdentifier", - "Value" - ], - "type": "object" - }, - "CustomAttributeList": { - "description": "Array of X.500 attribute type and value. CustomAttributes cannot be used along with pre-defined attributes.", - "items": { - "$ref": "#/definitions/CustomAttribute" - }, - "type": "array" - }, - "CustomExtension": { - "additionalProperties": false, - "description": "Structure that contains X.509 extension information for a certificate.", - "properties": { - "Critical": { - "type": "boolean" - }, - "ObjectIdentifier": { - "$ref": "#/definitions/CustomObjectIdentifier" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "ObjectIdentifier", - "Value" - ], - "type": "object" - }, - "CustomExtensionList": { - "description": "Array of X.509 extensions for a certificate.", - "items": { - "$ref": "#/definitions/CustomExtension" - }, - "type": "array" - }, - "CustomObjectIdentifier": { - "description": "String that contains X.509 ObjectIdentifier information.", - "type": "string" - }, - "DnsName": { - "description": "String that contains X.509 DnsName information.", - "type": "string" - }, - "EdiPartyName": { - "additionalProperties": false, - "description": "Structure that contains X.509 EdiPartyName information.", - "properties": { - "NameAssigner": { - "type": "string" - }, - "PartyName": { - "type": "string" - } - }, - "required": [ - "PartyName", - "NameAssigner" - ], - "type": "object" - }, - "ExtendedKeyUsage": { - "additionalProperties": false, - "description": "Structure that contains X.509 ExtendedKeyUsage information.", - "properties": { - "ExtendedKeyUsageObjectIdentifier": { - "$ref": "#/definitions/CustomObjectIdentifier" - }, - "ExtendedKeyUsageType": { - "type": "string" - } - }, - "type": "object" - }, - "ExtendedKeyUsageList": { - "items": { - "$ref": "#/definitions/ExtendedKeyUsage" - }, - "type": "array" - }, - "Extensions": { - "additionalProperties": false, - "description": "Structure that contains X.500 extensions for a Certificate.", - "properties": { - "CertificatePolicies": { - "$ref": "#/definitions/CertificatePolicyList" - }, - "CustomExtensions": { - "$ref": "#/definitions/CustomExtensionList" - }, - "ExtendedKeyUsage": { - "$ref": "#/definitions/ExtendedKeyUsageList" - }, - "KeyUsage": { - "$ref": "#/definitions/KeyUsage" - }, - "SubjectAlternativeNames": { - "$ref": "#/definitions/GeneralNameList" - } - }, - "type": "object" - }, - "GeneralName": { - "additionalProperties": false, - "description": "Structure that contains X.509 GeneralName information. Assign one and ONLY one field.", - "properties": { - "DirectoryName": { - "$ref": "#/definitions/Subject" - }, - "DnsName": { - "$ref": "#/definitions/DnsName" - }, - "EdiPartyName": { - "$ref": "#/definitions/EdiPartyName" - }, - "IpAddress": { - "$ref": "#/definitions/IpAddress" - }, - "OtherName": { - "$ref": "#/definitions/OtherName" - }, - "RegisteredId": { - "$ref": "#/definitions/CustomObjectIdentifier" - }, - "Rfc822Name": { - "$ref": "#/definitions/Rfc822Name" - }, - "UniformResourceIdentifier": { - "$ref": "#/definitions/UniformResourceIdentifier" - } - }, - "type": "object" - }, - "GeneralNameList": { - "items": { - "$ref": "#/definitions/GeneralName" - }, - "type": "array" - }, - "IpAddress": { - "description": "String that contains X.509 IpAddress information.", - "type": "string" - }, - "KeyUsage": { - "additionalProperties": false, - "description": "Structure that contains X.509 KeyUsage information.", - "properties": { - "CRLSign": { - "default": false, - "type": "boolean" - }, - "DataEncipherment": { - "default": false, - "type": "boolean" - }, - "DecipherOnly": { - "default": false, - "type": "boolean" - }, - "DigitalSignature": { - "default": false, - "type": "boolean" - }, - "EncipherOnly": { - "default": false, - "type": "boolean" - }, - "KeyAgreement": { - "default": false, - "type": "boolean" - }, - "KeyCertSign": { - "default": false, - "type": "boolean" - }, - "KeyEncipherment": { - "default": false, - "type": "boolean" - }, - "NonRepudiation": { - "default": false, - "type": "boolean" - } - }, - "type": "object" - }, - "OtherName": { - "additionalProperties": false, - "description": "Structure that contains X.509 OtherName information.", - "properties": { - "TypeId": { - "$ref": "#/definitions/CustomObjectIdentifier" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "TypeId", - "Value" - ], - "type": "object" - }, - "PolicyInformation": { - "additionalProperties": false, - "description": "Structure that contains X.509 Policy information.", - "properties": { - "CertPolicyId": { - "$ref": "#/definitions/CustomObjectIdentifier" - }, - "PolicyQualifiers": { - "$ref": "#/definitions/PolicyQualifierInfoList" - } - }, - "required": [ - "CertPolicyId" - ], - "type": "object" - }, - "PolicyQualifierInfo": { - "additionalProperties": false, - "description": "Structure that contains X.509 Policy qualifier information.", - "properties": { - "PolicyQualifierId": { - "type": "string" - }, - "Qualifier": { - "$ref": "#/definitions/Qualifier" - } - }, - "required": [ - "PolicyQualifierId", - "Qualifier" - ], - "type": "object" - }, - "PolicyQualifierInfoList": { - "items": { - "$ref": "#/definitions/PolicyQualifierInfo" - }, - "type": "array" - }, - "Qualifier": { - "additionalProperties": false, - "description": "Structure that contains a X.509 policy qualifier.", - "properties": { - "CpsUri": { - "type": "string" - } - }, - "required": [ - "CpsUri" - ], - "type": "object" - }, - "Rfc822Name": { - "description": "String that contains X.509 Rfc822Name information.", - "type": "string" - }, - "Subject": { - "additionalProperties": false, - "description": "Structure that contains X.500 distinguished name information.", - "properties": { - "CommonName": { - "type": "string" - }, - "Country": { - "type": "string" - }, - "CustomAttributes": { - "$ref": "#/definitions/CustomAttributeList" - }, - "DistinguishedNameQualifier": { - "type": "string" - }, - "GenerationQualifier": { - "type": "string" - }, - "GivenName": { - "type": "string" - }, - "Initials": { - "type": "string" - }, - "Locality": { - "type": "string" - }, - "Organization": { - "type": "string" - }, - "OrganizationalUnit": { - "type": "string" - }, - "Pseudonym": { - "type": "string" - }, - "SerialNumber": { - "type": "string" - }, - "State": { - "type": "string" - }, - "Surname": { - "type": "string" - }, - "Title": { - "type": "string" - } - }, - "type": "object" - }, - "UniformResourceIdentifier": { - "description": "String that contains X.509 UniformResourceIdentifier information.", - "type": "string" - }, - "Validity": { - "additionalProperties": false, - "description": "Validity for a certificate.", - "properties": { - "Type": { - "type": "string" - }, - "Value": { - "type": "number" - } - }, - "required": [ - "Value", - "Type" - ], - "type": "object" - } - }, - "description": "A certificate issued via a private certificate authority", - "handlers": { - "create": { - "permissions": [ - "acm-pca:IssueCertificate", - "acm-pca:GetCertificate" - ] - }, - "delete": { - "permissions": [ - "acm-pca:GetCertificate" - ] - }, - "read": { - "permissions": [ - "acm-pca:GetCertificate" - ] - }, - "update": { - "permissions": [] - } - }, - "primaryIdentifier": [ - "/properties/Arn", - "/properties/CertificateAuthorityArn" - ], - "properties": { - "ApiPassthrough": { - "$ref": "#/definitions/ApiPassthrough", - "description": "These are fields to be overridden in a certificate at the time of issuance. These requires an API_Passthrough template be used or they will be ignored." - }, - "Arn": { - "$ref": "#/definitions/Arn", - "description": "The ARN of the issued certificate." - }, - "Certificate": { - "description": "The issued certificate in base 64 PEM-encoded format.", - "type": "string" - }, - "CertificateAuthorityArn": { - "$ref": "#/definitions/Arn", - "description": "The Amazon Resource Name (ARN) for the private CA to issue the certificate." - }, - "CertificateSigningRequest": { - "description": "The certificate signing request (CSR) for the Certificate.", - "minLength": 1, - "type": "string" - }, - "SigningAlgorithm": { - "description": "The name of the algorithm that will be used to sign the Certificate.", - "type": "string" - }, - "TemplateArn": { - "$ref": "#/definitions/Arn", - "description": "Specifies a custom configuration template to use when issuing a certificate. If this parameter is not provided, ACM Private CA defaults to the EndEntityCertificate/V1 template." - }, - "Validity": { - "$ref": "#/definitions/Validity", - "description": "The time before which the Certificate will be valid." - }, - "ValidityNotBefore": { - "$ref": "#/definitions/Validity", - "description": "The time after which the Certificate will be valid." - } - }, - "readOnlyProperties": [ - "/properties/Arn", - "/properties/Certificate" - ], - "required": [ - "CertificateAuthorityArn", - "CertificateSigningRequest", - "SigningAlgorithm", - "Validity" - ], - "sourceUrl": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_ACMPCA.html", - "typeName": "AWS::ACMPCA::Certificate", - "writeOnlyProperties": [ - "/properties/ApiPassthrough", - "/properties/CertificateSigningRequest" - ] - } -} \ No newline at end of file diff --git a/artifacts/types/AWS::ACMPCA::CertificateAuthority.json b/artifacts/types/AWS::ACMPCA::CertificateAuthority.json index 614ea13e..8383e6a9 100644 --- a/artifacts/types/AWS::ACMPCA::CertificateAuthority.json +++ b/artifacts/types/AWS::ACMPCA::CertificateAuthority.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ACMPCA-CertificateAuthority", "type": "AWS::ACMPCA::CertificateAuthority", - "time": "2023-12-27T15:53:02.297Z", + "time": "2024-06-24T13:37:40.379Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -55,6 +55,9 @@ "additionalProperties": false, "description": "Your certificate authority can create and maintain a certificate revocation list (CRL). A CRL contains information about certificates that have been revoked.", "properties": { + "CrlDistributionPointExtensionConfiguration": { + "$ref": "#/definitions/CrlDistributionPointExtensionConfiguration" + }, "CustomCname": { "type": "string" }, @@ -71,6 +74,22 @@ "type": "string" } }, + "required": [ + "Enabled" + ], + "type": "object" + }, + "CrlDistributionPointExtensionConfiguration": { + "additionalProperties": false, + "description": "Configures the default behavior of the CRL Distribution Point extension for certificates issued by your certificate authority", + "properties": { + "OmitExtension": { + "type": "boolean" + } + }, + "required": [ + "OmitExtension" + ], "type": "object" }, "CsrExtensions": { @@ -130,8 +149,7 @@ } }, "required": [ - "PartyName", - "NameAssigner" + "PartyName" ], "type": "object" }, @@ -224,6 +242,9 @@ "type": "string" } }, + "required": [ + "Enabled" + ], "type": "object" }, "OtherName": { @@ -329,6 +350,9 @@ "type": "string" } }, + "required": [ + "Key" + ], "type": "object" }, "UniformResourceIdentifier": { @@ -347,7 +371,8 @@ }, "delete": { "permissions": [ - "acm-pca:DeleteCertificateAuthority" + "acm-pca:DeleteCertificateAuthority", + "acm-pca:DescribeCertificateAuthority" ] }, "list": { @@ -436,9 +461,21 @@ "Subject" ], "sourceUrl": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_ACMPCA.html", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, "typeName": "AWS::ACMPCA::CertificateAuthority", "writeOnlyProperties": [ - "/properties/Subject" + "/properties/Subject", + "/properties/Subject", + "/properties/CsrExtensions", + "/properties/Tags", + "/properties/RevocationConfiguration", + "/properties/KeyStorageSecurityStandard" ] } } \ No newline at end of file diff --git a/artifacts/types/AWS::ACMPCA::CertificateAuthorityActivation.json b/artifacts/types/AWS::ACMPCA::CertificateAuthorityActivation.json index 15ac5e82..79ad6566 100644 --- a/artifacts/types/AWS::ACMPCA::CertificateAuthorityActivation.json +++ b/artifacts/types/AWS::ACMPCA::CertificateAuthorityActivation.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ACMPCA-CertificateAuthorityActivation", "type": "AWS::ACMPCA::CertificateAuthorityActivation", - "time": "2023-12-27T17:14:39.531Z", + "time": "2024-06-24T14:05:10.084Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -66,6 +66,12 @@ "Certificate" ], "sourceUrl": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_ACMPCA.html", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, "typeName": "AWS::ACMPCA::CertificateAuthorityActivation", "writeOnlyProperties": [ "/properties/Certificate", diff --git a/artifacts/types/AWS::APS::RuleGroupsNamespace.json b/artifacts/types/AWS::APS::RuleGroupsNamespace.json index 565f6f3c..eff6a640 100644 --- a/artifacts/types/AWS::APS::RuleGroupsNamespace.json +++ b/artifacts/types/AWS::APS::RuleGroupsNamespace.json @@ -1,11 +1,12 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-APS-RuleGroupsNamespace", "type": "AWS::APS::RuleGroupsNamespace", - "time": "2023-12-21T21:29:49.059Z", + "time": "2024-05-27T20:46:27.899Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ - "/properties/Name" + "/properties/Name", + "/properties/Workspace" ], "definitions": { "Tag": { diff --git a/artifacts/types/AWS::APS::Scraper.json b/artifacts/types/AWS::APS::Scraper.json new file mode 100644 index 00000000..b8b6a727 --- /dev/null +++ b/artifacts/types/AWS::APS::Scraper.json @@ -0,0 +1,259 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-APS-Scraper", + "type": "AWS::APS::Scraper", + "time": "2024-05-27T20:40:33.971Z", + "schema": { + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ScrapeConfiguration", + "/properties/Source", + "/properties/Destination", + "/properties/Alias" + ], + "definitions": { + "Destination": { + "additionalProperties": false, + "description": "Scraper metrics destination", + "oneOf": [ + { + "required": [ + "AmpConfiguration" + ] + } + ], + "properties": { + "AmpConfiguration": { + "additionalProperties": false, + "description": "Configuration for Amazon Managed Prometheus metrics destination", + "properties": { + "WorkspaceArn": { + "description": "ARN of an Amazon Managed Prometheus workspace", + "pattern": "^arn:aws[-a-z]*:aps:[-a-z0-9]+:[0-9]{12}:workspace/.+$", + "type": "string" + } + }, + "required": [ + "WorkspaceArn" + ], + "type": "object" + } + }, + "type": "object" + }, + "ScrapeConfiguration": { + "additionalProperties": false, + "description": "Scraper configuration", + "oneOf": [ + { + "required": [ + "ConfigurationBlob" + ] + } + ], + "properties": { + "ConfigurationBlob": { + "description": "Prometheus compatible scrape configuration in base64 encoded blob format", + "type": "string" + } + }, + "type": "object" + }, + "SecurityGroupId": { + "description": "ID of a security group", + "pattern": "^sg-[0-9a-z]+$", + "type": "string" + }, + "Source": { + "additionalProperties": false, + "description": "Scraper metrics source", + "oneOf": [ + { + "required": [ + "EksConfiguration" + ] + } + ], + "properties": { + "EksConfiguration": { + "additionalProperties": false, + "description": "Configuration for EKS metrics source", + "properties": { + "ClusterArn": { + "description": "ARN of an EKS cluster", + "pattern": "^arn:aws[-a-z]*:eks:[-a-z0-9]+:[0-9]{12}:cluster/.+$", + "type": "string" + }, + "SecurityGroupIds": { + "description": "List of security group IDs", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/SecurityGroupId" + }, + "type": "array" + }, + "SubnetIds": { + "description": "List of subnet IDs", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/SubnetId" + }, + "type": "array" + } + }, + "required": [ + "ClusterArn", + "SubnetIds" + ], + "type": "object" + } + }, + "type": "object" + }, + "SubnetId": { + "description": "ID of a subnet", + "pattern": "^subnet-[0-9a-z]+$", + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::APS::Scraper", + "handlers": { + "create": { + "permissions": [ + "aps:CreateScraper", + "aps:DescribeScraper", + "aps:DescribeWorkspace", + "aps:TagResource", + "eks:CreateAccessEntry", + "eks:AssociateAccessPolicy", + "eks:DescribeCluster", + "ec2:DescribeSubnets", + "ec2:DescribeSecurityGroups", + "iam:CreateServiceLinkedRole" + ] + }, + "delete": { + "permissions": [ + "aps:DeleteScraper", + "aps:DescribeScraper", + "aps:DescribeWorkspace", + "eks:AssociateAccessPolicy", + "eks:DescribeCluster", + "ec2:DescribeSubnets", + "ec2:DescribeSecurityGroups", + "iam:DeleteServiceLinkedRole" + ] + }, + "list": { + "permissions": [ + "aps:ListScrapers", + "aps:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "aps:DescribeScraper", + "aps:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "aps:DescribeScraper", + "aps:TagResource", + "aps:UntagResource", + "aps:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Alias": { + "description": "Scraper alias.", + "maxLength": 100, + "minLength": 1, + "pattern": "^[0-9A-Za-z][-.0-9A-Z_a-z]*$", + "type": "string" + }, + "Arn": { + "description": "Scraper ARN.", + "pattern": "^arn:(aws|aws-us-gov|aws-cn):aps:(af|ap|ca|eu|me|sa|us)-(central|north|(north(?:east|west))|south|south(?:east|west)|east|west)-[0-9]+:[0-9]+:scraper/s-[a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12}$", + "type": "string" + }, + "Destination": { + "$ref": "#/definitions/Destination" + }, + "RoleArn": { + "description": "IAM role ARN for the scraper.", + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:(aws|aws-us-gov|aws-cn):iam::[0-9]{12}:role/[a-zA-Z0-9-]+$", + "type": "string" + }, + "ScrapeConfiguration": { + "$ref": "#/definitions/ScrapeConfiguration" + }, + "ScraperId": { + "description": "Required to identify a specific scraper.", + "maxLength": 64, + "minLength": 1, + "pattern": "^s-[a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12}$", + "type": "string" + }, + "Source": { + "$ref": "#/definitions/Source" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/ScraperId", + "/properties/Arn", + "/properties/RoleArn" + ], + "required": [ + "ScrapeConfiguration", + "Source", + "Destination" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-aps", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::APS::Scraper" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::APS::Workspace.json b/artifacts/types/AWS::APS::Workspace.json index ed2aa8c2..911a6630 100644 --- a/artifacts/types/AWS::APS::Workspace.json +++ b/artifacts/types/AWS::APS::Workspace.json @@ -1,9 +1,12 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-APS-Workspace", "type": "AWS::APS::Workspace", - "time": "2023-12-21T22:10:19.633Z", + "time": "2024-05-27T21:06:36.387Z", "schema": { "additionalProperties": false, + "createOnlyProperties": [ + "/properties/KmsKeyArn" + ], "definitions": { "LoggingConfiguration": { "additionalProperties": false, @@ -128,6 +131,13 @@ "pattern": "^arn:(aws|aws-us-gov|aws-cn):aps:[a-z0-9-]+:[0-9]+:workspace/[a-zA-Z0-9-]+$", "type": "string" }, + "KmsKeyArn": { + "description": "KMS Key ARN used to encrypt and decrypt AMP workspace data.", + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:aws[-a-z]*:kms:[-a-z0-9]+:[0-9]{12}:key/.+$", + "type": "string" + }, "LoggingConfiguration": { "$ref": "#/definitions/LoggingConfiguration" }, diff --git a/artifacts/types/AWS::ARCZonalShift::ZonalAutoshiftConfiguration.json b/artifacts/types/AWS::ARCZonalShift::ZonalAutoshiftConfiguration.json index 23e940c2..c2793fef 100644 --- a/artifacts/types/AWS::ARCZonalShift::ZonalAutoshiftConfiguration.json +++ b/artifacts/types/AWS::ARCZonalShift::ZonalAutoshiftConfiguration.json @@ -1,9 +1,32 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ARCZonalShift-ZonalAutoshiftConfiguration", "type": "AWS::ARCZonalShift::ZonalAutoshiftConfiguration", - "time": "2024-01-04T17:06:05.287Z", + "time": "2024-06-18T15:44:28.221Z", "schema": { "additionalProperties": false, + "allOf": [ + { + "allOf": [ + { + "required": [ + "ResourceIdentifier" + ] + } + ], + "anyOf": [ + { + "required": [ + "ZonalAutoshiftStatus" + ] + }, + { + "required": [ + "PracticeRunConfiguration" + ] + } + ] + } + ], "createOnlyProperties": [ "/properties/ResourceIdentifier" ], @@ -86,8 +109,7 @@ }, "ZonalAutoshiftStatus": { "enum": [ - "ENABLED", - "DISABLED" + "ENABLED" ], "type": "string" } @@ -142,12 +164,7 @@ "type": "string" }, "ZonalAutoshiftStatus": { - "$ref": "#/definitions/ZonalAutoshiftStatus", - "dependencies": { - "ZonalAutoshiftStatus": [ - "PracticeRunConfiguration" - ] - } + "$ref": "#/definitions/ZonalAutoshiftStatus" } }, "tagging": { diff --git a/artifacts/types/AWS::AccessAnalyzer::Analyzer.json b/artifacts/types/AWS::AccessAnalyzer::Analyzer.json index c32bad2a..46c6462e 100644 --- a/artifacts/types/AWS::AccessAnalyzer::Analyzer.json +++ b/artifacts/types/AWS::AccessAnalyzer::Analyzer.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-AccessAnalyzer-Analyzer", "type": "AWS::AccessAnalyzer::Analyzer", - "time": "2024-01-03T20:45:49.565Z", + "time": "2024-06-18T15:37:57.181Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Amplify::App.json b/artifacts/types/AWS::Amplify::App.json index ea58a572..91f678f9 100644 --- a/artifacts/types/AWS::Amplify::App.json +++ b/artifacts/types/AWS::Amplify::App.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Amplify-App", "type": "AWS::Amplify::App", - "time": "2023-10-25T22:46:48.031Z", + "time": "2024-06-12T17:32:37.589Z", "schema": { "additionalProperties": false, "definitions": { diff --git a/artifacts/types/AWS::Amplify::Branch.json b/artifacts/types/AWS::Amplify::Branch.json index fcc34567..3f3d5c96 100644 --- a/artifacts/types/AWS::Amplify::Branch.json +++ b/artifacts/types/AWS::Amplify::Branch.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Amplify-Branch", "type": "AWS::Amplify::Branch", - "time": "2023-10-25T23:10:23.196Z", + "time": "2024-06-12T17:51:15.602Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Amplify::Domain.json b/artifacts/types/AWS::Amplify::Domain.json index 79a67218..e98a374e 100644 --- a/artifacts/types/AWS::Amplify::Domain.json +++ b/artifacts/types/AWS::Amplify::Domain.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Amplify-Domain", "type": "AWS::Amplify::Domain", - "time": "2023-10-25T22:41:47.988Z", + "time": "2024-06-12T17:29:13.025Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -9,6 +9,44 @@ "/properties/DomainName" ], "definitions": { + "Certificate": { + "additionalProperties": false, + "properties": { + "CertificateArn": { + "pattern": "\"^arn:aws:acm:[a-z0-9-]+:\\d{12}:certificate\\/.+$\"", + "type": "string" + }, + "CertificateType": { + "enum": [ + "AMPLIFY_MANAGED", + "CUSTOM" + ], + "type": "string" + }, + "CertificateVerificationDNSRecord": { + "maxLength": 1000, + "type": "string" + } + }, + "type": "object" + }, + "CertificateSettings": { + "additionalProperties": false, + "properties": { + "CertificateType": { + "enum": [ + "AMPLIFY_MANAGED", + "CUSTOM" + ], + "type": "string" + }, + "CustomCertificateArn": { + "pattern": "^arn:aws:acm:[a-z0-9-]+:\\d{12}:certificate\\/.+$", + "type": "string" + } + }, + "type": "object" + }, "SubDomainSetting": { "additionalProperties": false, "properties": { @@ -106,10 +144,16 @@ "pattern": "^$|^arn:.+:iam::\\d{12}:role.+", "type": "string" }, + "Certificate": { + "$ref": "#/definitions/Certificate" + }, "CertificateRecord": { "maxLength": 1000, "type": "string" }, + "CertificateSettings": { + "$ref": "#/definitions/CertificateSettings" + }, "DomainName": { "maxLength": 255, "pattern": "^(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])(\\.)?$", @@ -132,19 +176,27 @@ "maxItems": 255, "type": "array", "uniqueItems": false + }, + "UpdateStatus": { + "type": "string" } }, "readOnlyProperties": [ "/properties/Arn", "/properties/DomainStatus", "/properties/StatusReason", - "/properties/CertificateRecord" + "/properties/CertificateRecord", + "/properties/Certificate", + "/properties/UpdateStatus" ], "required": [ "AppId", "DomainName", "SubDomainSettings" ], - "typeName": "AWS::Amplify::Domain" + "typeName": "AWS::Amplify::Domain", + "writeOnlyProperties": [ + "/properties/CertificateSettings" + ] } } \ No newline at end of file diff --git a/artifacts/types/AWS::AmplifyUIBuilder::Component.json b/artifacts/types/AWS::AmplifyUIBuilder::Component.json index f7490bfc..0bb74aba 100644 --- a/artifacts/types/AWS::AmplifyUIBuilder::Component.json +++ b/artifacts/types/AWS::AmplifyUIBuilder::Component.json @@ -1,11 +1,12 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-AmplifyUIBuilder-Component", "type": "AWS::AmplifyUIBuilder::Component", - "time": "2023-12-26T21:15:51.859Z", + "time": "2024-06-18T15:38:42.369Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ - "/properties/Tags" + "/properties/AppId", + "/properties/EnvironmentName" ], "definitions": { "ActionParameters": { @@ -89,6 +90,9 @@ }, "type": "array" }, + "SlotName": { + "type": "string" + }, "UserAttribute": { "type": "string" } @@ -115,6 +119,9 @@ }, "Properties": { "$ref": "#/definitions/ComponentProperties" + }, + "SourceId": { + "type": "string" } }, "required": [ @@ -193,6 +200,9 @@ "Action": { "type": "string" }, + "BindingEvent": { + "type": "string" + }, "Parameters": { "$ref": "#/definitions/ActionParameters" } @@ -385,6 +395,10 @@ "Operand": { "type": "string" }, + "OperandType": { + "pattern": "^boolean|string|number$", + "type": "string" + }, "Operator": { "type": "string" }, @@ -437,16 +451,16 @@ "create": { "permissions": [ "amplify:GetApp", - "amplifyuibuilder:GetComponent", "amplifyuibuilder:CreateComponent", + "amplifyuibuilder:GetComponent", "amplifyuibuilder:TagResource" ] }, "delete": { "permissions": [ "amplify:GetApp", - "amplifyuibuilder:GetComponent", "amplifyuibuilder:DeleteComponent", + "amplifyuibuilder:GetComponent", "amplifyuibuilder:UntagResource" ] }, @@ -467,7 +481,6 @@ }, "permissions": [ "amplify:GetApp", - "amplifyuibuilder:GetComponent", "amplifyuibuilder:ListComponents" ] }, @@ -481,8 +494,9 @@ "permissions": [ "amplify:GetApp", "amplifyuibuilder:GetComponent", - "amplifyuibuilder:UpdateComponent", - "amplifyuibuilder:TagResource" + "amplifyuibuilder:TagResource", + "amplifyuibuilder:UntagResource", + "amplifyuibuilder:UpdateComponent" ] } }, @@ -512,6 +526,10 @@ "minLength": 1, "type": "string" }, + "CreatedAt": { + "format": "date-time", + "type": "string" + }, "EnvironmentName": { "type": "string" }, @@ -521,6 +539,10 @@ "Id": { "type": "string" }, + "ModifiedAt": { + "format": "date-time", + "type": "string" + }, "Name": { "maxLength": 255, "minLength": 1, @@ -549,22 +571,16 @@ } }, "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "BindingProperties", - "ComponentType", - "Name", - "Overrides", - "Properties", - "Variants" + "/properties/CreatedAt", + "/properties/Id", + "/properties/ModifiedAt" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-amplifyuibuilder", "tagging": { - "cloudFormationSystemTags": false, + "cloudFormationSystemTags": true, "tagOnCreate": true, - "tagProperty": "#/properties/Tags", - "tagUpdatable": false, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, "taggable": true }, "typeName": "AWS::AmplifyUIBuilder::Component" diff --git a/artifacts/types/AWS::AmplifyUIBuilder::Form.json b/artifacts/types/AWS::AmplifyUIBuilder::Form.json index d72919c6..077267e3 100644 --- a/artifacts/types/AWS::AmplifyUIBuilder::Form.json +++ b/artifacts/types/AWS::AmplifyUIBuilder::Form.json @@ -1,11 +1,12 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-AmplifyUIBuilder-Form", "type": "AWS::AmplifyUIBuilder::Form", - "time": "2023-12-26T21:30:20.635Z", + "time": "2024-06-18T15:38:42.453Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ - "/properties/Tags" + "/properties/AppId", + "/properties/EnvironmentName" ], "definitions": { "FieldConfig": { @@ -276,15 +277,69 @@ ], "type": "object" }, + "FormInputBindingProperties": { + "additionalProperties": false, + "patternProperties": { + ".+": { + "$ref": "#/definitions/FormInputBindingPropertiesValue" + } + }, + "type": "object" + }, + "FormInputBindingPropertiesValue": { + "additionalProperties": false, + "properties": { + "BindingProperties": { + "$ref": "#/definitions/FormInputBindingPropertiesValueProperties" + }, + "Type": { + "type": "string" + } + }, + "type": "object" + }, + "FormInputBindingPropertiesValueProperties": { + "additionalProperties": false, + "properties": { + "Model": { + "type": "string" + } + }, + "type": "object" + }, "FormInputValueProperty": { "additionalProperties": false, "properties": { + "BindingProperties": { + "$ref": "#/definitions/FormInputValuePropertyBindingProperties" + }, + "Concat": { + "items": { + "$ref": "#/definitions/FormInputValueProperty" + }, + "type": "array" + }, "Value": { "type": "string" } }, "type": "object" }, + "FormInputValuePropertyBindingProperties": { + "additionalProperties": false, + "properties": { + "Field": { + "type": "string" + }, + "Property": { + "type": "string" + } + }, + "required": [ + "Property" + ], + "type": "object" + }, "FormStyle": { "additionalProperties": false, "properties": { @@ -411,6 +466,9 @@ "ValueMappings": { "additionalProperties": false, "properties": { + "BindingProperties": { + "$ref": "#/definitions/FormInputBindingProperties" + }, "Values": { "items": { "$ref": "#/definitions/ValueMapping" @@ -429,16 +487,17 @@ "create": { "permissions": [ "amplify:GetApp", - "amplifyuibuilder:GetForm", "amplifyuibuilder:CreateForm", - "amplifyuibuilder:TagResource" + "amplifyuibuilder:GetForm", + "amplifyuibuilder:TagResource", + "amplifyuibuilder:UntagResource" ] }, "delete": { "permissions": [ "amplify:GetApp", - "amplifyuibuilder:GetForm", "amplifyuibuilder:DeleteForm", + "amplifyuibuilder:TagResource", "amplifyuibuilder:UntagResource" ] }, @@ -459,22 +518,23 @@ }, "permissions": [ "amplify:GetApp", - "amplifyuibuilder:GetForm", "amplifyuibuilder:ListForms" ] }, "read": { "permissions": [ "amplify:GetApp", - "amplifyuibuilder:GetForm" + "amplifyuibuilder:GetForm", + "amplifyuibuilder:TagResource" ] }, "update": { "permissions": [ "amplify:GetApp", "amplifyuibuilder:GetForm", - "amplifyuibuilder:UpdateForm", - "amplifyuibuilder:TagResource" + "amplifyuibuilder:TagResource", + "amplifyuibuilder:UntagResource", + "amplifyuibuilder:UpdateForm" ] } }, @@ -529,21 +589,12 @@ "readOnlyProperties": [ "/properties/Id" ], - "required": [ - "DataType", - "Fields", - "FormActionType", - "Name", - "SchemaVersion", - "SectionalElements", - "Style" - ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-amplifyuibuilder", "tagging": { - "cloudFormationSystemTags": false, + "cloudFormationSystemTags": true, "tagOnCreate": true, - "tagProperty": "#/properties/Tags", - "tagUpdatable": false, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, "taggable": true }, "typeName": "AWS::AmplifyUIBuilder::Form" diff --git a/artifacts/types/AWS::AmplifyUIBuilder::Theme.json b/artifacts/types/AWS::AmplifyUIBuilder::Theme.json index 845353b3..a65fa0a3 100644 --- a/artifacts/types/AWS::AmplifyUIBuilder::Theme.json +++ b/artifacts/types/AWS::AmplifyUIBuilder::Theme.json @@ -1,11 +1,12 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-AmplifyUIBuilder-Theme", "type": "AWS::AmplifyUIBuilder::Theme", - "time": "2023-12-26T21:30:20.493Z", + "time": "2024-06-18T15:38:48.392Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ - "/properties/Tags" + "/properties/AppId", + "/properties/EnvironmentName" ], "definitions": { "Tags": { @@ -23,7 +24,6 @@ "additionalProperties": false, "properties": { "Children": { - "insertionOrder": false, "items": { "$ref": "#/definitions/ThemeValues" }, @@ -53,15 +53,14 @@ "create": { "permissions": [ "amplify:GetApp", - "amplifyuibuilder:GetTheme", "amplifyuibuilder:CreateTheme", + "amplifyuibuilder:GetTheme", "amplifyuibuilder:TagResource" ] }, "delete": { "permissions": [ "amplify:GetApp", - "amplifyuibuilder:GetTheme", "amplifyuibuilder:DeleteTheme", "amplifyuibuilder:UntagResource" ] @@ -83,7 +82,6 @@ }, "permissions": [ "amplify:GetApp", - "amplifyuibuilder:GetTheme", "amplifyuibuilder:ListThemes" ] }, @@ -97,8 +95,9 @@ "permissions": [ "amplify:GetApp", "amplifyuibuilder:GetTheme", - "amplifyuibuilder:UpdateTheme", - "amplifyuibuilder:TagResource" + "amplifyuibuilder:TagResource", + "amplifyuibuilder:UntagResource", + "amplifyuibuilder:UpdateTheme" ] } }, @@ -111,19 +110,26 @@ "AppId": { "type": "string" }, + "CreatedAt": { + "format": "date-time", + "type": "string" + }, "EnvironmentName": { "type": "string" }, "Id": { "type": "string" }, + "ModifiedAt": { + "format": "date-time", + "type": "string" + }, "Name": { "maxLength": 255, "minLength": 1, "type": "string" }, "Overrides": { - "insertionOrder": false, "items": { "$ref": "#/definitions/ThemeValues" }, @@ -133,7 +139,6 @@ "$ref": "#/definitions/Tags" }, "Values": { - "insertionOrder": false, "items": { "$ref": "#/definitions/ThemeValues" }, @@ -141,14 +146,18 @@ } }, "readOnlyProperties": [ - "/properties/Id" - ], - "required": [ - "Name", - "Values" + "/properties/CreatedAt", + "/properties/Id", + "/properties/ModifiedAt" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-amplifyuibuilder", - "taggable": true, + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, "typeName": "AWS::AmplifyUIBuilder::Theme" } } \ No newline at end of file diff --git a/artifacts/types/AWS::ApiGateway::Account.json b/artifacts/types/AWS::ApiGateway::Account.json index 38debb77..734fd9a1 100644 --- a/artifacts/types/AWS::ApiGateway::Account.json +++ b/artifacts/types/AWS::ApiGateway::Account.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ApiGateway-Account", "type": "AWS::ApiGateway::Account", - "time": "2023-12-01T17:59:36.902Z", + "time": "2024-06-11T15:37:43.357Z", "schema": { "additionalProperties": false, "description": "The ``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.", @@ -14,7 +14,9 @@ ] }, "delete": { - "permissions": [] + "permissions": [ + "apigateway:PATCH" + ] }, "read": { "permissions": [ @@ -46,6 +48,9 @@ "/properties/Id" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigateway", + "tagging": { + "taggable": false + }, "typeName": "AWS::ApiGateway::Account" } } \ No newline at end of file diff --git a/artifacts/types/AWS::ApiGateway::ApiKey.json b/artifacts/types/AWS::ApiGateway::ApiKey.json index 517f39f1..f8041322 100644 --- a/artifacts/types/AWS::ApiGateway::ApiKey.json +++ b/artifacts/types/AWS::ApiGateway::ApiKey.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ApiGateway-ApiKey", "type": "AWS::ApiGateway::ApiKey", - "time": "2023-12-01T18:47:52.528Z", + "time": "2024-06-11T15:40:27.974Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -136,6 +136,18 @@ "/properties/APIKeyId" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigateway", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "apigateway:PUT", + "apigateway:DELETE", + "apigateway:GET" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, "typeName": "AWS::ApiGateway::ApiKey", "writeOnlyProperties": [ "/properties/GenerateDistinctId" diff --git a/artifacts/types/AWS::ApiGateway::Authorizer.json b/artifacts/types/AWS::ApiGateway::Authorizer.json index 982220c7..e3c9ad83 100644 --- a/artifacts/types/AWS::ApiGateway::Authorizer.json +++ b/artifacts/types/AWS::ApiGateway::Authorizer.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ApiGateway-Authorizer", "type": "AWS::ApiGateway::Authorizer", - "time": "2023-12-01T18:17:39.401Z", + "time": "2024-06-11T15:45:24.866Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::ApiGateway::BasePathMapping.json b/artifacts/types/AWS::ApiGateway::BasePathMapping.json index 2b384567..a94b020d 100644 --- a/artifacts/types/AWS::ApiGateway::BasePathMapping.json +++ b/artifacts/types/AWS::ApiGateway::BasePathMapping.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ApiGateway-BasePathMapping", "type": "AWS::ApiGateway::BasePathMapping", - "time": "2023-12-01T18:18:18.467Z", + "time": "2024-06-11T15:46:03.628Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::ApiGateway::ClientCertificate.json b/artifacts/types/AWS::ApiGateway::ClientCertificate.json index 16a47ae6..4eaa82a8 100644 --- a/artifacts/types/AWS::ApiGateway::ClientCertificate.json +++ b/artifacts/types/AWS::ApiGateway::ClientCertificate.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ApiGateway-ClientCertificate", "type": "AWS::ApiGateway::ClientCertificate", - "time": "2023-12-01T18:12:00.381Z", + "time": "2024-06-11T15:40:24.407Z", "schema": { "additionalProperties": false, "definitions": { @@ -81,6 +81,18 @@ "/properties/ClientCertificateId" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigateway", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "apigateway:PUT", + "apigateway:DELETE", + "apigateway:GET" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, "typeName": "AWS::ApiGateway::ClientCertificate" } } \ No newline at end of file diff --git a/artifacts/types/AWS::ApiGateway::Deployment.json b/artifacts/types/AWS::ApiGateway::Deployment.json index f2efa582..094e139b 100644 --- a/artifacts/types/AWS::ApiGateway::Deployment.json +++ b/artifacts/types/AWS::ApiGateway::Deployment.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ApiGateway-Deployment", "type": "AWS::ApiGateway::Deployment", - "time": "2023-12-01T18:10:15.227Z", + "time": "2024-06-11T15:40:18.566Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -322,7 +322,9 @@ "RestApiId" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigateway", - "taggable": true, + "tagging": { + "taggable": false + }, "typeName": "AWS::ApiGateway::Deployment", "writeOnlyProperties": [ "/properties/StageName", diff --git a/artifacts/types/AWS::ApiGateway::DocumentationPart.json b/artifacts/types/AWS::ApiGateway::DocumentationPart.json index 0584f307..b48ca19d 100644 --- a/artifacts/types/AWS::ApiGateway::DocumentationPart.json +++ b/artifacts/types/AWS::ApiGateway::DocumentationPart.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ApiGateway-DocumentationPart", "type": "AWS::ApiGateway::DocumentationPart", - "time": "2023-12-01T18:08:37.744Z", + "time": "2024-06-11T15:38:13.775Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -122,6 +122,9 @@ "RestApiId" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigateway", + "tagging": { + "taggable": false + }, "typeName": "AWS::ApiGateway::DocumentationPart" } } \ No newline at end of file diff --git a/artifacts/types/AWS::ApiGateway::DocumentationVersion.json b/artifacts/types/AWS::ApiGateway::DocumentationVersion.json index c61ab121..7540c73d 100644 --- a/artifacts/types/AWS::ApiGateway::DocumentationVersion.json +++ b/artifacts/types/AWS::ApiGateway::DocumentationVersion.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ApiGateway-DocumentationVersion", "type": "AWS::ApiGateway::DocumentationVersion", - "time": "2023-12-01T18:08:27.998Z", + "time": "2024-06-11T15:38:47.294Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -74,6 +74,9 @@ "RestApiId" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigateway", + "tagging": { + "taggable": false + }, "typeName": "AWS::ApiGateway::DocumentationVersion" } } \ No newline at end of file diff --git a/artifacts/types/AWS::ApiGateway::DomainName.json b/artifacts/types/AWS::ApiGateway::DomainName.json index 976e3df5..87d46272 100644 --- a/artifacts/types/AWS::ApiGateway::DomainName.json +++ b/artifacts/types/AWS::ApiGateway::DomainName.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ApiGateway-DomainName", "type": "AWS::ApiGateway::DomainName", - "time": "2023-02-06T21:00:25.645Z", + "time": "2024-06-19T16:23:34.016Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -124,6 +124,13 @@ "/properties/DistributionHostedZoneId" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, "typeName": "AWS::ApiGateway::DomainName" } } \ No newline at end of file diff --git a/artifacts/types/AWS::ApiGateway::GatewayResponse.json b/artifacts/types/AWS::ApiGateway::GatewayResponse.json new file mode 100644 index 00000000..2d998dff --- /dev/null +++ b/artifacts/types/AWS::ApiGateway::GatewayResponse.json @@ -0,0 +1,106 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ApiGateway-GatewayResponse", + "type": "AWS::ApiGateway::GatewayResponse", + "time": "2024-06-11T15:39:51.992Z", + "schema": { + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ResponseType", + "/properties/RestApiId" + ], + "description": "The ``AWS::ApiGateway::GatewayResponse`` resource creates a gateway response for your API. For more information, see [API Gateway Responses](https://docs.aws.amazon.com/apigateway/latest/developerguide/customize-gateway-responses.html#api-gateway-gatewayResponse-definition) in the *API Gateway Developer Guide*.", + "handlers": { + "create": { + "permissions": [ + "apigateway:PUT", + "apigateway:GET" + ] + }, + "delete": { + "permissions": [ + "apigateway:GET", + "apigateway:DELETE" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "RestApiId": { + "$ref": "resource-schema.json#/properties/RestApiId" + } + }, + "required": [ + "RestApiId" + ] + }, + "permissions": [ + "apigateway:GET" + ] + }, + "read": { + "permissions": [ + "apigateway:GET" + ] + }, + "update": { + "permissions": [ + "apigateway:GET", + "apigateway:PUT" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Id": { + "description": "", + "type": "string" + }, + "ResponseParameters": { + "additionalProperties": false, + "description": "Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.", + "patternProperties": { + "[a-zA-Z0-9]+": { + "type": "string" + } + }, + "type": "object" + }, + "ResponseTemplates": { + "additionalProperties": false, + "description": "Response templates of the GatewayResponse as a string-to-string map of key-value pairs.", + "patternProperties": { + "[a-zA-Z0-9]+": { + "type": "string" + } + }, + "type": "object" + }, + "ResponseType": { + "description": "The response type of the associated GatewayResponse.", + "type": "string" + }, + "RestApiId": { + "description": "The string identifier of the associated RestApi.", + "type": "string" + }, + "StatusCode": { + "description": "The HTTP status code for this GatewayResponse.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "ResponseType", + "RestApiId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::ApiGateway::GatewayResponse" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::ApiGateway::Method.json b/artifacts/types/AWS::ApiGateway::Method.json index d2148a81..a7b6e4fd 100644 --- a/artifacts/types/AWS::ApiGateway::Method.json +++ b/artifacts/types/AWS::ApiGateway::Method.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ApiGateway-Method", "type": "AWS::ApiGateway::Method", - "time": "2023-12-01T19:57:14.381Z", + "time": "2024-06-11T16:04:01.984Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -248,12 +248,6 @@ }, "AuthorizationType": { "description": "The method's authorization type. This parameter is required. For valid values, see [Method](https://docs.aws.amazon.com/apigateway/latest/api/API_Method.html) in the *API Gateway API Reference*.\n If you specify the ``AuthorizerId`` property, specify ``CUSTOM`` or ``COGNITO_USER_POOLS`` for this property.", - "enum": [ - "NONE", - "AWS_IAM", - "CUSTOM", - "COGNITO_USER_POOLS" - ], "type": "string" }, "AuthorizerId": { diff --git a/artifacts/types/AWS::ApiGateway::Model.json b/artifacts/types/AWS::ApiGateway::Model.json index b7cbaabd..f1d0a9f4 100644 --- a/artifacts/types/AWS::ApiGateway::Model.json +++ b/artifacts/types/AWS::ApiGateway::Model.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ApiGateway-Model", "type": "AWS::ApiGateway::Model", - "time": "2023-12-01T18:09:38.723Z", + "time": "2024-06-11T15:40:19.648Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -83,6 +83,9 @@ "RestApiId" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigateway", + "tagging": { + "taggable": false + }, "typeName": "AWS::ApiGateway::Model" } } \ No newline at end of file diff --git a/artifacts/types/AWS::ApiGateway::RequestValidator.json b/artifacts/types/AWS::ApiGateway::RequestValidator.json index a3c7bc66..18809068 100644 --- a/artifacts/types/AWS::ApiGateway::RequestValidator.json +++ b/artifacts/types/AWS::ApiGateway::RequestValidator.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ApiGateway-RequestValidator", "type": "AWS::ApiGateway::RequestValidator", - "time": "2023-12-01T18:10:04.66Z", + "time": "2024-06-11T15:40:28.485Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -81,6 +81,9 @@ "RestApiId" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigateway", + "tagging": { + "taggable": false + }, "typeName": "AWS::ApiGateway::RequestValidator" } } \ No newline at end of file diff --git a/artifacts/types/AWS::ApiGateway::Resource.json b/artifacts/types/AWS::ApiGateway::Resource.json index 67f3fb50..442eb987 100644 --- a/artifacts/types/AWS::ApiGateway::Resource.json +++ b/artifacts/types/AWS::ApiGateway::Resource.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ApiGateway-Resource", "type": "AWS::ApiGateway::Resource", - "time": "2023-12-01T18:10:20.413Z", + "time": "2024-06-11T15:38:57.418Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -79,7 +79,9 @@ "RestApiId" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigateway", - "taggable": false, + "tagging": { + "taggable": false + }, "typeName": "AWS::ApiGateway::Resource" } } \ No newline at end of file diff --git a/artifacts/types/AWS::ApiGateway::RestApi.json b/artifacts/types/AWS::ApiGateway::RestApi.json index 94601682..30588fc1 100644 --- a/artifacts/types/AWS::ApiGateway::RestApi.json +++ b/artifacts/types/AWS::ApiGateway::RestApi.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ApiGateway-RestApi", "type": "AWS::ApiGateway::RestApi", - "time": "2023-12-01T18:14:35.586Z", + "time": "2024-06-11T15:43:43.759Z", "schema": { "additionalProperties": false, "definitions": { @@ -20,6 +20,10 @@ "VpcEndpointIds": { "description": "A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for ``PRIVATE`` endpoint type.", "items": { + "relationshipRef": { + "propertyPath": "/properties/Id", + "typeName": "AWS::EC2::VPCEndpoint" + }, "type": "string" }, "type": "array", @@ -34,6 +38,10 @@ "properties": { "Bucket": { "description": "The name of the S3 bucket where the OpenAPI file is stored.", + "relationshipRef": { + "propertyPath": "/properties/BucketName", + "typeName": "AWS::S3::Bucket" + }, "type": "string" }, "ETag": { @@ -212,6 +220,11 @@ "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", "tagging": { "cloudFormationSystemTags": true, + "permissions": [ + "apigateway:PUT", + "apigateway:DELETE", + "apigateway:GET" + ], "tagOnCreate": true, "tagProperty": "/properties/Tags", "tagUpdatable": true, diff --git a/artifacts/types/AWS::ApiGateway::Stage.json b/artifacts/types/AWS::ApiGateway::Stage.json index 39827bea..0f4bef0c 100644 --- a/artifacts/types/AWS::ApiGateway::Stage.json +++ b/artifacts/types/AWS::ApiGateway::Stage.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ApiGateway-Stage", "type": "AWS::ApiGateway::Stage", - "time": "2023-12-01T18:17:47.373Z", + "time": "2024-06-11T15:41:48.656Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -256,6 +256,11 @@ "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigateway", "tagging": { "cloudFormationSystemTags": true, + "permissions": [ + "apigateway:PUT", + "apigateway:DELETE", + "apigateway:GET" + ], "tagOnCreate": true, "tagProperty": "/properties/Tags", "tagUpdatable": true, diff --git a/artifacts/types/AWS::ApiGateway::UsagePlan.json b/artifacts/types/AWS::ApiGateway::UsagePlan.json index becfa972..fdd7dd5f 100644 --- a/artifacts/types/AWS::ApiGateway::UsagePlan.json +++ b/artifacts/types/AWS::ApiGateway::UsagePlan.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ApiGateway-UsagePlan", "type": "AWS::ApiGateway::UsagePlan", - "time": "2023-12-01T18:17:28Z", + "time": "2024-06-11T15:41:12.682Z", "schema": { "additionalProperties": false, "definitions": { @@ -175,6 +175,11 @@ "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-apigateway.git", "tagging": { "cloudFormationSystemTags": true, + "permissions": [ + "apigateway:PUT", + "apigateway:DELETE", + "apigateway:GET" + ], "tagOnCreate": true, "tagProperty": "/properties/Tags", "tagUpdatable": true, diff --git a/artifacts/types/AWS::ApiGateway::VpcLink.json b/artifacts/types/AWS::ApiGateway::VpcLink.json index 129ed5cb..89be975b 100644 --- a/artifacts/types/AWS::ApiGateway::VpcLink.json +++ b/artifacts/types/AWS::ApiGateway::VpcLink.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ApiGateway-VpcLink", "type": "AWS::ApiGateway::VpcLink", - "time": "2023-07-06T21:52:49.319Z", + "time": "2024-06-24T19:44:34.784Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -10,6 +10,7 @@ "definitions": { "Tag": { "additionalProperties": false, + "description": "", "properties": { "Key": { "type": "string" @@ -25,12 +26,13 @@ "type": "object" } }, - "description": "Schema for AWS ApiGateway VpcLink", + "description": "The ``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``.", "handlers": { "create": { "permissions": [ "apigateway:POST", "apigateway:PUT", + "apigateway:GET", "ec2:CreateVpcEndpointServiceConfiguration", "ec2:DeleteVpcEndpointServiceConfigurations", "ec2:DescribeVpcEndpointServiceConfigurations", @@ -83,15 +85,15 @@ ], "properties": { "Description": { - "description": "A description of the VPC link.", + "description": "The description of the VPC link.", "type": "string" }, "Name": { - "description": "A name for the VPC link.", + "description": "The name used to label and identify the VPC link.", "type": "string" }, "Tags": { - "description": "An array of arbitrary tags (key-value pairs) to associate with the stage.", + "description": "An array of arbitrary tags (key-value pairs) to associate with the VPC link.", "insertionOrder": false, "items": { "$ref": "#/definitions/Tag" @@ -100,7 +102,7 @@ "uniqueItems": true }, "TargetArns": { - "description": "The ARN of network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner.", + "description": "The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS-account of the API owner.", "insertionOrder": false, "items": { "type": "string" @@ -109,7 +111,7 @@ "uniqueItems": false }, "VpcLinkId": { - "description": "The ID of the instance that backs VPC link.", + "description": "", "type": "string" } }, diff --git a/artifacts/types/AWS::ApiGatewayV2::Api.json b/artifacts/types/AWS::ApiGatewayV2::Api.json index 7d9753de..d1f87d2a 100644 --- a/artifacts/types/AWS::ApiGatewayV2::Api.json +++ b/artifacts/types/AWS::ApiGatewayV2::Api.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ApiGatewayV2-Api", "type": "AWS::ApiGatewayV2::Api", - "time": "2024-01-02T18:50:18.148Z", + "time": "2024-03-12T17:39:14.158Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::ApiGatewayV2::ApiMapping.json b/artifacts/types/AWS::ApiGatewayV2::ApiMapping.json index 63b56a3d..31f19cad 100644 --- a/artifacts/types/AWS::ApiGatewayV2::ApiMapping.json +++ b/artifacts/types/AWS::ApiGatewayV2::ApiMapping.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ApiGatewayV2-ApiMapping", "type": "AWS::ApiGatewayV2::ApiMapping", - "time": "2024-01-02T18:50:17.817Z", + "time": "2024-03-12T17:34:30.683Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::ApiGatewayV2::Authorizer.json b/artifacts/types/AWS::ApiGatewayV2::Authorizer.json index 68d8d4aa..74983e12 100644 --- a/artifacts/types/AWS::ApiGatewayV2::Authorizer.json +++ b/artifacts/types/AWS::ApiGatewayV2::Authorizer.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ApiGatewayV2-Authorizer", "type": "AWS::ApiGatewayV2::Authorizer", - "time": "2024-01-02T19:04:17.712Z", + "time": "2024-03-12T17:37:54.622Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -10,8 +10,10 @@ "definitions": { "JWTConfiguration": { "additionalProperties": false, + "description": "The ``JWTConfiguration`` property specifies the configuration of a JWT authorizer. Required for the ``JWT`` authorizer type. Supported only for HTTP APIs.", "properties": { "Audience": { + "description": "A list of the intended recipients of the JWT. A valid JWT must provide an ``aud`` that matches at least one entry in this list. See [RFC 7519](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc7519#section-4.1.3). Required for the ``JWT`` authorizer type. Supported only for HTTP APIs.", "items": { "type": "string" }, @@ -19,13 +21,14 @@ "uniqueItems": false }, "Issuer": { + "description": "The base domain of the identity provider that issues JSON Web Tokens. For example, an Amazon Cognito user pool has the following format: ``https://cognito-idp.{region}.amazonaws.com/{userPoolId}``. Required for the ``JWT`` authorizer type. Supported only for HTTP APIs.", "type": "string" } }, "type": "object" } }, - "description": "Resource Type definition for AWS::ApiGatewayV2::Authorizer", + "description": "The ``AWS::ApiGatewayV2::Authorizer`` resource creates an authorizer for a WebSocket 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 [Controlling and managing 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 Developer Guide*.", "handlers": { "create": { "permissions": [ @@ -74,30 +77,39 @@ ], "properties": { "ApiId": { + "description": "The API identifier.", "type": "string" }, "AuthorizerCredentialsArn": { + "description": "Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null. Supported only for ``REQUEST`` authorizers.", "type": "string" }, "AuthorizerId": { + "description": "", "type": "string" }, "AuthorizerPayloadFormatVersion": { + "description": "Specifies 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 Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html).", "type": "string" }, "AuthorizerResultTtlInSeconds": { + "description": "The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.", "type": "integer" }, "AuthorizerType": { + "description": "The authorizer type. Specify ``REQUEST`` for a Lambda function using incoming request parameters. Specify ``JWT`` to use JSON Web Tokens (supported only for HTTP APIs).", "type": "string" }, "AuthorizerUri": { + "description": "The authorizer's Uniform Resource Identifier (URI). For ``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``.", "type": "string" }, "EnableSimpleResponses": { + "description": "Specifies 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 Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html).", "type": "boolean" }, "IdentitySource": { + "description": "The identity source for which authorization is requested.\n For a ``REQUEST`` authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with ``$``, for example, ``$request.header.Auth``, ``$request.querystring.Name``. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see [Working with Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html).\n For ``JWT``, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example ``$request.header.Authorization``.", "items": { "type": "string" }, @@ -105,12 +117,15 @@ "uniqueItems": false }, "IdentityValidationExpression": { + "description": "This parameter is not used.", "type": "string" }, "JwtConfiguration": { - "$ref": "#/definitions/JWTConfiguration" + "$ref": "#/definitions/JWTConfiguration", + "description": "The ``JWTConfiguration`` property specifies the configuration of a JWT authorizer. Required for the ``JWT`` authorizer type. Supported only for HTTP APIs." }, "Name": { + "description": "The name of the authorizer.", "type": "string" } }, diff --git a/artifacts/types/AWS::ApiGatewayV2::Deployment.json b/artifacts/types/AWS::ApiGatewayV2::Deployment.json index 9fb6687d..5cbdb108 100644 --- a/artifacts/types/AWS::ApiGatewayV2::Deployment.json +++ b/artifacts/types/AWS::ApiGatewayV2::Deployment.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ApiGatewayV2-Deployment", "type": "AWS::ApiGatewayV2::Deployment", - "time": "2024-01-02T18:50:17.173Z", + "time": "2024-03-12T17:33:48.417Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::ApiGatewayV2::DomainName.json b/artifacts/types/AWS::ApiGatewayV2::DomainName.json index 1cd2fd3e..eda5e0a1 100644 --- a/artifacts/types/AWS::ApiGatewayV2::DomainName.json +++ b/artifacts/types/AWS::ApiGatewayV2::DomainName.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ApiGatewayV2-DomainName", "type": "AWS::ApiGatewayV2::DomainName", - "time": "2024-01-02T18:50:18.133Z", + "time": "2024-03-12T17:35:46.13Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::ApiGatewayV2::Integration.json b/artifacts/types/AWS::ApiGatewayV2::Integration.json new file mode 100644 index 00000000..d0ab0ee6 --- /dev/null +++ b/artifacts/types/AWS::ApiGatewayV2::Integration.json @@ -0,0 +1,93 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ApiGatewayV2-Integration", + "type": "AWS::ApiGatewayV2::Integration", + "time": "2023-11-12T17:33:13.802Z", + "schema": { + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ApiId" + ], + "definitions": { + "TlsConfig": { + "additionalProperties": false, + "properties": { + "ServerNameToVerify": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::ApiGatewayV2::Integration", + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "ApiId": { + "type": "string" + }, + "ConnectionId": { + "type": "string" + }, + "ConnectionType": { + "type": "string" + }, + "ContentHandlingStrategy": { + "type": "string" + }, + "CredentialsArn": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "IntegrationMethod": { + "type": "string" + }, + "IntegrationSubtype": { + "type": "string" + }, + "IntegrationType": { + "type": "string" + }, + "IntegrationUri": { + "type": "string" + }, + "PassthroughBehavior": { + "type": "string" + }, + "PayloadFormatVersion": { + "type": "string" + }, + "RequestParameters": { + "type": "object" + }, + "RequestTemplates": { + "type": "object" + }, + "ResponseParameters": { + "type": "object" + }, + "TemplateSelectionExpression": { + "type": "string" + }, + "TimeoutInMillis": { + "type": "integer" + }, + "TlsConfig": { + "$ref": "#/definitions/TlsConfig" + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "ApiId", + "IntegrationType" + ], + "typeName": "AWS::ApiGatewayV2::Integration" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::ApiGatewayV2::IntegrationResponse.json b/artifacts/types/AWS::ApiGatewayV2::IntegrationResponse.json index 665addfd..610a9cfc 100644 --- a/artifacts/types/AWS::ApiGatewayV2::IntegrationResponse.json +++ b/artifacts/types/AWS::ApiGatewayV2::IntegrationResponse.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ApiGatewayV2-IntegrationResponse", "type": "AWS::ApiGatewayV2::IntegrationResponse", - "time": "2024-01-02T18:50:16.83Z", + "time": "2024-03-12T17:33:25.134Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::ApiGatewayV2::Model.json b/artifacts/types/AWS::ApiGatewayV2::Model.json index bab89bd0..c8976b6a 100644 --- a/artifacts/types/AWS::ApiGatewayV2::Model.json +++ b/artifacts/types/AWS::ApiGatewayV2::Model.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ApiGatewayV2-Model", "type": "AWS::ApiGatewayV2::Model", - "time": "2024-01-02T18:50:25.872Z", + "time": "2024-03-12T17:33:28.681Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::ApiGatewayV2::Route.json b/artifacts/types/AWS::ApiGatewayV2::Route.json index b4b9b225..b8166615 100644 --- a/artifacts/types/AWS::ApiGatewayV2::Route.json +++ b/artifacts/types/AWS::ApiGatewayV2::Route.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ApiGatewayV2-Route", "type": "AWS::ApiGatewayV2::Route", - "time": "2024-01-02T18:50:17.365Z", + "time": "2024-03-12T17:34:27.962Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::ApiGatewayV2::RouteResponse.json b/artifacts/types/AWS::ApiGatewayV2::RouteResponse.json index 057f7503..27cb4cb1 100644 --- a/artifacts/types/AWS::ApiGatewayV2::RouteResponse.json +++ b/artifacts/types/AWS::ApiGatewayV2::RouteResponse.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ApiGatewayV2-RouteResponse", "type": "AWS::ApiGatewayV2::RouteResponse", - "time": "2024-01-02T18:50:18.335Z", + "time": "2024-03-12T17:33:29.971Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::ApiGatewayV2::VpcLink.json b/artifacts/types/AWS::ApiGatewayV2::VpcLink.json index 09333c39..1b75e82d 100644 --- a/artifacts/types/AWS::ApiGatewayV2::VpcLink.json +++ b/artifacts/types/AWS::ApiGatewayV2::VpcLink.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ApiGatewayV2-VpcLink", "type": "AWS::ApiGatewayV2::VpcLink", - "time": "2024-01-02T19:05:20.218Z", + "time": "2024-03-12T17:31:16.298Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::AppConfig::Application.json b/artifacts/types/AWS::AppConfig::Application.json index d117f8ee..915b4743 100644 --- a/artifacts/types/AWS::AppConfig::Application.json +++ b/artifacts/types/AWS::AppConfig::Application.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-AppConfig-Application", "type": "AWS::AppConfig::Application", - "time": "2023-10-30T16:03:13.112Z", + "time": "2024-04-08T15:36:32.26Z", "schema": { "additionalProperties": false, "definitions": { diff --git a/artifacts/types/AWS::AppConfig::ConfigurationProfile.json b/artifacts/types/AWS::AppConfig::ConfigurationProfile.json index aa56a8f6..f95cd171 100644 --- a/artifacts/types/AWS::AppConfig::ConfigurationProfile.json +++ b/artifacts/types/AWS::AppConfig::ConfigurationProfile.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-AppConfig-ConfigurationProfile", "type": "AWS::AppConfig::ConfigurationProfile", - "time": "2023-11-02T00:45:22.672Z", + "time": "2024-04-08T15:38:21.082Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::AppConfig::Environment.json b/artifacts/types/AWS::AppConfig::Environment.json new file mode 100644 index 00000000..f62039ee --- /dev/null +++ b/artifacts/types/AWS::AppConfig::Environment.json @@ -0,0 +1,178 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-AppConfig-Environment", + "type": "AWS::AppConfig::Environment", + "time": "2024-04-08T15:34:08.853Z", + "schema": { + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ApplicationId" + ], + "definitions": { + "Monitor": { + "additionalProperties": false, + "description": "Amazon CloudWatch alarm to monitor during the deployment process.", + "properties": { + "AlarmArn": { + "description": "Amazon Resource Name (ARN) of the Amazon CloudWatch alarm.", + "maxLength": 2048, + "minLength": 1, + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::CloudWatch::Alarm" + }, + "type": "string" + }, + "AlarmRoleArn": { + "description": "ARN of an AWS Identity and Access Management (IAM) role for AWS AppConfig to monitor AlarmArn.", + "maxLength": 2048, + "minLength": 20, + "pattern": "^((arn):(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):(iam)::\\d{12}:role[/].*)$", + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::IAM::Role" + }, + "type": "string" + } + }, + "required": [ + "AlarmArn" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "Metadata 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 you define.", + "properties": { + "Key": { + "description": "The key-value string map. The valid character set is [a-zA-Z1-9+-=._:/]. The tag key can be up to 128 characters and must not start with aws:.", + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:.)[a-zA-Z1-9+=._:/-]*$", + "type": "string" + }, + "Value": { + "description": "The tag value can be up to 256 characters.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::AppConfig::Environment", + "handlers": { + "create": { + "permissions": [ + "appconfig:CreateEnvironment", + "appconfig:GetEnvironment", + "appconfig:ListTagsForResource", + "appconfig:TagResource", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "appconfig:GetEnvironment", + "appconfig:DeleteEnvironment" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "ApplicationId": { + "$ref": "resource-schema.json#/properties/ApplicationId" + } + }, + "required": [ + "ApplicationId" + ] + }, + "permissions": [ + "appconfig:ListEnvironments" + ] + }, + "read": { + "permissions": [ + "appconfig:GetEnvironment", + "appconfig:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "appconfig:UpdateEnvironment", + "appconfig:TagResource", + "appconfig:UntagResource", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/ApplicationId", + "/properties/EnvironmentId" + ], + "properties": { + "ApplicationId": { + "description": "The application ID.", + "pattern": "[a-z0-9]{4,7}", + "type": "string" + }, + "Description": { + "description": "A description of the environment.", + "maxLength": 1024, + "minLength": 0, + "type": "string" + }, + "EnvironmentId": { + "description": "The environment ID.", + "pattern": "[a-z0-9]{4,7}", + "type": "string" + }, + "Monitors": { + "description": "Amazon CloudWatch alarms to monitor during the deployment process.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Monitor" + }, + "maxItems": 5, + "minItems": 0, + "type": "array" + }, + "Name": { + "description": "A name for the environment.", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "Tags": { + "description": "Metadata 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 you define.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/EnvironmentId" + ], + "required": [ + "Name", + "ApplicationId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-appconfig.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::AppConfig::Environment" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::AppConfig::Extension.json b/artifacts/types/AWS::AppConfig::Extension.json index c1f9831d..536fdaee 100644 --- a/artifacts/types/AWS::AppConfig::Extension.json +++ b/artifacts/types/AWS::AppConfig::Extension.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-AppConfig-Extension", "type": "AWS::AppConfig::Extension", - "time": "2023-12-04T16:25:47.08Z", + "time": "2024-04-08T15:34:09.569Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -65,6 +65,9 @@ "minLength": 0, "type": "string" }, + "Dynamic": { + "type": "boolean" + }, "Required": { "type": "boolean" } diff --git a/artifacts/types/AWS::AppConfig::ExtensionAssociation.json b/artifacts/types/AWS::AppConfig::ExtensionAssociation.json index 5faf37ef..6c9bfb69 100644 --- a/artifacts/types/AWS::AppConfig::ExtensionAssociation.json +++ b/artifacts/types/AWS::AppConfig::ExtensionAssociation.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-AppConfig-ExtensionAssociation", "type": "AWS::AppConfig::ExtensionAssociation", - "time": "2023-12-04T16:25:32.556Z", + "time": "2024-04-08T15:33:24.386Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::AppFlow::Connector.json b/artifacts/types/AWS::AppFlow::Connector.json index 94dc2e71..ba24ed6d 100644 --- a/artifacts/types/AWS::AppFlow::Connector.json +++ b/artifacts/types/AWS::AppFlow::Connector.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-AppFlow-Connector", "type": "AWS::AppFlow::Connector", - "time": "2023-12-19T20:44:00.473Z", + "time": "2024-06-04T21:31:23.757Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::AppFlow::ConnectorProfile.json b/artifacts/types/AWS::AppFlow::ConnectorProfile.json index 471d2395..bd8f5344 100644 --- a/artifacts/types/AWS::AppFlow::ConnectorProfile.json +++ b/artifacts/types/AWS::AppFlow::ConnectorProfile.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-AppFlow-ConnectorProfile", "type": "AWS::AppFlow::ConnectorProfile", - "time": "2023-12-19T20:43:58.686Z", + "time": "2024-06-04T21:31:09.314Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::AppFlow::Flow.json b/artifacts/types/AWS::AppFlow::Flow.json index 4b60d5b9..4c12a405 100644 --- a/artifacts/types/AWS::AppFlow::Flow.json +++ b/artifacts/types/AWS::AppFlow::Flow.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-AppFlow-Flow", "type": "AWS::AppFlow::Flow", - "time": "2023-12-19T20:46:00.889Z", + "time": "2024-06-04T21:32:40.817Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::AppIntegrations::Application.json b/artifacts/types/AWS::AppIntegrations::Application.json new file mode 100644 index 00000000..88a6fdfe --- /dev/null +++ b/artifacts/types/AWS::AppIntegrations::Application.json @@ -0,0 +1,192 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-AppIntegrations-Application", + "type": "AWS::AppIntegrations::Application", + "time": "2024-05-29T21:30:33.878Z", + "schema": { + "additionalProperties": false, + "definitions": { + "ApprovedOrigins": { + "maxLength": 1000, + "minLength": 1, + "pattern": "^\\w+\\:\\/\\/.*$", + "type": "string" + }, + "ExternalUrlConfig": { + "additionalProperties": false, + "properties": { + "AccessUrl": { + "maxLength": 1000, + "minLength": 1, + "pattern": "^\\w+\\:\\/\\/.*$", + "type": "string" + }, + "ApprovedOrigins": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ApprovedOrigins" + }, + "maxItems": 50, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "AccessUrl" + ], + "type": "object" + }, + "Permissions": { + "maxLength": 255, + "minLength": 1, + "pattern": "^[a-zA-Z0-9\\/\\._\\-\\*]+$", + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "A label for tagging Application resources", + "properties": { + "Key": { + "description": "A key to identify the tag.", + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", + "type": "string" + }, + "Value": { + "description": "Corresponding tag value for the key.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS:AppIntegrations::Application", + "handlers": { + "create": { + "permissions": [ + "app-integrations:CreateApplication", + "app-integrations:TagResource" + ] + }, + "delete": { + "permissions": [ + "app-integrations:DeleteApplication" + ] + }, + "list": { + "permissions": [ + "app-integrations:ListApplications", + "app-integrations:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "app-integrations:GetApplication" + ] + }, + "update": { + "permissions": [ + "app-integrations:GetApplication", + "app-integrations:UpdateApplication", + "app-integrations:TagResource", + "app-integrations:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/ApplicationArn" + ], + "properties": { + "ApplicationArn": { + "description": "The Amazon Resource Name (ARN) of the application.", + "maxLength": 2048, + "minLength": 1, + "pattern": "^arn:aws[-a-z0-9]*:app-integrations:[-a-z0-9]*:[0-9]{12}:application/[-a-zA-Z0-9]*", + "type": "string" + }, + "ApplicationSourceConfig": { + "additionalProperties": false, + "description": "Application source config", + "properties": { + "ExternalUrlConfig": { + "$ref": "#/definitions/ExternalUrlConfig" + } + }, + "required": [ + "ExternalUrlConfig" + ], + "type": "object" + }, + "Description": { + "description": "The application description.", + "maxLength": 1000, + "minLength": 1, + "type": "string" + }, + "Id": { + "description": "The id of the application.", + "maxLength": 255, + "minLength": 1, + "pattern": "^[a-zA-Z0-9/\\._\\-]+$", + "type": "string" + }, + "Name": { + "description": "The name of the application.", + "maxLength": 255, + "minLength": 1, + "pattern": "^[a-zA-Z0-9\\/\\._ \\-]+$", + "type": "string" + }, + "Namespace": { + "description": "The namespace of the application.", + "maxLength": 255, + "minLength": 1, + "pattern": "^[a-zA-Z0-9/\\._\\-]+$", + "type": "string" + }, + "Permissions": { + "description": "The configuration of events or requests that the application has access to.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Permissions" + }, + "maxItems": 150, + "minItems": 0, + "type": "array" + }, + "Tags": { + "description": "The tags (keys and values) associated with the application.", + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/ApplicationArn", + "/properties/Id" + ], + "required": [ + "Name", + "Description", + "ApplicationSourceConfig" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::AppIntegrations::Application" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::AppIntegrations::DataIntegration.json b/artifacts/types/AWS::AppIntegrations::DataIntegration.json index d1d752da..e25efbb9 100644 --- a/artifacts/types/AWS::AppIntegrations::DataIntegration.json +++ b/artifacts/types/AWS::AppIntegrations::DataIntegration.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-AppIntegrations-DataIntegration", "type": "AWS::AppIntegrations::DataIntegration", - "time": "2024-01-03T22:41:49.698Z", + "time": "2024-05-29T21:31:06.17Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::AppIntegrations::EventIntegration.json b/artifacts/types/AWS::AppIntegrations::EventIntegration.json index d01cb7e0..2c1cec7a 100644 --- a/artifacts/types/AWS::AppIntegrations::EventIntegration.json +++ b/artifacts/types/AWS::AppIntegrations::EventIntegration.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-AppIntegrations-EventIntegration", "type": "AWS::AppIntegrations::EventIntegration", - "time": "2024-01-03T22:30:23.93Z", + "time": "2024-05-29T21:26:04.172Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -161,6 +161,13 @@ "EventFilter" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, "typeName": "AWS::AppIntegrations::EventIntegration" } } \ No newline at end of file diff --git a/artifacts/types/AWS::AppRunner::Service.json b/artifacts/types/AWS::AppRunner::Service.json index d81a8f1c..90cb79fd 100644 --- a/artifacts/types/AWS::AppRunner::Service.json +++ b/artifacts/types/AWS::AppRunner::Service.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-AppRunner-Service", "type": "AWS::AppRunner::Service", - "time": "2023-12-29T19:52:29.005Z", + "time": "2024-05-09T16:26:09.976Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::AppRunner::VpcIngressConnection.json b/artifacts/types/AWS::AppRunner::VpcIngressConnection.json index 56b9019e..1f6a50e7 100644 --- a/artifacts/types/AWS::AppRunner::VpcIngressConnection.json +++ b/artifacts/types/AWS::AppRunner::VpcIngressConnection.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-AppRunner-VpcIngressConnection", "type": "AWS::AppRunner::VpcIngressConnection", - "time": "2023-12-29T20:02:54.106Z", + "time": "2024-03-12T17:22:52.476Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::AppStream::AppBlockBuilder.json b/artifacts/types/AWS::AppStream::AppBlockBuilder.json index a5df7feb..94059522 100644 --- a/artifacts/types/AWS::AppStream::AppBlockBuilder.json +++ b/artifacts/types/AWS::AppStream::AppBlockBuilder.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-AppStream-AppBlockBuilder", "type": "AWS::AppStream::AppBlockBuilder", - "time": "2023-06-23T18:19:56.682Z", + "time": "2024-02-26T19:00:54.552Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::AppStream::Application.json b/artifacts/types/AWS::AppStream::Application.json index 4bea8aba..f001790a 100644 --- a/artifacts/types/AWS::AppStream::Application.json +++ b/artifacts/types/AWS::AppStream::Application.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-AppStream-Application", "type": "AWS::AppStream::Application", - "time": "2023-06-23T17:46:49.688Z", + "time": "2024-02-26T18:56:41.916Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -182,6 +182,13 @@ "AppBlockArn" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-appstream.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": false, + "taggable": true + }, "typeName": "AWS::AppStream::Application", "writeOnlyProperties": [ "/properties/Tags", diff --git a/artifacts/types/AWS::AppStream::DirectoryConfig.json b/artifacts/types/AWS::AppStream::DirectoryConfig.json index f8ea3738..20ef2b83 100644 --- a/artifacts/types/AWS::AppStream::DirectoryConfig.json +++ b/artifacts/types/AWS::AppStream::DirectoryConfig.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-AppStream-DirectoryConfig", "type": "AWS::AppStream::DirectoryConfig", - "time": "2022-11-07T17:42:46.572Z", + "time": "2024-03-05T20:40:11.414Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -43,7 +43,7 @@ "permissions": [ "appstream:CreateDirectoryConfig", "appstream:DeleteDirectoryConfig", - "appstream:DescribeDirectoryConfig", + "appstream:DescribeDirectoryConfigs", "appstream:UpdateDirectoryConfig", "iam:CreateServiceLinkedRole", "iam:DeleteServiceLinkedRole", @@ -54,7 +54,7 @@ "permissions": [ "appstream:CreateDirectoryConfig", "appstream:DeleteDirectoryConfig", - "appstream:DescribeDirectoryConfig", + "appstream:DescribeDirectoryConfigs", "appstream:UpdateDirectoryConfig", "iam:CreateServiceLinkedRole", "iam:DeleteServiceLinkedRole", @@ -65,7 +65,7 @@ "permissions": [ "appstream:CreateDirectoryConfig", "appstream:DeleteDirectoryConfig", - "appstream:DescribeDirectoryConfig", + "appstream:DescribeDirectoryConfigs", "appstream:UpdateDirectoryConfig", "iam:CreateServiceLinkedRole", "iam:DeleteServiceLinkedRole", @@ -76,7 +76,7 @@ "permissions": [ "appstream:CreateDirectoryConfig", "appstream:DeleteDirectoryConfig", - "appstream:DescribeDirectoryConfig", + "appstream:DescribeDirectoryConfigs", "appstream:UpdateDirectoryConfig", "iam:CreateServiceLinkedRole", "iam:DeleteServiceLinkedRole", @@ -87,7 +87,7 @@ "permissions": [ "appstream:CreateDirectoryConfig", "appstream:DeleteDirectoryConfig", - "appstream:DescribeDirectoryConfig", + "appstream:DescribeDirectoryConfigs", "appstream:UpdateDirectoryConfig", "iam:CreateServiceLinkedRole", "iam:DeleteServiceLinkedRole", @@ -121,7 +121,9 @@ "OrganizationalUnitDistinguishedNames", "ServiceAccountCredentials" ], - "taggable": false, + "tagging": { + "taggable": false + }, "typeName": "AWS::AppStream::DirectoryConfig", "writeOnlyProperties": [ "/properties/ServiceAccountCredentials/AccountPassword" diff --git a/artifacts/types/AWS::AppStream::Entitlement.json b/artifacts/types/AWS::AppStream::Entitlement.json index 350d9103..ac145361 100644 --- a/artifacts/types/AWS::AppStream::Entitlement.json +++ b/artifacts/types/AWS::AppStream::Entitlement.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-AppStream-Entitlement", "type": "AWS::AppStream::Entitlement", - "time": "2023-06-23T17:46:57.381Z", + "time": "2024-02-26T18:56:58.646Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -92,6 +92,9 @@ "Attributes" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-appstream.git", + "tagging": { + "taggable": false + }, "typeName": "AWS::AppStream::Entitlement" } } \ No newline at end of file diff --git a/artifacts/types/AWS::AppSync::DomainName.json b/artifacts/types/AWS::AppSync::DomainName.json index 64f6b4c4..e3de986c 100644 --- a/artifacts/types/AWS::AppSync::DomainName.json +++ b/artifacts/types/AWS::AppSync::DomainName.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-AppSync-DomainName", "type": "AWS::AppSync::DomainName", - "time": "2023-12-13T17:24:04.639Z", + "time": "2024-03-21T16:21:20.324Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::AppSync::DomainNameApiAssociation.json b/artifacts/types/AWS::AppSync::DomainNameApiAssociation.json index 0a40f791..209cf034 100644 --- a/artifacts/types/AWS::AppSync::DomainNameApiAssociation.json +++ b/artifacts/types/AWS::AppSync::DomainNameApiAssociation.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-AppSync-DomainNameApiAssociation", "type": "AWS::AppSync::DomainNameApiAssociation", - "time": "2023-12-13T18:22:19.489Z", + "time": "2024-03-21T16:16:06.542Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::AppSync::FunctionConfiguration.json b/artifacts/types/AWS::AppSync::FunctionConfiguration.json index d7106e4b..9ee2190e 100644 --- a/artifacts/types/AWS::AppSync::FunctionConfiguration.json +++ b/artifacts/types/AWS::AppSync::FunctionConfiguration.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-AppSync-FunctionConfiguration", "type": "AWS::AppSync::FunctionConfiguration", - "time": "2023-10-18T18:29:30.694Z", + "time": "2024-04-16T15:44:40.669Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::AppSync::Resolver.json b/artifacts/types/AWS::AppSync::Resolver.json index 378324aa..4f0dc031 100644 --- a/artifacts/types/AWS::AppSync::Resolver.json +++ b/artifacts/types/AWS::AppSync::Resolver.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-AppSync-Resolver", "type": "AWS::AppSync::Resolver", - "time": "2023-11-08T00:48:07.799Z", + "time": "2024-06-24T16:32:13.334Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -12,13 +12,14 @@ "definitions": { "AppSyncRuntime": { "additionalProperties": false, + "description": "Describes a runtime used by an APSYlong resolver or APSYlong function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified.", "properties": { "Name": { - "description": "The name of the runtime to use.", + "description": "The ``name`` of the runtime to use. Currently, the only allowed value is ``APPSYNC_JS``.", "type": "string" }, "RuntimeVersion": { - "description": "The version of the runtime to use.", + "description": "The ``version`` of the runtime to use. Currently, the only allowed version is ``1.0.0``.", "type": "string" } }, @@ -30,9 +31,10 @@ }, "CachingConfig": { "additionalProperties": false, + "description": "The caching configuration for a resolver that has caching activated.", "properties": { "CachingKeys": { - "description": "The caching keys for a resolver that has caching activated. Valid values are entries from the $context.arguments, $context.source, and $context.identity maps.", + "description": "The caching keys for a resolver that has caching activated.\n Valid values are entries from the ``$context.arguments``, ``$context.source``, and ``$context.identity`` maps.", "insertionOrder": false, "items": { "type": "string" @@ -41,7 +43,7 @@ "uniqueItems": false }, "Ttl": { - "description": "The TTL in seconds for a resolver that has caching activated. Valid values are 1-36.00 seconds.", + "description": "The TTL in seconds for a resolver that has caching activated.\n Valid values are 1?3,600 seconds.", "type": "number" } }, @@ -52,7 +54,7 @@ }, "LambdaConflictHandlerConfig": { "additionalProperties": false, - "description": "The LambdaConflictHandlerConfig when configuring LAMBDA as the Conflict Handler.", + "description": "The ``LambdaConflictHandlerConfig`` when configuring LAMBDA as the Conflict Handler.", "properties": { "LambdaConflictHandlerArn": { "description": "The Amazon Resource Name (ARN) for the Lambda function to use as the Conflict Handler.", @@ -63,9 +65,10 @@ }, "PipelineConfig": { "additionalProperties": false, + "description": "Use the ``PipelineConfig`` property type to specify ``PipelineConfig`` for an APSYlong resolver.\n ``PipelineConfig`` is a property of the [AWS::AppSync::Resolver](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html) resource.", "properties": { "Functions": { - "description": "A list of Function objects.", + "description": "A list of ``Function`` objects.", "insertionOrder": false, "items": { "type": "string" @@ -78,17 +81,19 @@ }, "SyncConfig": { "additionalProperties": false, + "description": "Describes a Sync configuration for a resolver.\n Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is invoked.", "properties": { "ConflictDetection": { - "description": "The Conflict Detection strategy to use.", + "description": "The Conflict Detection strategy to use.\n + *VERSION*: Detect conflicts based on object versions for this resolver.\n + *NONE*: Do not detect conflicts when invoking this resolver.", "type": "string" }, "ConflictHandler": { - "description": "The Conflict Resolution strategy to perform in the event of a conflict.", + "description": "The Conflict Resolution strategy to perform in the event of a conflict.\n + *OPTIMISTIC_CONCURRENCY*: Resolve conflicts by rejecting mutations when versions don't match the latest version at the server.\n + *AUTOMERGE*: Resolve conflicts with the Automerge conflict resolution strategy.\n + *LAMBDA*: Resolve conflicts with an LAMlong function supplied in the ``LambdaConflictHandlerConfig``.", "type": "string" }, "LambdaConflictHandlerConfig": { - "$ref": "#/definitions/LambdaConflictHandlerConfig" + "$ref": "#/definitions/LambdaConflictHandlerConfig", + "description": "The ``LambdaConflictHandlerConfig`` when configuring ``LAMBDA`` as the Conflict Handler." } }, "required": [ @@ -97,7 +102,7 @@ "type": "object" } }, - "description": "Resource Type definition for AWS::AppSync::Resolver", + "description": "The ``AWS::AppSync::Resolver`` resource defines the logical GraphQL resolver that you attach to fields in a schema. Request and response templates for resolvers are written in Apache Velocity Template Language (VTL) format. For more information about resolvers, see [Resolver Mapping Template Reference](https://docs.aws.amazon.com/appsync/latest/devguide/resolver-mapping-template-reference.html).\n When you submit an update, CFNLong updates resources based on differences between what you submit and the stack's current template. To cause this resource to be updated you must change a property value for this resource in the CFNshort template. Changing the S3 file content without changing a property value will not result in an update operation.\n See [Update Behaviors of Stack Resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html) in the *User Guide*.", "handlers": { "create": { "permissions": [ @@ -147,7 +152,7 @@ ], "properties": { "ApiId": { - "description": "The AWS AppSync GraphQL API to which you want to attach this resolver.", + "description": "The APSYlong GraphQL API to which you want to attach this resolver.", "type": "string" }, "CachingConfig": { @@ -155,7 +160,7 @@ "description": "The caching configuration for the resolver." }, "Code": { - "description": "The resolver code that contains the request and response functions. When code is used, the runtime is required.", + "description": "The ``resolver`` code that contains the request and response functions. When code is used, the ``runtime`` is required. The runtime value must be ``APPSYNC_JS``.", "type": "string" }, "CodeS3Location": { @@ -171,27 +176,35 @@ "type": "string" }, "Kind": { - "description": "The resolver type.", + "description": "The resolver type.\n + *UNIT*: A UNIT resolver type. A UNIT resolver is the default resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source.\n + *PIPELINE*: A PIPELINE resolver type. You can use a PIPELINE resolver to invoke a series of ``Function`` objects in a serial manner. You can use a pipeline resolver to run a GraphQL query against multiple data sources.", "type": "string" }, "MaxBatchSize": { - "description": "The maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a BatchInvoke operation.", + "description": "The maximum number of resolver request inputs that will be sent to a single LAMlong function in a ``BatchInvoke`` operation.", "type": "integer" }, + "MetricsConfig": { + "description": "Enables or disables enhanced resolver metrics for specified resolvers. Note that ``MetricsConfig`` won't be used unless the ``resolverLevelMetricsBehavior`` value is set to ``PER_RESOLVER_METRICS``. If the ``resolverLevelMetricsBehavior`` is set to ``FULL_REQUEST_RESOLVER_METRICS`` instead, ``MetricsConfig`` will be ignored. However, you can still set its value.", + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + }, "PipelineConfig": { "$ref": "#/definitions/PipelineConfig", "description": "Functions linked with the pipeline resolver." }, "RequestMappingTemplate": { - "description": "Request mapping templates are optional when using a Lambda data source. For all other data sources, a request mapping template is required.", + "description": "The request mapping template.\n Request mapping templates are optional when using a Lambda data source. For all other data sources, a request mapping template is required.", "type": "string" }, "RequestMappingTemplateS3Location": { - "description": "The location of a request mapping template in an Amazon S3 bucket. Use this if you want to provision with a template file in Amazon S3 rather than embedding it in your CloudFormation template.", + "description": "The location of a request mapping template in an S3 bucket. Use this if you want to provision with a template file in S3 rather than embedding it in your CFNshort template.", "type": "string" }, "ResolverArn": { - "description": "The Amazon Resource Name (ARN) for the resolver.", + "description": "", "type": "string" }, "ResponseMappingTemplate": { @@ -199,16 +212,16 @@ "type": "string" }, "ResponseMappingTemplateS3Location": { - "description": "The location of a response mapping template in an Amazon S3 bucket. Use this if you want to provision with a template file in Amazon S3 rather than embedding it in your CloudFormation template.", + "description": "The location of a response mapping template in an S3 bucket. Use this if you want to provision with a template file in S3 rather than embedding it in your CFNshort template.", "type": "string" }, "Runtime": { "$ref": "#/definitions/AppSyncRuntime", - "description": "Describes a runtime used by an AWS AppSync pipeline resolver or AWS AppSync function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified." + "description": "Describes a runtime used by an APSYlong resolver or APSYlong function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified." }, "SyncConfig": { "$ref": "#/definitions/SyncConfig", - "description": "The SyncConfig for a resolver attached to a versioned data source." + "description": "The ``SyncConfig`` for a resolver attached to a versioned data source." }, "TypeName": { "description": "The GraphQL type that invokes this resolver.", diff --git a/artifacts/types/AWS::AppSync::SourceApiAssociation.json b/artifacts/types/AWS::AppSync::SourceApiAssociation.json index 5d385834..27c01f10 100644 --- a/artifacts/types/AWS::AppSync::SourceApiAssociation.json +++ b/artifacts/types/AWS::AppSync::SourceApiAssociation.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-AppSync-SourceApiAssociation", "type": "AWS::AppSync::SourceApiAssociation", - "time": "2023-12-13T16:29:48.116Z", + "time": "2024-03-21T15:27:17.314Z", "schema": { "additionalIdentifiers": [ [ diff --git a/artifacts/types/AWS::ApplicationAutoScaling::ScalableTarget.json b/artifacts/types/AWS::ApplicationAutoScaling::ScalableTarget.json index dbd7cb61..96134ab5 100644 --- a/artifacts/types/AWS::ApplicationAutoScaling::ScalableTarget.json +++ b/artifacts/types/AWS::ApplicationAutoScaling::ScalableTarget.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ApplicationAutoScaling-ScalableTarget", "type": "AWS::ApplicationAutoScaling::ScalableTarget", - "time": "2023-07-05T15:47:14.942Z", + "time": "2024-06-24T15:24:05.468Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -12,12 +12,14 @@ "definitions": { "ScalableTargetAction": { "additionalProperties": false, - "description": "specifies the minimum and maximum capacity", + "description": "``ScalableTargetAction`` specifies the minimum and maximum capacity for the ``ScalableTargetAction`` property of the [AWS::ApplicationAutoScaling::ScalableTarget ScheduledAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalabletarget-scheduledaction.html) property type.", "properties": { "MaxCapacity": { + "description": "The maximum capacity.", "type": "integer" }, "MinCapacity": { + "description": "The minimum capacity.", "type": "integer" } }, @@ -25,24 +27,30 @@ }, "ScheduledAction": { "additionalProperties": false, - "description": "specifies a scheduled action for a scalable target", + "description": "``ScheduledAction`` is a property of the [AWS::ApplicationAutoScaling::ScalableTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalabletarget.html) resource that specifies a scheduled action for a scalable target. \n For more information, see [Scheduled scaling](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-scheduled-scaling.html) in the *Application Auto Scaling User Guide*.", "properties": { "EndTime": { + "description": "The date and time that the action is scheduled to end, in UTC.", "type": "string" }, "ScalableTargetAction": { - "$ref": "#/definitions/ScalableTargetAction" + "$ref": "#/definitions/ScalableTargetAction", + "description": "The new minimum and maximum capacity. You can set both values or just one. At the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity." }, "Schedule": { + "description": "The schedule for this action. The following formats are supported:\n + At expressions - \"``at(yyyy-mm-ddThh:mm:ss)``\"\n + Rate expressions - \"``rate(value unit)``\"\n + Cron expressions - \"``cron(fields)``\"\n \n At expressions are useful for one-time schedules. Cron expressions are useful for scheduled actions that run periodically at a specified date and time, and rate expressions are useful for scheduled actions that run at a regular interval.\n At and cron expressions use Universal Coordinated Time (UTC) by default.\n The cron format consists of six fields separated by white spaces: [Minutes] [Hours] [Day_of_Month] [Month] [Day_of_Week] [Year].\n For rate expressions, *value* is a positive integer and *unit* is ``minute`` | ``minutes`` | ``hour`` | ``hours`` | ``day`` | ``days``.", "type": "string" }, "ScheduledActionName": { + "description": "The name of the scheduled action. This name must be unique among all other scheduled actions on the specified scalable target.", "type": "string" }, "StartTime": { + "description": "The date and time that the action is scheduled to begin, in UTC.", "type": "string" }, "Timezone": { + "description": "The time zone used when referring to the date and time of a scheduled action, when the scheduled action uses an at or cron expression.", "type": "string" } }, @@ -54,22 +62,25 @@ }, "SuspendedState": { "additionalProperties": false, - "description": "specifies whether the scaling activities for a scalable target are in a suspended state", + "description": "``SuspendedState`` is a property of the [AWS::ApplicationAutoScaling::ScalableTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalabletarget.html) resource that specifies whether the scaling activities for a scalable target are in a suspended state.\n For more information, see [Suspending and resuming scaling](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-suspend-resume-scaling.html) in the *Application Auto Scaling User Guide*.", "properties": { "DynamicScalingInSuspended": { + "description": "Whether scale in by a target tracking scaling policy or a step scaling policy is suspended. Set the value to ``true`` if you don't want Application Auto Scaling to remove capacity when a scaling policy is triggered. The default is ``false``.", "type": "boolean" }, "DynamicScalingOutSuspended": { + "description": "Whether scale out by a target tracking scaling policy or a step scaling policy is suspended. Set the value to ``true`` if you don't want Application Auto Scaling to add capacity when a scaling policy is triggered. The default is ``false``.", "type": "boolean" }, "ScheduledScalingSuspended": { + "description": "Whether scheduled scaling is suspended. Set the value to ``true`` if you don't want Application Auto Scaling to add or remove capacity by initiating scheduled actions. The default is ``false``.", "type": "boolean" } }, "type": "object" } }, - "description": "Resource Type definition for AWS::ApplicationAutoScaling::ScalableTarget", + "description": "The ``AWS::ApplicationAutoScaling::ScalableTarget`` resource specifies a resource that Application Auto Scaling can scale, such as an AWS::DynamoDB::Table or AWS::ECS::Service resource.\n For more information, see [Getting started](https://docs.aws.amazon.com/autoscaling/application/userguide/getting-started.html) in the *Application Auto Scaling User Guide*.\n If the resource that you want Application Auto Scaling to scale is not yet created in your account, add a dependency on the resource when registering it as a scalable target using the [DependsOn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) attribute.", "handlers": { "create": { "permissions": [ @@ -126,27 +137,41 @@ ], "properties": { "Id": { - "description": "This value can be returned by using the Ref function. Ref returns the Cloudformation generated ID of the resource in format - ResourceId|ScalableDimension|ServiceNamespace", + "description": "", "type": "string" }, "MaxCapacity": { - "description": "The maximum value that you plan to scale in to. When a scaling policy is in effect, Application Auto Scaling can scale in (contract) as needed to the minimum capacity limit in response to changing demand", + "description": "The maximum value that you plan to scale out to. When a scaling policy is in effect, Application Auto Scaling can scale out (expand) as needed to the maximum capacity limit in response to changing demand.", "type": "integer" }, "MinCapacity": { - "description": "The minimum value that you plan to scale in to. When a scaling policy is in effect, Application Auto Scaling can scale in (contract) as needed to the minimum capacity limit in response to changing demand", + "description": "The minimum value that you plan to scale in to. When a scaling policy is in effect, Application Auto Scaling can scale in (contract) as needed to the minimum capacity limit in response to changing demand.", "type": "integer" }, "ResourceId": { - "description": "The identifier of the resource associated with the scalable target", + "anyOf": [ + { + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::MSK::Cluster" + } + }, + { + "relationshipRef": { + "propertyPath": "/properties/ServiceArn", + "typeName": "AWS::ECS::Service" + } + } + ], + "description": "The identifier of the resource associated with the scalable target. This 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 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 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. Example: ``instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0``.\n + AppStream 2.0 fleet - The resource type is ``fleet`` and the unique identifier is the fleet name. Example: ``fleet/sample-fleet``.\n + DynamoDB table - The resource type is ``table`` and the unique identifier is the table name. Example: ``table/my-table``.\n + DynamoDB global secondary index - The resource type is ``index`` and the unique identifier is the index name. 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. Example: ``cluster:my-db-cluster``.\n + SageMaker endpoint variant - The resource type is ``variant`` and the unique identifier is the resource ID. 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 is available in our [GitHub repository](https://docs.aws.amazon.com/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``. 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. Example: ``keyspace/mykeyspace/table/mytable``.\n + Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. 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. Example: ``replication-group/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. 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. Example: ``inference-component/my-inference-component``.", "type": "string" }, "RoleARN": { - "description": "Specify the Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that allows Application Auto Scaling to modify the scalable target on your behalf. ", + "description": "Specify the Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that allows Application Auto Scaling to modify the scalable target on your behalf. This can be either an IAM service role that Application Auto Scaling can assume to make calls to other AWS resources on your behalf, or a service-linked role for the specified service. For more information, see [How Application Auto Scaling works with IAM](https://docs.aws.amazon.com/autoscaling/application/userguide/security_iam_service-with-iam.html) in the *Application Auto Scaling User Guide*.\n To automatically create a service-linked role (recommended), specify the full ARN of the service-linked role in your stack template. To find the exact ARN of the service-linked role for 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 Guide*. Look for the ARN in the table at the bottom of the page.", "type": "string" }, "ScalableDimension": { - "description": "The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property", + "description": "The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.\n + ``ecs:service:DesiredCount`` - The desired 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 desired 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: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.", "type": "string" }, "ScheduledActions": { @@ -159,12 +184,12 @@ "uniqueItems": true }, "ServiceNamespace": { - "description": "The namespace of the AWS service that provides the resource, or a custom-resource", + "description": "The namespace of the AWS service that provides the resource, or a ``custom-resource``.", "type": "string" }, "SuspendedState": { "$ref": "#/definitions/SuspendedState", - "description": "An embedded object that contains attributes and attribute values that are used to suspend and resume automatic scaling. Setting the value of an attribute to true suspends the specified scaling activities. Setting it to false (default) resumes the specified scaling activities." + "description": "An embedded object that contains attributes and attribute values that are used to suspend and resume automatic scaling. Setting the value of an attribute to ``true`` suspends the specified scaling activities. Setting it to ``false`` (default) resumes the specified scaling activities. \n *Suspension Outcomes* \n + For ``DynamicScalingInSuspended``, while a suspension is in effect, all scale-in activities that are triggered by a scaling policy are suspended.\n + For ``DynamicScalingOutSuspended``, while a suspension is in effect, all scale-out activities that are triggered by a scaling policy are suspended.\n + For ``ScheduledScalingSuspended``, while a suspension is in effect, all scaling activities that involve scheduled actions are suspended." } }, "readOnlyProperties": [ diff --git a/artifacts/types/AWS::ApplicationInsights::Application.json b/artifacts/types/AWS::ApplicationInsights::Application.json index d9aba606..c36aeb05 100644 --- a/artifacts/types/AWS::ApplicationInsights::Application.json +++ b/artifacts/types/AWS::ApplicationInsights::Application.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ApplicationInsights-Application", "type": "AWS::ApplicationInsights::Application", - "time": "2023-12-28T16:18:57.601Z", + "time": "2024-06-12T15:58:59.35Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -167,6 +167,22 @@ }, "type": "array" }, + "NetWeaverPrometheusExporter": { + "$ref": "#/definitions/NetWeaverPrometheusExporter", + "description": "The NetWeaver Prometheus Exporter settings." + }, + "Processes": { + "description": "A list of processes to monitor for the component. Only Windows EC2 instances can have a processes section.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/Process" + }, + "type": "array" + }, + "SQLServerPrometheusExporter": { + "$ref": "#/definitions/SQLServerPrometheusExporter", + "description": "The SQL Prometheus Exporter settings." + }, "WindowsEvents": { "description": "A list of Windows Events to log.", "insertionOrder": true, @@ -383,6 +399,80 @@ ], "type": "object" }, + "NetWeaverPrometheusExporter": { + "additionalProperties": false, + "description": "The NetWeaver Prometheus Exporter Settings.", + "properties": { + "InstanceNumbers": { + "description": "SAP instance numbers for ASCS, ERS, and App Servers.", + "items": { + "maxLength": 2, + "minLength": 1, + "pattern": "\\b([0-9]|[0-9][0-9])\\b", + "type": "string" + }, + "type": "array" + }, + "PrometheusPort": { + "description": "Prometheus exporter port.", + "type": "string" + }, + "SAPSID": { + "description": "SAP NetWeaver SID.", + "type": "string" + } + }, + "required": [ + "SAPSID", + "InstanceNumbers" + ], + "type": "object" + }, + "Process": { + "additionalProperties": false, + "description": "A process to be monitored for the component.", + "properties": { + "AlarmMetrics": { + "description": "A list of metrics to monitor for the component.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/AlarmMetric" + }, + "type": "array" + }, + "ProcessName": { + "description": "The name of the process to be monitored for the component.", + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_,-]+$", + "type": "string" + } + }, + "required": [ + "ProcessName", + "AlarmMetrics" + ], + "type": "object" + }, + "SQLServerPrometheusExporter": { + "additionalProperties": false, + "description": "The SQL prometheus exporter settings.", + "properties": { + "PrometheusPort": { + "description": "Prometheus exporter port.", + "type": "string" + }, + "SQLSecretName": { + "description": "Secret name which managers SQL exporter connection. e.g. {\"data_source_name\": \"sqlserver://\u003cUSERNAME\u003e:\u003cPASSWORD\u003e@localhost:1433\"}", + "type": "string" + } + }, + "required": [ + "PrometheusPort", + "SQLSecretName" + ], + "type": "object" + }, "SubComponentConfigurationDetails": { "additionalProperties": false, "description": "The configuration settings of sub components.", @@ -403,6 +493,14 @@ }, "type": "array" }, + "Processes": { + "description": "A list of processes to monitor for the component. Only Windows EC2 instances can have a processes section.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/Process" + }, + "type": "array" + }, "WindowsEvents": { "description": "A list of Windows Events to log.", "insertionOrder": true, @@ -541,6 +639,10 @@ "description": "The ARN of the ApplicationInsights application.", "type": "string" }, + "AttachMissingPermission": { + "description": "If set to true, the managed policies for SSM and CW will be attached to the instance roles if they are missing", + "type": "boolean" + }, "AutoConfigurationEnabled": { "description": "If set to true, application will be configured with recommended monitoring configuration.", "type": "boolean" @@ -625,7 +727,8 @@ "/properties/LogPatternSets", "/properties/CustomComponents", "/properties/GroupingType", - "/properties/OpsItemSNSTopicArn" + "/properties/OpsItemSNSTopicArn", + "/properties/AttachMissingPermission" ] } } \ No newline at end of file diff --git a/artifacts/types/AWS::ApplicationSignals::ServiceLevelObjective.json b/artifacts/types/AWS::ApplicationSignals::ServiceLevelObjective.json new file mode 100644 index 00000000..5fa2644c --- /dev/null +++ b/artifacts/types/AWS::ApplicationSignals::ServiceLevelObjective.json @@ -0,0 +1,419 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ApplicationSignals-ServiceLevelObjective", + "type": "AWS::ApplicationSignals::ServiceLevelObjective", + "time": "2024-06-12T15:39:12.608Z", + "schema": { + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "CalendarInterval": { + "additionalProperties": false, + "description": "If the interval for this service level objective is a calendar interval, this structure contains the interval specifications.", + "properties": { + "Duration": { + "$ref": "#/definitions/Duration" + }, + "DurationUnit": { + "$ref": "#/definitions/DurationUnit" + }, + "StartTime": { + "description": "Epoch time in seconds you want the first interval to start. Be sure to choose a time that configures the intervals the way that you want. For example, if you want weekly intervals starting on Mondays at 6 a.m., be sure to specify a start time that is a Monday at 6 a.m.\nAs soon as one calendar interval ends, another automatically begins.", + "minimum": 946684800, + "type": "integer" + } + }, + "required": [ + "StartTime", + "DurationUnit", + "Duration" + ], + "type": "object" + }, + "Dimension": { + "additionalProperties": false, + "description": "A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique identifier for a metric, whenever you add a unique name/value pair to one of your metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish `InstanceId` as a dimension name, and the actual instance ID as the value for that dimension. You can assign up to 30 dimensions to a metric.", + "properties": { + "Name": { + "description": "The name of the dimension. Dimension names must contain only ASCII characters, must include at least one non-whitespace character, and cannot start with a colon (:). ASCII control characters are not supported as part of dimension names.", + "type": "string" + }, + "Value": { + "description": "The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character. ASCII control characters are not supported as part of dimension values", + "type": "string" + } + }, + "required": [ + "Value", + "Name" + ], + "type": "object" + }, + "Duration": { + "description": "Specifies the duration of each calendar interval. For example, if `Duration` is 1 and `DurationUnit` is `MONTH`, each interval is one month, aligned with the calendar.", + "minimum": 1, + "type": "integer" + }, + "DurationUnit": { + "description": "Specifies the calendar interval unit.", + "enum": [ + "DAY", + "MONTH" + ], + "type": "string" + }, + "Goal": { + "additionalProperties": false, + "description": "A structure that contains the attributes that determine the goal of the SLO. This includes the time period for evaluation and the attainment threshold.", + "properties": { + "AttainmentGoal": { + "description": "The threshold that determines if the goal is being met. An attainment goal is the ratio of good periods that meet the threshold requirements to the total periods within the interval. For example, an attainment goal of 99.9% means that within your interval, you are targeting 99.9% of the periods to be in healthy state.\nIf you omit this parameter, 99 is used to represent 99% as the attainment goal.", + "type": "number" + }, + "Interval": { + "$ref": "#/definitions/Interval" + }, + "WarningThreshold": { + "description": "The percentage of remaining budget over total budget that you want to get warnings for. If you omit this parameter, the default of 50.0 is used.", + "type": "number" + } + }, + "type": "object" + }, + "Interval": { + "additionalProperties": false, + "description": "The 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.", + "properties": { + "CalendarInterval": { + "$ref": "#/definitions/CalendarInterval" + }, + "RollingInterval": { + "$ref": "#/definitions/RollingInterval" + } + }, + "type": "object" + }, + "KeyAttributes": { + "additionalProperties": false, + "description": "This is a string-to-string map that contains information about the type of object that this SLO is related to.", + "patternProperties": { + "^.+$": { + "type": "string" + } + } + }, + "Metric": { + "additionalProperties": false, + "description": "This structure defines the metric used for a service level indicator, including the metric name, namespace, and dimensions.", + "properties": { + "Dimensions": { + "description": "An array of one or more dimensions to use to define the metric that you want to use.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Dimension" + }, + "type": "array", + "uniqueItems": false + }, + "MetricName": { + "description": "The name of the metric to use.", + "type": "string" + }, + "Namespace": { + "description": "The namespace of the metric.", + "type": "string" + } + }, + "type": "object" + }, + "MetricDataQueries": { + "description": "If this SLO monitors a CloudWatch metric or the result of a CloudWatch metric math expression, this structure includes the information about that metric or expression.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/MetricDataQuery" + }, + "type": "array", + "uniqueItems": false + }, + "MetricDataQuery": { + "additionalProperties": false, + "description": "Use 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 to be performed on retrieved metrics. A single `MetricDataQueries` array can include as many as 20 `MetricDataQuery` structures in the array. The 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 contain the `Expression` parameter to perform a math expression. Of those Expression structures, exactly one must have true as the value for `ReturnData`. The result of this expression used for the SLO.", + "properties": { + "AccountId": { + "description": "The ID of the account where the metrics are located, if this is a cross-account alarm.", + "type": "string" + }, + "Expression": { + "description": "The math expression to be performed on the returned data.", + "type": "string" + }, + "Id": { + "description": "A short name used to tie this object to the results in the response.", + "type": "string" + }, + "MetricStat": { + "$ref": "#/definitions/MetricStat", + "description": "A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO. Within one MetricDataQuery, you must specify either Expression or MetricStat but not both." + }, + "ReturnData": { + "description": "This option indicates whether to return the timestamps and raw data values of this metric.", + "type": "boolean" + } + }, + "required": [ + "Id" + ], + "type": "object" + }, + "MetricStat": { + "additionalProperties": false, + "description": "A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO. Within one MetricDataQuery object, you must specify either Expression or MetricStat but not both.", + "properties": { + "Metric": { + "$ref": "#/definitions/Metric" + }, + "Period": { + "description": "The granularity, in seconds, to be used for the metric.", + "type": "integer" + }, + "Stat": { + "description": "The statistic to use for comparison to the threshold. It can be any CloudWatch statistic or extended statistic.", + "type": "string" + }, + "Unit": { + "description": "If you omit Unit then all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.", + "type": "string" + } + }, + "required": [ + "Stat", + "Period", + "Metric" + ], + "type": "object" + }, + "RollingInterval": { + "additionalProperties": false, + "description": "If the interval is a calendar interval, this structure contains the interval specifications.", + "properties": { + "Duration": { + "$ref": "#/definitions/Duration" + }, + "DurationUnit": { + "$ref": "#/definitions/DurationUnit" + } + }, + "required": [ + "DurationUnit", + "Duration" + ], + "type": "object" + }, + "Sli": { + "additionalProperties": false, + "description": "This structure contains information about the performance metric that an SLO monitors.", + "properties": { + "ComparisonOperator": { + "description": "The arithmetic operation used when comparing the specified metric to the threshold.", + "enum": [ + "GreaterThanOrEqualTo", + "LessThanOrEqualTo", + "LessThan", + "GreaterThan" + ], + "type": "string" + }, + "MetricThreshold": { + "description": "The value that the SLI metric is compared to.", + "type": "number" + }, + "SliMetric": { + "$ref": "#/definitions/SliMetric" + } + }, + "required": [ + "SliMetric", + "MetricThreshold", + "ComparisonOperator" + ], + "type": "object" + }, + "SliMetric": { + "additionalProperties": false, + "description": "A structure that contains information about the metric that the SLO monitors.", + "properties": { + "KeyAttributes": { + "$ref": "#/definitions/KeyAttributes" + }, + "MetricDataQueries": { + "$ref": "#/definitions/MetricDataQueries" + }, + "MetricType": { + "description": "If the SLO monitors either the LATENCY or AVAILABILITY metric that Application Signals collects, this field displays which of those metrics is used.", + "enum": [ + "LATENCY", + "AVAILABILITY" + ], + "type": "string" + }, + "OperationName": { + "description": "If the SLO monitors a specific operation of the service, this field displays that operation name.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "PeriodSeconds": { + "description": "The 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.", + "maximum": 900, + "minimum": 60, + "type": "integer" + }, + "Statistic": { + "description": "The statistic to use for comparison to the threshold. It can be any CloudWatch statistic or extended statistic", + "maxLength": 20, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "description": "A string that you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.", + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", + "type": "string" + }, + "Value": { + "description": "The value for the specified tag key.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "Tags": { + "description": "The list of tag keys and values associated with the resource you specified", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 1, + "type": "array", + "uniqueItems": true + } + }, + "description": "Resource Type definition for AWS::ApplicationSignals::ServiceLevelObjective", + "handlers": { + "create": { + "permissions": [ + "application-signals:CreateServiceLevelObjective", + "cloudwatch:GetMetricData", + "application-signals:TagResource", + "application-signals:GetServiceLevelObjective", + "application-signals:ListTagsForResource", + "iam:GetRole", + "iam:CreateServiceLinkedRole" + ] + }, + "delete": { + "permissions": [ + "application-signals:DeleteServiceLevelObjective", + "application-signals:UntagResource", + "application-signals:GetServiceLevelObjective" + ] + }, + "list": { + "permissions": [ + "application-signals:ListServiceLevelObjectives", + "application-signals:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "application-signals:GetServiceLevelObjective", + "application-signals:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "application-signals:UpdateServiceLevelObjective", + "cloudwatch:GetMetricData", + "application-signals:TagResource", + "application-signals:UntagResource", + "application-signals:GetServiceLevelObjective", + "application-signals:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "The ARN of this SLO.", + "pattern": "^arn:[^:]*:application-signals:[^:]*:[^:]*:slo\\/[0-9A-Za-z][-._0-9A-Za-z ]{0,126}[0-9A-Za-z]$", + "type": "string" + }, + "CreatedTime": { + "description": "Epoch time in seconds of the time that this SLO was created", + "minimum": 946684800, + "type": "integer" + }, + "Description": { + "default": "No description", + "description": "An optional description for this SLO. Default is 'No description'", + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "Goal": { + "$ref": "#/definitions/Goal" + }, + "LastUpdatedTime": { + "description": "Epoch time in seconds of the time that this SLO was most recently updated", + "minimum": 946684800, + "type": "integer" + }, + "Name": { + "description": "The name of this SLO.", + "pattern": "^[0-9A-Za-z][-._0-9A-Za-z ]{0,126}[0-9A-Za-z]$", + "type": "string" + }, + "Sli": { + "$ref": "#/definitions/Sli" + }, + "Tags": { + "$ref": "#/definitions/Tags" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CreatedTime", + "/properties/LastUpdatedTime" + ], + "required": [ + "Name", + "Sli" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-applicationsignals", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::ApplicationSignals::ServiceLevelObjective" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::Athena::CapacityReservation.json b/artifacts/types/AWS::Athena::CapacityReservation.json index 81a419da..895c77b9 100644 --- a/artifacts/types/AWS::Athena::CapacityReservation.json +++ b/artifacts/types/AWS::Athena::CapacityReservation.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Athena-CapacityReservation", "type": "AWS::Athena::CapacityReservation", - "time": "2023-07-07T18:49:08.327Z", + "time": "2024-05-30T16:13:05.148Z", "schema": { "additionalIdentifiers": [ [ diff --git a/artifacts/types/AWS::Athena::DataCatalog.json b/artifacts/types/AWS::Athena::DataCatalog.json index 792d0bcd..515e3afc 100644 --- a/artifacts/types/AWS::Athena::DataCatalog.json +++ b/artifacts/types/AWS::Athena::DataCatalog.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Athena-DataCatalog", "type": "AWS::Athena::DataCatalog", - "time": "2023-12-26T16:26:24.084Z", + "time": "2024-06-18T15:23:46.239Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Athena::PreparedStatement.json b/artifacts/types/AWS::Athena::PreparedStatement.json index ea772810..c221cce0 100644 --- a/artifacts/types/AWS::Athena::PreparedStatement.json +++ b/artifacts/types/AWS::Athena::PreparedStatement.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Athena-PreparedStatement", "type": "AWS::Athena::PreparedStatement", - "time": "2023-12-21T16:22:38.657Z", + "time": "2024-06-13T18:16:18.607Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Athena::WorkGroup.json b/artifacts/types/AWS::Athena::WorkGroup.json index 276c4ca1..ba105e2f 100644 --- a/artifacts/types/AWS::Athena::WorkGroup.json +++ b/artifacts/types/AWS::Athena::WorkGroup.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Athena-WorkGroup", "type": "AWS::Athena::WorkGroup", - "time": "2023-12-21T16:35:46.769Z", + "time": "2024-06-13T15:16:54.261Z", "schema": { "$comment": "Resource Schema for AWS::Athena::WorkGroup. Any changes made to SDK model for WorkGroup should be reflected here.", "additionalProperties": false, diff --git a/artifacts/types/AWS::AuditManager::Assessment.json b/artifacts/types/AWS::AuditManager::Assessment.json index bf6508d0..aefb197c 100644 --- a/artifacts/types/AWS::AuditManager::Assessment.json +++ b/artifacts/types/AWS::AuditManager::Assessment.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-AuditManager-Assessment", "type": "AWS::AuditManager::Assessment", - "time": "2023-12-06T16:28:05.109Z", + "time": "2024-06-05T16:01:54.542Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::AutoScaling::AutoScalingGroup.json b/artifacts/types/AWS::AutoScaling::AutoScalingGroup.json index 485c105b..d97fd104 100644 --- a/artifacts/types/AWS::AutoScaling::AutoScalingGroup.json +++ b/artifacts/types/AWS::AutoScaling::AutoScalingGroup.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-AutoScaling-AutoScalingGroup", "type": "AWS::AutoScaling::AutoScalingGroup", - "time": "2023-12-20T17:32:26.479Z", + "time": "2024-06-10T16:13:03.18Z", "schema": { "additionalProperties": false, "conditionalCreateOnlyProperties": [ @@ -18,11 +18,14 @@ "definitions": { "AcceleratorCountRequest": { "additionalProperties": false, + "description": "``AcceleratorCountRequest`` is a property of the ``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 describes the minimum and maximum number of accelerators for an instance type.", "properties": { "Max": { + "description": "The maximum value.", "type": "integer" }, "Min": { + "description": "The minimum value.", "type": "integer" } }, @@ -30,11 +33,14 @@ }, "AcceleratorTotalMemoryMiBRequest": { "additionalProperties": false, + "description": "``AcceleratorTotalMemoryMiBRequest`` is a property of the ``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 describes the minimum and maximum total memory size for the accelerators for an instance type, in MiB.", "properties": { "Max": { + "description": "The memory maximum in MiB.", "type": "integer" }, "Min": { + "description": "The memory minimum in MiB.", "type": "integer" } }, @@ -42,11 +48,14 @@ }, "BaselineEbsBandwidthMbpsRequest": { "additionalProperties": false, + "description": "``BaselineEbsBandwidthMbpsRequest`` is a property of the ``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 describes the minimum and maximum baseline bandwidth performance for an instance type, in Mbps.", "properties": { "Max": { + "description": "The maximum value in Mbps.", "type": "integer" }, "Min": { + "description": "The minimum value in Mbps.", "type": "integer" } }, @@ -62,11 +71,14 @@ "MaxHealthyPercentage" ] }, + "description": "``InstanceMaintenancePolicy`` is a property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource.\n For more information, see [Instance maintenance policies](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-maintenance-policy.html) in the *Amazon EC2 Auto Scaling User Guide*.", "properties": { "MaxHealthyPercentage": { + "description": "Specifies the upper threshold as a percentage of the desired capacity of the Auto Scaling group. It represents the maximum percentage of the group that can be in service and healthy, or pending, to support your workload when replacing instances. Value range is 100 to 200. To clear a previously set value, specify a value of ``-1``.\n Both ``MinHealthyPercentage`` and ``MaxHealthyPercentage`` must be specified, and the difference between them cannot be greater than 100. A large range increases the number of instances that can be replaced at the same time.", "type": "integer" }, "MinHealthyPercentage": { + "description": "Specifies the lower threshold as a percentage of the desired capacity of the Auto Scaling group. It represents the minimum percentage of the group to keep in service, healthy, and ready to use to support your workload when replacing instances. Value range is 0 to 100. To clear a previously set value, specify a value of ``-1``.", "type": "integer" } }, @@ -74,11 +86,14 @@ }, "InstanceRequirements": { "additionalProperties": false, + "description": "The attributes for the instance types for a mixed instances policy. Amazon EC2 Auto Scaling uses your specified requirements to identify instance types. Then, it uses your On-Demand and Spot allocation strategies to launch instances from these instance types.\n When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values.\n To limit the list of instance types from which Amazon EC2 Auto Scaling can identify matching instance types, you 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 other instance types are ignored, even if they match your specified attributes.\n + ``ExcludedInstanceTypes`` - The instance types to exclude from the list, even if they match your specified attributes.\n \n You must specify ``VCpuCount`` and ``MemoryMiB``. All other attributes are optional. Any unspecified optional attribute is set to its default.\n For an example template, see [Configure Amazon EC2 Auto Scaling resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-ec2-auto-scaling.html).\n For more information, see [Creating an Auto Scaling group using attribute-based instance type selection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-instance-type-requirements.html) in the *Amazon EC2 Auto Scaling User Guide*. For help determining which instance types match your attributes 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 Guide for Linux Instances*.\n ``InstanceRequirements`` is a property of the ``LaunchTemplateOverrides`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplate.html) property type.", "properties": { "AcceleratorCount": { - "$ref": "#/definitions/AcceleratorCountRequest" + "$ref": "#/definitions/AcceleratorCountRequest", + "description": "The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) for an instance type.\n To exclude accelerator-enabled instance types, set ``Max`` to ``0``.\n Default: No minimum or maximum limits" }, "AcceleratorManufacturers": { + "description": "Indicates whether instance types must have accelerators by specific manufacturers.\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 ``amazon-web-services``.\n + For instance types with Xilinx devices, specify ``xilinx``.\n \n Default: Any manufacturer", "insertionOrder": false, "items": { "type": "string" @@ -87,6 +102,7 @@ "uniqueItems": true }, "AcceleratorNames": { + "description": "Lists 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 ``radeon-pro-v520``.\n + For instance types with Xilinx VU9P FPGAs, specify ``vu9p``.\n \n Default: Any accelerator", "insertionOrder": false, "items": { "type": "string" @@ -95,9 +111,11 @@ "uniqueItems": true }, "AcceleratorTotalMemoryMiB": { - "$ref": "#/definitions/AcceleratorTotalMemoryMiBRequest" + "$ref": "#/definitions/AcceleratorTotalMemoryMiBRequest", + "description": "The minimum and maximum total memory size for the accelerators on an instance type, in MiB.\n Default: No minimum or maximum limits" }, "AcceleratorTypes": { + "description": "Lists 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 ``inference``.\n \n Default: Any accelerator type", "insertionOrder": false, "items": { "type": "string" @@ -106,6 +124,7 @@ "uniqueItems": true }, "AllowedInstanceTypes": { + "description": "The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes.\n You can use strings with one or more wild cards, represented by an asterisk (``*``), to allow an instance type, size, or generation. The following are examples: ``m5.8xlarge``, ``c5*.*``, ``m5a.*``, ``r*``, ``*3*``.\n For example, if you specify ``c5*``, Amazon EC2 Auto Scaling will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify ``m5a.*``, Amazon EC2 Auto Scaling will allow all the M5a instance types, but not the M5n instance types.\n If you specify ``AllowedInstanceTypes``, you can't specify ``ExcludedInstanceTypes``.\n Default: All instance types", "insertionOrder": true, "items": { "type": "string" @@ -114,15 +133,19 @@ "uniqueItems": true }, "BareMetal": { + "description": "Indicates whether bare metal instance types are included, excluded, or required.\n Default: ``excluded``", "type": "string" }, "BaselineEbsBandwidthMbps": { - "$ref": "#/definitions/BaselineEbsBandwidthMbpsRequest" + "$ref": "#/definitions/BaselineEbsBandwidthMbpsRequest", + "description": "The minimum and maximum baseline bandwidth performance for an instance type, in Mbps. For more information, see [Amazon EBS–optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the *Amazon EC2 User Guide for Linux Instances*.\n Default: No minimum or maximum limits" }, "BurstablePerformance": { + "description": "Indicates whether burstable performance instance types are included, excluded, or required. For more information, see [Burstable performance instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) in the *Amazon EC2 User Guide for Linux Instances*.\n Default: ``excluded``", "type": "string" }, "CpuManufacturers": { + "description": "Lists 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 ``amazon-web-services``.\n \n Don't confuse the CPU hardware manufacturer with the CPU hardware architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template. \n Default: Any manufacturer", "insertionOrder": false, "items": { "type": "string" @@ -131,6 +154,7 @@ "uniqueItems": true }, "ExcludedInstanceTypes": { + "description": "The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk (``*``), to exclude an instance family, type, size, or generation. The following are examples: ``m5.8xlarge``, ``c5*.*``, ``m5a.*``, ``r*``, ``*3*``. \n For example, if you specify ``c5*``, you are excluding the entire C5 instance family, which includes all C5a and C5n instance types. If you specify ``m5a.*``, Amazon EC2 Auto Scaling will exclude all the M5a instance types, but not the M5n instance types.\n If you specify ``ExcludedInstanceTypes``, you can't specify ``AllowedInstanceTypes``.\n Default: No excluded instance types", "insertionOrder": true, "items": { "type": "string" @@ -139,6 +163,7 @@ "uniqueItems": true }, "InstanceGenerations": { + "description": "Indicates whether current or previous generation instance types are included.\n + For current generation instance types, specify ``current``. The current generation includes EC2 instance types currently recommended for use. This typically includes the latest two to three generations in each instance family. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide for Linux Instances*.\n + For previous generation instance types, specify ``previous``.\n \n Default: Any current or previous generation", "insertionOrder": false, "items": { "type": "string" @@ -147,9 +172,11 @@ "uniqueItems": true }, "LocalStorage": { + "description": "Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, see [Amazon EC2 instance store](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html) in the *Amazon EC2 User Guide for Linux Instances*.\n Default: ``included``", "type": "string" }, "LocalStorageTypes": { + "description": "Indicates the 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 ``ssd``.\n \n Default: Any local storage type", "insertionOrder": false, "items": { "type": "string" @@ -157,32 +184,45 @@ "type": "array", "uniqueItems": true }, + "MaxSpotPriceAsPercentageOfOptimalOnDemandPrice": { + "description": "[Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold.\n The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.\n If you set ``DesiredCapacityType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is based on the per-vCPU or per-memory price instead of the per instance price. \n Only one of ``SpotMaxPricePercentageOverLowestPrice`` or ``MaxSpotPriceAsPercentageOfOptimalOnDemandPrice`` can be specified. If you don't specify either, Amazon EC2 Auto Scaling will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as ``999999``.", + "type": "integer" + }, "MemoryGiBPerVCpu": { - "$ref": "#/definitions/MemoryGiBPerVCpuRequest" + "$ref": "#/definitions/MemoryGiBPerVCpuRequest", + "description": "The minimum and maximum amount of memory per vCPU for an instance type, in GiB.\n Default: No minimum or maximum limits" }, "MemoryMiB": { - "$ref": "#/definitions/MemoryMiBRequest" + "$ref": "#/definitions/MemoryMiBRequest", + "description": "The minimum and maximum instance memory size for an instance type, in MiB." }, "NetworkBandwidthGbps": { - "$ref": "#/definitions/NetworkBandwidthGbpsRequest" + "$ref": "#/definitions/NetworkBandwidthGbpsRequest", + "description": "The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).\n Default: No minimum or maximum limits" }, "NetworkInterfaceCount": { - "$ref": "#/definitions/NetworkInterfaceCountRequest" + "$ref": "#/definitions/NetworkInterfaceCountRequest", + "description": "The minimum and maximum number of network interfaces for an instance type.\n Default: No minimum or maximum limits" }, "OnDemandMaxPricePercentageOverLowestPrice": { + "description": "[Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold. \n The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.\n To turn off price protection, specify a high value, such as ``999999``. \n If you set ``DesiredCapacityType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per instance price. \n Default: ``20``", "type": "integer" }, "RequireHibernateSupport": { + "description": "Indicates whether instance types must provide On-Demand Instance hibernation support.\n Default: ``false``", "type": "boolean" }, "SpotMaxPricePercentageOverLowestPrice": { + "description": "[Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold.\n The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage. \n If you set ``DesiredCapacityType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is based on the per-vCPU or per-memory price instead of the per instance price. \n Only one of ``SpotMaxPricePercentageOverLowestPrice`` or ``MaxSpotPriceAsPercentageOfOptimalOnDemandPrice`` can be specified. If you don't specify either, Amazon EC2 Auto Scaling will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as ``999999``.", "type": "integer" }, "TotalLocalStorageGB": { - "$ref": "#/definitions/TotalLocalStorageGBRequest" + "$ref": "#/definitions/TotalLocalStorageGBRequest", + "description": "The minimum and maximum total local storage size for an instance type, in GB.\n Default: No minimum or maximum limits" }, "VCpuCount": { - "$ref": "#/definitions/VCpuCountRequest" + "$ref": "#/definitions/VCpuCountRequest", + "description": "The minimum and maximum number of vCPUs for an instance type." } }, "required": [ @@ -193,23 +233,30 @@ }, "InstancesDistribution": { "additionalProperties": false, + "description": "Use this structure to specify the distribution of On-Demand Instances and Spot Instances and the allocation strategies used to fulfill On-Demand and Spot capacities for a mixed instances policy.\n For more information, see [Auto Scaling groups 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 Auto 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.", "properties": { "OnDemandAllocationStrategy": { + "description": "The allocation strategy to apply to your On-Demand Instances when they are launched. Possible instance types are determined by the launch template overrides that you specify.\n The following lists the valid values:\n + lowest-price Uses price to determine which instance types are the highest priority, launching the lowest priced instance types within an Availability Zone first. This is the default value for Auto Scaling groups that specify InstanceRequirements. + prioritized You set the order of instance types for the launch template overrides from highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling launches your highest priority instance types first. If all your On-Demand capacity cannot be fulfilled using your highest priority instance type, then Amazon EC2 Auto Scaling launches the remaining capacity using the second priority instance type, and so on. This is the default value for Auto Scaling groups that don't specify InstanceRequirements and cannot be used for groups that do.", "type": "string" }, "OnDemandBaseCapacity": { + "description": "The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand Instances. This base portion is launched first as your group scales.\n This number has the same unit of measurement as the group's desired capacity. If you change the default unit of measurement (number of instances) by specifying weighted capacity values in your launch template overrides list, or by changing the default desired capacity type setting of the group, you must specify this number using the same unit of measurement.\n Default: 0\n An update to this setting means a gradual replacement of instances to adjust the current On-Demand Instance levels. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the previous ones.", "type": "integer" }, "OnDemandPercentageAboveBaseCapacity": { + "description": "Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond ``OnDemandBaseCapacity``. Expressed as a number (for example, 20 specifies 20% On-Demand Instances, 80% Spot Instances). If set to 100, only On-Demand Instances are used.\n Default: 100\n An update to this setting means a gradual replacement of instances to adjust the current On-Demand and Spot Instance levels for your additional capacity higher than the base capacity. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the previous ones.", "type": "integer" }, "SpotAllocationStrategy": { + "description": "The allocation strategy to apply to your Spot Instances when they are launched. Possible instance types are determined by the launch template overrides that you specify.\n The following lists the valid values:\n + capacity-optimized Requests Spot Instances using pools that are optimally chosen based on the available Spot capacity. This strategy has the lowest risk of interruption. To give certain instance types a higher chance of launching first, use capacity-optimized-prioritized. + capacity-optimized-prioritized You set the order of instance types for the launch template overrides from highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling honors the instance type priorities on a best effort basis but optimizes for capacity first. Note that if the On-Demand allocation strategy is set to prioritized, the same priority is applied when fulfilling On-Demand capacity. This is not a valid value for Auto Scaling groups that specify InstanceRequirements. + lowest-price Requests Spot Instances using the lowest priced pools within an Availability Zone, across the number of Spot pools that you specify for the SpotInstancePools property. To ensure that your desired capacity is met, you might receive Spot Instances from several pools. This is the default value, but it might lead to high interruption rates because this strategy only considers instance price and not available capacity. + price-capacity-optimized (recommended) The price and capacity optimized allocation strategy looks at both price and capacity to select the Spot Instance pools that are the least likely to be interrupted and have the lowest possible price.", "type": "string" }, "SpotInstancePools": { + "description": "The number of Spot Instance pools across which to allocate your Spot Instances. The Spot pools are determined from the different instance types in the overrides. Valid only when the ``SpotAllocationStrategy`` is ``lowest-price``. Value must be in the range of 1–20.\n Default: 2", "type": "integer" }, "SpotMaxPrice": { + "description": "The maximum price per unit hour that you are willing to pay for a Spot Instance. If your maximum price is lower than the Spot price for the instance types that you selected, your Spot Instances are not launched. We do not recommend specifying a maximum price because it can lead to increased interruptions. When Spot Instances launch, you pay the current Spot price. To remove a maximum price that you previously set, include the property but specify an empty string (\"\") for the value.\n If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify one.\n Valid Range: Minimum value of 0.001", "type": "string" } }, @@ -217,11 +264,14 @@ }, "LaunchTemplate": { "additionalProperties": false, + "description": "Use this structure to specify the launch templates and instance types (overrides) for a mixed 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.", "properties": { "LaunchTemplateSpecification": { - "$ref": "#/definitions/LaunchTemplateSpecification" + "$ref": "#/definitions/LaunchTemplateSpecification", + "description": "The launch template." }, "Overrides": { + "description": "Any properties that you specify override the same properties in the launch template.", "insertionOrder": true, "items": { "$ref": "#/definitions/LaunchTemplateOverrides" @@ -237,17 +287,22 @@ }, "LaunchTemplateOverrides": { "additionalProperties": false, + "description": "Use this structure to let Amazon EC2 Auto Scaling do the following when the Auto Scaling group has a mixed instances policy:\n + Override the instance type that is specified in the launch template.\n + Use multiple instance types.\n \n Specify the instance types that you want, or define your instance requirements instead and let Amazon EC2 Auto Scaling provision the available instance types that meet your requirements. This can provide Amazon EC2 Auto Scaling with a larger selection of instance types to choose from when fulfilling Spot and On-Demand capacities. You can view which instance types are matched before you apply the instance requirements to your Auto Scaling group.\n After you define your instance requirements, you don't have to keep updating these settings to get new EC2 instance types automatically. Amazon EC2 Auto Scaling uses the instance requirements of the Auto Scaling group to determine whether a new EC2 instance type can 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.", "properties": { "InstanceRequirements": { - "$ref": "#/definitions/InstanceRequirements" + "$ref": "#/definitions/InstanceRequirements", + "description": "The instance requirements. Amazon EC2 Auto Scaling uses your specified requirements to identify instance types. Then, it uses your On-Demand and Spot allocation strategies to launch instances from these instance types.\n You can specify up to four separate sets of instance requirements per Auto Scaling group. This is useful for provisioning instances from different Amazon Machine Images (AMIs) in the same Auto Scaling group. To do this, create the AMIs and create a new launch template for each AMI. Then, create a compatible set of instance requirements for each launch template. \n If you specify ``InstanceRequirements``, you can't specify ``InstanceType``." }, "InstanceType": { + "description": "The instance type, such as ``m3.xlarge``. You must specify an instance type that is supported in your requested Region and Availability Zones. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide for Linux Instances*.\n You can specify up to 40 instance types per Auto Scaling group.", "type": "string" }, "LaunchTemplateSpecification": { - "$ref": "#/definitions/LaunchTemplateSpecification" + "$ref": "#/definitions/LaunchTemplateSpecification", + "description": "Provides a launch template for the specified instance type or set of instance requirements. For example, some instance types might require a launch template with a different AMI. If not provided, Amazon EC2 Auto Scaling uses the launch template that's specified in the ``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 *Amazon EC2 Auto Scaling User Guide*. \n You can specify up to 20 launch templates per Auto Scaling group. The launch templates specified in the overrides and in the ``LaunchTemplate`` definition count towards this limit." }, "WeightedCapacity": { + "description": "If you provide a list of instance types to use, you can specify the number of capacity units provided by each instance type in terms of virtual CPUs, memory, storage, throughput, or other relative performance characteristic. When a Spot or On-Demand Instance is launched, the capacity units count toward the desired capacity. Amazon EC2 Auto Scaling launches instances until the desired capacity is totally fulfilled, even if this results in an overage. For example, if there are two units remaining to fulfill capacity, and Amazon EC2 Auto Scaling can only launch an instance with a ``WeightedCapacity`` of five units, the instance is launched, and the desired capacity is exceeded by three units. For more information, see [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 EC2 Auto Scaling User Guide*. Value must be in the range of 1-999. \n If you specify a value for ``WeightedCapacity`` for one instance type, you must specify a value for ``WeightedCapacity`` for all of them.\n Every Auto Scaling group has three size parameters (``DesiredCapacity``, ``MaxSize``, and ``MinSize``). Usually, you set these sizes based on a specific number of instances. However, if you configure a mixed instances policy that defines weights for the instance types, you must specify these sizes with the same units that you use for weighting instances.", "type": "string" } }, @@ -255,14 +310,18 @@ }, "LaunchTemplateSpecification": { "additionalProperties": false, + "description": "Specifies a launch template to use when provisioning EC2 instances for an Auto Scaling group.\n You 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 \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.\n For 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 Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html) in the *Amazon EC2 Auto Scaling User Guide*.\n For examples of launch templates, see [Create launch templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-ec2-launch-templates.html).", "properties": { "LaunchTemplateId": { + "description": "The ID of the launch template.\n You must specify the ``LaunchTemplateID`` or the ``LaunchTemplateName``, but not both.", "type": "string" }, "LaunchTemplateName": { + "description": "The name of the launch template.\n You must specify the ``LaunchTemplateName`` or the ``LaunchTemplateID``, but not both.", "type": "string" }, "Version": { + "description": "The version number of the launch template.\n Specifying ``$Latest`` or ``$Default`` for the template version number is not supported. However, you can specify ``LatestVersionNumber`` or ``DefaultVersionNumber`` using the ``Fn::GetAtt`` intrinsic function. For more information, see [Fn::GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html).\n For 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`` resource.", "type": "string" } }, @@ -273,26 +332,34 @@ }, "LifecycleHookSpecification": { "additionalProperties": false, + "description": "``LifecycleHookSpecification`` specifies a lifecycle hook for the ``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 perform when Amazon EC2 Auto Scaling launches or terminates instances. \n For more information, see [Amazon EC2 Auto Scaling lifecycle hooks](https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html) in the *Amazon EC2 Auto Scaling User Guide*. You can find a sample 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`` resource.", "properties": { "DefaultResult": { + "description": "The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. The default value is ``ABANDON``.\n Valid values: ``CONTINUE`` | ``ABANDON``", "type": "string" }, "HeartbeatTimeout": { + "description": "The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from ``30`` to ``7200`` seconds. The default value is ``3600`` seconds (1 hour).", "type": "integer" }, "LifecycleHookName": { + "description": "The name of the lifecycle hook.", "type": "string" }, "LifecycleTransition": { + "description": "The lifecycle transition. For Auto Scaling groups, there are two major lifecycle transitions.\n + To create a lifecycle hook for scale-out events, specify ``autoscaling:EC2_INSTANCE_LAUNCHING``.\n + To create a lifecycle hook for scale-in events, specify ``autoscaling:EC2_INSTANCE_TERMINATING``.", "type": "string" }, "NotificationMetadata": { + "description": "Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.", "type": "string" }, "NotificationTargetARN": { + "description": "The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling sends notifications to when an instance is in a wait state for the lifecycle hook. You can specify an Amazon SNS topic or an Amazon SQS queue.", "type": "string" }, "RoleARN": { + "description": "The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target. For information about creating this role, see [Prepare to add a lifecycle hook to your Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/prepare-for-lifecycle-notifications.html) in the *Amazon EC2 Auto Scaling User Guide*.\n Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue.", "type": "string" } }, @@ -304,11 +371,14 @@ }, "MemoryGiBPerVCpuRequest": { "additionalProperties": false, + "description": "``MemoryGiBPerVCpuRequest`` is a property of the ``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 describes the minimum and maximum amount of memory per vCPU for an instance type, in GiB.", "properties": { "Max": { + "description": "The memory maximum in GiB.", "type": "number" }, "Min": { + "description": "The memory minimum in GiB.", "type": "number" } }, @@ -316,11 +386,14 @@ }, "MemoryMiBRequest": { "additionalProperties": false, + "description": "``MemoryMiBRequest`` is a property of the ``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 describes the minimum and maximum instance memory size for an instance type, in MiB.", "properties": { "Max": { + "description": "The memory maximum in MiB.", "type": "integer" }, "Min": { + "description": "The memory minimum in MiB.", "type": "integer" } }, @@ -328,11 +401,14 @@ }, "MetricsCollection": { "additionalProperties": false, + "description": "``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 an Amazon EC2 Auto Scaling group sends to Amazon CloudWatch. These metrics describe the group rather than any of its instances. \n For more information, see [Monitor CloudWatch metrics for your Auto Scaling groups and instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-monitoring.html) in the *Amazon EC2 Auto Scaling User Guide*. 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`` resource.", "properties": { "Granularity": { + "description": "The frequency at which Amazon EC2 Auto Scaling sends aggregated data to CloudWatch. The only valid value is ``1Minute``.", "type": "string" }, "Metrics": { + "description": "Identifies the metrics to enable.\n You 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`` \n \n If you specify ``Granularity`` and don't specify any metrics, all metrics are enabled.\n For more information, see [Amazon CloudWatch metrics for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-metrics.html) in the *Amazon EC2 Auto Scaling User Guide*.", "insertionOrder": false, "items": { "type": "string" @@ -348,12 +424,15 @@ }, "MixedInstancesPolicy": { "additionalProperties": false, + "description": "Use this structure to launch multiple instance types and On-Demand Instances and Spot Instances within a single Auto Scaling group.\n A mixed instances policy contains information that Amazon EC2 Auto Scaling can use to launch instances and help optimize your costs. For more information, see [Auto Scaling groups 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 Auto Scaling User Guide*.\n You can create a mixed instances policy for new and existing Auto Scaling groups. You must use a launch template to configure the policy. You cannot use a launch configuration.\n There 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 for, Spot Instances changes\n \n When a Spot Instance is terminated, Amazon EC2 Auto Scaling group attempts to launch a replacement 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.", "properties": { "InstancesDistribution": { - "$ref": "#/definitions/InstancesDistribution" + "$ref": "#/definitions/InstancesDistribution", + "description": "The instances distribution." }, "LaunchTemplate": { - "$ref": "#/definitions/LaunchTemplate" + "$ref": "#/definitions/LaunchTemplate", + "description": "One or more launch templates and the instance types (overrides) that are used to launch EC2 instances to fulfill On-Demand and Spot capacities." } }, "required": [ @@ -363,11 +442,14 @@ }, "NetworkBandwidthGbpsRequest": { "additionalProperties": false, + "description": "``NetworkBandwidthGbpsRequest`` is a property of the ``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 describes the minimum and maximum network bandwidth for an instance type, in Gbps.\n Setting the minimum bandwidth does not guarantee that your instance will achieve the minimum bandwidth. Amazon EC2 will identify instance types that support the specified minimum bandwidth, but the actual bandwidth of your instance might go below the specified minimum 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 Instances*.", "properties": { "Max": { + "description": "The maximum amount of network bandwidth, in gigabits per second (Gbps).", "type": "number" }, "Min": { + "description": "The minimum amount of network bandwidth, in gigabits per second (Gbps).", "type": "number" } }, @@ -375,11 +457,14 @@ }, "NetworkInterfaceCountRequest": { "additionalProperties": false, + "description": "``NetworkInterfaceCountRequest`` is a property of the ``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 describes the minimum and maximum number of network interfaces for an instance type.", "properties": { "Max": { + "description": "The maximum number of network interfaces.", "type": "integer" }, "Min": { + "description": "The minimum number of network interfaces.", "type": "integer" } }, @@ -387,8 +472,10 @@ }, "NotificationConfiguration": { "additionalProperties": false, + "description": "A structure that specifies an Amazon SNS notification configuration for the ``NotificationConfigurations`` property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource.\n For an example template snippet, see [Configure Amazon EC2 Auto Scaling resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-ec2-auto-scaling.html).\n For more information, see [Get Amazon SNS notifications when your Auto Scaling group scales](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ASGettingNotifications.html) in the *Amazon EC2 Auto Scaling User Guide*.", "properties": { "NotificationTypes": { + "description": "A list of event types that send a notification. Event types can include any of the following 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``", "insertionOrder": false, "items": { "type": "string" @@ -397,6 +484,7 @@ "uniqueItems": false }, "TopicARN": { + "description": "The Amazon Resource Name (ARN) of the Amazon SNS topic.", "items": { "type": "string" }, @@ -413,14 +501,18 @@ }, "TagProperty": { "additionalProperties": false, + "description": "A 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.\n For more information, see [Tag Auto Scaling groups and instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-tagging.html) in the *Amazon EC2 Auto Scaling User Guide*. 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`` resource.\n CloudFormation adds the following tags to all Auto Scaling groups and associated instances: \n + aws:cloudformation:stack-name\n + aws:cloudformation:stack-id\n + aws:cloudformation:logical-id", "properties": { "Key": { + "description": "The tag key.", "type": "string" }, "PropagateAtLaunch": { + "description": "Set to ``true`` if you want CloudFormation to copy the tag to EC2 instances that are launched as part of the Auto Scaling group. Set to ``false`` if you want the tag attached only to the Auto Scaling group and not copied to any instances launched as part of the Auto Scaling group.", "type": "boolean" }, "Value": { + "description": "The tag value.", "type": "string" } }, @@ -433,11 +525,14 @@ }, "TotalLocalStorageGBRequest": { "additionalProperties": false, + "description": "``TotalLocalStorageGBRequest`` is a property of the ``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 describes the minimum and maximum total local storage size for an instance type, in GB.", "properties": { "Max": { + "description": "The storage maximum in GB.", "type": "number" }, "Min": { + "description": "The storage minimum in GB.", "type": "number" } }, @@ -445,11 +540,14 @@ }, "VCpuCountRequest": { "additionalProperties": false, + "description": "``VCpuCountRequest`` is a property of the ``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 describes the minimum and maximum number of vCPUs for an instance type.", "properties": { "Max": { + "description": "The maximum number of vCPUs.", "type": "integer" }, "Min": { + "description": "The minimum number of vCPUs.", "type": "integer" } }, @@ -459,62 +557,83 @@ "deprecatedProperties": [ "/properties/NotificationConfiguration" ], - "description": "Resource Type definition for AWS::AutoScaling::AutoScalingGroup", + "description": "The ``AWS::AutoScaling::AutoScalingGroup`` resource defines an Amazon EC2 Auto Scaling group, which is a collection of Amazon EC2 instances that are treated as a logical grouping for the purposes of automatic scaling and management. \n For more information about Amazon EC2 Auto Scaling, see the [Amazon EC2 Auto Scaling User Guide](https://docs.aws.amazon.com/autoscaling/ec2/userguide/what-is-amazon-ec2-auto-scaling.html). \n Amazon EC2 Auto Scaling configures instances launched as part of an Auto Scaling group using either a [launch template](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 launch configurations. For more information, see [Launch configurations](https://docs.aws.amazon.com/autoscaling/ec2/userguide/launch-configurations.html) in the *Amazon EC2 Auto Scaling User Guide*.\n For help migrating from launch configurations to launch templates, see [Migrate CloudFormation stacks from launch configurations to launch templates](https://docs.aws.amazon.com/autoscaling/ec2/userguide/migrate-launch-configurations-with-cloudformation.html) in the *Amazon EC2 Auto Scaling User Guide*.", "handlers": { "create": { "permissions": [ - "autoscaling:*", + "autoscaling:CreateAutoScalingGroup", + "autoscaling:UpdateAutoScalingGroup", + "autoscaling:CreateOrUpdateTags", + "autoscaling:Describe*", + "autoscaling:EnableMetricsCollection", + "autoscaling:PutNotificationConfiguration", "cloudwatch:PutMetricAlarm", "ec2:Describe*", - "ec2:GetInstanceTypesFromInstanceRequirements", + "ec2:Get*", "ec2:RunInstances", - "elasticloadbalancing:DescribeLoadBalancers", - "elasticloadbalancing:DescribeTargetGroups", + "elasticloadbalancing:Describe*", "iam:CreateServiceLinkedRole", "iam:PassRole", - "managed-fleets:GetAutoScalingGroup", + "managed-fleets:Get*", "managed-fleets:CreateAutoScalingGroup", - "ssm:GetParameters" + "managed-fleets:UpdateAutoScalingGroup", + "ssm:Get*" ], - "timeoutInMinutes": 120 + "timeoutInMinutes": 360 }, "delete": { "permissions": [ - "autoscaling:*", - "managed-fleets:GetAutoScalingGroup", + "autoscaling:DeleteAutoScalingGroup", + "autoscaling:UpdateAutoScalingGroup", + "autoscaling:Describe*", + "managed-fleets:Get*", "managed-fleets:DeleteAutoScalingGroup" ], - "timeoutInMinutes": 180 + "timeoutInMinutes": 240 }, "list": { "permissions": [ - "autoscaling:*" + "autoscaling:Describe*" ] }, "read": { "permissions": [ - "autoscaling:*", - "managed-fleets:GetAutoScalingGroup" + "autoscaling:Describe*", + "managed-fleets:Get*" ] }, "update": { "permissions": [ - "autoscaling:*", + "autoscaling:UpdateAutoScalingGroup", + "autoscaling:CreateOrUpdateTags", + "autoscaling:DeleteTags", + "autoscaling:Describe*", + "autoscaling:EnableMetricsCollection", + "autoscaling:DisableMetricsCollection", + "autoscaling:PutNotificationConfiguration", + "autoscaling:DeleteNotificationConfiguration", + "autoscaling:DetachLoadBalancerTargetGroups", + "autoscaling:AttachLoadBalancerTargetGroups", + "autoscaling:AttachLoadBalancers", + "autoscaling:DetachLoadBalancers", + "autoscaling:AttachTrafficSources", + "autoscaling:DetachTrafficSources", + "autoscaling:DeleteLifecycleHook", + "autoscaling:PutLifecycleHook", "cloudwatch:PutMetricAlarm", "ec2:Describe*", - "ec2:GetInstanceTypesFromInstanceRequirements", + "ec2:Get*", "ec2:RunInstances", - "elasticloadbalancing:DescribeLoadBalancers", - "elasticloadbalancing:DescribeTargetGroups", + "elasticloadbalancing:Describe*", "iam:CreateServiceLinkedRole", "iam:PassRole", - "managed-fleets:GetAutoScalingGroup", + "managed-fleets:Get*", "managed-fleets:RegisterAutoScalingGroup", "managed-fleets:DeregisterAutoScalingGroup", "managed-fleets:UpdateAutoScalingGroup", - "ssm:GetParameters" + "ssm:Get*" ], - "timeoutInMinutes": 480 + "timeoutInMinutes": 660 } }, "primaryIdentifier": [ @@ -522,9 +641,11 @@ ], "properties": { "AutoScalingGroupName": { + "description": "The name of the Auto Scaling group. This name must be unique per Region per account.\n The name can contain any ASCII character 33 to 126 including most punctuation characters, digits, and upper and lowercased letters.\n You cannot use a colon (:) in the name.", "type": "string" }, "AvailabilityZones": { + "description": "A list of Availability Zones where instances in the Auto Scaling group can be created. Used for launching into the default VPC subnet in each Availability Zone when not using the ``VPCZoneIdentifier`` property, or for attaching a network interface when an existing network interface ID is specified in a launch template.", "insertionOrder": false, "items": { "type": "string" @@ -533,43 +654,56 @@ "uniqueItems": false }, "CapacityRebalance": { + "description": "Indicates whether Capacity Rebalancing is enabled. Otherwise, Capacity Rebalancing is disabled. When you turn on Capacity Rebalancing, Amazon EC2 Auto Scaling attempts to launch a Spot Instance whenever Amazon EC2 notifies that a Spot Instance is at an elevated risk of interruption. After launching a new instance, it then terminates an old instance. For more information, see [Use Capacity Rebalancing 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*.", "type": "boolean" }, "Context": { + "description": "Reserved.", "type": "string" }, "Cooldown": { + "description": "*Only needed if you use simple scaling policies.* \n The amount of time, in seconds, between one scaling activity ending and another one starting due to simple scaling policies. For more information, see [Scaling cooldowns 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*.\n Default: ``300`` seconds", "type": "string" }, "DefaultInstanceWarmup": { + "description": "The amount of time, in seconds, until a new instance is considered to have finished initializing and resource consumption to become stable after it enters the ``InService`` state. \n During an instance refresh, Amazon EC2 Auto Scaling waits for the warm-up period after it replaces an instance before it moves on to replacing the next instance. Amazon EC2 Auto Scaling also waits for the warm-up period before aggregating the metrics for new instances with existing instances in the Amazon CloudWatch metrics that are used for scaling, resulting in more reliable usage data. For more information, see [Set the 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 *Amazon EC2 Auto Scaling User Guide*.\n To manage various warm-up settings at the group level, we recommend that you set the default instance warmup, *even if it is set to 0 seconds*. To remove a value that you previously set, include the property but specify ``-1`` for the value. However, we strongly recommend keeping the default instance warmup enabled by specifying a value of ``0`` or other nominal value.\n Default: None", "type": "integer" }, "DesiredCapacity": { + "description": "The desired capacity is the initial capacity of the Auto Scaling group at the time of its creation and the capacity it attempts to maintain. It can scale beyond this capacity if you configure automatic scaling.\n The number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group. If you do not specify a desired capacity when creating the stack, the default is the minimum size of the group.\n CloudFormation marks the Auto Scaling group as successful (by setting its status to CREATE_COMPLETE) when the desired capacity is reached. However, if a maximum Spot price is set in the launch template or launch configuration that you specified, then desired capacity is not used as a criteria for success. Whether your request is fulfilled depends on Spot Instance capacity and your maximum price.", "pattern": "^[0-9]+$", "type": "string" }, "DesiredCapacityType": { + "description": "The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports ``DesiredCapacityType`` for attribute-based instance type selection only. For more information, see [Create a mixed instances group using attribute-based instance type selection](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*.\n By default, Amazon EC2 Auto Scaling specifies ``units``, which translates into number of instances.\n Valid values: ``units`` | ``vcpu`` | ``memory-mib``", "type": "string" }, "HealthCheckGracePeriod": { + "description": "The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service and marking it unhealthy due to a failed health check. This is useful if your instances do not immediately pass their health checks after they enter the ``InService`` state. For more information, see [Set the health check grace period for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/health-check-grace-period.html) in the *Amazon EC2 Auto Scaling User Guide*.\n Default: ``0`` seconds", "type": "integer" }, "HealthCheckType": { + "description": "A comma-separated value string of one or more health check types.\n The valid values are ``EC2``, ``ELB``, and ``VPC_LATTICE``. ``EC2`` is the default health check and cannot be disabled. For more information, see [Health checks for instances in an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-health-checks.html) in the *Amazon EC2 Auto Scaling User Guide*.\n Only specify ``EC2`` if you must clear a value that was previously set.", "type": "string" }, "InstanceId": { + "description": "The ID of the instance used to base the launch configuration on. For more information, see [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 Scaling User Guide*.\n If you specify ``LaunchTemplate``, ``MixedInstancesPolicy``, or ``LaunchConfigurationName``, don't specify ``InstanceId``.", "type": "string" }, "InstanceMaintenancePolicy": { - "$ref": "#/definitions/InstanceMaintenancePolicy" + "$ref": "#/definitions/InstanceMaintenancePolicy", + "description": "An 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 *Amazon EC2 Auto Scaling User Guide*." }, "LaunchConfigurationName": { + "description": "The name of the launch configuration to use to launch instances.\n Required only if you don't specify ``LaunchTemplate``, ``MixedInstancesPolicy``, or ``InstanceId``.", "type": "string" }, "LaunchTemplate": { - "$ref": "#/definitions/LaunchTemplateSpecification" + "$ref": "#/definitions/LaunchTemplateSpecification", + "description": "Information used to specify the launch template and version to use to launch instances. You can alternatively associate a launch template to the Auto Scaling group by specifying a ``MixedInstancesPolicy``. For more information about creating launch templates, see [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 Scaling User Guide*.\n If you omit this property, you must specify ``MixedInstancesPolicy``, ``LaunchConfigurationName``, or ``InstanceId``." }, "LifecycleHookSpecificationList": { + "description": "One or more lifecycle hooks to add to the Auto Scaling group before instances are launched.", "insertionOrder": true, "items": { "$ref": "#/definitions/LifecycleHookSpecification" @@ -578,6 +712,7 @@ "uniqueItems": false }, "LoadBalancerNames": { + "description": "A list of Classic Load Balancers associated with this Auto Scaling group. For Application Load Balancers, Network Load Balancers, and Gateway Load Balancers, specify the ``TargetGroupARNs`` property instead.", "insertionOrder": true, "items": { "type": "string" @@ -586,13 +721,16 @@ "uniqueItems": false }, "MaxInstanceLifetime": { + "description": "The maximum amount of time, in seconds, that an instance can be in service. The default is null. If specified, the value must be either 0 or a number equal to or greater 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 *Amazon EC2 Auto Scaling User Guide*.", "type": "integer" }, "MaxSize": { + "description": "The maximum size of the group.\n With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to go above ``MaxSize`` to meet your capacity requirements. In this event, Amazon EC2 Auto Scaling will never go above ``MaxSize`` by more than your largest instance weight (weights that define how many units each instance contributes to the desired capacity of the group).", "pattern": "^[0-9]+$", "type": "string" }, "MetricsCollection": { + "description": "Enables the monitoring of group metrics of an Auto Scaling group. By default, these metrics are disabled.", "insertionOrder": true, "items": { "$ref": "#/definitions/MetricsCollection" @@ -601,19 +739,24 @@ "uniqueItems": false }, "MinSize": { + "description": "The minimum size of the group.", "pattern": "^[0-9]+$", "type": "string" }, "MixedInstancesPolicy": { - "$ref": "#/definitions/MixedInstancesPolicy" + "$ref": "#/definitions/MixedInstancesPolicy", + "description": "An embedded object that specifies a mixed instances policy.\n The policy includes properties that not only define the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances (optional), and how the Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacities, but also the properties that specify the instance configuration information—the launch template and instance types. The policy can also include a weight for each instance type and different launch templates for individual instance types.\n For more information, see [Auto Scaling groups 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 Auto Scaling User Guide*." }, "NewInstancesProtectedFromScaleIn": { + "description": "Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. For more information about preventing instances from terminating on scale in, see [Use instance scale-in protection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-protection.html) in the *Amazon EC2 Auto Scaling User Guide*.", "type": "boolean" }, "NotificationConfiguration": { - "$ref": "#/definitions/NotificationConfiguration" + "$ref": "#/definitions/NotificationConfiguration", + "description": "" }, "NotificationConfigurations": { + "description": "Configures an Auto Scaling group to send notifications when specified events take place.", "insertionOrder": true, "items": { "$ref": "#/definitions/NotificationConfiguration" @@ -622,12 +765,15 @@ "uniqueItems": false }, "PlacementGroup": { + "description": "The name of the placement group into which to launch your instances. For more information, see [Placement groups](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) in the *Amazon EC2 User Guide for Linux Instances*.\n A *cluster* placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a cluster placement group.", "type": "string" }, "ServiceLinkedRoleARN": { + "description": "The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS service on your behalf. By default, Amazon EC2 Auto Scaling uses a service-linked role named ``AWSServiceRoleForAutoScaling``, which it creates if it does not exist. For more information, see [Service-linked roles](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-service-linked-role.html) in the *Amazon EC2 Auto Scaling User Guide*.", "type": "string" }, "Tags": { + "description": "One or more tags. You can tag your Auto Scaling group and propagate the tags to the Amazon EC2 instances it launches. Tags are not propagated to Amazon EBS volumes. To add tags to Amazon EBS volumes, specify the tags in a launch template but use caution. If the launch template specifies an instance tag with a key that is also specified for the Auto Scaling group, Amazon EC2 Auto Scaling overrides the value of that instance tag with the value specified by the Auto Scaling group. For more information, see [Tag Auto Scaling groups and instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-tagging.html) in the *Amazon EC2 Auto Scaling User Guide*.", "insertionOrder": false, "items": { "$ref": "#/definitions/TagProperty" @@ -635,7 +781,8 @@ "type": "array" }, "TargetGroupARNs": { - "insertionOrder": true, + "description": "The Amazon Resource Names (ARN) of the Elastic Load Balancing target groups to associate with the Auto Scaling group. Instances are registered as targets with the target groups. The target groups receive incoming traffic and route requests to one or more registered targets. For more information, see [Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html) in the *Amazon EC2 Auto Scaling User Guide*.", + "insertionOrder": false, "items": { "type": "string" }, @@ -643,6 +790,7 @@ "uniqueItems": false }, "TerminationPolicies": { + "description": "A policy or a list of policies that are used to select the instance to terminate. These policies are executed in the order that you list them. For more information, see [Configure termination policies for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-termination-policies.html) in the *Amazon EC2 Auto Scaling User Guide*.\n Valid values: ``Default`` | ``AllocationStrategy`` | ``ClosestToNextInstanceHour`` | ``NewestInstance`` | ``OldestInstance`` | ``OldestLaunchConfiguration`` | ``OldestLaunchTemplate`` | ``arn:aws:lambda:region:account-id:function:my-function:my-alias``", "insertionOrder": true, "items": { "type": "string" @@ -651,6 +799,7 @@ "uniqueItems": false }, "VPCZoneIdentifier": { + "description": "A list of subnet IDs for a virtual private cloud (VPC) where instances in the Auto Scaling group can be created.\n If this resource specifies public subnets and is also in a VPC that is defined in the same stack template, you must use the [DependsOn attribute](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 When you update ``VPCZoneIdentifier``, this retains the same Auto Scaling group and replaces old instances with new ones, according to the specified subnets. You can optionally specify how CloudFormation handles these updates by using an [UpdatePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html).\n Required to launch instances into a nondefault VPC. If you specify ``VPCZoneIdentifier`` with ``AvailabilityZones``, the subnets that you specify for this property must reside in those Availability Zones.", "insertionOrder": false, "items": { "type": "string" diff --git a/artifacts/types/AWS::AutoScaling::LifecycleHook.json b/artifacts/types/AWS::AutoScaling::LifecycleHook.json index ef82a8c2..fcca7e2a 100644 --- a/artifacts/types/AWS::AutoScaling::LifecycleHook.json +++ b/artifacts/types/AWS::AutoScaling::LifecycleHook.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-AutoScaling-LifecycleHook", "type": "AWS::AutoScaling::LifecycleHook", - "time": "2023-11-15T18:44:46.271Z", + "time": "2024-06-12T15:25:04.656Z", "schema": { "$schema": "https://raw.githubusercontent.com/aws-cloudformation/cloudformation-resource-schema/master/src/main/resources/schema/provider.definition.schema.v1.json", "additionalProperties": false, diff --git a/artifacts/types/AWS::AutoScaling::ScalingPolicy.json b/artifacts/types/AWS::AutoScaling::ScalingPolicy.json index 0221d26a..7bfd94bf 100644 --- a/artifacts/types/AWS::AutoScaling::ScalingPolicy.json +++ b/artifacts/types/AWS::AutoScaling::ScalingPolicy.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-AutoScaling-ScalingPolicy", "type": "AWS::AutoScaling::ScalingPolicy", - "time": "2023-11-15T20:02:38.088Z", + "time": "2024-06-12T15:26:46.499Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -22,6 +22,14 @@ "MetricName": { "type": "string" }, + "Metrics": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/TargetTrackingMetricDataQuery" + }, + "type": "array", + "uniqueItems": true + }, "Namespace": { "type": "string" }, @@ -32,11 +40,7 @@ "type": "string" } }, - "required": [ - "MetricName", - "Statistic", - "Namespace" - ], + "required": [], "type": "object" }, "Metric": { @@ -331,6 +335,49 @@ "TargetValue" ], "type": "object" + }, + "TargetTrackingMetricDataQuery": { + "additionalProperties": false, + "properties": { + "Expression": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "Label": { + "type": "string" + }, + "MetricStat": { + "$ref": "#/definitions/TargetTrackingMetricStat" + }, + "ReturnData": { + "type": "boolean" + } + }, + "required": [ + "Id" + ], + "type": "object" + }, + "TargetTrackingMetricStat": { + "additionalProperties": false, + "properties": { + "Metric": { + "$ref": "#/definitions/Metric" + }, + "Stat": { + "type": "string" + }, + "Unit": { + "type": "string" + } + }, + "required": [ + "Stat", + "Metric" + ], + "type": "object" } }, "description": "The AWS::AutoScaling::ScalingPolicy resource specifies an Amazon EC2 Auto Scaling scaling policy so that the Auto Scaling group can scale the number of instances available for your application.", diff --git a/artifacts/types/AWS::AutoScaling::ScheduledAction.json b/artifacts/types/AWS::AutoScaling::ScheduledAction.json index bfcf3eaa..7906af27 100644 --- a/artifacts/types/AWS::AutoScaling::ScheduledAction.json +++ b/artifacts/types/AWS::AutoScaling::ScheduledAction.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-AutoScaling-ScheduledAction", "type": "AWS::AutoScaling::ScheduledAction", - "time": "2023-11-15T18:57:42.14Z", + "time": "2024-06-12T15:33:13.084Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::AutoScaling::WarmPool.json b/artifacts/types/AWS::AutoScaling::WarmPool.json index 69adc734..ecfc6127 100644 --- a/artifacts/types/AWS::AutoScaling::WarmPool.json +++ b/artifacts/types/AWS::AutoScaling::WarmPool.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-AutoScaling-WarmPool", "type": "AWS::AutoScaling::WarmPool", - "time": "2023-12-20T16:52:53.343Z", + "time": "2024-06-10T15:52:42.642Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::B2BI::Capability.json b/artifacts/types/AWS::B2BI::Capability.json index 5882e60c..112147d9 100644 --- a/artifacts/types/AWS::B2BI::Capability.json +++ b/artifacts/types/AWS::B2BI::Capability.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-B2BI-Capability", "type": "AWS::B2BI::Capability", - "time": "2024-01-04T19:28:49.287Z", + "time": "2024-06-24T16:08:57.631Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -129,17 +129,39 @@ "X12_180", "X12_204", "X12_210", + "X12_211", "X12_214", "X12_215", + "X12_259", + "X12_260", + "X12_266", + "X12_269", + "X12_270", + "X12_271", + "X12_274", + "X12_275", + "X12_276", + "X12_277", + "X12_278", "X12_310", "X12_315", "X12_322", "X12_404", "X12_410", + "X12_417", + "X12_421", + "X12_426", + "X12_810", "X12_820", "X12_824", "X12_830", + "X12_832", + "X12_834", + "X12_835", + "X12_837", + "X12_844", "X12_846", + "X12_849", "X12_850", "X12_852", "X12_855", @@ -147,9 +169,37 @@ "X12_860", "X12_861", "X12_864", + "X12_865", + "X12_869", + "X12_870", "X12_940", + "X12_945", "X12_990", - "X12_997" + "X12_997", + "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" ], "type": "string" }, @@ -157,7 +207,8 @@ "enum": [ "VERSION_4010", "VERSION_4030", - "VERSION_5010" + "VERSION_5010", + "VERSION_5010_HIPAA" ], "type": "string" } diff --git a/artifacts/types/AWS::B2BI::Partnership.json b/artifacts/types/AWS::B2BI::Partnership.json index 78a236ec..d7d27853 100644 --- a/artifacts/types/AWS::B2BI::Partnership.json +++ b/artifacts/types/AWS::B2BI::Partnership.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-B2BI-Partnership", "type": "AWS::B2BI::Partnership", - "time": "2024-01-04T19:48:42.122Z", + "time": "2024-06-24T16:29:27.357Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::B2BI::Profile.json b/artifacts/types/AWS::B2BI::Profile.json index 5c528b65..afa3d501 100644 --- a/artifacts/types/AWS::B2BI::Profile.json +++ b/artifacts/types/AWS::B2BI::Profile.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-B2BI-Profile", "type": "AWS::B2BI::Profile", - "time": "2024-01-04T19:07:20.682Z", + "time": "2024-06-24T15:54:22.896Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::B2BI::Transformer.json b/artifacts/types/AWS::B2BI::Transformer.json index 3aa0c535..39dc6551 100644 --- a/artifacts/types/AWS::B2BI::Transformer.json +++ b/artifacts/types/AWS::B2BI::Transformer.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-B2BI-Transformer", "type": "AWS::B2BI::Transformer", - "time": "2024-01-04T19:07:56.997Z", + "time": "2024-06-24T15:50:27.522Z", "schema": { "additionalProperties": false, "definitions": { @@ -74,17 +74,39 @@ "X12_180", "X12_204", "X12_210", + "X12_211", "X12_214", "X12_215", + "X12_259", + "X12_260", + "X12_266", + "X12_269", + "X12_270", + "X12_271", + "X12_274", + "X12_275", + "X12_276", + "X12_277", + "X12_278", "X12_310", "X12_315", "X12_322", "X12_404", "X12_410", + "X12_417", + "X12_421", + "X12_426", + "X12_810", "X12_820", "X12_824", "X12_830", + "X12_832", + "X12_834", + "X12_835", + "X12_837", + "X12_844", "X12_846", + "X12_849", "X12_850", "X12_852", "X12_855", @@ -92,9 +114,37 @@ "X12_860", "X12_861", "X12_864", + "X12_865", + "X12_869", + "X12_870", "X12_940", + "X12_945", "X12_990", - "X12_997" + "X12_997", + "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" ], "type": "string" }, @@ -102,7 +152,8 @@ "enum": [ "VERSION_4010", "VERSION_4030", - "VERSION_5010" + "VERSION_5010", + "VERSION_5010_HIPAA" ], "type": "string" } @@ -113,6 +164,7 @@ "permissions": [ "b2bi:CreateTransformer", "b2bi:TagResource", + "b2bi:UpdateTransformer", "logs:CreateLogDelivery", "logs:CreateLogGroup", "logs:CreateLogStream", @@ -138,8 +190,8 @@ }, "read": { "permissions": [ - "b2bi:ListTagsForResource", - "b2bi:GetTransformer" + "b2bi:GetTransformer", + "b2bi:ListTagsForResource" ] }, "update": { @@ -208,6 +260,7 @@ }, "readOnlyProperties": [ "/properties/CreatedAt", + "/properties/ModifiedAt", "/properties/TransformerArn", "/properties/TransformerId" ], diff --git a/artifacts/types/AWS::Backup::BackupPlan.json b/artifacts/types/AWS::Backup::BackupPlan.json index 551ac103..da65eb2d 100644 --- a/artifacts/types/AWS::Backup::BackupPlan.json +++ b/artifacts/types/AWS::Backup::BackupPlan.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Backup-BackupPlan", "type": "AWS::Backup::BackupPlan", - "time": "2024-01-04T16:27:16.773Z", + "time": "2024-06-06T15:34:51.315Z", "schema": { "additionalProperties": false, "definitions": { @@ -124,6 +124,9 @@ }, "MoveToColdStorageAfterDays": { "type": "number" + }, + "OptInToArchiveForSupportedResources": { + "type": "boolean" } }, "type": "object" diff --git a/artifacts/types/AWS::Backup::BackupVault.json b/artifacts/types/AWS::Backup::BackupVault.json index 0e664ba0..8591d62e 100644 --- a/artifacts/types/AWS::Backup::BackupVault.json +++ b/artifacts/types/AWS::Backup::BackupVault.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Backup-BackupVault", "type": "AWS::Backup::BackupVault", - "time": "2024-01-04T16:27:16.584Z", + "time": "2024-06-06T15:34:56.185Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Backup::Framework.json b/artifacts/types/AWS::Backup::Framework.json index b66b9474..e5521c7e 100644 --- a/artifacts/types/AWS::Backup::Framework.json +++ b/artifacts/types/AWS::Backup::Framework.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Backup-Framework", "type": "AWS::Backup::Framework", - "time": "2024-01-04T16:37:03.661Z", + "time": "2024-06-06T15:48:39.592Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Backup::ReportPlan.json b/artifacts/types/AWS::Backup::ReportPlan.json index 046d6669..8280db16 100644 --- a/artifacts/types/AWS::Backup::ReportPlan.json +++ b/artifacts/types/AWS::Backup::ReportPlan.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Backup-ReportPlan", "type": "AWS::Backup::ReportPlan", - "time": "2024-01-04T16:46:13.663Z", + "time": "2024-06-06T15:46:36.448Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Backup::RestoreTestingPlan.json b/artifacts/types/AWS::Backup::RestoreTestingPlan.json index 1df51242..a01b5a63 100644 --- a/artifacts/types/AWS::Backup::RestoreTestingPlan.json +++ b/artifacts/types/AWS::Backup::RestoreTestingPlan.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Backup-RestoreTestingPlan", "type": "AWS::Backup::RestoreTestingPlan", - "time": "2024-01-04T16:26:53.703Z", + "time": "2024-06-06T15:37:18.091Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Backup::RestoreTestingSelection.json b/artifacts/types/AWS::Backup::RestoreTestingSelection.json index 7925c1c0..3e1bfe54 100644 --- a/artifacts/types/AWS::Backup::RestoreTestingSelection.json +++ b/artifacts/types/AWS::Backup::RestoreTestingSelection.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Backup-RestoreTestingSelection", "type": "AWS::Backup::RestoreTestingSelection", - "time": "2024-01-04T16:27:16.969Z", + "time": "2024-06-06T15:37:16.261Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Batch::ComputeEnvironment.json b/artifacts/types/AWS::Batch::ComputeEnvironment.json index 5dcced2e..22a5b900 100644 --- a/artifacts/types/AWS::Batch::ComputeEnvironment.json +++ b/artifacts/types/AWS::Batch::ComputeEnvironment.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Batch-ComputeEnvironment", "type": "AWS::Batch::ComputeEnvironment", - "time": "2023-12-18T19:30:29.507Z", + "time": "2024-06-05T17:45:52.589Z", "schema": { "additionalIdentifiers": [ [ diff --git a/artifacts/types/AWS::Batch::JobDefinition.json b/artifacts/types/AWS::Batch::JobDefinition.json deleted file mode 100644 index b6da5c9e..00000000 --- a/artifacts/types/AWS::Batch::JobDefinition.json +++ /dev/null @@ -1,863 +0,0 @@ -{ - "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Batch-JobDefinition", - "type": "AWS::Batch::JobDefinition", - "time": "2023-12-18T19:17:38.155Z", - "schema": { - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/JobDefinitionName", - "/properties/ContainerProperties", - "/properties/EksProperties", - "/properties/NodeProperties", - "/properties/Parameters", - "/properties/PlatformCapabilities", - "/properties/PropagateTags", - "/properties/RetryStrategy", - "/properties/SchedulingPriority", - "/properties/Timeout", - "/properties/Type" - ], - "definitions": { - "ContainerProperties": { - "additionalProperties": false, - "properties": { - "Command": { - "insertionOrder": true, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Environment": { - "insertionOrder": true, - "items": { - "$ref": "#/definitions/Environment" - }, - "type": "array", - "uniqueItems": false - }, - "EphemeralStorage": { - "additionalProperties": false, - "properties": { - "SizeInGiB": { - "type": "integer" - } - }, - "required": [ - "SizeInGiB" - ], - "type": "object" - }, - "ExecutionRoleArn": { - "type": "string" - }, - "FargatePlatformConfiguration": { - "additionalProperties": false, - "properties": { - "PlatformVersion": { - "type": "string" - } - }, - "type": "object" - }, - "Image": { - "type": "string" - }, - "InstanceType": { - "type": "string" - }, - "JobRoleArn": { - "type": "string" - }, - "LinuxParameters": { - "additionalProperties": false, - "properties": { - "Devices": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Device" - }, - "type": "array", - "uniqueItems": false - }, - "InitProcessEnabled": { - "type": "boolean" - }, - "MaxSwap": { - "type": "integer" - }, - "SharedMemorySize": { - "type": "integer" - }, - "Swappiness": { - "type": "integer" - }, - "Tmpfs": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tmpfs" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "LogConfiguration": { - "additionalProperties": false, - "properties": { - "LogDriver": { - "type": "string" - }, - "Options": { - "additionalProperties": false, - "patternProperties": { - ".*": { - "type": "string" - } - }, - "type": "object" - }, - "SecretOptions": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Secret" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "LogDriver" - ], - "type": "object" - }, - "Memory": { - "type": "integer" - }, - "MountPoints": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/MountPoint" - }, - "type": "array", - "uniqueItems": false - }, - "NetworkConfiguration": { - "additionalProperties": false, - "properties": { - "AssignPublicIp": { - "type": "string" - } - }, - "type": "object" - }, - "Privileged": { - "type": "boolean" - }, - "ReadonlyRootFilesystem": { - "type": "boolean" - }, - "ResourceRequirements": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/ResourceRequirement" - }, - "type": "array", - "uniqueItems": false - }, - "RuntimePlatform": { - "additionalProperties": false, - "properties": { - "CpuArchitecture": { - "type": "string" - }, - "OperatingSystemFamily": { - "type": "string" - } - }, - "type": "object" - }, - "Secrets": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Secret" - }, - "type": "array", - "uniqueItems": false - }, - "Ulimits": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Ulimit" - }, - "type": "array", - "uniqueItems": false - }, - "User": { - "type": "string" - }, - "Vcpus": { - "type": "integer" - }, - "Volumes": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Volume" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "Image" - ], - "type": "object" - }, - "Device": { - "additionalProperties": false, - "properties": { - "ContainerPath": { - "type": "string" - }, - "HostPath": { - "type": "string" - }, - "Permissions": { - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "EFSAuthorizationConfig": { - "additionalProperties": false, - "properties": { - "AccessPointId": { - "type": "string" - }, - "Iam": { - "type": "string" - } - }, - "type": "object" - }, - "EFSVolumeConfiguration": { - "additionalProperties": false, - "properties": { - "AuthorizationConfig": { - "$ref": "#/definitions/EFSAuthorizationConfig" - }, - "FileSystemId": { - "type": "string" - }, - "RootDirectory": { - "type": "string" - }, - "TransitEncryption": { - "type": "string" - }, - "TransitEncryptionPort": { - "type": "integer" - } - }, - "required": [ - "FileSystemId" - ], - "type": "object" - }, - "EksContainer": { - "additionalProperties": false, - "properties": { - "Args": { - "insertionOrder": true, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Command": { - "insertionOrder": true, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Env": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/EksContainerEnvironmentVariable" - }, - "type": "array", - "uniqueItems": false - }, - "Image": { - "type": "string" - }, - "ImagePullPolicy": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "Resources": { - "$ref": "#/definitions/EksContainerResourceRequirements" - }, - "SecurityContext": { - "$ref": "#/definitions/EksContainerSecurityContext" - }, - "VolumeMounts": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/EksContainerVolumeMount" - }, - "type": "array", - "uniqueItems": false - } - }, - "required": [ - "Image" - ], - "type": "object" - }, - "EksContainerEnvironmentVariable": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "EksContainerResourceRequirements": { - "additionalProperties": false, - "properties": { - "Limits": { - "additionalProperties": false, - "patternProperties": { - ".*": { - "type": "string" - } - }, - "type": "object" - }, - "Requests": { - "additionalProperties": false, - "patternProperties": { - ".*": { - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "EksContainerSecurityContext": { - "additionalProperties": false, - "properties": { - "Privileged": { - "type": "boolean" - }, - "ReadOnlyRootFilesystem": { - "type": "boolean" - }, - "RunAsGroup": { - "type": "integer" - }, - "RunAsNonRoot": { - "type": "boolean" - }, - "RunAsUser": { - "type": "integer" - } - }, - "type": "object" - }, - "EksContainerVolumeMount": { - "additionalProperties": false, - "properties": { - "MountPath": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "ReadOnly": { - "type": "boolean" - } - }, - "type": "object" - }, - "EksEmptyDir": { - "additionalProperties": false, - "properties": { - "Medium": { - "type": "string" - }, - "SizeLimit": { - "type": "string" - } - }, - "type": "object" - }, - "EksHostPath": { - "additionalProperties": false, - "properties": { - "Path": { - "type": "string" - } - }, - "type": "object" - }, - "EksMetadata": { - "additionalProperties": false, - "properties": { - "Labels": { - "additionalProperties": false, - "patternProperties": { - ".*": { - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "EksPodProperties": { - "additionalProperties": false, - "properties": { - "Containers": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/EksContainer" - }, - "type": "array", - "uniqueItems": false - }, - "DnsPolicy": { - "type": "string" - }, - "HostNetwork": { - "type": "boolean" - }, - "Metadata": { - "$ref": "#/definitions/EksMetadata" - }, - "ServiceAccountName": { - "type": "string" - }, - "Volumes": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/EksVolume" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "EksProperties": { - "additionalProperties": false, - "properties": { - "PodProperties": { - "$ref": "#/definitions/EksPodProperties" - } - }, - "type": "object" - }, - "EksSecret": { - "additionalProperties": false, - "properties": { - "Optional": { - "type": "boolean" - }, - "SecretName": { - "type": "string" - } - }, - "required": [ - "SecretName" - ], - "type": "object" - }, - "EksVolume": { - "additionalProperties": false, - "properties": { - "EmptyDir": { - "$ref": "#/definitions/EksEmptyDir" - }, - "HostPath": { - "$ref": "#/definitions/EksHostPath" - }, - "Name": { - "type": "string" - }, - "Secret": { - "$ref": "#/definitions/EksSecret" - } - }, - "required": [ - "Name" - ], - "type": "object" - }, - "Environment": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - }, - "EvaluateOnExit": { - "additionalProperties": false, - "properties": { - "Action": { - "type": "string" - }, - "OnExitCode": { - "type": "string" - }, - "OnReason": { - "type": "string" - }, - "OnStatusReason": { - "type": "string" - } - }, - "required": [ - "Action" - ], - "type": "object" - }, - "Host": { - "additionalProperties": false, - "properties": { - "SourcePath": { - "type": "string" - } - }, - "type": "object" - }, - "JobTimeout": { - "additionalProperties": false, - "properties": { - "AttemptDurationSeconds": { - "type": "integer" - } - }, - "type": "object" - }, - "MountPoint": { - "additionalProperties": false, - "properties": { - "ContainerPath": { - "type": "string" - }, - "ReadOnly": { - "type": "boolean" - }, - "SourceVolume": { - "type": "string" - } - }, - "type": "object" - }, - "NodeProperties": { - "additionalProperties": false, - "properties": { - "MainNode": { - "type": "integer" - }, - "NodeRangeProperties": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/NodeRangeProperty" - }, - "type": "array", - "uniqueItems": false - }, - "NumNodes": { - "type": "integer" - } - }, - "required": [ - "NumNodes", - "MainNode", - "NodeRangeProperties" - ], - "type": "object" - }, - "NodeRangeProperty": { - "additionalProperties": false, - "properties": { - "Container": { - "$ref": "#/definitions/ContainerProperties" - }, - "TargetNodes": { - "type": "string" - } - }, - "required": [ - "TargetNodes" - ], - "type": "object" - }, - "ResourceRequirement": { - "additionalProperties": false, - "properties": { - "Type": { - "type": "string" - }, - "Value": { - "type": "string" - } - }, - "type": "object" - }, - "RetryStrategy": { - "additionalProperties": false, - "properties": { - "Attempts": { - "type": "integer" - }, - "EvaluateOnExit": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/EvaluateOnExit" - }, - "type": "array", - "uniqueItems": false - } - }, - "type": "object" - }, - "Secret": { - "additionalProperties": false, - "properties": { - "Name": { - "type": "string" - }, - "ValueFrom": { - "type": "string" - } - }, - "required": [ - "Name", - "ValueFrom" - ], - "type": "object" - }, - "Tmpfs": { - "additionalProperties": false, - "properties": { - "ContainerPath": { - "type": "string" - }, - "MountOptions": { - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "Size": { - "type": "integer" - } - }, - "required": [ - "ContainerPath", - "Size" - ], - "type": "object" - }, - "Ulimit": { - "additionalProperties": false, - "properties": { - "HardLimit": { - "type": "integer" - }, - "Name": { - "type": "string" - }, - "SoftLimit": { - "type": "integer" - } - }, - "required": [ - "HardLimit", - "Name", - "SoftLimit" - ], - "type": "object" - }, - "Volume": { - "additionalProperties": false, - "properties": { - "EfsVolumeConfiguration": { - "$ref": "#/definitions/EFSVolumeConfiguration" - }, - "Host": { - "$ref": "#/definitions/Host" - }, - "Name": { - "type": "string" - } - }, - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Batch::JobDefinition", - "handlers": { - "create": { - "permissions": [ - "Batch:RegisterJobDefinition", - "Batch:TagResource", - "Batch:DescribeJobDefinitions", - "Iam:PassRole" - ] - }, - "delete": { - "permissions": [ - "Batch:DescribeJobDefinitions", - "Batch:DeregisterJobDefinition", - "Iam:PassRole" - ] - }, - "list": { - "permissions": [ - "Batch:DescribeJobDefinitions" - ] - }, - "read": { - "permissions": [ - "Batch:DescribeJobDefinitions" - ] - }, - "update": { - "permissions": [ - "Batch:DescribeJobDefinitions", - "Batch:TagResource", - "Batch:UntagResource", - "Iam:PassRole" - ] - } - }, - "primaryIdentifier": [ - "/properties/JobDefinitionArn" - ], - "properties": { - "ContainerOrchestrationType": { - "type": "string" - }, - "ContainerProperties": { - "$ref": "#/definitions/ContainerProperties" - }, - "EksProperties": { - "$ref": "#/definitions/EksProperties" - }, - "JobDefinitionArn": { - "type": "string" - }, - "JobDefinitionName": { - "maxLength": 128, - "type": "string" - }, - "NodeProperties": { - "$ref": "#/definitions/NodeProperties" - }, - "Parameters": { - "additionalProperties": false, - "patternProperties": { - ".*": { - "type": "string" - } - }, - "type": "object" - }, - "PlatformCapabilities": { - "insertionOrder": true, - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": false - }, - "PropagateTags": { - "type": "boolean" - }, - "RetryStrategy": { - "$ref": "#/definitions/RetryStrategy" - }, - "Revision": { - "type": "integer" - }, - "SchedulingPriority": { - "type": "integer" - }, - "Status": { - "type": "string" - }, - "Tags": { - "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", - "patternProperties": { - ".*": { - "type": "string" - } - }, - "type": "object" - }, - "Timeout": { - "$ref": "#/definitions/JobTimeout" - }, - "Type": { - "type": "string" - } - }, - "readOnlyProperties": [ - "/properties/ContainerOrchestrationType", - "/properties/JobDefinitionArn", - "/properties/Revision", - "/properties/Status" - ], - "required": [ - "Type" - ], - "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": true, - "tagProperty": "/properties/Tags", - "tagUpdatable": true, - "taggable": true - }, - "typeName": "AWS::Batch::JobDefinition", - "writeOnlyProperties": [ - "/properties/ContainerProperties/InstanceType", - "/properties/NodeProperties/NodeRangeProperties/*/Container/FargatePlatformConfiguration/PlatformVersion", - "/properties/NodeProperties/NodeRangeProperties/*/Container/NetworkConfiguration/AssignPublicIp" - ] - } -} \ No newline at end of file diff --git a/artifacts/types/AWS::Batch::JobQueue.json b/artifacts/types/AWS::Batch::JobQueue.json index 00fb0bbc..ac581571 100644 --- a/artifacts/types/AWS::Batch::JobQueue.json +++ b/artifacts/types/AWS::Batch::JobQueue.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Batch-JobQueue", "type": "AWS::Batch::JobQueue", - "time": "2023-12-18T19:18:33.811Z", + "time": "2024-06-05T18:15:28.71Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -25,6 +25,38 @@ ], "type": "object" }, + "JobStateTimeLimitAction": { + "additionalProperties": false, + "properties": { + "Action": { + "enum": [ + "CANCEL" + ], + "type": "string" + }, + "MaxTimeSeconds": { + "maximum": 86400, + "minimum": 600, + "type": "integer" + }, + "Reason": { + "type": "string" + }, + "State": { + "enum": [ + "RUNNABLE" + ], + "type": "string" + } + }, + "required": [ + "Action", + "MaxTimeSeconds", + "Reason", + "State" + ], + "type": "object" + }, "ResourceArn": { "pattern": "arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}", "type": "string" @@ -85,6 +117,14 @@ "minLength": 1, "type": "string" }, + "JobStateTimeLimitActions": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/JobStateTimeLimitAction" + }, + "type": "array", + "uniqueItems": false + }, "Priority": { "maximum": 1000, "minimum": 0, diff --git a/artifacts/types/AWS::Batch::SchedulingPolicy.json b/artifacts/types/AWS::Batch::SchedulingPolicy.json index 48e1c35c..58abe860 100644 --- a/artifacts/types/AWS::Batch::SchedulingPolicy.json +++ b/artifacts/types/AWS::Batch::SchedulingPolicy.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Batch-SchedulingPolicy", "type": "AWS::Batch::SchedulingPolicy", - "time": "2023-12-18T19:17:38.074Z", + "time": "2024-06-05T17:20:20.681Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Bedrock::Agent.json b/artifacts/types/AWS::Bedrock::Agent.json new file mode 100644 index 00000000..0c318611 --- /dev/null +++ b/artifacts/types/AWS::Bedrock::Agent.json @@ -0,0 +1,687 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Bedrock-Agent", + "type": "AWS::Bedrock::Agent", + "time": "2024-06-24T19:46:05.052Z", + "schema": { + "additionalProperties": false, + "definitions": { + "APISchema": { + "description": "Contains information about the API Schema for the Action Group", + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "S3": { + "$ref": "#/definitions/S3Identifier" + } + }, + "required": [ + "S3" + ], + "title": "S3", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "Payload": { + "description": "String OpenAPI Payload", + "type": "string" + } + }, + "required": [ + "Payload" + ], + "title": "Payload", + "type": "object" + } + ] + }, + "ActionGroupExecutor": { + "description": "Type of Executors for an Action Group", + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "Lambda": { + "description": "ARN of a Lambda.", + "maxLength": 2048, + "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-_]+))?$", + "type": "string" + } + }, + "required": [ + "Lambda" + ], + "title": "Lambda", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "CustomControl": { + "$ref": "#/definitions/CustomControlMethod" + } + }, + "required": [ + "CustomControl" + ], + "title": "CustomControl", + "type": "object" + } + ] + }, + "ActionGroupSignature": { + "description": "Action Group Signature for a BuiltIn Action", + "enum": [ + "AMAZON.UserInput" + ], + "type": "string" + }, + "ActionGroupState": { + "description": "State of the action group", + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + }, + "AgentActionGroup": { + "additionalProperties": false, + "description": "Contains the information of an Agent Action Group", + "properties": { + "ActionGroupExecutor": { + "$ref": "#/definitions/ActionGroupExecutor" + }, + "ActionGroupName": { + "description": "Name of the action group", + "pattern": "^([0-9a-zA-Z][_-]?){1,100}$", + "type": "string" + }, + "ActionGroupState": { + "$ref": "#/definitions/ActionGroupState" + }, + "ApiSchema": { + "$ref": "#/definitions/APISchema" + }, + "Description": { + "description": "Description of action group", + "maxLength": 200, + "minLength": 1, + "type": "string" + }, + "FunctionSchema": { + "$ref": "#/definitions/FunctionSchema" + }, + "ParentActionGroupSignature": { + "$ref": "#/definitions/ActionGroupSignature" + }, + "SkipResourceInUseCheckOnDelete": { + "default": false, + "description": "Specifies whether to allow deleting action group while it is in use.", + "type": "boolean" + } + }, + "required": [ + "ActionGroupName" + ], + "type": "object" + }, + "AgentKnowledgeBase": { + "additionalProperties": false, + "description": "Agent Knowledge Base", + "properties": { + "Description": { + "description": "Description of the Resource.", + "maxLength": 200, + "minLength": 1, + "type": "string" + }, + "KnowledgeBaseId": { + "description": "Identifier for a resource.", + "pattern": "^[0-9a-zA-Z]{10}$", + "type": "string" + }, + "KnowledgeBaseState": { + "$ref": "#/definitions/KnowledgeBaseState" + } + }, + "required": [ + "KnowledgeBaseId", + "Description" + ], + "type": "object" + }, + "AgentStatus": { + "description": "Schema Type for Action APIs.", + "enum": [ + "CREATING", + "PREPARING", + "PREPARED", + "NOT_PREPARED", + "DELETING", + "FAILED", + "VERSIONING", + "UPDATING" + ], + "type": "string" + }, + "CreationMode": { + "description": "Creation Mode for Prompt Configuration.", + "enum": [ + "DEFAULT", + "OVERRIDDEN" + ], + "type": "string" + }, + "CustomControlMethod": { + "description": "Custom control of action execution", + "enum": [ + "RETURN_CONTROL" + ], + "type": "string" + }, + "Function": { + "additionalProperties": false, + "description": "Function definition", + "properties": { + "Description": { + "description": "Description of function", + "maxLength": 1200, + "minLength": 1, + "type": "string" + }, + "Name": { + "description": "Name for a resource.", + "pattern": "^([0-9a-zA-Z][_-]?){1,100}$", + "type": "string" + }, + "Parameters": { + "$ref": "#/definitions/ParameterMap" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "FunctionSchema": { + "additionalProperties": false, + "description": "Schema of Functions", + "properties": { + "Functions": { + "description": "List of Function definitions", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Function" + }, + "type": "array" + } + }, + "required": [ + "Functions" + ], + "title": "Functions", + "type": "object" + }, + "GuardrailConfiguration": { + "additionalProperties": false, + "description": "Configuration for a guardrail.", + "properties": { + "GuardrailIdentifier": { + "description": "Identifier for the guardrail, could be the id or the arn", + "maxLength": 2048, + "pattern": "^(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))$", + "type": "string" + }, + "GuardrailVersion": { + "description": "Version of the guardrail", + "pattern": "^(([0-9]{1,8})|(DRAFT))$", + "type": "string" + } + }, + "type": "object" + }, + "InferenceConfiguration": { + "additionalProperties": false, + "description": "Configuration for inference in prompt configuration", + "properties": { + "MaximumLength": { + "description": "Maximum length of output", + "maximum": 4096, + "minimum": 0, + "type": "number" + }, + "StopSequences": { + "description": "List of stop sequences", + "insertionOrder": false, + "items": { + "type": "string" + }, + "maxItems": 4, + "minItems": 0, + "type": "array" + }, + "Temperature": { + "description": "Controls randomness, higher values increase diversity", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "TopK": { + "description": "Sample from the k most likely next tokens", + "maximum": 500, + "minimum": 0, + "type": "number" + }, + "TopP": { + "description": "Cumulative probability cutoff for token selection", + "maximum": 1, + "minimum": 0, + "type": "number" + } + }, + "type": "object" + }, + "KnowledgeBaseState": { + "description": "State of the knowledge base; whether it is enabled or disabled", + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + }, + "ParameterDetail": { + "additionalProperties": false, + "description": "Parameter detail", + "properties": { + "Description": { + "description": "Description of function parameter.", + "maxLength": 500, + "minLength": 1, + "type": "string" + }, + "Required": { + "description": "Information about if a parameter is required for function call. Default to false.", + "type": "boolean" + }, + "Type": { + "$ref": "#/definitions/Type" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "ParameterMap": { + "additionalProperties": false, + "description": "A map of parameter name and detail", + "patternProperties": { + "^([0-9a-zA-Z][_-]?){1,100}$": { + "$ref": "#/definitions/ParameterDetail" + } + }, + "type": "object" + }, + "PromptConfiguration": { + "additionalProperties": false, + "description": "BasePromptConfiguration per Prompt Type.", + "properties": { + "BasePromptTemplate": { + "description": "Base Prompt Template.", + "maxLength": 100000, + "minLength": 1, + "type": "string" + }, + "InferenceConfiguration": { + "$ref": "#/definitions/InferenceConfiguration" + }, + "ParserMode": { + "$ref": "#/definitions/CreationMode" + }, + "PromptCreationMode": { + "$ref": "#/definitions/CreationMode" + }, + "PromptState": { + "$ref": "#/definitions/PromptState" + }, + "PromptType": { + "$ref": "#/definitions/PromptType" + } + }, + "type": "object" + }, + "PromptOverrideConfiguration": { + "additionalProperties": false, + "description": "Configuration for prompt override.", + "properties": { + "OverrideLambda": { + "description": "ARN of a Lambda.", + "maxLength": 2048, + "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-_]+))?$", + "type": "string" + }, + "PromptConfigurations": { + "description": "List of BasePromptConfiguration", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/PromptConfiguration" + }, + "maxItems": 10, + "type": "array" + } + }, + "required": [ + "PromptConfigurations" + ], + "type": "object" + }, + "PromptState": { + "description": "Prompt State.", + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + }, + "PromptType": { + "description": "Prompt Type.", + "enum": [ + "PRE_PROCESSING", + "ORCHESTRATION", + "POST_PROCESSING", + "KNOWLEDGE_BASE_RESPONSE_GENERATION" + ], + "type": "string" + }, + "S3Identifier": { + "additionalProperties": false, + "description": "The identifier for the S3 resource.", + "properties": { + "S3BucketName": { + "description": "A bucket in S3.", + "maxLength": 63, + "minLength": 3, + "pattern": "^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$", + "type": "string" + }, + "S3ObjectKey": { + "description": "A object key in S3.", + "maxLength": 1024, + "minLength": 1, + "pattern": "^[\\.\\-\\!\\*\\_\\'\\(\\)a-zA-Z0-9][\\.\\-\\!\\*\\_\\'\\(\\)\\/a-zA-Z0-9]*$", + "type": "string" + } + }, + "type": "object" + }, + "TagsMap": { + "additionalProperties": false, + "description": "A map of tag keys and values", + "patternProperties": { + "^[a-zA-Z0-9\\s._:/=+@-]*$": { + "description": "Value of a tag", + "maxLength": 256, + "minLength": 0, + "pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$", + "type": "string" + } + }, + "type": "object" + }, + "Type": { + "description": "Parameter Type", + "enum": [ + "string", + "number", + "integer", + "boolean", + "array" + ], + "type": "string" + } + }, + "description": "Definition of AWS::Bedrock::Agent Resource Type", + "handlers": { + "create": { + "permissions": [ + "bedrock:CreateAgent", + "bedrock:GetAgent", + "bedrock:PrepareAgent", + "bedrock:GetAgentKnowledgeBase", + "bedrock:AssociateAgentKnowledgeBase", + "bedrock:ListAgentKnowledgeBases", + "bedrock:CreateAgentActionGroup", + "bedrock:GetAgentActionGroup", + "bedrock:ListAgentActionGroups", + "bedrock:TagResource", + "bedrock:ListTagsForResource", + "bedrock:CreateGuardrail", + "bedrock:CreateGuardrailVersion", + "bedrock:GetGuardrail", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "bedrock:GetAgent", + "bedrock:DeleteAgent", + "bedrock:DeleteGuardrail", + "bedrock:GetGuardrail" + ] + }, + "list": { + "permissions": [ + "bedrock:ListAgents", + "bedrock:ListGuardrails" + ] + }, + "read": { + "permissions": [ + "bedrock:GetAgent", + "bedrock:GetAgentActionGroup", + "bedrock:ListAgentActionGroups", + "bedrock:GetAgentKnowledgeBase", + "bedrock:ListAgentKnowledgeBases", + "bedrock:ListTagsForResource", + "bedrock:GetGuardrail", + "kms:Decrypt" + ] + }, + "update": { + "permissions": [ + "bedrock:GetAgent", + "bedrock:UpdateAgent", + "bedrock:PrepareAgent", + "bedrock:GetAgentKnowledgeBase", + "bedrock:UpdateAgentKnowledgeBase", + "bedrock:AssociateAgentKnowledgeBase", + "bedrock:DisassociateAgentKnowledgeBase", + "bedrock:ListAgentKnowledgeBases", + "bedrock:CreateAgentActionGroup", + "bedrock:GetAgentActionGroup", + "bedrock:UpdateAgentActionGroup", + "bedrock:DeleteAgentActionGroup", + "bedrock:ListAgentActionGroups", + "bedrock:TagResource", + "bedrock:UntagResource", + "bedrock:ListTagsForResource", + "bedrock:UpdateGuardrail", + "bedrock:GetGuardrail", + "kms:Decrypt", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/AgentId" + ], + "properties": { + "ActionGroups": { + "description": "List of ActionGroups", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/AgentActionGroup" + }, + "type": "array" + }, + "AgentArn": { + "description": "Arn representation of the Agent.", + "maxLength": 2048, + "pattern": "^arn:aws(|-cn|-us-gov):bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent/[0-9a-zA-Z]{10}$", + "type": "string" + }, + "AgentId": { + "description": "Identifier for a resource.", + "pattern": "^[0-9a-zA-Z]{10}$", + "type": "string" + }, + "AgentName": { + "description": "Name for a resource.", + "pattern": "^([0-9a-zA-Z][_-]?){1,100}$", + "type": "string" + }, + "AgentResourceRoleArn": { + "description": "ARN of a IAM role.", + "maxLength": 2048, + "type": "string" + }, + "AgentStatus": { + "$ref": "#/definitions/AgentStatus" + }, + "AgentVersion": { + "description": "Draft Agent Version.", + "maxLength": 5, + "minLength": 5, + "pattern": "^DRAFT$", + "type": "string" + }, + "AutoPrepare": { + "default": false, + "description": "Specifies whether to automatically prepare after creating or updating the agent.", + "type": "boolean" + }, + "CreatedAt": { + "description": "Time Stamp.", + "format": "date-time", + "type": "string" + }, + "CustomerEncryptionKeyArn": { + "description": "A KMS key ARN", + "maxLength": 2048, + "minLength": 1, + "pattern": "^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$", + "type": "string" + }, + "Description": { + "description": "Description of the Resource.", + "maxLength": 200, + "minLength": 1, + "type": "string" + }, + "FailureReasons": { + "description": "Failure Reasons for Error.", + "insertionOrder": false, + "items": { + "description": "Failure Reason for Error.", + "maxLength": 2048, + "type": "string" + }, + "maxItems": 2048, + "type": "array" + }, + "FoundationModel": { + "description": "ARN or name of a Bedrock model.", + "maxLength": 2048, + "minLength": 1, + "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})))|(([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][_-]?)+)$", + "type": "string" + }, + "GuardrailConfiguration": { + "$ref": "#/definitions/GuardrailConfiguration" + }, + "IdleSessionTTLInSeconds": { + "description": "Max Session Time.", + "maximum": 3600, + "minimum": 60, + "type": "number" + }, + "Instruction": { + "description": "Instruction for the agent.", + "minLength": 40, + "type": "string" + }, + "KnowledgeBases": { + "description": "List of Agent Knowledge Bases", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/AgentKnowledgeBase" + }, + "type": "array" + }, + "PreparedAt": { + "description": "Time Stamp.", + "format": "date-time", + "type": "string" + }, + "PromptOverrideConfiguration": { + "$ref": "#/definitions/PromptOverrideConfiguration" + }, + "RecommendedActions": { + "description": "The recommended actions users can take to resolve an error in failureReasons.", + "insertionOrder": false, + "items": { + "description": "The recommended action users can take to resolve an error in failureReasons.", + "maxLength": 2048, + "type": "string" + }, + "maxItems": 2048, + "type": "array" + }, + "SkipResourceInUseCheckOnDelete": { + "default": false, + "description": "Specifies whether to allow deleting agent while it is in use.", + "type": "boolean" + }, + "Tags": { + "$ref": "#/definitions/TagsMap" + }, + "TestAliasTags": { + "$ref": "#/definitions/TagsMap" + }, + "UpdatedAt": { + "description": "Time Stamp.", + "format": "date-time", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/AgentArn", + "/properties/AgentId", + "/properties/AgentStatus", + "/properties/AgentVersion", + "/properties/CreatedAt", + "/properties/FailureReasons", + "/properties/PreparedAt", + "/properties/RecommendedActions", + "/properties/UpdatedAt" + ], + "required": [ + "AgentName" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Bedrock::Agent", + "writeOnlyProperties": [ + "/properties/AutoPrepare", + "/properties/SkipResourceInUseCheckOnDelete", + "/properties/ActionGroups/*/SkipResourceInUseCheckOnDelete" + ] + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::Bedrock::AgentAlias.json b/artifacts/types/AWS::Bedrock::AgentAlias.json new file mode 100644 index 00000000..9f61c32a --- /dev/null +++ b/artifacts/types/AWS::Bedrock::AgentAlias.json @@ -0,0 +1,222 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Bedrock-AgentAlias", + "type": "AWS::Bedrock::AgentAlias", + "time": "2024-06-24T19:45:42.165Z", + "schema": { + "additionalIdentifiers": [ + [ + "/properties/AgentAliasArn" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AgentId" + ], + "definitions": { + "AgentAliasHistoryEvent": { + "additionalProperties": false, + "description": "History event for an alias for an Agent.", + "properties": { + "EndDate": { + "description": "Time Stamp.", + "type": "string" + }, + "RoutingConfiguration": { + "description": "Routing configuration for an Agent alias.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/AgentAliasRoutingConfigurationListItem" + }, + "maxItems": 1, + "type": "array" + }, + "StartDate": { + "description": "Time Stamp.", + "type": "string" + } + }, + "type": "object" + }, + "AgentAliasRoutingConfigurationListItem": { + "additionalProperties": false, + "description": "Details about the routing configuration for an Agent alias.", + "properties": { + "AgentVersion": { + "description": "Agent Version.", + "maxLength": 5, + "minLength": 1, + "pattern": "^(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})$", + "type": "string" + } + }, + "required": [ + "AgentVersion" + ], + "type": "object" + }, + "AgentAliasStatus": { + "description": "The statuses an Agent Alias can be in.", + "enum": [ + "CREATING", + "PREPARED", + "FAILED", + "UPDATING", + "DELETING" + ], + "type": "string" + }, + "TagsMap": { + "additionalProperties": false, + "description": "A map of tag keys and values", + "patternProperties": { + "^[a-zA-Z0-9\\s._:/=+@-]*$": { + "description": "Value of a tag", + "maxLength": 256, + "minLength": 0, + "pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$", + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Definition of AWS::Bedrock::AgentAlias Resource Type", + "handlers": { + "create": { + "permissions": [ + "bedrock:PrepareAgent", + "bedrock:GetAgent", + "bedrock:CreateAgentAlias", + "bedrock:TagResource", + "bedrock:GetAgentAlias", + "bedrock:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "bedrock:DeleteAgentAlias" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "AgentId": { + "$ref": "resource-schema.json#/properties/AgentId" + } + }, + "required": [ + "AgentId" + ] + }, + "permissions": [ + "bedrock:ListAgentAliases" + ] + }, + "read": { + "permissions": [ + "bedrock:GetAgentAlias", + "bedrock:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "bedrock:PrepareAgent", + "bedrock:GetAgent", + "bedrock:UpdateAgentAlias", + "bedrock:TagResource", + "bedrock:UntagResource", + "bedrock:GetAgentAlias", + "bedrock:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/AgentId", + "/properties/AgentAliasId" + ], + "properties": { + "AgentAliasArn": { + "description": "Arn representation of the Agent Alias.", + "maxLength": 2048, + "pattern": "^arn:aws(|-cn|-us-gov):bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent-alias/[0-9a-zA-Z]{10}/[0-9a-zA-Z]{10}$", + "type": "string" + }, + "AgentAliasHistoryEvents": { + "description": "The list of history events for an alias for an Agent.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/AgentAliasHistoryEvent" + }, + "maxItems": 10, + "type": "array" + }, + "AgentAliasId": { + "description": "Id for an Agent Alias generated at the server side.", + "maxLength": 10, + "minLength": 10, + "pattern": "^(\\bTSTALIASID\\b|[0-9a-zA-Z]+)$", + "type": "string" + }, + "AgentAliasName": { + "description": "Name for a resource.", + "pattern": "^([0-9a-zA-Z][_-]?){1,100}$", + "type": "string" + }, + "AgentAliasStatus": { + "$ref": "#/definitions/AgentAliasStatus" + }, + "AgentId": { + "description": "Identifier for a resource.", + "pattern": "^[0-9a-zA-Z]{10}$", + "type": "string" + }, + "CreatedAt": { + "description": "Time Stamp.", + "type": "string" + }, + "Description": { + "description": "Description of the Resource.", + "maxLength": 200, + "minLength": 1, + "type": "string" + }, + "RoutingConfiguration": { + "description": "Routing configuration for an Agent alias.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/AgentAliasRoutingConfigurationListItem" + }, + "maxItems": 1, + "type": "array" + }, + "Tags": { + "$ref": "#/definitions/TagsMap" + }, + "UpdatedAt": { + "description": "Time Stamp.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/AgentAliasArn", + "/properties/AgentAliasHistoryEvents", + "/properties/AgentAliasId", + "/properties/AgentAliasStatus", + "/properties/CreatedAt", + "/properties/UpdatedAt" + ], + "required": [ + "AgentAliasName", + "AgentId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-bedrock-agents", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Bedrock::AgentAlias" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::Bedrock::DataSource.json b/artifacts/types/AWS::Bedrock::DataSource.json new file mode 100644 index 00000000..cad5ea4a --- /dev/null +++ b/artifacts/types/AWS::Bedrock::DataSource.json @@ -0,0 +1,283 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Bedrock-DataSource", + "type": "AWS::Bedrock::DataSource", + "time": "2024-06-11T01:12:44.701Z", + "schema": { + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/KnowledgeBaseId", + "/properties/VectorIngestionConfiguration" + ], + "definitions": { + "ChunkingConfiguration": { + "additionalProperties": false, + "description": "Details 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.", + "properties": { + "ChunkingStrategy": { + "$ref": "#/definitions/ChunkingStrategy" + }, + "FixedSizeChunkingConfiguration": { + "$ref": "#/definitions/FixedSizeChunkingConfiguration" + } + }, + "required": [ + "ChunkingStrategy" + ], + "type": "object" + }, + "ChunkingStrategy": { + "description": "Knowledge 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.", + "enum": [ + "FIXED_SIZE", + "NONE" + ], + "type": "string" + }, + "DataDeletionPolicy": { + "description": "The deletion policy for the data source.", + "enum": [ + "RETAIN", + "DELETE" + ], + "type": "string" + }, + "DataSourceConfiguration": { + "additionalProperties": false, + "description": "Specifies a raw data source location to ingest.", + "properties": { + "S3Configuration": { + "$ref": "#/definitions/S3DataSourceConfiguration" + }, + "Type": { + "$ref": "#/definitions/DataSourceType" + } + }, + "required": [ + "Type", + "S3Configuration" + ], + "type": "object" + }, + "DataSourceStatus": { + "description": "The status of a data source.", + "enum": [ + "AVAILABLE", + "DELETING", + "DELETE_UNSUCCESSFUL" + ], + "type": "string" + }, + "DataSourceType": { + "description": "The type of the data source location.", + "enum": [ + "S3" + ], + "type": "string" + }, + "FixedSizeChunkingConfiguration": { + "additionalProperties": false, + "description": "Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE, exclude this field.", + "properties": { + "MaxTokens": { + "description": "The maximum number of tokens to include in a chunk.", + "minimum": 1, + "type": "integer" + }, + "OverlapPercentage": { + "description": "The percentage of overlap between adjacent chunks of a data source.", + "maximum": 99, + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "MaxTokens", + "OverlapPercentage" + ], + "type": "object" + }, + "S3DataSourceConfiguration": { + "additionalProperties": false, + "description": "Contains information about the S3 configuration of the data source.", + "properties": { + "BucketArn": { + "description": "The ARN of the bucket that contains the data source.", + "maxLength": 2048, + "minLength": 1, + "pattern": "^arn:aws(|-cn|-us-gov):s3:::[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$", + "type": "string" + }, + "BucketOwnerAccountId": { + "description": "The account ID for the owner of the S3 bucket.", + "maxLength": 12, + "minLength": 12, + "pattern": "^[0-9]{12}$", + "type": "string" + }, + "InclusionPrefixes": { + "description": "A list of S3 prefixes that define the object containing the data sources.", + "insertionOrder": false, + "items": { + "description": "Prefix for s3 object.", + "maxLength": 300, + "minLength": 1, + "type": "string" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "BucketArn" + ], + "type": "object" + }, + "ServerSideEncryptionConfiguration": { + "additionalProperties": false, + "description": "Contains details about the server-side encryption for the data source.", + "properties": { + "KmsKeyArn": { + "description": "The ARN of the AWS KMS key used to encrypt the resource.", + "maxLength": 2048, + "minLength": 1, + "pattern": "^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$", + "type": "string" + } + }, + "type": "object" + }, + "VectorIngestionConfiguration": { + "additionalProperties": false, + "description": "Details 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.", + "properties": { + "ChunkingConfiguration": { + "$ref": "#/definitions/ChunkingConfiguration" + } + }, + "type": "object" + } + }, + "description": "Definition of AWS::Bedrock::DataSource Resource Type", + "handlers": { + "create": { + "permissions": [ + "bedrock:CreateDataSource", + "bedrock:GetDataSource", + "bedrock:GetKnowledgeBase" + ] + }, + "delete": { + "permissions": [ + "bedrock:GetDataSource", + "bedrock:DeleteDataSource" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "KnowledgeBaseId": { + "$ref": "resource-schema.json#/properties/KnowledgeBaseId" + } + }, + "required": [ + "KnowledgeBaseId" + ] + }, + "permissions": [ + "bedrock:ListDataSources" + ] + }, + "read": { + "permissions": [ + "bedrock:GetDataSource" + ] + }, + "update": { + "permissions": [ + "bedrock:GetDataSource", + "bedrock:UpdateDataSource" + ] + } + }, + "primaryIdentifier": [ + "/properties/KnowledgeBaseId", + "/properties/DataSourceId" + ], + "properties": { + "CreatedAt": { + "description": "The time at which the data source was created.", + "type": "string" + }, + "DataDeletionPolicy": { + "$ref": "#/definitions/DataDeletionPolicy" + }, + "DataSourceConfiguration": { + "$ref": "#/definitions/DataSourceConfiguration" + }, + "DataSourceId": { + "description": "Identifier for a resource.", + "pattern": "^[0-9a-zA-Z]{10}$", + "type": "string" + }, + "DataSourceStatus": { + "$ref": "#/definitions/DataSourceStatus" + }, + "Description": { + "description": "Description of the Resource.", + "maxLength": 200, + "minLength": 1, + "type": "string" + }, + "FailureReasons": { + "description": "The details of the failure reasons related to the data source.", + "insertionOrder": false, + "items": { + "description": "Failure Reason for Error.", + "maxLength": 2048, + "type": "string" + }, + "maxItems": 2048, + "type": "array" + }, + "KnowledgeBaseId": { + "description": "The unique identifier of the knowledge base to which to add the data source.", + "pattern": "^[0-9a-zA-Z]{10}$", + "type": "string" + }, + "Name": { + "description": "The name of the data source.", + "pattern": "^([0-9a-zA-Z][_-]?){1,100}$", + "type": "string" + }, + "ServerSideEncryptionConfiguration": { + "$ref": "#/definitions/ServerSideEncryptionConfiguration" + }, + "UpdatedAt": { + "description": "The time at which the knowledge base was last updated.", + "type": "string" + }, + "VectorIngestionConfiguration": { + "$ref": "#/definitions/VectorIngestionConfiguration" + } + }, + "readOnlyProperties": [ + "/properties/DataSourceId", + "/properties/DataSourceStatus", + "/properties/CreatedAt", + "/properties/UpdatedAt", + "/properties/FailureReasons" + ], + "required": [ + "DataSourceConfiguration", + "Name", + "KnowledgeBaseId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-aps", + "tagging": { + "cloudFormationSystemTags": true, + "taggable": false + }, + "typeName": "AWS::Bedrock::DataSource" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::Bedrock::Guardrail.json b/artifacts/types/AWS::Bedrock::Guardrail.json new file mode 100644 index 00000000..3fae8e95 --- /dev/null +++ b/artifacts/types/AWS::Bedrock::Guardrail.json @@ -0,0 +1,619 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Bedrock-Guardrail", + "type": "AWS::Bedrock::Guardrail", + "time": "2024-06-24T15:48:42.093Z", + "schema": { + "additionalProperties": false, + "definitions": { + "ContentFilter": { + "additionalProperties": false, + "description": "Content filter in content policy.", + "properties": { + "InputStrength": { + "$ref": "#/definitions/FilterStrength" + }, + "OutputStrength": { + "$ref": "#/definitions/FilterStrength" + }, + "Type": { + "$ref": "#/definitions/ContentFilterType" + } + }, + "required": [ + "InputStrength", + "OutputStrength", + "Type" + ], + "type": "object" + }, + "ContentFilterConfig": { + "additionalProperties": false, + "description": "Content filter config in content policy.", + "properties": { + "InputStrength": { + "$ref": "#/definitions/FilterStrength" + }, + "OutputStrength": { + "$ref": "#/definitions/FilterStrength" + }, + "Type": { + "$ref": "#/definitions/ContentFilterType" + } + }, + "required": [ + "InputStrength", + "OutputStrength", + "Type" + ], + "type": "object" + }, + "ContentFilterType": { + "description": "Type of filter in content policy", + "enum": [ + "SEXUAL", + "VIOLENCE", + "HATE", + "INSULTS", + "MISCONDUCT", + "PROMPT_ATTACK" + ], + "type": "string" + }, + "ContentPolicyConfig": { + "additionalProperties": false, + "description": "Content policy config for a guardrail.", + "properties": { + "FiltersConfig": { + "description": "List of content filter configs in content policy.", + "items": { + "$ref": "#/definitions/ContentFilterConfig" + }, + "maxItems": 6, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "FiltersConfig" + ], + "type": "object" + }, + "FilterStrength": { + "description": "Strength for filters", + "enum": [ + "NONE", + "LOW", + "MEDIUM", + "HIGH" + ], + "type": "string" + }, + "GuardrailStatus": { + "description": "Status of the guardrail", + "enum": [ + "CREATING", + "UPDATING", + "VERSIONING", + "READY", + "FAILED", + "DELETING" + ], + "type": "string" + }, + "ManagedWords": { + "additionalProperties": false, + "description": "A managed words definition.", + "properties": { + "Type": { + "$ref": "#/definitions/ManagedWordsType" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "ManagedWordsConfig": { + "additionalProperties": false, + "description": "A managed words config.", + "properties": { + "Type": { + "$ref": "#/definitions/ManagedWordsType" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "ManagedWordsType": { + "description": "Options for managed words.", + "enum": [ + "PROFANITY" + ], + "type": "string" + }, + "PiiEntity": { + "additionalProperties": false, + "description": "Entity name and behavior.", + "properties": { + "Action": { + "$ref": "#/definitions/SensitiveInformationAction" + }, + "Type": { + "$ref": "#/definitions/PiiEntityType" + } + }, + "required": [ + "Action", + "Type" + ], + "type": "object" + }, + "PiiEntityConfig": { + "additionalProperties": false, + "description": "Pii entity configuration.", + "properties": { + "Action": { + "$ref": "#/definitions/SensitiveInformationAction" + }, + "Type": { + "$ref": "#/definitions/PiiEntityType" + } + }, + "required": [ + "Action", + "Type" + ], + "type": "object" + }, + "PiiEntityType": { + "description": "The currently supported PII entities", + "enum": [ + "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" + ], + "type": "string" + }, + "RegexConfig": { + "additionalProperties": false, + "description": "A regex configuration.", + "properties": { + "Action": { + "$ref": "#/definitions/SensitiveInformationAction" + }, + "Description": { + "description": "The regex description.", + "maxLength": 1000, + "minLength": 1, + "type": "string" + }, + "Name": { + "description": "The regex name.", + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "Pattern": { + "description": "The regex pattern.", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Action", + "Name", + "Pattern" + ], + "type": "object" + }, + "SensitiveInformationAction": { + "description": "Options for sensitive information action.", + "enum": [ + "BLOCK", + "ANONYMIZE" + ], + "type": "string" + }, + "SensitiveInformationPolicyConfig": { + "additionalProperties": false, + "description": "Sensitive information policy config for a guardrail.", + "properties": { + "PiiEntitiesConfig": { + "description": "List of entities.", + "items": { + "$ref": "#/definitions/PiiEntityConfig" + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "RegexesConfig": { + "description": "List of regex.", + "items": { + "$ref": "#/definitions/RegexConfig" + }, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "Definition of the key/value pair for a tag", + "properties": { + "Key": { + "description": "Tag Key", + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$", + "type": "string" + }, + "Value": { + "description": "Tag Value", + "maxLength": 256, + "minLength": 0, + "pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "Topic": { + "additionalProperties": false, + "description": "Topic in topic policy.", + "properties": { + "Definition": { + "description": "Definition of topic in topic policy", + "maxLength": 200, + "minLength": 1, + "type": "string" + }, + "Examples": { + "description": "List of text examples", + "items": { + "description": "Text example in topic policy", + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "minItems": 0, + "type": "array" + }, + "Name": { + "description": "Name of topic in topic policy", + "maxLength": 100, + "minLength": 1, + "pattern": "^[0-9a-zA-Z-_ !?.]+$", + "type": "string" + }, + "Type": { + "$ref": "#/definitions/TopicType" + } + }, + "required": [ + "Definition", + "Name", + "Type" + ], + "type": "object" + }, + "TopicConfig": { + "additionalProperties": false, + "description": "Topic config in topic policy.", + "properties": { + "Definition": { + "description": "Definition of topic in topic policy", + "maxLength": 200, + "minLength": 1, + "type": "string" + }, + "Examples": { + "description": "List of text examples", + "items": { + "description": "Text example in topic policy", + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "minItems": 0, + "type": "array" + }, + "Name": { + "description": "Name of topic in topic policy", + "maxLength": 100, + "minLength": 1, + "pattern": "^[0-9a-zA-Z-_ !?.]+$", + "type": "string" + }, + "Type": { + "$ref": "#/definitions/TopicType" + } + }, + "required": [ + "Definition", + "Name", + "Type" + ], + "type": "object" + }, + "TopicPolicyConfig": { + "additionalProperties": false, + "description": "Topic policy config for a guardrail.", + "properties": { + "TopicsConfig": { + "description": "List of topic configs in topic policy.", + "items": { + "$ref": "#/definitions/TopicConfig" + }, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "TopicsConfig" + ], + "type": "object" + }, + "TopicType": { + "description": "Type of topic in a policy", + "enum": [ + "DENY" + ], + "type": "string" + }, + "WordConfig": { + "additionalProperties": false, + "description": "A custom word config.", + "properties": { + "Text": { + "description": "The custom word text.", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Text" + ], + "type": "object" + }, + "WordPolicyConfig": { + "additionalProperties": false, + "description": "Word policy config for a guardrail.", + "properties": { + "ManagedWordListsConfig": { + "description": "A config for the list of managed words.", + "items": { + "$ref": "#/definitions/ManagedWordsConfig" + }, + "type": "array" + }, + "WordsConfig": { + "description": "List of custom word configs.", + "items": { + "$ref": "#/definitions/WordConfig" + }, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + } + }, + "description": "Definition of AWS::Bedrock::Guardrail Resource Type", + "handlers": { + "create": { + "permissions": [ + "bedrock:CreateGuardrail", + "bedrock:GetGuardrail", + "kms:DescribeKey", + "kms:CreateGrant", + "kms:GenerateDataKey", + "kms:Decrypt", + "bedrock:TagResource", + "bedrock:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "bedrock:DeleteGuardrail", + "bedrock:GetGuardrail", + "kms:Decrypt", + "kms:RetireGrant" + ] + }, + "list": { + "permissions": [ + "bedrock:ListGuardrails" + ] + }, + "read": { + "permissions": [ + "bedrock:GetGuardrail", + "kms:Decrypt", + "bedrock:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "bedrock:UpdateGuardrail", + "bedrock:GetGuardrail", + "bedrock:ListTagsForResource", + "bedrock:TagResource", + "bedrock:UntagResource", + "kms:DescribeKey", + "kms:CreateGrant", + "kms:GenerateDataKey", + "kms:Decrypt" + ] + } + }, + "primaryIdentifier": [ + "/properties/GuardrailArn" + ], + "properties": { + "BlockedInputMessaging": { + "description": "Messaging for when violations are detected in text", + "maxLength": 500, + "minLength": 1, + "type": "string" + }, + "BlockedOutputsMessaging": { + "description": "Messaging for when violations are detected in text", + "maxLength": 500, + "minLength": 1, + "type": "string" + }, + "ContentPolicyConfig": { + "$ref": "#/definitions/ContentPolicyConfig" + }, + "CreatedAt": { + "description": "Time Stamp", + "format": "date-time", + "type": "string" + }, + "Description": { + "description": "Description of the guardrail or its version", + "maxLength": 200, + "minLength": 1, + "type": "string" + }, + "FailureRecommendations": { + "description": "List of failure recommendations", + "items": { + "description": "Recommendation for guardrail failure status", + "maxLength": 200, + "minLength": 1, + "type": "string" + }, + "maxItems": 100, + "type": "array" + }, + "GuardrailArn": { + "description": "Arn representation for the guardrail", + "maxLength": 2048, + "pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+$", + "type": "string" + }, + "GuardrailId": { + "description": "Unique id for the guardrail", + "maxLength": 64, + "pattern": "^[a-z0-9]+$", + "type": "string" + }, + "KmsKeyArn": { + "description": "The KMS key with which the guardrail was encrypted at rest", + "maxLength": 2048, + "minLength": 1, + "pattern": "^arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$", + "type": "string" + }, + "Name": { + "description": "Name of the guardrail", + "maxLength": 50, + "minLength": 1, + "pattern": "^[0-9a-zA-Z-_]+$", + "type": "string" + }, + "SensitiveInformationPolicyConfig": { + "$ref": "#/definitions/SensitiveInformationPolicyConfig" + }, + "Status": { + "$ref": "#/definitions/GuardrailStatus" + }, + "StatusReasons": { + "description": "List of status reasons", + "items": { + "description": "Reason for guardrail status", + "maxLength": 200, + "minLength": 1, + "type": "string" + }, + "maxItems": 100, + "type": "array" + }, + "Tags": { + "description": "List of Tags", + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "TopicPolicyConfig": { + "$ref": "#/definitions/TopicPolicyConfig" + }, + "UpdatedAt": { + "description": "Time Stamp", + "format": "date-time", + "type": "string" + }, + "Version": { + "description": "Guardrail version", + "pattern": "^(([1-9][0-9]{0,7})|(DRAFT))$", + "type": "string" + }, + "WordPolicyConfig": { + "$ref": "#/definitions/WordPolicyConfig" + } + }, + "readOnlyProperties": [ + "/properties/CreatedAt", + "/properties/FailureRecommendations", + "/properties/GuardrailArn", + "/properties/GuardrailId", + "/properties/Status", + "/properties/StatusReasons", + "/properties/UpdatedAt", + "/properties/Version" + ], + "required": [ + "Name", + "BlockedInputMessaging", + "BlockedOutputsMessaging" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Bedrock::Guardrail" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::Bedrock::KnowledgeBase.json b/artifacts/types/AWS::Bedrock::KnowledgeBase.json new file mode 100644 index 00000000..041fce6c --- /dev/null +++ b/artifacts/types/AWS::Bedrock::KnowledgeBase.json @@ -0,0 +1,509 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Bedrock-KnowledgeBase", + "type": "AWS::Bedrock::KnowledgeBase", + "time": "2024-06-11T01:12:47.122Z", + "schema": { + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/StorageConfiguration", + "/properties/KnowledgeBaseConfiguration" + ], + "definitions": { + "KnowledgeBaseConfiguration": { + "additionalProperties": false, + "description": "Contains details about the embeddings model used for the knowledge base.", + "properties": { + "Type": { + "$ref": "#/definitions/KnowledgeBaseType" + }, + "VectorKnowledgeBaseConfiguration": { + "$ref": "#/definitions/VectorKnowledgeBaseConfiguration" + } + }, + "required": [ + "Type", + "VectorKnowledgeBaseConfiguration" + ], + "type": "object" + }, + "KnowledgeBaseStatus": { + "description": "The status of a knowledge base.", + "enum": [ + "CREATING", + "ACTIVE", + "DELETING", + "UPDATING", + "FAILED", + "DELETE_UNSUCCESSFUL" + ], + "type": "string" + }, + "KnowledgeBaseStorageType": { + "description": "The storage type of a knowledge base.", + "enum": [ + "OPENSEARCH_SERVERLESS", + "PINECONE", + "RDS" + ], + "type": "string" + }, + "KnowledgeBaseType": { + "description": "The type of a knowledge base.", + "enum": [ + "VECTOR" + ], + "type": "string" + }, + "OpenSearchServerlessConfiguration": { + "additionalProperties": false, + "description": "Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.", + "properties": { + "CollectionArn": { + "description": "The ARN of the OpenSearch Service vector store.", + "maxLength": 2048, + "pattern": "^arn:aws:aoss:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:collection/[a-z0-9-]{3,32}$", + "type": "string" + }, + "FieldMapping": { + "$ref": "#/definitions/OpenSearchServerlessFieldMapping" + }, + "VectorIndexName": { + "description": "The name of the vector store.", + "maxLength": 2048, + "pattern": "^.*$", + "type": "string" + } + }, + "required": [ + "CollectionArn", + "FieldMapping", + "VectorIndexName" + ], + "type": "object" + }, + "OpenSearchServerlessFieldMapping": { + "additionalProperties": false, + "description": "A mapping of Bedrock Knowledge Base fields to OpenSearch Serverless field names", + "properties": { + "MetadataField": { + "description": "The name of the field in which Amazon Bedrock stores metadata about the vector store.", + "maxLength": 2048, + "pattern": "^.*$", + "type": "string" + }, + "TextField": { + "description": "The 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.", + "maxLength": 2048, + "pattern": "^.*$", + "type": "string" + }, + "VectorField": { + "description": "The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.", + "maxLength": 2048, + "pattern": "^.*$", + "type": "string" + } + }, + "required": [ + "MetadataField", + "TextField", + "VectorField" + ], + "type": "object" + }, + "PineconeConfiguration": { + "additionalProperties": false, + "description": "Contains the storage configuration of the knowledge base in Pinecone.", + "properties": { + "ConnectionString": { + "description": "The endpoint URL for your index management page.", + "maxLength": 2048, + "pattern": "^.*$", + "type": "string" + }, + "CredentialsSecretArn": { + "description": "The ARN of the secret that you created in AWS Secrets Manager that is linked to your Pinecone API key.", + "pattern": "^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$", + "type": "string" + }, + "FieldMapping": { + "$ref": "#/definitions/PineconeFieldMapping" + }, + "Namespace": { + "description": "The namespace to be used to write new data to your database.", + "maxLength": 2048, + "pattern": "^.*$", + "type": "string" + } + }, + "required": [ + "ConnectionString", + "CredentialsSecretArn", + "FieldMapping" + ], + "type": "object" + }, + "PineconeFieldMapping": { + "additionalProperties": false, + "description": "Contains the names of the fields to which to map information about the vector store.", + "properties": { + "MetadataField": { + "description": "The name of the field in which Amazon Bedrock stores metadata about the vector store.", + "maxLength": 2048, + "pattern": "^.*$", + "type": "string" + }, + "TextField": { + "description": "The 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.", + "maxLength": 2048, + "pattern": "^.*$", + "type": "string" + } + }, + "required": [ + "MetadataField", + "TextField" + ], + "type": "object" + }, + "RdsConfiguration": { + "additionalProperties": false, + "description": "Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS.", + "properties": { + "CredentialsSecretArn": { + "description": "The ARN of the secret that you created in AWS Secrets Manager that is linked to your Amazon RDS database.", + "pattern": "^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$", + "type": "string" + }, + "DatabaseName": { + "description": "The name of your Amazon RDS database.", + "maxLength": 63, + "pattern": "^[a-zA-Z0-9_\\-]+$", + "type": "string" + }, + "FieldMapping": { + "$ref": "#/definitions/RdsFieldMapping" + }, + "ResourceArn": { + "description": "The ARN of the vector store.", + "pattern": "^arn:aws(|-cn|-us-gov):rds:[a-zA-Z0-9-]*:[0-9]{12}:cluster:[a-zA-Z0-9-]{1,63}$", + "type": "string" + }, + "TableName": { + "description": "The name of the table in the database.", + "maxLength": 63, + "pattern": "^[a-zA-Z0-9_\\.\\-]+$", + "type": "string" + } + }, + "required": [ + "CredentialsSecretArn", + "DatabaseName", + "FieldMapping", + "ResourceArn", + "TableName" + ], + "type": "object" + }, + "RdsFieldMapping": { + "additionalProperties": false, + "description": "Contains the names of the fields to which to map information about the vector store.", + "properties": { + "MetadataField": { + "description": "The name of the field in which Amazon Bedrock stores metadata about the vector store.", + "maxLength": 63, + "pattern": "^[a-zA-Z0-9_\\-]+$", + "type": "string" + }, + "PrimaryKeyField": { + "description": "The name of the field in which Amazon Bedrock stores the ID for each entry.", + "maxLength": 63, + "pattern": "^[a-zA-Z0-9_\\-]+$", + "type": "string" + }, + "TextField": { + "description": "The 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.", + "maxLength": 63, + "pattern": "^[a-zA-Z0-9_\\-]+$", + "type": "string" + }, + "VectorField": { + "description": "The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.", + "maxLength": 63, + "pattern": "^[a-zA-Z0-9_\\-]+$", + "type": "string" + } + }, + "required": [ + "MetadataField", + "PrimaryKeyField", + "TextField", + "VectorField" + ], + "type": "object" + }, + "RedisEnterpriseCloudConfiguration": { + "additionalProperties": false, + "description": "Contains the storage configuration of the knowledge base in Redis Enterprise Cloud.", + "properties": { + "CredentialsSecretArn": { + "description": "The ARN of the secret that you created in AWS Secrets Manager that is linked to your Redis Enterprise Cloud database.", + "pattern": "^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$", + "type": "string" + }, + "Endpoint": { + "description": "The endpoint URL of the Redis Enterprise Cloud database.", + "maxLength": 2048, + "pattern": "^.*$", + "type": "string" + }, + "FieldMapping": { + "$ref": "#/definitions/RedisEnterpriseCloudFieldMapping" + }, + "VectorIndexName": { + "description": "The name of the vector index.", + "maxLength": 2048, + "pattern": "^.*$", + "type": "string" + } + }, + "required": [ + "CredentialsSecretArn", + "Endpoint", + "FieldMapping", + "VectorIndexName" + ], + "type": "object" + }, + "RedisEnterpriseCloudFieldMapping": { + "additionalProperties": false, + "description": "Contains the names of the fields to which to map information about the vector store.", + "properties": { + "MetadataField": { + "description": "The name of the field in which Amazon Bedrock stores metadata about the vector store.", + "maxLength": 2048, + "pattern": "^.*$", + "type": "string" + }, + "TextField": { + "description": "The 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.", + "maxLength": 2048, + "pattern": "^.*$", + "type": "string" + }, + "VectorField": { + "description": "The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.", + "maxLength": 2048, + "pattern": "^.*$", + "type": "string" + } + }, + "required": [ + "MetadataField", + "TextField", + "VectorField" + ], + "type": "object" + }, + "StorageConfiguration": { + "additionalProperties": false, + "description": "The vector store service in which the knowledge base is stored.", + "oneOf": [ + { + "required": [ + "OpensearchServerlessConfiguration" + ] + }, + { + "required": [ + "PineconeConfiguration" + ] + }, + { + "required": [ + "RdsConfiguration" + ] + } + ], + "properties": { + "OpensearchServerlessConfiguration": { + "$ref": "#/definitions/OpenSearchServerlessConfiguration" + }, + "PineconeConfiguration": { + "$ref": "#/definitions/PineconeConfiguration" + }, + "RdsConfiguration": { + "$ref": "#/definitions/RdsConfiguration" + }, + "Type": { + "$ref": "#/definitions/KnowledgeBaseStorageType" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "TagsMap": { + "additionalProperties": false, + "description": "A map of tag keys and values", + "patternProperties": { + "^[a-zA-Z0-9\\s._:/=+@-]*$": { + "description": "Value of a tag", + "maxLength": 256, + "minLength": 0, + "pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$", + "type": "string" + } + }, + "type": "object" + }, + "VectorKnowledgeBaseConfiguration": { + "additionalProperties": false, + "description": "Contains details about the model used to create vector embeddings for the knowledge base.", + "properties": { + "EmbeddingModelArn": { + "description": "The ARN of the model used to create vector embeddings for the knowledge base.", + "maxLength": 2048, + "minLength": 20, + "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]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|([0-9]{12}:provisioned-model/[a-z0-9]{12})))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|(([0-9a-zA-Z][_-]?)+)$", + "type": "string" + } + }, + "required": [ + "EmbeddingModelArn" + ], + "type": "object" + } + }, + "description": "Definition of AWS::Bedrock::KnowledgeBase Resource Type", + "handlers": { + "create": { + "permissions": [ + "bedrock:CreateKnowledgeBase", + "bedrock:GetKnowledgeBase", + "bedrock:TagResource", + "bedrock:ListTagsForResource", + "bedrock:AssociateThirdPartyKnowledgeBase", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "bedrock:GetKnowledgeBase", + "bedrock:DeleteKnowledgeBase", + "bedrock:ListDataSources" + ] + }, + "list": { + "permissions": [ + "bedrock:ListKnowledgeBases" + ] + }, + "read": { + "permissions": [ + "bedrock:GetKnowledgeBase", + "bedrock:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "bedrock:GetKnowledgeBase", + "bedrock:UpdateKnowledgeBase", + "bedrock:TagResource", + "bedrock:UntagResource", + "bedrock:ListTagsForResource", + "bedrock:AssociateThirdPartyKnowledgeBase", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/KnowledgeBaseId" + ], + "properties": { + "CreatedAt": { + "description": "The time at which the knowledge base was created.", + "type": "string" + }, + "Description": { + "description": "Description of the Resource.", + "maxLength": 200, + "minLength": 1, + "type": "string" + }, + "FailureReasons": { + "description": "A list of reasons that the API operation on the knowledge base failed.", + "insertionOrder": false, + "items": { + "description": "Failure Reason for Error.", + "maxLength": 2048, + "type": "string" + }, + "maxItems": 2048, + "type": "array" + }, + "KnowledgeBaseArn": { + "description": "The ARN of the knowledge base.", + "maxLength": 128, + "minLength": 0, + "pattern": "^arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:knowledge-base/[0-9a-zA-Z]+$", + "type": "string" + }, + "KnowledgeBaseConfiguration": { + "$ref": "#/definitions/KnowledgeBaseConfiguration" + }, + "KnowledgeBaseId": { + "description": "The unique identifier of the knowledge base.", + "pattern": "^[0-9a-zA-Z]{10}$", + "type": "string" + }, + "Name": { + "description": "The name of the knowledge base.", + "pattern": "^([0-9a-zA-Z][_-]?){1,100}$", + "type": "string" + }, + "RoleArn": { + "description": "The ARN of the IAM role with permissions to invoke API operations on the knowledge base. The ARN must begin with AmazonBedrockExecutionRoleForKnowledgeBase_", + "maxLength": 2048, + "pattern": "^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+$", + "type": "string" + }, + "Status": { + "$ref": "#/definitions/KnowledgeBaseStatus" + }, + "StorageConfiguration": { + "$ref": "#/definitions/StorageConfiguration" + }, + "Tags": { + "$ref": "#/definitions/TagsMap" + }, + "UpdatedAt": { + "description": "The time at which the knowledge base was last updated.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/KnowledgeBaseId", + "/properties/KnowledgeBaseArn", + "/properties/CreatedAt", + "/properties/UpdatedAt", + "/properties/FailureReasons", + "/properties/Status" + ], + "required": [ + "KnowledgeBaseConfiguration", + "Name", + "RoleArn", + "StorageConfiguration" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Bedrock::KnowledgeBase" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::Budgets::BudgetsAction.json b/artifacts/types/AWS::Budgets::BudgetsAction.json index 0c879eb7..688ae810 100644 --- a/artifacts/types/AWS::Budgets::BudgetsAction.json +++ b/artifacts/types/AWS::Budgets::BudgetsAction.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Budgets-BudgetsAction", "type": "AWS::Budgets::BudgetsAction", - "time": "2023-02-07T16:44:46.958Z", + "time": "2024-06-12T15:31:11.842Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -80,6 +80,22 @@ ], "type": "object" }, + "ResourceTag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, "ScpActionDefinition": { "additionalProperties": false, "properties": { @@ -156,7 +172,8 @@ "create": { "permissions": [ "budgets:CreateBudgetAction", - "iam:PassRole" + "iam:PassRole", + "budgets:TagResource" ] }, "delete": { @@ -172,13 +189,17 @@ }, "read": { "permissions": [ - "budgets:DescribeBudgetAction" + "budgets:DescribeBudgetAction", + "budgets:ListTagsForResource" ] }, "update": { "permissions": [ "budgets:UpdateBudgetAction", - "iam:PassRole" + "iam:PassRole", + "budgets:TagResource", + "budgets:UntagResource", + "budgets:ListTagsForResource" ] } }, @@ -224,6 +245,12 @@ ], "type": "string" }, + "ResourceTags": { + "items": { + "$ref": "#/definitions/ResourceTag" + }, + "type": "array" + }, "Subscribers": { "items": { "$ref": "#/definitions/Subscriber" @@ -246,6 +273,13 @@ "Subscribers" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/ResourceTags", + "tagUpdatable": true, + "taggable": true + }, "typeName": "AWS::Budgets::BudgetsAction" } } \ No newline at end of file diff --git a/artifacts/types/AWS::CE::AnomalyMonitor.json b/artifacts/types/AWS::CE::AnomalyMonitor.json index eae5200c..ac5c0012 100644 --- a/artifacts/types/AWS::CE::AnomalyMonitor.json +++ b/artifacts/types/AWS::CE::AnomalyMonitor.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-CE-AnomalyMonitor", "type": "AWS::CE::AnomalyMonitor", - "time": "2023-12-27T17:05:41.023Z", + "time": "2024-05-14T15:28:30.037Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::CE::AnomalySubscription.json b/artifacts/types/AWS::CE::AnomalySubscription.json index 6160a31c..6bf7fad8 100644 --- a/artifacts/types/AWS::CE::AnomalySubscription.json +++ b/artifacts/types/AWS::CE::AnomalySubscription.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-CE-AnomalySubscription", "type": "AWS::CE::AnomalySubscription", - "time": "2023-12-27T17:04:39.853Z", + "time": "2024-05-14T15:28:24.964Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::CE::CostCategory.json b/artifacts/types/AWS::CE::CostCategory.json index 8eee1d53..6fe972a8 100644 --- a/artifacts/types/AWS::CE::CostCategory.json +++ b/artifacts/types/AWS::CE::CostCategory.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-CE-CostCategory", "type": "AWS::CE::CostCategory", - "time": "2024-01-02T17:25:18.866Z", + "time": "2024-06-10T15:54:34.807Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Cassandra::Keyspace.json b/artifacts/types/AWS::Cassandra::Keyspace.json index 628edf76..711448b9 100644 --- a/artifacts/types/AWS::Cassandra::Keyspace.json +++ b/artifacts/types/AWS::Cassandra::Keyspace.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Cassandra-Keyspace", "type": "AWS::Cassandra::Keyspace", - "time": "2024-01-04T19:46:45.482Z", + "time": "2024-06-19T21:56:33.184Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Cassandra::Table.json b/artifacts/types/AWS::Cassandra::Table.json index c350b825..a6b0eb4f 100644 --- a/artifacts/types/AWS::Cassandra::Table.json +++ b/artifacts/types/AWS::Cassandra::Table.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Cassandra-Table", "type": "AWS::Cassandra::Table", - "time": "2024-01-04T17:48:44.665Z", + "time": "2024-06-19T21:39:47.858Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -12,6 +12,41 @@ "/properties/ClientSideTimestampsEnabled" ], "definitions": { + "AutoScalingSetting": { + "additionalProperties": false, + "description": "Represents configuration for auto scaling.", + "properties": { + "AutoScalingDisabled": { + "default": false, + "type": "boolean" + }, + "MaximumUnits": { + "minimum": 1, + "type": "integer" + }, + "MinimumUnits": { + "minimum": 1, + "type": "integer" + }, + "ScalingPolicy": { + "$ref": "#/definitions/ScalingPolicy" + } + }, + "type": "object" + }, + "AutoScalingSpecification": { + "additionalProperties": false, + "description": "Represents the read and write settings used for AutoScaling.", + "properties": { + "ReadCapacityAutoScaling": { + "$ref": "#/definitions/AutoScalingSetting" + }, + "WriteCapacityAutoScaling": { + "$ref": "#/definitions/AutoScalingSetting" + } + }, + "type": "object" + }, "BillingMode": { "additionalProperties": false, "properties": { @@ -121,6 +156,37 @@ ], "type": "object" }, + "ReplicaSpecification": { + "additionalProperties": false, + "description": "Represents replica specifications.", + "properties": { + "ReadCapacityAutoScaling": { + "$ref": "#/definitions/AutoScalingSetting" + }, + "ReadCapacityUnits": { + "type": "integer" + }, + "Region": { + "maxLength": 25, + "minLength": 2, + "type": "string" + } + }, + "required": [ + "Region" + ], + "type": "object" + }, + "ScalingPolicy": { + "additionalProperties": false, + "description": "Represents scaling policy.", + "properties": { + "TargetTrackingScalingPolicyConfiguration": { + "$ref": "#/definitions/TargetTrackingScalingPolicyConfiguration" + } + }, + "type": "object" + }, "Tag": { "additionalProperties": false, "description": "A key-value pair to apply to the resource", @@ -141,6 +207,31 @@ "Key" ], "type": "object" + }, + "TargetTrackingScalingPolicyConfiguration": { + "additionalProperties": false, + "description": "Represents configuration for target tracking scaling policy.", + "properties": { + "DisableScaleIn": { + "default": "false", + "type": "boolean" + }, + "ScaleInCooldown": { + "default": 0, + "type": "integer" + }, + "ScaleOutCooldown": { + "default": 0, + "type": "integer" + }, + "TargetValue": { + "type": "integer" + } + }, + "required": [ + "TargetValue" + ], + "type": "object" } }, "description": "Resource schema for AWS::Cassandra::Table", @@ -156,7 +247,16 @@ "kms:CreateGrant", "kms:DescribeKey", "kms:Encrypt", - "kms:Decrypt" + "kms:Decrypt", + "application-autoscaling:DescribeScalableTargets", + "application-autoscaling:DescribeScalingPolicies", + "application-autoscaling:DeregisterScalableTarget", + "application-autoscaling:RegisterScalableTarget", + "application-autoscaling:PutScalingPolicy", + "cloudwatch:DeleteAlarms", + "cloudwatch:DescribeAlarms", + "cloudwatch:GetMetricData", + "cloudwatch:PutMetricAlarm" ] }, "delete": { @@ -164,19 +264,46 @@ "cassandra:Drop", "cassandra:DropMultiRegionResource", "cassandra:Select", - "cassandra:SelectMultiRegionResource" + "cassandra:SelectMultiRegionResource", + "application-autoscaling:DescribeScalableTargets", + "application-autoscaling:DescribeScalingPolicies", + "application-autoscaling:DeregisterScalableTarget", + "application-autoscaling:RegisterScalableTarget", + "application-autoscaling:PutScalingPolicy", + "cloudwatch:DeleteAlarms", + "cloudwatch:DescribeAlarms", + "cloudwatch:GetMetricData", + "cloudwatch:PutMetricAlarm" ] }, "list": { "permissions": [ "cassandra:Select", - "cassandra:SelectMultiRegionResource" + "cassandra:SelectMultiRegionResource", + "application-autoscaling:DescribeScalableTargets", + "application-autoscaling:DescribeScalingPolicies", + "application-autoscaling:DeregisterScalableTarget", + "application-autoscaling:RegisterScalableTarget", + "application-autoscaling:PutScalingPolicy", + "cloudwatch:DeleteAlarms", + "cloudwatch:DescribeAlarms", + "cloudwatch:GetMetricData", + "cloudwatch:PutMetricAlarm" ] }, "read": { "permissions": [ "cassandra:Select", - "cassandra:SelectMultiRegionResource" + "cassandra:SelectMultiRegionResource", + "application-autoscaling:DescribeScalableTargets", + "application-autoscaling:DescribeScalingPolicies", + "application-autoscaling:DeregisterScalableTarget", + "application-autoscaling:RegisterScalableTarget", + "application-autoscaling:PutScalingPolicy", + "cloudwatch:DeleteAlarms", + "cloudwatch:DescribeAlarms", + "cloudwatch:GetMetricData", + "cloudwatch:PutMetricAlarm" ] }, "update": { @@ -192,7 +319,16 @@ "kms:CreateGrant", "kms:DescribeKey", "kms:Encrypt", - "kms:Decrypt" + "kms:Decrypt", + "application-autoscaling:DescribeScalableTargets", + "application-autoscaling:DescribeScalingPolicies", + "application-autoscaling:DeregisterScalableTarget", + "application-autoscaling:RegisterScalableTarget", + "application-autoscaling:PutScalingPolicy", + "cloudwatch:DeleteAlarms", + "cloudwatch:DescribeAlarms", + "cloudwatch:GetMetricData", + "cloudwatch:PutMetricAlarm" ] } }, @@ -201,6 +337,9 @@ "/properties/TableName" ], "properties": { + "AutoScalingSpecifications": { + "$ref": "#/definitions/AutoScalingSpecification" + }, "BillingMode": { "$ref": "#/definitions/BillingMode" }, @@ -253,6 +392,15 @@ "type": "array", "uniqueItems": true }, + "ReplicaSpecifications": { + "insertionOrder": true, + "items": { + "$ref": "#/definitions/ReplicaSpecification" + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, "TableName": { "description": "Name for Cassandra table", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_]{1,47}$", @@ -273,6 +421,10 @@ "KeyspaceName", "PartitionKeyColumns" ], - "typeName": "AWS::Cassandra::Table" + "typeName": "AWS::Cassandra::Table", + "writeOnlyProperties": [ + "/properties/AutoScalingSpecifications", + "/properties/ReplicaSpecifications" + ] } } \ No newline at end of file diff --git a/artifacts/types/AWS::CertificateManager::Account.json b/artifacts/types/AWS::CertificateManager::Account.json index a514f2af..9fbb7608 100644 --- a/artifacts/types/AWS::CertificateManager::Account.json +++ b/artifacts/types/AWS::CertificateManager::Account.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-CertificateManager-Account", "type": "AWS::CertificateManager::Account", - "time": "2024-01-04T16:12:41.681Z", + "time": "2024-05-09T15:13:19.929Z", "schema": { "additionalProperties": false, "definitions": { diff --git a/artifacts/types/AWS::Chatbot::MicrosoftTeamsChannelConfiguration.json b/artifacts/types/AWS::Chatbot::MicrosoftTeamsChannelConfiguration.json index 9c87b10d..56675912 100644 --- a/artifacts/types/AWS::Chatbot::MicrosoftTeamsChannelConfiguration.json +++ b/artifacts/types/AWS::Chatbot::MicrosoftTeamsChannelConfiguration.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Chatbot-MicrosoftTeamsChannelConfiguration", "type": "AWS::Chatbot::MicrosoftTeamsChannelConfiguration", - "time": "2024-01-04T19:09:41.286Z", + "time": "2024-06-24T19:57:31.828Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -9,11 +9,30 @@ "/properties/TeamsTenantId", "/properties/ConfigurationName" ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, "description": "Resource schema for AWS::Chatbot::MicrosoftTeamsChannelConfiguration.", "handlers": { "create": { "permissions": [ "chatbot:CreateMicrosoftTeamsChannelConfiguration", + "chatbot:TagResource", "iam:PassRole", "iam:CreateServiceLinkedRole" ] @@ -37,6 +56,9 @@ "update": { "permissions": [ "chatbot:UpdateMicrosoftTeamsChannelConfiguration", + "chatbot:TagResource", + "chatbot:UntagResource", + "chatbot:ListTagsForResource", "iam:PassRole" ] } @@ -86,6 +108,15 @@ }, "type": "array" }, + "Tags": { + "description": "The tags to add to the configuration", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, "TeamId": { "description": "The id of the Microsoft Teams team", "maxLength": 36, @@ -125,7 +156,11 @@ ], "sourceUrl": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-microsoftteamschannelconfiguration.html", "tagging": { - "taggable": false + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true }, "typeName": "AWS::Chatbot::MicrosoftTeamsChannelConfiguration" } diff --git a/artifacts/types/AWS::Chatbot::SlackChannelConfiguration.json b/artifacts/types/AWS::Chatbot::SlackChannelConfiguration.json index 3bed5f2f..56d38109 100644 --- a/artifacts/types/AWS::Chatbot::SlackChannelConfiguration.json +++ b/artifacts/types/AWS::Chatbot::SlackChannelConfiguration.json @@ -1,18 +1,37 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Chatbot-SlackChannelConfiguration", "type": "AWS::Chatbot::SlackChannelConfiguration", - "time": "2024-01-04T19:09:53.179Z", + "time": "2024-06-24T19:57:27.352Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ "/properties/SlackWorkspaceId", "/properties/ConfigurationName" ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, "description": "Resource schema for AWS::Chatbot::SlackChannelConfiguration.", "handlers": { "create": { "permissions": [ "chatbot:CreateSlackChannelConfiguration", + "chatbot:TagResource", "iam:PassRole", "iam:CreateServiceLinkedRole" ] @@ -35,6 +54,9 @@ "update": { "permissions": [ "chatbot:UpdateSlackChannelConfiguration", + "chatbot:TagResource", + "chatbot:UntagResource", + "chatbot:ListTagsForResource", "iam:PassRole" ] } @@ -98,6 +120,15 @@ }, "type": "array" }, + "Tags": { + "description": "The tags to add to the configuration", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, "UserRoleRequired": { "default": false, "description": "Enables use of a user role requirement in your chat configuration", @@ -114,6 +145,13 @@ "IamRoleArn" ], "sourceUrl": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, "typeName": "AWS::Chatbot::SlackChannelConfiguration" } } \ No newline at end of file diff --git a/artifacts/types/AWS::CleanRooms::AnalysisTemplate.json b/artifacts/types/AWS::CleanRooms::AnalysisTemplate.json index 02877855..c95cc047 100644 --- a/artifacts/types/AWS::CleanRooms::AnalysisTemplate.json +++ b/artifacts/types/AWS::CleanRooms::AnalysisTemplate.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-CleanRooms-AnalysisTemplate", "type": "AWS::CleanRooms::AnalysisTemplate", - "time": "2024-01-03T01:02:51.385Z", + "time": "2024-06-17T20:14:02.847Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::CleanRooms::Collaboration.json b/artifacts/types/AWS::CleanRooms::Collaboration.json index 76af9dd5..a75ec574 100644 --- a/artifacts/types/AWS::CleanRooms::Collaboration.json +++ b/artifacts/types/AWS::CleanRooms::Collaboration.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-CleanRooms-Collaboration", "type": "AWS::CleanRooms::Collaboration", - "time": "2024-01-03T00:59:47.595Z", + "time": "2024-06-17T20:10:57.437Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::CleanRooms::ConfiguredTable.json b/artifacts/types/AWS::CleanRooms::ConfiguredTable.json index bcc73063..f0a21684 100644 --- a/artifacts/types/AWS::CleanRooms::ConfiguredTable.json +++ b/artifacts/types/AWS::CleanRooms::ConfiguredTable.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-CleanRooms-ConfiguredTable", "type": "AWS::CleanRooms::ConfiguredTable", - "time": "2024-01-03T01:21:08.004Z", + "time": "2024-06-24T20:10:04.401Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -194,6 +194,9 @@ }, "AllowedAnalysisProviders": { "$ref": "#/definitions/AllowedAnalysisProviders" + }, + "DifferentialPrivacy": { + "$ref": "#/definitions/DifferentialPrivacy" } }, "required": [ @@ -298,6 +301,35 @@ ], "type": "string" }, + "DifferentialPrivacy": { + "additionalProperties": false, + "properties": { + "Columns": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/DifferentialPrivacyColumn" + }, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "Columns" + ], + "type": "object" + }, + "DifferentialPrivacyColumn": { + "additionalProperties": false, + "properties": { + "Name": { + "type": "string" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, "GlueTableReference": { "additionalProperties": false, "properties": { @@ -345,7 +377,18 @@ "LOWER", "RTRIM", "UPPER", - "COALESCE" + "COALESCE", + "CONVERT", + "CURRENT_DATE", + "DATEADD", + "EXTRACT", + "GETDATE", + "SUBSTRING", + "TO_CHAR", + "TO_DATE", + "TO_NUMBER", + "TO_TIMESTAMP", + "TRIM" ], "type": "string" }, diff --git a/artifacts/types/AWS::CleanRooms::ConfiguredTableAssociation.json b/artifacts/types/AWS::CleanRooms::ConfiguredTableAssociation.json index eba4ae23..48e01c22 100644 --- a/artifacts/types/AWS::CleanRooms::ConfiguredTableAssociation.json +++ b/artifacts/types/AWS::CleanRooms::ConfiguredTableAssociation.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-CleanRooms-ConfiguredTableAssociation", "type": "AWS::CleanRooms::ConfiguredTableAssociation", - "time": "2024-01-03T01:02:57.268Z", + "time": "2024-06-17T20:15:30.688Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::CleanRooms::Membership.json b/artifacts/types/AWS::CleanRooms::Membership.json index 9ebf6ed0..7dcb1610 100644 --- a/artifacts/types/AWS::CleanRooms::Membership.json +++ b/artifacts/types/AWS::CleanRooms::Membership.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-CleanRooms-Membership", "type": "AWS::CleanRooms::Membership", - "time": "2024-01-03T04:11:08.453Z", + "time": "2024-06-17T22:08:25.455Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::CleanRooms::PrivacyBudgetTemplate.json b/artifacts/types/AWS::CleanRooms::PrivacyBudgetTemplate.json new file mode 100644 index 00000000..ec05852a --- /dev/null +++ b/artifacts/types/AWS::CleanRooms::PrivacyBudgetTemplate.json @@ -0,0 +1,186 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-CleanRooms-PrivacyBudgetTemplate", + "type": "AWS::CleanRooms::PrivacyBudgetTemplate", + "time": "2024-06-17T20:13:53.173Z", + "schema": { + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/MembershipIdentifier", + "/properties/PrivacyBudgetType", + "/properties/AutoRefresh" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Represents a privacy budget within a collaboration", + "handlers": { + "create": { + "permissions": [ + "cleanrooms:CreatePrivacyBudgetTemplate", + "cleanrooms:ListTagsForResource", + "cleanrooms:TagResource", + "cleanrooms:GetPrivacyBudgetTemplate", + "cleanrooms:ListPrivacyBudgetTemplates" + ] + }, + "delete": { + "permissions": [ + "cleanrooms:DeletePrivacyBudgetTemplate", + "cleanrooms:GetPrivacyBudgetTemplate", + "cleanrooms:ListPrivacyBudgetTemplates", + "cleanrooms:ListTagsForResource", + "cleanrooms:UntagResource" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "MembershipIdentifier": { + "$ref": "resource-schema.json#/properties/MembershipIdentifier" + } + }, + "required": [ + "MembershipIdentifier" + ] + }, + "permissions": [ + "cleanrooms:ListPrivacyBudgetTemplates" + ] + }, + "read": { + "permissions": [ + "cleanrooms:GetPrivacyBudgetTemplate", + "cleanrooms:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "cleanrooms:UpdatePrivacyBudgetTemplate", + "cleanrooms:GetPrivacyBudgetTemplate", + "cleanrooms:ListTagsForResource", + "cleanrooms:TagResource", + "cleanrooms:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/PrivacyBudgetTemplateIdentifier", + "/properties/MembershipIdentifier" + ], + "properties": { + "Arn": { + "maxLength": 200, + "type": "string" + }, + "AutoRefresh": { + "enum": [ + "CALENDAR_MONTH", + "NONE" + ], + "type": "string" + }, + "CollaborationArn": { + "maxLength": 100, + "type": "string" + }, + "CollaborationIdentifier": { + "maxLength": 36, + "minLength": 36, + "pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}", + "type": "string" + }, + "MembershipArn": { + "maxLength": 100, + "type": "string" + }, + "MembershipIdentifier": { + "maxLength": 36, + "minLength": 36, + "pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}", + "type": "string" + }, + "Parameters": { + "additionalProperties": false, + "properties": { + "Epsilon": { + "maximum": 20, + "minimum": 1, + "type": "integer" + }, + "UsersNoisePerQuery": { + "maximum": 100, + "minimum": 10, + "type": "integer" + } + }, + "required": [ + "Epsilon", + "UsersNoisePerQuery" + ], + "type": "object" + }, + "PrivacyBudgetTemplateIdentifier": { + "maxLength": 36, + "minLength": 36, + "pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}", + "type": "string" + }, + "PrivacyBudgetType": { + "enum": [ + "DIFFERENTIAL_PRIVACY" + ], + "type": "string" + }, + "Tags": { + "description": "An arbitrary set of tags (key-value pairs) for this cleanrooms privacy budget template.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/CollaborationArn", + "/properties/CollaborationIdentifier", + "/properties/PrivacyBudgetTemplateIdentifier", + "/properties/Arn", + "/properties/MembershipArn" + ], + "replacementStrategy": "delete_then_create", + "required": [ + "AutoRefresh", + "PrivacyBudgetType", + "Parameters", + "MembershipIdentifier" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-cleanrooms", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::CleanRooms::PrivacyBudgetTemplate" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::CleanRoomsML::TrainingDataset.json b/artifacts/types/AWS::CleanRoomsML::TrainingDataset.json new file mode 100644 index 00000000..177761e7 --- /dev/null +++ b/artifacts/types/AWS::CleanRoomsML::TrainingDataset.json @@ -0,0 +1,260 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-CleanRoomsML-TrainingDataset", + "type": "AWS::CleanRoomsML::TrainingDataset", + "time": "2024-06-20T20:10:19.626Z", + "schema": { + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Description", + "/properties/Name", + "/properties/RoleArn", + "/properties/TrainingData" + ], + "definitions": { + "ColumnSchema": { + "additionalProperties": false, + "properties": { + "ColumnName": { + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?$", + "type": "string" + }, + "ColumnTypes": { + "items": { + "$ref": "#/definitions/ColumnType" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "ColumnName", + "ColumnTypes" + ], + "type": "object" + }, + "ColumnType": { + "enum": [ + "USER_ID", + "ITEM_ID", + "TIMESTAMP", + "CATEGORICAL_FEATURE", + "NUMERICAL_FEATURE" + ], + "type": "string" + }, + "DataSource": { + "additionalProperties": false, + "properties": { + "GlueDataSource": { + "$ref": "#/definitions/GlueDataSource" + } + }, + "required": [ + "GlueDataSource" + ], + "type": "object" + }, + "Dataset": { + "additionalProperties": false, + "properties": { + "InputConfig": { + "$ref": "#/definitions/DatasetInputConfig" + }, + "Type": { + "$ref": "#/definitions/DatasetType" + } + }, + "required": [ + "InputConfig", + "Type" + ], + "type": "object" + }, + "DatasetInputConfig": { + "additionalProperties": false, + "properties": { + "DataSource": { + "$ref": "#/definitions/DataSource" + }, + "Schema": { + "items": { + "$ref": "#/definitions/ColumnSchema" + }, + "maxItems": 100, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "DataSource", + "Schema" + ], + "type": "object" + }, + "DatasetType": { + "enum": [ + "INTERACTIONS" + ], + "type": "string" + }, + "GlueDataSource": { + "additionalProperties": false, + "properties": { + "CatalogId": { + "maxLength": 12, + "minLength": 12, + "pattern": "^[0-9]{12}$", + "type": "string" + }, + "DatabaseName": { + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_](([a-zA-Z0-9_]+-)*([a-zA-Z0-9_]+))?$", + "type": "string" + }, + "TableName": { + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?$", + "type": "string" + } + }, + "required": [ + "DatabaseName", + "TableName" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "TrainingDatasetStatus": { + "enum": [ + "ACTIVE" + ], + "type": "string" + }, + "Unit": { + "additionalProperties": false, + "type": "object" + } + }, + "description": "Definition of AWS::CleanRoomsML::TrainingDataset Resource Type", + "handlers": { + "create": { + "permissions": [ + "cleanrooms-ml:CreateTrainingDataset", + "cleanrooms-ml:GetTrainingDataset", + "cleanrooms-ml:TagResource", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "cleanrooms-ml:DeleteTrainingDataset" + ] + }, + "list": { + "permissions": [ + "cleanrooms-ml:ListTrainingDatasets" + ] + }, + "read": { + "permissions": [ + "cleanrooms-ml:GetTrainingDataset" + ] + }, + "update": { + "permissions": [ + "cleanrooms-ml:TagResource", + "cleanrooms-ml:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/TrainingDatasetArn" + ], + "properties": { + "Description": { + "maxLength": 255, + "pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t\\r\\n]*$", + "type": "string" + }, + "Name": { + "maxLength": 63, + "minLength": 1, + "pattern": "^(?!\\s*$)[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t]*$", + "type": "string" + }, + "RoleArn": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:aws[-a-z]*:iam::[0-9]{12}:role/.+$", + "type": "string" + }, + "Status": { + "$ref": "#/definitions/TrainingDatasetStatus" + }, + "Tags": { + "description": "An arbitrary set of tags (key-value pairs) for this cleanrooms-ml training dataset.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "TrainingData": { + "items": { + "$ref": "#/definitions/Dataset" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + }, + "TrainingDatasetArn": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:training-dataset/[-a-zA-Z0-9_/.]+$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Status", + "/properties/TrainingDatasetArn" + ], + "required": [ + "Name", + "RoleArn", + "TrainingData" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::CleanRoomsML::TrainingDataset" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::CloudFormation::HookDefaultVersion.json b/artifacts/types/AWS::CloudFormation::HookDefaultVersion.json index 28bb9586..73620d2b 100644 --- a/artifacts/types/AWS::CloudFormation::HookDefaultVersion.json +++ b/artifacts/types/AWS::CloudFormation::HookDefaultVersion.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-CloudFormation-HookDefaultVersion", "type": "AWS::CloudFormation::HookDefaultVersion", - "time": "2024-01-03T16:26:56.867Z", + "time": "2024-05-20T15:25:18.79Z", "schema": { "additionalProperties": false, "description": "Set a version as default version for a hook in CloudFormation Registry.", diff --git a/artifacts/types/AWS::CloudFormation::HookTypeConfig.json b/artifacts/types/AWS::CloudFormation::HookTypeConfig.json index 755a3ef1..12f862d0 100644 --- a/artifacts/types/AWS::CloudFormation::HookTypeConfig.json +++ b/artifacts/types/AWS::CloudFormation::HookTypeConfig.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-CloudFormation-HookTypeConfig", "type": "AWS::CloudFormation::HookTypeConfig", - "time": "2024-01-03T16:27:00.412Z", + "time": "2024-05-20T15:25:44.059Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::CloudFormation::ResourceDefaultVersion.json b/artifacts/types/AWS::CloudFormation::ResourceDefaultVersion.json index 4b3df762..f9347b2b 100644 --- a/artifacts/types/AWS::CloudFormation::ResourceDefaultVersion.json +++ b/artifacts/types/AWS::CloudFormation::ResourceDefaultVersion.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-CloudFormation-ResourceDefaultVersion", "type": "AWS::CloudFormation::ResourceDefaultVersion", - "time": "2023-12-07T02:38:06.506Z", + "time": "2024-02-29T19:17:52.009Z", "schema": { "additionalIdentifiers": [ [ diff --git a/artifacts/types/AWS::CloudFormation::StackSet.json b/artifacts/types/AWS::CloudFormation::StackSet.json index 8b42451b..fd18b2fa 100644 --- a/artifacts/types/AWS::CloudFormation::StackSet.json +++ b/artifacts/types/AWS::CloudFormation::StackSet.json @@ -1,8 +1,13 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-CloudFormation-StackSet", "type": "AWS::CloudFormation::StackSet", - "time": "2023-12-11T16:25:40.02Z", + "time": "2024-05-20T20:37:42.556Z", "schema": { + "additionalIdentifiers": [ + [ + "/properties/StackSetName" + ] + ], "additionalProperties": false, "createOnlyProperties": [ "/properties/PermissionModel", diff --git a/artifacts/types/AWS::CloudFormation::TypeActivation.json b/artifacts/types/AWS::CloudFormation::TypeActivation.json index fde820f1..0a9a1899 100644 --- a/artifacts/types/AWS::CloudFormation::TypeActivation.json +++ b/artifacts/types/AWS::CloudFormation::TypeActivation.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-CloudFormation-TypeActivation", "type": "AWS::CloudFormation::TypeActivation", - "time": "2023-12-28T16:54:56.143Z", + "time": "2024-01-08T19:06:47.065Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::CloudFront::CachePolicy.json b/artifacts/types/AWS::CloudFront::CachePolicy.json index b0ca1842..d131c8c7 100644 --- a/artifacts/types/AWS::CloudFront::CachePolicy.json +++ b/artifacts/types/AWS::CloudFront::CachePolicy.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-CloudFront-CachePolicy", "type": "AWS::CloudFront::CachePolicy", - "time": "2024-01-04T18:54:02.105Z", + "time": "2024-05-30T17:58:02.685Z", "schema": { "additionalProperties": false, "definitions": { diff --git a/artifacts/types/AWS::CloudFront::CloudFrontOriginAccessIdentity.json b/artifacts/types/AWS::CloudFront::CloudFrontOriginAccessIdentity.json index 0ece857e..84ed20c7 100644 --- a/artifacts/types/AWS::CloudFront::CloudFrontOriginAccessIdentity.json +++ b/artifacts/types/AWS::CloudFront::CloudFrontOriginAccessIdentity.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-CloudFront-CloudFrontOriginAccessIdentity", "type": "AWS::CloudFront::CloudFrontOriginAccessIdentity", - "time": "2024-01-04T18:38:26.34Z", + "time": "2024-05-30T17:57:57.121Z", "schema": { "additionalProperties": false, "definitions": { diff --git a/artifacts/types/AWS::CloudFront::ContinuousDeploymentPolicy.json b/artifacts/types/AWS::CloudFront::ContinuousDeploymentPolicy.json index 37625643..2cca4805 100644 --- a/artifacts/types/AWS::CloudFront::ContinuousDeploymentPolicy.json +++ b/artifacts/types/AWS::CloudFront::ContinuousDeploymentPolicy.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-CloudFront-ContinuousDeploymentPolicy", "type": "AWS::CloudFront::ContinuousDeploymentPolicy", - "time": "2024-01-04T17:34:00.924Z", + "time": "2024-05-30T17:57:57.384Z", "schema": { "additionalProperties": false, "definitions": { diff --git a/artifacts/types/AWS::CloudFront::Distribution.json b/artifacts/types/AWS::CloudFront::Distribution.json index d9f95131..8b1e7912 100644 --- a/artifacts/types/AWS::CloudFront::Distribution.json +++ b/artifacts/types/AWS::CloudFront::Distribution.json @@ -1,18 +1,20 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-CloudFront-Distribution", "type": "AWS::CloudFront::Distribution", - "time": "2024-01-04T22:54:31.792Z", + "time": "2024-05-30T17:57:57.971Z", "schema": { "additionalProperties": false, "definitions": { "CacheBehavior": { "additionalProperties": false, + "description": "A complex type that describes how CloudFront processes requests.\n You must create at least as many cache behaviors (including the default cache behavior) as you have origins if you want CloudFront to serve objects from all of the origins. Each cache behavior specifies the one origin from which you want CloudFront to get objects. If you have two origins and only the default cache behavior, the default cache behavior will cause CloudFront to get objects from one of the origins, but the other origin is never used.\n For the current quota (formerly known as limit) on the number of cache behaviors that you can add to a distribution, see [Quotas](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) in the *Amazon CloudFront Developer Guide*.\n If you don't want to specify any cache behaviors, include only an empty ``CacheBehaviors`` element. Don't include an empty ``CacheBehavior`` element because this is invalid.\n To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty ``CacheBehaviors`` element.\n To add, change, or remove one or more cache behaviors, update the distribution configuration and specify all of the cache behaviors that you want to include in the updated distribution.\n For 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*.", "properties": { "AllowedMethods": { "default": [ "GET", "HEAD" ], + "description": "A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices:\n + CloudFront forwards only ``GET`` and ``HEAD`` requests.\n + CloudFront forwards only ``GET``, ``HEAD``, and ``OPTIONS`` requests.\n + CloudFront forwards ``GET, HEAD, OPTIONS, PUT, PATCH, POST``, and ``DELETE`` requests.\n \n If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin.", "items": { "type": "string" }, @@ -20,6 +22,7 @@ "uniqueItems": false }, "CachePolicyId": { + "description": "The unique identifier of the cache policy that is attached to this cache behavior. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*.\n A ``CacheBehavior`` must include either a ``CachePolicyId`` or ``ForwardedValues``. We recommend that you use a ``CachePolicyId``.", "type": "string" }, "CachedMethods": { @@ -27,6 +30,7 @@ "GET", "HEAD" ], + "description": "A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:\n + CloudFront caches responses to ``GET`` and ``HEAD`` requests.\n + CloudFront caches responses to ``GET``, ``HEAD``, and ``OPTIONS`` requests.\n \n If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly.", "items": { "type": "string" }, @@ -35,20 +39,25 @@ }, "Compress": { "default": false, + "description": "Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see [Serving Compressed Files](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/ServingCompressedFiles.html) in the *Amazon CloudFront Developer Guide*.", "type": "boolean" }, "DefaultTTL": { "default": 86400, + "description": "This field is deprecated. We recommend that you use the ``DefaultTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*.\n The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as ``Cache-Control max-age``, ``Cache-Control s-maxage``, and ``Expires`` to objects. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.", "type": "number" }, "FieldLevelEncryptionId": { "default": "", + "description": "The value of ``ID`` for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for this cache behavior.", "type": "string" }, "ForwardedValues": { - "$ref": "#/definitions/ForwardedValues" + "$ref": "#/definitions/ForwardedValues", + "description": "This field is deprecated. We recommend that you use a cache policy or an origin request 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 *Amazon CloudFront Developer Guide*.\n If you want to include values in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*.\n If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) or [Using the managed origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) in the *Amazon CloudFront Developer Guide*.\n A ``CacheBehavior`` must include either a ``CachePolicyId`` or ``ForwardedValues``. We recommend that you use a ``CachePolicyId``.\n A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers." }, "FunctionAssociations": { + "description": "A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the ``LIVE`` stage to associate them with a cache behavior.", "items": { "$ref": "#/definitions/FunctionAssociation" }, @@ -56,6 +65,7 @@ "uniqueItems": false }, "LambdaFunctionAssociations": { + "description": "A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.", "items": { "$ref": "#/definitions/LambdaFunctionAssociation" }, @@ -64,32 +74,41 @@ }, "MaxTTL": { "default": 31536000, + "description": "This field is deprecated. We recommend that you use the ``MaxTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*.\n The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as ``Cache-Control max-age``, ``Cache-Control s-maxage``, and ``Expires`` to objects. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.", "type": "number" }, "MinTTL": { "default": 0, + "description": "This field is deprecated. We recommend that you use the ``MinTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*.\n The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.\n You must specify ``0`` for ``MinTTL`` if you configure CloudFront to forward all headers to your origin (under ``Headers``, if you specify ``1`` for ``Quantity`` and ``*`` for ``Name``).", "type": "number" }, "OriginRequestPolicyId": { + "description": "The unique identifier of the origin request policy that is attached to this cache behavior. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) or [Using the managed origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) in the *Amazon CloudFront Developer Guide*.", "type": "string" }, "PathPattern": { + "description": "The pattern (for example, ``images/*.jpg``) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution.\n You can optionally include a slash (``/``) at the beginning of the path pattern. For example, ``/images/*.jpg``. CloudFront behavior is the same with or without the leading ``/``.\n The path pattern for the default cache behavior is ``*`` and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior.\n For 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*.", "type": "string" }, "RealtimeLogConfigArn": { + "description": "The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see [Real-time logs](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html) in the *Amazon CloudFront Developer Guide*.", "type": "string" }, "ResponseHeadersPolicyId": { + "description": "The identifier for a response headers policy.", "type": "string" }, "SmoothStreaming": { "default": false, + "description": "Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify ``true``; if not, specify ``false``. If you specify ``true`` for ``SmoothStreaming``, you can still distribute other content using this cache behavior if the content matches the value of ``PathPattern``.", "type": "boolean" }, "TargetOriginId": { + "description": "The value of ``ID`` for the origin that you want CloudFront to route requests to when they match this cache behavior.", "type": "string" }, "TrustedKeyGroups": { + "description": "A list of key groups that CloudFront can use to validate signed URLs or signed cookies.\n When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*.", "items": { "type": "string" }, @@ -97,6 +116,7 @@ "uniqueItems": false }, "TrustedSigners": { + "description": "We recommend using ``TrustedKeyGroups`` instead of ``TrustedSigners``.\n A list of AWS-account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.\n When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer's AWS-account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*.", "items": { "type": "string" }, @@ -104,6 +124,7 @@ "uniqueItems": false }, "ViewerProtocolPolicy": { + "description": "The protocol that viewers can use to access the files in the origin specified by ``TargetOriginId`` when a request matches the path pattern in ``PathPattern``. You can specify the following options:\n + ``allow-all``: Viewers can use HTTP or HTTPS.\n + ``redirect-to-https``: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.\n + ``https-only``: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).\n \n For more information about requiring the HTTPS protocol, see [Requiring HTTPS Between Viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-viewers-to-cloudfront.html) in the *Amazon CloudFront Developer Guide*.\n The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see [Managing Cache Expiration](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.", "type": "string" } }, @@ -116,11 +137,14 @@ }, "Cookies": { "additionalProperties": false, + "description": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.\n If you want to include cookies in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*.\n If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*.\n A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see [How CloudFront Forwards, Caches, and Logs Cookies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html) in the *Amazon CloudFront Developer Guide*.", "properties": { "Forward": { + "description": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.\n If you want to include cookies in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*.\n If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*.\n Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the ``WhitelistedNames`` complex type.\n Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the ``Forward`` element.", "type": "string" }, "WhitelistedNames": { + "description": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.\n If you want to include cookies in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*.\n If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*.\n Required if you specify ``whitelist`` for the value of ``Forward``. A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies.\n If you specify ``all`` or ``none`` for the value of ``Forward``, omit ``WhitelistedNames``. If you change the value of ``Forward`` from ``whitelist`` to ``all`` or ``none`` and you don't delete the ``WhitelistedNames`` element and its child elements, CloudFront deletes them automatically.\n For the current limit on the number of cookie names that you can whitelist for each cache behavior, see [CloudFront Limits](https://docs.aws.amazon.com/general/latest/gr/xrefaws_service_limits.html#limits_cloudfront) in the *General Reference*.", "items": { "type": "string" }, @@ -135,18 +159,23 @@ }, "CustomErrorResponse": { "additionalProperties": false, + "description": "A complex type that controls:\n + Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.\n + How long CloudFront caches HTTP status codes in the 4xx and 5xx range.\n \n For more information about custom error pages, see [Customizing Error Responses](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html) in the *Amazon CloudFront Developer Guide*.", "properties": { "ErrorCachingMinTTL": { "default": 300, + "description": "The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in ``ErrorCode``. When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available.\n For more information, see [Customizing Error Responses](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html) in the *Amazon CloudFront Developer Guide*.", "type": "number" }, "ErrorCode": { + "description": "The HTTP status code for which you want to specify a custom error page and/or a caching duration.", "type": "integer" }, "ResponseCode": { + "description": "The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example:\n + Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute ``200``, the response typically won't be intercepted.\n + If you don't care about distinguishing among different client errors or server errors, you can specify ``400`` or ``500`` as the ``ResponseCode`` for all 4xx or 5xx errors.\n + You might want to return a ``200`` status code (OK) and static website so your customers don't know that your website is down.\n \n If you specify a value for ``ResponseCode``, you must also specify a value for ``ResponsePagePath``.", "type": "integer" }, "ResponsePagePath": { + "description": "The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by ``ErrorCode``, for example, ``/4xx-errors/403-forbidden.html``. If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true:\n + The value of ``PathPattern`` matches the path to your custom error messages. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named ``/4xx-errors``. Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example, ``/4xx-errors/*``.\n + The value of ``TargetOriginId`` specifies the value of the ``ID`` element for the origin that contains your custom error pages.\n \n If you specify a value for ``ResponsePagePath``, you must also specify a value for ``ResponseCode``.\n We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable.", "type": "string" } }, @@ -157,24 +186,30 @@ }, "CustomOriginConfig": { "additionalProperties": false, + "description": "A custom origin. A custom origin is any origin that is *not* an Amazon S3 bucket, with one exception. An Amazon S3 bucket that is [configured with static website hosting](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html) *is* a custom origin.", "properties": { "HTTPPort": { "default": 80, + "description": "The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on.", "type": "integer" }, "HTTPSPort": { "default": 443, + "description": "The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on.", "type": "integer" }, "OriginKeepaliveTimeout": { "default": 5, + "description": "Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 5 seconds.\n For more information, see [Origin Keep-alive Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginKeepaliveTimeout) in the *Amazon CloudFront Developer Guide*.", "type": "integer" }, "OriginProtocolPolicy": { + "description": "Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid values are:\n + ``http-only`` ? CloudFront always uses HTTP to connect to the origin.\n + ``match-viewer`` ? CloudFront connects to the origin using the same protocol that the viewer used to connect to CloudFront.\n + ``https-only`` ? CloudFront always uses HTTPS to connect to the origin.", "type": "string" }, "OriginReadTimeout": { "default": 30, + "description": "Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the *origin response timeout*. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 30 seconds.\n For more information, see [Origin Response Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginResponseTimeout) in the *Amazon CloudFront Developer Guide*.", "type": "integer" }, "OriginSSLProtocols": { @@ -182,6 +217,7 @@ "TLSv1", "SSLv3" ], + "description": "Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS. Valid values include ``SSLv3``, ``TLSv1``, ``TLSv1.1``, and ``TLSv1.2``.\n For more information, see [Minimum Origin SSL Protocol](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginSSLProtocols) in the *Amazon CloudFront Developer Guide*.", "items": { "type": "string" }, @@ -196,12 +232,14 @@ }, "DefaultCacheBehavior": { "additionalProperties": false, + "description": "A complex type that describes the default cache behavior if you don't specify a ``CacheBehavior`` element or if request URLs don't match any of the values of ``PathPattern`` in ``CacheBehavior`` elements. You must create exactly one default cache behavior.", "properties": { "AllowedMethods": { "default": [ "GET", "HEAD" ], + "description": "A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices:\n + CloudFront forwards only ``GET`` and ``HEAD`` requests.\n + CloudFront forwards only ``GET``, ``HEAD``, and ``OPTIONS`` requests.\n + CloudFront forwards ``GET, HEAD, OPTIONS, PUT, PATCH, POST``, and ``DELETE`` requests.\n \n If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin.", "items": { "type": "string" }, @@ -210,6 +248,7 @@ }, "CachePolicyId": { "default": "", + "description": "The unique identifier of the cache policy that is attached to the default cache behavior. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*.\n A ``DefaultCacheBehavior`` must include either a ``CachePolicyId`` or ``ForwardedValues``. We recommend that you use a ``CachePolicyId``.", "type": "string" }, "CachedMethods": { @@ -217,6 +256,7 @@ "GET", "HEAD" ], + "description": "A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:\n + CloudFront caches responses to ``GET`` and ``HEAD`` requests.\n + CloudFront caches responses to ``GET``, ``HEAD``, and ``OPTIONS`` requests.\n \n If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly.", "items": { "type": "string" }, @@ -225,20 +265,25 @@ }, "Compress": { "default": false, + "description": "Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify ``true``; if not, specify ``false``. For more information, see [Serving Compressed Files](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/ServingCompressedFiles.html) in the *Amazon CloudFront Developer Guide*.", "type": "boolean" }, "DefaultTTL": { "default": 86400, + "description": "This field is deprecated. We recommend that you use the ``DefaultTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*.\n The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as ``Cache-Control max-age``, ``Cache-Control s-maxage``, and ``Expires`` to objects. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.", "type": "number" }, "FieldLevelEncryptionId": { "default": "", + "description": "The value of ``ID`` for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for the default cache behavior.", "type": "string" }, "ForwardedValues": { - "$ref": "#/definitions/ForwardedValues" + "$ref": "#/definitions/ForwardedValues", + "description": "This field is deprecated. We recommend that you use a cache policy or an origin request 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 *Amazon CloudFront Developer Guide*.\n If you want to include values in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*.\n If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) or [Using the managed origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) in the *Amazon CloudFront Developer Guide*.\n A ``DefaultCacheBehavior`` must include either a ``CachePolicyId`` or ``ForwardedValues``. We recommend that you use a ``CachePolicyId``.\n A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers." }, "FunctionAssociations": { + "description": "A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the ``LIVE`` stage to associate them with a cache behavior.", "items": { "$ref": "#/definitions/FunctionAssociation" }, @@ -246,6 +291,7 @@ "uniqueItems": false }, "LambdaFunctionAssociations": { + "description": "A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.", "items": { "$ref": "#/definitions/LambdaFunctionAssociation" }, @@ -254,32 +300,40 @@ }, "MaxTTL": { "default": 31536000, + "description": "This field is deprecated. We recommend that you use the ``MaxTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*.\n The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as ``Cache-Control max-age``, ``Cache-Control s-maxage``, and ``Expires`` to objects. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.", "type": "number" }, "MinTTL": { "default": 0, + "description": "This field is deprecated. We recommend that you use the ``MinTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*.\n The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.\n You must specify ``0`` for ``MinTTL`` if you configure CloudFront to forward all headers to your origin (under ``Headers``, if you specify ``1`` for ``Quantity`` and ``*`` for ``Name``).", "type": "number" }, "OriginRequestPolicyId": { "default": "", + "description": "The unique identifier of the origin request policy that is attached to the default cache behavior. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) or [Using the managed origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) in the *Amazon CloudFront Developer Guide*.", "type": "string" }, "RealtimeLogConfigArn": { "default": "", + "description": "The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see [Real-time logs](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html) in the *Amazon CloudFront Developer Guide*.", "type": "string" }, "ResponseHeadersPolicyId": { "default": "", + "description": "The identifier for a response headers policy.", "type": "string" }, "SmoothStreaming": { "default": false, + "description": "Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify ``true``; if not, specify ``false``. If you specify ``true`` for ``SmoothStreaming``, you can still distribute other content using this cache behavior if the content matches the value of ``PathPattern``.", "type": "boolean" }, "TargetOriginId": { + "description": "The value of ``ID`` for the origin that you want CloudFront to route requests to when they use the default cache behavior.", "type": "string" }, "TrustedKeyGroups": { + "description": "A list of key groups that CloudFront can use to validate signed URLs or signed cookies.\n When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*.", "items": { "type": "string" }, @@ -287,6 +341,7 @@ "uniqueItems": false }, "TrustedSigners": { + "description": "We recommend using ``TrustedKeyGroups`` instead of ``TrustedSigners``.\n A list of AWS-account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.\n When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer's AWS-account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*.", "items": { "type": "string" }, @@ -294,6 +349,7 @@ "uniqueItems": false }, "ViewerProtocolPolicy": { + "description": "The protocol that viewers can use to access the files in the origin specified by ``TargetOriginId`` when a request matches the path pattern in ``PathPattern``. You can specify the following options:\n + ``allow-all``: Viewers can use HTTP or HTTPS.\n + ``redirect-to-https``: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.\n + ``https-only``: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).\n \n For more information about requiring the HTTPS protocol, see [Requiring HTTPS Between Viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-viewers-to-cloudfront.html) in the *Amazon CloudFront Developer Guide*.\n The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see [Managing Cache Expiration](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.", "type": "string" } }, @@ -305,8 +361,10 @@ }, "DistributionConfig": { "additionalProperties": false, + "description": "A distribution configuration.", "properties": { "Aliases": { + "description": "A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.", "items": { "type": "string" }, @@ -314,6 +372,7 @@ "uniqueItems": false }, "CNAMEs": { + "description": "", "items": { "type": "string" }, @@ -321,6 +380,7 @@ "uniqueItems": false }, "CacheBehaviors": { + "description": "A complex type that contains zero or more ``CacheBehavior`` elements.", "items": { "$ref": "#/definitions/CacheBehavior" }, @@ -329,12 +389,15 @@ }, "Comment": { "default": "", + "description": "A comment to describe the distribution. The comment cannot be longer than 128 characters.", "type": "string" }, "ContinuousDeploymentPolicyId": { + "description": "The identifier of a continuous deployment policy. For more information, see ``CreateContinuousDeploymentPolicy``.", "type": "string" }, "CustomErrorResponses": { + "description": "A complex type that controls the following:\n + Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.\n + How long CloudFront caches HTTP status codes in the 4xx and 5xx range.\n \n For more information about custom error pages, see [Customizing Error Responses](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html) in the *Amazon CloudFront Developer Guide*.", "items": { "$ref": "#/definitions/CustomErrorResponse" }, @@ -342,32 +405,42 @@ "uniqueItems": false }, "CustomOrigin": { - "$ref": "#/definitions/LegacyCustomOrigin" + "$ref": "#/definitions/LegacyCustomOrigin", + "description": "" }, "DefaultCacheBehavior": { - "$ref": "#/definitions/DefaultCacheBehavior" + "$ref": "#/definitions/DefaultCacheBehavior", + "description": "A complex type that describes the default cache behavior if you don't specify a ``CacheBehavior`` element or if files don't match any of the values of ``PathPattern`` in ``CacheBehavior`` elements. You must create exactly one default cache behavior." }, "DefaultRootObject": { "default": "", + "description": "The object that you want CloudFront to request from your origin (for example, ``index.html``) when a viewer requests the root URL for your distribution (``https://www.example.com``) instead of an object in your distribution (``https://www.example.com/product-description.html``). Specifying a default root object avoids exposing the contents of your distribution.\n Specify only the object name, for example, ``index.html``. Don't add a ``/`` before the object name.\n If you don't want to specify a default root object when you create a distribution, include an empty ``DefaultRootObject`` element.\n To delete the default root object from an existing distribution, update the distribution configuration and include an empty ``DefaultRootObject`` element.\n To replace the default root object, update the distribution configuration and specify the new object.\n For more information about the default root object, see [Creating a Default Root Object](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DefaultRootObject.html) in the *Amazon CloudFront Developer Guide*.", "type": "string" }, "Enabled": { + "description": "From this field, you can enable or disable the selected distribution.", "type": "boolean" }, "HttpVersion": { "default": "http1.1", + "description": "(Optional) Specify the maximum HTTP version(s) that you want viewers to use to communicate with CF. The default value for new distributions is ``http1.1``.\n For viewers and CF to use HTTP/2, viewers must support TLSv1.2 or later, and must support Server Name Indication (SNI).\n For viewers and CF to use HTTP/3, viewers must support TLSv1.3 and Server Name Indication (SNI). CF supports HTTP/3 connection migration to allow the viewer to switch networks without losing connection. For more information about connection migration, see [Connection Migration](https://docs.aws.amazon.com/https://www.rfc-editor.org/rfc/rfc9000.html#name-connection-migration) at RFC 9000. For more information about supported TLSv1.3 ciphers, see [Supported protocols and ciphers between viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html).", "type": "string" }, "IPV6Enabled": { + "description": "If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify ``true``. If you specify ``false``, CloudFront responds to IPv6 DNS requests with the DNS response code ``NOERROR`` and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution.\n In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the ``IpAddress`` parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see [Creating a Signed URL Using a Custom Policy](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-creating-signed-url-custom-policy.html) in the *Amazon CloudFront Developer Guide*.\n If you're using an R53AWSIntlong alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true:\n + You enable IPv6 for the distribution\n + You're using alternate domain names in the URLs for your objects\n \n For more information, see [Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-to-cloudfront-distribution.html) in the *Developer Guide*.\n If you created a CNAME resource record set, either with R53AWSIntlong or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request.", "type": "boolean" }, "Logging": { - "$ref": "#/definitions/Logging" + "$ref": "#/definitions/Logging", + "description": "A complex type that controls whether access logs are written for the distribution.\n For more information about logging, see [Access Logs](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/AccessLogs.html) in the *Amazon CloudFront Developer Guide*." }, "OriginGroups": { - "$ref": "#/definitions/OriginGroups" + "$ref": "#/definitions/OriginGroups", + "description": "A complex type that contains information about origin groups for this distribution." }, "Origins": { + "description": "A complex type that contains information about origins for this distribution.", + "insertionOrder": false, "items": { "$ref": "#/definitions/Origin" }, @@ -376,6 +449,7 @@ }, "PriceClass": { "default": "PriceClass_All", + "description": "The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify ``PriceClass_All``, CloudFront responds to requests for your objects from all CloudFront edge locations.\n If you specify a price class other than ``PriceClass_All``, CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance.\n For more information about price classes, see [Choosing the Price Class for a CloudFront Distribution](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PriceClass.html) in the *Amazon CloudFront Developer Guide*. For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see [Amazon CloudFront Pricing](https://docs.aws.amazon.com/cloudfront/pricing/).", "type": "string" }, "Restrictions": { @@ -384,22 +458,27 @@ "GeoRestriction": { "RestrictionType": "none" } - } + }, + "description": "A complex type that identifies ways in which you want to restrict distribution of your content." }, "S3Origin": { - "$ref": "#/definitions/LegacyS3Origin" + "$ref": "#/definitions/LegacyS3Origin", + "description": "" }, "Staging": { + "description": "A Boolean that indicates whether this is a staging distribution. When this value is ``true``, this is a staging distribution. When this value is ``false``, this is not a staging distribution.", "type": "boolean" }, "ViewerCertificate": { "$ref": "#/definitions/ViewerCertificate", "default": { "CloudFrontDefaultCertificate": true - } + }, + "description": "A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers." }, "WebACLId": { "default": "", + "description": "A unique identifier that specifies the WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of WAF, use the ACL ARN, for example ``arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a``. To specify a web ACL created using WAF Classic, use the ACL ID, for example ``473e64fd-f30b-4765-81a0-62ad96dd167a``.\n WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about WAF, see the [Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/what-is-aws-waf.html).", "type": "string" } }, @@ -411,14 +490,17 @@ }, "ForwardedValues": { "additionalProperties": false, + "description": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.\n If you want to include values in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*.\n If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*.\n A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.", "properties": { "Cookies": { "$ref": "#/definitions/Cookies", "default": { "Forward": "none" - } + }, + "description": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.\n If you want to include cookies in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*.\n If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*.\n A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see [How CloudFront Forwards, Caches, and Logs Cookies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html) in the *Amazon CloudFront Developer Guide*." }, "Headers": { + "description": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.\n If you want to include headers in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*.\n If you want to send headers to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*.\n A complex type that specifies the ``Headers``, if any, that you want CloudFront to forward to the origin for this cache behavior (whitelisted headers). For the headers that you specify, CloudFront also caches separate versions of a specified object that is based on the header values in viewer requests.\n For more information, see [Caching Content Based on Request Headers](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/header-caching.html) in the *Amazon CloudFront Developer Guide*.", "items": { "type": "string" }, @@ -426,9 +508,11 @@ "uniqueItems": false }, "QueryString": { + "description": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.\n If you want to include query strings in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*.\n If you want to send query strings to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*.\n Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of ``QueryString`` and on the values that you specify for ``QueryStringCacheKeys``, if any:\n If you specify true for ``QueryString`` and you don't specify any values for ``QueryStringCacheKeys``, CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.\n If you specify true for ``QueryString`` and you specify one or more values for ``QueryStringCacheKeys``, CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.\n If you specify false for ``QueryString``, CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.\n For more information, see [Configuring CloudFront to Cache Based on Query String Parameters](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/QueryStringParameters.html) in the *Amazon CloudFront Developer Guide*.", "type": "boolean" }, "QueryStringCacheKeys": { + "description": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.\n If you want to include query strings in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*.\n If you want to send query strings to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*.\n A complex type that contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.", "items": { "type": "string" }, @@ -443,11 +527,14 @@ }, "FunctionAssociation": { "additionalProperties": false, + "description": "A CloudFront function that is associated with a cache behavior in a CloudFront distribution.", "properties": { "EventType": { + "description": "The event type of the function, either ``viewer-request`` or ``viewer-response``. You cannot use origin-facing event types (``origin-request`` and ``origin-response``) with a CloudFront function.", "type": "string" }, "FunctionARN": { + "description": "The Amazon Resource Name (ARN) of the function.", "type": "string" } }, @@ -455,8 +542,10 @@ }, "GeoRestriction": { "additionalProperties": false, + "description": "A complex type that controls the countries in which your content is distributed. CF determines the location of your users using ``MaxMind`` GeoIP databases. To disable geo restriction, remove the [Restrictions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-restrictions) property from your stack template.", "properties": { "Locations": { + "description": "A complex type that contains a ``Location`` element for each country in which you want CloudFront either to distribute your content (``whitelist``) or not distribute your content (``blacklist``).\n The ``Location`` element is a two-letter, uppercase country code for a country that you want to include in your ``blacklist`` or ``whitelist``. Include one ``Location`` element for each country.\n CloudFront and ``MaxMind`` both use ``ISO 3166`` country codes. For the current list of countries and the corresponding codes, see ``ISO 3166-1-alpha-2`` code on the *International Organization for Standardization* website. You can also refer to the country list on the CloudFront console, which includes both country names and codes.", "items": { "type": "string" }, @@ -464,6 +553,7 @@ "uniqueItems": false }, "RestrictionType": { + "description": "The method that you want to use to restrict distribution of your content by country:\n + ``none``: No geo restriction is enabled, meaning access to content is not restricted by client geo location.\n + ``blacklist``: The ``Location`` elements specify the countries in which you don't want CloudFront to distribute your content.\n + ``whitelist``: The ``Location`` elements specify the countries in which you want CloudFront to distribute your content.", "type": "string" } }, @@ -474,14 +564,18 @@ }, "LambdaFunctionAssociation": { "additionalProperties": false, + "description": "A complex type that contains a Lambda@Edge function association.", "properties": { "EventType": { + "description": "Specifies the event type that triggers a Lambda@Edge function invocation. You can specify the following values:\n + ``viewer-request``: The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache.\n + ``origin-request``: The function executes only when CloudFront sends a request to your origin. When the requested object is in the edge cache, the function doesn't execute.\n + ``origin-response``: The function executes after CloudFront receives a response from the origin and before it caches the object in the response. When the requested object is in the edge cache, the function doesn't execute.\n + ``viewer-response``: The function executes before CloudFront returns the requested object to the viewer. The function executes regardless of whether the object was already in the edge cache.\n If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute.", "type": "string" }, "IncludeBody": { + "description": "A flag that allows a Lambda@Edge function to have read access to the body content. For more information, see [Accessing the Request Body by Choosing the Include Body Option](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/lambda-include-body-access.html) in the Amazon CloudFront Developer Guide.", "type": "boolean" }, "LambdaFunctionARN": { + "description": "The ARN of the Lambda@Edge function. You must specify the ARN of a function version; you can't specify an alias or $LATEST.", "type": "string" } }, @@ -489,22 +583,28 @@ }, "LegacyCustomOrigin": { "additionalProperties": false, + "description": "", "properties": { "DNSName": { + "description": "", "type": "string" }, "HTTPPort": { "default": 80, + "description": "", "type": "integer" }, "HTTPSPort": { "default": 443, + "description": "", "type": "integer" }, "OriginProtocolPolicy": { + "description": "", "type": "string" }, "OriginSSLProtocols": { + "description": "", "items": { "type": "string" }, @@ -521,12 +621,15 @@ }, "LegacyS3Origin": { "additionalProperties": false, + "description": "", "properties": { "DNSName": { + "description": "", "type": "string" }, "OriginAccessIdentity": { "default": "", + "description": "", "type": "string" } }, @@ -537,16 +640,20 @@ }, "Logging": { "additionalProperties": false, + "description": "A complex type that controls whether access logs are written for the distribution.", "properties": { "Bucket": { + "description": "The Amazon S3 bucket to store the access logs in, for example, ``myawslogbucket.s3.amazonaws.com``.", "type": "string" }, "IncludeCookies": { "default": false, + "description": "Specifies whether you want CloudFront to include cookies in access logs, specify ``true`` for ``IncludeCookies``. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you don't want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify ``false`` for ``IncludeCookies``.", "type": "boolean" }, "Prefix": { "default": "", + "description": "An optional string that you want CloudFront to prefix to the access log ``filenames`` for this distribution, for example, ``myprefix/``. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty ``Prefix`` element in the ``Logging`` element.", "type": "string" } }, @@ -557,26 +664,34 @@ }, "Origin": { "additionalProperties": false, + "description": "An origin.\n An origin is the location where content is stored, and from which CloudFront gets content to serve to viewers. To specify an origin:\n + Use ``S3OriginConfig`` to specify an Amazon S3 bucket that is not configured with static website hosting.\n + Use ``CustomOriginConfig`` to specify all other kinds of origins, including:\n + An Amazon S3 bucket that is configured with static website hosting\n + An Elastic Load Balancing load balancer\n + An EMPlong endpoint\n + An EMSlong container\n + Any other HTTP server, running on an Amazon EC2 instance or any other kind of host\n \n \n For the current maximum number of origins that you can specify per distribution, see [General Quotas on Web Distributions](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html#limits-web-distributions) in the *Amazon CloudFront Developer Guide* (quotas were formerly referred to as limits).", "properties": { "ConnectionAttempts": { + "description": "The number of times that CloudFront attempts to connect to the origin. The minimum number is 1, the maximum is 3, and the default (if you don't specify otherwise) is 3.\n For a custom origin (including an Amazon S3 bucket that's configured with static website hosting), this value also specifies the number of times that CloudFront attempts to get a response from the origin, in the case of an [Origin Response Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginResponseTimeout).\n For more information, see [Origin Connection Attempts](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#origin-connection-attempts) in the *Amazon CloudFront Developer Guide*.", "type": "integer" }, "ConnectionTimeout": { + "description": "The number of seconds that CloudFront waits when trying to establish a connection to the origin. The minimum timeout is 1 second, the maximum is 10 seconds, and the default (if you don't specify otherwise) is 10 seconds.\n For more information, see [Origin Connection Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#origin-connection-timeout) in the *Amazon CloudFront Developer Guide*.", "type": "integer" }, "CustomOriginConfig": { - "$ref": "#/definitions/CustomOriginConfig" + "$ref": "#/definitions/CustomOriginConfig", + "description": "Use this type to specify an origin that is not an Amazon S3 bucket, with one exception. If the Amazon S3 bucket is configured with static website hosting, use this type. If the Amazon S3 bucket is not configured with static website hosting, use the ``S3OriginConfig`` type instead." }, "DomainName": { + "description": "The domain name for the origin.\n For 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*.", "type": "string" }, "Id": { + "description": "A unique identifier for the origin. This value must be unique within the distribution.\n Use this value to specify the ``TargetOriginId`` in a ``CacheBehavior`` or ``DefaultCacheBehavior``.", "type": "string" }, "OriginAccessControlId": { + "description": "The unique identifier of an origin access control for this origin.\n For more information, see [Restricting access to an Amazon S3 origin](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html) in the *Amazon CloudFront Developer Guide*.", "type": "string" }, "OriginCustomHeaders": { + "description": "A list of HTTP header names and values that CloudFront adds to the requests that it sends to the origin.\n For more information, see [Adding Custom Headers to Origin Requests](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/add-origin-custom-headers.html) in the *Amazon CloudFront Developer Guide*.", "items": { "$ref": "#/definitions/OriginCustomHeader" }, @@ -585,13 +700,16 @@ }, "OriginPath": { "default": "", + "description": "An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin.\n For more information, see [Origin Path](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginPath) in the *Amazon CloudFront Developer Guide*.", "type": "string" }, "OriginShield": { - "$ref": "#/definitions/OriginShield" + "$ref": "#/definitions/OriginShield", + "description": "CloudFront Origin Shield. Using Origin Shield can help reduce the load on your origin.\n For more information, see [Using Origin Shield](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html) in the *Amazon CloudFront Developer Guide*." }, "S3OriginConfig": { - "$ref": "#/definitions/S3OriginConfig" + "$ref": "#/definitions/S3OriginConfig", + "description": "Use this type to specify an origin that is an Amazon S3 bucket that is not configured with static website hosting. To specify any other type of origin, including an Amazon S3 bucket that is configured with static website hosting, use the ``CustomOriginConfig`` type instead." } }, "required": [ @@ -602,11 +720,14 @@ }, "OriginCustomHeader": { "additionalProperties": false, + "description": "A complex type that contains ``HeaderName`` and ``HeaderValue`` elements, if any, for this distribution.", "properties": { "HeaderName": { + "description": "The name of a header that you want CloudFront to send to your origin. For more information, see [Adding Custom Headers to Origin Requests](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/forward-custom-headers.html) in the *Amazon CloudFront Developer Guide*.", "type": "string" }, "HeaderValue": { + "description": "The value for the header that you specified in the ``HeaderName`` field.", "type": "string" } }, @@ -618,15 +739,19 @@ }, "OriginGroup": { "additionalProperties": false, + "description": "An origin group includes two origins (a primary origin and a second origin to failover to) and a failover criteria that you specify. You create an origin group to support origin failover in CloudFront. When you create or update a distribution, you can specify the origin group instead of a single origin, and CloudFront will failover from the primary origin to the second origin under the failover conditions that you've chosen.", "properties": { "FailoverCriteria": { - "$ref": "#/definitions/OriginGroupFailoverCriteria" + "$ref": "#/definitions/OriginGroupFailoverCriteria", + "description": "A complex type that contains information about the failover criteria for an origin group." }, "Id": { + "description": "The origin group's ID.", "type": "string" }, "Members": { - "$ref": "#/definitions/OriginGroupMembers" + "$ref": "#/definitions/OriginGroupMembers", + "description": "A complex type that contains information about the origins in an origin group." } }, "required": [ @@ -638,9 +763,11 @@ }, "OriginGroupFailoverCriteria": { "additionalProperties": false, + "description": "A complex data type that includes information about the failover criteria for an origin group, including the status codes for which CloudFront will failover from the primary origin to the second origin.", "properties": { "StatusCodes": { - "$ref": "#/definitions/StatusCodes" + "$ref": "#/definitions/StatusCodes", + "description": "The status codes that, when returned from the primary origin, will trigger CloudFront to failover to the second origin." } }, "required": [ @@ -650,8 +777,10 @@ }, "OriginGroupMember": { "additionalProperties": false, + "description": "An origin in an origin group.", "properties": { "OriginId": { + "description": "The ID for an origin in an origin group.", "type": "string" } }, @@ -662,8 +791,10 @@ }, "OriginGroupMembers": { "additionalProperties": false, + "description": "A complex data type for the origins included in an origin group.", "properties": { "Items": { + "description": "Items (origins) in an origin group.", "items": { "$ref": "#/definitions/OriginGroupMember" }, @@ -671,6 +802,7 @@ "uniqueItems": false }, "Quantity": { + "description": "The number of origins in an origin group.", "type": "integer" } }, @@ -682,8 +814,10 @@ }, "OriginGroups": { "additionalProperties": false, + "description": "A complex data type for the origin groups specified for a distribution.", "properties": { "Items": { + "description": "The items (origin groups) in a distribution.", "items": { "$ref": "#/definitions/OriginGroup" }, @@ -691,6 +825,7 @@ "uniqueItems": false }, "Quantity": { + "description": "The number of origin groups.", "type": "integer" } }, @@ -701,11 +836,14 @@ }, "OriginShield": { "additionalProperties": false, + "description": "CloudFront Origin Shield.\n Using Origin Shield can help reduce the load on your origin. For more information, see [Using Origin Shield](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html) in the *Amazon CloudFront Developer Guide*.", "properties": { "Enabled": { + "description": "A flag that specifies whether Origin Shield is enabled.\n When it's enabled, CloudFront routes all requests through Origin Shield, which can help protect your origin. When it's disabled, CloudFront might send requests directly to your origin from multiple edge locations or regional edge caches.", "type": "boolean" }, "OriginShieldRegion": { + "description": "The AWS-Region for Origin Shield.\n Specify the AWS-Region that has the lowest latency to your origin. To specify a region, use the region code, not the region name. For example, specify the US East (Ohio) region as ``us-east-2``.\n When you enable CloudFront Origin Shield, you must specify the AWS-Region for Origin Shield. For the list of AWS-Regions that you can specify, and for help choosing the best Region for your origin, see [Choosing the for Origin Shield](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html#choose-origin-shield-region) in the *Amazon CloudFront Developer Guide*.", "type": "string" } }, @@ -713,9 +851,11 @@ }, "Restrictions": { "additionalProperties": false, + "description": "A complex type that identifies ways in which you want to restrict distribution of your content.", "properties": { "GeoRestriction": { - "$ref": "#/definitions/GeoRestriction" + "$ref": "#/definitions/GeoRestriction", + "description": "A complex type that controls the countries in which your content is distributed. CF determines the location of your users using ``MaxMind`` GeoIP databases. To disable geo restriction, remove the [Restrictions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-restrictions) property from your stack template." } }, "required": [ @@ -725,9 +865,11 @@ }, "S3OriginConfig": { "additionalProperties": false, + "description": "A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin or an S3 bucket that is configured as a website endpoint, use the ``CustomOriginConfig`` element instead.", "properties": { "OriginAccessIdentity": { "default": "", + "description": "The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can *only* access objects in an Amazon S3 bucket through CloudFront. The format of the value is:\n origin-access-identity/cloudfront/*ID-of-origin-access-identity* \n where ``ID-of-origin-access-identity`` is the value that CloudFront returned in the ``ID`` element when you created the origin access identity.\n If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty ``OriginAccessIdentity`` element.\n To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty ``OriginAccessIdentity`` element.\n To replace the origin access identity, update the distribution configuration and specify the new origin access identity.\n For more information about the origin access identity, see [Serving Private Content through CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*.", "type": "string" } }, @@ -735,8 +877,10 @@ }, "StatusCodes": { "additionalProperties": false, + "description": "A complex data type for the status codes that you specify that, when returned by a primary origin, trigger CloudFront to failover to a second origin.", "properties": { "Items": { + "description": "The items (status codes) for an origin group.", "items": { "type": "integer" }, @@ -744,6 +888,7 @@ "uniqueItems": false }, "Quantity": { + "description": "The number of status codes.", "type": "integer" } }, @@ -755,11 +900,14 @@ }, "Tag": { "additionalProperties": false, + "description": "A complex type that contains ``Tag`` key and ``Tag`` value.", "properties": { "Key": { + "description": "A string that contains ``Tag`` key.\n The string length should be between 1 and 128 characters. Valid characters include ``a-z``, ``A-Z``, ``0-9``, space, and the special characters ``_ - . : / = + @``.", "type": "string" }, "Value": { + "description": "A string that contains an optional ``Tag`` value.\n The string length should be between 0 and 256 characters. Valid characters include ``a-z``, ``A-Z``, ``0-9``, space, and the special characters ``_ - . : / = + @``.", "type": "string" } }, @@ -771,20 +919,26 @@ }, "ViewerCertificate": { "additionalProperties": false, + "description": "A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers.\n If the distribution doesn't use ``Aliases`` (also known as alternate domain names or CNAMEs)?that is, if the distribution uses the CloudFront domain name such as ``d111111abcdef8.cloudfront.net``?set ``CloudFrontDefaultCertificate`` to ``true`` and leave all other fields empty.\n If the distribution uses ``Aliases`` (alternate domain names or CNAMEs), use the fields in this type to specify the following settings:\n + Which viewers the distribution accepts HTTPS connections from: only viewers that support [server name indication (SNI)](https://docs.aws.amazon.com/https://en.wikipedia.org/wiki/Server_Name_Indication) (recommended), or all viewers including those that don't support SNI.\n + To accept HTTPS connections from only viewers that support SNI, set ``SSLSupportMethod`` to ``sni-only``. This is recommended. Most browsers and clients support SNI. (In CloudFormation, the field name is ``SslSupportMethod``. Note the different capitalization.)\n + To accept HTTPS connections from all viewers, including those that don't support SNI, set ``SSLSupportMethod`` to ``vip``. This is not recommended, and results in additional monthly charges from CloudFront. (In CloudFormation, the field name is ``SslSupportMethod``. Note the different capitalization.)\n \n + The minimum SSL/TLS protocol version that the distribution can use to communicate with viewers. To specify a minimum version, choose a value for ``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 *Amazon CloudFront Developer Guide*.\n + The location of the SSL/TLS certificate, [(ACM)](https://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html) (recommended) or [(IAM)](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html). You specify the location by setting a value in one of the following fields (not both):\n + ``ACMCertificateArn`` (In CloudFormation, this field name is ``AcmCertificateArn``. Note the different capitalization.)\n + ``IAMCertificateId`` (In CloudFormation, this field name is ``IamCertificateId``. Note the different capitalization.)\n \n \n All distributions support HTTPS connections from viewers. To require viewers to use HTTPS only, or to redirect them from HTTP to HTTPS, use ``ViewerProtocolPolicy`` in the ``CacheBehavior`` or ``DefaultCacheBehavior``. To specify how CloudFront should use SSL/TLS to communicate with your custom origin, use ``CustomOriginConfig``.\n For 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 *Amazon CloudFront Developer Guide*.", "properties": { "AcmCertificateArn": { + "description": "In CloudFormation, this field name is ``AcmCertificateArn``. Note the different capitalization.\n If the distribution uses ``Aliases`` (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in [(ACM)](https://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html), provide the Amazon Resource Name (ARN) of the ACM certificate. CloudFront only supports ACM certificates in the US East (N. Virginia) Region (``us-east-1``).\n If you specify an ACM certificate ARN, you must also specify values for ``MinimumProtocolVersion`` and ``SSLSupportMethod``. (In CloudFormation, the field name is ``SslSupportMethod``. Note the different capitalization.)", "type": "string" }, "CloudFrontDefaultCertificate": { + "description": "If the distribution uses the CloudFront domain name such as ``d111111abcdef8.cloudfront.net``, set this field to ``true``.\n If 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 value for one, not both) \n + ``MinimumProtocolVersion`` \n + ``SslSupportMethod``", "type": "boolean" }, "IamCertificateId": { + "description": "In CloudFormation, this field name is ``IamCertificateId``. Note the different capitalization.\n If the distribution uses ``Aliases`` (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in [(IAM)](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html), provide the ID of the IAM certificate.\n If you specify an IAM certificate ID, you must also specify values for ``MinimumProtocolVersion`` and ``SSLSupportMethod``. (In CloudFormation, the field name is ``SslSupportMethod``. Note the different capitalization.)", "type": "string" }, "MinimumProtocolVersion": { + "description": "If the distribution uses ``Aliases`` (alternate domain names or CNAMEs), specify the security policy that you want CloudFront to use for HTTPS connections with viewers. The security policy determines two settings:\n + The minimum SSL/TLS protocol that CloudFront can use to communicate with viewers.\n + The ciphers that CloudFront can use to encrypt the content that it returns to viewers.\n \n For more information, see [Security Policy](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValues-security-policy) and [Supported Protocols and Ciphers Between Viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html#secure-connections-supported-ciphers) in the *Amazon CloudFront Developer Guide*.\n On the CloudFront console, this setting is called *Security Policy*.\n When you're using SNI only (you set ``SSLSupportMethod`` to ``sni-only``), you must specify ``TLSv1`` or higher. (In CloudFormation, the field name is ``SslSupportMethod``. Note the different capitalization.)\n If the distribution uses the CloudFront domain name such as ``d111111abcdef8.cloudfront.net`` (you set ``CloudFrontDefaultCertificate`` to ``true``), CloudFront automatically sets the security policy to ``TLSv1`` regardless of the value that you set here.", "type": "string" }, "SslSupportMethod": { + "description": "In CloudFormation, this field name is ``SslSupportMethod``. Note the different capitalization.\n If the distribution uses ``Aliases`` (alternate domain names or CNAMEs), specify which viewers the distribution accepts HTTPS connections from.\n + ``sni-only`` ? The distribution accepts HTTPS connections from only viewers that support [server name indication (SNI)](https://docs.aws.amazon.com/https://en.wikipedia.org/wiki/Server_Name_Indication). This is recommended. Most browsers and clients support SNI.\n + ``vip`` ? The distribution accepts HTTPS connections from all viewers including those that don't support SNI. This is not recommended, and results in additional monthly charges from CloudFront.\n + ``static-ip`` - Do not specify this value unless your distribution has been enabled for this feature by the CloudFront team. If you have a use case that requires static IP addresses for a distribution, contact CloudFront through the [Center](https://docs.aws.amazon.com/support/home).\n \n If the distribution uses the CloudFront domain name such as ``d111111abcdef8.cloudfront.net``, don't set a value for this field.", "type": "string" } }, @@ -795,7 +949,7 @@ "/properties/DistributionConfig/properties/CustomOrigin", "/properties/DistributionConfig/properties/S3Origin" ], - "description": "Resource Type definition for AWS::CloudFront::Distribution", + "description": "A distribution tells CloudFront where you want content to be delivered from, and the details about how to track and manage content delivery.", "handlers": { "create": { "permissions": [ @@ -841,15 +995,19 @@ ], "properties": { "DistributionConfig": { - "$ref": "#/definitions/DistributionConfig" + "$ref": "#/definitions/DistributionConfig", + "description": "The distribution's configuration." }, "DomainName": { + "description": "", "type": "string" }, "Id": { + "description": "", "type": "string" }, "Tags": { + "description": "A complex type that contains zero or more ``Tag`` elements.", "items": { "$ref": "#/definitions/Tag" }, diff --git a/artifacts/types/AWS::CloudFront::Function.json b/artifacts/types/AWS::CloudFront::Function.json index b8e2d38f..cc3dc764 100644 --- a/artifacts/types/AWS::CloudFront::Function.json +++ b/artifacts/types/AWS::CloudFront::Function.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-CloudFront-Function", "type": "AWS::CloudFront::Function", - "time": "2024-01-04T19:30:54.019Z", + "time": "2024-05-30T17:58:00.22Z", "schema": { "additionalProperties": false, "definitions": { diff --git a/artifacts/types/AWS::CloudFront::KeyGroup.json b/artifacts/types/AWS::CloudFront::KeyGroup.json index 63869277..bcbafe6d 100644 --- a/artifacts/types/AWS::CloudFront::KeyGroup.json +++ b/artifacts/types/AWS::CloudFront::KeyGroup.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-CloudFront-KeyGroup", "type": "AWS::CloudFront::KeyGroup", - "time": "2024-01-04T23:11:39.567Z", + "time": "2024-05-30T17:57:58.659Z", "schema": { "additionalProperties": false, "definitions": { diff --git a/artifacts/types/AWS::CloudFront::KeyValueStore.json b/artifacts/types/AWS::CloudFront::KeyValueStore.json index 8676a399..cd3c1db6 100644 --- a/artifacts/types/AWS::CloudFront::KeyValueStore.json +++ b/artifacts/types/AWS::CloudFront::KeyValueStore.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-CloudFront-KeyValueStore", "type": "AWS::CloudFront::KeyValueStore", - "time": "2024-01-04T16:39:45.953Z", + "time": "2024-05-30T17:57:56.407Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::CloudFront::OriginAccessControl.json b/artifacts/types/AWS::CloudFront::OriginAccessControl.json index a6d2a69e..e532a222 100644 --- a/artifacts/types/AWS::CloudFront::OriginAccessControl.json +++ b/artifacts/types/AWS::CloudFront::OriginAccessControl.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-CloudFront-OriginAccessControl", "type": "AWS::CloudFront::OriginAccessControl", - "time": "2024-01-04T18:21:36.157Z", + "time": "2024-05-30T17:57:57.854Z", "schema": { "additionalProperties": false, "definitions": { @@ -15,7 +15,7 @@ "type": "string" }, "OriginAccessControlOriginType": { - "pattern": "^(s3|mediastore)$", + "pattern": "^(s3|mediastore|lambda|mediapackagev2)$", "type": "string" }, "SigningBehavior": { diff --git a/artifacts/types/AWS::CloudFront::OriginRequestPolicy.json b/artifacts/types/AWS::CloudFront::OriginRequestPolicy.json index cb0d7682..f0260bbb 100644 --- a/artifacts/types/AWS::CloudFront::OriginRequestPolicy.json +++ b/artifacts/types/AWS::CloudFront::OriginRequestPolicy.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-CloudFront-OriginRequestPolicy", "type": "AWS::CloudFront::OriginRequestPolicy", - "time": "2024-01-04T19:09:47.983Z", + "time": "2024-05-30T17:57:59.554Z", "schema": { "additionalProperties": false, "definitions": { diff --git a/artifacts/types/AWS::CloudFront::PublicKey.json b/artifacts/types/AWS::CloudFront::PublicKey.json index 2799c3f8..26ced635 100644 --- a/artifacts/types/AWS::CloudFront::PublicKey.json +++ b/artifacts/types/AWS::CloudFront::PublicKey.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-CloudFront-PublicKey", "type": "AWS::CloudFront::PublicKey", - "time": "2024-01-04T23:27:56.82Z", + "time": "2024-05-30T17:59:01.779Z", "schema": { "additionalProperties": false, "definitions": { diff --git a/artifacts/types/AWS::CloudFront::RealtimeLogConfig.json b/artifacts/types/AWS::CloudFront::RealtimeLogConfig.json index a2de88d4..41f8f50f 100644 --- a/artifacts/types/AWS::CloudFront::RealtimeLogConfig.json +++ b/artifacts/types/AWS::CloudFront::RealtimeLogConfig.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-CloudFront-RealtimeLogConfig", "type": "AWS::CloudFront::RealtimeLogConfig", - "time": "2024-01-04T23:44:31.192Z", + "time": "2024-05-30T17:58:00.826Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::CloudFront::ResponseHeadersPolicy.json b/artifacts/types/AWS::CloudFront::ResponseHeadersPolicy.json index 14dee715..fe6e4094 100644 --- a/artifacts/types/AWS::CloudFront::ResponseHeadersPolicy.json +++ b/artifacts/types/AWS::CloudFront::ResponseHeadersPolicy.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-CloudFront-ResponseHeadersPolicy", "type": "AWS::CloudFront::ResponseHeadersPolicy", - "time": "2024-01-04T16:55:29.243Z", + "time": "2024-05-30T17:57:56.655Z", "schema": { "additionalProperties": false, "definitions": { diff --git a/artifacts/types/AWS::CloudTrail::Channel.json b/artifacts/types/AWS::CloudTrail::Channel.json index 0581a058..0792eaee 100644 --- a/artifacts/types/AWS::CloudTrail::Channel.json +++ b/artifacts/types/AWS::CloudTrail::Channel.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-CloudTrail-Channel", "type": "AWS::CloudTrail::Channel", - "time": "2023-12-06T19:50:21.65Z", + "time": "2024-04-15T16:21:38.493Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::CloudTrail::EventDataStore.json b/artifacts/types/AWS::CloudTrail::EventDataStore.json index cab29840..77225b3f 100644 --- a/artifacts/types/AWS::CloudTrail::EventDataStore.json +++ b/artifacts/types/AWS::CloudTrail::EventDataStore.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-CloudTrail-EventDataStore", "type": "AWS::CloudTrail::EventDataStore", - "time": "2023-12-06T22:08:56.51Z", + "time": "2024-04-15T16:22:04.517Z", "schema": { "additionalProperties": false, "definitions": { @@ -230,7 +230,8 @@ "glue:PassConnection", "lakeformation:RegisterResource", "glue:DeleteTable", - "lakeformation:DeregisterResource" + "lakeformation:DeregisterResource", + "kms:DescribeKey" ] } }, diff --git a/artifacts/types/AWS::CloudTrail::ResourcePolicy.json b/artifacts/types/AWS::CloudTrail::ResourcePolicy.json index 9f1dc0ca..aa5ff6f3 100644 --- a/artifacts/types/AWS::CloudTrail::ResourcePolicy.json +++ b/artifacts/types/AWS::CloudTrail::ResourcePolicy.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-CloudTrail-ResourcePolicy", "type": "AWS::CloudTrail::ResourcePolicy", - "time": "2023-12-06T19:40:02.984Z", + "time": "2024-01-24T21:12:20.617Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::CloudTrail::Trail.json b/artifacts/types/AWS::CloudTrail::Trail.json index 934ffe37..80619814 100644 --- a/artifacts/types/AWS::CloudTrail::Trail.json +++ b/artifacts/types/AWS::CloudTrail::Trail.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-CloudTrail-Trail", "type": "AWS::CloudTrail::Trail", - "time": "2023-12-06T19:46:19.858Z", + "time": "2024-01-24T21:17:27.836Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::CloudWatch::Alarm.json b/artifacts/types/AWS::CloudWatch::Alarm.json index d3778e3c..5c365a2f 100644 --- a/artifacts/types/AWS::CloudWatch::Alarm.json +++ b/artifacts/types/AWS::CloudWatch::Alarm.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-CloudWatch-Alarm", "type": "AWS::CloudWatch::Alarm", - "time": "2023-12-18T10:21:44.223Z", + "time": "2024-04-02T13:25:30.821Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -10,14 +10,14 @@ "definitions": { "Dimension": { "additionalProperties": false, - "description": "Dimensions are arbitrary name/value pairs that can be associated with a CloudWatch metric.", + "description": "Dimension is an embedded property of the ``AWS::CloudWatch::Alarm`` type. Dimensions are name/value pairs that can be associated with a CW metric. You can specify a maximum of 10 dimensions for a given metric.", "properties": { "Name": { - "description": "The name of the dimension.", + "description": "The name of the dimension, from 1?255 characters in length. This dimension name must have been included when the metric was published.", "type": "string" }, "Value": { - "description": "The value for the dimension.", + "description": "The value for the dimension, from 1?255 characters in length.", "type": "string" } }, @@ -29,10 +29,10 @@ }, "Metric": { "additionalProperties": false, - "description": "The Metric property type represents a specific metric.", + "description": "The ``Metric`` property type represents a specific metric. ``Metric`` is a property of the [MetricStat](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricstat.html) property type.", "properties": { "Dimensions": { - "description": "The dimensions for the metric.", + "description": "The metric dimensions that you want to be used for the metric that the alarm will watch.", "insertionOrder": false, "items": { "$ref": "#/definitions/Dimension" @@ -41,11 +41,11 @@ "uniqueItems": false }, "MetricName": { - "description": "The name of the metric.", + "description": "The name of the metric that you want the alarm to watch. This is a required field.", "type": "string" }, "Namespace": { - "description": "The namespace of the metric.", + "description": "The namespace of the metric that the alarm will watch.", "type": "string" } }, @@ -53,34 +53,34 @@ }, "MetricDataQuery": { "additionalProperties": false, - "description": "This property type specifies the metric data to return, and whether this call is just retrieving a batch set of data for one metric, or is performing a math expression on metric data.", + "description": "The ``MetricDataQuery`` property type specifies the metric data to return, and whether this call is just retrieving a batch set of data for one metric, or is performing a math expression on metric data. \n Any 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 *User Guide*.", "properties": { "AccountId": { "description": "The ID of the account where the metrics are located, if this is a cross-account alarm.", "type": "string" }, "Expression": { - "description": "The math expression to be performed on the returned data.", + "description": "The math expression to be performed on the returned data, if this object is performing a math expression. This expression can use the ``Id`` of the other metrics to refer to those metrics, and can also use the ``Id`` of other expressions to use the result of those expressions. For more information about metric math expressions, see [Metric Math Syntax and Functions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) in the *User Guide*.\n Within each MetricDataQuery object, you must specify either ``Expression`` or ``MetricStat`` but not both.", "type": "string" }, "Id": { - "description": "A short name used to tie this object to the results in the response.", + "description": "A short name used to tie this object to the results in the response. This name must be unique within a single call to ``GetMetricData``. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.", "type": "string" }, "Label": { - "description": "A human-readable label for this metric or expression.", + "description": "A human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know what the value represents. If the metric or expression is shown in a CW dashboard widget, the label is shown. If ``Label`` is omitted, CW generates a default.", "type": "string" }, "MetricStat": { "$ref": "#/definitions/MetricStat", - "description": "The metric to be returned, along with statistics, period, and units." + "description": "The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data.\n Within one MetricDataQuery object, you must specify either ``Expression`` or ``MetricStat`` but not both." }, "Period": { - "description": "The period in seconds, over which the statistic is applied.", + "description": "The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a ``PutMetricData`` operation that includes a ``StorageResolution of 1 second``.", "type": "integer" }, "ReturnData": { - "description": "This option indicates whether to return the timestamps and raw data values of this metric.", + "description": "This option indicates whether to return the timestamps and raw data values of this metric.\n When you create an alarm based on a metric math expression, specify ``True`` for this value for only the one math expression that the alarm is based on. You must specify ``False`` for ``ReturnData`` for all the other metrics and expressions used in the alarm.\n This field is required.", "type": "boolean" } }, @@ -91,22 +91,22 @@ }, "MetricStat": { "additionalProperties": false, - "description": "This structure defines the metric to be returned, along with the statistics, period, and units.", + "description": "This structure defines the metric to be returned, along with the statistics, period, and units.\n ``MetricStat`` is a property of the [MetricDataQuery](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricdataquery.html) property type.", "properties": { "Metric": { "$ref": "#/definitions/Metric", "description": "The metric to return, including the metric name, namespace, and dimensions." }, "Period": { - "description": "The granularity, in seconds, of the returned data points.", + "description": "The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a ``PutMetricData`` call that includes a ``StorageResolution`` of 1 second.\n If the ``StartTime`` parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:\n + Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).\n + Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).\n + Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).", "type": "integer" }, "Stat": { - "description": "The statistic to return.", + "description": "The statistic to return. It can include any CW statistic or extended statistic. For a list of valid values, see the table in [Statistics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic) in the *User Guide*.", "type": "string" }, "Unit": { - "description": "The unit to use for the returned data points.", + "description": "The unit to use for the returned data points. \n Valid values are: 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, or None.", "type": "string" } }, @@ -116,14 +116,38 @@ "Metric" ], "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "", + "properties": { + "Key": { + "description": "A unique identifier for the tag. The combination of tag keys and values can help you organize and categorize your resources.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the specified tag key.", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" } }, - "description": "Resource Type definition for AWS::CloudWatch::Alarm", + "description": "The ``AWS::CloudWatch::Alarm`` type specifies an alarm and associates it with the specified metric or metric math expression.\n When this operation creates an alarm, the alarm state is immediately set to ``INSUFFICIENT_DATA``. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed.\n When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.", "handlers": { "create": { "permissions": [ "cloudwatch:PutMetricAlarm", - "cloudwatch:DescribeAlarms" + "cloudwatch:DescribeAlarms", + "cloudwatch:TagResource" ] }, "delete": { @@ -139,13 +163,16 @@ }, "read": { "permissions": [ - "cloudwatch:DescribeAlarms" + "cloudwatch:DescribeAlarms", + "cloudwatch:ListTagsForResource" ] }, "update": { "permissions": [ "cloudwatch:PutMetricAlarm", - "cloudwatch:DescribeAlarms" + "cloudwatch:DescribeAlarms", + "cloudwatch:TagResource", + "cloudwatch:UntagResource" ] } }, @@ -159,7 +186,7 @@ "type": "boolean" }, "AlarmActions": { - "description": "The list of actions to execute when this alarm transitions into an ALARM state from any other state.", + "description": "The list of actions to execute when this alarm transitions into an ALARM state from any other state. Specify each action as an Amazon Resource Name (ARN). For more information about creating alarms and the actions that you can specify, see [PutMetricAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutMetricAlarm.html) in the *API Reference*.", "items": { "type": "string" }, @@ -171,23 +198,23 @@ "type": "string" }, "AlarmName": { - "description": "The name of the alarm.", + "description": "The name of the alarm. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the alarm name. \n If 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.", "type": "string" }, "Arn": { - "description": "Amazon Resource Name is a unique name for each resource.", + "description": "", "type": "string" }, "ComparisonOperator": { - "description": "The arithmetic operation to use when comparing the specified statistic and threshold.", + "description": "The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.", "type": "string" }, "DatapointsToAlarm": { - "description": "The number of datapoints that must be breaching to trigger the alarm.", + "description": "The number of datapoints that must be breaching to trigger the alarm. This is used only if you are setting an \"M out of N\" alarm. In that case, this value is the M, and the value that you set for ``EvaluationPeriods`` is the N value. For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *User Guide*.\n If you omit this parameter, CW uses the same value here that you set for ``EvaluationPeriods``, and the alarm goes to alarm state if that many consecutive periods are breaching.", "type": "integer" }, "Dimensions": { - "description": "The dimensions for the metric associated with the alarm. For an alarm based on a math expression, you can't specify Dimensions. Instead, you use Metrics.", + "description": "The dimensions for the metric associated with the alarm. For an alarm based on a math expression, you can't specify ``Dimensions``. Instead, you use ``Metrics``.", "insertionOrder": false, "items": { "$ref": "#/definitions/Dimension" @@ -196,19 +223,19 @@ "uniqueItems": false }, "EvaluateLowSampleCountPercentile": { - "description": "Used only for alarms based on percentiles.", + "description": "Used only for alarms based on percentiles. If ``ignore``, the alarm state does not change during periods with too few data points to be statistically significant. If ``evaluate`` or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.", "type": "string" }, "EvaluationPeriods": { - "description": "The number of periods over which data is compared to the specified threshold.", + "description": "The number of periods over which data is compared to the specified threshold. If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies that number. If you are setting an \"M out of N\" alarm, this value is the N, and ``DatapointsToAlarm`` is the M.\n For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *User Guide*.", "type": "integer" }, "ExtendedStatistic": { - "description": "The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.", + "description": "The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.\n For an alarm based on a metric, you must specify either ``Statistic`` or ``ExtendedStatistic`` but not both.\n For an alarm based on a math expression, you can't specify ``ExtendedStatistic``. Instead, you use ``Metrics``.", "type": "string" }, "InsufficientDataActions": { - "description": "The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state.", + "description": "The actions to execute when this alarm transitions to the ``INSUFFICIENT_DATA`` state from any other state. Each action is specified as an Amazon Resource Name (ARN).", "items": { "type": "string" }, @@ -216,11 +243,11 @@ "uniqueItems": false }, "MetricName": { - "description": "The name of the metric associated with the alarm.", + "description": "The name of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you use ``Metrics`` instead and you can't specify ``MetricName``.", "type": "string" }, "Metrics": { - "description": "An array that enables you to create an alarm based on the result of a metric math expression.", + "description": "An array that enables you to create an alarm based on the result of a metric math expression. Each item in the array either retrieves a metric or performs a math expression.\n If you specify the ``Metrics`` parameter, you cannot specify ``MetricName``, ``Dimensions``, ``Period``, ``Namespace``, ``Statistic``, ``ExtendedStatistic``, or ``Unit``.", "items": { "$ref": "#/definitions/MetricDataQuery" }, @@ -228,11 +255,11 @@ "uniqueItems": true }, "Namespace": { - "description": "The namespace of the metric associated with the alarm.", + "description": "The namespace of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you can't specify ``Namespace`` and you use ``Metrics`` instead.\n For a list of namespaces for metrics from AWS services, see [Services That Publish Metrics.](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html)", "type": "string" }, "OKActions": { - "description": "The actions to execute when this alarm transitions to the OK state from any other state.", + "description": "The actions to execute when this alarm transitions to the ``OK`` state from any other state. Each action is specified as an Amazon Resource Name (ARN).", "items": { "type": "string" }, @@ -240,27 +267,36 @@ "uniqueItems": false }, "Period": { - "description": "The period in seconds, over which the statistic is applied.", + "description": "The period, in seconds, over which the statistic is applied. This is required for an alarm based on a metric. Valid values are 10, 30, 60, and any multiple of 60.\n For an alarm based on a math expression, you can't specify ``Period``, and instead you use the ``Metrics`` parameter.\n *Minimum:* 10", "type": "integer" }, "Statistic": { - "description": "The statistic for the metric associated with the alarm, other than percentile.", + "description": "The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ``ExtendedStatistic``.\n For an alarm based on a metric, you must specify either ``Statistic`` or ``ExtendedStatistic`` but not both.\n For an alarm based on a math expression, you can't specify ``Statistic``. Instead, you use ``Metrics``.", "type": "string" }, + "Tags": { + "description": "", + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + }, "Threshold": { - "description": "In an alarm based on an anomaly detection model, this is the ID of the ANOMALY_DETECTION_BAND function used as the threshold for the alarm.", + "description": "The value to compare with the specified statistic.", "type": "number" }, "ThresholdMetricId": { - "description": "In an alarm based on an anomaly detection model, this is the ID of the ANOMALY_DETECTION_BAND function used as the threshold for the alarm.", + "description": "In an alarm based on an anomaly detection model, this is the ID of the ``ANOMALY_DETECTION_BAND`` function used as the threshold for the alarm.", "type": "string" }, "TreatMissingData": { - "description": "Sets how this alarm is to handle missing data points. Valid values are breaching, notBreaching, ignore, and missing.", + "description": "Sets how this alarm is to handle missing data points. Valid values are ``breaching``, ``notBreaching``, ``ignore``, and ``missing``. For more information, see [Configuring How Alarms Treat Missing Data](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data) in the *Amazon User Guide*.\n If you omit this parameter, the default behavior of ``missing`` is used.", "type": "string" }, "Unit": { - "description": "The unit of the metric associated with the alarm.", + "description": "The unit of the metric associated with the alarm. Specify this only if you are creating an alarm based on a single metric. Do not specify this if you are specifying a ``Metrics`` array.\n You can specify the following values: 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, or None.", "type": "string" } }, @@ -273,7 +309,11 @@ ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-cloudwatch.git", "tagging": { - "taggable": false + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true }, "typeName": "AWS::CloudWatch::Alarm" } diff --git a/artifacts/types/AWS::CloudWatch::CompositeAlarm.json b/artifacts/types/AWS::CloudWatch::CompositeAlarm.json index 7fbd4c67..74524986 100644 --- a/artifacts/types/AWS::CloudWatch::CompositeAlarm.json +++ b/artifacts/types/AWS::CloudWatch::CompositeAlarm.json @@ -1,18 +1,50 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-CloudWatch-CompositeAlarm", "type": "AWS::CloudWatch::CompositeAlarm", - "time": "2023-12-18T09:54:51.426Z", + "time": "2024-04-02T13:07:59.357Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ "/properties/AlarmName" ], + "definitions": { + "AlarmActionARN": { + "description": "Amazon Resource Name (ARN) of the action", + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "Metadata that you can assign to a composite alarm, Tags can help you organize and categorize your resources.", + "properties": { + "Key": { + "description": "A unique identifier for the tag. The combination of tag keys and values can help you organize and categorize your resources.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the specified tag key.", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, "description": "The AWS::CloudWatch::CompositeAlarm type specifies an alarm which aggregates the states of other Alarms (Metric or Composite Alarms) as defined by the AlarmRule expression", "handlers": { "create": { "permissions": [ "cloudwatch:DescribeAlarms", - "cloudwatch:PutCompositeAlarm" + "cloudwatch:PutCompositeAlarm", + "cloudwatch:TagResource" ] }, "delete": { @@ -28,13 +60,16 @@ }, "read": { "permissions": [ - "cloudwatch:DescribeAlarms" + "cloudwatch:DescribeAlarms", + "cloudwatch:ListTagsForResource" ] }, "update": { "permissions": [ "cloudwatch:DescribeAlarms", - "cloudwatch:PutCompositeAlarm" + "cloudwatch:PutCompositeAlarm", + "cloudwatch:TagResource", + "cloudwatch:UntagResource" ] } }, @@ -118,6 +153,15 @@ }, "maxItems": 5, "type": "array" + }, + "Tags": { + "description": "A list of key-value pairs to associate with the composite alarm. You can associate as many as 50 tags with an alarm.", + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true } }, "readOnlyProperties": [ @@ -128,7 +172,11 @@ ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-cloudwatch.git", "tagging": { - "taggable": false + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true }, "typeName": "AWS::CloudWatch::CompositeAlarm" } diff --git a/artifacts/types/AWS::CloudWatch::MetricStream.json b/artifacts/types/AWS::CloudWatch::MetricStream.json index ded99e88..ec52a6a8 100644 --- a/artifacts/types/AWS::CloudWatch::MetricStream.json +++ b/artifacts/types/AWS::CloudWatch::MetricStream.json @@ -1,10 +1,10 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-CloudWatch-MetricStream", "type": "AWS::CloudWatch::MetricStream", - "time": "2023-12-21T17:19:14.055Z", + "time": "2024-06-20T22:56:25.831Z", "schema": { "additionalProperties": false, - "anyOf": [ + "allOf": [ { "required": [ "FirehoseArn", @@ -12,26 +12,12 @@ "OutputFormat" ] }, - { - "allOf": [ - { - "required": [ - "FirehoseArn", - "RoleArn", - "OutputFormat" - ] - } - ] - }, { "oneOf": [ + {}, { "required": [ - "IncludeFilters" - ] - }, - { - "required": [ + "IncludeFilters", "ExcludeFilters" ] } @@ -133,7 +119,7 @@ "Value": { "description": "String which you can use to describe or define the tag.", "maxLength": 256, - "minLength": 1, + "minLength": 0, "type": "string" } }, @@ -291,11 +277,6 @@ "/properties/LastUpdateDate", "/properties/State" ], - "required": [ - "FirehoseArn", - "RoleArn", - "OutputFormat" - ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-cloudwatch.git", "taggable": true, "typeName": "AWS::CloudWatch::MetricStream", diff --git a/artifacts/types/AWS::CodeArtifact::Domain.json b/artifacts/types/AWS::CodeArtifact::Domain.json index 2559ccd0..f1ef54cb 100644 --- a/artifacts/types/AWS::CodeArtifact::Domain.json +++ b/artifacts/types/AWS::CodeArtifact::Domain.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-CodeArtifact-Domain", "type": "AWS::CodeArtifact::Domain", - "time": "2024-01-04T16:49:26.524Z", + "time": "2024-06-20T16:19:36.156Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -14,15 +14,15 @@ "description": "A key-value pair to associate with a resource.", "properties": { "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", "maxLength": 128, "minLength": 1, "type": "string" }, "Value": { - "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "description": "The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", "maxLength": 256, - "minLength": 0, + "minLength": 1, "type": "string" } }, @@ -129,6 +129,13 @@ "DomainName" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-codeartifact", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, "typeName": "AWS::CodeArtifact::Domain" } } \ No newline at end of file diff --git a/artifacts/types/AWS::CodeArtifact::PackageGroup.json b/artifacts/types/AWS::CodeArtifact::PackageGroup.json new file mode 100644 index 00000000..05fb823f --- /dev/null +++ b/artifacts/types/AWS::CodeArtifact::PackageGroup.json @@ -0,0 +1,216 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-CodeArtifact-PackageGroup", + "type": "AWS::CodeArtifact::PackageGroup", + "time": "2024-06-20T17:11:01.963Z", + "schema": { + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DomainName", + "/properties/Pattern" + ], + "definitions": { + "OriginConfiguration": { + "additionalProperties": false, + "properties": { + "Restrictions": { + "$ref": "#/definitions/Restrictions", + "description": "The origin configuration that is applied to the package group.", + "type": "object" + } + }, + "required": [ + "Restrictions" + ], + "type": "object" + }, + "RestrictionType": { + "additionalProperties": false, + "properties": { + "Repositories": { + "items": { + "type": "string" + }, + "type": "array" + }, + "RestrictionMode": { + "enum": [ + "ALLOW", + "BLOCK", + "ALLOW_SPECIFIC_REPOSITORIES", + "INHERIT" + ], + "type": "string" + } + }, + "required": [ + "RestrictionMode" + ], + "type": "object" + }, + "Restrictions": { + "additionalProperties": false, + "properties": { + "ExternalUpstream": { + "$ref": "#/definitions/RestrictionType", + "description": "The external upstream restriction determines if new package versions can be ingested or retained from external connections.", + "type": "object" + }, + "InternalUpstream": { + "$ref": "#/definitions/RestrictionType", + "description": "The internal upstream restriction determines if new package versions can be ingested or retained from upstream repositories.", + "type": "object" + }, + "Publish": { + "$ref": "#/definitions/RestrictionType", + "description": "The publish restriction determines if new package versions can be published.", + "type": "object" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "The resource schema to create a CodeArtifact package group.", + "handlers": { + "create": { + "permissions": [ + "codeartifact:CreatePackageGroup", + "codeartifact:DescribePackageGroup", + "codeartifact:UpdatePackageGroup", + "codeartifact:UpdatePackageGroupOriginConfiguration", + "codeartifact:ListAllowedRepositoriesForGroup", + "codeartifact:ListTagsForResource", + "codeartifact:TagResource" + ] + }, + "delete": { + "permissions": [ + "codeartifact:DeletePackageGroup", + "codeartifact:DescribePackageGroup" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "DomainName": { + "$ref": "resource-schema.json#/properties/DomainName" + } + }, + "required": [ + "DomainName" + ] + }, + "permissions": [ + "codeartifact:ListPackageGroups" + ] + }, + "read": { + "permissions": [ + "codeartifact:DescribePackageGroup", + "codeartifact:ListAllowedRepositoriesForGroup", + "codeartifact:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "codeartifact:UpdatePackageGroup", + "codeartifact:UpdatePackageGroupOriginConfiguration", + "codeartifact:DescribePackageGroup", + "codeartifact:ListAllowedRepositoriesForGroup", + "codeartifact:ListTagsForResource", + "codeartifact:TagResource", + "codeartifact:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "The ARN of the package group.", + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "ContactInfo": { + "description": "The contact info of the package group.", + "maxLength": 1000, + "type": "string" + }, + "Description": { + "description": "The text description of the package group.", + "maxLength": 1000, + "type": "string" + }, + "DomainName": { + "description": "The name of the domain that contains the package group.", + "maxLength": 50, + "minLength": 2, + "pattern": "^([a-z][a-z0-9\\-]{0,48}[a-z0-9])$", + "type": "string" + }, + "DomainOwner": { + "description": "The 12-digit account ID of the AWS account that owns the domain.", + "pattern": "[0-9]{12}", + "type": "string" + }, + "OriginConfiguration": { + "$ref": "#/definitions/OriginConfiguration", + "description": "The package origin configuration of the package group.", + "type": "object" + }, + "Pattern": { + "description": "The package group pattern that is used to gather packages.", + "maxLength": 520, + "minLength": 2, + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to the package group.", + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "Pattern", + "DomainName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-codeartifact", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::CodeArtifact::PackageGroup" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::CodeArtifact::Repository.json b/artifacts/types/AWS::CodeArtifact::Repository.json index 4488769d..c01c9a22 100644 --- a/artifacts/types/AWS::CodeArtifact::Repository.json +++ b/artifacts/types/AWS::CodeArtifact::Repository.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-CodeArtifact-Repository", "type": "AWS::CodeArtifact::Repository", - "time": "2024-01-04T16:54:14.697Z", + "time": "2024-06-20T16:45:23.549Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -15,15 +15,15 @@ "description": "A key-value pair to associate with a resource.", "properties": { "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", "maxLength": 128, "minLength": 1, "type": "string" }, "Value": { - "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "description": "The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", "maxLength": 256, - "minLength": 0, + "minLength": 1, "type": "string" } }, @@ -157,6 +157,13 @@ "DomainName" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-codeartifact", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, "typeName": "AWS::CodeArtifact::Repository" } } \ No newline at end of file diff --git a/artifacts/types/AWS::CodeBuild::Fleet.json b/artifacts/types/AWS::CodeBuild::Fleet.json new file mode 100644 index 00000000..6cee539c --- /dev/null +++ b/artifacts/types/AWS::CodeBuild::Fleet.json @@ -0,0 +1,159 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-CodeBuild-Fleet", + "type": "AWS::CodeBuild::Fleet", + "time": "2024-05-23T10:17:03.218Z", + "schema": { + "additionalProperties": false, + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 128, + "minLength": 1, + "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 255 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 256, + "minLength": 0, + "pattern": "[a-zA-Z+-=._:/]+$", + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, + "VpcConfig": { + "additionalProperties": false, + "properties": { + "SecurityGroupIds": { + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + }, + "Subnets": { + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + }, + "VpcId": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::CodeBuild::Fleet", + "handlers": { + "create": { + "permissions": [ + "codebuild:BatchGetFleets", + "codebuild:CreateFleet", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "codebuild:BatchGetFleets", + "codebuild:DeleteFleet" + ] + }, + "list": { + "permissions": [ + "codebuild:ListFleets" + ] + }, + "read": { + "permissions": [ + "codebuild:BatchGetFleets" + ] + }, + "update": { + "permissions": [ + "codebuild:BatchGetFleets", + "codebuild:UpdateFleet", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "minLength": 1, + "type": "string" + }, + "BaseCapacity": { + "minimum": 1, + "type": "integer" + }, + "ComputeType": { + "enum": [ + "BUILD_GENERAL1_SMALL", + "BUILD_GENERAL1_MEDIUM", + "BUILD_GENERAL1_LARGE", + "BUILD_GENERAL1_2XLARGE" + ], + "type": "string" + }, + "EnvironmentType": { + "enum": [ + "WINDOWS_SERVER_2019_CONTAINER", + "WINDOWS_SERVER_2022_CONTAINER", + "LINUX_CONTAINER", + "LINUX_GPU_CONTAINER", + "ARM_CONTAINER" + ], + "type": "string" + }, + "FleetServiceRole": { + "pattern": "^(?:arn:)[a-zA-Z+-=,._:/@]+$", + "type": "string" + }, + "FleetVpcConfig": { + "$ref": "#/definitions/VpcConfig" + }, + "Name": { + "maxLength": 128, + "minLength": 2, + "type": "string" + }, + "OverflowBehavior": { + "enum": [ + "QUEUE", + "ON_DEMAND" + ], + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::CodeBuild::Fleet" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::CodeConnections::Connection.json b/artifacts/types/AWS::CodeConnections::Connection.json new file mode 100644 index 00000000..9115e03a --- /dev/null +++ b/artifacts/types/AWS::CodeConnections::Connection.json @@ -0,0 +1,136 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-CodeConnections-Connection", + "type": "AWS::CodeConnections::Connection", + "time": "2024-03-29T22:03:26.363Z", + "schema": { + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ConnectionName", + "/properties/ProviderType", + "/properties/HostArn" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Schema for AWS::CodeConnections::Connection resource which can be used to connect external source providers with other AWS services (i.e. AWS CodePipeline)", + "handlers": { + "create": { + "permissions": [ + "codeconnections:CreateConnection", + "codeconnections:TagResource" + ] + }, + "delete": { + "permissions": [ + "codeconnections:DeleteConnection" + ] + }, + "list": { + "permissions": [ + "codeconnections:ListConnections", + "codeconnections:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "codeconnections:GetConnection", + "codeconnections:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "codeconnections:ListTagsForResource", + "codeconnections:TagResource", + "codeconnections:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/ConnectionArn" + ], + "properties": { + "ConnectionArn": { + "description": "The Amazon Resource Name (ARN) of the connection. The ARN is used as the connection reference when the connection is shared between AWS services.", + "maxLength": 256, + "minLength": 0, + "pattern": "arn:aws(-[\\w]+)*:.+:.+:[0-9]{12}:.+", + "type": "string" + }, + "ConnectionName": { + "description": "The name of the connection. Connection names must be unique in an AWS user account.", + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "ConnectionStatus": { + "description": "The current status of the connection.", + "type": "string" + }, + "HostArn": { + "description": "The host arn configured to represent the infrastructure where your third-party provider is installed. You must specify either a ProviderType or a HostArn.", + "maxLength": 256, + "minLength": 0, + "pattern": "arn:aws(-[\\w]+)*:.+:.+:[0-9]{12}:.+", + "type": "string" + }, + "OwnerAccountId": { + "description": "The name of the external provider where your third-party code repository is configured. For Bitbucket, this is the account ID of the owner of the Bitbucket repository.", + "maxLength": 12, + "minLength": 12, + "pattern": "[0-9]{12}", + "type": "string" + }, + "ProviderType": { + "description": "The name of the external provider where your third-party code repository is configured. You must specify either a ProviderType or a HostArn.", + "type": "string" + }, + "Tags": { + "description": "Specifies the tags applied to a connection.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/ConnectionArn", + "/properties/ConnectionStatus", + "/properties/OwnerAccountId" + ], + "required": [ + "ConnectionName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-codeconnections.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::CodeConnections::Connection" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::CodeDeploy::Application.json b/artifacts/types/AWS::CodeDeploy::Application.json index 213de23b..409cb250 100644 --- a/artifacts/types/AWS::CodeDeploy::Application.json +++ b/artifacts/types/AWS::CodeDeploy::Application.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-CodeDeploy-Application", "type": "AWS::CodeDeploy::Application", - "time": "2024-01-03T18:25:13.598Z", + "time": "2024-06-18T15:22:17.596Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::CodeGuruProfiler::ProfilingGroup.json b/artifacts/types/AWS::CodeGuruProfiler::ProfilingGroup.json index 3b909cf9..07177f89 100644 --- a/artifacts/types/AWS::CodeGuruProfiler::ProfilingGroup.json +++ b/artifacts/types/AWS::CodeGuruProfiler::ProfilingGroup.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-CodeGuruProfiler-ProfilingGroup", "type": "AWS::CodeGuruProfiler::ProfilingGroup", - "time": "2023-06-23T23:26:02.806Z", + "time": "2024-02-12T09:54:48.031Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::CodePipeline::CustomActionType.json b/artifacts/types/AWS::CodePipeline::CustomActionType.json index 6c0a5d98..4f574061 100644 --- a/artifacts/types/AWS::CodePipeline::CustomActionType.json +++ b/artifacts/types/AWS::CodePipeline::CustomActionType.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-CodePipeline-CustomActionType", "type": "AWS::CodePipeline::CustomActionType", - "time": "2023-12-04T16:26:48.545Z", + "time": "2024-02-01T18:27:35.274Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::CodeStarConnections::Connection.json b/artifacts/types/AWS::CodeStarConnections::Connection.json index 86ba9499..5fcaecde 100644 --- a/artifacts/types/AWS::CodeStarConnections::Connection.json +++ b/artifacts/types/AWS::CodeStarConnections::Connection.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-CodeStarConnections-Connection", "type": "AWS::CodeStarConnections::Connection", - "time": "2024-01-04T16:10:42.598Z", + "time": "2024-05-21T15:14:18.014Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -108,6 +108,7 @@ }, "Tags": { "description": "Specifies the tags applied to a connection.", + "insertionOrder": false, "items": { "$ref": "#/definitions/Tag" }, @@ -123,6 +124,13 @@ "ConnectionName" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-codestarconnections.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, "typeName": "AWS::CodeStarConnections::Connection" } } \ No newline at end of file diff --git a/artifacts/types/AWS::CodeStarConnections::RepositoryLink.json b/artifacts/types/AWS::CodeStarConnections::RepositoryLink.json index cef27056..17eaf1eb 100644 --- a/artifacts/types/AWS::CodeStarConnections::RepositoryLink.json +++ b/artifacts/types/AWS::CodeStarConnections::RepositoryLink.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-CodeStarConnections-RepositoryLink", "type": "AWS::CodeStarConnections::RepositoryLink", - "time": "2023-12-18T16:40:29.113Z", + "time": "2024-06-10T15:32:41.136Z", "schema": { "additionalIdentifiers": [ [ @@ -103,7 +103,13 @@ }, "ProviderType": { "description": "The name of the external provider where your third-party code repository is configured.", - "pattern": "^(GitHub|Bitbucket|GitHubEnterprise|GitLab)$", + "enum": [ + "GitHub", + "Bitbucket", + "GitHubEnterprise", + "GitLab", + "GitLabSelfManaged" + ], "type": "string" }, "RepositoryLinkArn": { diff --git a/artifacts/types/AWS::CodeStarConnections::SyncConfiguration.json b/artifacts/types/AWS::CodeStarConnections::SyncConfiguration.json index 4661aa4e..aeb348ae 100644 --- a/artifacts/types/AWS::CodeStarConnections::SyncConfiguration.json +++ b/artifacts/types/AWS::CodeStarConnections::SyncConfiguration.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-CodeStarConnections-SyncConfiguration", "type": "AWS::CodeStarConnections::SyncConfiguration", - "time": "2023-12-18T16:40:25.846Z", + "time": "2024-06-10T15:36:01.51Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -63,7 +63,21 @@ }, "ProviderType": { "description": "The name of the external provider where your third-party code repository is configured.", - "pattern": "^(GitHub|Bitbucket|GitHubEnterprise|GitLab)$", + "enum": [ + "GitHub", + "Bitbucket", + "GitHubEnterprise", + "GitLab", + "GitLabSelfManaged" + ], + "type": "string" + }, + "PublishDeploymentStatus": { + "description": "Whether to enable or disable publishing of deployment status to source providers.", + "enum": [ + "ENABLED", + "DISABLED" + ], "type": "string" }, "RepositoryLinkId": { @@ -88,6 +102,14 @@ "SyncType": { "description": "The type of resource synchronization service that is to be configured, for example, CFN_STACK_SYNC.", "type": "string" + }, + "TriggerResourceUpdateOn": { + "description": "When to trigger Git sync to begin the stack update.", + "enum": [ + "ANY_CHANGE", + "FILE_CHANGE" + ], + "type": "string" } }, "readOnlyProperties": [ diff --git a/artifacts/types/AWS::CodeStarNotifications::NotificationRule.json b/artifacts/types/AWS::CodeStarNotifications::NotificationRule.json index 849b96a0..9fb02ab9 100644 --- a/artifacts/types/AWS::CodeStarNotifications::NotificationRule.json +++ b/artifacts/types/AWS::CodeStarNotifications::NotificationRule.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-CodeStarNotifications-NotificationRule", "type": "AWS::CodeStarNotifications::NotificationRule", - "time": "2024-01-03T16:27:54.135Z", + "time": "2024-06-04T15:25:43.933Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Cognito::IdentityPool.json b/artifacts/types/AWS::Cognito::IdentityPool.json new file mode 100644 index 00000000..c20eae67 --- /dev/null +++ b/artifacts/types/AWS::Cognito::IdentityPool.json @@ -0,0 +1,175 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Cognito-IdentityPool", + "type": "AWS::Cognito::IdentityPool", + "time": "2024-04-16T16:11:07.98Z", + "schema": { + "additionalProperties": false, + "definitions": { + "CognitoIdentityProvider": { + "additionalProperties": false, + "properties": { + "ClientId": { + "type": "string" + }, + "ProviderName": { + "type": "string" + }, + "ServerSideTokenCheck": { + "type": "boolean" + } + }, + "required": [ + "ProviderName", + "ClientId" + ], + "type": "object" + }, + "CognitoStreams": { + "additionalProperties": false, + "properties": { + "RoleArn": { + "type": "string" + }, + "StreamName": { + "type": "string" + }, + "StreamingStatus": { + "type": "string" + } + }, + "type": "object" + }, + "PushSync": { + "additionalProperties": false, + "properties": { + "ApplicationArns": { + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "RoleArn": { + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Cognito::IdentityPool", + "handlers": { + "create": { + "permissions": [ + "cognito-identity:CreateIdentityPool", + "cognito-sync:SetIdentityPoolConfiguration", + "cognito-sync:SetCognitoEvents", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "cognito-identity:DeleteIdentityPool" + ] + }, + "list": { + "permissions": [ + "cognito-identity:ListIdentityPools" + ] + }, + "read": { + "permissions": [ + "cognito-identity:DescribeIdentityPool" + ] + }, + "update": { + "permissions": [ + "cognito-identity:UpdateIdentityPool", + "cognito-identity:DescribeIdentityPool", + "cognito-sync:SetIdentityPoolConfiguration", + "cognito-sync:SetCognitoEvents", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "AllowClassicFlow": { + "type": "boolean" + }, + "AllowUnauthenticatedIdentities": { + "type": "boolean" + }, + "CognitoEvents": { + "type": "object" + }, + "CognitoIdentityProviders": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/CognitoIdentityProvider" + }, + "type": "array", + "uniqueItems": false + }, + "CognitoStreams": { + "$ref": "#/definitions/CognitoStreams" + }, + "DeveloperProviderName": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "IdentityPoolName": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "OpenIdConnectProviderARNs": { + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "PushSync": { + "$ref": "#/definitions/PushSync" + }, + "SamlProviderARNs": { + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "SupportedLoginProviders": { + "type": "object" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/Name" + ], + "required": [ + "AllowUnauthenticatedIdentities" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::Cognito::IdentityPool", + "writeOnlyProperties": [ + "/properties/PushSync", + "/properties/CognitoStreams", + "/properties/CognitoEvents" + ] + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::Cognito::IdentityPoolPrincipalTag.json b/artifacts/types/AWS::Cognito::IdentityPoolPrincipalTag.json index f7e3480e..6679ab1c 100644 --- a/artifacts/types/AWS::Cognito::IdentityPoolPrincipalTag.json +++ b/artifacts/types/AWS::Cognito::IdentityPoolPrincipalTag.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Cognito-IdentityPoolPrincipalTag", "type": "AWS::Cognito::IdentityPoolPrincipalTag", - "time": "2024-01-03T16:59:59.307Z", + "time": "2024-04-16T16:26:52.048Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Cognito::IdentityPoolRoleAttachment.json b/artifacts/types/AWS::Cognito::IdentityPoolRoleAttachment.json new file mode 100644 index 00000000..156d3ad3 --- /dev/null +++ b/artifacts/types/AWS::Cognito::IdentityPoolRoleAttachment.json @@ -0,0 +1,164 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Cognito-IdentityPoolRoleAttachment", + "type": "AWS::Cognito::IdentityPoolRoleAttachment", + "time": "2024-04-16T16:27:44.102Z", + "schema": { + "additionalIdentifiers": [ + [ + "/properties/IdentityPoolId" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/IdentityPoolId" + ], + "definitions": { + "MappingRule": { + "additionalProperties": false, + "properties": { + "Claim": { + "type": "string" + }, + "MatchType": { + "type": "string" + }, + "RoleARN": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Claim", + "MatchType", + "RoleARN", + "Value" + ], + "type": "object" + }, + "RoleMapping": { + "additionalProperties": false, + "properties": { + "AmbiguousRoleResolution": { + "type": "string" + }, + "IdentityProvider": { + "type": "string" + }, + "RulesConfiguration": { + "$ref": "#/definitions/RulesConfigurationType" + }, + "Type": { + "type": "string" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "RulesConfigurationType": { + "additionalProperties": false, + "properties": { + "Rules": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/MappingRule" + }, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "Rules" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Cognito::IdentityPoolRoleAttachment", + "handlers": { + "create": { + "permissions": [ + "cognito-identity:GetIdentityPoolRoles", + "cognito-identity:SetIdentityPoolRoles", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "cognito-identity:GetIdentityPoolRoles", + "cognito-identity:SetIdentityPoolRoles" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "IdentityPoolId": { + "$ref": "resource-schema.json#/properties/IdentityPoolId" + } + }, + "required": [ + "IdentityPoolId" + ] + }, + "permissions": [ + "cognito-identity:GetIdentityPoolRoles" + ] + }, + "read": { + "permissions": [ + "cognito-identity:GetIdentityPoolRoles" + ] + }, + "update": { + "permissions": [ + "cognito-identity:GetIdentityPoolRoles", + "cognito-identity:SetIdentityPoolRoles", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Id": { + "type": "string" + }, + "IdentityPoolId": { + "type": "string" + }, + "RoleMappings": { + "additionalProperties": false, + "patternProperties": { + "^.+$": { + "$ref": "#/definitions/RoleMapping" + } + } + }, + "Roles": { + "additionalProperties": false, + "patternProperties": { + "^.+$": { + "type": "string" + } + } + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "IdentityPoolId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::Cognito::IdentityPoolRoleAttachment" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::Cognito::LogDeliveryConfiguration.json b/artifacts/types/AWS::Cognito::LogDeliveryConfiguration.json index de71e687..8bc35326 100644 --- a/artifacts/types/AWS::Cognito::LogDeliveryConfiguration.json +++ b/artifacts/types/AWS::Cognito::LogDeliveryConfiguration.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Cognito-LogDeliveryConfiguration", "type": "AWS::Cognito::LogDeliveryConfiguration", - "time": "2024-01-02T16:37:06.016Z", + "time": "2024-04-09T16:34:36.17Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Cognito::UserPool.json b/artifacts/types/AWS::Cognito::UserPool.json index 381a90fa..54045259 100644 --- a/artifacts/types/AWS::Cognito::UserPool.json +++ b/artifacts/types/AWS::Cognito::UserPool.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Cognito-UserPool", "type": "AWS::Cognito::UserPool", - "time": "2024-01-02T16:45:21.079Z", + "time": "2024-04-09T16:40:54.929Z", "schema": { "additionalProperties": false, "definitions": { diff --git a/artifacts/types/AWS::Cognito::UserPoolClient.json b/artifacts/types/AWS::Cognito::UserPoolClient.json index e2a724fa..2e3adb30 100644 --- a/artifacts/types/AWS::Cognito::UserPoolClient.json +++ b/artifacts/types/AWS::Cognito::UserPoolClient.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Cognito-UserPoolClient", "type": "AWS::Cognito::UserPoolClient", - "time": "2024-01-02T16:44:29.869Z", + "time": "2024-04-09T16:45:50.95Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Cognito::UserPoolGroup.json b/artifacts/types/AWS::Cognito::UserPoolGroup.json index fee33674..1843bf83 100644 --- a/artifacts/types/AWS::Cognito::UserPoolGroup.json +++ b/artifacts/types/AWS::Cognito::UserPoolGroup.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Cognito-UserPoolGroup", "type": "AWS::Cognito::UserPoolGroup", - "time": "2024-01-02T16:47:36.692Z", + "time": "2024-04-09T16:41:53.739Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Cognito::UserPoolResourceServer.json b/artifacts/types/AWS::Cognito::UserPoolResourceServer.json new file mode 100644 index 00000000..c12cdd56 --- /dev/null +++ b/artifacts/types/AWS::Cognito::UserPoolResourceServer.json @@ -0,0 +1,107 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Cognito-UserPoolResourceServer", + "type": "AWS::Cognito::UserPoolResourceServer", + "time": "2024-06-13T15:48:57.285Z", + "schema": { + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/UserPoolId", + "/properties/Identifier" + ], + "definitions": { + "ResourceServerScopeType": { + "additionalProperties": false, + "properties": { + "ScopeDescription": { + "type": "string" + }, + "ScopeName": { + "type": "string" + } + }, + "required": [ + "ScopeDescription", + "ScopeName" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Cognito::UserPoolResourceServer", + "handlers": { + "create": { + "permissions": [ + "cognito-idp:CreateResourceServer", + "iam:PassRole" + ], + "timeoutInMinutes": 2 + }, + "delete": { + "permissions": [ + "cognito-idp:DeleteResourceServer" + ], + "timeoutInMinutes": 2 + }, + "list": { + "handlerSchema": { + "properties": { + "UserPoolId": { + "$ref": "resource-schema.json#/properties/UserPoolId" + } + }, + "required": [ + "UserPoolId" + ] + }, + "permissions": [ + "cognito-idp:ListResourceServers" + ] + }, + "read": { + "permissions": [ + "cognito-idp:DescribeResourceServer" + ] + }, + "update": { + "permissions": [ + "cognito-idp:UpdateResourceServer", + "iam:PassRole" + ], + "timeoutInMinutes": 2 + } + }, + "primaryIdentifier": [ + "/properties/UserPoolId", + "/properties/Identifier" + ], + "properties": { + "Identifier": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "Scopes": { + "items": { + "$ref": "#/definitions/ResourceServerScopeType" + }, + "type": "array" + }, + "UserPoolId": { + "type": "string" + } + }, + "required": [ + "UserPoolId", + "Identifier", + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::Cognito::UserPoolResourceServer" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::Cognito::UserPoolRiskConfigurationAttachment.json b/artifacts/types/AWS::Cognito::UserPoolRiskConfigurationAttachment.json new file mode 100644 index 00000000..f384b29a --- /dev/null +++ b/artifacts/types/AWS::Cognito::UserPoolRiskConfigurationAttachment.json @@ -0,0 +1,220 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Cognito-UserPoolRiskConfigurationAttachment", + "type": "AWS::Cognito::UserPoolRiskConfigurationAttachment", + "time": "2024-04-09T16:36:51.173Z", + "schema": { + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/UserPoolId", + "/properties/ClientId" + ], + "definitions": { + "AccountTakeoverActionType": { + "additionalProperties": false, + "properties": { + "EventAction": { + "type": "string" + }, + "Notify": { + "type": "boolean" + } + }, + "required": [ + "EventAction", + "Notify" + ], + "type": "object" + }, + "AccountTakeoverActionsType": { + "additionalProperties": false, + "properties": { + "HighAction": { + "$ref": "#/definitions/AccountTakeoverActionType" + }, + "LowAction": { + "$ref": "#/definitions/AccountTakeoverActionType" + }, + "MediumAction": { + "$ref": "#/definitions/AccountTakeoverActionType" + } + }, + "type": "object" + }, + "AccountTakeoverRiskConfigurationType": { + "additionalProperties": false, + "properties": { + "Actions": { + "$ref": "#/definitions/AccountTakeoverActionsType" + }, + "NotifyConfiguration": { + "$ref": "#/definitions/NotifyConfigurationType" + } + }, + "required": [ + "Actions" + ], + "type": "object" + }, + "CompromisedCredentialsActionsType": { + "additionalProperties": false, + "properties": { + "EventAction": { + "type": "string" + } + }, + "required": [ + "EventAction" + ], + "type": "object" + }, + "CompromisedCredentialsRiskConfigurationType": { + "additionalProperties": false, + "properties": { + "Actions": { + "$ref": "#/definitions/CompromisedCredentialsActionsType" + }, + "EventFilter": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "Actions" + ], + "type": "object" + }, + "NotifyConfigurationType": { + "additionalProperties": false, + "properties": { + "BlockEmail": { + "$ref": "#/definitions/NotifyEmailType" + }, + "From": { + "type": "string" + }, + "MfaEmail": { + "$ref": "#/definitions/NotifyEmailType" + }, + "NoActionEmail": { + "$ref": "#/definitions/NotifyEmailType" + }, + "ReplyTo": { + "type": "string" + }, + "SourceArn": { + "type": "string" + } + }, + "required": [ + "SourceArn" + ], + "type": "object" + }, + "NotifyEmailType": { + "additionalProperties": false, + "properties": { + "HtmlBody": { + "type": "string" + }, + "Subject": { + "type": "string" + }, + "TextBody": { + "type": "string" + } + }, + "required": [ + "Subject" + ], + "type": "object" + }, + "RiskExceptionConfigurationType": { + "additionalProperties": false, + "properties": { + "BlockedIPRangeList": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "SkippedIPRangeList": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Cognito::UserPoolRiskConfigurationAttachment", + "handlers": { + "create": { + "permissions": [ + "cognito-idp:SetRiskConfiguration", + "cognito-idp:DescribeRiskConfiguration", + "iam:PassRole" + ], + "timeoutInMinutes": 2 + }, + "delete": { + "permissions": [ + "cognito-idp:SetRiskConfiguration", + "cognito-idp:DescribeRiskConfiguration" + ], + "timeoutInMinutes": 2 + }, + "read": { + "permissions": [ + "cognito-idp:DescribeRiskConfiguration" + ] + }, + "update": { + "permissions": [ + "cognito-idp:SetRiskConfiguration", + "cognito-idp:DescribeRiskConfiguration", + "iam:PassRole" + ], + "timeoutInMinutes": 2 + } + }, + "primaryIdentifier": [ + "/properties/UserPoolId", + "/properties/ClientId" + ], + "properties": { + "AccountTakeoverRiskConfiguration": { + "$ref": "#/definitions/AccountTakeoverRiskConfigurationType" + }, + "ClientId": { + "type": "string" + }, + "CompromisedCredentialsRiskConfiguration": { + "$ref": "#/definitions/CompromisedCredentialsRiskConfigurationType" + }, + "RiskExceptionConfiguration": { + "$ref": "#/definitions/RiskExceptionConfigurationType" + }, + "UserPoolId": { + "type": "string" + } + }, + "required": [ + "UserPoolId", + "ClientId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::Cognito::UserPoolRiskConfigurationAttachment" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::Comprehend::DocumentClassifier.json b/artifacts/types/AWS::Comprehend::DocumentClassifier.json index b7e4dd81..8b0626f2 100644 --- a/artifacts/types/AWS::Comprehend::DocumentClassifier.json +++ b/artifacts/types/AWS::Comprehend::DocumentClassifier.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Comprehend-DocumentClassifier", "type": "AWS::Comprehend::DocumentClassifier", - "time": "2023-11-09T02:18:19.731Z", + "time": "2024-06-19T17:37:11.193Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Comprehend::Flywheel.json b/artifacts/types/AWS::Comprehend::Flywheel.json index 97ef4d71..2d420c44 100644 --- a/artifacts/types/AWS::Comprehend::Flywheel.json +++ b/artifacts/types/AWS::Comprehend::Flywheel.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Comprehend-Flywheel", "type": "AWS::Comprehend::Flywheel", - "time": "2023-11-08T22:11:28.872Z", + "time": "2024-06-19T18:22:05.088Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Config::AggregationAuthorization.json b/artifacts/types/AWS::Config::AggregationAuthorization.json index 2115e77d..a4fa34e4 100644 --- a/artifacts/types/AWS::Config::AggregationAuthorization.json +++ b/artifacts/types/AWS::Config::AggregationAuthorization.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Config-AggregationAuthorization", "type": "AWS::Config::AggregationAuthorization", - "time": "2023-12-05T16:23:05.991Z", + "time": "2024-05-13T16:14:22.55Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -107,6 +107,13 @@ "AuthorizedAwsRegion" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-config.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, "typeName": "AWS::Config::AggregationAuthorization" } } \ No newline at end of file diff --git a/artifacts/types/AWS::Config::ConfigRule.json b/artifacts/types/AWS::Config::ConfigRule.json index c9625300..7ce80786 100644 --- a/artifacts/types/AWS::Config::ConfigRule.json +++ b/artifacts/types/AWS::Config::ConfigRule.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Config-ConfigRule", "type": "AWS::Config::ConfigRule", - "time": "2023-12-06T16:01:02.845Z", + "time": "2024-06-05T15:53:08.507Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -10,18 +10,18 @@ "definitions": { "CustomPolicyDetails": { "additionalProperties": false, - "description": "Custom policy details when rule is custom owned", + "description": "Provides the CustomPolicyDetails, the rule owner (```` for managed rules, ``CUSTOM_POLICY`` for Custom Policy rules, and ``CUSTOM_LAMBDA`` for Custom Lambda rules), the rule identifier, and the events that cause the evaluation of your AWS resources.", "properties": { "EnableDebugLogDelivery": { - "description": "Logging toggle for custom policy rule", + "description": "The boolean expression for enabling debug logging for your CC Custom Policy rule. The default value is ``false``.", "type": "boolean" }, "PolicyRuntime": { - "description": "Runtime system for custom policy rule", + "description": "The runtime system for your CC Custom Policy rule. Guard is a policy-as-code language that allows you to write policies that are enforced by CC Custom Policy rules. For more information about Guard, see the [Guard GitHub Repository](https://docs.aws.amazon.com/https://github.com/aws-cloudformation/cloudformation-guard).", "type": "string" }, "PolicyText": { - "description": "Policy definition containing logic for custom policy rule", + "description": "The policy definition containing the logic for your CC Custom Policy rule.", "type": "string" } }, @@ -29,10 +29,10 @@ }, "EvaluationModeConfiguration": { "additionalProperties": false, - "description": "Evaluation mode for the AWS Config rule", + "description": "The configuration object for CC rule evaluation mode. The supported valid values are Detective or Proactive.", "properties": { "Mode": { - "description": "Mode of evaluation of AWS Config rule", + "description": "The mode of an evaluation. The valid values are Detective or Proactive.", "type": "string" } }, @@ -40,14 +40,14 @@ }, "Scope": { "additionalProperties": false, - "description": "Scope to constrain which resources can trigger the rule", + "description": "Defines which resources trigger an evaluation for an CC rule. The scope can include one or more resource types, a combination of a tag key and value, or a combination of one resource type and one resource ID. Specify a scope to constrain which resources trigger an evaluation for a rule. Otherwise, evaluations for the rule are triggered when any resource in your recording group changes in configuration.", "properties": { "ComplianceResourceId": { - "description": "ID of the only one resource which we want to trigger the rule", + "description": "The ID of the only AWS resource that you want to trigger an evaluation for the rule. If you specify a resource ID, you must specify one resource type for ``ComplianceResourceTypes``.", "type": "string" }, "ComplianceResourceTypes": { - "description": "Resource types of resources which we want to trigger the rule", + "description": "The resource types of only those AWS resources that you want to trigger an evaluation for the rule. You can only specify one type if you also specify a resource ID for ``ComplianceResourceId``.", "items": { "type": "string" }, @@ -55,11 +55,11 @@ "uniqueItems": true }, "TagKey": { - "description": "Tag key applied only to resources which we want to trigger the rule", + "description": "The tag key that is applied to only those AWS resources that you want to trigger an evaluation for the rule.", "type": "string" }, "TagValue": { - "description": "Tag value applied only to resources which we want to trigger the rule", + "description": "The tag value applied to only those AWS resources that you want to trigger an evaluation for the rule. If you specify a value for ``TagValue``, you must also specify a value for ``TagKey``.", "type": "string" } }, @@ -67,18 +67,18 @@ }, "Source": { "additionalProperties": false, - "description": "Source of events for the config rule", + "description": "Provides the CustomPolicyDetails, the rule owner (```` for managed rules, ``CUSTOM_POLICY`` for Custom Policy rules, and ``CUSTOM_LAMBDA`` for Custom Lambda rules), the rule identifier, and the events that cause the evaluation of your AWS resources.", "properties": { "CustomPolicyDetails": { "$ref": "#/definitions/CustomPolicyDetails", - "description": "Custom policy details when rule is custom owned" + "description": "Provides the runtime system, policy definition, and whether debug logging is enabled. Required when owner is set to ``CUSTOM_POLICY``." }, "Owner": { - "description": "Owner of the config rule", + "description": "Indicates whether AWS or the customer owns and manages the CC rule.\n CC Managed Rules are predefined rules owned by AWS. For more information, see [Managed Rules](https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html) in the *developer guide*.\n CC Custom Rules are rules that you can develop either with Guard (``CUSTOM_POLICY``) or LAMlong (``CUSTOM_LAMBDA``). For more information, see [Custom Rules](https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_develop-rules.html) in the *developer guide*.", "type": "string" }, "SourceDetails": { - "description": "List of message types that can trigger the rule", + "description": "Provides the source and the message types that cause CC to evaluate your AWS resources against a rule. It also provides the frequency with which you want CC to run evaluations for the rule if the trigger type is periodic.\n If the owner is set to ``CUSTOM_POLICY``, the only acceptable values for the CC rule trigger message type are ``ConfigurationItemChangeNotification`` and ``OversizedConfigurationItemChangeNotification``.", "items": { "$ref": "#/definitions/SourceDetail", "description": "Source and message type that can trigger the rule" @@ -87,7 +87,7 @@ "uniqueItems": true }, "SourceIdentifier": { - "description": "Identifier for the source of events", + "description": "For CC Managed rules, a predefined identifier from a list. For example, ``IAM_PASSWORD_POLICY`` is a managed rule. To reference a managed rule, see [List of Managed Rules](https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html).\n For CC Custom Lambda rules, the identifier is the Amazon Resource Name (ARN) of the rule's LAMlong function, such as ``arn:aws:lambda:us-east-2:123456789012:function:custom_rule_name``.\n For CC Custom Policy rules, this field will be ignored.", "type": "string" } }, @@ -98,18 +98,18 @@ }, "SourceDetail": { "additionalProperties": false, - "description": "Source and message type that can trigger the rule", + "description": "Provides the source and the message types that trigger CC to evaluate your AWS resources against a rule. It also provides the frequency with which you want CC to run evaluations for the rule if the trigger type is periodic. You can specify the parameter values for ``SourceDetail`` only for custom rules.", "properties": { "EventSource": { - "description": "Source of event that can trigger the rule", + "description": "The source of the event, such as an AWS service, that triggers CC to evaluate your AWS resources.", "type": "string" }, "MaximumExecutionFrequency": { - "description": "Frequency at which the rule has to be evaluated", + "description": "The frequency at which you want CC to run evaluations for a custom rule with a periodic trigger. If you specify a value for ``MaximumExecutionFrequency``, then ``MessageType`` must use the ``ScheduledNotification`` value.\n By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the ``MaximumExecutionFrequency`` parameter.\n Based on the valid value you choose, CC runs evaluations once for each valid value. For example, if you choose ``Three_Hours``, CC runs evaluations once every three hours. In this case, ``Three_Hours`` is the frequency of this rule.", "type": "string" }, "MessageType": { - "description": "Notification type that can trigger the rule", + "description": "The type of notification that triggers CC to run an evaluation for a rule. You can specify the following notification types:\n + ``ConfigurationItemChangeNotification`` - Triggers an evaluation when CC delivers a configuration item as a result of a resource change.\n + ``OversizedConfigurationItemChangeNotification`` - Triggers an evaluation when CC delivers an oversized configuration item. CC 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 + ``ConfigurationSnapshotDeliveryCompleted`` - Triggers a periodic evaluation when CC delivers a configuration snapshot.\n \n If you want your custom rule to be triggered by configuration changes, specify two SourceDetail objects, one for ``ConfigurationItemChangeNotification`` and one for ``OversizedConfigurationItemChangeNotification``.", "type": "string" } }, @@ -120,7 +120,7 @@ "type": "object" } }, - "description": "Schema for AWS Config ConfigRule", + "description": "You must first create and start the CC configuration recorder in order to create CC managed rules with CFNlong. For more information, see [Managing the Configuration Recorder](https://docs.aws.amazon.com/config/latest/developerguide/stop-start-recorder.html).\n Adds or updates an CC rule to evaluate if your AWS resources comply with your desired configurations. For information on how many CC rules you can have per account, see [Service Limits](https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html) in the *Developer Guide*.\n There are two types of rules: *Managed Rules* and *Custom Rules*. You can use the ``ConfigRule`` resource to create both CC Managed Rules and CC Custom Rules.\n CC Managed Rules are predefined, customizable rules created by CC. For a list of managed rules, see [List of Managed Rules](https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html). If you are adding an CC managed rule, you must specify the rule's identifier for the ``SourceIdentifier`` key.\n CC Custom Rules are rules that you create from scratch. There are two ways to create CC custom rules: with Lambda functions ([Developer Guide](https://docs.aws.amazon.com/config/latest/developerguide/gettingstarted-concepts.html#gettingstarted-concepts-function)) and with CFNGUARDshort ([Guard GitHub Repository](https://docs.aws.amazon.com/https://github.com/aws-cloudformation/cloudformation-guard)), a policy-as-code language. CC custom rules created with LAMlong are called *Custom Lambda Rules* and CC custom rules created with CFNGUARDshort are called *Custom Policy Rules*.\n If you are adding a new CC Custom LAM rule, you first need to create an LAMlong function that the rule invokes to evaluate your resources. When you use the ``ConfigRule`` resource to add a Custom LAM rule to CC, you must specify the Amazon Resource Name (ARN) that LAMlong assigns to the function. You specify the ARN in the ``SourceIdentifier`` key. This key is part of the ``Source`` object, which is part of the ``ConfigRule`` object. \n For any new CC rule that you add, specify the ``ConfigRuleName`` in the ``ConfigRule`` object. Do not specify the ``ConfigRuleArn`` or the ``ConfigRuleId``. These values are generated by CC for new rules.\n If you are updating a rule that you added previously, you can specify the rule by ``ConfigRuleName``, ``ConfigRuleId``, or ``ConfigRuleArn`` in the ``ConfigRule`` data type that you use in this request.\n For more information about developing and using CC rules, see [Evaluating Resources with Rules](https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config.html) in the *Developer Guide*.", "handlers": { "create": { "permissions": [ @@ -157,12 +157,12 @@ ], "properties": { "Arn": { - "description": "ARN generated for the AWS Config rule ", + "description": "", "type": "string" }, "Compliance": { "additionalProperties": false, - "description": "Compliance details of the Config rule", + "description": "Indicates whether an AWS resource or CC rule is compliant and provides the number of contributors that affect the compliance.", "properties": { "Type": { "description": "Compliance type determined by the Config rule", @@ -172,19 +172,19 @@ "type": "object" }, "ConfigRuleId": { - "description": "ID of the config rule", + "description": "", "type": "string" }, "ConfigRuleName": { - "description": "Name for the AWS Config rule", + "description": "A name for the CC rule. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the rule name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).", "type": "string" }, "Description": { - "description": "Description provided for the AWS Config rule", + "description": "The description that you provide for the CC rule.", "type": "string" }, "EvaluationModes": { - "description": "List of EvaluationModeConfiguration objects", + "description": "The modes the CC rule can be evaluated in. The valid values are distinct objects. By default, the value is Detective evaluation mode only.", "items": { "$ref": "#/definitions/EvaluationModeConfiguration", "description": "Mode of evaluation of AWS Config rule" @@ -193,25 +193,28 @@ "uniqueItems": false }, "InputParameters": { - "description": "JSON string passed the Lambda function", + "description": "A string, in JSON format, that is passed to the CC rule Lambda function.", "type": [ "string", "object" ] }, "MaximumExecutionFrequency": { - "description": "Maximum frequency at which the rule has to be evaluated", + "description": "The maximum frequency with which CC runs evaluations for a rule. You can specify a value for ``MaximumExecutionFrequency`` when:\n + You are using an AWS managed rule that is triggered at a periodic frequency.\n + Your custom rule is triggered when CC delivers the configuration snapshot. For more information, see [ConfigSnapshotDeliveryProperties](https://docs.aws.amazon.com/config/latest/APIReference/API_ConfigSnapshotDeliveryProperties.html).\n \n By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the ``MaximumExecutionFrequency`` parameter.", "type": "string" }, "Scope": { "$ref": "#/definitions/Scope", - "description": "Scope to constrain which resources can trigger the AWS Config rule" + "description": "Defines which resources can trigger an evaluation for the rule. The scope can include one or more resource types, a combination of one resource type and one resource ID, or a combination of a tag key and value. Specify a scope to constrain the resources that can trigger an evaluation for the rule. If you do not specify a scope, evaluations are triggered when any resource in the recording group changes.\n The scope can be empty." }, "Source": { "$ref": "#/definitions/Source", - "description": "Source of events for the AWS Config rule" + "description": "Provides the rule owner (```` for managed rules, ``CUSTOM_POLICY`` for Custom Policy rules, and ``CUSTOM_LAMBDA`` for Custom Lambda rules), the rule identifier, and the notifications that cause the function to evaluate your AWS resources." } }, + "propertyTransform": { + "/properties/Source": "Source.Owner=\"CUSTOM_LAMBDA\" ? ($count(Source.SourceDetails[MessageType=\"ConfigurationItemChangeNotification\"]) \u003e 0 and $count(Source.SourceDetails[MessageType=\"OversizedConfigurationItemChangeNotification\"]) = 0) ? $ ~\u003e | $.Source | {\"SourceDetails\" : [SourceDetails, {\"EventSource\": \"aws.config\", \"MessageType\": \"OversizedConfigurationItemChangeNotification\"}]} | : ($count(Source.SourceDetails[MessageType=\"ConfigurationItemChangeNotification\"]) = 0 and $count(Source.SourceDetails[MessageType=\"OversizedConfigurationItemChangeNotification\"]) \u003e 0) ? $ ~\u003e | $.Source | {\"SourceDetails\" : [SourceDetails, {\"EventSource\": \"aws.config\", \"MessageType\": \"ConfigurationItemChangeNotification\" }]} | : $ : $" + }, "readOnlyProperties": [ "/properties/ConfigRuleId", "/properties/Compliance/Type", diff --git a/artifacts/types/AWS::Config::ConfigurationAggregator.json b/artifacts/types/AWS::Config::ConfigurationAggregator.json index 19e049a4..40a3c5b6 100644 --- a/artifacts/types/AWS::Config::ConfigurationAggregator.json +++ b/artifacts/types/AWS::Config::ConfigurationAggregator.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Config-ConfigurationAggregator", "type": "AWS::Config::ConfigurationAggregator", - "time": "2023-12-04T16:59:15.132Z", + "time": "2024-05-13T16:25:07.081Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -161,6 +161,13 @@ "/properties/ConfigurationAggregatorArn" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-config.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, "typeName": "AWS::Config::ConfigurationAggregator" } } \ No newline at end of file diff --git a/artifacts/types/AWS::Config::ConformancePack.json b/artifacts/types/AWS::Config::ConformancePack.json index f85300c6..e42eb80f 100644 --- a/artifacts/types/AWS::Config::ConformancePack.json +++ b/artifacts/types/AWS::Config::ConformancePack.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Config-ConformancePack", "type": "AWS::Config::ConformancePack", - "time": "2023-12-19T16:48:08.114Z", + "time": "2024-05-01T16:28:28.054Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -146,6 +146,13 @@ "ConformancePackName" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-config.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagProperty": "/properties/Tags", + "tagUpdatable": false, + "taggable": false + }, "typeName": "AWS::Config::ConformancePack", "writeOnlyProperties": [ "/properties/TemplateBody", diff --git a/artifacts/types/AWS::Config::OrganizationConformancePack.json b/artifacts/types/AWS::Config::OrganizationConformancePack.json index 9e812f60..14fac867 100644 --- a/artifacts/types/AWS::Config::OrganizationConformancePack.json +++ b/artifacts/types/AWS::Config::OrganizationConformancePack.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Config-OrganizationConformancePack", "type": "AWS::Config::OrganizationConformancePack", - "time": "2023-10-31T17:02:55.206Z", + "time": "2024-04-01T16:51:45.98Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -149,6 +149,13 @@ "OrganizationConformancePackName" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-config.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagProperty": "/properties/Tags", + "tagUpdatable": false, + "taggable": false + }, "typeName": "AWS::Config::OrganizationConformancePack", "writeOnlyProperties": [ "/properties/TemplateBody", diff --git a/artifacts/types/AWS::Config::StoredQuery.json b/artifacts/types/AWS::Config::StoredQuery.json index e8e49242..2524b6c2 100644 --- a/artifacts/types/AWS::Config::StoredQuery.json +++ b/artifacts/types/AWS::Config::StoredQuery.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Config-StoredQuery", "type": "AWS::Config::StoredQuery", - "time": "2024-01-03T17:40:32.228Z", + "time": "2024-05-14T17:07:37.482Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -120,6 +120,13 @@ "QueryExpression" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-config.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, "typeName": "AWS::Config::StoredQuery" } } \ No newline at end of file diff --git a/artifacts/types/AWS::Connect::ApprovedOrigin.json b/artifacts/types/AWS::Connect::ApprovedOrigin.json index b8a0ee80..136c04b4 100644 --- a/artifacts/types/AWS::Connect::ApprovedOrigin.json +++ b/artifacts/types/AWS::Connect::ApprovedOrigin.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Connect-ApprovedOrigin", "type": "AWS::Connect::ApprovedOrigin", - "time": "2023-12-11T19:18:23.987Z", + "time": "2024-04-16T21:19:51.469Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Connect::ContactFlow.json b/artifacts/types/AWS::Connect::ContactFlow.json index 0e3104d6..3f59a3a0 100644 --- a/artifacts/types/AWS::Connect::ContactFlow.json +++ b/artifacts/types/AWS::Connect::ContactFlow.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Connect-ContactFlow", "type": "AWS::Connect::ContactFlow", - "time": "2023-12-13T22:29:22.362Z", + "time": "2024-06-11T21:28:00.895Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Connect::ContactFlowModule.json b/artifacts/types/AWS::Connect::ContactFlowModule.json index e39f681b..a9b14d2e 100644 --- a/artifacts/types/AWS::Connect::ContactFlowModule.json +++ b/artifacts/types/AWS::Connect::ContactFlowModule.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Connect-ContactFlowModule", "type": "AWS::Connect::ContactFlowModule", - "time": "2023-12-13T22:29:15.167Z", + "time": "2024-06-11T21:24:02.276Z", "schema": { "additionalProperties": false, "definitions": { diff --git a/artifacts/types/AWS::Connect::EvaluationForm.json b/artifacts/types/AWS::Connect::EvaluationForm.json index dd806850..e556f912 100644 --- a/artifacts/types/AWS::Connect::EvaluationForm.json +++ b/artifacts/types/AWS::Connect::EvaluationForm.json @@ -1,17 +1,17 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Connect-EvaluationForm", "type": "AWS::Connect::EvaluationForm", - "time": "2024-01-04T22:23:49.66Z", + "time": "2024-06-18T21:24:57.788Z", "schema": { "additionalProperties": false, "definitions": { "EvaluationFormBaseItem": { "additionalProperties": false, - "description": "The evaluation form base item.", + "description": "An item at the root level. All items must be sections.", "properties": { "Section": { "$ref": "#/definitions/EvaluationFormSection", - "description": "The evaluation form section item" + "description": "A subsection or inner section of an item." } }, "required": [ @@ -21,26 +21,26 @@ }, "EvaluationFormItem": { "additionalProperties": false, - "description": "The evaluation form item.", + "description": "Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.", "properties": { "Question": { "$ref": "#/definitions/EvaluationFormQuestion", - "description": "The evaluation form question item" + "description": "The information of the question." }, "Section": { "$ref": "#/definitions/EvaluationFormSection", - "description": "The evaluation form section item" + "description": "The information of the section." } }, "type": "object" }, "EvaluationFormNumericQuestionAutomation": { "additionalProperties": false, - "description": "The automation properties for the numeric question.", + "description": "Information about the automation configuration in numeric questions.", "properties": { "PropertyValue": { "$ref": "#/definitions/NumericQuestionPropertyValueAutomation", - "description": "The automation property name of the question." + "description": "The property value of the automation." } }, "required": [ @@ -50,23 +50,23 @@ }, "EvaluationFormNumericQuestionOption": { "additionalProperties": false, - "description": "The option ranges used for scoring in numeric questions.", + "description": "Information about the option range used for scoring in numeric questions.", "properties": { "AutomaticFail": { - "description": "The flag to mark the option as automatic fail.", + "description": "The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.", "type": "boolean" }, "MaxValue": { - "description": "The maximum value of the option range.", + "description": "The maximum answer value of the range option.", "type": "integer" }, "MinValue": { - "description": "The minimum value of the option range.", + "description": "The minimum answer value of the range option.", "type": "integer" }, "Score": { "$ref": "#/definitions/Score", - "description": "The score of the option range." + "description": "The score assigned to answer values within the range option.\n *Minimum*: 0\n *Maximum*: 10" } }, "required": [ @@ -77,22 +77,22 @@ }, "EvaluationFormNumericQuestionProperties": { "additionalProperties": false, - "description": "The properties of the numeric question.", + "description": "Information about properties for a numeric question in an evaluation form.", "properties": { "Automation": { "$ref": "#/definitions/EvaluationFormNumericQuestionAutomation", - "description": "The automation properties for the numeric question." + "description": "The automation properties of the numeric question." }, "MaxValue": { - "description": "The maximum value for answers of the question.", + "description": "The maximum answer value.", "type": "integer" }, "MinValue": { - "description": "The minimum value for answers of the question.", + "description": "The minimum answer value.", "type": "integer" }, "Options": { - "description": "The list of option ranges used for scoring.", + "description": "The scoring options of the numeric question.", "insertionOrder": true, "items": { "$ref": "#/definitions/EvaluationFormNumericQuestionOption" @@ -110,10 +110,10 @@ }, "EvaluationFormQuestion": { "additionalProperties": false, - "description": "The evaluation form question.", + "description": "Information about a question from an evaluation form.", "properties": { "Instructions": { - "description": "The instructions for the question.", + "description": "The instructions of the section.\n *Length Constraints*: Minimum length of 0. Maximum length of 1024.", "maxLength": 1024, "type": "string" }, @@ -122,7 +122,7 @@ "type": "boolean" }, "QuestionType": { - "description": "The type of the question.", + "description": "The type of the question.\n *Allowed values*: ``NUMERIC`` | ``SINGLESELECT`` | ``TEXT``", "enum": [ "NUMERIC", "SINGLESELECT", @@ -132,21 +132,21 @@ }, "QuestionTypeProperties": { "$ref": "#/definitions/EvaluationFormQuestionTypeProperties", - "description": "The properties of the question" + "description": "The properties of the type of question. Text questions do not have to define question type properties." }, "RefId": { "$ref": "#/definitions/RefId", - "description": "The identifier used to reference the question." + "description": "The identifier of the question. An identifier must be unique within the evaluation form.\n *Length Constraints*: Minimum length of 1. Maximum length of 40." }, "Title": { - "description": "The title of the question.", + "description": "The title of the question.\n *Length Constraints*: Minimum length of 1. Maximum length of 350.", "maxLength": 350, "minLength": 1, "type": "string" }, "Weight": { "$ref": "#/definitions/Weight", - "description": "The question weight used for scoring." + "description": "The scoring weight of the section.\n *Minimum*: 0\n *Maximum*: 100" } }, "required": [ @@ -158,7 +158,7 @@ }, "EvaluationFormQuestionTypeProperties": { "additionalProperties": false, - "description": "The properties of the question.", + "description": "Information about properties for a question in an evaluation form. The question type properties must be either for a numeric question or a single select question.", "properties": { "Numeric": { "$ref": "#/definitions/EvaluationFormNumericQuestionProperties", @@ -166,22 +166,22 @@ }, "SingleSelect": { "$ref": "#/definitions/EvaluationFormSingleSelectQuestionProperties", - "description": "The properties of the single-select question." + "description": "The properties of the numeric question." } }, "type": "object" }, "EvaluationFormSection": { "additionalProperties": false, - "description": "The evaluation form section.", + "description": "Information about a section from an evaluation form. A section can contain sections and/or questions. Evaluation forms can only contain sections and subsections (two level nesting).", "properties": { "Instructions": { - "description": "The instructions for the section.", + "description": "The instructions of the section.", "maxLength": 1024, "type": "string" }, "Items": { - "description": "The list of section items.", + "description": "The items of the section.\n *Minimum*: 1", "insertionOrder": true, "items": { "$ref": "#/definitions/EvaluationFormItem" @@ -192,17 +192,17 @@ }, "RefId": { "$ref": "#/definitions/RefId", - "description": "The identifier to reference the section." + "description": "The identifier of the section. An identifier must be unique within the evaluation form.\n *Length Constraints*: Minimum length of 1. Maximum length of 40." }, "Title": { - "description": "The title of the section.", + "description": "The title of the section.\n *Length Constraints*: Minimum length of 1. Maximum length of 128.", "maxLength": 128, "minLength": 1, "type": "string" }, "Weight": { "$ref": "#/definitions/Weight", - "description": "The item weight used for scoring." + "description": "The scoring weight of the section.\n *Minimum*: 0 \n *Maximum*: 100" } }, "required": [ @@ -213,14 +213,14 @@ }, "EvaluationFormSingleSelectQuestionAutomation": { "additionalProperties": false, - "description": "The automation properties for the single-select question.", + "description": "Information about the automation configuration in single select questions. Automation options are evaluated in order, and the first matched option is applied. If no automation option matches, and there is a default option, then the default option is applied.", "properties": { "DefaultOptionRefId": { "$ref": "#/definitions/RefId", - "description": "The option reference identifier of the default answer." + "description": "The identifier of the default answer option, when none of the automation options match the criteria.\n *Length Constraints*: Minimum length of 1. Maximum length of 40." }, "Options": { - "description": "The answer options for the automation.", + "description": "The automation options of the single select question.\n *Minimum*: 1\n *Maximum*: 20", "insertionOrder": true, "items": { "$ref": "#/definitions/EvaluationFormSingleSelectQuestionAutomationOption" @@ -237,11 +237,11 @@ }, "EvaluationFormSingleSelectQuestionAutomationOption": { "additionalProperties": false, - "description": "The automation option for the single-select question.", + "description": "The automation options of the single select question.", "properties": { "RuleCategory": { "$ref": "#/definitions/SingleSelectQuestionRuleCategoryAutomation", - "description": "The automation option based on Rules categories." + "description": "The automation option based on a rule category for the single select question." } }, "required": [ @@ -251,22 +251,22 @@ }, "EvaluationFormSingleSelectQuestionOption": { "additionalProperties": false, - "description": "The option for a question.", + "description": "Information about the automation configuration in single select questions.", "properties": { "AutomaticFail": { - "description": "The flag to mark the option as automatic fail.", + "description": "The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.", "type": "boolean" }, "RefId": { "$ref": "#/definitions/RefId", - "description": "The identifier used to reference the option." + "description": "The identifier of the answer option. An identifier must be unique within the question.\n *Length Constraints*: Minimum length of 1. Maximum length of 40." }, "Score": { "$ref": "#/definitions/Score", - "description": "The score of the option." + "description": "The score assigned to the answer option.\n *Minimum*: 0\n *Maximum*: 10" }, "Text": { - "description": "The title of the option.", + "description": "The title of the answer option.\n *Length Constraints*: Minimum length of 1. Maximum length of 128.", "maxLength": 128, "minLength": 1, "type": "string" @@ -280,14 +280,14 @@ }, "EvaluationFormSingleSelectQuestionProperties": { "additionalProperties": false, - "description": "The properties of the single-select question.", + "description": "Information about the options in single select questions.", "properties": { "Automation": { "$ref": "#/definitions/EvaluationFormSingleSelectQuestionAutomation", - "description": "The automation properties for the single-select question." + "description": "The display mode of the single select question." }, "DisplayAs": { - "description": "The display mode of the single-select question.", + "description": "The display mode of the single select question.\n *Allowed values*: ``DROPDOWN`` | ``RADIO``", "enum": [ "DROPDOWN", "RADIO" @@ -295,7 +295,7 @@ "type": "string" }, "Options": { - "description": "The list of options for the question.", + "description": "The answer options of the single select question.\n *Minimum*: 2\n *Maximum*: 256", "insertionOrder": true, "items": { "$ref": "#/definitions/EvaluationFormSingleSelectQuestionOption" @@ -312,10 +312,10 @@ }, "NumericQuestionPropertyValueAutomation": { "additionalProperties": false, - "description": "The automation property name of the question.", + "description": "Information about the property value used in automation of a numeric questions.", "properties": { "Label": { - "description": "The automation property label.", + "description": "The property label of the automation.", "enum": [ "OVERALL_CUSTOMER_SENTIMENT_SCORE", "OVERALL_AGENT_SENTIMENT_SCORE", @@ -347,10 +347,10 @@ }, "ScoringStrategy": { "additionalProperties": false, - "description": "The scoring strategy.", + "description": "A scoring strategy of the evaluation form.", "properties": { "Mode": { - "description": "The scoring mode.", + "description": "The scoring mode of the evaluation form.\n *Allowed values*: ``QUESTION_ONLY`` | ``SECTION_ONLY``", "enum": [ "QUESTION_ONLY", "SECTION_ONLY" @@ -358,7 +358,7 @@ "type": "string" }, "Status": { - "description": "The scoring status.", + "description": "The scoring status of the evaluation form.\n *Allowed values*: ``ENABLED`` | ``DISABLED``", "enum": [ "ENABLED", "DISABLED" @@ -374,16 +374,16 @@ }, "SingleSelectQuestionRuleCategoryAutomation": { "additionalProperties": false, - "description": "The automation option based on Rules categories.", + "description": "Information about the automation option based on a rule category for a single select question.\n *Length Constraints*: Minimum length of 1. Maximum length of 50.", "properties": { "Category": { - "description": "The category name as defined in Rules.", + "description": "The category name, as defined in Rules.\n *Minimum*: 1\n *Maximum*: 50", "maxLength": 50, "minLength": 1, "type": "string" }, "Condition": { - "description": "The automation condition applied on contact categories.", + "description": "The condition to apply for the automation option. If the condition is PRESENT, then the option is applied when the contact data includes the category. Similarly, if the condition is NOT_PRESENT, then the option is applied when the contact data does not include the category.\n *Allowed values*: ``PRESENT`` | ``NOT_PRESENT`` \n *Maximum*: 50", "enum": [ "PRESENT", "NOT_PRESENT" @@ -392,7 +392,7 @@ }, "OptionRefId": { "$ref": "#/definitions/RefId", - "description": "The option identifier referencing the option to be selected when the automation option is triggered." + "description": "The identifier of the answer option. An identifier must be unique within the question.\n *Length Constraints*: Minimum length of 1. Maximum length of 40." } }, "required": [ @@ -407,14 +407,14 @@ "description": "A key-value pair to associate with a resource.", "properties": { "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -", "maxLength": 128, "minLength": 1, "pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$", "type": "string" }, "Value": { - "description": "The value for the tag. You can specify a value that's 1 to 256 characters in length.", + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -", "maxLength": 256, "type": "string" } @@ -432,7 +432,7 @@ "type": "number" } }, - "description": "Resource Type definition for AWS::Connect::EvaluationForm", + "description": "Creates an evaluation form for the specified CON instance.", "handlers": { "create": { "permissions": [ @@ -474,22 +474,22 @@ ], "properties": { "Description": { - "description": "The description of the evaluation form.", + "description": "The description of the evaluation form.\n *Length Constraints*: Minimum length of 0. Maximum length of 1024.", "maxLength": 1024, "type": "string" }, "EvaluationFormArn": { - "description": "The Amazon Resource Name (ARN) for the evaluation form.", + "description": "", "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/evaluation-form/[-a-zA-Z0-9]*$", "type": "string" }, "InstanceArn": { - "description": "The Amazon Resource Name (ARN) of the instance.", + "description": "The identifier of the Amazon Connect instance.", "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$", "type": "string" }, "Items": { - "description": "The list of evaluation form items.", + "description": "Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.\n *Minimum size*: 1\n *Maximum size*: 100", "insertionOrder": true, "items": { "$ref": "#/definitions/EvaluationFormBaseItem" @@ -500,11 +500,11 @@ }, "ScoringStrategy": { "$ref": "#/definitions/ScoringStrategy", - "description": "The scoring strategy." + "description": "A scoring strategy of the evaluation form." }, "Status": { "default": "DRAFT", - "description": "The status of the evaluation form.", + "description": "The status of the evaluation form.\n *Allowed values*: ``DRAFT`` | ``ACTIVE``", "enum": [ "DRAFT", "ACTIVE" @@ -512,7 +512,7 @@ "type": "string" }, "Tags": { - "description": "One or more tags.", + "description": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.", "insertionOrder": false, "items": { "$ref": "#/definitions/Tag" @@ -522,7 +522,7 @@ "uniqueItems": true }, "Title": { - "description": "The title of the evaluation form.", + "description": "A title of the evaluation form.", "maxLength": 128, "minLength": 1, "type": "string" diff --git a/artifacts/types/AWS::Connect::HoursOfOperation.json b/artifacts/types/AWS::Connect::HoursOfOperation.json index 909d9cfe..f6f1293c 100644 --- a/artifacts/types/AWS::Connect::HoursOfOperation.json +++ b/artifacts/types/AWS::Connect::HoursOfOperation.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Connect-HoursOfOperation", "type": "AWS::Connect::HoursOfOperation", - "time": "2024-01-03T22:30:26.24Z", + "time": "2024-06-19T21:28:36.691Z", "schema": { "additionalProperties": false, "definitions": { @@ -188,6 +188,13 @@ "Config" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-connect", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, "typeName": "AWS::Connect::HoursOfOperation" } } \ No newline at end of file diff --git a/artifacts/types/AWS::Connect::Instance.json b/artifacts/types/AWS::Connect::Instance.json index c58d8f29..7ff33efe 100644 --- a/artifacts/types/AWS::Connect::Instance.json +++ b/artifacts/types/AWS::Connect::Instance.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Connect-Instance", "type": "AWS::Connect::Instance", - "time": "2023-12-11T20:00:51.785Z", + "time": "2024-04-16T21:17:57.208Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Connect::InstanceStorageConfig.json b/artifacts/types/AWS::Connect::InstanceStorageConfig.json index a847d9fd..0ece54af 100644 --- a/artifacts/types/AWS::Connect::InstanceStorageConfig.json +++ b/artifacts/types/AWS::Connect::InstanceStorageConfig.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Connect-InstanceStorageConfig", "type": "AWS::Connect::InstanceStorageConfig", - "time": "2023-12-11T19:40:34.91Z", + "time": "2024-04-16T21:33:02.472Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Connect::IntegrationAssociation.json b/artifacts/types/AWS::Connect::IntegrationAssociation.json index 3632f7d0..7c68147f 100644 --- a/artifacts/types/AWS::Connect::IntegrationAssociation.json +++ b/artifacts/types/AWS::Connect::IntegrationAssociation.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Connect-IntegrationAssociation", "type": "AWS::Connect::IntegrationAssociation", - "time": "2023-12-11T19:28:40.64Z", + "time": "2024-04-16T21:35:10.161Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -67,6 +67,7 @@ "lex:CreateResourcePolicyStatement", "lambda:AddPermission", "app-integrations:GetApplication", + "app-integrations:CreateApplicationAssociation", "iam:AttachRolePolicy", "iam:CreateServiceLinkedRole", "iam:GetRolePolicy", @@ -78,6 +79,7 @@ "connect:DescribeInstance", "ds:DescribeDirectories", "app-integrations:DeleteEventIntegrationAssociation", + "app-integrations:DeleteApplicationAssociation", "events:ListTargetsByRule", "events:RemoveTargets", "events:DeleteRule", @@ -96,6 +98,16 @@ ] }, "list": { + "handlerSchema": { + "properties": { + "InstanceId": { + "$ref": "resource-schema.json#/properties/InstanceId" + } + }, + "required": [ + "InstanceId" + ] + }, "permissions": [ "connect:ListBots", "connect:ListLambdaFunctions", diff --git a/artifacts/types/AWS::Connect::PhoneNumber.json b/artifacts/types/AWS::Connect::PhoneNumber.json index 5c646267..5bbb101d 100644 --- a/artifacts/types/AWS::Connect::PhoneNumber.json +++ b/artifacts/types/AWS::Connect::PhoneNumber.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Connect-PhoneNumber", "type": "AWS::Connect::PhoneNumber", - "time": "2024-01-03T20:56:35.022Z", + "time": "2024-06-21T21:40:50.18Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Connect::PredefinedAttribute.json b/artifacts/types/AWS::Connect::PredefinedAttribute.json index b46a6ba7..cf8b075d 100644 --- a/artifacts/types/AWS::Connect::PredefinedAttribute.json +++ b/artifacts/types/AWS::Connect::PredefinedAttribute.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Connect-PredefinedAttribute", "type": "AWS::Connect::PredefinedAttribute", - "time": "2023-12-22T06:17:14.647Z", + "time": "2024-06-18T21:30:20.21Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -74,6 +74,15 @@ "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$", "type": "string" }, + "LastModifiedRegion": { + "description": "Last modified region.", + "pattern": "[a-z]{2}(-[a-z]+){1,2}(-[0-9])?", + "type": "string" + }, + "LastModifiedTime": { + "description": "Last modified time.", + "type": "number" + }, "Name": { "description": "The name of the predefined attribute.", "maxLength": 64, @@ -91,6 +100,10 @@ "type": "object" } }, + "readOnlyProperties": [ + "/properties/LastModifiedRegion", + "/properties/LastModifiedTime" + ], "required": [ "InstanceArn", "Name", diff --git a/artifacts/types/AWS::Connect::Prompt.json b/artifacts/types/AWS::Connect::Prompt.json index 7e91528f..8e796b26 100644 --- a/artifacts/types/AWS::Connect::Prompt.json +++ b/artifacts/types/AWS::Connect::Prompt.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Connect-Prompt", "type": "AWS::Connect::Prompt", - "time": "2023-10-31T21:30:52.913Z", + "time": "2024-06-11T21:25:22.42Z", "schema": { "additionalProperties": false, "definitions": { @@ -103,7 +103,7 @@ "description": "S3 URI of the customer's audio file for creating prompts resource..", "maxLength": 2000, "minLength": 1, - "pattern": "s3://\\S+/.+|https://\\S+\\.s3\\.\\S+\\.amazonaws\\.com/\\S+", + "pattern": "s3://\\S+/.+|https://\\S+\\.s3(\\.\\S+)?\\.amazonaws\\.com/\\S+", "type": "string" }, "Tags": { diff --git a/artifacts/types/AWS::Connect::Queue.json b/artifacts/types/AWS::Connect::Queue.json index 47c0c6ad..07ffef58 100644 --- a/artifacts/types/AWS::Connect::Queue.json +++ b/artifacts/types/AWS::Connect::Queue.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Connect-Queue", "type": "AWS::Connect::Queue", - "time": "2023-12-07T22:27:48.313Z", + "time": "2024-06-13T21:12:58.126Z", "schema": { "additionalProperties": false, "definitions": { diff --git a/artifacts/types/AWS::Connect::QuickConnect.json b/artifacts/types/AWS::Connect::QuickConnect.json index 09c9ab77..082f6b62 100644 --- a/artifacts/types/AWS::Connect::QuickConnect.json +++ b/artifacts/types/AWS::Connect::QuickConnect.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Connect-QuickConnect", "type": "AWS::Connect::QuickConnect", - "time": "2024-01-03T22:37:43.644Z", + "time": "2024-06-19T21:31:06.818Z", "schema": { "additionalProperties": false, "definitions": { @@ -230,6 +230,13 @@ "QuickConnectConfig" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-connect", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, "typeName": "AWS::Connect::QuickConnect" } } \ No newline at end of file diff --git a/artifacts/types/AWS::Connect::RoutingProfile.json b/artifacts/types/AWS::Connect::RoutingProfile.json index d0c96db1..9e6a202d 100644 --- a/artifacts/types/AWS::Connect::RoutingProfile.json +++ b/artifacts/types/AWS::Connect::RoutingProfile.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Connect-RoutingProfile", "type": "AWS::Connect::RoutingProfile", - "time": "2023-12-27T22:28:54.929Z", + "time": "2024-06-10T21:19:38.23Z", "schema": { "additionalProperties": false, "definitions": { @@ -239,7 +239,6 @@ "items": { "$ref": "#/definitions/RoutingProfileQueueConfig" }, - "maxItems": 10, "minItems": 1, "type": "array" }, diff --git a/artifacts/types/AWS::Connect::Rule.json b/artifacts/types/AWS::Connect::Rule.json index 35d8289d..4e399ed4 100644 --- a/artifacts/types/AWS::Connect::Rule.json +++ b/artifacts/types/AWS::Connect::Rule.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Connect-Rule", "type": "AWS::Connect::Rule", - "time": "2024-01-03T18:47:28.639Z", + "time": "2024-06-05T21:29:28.675Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -19,7 +19,7 @@ "CreateCaseActions": { "$ref": "#/definitions/CreateCaseActions" }, - "EndAssociatedTaskActions": { + "EndAssociatedTasksActions": { "$ref": "#/definitions/EndAssociatedTasksActions" }, "EventBridgeActions": { @@ -28,6 +28,9 @@ "SendNotificationActions": { "$ref": "#/definitions/SendNotificationActions" }, + "SubmitAutoEvaluationActions": { + "$ref": "#/definitions/SubmitAutoEvaluationActions" + }, "TaskActions": { "$ref": "#/definitions/TaskActions" }, @@ -244,7 +247,7 @@ "OnSalesforceCaseCreate", "OnMetricDataUpdate", "OnCaseCreate", - "OnCasesUpdate" + "OnCaseUpdate" ], "type": "string" }, @@ -312,6 +315,32 @@ "type": "array", "uniqueItems": true }, + "SubmitAutoEvaluationAction": { + "additionalProperties": false, + "description": "The definition of submit auto evaluation action.", + "properties": { + "EvaluationFormArn": { + "description": "The Amazon Resource Name (ARN) of the evaluation form.", + "pattern": "^$|arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/evaluation-form/[-a-zA-Z0-9]*$", + "type": "string" + } + }, + "required": [ + "EvaluationFormArn" + ], + "type": "object" + }, + "SubmitAutoEvaluationActions": { + "description": "This action will submit an auto contact evaluation when a rule is triggered.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/SubmitAutoEvaluationAction" + }, + "maxItems": 1, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, "Tag": { "additionalProperties": false, "description": "A key-value pair to associate with a resource.", @@ -417,7 +446,10 @@ "handlers": { "create": { "permissions": [ - "connect:CreateRule" + "connect:CreateRule", + "cases:GetTemplate", + "cases:ListFields", + "cases:ListFieldOptions" ] }, "delete": { @@ -434,6 +466,9 @@ "update": { "permissions": [ "connect:UpdateRule", + "cases:GetTemplate", + "cases:ListFields", + "cases:ListFieldOptions", "connect:TagResource", "connect:UntagResource" ] diff --git a/artifacts/types/AWS::Connect::SecurityKey.json b/artifacts/types/AWS::Connect::SecurityKey.json index 0ff58035..6dabd930 100644 --- a/artifacts/types/AWS::Connect::SecurityKey.json +++ b/artifacts/types/AWS::Connect::SecurityKey.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Connect-SecurityKey", "type": "AWS::Connect::SecurityKey", - "time": "2023-12-11T19:18:22.495Z", + "time": "2024-04-16T21:24:09.237Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Connect::SecurityProfile.json b/artifacts/types/AWS::Connect::SecurityProfile.json index 80fa04de..a1373828 100644 --- a/artifacts/types/AWS::Connect::SecurityProfile.json +++ b/artifacts/types/AWS::Connect::SecurityProfile.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Connect-SecurityProfile", "type": "AWS::Connect::SecurityProfile", - "time": "2023-12-14T23:25:43.816Z", + "time": "2024-06-06T21:23:12.223Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -9,6 +9,39 @@ "/properties/InstanceArn" ], "definitions": { + "Application": { + "additionalProperties": false, + "description": "A third-party application's metadata.", + "properties": { + "ApplicationPermissions": { + "description": "The permissions that the agent is granted on the application", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ApplicationPermission" + }, + "maxItems": 10, + "type": "array", + "uniqueItems": true + }, + "Namespace": { + "description": "Namespace of the application that you want to give access to.", + "maxLength": 128, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "ApplicationPermissions", + "Namespace" + ], + "type": "object" + }, + "ApplicationPermission": { + "description": "The permissions that the agent is granted on the application.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, "Permission": { "description": "A permission associated with the security profile.", "maxLength": 128, @@ -16,7 +49,7 @@ "type": "string" }, "ResourceName": { - "description": "A resource that a security profile applies tag restrictions to in Amazon Connect.", + "description": "A resource that a security profile applies tag or hierarchy restrictions to in Amazon Connect.", "maxLength": 128, "minLength": 1, "type": "string" @@ -78,6 +111,7 @@ "read": { "permissions": [ "connect:DescribeSecurityProfile", + "connect:ListSecurityProfileApplications", "connect:ListSecurityProfilePermissions" ] }, @@ -93,6 +127,13 @@ "/properties/SecurityProfileArn" ], "properties": { + "AllowedAccessControlHierarchyGroupId": { + "description": "The identifier of the hierarchy group that a security profile uses to restrict access to resources in Amazon Connect.", + "maxLength": 127, + "minLength": 0, + "pattern": "^[a-zA-Z0-9-]+$", + "type": "string" + }, "AllowedAccessControlTags": { "description": "The list of tags that a security profile uses to restrict access to resources in Amazon Connect.", "insertionOrder": false, @@ -103,17 +144,46 @@ "type": "array", "uniqueItems": true }, + "Applications": { + "description": "A list of third-party applications that the security profile will give access to.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Application" + }, + "maxItems": 10, + "type": "array", + "uniqueItems": true + }, "Description": { "description": "The description of the security profile.", "maxLength": 250, "minLength": 0, "type": "string" }, + "HierarchyRestrictedResources": { + "description": "The list of resources that a security profile applies hierarchy restrictions to in Amazon Connect.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ResourceName" + }, + "maxItems": 10, + "type": "array", + "uniqueItems": true + }, "InstanceArn": { "description": "The identifier of the Amazon Connect instance.", "pattern": "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$", "type": "string" }, + "LastModifiedRegion": { + "description": "The AWS Region where this resource was last modified.", + "pattern": "[a-z]{2}(-[a-z]+){1,2}(-[0-9])?", + "type": "string" + }, + "LastModifiedTime": { + "description": "The timestamp when this resource was last modified.", + "type": "number" + }, "Permissions": { "description": "Permissions assigned to the security profile.", "insertionOrder": false, @@ -158,7 +228,9 @@ } }, "readOnlyProperties": [ - "/properties/SecurityProfileArn" + "/properties/SecurityProfileArn", + "/properties/LastModifiedRegion", + "/properties/LastModifiedTime" ], "required": [ "InstanceArn", diff --git a/artifacts/types/AWS::Connect::TaskTemplate.json b/artifacts/types/AWS::Connect::TaskTemplate.json index c818a3ce..b4a633ce 100644 --- a/artifacts/types/AWS::Connect::TaskTemplate.json +++ b/artifacts/types/AWS::Connect::TaskTemplate.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Connect-TaskTemplate", "type": "AWS::Connect::TaskTemplate", - "time": "2024-01-02T17:58:57.078Z", + "time": "2024-06-24T15:56:11.471Z", "schema": { "additionalProperties": false, "definitions": { diff --git a/artifacts/types/AWS::Connect::TrafficDistributionGroup.json b/artifacts/types/AWS::Connect::TrafficDistributionGroup.json index db0688e4..3b14e2fe 100644 --- a/artifacts/types/AWS::Connect::TrafficDistributionGroup.json +++ b/artifacts/types/AWS::Connect::TrafficDistributionGroup.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Connect-TrafficDistributionGroup", "type": "AWS::Connect::TrafficDistributionGroup", - "time": "2023-12-22T00:54:41.274Z", + "time": "2024-05-28T23:01:19.475Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Connect::User.json b/artifacts/types/AWS::Connect::User.json index 30134872..9ac6cef3 100644 --- a/artifacts/types/AWS::Connect::User.json +++ b/artifacts/types/AWS::Connect::User.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Connect-User", "type": "AWS::Connect::User", - "time": "2024-01-03T22:12:59.674Z", + "time": "2024-06-19T21:28:38.737Z", "schema": { "additionalProperties": false, "definitions": { @@ -175,6 +175,21 @@ "connect:UntagResource" ] }, + "list": { + "handlerSchema": { + "properties": { + "InstanceArn": { + "$ref": "resource-schema.json#/properties/InstanceArn" + } + }, + "required": [ + "InstanceArn" + ] + }, + "permissions": [ + "connect:ListUsers" + ] + }, "read": { "permissions": [ "connect:DescribeUser", @@ -285,6 +300,13 @@ "Username" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-connect", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, "typeName": "AWS::Connect::User", "writeOnlyProperties": [ "/properties/Password" diff --git a/artifacts/types/AWS::Connect::UserHierarchyGroup.json b/artifacts/types/AWS::Connect::UserHierarchyGroup.json index 9c5bdb04..ebf76620 100644 --- a/artifacts/types/AWS::Connect::UserHierarchyGroup.json +++ b/artifacts/types/AWS::Connect::UserHierarchyGroup.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Connect-UserHierarchyGroup", "type": "AWS::Connect::UserHierarchyGroup", - "time": "2024-01-03T22:24:39.799Z", + "time": "2024-06-19T21:23:34.912Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -122,6 +122,10 @@ ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-connect", "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, "taggable": true }, "typeName": "AWS::Connect::UserHierarchyGroup" diff --git a/artifacts/types/AWS::Connect::View.json b/artifacts/types/AWS::Connect::View.json index 28d4036d..b51eddfd 100644 --- a/artifacts/types/AWS::Connect::View.json +++ b/artifacts/types/AWS::Connect::View.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Connect-View", "type": "AWS::Connect::View", - "time": "2023-12-06T22:40:46.951Z", + "time": "2024-05-16T16:07:10.95Z", "schema": { "additionalProperties": false, "definitions": { diff --git a/artifacts/types/AWS::Connect::ViewVersion.json b/artifacts/types/AWS::Connect::ViewVersion.json index 28c84b19..d08a38c1 100644 --- a/artifacts/types/AWS::Connect::ViewVersion.json +++ b/artifacts/types/AWS::Connect::ViewVersion.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Connect-ViewVersion", "type": "AWS::Connect::ViewVersion", - "time": "2023-12-06T23:09:18.849Z", + "time": "2024-05-16T16:30:40.921Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::ConnectCampaigns::Campaign.json b/artifacts/types/AWS::ConnectCampaigns::Campaign.json index b3a37266..18303cb9 100644 --- a/artifacts/types/AWS::ConnectCampaigns::Campaign.json +++ b/artifacts/types/AWS::ConnectCampaigns::Campaign.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ConnectCampaigns-Campaign", "type": "AWS::ConnectCampaigns::Campaign", - "time": "2024-01-04T22:38:42.528Z", + "time": "2024-06-13T21:32:55.988Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -26,6 +26,10 @@ "additionalProperties": false, "description": "The configuration used for answering machine detection during outbound calls", "properties": { + "AwaitAnswerMachinePrompt": { + "description": "Enables detection of prompts (e.g., beep after after a voicemail greeting)", + "type": "boolean" + }, "EnableAnswerMachineDetection": { "description": "Flag to decided whether outbound calls should have answering machine detection enabled or not", "type": "boolean" diff --git a/artifacts/types/AWS::ControlTower::EnabledBaseline.json b/artifacts/types/AWS::ControlTower::EnabledBaseline.json new file mode 100644 index 00000000..459561c4 --- /dev/null +++ b/artifacts/types/AWS::ControlTower::EnabledBaseline.json @@ -0,0 +1,242 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ControlTower-EnabledBaseline", + "type": "AWS::ControlTower::EnabledBaseline", + "time": "2024-06-21T16:17:05.106Z", + "schema": { + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/TargetIdentifier", + "/properties/BaselineIdentifier" + ], + "definitions": { + "AnyType": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "object" + }, + { + "type": "number" + }, + { + "insertionOrder": false, + "items": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "number" + }, + { + "type": "object" + }, + { + "type": "string" + } + ] + }, + "type": "array" + }, + { + "type": "boolean" + } + ] + }, + "Parameter": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "Value": { + "$ref": "#/definitions/AnyType" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Definition of AWS::ControlTower::EnabledBaseline Resource Type", + "handlers": { + "create": { + "permissions": [ + "controltower:EnableBaseline", + "controltower:TagResource", + "controltower:GetBaselineOperation", + "controltower:GetEnabledBaseline", + "controltower:ListTagsForResource", + "organizations:CreateOrganizationalUnit", + "organizations:CreateOrganization", + "organizations:UpdatePolicy", + "organizations:CreatePolicy", + "organizations:AttachPolicy", + "organizations:DetachPolicy", + "organizations:DeletePolicy", + "organizations:EnablePolicyType", + "organizations:EnableAWSServiceAccess", + "organizations:ListRoots", + "servicecatalog:AssociatePrincipalWithPortfolio", + "servicecatalog:AssociateProductWithPortfolio", + "servicecatalog:CreatePortfolio", + "servicecatalog:CreateProduct", + "servicecatalog:CreateProvisioningArtifact", + "servicecatalog:ListPortfolios", + "servicecatalog:ListProvisioningArtifacts", + "servicecatalog:SearchProductsAsAdmin", + "servicecatalog:UpdatePortfolio", + "servicecatalog:UpdateProvisioningArtifact", + "servicecatalog:ListPrincipalsForPortfolio", + "servicecatalog:DeleteProvisioningArtifact" + ] + }, + "delete": { + "permissions": [ + "controltower:DisableBaseline", + "controltower:GetBaselineOperation", + "organizations:CreateOrganizationalUnit", + "organizations:CreateOrganization", + "organizations:UpdatePolicy", + "organizations:CreatePolicy", + "organizations:AttachPolicy", + "organizations:DetachPolicy", + "organizations:DeletePolicy", + "organizations:EnablePolicyType", + "organizations:EnableAWSServiceAccess", + "organizations:ListRoots", + "servicecatalog:AssociatePrincipalWithPortfolio", + "servicecatalog:AssociateProductWithPortfolio", + "servicecatalog:CreatePortfolio", + "servicecatalog:CreateProduct", + "servicecatalog:CreateProvisioningArtifact", + "servicecatalog:ListPortfolios", + "servicecatalog:ListProvisioningArtifacts", + "servicecatalog:SearchProductsAsAdmin", + "servicecatalog:UpdatePortfolio", + "servicecatalog:UpdateProvisioningArtifact", + "servicecatalog:ListPrincipalsForPortfolio", + "servicecatalog:DeleteProvisioningArtifact" + ] + }, + "list": { + "permissions": [ + "controltower:ListEnabledBaselines" + ] + }, + "read": { + "permissions": [ + "controltower:GetEnabledBaseline", + "controltower:ListEnabledBaselines", + "controltower:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "controltower:UpdateEnabledBaseline", + "controltower:GetBaselineOperation", + "organizations:CreateOrganizationalUnit", + "organizations:CreateOrganization", + "organizations:UpdatePolicy", + "organizations:CreatePolicy", + "organizations:AttachPolicy", + "organizations:DetachPolicy", + "organizations:DeletePolicy", + "organizations:EnablePolicyType", + "organizations:EnableAWSServiceAccess", + "organizations:ListRoots", + "servicecatalog:AssociatePrincipalWithPortfolio", + "servicecatalog:AssociateProductWithPortfolio", + "servicecatalog:CreatePortfolio", + "servicecatalog:CreateProduct", + "servicecatalog:CreateProvisioningArtifact", + "servicecatalog:ListPortfolios", + "servicecatalog:ListProvisioningArtifacts", + "servicecatalog:SearchProductsAsAdmin", + "servicecatalog:UpdatePortfolio", + "servicecatalog:UpdateProvisioningArtifact", + "servicecatalog:ListPrincipalsForPortfolio", + "servicecatalog:DeleteProvisioningArtifact", + "controltower:TagResource", + "controltower:ListTagsForResource", + "controltower:GetEnabledBaseline" + ] + } + }, + "primaryIdentifier": [ + "/properties/EnabledBaselineIdentifier" + ], + "properties": { + "BaselineIdentifier": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:aws[0-9a-zA-Z_\\-:\\/]+$", + "type": "string" + }, + "BaselineVersion": { + "pattern": "^\\d+(?:\\.\\d+){0,2}$", + "type": "string" + }, + "EnabledBaselineIdentifier": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:aws[0-9a-zA-Z_\\-:\\/]+$", + "type": "string" + }, + "Parameters": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Parameter" + }, + "type": "array" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + }, + "TargetIdentifier": { + "maxLength": 2048, + "minLength": 20, + "pattern": "^arn:aws[0-9a-zA-Z_\\-:\\/]+$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/EnabledBaselineIdentifier" + ], + "required": [ + "BaselineIdentifier", + "TargetIdentifier", + "BaselineVersion" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::ControlTower::EnabledBaseline" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::ControlTower::EnabledControl.json b/artifacts/types/AWS::ControlTower::EnabledControl.json index 8f2b4ee7..ca79a27d 100644 --- a/artifacts/types/AWS::ControlTower::EnabledControl.json +++ b/artifacts/types/AWS::ControlTower::EnabledControl.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ControlTower-EnabledControl", "type": "AWS::ControlTower::EnabledControl", - "time": "2024-01-04T17:26:14.884Z", + "time": "2024-06-24T16:50:01.468Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -58,6 +58,29 @@ "Key" ], "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" } }, "description": "Enables a control on a specified target.", @@ -68,6 +91,7 @@ "controltower:GetEnabledControl", "controltower:GetControlOperation", "controltower:EnableControl", + "controltower:TagResource", "organizations:UpdatePolicy", "organizations:CreatePolicy", "organizations:AttachPolicy", @@ -75,7 +99,8 @@ "organizations:ListPoliciesForTarget", "organizations:ListTargetsForPolicy", "organizations:DescribePolicy" - ] + ], + "timeoutInMinutes": 720 }, "delete": { "permissions": [ @@ -89,7 +114,8 @@ "organizations:ListPoliciesForTarget", "organizations:ListTargetsForPolicy", "organizations:DescribePolicy" - ] + ], + "timeoutInMinutes": 720 }, "list": { "handlerSchema": { @@ -109,7 +135,8 @@ "read": { "permissions": [ "controltower:ListEnabledControls", - "controltower:GetEnabledControl" + "controltower:GetEnabledControl", + "controltower:ListTagsForResource" ] }, "update": { @@ -118,6 +145,8 @@ "controltower:GetEnabledControl", "controltower:GetControlOperation", "controltower:UpdateEnabledControl", + "controltower:UntagResource", + "controltower:TagResource", "organizations:UpdatePolicy", "organizations:CreatePolicy", "organizations:AttachPolicy", @@ -125,7 +154,8 @@ "organizations:ListPoliciesForTarget", "organizations:ListTargetsForPolicy", "organizations:DescribePolicy" - ] + ], + "timeoutInMinutes": 720 } }, "primaryIdentifier": [ @@ -149,6 +179,16 @@ "minItems": 1, "type": "array" }, + "Tags": { + "description": "A set of tags to assign to the enabled control.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "minItems": 1, + "type": "array" + }, "TargetIdentifier": { "description": "Arn for Organizational unit to which the control needs to be applied", "maxLength": 2048, @@ -163,10 +203,11 @@ ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-controltower", "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true }, "typeName": "AWS::ControlTower::EnabledControl" } diff --git a/artifacts/types/AWS::ControlTower::LandingZone.json b/artifacts/types/AWS::ControlTower::LandingZone.json index 010f242f..09f7c846 100644 --- a/artifacts/types/AWS::ControlTower::LandingZone.json +++ b/artifacts/types/AWS::ControlTower::LandingZone.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ControlTower-LandingZone", "type": "AWS::ControlTower::LandingZone", - "time": "2023-12-19T19:52:07.609Z", + "time": "2024-06-20T16:07:32.451Z", "schema": { "additionalProperties": false, "definitions": { diff --git a/artifacts/types/AWS::CustomerProfiles::CalculatedAttributeDefinition.json b/artifacts/types/AWS::CustomerProfiles::CalculatedAttributeDefinition.json index fd39a062..8619cc99 100644 --- a/artifacts/types/AWS::CustomerProfiles::CalculatedAttributeDefinition.json +++ b/artifacts/types/AWS::CustomerProfiles::CalculatedAttributeDefinition.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-CustomerProfiles-CalculatedAttributeDefinition", "type": "AWS::CustomerProfiles::CalculatedAttributeDefinition", - "time": "2024-01-03T16:54:53.794Z", + "time": "2024-06-18T15:52:35.98Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::CustomerProfiles::Domain.json b/artifacts/types/AWS::CustomerProfiles::Domain.json index 7fd5155f..25f6b221 100644 --- a/artifacts/types/AWS::CustomerProfiles::Domain.json +++ b/artifacts/types/AWS::CustomerProfiles::Domain.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-CustomerProfiles-Domain", "type": "AWS::CustomerProfiles::Domain", - "time": "2024-01-03T16:55:55.053Z", + "time": "2024-06-18T15:54:02.766Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -452,7 +452,8 @@ "/properties/Stats" ], "required": [ - "DomainName" + "DomainName", + "DefaultExpirationDays" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-customer-profiles.git", "tagging": { diff --git a/artifacts/types/AWS::CustomerProfiles::EventStream.json b/artifacts/types/AWS::CustomerProfiles::EventStream.json index 1b12ab01..9a1f8734 100644 --- a/artifacts/types/AWS::CustomerProfiles::EventStream.json +++ b/artifacts/types/AWS::CustomerProfiles::EventStream.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-CustomerProfiles-EventStream", "type": "AWS::CustomerProfiles::EventStream", - "time": "2024-01-03T16:54:40.562Z", + "time": "2024-06-18T15:52:30.044Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::CustomerProfiles::Integration.json b/artifacts/types/AWS::CustomerProfiles::Integration.json index 5ab677bf..06b57c34 100644 --- a/artifacts/types/AWS::CustomerProfiles::Integration.json +++ b/artifacts/types/AWS::CustomerProfiles::Integration.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-CustomerProfiles-Integration", "type": "AWS::CustomerProfiles::Integration", - "time": "2024-01-03T17:04:23.191Z", + "time": "2024-06-18T15:59:29.635Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::CustomerProfiles::ObjectType.json b/artifacts/types/AWS::CustomerProfiles::ObjectType.json index 067620e3..867b4374 100644 --- a/artifacts/types/AWS::CustomerProfiles::ObjectType.json +++ b/artifacts/types/AWS::CustomerProfiles::ObjectType.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-CustomerProfiles-ObjectType", "type": "AWS::CustomerProfiles::ObjectType", - "time": "2024-01-03T17:05:59.924Z", + "time": "2024-06-18T15:58:26.33Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -265,7 +265,9 @@ "/properties/CreatedAt" ], "required": [ - "DomainName" + "DomainName", + "ObjectTypeName", + "Description" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-customer-profiles.git", "tagging": { diff --git a/artifacts/types/AWS::DMS::DataProvider.json b/artifacts/types/AWS::DMS::DataProvider.json index 4930c35c..11330c07 100644 --- a/artifacts/types/AWS::DMS::DataProvider.json +++ b/artifacts/types/AWS::DMS::DataProvider.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-DMS-DataProvider", "type": "AWS::DMS::DataProvider", - "time": "2023-12-14T05:32:52.489Z", + "time": "2024-06-10T14:48:42.351Z", "schema": { "additionalIdentifiers": [ [ @@ -14,8 +14,8 @@ "enum": [ "none", "require", - "verify_ca", - "verify_full" + "verify-ca", + "verify-full" ], "type": "string" }, @@ -120,7 +120,7 @@ "Engine": { "description": "The property describes a data engine for the data provider.", "enum": [ - "postgresql", + "postgres", "mysql", "oracle", "sqlserver", @@ -135,137 +135,159 @@ "type": "boolean" }, "Settings": { - "description": "The property identifies the exact type of settings for the data provider.", - "oneOf": [ + "additionalProperties": false, + "anyOf": [ + { + "required": [ + "PostgreSqlSettings" + ] + }, + { + "required": [ + "MySqlSettings" + ] + }, { + "required": [ + "OracleSettings" + ] + }, + { + "required": [ + "MicrosoftSqlServerSettings" + ] + } + ], + "description": "The property identifies the exact type of settings for the data provider.", + "properties": { + "MicrosoftSqlServerSettings": { "additionalProperties": false, - "description": "PostgreSqlSettings property identifier.", + "description": "MicrosoftSqlServerSettings property identifier.", "properties": { - "PostgreSqlSettings": { - "additionalProperties": false, - "properties": { - "CertificateArn": { - "type": "string" - }, - "DatabaseName": { - "type": "string" - }, - "Port": { - "type": "integer" - }, - "ServerName": { - "type": "string" - }, - "SslMode": { - "$ref": "#/definitions/DmsSslModeValue", - "type": "object" - } - }, + "CertificateArn": { + "type": "string" + }, + "DatabaseName": { + "type": "string" + }, + "Port": { + "type": "integer" + }, + "ServerName": { + "type": "string" + }, + "SslMode": { + "$ref": "#/definitions/DmsSslModeValue", "type": "object" } }, + "required": [ + "ServerName", + "Port", + "SslMode", + "DatabaseName" + ], "type": "object" }, - { + "MySqlSettings": { "additionalProperties": false, "description": "MySqlSettings property identifier.", "properties": { - "MySqlSettings": { - "additionalProperties": false, - "properties": { - "CertificateArn": { - "type": "string" - }, - "Port": { - "type": "integer" - }, - "ServerName": { - "type": "string" - }, - "SslMode": { - "$ref": "#/definitions/DmsSslModeValue", - "type": "object" - } - }, + "CertificateArn": { + "type": "string" + }, + "Port": { + "type": "integer" + }, + "ServerName": { + "type": "string" + }, + "SslMode": { + "$ref": "#/definitions/DmsSslModeValue", "type": "object" } }, + "required": [ + "ServerName", + "Port", + "SslMode" + ], "type": "object" }, - { + "OracleSettings": { "additionalProperties": false, "description": "OracleSettings property identifier.", "properties": { - "OracleSettings": { - "additionalProperties": false, - "properties": { - "AsmServer": { - "type": "string" - }, - "CertificateArn": { - "type": "string" - }, - "DatabaseName": { - "type": "string" - }, - "Port": { - "type": "integer" - }, - "SecretsManagerOracleAsmAccessRoleArn": { - "type": "string" - }, - "SecretsManagerOracleAsmSecretId": { - "type": "string" - }, - "SecretsManagerSecurityDbEncryptionAccessRoleArn": { - "type": "string" - }, - "SecretsManagerSecurityDbEncryptionSecretId": { - "type": "string" - }, - "ServerName": { - "type": "string" - }, - "SslMode": { - "$ref": "#/definitions/DmsSslModeValue", - "type": "object" - } - }, + "AsmServer": { + "type": "string" + }, + "CertificateArn": { + "type": "string" + }, + "DatabaseName": { + "type": "string" + }, + "Port": { + "type": "integer" + }, + "SecretsManagerOracleAsmAccessRoleArn": { + "type": "string" + }, + "SecretsManagerOracleAsmSecretId": { + "type": "string" + }, + "SecretsManagerSecurityDbEncryptionAccessRoleArn": { + "type": "string" + }, + "SecretsManagerSecurityDbEncryptionSecretId": { + "type": "string" + }, + "ServerName": { + "type": "string" + }, + "SslMode": { + "$ref": "#/definitions/DmsSslModeValue", "type": "object" } }, + "required": [ + "ServerName", + "Port", + "SslMode", + "DatabaseName" + ], "type": "object" }, - { + "PostgreSqlSettings": { "additionalProperties": false, - "description": "MicrosoftSqlServerSettings property identifier.", + "description": "PostgreSqlSettings property identifier.", "properties": { - "MicrosoftSqlServerSettings": { - "additionalProperties": false, - "properties": { - "CertificateArn": { - "type": "string" - }, - "DatabaseName": { - "type": "string" - }, - "Port": { - "type": "integer" - }, - "ServerName": { - "type": "string" - }, - "SslMode": { - "$ref": "#/definitions/DmsSslModeValue", - "type": "object" - } - }, + "CertificateArn": { + "type": "string" + }, + "DatabaseName": { + "type": "string" + }, + "Port": { + "type": "integer" + }, + "ServerName": { + "type": "string" + }, + "SslMode": { + "$ref": "#/definitions/DmsSslModeValue", "type": "object" } }, + "required": [ + "ServerName", + "Port", + "SslMode", + "DatabaseName" + ], "type": "object" } - ], + }, "type": "object" }, "Tags": { diff --git a/artifacts/types/AWS::DMS::InstanceProfile.json b/artifacts/types/AWS::DMS::InstanceProfile.json index ef3216f3..1e304456 100644 --- a/artifacts/types/AWS::DMS::InstanceProfile.json +++ b/artifacts/types/AWS::DMS::InstanceProfile.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-DMS-InstanceProfile", "type": "AWS::DMS::InstanceProfile", - "time": "2023-12-14T05:37:36.428Z", + "time": "2024-06-10T14:39:37.15Z", "schema": { "additionalIdentifiers": [ [ diff --git a/artifacts/types/AWS::DMS::MigrationProject.json b/artifacts/types/AWS::DMS::MigrationProject.json index 910da2c6..3ebfff8c 100644 --- a/artifacts/types/AWS::DMS::MigrationProject.json +++ b/artifacts/types/AWS::DMS::MigrationProject.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-DMS-MigrationProject", "type": "AWS::DMS::MigrationProject", - "time": "2023-12-14T05:35:35.339Z", + "time": "2024-06-10T14:41:47.938Z", "schema": { "additionalIdentifiers": [ [ diff --git a/artifacts/types/AWS::DMS::ReplicationConfig.json b/artifacts/types/AWS::DMS::ReplicationConfig.json index 500807c6..f62c8954 100644 --- a/artifacts/types/AWS::DMS::ReplicationConfig.json +++ b/artifacts/types/AWS::DMS::ReplicationConfig.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-DMS-ReplicationConfig", "type": "AWS::DMS::ReplicationConfig", - "time": "2023-12-29T08:32:06.63Z", + "time": "2024-06-10T08:43:01.9Z", "schema": { "additionalIdentifiers": [ [ diff --git a/artifacts/types/AWS::DataBrew::Dataset.json b/artifacts/types/AWS::DataBrew::Dataset.json index 479bc7bb..b894db74 100644 --- a/artifacts/types/AWS::DataBrew::Dataset.json +++ b/artifacts/types/AWS::DataBrew::Dataset.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-DataBrew-Dataset", "type": "AWS::DataBrew::Dataset", - "time": "2023-11-14T19:37:29.625Z", + "time": "2024-06-18T17:49:56.885Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::DataBrew::Job.json b/artifacts/types/AWS::DataBrew::Job.json index 1971d15e..15a1cc95 100644 --- a/artifacts/types/AWS::DataBrew::Job.json +++ b/artifacts/types/AWS::DataBrew::Job.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-DataBrew-Job", "type": "AWS::DataBrew::Job", - "time": "2023-11-14T19:17:17.011Z", + "time": "2024-06-18T17:40:02.621Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::DataBrew::Project.json b/artifacts/types/AWS::DataBrew::Project.json index bcd1651c..825058c7 100644 --- a/artifacts/types/AWS::DataBrew::Project.json +++ b/artifacts/types/AWS::DataBrew::Project.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-DataBrew-Project", "type": "AWS::DataBrew::Project", - "time": "2023-11-14T19:00:08.521Z", + "time": "2024-06-18T17:31:18.106Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::DataBrew::Recipe.json b/artifacts/types/AWS::DataBrew::Recipe.json index a38cc0b9..294b35a2 100644 --- a/artifacts/types/AWS::DataBrew::Recipe.json +++ b/artifacts/types/AWS::DataBrew::Recipe.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-DataBrew-Recipe", "type": "AWS::DataBrew::Recipe", - "time": "2023-11-14T18:56:23.505Z", + "time": "2024-06-18T17:30:14.598Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::DataBrew::Ruleset.json b/artifacts/types/AWS::DataBrew::Ruleset.json index 52bacc4b..0bab7dd5 100644 --- a/artifacts/types/AWS::DataBrew::Ruleset.json +++ b/artifacts/types/AWS::DataBrew::Ruleset.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-DataBrew-Ruleset", "type": "AWS::DataBrew::Ruleset", - "time": "2023-11-14T18:59:22.726Z", + "time": "2024-06-18T17:32:06.853Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::DataBrew::Schedule.json b/artifacts/types/AWS::DataBrew::Schedule.json index 8fa31558..3dec0a0c 100644 --- a/artifacts/types/AWS::DataBrew::Schedule.json +++ b/artifacts/types/AWS::DataBrew::Schedule.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-DataBrew-Schedule", "type": "AWS::DataBrew::Schedule", - "time": "2023-11-14T19:00:27.132Z", + "time": "2024-06-18T17:31:47.204Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::DataPipeline::Pipeline.json b/artifacts/types/AWS::DataPipeline::Pipeline.json index 494f9146..905dba56 100644 --- a/artifacts/types/AWS::DataPipeline::Pipeline.json +++ b/artifacts/types/AWS::DataPipeline::Pipeline.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-DataPipeline-Pipeline", "type": "AWS::DataPipeline::Pipeline", - "time": "2024-01-03T17:08:09.234Z", + "time": "2024-02-13T17:01:04.57Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::DataSync::Agent.json b/artifacts/types/AWS::DataSync::Agent.json index b6c36298..43a6533f 100644 --- a/artifacts/types/AWS::DataSync::Agent.json +++ b/artifacts/types/AWS::DataSync::Agent.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-DataSync-Agent", "type": "AWS::DataSync::Agent", - "time": "2023-12-28T17:28:19.494Z", + "time": "2024-06-07T18:27:20.339Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -96,7 +96,7 @@ "AgentName": { "description": "The name configured for the agent. Text reference used to identify the agent in the console.", "maxLength": 256, - "minLength": 1, + "minLength": 0, "pattern": "^[a-zA-Z0-9\\s+=._:@/-]+$", "type": "string" }, diff --git a/artifacts/types/AWS::DataSync::LocationAzureBlob.json b/artifacts/types/AWS::DataSync::LocationAzureBlob.json index 58c212e7..dfdcef9c 100644 --- a/artifacts/types/AWS::DataSync::LocationAzureBlob.json +++ b/artifacts/types/AWS::DataSync::LocationAzureBlob.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-DataSync-LocationAzureBlob", "type": "AWS::DataSync::LocationAzureBlob", - "time": "2023-12-28T18:12:10.002Z", + "time": "2024-06-07T19:05:06.361Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::DataSync::LocationEFS.json b/artifacts/types/AWS::DataSync::LocationEFS.json index 3beedaaa..2fd1cb51 100644 --- a/artifacts/types/AWS::DataSync::LocationEFS.json +++ b/artifacts/types/AWS::DataSync::LocationEFS.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-DataSync-LocationEFS", "type": "AWS::DataSync::LocationEFS", - "time": "2023-12-28T17:37:05.912Z", + "time": "2024-06-07T18:33:12.757Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::DataSync::LocationFSxLustre.json b/artifacts/types/AWS::DataSync::LocationFSxLustre.json index 14defccb..f3246c6d 100644 --- a/artifacts/types/AWS::DataSync::LocationFSxLustre.json +++ b/artifacts/types/AWS::DataSync::LocationFSxLustre.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-DataSync-LocationFSxLustre", "type": "AWS::DataSync::LocationFSxLustre", - "time": "2023-12-28T18:03:28.724Z", + "time": "2024-06-07T18:54:45.178Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::DataSync::LocationFSxONTAP.json b/artifacts/types/AWS::DataSync::LocationFSxONTAP.json index 89928233..9513cd43 100644 --- a/artifacts/types/AWS::DataSync::LocationFSxONTAP.json +++ b/artifacts/types/AWS::DataSync::LocationFSxONTAP.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-DataSync-LocationFSxONTAP", "type": "AWS::DataSync::LocationFSxONTAP", - "time": "2023-12-28T18:09:19.942Z", + "time": "2024-06-07T19:01:09.931Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::DataSync::LocationFSxOpenZFS.json b/artifacts/types/AWS::DataSync::LocationFSxOpenZFS.json index 862b8bd0..af40ecdf 100644 --- a/artifacts/types/AWS::DataSync::LocationFSxOpenZFS.json +++ b/artifacts/types/AWS::DataSync::LocationFSxOpenZFS.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-DataSync-LocationFSxOpenZFS", "type": "AWS::DataSync::LocationFSxOpenZFS", - "time": "2023-12-28T18:06:23.575Z", + "time": "2024-06-07T18:57:52.676Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::DataSync::LocationFSxWindows.json b/artifacts/types/AWS::DataSync::LocationFSxWindows.json index 1f7c9eee..d3fb1806 100644 --- a/artifacts/types/AWS::DataSync::LocationFSxWindows.json +++ b/artifacts/types/AWS::DataSync::LocationFSxWindows.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-DataSync-LocationFSxWindows", "type": "AWS::DataSync::LocationFSxWindows", - "time": "2023-12-28T17:55:11.236Z", + "time": "2024-06-07T18:48:51.621Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::DataSync::LocationHDFS.json b/artifacts/types/AWS::DataSync::LocationHDFS.json index 947a35f9..7f0f97e2 100644 --- a/artifacts/types/AWS::DataSync::LocationHDFS.json +++ b/artifacts/types/AWS::DataSync::LocationHDFS.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-DataSync-LocationHDFS", "type": "AWS::DataSync::LocationHDFS", - "time": "2023-12-28T17:58:01.868Z", + "time": "2024-06-07T18:51:53.925Z", "schema": { "additionalProperties": false, "definitions": { diff --git a/artifacts/types/AWS::DataSync::LocationNFS.json b/artifacts/types/AWS::DataSync::LocationNFS.json index 1de0df4c..3f9a08e9 100644 --- a/artifacts/types/AWS::DataSync::LocationNFS.json +++ b/artifacts/types/AWS::DataSync::LocationNFS.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-DataSync-LocationNFS", "type": "AWS::DataSync::LocationNFS", - "time": "2023-12-28T17:43:09.532Z", + "time": "2024-06-07T18:39:21.297Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::DataSync::LocationObjectStorage.json b/artifacts/types/AWS::DataSync::LocationObjectStorage.json index 3ff8d029..b249e2bc 100644 --- a/artifacts/types/AWS::DataSync::LocationObjectStorage.json +++ b/artifacts/types/AWS::DataSync::LocationObjectStorage.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-DataSync-LocationObjectStorage", "type": "AWS::DataSync::LocationObjectStorage", - "time": "2023-12-28T17:51:03.667Z", + "time": "2024-06-07T18:45:54.258Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::DataSync::LocationS3.json b/artifacts/types/AWS::DataSync::LocationS3.json index 4b766da7..f63d8db5 100644 --- a/artifacts/types/AWS::DataSync::LocationS3.json +++ b/artifacts/types/AWS::DataSync::LocationS3.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-DataSync-LocationS3", "type": "AWS::DataSync::LocationS3", - "time": "2023-12-28T17:40:10.944Z", + "time": "2024-06-07T18:36:14.077Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::DataSync::LocationSMB.json b/artifacts/types/AWS::DataSync::LocationSMB.json index 4d1be8bd..e8fe077b 100644 --- a/artifacts/types/AWS::DataSync::LocationSMB.json +++ b/artifacts/types/AWS::DataSync::LocationSMB.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-DataSync-LocationSMB", "type": "AWS::DataSync::LocationSMB", - "time": "2023-12-28T17:47:07.085Z", + "time": "2024-06-07T18:42:14.619Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::DataSync::StorageSystem.json b/artifacts/types/AWS::DataSync::StorageSystem.json index 65d2b5a9..b28425a4 100644 --- a/artifacts/types/AWS::DataSync::StorageSystem.json +++ b/artifacts/types/AWS::DataSync::StorageSystem.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-DataSync-StorageSystem", "type": "AWS::DataSync::StorageSystem", - "time": "2023-11-13T17:07:14.968Z", + "time": "2024-06-19T17:24:04.817Z", "schema": { "additionalProperties": false, "definitions": { diff --git a/artifacts/types/AWS::DataSync::Task.json b/artifacts/types/AWS::DataSync::Task.json index d182b078..cc43e8fb 100644 --- a/artifacts/types/AWS::DataSync::Task.json +++ b/artifacts/types/AWS::DataSync::Task.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-DataSync-Task", "type": "AWS::DataSync::Task", - "time": "2023-12-28T17:31:26.209Z", + "time": "2024-06-07T18:30:20.429Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -41,6 +41,71 @@ }, "type": "object" }, + "ManifestConfig": { + "additionalProperties": false, + "description": "Configures a manifest, which is a list of files or objects that you want DataSync to transfer.", + "properties": { + "Action": { + "description": "Specifies what DataSync uses the manifest for.", + "enum": [ + "TRANSFER" + ], + "type": "string" + }, + "Format": { + "description": "Specifies the file format of your manifest.", + "enum": [ + "CSV" + ], + "type": "string" + }, + "Source": { + "additionalProperties": false, + "description": "Specifies the manifest that you want DataSync to use and where it's hosted.", + "properties": { + "S3": { + "$ref": "#/definitions/ManifestConfigSourceS3" + } + }, + "type": "object" + } + }, + "required": [ + "Source" + ], + "type": "object" + }, + "ManifestConfigSourceS3": { + "additionalProperties": false, + "description": "Specifies the S3 bucket where you're hosting the manifest that you want AWS DataSync to use.", + "properties": { + "BucketAccessRoleArn": { + "description": "Specifies the AWS Identity and Access Management (IAM) role that allows DataSync to access your manifest.", + "maxLength": 2048, + "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*$", + "type": "string" + }, + "ManifestObjectPath": { + "description": "Specifies the Amazon S3 object key of your manifest.", + "maxLength": 1024, + "pattern": "^[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}\\p{C}]*$", + "type": "string" + }, + "ManifestObjectVersionId": { + "description": "Specifies the object version ID of the manifest that you want DataSync to use.", + "maxLength": 100, + "pattern": "^.+$", + "type": "string" + }, + "S3BucketArn": { + "description": "Specifies the Amazon Resource Name (ARN) of the S3 bucket where you're hosting your manifest.", + "maxLength": 156, + "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):(s3|s3-outposts):[a-z\\-0-9]*:[0-9]*:.*$", + "type": "string" + } + }, + "type": "object" + }, "Options": { "additionalProperties": false, "description": "Represents the options that are available to control the behavior of a StartTaskExecution operation.", @@ -217,29 +282,7 @@ "description": "Specifies where DataSync uploads your task report.", "properties": { "S3": { - "additionalProperties": false, - "description": "Specifies the Amazon S3 bucket where DataSync uploads your task report.", - "properties": { - "BucketAccessRoleArn": { - "description": "Specifies the Amazon Resource Name (ARN) of the IAM policy that allows Datasync to upload a task report to your S3 bucket.", - "maxLength": 2048, - "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*$", - "type": "string" - }, - "S3BucketArn": { - "description": "Specifies the ARN of the S3 bucket where Datasync uploads your report.", - "maxLength": 156, - "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):(s3|s3-outposts):[a-z\\-0-9]*:[0-9]*:.*$", - "type": "string" - }, - "Subdirectory": { - "description": "Specifies a bucket prefix for your report.", - "maxLength": 4096, - "pattern": "^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\p{Zs}]*$", - "type": "string" - } - }, - "type": "object" + "$ref": "#/definitions/TaskReportConfigDestinationS3" } }, "type": "object" @@ -342,6 +385,31 @@ ], "type": "object" }, + "TaskReportConfigDestinationS3": { + "additionalProperties": false, + "description": "Specifies the Amazon S3 bucket where DataSync uploads your task report.", + "properties": { + "BucketAccessRoleArn": { + "description": "Specifies the Amazon Resource Name (ARN) of the IAM policy that allows Datasync to upload a task report to your S3 bucket.", + "maxLength": 2048, + "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*$", + "type": "string" + }, + "S3BucketArn": { + "description": "Specifies the ARN of the S3 bucket where Datasync uploads your report.", + "maxLength": 156, + "pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):(s3|s3-outposts):[a-z\\-0-9]*:[0-9]*:.*$", + "type": "string" + }, + "Subdirectory": { + "description": "Specifies a bucket prefix for your report.", + "maxLength": 4096, + "pattern": "^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\p{Zs}]*$", + "type": "string" + } + }, + "type": "object" + }, "TaskSchedule": { "additionalProperties": false, "description": "Specifies the schedule you want your task to use for repeated executions.", @@ -351,11 +419,16 @@ "maxLength": 256, "pattern": "^[a-zA-Z0-9\\ \\_\\*\\?\\,\\|\\^\\-\\/\\#\\s\\(\\)\\+]*$", "type": "string" + }, + "Status": { + "description": "Specifies status of a schedule.", + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" } }, - "required": [ - "ScheduleExpression" - ], "type": "object" } }, @@ -369,6 +442,8 @@ "datasync:TagResource", "s3:ListAllMyBuckets", "s3:ListBucket", + "s3:GetObject", + "s3:GetObjectVersion", "ec2:DescribeNetworkInterfaces", "ec2:CreateNetworkInterface", "ec2:DeleteNetworkInterface", @@ -457,6 +532,9 @@ "minItems": 0, "type": "array" }, + "ManifestConfig": { + "$ref": "#/definitions/ManifestConfig" + }, "Name": { "description": "The name of a task. This value is a text reference that is used to identify the task in the console.", "maxLength": 256, diff --git a/artifacts/types/AWS::DataZone::DataSource.json b/artifacts/types/AWS::DataZone::DataSource.json new file mode 100644 index 00000000..f7148124 --- /dev/null +++ b/artifacts/types/AWS::DataZone::DataSource.json @@ -0,0 +1,548 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-DataZone-DataSource", + "type": "AWS::DataZone::DataSource", + "time": "2024-06-22T05:19:16.713Z", + "schema": { + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/EnvironmentIdentifier", + "/properties/DomainIdentifier", + "/properties/ProjectIdentifier", + "/properties/Type" + ], + "definitions": { + "AccountId": { + "maxLength": 12, + "minLength": 12, + "pattern": "^\\d{12}$", + "type": "string" + }, + "DataAccessRole": { + "description": "The data access role included in the configuration details of the AWS Glue data source.", + "pattern": "^arn:aws[^:]*:iam::\\d{12}:(role|role/service-role)/[\\w+=,.@-]{1,128}$", + "type": "string" + }, + "DataSourceConfigurationInput": { + "description": "Specifies the configuration of the data source. It can be set to either glueRunConfiguration or redshiftRunConfiguration.", + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "GlueRunConfiguration": { + "$ref": "#/definitions/GlueRunConfigurationInput" + } + }, + "title": "GlueRunConfiguration", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "RedshiftRunConfiguration": { + "$ref": "#/definitions/RedshiftRunConfigurationInput" + } + }, + "title": "RedshiftRunConfiguration", + "type": "object" + } + ] + }, + "DataSourceStatus": { + "description": "The status of the data source.", + "enum": [ + "CREATING", + "FAILED_CREATION", + "READY", + "UPDATING", + "FAILED_UPDATE", + "RUNNING", + "DELETING", + "FAILED_DELETION" + ], + "type": "string" + }, + "EnableSetting": { + "description": "Specifies whether the data source is enabled.", + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + }, + "FilterExpression": { + "additionalProperties": false, + "description": "The search filter expression.", + "properties": { + "Expression": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Type": { + "$ref": "#/definitions/FilterExpressionType" + } + }, + "required": [ + "Expression", + "Type" + ], + "type": "object" + }, + "FilterExpressionType": { + "description": "The search filter expression type.", + "enum": [ + "INCLUDE", + "EXCLUDE" + ], + "type": "string" + }, + "FormInput": { + "additionalProperties": false, + "description": "The details of a metadata form.", + "properties": { + "Content": { + "description": "The content of the metadata form.", + "maxLength": 75000, + "type": "string" + }, + "FormName": { + "$ref": "#/definitions/FormName", + "description": "The name of the metadata form." + }, + "TypeIdentifier": { + "description": "The ID of the metadata form type.", + "maxLength": 385, + "minLength": 1, + "pattern": "^(?!\\.)[\\w\\.]*\\w$", + "type": "string" + }, + "TypeRevision": { + "$ref": "#/definitions/TypeRevision", + "description": "The revision of the metadata form type." + } + }, + "required": [ + "FormName" + ], + "type": "object" + }, + "FormName": { + "description": "The name of the metadata form.", + "maxLength": 128, + "minLength": 1, + "pattern": "^(?![0-9_])\\w+$|^_\\w*[a-zA-Z0-9]\\w*$", + "type": "string" + }, + "GlueRunConfigurationInput": { + "additionalProperties": false, + "properties": { + "AutoImportDataQualityResult": { + "description": "Specifies whether to automatically import data quality metrics as part of the data source run.", + "type": "boolean" + }, + "DataAccessRole": { + "$ref": "#/definitions/DataAccessRole", + "description": "The data access role included in the configuration details of the AWS Glue data source." + }, + "RelationalFilterConfigurations": { + "description": "The relational filter configurations included in the configuration details of the AWS Glue data source.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/RelationalFilterConfiguration" + }, + "type": "array" + } + }, + "required": [ + "RelationalFilterConfigurations" + ], + "type": "object" + }, + "RecommendationConfiguration": { + "additionalProperties": false, + "description": "The recommendation to be updated as part of the UpdateDataSource action.", + "properties": { + "EnableBusinessNameGeneration": { + "description": "Specifies whether automatic business name generation is to be enabled or not as part of the recommendation configuration.", + "type": "boolean" + } + }, + "type": "object" + }, + "RedshiftClusterStorage": { + "additionalProperties": false, + "description": "The name of an Amazon Redshift cluster.", + "properties": { + "ClusterName": { + "description": "The name of an Amazon Redshift cluster.", + "maxLength": 63, + "minLength": 1, + "pattern": "^[0-9a-z].[a-z0-9\\-]*$", + "type": "string" + } + }, + "required": [ + "ClusterName" + ], + "type": "object" + }, + "RedshiftCredentialConfiguration": { + "additionalProperties": false, + "description": "The ARN of a secret manager for an Amazon Redshift cluster.", + "properties": { + "SecretManagerArn": { + "description": "The ARN of a secret manager for an Amazon Redshift cluster.", + "maxLength": 256, + "pattern": "^arn:aws[^:]*:secretsmanager:[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]:\\d{12}:secret:.*$", + "type": "string" + } + }, + "required": [ + "SecretManagerArn" + ], + "type": "object" + }, + "RedshiftRunConfigurationInput": { + "additionalProperties": false, + "description": "The configuration details of the Amazon Redshift data source.", + "properties": { + "DataAccessRole": { + "$ref": "#/definitions/DataAccessRole", + "description": "The data access role included in the configuration details of the Amazon Redshift data source." + }, + "RedshiftCredentialConfiguration": { + "$ref": "#/definitions/RedshiftCredentialConfiguration", + "description": "The details of the credentials required to access an Amazon Redshift cluster." + }, + "RedshiftStorage": { + "$ref": "#/definitions/RedshiftStorage", + "description": "The details of the Amazon Redshift storage as part of the configuration of an Amazon Redshift data source run." + }, + "RelationalFilterConfigurations": { + "$ref": "#/definitions/RelationalFilterConfigurations" + } + }, + "required": [ + "RedshiftCredentialConfiguration", + "RedshiftStorage", + "RelationalFilterConfigurations" + ], + "type": "object" + }, + "RedshiftServerlessStorage": { + "additionalProperties": false, + "description": "The details of the Amazon Redshift Serverless workgroup storage.", + "properties": { + "WorkgroupName": { + "description": "The name of the Amazon Redshift Serverless workgroup.", + "maxLength": 64, + "minLength": 3, + "pattern": "^[a-z0-9-]+$", + "type": "string" + } + }, + "required": [ + "WorkgroupName" + ], + "type": "object" + }, + "RedshiftStorage": { + "description": "The details of the Amazon Redshift storage as part of the configuration of an Amazon Redshift data source run.", + "oneOf": [ + { + "additionalProperties": false, + "description": "The details of the Amazon Redshift cluster source.", + "properties": { + "RedshiftClusterSource": { + "$ref": "#/definitions/RedshiftClusterStorage" + } + }, + "required": [ + "RedshiftClusterSource" + ], + "title": "RedshiftClusterSource", + "type": "object" + }, + { + "additionalProperties": false, + "description": "The details of the Amazon Redshift Serverless workgroup source.", + "properties": { + "RedshiftServerlessSource": { + "$ref": "#/definitions/RedshiftServerlessStorage" + } + }, + "required": [ + "RedshiftServerlessSource" + ], + "title": "RedshiftServerlessSource", + "type": "object" + } + ] + }, + "Region": { + "maxLength": 16, + "minLength": 4, + "pattern": "[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]", + "type": "string" + }, + "RelationalFilterConfiguration": { + "additionalProperties": false, + "description": "The relational filter configuration for the data source.", + "properties": { + "DatabaseName": { + "description": "The database name specified in the relational filter configuration for the data source.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "FilterExpressions": { + "description": "The filter expressions specified in the relational filter configuration for the data source.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/FilterExpression" + }, + "type": "array" + }, + "SchemaName": { + "description": "The schema name specified in the relational filter configuration for the data source.", + "maxLength": 128, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "DatabaseName" + ], + "type": "object" + }, + "RelationalFilterConfigurations": { + "description": "The relational filter configurations included in the configuration details of the Amazon Redshift data source.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/RelationalFilterConfiguration" + }, + "type": "array" + }, + "ScheduleConfiguration": { + "additionalProperties": false, + "description": "The schedule of the data source runs.", + "properties": { + "Schedule": { + "description": "The schedule of the data source runs.", + "maxLength": 256, + "minLength": 1, + "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}\\)", + "type": "string" + }, + "Timezone": { + "$ref": "#/definitions/Timezone", + "description": "The timezone of the data source run." + } + }, + "type": "object" + }, + "Timezone": { + "type": "string" + }, + "TypeRevision": { + "description": "The revision of the metadata form type.", + "maxLength": 64, + "minLength": 1, + "type": "string" + } + }, + "description": "A data source is used to import technical metadata of assets (data) from the source databases or data warehouses into Amazon DataZone. ", + "handlers": { + "create": { + "permissions": [ + "datazone:CreateDataSource", + "iam:PassRole", + "datazone:GetDataSource", + "datazone:DeleteDataSource" + ] + }, + "delete": { + "permissions": [ + "datazone:DeleteDataSource", + "datazone:GetDataSource" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "DomainIdentifier": { + "$ref": "resource-schema.json#/properties/DomainIdentifier" + }, + "ProjectIdentifier": { + "$ref": "resource-schema.json#/properties/ProjectIdentifier" + } + }, + "required": [ + "DomainIdentifier" + ] + }, + "permissions": [ + "datazone:ListDataSources" + ] + }, + "read": { + "permissions": [ + "datazone:GetDataSource" + ] + }, + "update": { + "permissions": [ + "datazone:UpdateDataSource", + "datazone:GetDataSource", + "datazone:DeleteDataSource" + ] + } + }, + "primaryIdentifier": [ + "/properties/DomainId", + "/properties/Id" + ], + "properties": { + "AssetFormsInput": { + "description": "The metadata forms that are to be attached to the assets that this data source works with.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/FormInput" + }, + "maxItems": 10, + "minItems": 0, + "type": "array" + }, + "Configuration": { + "$ref": "#/definitions/DataSourceConfigurationInput", + "description": "Configuration of the data source. It can be set to either glueRunConfiguration or redshiftRunConfiguration." + }, + "CreatedAt": { + "description": "The timestamp of when the data source was created.", + "format": "date-time", + "type": "string" + }, + "Description": { + "description": "The description of the data source.", + "maxLength": 2048, + "type": "string" + }, + "DomainId": { + "description": "The ID of the Amazon DataZone domain where the data source is created.", + "pattern": "^dzd[-_][a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "DomainIdentifier": { + "description": "The ID of the Amazon DataZone domain where the data source is created.", + "pattern": "^dzd[-_][a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "EnableSetting": { + "$ref": "#/definitions/EnableSetting", + "description": "Specifies whether the data source is enabled." + }, + "EnvironmentId": { + "description": "The unique identifier of the Amazon DataZone environment to which the data source publishes assets.", + "pattern": "^[a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "EnvironmentIdentifier": { + "description": "The unique identifier of the Amazon DataZone environment to which the data source publishes assets.", + "type": "string" + }, + "Id": { + "description": "The unique identifier of the data source.", + "pattern": "^[a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "LastRunAssetCount": { + "description": "The number of assets created by the data source during its last run.", + "type": "number" + }, + "LastRunAt": { + "description": "The timestamp that specifies when the data source was last run.", + "type": "string" + }, + "LastRunStatus": { + "description": "The status of the last run of this data source.", + "type": "string" + }, + "Name": { + "description": "The name of the data source.", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "ProjectId": { + "description": "The ID of the Amazon DataZone project to which the data source is added.", + "pattern": "^[a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "ProjectIdentifier": { + "description": "The identifier of the Amazon DataZone project in which you want to add the data source.", + "type": "string" + }, + "PublishOnImport": { + "description": "Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog.", + "type": "boolean" + }, + "Recommendation": { + "$ref": "#/definitions/RecommendationConfiguration", + "description": "Specifies whether the business name generation is to be enabled for this data source." + }, + "Schedule": { + "$ref": "#/definitions/ScheduleConfiguration", + "description": "The schedule of the data source runs." + }, + "Status": { + "$ref": "#/definitions/DataSourceStatus", + "description": "The status of the data source." + }, + "Type": { + "description": "The type of the data source.", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "UpdatedAt": { + "description": "The timestamp of when this data source was updated.", + "format": "date-time", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/CreatedAt", + "/properties/DomainId", + "/properties/EnvironmentId", + "/properties/Id", + "/properties/LastRunAssetCount", + "/properties/LastRunAt", + "/properties/LastRunStatus", + "/properties/ProjectId", + "/properties/Status", + "/properties/UpdatedAt" + ], + "required": [ + "Name", + "DomainIdentifier", + "ProjectIdentifier", + "EnvironmentIdentifier", + "Type" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-datazone", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::DataZone::DataSource", + "writeOnlyProperties": [ + "/properties/AssetFormsInput", + "/properties/EnvironmentIdentifier", + "/properties/DomainIdentifier", + "/properties/Configuration", + "/properties/ProjectIdentifier" + ] + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::DataZone::Domain.json b/artifacts/types/AWS::DataZone::Domain.json new file mode 100644 index 00000000..f43d9ed7 --- /dev/null +++ b/artifacts/types/AWS::DataZone::Domain.json @@ -0,0 +1,214 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-DataZone-Domain", + "type": "AWS::DataZone::Domain", + "time": "2024-06-22T04:31:48.486Z", + "schema": { + "additionalIdentifiers": [ + [ + "/properties/Name" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/KmsKeyIdentifier" + ], + "definitions": { + "AuthType": { + "description": "The type of single sign-on in Amazon DataZone.", + "enum": [ + "IAM_IDC", + "DISABLED" + ], + "type": "string" + }, + "DomainStatus": { + "description": "The status of the Amazon DataZone domain.", + "enum": [ + "CREATING", + "AVAILABLE", + "CREATION_FAILED", + "DELETING", + "DELETED", + "DELETION_FAILED" + ], + "type": "string" + }, + "SingleSignOn": { + "additionalProperties": false, + "description": "The single-sign on configuration of the Amazon DataZone domain.", + "properties": { + "Type": { + "$ref": "#/definitions/AuthType" + }, + "UserAssignment": { + "$ref": "#/definitions/UserAssignment" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with the domain.", + "properties": { + "Key": { + "description": "The key name of the tag.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "UserAssignment": { + "description": "The single sign-on user assignment in Amazon DataZone.", + "enum": [ + "AUTOMATIC", + "MANUAL" + ], + "type": "string" + } + }, + "description": "A domain is an organizing entity for connecting together assets, users, and their projects", + "handlers": { + "create": { + "permissions": [ + "datazone:CreateDomain", + "datazone:UpdateDomain", + "datazone:GetDomain", + "datazone:TagResource", + "sso:CreateManagedApplicationInstance", + "sso:DeleteManagedApplicationInstance", + "sso:PutApplicationAssignmentConfiguration" + ] + }, + "delete": { + "permissions": [ + "datazone:DeleteDomain", + "datazone:GetDomain" + ] + }, + "list": { + "permissions": [ + "datazone:ListDomains" + ] + }, + "read": { + "permissions": [ + "datazone:GetDomain" + ] + }, + "update": { + "permissions": [ + "datazone:UpdateDomain", + "datazone:GetDomain", + "datazone:TagResource", + "datazone:UntagResource", + "sso:CreateManagedApplicationInstance", + "sso:DeleteManagedApplicationInstance", + "sso:PutApplicationAssignmentConfiguration" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "description": "The ARN of the Amazon DataZone domain.", + "pattern": "^arn:aws(|-cn|-us-gov):datazone:\\w+(?:-\\w+)+:\\d{12}:domain/dzd[-_][a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "CreatedAt": { + "description": "The timestamp of when the Amazon DataZone domain was last updated.", + "format": "date-time", + "type": "string" + }, + "Description": { + "description": "The description of the Amazon DataZone domain.", + "type": "string" + }, + "DomainExecutionRole": { + "description": "The domain execution role that is created when an Amazon DataZone domain is created. The domain execution role is created in the AWS account that houses the Amazon DataZone domain.", + "pattern": "^arn:aws[^:]*:iam::\\d{12}:(role|role/service-role)/[\\w+=,.@-]*$", + "type": "string" + }, + "Id": { + "description": "The id of the Amazon DataZone domain.", + "pattern": "^dzd[-_][a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "KmsKeyIdentifier": { + "description": "The identifier of the AWS Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data.", + "maxLength": 1024, + "minLength": 1, + "pattern": "^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$", + "type": "string" + }, + "LastUpdatedAt": { + "description": "The timestamp of when the Amazon DataZone domain was last updated.", + "format": "date-time", + "type": "string" + }, + "ManagedAccountId": { + "description": "The identifier of the AWS account that manages the domain.", + "type": "string" + }, + "Name": { + "description": "The name of the Amazon DataZone domain.", + "type": "string" + }, + "PortalUrl": { + "description": "The URL of the data portal for this Amazon DataZone domain.", + "type": "string" + }, + "SingleSignOn": { + "$ref": "#/definitions/SingleSignOn", + "description": "The single-sign on configuration of the Amazon DataZone domain." + }, + "Status": { + "$ref": "#/definitions/DomainStatus", + "description": "The status of the Amazon DataZone domain." + }, + "Tags": { + "description": "The tags specified for the Amazon DataZone domain.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/CreatedAt", + "/properties/Id", + "/properties/LastUpdatedAt", + "/properties/ManagedAccountId", + "/properties/PortalUrl", + "/properties/Status" + ], + "required": [ + "DomainExecutionRole", + "Name" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::DataZone::Domain" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::DataZone::Environment.json b/artifacts/types/AWS::DataZone::Environment.json new file mode 100644 index 00000000..51fded82 --- /dev/null +++ b/artifacts/types/AWS::DataZone::Environment.json @@ -0,0 +1,241 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-DataZone-Environment", + "type": "AWS::DataZone::Environment", + "time": "2024-06-22T04:59:56.919Z", + "schema": { + "additionalIdentifiers": [ + [ + "/properties/DomainIdentifier" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DomainIdentifier", + "/properties/EnvironmentProfileIdentifier", + "/properties/ProjectIdentifier", + "/properties/UserParameters" + ], + "definitions": { + "EnvironmentParameter": { + "additionalProperties": false, + "description": "The parameter details of an environment.", + "properties": { + "Name": { + "description": "The name of an environment parameter.", + "type": "string" + }, + "Value": { + "description": "The value of an environment parameter.", + "type": "string" + } + }, + "type": "object" + }, + "EnvironmentStatus": { + "description": "The status of the Amazon DataZone environment.", + "enum": [ + "ACTIVE", + "CREATING", + "UPDATING", + "DELETING", + "CREATE_FAILED", + "UPDATE_FAILED", + "DELETE_FAILED", + "VALIDATION_FAILED", + "SUSPENDED", + "DISABLED", + "EXPIRED", + "DELETED", + "INACCESSIBLE" + ], + "type": "string" + } + }, + "description": "Definition of AWS::DataZone::Environment Resource Type", + "handlers": { + "create": { + "permissions": [ + "datazone:CreateEnvironment", + "datazone:GetEnvironment", + "datazone:DeleteEnvironment" + ] + }, + "delete": { + "permissions": [ + "datazone:DeleteEnvironment", + "datazone:GetEnvironment" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "DomainIdentifier": { + "$ref": "resource-schema.json#/properties/DomainIdentifier" + }, + "ProjectIdentifier": { + "$ref": "resource-schema.json#/properties/ProjectIdentifier" + } + }, + "required": [ + "DomainIdentifier", + "ProjectIdentifier" + ] + }, + "permissions": [ + "datazone:ListEnvironments" + ] + }, + "read": { + "permissions": [ + "datazone:GetEnvironment" + ] + }, + "update": { + "permissions": [ + "datazone:UpdateEnvironment", + "datazone:GetEnvironment", + "datazone:DeleteEnvironment" + ] + } + }, + "primaryIdentifier": [ + "/properties/DomainId", + "/properties/Id" + ], + "properties": { + "AwsAccountId": { + "description": "The AWS account in which the Amazon DataZone environment is created.", + "pattern": "^\\d{12}$", + "type": "string" + }, + "AwsAccountRegion": { + "description": "The AWS region in which the Amazon DataZone environment is created.", + "pattern": "^[a-z]{2}-[a-z]{4,10}-\\d$", + "type": "string" + }, + "CreatedAt": { + "description": "The timestamp of when the environment was created.", + "format": "date-time", + "type": "string" + }, + "CreatedBy": { + "description": "The Amazon DataZone user who created the environment.", + "type": "string" + }, + "Description": { + "description": "The description of the Amazon DataZone environment.", + "maxLength": 2048, + "type": "string" + }, + "DomainId": { + "description": "The identifier of the Amazon DataZone domain in which the environment is created.", + "pattern": "^dzd[-_][a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "DomainIdentifier": { + "description": "The identifier of the Amazon DataZone domain in which the environment would be created.", + "pattern": "^dzd[-_][a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "EnvironmentBlueprintId": { + "description": "The ID of the blueprint with which the Amazon DataZone environment was created.", + "pattern": "^[a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "EnvironmentProfileId": { + "description": "The ID of the environment profile with which the Amazon DataZone environment was created.", + "pattern": "^[a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "EnvironmentProfileIdentifier": { + "description": "The ID of the environment profile with which the Amazon DataZone environment would be created.", + "pattern": "^[a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "GlossaryTerms": { + "description": "The glossary terms that can be used in the Amazon DataZone environment.", + "insertionOrder": false, + "items": { + "pattern": "^[a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "maxItems": 20, + "minItems": 1, + "type": "array" + }, + "Id": { + "description": "The ID of the Amazon DataZone environment.", + "pattern": "^[a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "Name": { + "description": "The name of the environment.", + "maxLength": 64, + "minLength": 1, + "pattern": "^[\\w -]+$", + "type": "string" + }, + "ProjectId": { + "description": "The ID of the Amazon DataZone project in which the environment is created.", + "pattern": "^[a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "ProjectIdentifier": { + "description": "The ID of the Amazon DataZone project in which the environment would be created.", + "pattern": "^[a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "Provider": { + "description": "The provider of the Amazon DataZone environment.", + "type": "string" + }, + "Status": { + "$ref": "#/definitions/EnvironmentStatus", + "description": "The status of the Amazon DataZone environment." + }, + "UpdatedAt": { + "description": "The timestamp of when the environment was updated.", + "format": "date-time", + "type": "string" + }, + "UserParameters": { + "description": "The user parameters of the Amazon DataZone environment.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/EnvironmentParameter" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/AwsAccountId", + "/properties/AwsAccountRegion", + "/properties/CreatedAt", + "/properties/CreatedBy", + "/properties/DomainId", + "/properties/EnvironmentBlueprintId", + "/properties/EnvironmentProfileId", + "/properties/Id", + "/properties/ProjectId", + "/properties/Provider", + "/properties/Status", + "/properties/UpdatedAt" + ], + "required": [ + "EnvironmentProfileIdentifier", + "Name", + "ProjectIdentifier", + "DomainIdentifier" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-datazone", + "tagging": { + "taggable": false + }, + "typeName": "AWS::DataZone::Environment", + "writeOnlyProperties": [ + "/properties/EnvironmentProfileIdentifier", + "/properties/ProjectIdentifier", + "/properties/DomainIdentifier" + ] + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::DataZone::EnvironmentBlueprintConfiguration.json b/artifacts/types/AWS::DataZone::EnvironmentBlueprintConfiguration.json new file mode 100644 index 00000000..4e16edd8 --- /dev/null +++ b/artifacts/types/AWS::DataZone::EnvironmentBlueprintConfiguration.json @@ -0,0 +1,164 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-DataZone-EnvironmentBlueprintConfiguration", + "type": "AWS::DataZone::EnvironmentBlueprintConfiguration", + "time": "2024-06-22T04:33:02.282Z", + "schema": { + "additionalIdentifiers": [ + [ + "/properties/DomainIdentifier", + "/properties/EnvironmentBlueprintIdentifier" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DomainIdentifier", + "/properties/EnvironmentBlueprintIdentifier" + ], + "definitions": { + "Parameter": { + "additionalProperties": false, + "patternProperties": { + ".+": { + "type": "string" + } + }, + "type": "object" + }, + "RegionalParameter": { + "additionalProperties": false, + "properties": { + "Parameters": { + "$ref": "#/definitions/Parameter" + }, + "Region": { + "pattern": "^[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]$", + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Definition of AWS::DataZone::EnvironmentBlueprintConfiguration Resource Type", + "handlers": { + "create": { + "permissions": [ + "datazone:ListEnvironmentBlueprints", + "iam:PassRole", + "datazone:GetEnvironmentBlueprintConfiguration", + "datazone:PutEnvironmentBlueprintConfiguration" + ] + }, + "delete": { + "permissions": [ + "datazone:GetEnvironmentBlueprintConfiguration", + "datazone:DeleteEnvironmentBlueprintConfiguration" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "DomainIdentifier": { + "$ref": "resource-schema.json#/properties/DomainIdentifier" + } + }, + "required": [ + "DomainIdentifier" + ] + }, + "permissions": [ + "datazone:ListEnvironmentBlueprintConfigurations" + ] + }, + "read": { + "permissions": [ + "datazone:GetEnvironmentBlueprintConfiguration" + ] + }, + "update": { + "permissions": [ + "datazone:DeleteEnvironmentBlueprintConfiguration", + "iam:PassRole", + "datazone:GetEnvironmentBlueprintConfiguration", + "datazone:PutEnvironmentBlueprintConfiguration" + ] + } + }, + "primaryIdentifier": [ + "/properties/DomainId", + "/properties/EnvironmentBlueprintId" + ], + "properties": { + "CreatedAt": { + "format": "date-time", + "type": "string" + }, + "DomainId": { + "pattern": "^dzd[-_][a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "DomainIdentifier": { + "pattern": "^dzd[-_][a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "EnabledRegions": { + "insertionOrder": false, + "items": { + "maxLength": 16, + "minLength": 4, + "pattern": "^[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]$", + "type": "string" + }, + "minItems": 0, + "type": "array" + }, + "EnvironmentBlueprintId": { + "pattern": "^[a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "EnvironmentBlueprintIdentifier": { + "pattern": "^[a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "ManageAccessRoleArn": { + "pattern": "^arn:aws[^:]*:iam::\\d{12}:(role|role/service-role)/[\\w+=,.@-]*$", + "type": "string" + }, + "ProvisioningRoleArn": { + "pattern": "^arn:aws[^:]*:iam::\\d{12}:(role|role/service-role)/[\\w+=,.@-]*$", + "type": "string" + }, + "RegionalParameters": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/RegionalParameter" + }, + "type": "array", + "uniqueItems": true + }, + "UpdatedAt": { + "format": "date-time", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/CreatedAt", + "/properties/DomainId", + "/properties/EnvironmentBlueprintId", + "/properties/UpdatedAt" + ], + "required": [ + "DomainIdentifier", + "EnvironmentBlueprintIdentifier", + "EnabledRegions" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-datazone", + "tagging": { + "taggable": false + }, + "typeName": "AWS::DataZone::EnvironmentBlueprintConfiguration", + "writeOnlyProperties": [ + "/properties/DomainIdentifier", + "/properties/EnvironmentBlueprintIdentifier" + ] + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::DataZone::EnvironmentProfile.json b/artifacts/types/AWS::DataZone::EnvironmentProfile.json new file mode 100644 index 00000000..4cfbd443 --- /dev/null +++ b/artifacts/types/AWS::DataZone::EnvironmentProfile.json @@ -0,0 +1,191 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-DataZone-EnvironmentProfile", + "type": "AWS::DataZone::EnvironmentProfile", + "time": "2024-06-22T04:34:13.494Z", + "schema": { + "additionalIdentifiers": [ + [ + "/properties/DomainIdentifier" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DomainIdentifier", + "/properties/EnvironmentBlueprintIdentifier", + "/properties/ProjectIdentifier" + ], + "definitions": { + "EnvironmentParameter": { + "additionalProperties": false, + "description": "The parameter details of an environment profile.", + "properties": { + "Name": { + "description": "The name of an environment profile parameter.", + "type": "string" + }, + "Value": { + "description": "The value of an environment profile parameter.", + "type": "string" + } + }, + "type": "object" + } + }, + "description": "AWS Datazone Environment Profile is pre-configured set of resources and blueprints that provide reusable templates for creating environments.", + "handlers": { + "create": { + "permissions": [ + "datazone:CreateEnvironmentProfile", + "datazone:GetEnvironmentProfile" + ] + }, + "delete": { + "permissions": [ + "datazone:DeleteEnvironmentProfile", + "datazone:GetEnvironmentProfile" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "DomainIdentifier": { + "$ref": "resource-schema.json#/properties/DomainIdentifier" + } + }, + "required": [ + "DomainIdentifier" + ] + }, + "permissions": [ + "datazone:ListEnvironmentProfiles" + ] + }, + "read": { + "permissions": [ + "datazone:GetEnvironmentProfile" + ] + }, + "update": { + "permissions": [ + "datazone:UpdateEnvironmentProfile", + "datazone:GetEnvironmentProfile" + ] + } + }, + "primaryIdentifier": [ + "/properties/DomainId", + "/properties/Id" + ], + "properties": { + "AwsAccountId": { + "description": "The AWS account in which the Amazon DataZone environment is created.", + "pattern": "^\\d{12}$", + "type": "string" + }, + "AwsAccountRegion": { + "description": "The AWS region in which this environment profile is created.", + "pattern": "^[a-z]{2}-[a-z]{4,10}-\\d$", + "type": "string" + }, + "CreatedAt": { + "description": "The timestamp of when this environment profile was created.", + "format": "date-time", + "type": "string" + }, + "CreatedBy": { + "description": "The Amazon DataZone user who created this environment profile.", + "type": "string" + }, + "Description": { + "description": "The description of this Amazon DataZone environment profile.", + "maxLength": 2048, + "type": "string" + }, + "DomainId": { + "description": "The ID of the Amazon DataZone domain in which this environment profile is created.", + "pattern": "^dzd[-_][a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "DomainIdentifier": { + "description": "The ID of the Amazon DataZone domain in which this environment profile is created.", + "pattern": "^dzd[-_][a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "EnvironmentBlueprintId": { + "description": "The ID of the blueprint with which this environment profile is created.", + "pattern": "^[a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "EnvironmentBlueprintIdentifier": { + "description": "The ID of the blueprint with which this environment profile is created.", + "pattern": "^[a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "Id": { + "description": "The ID of this Amazon DataZone environment profile.", + "pattern": "^[a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "Name": { + "description": "The name of this Amazon DataZone environment profile.", + "maxLength": 64, + "minLength": 1, + "pattern": "^[\\w -]+$", + "type": "string" + }, + "ProjectId": { + "description": "The identifier of the project in which to create the environment profile.", + "pattern": "^[a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "ProjectIdentifier": { + "description": "The identifier of the project in which to create the environment profile.", + "pattern": "^[a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "UpdatedAt": { + "description": "The timestamp of when this environment profile was updated.", + "format": "date-time", + "type": "string" + }, + "UserParameters": { + "description": "The user parameters of this Amazon DataZone environment profile.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/EnvironmentParameter" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/CreatedAt", + "/properties/CreatedBy", + "/properties/DomainId", + "/properties/EnvironmentBlueprintId", + "/properties/Id", + "/properties/ProjectId", + "/properties/UpdatedAt" + ], + "required": [ + "EnvironmentBlueprintIdentifier", + "ProjectIdentifier", + "DomainIdentifier", + "AwsAccountId", + "AwsAccountRegion", + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-datazone", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::DataZone::EnvironmentProfile", + "writeOnlyProperties": [ + "/properties/EnvironmentBlueprintIdentifier", + "/properties/ProjectIdentifier", + "/properties/DomainIdentifier" + ] + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::DataZone::GroupProfile.json b/artifacts/types/AWS::DataZone::GroupProfile.json new file mode 100644 index 00000000..6ec1c67c --- /dev/null +++ b/artifacts/types/AWS::DataZone::GroupProfile.json @@ -0,0 +1,134 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-DataZone-GroupProfile", + "type": "AWS::DataZone::GroupProfile", + "time": "2024-06-22T04:44:05.405Z", + "schema": { + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DomainIdentifier", + "/properties/GroupIdentifier" + ], + "definitions": { + "GroupProfileStatus": { + "description": "The status of the group profile.", + "enum": [ + "ASSIGNED", + "NOT_ASSIGNED" + ], + "type": "string" + } + }, + "description": "Group profiles represent groups of Amazon DataZone users. Groups can be manually created, or mapped to Active Directory groups of enterprise customers. In Amazon DataZone, groups serve two purposes. First, a group can map to a team of users in the organizational chart, and thus reduce the administrative work of a Amazon DataZone project owner when there are new employees joining or leaving a team. Second, corporate administrators use Active Directory groups to manage and update user statuses and so Amazon DataZone domain administrators can use these group memberships to implement Amazon DataZone domain policies.", + "handlers": { + "create": { + "permissions": [ + "datazone:CreateGroupProfile", + "datazone:GetGroupProfile", + "datazone:UpdateGroupProfile", + "sso:ListProfiles", + "sso:GetProfile", + "sso:AssociateProfile", + "sso:DisassociateProfile" + ] + }, + "delete": { + "permissions": [ + "datazone:DeleteGroupProfile", + "datazone:GetGroupProfile", + "datazone:UpdateGroupProfile", + "sso:ListProfiles", + "sso:GetProfile", + "sso:AssociateProfile", + "sso:DisassociateProfile" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "DomainIdentifier": { + "$ref": "resource-schema.json#/properties/DomainIdentifier" + } + }, + "required": [ + "DomainIdentifier" + ] + }, + "permissions": [ + "datazone:SearchGroupProfiles" + ] + }, + "read": { + "permissions": [ + "datazone:GetGroupProfile" + ] + }, + "update": { + "permissions": [ + "datazone:UpdateGroupProfile", + "datazone:GetGroupProfile", + "sso:ListProfiles", + "sso:GetProfile", + "sso:AssociateProfile", + "sso:DisassociateProfile" + ] + } + }, + "primaryIdentifier": [ + "/properties/DomainId", + "/properties/Id" + ], + "properties": { + "DomainId": { + "description": "The identifier of the Amazon DataZone domain in which the group profile is created.", + "pattern": "^dzd[-_][a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "DomainIdentifier": { + "description": "The identifier of the Amazon DataZone domain in which the group profile would be created.", + "pattern": "^dzd[-_][a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "GroupIdentifier": { + "description": "The ID of the group.", + "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 ]+)", + "type": "string" + }, + "GroupName": { + "description": "The group-name of the Group Profile.", + "maxLength": 1024, + "minLength": 1, + "pattern": "^[a-zA-Z_0-9+=,.@-]+$", + "type": "string" + }, + "Id": { + "description": "The ID of the Amazon DataZone group profile.", + "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}$", + "type": "string" + }, + "Status": { + "$ref": "#/definitions/GroupProfileStatus" + } + }, + "readOnlyProperties": [ + "/properties/DomainId", + "/properties/GroupName", + "/properties/Id" + ], + "required": [ + "DomainIdentifier", + "GroupIdentifier" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-datazone", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::DataZone::GroupProfile", + "writeOnlyProperties": [ + "/properties/DomainIdentifier", + "/properties/GroupIdentifier" + ] + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::DataZone::Project.json b/artifacts/types/AWS::DataZone::Project.json new file mode 100644 index 00000000..890c7dcb --- /dev/null +++ b/artifacts/types/AWS::DataZone::Project.json @@ -0,0 +1,138 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-DataZone-Project", + "type": "AWS::DataZone::Project", + "time": "2024-06-22T04:33:07.172Z", + "schema": { + "additionalIdentifiers": [ + [ + "/properties/DomainIdentifier" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DomainIdentifier" + ], + "definitions": {}, + "description": "Amazon DataZone projects are business use case?based groupings of people, assets (data), and tools used to simplify access to the AWS analytics.", + "handlers": { + "create": { + "permissions": [ + "datazone:CreateProject", + "datazone:GetProject" + ] + }, + "delete": { + "permissions": [ + "datazone:DeleteProject", + "datazone:GetProject" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "DomainIdentifier": { + "$ref": "resource-schema.json#/properties/DomainIdentifier" + } + }, + "required": [ + "DomainIdentifier" + ] + }, + "permissions": [ + "datazone:ListProjects" + ] + }, + "read": { + "permissions": [ + "datazone:GetProject" + ] + }, + "update": { + "permissions": [ + "datazone:UpdateProject", + "datazone:GetProject" + ] + } + }, + "primaryIdentifier": [ + "/properties/DomainId", + "/properties/Id" + ], + "properties": { + "CreatedAt": { + "description": "The timestamp of when the project was created.", + "format": "date-time", + "type": "string" + }, + "CreatedBy": { + "description": "The Amazon DataZone user who created the project.", + "type": "string" + }, + "Description": { + "description": "The description of the Amazon DataZone project.", + "maxLength": 2048, + "type": "string" + }, + "DomainId": { + "description": "The identifier of the Amazon DataZone domain in which the project was created.", + "pattern": "^dzd[-_][a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "DomainIdentifier": { + "description": "The ID of the Amazon DataZone domain in which this project is created.", + "pattern": "^dzd[-_][a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "GlossaryTerms": { + "description": "The glossary terms that can be used in this Amazon DataZone project.", + "insertionOrder": false, + "items": { + "pattern": "^[a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "maxItems": 20, + "minItems": 1, + "type": "array" + }, + "Id": { + "description": "The ID of the Amazon DataZone project.", + "pattern": "^[a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "LastUpdatedAt": { + "description": "The timestamp of when the project was last updated.", + "format": "date-time", + "type": "string" + }, + "Name": { + "description": "The name of the Amazon DataZone project.", + "maxLength": 64, + "minLength": 1, + "pattern": "^[\\w -]+$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/CreatedAt", + "/properties/CreatedBy", + "/properties/DomainId", + "/properties/LastUpdatedAt" + ], + "required": [ + "DomainIdentifier", + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-datazone", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::DataZone::Project", + "writeOnlyProperties": [ + "/properties/DomainIdentifier" + ] + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::DataZone::ProjectMembership.json b/artifacts/types/AWS::DataZone::ProjectMembership.json new file mode 100644 index 00000000..729cff83 --- /dev/null +++ b/artifacts/types/AWS::DataZone::ProjectMembership.json @@ -0,0 +1,143 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-DataZone-ProjectMembership", + "type": "AWS::DataZone::ProjectMembership", + "time": "2024-06-22T04:33:50.404Z", + "schema": { + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DomainIdentifier", + "/properties/ProjectIdentifier", + "/properties/Member" + ], + "definitions": { + "Member": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "UserIdentifier": { + "type": "string" + } + }, + "required": [ + "UserIdentifier" + ], + "title": "UserIdentifier", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "GroupIdentifier": { + "type": "string" + } + }, + "required": [ + "GroupIdentifier" + ], + "title": "GroupIdentifier", + "type": "object" + } + ] + }, + "MemberIdentifierType": { + "enum": [ + "USER_IDENTIFIER", + "GROUP_IDENTIFIER" + ], + "type": "string" + }, + "UserDesignation": { + "enum": [ + "PROJECT_OWNER", + "PROJECT_CONTRIBUTOR" + ], + "type": "string" + } + }, + "description": "Definition of AWS::DataZone::ProjectMembership Resource Type", + "handlers": { + "create": { + "permissions": [ + "datazone:CreateProjectMembership", + "datazone:ListProjectMemberships", + "iam:GetRole", + "datazone:GetGroupProfile", + "datazone:GetUserProfile" + ] + }, + "delete": { + "permissions": [ + "datazone:DeleteProjectMembership" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "DomainIdentifier": { + "$ref": "resource-schema.json#/properties/DomainIdentifier" + }, + "ProjectIdentifier": { + "$ref": "resource-schema.json#/properties/ProjectIdentifier" + } + }, + "required": [ + "DomainIdentifier", + "ProjectIdentifier" + ] + }, + "permissions": [ + "datazone:ListProjectMemberships" + ] + }, + "read": { + "permissions": [ + "datazone:ListProjectMemberships" + ] + }, + "update": { + "permissions": [ + "datazone:CreateProjectMembership", + "datazone:DeleteProjectMembership" + ] + } + }, + "primaryIdentifier": [ + "/properties/DomainIdentifier", + "/properties/MemberIdentifier", + "/properties/MemberIdentifierType", + "/properties/ProjectIdentifier" + ], + "properties": { + "Designation": { + "$ref": "#/definitions/UserDesignation" + }, + "DomainIdentifier": { + "pattern": "^dzd[-_][a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "Member": { + "$ref": "#/definitions/Member" + }, + "ProjectIdentifier": { + "pattern": "^[a-zA-Z0-9_-]{1,36}$", + "type": "string" + } + }, + "required": [ + "Designation", + "DomainIdentifier", + "ProjectIdentifier", + "Member" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-datazone", + "tagging": { + "taggable": false + }, + "typeName": "AWS::DataZone::ProjectMembership", + "writeOnlyProperties": [ + "/properties/Designation", + "/properties/Member" + ] + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::DataZone::SubscriptionTarget.json b/artifacts/types/AWS::DataZone::SubscriptionTarget.json new file mode 100644 index 00000000..075172d5 --- /dev/null +++ b/artifacts/types/AWS::DataZone::SubscriptionTarget.json @@ -0,0 +1,217 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-DataZone-SubscriptionTarget", + "type": "AWS::DataZone::SubscriptionTarget", + "time": "2024-06-22T04:37:31.609Z", + "schema": { + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Type", + "/properties/DomainIdentifier", + "/properties/EnvironmentIdentifier" + ], + "definitions": { + "SubscriptionTargetForm": { + "additionalProperties": false, + "description": "The details of the subscription target configuration.", + "properties": { + "Content": { + "description": "The content of the subscription target configuration.", + "type": "string" + }, + "FormName": { + "description": "The form name included in the subscription target configuration.", + "maxLength": 128, + "minLength": 1, + "pattern": "^(?![0-9_])\\w+$|^_\\w*[a-zA-Z0-9]\\w*$", + "type": "string" + } + }, + "required": [ + "Content", + "FormName" + ], + "type": "object" + } + }, + "description": "Subscription targets enables one to access the data to which you have subscribed in your projects.", + "handlers": { + "create": { + "permissions": [ + "datazone:CreateSubscriptionTarget", + "datazone:GetSubscriptionTarget", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "datazone:DeleteSubscriptionTarget" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "DomainIdentifier": { + "$ref": "resource-schema.json#/properties/DomainIdentifier" + }, + "EnvironmentIdentifier": { + "$ref": "resource-schema.json#/properties/EnvironmentIdentifier" + } + }, + "required": [ + "DomainIdentifier" + ] + }, + "permissions": [ + "datazone:ListSubscriptionTargets" + ] + }, + "read": { + "permissions": [ + "datazone:GetSubscriptionTarget" + ] + }, + "update": { + "permissions": [ + "datazone:UpdateSubscriptionTarget", + "datazone:GetSubscriptionTarget", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/DomainId", + "/properties/EnvironmentId", + "/properties/Id" + ], + "properties": { + "ApplicableAssetTypes": { + "description": "The asset types that can be included in the subscription target.", + "insertionOrder": false, + "items": { + "maxLength": 256, + "minLength": 1, + "pattern": "^[^\\.]*", + "type": "string" + }, + "type": "array" + }, + "AuthorizedPrincipals": { + "description": "The authorized principals of the subscription target.", + "insertionOrder": false, + "items": { + "pattern": "^[a-zA-Z0-9:/_-]*$", + "type": "string" + }, + "maxItems": 10, + "minItems": 1, + "type": "array" + }, + "CreatedAt": { + "description": "The timestamp of when the subscription target was created.", + "format": "date-time", + "type": "string" + }, + "CreatedBy": { + "description": "The Amazon DataZone user who created the subscription target.", + "type": "string" + }, + "DomainId": { + "description": "The ID of the Amazon DataZone domain in which subscription target is created.", + "pattern": "^dzd[-_][a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "DomainIdentifier": { + "description": "The ID of the Amazon DataZone domain in which subscription target would be created.", + "pattern": "^dzd[-_][a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "EnvironmentId": { + "description": "The ID of the environment in which subscription target is created.", + "pattern": "^[a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "EnvironmentIdentifier": { + "description": "The ID of the environment in which subscription target would be created.", + "pattern": "^[a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "Id": { + "description": "The ID of the subscription target.", + "pattern": "^[a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "ManageAccessRole": { + "description": "The manage access role that is used to create the subscription target.", + "type": "string" + }, + "Name": { + "description": "The name of the subscription target.", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "ProjectId": { + "description": "The identifier of the project specified in the subscription target.", + "pattern": "^[a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "Provider": { + "description": "The provider of the subscription target.", + "type": "string" + }, + "SubscriptionTargetConfig": { + "description": "The configuration of the subscription target.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/SubscriptionTargetForm" + }, + "type": "array" + }, + "Type": { + "description": "The type of the subscription target.", + "type": "string" + }, + "UpdatedAt": { + "description": "The timestamp of when the subscription target was updated.", + "format": "date-time", + "type": "string" + }, + "UpdatedBy": { + "description": "The Amazon DataZone user who updated the subscription target.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/CreatedAt", + "/properties/CreatedBy", + "/properties/DomainId", + "/properties/EnvironmentId", + "/properties/Id", + "/properties/ProjectId", + "/properties/UpdatedAt", + "/properties/UpdatedBy" + ], + "required": [ + "ApplicableAssetTypes", + "AuthorizedPrincipals", + "DomainIdentifier", + "EnvironmentIdentifier", + "ManageAccessRole", + "Name", + "SubscriptionTargetConfig", + "Type" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-datazone", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::DataZone::SubscriptionTarget", + "writeOnlyProperties": [ + "/properties/DomainIdentifier", + "/properties/EnvironmentIdentifier" + ] + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::DataZone::UserProfile.json b/artifacts/types/AWS::DataZone::UserProfile.json new file mode 100644 index 00000000..6272b36f --- /dev/null +++ b/artifacts/types/AWS::DataZone::UserProfile.json @@ -0,0 +1,232 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-DataZone-UserProfile", + "type": "AWS::DataZone::UserProfile", + "time": "2024-06-22T04:47:42.294Z", + "schema": { + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DomainIdentifier", + "/properties/UserIdentifier", + "/properties/UserType" + ], + "definitions": { + "IamUserProfileDetails": { + "additionalProperties": false, + "description": "The details of the IAM User Profile.", + "properties": { + "Arn": { + "description": "The ARN of the IAM User Profile.", + "type": "string" + } + }, + "type": "object" + }, + "SsoUserProfileDetails": { + "additionalProperties": false, + "description": "The details of the SSO User Profile.", + "properties": { + "FirstName": { + "description": "The First Name of the IAM User Profile.", + "type": "string" + }, + "LastName": { + "description": "The Last Name of the IAM User Profile.", + "type": "string" + }, + "Username": { + "description": "The username of the SSO User Profile.", + "maxLength": 1024, + "minLength": 1, + "pattern": "^[a-zA-Z_0-9+=,.@-]+$", + "type": "string" + } + }, + "type": "object" + }, + "UserProfileDetails": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "Iam": { + "$ref": "#/definitions/IamUserProfileDetails" + } + }, + "required": [ + "Iam" + ], + "title": "Iam", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "Sso": { + "$ref": "#/definitions/SsoUserProfileDetails" + } + }, + "required": [ + "Sso" + ], + "title": "Sso", + "type": "object" + } + ] + }, + "UserProfileStatus": { + "description": "The status of the user profile.", + "enum": [ + "ASSIGNED", + "NOT_ASSIGNED", + "ACTIVATED", + "DEACTIVATED" + ], + "type": "string" + }, + "UserProfileType": { + "description": "The type of the user profile.", + "enum": [ + "IAM", + "SSO" + ], + "type": "string" + }, + "UserType": { + "description": "The type of the user.", + "enum": [ + "IAM_USER", + "IAM_ROLE", + "SSO_USER" + ], + "type": "string" + } + }, + "description": "A user profile represents Amazon DataZone users. Amazon DataZone supports both IAM roles and SSO identities to interact with the Amazon DataZone Management Console and the data portal for different purposes. Domain administrators use IAM roles to perform the initial administrative domain-related work in the Amazon DataZone Management Console, including creating new Amazon DataZone domains, configuring metadata form types, and implementing policies. Data workers use their SSO corporate identities via Identity Center to log into the Amazon DataZone Data Portal and access projects where they have memberships.", + "handlers": { + "create": { + "permissions": [ + "datazone:CreateUserProfile", + "datazone:GetUserProfile", + "datazone:UpdateUserProfile", + "datazone:GetDomain", + "sso:ListProfiles", + "sso:GetProfile", + "sso:AssociateProfile", + "sso:DisassociateProfile", + "iam:GetRole", + "iam:GetUser" + ] + }, + "delete": { + "permissions": [ + "datazone:DeleteUserProfile", + "datazone:GetUserProfile", + "datazone:UpdateUserProfile", + "sso:ListProfiles", + "sso:GetProfile", + "sso:AssociateProfile", + "sso:DisassociateProfile", + "iam:GetRole", + "iam:GetUser" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "DomainIdentifier": { + "$ref": "resource-schema.json#/properties/DomainIdentifier" + }, + "UserType": { + "$ref": "resource-schema.json#/properties/UserType" + } + }, + "required": [ + "DomainIdentifier", + "UserType" + ] + }, + "permissions": [ + "datazone:SearchUserProfiles" + ] + }, + "read": { + "permissions": [ + "datazone:GetUserProfile" + ] + }, + "update": { + "permissions": [ + "datazone:UpdateUserProfile", + "datazone:GetUserProfile", + "datazone:UpdateUserProfile", + "sso:ListProfiles", + "sso:GetProfile", + "sso:AssociateProfile", + "sso:DisassociateProfile", + "iam:GetRole", + "iam:GetUser" + ] + } + }, + "primaryIdentifier": [ + "/properties/DomainId", + "/properties/Id" + ], + "properties": { + "Details": { + "$ref": "#/definitions/UserProfileDetails" + }, + "DomainId": { + "description": "The identifier of the Amazon DataZone domain in which the user profile is created.", + "pattern": "^dzd[-_][a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "DomainIdentifier": { + "description": "The identifier of the Amazon DataZone domain in which the user profile would be created.", + "pattern": "^dzd[-_][a-zA-Z0-9_-]{1,36}$", + "type": "string" + }, + "Id": { + "description": "The ID of the Amazon DataZone user profile.", + "type": "string" + }, + "Status": { + "$ref": "#/definitions/UserProfileStatus" + }, + "Type": { + "$ref": "#/definitions/UserProfileType" + }, + "UserIdentifier": { + "description": "The ID of the user.", + "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}:.+$)", + "type": "string" + }, + "UserType": { + "$ref": "#/definitions/UserType" + } + }, + "readOnlyProperties": [ + "/properties/DomainId", + "/properties/Type", + "/properties/Id", + "/properties/Details" + ], + "required": [ + "DomainIdentifier", + "UserIdentifier" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-datazone", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::DataZone::UserProfile", + "writeOnlyProperties": [ + "/properties/DomainIdentifier", + "/properties/UserIdentifier", + "/properties/UserType" + ] + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::Deadline::Farm.json b/artifacts/types/AWS::Deadline::Farm.json new file mode 100644 index 00000000..dfa418ff --- /dev/null +++ b/artifacts/types/AWS::Deadline::Farm.json @@ -0,0 +1,152 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Deadline-Farm", + "type": "AWS::Deadline::Farm", + "time": "2024-06-20T16:22:59.486Z", + "schema": { + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/KmsKeyArn" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 127, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Definition of AWS::Deadline::Farm Resource Type", + "handlers": { + "create": { + "permissions": [ + "deadline:CreateFarm", + "deadline:GetFarm", + "deadline:TagResource", + "deadline:ListTagsForResource", + "identitystore:ListGroupMembershipsForMember", + "kms:Encrypt", + "kms:Decrypt", + "kms:CreateGrant", + "kms:GenerateDataKey" + ] + }, + "delete": { + "permissions": [ + "deadline:DeleteFarm", + "deadline:GetFarm", + "identitystore:ListGroupMembershipsForMember", + "kms:Encrypt", + "kms:Decrypt", + "kms:CreateGrant", + "kms:GenerateDataKey" + ] + }, + "list": { + "permissions": [ + "deadline:ListFarms", + "identitystore:ListGroupMembershipsForMember" + ] + }, + "read": { + "permissions": [ + "deadline:GetFarm", + "deadline:ListTagsForResource", + "identitystore:ListGroupMembershipsForMember", + "kms:Encrypt", + "kms:Decrypt", + "kms:CreateGrant", + "kms:GenerateDataKey" + ] + }, + "update": { + "permissions": [ + "deadline:UpdateFarm", + "deadline:GetFarm", + "deadline:TagResource", + "deadline:UntagResource", + "deadline:ListTagsForResource", + "identitystore:ListGroupMembershipsForMember", + "kms:Encrypt", + "kms:Decrypt", + "kms:CreateGrant", + "kms:GenerateDataKey" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "pattern": "^arn:(aws[a-zA-Z-]*):deadline:[a-z0-9-]+:[0-9]+:farm/farm-[0-9a-z]{32}$", + "type": "string" + }, + "Description": { + "default": "", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "DisplayName": { + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "FarmId": { + "pattern": "^farm-[0-9a-f]{32}$", + "type": "string" + }, + "KmsKeyArn": { + "pattern": "^arn:aws[-a-z]*:kms:.*:key/.*", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/FarmId", + "/properties/Arn" + ], + "required": [ + "DisplayName" + ], + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "deadline:TagResource", + "deadline:UntagResource", + "deadline:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Deadline::Farm" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::Deadline::Fleet.json b/artifacts/types/AWS::Deadline::Fleet.json new file mode 100644 index 00000000..1e4207b5 --- /dev/null +++ b/artifacts/types/AWS::Deadline::Fleet.json @@ -0,0 +1,596 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Deadline-Fleet", + "type": "AWS::Deadline::Fleet", + "time": "2024-06-20T16:43:31.734Z", + "schema": { + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/FarmId" + ], + "definitions": { + "AcceleratorCountRange": { + "additionalProperties": false, + "properties": { + "Max": { + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "Min": { + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "Min" + ], + "type": "object" + }, + "AcceleratorTotalMemoryMiBRange": { + "additionalProperties": false, + "properties": { + "Max": { + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "Min": { + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "Min" + ], + "type": "object" + }, + "AcceleratorType": { + "enum": [ + "gpu" + ], + "type": "string" + }, + "AutoScalingMode": { + "enum": [ + "NO_SCALING", + "EVENT_BASED_AUTO_SCALING" + ], + "type": "string" + }, + "CpuArchitectureType": { + "enum": [ + "x86_64", + "arm64" + ], + "type": "string" + }, + "CustomerManagedFleetConfiguration": { + "additionalProperties": false, + "properties": { + "Mode": { + "$ref": "#/definitions/AutoScalingMode" + }, + "StorageProfileId": { + "pattern": "^sp-[0-9a-f]{32}$", + "type": "string" + }, + "WorkerCapabilities": { + "$ref": "#/definitions/CustomerManagedWorkerCapabilities" + } + }, + "required": [ + "Mode", + "WorkerCapabilities" + ], + "type": "object" + }, + "CustomerManagedFleetOperatingSystemFamily": { + "enum": [ + "WINDOWS", + "LINUX", + "MACOS" + ], + "type": "string" + }, + "CustomerManagedWorkerCapabilities": { + "additionalProperties": false, + "properties": { + "AcceleratorCount": { + "$ref": "#/definitions/AcceleratorCountRange" + }, + "AcceleratorTotalMemoryMiB": { + "$ref": "#/definitions/AcceleratorTotalMemoryMiBRange" + }, + "AcceleratorTypes": { + "items": { + "$ref": "#/definitions/AcceleratorType" + }, + "type": "array" + }, + "CpuArchitectureType": { + "$ref": "#/definitions/CpuArchitectureType" + }, + "CustomAmounts": { + "items": { + "$ref": "#/definitions/FleetAmountCapability" + }, + "maxItems": 15, + "minItems": 1, + "type": "array" + }, + "CustomAttributes": { + "items": { + "$ref": "#/definitions/FleetAttributeCapability" + }, + "maxItems": 15, + "minItems": 1, + "type": "array" + }, + "MemoryMiB": { + "$ref": "#/definitions/MemoryMiBRange" + }, + "OsFamily": { + "$ref": "#/definitions/CustomerManagedFleetOperatingSystemFamily" + }, + "VCpuCount": { + "$ref": "#/definitions/VCpuCountRange" + } + }, + "required": [ + "CpuArchitectureType", + "MemoryMiB", + "OsFamily", + "VCpuCount" + ], + "type": "object" + }, + "Ec2EbsVolume": { + "additionalProperties": false, + "properties": { + "Iops": { + "default": 3000, + "maximum": 16000, + "minimum": 3000, + "type": "integer" + }, + "SizeGiB": { + "default": 250, + "type": "integer" + }, + "ThroughputMiB": { + "default": 125, + "maximum": 1000, + "minimum": 125, + "type": "integer" + } + }, + "type": "object" + }, + "Ec2MarketType": { + "enum": [ + "on-demand", + "spot" + ], + "type": "string" + }, + "FleetAmountCapability": { + "additionalProperties": false, + "properties": { + "Max": { + "type": "number" + }, + "Min": { + "type": "number" + }, + "Name": { + "maxLength": 100, + "minLength": 1, + "pattern": "^([a-zA-Z][a-zA-Z0-9]{0,63}:)?amount(\\.[a-zA-Z][a-zA-Z0-9]{0,63})+$", + "type": "string" + } + }, + "required": [ + "Min", + "Name" + ], + "type": "object" + }, + "FleetAttributeCapability": { + "additionalProperties": false, + "properties": { + "Name": { + "maxLength": 100, + "minLength": 1, + "pattern": "^([a-zA-Z][a-zA-Z0-9]{0,63}:)?attr(\\.[a-zA-Z][a-zA-Z0-9]{0,63})+$", + "type": "string" + }, + "Values": { + "items": { + "maxLength": 100, + "minLength": 1, + "pattern": "^[a-zA-Z_]([a-zA-Z0-9_\\-]{0,99})$", + "type": "string" + }, + "maxItems": 10, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "Name", + "Values" + ], + "type": "object" + }, + "FleetCapabilities": { + "additionalProperties": false, + "properties": { + "Amounts": { + "items": { + "$ref": "#/definitions/FleetAmountCapability" + }, + "maxItems": 15, + "minItems": 1, + "type": "array" + }, + "Attributes": { + "items": { + "$ref": "#/definitions/FleetAttributeCapability" + }, + "maxItems": 15, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "FleetConfiguration": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "CustomerManaged": { + "$ref": "#/definitions/CustomerManagedFleetConfiguration" + } + }, + "required": [ + "CustomerManaged" + ], + "title": "CustomerManaged", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "ServiceManagedEc2": { + "$ref": "#/definitions/ServiceManagedEc2FleetConfiguration" + } + }, + "required": [ + "ServiceManagedEc2" + ], + "title": "ServiceManagedEc2", + "type": "object" + } + ] + }, + "FleetStatus": { + "enum": [ + "ACTIVE", + "CREATE_IN_PROGRESS", + "UPDATE_IN_PROGRESS", + "CREATE_FAILED", + "UPDATE_FAILED" + ], + "type": "string" + }, + "MemoryMiBRange": { + "additionalProperties": false, + "properties": { + "Max": { + "maximum": 2147483647, + "minimum": 512, + "type": "integer" + }, + "Min": { + "maximum": 2147483647, + "minimum": 512, + "type": "integer" + } + }, + "required": [ + "Min" + ], + "type": "object" + }, + "ServiceManagedEc2FleetConfiguration": { + "additionalProperties": false, + "properties": { + "InstanceCapabilities": { + "$ref": "#/definitions/ServiceManagedEc2InstanceCapabilities" + }, + "InstanceMarketOptions": { + "$ref": "#/definitions/ServiceManagedEc2InstanceMarketOptions" + } + }, + "required": [ + "InstanceCapabilities", + "InstanceMarketOptions" + ], + "type": "object" + }, + "ServiceManagedEc2InstanceCapabilities": { + "additionalProperties": false, + "properties": { + "AllowedInstanceTypes": { + "items": { + "pattern": "^[a-zA-Z0-9]+\\.[a-zA-Z0-9]+$", + "type": "string" + }, + "maxItems": 100, + "minItems": 1, + "type": "array" + }, + "CpuArchitectureType": { + "$ref": "#/definitions/CpuArchitectureType" + }, + "CustomAmounts": { + "items": { + "$ref": "#/definitions/FleetAmountCapability" + }, + "maxItems": 15, + "minItems": 1, + "type": "array" + }, + "CustomAttributes": { + "items": { + "$ref": "#/definitions/FleetAttributeCapability" + }, + "maxItems": 15, + "minItems": 1, + "type": "array" + }, + "ExcludedInstanceTypes": { + "items": { + "pattern": "^[a-zA-Z0-9]+\\.[a-zA-Z0-9]+$", + "type": "string" + }, + "maxItems": 100, + "minItems": 1, + "type": "array" + }, + "MemoryMiB": { + "$ref": "#/definitions/MemoryMiBRange" + }, + "OsFamily": { + "$ref": "#/definitions/ServiceManagedFleetOperatingSystemFamily" + }, + "RootEbsVolume": { + "$ref": "#/definitions/Ec2EbsVolume" + }, + "VCpuCount": { + "$ref": "#/definitions/VCpuCountRange" + } + }, + "required": [ + "CpuArchitectureType", + "MemoryMiB", + "OsFamily", + "VCpuCount" + ], + "type": "object" + }, + "ServiceManagedEc2InstanceMarketOptions": { + "additionalProperties": false, + "properties": { + "Type": { + "$ref": "#/definitions/Ec2MarketType" + } + }, + "required": [ + "Type" + ], + "type": "object" + }, + "ServiceManagedFleetOperatingSystemFamily": { + "enum": [ + "LINUX" + ], + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 127, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "VCpuCountRange": { + "additionalProperties": false, + "properties": { + "Max": { + "maximum": 10000, + "minimum": 1, + "type": "integer" + }, + "Min": { + "maximum": 10000, + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "Min" + ], + "type": "object" + } + }, + "description": "Definition of AWS::Deadline::Fleet Resource Type", + "handlers": { + "create": { + "permissions": [ + "deadline:CreateFleet", + "deadline:GetFleet", + "iam:PassRole", + "identitystore:ListGroupMembershipsForMember", + "logs:CreateLogGroup", + "deadline:TagResource", + "deadline:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "deadline:DeleteFleet", + "deadline:GetFleet", + "identitystore:ListGroupMembershipsForMember" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "FarmId": { + "$ref": "resource-schema.json#/properties/FarmId" + } + }, + "required": [ + "FarmId" + ] + }, + "permissions": [ + "deadline:ListFleets", + "identitystore:DescribeGroup", + "identitystore:DescribeUser", + "identitystore:ListGroupMembershipsForMember" + ] + }, + "read": { + "permissions": [ + "deadline:GetFleet", + "identitystore:ListGroupMembershipsForMember", + "deadline:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "deadline:UpdateFleet", + "deadline:GetFleet", + "iam:PassRole", + "identitystore:ListGroupMembershipsForMember", + "deadline:TagResource", + "deadline:UntagResource", + "deadline:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "pattern": "^arn:(aws[a-zA-Z-]*):deadline:[a-z0-9-]+:[0-9]+:farm/farm-[0-9a-z]{32}/fleet/fleet-[0-9a-z]{32}", + "type": "string" + }, + "Capabilities": { + "$ref": "#/definitions/FleetCapabilities" + }, + "Configuration": { + "$ref": "#/definitions/FleetConfiguration" + }, + "Description": { + "default": "", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "DisplayName": { + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "FarmId": { + "pattern": "^farm-[0-9a-f]{32}$", + "type": "string" + }, + "FleetId": { + "pattern": "^fleet-[0-9a-f]{32}$", + "type": "string" + }, + "MaxWorkerCount": { + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "MinWorkerCount": { + "default": 0, + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "RoleArn": { + "pattern": "^arn:(aws[a-zA-Z-]*):iam::\\d{12}:role(/[!-.0-~]+)*/[\\w+=,.@-]+$", + "type": "string" + }, + "Status": { + "$ref": "#/definitions/FleetStatus" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + }, + "WorkerCount": { + "type": "integer" + } + }, + "readOnlyProperties": [ + "/properties/Capabilities", + "/properties/FleetId", + "/properties/Status", + "/properties/WorkerCount", + "/properties/Arn" + ], + "required": [ + "Configuration", + "DisplayName", + "MaxWorkerCount", + "RoleArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-deadline", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "deadline:TagResource", + "deadline:UntagResource", + "deadline:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Deadline::Fleet" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::Deadline::LicenseEndpoint.json b/artifacts/types/AWS::Deadline::LicenseEndpoint.json new file mode 100644 index 00000000..5ee2471e --- /dev/null +++ b/artifacts/types/AWS::Deadline::LicenseEndpoint.json @@ -0,0 +1,170 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Deadline-LicenseEndpoint", + "type": "AWS::Deadline::LicenseEndpoint", + "time": "2024-06-20T16:46:40.202Z", + "schema": { + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/SecurityGroupIds", + "/properties/SubnetIds", + "/properties/VpcId" + ], + "definitions": { + "LicenseEndpointStatus": { + "enum": [ + "CREATE_IN_PROGRESS", + "DELETE_IN_PROGRESS", + "READY", + "NOT_READY" + ], + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 127, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Definition of AWS::Deadline::LicenseEndpoint Resource Type", + "handlers": { + "create": { + "permissions": [ + "deadline:CreateLicenseEndpoint", + "deadline:GetLicenseEndpoint", + "ec2:CreateTags", + "ec2:CreateVpcEndpoint", + "ec2:DescribeVpcEndpoints", + "deadline:TagResource", + "deadline:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "deadline:GetLicenseEndpoint", + "deadline:DeleteLicenseEndpoint", + "ec2:DeleteVpcEndpoints", + "ec2:DescribeVpcEndpoints" + ] + }, + "list": { + "permissions": [ + "deadline:ListLicenseEndpoints" + ] + }, + "read": { + "permissions": [ + "deadline:GetLicenseEndpoint", + "deadline:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "deadline:TagResource", + "deadline:UntagResource", + "deadline:ListTagsForResource", + "deadline:GetLicenseEndpoint" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "pattern": "^arn:(aws[a-zA-Z-]*):deadline:[a-z0-9-]+:[0-9]{12}:license-endpoint/le-[0-9a-z]{32}", + "type": "string" + }, + "DnsName": { + "type": "string" + }, + "LicenseEndpointId": { + "pattern": "^le-[0-9a-f]{32}$", + "type": "string" + }, + "SecurityGroupIds": { + "items": { + "type": "string" + }, + "maxItems": 10, + "minItems": 1, + "type": "array" + }, + "Status": { + "$ref": "#/definitions/LicenseEndpointStatus" + }, + "StatusMessage": { + "maxLength": 1024, + "minLength": 0, + "type": "string" + }, + "SubnetIds": { + "items": { + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "maxItems": 10, + "minItems": 1, + "type": "array" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + }, + "VpcId": { + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/DnsName", + "/properties/LicenseEndpointId", + "/properties/Status", + "/properties/StatusMessage", + "/properties/Arn" + ], + "required": [ + "SecurityGroupIds", + "SubnetIds", + "VpcId" + ], + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "deadline:TagResource", + "deadline:UntagResource", + "deadline:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Deadline::LicenseEndpoint" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::Deadline::Monitor.json b/artifacts/types/AWS::Deadline::Monitor.json new file mode 100644 index 00000000..25911bdb --- /dev/null +++ b/artifacts/types/AWS::Deadline::Monitor.json @@ -0,0 +1,109 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Deadline-Monitor", + "type": "AWS::Deadline::Monitor", + "time": "2024-06-20T16:24:39.826Z", + "schema": { + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/IdentityCenterInstanceArn" + ], + "description": "Definition of AWS::Deadline::Monitor Resource Type", + "handlers": { + "create": { + "permissions": [ + "deadline:CreateMonitor", + "deadline:GetMonitor", + "iam:PassRole", + "kms:CreateGrant", + "sso:CreateApplication", + "sso:DeleteApplication", + "sso:PutApplicationAssignmentConfiguration", + "sso:PutApplicationAuthenticationMethod", + "sso:PutApplicationGrant" + ] + }, + "delete": { + "permissions": [ + "deadline:DeleteMonitor", + "deadline:GetMonitor", + "sso:DeleteApplication" + ] + }, + "list": { + "permissions": [ + "deadline:ListMonitors" + ] + }, + "read": { + "permissions": [ + "deadline:GetMonitor" + ] + }, + "update": { + "permissions": [ + "deadline:GetMonitor", + "deadline:UpdateMonitor", + "iam:PassRole", + "kms:CreateGrant", + "sso:PutApplicationGrant", + "sso:UpdateApplication" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "pattern": "^arn:(aws[a-zA-Z-]*):deadline:[a-z0-9-]+:[0-9]+:monitor/monitor-[0-9a-z]{32}$", + "type": "string" + }, + "DisplayName": { + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "IdentityCenterApplicationArn": { + "type": "string" + }, + "IdentityCenterInstanceArn": { + "pattern": "^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}$", + "type": "string" + }, + "MonitorId": { + "pattern": "^monitor-[0-9a-f]{32}$", + "type": "string" + }, + "RoleArn": { + "pattern": "^arn:(aws[a-zA-Z-]*):iam::\\d{12}:role(/[!-.0-~]+)*/[\\w+=,.@-]+$", + "type": "string" + }, + "Subdomain": { + "pattern": "^[a-z0-9-]{1,100}$", + "type": "string" + }, + "Url": { + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/IdentityCenterApplicationArn", + "/properties/MonitorId", + "/properties/Url", + "/properties/Arn" + ], + "required": [ + "DisplayName", + "IdentityCenterInstanceArn", + "RoleArn", + "Subdomain" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::Deadline::Monitor" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::Deadline::Queue.json b/artifacts/types/AWS::Deadline::Queue.json new file mode 100644 index 00000000..975755a1 --- /dev/null +++ b/artifacts/types/AWS::Deadline::Queue.json @@ -0,0 +1,289 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Deadline-Queue", + "type": "AWS::Deadline::Queue", + "time": "2024-06-20T16:54:08.576Z", + "schema": { + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/FarmId" + ], + "definitions": { + "DefaultQueueBudgetAction": { + "default": "NONE", + "enum": [ + "NONE", + "STOP_SCHEDULING_AND_COMPLETE_TASKS", + "STOP_SCHEDULING_AND_CANCEL_TASKS" + ], + "type": "string" + }, + "JobAttachmentSettings": { + "additionalProperties": false, + "properties": { + "RootPrefix": { + "maxLength": 63, + "minLength": 1, + "type": "string" + }, + "S3BucketName": { + "maxLength": 63, + "minLength": 3, + "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])$)", + "type": "string" + } + }, + "required": [ + "RootPrefix", + "S3BucketName" + ], + "type": "object" + }, + "JobRunAsUser": { + "additionalProperties": false, + "properties": { + "Posix": { + "$ref": "#/definitions/PosixUser" + }, + "RunAs": { + "$ref": "#/definitions/RunAs" + }, + "Windows": { + "$ref": "#/definitions/WindowsUser" + } + }, + "required": [ + "RunAs" + ], + "type": "object" + }, + "PosixUser": { + "additionalProperties": false, + "properties": { + "Group": { + "maxLength": 31, + "minLength": 0, + "pattern": "^(?:[a-z][a-z0-9-]{0,30})?$", + "type": "string" + }, + "User": { + "maxLength": 31, + "minLength": 0, + "pattern": "^(?:[a-z][a-z0-9-]{0,30})?$", + "type": "string" + } + }, + "required": [ + "Group", + "User" + ], + "type": "object" + }, + "RunAs": { + "enum": [ + "QUEUE_CONFIGURED_USER", + "WORKER_AGENT_USER" + ], + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 127, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "WindowsUser": { + "additionalProperties": false, + "properties": { + "PasswordArn": { + "maxLength": 2048, + "minLength": 20, + "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}$", + "type": "string" + }, + "User": { + "maxLength": 111, + "minLength": 0, + "pattern": "^[^\"'/\\[\\]:;|=,+*?\u003c\u003e\\s]*$", + "type": "string" + } + }, + "required": [ + "PasswordArn", + "User" + ], + "type": "object" + } + }, + "description": "Definition of AWS::Deadline::Queue Resource Type", + "handlers": { + "create": { + "permissions": [ + "deadline:CreateQueue", + "deadline:GetQueue", + "iam:PassRole", + "identitystore:ListGroupMembershipsForMember", + "logs:CreateLogGroup", + "s3:ListBucket", + "deadline:TagResource", + "deadline:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "deadline:DeleteQueue", + "deadline:GetQueue", + "identitystore:ListGroupMembershipsForMember" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "FarmId": { + "$ref": "resource-schema.json#/properties/FarmId" + } + }, + "required": [ + "FarmId" + ] + }, + "permissions": [ + "deadline:ListQueues", + "identitystore:DescribeGroup", + "identitystore:DescribeUser", + "identitystore:ListGroupMembershipsForMember" + ] + }, + "read": { + "permissions": [ + "deadline:GetQueue", + "identitystore:ListGroupMembershipsForMember", + "deadline:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "deadline:UpdateQueue", + "deadline:GetQueue", + "iam:PassRole", + "identitystore:ListGroupMembershipsForMember", + "logs:CreateLogGroup", + "s3:ListBucket", + "deadline:TagResource", + "deadline:UntagResource", + "deadline:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "AllowedStorageProfileIds": { + "items": { + "pattern": "^sp-[0-9a-f]{32}$", + "type": "string" + }, + "maxItems": 20, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "Arn": { + "pattern": "^arn:*", + "type": "string" + }, + "DefaultBudgetAction": { + "$ref": "#/definitions/DefaultQueueBudgetAction" + }, + "Description": { + "default": "", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "DisplayName": { + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "FarmId": { + "pattern": "^farm-[0-9a-f]{32}$", + "type": "string" + }, + "JobAttachmentSettings": { + "$ref": "#/definitions/JobAttachmentSettings" + }, + "JobRunAsUser": { + "$ref": "#/definitions/JobRunAsUser" + }, + "QueueId": { + "pattern": "^queue-[0-9a-f]{32}$", + "type": "string" + }, + "RequiredFileSystemLocationNames": { + "items": { + "maxLength": 64, + "minLength": 1, + "pattern": "^[0-9A-Za-z ]*$", + "type": "string" + }, + "maxItems": 20, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "RoleArn": { + "pattern": "^arn:(aws[a-zA-Z-]*):iam::\\d{12}:role(/[!-.0-~]+)*/[\\w+=,.@-]+$", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/QueueId", + "/properties/Arn" + ], + "required": [ + "DisplayName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-deadline", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "deadline:TagResource", + "deadline:UntagResource", + "deadline:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Deadline::Queue" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::Deadline::QueueEnvironment.json b/artifacts/types/AWS::Deadline::QueueEnvironment.json new file mode 100644 index 00000000..d63cf095 --- /dev/null +++ b/artifacts/types/AWS::Deadline::QueueEnvironment.json @@ -0,0 +1,123 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Deadline-QueueEnvironment", + "type": "AWS::Deadline::QueueEnvironment", + "time": "2024-06-20T17:05:49.774Z", + "schema": { + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/FarmId", + "/properties/QueueId" + ], + "definitions": { + "EnvironmentTemplateType": { + "enum": [ + "JSON", + "YAML" + ], + "type": "string" + } + }, + "description": "Definition of AWS::Deadline::QueueEnvironment Resource Type", + "handlers": { + "create": { + "permissions": [ + "deadline:CreateQueueEnvironment", + "identitystore:ListGroupMembershipsForMember" + ] + }, + "delete": { + "permissions": [ + "deadline:DeleteQueueEnvironment", + "deadline:GetQueueEnvironment", + "identitystore:ListGroupMembershipsForMember" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "FarmId": { + "$ref": "resource-schema.json#/properties/FarmId" + }, + "QueueId": { + "$ref": "resource-schema.json#/properties/QueueId" + } + }, + "required": [ + "FarmId", + "QueueId" + ] + }, + "permissions": [ + "deadline:ListQueueEnvironments", + "identitystore:ListGroupMembershipsForMember" + ] + }, + "read": { + "permissions": [ + "deadline:GetQueueEnvironment", + "identitystore:ListGroupMembershipsForMember" + ] + }, + "update": { + "permissions": [ + "deadline:UpdateQueueEnvironment", + "identitystore:ListGroupMembershipsForMember" + ] + } + }, + "primaryIdentifier": [ + "/properties/FarmId", + "/properties/QueueId", + "/properties/QueueEnvironmentId" + ], + "properties": { + "FarmId": { + "pattern": "^farm-[0-9a-f]{32}$", + "type": "string" + }, + "Name": { + "type": "string" + }, + "Priority": { + "maximum": 10000, + "minimum": 0, + "type": "integer" + }, + "QueueEnvironmentId": { + "pattern": "^queueenv-[0-9a-f]{32}$", + "type": "string" + }, + "QueueId": { + "pattern": "^queue-[0-9a-f]{32}$", + "type": "string" + }, + "Template": { + "maxLength": 15000, + "minLength": 1, + "type": "string" + }, + "TemplateType": { + "$ref": "#/definitions/EnvironmentTemplateType" + } + }, + "readOnlyProperties": [ + "/properties/Name", + "/properties/QueueEnvironmentId" + ], + "required": [ + "FarmId", + "QueueId", + "Priority", + "Template", + "TemplateType" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-deadline", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::Deadline::QueueEnvironment" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::Deadline::StorageProfile.json b/artifacts/types/AWS::Deadline::StorageProfile.json new file mode 100644 index 00000000..3238e210 --- /dev/null +++ b/artifacts/types/AWS::Deadline::StorageProfile.json @@ -0,0 +1,144 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Deadline-StorageProfile", + "type": "AWS::Deadline::StorageProfile", + "time": "2024-06-20T16:38:08.487Z", + "schema": { + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/FarmId" + ], + "definitions": { + "FileSystemLocation": { + "additionalProperties": false, + "properties": { + "Name": { + "maxLength": 64, + "minLength": 1, + "pattern": "^[0-9A-Za-z ]*$", + "type": "string" + }, + "Path": { + "maxLength": 1024, + "minLength": 0, + "type": "string" + }, + "Type": { + "$ref": "#/definitions/FileSystemLocationType" + } + }, + "required": [ + "Name", + "Path", + "Type" + ], + "type": "object" + }, + "FileSystemLocationType": { + "enum": [ + "SHARED", + "LOCAL" + ], + "type": "string" + }, + "StorageProfileOperatingSystemFamily": { + "enum": [ + "WINDOWS", + "LINUX", + "MACOS" + ], + "type": "string" + } + }, + "description": "Definition of AWS::Deadline::StorageProfile Resource Type", + "handlers": { + "create": { + "permissions": [ + "deadline:CreateStorageProfile", + "deadline:GetStorageProfile", + "identitystore:ListGroupMembershipsForMember" + ] + }, + "delete": { + "permissions": [ + "deadline:DeleteStorageProfile", + "deadline:GetStorageProfile", + "identitystore:ListGroupMembershipsForMember" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "FarmId": { + "$ref": "resource-schema.json#/properties/FarmId" + } + }, + "required": [ + "FarmId" + ] + }, + "permissions": [ + "deadline:ListStorageProfiles", + "identitystore:ListGroupMembershipsForMember" + ] + }, + "read": { + "permissions": [ + "deadline:GetStorageProfile", + "identitystore:ListGroupMembershipsForMember" + ] + }, + "update": { + "permissions": [ + "deadline:UpdateStorageProfile", + "deadline:GetStorageProfile", + "identitystore:ListGroupMembershipsForMember" + ] + } + }, + "primaryIdentifier": [ + "/properties/FarmId", + "/properties/StorageProfileId" + ], + "properties": { + "DisplayName": { + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "FarmId": { + "pattern": "^farm-[0-9a-f]{32}$", + "type": "string" + }, + "FileSystemLocations": { + "items": { + "$ref": "#/definitions/FileSystemLocation" + }, + "maxItems": 20, + "minItems": 0, + "type": "array" + }, + "OsFamily": { + "$ref": "#/definitions/StorageProfileOperatingSystemFamily" + }, + "StorageProfileId": { + "pattern": "^sp-[0-9a-f]{32}$", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/StorageProfileId" + ], + "required": [ + "DisplayName", + "OsFamily" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-deadline", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::Deadline::StorageProfile" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::Detective::Graph.json b/artifacts/types/AWS::Detective::Graph.json index 3c03b1e9..39922edb 100644 --- a/artifacts/types/AWS::Detective::Graph.json +++ b/artifacts/types/AWS::Detective::Graph.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Detective-Graph", "type": "AWS::Detective::Graph", - "time": "2023-12-18T17:47:22.307Z", + "time": "2024-06-17T18:38:09.38Z", "schema": { "additionalProperties": false, "definitions": { diff --git a/artifacts/types/AWS::Detective::MemberInvitation.json b/artifacts/types/AWS::Detective::MemberInvitation.json index 6dbcec38..80d6e93e 100644 --- a/artifacts/types/AWS::Detective::MemberInvitation.json +++ b/artifacts/types/AWS::Detective::MemberInvitation.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Detective-MemberInvitation", "type": "AWS::Detective::MemberInvitation", - "time": "2023-12-18T17:50:12.834Z", + "time": "2024-06-17T18:41:02.716Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Detective::OrganizationAdmin.json b/artifacts/types/AWS::Detective::OrganizationAdmin.json index 193201ef..a6e598cb 100644 --- a/artifacts/types/AWS::Detective::OrganizationAdmin.json +++ b/artifacts/types/AWS::Detective::OrganizationAdmin.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Detective-OrganizationAdmin", "type": "AWS::Detective::OrganizationAdmin", - "time": "2023-12-18T17:58:33.115Z", + "time": "2024-06-17T18:49:38.21Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::DevOpsGuru::LogAnomalyDetectionIntegration.json b/artifacts/types/AWS::DevOpsGuru::LogAnomalyDetectionIntegration.json index 407972b3..54e06337 100644 --- a/artifacts/types/AWS::DevOpsGuru::LogAnomalyDetectionIntegration.json +++ b/artifacts/types/AWS::DevOpsGuru::LogAnomalyDetectionIntegration.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-DevOpsGuru-LogAnomalyDetectionIntegration", "type": "AWS::DevOpsGuru::LogAnomalyDetectionIntegration", - "time": "2024-01-03T19:11:25.541Z", + "time": "2024-03-13T15:19:51.592Z", "schema": { "additionalProperties": false, "definitions": { diff --git a/artifacts/types/AWS::DevOpsGuru::ResourceCollection.json b/artifacts/types/AWS::DevOpsGuru::ResourceCollection.json index 223f035d..40f3b92d 100644 --- a/artifacts/types/AWS::DevOpsGuru::ResourceCollection.json +++ b/artifacts/types/AWS::DevOpsGuru::ResourceCollection.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-DevOpsGuru-ResourceCollection", "type": "AWS::DevOpsGuru::ResourceCollection", - "time": "2024-01-03T18:57:43.643Z", + "time": "2024-03-13T15:24:12.78Z", "schema": { "additionalProperties": false, "definitions": { diff --git a/artifacts/types/AWS::DeviceFarm::DevicePool.json b/artifacts/types/AWS::DeviceFarm::DevicePool.json index c004c556..dc20bc5a 100644 --- a/artifacts/types/AWS::DeviceFarm::DevicePool.json +++ b/artifacts/types/AWS::DeviceFarm::DevicePool.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-DeviceFarm-DevicePool", "type": "AWS::DeviceFarm::DevicePool", - "time": "2023-12-07T18:20:33.408Z", + "time": "2024-01-31T23:43:31.717Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::DeviceFarm::InstanceProfile.json b/artifacts/types/AWS::DeviceFarm::InstanceProfile.json index e86a6f8c..96f25d93 100644 --- a/artifacts/types/AWS::DeviceFarm::InstanceProfile.json +++ b/artifacts/types/AWS::DeviceFarm::InstanceProfile.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-DeviceFarm-InstanceProfile", "type": "AWS::DeviceFarm::InstanceProfile", - "time": "2023-12-07T18:20:04.504Z", + "time": "2024-01-31T23:41:21.44Z", "schema": { "additionalProperties": false, "definitions": { diff --git a/artifacts/types/AWS::DeviceFarm::NetworkProfile.json b/artifacts/types/AWS::DeviceFarm::NetworkProfile.json index 5e48e70e..4e2fd574 100644 --- a/artifacts/types/AWS::DeviceFarm::NetworkProfile.json +++ b/artifacts/types/AWS::DeviceFarm::NetworkProfile.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-DeviceFarm-NetworkProfile", "type": "AWS::DeviceFarm::NetworkProfile", - "time": "2023-12-07T18:20:29.534Z", + "time": "2024-01-31T23:42:32.322Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::DeviceFarm::Project.json b/artifacts/types/AWS::DeviceFarm::Project.json index 7ad68136..567253a2 100644 --- a/artifacts/types/AWS::DeviceFarm::Project.json +++ b/artifacts/types/AWS::DeviceFarm::Project.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-DeviceFarm-Project", "type": "AWS::DeviceFarm::Project", - "time": "2023-12-07T18:21:11.362Z", + "time": "2024-01-31T23:42:13.737Z", "schema": { "additionalProperties": false, "definitions": { diff --git a/artifacts/types/AWS::DeviceFarm::TestGridProject.json b/artifacts/types/AWS::DeviceFarm::TestGridProject.json index 82e94464..74f7045b 100644 --- a/artifacts/types/AWS::DeviceFarm::TestGridProject.json +++ b/artifacts/types/AWS::DeviceFarm::TestGridProject.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-DeviceFarm-TestGridProject", "type": "AWS::DeviceFarm::TestGridProject", - "time": "2023-12-07T18:20:31.19Z", + "time": "2024-01-31T23:42:31.347Z", "schema": { "additionalProperties": false, "definitions": { diff --git a/artifacts/types/AWS::DeviceFarm::VPCEConfiguration.json b/artifacts/types/AWS::DeviceFarm::VPCEConfiguration.json index 3818b7be..e085c66c 100644 --- a/artifacts/types/AWS::DeviceFarm::VPCEConfiguration.json +++ b/artifacts/types/AWS::DeviceFarm::VPCEConfiguration.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-DeviceFarm-VPCEConfiguration", "type": "AWS::DeviceFarm::VPCEConfiguration", - "time": "2023-12-07T18:19:08.633Z", + "time": "2024-01-31T23:41:25.102Z", "schema": { "additionalProperties": false, "definitions": { diff --git a/artifacts/types/AWS::DirectoryService::SimpleAD.json b/artifacts/types/AWS::DirectoryService::SimpleAD.json index 4d4a2da6..55905a44 100644 --- a/artifacts/types/AWS::DirectoryService::SimpleAD.json +++ b/artifacts/types/AWS::DirectoryService::SimpleAD.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-DirectoryService-SimpleAD", "type": "AWS::DirectoryService::SimpleAD", - "time": "2023-11-14T22:25:08.892Z", + "time": "2024-05-13T18:36:43.226Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -55,7 +55,9 @@ "ec2:DescribeNetworkInterfaces", "ec2:AuthorizeSecurityGroupIngress", "ec2:AuthorizeSecurityGroupEgress", - "ec2:CreateTags" + "ec2:CreateTags", + "ec2:RevokeSecurityGroupIngress", + "ec2:RevokeSecurityGroupEgress" ], "timeoutInMinutes": 60 }, diff --git a/artifacts/types/AWS::DocDBElastic::Cluster.json b/artifacts/types/AWS::DocDBElastic::Cluster.json index d587be62..68f7f5d7 100644 --- a/artifacts/types/AWS::DocDBElastic::Cluster.json +++ b/artifacts/types/AWS::DocDBElastic::Cluster.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-DocDBElastic-Cluster", "type": "AWS::DocDBElastic::Cluster", - "time": "2023-03-02T02:56:17.925Z", + "time": "2024-06-18T20:21:41.581Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -38,6 +38,9 @@ "create": { "permissions": [ "docdb-elastic:CreateCluster", + "docdb-elastic:TagResource", + "docdb-elastic:GetCluster", + "docdb-elastic:ListTagsForResource", "ec2:CreateVpcEndpoint", "ec2:DescribeVpcEndpoints", "ec2:DeleteVpcEndpoints", @@ -62,6 +65,7 @@ "delete": { "permissions": [ "docdb-elastic:DeleteCluster", + "docdb-elastic:GetCluster", "ec2:DescribeVpcEndpoints", "ec2:DeleteVpcEndpoints", "ec2:ModifyVpcEndpoint", @@ -88,6 +92,8 @@ "docdb-elastic:UpdateCluster", "docdb-elastic:TagResource", "docdb-elastic:UntagResource", + "docdb-elastic:GetCluster", + "docdb-elastic:ListTagsForResource", "ec2:CreateVpcEndpoint", "ec2:DescribeVpcEndpoints", "ec2:DeleteVpcEndpoints", @@ -122,6 +128,9 @@ "AuthType": { "type": "string" }, + "BackupRetentionPeriod": { + "type": "integer" + }, "ClusterArn": { "type": "string" }, @@ -137,6 +146,9 @@ "KmsKeyId": { "type": "string" }, + "PreferredBackupWindow": { + "type": "string" + }, "PreferredMaintenanceWindow": { "type": "string" }, @@ -146,6 +158,9 @@ "ShardCount": { "type": "integer" }, + "ShardInstanceCount": { + "type": "integer" + }, "SubnetIds": { "insertionOrder": false, "items": { diff --git a/artifacts/types/AWS::DynamoDB::GlobalTable.json b/artifacts/types/AWS::DynamoDB::GlobalTable.json index 3bdc803b..80293f1a 100644 --- a/artifacts/types/AWS::DynamoDB::GlobalTable.json +++ b/artifacts/types/AWS::DynamoDB::GlobalTable.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-DynamoDB-GlobalTable", "type": "AWS::DynamoDB::GlobalTable", - "time": "2024-01-04T16:30:00.043Z", + "time": "2024-06-18T16:41:00.591Z", "schema": { "additionalIdentifiers": [ [ @@ -94,6 +94,9 @@ "Projection": { "$ref": "#/definitions/Projection" }, + "WriteOnDemandThroughputSettings": { + "$ref": "#/definitions/WriteOnDemandThroughputSettings" + }, "WriteProvisionedThroughputSettings": { "$ref": "#/definitions/WriteProvisionedThroughputSettings" } @@ -126,7 +129,18 @@ "KinesisStreamSpecification": { "additionalProperties": false, "properties": { + "ApproximateCreationDateTimePrecision": { + "enum": [ + "MICROSECOND", + "MILLISECOND" + ], + "type": "string" + }, "StreamArn": { + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::Kinesis::Stream" + }, "type": "string" } }, @@ -189,6 +203,16 @@ }, "type": "object" }, + "ReadOnDemandThroughputSettings": { + "additionalProperties": false, + "properties": { + "MaxReadRequestUnits": { + "minimum": 1, + "type": "integer" + } + }, + "type": "object" + }, "ReadProvisionedThroughputSettings": { "additionalProperties": false, "properties": { @@ -213,6 +237,9 @@ "minLength": 3, "type": "string" }, + "ReadOnDemandThroughputSettings": { + "$ref": "#/definitions/ReadOnDemandThroughputSettings" + }, "ReadProvisionedThroughputSettings": { "$ref": "#/definitions/ReadProvisionedThroughputSettings" } @@ -226,6 +253,26 @@ "additionalProperties": false, "properties": { "KMSMasterKeyId": { + "anyOf": [ + { + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::KMS::Key" + } + }, + { + "relationshipRef": { + "propertyPath": "/properties/KeyId", + "typeName": "AWS::KMS::Key" + } + }, + { + "relationshipRef": { + "propertyPath": "/properties/AliasName", + "typeName": "AWS::KMS::Alias" + } + } + ], "type": "string" } }, @@ -257,12 +304,21 @@ "PointInTimeRecoverySpecification": { "$ref": "#/definitions/PointInTimeRecoverySpecification" }, + "ReadOnDemandThroughputSettings": { + "$ref": "#/definitions/ReadOnDemandThroughputSettings" + }, "ReadProvisionedThroughputSettings": { "$ref": "#/definitions/ReadProvisionedThroughputSettings" }, "Region": { "type": "string" }, + "ReplicaStreamSpecification": { + "$ref": "#/definitions/ReplicaStreamSpecification" + }, + "ResourcePolicy": { + "$ref": "#/definitions/ResourcePolicy" + }, "SSESpecification": { "$ref": "#/definitions/ReplicaSSESpecification" }, @@ -283,6 +339,30 @@ ], "type": "object" }, + "ReplicaStreamSpecification": { + "additionalProperties": false, + "properties": { + "ResourcePolicy": { + "$ref": "#/definitions/ResourcePolicy" + } + }, + "required": [ + "ResourcePolicy" + ], + "type": "object" + }, + "ResourcePolicy": { + "additionalProperties": false, + "properties": { + "PolicyDocument": { + "type": "object" + } + }, + "required": [ + "PolicyDocument" + ], + "type": "object" + }, "SSESpecification": { "additionalProperties": false, "properties": { @@ -365,6 +445,16 @@ ], "type": "object" }, + "WriteOnDemandThroughputSettings": { + "additionalProperties": false, + "properties": { + "MaxWriteRequestUnits": { + "minimum": 1, + "type": "integer" + } + }, + "type": "object" + }, "WriteProvisionedThroughputSettings": { "additionalProperties": false, "properties": { @@ -398,6 +488,8 @@ "dynamodb:DisableKinesisStreamingDestination", "dynamodb:UpdateTableReplicaAutoScaling", "dynamodb:TagResource", + "dynamodb:GetResourcePolicy", + "dynamodb:PutResourcePolicy", "application-autoscaling:DeleteScalingPolicy", "application-autoscaling:DeleteScheduledAction", "application-autoscaling:DeregisterScalableTarget", @@ -439,6 +531,7 @@ "read": { "permissions": [ "dynamodb:Describe*", + "dynamodb:GetResourcePolicy", "application-autoscaling:Describe*", "cloudwatch:PutMetricData", "dynamodb:ListTagsOfResource", @@ -469,6 +562,10 @@ "dynamodb:EnableKinesisStreamingDestination", "dynamodb:DisableKinesisStreamingDestination", "dynamodb:UpdateTableReplicaAutoScaling", + "dynamodb:UpdateKinesisStreamingDestination", + "dynamodb:GetResourcePolicy", + "dynamodb:PutResourcePolicy", + "dynamodb:DeleteResourcePolicy", "application-autoscaling:DeleteScalingPolicy", "application-autoscaling:DeleteScheduledAction", "application-autoscaling:DeregisterScalableTarget", @@ -559,6 +656,9 @@ "TimeToLiveSpecification": { "$ref": "#/definitions/TimeToLiveSpecification" }, + "WriteOnDemandThroughputSettings": { + "$ref": "#/definitions/WriteOnDemandThroughputSettings" + }, "WriteProvisionedThroughputSettings": { "$ref": "#/definitions/WriteProvisionedThroughputSettings" } diff --git a/artifacts/types/AWS::DynamoDB::Table.json b/artifacts/types/AWS::DynamoDB::Table.json index 9316587a..d5c20394 100644 --- a/artifacts/types/AWS::DynamoDB::Table.json +++ b/artifacts/types/AWS::DynamoDB::Table.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-DynamoDB-Table", "type": "AWS::DynamoDB::Table", - "time": "2024-01-04T17:02:07.054Z", + "time": "2024-06-18T16:42:54.783Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -11,11 +11,14 @@ "definitions": { "AttributeDefinition": { "additionalProperties": false, + "description": "Represents an attribute for describing the schema for the table and indexes.", "properties": { "AttributeName": { + "description": "A name for the attribute.", "type": "string" }, "AttributeType": { + "description": "The data type for the attribute, where:\n + ``S`` - the attribute is of type String\n + ``N`` - the attribute is of type Number\n + ``B`` - the attribute is of type Binary", "type": "string" } }, @@ -27,8 +30,10 @@ }, "ContributorInsightsSpecification": { "additionalProperties": false, + "description": "The settings used to enable or disable CloudWatch Contributor Insights.", "properties": { "Enabled": { + "description": "Indicates whether CloudWatch Contributor Insights are to be enabled (true) or disabled (false).", "type": "boolean" } }, @@ -39,11 +44,14 @@ }, "Csv": { "additionalProperties": false, + "description": "The options for imported source files in CSV format. The values are Delimiter and HeaderList.", "properties": { "Delimiter": { + "description": "The delimiter used for separating items in the CSV file being imported.", "type": "string" }, "HeaderList": { + "description": "List of the headers used to specify a common header for all source CSV files being imported. If this field is specified then the first line of each CSV file is treated as data instead of the header. If this field is not specified the the first line of each CSV file is treated as the header.", "items": { "type": "string" }, @@ -55,6 +63,7 @@ }, "DeprecatedHashKeyElement": { "additionalProperties": false, + "description": "", "properties": { "AttributeName": { "type": "string" @@ -71,6 +80,7 @@ }, "DeprecatedKeySchema": { "additionalProperties": false, + "description": "", "properties": { "HashKeyElement": { "$ref": "#/definitions/DeprecatedHashKeyElement" @@ -83,25 +93,35 @@ }, "GlobalSecondaryIndex": { "additionalProperties": false, + "description": "Represents the properties of a global secondary index.", "properties": { "ContributorInsightsSpecification": { - "$ref": "#/definitions/ContributorInsightsSpecification" + "$ref": "#/definitions/ContributorInsightsSpecification", + "description": "The settings used to enable or disable CloudWatch Contributor Insights for the specified global secondary index." }, "IndexName": { + "description": "The name of the global secondary index. The name must be unique among all other indexes on this table.", "type": "string" }, "KeySchema": { + "description": "The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:\n + ``HASH`` - partition key\n + ``RANGE`` - sort key\n \n The partition key of an item is also known as its *hash attribute*. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.\n The sort key of an item is also known as its *range attribute*. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.", "items": { "$ref": "#/definitions/KeySchema" }, "type": "array", "uniqueItems": true }, + "OnDemandThroughput": { + "$ref": "#/definitions/OnDemandThroughput", + "description": "The maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify ``MaxReadRequestUnits``, ``MaxWriteRequestUnits``, or both." + }, "Projection": { - "$ref": "#/definitions/Projection" + "$ref": "#/definitions/Projection", + "description": "Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected." }, "ProvisionedThroughput": { - "$ref": "#/definitions/ProvisionedThroughput" + "$ref": "#/definitions/ProvisionedThroughput", + "description": "Represents the provisioned throughput settings for the specified global secondary index.\n For current minimum and maximum provisioned throughput values, see [Service, Account, and Table Quotas](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) in the *Amazon DynamoDB Developer Guide*." } }, "required": [ @@ -113,18 +133,23 @@ }, "ImportSourceSpecification": { "additionalProperties": false, + "description": "Specifies the properties of data being imported from the S3 bucket source to the table.", "properties": { "InputCompressionType": { + "description": "Type of compression to be used on the input coming from the imported table.", "type": "string" }, "InputFormat": { + "description": "The format of the source data. Valid values for ``ImportFormat`` are ``CSV``, ``DYNAMODB_JSON`` or ``ION``.", "type": "string" }, "InputFormatOptions": { - "$ref": "#/definitions/InputFormatOptions" + "$ref": "#/definitions/InputFormatOptions", + "description": "Additional properties that specify how the input is formatted," }, "S3BucketSource": { - "$ref": "#/definitions/S3BucketSource" + "$ref": "#/definitions/S3BucketSource", + "description": "The S3 bucket that provides the source for the import." } }, "required": [ @@ -135,20 +160,25 @@ }, "InputFormatOptions": { "additionalProperties": false, + "description": "The format options for the data that was imported into the target table. There is one value, CsvOption.", "properties": { "Csv": { - "$ref": "#/definitions/Csv" + "$ref": "#/definitions/Csv", + "description": "The options for imported source files in CSV format. The values are Delimiter and HeaderList." } }, "type": "object" }, "KeySchema": { "additionalProperties": false, + "description": "Represents *a single element* of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.\n A ``KeySchemaElement`` represents exactly one attribute of the primary key. For example, a simple primary key would be represented by one ``KeySchemaElement`` (for the partition key). A composite primary key would require one ``KeySchemaElement`` for the partition key, and another ``KeySchemaElement`` for the sort key.\n A ``KeySchemaElement`` must be a scalar, top-level attribute (not a nested attribute). The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map.", "properties": { "AttributeName": { + "description": "The name of a key attribute.", "type": "string" }, "KeyType": { + "description": "The role that this key attribute will assume:\n + ``HASH`` - partition key\n + ``RANGE`` - sort key\n \n The partition key of an item is also known as its *hash attribute*. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.\n The sort key of an item is also known as its *range attribute*. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.", "type": "string" } }, @@ -160,8 +190,22 @@ }, "KinesisStreamSpecification": { "additionalProperties": false, + "description": "The Kinesis Data Streams configuration for the specified table.", "properties": { + "ApproximateCreationDateTimePrecision": { + "description": "The precision for the time and date that the stream was created.", + "enum": [ + "MICROSECOND", + "MILLISECOND" + ], + "type": "string" + }, "StreamArn": { + "description": "The ARN for a specific Kinesis data stream.\n Length Constraints: Minimum length of 37. Maximum length of 1024.", + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::Kinesis::Stream" + }, "type": "string" } }, @@ -172,11 +216,14 @@ }, "LocalSecondaryIndex": { "additionalProperties": false, + "description": "Represents the properties of a local secondary index. A local secondary index can only be created when its parent table is created.", "properties": { "IndexName": { + "description": "The name of the local secondary index. The name must be unique among all other indexes on this table.", "type": "string" }, "KeySchema": { + "description": "The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:\n + ``HASH`` - partition key\n + ``RANGE`` - sort key\n \n The partition key of an item is also known as its *hash attribute*. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.\n The sort key of an item is also known as its *range attribute*. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.", "items": { "$ref": "#/definitions/KeySchema" }, @@ -184,7 +231,8 @@ "uniqueItems": true }, "Projection": { - "$ref": "#/definitions/Projection" + "$ref": "#/definitions/Projection", + "description": "Represents attributes that are copied (projected) from the table into the local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected." } }, "required": [ @@ -194,10 +242,29 @@ ], "type": "object" }, + "OnDemandThroughput": { + "additionalProperties": false, + "description": "Sets the maximum number of read and write units for the specified on-demand table. If you use this property, you must specify ``MaxReadRequestUnits``, ``MaxWriteRequestUnits``, or both.", + "properties": { + "MaxReadRequestUnits": { + "description": "Maximum number of read request units for the specified table.\n To specify a maximum ``OnDemandThroughput`` on your table, set the value of ``MaxReadRequestUnits`` as greater than or equal to 1. To remove the maximum ``OnDemandThroughput`` that is currently set on your table, set the value of ``MaxReadRequestUnits`` to -1.", + "minimum": 1, + "type": "integer" + }, + "MaxWriteRequestUnits": { + "description": "Maximum number of write request units for the specified table.\n To specify a maximum ``OnDemandThroughput`` on your table, set the value of ``MaxWriteRequestUnits`` as greater than or equal to 1. To remove the maximum ``OnDemandThroughput`` that is currently set on your table, set the value of ``MaxWriteRequestUnits`` to -1.", + "minimum": 1, + "type": "integer" + } + }, + "type": "object" + }, "PointInTimeRecoverySpecification": { "additionalProperties": false, + "description": "The settings used to enable point in time recovery.", "properties": { "PointInTimeRecoveryEnabled": { + "description": "Indicates whether point in time recovery is enabled (true) or disabled (false) on the table.", "type": "boolean" } }, @@ -205,8 +272,10 @@ }, "Projection": { "additionalProperties": false, + "description": "Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.", "properties": { "NonKeyAttributes": { + "description": "Represents the non-key attribute names which will be projected into the index.\n For local secondary indexes, the total count of ``NonKeyAttributes`` summed across all of the local secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.", "items": { "type": "string" }, @@ -214,6 +283,7 @@ "uniqueItems": false }, "ProjectionType": { + "description": "The set of attributes that are projected into the index:\n + ``KEYS_ONLY`` - Only the index and primary keys are projected into the index.\n + ``INCLUDE`` - In addition to the attributes described in ``KEYS_ONLY``, the secondary index will include other non-key attributes that you specify.\n + ``ALL`` - All of the table attributes are projected into the index.\n \n When using the DynamoDB console, ``ALL`` is selected by default.", "type": "string" } }, @@ -221,11 +291,14 @@ }, "ProvisionedThroughput": { "additionalProperties": false, + "description": "Throughput for the specified table, which consists of values for ``ReadCapacityUnits`` and ``WriteCapacityUnits``. For more information about the contents of a provisioned throughput structure, see [Table ProvisionedThroughput](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ProvisionedThroughput.html).", "properties": { "ReadCapacityUnits": { + "description": "The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ``ThrottlingException``. For more information, see [Specifying Read and Write Requirements](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughput.html) in the *Amazon DynamoDB Developer Guide*.\n If read/write capacity mode is ``PAY_PER_REQUEST`` the value is set to 0.", "type": "integer" }, "WriteCapacityUnits": { + "description": "The maximum number of writes consumed per second before DynamoDB returns a ``ThrottlingException``. For more information, see [Specifying Read and Write Requirements](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughput.html) in the *Amazon DynamoDB Developer Guide*.\n If read/write capacity mode is ``PAY_PER_REQUEST`` the value is set to 0.", "type": "integer" } }, @@ -235,16 +308,38 @@ ], "type": "object" }, + "ResourcePolicy": { + "additionalProperties": false, + "description": "Creates or updates a resource-based policy document that contains the permissions for DDB resources, such as a table, its indexes, and stream. Resource-based policies let you define access permissions by specifying who has access to each resource, and the actions they are allowed to perform on each resource.\n In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see [Using resource-based policies for](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html).\n While defining resource-based policies in your CFNshort templates, the following considerations apply:\n + The maximum size supported for a resource-based policy document in JSON format is 20 KB. DDB counts whitespaces when calculating the size of a policy against this limit. \n + Resource-based policies don't support [drift detection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html#). If you update a policy outside of the CFNshort stack template, you'll need to update the CFNshort stack with the changes.\n + Resource-based policies don't support out-of-band changes. If you add, update, or delete a policy outside of the CFNshort template, the change won't be overwritten if there are no changes to the policy within the template.\n For example, say that your template contains a resource-based policy, which you later update outside of the template. If you don't make any changes to the policy in the template, the updated policy in DDB won’t be synced with the policy in the template.\n Conversely, say that your template doesn’t contain a resource-based policy, but you add a policy outside of the template. This policy won’t be removed from DDB as long as you don’t add it to the template. When you add a policy to the template and update the stack, the existing policy in DDB will be updated to match the one defined in the template.\n \n For a full list of all considerations, see [Resource-based policy considerations](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html).", + "properties": { + "PolicyDocument": { + "description": "A resource-based policy document that contains permissions to add to the specified DDB table, index, or both. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see [Using resource-based policies for](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html).", + "type": "object" + } + }, + "required": [ + "PolicyDocument" + ], + "type": "object" + }, "S3BucketSource": { "additionalProperties": false, + "description": "The S3 bucket that is being imported from.", "properties": { "S3Bucket": { + "description": "The S3 bucket that is being imported from.", + "relationshipRef": { + "propertyPath": "/properties/BucketName", + "typeName": "AWS::S3::Bucket" + }, "type": "string" }, "S3BucketOwner": { + "description": "The account number of the S3 bucket that is being imported from. If the bucket is owned by the requester this is optional.", "type": "string" }, "S3KeyPrefix": { + "description": "The key prefix shared by all S3 Objects that are being imported.", "type": "string" } }, @@ -255,14 +350,38 @@ }, "SSESpecification": { "additionalProperties": false, + "description": "Represents the settings used to enable server-side encryption.", "properties": { "KMSMasterKeyId": { + "anyOf": [ + { + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::KMS::Key" + } + }, + { + "relationshipRef": { + "propertyPath": "/properties/KeyId", + "typeName": "AWS::KMS::Key" + } + }, + { + "relationshipRef": { + "propertyPath": "/properties/AliasName", + "typeName": "AWS::KMS::Alias" + } + } + ], + "description": "The KMS key that should be used for the KMS encryption. To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB key ``alias/aws/dynamodb``.", "type": "string" }, "SSEEnabled": { + "description": "Indicates whether server-side encryption is done using an AWS managed key or an AWS owned key. If enabled (true), server-side encryption type is set to ``KMS`` and an AWS managed key is used (KMS charges apply). If disabled (false) or not specified, server-side encryption is set to AWS owned key.", "type": "boolean" }, "SSEType": { + "description": "Server-side encryption type. The only supported value is:\n + ``KMS`` - Server-side encryption that uses KMSlong. The key is stored in your account and is managed by KMS (KMS charges apply).", "type": "string" } }, @@ -273,8 +392,14 @@ }, "StreamSpecification": { "additionalProperties": false, + "description": "Represents the DynamoDB Streams configuration for a table in DynamoDB.", "properties": { + "ResourcePolicy": { + "$ref": "#/definitions/ResourcePolicy", + "description": "Creates or updates a resource-based policy document that contains the permissions for DDB resources, such as a table's streams. Resource-based policies let you define access permissions by specifying who has access to each resource, and the actions they are allowed to perform on each resource.\n In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see [Using resource-based policies for](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html)." + }, "StreamViewType": { + "description": "When an item in the table is modified, ``StreamViewType`` determines what information is written to the stream for this table. Valid values for ``StreamViewType`` are:\n + ``KEYS_ONLY`` - Only the key attributes of the modified item are written to the stream.\n + ``NEW_IMAGE`` - The entire item, as it appears after it was modified, is written to the stream.\n + ``OLD_IMAGE`` - The entire item, as it appeared before it was modified, is written to the stream.\n + ``NEW_AND_OLD_IMAGES`` - Both the new and the old item images of the item are written to the stream.", "type": "string" } }, @@ -285,11 +410,14 @@ }, "Tag": { "additionalProperties": false, + "description": "Describes a tag. A tag is a key-value pair. You can add up to 50 tags to a single DynamoDB table. \n AWS-assigned tag names and values are automatically assigned the ``aws:`` prefix, which the user cannot assign. AWS-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the prefix ``user:`` in the Cost Allocation Report. You cannot backdate the application of a tag.\n For an overview on tagging DynamoDB resources, see [Tagging for DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html) in the *Amazon DynamoDB Developer Guide*.", "properties": { "Key": { + "description": "The key of the tag. Tag keys are case sensitive. Each DynamoDB table can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.", "type": "string" }, "Value": { + "description": "The value of the tag. Tag values are case-sensitive and can be null.", "type": "string" } }, @@ -301,11 +429,14 @@ }, "TimeToLiveSpecification": { "additionalProperties": false, + "description": "Represents the settings used to enable or disable Time to Live (TTL) for the specified table.", "properties": { "AttributeName": { + "description": "The name of the TTL attribute used to store the expiration time for items in the table.\n + The ``AttributeName`` property is required when enabling the TTL, or when TTL is already enabled.\n + To update this property, you must first disable TTL and then enable TTL with the new attribute name.", "type": "string" }, "Enabled": { + "description": "Indicates whether TTL is to be enabled (true) or disabled (false) on the table.", "type": "boolean" } }, @@ -315,7 +446,7 @@ "type": "object" } }, - "description": "Version: None. Resource Type definition for AWS::DynamoDB::Table", + "description": "The ``AWS::DynamoDB::Table`` resource creates a DDB table. For more information, see [CreateTable](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_CreateTable.html) in the *API Reference*.\n You should be aware of the following behaviors when working with DDB tables:\n + CFNlong typically creates DDB tables in parallel. However, if your template includes multiple DDB tables with indexes, you must declare dependencies so that the tables are created sequentially. DDBlong limits the number of tables with secondary indexes that are in the creating state. If you create multiple tables with indexes at the same time, DDB returns an error and the stack operation fails. For an 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 \n Our guidance is to use the latest schema documented here for your CFNlong templates. This schema supports the provisioning of all table settings below. When using this schema in your CFNlong templates, please ensure that your Identity and Access Management (IAM) policies are updated with appropriate permissions to allow for the authorization of these setting changes.", "handlers": { "create": { "permissions": [ @@ -335,6 +466,8 @@ "dynamodb:ListTagsOfResource", "dynamodb:TagResource", "dynamodb:UpdateTable", + "dynamodb:GetResourcePolicy", + "dynamodb:PutResourcePolicy", "kinesis:DescribeStream", "kinesis:PutRecords", "iam:CreateServiceLinkedRole", @@ -374,7 +507,8 @@ "dynamodb:DescribeContinuousBackups", "dynamodb:DescribeContributorInsights", "dynamodb:DescribeKinesisStreamingDestination", - "dynamodb:ListTagsOfResource" + "dynamodb:ListTagsOfResource", + "dynamodb:GetResourcePolicy" ] }, "update": { @@ -385,6 +519,7 @@ "dynamodb:UpdateTimeToLive", "dynamodb:UpdateContinuousBackups", "dynamodb:UpdateContributorInsights", + "dynamodb:UpdateKinesisStreamingDestination", "dynamodb:DescribeContinuousBackups", "dynamodb:DescribeKinesisStreamingDestination", "dynamodb:ListTagsOfResource", @@ -393,6 +528,9 @@ "dynamodb:DescribeContributorInsights", "dynamodb:EnableKinesisStreamingDestination", "dynamodb:DisableKinesisStreamingDestination", + "dynamodb:GetResourcePolicy", + "dynamodb:PutResourcePolicy", + "dynamodb:DeleteResourcePolicy", "kinesis:DescribeStream", "kinesis:PutRecords", "iam:CreateServiceLinkedRole", @@ -409,9 +547,11 @@ ], "properties": { "Arn": { + "description": "", "type": "string" }, "AttributeDefinitions": { + "description": "A list of attributes that describe the key schema for the table and indexes.\n This property is required to create a DDB table.\n Update requires: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt). Replacement if you edit an existing AttributeDefinition.", "items": { "$ref": "#/definitions/AttributeDefinition" }, @@ -419,15 +559,19 @@ "uniqueItems": true }, "BillingMode": { + "description": "Specify how you are charged for read and write throughput and how you manage capacity.\n Valid values include:\n + ``PROVISIONED`` - We recommend using ``PROVISIONED`` for predictable workloads. ``PROVISIONED`` sets the billing mode to [Provisioned Mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.ProvisionedThroughput.Manual).\n + ``PAY_PER_REQUEST`` - We recommend using ``PAY_PER_REQUEST`` for unpredictable workloads. ``PAY_PER_REQUEST`` sets the billing mode to [On-Demand Mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.OnDemand).\n \n If not specified, the default is ``PROVISIONED``.", "type": "string" }, "ContributorInsightsSpecification": { - "$ref": "#/definitions/ContributorInsightsSpecification" + "$ref": "#/definitions/ContributorInsightsSpecification", + "description": "The settings used to enable or disable CloudWatch Contributor Insights for the specified table." }, "DeletionProtectionEnabled": { + "description": "Determines if a table is protected from deletion. When enabled, the table cannot be deleted by any user or process. This setting is disabled by default. For more information, see [Using deletion protection](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html#WorkingWithTables.Basics.DeletionProtection) in the *Developer Guide*.", "type": "boolean" }, "GlobalSecondaryIndexes": { + "description": "Global secondary indexes to be created on the table. You can create up to 20 global secondary indexes.\n If you update a table to include a new global secondary index, CFNlong initiates the index creation and then proceeds with the stack update. CFNlong doesn't wait for the index to complete creation because the backfilling phase can take a long time, depending on the size of the table. You can't use the index or update the table until the index's status is ``ACTIVE``. You can track its status by using the DynamoDB [DescribeTable](https://docs.aws.amazon.com/cli/latest/reference/dynamodb/describe-table.html) command.\n If you add or delete an index during an update, we recommend that you don't update any other resources. If your stack fails to update and is rolled back while adding a new index, you must manually delete the index. \n Updates are not supported. The following are exceptions:\n + If you update either the contributor insights specification or the provisioned throughput values of global secondary indexes, you can update the table without interruption.\n + You can delete or add one global secondary index without interruption. If you do both in the same update (for example, by changing the index's logical ID), the update fails.", "items": { "$ref": "#/definitions/GlobalSecondaryIndex" }, @@ -435,9 +579,11 @@ "uniqueItems": false }, "ImportSourceSpecification": { - "$ref": "#/definitions/ImportSourceSpecification" + "$ref": "#/definitions/ImportSourceSpecification", + "description": "Specifies the properties of data being imported from the S3 bucket source to the table.\n If you specify the ``ImportSourceSpecification`` property, and also specify either the ``StreamSpecification``, the ``TableClass`` property, or the ``DeletionProtectionEnabled`` property, the IAM entity creating/updating stack must have ``UpdateTable`` permission." }, "KeySchema": { + "description": "Specifies the attributes that make up the primary key for the table. The attributes in the ``KeySchema`` property must also be defined in the ``AttributeDefinitions`` property.", "oneOf": [ { "items": { @@ -452,37 +598,55 @@ ] }, "KinesisStreamSpecification": { - "$ref": "#/definitions/KinesisStreamSpecification" + "$ref": "#/definitions/KinesisStreamSpecification", + "description": "The Kinesis Data Streams configuration for the specified table." }, "LocalSecondaryIndexes": { + "description": "Local secondary indexes to be created on the table. You can create up to 5 local secondary indexes. Each index is scoped to a given hash key value. The size of each hash key can be up to 10 gigabytes.", "items": { "$ref": "#/definitions/LocalSecondaryIndex" }, "type": "array", "uniqueItems": false }, + "OnDemandThroughput": { + "$ref": "#/definitions/OnDemandThroughput", + "description": "Sets the maximum number of read and write units for the specified on-demand table. If you use this property, you must specify ``MaxReadRequestUnits``, ``MaxWriteRequestUnits``, or both." + }, "PointInTimeRecoverySpecification": { - "$ref": "#/definitions/PointInTimeRecoverySpecification" + "$ref": "#/definitions/PointInTimeRecoverySpecification", + "description": "The settings used to enable point in time recovery." }, "ProvisionedThroughput": { - "$ref": "#/definitions/ProvisionedThroughput" + "$ref": "#/definitions/ProvisionedThroughput", + "description": "Throughput for the specified table, which consists of values for ``ReadCapacityUnits`` and ``WriteCapacityUnits``. For more information about the contents of a provisioned throughput structure, see [Amazon DynamoDB Table ProvisionedThroughput](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ProvisionedThroughput.html). \n If you set ``BillingMode`` as ``PROVISIONED``, you must specify this property. If you set ``BillingMode`` as ``PAY_PER_REQUEST``, you cannot specify this property." + }, + "ResourcePolicy": { + "$ref": "#/definitions/ResourcePolicy", + "description": "A resource-based policy document that contains permissions to add to the specified table. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see [Using resource-based policies for](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html).\n When you attach a resource-based policy while creating a table, the policy creation is *strongly consistent*. For information about the considerations that you should keep in mind while attaching a resource-based policy, see [Resource-based policy considerations](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html)." }, "SSESpecification": { - "$ref": "#/definitions/SSESpecification" + "$ref": "#/definitions/SSESpecification", + "description": "Specifies the settings to enable server-side encryption." }, "StreamArn": { + "description": "", "type": "string" }, "StreamSpecification": { - "$ref": "#/definitions/StreamSpecification" + "$ref": "#/definitions/StreamSpecification", + "description": "The settings for the DDB table stream, which capture changes to items stored in the table." }, "TableClass": { + "description": "The table class of the new table. Valid values are ``STANDARD`` and ``STANDARD_INFREQUENT_ACCESS``.", "type": "string" }, "TableName": { + "description": "A name for the table. If you don't specify a name, CFNlong generates a unique physical ID and uses that ID for the table name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).\n If 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.", "type": "string" }, "Tags": { + "description": "An array of key-value pairs to apply to this resource.\n For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).", "items": { "$ref": "#/definitions/Tag" }, @@ -490,7 +654,8 @@ "uniqueItems": false }, "TimeToLiveSpecification": { - "$ref": "#/definitions/TimeToLiveSpecification" + "$ref": "#/definitions/TimeToLiveSpecification", + "description": "Specifies the Time to Live (TTL) settings for the table.\n For detailed information about the limits in DynamoDB, see [Limits in Amazon DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) in the Amazon DynamoDB Developer Guide." } }, "propertyTransform": { diff --git a/artifacts/types/AWS::EC2::CapacityReservation.json b/artifacts/types/AWS::EC2::CapacityReservation.json index c7382393..7e7ae668 100644 --- a/artifacts/types/AWS::EC2::CapacityReservation.json +++ b/artifacts/types/AWS::EC2::CapacityReservation.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-CapacityReservation", "type": "AWS::EC2::CapacityReservation", - "time": "2024-01-04T19:09:57.097Z", + "time": "2024-03-27T15:33:32.923Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::EC2::CapacityReservationFleet.json b/artifacts/types/AWS::EC2::CapacityReservationFleet.json index 4e1711bb..1d4ff44e 100644 --- a/artifacts/types/AWS::EC2::CapacityReservationFleet.json +++ b/artifacts/types/AWS::EC2::CapacityReservationFleet.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-CapacityReservationFleet", "type": "AWS::EC2::CapacityReservationFleet", - "time": "2024-01-05T00:08:11.684Z", + "time": "2024-04-02T16:42:25.791Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::EC2::CarrierGateway.json b/artifacts/types/AWS::EC2::CarrierGateway.json index b541dfeb..58c712b3 100644 --- a/artifacts/types/AWS::EC2::CarrierGateway.json +++ b/artifacts/types/AWS::EC2::CarrierGateway.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-CarrierGateway", "type": "AWS::EC2::CarrierGateway", - "time": "2023-10-26T14:30:55.045Z", + "time": "2024-06-12T14:25:15.395Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::EC2::CustomerGateway.json b/artifacts/types/AWS::EC2::CustomerGateway.json index 2f7c93fb..ae5f20f8 100644 --- a/artifacts/types/AWS::EC2::CustomerGateway.json +++ b/artifacts/types/AWS::EC2::CustomerGateway.json @@ -1,11 +1,13 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-CustomerGateway", "type": "AWS::EC2::CustomerGateway", - "time": "2023-07-25T15:04:53.457Z", + "time": "2024-06-13T16:19:20.448Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ + "/properties/CertificateArn", "/properties/BgpAsn", + "/properties/BgpAsnExtended", "/properties/Type", "/properties/IpAddress", "/properties/DeviceName" @@ -13,11 +15,14 @@ "definitions": { "Tag": { "additionalProperties": false, + "description": "Specifies a tag. For more information, see [Add tags to a resource](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#cloudformation-add-tag-specifications).", "properties": { "Key": { + "description": "The tag key.", "type": "string" }, "Value": { + "description": "The tag value.", "type": "string" } }, @@ -28,18 +33,20 @@ "type": "object" } }, - "description": "Resource Type definition for AWS::EC2::CustomerGateway", + "description": "Specifies a customer gateway.", "handlers": { "create": { "permissions": [ "ec2:CreateCustomerGateway", - "ec2:DescribeCustomerGateways" + "ec2:DescribeCustomerGateways", + "ec2:CreateTags" ] }, "delete": { "permissions": [ "ec2:DeleteCustomerGateway", - "ec2:DescribeCustomerGateways" + "ec2:DescribeCustomerGateways", + "ec2:DeleteTags" ] }, "list": { @@ -55,7 +62,8 @@ "update": { "permissions": [ "ec2:CreateTags", - "ec2:DeleteTags" + "ec2:DeleteTags", + "ec2:DescribeCustomerGateways" ] } }, @@ -65,19 +73,31 @@ "properties": { "BgpAsn": { "default": 65000, - "description": "For devices that support BGP, the customer gateway's BGP ASN.", + "description": "For 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``.\n Default: 65000\n Valid values: ``1`` to ``2,147,483,647``", "type": "integer" }, + "BgpAsnExtended": { + "description": "For 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``.\n Valid values: ``2,147,483,648`` to ``4,294,967,295``", + "maximum": 4294967294, + "minimum": 2147483648, + "multipleOf": 1, + "type": "number" + }, + "CertificateArn": { + "description": "The Amazon Resource Name (ARN) for the customer gateway certificate.", + "pattern": "^arn:(aws[a-zA-Z-]*)?:acm:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}:\\d{12}:certificate\\/[a-zA-Z0-9-_]+$", + "type": "string" + }, "CustomerGatewayId": { - "description": "CustomerGateway ID generated after customer gateway is created. Each customer gateway has a unique ID.", + "description": "", "type": "string" }, "DeviceName": { - "description": "A name for the customer gateway device.", + "description": "The name of customer gateway device.", "type": "string" }, "IpAddress": { - "description": "The internet-routable IP address for the customer gateway's outside interface. The address must be static.", + "description": "IPv4 address for the customer gateway device's outside interface. The address must be static. If ``OutsideIpAddressType`` in your VPN connection options is set to ``PrivateIpv4``, you can use an RFC6598 or RFC1918 private IPv4 address. If ``OutsideIpAddressType`` is set to ``PublicIpv4``, you can use a public IPv4 address.", "type": "string" }, "Tags": { @@ -90,7 +110,7 @@ "uniqueItems": false }, "Type": { - "description": "The type of VPN connection that this customer gateway supports.", + "description": "The type of VPN connection that this customer gateway supports (``ipsec.1``).", "type": "string" } }, @@ -98,7 +118,6 @@ "/properties/CustomerGatewayId" ], "required": [ - "BgpAsn", "IpAddress", "Type" ], diff --git a/artifacts/types/AWS::EC2::DHCPOptions.json b/artifacts/types/AWS::EC2::DHCPOptions.json index 49129ced..b2f34185 100644 --- a/artifacts/types/AWS::EC2::DHCPOptions.json +++ b/artifacts/types/AWS::EC2::DHCPOptions.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-DHCPOptions", "type": "AWS::EC2::DHCPOptions", - "time": "2024-01-02T21:06:22.382Z", + "time": "2024-06-03T17:44:43.551Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -9,7 +9,8 @@ "/properties/NetbiosNodeType", "/properties/NtpServers", "/properties/DomainName", - "/properties/DomainNameServers" + "/properties/DomainNameServers", + "/properties/Ipv6AddressPreferredLeaseTime" ], "definitions": { "Tag": { @@ -87,6 +88,10 @@ "type": "array", "uniqueItems": true }, + "Ipv6AddressPreferredLeaseTime": { + "description": "The preferred Lease Time for ipV6 address in seconds.", + "type": "integer" + }, "NetbiosNameServers": { "description": "The IPv4 addresses of up to four NetBIOS name servers.", "items": { @@ -120,7 +125,13 @@ "readOnlyProperties": [ "/properties/DhcpOptionsId" ], - "taggable": true, + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, "typeName": "AWS::EC2::DHCPOptions" } } \ No newline at end of file diff --git a/artifacts/types/AWS::EC2::EC2Fleet.json b/artifacts/types/AWS::EC2::EC2Fleet.json index eaa945a5..2f902688 100644 --- a/artifacts/types/AWS::EC2::EC2Fleet.json +++ b/artifacts/types/AWS::EC2::EC2Fleet.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-EC2Fleet", "type": "AWS::EC2::EC2Fleet", - "time": "2023-11-16T00:30:09.513Z", + "time": "2024-06-18T15:14:47.885Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -284,6 +284,9 @@ "type": "array", "uniqueItems": false }, + "MaxSpotPriceAsPercentageOfOptimalOnDemandPrice": { + "type": "integer" + }, "MemoryGiBPerVCpu": { "$ref": "#/definitions/MemoryGiBPerVCpuRequest" }, diff --git a/artifacts/types/AWS::EC2::EIP.json b/artifacts/types/AWS::EC2::EIP.json index 7f7653c6..b612e444 100644 --- a/artifacts/types/AWS::EC2::EIP.json +++ b/artifacts/types/AWS::EC2::EIP.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-EIP", "type": "AWS::EC2::EIP", - "time": "2023-12-19T16:33:39.757Z", + "time": "2024-06-13T15:30:37.17Z", "schema": { "$schema": "https://raw.githubusercontent.com/aws-cloudformation/cloudformation-resource-schema/blob/master/src/main/resources/schema/provider.definition.schema.v1.json", "additionalProperties": false, @@ -13,11 +13,14 @@ "definitions": { "Tag": { "additionalProperties": false, + "description": "Specifies a tag. For more information, see [Add tags to a resource](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#cloudformation-add-tag-specifications).", "properties": { "Key": { + "description": "The tag key.", "type": "string" }, "Value": { + "description": "The tag value.", "type": "string" } }, @@ -28,7 +31,7 @@ "type": "object" } }, - "description": "Resource Type definition for AWS::EC2::EIP", + "description": "Specifies an Elastic IP (EIP) address and can, optionally, associate it with an Amazon EC2 instance.\n You 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 to AWS for use with your AWS resources using bring your own IP addresses (BYOIP). For more information, see [Bring Your Own IP Addresses (BYOIP)](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html) in the *Amazon EC2 User Guide*.\n For more information, see [Elastic IP Addresses](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) in the *Amazon EC2 User Guide*.", "handlers": { "create": { "permissions": [ @@ -72,31 +75,31 @@ ], "properties": { "AllocationId": { - "description": "The Allocation ID of the EIP generated by resource.", + "description": "", "type": "string" }, "Domain": { - "description": "Indicates whether the Elastic IP address is for use with instances in a VPC or instance in EC2-Classic.", + "description": "The network (``vpc``).\n If you define an Elastic IP address and associate it with a VPC that is defined in the same template, you must declare a dependency on the VPC-gateway attachment by using the [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) on this resource.", "type": "string" }, "InstanceId": { - "description": "The ID of the instance.", + "description": "The ID of the instance.\n Updates to the ``InstanceId`` property may require *some interruptions*. Updates on an EIP reassociates the address on its associated resource.", "type": "string" }, "NetworkBorderGroup": { - "description": "A unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses.", + "description": "A unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses. Use this parameter to limit the IP address to this location. IP addresses cannot move between network border groups.\n Use [DescribeAvailabilityZones](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeAvailabilityZones.html) to view the network border groups.", "type": "string" }, "PublicIp": { - "description": "The PublicIP of the EIP generated by resource.", + "description": "", "type": "string" }, "PublicIpv4Pool": { - "description": "The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool.", + "description": "The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool.\n Updates to the ``PublicIpv4Pool`` property may require *some interruptions*. Updates on an EIP reassociates the address on its associated resource.", "type": "string" }, "Tags": { - "description": "Any tags assigned to the EIP.", + "description": "Any tags assigned to the Elastic IP address.\n Updates to the ``Tags`` property may require *some interruptions*. Updates on an EIP reassociates the address on its associated resource.", "insertionOrder": false, "items": { "$ref": "#/definitions/Tag" @@ -105,7 +108,7 @@ "uniqueItems": false }, "TransferAddress": { - "description": "The PublicIP of the EIP generated by resource through transfer from another account", + "description": "The Elastic IP address you are accepting for transfer. You can only accept one transferred address. For more information on Elastic IP address transfers, see [Transfer Elastic IP addresses](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#transfer-EIPs-intro) in the *Amazon Virtual Private Cloud User Guide*.", "type": "string" } }, diff --git a/artifacts/types/AWS::EC2::FlowLog.json b/artifacts/types/AWS::EC2::FlowLog.json index 1bd86edb..89a5ea2c 100644 --- a/artifacts/types/AWS::EC2::FlowLog.json +++ b/artifacts/types/AWS::EC2::FlowLog.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-FlowLog", "type": "AWS::EC2::FlowLog", - "time": "2023-12-28T06:41:13.767Z", + "time": "2024-06-20T14:00:13.189Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::EC2::GatewayRouteTableAssociation.json b/artifacts/types/AWS::EC2::GatewayRouteTableAssociation.json index 87d9d22e..3af87827 100644 --- a/artifacts/types/AWS::EC2::GatewayRouteTableAssociation.json +++ b/artifacts/types/AWS::EC2::GatewayRouteTableAssociation.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-GatewayRouteTableAssociation", "type": "AWS::EC2::GatewayRouteTableAssociation", - "time": "2024-01-03T16:25:08.62Z", + "time": "2024-06-20T15:48:22.115Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -58,6 +58,12 @@ "GatewayId" ], "sourceUrl": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-gatewayroutetableassociation.html", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, "typeName": "AWS::EC2::GatewayRouteTableAssociation" } } \ No newline at end of file diff --git a/artifacts/types/AWS::EC2::IPAM.json b/artifacts/types/AWS::EC2::IPAM.json index ef2b1242..67f872a9 100644 --- a/artifacts/types/AWS::EC2::IPAM.json +++ b/artifacts/types/AWS::EC2::IPAM.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-IPAM", "type": "AWS::EC2::IPAM", - "time": "2023-12-05T16:29:12.683Z", + "time": "2024-06-19T15:52:17.939Z", "schema": { "additionalProperties": false, "definitions": { diff --git a/artifacts/types/AWS::EC2::IPAMPool.json b/artifacts/types/AWS::EC2::IPAMPool.json index 20234498..55544eb2 100644 --- a/artifacts/types/AWS::EC2::IPAMPool.json +++ b/artifacts/types/AWS::EC2::IPAMPool.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-IPAMPool", "type": "AWS::EC2::IPAMPool", - "time": "2023-12-05T16:56:13.711Z", + "time": "2024-06-19T17:30:16.568Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -11,7 +11,8 @@ "/properties/AddressFamily", "/properties/PubliclyAdvertisable", "/properties/PublicIpSource", - "/properties/AwsService" + "/properties/AwsService", + "/properties/SourceResource" ], "definitions": { "Cidr": { @@ -31,6 +32,31 @@ ], "type": "object" }, + "SourceResource": { + "additionalProperties": false, + "description": "The resource associated with this pool's space. Depending on the ResourceType, setting a SourceResource changes which space can be provisioned in this pool and which types of resources can receive allocations", + "properties": { + "ResourceId": { + "type": "string" + }, + "ResourceOwner": { + "type": "string" + }, + "ResourceRegion": { + "type": "string" + }, + "ResourceType": { + "type": "string" + } + }, + "required": [ + "ResourceId", + "ResourceType", + "ResourceRegion", + "ResourceOwner" + ], + "type": "object" + }, "Tag": { "additionalProperties": false, "description": "A key-value pair to associate with a resource.", @@ -202,6 +228,9 @@ "description": "The Id of this pool's source. If set, all space provisioned in this pool must be free space provisioned in the parent pool.", "type": "string" }, + "SourceResource": { + "$ref": "#/definitions/SourceResource" + }, "State": { "description": "The state of this pool. This can be one of the following values: \"create-in-progress\", \"create-complete\", \"modify-in-progress\", \"modify-complete\", \"delete-in-progress\", or \"delete-complete\"", "enum": [ diff --git a/artifacts/types/AWS::EC2::IPAMResourceDiscovery.json b/artifacts/types/AWS::EC2::IPAMResourceDiscovery.json index 3ff0c7ae..fe2ee0ea 100644 --- a/artifacts/types/AWS::EC2::IPAMResourceDiscovery.json +++ b/artifacts/types/AWS::EC2::IPAMResourceDiscovery.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-IPAMResourceDiscovery", "type": "AWS::EC2::IPAMResourceDiscovery", - "time": "2023-12-05T16:26:13.307Z", + "time": "2024-06-19T15:51:45.842Z", "schema": { "additionalProperties": false, "definitions": { diff --git a/artifacts/types/AWS::EC2::IPAMResourceDiscoveryAssociation.json b/artifacts/types/AWS::EC2::IPAMResourceDiscoveryAssociation.json index a7a22955..6adbd2dd 100644 --- a/artifacts/types/AWS::EC2::IPAMResourceDiscoveryAssociation.json +++ b/artifacts/types/AWS::EC2::IPAMResourceDiscoveryAssociation.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-IPAMResourceDiscoveryAssociation", "type": "AWS::EC2::IPAMResourceDiscoveryAssociation", - "time": "2023-12-05T16:27:12.534Z", + "time": "2024-06-19T15:51:32.563Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::EC2::IPAMScope.json b/artifacts/types/AWS::EC2::IPAMScope.json index a0227013..f2061105 100644 --- a/artifacts/types/AWS::EC2::IPAMScope.json +++ b/artifacts/types/AWS::EC2::IPAMScope.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-IPAMScope", "type": "AWS::EC2::IPAMScope", - "time": "2023-12-05T16:26:41.278Z", + "time": "2024-06-19T15:51:41.839Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::EC2::Instance.json b/artifacts/types/AWS::EC2::Instance.json index cc97ac6a..b7937055 100644 --- a/artifacts/types/AWS::EC2::Instance.json +++ b/artifacts/types/AWS::EC2::Instance.json @@ -1,37 +1,55 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-Instance", "type": "AWS::EC2::Instance", - "time": "2023-12-14T20:42:38.976Z", + "time": "2024-06-17T16:48:43.389Z", "schema": { + "$schema": "https://schema.cloudformation.us-east-1.amazonaws.com/provider.definition.schema.v1.json", "additionalProperties": false, + "conditionalCreateOnlyProperties": [ + "/properties/AdditionalInfo", + "/properties/Affinity", + "/properties/EbsOptimized", + "/properties/HostId", + "/properties/InstanceType", + "/properties/KernelId", + "/properties/PrivateDnsNameOptions", + "/properties/RamdiskId", + "/properties/SecurityGroupIds", + "/properties/Tenancy", + "/properties/UserData", + "/properties/BlockDeviceMappings" + ], "createOnlyProperties": [ - "/properties/ElasticGpuSpecifications", - "/properties/Ipv6Addresses", - "/properties/PlacementGroupName", - "/properties/HostResourceGroupArn", - "/properties/ImageId", + "/properties/AvailabilityZone", "/properties/CpuOptions", - "/properties/PrivateIpAddress", + "/properties/ElasticGpuSpecifications", "/properties/ElasticInferenceAccelerators", "/properties/EnclaveOptions", "/properties/HibernationOptions", + "/properties/HostResourceGroupArn", + "/properties/ImageId", + "/properties/Ipv6AddressCount", + "/properties/Ipv6Addresses", "/properties/KeyName", + "/properties/LaunchTemplate", "/properties/LicenseSpecifications", "/properties/NetworkInterfaces", - "/properties/AvailabilityZone", - "/properties/SubnetId", - "/properties/LaunchTemplate", + "/properties/PlacementGroupName", + "/properties/PrivateIpAddress", "/properties/SecurityGroups", - "/properties/Ipv6AddressCount" + "/properties/SubnetId" ], "definitions": { "AssociationParameter": { "additionalProperties": false, "properties": { "Key": { + "description": "The name of an input parameter that is in the associated SSM document.", "type": "string" }, "Value": { + "description": "The value of an input parameter.", + "insertionOrder": false, "items": { "type": "string" }, @@ -49,13 +67,16 @@ "additionalProperties": false, "properties": { "DeviceName": { + "description": "The device name (for example, /dev/sdh or xvdh).", "type": "string" }, "Ebs": { - "$ref": "#/definitions/Ebs" + "$ref": "#/definitions/Ebs", + "description": "Parameters used to automatically set up EBS volumes when the instance is launched." }, "NoDevice": { - "$ref": "#/definitions/NoDevice" + "additionalProperties": false, + "type": "object" }, "VirtualName": { "type": "string" @@ -66,49 +87,35 @@ ], "type": "object" }, - "CpuOptions": { - "additionalProperties": false, - "properties": { - "CoreCount": { - "type": "integer" - }, - "ThreadsPerCore": { - "type": "integer" - } - }, - "type": "object" - }, - "CreditSpecification": { - "additionalProperties": false, - "properties": { - "CPUCredits": { - "type": "string" - } - }, - "type": "object" - }, "Ebs": { "additionalProperties": false, "properties": { "DeleteOnTermination": { + "description": "Indicates whether the EBS volume is deleted on instance termination.", "type": "boolean" }, "Encrypted": { + "description": "Indicates whether the volume should be encrypted.", "type": "boolean" }, "Iops": { + "description": "The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.", "type": "integer" }, "KmsKeyId": { + "description": "The identifier of the AWS Key Management Service (AWS KMS) customer managed CMK to use for Amazon EBS encryption. If KmsKeyId is specified, the encrypted state must be true. If the encrypted state is true but you do not specify KmsKeyId, your AWS managed CMK for EBS is used.", "type": "string" }, "SnapshotId": { + "description": "The ID of the snapshot.", "type": "string" }, "VolumeSize": { + "description": "The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.", "type": "integer" }, "VolumeType": { + "description": "The volume type.", "type": "string" } }, @@ -118,6 +125,7 @@ "additionalProperties": false, "properties": { "Type": { + "description": "The type of Elastic Graphics accelerator.", "type": "string" } }, @@ -130,9 +138,12 @@ "additionalProperties": false, "properties": { "Count": { + "description": "The number of elastic inference accelerators to attach to the instance.", + "minimum": 0, "type": "integer" }, "Type": { + "description": "The type of elastic inference accelerator.", "type": "string" } }, @@ -141,28 +152,11 @@ ], "type": "object" }, - "EnclaveOptions": { - "additionalProperties": false, - "properties": { - "Enabled": { - "type": "boolean" - } - }, - "type": "object" - }, - "HibernationOptions": { - "additionalProperties": false, - "properties": { - "Configured": { - "type": "boolean" - } - }, - "type": "object" - }, "InstanceIpv6Address": { "additionalProperties": false, "properties": { "Ipv6Address": { + "description": "The IPv6 address.", "type": "string" } }, @@ -173,26 +167,41 @@ }, "LaunchTemplateSpecification": { "additionalProperties": false, + "oneOf": [ + { + "required": [ + "LaunchTemplateName", + "Version" + ] + }, + { + "required": [ + "LaunchTemplateId", + "Version" + ] + } + ], "properties": { "LaunchTemplateId": { + "description": "The ID of the launch template. You must specify the LaunchTemplateName or the LaunchTemplateId, but not both.", "type": "string" }, "LaunchTemplateName": { + "description": "The name of the launch template. You must specify the LaunchTemplateName or the LaunchTemplateId, but not both.", "type": "string" }, "Version": { + "description": "The version number of the launch template.", "type": "string" } }, - "required": [ - "Version" - ], "type": "object" }, "LicenseSpecification": { "additionalProperties": false, "properties": { "LicenseConfigurationArn": { + "description": "The Amazon Resource Name (ARN) of the license configuration.", "type": "string" } }, @@ -205,21 +214,28 @@ "additionalProperties": false, "properties": { "AssociateCarrierIpAddress": { + "description": "Not currently supported by AWS CloudFormation.", "type": "boolean" }, "AssociatePublicIpAddress": { + "description": "Indicates whether to assign a public IPv4 address to an instance you launch in a VPC.", "type": "boolean" }, "DeleteOnTermination": { + "description": "If set to true, the interface is deleted when the instance is terminated.", "type": "boolean" }, "Description": { + "description": "The description of the network interface.", "type": "string" }, "DeviceIndex": { + "description": "The position of the network interface in the attachment order. A primary network interface has a device index of 0.", "type": "string" }, "GroupSet": { + "description": "The IDs of the security groups for the network interface.", + "insertionOrder": false, "items": { "type": "string" }, @@ -227,9 +243,12 @@ "uniqueItems": false }, "Ipv6AddressCount": { + "description": "A number of IPv6 addresses to assign to the network interface.", "type": "integer" }, "Ipv6Addresses": { + "description": "The IPv6 addresses associated with the network interface.", + "insertionOrder": false, "items": { "$ref": "#/definitions/InstanceIpv6Address" }, @@ -237,12 +256,16 @@ "uniqueItems": false }, "NetworkInterfaceId": { + "description": "The ID of the network interface.", "type": "string" }, "PrivateIpAddress": { + "description": "The private IPv4 address of the network interface.", "type": "string" }, "PrivateIpAddresses": { + "description": "One or more private IPv4 addresses to assign to the network interface.", + "insertionOrder": false, "items": { "$ref": "#/definitions/PrivateIpAddressSpecification" }, @@ -250,9 +273,11 @@ "uniqueItems": false }, "SecondaryPrivateIpAddressCount": { + "description": "The number of secondary private IPv4 addresses.", "type": "integer" }, "SubnetId": { + "description": "The ID of the subnet.", "type": "string" } }, @@ -261,20 +286,23 @@ ], "type": "object" }, - "NoDevice": { - "additionalProperties": false, - "type": "object" - }, "PrivateDnsNameOptions": { "additionalProperties": false, "properties": { "EnableResourceNameDnsAAAARecord": { + "description": "Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records. For more information, see Amazon EC2 instance hostname types in the Amazon Elastic Compute Cloud User Guide.", "type": "boolean" }, "EnableResourceNameDnsARecord": { + "description": "Indicates whether to respond to DNS queries for instance hostnames with DNS A records. For more information, see Amazon EC2 instance hostname types in the Amazon Elastic Compute Cloud User Guide.", "type": "boolean" }, "HostnameType": { + "description": "The type of hostnames to assign to instances in the subnet at launch. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID. For more information, see Amazon EC2 instance hostname types in the Amazon Elastic Compute Cloud User Guide.", + "enum": [ + "ip-name", + "resource-name" + ], "type": "string" } }, @@ -284,9 +312,11 @@ "additionalProperties": false, "properties": { "Primary": { + "description": "Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.", "type": "boolean" }, "PrivateIpAddress": { + "description": "The private IPv4 addresses.", "type": "string" } }, @@ -300,6 +330,8 @@ "additionalProperties": false, "properties": { "AssociationParameters": { + "description": "The input parameter values to use with the associated SSM document.", + "insertionOrder": false, "items": { "$ref": "#/definitions/AssociationParameter" }, @@ -307,6 +339,7 @@ "uniqueItems": false }, "DocumentName": { + "description": "The name of an SSM document to associate with the instance.", "type": "string" } }, @@ -315,6 +348,21 @@ ], "type": "object" }, + "State": { + "additionalProperties": false, + "description": "The current state of the instance", + "properties": { + "Code": { + "description": "The state of the instance as a 16-bit unsigned integer.", + "type": "string" + }, + "Name": { + "description": "The current state of the instance.", + "type": "string" + } + }, + "type": "object" + }, "Tag": { "additionalProperties": false, "properties": { @@ -335,9 +383,11 @@ "additionalProperties": false, "properties": { "Device": { + "description": "The device name (for example, /dev/sdh or xvdh).", "type": "string" }, "VolumeId": { + "description": "The ID of the EBS volume. The volume and instance must be within the same Availability Zone.", "type": "string" } }, @@ -349,20 +399,137 @@ } }, "description": "Resource Type definition for AWS::EC2::Instance", + "handlers": { + "create": { + "permissions": [ + "iam:PassRole", + "ec2:ModifyPrivateDnsNameOptions", + "ec2:DescribeElasticGpus", + "ec2:DescribeNetworkInterfaces", + "ec2:DescribeVolumes", + "ec2:RunInstances", + "ec2:AssociateIamInstanceProfile", + "ec2:DescribeIamInstanceProfileAssociations", + "ec2:DescribeInstances", + "ec2:DescribeSubnets", + "ec2:DescribeKeyPairs", + "ec2:DescribeSecurityGroups", + "ec2:DescribeVpcs", + "ec2:DescribeInstanceAttribute", + "ec2:DescribeInstanceCreditSpecifications", + "ec2:DescribeLaunchTemplates", + "ec2:DescribeLaunchTemplateVersions", + "ec2:DetachVolume", + "ec2:DisassociateIamInstanceProfile", + "ec2:ModifyInstanceAttribute", + "ec2:ModifyInstanceCreditSpecification", + "ec2:ModifyInstancePlacement", + "ec2:MonitorInstances", + "ec2:AttachVolume", + "ec2:CreateTags", + "ec2:ReplaceIamInstanceProfileAssociation", + "ec2:StartInstances", + "elastic-inference:DescribeAccelerators", + "ssm:CreateAssociation", + "ssm:DescribeAssociation", + "ssm:ListAssociations" + ] + }, + "delete": { + "permissions": [ + "ec2:DescribeInstances", + "ec2:TerminateInstances", + "ec2:DescribeElasticGpus", + "ec2:DescribeNetworkInterfaces", + "ec2:DescribeVolumes", + "ec2:DescribeInstances", + "ec2:DescribeInstanceAttribute", + "ec2:DescribeInstanceCreditSpecifications", + "ec2:DescribeLaunchTemplates", + "elastic-inference:DescribeAccelerators", + "ssm:DescribeAssociation", + "ssm:ListAssociations" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeInstances" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeElasticGpus", + "ec2:DescribeNetworkInterfaces", + "ec2:DescribeVolumes", + "ec2:DescribeInstances", + "ec2:DescribeInstanceAttribute", + "ec2:DescribeInstanceCreditSpecifications", + "ec2:DescribeLaunchTemplates", + "elastic-inference:DescribeAccelerators", + "ssm:DescribeAssociation", + "ssm:ListAssociations" + ] + }, + "update": { + "permissions": [ + "ec2:DescribeElasticGpus", + "ec2:ModifyPrivateDnsNameOptions", + "ec2:DescribeNetworkInterfaces", + "ec2:AssociateIamInstanceProfile", + "ec2:DescribeIamInstanceProfileAssociations", + "ec2:DescribeInstances", + "ec2:DescribeSubnets", + "ec2:DescribeKeyPairs", + "ec2:DescribeSecurityGroups", + "ec2:DescribeVpcs", + "ec2:DescribeInstanceAttribute", + "ec2:DescribeInstanceCreditSpecifications", + "ec2:DescribeLaunchTemplates", + "ec2:DetachVolume", + "ec2:DisassociateIamInstanceProfile", + "ec2:ModifyInstanceAttribute", + "ec2:ModifyInstanceCreditSpecification", + "ec2:ModifyInstanceMaintenanceOptions", + "ec2:ModifyInstancePlacement", + "ec2:MonitorInstances", + "ec2:AttachVolume", + "ec2:CreateTags", + "ec2:DeleteTags", + "ec2:ReplaceIamInstanceProfileAssociation", + "ec2:StartInstances", + "ec2:StopInstances", + "ec2:UnmonitorInstances", + "elastic-inference:DescribeAccelerators", + "ssm:CreateAssociation", + "ssm:DeleteAssociation", + "ssm:DescribeAssociation", + "ssm:ListAssociations" + ] + } + }, "primaryIdentifier": [ - "/properties/Id" + "/properties/InstanceId" ], "properties": { "AdditionalInfo": { + "description": "This property is reserved for internal use. If you use it, the stack fails with this error: Bad property set: [Testing this property] (Service: AmazonEC2; Status Code: 400; Error Code: InvalidParameterCombination; Request ID: 0XXXXXX-49c7-4b40-8bcc-76885dcXXXXX).", "type": "string" }, "Affinity": { + "description": "Indicates whether the instance is associated with a dedicated host. If you want the instance to always restart on the same host on which it was launched, specify host. If you want the instance to restart on any available host, but try to launch onto the last host it ran on (on a best-effort basis), specify default.", + "enum": [ + "default", + "host" + ], "type": "string" }, "AvailabilityZone": { + "description": "The Availability Zone of the instance.", "type": "string" }, "BlockDeviceMappings": { + "description": "The block device mapping entries that defines the block devices to attach to the instance at launch.", + "insertionOrder": false, "items": { "$ref": "#/definitions/BlockDeviceMapping" }, @@ -370,62 +537,112 @@ "uniqueItems": false }, "CpuOptions": { - "$ref": "#/definitions/CpuOptions" + "additionalProperties": false, + "description": "The CPU options for the instance.", + "properties": { + "CoreCount": { + "type": "integer" + }, + "ThreadsPerCore": { + "type": "integer" + } + }, + "type": "object" }, "CreditSpecification": { - "$ref": "#/definitions/CreditSpecification" + "additionalProperties": false, + "description": "The credit option for CPU usage of the burstable performance instance. Valid values are standard and unlimited.", + "properties": { + "CPUCredits": { + "type": "string" + } + }, + "type": "object" }, "DisableApiTermination": { + "description": "If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can.", "type": "boolean" }, "EbsOptimized": { + "description": "Indicates whether the instance is optimized for Amazon EBS I/O.", "type": "boolean" }, "ElasticGpuSpecifications": { + "description": "An elastic GPU to associate with the instance.", + "insertionOrder": false, "items": { "$ref": "#/definitions/ElasticGpuSpecification" }, "type": "array", - "uniqueItems": true + "uniqueItems": false }, "ElasticInferenceAccelerators": { + "description": "An elastic inference accelerator to associate with the instance.", + "insertionOrder": false, "items": { "$ref": "#/definitions/ElasticInferenceAccelerator" }, "type": "array", - "uniqueItems": true + "uniqueItems": false }, "EnclaveOptions": { - "$ref": "#/definitions/EnclaveOptions" + "additionalProperties": false, + "description": "Indicates whether the instance is enabled for AWS Nitro Enclaves.", + "properties": { + "Enabled": { + "description": "If this parameter is set to true, the instance is enabled for AWS Nitro Enclaves; otherwise, it is not enabled for AWS Nitro Enclaves.", + "type": "boolean" + } + }, + "type": "object" }, "HibernationOptions": { - "$ref": "#/definitions/HibernationOptions" + "additionalProperties": false, + "description": "Indicates whether an instance is enabled for hibernation.", + "properties": { + "Configured": { + "default": false, + "description": "If you set this parameter to true, your instance is enabled for hibernation.", + "type": "boolean" + } + }, + "type": "object" }, "HostId": { + "description": "If you specify host for the Affinity property, the ID of a dedicated host that the instance is associated with. If you don't specify an ID, Amazon EC2 launches the instance onto any available, compatible dedicated host in your account.", "type": "string" }, "HostResourceGroupArn": { + "description": "The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host.", "type": "string" }, "IamInstanceProfile": { + "description": "The IAM instance profile.", "type": "string" }, - "Id": { + "ImageId": { + "description": "The ID of the AMI. An AMI ID is required to launch an instance and must be specified here or in a launch template.", "type": "string" }, - "ImageId": { + "InstanceId": { + "description": "The EC2 Instance ID.", "type": "string" }, "InstanceInitiatedShutdownBehavior": { + "description": "Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).", "type": "string" }, "InstanceType": { + "description": "The instance type.", "type": "string" }, "Ipv6AddressCount": { + "description": "[EC2-VPC] The number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet.", "type": "integer" }, "Ipv6Addresses": { + "description": "[EC2-VPC] The IPv6 addresses from the range of the subnet to associate with the primary network interface.", + "insertionOrder": false, "items": { "$ref": "#/definitions/InstanceIpv6Address" }, @@ -433,25 +650,34 @@ "uniqueItems": false }, "KernelId": { + "description": "The ID of the kernel.", "type": "string" }, "KeyName": { + "description": "The name of the key pair.", "type": "string" }, "LaunchTemplate": { - "$ref": "#/definitions/LaunchTemplateSpecification" + "$ref": "#/definitions/LaunchTemplateSpecification", + "description": "The launch template to use to launch the instances.", + "type": "object" }, "LicenseSpecifications": { + "description": "The license configurations.", + "insertionOrder": false, "items": { "$ref": "#/definitions/LicenseSpecification" }, "type": "array", - "uniqueItems": true + "uniqueItems": false }, "Monitoring": { + "description": "Specifies whether detailed monitoring is enabled for the instance.", "type": "boolean" }, "NetworkInterfaces": { + "description": "The network interfaces to associate with the instance.", + "insertionOrder": false, "items": { "$ref": "#/definitions/NetworkInterface" }, @@ -459,33 +685,45 @@ "uniqueItems": false }, "PlacementGroupName": { + "description": "The name of an existing placement group that you want to launch the instance into (cluster | partition | spread).", "type": "string" }, "PrivateDnsName": { + "description": "The private DNS name of the specified instance. For example: ip-10-24-34-0.ec2.internal.", "type": "string" }, "PrivateDnsNameOptions": { - "$ref": "#/definitions/PrivateDnsNameOptions" + "$ref": "#/definitions/PrivateDnsNameOptions", + "description": "The options for the instance hostname.", + "type": "object" }, "PrivateIp": { + "description": "The private IP address of the specified instance. For example: 10.24.34.0.", "type": "string" }, "PrivateIpAddress": { + "description": "[EC2-VPC] The primary IPv4 address. You must specify a value from the IPv4 address range of the subnet.", "type": "string" }, "PropagateTagsToVolumeOnCreation": { + "description": "Indicates whether to assign the tags from the instance to all of the volumes attached to the instance at launch. If you specify true and you assign tags to the instance, those tags are automatically assigned to all of the volumes that you attach to the instance at launch. If you specify false, those tags are not assigned to the attached volumes.", "type": "boolean" }, "PublicDnsName": { + "description": "The public DNS name of the specified instance. For example: ec2-107-20-50-45.compute-1.amazonaws.com.", "type": "string" }, "PublicIp": { + "description": "The public IP address of the specified instance. For example: 192.0.2.0.", "type": "string" }, "RamdiskId": { + "description": "The ID of the RAM disk to select.", "type": "string" }, "SecurityGroupIds": { + "description": "The IDs of the security groups.", + "insertionOrder": false, "items": { "type": "string" }, @@ -493,6 +731,8 @@ "uniqueItems": false }, "SecurityGroups": { + "description": "the names of the security groups. For a nondefault VPC, you must use security group IDs instead.", + "insertionOrder": false, "items": { "type": "string" }, @@ -500,19 +740,30 @@ "uniqueItems": false }, "SourceDestCheck": { + "description": "Specifies whether to enable an instance launched in a VPC to perform NAT.", "type": "boolean" }, "SsmAssociations": { + "description": "The SSM document and parameter values in AWS Systems Manager to associate with this instance.", + "insertionOrder": false, "items": { "$ref": "#/definitions/SsmAssociation" }, "type": "array", "uniqueItems": false }, + "State": { + "$ref": "#/definitions/State", + "description": "The current state of the instance.", + "type": "object" + }, "SubnetId": { + "description": "[EC2-VPC] The ID of the subnet to launch the instance into.\n\n", "type": "string" }, "Tags": { + "description": "The tags to add to the instance.", + "insertionOrder": false, "items": { "$ref": "#/definitions/Tag" }, @@ -520,26 +771,53 @@ "uniqueItems": false }, "Tenancy": { + "description": "The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.", "type": "string" }, "UserData": { + "description": "The user data to make available to the instance.", "type": "string" }, "Volumes": { + "description": "The volumes to attach to the instance.", + "insertionOrder": false, "items": { "$ref": "#/definitions/Volume" }, "type": "array", "uniqueItems": false + }, + "VpcId": { + "description": "The ID of the VPC that the instance is running in.", + "type": "string" } }, "readOnlyProperties": [ - "/properties/PublicIp", - "/properties/Id", + "/properties/InstanceId", + "/properties/PrivateIp", "/properties/PublicDnsName", + "/properties/PublicIp", "/properties/PrivateDnsName", - "/properties/PrivateIp" + "/properties/VpcId", + "/properties/State" ], - "typeName": "AWS::EC2::Instance" + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::EC2::Instance", + "writeOnlyProperties": [ + "/properties/BlockDeviceMappings/*/BlockDeviceMapping/NoDevice", + "/properties/BlockDeviceMappings/*/BlockDeviceMapping/VirtualName", + "/properties/LicenseSpecification", + "/properties/AdditionalInfo", + "/properties/Ipv6AddressCount", + "/properties/Ipv6Addresses", + "/properties/PropagateTagsToVolumeOnCreation" + ] } } \ No newline at end of file diff --git a/artifacts/types/AWS::EC2::InstanceConnectEndpoint.json b/artifacts/types/AWS::EC2::InstanceConnectEndpoint.json index 20c3e707..88038d2b 100644 --- a/artifacts/types/AWS::EC2::InstanceConnectEndpoint.json +++ b/artifacts/types/AWS::EC2::InstanceConnectEndpoint.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-InstanceConnectEndpoint", "type": "AWS::EC2::InstanceConnectEndpoint", - "time": "2023-12-27T20:41:49.338Z", + "time": "2024-06-06T18:25:05.236Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -81,7 +81,7 @@ "type": "string" }, "PreserveClientIp": { - "description": "If true, the address of the loki client is preserved when connecting to the end resource", + "description": "If true, the address of the instance connect endpoint client is preserved when connecting to the end resource", "type": "boolean" }, "SecurityGroupIds": { diff --git a/artifacts/types/AWS::EC2::InternetGateway.json b/artifacts/types/AWS::EC2::InternetGateway.json index e871f93d..27888fec 100644 --- a/artifacts/types/AWS::EC2::InternetGateway.json +++ b/artifacts/types/AWS::EC2::InternetGateway.json @@ -1,19 +1,22 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-InternetGateway", "type": "AWS::EC2::InternetGateway", - "time": "2023-12-29T22:50:50.823Z", + "time": "2024-03-30T01:20:27.988Z", "schema": { "additionalProperties": false, "definitions": { "Tag": { "additionalProperties": false, + "description": "Specifies a tag. For more information, see [Add tags to a resource](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#cloudformation-add-tag-specifications).", "properties": { "Key": { + "description": "The tag key.", "maxLength": 128, "minLength": 1, "type": "string" }, "Value": { + "description": "The tag value.", "maxLength": 256, "type": "string" } @@ -25,7 +28,7 @@ "type": "object" } }, - "description": "Resource Type definition for AWS::EC2::InternetGateway", + "description": "Allocates an internet gateway for use with a VPC. After creating the Internet gateway, you then attach it to a VPC.", "handlers": { "create": { "permissions": [ @@ -63,7 +66,7 @@ ], "properties": { "InternetGatewayId": { - "description": "ID of internet gateway.", + "description": "", "type": "string" }, "Tags": { diff --git a/artifacts/types/AWS::EC2::LaunchTemplate.json b/artifacts/types/AWS::EC2::LaunchTemplate.json index df724552..c47c5a69 100644 --- a/artifacts/types/AWS::EC2::LaunchTemplate.json +++ b/artifacts/types/AWS::EC2::LaunchTemplate.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-LaunchTemplate", "type": "AWS::EC2::LaunchTemplate", - "time": "2024-01-03T17:10:00.971Z", + "time": "2024-05-07T19:11:29.825Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -10,14 +10,14 @@ "definitions": { "AcceleratorCount": { "additionalProperties": false, - "description": "The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferential chips) on an instance.", + "description": "The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) on an instance.", "properties": { "Max": { - "description": "The maximum number of accelerators.", + "description": "The maximum number of accelerators. To specify no maximum limit, omit this parameter. To exclude accelerator-enabled instance types, set ``Max`` to ``0``.", "type": "integer" }, "Min": { - "description": "The minimum number of accelerators.", + "description": "The minimum number of accelerators. To specify no minimum limit, omit this parameter.", "type": "integer" } }, @@ -28,11 +28,11 @@ "description": "The minimum and maximum amount of total accelerator memory, in MiB.", "properties": { "Max": { - "description": "The maximum amount of accelerator memory, in MiB.", + "description": "The maximum amount of accelerator memory, in MiB. To specify no maximum limit, omit this parameter.", "type": "integer" }, "Min": { - "description": "The minimum amount of accelerator memory, in MiB.", + "description": "The minimum amount of accelerator memory, in MiB. To specify no minimum limit, omit this parameter.", "type": "integer" } }, @@ -40,14 +40,14 @@ }, "BaselineEbsBandwidthMbps": { "additionalProperties": false, - "description": "The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps.", + "description": "The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see [Amazon EBS–optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the *Amazon EC2 User Guide*.", "properties": { "Max": { - "description": "The maximum baseline bandwidth, in Mbps.", + "description": "The maximum baseline bandwidth, in Mbps. To specify no maximum limit, omit this parameter.", "type": "integer" }, "Min": { - "description": "The minimum baseline bandwidth, in Mbps.", + "description": "The minimum baseline bandwidth, in Mbps. To specify no minimum limit, omit this parameter.", "type": "integer" } }, @@ -55,21 +55,22 @@ }, "BlockDeviceMapping": { "additionalProperties": false, - "description": "Information about a block device mapping for an Amazon EC2 launch template.", + "description": "Specifies a block device mapping for a launch template. You must specify ``DeviceName`` plus 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).", "properties": { "DeviceName": { - "description": "The user data to make available to the instance.", + "description": "The device name (for example, /dev/sdh or xvdh).", "type": "string" }, "Ebs": { - "$ref": "#/definitions/Ebs" + "$ref": "#/definitions/Ebs", + "description": "Parameters used to automatically set up EBS volumes when the instance is launched." }, "NoDevice": { "description": "To omit the device from the block device mapping, specify an empty string.", "type": "string" }, "VirtualName": { - "description": "The virtual device name (ephemeralN).", + "description": "The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.", "type": "string" } }, @@ -77,21 +78,22 @@ }, "CapacityReservationSpecification": { "additionalProperties": false, - "description": "Specifies an instance's Capacity Reservation targeting option.", + "description": "Specifies an instance's Capacity Reservation targeting option. You can specify only one option 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).", "properties": { "CapacityReservationPreference": { - "description": "Indicates the instance's Capacity Reservation preferences.", + "description": "Indicates the instance's Capacity Reservation preferences. Possible preferences include:\n + ``open`` - The instance can run in any ``open`` Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).\n + ``none`` - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity.", "type": "string" }, "CapacityReservationTarget": { - "$ref": "#/definitions/CapacityReservationTarget" + "$ref": "#/definitions/CapacityReservationTarget", + "description": "Information about the target Capacity Reservation or Capacity Reservation group." } }, "type": "object" }, "CapacityReservationTarget": { "additionalProperties": false, - "description": "Specifies a target Capacity Reservation.", + "description": "Specifies 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.", "properties": { "CapacityReservationId": { "description": "The ID of the Capacity Reservation in which to run the instance.", @@ -106,18 +108,18 @@ }, "ConnectionTrackingSpecification": { "additionalProperties": false, - "description": "Allows customer to specify Connection Tracking options", + "description": "A security group connection tracking specification that enables you to set the idle timeout for connection tracking on an Elastic 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*.", "properties": { "TcpEstablishedTimeout": { - "description": "Integer value for TCP Established Timeout", + "description": "Timeout (in seconds) for idle TCP connections in an established state. Min: 60 seconds. Max: 432000 seconds (5 days). Default: 432000 seconds. Recommended: Less than 432000 seconds.", "type": "integer" }, "UdpStreamTimeout": { - "description": "Integer value for UDP Stream Timeout", + "description": "Timeout (in seconds) for idle UDP flows classified as streams which have seen more than one request-response transaction. Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180 seconds.", "type": "integer" }, "UdpTimeout": { - "description": "Integer value for UDP Timeout", + "description": "Timeout (in seconds) for idle UDP flows that have seen traffic only in a single direction or a single request-response transaction. Min: 30 seconds. Max: 60 seconds. Default: 30 seconds.", "type": "integer" } }, @@ -125,10 +127,10 @@ }, "CpuOptions": { "additionalProperties": false, - "description": "specifies the CPU options for an instance.", + "description": "Specifies the CPU options for an instance. For more information, see [Optimize CPU options](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html) in the *User Guide*.\n ``CpuOptions`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).", "properties": { "AmdSevSnp": { - "description": "Indicates whether to enable the instance for AMD SEV-SNP. AMD SEV-SNP is supported with M6a, R6a, and C6a instance types only.", + "description": "Indicates whether to enable the instance for AMD SEV-SNP. AMD SEV-SNP is supported with M6a, R6a, and C6a instance types only. For more information, see [AMD SEV-SNP](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/sev-snp.html).", "enum": [ "enabled", "disabled" @@ -140,7 +142,7 @@ "type": "integer" }, "ThreadsPerCore": { - "description": "The number of threads per CPU core. To disable multithreading for the instance, specify a value of 1. Otherwise, specify the default value of 2.", + "description": "The number of threads per CPU core. To disable multithreading for the instance, specify a value of ``1``. Otherwise, specify the default value of ``2``.", "type": "integer" } }, @@ -148,10 +150,10 @@ }, "CreditSpecification": { "additionalProperties": false, - "description": "The user data to make available to the instance.", + "description": "Specifies 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).", "properties": { "CpuCredits": { - "description": "The user data to make available to the instance.", + "description": "The credit option for CPU usage of a T instance.\n Valid values: ``standard`` | ``unlimited``", "type": "string" } }, @@ -159,7 +161,7 @@ }, "Ebs": { "additionalProperties": false, - "description": "Parameters for a block device for an EBS volume in an Amazon EC2 launch template.", + "description": "Parameters 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).", "properties": { "DeleteOnTermination": { "description": "Indicates whether the EBS volume is deleted on instance termination.", @@ -170,11 +172,11 @@ "type": "boolean" }, "Iops": { - "description": "The number of I/O operations per second (IOPS).", + "description": "The number of I/O operations per second (IOPS). For ``gp3``, ``io1``, and ``io2`` volumes, this represents the number of IOPS that are provisioned for the volume. For ``gp2`` volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.\n The 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\n \n For ``io2`` volumes, you can achieve up to 256,000 IOPS on [instances built 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.\n This parameter is supported for ``io1``, ``io2``, and ``gp3`` volumes only.", "type": "integer" }, "KmsKeyId": { - "description": "The ARN of the symmetric AWS Key Management Service (AWS KMS) CMK used for encryption.", + "description": "The ARN of the symmetric KMSlong (KMS) CMK used for encryption.", "type": "string" }, "SnapshotId": { @@ -182,15 +184,15 @@ "type": "string" }, "Throughput": { - "description": "The throughput to provision for a gp3 volume, with a maximum of 1,000 MiB/s.", + "description": "The throughput to provision for a ``gp3`` volume, with a maximum of 1,000 MiB/s.\n Valid Range: Minimum value of 125. Maximum value of 1000.", "type": "integer" }, "VolumeSize": { - "description": "The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size.", + "description": "The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. The following are the supported volumes sizes for each volume type:\n + ``gp2`` and ``gp3``: 1 - 16,384 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", "type": "integer" }, "VolumeType": { - "description": "The volume type.", + "description": "The volume type. For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volume-types.html) in the *Amazon EBS User Guide*.", "type": "string" } }, @@ -198,10 +200,10 @@ }, "ElasticGpuSpecification": { "additionalProperties": false, - "description": "Specifies a specification for an Elastic GPU for launch template.", + "description": "Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, G4dn, or G5 instances.\n Specifies a specification for an Elastic GPU for an Amazon EC2 launch template.\n ``ElasticGpuSpecification`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).", "properties": { "Type": { - "description": "The type of Elastic Graphics accelerator.", + "description": "The type of Elastic Graphics accelerator. For more information about the values to specify for ``Type``, see [Elastic Graphics Basics](https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/elastic-graphics.html#elastic-graphics-basics), specifically the Elastic Graphics accelerator column, in the *Amazon Elastic Compute Cloud User Guide for Windows Instances*.", "type": "string" } }, @@ -209,24 +211,25 @@ }, "EnaSrdSpecification": { "additionalProperties": false, - "description": "Allows customer to specify ENA-SRD options", + "description": "ENA Express uses AWS Scalable Reliable Datagram (SRD) technology to increase the maximum bandwidth used per stream and minimize tail latency of network traffic between EC2 instances. With ENA Express, you can communicate between two EC2 instances in the same subnet within the same account, or in different accounts. Both sending and receiving instances must have ENA Express enabled.\n To improve the reliability of network packet delivery, ENA Express reorders network packets on the receiving end by default. However, some UDP-based applications are designed to handle network packets that are out of order to reduce the overhead for packet delivery at the network layer. When ENA Express is enabled, you can specify whether UDP network traffic uses it.", "properties": { "EnaSrdEnabled": { - "description": "Enables TCP ENA-SRD", + "description": "Indicates whether ENA Express is enabled for the network interface.", "type": "boolean" }, "EnaSrdUdpSpecification": { - "$ref": "#/definitions/EnaSrdUdpSpecification" + "$ref": "#/definitions/EnaSrdUdpSpecification", + "description": "Configures ENA Express for UDP network traffic." } }, "type": "object" }, "EnaSrdUdpSpecification": { "additionalProperties": false, - "description": "Allows customer to specify ENA-SRD (UDP) options", + "description": "ENA Express is compatible with both TCP and UDP transport protocols. When it's enabled, TCP traffic automatically uses it. However, some UDP-based applications are designed to handle network packets that are out of order, without a need for retransmission, such as live video broadcasting or other near-real-time applications. For UDP traffic, you can specify whether to use ENA Express, based on your application environment needs.", "properties": { "EnaSrdUdpEnabled": { - "description": "Enables UDP ENA-SRD", + "description": "Indicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting, you must first enable ENA Express.", "type": "boolean" } }, @@ -237,7 +240,7 @@ "description": "Indicates whether the instance is enabled for AWS Nitro Enclaves.", "properties": { "Enabled": { - "description": "If this parameter is set to true, the instance is enabled for AWS Nitro Enclaves; otherwise, it is not enabled for AWS Nitro Enclaves.", + "description": "If this parameter is set to ``true``, the instance is enabled for AWS Nitro Enclaves; otherwise, it is not enabled for AWS Nitro Enclaves.", "type": "boolean" } }, @@ -245,10 +248,10 @@ }, "HibernationOptions": { "additionalProperties": false, - "description": "Specifies whether your instance is configured for hibernation.", + "description": "Specifies whether your instance is configured for hibernation. This parameter is valid only if the instance meets the [hibernation prerequisites](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 *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).", "properties": { "Configured": { - "description": "TIf you set this parameter to true, the instance is enabled for hibernation.", + "description": "If you set this parameter to ``true``, the instance is enabled for hibernation.\n Default: ``false``", "type": "boolean" } }, @@ -256,7 +259,7 @@ }, "IamInstanceProfile": { "additionalProperties": false, - "description": "Specifies an IAM instance profile, which is a container for an IAM role for your instance.", + "description": "Specifies an IAM instance profile, which is a container for an IAM role for your instance. You can use an IAM role to distribute your AWS credentials to your instances.\n If you are creating the launch template for use with an ASlong group, you 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).", "properties": { "Arn": { "description": "The Amazon Resource Name (ARN) of the instance profile.", @@ -271,27 +274,29 @@ }, "InstanceMarketOptions": { "additionalProperties": false, - "description": "The market (purchasing) option for the instances.", + "description": "Specifies 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).", "properties": { "MarketType": { "description": "The market type.", "type": "string" }, "SpotOptions": { - "$ref": "#/definitions/SpotOptions" + "$ref": "#/definitions/SpotOptions", + "description": "The options for Spot Instances." } }, "type": "object" }, "InstanceRequirements": { "additionalProperties": false, - "description": "The attributes for the instance types.", + "description": "The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.\n You must specify ``VCpuCount`` and ``MemoryMiB``. All other attributes are optional. Any unspecified optional attribute is set to its default.\n When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values.\n To limit the list of instance types from which Amazon EC2 can identify matching instance types, you 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 other instance types are ignored, even if they match your specified attributes.\n + ``ExcludedInstanceTypes`` - The instance types to exclude from the list, even if they match your specified attributes.\n \n If you specify ``InstanceRequirements``, you can't specify ``InstanceType``.\n Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the [launch instance wizard](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 [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) AWS CloudFormation resource, you can't specify ``InstanceRequirements``.\n For more information, see [Attribute-based instance type selection for EC2 Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html), [Attribute-based instance type selection for Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-attribute-based-instance-type-selection.html), and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*.", "properties": { "AcceleratorCount": { - "$ref": "#/definitions/AcceleratorCount" + "$ref": "#/definitions/AcceleratorCount", + "description": "The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) on an instance.\n To exclude accelerator-enabled instance types, set ``Max`` to ``0``.\n Default: No minimum or maximum limits" }, "AcceleratorManufacturers": { - "description": "Indicates whether instance types must have accelerators by specific manufacturers.", + "description": "Indicates 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``.\n \n Default: Any manufacturer", "items": { "type": "string" }, @@ -299,7 +304,7 @@ "uniqueItems": false }, "AcceleratorNames": { - "description": "The accelerators that must be on the instance type.", + "description": "The 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 NVIDIA GRID K520 GPUs, specify ``k520``.\n + For instance types with NVIDIA K80 GPUs, specify ``k80``.\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 NVIDIA T4 GPUs, specify ``t4``.\n + For instance types with NVIDIA T4G GPUs, specify ``t4g``.\n + For instance types with Xilinx VU9P FPGAs, specify ``vu9p``.\n + For instance types with NVIDIA V100 GPUs, specify ``v100``.\n \n Default: Any accelerator", "items": { "type": "string" }, @@ -307,10 +312,11 @@ "uniqueItems": false }, "AcceleratorTotalMemoryMiB": { - "$ref": "#/definitions/AcceleratorTotalMemoryMiB" + "$ref": "#/definitions/AcceleratorTotalMemoryMiB", + "description": "The minimum and maximum amount of total accelerator memory, in MiB.\n Default: No minimum or maximum limits" }, "AcceleratorTypes": { - "description": "The accelerator types that must be on the instance type.", + "description": "The accelerator types that must be on the 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 ``inference``.\n \n Default: Any accelerator type", "items": { "type": "string" }, @@ -318,7 +324,7 @@ "uniqueItems": false }, "AllowedInstanceTypes": { - "description": "The instance types to apply your specified attributes against.", + "description": "The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes.\n You can use strings with one or more wild cards, represented by an asterisk (``*``), to allow an instance type, size, or generation. The following are examples: ``m5.8xlarge``, ``c5*.*``, ``m5a.*``, ``r*``, ``*3*``.\n For example, if you specify ``c5*``,Amazon EC2 will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify ``m5a.*``, Amazon EC2 will allow all the M5a instance types, but not the M5n instance types.\n If you specify ``AllowedInstanceTypes``, you can't specify ``ExcludedInstanceTypes``.\n Default: All instance types", "items": { "type": "string" }, @@ -326,17 +332,19 @@ "uniqueItems": false }, "BareMetal": { - "description": "Indicates whether bare metal instance types must be included, excluded, or required.", + "description": "Indicates 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``.\n \n Default: ``excluded``", "type": "string" }, "BaselineEbsBandwidthMbps": { - "$ref": "#/definitions/BaselineEbsBandwidthMbps" + "$ref": "#/definitions/BaselineEbsBandwidthMbps", + "description": "The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see [Amazon EBS–optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the *Amazon EC2 User Guide*.\n Default: No minimum or maximum limits" }, "BurstablePerformance": { + "description": "Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see [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``.\n \n Default: ``excluded``", "type": "string" }, "CpuManufacturers": { - "description": "The CPU manufacturers to include.", + "description": "The 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 \n Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template.\n Default: Any manufacturer", "items": { "type": "string" }, @@ -344,7 +352,7 @@ "uniqueItems": false }, "ExcludedInstanceTypes": { - "description": "The instance types to exclude.", + "description": "The instance types to exclude.\n You can use strings with one or more wild cards, represented by an asterisk (``*``), to exclude an instance type, size, or generation. The following are examples: ``m5.8xlarge``, ``c5*.*``, ``m5a.*``, ``r*``, ``*3*``.\n For example, if you specify ``c5*``,Amazon EC2 will exclude the entire C5 instance family, which includes all C5a and C5n instance types. If you specify ``m5a.*``, Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types.\n If you specify ``ExcludedInstanceTypes``, you can't specify ``AllowedInstanceTypes``.\n Default: No excluded instance types", "items": { "description": "The user data to make available to the instance.", "type": "string" @@ -353,7 +361,7 @@ "uniqueItems": false }, "InstanceGenerations": { - "description": "Indicates whether current or previous generation instance types are included.", + "description": "Indicates whether current or previous generation instance types are included. The current generation instance types are recommended for use. Current generation instance types are typically the latest two to three generations in each instance family. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide*.\n For current generation instance types, specify ``current``.\n For previous generation instance types, specify ``previous``.\n Default: Current and previous generation instance types", "items": { "type": "string" }, @@ -361,56 +369,66 @@ "uniqueItems": false }, "LocalStorage": { - "description": "The user data to make available to the instance.", + "description": "Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, [Amazon EC2 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 ``included``.\n + To require only instance types with instance store volumes, specify ``required``.\n + To exclude instance types with instance store volumes, specify ``excluded``.\n \n Default: ``included``", "type": "string" }, "LocalStorageTypes": { - "description": "The type of local storage that is required.", + "description": "The 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 ``ssd``.\n \n Default: ``hdd`` and ``ssd``", "items": { "type": "string" }, "type": "array", "uniqueItems": false }, + "MaxSpotPriceAsPercentageOfOptimalOnDemandPrice": { + "description": "[Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold.\n The parameter accepts an integer, which Amazon EC2 interprets as a percentage.\n If you set ``DesiredCapacityType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is based on the per vCPU or per memory price instead of the per instance price.\n Only one of ``SpotMaxPricePercentageOverLowestPrice`` or ``MaxSpotPriceAsPercentageOfOptimalOnDemandPrice`` can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as ``999999``.", + "type": "integer" + }, "MemoryGiBPerVCpu": { - "$ref": "#/definitions/MemoryGiBPerVCpu" + "$ref": "#/definitions/MemoryGiBPerVCpu", + "description": "The minimum and maximum amount of memory per vCPU, in GiB.\n Default: No minimum or maximum limits" }, "MemoryMiB": { - "$ref": "#/definitions/MemoryMiB" + "$ref": "#/definitions/MemoryMiB", + "description": "The minimum and maximum amount of memory, in MiB." }, "NetworkBandwidthGbps": { - "$ref": "#/definitions/NetworkBandwidthGbps" + "$ref": "#/definitions/NetworkBandwidthGbps", + "description": "The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).\n Default: No minimum or maximum limits" }, "NetworkInterfaceCount": { - "$ref": "#/definitions/NetworkInterfaceCount" + "$ref": "#/definitions/NetworkInterfaceCount", + "description": "The minimum and maximum number of network interfaces.\n Default: No minimum or maximum limits" }, "OnDemandMaxPricePercentageOverLowestPrice": { - "description": "The price protection threshold for On-Demand Instances.", + "description": "[Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold.\n The parameter accepts an integer, which Amazon EC2 interprets as a percentage.\n To turn off price protection, specify a high value, such as ``999999``.\n This 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 If you set ``TargetCapacityUnitType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.\n Default: ``20``", "type": "integer" }, "RequireHibernateSupport": { - "description": "Indicates whether instance types must support hibernation for On-Demand Instances.", + "description": "Indicates whether instance types must support hibernation for On-Demand Instances.\n This parameter is not supported for [GetSpotPlacementScores](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html).\n Default: ``false``", "type": "boolean" }, "SpotMaxPricePercentageOverLowestPrice": { - "description": "The price protection threshold for Spot Instances.", + "description": "[Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the Spot price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified Spot price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose Spot price exceeds your specified threshold.\n The parameter accepts an integer, which Amazon EC2 interprets as a percentage.\n If you set ``TargetCapacityUnitType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.\n This 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 Only one of ``SpotMaxPricePercentageOverLowestPrice`` or ``MaxSpotPriceAsPercentageOfOptimalOnDemandPrice`` can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as ``999999``.\n Default: ``100``", "type": "integer" }, "TotalLocalStorageGB": { - "$ref": "#/definitions/TotalLocalStorageGB" + "$ref": "#/definitions/TotalLocalStorageGB", + "description": "The minimum and maximum amount of total local storage, in GB.\n Default: No minimum or maximum limits" }, "VCpuCount": { - "$ref": "#/definitions/VCpuCount" + "$ref": "#/definitions/VCpuCount", + "description": "The minimum and maximum number of vCPUs." } }, "type": "object" }, "Ipv4PrefixSpecification": { "additionalProperties": false, - "description": "Specifies an IPv4 prefix for a network interface.", + "description": "Specifies 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).", "properties": { "Ipv4Prefix": { - "description": "The IPv4 prefix.", + "description": "The IPv4 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 *Amazon Elastic Compute Cloud User Guide*.", "type": "string" } }, @@ -418,9 +436,10 @@ }, "Ipv6Add": { "additionalProperties": false, - "description": "Specifies an IPv6 address.", + "description": "Specifies 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).", "properties": { "Ipv6Address": { + "description": "One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses.", "type": "string" } }, @@ -428,9 +447,10 @@ }, "Ipv6PrefixSpecification": { "additionalProperties": false, - "description": "Specifies an IPv6 prefix for a network interface.", + "description": "Specifies 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).", "properties": { "Ipv6Prefix": { + "description": "The IPv6 prefix.", "type": "string" } }, @@ -438,7 +458,7 @@ }, "LaunchTemplateData": { "additionalProperties": false, - "description": "The information for the launch template.", + "description": "The information to include in the launch template.\n You must specify at least one parameter for the launch template data.", "properties": { "BlockDeviceMappings": { "description": "The block device mapping.", @@ -449,28 +469,31 @@ "uniqueItems": false }, "CapacityReservationSpecification": { - "$ref": "#/definitions/CapacityReservationSpecification" + "$ref": "#/definitions/CapacityReservationSpecification", + "description": "The Capacity Reservation targeting option. If you do not specify this parameter, the instance's Capacity Reservation preference defaults to ``open``, which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone)." }, "CpuOptions": { - "$ref": "#/definitions/CpuOptions" + "$ref": "#/definitions/CpuOptions", + "description": "The CPU options for the instance. For more information, see [Optimizing CPU Options](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html) in the *Amazon Elastic Compute Cloud User Guide*." }, "CreditSpecification": { - "$ref": "#/definitions/CreditSpecification" + "$ref": "#/definitions/CreditSpecification", + "description": "The credit option for CPU usage of the instance. Valid only for T instances." }, "DisableApiStop": { - "description": "Indicates whether to enable the instance for stop protection.", + "description": "Indicates whether to enable the instance for stop protection. For more information, see [Stop protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Stop_Start.html#Using_StopProtection) in the *Amazon Elastic Compute Cloud User Guide*.", "type": "boolean" }, "DisableApiTermination": { - "description": "If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API.", + "description": "If you set this parameter to ``true``, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch, use [ModifyInstanceAttribute](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyInstanceAttribute.html). Alternatively, if you set ``InstanceInitiatedShutdownBehavior`` to ``terminate``, you can terminate the instance by running the shutdown command from the instance.", "type": "boolean" }, "EbsOptimized": { - "description": "Indicates whether the instance is optimized for Amazon EBS I/O.", + "description": "Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.", "type": "boolean" }, "ElasticGpuSpecifications": { - "description": "An elastic GPU to associate with the instance.", + "description": "Deprecated.\n Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, G4dn, or G5 instances.", "items": { "$ref": "#/definitions/ElasticGpuSpecification" }, @@ -478,7 +501,7 @@ "uniqueItems": false }, "ElasticInferenceAccelerators": { - "description": "The elastic inference accelerator for the instance.", + "description": "An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads.\n You cannot specify accelerators from different generations in the same request.\n Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.", "items": { "$ref": "#/definitions/LaunchTemplateElasticInferenceAccelerator" }, @@ -486,37 +509,43 @@ "uniqueItems": false }, "EnclaveOptions": { - "$ref": "#/definitions/EnclaveOptions" + "$ref": "#/definitions/EnclaveOptions", + "description": "Indicates whether the instance is enabled for AWS Nitro Enclaves. For more information, see [What is Nitro Enclaves?](https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave.html) in the *Nitro Enclaves User Guide*.\n You can't enable AWS Nitro Enclaves and hibernation on the same instance." }, "HibernationOptions": { - "$ref": "#/definitions/HibernationOptions" + "$ref": "#/definitions/HibernationOptions", + "description": "Indicates whether an instance is enabled for hibernation. This parameter is valid only if the instance meets the [hibernation prerequisites](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/hibernating-prerequisites.html). For more information, see [Hibernate your instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html) in the *Amazon Elastic Compute Cloud User Guide*." }, "IamInstanceProfile": { - "$ref": "#/definitions/IamInstanceProfile" + "$ref": "#/definitions/IamInstanceProfile", + "description": "The name or Amazon Resource Name (ARN) of an IAM instance profile." }, "ImageId": { - "description": "The ID of the AMI. Alternatively, you can specify a Systems Manager parameter, which will resolve to an AMI ID on launch.", + "description": "The ID of the AMI. Alternatively, you can specify a Systems Manager parameter, which will resolve to an AMI ID on launch.\n Valid formats:\n + ``ami-17characters00000`` \n + ``resolve:ssm:parameter-name`` \n + ``resolve:ssm:parameter-name:version-number`` \n + ``resolve:ssm:parameter-name:label`` \n \n For 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*.", "type": "string" }, "InstanceInitiatedShutdownBehavior": { - "description": "Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).", + "description": "Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).\n Default: ``stop``", "type": "string" }, "InstanceMarketOptions": { - "$ref": "#/definitions/InstanceMarketOptions" + "$ref": "#/definitions/InstanceMarketOptions", + "description": "The market (purchasing) option for the instances." }, "InstanceRequirements": { - "$ref": "#/definitions/InstanceRequirements" + "$ref": "#/definitions/InstanceRequirements", + "description": "The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.\n You must specify ``VCpuCount`` and ``MemoryMiB``. All other attributes are optional. Any unspecified optional attribute is set to its default.\n When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values.\n To limit the list of instance types from which Amazon EC2 can identify matching instance types, you 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 other instance types are ignored, even if they match your specified attributes.\n + ``ExcludedInstanceTypes`` - The instance types to exclude from the list, even if they match your specified attributes.\n \n If you specify ``InstanceRequirements``, you can't specify ``InstanceType``.\n Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the [launch instance wizard](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 [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) AWS CloudFormation resource, you can't specify ``InstanceRequirements``.\n For more information, see [Attribute-based instance type selection for EC2 Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html), [Attribute-based instance type selection for Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-attribute-based-instance-type-selection.html), and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*." }, "InstanceType": { + "description": "The instance type. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon Elastic Compute Cloud User Guide*.\n If you specify ``InstanceType``, you can't specify ``InstanceRequirements``.", "type": "string" }, "KernelId": { - "description": "The ID of the kernel.", + "description": "The ID of the kernel.\n We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see [User Provided Kernels](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html) in the *Amazon EC2 User Guide*.", "type": "string" }, "KeyName": { - "description": "The name of the EC2 key pair", + "description": "The name of the key pair. You can create a key pair using [CreateKeyPair](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateKeyPair.html) or [ImportKeyPair](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportKeyPair.html).\n If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.", "type": "string" }, "LicenseSpecifications": { @@ -528,16 +557,19 @@ "uniqueItems": false }, "MaintenanceOptions": { - "$ref": "#/definitions/MaintenanceOptions" + "$ref": "#/definitions/MaintenanceOptions", + "description": "The maintenance options of your instance." }, "MetadataOptions": { - "$ref": "#/definitions/MetadataOptions" + "$ref": "#/definitions/MetadataOptions", + "description": "The 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 *Amazon Elastic Compute Cloud User Guide*." }, "Monitoring": { - "$ref": "#/definitions/Monitoring" + "$ref": "#/definitions/Monitoring", + "description": "The monitoring for the instance." }, "NetworkInterfaces": { - "description": "If you specify a network interface, you must specify any security groups and subnets as part of the network interface.", + "description": "The network interfaces for the instance.", "items": { "$ref": "#/definitions/NetworkInterface" }, @@ -545,16 +577,19 @@ "uniqueItems": false }, "Placement": { - "$ref": "#/definitions/Placement" + "$ref": "#/definitions/Placement", + "description": "The placement for the instance." }, "PrivateDnsNameOptions": { - "$ref": "#/definitions/PrivateDnsNameOptions" + "$ref": "#/definitions/PrivateDnsNameOptions", + "description": "The 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 *User Guide*." }, "RamDiskId": { + "description": "The ID of the RAM disk.\n We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see [User provided kernels](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html) in the *Amazon Elastic Compute Cloud User Guide*.", "type": "string" }, "SecurityGroupIds": { - "description": "One or more security group IDs. ", + "description": "The IDs of the security groups. You can specify the IDs of existing security groups and references to resources created by the stack template.\n If you specify a network interface, you must specify any security groups as part of the network interface instead.", "items": { "type": "string" }, @@ -562,7 +597,7 @@ "uniqueItems": false }, "SecurityGroups": { - "description": "One or more security group names.", + "description": "The names of the security groups. For a nondefault VPC, you must use security group IDs instead.\n If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter.", "items": { "type": "string" }, @@ -570,7 +605,7 @@ "uniqueItems": false }, "TagSpecifications": { - "description": "The tags to apply to the resources that are created during instance launch.", + "description": "The tags to apply to the resources that are created during instance launch.\n To tag a resource after it has been created, see [CreateTags](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html).\n To tag the launch template itself, use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-tagspecifications).", "items": { "$ref": "#/definitions/TagSpecification" }, @@ -578,7 +613,7 @@ "uniqueItems": false }, "UserData": { - "description": "The user data to make available to the instance.", + "description": "The user data to make available to the instance. You must provide base64-encoded text. User data is limited to 16 KB. For more information, see [Run commands on your Linux instance at launch](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html) (Linux) or [Work with instance user data](https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/instancedata-add-user-data.html) (Windows) in the *Amazon Elastic Compute Cloud User Guide*.\n If you are creating the launch template for use with BATCH, the user data must be provided in the [MIME multi-part archive format](https://docs.aws.amazon.com/https://cloudinit.readthedocs.io/en/latest/topics/format.html#mime-multi-part-archive). For more information, see [Amazon EC2 user data in launch templates](https://docs.aws.amazon.com/batch/latest/userguide/launch-templates.html) in the *User Guide*.", "type": "string" } }, @@ -586,14 +621,14 @@ }, "LaunchTemplateElasticInferenceAccelerator": { "additionalProperties": false, - "description": "Specifies an elastic inference accelerator.", + "description": "Specifies an elastic inference accelerator.\n ``LaunchTemplateElasticInferenceAccelerator`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).", "properties": { "Count": { - "description": "The number of elastic inference accelerators to attach to the instance.", + "description": "The number of elastic inference accelerators to attach to the instance. \n Default: 1", "type": "integer" }, "Type": { - "description": "The type of elastic inference accelerator.", + "description": "The type of elastic inference accelerator. The possible values are eia1.medium, eia1.large, and eia1.xlarge.", "type": "string" } }, @@ -601,10 +636,10 @@ }, "LaunchTemplateTagSpecification": { "additionalProperties": false, - "description": "Specifies the tags to apply to the launch template during creation.", + "description": "Specifies the tags to apply to the launch template during creation.\n ``LaunchTemplateTagSpecification`` is a property of [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html).", "properties": { "ResourceType": { - "description": "The type of resource to tag.", + "description": "The type of resource. To tag the launch template, ``ResourceType`` must be ``launch-template``.", "type": "string" }, "Tags": { @@ -620,7 +655,7 @@ }, "LicenseSpecification": { "additionalProperties": false, - "description": "Specifies a license configuration for an instance.", + "description": "Specifies 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).", "properties": { "LicenseConfigurationArn": { "description": "The Amazon Resource Name (ARN) of the license configuration.", @@ -636,10 +671,6 @@ "AutoRecovery": { "description": "Disables the automatic recovery behavior of your instance or sets it to default.", "type": "string" - }, - "RebootMigration": { - "description": "Disables the automatic reboot-migration behavior of your instance or sets it to default.", - "type": "string" } }, "type": "object" @@ -649,11 +680,11 @@ "description": "The minimum and maximum amount of memory per vCPU, in GiB.", "properties": { "Max": { - "description": "The maximum amount of memory per vCPU, in GiB.", + "description": "The maximum amount of memory per vCPU, in GiB. To specify no maximum limit, omit this parameter.", "type": "number" }, "Min": { - "description": "TThe minimum amount of memory per vCPU, in GiB.", + "description": "The minimum amount of memory per vCPU, in GiB. To specify no minimum limit, omit this parameter.", "type": "number" } }, @@ -664,11 +695,11 @@ "description": "The minimum and maximum amount of memory, in MiB.", "properties": { "Max": { - "description": "The maximum amount of memory, in MiB.", + "description": "The maximum amount of memory, in MiB. To specify no maximum limit, omit this parameter.", "type": "integer" }, "Min": { - "description": "The minimum amount of memory, in MiB.", + "description": "The minimum amount of memory, in MiB. To specify no minimum limit, specify ``0``.", "type": "integer" } }, @@ -676,26 +707,26 @@ }, "MetadataOptions": { "additionalProperties": false, - "description": "The metadata options for the instance.", + "description": "The 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 *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).", "properties": { "HttpEndpoint": { - "description": "Enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled.", + "description": "Enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is ``enabled``.\n If you specify a value of ``disabled``, you will not be able to access your instance metadata.", "type": "string" }, "HttpProtocolIpv6": { - "description": "Enables or disables the IPv6 endpoint for the instance metadata service.", + "description": "Enables or disables the IPv6 endpoint for the instance metadata service.\n Default: ``disabled``", "type": "string" }, "HttpPutResponseHopLimit": { - "description": "The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.", + "description": "The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.\n Default: ``1`` \n Possible values: Integers from 1 to 64", "type": "integer" }, "HttpTokens": { - "description": "IMDSv2 uses token-backed sessions.", + "description": "Indicates whether IMDSv2 is required.\n + ``optional`` - IMDSv2 is optional. You can choose whether to send a session token in your instance metadata retrieval requests. If you retrieve IAM role credentials without a session token, you receive the IMDSv1 role credentials. If you retrieve IAM role credentials using a valid session token, you receive the IMDSv2 role credentials.\n + ``required`` - IMDSv2 is required. You must send a session token in your instance metadata retrieval requests. With this option, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available.\n \n Default: If the value of ``ImdsSupport`` for the Amazon Machine Image (AMI) for your instance is ``v2.0``, the default is ``required``.", "type": "string" }, "InstanceMetadataTags": { - "description": "Set to enabled to allow access to instance tags from the instance metadata.", + "description": "Set to ``enabled`` to allow access to instance tags from the instance metadata. Set to ``disabled`` to turn off access to instance tags from the instance metadata. For more information, see [Work with instance tags using the instance metadata](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#work-with-tags-in-IMDS).\n Default: ``disabled``", "type": "string" } }, @@ -703,10 +734,10 @@ }, "Monitoring": { "additionalProperties": false, - "description": "Specifies whether detailed monitoring is enabled for an instance.", + "description": "Specifies whether detailed monitoring is enabled for an instance. For more information about detailed monitoring, see [Enable or turn off detailed monitoring for your instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-cloudwatch-new.html) in the *User Guide*.\n ``Monitoring`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).", "properties": { "Enabled": { - "description": "Specify true to enable detailed monitoring.", + "description": "Specify ``true`` to enable detailed monitoring. Otherwise, basic monitoring is enabled.", "type": "boolean" } }, @@ -714,14 +745,14 @@ }, "NetworkBandwidthGbps": { "additionalProperties": false, - "description": "The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).", + "description": "The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).\n Setting the minimum bandwidth does not guarantee that your instance will achieve the minimum bandwidth. Amazon EC2 will identify instance types that support the specified minimum bandwidth, but the actual bandwidth of your instance might go below the specified minimum 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*.", "properties": { "Max": { - "description": "The maximum amount of network bandwidth, in Gbps.", + "description": "The maximum amount of network bandwidth, in Gbps. To specify no maximum limit, omit this parameter.", "type": "number" }, "Min": { - "description": "The minimum amount of network bandwidth, in Gbps.", + "description": "The minimum amount of network bandwidth, in Gbps. If this parameter is not specified, there is no minimum limit.", "type": "number" } }, @@ -729,18 +760,19 @@ }, "NetworkInterface": { "additionalProperties": false, - "description": "Specifies the parameters for a network interface.", + "description": "Specifies 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).", "properties": { "AssociateCarrierIpAddress": { - "description": "Indicates whether to associate a Carrier IP address with eth0 for a new network interface.", + "description": "Associates a Carrier IP address with eth0 for a new network interface.\n Use this option when you launch an instance in a Wavelength Zone and want to associate a Carrier IP address with the network interface. For more information about Carrier IP addresses, see [Carrier IP addresses](https://docs.aws.amazon.com/wavelength/latest/developerguide/how-wavelengths-work.html#provider-owned-ip) in the *Developer Guide*.", "type": "boolean" }, "AssociatePublicIpAddress": { - "description": "Associates a public IPv4 address with eth0 for a new network interface.", + "description": "Associates a public IPv4 address with eth0 for a new network interface.\n AWS charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the *Public IPv4 Address* tab on the [Amazon VPC pricing page](https://docs.aws.amazon.com/vpc/pricing/).", "type": "boolean" }, "ConnectionTrackingSpecification": { - "$ref": "#/definitions/ConnectionTrackingSpecification" + "$ref": "#/definitions/ConnectionTrackingSpecification", + "description": "A connection tracking specification for the network interface." }, "DeleteOnTermination": { "description": "Indicates whether the network interface is deleted when the instance is terminated.", @@ -751,11 +783,12 @@ "type": "string" }, "DeviceIndex": { - "description": "The device index for the network interface attachment.", + "description": "The device index for the network interface attachment. Each network interface requires a device index. If you create a launch template that includes secondary network interfaces but not a primary network interface, then you must add a primary network interface as a launch parameter when you launch an instance from the template.", "type": "integer" }, "EnaSrdSpecification": { - "$ref": "#/definitions/EnaSrdSpecification" + "$ref": "#/definitions/EnaSrdSpecification", + "description": "The ENA Express configuration for the network interface." }, "Groups": { "description": "The IDs of one or more security groups.", @@ -766,15 +799,15 @@ "uniqueItems": false }, "InterfaceType": { - "description": "The type of network interface.", + "description": "The type of network interface. To create an Elastic Fabric Adapter (EFA), specify ``efa``. For more information, see [Elastic Fabric Adapter](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa.html) in the *Amazon Elastic Compute Cloud User Guide*.\n If you are not creating an EFA, specify ``interface`` or omit this parameter.\n Valid values: ``interface`` | ``efa``", "type": "string" }, "Ipv4PrefixCount": { - "description": "The number of IPv4 prefixes to be automatically assigned to the network interface.", + "description": "The number of IPv4 prefixes to be automatically assigned to the network interface. You cannot use this option if you use the ``Ipv4Prefix`` option.", "type": "integer" }, "Ipv4Prefixes": { - "description": "One or more IPv4 prefixes to be assigned to the network interface.", + "description": "One or more IPv4 prefixes to be assigned to the network interface. You cannot use this option if you use the ``Ipv4PrefixCount`` option.", "items": { "$ref": "#/definitions/Ipv4PrefixSpecification" }, @@ -782,11 +815,11 @@ "uniqueItems": false }, "Ipv6AddressCount": { - "description": "The number of IPv6 addresses to assign to a network interface.", + "description": "The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses.", "type": "integer" }, "Ipv6Addresses": { - "description": "One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet.", + "description": "One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses.", "items": { "$ref": "#/definitions/Ipv6Add" }, @@ -794,11 +827,11 @@ "uniqueItems": false }, "Ipv6PrefixCount": { - "description": "The number of IPv6 prefixes to be automatically assigned to the network interface.", + "description": "The number of IPv6 prefixes to be automatically assigned to the network interface. You cannot use this option if you use the ``Ipv6Prefix`` option.", "type": "integer" }, "Ipv6Prefixes": { - "description": "One or more IPv6 prefixes to be assigned to the network interface.", + "description": "One or more IPv6 prefixes to be assigned to the network interface. You cannot use this option if you use the ``Ipv6PrefixCount`` option.", "items": { "$ref": "#/definitions/Ipv6PrefixSpecification" }, @@ -806,7 +839,7 @@ "uniqueItems": false }, "NetworkCardIndex": { - "description": "The index of the network card.", + "description": "The index of the network card. Some instance types support multiple network cards. The primary network interface must be assigned to network card index 0. The default is network card index 0.", "type": "integer" }, "NetworkInterfaceId": { @@ -814,7 +847,7 @@ "type": "string" }, "PrimaryIpv6": { - "description": "Enables the first IPv6 global unique address (GUA) on a dual stack or IPv6-only ENI immutable.", + "description": "The primary IPv6 address of the network interface. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information about primary IPv6 addresses, see [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html).", "type": "boolean" }, "PrivateIpAddress": { @@ -842,12 +875,14 @@ }, "NetworkInterfaceCount": { "additionalProperties": false, - "description": "TThe minimum and maximum number of network interfaces.", + "description": "The minimum and maximum number of network interfaces.", "properties": { "Max": { + "description": "The maximum number of network interfaces. To specify no maximum limit, omit this parameter.", "type": "integer" }, "Min": { + "description": "The minimum number of network interfaces. To specify no minimum limit, omit this parameter.", "type": "integer" } }, @@ -855,7 +890,7 @@ }, "Placement": { "additionalProperties": false, - "description": "Specifies the placement of an instance.", + "description": "Specifies 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).", "properties": { "Affinity": { "description": "The affinity setting for an instance on a Dedicated Host.", @@ -866,7 +901,7 @@ "type": "string" }, "GroupId": { - "description": "The Group Id of a placement group. You must specify the Placement Group Group Id to launch an instance in a shared placement group.", + "description": "The Group Id of a placement group. You must specify the Placement Group *Group Id* to launch an instance in a shared placement group.", "type": "string" }, "GroupName": { @@ -878,11 +913,11 @@ "type": "string" }, "HostResourceGroupArn": { - "description": "The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host.", + "description": "The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the *Tenancy* parameter or set it to ``host``.", "type": "string" }, "PartitionNumber": { - "description": "The number of the partition the instance should launch in. Valid only if the placement group strategy is set to partition.", + "description": "The number of the partition the instance should launch in. Valid only if the placement group strategy is set to ``partition``.", "type": "integer" }, "SpreadDomain": { @@ -890,7 +925,7 @@ "type": "string" }, "Tenancy": { - "description": "The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.", + "description": "The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware.", "type": "string" } }, @@ -898,7 +933,7 @@ }, "PrivateDnsNameOptions": { "additionalProperties": false, - "description": "Describes the options for instance hostnames.", + "description": "The 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 *User Guide*.", "properties": { "EnableResourceNameDnsAAAARecord": { "description": "Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.", @@ -909,7 +944,7 @@ "type": "boolean" }, "HostnameType": { - "description": "The type of hostname for EC2 instances.", + "description": "The type of hostname for EC2 instances. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names 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 *User Guide*.", "type": "string" } }, @@ -917,7 +952,7 @@ }, "PrivateIpAdd": { "additionalProperties": false, - "description": "Specifies a secondary private IPv4 address for a network interface.", + "description": "Specifies 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).", "properties": { "Primary": { "description": "Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.", @@ -932,26 +967,26 @@ }, "SpotOptions": { "additionalProperties": false, - "description": "Specifies options for Spot Instances.", + "description": "Specifies 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).", "properties": { "BlockDurationMinutes": { - "description": "Deprecated", + "description": "Deprecated.", "type": "integer" }, "InstanceInterruptionBehavior": { - "description": "The behavior when a Spot Instance is interrupted. The default is terminate.", + "description": "The behavior when a Spot Instance is interrupted. The default is ``terminate``.", "type": "string" }, "MaxPrice": { - "description": "The maximum hourly price you're willing to pay for the Spot Instances.", + "description": "The maximum hourly price you're willing to pay for the Spot Instances. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.\n If you specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter.", "type": "string" }, "SpotInstanceType": { - "description": "The Spot Instance request type.", + "description": "The Spot Instance request type.\n If you are using Spot Instances with an Auto Scaling group, use ``one-time`` requests, as the ASlong service handles requesting new Spot Instances whenever the group is below its desired capacity.", "type": "string" }, "ValidUntil": { - "description": "The end date of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ). Supported only for persistent requests.", + "description": "The end date of the request, in UTC format (*YYYY-MM-DD*T*HH:MM:SS*Z). Supported only for persistent requests.\n + For a persistent request, the request remains active until the ``ValidUntil`` date and time is reached. Otherwise, the request remains active until you cancel it.\n + For a one-time request, ``ValidUntil`` is not supported. The request remains active until all instances launch or you cancel the request.\n \n Default: 7 days from the current date", "type": "string" } }, @@ -959,12 +994,14 @@ }, "Tag": { "additionalProperties": false, - "description": "The user data to make available to the instance.", + "description": "Specifies a tag. For more information, see [Add tags to a resource](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#cloudformation-add-tag-specifications).", "properties": { "Key": { + "description": "The tag key.", "type": "string" }, "Value": { + "description": "The tag value.", "type": "string" } }, @@ -976,14 +1013,14 @@ }, "TagSpecification": { "additionalProperties": false, - "description": "Specifies the tags to apply to a resource when the resource is created for the launch template.", + "description": "Specifies the tags to apply to a resource when the resource is created for the launch template.\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). [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).", "properties": { "ResourceType": { - "description": "The type of resource to tag.", + "description": "The type of resource to tag.\n Valid Values lists all resource types for Amazon EC2 that can be tagged. When you create a launch template, you can specify tags for the following resource types only: ``instance`` | ``volume`` | ``network-interface`` | ``spot-instances-request``. If the instance does not include the resource type that you specify, the instance launch fails. For example, not all instance types include a volume.\n To tag a resource after it has been created, see [CreateTags](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html).", "type": "string" }, "Tags": { - "description": "The tags for the resource.", + "description": "The tags to apply to the resource.", "items": { "$ref": "#/definitions/Tag" }, @@ -998,9 +1035,11 @@ "description": "The minimum and maximum amount of total local storage, in GB.", "properties": { "Max": { + "description": "The maximum amount of total local storage, in GB. To specify no maximum limit, omit this parameter.", "type": "number" }, "Min": { + "description": "The minimum amount of total local storage, in GB. To specify no minimum limit, omit this parameter.", "type": "number" } }, @@ -1011,18 +1050,18 @@ "description": "The minimum and maximum number of vCPUs.", "properties": { "Max": { - "description": "The maximum number of vCPUs.", + "description": "The maximum number of vCPUs. To specify no maximum limit, omit this parameter.", "type": "integer" }, "Min": { - "description": "The minimum number of vCPUs.", + "description": "The minimum number of vCPUs. To specify no minimum limit, specify ``0``.", "type": "integer" } }, "type": "object" } }, - "description": "Resource Type definition for AWS::EC2::LaunchTemplate", + "description": "Specifies the properties for creating a launch template.\n The 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 name, CFN creates a name for you.\n \n A launch template can contain some or all of the configuration information to launch an instance. When you launch an instance using a launch template, instance properties that are not specified in the launch template use default values, except the ``ImageId`` property, which has no default value. If you do not specify an AMI ID for the launch template ``ImageId`` property, you must specify an AMI ID for the instance ``ImageId`` property.\n For more information, see [Launch an instance from a launch template](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html) in the *Amazon EC2 User Guide*.", "handlers": { "create": { "permissions": [ @@ -1058,18 +1097,19 @@ ], "properties": { "DefaultVersionNumber": { - "description": "The default version of the launch template", + "description": "", "type": "string" }, "LatestVersionNumber": { - "description": "The latest version of the launch template", + "description": "", "type": "string" }, "LaunchTemplateData": { - "$ref": "#/definitions/LaunchTemplateData" + "$ref": "#/definitions/LaunchTemplateData", + "description": "The information for the launch template." }, "LaunchTemplateId": { - "description": "LaunchTemplate ID generated by service", + "description": "", "type": "string" }, "LaunchTemplateName": { @@ -1077,7 +1117,7 @@ "type": "string" }, "TagSpecifications": { - "description": "The tags to apply to the launch template on creation.", + "description": "The tags to apply to the launch template on creation. To tag the launch template, the resource type must be ``launch-template``.\n To specify the tags for the resources that are created when an instance is launched, you must use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-tagspecifications).", "items": { "$ref": "#/definitions/LaunchTemplateTagSpecification" }, diff --git a/artifacts/types/AWS::EC2::LocalGatewayRoute.json b/artifacts/types/AWS::EC2::LocalGatewayRoute.json index 1d8759e0..cecb0552 100644 --- a/artifacts/types/AWS::EC2::LocalGatewayRoute.json +++ b/artifacts/types/AWS::EC2::LocalGatewayRoute.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-LocalGatewayRoute", "type": "AWS::EC2::LocalGatewayRoute", - "time": "2023-10-13T12:01:03.777Z", + "time": "2024-06-07T11:27:47.768Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::EC2::LocalGatewayRouteTable.json b/artifacts/types/AWS::EC2::LocalGatewayRouteTable.json index 10aed587..ec1d73d3 100644 --- a/artifacts/types/AWS::EC2::LocalGatewayRouteTable.json +++ b/artifacts/types/AWS::EC2::LocalGatewayRouteTable.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-LocalGatewayRouteTable", "type": "AWS::EC2::LocalGatewayRouteTable", - "time": "2023-10-13T11:54:04.051Z", + "time": "2024-06-07T11:25:26.59Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::EC2::LocalGatewayRouteTableVPCAssociation.json b/artifacts/types/AWS::EC2::LocalGatewayRouteTableVPCAssociation.json index 66c4a96f..81d78931 100644 --- a/artifacts/types/AWS::EC2::LocalGatewayRouteTableVPCAssociation.json +++ b/artifacts/types/AWS::EC2::LocalGatewayRouteTableVPCAssociation.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-LocalGatewayRouteTableVPCAssociation", "type": "AWS::EC2::LocalGatewayRouteTableVPCAssociation", - "time": "2023-10-13T12:01:01.941Z", + "time": "2024-06-07T11:27:53.69Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::EC2::LocalGatewayRouteTableVirtualInterfaceGroupAssociation.json b/artifacts/types/AWS::EC2::LocalGatewayRouteTableVirtualInterfaceGroupAssociation.json index 2f26c3c7..1b6070df 100644 --- a/artifacts/types/AWS::EC2::LocalGatewayRouteTableVirtualInterfaceGroupAssociation.json +++ b/artifacts/types/AWS::EC2::LocalGatewayRouteTableVirtualInterfaceGroupAssociation.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-LocalGatewayRouteTableVirtualInterfaceGroupAssociation", "type": "AWS::EC2::LocalGatewayRouteTableVirtualInterfaceGroupAssociation", - "time": "2023-10-13T12:01:05.833Z", + "time": "2024-06-07T11:28:49.706Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::EC2::NatGateway.json b/artifacts/types/AWS::EC2::NatGateway.json index 97c6df96..314c1494 100644 --- a/artifacts/types/AWS::EC2::NatGateway.json +++ b/artifacts/types/AWS::EC2::NatGateway.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-NatGateway", "type": "AWS::EC2::NatGateway", - "time": "2024-01-04T18:53:41.733Z", + "time": "2024-06-18T17:31:50.136Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -13,11 +13,14 @@ "definitions": { "Tag": { "additionalProperties": false, + "description": "Specifies a tag. For more information, see [Add tags to a resource](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#cloudformation-add-tag-specifications).", "properties": { "Key": { + "description": "The tag key.", "type": "string" }, "Value": { + "description": "The tag value.", "type": "string" } }, @@ -28,7 +31,7 @@ "type": "object" } }, - "description": "Resource Type definition for AWS::EC2::NatGateway", + "description": "Specifies a network address translation (NAT) gateway in the specified subnet. You can create either a public NAT gateway or a private NAT gateway. The default is a public NAT gateway. If you create a public NAT gateway, you must specify an elastic IP address.\n With a NAT gateway, instances in a private subnet can connect to the internet, other AWS services, or an on-premises network using the IP address of the NAT gateway. For more information, see [NAT gateways](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html) in the *Amazon VPC User Guide*.\n If you add a default route (``AWS::EC2::Route`` resource) that points to a NAT gateway, specify the NAT gateway ID for the route's ``NatGatewayId`` property.\n When you associate an Elastic IP address or secondary Elastic IP address with a public NAT gateway, the network border group of the Elastic IP address must match the network border group of the Availability Zone (AZ) that the public NAT gateway is in. Otherwise, the NAT gateway fails to launch. You can see the network border group for the AZ by viewing the details of the subnet. Similarly, you can view the network border group for the Elastic IP address 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) in the *Amazon VPC User Guide*.", "handlers": { "create": { "permissions": [ @@ -70,21 +73,27 @@ ], "properties": { "AllocationId": { + "description": "[Public NAT gateway only] The allocation ID of the Elastic IP address that's associated with the NAT gateway. This property is required for a public NAT gateway and cannot be specified with a private NAT gateway.", "type": "string" }, "ConnectivityType": { + "description": "Indicates whether the NAT gateway supports public or private connectivity. The default is public connectivity.", "type": "string" }, "MaxDrainDurationSeconds": { + "description": "The maximum amount of time to wait (in seconds) before forcibly releasing the IP addresses if connections are still in progress. Default value is 350 seconds.", "type": "integer" }, "NatGatewayId": { + "description": "", "type": "string" }, "PrivateIpAddress": { + "description": "The private IPv4 address to assign to the NAT gateway. If you don't provide an address, a private IPv4 address will be automatically assigned.", "type": "string" }, "SecondaryAllocationIds": { + "description": "Secondary EIP allocation IDs. For more information, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon VPC User Guide*.", "insertionOrder": true, "items": { "type": "string" @@ -93,10 +102,12 @@ "uniqueItems": true }, "SecondaryPrivateIpAddressCount": { + "description": "[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.", "minimum": 1, "type": "integer" }, "SecondaryPrivateIpAddresses": { + "description": "Secondary private IPv4 addresses. For more information about secondary addresses, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon Virtual Private Cloud User Guide*.\n ``SecondaryPrivateIpAddressCount`` and ``SecondaryPrivateIpAddresses`` cannot be set at the same time.", "insertionOrder": true, "items": { "type": "string" @@ -105,9 +116,11 @@ "uniqueItems": true }, "SubnetId": { + "description": "The ID of the subnet in which the NAT gateway is located.", "type": "string" }, "Tags": { + "description": "The tags for the NAT gateway.", "insertionOrder": false, "items": { "$ref": "#/definitions/Tag" diff --git a/artifacts/types/AWS::EC2::NetworkAcl.json b/artifacts/types/AWS::EC2::NetworkAcl.json index bfdeb742..bf658ce0 100644 --- a/artifacts/types/AWS::EC2::NetworkAcl.json +++ b/artifacts/types/AWS::EC2::NetworkAcl.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-NetworkAcl", "type": "AWS::EC2::NetworkAcl", - "time": "2023-10-17T05:05:32.631Z", + "time": "2024-06-21T18:45:17.115Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -10,11 +10,14 @@ "definitions": { "Tag": { "additionalProperties": false, + "description": "Specifies a tag. For more information, see [Add tags to a resource](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#cloudformation-add-tag-specifications).", "properties": { "Key": { + "description": "The tag key.", "type": "string" }, "Value": { + "description": "The tag value.", "type": "string" } }, @@ -25,7 +28,7 @@ "type": "object" } }, - "description": "Resource Type definition for AWS::EC2::NetworkAcl", + "description": "Specifies a network ACL for your VPC.", "handlers": { "create": { "permissions": [ @@ -65,10 +68,11 @@ ], "properties": { "Id": { + "description": "", "type": "string" }, "Tags": { - "description": "The tags to assign to the network ACL.", + "description": "The tags for the network ACL.", "insertionOrder": false, "items": { "$ref": "#/definitions/Tag" @@ -77,7 +81,7 @@ "uniqueItems": false }, "VpcId": { - "description": "The ID of the VPC.", + "description": "The ID of the VPC for the network ACL.", "type": "string" } }, diff --git a/artifacts/types/AWS::EC2::NetworkInsightsAccessScope.json b/artifacts/types/AWS::EC2::NetworkInsightsAccessScope.json index 2b22b077..906fe196 100644 --- a/artifacts/types/AWS::EC2::NetworkInsightsAccessScope.json +++ b/artifacts/types/AWS::EC2::NetworkInsightsAccessScope.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-NetworkInsightsAccessScope", "type": "AWS::EC2::NetworkInsightsAccessScope", - "time": "2024-01-03T16:30:42.236Z", + "time": "2024-04-10T15:17:05.55Z", "schema": { "additionalIdentifiers": [ [ diff --git a/artifacts/types/AWS::EC2::NetworkInsightsAccessScopeAnalysis.json b/artifacts/types/AWS::EC2::NetworkInsightsAccessScopeAnalysis.json index f38d44d1..45136796 100644 --- a/artifacts/types/AWS::EC2::NetworkInsightsAccessScopeAnalysis.json +++ b/artifacts/types/AWS::EC2::NetworkInsightsAccessScopeAnalysis.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-NetworkInsightsAccessScopeAnalysis", "type": "AWS::EC2::NetworkInsightsAccessScopeAnalysis", - "time": "2024-01-03T16:20:35.065Z", + "time": "2024-04-10T15:17:04.732Z", "schema": { "additionalIdentifiers": [ [ diff --git a/artifacts/types/AWS::EC2::NetworkInsightsAnalysis.json b/artifacts/types/AWS::EC2::NetworkInsightsAnalysis.json index 65e31749..734ff23d 100644 --- a/artifacts/types/AWS::EC2::NetworkInsightsAnalysis.json +++ b/artifacts/types/AWS::EC2::NetworkInsightsAnalysis.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-NetworkInsightsAnalysis", "type": "AWS::EC2::NetworkInsightsAnalysis", - "time": "2024-01-03T16:20:35.05Z", + "time": "2024-04-10T15:17:04.806Z", "schema": { "additionalIdentifiers": [ [ @@ -695,8 +695,6 @@ "/properties/StartDate", "/properties/Status", "/properties/StatusMessage", - "/properties/ErrorCode", - "/properties/ErrorMessage", "/properties/NetworkPathFound", "/properties/ForwardPathComponents", "/properties/ReturnPathComponents", diff --git a/artifacts/types/AWS::EC2::NetworkInsightsPath.json b/artifacts/types/AWS::EC2::NetworkInsightsPath.json index 6be2bb19..2ba4344b 100644 --- a/artifacts/types/AWS::EC2::NetworkInsightsPath.json +++ b/artifacts/types/AWS::EC2::NetworkInsightsPath.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-NetworkInsightsPath", "type": "AWS::EC2::NetworkInsightsPath", - "time": "2024-01-03T16:35:41.33Z", + "time": "2024-04-10T15:17:04.996Z", "schema": { "additionalIdentifiers": [ [ diff --git a/artifacts/types/AWS::EC2::NetworkInterface.json b/artifacts/types/AWS::EC2::NetworkInterface.json index 17596248..046515f5 100644 --- a/artifacts/types/AWS::EC2::NetworkInterface.json +++ b/artifacts/types/AWS::EC2::NetworkInterface.json @@ -1,13 +1,14 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-NetworkInterface", "type": "AWS::EC2::NetworkInterface", - "time": "2024-01-03T19:01:38.491Z", + "time": "2024-03-26T15:50:33.265Z", "schema": { "$schema": "https://raw.githubusercontent.com/aws-cloudformation/cloudformation-resource-schema/master/src/main/resources/schema/provider.definition.schema.v1.json", "additionalProperties": false, "conditionalCreateOnlyProperties": [ "/properties/PrivateIpAddresses", - "/properties/EnablePrimaryIpv6" + "/properties/EnablePrimaryIpv6", + "/properties/ConnectionTrackingSpecification" ], "createOnlyProperties": [ "/properties/PrivateIpAddress", @@ -15,6 +16,21 @@ "/properties/SubnetId" ], "definitions": { + "ConnectionTrackingSpecification": { + "additionalProperties": false, + "properties": { + "TcpEstablishedTimeout": { + "type": "integer" + }, + "UdpStreamTimeout": { + "type": "integer" + }, + "UdpTimeout": { + "type": "integer" + } + }, + "type": "object" + }, "InstanceIpv6Address": { "additionalProperties": false, "properties": { @@ -127,6 +143,9 @@ "/properties/Id" ], "properties": { + "ConnectionTrackingSpecification": { + "$ref": "#/definitions/ConnectionTrackingSpecification" + }, "Description": { "description": "A description for the network interface.", "type": "string" @@ -241,13 +260,18 @@ }, "type": "array", "uniqueItems": false + }, + "VpcId": { + "description": "The ID of the VPC", + "type": "string" } }, "readOnlyProperties": [ "/properties/Id", "/properties/SecondaryPrivateIpAddresses", "/properties/PrimaryPrivateIpAddress", - "/properties/PrimaryIpv6Address" + "/properties/PrimaryIpv6Address", + "/properties/VpcId" ], "required": [ "SubnetId" diff --git a/artifacts/types/AWS::EC2::NetworkInterfaceAttachment.json b/artifacts/types/AWS::EC2::NetworkInterfaceAttachment.json index 7ef47ce1..e820f66f 100644 --- a/artifacts/types/AWS::EC2::NetworkInterfaceAttachment.json +++ b/artifacts/types/AWS::EC2::NetworkInterfaceAttachment.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-NetworkInterfaceAttachment", "type": "AWS::EC2::NetworkInterfaceAttachment", - "time": "2023-11-02T15:28:15.605Z", + "time": "2024-06-11T16:08:22.494Z", "schema": { "additionalIdentifiers": [ [ @@ -14,6 +14,26 @@ "/properties/InstanceId", "/properties/NetworkInterfaceId" ], + "definitions": { + "EnaSrdSpecification": { + "additionalProperties": false, + "properties": { + "EnaSrdEnabled": { + "type": "boolean" + }, + "EnaSrdUdpSpecification": { + "additionalProperties": false, + "properties": { + "EnaSrdUdpEnabled": { + "type": "boolean" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, "description": "Resource Type definition for AWS::EC2::NetworkInterfaceAttachment", "handlers": { "create": { @@ -65,6 +85,9 @@ "description": "The network interface's position in the attachment order. For example, the first attached network interface has a DeviceIndex of 0.", "type": "string" }, + "EnaSrdSpecification": { + "$ref": "#/definitions/EnaSrdSpecification" + }, "InstanceId": { "description": "The ID of the instance to which you will attach the ENI.", "type": "string" diff --git a/artifacts/types/AWS::EC2::PrefixList.json b/artifacts/types/AWS::EC2::PrefixList.json index 48f3c800..a18ccc47 100644 --- a/artifacts/types/AWS::EC2::PrefixList.json +++ b/artifacts/types/AWS::EC2::PrefixList.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-PrefixList", "type": "AWS::EC2::PrefixList", - "time": "2023-12-21T16:42:32.126Z", + "time": "2024-06-20T15:52:41.967Z", "schema": { "additionalProperties": false, "definitions": { @@ -142,7 +142,6 @@ ], "required": [ "PrefixListName", - "MaxEntries", "AddressFamily" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", diff --git a/artifacts/types/AWS::EC2::Route.json b/artifacts/types/AWS::EC2::Route.json index d0be6bf6..e6243ebb 100644 --- a/artifacts/types/AWS::EC2::Route.json +++ b/artifacts/types/AWS::EC2::Route.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-Route", "type": "AWS::EC2::Route", - "time": "2023-12-26T18:14:36.622Z", + "time": "2024-06-24T16:02:59.274Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -10,7 +10,7 @@ "/properties/DestinationIpv6CidrBlock", "/properties/DestinationPrefixListId" ], - "description": "Resource Type definition for AWS::EC2::Route", + "description": "Specifies 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) in the *Amazon VPC User Guide*.\n You must specify either a destination CIDR block or prefix list ID. You must also specify exactly one of the resources as the target.\n If you create a route that references a transit gateway in the same template where you create the transit gateway, you must declare a dependency on the transit gateway attachment. The route table cannot use the transit gateway until it has successfully attached to the VPC. Add a [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) in the ``AWS::EC2::Route`` resource to explicitly declare a dependency on the ``AWS::EC2::TransitGatewayAttachment`` resource.", "handlers": { "create": { "permissions": [ @@ -59,11 +59,11 @@ ], "properties": { "CarrierGatewayId": { - "description": "The ID of the carrier gateway.", + "description": "The ID of the carrier gateway.\n You can only use this option when the VPC contains a subnet which is associated with a Wavelength Zone.", "type": "string" }, "CidrBlock": { - "description": "The primary identifier of the resource generated by the service.", + "description": "", "type": "string" }, "CoreNetworkArn": { @@ -71,19 +71,19 @@ "type": "string" }, "DestinationCidrBlock": { - "description": "The IPv4 CIDR block used for the destination match.", + "description": "The 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``.", "type": "string" }, "DestinationIpv6CidrBlock": { - "description": "The IPv6 CIDR block used for the destination match.", + "description": "The IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match.", "type": "string" }, "DestinationPrefixListId": { - "description": "The ID of managed prefix list, it's a set of one or more CIDR blocks.", + "description": "The ID of a prefix list used for the destination match.", "type": "string" }, "EgressOnlyInternetGatewayId": { - "description": "The ID of the egress-only internet gateway.", + "description": "[IPv6 traffic only] The ID of an egress-only internet gateway.", "type": "string" }, "GatewayId": { @@ -91,7 +91,7 @@ "type": "string" }, "InstanceId": { - "description": "The ID of a NAT instance in your VPC.", + "description": "The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached.", "type": "string" }, "LocalGatewayId": { @@ -99,15 +99,15 @@ "type": "string" }, "NatGatewayId": { - "description": "The ID of a NAT gateway.", + "description": "[IPv4 traffic only] The ID of a NAT gateway.", "type": "string" }, "NetworkInterfaceId": { - "description": "The ID of the network interface.", + "description": "The ID of a network interface.", "type": "string" }, "RouteTableId": { - "description": "The ID of the route table. The routing table must be associated with the same VPC that the virtual private gateway is attached to.", + "description": "The ID of the route table for the route.", "type": "string" }, "TransitGatewayId": { diff --git a/artifacts/types/AWS::EC2::RouteTable.json b/artifacts/types/AWS::EC2::RouteTable.json index 0e459e6c..60d82f5d 100644 --- a/artifacts/types/AWS::EC2::RouteTable.json +++ b/artifacts/types/AWS::EC2::RouteTable.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-RouteTable", "type": "AWS::EC2::RouteTable", - "time": "2023-10-18T03:14:41.104Z", + "time": "2024-06-21T21:19:17.394Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -10,11 +10,14 @@ "definitions": { "Tag": { "additionalProperties": false, + "description": "Specifies a tag. For more information, see [Add tags to a resource](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#cloudformation-add-tag-specifications).", "properties": { "Key": { + "description": "The tag key.", "type": "string" }, "Value": { + "description": "The tag value.", "type": "string" } }, @@ -25,7 +28,7 @@ "type": "object" } }, - "description": "Resource Type definition for AWS::EC2::RouteTable", + "description": "Specifies a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet.\n For more information, see [Route tables](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html) in the *Amazon VPC User Guide*.", "handlers": { "create": { "permissions": [ @@ -63,7 +66,7 @@ ], "properties": { "RouteTableId": { - "description": "The route table ID.", + "description": "", "type": "string" }, "Tags": { diff --git a/artifacts/types/AWS::EC2::SecurityGroup.json b/artifacts/types/AWS::EC2::SecurityGroup.json index a1a021e7..8edc34cd 100644 --- a/artifacts/types/AWS::EC2::SecurityGroup.json +++ b/artifacts/types/AWS::EC2::SecurityGroup.json @@ -1,8 +1,9 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-SecurityGroup", "type": "AWS::EC2::SecurityGroup", - "time": "2023-11-16T16:52:44.738Z", + "time": "2024-04-01T16:25:54.57Z", "schema": { + "$schema": "https://raw.githubusercontent.com/aws-cloudformation/cloudformation-resource-schema/master/src/main/resources/schema/provider.definition.schema.v1.json", "additionalProperties": false, "createOnlyProperties": [ "/properties/GroupDescription", @@ -99,24 +100,72 @@ "type": "object" } }, + "deprecatedProperties": [ + "/properties/SecurityGroupEgress/*/SourceSecurityGroupId" + ], "description": "Resource Type definition for AWS::EC2::SecurityGroup", + "handlers": { + "create": { + "permissions": [ + "ec2:CreateSecurityGroup", + "ec2:DescribeSecurityGroups", + "ec2:RevokeSecurityGroupEgress", + "ec2:AuthorizeSecurityGroupEgress", + "ec2:AuthorizeSecurityGroupIngress", + "ec2:CreateTags" + ] + }, + "delete": { + "permissions": [ + "ec2:DeleteSecurityGroup", + "ec2:DescribeInstances" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeSecurityGroups" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeSecurityGroups" + ] + }, + "update": { + "permissions": [ + "ec2:RevokeSecurityGroupEgress", + "ec2:RevokeSecurityGroupIngress", + "ec2:DescribeSecurityGroups", + "ec2:AuthorizeSecurityGroupEgress", + "ec2:AuthorizeSecurityGroupIngress", + "ec2:CreateTags", + "ec2:DeleteTags" + ] + } + }, "primaryIdentifier": [ "/properties/Id" ], "properties": { "GroupDescription": { + "description": "A description for the security group.", "type": "string" }, "GroupId": { + "description": "The group ID of the specified security group.", "type": "string" }, "GroupName": { + "description": "The name of the security group.", "type": "string" }, "Id": { + "description": "The group name or group ID depending on whether the SG is created in default or specific VPC", "type": "string" }, "SecurityGroupEgress": { + "description": "[VPC only] The outbound rules associated with the security group. There is a short interruption during which you cannot connect to the security group.", + "insertionOrder": false, "items": { "$ref": "#/definitions/Egress" }, @@ -124,6 +173,8 @@ "uniqueItems": false }, "SecurityGroupIngress": { + "description": "The inbound rules associated with the security group. There is a short interruption during which you cannot connect to the security group.", + "insertionOrder": false, "items": { "$ref": "#/definitions/Ingress" }, @@ -131,6 +182,8 @@ "uniqueItems": false }, "Tags": { + "description": "Any tags assigned to the security group.", + "insertionOrder": false, "items": { "$ref": "#/definitions/Tag" }, @@ -138,9 +191,18 @@ "uniqueItems": false }, "VpcId": { + "description": "The ID of the VPC for the security group.", "type": "string" } }, + "propertyTransform": { + "/properties/SecurityGroupEgress/*/FromPort": "($mapVal := $lookup({'1': 'icmp','6': 'tcp','17': 'udp','58': 'icmpv6'}, IpProtocol);$ipProtocol := $mapVal ? $mapVal : $lowercase(IpProtocol);$ipProtocol in ['imcp', 'tcp', 'udp', 'imcp'] ? FromPort : -1)", + "/properties/SecurityGroupEgress/*/IpProtocol": "($mapVal := $lookup({'1': 'icmp','6': 'tcp','17': 'udp','58': 'icmpv6'}, IpProtocol);$mapVal ? $mapVal : $lowercase(IpProtocol))", + "/properties/SecurityGroupEgress/*/ToPort": "($mapVal := $lookup({'1': 'icmp','6': 'tcp','17': 'udp','58': 'icmpv6'}, IpProtocol);$ipProtocol := $mapVal ? $mapVal : $lowercase(IpProtocol);$ipProtocol in ['imcp', 'tcp', 'udp', 'imcp'] ? ToPort : -1)", + "/properties/SecurityGroupIngress/*/FromPort": "($mapVal := $lookup({'1': 'icmp','6': 'tcp','17': 'udp','58': 'icmpv6'}, IpProtocol);$ipProtocol := $mapVal ? $mapVal : $lowercase(IpProtocol);$ipProtocol in ['imcp', 'tcp', 'udp', 'imcp'] ? FromPort : -1)", + "/properties/SecurityGroupIngress/*/IpProtocol": "($mapVal := $lookup({'1': 'icmp','6': 'tcp','17': 'udp','58': 'icmpv6'}, IpProtocol);$mapVal ? $mapVal : $lowercase(IpProtocol))", + "/properties/SecurityGroupIngress/*/ToPort": "($mapVal := $lookup({'1': 'icmp','6': 'tcp','17': 'udp','58': 'icmpv6'}, IpProtocol);$ipProtocol := $mapVal ? $mapVal : $lowercase(IpProtocol);$ipProtocol in ['imcp', 'tcp', 'udp', 'imcp'] ? ToPort : -1)" + }, "readOnlyProperties": [ "/properties/Id", "/properties/GroupId" @@ -148,6 +210,16 @@ "required": [ "GroupDescription" ], - "typeName": "AWS::EC2::SecurityGroup" + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::EC2::SecurityGroup", + "writeOnlyProperties": [ + "/properties/SecurityGroupIngress/*/SourceSecurityGroupName" + ] } } \ No newline at end of file diff --git a/artifacts/types/AWS::EC2::SecurityGroupEgress.json b/artifacts/types/AWS::EC2::SecurityGroupEgress.json index 4daf5940..96395dad 100644 --- a/artifacts/types/AWS::EC2::SecurityGroupEgress.json +++ b/artifacts/types/AWS::EC2::SecurityGroupEgress.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-SecurityGroupEgress", "type": "AWS::EC2::SecurityGroupEgress", - "time": "2023-12-08T21:39:01.689Z", + "time": "2024-06-18T15:49:08.893Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -14,7 +14,7 @@ "/properties/CidrIpv6", "/properties/DestinationPrefixListId" ], - "description": "Resource Type definition for AWS::EC2::SecurityGroupEgress", + "description": "Adds the specified outbound (egress) rule to a security group.\n An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 address range, the IP addresses that are specified by a prefix list, or the instances that 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).\n You must specify exactly one of the following destinations: an IPv4 address range, an IPv6 address range, a prefix list, or a security group.\n You must specify a protocol for each rule (for example, TCP). If the protocol is TCP or UDP, you must also specify a port or port range. If the protocol is ICMP or ICMPv6, you must also specify the ICMP/ICMPv6 type and code. To specify all types or all codes, use -1.\n Rule changes are propagated to instances associated with the security group as quickly as possible. However, a small delay might occur.", "handlers": { "create": { "permissions": [ @@ -50,27 +50,27 @@ ], "properties": { "CidrIp": { - "description": "The IPv4 ranges", + "description": "The IPv4 address range, in CIDR format.\n You must specify exactly one of the following: ``CidrIp``, ``CidrIpv6``, ``DestinationPrefixListId``, or ``DestinationSecurityGroupId``.\n For 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 *User Guide*.", "type": "string" }, "CidrIpv6": { - "description": "[VPC only] The IPv6 ranges", + "description": "The IPv6 address range, in CIDR format.\n You must specify exactly one of the following: ``CidrIp``, ``CidrIpv6``, ``DestinationPrefixListId``, or ``DestinationSecurityGroupId``.\n For 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 *User Guide*.", "type": "string" }, "Description": { - "description": "Resource Type definition for an egress (outbound) security group rule.", + "description": "The description of an egress (outbound) security group rule.\n Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*", "type": "string" }, "DestinationPrefixListId": { - "description": "[EC2-VPC only] The ID of a prefix list.", + "description": "The prefix list IDs for an AWS service. This is the AWS service to access through a VPC endpoint from instances associated with the security group.\n You must specify exactly one of the following: ``CidrIp``, ``CidrIpv6``, ``DestinationPrefixListId``, or ``DestinationSecurityGroupId``.", "type": "string" }, "DestinationSecurityGroupId": { - "description": "You must specify a destination security group (DestinationPrefixListId or DestinationSecurityGroupId) or a CIDR range (CidrIp or CidrIpv6).", + "description": "The ID of the security group.\n You must specify exactly one of the following: ``CidrIp``, ``CidrIpv6``, ``DestinationPrefixListId``, or ``DestinationSecurityGroupId``.", "type": "string" }, "FromPort": { - "description": "The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.", + "description": "If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types).", "type": "integer" }, "GroupId": { @@ -78,18 +78,23 @@ "type": "string" }, "Id": { - "description": "The Security Group Rule Id", + "description": "", "type": "string" }, "IpProtocol": { - "description": "[VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp, udp, and icmp, you must specify a port range. For icmpv6, the port range is optional; if you omit the port range, traffic for all types and codes is allowed.", + "description": "The IP protocol name (``tcp``, ``udp``, ``icmp``, ``icmpv6``) or number (see [Protocol Numbers](https://docs.aws.amazon.com/http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml)).\n Use ``-1`` to specify all protocols. When authorizing security group rules, specifying ``-1`` or a protocol number other than ``tcp``, ``udp``, ``icmp``, or ``icmpv6`` allows traffic on all ports, regardless of any port range you specify. For ``tcp``, ``udp``, and ``icmp``, you must specify a port range. For ``icmpv6``, the port range is optional; if you omit the port range, traffic for all types and codes is allowed.", "type": "string" }, "ToPort": { - "description": "The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.", + "description": "If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes).", "type": "integer" } }, + "propertyTransform": { + "/properties/FromPort": "($mapVal := $lookup({'1': 'icmp','6': 'tcp','17': 'udp','58': 'icmpv6'}, IpProtocol);$ipProtocol := $mapVal ? $mapVal : $lowercase(IpProtocol);$ipProtocol in ['imcp', 'tcp', 'udp', 'imcp'] ? FromPort : -1)", + "/properties/IpProtocol": "($mapVal := $lookup({'1': 'icmp','6': 'tcp','17': 'udp','58': 'icmpv6'}, IpProtocol);$mapVal ? $mapVal : $lowercase(IpProtocol))", + "/properties/ToPort": "($mapVal := $lookup({'1': 'icmp','6': 'tcp','17': 'udp','58': 'icmpv6'}, IpProtocol);$ipProtocol := $mapVal ? $mapVal : $lowercase(IpProtocol);$ipProtocol in ['imcp', 'tcp', 'udp', 'imcp'] ? ToPort : -1)" + }, "readOnlyProperties": [ "/properties/Id" ], diff --git a/artifacts/types/AWS::EC2::SecurityGroupIngress.json b/artifacts/types/AWS::EC2::SecurityGroupIngress.json new file mode 100644 index 00000000..b21d7275 --- /dev/null +++ b/artifacts/types/AWS::EC2::SecurityGroupIngress.json @@ -0,0 +1,128 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-SecurityGroupIngress", + "type": "AWS::EC2::SecurityGroupIngress", + "time": "2024-06-24T16:02:03.525Z", + "schema": { + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/GroupName", + "/properties/IpProtocol", + "/properties/SourceSecurityGroupId", + "/properties/SourcePrefixListId", + "/properties/ToPort", + "/properties/CidrIp", + "/properties/SourceSecurityGroupName", + "/properties/SourceSecurityGroupOwnerId", + "/properties/FromPort", + "/properties/GroupId", + "/properties/CidrIpv6" + ], + "description": "Resource Type definition for AWS::EC2::SecurityGroupIngress", + "handlers": { + "create": { + "permissions": [ + "ec2:DescribeSecurityGroupRules", + "ec2:AuthorizeSecurityGroupIngress" + ] + }, + "delete": { + "permissions": [ + "ec2:DescribeSecurityGroupRules", + "ec2:RevokeSecurityGroupIngress" + ] + }, + "list": { + "permissions": [ + "ec2:DescribeSecurityGroupRules" + ] + }, + "read": { + "permissions": [ + "ec2:DescribeSecurityGroups", + "ec2:DescribeSecurityGroupRules" + ] + }, + "update": { + "permissions": [ + "ec2:UpdateSecurityGroupRuleDescriptionsIngress" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "CidrIp": { + "description": "The IPv4 ranges", + "type": "string" + }, + "CidrIpv6": { + "description": "[VPC only] The IPv6 ranges", + "type": "string" + }, + "Description": { + "description": "Updates the description of an ingress (inbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously", + "type": "string" + }, + "FromPort": { + "description": "The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.\n\nUse this for ICMP and any protocol that uses ports.", + "type": "integer" + }, + "GroupId": { + "description": "The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.\n\nYou must specify the GroupName property or the GroupId property. For security groups that are in a VPC, you must use the GroupId property.", + "type": "string" + }, + "GroupName": { + "description": "The name of the security group.", + "type": "string" + }, + "Id": { + "description": "The Security Group Rule Id", + "type": "string" + }, + "IpProtocol": { + "description": "The IP protocol name (tcp, udp, icmp, icmpv6) or number (see Protocol Numbers).\n\n[VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp, udp, and icmp, you must specify a port range. For icmpv6, the port range is optional; if you omit the port range, traffic for all types and codes is allowed.", + "type": "string" + }, + "SourcePrefixListId": { + "description": "[EC2-VPC only] The ID of a prefix list.\n\n", + "type": "string" + }, + "SourceSecurityGroupId": { + "description": "The ID of the security group. You must specify either the security group ID or the security group name. For security groups in a nondefault VPC, you must specify the security group ID.", + "type": "string" + }, + "SourceSecurityGroupName": { + "description": "[EC2-Classic, default VPC] The name of the source security group.\n\nYou must specify the GroupName property or the GroupId property. For security groups that are in a VPC, you must use the GroupId property.", + "type": "string" + }, + "SourceSecurityGroupOwnerId": { + "description": "[nondefault VPC] The AWS account ID that owns the source security group. You can't specify this property with an IP address range.\n\nIf you specify SourceSecurityGroupName or SourceSecurityGroupId and that security group is owned by a different account than the account creating the stack, you must specify the SourceSecurityGroupOwnerId; otherwise, this property is optional.", + "type": "string" + }, + "ToPort": { + "description": "The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes for the specified ICMP type. If you specify all ICMP/ICMPv6 types, you must specify all codes.\n\nUse this for ICMP and any protocol that uses ports.", + "type": "integer" + } + }, + "propertyTransform": { + "/properties/FromPort": "($mapVal := $lookup({'1': 'icmp','6': 'tcp','17': 'udp','58': 'icmpv6'}, IpProtocol);$ipProtocol := $mapVal ? $mapVal : $lowercase(IpProtocol);$ipProtocol in ['imcp', 'tcp', 'udp', 'imcp'] ? FromPort : -1)", + "/properties/IpProtocol": "($mapVal := $lookup({'1': 'icmp','6': 'tcp','17': 'udp','58': 'icmpv6'}, IpProtocol);$mapVal ? $mapVal : $lowercase(IpProtocol))", + "/properties/ToPort": "($mapVal := $lookup({'1': 'icmp','6': 'tcp','17': 'udp','58': 'icmpv6'}, IpProtocol);$ipProtocol := $mapVal ? $mapVal : $lowercase(IpProtocol);$ipProtocol in ['imcp', 'tcp', 'udp', 'imcp'] ? ToPort : -1)" + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "IpProtocol" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::EC2::SecurityGroupIngress" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::EC2::SpotFleet.json b/artifacts/types/AWS::EC2::SpotFleet.json index 4a0ffb17..59795021 100644 --- a/artifacts/types/AWS::EC2::SpotFleet.json +++ b/artifacts/types/AWS::EC2::SpotFleet.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-SpotFleet", "type": "AWS::EC2::SpotFleet", - "time": "2023-11-16T01:21:41.821Z", + "time": "2024-06-18T15:59:42.856Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -386,6 +386,9 @@ "type": "array", "uniqueItems": false }, + "MaxSpotPriceAsPercentageOfOptimalOnDemandPrice": { + "type": "integer" + }, "MemoryGiBPerVCpu": { "$ref": "#/definitions/MemoryGiBPerVCpuRequest" }, diff --git a/artifacts/types/AWS::EC2::Subnet.json b/artifacts/types/AWS::EC2::Subnet.json index 19ccfcb7..d5f6b92b 100644 --- a/artifacts/types/AWS::EC2::Subnet.json +++ b/artifacts/types/AWS::EC2::Subnet.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-Subnet", "type": "AWS::EC2::Subnet", - "time": "2024-01-03T16:29:03.787Z", + "time": "2024-06-20T15:53:48.041Z", "schema": { "additionalProperties": false, "conditionalCreateOnlyProperties": [ @@ -22,11 +22,14 @@ "definitions": { "Tag": { "additionalProperties": false, + "description": "Specifies a tag. For more information, see [Add tags to a resource](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#cloudformation-add-tag-specifications).", "properties": { "Key": { + "description": "The tag key.", "type": "string" }, "Value": { + "description": "The tag value.", "type": "string" } }, @@ -37,7 +40,7 @@ "type": "object" } }, - "description": "Resource Type definition for AWS::EC2::Subnet", + "description": "Specifies a subnet for the specified VPC.\n For an IPv4 only subnet, specify an IPv4 CIDR block. If the VPC has an IPv6 CIDR block, you can create an IPv6 only subnet or a dual stack subnet instead. For an IPv6 only subnet, specify an IPv6 CIDR block. For a dual stack subnet, specify both an IPv4 CIDR block and an IPv6 CIDR block.\n For more information, see [Subnets for your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/configure-subnets.html) in the *Amazon VPC User Guide*.", "handlers": { "create": { "permissions": [ @@ -81,32 +84,43 @@ ], "properties": { "AssignIpv6AddressOnCreation": { + "description": "Indicates whether a network interface created in this subnet receives an IPv6 address. The default value is ``false``.\n If you specify ``AssignIpv6AddressOnCreation``, you must also specify an IPv6 CIDR block.", "type": "boolean" }, "AvailabilityZone": { + "description": "The Availability Zone of the subnet.\n If you update this property, you must also update the ``CidrBlock`` property.", "type": "string" }, "AvailabilityZoneId": { + "description": "The AZ ID of the subnet.", "type": "string" }, "CidrBlock": { + "description": "The IPv4 CIDR block assigned to the subnet.\n If you update this property, we create a new subnet, and then delete the existing one.", "type": "string" }, "EnableDns64": { + "description": "Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations. For more information, see [DNS64 and NAT64](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-nat64-dns64) in the *User Guide*.", "type": "boolean" }, + "EnableLniAtDeviceIndex": { + "description": "Indicates the device position for local network interfaces in this subnet. For example, ``1`` indicates local network interfaces in this subnet are the secondary network interface (eth1).", + "type": "integer" + }, "Ipv4IpamPoolId": { - "description": "The ID of an IPv4 IPAM pool you want to use for allocating this subnet's CIDR", + "description": "An IPv4 IPAM pool ID for the subnet.", "type": "string" }, "Ipv4NetmaskLength": { - "description": "The netmask length of the IPv4 CIDR you want to allocate to this subnet from an Amazon VPC IP Address Manager (IPAM) pool", + "description": "An IPv4 netmask length for the subnet.", "type": "integer" }, "Ipv6CidrBlock": { + "description": "The IPv6 CIDR block.\n If you specify ``AssignIpv6AddressOnCreation``, you must also specify an IPv6 CIDR block.", "type": "string" }, "Ipv6CidrBlocks": { + "description": "The IPv6 network ranges for the subnet, in CIDR notation.", "items": { "type": "string" }, @@ -114,27 +128,32 @@ "uniqueItems": false }, "Ipv6IpamPoolId": { - "description": "The ID of an IPv6 IPAM pool you want to use for allocating this subnet's CIDR", + "description": "An IPv6 IPAM pool ID for the subnet.", "type": "string" }, "Ipv6Native": { + "description": "Indicates 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 *User Guide*.", "type": "boolean" }, "Ipv6NetmaskLength": { - "description": "The netmask length of the IPv6 CIDR you want to allocate to this subnet from an Amazon VPC IP Address Manager (IPAM) pool", + "description": "An IPv6 netmask length for the subnet.", "type": "integer" }, "MapPublicIpOnLaunch": { + "description": "Indicates whether instances launched in this subnet receive a public IPv4 address. The default value is ``false``.\n AWS charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the *Public IPv4 Address* tab on the [VPC pricing page](https://docs.aws.amazon.com/vpc/pricing/).", "type": "boolean" }, "NetworkAclAssociationId": { + "description": "", "type": "string" }, "OutpostArn": { + "description": "The Amazon Resource Name (ARN) of the Outpost.", "type": "string" }, "PrivateDnsNameOptionsOnLaunch": { "additionalProperties": false, + "description": "The 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 *User Guide*.\n Available options:\n + EnableResourceNameDnsAAAARecord (true | false)\n + EnableResourceNameDnsARecord (true | false)\n + HostnameType (ip-name | resource-name)", "properties": { "EnableResourceNameDnsAAAARecord": { "type": "boolean" @@ -149,9 +168,11 @@ "type": "object" }, "SubnetId": { + "description": "", "type": "string" }, "Tags": { + "description": "Any tags assigned to the subnet.", "items": { "$ref": "#/definitions/Tag" }, @@ -159,6 +180,7 @@ "uniqueItems": false }, "VpcId": { + "description": "The ID of the VPC the subnet is in.\n If you update this property, you must also update the ``CidrBlock`` property.", "type": "string" } }, @@ -178,6 +200,7 @@ }, "typeName": "AWS::EC2::Subnet", "writeOnlyProperties": [ + "/properties/EnableLniAtDeviceIndex", "/properties/Ipv4IpamPoolId", "/properties/Ipv4NetmaskLength", "/properties/Ipv6IpamPoolId", diff --git a/artifacts/types/AWS::EC2::TransitGateway.json b/artifacts/types/AWS::EC2::TransitGateway.json index 897d545b..376dfbf1 100644 --- a/artifacts/types/AWS::EC2::TransitGateway.json +++ b/artifacts/types/AWS::EC2::TransitGateway.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-TransitGateway", "type": "AWS::EC2::TransitGateway", - "time": "2023-11-27T20:00:16.768Z", + "time": "2024-02-13T16:57:57.646Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::EC2::TransitGatewayAttachment.json b/artifacts/types/AWS::EC2::TransitGatewayAttachment.json index 6025de5f..296e40e0 100644 --- a/artifacts/types/AWS::EC2::TransitGatewayAttachment.json +++ b/artifacts/types/AWS::EC2::TransitGatewayAttachment.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-TransitGatewayAttachment", "type": "AWS::EC2::TransitGatewayAttachment", - "time": "2023-11-27T19:45:55.636Z", + "time": "2024-02-13T17:04:43.958Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::EC2::TransitGatewayConnect.json b/artifacts/types/AWS::EC2::TransitGatewayConnect.json index 49552315..36bb55db 100644 --- a/artifacts/types/AWS::EC2::TransitGatewayConnect.json +++ b/artifacts/types/AWS::EC2::TransitGatewayConnect.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-TransitGatewayConnect", "type": "AWS::EC2::TransitGatewayConnect", - "time": "2023-11-27T19:37:47.379Z", + "time": "2024-02-13T16:57:17.683Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::EC2::TransitGatewayMulticastDomain.json b/artifacts/types/AWS::EC2::TransitGatewayMulticastDomain.json index 246a4a69..3a49bd73 100644 --- a/artifacts/types/AWS::EC2::TransitGatewayMulticastDomain.json +++ b/artifacts/types/AWS::EC2::TransitGatewayMulticastDomain.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-TransitGatewayMulticastDomain", "type": "AWS::EC2::TransitGatewayMulticastDomain", - "time": "2023-11-27T19:20:16.044Z", + "time": "2024-02-13T16:38:01.787Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::EC2::TransitGatewayPeeringAttachment.json b/artifacts/types/AWS::EC2::TransitGatewayPeeringAttachment.json index ab64499e..aae8a03b 100644 --- a/artifacts/types/AWS::EC2::TransitGatewayPeeringAttachment.json +++ b/artifacts/types/AWS::EC2::TransitGatewayPeeringAttachment.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-TransitGatewayPeeringAttachment", "type": "AWS::EC2::TransitGatewayPeeringAttachment", - "time": "2023-11-27T19:04:19.25Z", + "time": "2024-02-13T16:32:36.312Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::EC2::TransitGatewayVpcAttachment.json b/artifacts/types/AWS::EC2::TransitGatewayVpcAttachment.json index ea19fb67..5967e8ec 100644 --- a/artifacts/types/AWS::EC2::TransitGatewayVpcAttachment.json +++ b/artifacts/types/AWS::EC2::TransitGatewayVpcAttachment.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-TransitGatewayVpcAttachment", "type": "AWS::EC2::TransitGatewayVpcAttachment", - "time": "2023-11-27T19:49:57.65Z", + "time": "2024-02-13T17:05:47.036Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::EC2::VPC.json b/artifacts/types/AWS::EC2::VPC.json index 568b1eaa..91aadbd1 100644 --- a/artifacts/types/AWS::EC2::VPC.json +++ b/artifacts/types/AWS::EC2::VPC.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-VPC", "type": "AWS::EC2::VPC", - "time": "2023-12-04T16:27:58.785Z", + "time": "2024-04-16T15:36:43.764Z", "schema": { "additionalProperties": false, "conditionalCreateOnlyProperties": [ @@ -15,11 +15,14 @@ "definitions": { "Tag": { "additionalProperties": false, + "description": "Specifies a tag. For more information, see [Add tags to a resource](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#cloudformation-add-tag-specifications).", "properties": { "Key": { + "description": "The tag key.", "type": "string" }, "Value": { + "description": "The tag value.", "type": "string" } }, @@ -30,7 +33,7 @@ "type": "object" } }, - "description": "Resource Type definition for AWS::EC2::VPC", + "description": "Specifies a virtual private cloud (VPC).\n You can optionally request an IPv6 CIDR block for the VPC. You can request an Amazon-provided IPv6 CIDR block from Amazon's pool of IPv6 addresses, or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses (BYOIP).\n For more information, see [Virtual private clouds (VPC)](https://docs.aws.amazon.com/vpc/latest/userguide/configure-your-vpc.html) in the *Amazon VPC User Guide*.", "handlers": { "create": { "permissions": [ @@ -73,11 +76,11 @@ ], "properties": { "CidrBlock": { - "description": "The primary IPv4 CIDR block for the VPC.", + "description": "The IPv4 network range for the VPC, in CIDR notation. For example, ``10.0.0.0/16``. We modify the specified CIDR block to its canonical form; for example, if you specify ``100.68.0.18/18``, we modify it to ``100.68.0.0/18``.\n You must specify either``CidrBlock`` or ``Ipv4IpamPoolId``.", "type": "string" }, "CidrBlockAssociations": { - "description": "A list of IPv4 CIDR block association IDs for the VPC.", + "description": "", "insertionOrder": false, "items": { "type": "string" @@ -86,37 +89,37 @@ "uniqueItems": false }, "DefaultNetworkAcl": { - "description": "The default network ACL ID that is associated with the VPC.", + "description": "", "insertionOrder": false, "type": "string" }, "DefaultSecurityGroup": { - "description": "The default security group ID that is associated with the VPC.", + "description": "", "insertionOrder": false, "type": "string" }, "EnableDnsHostnames": { - "description": "Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not. Disabled by default for nondefault VPCs.", + "description": "Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not. Disabled by default for nondefault VPCs. For more information, see [DNS attributes in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support).\n You can only enable DNS hostnames if you've enabled DNS support.", "type": "boolean" }, "EnableDnsSupport": { - "description": "Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range \"plus two\" succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled. Enabled by default.", + "description": "Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range \"plus two\" succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled. Enabled by default. For more information, see [DNS attributes in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support).", "type": "boolean" }, "InstanceTenancy": { - "description": "The allowed tenancy of instances launched into the VPC.\n\n\"default\": An instance launched into the VPC runs on shared hardware by default, unless you explicitly specify a different tenancy during instance launch.\n\n\"dedicated\": An instance launched into the VPC is a Dedicated Instance by default, unless you explicitly specify a tenancy of host during instance launch. You cannot specify a tenancy of default during instance launch.\n\nUpdating InstanceTenancy requires no replacement only if you are updating its value from \"dedicated\" to \"default\". Updating InstanceTenancy from \"default\" to \"dedicated\" requires replacement.", + "description": "The allowed tenancy of instances launched into the VPC.\n + ``default``: An instance launched into the VPC runs on shared hardware by default, unless you explicitly specify a different tenancy during instance launch.\n + ``dedicated``: An instance launched into the VPC runs on dedicated hardware by default, unless you explicitly specify a tenancy of ``host`` during instance launch. You cannot specify a tenancy of ``default`` during instance launch.\n \n Updating ``InstanceTenancy`` requires no replacement only if you are updating its value from ``dedicated`` to ``default``. Updating ``InstanceTenancy`` from ``default`` to ``dedicated`` requires replacement.", "type": "string" }, "Ipv4IpamPoolId": { - "description": "The ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR", + "description": "The ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR. For more information, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*.\n You must specify either``CidrBlock`` or ``Ipv4IpamPoolId``.", "type": "string" }, "Ipv4NetmaskLength": { - "description": "The netmask length of the IPv4 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool", + "description": "The netmask length of the IPv4 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*.", "type": "integer" }, "Ipv6CidrBlocks": { - "description": "A list of IPv6 CIDR blocks that are associated with the VPC.", + "description": "", "insertionOrder": false, "items": { "type": "string" @@ -134,7 +137,7 @@ "uniqueItems": false }, "VpcId": { - "description": "The Id for the model.", + "description": "", "type": "string" } }, diff --git a/artifacts/types/AWS::EC2::VPCDHCPOptionsAssociation.json b/artifacts/types/AWS::EC2::VPCDHCPOptionsAssociation.json index a8c3e7d2..851caa46 100644 --- a/artifacts/types/AWS::EC2::VPCDHCPOptionsAssociation.json +++ b/artifacts/types/AWS::EC2::VPCDHCPOptionsAssociation.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-VPCDHCPOptionsAssociation", "type": "AWS::EC2::VPCDHCPOptionsAssociation", - "time": "2023-10-18T15:51:51.764Z", + "time": "2024-06-21T00:53:00.602Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -56,7 +56,12 @@ "DhcpOptionsId" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ec2.git", - "taggable": false, + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, "typeName": "AWS::EC2::VPCDHCPOptionsAssociation" } } \ No newline at end of file diff --git a/artifacts/types/AWS::EC2::VPCEndpoint.json b/artifacts/types/AWS::EC2::VPCEndpoint.json index 7df6fb64..55e7f879 100644 --- a/artifacts/types/AWS::EC2::VPCEndpoint.json +++ b/artifacts/types/AWS::EC2::VPCEndpoint.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-VPCEndpoint", "type": "AWS::EC2::VPCEndpoint", - "time": "2023-08-23T17:53:32.762Z", + "time": "2024-02-27T16:53:16.428Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -9,7 +9,7 @@ "/properties/VpcEndpointType", "/properties/VpcId" ], - "description": "Resource Type definition for AWS::EC2::VPCEndpoint", + "description": "Specifies a VPC endpoint. A VPC endpoint provides a private connection between your VPC and an endpoint service. You can use an endpoint service provided by AWS, an MKT Partner, or another AWS accounts in your organization. For more information, see the [User Guide](https://docs.aws.amazon.com/vpc/latest/privatelink/).\n An endpoint of type ``Interface`` establishes connections between the subnets in your VPC and an AWS-service, your own service, or a service hosted by another AWS-account. With an interface VPC endpoint, you specify the subnets in which to create the endpoint and the security groups to associate with the endpoint network interfaces.\n An endpoint of type ``gateway`` serves as a target for a route in your route table for traffic destined for S3 or DDB. You can specify an endpoint policy for the endpoint, which controls access to the service from your VPC. You can also specify the VPC route tables that use the endpoint. For more information about connectivity to S3, see [W", "handlers": { "create": { "permissions": [ @@ -48,9 +48,11 @@ ], "properties": { "CreationTimestamp": { + "description": "", "type": "string" }, "DnsEntries": { + "description": "", "insertionOrder": false, "items": { "type": "string" @@ -59,9 +61,11 @@ "uniqueItems": false }, "Id": { + "description": "", "type": "string" }, "NetworkInterfaceIds": { + "description": "", "insertionOrder": false, "items": { "type": "string" @@ -70,18 +74,18 @@ "uniqueItems": false }, "PolicyDocument": { - "description": "A policy to attach to the endpoint that controls access to the service.", + "description": "An endpoint policy, which controls access to the service from the VPC. The default endpoint policy allows full access to the service. Endpoint policies are supported only for gateway and interface endpoints.\n For CloudFormation templates in YAML, you can provide the policy in JSON or YAML format. CFNlong converts YAML policies to JSON format before calling the API to create or modify the VPC endpoint.", "type": [ "string", "object" ] }, "PrivateDnsEnabled": { - "description": "Indicate whether to associate a private hosted zone with the specified VPC.", + "description": "Indicate whether to associate a private hosted zone with the specified VPC. The private hosted zone contains a record set for the default public DNS name for the service for the Region (for example, ``kinesis.us-east-1.amazonaws.com``), which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC endpoint service.\n To use a private hosted zone, you must set the following VPC attributes to ``true``: ``enableDnsHostnames`` and ``enableDnsSupport``.\n This property is supported only for interface endpoints.\n Default: ``false``", "type": "boolean" }, "RouteTableIds": { - "description": "One or more route table IDs.", + "description": "The IDs of the route tables. Routing is supported only for gateway endpoints.", "insertionOrder": false, "items": { "type": "string" @@ -90,7 +94,7 @@ "uniqueItems": true }, "SecurityGroupIds": { - "description": "The ID of one or more security groups to associate with the endpoint network interface.", + "description": "The IDs of the security groups to associate with the endpoint network interfaces. If this parameter is not specified, we use the default security group for the VPC. Security groups are supported only for interface endpoints.", "insertionOrder": false, "items": { "type": "string" @@ -99,11 +103,11 @@ "uniqueItems": true }, "ServiceName": { - "description": "The service name.", + "description": "The name of the endpoint service.", "type": "string" }, "SubnetIds": { - "description": "The ID of one or more subnets in which to create an endpoint network interface.", + "description": "The IDs of the subnets in which to create endpoint network interfaces. You must specify this property for an interface endpoint or a Gateway Load Balancer endpoint. You can't specify this property for a gateway endpoint. For a Gateway Load Balancer endpoint, you can specify only one subnet.", "insertionOrder": false, "items": { "type": "string" @@ -112,6 +116,7 @@ "uniqueItems": true }, "VpcEndpointType": { + "description": "The type of endpoint.\n Default: Gateway", "enum": [ "Interface", "Gateway", @@ -120,7 +125,7 @@ "type": "string" }, "VpcId": { - "description": "The ID of the VPC in which the endpoint will be used.", + "description": "The ID of the VPC.", "type": "string" } }, diff --git a/artifacts/types/AWS::EC2::VPCEndpointConnectionNotification.json b/artifacts/types/AWS::EC2::VPCEndpointConnectionNotification.json index 8f868d79..3f8f1be4 100644 --- a/artifacts/types/AWS::EC2::VPCEndpointConnectionNotification.json +++ b/artifacts/types/AWS::EC2::VPCEndpointConnectionNotification.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-VPCEndpointConnectionNotification", "type": "AWS::EC2::VPCEndpointConnectionNotification", - "time": "2024-01-04T23:37:11.259Z", + "time": "2024-01-22T20:33:35.942Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::EC2::VPCEndpointService.json b/artifacts/types/AWS::EC2::VPCEndpointService.json index 10cca266..235e791f 100644 --- a/artifacts/types/AWS::EC2::VPCEndpointService.json +++ b/artifacts/types/AWS::EC2::VPCEndpointService.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-VPCEndpointService", "type": "AWS::EC2::VPCEndpointService", - "time": "2024-01-04T23:34:50.97Z", + "time": "2024-01-22T20:32:36.482Z", "schema": { "additionalProperties": false, "description": "Resource Type definition for AWS::EC2::VPCEndpointService", diff --git a/artifacts/types/AWS::EC2::VPCEndpointServicePermissions.json b/artifacts/types/AWS::EC2::VPCEndpointServicePermissions.json index b8959499..5c06a867 100644 --- a/artifacts/types/AWS::EC2::VPCEndpointServicePermissions.json +++ b/artifacts/types/AWS::EC2::VPCEndpointServicePermissions.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-VPCEndpointServicePermissions", "type": "AWS::EC2::VPCEndpointServicePermissions", - "time": "2024-01-04T23:53:39.612Z", + "time": "2024-01-22T20:53:32.653Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::EC2::VPCGatewayAttachment.json b/artifacts/types/AWS::EC2::VPCGatewayAttachment.json index 8bee5b6e..d2af335f 100644 --- a/artifacts/types/AWS::EC2::VPCGatewayAttachment.json +++ b/artifacts/types/AWS::EC2::VPCGatewayAttachment.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-VPCGatewayAttachment", "type": "AWS::EC2::VPCGatewayAttachment", - "time": "2023-10-27T17:53:31.655Z", + "time": "2024-05-22T16:05:18.039Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::EC2::VPCPeeringConnection.json b/artifacts/types/AWS::EC2::VPCPeeringConnection.json index d6e46a4c..29700765 100644 --- a/artifacts/types/AWS::EC2::VPCPeeringConnection.json +++ b/artifacts/types/AWS::EC2::VPCPeeringConnection.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-VPCPeeringConnection", "type": "AWS::EC2::VPCPeeringConnection", - "time": "2023-10-18T03:29:45.717Z", + "time": "2024-06-20T22:50:13.797Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::EC2::VPNConnection.json b/artifacts/types/AWS::EC2::VPNConnection.json index c7bb4c57..76dc4af0 100644 --- a/artifacts/types/AWS::EC2::VPNConnection.json +++ b/artifacts/types/AWS::EC2::VPNConnection.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-VPNConnection", "type": "AWS::EC2::VPNConnection", - "time": "2023-07-25T14:36:25.229Z", + "time": "2024-04-16T15:26:36.331Z", "schema": { "$schema": "https://raw.githubusercontent.com/aws-cloudformation/cloudformation-resource-schema/blob/master/src/main/resources/schema/provider.definition.schema.v1.json", "additionalProperties": false, diff --git a/artifacts/types/AWS::EC2::VPNGateway.json b/artifacts/types/AWS::EC2::VPNGateway.json index 3db1d2ea..5453a41a 100644 --- a/artifacts/types/AWS::EC2::VPNGateway.json +++ b/artifacts/types/AWS::EC2::VPNGateway.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-VPNGateway", "type": "AWS::EC2::VPNGateway", - "time": "2023-12-04T20:00:18.197Z", + "time": "2024-06-19T14:45:01.879Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -11,11 +11,14 @@ "definitions": { "Tag": { "additionalProperties": false, + "description": "Specifies a tag. For more information, see [Add tags to a resource](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#cloudformation-add-tag-specifications).", "properties": { "Key": { + "description": "The tag key.", "type": "string" }, "Value": { + "description": "The tag value.", "type": "string" } }, @@ -26,17 +29,20 @@ "type": "object" } }, - "description": "Schema for EC2 VPN Gateway", + "description": "Specifies a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself.\n For more information, see [](https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html) in the *User Guide*.", "handlers": { "create": { "permissions": [ "ec2:CreateVpnGateway", - "ec2:DescribeVpnGateways" + "ec2:DescribeVpnGateways", + "ec2:CreateTags" ] }, "delete": { "permissions": [ - "ec2:DeleteVpnGateway" + "ec2:DeleteVpnGateway", + "ec2:DescribeVpnGateways", + "ec2:DeleteTags" ] }, "list": { @@ -51,6 +57,7 @@ }, "update": { "permissions": [ + "ec2:DescribeVpnGateways", "ec2:CreateTags", "ec2:DeleteTags" ] @@ -79,7 +86,7 @@ "type": "string" }, "VPNGatewayId": { - "description": "VPN Gateway ID generated by service", + "description": "", "type": "string" } }, diff --git a/artifacts/types/AWS::EC2::VerifiedAccessEndpoint.json b/artifacts/types/AWS::EC2::VerifiedAccessEndpoint.json index 30602a52..760e7aea 100644 --- a/artifacts/types/AWS::EC2::VerifiedAccessEndpoint.json +++ b/artifacts/types/AWS::EC2::VerifiedAccessEndpoint.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-VerifiedAccessEndpoint", "type": "AWS::EC2::VerifiedAccessEndpoint", - "time": "2023-12-06T02:07:10.518Z", + "time": "2024-06-19T00:23:14.338Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::EC2::VerifiedAccessGroup.json b/artifacts/types/AWS::EC2::VerifiedAccessGroup.json index f26f0d4a..647085b7 100644 --- a/artifacts/types/AWS::EC2::VerifiedAccessGroup.json +++ b/artifacts/types/AWS::EC2::VerifiedAccessGroup.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-VerifiedAccessGroup", "type": "AWS::EC2::VerifiedAccessGroup", - "time": "2023-12-05T16:29:01.561Z", + "time": "2024-06-18T17:18:23.293Z", "schema": { "additionalProperties": false, "definitions": { diff --git a/artifacts/types/AWS::EC2::VerifiedAccessInstance.json b/artifacts/types/AWS::EC2::VerifiedAccessInstance.json index 1e27954d..0540353d 100644 --- a/artifacts/types/AWS::EC2::VerifiedAccessInstance.json +++ b/artifacts/types/AWS::EC2::VerifiedAccessInstance.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-VerifiedAccessInstance", "type": "AWS::EC2::VerifiedAccessInstance", - "time": "2023-12-05T16:39:36.592Z", + "time": "2024-06-18T17:24:00.544Z", "schema": { "additionalProperties": false, "definitions": { @@ -137,6 +137,8 @@ "ec2:ModifyVerifiedAccessInstanceLoggingConfiguration", "ec2:DescribeVerifiedAccessInstances", "ec2:DescribeVerifiedAccessInstanceLoggingConfigurations", + "ec2:DetachVerifiedAccessTrustProvider", + "ec2:DeleteVerifiedAccessInstance", "ec2:CreateTags", "ec2:DescribeTags", "logs:CreateLogDelivery", diff --git a/artifacts/types/AWS::EC2::VerifiedAccessTrustProvider.json b/artifacts/types/AWS::EC2::VerifiedAccessTrustProvider.json index 007def26..074ccbaa 100644 --- a/artifacts/types/AWS::EC2::VerifiedAccessTrustProvider.json +++ b/artifacts/types/AWS::EC2::VerifiedAccessTrustProvider.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-VerifiedAccessTrustProvider", "type": "AWS::EC2::VerifiedAccessTrustProvider", - "time": "2023-12-05T16:42:01.6Z", + "time": "2024-06-18T17:24:04.609Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::EC2::Volume.json b/artifacts/types/AWS::EC2::Volume.json index 32351099..4638a625 100644 --- a/artifacts/types/AWS::EC2::Volume.json +++ b/artifacts/types/AWS::EC2::Volume.json @@ -1,19 +1,20 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-Volume", "type": "AWS::EC2::Volume", - "time": "2023-10-25T15:52:45.266Z", + "time": "2024-02-15T16:42:22.773Z", "schema": { "additionalProperties": false, "definitions": { "Tag": { "additionalProperties": false, + "description": "Specifies a tag. For more information, see [Add tags to a resource](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#cloudformation-add-tag-specifications).", "properties": { "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "description": "The tag key.", "type": "string" }, "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "description": "The tag value.", "type": "string" } }, @@ -24,7 +25,7 @@ "type": "object" } }, - "description": "Resource Type definition for AWS::EC2::Volume", + "description": "Specifies an Amazon Elastic Block Store (Amazon EBS) volume.\n When you use CFNlong to update an Amazon EBS volume that modifies ``Iops``, ``Size``, or ``VolumeType``, there is a cooldown period before another operation can occur. This can cause your stack to report being in ``UPDATE_IN_PROGRESS`` or ``UPDATE_ROLLBACK_IN_PROGRESS`` for long periods of time.\n Amazon EBS does not support sizing down an Amazon EBS volume. CFNlong does not attempt to modify an Amazon EBS volume to a smaller size on rollback.\n Some common scenarios when you might encounter a cooldown period for Amazon EBS include:\n + You successfully update an Amazon EBS volume and the update succeeds. When you attempt another update within the cooldown window, that update will be subject to a cooldown period.\n + You successfully update an Amazon EBS volume and the update succeeds but another change in your ``update-stack`` call fails. The rollback will be subject to a cooldown period.\n \n For more information on the coo", "handlers": { "create": { "permissions": [ @@ -78,27 +79,27 @@ ], "properties": { "AutoEnableIO": { - "description": "The Availability Zone in which to create the volume.", + "description": "Indicates whether the volume is auto-enabled for I/O operations. By default, Amazon EBS disables I/O to the volume from attached EC2 instances when it determines that a volume's data is potentially inconsistent. If the consistency of the volume is not a concern, and you prefer that the volume be made available immediately if it's impaired, you can configure the volume to automatically enable I/O.", "type": "boolean" }, "AvailabilityZone": { - "description": "The Availability Zone in which to create the volume.", + "description": "The ID of the Availability Zone in which to create the volume. For example, ``us-east-1a``.", "type": "string" }, "Encrypted": { - "description": "Specifies whether the volume should be encrypted. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Encryption by default in the Amazon Elastic Compute Cloud User Guide. Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types.", + "description": "Indicates whether the volume should be encrypted. The effect of setting the encryption state to ``true`` depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see [Encryption by default](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-by-default) in the *Amazon Elastic Compute Cloud User Guide*.\n Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see [Supported instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances).", "type": "boolean" }, "Iops": { - "description": "The number of I/O operations per second (IOPS) to provision for an io1 or io2 volume, with a maximum ratio of 50 IOPS/GiB for io1, and 500 IOPS/GiB for io2. Range is 100 to 64,000 IOPS for volumes in most Regions. Maximum IOPS of 64,000 is guaranteed only on Nitro-based instances. Other instance families guarantee performance up to 32,000 IOPS. For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide. This parameter is valid only for Provisioned IOPS SSD (io1 and io2) volumes. ", + "description": "The number of I/O operations per second (IOPS). For ``gp3``, ``io1``, and ``io2`` volumes, this represents the number of IOPS that are provisioned for the volume. For ``gp2`` volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.\n The 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\n \n For ``io2`` volumes, you can achieve up to 256,000 IOPS on [instances built 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.\n This parameter is required for ``io1`` and ``io2`` volumes. The default for ``gp3`` volumes is 3,000 IOPS. This parameter is not supported for ``gp2``, ``st1``, ``sc1``, or ``standard`` volumes.", "type": "integer" }, "KmsKeyId": { - "description": "The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption. If KmsKeyId is specified, the encrypted state must be true. If you omit this property and your account is enabled for encryption by default, or Encrypted is set to true, then the volume is encrypted using the default CMK specified for your account. If your account does not have a default CMK, then the volume is encrypted using the AWS managed CMK. Alternatively, if you want to specify a different CMK, you can specify one of the following: Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab. Key alias. Specify the alias for the CMK, prefixed with alias/. For example, for a CMK with the alias my_cmk, use alias/my_cmk. Or to specify the AWS managed CMK, use alias/aws/ebs. Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab. Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.", + "description": "The identifier of the kms-key-long to use for Amazon EBS encryption. If ``KmsKeyId`` is specified, the encrypted state must be ``true``.\n If you omit this property and your account is enabled for encryption by default, or *Encrypted* is set to ``true``, then the volume is encrypted using the default key specified for your account. If your account does not have a default key, then the volume is encrypted using the aws-managed-key.\n Alternatively, 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 ``my_cmk``, use ``alias/my_cmk``. Or to specify the aws-managed-key, use ``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.", "type": "string" }, "MultiAttachEnabled": { - "description": "Indicates whether Amazon EBS Multi-Attach is enabled.", + "description": "Indicates whether Amazon EBS Multi-Attach is enabled.\n CFNlong does not currently support updating a single-attach volume to be multi-attach enabled, updating a multi-attach enabled volume to be single-attach, or updating the size or number of I/O operations per second (IOPS) of a multi-attach enabled volume.", "type": "boolean" }, "OutpostArn": { @@ -106,11 +107,11 @@ "type": "string" }, "Size": { - "description": "The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. Constraints: 1-16,384 for gp2, 4-16,384 for io1 and io2, 500-16,384 for st1, 500-16,384 for sc1, and 1-1,024 for standard. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size. Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size. ", + "description": "The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.\n The following are the supported volumes sizes for each volume type:\n + ``gp2`` and ``gp3``: 1 - 16,384 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", "type": "integer" }, "SnapshotId": { - "description": "The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size. ", + "description": "The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.", "type": "string" }, "Tags": { @@ -123,14 +124,15 @@ "uniqueItems": false }, "Throughput": { - "description": "The throughput that the volume supports, in MiB/s.", + "description": "The throughput to provision for a volume, with a maximum of 1,000 MiB/s.\n This parameter is valid only for ``gp3`` volumes. The default value is 125.\n Valid Range: Minimum value of 125. Maximum value of 1000.", "type": "integer" }, "VolumeId": { + "description": "", "type": "string" }, "VolumeType": { - "description": "The volume type. This parameter can be one of the following values: General Purpose SSD: gp2 | gp3, Provisioned IOPS SSD: io1 | io2, Throughput Optimized HDD: st1, Cold HDD: sc1, Magnetic: standard", + "description": "The volume type. This parameter can be one of the following values:\n + General Purpose SSD: ``gp2`` | ``gp3`` \n + Provisioned IOPS SSD: ``io1`` | ``io2`` \n + Throughput Optimized HDD: ``st1`` \n + Cold HDD: ``sc1`` \n + Magnetic: ``standard`` \n \n For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the *Amazon Elastic Compute Cloud User Guide*.\n Default: ``gp2``", "type": "string" } }, diff --git a/artifacts/types/AWS::ECR::PullThroughCacheRule.json b/artifacts/types/AWS::ECR::PullThroughCacheRule.json index dfc3eb7b..d121007f 100644 --- a/artifacts/types/AWS::ECR::PullThroughCacheRule.json +++ b/artifacts/types/AWS::ECR::PullThroughCacheRule.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ECR-PullThroughCacheRule", "type": "AWS::ECR::PullThroughCacheRule", - "time": "2024-01-04T18:20:47.14Z", + "time": "2024-05-24T17:33:09.049Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -131,7 +131,9 @@ } }, "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ecr.git", - "taggable": false, + "tagging": { + "taggable": false + }, "typeName": "AWS::ECR::PullThroughCacheRule", "writeOnlyProperties": [ "/properties/CredentialArn", diff --git a/artifacts/types/AWS::ECR::RegistryPolicy.json b/artifacts/types/AWS::ECR::RegistryPolicy.json index 35505793..f7d96870 100644 --- a/artifacts/types/AWS::ECR::RegistryPolicy.json +++ b/artifacts/types/AWS::ECR::RegistryPolicy.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ECR-RegistryPolicy", "type": "AWS::ECR::RegistryPolicy", - "time": "2024-01-04T18:14:45.892Z", + "time": "2024-05-24T17:33:05.903Z", "schema": { "additionalProperties": false, "definitions": { @@ -13,7 +13,7 @@ "type": "string" } }, - "description": "The AWS::ECR::RegistryPolicy is used to specify permissions for another AWS account and is used when configuring cross-account replication. For more information, see Registry permissions in the Amazon Elastic Container Registry User Guide: https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry-permissions.html", + "description": "The ``AWS::ECR::RegistryPolicy`` resource creates or updates the permissions policy for a private registry.\n A private registry policy is used to specify permissions for another AWS-account and is used when configuring cross-account replication. For more information, see [Registry permissions](https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry-permissions.html) in the *Amazon Elastic Container Registry User Guide*.", "handlers": { "create": { "permissions": [ @@ -48,11 +48,12 @@ ], "properties": { "PolicyText": { - "description": "The JSON policy text to apply to your registry. The policy text follows the same format as IAM policy text. For more information, see Registry permissions (https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry-permissions.html) in the Amazon Elastic Container Registry User Guide.", + "description": "The JSON policy text for your registry.", "type": "object" }, "RegistryId": { - "$ref": "#/definitions/RegistryId" + "$ref": "#/definitions/RegistryId", + "description": "" } }, "readOnlyProperties": [ @@ -62,6 +63,9 @@ "PolicyText" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ecr.git", + "tagging": { + "taggable": false + }, "typeName": "AWS::ECR::RegistryPolicy" } } \ No newline at end of file diff --git a/artifacts/types/AWS::ECR::ReplicationConfiguration.json b/artifacts/types/AWS::ECR::ReplicationConfiguration.json index 4a3d744d..679fdfff 100644 --- a/artifacts/types/AWS::ECR::ReplicationConfiguration.json +++ b/artifacts/types/AWS::ECR::ReplicationConfiguration.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ECR-ReplicationConfiguration", "type": "AWS::ECR::ReplicationConfiguration", - "time": "2024-01-04T18:08:56.04Z", + "time": "2024-05-24T17:23:41.68Z", "schema": { "additionalProperties": false, "definitions": { @@ -162,6 +162,9 @@ "ReplicationConfiguration" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ecr.git", + "tagging": { + "taggable": false + }, "typeName": "AWS::ECR::ReplicationConfiguration" } } \ No newline at end of file diff --git a/artifacts/types/AWS::ECR::Repository.json b/artifacts/types/AWS::ECR::Repository.json index 414d4fc7..4921f233 100644 --- a/artifacts/types/AWS::ECR::Repository.json +++ b/artifacts/types/AWS::ECR::Repository.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ECR-Repository", "type": "AWS::ECR::Repository", - "time": "2024-01-04T18:15:38.497Z", + "time": "2024-05-24T17:35:38.354Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -17,13 +17,15 @@ }, "EncryptionConfiguration": { "additionalProperties": false, - "description": "The encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest.\n\nBy default, when no encryption configuration is set or the AES256 encryption type is used, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts your data at rest using an AES-256 encryption algorithm. This does not require any action on your part.\n\nFor more information, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/encryption-at-rest.html", + "description": "The encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest.\n By default, when no encryption configuration is set or the ``AES256`` encryption type is used, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts your data at rest using an AES-256 encryption algorithm. This does not require any action on your part.\n For more control over the encryption of the contents of your repository, you can use server-side encryption with KMSlong key stored in KMSlong (KMS) to encrypt your images. For more information, see [Amazon ECR encryption at rest](https://docs.aws.amazon.com/AmazonECR/latest/userguide/encryption-at-rest.html) in the *Amazon Elastic Container Registry User Guide*.", "properties": { "EncryptionType": { - "$ref": "#/definitions/EncryptionType" + "$ref": "#/definitions/EncryptionType", + "description": "The encryption type to use.\n If you use the ``KMS`` encryption type, the contents of the repository will be encrypted using server-side encryption with KMSlong key stored in KMS. When you use KMS to encrypt your data, you can either use the default AWS managed KMS key for Amazon ECR, or specify your own KMS key, which you already created. For more information, see [Protecting data using server-side encryption with an key stored in (SSE-KMS)](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html) in the *Amazon Simple Storage Service Console Developer Guide*.\n If you use the ``AES256`` encryption type, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts the images in the repository using an AES-256 encryption algorithm. For more information, see [Protecting data using server-side encryption with Amazon S3-managed encryption keys (SSE-S3)](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html) in the *Ama" }, "KmsKey": { - "$ref": "#/definitions/KmsKey" + "$ref": "#/definitions/KmsKey", + "description": "If you use the ``KMS`` encryption type, specify the KMS key to use for encryption. The alias, key ID, or full ARN of the KMS key can be specified. The key must exist in the same Region as the repository. If no key is specified, the default AWS managed KMS key for Amazon ECR will be used." } }, "required": [ @@ -41,10 +43,11 @@ }, "ImageScanningConfiguration": { "additionalProperties": false, - "description": "The image scanning configuration for the repository. This setting determines whether images are scanned for known vulnerabilities after being pushed to the repository.", + "description": "The image scanning configuration for a repository.", "properties": { "ScanOnPush": { - "$ref": "#/definitions/ScanOnPush" + "$ref": "#/definitions/ScanOnPush", + "description": "The setting that determines whether images are scanned after being pushed to a repository. If set to ``true``, images will be scanned after being pushed. If this parameter is not specified, it will default to ``false`` and images will not be scanned unless a scan is manually started." } }, "type": "object" @@ -57,13 +60,15 @@ }, "LifecyclePolicy": { "additionalProperties": false, - "description": "The LifecyclePolicy property type specifies a lifecycle policy. For information about lifecycle policy syntax, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html", + "description": "The ``LifecyclePolicy`` property type specifies a lifecycle policy. For information about lifecycle policy syntax, see [Lifecycle policy template](https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html) in the *Amazon ECR User Guide*.", "properties": { "LifecyclePolicyText": { - "$ref": "#/definitions/LifecyclePolicyText" + "$ref": "#/definitions/LifecyclePolicyText", + "description": "The JSON repository policy text to apply to the repository." }, "RegistryId": { - "$ref": "#/definitions/RegistryId" + "$ref": "#/definitions/RegistryId", + "description": "The AWS account ID associated with the registry that contains the repository. If you do? not specify a registry, the default registry is assumed." } }, "type": "object" @@ -87,16 +92,16 @@ }, "Tag": { "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", + "description": "The metadata to apply to a resource to help you categorize and organize them. Each tag consists of a key and a value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.", "properties": { "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "description": "One part of a key-value pair that make up a tag. A ``key`` is a general label that acts like a category for more specific tag values.", "maxLength": 127, "minLength": 1, "type": "string" }, "Value": { - "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "description": "A ``value`` acts as a descriptor within a tag category (key).", "maxLength": 255, "minLength": 1, "type": "string" @@ -109,7 +114,7 @@ "type": "object" } }, - "description": "The AWS::ECR::Repository resource specifies an Amazon Elastic Container Registry (Amazon ECR) repository, where users can push and pull Docker images. For more information, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/Repositories.html", + "description": "The ``AWS::ECR::Repository`` resource specifies an Amazon Elastic Container Registry (Amazon ECR) repository, where users can push and pull Docker images, Open Container Initiative (OCI) images, and OCI compatible artifacts. For more information, see [Amazon ECR private repositories](https://docs.aws.amazon.com/AmazonECR/latest/userguide/Repositories.html) in the *Amazon ECR User Guide*.", "handlers": { "create": { "permissions": [ @@ -164,19 +169,23 @@ ], "properties": { "Arn": { + "description": "", "type": "string" }, "EmptyOnDelete": { - "$ref": "#/definitions/EmptyOnDelete" + "$ref": "#/definitions/EmptyOnDelete", + "description": "If true, deleting the repository force deletes the contents of the repository. If false, the repository must be empty before attempting to delete it." }, "EncryptionConfiguration": { - "$ref": "#/definitions/EncryptionConfiguration" + "$ref": "#/definitions/EncryptionConfiguration", + "description": "The encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest." }, "ImageScanningConfiguration": { - "$ref": "#/definitions/ImageScanningConfiguration" + "$ref": "#/definitions/ImageScanningConfiguration", + "description": "The image scanning configuration for the repository. This determines whether images are scanned for known vulnerabilities after being pushed to the repository." }, "ImageTagMutability": { - "description": "The image tag mutability setting for the repository.", + "description": "The tag mutability setting for the repository. If this parameter is omitted, the default setting of ``MUTABLE`` will be used which will allow image tags to be overwritten. If ``IMMUTABLE`` is specified, all image tags within the repository will be immutable which will prevent them from being overwritten.", "enum": [ "MUTABLE", "IMMUTABLE" @@ -184,23 +193,25 @@ "type": "string" }, "LifecyclePolicy": { - "$ref": "#/definitions/LifecyclePolicy" + "$ref": "#/definitions/LifecyclePolicy", + "description": "Creates or updates a lifecycle policy. For information about lifecycle policy syntax, see [Lifecycle policy template](https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html)." }, "RepositoryName": { - "description": "The name to use for the repository. The repository name may be specified on its own (such as nginx-web-app) or it can be prepended with a namespace to group the repository into a category (such as project-a/nginx-web-app). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the repository name. For more information, see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html.", + "description": "The name to use for the repository. The repository name may be specified on its own (such as ``nginx-web-app``) or it can be prepended with a namespace to group the repository into a category (such as ``project-a/nginx-web-app``). If you don't specify a name, CFNlong generates a unique physical ID and uses that ID for the repository name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).\n The repository name must start with a letter and can only contain lowercase letters, numbers, hyphens, underscores, and forward slashes.\n If 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.", "maxLength": 256, "minLength": 2, "pattern": "^(?=.{2,256}$)((?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*)$", "type": "string" }, "RepositoryPolicyText": { - "description": "The JSON repository policy text to apply to the repository. For more information, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/RepositoryPolicyExamples.html in the Amazon Elastic Container Registry User Guide. ", + "description": "The JSON repository policy text to apply to the repository. For more information, see [Amazon ECR repository policies](https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policy-examples.html) in the *Amazon Elastic Container Registry User Guide*.", "type": [ "object", "string" ] }, "RepositoryUri": { + "description": "", "type": "string" }, "Tags": { @@ -219,6 +230,13 @@ "/properties/RepositoryUri" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ecr.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, "typeName": "AWS::ECR::Repository", "writeOnlyProperties": [ "/properties/EmptyOnDelete" diff --git a/artifacts/types/AWS::ECR::RepositoryCreationTemplate.json b/artifacts/types/AWS::ECR::RepositoryCreationTemplate.json new file mode 100644 index 00000000..dc8fd7b9 --- /dev/null +++ b/artifacts/types/AWS::ECR::RepositoryCreationTemplate.json @@ -0,0 +1,186 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ECR-RepositoryCreationTemplate", + "type": "AWS::ECR::RepositoryCreationTemplate", + "time": "2024-04-19T23:50:08.189Z", + "schema": { + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Prefix" + ], + "definitions": { + "AppliedForItem": { + "description": "Enumerable Strings representing the repository creation scenarios that the template will apply towards.", + "enum": [ + "REPLICATION", + "PULL_THROUGH_CACHE" + ], + "type": "string" + }, + "EncryptionConfiguration": { + "additionalProperties": false, + "description": "The encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest. By default, when no encryption configuration is set or the AES256 encryption type is used, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts your data at rest using an AES-256 encryption algorithm. This does not require any action on your part.\n\nFor more information, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/encryption-at-rest.html", + "properties": { + "EncryptionType": { + "$ref": "#/definitions/EncryptionType" + }, + "KmsKey": { + "$ref": "#/definitions/KmsKey" + } + }, + "required": [ + "EncryptionType" + ], + "type": "object" + }, + "EncryptionType": { + "description": "The encryption type to use.", + "enum": [ + "AES256", + "KMS" + ], + "type": "string" + }, + "KmsKey": { + "description": "If you use the KMS encryption type, specify the CMK to use for encryption. The alias, key ID, or full ARN of the CMK can be specified. The key must exist in the same Region as the repository. If no key is specified, the default AWS managed CMK for Amazon ECR will be used.", + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "An array of key-value pairs to apply to this resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "AWS::ECR::RepositoryCreationTemplate is used to create repository with configuration from a pre-defined template.", + "handlers": { + "create": { + "permissions": [ + "ecr:CreateRepositoryCreationTemplate", + "ecr:PutLifecyclePolicy", + "ecr:SetRepositoryPolicy" + ] + }, + "delete": { + "permissions": [ + "ecr:DeleteRepositoryCreationTemplate" + ] + }, + "list": { + "permissions": [ + "ecr:DescribeRepositoryCreationTemplates" + ] + }, + "read": { + "permissions": [ + "ecr:DescribeRepositoryCreationTemplates" + ] + }, + "update": { + "permissions": [ + "ecr:DescribeRepositoryCreationTemplates", + "ecr:UpdateRepositoryCreationTemplate", + "ecr:PutLifecyclePolicy", + "ecr:SetRepositoryPolicy" + ] + } + }, + "primaryIdentifier": [ + "/properties/Prefix" + ], + "properties": { + "AppliedFor": { + "description": "A list of enumerable Strings representing the repository creation scenarios that the template will apply towards.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/AppliedForItem" + }, + "type": "array", + "uniqueItems": true + }, + "CreatedAt": { + "description": "Create timestamp of the template.", + "type": "string" + }, + "Description": { + "description": "The description of the template.", + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "EncryptionConfiguration": { + "$ref": "#/definitions/EncryptionConfiguration" + }, + "ImageTagMutability": { + "description": "The image tag mutability setting for the repository.", + "enum": [ + "MUTABLE", + "IMMUTABLE" + ], + "type": "string" + }, + "LifecyclePolicy": { + "description": "The JSON lifecycle policy text to apply to the repository. For information about lifecycle policy syntax, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html", + "maxLength": 30720, + "minLength": 100, + "type": "string" + }, + "Prefix": { + "description": "The prefix use to match the repository name and apply the template.", + "maxLength": 256, + "minLength": 1, + "pattern": "^((?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*/?|ROOT)$", + "type": "string" + }, + "RepositoryPolicy": { + "description": "The JSON repository policy text to apply to the repository. For more information, see https://docs.aws.amazon.com/AmazonECR/latest/userguide/RepositoryPolicyExamples.html", + "type": "string" + }, + "ResourceTags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + }, + "UpdatedAt": { + "description": "Update timestamp of the template.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/CreatedAt", + "/properties/UpdatedAt" + ], + "required": [ + "Prefix", + "AppliedFor" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ecr.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::ECR::RepositoryCreationTemplate" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::ECS::CapacityProvider.json b/artifacts/types/AWS::ECS::CapacityProvider.json index bbf47e1b..8e842aa8 100644 --- a/artifacts/types/AWS::ECS::CapacityProvider.json +++ b/artifacts/types/AWS::ECS::CapacityProvider.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ECS-CapacityProvider", "type": "AWS::ECS::CapacityProvider", - "time": "2024-01-04T23:49:54.824Z", + "time": "2024-05-23T15:35:35.094Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::ECS::Cluster.json b/artifacts/types/AWS::ECS::Cluster.json index 0f9927ce..75fe04a0 100644 --- a/artifacts/types/AWS::ECS::Cluster.json +++ b/artifacts/types/AWS::ECS::Cluster.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ECS-Cluster", "type": "AWS::ECS::Cluster", - "time": "2023-11-06T17:26:16.066Z", + "time": "2024-06-05T19:49:10.71Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -10,15 +10,22 @@ "definitions": { "CapacityProviderStrategyItem": { "additionalProperties": false, - "description": "A capacity provider strategy consists of one or more capacity providers along with the `base` and `weight` to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an `ACTIVE` or `UPDATING` status can be used.", + "description": "The ``CapacityProviderStrategyItem`` property specifies the details of the default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.", "properties": { "Base": { + "description": "The *base* value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a *base* defined. If no value is specified, the default value of ``0`` is used.", "type": "integer" }, "CapacityProvider": { + "description": "The short name of the capacity provider.", + "relationshipRef": { + "propertyPath": "/properties/Name", + "typeName": "AWS::ECS::CapacityProvider" + }, "type": "string" }, "Weight": { + "description": "The *weight* value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The ``weight`` value is taken into consideration after the ``base`` value, if defined, is satisfied.\n If no ``weight`` value is specified, the default value of ``0`` is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of ``0`` can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of ``0``, any ``RunTask`` or ``CreateService`` actions using the capacity provider strategy will fail.\n An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of ``1``, then when the ``base`` is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of ``1`` for *capacityProviderA* and a weight of ``4`` for *capacityProviderB*, then for every one task that's run using *capacityProviderA*, four tasks would use *capacityProviderB*.", "type": "integer" } }, @@ -26,22 +33,29 @@ }, "ClusterConfiguration": { "additionalProperties": false, - "description": "The configurations to be set at cluster level.", + "description": "The execute command configuration for the cluster.", "properties": { "ExecuteCommandConfiguration": { - "$ref": "#/definitions/ExecuteCommandConfiguration" + "$ref": "#/definitions/ExecuteCommandConfiguration", + "description": "The details of the execute command configuration." + }, + "ManagedStorageConfiguration": { + "$ref": "#/definitions/ManagedStorageConfiguration", + "description": "" } }, "type": "object" }, "ClusterSettings": { "additionalProperties": false, - "description": "The setting to use when creating a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster. If this value is specified, it will override the containerInsights value set with PutAccountSetting or PutAccountSettingDefault.", + "description": "The settings to use when creating a cluster. This parameter is used to turn on CloudWatch Container Insights for a cluster.", "properties": { "Name": { + "description": "The name of the cluster setting. The value is ``containerInsights`` .", "type": "string" }, "Value": { + "description": "The value to set for the cluster setting. The supported values are ``enabled`` and ``disabled``. \n If you set ``name`` to ``containerInsights`` and ``value`` to ``enabled``, CloudWatch Container Insights will be on for the cluster, otherwise it will be off unless the ``containerInsights`` account setting is turned on. If a cluster value is specified, it will override the ``containerInsights`` value set with [PutAccountSetting](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSetting.html) or [PutAccountSettingDefault](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSettingDefault.html).", "type": "string" } }, @@ -49,15 +63,22 @@ }, "ExecuteCommandConfiguration": { "additionalProperties": false, - "description": "The configuration for ExecuteCommand.", + "description": "The details of the execute command configuration.", "properties": { "KmsKeyId": { + "description": "Specify an KMSlong key ID to encrypt the data between the local client and the container.", + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::KMS::Key" + }, "type": "string" }, "LogConfiguration": { - "$ref": "#/definitions/ExecuteCommandLogConfiguration" + "$ref": "#/definitions/ExecuteCommandLogConfiguration", + "description": "The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket. When ``logging=OVERRIDE`` is specified, a ``logConfiguration`` must be provided." }, "Logging": { + "description": "The log setting to use for redirecting logs for your execute command results. The following log settings are available.\n + ``NONE``: The execute command session is not logged.\n + ``DEFAULT``: The ``awslogs`` configuration in the task definition is used. If no logging parameter is specified, it defaults to this value. If no ``awslogs`` log driver is configured in the task definition, the output won't be logged.\n + ``OVERRIDE``: Specify the logging details as a part of ``logConfiguration``. If the ``OVERRIDE`` logging option is specified, the ``logConfiguration`` is required.", "type": "string" } }, @@ -65,21 +86,43 @@ }, "ExecuteCommandLogConfiguration": { "additionalProperties": false, - "description": "The session logging configuration for ExecuteCommand.", + "description": "The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket.", "properties": { "CloudWatchEncryptionEnabled": { + "description": "Determines whether to use encryption on the CloudWatch logs. If not specified, encryption will be off.", "type": "boolean" }, "CloudWatchLogGroupName": { + "description": "The name of the CloudWatch log group to send logs to.\n The CloudWatch log group must already be created.", + "relationshipRef": { + "propertyPath": "/properties/LogGroupName", + "typeName": "AWS::Logs::LogGroup" + }, "type": "string" }, "S3BucketName": { + "description": "The name of the S3 bucket to send logs to.\n The S3 bucket must already be created.", "type": "string" }, "S3EncryptionEnabled": { + "description": "Determines whether to use encryption on the S3 logs. If not specified, encryption is not used.", "type": "boolean" }, "S3KeyPrefix": { + "description": "An optional folder in the S3 bucket to place logs in.", + "type": "string" + } + }, + "type": "object" + }, + "ManagedStorageConfiguration": { + "additionalProperties": false, + "description": "", + "properties": { + "FargateEphemeralStorageKmsKeyId": { + "type": "string" + }, + "KmsKeyId": { "type": "string" } }, @@ -87,10 +130,10 @@ }, "ServiceConnectDefaults": { "additionalProperties": false, - "description": "Service Connect Configuration default for all services or tasks within this cluster", + "description": "Use this parameter to set a default Service Connect namespace. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the ``enabled`` parameter to ``true`` in the ``ServiceConnectConfiguration``. You can set the namespace of each service individually in the ``ServiceConnectConfiguration`` to override this default parameter.\n Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*.", "properties": { "Namespace": { - "description": "Service Connect Namespace Name or ARN default for all services or tasks within this cluster", + "description": "The namespace name or full Amazon Resource Name (ARN) of the CMAPlong namespace that's used when you create a service and don't specify a Service Connect configuration. The namespace name can include up to 1024 characters. The name is case-sensitive. The name can't include hyphens (-), tilde (~), greater than (\u003e), less than (\u003c), or slash (/).\n If you enter an existing namespace name or ARN, then that namespace will be used. Any namespace type is supported. The namespace must be in this account and this AWS Region.\n If you enter a new name, a CMAPlong namespace will be created. Amazon ECS creates a CMAP namespace with the \"API calls\" method of instance discovery only. This instance discovery method is the \"HTTP\" namespace type in the CLIlong. Other types of instance discovery aren't used by Service Connect.\n If you update the cluster with an empty string ``\"\"`` for the namespace name, the cluster configuration for Service Connect is removed. Note that the namespace will remain in CMAP and must be deleted separately.\n For more information about CMAPlong, see [Working with Services](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-services.html) in the *Developer Guide*.", "type": "string" } }, @@ -98,32 +141,36 @@ }, "Tag": { "additionalProperties": false, - "description": "The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.", + "description": "The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value. You define them.\n The following basic restrictions apply to tags:\n + Maximum number of tags per resource - 50\n + For each resource, each tag key must be unique, and each tag key can have only one value.\n + Maximum key length - 128 Unicode characters in UTF-8\n + Maximum value length - 256 Unicode characters in UTF-8\n + If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.\n + Tag keys and values are case-sensitive.\n + Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.", "properties": { "Key": { + "description": "One part of a key-value pair that make up a tag. A ``key`` is a general label that acts like a category for more specific tag values.", "type": "string" }, "Value": { + "description": "The optional part of a key-value pair that make up a tag. A ``value`` acts as a descriptor within a tag category (key).", "type": "string" } }, "type": "object" } }, - "description": "Create an Elastic Container Service (ECS) cluster.", + "description": "The ``AWS::ECS::Cluster`` resource creates an Amazon Elastic Container Service (Amazon ECS) cluster.", "handlers": { "create": { "permissions": [ "ecs:CreateCluster", "ecs:DescribeClusters", "iam:CreateServiceLinkedRole", - "ecs:TagResource" + "ecs:TagResource", + "kms:DescribeKey" ] }, "delete": { "permissions": [ "ecs:DeleteCluster", - "ecs:DescribeClusters" + "ecs:DescribeClusters", + "kms:DescribeKey" ] }, "list": { @@ -134,7 +181,8 @@ }, "read": { "permissions": [ - "ecs:DescribeClusters" + "ecs:DescribeClusters", + "kms:DescribeKey" ] }, "update": { @@ -147,7 +195,8 @@ "ecs:ListTagsForResource", "ecs:UpdateCluster", "ecs:UpdateClusterSettings", - "ecs:PutClusterCapacityProviders" + "ecs:PutClusterCapacityProviders", + "kms:DescribeKey" ] } }, @@ -156,38 +205,44 @@ ], "properties": { "Arn": { - "description": "The Amazon Resource Name (ARN) of the Amazon ECS cluster, such as arn:aws:ecs:us-east-2:123456789012:cluster/MyECSCluster.", + "description": "", "type": "string" }, "CapacityProviders": { + "description": "The short name of one or more capacity providers to associate with the cluster. A capacity provider must be associated with a cluster before it can be included as part of the default capacity provider strategy of the cluster or used in a capacity provider strategy when calling the [CreateService](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html) or [RunTask](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html) actions.\n If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must be created but not associated with another cluster. New Auto Scaling group capacity providers can be created with the [CreateCapacityProvider](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCapacityProvider.html) API operation.\n To use a FARGATElong capacity provider, specify either the ``FARGATE`` or ``FARGATE_SPOT`` capacity providers. The FARGATElong capacity providers are available to all accounts and only need to be associated with a cluster to be used.\n The [PutCapacityProvider](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutCapacityProvider.html) API operation is used to update the list of available capacity providers for a cluster after the cluster is created.", "items": { "type": "string" }, "type": "array" }, "ClusterName": { - "description": "A user-generated string that you use to identify your cluster. If you don't specify a name, AWS CloudFormation generates a unique physical ID for the name.", + "description": "A user-generated string that you use to identify your cluster. If you don't specify a name, CFNlong generates a unique physical ID for the name.", "type": "string" }, "ClusterSettings": { + "description": "The settings to use when creating a cluster. This parameter is used to turn on CloudWatch Container Insights for a cluster.", "items": { "$ref": "#/definitions/ClusterSettings" }, "type": "array" }, "Configuration": { - "$ref": "#/definitions/ClusterConfiguration" + "$ref": "#/definitions/ClusterConfiguration", + "description": "The execute command configuration for the cluster." }, "DefaultCapacityProviderStrategy": { + "description": "The default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.", "items": { "$ref": "#/definitions/CapacityProviderStrategyItem" }, "type": "array" }, "ServiceConnectDefaults": { - "$ref": "#/definitions/ServiceConnectDefaults" + "$ref": "#/definitions/ServiceConnectDefaults", + "description": "Use this parameter to set a default Service Connect namespace. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the ``enabled`` parameter to ``true`` in the ``ServiceConnectConfiguration``. You can set the namespace of each service individually in the ``ServiceConnectConfiguration`` to override this default parameter.\n Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*." }, "Tags": { + "description": "The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.\n The following basic restrictions apply to tags:\n + Maximum number of tags per resource - 50\n + For each resource, each tag key must be unique, and each tag key can have only one value.\n + Maximum key length - 128 Unicode characters in UTF-8\n + Maximum value length - 256 Unicode characters in UTF-8\n + If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.\n + Tag keys and values are case-sensitive.\n + Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.", "items": { "$ref": "#/definitions/Tag" }, diff --git a/artifacts/types/AWS::ECS::ClusterCapacityProviderAssociations.json b/artifacts/types/AWS::ECS::ClusterCapacityProviderAssociations.json index 348ff88a..862c8921 100644 --- a/artifacts/types/AWS::ECS::ClusterCapacityProviderAssociations.json +++ b/artifacts/types/AWS::ECS::ClusterCapacityProviderAssociations.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ECS-ClusterCapacityProviderAssociations", "type": "AWS::ECS::ClusterCapacityProviderAssociations", - "time": "2023-12-19T17:49:30.159Z", + "time": "2024-02-07T00:24:23.022Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::ECS::PrimaryTaskSet.json b/artifacts/types/AWS::ECS::PrimaryTaskSet.json index 63437e09..f413b21b 100644 --- a/artifacts/types/AWS::ECS::PrimaryTaskSet.json +++ b/artifacts/types/AWS::ECS::PrimaryTaskSet.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ECS-PrimaryTaskSet", "type": "AWS::ECS::PrimaryTaskSet", - "time": "2023-12-14T16:27:55.175Z", + "time": "2024-06-10T15:26:36.449Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::ECS::Service.json b/artifacts/types/AWS::ECS::Service.json index 3b034713..9207bc80 100644 --- a/artifacts/types/AWS::ECS::Service.json +++ b/artifacts/types/AWS::ECS::Service.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ECS-Service", "type": "AWS::ECS::Service", - "time": "2023-12-20T02:42:51.175Z", + "time": "2024-03-13T18:37:44.006Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -15,8 +15,10 @@ "definitions": { "AwsVpcConfiguration": { "additionalProperties": false, + "description": "An object representing the networking details for a task or service. For example ``awsvpcConfiguration={subnets=[\"subnet-12344321\"],securityGroups=[\"sg-12344321\"]}``", "properties": { "AssignPublicIp": { + "description": "Whether the task's elastic network interface receives a public IP address. The default value is ``DISABLED``.", "enum": [ "DISABLED", "ENABLED" @@ -24,12 +26,14 @@ "type": "string" }, "SecurityGroups": { + "description": "The IDs of the security groups associated with the task or service. If you don't specify a security group, the default security group for the VPC is used. There's a limit of 5 security groups that can be specified per ``AwsVpcConfiguration``.\n All specified security groups must be from the same VPC.", "items": { "type": "string" }, "type": "array" }, "Subnets": { + "description": "The IDs of the subnets associated with the task or service. There's a limit of 16 subnets that can be specified per ``AwsVpcConfiguration``.\n All specified subnets must be from the same VPC.", "items": { "type": "string" }, @@ -40,14 +44,18 @@ }, "CapacityProviderStrategyItem": { "additionalProperties": false, + "description": "The details of a capacity provider strategy. A capacity provider strategy can be set when using the ``RunTask`` or ``CreateService`` APIs or as the default capacity provider strategy for a cluster with the ``CreateCluster`` API.\n Only capacity providers that are already associated with a cluster and have an ``ACTIVE`` or ``UPDATING`` status can be used in a capacity provider strategy. The ``PutClusterCapacityProviders`` API is used to associate a capacity provider with a cluster.\n If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New Auto Scaling group capacity providers can be created with the ``CreateCapacityProvider`` API operation.\n To use an FARGATElong capacity provider, specify either the ``FARGATE`` or ``FARGATE_SPOT`` capacity providers. The FARGATElong capacity providers are available to all accounts and only need to be associated with a cluster to be used in a capacity provider strategy.", "properties": { "Base": { + "description": "The *base* value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a *base* defined. If no value is specified, the default value of ``0`` is used.", "type": "integer" }, "CapacityProvider": { + "description": "The short name of the capacity provider.", "type": "string" }, "Weight": { + "description": "The *weight* value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The ``weight`` value is taken into consideration after the ``base`` value, if defined, is satisfied.\n If no ``weight`` value is specified, the default value of ``0`` is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of ``0`` can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of ``0``, any ``RunTask`` or ``CreateService`` actions using the capacity provider strategy will fail.\n An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of ``1``, then when the ``base`` is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of ``1`` for *capacityProviderA* and a weight of ``4`` for *capacityProviderB*, then for every one task that's run using *capacityProviderA*, four tasks would use *capacityProviderB*.", "type": "integer" } }, @@ -55,17 +63,21 @@ }, "DeploymentAlarms": { "additionalProperties": false, + "description": "One of the methods which provide a way for you to quickly identify when a deployment has failed, and then to optionally roll back the failure to the last working deployment.\n When the alarms are generated, Amazon ECS sets the service deployment to failed. Set the rollback parameter to have Amazon ECS to roll back your service to the last completed deployment after a failure.\n You can only use the ``DeploymentAlarms`` method to detect failures when the ``DeploymentController`` is set to ``ECS`` (rolling update).\n For more information, see [Rolling update](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html) in the *Amazon Elastic Container Service Developer Guide*.", "properties": { "AlarmNames": { + "description": "One or more CloudWatch alarm names. Use a \",\" to separate the alarms.", "items": { "type": "string" }, "type": "array" }, "Enable": { + "description": "Determines whether to use the CloudWatch alarm option in the service deployment process.", "type": "boolean" }, "Rollback": { + "description": "Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is used, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.", "type": "boolean" } }, @@ -78,11 +90,14 @@ }, "DeploymentCircuitBreaker": { "additionalProperties": false, + "description": "The deployment circuit breaker can only be used for services using the rolling update (``ECS``) deployment type.\n The *deployment circuit breaker* determines whether a service deployment will fail if the service can't reach a steady state. If it is turned on, a service deployment will transition to a failed state and stop launching new tasks. You can also configure Amazon ECS to roll back your service to the last completed deployment after a failure. For more information, see [Rolling update](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html) in the *Amazon Elastic Container Service Developer Guide*.\n For more information about API failure reasons, see [API failure reasons](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/api_failures_messages.html) in the *Amazon Elastic Container Service Developer Guide*.", "properties": { "Enable": { + "description": "Determines whether to use the deployment circuit breaker logic for the service.", "type": "boolean" }, "Rollback": { + "description": "Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is on, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.", "type": "boolean" } }, @@ -94,17 +109,22 @@ }, "DeploymentConfiguration": { "additionalProperties": false, + "description": "The ``DeploymentConfiguration`` property specifies optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.", "properties": { "Alarms": { - "$ref": "#/definitions/DeploymentAlarms" + "$ref": "#/definitions/DeploymentAlarms", + "description": "Information about the CloudWatch alarms." }, "DeploymentCircuitBreaker": { - "$ref": "#/definitions/DeploymentCircuitBreaker" + "$ref": "#/definitions/DeploymentCircuitBreaker", + "description": "The deployment circuit breaker can only be used for services using the rolling update (``ECS``) deployment type.\n The *deployment circuit breaker* determines whether a service deployment will fail if the service can't reach a steady state. If you use the deployment circuit breaker, a service deployment will transition to a failed state and stop launching new tasks. If you use the rollback option, when a service deployment fails, the service is rolled back to the last deployment that completed successfully. For more information, see [Rolling update](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html) in the *Amazon Elastic Container Service Developer Guide*" }, "MaximumPercent": { + "description": "If a service is using the rolling update (``ECS``) deployment type, the ``maximumPercent`` parameter represents an upper limit on the number of your service's tasks that are allowed in the ``RUNNING`` or ``PENDING`` state during a deployment, as a percentage of the ``desiredCount`` (rounded down to the nearest integer). This parameter enables you to define the deployment batch size. For example, if your service is using the ``REPLICA`` service scheduler and has a ``desiredCount`` of four tasks and a ``maximumPercent`` value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default ``maximumPercent`` value for a service using the ``REPLICA`` service scheduler is 200%.\n If a service is using either the blue/green (``CODE_DEPLOY``) or ``EXTERNAL`` deployment types and tasks that use the EC2 launch type, the *maximum percent* value is set to the default value and is used to define the upper limit on the number of the tasks in the service that remain in the ``RUNNING`` state while the container instances are in the ``DRAINING`` state. If the tasks in the service use the Fargate launch type, the maximum percent value is not used, although it is returned when describing your service.", "type": "integer" }, "MinimumHealthyPercent": { + "description": "If a service is using the rolling update (``ECS``) deployment type, the ``minimumHealthyPercent`` represents a lower limit on the number of your service's tasks that must remain in the ``RUNNING`` state during a deployment, as a percentage of the ``desiredCount`` (rounded up to the nearest integer). This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a ``desiredCount`` of four tasks and a ``minimumHealthyPercent`` of 50%, the service scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks. \n For services that *do not* use a load balancer, the following should be noted:\n + A service is considered healthy if all essential containers within the tasks in the service pass their health checks.\n + If a task has no essential containers with a health check defined, the service scheduler will wait for 40 seconds after a task reaches a ``RUNNING`` state before the task is counted towards the minimum healthy percent total.\n + If a task has one or more essential containers with a health check defined, the service scheduler will wait for the task to reach a healthy status before counting it towards the minimum healthy percent total. A task is considered healthy when all essential containers within the task have passed their health checks. The amount of time the service scheduler can wait for is determined by the container health check settings. \n \n For services that *do* use a load balancer, the following should be noted:\n + If a task has no essential containers with a health check defined, the service scheduler will wait for the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total.\n + If a task has an essential container with a health check defined, the service scheduler will wait for both the task to reach a healthy status and the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total.\n \n If a service is using either the blue/green (``CODE_DEPLOY``) or ``EXTERNAL`` deployment types and is running tasks that use the EC2 launch type, the *minimum healthy percent* value is set to the default value and is used to define the lower limit on the number of the tasks in the service that remain in the ``RUNNING`` state while the container instances are in the ``DRAINING`` state. If a service is using either the blue/green (``CODE_DEPLOY``) or ``EXTERNAL`` deployment types and is running tasks that use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service.", "type": "integer" } }, @@ -112,8 +132,10 @@ }, "DeploymentController": { "additionalProperties": false, + "description": "The deployment controller to use for the service. For more information, see [Amazon ECS deployment types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html) in the *Amazon Elastic Container Service Developer Guide*.", "properties": { "Type": { + "description": "The deployment controller type to use. There are three deployment controller types available:\n + ECS The rolling update (ECS) deployment type involves replacing the current running version of the container with the latest version. The number of containers Amazon ECS adds or removes from the service during a rolling update is controlled by adjusting the minimum and maximum number of healthy tasks allowed during a service deployment, as specified in the DeploymentConfiguration. + CODE_DEPLOY The blue/green (CODE_DEPLOY) deployment type uses the blue/green deployment model powered by , which allows you to verify a new deployment of a service before sending production traffic to it. + EXTERNAL The external (EXTERNAL) deployment type enables you to use any third-party deployment controller for full control over the deployment process for an Amazon ECS service.", "enum": [ "CODE_DEPLOY", "ECS", @@ -125,8 +147,10 @@ "type": "object" }, "EBSTagSpecification": { + "description": "The tag specifications of an Amazon EBS volume.", "properties": { "PropagateTags": { + "description": "Determines whether to propagate the tags from the task definition to ?the Amazon EBS volume. Tags can only propagate to a ``SERVICE`` specified in ?``ServiceVolumeConfiguration``. If no value is specified, the tags aren't ?propagated.", "enum": [ "SERVICE", "TASK_DEFINITION" @@ -134,9 +158,11 @@ "type": "string" }, "ResourceType": { + "description": "The type of volume resource.", "type": "string" }, "Tags": { + "description": "The tags applied to this Amazon EBS volume. ``AmazonECSCreated`` and ``AmazonECSManaged`` are reserved tags that can't be used.", "items": { "$ref": "#/definitions/Tag" }, @@ -150,17 +176,22 @@ }, "LoadBalancer": { "additionalProperties": false, + "description": "The ``LoadBalancer`` property specifies details on a load balancer that is used with a service.\n If the service is using the ``CODE_DEPLOY`` deployment controller, the service is required to use either an Application Load Balancer or Network Load Balancer. When you are creating an ACDlong deployment group, you specify two target groups (referred to as a ``targetGroupPair``). Each target group binds to a separate task set in the deployment. The load balancer can also have up to two listeners, a required listener for production traffic and an optional listener that allows you to test new revisions of the service before routing production traffic to it.\n Services with tasks that use the ``awsvpc`` network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose ``ip`` as the target type, not ``instance``. Tasks that use the ``awsvpc`` network mode are associated with an elastic network interface, not an Amazon EC2 instance.", "properties": { "ContainerName": { + "description": "The name of the container (as it appears in a container definition) to associate with the load balancer.\n You need to specify the container name when configuring the target group for an Amazon ECS load balancer.", "type": "string" }, "ContainerPort": { + "description": "The port on the container to associate with the load balancer. This port must correspond to a ``containerPort`` in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they're launched on must allow ingress traffic on the ``hostPort`` of the port mapping.", "type": "integer" }, "LoadBalancerName": { + "description": "The name of the load balancer to associate with the Amazon ECS service or task set.\n If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted.", "type": "string" }, "TargetGroupArn": { + "description": "The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.\n A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. \n For services using the ``ECS`` deployment controller, you can specify one or multiple target groups. For more information, see [Registering multiple target groups with a service](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html) in the *Amazon Elastic Container Service Developer Guide*.\n For services using the ``CODE_DEPLOY`` deployment controller, you're required to define two target groups for the load balancer. For more information, see [Blue/green deployment with CodeDeploy](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-bluegreen.html) in the *Amazon Elastic Container Service Developer Guide*.\n If your service's task definition uses the ``awsvpc`` network mode, you must choose ``ip`` as the target type, not ``instance``. Do this when creating your target groups because tasks that use the ``awsvpc`` network mode are associated with an elastic network interface, not an Amazon EC2 instance. This network mode is required for the Fargate launch type.", "type": "string" } }, @@ -168,12 +199,15 @@ }, "LogConfiguration": { "additionalProperties": false, + "description": "The log configuration for the container. This parameter maps to ``LogConfig`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--log-driver`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/commandline/run/).\n By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a different logging driver than the Docker daemon by specifying a log driver configuration in the container definition. For more information about the options for different supported log drivers, see [Configure logging drivers](https://docs.aws.amazon.com/https://docs.docker.com/engine/admin/logging/overview/) in the Docker documentation.\n Understand the following when specifying a log configuration for your containers.\n + Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon. Additional log drivers may be available in future releases of the Amazon ECS container agent.\n For tasks on FARGATElong, the supported log drivers are ``awslogs``, ``splunk``, and ``awsfirelens``.\n For tasks hosted on Amazon EC2 instances, the supported log drivers are ``awslogs``, ``fluentd``, ``gelf``, ``json-file``, ``journald``, ``logentries``,``syslog``, ``splunk``, and ``awsfirelens``.\n + This parameter requires version 1.18 of the Docker Remote API or greater on your container instance.\n + For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container agent must register the available logging drivers with the ``ECS_AVAILABLE_LOGGING_DRIVERS`` environment variable before containers placed on that instance can use these log configuration options. For more information, see [Amazon ECS container agent configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service Developer Guide*.\n + For tasks that are on FARGATElong, because you don't have access to the underlying infrastructure your tasks are hosted on, any additional software needed must be installed outside of the task. For example, the Fluentd output aggregators or a remote host running Logstash to send Gelf logs to.", "properties": { "LogDriver": { + "description": "The log driver to use for the container.\n For tasks on FARGATElong, the supported log drivers are ``awslogs``, ``splunk``, and ``awsfirelens``.\n For tasks hosted on Amazon EC2 instances, the supported log drivers are ``awslogs``, ``fluentd``, ``gelf``, ``json-file``, ``journald``, ``logentries``,``syslog``, ``splunk``, and ``awsfirelens``.\n For more information about using the ``awslogs`` log driver, see [Using the awslogs log driver](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html) in the *Amazon Elastic Container Service Developer Guide*.\n For more information about using the ``awsfirelens`` log driver, see [Custom log routing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) in the *Amazon Elastic Container Service Developer Guide*.\n If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's [available on GitHub](https://docs.aws.amazon.com/https://github.com/aws/amazon-ecs-agent) and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we don't currently provide support for running modified copies of this software.", "type": "string" }, "Options": { "additionalProperties": false, + "description": "The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'``", "patternProperties": { ".{1,}": { "type": "string" @@ -182,6 +216,7 @@ "type": "object" }, "SecretOptions": { + "description": "The secrets to pass to the log configuration. For more information, see [Specifying sensitive data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer Guide*.", "insertionOrder": false, "items": { "$ref": "#/definitions/Secret" @@ -193,20 +228,25 @@ }, "NetworkConfiguration": { "additionalProperties": false, + "description": "The ``NetworkConfiguration`` property specifies an object representing the network configuration for a task or service.", "properties": { "AwsvpcConfiguration": { - "$ref": "#/definitions/AwsVpcConfiguration" + "$ref": "#/definitions/AwsVpcConfiguration", + "description": "The VPC subnets and security groups that are associated with a task.\n All specified subnets and security groups must be from the same VPC." } }, "type": "object" }, "PlacementConstraint": { "additionalProperties": false, + "description": "The ``PlacementConstraint`` property specifies an object representing a constraint on task placement in the task definition. For more information, see [Task Placement Constraints](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html) in the *Amazon Elastic Container Service Developer Guide*.", "properties": { "Expression": { + "description": "A cluster query language expression to apply to the constraint. The expression can have a maximum length of 2000 characters. You can't specify an expression if the constraint type is ``distinctInstance``. For more information, see [Cluster query language](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) in the *Amazon Elastic Container Service Developer Guide*.", "type": "string" }, "Type": { + "description": "The type of constraint. Use ``distinctInstance`` to ensure that each task in a particular group is running on a different container instance. Use ``memberOf`` to restrict the selection to a group of valid candidates.", "enum": [ "distinctInstance", "memberOf" @@ -221,11 +261,14 @@ }, "PlacementStrategy": { "additionalProperties": false, + "description": "The ``PlacementStrategy`` property specifies the 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 Elastic Container Service Developer Guide*.", "properties": { "Field": { + "description": "The field to apply the placement strategy against. For the ``spread`` placement strategy, valid values are ``instanceId`` (or ``host``, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as ``attribute:ecs.availability-zone``. For the ``binpack`` placement strategy, valid values are ``CPU`` and ``MEMORY``. For the ``random`` placement strategy, this field is not used.", "type": "string" }, "Type": { + "description": "The type of placement strategy. The ``random`` placement strategy randomly places tasks on available candidates. The ``spread`` placement strategy spreads placement across available candidates evenly based on the ``field`` parameter. The ``binpack`` strategy places tasks on available candidates that have the least available amount of the resource that's specified with the ``field`` parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory but still enough to run the task.", "enum": [ "binpack", "random", @@ -241,11 +284,14 @@ }, "Secret": { "additionalProperties": false, + "description": "An object representing the secret to expose to your container. Secrets can be exposed to a container in the following ways:\n + To inject sensitive data into your containers as environment variables, use the ``secrets`` container definition parameter.\n + To reference sensitive information in the log configuration of a container, use the ``secretOptions`` container definition parameter.\n \n For more information, see [Specifying sensitive data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer Guide*.", "properties": { "Name": { + "description": "The name of the secret.", "type": "string" }, "ValueFrom": { + "description": "The secret to expose to the container. The supported values are either the full ARN of the ASMlong secret or the full ARN of the parameter in the SSM Parameter Store.\n For information about the require IAMlong permissions, see [Required IAM permissions for Amazon ECS secrets](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-secrets.html#secrets-iam) (for Secrets Manager) or [Required IAM permissions for Amazon ECS secrets](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-parameters.html) (for Systems Manager Parameter store) in the *Amazon Elastic Container Service Developer Guide*.\n If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.", "type": "string" } }, @@ -257,11 +303,14 @@ }, "ServiceConnectClientAlias": { "additionalProperties": false, + "description": "Each alias (\"endpoint\") is a fully-qualified name and port number that other tasks (\"clients\") can use to connect to this service.\n Each name and port mapping must be unique within the namespace.\n Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*.", "properties": { "DnsName": { + "description": "The ``dnsName`` is the name that you use in the applications of client tasks to connect to this service. The name must be a valid DNS name but doesn't need to be fully-qualified. The name can include up to 127 characters. The name can include lowercase letters, numbers, underscores (_), hyphens (-), and periods (.). The name can't start with a hyphen.\n If this parameter isn't specified, the default value of ``discoveryName.namespace`` is used. If the ``discoveryName`` isn't specified, the port mapping name from the task definition is used in ``portName.namespace``.\n To avoid changing your applications in client Amazon ECS services, set this to the same name that the client application uses by default. For example, a few common names are ``database``, ``db``, or the lowercase name of a database, such as ``mysql`` or ``redis``. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*.", "type": "string" }, "Port": { + "description": "The listening port number for the Service Connect proxy. This port is available inside of all of the tasks within the same namespace.\n To avoid changing your applications in client Amazon ECS services, set this to the same port that the client application uses by default. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*.", "type": "integer" } }, @@ -272,17 +321,22 @@ }, "ServiceConnectConfiguration": { "additionalProperties": false, + "description": "The Service Connect configuration of your Amazon ECS service. The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.\n Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*.", "properties": { "Enabled": { + "description": "Specifies whether to use Service Connect with this service.", "type": "boolean" }, "LogConfiguration": { - "$ref": "#/definitions/LogConfiguration" + "$ref": "#/definitions/LogConfiguration", + "description": "The log configuration for the container. This parameter maps to ``LogConfig`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--log-driver`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/commandline/run/).\n By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a different logging driver than the Docker daemon by specifying a log driver configuration in the container definition. For more information about the options for different supported log drivers, see [Configure logging drivers](https://docs.aws.amazon.com/https://docs.docker.com/engine/admin/logging/overview/) in the Docker documentation.\n Understand the following when specifying a log configuration for your containers.\n + Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon. Additional log drivers may be available in future releases of the Amazon ECS container agent.\n For tasks on FARGATElong, the supported log drivers are ``awslogs``, ``splunk``, and ``awsfirelens``.\n For tasks hosted on Amazon EC2 instances, the supported log drivers are ``awslogs``, ``fluentd``, ``gelf``, ``json-file``, ``journald``, ``logentries``,``syslog``, ``splunk``, and ``awsfirelens``.\n + This parameter requires version 1.18 of the Docker Remote API or greater on your container instance.\n + For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container agent must register the available logging drivers with the ``ECS_AVAILABLE_LOGGING_DRIVERS`` environment variable before containers placed on that instance can use these log configuration options. For more information, see [Amazon ECS container agent configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service Developer Guide*.\n + For tasks that are on FARGATElong, because you don't have access to the underlying infrastructure your tasks are hosted on, any additional software needed must be installed outside of the task. For example, the Fluentd output aggregators or a remote host running Logstash to send Gelf logs to." }, "Namespace": { + "description": "The namespace name or full Amazon Resource Name (ARN) of the CMAPlong namespace for use with Service Connect. The namespace must be in the same AWS Region as the Amazon ECS service and cluster. The type of namespace doesn't affect Service Connect. For more information about CMAPlong, see [Working with Services](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-services.html) in the *Developer Guide*.", "type": "string" }, "Services": { + "description": "The list of Service Connect service objects. These are names and aliases (also known as endpoints) that are used by other Amazon ECS services to connect to this service. \n This field is not required for a \"client\" Amazon ECS service that's a member of a namespace only to connect to other services within the namespace. An example of this would be a frontend application that accepts incoming requests from either a load balancer that's attached to the service or by other means.\n An object selects a port from the task definition, assigns a name for the CMAPlong service, and a list of aliases (endpoints) and ports for client applications to refer to this service.", "items": { "$ref": "#/definitions/ServiceConnectService" }, @@ -296,21 +350,34 @@ }, "ServiceConnectService": { "additionalProperties": false, + "description": "The 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 Guide*.", "properties": { "ClientAliases": { + "description": "The list of client aliases for this Service Connect service. You use these to assign names that can be used by client applications. The maximum number of client aliases that you can have in this list is 1.\n Each alias (\"endpoint\") is a fully-qualified name and port number that other Amazon ECS tasks (\"clients\") can use to connect to this service.\n Each name and port mapping must be unique within the namespace.\n For each ``ServiceConnectService``, you must provide at least one ``clientAlias`` with one ``port``.", "items": { "$ref": "#/definitions/ServiceConnectClientAlias" }, "type": "array" }, "DiscoveryName": { + "description": "The ``discoveryName`` is the name of the new CMAP service that Amazon ECS creates for this Amazon ECS service. This must be unique within the CMAP namespace. The name can contain up to 64 characters. The name can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen.\n If the ``discoveryName`` isn't specified, the port mapping name from the task definition is used in ``portName.namespace``.", "type": "string" }, "IngressPortOverride": { + "description": "The port number for the Service Connect proxy to listen on.\n Use the value of this field to bypass the proxy for traffic on the port number specified in the named ``portMapping`` in the task definition of this application, and then use it in your VPC security groups to allow traffic into the proxy for this Amazon ECS service.\n In ``awsvpc`` mode and Fargate, the default value is the container port number. The container port number is in the ``portMapping`` in the task definition. In bridge mode, the default value is the ephemeral port of the Service Connect proxy.", "type": "integer" }, "PortName": { + "description": "The ``portName`` must match the name of one of the ``portMappings`` from all the containers in the task definition of this Amazon ECS service.", "type": "string" + }, + "Timeout": { + "$ref": "#/definitions/TimeoutConfiguration", + "description": "A reference to an object that represents the configured timeouts for Service Connect." + }, + "Tls": { + "$ref": "#/definitions/ServiceConnectTlsConfiguration", + "description": "A reference to an object that represents a Transport Layer Security (TLS) configuration." } }, "required": [ @@ -318,39 +385,83 @@ ], "type": "object" }, + "ServiceConnectTlsCertificateAuthority": { + "additionalProperties": false, + "description": "An object that represents the AWS Private Certificate Authority certificate.", + "properties": { + "AwsPcaAuthorityArn": { + "description": "The ARN of the AWS Private Certificate Authority certificate.", + "type": "string" + } + }, + "type": "object" + }, + "ServiceConnectTlsConfiguration": { + "additionalProperties": false, + "description": "An object that represents the configuration for Service Connect TLS.", + "properties": { + "IssuerCertificateAuthority": { + "$ref": "#/definitions/ServiceConnectTlsCertificateAuthority", + "description": "The signer certificate authority." + }, + "KmsKey": { + "description": "The AWS Key Management Service key.", + "type": "string" + }, + "RoleArn": { + "description": "The Amazon Resource Name (ARN) of the IAM role that's associated with the Service Connect TLS.", + "type": "string" + } + }, + "required": [ + "IssuerCertificateAuthority" + ], + "type": "object" + }, "ServiceManagedEBSVolumeConfiguration": { + "description": "The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf. These settings are used to create each Amazon EBS volume, with one volume created for each task in the service.\n Many of these parameters map 1:1 with the Amazon EBS ``CreateVolume`` API request parameters.", "properties": { "Encrypted": { + "description": "Indicates whether the volume should be encrypted. If no value is specified, encryption is turned on by default. This parameter maps 1:1 with the ``Encrypted`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*.", "type": "boolean" }, "FilesystemType": { + "description": "The Linux filesystem type for the volume. For volumes created from a snapshot, you must specify the same filesystem type that the volume was using when the snapshot was created. If there is a filesystem type mismatch, the task will fail to start.\n The available filesystem types are? ``ext3``, ``ext4``, and ``xfs``. If no value is specified, the ``xfs`` filesystem type is used by default.", "type": "string" }, "Iops": { + "description": "The number of I/O operations per second (IOPS). For ``gp3``, ``io1``, and ``io2`` volumes, this represents the number of IOPS that are provisioned for the volume. For ``gp2`` volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.\n The 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\n \n This parameter is required for ``io1`` and ``io2`` volume types. The default for ``gp3`` volumes is ``3,000 IOPS``. This parameter is not supported for ``st1``, ``sc1``, or ``standard`` volume types.\n This 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 Reference*.", "type": "integer" }, "KmsKeyId": { + "description": "The Amazon Resource Name (ARN) identifier of the AWS Key Management Service key to use for Amazon EBS encryption. When encryption is turned on and no AWS Key Management Service key is specified, the default AWS managed key for Amazon EBS volumes is used. This parameter maps 1:1 with the ``KmsKeyId`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*.\n AWS authenticates the AWS Key Management Service key asynchronously. Therefore, if you specify an ID, alias, or ARN that is invalid, the action can appear to complete, but eventually fails.", "type": "string" }, "RoleArn": { + "description": "The ARN of the IAM role to associate with this volume. This is the Amazon ECS infrastructure IAM role that is used to manage your AWS infrastructure. We recommend using the Amazon ECS-managed ``AmazonECSInfrastructureRolePolicyForVolumes`` IAM policy with this role. For more information, see [Amazon ECS infrastructure IAM role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/infrastructure_IAM_role.html) in the *Amazon ECS Developer Guide*.", "type": "string" }, "SizeInGiB": { + "description": "The size of the volume in GiB. You must specify either a volume size or a snapshot ID. If you specify a snapshot ID, the snapshot size is used for the volume size by default. You can optionally specify a volume size greater than or equal to the snapshot size. This 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 Reference*.\n The 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", "type": "integer" }, "SnapshotId": { + "description": "The snapshot that Amazon ECS uses to create the volume. You must specify either a snapshot ID or a volume size. This parameter maps 1:1 with the ``SnapshotId`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*.", "type": "string" }, "TagSpecifications": { + "description": "The tags to apply to the volume. Amazon ECS applies service-managed tags by default. This parameter maps 1:1 with the ``TagSpecifications.N`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*.", "items": { "$ref": "#/definitions/EBSTagSpecification" }, "type": "array" }, "Throughput": { + "description": "The throughput to provision for a volume, in MiB/s, with a maximum of 1,000 MiB/s. This 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 Reference*.\n This parameter is only supported for the ``gp3`` volume type.", "type": "integer" }, "VolumeType": { + "description": "The volume type. This parameter maps 1:1 with the ``VolumeType`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*. For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volume-types.html) in the *Amazon EC2 User Guide*.\n The 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 The magnetic volume type is not supported on Fargate.", "type": "string" } }, @@ -361,28 +472,36 @@ }, "ServiceRegistry": { "additionalProperties": false, + "description": "The ``ServiceRegistry`` property specifies details of the service registry. For more information, see [Service Discovery](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html) in the *Amazon Elastic Container Service Developer Guide*.", "properties": { "ContainerName": { + "description": "The container name value to be used for your service discovery service. It's already specified in the task definition. If the task definition that your service task specifies uses the ``bridge`` or ``host`` network mode, you must specify a ``containerName`` and ``containerPort`` combination from the task definition. If the task definition that your service task specifies uses the ``awsvpc`` network mode and a type SRV DNS record is used, you must specify either a ``containerName`` and ``containerPort`` combination or a ``port`` value. However, you can't specify both.", "type": "string" }, "ContainerPort": { + "description": "The port value to be used for your service discovery service. It's already specified in the task definition. If the task definition your service task specifies uses the ``bridge`` or ``host`` network mode, you must specify a ``containerName`` and ``containerPort`` combination from the task definition. If the task definition your service task specifies uses the ``awsvpc`` network mode and a type SRV DNS record is used, you must specify either a ``containerName`` and ``containerPort`` combination or a ``port`` value. However, you can't specify both.", "type": "integer" }, "Port": { + "description": "The port value used if your service discovery service specified an SRV record. This field might be used if both the ``awsvpc`` network mode and SRV records are used.", "type": "integer" }, "RegistryArn": { + "description": "The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is CMAP. For more information, see [CreateService](https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html).", "type": "string" } }, "type": "object" }, "ServiceVolumeConfiguration": { + "description": "The configuration for a volume specified in the task definition as a volume that is configured at launch time. Currently, the only supported volume type is an Amazon EBS volume.", "properties": { "ManagedEBSVolume": { - "$ref": "#/definitions/ServiceManagedEBSVolumeConfiguration" + "$ref": "#/definitions/ServiceManagedEBSVolumeConfiguration", + "description": "The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf. These settings are used to create each Amazon EBS volume, with one volume created for each task in the service. The Amazon EBS volumes are visible in your account in the Amazon EC2 console once they are created." }, "Name": { + "description": "The name of the volume. This value must match the volume name from the ``Volume`` object in the task definition.", "type": "string" } }, @@ -393,18 +512,36 @@ }, "Tag": { "additionalProperties": false, + "description": "The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value. You define them.\n The following basic restrictions apply to tags:\n + Maximum number of tags per resource - 50\n + For each resource, each tag key must be unique, and each tag key can have only one value.\n + Maximum key length - 128 Unicode characters in UTF-8\n + Maximum value length - 256 Unicode characters in UTF-8\n + If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.\n + Tag keys and values are case-sensitive.\n + Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.", "properties": { "Key": { + "description": "One part of a key-value pair that make up a tag. A ``key`` is a general label that acts like a category for more specific tag values.", "type": "string" }, "Value": { + "description": "The optional part of a key-value pair that make up a tag. A ``value`` acts as a descriptor within a tag category (key).", "type": "string" } }, "type": "object" + }, + "TimeoutConfiguration": { + "additionalProperties": false, + "description": "An object that represents the timeout configurations for Service Connect.\n If ``idleTimeout`` is set to a time that is less than ``perRequestTimeout``, the connection will close when the ``idleTimeout`` is reached and not the ``perRequestTimeout``.", + "properties": { + "IdleTimeoutSeconds": { + "description": "The amount of time in seconds a connection will stay active while idle. A value of ``0`` can be set to disable ``idleTimeout``.\n The ``idleTimeout`` default for ``HTTP``/``HTTP2``/``GRPC`` is 5 minutes.\n The ``idleTimeout`` default for ``TCP`` is 1 hour.", + "type": "integer" + }, + "PerRequestTimeoutSeconds": { + "description": "The amount of time waiting for the upstream to respond with a complete response per request. A value of ``0`` can be set to disable ``perRequestTimeout``. ``perRequestTimeout`` can only be set if Service Connect ``appProtocol`` isn't ``TCP``. Only ``idleTimeout`` is allowed for ``TCP`` ``appProtocol``.", + "type": "integer" + } + }, + "type": "object" } }, - "description": "Resource Type definition for AWS::ECS::Service", + "description": "The ``AWS::ECS::Service`` resource creates an Amazon Elastic Container Service (Amazon ECS) service that runs and maintains the requested number of tasks and associated load balancers.\n The stack update fails if you change any properties that require replacement and at least one Amazon ECS Service Connect ``ServiceConnectService`` is configured. This is because AWS CloudFormation creates the replacement service first, but each ``ServiceConnectService`` must have a name that is unique in the namespace.\n Starting April 15, 2023, AWS; will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, ECS, or EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.", "handlers": { "create": { "permissions": [ @@ -451,33 +588,42 @@ ], "properties": { "CapacityProviderStrategy": { + "description": "The capacity provider strategy to use for the service.\n If a ``capacityProviderStrategy`` is specified, the ``launchType`` parameter must be omitted. If no ``capacityProviderStrategy`` or ``launchType`` is specified, the ``defaultCapacityProviderStrategy`` for the cluster is used.\n A capacity provider strategy may contain a maximum of 6 capacity providers.", "items": { "$ref": "#/definitions/CapacityProviderStrategyItem" }, "type": "array" }, "Cluster": { + "description": "The short name or full Amazon Resource Name (ARN) of the cluster that you run your service on. If you do not specify a cluster, the default cluster is assumed.", "type": "string" }, "DeploymentConfiguration": { - "$ref": "#/definitions/DeploymentConfiguration" + "$ref": "#/definitions/DeploymentConfiguration", + "description": "Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks." }, "DeploymentController": { - "$ref": "#/definitions/DeploymentController" + "$ref": "#/definitions/DeploymentController", + "description": "The deployment controller to use for the service. If no deployment controller is specified, the default value of ``ECS`` is used." }, "DesiredCount": { + "description": "The number of instantiations of the specified task definition to place and keep running in your service.\n For new services, if a desired count is not specified, a default value of ``1`` is used. When using the ``DAEMON`` scheduling strategy, the desired count is not required.\n For existing services, if a desired count is not specified, it is omitted from the operation.", "type": "integer" }, "EnableECSManagedTags": { + "description": "Specifies whether to turn on Amazon ECS managed tags for the tasks within the service. For more information, see [Tagging your Amazon ECS resources](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) in the *Amazon Elastic Container Service Developer Guide*.\n When you use Amazon ECS managed tags, you need to set the ``propagateTags`` request parameter.", "type": "boolean" }, "EnableExecuteCommand": { + "description": "Determines whether the execute command functionality is turned on for the service. If ``true``, the execute command functionality is turned on for all containers in tasks as part of the service.", "type": "boolean" }, "HealthCheckGracePeriodSeconds": { + "description": "The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started. This is only used when your service is configured to use a load balancer. If your service has a load balancer defined and you don't specify a health check grace period value, the default value of ``0`` is used.\n If you do not use an Elastic Load Balancing, we recommend that you use the ``startPeriod`` in the task definition health check parameters. For more information, see [Health check](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_HealthCheck.html).\n If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds (about 69 years). During that time, the Amazon ECS service scheduler ignores health check status. This grace period can prevent the service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.", "type": "integer" }, "LaunchType": { + "description": "The launch type on which to run your service. For more information, see [Amazon ECS Launch Types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer Guide*.", "enum": [ "EC2", "FARGATE", @@ -486,24 +632,29 @@ "type": "string" }, "LoadBalancers": { + "description": "A list of load balancer objects to associate with the service. If you specify the ``Role`` property, ``LoadBalancers`` must be specified as well. For information about the number of load balancers that you can specify per service, see [Service Load Balancing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html) in the *Amazon Elastic Container Service Developer Guide*.", "items": { "$ref": "#/definitions/LoadBalancer" }, "type": "array" }, "Name": { + "description": "", "type": "string" }, "NetworkConfiguration": { - "$ref": "#/definitions/NetworkConfiguration" + "$ref": "#/definitions/NetworkConfiguration", + "description": "The network configuration for the service. This parameter is required for task definitions that use the ``awsvpc`` network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*." }, "PlacementConstraints": { + "description": "An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints for each task. This limit includes constraints in the task definition and those specified at runtime.", "items": { "$ref": "#/definitions/PlacementConstraint" }, "type": "array" }, "PlacementStrategies": { + "description": "The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules for each service.", "items": { "$ref": "#/definitions/PlacementStrategy" }, @@ -511,9 +662,11 @@ }, "PlatformVersion": { "default": "LATEST", + "description": "The platform version that your tasks in the service are running on. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the ``LATEST`` platform version is used. For more information, see [platform versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) in the *Amazon Elastic Container Service Developer Guide*.", "type": "string" }, "PropagateTags": { + "description": "Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the task during 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.\n The default is ``NONE``.", "enum": [ "SERVICE", "TASK_DEFINITION" @@ -521,9 +674,11 @@ "type": "string" }, "Role": { + "description": "The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition doesn't use the ``awsvpc`` network mode. If you specify the ``role`` parameter, you must also specify a load balancer object with the ``loadBalancers`` parameter.\n If your account has already created the Amazon ECS service-linked role, that role is used for your service unless you specify a role here. The service-linked role is required if your task definition uses the ``awsvpc`` network mode or if the service is configured to use service discovery, an external deployment controller, multiple target groups, or Elastic Inference accelerators in which case you don't specify a role here. For more information, see [Using service-linked roles for Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html) in the *Amazon Elastic Container Service Developer Guide*.\n If your specified role has a path other than ``/``, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name ``bar`` has a path of ``/foo/`` then you would specify ``/foo/bar`` as the role name. For more information, see [Friendly names and paths](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names) in the *IAM User Guide*.", "type": "string" }, "SchedulingStrategy": { + "description": "The scheduling strategy to use for the service. For more information, see [Services](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html).\n There are two service scheduler strategies available:\n + ``REPLICA``-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. This scheduler strategy is required if the service uses the ``CODE_DEPLOY`` or ``EXTERNAL`` deployment controller types.\n + ``DAEMON``-The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that don't meet the placement constraints. When you're using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies.\n Tasks using the Fargate launch type or the ``CODE_DEPLOY`` or ``EXTERNAL`` deployment controller types don't support the ``DAEMON`` scheduling strategy.", "enum": [ "DAEMON", "REPLICA" @@ -531,30 +686,37 @@ "type": "string" }, "ServiceArn": { + "description": "", "type": "string" }, "ServiceConnectConfiguration": { - "$ref": "#/definitions/ServiceConnectConfiguration" + "$ref": "#/definitions/ServiceConnectConfiguration", + "description": "The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.\n Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*." }, "ServiceName": { + "description": "The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.\n The stack update fails if you change any properties that require replacement and the ``ServiceName`` is configured. This is because AWS CloudFormation creates the replacement service first, but each ``ServiceName`` must be unique in the cluster.", "type": "string" }, "ServiceRegistries": { + "description": "The details of the service discovery registry to associate with this service. For more information, see [Service discovery](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html).\n Each service may be associated with one service registry. Multiple service registries for each service isn't supported.", "items": { "$ref": "#/definitions/ServiceRegistry" }, "type": "array" }, "Tags": { + "description": "The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as well.\n The following basic restrictions apply to tags:\n + Maximum number of tags per resource - 50\n + For each resource, each tag key must be unique, and each tag key can have only one value.\n + Maximum key length - 128 Unicode characters in UTF-8\n + Maximum value length - 256 Unicode characters in UTF-8\n + If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.\n + Tag keys and values are case-sensitive.\n + Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.", "items": { "$ref": "#/definitions/Tag" }, "type": "array" }, "TaskDefinition": { + "description": "The ``family`` and ``revision`` (``family:revision``) or full ARN of the task definition to run in your service. If a ``revision`` isn't specified, the latest ``ACTIVE`` revision is used.\n A task definition must be specified if the service uses either the ``ECS`` or ``CODE_DEPLOY`` deployment controllers.\n For more information about deployment types, see [Amazon ECS deployment types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html).", "type": "string" }, "VolumeConfigurations": { + "description": "The configuration for a volume specified in the task definition as a volume that is configured at launch time. Currently, the only supported volume type is an Amazon EBS volume.", "items": { "$ref": "#/definitions/ServiceVolumeConfiguration" }, diff --git a/artifacts/types/AWS::ECS::TaskDefinition.json b/artifacts/types/AWS::ECS::TaskDefinition.json index 3006c357..e584b41c 100644 --- a/artifacts/types/AWS::ECS::TaskDefinition.json +++ b/artifacts/types/AWS::ECS::TaskDefinition.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ECS-TaskDefinition", "type": "AWS::ECS::TaskDefinition", - "time": "2024-01-04T16:57:20.861Z", + "time": "2024-06-24T16:02:45.54Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -25,11 +25,14 @@ "definitions": { "AuthorizationConfig": { "additionalProperties": false, + "description": "The authorization configuration details for the Amazon EFS file system.", "properties": { "AccessPointId": { + "description": "The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the ``EFSVolumeConfiguration`` must either be omitted or set to ``/`` which will enforce the path set on the EFS access point. If an access point is used, transit encryption must be on in the ``EFSVolumeConfiguration``. For more information, see [Working with Amazon EFS access points](https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html) in the *Amazon Elastic File System User Guide*.", "type": "string" }, "IAM": { + "description": "Determines whether to use the Amazon ECS task role defined in a task definition when mounting the Amazon EFS file system. If it is turned on, transit encryption must be turned on in the ``EFSVolumeConfiguration``. If this parameter is omitted, the default value of ``DISABLED`` is used. For more information, see [Using Amazon EFS access points](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/efs-volumes.html#efs-volume-accesspoints) in the *Amazon Elastic Container Service Developer Guide*.", "enum": [ "ENABLED", "DISABLED" @@ -41,9 +44,10 @@ }, "ContainerDefinition": { "additionalProperties": false, - "description": "List of container definitions that are passed to the Docker daemon on a container instance", + "description": "The ``ContainerDefinition`` property specifies a container definition. Container definitions are used in task definitions to describe the different containers that are launched as part of a task.", "properties": { "Command": { + "description": "The command that's passed to the container. This parameter maps to ``Cmd`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``COMMAND`` parameter to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). For more information, see [https://docs.docker.com/engine/reference/builder/#cmd](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/builder/#cmd). If there are multiple arguments, each argument is a separated string in the array.", "insertionOrder": true, "items": { "type": "string" @@ -51,9 +55,19 @@ "type": "array" }, "Cpu": { + "description": "The number of ``cpu`` units reserved for the container. This parameter maps to ``CpuShares`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--cpu-shares`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-level ``cpu`` value.\n You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the [Amazon EC2 Instances](https://docs.aws.amazon.com/ec2/instance-types/) detail page by 1,024.\n Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that's the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task is guaranteed a minimum of 512 CPU units when needed. Moreover, each container could float to higher CPU usage if the other container was not using it. If both tasks were 100% active all of the time, they would be limited to 512 CPU units.\n On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see [CPU share constraint](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#cpu-share-constraint) in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2. However, the CPU parameter isn't required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:\n + *Agent versions less than or equal to 1.1.0:* Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to two CPU shares.\n + *Agent versions greater than or equal to 1.2.0:* Null, zero, and CPU values of 1 are passed to Docker as 2.\n \n On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that's described in the task definition. A null or zero CPU value is passed to Docker as ``0``, which Windows interprets as 1% of one CPU.", "type": "integer" }, + "CredentialSpecs": { + "description": "A list of ARNs in SSM or Amazon S3 to a credential spec (``CredSpec``) file that configures the container for Active Directory authentication. We recommend that you use this parameter instead of the ``dockerSecurityOptions``. The maximum number of ARNs is 1.\n There are two formats for each ARN.\n + credentialspecdomainless:MyARN You use credentialspecdomainless:MyARN to provide a CredSpec with an additional section for a secret in . You provide the login credentials to the domain in the secret. Each task that runs on any container instance can join different domains. You can use this format without joining the container instance to a domain. + credentialspec:MyARN You use credentialspec:MyARN to provide a CredSpec for a single domain. You must join the container instance to the domain before you start any tasks that use this task definition. \n In both formats, replace ``MyARN`` with the ARN in SSM or Amazon S3.\n If you provide a ``credentialspecdomainless:MyARN``, the ``credspec`` must provide a ARN in ASMlong for a secret containing the username, password, and the domain to connect to. For better security, the instance isn't joined to the domain for domainless authentication. Other applications on the instance can't use the domainless credentials. You can use this parameter to run tasks on the same instance, even it the tasks need to join different domains. For more information, see [Using gMSAs for Windows Containers](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows-gmsa.html) and [Using gMSAs for Linux Containers](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/linux-gmsa.html).", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + }, "DependsOn": { + "description": "The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed.\n For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to turn on container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the *Amazon Elastic Container Service Developer Guide*. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ``ecs-init`` package. If your container instances are launched from version ``20190301`` or later, then they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*.\n For tasks using the Fargate launch type, the task or service requires the following platforms:\n + Linux platform version ``1.3.0`` or later.\n + Windows platform version ``1.0.0`` or later.\n \n If the task definition is used in a blue/green deployment that uses [AWS::CodeDeploy::DeploymentGroup BlueGreenDeploymentConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-bluegreendeploymentconfiguration.html), the ``dependsOn`` parameter is not supported. For more information see [Issue #680](https://docs.aws.amazon.com/https://github.com/aws-cloudformation/cloudformation-coverage-roadmap/issues/680) on the on the GitHub website.", "insertionOrder": false, "items": { "$ref": "#/definitions/ContainerDependency" @@ -61,9 +75,11 @@ "type": "array" }, "DisableNetworking": { + "description": "When this parameter is true, networking is off within the container. This parameter maps to ``NetworkDisabled`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/).\n This parameter is not supported for Windows containers.", "type": "boolean" }, "DnsSearchDomains": { + "description": "A list of DNS search domains that are presented to the container. This parameter maps to ``DnsSearch`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--dns-search`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n This parameter is not supported for Windows containers.", "insertionOrder": false, "items": { "type": "string" @@ -71,6 +87,7 @@ "type": "array" }, "DnsServers": { + "description": "A list of DNS servers that are presented to the container. This parameter maps to ``Dns`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--dns`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n This parameter is not supported for Windows containers.", "insertionOrder": false, "items": { "type": "string" @@ -79,6 +96,7 @@ }, "DockerLabels": { "additionalProperties": false, + "description": "A key/value map of labels to add to the container. This parameter maps to ``Labels`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--label`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'``", "patternProperties": { ".{1,}": { "type": "string" @@ -87,6 +105,7 @@ "type": "object" }, "DockerSecurityOptions": { + "description": "A list of strings to provide custom configuration for multiple security systems. For more information about valid values, see [Docker Run Security Configuration](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). This field isn't valid for containers in tasks using the Fargate launch type.\n For Linux tasks on EC2, this parameter can be used to reference custom labels for SELinux and AppArmor multi-level security systems.\n For any tasks on EC2, this parameter can be used to reference a credential spec file that configures a container for Active Directory authentication. For more information, see [Using gMSAs for Windows Containers](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows-gmsa.html) and [Using gMSAs for Linux Containers](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/linux-gmsa.html) in the *Amazon Elastic Container Service Developer Guide*.\n This parameter maps to ``SecurityOpt`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--security-opt`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n The Amazon ECS container agent running on a container instance must register with the ``ECS_SELINUX_CAPABLE=true`` or ``ECS_APPARMOR_CAPABLE=true`` environment variables before containers placed on that instance can use these security options. For more information, see [Amazon ECS Container Agent Configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service Developer Guide*.\n For more information about valid values, see [Docker Run Security Configuration](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). \n Valid values: \"no-new-privileges\" | \"apparmor:PROFILE\" | \"label:value\" | \"credentialspec:CredentialSpecFilePath\"", "insertionOrder": false, "items": { "type": "string" @@ -94,6 +113,7 @@ "type": "array" }, "EntryPoint": { + "description": "Early versions of the Amazon ECS container agent don't properly handle ``entryPoint`` parameters. If you have problems using ``entryPoint``, update your container agent or enter your commands and arguments as ``command`` array items instead.\n The entry point that's passed to the container. This parameter maps to ``Entrypoint`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--entrypoint`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). For more information, see [https://docs.docker.com/engine/reference/builder/#entrypoint](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/builder/#entrypoint).", "insertionOrder": true, "items": { "type": "string" @@ -101,7 +121,7 @@ "type": "array" }, "Environment": { - "description": "The environment variables to pass to a container", + "description": "The environment variables to pass to a container. This parameter maps to ``Env`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--env`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n We don't recommend that you use plaintext environment variables for sensitive information, such as credential data.", "insertionOrder": false, "items": { "$ref": "#/definitions/KeyValuePair" @@ -110,7 +130,7 @@ "uniqueItems": true }, "EnvironmentFiles": { - "description": "The list of one or more files that contain the environment variables to pass to a container", + "description": "A list of files containing the environment variables to pass to a container. This parameter maps to the ``--env-file`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n You can specify up to ten environment files. The file must have a ``.env`` file extension. Each line in an environment file contains an environment variable in ``VARIABLE=VALUE`` format. Lines beginning with ``#`` are treated as comments and are ignored. For more information about the environment variable file syntax, see [Declare default environment variables in file](https://docs.aws.amazon.com/https://docs.docker.com/compose/env-file/).\n If there are environment variables specified using the ``environment`` parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they're processed from the top down. We recommend that you use unique variable names. For more information, see [Specifying Environment Variables](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html) in the *Amazon Elastic Container Service Developer Guide*.", "insertionOrder": true, "items": { "$ref": "#/definitions/EnvironmentFile" @@ -118,9 +138,11 @@ "type": "array" }, "Essential": { + "description": "If the ``essential`` parameter of a container is marked as ``true``, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the ``essential`` parameter of a container is marked as ``false``, its failure doesn't affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.\n All tasks must have at least one essential container. If you have an application that's composed of multiple containers, group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see [Application Architecture](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/application_architecture.html) in the *Amazon Elastic Container Service Developer Guide*.", "type": "boolean" }, "ExtraHosts": { + "description": "A list of hostnames and IP address mappings to append to the ``/etc/hosts`` file on the container. This parameter maps to ``ExtraHosts`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--add-host`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n This parameter isn't supported for Windows containers or tasks that use the ``awsvpc`` network mode.", "insertionOrder": false, "items": { "$ref": "#/definitions/HostEntry" @@ -128,22 +150,27 @@ "type": "array" }, "FirelensConfiguration": { - "$ref": "#/definitions/FirelensConfiguration" + "$ref": "#/definitions/FirelensConfiguration", + "description": "The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see [Custom Log Routing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) in the *Amazon Elastic Container Service Developer Guide*." }, "HealthCheck": { - "$ref": "#/definitions/HealthCheck" + "$ref": "#/definitions/HealthCheck", + "description": "The container health check command and associated configuration parameters for the container. This parameter maps to ``HealthCheck`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``HEALTHCHECK`` parameter of [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration)." }, "Hostname": { + "description": "The hostname to use for your container. This parameter maps to ``Hostname`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--hostname`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n The ``hostname`` parameter is not supported if you're using the ``awsvpc`` network mode.", "type": "string" }, "Image": { - "description": "The image used to start a container. This string is passed directly to the Docker daemon.", + "description": "The image used to start a container. This string is passed directly to the Docker daemon. By default, images in the Docker Hub registry are available. Other repositories are specified with either ``repository-url/image:tag`` or ``repository-url/image@digest``. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to ``Image`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``IMAGE`` parameter of [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n + When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image aren't propagated to already running tasks.\n + Images in Amazon ECR repositories can be specified by either using the full ``registry/repository:tag`` or ``registry/repository@digest``. For example, ``012345678910.dkr.ecr.\u003cregion-name\u003e.amazonaws.com/\u003crepository-name\u003e:latest`` or ``012345678910.dkr.ecr.\u003cregion-name\u003e.amazonaws.com/\u003crepository-name\u003e@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE``. \n + Images in official repositories on Docker Hub use a single name (for example, ``ubuntu`` or ``mongo``).\n + Images in other repositories on Docker Hub are qualified with an organization name (for example, ``amazon/amazon-ecs-agent``).\n + Images in other online repositories are qualified further by a domain name (for example, ``quay.io/assemblyline/ubuntu``).", "type": "string" }, "Interactive": { + "description": "When this parameter is ``true``, you can deploy containerized applications that require ``stdin`` or a ``tty`` to be allocated. This parameter maps to ``OpenStdin`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--interactive`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).", "type": "boolean" }, "Links": { + "description": "The ``links`` parameter allows containers to communicate with each other without the need for port mappings. This parameter is only supported if the network mode of a task definition is ``bridge``. The ``name:internalName`` construct is analogous to ``name:alias`` in Docker links. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. For more information about linking Docker containers, go to [Legacy container links](https://docs.aws.amazon.com/https://docs.docker.com/network/links/) in the Docker documentation. This parameter maps to ``Links`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--link`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n This parameter is not supported for Windows containers.\n Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.", "insertionOrder": false, "items": { "type": "string" @@ -152,19 +179,23 @@ "uniqueItems": true }, "LinuxParameters": { - "$ref": "#/definitions/LinuxParameters" + "$ref": "#/definitions/LinuxParameters", + "description": "Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information see [KernelCapabilities](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html).\n This parameter is not supported for Windows containers." }, "LogConfiguration": { - "$ref": "#/definitions/LogConfiguration" + "$ref": "#/definitions/LogConfiguration", + "description": "The log configuration specification for the container.\n This parameter maps to ``LogConfig`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--log-driver`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/). By default, containers use the same logging driver that the Docker daemon uses. However, the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see [Configure logging drivers](https://docs.aws.amazon.com/https://docs.docker.com/engine/admin/logging/overview/) in the Docker documentation.\n Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the [LogConfiguration](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_LogConfiguration.html) data type). Additional log drivers may be available in future releases of the Amazon ECS container agent.\n This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'`` \n The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ``ECS_AVAILABLE_LOGGING_DRIVERS`` environment variable before containers placed on that instance can use these log configuration options. For more information, see [Amazon ECS Container Agent Configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service Developer Guide*." }, "Memory": { - "description": "The amount (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed.", + "description": "The amount (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. The total amount of memory reserved for all containers within a task must be lower than the task ``memory`` value, if one is specified. This parameter maps to ``Memory`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--memory`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n If using the Fargate launch type, this parameter is optional.\n If using the EC2 launch type, you must specify either a task-level memory value or a container-level memory value. If you specify both a container-level ``memory`` and ``memoryReservation`` value, ``memory`` must be greater than ``memoryReservation``. If you specify ``memoryReservation``, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value of ``memory`` is used.\n The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container, so you should not specify fewer than 6 MiB of memory for your containers.\n The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.", "type": "integer" }, "MemoryReservation": { + "description": "The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the ``memory`` parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps to ``MemoryReservation`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--memory-reservation`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n If a task-level memory value is not specified, you must specify a non-zero integer for one or both of ``memory`` or ``memoryReservation`` in a container definition. If you specify both, ``memory`` must be greater than ``memoryReservation``. If you specify ``memoryReservation``, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value of ``memory`` is used.\n For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a ``memoryReservation`` of 128 MiB, and a ``memory`` hard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed.\n The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers. \n The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers.", "type": "integer" }, "MountPoints": { + "description": "The mount points for data volumes in your container.\n This parameter maps to ``Volumes`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--volume`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n Windows containers can mount whole directories on the same drive as ``$env:ProgramData``. Windows containers can't mount directories on a different drive, and mount point can't be across drives.", "insertionOrder": true, "items": { "$ref": "#/definitions/MountPoint" @@ -173,11 +204,11 @@ "uniqueItems": true }, "Name": { - "description": "The name of a container. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed", + "description": "The name of a container. If you're linking multiple containers together in a task definition, the ``name`` of one container can be entered in the ``links`` of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter maps to ``name`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--name`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).", "type": "string" }, "PortMappings": { - "description": "Port mappings allow containers to access ports on the host container instance to send or receive traffic.", + "description": "The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic.\n For task definitions that use the ``awsvpc`` network mode, you should only specify the ``containerPort``. The ``hostPort`` can be left blank or it must be the same value as the ``containerPort``.\n Port mappings on Windows use the ``NetNAT`` gateway address rather than ``localhost``. There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself. \n This parameter maps to ``PortBindings`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--publish`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/). If the network mode of a task definition is set to ``none``, then you can't specify port mappings. If the network mode of a task definition is set to ``host``, then host ports must either be undefined or they must match the container port in the port mapping.\n After a task reaches the ``RUNNING`` status, manual and automatic host and container port assignments are visible in the *Network Bindings* section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in the ``networkBindings`` section [DescribeTasks](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html) responses.", "insertionOrder": false, "items": { "$ref": "#/definitions/PortMapping" @@ -186,18 +217,23 @@ "uniqueItems": true }, "Privileged": { + "description": "When this parameter is true, the container is given elevated privileges on the host container instance (similar to the ``root`` user). This parameter maps to ``Privileged`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--privileged`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n This parameter is not supported for Windows containers or tasks run on FARGATElong.", "type": "boolean" }, "PseudoTerminal": { + "description": "When this parameter is ``true``, a TTY is allocated. This parameter maps to ``Tty`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--tty`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).", "type": "boolean" }, "ReadonlyRootFilesystem": { + "description": "When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ``ReadonlyRootfs`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--read-only`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n This parameter is not supported for Windows containers.", "type": "boolean" }, "RepositoryCredentials": { - "$ref": "#/definitions/RepositoryCredentials" + "$ref": "#/definitions/RepositoryCredentials", + "description": "The private repository authentication credentials to use." }, "ResourceRequirements": { + "description": "The type and amount of a resource to assign to a container. The only supported resource is a GPU.", "insertionOrder": false, "items": { "$ref": "#/definitions/ResourceRequirement" @@ -205,6 +241,7 @@ "type": "array" }, "Secrets": { + "description": "The secrets to pass to the container. For more information, see [Specifying Sensitive Data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer Guide*.", "insertionOrder": false, "items": { "$ref": "#/definitions/Secret" @@ -212,12 +249,15 @@ "type": "array" }, "StartTimeout": { + "description": "Time duration (in seconds) to wait before giving up on resolving dependencies for a container. For example, you specify two containers in a task definition with containerA having a dependency on containerB reaching a ``COMPLETE``, ``SUCCESS``, or ``HEALTHY`` status. If a ``startTimeout`` value is specified for containerB and it doesn't reach the desired status within that time then containerA gives up and not start. This results in the task transitioning to a ``STOPPED`` state.\n When the ``ECS_CONTAINER_START_TIMEOUT`` container agent configuration variable is used, it's enforced independently from this start timeout value.\n For tasks using the Fargate launch type, the task or service requires the following platforms:\n + Linux platform version ``1.3.0`` or later.\n + Windows platform version ``1.0.0`` or later.\n \n For tasks using the EC2 launch type, your container instances require at least version ``1.26.0`` of the container agent to use a container start timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the *Amazon Elastic Container Service Developer Guide*. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version ``1.26.0-1`` of the ``ecs-init`` package. If your container instances are launched from version ``20190301`` or later, then they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*.\n The valid values are 2-120 seconds.", "type": "integer" }, "StopTimeout": { + "description": "Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own.\n For tasks using the Fargate launch type, the task or service requires the following platforms:\n + Linux platform version ``1.3.0`` or later.\n + Windows platform version ``1.0.0`` or later.\n \n The max stop timeout value is 120 seconds and if the parameter is not specified, the default value of 30 seconds is used.\n For tasks that use the EC2 launch type, if the ``stopTimeout`` parameter isn't specified, the value set for the Amazon ECS container agent configuration variable ``ECS_CONTAINER_STOP_TIMEOUT`` is used. If neither the ``stopTimeout`` parameter or the ``ECS_CONTAINER_STOP_TIMEOUT`` agent configuration variable are set, then the default values of 30 seconds for Linux containers and 30 seconds on Windows containers are used. Your container instances require at least version 1.26.0 of the container agent to use a container stop timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the *Amazon Elastic Container Service Developer Guide*. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ``ecs-init`` package. If your container instances are launched from version ``20190301`` or later, then they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*.\n The valid values are 2-120 seconds.", "type": "integer" }, "SystemControls": { + "description": "A list of namespaced kernel parameters to set in the container. This parameter maps to ``Sysctls`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--sysctl`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). For example, you can configure ``net.ipv4.tcp_keepalive_time`` setting to maintain longer lived connections.", "insertionOrder": false, "items": { "$ref": "#/definitions/SystemControl" @@ -225,6 +265,7 @@ "type": "array" }, "Ulimits": { + "description": "A list of ``ulimits`` to set in the container. This parameter maps to ``Ulimits`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--ulimit`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/). Valid naming values are displayed in the [Ulimit](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Ulimit.html) data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'`` \n This parameter is not supported for Windows containers.", "insertionOrder": false, "items": { "$ref": "#/definitions/Ulimit" @@ -232,9 +273,11 @@ "type": "array" }, "User": { + "description": "The user to use inside the container. This parameter maps to ``User`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--user`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n When running tasks using the ``host`` network mode, don't run containers using the root user (UID 0). We recommend using a non-root user for better security.\n You can specify the ``user`` using the following formats. If specifying a UID or GID, you must specify it as a positive integer.\n + ``user`` \n + ``user:group`` \n + ``uid`` \n + ``uid:gid`` \n + ``user:gid`` \n + ``uid:group`` \n \n This parameter is not supported for Windows containers.", "type": "string" }, "VolumesFrom": { + "description": "Data volumes to mount from another container. This parameter maps to ``VolumesFrom`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--volumes-from`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).", "insertionOrder": false, "items": { "$ref": "#/definitions/VolumeFrom" @@ -243,6 +286,7 @@ "uniqueItems": true }, "WorkingDirectory": { + "description": "The working directory to run commands inside the container in. This parameter maps to ``WorkingDir`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--workdir`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).", "type": "string" } }, @@ -254,11 +298,14 @@ }, "ContainerDependency": { "additionalProperties": false, + "description": "The ``ContainerDependency`` property specifies the dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed.\n Your Amazon ECS container instances require at least version 1.26.0 of the container agent to enable container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the *Amazon Elastic Container Service Developer Guide*. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ``ecs-init`` package. If your container instances are launched from version ``20190301`` or later, then they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*.\n For tasks using the Fargate launch type, this parameter requires that the task or service uses platform version 1.3.0 or later.", "properties": { "Condition": { + "description": "The dependency condition of the container. The following are the available conditions and their behavior:\n + ``START`` - This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start.\n + ``COMPLETE`` - This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition can't be set on an essential container.\n + ``SUCCESS`` - This condition is the same as ``COMPLETE``, but it also requires that the container exits with a ``zero`` status. This condition can't be set on an essential container.\n + ``HEALTHY`` - This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confirmed only at task startup.", "type": "string" }, "ContainerName": { + "description": "The name of a container.", "type": "string" } }, @@ -266,14 +313,18 @@ }, "Device": { "additionalProperties": false, + "description": "The ``Device`` property specifies an object representing a container instance host device.", "properties": { "ContainerPath": { + "description": "The path inside the container at which to expose the host device.", "type": "string" }, "HostPath": { + "description": "The path for the device on the host container instance.", "type": "string" }, "Permissions": { + "description": "The explicit permissions to provide to the container for the device. By default, the container has permissions for ``read``, ``write``, and ``mknod`` for the device.", "insertionOrder": false, "items": { "type": "string" @@ -286,15 +337,19 @@ }, "DockerVolumeConfiguration": { "additionalProperties": false, + "description": "The ``DockerVolumeConfiguration`` property specifies a Docker volume configuration and is used when you use Docker volumes. Docker volumes are only supported when you are using the EC2 launch type. Windows containers only support the use of the ``local`` driver. To use bind mounts, specify a ``host`` instead.", "properties": { "Autoprovision": { + "description": "If this value is ``true``, the Docker volume is created if it doesn't already exist.\n This field is only used if the ``scope`` is ``shared``.", "type": "boolean" }, "Driver": { + "description": "The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use ``docker plugin ls`` to retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. For more information, see [Docker plugin discovery](https://docs.aws.amazon.com/https://docs.docker.com/engine/extend/plugin_api/#plugin-discovery). This parameter maps to ``Driver`` in the [Create a volume](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``xxdriver`` option to [docker volume create](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/commandline/volume_create/).", "type": "string" }, "DriverOpts": { "additionalProperties": false, + "description": "A map of Docker driver-specific options passed through. This parameter maps to ``DriverOpts`` in the [Create a volume](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``xxopt`` option to [docker volume create](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/commandline/volume_create/).", "patternProperties": { ".{1,}": { "type": "string" @@ -304,6 +359,7 @@ }, "Labels": { "additionalProperties": false, + "description": "Custom metadata to add to your Docker volume. This parameter maps to ``Labels`` in the [Create a volume](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``xxlabel`` option to [docker volume create](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/commandline/volume_create/).", "patternProperties": { ".{1,}": { "type": "string" @@ -312,6 +368,7 @@ "type": "object" }, "Scope": { + "description": "The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a ``task`` are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped as ``shared`` persist after the task stops.", "type": "string" } }, @@ -319,17 +376,22 @@ }, "EFSVolumeConfiguration": { "additionalProperties": false, + "description": "This parameter is specified when you're using an Amazon Elastic File System file system for task storage. For more information, see [Amazon EFS volumes](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/efs-volumes.html) in the *Amazon Elastic Container Service Developer Guide*.", "properties": { "AuthorizationConfig": { - "$ref": "#/definitions/AuthorizationConfig" + "$ref": "#/definitions/AuthorizationConfig", + "description": "The authorization configuration details for the Amazon EFS file system." }, "FilesystemId": { + "description": "The Amazon EFS file system ID to use.", "type": "string" }, "RootDirectory": { + "description": "The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume will be used. Specifying ``/`` will have the same effect as omitting this parameter.\n If an EFS access point is specified in the ``authorizationConfig``, the root directory parameter must either be omitted or set to ``/`` which will enforce the path set on the EFS access point.", "type": "string" }, "TransitEncryption": { + "description": "Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be turned on if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of ``DISABLED`` is used. For more information, see [Encrypting data in transit](https://docs.aws.amazon.com/efs/latest/ug/encryption-in-transit.html) in the *Amazon Elastic File System User Guide*.", "enum": [ "ENABLED", "DISABLED" @@ -337,6 +399,7 @@ "type": "string" }, "TransitEncryptionPort": { + "description": "The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses. For more information, see [EFS mount helper](https://docs.aws.amazon.com/efs/latest/ug/efs-mount-helper.html) in the *Amazon Elastic File System User Guide*.", "type": "integer" } }, @@ -347,11 +410,14 @@ }, "EnvironmentFile": { "additionalProperties": false, + "description": "A list of files containing the environment variables to pass to a container. You can specify up to ten environment files. The file must have a ``.env`` file extension. Each line in an environment file should contain an environment variable in ``VARIABLE=VALUE`` format. Lines beginning with ``#`` are treated as comments and are ignored.\n If there are environment variables specified using the ``environment`` parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they're processed from the top down. We recommend that you use unique variable names. For more information, see [Use a file to pass environment variables to a container](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/use-environment-file.html) in the *Amazon Elastic Container Service Developer Guide*.\n Environment variable files are objects in Amazon S3 and all Amazon S3 security considerations apply. \n You 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.\n \n Consider 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.", "properties": { "Type": { + "description": "The file type to use. Environment files are objects in Amazon S3. The only supported value is ``s3``.", "type": "string" }, "Value": { + "description": "The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file.", "type": "string" } }, @@ -359,18 +425,64 @@ }, "EphemeralStorage": { "additionalProperties": false, + "description": "The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on FARGATElong. For more information, see [Using data volumes in tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html) in the *Amazon ECS Developer Guide;*.\n For tasks using the Fargate launch type, the task requires the following platforms:\n + Linux platform version ``1.4.0`` or later.\n + Windows platform version ``1.0.0`` or later.", "properties": { "SizeInGiB": { + "description": "The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is ``20`` GiB and the maximum supported value is ``200`` GiB.", "type": "integer" } }, "type": "object" }, + "FSxAuthorizationConfig": { + "additionalProperties": false, + "description": "", + "properties": { + "CredentialsParameter": { + "description": "", + "type": "string" + }, + "Domain": { + "description": "", + "type": "string" + } + }, + "required": [ + "CredentialsParameter", + "Domain" + ], + "type": "object" + }, + "FSxWindowsFileServerVolumeConfiguration": { + "additionalProperties": false, + "description": "This parameter is specified when you're using [Amazon FSx for Windows File Server](https://docs.aws.amazon.com/fsx/latest/WindowsGuide/what-is.html) file system for task storage.\n For more information and the input format, see [Amazon FSx for Windows File Server volumes](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/wfsx-volumes.html) in the *Amazon Elastic Container Service Developer Guide*.", + "properties": { + "AuthorizationConfig": { + "$ref": "#/definitions/FSxAuthorizationConfig", + "description": "The authorization configuration details for the Amazon FSx for Windows File Server file system." + }, + "FileSystemId": { + "description": "The Amazon FSx for Windows File Server file system ID to use.", + "type": "string" + }, + "RootDirectory": { + "description": "The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host.", + "type": "string" + } + }, + "required": [ + "FileSystemId", + "RootDirectory" + ], + "type": "object" + }, "FirelensConfiguration": { "additionalProperties": false, + "description": "The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see [Custom log routing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) in the *Amazon Elastic Container Service Developer Guide*.", "properties": { "Options": { "additionalProperties": false, + "description": "The options to use when configuring the log router. This field is optional and can be used to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event.\n If specified, valid option keys are:\n + ``enable-ecs-log-metadata``, which can be ``true`` or ``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", "patternProperties": { ".{1,}": { "type": "string" @@ -379,6 +491,7 @@ "type": "object" }, "Type": { + "description": "The log router to use. The valid values are ``fluentd`` or ``fluentbit``.", "type": "string" } }, @@ -386,10 +499,10 @@ }, "HealthCheck": { "additionalProperties": false, - "description": "The health check command and associated configuration parameters for the container.", + "description": "The ``HealthCheck`` property specifies an object representing a container health check. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image's Dockerfile). This configuration maps to the ``HEALTHCHECK`` parameter of [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/).\n The Amazon ECS container agent only monitors and reports on the health checks specified in the task definition. Amazon ECS does not monitor Docker health checks that are embedded in a container image and not specified in the container definition. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image.\n If a task is run manually, and not as part of a service, the task will continue its lifecycle regardless of its health status. For tasks that are part of a service, if the task reports as unhealthy then the task will be stopped and the service scheduler will replace it.\n The following are notes about container health check support:\n + Container health checks require version 1.17.0 or greater of the Amazon ECS container agent. For more information, see [Updating the Amazon 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 version 1.1.0 or greater. For more information, see [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 that is configured to use a Classic Load Balancer.", "properties": { "Command": { - "description": "A string array representing the command that the container runs to determine if it is healthy.", + "description": "A string array representing the command that the container runs to determine if it is healthy. The string array must start with ``CMD`` to run the command arguments directly, or ``CMD-SHELL`` to run the command with the container's default shell. \n When you use the AWS Management Console JSON panel, the CLIlong, or the APIs, enclose the list of commands in double quotes and brackets.\n ``[ \"CMD-SHELL\", \"curl -f http://localhost/ || exit 1\" ]`` \n You don't include the double quotes and brackets when you use the AWS Management Console.\n ``CMD-SHELL, curl -f http://localhost/ || exit 1`` \n An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, see ``HealthCheck`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/).", "insertionOrder": true, "items": { "type": "string" @@ -401,15 +514,15 @@ "type": "integer" }, "Retries": { - "description": "The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is three retries.", + "description": "The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3.", "type": "integer" }, "StartPeriod": { - "description": "The optional grace period within which to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You may specify between 0 and 300 seconds. The startPeriod is disabled by default.", + "description": "The optional grace period to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You can specify between 0 and 300 seconds. By default, the ``startPeriod`` is off.\n If a health check succeeds within the ``startPeriod``, then the container is considered healthy and any subsequent failures count toward the maximum number of retries.", "type": "integer" }, "Timeout": { - "description": "The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5 seconds.", + "description": "The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5.", "type": "integer" } }, @@ -417,11 +530,14 @@ }, "HostEntry": { "additionalProperties": false, + "description": "The ``HostEntry`` property specifies a hostname and an IP address that are added to the ``/etc/hosts`` file of a container through the ``extraHosts`` parameter of its ``ContainerDefinition`` resource.", "properties": { "Hostname": { + "description": "The hostname to use in the ``/etc/hosts`` entry.", "type": "string" }, "IpAddress": { + "description": "The IP address to use in the ``/etc/hosts`` entry.", "type": "string" } }, @@ -429,8 +545,10 @@ }, "HostVolumeProperties": { "additionalProperties": false, + "description": "The ``HostVolumeProperties`` property specifies details on a container instance bind mount host volume.", "properties": { "SourcePath": { + "description": "When the ``host`` parameter is used, specify a ``sourcePath`` to declare the path on the host container instance that's presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the ``host`` parameter contains a ``sourcePath`` file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the ``sourcePath`` value doesn't exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.\n If you're using the Fargate launch type, the ``sourcePath`` parameter is not supported.", "type": "string" } }, @@ -438,11 +556,14 @@ }, "InferenceAccelerator": { "additionalProperties": false, + "description": "Details on an Elastic Inference accelerator. For more information, see [Working with Amazon Elastic Inference on Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-inference.html) in the *Amazon Elastic Container Service Developer Guide*.", "properties": { "DeviceName": { + "description": "The Elastic Inference accelerator device name. The ``deviceName`` must also be referenced in a container definition as a [ResourceRequirement](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ResourceRequirement.html).", "type": "string" }, "DeviceType": { + "description": "The Elastic Inference accelerator type to use.", "type": "string" } }, @@ -450,8 +571,10 @@ }, "KernelCapabilities": { "additionalProperties": false, + "description": "The Linux capabilities to add or remove from the default Docker configuration for a container defined in the task definition. For more information about the default capabilities and the non-default available capabilities, see [Runtime privilege and Linux capabilities](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities) in the *Docker run reference*. For more detailed information about these Linux capabilities, see the [capabilities(7)](https://docs.aws.amazon.com/http://man7.org/linux/man-pages/man7/capabilities.7.html) Linux manual page.", "properties": { "Add": { + "description": "The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to ``CapAdd`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--cap-add`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n Tasks launched on FARGATElong only support adding the ``SYS_PTRACE`` kernel capability.\n Valid values: ``\"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" | \"BLOCK_SUSPEND\" | \"CHOWN\" | \"DAC_OVERRIDE\" | \"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" | \"IPC_LOCK\" | \"IPC_OWNER\" | \"KILL\" | \"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" | \"MAC_OVERRIDE\" | \"MKNOD\" | \"NET_ADMIN\" | \"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" | \"SETFCAP\" | \"SETGID\" | \"SETPCAP\" | \"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" | \"SYS_CHROOT\" | \"SYS_MODULE\" | \"SYS_NICE\" | \"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" | \"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" | \"SYSLOG\" | \"WAKE_ALARM\"``", "insertionOrder": false, "items": { "type": "string" @@ -459,6 +582,7 @@ "type": "array" }, "Drop": { + "description": "The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to ``CapDrop`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--cap-drop`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n Valid values: ``\"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" | \"BLOCK_SUSPEND\" | \"CHOWN\" | \"DAC_OVERRIDE\" | \"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" | \"IPC_LOCK\" | \"IPC_OWNER\" | \"KILL\" | \"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" | \"MAC_OVERRIDE\" | \"MKNOD\" | \"NET_ADMIN\" | \"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" | \"SETFCAP\" | \"SETGID\" | \"SETPCAP\" | \"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" | \"SYS_CHROOT\" | \"SYS_MODULE\" | \"SYS_NICE\" | \"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" | \"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" | \"SYSLOG\" | \"WAKE_ALARM\"``", "insertionOrder": false, "items": { "type": "string" @@ -470,11 +594,14 @@ }, "KeyValuePair": { "additionalProperties": false, + "description": "A key-value pair object.", "properties": { "Name": { + "description": "The name of the key-value pair. For environment variables, this is the name of the environment variable.", "type": "string" }, "Value": { + "description": "The value of the key-value pair. For environment variables, this is the value of the environment variable.", "type": "string" } }, @@ -482,11 +609,14 @@ }, "LinuxParameters": { "additionalProperties": false, + "description": "The Linux-specific options that are applied to the container, such as Linux [KernelCapabilities](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html).", "properties": { "Capabilities": { - "$ref": "#/definitions/KernelCapabilities" + "$ref": "#/definitions/KernelCapabilities", + "description": "The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.\n For tasks that use the Fargate launch type, ``capabilities`` is supported for all platform versions but the ``add`` parameter is only supported if using platform version 1.4.0 or later." }, "Devices": { + "description": "Any host devices to expose to the container. This parameter maps to ``Devices`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--device`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n If you're using tasks that use the Fargate launch type, the ``devices`` parameter isn't supported.", "insertionOrder": false, "items": { "$ref": "#/definitions/Device" @@ -494,18 +624,23 @@ "type": "array" }, "InitProcessEnabled": { + "description": "Run an ``init`` process inside the container that forwards signals and reaps processes. This parameter maps to the ``--init`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'``", "type": "boolean" }, "MaxSwap": { + "description": "The total amount of swap memory (in MiB) a container can use. This parameter will be translated to the ``--memory-swap`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration) where the value would be the sum of the container memory plus the ``maxSwap`` value.\n If a ``maxSwap`` value of ``0`` is specified, the container will not use swap. Accepted values are ``0`` or any positive integer. If the ``maxSwap`` parameter is omitted, the container will use the swap configuration for the container instance it is running on. A ``maxSwap`` value must be set for the ``swappiness`` parameter to be used.\n If you're using tasks that use the Fargate launch type, the ``maxSwap`` parameter isn't supported.\n If you're using tasks on Amazon Linux 2023 the ``swappiness`` parameter isn't supported.", "type": "integer" }, "SharedMemorySize": { + "description": "The value for the size (in MiB) of the ``/dev/shm`` volume. This parameter maps to the ``--shm-size`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n If you are using tasks that use the Fargate launch type, the ``sharedMemorySize`` parameter is not supported.", "type": "integer" }, "Swappiness": { + "description": "This allows you to tune a container's memory swappiness behavior. A ``swappiness`` value of ``0`` will cause swapping to not happen unless absolutely necessary. A ``swappiness`` value of ``100`` will cause pages to be swapped very aggressively. Accepted values are whole numbers between ``0`` and ``100``. If the ``swappiness`` parameter is not specified, a default value of ``60`` is used. If a value is not specified for ``maxSwap`` then this parameter is ignored. This parameter maps to the ``--memory-swappiness`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n If you're using tasks that use the Fargate launch type, the ``swappiness`` parameter isn't supported.\n If you're using tasks on Amazon Linux 2023 the ``swappiness`` parameter isn't supported.", "type": "integer" }, "Tmpfs": { + "description": "The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the ``--tmpfs`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n If you're using tasks that use the Fargate launch type, the ``tmpfs`` parameter isn't supported.", "insertionOrder": false, "items": { "$ref": "#/definitions/Tmpfs" @@ -517,12 +652,15 @@ }, "LogConfiguration": { "additionalProperties": false, + "description": "The ``LogConfiguration`` property specifies log configuration options to send to a custom log driver for the container.", "properties": { "LogDriver": { + "description": "The log driver to use for the container.\n For tasks on FARGATElong, the supported log drivers are ``awslogs``, ``splunk``, and ``awsfirelens``.\n For tasks hosted on Amazon EC2 instances, the supported log drivers are ``awslogs``, ``fluentd``, ``gelf``, ``json-file``, ``journald``, ``logentries``,``syslog``, ``splunk``, and ``awsfirelens``.\n For more information about using the ``awslogs`` log driver, see [Using the awslogs log driver](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html) in the *Amazon Elastic Container Service Developer Guide*.\n For more information about using the ``awsfirelens`` log driver, see [Custom log routing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) in the *Amazon Elastic Container Service Developer Guide*.\n If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's [available on GitHub](https://docs.aws.amazon.com/https://github.com/aws/amazon-ecs-agent) and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we don't currently provide support for running modified copies of this software.", "type": "string" }, "Options": { "additionalProperties": false, + "description": "The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'``", "patternProperties": { ".{1,}": { "type": "string" @@ -531,6 +669,7 @@ "type": "object" }, "SecretOptions": { + "description": "The secrets to pass to the log configuration. For more information, see [Specifying sensitive data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer Guide*.", "insertionOrder": false, "items": { "$ref": "#/definitions/Secret" @@ -545,14 +684,18 @@ }, "MountPoint": { "additionalProperties": false, + "description": "The details for a volume mount point that's used in a container definition.", "properties": { "ContainerPath": { + "description": "The path on the container to mount the host volume at.", "type": "string" }, "ReadOnly": { + "description": "If this value is ``true``, the container has read-only access to the volume. If this value is ``false``, then the container can write to the volume. The default value is ``false``.", "type": "boolean" }, "SourceVolume": { + "description": "The name of the volume to mount. Must be a volume name referenced in the ``name`` parameter of task definition ``volume``.", "type": "string" } }, @@ -560,8 +703,10 @@ }, "PortMapping": { "additionalProperties": false, + "description": "The ``PortMapping`` property specifies a port mapping. Port mappings allow containers to access ports on the host container instance to send or receive traffic. Port mappings are specified as part of the container definition.\n If you are using containers in a task with the ``awsvpc`` or ``host`` network mode, exposed ports should be specified using ``containerPort``. The ``hostPort`` can be left blank or it must be the same value as the ``containerPort``.\n After a task reaches the ``RUNNING`` status, manual and automatic host and container port assignments are visible in the ``networkBindings`` section of [DescribeTasks](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html) API responses.", "properties": { "AppProtocol": { + "description": "The application protocol that's used for the port mapping. This parameter only applies to Service Connect. We recommend that you set this parameter to be consistent with the protocol that your application uses. If you set this parameter, Amazon ECS adds protocol-specific connection handling to the Service Connect proxy. If you set this parameter, Amazon ECS adds protocol-specific telemetry in the Amazon ECS console and CloudWatch.\n If you don't set a value for this parameter, then TCP is used. However, Amazon ECS doesn't add protocol-specific telemetry for TCP.\n ``appProtocol`` is immutable in a Service Connect service. Updating this field requires a service deletion and redeployment.\n Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*.", "enum": [ "http", "http2", @@ -570,18 +715,23 @@ "type": "string" }, "ContainerPort": { + "description": "The port number on the container that's bound to the user-specified or automatically assigned host port.\n If you use containers in a task with the ``awsvpc`` or ``host`` network mode, specify the exposed ports using ``containerPort``.\n If you use containers in a task with the ``bridge`` network mode and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range. For more information, see ``hostPort``. Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance.", "type": "integer" }, "ContainerPortRange": { + "description": "The port number range on the container that's bound to the dynamically mapped host port range. \n The following rules apply when you specify a ``containerPortRange``:\n + You must use either the ``bridge`` network mode or the ``awsvpc`` network mode.\n + This parameter is available for both the EC2 and FARGATElong launch types.\n + This parameter is available for both the Linux and Windows operating systems.\n + The container instance must have at least version 1.67.0 of the container agent and at least version 1.67.0-1 of the ``ecs-init`` package \n + You can specify a maximum of 100 port ranges per container.\n + You do not specify a ``hostPortRange``. The value of the ``hostPortRange`` is set as follows:\n + For containers in a task with the ``awsvpc`` network mode, the ``hostPortRange`` is set to the same value as the ``containerPortRange``. This is a static mapping strategy.\n + For containers in a task with the ``bridge`` network mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports.\n \n + The ``containerPortRange`` valid values are between 1 and 65535.\n + A port can only be included in one port mapping per container.\n + You cannot specify overlapping port ranges.\n + The first port in the range must be less than last port in the range.\n + Docker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports.\n For more information, see [Issue #11185](https://docs.aws.amazon.com/https://github.com/moby/moby/issues/11185) on the Github website.\n For information about how to turn off the docker-proxy in the Docker daemon 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 Guide*.\n \n You can call [DescribeTasks](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html) to view the ``hostPortRange`` which are the host ports that are bound to the container ports.", "type": "string" }, "HostPort": { + "description": "The port number on the container instance to reserve for your container.\n If you specify a ``containerPortRange``, leave this field empty and the value of the ``hostPort`` is set as follows:\n + For containers in a task with the ``awsvpc`` network mode, the ``hostPort`` is set to the same value as the ``containerPort``. This is a static mapping strategy.\n + For containers in a task with the ``bridge`` network mode, the Amazon ECS agent finds open ports on the host and automatically binds them to the container ports. This is a dynamic mapping strategy.\n \n If you use containers in a task with the ``awsvpc`` or ``host`` network mode, the ``hostPort`` can either be left blank or set to the same value as the ``containerPort``.\n If you use containers in a task with the ``bridge`` network mode, you can specify a non-reserved host port for your container port mapping, or you can omit the ``hostPort`` (or set it to ``0``) while specifying a ``containerPort`` and your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version.\n The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under ``/proc/sys/net/ipv4/ip_local_port_range``. If this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 (Linux) or 49152 through 65535 (Windows) is used. Do not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.\n The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678-51680. Any host port that was previously specified in a running task is also reserved while the task is running. That is, after a task stops, the host port is released. The current reserved ports are displayed in the ``remainingResources`` of [DescribeContainerInstances](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeContainerInstances.html) output. A container instance can have up to 100 reserved ports at a time. This number includes the default reserved ports. Automatically assigned ports aren't included in the 100 reserved ports quota.", "type": "integer" }, "Name": { + "description": "The name that's used for the port mapping. This parameter only applies to Service Connect. This parameter is the name that you use in the ``serviceConnectConfiguration`` of a service. The name can include up to 64 characters. The characters can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen.\n For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*.", "type": "string" }, "Protocol": { + "description": "The protocol used for the port mapping. Valid values are ``tcp`` and ``udp``. The default is ``tcp``. ``protocol`` is immutable in a Service Connect service. Updating this field requires a service deletion and redeployment.", "type": "string" } }, @@ -589,11 +739,14 @@ }, "ProxyConfiguration": { "additionalProperties": false, + "description": "The configuration details for the App Mesh proxy.\n For tasks that use the EC2 launch type, the container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ``ecs-init`` package to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version ``20190301`` or later, then they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html)", "properties": { "ContainerName": { + "description": "The name of the container that will serve as the App Mesh proxy.", "type": "string" }, "ProxyConfigurationProperties": { + "description": "The set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified as key-value pairs.\n + ``IgnoredUID`` - (Required) The user ID (UID) of the proxy container as defined by the ``user`` parameter in a container definition. This is used to ensure the proxy ignores its own traffic. If ``IgnoredGID`` is specified, this field can be empty.\n + ``IgnoredGID`` - (Required) The group ID (GID) of the proxy container as defined by the ``user`` parameter in a container definition. This is used to ensure the proxy ignores its own traffic. If ``IgnoredUID`` is specified, this field can be empty.\n + ``AppPorts`` - (Required) The list of ports that the application uses. Network traffic to these ports is forwarded to the ``ProxyIngressPort`` and ``ProxyEgressPort``.\n + ``ProxyIngressPort`` - (Required) Specifies the port that incoming traffic to the ``AppPorts`` is directed to.\n + ``ProxyEgressPort`` - (Required) Specifies the port that outgoing traffic from the ``AppPorts`` is directed to.\n + ``EgressIgnoredPorts`` - (Required) The egress traffic going to the specified ports is ignored and not redirected to the ``ProxyEgressPort``. It can be an empty list.\n + ``EgressIgnoredIPs`` - (Required) The egress traffic going to the specified IP addresses is ignored and not redirected to the ``ProxyEgressPort``. It can be an empty list.", "insertionOrder": false, "items": { "$ref": "#/definitions/KeyValuePair" @@ -602,6 +755,7 @@ "uniqueItems": true }, "Type": { + "description": "The proxy type. The only supported value is ``APPMESH``.", "type": "string" } }, @@ -612,8 +766,10 @@ }, "RepositoryCredentials": { "additionalProperties": false, + "description": "The repository credentials for private registry authentication.", "properties": { "CredentialsParameter": { + "description": "The Amazon Resource Name (ARN) of the secret containing the private repository credentials.\n When you use the Amazon ECS API, CLI, or AWS SDK, if the secret exists in the same Region as the task that you're launching then you can use either the full ARN or the name of the secret. When you use the AWS Management Console, you must specify the full ARN of the secret.", "type": "string" } }, @@ -621,11 +777,14 @@ }, "ResourceRequirement": { "additionalProperties": false, + "description": "The type and amount of a resource to assign to a container. The supported resource types are GPUs and Elastic Inference accelerators. For more information, see [Working with GPUs on Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-gpu.html) or [Working with Amazon Elastic Inference on Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-inference.html) in the *Amazon Elastic Container Service Developer Guide*", "properties": { "Type": { + "description": "The type of resource to assign to a container.", "type": "string" }, "Value": { + "description": "The value for the specified resource type.\n When the type is ``GPU``, the value is the number of physical ``GPUs`` the Amazon ECS container agent reserves for the container. The number of GPUs that's reserved for all containers in a task can't exceed the number of available GPUs on the container instance that the task is launched on.\n When the type is ``InferenceAccelerator``, the ``value`` matches the ``deviceName`` for an [InferenceAccelerator](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_InferenceAccelerator.html) specified in a task definition.", "type": "string" } }, @@ -637,11 +796,14 @@ }, "RuntimePlatform": { "additionalProperties": false, + "description": "Information about the platform for the Amazon ECS service or task.\n For 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 Guide*.", "properties": { "CpuArchitecture": { + "description": "The CPU architecture.\n You can run your Linux tasks on an ARM-based platform by setting the value to ``ARM64``. This option is available for tasks that run on Linux Amazon EC2 instance or Linux containers on Fargate.", "type": "string" }, "OperatingSystemFamily": { + "description": "The operating system.", "type": "string" } }, @@ -649,11 +811,14 @@ }, "Secret": { "additionalProperties": false, + "description": "An object representing the secret to expose to your container. Secrets can be exposed to a container in the following ways:\n + To inject sensitive data into your containers as environment variables, use the ``secrets`` container definition parameter.\n + To reference sensitive information in the log configuration of a container, use the ``secretOptions`` container definition parameter.\n \n For more information, see [Specifying sensitive data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer Guide*.", "properties": { "Name": { + "description": "The name of the secret.", "type": "string" }, "ValueFrom": { + "description": "The secret to expose to the container. The supported values are either the full ARN of the ASMlong secret or the full ARN of the parameter in the SSM Parameter Store.\n For information about the require IAMlong permissions, see [Required IAM permissions for Amazon ECS secrets](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-secrets.html#secrets-iam) (for Secrets Manager) or [Required IAM permissions for Amazon ECS secrets](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-parameters.html) (for Systems Manager Parameter store) in the *Amazon Elastic Container Service Developer Guide*.\n If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.", "type": "string" } }, @@ -665,11 +830,14 @@ }, "SystemControl": { "additionalProperties": false, + "description": "A list of namespaced kernel parameters to set in the container. This parameter maps to ``Sysctls`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--sysctl`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). For example, you can configure ``net.ipv4.tcp_keepalive_time`` setting to maintain longer lived connections.\n We don't recommend that you specify network-related ``systemControls`` parameters for multiple containers in a single task that also uses either the ``awsvpc`` or ``host`` network mode. Doing this has the following disadvantages:\n + For tasks that use the ``awsvpc`` network mode including Fargate, if you set ``systemControls`` for any container, it applies to all containers in the task. If you set different ``systemControls`` for multiple containers in a single task, the container that's started last determines which ``systemControls`` take effect.\n + For tasks that use the ``host`` network mode, the network namespace ``systemControls`` aren't supported.\n \n If you're setting an IPC resource namespace to use for the containers in the task, the following 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 ``systemControls`` aren't supported.\n + For tasks that use the ``task`` IPC mode, IPC namespace ``systemControls`` values apply to all containers within a task.\n \n This parameter is not supported for Windows containers.\n This parameter is only supported for tasks that are hosted on FARGATElong if the tasks are using platform version ``1.4.0`` or later (Linux). This isn't supported for Windows containers on Fargate.", "properties": { "Namespace": { + "description": "The namespaced kernel parameter to set a ``value`` for.", "type": "string" }, "Value": { + "description": "The namespaced kernel parameter to set a ``value`` for.\n Valid IPC namespace values: ``\"kernel.msgmax\" | \"kernel.msgmnb\" | \"kernel.msgmni\" | \"kernel.sem\" | \"kernel.shmall\" | \"kernel.shmmax\" | \"kernel.shmmni\" | \"kernel.shm_rmid_forced\"``, and ``Sysctls`` that start with ``\"fs.mqueue.*\"`` \n Valid network namespace values: ``Sysctls`` that start with ``\"net.*\"`` \n All of these values are supported by Fargate.", "type": "string" } }, @@ -677,11 +845,14 @@ }, "Tag": { "additionalProperties": false, + "description": "The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value. You define them.\n The following basic restrictions apply to tags:\n + Maximum number of tags per resource - 50\n + For each resource, each tag key must be unique, and each tag key can have only one value.\n + Maximum key length - 128 Unicode characters in UTF-8\n + Maximum value length - 256 Unicode characters in UTF-8\n + If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.\n + Tag keys and values are case-sensitive.\n + Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.", "properties": { "Key": { + "description": "One part of a key-value pair that make up a tag. A ``key`` is a general label that acts like a category for more specific tag values.", "type": "string" }, "Value": { + "description": "The optional part of a key-value pair that make up a tag. A ``value`` acts as a descriptor within a tag category (key).", "type": "string" } }, @@ -689,11 +860,14 @@ }, "TaskDefinitionPlacementConstraint": { "additionalProperties": false, + "description": "The constraint on task placement in the task definition. For more information, 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 Task placement constraints aren't supported for tasks run on FARGATElong.", "properties": { "Expression": { + "description": "A cluster query language expression to apply to the constraint. For more information, see [Cluster query language](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) in the *Amazon Elastic Container Service Developer Guide*.", "type": "string" }, "Type": { + "description": "The type of constraint. The ``MemberOf`` constraint restricts selection to be from a group of valid candidates.", "type": "string" } }, @@ -704,11 +878,14 @@ }, "Tmpfs": { "additionalProperties": false, + "description": "The container path, mount options, and size of the tmpfs mount.", "properties": { "ContainerPath": { + "description": "The absolute file path where the tmpfs volume is to be mounted.", "type": "string" }, "MountOptions": { + "description": "The list of tmpfs volume mount options.\n Valid values: ``\"defaults\" | \"ro\" | \"rw\" | \"suid\" | \"nosuid\" | \"dev\" | \"nodev\" | \"exec\" | \"noexec\" | \"sync\" | \"async\" | \"dirsync\" | \"remount\" | \"mand\" | \"nomand\" | \"atime\" | \"noatime\" | \"diratime\" | \"nodiratime\" | \"bind\" | \"rbind\" | \"unbindable\" | \"runbindable\" | \"private\" | \"rprivate\" | \"shared\" | \"rshared\" | \"slave\" | \"rslave\" | \"relatime\" | \"norelatime\" | \"strictatime\" | \"nostrictatime\" | \"mode\" | \"uid\" | \"gid\" | \"nr_inodes\" | \"nr_blocks\" | \"mpol\"``", "insertionOrder": false, "items": { "type": "string" @@ -716,6 +893,7 @@ "type": "array" }, "Size": { + "description": "The maximum size (in MiB) of the tmpfs volume.", "type": "integer" } }, @@ -726,14 +904,18 @@ }, "Ulimit": { "additionalProperties": false, + "description": "The ``ulimit`` settings to pass to the container.\n Amazon ECS tasks hosted on FARGATElong use the default resource limit values set by the operating system with the exception of the ``nofile`` resource limit parameter which FARGATElong overrides. The ``nofile`` resource limit sets a restriction on the number of open files that a container can use. The default ``nofile`` soft limit is ``1024`` and the default hard limit is ``65535``.\n You can specify the ``ulimit`` settings for a container in a task definition.", "properties": { "HardLimit": { + "description": "The hard limit for the ``ulimit`` type.", "type": "integer" }, "Name": { + "description": "The ``type`` of the ``ulimit``.", "type": "string" }, "SoftLimit": { + "description": "The soft limit for the ``ulimit`` type.", "type": "integer" } }, @@ -746,17 +928,30 @@ }, "Volume": { "additionalProperties": false, + "description": "The data volume configuration for tasks launched using this task definition. Specifying a volume configuration in a task definition is optional. The volume configuration may contain multiple volumes but only one volume configured at launch is supported. Each volume defined in the volume configuration may only specify a ``name`` and one of either ``configuredAtLaunch``, ``dockerVolumeConfiguration``, ``efsVolumeConfiguration``, ``fsxWindowsFileServerVolumeConfiguration``, or ``host``. If an empty volume configuration is specified, by default Amazon ECS uses a host volume. For more information, see [Using data volumes in tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html).", "properties": { + "ConfiguredAtLaunch": { + "description": "Indicates whether the volume should be configured at launch time. This is used to create Amazon EBS volumes for standalone tasks or tasks created as part of a service. Each task definition revision may only have one volume configured at launch in the volume configuration.\n To configure a volume at launch time, use this task definition revision and specify a ``volumeConfigurations`` object when calling the ``CreateService``, ``UpdateService``, ``RunTask`` or ``StartTask`` APIs.", + "type": "boolean" + }, "DockerVolumeConfiguration": { - "$ref": "#/definitions/DockerVolumeConfiguration" + "$ref": "#/definitions/DockerVolumeConfiguration", + "description": "This parameter is specified when you use Docker volumes.\n Windows containers only support the use of the ``local`` driver. To use bind mounts, specify the ``host`` parameter instead.\n Docker volumes aren't supported by tasks run on FARGATElong." }, "EFSVolumeConfiguration": { - "$ref": "#/definitions/EFSVolumeConfiguration" + "$ref": "#/definitions/EFSVolumeConfiguration", + "description": "This parameter is specified when you use an Amazon Elastic File System file system for task storage." + }, + "FSxWindowsFileServerVolumeConfiguration": { + "$ref": "#/definitions/FSxWindowsFileServerVolumeConfiguration", + "description": "This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage." }, "Host": { - "$ref": "#/definitions/HostVolumeProperties" + "$ref": "#/definitions/HostVolumeProperties", + "description": "This parameter is specified when you use bind mount host volumes. The contents of the ``host`` parameter determine whether your bind mount host volume persists on the host container instance and where it's stored. If the ``host`` parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it stop running.\n Windows containers can mount whole directories on the same drive as ``$env:ProgramData``. Windows containers can't mount directories on a different drive, and mount point can't be across drives. For example, you can mount ``C:\\my\\path:C:\\my\\path`` and ``D:\\:D:\\``, but not ``D:\\my\\path:C:\\my\\path`` or ``D:\\:C:\\my\\path``." }, "Name": { + "description": "The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.\n When using a volume configured at launch, the ``name`` is required and must also be specified as the volume name in the ``ServiceVolumeConfiguration`` or ``TaskVolumeConfiguration`` parameter when creating your service or standalone task.\n For all other types of volumes, this name is referenced in the ``sourceVolume`` parameter of the ``mountPoints`` object in the container definition.\n When a volume is using the ``efsVolumeConfiguration``, the name is required.", "type": "string" } }, @@ -764,18 +959,21 @@ }, "VolumeFrom": { "additionalProperties": false, + "description": "Details on a data volume from another container in the same task definition.", "properties": { "ReadOnly": { + "description": "If this value is ``true``, the container has read-only access to the volume. If this value is ``false``, then the container can write to the volume. The default value is ``false``.", "type": "boolean" }, "SourceContainer": { + "description": "The name of another container within the same task definition to mount volumes from.", "type": "string" } }, "type": "object" } }, - "description": "Resource Schema describing various properties for ECS TaskDefinition", + "description": "Registers a new task definition from the supplied ``family`` and ``containerDefinitions``. Optionally, you can add data volumes to your containers with the ``volumes`` parameter. For more information about task definition parameters and defaults, see [Amazon ECS Task Definitions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon Elastic Container Service Developer Guide*.\n You can specify a role for your task with the ``taskRoleArn`` parameter. When you specify a role for a task, its containers can then use the latest versions of the CLI or SDKs to make API requests to the AWS services that are specified in the policy that's associated with the role. For more information, see [IAM Roles for Tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) in the *Amazon Elastic Container Service Developer Guide*.\n You can specify a Docker networking mode for the containers in your task definition with the ``networkMode`` parameter. The available network modes correspond to those described in [Network settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#/network-settings) in the Docker run reference. If you specify the ``awsvpc`` network mode, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration when you create a service or run a task with the task definition. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*.\n In the following example or examples, the Authorization header contents (``AUTHPARAMS``) must be replaced with an AWS Signature Version 4 signature. For more information, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *General Reference*.\n You only need to learn how to sign HTTP requests if you intend to create them manually. When you use the [](https://docs.aws.amazon.com/cli/) or one of the [SDKs](https://docs.aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you, with the access key that you specify when you configure the tools. When you use these tools, you don't have to sign requests yourself.", "handlers": { "create": { "permissions": [ @@ -821,6 +1019,7 @@ ], "properties": { "ContainerDefinitions": { + "description": "A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see [Amazon ECS Task Definitions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon Elastic Container Service Developer Guide*.", "insertionOrder": false, "items": { "$ref": "#/definitions/ContainerDefinition" @@ -829,18 +1028,23 @@ "uniqueItems": true }, "Cpu": { + "description": "The number of ``cpu`` units used by the task. If you use the EC2 launch type, this field is optional. Any value can be used. If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines your range of valid values for the ``memory`` parameter.\n The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.\n + 256 (.25 vCPU) - Available ``memory`` values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)\n + 512 (.5 vCPU) - Available ``memory`` values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)\n + 1024 (1 vCPU) - Available ``memory`` values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)\n + 2048 (2 vCPU) - Available ``memory`` values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)\n + 4096 (4 vCPU) - Available ``memory`` values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)\n + 8192 (8 vCPU) - Available ``memory`` values: 16 GB and 60 GB in 4 GB increments\n This option requires Linux platform ``1.4.0`` or later.\n + 16384 (16vCPU) - Available ``memory`` values: 32GB and 120 GB in 8 GB increments\n This option requires Linux platform ``1.4.0`` or later.", "type": "string" }, "EphemeralStorage": { - "$ref": "#/definitions/EphemeralStorage" + "$ref": "#/definitions/EphemeralStorage", + "description": "The ephemeral storage settings to use for tasks run with the task definition." }, "ExecutionRoleArn": { + "description": "The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make AWS API calls on your behalf. The task execution IAM role is required depending on the requirements of your task. For more information, see [Amazon ECS task execution IAM role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html) in the *Amazon Elastic Container Service Developer Guide*.", "type": "string" }, "Family": { + "description": "The name of a family that this task definition is registered to. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.\n A family groups multiple versions of a task definition. Amazon ECS gives the first task definition that you registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task definition that you add.\n To use revision numbers when you update a task definition, specify this property. If you don't specify a value, CFNlong generates a new task definition each time that you update it.", "type": "string" }, "InferenceAccelerators": { + "description": "The Elastic Inference accelerators to use for the containers in the task.", "insertionOrder": false, "items": { "$ref": "#/definitions/InferenceAccelerator" @@ -849,18 +1053,23 @@ "uniqueItems": true }, "IpcMode": { + "description": "The IPC resource namespace to use for the containers in the task. The valid values are ``host``, ``task``, or ``none``. If ``host`` is specified, then all containers within the tasks that specified the ``host`` IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If ``task`` is specified, all containers within the specified task share the same IPC resources. If ``none`` is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see [IPC settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#ipc-settings---ipc) in the *Docker run reference*.\n If the ``host`` IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see [Docker security](https://docs.aws.amazon.com/https://docs.docker.com/engine/security/security/).\n If you are setting namespaced kernel parameters using ``systemControls`` for the containers in the task, the following will apply to your IPC resource namespace. For more information, see [System Controls](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html) in the *Amazon Elastic Container Service Developer Guide*.\n + For tasks that use the ``host`` IPC mode, IPC namespace related ``systemControls`` are not supported.\n + For tasks that use the ``task`` IPC mode, IPC namespace related ``systemControls`` will apply to all containers within a task.\n \n This parameter is not supported for Windows containers or tasks run on FARGATElong.", "type": "string" }, "Memory": { + "description": "The amount (in MiB) of memory used by the task.\n If your tasks runs on Amazon EC2 instances, you must specify either a task-level memory value or a container-level memory value. This field is optional and any value can be used. If a task-level memory value is specified, the container-level memory value is optional. For more information regarding container-level memory and memory reservation, see [ContainerDefinition](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html).\n If your tasks runs on FARGATElong, this field is required. You must use one of the following values. The value you choose determines your range of valid values for the ``cpu`` parameter.\n + 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available ``cpu`` values: 256 (.25 vCPU)\n + 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available ``cpu`` values: 512 (.5 vCPU)\n + 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available ``cpu`` values: 1024 (1 vCPU)\n + Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available ``cpu`` values: 2048 (2 vCPU)\n + Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available ``cpu`` values: 4096 (4 vCPU)\n + Between 16 GB and 60 GB in 4 GB increments - Available ``cpu`` values: 8192 (8 vCPU)\n This option requires Linux platform ``1.4.0`` or later.\n + Between 32GB and 120 GB in 8 GB increments - Available ``cpu`` values: 16384 (16 vCPU)\n This option requires Linux platform ``1.4.0`` or later.", "type": "string" }, "NetworkMode": { + "description": "The Docker networking mode to use for the containers in the task. The valid values are ``none``, ``bridge``, ``awsvpc``, and ``host``. If no network mode is specified, the default is ``bridge``.\n For Amazon ECS tasks on Fargate, the ``awsvpc`` network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, ``\u003cdefault\u003e`` or ``awsvpc`` can be used. If the network mode is set to ``none``, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The ``host`` and ``awsvpc`` network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the ``bridge`` mode.\n With the ``host`` and ``awsvpc`` network modes, exposed container ports are mapped directly to the corresponding host port (for the ``host`` network mode) or the attached elastic network interface port (for the ``awsvpc`` network mode), so you cannot take advantage of dynamic host port mappings. \n When using the ``host`` network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.\n If the network mode is ``awsvpc``, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*.\n If the network mode is ``host``, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.\n For more information, see [Network settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#network-settings) in the *Docker run reference*.", "type": "string" }, "PidMode": { + "description": "The process namespace to use for the containers in the task. The valid values are ``host`` or ``task``. On Fargate for Linux containers, the only valid value is ``task``. For example, monitoring sidecars might need ``pidMode`` to access information about other containers running in the same task.\n If ``host`` is specified, all containers within the tasks that specified the ``host`` PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance.\n If ``task`` is specified, all containers within the specified task share the same process namespace.\n If no value is specified, the default is a private namespace for each container. For more information, see [PID settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#pid-settings---pid) in the *Docker run reference*.\n If the ``host`` PID mode is used, there's a heightened risk of undesired process namespace exposure. For more information, see [Docker security](https://docs.aws.amazon.com/https://docs.docker.com/engine/security/security/).\n This parameter is not supported for Windows containers.\n This parameter is only supported for tasks that are hosted on FARGATElong if the tasks are using platform version ``1.4.0`` or later (Linux). This isn't supported for Windows containers on Fargate.", "type": "string" }, "PlacementConstraints": { + "description": "An array of placement constraint objects to use for tasks.\n This parameter isn't supported for tasks run on FARGATElong.", "insertionOrder": false, "items": { "$ref": "#/definitions/TaskDefinitionPlacementConstraint" @@ -869,9 +1078,11 @@ "uniqueItems": true }, "ProxyConfiguration": { - "$ref": "#/definitions/ProxyConfiguration" + "$ref": "#/definitions/ProxyConfiguration", + "description": "The configuration details for the App Mesh proxy.\n Your Amazon ECS container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ``ecs-init`` package to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version ``20190301`` or later, they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*." }, "RequiresCompatibilities": { + "description": "The task launch types the task definition was validated against. The valid values are ``EC2``, ``FARGATE``, and ``EXTERNAL``. For more information, see [Amazon ECS launch types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer Guide*.", "insertionOrder": false, "items": { "type": "string" @@ -880,9 +1091,11 @@ "uniqueItems": true }, "RuntimePlatform": { - "$ref": "#/definitions/RuntimePlatform" + "$ref": "#/definitions/RuntimePlatform", + "description": "The operating system that your tasks definitions run on. A platform family is specified only for tasks using the Fargate launch type." }, "Tags": { + "description": "The metadata that you apply to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value. You define both of them.\n The following basic restrictions apply to tags:\n + Maximum number of tags per resource - 50\n + For each resource, each tag key must be unique, and each tag key can have only one value.\n + Maximum key length - 128 Unicode characters in UTF-8\n + Maximum value length - 256 Unicode characters in UTF-8\n + If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.\n + Tag keys and values are case-sensitive.\n + Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.", "insertionOrder": false, "items": { "$ref": "#/definitions/Tag" @@ -890,13 +1103,15 @@ "type": "array" }, "TaskDefinitionArn": { - "description": "The Amazon Resource Name (ARN) of the Amazon ECS task definition", + "description": "", "type": "string" }, "TaskRoleArn": { + "description": "The short name or full Amazon Resource Name (ARN) of the IAMlong role that grants containers in the task permission to call AWS APIs on your behalf. For more information, see [Amazon ECS Task Role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) in the *Amazon Elastic Container Service Developer Guide*.\n IAM roles for tasks on Windows require that the ``-EnableTaskIAMRole`` option is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code to use the feature. For more information, see [Windows IAM roles for tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows_task_IAM_roles.html) in the *Amazon Elastic Container Service Developer Guide*.", "type": "string" }, "Volumes": { + "description": "The list of data volume definitions for the task. For more information, see [Using data volumes in tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html) in the *Amazon Elastic Container Service Developer Guide*.\n The ``host`` and ``sourcePath`` parameters aren't supported for tasks run on FARGATElong.", "insertionOrder": false, "items": { "$ref": "#/definitions/Volume" diff --git a/artifacts/types/AWS::ECS::TaskSet.json b/artifacts/types/AWS::ECS::TaskSet.json index 71409d94..5b3d796f 100644 --- a/artifacts/types/AWS::ECS::TaskSet.json +++ b/artifacts/types/AWS::ECS::TaskSet.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ECS-TaskSet", "type": "AWS::ECS::TaskSet", - "time": "2023-12-20T17:09:11.896Z", + "time": "2024-06-10T16:14:04.103Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -119,6 +119,18 @@ } }, "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "type": "object" } }, "description": "Create a task set in the specified cluster and service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.htmlin the Amazon Elastic Container Service Developer Guide.", @@ -126,7 +138,8 @@ "create": { "permissions": [ "ecs:CreateTaskSet", - "ecs:DescribeTaskSets" + "ecs:DescribeTaskSets", + "ecs:TagResource" ] }, "delete": { @@ -142,8 +155,10 @@ }, "update": { "permissions": [ - "ecs:UpdateTaskSet", - "ecs:DescribeTaskSets" + "ecs:DescribeTaskSets", + "ecs:TagResource", + "ecs:UntagResource", + "ecs:UpdateTaskSet" ] } }, @@ -201,6 +216,12 @@ }, "type": "array" }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + }, "TaskDefinition": { "description": "The short name or full Amazon Resource Name (ARN) of the task definition for the tasks in the task set to use.", "type": "string" @@ -217,9 +238,9 @@ "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ecs.git", "tagging": { "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false + "tagOnCreate": true, + "tagUpdatable": true, + "taggable": true }, "typeName": "AWS::ECS::TaskSet" } diff --git a/artifacts/types/AWS::EFS::AccessPoint.json b/artifacts/types/AWS::EFS::AccessPoint.json index fb555a46..6c3d196d 100644 --- a/artifacts/types/AWS::EFS::AccessPoint.json +++ b/artifacts/types/AWS::EFS::AccessPoint.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EFS-AccessPoint", "type": "AWS::EFS::AccessPoint", - "time": "2023-12-02T03:07:46.258Z", + "time": "2024-05-10T12:56:44.203Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -22,13 +22,16 @@ "definitions": { "AccessPointTag": { "additionalProperties": false, + "description": "A tag is a key-value pair attached to a file system. Allowed characters in the ``Key`` and ``Value`` properties are letters, white space, and numbers that can be represented in UTF-8, and the following characters:``+ - = . _ : /``", "properties": { "Key": { + "description": "The tag key (String). The key can't start with ``aws:``.", "maxLength": 128, "minLength": 1, "type": "string" }, "Value": { + "description": "The value of the tag key.", "maxLength": 256, "minLength": 1, "type": "string" @@ -38,17 +41,18 @@ }, "CreationInfo": { "additionalProperties": false, + "description": "Required if the ``RootDirectory`` \u003e ``Path`` specified does not exist. Specifies the POSIX IDs and permissions to apply to the access point's ``RootDirectory`` \u003e ``Path``. If the access point root directory does not exist, EFS creates it with these settings when a client connects to the access point. When specifying ``CreationInfo``, you must include values for all properties. \n Amazon EFS creates a root directory only if you have provided the CreationInfo: OwnUid, OwnGID, and permissions for the directory. If you do not provide this information, Amazon EFS does not create the root directory. If the root directory does not exist, attempts to mount using the access point will fail.\n If you do not provide ``CreationInfo`` and the specified ``RootDirectory`` does not exist, attempts to mount the file system using the access point will fail.", "properties": { "OwnerGid": { - "description": "Specifies the POSIX group ID to apply to the RootDirectory. Accepts values from 0 to 2^32 (4294967295).", + "description": "Specifies the POSIX group ID to apply to the ``RootDirectory``. Accepts values from 0 to 2^32 (4294967295).", "type": "string" }, "OwnerUid": { - "description": "Specifies the POSIX user ID to apply to the RootDirectory. Accepts values from 0 to 2^32 (4294967295).", + "description": "Specifies the POSIX user ID to apply to the ``RootDirectory``. Accepts values from 0 to 2^32 (4294967295).", "type": "string" }, "Permissions": { - "description": "Specifies the POSIX permissions to apply to the RootDirectory, in the format of an octal number representing the file's mode bits.", + "description": "Specifies the POSIX permissions to apply to the ``RootDirectory``, in the format of an octal number representing the file's mode bits.", "pattern": "^[0-7]{3,4}$", "type": "string" } @@ -62,6 +66,7 @@ }, "PosixUser": { "additionalProperties": false, + "description": "The 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 NFS clients using the access point.", "properties": { "Gid": { "description": "The POSIX group ID used for all file system operations using this access point.", @@ -87,13 +92,14 @@ }, "RootDirectory": { "additionalProperties": false, + "description": "Specifies the directory on the Amazon EFS file system that the access point provides access to. The access point exposes the specified file system path as the root directory of your file system to applications using the access point. NFS clients using the access point can only access data in the access point's ``RootDirectory`` and its subdirectories.", "properties": { "CreationInfo": { "$ref": "#/definitions/CreationInfo", - "description": "(Optional) Specifies the POSIX IDs and permissions to apply to the access point's RootDirectory. If the RootDirectory\u003ePath specified does not exist, EFS creates the root directory using the CreationInfo settings when a client connects to an access point. When specifying the CreationInfo, you must provide values for all properties. If you do not provide CreationInfo and the specified RootDirectory\u003ePath does not exist, attempts to mount the file system using the access point will fail. " + "description": "(Optional) Specifies the POSIX IDs and permissions to apply to the access point's ``RootDirectory``. If the ``RootDirectory`` \u003e ``Path`` specified does not exist, EFS creates the root directory using the ``CreationInfo`` settings when a client connects to an access point. When specifying the ``CreationInfo``, you must provide values for all properties. \n If you do not provide ``CreationInfo`` and the specified ``RootDirectory`` \u003e ``Path`` does not exist, attempts to mount the file system using the access point will fail." }, "Path": { - "description": "Specifies the path on the EFS file system to expose as the root directory to NFS clients using the access point to access the EFS file system. A path can have up to four subdirectories. If the specified path does not exist, you are required to provide the CreationInfo.", + "description": "Specifies the path on the EFS file system to expose as the root directory to NFS clients using the access point to access the EFS file system. A path can have up to four subdirectories. If the specified path does not exist, you are required to provide the ``CreationInfo``.", "maxLength": 100, "minLength": 1, "type": "string" @@ -102,7 +108,7 @@ "type": "object" } }, - "description": "Resource Type definition for AWS::EFS::AccessPoint", + "description": "The ``AWS::EFS::AccessPoint`` resource creates an EFS access point. An access point is an application-specific view into an EFS file system that applies an operating system user and group, and a file system path, to any file system request made through the access point. The operating system user and group override any identity information provided by the NFS client. The file system path is exposed as the access point's root directory. Applications using the access point can only access data in its own directory and below. To learn more, see [Mounting a file system using EFS access points](https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html).\n This operation requires permissions for the ``elasticfilesystem:CreateAccessPoint`` action.", "handlers": { "create": { "permissions": [ @@ -141,9 +147,11 @@ ], "properties": { "AccessPointId": { + "description": "", "type": "string" }, "AccessPointTags": { + "description": "An array of key-value pairs to apply to this resource.\n For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).", "insertionOrder": false, "items": { "$ref": "#/definitions/AccessPointTag" @@ -152,23 +160,24 @@ "uniqueItems": true }, "Arn": { + "description": "", "type": "string" }, "ClientToken": { - "description": "(optional) A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation.", + "description": "The opaque string specified in the request to ensure idempotent creation.", "type": "string" }, "FileSystemId": { - "description": "The ID of the EFS file system that the access point provides access to.", + "description": "The ID of the EFS file system that the access point applies to. Accepts only the ID format for input when specifying a file system, for example ``fs-0123456789abcedf2``.", "type": "string" }, "PosixUser": { "$ref": "#/definitions/PosixUser", - "description": "The operating system user and group applied to all file system requests made using the access point." + "description": "The full POSIX identity, including the user ID, group ID, and secondary group IDs on the access point that is used for all file operations by NFS clients using the access point." }, "RootDirectory": { "$ref": "#/definitions/RootDirectory", - "description": "Specifies the directory on the Amazon EFS file system that the access point exposes as the root directory of your file system to NFS clients using the access point. The clients using the access point can only access the root directory and below. If the RootDirectory\u003ePath specified does not exist, EFS creates it and applies the CreationInfo settings when a client connects to an access point. When specifying a RootDirectory, you need to provide the Path, and the CreationInfo is optional." + "description": "The directory on the EFS file system that the access point exposes as the root directory to NFS clients using the access point." } }, "readOnlyProperties": [ diff --git a/artifacts/types/AWS::EFS::FileSystem.json b/artifacts/types/AWS::EFS::FileSystem.json index a302c7ce..27e5f16c 100644 --- a/artifacts/types/AWS::EFS::FileSystem.json +++ b/artifacts/types/AWS::EFS::FileSystem.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EFS-FileSystem", "type": "AWS::EFS::FileSystem", - "time": "2023-11-28T15:50:20.84Z", + "time": "2024-06-20T13:02:43.663Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -16,8 +16,14 @@ }, "BackupPolicy": { "additionalProperties": false, + "description": "The backup policy turns automatic backups for the file system on or off.", "properties": { "Status": { + "description": "Set the backup policy status for the file system.\n + *ENABLED* - Turns automatic backups on for the file system. \n + *DISABLED* - Turns automatic backups off for the file system.", + "enum": [ + "DISABLED", + "ENABLED" + ], "type": "string" } }, @@ -28,11 +34,14 @@ }, "ElasticFileSystemTag": { "additionalProperties": false, + "description": "A tag is a key-value pair attached to a file system. Allowed characters in the ``Key`` and ``Value`` properties are letters, white space, and numbers that can be represented in UTF-8, and the following characters:``+ - = . _ : /``", "properties": { "Key": { + "description": "The tag key (String). The key can't start with ``aws:``.", "type": "string" }, "Value": { + "description": "The value of the tag key.", "type": "string" } }, @@ -44,8 +53,10 @@ }, "FileSystemProtection": { "additionalProperties": false, + "description": "Describes the protection on the file system.", "properties": { "ReplicationOverwriteProtection": { + "description": "The status of the file system's replication overwrite protection.\n + ``ENABLED`` ? The file system cannot be used as the destination file system in a replication configuration. The file system is writeable. Replication overwrite protection is ``ENABLED`` by default. \n + ``DISABLED`` ? The file system can be used as the destination file system in a replication configuration. The file system is read-only and can only be modified by EFS replication.\n + ``REPLICATING`` ? The file system is being used as the destination file system in a replication configuration. The file system is read-only and is only modified only by EFS replication.\n \n If the replication configuration is deleted, the file system's replication overwrite protection is re-enabled, the file system becomes writeable.", "enum": [ "DISABLED", "ENABLED" @@ -57,14 +68,18 @@ }, "LifecyclePolicy": { "additionalProperties": false, + "description": "Describes a policy used by Lifecycle management that specifies when to transition files into and out of the EFS storage classes. For more information, see [Managing file system storage](https://docs.aws.amazon.com/efs/latest/ug/lifecycle-management-efs.html).\n + Each ``LifecyclePolicy`` object can have only a single transition. This means that in a request body, ``LifecyclePolicies`` must be structured as an array of ``LifecyclePolicy`` objects, one object for each transition, ``TransitionToIA``, ``TransitionToArchive``, ``TransitionToPrimaryStorageClass``.\n + See the AWS::EFS::FileSystem examples for the correct ``LifecyclePolicy`` structure. Do not use the syntax shown on this page.", "properties": { "TransitionToArchive": { + "description": "The number of days after files were last accessed in primary storage (the Standard storage class) at which to move them to Archive storage. Metadata operations such as listing the contents of a directory don't count as file access events.", "type": "string" }, "TransitionToIA": { + "description": "The number of days after files were last accessed in primary storage (the Standard storage class) at which to move them to Infrequent Access (IA) storage. Metadata operations such as listing the contents of a directory don't count as file access events.", "type": "string" }, "TransitionToPrimaryStorageClass": { + "description": "Whether to move files back to primary (Standard) storage after they are accessed in IA or Archive storage. Metadata operations such as listing the contents of a directory don't count as file access events.", "type": "string" } }, @@ -72,8 +87,10 @@ }, "ReplicationConfiguration": { "additionalProperties": false, + "description": "Describes the replication configuration for a specific file system.", "properties": { "Destinations": { + "description": "An array of destination objects. Only one destination object is supported.", "items": { "$ref": "#/definitions/ReplicationDestination" }, @@ -87,24 +104,29 @@ }, "ReplicationDestination": { "additionalProperties": false, + "description": "Describes the destination file system in the replication configuration.", "properties": { "AvailabilityZoneName": { + "description": "The AWS For One Zone file systems, the replication configuration must specify the Availability Zone in which the destination file system is located. \n Use the format ``us-east-1a`` to specify the Availability Zone. For more 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 One Zone file system type is not available in all Availability Zones in AWS-Regions where Amazon EFS is available.", "type": "string" }, "FileSystemId": { + "description": "The ID of the destination Amazon EFS file system.", "type": "string" }, "KmsKeyId": { + "description": "The ID of an kms-key-long used to protect the encrypted file system.", "type": "string" }, "Region": { + "description": "The AWS-Region in which the destination file system is located.\n For One Zone file systems, the replication configuration must specify the AWS-Region in which the destination file system is located.", "type": "string" } }, "type": "object" } }, - "description": "Resource Type definition for AWS::EFS::FileSystem", + "description": "The ``AWS::EFS::FileSystem`` resource creates a new, empty file system in EFSlong (EFS). You must create a mount target ([AWS::EFS::MountTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html)) to mount your EFS file system on an EC2 or other AWS cloud compute resource.", "handlers": { "create": { "permissions": [ @@ -178,31 +200,39 @@ ], "properties": { "Arn": { - "$ref": "#/definitions/Arn" + "$ref": "#/definitions/Arn", + "description": "" }, "AvailabilityZoneName": { + "description": "For One Zone file systems, specify the AWS Availability Zone in which to create the file system. Use the format ``us-east-1a`` to specify the Availability Zone. For more information about One Zone file systems, see [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 One Zone file systems are not available in all Availability Zones in AWS-Regions where Amazon EFS is available.", "type": "string" }, "BackupPolicy": { - "$ref": "#/definitions/BackupPolicy" + "$ref": "#/definitions/BackupPolicy", + "description": "Use the ``BackupPolicy`` to turn automatic backups on or off for the file system." }, "BypassPolicyLockoutSafetyCheck": { - "description": "Whether to bypass the FileSystemPolicy lockout safety check. The policy lockout safety check determines whether the policy in the request will prevent the principal making the request to be locked out from making future PutFileSystemPolicy requests on the file system. Set BypassPolicyLockoutSafetyCheck to True only when you intend to prevent the principal that is making the request from making a subsequent PutFileSystemPolicy request on the file system. Defaults to false", + "description": "(Optional) A boolean that specifies whether or not to bypass the ``FileSystemPolicy`` lockout safety check. The lockout safety check determines whether the policy in the request will lock out, or prevent, the IAM principal that is making the request from making future ``PutFileSystemPolicy`` requests on this file system. Set ``BypassPolicyLockoutSafetyCheck`` to ``True`` only when you intend to prevent the IAM principal that is making the request from making subsequent ``PutFileSystemPolicy`` requests on this file system. The default value is ``False``.", "type": "boolean" }, "Encrypted": { + "description": "A Boolean value that, if true, creates an encrypted file system. When creating an encrypted file system, you have the option of specifying a KmsKeyId for an existing kms-key-long. If you don't specify a kms-key, then the default kms-key for EFS, ``/aws/elasticfilesystem``, is used to protect the encrypted file system.", "type": "boolean" }, "FileSystemId": { + "description": "", "type": "string" }, "FileSystemPolicy": { + "description": "The ``FileSystemPolicy`` for the EFS file system. A file system policy is an IAM resource policy used to control NFS access to an EFS file system. For more information, see [Using to control NFS access to Amazon EFS](https://docs.aws.amazon.com/efs/latest/ug/iam-access-control-nfs-efs.html) in the *Amazon EFS User Guide*.", "type": "object" }, "FileSystemProtection": { - "$ref": "#/definitions/FileSystemProtection" + "$ref": "#/definitions/FileSystemProtection", + "description": "Describes the protection on the file system." }, "FileSystemTags": { + "description": "Use to create one or more tags associated with the file system. Each tag is a user-defined key-value pair. Name your file system on creation by including a ``\"Key\":\"Name\",\"Value\":\"{value}\"`` key-value pair. Each key must be unique. For more information, see [Tagging resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the *General Reference Guide*.", "items": { "$ref": "#/definitions/ElasticFileSystemTag" }, @@ -210,9 +240,11 @@ "uniqueItems": true }, "KmsKeyId": { + "description": "The ID of the kms-key-long to be used to protect the encrypted file system. This parameter is only required if you want to use a nondefault kms-key. If this parameter is not specified, the default kms-key for EFS is used. This ID can be in one of the following formats:\n + Key ID - A unique identifier of the key, for example ``1234abcd-12ab-34cd-56ef-1234567890ab``.\n + ARN - An Amazon Resource Name (ARN) for the key, for example ``arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab``.\n + Key alias - A previously created display name for a key, for example ``alias/projectKey1``.\n + Key alias ARN - An ARN for a key alias, for example ``arn:aws:kms:us-west-2:444455556666:alias/projectKey1``.\n \n If ``KmsKeyId`` is specified, the ``Encrypted`` parameter must be set to true.", "type": "string" }, "LifecyclePolicies": { + "description": "An array of ``LifecyclePolicy`` objects that define the file system's ``LifecycleConfiguration`` object. A ``LifecycleConfiguration`` object informs 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 to Archive storage.\n + When to move files that are in IA or Archive storage to primary storage.\n \n EFS requires that each ``LifecyclePolicy`` object have only a single transition. This means that in a request body, ``LifecyclePolicies`` needs to be structured as an array of ``LifecyclePolicy`` objects, one object for each transition, ``TransitionToIA``, ``TransitionToArchive`` ``TransitionToPrimaryStorageClass``. See the example requests in the following section for more information.", "items": { "$ref": "#/definitions/LifecyclePolicy" }, @@ -220,15 +252,19 @@ "uniqueItems": true }, "PerformanceMode": { + "description": "The Performance mode of the file system. We recommend ``generalPurpose`` performance mode for all file systems. File systems using the ``maxIO`` performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The performance mode can't be changed after the file system has been created. The ``maxIO`` mode is not supported on One Zone file systems.\n Due to the higher per-operation latencies with Max I/O, we recommend using General Purpose performance mode for all file systems.\n Default is ``generalPurpose``.", "type": "string" }, "ProvisionedThroughputInMibps": { + "description": "The throughput, measured in mebibytes per second (MiBps), that you want to provision for a file system that you're creating. Required if ``ThroughputMode`` is set to ``provisioned``. Valid values are 1-3414 MiBps, with the upper limit depending on Region. To increase this limit, contact SUP. For more information, see [Amazon EFS quotas that you can increase](https://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits) in the *Amazon EFS User Guide*.", "type": "number" }, "ReplicationConfiguration": { - "$ref": "#/definitions/ReplicationConfiguration" + "$ref": "#/definitions/ReplicationConfiguration", + "description": "Describes the replication configuration for a specific file system." }, "ThroughputMode": { + "description": "Specifies the throughput mode for the file system. The mode can be ``bursting``, ``provisioned``, or ``elastic``. If you set ``ThroughputMode`` to ``provisioned``, you must also set a value for ``ProvisionedThroughputInMibps``. After you create the file system, you can decrease your file system's Provisioned throughput or change between the throughput modes, with certain time restrictions. For more information, see [Specifying throughput with provisioned mode](https://docs.aws.amazon.com/efs/latest/ug/performance.html#provisioned-throughput) in the *Amazon EFS User Guide*. \n Default is ``bursting``.", "type": "string" } }, diff --git a/artifacts/types/AWS::EFS::MountTarget.json b/artifacts/types/AWS::EFS::MountTarget.json index ec7bd0e6..abaf2bf0 100644 --- a/artifacts/types/AWS::EFS::MountTarget.json +++ b/artifacts/types/AWS::EFS::MountTarget.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EFS-MountTarget", "type": "AWS::EFS::MountTarget", - "time": "2023-12-02T02:55:31.169Z", + "time": "2024-05-09T13:09:58.559Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -9,7 +9,7 @@ "/properties/SubnetId", "/properties/FileSystemId" ], - "description": "Resource Type definition for AWS::EFS::MountTarget", + "description": "The ``AWS::EFS::MountTarget`` resource is an Amazon EFS resource that creates a mount target for an EFS file system. You can then mount the file system on Amazon EC2 instances or other resources by using the mount target.", "handlers": { "create": { "permissions": [ @@ -58,15 +58,19 @@ ], "properties": { "FileSystemId": { + "description": "The ID of the file system for which to create the mount target.", "type": "string" }, "Id": { + "description": "", "type": "string" }, "IpAddress": { + "description": "Valid IPv4 address within the address range of the specified subnet.", "type": "string" }, "SecurityGroups": { + "description": "Up to five VPC security group IDs, of the form ``sg-xxxxxxxx``. These must be for the same VPC as subnet specified.", "insertionOrder": false, "items": { "type": "string" @@ -75,6 +79,7 @@ "uniqueItems": true }, "SubnetId": { + "description": "The ID of the subnet to add the mount target in. For One Zone file systems, use the subnet that is associated with the file system's Availability Zone.", "type": "string" } }, diff --git a/artifacts/types/AWS::EKS::AccessEntry.json b/artifacts/types/AWS::EKS::AccessEntry.json index 6b586297..f72892f6 100644 --- a/artifacts/types/AWS::EKS::AccessEntry.json +++ b/artifacts/types/AWS::EKS::AccessEntry.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EKS-AccessEntry", "type": "AWS::EKS::AccessEntry", - "time": "2024-01-04T16:37:00.754Z", + "time": "2024-06-24T15:53:09.537Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -150,6 +150,7 @@ }, "ClusterName": { "description": "The cluster that the access entry is created for.", + "minLength": 1, "type": "string" }, "KubernetesGroups": { @@ -163,6 +164,7 @@ }, "PrincipalArn": { "description": "The principal ARN that the access entry is created for.", + "minLength": 1, "type": "string" }, "Tags": { diff --git a/artifacts/types/AWS::EKS::Addon.json b/artifacts/types/AWS::EKS::Addon.json index 58fd1651..44168829 100644 --- a/artifacts/types/AWS::EKS::Addon.json +++ b/artifacts/types/AWS::EKS::Addon.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EKS-Addon", "type": "AWS::EKS::Addon", - "time": "2024-01-04T17:14:08.991Z", + "time": "2024-06-20T16:33:34.501Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -9,6 +9,26 @@ "/properties/AddonName" ], "definitions": { + "PodIdentityAssociation": { + "additionalProperties": false, + "description": "A pod identity to associate with an add-on.", + "properties": { + "RoleArn": { + "description": "The IAM role ARN that the pod identity association is created for.", + "pattern": "^arn:aws(-cn|-us-gov|-iso(-[a-z])?)?:iam::\\d{12}:(role)\\/*", + "type": "string" + }, + "ServiceAccount": { + "description": "The Kubernetes service account that the pod identity association is created for.", + "type": "string" + } + }, + "required": [ + "ServiceAccount", + "RoleArn" + ], + "type": "object" + }, "Tag": { "additionalProperties": false, "description": "A key-value pair to associate with a resource.", @@ -40,16 +60,29 @@ "eks:CreateAddon", "eks:DescribeAddon", "eks:TagResource", - "iam:PassRole" + "iam:PassRole", + "iam:GetRole", + "eks:CreatePodIdentityAssociation" ] }, "delete": { "permissions": [ "eks:DeleteAddon", - "eks:DescribeAddon" + "eks:DescribeAddon", + "eks:DeletePodIdentityAssociation" ] }, "list": { + "handlerSchema": { + "properties": { + "ClusterName": { + "$ref": "resource-schema.json#/properties/ClusterName" + } + }, + "required": [ + "ClusterName" + ] + }, "permissions": [ "eks:ListAddons" ] @@ -62,12 +95,15 @@ "update": { "permissions": [ "iam:PassRole", + "iam:GetRole", "eks:UpdateAddon", "eks:DescribeAddon", "eks:DescribeUpdate", "eks:ListTagsForResource", "eks:TagResource", - "eks:UntagResource" + "eks:UntagResource", + "eks:CreatePodIdentityAssociation", + "eks:DeletePodIdentityAssociation" ] } }, @@ -100,6 +136,15 @@ "minLength": 1, "type": "string" }, + "PodIdentityAssociations": { + "description": "An array of pod identities to apply to this add-on.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/PodIdentityAssociation" + }, + "type": "array", + "uniqueItems": true + }, "PreserveOnDelete": { "description": "PreserveOnDelete parameter value", "type": "boolean" @@ -147,7 +192,8 @@ "typeName": "AWS::EKS::Addon", "writeOnlyProperties": [ "/properties/ResolveConflicts", - "/properties/PreserveOnDelete" + "/properties/PreserveOnDelete", + "/properties/PodIdentityAssociations" ] } } \ No newline at end of file diff --git a/artifacts/types/AWS::EKS::Cluster.json b/artifacts/types/AWS::EKS::Cluster.json index 85ef3b65..764dd0df 100644 --- a/artifacts/types/AWS::EKS::Cluster.json +++ b/artifacts/types/AWS::EKS::Cluster.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EKS-Cluster", "type": "AWS::EKS::Cluster", - "time": "2023-12-16T08:51:00.432Z", + "time": "2024-06-19T19:46:41.798Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -10,7 +10,8 @@ "/properties/KubernetesNetworkConfig", "/properties/AccessConfig/BootstrapClusterCreatorAdminPermissions", "/properties/Name", - "/properties/RoleArn" + "/properties/RoleArn", + "/properties/BootstrapSelfManagedAddons" ], "definitions": { "AccessConfig": { @@ -303,6 +304,10 @@ "description": "The ARN of the cluster, such as arn:aws:eks:us-west-2:666666666666:cluster/prod.", "type": "string" }, + "BootstrapSelfManagedAddons": { + "description": "Set this value to false to avoid creating the default networking addons when the cluster is created.", + "type": "boolean" + }, "CertificateAuthorityData": { "description": "The certificate-authority-data for your cluster.", "type": "string" @@ -397,7 +402,8 @@ }, "typeName": "AWS::EKS::Cluster", "writeOnlyProperties": [ - "/properties/AccessConfig/BootstrapClusterCreatorAdminPermissions" + "/properties/AccessConfig/BootstrapClusterCreatorAdminPermissions", + "/properties/BootstrapSelfManagedAddons" ] } } \ No newline at end of file diff --git a/artifacts/types/AWS::EKS::FargateProfile.json b/artifacts/types/AWS::EKS::FargateProfile.json index cc423ef8..1327a4a4 100644 --- a/artifacts/types/AWS::EKS::FargateProfile.json +++ b/artifacts/types/AWS::EKS::FargateProfile.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EKS-FargateProfile", "type": "AWS::EKS::FargateProfile", - "time": "2024-01-03T16:53:51.295Z", + "time": "2024-06-20T16:11:20.969Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::EKS::IdentityProviderConfig.json b/artifacts/types/AWS::EKS::IdentityProviderConfig.json index 980c0ae5..d8ff61c2 100644 --- a/artifacts/types/AWS::EKS::IdentityProviderConfig.json +++ b/artifacts/types/AWS::EKS::IdentityProviderConfig.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EKS-IdentityProviderConfig", "type": "AWS::EKS::IdentityProviderConfig", - "time": "2024-01-04T20:21:10.464Z", + "time": "2024-06-19T19:02:07.59Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::EKS::Nodegroup.json b/artifacts/types/AWS::EKS::Nodegroup.json index af99b4c9..20c9da50 100644 --- a/artifacts/types/AWS::EKS::Nodegroup.json +++ b/artifacts/types/AWS::EKS::Nodegroup.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EKS-Nodegroup", "type": "AWS::EKS::Nodegroup", - "time": "2024-01-04T20:57:40.083Z", + "time": "2024-06-19T18:07:00.969Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -143,6 +143,16 @@ ] }, "list": { + "handlerSchema": { + "properties": { + "ClusterName": { + "$ref": "resource-schema.json#/properties/ClusterName" + } + }, + "required": [ + "ClusterName" + ] + }, "permissions": [ "eks:ListNodegroups" ] diff --git a/artifacts/types/AWS::EKS::PodIdentityAssociation.json b/artifacts/types/AWS::EKS::PodIdentityAssociation.json index 7d755cd0..a89add6a 100644 --- a/artifacts/types/AWS::EKS::PodIdentityAssociation.json +++ b/artifacts/types/AWS::EKS::PodIdentityAssociation.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EKS-PodIdentityAssociation", "type": "AWS::EKS::PodIdentityAssociation", - "time": "2024-01-03T16:44:05.665Z", + "time": "2024-06-24T16:33:48.018Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -92,10 +92,12 @@ }, "AssociationId": { "description": "The ID of the pod identity association.", + "minLength": 1, "type": "string" }, "ClusterName": { "description": "The cluster that the pod identity association is created for.", + "minLength": 1, "type": "string" }, "Namespace": { diff --git a/artifacts/types/AWS::EMR::Studio.json b/artifacts/types/AWS::EMR::Studio.json index 48856a32..bfd41383 100644 --- a/artifacts/types/AWS::EMR::Studio.json +++ b/artifacts/types/AWS::EMR::Studio.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EMR-Studio", "type": "AWS::EMR::Studio", - "time": "2023-12-06T16:36:31.049Z", + "time": "2024-06-11T15:28:33.404Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::EMR::StudioSessionMapping.json b/artifacts/types/AWS::EMR::StudioSessionMapping.json index 45529478..e432f66d 100644 --- a/artifacts/types/AWS::EMR::StudioSessionMapping.json +++ b/artifacts/types/AWS::EMR::StudioSessionMapping.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EMR-StudioSessionMapping", "type": "AWS::EMR::StudioSessionMapping", - "time": "2023-12-06T16:28:18.525Z", + "time": "2024-06-11T15:24:42.772Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -25,6 +25,7 @@ "sso-directory:SearchGroups", "sso-directory:DescribeUser", "sso-directory:DescribeGroup", + "sso:GetManagedApplicationInstance", "sso:ListDirectoryAssociations", "sso:GetProfile", "sso:ListProfiles", diff --git a/artifacts/types/AWS::EMR::WALWorkspace.json b/artifacts/types/AWS::EMR::WALWorkspace.json index a6931d92..55c34922 100644 --- a/artifacts/types/AWS::EMR::WALWorkspace.json +++ b/artifacts/types/AWS::EMR::WALWorkspace.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EMR-WALWorkspace", "type": "AWS::EMR::WALWorkspace", - "time": "2023-12-12T05:15:05.79Z", + "time": "2024-06-17T19:39:46.176Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::EMRContainers::VirtualCluster.json b/artifacts/types/AWS::EMRContainers::VirtualCluster.json index 50e8548f..2eb7a0cc 100644 --- a/artifacts/types/AWS::EMRContainers::VirtualCluster.json +++ b/artifacts/types/AWS::EMRContainers::VirtualCluster.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EMRContainers-VirtualCluster", "type": "AWS::EMRContainers::VirtualCluster", - "time": "2023-03-22T15:07:32.806Z", + "time": "2024-04-04T23:19:09.65Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::EMRServerless::Application.json b/artifacts/types/AWS::EMRServerless::Application.json index ea849e16..fe1f1001 100644 --- a/artifacts/types/AWS::EMRServerless::Application.json +++ b/artifacts/types/AWS::EMRServerless::Application.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EMRServerless-Application", "type": "AWS::EMRServerless::Application", - "time": "2024-01-02T17:38:13.939Z", + "time": "2024-06-19T15:33:37.472Z", "schema": { "additionalProperties": false, "conditionalCreateOnlyProperties": [ @@ -151,6 +151,11 @@ "pattern": "^[1-9][0-9]*(\\s)?(GB|gb|gB|Gb)$", "type": "string" }, + "DiskType": { + "description": "Per worker DiskType resource. Shuffle optimized and Standard are only supported types and specifying diskType is optional", + "pattern": "^(SHUFFLE_OPTIMIZED|[Ss]huffle_[Oo]ptimized|STANDARD|[Ss]tandard)$", + "type": "string" + }, "EncryptionKeyArn": { "maxLength": 2048, "minLength": 20, @@ -435,6 +440,10 @@ "$ref": "#/definitions/DiskSize", "description": "Per worker Disk resource. GB is the only supported unit and specifying GB is optional" }, + "DiskType": { + "$ref": "#/definitions/DiskType", + "description": "Per worker DiskType resource. Shuffle optimized and Standard are only supported types and specifying diskType is optional" + }, "Memory": { "$ref": "#/definitions/MemorySize", "description": "Per worker memory resource. GB is the only supported unit and specifying GB is optional." @@ -476,16 +485,24 @@ "handlers": { "create": { "permissions": [ - "kms:Create*", - "kms:Describe*", - "kms:Enable*", - "kms:List*", - "kms:Put*", - "kms:Update*", - "kms:Revoke*", - "kms:Disable*", - "kms:Get*", - "kms:Delete*", + "kms:CreateKey", + "kms:CreateAlias", + "kms:DescribeKey", + "kms:EnableKey", + "kms:ListGrants", + "kms:ListAliases", + "kms:ListKeyPolicies", + "kms:ListKeys", + "kms:PutKeyPolicy", + "kms:UpdateKeyDescription", + "kms:UpdateAlias", + "kms:UpdatePrimaryRegion", + "kms:RevokeGrant", + "kms:DisableKey", + "kms:DisableKeyRotation", + "kms:GetKeyPolicy", + "kms:GetKeyRotationStatus", + "kms:DeleteAlias", "kms:ScheduleKeyDeletion", "kms:CancelKeyDeletion", "kms:GenerateDataKey", @@ -528,16 +545,24 @@ "ecr:BatchGetImage", "ecr:DescribeImages", "ecr:GetDownloadUrlForLayer", - "kms:Create*", - "kms:Describe*", - "kms:Enable*", - "kms:List*", - "kms:Put*", - "kms:Update*", - "kms:Revoke*", - "kms:Disable*", - "kms:Get*", - "kms:Delete*", + "kms:CreateKey", + "kms:CreateAlias", + "kms:DescribeKey", + "kms:EnableKey", + "kms:ListGrants", + "kms:ListAliases", + "kms:ListKeyPolicies", + "kms:ListKeys", + "kms:PutKeyPolicy", + "kms:UpdateKeyDescription", + "kms:UpdateAlias", + "kms:UpdatePrimaryRegion", + "kms:RevokeGrant", + "kms:DisableKey", + "kms:DisableKeyRotation", + "kms:GetKeyPolicy", + "kms:GetKeyRotationStatus", + "kms:DeleteAlias", "kms:ScheduleKeyDeletion", "kms:CancelKeyDeletion", "kms:GenerateDataKey", @@ -562,6 +587,7 @@ }, "Arn": { "description": "The Amazon Resource Name (ARN) of the EMR Serverless Application.", + "pattern": "^arn:(aws[a-zA-Z0-9-]*):emr-serverless:.+:(\\d{12}):\\/applications\\/[0-9a-zA-Z]+$", "type": "string" }, "AutoStartConfiguration": { @@ -636,7 +662,9 @@ "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", "tagging": { "cloudFormationSystemTags": false, + "tagOnCreate": true, "tagProperty": "/properties/Tags", + "tagUpdatable": true, "taggable": true }, "typeName": "AWS::EMRServerless::Application" diff --git a/artifacts/types/AWS::ElastiCache::GlobalReplicationGroup.json b/artifacts/types/AWS::ElastiCache::GlobalReplicationGroup.json index 896354ef..4bec7b3b 100644 --- a/artifacts/types/AWS::ElastiCache::GlobalReplicationGroup.json +++ b/artifacts/types/AWS::ElastiCache::GlobalReplicationGroup.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ElastiCache-GlobalReplicationGroup", "type": "AWS::ElastiCache::GlobalReplicationGroup", - "time": "2023-12-07T22:31:16.281Z", + "time": "2024-04-10T09:36:10.535Z", "schema": { "additionalProperties": false, "definitions": { @@ -178,7 +178,6 @@ "/properties/CacheNodeType", "/properties/EngineVersion", "/properties/GlobalNodeGroupCount", - "/properties/GlobalReplicationGroupDescription", "/properties/RegionalConfigurations" ] } diff --git a/artifacts/types/AWS::ElastiCache::ParameterGroup.json b/artifacts/types/AWS::ElastiCache::ParameterGroup.json new file mode 100644 index 00000000..7d17dffd --- /dev/null +++ b/artifacts/types/AWS::ElastiCache::ParameterGroup.json @@ -0,0 +1,119 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ElastiCache-ParameterGroup", + "type": "AWS::ElastiCache::ParameterGroup", + "time": "2024-06-06T15:21:35.26Z", + "schema": { + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/CacheParameterGroupFamily" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::ElastiCache::ParameterGroup", + "handlers": { + "create": { + "permissions": [ + "ElastiCache:CreateCacheParameterGroup", + "ElastiCache:DescribeCacheParameterGroups", + "ElastiCache:AddTagsToResource", + "ElastiCache:ModifyCacheParameterGroup" + ] + }, + "delete": { + "permissions": [ + "ElastiCache:DescribeCacheParameterGroups", + "ElastiCache:DeleteCacheParameterGroup" + ] + }, + "list": { + "permissions": [ + "ElastiCache:DescribeCacheParameterGroups" + ] + }, + "read": { + "permissions": [ + "ElastiCache:DescribeCacheParameterGroups", + "ElastiCache:DescribeCacheParameters", + "ElastiCache:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "ElastiCache:ModifyCacheParameterGroup", + "ElastiCache:DescribeCacheParameterGroups", + "ElastiCache:DescribeCacheParameters", + "ElastiCache:DescribeEngineDefaultParameters", + "ElastiCache:AddTagsToResource", + "ElastiCache:RemoveTagsFromResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/CacheParameterGroupName" + ], + "properties": { + "CacheParameterGroupFamily": { + "description": "The name of the cache parameter group family that this cache parameter group is compatible with.", + "type": "string" + }, + "CacheParameterGroupName": { + "description": "The name of the Cache Parameter Group.", + "type": "string" + }, + "Description": { + "description": "The description for this cache parameter group.", + "type": "string" + }, + "Properties": { + "additionalProperties": false, + "description": "A comma-delimited list of parameter name/value pairs. For more information see ModifyCacheParameterGroup in the Amazon ElastiCache API Reference Guide.", + "patternProperties": { + "[a-zA-Z0-9]+": { + "type": "string" + } + }, + "type": "object" + }, + "Tags": { + "description": "Tags are composed of a Key/Value pair. You can use tags to categorize and track each parameter group. The tag value null is permitted.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/CacheParameterGroupName" + ], + "required": [ + "Description", + "CacheParameterGroupFamily" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::ElastiCache::ParameterGroup" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::ElastiCache::ServerlessCache.json b/artifacts/types/AWS::ElastiCache::ServerlessCache.json index 53a25740..0e119dc0 100644 --- a/artifacts/types/AWS::ElastiCache::ServerlessCache.json +++ b/artifacts/types/AWS::ElastiCache::ServerlessCache.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ElastiCache-ServerlessCache", "type": "AWS::ElastiCache::ServerlessCache", - "time": "2023-12-08T01:45:40.1Z", + "time": "2024-04-10T09:36:15.004Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -34,8 +34,12 @@ "description": "The maximum cached data capacity of the Serverless Cache.", "type": "integer" }, + "Minimum": { + "description": "The minimum cached data capacity of the Serverless Cache.", + "type": "integer" + }, "Unit": { - "description": "The unix of cached data capacity of the Serverless Cache.", + "description": "The unit of cached data capacity of the Serverless Cache.", "enum": [ "GB" ], @@ -43,7 +47,6 @@ } }, "required": [ - "Maximum", "Unit" ], "type": "object" @@ -55,11 +58,12 @@ "Maximum": { "description": "The maximum ECPU per second of the Serverless Cache.", "type": "integer" + }, + "Minimum": { + "description": "The minimum ECPU per second of the Serverless Cache.", + "type": "integer" } }, - "required": [ - "Maximum" - ], "type": "object" }, "Endpoint": { @@ -72,7 +76,7 @@ }, "Port": { "description": "Endpoint port.", - "type": "integer" + "type": "string" } }, "type": "object" diff --git a/artifacts/types/AWS::ElastiCache::SubnetGroup.json b/artifacts/types/AWS::ElastiCache::SubnetGroup.json index baa18bf6..c154a060 100644 --- a/artifacts/types/AWS::ElastiCache::SubnetGroup.json +++ b/artifacts/types/AWS::ElastiCache::SubnetGroup.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ElastiCache-SubnetGroup", "type": "AWS::ElastiCache::SubnetGroup", - "time": "2024-01-02T21:49:08.849Z", + "time": "2024-06-06T15:26:19.375Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::ElastiCache::User.json b/artifacts/types/AWS::ElastiCache::User.json index 62255ab9..90e4b56f 100644 --- a/artifacts/types/AWS::ElastiCache::User.json +++ b/artifacts/types/AWS::ElastiCache::User.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ElastiCache-User", "type": "AWS::ElastiCache::User", - "time": "2023-12-07T22:55:28.889Z", + "time": "2024-04-10T07:47:22.535Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -41,7 +41,8 @@ "permissions": [ "elasticache:CreateUser", "elasticache:DescribeUsers", - "elasticache:ListTagsForResource" + "elasticache:ListTagsForResource", + "elasticache:AddTagsToResource" ] }, "delete": { diff --git a/artifacts/types/AWS::ElastiCache::UserGroup.json b/artifacts/types/AWS::ElastiCache::UserGroup.json index d261515e..af65aba8 100644 --- a/artifacts/types/AWS::ElastiCache::UserGroup.json +++ b/artifacts/types/AWS::ElastiCache::UserGroup.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ElastiCache-UserGroup", "type": "AWS::ElastiCache::UserGroup", - "time": "2023-12-07T23:15:14.425Z", + "time": "2024-04-10T09:36:15.021Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -40,7 +40,8 @@ "permissions": [ "elasticache:CreateUserGroup", "elasticache:DescribeUserGroups", - "elasticache:ListTagsForResource" + "elasticache:ListTagsForResource", + "elasticache:AddTagsToResource" ] }, "delete": { diff --git a/artifacts/types/AWS::ElasticBeanstalk::Application.json b/artifacts/types/AWS::ElasticBeanstalk::Application.json index face2915..c46ff91b 100644 --- a/artifacts/types/AWS::ElasticBeanstalk::Application.json +++ b/artifacts/types/AWS::ElasticBeanstalk::Application.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ElasticBeanstalk-Application", "type": "AWS::ElasticBeanstalk::Application", - "time": "2023-07-26T17:36:14.232Z", + "time": "2024-06-24T17:55:40.572Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::ElasticBeanstalk::ApplicationVersion.json b/artifacts/types/AWS::ElasticBeanstalk::ApplicationVersion.json index a266d37f..e9cda991 100644 --- a/artifacts/types/AWS::ElasticBeanstalk::ApplicationVersion.json +++ b/artifacts/types/AWS::ElasticBeanstalk::ApplicationVersion.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ElasticBeanstalk-ApplicationVersion", "type": "AWS::ElasticBeanstalk::ApplicationVersion", - "time": "2023-07-26T17:49:28.849Z", + "time": "2024-06-24T17:55:34.08Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::ElasticBeanstalk::ConfigurationTemplate.json b/artifacts/types/AWS::ElasticBeanstalk::ConfigurationTemplate.json index fb041c55..2e3df858 100644 --- a/artifacts/types/AWS::ElasticBeanstalk::ConfigurationTemplate.json +++ b/artifacts/types/AWS::ElasticBeanstalk::ConfigurationTemplate.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ElasticBeanstalk-ConfigurationTemplate", "type": "AWS::ElasticBeanstalk::ConfigurationTemplate", - "time": "2023-07-26T17:49:37.316Z", + "time": "2024-06-24T17:58:50.629Z", "schema": { "$schema": "https://raw.githubusercontent.com/aws-cloudformation/cloudformation-resource-schema/master/src/main/resources/schema/provider.definition.schema.v1.json", "additionalProperties": false, diff --git a/artifacts/types/AWS::ElasticBeanstalk::Environment.json b/artifacts/types/AWS::ElasticBeanstalk::Environment.json index a49b9ddb..c3da1259 100644 --- a/artifacts/types/AWS::ElasticBeanstalk::Environment.json +++ b/artifacts/types/AWS::ElasticBeanstalk::Environment.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ElasticBeanstalk-Environment", "type": "AWS::ElasticBeanstalk::Environment", - "time": "2023-07-26T17:36:15.302Z", + "time": "2024-06-24T19:36:13.772Z", "schema": { "$schema": "https://raw.githubusercontent.com/aws-cloudformation/cloudformation-resource-schema/master/src/main/resources/schema/provider.definition.schema.v1.json", "additionalProperties": false, @@ -83,6 +83,8 @@ "permissions": [ "elasticbeanstalk:DescribeEnvironments", "elasticbeanstalk:CreateEnvironment", + "elasticbeanstalk:AddTags", + "elasticbeanstalk:ListTagsForResource", "iam:PassRole" ], "timeoutInMinutes": 120 @@ -96,7 +98,8 @@ }, "list": { "permissions": [ - "elasticbeanstalk:DescribeEnvironments" + "elasticbeanstalk:DescribeEnvironments", + "elasticbeanstalk:ListTagsForResource" ] }, "read": { @@ -113,6 +116,8 @@ "elasticbeanstalk:UpdateTagsForResource", "elasticbeanstalk:AssociateEnvironmentOperationsRole", "elasticbeanstalk:DisassociateEnvironmentOperationsRole", + "elasticbeanstalk:AddTags", + "elasticbeanstalk:ListTagsForResource", "iam:PassRole" ], "timeoutInMinutes": 300 diff --git a/artifacts/types/AWS::ElasticLoadBalancingV2::Listener.json b/artifacts/types/AWS::ElasticLoadBalancingV2::Listener.json index 57cacddb..db8b23e4 100644 --- a/artifacts/types/AWS::ElasticLoadBalancingV2::Listener.json +++ b/artifacts/types/AWS::ElasticLoadBalancingV2::Listener.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ElasticLoadBalancingV2-Listener", "type": "AWS::ElasticLoadBalancingV2::Listener", - "time": "2023-11-26T18:51:08.695Z", + "time": "2024-06-11T15:59:41.422Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -10,29 +10,42 @@ "definitions": { "Action": { "additionalProperties": false, + "description": "Specifies an action for a listener rule.", "properties": { "AuthenticateCognitoConfig": { - "$ref": "#/definitions/AuthenticateCognitoConfig" + "$ref": "#/definitions/AuthenticateCognitoConfig", + "description": "[HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when ``Type`` is ``authenticate-cognito``." }, "AuthenticateOidcConfig": { - "$ref": "#/definitions/AuthenticateOidcConfig" + "$ref": "#/definitions/AuthenticateOidcConfig", + "description": "[HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when ``Type`` is ``authenticate-oidc``." }, "FixedResponseConfig": { - "$ref": "#/definitions/FixedResponseConfig" + "$ref": "#/definitions/FixedResponseConfig", + "description": "[Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when ``Type`` is ``fixed-response``." }, "ForwardConfig": { - "$ref": "#/definitions/ForwardConfig" + "$ref": "#/definitions/ForwardConfig", + "description": "Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when ``Type`` is ``forward``. If you specify both ``ForwardConfig`` and ``TargetGroupArn``, you can specify only one target group using ``ForwardConfig`` and it must be the same target group specified in ``TargetGroupArn``." }, "Order": { + "description": "The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first.", "type": "integer" }, "RedirectConfig": { - "$ref": "#/definitions/RedirectConfig" + "$ref": "#/definitions/RedirectConfig", + "description": "[Application Load Balancer] Information for creating a redirect action. Specify only when ``Type`` is ``redirect``." }, "TargetGroupArn": { + "description": "The Amazon Resource Name (ARN) of the target group. Specify only when ``Type`` is ``forward`` and you want to route to a single target group. To route to one or more target groups, use ``ForwardConfig`` instead.", + "relationshipRef": { + "propertyPath": "/properties/TargetGroupArn", + "typeName": "AWS::ElasticLoadBalancingV2::TargetGroup" + }, "type": "string" }, "Type": { + "description": "The type of action.", "type": "string" } }, @@ -43,8 +56,10 @@ }, "AuthenticateCognitoConfig": { "additionalProperties": false, + "description": "Specifies information required when integrating with Amazon Cognito to authenticate users.", "properties": { "AuthenticationRequestExtraParams": { + "description": "The query parameters (up to 10) to include in the redirect request to the authorization endpoint.", "patternProperties": { "[a-zA-Z0-9]+": { "type": "string" @@ -53,24 +68,53 @@ "type": "object" }, "OnUnauthenticatedRequest": { + "description": "The behavior if the user is not authenticated. The following are possible values:\n + deny```` - Return an HTTP 401 Unauthorized error.\n + allow```` - Allow the request to be forwarded to the target.\n + authenticate```` - Redirect the request to the IdP authorization endpoint. This is the default value.", "type": "string" }, "Scope": { + "description": "The set of user claims to be requested from the IdP. The default is ``openid``.\n To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.", "type": "string" }, "SessionCookieName": { + "description": "The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.", "type": "string" }, "SessionTimeout": { + "description": "The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).", "type": "string" }, "UserPoolArn": { + "description": "The Amazon Resource Name (ARN) of the Amazon Cognito user pool.", + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::Cognito::UserPool" + }, "type": "string" }, "UserPoolClientId": { + "anyOf": [ + { + "relationshipRef": { + "propertyPath": "/properties/UserPoolId", + "typeName": "AWS::Cognito::UserPoolClient" + } + }, + { + "relationshipRef": { + "propertyPath": "/properties/ClientId", + "typeName": "AWS::Cognito::UserPoolClient" + } + } + ], + "description": "The ID of the Amazon Cognito user pool client.", "type": "string" }, "UserPoolDomain": { + "description": "The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.", + "relationshipRef": { + "propertyPath": "/properties/Id", + "typeName": "AWS::Cognito::UserPoolDomain" + }, "type": "string" } }, @@ -83,8 +127,10 @@ }, "AuthenticateOidcConfig": { "additionalProperties": false, + "description": "Specifies information required using an identity provide (IdP) that is compliant with OpenID Connect (OIDC) to authenticate users.", "properties": { "AuthenticationRequestExtraParams": { + "description": "The query parameters (up to 10) to include in the redirect request to the authorization endpoint.", "patternProperties": { "[a-zA-Z0-9]+": { "type": "string" @@ -93,36 +139,47 @@ "type": "object" }, "AuthorizationEndpoint": { + "description": "The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.", "type": "string" }, "ClientId": { + "description": "The OAuth 2.0 client identifier.", "type": "string" }, "ClientSecret": { + "description": "The OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you are modifying a rule, you can omit this parameter if you set ``UseExistingClientSecret`` to true.", "type": "string" }, "Issuer": { + "description": "The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.", "type": "string" }, "OnUnauthenticatedRequest": { + "description": "The behavior if the user is not authenticated. The following are possible values:\n + deny```` - Return an HTTP 401 Unauthorized error.\n + allow```` - Allow the request to be forwarded to the target.\n + authenticate```` - Redirect the request to the IdP authorization endpoint. This is the default value.", "type": "string" }, "Scope": { + "description": "The set of user claims to be requested from the IdP. The default is ``openid``.\n To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.", "type": "string" }, "SessionCookieName": { + "description": "The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.", "type": "string" }, "SessionTimeout": { + "description": "The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).", "type": "string" }, "TokenEndpoint": { + "description": "The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.", "type": "string" }, "UseExistingClientSecret": { + "description": "Indicates whether to use the existing client secret when modifying a rule. If you are creating a rule, you can omit this parameter or set it to false.", "type": "boolean" }, "UserInfoEndpoint": { + "description": "The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.", "type": "string" } }, @@ -137,8 +194,24 @@ }, "Certificate": { "additionalProperties": false, + "description": "Specifies an SSL server certificate to use as the default certificate for a secure listener.", "properties": { "CertificateArn": { + "anyOf": [ + { + "relationshipRef": { + "propertyPath": "/properties/Id", + "typeName": "AWS::CertificateManager::Certificate" + } + }, + { + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::IAM::ServerCertificate" + } + } + ], + "description": "The Amazon Resource Name (ARN) of the certificate.", "type": "string" } }, @@ -146,14 +219,18 @@ }, "FixedResponseConfig": { "additionalProperties": false, + "description": "Specifies information required when returning a custom HTTP response.", "properties": { "ContentType": { + "description": "The content type.\n Valid Values: text/plain | text/css | text/html | application/javascript | application/json", "type": "string" }, "MessageBody": { + "description": "The message.", "type": "string" }, "StatusCode": { + "description": "The HTTP response code (2XX, 4XX, or 5XX).", "type": "string" } }, @@ -164,11 +241,14 @@ }, "ForwardConfig": { "additionalProperties": false, + "description": "Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when ``Type`` is ``forward``. If you specify both ``ForwardConfig`` and ``TargetGroupArn``, you can specify only one target group using ``ForwardConfig`` and it must be the same target group specified in ``TargetGroupArn``.", "properties": { "TargetGroupStickinessConfig": { - "$ref": "#/definitions/TargetGroupStickinessConfig" + "$ref": "#/definitions/TargetGroupStickinessConfig", + "description": "Information about the target group stickiness for a rule." }, "TargetGroups": { + "description": "Information about how traffic will be distributed between multiple target groups in a forward rule.", "items": { "$ref": "#/definitions/TargetGroupTuple" }, @@ -180,14 +260,18 @@ }, "MutualAuthentication": { "additionalProperties": false, + "description": "Specifies the configuration information for mutual authentication.", "properties": { "IgnoreClientCertificateExpiry": { + "description": "Indicates whether expired client certificates are ignored.", "type": "boolean" }, "Mode": { + "description": "The client certificate handling method. Options are ``off``, ``passthrough`` or ``verify``. The default value is ``off``.", "type": "string" }, "TrustStoreArn": { + "description": "The Amazon Resource Name (ARN) of the trust store.", "type": "string" } }, @@ -195,23 +279,30 @@ }, "RedirectConfig": { "additionalProperties": false, + "description": "Information about a redirect action.\n A URI consists of the following components: protocol://hostname:port/path?query. You must modify at least one of the following components to avoid a redirect loop: protocol, hostname, port, or path. Any components that you do not modify retain their original values.\n You can reuse URI components using the following reserved keywords:\n + #{protocol}\n + #{host}\n + #{port}\n + #{path} (the leading \"/\" is removed)\n + #{query}\n \n For example, you can change the path to \"/new/#{path}\", the hostname to \"example.#{host}\", or the query to \"#{query}\u0026value=xyz\".", "properties": { "Host": { + "description": "The hostname. This component is not percent-encoded. The hostname can contain #{host}.", "type": "string" }, "Path": { + "description": "The absolute path, starting with the leading \"/\". This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}.", "type": "string" }, "Port": { + "description": "The port. You can specify a value from 1 to 65535 or #{port}.", "type": "string" }, "Protocol": { + "description": "The protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP, HTTP to HTTPS, and HTTPS to HTTPS. You cannot redirect HTTPS to HTTP.", "type": "string" }, "Query": { + "description": "The query parameters, URL-encoded when necessary, but not percent-encoded. Do not include the leading \"?\", as it is automatically added. You can specify any of the reserved keywords.", "type": "string" }, "StatusCode": { + "description": "The HTTP redirect code. The redirect is either permanent (HTTP 301) or temporary (HTTP 302).", "type": "string" } }, @@ -222,11 +313,14 @@ }, "TargetGroupStickinessConfig": { "additionalProperties": false, + "description": "Information about the target group stickiness for a rule.", "properties": { "DurationSeconds": { + "description": "The time period, in seconds, during which requests from a client should be routed to the same target group. The range is 1-604800 seconds (7 days).", "type": "integer" }, "Enabled": { + "description": "Indicates whether target group stickiness is enabled.", "type": "boolean" } }, @@ -234,18 +328,25 @@ }, "TargetGroupTuple": { "additionalProperties": false, + "description": "Information about how traffic will be distributed between multiple target groups in a forward rule.", "properties": { "TargetGroupArn": { + "description": "The Amazon Resource Name (ARN) of the target group.", + "relationshipRef": { + "propertyPath": "/properties/TargetGroupArn", + "typeName": "AWS::ElasticLoadBalancingV2::TargetGroup" + }, "type": "string" }, "Weight": { + "description": "The weight. The range is 0 to 999.", "type": "integer" } }, "type": "object" } }, - "description": "Resource Type definition for AWS::ElasticLoadBalancingV2::Listener", + "description": "Specifies a listener for an Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.", "handlers": { "create": { "permissions": [ @@ -309,12 +410,14 @@ ], "properties": { "AlpnPolicy": { + "description": "[TLS listener] The name of the Application-Layer Protocol Negotiation (ALPN) policy.", "items": { "type": "string" }, "type": "array" }, "Certificates": { + "description": "The default SSL server certificate for a secure listener. You must provide exactly one certificate if the listener protocol is HTTPS or TLS.\n To 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).", "items": { "$ref": "#/definitions/Certificate" }, @@ -322,6 +425,7 @@ "uniqueItems": true }, "DefaultActions": { + "description": "The actions for the default rule. You cannot define a condition for a default rule.\n To 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).", "items": { "$ref": "#/definitions/Action" }, @@ -329,21 +433,27 @@ "uniqueItems": true }, "ListenerArn": { + "description": "", "type": "string" }, "LoadBalancerArn": { + "description": "The Amazon Resource Name (ARN) of the load balancer.", "type": "string" }, "MutualAuthentication": { - "$ref": "#/definitions/MutualAuthentication" + "$ref": "#/definitions/MutualAuthentication", + "description": "The mutual authentication configuration information." }, "Port": { + "description": "The port on which the load balancer is listening. You cannot specify a port for a Gateway Load Balancer.", "type": "integer" }, "Protocol": { + "description": "The protocol for connections from clients to the load balancer. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP, TLS, UDP, and TCP_UDP. You can’t specify the UDP or TCP_UDP protocol if dual-stack mode is enabled. You cannot specify a protocol for a Gateway Load Balancer.", "type": "string" }, "SslPolicy": { + "description": "[HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are supported.\n Updating the security policy can result in interruptions if the load balancer is handling a high volume of traffic.\n For more information, see [Security policies](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html#describe-ssl-policies) in the *Application Load Balancers Guide* and [Security policies](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html#describe-ssl-policies) in the *Network Load Balancers Guide*.", "type": "string" } }, diff --git a/artifacts/types/AWS::ElasticLoadBalancingV2::ListenerRule.json b/artifacts/types/AWS::ElasticLoadBalancingV2::ListenerRule.json index cea3017f..0ed33190 100644 --- a/artifacts/types/AWS::ElasticLoadBalancingV2::ListenerRule.json +++ b/artifacts/types/AWS::ElasticLoadBalancingV2::ListenerRule.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ElasticLoadBalancingV2-ListenerRule", "type": "AWS::ElasticLoadBalancingV2::ListenerRule", - "time": "2023-11-01T20:19:09.204Z", + "time": "2024-06-11T15:53:47.866Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -10,29 +10,38 @@ "definitions": { "Action": { "additionalProperties": false, + "description": "Specifies an action for a listener rule.", "properties": { "AuthenticateCognitoConfig": { - "$ref": "#/definitions/AuthenticateCognitoConfig" + "$ref": "#/definitions/AuthenticateCognitoConfig", + "description": "[HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when ``Type`` is ``authenticate-cognito``." }, "AuthenticateOidcConfig": { - "$ref": "#/definitions/AuthenticateOidcConfig" + "$ref": "#/definitions/AuthenticateOidcConfig", + "description": "[HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when ``Type`` is ``authenticate-oidc``." }, "FixedResponseConfig": { - "$ref": "#/definitions/FixedResponseConfig" + "$ref": "#/definitions/FixedResponseConfig", + "description": "[Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when ``Type`` is ``fixed-response``." }, "ForwardConfig": { - "$ref": "#/definitions/ForwardConfig" + "$ref": "#/definitions/ForwardConfig", + "description": "Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when ``Type`` is ``forward``. If you specify both ``ForwardConfig`` and ``TargetGroupArn``, you can specify only one target group using ``ForwardConfig`` and it must be the same target group specified in ``TargetGroupArn``." }, "Order": { + "description": "The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first.", "type": "integer" }, "RedirectConfig": { - "$ref": "#/definitions/RedirectConfig" + "$ref": "#/definitions/RedirectConfig", + "description": "[Application Load Balancer] Information for creating a redirect action. Specify only when ``Type`` is ``redirect``." }, "TargetGroupArn": { + "description": "The Amazon Resource Name (ARN) of the target group. Specify only when ``Type`` is ``forward`` and you want to route to a single target group. To route to one or more target groups, use ``ForwardConfig`` instead.", "type": "string" }, "Type": { + "description": "The type of action.", "type": "string" } }, @@ -43,9 +52,11 @@ }, "AuthenticateCognitoConfig": { "additionalProperties": false, + "description": "Specifies information required when integrating with Amazon Cognito to authenticate users.", "properties": { "AuthenticationRequestExtraParams": { "additionalProperties": false, + "description": "The query parameters (up to 10) to include in the redirect request to the authorization endpoint.", "patternProperties": { "[a-zA-Z0-9]+": { "type": "string" @@ -54,24 +65,31 @@ "type": "object" }, "OnUnauthenticatedRequest": { + "description": "The behavior if the user is not authenticated. The following are possible values:\n + deny```` - Return an HTTP 401 Unauthorized error.\n + allow```` - Allow the request to be forwarded to the target.\n + authenticate```` - Redirect the request to the IdP authorization endpoint. This is the default value.", "type": "string" }, "Scope": { + "description": "The set of user claims to be requested from the IdP. The default is ``openid``.\n To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.", "type": "string" }, "SessionCookieName": { + "description": "The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.", "type": "string" }, "SessionTimeout": { + "description": "The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).", "type": "integer" }, "UserPoolArn": { + "description": "The Amazon Resource Name (ARN) of the Amazon Cognito user pool.", "type": "string" }, "UserPoolClientId": { + "description": "The ID of the Amazon Cognito user pool client.", "type": "string" }, "UserPoolDomain": { + "description": "The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.", "type": "string" } }, @@ -84,9 +102,11 @@ }, "AuthenticateOidcConfig": { "additionalProperties": false, + "description": "Specifies information required using an identity provide (IdP) that is compliant with OpenID Connect (OIDC) to authenticate users.", "properties": { "AuthenticationRequestExtraParams": { "additionalProperties": false, + "description": "The query parameters (up to 10) to include in the redirect request to the authorization endpoint.", "patternProperties": { "[a-zA-Z0-9]+": { "type": "string" @@ -95,36 +115,47 @@ "type": "object" }, "AuthorizationEndpoint": { + "description": "The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.", "type": "string" }, "ClientId": { + "description": "The OAuth 2.0 client identifier.", "type": "string" }, "ClientSecret": { + "description": "The OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you are modifying a rule, you can omit this parameter if you set ``UseExistingClientSecret`` to true.", "type": "string" }, "Issuer": { + "description": "The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.", "type": "string" }, "OnUnauthenticatedRequest": { + "description": "The behavior if the user is not authenticated. The following are possible values:\n + deny```` - Return an HTTP 401 Unauthorized error.\n + allow```` - Allow the request to be forwarded to the target.\n + authenticate```` - Redirect the request to the IdP authorization endpoint. This is the default value.", "type": "string" }, "Scope": { + "description": "The set of user claims to be requested from the IdP. The default is ``openid``.\n To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.", "type": "string" }, "SessionCookieName": { + "description": "The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.", "type": "string" }, "SessionTimeout": { + "description": "The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).", "type": "integer" }, "TokenEndpoint": { + "description": "The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.", "type": "string" }, "UseExistingClientSecret": { + "description": "Indicates whether to use the existing client secret when modifying a rule. If you are creating a rule, you can omit this parameter or set it to false.", "type": "boolean" }, "UserInfoEndpoint": { + "description": "The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.", "type": "string" } }, @@ -139,14 +170,18 @@ }, "FixedResponseConfig": { "additionalProperties": false, + "description": "Specifies information required when returning a custom HTTP response.", "properties": { "ContentType": { + "description": "The content type.\n Valid Values: text/plain | text/css | text/html | application/javascript | application/json", "type": "string" }, "MessageBody": { + "description": "The message.", "type": "string" }, "StatusCode": { + "description": "The HTTP response code (2XX, 4XX, or 5XX).", "type": "string" } }, @@ -157,11 +192,15 @@ }, "ForwardConfig": { "additionalProperties": false, + "description": "Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when ``Type`` is ``forward``. If you specify both ``ForwardConfig`` and ``TargetGroupArn``, you can specify only one target group using ``ForwardConfig`` and it must be the same target group specified in ``TargetGroupArn``.", "properties": { "TargetGroupStickinessConfig": { - "$ref": "#/definitions/TargetGroupStickinessConfig" + "$ref": "#/definitions/TargetGroupStickinessConfig", + "description": "Information about the target group stickiness for a rule." }, "TargetGroups": { + "description": "Information about how traffic will be distributed between multiple target groups in a forward rule.", + "insertionOrder": false, "items": { "$ref": "#/definitions/TargetGroupTuple" }, @@ -173,8 +212,11 @@ }, "HostHeaderConfig": { "additionalProperties": false, + "description": "Information about a host header condition.", "properties": { "Values": { + "description": "The host names. The maximum size of each name is 128 characters. The comparison is case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).\n If you specify multiple strings, the condition is satisfied if one of the strings matches the host name.", + "insertionOrder": false, "items": { "type": "string" }, @@ -186,11 +228,15 @@ }, "HttpHeaderConfig": { "additionalProperties": false, + "description": "Information about an HTTP header condition.\n There is a set of standard HTTP header fields. You can also define custom HTTP header fields.", "properties": { "HttpHeaderName": { + "description": "The name of the HTTP header field. The maximum size is 40 characters. The header name is case insensitive. The allowed characters are specified by RFC 7230. Wildcards are not supported.", "type": "string" }, "Values": { + "description": "The strings to compare against the value of the HTTP header. The maximum size of each string is 128 characters. The comparison strings are case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).\n If the same header appears multiple times in the request, we search them in order until a match is found.\n If you specify multiple strings, the condition is satisfied if one of the strings matches the value of the HTTP header. To require that all of the strings are a match, create one condition per string.", + "insertionOrder": false, "items": { "type": "string" }, @@ -202,8 +248,11 @@ }, "HttpRequestMethodConfig": { "additionalProperties": false, + "description": "Information about an HTTP method condition.\n HTTP defines a set of request methods, also referred to as HTTP verbs. For more information, see the [HTTP Method Registry](https://docs.aws.amazon.com/https://www.iana.org/assignments/http-methods/http-methods.xhtml). You can also define custom HTTP methods.", "properties": { "Values": { + "description": "The name of the request method. The maximum size is 40 characters. The allowed characters are A-Z, hyphen (-), and underscore (_). The comparison is case sensitive. Wildcards are not supported; therefore, the method name must be an exact match.\n If you specify multiple strings, the condition is satisfied if one of the strings matches the HTTP request method. We recommend that you route GET and HEAD requests in the same way, because the response to a HEAD request may be cached.", + "insertionOrder": false, "items": { "type": "string" }, @@ -215,8 +264,11 @@ }, "PathPatternConfig": { "additionalProperties": false, + "description": "Information about a path pattern condition.", "properties": { "Values": { + "description": "The path patterns to compare against the request URL. The maximum size of each string is 128 characters. The comparison is case sensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).\n If you specify multiple strings, the condition is satisfied if one of them matches the request URL. The path pattern is compared only to the path of the URL, not to its query string.", + "insertionOrder": false, "items": { "type": "string" }, @@ -228,8 +280,11 @@ }, "QueryStringConfig": { "additionalProperties": false, + "description": "Information about a query string condition.\n The query string component of a URI starts after the first '?' character and is terminated by either a '#' character or the end of the URI. A typical query string contains key/value pairs separated by '\u0026' characters. The allowed characters are specified by RFC 3986. Any character can be percentage encoded.", "properties": { "Values": { + "description": "The key/value pairs or values to find in the query string. The maximum size of each string is 128 characters. The comparison is case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character). To search for a literal '*' or '?' character in a query string, you must escape these characters in ``Values`` using a '\\' character.\n If you specify multiple key/value pairs or values, the condition is satisfied if one of them is found in the query string.", + "insertionOrder": false, "items": { "$ref": "#/definitions/QueryStringKeyValue" }, @@ -241,11 +296,14 @@ }, "QueryStringKeyValue": { "additionalProperties": false, + "description": "Information about a key/value pair.", "properties": { "Key": { + "description": "The key. You can omit the key.", "type": "string" }, "Value": { + "description": "The value.", "type": "string" } }, @@ -253,23 +311,30 @@ }, "RedirectConfig": { "additionalProperties": false, + "description": "Information about a redirect action.\n A URI consists of the following components: protocol://hostname:port/path?query. You must modify at least one of the following components to avoid a redirect loop: protocol, hostname, port, or path. Any components that you do not modify retain their original values.\n You can reuse URI components using the following reserved keywords:\n + #{protocol}\n + #{host}\n + #{port}\n + #{path} (the leading \"/\" is removed)\n + #{query}\n \n For example, you can change the path to \"/new/#{path}\", the hostname to \"example.#{host}\", or the query to \"#{query}\u0026value=xyz\".", "properties": { "Host": { + "description": "The hostname. This component is not percent-encoded. The hostname can contain #{host}.", "type": "string" }, "Path": { + "description": "The absolute path, starting with the leading \"/\". This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}.", "type": "string" }, "Port": { + "description": "The port. You can specify a value from 1 to 65535 or #{port}.", "type": "string" }, "Protocol": { + "description": "The protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP, HTTP to HTTPS, and HTTPS to HTTPS. You cannot redirect HTTPS to HTTP.", "type": "string" }, "Query": { + "description": "The query parameters, URL-encoded when necessary, but not percent-encoded. Do not include the leading \"?\", as it is automatically added. You can specify any of the reserved keywords.", "type": "string" }, "StatusCode": { + "description": "The HTTP redirect code. The redirect is either permanent (HTTP 301) or temporary (HTTP 302).", "type": "string" } }, @@ -280,29 +345,39 @@ }, "RuleCondition": { "additionalProperties": false, + "description": "Specifies a condition for a listener rule.", "properties": { "Field": { + "description": "The 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``", "type": "string" }, "HostHeaderConfig": { - "$ref": "#/definitions/HostHeaderConfig" + "$ref": "#/definitions/HostHeaderConfig", + "description": "Information for a host header condition. Specify only when ``Field`` is ``host-header``." }, "HttpHeaderConfig": { - "$ref": "#/definitions/HttpHeaderConfig" + "$ref": "#/definitions/HttpHeaderConfig", + "description": "Information for an HTTP header condition. Specify only when ``Field`` is ``http-header``." }, "HttpRequestMethodConfig": { - "$ref": "#/definitions/HttpRequestMethodConfig" + "$ref": "#/definitions/HttpRequestMethodConfig", + "description": "Information for an HTTP method condition. Specify only when ``Field`` is ``http-request-method``." }, "PathPatternConfig": { - "$ref": "#/definitions/PathPatternConfig" + "$ref": "#/definitions/PathPatternConfig", + "description": "Information for a path pattern condition. Specify only when ``Field`` is ``path-pattern``." }, "QueryStringConfig": { - "$ref": "#/definitions/QueryStringConfig" + "$ref": "#/definitions/QueryStringConfig", + "description": "Information for a query string condition. Specify only when ``Field`` is ``query-string``." }, "SourceIpConfig": { - "$ref": "#/definitions/SourceIpConfig" + "$ref": "#/definitions/SourceIpConfig", + "description": "Information for a source IP condition. Specify only when ``Field`` is ``source-ip``." }, "Values": { + "description": "The condition value. Specify only when ``Field`` is ``host-header`` or ``path-pattern``. Alternatively, to specify multiple host names or multiple path patterns, use ``HostHeaderConfig`` or ``PathPatternConfig``.\n If ``Field`` is ``host-header`` and you're not using ``HostHeaderConfig``, you can specify a single host name (for example, my.example.com). A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters.\n + A-Z, a-z, 0-9\n + - .\n + * (matches 0 or more characters)\n + ? (matches exactly 1 character)\n \n If ``Field`` is ``path-pattern`` and you're not using ``PathPatternConfig``, you can specify a single path pattern (for example, /img/*). A path pattern is case-sensitive, can be up to 128 characters in length, and can contain any of the following characters.\n + A-Z, a-z, 0-9\n + _ - . $ / ~ \" ' @ : +\n + \u0026 (using \u0026amp;)\n + * (matches 0 or more characters)\n + ? (matches exactly 1 character)", + "insertionOrder": false, "items": { "type": "string" }, @@ -314,8 +389,11 @@ }, "SourceIpConfig": { "additionalProperties": false, + "description": "Information about a source IP condition.\n You can use this condition to route based on the IP address of the source that connects to the load balancer. If a client is behind a proxy, this is the IP address of the proxy not the IP address of the client.", "properties": { "Values": { + "description": "The source IP addresses, in CIDR format. You can use both IPv4 and IPv6 addresses. Wildcards are not supported.\n If you specify multiple addresses, the condition is satisfied if the source IP address of the request matches one of the CIDR blocks. This condition is not satisfied by the addresses in the X-Forwarded-For header.", + "insertionOrder": false, "items": { "type": "string" }, @@ -327,11 +405,14 @@ }, "TargetGroupStickinessConfig": { "additionalProperties": false, + "description": "Information about the target group stickiness for a rule.", "properties": { "DurationSeconds": { + "description": "The time period, in seconds, during which requests from a client should be routed to the same target group. The range is 1-604800 seconds (7 days).", "type": "integer" }, "Enabled": { + "description": "Indicates whether target group stickiness is enabled.", "type": "boolean" } }, @@ -339,31 +420,63 @@ }, "TargetGroupTuple": { "additionalProperties": false, + "description": "Information about how traffic will be distributed between multiple target groups in a forward rule.", "properties": { "TargetGroupArn": { + "description": "The Amazon Resource Name (ARN) of the target group.", "type": "string" }, "Weight": { + "description": "The weight. The range is 0 to 999.", "type": "integer" } }, "type": "object" } }, - "description": "Resource Type definition for AWS::ElasticLoadBalancingV2::ListenerRule", + "description": "Specifies a listener rule. The listener must be associated with an Application Load Balancer. Each rule consists of a priority, one or more actions, and one or more conditions.\n For more information, see [Quotas for your Application Load Balancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-limits.html) in the *User Guide for Application Load Balancers*.", "handlers": { "create": { "permissions": [ "elasticloadbalancing:CreateRule", - "elasticloadbalancing:DescribeRules" + "elasticloadbalancing:DescribeRules", + "cognito-idp:DescribeUserPoolClient" ] }, "delete": { "permissions": [ - "elasticloadbalancing:DeleteRule" + "elasticloadbalancing:DeleteRule", + "elasticloadbalancing:DescribeRules" ] }, "list": { + "handlerSchema": { + "oneOf": [ + { + "required": [ + "ListenerArn" + ] + }, + { + "required": [ + "RuleArns" + ] + } + ], + "properties": { + "ListenerArn": { + "$ref": "resource-schema.json#/properties/ListenerArn" + }, + "RuleArns": { + "insertionOrder": false, + "items": { + "$ref": "resource-schema.json#/properties/RuleArn" + }, + "type": "array", + "uniqueItems": false + } + } + }, "permissions": [ "elasticloadbalancing:DescribeRules" ] @@ -386,6 +499,8 @@ ], "properties": { "Actions": { + "description": "The actions.\n The rule must include exactly one of the following types of actions: ``forward``, ``fixed-response``, or ``redirect``, and it must be the last action to be performed. If the rule is for an HTTPS listener, it can also optionally include an authentication action.", + "insertionOrder": false, "items": { "$ref": "#/definitions/Action" }, @@ -393,6 +508,8 @@ "uniqueItems": true }, "Conditions": { + "description": "The conditions.\n The rule can optionally include up to one of each of the following conditions: ``http-request-method``, ``host-header``, ``path-pattern``, and ``source-ip``. A rule can also optionally include one or more of each of the following conditions: ``http-header`` and ``query-string``.", + "insertionOrder": false, "items": { "$ref": "#/definitions/RuleCondition" }, @@ -400,15 +517,19 @@ "uniqueItems": true }, "IsDefault": { + "description": "", "type": "boolean" }, "ListenerArn": { + "description": "The Amazon Resource Name (ARN) of the listener.", "type": "string" }, "Priority": { + "description": "The rule priority. A listener can't have multiple rules with the same priority.\n If you try to reorder rules by updating their priorities, do not specify a new priority if an existing rule already uses this priority, as this can cause an error. If you need to reuse a priority with a different rule, you must remove it as a priority first, and then specify it in a subsequent update.", "type": "integer" }, "RuleArn": { + "description": "", "type": "string" } }, @@ -421,7 +542,13 @@ "Priority", "Conditions" ], - "taggable": false, + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-elasticloadbalancingv2", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, "typeName": "AWS::ElasticLoadBalancingV2::ListenerRule", "writeOnlyProperties": [ "/properties/Actions/*/AuthenticateOidcConfig/ClientSecret", diff --git a/artifacts/types/AWS::ElasticLoadBalancingV2::LoadBalancer.json b/artifacts/types/AWS::ElasticLoadBalancingV2::LoadBalancer.json index 1c0fc521..424c42f7 100644 --- a/artifacts/types/AWS::ElasticLoadBalancingV2::LoadBalancer.json +++ b/artifacts/types/AWS::ElasticLoadBalancingV2::LoadBalancer.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ElasticLoadBalancingV2-LoadBalancer", "type": "AWS::ElasticLoadBalancingV2::LoadBalancer", - "time": "2023-11-01T20:19:07.313Z", + "time": "2024-06-11T18:43:24.674Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -12,11 +12,14 @@ "definitions": { "LoadBalancerAttribute": { "additionalProperties": false, + "description": "Specifies an attribute for an Application Load Balancer, a Network Load Balancer, or a Gateway Load Balancer.", "properties": { "Key": { + "description": "The name of the attribute.\n The following attributes are supported by all load balancers:\n + ``deletion_protection.enabled`` - Indicates whether deletion protection is enabled. The value is ``true`` or ``false``. The default is ``false``.\n + ``load_balancing.cross_zone.enabled`` - Indicates whether cross-zone load balancing is enabled. The possible values are ``true`` and ``false``. The default for Network Load Balancers and Gateway Load Balancers is ``false``. The default for Application Load Balancers is ``true``, and cannot be changed.\n \n The following attributes are supported by both Application Load Balancers and Network Load Balancers:\n + ``access_logs.s3.enabled`` - Indicates whether access logs are enabled. The value is ``true`` or ``false``. The default is ``false``.\n + ``access_logs.s3.bucket`` - The name of the S3 bucket for the access logs. This attribute is required if access logs are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket.\n + ``access_logs.s3.prefix`` - The prefix for the location in the S3 bucket for the access logs.\n + ``ipv6.deny_all_igw_traffic`` - Blocks internet gateway (IGW) access to the load balancer. It is set to ``false`` for internet-facing load balancers and ``true`` for internal load balancers, preventing unintended access to your internal load balancer through an internet gateway.\n \n The following attributes are supported by only Application Load Balancers:\n + ``idle_timeout.timeout_seconds`` - The idle timeout value, in seconds. The valid range is 1-4000 seconds. The default is 60 seconds.\n + ``client_keep_alive.seconds`` - The client keep alive value, in seconds. The valid range is 60-604800 seconds. The default is 3600 seconds.\n + ``connection_logs.s3.enabled`` - Indicates whether connection logs are enabled. The value is ``true`` or ``false``. The default is ``false``.\n + ``connection_logs.s3.bucket`` - The name of the S3 bucket for the connection logs. This attribute is required if connection logs are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket.\n + ``connection_logs.s3.prefix`` - The prefix for the location in the S3 bucket for the connection logs.\n + ``routing.http.desync_mitigation_mode`` - Determines how the load balancer handles requests that might pose a security risk to your application. The possible values are ``monitor``, ``defensive``, and ``strictest``. The default is ``defensive``.\n + ``routing.http.drop_invalid_header_fields.enabled`` - Indicates whether HTTP headers with invalid header fields are removed by the load balancer (``true``) or routed to targets (``false``). The default is ``false``.\n + ``routing.http.preserve_host_header.enabled`` - Indicates whether the Application Load Balancer should preserve the ``Host`` header in the HTTP request and send it to the target without any change. The possible values are ``true`` and ``false``. The default is ``false``.\n + ``routing.http.x_amzn_tls_version_and_cipher_suite.enabled`` - Indicates whether the two headers (``x-amzn-tls-version`` and ``x-amzn-tls-cipher-suite``), which contain information about the negotiated TLS version and cipher suite, are added to the client request before sending it to the target. The ``x-amzn-tls-version`` header has information about the TLS protocol version negotiated with the client, and the ``x-amzn-tls-cipher-suite`` header has information about the cipher suite negotiated with the client. Both headers are in OpenSSL format. The possible values for the attribute are ``true`` and ``false``. The default is ``false``.\n + ``routing.http.xff_client_port.enabled`` - Indicates whether the ``X-Forwarded-For`` header should preserve the source port that the client used to connect to the load balancer. The possible values are ``true`` and ``false``. The default is ``false``.\n + ``routing.http.xff_header_processing.mode`` - Enables you to modify, preserve, or remove the ``X-Forwarded-For`` header in the HTTP request before the Application Load Balancer sends the request to the target. The possible values are ``append``, ``preserve``, and ``remove``. The default is ``append``.\n + If the value is ``append``, the Application Load Balancer adds the client IP address (of the last hop) to the ``X-Forwarded-For`` header in the HTTP request before it sends it to targets.\n + If the value is ``preserve`` the Application Load Balancer preserves the ``X-Forwarded-For`` header in the HTTP request, and sends it to targets without any change.\n + If the value is ``remove``, the Application Load Balancer removes the ``X-Forwarded-For`` header in the HTTP request before it sends it to targets.\n \n + ``routing.http2.enabled`` - Indicates whether HTTP/2 is enabled. The possible values are ``true`` and ``false``. The default is ``true``. Elastic Load Balancing requires that message header names contain only alphanumeric characters and hyphens.\n + ``waf.fail_open.enabled`` - Indicates whether to allow a WAF-enabled load balancer to route requests to targets if it is unable to forward the request to AWS WAF. The possible values are ``true`` and ``false``. The default is ``false``.\n \n The following attributes are supported by only Network Load Balancers:\n + ``dns_record.client_routing_policy`` - Indicates how traffic is distributed among the load balancer Availability Zones. The possible values are ``availability_zone_affinity`` with 100 percent zonal affinity, ``partial_availability_zone_affinity`` with 85 percent zonal affinity, and ``any_availability_zone`` with 0 percent zonal affinity.", "type": "string" }, "Value": { + "description": "The value of the attribute.", "type": "string" } }, @@ -24,17 +27,22 @@ }, "SubnetMapping": { "additionalProperties": false, + "description": "Specifies a subnet for a load balancer.", "properties": { "AllocationId": { + "description": "[Network Load Balancers] The allocation ID of the Elastic IP address for an internet-facing load balancer.", "type": "string" }, "IPv6Address": { + "description": "[Network Load Balancers] The IPv6 address.", "type": "string" }, "PrivateIPv4Address": { + "description": "[Network Load Balancers] The private IPv4 address for an internal load balancer.", "type": "string" }, "SubnetId": { + "description": "The ID of the subnet.", "type": "string" } }, @@ -45,11 +53,14 @@ }, "Tag": { "additionalProperties": false, + "description": "Information about a tag.", "properties": { "Key": { + "description": "The key of the tag.", "type": "string" }, "Value": { + "description": "The value of the tag.", "type": "string" } }, @@ -59,7 +70,7 @@ "type": "object" } }, - "description": "Resource Type definition for AWS::ElasticLoadBalancingV2::LoadBalancer", + "description": "Specifies an Application Load Balancer, a Network Load Balancer, or a Gateway Load Balancer.", "documentationUrl": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html", "handlers": { "create": { @@ -68,7 +79,8 @@ "elasticloadbalancing:DescribeLoadBalancers", "elasticloadbalancing:ModifyLoadBalancerAttributes", "elasticloadbalancing:AddTags" - ] + ], + "timeoutInMinutes": 30 }, "delete": { "permissions": [ @@ -104,19 +116,23 @@ ], "properties": { "CanonicalHostedZoneID": { - "description": "The ID of the Amazon Route 53 hosted zone associated with the load balancer.", + "description": "", "type": "string" }, "DNSName": { - "description": "The public DNS name of the load balancer.", + "description": "", + "type": "string" + }, + "EnforceSecurityGroupInboundRulesOnPrivateLinkTraffic": { + "description": "Indicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through privatelink.", "type": "string" }, "IpAddressType": { - "description": "The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses).", + "description": "Note: Internal load balancers must use the ``ipv4`` IP address type.\n [Application Load Balancers] The IP address type. The possible values are ``ipv4`` (for only IPv4 addresses), ``dualstack`` (for IPv4 and IPv6 addresses), and ``dualstack-without-public-ipv4`` (for IPv6 only public addresses, with private IPv4 and IPv6 addresses).\n [Network Load Balancers] The IP address type. The possible values are ``ipv4`` (for only IPv4 addresses) and ``dualstack`` (for IPv4 and IPv6 addresses). You can’t specify ``dualstack`` for a load balancer with a UDP or TCP_UDP listener.\n [Gateway Load Balancers] The IP address type. The possible values are ``ipv4`` (for only IPv4 addresses) and ``dualstack`` (for IPv4 and IPv6 addresses).", "type": "string" }, "LoadBalancerArn": { - "description": "The Amazon Resource Name (ARN) of the load balancer.", + "description": "", "type": "string" }, "LoadBalancerAttributes": { @@ -130,23 +146,23 @@ "uniqueItems": true }, "LoadBalancerFullName": { - "description": "The full name of the load balancer.", + "description": "", "type": "string" }, "LoadBalancerName": { - "description": "The name of the load balancer.", + "description": "", "type": "string" }, "Name": { - "description": "The name of the load balancer.", + "description": "The name of the load balancer. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, must not begin or end with a hyphen, and must not begin with \"internal-\".\n If you don't specify a name, AWS CloudFormation generates a unique physical ID for the load balancer. If you specify a name, you cannot perform updates that require replacement of this resource, but you can perform other updates. To replace the resource, specify a new name.", "type": "string" }, "Scheme": { - "description": "The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet. The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer. The default is an Internet-facing load balancer.", + "description": "The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet.\n The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer.\n The default is an Internet-facing load balancer.\n You cannot specify a scheme for a Gateway Load Balancer.", "type": "string" }, "SecurityGroups": { - "description": "The IDs of the security groups for the load balancer.", + "description": "[Application Load Balancers and Network Load Balancers] The IDs of the security groups for the load balancer.", "insertionOrder": false, "items": { "type": "string" @@ -155,7 +171,7 @@ "uniqueItems": true }, "SubnetMappings": { - "description": "The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both.", + "description": "The IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both.\n [Application Load Balancers] You must specify subnets from at least two Availability Zones. You cannot 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 Zones.\n [Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet.\n [Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You cannot specify Elastic IP addresses for your subnets.", "insertionOrder": false, "items": { "$ref": "#/definitions/SubnetMapping" @@ -164,7 +180,7 @@ "uniqueItems": true }, "Subnets": { - "description": "The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. To specify an Elastic IP address, specify subnet mappings instead of subnets.", + "description": "The IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. To specify an Elastic IP address, specify subnet mappings instead of subnets.\n [Application Load Balancers] You must specify subnets from at least two Availability Zones.\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 Zones.\n [Network Load Balancers] You can specify subnets from one or more Availability Zones.\n [Gateway Load Balancers] You can specify subnets from one or more Availability Zones.", "insertionOrder": false, "items": { "type": "string" @@ -182,7 +198,7 @@ "uniqueItems": false }, "Type": { - "description": "The type of load balancer. The default is application.", + "description": "The type of load balancer. The default is ``application``.", "type": "string" } }, diff --git a/artifacts/types/AWS::ElasticLoadBalancingV2::TargetGroup.json b/artifacts/types/AWS::ElasticLoadBalancingV2::TargetGroup.json index a827470d..1848d90a 100644 --- a/artifacts/types/AWS::ElasticLoadBalancingV2::TargetGroup.json +++ b/artifacts/types/AWS::ElasticLoadBalancingV2::TargetGroup.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ElasticLoadBalancingV2-TargetGroup", "type": "AWS::ElasticLoadBalancingV2::TargetGroup", - "time": "2023-12-12T18:19:25.299Z", + "time": "2024-03-04T16:43:15.092Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::ElasticLoadBalancingV2::TrustStore.json b/artifacts/types/AWS::ElasticLoadBalancingV2::TrustStore.json index 3ae326b4..ae2e03d1 100644 --- a/artifacts/types/AWS::ElasticLoadBalancingV2::TrustStore.json +++ b/artifacts/types/AWS::ElasticLoadBalancingV2::TrustStore.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ElasticLoadBalancingV2-TrustStore", "type": "AWS::ElasticLoadBalancingV2::TrustStore", - "time": "2023-11-26T18:38:04.556Z", + "time": "2024-06-24T15:58:22.869Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::EntityResolution::IdMappingWorkflow.json b/artifacts/types/AWS::EntityResolution::IdMappingWorkflow.json index 2171d474..45a1bc9b 100644 --- a/artifacts/types/AWS::EntityResolution::IdMappingWorkflow.json +++ b/artifacts/types/AWS::EntityResolution::IdMappingWorkflow.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EntityResolution-IdMappingWorkflow", "type": "AWS::EntityResolution::IdMappingWorkflow", - "time": "2024-01-04T16:47:35.583Z", + "time": "2024-06-18T15:37:38.78Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -53,18 +53,24 @@ "additionalProperties": false, "properties": { "InputSourceARN": { - "description": "An Glue table ARN for the input source table", + "description": "An Glue table ARN for the input source table or IdNamespace ARN", "pattern": "arn:(aws|aws-us-gov|aws-cn):.*:.*:[0-9]+:.*$", "type": "string" }, "SchemaArn": { "$ref": "#/definitions/SchemaMappingArn", "type": "string" + }, + "Type": { + "enum": [ + "SOURCE", + "TARGET" + ], + "type": "string" } }, "required": [ - "InputSourceARN", - "SchemaArn" + "InputSourceARN" ], "type": "object" }, @@ -270,7 +276,6 @@ "required": [ "WorkflowName", "InputSourceConfig", - "OutputSourceConfig", "IdMappingTechniques", "RoleArn" ], diff --git a/artifacts/types/AWS::EntityResolution::IdNamespace.json b/artifacts/types/AWS::EntityResolution::IdNamespace.json new file mode 100644 index 00000000..15a77452 --- /dev/null +++ b/artifacts/types/AWS::EntityResolution::IdNamespace.json @@ -0,0 +1,226 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EntityResolution-IdNamespace", + "type": "AWS::EntityResolution::IdNamespace", + "time": "2024-06-18T15:43:04.593Z", + "schema": { + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/IdNamespaceName" + ], + "definitions": { + "EntityName": { + "maxLength": 255, + "minLength": 1, + "pattern": "^[a-zA-Z_0-9-]*$", + "type": "string" + }, + "IdNamespaceIdMappingWorkflowProperties": { + "additionalProperties": false, + "properties": { + "IdMappingType": { + "enum": [ + "PROVIDER" + ], + "type": "string" + }, + "ProviderProperties": { + "$ref": "#/definitions/NamespaceProviderProperties" + } + }, + "required": [ + "IdMappingType" + ], + "type": "object" + }, + "IdNamespaceInputSource": { + "additionalProperties": false, + "properties": { + "InputSourceARN": { + "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):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})$", + "type": "string" + }, + "SchemaName": { + "$ref": "#/definitions/EntityName" + } + }, + "required": [ + "InputSourceARN" + ], + "type": "object" + }, + "NamespaceProviderProperties": { + "additionalProperties": false, + "properties": { + "ProviderConfiguration": { + "additionalProperties": false, + "description": "Additional Provider configuration that would be required for the provider service. The Configuration must be in JSON string format.", + "patternProperties": { + "^.+$": { + "type": "string" + } + }, + "type": "object" + }, + "ProviderServiceArn": { + "$ref": "#/definitions/ProviderServiceArn" + } + }, + "required": [ + "ProviderServiceArn" + ], + "type": "object" + }, + "ProviderServiceArn": { + "maxLength": 255, + "minLength": 20, + "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})$", + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "IdNamespace defined in AWS Entity Resolution service", + "handlers": { + "create": { + "permissions": [ + "entityresolution:CreateIdNamespace", + "entityresolution:TagResource", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "entityresolution:DeleteIdNamespace", + "entityresolution:GetIdNamespace", + "entityresolution:UntagResource" + ] + }, + "list": { + "permissions": [ + "entityresolution:ListIdNamespaces" + ] + }, + "read": { + "permissions": [ + "entityresolution:GetIdNamespace", + "entityresolution:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "entityresolution:UpdateIdNamespace", + "entityresolution:ListTagsForResource", + "entityresolution:TagResource", + "entityresolution:UntagResource", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/IdNamespaceName" + ], + "properties": { + "CreatedAt": { + "description": "The date and time when the IdNamespace was created", + "type": "string" + }, + "Description": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "IdMappingWorkflowProperties": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/IdNamespaceIdMappingWorkflowProperties" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + }, + "IdNamespaceArn": { + "description": "The arn associated with the IdNamespace", + "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})$", + "type": "string" + }, + "IdNamespaceName": { + "$ref": "#/definitions/EntityName" + }, + "InputSourceConfig": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/IdNamespaceInputSource" + }, + "maxItems": 20, + "minItems": 0, + "type": "array" + }, + "RoleArn": { + "maxLength": 512, + "minLength": 32, + "pattern": "^arn:(aws|aws-us-gov|aws-cn):iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$", + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "Type": { + "enum": [ + "SOURCE", + "TARGET" + ], + "type": "string" + }, + "UpdatedAt": { + "description": "The date and time when the IdNamespace was updated", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/IdNamespaceArn", + "/properties/CreatedAt", + "/properties/UpdatedAt" + ], + "required": [ + "IdNamespaceName", + "Type" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-entity-resolution.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::EntityResolution::IdNamespace" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::EntityResolution::MatchingWorkflow.json b/artifacts/types/AWS::EntityResolution::MatchingWorkflow.json index 097d9e3a..92393fef 100644 --- a/artifacts/types/AWS::EntityResolution::MatchingWorkflow.json +++ b/artifacts/types/AWS::EntityResolution::MatchingWorkflow.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EntityResolution-MatchingWorkflow", "type": "AWS::EntityResolution::MatchingWorkflow", - "time": "2024-01-04T16:47:35.713Z", + "time": "2024-06-18T15:42:15.245Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::EntityResolution::PolicyStatement.json b/artifacts/types/AWS::EntityResolution::PolicyStatement.json new file mode 100644 index 00000000..ba9727eb --- /dev/null +++ b/artifacts/types/AWS::EntityResolution::PolicyStatement.json @@ -0,0 +1,138 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EntityResolution-PolicyStatement", + "type": "AWS::EntityResolution::PolicyStatement", + "time": "2024-06-18T15:38:26.964Z", + "schema": { + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/StatementId", + "/properties/Arn" + ], + "definitions": { + "StatementAction": { + "maxLength": 64, + "minLength": 3, + "pattern": "^(entityresolution:[a-zA-Z0-9]+)$", + "type": "string" + }, + "StatementActionList": { + "items": { + "$ref": "#/definitions/StatementAction" + }, + "type": "array" + }, + "StatementCondition": { + "maxLength": 40960, + "minLength": 1, + "type": "string" + }, + "StatementEffect": { + "enum": [ + "Allow", + "Deny" + ], + "type": "string" + }, + "StatementId": { + "description": "The Statement Id of the policy statement that is being attached.", + "maxLength": 64, + "minLength": 1, + "pattern": "^[0-9A-Za-z]+$", + "type": "string" + }, + "StatementPrincipal": { + "maxLength": 64, + "minLength": 12, + "pattern": "^(\\\\d{12})|([a-z0-9\\\\.]+)$", + "type": "string" + }, + "StatementPrincipalList": { + "items": { + "$ref": "#/definitions/StatementPrincipal" + }, + "type": "array" + }, + "VeniceGlobalArn": { + "description": "Arn of the resource to which the policy statement is being attached.", + "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})$", + "type": "string" + } + }, + "description": "Policy Statement defined in AWS Entity Resolution Service", + "handlers": { + "create": { + "permissions": [ + "entityresolution:AddPolicyStatement" + ] + }, + "delete": { + "permissions": [ + "entityresolution:DeletePolicyStatement", + "entityresolution:GetPolicy" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "Arn": { + "$ref": "resource-schema.json#/properties/Arn" + } + }, + "required": [ + "Arn" + ] + }, + "permissions": [ + "entityresolution:GetPolicy" + ] + }, + "read": { + "permissions": [ + "entityresolution:GetPolicy" + ] + }, + "update": { + "permissions": [ + "entityresolution:AddPolicyStatement", + "entityresolution:DeletePolicyStatement" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn", + "/properties/StatementId" + ], + "properties": { + "Action": { + "$ref": "#/definitions/StatementActionList" + }, + "Arn": { + "$ref": "#/definitions/VeniceGlobalArn" + }, + "Condition": { + "$ref": "#/definitions/StatementCondition" + }, + "Effect": { + "$ref": "#/definitions/StatementEffect" + }, + "Principal": { + "$ref": "#/definitions/StatementPrincipalList" + }, + "StatementId": { + "$ref": "#/definitions/StatementId" + } + }, + "required": [ + "Arn", + "StatementId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-entity-resolution.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::EntityResolution::PolicyStatement" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::EntityResolution::SchemaMapping.json b/artifacts/types/AWS::EntityResolution::SchemaMapping.json index 4a4f03e6..515972f3 100644 --- a/artifacts/types/AWS::EntityResolution::SchemaMapping.json +++ b/artifacts/types/AWS::EntityResolution::SchemaMapping.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EntityResolution-SchemaMapping", "type": "AWS::EntityResolution::SchemaMapping", - "time": "2024-01-04T16:47:31.327Z", + "time": "2024-06-18T15:36:21.095Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::EventSchemas::Discoverer.json b/artifacts/types/AWS::EventSchemas::Discoverer.json index b7fc8096..4f28a204 100644 --- a/artifacts/types/AWS::EventSchemas::Discoverer.json +++ b/artifacts/types/AWS::EventSchemas::Discoverer.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EventSchemas-Discoverer", "type": "AWS::EventSchemas::Discoverer", - "time": "2024-01-04T21:29:07.824Z", + "time": "2024-04-22T15:33:45.782Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::EventSchemas::Registry.json b/artifacts/types/AWS::EventSchemas::Registry.json index 1d86219e..4723f7d0 100644 --- a/artifacts/types/AWS::EventSchemas::Registry.json +++ b/artifacts/types/AWS::EventSchemas::Registry.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EventSchemas-Registry", "type": "AWS::EventSchemas::Registry", - "time": "2024-01-04T21:34:43.024Z", + "time": "2024-04-22T15:37:15.471Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::EventSchemas::RegistryPolicy.json b/artifacts/types/AWS::EventSchemas::RegistryPolicy.json index d6b5d702..d06526f3 100644 --- a/artifacts/types/AWS::EventSchemas::RegistryPolicy.json +++ b/artifacts/types/AWS::EventSchemas::RegistryPolicy.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EventSchemas-RegistryPolicy", "type": "AWS::EventSchemas::RegistryPolicy", - "time": "2024-01-04T21:48:56.5Z", + "time": "2024-04-22T15:50:56.024Z", "schema": { "additionalProperties": false, "description": "Resource Type definition for AWS::EventSchemas::RegistryPolicy", diff --git a/artifacts/types/AWS::EventSchemas::Schema.json b/artifacts/types/AWS::EventSchemas::Schema.json index bb8f324e..a3ca3495 100644 --- a/artifacts/types/AWS::EventSchemas::Schema.json +++ b/artifacts/types/AWS::EventSchemas::Schema.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-EventSchemas-Schema", "type": "AWS::EventSchemas::Schema", - "time": "2024-01-04T21:59:22.9Z", + "time": "2024-04-22T15:54:54.002Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Events::EventBus.json b/artifacts/types/AWS::Events::EventBus.json index 45ef2a9e..34bff577 100644 --- a/artifacts/types/AWS::Events::EventBus.json +++ b/artifacts/types/AWS::Events::EventBus.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Events-EventBus", "type": "AWS::Events::EventBus", - "time": "2023-12-21T16:47:30.93Z", + "time": "2024-06-10T15:43:18.101Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -33,12 +33,19 @@ "events:DescribeEventBus", "events:PutPermission", "events:ListTagsForResource", - "events:TagResource" + "events:TagResource", + "kms:DescribeKey", + "kms:GenerateDataKey", + "kms:Decrypt" ] }, "delete": { "permissions": [ "events:DescribeEventBus", + "events:UpdateEventBus", + "events:ListTagsForResource", + "events:UntagResource", + "events:RemovePermission", "events:DeleteEventBus" ] }, @@ -59,7 +66,11 @@ "events:TagResource", "events:UntagResource", "events:PutPermission", - "events:DescribeEventBus" + "events:DescribeEventBus", + "events:UpdateEventBus", + "kms:DescribeKey", + "kms:GenerateDataKey", + "kms:Decrypt" ] } }, @@ -71,10 +82,28 @@ "description": "The Amazon Resource Name (ARN) for the event bus.", "type": "string" }, + "DeadLetterConfig": { + "additionalProperties": false, + "description": "Dead Letter Queue for the event bus.", + "properties": { + "Arn": { + "type": "string" + } + }, + "type": "object" + }, + "Description": { + "description": "The description of the event bus.", + "type": "string" + }, "EventSourceName": { "description": "If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.", "type": "string" }, + "KmsKeyIdentifier": { + "description": "Kms Key Identifier used to encrypt events at rest in the event bus.", + "type": "string" + }, "Name": { "description": "The name of the event bus.", "type": "string" diff --git a/artifacts/types/AWS::Events::Rule.json b/artifacts/types/AWS::Events::Rule.json index 578238bd..bd52988d 100644 --- a/artifacts/types/AWS::Events::Rule.json +++ b/artifacts/types/AWS::Events::Rule.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Events-Rule", "type": "AWS::Events::Rule", - "time": "2023-12-26T18:58:29.961Z", + "time": "2024-05-21T20:40:40.172Z", "schema": { "additionalProperties": false, "conditionalCreateOnlyProperties": [ diff --git a/artifacts/types/AWS::Evidently::Experiment.json b/artifacts/types/AWS::Evidently::Experiment.json index d8733b9a..3c5cbdc9 100644 --- a/artifacts/types/AWS::Evidently::Experiment.json +++ b/artifacts/types/AWS::Evidently::Experiment.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Evidently-Experiment", "type": "AWS::Evidently::Experiment", - "time": "2023-04-25T15:38:01.923Z", + "time": "2024-02-29T16:43:55.22Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Evidently::Feature.json b/artifacts/types/AWS::Evidently::Feature.json index d9fa1698..ff9cff77 100644 --- a/artifacts/types/AWS::Evidently::Feature.json +++ b/artifacts/types/AWS::Evidently::Feature.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Evidently-Feature", "type": "AWS::Evidently::Feature", - "time": "2023-04-25T15:38:43.762Z", + "time": "2024-02-29T16:44:01.294Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Evidently::Launch.json b/artifacts/types/AWS::Evidently::Launch.json index 285a93f7..7ff63086 100644 --- a/artifacts/types/AWS::Evidently::Launch.json +++ b/artifacts/types/AWS::Evidently::Launch.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Evidently-Launch", "type": "AWS::Evidently::Launch", - "time": "2023-04-25T15:48:33.256Z", + "time": "2024-02-29T16:43:52.416Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Evidently::Project.json b/artifacts/types/AWS::Evidently::Project.json index 13f21104..f22ffcf7 100644 --- a/artifacts/types/AWS::Evidently::Project.json +++ b/artifacts/types/AWS::Evidently::Project.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Evidently-Project", "type": "AWS::Evidently::Project", - "time": "2023-04-25T15:38:11.133Z", + "time": "2024-02-29T16:43:56.542Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::FIS::ExperimentTemplate.json b/artifacts/types/AWS::FIS::ExperimentTemplate.json index 7d6ccbd5..632e55e5 100644 --- a/artifacts/types/AWS::FIS::ExperimentTemplate.json +++ b/artifacts/types/AWS::FIS::ExperimentTemplate.json @@ -1,12 +1,12 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-FIS-ExperimentTemplate", "type": "AWS::FIS::ExperimentTemplate", - "time": "2023-12-13T05:18:11.096Z", + "time": "2024-05-31T08:36:19.583Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ "/properties/Tags", - "/properties/ExperimentOptions/properties/AccountTargeting" + "/properties/ExperimentOptions/AccountTargeting" ], "definitions": { "ActionId": { @@ -399,6 +399,17 @@ "Tags" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-fis.git", + "tagging": { + "cloudFormationSystemTags": true, + "permissions": [ + "fis:TagResource", + "fis:UntagResource", + "fis:ListTagsForResource" + ], + "tagOnCreate": true, + "tagUpdatable": true, + "taggable": true + }, "typeName": "AWS::FIS::ExperimentTemplate" } } \ No newline at end of file diff --git a/artifacts/types/AWS::FIS::TargetAccountConfiguration.json b/artifacts/types/AWS::FIS::TargetAccountConfiguration.json index 1cb6cc8b..2e09ff95 100644 --- a/artifacts/types/AWS::FIS::TargetAccountConfiguration.json +++ b/artifacts/types/AWS::FIS::TargetAccountConfiguration.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-FIS-TargetAccountConfiguration", "type": "AWS::FIS::TargetAccountConfiguration", - "time": "2023-12-13T05:19:07.388Z", + "time": "2024-05-31T08:51:29.909Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::FMS::NotificationChannel.json b/artifacts/types/AWS::FMS::NotificationChannel.json index 80c61d92..d6ae533f 100644 --- a/artifacts/types/AWS::FMS::NotificationChannel.json +++ b/artifacts/types/AWS::FMS::NotificationChannel.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-FMS-NotificationChannel", "type": "AWS::FMS::NotificationChannel", - "time": "2023-12-05T23:36:24.852Z", + "time": "2024-05-07T15:12:42.319Z", "schema": { "additionalProperties": false, "definitions": { diff --git a/artifacts/types/AWS::FMS::Policy.json b/artifacts/types/AWS::FMS::Policy.json index b69afdac..957e9d13 100644 --- a/artifacts/types/AWS::FMS::Policy.json +++ b/artifacts/types/AWS::FMS::Policy.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-FMS-Policy", "type": "AWS::FMS::Policy", - "time": "2023-12-05T23:36:41.142Z", + "time": "2024-05-01T17:36:56.317Z", "schema": { "additionalProperties": false, "definitions": { @@ -54,6 +54,147 @@ "minLength": 1, "type": "string" }, + "NetworkAclCommonPolicy": { + "additionalProperties": false, + "description": "Network ACL common policy.", + "properties": { + "NetworkAclEntrySet": { + "$ref": "#/definitions/NetworkAclEntrySet" + } + }, + "required": [ + "NetworkAclEntrySet" + ], + "type": "object" + }, + "NetworkAclEntry": { + "additionalProperties": false, + "description": "Network ACL entry.", + "properties": { + "CidrBlock": { + "description": "CIDR block.", + "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]))$", + "type": "string" + }, + "Egress": { + "description": "Whether the entry is an egress entry.", + "type": "boolean" + }, + "IcmpTypeCode": { + "additionalProperties": false, + "description": "ICMP type and code.", + "properties": { + "Code": { + "description": "Code.", + "maximum": 255, + "minimum": 0, + "type": "integer" + }, + "Type": { + "description": "Type.", + "maximum": 255, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "Code", + "Type" + ], + "type": "object" + }, + "Ipv6CidrBlock": { + "description": "IPv6 CIDR block.", + "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]))?$", + "type": "string" + }, + "PortRange": { + "additionalProperties": false, + "description": "Port range.", + "properties": { + "From": { + "description": "From Port.", + "maximum": 65535, + "minimum": 0, + "type": "integer" + }, + "To": { + "description": "To Port.", + "maximum": 65535, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "From", + "To" + ], + "type": "object" + }, + "Protocol": { + "description": "Protocol.", + "pattern": "^(tcp|udp|icmp|([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5]))$", + "type": "string" + }, + "RuleAction": { + "description": "Rule Action.", + "enum": [ + "allow", + "deny" + ], + "type": "string" + } + }, + "required": [ + "Egress", + "Protocol", + "RuleAction" + ], + "type": "object" + }, + "NetworkAclEntryList": { + "description": "NetworkAcl entry list.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/NetworkAclEntry" + }, + "type": "array" + }, + "NetworkAclEntrySet": { + "additionalProperties": false, + "anyOf": [ + { + "required": [ + "FirstEntries" + ] + }, + { + "required": [ + "LastEntries" + ] + } + ], + "description": "Network ACL entry set.", + "properties": { + "FirstEntries": { + "$ref": "#/definitions/NetworkAclEntryList" + }, + "ForceRemediateForFirstEntries": { + "type": "boolean" + }, + "ForceRemediateForLastEntries": { + "type": "boolean" + }, + "LastEntries": { + "$ref": "#/definitions/NetworkAclEntryList" + } + }, + "required": [ + "ForceRemediateForFirstEntries", + "ForceRemediateForLastEntries" + ], + "type": "object" + }, "NetworkFirewallPolicy": { "additionalProperties": false, "description": "Network firewall policy.", @@ -87,9 +228,17 @@ "required": [ "ThirdPartyFirewallPolicy" ] + }, + { + "required": [ + "NetworkAclCommonPolicy" + ] } ], "properties": { + "NetworkAclCommonPolicy": { + "$ref": "#/definitions/NetworkAclCommonPolicy" + }, "NetworkFirewallPolicy": { "$ref": "#/definitions/NetworkFirewallPolicy" }, @@ -133,7 +282,8 @@ "NETWORK_FIREWALL", "THIRD_PARTY_FIREWALL", "DNS_FIREWALL", - "IMPORT_NETWORK_FIREWALL" + "IMPORT_NETWORK_FIREWALL", + "NETWORK_ACL_COMMON" ], "type": "string" }, diff --git a/artifacts/types/AWS::FSx::DataRepositoryAssociation.json b/artifacts/types/AWS::FSx::DataRepositoryAssociation.json index dacc9ec9..3b8b66e2 100644 --- a/artifacts/types/AWS::FSx::DataRepositoryAssociation.json +++ b/artifacts/types/AWS::FSx::DataRepositoryAssociation.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-FSx-DataRepositoryAssociation", "type": "AWS::FSx::DataRepositoryAssociation", - "time": "2024-01-04T17:32:14.693Z", + "time": "2024-06-03T16:13:24.92Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Forecast::DatasetGroup.json b/artifacts/types/AWS::Forecast::DatasetGroup.json index f649536b..c803c97d 100644 --- a/artifacts/types/AWS::Forecast::DatasetGroup.json +++ b/artifacts/types/AWS::Forecast::DatasetGroup.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Forecast-DatasetGroup", "type": "AWS::Forecast::DatasetGroup", - "time": "2024-01-03T16:13:05.701Z", + "time": "2024-05-19T20:15:16.566Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::FraudDetector::Detector.json b/artifacts/types/AWS::FraudDetector::Detector.json index 1e594a60..afc6d02c 100644 --- a/artifacts/types/AWS::FraudDetector::Detector.json +++ b/artifacts/types/AWS::FraudDetector::Detector.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-FraudDetector-Detector", "type": "AWS::FraudDetector::Detector", - "time": "2023-12-22T00:15:08.811Z", + "time": "2024-04-16T15:47:53.701Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::FraudDetector::EntityType.json b/artifacts/types/AWS::FraudDetector::EntityType.json index 6ad0b83e..2122d71b 100644 --- a/artifacts/types/AWS::FraudDetector::EntityType.json +++ b/artifacts/types/AWS::FraudDetector::EntityType.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-FraudDetector-EntityType", "type": "AWS::FraudDetector::EntityType", - "time": "2023-12-22T00:13:07.385Z", + "time": "2024-04-16T15:47:53.728Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::FraudDetector::EventType.json b/artifacts/types/AWS::FraudDetector::EventType.json index edfd58df..205f66ea 100644 --- a/artifacts/types/AWS::FraudDetector::EventType.json +++ b/artifacts/types/AWS::FraudDetector::EventType.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-FraudDetector-EventType", "type": "AWS::FraudDetector::EventType", - "time": "2023-12-22T00:23:12.274Z", + "time": "2024-04-16T15:51:54.962Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::FraudDetector::Label.json b/artifacts/types/AWS::FraudDetector::Label.json index b9c2c710..8c4242e5 100644 --- a/artifacts/types/AWS::FraudDetector::Label.json +++ b/artifacts/types/AWS::FraudDetector::Label.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-FraudDetector-Label", "type": "AWS::FraudDetector::Label", - "time": "2023-12-22T00:00:32.56Z", + "time": "2024-04-16T15:50:33.708Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::FraudDetector::List.json b/artifacts/types/AWS::FraudDetector::List.json index 5b3b6c24..f307a6c3 100644 --- a/artifacts/types/AWS::FraudDetector::List.json +++ b/artifacts/types/AWS::FraudDetector::List.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-FraudDetector-List", "type": "AWS::FraudDetector::List", - "time": "2023-12-22T00:12:47.936Z", + "time": "2024-04-16T15:47:54.837Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::FraudDetector::Outcome.json b/artifacts/types/AWS::FraudDetector::Outcome.json index d2b1731e..3331f9fc 100644 --- a/artifacts/types/AWS::FraudDetector::Outcome.json +++ b/artifacts/types/AWS::FraudDetector::Outcome.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-FraudDetector-Outcome", "type": "AWS::FraudDetector::Outcome", - "time": "2023-12-22T00:13:07.473Z", + "time": "2024-04-16T15:46:53.177Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::FraudDetector::Variable.json b/artifacts/types/AWS::FraudDetector::Variable.json index 677a82a0..2592ed5d 100644 --- a/artifacts/types/AWS::FraudDetector::Variable.json +++ b/artifacts/types/AWS::FraudDetector::Variable.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-FraudDetector-Variable", "type": "AWS::FraudDetector::Variable", - "time": "2023-12-22T00:00:33.06Z", + "time": "2024-04-16T15:51:12.995Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::GameLift::Alias.json b/artifacts/types/AWS::GameLift::Alias.json index 4c67196a..d95cf4ae 100644 --- a/artifacts/types/AWS::GameLift::Alias.json +++ b/artifacts/types/AWS::GameLift::Alias.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-GameLift-Alias", "type": "AWS::GameLift::Alias", - "time": "2024-01-04T19:44:41.222Z", + "time": "2024-06-20T20:09:55.808Z", "schema": { "additionalProperties": false, "definitions": { diff --git a/artifacts/types/AWS::GameLift::Build.json b/artifacts/types/AWS::GameLift::Build.json index 3809ba3c..2cd71ebf 100644 --- a/artifacts/types/AWS::GameLift::Build.json +++ b/artifacts/types/AWS::GameLift::Build.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-GameLift-Build", "type": "AWS::GameLift::Build", - "time": "2024-01-04T19:43:46.751Z", + "time": "2024-06-20T20:02:21.165Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::GameLift::ContainerGroupDefinition.json b/artifacts/types/AWS::GameLift::ContainerGroupDefinition.json new file mode 100644 index 00000000..db4377be --- /dev/null +++ b/artifacts/types/AWS::GameLift::ContainerGroupDefinition.json @@ -0,0 +1,457 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-GameLift-ContainerGroupDefinition", + "type": "AWS::GameLift::ContainerGroupDefinition", + "time": "2024-06-20T20:24:28.197Z", + "schema": { + "$schema": "https://schema.cloudformation.us-east-1.amazonaws.com/provider.definition.schema.v1.json", + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/SchedulingStrategy", + "/properties/TotalMemoryLimit", + "/properties/TotalCpuLimit", + "/properties/ContainerDefinitions", + "/properties/OperatingSystem" + ], + "definitions": { + "ContainerDefinition": { + "additionalProperties": false, + "description": "Details about a container that is used in a container fleet", + "properties": { + "Command": { + "description": "The command that's passed to the container.", + "insertionOrder": true, + "items": { + "maxLength": 255, + "minLength": 1, + "pattern": "^.*$", + "type": "string" + }, + "maxItems": 20, + "minItems": 1, + "type": "array", + "uniqueItems": false + }, + "ContainerName": { + "description": "A descriptive label for the container definition. Container definition names must be unique with a container group definition.", + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z0-9-]+$", + "type": "string" + }, + "Cpu": { + "description": "The maximum number of CPU units reserved for this container. The value is expressed as an integer amount of CPU units. 1 vCPU is equal to 1024 CPU units", + "maximum": 10240, + "minimum": 1, + "type": "integer" + }, + "DependsOn": { + "description": "A list of container dependencies that determines when this container starts up and shuts down. For container groups with multiple containers, dependencies let you define a startup/shutdown sequence across the containers.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/ContainerDependency" + }, + "maxItems": 10, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "EntryPoint": { + "description": "The entry point that's passed to the container so that it will run as an executable. If there are multiple arguments, each argument is a string in the array.", + "insertionOrder": true, + "items": { + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "maxItems": 20, + "minItems": 1, + "type": "array", + "uniqueItems": false + }, + "Environment": { + "description": "The environment variables to pass to a container.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ContainerEnvironment" + }, + "maxItems": 20, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "Essential": { + "description": "Specifies if the container is essential. If an essential container fails a health check, then all containers in the container group will be restarted. You must specify exactly 1 essential container in a container group.", + "type": "boolean" + }, + "HealthCheck": { + "$ref": "#/definitions/ContainerHealthCheck", + "description": "Specifies how the health of the containers will be checked." + }, + "ImageUri": { + "description": "Specifies the image URI of this container.", + "maxLength": 255, + "minLength": 1, + "pattern": "^[a-zA-Z0-9-_\\.@\\/:]+$", + "type": "string" + }, + "MemoryLimits": { + "$ref": "#/definitions/MemoryLimits", + "description": "Specifies how much memory is available to the container. You must specify at least this parameter or the TotalMemoryLimit parameter of the ContainerGroupDefinition." + }, + "PortConfiguration": { + "$ref": "#/definitions/PortConfiguration", + "description": "Defines the ports on the container." + }, + "ResolvedImageDigest": { + "description": "The digest of the container image.", + "pattern": "^sha256:[a-fA-F0-9]{64}$", + "type": "string" + }, + "WorkingDirectory": { + "description": "The working directory to run commands inside the container in.", + "maxLength": 255, + "minLength": 1, + "pattern": "^.*$", + "type": "string" + } + }, + "required": [ + "ContainerName", + "ImageUri" + ], + "type": "object" + }, + "ContainerDependency": { + "additionalProperties": false, + "description": "A dependency that impacts a container's startup and shutdown.", + "properties": { + "Condition": { + "description": "The type of dependency.", + "enum": [ + "START", + "COMPLETE", + "SUCCESS", + "HEALTHY" + ], + "type": "string" + }, + "ContainerName": { + "description": "A descriptive label for the container definition. The container being defined depends on this container's condition.", + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z0-9-]+$", + "type": "string" + } + }, + "required": [ + "ContainerName", + "Condition" + ], + "type": "object" + }, + "ContainerEnvironment": { + "additionalProperties": false, + "description": "An environment variable to set inside a container, in the form of a key-value pair.", + "properties": { + "Name": { + "description": "The environment variable name.", + "maxLength": 255, + "minLength": 1, + "pattern": "^.*$", + "type": "string" + }, + "Value": { + "description": "The environment variable value.", + "maxLength": 255, + "minLength": 1, + "pattern": "^.*$", + "type": "string" + } + }, + "required": [ + "Name", + "Value" + ], + "type": "object" + }, + "ContainerHealthCheck": { + "additionalProperties": false, + "description": "Specifies how the process manager checks the health of containers.", + "properties": { + "Command": { + "description": "A string array representing the command that the container runs to determine if it is healthy.", + "insertionOrder": true, + "items": { + "maxLength": 255, + "minLength": 1, + "pattern": "^.*$", + "type": "string" + }, + "maxItems": 20, + "minItems": 1, + "type": "array", + "uniqueItems": false + }, + "Interval": { + "description": "How often (in seconds) the health is checked.", + "maximum": 300, + "minimum": 60, + "type": "integer" + }, + "Retries": { + "description": "How many times the process manager will retry the command after a timeout. (The first run of the command does not count as a retry.)", + "maximum": 10, + "minimum": 5, + "type": "integer" + }, + "StartPeriod": { + "description": "The optional grace period (in seconds) to give a container time to boostrap before teh health check is declared failed.", + "maximum": 300, + "minimum": 0, + "type": "integer" + }, + "Timeout": { + "description": "How many seconds the process manager allows the command to run before canceling it.", + "maximum": 60, + "minimum": 30, + "type": "integer" + } + }, + "required": [ + "Command" + ], + "type": "object" + }, + "ContainerPortRange": { + "additionalProperties": false, + "description": "A set of one or more port numbers that can be opened on the container.", + "properties": { + "FromPort": { + "description": "A starting value for the range of allowed port numbers.", + "maximum": 60000, + "minimum": 1, + "type": "integer" + }, + "Protocol": { + "description": "Defines the protocol of these ports.", + "enum": [ + "TCP", + "UDP" + ], + "type": "string" + }, + "ToPort": { + "description": "An ending value for the range of allowed port numbers. Port numbers are end-inclusive. This value must be equal to or greater than FromPort.", + "maximum": 60000, + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "FromPort", + "Protocol", + "ToPort" + ], + "type": "object" + }, + "MemoryLimits": { + "additionalProperties": false, + "description": "Specifies how much memory is available to the container.", + "properties": { + "HardLimit": { + "description": "The hard limit of memory to reserve for the container.", + "maximum": 1024000, + "minimum": 4, + "type": "integer" + }, + "SoftLimit": { + "description": "The amount of memory that is reserved for the container.", + "maximum": 1024000, + "minimum": 4, + "type": "integer" + } + }, + "type": "object" + }, + "PortConfiguration": { + "additionalProperties": false, + "description": "Defines the ports on a container.", + "properties": { + "ContainerPortRanges": { + "description": "Specifies one or more ranges of ports on a container.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ContainerPortRange" + }, + "maxItems": 100, + "minItems": 1, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "ContainerPortRanges" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length.", + "maxLength": 128, + "minLength": 1, + "pattern": "^.*$", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length.", + "maxLength": 256, + "minLength": 0, + "pattern": "^.*$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "The AWS::GameLift::ContainerGroupDefinition resource creates an Amazon GameLift container group definition.", + "handlers": { + "create": { + "permissions": [ + "gamelift:CreateContainerGroupDefinition", + "gamelift:DescribeContainerGroupDefinition", + "gamelift:ListTagsForResource", + "gamelift:TagResource", + "ecr:BatchCheckLayerAvailability", + "ecr:BatchGetImage", + "ecr:GetDownloadUrlForLayer", + "ecr:DescribeImages" + ] + }, + "delete": { + "permissions": [ + "gamelift:DescribeContainerGroupDefinition", + "gamelift:DeleteContainerGroupDefinition" + ] + }, + "list": { + "permissions": [ + "gamelift:ListContainerGroupDefinitions" + ] + }, + "read": { + "permissions": [ + "gamelift:DescribeContainerGroupDefinition", + "gamelift:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "gamelift:ListTagsForResource", + "gamelift:TagResource", + "gamelift:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Name" + ], + "properties": { + "ContainerDefinitions": { + "description": "A collection of container definitions that define the containers in this group.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/ContainerDefinition" + }, + "maxItems": 10, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "ContainerGroupDefinitionArn": { + "description": "The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift container group resource and uniquely identifies it across all AWS Regions.", + "maxLength": 512, + "minLength": 1, + "pattern": "^arn:.*:containergroupdefinition/containergroupdefinition-[a-zA-Z0-9-]+$", + "type": "string" + }, + "CreationTime": { + "description": "A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").", + "type": "string" + }, + "Name": { + "description": "A descriptive label for the container group definition.", + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z0-9-]+$", + "type": "string" + }, + "OperatingSystem": { + "description": "The operating system of the container group", + "enum": [ + "AMAZON_LINUX_2023" + ], + "type": "string" + }, + "SchedulingStrategy": { + "description": "Specifies whether the container group includes replica or daemon containers.", + "enum": [ + "REPLICA", + "DAEMON" + ], + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "TotalCpuLimit": { + "description": "The maximum number of CPU units reserved for this container group. The value is expressed as an integer amount of CPU units. (1 vCPU is equal to 1024 CPU units.)", + "maximum": 10240, + "minimum": 128, + "type": "integer" + }, + "TotalMemoryLimit": { + "description": "The maximum amount of memory (in MiB) to allocate for this container group.", + "maximum": 1024000, + "minimum": 4, + "type": "integer" + } + }, + "readOnlyProperties": [ + "/properties/ContainerGroupDefinitionArn", + "/properties/CreationTime", + "/properties/ContainerDefinitions/*/ResolvedImageDigest" + ], + "required": [ + "Name", + "TotalMemoryLimit", + "TotalCpuLimit", + "ContainerDefinitions", + "OperatingSystem" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-gamelift.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::GameLift::ContainerGroupDefinition" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::GameLift::Fleet.json b/artifacts/types/AWS::GameLift::Fleet.json index c7f93a8c..e11bd8b2 100644 --- a/artifacts/types/AWS::GameLift::Fleet.json +++ b/artifacts/types/AWS::GameLift::Fleet.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-GameLift-Fleet", "type": "AWS::GameLift::Fleet", - "time": "2024-01-04T19:43:48.748Z", + "time": "2024-06-20T19:51:41.413Z", "schema": { "$schema": "https://schema.cloudformation.us-east-1.amazonaws.com/provider.definition.schema.v1.json", "additionalProperties": false, @@ -9,6 +9,7 @@ "/properties/ApplyCapacity", "/properties/BuildId", "/properties/CertificateConfiguration", + "/properties/ContainerGroupsConfiguration", "/properties/EC2InstanceType", "/properties/FleetType", "/properties/InstanceRoleARN", @@ -19,7 +20,6 @@ "/properties/ScriptId", "/properties/ServerLaunchParameters", "/properties/ServerLaunchPath", - "/properties/CertificateType", "/properties/ComputeType" ], "definitions": { @@ -56,6 +56,78 @@ ], "type": "object" }, + "ConnectionPortRange": { + "additionalProperties": false, + "description": "Defines the range of ports on the instance that allow inbound traffic to connect with containers in a fleet.", + "properties": { + "FromPort": { + "description": "A starting value for a range of allowed port numbers.", + "maximum": 60000, + "minimum": 1, + "type": "integer" + }, + "ToPort": { + "description": "An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort.", + "maximum": 60000, + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "FromPort", + "ToPort" + ], + "type": "object" + }, + "ContainerGroupsConfiguration": { + "additionalProperties": false, + "description": "Specifies container groups that this instance will hold. You must specify exactly one replica group. Optionally, you may specify exactly one daemon group. You can't change this property after you create the fleet.", + "properties": { + "ConnectionPortRange": { + "$ref": "#/definitions/ConnectionPortRange" + }, + "ContainerGroupDefinitionNames": { + "description": "The names of the container group definitions that will be created in an instance. You must specify exactly one REPLICA container group. You have the option to also specify one DAEMON container group.", + "insertionOrder": false, + "items": { + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z0-9\\-]+$", + "type": "string" + }, + "maxItems": 2, + "minItems": 1, + "type": "array" + }, + "ContainerGroupsPerInstance": { + "$ref": "#/definitions/ContainerGroupsPerInstance" + } + }, + "required": [ + "ContainerGroupDefinitionNames", + "ConnectionPortRange" + ], + "type": "object" + }, + "ContainerGroupsPerInstance": { + "additionalProperties": false, + "description": "The number of container groups per instance.", + "properties": { + "DesiredReplicaContainerGroupsPerInstance": { + "description": "Use this parameter to override the number of replica container groups GameLift will launch per instance with a number that is lower than that calculated maximum.", + "maximum": 5000, + "minimum": 1, + "type": "integer" + }, + "MaxReplicaContainerGroupsPerInstance": { + "description": "GameLift calculates the maximum number of replica container groups it can launch per instance based on instance properties such as CPU, memory, and connection ports.", + "maximum": 5000, + "minimum": 1, + "type": "integer" + } + }, + "type": "object" + }, "IpPermission": { "additionalProperties": false, "description": "A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift hosting resource. New game sessions that are started on the fleet are assigned an IP address/port number combination, which must fall into the fleet's allowed ranges. For fleets created with a custom game server, the ranges reflect the server's game session assignments. For Realtime Servers fleets, Amazon GameLift automatically opens two port ranges, one for TCP messaging and one for UDP, for use by the Realtime servers.", @@ -404,7 +476,7 @@ "description": "Configuration for Anywhere fleet." }, "ApplyCapacity": { - "description": "ComputeType to differentiate EC2 hardware managed by GameLift and Anywhere hardware managed by the customer.", + "description": "Determines whether to apply fleet or location capacities on fleet creation.", "enum": [ "ON_UPDATE", "ON_CREATE_AND_UPDATE" @@ -424,10 +496,14 @@ "description": "ComputeType to differentiate EC2 hardware managed by GameLift and Anywhere hardware managed by the customer.", "enum": [ "EC2", - "ANYWHERE" + "ANYWHERE", + "CONTAINER" ], "type": "string" }, + "ContainerGroupsConfiguration": { + "$ref": "#/definitions/ContainerGroupsConfiguration" + }, "Description": { "description": "A human-readable description of a fleet.", "maxLength": 1024, @@ -579,6 +655,7 @@ } }, "readOnlyProperties": [ + "/properties/ContainerGroupsConfiguration/ContainerGroupsPerInstance/MaxReplicaContainerGroupsPerInstance", "/properties/FleetId" ], "required": [ @@ -586,6 +663,9 @@ ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-gamelift.git", "taggable": true, - "typeName": "AWS::GameLift::Fleet" + "typeName": "AWS::GameLift::Fleet", + "writeOnlyProperties": [ + "/properties/ApplyCapacity" + ] } } \ No newline at end of file diff --git a/artifacts/types/AWS::GameLift::GameServerGroup.json b/artifacts/types/AWS::GameLift::GameServerGroup.json index bf53555b..505afac0 100644 --- a/artifacts/types/AWS::GameLift::GameServerGroup.json +++ b/artifacts/types/AWS::GameLift::GameServerGroup.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-GameLift-GameServerGroup", "type": "AWS::GameLift::GameServerGroup", - "time": "2024-01-04T19:44:48.346Z", + "time": "2024-06-20T20:25:05.548Z", "schema": { "$schema": "https://schema.cloudformation.us-east-1.amazonaws.com/provider.definition.schema.v1.json", "additionalProperties": false, @@ -15,7 +15,7 @@ }, "AutoScalingPolicy": { "additionalProperties": false, - "description": "Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting", + "description": "Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource.", "properties": { "EstimatedInstanceWarmup": { "$ref": "#/definitions/EstimatedInstanceWarmup" @@ -156,7 +156,7 @@ }, "LaunchTemplate": { "additionalProperties": false, - "description": "The EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group.", + "description": "The EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource.", "properties": { "LaunchTemplateId": { "$ref": "#/definitions/LaunchTemplateId" @@ -179,12 +179,12 @@ "type": "string" }, "MaxSize": { - "description": "The maximum number of instances allowed in the EC2 Auto Scaling group.", + "description": "The maximum number of instances allowed in the EC2 Auto Scaling group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource.", "minimum": 1, "type": "number" }, "MinSize": { - "description": "The minimum number of instances allowed in the EC2 Auto Scaling group.", + "description": "The minimum number of instances allowed in the EC2 Auto Scaling group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource.", "minimum": 0, "type": "number" }, @@ -238,7 +238,7 @@ "type": "object" }, "Tags": { - "description": "A list of labels to assign to the new game server group resource.", + "description": "A list of labels to assign to the new game server group resource. Updating game server group tags with CloudFormation will not take effect. Please update this property using AWS GameLift APIs instead.", "insertionOrder": false, "items": { "$ref": "#/definitions/Tag" @@ -269,7 +269,7 @@ "type": "string" }, "VpcSubnets": { - "description": "A list of virtual private cloud (VPC) subnets to use with instances in the game server group.", + "description": "A list of virtual private cloud (VPC) subnets to use with instances in the game server group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource.", "insertionOrder": false, "items": { "maxLength": 24, @@ -374,7 +374,7 @@ }, "AutoScalingPolicy": { "$ref": "#/definitions/AutoScalingPolicy", - "description": "Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting" + "description": "Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource." }, "BalancingStrategy": { "$ref": "#/definitions/BalancingStrategy", @@ -402,15 +402,15 @@ }, "LaunchTemplate": { "$ref": "#/definitions/LaunchTemplate", - "description": "The EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group." + "description": "The EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource." }, "MaxSize": { "$ref": "#/definitions/MaxSize", - "description": "The maximum number of instances allowed in the EC2 Auto Scaling group." + "description": "The maximum number of instances allowed in the EC2 Auto Scaling group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource." }, "MinSize": { "$ref": "#/definitions/MinSize", - "description": "The minimum number of instances allowed in the EC2 Auto Scaling group." + "description": "The minimum number of instances allowed in the EC2 Auto Scaling group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource." }, "RoleArn": { "$ref": "#/definitions/RoleArn", @@ -418,11 +418,11 @@ }, "Tags": { "$ref": "#/definitions/Tags", - "description": "A list of labels to assign to the new game server group resource." + "description": "A list of labels to assign to the new game server group resource. Updating game server group tags with CloudFormation will not take effect. Please update this property using AWS GameLift APIs instead." }, "VpcSubnets": { "$ref": "#/definitions/VpcSubnets", - "description": "A list of virtual private cloud (VPC) subnets to use with instances in the game server group." + "description": "A list of virtual private cloud (VPC) subnets to use with instances in the game server group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource." } }, "readOnlyProperties": [ diff --git a/artifacts/types/AWS::GameLift::GameSessionQueue.json b/artifacts/types/AWS::GameLift::GameSessionQueue.json index 07564386..f75164ee 100644 --- a/artifacts/types/AWS::GameLift::GameSessionQueue.json +++ b/artifacts/types/AWS::GameLift::GameSessionQueue.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-GameLift-GameSessionQueue", "type": "AWS::GameLift::GameSessionQueue", - "time": "2024-01-04T19:43:44.218Z", + "time": "2024-06-20T20:05:31.581Z", "schema": { "$schema": "https://schema.cloudformation.us-east-1.amazonaws.com/provider.definition.schema.v1.json", "additionalProperties": false, @@ -46,7 +46,7 @@ }, "LocationOrder": { "description": "The prioritization order to use for fleet locations, when the PriorityOrder property includes LOCATION.", - "insertionOrder": false, + "insertionOrder": true, "items": { "maxLength": 64, "minLength": 1, @@ -88,7 +88,7 @@ }, "PriorityOrder": { "description": "The recommended sequence to use when prioritizing where to place new game sessions.", - "insertionOrder": false, + "insertionOrder": true, "items": { "enum": [ "LATENCY", @@ -181,7 +181,7 @@ }, "Destinations": { "description": "A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.", - "insertionOrder": false, + "insertionOrder": true, "items": { "$ref": "#/definitions/GameSessionQueueDestination" }, diff --git a/artifacts/types/AWS::GameLift::Location.json b/artifacts/types/AWS::GameLift::Location.json index d8a7bffe..d9a45823 100644 --- a/artifacts/types/AWS::GameLift::Location.json +++ b/artifacts/types/AWS::GameLift::Location.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-GameLift-Location", "type": "AWS::GameLift::Location", - "time": "2024-01-04T19:43:42.971Z", + "time": "2024-06-20T20:09:33.345Z", "schema": { "$schema": "https://schema.cloudformation.us-east-1.amazonaws.com/provider.definition.schema.v1.json", "additionalProperties": false, diff --git a/artifacts/types/AWS::GameLift::MatchmakingConfiguration.json b/artifacts/types/AWS::GameLift::MatchmakingConfiguration.json index f698500a..9a8ff1e4 100644 --- a/artifacts/types/AWS::GameLift::MatchmakingConfiguration.json +++ b/artifacts/types/AWS::GameLift::MatchmakingConfiguration.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-GameLift-MatchmakingConfiguration", "type": "AWS::GameLift::MatchmakingConfiguration", - "time": "2024-01-04T19:43:52.601Z", + "time": "2024-06-20T20:11:38.617Z", "schema": { "$schema": "https://schema.cloudformation.us-east-1.amazonaws.com/provider.definition.schema.v1.json", "additionalProperties": false, diff --git a/artifacts/types/AWS::GameLift::MatchmakingRuleSet.json b/artifacts/types/AWS::GameLift::MatchmakingRuleSet.json index 1ecaa693..1170fd08 100644 --- a/artifacts/types/AWS::GameLift::MatchmakingRuleSet.json +++ b/artifacts/types/AWS::GameLift::MatchmakingRuleSet.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-GameLift-MatchmakingRuleSet", "type": "AWS::GameLift::MatchmakingRuleSet", - "time": "2024-01-04T19:44:33.567Z", + "time": "2024-06-20T20:10:58.534Z", "schema": { "$schema": "https://schema.cloudformation.us-east-1.amazonaws.com/provider.definition.schema.v1.json", "additionalProperties": false, diff --git a/artifacts/types/AWS::GameLift::Script.json b/artifacts/types/AWS::GameLift::Script.json index 5d571926..fc9ea4de 100644 --- a/artifacts/types/AWS::GameLift::Script.json +++ b/artifacts/types/AWS::GameLift::Script.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-GameLift-Script", "type": "AWS::GameLift::Script", - "time": "2024-01-04T19:44:39.477Z", + "time": "2024-06-20T20:11:46.413Z", "schema": { "$schema": "https://schema.cloudformation.us-east-1.amazonaws.com/provider.definition.schema.v1.json", "additionalProperties": false, diff --git a/artifacts/types/AWS::GlobalAccelerator::Accelerator.json b/artifacts/types/AWS::GlobalAccelerator::Accelerator.json index 72172840..d27d5e0b 100644 --- a/artifacts/types/AWS::GlobalAccelerator::Accelerator.json +++ b/artifacts/types/AWS::GlobalAccelerator::Accelerator.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-GlobalAccelerator-Accelerator", "type": "AWS::GlobalAccelerator::Accelerator", - "time": "2023-12-26T17:07:55.334Z", + "time": "2024-05-07T15:34:57.78Z", "schema": { "additionalProperties": false, "definitions": { @@ -102,6 +102,7 @@ "IpAddresses": { "default": null, "description": "The IP addresses from BYOIP Prefix pool.", + "insertionOrder": true, "items": { "$ref": "#/definitions/IpAddress" }, @@ -109,6 +110,7 @@ }, "Ipv4Addresses": { "description": "The IPv4 addresses assigned to the accelerator.", + "insertionOrder": true, "items": { "type": "string" }, @@ -117,6 +119,7 @@ "Ipv6Addresses": { "default": null, "description": "The IPv6 addresses assigned if the accelerator is dualstack", + "insertionOrder": true, "items": { "type": "string" }, @@ -130,6 +133,7 @@ "type": "string" }, "Tags": { + "insertionOrder": true, "items": { "$ref": "#/definitions/Tag" }, @@ -147,6 +151,13 @@ "Name" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-globalaccelerator", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, "typeName": "AWS::GlobalAccelerator::Accelerator" } } \ No newline at end of file diff --git a/artifacts/types/AWS::GlobalAccelerator::CrossAccountAttachment.json b/artifacts/types/AWS::GlobalAccelerator::CrossAccountAttachment.json new file mode 100644 index 00000000..675b1369 --- /dev/null +++ b/artifacts/types/AWS::GlobalAccelerator::CrossAccountAttachment.json @@ -0,0 +1,137 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-GlobalAccelerator-CrossAccountAttachment", + "type": "AWS::GlobalAccelerator::CrossAccountAttachment", + "time": "2024-05-07T15:22:45.367Z", + "schema": { + "additionalProperties": false, + "definitions": { + "Resource": { + "additionalProperties": false, + "description": "ARN of resource to share.", + "properties": { + "EndpointId": { + "type": "string" + }, + "Region": { + "type": "string" + } + }, + "required": [ + "EndpointId" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "Tag is a key-value pair associated with Cross Account Attachment.", + "properties": { + "Key": { + "description": "Key of the tag. Value can be 1 to 127 characters.", + "maxLength": 127, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "Value for the tag. Value can be 1 to 255 characters.", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::GlobalAccelerator::CrossAccountAttachment", + "handlers": { + "create": { + "permissions": [ + "globalaccelerator:DescribeCrossAccountAttachment", + "globalaccelerator:CreateCrossAccountAttachment", + "globalaccelerator:TagResource" + ] + }, + "delete": { + "permissions": [ + "globalaccelerator:DescribeCrossAccountAttachment", + "globalaccelerator:DeleteCrossAccountAttachment" + ] + }, + "list": { + "permissions": [ + "globalaccelerator:ListCrossAccountAttachments" + ] + }, + "read": { + "permissions": [ + "globalaccelerator:DescribeCrossAccountAttachment" + ] + }, + "update": { + "permissions": [ + "globalaccelerator:UpdateCrossAccountAttachment", + "globalaccelerator:DescribeCrossAccountAttachment", + "globalaccelerator:TagResource", + "globalaccelerator:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/AttachmentArn" + ], + "properties": { + "AttachmentArn": { + "description": "The Amazon Resource Name (ARN) of the attachment.", + "type": "string" + }, + "Name": { + "description": "The Friendly identifier of the attachment.", + "maxLength": 64, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_-]{0,64}$", + "type": "string" + }, + "Principals": { + "description": "Principals to share the resources with.", + "items": { + "type": "string" + }, + "type": "array" + }, + "Resources": { + "description": "Resources shared using the attachment.", + "items": { + "$ref": "#/definitions/Resource" + }, + "type": "array" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/AttachmentArn" + ], + "required": [ + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-globalaccelerator", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::GlobalAccelerator::CrossAccountAttachment", + "writeOnlyProperties": [ + "/properties/Resources/*/Region" + ] + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::GlobalAccelerator::EndpointGroup.json b/artifacts/types/AWS::GlobalAccelerator::EndpointGroup.json index 633a5b48..3c309eae 100644 --- a/artifacts/types/AWS::GlobalAccelerator::EndpointGroup.json +++ b/artifacts/types/AWS::GlobalAccelerator::EndpointGroup.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-GlobalAccelerator-EndpointGroup", "type": "AWS::GlobalAccelerator::EndpointGroup", - "time": "2023-12-26T17:16:58.993Z", + "time": "2024-05-07T15:30:50.893Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -178,6 +178,9 @@ "EndpointGroupRegion" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-globalaccelerator", + "tagging": { + "taggable": false + }, "typeName": "AWS::GlobalAccelerator::EndpointGroup", "writeOnlyProperties": [ "/properties/EndpointConfigurations/*/AttachmentArn" diff --git a/artifacts/types/AWS::GlobalAccelerator::Listener.json b/artifacts/types/AWS::GlobalAccelerator::Listener.json index 20d6baab..022640ee 100644 --- a/artifacts/types/AWS::GlobalAccelerator::Listener.json +++ b/artifacts/types/AWS::GlobalAccelerator::Listener.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-GlobalAccelerator-Listener", "type": "AWS::GlobalAccelerator::Listener", - "time": "2023-12-26T17:02:53.367Z", + "time": "2024-05-07T15:29:12.383Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -112,6 +112,9 @@ "Protocol" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-globalaccelerator", + "tagging": { + "taggable": false + }, "typeName": "AWS::GlobalAccelerator::Listener" } } \ No newline at end of file diff --git a/artifacts/types/AWS::Glue::Registry.json b/artifacts/types/AWS::Glue::Registry.json index 15338e47..706a12e6 100644 --- a/artifacts/types/AWS::Glue::Registry.json +++ b/artifacts/types/AWS::Glue::Registry.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Glue-Registry", "type": "AWS::Glue::Registry", - "time": "2023-05-02T20:45:04.47Z", + "time": "2024-03-01T21:57:46.696Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -42,6 +42,7 @@ }, "delete": { "permissions": [ + "glue:GetRegistry", "glue:DeleteRegistry" ] }, diff --git a/artifacts/types/AWS::Glue::Schema.json b/artifacts/types/AWS::Glue::Schema.json index ce3fdf35..f56c609e 100644 --- a/artifacts/types/AWS::Glue::Schema.json +++ b/artifacts/types/AWS::Glue::Schema.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Glue-Schema", "type": "AWS::Glue::Schema", - "time": "2023-05-02T20:49:29.354Z", + "time": "2024-03-01T22:01:35.812Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Grafana::Workspace.json b/artifacts/types/AWS::Grafana::Workspace.json index 6fa57d48..1d159fa7 100644 --- a/artifacts/types/AWS::Grafana::Workspace.json +++ b/artifacts/types/AWS::Grafana::Workspace.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Grafana-Workspace", "type": "AWS::Grafana::Workspace", - "time": "2023-12-08T20:56:22.012Z", + "time": "2024-06-21T18:42:17.146Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::GreengrassV2::ComponentVersion.json b/artifacts/types/AWS::GreengrassV2::ComponentVersion.json index 21764425..af367f62 100644 --- a/artifacts/types/AWS::GreengrassV2::ComponentVersion.json +++ b/artifacts/types/AWS::GreengrassV2::ComponentVersion.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-GreengrassV2-ComponentVersion", "type": "AWS::GreengrassV2::ComponentVersion", - "time": "2023-10-03T15:24:24.1Z", + "time": "2024-02-06T22:32:41.111Z", "schema": { "additionalIdentifiers": [ [ diff --git a/artifacts/types/AWS::GreengrassV2::Deployment.json b/artifacts/types/AWS::GreengrassV2::Deployment.json index 0e1999ae..52be7405 100644 --- a/artifacts/types/AWS::GreengrassV2::Deployment.json +++ b/artifacts/types/AWS::GreengrassV2::Deployment.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-GreengrassV2-Deployment", "type": "AWS::GreengrassV2::Deployment", - "time": "2023-10-03T15:31:22.076Z", + "time": "2024-02-06T22:36:01.023Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::GroundStation::Config.json b/artifacts/types/AWS::GroundStation::Config.json index 9fafa710..637e3526 100644 --- a/artifacts/types/AWS::GroundStation::Config.json +++ b/artifacts/types/AWS::GroundStation::Config.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-GroundStation-Config", "type": "AWS::GroundStation::Config", - "time": "2024-01-03T17:50:35.834Z", + "time": "2024-06-03T15:51:29.843Z", "schema": { "additionalProperties": false, "definitions": { @@ -53,6 +53,7 @@ "type": "string" }, "BucketArn": { + "pattern": "^arn:aws[A-Za-z0-9-]{0,64}:s3:::[A-Za-z0-9-]{1,64}$", "type": "string" }, "ConfigData": { @@ -177,6 +178,7 @@ "type": "string" }, "RoleArn": { + "pattern": "^arn:[^:\\n]+:iam::[^:\\n]+:role\\/.+$", "type": "string" }, "S3KeyPrefix": { @@ -245,6 +247,7 @@ "additionalProperties": false, "properties": { "AntennaUplinkConfigArn": { + "pattern": "^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$", "type": "string" }, "Enabled": { @@ -306,6 +309,7 @@ ], "properties": { "Arn": { + "pattern": "^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$", "type": "string" }, "ConfigData": { diff --git a/artifacts/types/AWS::GroundStation::MissionProfile.json b/artifacts/types/AWS::GroundStation::MissionProfile.json index e005f4ec..2d9a01e1 100644 --- a/artifacts/types/AWS::GroundStation::MissionProfile.json +++ b/artifacts/types/AWS::GroundStation::MissionProfile.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-GroundStation-MissionProfile", "type": "AWS::GroundStation::MissionProfile", - "time": "2024-01-03T17:15:21.161Z", + "time": "2024-06-03T15:33:39.663Z", "schema": { "additionalProperties": false, "definitions": { @@ -33,9 +33,11 @@ ], "properties": { "KmsAliasArn": { + "pattern": "^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$", "type": "string" }, "KmsKeyArn": { + "pattern": "^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$", "type": "string" } }, @@ -110,6 +112,7 @@ ], "properties": { "Arn": { + "pattern": "^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$", "type": "string" }, "ContactPostPassDurationSeconds": { @@ -158,6 +161,7 @@ "type": "array" }, "TrackingConfigArn": { + "pattern": "^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$", "type": "string" } }, diff --git a/artifacts/types/AWS::GuardDuty::Detector.json b/artifacts/types/AWS::GuardDuty::Detector.json index b5442faa..29eb530d 100644 --- a/artifacts/types/AWS::GuardDuty::Detector.json +++ b/artifacts/types/AWS::GuardDuty::Detector.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-GuardDuty-Detector", "type": "AWS::GuardDuty::Detector", - "time": "2023-12-07T13:38:58.309Z", + "time": "2024-06-19T15:47:47.627Z", "schema": { "additionalProperties": false, "definitions": { diff --git a/artifacts/types/AWS::GuardDuty::Filter.json b/artifacts/types/AWS::GuardDuty::Filter.json new file mode 100644 index 00000000..f34955fd --- /dev/null +++ b/artifacts/types/AWS::GuardDuty::Filter.json @@ -0,0 +1,201 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-GuardDuty-Filter", + "type": "AWS::GuardDuty::Filter", + "time": "2024-06-18T21:30:18.566Z", + "schema": { + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DetectorId", + "/properties/Name" + ], + "definitions": { + "Condition": { + "additionalProperties": false, + "properties": { + "Eq": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "Equals": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "GreaterThan": { + "format": "int64", + "type": "integer" + }, + "GreaterThanOrEqual": { + "format": "int64", + "type": "integer" + }, + "Gt": { + "type": "integer" + }, + "Gte": { + "type": "integer" + }, + "LessThan": { + "format": "int64", + "type": "integer" + }, + "LessThanOrEqual": { + "format": "int64", + "type": "integer" + }, + "Lt": { + "type": "integer" + }, + "Lte": { + "type": "integer" + }, + "Neq": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + }, + "NotEquals": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "FindingCriteria": { + "additionalProperties": false, + "properties": { + "Criterion": { + "additionalProperties": false, + "patternProperties": { + "^.+$": { + "$ref": "#/definitions/Condition" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "TagItem": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::GuardDuty::Filter", + "handlers": { + "create": { + "permissions": [ + "guardduty:CreateFilter", + "guardduty:GetFilter", + "guardduty:TagResource" + ] + }, + "delete": { + "permissions": [ + "guardduty:ListDetectors", + "guardduty:ListFilters", + "guardduty:GetFilter", + "guardduty:DeleteFilter" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "DetectorId": { + "type": "string" + } + } + }, + "permissions": [ + "guardduty:ListFilters" + ] + }, + "read": { + "permissions": [ + "guardduty:GetFilter" + ] + }, + "update": { + "permissions": [ + "guardduty:UpdateFilter", + "guardduty:GetFilter", + "guardduty:ListFilters" + ] + } + }, + "primaryIdentifier": [ + "/properties/DetectorId", + "/properties/Name" + ], + "properties": { + "Action": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "DetectorId": { + "maxLength": 300, + "minLength": 1, + "type": "string" + }, + "FindingCriteria": { + "$ref": "#/definitions/FindingCriteria" + }, + "Name": { + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "Rank": { + "maximum": 100, + "minimum": 1, + "type": "integer" + }, + "Tags": { + "items": { + "$ref": "#/definitions/TagItem" + }, + "type": "array" + } + }, + "required": [ + "DetectorId", + "Name", + "FindingCriteria" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagUpdatable": false, + "taggable": true + }, + "typeName": "AWS::GuardDuty::Filter" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::GuardDuty::IPSet.json b/artifacts/types/AWS::GuardDuty::IPSet.json index 9f3c81ad..35f6f2b3 100644 --- a/artifacts/types/AWS::GuardDuty::IPSet.json +++ b/artifacts/types/AWS::GuardDuty::IPSet.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-GuardDuty-IPSet", "type": "AWS::GuardDuty::IPSet", - "time": "2023-12-05T16:26:28.054Z", + "time": "2024-06-21T20:51:23.943Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -117,8 +117,7 @@ ], "required": [ "Format", - "Location", - "Name" + "Location" ], "tagging": { "cloudFormationSystemTags": false, diff --git a/artifacts/types/AWS::GuardDuty::MalwareProtectionPlan.json b/artifacts/types/AWS::GuardDuty::MalwareProtectionPlan.json new file mode 100644 index 00000000..9cdfe47e --- /dev/null +++ b/artifacts/types/AWS::GuardDuty::MalwareProtectionPlan.json @@ -0,0 +1,188 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-GuardDuty-MalwareProtectionPlan", + "type": "AWS::GuardDuty::MalwareProtectionPlan", + "time": "2024-06-24T16:58:13.089Z", + "schema": { + "additionalProperties": false, + "definitions": { + "CFNActions": { + "additionalProperties": false, + "properties": { + "Tagging": { + "$ref": "#/definitions/CFNTagging", + "description": "Contains information about tagging status of the Malware Protection plan resource." + } + }, + "type": "object" + }, + "CFNProtectedResource": { + "additionalProperties": false, + "properties": { + "S3Bucket": { + "additionalProperties": false, + "description": "Information about the protected S3 bucket resource.", + "properties": { + "BucketName": { + "description": "Name of the S3 bucket.", + "type": "string" + }, + "ObjectPrefixes": { + "description": "Information about the specified object prefixes. The S3 object will be scanned only if it belongs to any of the specified object prefixes.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "required": [ + "S3Bucket" + ], + "type": "object" + }, + "CFNStatusReasons": { + "additionalProperties": false, + "properties": { + "Code": { + "description": "The status code of the Malware Protection plan.", + "type": "string" + }, + "Message": { + "description": "Issue message that specifies the reason.", + "type": "string" + } + }, + "type": "object" + }, + "CFNTagging": { + "additionalProperties": false, + "properties": { + "Status": { + "description": "Indicates whether or not you chose GuardDuty to add a predefined tag to the scanned S3 object.", + "type": "string" + } + }, + "type": "object" + }, + "TagItem": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::GuardDuty::MalwareProtectionPlan", + "handlers": { + "create": { + "permissions": [ + "guardduty:CreateMalwareProtectionPlan", + "guardduty:GetMalwareProtectionPlan", + "guardduty:TagResource", + "iam:PassRole" + ] + }, + "delete": { + "permissions": [ + "guardduty:DeleteMalwareProtectionPlan", + "guardduty:GetMalwareProtectionPlan" + ] + }, + "list": { + "permissions": [ + "guardduty:ListMalwareProtectionPlans" + ] + }, + "read": { + "permissions": [ + "guardduty:GetMalwareProtectionPlan" + ] + }, + "update": { + "permissions": [ + "guardduty:UpdateMalwareProtectionPlan", + "guardduty:GetMalwareProtectionPlan", + "guardduty:TagResource", + "guardduty:UntagResource", + "iam:PassRole" + ] + } + }, + "primaryIdentifier": [ + "/properties/MalwareProtectionPlanId" + ], + "properties": { + "Actions": { + "$ref": "#/definitions/CFNActions", + "description": "Specifies the action that is to be applied to the Malware Protection plan resource." + }, + "Arn": { + "description": "Amazon Resource Name (ARN) of the protected resource.", + "type": "string" + }, + "CreatedAt": { + "description": "The timestamp when the Malware Protection plan resource was created.", + "type": "string" + }, + "MalwareProtectionPlanId": { + "description": "A unique identifier associated with Malware Protection plan resource.", + "type": "string" + }, + "ProtectedResource": { + "$ref": "#/definitions/CFNProtectedResource", + "description": "Information about the protected resource. Presently, S3Bucket is the only supported protected resource." + }, + "Role": { + "description": "IAM role that includes the permissions required to scan and (optionally) add tags to the associated protected resource.", + "type": "string" + }, + "Status": { + "description": "Status of the Malware Protection plan resource.", + "type": "string" + }, + "StatusReasons": { + "description": "Status details associated with the Malware Protection plan resource status.", + "items": { + "$ref": "#/definitions/CFNStatusReasons" + }, + "type": "array" + }, + "Tags": { + "description": "The tags to be added to the created Malware Protection plan resource. Each tag consists of a key and an optional value, both of which you need to specify.", + "items": { + "$ref": "#/definitions/TagItem" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/MalwareProtectionPlanId", + "/properties/Arn", + "/properties/CreatedAt", + "/properties/Status", + "/properties/StatusReasons" + ], + "required": [ + "Role", + "ProtectedResource" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::GuardDuty::MalwareProtectionPlan" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::GuardDuty::Member.json b/artifacts/types/AWS::GuardDuty::Member.json new file mode 100644 index 00000000..388db09a --- /dev/null +++ b/artifacts/types/AWS::GuardDuty::Member.json @@ -0,0 +1,94 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-GuardDuty-Member", + "type": "AWS::GuardDuty::Member", + "time": "2024-05-22T16:06:18.825Z", + "schema": { + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DetectorId", + "/properties/MemberId" + ], + "description": "Resource Type definition for AWS::GuardDuty::Member", + "handlers": { + "create": { + "permissions": [ + "guardduty:CreateMembers", + "guardduty:GetMembers" + ] + }, + "delete": { + "permissions": [ + "guardduty:GetMembers", + "guardduty:DisassociateMembers", + "guardduty:DeleteMembers" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "DetectorId": { + "type": "string" + } + } + }, + "permissions": [ + "guardduty:ListMembers" + ] + }, + "read": { + "permissions": [ + "guardduty:GetMembers" + ] + }, + "update": { + "permissions": [ + "guardduty:GetMembers", + "guardduty:CreateMembers", + "guardduty:DisassociateMembers", + "guardduty:StartMonitoringMembers", + "guardduty:StopMonitoringMembers", + "guardduty:InviteMembers" + ] + } + }, + "primaryIdentifier": [ + "/properties/DetectorId", + "/properties/MemberId" + ], + "properties": { + "DetectorId": { + "type": "string" + }, + "DisableEmailNotification": { + "type": "boolean" + }, + "Email": { + "type": "string" + }, + "MemberId": { + "type": "string" + }, + "Message": { + "type": "string" + }, + "Status": { + "type": "string" + } + }, + "required": [ + "Email" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-guardduty", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::GuardDuty::Member", + "writeOnlyProperties": [ + "/properties/DisableEmailNotification", + "/properties/Message" + ] + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::GuardDuty::ThreatIntelSet.json b/artifacts/types/AWS::GuardDuty::ThreatIntelSet.json index 86ae3be3..4ef3db4c 100644 --- a/artifacts/types/AWS::GuardDuty::ThreatIntelSet.json +++ b/artifacts/types/AWS::GuardDuty::ThreatIntelSet.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-GuardDuty-ThreatIntelSet", "type": "AWS::GuardDuty::ThreatIntelSet", - "time": "2023-12-04T13:51:16.533Z", + "time": "2024-05-21T15:36:12.844Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -116,8 +116,7 @@ ], "required": [ "Format", - "Location", - "Name" + "Location" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-guardduty", "tagging": { diff --git a/artifacts/types/AWS::HealthLake::FHIRDatastore.json b/artifacts/types/AWS::HealthLake::FHIRDatastore.json index 51e8e95d..ec6e080c 100644 --- a/artifacts/types/AWS::HealthLake::FHIRDatastore.json +++ b/artifacts/types/AWS::HealthLake::FHIRDatastore.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-HealthLake-FHIRDatastore", "type": "AWS::HealthLake::FHIRDatastore", - "time": "2023-12-26T16:12:55.459Z", + "time": "2024-06-03T15:18:59.505Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -9,7 +9,6 @@ "/properties/DatastoreTypeVersion", "/properties/PreloadDataConfig", "/properties/SseConfiguration", - "/properties/KmsEncryptionConfig", "/properties/IdentityProviderConfiguration" ], "definitions": { diff --git a/artifacts/types/AWS::IAM::Group.json b/artifacts/types/AWS::IAM::Group.json index 594e5c66..15159aab 100644 --- a/artifacts/types/AWS::IAM::Group.json +++ b/artifacts/types/AWS::IAM::Group.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IAM-Group", "type": "AWS::IAM::Group", - "time": "2023-10-19T15:22:55.262Z", + "time": "2024-03-13T15:45:19.146Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -10,6 +10,7 @@ "definitions": { "Policy": { "additionalProperties": false, + "description": "Contains information about an attached policy.\n An attached policy is a managed policy that has been attached to a user, group, or role.\n For more information about managed policies, see [Managed Policies and Inline Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *User Guide*.", "properties": { "PolicyDocument": { "description": "The policy document.", @@ -30,7 +31,7 @@ "type": "object" } }, - "description": "Resource Type definition for AWS::IAM::Group", + "description": "Creates a new group.\n For information about the number of groups you can create, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*.", "handlers": { "create": { "permissions": [ @@ -82,15 +83,15 @@ ], "properties": { "Arn": { - "description": "The Arn of the group to create", + "description": "", "type": "string" }, "GroupName": { - "description": "The name of the group to create", + "description": "The name of the group to create. Do not include the path in this value.\n The group name must be unique within the account. Group names are not distinguished by case. For example, you cannot create groups named both \"ADMINS\" and \"admins\". If you don't specify a name, CFN generates a unique physical ID and uses that ID for the group name.\n If 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 If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities).\n Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using ``Fn::Join`` and ``AWS::Region`` to create a Region-specific name, as in the following example: ``{\"Fn::Join\": [\"\", [{\"Ref\": \"AWS::Region\"}, {\"Ref\": \"MyResourceName\"}]]}``.", "type": "string" }, "ManagedPolicyArns": { - "description": "A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the role. ", + "description": "The Amazon Resource Name (ARN) of the IAM policy you want to attach.\n For more information about ARNs, see [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*.", "insertionOrder": false, "items": { "type": "string" @@ -99,11 +100,11 @@ "uniqueItems": true }, "Path": { - "description": "The path to the group", + "description": "The path to the group. For more information about paths, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*.\n This parameter is optional. If it is not included, it defaults to a slash (/).\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\\u0021``) through the DEL character (``\\u007F``), including most punctuation characters, digits, and upper and lowercased letters.", "type": "string" }, "Policies": { - "description": "Adds or updates an inline policy document that is embedded in the specified IAM group", + "description": "Adds or updates an inline policy document that is embedded in the specified IAM group. To view AWS::IAM::Group snippets, see [Declaring an Group Resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-iam-group).\n The name of each inline policy for a role, user, or group must be unique. If you don't choose unique names, updates to the IAM identity will fail. \n For information about limits on the number of inline policies that you can embed in a group, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*.", "insertionOrder": false, "items": { "$ref": "#/definitions/Policy" diff --git a/artifacts/types/AWS::IAM::GroupPolicy.json b/artifacts/types/AWS::IAM::GroupPolicy.json index 86a29847..6a36d7c0 100644 --- a/artifacts/types/AWS::IAM::GroupPolicy.json +++ b/artifacts/types/AWS::IAM::GroupPolicy.json @@ -1,14 +1,14 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IAM-GroupPolicy", "type": "AWS::IAM::GroupPolicy", - "time": "2023-11-13T17:21:54.972Z", + "time": "2024-05-02T15:46:20.075Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ "/properties/PolicyName", "/properties/GroupName" ], - "description": "Schema for IAM Group Policy", + "description": "Adds or updates an inline policy document that is embedded in the specified IAM group.\n A group can also have managed policies attached to it. To attach a managed policy to a group, 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 policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *IAM User Guide*.\n For information about the maximum number of inline policies that you can embed in a group, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*.", "handlers": { "create": { "permissions": [ @@ -40,15 +40,15 @@ ], "properties": { "GroupName": { - "description": "The name of the group to associate the policy with.", + "description": "The name of the group to associate the policy with.\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-.", "type": "string" }, "PolicyDocument": { - "description": "The policy document.", + "description": "The policy document.\n You must provide policies in JSON format in IAM. However, for CFN templates formatted in YAML, you can provide the policy in JSON or YAML format. CFN always converts a YAML policy to JSON format before submitting it to IAM.\n The [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) used to validate this parameter is a string of characters consisting of the following:\n + Any printable ASCII 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 (through ``\\u00FF``)\n + The special characters tab (``\\u0009``), line feed (``\\u000A``), and carriage return (``\\u000D``)", "type": "object" }, "PolicyName": { - "description": "The name of the policy document.", + "description": "The name of the policy document.\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-", "type": "string" } }, diff --git a/artifacts/types/AWS::IAM::InstanceProfile.json b/artifacts/types/AWS::IAM::InstanceProfile.json index 444a0d31..f28b7c19 100644 --- a/artifacts/types/AWS::IAM::InstanceProfile.json +++ b/artifacts/types/AWS::IAM::InstanceProfile.json @@ -1,14 +1,14 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IAM-InstanceProfile", "type": "AWS::IAM::InstanceProfile", - "time": "2023-11-15T16:15:24.555Z", + "time": "2024-02-27T16:36:19.198Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ "/properties/InstanceProfileName", "/properties/Path" ], - "description": "Resource Type definition for AWS::IAM::InstanceProfile", + "description": "Creates a new instance profile. For information about instance profiles, see [Using instance profiles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html).\n For information about the number of instance profiles you can create, see [object quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *User Guide*.", "handlers": { "create": { "permissions": [ @@ -49,15 +49,15 @@ ], "properties": { "Arn": { - "description": "The Amazon Resource Name (ARN) of the instance profile.", + "description": "", "type": "string" }, "InstanceProfileName": { - "description": "The name of the instance profile to create.", + "description": "The name of the instance profile to create.\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-", "type": "string" }, "Path": { - "description": "The path to the instance profile.", + "description": "The path to the instance profile. For more information about paths, see [IAM Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*.\n This parameter is optional. If it is not included, it defaults to a slash (/).\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\\u0021``) through the DEL character (``\\u007F``), including most punctuation characters, digits, and upper and lowercased letters.", "type": "string" }, "Roles": { diff --git a/artifacts/types/AWS::IAM::ManagedPolicy.json b/artifacts/types/AWS::IAM::ManagedPolicy.json index 6f5a7561..7c6b0668 100644 --- a/artifacts/types/AWS::IAM::ManagedPolicy.json +++ b/artifacts/types/AWS::IAM::ManagedPolicy.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IAM-ManagedPolicy", "type": "AWS::IAM::ManagedPolicy", - "time": "2023-08-21T22:56:05.318Z", + "time": "2024-05-02T19:45:10.077Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -9,7 +9,7 @@ "/properties/Description", "/properties/Path" ], - "description": "Resource Type definition for AWS::IAM::ManagedPolicy", + "description": "Creates a new managed policy for your AWS-account.\n This operation creates a policy version with a version identifier of ``v1`` and sets v1 as the policy's default version. For more information about policy versions, see [Versioning for managed policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html) in the *IAM User Guide*.\n As a best practice, you can validate your IAM policies. To learn more, see [Validating IAM policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html) in the *IAM User Guide*.\n For more information about managed policies in general, see [Managed policies and inline policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *IAM User Guide*.", "handlers": { "create": { "permissions": [ @@ -63,23 +63,23 @@ ], "properties": { "AttachmentCount": { - "description": "The number of entities (users, groups, and roles) that the policy is attached to.", + "description": "", "type": "integer" }, "CreateDate": { - "description": "The date and time, in ISO 8601 date-time format, when the policy was created.", + "description": "", "type": "string" }, "DefaultVersionId": { - "description": "The identifier for the version of the policy that is set as the default version.", + "description": "", "type": "string" }, "Description": { - "description": "A friendly description of the policy.", + "description": "A friendly description of the policy.\n Typically used to store information about the permissions defined in the policy. For example, \"Grants access to production DynamoDB tables.\"\n The policy description is immutable. After a value is assigned, it cannot be changed.", "type": "string" }, "Groups": { - "description": "The name (friendly name, not ARN) of the group to attach the policy to.", + "description": "The name (friendly name, not ARN) of the group to attach the policy to.\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-", "insertionOrder": false, "items": { "type": "string" @@ -88,38 +88,39 @@ "uniqueItems": true }, "IsAttachable": { - "description": "Specifies whether the policy can be attached to an IAM user, group, or role.", + "description": "", "type": "boolean" }, "ManagedPolicyName": { - "description": "The friendly name of the policy.", + "description": "The friendly name of the policy.\n If 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 If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities).\n Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using ``Fn::Join`` and ``AWS::Region`` to create a Region-specific name, as in the following example: ``{\"Fn::Join\": [\"\", [{\"Ref\": \"AWS::Region\"}, {\"Ref\": \"MyResourceName\"}]]}``.", "type": "string" }, "Path": { - "description": "The path for the policy.", + "default": "/", + "description": "The path for the policy.\n For more information about paths, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*.\n This parameter is optional. If it is not included, it defaults to a slash (/).\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\\u0021``) through the DEL character (``\\u007F``), including most punctuation characters, digits, and upper and lowercased letters.\n You cannot use an asterisk (*) in the path name.", "type": "string" }, "PermissionsBoundaryUsageCount": { - "description": "The number of entities (users and roles) for which the policy is used to set the permissions boundary.", + "description": "", "type": "integer" }, "PolicyArn": { - "description": "Amazon Resource Name (ARN) of the managed policy", + "description": "", "type": "string" }, "PolicyDocument": { - "description": "The JSON policy document that you want to use as the content for the new policy.", + "description": "The JSON policy document that you want to use as the content for the new policy.\n You must provide policies in JSON format in IAM. However, for CFN templates formatted in YAML, you can provide the policy in JSON or YAML format. CFN always converts a YAML policy to JSON format before submitting it to IAM.\n The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see [IAM and character quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length).\n To learn more about JSON policy grammar, see [Grammar of the IAM JSON policy language](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_grammar.html) in the *IAM User Guide*. \n The [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) used to validate this parameter is a string of characters consisting of the following:\n + Any printable ASCII 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 (through ``\\u00FF``)\n + The special characters tab (``\\u0009``), line feed (``\\u000A``), and carriage return (``\\u000D``)", "type": [ "object", "string" ] }, "PolicyId": { - "description": "The stable and unique string identifying the policy.", + "description": "", "type": "string" }, "Roles": { - "description": "The name (friendly name, not ARN) of the role to attach the policy to.", + "description": "The name (friendly name, not ARN) of the role to attach the policy to.\n This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-\n If an external policy (such as ``AWS::IAM::Policy`` or ``AWS::IAM::ManagedPolicy``) has a ``Ref`` to a role and if a resource (such as ``AWS::ECS::Service``) also has a ``Ref`` to the same role, add a ``DependsOn`` attribute to the resource to make the resource depend on the external policy. This dependency ensures that the role's policy is available throughout the resource's lifecycle. For example, when you delete a stack with an ``AWS::ECS::Service`` resource, the ``DependsOn`` attribute ensures that CFN deletes the ``AWS::ECS::Service`` resource before deleting its role's policy.", "insertionOrder": false, "items": { "type": "string" @@ -128,11 +129,11 @@ "uniqueItems": true }, "UpdateDate": { - "description": "The date and time, in ISO 8601 date-time format, when the policy was last updated.", + "description": "", "type": "string" }, "Users": { - "description": "The name (friendly name, not ARN) of the IAM user to attach the policy to.", + "description": "The name (friendly name, not ARN) of the IAM user to attach the policy to.\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-", "insertionOrder": false, "items": { "type": "string" diff --git a/artifacts/types/AWS::IAM::OIDCProvider.json b/artifacts/types/AWS::IAM::OIDCProvider.json index f80faf1d..18f56741 100644 --- a/artifacts/types/AWS::IAM::OIDCProvider.json +++ b/artifacts/types/AWS::IAM::OIDCProvider.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IAM-OIDCProvider", "type": "AWS::IAM::OIDCProvider", - "time": "2022-12-12T23:49:19.417Z", + "time": "2024-06-20T15:43:50.166Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -37,6 +37,7 @@ "create": { "permissions": [ "iam:CreateOpenIDConnectProvider", + "iam:TagOpenIDConnectProvider", "iam:GetOpenIDConnectProvider" ] }, diff --git a/artifacts/types/AWS::IAM::Role.json b/artifacts/types/AWS::IAM::Role.json index 32977633..44b87c33 100644 --- a/artifacts/types/AWS::IAM::Role.json +++ b/artifacts/types/AWS::IAM::Role.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IAM-Role", "type": "AWS::IAM::Role", - "time": "2023-11-15T16:35:34.646Z", + "time": "2024-02-27T16:59:28.365Z", "schema": { "$schema": "https://raw.githubusercontent.com/aws-cloudformation/cloudformation-resource-schema/master/src/main/resources/schema/provider.definition.schema.v1.json", "additionalProperties": false, @@ -12,10 +12,10 @@ "definitions": { "Policy": { "additionalProperties": false, - "description": "The inline policy document that is embedded in the specified IAM role.", + "description": "Contains information about an attached policy.\n An attached policy is a managed policy that has been attached to a user, group, or role.\n For more information about managed policies, refer to [Managed Policies and Inline Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *User Guide*.", "properties": { "PolicyDocument": { - "description": "The policy document.", + "description": "The entire contents of the policy that defines permissions. For more information, see [Overview of JSON policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json).", "type": [ "string", "object" @@ -34,14 +34,14 @@ }, "Tag": { "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", + "description": "A structure that represents user-provided metadata that can be associated with an IAM resource. For more information about tagging, see [Tagging IAM resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the *IAM User Guide*.", "properties": { "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "description": "The key name that can be used to look up or retrieve the associated value. For example, ``Department`` or ``Cost Center`` are common choices.", "type": "string" }, "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "description": "The value associated with this tag. For example, tags with a key name of ``Department`` could have values such as ``Human Resources``, ``Accounting``, and ``Support``. Tags with a key name of ``Cost Center`` might have values that consist of the number associated with the different cost centers in your company. Typically, many resources have tags with the same key name but with different values.\n AWS always interprets the tag ``Value`` as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.", "type": "string" } }, @@ -52,7 +52,7 @@ "type": "object" } }, - "description": "Resource Type definition for AWS::IAM::Role", + "description": "Creates a new role for your AWS-account.\n For more information about roles, see [IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) in the *IAM User Guide*. For information about quotas for role names and the number of roles you can create, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*.", "handlers": { "create": { "permissions": [ @@ -111,11 +111,11 @@ ], "properties": { "Arn": { - "description": "The Amazon Resource Name (ARN) for the role.", + "description": "", "type": "string" }, "AssumeRolePolicyDocument": { - "description": "The trust policy that is associated with this role.", + "description": "The trust policy that is associated with this role. Trust policies define which entities can assume the role. You can associate only one trust policy with a role. For an example of a policy that can be used to assume a role, see [Template Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#aws-resource-iam-role--examples). For more information about the elements that you can use in an IAM policy, see [Policy Elements Reference](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements.html) in the *User Guide*.", "type": [ "object", "string" @@ -126,7 +126,7 @@ "type": "string" }, "ManagedPolicyArns": { - "description": "A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the role. ", + "description": "A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the role.\n For more information about ARNs, see [Amazon Resource Names (ARNs) and Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*.", "insertionOrder": false, "items": { "type": "string" @@ -135,20 +135,20 @@ "uniqueItems": true }, "MaxSessionDuration": { - "description": "The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default maximum of one hour is applied. This setting can have a value from 1 hour to 12 hours. ", + "description": "The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default value of one hour is applied. This setting can have a value from 1 hour to 12 hours.\n Anyone who assumes the role from the CLI or API can use the ``DurationSeconds`` API parameter or the ``duration-seconds`` CLI parameter to request a longer session. The ``MaxSessionDuration`` setting determines the maximum duration that can be requested using the ``DurationSeconds`` parameter. If users don't specify a value for the ``DurationSeconds`` parameter, their security credentials are valid for one hour by default. This applies when you use the ``AssumeRole*`` API operations or the ``assume-role*`` CLI operations but does not apply when you use those operations to create a console URL. For more information, see [Using IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html) in the *IAM User Guide*.", "type": "integer" }, "Path": { "default": "/", - "description": "The path to the role.", + "description": "The path to the role. For more information about paths, see [IAM Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*.\n This parameter is optional. If it is not included, it defaults to a slash (/).\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\\u0021``) through the DEL character (``\\u007F``), including most punctuation characters, digits, and upper and lowercased letters.", "type": "string" }, "PermissionsBoundary": { - "description": "The ARN of the policy used to set the permissions boundary for the role.", + "description": "The ARN of the policy used to set the permissions boundary for the role.\n For more information about permissions boundaries, see [Permissions boundaries for IAM identities](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) in the *IAM User Guide*.", "type": "string" }, "Policies": { - "description": "Adds or updates an inline policy document that is embedded in the specified IAM role. ", + "description": "Adds or updates an inline policy document that is embedded in the specified IAM role.\n When you embed an inline policy in a role, the inline policy is used as part of the role's access (permissions) policy. The role's trust policy is created at the same time as the role. You can update a role's trust policy later. For more information about IAM roles, go to [Using Roles to Delegate Permissions and Federate Identities](https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html).\n A role can also have an attached managed policy. For information about policies, see [Managed Policies and Inline Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *User Guide*.\n For information about limits on the number of inline policies that you can embed with a role, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*.\n If an external policy (such as ``AWS::IAM::Policy`` or", "insertionOrder": false, "items": { "$ref": "#/definitions/Policy" @@ -157,15 +157,15 @@ "uniqueItems": false }, "RoleId": { - "description": "The stable and unique string identifying the role.", + "description": "", "type": "string" }, "RoleName": { - "description": "A name for the IAM role, up to 64 characters in length.", + "description": "A name for the IAM role, up to 64 characters in length. For valid values, see the ``RoleName`` parameter for the [CreateRole](https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html) action in the *User Guide*.\n This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. The role name must be unique within the account. Role names are not distinguished by case. For example, you cannot create roles named both \"Role1\" and \"role1\".\n If you don't specify a name, CFN generates a unique physical ID and uses that ID for the role name.\n If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/Use", "type": "string" }, "Tags": { - "description": "A list of tags that are attached to the role.", + "description": "A list of tags that are attached to the role. For more information about tagging, see [Tagging IAM resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the *IAM User Guide*.", "insertionOrder": false, "items": { "$ref": "#/definitions/Tag" diff --git a/artifacts/types/AWS::IAM::RolePolicy.json b/artifacts/types/AWS::IAM::RolePolicy.json index 21a1897d..fbc328df 100644 --- a/artifacts/types/AWS::IAM::RolePolicy.json +++ b/artifacts/types/AWS::IAM::RolePolicy.json @@ -1,14 +1,14 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IAM-RolePolicy", "type": "AWS::IAM::RolePolicy", - "time": "2023-11-14T17:17:07.172Z", + "time": "2024-05-02T16:21:32.154Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ "/properties/PolicyName", "/properties/RoleName" ], - "description": "Schema for IAM Role Policy", + "description": "Adds or updates an inline policy document that is embedded in the specified IAM role.\n When you embed an inline policy in a role, the inline policy is used as part of the role's access (permissions) policy. The role's trust policy is created at the same time as the role, 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 [roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html) in the *IAM User Guide*.\n A role can also have a managed policy attached to it. To attach a managed policy to a role, 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 policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *IAM User Guide*.\n For information about the maximum number of inline policies that you can embed with a role, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*.", "handlers": { "create": { "permissions": [ @@ -40,15 +40,15 @@ ], "properties": { "PolicyDocument": { - "description": "The policy document.", + "description": "The policy document.\n You must provide policies in JSON format in IAM. However, for CFN templates formatted in YAML, you can provide the policy in JSON or YAML format. CFN always converts a YAML policy to JSON format before submitting it to IAM.\n The [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) used to validate this parameter is a string of characters consisting of the following:\n + Any printable ASCII 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 (through ``\\u00FF``)\n + The special characters tab (``\\u0009``), line feed (``\\u000A``), and carriage return (``\\u000D``)", "type": "object" }, "PolicyName": { - "description": "The friendly name (not ARN) identifying the policy.", + "description": "The name of the policy document.\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-", "type": "string" }, "RoleName": { - "description": "The name of the policy document.", + "description": "The name of the role to associate the policy with.\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-", "type": "string" } }, diff --git a/artifacts/types/AWS::IAM::SAMLProvider.json b/artifacts/types/AWS::IAM::SAMLProvider.json index f107c629..f4882081 100644 --- a/artifacts/types/AWS::IAM::SAMLProvider.json +++ b/artifacts/types/AWS::IAM::SAMLProvider.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IAM-SAMLProvider", "type": "AWS::IAM::SAMLProvider", - "time": "2022-12-13T03:34:50.607Z", + "time": "2024-06-20T15:43:22.308Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -37,7 +37,8 @@ "create": { "permissions": [ "iam:CreateSAMLProvider", - "iam:GetSAMLProvider" + "iam:GetSAMLProvider", + "iam:TagSAMLProvider" ] }, "delete": { @@ -61,6 +62,7 @@ "iam:UpdateSAMLProvider", "iam:GetSAMLProvider", "iam:TagSAMLProvider", + "iam:ListSAMLProviderTags", "iam:UntagSAMLProvider" ] } diff --git a/artifacts/types/AWS::IAM::ServerCertificate.json b/artifacts/types/AWS::IAM::ServerCertificate.json index adfc8cde..4af3ff8e 100644 --- a/artifacts/types/AWS::IAM::ServerCertificate.json +++ b/artifacts/types/AWS::IAM::ServerCertificate.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IAM-ServerCertificate", "type": "AWS::IAM::ServerCertificate", - "time": "2022-12-13T03:34:51.529Z", + "time": "2024-06-20T16:00:53.776Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -40,6 +40,7 @@ "create": { "permissions": [ "iam:UploadServerCertificate", + "iam:TagServerCertificate", "iam:GetServerCertificate" ] }, @@ -62,7 +63,9 @@ "update": { "permissions": [ "iam:TagServerCertificate", - "iam:UntagServerCertificate" + "iam:UntagServerCertificate", + "iam:ListServerCertificateTags", + "iam:GetServerCertificate" ] } }, diff --git a/artifacts/types/AWS::IAM::ServiceLinkedRole.json b/artifacts/types/AWS::IAM::ServiceLinkedRole.json index 64a25d24..9707bb4b 100644 --- a/artifacts/types/AWS::IAM::ServiceLinkedRole.json +++ b/artifacts/types/AWS::IAM::ServiceLinkedRole.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IAM-ServiceLinkedRole", "type": "AWS::IAM::ServiceLinkedRole", - "time": "2023-11-13T16:41:50.905Z", + "time": "2024-02-20T19:05:09.877Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::IAM::User.json b/artifacts/types/AWS::IAM::User.json index 32bd615b..c2cfa03b 100644 --- a/artifacts/types/AWS::IAM::User.json +++ b/artifacts/types/AWS::IAM::User.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IAM-User", "type": "AWS::IAM::User", - "time": "2023-12-08T20:24:06.996Z", + "time": "2024-04-12T18:33:59.424Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -10,7 +10,7 @@ "definitions": { "LoginProfile": { "additionalProperties": false, - "description": "Contains the user name and password create date for a user.", + "description": "Creates a password for the specified user, giving the user the ability to access AWS services through the console. For more information about managing passwords, see [Managing Passwords](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html) in the *User Guide*.", "properties": { "Password": { "description": "The user's password.", @@ -28,10 +28,10 @@ }, "Policy": { "additionalProperties": false, - "description": "Contains information about an attached policy.", + "description": "Contains information about an attached policy.\n An attached policy is a managed policy that has been attached to a user, group, or role.\n For more information about managed policies, refer to [Managed Policies and Inline Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *User Guide*.", "properties": { "PolicyDocument": { - "description": "The policy document.", + "description": "The entire contents of the policy that defines permissions. For more information, see [Overview of JSON policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json).", "type": [ "object", "string" @@ -50,14 +50,14 @@ }, "Tag": { "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", + "description": "A structure that represents user-provided metadata that can be associated with an IAM resource. For more information about tagging, see [Tagging IAM resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the *IAM User Guide*.", "properties": { "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "description": "The key name that can be used to look up or retrieve the associated value. For example, ``Department`` or ``Cost Center`` are common choices.", "type": "string" }, "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "description": "The value associated with this tag. For example, tags with a key name of ``Department`` could have values such as ``Human Resources``, ``Accounting``, and ``Support``. Tags with a key name of ``Cost Center`` might have values that consist of the number associated with the different cost centers in your company. Typically, many resources have tags with the same key name but with different values.\n AWS always interprets the tag ``Value`` as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.", "type": "string" } }, @@ -68,7 +68,7 @@ "type": "object" } }, - "description": "Resource Type definition for AWS::IAM::User", + "description": "Creates a new IAM user for your AWS-account.\n For information about quotas for the number of IAM users you can create, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*.", "handlers": { "create": { "permissions": [ @@ -140,7 +140,7 @@ ], "properties": { "Arn": { - "description": "The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the IAM User Guide.", + "description": "", "type": "string" }, "Groups": { @@ -154,10 +154,10 @@ }, "LoginProfile": { "$ref": "#/definitions/LoginProfile", - "description": "Creates a password for the specified IAM user. A password allows an IAM user to access AWS services through the AWS Management Console." + "description": "Creates a password for the specified IAM user. A password allows an IAM user to access AWS services through the console.\n You can use the CLI, the AWS API, or the *Users* page in the IAM console to create a password for any IAM user. Use [ChangePassword](https://docs.aws.amazon.com/IAM/latest/APIReference/API_ChangePassword.html) to update your own existing password in the *My Security Credentials* page in the console.\n For more information about managing passwords, see [Managing passwords](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html) in the *User Guide*." }, "ManagedPolicyArns": { - "description": "A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the role.", + "description": "A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the user.\n For more information about ARNs, see [Amazon Resource Names (ARNs) and Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*.", "insertionOrder": false, "items": { "type": "string" @@ -166,15 +166,15 @@ "uniqueItems": true }, "Path": { - "description": "The path to the user. For more information about paths, see IAM identifiers in the IAM User Guide. The ARN of the policy used to set the permissions boundary for the user.", + "description": "The path for the user name. For more information about paths, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*.\n This parameter is optional. If it is not included, it defaults to a slash (/).\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\\u0021``) through the DEL character (``\\u007F``), including most punctuation characters, digits, and upper and lowercased letters.", "type": "string" }, "PermissionsBoundary": { - "description": "The ARN of the policy that is used to set the permissions boundary for the user.", + "description": "The ARN of the managed policy that is used to set the permissions boundary for the user.\n A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a resource-based policy can grant to an entity. To learn more, see [Permissions boundaries for IAM entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) in the *IAM User Guide*.\n For 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*.", "type": "string" }, "Policies": { - "description": "Adds or updates an inline policy document that is embedded in the specified IAM role.", + "description": "Adds or updates an inline policy document that is embedded in the specified IAM user. To view AWS::IAM::User snippets, see [Declaring an User Resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-iam-user).\n The name of each policy for a role, user, or group must be unique. If you don't choose unique names, updates to the IAM identity will fail. \n For information about limits on the number of inline policies that you can embed in a user, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*.", "insertionOrder": false, "items": { "$ref": "#/definitions/Policy" @@ -183,7 +183,7 @@ "uniqueItems": false }, "Tags": { - "description": "A list of tags that are associated with the user. For more information about tagging, see Tagging IAM resources in the IAM User Guide.", + "description": "A list of tags that you want to attach to the new user. Each tag consists of a key name and an associated value. For more information about tagging, see [Tagging IAM resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the *IAM User Guide*.\n If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.", "insertionOrder": false, "items": { "$ref": "#/definitions/Tag" @@ -192,7 +192,7 @@ "uniqueItems": false }, "UserName": { - "description": "The friendly name identifying the user.", + "description": "The name of the user to create. Do not include the path in this value.\n This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. The user name must be unique within the account. User names are not distinguished by case. For example, you cannot create users named both \"John\" and \"john\".\n If you don't specify a name, CFN generates a unique physical ID and uses that ID for the user name.\n If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities).\n Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using ``Fn::Join`` and ``AWS::Region`` to create a Region-specific name, as in the following example: ``{\"Fn::Join\": [\"\", [{\"Ref\": \"AWS::Region\"}, {\"Ref\": \"MyResourceName\"}]]}``.", "type": "string" } }, diff --git a/artifacts/types/AWS::IAM::UserPolicy.json b/artifacts/types/AWS::IAM::UserPolicy.json index 642ad04d..89971656 100644 --- a/artifacts/types/AWS::IAM::UserPolicy.json +++ b/artifacts/types/AWS::IAM::UserPolicy.json @@ -1,14 +1,14 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IAM-UserPolicy", "type": "AWS::IAM::UserPolicy", - "time": "2023-12-05T18:11:21.812Z", + "time": "2024-05-21T15:45:56.087Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ "/properties/PolicyName", "/properties/UserName" ], - "description": "Schema for IAM User Policy", + "description": "Adds or updates an inline policy document that is embedded in the specified IAM user.\n An IAM user can also have a managed policy attached to it. To attach a managed policy to a 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 policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *IAM User Guide*.\n For information about the maximum number of inline policies that you can embed in a user, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*.", "handlers": { "create": { "permissions": [ @@ -40,15 +40,15 @@ ], "properties": { "PolicyDocument": { - "description": "The policy document.", + "description": "The policy document.\n You must provide policies in JSON format in IAM. However, for CFN templates formatted in YAML, you can provide the policy in JSON or YAML format. CFN always converts a YAML policy to JSON format before submitting it to IAM.\n The [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) used to validate this parameter is a string of characters consisting of the following:\n + Any printable ASCII 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 (through ``\\u00FF``)\n + The special characters tab (``\\u0009``), line feed (``\\u000A``), and carriage return (``\\u000D``)", "type": "object" }, "PolicyName": { - "description": "The name of the policy document.", + "description": "The name of the policy document.\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-", "type": "string" }, "UserName": { - "description": "The name of the user to associate the policy with.", + "description": "The name of the user to associate the policy with.\n This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-", "type": "string" } }, diff --git a/artifacts/types/AWS::IVS::Channel.json b/artifacts/types/AWS::IVS::Channel.json index 0c3c97bc..00bad007 100644 --- a/artifacts/types/AWS::IVS::Channel.json +++ b/artifacts/types/AWS::IVS::Channel.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IVS-Channel", "type": "AWS::IVS::Channel", - "time": "2024-01-04T16:30:20.944Z", + "time": "2024-04-25T15:34:37.154Z", "schema": { "additionalProperties": false, "definitions": { @@ -153,6 +153,13 @@ ], "required": [], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, "typeName": "AWS::IVS::Channel" } } \ No newline at end of file diff --git a/artifacts/types/AWS::IVS::EncoderConfiguration.json b/artifacts/types/AWS::IVS::EncoderConfiguration.json new file mode 100644 index 00000000..8da5147f --- /dev/null +++ b/artifacts/types/AWS::IVS::EncoderConfiguration.json @@ -0,0 +1,153 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IVS-EncoderConfiguration", + "type": "AWS::IVS::EncoderConfiguration", + "time": "2024-04-25T15:34:32.506Z", + "schema": { + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/Video", + "/properties/Video/Bitrate", + "/properties/Video/Framerate", + "/properties/Video/Height", + "/properties/Video/Width" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::IVS::EncoderConfiguration.", + "handlers": { + "create": { + "permissions": [ + "ivs:CreateEncoderConfiguration", + "ivs:TagResource" + ] + }, + "delete": { + "permissions": [ + "ivs:DeleteEncoderConfiguration", + "ivs:UntagResource" + ] + }, + "list": { + "permissions": [ + "ivs:ListEncoderConfigurations", + "ivs:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "ivs:GetEncoderConfiguration", + "ivs:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "ivs:GetEncoderConfiguration", + "ivs:ListTagsForResource", + "ivs:UntagResource", + "ivs:TagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "Encoder configuration identifier.", + "maxLength": 128, + "minLength": 1, + "pattern": "^arn:aws:ivs:[a-z0-9-]+:[0-9]+:encoder-configuration/[a-zA-Z0-9-]+$", + "type": "string" + }, + "Name": { + "description": "Encoder configuration name.", + "maxLength": 128, + "minLength": 0, + "pattern": "^[a-zA-Z0-9-_]*$", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + }, + "Video": { + "additionalProperties": false, + "description": "Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30 fps", + "properties": { + "Bitrate": { + "default": 2500000, + "description": "Bitrate for generated output, in bps. Default: 2500000.", + "maximum": 8500000, + "minimum": 1, + "type": "integer" + }, + "Framerate": { + "default": 30, + "description": "Video frame rate, in fps. Default: 30.", + "maximum": 60, + "minimum": 1, + "type": "number" + }, + "Height": { + "default": 720, + "description": "Video-resolution height. Note that the maximum value is determined by width times height, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 720.", + "maximum": 1920, + "minimum": 1, + "type": "integer" + }, + "Width": { + "default": 1280, + "description": "Video-resolution width. Note that the maximum value is determined by width times height, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 1280.", + "maximum": 1920, + "minimum": 1, + "type": "integer" + } + }, + "type": "object" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::IVS::EncoderConfiguration" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::IVS::PlaybackKeyPair.json b/artifacts/types/AWS::IVS::PlaybackKeyPair.json index 8103a757..65cc67c5 100644 --- a/artifacts/types/AWS::IVS::PlaybackKeyPair.json +++ b/artifacts/types/AWS::IVS::PlaybackKeyPair.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IVS-PlaybackKeyPair", "type": "AWS::IVS::PlaybackKeyPair", - "time": "2024-01-04T16:25:09.465Z", + "time": "2024-04-25T15:34:32.403Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::IVS::PlaybackRestrictionPolicy.json b/artifacts/types/AWS::IVS::PlaybackRestrictionPolicy.json new file mode 100644 index 00000000..e961bbb2 --- /dev/null +++ b/artifacts/types/AWS::IVS::PlaybackRestrictionPolicy.json @@ -0,0 +1,138 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IVS-PlaybackRestrictionPolicy", + "type": "AWS::IVS::PlaybackRestrictionPolicy", + "time": "2024-04-25T15:34:37.009Z", + "schema": { + "additionalProperties": false, + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::IVS::PlaybackRestrictionPolicy.", + "handlers": { + "create": { + "permissions": [ + "ivs:CreatePlaybackRestrictionPolicy", + "ivs:TagResource" + ] + }, + "delete": { + "permissions": [ + "ivs:DeletePlaybackRestrictionPolicy", + "ivs:UntagResource" + ] + }, + "list": { + "permissions": [ + "ivs:ListPlaybackRestrictionPolicies", + "ivs:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "ivs:GetPlaybackRestrictionPolicy", + "ivs:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "ivs:GetPlaybackRestrictionPolicy", + "ivs:UpdatePlaybackRestrictionPolicy", + "ivs:ListTagsForResource", + "ivs:UntagResource", + "ivs:TagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "AllowedCountries": { + "default": [], + "description": "A list of country codes that control geoblocking restriction. Allowed values are the officially assigned ISO 3166-1 alpha-2 codes. Default: All countries (an empty array).", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "AllowedOrigins": { + "default": [], + "description": "A list of origin sites that control CORS restriction. Allowed values are the same as valid values of the Origin header defined at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + }, + "Arn": { + "description": "Playback-restriction-policy identifier.", + "maxLength": 128, + "minLength": 1, + "pattern": "^arn:aws:ivs:[a-z0-9-]+:[0-9]+:playback-restriction-policy/[a-zA-Z0-9-]+$", + "type": "string" + }, + "EnableStrictOriginEnforcement": { + "default": false, + "description": "Whether channel playback is constrained by origin site.", + "type": "boolean" + }, + "Name": { + "description": "Playback-restriction-policy name.", + "maxLength": 128, + "minLength": 0, + "pattern": "^[a-zA-Z0-9-_]*$", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "AllowedCountries", + "AllowedOrigins" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::IVS::PlaybackRestrictionPolicy" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::IVS::RecordingConfiguration.json b/artifacts/types/AWS::IVS::RecordingConfiguration.json index c03c4789..cea2d196 100644 --- a/artifacts/types/AWS::IVS::RecordingConfiguration.json +++ b/artifacts/types/AWS::IVS::RecordingConfiguration.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IVS-RecordingConfiguration", "type": "AWS::IVS::RecordingConfiguration", - "time": "2024-01-04T16:41:11.514Z", + "time": "2024-04-25T15:34:32.263Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -264,6 +264,13 @@ "DestinationConfiguration" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, "typeName": "AWS::IVS::RecordingConfiguration" } } \ No newline at end of file diff --git a/artifacts/types/AWS::IVS::Stage.json b/artifacts/types/AWS::IVS::Stage.json new file mode 100644 index 00000000..930ca388 --- /dev/null +++ b/artifacts/types/AWS::IVS::Stage.json @@ -0,0 +1,116 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IVS-Stage", + "type": "AWS::IVS::Stage", + "time": "2024-04-25T15:34:37.121Z", + "schema": { + "additionalProperties": false, + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Definition for type AWS::IVS::Stage.", + "handlers": { + "create": { + "permissions": [ + "ivs:CreateStage", + "ivs:GetStage", + "ivs:TagResource", + "ivs:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "ivs:DeleteStage", + "ivs:UnTagResource" + ] + }, + "list": { + "permissions": [ + "ivs:ListStages", + "ivs:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "ivs:GetStage", + "ivs:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "ivs:GetStage", + "ivs:UpdateStage", + "ivs:TagResource", + "ivs:UnTagResource", + "ivs:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "ActiveSessionId": { + "default": "", + "description": "ID of the active session within the stage.", + "maxLength": 128, + "minLength": 0, + "type": "string" + }, + "Arn": { + "description": "Stage ARN is automatically generated on creation and assigned as the unique identifier.", + "maxLength": 128, + "minLength": 0, + "pattern": "^arn:aws[-a-z]*:ivs:[a-z0-9-]+:[0-9]+:stage/[a-zA-Z0-9-]+$", + "type": "string" + }, + "Name": { + "description": "Stage name", + "maxLength": 128, + "minLength": 0, + "pattern": "^[a-zA-Z0-9-_]*$", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/ActiveSessionId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::IVS::Stage" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::IVS::StorageConfiguration.json b/artifacts/types/AWS::IVS::StorageConfiguration.json new file mode 100644 index 00000000..8ecc55fd --- /dev/null +++ b/artifacts/types/AWS::IVS::StorageConfiguration.json @@ -0,0 +1,143 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IVS-StorageConfiguration", + "type": "AWS::IVS::StorageConfiguration", + "time": "2024-04-25T15:34:32.664Z", + "schema": { + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/S3", + "/properties/S3/BucketName" + ], + "definitions": { + "S3StorageConfiguration": { + "additionalProperties": false, + "description": "A complex type that describes an S3 location where recorded videos will be stored.", + "properties": { + "BucketName": { + "description": "Location (S3 bucket name) where recorded videos will be stored. Note that the StorageConfiguration and S3 bucket must be in the same region as the Composition.", + "maxLength": 63, + "minLength": 3, + "pattern": "^[a-z0-9-.]+$", + "type": "string" + } + }, + "required": [ + "BucketName" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::IVS::StorageConfiguration", + "handlers": { + "create": { + "permissions": [ + "ivs:CreateStorageConfiguration", + "ivs:GetStorageConfiguration", + "ivs:TagResource", + "s3:GetBucketLocation", + "s3:GetBucketPolicy", + "s3:PutBucketPolicy" + ] + }, + "delete": { + "permissions": [ + "ivs:DeleteStorageConfiguration", + "ivs:UntagResource", + "s3:GetBucketPolicy", + "s3:DeleteBucketPolicy", + "s3:PutBucketPolicy" + ] + }, + "list": { + "permissions": [ + "ivs:ListStorageConfigurations", + "s3:GetBucketLocation", + "ivs:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "ivs:GetStorageConfiguration", + "ivs:ListTagsForResource", + "s3:GetBucketLocation" + ] + }, + "update": { + "permissions": [ + "ivs:GetStorageConfiguration", + "ivs:TagResource", + "ivs:UntagResource", + "ivs:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "Storage Configuration ARN is automatically generated on creation and assigned as the unique identifier.", + "maxLength": 128, + "minLength": 0, + "pattern": "^arn:aws[-a-z]*:ivs:[a-z0-9-]+:[0-9]+:storage-configuration/[a-zA-Z0-9-]+$", + "type": "string" + }, + "Name": { + "description": "Storage Configuration Name.", + "maxLength": 128, + "minLength": 0, + "pattern": "^[a-zA-Z0-9-_]*$", + "type": "string" + }, + "S3": { + "$ref": "#/definitions/S3StorageConfiguration" + }, + "Tags": { + "description": "A list of key-value pairs that contain metadata for the asset model.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "required": [ + "S3" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::IVS::StorageConfiguration" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::IVS::StreamKey.json b/artifacts/types/AWS::IVS::StreamKey.json index 831ddd6a..2c4b50ec 100644 --- a/artifacts/types/AWS::IVS::StreamKey.json +++ b/artifacts/types/AWS::IVS::StreamKey.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IVS-StreamKey", "type": "AWS::IVS::StreamKey", - "time": "2024-01-04T16:25:09.582Z", + "time": "2024-04-25T15:34:37.181Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -115,6 +115,13 @@ "ChannelArn" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, "typeName": "AWS::IVS::StreamKey" } } \ No newline at end of file diff --git a/artifacts/types/AWS::IVSChat::LoggingConfiguration.json b/artifacts/types/AWS::IVSChat::LoggingConfiguration.json index 9adafb74..2b4d7f29 100644 --- a/artifacts/types/AWS::IVSChat::LoggingConfiguration.json +++ b/artifacts/types/AWS::IVSChat::LoggingConfiguration.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IVSChat-LoggingConfiguration", "type": "AWS::IVSChat::LoggingConfiguration", - "time": "2023-11-17T22:13:27.036Z", + "time": "2024-05-02T15:34:42.215Z", "schema": { "additionalProperties": false, "definitions": { @@ -141,7 +141,7 @@ "ivschat:UpdateLoggingConfiguration", "ivschat:GetLoggingConfiguration", "ivschat:TagResource", - "ivschat:UnTagResource", + "ivschat:UntagResource", "ivschat:ListTagsForResource", "logs:CreateLogDelivery", "logs:GetLogDelivery", diff --git a/artifacts/types/AWS::IVSChat::Room.json b/artifacts/types/AWS::IVSChat::Room.json index b900bc66..35e3896e 100644 --- a/artifacts/types/AWS::IVSChat::Room.json +++ b/artifacts/types/AWS::IVSChat::Room.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IVSChat-Room", "type": "AWS::IVSChat::Room", - "time": "2023-11-17T21:58:45.536Z", + "time": "2024-05-02T15:27:42.16Z", "schema": { "additionalProperties": false, "definitions": { @@ -83,7 +83,7 @@ "permissions": [ "ivschat:UpdateRoom", "ivschat:TagResource", - "ivschat:UnTagResource", + "ivschat:UntagResource", "ivschat:ListTagsForResource" ] } diff --git a/artifacts/types/AWS::IdentityStore::Group.json b/artifacts/types/AWS::IdentityStore::Group.json index cbe78b0f..d3b82532 100644 --- a/artifacts/types/AWS::IdentityStore::Group.json +++ b/artifacts/types/AWS::IdentityStore::Group.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IdentityStore-Group", "type": "AWS::IdentityStore::Group", - "time": "2024-01-03T17:11:54.952Z", + "time": "2024-06-05T15:36:34.161Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::ImageBuilder::DistributionConfiguration.json b/artifacts/types/AWS::ImageBuilder::DistributionConfiguration.json index 78792e28..f4bcc640 100644 --- a/artifacts/types/AWS::ImageBuilder::DistributionConfiguration.json +++ b/artifacts/types/AWS::ImageBuilder::DistributionConfiguration.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ImageBuilder-DistributionConfiguration", "type": "AWS::ImageBuilder::DistributionConfiguration", - "time": "2024-01-04T16:49:52.681Z", + "time": "2024-06-21T06:52:02.148Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::ImageBuilder::ImagePipeline.json b/artifacts/types/AWS::ImageBuilder::ImagePipeline.json index 149b9bc7..a4b223c9 100644 --- a/artifacts/types/AWS::ImageBuilder::ImagePipeline.json +++ b/artifacts/types/AWS::ImageBuilder::ImagePipeline.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ImageBuilder-ImagePipeline", "type": "AWS::ImageBuilder::ImagePipeline", - "time": "2024-01-04T16:57:04.125Z", + "time": "2024-06-21T06:53:58.891Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::ImageBuilder::InfrastructureConfiguration.json b/artifacts/types/AWS::ImageBuilder::InfrastructureConfiguration.json index 391dd721..cbe82729 100644 --- a/artifacts/types/AWS::ImageBuilder::InfrastructureConfiguration.json +++ b/artifacts/types/AWS::ImageBuilder::InfrastructureConfiguration.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ImageBuilder-InfrastructureConfiguration", "type": "AWS::ImageBuilder::InfrastructureConfiguration", - "time": "2024-01-04T16:46:49.44Z", + "time": "2024-06-21T06:50:48.139Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::ImageBuilder::LifecyclePolicy.json b/artifacts/types/AWS::ImageBuilder::LifecyclePolicy.json index ec5dec13..09323549 100644 --- a/artifacts/types/AWS::ImageBuilder::LifecyclePolicy.json +++ b/artifacts/types/AWS::ImageBuilder::LifecyclePolicy.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ImageBuilder-LifecyclePolicy", "type": "AWS::ImageBuilder::LifecyclePolicy", - "time": "2024-01-04T16:47:15.766Z", + "time": "2024-06-21T06:50:55.39Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -194,7 +194,8 @@ } }, "required": [ - "Name" + "Name", + "SemanticVersion" ], "type": "object" }, diff --git a/artifacts/types/AWS::InspectorV2::CisScanConfiguration.json b/artifacts/types/AWS::InspectorV2::CisScanConfiguration.json new file mode 100644 index 00000000..6cce0aa5 --- /dev/null +++ b/artifacts/types/AWS::InspectorV2::CisScanConfiguration.json @@ -0,0 +1,244 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-InspectorV2-CisScanConfiguration", + "type": "AWS::InspectorV2::CisScanConfiguration", + "time": "2024-06-05T16:27:50.294Z", + "schema": { + "additionalProperties": false, + "definitions": { + "CisSecurityLevel": { + "enum": [ + "LEVEL_1", + "LEVEL_2" + ], + "type": "string" + }, + "CisTagMap": { + "additionalProperties": false, + "patternProperties": { + "^.{2,127}$": { + "pattern": "^.{1,255}$", + "type": "string" + } + }, + "type": "object" + }, + "CisTargets": { + "additionalProperties": false, + "properties": { + "AccountIds": { + "items": { + "pattern": "^\\d{12}|ALL_MEMBERS|SELF$", + "type": "string" + }, + "maxItems": 10000, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "TargetResourceTags": { + "$ref": "#/definitions/TargetResourceTags" + } + }, + "required": [ + "AccountIds" + ] + }, + "DailySchedule": { + "additionalProperties": false, + "properties": { + "StartTime": { + "$ref": "#/definitions/Time" + } + }, + "required": [ + "StartTime" + ], + "type": "object" + }, + "Day": { + "enum": [ + "MON", + "TUE", + "WED", + "THU", + "FRI", + "SAT", + "SUN" + ], + "type": "string" + }, + "DaysList": { + "items": { + "$ref": "#/definitions/Day" + }, + "maxItems": 7, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "MonthlySchedule": { + "additionalProperties": false, + "properties": { + "Day": { + "$ref": "#/definitions/Day" + }, + "StartTime": { + "$ref": "#/definitions/Time" + } + }, + "required": [ + "StartTime", + "Day" + ], + "type": "object" + }, + "OneTimeSchedule": { + "type": "object" + }, + "Schedule": { + "description": "Choose a Schedule cadence", + "properties": { + "Daily": { + "$ref": "#/definitions/DailySchedule" + }, + "Monthly": { + "$ref": "#/definitions/MonthlySchedule" + }, + "OneTime": { + "$ref": "#/definitions/OneTimeSchedule" + }, + "Weekly": { + "$ref": "#/definitions/WeeklySchedule" + } + } + }, + "TagValueList": { + "items": { + "type": "string" + }, + "maxItems": 5, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "TargetResourceTags": { + "additionalProperties": false, + "maxProperties": 5, + "patternProperties": { + "^.+$": { + "$ref": "#/definitions/TagValueList" + } + } + }, + "Time": { + "additionalProperties": false, + "properties": { + "TimeOfDay": { + "pattern": "^([0-1]?[0-9]|2[0-3]):[0-5][0-9]$", + "type": "string" + }, + "TimeZone": { + "type": "string" + } + }, + "required": [ + "TimeOfDay", + "TimeZone" + ], + "type": "object" + }, + "WeeklySchedule": { + "additionalProperties": false, + "properties": { + "Days": { + "$ref": "#/definitions/DaysList" + }, + "StartTime": { + "$ref": "#/definitions/Time" + } + }, + "required": [ + "StartTime", + "Days" + ], + "type": "object" + } + }, + "description": "CIS Scan Configuration resource schema", + "handlers": { + "create": { + "permissions": [ + "inspector2:CreateCisScanConfiguration", + "inspector2:ListCisScanConfigurations", + "inspector2:TagResource" + ] + }, + "delete": { + "permissions": [ + "inspector2:ListCisScanConfigurations", + "inspector2:DeleteCisScanConfiguration", + "inspector2:UntagResource" + ] + }, + "list": { + "permissions": [ + "inspector2:ListCisScanConfigurations", + "inspector2:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "inspector2:ListCisScanConfigurations", + "inspector2:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "inspector2:ListCisScanConfigurations", + "inspector2:UpdateCisScanConfiguration", + "inspector2:TagResource", + "inspector2:UntagResource", + "inspector2:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "CIS Scan configuration unique identifier", + "type": "string" + }, + "ScanName": { + "description": "Name of the scan", + "minLength": 1, + "type": "string" + }, + "Schedule": { + "$ref": "#/definitions/Schedule" + }, + "SecurityLevel": { + "$ref": "#/definitions/CisSecurityLevel" + }, + "Tags": { + "$ref": "#/definitions/CisTagMap" + }, + "Targets": { + "$ref": "#/definitions/CisTargets" + } + }, + "readOnlyProperties": [ + "/properties/Arn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-inspector.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::InspectorV2::CisScanConfiguration" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::InspectorV2::Filter.json b/artifacts/types/AWS::InspectorV2::Filter.json index 3505e6cb..6dd47425 100644 --- a/artifacts/types/AWS::InspectorV2::Filter.json +++ b/artifacts/types/AWS::InspectorV2::Filter.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-InspectorV2-Filter", "type": "AWS::InspectorV2::Filter", - "time": "2023-08-12T08:47:17.919Z", + "time": "2024-06-05T16:13:40.017Z", "schema": { "additionalProperties": false, "definitions": { @@ -369,6 +369,9 @@ "FilterAction" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-inspector.git", + "tagging": { + "taggable": false + }, "typeName": "AWS::InspectorV2::Filter" } } \ No newline at end of file diff --git a/artifacts/types/AWS::InternetMonitor::Monitor.json b/artifacts/types/AWS::InternetMonitor::Monitor.json index d072946f..565190bb 100644 --- a/artifacts/types/AWS::InternetMonitor::Monitor.json +++ b/artifacts/types/AWS::InternetMonitor::Monitor.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-InternetMonitor-Monitor", "type": "AWS::InternetMonitor::Monitor", - "time": "2024-01-04T16:22:09.911Z", + "time": "2024-06-18T15:53:23.505Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -188,9 +188,18 @@ "HealthEventsConfig": { "$ref": "#/definitions/HealthEventsConfig" }, + "IncludeLinkedAccounts": { + "type": "boolean" + }, "InternetMeasurementsLogDelivery": { "$ref": "#/definitions/InternetMeasurementsLogDelivery" }, + "LinkedAccountId": { + "maxLength": 12, + "minLength": 12, + "pattern": "^(\\d{12})$", + "type": "string" + }, "MaxCityNetworksToMonitor": { "maximum": 500000, "minimum": 1, @@ -281,7 +290,9 @@ "typeName": "AWS::InternetMonitor::Monitor", "writeOnlyProperties": [ "/properties/ResourcesToAdd", - "/properties/ResourcesToRemove" + "/properties/ResourcesToRemove", + "/properties/LinkedAccountId", + "/properties/IncludeLinkedAccounts" ] } } \ No newline at end of file diff --git a/artifacts/types/AWS::IoT::AccountAuditConfiguration.json b/artifacts/types/AWS::IoT::AccountAuditConfiguration.json index 9c618211..c95b88ab 100644 --- a/artifacts/types/AWS::IoT::AccountAuditConfiguration.json +++ b/artifacts/types/AWS::IoT::AccountAuditConfiguration.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IoT-AccountAuditConfiguration", "type": "AWS::IoT::AccountAuditConfiguration", - "time": "2023-12-05T16:05:48.897Z", + "time": "2024-02-08T16:24:55.444Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::IoT::Authorizer.json b/artifacts/types/AWS::IoT::Authorizer.json index 3f5489d7..bd867266 100644 --- a/artifacts/types/AWS::IoT::Authorizer.json +++ b/artifacts/types/AWS::IoT::Authorizer.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IoT-Authorizer", "type": "AWS::IoT::Authorizer", - "time": "2024-01-03T16:41:35.091Z", + "time": "2024-02-29T21:04:31.75Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::IoT::BillingGroup.json b/artifacts/types/AWS::IoT::BillingGroup.json index 5813f51b..a1a00cc2 100644 --- a/artifacts/types/AWS::IoT::BillingGroup.json +++ b/artifacts/types/AWS::IoT::BillingGroup.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IoT-BillingGroup", "type": "AWS::IoT::BillingGroup", - "time": "2023-12-18T16:28:01.063Z", + "time": "2024-05-08T15:24:08.598Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::IoT::CACertificate.json b/artifacts/types/AWS::IoT::CACertificate.json index 338ffdc0..37d8c446 100644 --- a/artifacts/types/AWS::IoT::CACertificate.json +++ b/artifacts/types/AWS::IoT::CACertificate.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IoT-CACertificate", "type": "AWS::IoT::CACertificate", - "time": "2024-01-03T16:53:42.668Z", + "time": "2024-02-29T21:08:26.17Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::IoT::Certificate.json b/artifacts/types/AWS::IoT::Certificate.json index feff8dcc..cb805a5b 100644 --- a/artifacts/types/AWS::IoT::Certificate.json +++ b/artifacts/types/AWS::IoT::Certificate.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IoT-Certificate", "type": "AWS::IoT::Certificate", - "time": "2024-01-03T16:37:32.206Z", + "time": "2024-02-29T20:59:40.809Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::IoT::CertificateProvider.json b/artifacts/types/AWS::IoT::CertificateProvider.json index 42820ddf..e0538a25 100644 --- a/artifacts/types/AWS::IoT::CertificateProvider.json +++ b/artifacts/types/AWS::IoT::CertificateProvider.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IoT-CertificateProvider", "type": "AWS::IoT::CertificateProvider", - "time": "2024-01-03T16:39:19.088Z", + "time": "2024-02-29T21:01:07.98Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::IoT::CustomMetric.json b/artifacts/types/AWS::IoT::CustomMetric.json index 48f6d7e6..85dd0c2a 100644 --- a/artifacts/types/AWS::IoT::CustomMetric.json +++ b/artifacts/types/AWS::IoT::CustomMetric.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IoT-CustomMetric", "type": "AWS::IoT::CustomMetric", - "time": "2023-12-05T16:05:52.597Z", + "time": "2024-02-08T16:21:55.523Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::IoT::Dimension.json b/artifacts/types/AWS::IoT::Dimension.json index 091046d2..408d00bd 100644 --- a/artifacts/types/AWS::IoT::Dimension.json +++ b/artifacts/types/AWS::IoT::Dimension.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IoT-Dimension", "type": "AWS::IoT::Dimension", - "time": "2023-12-05T16:05:43.937Z", + "time": "2024-02-08T16:22:11.545Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::IoT::DomainConfiguration.json b/artifacts/types/AWS::IoT::DomainConfiguration.json index 1dd1f40b..369b9e62 100644 --- a/artifacts/types/AWS::IoT::DomainConfiguration.json +++ b/artifacts/types/AWS::IoT::DomainConfiguration.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IoT-DomainConfiguration", "type": "AWS::IoT::DomainConfiguration", - "time": "2024-01-03T16:52:38.446Z", + "time": "2024-02-29T21:13:22.102Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::IoT::FleetMetric.json b/artifacts/types/AWS::IoT::FleetMetric.json index d7a96086..7da1d836 100644 --- a/artifacts/types/AWS::IoT::FleetMetric.json +++ b/artifacts/types/AWS::IoT::FleetMetric.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IoT-FleetMetric", "type": "AWS::IoT::FleetMetric", - "time": "2023-12-07T16:12:10.865Z", + "time": "2024-05-07T15:21:17.471Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -53,18 +53,26 @@ "Key" ], "type": "object" + }, + "iso8601UTC": { + "description": "The datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)", + "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$", + "type": "string" } }, "description": "An aggregated metric of certain devices in your fleet", "handlers": { "create": { "permissions": [ - "iot:CreateFleetMetric" + "iot:CreateFleetMetric", + "iot:DescribeFleetMetric", + "iot:TagResource" ] }, "delete": { "permissions": [ - "iot:DeleteFleetMetric" + "iot:DeleteFleetMetric", + "iot:DescribeFleetMetric" ] }, "list": { @@ -81,6 +89,7 @@ "update": { "permissions": [ "iot:UpdateFleetMetric", + "iot:DescribeFleetMetric", "iot:ListTagsForResource", "iot:UntagResource", "iot:TagResource" @@ -99,8 +108,8 @@ "$ref": "#/definitions/AggregationType" }, "CreationDate": { - "description": "The creation date of a fleet metric", - "type": "number" + "$ref": "#/definitions/iso8601UTC", + "description": "The creation date of a fleet metric" }, "Description": { "description": "The description of a fleet metric", @@ -111,8 +120,8 @@ "type": "string" }, "LastModifiedDate": { - "description": "The last modified date of a fleet metric", - "type": "number" + "$ref": "#/definitions/iso8601UTC", + "description": "The last modified date of a fleet metric" }, "MetricArn": { "description": "The Amazon Resource Number (ARN) of a fleet metric metric", diff --git a/artifacts/types/AWS::IoT::Logging.json b/artifacts/types/AWS::IoT::Logging.json index 30c8e0d8..829a91a8 100644 --- a/artifacts/types/AWS::IoT::Logging.json +++ b/artifacts/types/AWS::IoT::Logging.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IoT-Logging", "type": "AWS::IoT::Logging", - "time": "2023-10-31T15:28:50.178Z", + "time": "2024-01-31T16:22:02.797Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::IoT::MitigationAction.json b/artifacts/types/AWS::IoT::MitigationAction.json index 2431008c..3c2e6a18 100644 --- a/artifacts/types/AWS::IoT::MitigationAction.json +++ b/artifacts/types/AWS::IoT::MitigationAction.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IoT-MitigationAction", "type": "AWS::IoT::MitigationAction", - "time": "2023-12-05T16:05:48.633Z", + "time": "2024-02-08T16:23:05.832Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::IoT::Policy.json b/artifacts/types/AWS::IoT::Policy.json index c17c68a3..31bc8e5d 100644 --- a/artifacts/types/AWS::IoT::Policy.json +++ b/artifacts/types/AWS::IoT::Policy.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IoT-Policy", "type": "AWS::IoT::Policy", - "time": "2024-01-03T16:38:07.679Z", + "time": "2024-02-29T21:00:51.452Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::IoT::ProvisioningTemplate.json b/artifacts/types/AWS::IoT::ProvisioningTemplate.json index 466107df..b754e484 100644 --- a/artifacts/types/AWS::IoT::ProvisioningTemplate.json +++ b/artifacts/types/AWS::IoT::ProvisioningTemplate.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IoT-ProvisioningTemplate", "type": "AWS::IoT::ProvisioningTemplate", - "time": "2024-01-03T16:39:17.352Z", + "time": "2024-02-29T21:01:55.62Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::IoT::ResourceSpecificLogging.json b/artifacts/types/AWS::IoT::ResourceSpecificLogging.json index db67ae48..3f9e72c6 100644 --- a/artifacts/types/AWS::IoT::ResourceSpecificLogging.json +++ b/artifacts/types/AWS::IoT::ResourceSpecificLogging.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IoT-ResourceSpecificLogging", "type": "AWS::IoT::ResourceSpecificLogging", - "time": "2023-10-31T15:27:53.031Z", + "time": "2024-01-31T16:21:00.403Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::IoT::RoleAlias.json b/artifacts/types/AWS::IoT::RoleAlias.json index f9d52ab0..e6b510ab 100644 --- a/artifacts/types/AWS::IoT::RoleAlias.json +++ b/artifacts/types/AWS::IoT::RoleAlias.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IoT-RoleAlias", "type": "AWS::IoT::RoleAlias", - "time": "2024-01-03T16:39:35.705Z", + "time": "2024-02-29T21:00:48.475Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::IoT::ScheduledAudit.json b/artifacts/types/AWS::IoT::ScheduledAudit.json index 41d6d8e4..a9e73825 100644 --- a/artifacts/types/AWS::IoT::ScheduledAudit.json +++ b/artifacts/types/AWS::IoT::ScheduledAudit.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IoT-ScheduledAudit", "type": "AWS::IoT::ScheduledAudit", - "time": "2023-12-05T16:05:44.494Z", + "time": "2024-02-08T16:24:05.533Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::IoT::SecurityProfile.json b/artifacts/types/AWS::IoT::SecurityProfile.json index d748c3f8..f26eca5a 100644 --- a/artifacts/types/AWS::IoT::SecurityProfile.json +++ b/artifacts/types/AWS::IoT::SecurityProfile.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IoT-SecurityProfile", "type": "AWS::IoT::SecurityProfile", - "time": "2023-12-05T16:05:46.084Z", + "time": "2024-02-08T16:36:08.873Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::IoT::SoftwarePackage.json b/artifacts/types/AWS::IoT::SoftwarePackage.json index c0163275..bb90094c 100644 --- a/artifacts/types/AWS::IoT::SoftwarePackage.json +++ b/artifacts/types/AWS::IoT::SoftwarePackage.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IoT-SoftwarePackage", "type": "AWS::IoT::SoftwarePackage", - "time": "2023-11-07T16:26:45.144Z", + "time": "2024-02-19T16:23:13.406Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::IoT::SoftwarePackageVersion.json b/artifacts/types/AWS::IoT::SoftwarePackageVersion.json index d3f890b3..0c2ffeb3 100644 --- a/artifacts/types/AWS::IoT::SoftwarePackageVersion.json +++ b/artifacts/types/AWS::IoT::SoftwarePackageVersion.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IoT-SoftwarePackageVersion", "type": "AWS::IoT::SoftwarePackageVersion", - "time": "2023-11-07T16:26:43.224Z", + "time": "2024-02-19T16:23:10.071Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::IoT::Thing.json b/artifacts/types/AWS::IoT::Thing.json index bbc8b05b..9343ae97 100644 --- a/artifacts/types/AWS::IoT::Thing.json +++ b/artifacts/types/AWS::IoT::Thing.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IoT-Thing", "type": "AWS::IoT::Thing", - "time": "2023-12-18T16:29:05.303Z", + "time": "2024-05-08T15:24:12.137Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::IoT::ThingGroup.json b/artifacts/types/AWS::IoT::ThingGroup.json index c924189c..d659ce3f 100644 --- a/artifacts/types/AWS::IoT::ThingGroup.json +++ b/artifacts/types/AWS::IoT::ThingGroup.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IoT-ThingGroup", "type": "AWS::IoT::ThingGroup", - "time": "2023-12-18T16:44:46.364Z", + "time": "2024-05-08T15:32:41.147Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::IoT::ThingType.json b/artifacts/types/AWS::IoT::ThingType.json index c6da2cd1..59603e6b 100644 --- a/artifacts/types/AWS::IoT::ThingType.json +++ b/artifacts/types/AWS::IoT::ThingType.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IoT-ThingType", "type": "AWS::IoT::ThingType", - "time": "2023-12-18T17:58:06.641Z", + "time": "2024-05-08T16:29:58.605Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::IoT::TopicRule.json b/artifacts/types/AWS::IoT::TopicRule.json index 1ca3f81e..60e973f1 100644 --- a/artifacts/types/AWS::IoT::TopicRule.json +++ b/artifacts/types/AWS::IoT::TopicRule.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IoT-TopicRule", "type": "AWS::IoT::TopicRule", - "time": "2023-12-19T18:59:23.98Z", + "time": "2024-04-02T16:39:29.207Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -981,7 +981,7 @@ "type": "string" }, "Tags": { - "insertionOrder": true, + "insertionOrder": false, "items": { "$ref": "#/definitions/Tag" }, diff --git a/artifacts/types/AWS::IoT::TopicRuleDestination.json b/artifacts/types/AWS::IoT::TopicRuleDestination.json index a89ca64e..19d7b28c 100644 --- a/artifacts/types/AWS::IoT::TopicRuleDestination.json +++ b/artifacts/types/AWS::IoT::TopicRuleDestination.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IoT-TopicRuleDestination", "type": "AWS::IoT::TopicRuleDestination", - "time": "2023-12-19T20:40:19.14Z", + "time": "2024-04-02T17:58:08.191Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::IoTAnalytics::Channel.json b/artifacts/types/AWS::IoTAnalytics::Channel.json index e56d6a36..8f16db64 100644 --- a/artifacts/types/AWS::IoTAnalytics::Channel.json +++ b/artifacts/types/AWS::IoTAnalytics::Channel.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IoTAnalytics-Channel", "type": "AWS::IoTAnalytics::Channel", - "time": "2023-01-19T06:12:38.579Z", + "time": "2024-01-31T21:45:23.138Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::IoTAnalytics::Dataset.json b/artifacts/types/AWS::IoTAnalytics::Dataset.json index 9ed4699f..85f24364 100644 --- a/artifacts/types/AWS::IoTAnalytics::Dataset.json +++ b/artifacts/types/AWS::IoTAnalytics::Dataset.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IoTAnalytics-Dataset", "type": "AWS::IoTAnalytics::Dataset", - "time": "2023-01-19T06:12:24.255Z", + "time": "2024-01-31T21:46:26.906Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::IoTAnalytics::Datastore.json b/artifacts/types/AWS::IoTAnalytics::Datastore.json index 20e4dd2f..af9d58d9 100644 --- a/artifacts/types/AWS::IoTAnalytics::Datastore.json +++ b/artifacts/types/AWS::IoTAnalytics::Datastore.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IoTAnalytics-Datastore", "type": "AWS::IoTAnalytics::Datastore", - "time": "2023-01-19T06:12:26.228Z", + "time": "2024-01-31T21:45:22.818Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::IoTAnalytics::Pipeline.json b/artifacts/types/AWS::IoTAnalytics::Pipeline.json index db251460..0e110e64 100644 --- a/artifacts/types/AWS::IoTAnalytics::Pipeline.json +++ b/artifacts/types/AWS::IoTAnalytics::Pipeline.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IoTAnalytics-Pipeline", "type": "AWS::IoTAnalytics::Pipeline", - "time": "2023-01-19T06:12:27.294Z", + "time": "2024-01-31T21:43:25.688Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::IoTEvents::AlarmModel.json b/artifacts/types/AWS::IoTEvents::AlarmModel.json index 6f7218d8..35ff5776 100644 --- a/artifacts/types/AWS::IoTEvents::AlarmModel.json +++ b/artifacts/types/AWS::IoTEvents::AlarmModel.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IoTEvents-AlarmModel", "type": "AWS::IoTEvents::AlarmModel", - "time": "2024-01-02T19:45:53.745Z", + "time": "2024-03-01T00:03:50.399Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -514,7 +514,7 @@ }, "AlarmModelDescription": { "description": "A brief description of the alarm model.", - "maxLength": 128, + "maxLength": 1024, "type": "string" }, "AlarmModelName": { diff --git a/artifacts/types/AWS::IoTEvents::DetectorModel.json b/artifacts/types/AWS::IoTEvents::DetectorModel.json index 269f5c14..cf1c4283 100644 --- a/artifacts/types/AWS::IoTEvents::DetectorModel.json +++ b/artifacts/types/AWS::IoTEvents::DetectorModel.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IoTEvents-DetectorModel", "type": "AWS::IoTEvents::DetectorModel", - "time": "2024-01-02T20:12:12.162Z", + "time": "2024-03-01T00:09:25.207Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -680,7 +680,7 @@ }, "DetectorModelDescription": { "description": "A brief description of the detector model.", - "maxLength": 128, + "maxLength": 1024, "type": "string" }, "DetectorModelName": { diff --git a/artifacts/types/AWS::IoTEvents::Input.json b/artifacts/types/AWS::IoTEvents::Input.json index fdaa8acf..cb92e8b9 100644 --- a/artifacts/types/AWS::IoTEvents::Input.json +++ b/artifacts/types/AWS::IoTEvents::Input.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IoTEvents-Input", "type": "AWS::IoTEvents::Input", - "time": "2024-01-02T19:45:52.84Z", + "time": "2024-02-29T23:56:52.362Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -112,7 +112,7 @@ }, "InputDescription": { "description": "A brief description of the input.", - "maxLength": 128, + "maxLength": 1024, "minLength": 1, "type": "string" }, diff --git a/artifacts/types/AWS::IoTFleetHub::Application.json b/artifacts/types/AWS::IoTFleetHub::Application.json index 084a16ed..c37d1e76 100644 --- a/artifacts/types/AWS::IoTFleetHub::Application.json +++ b/artifacts/types/AWS::IoTFleetHub::Application.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IoTFleetHub-Application", "type": "AWS::IoTFleetHub::Application", - "time": "2023-11-10T22:52:08.29Z", + "time": "2024-02-06T16:20:48.072Z", "schema": { "additionalProperties": false, "definitions": { diff --git a/artifacts/types/AWS::IoTSiteWise::AccessPolicy.json b/artifacts/types/AWS::IoTSiteWise::AccessPolicy.json index d050ed51..02cc9814 100644 --- a/artifacts/types/AWS::IoTSiteWise::AccessPolicy.json +++ b/artifacts/types/AWS::IoTSiteWise::AccessPolicy.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IoTSiteWise-AccessPolicy", "type": "AWS::IoTSiteWise::AccessPolicy", - "time": "2024-01-04T16:09:05.035Z", + "time": "2024-06-19T23:18:19.273Z", "schema": { "additionalProperties": false, "definitions": { diff --git a/artifacts/types/AWS::IoTSiteWise::Asset.json b/artifacts/types/AWS::IoTSiteWise::Asset.json index 228d3e88..5171cd7e 100644 --- a/artifacts/types/AWS::IoTSiteWise::Asset.json +++ b/artifacts/types/AWS::IoTSiteWise::Asset.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IoTSiteWise-Asset", "type": "AWS::IoTSiteWise::Asset", - "time": "2024-01-04T16:08:31.081Z", + "time": "2024-06-19T23:10:25.651Z", "schema": { "additionalProperties": false, "definitions": { @@ -13,6 +13,20 @@ "description": "The ID of the child asset to be associated.", "type": "string" }, + "ExternalId": { + "description": "String-friendly customer provided external ID", + "maxLength": 128, + "minLength": 2, + "pattern": "[a-zA-Z0-9_][a-zA-Z_\\-0-9.:]*[a-zA-Z0-9_]+", + "type": "string" + }, + "Id": { + "description": "Customer provided actual UUID for property", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", + "type": "string" + }, "LogicalId": { "description": "The LogicalID of a hierarchy in the parent asset's model.", "maxLength": 256, @@ -22,7 +36,6 @@ } }, "required": [ - "LogicalId", "ChildAssetId" ], "type": "object" @@ -35,6 +48,20 @@ "description": "The property alias that identifies the property.", "type": "string" }, + "ExternalId": { + "description": "String-friendly customer provided external ID", + "maxLength": 128, + "minLength": 2, + "pattern": "[a-zA-Z0-9_][a-zA-Z_\\-0-9.:]*[a-zA-Z0-9_]+", + "type": "string" + }, + "Id": { + "description": "Customer provided actual UUID for property", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", + "type": "string" + }, "LogicalId": { "description": "Customer provided ID for property.", "maxLength": 256, @@ -55,9 +82,6 @@ "type": "string" } }, - "required": [ - "LogicalId" - ], "type": "object" }, "Tag": { @@ -88,6 +112,9 @@ "iotsitewise:ListAssociatedAssets", "iotsitewise:ListTagsForResource", "iotsitewise:TagResource", + "iotsitewise:ListAssetModelProperties", + "iotsitewise:ListAssetProperties", + "iotsitewise:ListAssetModelCompositeModels", "iotsitewise:UpdateAssetProperty" ] }, @@ -98,7 +125,11 @@ "iotsitewise:DescribeAssetModel", "iotsitewise:DisassociateAssets", "iotsitewise:ListAssociatedAssets", - "iotsitewise:ListTagsForResource" + "iotsitewise:ListAssetProperties", + "iotsitewise:ListTagsForResource", + "iotsitewise:ListAssetModelCompositeModels", + "iotsitewise:ListAssetModelProperties", + "iotsitewise:ListAssetProperties" ] }, "list": { @@ -112,6 +143,9 @@ "iotsitewise:DescribeAsset", "iotsitewise:DescribeAssetModel", "iotsitewise:ListAssociatedAssets", + "iotsitewise:ListAssetModelProperties", + "iotsitewise:ListAssetModelCompositeModels", + "iotsitewise:ListAssetProperties", "iotsitewise:ListTagsForResource" ] }, @@ -126,6 +160,9 @@ "iotsitewise:TagResource", "iotsitewise:UpdateAsset", "iotsitewise:UpdateAssetProperty", + "iotsitewise:ListAssetModelProperties", + "iotsitewise:ListAssetProperties", + "iotsitewise:ListAssetModelCompositeModels", "iotsitewise:UntagResource" ] } @@ -142,6 +179,13 @@ "description": "A description for the asset", "type": "string" }, + "AssetExternalId": { + "description": "The External ID of the asset", + "maxLength": 128, + "minLength": 2, + "pattern": "[a-zA-Z0-9_][a-zA-Z_\\-0-9.:]*[a-zA-Z0-9_]+", + "type": "string" + }, "AssetHierarchies": { "insertionOrder": false, "items": { @@ -151,6 +195,9 @@ }, "AssetId": { "description": "The ID of the asset", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "type": "string" }, "AssetModelId": { @@ -180,7 +227,9 @@ }, "readOnlyProperties": [ "/properties/AssetArn", - "/properties/AssetId" + "/properties/AssetId", + "/properties/AssetProperties/*/Id", + "/properties/AssetHierarchies/*/Id" ], "required": [ "AssetName", diff --git a/artifacts/types/AWS::IoTSiteWise::AssetModel.json b/artifacts/types/AWS::IoTSiteWise::AssetModel.json index 8718912d..654825bb 100644 --- a/artifacts/types/AWS::IoTSiteWise::AssetModel.json +++ b/artifacts/types/AWS::IoTSiteWise::AssetModel.json @@ -1,14 +1,21 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IoTSiteWise-AssetModel", "type": "AWS::IoTSiteWise::AssetModel", - "time": "2024-01-04T16:08:21.378Z", + "time": "2024-06-19T23:10:26.24Z", "schema": { "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AssetModelType" + ], "definitions": { "AssetModelCompositeModel": { "additionalProperties": false, "description": "Contains a composite model definition in an asset model. This composite model definition is applied to all assets created from the asset model.", "properties": { + "ComposedAssetModelId": { + "description": "The component model ID for which the composite model is composed of", + "type": "string" + }, "CompositeModelProperties": { "description": "The property definitions of the asset model. You can specify up to 200 properties per asset model.", "insertionOrder": false, @@ -21,10 +28,39 @@ "description": "A description for the asset composite model.", "type": "string" }, + "ExternalId": { + "description": "The External ID of the composite model", + "maxLength": 128, + "minLength": 2, + "pattern": "[a-zA-Z0-9_][a-zA-Z_\\-0-9.:]*[a-zA-Z0-9_]+", + "type": "string" + }, + "Id": { + "description": "The Actual ID of the composite model", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", + "type": "string" + }, "Name": { "description": "A unique, friendly name for the asset composite model.", "type": "string" }, + "ParentAssetModelCompositeModelExternalId": { + "description": "The parent composite model External ID", + "maxLength": 128, + "minLength": 2, + "pattern": "[a-zA-Z0-9_][a-zA-Z_\\-0-9.:]*[a-zA-Z0-9_]+", + "type": "string" + }, + "Path": { + "description": "The path of the composite model. This is only for derived composite models", + "insertionOrder": true, + "items": { + "type": "string" + }, + "type": "array" + }, "Type": { "description": "The type of the composite model. For alarm composite models, this type is AWS/ALARM", "type": "string" @@ -44,8 +80,22 @@ "description": "The ID of the asset model. All assets in this hierarchy must be instances of the child AssetModelId asset model.", "type": "string" }, + "ExternalId": { + "description": "Customer provided external ID for hierarchy", + "maxLength": 128, + "minLength": 2, + "pattern": "[a-zA-Z0-9_][a-zA-Z_\\-0-9.:]*[a-zA-Z0-9_]+", + "type": "string" + }, + "Id": { + "description": "Customer provided actual ID for hierarchy", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", + "type": "string" + }, "LogicalId": { - "description": "Customer provided ID for hierarchy.", + "description": "Customer provided logical ID for hierarchy.", "maxLength": 256, "minLength": 1, "pattern": "[^\\u0000-\\u001F\\u007F]+", @@ -57,7 +107,6 @@ } }, "required": [ - "LogicalId", "Name", "ChildAssetModelId" ], @@ -75,8 +124,22 @@ "$ref": "#/definitions/DataTypeSpec", "description": "The data type of the structure for this property." }, + "ExternalId": { + "description": "The External ID of the Asset Model Property", + "maxLength": 128, + "minLength": 2, + "pattern": "[a-zA-Z0-9_][a-zA-Z_\\-0-9.:]*[a-zA-Z0-9_]+", + "type": "string" + }, + "Id": { + "description": "The ID of the Asset Model Property", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", + "type": "string" + }, "LogicalId": { - "description": "Customer provided ID for property.", + "description": "Customer provided Logical ID for property.", "maxLength": 256, "minLength": 1, "pattern": "[^\\u0000-\\u001F\\u007F]+", @@ -96,7 +159,6 @@ } }, "required": [ - "LogicalId", "Name", "DataType", "Type" @@ -191,6 +253,20 @@ "description": "The shift or reference point on timeline for the contiguous time intervals.", "type": "string" }, + "PropertyPathDefinition": { + "additionalProperties": false, + "description": "The definition for property path which is used to reference properties in transforms/metrics", + "properties": { + "Name": { + "description": "The name of the property", + "type": "string" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, "PropertyType": { "additionalProperties": false, "description": "Contains a property type, which can be one of attribute, measurement, metric, or transform.", @@ -279,22 +355,55 @@ "VariableValue": { "additionalProperties": false, "properties": { + "HierarchyExternalId": { + "description": "The External ID of the hierarchy that is trying to be referenced", + "maxLength": 128, + "minLength": 2, + "pattern": "[a-zA-Z0-9_][a-zA-Z_\\-0-9.:]*[a-zA-Z0-9_]+", + "type": "string" + }, + "HierarchyId": { + "description": "The ID of the hierarchy that is trying to be referenced", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", + "type": "string" + }, "HierarchyLogicalId": { "maxLength": 256, "minLength": 1, "pattern": "[^\\u0000-\\u001F\\u007F]+", "type": "string" }, + "PropertyExternalId": { + "description": "The External ID of the property that is trying to be referenced", + "maxLength": 128, + "minLength": 2, + "pattern": "[a-zA-Z0-9_][a-zA-Z_\\-0-9.:]*[a-zA-Z0-9_]+", + "type": "string" + }, + "PropertyId": { + "description": "The ID of the property that is trying to be referenced", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", + "type": "string" + }, "PropertyLogicalId": { "maxLength": 256, "minLength": 1, "pattern": "[^\\u0000-\\u001F\\u007F]+", "type": "string" + }, + "PropertyPath": { + "description": "The path of the property that is trying to be referenced", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/PropertyPathDefinition" + }, + "type": "array" } }, - "required": [ - "PropertyLogicalId" - ], "type": "object" } }, @@ -305,25 +414,38 @@ "iotsitewise:CreateAssetModel", "iotsitewise:ListTagsForResource", "iotsitewise:TagResource", - "iotsitewise:DescribeAssetModel" + "iotsitewise:DescribeAssetModel", + "iotsitewise:UpdateAssetModel", + "iotsitewise:ListAssetModelProperties", + "iotsitewise:ListAssetModelCompositeModels", + "iotsitewise:UpdateAssetModelCompositeModel", + "iotsitewise:DescribeAssetModelCompositeModel", + "iotsitewise:CreateAssetModelCompositeModel" ] }, "delete": { "permissions": [ "iotsitewise:DescribeAssetModel", - "iotsitewise:DeleteAssetModel" + "iotsitewise:DeleteAssetModel", + "iotsitewise:ListAssetModelProperties", + "iotsitewise:ListAssetModelCompositeModels" ] }, "list": { "permissions": [ "iotsitewise:DescribeAssetModel", "iotsitewise:ListAssetModels", - "iotsitewise:ListTagsForResource" + "iotsitewise:ListTagsForResource", + "iotsitewise:ListAssetModelProperties", + "iotsitewise:ListAssetModelCompositeModels" ] }, "read": { "permissions": [ "iotsitewise:DescribeAssetModel", + "iotsitewise:ListAssetModelProperties", + "iotsitewise:DescribeAssetModelCompositeModel", + "iotsitewise:ListAssetModelCompositeModels", "iotsitewise:ListTagsForResource" ] }, @@ -333,6 +455,12 @@ "iotsitewise:ListTagsForResource", "iotsitewise:TagResource", "iotsitewise:UntagResource", + "iotsitewise:ListAssetModelProperties", + "iotsitewise:ListAssetModelCompositeModels", + "iotsitewise:CreateAssetModelCompositeModel", + "iotsitewise:UpdateAssetModelCompositeModel", + "iotsitewise:DeleteAssetModelCompositeModel", + "iotsitewise:DescribeAssetModelCompositeModel", "iotsitewise:UpdateAssetModel" ] } @@ -357,6 +485,13 @@ "description": "A description for the asset model.", "type": "string" }, + "AssetModelExternalId": { + "description": "The external ID of the asset model.", + "maxLength": 128, + "minLength": 2, + "pattern": "[a-zA-Z0-9_][a-zA-Z_\\-0-9.:]*[a-zA-Z0-9_]+", + "type": "string" + }, "AssetModelHierarchies": { "description": "The hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. You can specify up to 10 hierarchies per asset model.", "insertionOrder": false, @@ -367,6 +502,9 @@ }, "AssetModelId": { "description": "The ID of the asset model.", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "type": "string" }, "AssetModelName": { @@ -381,6 +519,10 @@ }, "type": "array" }, + "AssetModelType": { + "description": "The type of the asset model (ASSET_MODEL OR COMPONENT_MODEL)", + "type": "string" + }, "Tags": { "description": "A list of key-value pairs that contain metadata for the asset model.", "insertionOrder": false, @@ -392,7 +534,15 @@ }, "readOnlyProperties": [ "/properties/AssetModelArn", - "/properties/AssetModelId" + "/properties/AssetModelId", + "/properties/AssetModelProperties/*/Id", + "/properties/AssetModelProperties/*/Type/Transform/Variables/*/Value/PropertyId", + "/properties/AssetModelProperties/*/Type/Metric/Variables/*/Value/PropertyId", + "/properties/AssetModelHierarchies/*/Id", + "/properties/AssetModelCompositeModels/*/Id", + "/properties/AssetModelCompositeModels/*/CompositeModelProperties/*/Id", + "/properties/AssetModelCompositeModels/*/CompositeModelProperties/*/Type/Transform/Variables/*/Value/PropertyId", + "/properties/AssetModelCompositeModels/*/CompositeModelProperties/*/Type/Metric/Variables/*/Value/PropertyId" ], "required": [ "AssetModelName" @@ -403,8 +553,19 @@ "writeOnlyProperties": [ "/properties/AssetModelProperties/*/DataTypeSpec", "/properties/AssetModelProperties/*/Type/Transform/Variables/*/Value/HierarchyLogicalId", - "/properties/AssetModelCompositeModels/*/CompositeModelProperties/*/Type/Transform", - "/properties/AssetModelCompositeModels/*/CompositeModelProperties/*/Type/Metric" + "/properties/AssetModelProperties/*/Type/Transform/Variables/*/Value/HierarchyId", + "/properties/AssetModelProperties/*/Type/Metric/Variables/*/Value/HierarchyId", + "/properties/AssetModelProperties/*/Type/Transform/Variables/*/Value/HierarchyExternalId", + "/properties/AssetModelProperties/*/Type/Metric/Variables/*/Value/PropertyPath/*/Name", + "/properties/AssetModelProperties/*/Type/Transform/Variables/*/Value/PropertyPath/*/Name", + "/properties/AssetModelProperties/*/Type/Transform/Variables/*/Value/HierarchyExternalId", + "/properties/AssetModelCompositeModels/*/CompositeModelProperties/*/Type/Transform/Variables/*/Value/HierarchyId", + "/properties/AssetModelCompositeModels/*/CompositeModelProperties/*/Type/Metric/Variables/*/Value/HierarchyId", + "/properties/AssetModelCompositeModels/*/CompositeModelProperties/*/Type/Transform/Variables/*/Value/HierarchyLogicalId", + "/properties/AssetModelCompositeModels/*/CompositeModelProperties/*/Type/Transform/Variables/*/Value/HierarchyExternalId", + "/properties/AssetModelCompositeModels/*/CompositeModelProperties/*/Type/Transform/Variables/*/Value/PropertyPath/*/Name", + "/properties/AssetModelCompositeModels/*/CompositeModelProperties/*/Type/Metric/Variables/*/Value/PropertyPath/*/Name", + "/properties/AssetModelCompositeModels/*/CompositeModelProperties/*/DataTypeSpec" ] } } \ No newline at end of file diff --git a/artifacts/types/AWS::IoTSiteWise::Dashboard.json b/artifacts/types/AWS::IoTSiteWise::Dashboard.json index 027f8771..351cc962 100644 --- a/artifacts/types/AWS::IoTSiteWise::Dashboard.json +++ b/artifacts/types/AWS::IoTSiteWise::Dashboard.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IoTSiteWise-Dashboard", "type": "AWS::IoTSiteWise::Dashboard", - "time": "2024-01-04T16:08:15.876Z", + "time": "2024-06-19T23:10:25.721Z", "schema": { "additionalIdentifiers": [ [ @@ -40,7 +40,9 @@ "iotsitewise:ListTagsForResource", "iotsitewise:TagResource", "iotsitewise:DescribeAsset", - "iotsitewise:DescribeAssetModel" + "iotsitewise:DescribeAssetModel", + "iotsitewise:ListAssetModelProperties", + "iotsitewise:ListAssetModelCompositeModels" ] }, "delete": { @@ -68,7 +70,9 @@ "iotsitewise:UntagResource", "iotsitewise:ListTagsForResource", "iotsitewise:DescribeAsset", - "iotsitewise:DescribeAssetModel" + "iotsitewise:DescribeAssetModel", + "iotsitewise:ListAssetModelProperties", + "iotsitewise:ListAssetModelCompositeModels" ] } }, diff --git a/artifacts/types/AWS::IoTSiteWise::Gateway.json b/artifacts/types/AWS::IoTSiteWise::Gateway.json index 58469dad..4803d63b 100644 --- a/artifacts/types/AWS::IoTSiteWise::Gateway.json +++ b/artifacts/types/AWS::IoTSiteWise::Gateway.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IoTSiteWise-Gateway", "type": "AWS::IoTSiteWise::Gateway", - "time": "2024-01-04T16:08:23.905Z", + "time": "2024-06-19T23:10:25.783Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -45,6 +45,11 @@ "required": [ "GreengrassV2" ] + }, + { + "required": [ + "SiemensIE" + ] } ], "properties": { @@ -55,6 +60,10 @@ "GreengrassV2": { "$ref": "#/definitions/GreengrassV2", "description": "A gateway that runs on AWS IoT Greengrass V2." + }, + "SiemensIE": { + "$ref": "#/definitions/SiemensIE", + "description": "A gateway that runs on Siemens Industrial Edge." } }, "type": "object" @@ -87,6 +96,20 @@ ], "type": "object" }, + "SiemensIE": { + "additionalProperties": false, + "description": "Contains the IotCoreThingName of AWS IoT Thing that the gateway runs on.", + "properties": { + "IotCoreThingName": { + "description": "The name of the IoT Core Thing.", + "type": "string" + } + }, + "required": [ + "IotCoreThingName" + ], + "type": "object" + }, "Tag": { "additionalProperties": false, "description": "To add or update tag, provide both key and value. To delete tag, provide only tag key to be deleted", diff --git a/artifacts/types/AWS::IoTSiteWise::Portal.json b/artifacts/types/AWS::IoTSiteWise::Portal.json index 910bfba0..095e5d54 100644 --- a/artifacts/types/AWS::IoTSiteWise::Portal.json +++ b/artifacts/types/AWS::IoTSiteWise::Portal.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IoTSiteWise-Portal", "type": "AWS::IoTSiteWise::Portal", - "time": "2024-01-04T16:09:03.524Z", + "time": "2024-06-19T23:18:13.391Z", "schema": { "additionalIdentifiers": [ [ @@ -157,9 +157,6 @@ ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-iotsitewise.git", "taggable": true, - "typeName": "AWS::IoTSiteWise::Portal", - "writeOnlyProperties": [ - "/properties/Tags" - ] + "typeName": "AWS::IoTSiteWise::Portal" } } \ No newline at end of file diff --git a/artifacts/types/AWS::IoTSiteWise::Project.json b/artifacts/types/AWS::IoTSiteWise::Project.json index 628847db..76baa06c 100644 --- a/artifacts/types/AWS::IoTSiteWise::Project.json +++ b/artifacts/types/AWS::IoTSiteWise::Project.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IoTSiteWise-Project", "type": "AWS::IoTSiteWise::Project", - "time": "2024-01-04T16:08:28.385Z", + "time": "2024-06-19T23:10:26.148Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::IoTTwinMaker::ComponentType.json b/artifacts/types/AWS::IoTTwinMaker::ComponentType.json index 4f5a84ad..8171ec15 100644 --- a/artifacts/types/AWS::IoTTwinMaker::ComponentType.json +++ b/artifacts/types/AWS::IoTTwinMaker::ComponentType.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IoTTwinMaker-ComponentType", "type": "AWS::IoTTwinMaker::ComponentType", - "time": "2023-12-19T16:28:48.771Z", + "time": "2024-06-18T15:21:16.733Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::IoTTwinMaker::Entity.json b/artifacts/types/AWS::IoTTwinMaker::Entity.json index e76bb4f1..8299598f 100644 --- a/artifacts/types/AWS::IoTTwinMaker::Entity.json +++ b/artifacts/types/AWS::IoTTwinMaker::Entity.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IoTTwinMaker-Entity", "type": "AWS::IoTTwinMaker::Entity", - "time": "2023-12-19T16:37:22.905Z", + "time": "2024-06-18T15:21:11.213Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -250,55 +250,60 @@ "format": "date-time", "type": "string" }, + "Definition": { + "additionalProperties": false, + "description": "An object that specifies information about a property definition.", + "properties": { + "Configuration": { + "$ref": "#/definitions/PropertyDefinitionConfiguration", + "description": "An object that specifies information about a property configuration." + }, + "DataType": { + "$ref": "#/definitions/DataType", + "description": "An object that contains information about the data type." + }, + "DefaultValue": { + "$ref": "#/definitions/DataValue", + "description": "An object that contains the default value." + }, + "IsExternalId": { + "description": "A Boolean value that specifies whether the property ID comes from an external data store.", + "type": "boolean" + }, + "IsFinal": { + "description": "A Boolean value that specifies whether the property definition can be updated.", + "type": "boolean" + }, + "IsImported": { + "description": "A Boolean value that specifies whether the property definition is imported from an external data store.", + "type": "boolean" + }, + "IsInherited": { + "description": "A Boolean value that specifies whether the property definition is inherited from a parent entity.", + "type": "boolean" + }, + "IsRequiredInEntity": { + "description": "A Boolean value that specifies whether the property is required.", + "type": "boolean" + }, + "IsStoredExternally": { + "description": "A Boolean value that specifies whether the property is stored externally.", + "type": "boolean" + }, + "IsTimeSeries": { + "description": "A Boolean value that specifies whether the property consists of time series data.", + "type": "boolean" + } + }, + "type": "object" + }, "Property": { "additionalProperties": false, + "description": "An object that specifies information about a property.", "properties": { "Definition": { - "additionalProperties": false, - "description": "An object that specifies information about a property.", - "properties": { - "Configuration": { - "$ref": "#/definitions/PropertyDefinitionConfiguration", - "description": "An object that specifies information about a property." - }, - "DataType": { - "$ref": "#/definitions/DataType", - "description": "An object that contains information about the data type." - }, - "DefaultValue": { - "$ref": "#/definitions/DataValue", - "description": "An object that contains the default value." - }, - "IsExternalId": { - "description": "A Boolean value that specifies whether the property ID comes from an external data store.", - "type": "boolean" - }, - "IsFinal": { - "description": "A Boolean value that specifies whether the property definition can be updated.", - "type": "boolean" - }, - "IsImported": { - "description": "A Boolean value that specifies whether the property definition is imported from an external data store.", - "type": "boolean" - }, - "IsInherited": { - "description": "A Boolean value that specifies whether the property definition is inherited from a parent entity.", - "type": "boolean" - }, - "IsRequiredInEntity": { - "description": "A Boolean value that specifies whether the property is required.", - "type": "boolean" - }, - "IsStoredExternally": { - "description": "A Boolean value that specifies whether the property is stored externally.", - "type": "boolean" - }, - "IsTimeSeries": { - "description": "A Boolean value that specifies whether the property consists of time series data.", - "type": "boolean" - } - }, - "type": "object" + "$ref": "#/definitions/Definition", + "description": "The definition of the property." }, "Value": { "$ref": "#/definitions/DataValue", @@ -309,7 +314,7 @@ }, "PropertyDefinitionConfiguration": { "additionalProperties": false, - "description": "An object that specifies information about a property.", + "description": "An object that specifies information about a property configuration.", "patternProperties": { "[a-zA-Z_\\-0-9]+": { "maxLength": 256, diff --git a/artifacts/types/AWS::IoTTwinMaker::Scene.json b/artifacts/types/AWS::IoTTwinMaker::Scene.json index 79824b32..a55680d5 100644 --- a/artifacts/types/AWS::IoTTwinMaker::Scene.json +++ b/artifacts/types/AWS::IoTTwinMaker::Scene.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IoTTwinMaker-Scene", "type": "AWS::IoTTwinMaker::Scene", - "time": "2023-12-19T16:45:50.72Z", + "time": "2024-06-18T15:21:36.983Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::IoTTwinMaker::Workspace.json b/artifacts/types/AWS::IoTTwinMaker::Workspace.json index 9090a90f..b29965c9 100644 --- a/artifacts/types/AWS::IoTTwinMaker::Workspace.json +++ b/artifacts/types/AWS::IoTTwinMaker::Workspace.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IoTTwinMaker-Workspace", "type": "AWS::IoTTwinMaker::Workspace", - "time": "2023-12-19T16:31:05.038Z", + "time": "2024-06-18T15:21:03.968Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::IoTWireless::Destination.json b/artifacts/types/AWS::IoTWireless::Destination.json index ea9a7ae1..aba74d9f 100644 --- a/artifacts/types/AWS::IoTWireless::Destination.json +++ b/artifacts/types/AWS::IoTWireless::Destination.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IoTWireless-Destination", "type": "AWS::IoTWireless::Destination", - "time": "2023-10-03T16:53:00.799Z", + "time": "2024-05-28T17:34:05.416Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::IoTWireless::FuotaTask.json b/artifacts/types/AWS::IoTWireless::FuotaTask.json index 5882567e..36744ba1 100644 --- a/artifacts/types/AWS::IoTWireless::FuotaTask.json +++ b/artifacts/types/AWS::IoTWireless::FuotaTask.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IoTWireless-FuotaTask", "type": "AWS::IoTWireless::FuotaTask", - "time": "2023-10-03T16:53:11.685Z", + "time": "2024-05-28T17:34:29.184Z", "schema": { "additionalProperties": false, "definitions": { diff --git a/artifacts/types/AWS::IoTWireless::MulticastGroup.json b/artifacts/types/AWS::IoTWireless::MulticastGroup.json index 8e8a9dc2..61d2bc0e 100644 --- a/artifacts/types/AWS::IoTWireless::MulticastGroup.json +++ b/artifacts/types/AWS::IoTWireless::MulticastGroup.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IoTWireless-MulticastGroup", "type": "AWS::IoTWireless::MulticastGroup", - "time": "2023-10-03T16:53:09.218Z", + "time": "2024-05-28T17:31:37.36Z", "schema": { "additionalProperties": false, "definitions": { diff --git a/artifacts/types/AWS::IoTWireless::NetworkAnalyzerConfiguration.json b/artifacts/types/AWS::IoTWireless::NetworkAnalyzerConfiguration.json index 0b03453f..484df28a 100644 --- a/artifacts/types/AWS::IoTWireless::NetworkAnalyzerConfiguration.json +++ b/artifacts/types/AWS::IoTWireless::NetworkAnalyzerConfiguration.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IoTWireless-NetworkAnalyzerConfiguration", "type": "AWS::IoTWireless::NetworkAnalyzerConfiguration", - "time": "2023-10-03T16:53:39.138Z", + "time": "2024-05-28T17:30:30.352Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::IoTWireless::WirelessDevice.json b/artifacts/types/AWS::IoTWireless::WirelessDevice.json index 91e4f8a6..a3ac30b9 100644 --- a/artifacts/types/AWS::IoTWireless::WirelessDevice.json +++ b/artifacts/types/AWS::IoTWireless::WirelessDevice.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IoTWireless-WirelessDevice", "type": "AWS::IoTWireless::WirelessDevice", - "time": "2023-10-03T16:53:10.949Z", + "time": "2024-05-28T17:34:51.387Z", "schema": { "additionalProperties": false, "definitions": { diff --git a/artifacts/types/AWS::IoTWireless::WirelessGateway.json b/artifacts/types/AWS::IoTWireless::WirelessGateway.json index d81e996c..cc9a40eb 100644 --- a/artifacts/types/AWS::IoTWireless::WirelessGateway.json +++ b/artifacts/types/AWS::IoTWireless::WirelessGateway.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-IoTWireless-WirelessGateway", "type": "AWS::IoTWireless::WirelessGateway", - "time": "2023-09-07T01:14:12.061Z", + "time": "2024-05-28T17:28:23.934Z", "schema": { "additionalProperties": false, "definitions": { diff --git a/artifacts/types/AWS::KMS::Alias.json b/artifacts/types/AWS::KMS::Alias.json index 6fbf4c1f..37fe89fb 100644 --- a/artifacts/types/AWS::KMS::Alias.json +++ b/artifacts/types/AWS::KMS::Alias.json @@ -1,13 +1,13 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-KMS-Alias", "type": "AWS::KMS::Alias", - "time": "2024-01-04T17:09:44.782Z", + "time": "2024-06-17T18:20:05.421Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ "/properties/AliasName" ], - "description": "The AWS::KMS::Alias resource specifies a display name for an AWS KMS key in AWS Key Management Service (AWS KMS). You can use an alias to identify an AWS KMS key in cryptographic operations.", + "description": "The ``AWS::KMS::Alias`` resource specifies a display name for a [KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys). You can use an alias to identify a KMS key in the KMS console, in the [DescribeKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html) operation, and in [cryptographic operations](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations), such as [Decrypt](https://docs.aws.amazon.com/kms/latest/APIReference/API_Decrypt.html) and [GenerateDataKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_GenerateDataKey.html).\n Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see [ABAC for](https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) in the *Developer Guide*.\n Using an alias to refer to a KMS key can help you simplify key management. For example, an alias in your code can be associated with different KMS keys in different AWS-Regions. For more information, see [Using aliases](https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html) in the *Developer Guide*.\n When specifying an alias, observe the following rules.\n + Each alias is associated with one KMS key, but multiple aliases can be associated with the same KMS key.\n + The alias and its associated KMS key must be in the same AWS-account and Region.\n + The alias name must be unique in the AWS-account and Region. However, you can create aliases with the same name in different AWS-Regions. For example, you can have an ``alias/projectKey`` in multiple Regions, each of which is associated with a KMS key in its Region.\n + Each alias name must begin with ``alias/`` followed by a name, such as ``alias/exampleKey``. The alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). Alias names cannot begin with ``alias/aws/``. That alias name prefix is reserved for [](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk).\n \n *Regions* \n KMS CloudFormation resources are available in all AWS-Regions in which KMS and CFN are supported.", "handlers": { "create": { "permissions": [ @@ -40,14 +40,14 @@ ], "properties": { "AliasName": { - "description": "Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias. The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed keys.", + "description": "Specifies the alias name. This value must begin with ``alias/`` followed by a name, such as ``alias/ExampleAlias``. \n If you change the value of the ``AliasName`` property, the existing alias is deleted and a new alias is created for the specified KMS key. This change can disrupt applications that use the alias. It can also allow or deny access to a KMS key affected by attribute-based access control (ABAC).\n The alias must be string of 1-256 characters. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with ``alias/aws/``. The ``alias/aws/`` prefix is reserved for [](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk).", "maxLength": 256, "minLength": 1, "pattern": "^(alias/)[a-zA-Z0-9:/_-]+$", "type": "string" }, "TargetKeyId": { - "description": "Identifies the AWS KMS key to which the alias refers. Specify the key ID or the Amazon Resource Name (ARN) of the AWS KMS key. You cannot specify another alias. For help finding the key ID and ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.", + "description": "Associates the alias with the specified [](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk). The KMS key must be in the same AWS-account and Region.\n A valid key ID is required. If you supply a null or empty string value, this operation returns an error.\n For help finding the key ID and ARN, see [Finding the key ID and ARN](https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html#find-cmk-id-arn) in the *Developer Guide*.\n Specify the key ID or the key ARN of the KMS key.\n For example:\n + Key ID: ``1234abcd-12ab-34cd-56ef-1234567890ab`` \n + Key ARN: ``arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`` \n \n To get the key ID and key ARN for a KMS key, use [ListKeys](https://docs.aws.amazon.com/kms/latest/APIReference/API_ListKeys.html) or [DescribeKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html).", "maxLength": 256, "minLength": 1, "type": "string" diff --git a/artifacts/types/AWS::KMS::Key.json b/artifacts/types/AWS::KMS::Key.json index 89d1b438..3123e310 100644 --- a/artifacts/types/AWS::KMS::Key.json +++ b/artifacts/types/AWS::KMS::Key.json @@ -1,22 +1,22 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-KMS-Key", "type": "AWS::KMS::Key", - "time": "2023-12-13T17:48:03.372Z", + "time": "2024-06-24T20:07:23.734Z", "schema": { "additionalProperties": false, "definitions": { "Tag": { "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", + "description": "A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.\n Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.\n For information about the rules that apply to tag keys and tag values, see [User-Defined Tag Restrictions](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html) in the *Billing and Cost Management User Guide*.", "properties": { "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "description": "", "maxLength": 128, "minLength": 1, "type": "string" }, "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "description": "", "maxLength": 256, "minLength": 0, "type": "string" @@ -29,7 +29,7 @@ "type": "object" } }, - "description": "The AWS::KMS::Key resource specifies an AWS KMS key in AWS Key Management Service (AWS KMS). Authorized users can use the AWS KMS key to encrypt and decrypt small amounts of data (up to 4096 bytes), but they are more commonly used to generate data keys. You can also use AWS KMS keys to encrypt data stored in AWS services that are integrated with AWS KMS or within their applications.", + "description": "The ``AWS::KMS::Key`` resource specifies an [KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys) in KMSlong. You can use this resource to create symmetric encryption KMS keys, asymmetric KMS keys for encryption or signing, and symmetric HMAC KMS keys. You can use ``AWS::KMS::Key`` to create [multi-Region primary keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html#mrk-primary-key) of all supported types. To replicate a multi-Region key, use the ``AWS::KMS::ReplicaKey`` resource.\n If you change the value of the ``KeySpec``, ``KeyUsage``, ``Origin``, or ``MultiRegion`` properties of an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing any of its immutable property values.\n KMS replaced the term *customer master key (CMK)* with ** and *KMS key*. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.\n You can use symmetric encryption KMS keys to encrypt and decrypt small amounts of data, but they are more commonly used to generate data keys and data key pairs. You can also use a symmetric encryption KMS key to encrypt data stored in AWS services that are [integrated with](https://docs.aws.amazon.com//kms/features/#AWS_Service_Integration). For more information, see [Symmetric encryption KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#symmetric-cmks) in the *Developer Guide*.\n You can use asymmetric KMS keys to encrypt and decrypt data or sign messages and verify signatures. To create an asymmetric key, you must specify an asymmetric ``KeySpec`` value and a ``KeyUsage`` value. For details, see [Asymmetric keys in](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) in the *Developer Guide*.\n You can use HMAC KMS keys (which are also symmetric keys) to generate and verify hash-based message authentication codes. To create an HMAC key, you must specify an HMAC ``KeySpec`` value and a ``KeyUsage`` value of ``GENERATE_VERIFY_MAC``. For details, see [HMAC keys in](https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html) in the *Developer Guide*.\n You can also create symmetric encryption, asymmetric, and HMAC multi-Region primary keys. To create a multi-Region primary key, set the ``MultiRegion`` property to ``true``. For information about multi-Region keys, see [Multi-Region keys in](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the *Developer Guide*.\n You cannot use the ``AWS::KMS::Key`` resource to specify a KMS key with [imported key material](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) or a KMS key in a [custom key store](https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html).\n *Regions* \n KMS CloudFormation resources are available in all Regions in which KMS and CFN are supported. You can use the ``AWS::KMS::Key`` resource to create and manage all KMS key types that are supported in a Region.", "handlers": { "create": { "permissions": [ @@ -80,33 +80,35 @@ ], "properties": { "Arn": { + "description": "", "type": "string" }, "BypassPolicyLockoutSafetyCheck": { "default": false, - "description": "Skips (\"bypasses\") the key policy lockout safety check. The default value is false.", + "description": "Skips (\"bypasses\") the key policy lockout safety check. The default value is false.\n Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately.\n For more information, see [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key) in the *Developer Guide*.\n Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent [PutKeyPolicy](https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) request on the KMS key.", "type": "boolean" }, "Description": { - "description": "A description of the AWS KMS key. Use a description that helps you to distinguish this AWS KMS key from others in the account, such as its intended use.", + "description": "A description of the KMS key. Use a description that helps you to distinguish this KMS key from others in the account, such as its intended use.", "maxLength": 8192, "minLength": 0, "type": "string" }, "EnableKeyRotation": { - "description": "Enables automatic rotation of the key material for the specified AWS KMS key. By default, automation key rotation is not enabled.", + "description": "Enables automatic rotation of the key material for the specified KMS key. By default, automatic key rotation is not enabled.\n KMS supports automatic rotation only for symmetric encryption KMS keys (``KeySpec`` = ``SYMMETRIC_DEFAULT``). For asymmetric KMS keys, HMAC KMS keys, and KMS keys with Origin ``EXTERNAL``, omit the ``EnableKeyRotation`` property or set it to ``false``.\n To enable automatic key rotation of the key material for a multi-Region KMS key, set ``EnableKeyRotation`` to ``true`` on the primary key (created by using ``AWS::KMS::Key``). KMS copies the rotation status to all replica keys. For details, see [Rotating multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-rotate) in the *Developer Guide*.\n When you enable automatic rotation, KMS automatically creates new key material for the KMS key one year after the enable date and every year thereafter. KMS retains all key material until you delete the KMS key. For detailed information about automatic key rotation, see [Rotating KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html) in the *Developer Guide*.", "type": "boolean" }, "Enabled": { - "description": "Specifies whether the AWS KMS key is enabled. Disabled AWS KMS keys cannot be used in cryptographic operations.", + "description": "Specifies whether the KMS key is enabled. Disabled KMS keys cannot be used in cryptographic operations.\n When ``Enabled`` is ``true``, the *key state* of the KMS key is ``Enabled``. When ``Enabled`` is ``false``, the key state of the KMS key is ``Disabled``. The default value is ``true``.\n The actual key state of the KMS key might be affected by actions taken outside of CloudFormation, such as running the [EnableKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_EnableKey.html), [DisableKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DisableKey.html), or [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operations.\n For information about the key states of a KMS key, see [Key state: Effect on your KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *Developer Guide*.", "type": "boolean" }, "KeyId": { + "description": "", "type": "string" }, "KeyPolicy": { "default": "{\n \"Version\": \"2012-10-17\",\n \"Id\": \"key-default\",\n \"Statement\": [\n {\n \"Sid\": \"Enable IAM User Permissions\",\n \"Effect\": \"Allow\",\n \"Principal\": {\n \"AWS\": \"arn:\u003cpartition\u003e:iam::\u003caccount-id\u003e:root\"\n },\n \"Action\": \"kms:*\",\n \"Resource\": \"*\"\n }\n ]\n}", - "description": "The key policy that authorizes use of the AWS KMS key. The key policy must observe the following rules.", + "description": "The key policy to attach to the KMS key.\n If you provide a key policy, it must meet the following criteria:\n + The key policy must allow the caller to make a subsequent [PutKeyPolicy](https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, see [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam) in the *Developer Guide*. (To omit this condition, set ``BypassPolicyLockoutSafetyCheck`` to true.)\n + Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see [Changes that I make are not always immediately visible](https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency) in the *User Guide*.\n \n If you do not provide a key policy, KMS attaches a default key policy to the KMS key. For more information, see [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default) in the *Developer Guide*.\n A key policy document can include only the following characters:\n + Printable ASCII characters\n + Printable characters in the Basic Latin and Latin-1 Supplement character set\n + The tab (``\\u0009``), line feed (``\\u000A``), and carriage return (``\\u000D``) special characters\n \n *Minimum*: ``1`` \n *Maximum*: ``32768``", "type": [ "object", "string" @@ -114,7 +116,7 @@ }, "KeySpec": { "default": "SYMMETRIC_DEFAULT", - "description": "Specifies the type of AWS KMS key to create. The default value is SYMMETRIC_DEFAULT. This property is required only for asymmetric AWS KMS keys. You can't change the KeySpec value after the AWS KMS key is created.", + "description": "Specifies the type of KMS key to create. The default value, ``SYMMETRIC_DEFAULT``, creates a KMS key with a 256-bit symmetric key for encryption and decryption. In China Regions, ``SYMMETRIC_DEFAULT`` creates a 128-bit symmetric key that uses SM4 encryption. You can't change the ``KeySpec`` value after the KMS key is created. For help choosing a key spec for your KMS key, see [Choosing a KMS key type](https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-choose.html) in the *Developer Guide*.\n The ``KeySpec`` property determines the type of key material in the KMS key and the algorithms that the KMS key supports. To further restrict the algorithms that can be used with the KMS key, use a condition key in its key policy or IAM policy. For more information, see [condition keys](https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms) in the *Developer Guide*.\n If you change the value of the ``KeySpec`` property on an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing an immutable property value.\n [services that are integrated with](https://docs.aws.amazon.com/kms/features/#AWS_Service_Integration) use symmetric encryption KMS keys to protect your data. These services do not support encryption with asymmetric KMS keys. For help determining whether a KMS key is asymmetric, see [Identifying asymmetric KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/find-symm-asymm.html) in the *Developer Guide*.\n KMS supports the following key specs for KMS keys:\n + Symmetric encryption key (default)\n + ``SYMMETRIC_DEFAULT`` (AES-256-GCM)\n \n + HMAC keys (symmetric)\n + ``HMAC_224`` \n + ``HMAC_256`` \n + ``HMAC_384`` \n + ``HMAC_512`` \n \n + Asymmetric RSA key pairs\n + ``RSA_2048`` \n + ``RSA_3072`` \n + ``RSA_4096`` \n \n + Asymmetric NIST-recommended elliptic curve key pairs\n + ``ECC_NIST_P256`` (secp256r1)\n + ``ECC_NIST_P384`` (secp384r1)\n + ``ECC_NIST_P521`` (secp521r1)\n \n + Other asymmetric elliptic curve key pairs\n + ``ECC_SECG_P256K1`` (secp256k1), commonly used for cryptocurrencies.\n \n + SM2 key pairs (China Regions only)\n + ``SM2``", "enum": [ "SYMMETRIC_DEFAULT", "RSA_2048", @@ -134,22 +136,23 @@ }, "KeyUsage": { "default": "ENCRYPT_DECRYPT", - "description": "Determines the cryptographic operations for which you can use the AWS KMS key. The default value is ENCRYPT_DECRYPT. This property is required only for asymmetric AWS KMS keys. You can't change the KeyUsage value after the AWS KMS key is created.", + "description": "Determines the [cryptographic operations](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) for which you can use the KMS key. The default value is ``ENCRYPT_DECRYPT``. This property is required for asymmetric KMS keys and HMAC KMS keys. You can't change the ``KeyUsage`` value after the KMS key is created.\n If you change the value of the ``KeyUsage`` property on an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing an immutable property value.\n Select only one valid value.\n + For symmetric encryption KMS keys, omit the property or specify ``ENCRYPT_DECRYPT``.\n + For asymmetric KMS keys with RSA key material, specify ``ENCRYPT_DECRYPT`` or ``SIGN_VERIFY``.\n + For asymmetric KMS keys with ECC key material, specify ``SIGN_VERIFY``.\n + For asymmetric KMS keys with SM2 (China Regions only) key material, specify ``ENCRYPT_DECRYPT`` or ``SIGN_VERIFY``.\n + For HMAC KMS keys, specify ``GENERATE_VERIFY_MAC``.", "enum": [ "ENCRYPT_DECRYPT", "SIGN_VERIFY", - "GENERATE_VERIFY_MAC" + "GENERATE_VERIFY_MAC", + "KEY_AGREEMENT" ], "type": "string" }, "MultiRegion": { "default": false, - "description": "Specifies whether the AWS KMS key should be Multi-Region. You can't change the MultiRegion value after the AWS KMS key is created.", + "description": "Creates a multi-Region primary key that you can replicate in other AWS-Regions. You can't change the ``MultiRegion`` value after the KMS key is created.\n For a list of AWS-Regions in which multi-Region keys are supported, see [Multi-Region keys in](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the **.\n If you change the value of the ``MultiRegion`` property on an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing an immutable property value.\n For a multi-Region key, set to this property to ``true``. For a single-Region key, omit this property or set it to ``false``. The default value is ``false``.\n *Multi-Region keys* are an KMS feature that lets you create multiple interoperable KMS keys in different AWS-Regions. Because these KMS keys have the same key ID, key material, and other metadata, you can use them to encrypt data in one AWS-Region and decrypt it in a different AWS-Region without making a cross-Region call or exposing the plaintext data. For more information, see [Multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the *Developer Guide*.\n You can create a symmetric encryption, HMAC, or asymmetric multi-Region KMS key, and you can create a multi-Region key with imported key material. However, you cannot create a multi-Region key in a custom key store.\n To create a replica of this primary key in a different AWS-Region , create an [AWS::KMS::ReplicaKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-replicakey.html) resource in a CloudFormation stack in the replica Region. Specify the key ARN of this primary key.", "type": "boolean" }, "Origin": { "default": "AWS_KMS", - "description": "The source of the key material for the KMS key. You cannot change the origin after you create the KMS key. The default is AWS_KMS, which means that AWS KMS creates the key material.", + "description": "The source of the key material for the KMS key. You cannot change the origin after you create the KMS key. The default is ``AWS_KMS``, which means that KMS creates the key material.\n To [create a KMS key with no key material](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys-create-cmk.html) (for imported key material), set this value to ``EXTERNAL``. For more information about importing key material into KMS, see [Importing Key Material](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) in the *Developer Guide*.\n You can ignore ``ENABLED`` when Origin is ``EXTERNAL``. When a KMS key with Origin ``EXTERNAL`` is created, the key state is ``PENDING_IMPORT`` and ``ENABLED`` is ``false``. After you import the key material, ``ENABLED`` updated to ``true``. The KMS key can then be used for Cryptographic Operations. \n CFN doesn't support creating an ``Origin`` parameter of the ``AWS_CLOUDHSM`` or ``EXTERNAL_KEY_STORE`` values.", "enum": [ "AWS_KMS", "EXTERNAL" @@ -157,13 +160,20 @@ "type": "string" }, "PendingWindowInDays": { - "description": "Specifies the number of days in the waiting period before AWS KMS deletes an AWS KMS key that has been removed from a CloudFormation stack. Enter a value between 7 and 30 days. The default value is 30 days.", + "description": "Specifies the number of days in the waiting period before KMS deletes a KMS key that has been removed from a CloudFormation stack. Enter a value between 7 and 30 days. The default value is 30 days.\n When you remove a KMS key from a CloudFormation stack, KMS schedules the KMS key for deletion and starts the mandatory waiting period. The ``PendingWindowInDays`` property determines the length of waiting period. During the waiting period, the key state of KMS key is ``Pending Deletion`` or ``Pending Replica Deletion``, which prevents the KMS key from being used in cryptographic operations. When the waiting period expires, KMS permanently deletes the KMS key.\n KMS will not delete a [multi-Region primary key](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) that has replica keys. If you remove a multi-Region primary key from a CloudFormation stack, its key state changes to ``PendingReplicaDeletion`` so it cannot be replicated or used in cryptographic operations. This state can persist indefinitely. When the last of its replica keys is deleted, the key state of the primary key changes to ``PendingDeletion`` and the waiting period specified by ``PendingWindowInDays`` begins. When this waiting period expires, KMS deletes the primary key. For details, see [Deleting multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html) in the *Developer Guide*.\n You cannot use a CloudFormation template to cancel deletion of the KMS key after you remove it from the stack, regardless of the waiting period. If you specify a KMS key in your template, even one with the same name, CloudFormation creates a new KMS key. To cancel deletion of a KMS key, use the KMS console or the [CancelKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_CancelKeyDeletion.html) operation.\n For information about the ``Pending Deletion`` and ``Pending Replica Deletion`` key states, see [Key state: Effect on your KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *Developer Guide*. For more information about deleting KMS keys, see the [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operation in the *API Reference* and [Deleting KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html) in the *Developer Guide*.", "maximum": 30, "minimum": 7, "type": "integer" }, + "RotationPeriodInDays": { + "default": 365, + "description": "Specifies a custom period of time between each rotation date. If no value is specified, the default value is 365 days.\n The rotation period defines the number of days after you enable automatic key rotation that KMS will rotate your key material, and the number of days between each automatic rotation thereafter.\n You can use the [kms:RotationPeriodInDays](https://docs.aws.amazon.com/kms/latest/developerguide/conditions-kms.html#conditions-kms-rotation-period-in-days) condition key to further constrain the values that principals can specify in the ``RotationPeriodInDays`` parameter.\n For more information about rotating KMS keys and automatic rotation, see [Rotating keys](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html) in the *Developer Guide*.", + "maximum": 2560, + "minimum": 90, + "type": "integer" + }, "Tags": { - "description": "An array of key-value pairs to apply to this resource.", + "description": "Assigns one or more tags to the replica key.\n Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see [ABAC for](https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) in the *Developer Guide*.\n For information about tags in KMS, see [Tagging keys](https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html) in the *Developer Guide*. For information about tags in CloudFormation, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).", "insertionOrder": false, "items": { "$ref": "#/definitions/Tag" @@ -180,13 +190,15 @@ "tagging": { "cloudFormationSystemTags": false, "tagOnCreate": true, + "tagProperty": "/properties/Tags", "tagUpdatable": true, "taggable": true }, "typeName": "AWS::KMS::Key", "writeOnlyProperties": [ "/properties/PendingWindowInDays", - "/properties/BypassPolicyLockoutSafetyCheck" + "/properties/BypassPolicyLockoutSafetyCheck", + "/properties/RotationPeriodInDays" ] } } \ No newline at end of file diff --git a/artifacts/types/AWS::KMS::ReplicaKey.json b/artifacts/types/AWS::KMS::ReplicaKey.json index 73d6a13d..7240737e 100644 --- a/artifacts/types/AWS::KMS::ReplicaKey.json +++ b/artifacts/types/AWS::KMS::ReplicaKey.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-KMS-ReplicaKey", "type": "AWS::KMS::ReplicaKey", - "time": "2023-12-13T16:12:51.844Z", + "time": "2024-06-24T19:42:45.266Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::KafkaConnect::Connector.json b/artifacts/types/AWS::KafkaConnect::Connector.json index d3d5d978..c6da6d5c 100644 --- a/artifacts/types/AWS::KafkaConnect::Connector.json +++ b/artifacts/types/AWS::KafkaConnect::Connector.json @@ -1,8 +1,13 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-KafkaConnect-Connector", "type": "AWS::KafkaConnect::Connector", - "time": "2023-06-21T09:46:42.272Z", + "time": "2024-04-09T14:57:18.223Z", "schema": { + "additionalIdentifiers": [ + [ + "/properties/ConnectorName" + ] + ], "additionalProperties": false, "createOnlyProperties": [ "/properties/ConnectorConfiguration", @@ -316,6 +321,25 @@ ], "type": "object" }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + }, "Vpc": { "additionalProperties": false, "description": "Information about a VPC used with the connector.", @@ -391,6 +415,8 @@ "permissions": [ "kafkaconnect:CreateConnector", "kafkaconnect:DescribeConnector", + "kafkaconnect:TagResource", + "kafkaconnect:ListTagsForResource", "iam:CreateServiceLinkedRole", "iam:PassRole", "ec2:CreateNetworkInterface", @@ -424,13 +450,17 @@ }, "read": { "permissions": [ - "kafkaconnect:DescribeConnector" + "kafkaconnect:DescribeConnector", + "kafkaconnect:ListTagsForResource" ] }, "update": { "permissions": [ "kafkaconnect:UpdateConnector", "kafkaconnect:DescribeConnector", + "kafkaconnect:TagResource", + "kafkaconnect:ListTagsForResource", + "kafkaconnect:UntagResource", "iam:CreateServiceLinkedRole", "logs:UpdateLogDelivery", "logs:GetLogDelivery", @@ -508,6 +538,15 @@ "pattern": "arn:(aws|aws-us-gov|aws-cn):iam:.*", "type": "string" }, + "Tags": { + "description": "A collection of tags associated with a resource", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, "WorkerConfiguration": { "$ref": "#/definitions/WorkerConfiguration" } @@ -528,7 +567,13 @@ "ServiceExecutionRoleArn" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-kafkaconnect.git", - "taggable": false, + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, "typeName": "AWS::KafkaConnect::Connector" } } \ No newline at end of file diff --git a/artifacts/types/AWS::KafkaConnect::CustomPlugin.json b/artifacts/types/AWS::KafkaConnect::CustomPlugin.json new file mode 100644 index 00000000..9128f5dd --- /dev/null +++ b/artifacts/types/AWS::KafkaConnect::CustomPlugin.json @@ -0,0 +1,204 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-KafkaConnect-CustomPlugin", + "type": "AWS::KafkaConnect::CustomPlugin", + "time": "2024-04-09T09:22:13.321Z", + "schema": { + "additionalIdentifiers": [ + [ + "/properties/Name" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/Description", + "/properties/ContentType", + "/properties/Location" + ], + "definitions": { + "CustomPluginFileDescription": { + "additionalProperties": false, + "description": "Details about the custom plugin file.", + "properties": { + "FileMd5": { + "description": "The hex-encoded MD5 checksum of the custom plugin file. You can use it to validate the file.", + "type": "string" + }, + "FileSize": { + "description": "The size in bytes of the custom plugin file. You can use it to validate the file.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "CustomPluginLocation": { + "additionalProperties": false, + "description": "Information about the location of a custom plugin.", + "properties": { + "S3Location": { + "$ref": "#/definitions/S3Location" + } + }, + "required": [ + "S3Location" + ], + "type": "object" + }, + "S3Location": { + "additionalProperties": false, + "description": "The S3 bucket Amazon Resource Name (ARN), file key, and object version of the plugin file stored in Amazon S3.", + "properties": { + "BucketArn": { + "description": "The Amazon Resource Name (ARN) of an S3 bucket.", + "type": "string" + }, + "FileKey": { + "description": "The file key for an object in an S3 bucket.", + "type": "string" + }, + "ObjectVersion": { + "description": "The version of an object in an S3 bucket.", + "type": "string" + } + }, + "required": [ + "BucketArn", + "FileKey" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "An example resource schema demonstrating some basic constructs and validation rules.", + "handlers": { + "create": { + "permissions": [ + "kafkaconnect:DescribeCustomPlugin", + "kafkaconnect:ListTagsForResource", + "kafkaconnect:CreateCustomPlugin", + "kafkaconnect:TagResource", + "s3:GetObject", + "s3:GetObjectVersion", + "s3:GetObjectAttributes", + "s3:GetObjectVersionAttributes" + ] + }, + "delete": { + "permissions": [ + "kafkaconnect:DeleteCustomPlugin", + "kafkaconnect:DescribeCustomPlugin" + ] + }, + "list": { + "permissions": [ + "kafkaconnect:ListCustomPlugins" + ] + }, + "read": { + "permissions": [ + "kafkaconnect:DescribeCustomPlugin", + "kafkaconnect:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "kafkaconnect:DescribeCustomPlugin", + "kafkaconnect:ListTagsForResource", + "kafkaconnect:TagResource", + "kafkaconnect:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/CustomPluginArn" + ], + "properties": { + "ContentType": { + "description": "The type of the plugin file.", + "enum": [ + "JAR", + "ZIP" + ], + "type": "string" + }, + "CustomPluginArn": { + "description": "The Amazon Resource Name (ARN) of the custom plugin to use.", + "pattern": "arn:(aws|aws-us-gov|aws-cn):kafkaconnect:.*", + "type": "string" + }, + "Description": { + "description": "A summary description of the custom plugin.", + "maxLength": 1024, + "type": "string" + }, + "FileDescription": { + "$ref": "#/definitions/CustomPluginFileDescription" + }, + "Location": { + "$ref": "#/definitions/CustomPluginLocation" + }, + "Name": { + "description": "The name of the custom plugin.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Revision": { + "description": "The revision of the custom plugin.", + "format": "int64", + "type": "integer" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/CustomPluginArn", + "/properties/Revision", + "/properties/FileDescription" + ], + "required": [ + "Name", + "ContentType", + "Location" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::KafkaConnect::CustomPlugin" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::KafkaConnect::WorkerConfiguration.json b/artifacts/types/AWS::KafkaConnect::WorkerConfiguration.json new file mode 100644 index 00000000..f59f9cfc --- /dev/null +++ b/artifacts/types/AWS::KafkaConnect::WorkerConfiguration.json @@ -0,0 +1,131 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-KafkaConnect-WorkerConfiguration", + "type": "AWS::KafkaConnect::WorkerConfiguration", + "time": "2024-04-09T09:12:59.732Z", + "schema": { + "additionalIdentifiers": [ + [ + "/properties/Name" + ] + ], + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/Description", + "/properties/PropertiesFileContent" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "The configuration of the workers, which are the processes that run the connector logic.", + "handlers": { + "create": { + "permissions": [ + "kafkaconnect:DescribeWorkerConfiguration", + "kafkaconnect:CreateWorkerConfiguration", + "kafkaconnect:TagResource", + "kafkaconnect:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "kafkaconnect:DescribeWorkerConfiguration", + "kafkaconnect:DeleteWorkerConfiguration" + ] + }, + "list": { + "permissions": [ + "kafkaconnect:ListWorkerConfigurations" + ] + }, + "read": { + "permissions": [ + "kafkaconnect:DescribeWorkerConfiguration", + "kafkaconnect:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "kafkaconnect:DescribeWorkerConfiguration", + "kafkaconnect:ListTagsForResource", + "kafkaconnect:TagResource", + "kafkaconnect:UntagResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/WorkerConfigurationArn" + ], + "properties": { + "Description": { + "description": "A summary description of the worker configuration.", + "maxLength": 1024, + "type": "string" + }, + "Name": { + "description": "The name of the worker configuration.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "PropertiesFileContent": { + "description": "Base64 encoded contents of connect-distributed.properties file.", + "type": "string" + }, + "Revision": { + "description": "The description of a revision of the worker configuration.", + "format": "int64", + "type": "integer" + }, + "Tags": { + "description": "A collection of tags associated with a resource", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": true + }, + "WorkerConfigurationArn": { + "description": "The Amazon Resource Name (ARN) of the custom configuration.", + "pattern": "arn:(aws|aws-us-gov|aws-cn):kafkaconnect:.*", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/WorkerConfigurationArn", + "/properties/Revision" + ], + "required": [ + "Name", + "PropertiesFileContent" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-kafkaconnect.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::KafkaConnect::WorkerConfiguration" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::Kendra::DataSource.json b/artifacts/types/AWS::Kendra::DataSource.json index 69cd8049..f6b11e3c 100644 --- a/artifacts/types/AWS::Kendra::DataSource.json +++ b/artifacts/types/AWS::Kendra::DataSource.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Kendra-DataSource", "type": "AWS::Kendra::DataSource", - "time": "2023-12-07T23:56:34.998Z", + "time": "2024-06-20T21:58:59.695Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Kendra::Faq.json b/artifacts/types/AWS::Kendra::Faq.json index 753b626e..3fd4bade 100644 --- a/artifacts/types/AWS::Kendra::Faq.json +++ b/artifacts/types/AWS::Kendra::Faq.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Kendra-Faq", "type": "AWS::Kendra::Faq", - "time": "2023-12-07T17:09:52.248Z", + "time": "2024-06-20T13:37:36.442Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -45,6 +45,13 @@ "minLength": 36, "type": "string" }, + "LanguageCode": { + "description": "The code for a language.", + "maxLength": 10, + "minLength": 2, + "pattern": "[a-zA-Z-]*", + "type": "string" + }, "RoleArn": { "maxLength": 1284, "minLength": 1, @@ -170,6 +177,9 @@ "$ref": "#/definitions/IndexId", "description": "Index ID" }, + "LanguageCode": { + "$ref": "#/definitions/LanguageCode" + }, "Name": { "$ref": "#/definitions/FaqName", "description": "FAQ name" diff --git a/artifacts/types/AWS::Kendra::Index.json b/artifacts/types/AWS::Kendra::Index.json index 7b3486b4..d7270745 100644 --- a/artifacts/types/AWS::Kendra::Index.json +++ b/artifacts/types/AWS::Kendra::Index.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Kendra-Index", "type": "AWS::Kendra::Index", - "time": "2023-12-07T17:09:59.71Z", + "time": "2024-06-20T20:56:29.233Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::KendraRanking::ExecutionPlan.json b/artifacts/types/AWS::KendraRanking::ExecutionPlan.json index 3e21f613..e35bce75 100644 --- a/artifacts/types/AWS::KendraRanking::ExecutionPlan.json +++ b/artifacts/types/AWS::KendraRanking::ExecutionPlan.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-KendraRanking-ExecutionPlan", "type": "AWS::KendraRanking::ExecutionPlan", - "time": "2024-01-03T16:17:43.092Z", + "time": "2024-06-04T15:11:45.409Z", "schema": { "additionalProperties": false, "definitions": { diff --git a/artifacts/types/AWS::Kinesis::Stream.json b/artifacts/types/AWS::Kinesis::Stream.json index 10d753e0..15e1898c 100644 --- a/artifacts/types/AWS::Kinesis::Stream.json +++ b/artifacts/types/AWS::Kinesis::Stream.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Kinesis-Stream", "type": "AWS::Kinesis::Stream", - "time": "2024-01-03T21:29:14.283Z", + "time": "2024-03-20T17:32:51.148Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -20,6 +20,20 @@ "type": "string" }, "KeyId": { + "anyOf": [ + { + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::KMS::Key" + } + }, + { + "relationshipRef": { + "propertyPath": "/properties/KeyId", + "typeName": "AWS::KMS::Key" + } + } + ], "description": "The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified Amazon Resource Name (ARN) to either an alias or a key, or an alias name prefixed by \"alias/\".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.", "maxLength": 2048, "minLength": 1, diff --git a/artifacts/types/AWS::KinesisAnalyticsV2::Application.json b/artifacts/types/AWS::KinesisAnalyticsV2::Application.json index 8185789f..44ac7009 100644 --- a/artifacts/types/AWS::KinesisAnalyticsV2::Application.json +++ b/artifacts/types/AWS::KinesisAnalyticsV2::Application.json @@ -1,13 +1,12 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-KinesisAnalyticsV2-Application", "type": "AWS::KinesisAnalyticsV2::Application", - "time": "2023-12-22T19:01:42.243Z", + "time": "2024-06-19T17:40:48.025Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ "/properties/ApplicationName", - "/properties/ApplicationMode", - "/properties/RuntimeEnvironment" + "/properties/ApplicationMode" ], "definitions": { "ApplicationCodeConfiguration": { @@ -45,6 +44,10 @@ "$ref": "#/definitions/ApplicationSnapshotConfiguration", "description": "Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application." }, + "ApplicationSystemRollbackConfiguration": { + "$ref": "#/definitions/ApplicationSystemRollbackConfiguration", + "description": "Describes whether system initiated rollbacks are enabled for a Flink-based Kinesis Data Analytics application." + }, "EnvironmentProperties": { "$ref": "#/definitions/EnvironmentProperties", "description": "Describes execution properties for a Flink-based Kinesis Data Analytics application." @@ -123,6 +126,20 @@ ], "type": "object" }, + "ApplicationSystemRollbackConfiguration": { + "additionalProperties": false, + "description": "Describes whether system initiated rollbacks are enabled for a Flink-based Kinesis Data Analytics application.", + "properties": { + "RollbackEnabled": { + "description": "Describes whether system initiated rollbacks are enabled for a Flink-based Kinesis Data Analytics application.", + "type": "boolean" + } + }, + "required": [ + "RollbackEnabled" + ], + "type": "object" + }, "Arn": { "description": "The Amazon Resource Name", "maxLength": 2048, diff --git a/artifacts/types/AWS::KinesisFirehose::DeliveryStream.json b/artifacts/types/AWS::KinesisFirehose::DeliveryStream.json index ebb29d92..c0c50d58 100644 --- a/artifacts/types/AWS::KinesisFirehose::DeliveryStream.json +++ b/artifacts/types/AWS::KinesisFirehose::DeliveryStream.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-KinesisFirehose-DeliveryStream", "type": "AWS::KinesisFirehose::DeliveryStream", - "time": "2023-12-26T16:22:56.215Z", + "time": "2024-06-13T15:19:26.547Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -11,7 +11,8 @@ "/properties/AmazonopensearchserviceDestinationConfiguration/VpcConfiguration", "/properties/AmazonOpenSearchServerlessDestinationConfiguration/VpcConfiguration", "/properties/KinesisStreamSourceConfiguration", - "/properties/MSKSourceConfiguration" + "/properties/MSKSourceConfiguration", + "/properties/SnowflakeDestinationConfiguration/SnowflakeVpcConfiguration" ], "definitions": { "AmazonOpenSearchServerlessBufferingHints": { @@ -39,6 +40,10 @@ "maxLength": 512, "minLength": 1, "pattern": "https:.*", + "relationshipRef": { + "propertyPath": "/properties/CollectionEndpoint", + "typeName": "AWS::OpenSearchServerless::Collection" + }, "type": "string" }, "IndexName": { @@ -56,6 +61,10 @@ "maxLength": 512, "minLength": 1, "pattern": "arn:.*", + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::IAM::Role" + }, "type": "string" }, "S3BackupMode": { @@ -149,6 +158,10 @@ "maxLength": 512, "minLength": 1, "pattern": "arn:.*", + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::IAM::Role" + }, "type": "string" }, "S3BackupMode": { @@ -200,6 +213,10 @@ "maxLength": 512, "minLength": 1, "pattern": "arn:.*", + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::IAM::Role" + }, "type": "string" } }, @@ -228,9 +245,17 @@ "type": "boolean" }, "LogGroupName": { + "relationshipRef": { + "propertyPath": "/properties/LogGroupName", + "typeName": "AWS::Logs::LogGroup" + }, "type": "string" }, "LogStreamName": { + "relationshipRef": { + "propertyPath": "/properties/LogStreamName", + "typeName": "AWS::Logs::LogStream" + }, "type": "string" } }, @@ -285,6 +310,10 @@ "maxLength": 512, "minLength": 1, "pattern": "arn:.*", + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::KMS::Key" + }, "type": "string" }, "KeyType": { @@ -371,6 +400,20 @@ "$ref": "#/definitions/DocumentIdOptions" }, "DomainARN": { + "anyOf": [ + { + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::Elasticsearch::Domain" + } + }, + { + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::OpenSearchService::Domain" + } + } + ], "maxLength": 512, "minLength": 1, "pattern": "arn:.*", @@ -401,6 +444,10 @@ "maxLength": 512, "minLength": 1, "pattern": "arn:.*", + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::IAM::Role" + }, "type": "string" }, "S3BackupMode": { @@ -460,6 +507,10 @@ "maxLength": 2048, "minLength": 1, "pattern": "arn:.*", + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::S3::Bucket" + }, "type": "string" }, "BufferingHints": { @@ -478,6 +529,11 @@ ], "type": "string" }, + "CustomTimeZone": { + "maxLength": 50, + "minLength": 0, + "type": "string" + }, "DataFormatConversionConfiguration": { "$ref": "#/definitions/DataFormatConversionConfiguration" }, @@ -492,6 +548,12 @@ "minLength": 0, "type": "string" }, + "FileExtension": { + "maxLength": 128, + "minLength": 0, + "pattern": "^$|\\.[0-9a-z!\\-_.*'()]+", + "type": "string" + }, "Prefix": { "maxLength": 1024, "minLength": 0, @@ -504,6 +566,10 @@ "maxLength": 512, "minLength": 1, "pattern": "arn:.*", + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::IAM::Role" + }, "type": "string" }, "S3BackupConfiguration": { @@ -605,6 +671,10 @@ "maxLength": 512, "minLength": 1, "pattern": "arn:.*", + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::IAM::Role" + }, "type": "string" }, "S3BackupMode": { @@ -612,6 +682,9 @@ }, "S3Configuration": { "$ref": "#/definitions/S3DestinationConfiguration" + }, + "SecretsManagerConfiguration": { + "$ref": "#/definitions/SecretsManagerConfiguration" } }, "required": [ @@ -655,6 +728,10 @@ "additionalProperties": false, "properties": { "AWSKMSKeyARN": { + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::KMS::Key" + }, "type": "string" } }, @@ -670,12 +747,20 @@ "maxLength": 512, "minLength": 1, "pattern": "arn:.*", + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::Kinesis::Stream" + }, "type": "string" }, "RoleARN": { "maxLength": 512, "minLength": 1, "pattern": "arn:.*", + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::IAM::Role" + }, "type": "string" } }, @@ -695,6 +780,10 @@ "maxLength": 512, "minLength": 1, "pattern": "arn:.*", + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::MSK::Cluster" + }, "type": "string" }, "TopicName": { @@ -718,6 +807,7 @@ "type": "boolean" }, "ColumnToJsonKeyMappings": { + "additionalProperties": false, "patternProperties": { "[a-zA-Z0-9]+": { "type": "string" @@ -834,6 +924,7 @@ "enum": [ "RecordDeAggregation", "Decompression", + "CloudWatchLogProcessing", "Lambda", "MetadataExtraction", "AppendDelimiterToRecord" @@ -853,6 +944,26 @@ "type": "string" }, "ParameterValue": { + "anyOf": [ + { + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::Lambda::Function" + } + }, + { + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::IAM::Role" + } + }, + { + "relationshipRef": { + "propertyPath": "/properties/Id", + "typeName": "AWS::Lambda::Alias" + } + } + ], "type": "string" } }, @@ -891,6 +1002,10 @@ "maxLength": 512, "minLength": 1, "pattern": "arn:.*", + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::IAM::Role" + }, "type": "string" }, "S3BackupConfiguration": { @@ -906,6 +1021,9 @@ "S3Configuration": { "$ref": "#/definitions/S3DestinationConfiguration" }, + "SecretsManagerConfiguration": { + "$ref": "#/definitions/SecretsManagerConfiguration" + }, "Username": { "maxLength": 512, "minLength": 1, @@ -914,11 +1032,9 @@ }, "required": [ "S3Configuration", - "Username", "ClusterJDBCURL", "CopyCommand", - "RoleARN", - "Password" + "RoleARN" ], "type": "object" }, @@ -947,6 +1063,10 @@ "maxLength": 2048, "minLength": 1, "pattern": "arn:.*", + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::S3::Bucket" + }, "type": "string" }, "BufferingHints": { @@ -982,6 +1102,10 @@ "maxLength": 512, "minLength": 1, "pattern": "arn:.*", + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::IAM::Role" + }, "type": "string" } }, @@ -998,6 +1122,10 @@ "type": "string" }, "DatabaseName": { + "relationshipRef": { + "propertyPath": "/properties/Id", + "typeName": "AWS::Glue::Database" + }, "type": "string" }, "Region": { @@ -1007,9 +1135,17 @@ "maxLength": 512, "minLength": 1, "pattern": "arn:.*", + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::IAM::Role" + }, "type": "string" }, "TableName": { + "relationshipRef": { + "propertyPath": "/properties/Id", + "typeName": "AWS::Glue::Table" + }, "type": "string" }, "VersionId": { @@ -1018,6 +1154,38 @@ }, "type": "object" }, + "SecretsManagerConfiguration": { + "additionalProperties": false, + "properties": { + "Enabled": { + "type": "boolean" + }, + "RoleARN": { + "maxLength": 512, + "minLength": 1, + "pattern": "arn:.*", + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::IAM::Role" + }, + "type": "string" + }, + "SecretARN": { + "maxLength": 512, + "minLength": 1, + "pattern": "arn:.*", + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::SecretsManager::Secret" + }, + "type": "string" + } + }, + "required": [ + "Enabled" + ], + "type": "object" + }, "Serializer": { "additionalProperties": false, "properties": { @@ -1030,6 +1198,151 @@ }, "type": "object" }, + "SnowflakeDestinationConfiguration": { + "additionalProperties": false, + "properties": { + "AccountUrl": { + "maxLength": 2048, + "minLength": 24, + "pattern": ".+?\\.snowflakecomputing\\.com", + "type": "string" + }, + "CloudWatchLoggingOptions": { + "$ref": "#/definitions/CloudWatchLoggingOptions" + }, + "ContentColumnName": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "DataLoadingOption": { + "enum": [ + "JSON_MAPPING", + "VARIANT_CONTENT_MAPPING", + "VARIANT_CONTENT_AND_METADATA_MAPPING" + ], + "type": "string" + }, + "Database": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "KeyPassphrase": { + "maxLength": 255, + "minLength": 7, + "type": "string" + }, + "MetaDataColumnName": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "PrivateKey": { + "maxLength": 4096, + "minLength": 256, + "pattern": "^(?:[A-Za-z0-9+\\/]{4})*(?:[A-Za-z0-9+\\/]{2}==|[A-Za-z0-9+\\/]{3}=)?$", + "type": "string" + }, + "ProcessingConfiguration": { + "$ref": "#/definitions/ProcessingConfiguration" + }, + "RetryOptions": { + "$ref": "#/definitions/SnowflakeRetryOptions" + }, + "RoleARN": { + "maxLength": 512, + "minLength": 1, + "pattern": "arn:.*", + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::IAM::Role" + }, + "type": "string" + }, + "S3BackupMode": { + "enum": [ + "FailedDataOnly", + "AllData" + ], + "type": "string" + }, + "S3Configuration": { + "$ref": "#/definitions/S3DestinationConfiguration" + }, + "Schema": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "SecretsManagerConfiguration": { + "$ref": "#/definitions/SecretsManagerConfiguration" + }, + "SnowflakeRoleConfiguration": { + "$ref": "#/definitions/SnowflakeRoleConfiguration" + }, + "SnowflakeVpcConfiguration": { + "$ref": "#/definitions/SnowflakeVpcConfiguration" + }, + "Table": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "User": { + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "AccountUrl", + "Database", + "Schema", + "Table", + "RoleARN", + "S3Configuration" + ], + "type": "object" + }, + "SnowflakeRetryOptions": { + "additionalProperties": false, + "properties": { + "DurationInSeconds": { + "type": "integer" + } + }, + "type": "object" + }, + "SnowflakeRoleConfiguration": { + "additionalProperties": false, + "properties": { + "Enabled": { + "type": "boolean" + }, + "SnowflakeRole": { + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "SnowflakeVpcConfiguration": { + "additionalProperties": false, + "properties": { + "PrivateLinkVpceId": { + "maxLength": 255, + "minLength": 47, + "pattern": "([a-zA-Z0-9\\-\\_]+\\.){2,3}vpce\\.[a-zA-Z0-9\\-]*\\.vpce-svc\\-[a-zA-Z0-9\\-]{17}$", + "type": "string" + } + }, + "required": [ + "PrivateLinkVpceId" + ], + "type": "object" + }, "SplunkBufferingHints": { "additionalProperties": false, "properties": { @@ -1084,12 +1397,14 @@ }, "S3Configuration": { "$ref": "#/definitions/S3DestinationConfiguration" + }, + "SecretsManagerConfiguration": { + "$ref": "#/definitions/SecretsManagerConfiguration" } }, "required": [ "HECEndpoint", "S3Configuration", - "HECToken", "HECEndpointType" ], "type": "object" @@ -1104,6 +1419,7 @@ "type": "object" }, "Tag": { + "additionalProperties": false, "properties": { "Key": { "maxLength": 128, @@ -1130,12 +1446,20 @@ "maxLength": 512, "minLength": 1, "pattern": "arn:.*", + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::IAM::Role" + }, "type": "string" }, "SecurityGroupIds": { "items": { "maxLength": 1024, "minLength": 1, + "relationshipRef": { + "propertyPath": "/properties/GroupId", + "typeName": "AWS::EC2::SecurityGroup" + }, "type": "string" }, "maxItems": 5, @@ -1147,6 +1471,10 @@ "items": { "maxLength": 1024, "minLength": 1, + "relationshipRef": { + "propertyPath": "/properties/SubnetId", + "typeName": "AWS::EC2::Subnet" + }, "type": "string" }, "maxItems": 16, @@ -1260,6 +1588,9 @@ "S3DestinationConfiguration": { "$ref": "#/definitions/S3DestinationConfiguration" }, + "SnowflakeDestinationConfiguration": { + "$ref": "#/definitions/SnowflakeDestinationConfiguration" + }, "SplunkDestinationConfiguration": { "$ref": "#/definitions/SplunkDestinationConfiguration" }, diff --git a/artifacts/types/AWS::LakeFormation::Tag.json b/artifacts/types/AWS::LakeFormation::Tag.json index 48a34826..3635e58a 100644 --- a/artifacts/types/AWS::LakeFormation::Tag.json +++ b/artifacts/types/AWS::LakeFormation::Tag.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-LakeFormation-Tag", "type": "AWS::LakeFormation::Tag", - "time": "2023-04-13T18:23:57.529Z", + "time": "2024-03-06T19:16:28.195Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Lambda::CodeSigningConfig.json b/artifacts/types/AWS::Lambda::CodeSigningConfig.json index df194f0e..037efe7a 100644 --- a/artifacts/types/AWS::Lambda::CodeSigningConfig.json +++ b/artifacts/types/AWS::Lambda::CodeSigningConfig.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Lambda-CodeSigningConfig", "type": "AWS::Lambda::CodeSigningConfig", - "time": "2024-01-03T16:25:13.712Z", + "time": "2024-02-06T17:08:51.755Z", "schema": { "additionalProperties": false, "definitions": { diff --git a/artifacts/types/AWS::Lambda::EventInvokeConfig.json b/artifacts/types/AWS::Lambda::EventInvokeConfig.json index 6f6f55a4..4b1a10fe 100644 --- a/artifacts/types/AWS::Lambda::EventInvokeConfig.json +++ b/artifacts/types/AWS::Lambda::EventInvokeConfig.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Lambda-EventInvokeConfig", "type": "AWS::Lambda::EventInvokeConfig", - "time": "2023-12-08T02:07:27.56Z", + "time": "2024-03-07T16:34:01.071Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Lambda::EventSourceMapping.json b/artifacts/types/AWS::Lambda::EventSourceMapping.json index f8279213..a98dcedf 100644 --- a/artifacts/types/AWS::Lambda::EventSourceMapping.json +++ b/artifacts/types/AWS::Lambda::EventSourceMapping.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Lambda-EventSourceMapping", "type": "AWS::Lambda::EventSourceMapping", - "time": "2023-06-22T19:37:40.328Z", + "time": "2024-06-17T16:46:36.997Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -15,11 +15,11 @@ "definitions": { "AmazonManagedKafkaEventSourceConfig": { "additionalProperties": false, - "description": "Specific configuration settings for an MSK event source.", + "description": "Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.", "properties": { "ConsumerGroupId": { "$ref": "#/definitions/ConsumerGroupId", - "description": "The identifier for the Kafka Consumer Group to join." + "description": "The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer 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-msk.html#services-msk-consumer-group-id)." } }, "type": "object" @@ -33,7 +33,7 @@ }, "DestinationConfig": { "additionalProperties": false, - "description": "(Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.", + "description": "A configuration object that specifies the destination of an event after Lambda processes it.", "properties": { "OnFailure": { "$ref": "#/definitions/OnFailure", @@ -44,22 +44,22 @@ }, "DocumentDBEventSourceConfig": { "additionalProperties": false, - "description": "Document db event source config.", + "description": "Specific configuration settings for a DocumentDB event source.", "properties": { "CollectionName": { - "description": "The collection name to connect to.", + "description": "The name of the collection to consume within the database. If you do not specify a collection, Lambda consumes all collections.", "maxLength": 57, "minLength": 1, "type": "string" }, "DatabaseName": { - "description": "The database name to connect to.", + "description": "The name of the database to consume within the DocumentDB cluster.", "maxLength": 63, "minLength": 1, "type": "string" }, "FullDocument": { - "description": "Include full document in change stream response. The default option will only send the changes made to documents to Lambda. If you want the complete document sent to Lambda, set this to UpdateLookup.", + "description": "Determines 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.", "enum": [ "UpdateLookup", "Default" @@ -71,10 +71,10 @@ }, "Endpoints": { "additionalProperties": false, - "description": "The endpoints used by AWS Lambda to access a self-managed event source.", + "description": "The list of bootstrap servers for your Kafka brokers in the following format: ``\"KafkaBootstrapServers\": [\"abc.xyz.com:xxxx\",\"abc2.xyz.com:xxxx\"]``.", "properties": { "KafkaBootstrapServers": { - "description": "A list of Kafka server endpoints.", + "description": "The list of bootstrap servers for your Kafka brokers in the following format: ``\"KafkaBootstrapServers\": [\"abc.xyz.com:xxxx\",\"abc2.xyz.com:xxxx\"]``.", "items": { "description": "The URL of a Kafka server.", "maxLength": 300, @@ -92,10 +92,10 @@ }, "Filter": { "additionalProperties": false, - "description": "The filter object that defines parameters for ESM filtering.", + "description": "A structure within a ``FilterCriteria`` object that defines an event filtering pattern.", "properties": { "Pattern": { - "description": "The filter pattern that defines which events should be passed for invocations.", + "description": "A filter pattern. For more information on the syntax of a filter pattern, see [Filter rule syntax](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html#filtering-syntax).", "maxLength": 4096, "minLength": 0, "pattern": ".*", @@ -106,10 +106,10 @@ }, "FilterCriteria": { "additionalProperties": false, - "description": "The filter criteria to control event filtering.", + "description": "An object that contains the filters for an event source.", "properties": { "Filters": { - "description": "List of filters of this FilterCriteria", + "description": "A list of filters.", "items": { "$ref": "#/definitions/Filter" }, @@ -132,10 +132,10 @@ "description": "A destination for events that failed processing.", "properties": { "Destination": { - "description": "The Amazon Resource Name (ARN) of the destination resource.", + "description": "The Amazon Resource Name (ARN) of the destination resource.\n To retain records of [asynchronous invocations](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-async-destinations), you can configure an Amazon SNS topic, Amazon SQS queue, Lambda function, or Amazon EventBridge event bus as the destination.\n To retain records of failed invocations from [Kinesis and DynamoDB event sources](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventsourcemapping.html#event-source-mapping-destinations), you can configure an Amazon SNS topic or Amazon SQS queue as the destination.\n To retain records of failed invocations from [self-managed Kafka](https://docs.aws.amazon.com/lambda/latest/dg/with-kafka.html#services-smaa-onfailure-destination) or [Amazon MSK](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-onfailure-destination), you can configure an Amazon SNS topic, Amazon SQS queue, or Amazon S3 bucket as the destination.", "maxLength": 1024, "minLength": 12, - "pattern": "arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-])+:([a-z]{2}(-gov)?-[a-z]+-\\d{1})?:(\\d{12})?:(.*)", + "pattern": "arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-])+:([a-z]{2}(-gov)?(-iso([a-z])?)?-[a-z]+-\\d{1})?:(\\d{12})?:(.*)", "type": "string" } }, @@ -143,43 +143,43 @@ }, "ScalingConfig": { "additionalProperties": false, - "description": "The scaling configuration for the event source.", + "description": "(Amazon SQS only) The scaling configuration for the event source. To remove the configuration, pass an empty value.", "properties": { "MaximumConcurrency": { "$ref": "#/definitions/MaximumConcurrency", - "description": "The maximum number of concurrent functions that the event source can invoke." + "description": "Limits the number of concurrent instances that the SQS event source can invoke." } }, "type": "object" }, "SelfManagedEventSource": { "additionalProperties": false, - "description": "The configuration used by AWS Lambda to access a self-managed event source.", + "description": "The self-managed Apache Kafka cluster for your event source.", "properties": { "Endpoints": { "$ref": "#/definitions/Endpoints", - "description": "The endpoints for a self-managed event source." + "description": "The list of bootstrap servers for your Kafka brokers in the following format: ``\"KafkaBootstrapServers\": [\"abc.xyz.com:xxxx\",\"abc2.xyz.com:xxxx\"]``." } }, "type": "object" }, "SelfManagedKafkaEventSourceConfig": { "additionalProperties": false, - "description": "Specific configuration settings for a Self-Managed Apache Kafka event source.", + "description": "Specific configuration settings for a self-managed Apache Kafka event source.", "properties": { "ConsumerGroupId": { "$ref": "#/definitions/ConsumerGroupId", - "description": "The identifier for the Kafka Consumer Group to join." + "description": "The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer 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-msk.html#services-msk-consumer-group-id)." } }, "type": "object" }, "SourceAccessConfiguration": { "additionalProperties": false, - "description": "The configuration used by AWS Lambda to access event source", + "description": "An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.", "properties": { "Type": { - "description": "The type of source access configuration.", + "description": "The type of authentication protocol, VPC components, or virtual host for your event source. For example: ``\"Type\":\"SASL_SCRAM_512_AUTH\"``.\n + ``BASIC_AUTH`` – (Amazon MQ) The ASMlong secret that stores your broker credentials.\n + ``BASIC_AUTH`` – (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`` – (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`` – (Self-managed Apache Kafka) The VPC security group used to manage access to your self-managed Apache Kafka brokers.\n + ``SASL_SCRAM_256_AUTH`` – (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`` – (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`` –- (RabbitMQ) The name of the virtual host in your RabbitMQ broker. Lambda uses this RabbitMQ host as the event source. This property cannot be specified in an UpdateEventSourceMapping API call.\n + ``CLIENT_CERTIFICATE_TLS_AUTH`` – (Amazon MSK, self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the certificate chain (X.509 PEM), 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`` – (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.", "enum": [ "BASIC_AUTH", "VPC_SUBNET", @@ -193,7 +193,7 @@ "type": "string" }, "URI": { - "description": "The URI for the source access configuration resource.", + "description": "The value for your chosen configuration in ``Type``. For example: ``\"URI\": \"arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName\"``.", "maxLength": 200, "minLength": 1, "pattern": "[a-zA-Z0-9-\\/*:_+=.@-]*", @@ -203,7 +203,7 @@ "type": "object" } }, - "description": "Resource Type definition for AWS::Lambda::EventSourceMapping", + "description": "The ``AWS::Lambda::EventSourceMapping`` resource creates a mapping between an event source and an LAMlong function. LAM reads items from the event source and triggers the function.\n For details about each event source type, see the following topics. In particular, each of the topics describes 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)", "handlers": { "create": { "permissions": [ @@ -240,50 +240,50 @@ "properties": { "AmazonManagedKafkaEventSourceConfig": { "$ref": "#/definitions/AmazonManagedKafkaEventSourceConfig", - "description": "Specific configuration settings for an MSK event source." + "description": "Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source." }, "BatchSize": { - "description": "The maximum number of items to retrieve in a single batch.", + "description": "The 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 (6 MB).\n + *Amazon Kinesis* – Default 100. Max 10,000.\n + *Amazon DynamoDB Streams* – Default 100. Max 10,000.\n + *Amazon Simple Queue Service* – Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10.\n + *Amazon Managed Streaming for Apache Kafka* – Default 100. Max 10,000.\n + *Self-managed Apache Kafka* – Default 100. Max 10,000.\n + *Amazon MQ (ActiveMQ and RabbitMQ)* – Default 100. Max 10,000.\n + *DocumentDB* – Default 100. Max 10,000.", "maximum": 10000, "minimum": 1, "type": "integer" }, "BisectBatchOnFunctionError": { - "description": "(Streams) If the function returns an error, split the batch in two and retry.", + "description": "(Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry. The default value is false.", "type": "boolean" }, "DestinationConfig": { "$ref": "#/definitions/DestinationConfig", - "description": "(Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records." + "description": "(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka event sources only) A configuration object that specifies the destination of an event after Lambda processes it." }, "DocumentDBEventSourceConfig": { "$ref": "#/definitions/DocumentDBEventSourceConfig", - "description": "Document db event source config." + "description": "Specific configuration settings for a DocumentDB event source." }, "Enabled": { - "description": "Disables the event source mapping to pause polling and invocation.", + "description": "When true, the event source mapping is active. When false, Lambda pauses polling and invocation.\n Default: True", "type": "boolean" }, "EventSourceArn": { - "description": "The Amazon Resource Name (ARN) of the event source.", + "description": "The Amazon Resource Name (ARN) of the event source.\n + *Amazon Kinesis* – The ARN of the data stream or a stream consumer.\n + *Amazon DynamoDB Streams* – The ARN of the stream.\n + *Amazon Simple Queue Service* – The ARN of the queue.\n + *Amazon Managed Streaming for Apache Kafka* – 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* – The ARN of the broker.\n + *Amazon DocumentDB* – The ARN of the DocumentDB change stream.", "maxLength": 1024, "minLength": 12, - "pattern": "arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-])+:([a-z]{2}(-gov)?-[a-z]+-\\d{1})?:(\\d{12})?:(.*)", + "pattern": "arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-])+:([a-z]{2}(-gov)?(-iso([a-z])?)?-[a-z]+-\\d{1})?:(\\d{12})?:(.*)", "type": "string" }, "FilterCriteria": { "$ref": "#/definitions/FilterCriteria", - "description": "The filter criteria to control event filtering." + "description": "An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see [Lambda event filtering](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html)." }, "FunctionName": { - "description": "The name of the Lambda function.", + "description": "The 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 + *Version or Alias ARN* – ``arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD``.\n + *Partial ARN* – ``123456789012:function:MyFunction``.\n \n The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.", "maxLength": 140, "minLength": 1, - "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-_]+))?", + "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-_]+))?", "type": "string" }, "FunctionResponseTypes": { - "description": "(Streams) A list of response types supported by the function.", + "description": "(Streams and SQS) A list of current response type enums applied to the event source mapping.\n Valid Values: ``ReportBatchItemFailures``", "items": { "enum": [ "ReportBatchItemFailures" @@ -296,38 +296,38 @@ "uniqueItems": true }, "Id": { - "description": "Event Source Mapping Identifier UUID.", + "description": "", "maxLength": 36, "minLength": 36, "pattern": "[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}", "type": "string" }, "MaximumBatchingWindowInSeconds": { - "description": "(Streams) The maximum amount of time to gather records before invoking the function, in seconds.", + "description": "The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.\n *Default (, , event sources)*: 0\n *Default (, Kafka, , event sources)*: 500 ms\n *Related setting:* For SQS event sources, when you set ``BatchSize`` to a value greater than 10, you must set ``MaximumBatchingWindowInSeconds`` to at least 1.", "maximum": 300, "minimum": 0, "type": "integer" }, "MaximumRecordAgeInSeconds": { - "description": "(Streams) The maximum age of a record that Lambda sends to a function for processing.", + "description": "(Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records.\n The 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", "maximum": 604800, "minimum": -1, "type": "integer" }, "MaximumRetryAttempts": { - "description": "(Streams) The maximum number of times to retry when the function returns an error.", + "description": "(Kinesis and DynamoDB Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the event source.", "maximum": 10000, "minimum": -1, "type": "integer" }, "ParallelizationFactor": { - "description": "(Streams) The number of batches to process from each shard concurrently.", + "description": "(Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard. The default value is 1.", "maximum": 10, "minimum": 1, "type": "integer" }, "Queues": { - "description": "(ActiveMQ) A list of ActiveMQ queues.", + "description": "(Amazon MQ) The name of the Amazon MQ broker destination queue to consume.", "items": { "maxLength": 1000, "minLength": 1, @@ -341,18 +341,18 @@ }, "ScalingConfig": { "$ref": "#/definitions/ScalingConfig", - "description": "The scaling configuration for the event source." + "description": "(Amazon SQS only) The scaling configuration for the event source. For more information, see [Configuring maximum concurrency for Amazon SQS event sources](https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-max-concurrency)." }, "SelfManagedEventSource": { "$ref": "#/definitions/SelfManagedEventSource", - "description": "Self-managed event source endpoints." + "description": "The self-managed Apache Kafka cluster for your event source." }, "SelfManagedKafkaEventSourceConfig": { "$ref": "#/definitions/SelfManagedKafkaEventSourceConfig", - "description": "Specific configuration settings for a Self-Managed Apache Kafka event source." + "description": "Specific configuration settings for a self-managed Apache Kafka event source." }, "SourceAccessConfigurations": { - "description": "A list of SourceAccessConfiguration.", + "description": "An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.", "items": { "$ref": "#/definitions/SourceAccessConfiguration" }, @@ -362,18 +362,18 @@ "uniqueItems": true }, "StartingPosition": { - "description": "The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Streams sources.", + "description": "The 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.", "maxLength": 12, "minLength": 6, "pattern": "(LATEST|TRIM_HORIZON|AT_TIMESTAMP)+", "type": "string" }, "StartingPositionTimestamp": { - "description": "With StartingPosition set to AT_TIMESTAMP, the time from which to start reading, in Unix time seconds.", + "description": "With ``StartingPosition`` set to ``AT_TIMESTAMP``, the time from which to start reading, in Unix time seconds. ``StartingPositionTimestamp`` cannot be in the future.", "type": "number" }, "Topics": { - "description": "(Kafka) A list of Kafka topics.", + "description": "The name of the Kafka topic.", "items": { "maxLength": 249, "minLength": 1, @@ -386,18 +386,27 @@ "uniqueItems": true }, "TumblingWindowInSeconds": { - "description": "(Streams) Tumbling window (non-overlapping time window) duration to perform aggregations.", + "description": "(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.", "maximum": 900, "minimum": 0, "type": "integer" } }, + "propertyTransform": { + "/properties/StartingPositionTimestamp": "StartingPositionTimestamp * 1000" + }, "readOnlyProperties": [ "/properties/Id" ], "required": [ "FunctionName" ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, "typeName": "AWS::Lambda::EventSourceMapping" } } \ No newline at end of file diff --git a/artifacts/types/AWS::Lambda::Function.json b/artifacts/types/AWS::Lambda::Function.json index 68e35788..5a9d08f3 100644 --- a/artifacts/types/AWS::Lambda::Function.json +++ b/artifacts/types/AWS::Lambda::Function.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Lambda-Function", "type": "AWS::Lambda::Function", - "time": "2024-01-03T22:31:38.456Z", + "time": "2024-06-24T18:26:58Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -10,13 +10,14 @@ "definitions": { "Code": { "additionalProperties": false, + "description": "The [deployment package](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html) for a Lambda function. To deploy a function defined as a container image, you specify the location of a container image in the Amazon ECR registry. For a .zip file deployment package, you can specify the location of an object in Amazon S3. For Node.js and Python functions, you can specify the function code inline in the template.\n Changes to a deployment package in Amazon S3 or a container image in ECR are not detected automatically during stack updates. To update the function code, change the object key or version in the template.", "properties": { "ImageUri": { - "description": "ImageUri.", + "description": "URI of a [container image](https://docs.aws.amazon.com/lambda/latest/dg/lambda-images.html) in the Amazon ECR registry.", "type": "string" }, "S3Bucket": { - "description": "An Amazon S3 bucket in the same AWS Region as your function. The bucket can be in a different AWS account.", + "description": "An Amazon S3 bucket in the same AWS-Region as your function. The bucket can be in a different AWS-account.", "maxLength": 63, "minLength": 3, "pattern": "^[0-9A-Za-z\\.\\-_]*(?\u003c!\\.)$", @@ -35,7 +36,7 @@ "type": "string" }, "ZipFile": { - "description": "The source code of your Lambda function. If you include your function source inline with this parameter, AWS CloudFormation places it in a file named index and zips it to create a deployment package..", + "description": "(Node.js and Python) The source code of your Lambda function. If you include your function source inline with this parameter, CFN places it in a file named ``index`` and zips it to create a [deployment package](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html). This zip file cannot exceed 4MB. For the ``Handler`` property, the first part of the handler identifier must be ``index``. For example, ``index.handler``.\n For JSON, you must escape quotes and special characters such as newline (``\\n``) with a backslash.\n If you specify a function that interacts with an AWS CloudFormation custom resource, you don't have to write your own functions to send responses to the custom resource that invoked the function. AWS CloudFormation provides a response module ([cfn-response](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-lambda-function-code-cfnresponsemodule.html)) that simplifies sending responses. See [Using Lambda with CloudFormation](https://docs.aws.amazon.com/lambda/latest/dg/services-cloudformation.html) for details.", "type": "string" } }, @@ -43,7 +44,7 @@ }, "DeadLetterConfig": { "additionalProperties": false, - "description": "The dead-letter queue for failed asynchronous invocations.", + "description": "The [dead-letter queue](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#dlq) for failed asynchronous invocations.", "properties": { "TargetArn": { "description": "The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.", @@ -55,11 +56,11 @@ }, "Environment": { "additionalProperties": false, - "description": "A function's environment variable settings.", + "description": "A function's environment variable settings. You can use environment variables to adjust your function's behavior without updating code. An environment variable is a pair of strings that are stored in a function's version-specific configuration.", "properties": { "Variables": { "additionalProperties": false, - "description": "Environment variable key-value pairs.", + "description": "Environment variable key-value pairs. For more information, see [Using Lambda environment variables](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html).", "patternProperties": { "[a-zA-Z][a-zA-Z0-9_]+": { "type": "string" @@ -72,10 +73,10 @@ }, "EphemeralStorage": { "additionalProperties": false, - "description": "A function's ephemeral storage settings.", + "description": "The size of the function's ``/tmp`` directory in MB. The default value is 512, but it can be any whole number between 512 and 10,240 MB.", "properties": { "Size": { - "description": "The amount of ephemeral storage that your function has access to.", + "description": "The size of the function's ``/tmp`` directory.", "maximum": 10240, "minimum": 512, "type": "integer" @@ -88,6 +89,7 @@ }, "FileSystemConfig": { "additionalProperties": false, + "description": "Details about the connection between a Lambda function and an [Amazon EFS file system](https://docs.aws.amazon.com/lambda/latest/dg/configuration-filesystem.html).", "properties": { "Arn": { "description": "The Amazon Resource Name (ARN) of the Amazon EFS access point that provides access to the file system.", @@ -96,7 +98,7 @@ "type": "string" }, "LocalMountPath": { - "description": "The path where the function can access the file system, starting with /mnt/.", + "description": "The path where the function can access the file system, starting with ``/mnt/``.", "maxLength": 160, "pattern": "^/mnt/[a-zA-Z0-9-_.]+$", "type": "string" @@ -110,9 +112,10 @@ }, "ImageConfig": { "additionalProperties": false, + "description": "Configuration values that override the container image Dockerfile settings. For more information, see [Container image settings](https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-parms).", "properties": { "Command": { - "description": "Command.", + "description": "Specifies parameters that you want to pass in with ENTRYPOINT. You can specify a maximum of 1,500 parameters in the list.", "items": { "type": "string" }, @@ -121,7 +124,7 @@ "uniqueItems": true }, "EntryPoint": { - "description": "EntryPoint.", + "description": "Specifies the entry point to their application, which is typically the location of the runtime executable. You can specify a maximum of 1,500 string entries in the list.", "items": { "type": "string" }, @@ -130,7 +133,7 @@ "uniqueItems": true }, "WorkingDirectory": { - "description": "WorkingDirectory.", + "description": "Specifies the working directory. The length of the directory string cannot exceed 1,000 characters.", "type": "string" } }, @@ -138,10 +141,10 @@ }, "LoggingConfig": { "additionalProperties": false, - "description": "The function's logging configuration.", + "description": "The function's Amazon CloudWatch Logs configuration settings.", "properties": { "ApplicationLogLevel": { - "description": "Application log granularity level, can only be used when LogFormat is set to JSON", + "description": "Set this property to filter the application logs for your function that Lambda sends to CloudWatch. Lambda only sends application logs at the selected level of detail and lower, where ``TRACE`` is the highest level and ``FATAL`` is the lowest.", "enum": [ "TRACE", "DEBUG", @@ -153,7 +156,7 @@ "type": "string" }, "LogFormat": { - "description": "Log delivery format for the lambda function", + "description": "The format in which Lambda sends your function's application and system logs to CloudWatch. Select between plain text and structured JSON.", "enum": [ "Text", "JSON" @@ -161,14 +164,14 @@ "type": "string" }, "LogGroup": { - "description": "The log group name.", + "description": "The name of the Amazon CloudWatch log group the function sends logs to. By default, Lambda functions send logs to a default log group named ``/aws/lambda/\u003cfunction name\u003e``. To use a different log group, enter an existing log group or enter a new log group name.", "maxLength": 512, "minLength": 1, "pattern": "[\\.\\-_/#A-Za-z0-9]+", "type": "string" }, "SystemLogLevel": { - "description": "System log granularity level, can only be used when LogFormat is set to JSON", + "description": "Set this property to filter the system logs for your function that Lambda sends to CloudWatch. Lambda only sends system logs at the selected level of detail and lower, where ``DEBUG`` is the highest level and ``WARN`` is the lowest.", "enum": [ "DEBUG", "INFO", @@ -181,13 +184,14 @@ }, "RuntimeManagementConfig": { "additionalProperties": false, + "description": "Sets the runtime management configuration for a function's version. For more information, see [Runtime updates](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html).", "properties": { "RuntimeVersionArn": { - "description": "Unique identifier for a runtime version arn", + "description": "The ARN of the runtime version you want the function to use.\n This is only required if you're using the *Manual* runtime update mode.", "type": "string" }, "UpdateRuntimeOn": { - "description": "Trigger for runtime update", + "description": "Specify 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 choice for most customers to ensure they always benefit from runtime updates.\n + *FunctionUpdate* - LAM updates the runtime of you function to the most recent and secure runtime version when you update your function. This approach synchronizes runtime updates with function deployments, giving you control over when runtime updates are applied and allowing you to detect and 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. 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, see [Roll back a runtime version](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html#runtime-management-rollback).\n \n *Valid Values*: ``Auto`` | ``FunctionUpdate`` | ``Manual``", "enum": [ "Auto", "FunctionUpdate", @@ -203,10 +207,10 @@ }, "SnapStart": { "additionalProperties": false, - "description": "The function's SnapStart setting. When set to PublishedVersions, Lambda creates a snapshot of the execution environment when you publish a function version.", + "description": "The function's [SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) setting.", "properties": { "ApplyOn": { - "description": "Applying SnapStart setting on function resource type.", + "description": "Set ``ApplyOn`` to ``PublishedVersions`` to create a snapshot of the initialized execution environment when you publish a function version.", "enum": [ "PublishedVersions", "None" @@ -221,10 +225,10 @@ }, "SnapStartResponse": { "additionalProperties": false, - "description": "The function's SnapStart Response. When set to PublishedVersions, Lambda creates a snapshot of the execution environment when you publish a function version.", + "description": "The function's [SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) setting.", "properties": { "ApplyOn": { - "description": "Applying SnapStart setting on function resource type.", + "description": "When set to ``PublishedVersions``, Lambda creates a snapshot of the execution environment when you publish a function version.", "enum": [ "PublishedVersions", "None" @@ -232,7 +236,7 @@ "type": "string" }, "OptimizationStatus": { - "description": "Indicates whether SnapStart is activated for the specified function version.", + "description": "When 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.", "enum": [ "On", "Off" @@ -244,15 +248,16 @@ }, "Tag": { "additionalProperties": false, + "description": "", "properties": { "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "description": "", "maxLength": 128, "minLength": 1, "type": "string" }, "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "description": "", "maxLength": 256, "minLength": 0, "type": "string" @@ -265,7 +270,7 @@ }, "TracingConfig": { "additionalProperties": false, - "description": "The function's AWS X-Ray tracing configuration. To sample and record incoming requests, set Mode to Active.", + "description": "The function's [](https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html) tracing configuration. To sample and record incoming requests, set ``Mode`` to ``Active``.", "properties": { "Mode": { "description": "The tracing mode.", @@ -280,14 +285,14 @@ }, "VpcConfig": { "additionalProperties": false, - "description": "The VPC security groups and subnets that are attached to a Lambda function. When you connect a function to a VPC, Lambda creates an elastic network interface for each combination of security group and subnet in the function's VPC configuration. The function can only access resources and the internet through that VPC.", + "description": "The VPC security groups and subnets that are attached to a Lambda function. When you connect a function to a VPC, Lambda creates an elastic network interface for each combination of security group and subnet in the function's VPC configuration. The function can only access resources and the internet through that VPC. For more information, see [VPC Settings](https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html).\n When you delete a function, CFN monitors the state of its network interfaces and waits for Lambda to delete them before proceeding. If the VPC is defined in the same stack, the network interfaces need to be deleted by Lambda before CFN can delete the VPC's resources.\n To monitor network interfaces, CFN needs the ``ec2:DescribeNetworkInterfaces`` permission. It obtains this from the user or role that modifies the stack. If you don't provide this permission, CFN does not wait for network interfaces to be deleted.", "properties": { "Ipv6AllowedForDualStack": { - "description": "A boolean indicating whether IPv6 protocols will be allowed for dual stack subnets", + "description": "Allows outbound IPv6 traffic on VPC functions that are connected to dual-stack subnets.", "type": "boolean" }, "SecurityGroupIds": { - "description": "A list of VPC security groups IDs.", + "description": "A list of VPC security group IDs.", "items": { "type": "string" }, @@ -308,7 +313,7 @@ "type": "object" } }, - "description": "Resource Type definition for AWS::Lambda::Function in region", + "description": "The ``AWS::Lambda::Function`` resource creates a Lambda function. To create a function, you need a [deployment package](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html) and an [execution role](https://docs.aws.amazon.com/lambda/latest/dg/lambda-intro-execution-role.html). The deployment package is a .zip file archive or container image that contains your function code. The execution role grants the function permission to use AWS services, such as Amazon CloudWatch Logs for log streaming and AWS X-Ray for request tracing.\n You set the package type to ``Image`` if the deployment package is a [container image](https://docs.aws.amazon.com/lambda/latest/dg/lambda-images.html). For a container image, the code property must include the URI of a container image in the Amazon ECR registry. You do not need to specify the handler and runtime properties. \n You 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). For a .zip file archive, the code property specifies the location of the .zip file. You must also specify the handler and runtime properties. For a Python example, see [Deploy Python Lambda functions with .zip file archives](https://docs.aws.amazon.com/lambda/latest/dg/python-package.html).\n You can use [code signing](https://docs.aws.amazon.com/lambda/latest/dg/configuration-codesigning.html) if your deployment package is a .zip file archive. To enable code signing for this function, specify the ARN of a code-signing configuration. When a user attempts to deploy a code package with ``UpdateFunctionCode``, Lambda checks that the code package has a valid signature from a trusted publisher. The code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function.\n Note 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``.\n For a complete introduction to Lambda functions, see [What is Lambda?](https://docs.aws.amazon.com/lambda/latest/dg/lambda-welcome.html) in the *Lambda developer guide.*", "handlers": { "create": { "permissions": [ @@ -342,6 +347,7 @@ "delete": { "permissions": [ "lambda:DeleteFunction", + "lambda:GetFunction", "ec2:DescribeNetworkInterfaces" ] }, @@ -396,6 +402,7 @@ ], "properties": { "Architectures": { + "description": "The instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64). The default value is ``x86_64``.", "items": { "enum": [ "x86_64", @@ -409,7 +416,7 @@ "uniqueItems": true }, "Arn": { - "description": "Unique identifier for function resources", + "description": "", "type": "string" }, "Code": { @@ -417,13 +424,13 @@ "description": "The code for the function." }, "CodeSigningConfigArn": { - "description": "A unique Arn for CodeSigningConfig resource", + "description": "To enable code signing for this function, specify the ARN of a code-signing configuration. A code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function.", "pattern": "arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}:\\d{12}:code-signing-config:csc-[a-z0-9]{17}", "type": "string" }, "DeadLetterConfig": { "$ref": "#/definitions/DeadLetterConfig", - "description": "A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing." + "description": "A dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see [Dead-letter queues](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq)." }, "Description": { "description": "A description of the function.", @@ -436,10 +443,10 @@ }, "EphemeralStorage": { "$ref": "#/definitions/EphemeralStorage", - "description": "A function's ephemeral storage settings." + "description": "The size of the function's ``/tmp`` directory in MB. The default value is 512, but it can be any whole number between 512 and 10,240 MB." }, "FileSystemConfigs": { - "description": "Connection settings for an Amazon EFS file system. To connect a function to a file system, a mount target must be available in every Availability Zone that your function connects to. If your template contains an AWS::EFS::MountTarget resource, you must also specify a DependsOn attribute to ensure that the mount target is created or updated before the function.", + "description": "Connection settings for an Amazon EFS file system. To connect a function to a file system, a mount target must be available in every Availability Zone that your function connects to. If your template contains an [AWS::EFS::MountTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html) resource, you must also specify a ``DependsOn`` attribute to ensure that the mount target is created or updated before the function.\n For more information about using the ``DependsOn`` attribute, see [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html).", "items": { "$ref": "#/definitions/FileSystemConfig" }, @@ -447,27 +454,27 @@ "type": "array" }, "FunctionName": { - "description": "The name of the Lambda function, up to 64 characters in length. If you don't specify a name, AWS CloudFormation generates one.", + "description": "The name of the Lambda function, up to 64 characters in length. If you don't specify a name, CFN generates one.\n If 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.", "minLength": 1, "type": "string" }, "Handler": { - "description": "The name of the method within your code that Lambda calls to execute your function. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime", + "description": "The name of the method within your code that Lambda calls to run your function. Handler is required if the deployment package is a .zip file archive. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see [Lambda programming model](https://docs.aws.amazon.com/lambda/latest/dg/foundation-progmodel.html).", "maxLength": 128, "pattern": "^[^\\s]+$", "type": "string" }, "ImageConfig": { "$ref": "#/definitions/ImageConfig", - "description": "ImageConfig" + "description": "Configuration values that override the container image Dockerfile settings. For more information, see [Container image settings](https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-parms)." }, "KmsKeyArn": { - "description": "The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment variables. If it's not provided, AWS Lambda uses a default service key.", + "description": "The ARN of the KMSlong (KMS) customer managed key that's used to encrypt your function's [environment variables](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-encryption). When [Lambda SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart-security.html) is activated, Lambda also uses this key is to encrypt your function's snapshot. If you deploy your function using a container image, Lambda also uses this key to encrypt your function when it's deployed. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). If you don't provide a customer managed key, Lambda uses a default service key.", "pattern": "^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$", "type": "string" }, "Layers": { - "description": "A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.", + "description": "A list of [function layers](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) to add to the function's execution environment. Specify each layer by its ARN, including the version.", "items": { "type": "string" }, @@ -476,14 +483,14 @@ }, "LoggingConfig": { "$ref": "#/definitions/LoggingConfig", - "description": "The logging configuration of your function" + "description": "The function's Amazon CloudWatch Logs configuration settings." }, "MemorySize": { - "description": "The amount of memory that your function has access to. Increasing the function's memory also increases its CPU allocation. The default value is 128 MB. The value must be a multiple of 64 MB.", + "description": "The amount of [memory available to the function](https://docs.aws.amazon.com/lambda/latest/dg/configuration-function-common.html#configuration-memory-console) at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB. Note that new AWS accounts have reduced concurrency and memory quotas. AWS raises these quotas automatically based on your usage. You can also request a quota increase.", "type": "integer" }, "PackageType": { - "description": "PackageType.", + "description": "The type of deployment package. Set to ``Image`` for container image and set ``Zip`` for .zip file archive.", "enum": [ "Image", "Zip" @@ -501,23 +508,23 @@ "type": "string" }, "Runtime": { - "description": "The identifier of the function's runtime.", + "description": "The 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 an error if you're deploying a function using a container image.\n The following list includes deprecated runtimes. Lambda blocks creating new functions and updating existing functions shortly after each runtime is deprecated. For more information, see [Runtime use after deprecation](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-deprecation-levels).\n For a list of all currently supported runtimes, see [Supported runtimes](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtimes-supported).", "type": "string" }, "RuntimeManagementConfig": { "$ref": "#/definitions/RuntimeManagementConfig", - "description": "RuntimeManagementConfig" + "description": "Sets the runtime management configuration for a function's version. For more information, see [Runtime updates](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html)." }, "SnapStart": { "$ref": "#/definitions/SnapStart", - "description": "The SnapStart setting of your function" + "description": "The function's [SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) setting." }, "SnapStartResponse": { "$ref": "#/definitions/SnapStartResponse", - "description": "The SnapStart response of your function" + "description": "" }, "Tags": { - "description": "A list of tags to apply to the function.", + "description": "A list of [tags](https://docs.aws.amazon.com/lambda/latest/dg/tagging.html) to apply to the function.", "insertionOrder": false, "items": { "$ref": "#/definitions/Tag" @@ -526,17 +533,17 @@ "uniqueItems": true }, "Timeout": { - "description": "The amount of time that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds.", + "description": "The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For more information, see [Lambda execution environment](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-context.html).", "minimum": 1, "type": "integer" }, "TracingConfig": { "$ref": "#/definitions/TracingConfig", - "description": "Set Mode to Active to sample and trace a subset of incoming requests with AWS X-Ray." + "description": "Set ``Mode`` to ``Active`` to sample and trace a subset of incoming requests with [X-Ray](https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html)." }, "VpcConfig": { "$ref": "#/definitions/VpcConfig", - "description": "For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC." + "description": "For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can access resources and the internet only through that VPC. For more information, see [Configuring a Lambda function to access resources in a VPC](https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html)." } }, "readOnlyProperties": [ diff --git a/artifacts/types/AWS::Lambda::Url.json b/artifacts/types/AWS::Lambda::Url.json index f4e14b70..088a1854 100644 --- a/artifacts/types/AWS::Lambda::Url.json +++ b/artifacts/types/AWS::Lambda::Url.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Lambda-Url", "type": "AWS::Lambda::Url", - "time": "2023-11-15T01:23:01.656Z", + "time": "2024-03-14T23:58:26.331Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -157,7 +157,7 @@ "type": "string" }, "InvokeMode": { - "description": "The invocation mode for the function?s URL. Set to BUFFERED if you want to buffer responses before returning them to the client. Set to RESPONSE_STREAM if you want to stream responses, allowing faster time to first byte and larger response payload sizes. If not set, defaults to BUFFERED.", + "description": "The invocation mode for the function's URL. Set to BUFFERED if you want to buffer responses before returning them to the client. Set to RESPONSE_STREAM if you want to stream responses, allowing faster time to first byte and larger response payload sizes. If not set, defaults to BUFFERED.", "enum": [ "BUFFERED", "RESPONSE_STREAM" diff --git a/artifacts/types/AWS::Lambda::Version.json b/artifacts/types/AWS::Lambda::Version.json deleted file mode 100644 index ea78fcc9..00000000 --- a/artifacts/types/AWS::Lambda::Version.json +++ /dev/null @@ -1,156 +0,0 @@ -{ - "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Lambda-Version", - "type": "AWS::Lambda::Version", - "time": "2023-12-27T16:55:07.247Z", - "schema": { - "additionalProperties": false, - "createOnlyProperties": [ - "/properties/FunctionName", - "/properties/Description", - "/properties/CodeSha256", - "/properties/ProvisionedConcurrencyConfig", - "/properties/RuntimePolicy" - ], - "definitions": { - "ProvisionedConcurrencyConfiguration": { - "additionalProperties": false, - "description": "A provisioned concurrency configuration for a function's version.", - "properties": { - "ProvisionedConcurrentExecutions": { - "description": "The amount of provisioned concurrency to allocate for the version.", - "type": "integer" - } - }, - "required": [ - "ProvisionedConcurrentExecutions" - ], - "type": "object" - }, - "RuntimePolicy": { - "additionalProperties": false, - "description": "Runtime Management Config of a function.", - "properties": { - "RuntimeVersionArn": { - "description": "The ARN of the runtime the function is configured to use. If the runtime update mode is manual, the ARN is returned, otherwise null is returned.", - "maxLength": 2048, - "minLength": 26, - "pattern": "^arn:(aws[a-zA-Z-]*):lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}::runtime:.+$", - "type": "string" - }, - "UpdateRuntimeOn": { - "description": "The runtime update mode.", - "type": "string" - } - }, - "required": [ - "UpdateRuntimeOn" - ], - "type": "object" - } - }, - "description": "Resource Type definition for AWS::Lambda::Version", - "handlers": { - "create": { - "permissions": [ - "lambda:PublishVersion", - "lambda:GetFunctionConfiguration", - "lambda:PutProvisionedConcurrencyConfig", - "lambda:GetProvisionedConcurrencyConfig", - "lambda:PutRuntimeManagementConfig", - "lambda:GetRuntimeManagementConfig" - ], - "timeoutInMinutes": 180 - }, - "delete": { - "permissions": [ - "lambda:GetFunctionConfiguration", - "lambda:DeleteFunction" - ] - }, - "list": { - "handlerSchema": { - "properties": { - "FunctionName": { - "description": "The name of the Lambda function, version, or alias.", - "maxLength": 140, - "minLength": 1, - "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-_]+))?$", - "type": "string" - } - }, - "required": [ - "FunctionName" - ] - }, - "permissions": [ - "lambda:ListVersionsByFunction" - ] - }, - "read": { - "permissions": [ - "lambda:GetFunctionConfiguration", - "lambda:GetProvisionedConcurrencyConfig", - "lambda:GetRuntimeManagementConfig" - ] - }, - "update": { - "permissions": [] - } - }, - "primaryIdentifier": [ - "/properties/FunctionArn" - ], - "properties": { - "CodeSha256": { - "description": "Only publish a version if the hash value matches the value that's specified. Use this option to avoid publishing a version if the function code has changed since you last updated it. Updates are not supported for this property.", - "type": "string" - }, - "Description": { - "description": "A description for the version to override the description in the function configuration. Updates are not supported for this property.", - "maxLength": 256, - "minLength": 0, - "type": "string" - }, - "FunctionArn": { - "description": "The ARN of the version.", - "type": "string" - }, - "FunctionName": { - "description": "The name of the Lambda function.", - "maxLength": 140, - "minLength": 1, - "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-_]+))?$", - "type": "string" - }, - "ProvisionedConcurrencyConfig": { - "$ref": "#/definitions/ProvisionedConcurrencyConfiguration", - "description": "Specifies a provisioned concurrency configuration for a function's version. Updates are not supported for this property." - }, - "RuntimePolicy": { - "$ref": "#/definitions/RuntimePolicy", - "description": "Specifies the runtime management configuration of a function. Displays runtimeVersionArn only for Manual." - }, - "Version": { - "description": "The version number.", - "type": "string" - } - }, - "propertyTransform": { - "/properties/FunctionName": "$split(FunctionName, \":\")[-1] $OR FunctionName" - }, - "readOnlyProperties": [ - "/properties/Version", - "/properties/FunctionArn" - ], - "required": [ - "FunctionName" - ], - "tagging": { - "cloudFormationSystemTags": false, - "tagOnCreate": false, - "tagUpdatable": false, - "taggable": false - }, - "typeName": "AWS::Lambda::Version" - } -} \ No newline at end of file diff --git a/artifacts/types/AWS::Lex::Bot.json b/artifacts/types/AWS::Lex::Bot.json index 3dda9c04..19f069a1 100644 --- a/artifacts/types/AWS::Lex::Bot.json +++ b/artifacts/types/AWS::Lex::Bot.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Lex-Bot", "type": "AWS::Lex::Bot", - "time": "2024-01-04T00:45:46.045Z", + "time": "2024-05-17T11:58:22.359Z", "schema": { "additionalProperties": false, "definitions": { diff --git a/artifacts/types/AWS::Lex::BotAlias.json b/artifacts/types/AWS::Lex::BotAlias.json index 330609ad..8df1c884 100644 --- a/artifacts/types/AWS::Lex::BotAlias.json +++ b/artifacts/types/AWS::Lex::BotAlias.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Lex-BotAlias", "type": "AWS::Lex::BotAlias", - "time": "2024-01-04T00:41:40.16Z", + "time": "2024-05-17T11:56:31.919Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Lex::ResourcePolicy.json b/artifacts/types/AWS::Lex::ResourcePolicy.json index 10875bb7..9cbda221 100644 --- a/artifacts/types/AWS::Lex::ResourcePolicy.json +++ b/artifacts/types/AWS::Lex::ResourcePolicy.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Lex-ResourcePolicy", "type": "AWS::Lex::ResourcePolicy", - "time": "2024-01-04T00:42:46.2Z", + "time": "2024-05-17T11:57:54.392Z", "schema": { "additionalIdentifiers": [ [ diff --git a/artifacts/types/AWS::Lightsail::Alarm.json b/artifacts/types/AWS::Lightsail::Alarm.json index e6f3be17..33f91201 100644 --- a/artifacts/types/AWS::Lightsail::Alarm.json +++ b/artifacts/types/AWS::Lightsail::Alarm.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Lightsail-Alarm", "type": "AWS::Lightsail::Alarm", - "time": "2024-01-02T16:25:19.083Z", + "time": "2024-05-14T16:56:38.271Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Lightsail::Bucket.json b/artifacts/types/AWS::Lightsail::Bucket.json index fb99533d..1c9f20cc 100644 --- a/artifacts/types/AWS::Lightsail::Bucket.json +++ b/artifacts/types/AWS::Lightsail::Bucket.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Lightsail-Bucket", "type": "AWS::Lightsail::Bucket", - "time": "2024-01-02T16:42:10.858Z", + "time": "2024-05-14T17:09:12.32Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Lightsail::Certificate.json b/artifacts/types/AWS::Lightsail::Certificate.json index 17070690..8e9b70ae 100644 --- a/artifacts/types/AWS::Lightsail::Certificate.json +++ b/artifacts/types/AWS::Lightsail::Certificate.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Lightsail-Certificate", "type": "AWS::Lightsail::Certificate", - "time": "2024-01-02T16:24:07.982Z", + "time": "2024-05-14T16:56:09.196Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -38,7 +38,9 @@ "create": { "permissions": [ "lightsail:CreateCertificate", - "lightsail:GetCertificates" + "lightsail:GetCertificates", + "lightsail:TagResource", + "lightsail:UntagResource" ] }, "delete": { diff --git a/artifacts/types/AWS::Lightsail::Container.json b/artifacts/types/AWS::Lightsail::Container.json index 4d78375b..528e644f 100644 --- a/artifacts/types/AWS::Lightsail::Container.json +++ b/artifacts/types/AWS::Lightsail::Container.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Lightsail-Container", "type": "AWS::Lightsail::Container", - "time": "2024-01-03T04:49:47.626Z", + "time": "2024-05-14T20:52:15.255Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Lightsail::Database.json b/artifacts/types/AWS::Lightsail::Database.json index ac4cec35..7f08866c 100644 --- a/artifacts/types/AWS::Lightsail::Database.json +++ b/artifacts/types/AWS::Lightsail::Database.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Lightsail-Database", "type": "AWS::Lightsail::Database", - "time": "2024-01-02T16:13:15.986Z", + "time": "2024-05-14T16:46:49.021Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Lightsail::Disk.json b/artifacts/types/AWS::Lightsail::Disk.json index e03ea2c0..6a539662 100644 --- a/artifacts/types/AWS::Lightsail::Disk.json +++ b/artifacts/types/AWS::Lightsail::Disk.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Lightsail-Disk", "type": "AWS::Lightsail::Disk", - "time": "2024-01-02T16:33:38.332Z", + "time": "2024-05-14T17:03:58.502Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Lightsail::Instance.json b/artifacts/types/AWS::Lightsail::Instance.json index e5c88970..36cd9234 100644 --- a/artifacts/types/AWS::Lightsail::Instance.json +++ b/artifacts/types/AWS::Lightsail::Instance.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Lightsail-Instance", "type": "AWS::Lightsail::Instance", - "time": "2024-01-02T16:56:42.936Z", + "time": "2024-05-15T16:50:01.211Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -375,6 +375,14 @@ "pattern": "^[a-zA-Z0-9][\\w\\-.]*[a-zA-Z0-9]$", "type": "string" }, + "Ipv6Addresses": { + "description": "IPv6 addresses of the instance", + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" + }, "IsStaticIp": { "description": "Is the IP Address of the Instance is the static IP", "type": "boolean" @@ -438,6 +446,7 @@ "/properties/IsStaticIp", "/properties/PrivateIpAddress", "/properties/PublicIpAddress", + "/properties/Ipv6Addresses", "/properties/Location/AvailabilityZone", "/properties/Location/RegionName", "/properties/Hardware/CpuCount", diff --git a/artifacts/types/AWS::Lightsail::LoadBalancer.json b/artifacts/types/AWS::Lightsail::LoadBalancer.json index 6b217aa1..2677799c 100644 --- a/artifacts/types/AWS::Lightsail::LoadBalancer.json +++ b/artifacts/types/AWS::Lightsail::LoadBalancer.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Lightsail-LoadBalancer", "type": "AWS::Lightsail::LoadBalancer", - "time": "2024-01-02T16:57:15.233Z", + "time": "2024-05-14T17:17:43.974Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Lightsail::LoadBalancerTlsCertificate.json b/artifacts/types/AWS::Lightsail::LoadBalancerTlsCertificate.json index f03ab94b..c23b98c4 100644 --- a/artifacts/types/AWS::Lightsail::LoadBalancerTlsCertificate.json +++ b/artifacts/types/AWS::Lightsail::LoadBalancerTlsCertificate.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Lightsail-LoadBalancerTlsCertificate", "type": "AWS::Lightsail::LoadBalancerTlsCertificate", - "time": "2024-01-02T16:36:25.357Z", + "time": "2024-05-14T17:08:14.13Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Lightsail::StaticIp.json b/artifacts/types/AWS::Lightsail::StaticIp.json index 11edd616..a4c034fa 100644 --- a/artifacts/types/AWS::Lightsail::StaticIp.json +++ b/artifacts/types/AWS::Lightsail::StaticIp.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Lightsail-StaticIp", "type": "AWS::Lightsail::StaticIp", - "time": "2024-01-02T16:29:10.768Z", + "time": "2024-05-14T17:01:15.086Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Location::APIKey.json b/artifacts/types/AWS::Location::APIKey.json index c963edd5..79e6cd41 100644 --- a/artifacts/types/AWS::Location::APIKey.json +++ b/artifacts/types/AWS::Location::APIKey.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Location-APIKey", "type": "AWS::Location::APIKey", - "time": "2024-01-03T16:19:25.365Z", + "time": "2024-06-18T15:30:19.052Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -38,7 +38,7 @@ "insertionOrder": false, "items": { "maxLength": 1600, - "pattern": "^arn(:[a-z0-9]+([.-][a-z0-9]+)*):geo(:([a-z0-9]+([.-][a-z0-9]+)*))(:[0-9]+):((\\*)|([-a-z]+[/][*-._\\w]+))$", + "pattern": "(^arn(:[a-z0-9]+([.-][a-z0-9]+)*):geo(:([a-z0-9]+([.-][a-z0-9]+)*))(:[0-9]+):((\\*)|([-a-z]+[/][*-._\\w]+))$)|(^arn(:[a-z0-9]+([.-][a-z0-9]+)*):(geo-routes|geo-places|geo-maps)(:((\\*)|([a-z0-9]+([.-][a-z0-9]+)*)))::((provider[\\/][*-._\\w]+))$)", "type": "string" }, "maxItems": 5, @@ -60,14 +60,14 @@ "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", "maxLength": 128, "minLength": 1, - "pattern": "\\A(?!aws:)[a-zA-Z0-9+\\-=\\._\\:\\/@]+$", + "pattern": "^[a-zA-Z+-=._:/]+$", "type": "string" }, "Value": { "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", "maxLength": 256, "minLength": 0, - "pattern": "\\A[a-zA-Z0-9+\\-=\\._\\:\\/@]+$", + "pattern": "^[A-Za-z0-9 _=@:.+-/]*$", "type": "string" } }, @@ -81,10 +81,10 @@ "additionalProperties": false, "maxProperties": 50, "patternProperties": { - "^[a-zA-Z+-=._:/]+$": { + "^([\\p{L}\\p{Z}\\p{N}_.,:/=+\\-@]*)$": { "maxLength": 256, "minLength": 0, - "pattern": "^[A-Za-z0-9 _=@:.+-/]*$", + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.,:/=+\\-@]*)$", "type": "string" } }, diff --git a/artifacts/types/AWS::Location::GeofenceCollection.json b/artifacts/types/AWS::Location::GeofenceCollection.json index 33c7c2c7..ce4633e0 100644 --- a/artifacts/types/AWS::Location::GeofenceCollection.json +++ b/artifacts/types/AWS::Location::GeofenceCollection.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Location-GeofenceCollection", "type": "AWS::Location::GeofenceCollection", - "time": "2023-12-22T19:02:31.69Z", + "time": "2024-05-08T15:41:47.296Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -23,14 +23,14 @@ "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", "maxLength": 128, "minLength": 1, - "pattern": "\\A(?!aws:)[a-zA-Z0-9+\\-=\\._\\:\\/@]+$", + "pattern": "^[a-zA-Z+-=._:/]+$", "type": "string" }, "Value": { "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", "maxLength": 256, "minLength": 0, - "pattern": "\\A[a-zA-Z0-9+\\-=\\._\\:\\/@]+$", + "pattern": "^[A-Za-z0-9 _=@:.+-/]*$", "type": "string" } }, @@ -71,26 +71,25 @@ "geo:DescribeGeofenceCollection", "geo:TagResource", "geo:UntagResource", - "kms:*" + "kms:DescribeKey", + "kms:CreateGrant" ] }, "delete": { "permissions": [ "geo:DeleteGeofenceCollection", - "geo:DescribeGeofenceCollection", - "kms:*" + "geo:DescribeGeofenceCollection" ] }, "list": { "permissions": [ - "geo:ListGeofenceCollections", - "kms:*" + "geo:ListGeofenceCollections" ] }, "read": { "permissions": [ "geo:DescribeGeofenceCollection", - "kms:*" + "kms:DescribeKey" ] }, "update": { @@ -99,8 +98,9 @@ "geo:DescribeGeofenceCollection", "geo:TagResource", "geo:UntagResource", - "geo:UpdateGeofenceCollection", - "kms:*" + "kms:DescribeKey", + "kms:CreateGrant", + "geo:UpdateGeofenceCollection" ] } }, @@ -141,6 +141,7 @@ "$ref": "#/definitions/PricingPlan" }, "PricingPlanDataSource": { + "description": "This shape is deprecated since 2022-02-01: Deprecated. No longer allowed.", "type": "string" }, "Tags": { diff --git a/artifacts/types/AWS::Location::Map.json b/artifacts/types/AWS::Location::Map.json index 53bfc9b9..fca2f069 100644 --- a/artifacts/types/AWS::Location::Map.json +++ b/artifacts/types/AWS::Location::Map.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Location-Map", "type": "AWS::Location::Map", - "time": "2023-12-22T18:37:20.359Z", + "time": "2024-06-24T15:52:16.332Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -12,6 +12,16 @@ "MapConfiguration": { "additionalProperties": false, "properties": { + "CustomLayers": { + "items": { + "maxLength": 100, + "minLength": 1, + "pattern": "^[-._\\w]+$", + "type": "string" + }, + "maxItems": 10, + "type": "array" + }, "PoliticalView": { "maxLength": 3, "minLength": 3, @@ -44,14 +54,14 @@ "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", "maxLength": 128, "minLength": 1, - "pattern": "\\A(?!aws:)[a-zA-Z0-9+\\-=\\._\\:\\/@]+$", + "pattern": "^[a-zA-Z+-=._:/]+$", "type": "string" }, "Value": { "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", "maxLength": 256, "minLength": 0, - "pattern": "\\A[a-zA-Z0-9+\\-=\\._\\:\\/@]+$", + "pattern": "^[A-Za-z0-9 _=@:.+-/]*$", "type": "string" } }, @@ -65,10 +75,10 @@ "additionalProperties": false, "maxProperties": 50, "patternProperties": { - "^[a-zA-Z+-=._:/]+$": { + "^([\\p{L}\\p{Z}\\p{N}_.,:/=+\\-@]*)$": { "maxLength": 256, "minLength": 0, - "pattern": "^[A-Za-z0-9 _=@:.+-/]*$", + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.,:/=+\\-@]*)$", "type": "string" } }, diff --git a/artifacts/types/AWS::Location::PlaceIndex.json b/artifacts/types/AWS::Location::PlaceIndex.json index 59907173..a271bea6 100644 --- a/artifacts/types/AWS::Location::PlaceIndex.json +++ b/artifacts/types/AWS::Location::PlaceIndex.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Location-PlaceIndex", "type": "AWS::Location::PlaceIndex", - "time": "2023-12-22T18:51:17.005Z", + "time": "2024-06-18T15:35:17.438Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -39,14 +39,14 @@ "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", "maxLength": 128, "minLength": 1, - "pattern": "\\A(?!aws:)[a-zA-Z0-9+\\-=\\._\\:\\/@]+$", + "pattern": "^[a-zA-Z+-=._:/]+$", "type": "string" }, "Value": { "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", "maxLength": 256, "minLength": 0, - "pattern": "\\A[a-zA-Z0-9+\\-=\\._\\:\\/@]+$", + "pattern": "^[A-Za-z0-9 _=@:.+-/]*$", "type": "string" } }, @@ -60,10 +60,10 @@ "additionalProperties": false, "maxProperties": 50, "patternProperties": { - "^[a-zA-Z+-=._:/]+$": { + "^([\\p{L}\\p{Z}\\p{N}_.,:/=+\\-@]*)$": { "maxLength": 256, "minLength": 0, - "pattern": "^[A-Za-z0-9 _=@:.+-/]*$", + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.,:/=+\\-@]*)$", "type": "string" } }, diff --git a/artifacts/types/AWS::Location::RouteCalculator.json b/artifacts/types/AWS::Location::RouteCalculator.json index a2690399..b7debe0f 100644 --- a/artifacts/types/AWS::Location::RouteCalculator.json +++ b/artifacts/types/AWS::Location::RouteCalculator.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Location-RouteCalculator", "type": "AWS::Location::RouteCalculator", - "time": "2023-12-22T18:52:29.685Z", + "time": "2024-06-18T15:42:19.814Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -23,14 +23,14 @@ "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", "maxLength": 128, "minLength": 1, - "pattern": "\\A(?!aws:)[a-zA-Z0-9+\\-=\\._\\:\\/@]+$", + "pattern": "^[a-zA-Z+-=._:/]+$", "type": "string" }, "Value": { "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", "maxLength": 256, "minLength": 0, - "pattern": "\\A[a-zA-Z0-9+\\-=\\._\\:\\/@]+$", + "pattern": "^[A-Za-z0-9 _=@:.+-/]*$", "type": "string" } }, @@ -44,10 +44,10 @@ "additionalProperties": false, "maxProperties": 50, "patternProperties": { - "^[a-zA-Z+-=._:/]+$": { + "^([\\p{L}\\p{Z}\\p{N}_.,:/=+\\-@]*)$": { "maxLength": 256, "minLength": 0, - "pattern": "^[A-Za-z0-9 _=@:.+-/]*$", + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.,:/=+\\-@]*)$", "type": "string" } }, diff --git a/artifacts/types/AWS::Location::Tracker.json b/artifacts/types/AWS::Location::Tracker.json index df6cd48a..a19be4b2 100644 --- a/artifacts/types/AWS::Location::Tracker.json +++ b/artifacts/types/AWS::Location::Tracker.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Location-Tracker", "type": "AWS::Location::Tracker", - "time": "2023-12-22T19:24:19.189Z", + "time": "2024-05-14T15:55:59.185Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -31,14 +31,14 @@ "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", "maxLength": 128, "minLength": 1, - "pattern": "\\A(?!aws:)[a-zA-Z0-9+\\-=\\._\\:\\/@]+$", + "pattern": "^[a-zA-Z+-=._:/]+$", "type": "string" }, "Value": { "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", "maxLength": 256, "minLength": 0, - "pattern": "\\A[a-zA-Z0-9+\\-=\\._\\:\\/@]+$", + "pattern": "^[A-Za-z0-9 _=@:.+-/]*$", "type": "string" } }, @@ -79,26 +79,25 @@ "geo:DescribeTracker", "geo:TagResource", "geo:UntagResource", - "kms:*" + "kms:DescribeKey", + "kms:CreateGrant" ] }, "delete": { "permissions": [ "geo:DeleteTracker", - "geo:DescribeTracker", - "kms:*" + "geo:DescribeTracker" ] }, "list": { "permissions": [ - "geo:ListTrackers", - "kms:*" + "geo:ListTrackers" ] }, "read": { "permissions": [ "geo:DescribeTracker", - "kms:*" + "kms:DescribeKey" ] }, "update": { @@ -107,8 +106,9 @@ "geo:DescribeTracker", "geo:TagResource", "geo:UntagResource", - "geo:UpdateTracker", - "kms:*" + "kms:DescribeKey", + "kms:CreateGrant", + "geo:UpdateTracker" ] } }, @@ -147,6 +147,7 @@ "$ref": "#/definitions/PricingPlan" }, "PricingPlanDataSource": { + "description": "This shape is deprecated since 2022-02-01: Deprecated. No longer allowed.", "type": "string" }, "Tags": { diff --git a/artifacts/types/AWS::Logs::AccountPolicy.json b/artifacts/types/AWS::Logs::AccountPolicy.json index abd0153d..ef7b6622 100644 --- a/artifacts/types/AWS::Logs::AccountPolicy.json +++ b/artifacts/types/AWS::Logs::AccountPolicy.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Logs-AccountPolicy", "type": "AWS::Logs::AccountPolicy", - "time": "2023-07-19T00:29:55.788Z", + "time": "2024-06-20T00:07:27.598Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -17,14 +17,19 @@ "logs:DescribeAccountPolicies", "logs:CreateLogDelivery", "s3:REST.PUT.OBJECT", - "firehose:TagDeliveryStream" + "firehose:TagDeliveryStream", + "logs:PutSubscriptionFilter", + "logs:DeleteSubscriptionFilter", + "iam:PassRole" ] }, "delete": { "permissions": [ "logs:DeleteAccountPolicy", "logs:DeleteDataProtectionPolicy", - "logs:DescribeAccountPolicies" + "logs:DescribeAccountPolicies", + "logs:DeleteSubscriptionFilter", + "iam:PassRole" ] }, "list": { @@ -55,8 +60,11 @@ "logs:DeleteAccountPolicy", "logs:DeleteDataProtectionPolicy", "logs:CreateLogDelivery", + "logs:PutSubscriptionFilter", + "logs:DeleteSubscriptionFilter", "s3:REST.PUT.OBJECT", - "firehose:TagDeliveryStream" + "firehose:TagDeliveryStream", + "iam:PassRole" ] } }, @@ -87,7 +95,8 @@ "PolicyType": { "description": "Type of the policy.", "enum": [ - "DATA_PROTECTION_POLICY" + "DATA_PROTECTION_POLICY", + "SUBSCRIPTION_FILTER_POLICY" ], "type": "string" }, @@ -97,6 +106,10 @@ "ALL" ], "type": "string" + }, + "SelectionCriteria": { + "description": "Log group selection criteria to apply policy only to a subset of log groups. SelectionCriteria string can be up to 25KB and cloudwatchlogs determines the length of selectionCriteria by using its UTF-8 bytes", + "type": "string" } }, "readOnlyProperties": [ diff --git a/artifacts/types/AWS::Logs::Delivery.json b/artifacts/types/AWS::Logs::Delivery.json index 36192010..98521f96 100644 --- a/artifacts/types/AWS::Logs::Delivery.json +++ b/artifacts/types/AWS::Logs::Delivery.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Logs-Delivery", "type": "AWS::Logs::Delivery", - "time": "2023-12-21T20:06:17.141Z", + "time": "2024-06-05T15:26:07.106Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Logs::DeliveryDestination.json b/artifacts/types/AWS::Logs::DeliveryDestination.json index 8cb56e35..e7038d05 100644 --- a/artifacts/types/AWS::Logs::DeliveryDestination.json +++ b/artifacts/types/AWS::Logs::DeliveryDestination.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Logs-DeliveryDestination", "type": "AWS::Logs::DeliveryDestination", - "time": "2023-12-21T19:55:20.937Z", + "time": "2024-06-05T15:22:40.333Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Logs::DeliverySource.json b/artifacts/types/AWS::Logs::DeliverySource.json index 229f14db..16579f82 100644 --- a/artifacts/types/AWS::Logs::DeliverySource.json +++ b/artifacts/types/AWS::Logs::DeliverySource.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Logs-DeliverySource", "type": "AWS::Logs::DeliverySource", - "time": "2023-12-21T19:53:16.826Z", + "time": "2024-06-05T15:22:27.461Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Logs::Destination.json b/artifacts/types/AWS::Logs::Destination.json index 045f3f39..debbe45a 100644 --- a/artifacts/types/AWS::Logs::Destination.json +++ b/artifacts/types/AWS::Logs::Destination.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Logs-Destination", "type": "AWS::Logs::Destination", - "time": "2023-12-18T05:49:06.343Z", + "time": "2024-06-21T15:50:11.363Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Logs::LogGroup.json b/artifacts/types/AWS::Logs::LogGroup.json index 5c67a303..3d855a76 100644 --- a/artifacts/types/AWS::Logs::LogGroup.json +++ b/artifacts/types/AWS::Logs::LogGroup.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Logs-LogGroup", "type": "AWS::Logs::LogGroup", - "time": "2023-12-18T06:08:25.483Z", + "time": "2024-06-21T15:58:47.194Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -10,16 +10,16 @@ "definitions": { "Tag": { "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", + "description": "", "properties": { "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., :, /, =, +, - and @.", + "description": "", "maxLength": 128, "minLength": 1, "type": "string" }, "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., :, /, =, +, - and @.", + "description": "", "maxLength": 256, "minLength": 0, "type": "string" @@ -32,7 +32,7 @@ "type": "object" } }, - "description": "Resource schema for AWS::Logs::LogGroup", + "description": "The ``AWS::Logs::LogGroup`` resource specifies a log group. A log group defines common properties for log streams, such as their retention and access control rules. Each log stream must belong to one log group.\n You can create up to 1,000,000 log groups per Region per account. You must use the following guidelines when naming a log group:\n + Log group names must be unique within a Region for an AWS 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, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period).", "handlers": { "create": { "permissions": [ @@ -99,22 +99,22 @@ ], "properties": { "Arn": { - "description": "The CloudWatch log group ARN.", + "description": "", "type": "string" }, "DataProtectionPolicy": { - "description": "The body of the policy document you want to use for this topic.\n\nYou can only add one policy per topic.\n\nThe policy must be in JSON string format.\n\nLength Constraints: Maximum length of 30720", + "description": "Creates a data protection policy and assigns it to the log group. A data protection policy can help safeguard sensitive data that's ingested by the log group by auditing and masking the sensitive log data. When a user who does not have permission to view masked data views a log event that includes masked data, the sensitive data is replaced by asterisks.\n For more information, including a list of types of data that can be audited and masked, see [Protect sensitive log data with masking](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data.html).", "type": "object" }, "KmsKeyId": { - "description": "The Amazon Resource Name (ARN) of the CMK to use when encrypting log data.", + "description": "The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data.\n To associate an KMS key with the log group, specify the ARN of that KMS key here. If you do so, ingested data is encrypted using this key. This association is stored as long as the data encrypted with the KMS key is still within CWL. This enables CWL to decrypt this data whenever it is requested.\n If you attempt to associate a KMS key with the log group but the KMS key doesn't exist or is deactivated, you will receive an ``InvalidParameterException`` error.\n Log group data is always encrypted in CWL. If you omit this key, the encryption does not use KMS. For more information, see [Encrypt log data in using](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/encrypt-log-data-kms.html)", "maxLength": 256, "pattern": "^arn:[a-z0-9-]+:kms:[a-z0-9-]+:\\d{12}:(key|alias)/.+\\Z", "type": "string" }, "LogGroupClass": { "default": "STANDARD", - "description": "The class of the log group. Possible values are: STANDARD and INFREQUENT_ACCESS, with STANDARD being the default class", + "description": "Specifies the log group class for this log group. There are two classes:\n + The ``Standard`` log class supports all CWL features.\n + The ``Infrequent Access`` log class supports a subset of CWL features and incurs lower costs.\n \n For details about the features supported by each class, see [Log classes](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch_Logs_Log_Classes.html)", "enum": [ "STANDARD", "INFREQUENT_ACCESS" @@ -122,14 +122,14 @@ "type": "string" }, "LogGroupName": { - "description": "The name of the log group. If you don't specify a name, AWS CloudFormation generates a unique ID for the log group.", + "description": "The name of the log group. If you don't specify a name, CFNlong generates a unique ID for the log group.", "maxLength": 512, "minLength": 1, "pattern": "^[.\\-_/#A-Za-z0-9]{1,512}\\Z", "type": "string" }, "RetentionInDays": { - "description": "The number of days to retain the log events in the specified log group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1096, 1827, and 3653.", + "description": "The number of days to retain the log events in the specified log group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1096, 1827, 2192, 2557, 2922, 3288, and 3653.\n To set a log group so that its log events do not expire, use [DeleteRetentionPolicy](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DeleteRetentionPolicy.html).", "enum": [ 1, 3, @@ -157,7 +157,7 @@ "type": "integer" }, "Tags": { - "description": "An array of key-value pairs to apply to this resource.", + "description": "An array of key-value pairs to apply to the log group.\n For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).", "insertionOrder": false, "items": { "$ref": "#/definitions/Tag" diff --git a/artifacts/types/AWS::Logs::MetricFilter.json b/artifacts/types/AWS::Logs::MetricFilter.json index 95b1e058..320aed99 100644 --- a/artifacts/types/AWS::Logs::MetricFilter.json +++ b/artifacts/types/AWS::Logs::MetricFilter.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Logs-MetricFilter", "type": "AWS::Logs::MetricFilter", - "time": "2023-12-18T06:14:41.923Z", + "time": "2024-06-21T16:19:19.849Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -11,16 +11,16 @@ "definitions": { "Dimension": { "additionalProperties": false, - "description": "the key-value pairs that further define a metric.", + "description": "Specifies the CW metric dimensions to publish with this metric.\n Because dimensions are part of the unique identifier for a metric, whenever a unique dimension name/value pair is extracted from your logs, you are creating a new variation of that metric.\n For more information about publishing dimensions with metrics created by metric filters, see [Publishing dimensions with metrics from values in JSON or space-delimited log events](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html#logs-metric-filters-dimensions).\n Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as ``IPAddress`` or ``requestID`` as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric. \n To help prevent accidental high charges, Amazon disables a metric filter if it generates 1000 different name/value pairs for the dimensions that you have specified within a certain amount of time.\n You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see [Creating a Billing Alarm to Monitor Your Estimated Charges](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/monitor_estimated_charges_with_cloudwatch.html).", "properties": { "Key": { - "description": "The key of the dimension. Maximum length of 255.", + "description": "The name for the CW metric dimension that the metric filter creates.\n Dimension names must contain only ASCII characters, must include at least one non-whitespace character, and cannot start with a colon (:).", "maxLength": 255, "minLength": 1, "type": "string" }, "Value": { - "description": "The value of the dimension. Maximum length of 255.", + "description": "The log event field that will contain the value for this dimension. This dimension will only be published for a metric if the value is found in the log event. For example, ``$.eventType`` for JSON log events, or ``$server`` for space-delimited log events.", "maxLength": 255, "minLength": 1, "type": "string" @@ -34,13 +34,14 @@ }, "MetricTransformation": { "additionalProperties": false, + "description": "``MetricTransformation`` is a property of the ``AWS::Logs::MetricFilter`` resource that describes how to transform log streams into a CloudWatch metric.", "properties": { "DefaultValue": { - "description": "The value to emit when a filter pattern does not match a log event. This value can be null.", + "description": "(Optional) The value to emit when a filter pattern does not match a log event. This value can be null.", "type": "number" }, "Dimensions": { - "description": "Dimensions are the key-value pairs that further define a metric", + "description": "The fields to use as dimensions for the metric. One metric filter can include as many as three dimensions.\n Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as ``IPAddress`` or ``requestID`` as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric. \n CloudWatch Logs disables a metric filter if it generates 1000 different name/value pairs for your specified dimensions within a certain amount of time. This helps to prevent accidental high charges.\n You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see [Creating a Billing Alarm to Monitor Your Estimated Charges](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/monitor_estimated_charges_with_cloudwatch.html).", "insertionOrder": false, "items": { "$ref": "#/definitions/Dimension" @@ -51,7 +52,7 @@ "uniqueItems": true }, "MetricName": { - "description": "The name of the CloudWatch metric. Metric name must be in ASCII format.", + "description": "The name of the CloudWatch metric.", "maxLength": 255, "minLength": 1, "pattern": "^((?![:*$])[\\x00-\\x7F]){1,255}", @@ -59,21 +60,21 @@ }, "MetricNamespace": { "$comment": "Namespaces can be up to 256 characters long; valid characters include 0-9A-Za-z.-_/#", - "description": "The namespace of the CloudWatch metric.", + "description": "A custom namespace to contain your metric in CloudWatch. Use namespaces to group together metrics that are similar. For more information, see [Namespaces](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Namespace).", "maxLength": 256, "minLength": 1, "pattern": "^[0-9a-zA-Z\\.\\-_\\/#]{1,256}", "type": "string" }, "MetricValue": { - "description": "The value to publish to the CloudWatch metric when a filter pattern matches a log event.", + "description": "The value that is published to the CloudWatch metric. For example, if you're counting the occurrences of a particular term like ``Error``, specify 1 for the metric value. If you're counting the number of bytes transferred, reference the value that is in the log event by using $. followed by the name of the field that you specified in the filter pattern, such as ``$.size``.", "maxLength": 100, "minLength": 1, "pattern": ".{1,100}", "type": "string" }, "Unit": { - "description": "The unit to assign to the metric. If you omit this, the unit is set as None.", + "description": "The unit to assign to the metric. If you omit this, the unit is set as ``None``.", "enum": [ "Seconds", "Microseconds", @@ -114,7 +115,7 @@ "type": "object" } }, - "description": "Specifies a metric filter that describes how CloudWatch Logs extracts information from logs and transforms it into Amazon CloudWatch metrics.", + "description": "The ``AWS::Logs::MetricFilter`` resource specifies a metric filter that describes how CWL extracts information from logs and transforms it into Amazon CloudWatch metrics. If you have multiple metric filters that are associated with a log group, all the filters are applied to the log streams in that group.\n The maximum number of metric filters that can be associated with a log group is 100.", "handlers": { "create": { "permissions": [ @@ -150,26 +151,26 @@ ], "properties": { "FilterName": { - "description": "A name for the metric filter.", + "description": "The name of the metric filter.", "maxLength": 512, "minLength": 1, "pattern": "^[^:*]{1,512}", "type": "string" }, "FilterPattern": { - "description": "Pattern that Logs follows to interpret each entry in a log.", + "description": "A filter pattern for extracting metric data out of ingested log events. For more information, see [Filter and Pattern Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html).", "maxLength": 1024, "type": "string" }, "LogGroupName": { - "description": "Existing log group that you want to associate with this filter.", + "description": "The name of an existing log group that you want to associate with this metric filter.", "maxLength": 512, "minLength": 1, "pattern": "^[.\\-_/#A-Za-z0-9]{1,512}", "type": "string" }, "MetricTransformations": { - "description": "A collection of information that defines how metric data gets emitted.", + "description": "The metric transformations.", "insertionOrder": false, "items": { "$ref": "#/definitions/MetricTransformation" diff --git a/artifacts/types/AWS::Logs::QueryDefinition.json b/artifacts/types/AWS::Logs::QueryDefinition.json index 0cb1d449..80fb4537 100644 --- a/artifacts/types/AWS::Logs::QueryDefinition.json +++ b/artifacts/types/AWS::Logs::QueryDefinition.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Logs-QueryDefinition", "type": "AWS::Logs::QueryDefinition", - "time": "2023-12-18T06:18:02.656Z", + "time": "2024-06-21T15:48:38.731Z", "schema": { "additionalProperties": false, "definitions": { diff --git a/artifacts/types/AWS::Logs::ResourcePolicy.json b/artifacts/types/AWS::Logs::ResourcePolicy.json index 9fd19317..1125bbcc 100644 --- a/artifacts/types/AWS::Logs::ResourcePolicy.json +++ b/artifacts/types/AWS::Logs::ResourcePolicy.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Logs-ResourcePolicy", "type": "AWS::Logs::ResourcePolicy", - "time": "2023-12-18T06:20:52.79Z", + "time": "2024-06-21T15:49:16.44Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Logs::SubscriptionFilter.json b/artifacts/types/AWS::Logs::SubscriptionFilter.json index 18085fd9..ce840652 100644 --- a/artifacts/types/AWS::Logs::SubscriptionFilter.json +++ b/artifacts/types/AWS::Logs::SubscriptionFilter.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Logs-SubscriptionFilter", "type": "AWS::Logs::SubscriptionFilter", - "time": "2023-12-18T06:23:45.116Z", + "time": "2024-06-21T16:16:32.817Z", "schema": { "$schema": "https://raw.githubusercontent.com/aws-cloudformation/cloudformation-cli/master/src/rpdk/core/data/schema/provider.definition.schema.v1.json", "additionalProperties": false, @@ -9,7 +9,7 @@ "/properties/FilterName", "/properties/LogGroupName" ], - "description": "Subscription filters allow you to subscribe to a real-time stream of log events and have them delivered to a specific destination.", + "description": "The ``AWS::Logs::SubscriptionFilter`` resource specifies a subscription filter and associates it with the specified log group. Subscription filters allow you to subscribe to a real-time stream of log events and have them delivered to a specific destination. Currently, the supported destinations are:\n + An Amazon Kinesis data stream belonging to the same account as the subscription filter, for same-account delivery.\n + A logical destination that belongs to a different account, for cross-account delivery.\n + An Amazon Kinesis Firehose delivery stream that belongs to the same account as the subscription filter, for same-account delivery.\n + An LAMlong function that belongs to the same account as the subscription filter, for same-account delivery.\n \n There can be as many as two subscription filters associated with a log group.", "handlers": { "create": { "permissions": [ @@ -61,7 +61,7 @@ "type": "string" }, "Distribution": { - "description": "The method used to distribute log data to the destination. By default, log data is grouped by log stream, but the grouping can be set to random for a more even distribution. This property is only applicable when the destination is an Amazon Kinesis stream.", + "description": "The method used to distribute log data to the destination, which can be either random or grouped by log stream.", "enum": [ "Random", "ByLogStream" @@ -69,19 +69,19 @@ "type": "string" }, "FilterName": { - "description": "The name of the filter generated by resource.", + "description": "The name of the subscription filter.", "type": "string" }, "FilterPattern": { - "description": "The filtering expressions that restrict what gets delivered to the destination AWS resource.", + "description": "The filtering expressions that restrict what gets delivered to the destination AWS resource. For more information about the filter pattern syntax, see [Filter and Pattern Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html).", "type": "string" }, "LogGroupName": { - "description": "Existing log group that you want to associate with this filter.", + "description": "The log group to associate with the subscription filter. All log events that are uploaded to this log group are filtered and delivered to the specified AWS resource if the filter pattern matches the log events.", "type": "string" }, "RoleArn": { - "description": "The ARN of an IAM role that grants CloudWatch Logs permissions to deliver ingested log events to the destination stream. You don't need to provide the ARN when you are working with a logical destination for cross-account delivery.", + "description": "The ARN of an IAM role that grants CWL permissions to deliver ingested log events to the destination stream. You don't need to provide the ARN when you are working with a logical destination for cross-account delivery.", "type": "string" } }, diff --git a/artifacts/types/AWS::LookoutVision::Project.json b/artifacts/types/AWS::LookoutVision::Project.json index 7cf27c35..38a86ee9 100644 --- a/artifacts/types/AWS::LookoutVision::Project.json +++ b/artifacts/types/AWS::LookoutVision::Project.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-LookoutVision-Project", "type": "AWS::LookoutVision::Project", - "time": "2024-01-04T16:21:45.043Z", + "time": "2024-06-18T15:57:53.934Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::M2::Application.json b/artifacts/types/AWS::M2::Application.json index a07a4d17..83a340d9 100644 --- a/artifacts/types/AWS::M2::Application.json +++ b/artifacts/types/AWS::M2::Application.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-M2-Application", "type": "AWS::M2::Application", - "time": "2024-01-03T18:36:57.263Z", + "time": "2024-06-10T15:56:01.165Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::M2::Environment.json b/artifacts/types/AWS::M2::Environment.json index 003fcfee..5ad2a08b 100644 --- a/artifacts/types/AWS::M2::Environment.json +++ b/artifacts/types/AWS::M2::Environment.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-M2-Environment", "type": "AWS::M2::Environment", - "time": "2024-01-03T21:12:44.509Z", + "time": "2024-06-10T16:56:38.926Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -137,6 +137,7 @@ "ec2:ModifyNetworkInterfaceAttribute", "elasticfilesystem:DescribeMountTargets", "elasticloadbalancing:CreateLoadBalancer", + "elasticloadbalancing:DeleteLoadBalancer", "elasticloadbalancing:AddTags", "fsx:DescribeFileSystems", "iam:CreateServiceLinkedRole", @@ -172,7 +173,8 @@ "m2:UntagResource", "m2:ListTagsForResource", "m2:GetEnvironment", - "m2:UpdateEnvironment" + "m2:UpdateEnvironment", + "kms:DescribeKey" ] } }, diff --git a/artifacts/types/AWS::MSK::BatchScramSecret.json b/artifacts/types/AWS::MSK::BatchScramSecret.json index 150d0bfc..30d98d93 100644 --- a/artifacts/types/AWS::MSK::BatchScramSecret.json +++ b/artifacts/types/AWS::MSK::BatchScramSecret.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-MSK-BatchScramSecret", "type": "AWS::MSK::BatchScramSecret", - "time": "2023-12-07T04:26:55.115Z", + "time": "2024-02-20T21:27:05.98Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::MSK::Cluster.json b/artifacts/types/AWS::MSK::Cluster.json index 64c760da..f01ffd13 100644 --- a/artifacts/types/AWS::MSK::Cluster.json +++ b/artifacts/types/AWS::MSK::Cluster.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-MSK-Cluster", "type": "AWS::MSK::Cluster", - "time": "2023-12-07T03:34:19.164Z", + "time": "2024-02-20T20:37:25.721Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::MSK::ClusterPolicy.json b/artifacts/types/AWS::MSK::ClusterPolicy.json index 24b90876..976222e4 100644 --- a/artifacts/types/AWS::MSK::ClusterPolicy.json +++ b/artifacts/types/AWS::MSK::ClusterPolicy.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-MSK-ClusterPolicy", "type": "AWS::MSK::ClusterPolicy", - "time": "2023-12-07T05:47:40.863Z", + "time": "2024-02-20T22:50:54.474Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::MSK::Configuration.json b/artifacts/types/AWS::MSK::Configuration.json index 73ad23bb..5004c2a5 100644 --- a/artifacts/types/AWS::MSK::Configuration.json +++ b/artifacts/types/AWS::MSK::Configuration.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-MSK-Configuration", "type": "AWS::MSK::Configuration", - "time": "2023-12-06T17:16:34.727Z", + "time": "2024-02-20T16:41:17.801Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::MSK::Replicator.json b/artifacts/types/AWS::MSK::Replicator.json index 65bf1d43..91db73c7 100644 --- a/artifacts/types/AWS::MSK::Replicator.json +++ b/artifacts/types/AWS::MSK::Replicator.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-MSK-Replicator", "type": "AWS::MSK::Replicator", - "time": "2023-11-21T15:37:49.282Z", + "time": "2024-03-12T18:47:26.161Z", "schema": { "additionalIdentifiers": [ [ @@ -13,7 +13,8 @@ "/properties/ReplicatorName", "/properties/Description", "/properties/KafkaClusters", - "/properties/ServiceExecutionRoleArn" + "/properties/ServiceExecutionRoleArn", + "/properties/ReplicationInfoList/-/TopicReplication/StartingPosition/Type" ], "definitions": { "AmazonMskCluster": { @@ -167,6 +168,25 @@ ], "type": "object" }, + "ReplicationStartingPosition": { + "additionalProperties": false, + "description": "Configuration for specifying the position in the topics to start replicating from.", + "properties": { + "Type": { + "$ref": "#/definitions/ReplicationStartingPositionType" + } + }, + "required": [], + "type": "object" + }, + "ReplicationStartingPositionType": { + "description": "The type of replication starting position.", + "enum": [ + "LATEST", + "EARLIEST" + ], + "type": "string" + }, "Tag": { "additionalProperties": false, "properties": { @@ -201,6 +221,10 @@ "description": "Whether to periodically check for new topics and partitions.", "type": "boolean" }, + "StartingPosition": { + "$ref": "#/definitions/ReplicationStartingPosition", + "description": "Configuration for specifying the position in the topics to start replicating from." + }, "TopicsToExclude": { "description": "List of regular expression patterns indicating the topics that should not be replicated.", "insertionOrder": false, diff --git a/artifacts/types/AWS::MSK::VpcConnection.json b/artifacts/types/AWS::MSK::VpcConnection.json index 2a871506..9fcc7174 100644 --- a/artifacts/types/AWS::MSK::VpcConnection.json +++ b/artifacts/types/AWS::MSK::VpcConnection.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-MSK-VpcConnection", "type": "AWS::MSK::VpcConnection", - "time": "2023-12-07T06:44:24.132Z", + "time": "2024-02-20T23:24:35.683Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::MWAA::Environment.json b/artifacts/types/AWS::MWAA::Environment.json index d0be7d4e..3a83f675 100644 --- a/artifacts/types/AWS::MWAA::Environment.json +++ b/artifacts/types/AWS::MWAA::Environment.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-MWAA-Environment", "type": "AWS::MWAA::Environment", - "time": "2024-01-04T16:33:53.878Z", + "time": "2024-06-17T17:43:32.053Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -197,11 +197,21 @@ ], "type": "string" }, + "MaxWebservers": { + "description": "Maximum webserver compute units.", + "minimum": 2, + "type": "integer" + }, "MaxWorkers": { "description": "Maximum worker compute units.", "minimum": 1, "type": "integer" }, + "MinWebservers": { + "description": "Minimum webserver compute units.", + "minimum": 2, + "type": "integer" + }, "MinWorkers": { "description": "Minimum worker compute units.", "minimum": 1, @@ -428,9 +438,15 @@ "LoggingConfiguration": { "$ref": "#/definitions/LoggingConfiguration" }, + "MaxWebservers": { + "$ref": "#/definitions/MaxWebservers" + }, "MaxWorkers": { "$ref": "#/definitions/MaxWorkers" }, + "MinWebservers": { + "$ref": "#/definitions/MinWebservers" + }, "MinWorkers": { "$ref": "#/definitions/MinWorkers" }, diff --git a/artifacts/types/AWS::Macie::AllowList.json b/artifacts/types/AWS::Macie::AllowList.json index 0d0c5554..a1818997 100644 --- a/artifacts/types/AWS::Macie::AllowList.json +++ b/artifacts/types/AWS::Macie::AllowList.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Macie-AllowList", "type": "AWS::Macie::AllowList", - "time": "2024-01-04T16:21:49.714Z", + "time": "2024-06-20T15:25:13.346Z", "schema": { "additionalIdentifiers": [ [ diff --git a/artifacts/types/AWS::Macie::CustomDataIdentifier.json b/artifacts/types/AWS::Macie::CustomDataIdentifier.json index e7bf146f..edeaf530 100644 --- a/artifacts/types/AWS::Macie::CustomDataIdentifier.json +++ b/artifacts/types/AWS::Macie::CustomDataIdentifier.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Macie-CustomDataIdentifier", "type": "AWS::Macie::CustomDataIdentifier", - "time": "2024-01-03T16:54:29.228Z", + "time": "2024-01-25T16:20:56.163Z", "schema": { "additionalIdentifiers": [ [ diff --git a/artifacts/types/AWS::Macie::FindingsFilter.json b/artifacts/types/AWS::Macie::FindingsFilter.json index 8d4dca37..81df9cb9 100644 --- a/artifacts/types/AWS::Macie::FindingsFilter.json +++ b/artifacts/types/AWS::Macie::FindingsFilter.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Macie-FindingsFilter", "type": "AWS::Macie::FindingsFilter", - "time": "2024-01-03T16:24:37.874Z", + "time": "2024-06-11T15:21:29.098Z", "schema": { "additionalIdentifiers": [ [ diff --git a/artifacts/types/AWS::Macie::Session.json b/artifacts/types/AWS::Macie::Session.json index 50103b79..33e16b44 100644 --- a/artifacts/types/AWS::Macie::Session.json +++ b/artifacts/types/AWS::Macie::Session.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Macie-Session", "type": "AWS::Macie::Session", - "time": "2024-01-04T16:17:21.27Z", + "time": "2024-06-18T15:54:37.912Z", "schema": { "additionalProperties": false, "description": "The AWS::Macie::Session resource specifies a new Amazon Macie session. A session is an object that represents the Amazon Macie service. A session is required for Amazon Macie to become operational.", diff --git a/artifacts/types/AWS::MediaConnect::Bridge.json b/artifacts/types/AWS::MediaConnect::Bridge.json index 2c497b04..81570bea 100644 --- a/artifacts/types/AWS::MediaConnect::Bridge.json +++ b/artifacts/types/AWS::MediaConnect::Bridge.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-MediaConnect-Bridge", "type": "AWS::MediaConnect::Bridge", - "time": "2023-12-06T21:23:42.706Z", + "time": "2024-05-21T21:26:00.659Z", "schema": { "additionalProperties": false, "definitions": { diff --git a/artifacts/types/AWS::MediaConnect::BridgeOutput.json b/artifacts/types/AWS::MediaConnect::BridgeOutput.json index ceff7d5a..b2c2baff 100644 --- a/artifacts/types/AWS::MediaConnect::BridgeOutput.json +++ b/artifacts/types/AWS::MediaConnect::BridgeOutput.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-MediaConnect-BridgeOutput", "type": "AWS::MediaConnect::BridgeOutput", - "time": "2023-12-06T21:17:47.317Z", + "time": "2024-05-21T21:22:57.417Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::MediaConnect::BridgeSource.json b/artifacts/types/AWS::MediaConnect::BridgeSource.json index ae1b44f9..5c28c932 100644 --- a/artifacts/types/AWS::MediaConnect::BridgeSource.json +++ b/artifacts/types/AWS::MediaConnect::BridgeSource.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-MediaConnect-BridgeSource", "type": "AWS::MediaConnect::BridgeSource", - "time": "2023-12-06T21:21:49.501Z", + "time": "2024-05-21T21:24:02.581Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::MediaConnect::Flow.json b/artifacts/types/AWS::MediaConnect::Flow.json index f4415f9d..d5f5dd21 100644 --- a/artifacts/types/AWS::MediaConnect::Flow.json +++ b/artifacts/types/AWS::MediaConnect::Flow.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-MediaConnect-Flow", "type": "AWS::MediaConnect::Flow", - "time": "2023-10-19T21:15:49.584Z", + "time": "2024-06-12T18:52:49.605Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -107,6 +107,71 @@ }, "type": "object" }, + "Fmtp": { + "additionalProperties": false, + "description": "A set of parameters that define the media stream.", + "properties": { + "ChannelOrder": { + "description": "The format of the audio channel.", + "type": "string" + }, + "Colorimetry": { + "description": "The format used for the representation of color.", + "enum": [ + "BT601", + "BT709", + "BT2020", + "BT2100", + "ST2065-1", + "ST2065-3", + "XYZ" + ], + "type": "string" + }, + "ExactFramerate": { + "description": "The frame rate for the video stream, in frames/second. For example: 60000/1001.", + "type": "string" + }, + "Par": { + "description": "The pixel aspect ratio (PAR) of the video.", + "type": "string" + }, + "Range": { + "description": "The encoding range of the video.", + "enum": [ + "NARROW", + "FULL", + "FULLPROTECT" + ], + "type": "string" + }, + "ScanMode": { + "description": "The type of compression that was used to smooth the video's appearance.", + "enum": [ + "progressive", + "interlace", + "progressive-segmented-frame" + ], + "type": "string" + }, + "Tcs": { + "description": "The transfer characteristic system (TCS) that is used in the video.", + "enum": [ + "SDR", + "PQ", + "HLG", + "LINEAR", + "BT2100LINPQ", + "BT2100LINHLG", + "ST2065-1", + "ST428-1", + "DENSITY" + ], + "type": "string" + } + }, + "type": "object" + }, "GatewayBridgeSource": { "additionalProperties": false, "description": "The source configuration for cloud flows receiving a stream from a bridge.", @@ -125,6 +190,170 @@ ], "type": "object" }, + "InputConfiguration": { + "additionalProperties": false, + "description": "The transport parameters associated with an incoming media stream.", + "properties": { + "InputPort": { + "description": "The port that the flow listens on for an incoming media stream.", + "type": "integer" + }, + "Interface": { + "$ref": "#/definitions/Interface", + "description": "The VPC interface where the media stream comes in from." + } + }, + "required": [ + "InputPort", + "Interface" + ], + "type": "object" + }, + "Interface": { + "additionalProperties": false, + "description": "The VPC interface that you want to use for the media stream associated with the output.", + "properties": { + "Name": { + "description": "The name of the VPC interface that you want to use for the media stream associated with the output.", + "type": "string" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "Maintenance": { + "additionalProperties": false, + "description": "The maintenance setting of a flow.", + "properties": { + "MaintenanceDay": { + "description": "A day of a week when the maintenance will happen. Use Monday/Tuesday/Wednesday/Thursday/Friday/Saturday/Sunday.", + "enum": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "type": "string" + }, + "MaintenanceStartHour": { + "description": "UTC time when the maintenance will happen. Use 24-hour HH:MM format. Minutes must be 00. Example: 13:00. The default value is 02:00.", + "type": "string" + } + }, + "required": [ + "MaintenanceDay", + "MaintenanceStartHour" + ], + "type": "object" + }, + "MediaStream": { + "additionalProperties": false, + "description": "A single track or stream of media that contains video, audio, or ancillary data. After you add a media stream to a flow, you can associate it with sources and outputs on that flow, as long as they use the CDI protocol or the ST 2110 JPEG XS protocol. Each source or output can consist of one or many media streams.", + "properties": { + "Attributes": { + "$ref": "#/definitions/MediaStreamAttributes", + "description": "Attributes that are related to the media stream." + }, + "ClockRate": { + "description": "The sample rate for the stream. This value in measured in kHz.", + "type": "integer" + }, + "Description": { + "description": "A description that can help you quickly identify what your media stream is used for.", + "type": "string" + }, + "Fmt": { + "description": "The format type number (sometimes referred to as RTP payload type) of the media stream. MediaConnect assigns this value to the media stream. For ST 2110 JPEG XS outputs, you need to provide this value to the receiver.", + "type": "integer" + }, + "MediaStreamId": { + "description": "A unique identifier for the media stream.", + "type": "integer" + }, + "MediaStreamName": { + "description": "A name that helps you distinguish one media stream from another.", + "type": "string" + }, + "MediaStreamType": { + "description": "The type of media stream.", + "enum": [ + "video", + "audio", + "ancillary-data" + ], + "type": "string" + }, + "VideoFormat": { + "description": "The resolution of the video.", + "enum": [ + "2160p", + "1080p", + "1080i", + "720p", + "480p" + ], + "type": "string" + } + }, + "required": [ + "MediaStreamId", + "MediaStreamType", + "MediaStreamName" + ], + "type": "object" + }, + "MediaStreamAttributes": { + "additionalProperties": false, + "description": "Attributes that are related to the media stream.", + "properties": { + "Fmtp": { + "$ref": "#/definitions/Fmtp", + "description": "A set of parameters that define the media stream." + }, + "Lang": { + "description": "The audio language, in a format that is recognized by the receiver.", + "type": "string" + } + }, + "type": "object" + }, + "MediaStreamSourceConfiguration": { + "additionalProperties": false, + "description": "The media stream that is associated with the source, and the parameters for that association.", + "properties": { + "EncodingName": { + "description": "The format that was used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv.", + "enum": [ + "jxsv", + "raw", + "smpte291", + "pcm" + ], + "type": "string" + }, + "InputConfigurations": { + "description": "The media streams that you want to associate with the source.", + "items": { + "$ref": "#/definitions/InputConfiguration" + }, + "type": "array" + }, + "MediaStreamName": { + "description": "A name that helps you distinguish one media stream from another.", + "type": "string" + } + }, + "required": [ + "EncodingName", + "MediaStreamName" + ], + "type": "object" + }, "Source": { "additionalProperties": false, "description": "The settings for the source of the flow.", @@ -158,12 +387,21 @@ "type": "integer" }, "MaxLatency": { - "default": 2000, "description": "The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.", "type": "integer" }, + "MaxSyncBuffer": { + "description": "The size of the buffer (in milliseconds) to use to sync incoming source data.", + "type": "integer" + }, + "MediaStreamSourceConfigurations": { + "description": "The media stream that is associated with the source, and the parameters for that association.", + "items": { + "$ref": "#/definitions/MediaStreamSourceConfiguration" + }, + "type": "array" + }, "MinLatency": { - "default": 2000, "description": "The minimum latency in milliseconds.", "type": "integer" }, @@ -180,7 +418,9 @@ "rist", "fujitsu-qos", "srt-listener", - "srt-caller" + "srt-caller", + "st2110-jpegxs", + "cdi" ], "type": "string" }, @@ -223,6 +463,53 @@ }, "type": "object" }, + "VpcInterface": { + "additionalProperties": false, + "description": "The details of a VPC interface.", + "properties": { + "Name": { + "description": "Immutable and has to be a unique against other VpcInterfaces in this Flow.", + "type": "string" + }, + "NetworkInterfaceIds": { + "description": "IDs of the network interfaces created in customer's account by MediaConnect.", + "items": { + "type": "string" + }, + "type": "array" + }, + "NetworkInterfaceType": { + "description": "The type of network adapter that you want MediaConnect to use on this interface. If you don't set this value, it defaults to ENA.", + "enum": [ + "ena", + "efa" + ], + "type": "string" + }, + "RoleArn": { + "description": "Role Arn MediaConnect can assume to create ENIs in customer's account.", + "type": "string" + }, + "SecurityGroupIds": { + "description": "Security Group IDs to be used on ENI.", + "items": { + "type": "string" + }, + "type": "array" + }, + "SubnetId": { + "description": "Subnet must be in the AZ of the Flow", + "type": "string" + } + }, + "required": [ + "Name", + "RoleArn", + "SecurityGroupIds", + "SubnetId" + ], + "type": "object" + }, "VpcInterfaceAttachment": { "additionalProperties": false, "description": "The settings for attaching a VPC interface to an resource.", @@ -263,7 +550,12 @@ "permissions": [ "mediaconnect:DescribeFlow", "mediaconnect:UpdateFlow", - "mediaconnect:UpdateFlowSource" + "mediaconnect:UpdateFlowSource", + "mediaconnect:UpdateFlowMediaStream", + "mediaconnect:AddFlowMediaStreams", + "mediaconnect:RemoveFlowMediaStream", + "mediaconnect:AddFlowVpcInterfaces", + "mediaconnect:RemoveFlowVpcInterface" ] } }, @@ -275,6 +567,10 @@ "description": "The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS.", "type": "string" }, + "EgressIp": { + "description": "The IP address from which video will be sent to output destinations.", + "type": "string" + }, "FlowArn": { "description": "The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.", "type": "string" @@ -283,6 +579,17 @@ "description": "The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS.(ReadOnly)", "type": "string" }, + "Maintenance": { + "$ref": "#/definitions/Maintenance", + "description": "The maintenance settings you want to use for the flow. " + }, + "MediaStreams": { + "description": "The media streams associated with the flow. You can associate any of these media streams with sources and outputs on the flow.", + "items": { + "$ref": "#/definitions/MediaStream" + }, + "type": "array" + }, "Name": { "description": "The name of the flow.", "type": "string" @@ -294,6 +601,13 @@ "SourceFailoverConfig": { "$ref": "#/definitions/FailoverConfig", "description": "The source failover config of the flow." + }, + "VpcInterfaces": { + "description": "The VPC interfaces that you added to this flow.", + "items": { + "$ref": "#/definitions/VpcInterface" + }, + "type": "array" } }, "readOnlyProperties": [ @@ -301,12 +615,21 @@ "/properties/FlowAvailabilityZone", "/properties/Source/SourceArn", "/properties/Source/IngestIp", - "/properties/Source/SourceIngestPort" + "/properties/Source/SourceIngestPort", + "/properties/VpcInterfaces/*/NetworkInterfaceIds", + "/properties/MediaStreams/*/Fmt", + "/properties/EgressIp" ], "required": [ "Name", "Source" ], + "resourceLink": { + "mappings": { + "flowArn": "/FlowArn" + }, + "templateUri": "/mediaconnect/home?region=${awsRegion}#/flows/${flowArn}" + }, "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-mediaconnect.git", "typeName": "AWS::MediaConnect::Flow" } diff --git a/artifacts/types/AWS::MediaConnect::FlowEntitlement.json b/artifacts/types/AWS::MediaConnect::FlowEntitlement.json index 98d01ec3..4a62af8a 100644 --- a/artifacts/types/AWS::MediaConnect::FlowEntitlement.json +++ b/artifacts/types/AWS::MediaConnect::FlowEntitlement.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-MediaConnect-FlowEntitlement", "type": "AWS::MediaConnect::FlowEntitlement", - "time": "2023-10-19T21:15:03.085Z", + "time": "2024-06-12T18:53:09.749Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::MediaConnect::FlowOutput.json b/artifacts/types/AWS::MediaConnect::FlowOutput.json index 3ccb0f0d..6fc10b7c 100644 --- a/artifacts/types/AWS::MediaConnect::FlowOutput.json +++ b/artifacts/types/AWS::MediaConnect::FlowOutput.json @@ -1,13 +1,59 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-MediaConnect-FlowOutput", "type": "AWS::MediaConnect::FlowOutput", - "time": "2023-10-19T21:14:53.093Z", + "time": "2024-06-12T18:53:42.328Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ "/properties/Name" ], "definitions": { + "DestinationConfiguration": { + "additionalProperties": false, + "description": "The definition of a media stream that is associated with the output.", + "properties": { + "DestinationIp": { + "description": "The IP address where contents of the media stream will be sent.", + "type": "string" + }, + "DestinationPort": { + "description": "The port to use when the content of the media stream is distributed to the output.", + "type": "integer" + }, + "Interface": { + "$ref": "#/definitions/Interface", + "description": "The VPC interface that is used for the media stream associated with the output." + } + }, + "required": [ + "DestinationIp", + "DestinationPort", + "Interface" + ], + "type": "object" + }, + "EncodingParameters": { + "additionalProperties": false, + "description": "A collection of parameters that determine how MediaConnect will convert the content. These fields only apply to outputs on flows that have a CDI source.", + "properties": { + "CompressionFactor": { + "description": "A value that is used to calculate compression for an output. The bitrate of the output is calculated as follows: Output bitrate = (1 / compressionFactor) * (source bitrate) This property only applies to outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol. Valid values are in the range of 3.0 to 10.0, inclusive.", + "type": "number" + }, + "EncoderProfile": { + "description": "A setting on the encoder that drives compression settings. This property only applies to video media streams associated with outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol.", + "enum": [ + "main", + "high" + ], + "type": "string" + } + }, + "required": [ + "CompressionFactor" + ], + "type": "object" + }, "Encryption": { "additionalProperties": false, "description": "Information about the encryption of the flow.", @@ -45,6 +91,56 @@ ], "type": "object" }, + "Interface": { + "additionalProperties": false, + "description": "The VPC interface that you want to use for the media stream associated with the output.", + "properties": { + "Name": { + "description": "The name of the VPC interface that you want to use for the media stream associated with the output.", + "type": "string" + } + }, + "required": [ + "Name" + ], + "type": "object" + }, + "MediaStreamOutputConfiguration": { + "additionalProperties": false, + "description": "The media stream that is associated with the output, and the parameters for that association.", + "properties": { + "DestinationConfigurations": { + "description": "The media streams that you want to associate with the output.", + "items": { + "$ref": "#/definitions/DestinationConfiguration" + }, + "type": "array" + }, + "EncodingName": { + "description": "The format that will be used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video streams on sources or outputs that use the CDI protocol, set the encoding name to raw. For video streams on sources or outputs that use the ST 2110 JPEG XS protocol, set the encoding name to jxsv.", + "enum": [ + "jxsv", + "raw", + "smpte291", + "pcm" + ], + "type": "string" + }, + "EncodingParameters": { + "$ref": "#/definitions/EncodingParameters", + "description": "A collection of parameters that determine how MediaConnect will convert the content. These fields only apply to outputs on flows that have a CDI source." + }, + "MediaStreamName": { + "description": "A name that helps you distinguish one media stream from another.", + "type": "string" + } + }, + "required": [ + "EncodingName", + "MediaStreamName" + ], + "type": "object" + }, "VpcInterfaceAttachment": { "additionalProperties": false, "description": "The settings for attaching a VPC interface to an output.", @@ -119,6 +215,13 @@ "description": "The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.", "type": "integer" }, + "MediaStreamOutputConfigurations": { + "description": "The definition for each media stream that is associated with the output.", + "items": { + "$ref": "#/definitions/MediaStreamOutputConfiguration" + }, + "type": "array" + }, "MinLatency": { "description": "The minimum latency in milliseconds.", "type": "integer" @@ -145,7 +248,9 @@ "rist", "fujitsu-qos", "srt-listener", - "srt-caller" + "srt-caller", + "st2110-jpegxs", + "cdi" ], "type": "string" }, diff --git a/artifacts/types/AWS::MediaConnect::FlowSource.json b/artifacts/types/AWS::MediaConnect::FlowSource.json index 3e9dff13..3be0b9aa 100644 --- a/artifacts/types/AWS::MediaConnect::FlowSource.json +++ b/artifacts/types/AWS::MediaConnect::FlowSource.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-MediaConnect-FlowSource", "type": "AWS::MediaConnect::FlowSource", - "time": "2023-10-19T21:14:57.66Z", + "time": "2024-06-12T18:53:09.728Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::MediaConnect::FlowVpcInterface.json b/artifacts/types/AWS::MediaConnect::FlowVpcInterface.json index a0ef5fcd..f4e0c4f3 100644 --- a/artifacts/types/AWS::MediaConnect::FlowVpcInterface.json +++ b/artifacts/types/AWS::MediaConnect::FlowVpcInterface.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-MediaConnect-FlowVpcInterface", "type": "AWS::MediaConnect::FlowVpcInterface", - "time": "2023-10-19T21:26:59.555Z", + "time": "2024-06-12T19:03:33.732Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -62,7 +62,7 @@ "type": "array" }, "RoleArn": { - "description": "Role Arn MediaConnect can assumes to create ENIs in customer's account.", + "description": "Role Arn MediaConnect can assume to create ENIs in customer's account.", "type": "string" }, "SecurityGroupIds": { diff --git a/artifacts/types/AWS::MediaLive::Multiplex.json b/artifacts/types/AWS::MediaLive::Multiplex.json index 794ebf73..cd7a3ce2 100644 --- a/artifacts/types/AWS::MediaLive::Multiplex.json +++ b/artifacts/types/AWS::MediaLive::Multiplex.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-MediaLive-Multiplex", "type": "AWS::MediaLive::Multiplex", - "time": "2023-11-13T02:12:43.314Z", + "time": "2024-06-11T15:39:44.795Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::MediaLive::Multiplexprogram.json b/artifacts/types/AWS::MediaLive::Multiplexprogram.json index 41f70427..665aa63c 100644 --- a/artifacts/types/AWS::MediaLive::Multiplexprogram.json +++ b/artifacts/types/AWS::MediaLive::Multiplexprogram.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-MediaLive-Multiplexprogram", "type": "AWS::MediaLive::Multiplexprogram", - "time": "2023-11-13T02:11:45.841Z", + "time": "2024-06-11T15:39:40.734Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::MediaPackage::Channel.json b/artifacts/types/AWS::MediaPackage::Channel.json index a687db4f..b80ad949 100644 --- a/artifacts/types/AWS::MediaPackage::Channel.json +++ b/artifacts/types/AWS::MediaPackage::Channel.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-MediaPackage-Channel", "type": "AWS::MediaPackage::Channel", - "time": "2024-01-04T18:57:52.301Z", + "time": "2024-06-13T17:23:51.917Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -168,6 +168,13 @@ "Id" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": false, + "taggable": true + }, "typeName": "AWS::MediaPackage::Channel" } } \ No newline at end of file diff --git a/artifacts/types/AWS::MediaPackage::OriginEndpoint.json b/artifacts/types/AWS::MediaPackage::OriginEndpoint.json index 9fc5c5f1..f6ccf766 100644 --- a/artifacts/types/AWS::MediaPackage::OriginEndpoint.json +++ b/artifacts/types/AWS::MediaPackage::OriginEndpoint.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-MediaPackage-OriginEndpoint", "type": "AWS::MediaPackage::OriginEndpoint", - "time": "2024-01-04T19:24:09.539Z", + "time": "2024-06-13T17:43:35.162Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -598,28 +598,6 @@ ] } }, - "oneOf": [ - { - "required": [ - "HlsPackage" - ] - }, - { - "required": [ - "DashPackage" - ] - }, - { - "required": [ - "MssPackage" - ] - }, - { - "required": [ - "CmafPackage" - ] - } - ], "primaryIdentifier": [ "/properties/Id" ], @@ -707,6 +685,13 @@ "ChannelId" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": false, + "taggable": true + }, "typeName": "AWS::MediaPackage::OriginEndpoint" } } \ No newline at end of file diff --git a/artifacts/types/AWS::MediaPackage::PackagingGroup.json b/artifacts/types/AWS::MediaPackage::PackagingGroup.json index eeeb2ec4..8eb23cc3 100644 --- a/artifacts/types/AWS::MediaPackage::PackagingGroup.json +++ b/artifacts/types/AWS::MediaPackage::PackagingGroup.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-MediaPackage-PackagingGroup", "type": "AWS::MediaPackage::PackagingGroup", - "time": "2024-01-04T18:56:34.575Z", + "time": "2024-06-13T17:22:57.303Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -140,6 +140,13 @@ "Id" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-mediapackage.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": false, + "taggable": true + }, "typeName": "AWS::MediaPackage::PackagingGroup" } } \ No newline at end of file diff --git a/artifacts/types/AWS::MediaPackageV2::Channel.json b/artifacts/types/AWS::MediaPackageV2::Channel.json index 7ef39a53..c0e364c6 100644 --- a/artifacts/types/AWS::MediaPackageV2::Channel.json +++ b/artifacts/types/AWS::MediaPackageV2::Channel.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-MediaPackageV2-Channel", "type": "AWS::MediaPackageV2::Channel", - "time": "2024-01-04T17:23:00.473Z", + "time": "2024-06-13T17:55:22.21Z", "schema": { "additionalIdentifiers": [ [ @@ -17,11 +17,14 @@ "definitions": { "IngestEndpoint": { "additionalProperties": false, + "description": "\u003cp\u003eThe ingest domain URL where the source stream should be sent.\u003c/p\u003e", "properties": { "Id": { + "description": "\u003cp\u003eThe system-generated unique identifier for the IngestEndpoint.\u003c/p\u003e", "type": "string" }, "Url": { + "description": "\u003cp\u003eThe ingest domain URL where the source stream should be sent.\u003c/p\u003e", "type": "string" } }, @@ -40,7 +43,7 @@ "type": "object" } }, - "description": "Definition of AWS::MediaPackageV2::Channel Resource Type", + "description": "\u003cp\u003eRepresents an entry point into AWS Elemental MediaPackage for an ABR video content stream sent from an upstream encoder such as AWS Elemental MediaLive. The channel continuously analyzes the content that it receives and prepares it to be distributed to consumers via one or more origin endpoints.\u003c/p\u003e", "handlers": { "create": { "permissions": [ @@ -88,6 +91,7 @@ ], "properties": { "Arn": { + "description": "\u003cp\u003eThe Amazon Resource Name (ARN) associated with the resource.\u003c/p\u003e", "type": "string" }, "ChannelGroupName": { @@ -103,21 +107,31 @@ "type": "string" }, "CreatedAt": { + "description": "\u003cp\u003eThe date and time the channel was created.\u003c/p\u003e", "format": "date-time", "type": "string" }, "Description": { + "description": "\u003cp\u003eEnter any descriptive text that helps you to identify the channel.\u003c/p\u003e", "maxLength": 1024, "minLength": 0, "type": "string" }, + "IngestEndpointUrls": { + "items": { + "type": "string" + }, + "type": "array" + }, "IngestEndpoints": { + "description": "\u003cp\u003eThe list of ingest endpoints.\u003c/p\u003e", "items": { "$ref": "#/definitions/IngestEndpoint" }, "type": "array" }, "ModifiedAt": { + "description": "\u003cp\u003eThe date and time the channel was modified.\u003c/p\u003e", "format": "date-time", "type": "string" }, @@ -133,8 +147,13 @@ "/properties/Arn", "/properties/CreatedAt", "/properties/IngestEndpoints", + "/properties/IngestEndpointUrls", "/properties/ModifiedAt" ], + "required": [ + "ChannelGroupName", + "ChannelName" + ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-mediapackagev2", "tagging": { "cloudFormationSystemTags": false, diff --git a/artifacts/types/AWS::MediaPackageV2::ChannelGroup.json b/artifacts/types/AWS::MediaPackageV2::ChannelGroup.json index 109458f8..c54bfbe5 100644 --- a/artifacts/types/AWS::MediaPackageV2::ChannelGroup.json +++ b/artifacts/types/AWS::MediaPackageV2::ChannelGroup.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-MediaPackageV2-ChannelGroup", "type": "AWS::MediaPackageV2::ChannelGroup", - "time": "2024-01-04T17:05:52.419Z", + "time": "2024-06-13T17:38:34.116Z", "schema": { "additionalIdentifiers": [ [ @@ -26,7 +26,7 @@ "type": "object" } }, - "description": "Definition of AWS::MediaPackageV2::ChannelGroup Resource Type", + "description": "\u003cp\u003eRepresents a channel group that facilitates the grouping of multiple channels.\u003c/p\u003e", "handlers": { "create": { "permissions": [ @@ -64,6 +64,7 @@ ], "properties": { "Arn": { + "description": "\u003cp\u003eThe Amazon Resource Name (ARN) associated with the resource.\u003c/p\u003e", "type": "string" }, "ChannelGroupName": { @@ -73,18 +74,22 @@ "type": "string" }, "CreatedAt": { + "description": "\u003cp\u003eThe date and time the channel group was created.\u003c/p\u003e", "format": "date-time", "type": "string" }, "Description": { + "description": "\u003cp\u003eEnter any descriptive text that helps you to identify the channel group.\u003c/p\u003e", "maxLength": 1024, "minLength": 0, "type": "string" }, "EgressDomain": { + "description": "\u003cp\u003eThe output domain where the source stream should be sent. Integrate the domain with a downstream CDN (such as Amazon CloudFront) or playback device.\u003c/p\u003e", "type": "string" }, "ModifiedAt": { + "description": "\u003cp\u003eThe date and time the channel group was modified.\u003c/p\u003e", "format": "date-time", "type": "string" }, @@ -102,6 +107,9 @@ "/properties/EgressDomain", "/properties/ModifiedAt" ], + "required": [ + "ChannelGroupName" + ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-mediapackagev2", "tagging": { "cloudFormationSystemTags": false, diff --git a/artifacts/types/AWS::MediaPackageV2::ChannelPolicy.json b/artifacts/types/AWS::MediaPackageV2::ChannelPolicy.json index 718e3ac6..5d746dfc 100644 --- a/artifacts/types/AWS::MediaPackageV2::ChannelPolicy.json +++ b/artifacts/types/AWS::MediaPackageV2::ChannelPolicy.json @@ -1,14 +1,14 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-MediaPackageV2-ChannelPolicy", "type": "AWS::MediaPackageV2::ChannelPolicy", - "time": "2024-01-04T17:37:08.081Z", + "time": "2024-06-13T18:11:19.088Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ "/properties/ChannelGroupName", "/properties/ChannelName" ], - "description": "Definition of AWS::MediaPackageV2::ChannelPolicy Resource Type", + "description": "\u003cp\u003eRepresents a resource-based policy that allows or denies access to a channel.\u003c/p\u003e", "handlers": { "create": { "permissions": [ @@ -59,6 +59,8 @@ } }, "required": [ + "ChannelGroupName", + "ChannelName", "Policy" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-mediapackagev2", diff --git a/artifacts/types/AWS::MediaPackageV2::OriginEndpoint.json b/artifacts/types/AWS::MediaPackageV2::OriginEndpoint.json index 2e8f3978..15c3b9f0 100644 --- a/artifacts/types/AWS::MediaPackageV2::OriginEndpoint.json +++ b/artifacts/types/AWS::MediaPackageV2::OriginEndpoint.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-MediaPackageV2-OriginEndpoint", "type": "AWS::MediaPackageV2::OriginEndpoint", - "time": "2024-01-04T17:54:27.66Z", + "time": "2024-06-13T18:26:09.931Z", "schema": { "additionalIdentifiers": [ [ @@ -17,6 +17,13 @@ "/properties/OriginEndpointName" ], "definitions": { + "AdMarkerDash": { + "enum": [ + "BINARY", + "XML" + ], + "type": "string" + }, "AdMarkerHls": { "enum": [ "DATERANGE" @@ -37,6 +44,111 @@ ], "type": "string" }, + "DashDrmSignaling": { + "enum": [ + "INDIVIDUAL", + "REFERENCED" + ], + "type": "string" + }, + "DashManifestConfiguration": { + "additionalProperties": false, + "description": "\u003cp\u003eRetrieve the DASH manifest configuration.\u003c/p\u003e", + "properties": { + "DrmSignaling": { + "$ref": "#/definitions/DashDrmSignaling" + }, + "FilterConfiguration": { + "$ref": "#/definitions/FilterConfiguration" + }, + "ManifestName": { + "description": "\u003cp\u003eA 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. \u003c/p\u003e", + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string" + }, + "ManifestWindowSeconds": { + "description": "\u003cp\u003eThe total duration (in seconds) of the manifest's content.\u003c/p\u003e", + "type": "integer" + }, + "MinBufferTimeSeconds": { + "description": "\u003cp\u003eMinimum amount of content (in seconds) that a player must keep available in the buffer.\u003c/p\u003e", + "type": "integer" + }, + "MinUpdatePeriodSeconds": { + "description": "\u003cp\u003eMinimum amount of time (in seconds) that the player should wait before requesting updates to the manifest.\u003c/p\u003e", + "type": "integer" + }, + "PeriodTriggers": { + "description": "\u003cp\u003eA list of triggers that controls when AWS Elemental MediaPackage separates the MPEG-DASH manifest into multiple periods. Leave this value empty to indicate that the manifest is contained all in one period.\n For more information about periods in the DASH manifest, see \u003ca href=\"https://docs.aws.amazon.com/mediapackage/latest/userguide/multi-period.html\"\u003eMulti-period DASH in AWS Elemental MediaPackage\u003c/a\u003e.\u003c/p\u003e", + "items": { + "$ref": "#/definitions/DashPeriodTrigger" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "ScteDash": { + "$ref": "#/definitions/ScteDash" + }, + "SegmentTemplateFormat": { + "$ref": "#/definitions/DashSegmentTemplateFormat" + }, + "SuggestedPresentationDelaySeconds": { + "description": "\u003cp\u003eThe amount of time (in seconds) that the player should be from the end of the manifest.\u003c/p\u003e", + "type": "integer" + }, + "UtcTiming": { + "$ref": "#/definitions/DashUtcTiming" + } + }, + "required": [ + "ManifestName" + ], + "type": "object" + }, + "DashPeriodTrigger": { + "enum": [ + "AVAILS", + "DRM_KEY_ROTATION", + "SOURCE_CHANGES", + "SOURCE_DISRUPTIONS", + "NONE" + ], + "type": "string" + }, + "DashSegmentTemplateFormat": { + "enum": [ + "NUMBER_WITH_TIMELINE" + ], + "type": "string" + }, + "DashUtcTiming": { + "additionalProperties": false, + "description": "\u003cp\u003eDetermines the type of UTC timing included in the DASH Media Presentation Description (MPD).\u003c/p\u003e", + "properties": { + "TimingMode": { + "$ref": "#/definitions/DashUtcTimingMode" + }, + "TimingSource": { + "description": "\u003cp\u003eThe the method that the player uses to synchronize to coordinated universal time (UTC) wall clock time.\u003c/p\u003e", + "maxLength": 1024, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "DashUtcTimingMode": { + "enum": [ + "HTTP_HEAD", + "HTTP_ISO", + "HTTP_XSDATE", + "UTC_DIRECT" + ], + "type": "string" + }, "DrmSystem": { "enum": [ "CLEAR_KEY_AES_128", @@ -260,6 +372,16 @@ }, "type": "object" }, + "ScteDash": { + "additionalProperties": false, + "description": "\u003cp\u003eThe SCTE configuration.\u003c/p\u003e", + "properties": { + "AdMarkerDash": { + "$ref": "#/definitions/AdMarkerDash" + } + }, + "type": "object" + }, "ScteFilter": { "enum": [ "SPLICE_INSERT", @@ -464,12 +586,31 @@ "format": "date-time", "type": "string" }, + "DashManifestUrls": { + "items": { + "type": "string" + }, + "type": "array" + }, + "DashManifests": { + "description": "\u003cp\u003eA DASH manifest configuration.\u003c/p\u003e", + "items": { + "$ref": "#/definitions/DashManifestConfiguration" + }, + "type": "array" + }, "Description": { "description": "\u003cp\u003eEnter any descriptive text that helps you to identify the origin endpoint.\u003c/p\u003e", "maxLength": 1024, "minLength": 0, "type": "string" }, + "HlsManifestUrls": { + "items": { + "type": "string" + }, + "type": "array" + }, "HlsManifests": { "description": "\u003cp\u003eAn HTTP live streaming (HLS) manifest configuration.\u003c/p\u003e", "items": { @@ -477,6 +618,12 @@ }, "type": "array" }, + "LowLatencyHlsManifestUrls": { + "items": { + "type": "string" + }, + "type": "array" + }, "LowLatencyHlsManifests": { "description": "\u003cp\u003eA low-latency HLS manifest configuration.\u003c/p\u003e", "items": { @@ -515,12 +662,17 @@ "readOnlyProperties": [ "/properties/Arn", "/properties/CreatedAt", + "/properties/DashManifestUrls", + "/properties/HlsManifestUrls", + "/properties/LowLatencyHlsManifestUrls", "/properties/ModifiedAt", "/properties/LowLatencyHlsManifests/*/Url", "/properties/HlsManifests/*/Url" ], "required": [ - "ContainerType" + "ChannelGroupName", + "ChannelName", + "OriginEndpointName" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-mediapackagev2", "tagging": { diff --git a/artifacts/types/AWS::MediaPackageV2::OriginEndpointPolicy.json b/artifacts/types/AWS::MediaPackageV2::OriginEndpointPolicy.json index 32b76ed3..6250f20f 100644 --- a/artifacts/types/AWS::MediaPackageV2::OriginEndpointPolicy.json +++ b/artifacts/types/AWS::MediaPackageV2::OriginEndpointPolicy.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-MediaPackageV2-OriginEndpointPolicy", "type": "AWS::MediaPackageV2::OriginEndpointPolicy", - "time": "2024-01-04T18:09:47.128Z", + "time": "2024-06-13T18:41:23.453Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -9,7 +9,7 @@ "/properties/ChannelName", "/properties/OriginEndpointName" ], - "description": "Definition of AWS::MediaPackageV2::OriginEndpointPolicy Resource Type", + "description": "\u003cp\u003eRepresents a resource policy that allows or denies access to an origin endpoint.\u003c/p\u003e", "handlers": { "create": { "permissions": [ @@ -67,6 +67,9 @@ } }, "required": [ + "ChannelGroupName", + "ChannelName", + "OriginEndpointName", "Policy" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-mediapackagev2", diff --git a/artifacts/types/AWS::MediaTailor::Channel.json b/artifacts/types/AWS::MediaTailor::Channel.json index c6b4620b..75bf62cb 100644 --- a/artifacts/types/AWS::MediaTailor::Channel.json +++ b/artifacts/types/AWS::MediaTailor::Channel.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-MediaTailor-Channel", "type": "AWS::MediaTailor::Channel", - "time": "2024-01-02T16:26:24.663Z", + "time": "2024-05-16T19:08:53.233Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -209,6 +209,13 @@ "description": "\u003cp\u003eThe ARN of the channel.\u003c/p\u003e", "type": "string" }, + "Audiences": { + "description": "\u003cp\u003eThe list of audiences defined in channel.\u003c/p\u003e", + "items": { + "type": "string" + }, + "type": "array" + }, "ChannelName": { "type": "string" }, diff --git a/artifacts/types/AWS::MediaTailor::ChannelPolicy.json b/artifacts/types/AWS::MediaTailor::ChannelPolicy.json index 2e7b8ab9..46f64a53 100644 --- a/artifacts/types/AWS::MediaTailor::ChannelPolicy.json +++ b/artifacts/types/AWS::MediaTailor::ChannelPolicy.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-MediaTailor-ChannelPolicy", "type": "AWS::MediaTailor::ChannelPolicy", - "time": "2024-01-02T16:23:33.938Z", + "time": "2024-05-16T19:10:02.098Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::MediaTailor::LiveSource.json b/artifacts/types/AWS::MediaTailor::LiveSource.json index 5e633837..da88c1da 100644 --- a/artifacts/types/AWS::MediaTailor::LiveSource.json +++ b/artifacts/types/AWS::MediaTailor::LiveSource.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-MediaTailor-LiveSource", "type": "AWS::MediaTailor::LiveSource", - "time": "2024-01-02T16:26:27.384Z", + "time": "2024-05-16T19:09:45.719Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::MediaTailor::PlaybackConfiguration.json b/artifacts/types/AWS::MediaTailor::PlaybackConfiguration.json index e6d12b6b..ae519587 100644 --- a/artifacts/types/AWS::MediaTailor::PlaybackConfiguration.json +++ b/artifacts/types/AWS::MediaTailor::PlaybackConfiguration.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-MediaTailor-PlaybackConfiguration", "type": "AWS::MediaTailor::PlaybackConfiguration", - "time": "2024-01-02T16:12:32.912Z", + "time": "2024-05-16T18:59:02.079Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -23,11 +23,20 @@ "additionalProperties": false, "description": "The 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).", "properties": { + "FillPolicy": { + "description": "Defines 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. Valid values are FULL_AVAIL_ONLY and PARTIAL_AVAIL", + "enum": [ + "PARTIAL_AVAIL", + "FULL_AVAIL_ONLY" + ], + "type": "string" + }, "Mode": { - "description": "Sets the ad suppression mode. By default, ad suppression is set to 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.", + "description": "Sets 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.", "enum": [ "OFF", - "BEHIND_LIVE_EDGE" + "BEHIND_LIVE_EDGE", + "AFTER_LIVE_EDGE" ], "type": "string" }, diff --git a/artifacts/types/AWS::MediaTailor::SourceLocation.json b/artifacts/types/AWS::MediaTailor::SourceLocation.json index b421dbd7..54c8c821 100644 --- a/artifacts/types/AWS::MediaTailor::SourceLocation.json +++ b/artifacts/types/AWS::MediaTailor::SourceLocation.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-MediaTailor-SourceLocation", "type": "AWS::MediaTailor::SourceLocation", - "time": "2024-01-02T16:44:31.213Z", + "time": "2024-05-16T19:18:54.16Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::MediaTailor::VodSource.json b/artifacts/types/AWS::MediaTailor::VodSource.json index f8064e8f..c65d331d 100644 --- a/artifacts/types/AWS::MediaTailor::VodSource.json +++ b/artifacts/types/AWS::MediaTailor::VodSource.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-MediaTailor-VodSource", "type": "AWS::MediaTailor::VodSource", - "time": "2024-01-02T16:26:25.61Z", + "time": "2024-05-16T19:08:54.559Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Neptune::DBCluster.json b/artifacts/types/AWS::Neptune::DBCluster.json index 92f23572..9cec1590 100644 --- a/artifacts/types/AWS::Neptune::DBCluster.json +++ b/artifacts/types/AWS::Neptune::DBCluster.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Neptune-DBCluster", "type": "AWS::Neptune::DBCluster", - "time": "2024-01-03T04:39:51.961Z", + "time": "2024-02-28T03:02:57.355Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::NeptuneGraph::Graph.json b/artifacts/types/AWS::NeptuneGraph::Graph.json index 0a08bf4e..c36f8c48 100644 --- a/artifacts/types/AWS::NeptuneGraph::Graph.json +++ b/artifacts/types/AWS::NeptuneGraph::Graph.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-NeptuneGraph-Graph", "type": "AWS::NeptuneGraph::Graph", - "time": "2024-01-04T19:11:35.051Z", + "time": "2024-05-17T01:03:26.449Z", "schema": { "additionalIdentifiers": [ [ diff --git a/artifacts/types/AWS::NeptuneGraph::PrivateGraphEndpoint.json b/artifacts/types/AWS::NeptuneGraph::PrivateGraphEndpoint.json index 4c9d9864..c6435b67 100644 --- a/artifacts/types/AWS::NeptuneGraph::PrivateGraphEndpoint.json +++ b/artifacts/types/AWS::NeptuneGraph::PrivateGraphEndpoint.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-NeptuneGraph-PrivateGraphEndpoint", "type": "AWS::NeptuneGraph::PrivateGraphEndpoint", - "time": "2024-01-04T19:09:23.901Z", + "time": "2024-05-17T00:47:28.374Z", "schema": { "additionalIdentifiers": [ [ diff --git a/artifacts/types/AWS::NetworkFirewall::Firewall.json b/artifacts/types/AWS::NetworkFirewall::Firewall.json index 5ead95a1..2c0dba51 100644 --- a/artifacts/types/AWS::NetworkFirewall::Firewall.json +++ b/artifacts/types/AWS::NetworkFirewall::Firewall.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-NetworkFirewall-Firewall", "type": "AWS::NetworkFirewall::Firewall", - "time": "2023-12-21T04:53:08.761Z", + "time": "2024-06-19T19:05:18.719Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -97,7 +97,7 @@ "read": { "permissions": [ "network-firewall:DescribeFirewall", - "network-firewall:ListTagsForResources" + "network-firewall:ListTagsForResource" ] }, "update": { diff --git a/artifacts/types/AWS::NetworkFirewall::FirewallPolicy.json b/artifacts/types/AWS::NetworkFirewall::FirewallPolicy.json index 783d54b8..6066ac52 100644 --- a/artifacts/types/AWS::NetworkFirewall::FirewallPolicy.json +++ b/artifacts/types/AWS::NetworkFirewall::FirewallPolicy.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-NetworkFirewall-FirewallPolicy", "type": "AWS::NetworkFirewall::FirewallPolicy", - "time": "2023-12-20T22:04:49.006Z", + "time": "2024-06-19T17:47:09.469Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::NetworkFirewall::LoggingConfiguration.json b/artifacts/types/AWS::NetworkFirewall::LoggingConfiguration.json index 562a2fd2..0238ab67 100644 --- a/artifacts/types/AWS::NetworkFirewall::LoggingConfiguration.json +++ b/artifacts/types/AWS::NetworkFirewall::LoggingConfiguration.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-NetworkFirewall-LoggingConfiguration", "type": "AWS::NetworkFirewall::LoggingConfiguration", - "time": "2023-12-21T05:37:24.76Z", + "time": "2024-06-19T19:30:04.497Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -100,13 +100,6 @@ "network-firewall:DescribeLoggingConfiguration" ] }, - "list": { - "permissions": [ - "logs:GetLogDelivery", - "logs:ListLogDeliveries", - "network-firewall:DescribeLoggingConfiguration" - ] - }, "read": { "permissions": [ "logs:GetLogDelivery", diff --git a/artifacts/types/AWS::NetworkFirewall::RuleGroup.json b/artifacts/types/AWS::NetworkFirewall::RuleGroup.json index 57f34d1a..f46e5a4e 100644 --- a/artifacts/types/AWS::NetworkFirewall::RuleGroup.json +++ b/artifacts/types/AWS::NetworkFirewall::RuleGroup.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-NetworkFirewall-RuleGroup", "type": "AWS::NetworkFirewall::RuleGroup", - "time": "2023-12-20T21:12:26.67Z", + "time": "2024-06-19T17:02:17.603Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::NetworkFirewall::TLSInspectionConfiguration.json b/artifacts/types/AWS::NetworkFirewall::TLSInspectionConfiguration.json index 3297f17f..b3e3e0da 100644 --- a/artifacts/types/AWS::NetworkFirewall::TLSInspectionConfiguration.json +++ b/artifacts/types/AWS::NetworkFirewall::TLSInspectionConfiguration.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-NetworkFirewall-TLSInspectionConfiguration", "type": "AWS::NetworkFirewall::TLSInspectionConfiguration", - "time": "2023-12-20T19:25:14.759Z", + "time": "2024-06-19T16:17:57.973Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -205,6 +205,7 @@ "handlers": { "create": { "permissions": [ + "iam:CreateServiceLinkedRole", "network-firewall:CreateTLSInspectionConfiguration", "network-firewall:DescribeTLSInspectionConfiguration", "network-firewall:TagResource" diff --git a/artifacts/types/AWS::NetworkManager::ConnectAttachment.json b/artifacts/types/AWS::NetworkManager::ConnectAttachment.json index 98fec182..018a5844 100644 --- a/artifacts/types/AWS::NetworkManager::ConnectAttachment.json +++ b/artifacts/types/AWS::NetworkManager::ConnectAttachment.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-NetworkManager-ConnectAttachment", "type": "AWS::NetworkManager::ConnectAttachment", - "time": "2023-11-13T23:49:48.144Z", + "time": "2024-02-15T19:55:12.504Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::NetworkManager::ConnectPeer.json b/artifacts/types/AWS::NetworkManager::ConnectPeer.json index 217c5da9..cf35e39d 100644 --- a/artifacts/types/AWS::NetworkManager::ConnectPeer.json +++ b/artifacts/types/AWS::NetworkManager::ConnectPeer.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-NetworkManager-ConnectPeer", "type": "AWS::NetworkManager::ConnectPeer", - "time": "2023-11-14T02:21:50.132Z", + "time": "2024-02-15T21:52:32.45Z", "schema": { "additionalIdentifiers": [ [ diff --git a/artifacts/types/AWS::NetworkManager::CoreNetwork.json b/artifacts/types/AWS::NetworkManager::CoreNetwork.json index 136ba0b2..f2f8267b 100644 --- a/artifacts/types/AWS::NetworkManager::CoreNetwork.json +++ b/artifacts/types/AWS::NetworkManager::CoreNetwork.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-NetworkManager-CoreNetwork", "type": "AWS::NetworkManager::CoreNetwork", - "time": "2023-11-13T18:59:21.653Z", + "time": "2024-02-15T16:24:04.704Z", "schema": { "additionalIdentifiers": [ [ diff --git a/artifacts/types/AWS::NetworkManager::Device.json b/artifacts/types/AWS::NetworkManager::Device.json index 19236e90..e5c9099f 100644 --- a/artifacts/types/AWS::NetworkManager::Device.json +++ b/artifacts/types/AWS::NetworkManager::Device.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-NetworkManager-Device", "type": "AWS::NetworkManager::Device", - "time": "2023-11-13T16:57:08.601Z", + "time": "2024-02-15T14:48:52.327Z", "schema": { "additionalIdentifiers": [ [ diff --git a/artifacts/types/AWS::NetworkManager::GlobalNetwork.json b/artifacts/types/AWS::NetworkManager::GlobalNetwork.json index 331f0fd2..54585633 100644 --- a/artifacts/types/AWS::NetworkManager::GlobalNetwork.json +++ b/artifacts/types/AWS::NetworkManager::GlobalNetwork.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-NetworkManager-GlobalNetwork", "type": "AWS::NetworkManager::GlobalNetwork", - "time": "2023-11-13T16:41:20.564Z", + "time": "2024-02-15T14:36:31.028Z", "schema": { "additionalIdentifiers": [ [ diff --git a/artifacts/types/AWS::NetworkManager::Link.json b/artifacts/types/AWS::NetworkManager::Link.json index 77416d96..5df3ed88 100644 --- a/artifacts/types/AWS::NetworkManager::Link.json +++ b/artifacts/types/AWS::NetworkManager::Link.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-NetworkManager-Link", "type": "AWS::NetworkManager::Link", - "time": "2023-11-13T17:12:36.583Z", + "time": "2024-02-15T15:02:29.491Z", "schema": { "additionalIdentifiers": [ [ diff --git a/artifacts/types/AWS::NetworkManager::Site.json b/artifacts/types/AWS::NetworkManager::Site.json index 873bdb6d..5c16891d 100644 --- a/artifacts/types/AWS::NetworkManager::Site.json +++ b/artifacts/types/AWS::NetworkManager::Site.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-NetworkManager-Site", "type": "AWS::NetworkManager::Site", - "time": "2023-11-13T16:57:14.733Z", + "time": "2024-02-15T14:48:52.228Z", "schema": { "additionalIdentifiers": [ [ diff --git a/artifacts/types/AWS::NetworkManager::SiteToSiteVpnAttachment.json b/artifacts/types/AWS::NetworkManager::SiteToSiteVpnAttachment.json index a893b1a9..ecbecff2 100644 --- a/artifacts/types/AWS::NetworkManager::SiteToSiteVpnAttachment.json +++ b/artifacts/types/AWS::NetworkManager::SiteToSiteVpnAttachment.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-NetworkManager-SiteToSiteVpnAttachment", "type": "AWS::NetworkManager::SiteToSiteVpnAttachment", - "time": "2023-11-13T22:09:08.297Z", + "time": "2024-02-15T18:46:56.904Z", "schema": { "additionalIdentifiers": [ [ diff --git a/artifacts/types/AWS::NetworkManager::TransitGatewayPeering.json b/artifacts/types/AWS::NetworkManager::TransitGatewayPeering.json index 24b214b1..16c74a94 100644 --- a/artifacts/types/AWS::NetworkManager::TransitGatewayPeering.json +++ b/artifacts/types/AWS::NetworkManager::TransitGatewayPeering.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-NetworkManager-TransitGatewayPeering", "type": "AWS::NetworkManager::TransitGatewayPeering", - "time": "2023-11-13T22:26:24.787Z", + "time": "2024-02-15T19:03:50.93Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::NetworkManager::TransitGatewayRouteTableAttachment.json b/artifacts/types/AWS::NetworkManager::TransitGatewayRouteTableAttachment.json index 763cf9bf..790eb854 100644 --- a/artifacts/types/AWS::NetworkManager::TransitGatewayRouteTableAttachment.json +++ b/artifacts/types/AWS::NetworkManager::TransitGatewayRouteTableAttachment.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-NetworkManager-TransitGatewayRouteTableAttachment", "type": "AWS::NetworkManager::TransitGatewayRouteTableAttachment", - "time": "2023-11-14T01:07:11.083Z", + "time": "2024-02-15T21:03:11.885Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::NetworkManager::VpcAttachment.json b/artifacts/types/AWS::NetworkManager::VpcAttachment.json index 01f1ad96..53f54606 100644 --- a/artifacts/types/AWS::NetworkManager::VpcAttachment.json +++ b/artifacts/types/AWS::NetworkManager::VpcAttachment.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-NetworkManager-VpcAttachment", "type": "AWS::NetworkManager::VpcAttachment", - "time": "2023-11-13T21:40:31.05Z", + "time": "2024-02-15T18:25:47.58Z", "schema": { "additionalIdentifiers": [ [ diff --git a/artifacts/types/AWS::NimbleStudio::LaunchProfile.json b/artifacts/types/AWS::NimbleStudio::LaunchProfile.json index cd226956..1314f60e 100644 --- a/artifacts/types/AWS::NimbleStudio::LaunchProfile.json +++ b/artifacts/types/AWS::NimbleStudio::LaunchProfile.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-NimbleStudio-LaunchProfile", "type": "AWS::NimbleStudio::LaunchProfile", - "time": "2024-01-04T16:36:37.638Z", + "time": "2024-06-06T17:37:10.275Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::NimbleStudio::StreamingImage.json b/artifacts/types/AWS::NimbleStudio::StreamingImage.json index f086bd85..2511275a 100644 --- a/artifacts/types/AWS::NimbleStudio::StreamingImage.json +++ b/artifacts/types/AWS::NimbleStudio::StreamingImage.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-NimbleStudio-StreamingImage", "type": "AWS::NimbleStudio::StreamingImage", - "time": "2024-01-04T16:28:34.25Z", + "time": "2024-06-06T17:29:41.769Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::NimbleStudio::Studio.json b/artifacts/types/AWS::NimbleStudio::Studio.json index e8468771..06f9d624 100644 --- a/artifacts/types/AWS::NimbleStudio::Studio.json +++ b/artifacts/types/AWS::NimbleStudio::Studio.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-NimbleStudio-Studio", "type": "AWS::NimbleStudio::Studio", - "time": "2024-01-04T16:46:31.17Z", + "time": "2024-06-06T17:37:38.714Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::NimbleStudio::StudioComponent.json b/artifacts/types/AWS::NimbleStudio::StudioComponent.json index 1c1995f3..5445ca4a 100644 --- a/artifacts/types/AWS::NimbleStudio::StudioComponent.json +++ b/artifacts/types/AWS::NimbleStudio::StudioComponent.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-NimbleStudio-StudioComponent", "type": "AWS::NimbleStudio::StudioComponent", - "time": "2024-01-04T16:29:51.669Z", + "time": "2024-06-06T17:28:31.157Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::OSIS::Pipeline.json b/artifacts/types/AWS::OSIS::Pipeline.json index d96ded1b..30a3ca38 100644 --- a/artifacts/types/AWS::OSIS::Pipeline.json +++ b/artifacts/types/AWS::OSIS::Pipeline.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-OSIS-Pipeline", "type": "AWS::OSIS::Pipeline", - "time": "2023-12-07T22:08:37.137Z", + "time": "2024-06-11T23:14:04.237Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -129,6 +129,14 @@ "type": "string" }, "type": "array" + }, + "VpcEndpointManagement": { + "description": "Defines whether you or Amazon OpenSearch Ingestion service create and manage the VPC endpoint configured for the pipeline.", + "enum": [ + "CUSTOMER", + "SERVICE" + ], + "type": "string" } }, "required": [ @@ -208,14 +216,14 @@ "$ref": "#/definitions/LogPublishingOptions" }, "MaxUnits": { - "description": "The maximum pipeline capacity, in Ingestion Compute Units (ICUs).", - "maximum": 24, + "description": "The maximum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs).", + "maximum": 384, "minimum": 1, "type": "integer" }, "MinUnits": { - "description": "The minimum pipeline capacity, in Ingestion Compute Units (ICUs).", - "maximum": 24, + "description": "The minimum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs).", + "maximum": 384, "minimum": 1, "type": "integer" }, @@ -227,8 +235,8 @@ "type": "string" }, "PipelineConfigurationBody": { - "description": "The Data Prepper pipeline configuration in YAML format.", - "maxLength": 12000, + "description": "The Data Prepper pipeline configuration.", + "maxLength": 24000, "minLength": 1, "type": "string" }, @@ -248,6 +256,12 @@ "type": "array", "uniqueItems": true }, + "VpcEndpointService": { + "description": "The VPC endpoint service name for the pipeline.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, "VpcEndpoints": { "description": "The VPC interface endpoints that have access to the pipeline.", "insertionOrder": false, @@ -263,7 +277,8 @@ "readOnlyProperties": [ "/properties/PipelineArn", "/properties/IngestEndpointUrls", - "/properties/VpcEndpoints" + "/properties/VpcEndpoints", + "/properties/VpcEndpointService" ], "required": [ "MaxUnits", diff --git a/artifacts/types/AWS::Oam::Link.json b/artifacts/types/AWS::Oam::Link.json index b20f892f..56516995 100644 --- a/artifacts/types/AWS::Oam::Link.json +++ b/artifacts/types/AWS::Oam::Link.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Oam-Link", "type": "AWS::Oam::Link", - "time": "2024-01-02T17:19:00.939Z", + "time": "2024-06-19T11:57:16.545Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -9,12 +9,39 @@ "/properties/LabelTemplate" ], "definitions": { + "LinkConfiguration": { + "additionalProperties": false, + "properties": { + "LogGroupConfiguration": { + "$ref": "#/definitions/LinkFilter" + }, + "MetricConfiguration": { + "$ref": "#/definitions/LinkFilter" + } + }, + "type": "object" + }, + "LinkFilter": { + "additionalProperties": false, + "properties": { + "Filter": { + "maxLength": 2000, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Filter" + ], + "type": "object" + }, "ResourceType": { "enum": [ "AWS::CloudWatch::Metric", "AWS::Logs::LogGroup", "AWS::XRay::Trace", - "AWS::ApplicationInsights::Application" + "AWS::ApplicationInsights::Application", + "AWS::InternetMonitor::Monitor" ], "type": "string" } @@ -28,7 +55,8 @@ "cloudwatch:Link", "logs:Link", "xray:Link", - "applicationinsights:Link" + "applicationinsights:Link", + "internetmonitor:Link" ] }, "delete": { @@ -55,6 +83,7 @@ "logs:Link", "xray:Link", "applicationinsights:Link", + "internetmonitor:Link", "oam:TagResource", "oam:UntagResource" ] @@ -76,6 +105,9 @@ "minLength": 1, "type": "string" }, + "LinkConfiguration": { + "$ref": "#/definitions/LinkConfiguration" + }, "ResourceTypes": { "insertionOrder": false, "items": { @@ -95,11 +127,11 @@ "additionalProperties": false, "description": "Tags to apply to the link", "patternProperties": { - "^(?!aws:.*)[a-zA-Z0-9\\s\\_\\.\\/\\=\\+\\-]{1,128}$": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "^(?!aws:.*).{1,128}$": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:.", "maxLength": 256, "minLength": 0, - "pattern": "^(?!aws:.*)[a-zA-Z0-9\\s\\_\\.\\/\\=\\+\\-]{0,256}$", + "pattern": "^(?!aws:.*).{0,256}$", "type": "string" } }, diff --git a/artifacts/types/AWS::Oam::Sink.json b/artifacts/types/AWS::Oam::Sink.json index 3226e7f5..f1f95925 100644 --- a/artifacts/types/AWS::Oam::Sink.json +++ b/artifacts/types/AWS::Oam::Sink.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Oam-Sink", "type": "AWS::Oam::Sink", - "time": "2024-01-02T17:22:27.542Z", + "time": "2024-06-19T11:57:56.089Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -69,11 +69,11 @@ "additionalProperties": false, "description": "Tags to apply to the sink", "patternProperties": { - "^(?!aws:.*)[a-zA-Z0-9\\s\\_\\.\\/\\=\\+\\-]{1,128}$": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "^(?!aws:.*).{1,128}$": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:.", "maxLength": 256, "minLength": 0, - "pattern": "^(?!aws:.*)[a-zA-Z0-9\\s\\_\\.\\/\\=\\+\\-]{0,256}$", + "pattern": "^(?!aws:.*).{0,256}$", "type": "string" } }, diff --git a/artifacts/types/AWS::Omics::AnnotationStore.json b/artifacts/types/AWS::Omics::AnnotationStore.json index 4ae4b046..000858c1 100644 --- a/artifacts/types/AWS::Omics::AnnotationStore.json +++ b/artifacts/types/AWS::Omics::AnnotationStore.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Omics-AnnotationStore", "type": "AWS::Omics::AnnotationStore", - "time": "2023-12-13T17:20:22.071Z", + "time": "2024-06-18T15:30:57.571Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Omics::RunGroup.json b/artifacts/types/AWS::Omics::RunGroup.json index 711bf131..fbbf5c59 100644 --- a/artifacts/types/AWS::Omics::RunGroup.json +++ b/artifacts/types/AWS::Omics::RunGroup.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Omics-RunGroup", "type": "AWS::Omics::RunGroup", - "time": "2023-12-13T16:37:10.955Z", + "time": "2024-06-18T15:30:11.599Z", "schema": { "additionalProperties": false, "definitions": { diff --git a/artifacts/types/AWS::Omics::VariantStore.json b/artifacts/types/AWS::Omics::VariantStore.json index c7401ab1..accdf551 100644 --- a/artifacts/types/AWS::Omics::VariantStore.json +++ b/artifacts/types/AWS::Omics::VariantStore.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Omics-VariantStore", "type": "AWS::Omics::VariantStore", - "time": "2023-12-13T17:21:00.67Z", + "time": "2024-06-18T16:02:06.653Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Omics::Workflow.json b/artifacts/types/AWS::Omics::Workflow.json index 2c44ac51..7a9085bd 100644 --- a/artifacts/types/AWS::Omics::Workflow.json +++ b/artifacts/types/AWS::Omics::Workflow.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Omics-Workflow", "type": "AWS::Omics::Workflow", - "time": "2023-12-13T16:41:58.521Z", + "time": "2024-06-18T15:33:21.959Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::OpenSearchServerless::AccessPolicy.json b/artifacts/types/AWS::OpenSearchServerless::AccessPolicy.json index 8d6e153c..7372f02f 100644 --- a/artifacts/types/AWS::OpenSearchServerless::AccessPolicy.json +++ b/artifacts/types/AWS::OpenSearchServerless::AccessPolicy.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-OpenSearchServerless-AccessPolicy", "type": "AWS::OpenSearchServerless::AccessPolicy", - "time": "2024-01-02T16:21:58.914Z", + "time": "2024-05-08T15:54:18.62Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::OpenSearchServerless::Collection.json b/artifacts/types/AWS::OpenSearchServerless::Collection.json index 76aefd70..7cd98e6f 100644 --- a/artifacts/types/AWS::OpenSearchServerless::Collection.json +++ b/artifacts/types/AWS::OpenSearchServerless::Collection.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-OpenSearchServerless-Collection", "type": "AWS::OpenSearchServerless::Collection", - "time": "2024-01-02T16:21:58.718Z", + "time": "2024-05-08T16:02:26.762Z", "schema": { "additionalIdentifiers": [ [ diff --git a/artifacts/types/AWS::OpenSearchServerless::LifecyclePolicy.json b/artifacts/types/AWS::OpenSearchServerless::LifecyclePolicy.json index 4e6ba7e0..c7b1c2a5 100644 --- a/artifacts/types/AWS::OpenSearchServerless::LifecyclePolicy.json +++ b/artifacts/types/AWS::OpenSearchServerless::LifecyclePolicy.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-OpenSearchServerless-LifecyclePolicy", "type": "AWS::OpenSearchServerless::LifecyclePolicy", - "time": "2024-01-02T16:22:39.375Z", + "time": "2024-05-08T15:54:19.858Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::OpenSearchServerless::SecurityConfig.json b/artifacts/types/AWS::OpenSearchServerless::SecurityConfig.json index 360a86a3..d5885a25 100644 --- a/artifacts/types/AWS::OpenSearchServerless::SecurityConfig.json +++ b/artifacts/types/AWS::OpenSearchServerless::SecurityConfig.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-OpenSearchServerless-SecurityConfig", "type": "AWS::OpenSearchServerless::SecurityConfig", - "time": "2024-01-02T16:22:03.134Z", + "time": "2024-05-08T15:54:20.809Z", "schema": { "additionalIdentifiers": [ [ diff --git a/artifacts/types/AWS::OpenSearchServerless::SecurityPolicy.json b/artifacts/types/AWS::OpenSearchServerless::SecurityPolicy.json index f53abcfe..a69ee02f 100644 --- a/artifacts/types/AWS::OpenSearchServerless::SecurityPolicy.json +++ b/artifacts/types/AWS::OpenSearchServerless::SecurityPolicy.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-OpenSearchServerless-SecurityPolicy", "type": "AWS::OpenSearchServerless::SecurityPolicy", - "time": "2024-01-02T16:21:59.987Z", + "time": "2024-05-08T15:54:16.76Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::OpenSearchServerless::VpcEndpoint.json b/artifacts/types/AWS::OpenSearchServerless::VpcEndpoint.json index 52175fac..84ebbc04 100644 --- a/artifacts/types/AWS::OpenSearchServerless::VpcEndpoint.json +++ b/artifacts/types/AWS::OpenSearchServerless::VpcEndpoint.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-OpenSearchServerless-VpcEndpoint", "type": "AWS::OpenSearchServerless::VpcEndpoint", - "time": "2024-01-02T18:18:08.85Z", + "time": "2024-05-08T17:10:54.841Z", "schema": { "additionalIdentifiers": [ [ diff --git a/artifacts/types/AWS::OpenSearchService::Domain.json b/artifacts/types/AWS::OpenSearchService::Domain.json index 61c64a48..6a8fe81b 100644 --- a/artifacts/types/AWS::OpenSearchService::Domain.json +++ b/artifacts/types/AWS::OpenSearchService::Domain.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-OpenSearchService-Domain", "type": "AWS::OpenSearchService::Domain", - "time": "2023-12-21T03:41:36.56Z", + "time": "2024-06-05T03:41:23.926Z", "schema": { "additionalProperties": false, "conditionalCreateOnlyProperties": [ @@ -39,6 +39,9 @@ "ClusterConfig": { "additionalProperties": false, "properties": { + "ColdStorageOptions": { + "$ref": "#/definitions/ColdStorageOptions" + }, "DedicatedMasterCount": { "type": "integer" }, @@ -93,6 +96,15 @@ }, "type": "object" }, + "ColdStorageOptions": { + "additionalProperties": false, + "properties": { + "Enabled": { + "type": "boolean" + } + }, + "type": "object" + }, "DomainEndpointOptions": { "additionalProperties": false, "properties": { @@ -401,7 +413,7 @@ "es:ListTags", "es:DescribeDomainChangeProgress" ], - "timeoutInMinutes": 780 + "timeoutInMinutes": 2160 } }, "primaryIdentifier": [ diff --git a/artifacts/types/AWS::OpsWorksCM::Server.json b/artifacts/types/AWS::OpsWorksCM::Server.json index bc7957ac..8e8ed5ce 100644 --- a/artifacts/types/AWS::OpsWorksCM::Server.json +++ b/artifacts/types/AWS::OpsWorksCM::Server.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-OpsWorksCM-Server", "type": "AWS::OpsWorksCM::Server", - "time": "2023-10-05T18:10:46.562Z", + "time": "2024-06-11T18:11:00.866Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Organizations::Account.json b/artifacts/types/AWS::Organizations::Account.json index 3323f780..64222a43 100644 --- a/artifacts/types/AWS::Organizations::Account.json +++ b/artifacts/types/AWS::Organizations::Account.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Organizations-Account", "type": "AWS::Organizations::Account", - "time": "2023-12-12T16:38:59.533Z", + "time": "2024-05-15T15:34:55.205Z", "schema": { "additionalProperties": false, "definitions": { diff --git a/artifacts/types/AWS::Organizations::Organization.json b/artifacts/types/AWS::Organizations::Organization.json index c165290d..54bd8e25 100644 --- a/artifacts/types/AWS::Organizations::Organization.json +++ b/artifacts/types/AWS::Organizations::Organization.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Organizations-Organization", "type": "AWS::Organizations::Organization", - "time": "2023-12-12T16:44:22.92Z", + "time": "2024-05-15T15:38:28.775Z", "schema": { "additionalProperties": false, "description": "Resource schema for AWS::Organizations::Organization", diff --git a/artifacts/types/AWS::Organizations::OrganizationalUnit.json b/artifacts/types/AWS::Organizations::OrganizationalUnit.json index 92e7dc09..a4569faa 100644 --- a/artifacts/types/AWS::Organizations::OrganizationalUnit.json +++ b/artifacts/types/AWS::Organizations::OrganizationalUnit.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Organizations-OrganizationalUnit", "type": "AWS::Organizations::OrganizationalUnit", - "time": "2023-12-12T17:06:03.76Z", + "time": "2024-05-15T16:01:21.371Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Organizations::Policy.json b/artifacts/types/AWS::Organizations::Policy.json index 568518e2..7e9632ef 100644 --- a/artifacts/types/AWS::Organizations::Policy.json +++ b/artifacts/types/AWS::Organizations::Policy.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Organizations-Policy", "type": "AWS::Organizations::Policy", - "time": "2023-12-12T16:56:13.004Z", + "time": "2024-05-15T15:50:31.592Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Organizations::ResourcePolicy.json b/artifacts/types/AWS::Organizations::ResourcePolicy.json index 5dc3db31..cefe12d6 100644 --- a/artifacts/types/AWS::Organizations::ResourcePolicy.json +++ b/artifacts/types/AWS::Organizations::ResourcePolicy.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Organizations-ResourcePolicy", "type": "AWS::Organizations::ResourcePolicy", - "time": "2023-12-12T16:42:44.251Z", + "time": "2024-05-15T15:38:39.86Z", "schema": { "additionalProperties": false, "definitions": { diff --git a/artifacts/types/AWS::PCAConnectorAD::Connector.json b/artifacts/types/AWS::PCAConnectorAD::Connector.json index 2a7440ac..2f8b0ebe 100644 --- a/artifacts/types/AWS::PCAConnectorAD::Connector.json +++ b/artifacts/types/AWS::PCAConnectorAD::Connector.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-PCAConnectorAD-Connector", "type": "AWS::PCAConnectorAD::Connector", - "time": "2023-12-15T15:10:06.951Z", + "time": "2024-06-24T13:46:14.16Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::PCAConnectorAD::DirectoryRegistration.json b/artifacts/types/AWS::PCAConnectorAD::DirectoryRegistration.json index af764cd9..e8951337 100644 --- a/artifacts/types/AWS::PCAConnectorAD::DirectoryRegistration.json +++ b/artifacts/types/AWS::PCAConnectorAD::DirectoryRegistration.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-PCAConnectorAD-DirectoryRegistration", "type": "AWS::PCAConnectorAD::DirectoryRegistration", - "time": "2023-12-15T14:28:03.78Z", + "time": "2024-06-24T13:23:00.327Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::PCAConnectorAD::Template.json b/artifacts/types/AWS::PCAConnectorAD::Template.json index ef294549..6f77d05d 100644 --- a/artifacts/types/AWS::PCAConnectorAD::Template.json +++ b/artifacts/types/AWS::PCAConnectorAD::Template.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-PCAConnectorAD-Template", "type": "AWS::PCAConnectorAD::Template", - "time": "2023-12-15T15:16:04.831Z", + "time": "2024-06-24T13:51:52.037Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::PCAConnectorAD::TemplateGroupAccessControlEntry.json b/artifacts/types/AWS::PCAConnectorAD::TemplateGroupAccessControlEntry.json index 63ebe7d3..07f0dd45 100644 --- a/artifacts/types/AWS::PCAConnectorAD::TemplateGroupAccessControlEntry.json +++ b/artifacts/types/AWS::PCAConnectorAD::TemplateGroupAccessControlEntry.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-PCAConnectorAD-TemplateGroupAccessControlEntry", "type": "AWS::PCAConnectorAD::TemplateGroupAccessControlEntry", - "time": "2023-12-15T15:19:12.481Z", + "time": "2024-06-24T13:54:42.935Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Panorama::ApplicationInstance.json b/artifacts/types/AWS::Panorama::ApplicationInstance.json index 846918e7..eab06187 100644 --- a/artifacts/types/AWS::Panorama::ApplicationInstance.json +++ b/artifacts/types/AWS::Panorama::ApplicationInstance.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Panorama-ApplicationInstance", "type": "AWS::Panorama::ApplicationInstance", - "time": "2024-01-04T17:53:31.909Z", + "time": "2024-06-11T16:27:47.588Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Panorama::Package.json b/artifacts/types/AWS::Panorama::Package.json index bed9bf26..51af2d10 100644 --- a/artifacts/types/AWS::Panorama::Package.json +++ b/artifacts/types/AWS::Panorama::Package.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Panorama-Package", "type": "AWS::Panorama::Package", - "time": "2024-01-04T16:25:55.886Z", + "time": "2024-06-11T15:22:49.918Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Panorama::PackageVersion.json b/artifacts/types/AWS::Panorama::PackageVersion.json index a79e8d2f..6ca08a0e 100644 --- a/artifacts/types/AWS::Panorama::PackageVersion.json +++ b/artifacts/types/AWS::Panorama::PackageVersion.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Panorama-PackageVersion", "type": "AWS::Panorama::PackageVersion", - "time": "2024-01-04T16:24:39.734Z", + "time": "2024-06-11T15:22:47.251Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::PaymentCryptography::Alias.json b/artifacts/types/AWS::PaymentCryptography::Alias.json new file mode 100644 index 00000000..25fe9403 --- /dev/null +++ b/artifacts/types/AWS::PaymentCryptography::Alias.json @@ -0,0 +1,63 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-PaymentCryptography-Alias", + "type": "AWS::PaymentCryptography::Alias", + "time": "2024-06-19T12:57:02.104Z", + "schema": { + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/AliasName" + ], + "description": "Definition of AWS::PaymentCryptography::Alias Resource Type", + "handlers": { + "create": { + "permissions": [ + "payment-cryptography:CreateAlias" + ] + }, + "delete": { + "permissions": [ + "payment-cryptography:DeleteAlias" + ] + }, + "list": { + "permissions": [ + "payment-cryptography:ListAliases" + ] + }, + "read": { + "permissions": [ + "payment-cryptography:GetAlias" + ] + }, + "update": { + "permissions": [ + "payment-cryptography:UpdateAlias" + ] + } + }, + "primaryIdentifier": [ + "/properties/AliasName" + ], + "properties": { + "AliasName": { + "maxLength": 256, + "minLength": 7, + "pattern": "^alias/[a-zA-Z0-9/_-]+$", + "type": "string" + }, + "KeyArn": { + "maxLength": 150, + "minLength": 70, + "pattern": "^arn:aws:payment-cryptography:[a-z]{2}-[a-z]{1,16}-[0-9]+:[0-9]{12}:key/[0-9a-zA-Z]{16,64}$", + "type": "string" + } + }, + "required": [ + "AliasName" + ], + "tagging": { + "taggable": false + }, + "typeName": "AWS::PaymentCryptography::Alias" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::PaymentCryptography::Key.json b/artifacts/types/AWS::PaymentCryptography::Key.json new file mode 100644 index 00000000..2aed9f88 --- /dev/null +++ b/artifacts/types/AWS::PaymentCryptography::Key.json @@ -0,0 +1,262 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-PaymentCryptography-Key", + "type": "AWS::PaymentCryptography::Key", + "time": "2024-06-19T12:43:34.019Z", + "schema": { + "additionalProperties": false, + "definitions": { + "KeyAlgorithm": { + "enum": [ + "TDES_2KEY", + "TDES_3KEY", + "AES_128", + "AES_192", + "AES_256", + "RSA_2048", + "RSA_3072", + "RSA_4096" + ], + "type": "string" + }, + "KeyAttributes": { + "additionalProperties": false, + "properties": { + "KeyAlgorithm": { + "$ref": "#/definitions/KeyAlgorithm" + }, + "KeyClass": { + "$ref": "#/definitions/KeyClass" + }, + "KeyModesOfUse": { + "$ref": "#/definitions/KeyModesOfUse" + }, + "KeyUsage": { + "$ref": "#/definitions/KeyUsage" + } + }, + "required": [ + "KeyAlgorithm", + "KeyClass", + "KeyModesOfUse", + "KeyUsage" + ], + "type": "object" + }, + "KeyCheckValueAlgorithm": { + "enum": [ + "CMAC", + "ANSI_X9_24" + ], + "type": "string" + }, + "KeyClass": { + "enum": [ + "SYMMETRIC_KEY", + "ASYMMETRIC_KEY_PAIR", + "PRIVATE_KEY", + "PUBLIC_KEY" + ], + "type": "string" + }, + "KeyModesOfUse": { + "additionalProperties": false, + "properties": { + "Decrypt": { + "default": false, + "type": "boolean" + }, + "DeriveKey": { + "default": false, + "type": "boolean" + }, + "Encrypt": { + "default": false, + "type": "boolean" + }, + "Generate": { + "default": false, + "type": "boolean" + }, + "NoRestrictions": { + "default": false, + "type": "boolean" + }, + "Sign": { + "default": false, + "type": "boolean" + }, + "Unwrap": { + "default": false, + "type": "boolean" + }, + "Verify": { + "default": false, + "type": "boolean" + }, + "Wrap": { + "default": false, + "type": "boolean" + } + }, + "type": "object" + }, + "KeyOrigin": { + "description": "Defines the source of a key", + "enum": [ + "EXTERNAL", + "AWS_PAYMENT_CRYPTOGRAPHY" + ], + "type": "string" + }, + "KeyState": { + "description": "Defines the state of a key", + "enum": [ + "CREATE_IN_PROGRESS", + "CREATE_COMPLETE", + "DELETE_PENDING", + "DELETE_COMPLETE" + ], + "type": "string" + }, + "KeyUsage": { + "enum": [ + "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_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" + ], + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key" + ], + "type": "object" + } + }, + "description": "Definition of AWS::PaymentCryptography::Key Resource Type", + "handlers": { + "create": { + "permissions": [ + "payment-cryptography:GetKey", + "payment-cryptography:CreateKey", + "payment-cryptography:TagResource" + ] + }, + "delete": { + "permissions": [ + "payment-cryptography:GetKey", + "payment-cryptography:DeleteKey" + ] + }, + "list": { + "permissions": [ + "payment-cryptography:ListKeys" + ] + }, + "read": { + "permissions": [ + "payment-cryptography:GetKey", + "payment-cryptography:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "payment-cryptography:GetKey", + "payment-cryptography:ListTagsForResource", + "payment-cryptography:TagResource", + "payment-cryptography:UntagResource", + "payment-cryptography:StartKeyUsage", + "payment-cryptography:StopKeyUsage" + ] + } + }, + "primaryIdentifier": [ + "/properties/KeyIdentifier" + ], + "properties": { + "Enabled": { + "type": "boolean" + }, + "Exportable": { + "type": "boolean" + }, + "KeyAttributes": { + "$ref": "#/definitions/KeyAttributes" + }, + "KeyCheckValueAlgorithm": { + "$ref": "#/definitions/KeyCheckValueAlgorithm" + }, + "KeyIdentifier": { + "maxLength": 322, + "minLength": 7, + "pattern": "^arn:aws:payment-cryptography:[a-z]{2}-[a-z]{1,16}-[0-9]+:[0-9]{12}:(key/[0-9a-zA-Z]{16,64}|alias/[a-zA-Z0-9/_-]+)$|^alias/[a-zA-Z0-9/_-]+$", + "type": "string" + }, + "KeyOrigin": { + "$ref": "#/definitions/KeyOrigin" + }, + "KeyState": { + "$ref": "#/definitions/KeyState" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/KeyIdentifier", + "/properties/KeyOrigin", + "/properties/KeyState" + ], + "required": [ + "Exportable", + "KeyAttributes" + ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::PaymentCryptography::Key" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::Personalize::Dataset.json b/artifacts/types/AWS::Personalize::Dataset.json index bf3b0322..76a17dd1 100644 --- a/artifacts/types/AWS::Personalize::Dataset.json +++ b/artifacts/types/AWS::Personalize::Dataset.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Personalize-Dataset", "type": "AWS::Personalize::Dataset", - "time": "2023-12-18T18:28:17.287Z", + "time": "2024-06-17T22:10:46.012Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Pinpoint::InAppTemplate.json b/artifacts/types/AWS::Pinpoint::InAppTemplate.json index 7166efea..c9d5be9f 100644 --- a/artifacts/types/AWS::Pinpoint::InAppTemplate.json +++ b/artifacts/types/AWS::Pinpoint::InAppTemplate.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Pinpoint-InAppTemplate", "type": "AWS::Pinpoint::InAppTemplate", - "time": "2024-01-03T23:35:22.507Z", + "time": "2024-06-06T21:19:19.729Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Pipes::Pipe.json b/artifacts/types/AWS::Pipes::Pipe.json index c64ba1c1..3ab28f44 100644 --- a/artifacts/types/AWS::Pipes::Pipe.json +++ b/artifacts/types/AWS::Pipes::Pipe.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Pipes-Pipe", "type": "AWS::Pipes::Pipe", - "time": "2023-12-12T05:33:21.381Z", + "time": "2024-06-05T08:51:16.837Z", "schema": { "additionalIdentifiers": [ [ @@ -233,6 +233,36 @@ }, "type": "object" }, + "DimensionMapping": { + "additionalProperties": false, + "properties": { + "DimensionName": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "DimensionValue": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "DimensionValueType": { + "$ref": "#/definitions/DimensionValueType" + } + }, + "required": [ + "DimensionName", + "DimensionValue", + "DimensionValueType" + ], + "type": "object" + }, + "DimensionValueType": { + "enum": [ + "VARCHAR" + ], + "type": "string" + }, "DynamoDBStreamStartPosition": { "enum": [ "TRIM_HORIZON", @@ -405,6 +435,15 @@ }, "type": "object" }, + "EpochTimeUnit": { + "enum": [ + "MILLISECONDS", + "SECONDS", + "MICROSECONDS", + "NANOSECONDS" + ], + "type": "string" + }, "Filter": { "additionalProperties": false, "properties": { @@ -551,6 +590,63 @@ ], "type": "string" }, + "MeasureValueType": { + "enum": [ + "DOUBLE", + "BIGINT", + "VARCHAR", + "BOOLEAN", + "TIMESTAMP" + ], + "type": "string" + }, + "MultiMeasureAttributeMapping": { + "additionalProperties": false, + "properties": { + "MeasureValue": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "MeasureValueType": { + "$ref": "#/definitions/MeasureValueType" + }, + "MultiMeasureAttributeName": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "MeasureValue", + "MeasureValueType", + "MultiMeasureAttributeName" + ], + "type": "object" + }, + "MultiMeasureMapping": { + "additionalProperties": false, + "properties": { + "MultiMeasureAttributeMappings": { + "items": { + "$ref": "#/definitions/MultiMeasureAttributeMapping" + }, + "maxItems": 256, + "minItems": 1, + "type": "array" + }, + "MultiMeasureName": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "MultiMeasureAttributeMappings", + "MultiMeasureName" + ], + "type": "object" + }, "NetworkConfiguration": { "additionalProperties": false, "properties": { @@ -1201,6 +1297,9 @@ }, "StepFunctionStateMachineParameters": { "$ref": "#/definitions/PipeTargetStateMachineParameters" + }, + "TimestreamParameters": { + "$ref": "#/definitions/PipeTargetTimestreamParameters" } }, "type": "object" @@ -1295,6 +1394,62 @@ }, "type": "object" }, + "PipeTargetTimestreamParameters": { + "additionalProperties": false, + "properties": { + "DimensionMappings": { + "items": { + "$ref": "#/definitions/DimensionMapping" + }, + "maxItems": 128, + "minItems": 1, + "type": "array" + }, + "EpochTimeUnit": { + "$ref": "#/definitions/EpochTimeUnit" + }, + "MultiMeasureMappings": { + "items": { + "$ref": "#/definitions/MultiMeasureMapping" + }, + "maxItems": 1024, + "minItems": 0, + "type": "array" + }, + "SingleMeasureMappings": { + "items": { + "$ref": "#/definitions/SingleMeasureMapping" + }, + "maxItems": 8192, + "minItems": 0, + "type": "array" + }, + "TimeFieldType": { + "$ref": "#/definitions/TimeFieldType" + }, + "TimeValue": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "TimestampFormat": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "VersionValue": { + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "DimensionMappings", + "TimeValue", + "VersionValue" + ], + "type": "object" + }, "PlacementConstraint": { "additionalProperties": false, "properties": { @@ -1519,6 +1674,30 @@ ], "type": "string" }, + "SingleMeasureMapping": { + "additionalProperties": false, + "properties": { + "MeasureName": { + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "MeasureValue": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "MeasureValueType": { + "$ref": "#/definitions/MeasureValueType" + } + }, + "required": [ + "MeasureName", + "MeasureValue", + "MeasureValueType" + ], + "type": "object" + }, "Tag": { "additionalProperties": false, "properties": { @@ -1551,6 +1730,13 @@ } }, "type": "object" + }, + "TimeFieldType": { + "enum": [ + "EPOCH", + "TIMESTAMP_FORMAT" + ], + "type": "string" } }, "description": "Definition of AWS::Pipes::Pipe Resource Type", diff --git a/artifacts/types/AWS::Proton::EnvironmentAccountConnection.json b/artifacts/types/AWS::Proton::EnvironmentAccountConnection.json index 73d4db1a..ec1d10a7 100644 --- a/artifacts/types/AWS::Proton::EnvironmentAccountConnection.json +++ b/artifacts/types/AWS::Proton::EnvironmentAccountConnection.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Proton-EnvironmentAccountConnection", "type": "AWS::Proton::EnvironmentAccountConnection", - "time": "2023-12-26T14:59:26.751Z", + "time": "2024-02-13T14:23:44.84Z", "schema": { "additionalIdentifiers": [ [ diff --git a/artifacts/types/AWS::Proton::EnvironmentTemplate.json b/artifacts/types/AWS::Proton::EnvironmentTemplate.json index 0e1473fb..b62fc2da 100644 --- a/artifacts/types/AWS::Proton::EnvironmentTemplate.json +++ b/artifacts/types/AWS::Proton::EnvironmentTemplate.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Proton-EnvironmentTemplate", "type": "AWS::Proton::EnvironmentTemplate", - "time": "2023-12-26T15:00:28.499Z", + "time": "2024-02-13T14:22:40.795Z", "schema": { "additionalIdentifiers": [ [ diff --git a/artifacts/types/AWS::Proton::ServiceTemplate.json b/artifacts/types/AWS::Proton::ServiceTemplate.json index 38ff9ef7..cf8921df 100644 --- a/artifacts/types/AWS::Proton::ServiceTemplate.json +++ b/artifacts/types/AWS::Proton::ServiceTemplate.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Proton-ServiceTemplate", "type": "AWS::Proton::ServiceTemplate", - "time": "2023-12-26T15:00:26.245Z", + "time": "2024-02-13T14:22:35.138Z", "schema": { "additionalIdentifiers": [ [ diff --git a/artifacts/types/AWS::QBusiness::Application.json b/artifacts/types/AWS::QBusiness::Application.json new file mode 100644 index 00000000..d11f87c3 --- /dev/null +++ b/artifacts/types/AWS::QBusiness::Application.json @@ -0,0 +1,217 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-QBusiness-Application", + "type": "AWS::QBusiness::Application", + "time": "2024-06-18T15:57:54.092Z", + "schema": { + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/EncryptionConfiguration" + ], + "definitions": { + "ApplicationStatus": { + "enum": [ + "CREATING", + "ACTIVE", + "DELETING", + "FAILED", + "UPDATING" + ], + "type": "string" + }, + "AttachmentsConfiguration": { + "additionalProperties": false, + "properties": { + "AttachmentsControlMode": { + "$ref": "#/definitions/AttachmentsControlMode" + } + }, + "required": [ + "AttachmentsControlMode" + ], + "type": "object" + }, + "AttachmentsControlMode": { + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + }, + "EncryptionConfiguration": { + "additionalProperties": false, + "properties": { + "KmsKeyId": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Definition of AWS::QBusiness::Application Resource Type", + "handlers": { + "create": { + "permissions": [ + "iam:PassRole", + "kms:CreateGrant", + "kms:DescribeKey", + "qbusiness:CreateApplication", + "qbusiness:GetApplication", + "qbusiness:ListTagsForResource", + "qbusiness:TagResource", + "sso:CreateApplication", + "sso:DeleteApplication", + "sso:PutApplicationAccessScope", + "sso:PutApplicationAuthenticationMethod", + "sso:PutApplicationGrant" + ] + }, + "delete": { + "permissions": [ + "kms:RetireGrant", + "qbusiness:DeleteApplication", + "qbusiness:GetApplication", + "sso:DeleteApplication" + ] + }, + "list": { + "permissions": [ + "qbusiness:ListApplications" + ] + }, + "read": { + "permissions": [ + "qbusiness:GetApplication", + "qbusiness:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iam:PassRole", + "qbusiness:GetApplication", + "qbusiness:ListTagsForResource", + "qbusiness:TagResource", + "qbusiness:UntagResource", + "qbusiness:UpdateApplication", + "sso:CreateApplication", + "sso:DeleteApplication", + "sso:PutApplicationAccessScope", + "sso:PutApplicationAuthenticationMethod", + "sso:PutApplicationGrant" + ] + } + }, + "primaryIdentifier": [ + "/properties/ApplicationId" + ], + "properties": { + "ApplicationArn": { + "maxLength": 1284, + "minLength": 0, + "pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$", + "type": "string" + }, + "ApplicationId": { + "maxLength": 36, + "minLength": 36, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{35}$", + "type": "string" + }, + "AttachmentsConfiguration": { + "$ref": "#/definitions/AttachmentsConfiguration" + }, + "CreatedAt": { + "format": "date-time", + "type": "string" + }, + "Description": { + "maxLength": 1000, + "minLength": 0, + "pattern": "^[\\s\\S]*$", + "type": "string" + }, + "DisplayName": { + "maxLength": 1000, + "minLength": 1, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", + "type": "string" + }, + "EncryptionConfiguration": { + "$ref": "#/definitions/EncryptionConfiguration" + }, + "IdentityCenterApplicationArn": { + "maxLength": 1224, + "minLength": 10, + "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}$", + "type": "string" + }, + "IdentityCenterInstanceArn": { + "maxLength": 1224, + "minLength": 10, + "pattern": "^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}$", + "type": "string" + }, + "RoleArn": { + "maxLength": 1284, + "minLength": 0, + "pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$", + "type": "string" + }, + "Status": { + "$ref": "#/definitions/ApplicationStatus" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "UpdatedAt": { + "format": "date-time", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/ApplicationArn", + "/properties/ApplicationId", + "/properties/CreatedAt", + "/properties/IdentityCenterApplicationArn", + "/properties/Status", + "/properties/UpdatedAt" + ], + "required": [ + "DisplayName" + ], + "tagging": { + "taggable": true + }, + "typeName": "AWS::QBusiness::Application", + "writeOnlyProperties": [ + "/properties/IdentityCenterInstanceArn" + ] + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::QBusiness::DataSource.json b/artifacts/types/AWS::QBusiness::DataSource.json new file mode 100644 index 00000000..45bad975 --- /dev/null +++ b/artifacts/types/AWS::QBusiness::DataSource.json @@ -0,0 +1,433 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-QBusiness-DataSource", + "type": "AWS::QBusiness::DataSource", + "time": "2024-06-18T21:55:07.144Z", + "schema": { + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ApplicationId", + "/properties/IndexId" + ], + "definitions": { + "AttributeValueOperator": { + "enum": [ + "DELETE" + ], + "type": "string" + }, + "DataSourceStatus": { + "enum": [ + "PENDING_CREATION", + "CREATING", + "ACTIVE", + "DELETING", + "FAILED", + "UPDATING" + ], + "type": "string" + }, + "DataSourceVpcConfiguration": { + "additionalProperties": false, + "properties": { + "SecurityGroupIds": { + "insertionOrder": false, + "items": { + "maxLength": 200, + "minLength": 1, + "pattern": "^[-0-9a-zA-Z]+$", + "type": "string" + }, + "maxItems": 10, + "minItems": 1, + "type": "array" + }, + "SubnetIds": { + "insertionOrder": false, + "items": { + "maxLength": 200, + "minLength": 1, + "pattern": "^[-0-9a-zA-Z]+$", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "SecurityGroupIds", + "SubnetIds" + ], + "type": "object" + }, + "DocumentAttributeCondition": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 200, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_][a-zA-Z0-9_-]*$", + "type": "string" + }, + "Operator": { + "$ref": "#/definitions/DocumentEnrichmentConditionOperator" + }, + "Value": { + "$ref": "#/definitions/DocumentAttributeValue" + } + }, + "required": [ + "Key", + "Operator" + ], + "type": "object" + }, + "DocumentAttributeTarget": { + "additionalProperties": false, + "properties": { + "AttributeValueOperator": { + "$ref": "#/definitions/AttributeValueOperator" + }, + "Key": { + "maxLength": 200, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_][a-zA-Z0-9_-]*$", + "type": "string" + }, + "Value": { + "$ref": "#/definitions/DocumentAttributeValue" + } + }, + "required": [ + "Key" + ], + "type": "object" + }, + "DocumentAttributeValue": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "StringValue": { + "maxLength": 2048, + "type": "string" + } + }, + "required": [ + "StringValue" + ], + "title": "StringValue", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "StringListValue": { + "insertionOrder": true, + "items": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "StringListValue" + ], + "title": "StringListValue", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "LongValue": { + "type": "number" + } + }, + "required": [ + "LongValue" + ], + "title": "LongValue", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "DateValue": { + "format": "date-time", + "type": "string" + } + }, + "required": [ + "DateValue" + ], + "title": "DateValue", + "type": "object" + } + ] + }, + "DocumentContentOperator": { + "enum": [ + "DELETE" + ], + "type": "string" + }, + "DocumentEnrichmentConditionOperator": { + "enum": [ + "GREATER_THAN", + "GREATER_THAN_OR_EQUALS", + "LESS_THAN", + "LESS_THAN_OR_EQUALS", + "EQUALS", + "NOT_EQUALS", + "CONTAINS", + "NOT_CONTAINS", + "EXISTS", + "NOT_EXISTS", + "BEGINS_WITH" + ], + "type": "string" + }, + "DocumentEnrichmentConfiguration": { + "additionalProperties": false, + "properties": { + "InlineConfigurations": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/InlineDocumentEnrichmentConfiguration" + }, + "maxItems": 100, + "minItems": 1, + "type": "array" + }, + "PostExtractionHookConfiguration": { + "$ref": "#/definitions/HookConfiguration" + }, + "PreExtractionHookConfiguration": { + "$ref": "#/definitions/HookConfiguration" + } + }, + "type": "object" + }, + "HookConfiguration": { + "additionalProperties": false, + "properties": { + "InvocationCondition": { + "$ref": "#/definitions/DocumentAttributeCondition" + }, + "LambdaArn": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^arn:aws[a-zA-Z-]*:lambda:[a-z-]*-[0-9]:[0-9]{12}:function:[a-zA-Z0-9-_]+(/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})?(:[a-zA-Z0-9-_]+)?$", + "type": "string" + }, + "RoleArn": { + "maxLength": 1284, + "minLength": 0, + "pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$", + "type": "string" + }, + "S3BucketName": { + "maxLength": 63, + "minLength": 1, + "pattern": "^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$", + "type": "string" + } + }, + "type": "object" + }, + "InlineDocumentEnrichmentConfiguration": { + "additionalProperties": false, + "properties": { + "Condition": { + "$ref": "#/definitions/DocumentAttributeCondition" + }, + "DocumentContentOperator": { + "$ref": "#/definitions/DocumentContentOperator" + }, + "Target": { + "$ref": "#/definitions/DocumentAttributeTarget" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Definition of AWS::QBusiness::DataSource Resource Type", + "handlers": { + "create": { + "permissions": [ + "iam:PassRole", + "qbusiness:CreateDataSource", + "qbusiness:GetDataSource", + "qbusiness:ListTagsForResource", + "qbusiness:TagResource" + ] + }, + "delete": { + "permissions": [ + "qbusiness:DeleteDataSource", + "qbusiness:GetDataSource" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "ApplicationId": { + "$ref": "resource-schema.json#/properties/ApplicationId" + }, + "IndexId": { + "$ref": "resource-schema.json#/properties/IndexId" + } + }, + "required": [ + "IndexId", + "ApplicationId" + ] + }, + "permissions": [ + "qbusiness:ListDataSources" + ] + }, + "read": { + "permissions": [ + "qbusiness:GetDataSource", + "qbusiness:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iam:PassRole", + "qbusiness:GetDataSource", + "qbusiness:ListTagsForResource", + "qbusiness:TagResource", + "qbusiness:UntagResource", + "qbusiness:UpdateDataSource" + ] + } + }, + "primaryIdentifier": [ + "/properties/ApplicationId", + "/properties/DataSourceId", + "/properties/IndexId" + ], + "properties": { + "ApplicationId": { + "maxLength": 36, + "minLength": 36, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{35}$", + "type": "string" + }, + "Configuration": {}, + "CreatedAt": { + "format": "date-time", + "type": "string" + }, + "DataSourceArn": { + "maxLength": 1284, + "minLength": 0, + "pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$", + "type": "string" + }, + "DataSourceId": { + "maxLength": 36, + "minLength": 36, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{35}$", + "type": "string" + }, + "Description": { + "maxLength": 1000, + "minLength": 0, + "pattern": "^[\\s\\S]*$", + "type": "string" + }, + "DisplayName": { + "maxLength": 1000, + "minLength": 1, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", + "type": "string" + }, + "DocumentEnrichmentConfiguration": { + "$ref": "#/definitions/DocumentEnrichmentConfiguration" + }, + "IndexId": { + "maxLength": 36, + "minLength": 36, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{35}$", + "type": "string" + }, + "RoleArn": { + "maxLength": 1284, + "minLength": 0, + "pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$", + "type": "string" + }, + "Status": { + "$ref": "#/definitions/DataSourceStatus" + }, + "SyncSchedule": { + "maxLength": 998, + "pattern": "^[\\s\\S]*$", + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Type": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "UpdatedAt": { + "format": "date-time", + "type": "string" + }, + "VpcConfiguration": { + "$ref": "#/definitions/DataSourceVpcConfiguration" + } + }, + "readOnlyProperties": [ + "/properties/CreatedAt", + "/properties/DataSourceArn", + "/properties/DataSourceId", + "/properties/Status", + "/properties/Type", + "/properties/UpdatedAt" + ], + "required": [ + "ApplicationId", + "IndexId", + "Configuration", + "DisplayName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-qbusiness", + "tagging": { + "taggable": true + }, + "typeName": "AWS::QBusiness::DataSource" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::QBusiness::Index.json b/artifacts/types/AWS::QBusiness::Index.json new file mode 100644 index 00000000..c252a85e --- /dev/null +++ b/artifacts/types/AWS::QBusiness::Index.json @@ -0,0 +1,257 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-QBusiness-Index", + "type": "AWS::QBusiness::Index", + "time": "2024-06-18T17:06:01.168Z", + "schema": { + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ApplicationId", + "/properties/Type" + ], + "definitions": { + "AttributeType": { + "enum": [ + "STRING", + "STRING_LIST", + "NUMBER", + "DATE" + ], + "type": "string" + }, + "DocumentAttributeConfiguration": { + "additionalProperties": false, + "properties": { + "Name": { + "maxLength": 30, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_][a-zA-Z0-9_-]*$", + "type": "string" + }, + "Search": { + "$ref": "#/definitions/Status" + }, + "Type": { + "$ref": "#/definitions/AttributeType" + } + }, + "type": "object" + }, + "IndexCapacityConfiguration": { + "additionalProperties": false, + "properties": { + "Units": { + "minimum": 1, + "type": "number" + } + }, + "type": "object" + }, + "IndexStatistics": { + "additionalProperties": false, + "properties": { + "TextDocumentStatistics": { + "$ref": "#/definitions/TextDocumentStatistics" + } + }, + "type": "object" + }, + "IndexStatus": { + "enum": [ + "CREATING", + "ACTIVE", + "DELETING", + "FAILED", + "UPDATING" + ], + "type": "string" + }, + "IndexType": { + "enum": [ + "ENTERPRISE", + "STARTER" + ], + "type": "string" + }, + "Status": { + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "TextDocumentStatistics": { + "additionalProperties": false, + "properties": { + "IndexedTextBytes": { + "minimum": 0, + "type": "number" + }, + "IndexedTextDocumentCount": { + "minimum": 0, + "type": "number" + } + }, + "type": "object" + } + }, + "description": "Definition of AWS::QBusiness::Index Resource Type", + "handlers": { + "create": { + "permissions": [ + "qbusiness:CreateIndex", + "qbusiness:GetIndex", + "qbusiness:ListTagsForResource", + "qbusiness:TagResource", + "qbusiness:UpdateIndex" + ] + }, + "delete": { + "permissions": [ + "qbusiness:DeleteIndex", + "qbusiness:GetIndex" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "ApplicationId": { + "$ref": "resource-schema.json#/properties/ApplicationId" + } + }, + "required": [ + "ApplicationId" + ] + }, + "permissions": [ + "qbusiness:ListIndices" + ] + }, + "read": { + "permissions": [ + "qbusiness:GetIndex", + "qbusiness:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "qbusiness:GetIndex", + "qbusiness:ListTagsForResource", + "qbusiness:TagResource", + "qbusiness:UntagResource", + "qbusiness:UpdateIndex" + ] + } + }, + "primaryIdentifier": [ + "/properties/ApplicationId", + "/properties/IndexId" + ], + "properties": { + "ApplicationId": { + "maxLength": 36, + "minLength": 36, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{35}$", + "type": "string" + }, + "CapacityConfiguration": { + "$ref": "#/definitions/IndexCapacityConfiguration" + }, + "CreatedAt": { + "format": "date-time", + "type": "string" + }, + "Description": { + "maxLength": 1000, + "minLength": 0, + "pattern": "^[\\s\\S]*$", + "type": "string" + }, + "DisplayName": { + "maxLength": 1000, + "minLength": 1, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", + "type": "string" + }, + "DocumentAttributeConfigurations": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/DocumentAttributeConfiguration" + }, + "maxItems": 500, + "minItems": 1, + "type": "array" + }, + "IndexArn": { + "maxLength": 1284, + "minLength": 0, + "pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$", + "type": "string" + }, + "IndexId": { + "maxLength": 36, + "minLength": 36, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{35}$", + "type": "string" + }, + "IndexStatistics": { + "$ref": "#/definitions/IndexStatistics" + }, + "Status": { + "$ref": "#/definitions/IndexStatus" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Type": { + "$ref": "#/definitions/IndexType" + }, + "UpdatedAt": { + "format": "date-time", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/CreatedAt", + "/properties/IndexArn", + "/properties/IndexId", + "/properties/IndexStatistics", + "/properties/Status", + "/properties/UpdatedAt" + ], + "required": [ + "ApplicationId", + "DisplayName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-qbusiness", + "tagging": { + "taggable": true + }, + "typeName": "AWS::QBusiness::Index" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::QBusiness::Plugin.json b/artifacts/types/AWS::QBusiness::Plugin.json new file mode 100644 index 00000000..d22f663f --- /dev/null +++ b/artifacts/types/AWS::QBusiness::Plugin.json @@ -0,0 +1,369 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-QBusiness-Plugin", + "type": "AWS::QBusiness::Plugin", + "time": "2024-06-18T16:27:34.039Z", + "schema": { + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ApplicationId", + "/properties/Type" + ], + "definitions": { + "APISchema": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "Payload": { + "type": "string" + } + }, + "required": [ + "Payload" + ], + "title": "Payload", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "S3": { + "$ref": "#/definitions/S3" + } + }, + "required": [ + "S3" + ], + "title": "S3", + "type": "object" + } + ] + }, + "APISchemaType": { + "enum": [ + "OPEN_API_V3" + ], + "type": "string" + }, + "BasicAuthConfiguration": { + "additionalProperties": false, + "properties": { + "RoleArn": { + "maxLength": 1284, + "minLength": 0, + "pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$", + "type": "string" + }, + "SecretArn": { + "maxLength": 1284, + "minLength": 0, + "pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$", + "type": "string" + } + }, + "required": [ + "RoleArn", + "SecretArn" + ], + "type": "object" + }, + "CustomPluginConfiguration": { + "additionalProperties": false, + "properties": { + "ApiSchema": { + "$ref": "#/definitions/APISchema" + }, + "ApiSchemaType": { + "$ref": "#/definitions/APISchemaType" + }, + "Description": { + "maxLength": 200, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "ApiSchema", + "ApiSchemaType", + "Description" + ], + "type": "object" + }, + "NoAuthConfiguration": { + "additionalProperties": false, + "type": "object" + }, + "OAuth2ClientCredentialConfiguration": { + "additionalProperties": false, + "properties": { + "RoleArn": { + "maxLength": 1284, + "minLength": 0, + "pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$", + "type": "string" + }, + "SecretArn": { + "maxLength": 1284, + "minLength": 0, + "pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$", + "type": "string" + } + }, + "required": [ + "RoleArn", + "SecretArn" + ], + "type": "object" + }, + "PluginAuthConfiguration": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "BasicAuthConfiguration": { + "$ref": "#/definitions/BasicAuthConfiguration" + } + }, + "required": [ + "BasicAuthConfiguration" + ], + "title": "BasicAuthConfiguration", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "OAuth2ClientCredentialConfiguration": { + "$ref": "#/definitions/OAuth2ClientCredentialConfiguration" + } + }, + "required": [ + "OAuth2ClientCredentialConfiguration" + ], + "title": "OAuth2ClientCredentialConfiguration", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "NoAuthConfiguration": { + "$ref": "#/definitions/NoAuthConfiguration" + } + }, + "required": [ + "NoAuthConfiguration" + ], + "title": "NoAuthConfiguration", + "type": "object" + } + ] + }, + "PluginBuildStatus": { + "enum": [ + "READY", + "CREATE_IN_PROGRESS", + "CREATE_FAILED", + "UPDATE_IN_PROGRESS", + "UPDATE_FAILED", + "DELETE_IN_PROGRESS", + "DELETE_FAILED" + ], + "type": "string" + }, + "PluginState": { + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + }, + "PluginType": { + "enum": [ + "SERVICE_NOW", + "SALESFORCE", + "JIRA", + "ZENDESK", + "CUSTOM" + ], + "type": "string" + }, + "S3": { + "additionalProperties": false, + "properties": { + "Bucket": { + "maxLength": 63, + "minLength": 1, + "pattern": "^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$", + "type": "string" + }, + "Key": { + "maxLength": 1024, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "Bucket", + "Key" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Definition of AWS::QBusiness::Plugin Resource Type", + "handlers": { + "create": { + "permissions": [ + "iam:PassRole", + "qbusiness:CreatePlugin", + "qbusiness:GetPlugin", + "qbusiness:ListTagsForResource", + "qbusiness:TagResource", + "qbusiness:UpdatePlugin" + ] + }, + "delete": { + "permissions": [ + "qbusiness:DeletePlugin", + "qbusiness:GetPlugin" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "ApplicationId": { + "$ref": "resource-schema.json#/properties/ApplicationId" + } + }, + "required": [ + "ApplicationId" + ] + }, + "permissions": [ + "qbusiness:ListPlugins" + ] + }, + "read": { + "permissions": [ + "qbusiness:GetPlugin", + "qbusiness:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iam:PassRole", + "qbusiness:GetPlugin", + "qbusiness:ListTagsForResource", + "qbusiness:TagResource", + "qbusiness:UntagResource", + "qbusiness:UpdatePlugin" + ] + } + }, + "primaryIdentifier": [ + "/properties/ApplicationId", + "/properties/PluginId" + ], + "properties": { + "ApplicationId": { + "maxLength": 36, + "minLength": 36, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{35}$", + "type": "string" + }, + "AuthConfiguration": { + "$ref": "#/definitions/PluginAuthConfiguration" + }, + "BuildStatus": { + "$ref": "#/definitions/PluginBuildStatus" + }, + "CreatedAt": { + "format": "date-time", + "type": "string" + }, + "CustomPluginConfiguration": { + "$ref": "#/definitions/CustomPluginConfiguration" + }, + "DisplayName": { + "maxLength": 100, + "minLength": 1, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", + "type": "string" + }, + "PluginArn": { + "maxLength": 1284, + "minLength": 0, + "pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$", + "type": "string" + }, + "PluginId": { + "maxLength": 36, + "minLength": 36, + "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$", + "type": "string" + }, + "ServerUrl": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^(https?|ftp|file)://([^\\s]*)$", + "type": "string" + }, + "State": { + "$ref": "#/definitions/PluginState" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Type": { + "$ref": "#/definitions/PluginType" + }, + "UpdatedAt": { + "format": "date-time", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/BuildStatus", + "/properties/CreatedAt", + "/properties/PluginArn", + "/properties/PluginId", + "/properties/UpdatedAt" + ], + "required": [ + "ApplicationId", + "AuthConfiguration", + "DisplayName", + "Type" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-qbusiness", + "tagging": { + "taggable": true + }, + "typeName": "AWS::QBusiness::Plugin" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::QBusiness::Retriever.json b/artifacts/types/AWS::QBusiness::Retriever.json new file mode 100644 index 00000000..34c4cf96 --- /dev/null +++ b/artifacts/types/AWS::QBusiness::Retriever.json @@ -0,0 +1,238 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-QBusiness-Retriever", + "type": "AWS::QBusiness::Retriever", + "time": "2024-06-18T17:31:40.915Z", + "schema": { + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ApplicationId", + "/properties/Type" + ], + "definitions": { + "KendraIndexConfiguration": { + "additionalProperties": false, + "properties": { + "IndexId": { + "maxLength": 36, + "minLength": 36, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{35}$", + "type": "string" + } + }, + "required": [ + "IndexId" + ], + "type": "object" + }, + "NativeIndexConfiguration": { + "additionalProperties": false, + "properties": { + "IndexId": { + "maxLength": 36, + "minLength": 36, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{35}$", + "type": "string" + } + }, + "required": [ + "IndexId" + ], + "type": "object" + }, + "RetrieverConfiguration": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "NativeIndexConfiguration": { + "$ref": "#/definitions/NativeIndexConfiguration" + } + }, + "required": [ + "NativeIndexConfiguration" + ], + "title": "NativeIndexConfiguration", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "KendraIndexConfiguration": { + "$ref": "#/definitions/KendraIndexConfiguration" + } + }, + "required": [ + "KendraIndexConfiguration" + ], + "title": "KendraIndexConfiguration", + "type": "object" + } + ] + }, + "RetrieverStatus": { + "enum": [ + "CREATING", + "ACTIVE", + "FAILED" + ], + "type": "string" + }, + "RetrieverType": { + "enum": [ + "NATIVE_INDEX", + "KENDRA_INDEX" + ], + "type": "string" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Definition of AWS::QBusiness::Retriever Resource Type", + "handlers": { + "create": { + "permissions": [ + "iam:PassRole", + "qbusiness:CreateRetriever", + "qbusiness:GetRetriever", + "qbusiness:ListTagsForResource", + "qbusiness:TagResource" + ] + }, + "delete": { + "permissions": [ + "qbusiness:DeleteRetriever", + "qbusiness:GetRetriever" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "ApplicationId": { + "$ref": "resource-schema.json#/properties/ApplicationId" + } + }, + "required": [ + "ApplicationId" + ] + }, + "permissions": [ + "qbusiness:ListRetrievers" + ] + }, + "read": { + "permissions": [ + "qbusiness:GetRetriever", + "qbusiness:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iam:PassRole", + "qbusiness:GetRetriever", + "qbusiness:ListTagsForResource", + "qbusiness:TagResource", + "qbusiness:UntagResource", + "qbusiness:UpdateRetriever" + ] + } + }, + "primaryIdentifier": [ + "/properties/ApplicationId", + "/properties/RetrieverId" + ], + "properties": { + "ApplicationId": { + "maxLength": 36, + "minLength": 36, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{35}$", + "type": "string" + }, + "Configuration": { + "$ref": "#/definitions/RetrieverConfiguration" + }, + "CreatedAt": { + "format": "date-time", + "type": "string" + }, + "DisplayName": { + "maxLength": 1000, + "minLength": 1, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", + "type": "string" + }, + "RetrieverArn": { + "maxLength": 1284, + "minLength": 0, + "pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$", + "type": "string" + }, + "RetrieverId": { + "maxLength": 36, + "minLength": 36, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{35}$", + "type": "string" + }, + "RoleArn": { + "maxLength": 1284, + "minLength": 0, + "pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$", + "type": "string" + }, + "Status": { + "$ref": "#/definitions/RetrieverStatus" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Type": { + "$ref": "#/definitions/RetrieverType" + }, + "UpdatedAt": { + "format": "date-time", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/CreatedAt", + "/properties/RetrieverArn", + "/properties/RetrieverId", + "/properties/Status", + "/properties/UpdatedAt" + ], + "required": [ + "ApplicationId", + "Configuration", + "DisplayName", + "Type" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-qbusiness", + "tagging": { + "taggable": true + }, + "typeName": "AWS::QBusiness::Retriever" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::QBusiness::WebExperience.json b/artifacts/types/AWS::QBusiness::WebExperience.json new file mode 100644 index 00000000..b9991400 --- /dev/null +++ b/artifacts/types/AWS::QBusiness::WebExperience.json @@ -0,0 +1,195 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-QBusiness-WebExperience", + "type": "AWS::QBusiness::WebExperience", + "time": "2024-06-18T16:19:29.92Z", + "schema": { + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ApplicationId" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "WebExperienceSamplePromptsControlMode": { + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + }, + "WebExperienceStatus": { + "enum": [ + "CREATING", + "ACTIVE", + "DELETING", + "FAILED", + "PENDING_AUTH_CONFIG" + ], + "type": "string" + } + }, + "description": "Definition of AWS::QBusiness::WebExperience Resource Type", + "handlers": { + "create": { + "permissions": [ + "iam:PassRole", + "qbusiness:CreateWebExperience", + "qbusiness:GetWebExperience", + "qbusiness:ListTagsForResource", + "qbusiness:TagResource", + "sso:PutApplicationGrant", + "sso:UpdateApplication" + ] + }, + "delete": { + "permissions": [ + "qbusiness:DeleteWebExperience", + "qbusiness:GetWebExperience" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "ApplicationId": { + "$ref": "resource-schema.json#/properties/ApplicationId" + } + }, + "required": [ + "ApplicationId" + ] + }, + "permissions": [ + "qbusiness:ListWebExperiences" + ] + }, + "read": { + "permissions": [ + "qbusiness:GetWebExperience", + "qbusiness:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "iam:PassRole", + "qbusiness:GetWebExperience", + "qbusiness:ListTagsForResource", + "qbusiness:TagResource", + "qbusiness:UntagResource", + "qbusiness:UpdateWebExperience", + "sso:PutApplicationGrant", + "sso:UpdateApplication" + ] + } + }, + "primaryIdentifier": [ + "/properties/ApplicationId", + "/properties/WebExperienceId" + ], + "properties": { + "ApplicationId": { + "maxLength": 36, + "minLength": 36, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{35}$", + "type": "string" + }, + "CreatedAt": { + "format": "date-time", + "type": "string" + }, + "DefaultEndpoint": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^(https?|ftp|file)://([^\\s]*)$", + "type": "string" + }, + "RoleArn": { + "maxLength": 1284, + "minLength": 0, + "pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$", + "type": "string" + }, + "SamplePromptsControlMode": { + "$ref": "#/definitions/WebExperienceSamplePromptsControlMode" + }, + "Status": { + "$ref": "#/definitions/WebExperienceStatus" + }, + "Subtitle": { + "maxLength": 500, + "minLength": 0, + "pattern": "^[\\s\\S]*$", + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 0, + "type": "array" + }, + "Title": { + "maxLength": 500, + "minLength": 0, + "pattern": "^[\\s\\S]*$", + "type": "string" + }, + "UpdatedAt": { + "format": "date-time", + "type": "string" + }, + "WebExperienceArn": { + "maxLength": 1284, + "minLength": 0, + "pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$", + "type": "string" + }, + "WebExperienceId": { + "maxLength": 36, + "minLength": 36, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "type": "string" + }, + "WelcomeMessage": { + "maxLength": 300, + "minLength": 0, + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/CreatedAt", + "/properties/DefaultEndpoint", + "/properties/Status", + "/properties/UpdatedAt", + "/properties/WebExperienceArn", + "/properties/WebExperienceId" + ], + "required": [ + "ApplicationId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-qbusiness", + "tagging": { + "taggable": true + }, + "typeName": "AWS::QBusiness::WebExperience" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::QLDB::Stream.json b/artifacts/types/AWS::QLDB::Stream.json index 07fcd198..ebeec0e6 100644 --- a/artifacts/types/AWS::QLDB::Stream.json +++ b/artifacts/types/AWS::QLDB::Stream.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-QLDB-Stream", "type": "AWS::QLDB::Stream", - "time": "2024-01-03T16:59:47.87Z", + "time": "2024-06-11T15:29:10.255Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -139,6 +139,18 @@ "KinesisConfiguration", "InclusiveStartTime" ], + "tagging": { + "cloudFormationSystemTags": false, + "permissions": [ + "qldb:TagResource", + "qldb:UntagResource", + "qldb:ListTagsForResource" + ], + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, "typeName": "AWS::QLDB::Stream" } } \ No newline at end of file diff --git a/artifacts/types/AWS::QuickSight::Analysis.json b/artifacts/types/AWS::QuickSight::Analysis.json index 32b97c34..01c518e8 100644 --- a/artifacts/types/AWS::QuickSight::Analysis.json +++ b/artifacts/types/AWS::QuickSight::Analysis.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-QuickSight-Analysis", "type": "AWS::QuickSight::Analysis", - "time": "2024-01-04T17:38:30.35Z", + "time": "2024-06-05T15:53:14.775Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -80,7 +80,7 @@ "items": { "$ref": "#/definitions/ColumnConfiguration" }, - "maxItems": 200, + "maxItems": 2000, "minItems": 0, "type": "array" }, @@ -127,15 +127,18 @@ }, "AnalysisError": { "additionalProperties": false, + "description": "\u003cp\u003eAnalysis error.\u003c/p\u003e", "properties": { "Message": { - "pattern": ".*\\S.*", + "description": "\u003cp\u003eThe message associated with the analysis error.\u003c/p\u003e", + "pattern": "\\S", "type": "string" }, "Type": { "$ref": "#/definitions/AnalysisErrorType" }, "ViolatedEntities": { + "description": "\u003cp\u003eLists the violated entities that caused the analysis error\u003c/p\u003e", "items": { "$ref": "#/definitions/Entity" }, @@ -163,6 +166,7 @@ }, "AnalysisSourceEntity": { "additionalProperties": false, + "description": "\u003cp\u003eThe source entity of an analysis.\u003c/p\u003e", "properties": { "SourceTemplate": { "$ref": "#/definitions/AnalysisSourceTemplate" @@ -172,11 +176,14 @@ }, "AnalysisSourceTemplate": { "additionalProperties": false, + "description": "\u003cp\u003eThe source template of an analysis.\u003c/p\u003e", "properties": { "Arn": { + "description": "\u003cp\u003eThe Amazon Resource Name (ARN) of the source template of an analysis.\u003c/p\u003e", "type": "string" }, "DataSetReferences": { + "description": "\u003cp\u003eThe dataset references of the source template of an analysis.\u003c/p\u003e", "items": { "$ref": "#/definitions/DataSetReference" }, @@ -645,7 +652,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -708,7 +715,7 @@ "SectionId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "Style": { @@ -884,7 +891,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -1054,10 +1061,13 @@ "Configuration": { "$ref": "#/definitions/CategoryFilterConfiguration" }, + "DefaultFilterControlConfiguration": { + "$ref": "#/definitions/DefaultFilterControlConfiguration" + }, "FilterId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -1451,7 +1461,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -1733,7 +1743,7 @@ "type": "string" }, "Symbol": { - "pattern": "[A-Z]{3}", + "pattern": "^[A-Z]{3}$", "type": "string" } }, @@ -1881,7 +1891,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -2275,12 +2285,15 @@ }, "DataSetReference": { "additionalProperties": false, + "description": "\u003cp\u003eDataset reference.\u003c/p\u003e", "properties": { "DataSetArn": { + "description": "\u003cp\u003eDataset Amazon Resource Name (ARN).\u003c/p\u003e", "type": "string" }, "DataSetPlaceholder": { - "pattern": ".*\\S.*", + "description": "\u003cp\u003eDataset placeholder.\u003c/p\u003e", + "pattern": "\\S", "type": "string" } }, @@ -2423,12 +2436,15 @@ }, "DateTimeParameter": { "additionalProperties": false, + "description": "\u003cp\u003eA date-time parameter.\u003c/p\u003e", "properties": { "Name": { - "pattern": ".*\\S.*", + "description": "\u003cp\u003eA display name for the date-time parameter.\u003c/p\u003e", + "pattern": "\\S", "type": "string" }, "Values": { + "description": "\u003cp\u003eThe values for the date-time parameter.\u003c/p\u003e", "items": { "type": "string" }, @@ -2534,12 +2550,15 @@ }, "DecimalParameter": { "additionalProperties": false, + "description": "\u003cp\u003eA decimal parameter.\u003c/p\u003e", "properties": { "Name": { - "pattern": ".*\\S.*", + "description": "\u003cp\u003eA display name for the decimal parameter.\u003c/p\u003e", + "pattern": "\\S", "type": "string" }, "Values": { + "description": "\u003cp\u003eThe values for the decimal parameter.\u003c/p\u003e", "items": { "default": 0, "type": "number" @@ -2613,6 +2632,93 @@ }, "type": "object" }, + "DefaultDateTimePickerControlOptions": { + "additionalProperties": false, + "properties": { + "DisplayOptions": { + "$ref": "#/definitions/DateTimePickerControlDisplayOptions" + }, + "Type": { + "$ref": "#/definitions/SheetControlDateTimePickerType" + } + }, + "type": "object" + }, + "DefaultFilterControlConfiguration": { + "additionalProperties": false, + "properties": { + "ControlOptions": { + "$ref": "#/definitions/DefaultFilterControlOptions" + }, + "Title": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "ControlOptions", + "Title" + ], + "type": "object" + }, + "DefaultFilterControlOptions": { + "additionalProperties": false, + "properties": { + "DefaultDateTimePickerOptions": { + "$ref": "#/definitions/DefaultDateTimePickerControlOptions" + }, + "DefaultDropdownOptions": { + "$ref": "#/definitions/DefaultFilterDropDownControlOptions" + }, + "DefaultListOptions": { + "$ref": "#/definitions/DefaultFilterListControlOptions" + }, + "DefaultRelativeDateTimeOptions": { + "$ref": "#/definitions/DefaultRelativeDateTimeControlOptions" + }, + "DefaultSliderOptions": { + "$ref": "#/definitions/DefaultSliderControlOptions" + }, + "DefaultTextAreaOptions": { + "$ref": "#/definitions/DefaultTextAreaControlOptions" + }, + "DefaultTextFieldOptions": { + "$ref": "#/definitions/DefaultTextFieldControlOptions" + } + }, + "type": "object" + }, + "DefaultFilterDropDownControlOptions": { + "additionalProperties": false, + "properties": { + "DisplayOptions": { + "$ref": "#/definitions/DropDownControlDisplayOptions" + }, + "SelectableValues": { + "$ref": "#/definitions/FilterSelectableValues" + }, + "Type": { + "$ref": "#/definitions/SheetControlListType" + } + }, + "type": "object" + }, + "DefaultFilterListControlOptions": { + "additionalProperties": false, + "properties": { + "DisplayOptions": { + "$ref": "#/definitions/ListControlDisplayOptions" + }, + "SelectableValues": { + "$ref": "#/definitions/FilterSelectableValues" + }, + "Type": { + "$ref": "#/definitions/SheetControlListType" + } + }, + "type": "object" + }, "DefaultFreeFormLayoutConfiguration": { "additionalProperties": false, "properties": { @@ -2673,6 +2779,15 @@ }, "type": "object" }, + "DefaultRelativeDateTimeControlOptions": { + "additionalProperties": false, + "properties": { + "DisplayOptions": { + "$ref": "#/definitions/RelativeDateTimeControlDisplayOptions" + } + }, + "type": "object" + }, "DefaultSectionBasedLayoutConfiguration": { "additionalProperties": false, "properties": { @@ -2685,6 +2800,58 @@ ], "type": "object" }, + "DefaultSliderControlOptions": { + "additionalProperties": false, + "properties": { + "DisplayOptions": { + "$ref": "#/definitions/SliderControlDisplayOptions" + }, + "MaximumValue": { + "default": 0, + "type": "number" + }, + "MinimumValue": { + "default": 0, + "type": "number" + }, + "StepSize": { + "default": 0, + "type": "number" + }, + "Type": { + "$ref": "#/definitions/SheetControlSliderType" + } + }, + "required": [ + "MaximumValue", + "MinimumValue", + "StepSize" + ], + "type": "object" + }, + "DefaultTextAreaControlOptions": { + "additionalProperties": false, + "properties": { + "Delimiter": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "DisplayOptions": { + "$ref": "#/definitions/TextAreaControlDisplayOptions" + } + }, + "type": "object" + }, + "DefaultTextFieldControlOptions": { + "additionalProperties": false, + "properties": { + "DisplayOptions": { + "$ref": "#/definitions/TextFieldControlDisplayOptions" + } + }, + "type": "object" + }, "DestinationParameterValueConfiguration": { "additionalProperties": false, "properties": { @@ -2811,7 +2978,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -2825,7 +2992,7 @@ "additionalProperties": false, "properties": { "Path": { - "pattern": ".*\\S.*", + "pattern": "\\S", "type": "string" } }, @@ -3136,7 +3303,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -3175,6 +3342,9 @@ "FilterControl": { "additionalProperties": false, "properties": { + "CrossSheet": { + "$ref": "#/definitions/FilterCrossSheetControl" + }, "DateTimePicker": { "$ref": "#/definitions/FilterDateTimePickerControl" }, @@ -3199,6 +3369,31 @@ }, "type": "object" }, + "FilterCrossSheetControl": { + "additionalProperties": false, + "properties": { + "CascadingControlConfiguration": { + "$ref": "#/definitions/CascadingControlConfiguration" + }, + "FilterControlId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "SourceFilterId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "FilterControlId", + "SourceFilterId" + ], + "type": "object" + }, "FilterDateTimePickerControl": { "additionalProperties": false, "properties": { @@ -3208,13 +3403,13 @@ "FilterControlId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "SourceFilterId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "Title": { @@ -3245,7 +3440,7 @@ "FilterControlId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "SelectableValues": { @@ -3254,7 +3449,7 @@ "SourceFilterId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "Title": { @@ -3282,7 +3477,7 @@ "FilterGroupId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "Filters": { @@ -3348,7 +3543,7 @@ "FilterControlId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "SelectableValues": { @@ -3357,7 +3552,7 @@ "SourceFilterId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "Title": { @@ -3388,6 +3583,7 @@ "additionalProperties": false, "properties": { "SelectedColumns": { + "description": "\u003cp\u003eThe selected columns of a dataset.\u003c/p\u003e", "items": { "$ref": "#/definitions/ColumnIdentifier" }, @@ -3429,13 +3625,13 @@ "FilterControlId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "SourceFilterId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "Title": { @@ -3486,7 +3682,7 @@ "FilterControlId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "MaximumValue": { @@ -3500,7 +3696,7 @@ "SourceFilterId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "StepSize": { @@ -3540,13 +3736,13 @@ "FilterControlId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "SourceFilterId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "Title": { @@ -3571,13 +3767,13 @@ "FilterControlId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "SourceFilterId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "Title": { @@ -3667,7 +3863,7 @@ "ComputationId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "CustomSeasonalityValue": { @@ -3804,7 +4000,7 @@ "ElementId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "ElementType": { @@ -4054,7 +4250,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -4200,7 +4396,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -4383,7 +4579,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -4519,7 +4715,7 @@ "ElementId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "ElementType": { @@ -4566,7 +4762,7 @@ "ComputationId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "Name": { @@ -4599,7 +4795,7 @@ "SectionId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "Style": { @@ -4740,7 +4936,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -4851,7 +5047,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -4945,7 +5141,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -4974,12 +5170,15 @@ }, "IntegerParameter": { "additionalProperties": false, + "description": "\u003cp\u003eAn integer parameter.\u003c/p\u003e", "properties": { "Name": { - "pattern": ".*\\S.*", + "description": "\u003cp\u003eThe name of the integer parameter.\u003c/p\u003e", + "pattern": "\\S", "type": "string" }, "Values": { + "description": "\u003cp\u003eThe values for the integer parameter.\u003c/p\u003e", "items": { "default": 0, "type": "number" @@ -5284,7 +5483,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -5497,7 +5696,7 @@ "items": { "$ref": "#/definitions/SeriesItem" }, - "maxItems": 10, + "maxItems": 2000, "minItems": 0, "type": "array" }, @@ -5688,7 +5887,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -5773,7 +5972,7 @@ "TargetSheetId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -5841,7 +6040,7 @@ "ComputationId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "Name": { @@ -5894,7 +6093,7 @@ "ComputationId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "FromValue": { @@ -6063,10 +6262,13 @@ "Column": { "$ref": "#/definitions/ColumnIdentifier" }, + "DefaultFilterControlConfiguration": { + "$ref": "#/definitions/DefaultFilterControlConfiguration" + }, "FilterId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "MatchOperator": { @@ -6134,10 +6336,13 @@ "Column": { "$ref": "#/definitions/ColumnIdentifier" }, + "DefaultFilterControlConfiguration": { + "$ref": "#/definitions/DefaultFilterControlConfiguration" + }, "FilterId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "IncludeMaximum": { @@ -6407,7 +6612,7 @@ "ParameterControlId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "SourceParameterName": { @@ -6459,7 +6664,7 @@ "ParameterControlId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "SelectableValues": { @@ -6499,7 +6704,7 @@ "ParameterControlId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "SelectableValues": { @@ -6561,7 +6766,7 @@ "ParameterControlId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "SourceParameterName": { @@ -6604,7 +6809,7 @@ "ParameterControlId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "SourceParameterName": { @@ -6635,7 +6840,7 @@ "ParameterControlId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "SourceParameterName": { @@ -6666,8 +6871,10 @@ }, "Parameters": { "additionalProperties": false, + "description": "\u003cp\u003eA list of Amazon QuickSight parameters and the list's override values.\u003c/p\u003e", "properties": { "DateTimeParameters": { + "description": "\u003cp\u003eThe parameters that have a data type of date-time.\u003c/p\u003e", "items": { "$ref": "#/definitions/DateTimeParameter" }, @@ -6676,6 +6883,7 @@ "type": "array" }, "DecimalParameters": { + "description": "\u003cp\u003eThe parameters that have a data type of decimal.\u003c/p\u003e", "items": { "$ref": "#/definitions/DecimalParameter" }, @@ -6684,6 +6892,7 @@ "type": "array" }, "IntegerParameters": { + "description": "\u003cp\u003eThe parameters that have a data type of integer.\u003c/p\u003e", "items": { "$ref": "#/definitions/IntegerParameter" }, @@ -6692,6 +6901,7 @@ "type": "array" }, "StringParameters": { + "description": "\u003cp\u003eThe parameters that have a data type of string.\u003c/p\u003e", "items": { "$ref": "#/definitions/StringParameter" }, @@ -6765,7 +6975,7 @@ "ComputationId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "Name": { @@ -6789,7 +6999,7 @@ "ComputationId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "Name": { @@ -6952,7 +7162,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -7044,7 +7254,7 @@ "items": { "$ref": "#/definitions/PivotTableConditionalFormattingOption" }, - "maxItems": 100, + "maxItems": 500, "minItems": 0, "type": "array" } @@ -7407,7 +7617,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -7685,7 +7895,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -7728,7 +7938,7 @@ "additionalProperties": false, "properties": { "CustomLabel": { - "pattern": ".*\\S.*", + "pattern": "\\S", "type": "string" } }, @@ -7910,13 +8120,16 @@ "Column": { "$ref": "#/definitions/ColumnIdentifier" }, + "DefaultFilterControlConfiguration": { + "$ref": "#/definitions/DefaultFilterControlConfiguration" + }, "ExcludePeriodConfiguration": { "$ref": "#/definitions/ExcludePeriodConfiguration" }, "FilterId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "MinimumGranularity": { @@ -7971,8 +8184,10 @@ }, "ResourcePermission": { "additionalProperties": false, + "description": "\u003cp\u003ePermission for the resource.\u003c/p\u003e", "properties": { "Actions": { + "description": "\u003cp\u003eThe IAM action to grant or revoke permissions on.\u003c/p\u003e", "items": { "type": "string" }, @@ -7981,6 +8196,7 @@ "type": "array" }, "Principal": { + "description": "\u003cp\u003eThe Amazon Resource Name (ARN) of the principal. This can be one of the\n following:\u003c/p\u003e\n \u003cul\u003e\n \u003cli\u003e\n \u003cp\u003eThe ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)\u003c/p\u003e\n \u003c/li\u003e\n \u003cli\u003e\n \u003cp\u003eThe ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)\u003c/p\u003e\n \u003c/li\u003e\n \u003cli\u003e\n \u003cp\u003eThe ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight\n ARN. Use this option only to share resources (templates) across Amazon Web Services accounts.\n (This is less common.) \u003c/p\u003e\n \u003c/li\u003e\n \u003c/ul\u003e", "maxLength": 256, "minLength": 1, "type": "string" @@ -8054,7 +8270,7 @@ "items": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "maxItems": 50, @@ -8161,7 +8377,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -8338,7 +8554,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -8559,16 +8775,19 @@ }, "Sheet": { "additionalProperties": false, + "description": "\u003cp\u003eA \u003ci\u003esheet\u003c/i\u003e, which is an object that contains a set of visuals that\n are viewed together on one page in Amazon QuickSight. Every analysis and dashboard\n contains at least one sheet. Each sheet contains at least one visualization widget, for\n example a chart, pivot table, or narrative insight. Sheets can be associated with other\n components, such as controls, filters, and so on.\u003c/p\u003e", "properties": { "Name": { + "description": "\u003cp\u003eThe name of a sheet. This name is displayed on the sheet's tab in the Amazon QuickSight\n console.\u003c/p\u003e", "maxLength": 2048, "minLength": 1, "type": "string" }, "SheetId": { + "description": "\u003cp\u003eThe unique identifier associated with a sheet.\u003c/p\u003e", "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -8688,7 +8907,7 @@ "SheetId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "TextBoxes": { @@ -8756,7 +8975,7 @@ "SheetTextBoxId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -8774,14 +8993,14 @@ "SheetId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "VisualIds": { "items": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "maxItems": 50, @@ -8985,12 +9204,15 @@ }, "StringParameter": { "additionalProperties": false, + "description": "\u003cp\u003eA string parameter.\u003c/p\u003e", "properties": { "Name": { - "pattern": ".*\\S.*", + "description": "\u003cp\u003eA display name for a string parameter.\u003c/p\u003e", + "pattern": "\\S", "type": "string" }, "Values": { + "description": "\u003cp\u003eThe values of a string parameter.\u003c/p\u003e", "items": { "type": "string" }, @@ -9217,7 +9439,7 @@ "items": { "$ref": "#/definitions/TableConditionalFormattingOption" }, - "maxItems": 100, + "maxItems": 500, "minItems": 0, "type": "array" } @@ -9597,7 +9819,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -9608,13 +9830,16 @@ }, "Tag": { "additionalProperties": false, + "description": "\u003cp\u003eThe key or keys of the key-value pairs for the resource tag or tags assigned to the\n resource.\u003c/p\u003e", "properties": { "Key": { + "description": "\u003cp\u003eTag key.\u003c/p\u003e", "maxLength": 128, "minLength": 1, "type": "string" }, "Value": { + "description": "\u003cp\u003eTag value.\u003c/p\u003e", "maxLength": 256, "minLength": 1, "type": "string" @@ -9745,10 +9970,13 @@ "Column": { "$ref": "#/definitions/ColumnIdentifier" }, + "DefaultFilterControlConfiguration": { + "$ref": "#/definitions/DefaultFilterControlConfiguration" + }, "FilterId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "ParameterName": { @@ -9820,13 +10048,16 @@ "Column": { "$ref": "#/definitions/ColumnIdentifier" }, + "DefaultFilterControlConfiguration": { + "$ref": "#/definitions/DefaultFilterControlConfiguration" + }, "ExcludePeriodConfiguration": { "$ref": "#/definitions/ExcludePeriodConfiguration" }, "FilterId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "IncludeMaximum": { @@ -9931,10 +10162,13 @@ "Column": { "$ref": "#/definitions/ColumnIdentifier" }, + "DefaultFilterControlConfiguration": { + "$ref": "#/definitions/DefaultFilterControlConfiguration" + }, "FilterId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "Limit": { @@ -9967,7 +10201,7 @@ "ComputationId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "MoverSize": { @@ -10007,7 +10241,7 @@ "ComputationId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "Name": { @@ -10045,7 +10279,7 @@ "ComputationId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "Name": { @@ -10236,7 +10470,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -10292,7 +10526,7 @@ "ComputationId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "Name": { @@ -10306,6 +10540,7 @@ }, "ValidationStrategy": { "additionalProperties": false, + "description": "\u003cp\u003eThe 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 \u003ccode\u003eLENIENT\u003c/code\u003e, validation is skipped for specific errors.\u003c/p\u003e", "properties": { "Mode": { "$ref": "#/definitions/ValidationStrategyMode" @@ -10444,7 +10679,7 @@ "CustomActionId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "Name": { @@ -10564,6 +10799,15 @@ }, "type": "object" }, + "WaterfallChartColorConfiguration": { + "additionalProperties": false, + "properties": { + "GroupColorConfiguration": { + "$ref": "#/definitions/WaterfallChartGroupColorConfiguration" + } + }, + "type": "object" + }, "WaterfallChartConfiguration": { "additionalProperties": false, "properties": { @@ -10573,6 +10817,9 @@ "CategoryAxisLabelOptions": { "$ref": "#/definitions/ChartAxisLabelOptions" }, + "ColorConfiguration": { + "$ref": "#/definitions/WaterfallChartColorConfiguration" + }, "DataLabels": { "$ref": "#/definitions/DataLabelOptions" }, @@ -10609,6 +10856,24 @@ }, "type": "object" }, + "WaterfallChartGroupColorConfiguration": { + "additionalProperties": false, + "properties": { + "NegativeBarColor": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "PositiveBarColor": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "TotalBarColor": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + } + }, + "type": "object" + }, "WaterfallChartOptions": { "additionalProperties": false, "properties": { @@ -10666,7 +10931,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -10853,7 +11118,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -10959,10 +11224,11 @@ "AnalysisId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "Arn": { + "description": "\u003cp\u003eThe Amazon Resource Name (ARN) of the analysis.\u003c/p\u003e", "type": "string" }, "AwsAccountId": { @@ -10972,10 +11238,12 @@ "type": "string" }, "CreatedTime": { + "description": "\u003cp\u003eThe time that the analysis was created.\u003c/p\u003e", "format": "date-time", "type": "string" }, "DataSetArns": { + "description": "\u003cp\u003eThe ARNs of the datasets of the analysis.\u003c/p\u003e", "items": { "type": "string" }, @@ -10987,6 +11255,7 @@ "$ref": "#/definitions/AnalysisDefinition" }, "Errors": { + "description": "\u003cp\u003eErrors associated with the analysis.\u003c/p\u003e", "items": { "$ref": "#/definitions/AnalysisError" }, @@ -10994,10 +11263,12 @@ "type": "array" }, "LastUpdatedTime": { + "description": "\u003cp\u003eThe time that the analysis was last updated.\u003c/p\u003e", "format": "date-time", "type": "string" }, "Name": { + "description": "\u003cp\u003eThe descriptive name of the analysis.\u003c/p\u003e", "maxLength": 2048, "minLength": 1, "type": "string" @@ -11014,6 +11285,7 @@ "type": "array" }, "Sheets": { + "description": "\u003cp\u003eA list of the associated sheets with the unique identifier and name of each sheet.\u003c/p\u003e", "items": { "$ref": "#/definitions/Sheet" }, @@ -11036,6 +11308,7 @@ "type": "array" }, "ThemeArn": { + "description": "\u003cp\u003eThe ARN of the theme of the analysis.\u003c/p\u003e", "type": "string" }, "ValidationStrategy": { diff --git a/artifacts/types/AWS::QuickSight::Dashboard.json b/artifacts/types/AWS::QuickSight::Dashboard.json index 9afa18ec..417768aa 100644 --- a/artifacts/types/AWS::QuickSight::Dashboard.json +++ b/artifacts/types/AWS::QuickSight::Dashboard.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-QuickSight-Dashboard", "type": "AWS::QuickSight::Dashboard", - "time": "2024-01-04T17:31:33.29Z", + "time": "2024-06-05T15:49:35.782Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -11,6 +11,7 @@ "definitions": { "AdHocFilteringOption": { "additionalProperties": false, + "description": "\u003cp\u003eAn ad hoc (one-time) filtering option.\u003c/p\u003e", "properties": { "AvailabilityStatus": { "$ref": "#/definitions/DashboardBehavior" @@ -526,7 +527,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -589,7 +590,7 @@ "SectionId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "Style": { @@ -765,7 +766,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -935,10 +936,13 @@ "Configuration": { "$ref": "#/definitions/CategoryFilterConfiguration" }, + "DefaultFilterControlConfiguration": { + "$ref": "#/definitions/DefaultFilterControlConfiguration" + }, "FilterId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -1332,7 +1336,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -1614,7 +1618,7 @@ "type": "string" }, "Symbol": { - "pattern": "[A-Z]{3}", + "pattern": "^[A-Z]{3}$", "type": "string" } }, @@ -1762,7 +1766,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -1908,15 +1912,18 @@ }, "DashboardError": { "additionalProperties": false, + "description": "\u003cp\u003eDashboard error.\u003c/p\u003e", "properties": { "Message": { - "pattern": ".*\\S.*", + "description": "\u003cp\u003eMessage.\u003c/p\u003e", + "pattern": "\\S", "type": "string" }, "Type": { "$ref": "#/definitions/DashboardErrorType" }, "ViolatedEntities": { + "description": "\u003cp\u003eLists the violated entities that caused the dashboard error.\u003c/p\u003e", "items": { "$ref": "#/definitions/Entity" }, @@ -1944,6 +1951,7 @@ }, "DashboardPublishOptions": { "additionalProperties": false, + "description": "\u003cp\u003eDashboard publish options.\u003c/p\u003e", "properties": { "AdHocFilteringOption": { "$ref": "#/definitions/AdHocFilteringOption" @@ -1983,6 +1991,7 @@ }, "DashboardSourceEntity": { "additionalProperties": false, + "description": "\u003cp\u003eDashboard source entity.\u003c/p\u003e", "properties": { "SourceTemplate": { "$ref": "#/definitions/DashboardSourceTemplate" @@ -1992,11 +2001,14 @@ }, "DashboardSourceTemplate": { "additionalProperties": false, + "description": "\u003cp\u003eDashboard source template.\u003c/p\u003e", "properties": { "Arn": { + "description": "\u003cp\u003eThe Amazon Resource Name (ARN) of the resource.\u003c/p\u003e", "type": "string" }, "DataSetReferences": { + "description": "\u003cp\u003eDataset references.\u003c/p\u003e", "items": { "$ref": "#/definitions/DataSetReference" }, @@ -2019,15 +2031,19 @@ }, "DashboardVersion": { "additionalProperties": false, + "description": "\u003cp\u003eDashboard version.\u003c/p\u003e", "properties": { "Arn": { + "description": "\u003cp\u003eThe Amazon Resource Name (ARN) of the resource.\u003c/p\u003e", "type": "string" }, "CreatedTime": { + "description": "\u003cp\u003eThe time that this dashboard version was created.\u003c/p\u003e", "format": "date-time", "type": "string" }, "DataSetArns": { + "description": "\u003cp\u003eThe Amazon Resource Numbers (ARNs) for the datasets that are associated with this\n version of the dashboard.\u003c/p\u003e", "items": { "type": "string" }, @@ -2036,11 +2052,13 @@ "type": "array" }, "Description": { + "description": "\u003cp\u003eDescription.\u003c/p\u003e", "maxLength": 512, "minLength": 1, "type": "string" }, "Errors": { + "description": "\u003cp\u003eErrors associated with this dashboard version.\u003c/p\u003e", "items": { "$ref": "#/definitions/DashboardError" }, @@ -2048,6 +2066,7 @@ "type": "array" }, "Sheets": { + "description": "\u003cp\u003eA list of the associated sheets with the unique identifier and name of each sheet.\u003c/p\u003e", "items": { "$ref": "#/definitions/Sheet" }, @@ -2056,15 +2075,18 @@ "type": "array" }, "SourceEntityArn": { + "description": "\u003cp\u003eSource entity ARN.\u003c/p\u003e", "type": "string" }, "Status": { "$ref": "#/definitions/ResourceStatus" }, "ThemeArn": { + "description": "\u003cp\u003eThe ARN of the theme associated with a version of the dashboard.\u003c/p\u003e", "type": "string" }, "VersionNumber": { + "description": "\u003cp\u003eVersion number for this version of the dashboard.\u003c/p\u003e", "minimum": 1, "type": "number" } @@ -2089,7 +2111,7 @@ "items": { "$ref": "#/definitions/ColumnConfiguration" }, - "maxItems": 200, + "maxItems": 2000, "minItems": 0, "type": "array" }, @@ -2136,6 +2158,7 @@ }, "DashboardVisualPublishOptions": { "additionalProperties": false, + "description": "\u003cp\u003eThe visual publish options of a visual in a dashboard\u003c/p\u003e", "properties": { "ExportHiddenFieldsOption": { "$ref": "#/definitions/ExportHiddenFieldsOption" @@ -2382,6 +2405,7 @@ }, "DataPointDrillUpDownOption": { "additionalProperties": false, + "description": "\u003cp\u003eThe drill down options for data points in a dashbaord.\u003c/p\u003e", "properties": { "AvailabilityStatus": { "$ref": "#/definitions/DashboardBehavior" @@ -2391,6 +2415,7 @@ }, "DataPointMenuLabelOption": { "additionalProperties": false, + "description": "\u003cp\u003eThe data point menu options of a dashboard.\u003c/p\u003e", "properties": { "AvailabilityStatus": { "$ref": "#/definitions/DashboardBehavior" @@ -2400,6 +2425,7 @@ }, "DataPointTooltipOption": { "additionalProperties": false, + "description": "\u003cp\u003eThe data point tooltip options.\u003c/p\u003e", "properties": { "AvailabilityStatus": { "$ref": "#/definitions/DashboardBehavior" @@ -2427,12 +2453,15 @@ }, "DataSetReference": { "additionalProperties": false, + "description": "\u003cp\u003eDataset reference.\u003c/p\u003e", "properties": { "DataSetArn": { + "description": "\u003cp\u003eDataset Amazon Resource Name (ARN).\u003c/p\u003e", "type": "string" }, "DataSetPlaceholder": { - "pattern": ".*\\S.*", + "description": "\u003cp\u003eDataset placeholder.\u003c/p\u003e", + "pattern": "\\S", "type": "string" } }, @@ -2575,12 +2604,15 @@ }, "DateTimeParameter": { "additionalProperties": false, + "description": "\u003cp\u003eA date-time parameter.\u003c/p\u003e", "properties": { "Name": { - "pattern": ".*\\S.*", + "description": "\u003cp\u003eA display name for the date-time parameter.\u003c/p\u003e", + "pattern": "\\S", "type": "string" }, "Values": { + "description": "\u003cp\u003eThe values for the date-time parameter.\u003c/p\u003e", "items": { "type": "string" }, @@ -2686,12 +2718,15 @@ }, "DecimalParameter": { "additionalProperties": false, + "description": "\u003cp\u003eA decimal parameter.\u003c/p\u003e", "properties": { "Name": { - "pattern": ".*\\S.*", + "description": "\u003cp\u003eA display name for the decimal parameter.\u003c/p\u003e", + "pattern": "\\S", "type": "string" }, "Values": { + "description": "\u003cp\u003eThe values for the decimal parameter.\u003c/p\u003e", "items": { "default": 0, "type": "number" @@ -2765,6 +2800,93 @@ }, "type": "object" }, + "DefaultDateTimePickerControlOptions": { + "additionalProperties": false, + "properties": { + "DisplayOptions": { + "$ref": "#/definitions/DateTimePickerControlDisplayOptions" + }, + "Type": { + "$ref": "#/definitions/SheetControlDateTimePickerType" + } + }, + "type": "object" + }, + "DefaultFilterControlConfiguration": { + "additionalProperties": false, + "properties": { + "ControlOptions": { + "$ref": "#/definitions/DefaultFilterControlOptions" + }, + "Title": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "ControlOptions", + "Title" + ], + "type": "object" + }, + "DefaultFilterControlOptions": { + "additionalProperties": false, + "properties": { + "DefaultDateTimePickerOptions": { + "$ref": "#/definitions/DefaultDateTimePickerControlOptions" + }, + "DefaultDropdownOptions": { + "$ref": "#/definitions/DefaultFilterDropDownControlOptions" + }, + "DefaultListOptions": { + "$ref": "#/definitions/DefaultFilterListControlOptions" + }, + "DefaultRelativeDateTimeOptions": { + "$ref": "#/definitions/DefaultRelativeDateTimeControlOptions" + }, + "DefaultSliderOptions": { + "$ref": "#/definitions/DefaultSliderControlOptions" + }, + "DefaultTextAreaOptions": { + "$ref": "#/definitions/DefaultTextAreaControlOptions" + }, + "DefaultTextFieldOptions": { + "$ref": "#/definitions/DefaultTextFieldControlOptions" + } + }, + "type": "object" + }, + "DefaultFilterDropDownControlOptions": { + "additionalProperties": false, + "properties": { + "DisplayOptions": { + "$ref": "#/definitions/DropDownControlDisplayOptions" + }, + "SelectableValues": { + "$ref": "#/definitions/FilterSelectableValues" + }, + "Type": { + "$ref": "#/definitions/SheetControlListType" + } + }, + "type": "object" + }, + "DefaultFilterListControlOptions": { + "additionalProperties": false, + "properties": { + "DisplayOptions": { + "$ref": "#/definitions/ListControlDisplayOptions" + }, + "SelectableValues": { + "$ref": "#/definitions/FilterSelectableValues" + }, + "Type": { + "$ref": "#/definitions/SheetControlListType" + } + }, + "type": "object" + }, "DefaultFreeFormLayoutConfiguration": { "additionalProperties": false, "properties": { @@ -2825,6 +2947,15 @@ }, "type": "object" }, + "DefaultRelativeDateTimeControlOptions": { + "additionalProperties": false, + "properties": { + "DisplayOptions": { + "$ref": "#/definitions/RelativeDateTimeControlDisplayOptions" + } + }, + "type": "object" + }, "DefaultSectionBasedLayoutConfiguration": { "additionalProperties": false, "properties": { @@ -2837,6 +2968,58 @@ ], "type": "object" }, + "DefaultSliderControlOptions": { + "additionalProperties": false, + "properties": { + "DisplayOptions": { + "$ref": "#/definitions/SliderControlDisplayOptions" + }, + "MaximumValue": { + "default": 0, + "type": "number" + }, + "MinimumValue": { + "default": 0, + "type": "number" + }, + "StepSize": { + "default": 0, + "type": "number" + }, + "Type": { + "$ref": "#/definitions/SheetControlSliderType" + } + }, + "required": [ + "MaximumValue", + "MinimumValue", + "StepSize" + ], + "type": "object" + }, + "DefaultTextAreaControlOptions": { + "additionalProperties": false, + "properties": { + "Delimiter": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "DisplayOptions": { + "$ref": "#/definitions/TextAreaControlDisplayOptions" + } + }, + "type": "object" + }, + "DefaultTextFieldControlOptions": { + "additionalProperties": false, + "properties": { + "DisplayOptions": { + "$ref": "#/definitions/TextFieldControlDisplayOptions" + } + }, + "type": "object" + }, "DestinationParameterValueConfiguration": { "additionalProperties": false, "properties": { @@ -2963,7 +3146,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -2977,7 +3160,7 @@ "additionalProperties": false, "properties": { "Path": { - "pattern": ".*\\S.*", + "pattern": "\\S", "type": "string" } }, @@ -3036,6 +3219,7 @@ }, "ExportHiddenFieldsOption": { "additionalProperties": false, + "description": "\u003cp\u003eDetermines if hidden fields are included in an exported dashboard.\u003c/p\u003e", "properties": { "AvailabilityStatus": { "$ref": "#/definitions/DashboardBehavior" @@ -3045,6 +3229,7 @@ }, "ExportToCSVOption": { "additionalProperties": false, + "description": "\u003cp\u003eExport to .csv option.\u003c/p\u003e", "properties": { "AvailabilityStatus": { "$ref": "#/definitions/DashboardBehavior" @@ -3054,6 +3239,7 @@ }, "ExportWithHiddenFieldsOption": { "additionalProperties": false, + "description": "\u003cp\u003eDetermines whether or not hidden fields are visible on exported dashbaords.\u003c/p\u003e", "properties": { "AvailabilityStatus": { "$ref": "#/definitions/DashboardBehavior" @@ -3315,7 +3501,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -3354,6 +3540,9 @@ "FilterControl": { "additionalProperties": false, "properties": { + "CrossSheet": { + "$ref": "#/definitions/FilterCrossSheetControl" + }, "DateTimePicker": { "$ref": "#/definitions/FilterDateTimePickerControl" }, @@ -3378,6 +3567,31 @@ }, "type": "object" }, + "FilterCrossSheetControl": { + "additionalProperties": false, + "properties": { + "CascadingControlConfiguration": { + "$ref": "#/definitions/CascadingControlConfiguration" + }, + "FilterControlId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "SourceFilterId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "FilterControlId", + "SourceFilterId" + ], + "type": "object" + }, "FilterDateTimePickerControl": { "additionalProperties": false, "properties": { @@ -3387,13 +3601,13 @@ "FilterControlId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "SourceFilterId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "Title": { @@ -3424,7 +3638,7 @@ "FilterControlId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "SelectableValues": { @@ -3433,7 +3647,7 @@ "SourceFilterId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "Title": { @@ -3461,7 +3675,7 @@ "FilterGroupId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "Filters": { @@ -3527,7 +3741,7 @@ "FilterControlId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "SelectableValues": { @@ -3536,7 +3750,7 @@ "SourceFilterId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "Title": { @@ -3567,6 +3781,7 @@ "additionalProperties": false, "properties": { "SelectedColumns": { + "description": "\u003cp\u003eThe selected columns of a dataset.\u003c/p\u003e", "items": { "$ref": "#/definitions/ColumnIdentifier" }, @@ -3608,13 +3823,13 @@ "FilterControlId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "SourceFilterId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "Title": { @@ -3665,7 +3880,7 @@ "FilterControlId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "MaximumValue": { @@ -3679,7 +3894,7 @@ "SourceFilterId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "StepSize": { @@ -3719,13 +3934,13 @@ "FilterControlId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "SourceFilterId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "Title": { @@ -3750,13 +3965,13 @@ "FilterControlId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "SourceFilterId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "Title": { @@ -3846,7 +4061,7 @@ "ComputationId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "CustomSeasonalityValue": { @@ -3983,7 +4198,7 @@ "ElementId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "ElementType": { @@ -4233,7 +4448,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -4379,7 +4594,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -4562,7 +4777,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -4698,7 +4913,7 @@ "ElementId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "ElementType": { @@ -4745,7 +4960,7 @@ "ComputationId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "Name": { @@ -4778,7 +4993,7 @@ "SectionId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "Style": { @@ -4919,7 +5134,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -5030,7 +5245,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -5124,7 +5339,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -5153,12 +5368,15 @@ }, "IntegerParameter": { "additionalProperties": false, + "description": "\u003cp\u003eAn integer parameter.\u003c/p\u003e", "properties": { "Name": { - "pattern": ".*\\S.*", + "description": "\u003cp\u003eThe name of the integer parameter.\u003c/p\u003e", + "pattern": "\\S", "type": "string" }, "Values": { + "description": "\u003cp\u003eThe values for the integer parameter.\u003c/p\u003e", "items": { "default": 0, "type": "number" @@ -5463,7 +5681,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -5676,7 +5894,7 @@ "items": { "$ref": "#/definitions/SeriesItem" }, - "maxItems": 10, + "maxItems": 2000, "minItems": 0, "type": "array" }, @@ -5867,7 +6085,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -5966,7 +6184,7 @@ "TargetSheetId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -6034,7 +6252,7 @@ "ComputationId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "Name": { @@ -6087,7 +6305,7 @@ "ComputationId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "FromValue": { @@ -6256,10 +6474,13 @@ "Column": { "$ref": "#/definitions/ColumnIdentifier" }, + "DefaultFilterControlConfiguration": { + "$ref": "#/definitions/DefaultFilterControlConfiguration" + }, "FilterId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "MatchOperator": { @@ -6327,10 +6548,13 @@ "Column": { "$ref": "#/definitions/ColumnIdentifier" }, + "DefaultFilterControlConfiguration": { + "$ref": "#/definitions/DefaultFilterControlConfiguration" + }, "FilterId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "IncludeMaximum": { @@ -6600,7 +6824,7 @@ "ParameterControlId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "SourceParameterName": { @@ -6652,7 +6876,7 @@ "ParameterControlId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "SelectableValues": { @@ -6692,7 +6916,7 @@ "ParameterControlId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "SelectableValues": { @@ -6754,7 +6978,7 @@ "ParameterControlId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "SourceParameterName": { @@ -6797,7 +7021,7 @@ "ParameterControlId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "SourceParameterName": { @@ -6828,7 +7052,7 @@ "ParameterControlId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "SourceParameterName": { @@ -6859,8 +7083,10 @@ }, "Parameters": { "additionalProperties": false, + "description": "\u003cp\u003eA list of Amazon QuickSight parameters and the list's override values.\u003c/p\u003e", "properties": { "DateTimeParameters": { + "description": "\u003cp\u003eThe parameters that have a data type of date-time.\u003c/p\u003e", "items": { "$ref": "#/definitions/DateTimeParameter" }, @@ -6869,6 +7095,7 @@ "type": "array" }, "DecimalParameters": { + "description": "\u003cp\u003eThe parameters that have a data type of decimal.\u003c/p\u003e", "items": { "$ref": "#/definitions/DecimalParameter" }, @@ -6877,6 +7104,7 @@ "type": "array" }, "IntegerParameters": { + "description": "\u003cp\u003eThe parameters that have a data type of integer.\u003c/p\u003e", "items": { "$ref": "#/definitions/IntegerParameter" }, @@ -6885,6 +7113,7 @@ "type": "array" }, "StringParameters": { + "description": "\u003cp\u003eThe parameters that have a data type of string.\u003c/p\u003e", "items": { "$ref": "#/definitions/StringParameter" }, @@ -6958,7 +7187,7 @@ "ComputationId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "Name": { @@ -6982,7 +7211,7 @@ "ComputationId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "Name": { @@ -7145,7 +7374,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -7237,7 +7466,7 @@ "items": { "$ref": "#/definitions/PivotTableConditionalFormattingOption" }, - "maxItems": 100, + "maxItems": 500, "minItems": 0, "type": "array" } @@ -7600,7 +7829,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -7878,7 +8107,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -7921,7 +8150,7 @@ "additionalProperties": false, "properties": { "CustomLabel": { - "pattern": ".*\\S.*", + "pattern": "\\S", "type": "string" } }, @@ -8103,13 +8332,16 @@ "Column": { "$ref": "#/definitions/ColumnIdentifier" }, + "DefaultFilterControlConfiguration": { + "$ref": "#/definitions/DefaultFilterControlConfiguration" + }, "ExcludePeriodConfiguration": { "$ref": "#/definitions/ExcludePeriodConfiguration" }, "FilterId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "MinimumGranularity": { @@ -8164,8 +8396,10 @@ }, "ResourcePermission": { "additionalProperties": false, + "description": "\u003cp\u003ePermission for the resource.\u003c/p\u003e", "properties": { "Actions": { + "description": "\u003cp\u003eThe IAM action to grant or revoke permissions on.\u003c/p\u003e", "items": { "type": "string" }, @@ -8174,6 +8408,7 @@ "type": "array" }, "Principal": { + "description": "\u003cp\u003eThe Amazon Resource Name (ARN) of the principal. This can be one of the\n following:\u003c/p\u003e\n \u003cul\u003e\n \u003cli\u003e\n \u003cp\u003eThe ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)\u003c/p\u003e\n \u003c/li\u003e\n \u003cli\u003e\n \u003cp\u003eThe ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)\u003c/p\u003e\n \u003c/li\u003e\n \u003cli\u003e\n \u003cp\u003eThe ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight\n ARN. Use this option only to share resources (templates) across Amazon Web Services accounts.\n (This is less common.) \u003c/p\u003e\n \u003c/li\u003e\n \u003c/ul\u003e", "maxLength": 256, "minLength": 1, "type": "string" @@ -8247,7 +8482,7 @@ "items": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "maxItems": 50, @@ -8354,7 +8589,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -8531,7 +8766,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -8752,16 +8987,19 @@ }, "Sheet": { "additionalProperties": false, + "description": "\u003cp\u003eA \u003ci\u003esheet\u003c/i\u003e, which is an object that contains a set of visuals that\n are viewed together on one page in Amazon QuickSight. Every analysis and dashboard\n contains at least one sheet. Each sheet contains at least one visualization widget, for\n example a chart, pivot table, or narrative insight. Sheets can be associated with other\n components, such as controls, filters, and so on.\u003c/p\u003e", "properties": { "Name": { + "description": "\u003cp\u003eThe name of a sheet. This name is displayed on the sheet's tab in the Amazon QuickSight\n console.\u003c/p\u003e", "maxLength": 2048, "minLength": 1, "type": "string" }, "SheetId": { + "description": "\u003cp\u003eThe unique identifier associated with a sheet.\u003c/p\u003e", "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -8832,6 +9070,7 @@ }, "SheetControlsOption": { "additionalProperties": false, + "description": "\u003cp\u003eSheet controls option.\u003c/p\u003e", "properties": { "VisibilityState": { "$ref": "#/definitions/DashboardUIState" @@ -8890,7 +9129,7 @@ "SheetId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "TextBoxes": { @@ -8949,6 +9188,7 @@ }, "SheetLayoutElementMaximizationOption": { "additionalProperties": false, + "description": "\u003cp\u003eThe sheet layout maximization options of a dashbaord.\u003c/p\u003e", "properties": { "AvailabilityStatus": { "$ref": "#/definitions/DashboardBehavior" @@ -8967,7 +9207,7 @@ "SheetTextBoxId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -8985,14 +9225,14 @@ "SheetId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "VisualIds": { "items": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "maxItems": 50, @@ -9196,12 +9436,15 @@ }, "StringParameter": { "additionalProperties": false, + "description": "\u003cp\u003eA string parameter.\u003c/p\u003e", "properties": { "Name": { - "pattern": ".*\\S.*", + "description": "\u003cp\u003eA display name for a string parameter.\u003c/p\u003e", + "pattern": "\\S", "type": "string" }, "Values": { + "description": "\u003cp\u003eThe values of a string parameter.\u003c/p\u003e", "items": { "type": "string" }, @@ -9428,7 +9671,7 @@ "items": { "$ref": "#/definitions/TableConditionalFormattingOption" }, - "maxItems": 100, + "maxItems": 500, "minItems": 0, "type": "array" } @@ -9808,7 +10051,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -9819,13 +10062,16 @@ }, "Tag": { "additionalProperties": false, + "description": "\u003cp\u003eThe key or keys of the key-value pairs for the resource tag or tags assigned to the\n resource.\u003c/p\u003e", "properties": { "Key": { + "description": "\u003cp\u003eTag key.\u003c/p\u003e", "maxLength": 128, "minLength": 1, "type": "string" }, "Value": { + "description": "\u003cp\u003eTag value.\u003c/p\u003e", "maxLength": 256, "minLength": 1, "type": "string" @@ -9956,10 +10202,13 @@ "Column": { "$ref": "#/definitions/ColumnIdentifier" }, + "DefaultFilterControlConfiguration": { + "$ref": "#/definitions/DefaultFilterControlConfiguration" + }, "FilterId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "ParameterName": { @@ -10031,13 +10280,16 @@ "Column": { "$ref": "#/definitions/ColumnIdentifier" }, + "DefaultFilterControlConfiguration": { + "$ref": "#/definitions/DefaultFilterControlConfiguration" + }, "ExcludePeriodConfiguration": { "$ref": "#/definitions/ExcludePeriodConfiguration" }, "FilterId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "IncludeMaximum": { @@ -10142,10 +10394,13 @@ "Column": { "$ref": "#/definitions/ColumnIdentifier" }, + "DefaultFilterControlConfiguration": { + "$ref": "#/definitions/DefaultFilterControlConfiguration" + }, "FilterId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "Limit": { @@ -10178,7 +10433,7 @@ "ComputationId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "MoverSize": { @@ -10218,7 +10473,7 @@ "ComputationId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "Name": { @@ -10256,7 +10511,7 @@ "ComputationId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "Name": { @@ -10447,7 +10702,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -10503,7 +10758,7 @@ "ComputationId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "Name": { @@ -10517,6 +10772,7 @@ }, "ValidationStrategy": { "additionalProperties": false, + "description": "\u003cp\u003eThe 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 \u003ccode\u003eLENIENT\u003c/code\u003e, validation is skipped for specific errors.\u003c/p\u003e", "properties": { "Mode": { "$ref": "#/definitions/ValidationStrategyMode" @@ -10664,7 +10920,7 @@ "CustomActionId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "Name": { @@ -10793,6 +11049,15 @@ }, "type": "object" }, + "WaterfallChartColorConfiguration": { + "additionalProperties": false, + "properties": { + "GroupColorConfiguration": { + "$ref": "#/definitions/WaterfallChartGroupColorConfiguration" + } + }, + "type": "object" + }, "WaterfallChartConfiguration": { "additionalProperties": false, "properties": { @@ -10802,6 +11067,9 @@ "CategoryAxisLabelOptions": { "$ref": "#/definitions/ChartAxisLabelOptions" }, + "ColorConfiguration": { + "$ref": "#/definitions/WaterfallChartColorConfiguration" + }, "DataLabels": { "$ref": "#/definitions/DataLabelOptions" }, @@ -10838,6 +11106,24 @@ }, "type": "object" }, + "WaterfallChartGroupColorConfiguration": { + "additionalProperties": false, + "properties": { + "NegativeBarColor": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "PositiveBarColor": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "TotalBarColor": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + } + }, + "type": "object" + }, "WaterfallChartOptions": { "additionalProperties": false, "properties": { @@ -10895,7 +11181,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -11082,7 +11368,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -11170,6 +11456,7 @@ "quicksight:DescribeDashboard", "quicksight:DescribeDashboardPermissions", "quicksight:UpdateDashboard", + "quicksight:UpdateDashboardLinks", "quicksight:UpdateDashboardPermissions", "quicksight:UpdateDashboardPublishedVersion", "quicksight:DescribeTemplate", @@ -11187,6 +11474,7 @@ ], "properties": { "Arn": { + "description": "\u003cp\u003eThe Amazon Resource Name (ARN) of the resource.\u003c/p\u003e", "type": "string" }, "AwsAccountId": { @@ -11196,13 +11484,14 @@ "type": "string" }, "CreatedTime": { + "description": "\u003cp\u003eThe time that this dashboard was created.\u003c/p\u003e", "format": "date-time", "type": "string" }, "DashboardId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "DashboardPublishOptions": { @@ -11212,13 +11501,26 @@ "$ref": "#/definitions/DashboardVersionDefinition" }, "LastPublishedTime": { + "description": "\u003cp\u003eThe last time that this dashboard was published.\u003c/p\u003e", "format": "date-time", "type": "string" }, "LastUpdatedTime": { + "description": "\u003cp\u003eThe last time that this dashboard was updated.\u003c/p\u003e", "format": "date-time", "type": "string" }, + "LinkEntities": { + "items": { + "maxLength": 1024, + "minLength": 1, + "pattern": "^arn:aws[\\w\\-]*:quicksight:[\\w\\-]+:\\d+:analysis/[\\w\\-]{1,512}$", + "type": "string" + }, + "maxItems": 5, + "minItems": 0, + "type": "array" + }, "LinkSharingConfiguration": { "$ref": "#/definitions/LinkSharingConfiguration" }, diff --git a/artifacts/types/AWS::QuickSight::DataSet.json b/artifacts/types/AWS::QuickSight::DataSet.json index 2f903934..574eb3fc 100644 --- a/artifacts/types/AWS::QuickSight::DataSet.json +++ b/artifacts/types/AWS::QuickSight::DataSet.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-QuickSight-DataSet", "type": "AWS::QuickSight::DataSet", - "time": "2023-11-14T17:32:27.06Z", + "time": "2024-05-22T17:50:56.056Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -21,7 +21,7 @@ }, "ColumnName": { "description": "\u003cp\u003eColumn name.\u003c/p\u003e", - "maxLength": 128, + "maxLength": 127, "minLength": 1, "type": "string" }, @@ -45,7 +45,7 @@ "properties": { "ColumnName": { "description": "\u003cp\u003eColumn name.\u003c/p\u003e", - "maxLength": 128, + "maxLength": 127, "minLength": 1, "type": "string" }, @@ -59,7 +59,7 @@ "$ref": "#/definitions/ColumnDataType" }, "SubType": { - "$ref": "#/definitions/ColumnSubDataType" + "$ref": "#/definitions/ColumnDataSubType" } }, "required": [ @@ -68,6 +68,13 @@ ], "type": "object" }, + "ColumnDataSubType": { + "enum": [ + "FLOAT", + "FIXED" + ], + "type": "string" + }, "ColumnDataType": { "enum": [ "STRING", @@ -102,8 +109,10 @@ }, "ColumnLevelPermissionRule": { "additionalProperties": false, + "description": "\u003cp\u003eA rule defined to grant access on one or more restricted columns.\n Each dataset can have multiple rules.\n To create a restricted column, you add it to one or more rules.\n Each rule must contain at least one column and at least one user or group.\n To be able to see a restricted column, a user or group needs to be added\n to a rule for that column.\u003c/p\u003e", "properties": { "ColumnNames": { + "description": "\u003cp\u003eAn array of column names.\u003c/p\u003e", "items": { "type": "string" }, @@ -111,6 +120,7 @@ "type": "array" }, "Principals": { + "description": "\u003cp\u003eAn array of Amazon Resource Names (ARNs) for Amazon QuickSight users or groups.\u003c/p\u003e", "items": { "type": "string" }, @@ -121,16 +131,9 @@ }, "type": "object" }, - "ColumnSubDataType": { - "enum": [ - "FIXED", - "FLOAT" - ], - "type": "string" - }, "ColumnTag": { "additionalProperties": false, - "description": "\u003cp\u003eA tag for a column in a \u003ca\u003eTagColumnOperation\u003c/a\u003e structure. This is a\n variant type structure. For this structure to be valid, only one of the attributes can\n be non-null.\u003c/p\u003e", + "description": "\u003cp\u003eA tag for a column in a\n \u003ccode\u003e\n \u003ca href=\"https://docs.aws.amazon.com/quicksight/latest/APIReference/API_TagColumnOperation.html\"\u003eTagColumnOperation\u003c/a\u003e\n \u003c/code\u003e\n structure. This is a\n variant type structure. For this structure to be valid, only one of the attributes can\n be non-null.\u003c/p\u003e", "properties": { "ColumnDescription": { "$ref": "#/definitions/ColumnDescription" @@ -141,6 +144,13 @@ }, "type": "object" }, + "ColumnTagName": { + "enum": [ + "COLUMN_GEOGRAPHIC_ROLE", + "COLUMN_DESCRIPTION" + ], + "type": "string" + }, "CreateColumnsOperation": { "additionalProperties": false, "description": "\u003cp\u003eA transform operation that creates calculated columns. Columns created in one such\n operation form a lexical closure.\u003c/p\u003e", @@ -185,7 +195,7 @@ }, "SqlQuery": { "description": "\u003cp\u003eThe SQL query.\u003c/p\u003e", - "maxLength": 65536, + "maxLength": 168000, "minLength": 1, "type": "string" } @@ -207,22 +217,29 @@ }, "DataSetRefreshProperties": { "additionalProperties": false, - "description": "\u003cp\u003eThe dataset refresh properties for the dataset.\u003c/p\u003e", + "description": "\u003cp\u003eThe refresh properties of a dataset.\u003c/p\u003e", "properties": { "RefreshConfiguration": { "$ref": "#/definitions/RefreshConfiguration" } }, + "required": [ + "RefreshConfiguration" + ], "type": "object" }, "DataSetUsageConfiguration": { "additionalProperties": false, - "description": "\u003cp\u003eThe dataset usage configuration for the dataset.\u003c/p\u003e", + "description": "\u003cp\u003eThe usage configuration to apply to child datasets that reference this dataset as a source.\u003c/p\u003e", "properties": { "DisableUseAsDirectQuerySource": { + "default": false, + "description": "\u003cp\u003eAn option that controls whether a child dataset of a direct query can use this dataset as a source.\u003c/p\u003e", "type": "boolean" }, "DisableUseAsImportedSource": { + "default": false, + "description": "\u003cp\u003eAn option that controls whether a child dataset that's stored in QuickSight can use this dataset as a source.\u003c/p\u003e", "type": "boolean" } }, @@ -230,7 +247,7 @@ }, "DatasetParameter": { "additionalProperties": false, - "description": "\u003cp\u003eA parameter created in the dataset that could be of any one data type such as string, integer, decimal or datetime.\u003c/p\u003e", + "description": "\u003cp\u003eA dataset parameter.\u003c/p\u003e", "properties": { "DateTimeDatasetParameter": { "$ref": "#/definitions/DateTimeDatasetParameter" @@ -247,22 +264,7 @@ }, "type": "object" }, - "DatasetParameterId": { - "description": "\u003cp\u003eIdentifier of the parameter created in the dataset.\u003c/p\u003e", - "maxLength": 128, - "minLength": 1, - "pattern": "^[a-zA-Z0-9-]+$", - "type": "string" - }, - "DatasetParameterName": { - "description": "\u003cp\u003eName of the parameter created in the dataset.\u003c/p\u003e", - "maxLength": 2048, - "minLength": 1, - "pattern": "^[a-zA-Z0-9]+$", - "type": "string" - }, "DatasetParameterValueType": { - "description": "\u003cp\u003eEvery parameter value could be either a single value or multi value which helps to validate before evaluation.\u003c/p\u003e", "enum": [ "MULTI_VALUED", "SINGLE_VALUED" @@ -271,16 +273,24 @@ }, "DateTimeDatasetParameter": { "additionalProperties": false, - "description": "\u003cp\u003eA parameter created in the dataset of date time data type.\u003c/p\u003e", + "description": "\u003cp\u003eA date time parameter for a dataset.\u003c/p\u003e", "properties": { "DefaultValues": { "$ref": "#/definitions/DateTimeDatasetParameterDefaultValues" }, "Id": { - "$ref": "#/definitions/DatasetParameterId" + "description": "\u003cp\u003eAn identifier for the parameter that is created in the dataset.\u003c/p\u003e", + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z0-9-]+$", + "type": "string" }, "Name": { - "$ref": "#/definitions/DatasetParameterName" + "description": "\u003cp\u003eThe name of the date time parameter that is created in the dataset.\u003c/p\u003e", + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" }, "TimeGranularity": { "$ref": "#/definitions/TimeGranularity" @@ -298,36 +308,41 @@ }, "DateTimeDatasetParameterDefaultValues": { "additionalProperties": false, - "description": "\u003cp\u003eList of default values defined for a given string date time parameter type. Currently only static values are supported.\u003c/p\u003e", + "description": "\u003cp\u003eThe default values of a date time parameter.\u003c/p\u003e", "properties": { "StaticValues": { - "$ref": "#/definitions/DateTimeDatasetParameterValueList", - "description": "\u003cp\u003eList of static default values defined for a given string date time parameter type.\u003c/p\u003e" + "description": "\u003cp\u003eA list of static default values for a given date time parameter.\u003c/p\u003e", + "items": { + "description": "\u003cp\u003eThe default value for the date time parameter.\u003c/p\u003e", + "type": "string" + }, + "maxItems": 32, + "minItems": 0, + "type": "array" } }, "type": "object" }, - "DateTimeDatasetParameterValueList": { - "items": { - "description": "\u003cp\u003eDefault value defined for the dataset parameter of date time type.\u003c/p\u003e", - "type": "string" - }, - "maxItems": 32, - "minItems": 1, - "type": "array" - }, "DecimalDatasetParameter": { "additionalProperties": false, - "description": "\u003cp\u003eA parameter created in the dataset of decimal data type.\u003c/p\u003e", + "description": "\u003cp\u003eA decimal parameter for a dataset.\u003c/p\u003e", "properties": { "DefaultValues": { "$ref": "#/definitions/DecimalDatasetParameterDefaultValues" }, "Id": { - "$ref": "#/definitions/DatasetParameterId" + "description": "\u003cp\u003eAn identifier for the decimal parameter created in the dataset.\u003c/p\u003e", + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z0-9-]+$", + "type": "string" }, "Name": { - "$ref": "#/definitions/DatasetParameterName" + "description": "\u003cp\u003eThe name of the decimal parameter that is created in the dataset.\u003c/p\u003e", + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" }, "ValueType": { "$ref": "#/definitions/DatasetParameterValueType" @@ -342,28 +357,28 @@ }, "DecimalDatasetParameterDefaultValues": { "additionalProperties": false, - "description": "\u003cp\u003eList of default values defined for a given decimal dataset parameter type. Currently only static values are supported.\u003c/p\u003e", + "description": "\u003cp\u003eThe default values of a decimal parameter.\u003c/p\u003e", "properties": { "StaticValues": { - "$ref": "#/definitions/DecimalDatasetParameterValueList", - "description": "\u003cp\u003eList of static default values defined for a given decimal dataset parameter type.\u003c/p\u003e" + "description": "\u003cp\u003eA list of static default values for a given decimal parameter.\u003c/p\u003e", + "items": { + "default": 0, + "description": "\u003cp\u003eThe default value for the decimal parameter.\u003c/p\u003e", + "type": "number" + }, + "maxItems": 32, + "minItems": 0, + "type": "array" } }, "type": "object" }, - "DecimalDatasetParameterValueList": { - "items": { - "description": "\u003cp\u003eDefault value defined for the dataset parameter of decimal type.\u003c/p\u003e", - "type": "number" - }, - "maxItems": 32, - "minItems": 1, - "type": "array" - }, "FieldFolder": { "additionalProperties": false, + "description": "\u003cp\u003eA FieldFolder element is a folder that contains fields and nested subfolders.\u003c/p\u003e", "properties": { "Columns": { + "description": "\u003cp\u003eA folder has a list of columns. A column can only be in one folder.\u003c/p\u003e", "items": { "type": "string" }, @@ -372,6 +387,7 @@ "type": "array" }, "Description": { + "description": "\u003cp\u003eThe description for a field folder.\u003c/p\u003e", "maxLength": 500, "minLength": 0, "type": "string" @@ -422,7 +438,7 @@ "Columns": { "description": "\u003cp\u003eColumns in this hierarchy.\u003c/p\u003e", "items": { - "maxLength": 128, + "maxLength": 127, "minLength": 1, "type": "string" }, @@ -461,18 +477,24 @@ "POSTCODE", "LONGITUDE", "LATITUDE", - "POLITICAL1" + "POLITICAL1", + "CENSUS_TRACT", + "CENSUS_BLOCK_GROUP", + "CENSUS_BLOCK" ], "type": "string" }, "IncrementalRefresh": { "additionalProperties": false, - "description": "\u003cp\u003eIncremental Refresh\u003c/p\u003e", + "description": "\u003cp\u003eThe incremental refresh configuration for a dataset.\u003c/p\u003e", "properties": { "LookbackWindow": { "$ref": "#/definitions/LookbackWindow" } }, + "required": [ + "LookbackWindow" + ], "type": "object" }, "IngestionWaitPolicy": { @@ -500,12 +522,12 @@ "properties": { "Name": { "description": "\u003cp\u003eThe name of this column in the underlying data source.\u003c/p\u003e", - "maxLength": 128, + "maxLength": 127, "minLength": 1, "type": "string" }, "SubType": { - "$ref": "#/definitions/ColumnSubDataType" + "$ref": "#/definitions/ColumnDataSubType" }, "Type": { "$ref": "#/definitions/InputColumnDataType" @@ -531,16 +553,24 @@ }, "IntegerDatasetParameter": { "additionalProperties": false, - "description": "\u003cp\u003eA parameter created in the dataset of integer data type.\u003c/p\u003e", + "description": "\u003cp\u003eAn integer parameter for a dataset.\u003c/p\u003e", "properties": { "DefaultValues": { "$ref": "#/definitions/IntegerDatasetParameterDefaultValues" }, "Id": { - "$ref": "#/definitions/DatasetParameterId" + "description": "\u003cp\u003eAn identifier for the integer parameter created in the dataset.\u003c/p\u003e", + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z0-9-]+$", + "type": "string" }, "Name": { - "$ref": "#/definitions/DatasetParameterName" + "description": "\u003cp\u003eThe name of the integer parameter that is created in the dataset.\u003c/p\u003e", + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" }, "ValueType": { "$ref": "#/definitions/DatasetParameterValueType" @@ -555,40 +585,38 @@ }, "IntegerDatasetParameterDefaultValues": { "additionalProperties": false, - "description": "\u003cp\u003eList of default values defined for a given integer dataset parameter type. Currently only static values are supported.\u003c/p\u003e", + "description": "\u003cp\u003eThe default values of an integer parameter.\u003c/p\u003e", "properties": { "StaticValues": { - "$ref": "#/definitions/IntegerDatasetParameterValueList", - "description": "\u003cp\u003eList of static default values defined for a given integer dataset parameter type.\u003c/p\u003e" + "description": "\u003cp\u003eA list of static default values for a given integer parameter.\u003c/p\u003e", + "items": { + "default": 0, + "description": "\u003cp\u003eThe default value for the integer parameter.\u003c/p\u003e", + "type": "number" + }, + "maxItems": 32, + "minItems": 0, + "type": "array" } }, "type": "object" }, - "IntegerDatasetParameterValueList": { - "items": { - "description": "\u003cp\u003eDefault value defined for the dataset parameter of integer type.\u003c/p\u003e", - "type": "number" - }, - "maxItems": 32, - "minItems": 1, - "type": "array" - }, "JoinInstruction": { "additionalProperties": false, - "description": "\u003cp\u003eJoin instruction.\u003c/p\u003e", + "description": "\u003cp\u003eThe instructions associated with a join. \u003c/p\u003e", "properties": { "LeftJoinKeyProperties": { "$ref": "#/definitions/JoinKeyProperties" }, "LeftOperand": { - "description": "\u003cp\u003eLeft operand.\u003c/p\u003e", + "description": "\u003cp\u003eThe operand on the left side of a join.\u003c/p\u003e", "maxLength": 64, "minLength": 1, - "pattern": "[0-9a-zA-Z-]*", + "pattern": "^[0-9a-zA-Z-]*$", "type": "string" }, "OnClause": { - "description": "\u003cp\u003eOn Clause.\u003c/p\u003e", + "description": "\u003cp\u003eThe join instructions provided in the \u003ccode\u003eON\u003c/code\u003e clause of a join.\u003c/p\u003e", "maxLength": 512, "minLength": 1, "type": "string" @@ -597,10 +625,10 @@ "$ref": "#/definitions/JoinKeyProperties" }, "RightOperand": { - "description": "\u003cp\u003eRight operand.\u003c/p\u003e", + "description": "\u003cp\u003eThe operand on the right side of a join.\u003c/p\u003e", "maxLength": 64, "minLength": 1, - "pattern": "[0-9a-zA-Z-]*", + "pattern": "^[0-9a-zA-Z-]*$", "type": "string" }, "Type": { @@ -617,8 +645,10 @@ }, "JoinKeyProperties": { "additionalProperties": false, + "description": "\u003cp\u003eProperties associated with the columns participating in a join.\u003c/p\u003e", "properties": { "UniqueKey": { + "description": "\u003cp\u003eA value that indicates that a row in a table is uniquely identified by the columns in\n a join key. This is used by Amazon QuickSight to optimize query performance.\u003c/p\u003e", "type": "boolean" } }, @@ -644,7 +674,7 @@ "type": "string" }, "DataTransforms": { - "description": "\u003cp\u003eTransform operations that act on this logical table.\u003c/p\u003e", + "description": "\u003cp\u003eTransform operations that act on this logical table. For this structure to be valid, only one of the attributes can be non-null. \u003c/p\u003e", "items": { "$ref": "#/definitions/TransformOperation" }, @@ -667,7 +697,7 @@ "maxProperties": 64, "minProperties": 1, "patternProperties": { - "[0-9a-zA-Z-]*": { + "^[0-9a-zA-Z-]*$": { "$ref": "#/definitions/LogicalTable" } }, @@ -678,7 +708,7 @@ "description": "\u003cp\u003eInformation about the source of a logical table. This is a variant type structure. For\n this structure to be valid, only one of the attributes can be non-null.\u003c/p\u003e", "properties": { "DataSetArn": { - "description": "\u003cp\u003eThe Amazon Resource Name (ARN) for the dataset.\u003c/p\u003e", + "description": "\u003cp\u003eThe Amazon Resource Number (ARN) of the parent dataset.\u003c/p\u003e", "type": "string" }, "JoinInstruction": { @@ -688,7 +718,7 @@ "description": "\u003cp\u003ePhysical table ID.\u003c/p\u003e", "maxLength": 64, "minLength": 1, - "pattern": "[0-9a-zA-Z-]*", + "pattern": "^[0-9a-zA-Z-]*$", "type": "string" } }, @@ -696,36 +726,84 @@ }, "LookbackWindow": { "additionalProperties": false, + "description": "\u003cp\u003eThe lookback window setup of an incremental refresh configuration.\u003c/p\u003e", "properties": { "ColumnName": { - "description": "\u003cp\u003eColumn Name\u003c/p\u003e", + "description": "\u003cp\u003eThe name of the lookback window column.\u003c/p\u003e", "type": "string" }, "Size": { - "description": "\u003cp\u003eSize\u003c/p\u003e", + "default": 0, + "description": "\u003cp\u003eThe lookback window column size.\u003c/p\u003e", "minimum": 1, "type": "number" }, "SizeUnit": { - "$ref": "#/definitions/SizeUnit" + "$ref": "#/definitions/LookbackWindowSizeUnit" } }, + "required": [ + "ColumnName", + "Size", + "SizeUnit" + ], "type": "object" }, + "LookbackWindowSizeUnit": { + "enum": [ + "HOUR", + "DAY", + "WEEK" + ], + "type": "string" + }, "NewDefaultValues": { "additionalProperties": false, + "description": "\u003cp\u003eThe configuration that overrides the existing default values for a dataset parameter that is inherited from another dataset.\u003c/p\u003e", "properties": { "DateTimeStaticValues": { - "$ref": "#/definitions/DateTimeDatasetParameterValueList" + "description": "\u003cp\u003eA list of static default values for a given date time parameter.\u003c/p\u003e", + "items": { + "description": "\u003cp\u003eThe default value for the date time parameter.\u003c/p\u003e", + "type": "string" + }, + "maxItems": 32, + "minItems": 0, + "type": "array" }, "DecimalStaticValues": { - "$ref": "#/definitions/DecimalDatasetParameterValueList" + "description": "\u003cp\u003eA list of static default values for a given decimal parameter.\u003c/p\u003e", + "items": { + "default": 0, + "description": "\u003cp\u003eThe default value for the decimal parameter.\u003c/p\u003e", + "type": "number" + }, + "maxItems": 32, + "minItems": 0, + "type": "array" }, "IntegerStaticValues": { - "$ref": "#/definitions/IntegerDatasetParameterValueList" + "description": "\u003cp\u003eA list of static default values for a given integer parameter.\u003c/p\u003e", + "items": { + "default": 0, + "description": "\u003cp\u003eThe default value for the integer parameter.\u003c/p\u003e", + "type": "number" + }, + "maxItems": 32, + "minItems": 0, + "type": "array" }, "StringStaticValues": { - "$ref": "#/definitions/StringDatasetParameterValueList" + "description": "\u003cp\u003eA list of static default values for a given string parameter.\u003c/p\u003e", + "items": { + "description": "\u003cp\u003eThe default value for the string parameter.\u003c/p\u003e", + "maxLength": 512, + "minLength": 0, + "type": "string" + }, + "maxItems": 32, + "minItems": 0, + "type": "array" } }, "type": "object" @@ -741,13 +819,13 @@ "type": "string" }, "Name": { - "description": "\u003cp\u003eA display name for the dataset.\u003c/p\u003e", - "maxLength": 128, + "description": "\u003cp\u003eThe display name of the column..\u003c/p\u003e", + "maxLength": 127, "minLength": 1, "type": "string" }, "SubType": { - "$ref": "#/definitions/ColumnSubDataType" + "$ref": "#/definitions/ColumnDataSubType" }, "Type": { "$ref": "#/definitions/ColumnDataType" @@ -757,19 +835,24 @@ }, "OverrideDatasetParameterOperation": { "additionalProperties": false, - "description": "\u003cp\u003eA transform operation that overrides the dataset parameter values defined in another dataset.\u003c/p\u003e", + "description": "\u003cp\u003eA transform operation that overrides the dataset parameter values that are defined in another dataset.\u003c/p\u003e", "properties": { "NewDefaultValues": { - "$ref": "#/definitions/NewDefaultValues", - "description": "\u003cp\u003eThe new default values for the parameter.\u003c/p\u003e" + "$ref": "#/definitions/NewDefaultValues" }, "NewParameterName": { - "$ref": "#/definitions/DatasetParameterName", - "description": "\u003cp\u003eThe new name for the parameter.\u003c/p\u003e" + "description": "\u003cp\u003eThe new name for the parameter.\u003c/p\u003e", + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" }, "ParameterName": { - "$ref": "#/definitions/DatasetParameterName", - "description": "\u003cp\u003eThe name of the parameter to be overridden with different values.\u003c/p\u003e" + "description": "\u003cp\u003eThe name of the parameter to be overridden with different values.\u003c/p\u003e", + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" } }, "required": [ @@ -798,7 +881,7 @@ "maxProperties": 32, "minProperties": 0, "patternProperties": { - "[0-9a-zA-Z-]*": { + "^[0-9a-zA-Z-]*$": { "$ref": "#/definitions/PhysicalTable" } }, @@ -825,12 +908,15 @@ }, "RefreshConfiguration": { "additionalProperties": false, - "description": "\u003cp\u003e Refresh Configuration.\u003c/p\u003e", + "description": "\u003cp\u003eThe refresh configuration of a dataset.\u003c/p\u003e", "properties": { "IncrementalRefresh": { "$ref": "#/definitions/IncrementalRefresh" } }, + "required": [ + "IncrementalRefresh" + ], "type": "object" }, "RelationalTable": { @@ -858,13 +944,13 @@ }, "Name": { "description": "\u003cp\u003eThe name of the relational table.\u003c/p\u003e", - "maxLength": 64, + "maxLength": 256, "minLength": 1, "type": "string" }, "Schema": { "description": "\u003cp\u003eThe schema name. This name applies to certain relational database engines.\u003c/p\u003e", - "maxLength": 64, + "maxLength": 256, "minLength": 0, "type": "string" } @@ -882,13 +968,13 @@ "properties": { "ColumnName": { "description": "\u003cp\u003eThe name of the column to be renamed.\u003c/p\u003e", - "maxLength": 128, + "maxLength": 127, "minLength": 1, "type": "string" }, "NewColumnName": { "description": "\u003cp\u003eThe new name for the column.\u003c/p\u003e", - "maxLength": 128, + "maxLength": 127, "minLength": 1, "type": "string" } @@ -913,7 +999,7 @@ "type": "array" }, "Principal": { - "description": "\u003cp\u003eThe Amazon Resource Name (ARN) of the principal. This can be one of the\n following:\u003c/p\u003e\n \u003cul\u003e\n \u003cli\u003e\n \u003cp\u003eThe ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)\u003c/p\u003e\n \u003c/li\u003e\n \u003cli\u003e\n \u003cp\u003eThe ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)\u003c/p\u003e\n \u003c/li\u003e\n \u003cli\u003e\n \u003cp\u003eThe ARN of an AWS account root: This is an IAM ARN rather than a QuickSight\n ARN. Use this option only to share resources (templates) across AWS accounts.\n (This is less common.) \u003c/p\u003e\n \u003c/li\u003e\n \u003c/ul\u003e", + "description": "\u003cp\u003eThe Amazon Resource Name (ARN) of the principal. This can be one of the\n following:\u003c/p\u003e\n \u003cul\u003e\n \u003cli\u003e\n \u003cp\u003eThe ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)\u003c/p\u003e\n \u003c/li\u003e\n \u003cli\u003e\n \u003cp\u003eThe ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)\u003c/p\u003e\n \u003c/li\u003e\n \u003cli\u003e\n \u003cp\u003eThe ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight\n ARN. Use this option only to share resources (templates) across Amazon Web Services accounts.\n (This is less common.) \u003c/p\u003e\n \u003c/li\u003e\n \u003c/ul\u003e", "maxLength": 256, "minLength": 1, "type": "string" @@ -927,17 +1013,17 @@ }, "RowLevelPermissionDataSet": { "additionalProperties": false, - "description": "\u003cp\u003eThe row-level security configuration for the dataset.\u003c/p\u003e", + "description": "\u003cp\u003eInformation about a dataset that contains permissions for row-level security (RLS).\n The permissions dataset maps fields to users or groups. For more information, see\n \u003ca href=\"https://docs.aws.amazon.com/quicksight/latest/user/restrict-access-to-a-data-set-using-row-level-security.html\"\u003eUsing Row-Level Security (RLS) to Restrict Access to a Dataset\u003c/a\u003e in the \u003ci\u003eAmazon QuickSight User\n Guide\u003c/i\u003e.\u003c/p\u003e\n \u003cp\u003eThe option to deny permissions by setting \u003ccode\u003ePermissionPolicy\u003c/code\u003e to \u003ccode\u003eDENY_ACCESS\u003c/code\u003e is\n not supported for new RLS datasets.\u003c/p\u003e", "properties": { "Arn": { - "description": "\u003cp\u003eThe Amazon Resource Name (ARN) of the permission dataset.\u003c/p\u003e", + "description": "\u003cp\u003eThe Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.\u003c/p\u003e", "type": "string" }, "FormatVersion": { "$ref": "#/definitions/RowLevelPermissionFormatVersion" }, "Namespace": { - "description": "\u003cp\u003eThe namespace associated with the row-level permissions dataset.\u003c/p\u003e", + "description": "\u003cp\u003eThe namespace associated with the dataset that contains permissions for RLS.\u003c/p\u003e", "maxLength": 64, "minLength": 0, "pattern": "^[a-zA-Z0-9._-]*$", @@ -972,7 +1058,7 @@ }, "RowLevelPermissionTagConfiguration": { "additionalProperties": false, - "description": "\u003cp\u003eThe configuration of tags on a dataset to set row-level security.\u003c/p\u003e", + "description": "\u003cp\u003eThe configuration of tags on a dataset to set row-level security. \u003c/p\u003e", "properties": { "Status": { "$ref": "#/definitions/Status" @@ -980,7 +1066,14 @@ "TagRuleConfigurations": { "description": "\u003cp\u003eA list of tag configuration rules to apply to a dataset. All tag configurations have the OR condition. Tags within each tile will be joined (AND). At least one rule in this structure must have all tag values assigned to it to apply Row-level security (RLS) to the dataset.\u003c/p\u003e", "items": { - "$ref": "#/definitions/RowLevelPermissionTagRuleConfiguration" + "items": { + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "maxItems": 50, + "minItems": 1, + "type": "array" }, "maxItems": 50, "minItems": 1, @@ -1003,7 +1096,7 @@ }, "RowLevelPermissionTagRule": { "additionalProperties": false, - "description": "\u003cp\u003ePermission for the resource.\u003c/p\u003e", + "description": "\u003cp\u003eA set of rules associated with a tag.\u003c/p\u003e", "properties": { "ColumnName": { "description": "\u003cp\u003eThe column name that a tag key is assigned to.\u003c/p\u003e", @@ -1024,6 +1117,7 @@ "TagMultiValueDelimiter": { "description": "\u003cp\u003eA 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.\u003c/p\u003e", "maxLength": 10, + "minLength": 0, "type": "string" } }, @@ -1033,26 +1127,16 @@ ], "type": "object" }, - "RowLevelPermissionTagRuleConfiguration": { - "items": { - "maxLength": 128, - "minLength": 1, - "type": "string" - }, - "maxItems": 50, - "minItems": 1, - "type": "array" - }, "S3Source": { "additionalProperties": false, - "description": "\u003cp\u003eA physical table type for as S3 data source.\u003c/p\u003e", + "description": "\u003cp\u003eA physical table type for an S3 data source.\u003c/p\u003e", "properties": { "DataSourceArn": { - "description": "\u003cp\u003eThe amazon Resource Name (ARN) for the data source.\u003c/p\u003e", + "description": "\u003cp\u003eThe Amazon Resource Name (ARN) for the data source.\u003c/p\u003e", "type": "string" }, "InputColumns": { - "description": "\u003cp\u003eA physical table type for as S3 data source.\u003c/p\u003e", + "description": "\u003cp\u003eA physical table type for an S3 data source.\u003c/p\u003e\n \u003cnote\u003e\n \u003cp\u003eFor files that aren't JSON, only \u003ccode\u003eSTRING\u003c/code\u003e data types are supported in input columns.\u003c/p\u003e\n \u003c/note\u003e", "items": { "$ref": "#/definitions/InputColumn" }, @@ -1070,14 +1154,6 @@ ], "type": "object" }, - "SizeUnit": { - "enum": [ - "HOUR", - "DAY", - "WEEK" - ], - "type": "string" - }, "Status": { "enum": [ "ENABLED", @@ -1087,16 +1163,24 @@ }, "StringDatasetParameter": { "additionalProperties": false, - "description": "\u003cp\u003eA parameter created in the dataset of string data type.\u003c/p\u003e", + "description": "\u003cp\u003eA string parameter for a dataset.\u003c/p\u003e", "properties": { "DefaultValues": { "$ref": "#/definitions/StringDatasetParameterDefaultValues" }, "Id": { - "$ref": "#/definitions/DatasetParameterId" + "description": "\u003cp\u003eAn identifier for the string parameter that is created in the dataset.\u003c/p\u003e", + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z0-9-]+$", + "type": "string" }, "Name": { - "$ref": "#/definitions/DatasetParameterName" + "description": "\u003cp\u003eThe name of the string parameter that is created in the dataset.\u003c/p\u003e", + "maxLength": 2048, + "minLength": 1, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" }, "ValueType": { "$ref": "#/definitions/DatasetParameterValueType" @@ -1111,24 +1195,23 @@ }, "StringDatasetParameterDefaultValues": { "additionalProperties": false, - "description": "\u003cp\u003eList of default values defined for a given string dataset parameter type. Currently only static values are supported.\u003c/p\u003e", + "description": "\u003cp\u003eThe default values of a string parameter.\u003c/p\u003e", "properties": { "StaticValues": { - "$ref": "#/definitions/StringDatasetParameterValueList", - "description": "\u003cp\u003eList of static default values defined for a given string dataset parameter type.\u003c/p\u003e" + "description": "\u003cp\u003eA list of static default values for a given string parameter.\u003c/p\u003e", + "items": { + "description": "\u003cp\u003eThe default value for the string parameter.\u003c/p\u003e", + "maxLength": 512, + "minLength": 0, + "type": "string" + }, + "maxItems": 32, + "minItems": 0, + "type": "array" } }, "type": "object" }, - "StringDatasetParameterValueList": { - "items": { - "description": "\u003cp\u003eDefault value defined for the dataset parameter of string type.\u003c/p\u003e", - "type": "string" - }, - "maxItems": 32, - "minItems": 1, - "type": "array" - }, "Tag": { "additionalProperties": false, "description": "\u003cp\u003eThe key or keys of the key-value pairs for the resource tag or tags assigned to the\n resource.\u003c/p\u003e", @@ -1158,12 +1241,12 @@ "properties": { "ColumnName": { "description": "\u003cp\u003eThe column that this operation acts on.\u003c/p\u003e", - "maxLength": 128, + "maxLength": 127, "minLength": 1, "type": "string" }, "Tags": { - "description": "\u003cp\u003eThe dataset column tag, currently only used for geospatial type tagging. .\u003c/p\u003e\n \u003cnote\u003e\n \u003cp\u003eThis is not tags for the AWS tagging feature. .\u003c/p\u003e\n \u003c/note\u003e", + "description": "\u003cp\u003eThe dataset column tag, currently only used for geospatial type tagging.\u003c/p\u003e\n \u003cnote\u003e\n \u003cp\u003eThis is not tags for the Amazon Web Services tagging feature.\u003c/p\u003e\n \u003c/note\u003e", "items": { "$ref": "#/definitions/ColumnTag" }, @@ -1223,8 +1306,35 @@ }, "TagColumnOperation": { "$ref": "#/definitions/TagColumnOperation" + }, + "UntagColumnOperation": { + "$ref": "#/definitions/UntagColumnOperation" + } + }, + "type": "object" + }, + "UntagColumnOperation": { + "additionalProperties": false, + "description": "\u003cp\u003eA transform operation that removes tags associated with a column.\u003c/p\u003e", + "properties": { + "ColumnName": { + "description": "\u003cp\u003eThe column that this operation acts on.\u003c/p\u003e", + "maxLength": 127, + "minLength": 1, + "type": "string" + }, + "TagNames": { + "description": "\u003cp\u003eThe column tags to remove from this column.\u003c/p\u003e", + "items": { + "$ref": "#/definitions/ColumnTagName" + }, + "type": "array" } }, + "required": [ + "ColumnName", + "TagNames" + ], "type": "object" }, "UploadSettings": { @@ -1333,7 +1443,7 @@ "type": "string" }, "ColumnGroups": { - "description": "\u003cp\u003eGroupings of columns that work together in certain QuickSight features. Currently, only geospatial hierarchy is supported.\u003c/p\u003e", + "description": "\u003cp\u003eGroupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.\u003c/p\u003e", "items": { "$ref": "#/definitions/ColumnGroup" }, @@ -1342,6 +1452,7 @@ "type": "array" }, "ColumnLevelPermissionRules": { + "description": "\u003cp\u003eA set of one or more definitions of a \u003ccode\u003e\n \u003ca href=\"https://docs.aws.amazon.com/quicksight/latest/APIReference/API_ColumnLevelPermissionRule.html\"\u003eColumnLevelPermissionRule\u003c/a\u003e\n \u003c/code\u003e.\u003c/p\u003e", "items": { "$ref": "#/definitions/ColumnLevelPermissionRule" }, @@ -1349,6 +1460,7 @@ "type": "array" }, "ConsumedSpiceCapacityInBytes": { + "default": 0, "description": "\u003cp\u003eThe amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't\n imported into SPICE.\u003c/p\u003e", "type": "number" }, @@ -1367,12 +1479,12 @@ "$ref": "#/definitions/DataSetUsageConfiguration" }, "DatasetParameters": { - "description": "\u003cp\u003eThe parameters declared in the dataset.\u003c/p\u003e", + "description": "\u003cp\u003eThe parameter declarations of the dataset.\u003c/p\u003e", "items": { "$ref": "#/definitions/DatasetParameter" }, "maxItems": 32, - "minItems": 1, + "minItems": 0, "type": "array" }, "FieldFolders": { @@ -1440,6 +1552,13 @@ "/properties/LastUpdatedTime", "/properties/OutputColumns" ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, "typeName": "AWS::QuickSight::DataSet", "writeOnlyProperties": [ "/properties/FieldFolders", diff --git a/artifacts/types/AWS::QuickSight::DataSource.json b/artifacts/types/AWS::QuickSight::DataSource.json index 5d1b72da..c9328935 100644 --- a/artifacts/types/AWS::QuickSight::DataSource.json +++ b/artifacts/types/AWS::QuickSight::DataSource.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-QuickSight-DataSource", "type": "AWS::QuickSight::DataSource", - "time": "2023-11-14T16:22:17.291Z", + "time": "2024-05-22T16:51:40.879Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -11,10 +11,11 @@ ], "definitions": { "AmazonElasticsearchParameters": { - "description": "\u003cp\u003eAmazon Elasticsearch Service parameters.\u003c/p\u003e", + "additionalProperties": false, + "description": "\u003cp\u003eThe parameters for OpenSearch.\u003c/p\u003e", "properties": { "Domain": { - "description": "\u003cp\u003eThe Amazon Elasticsearch Service domain.\u003c/p\u003e", + "description": "\u003cp\u003eThe OpenSearch domain.\u003c/p\u003e", "maxLength": 64, "minLength": 1, "type": "string" @@ -26,10 +27,11 @@ "type": "object" }, "AmazonOpenSearchParameters": { - "description": "\u003cp\u003eAmazon OpenSearch Service parameters.\u003c/p\u003e", + "additionalProperties": false, + "description": "\u003cp\u003eThe parameters for OpenSearch.\u003c/p\u003e", "properties": { "Domain": { - "description": "\u003cp\u003eThe Amazon OpenSearch Service domain.\u003c/p\u003e", + "description": "\u003cp\u003eThe OpenSearch domain.\u003c/p\u003e", "maxLength": 64, "minLength": 1, "type": "string" @@ -41,7 +43,8 @@ "type": "object" }, "AthenaParameters": { - "description": "\u003cp\u003eAmazon Athena parameters.\u003c/p\u003e", + "additionalProperties": false, + "description": "\u003cp\u003eParameters for Amazon Athena.\u003c/p\u003e", "properties": { "RoleArn": { "description": "\u003cp\u003eUse the \u003ccode\u003eRoleArn\u003c/code\u003e 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 \u003ccode\u003eRoleArn\u003c/code\u003e 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.\u003c/p\u003e", @@ -59,7 +62,8 @@ "type": "object" }, "AuroraParameters": { - "description": "\u003cp\u003eAmazon Aurora parameters.\u003c/p\u003e", + "additionalProperties": false, + "description": "\u003cp\u003eParameters for Amazon Aurora.\u003c/p\u003e", "properties": { "Database": { "description": "\u003cp\u003eDatabase.\u003c/p\u003e", @@ -74,6 +78,7 @@ "type": "string" }, "Port": { + "default": 0, "description": "\u003cp\u003ePort.\u003c/p\u003e", "maximum": 65535, "minimum": 1, @@ -88,22 +93,24 @@ "type": "object" }, "AuroraPostgreSqlParameters": { - "description": "\u003cp\u003eAmazon Aurora with PostgreSQL compatibility parameters.\u003c/p\u003e", + "additionalProperties": false, + "description": "\u003cp\u003eParameters for Amazon Aurora PostgreSQL-Compatible Edition.\u003c/p\u003e", "properties": { "Database": { - "description": "\u003cp\u003eDatabase.\u003c/p\u003e", + "description": "\u003cp\u003eThe Amazon Aurora PostgreSQL database to connect to.\u003c/p\u003e", "maxLength": 128, "minLength": 1, "type": "string" }, "Host": { - "description": "\u003cp\u003eHost.\u003c/p\u003e", + "description": "\u003cp\u003eThe Amazon Aurora PostgreSQL-Compatible host to connect to.\u003c/p\u003e", "maxLength": 256, "minLength": 1, "type": "string" }, "Port": { - "description": "\u003cp\u003ePort.\u003c/p\u003e", + "default": 0, + "description": "\u003cp\u003eThe port that Amazon Aurora PostgreSQL is listening on.\u003c/p\u003e", "maximum": 65535, "minimum": 1, "type": "number" @@ -117,7 +124,8 @@ "type": "object" }, "AwsIotAnalyticsParameters": { - "description": "\u003cp\u003eAWS IoT Analytics parameters.\u003c/p\u003e", + "additionalProperties": false, + "description": "\u003cp\u003eThe parameters for IoT Analytics.\u003c/p\u003e", "properties": { "DataSetName": { "description": "\u003cp\u003eDataset name.\u003c/p\u003e", @@ -132,6 +140,7 @@ "type": "object" }, "CredentialPair": { + "additionalProperties": false, "description": "\u003cp\u003eThe combination of user name and password that are used as credentials.\u003c/p\u003e", "properties": { "AlternateDataSourceParameters": { @@ -163,11 +172,12 @@ "type": "object" }, "DataSourceCredentials": { + "additionalProperties": false, "description": "\u003cp\u003eData source credentials. This is a variant type structure. For this structure to be\n valid, only one of the attributes can be non-null.\u003c/p\u003e", "properties": { "CopySourceArn": { "description": "\u003cp\u003eThe Amazon Resource Name (ARN) of a data source that has the credential pair that you\n want to use. When \u003ccode\u003eCopySourceArn\u003c/code\u003e is not null, the credential pair from the\n data source in the ARN is used as the credentials for the\n \u003ccode\u003eDataSourceCredentials\u003c/code\u003e structure.\u003c/p\u003e", - "pattern": "^arn:[-a-z0-9]*:quicksight:[-a-z0-9]*:[0-9]{12}:datasource/.+", + "pattern": "^arn:[-a-z0-9]*:quicksight:[-a-z0-9]*:[0-9]{12}:datasource/.+$", "type": "string" }, "CredentialPair": { @@ -177,13 +187,14 @@ "description": "\u003cp\u003eThe Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.\u003c/p\u003e", "maxLength": 2048, "minLength": 1, - "pattern": "^arn:[-a-z0-9]*:secretsmanager:[-a-z0-9]*:[0-9]{12}:secret:.+", + "pattern": "^arn:[-a-z0-9]*:secretsmanager:[-a-z0-9]*:[0-9]{12}:secret:.+$", "type": "string" } }, "type": "object" }, "DataSourceErrorInfo": { + "additionalProperties": false, "description": "\u003cp\u003eError information for the data source creation or update.\u003c/p\u003e", "properties": { "Message": { @@ -210,6 +221,7 @@ "type": "string" }, "DataSourceParameters": { + "additionalProperties": false, "description": "\u003cp\u003eThe parameters that Amazon QuickSight uses to connect to your underlying data source.\n This is a variant type structure. For this structure to be valid, only one of the\n attributes can be non-null.\u003c/p\u003e", "properties": { "AmazonElasticsearchParameters": { @@ -285,6 +297,13 @@ "AURORA_POSTGRESQL", "AWS_IOT_ANALYTICS", "DATABRICKS", + "DENODO", + "DREMIO", + "DYNAMODB", + "SAPHANA", + "DB2_AS400", + "EXASOL", + "FILE", "GITHUB", "JIRA", "MARIADB", @@ -300,30 +319,38 @@ "SPARK", "SQLSERVER", "TERADATA", - "TWITTER", "TIMESTREAM", + "TWITTER", + "BIGQUERY", + "GOOGLE_ANALYTICS", + "TRINO", "STARBURST", - "TRINO" + "MONGO", + "MONGO_ATLAS", + "DOCUMENTDB", + "APPFLOW" ], "type": "string" }, "DatabricksParameters": { - "description": "\u003cp\u003eDatabricks parameters.\u003c/p\u003e", + "additionalProperties": false, + "description": "\u003cp\u003eThe parameters that are required to connect to a Databricks data source.\u003c/p\u003e", "properties": { "Host": { - "description": "\u003cp\u003eHost.\u003c/p\u003e", + "description": "\u003cp\u003eThe host name of the Databricks data source.\u003c/p\u003e", "maxLength": 256, "minLength": 1, "type": "string" }, "Port": { - "description": "\u003cp\u003ePort.\u003c/p\u003e", + "default": 0, + "description": "\u003cp\u003eThe port for the Databricks data source.\u003c/p\u003e", "maximum": 65535, "minimum": 1, "type": "number" }, "SqlEndpointPath": { - "description": "\u003cp\u003eThe HTTP Path of the Databricks data source.\u003c/p\u003e", + "description": "\u003cp\u003eThe HTTP path of the Databricks data source.\u003c/p\u003e", "maxLength": 4096, "minLength": 1, "type": "string" @@ -336,7 +363,20 @@ ], "type": "object" }, + "IdentityCenterConfiguration": { + "additionalProperties": false, + "description": "\u003cp\u003eThe parameters for an IAM Identity Center configuration.\u003c/p\u003e", + "properties": { + "EnableIdentityPropagation": { + "default": null, + "description": "\u003cp\u003eA Boolean option that controls whether Trusted Identity Propagation should be used.\u003c/p\u003e", + "type": "boolean" + } + }, + "type": "object" + }, "ManifestFileLocation": { + "additionalProperties": false, "description": "\u003cp\u003eAmazon S3 manifest file location.\u003c/p\u003e", "properties": { "Bucket": { @@ -359,7 +399,8 @@ "type": "object" }, "MariaDbParameters": { - "description": "\u003cp\u003eMariaDB parameters.\u003c/p\u003e", + "additionalProperties": false, + "description": "\u003cp\u003eThe parameters for MariaDB.\u003c/p\u003e", "properties": { "Database": { "description": "\u003cp\u003eDatabase.\u003c/p\u003e", @@ -374,6 +415,7 @@ "type": "string" }, "Port": { + "default": 0, "description": "\u003cp\u003ePort.\u003c/p\u003e", "maximum": 65535, "minimum": 1, @@ -388,7 +430,8 @@ "type": "object" }, "MySqlParameters": { - "description": "\u003cp\u003eMySQL parameters.\u003c/p\u003e", + "additionalProperties": false, + "description": "\u003cp\u003eThe parameters for MySQL.\u003c/p\u003e", "properties": { "Database": { "description": "\u003cp\u003eDatabase.\u003c/p\u003e", @@ -403,6 +446,7 @@ "type": "string" }, "Port": { + "default": 0, "description": "\u003cp\u003ePort.\u003c/p\u003e", "maximum": 65535, "minimum": 1, @@ -417,18 +461,24 @@ "type": "object" }, "OracleParameters": { + "additionalProperties": false, + "description": "\u003cp\u003eThe parameters for Oracle.\u003c/p\u003e", "properties": { "Database": { + "description": "\u003cp\u003eThe database.\u003c/p\u003e", "maxLength": 128, "minLength": 1, "type": "string" }, "Host": { + "description": "\u003cp\u003eAn Oracle host.\u003c/p\u003e", "maxLength": 256, "minLength": 1, "type": "string" }, "Port": { + "default": 0, + "description": "\u003cp\u003eThe port.\u003c/p\u003e", "maximum": 65535, "minimum": 1, "type": "number" @@ -442,7 +492,8 @@ "type": "object" }, "PostgreSqlParameters": { - "description": "\u003cp\u003ePostgreSQL parameters.\u003c/p\u003e", + "additionalProperties": false, + "description": "\u003cp\u003eThe parameters for PostgreSQL.\u003c/p\u003e", "properties": { "Database": { "description": "\u003cp\u003eDatabase.\u003c/p\u003e", @@ -457,6 +508,7 @@ "type": "string" }, "Port": { + "default": 0, "description": "\u003cp\u003ePort.\u003c/p\u003e", "maximum": 65535, "minimum": 1, @@ -471,7 +523,8 @@ "type": "object" }, "PrestoParameters": { - "description": "\u003cp\u003ePresto parameters.\u003c/p\u003e", + "additionalProperties": false, + "description": "\u003cp\u003eThe parameters for Presto.\u003c/p\u003e", "properties": { "Catalog": { "description": "\u003cp\u003eCatalog.\u003c/p\u003e", @@ -486,6 +539,7 @@ "type": "string" }, "Port": { + "default": 0, "description": "\u003cp\u003ePort.\u003c/p\u003e", "maximum": 65535, "minimum": 1, @@ -500,7 +554,8 @@ "type": "object" }, "RdsParameters": { - "description": "\u003cp\u003eAmazon RDS parameters.\u003c/p\u003e", + "additionalProperties": false, + "description": "\u003cp\u003eThe parameters for Amazon RDS.\u003c/p\u003e", "properties": { "Database": { "description": "\u003cp\u003eDatabase.\u003c/p\u003e", @@ -521,8 +576,47 @@ ], "type": "object" }, + "RedshiftIAMParameters": { + "additionalProperties": false, + "description": "\u003cp\u003eA structure that grants Amazon QuickSight access to your cluster and make a call to the \u003ccode\u003eredshift:GetClusterCredentials\u003c/code\u003e API. For more information on the \u003ccode\u003eredshift:GetClusterCredentials\u003c/code\u003e API, see \u003ca href=\"https://docs.aws.amazon.com/redshift/latest/APIReference/API_GetClusterCredentials.html\"\u003e\n \u003ccode\u003eGetClusterCredentials\u003c/code\u003e\n \u003c/a\u003e.\u003c/p\u003e", + "properties": { + "AutoCreateDatabaseUser": { + "default": false, + "description": "\u003cp\u003eAutomatically creates a database user. If your database doesn't have a \u003ccode\u003eDatabaseUser\u003c/code\u003e, set this parameter to \u003ccode\u003eTrue\u003c/code\u003e. If there is no \u003ccode\u003eDatabaseUser\u003c/code\u003e, Amazon QuickSight can't connect to your cluster. The \u003ccode\u003eRoleArn\u003c/code\u003e that you use for this operation must grant access to \u003ccode\u003eredshift:CreateClusterUser\u003c/code\u003e to successfully create the user.\u003c/p\u003e", + "type": "boolean" + }, + "DatabaseGroups": { + "description": "\u003cp\u003eA list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the \u003ccode\u003eDatabaseUser\u003c/code\u003e. If you choose to include this parameter, the \u003ccode\u003eRoleArn\u003c/code\u003e must grant access to \u003ccode\u003eredshift:JoinGroup\u003c/code\u003e.\u003c/p\u003e", + "items": { + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "maxItems": 50, + "minItems": 1, + "type": "array" + }, + "DatabaseUser": { + "description": "\u003cp\u003eThe user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of \u003ccode\u003eAutoCreateDatabaseUser\u003c/code\u003e to \u003ccode\u003eTrue\u003c/code\u003e to create a new user with PUBLIC permissions.\u003c/p\u003e", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "RoleArn": { + "description": "\u003cp\u003eUse the \u003ccode\u003eRoleArn\u003c/code\u003e structure to allow Amazon QuickSight to call \u003ccode\u003eredshift:GetClusterCredentials\u003c/code\u003e on your cluster. The calling principal must have \u003ccode\u003eiam:PassRole\u003c/code\u003e access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.\u003c/p\u003e", + "maxLength": 2048, + "minLength": 20, + "type": "string" + } + }, + "required": [ + "RoleArn" + ], + "type": "object" + }, "RedshiftParameters": { - "description": "\u003cp\u003eAmazon Redshift parameters. The \u003ccode\u003eClusterId\u003c/code\u003e field can be blank if\n \u003ccode\u003eHost\u003c/code\u003e and \u003ccode\u003ePort\u003c/code\u003e are both set. The \u003ccode\u003eHost\u003c/code\u003e and\n \u003ccode\u003ePort\u003c/code\u003e fields can be blank if the \u003ccode\u003eClusterId\u003c/code\u003e field is set.\u003c/p\u003e", + "additionalProperties": false, + "description": "\u003cp\u003eThe parameters for Amazon Redshift. The \u003ccode\u003eClusterId\u003c/code\u003e field can be blank if\n \u003ccode\u003eHost\u003c/code\u003e and \u003ccode\u003ePort\u003c/code\u003e are both set. The \u003ccode\u003eHost\u003c/code\u003e and \u003ccode\u003ePort\u003c/code\u003e fields can be blank if the \u003ccode\u003eClusterId\u003c/code\u003e field is set.\u003c/p\u003e", "properties": { "ClusterId": { "description": "\u003cp\u003eCluster ID. This field can be blank if the \u003ccode\u003eHost\u003c/code\u003e and \u003ccode\u003ePort\u003c/code\u003e are\n provided.\u003c/p\u003e", @@ -542,7 +636,14 @@ "minLength": 1, "type": "string" }, + "IAMParameters": { + "$ref": "#/definitions/RedshiftIAMParameters" + }, + "IdentityCenterConfiguration": { + "$ref": "#/definitions/IdentityCenterConfiguration" + }, "Port": { + "default": 0, "description": "\u003cp\u003ePort. This field can be blank if the \u003ccode\u003eClusterId\u003c/code\u003e is provided.\u003c/p\u003e", "maximum": 65535, "minimum": 0, @@ -555,6 +656,7 @@ "type": "object" }, "ResourcePermission": { + "additionalProperties": false, "description": "\u003cp\u003ePermission for the resource.\u003c/p\u003e", "properties": { "Actions": { @@ -567,10 +669,13 @@ "type": "array" }, "Principal": { - "description": "\u003cp\u003eThe Amazon Resource Name (ARN) of the principal. This can be one of the\n following:\u003c/p\u003e\n \u003cul\u003e\n \u003cli\u003e\n \u003cp\u003eThe ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)\u003c/p\u003e\n \u003c/li\u003e\n \u003cli\u003e\n \u003cp\u003eThe ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)\u003c/p\u003e\n \u003c/li\u003e\n \u003cli\u003e\n \u003cp\u003eThe ARN of an AWS account root: This is an IAM ARN rather than a QuickSight\n ARN. Use this option only to share resources (templates) across AWS accounts.\n (This is less common.) \u003c/p\u003e\n \u003c/li\u003e\n \u003c/ul\u003e", + "description": "\u003cp\u003eThe Amazon Resource Name (ARN) of the principal. This can be one of the\n following:\u003c/p\u003e\n \u003cul\u003e\n \u003cli\u003e\n \u003cp\u003eThe ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)\u003c/p\u003e\n \u003c/li\u003e\n \u003cli\u003e\n \u003cp\u003eThe ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)\u003c/p\u003e\n \u003c/li\u003e\n \u003cli\u003e\n \u003cp\u003eThe ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight\n ARN. Use this option only to share resources (templates) across Amazon Web Services accounts.\n (This is less common.) \u003c/p\u003e\n \u003c/li\u003e\n \u003c/ul\u003e", "maxLength": 256, "minLength": 1, "type": "string" + }, + "Resource": { + "type": "string" } }, "required": [ @@ -592,7 +697,8 @@ "type": "string" }, "S3Parameters": { - "description": "\u003cp\u003eS3 parameters.\u003c/p\u003e", + "additionalProperties": false, + "description": "\u003cp\u003eThe parameters for S3.\u003c/p\u003e", "properties": { "ManifestFileLocation": { "$ref": "#/definitions/ManifestFileLocation" @@ -610,7 +716,8 @@ "type": "object" }, "SnowflakeParameters": { - "description": "\u003cp\u003eSnowflake parameters.\u003c/p\u003e", + "additionalProperties": false, + "description": "\u003cp\u003eThe parameters for Snowflake.\u003c/p\u003e", "properties": { "Database": { "description": "\u003cp\u003eDatabase.\u003c/p\u003e", @@ -639,7 +746,8 @@ "type": "object" }, "SparkParameters": { - "description": "\u003cp\u003eSpark parameters.\u003c/p\u003e", + "additionalProperties": false, + "description": "\u003cp\u003eThe parameters for Spark.\u003c/p\u003e", "properties": { "Host": { "description": "\u003cp\u003eHost.\u003c/p\u003e", @@ -648,6 +756,7 @@ "type": "string" }, "Port": { + "default": 0, "description": "\u003cp\u003ePort.\u003c/p\u003e", "maximum": 65535, "minimum": 1, @@ -661,7 +770,8 @@ "type": "object" }, "SqlServerParameters": { - "description": "\u003cp\u003eSQL Server parameters.\u003c/p\u003e", + "additionalProperties": false, + "description": "\u003cp\u003eThe parameters for SQL Server.\u003c/p\u003e", "properties": { "Database": { "description": "\u003cp\u003eDatabase.\u003c/p\u003e", @@ -676,6 +786,7 @@ "type": "string" }, "Port": { + "default": 0, "description": "\u003cp\u003ePort.\u003c/p\u003e", "maximum": 65535, "minimum": 1, @@ -690,9 +801,11 @@ "type": "object" }, "SslProperties": { - "description": "\u003cp\u003eSecure Socket Layer (SSL) properties that apply when QuickSight connects to your\n underlying data source.\u003c/p\u003e", + "additionalProperties": false, + "description": "\u003cp\u003eSecure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your\n underlying data source.\u003c/p\u003e", "properties": { "DisableSsl": { + "default": false, "description": "\u003cp\u003eA Boolean option to control whether SSL should be disabled.\u003c/p\u003e", "type": "boolean" } @@ -700,22 +813,24 @@ "type": "object" }, "StarburstParameters": { - "description": "\u003cp\u003eStarburst parameters.\u003c/p\u003e", + "additionalProperties": false, + "description": "\u003cp\u003eThe parameters that are required to connect to a Starburst data source.\u003c/p\u003e", "properties": { "Catalog": { - "description": "\u003cp\u003eCatalog.\u003c/p\u003e", + "description": "\u003cp\u003eThe catalog name for the Starburst data source.\u003c/p\u003e", "maxLength": 128, "minLength": 0, "type": "string" }, "Host": { - "description": "\u003cp\u003eHost.\u003c/p\u003e", + "description": "\u003cp\u003eThe host name of the Starburst data source.\u003c/p\u003e", "maxLength": 256, "minLength": 1, "type": "string" }, "Port": { - "description": "\u003cp\u003ePort.\u003c/p\u003e", + "default": 0, + "description": "\u003cp\u003eThe port for the Starburst data source.\u003c/p\u003e", "maximum": 65535, "minimum": 1, "type": "number" @@ -725,9 +840,9 @@ } }, "required": [ + "Catalog", "Host", - "Port", - "Catalog" + "Port" ], "type": "object" }, @@ -739,6 +854,7 @@ "type": "string" }, "Tag": { + "additionalProperties": false, "description": "\u003cp\u003eThe key or keys of the key-value pairs for the resource tag or tags assigned to the\n resource.\u003c/p\u003e", "properties": { "Key": { @@ -761,7 +877,8 @@ "type": "object" }, "TeradataParameters": { - "description": "\u003cp\u003eTeradata parameters.\u003c/p\u003e", + "additionalProperties": false, + "description": "\u003cp\u003eThe parameters for Teradata.\u003c/p\u003e", "properties": { "Database": { "description": "\u003cp\u003eDatabase.\u003c/p\u003e", @@ -776,6 +893,7 @@ "type": "string" }, "Port": { + "default": 0, "description": "\u003cp\u003ePort.\u003c/p\u003e", "maximum": 65535, "minimum": 1, @@ -790,35 +908,38 @@ "type": "object" }, "TrinoParameters": { - "description": "\u003cp\u003eTrino parameters.\u003c/p\u003e", + "additionalProperties": false, + "description": "\u003cp\u003eThe parameters that are required to connect to a Trino data source.\u003c/p\u003e", "properties": { "Catalog": { - "description": "\u003cp\u003eCatalog.\u003c/p\u003e", + "description": "\u003cp\u003eThe catalog name for the Trino data source.\u003c/p\u003e", "maxLength": 128, "minLength": 0, "type": "string" }, "Host": { - "description": "\u003cp\u003eHost.\u003c/p\u003e", + "description": "\u003cp\u003eThe host name of the Trino data source.\u003c/p\u003e", "maxLength": 256, "minLength": 1, "type": "string" }, "Port": { - "description": "\u003cp\u003ePort.\u003c/p\u003e", + "default": 0, + "description": "\u003cp\u003eThe port for the Trino data source.\u003c/p\u003e", "maximum": 65535, "minimum": 1, "type": "number" } }, "required": [ + "Catalog", "Host", - "Port", - "Catalog" + "Port" ], "type": "object" }, "VpcConnectionProperties": { + "additionalProperties": false, "description": "\u003cp\u003eVPC connection properties.\u003c/p\u003e", "properties": { "VpcConnectionArn": { @@ -923,13 +1044,11 @@ "type": "string" }, "Name": { - "description": "\u003cp\u003eA display name for the data source.\u003c/p\u003e", "maxLength": 128, "minLength": 1, "type": "string" }, "Permissions": { - "description": "\u003cp\u003eA list of resource permissions on the data source.\u003c/p\u003e", "items": { "$ref": "#/definitions/ResourcePermission" }, @@ -944,7 +1063,6 @@ "$ref": "#/definitions/ResourceStatus" }, "Tags": { - "description": "\u003cp\u003eContains a map of the key-value pairs for the resource tag or tags assigned to the data source.\u003c/p\u003e", "items": { "$ref": "#/definitions/Tag" }, @@ -965,6 +1083,11 @@ "/properties/LastUpdatedTime", "/properties/Status" ], + "required": [ + "Name", + "Type" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-quicksight", "typeName": "AWS::QuickSight::DataSource", "writeOnlyProperties": [ "/properties/Credentials" diff --git a/artifacts/types/AWS::QuickSight::RefreshSchedule.json b/artifacts/types/AWS::QuickSight::RefreshSchedule.json index e1af14d6..5e5f20bb 100644 --- a/artifacts/types/AWS::QuickSight::RefreshSchedule.json +++ b/artifacts/types/AWS::QuickSight::RefreshSchedule.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-QuickSight-RefreshSchedule", "type": "AWS::QuickSight::RefreshSchedule", - "time": "2023-12-21T17:24:12.734Z", + "time": "2024-06-18T21:55:23.867Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -109,6 +109,20 @@ ] }, "list": { + "handlerSchema": { + "properties": { + "AwsAccountId": { + "$ref": "resource-schema.json#/properties/AwsAccountId" + }, + "DataSetId": { + "$ref": "resource-schema.json#/properties/DataSetId" + } + }, + "required": [ + "AwsAccountId", + "DataSetId" + ] + }, "permissions": [ "quicksight:ListRefreshSchedules" ] @@ -152,6 +166,7 @@ "/properties/Arn" ], "required": [], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-quicksight", "tagging": { "cloudFormationSystemTags": false, "tagOnCreate": false, diff --git a/artifacts/types/AWS::QuickSight::Template.json b/artifacts/types/AWS::QuickSight::Template.json index 84ebae81..f4941567 100644 --- a/artifacts/types/AWS::QuickSight::Template.json +++ b/artifacts/types/AWS::QuickSight::Template.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-QuickSight-Template", "type": "AWS::QuickSight::Template", - "time": "2024-01-04T17:35:37.277Z", + "time": "2024-06-05T15:52:19.248Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -517,7 +517,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -580,7 +580,7 @@ "SectionId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "Style": { @@ -756,7 +756,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -926,10 +926,13 @@ "Configuration": { "$ref": "#/definitions/CategoryFilterConfiguration" }, + "DefaultFilterControlConfiguration": { + "$ref": "#/definitions/DefaultFilterControlConfiguration" + }, "FilterId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -1078,8 +1081,10 @@ }, "ColumnGroupColumnSchema": { "additionalProperties": false, + "description": "\u003cp\u003eA structure describing the name, data type, and geographic role of the columns.\u003c/p\u003e", "properties": { "Name": { + "description": "\u003cp\u003eThe name of the column group's column schema.\u003c/p\u003e", "type": "string" } }, @@ -1087,8 +1092,10 @@ }, "ColumnGroupSchema": { "additionalProperties": false, + "description": "\u003cp\u003eThe column group schema.\u003c/p\u003e", "properties": { "ColumnGroupColumnSchemaList": { + "description": "\u003cp\u003eA structure containing the list of schemas for column group columns.\u003c/p\u003e", "items": { "$ref": "#/definitions/ColumnGroupColumnSchema" }, @@ -1097,6 +1104,7 @@ "type": "array" }, "Name": { + "description": "\u003cp\u003eThe name of the column group schema.\u003c/p\u003e", "type": "string" } }, @@ -1146,14 +1154,18 @@ }, "ColumnSchema": { "additionalProperties": false, + "description": "\u003cp\u003eThe column schema.\u003c/p\u003e", "properties": { "DataType": { + "description": "\u003cp\u003eThe data type of the column schema.\u003c/p\u003e", "type": "string" }, "GeographicRole": { + "description": "\u003cp\u003eThe geographic role of the column schema.\u003c/p\u003e", "type": "string" }, "Name": { + "description": "\u003cp\u003eThe name of the column schema.\u003c/p\u003e", "type": "string" } }, @@ -1364,7 +1376,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -1646,7 +1658,7 @@ "type": "string" }, "Symbol": { - "pattern": "[A-Z]{3}", + "pattern": "^[A-Z]{3}$", "type": "string" } }, @@ -1794,7 +1806,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -2170,8 +2182,10 @@ }, "DataSetConfiguration": { "additionalProperties": false, + "description": "\u003cp\u003eDataset configuration.\u003c/p\u003e", "properties": { "ColumnGroupSchemaList": { + "description": "\u003cp\u003eA structure containing the list of column group schemas.\u003c/p\u003e", "items": { "$ref": "#/definitions/ColumnGroupSchema" }, @@ -2183,6 +2197,7 @@ "$ref": "#/definitions/DataSetSchema" }, "Placeholder": { + "description": "\u003cp\u003ePlaceholder.\u003c/p\u003e", "type": "string" } }, @@ -2190,12 +2205,15 @@ }, "DataSetReference": { "additionalProperties": false, + "description": "\u003cp\u003eDataset reference.\u003c/p\u003e", "properties": { "DataSetArn": { + "description": "\u003cp\u003eDataset Amazon Resource Name (ARN).\u003c/p\u003e", "type": "string" }, "DataSetPlaceholder": { - "pattern": ".*\\S.*", + "description": "\u003cp\u003eDataset placeholder.\u003c/p\u003e", + "pattern": "\\S", "type": "string" } }, @@ -2207,8 +2225,10 @@ }, "DataSetSchema": { "additionalProperties": false, + "description": "\u003cp\u003eDataset schema.\u003c/p\u003e", "properties": { "ColumnSchemaList": { + "description": "\u003cp\u003eA structure containing the list of column schemas.\u003c/p\u003e", "items": { "$ref": "#/definitions/ColumnSchema" }, @@ -2501,6 +2521,93 @@ }, "type": "object" }, + "DefaultDateTimePickerControlOptions": { + "additionalProperties": false, + "properties": { + "DisplayOptions": { + "$ref": "#/definitions/DateTimePickerControlDisplayOptions" + }, + "Type": { + "$ref": "#/definitions/SheetControlDateTimePickerType" + } + }, + "type": "object" + }, + "DefaultFilterControlConfiguration": { + "additionalProperties": false, + "properties": { + "ControlOptions": { + "$ref": "#/definitions/DefaultFilterControlOptions" + }, + "Title": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "ControlOptions", + "Title" + ], + "type": "object" + }, + "DefaultFilterControlOptions": { + "additionalProperties": false, + "properties": { + "DefaultDateTimePickerOptions": { + "$ref": "#/definitions/DefaultDateTimePickerControlOptions" + }, + "DefaultDropdownOptions": { + "$ref": "#/definitions/DefaultFilterDropDownControlOptions" + }, + "DefaultListOptions": { + "$ref": "#/definitions/DefaultFilterListControlOptions" + }, + "DefaultRelativeDateTimeOptions": { + "$ref": "#/definitions/DefaultRelativeDateTimeControlOptions" + }, + "DefaultSliderOptions": { + "$ref": "#/definitions/DefaultSliderControlOptions" + }, + "DefaultTextAreaOptions": { + "$ref": "#/definitions/DefaultTextAreaControlOptions" + }, + "DefaultTextFieldOptions": { + "$ref": "#/definitions/DefaultTextFieldControlOptions" + } + }, + "type": "object" + }, + "DefaultFilterDropDownControlOptions": { + "additionalProperties": false, + "properties": { + "DisplayOptions": { + "$ref": "#/definitions/DropDownControlDisplayOptions" + }, + "SelectableValues": { + "$ref": "#/definitions/FilterSelectableValues" + }, + "Type": { + "$ref": "#/definitions/SheetControlListType" + } + }, + "type": "object" + }, + "DefaultFilterListControlOptions": { + "additionalProperties": false, + "properties": { + "DisplayOptions": { + "$ref": "#/definitions/ListControlDisplayOptions" + }, + "SelectableValues": { + "$ref": "#/definitions/FilterSelectableValues" + }, + "Type": { + "$ref": "#/definitions/SheetControlListType" + } + }, + "type": "object" + }, "DefaultFreeFormLayoutConfiguration": { "additionalProperties": false, "properties": { @@ -2561,6 +2668,15 @@ }, "type": "object" }, + "DefaultRelativeDateTimeControlOptions": { + "additionalProperties": false, + "properties": { + "DisplayOptions": { + "$ref": "#/definitions/RelativeDateTimeControlDisplayOptions" + } + }, + "type": "object" + }, "DefaultSectionBasedLayoutConfiguration": { "additionalProperties": false, "properties": { @@ -2573,6 +2689,58 @@ ], "type": "object" }, + "DefaultSliderControlOptions": { + "additionalProperties": false, + "properties": { + "DisplayOptions": { + "$ref": "#/definitions/SliderControlDisplayOptions" + }, + "MaximumValue": { + "default": 0, + "type": "number" + }, + "MinimumValue": { + "default": 0, + "type": "number" + }, + "StepSize": { + "default": 0, + "type": "number" + }, + "Type": { + "$ref": "#/definitions/SheetControlSliderType" + } + }, + "required": [ + "MaximumValue", + "MinimumValue", + "StepSize" + ], + "type": "object" + }, + "DefaultTextAreaControlOptions": { + "additionalProperties": false, + "properties": { + "Delimiter": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "DisplayOptions": { + "$ref": "#/definitions/TextAreaControlDisplayOptions" + } + }, + "type": "object" + }, + "DefaultTextFieldControlOptions": { + "additionalProperties": false, + "properties": { + "DisplayOptions": { + "$ref": "#/definitions/TextFieldControlDisplayOptions" + } + }, + "type": "object" + }, "DestinationParameterValueConfiguration": { "additionalProperties": false, "properties": { @@ -2699,7 +2867,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -2713,7 +2881,7 @@ "additionalProperties": false, "properties": { "Path": { - "pattern": ".*\\S.*", + "pattern": "\\S", "type": "string" } }, @@ -3024,7 +3192,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -3063,6 +3231,9 @@ "FilterControl": { "additionalProperties": false, "properties": { + "CrossSheet": { + "$ref": "#/definitions/FilterCrossSheetControl" + }, "DateTimePicker": { "$ref": "#/definitions/FilterDateTimePickerControl" }, @@ -3087,6 +3258,31 @@ }, "type": "object" }, + "FilterCrossSheetControl": { + "additionalProperties": false, + "properties": { + "CascadingControlConfiguration": { + "$ref": "#/definitions/CascadingControlConfiguration" + }, + "FilterControlId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + }, + "SourceFilterId": { + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\w\\-]+$", + "type": "string" + } + }, + "required": [ + "FilterControlId", + "SourceFilterId" + ], + "type": "object" + }, "FilterDateTimePickerControl": { "additionalProperties": false, "properties": { @@ -3096,13 +3292,13 @@ "FilterControlId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "SourceFilterId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "Title": { @@ -3133,7 +3329,7 @@ "FilterControlId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "SelectableValues": { @@ -3142,7 +3338,7 @@ "SourceFilterId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "Title": { @@ -3170,7 +3366,7 @@ "FilterGroupId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "Filters": { @@ -3236,7 +3432,7 @@ "FilterControlId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "SelectableValues": { @@ -3245,7 +3441,7 @@ "SourceFilterId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "Title": { @@ -3276,6 +3472,7 @@ "additionalProperties": false, "properties": { "SelectedColumns": { + "description": "\u003cp\u003eThe selected columns of a dataset.\u003c/p\u003e", "items": { "$ref": "#/definitions/ColumnIdentifier" }, @@ -3317,13 +3514,13 @@ "FilterControlId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "SourceFilterId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "Title": { @@ -3374,7 +3571,7 @@ "FilterControlId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "MaximumValue": { @@ -3388,7 +3585,7 @@ "SourceFilterId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "StepSize": { @@ -3428,13 +3625,13 @@ "FilterControlId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "SourceFilterId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "Title": { @@ -3459,13 +3656,13 @@ "FilterControlId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "SourceFilterId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "Title": { @@ -3555,7 +3752,7 @@ "ComputationId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "CustomSeasonalityValue": { @@ -3692,7 +3889,7 @@ "ElementId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "ElementType": { @@ -3942,7 +4139,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -4088,7 +4285,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -4271,7 +4468,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -4407,7 +4604,7 @@ "ElementId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "ElementType": { @@ -4454,7 +4651,7 @@ "ComputationId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "Name": { @@ -4487,7 +4684,7 @@ "SectionId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "Style": { @@ -4628,7 +4825,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -4739,7 +4936,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -4833,7 +5030,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -5151,7 +5348,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -5364,7 +5561,7 @@ "items": { "$ref": "#/definitions/SeriesItem" }, - "maxItems": 10, + "maxItems": 2000, "minItems": 0, "type": "array" }, @@ -5555,7 +5752,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -5640,7 +5837,7 @@ "TargetSheetId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -5708,7 +5905,7 @@ "ComputationId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "Name": { @@ -5761,7 +5958,7 @@ "ComputationId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "FromValue": { @@ -5930,10 +6127,13 @@ "Column": { "$ref": "#/definitions/ColumnIdentifier" }, + "DefaultFilterControlConfiguration": { + "$ref": "#/definitions/DefaultFilterControlConfiguration" + }, "FilterId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "MatchOperator": { @@ -6001,10 +6201,13 @@ "Column": { "$ref": "#/definitions/ColumnIdentifier" }, + "DefaultFilterControlConfiguration": { + "$ref": "#/definitions/DefaultFilterControlConfiguration" + }, "FilterId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "IncludeMaximum": { @@ -6274,7 +6477,7 @@ "ParameterControlId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "SourceParameterName": { @@ -6326,7 +6529,7 @@ "ParameterControlId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "SelectableValues": { @@ -6366,7 +6569,7 @@ "ParameterControlId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "SelectableValues": { @@ -6428,7 +6631,7 @@ "ParameterControlId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "SourceParameterName": { @@ -6471,7 +6674,7 @@ "ParameterControlId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "SourceParameterName": { @@ -6502,7 +6705,7 @@ "ParameterControlId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "SourceParameterName": { @@ -6594,7 +6797,7 @@ "ComputationId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "Name": { @@ -6618,7 +6821,7 @@ "ComputationId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "Name": { @@ -6781,7 +6984,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -6873,7 +7076,7 @@ "items": { "$ref": "#/definitions/PivotTableConditionalFormattingOption" }, - "maxItems": 100, + "maxItems": 500, "minItems": 0, "type": "array" } @@ -7236,7 +7439,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -7514,7 +7717,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -7557,7 +7760,7 @@ "additionalProperties": false, "properties": { "CustomLabel": { - "pattern": ".*\\S.*", + "pattern": "\\S", "type": "string" } }, @@ -7739,13 +7942,16 @@ "Column": { "$ref": "#/definitions/ColumnIdentifier" }, + "DefaultFilterControlConfiguration": { + "$ref": "#/definitions/DefaultFilterControlConfiguration" + }, "ExcludePeriodConfiguration": { "$ref": "#/definitions/ExcludePeriodConfiguration" }, "FilterId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "MinimumGranularity": { @@ -7800,8 +8006,10 @@ }, "ResourcePermission": { "additionalProperties": false, + "description": "\u003cp\u003ePermission for the resource.\u003c/p\u003e", "properties": { "Actions": { + "description": "\u003cp\u003eThe IAM action to grant or revoke permissions on.\u003c/p\u003e", "items": { "type": "string" }, @@ -7810,6 +8018,7 @@ "type": "array" }, "Principal": { + "description": "\u003cp\u003eThe Amazon Resource Name (ARN) of the principal. This can be one of the\n following:\u003c/p\u003e\n \u003cul\u003e\n \u003cli\u003e\n \u003cp\u003eThe ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)\u003c/p\u003e\n \u003c/li\u003e\n \u003cli\u003e\n \u003cp\u003eThe ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)\u003c/p\u003e\n \u003c/li\u003e\n \u003cli\u003e\n \u003cp\u003eThe ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight\n ARN. Use this option only to share resources (templates) across Amazon Web Services accounts.\n (This is less common.) \u003c/p\u003e\n \u003c/li\u003e\n \u003c/ul\u003e", "maxLength": 256, "minLength": 1, "type": "string" @@ -7883,7 +8092,7 @@ "items": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "maxItems": 50, @@ -7990,7 +8199,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -8167,7 +8376,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -8388,16 +8597,19 @@ }, "Sheet": { "additionalProperties": false, + "description": "\u003cp\u003eA \u003ci\u003esheet\u003c/i\u003e, which is an object that contains a set of visuals that\n are viewed together on one page in Amazon QuickSight. Every analysis and dashboard\n contains at least one sheet. Each sheet contains at least one visualization widget, for\n example a chart, pivot table, or narrative insight. Sheets can be associated with other\n components, such as controls, filters, and so on.\u003c/p\u003e", "properties": { "Name": { + "description": "\u003cp\u003eThe name of a sheet. This name is displayed on the sheet's tab in the Amazon QuickSight\n console.\u003c/p\u003e", "maxLength": 2048, "minLength": 1, "type": "string" }, "SheetId": { + "description": "\u003cp\u003eThe unique identifier associated with a sheet.\u003c/p\u003e", "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -8517,7 +8729,7 @@ "SheetId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "TextBoxes": { @@ -8585,7 +8797,7 @@ "SheetTextBoxId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -8603,14 +8815,14 @@ "SheetId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "VisualIds": { "items": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "maxItems": 50, @@ -9026,7 +9238,7 @@ "items": { "$ref": "#/definitions/TableConditionalFormattingOption" }, - "maxItems": 100, + "maxItems": 500, "minItems": 0, "type": "array" } @@ -9406,7 +9618,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -9417,13 +9629,16 @@ }, "Tag": { "additionalProperties": false, + "description": "\u003cp\u003eThe key or keys of the key-value pairs for the resource tag or tags assigned to the\n resource.\u003c/p\u003e", "properties": { "Key": { + "description": "\u003cp\u003eTag key.\u003c/p\u003e", "maxLength": 128, "minLength": 1, "type": "string" }, "Value": { + "description": "\u003cp\u003eTag value.\u003c/p\u003e", "maxLength": 256, "minLength": 1, "type": "string" @@ -9443,15 +9658,18 @@ }, "TemplateError": { "additionalProperties": false, + "description": "\u003cp\u003eList of errors that occurred when the template version creation failed.\u003c/p\u003e", "properties": { "Message": { - "pattern": ".*\\S.*", + "description": "\u003cp\u003eDescription of the error type.\u003c/p\u003e", + "pattern": "\\S", "type": "string" }, "Type": { "$ref": "#/definitions/TemplateErrorType" }, "ViolatedEntities": { + "description": "\u003cp\u003eAn error path that shows which entities caused the template error.\u003c/p\u003e", "items": { "$ref": "#/definitions/Entity" }, @@ -9473,11 +9691,14 @@ }, "TemplateSourceAnalysis": { "additionalProperties": false, + "description": "\u003cp\u003eThe source analysis of the template.\u003c/p\u003e", "properties": { "Arn": { + "description": "\u003cp\u003eThe Amazon Resource Name (ARN) of the resource.\u003c/p\u003e", "type": "string" }, "DataSetReferences": { + "description": "\u003cp\u003eA structure containing information about the dataset references used as placeholders\n in the template.\u003c/p\u003e", "items": { "$ref": "#/definitions/DataSetReference" }, @@ -9493,6 +9714,7 @@ }, "TemplateSourceEntity": { "additionalProperties": false, + "description": "\u003cp\u003eThe source entity of the template.\u003c/p\u003e", "properties": { "SourceAnalysis": { "$ref": "#/definitions/TemplateSourceAnalysis" @@ -9505,8 +9727,10 @@ }, "TemplateSourceTemplate": { "additionalProperties": false, + "description": "\u003cp\u003eThe source template of the template.\u003c/p\u003e", "properties": { "Arn": { + "description": "\u003cp\u003eThe Amazon Resource Name (ARN) of the resource.\u003c/p\u003e", "type": "string" } }, @@ -9517,12 +9741,15 @@ }, "TemplateVersion": { "additionalProperties": false, + "description": "\u003cp\u003eA version of a template.\u003c/p\u003e", "properties": { "CreatedTime": { + "description": "\u003cp\u003eThe time that this template version was created.\u003c/p\u003e", "format": "date-time", "type": "string" }, "DataSetConfigurations": { + "description": "\u003cp\u003eSchema of the dataset identified by the placeholder. Any dashboard created from this\n template should be bound to new datasets matching the same schema described through this\n API operation.\u003c/p\u003e", "items": { "$ref": "#/definitions/DataSetConfiguration" }, @@ -9531,11 +9758,13 @@ "type": "array" }, "Description": { + "description": "\u003cp\u003eThe description of the template.\u003c/p\u003e", "maxLength": 512, "minLength": 1, "type": "string" }, "Errors": { + "description": "\u003cp\u003eErrors associated with this template version.\u003c/p\u003e", "items": { "$ref": "#/definitions/TemplateError" }, @@ -9543,6 +9772,7 @@ "type": "array" }, "Sheets": { + "description": "\u003cp\u003eA list of the associated sheets with the unique identifier and name of each sheet.\u003c/p\u003e", "items": { "$ref": "#/definitions/Sheet" }, @@ -9551,15 +9781,18 @@ "type": "array" }, "SourceEntityArn": { + "description": "\u003cp\u003eThe Amazon Resource Name (ARN) of an analysis or template that was used to create this\n template.\u003c/p\u003e", "type": "string" }, "Status": { "$ref": "#/definitions/ResourceStatus" }, "ThemeArn": { + "description": "\u003cp\u003eThe ARN of the theme associated with this version of the template.\u003c/p\u003e", "type": "string" }, "VersionNumber": { + "description": "\u003cp\u003eThe version number of the template version.\u003c/p\u003e", "minimum": 1, "type": "number" } @@ -9584,7 +9817,7 @@ "items": { "$ref": "#/definitions/ColumnConfiguration" }, - "maxItems": 200, + "maxItems": 2000, "minItems": 0, "type": "array" }, @@ -9742,10 +9975,13 @@ "Column": { "$ref": "#/definitions/ColumnIdentifier" }, + "DefaultFilterControlConfiguration": { + "$ref": "#/definitions/DefaultFilterControlConfiguration" + }, "FilterId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "ParameterName": { @@ -9817,13 +10053,16 @@ "Column": { "$ref": "#/definitions/ColumnIdentifier" }, + "DefaultFilterControlConfiguration": { + "$ref": "#/definitions/DefaultFilterControlConfiguration" + }, "ExcludePeriodConfiguration": { "$ref": "#/definitions/ExcludePeriodConfiguration" }, "FilterId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "IncludeMaximum": { @@ -9928,10 +10167,13 @@ "Column": { "$ref": "#/definitions/ColumnIdentifier" }, + "DefaultFilterControlConfiguration": { + "$ref": "#/definitions/DefaultFilterControlConfiguration" + }, "FilterId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "Limit": { @@ -9964,7 +10206,7 @@ "ComputationId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "MoverSize": { @@ -10004,7 +10246,7 @@ "ComputationId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "Name": { @@ -10042,7 +10284,7 @@ "ComputationId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "Name": { @@ -10233,7 +10475,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -10289,7 +10531,7 @@ "ComputationId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "Name": { @@ -10303,6 +10545,7 @@ }, "ValidationStrategy": { "additionalProperties": false, + "description": "\u003cp\u003eThe 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 \u003ccode\u003eLENIENT\u003c/code\u003e, validation is skipped for specific errors.\u003c/p\u003e", "properties": { "Mode": { "$ref": "#/definitions/ValidationStrategyMode" @@ -10441,7 +10684,7 @@ "CustomActionId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "Name": { @@ -10561,6 +10804,15 @@ }, "type": "object" }, + "WaterfallChartColorConfiguration": { + "additionalProperties": false, + "properties": { + "GroupColorConfiguration": { + "$ref": "#/definitions/WaterfallChartGroupColorConfiguration" + } + }, + "type": "object" + }, "WaterfallChartConfiguration": { "additionalProperties": false, "properties": { @@ -10570,6 +10822,9 @@ "CategoryAxisLabelOptions": { "$ref": "#/definitions/ChartAxisLabelOptions" }, + "ColorConfiguration": { + "$ref": "#/definitions/WaterfallChartColorConfiguration" + }, "DataLabels": { "$ref": "#/definitions/DataLabelOptions" }, @@ -10606,6 +10861,24 @@ }, "type": "object" }, + "WaterfallChartGroupColorConfiguration": { + "additionalProperties": false, + "properties": { + "NegativeBarColor": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "PositiveBarColor": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + }, + "TotalBarColor": { + "pattern": "^#[A-F0-9]{6}$", + "type": "string" + } + }, + "type": "object" + }, "WaterfallChartOptions": { "additionalProperties": false, "properties": { @@ -10663,7 +10936,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -10850,7 +11123,7 @@ "VisualId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" } }, @@ -10950,6 +11223,7 @@ ], "properties": { "Arn": { + "description": "\u003cp\u003eThe Amazon Resource Name (ARN) of the template.\u003c/p\u003e", "type": "string" }, "AwsAccountId": { @@ -10959,6 +11233,7 @@ "type": "string" }, "CreatedTime": { + "description": "\u003cp\u003eTime when this was created.\u003c/p\u003e", "format": "date-time", "type": "string" }, @@ -10966,6 +11241,7 @@ "$ref": "#/definitions/TemplateVersionDefinition" }, "LastUpdatedTime": { + "description": "\u003cp\u003eTime when this was last updated.\u003c/p\u003e", "format": "date-time", "type": "string" }, @@ -10996,7 +11272,7 @@ "TemplateId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "ValidationStrategy": { diff --git a/artifacts/types/AWS::QuickSight::Theme.json b/artifacts/types/AWS::QuickSight::Theme.json index 54c802ae..b787bcd9 100644 --- a/artifacts/types/AWS::QuickSight::Theme.json +++ b/artifacts/types/AWS::QuickSight::Theme.json @@ -1,19 +1,21 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-QuickSight-Theme", "type": "AWS::QuickSight::Theme", - "time": "2024-01-04T17:24:37.505Z", + "time": "2024-06-05T15:44:17.773Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ - "/properties/ThemeId", - "/properties/AwsAccountId" + "/properties/AwsAccountId", + "/properties/ThemeId" ], "definitions": { "BorderStyle": { "additionalProperties": false, + "description": "\u003cp\u003eThe display options for tile borders for visuals.\u003c/p\u003e", "properties": { "Show": { "default": null, + "description": "\u003cp\u003eThe option to enable display of borders for visuals.\u003c/p\u003e", "type": "boolean" } }, @@ -21,8 +23,10 @@ }, "DataColorPalette": { "additionalProperties": false, + "description": "\u003cp\u003eThe theme colors that are used for data colors in charts. The colors description is a\n hexadecimal color code that consists of six alphanumerical characters, prefixed with\n \u003ccode\u003e#\u003c/code\u003e, for example #37BFF5. \u003c/p\u003e", "properties": { "Colors": { + "description": "\u003cp\u003eThe hexadecimal codes for the colors.\u003c/p\u003e", "items": { "pattern": "^#[A-F0-9]{6}$", "type": "string" @@ -32,10 +36,12 @@ "type": "array" }, "EmptyFillColor": { + "description": "\u003cp\u003eThe hexadecimal code of a color that applies to charts where a lack of data is\n highlighted.\u003c/p\u003e", "pattern": "^#[A-F0-9]{6}$", "type": "string" }, "MinMaxGradient": { + "description": "\u003cp\u003eThe minimum and maximum hexadecimal codes that describe a color gradient. \u003c/p\u003e", "items": { "pattern": "^#[A-F0-9]{6}$", "type": "string" @@ -58,9 +64,11 @@ }, "GutterStyle": { "additionalProperties": false, + "description": "\u003cp\u003eThe display options for gutter spacing between tiles on a sheet.\u003c/p\u003e", "properties": { "Show": { "default": null, + "description": "\u003cp\u003eThis Boolean value controls whether to display a gutter space between sheet tiles.\n \u003c/p\u003e", "type": "boolean" } }, @@ -68,9 +76,11 @@ }, "MarginStyle": { "additionalProperties": false, + "description": "\u003cp\u003eThe display options for margins around the outside edge of sheets.\u003c/p\u003e", "properties": { "Show": { "default": null, + "description": "\u003cp\u003eThis Boolean value controls whether to display sheet margins.\u003c/p\u003e", "type": "boolean" } }, @@ -78,8 +88,10 @@ }, "ResourcePermission": { "additionalProperties": false, + "description": "\u003cp\u003ePermission for the resource.\u003c/p\u003e", "properties": { "Actions": { + "description": "\u003cp\u003eThe IAM action to grant or revoke permissions on.\u003c/p\u003e", "items": { "type": "string" }, @@ -88,6 +100,7 @@ "type": "array" }, "Principal": { + "description": "\u003cp\u003eThe Amazon Resource Name (ARN) of the principal. This can be one of the\n following:\u003c/p\u003e\n \u003cul\u003e\n \u003cli\u003e\n \u003cp\u003eThe ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)\u003c/p\u003e\n \u003c/li\u003e\n \u003cli\u003e\n \u003cp\u003eThe ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)\u003c/p\u003e\n \u003c/li\u003e\n \u003cli\u003e\n \u003cp\u003eThe ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight\n ARN. Use this option only to share resources (templates) across Amazon Web Services accounts.\n (This is less common.) \u003c/p\u003e\n \u003c/li\u003e\n \u003c/ul\u003e", "maxLength": 256, "minLength": 1, "type": "string" @@ -113,6 +126,7 @@ }, "SheetStyle": { "additionalProperties": false, + "description": "\u003cp\u003eThe theme display options for sheets. \u003c/p\u003e", "properties": { "Tile": { "$ref": "#/definitions/TileStyle" @@ -125,13 +139,16 @@ }, "Tag": { "additionalProperties": false, + "description": "\u003cp\u003eThe key or keys of the key-value pairs for the resource tag or tags assigned to the\n resource.\u003c/p\u003e", "properties": { "Key": { + "description": "\u003cp\u003eTag key.\u003c/p\u003e", "maxLength": 128, "minLength": 1, "type": "string" }, "Value": { + "description": "\u003cp\u003eTag value.\u003c/p\u003e", "maxLength": 256, "minLength": 1, "type": "string" @@ -145,6 +162,7 @@ }, "ThemeConfiguration": { "additionalProperties": false, + "description": "\u003cp\u003eThe theme configuration. This configuration contains all of the display properties for\n a theme.\u003c/p\u003e", "properties": { "DataColorPalette": { "$ref": "#/definitions/DataColorPalette" @@ -163,9 +181,11 @@ }, "ThemeError": { "additionalProperties": false, + "description": "\u003cp\u003eTheme error.\u003c/p\u003e", "properties": { "Message": { - "pattern": ".*\\S.*", + "description": "\u003cp\u003eThe error message.\u003c/p\u003e", + "pattern": "\\S", "type": "string" }, "Type": { @@ -190,29 +210,35 @@ }, "ThemeVersion": { "additionalProperties": false, + "description": "\u003cp\u003eA version of a theme.\u003c/p\u003e", "properties": { "Arn": { + "description": "\u003cp\u003eThe Amazon Resource Name (ARN) of the resource.\u003c/p\u003e", "type": "string" }, "BaseThemeId": { + "description": "\u003cp\u003eThe Amazon QuickSight-defined ID of the theme that a custom theme inherits from. All\n themes initially inherit from a default Amazon QuickSight theme.\u003c/p\u003e", "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "Configuration": { "$ref": "#/definitions/ThemeConfiguration" }, "CreatedTime": { + "description": "\u003cp\u003eThe date and time that this theme version was created.\u003c/p\u003e", "format": "date-time", "type": "string" }, "Description": { + "description": "\u003cp\u003eThe description of the theme.\u003c/p\u003e", "maxLength": 512, "minLength": 1, "type": "string" }, "Errors": { + "description": "\u003cp\u003eErrors associated with the theme.\u003c/p\u003e", "items": { "$ref": "#/definitions/ThemeError" }, @@ -223,6 +249,7 @@ "$ref": "#/definitions/ResourceStatus" }, "VersionNumber": { + "description": "\u003cp\u003eThe version number of the theme.\u003c/p\u003e", "minimum": 1, "type": "number" } @@ -231,6 +258,7 @@ }, "TileLayoutStyle": { "additionalProperties": false, + "description": "\u003cp\u003eThe display options for the layout of tiles on a sheet.\u003c/p\u003e", "properties": { "Gutter": { "$ref": "#/definitions/GutterStyle" @@ -243,6 +271,7 @@ }, "TileStyle": { "additionalProperties": false, + "description": "\u003cp\u003eDisplay options related to tiles on a sheet.\u003c/p\u003e", "properties": { "Border": { "$ref": "#/definitions/BorderStyle" @@ -266,68 +295,85 @@ }, "UIColorPalette": { "additionalProperties": false, + "description": "\u003cp\u003eThe theme colors that apply to UI and to charts, excluding data colors. The colors\n description is a hexadecimal color code that consists of six alphanumerical characters,\n prefixed with \u003ccode\u003e#\u003c/code\u003e, for example #37BFF5. For more information, see \u003ca href=\"https://docs.aws.amazon.com/quicksight/latest/user/themes-in-quicksight.html\"\u003eUsing Themes in Amazon QuickSight\u003c/a\u003e in the \u003ci\u003eAmazon QuickSight User\n Guide.\u003c/i\u003e\n \u003c/p\u003e", "properties": { "Accent": { + "description": "\u003cp\u003eThis color is that applies to selected states and buttons.\u003c/p\u003e", "pattern": "^#[A-F0-9]{6}$", "type": "string" }, "AccentForeground": { + "description": "\u003cp\u003eThe foreground color that applies to any text or other elements that appear over the\n accent color.\u003c/p\u003e", "pattern": "^#[A-F0-9]{6}$", "type": "string" }, "Danger": { + "description": "\u003cp\u003eThe color that applies to error messages.\u003c/p\u003e", "pattern": "^#[A-F0-9]{6}$", "type": "string" }, "DangerForeground": { + "description": "\u003cp\u003eThe foreground color that applies to any text or other elements that appear over the\n error color.\u003c/p\u003e", "pattern": "^#[A-F0-9]{6}$", "type": "string" }, "Dimension": { + "description": "\u003cp\u003eThe color that applies to the names of fields that are identified as\n dimensions.\u003c/p\u003e", "pattern": "^#[A-F0-9]{6}$", "type": "string" }, "DimensionForeground": { + "description": "\u003cp\u003eThe foreground color that applies to any text or other elements that appear over the\n dimension color.\u003c/p\u003e", "pattern": "^#[A-F0-9]{6}$", "type": "string" }, "Measure": { + "description": "\u003cp\u003eThe color that applies to the names of fields that are identified as measures.\u003c/p\u003e", "pattern": "^#[A-F0-9]{6}$", "type": "string" }, "MeasureForeground": { + "description": "\u003cp\u003eThe foreground color that applies to any text or other elements that appear over the\n measure color.\u003c/p\u003e", "pattern": "^#[A-F0-9]{6}$", "type": "string" }, "PrimaryBackground": { + "description": "\u003cp\u003eThe background color that applies to visuals and other high emphasis UI.\u003c/p\u003e", "pattern": "^#[A-F0-9]{6}$", "type": "string" }, "PrimaryForeground": { + "description": "\u003cp\u003eThe color of text and other foreground elements that appear over the primary\n background regions, such as grid lines, borders, table banding, icons, and so on.\u003c/p\u003e", "pattern": "^#[A-F0-9]{6}$", "type": "string" }, "SecondaryBackground": { + "description": "\u003cp\u003eThe background color that applies to the sheet background and sheet controls.\u003c/p\u003e", "pattern": "^#[A-F0-9]{6}$", "type": "string" }, "SecondaryForeground": { + "description": "\u003cp\u003eThe foreground color that applies to any sheet title, sheet control text, or UI that\n appears over the secondary background.\u003c/p\u003e", "pattern": "^#[A-F0-9]{6}$", "type": "string" }, "Success": { + "description": "\u003cp\u003eThe color that applies to success messages, for example the check mark for a\n successful download.\u003c/p\u003e", "pattern": "^#[A-F0-9]{6}$", "type": "string" }, "SuccessForeground": { + "description": "\u003cp\u003eThe foreground color that applies to any text or other elements that appear over the\n success color.\u003c/p\u003e", "pattern": "^#[A-F0-9]{6}$", "type": "string" }, "Warning": { + "description": "\u003cp\u003eThis color that applies to warning and informational messages.\u003c/p\u003e", "pattern": "^#[A-F0-9]{6}$", "type": "string" }, "WarningForeground": { + "description": "\u003cp\u003eThe foreground color that applies to any text or other elements that appear over the\n warning color.\u003c/p\u003e", "pattern": "^#[A-F0-9]{6}$", "type": "string" } @@ -393,6 +439,7 @@ ], "properties": { "Arn": { + "description": "\u003cp\u003eThe Amazon Resource Name (ARN) of the theme.\u003c/p\u003e", "type": "string" }, "AwsAccountId": { @@ -404,17 +451,19 @@ "BaseThemeId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "Configuration": { "$ref": "#/definitions/ThemeConfiguration" }, "CreatedTime": { + "description": "\u003cp\u003eThe date and time that the theme was created.\u003c/p\u003e", "format": "date-time", "type": "string" }, "LastUpdatedTime": { + "description": "\u003cp\u003eThe date and time that the theme was last updated.\u003c/p\u003e", "format": "date-time", "type": "string" }, @@ -442,7 +491,7 @@ "ThemeId": { "maxLength": 512, "minLength": 1, - "pattern": "[\\w\\-]+", + "pattern": "^[\\w\\-]+$", "type": "string" }, "Type": { @@ -474,9 +523,9 @@ "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-quicksight", "typeName": "AWS::QuickSight::Theme", "writeOnlyProperties": [ - "/properties/VersionDescription", + "/properties/BaseThemeId", "/properties/Configuration", - "/properties/BaseThemeId" + "/properties/VersionDescription" ] } } \ No newline at end of file diff --git a/artifacts/types/AWS::QuickSight::Topic.json b/artifacts/types/AWS::QuickSight::Topic.json index 5d5d24d0..7c6afa37 100644 --- a/artifacts/types/AWS::QuickSight::Topic.json +++ b/artifacts/types/AWS::QuickSight::Topic.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-QuickSight-Topic", "type": "AWS::QuickSight::Topic", - "time": "2023-10-12T19:10:24.155Z", + "time": "2024-05-01T16:03:26.336Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -530,6 +530,9 @@ "DefaultFormatting": { "$ref": "#/definitions/DefaultFormatting" }, + "DisableIndexing": { + "type": "boolean" + }, "Expression": { "maxLength": 4096, "minLength": 1, @@ -652,6 +655,9 @@ "DefaultFormatting": { "$ref": "#/definitions/DefaultFormatting" }, + "DisableIndexing": { + "type": "boolean" + }, "IsIncludedInTopic": { "default": false, "type": "boolean" @@ -713,6 +719,9 @@ "maxLength": 128, "minLength": 1, "type": "string" + }, + "UserExperienceVersion": { + "$ref": "#/definitions/TopicUserExperienceVersion" } }, "type": "object" @@ -906,6 +915,13 @@ ], "type": "string" }, + "TopicUserExperienceVersion": { + "enum": [ + "LEGACY", + "NEW_READER_EXPERIENCE" + ], + "type": "string" + }, "TypeParameters": { "additionalProperties": false, "patternProperties": { @@ -992,6 +1008,9 @@ "minLength": 0, "pattern": "^[A-Za-z0-9-_.\\\\+]*$", "type": "string" + }, + "UserExperienceVersion": { + "$ref": "#/definitions/TopicUserExperienceVersion" } }, "readOnlyProperties": [ diff --git a/artifacts/types/AWS::QuickSight::VPCConnection.json b/artifacts/types/AWS::QuickSight::VPCConnection.json index d1196962..6d3dbc19 100644 --- a/artifacts/types/AWS::QuickSight::VPCConnection.json +++ b/artifacts/types/AWS::QuickSight::VPCConnection.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-QuickSight-VPCConnection", "type": "AWS::QuickSight::VPCConnection", - "time": "2023-11-14T17:12:24.372Z", + "time": "2024-05-22T17:35:50.785Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -9,105 +9,65 @@ "/properties/VPCConnectionId" ], "definitions": { - "Arn": { - "type": "string" - }, - "DnsResolvers": { - "insertionOrder": false, - "items": { - "type": "string" - }, - "type": "array" - }, "NetworkInterface": { "additionalProperties": false, + "description": "\u003cp\u003eThe structure that contains information about a network interface.\u003c/p\u003e", "properties": { "AvailabilityZone": { + "description": "\u003cp\u003eThe availability zone that the network interface resides in.\u003c/p\u003e", "type": "string" }, "ErrorMessage": { + "description": "\u003cp\u003eAn error message.\u003c/p\u003e", "type": "string" }, "NetworkInterfaceId": { - "$ref": "#/definitions/NetworkInterfaceId" + "description": "\u003cp\u003eThe network interface ID.\u003c/p\u003e", + "maxLength": 255, + "minLength": 0, + "pattern": "^eni-[0-9a-z]*$", + "type": "string" }, "Status": { - "enum": [ - "CREATING", - "AVAILABLE", - "CREATION_FAILED", - "UPDATING", - "UPDATE_FAILED", - "DELETING", - "DELETED", - "DELETION_FAILED", - "DELETION_SCHEDULED", - "ATTACHMENT_FAILED_ROLLBACK_FAILED" - ], - "type": "string" + "$ref": "#/definitions/NetworkInterfaceStatus" }, "SubnetId": { - "$ref": "#/definitions/SubnetId" + "description": "\u003cp\u003eThe subnet ID associated with the network interface.\u003c/p\u003e", + "maxLength": 255, + "minLength": 1, + "pattern": "^subnet-[0-9a-z]*$", + "type": "string" } }, - "required": [], "type": "object" }, - "NetworkInterfaceId": { - "maxLength": 255, - "pattern": "^eni-[0-9a-z]*$", - "type": "string" - }, - "NetworkInterfaces": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/NetworkInterface" - }, - "maxItems": 15, - "type": "array" - }, - "RoleArn": { - "type": "string" - }, - "SecurityGroupId": { - "maxItems": 255, - "minItems": 1, - "pattern": "^sg-[0-9a-z]*$", - "type": "string" - }, - "SecurityGroupIds": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/SecurityGroupId" - }, - "maxItems": 16, - "minItems": 1, - "type": "array" - }, - "SubnetId": { - "maxLength": 255, - "minLength": 1, - "pattern": "^subnet-[0-9a-z]*$", + "NetworkInterfaceStatus": { + "enum": [ + "CREATING", + "AVAILABLE", + "CREATION_FAILED", + "UPDATING", + "UPDATE_FAILED", + "DELETING", + "DELETED", + "DELETION_FAILED", + "DELETION_SCHEDULED", + "ATTACHMENT_FAILED_ROLLBACK_FAILED" + ], "type": "string" }, - "SubnetIds": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/SubnetId" - }, - "maxItems": 15, - "minItems": 2, - "type": "array" - }, "Tag": { "additionalProperties": false, + "description": "\u003cp\u003eThe key or keys of the key-value pairs for the resource tag or tags assigned to the\n resource.\u003c/p\u003e", "properties": { "Key": { + "description": "\u003cp\u003eTag key.\u003c/p\u003e", "maxLength": 128, "minLength": 1, "type": "string" }, "Value": { + "description": "\u003cp\u003eTag value.\u003c/p\u003e", "maxLength": 256, "minLength": 1, "type": "string" @@ -119,15 +79,6 @@ ], "type": "object" }, - "Tags": { - "insertionOrder": false, - "items": { - "$ref": "#/definitions/Tag" - }, - "maxItems": 200, - "minItems": 1, - "type": "array" - }, "VPCConnectionAvailabilityStatus": { "enum": [ "AVAILABLE", @@ -136,12 +87,6 @@ ], "type": "string" }, - "VPCConnectionId": { - "maxLength": 1000, - "minLength": 1, - "pattern": "[\\w\\-]+", - "type": "string" - }, "VPCConnectionResourceStatus": { "enum": [ "CREATION_IN_PROGRESS", @@ -155,9 +100,6 @@ "DELETED" ], "type": "string" - }, - "VPCId": { - "type": "string" } }, "description": "Definition of the AWS::QuickSight::VPCConnection Resource Type.", @@ -207,7 +149,8 @@ ], "properties": { "Arn": { - "$ref": "#/definitions/Arn" + "description": "\u003cp\u003eThe Amazon Resource Name (ARN) of the VPC connection.\u003c/p\u003e", + "type": "string" }, "AvailabilityStatus": { "$ref": "#/definitions/VPCConnectionAvailabilityStatus" @@ -219,13 +162,19 @@ "type": "string" }, "CreatedTime": { + "description": "\u003cp\u003eThe time that the VPC connection was created.\u003c/p\u003e", "format": "date-time", "type": "string" }, "DnsResolvers": { - "$ref": "#/definitions/DnsResolvers" + "insertionOrder": false, + "items": { + "type": "string" + }, + "type": "array" }, "LastUpdatedTime": { + "description": "\u003cp\u003eThe time that the VPC connection was last updated.\u003c/p\u003e", "format": "date-time", "type": "string" }, @@ -235,28 +184,63 @@ "type": "string" }, "NetworkInterfaces": { - "$ref": "#/definitions/NetworkInterfaces" + "description": "\u003cp\u003eA list of network interfaces.\u003c/p\u003e", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/NetworkInterface" + }, + "maxItems": 15, + "minItems": 0, + "type": "array" }, "RoleArn": { - "$ref": "#/definitions/RoleArn" + "type": "string" }, "SecurityGroupIds": { - "$ref": "#/definitions/SecurityGroupIds" + "insertionOrder": false, + "items": { + "maxLength": 255, + "minLength": 1, + "pattern": "^sg-[0-9a-z]*$", + "type": "string" + }, + "maxItems": 16, + "minItems": 1, + "type": "array" }, "Status": { "$ref": "#/definitions/VPCConnectionResourceStatus" }, "SubnetIds": { - "$ref": "#/definitions/SubnetIds" + "insertionOrder": false, + "items": { + "maxLength": 255, + "minLength": 1, + "pattern": "^subnet-[0-9a-z]*$", + "type": "string" + }, + "maxItems": 15, + "minItems": 2, + "type": "array" }, "Tags": { - "$ref": "#/definitions/Tags" + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 1, + "type": "array" }, "VPCConnectionId": { - "$ref": "#/definitions/VPCConnectionId" + "maxLength": 1000, + "minLength": 1, + "pattern": "[\\w\\-]+", + "type": "string" }, "VPCId": { - "$ref": "#/definitions/VPCId" + "description": "\u003cp\u003eThe Amazon EC2 VPC ID associated with the VPC connection.\u003c/p\u003e", + "type": "string" } }, "readOnlyProperties": [ diff --git a/artifacts/types/AWS::RAM::Permission.json b/artifacts/types/AWS::RAM::Permission.json index 3a7ae7e9..bb7e80c6 100644 --- a/artifacts/types/AWS::RAM::Permission.json +++ b/artifacts/types/AWS::RAM::Permission.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-RAM-Permission", "type": "AWS::RAM::Permission", - "time": "2024-01-03T14:49:58.13Z", + "time": "2024-04-01T13:40:40.167Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::RDS::CustomDBEngineVersion.json b/artifacts/types/AWS::RDS::CustomDBEngineVersion.json index 3f86b0f5..0456afc5 100644 --- a/artifacts/types/AWS::RDS::CustomDBEngineVersion.json +++ b/artifacts/types/AWS::RDS::CustomDBEngineVersion.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-RDS-CustomDBEngineVersion", "type": "AWS::RDS::CustomDBEngineVersion", - "time": "2023-08-10T10:31:53.999Z", + "time": "2024-06-20T01:11:20.919Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -9,8 +9,11 @@ "/properties/EngineVersion", "/properties/DatabaseInstallationFilesS3BucketName", "/properties/DatabaseInstallationFilesS3Prefix", + "/properties/ImageId", "/properties/KMSKeyId", - "/properties/Manifest" + "/properties/Manifest", + "/properties/SourceCustomDbEngineVersionIdentifier", + "/properties/UseAwsProvidedLatestImage" ], "definitions": { "Tag": { @@ -40,9 +43,14 @@ "handlers": { "create": { "permissions": [ - "iam:PassRole", + "ec2:CopySnapshot", + "ec2:DeleteSnapshot", + "ec2:DescribeSnapshots", "kms:CreateGrant", + "kms:Decrypt", "kms:DescribeKey", + "kms:GenerateDataKey", + "kms:ReEncrypt", "mediaimport:CreateDatabaseBinarySnapshot", "rds:AddTagsToResource", "rds:CreateCustomDBEngineVersion", @@ -125,6 +133,10 @@ "minLength": 1, "type": "string" }, + "ImageId": { + "description": "The identifier of Amazon Machine Image (AMI) used for CEV.", + "type": "string" + }, "KMSKeyId": { "description": "The AWS KMS key identifier for an encrypted CEV. A symmetric KMS key is required for RDS Custom, but optional for Amazon RDS.", "maxLength": 2048, @@ -137,6 +149,10 @@ "minLength": 1, "type": "string" }, + "SourceCustomDbEngineVersionIdentifier": { + "description": "The identifier of the source custom engine version.", + "type": "string" + }, "Status": { "default": "available", "description": "The availability status to be assigned to the CEV.", @@ -155,6 +171,10 @@ }, "type": "array", "uniqueItems": false + }, + "UseAwsProvidedLatestImage": { + "description": "A value that indicates whether AWS provided latest image is applied automatically to the Custom Engine Version. By default, AWS provided latest image is applied automatically. This value is only applied on create.", + "type": "boolean" } }, "propertyTransform": { @@ -166,7 +186,6 @@ "/properties/DBEngineVersionArn" ], "required": [ - "DatabaseInstallationFilesS3BucketName", "Engine", "EngineVersion" ], @@ -176,7 +195,9 @@ }, "typeName": "AWS::RDS::CustomDBEngineVersion", "writeOnlyProperties": [ - "/properties/Manifest" + "/properties/Manifest", + "/properties/SourceCustomDbEngineVersionIdentifier", + "/properties/UseAwsProvidedLatestImage" ] } } \ No newline at end of file diff --git a/artifacts/types/AWS::RDS::DBCluster.json b/artifacts/types/AWS::RDS::DBCluster.json index 4b53b740..b7afef62 100644 --- a/artifacts/types/AWS::RDS::DBCluster.json +++ b/artifacts/types/AWS::RDS::DBCluster.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-RDS-DBCluster", "type": "AWS::RDS::DBCluster", - "time": "2023-12-18T10:26:08.782Z", + "time": "2024-06-21T12:00:51.146Z", "schema": { "additionalProperties": false, "conditionalCreateOnlyProperties": [ @@ -120,14 +120,10 @@ "properties": { "MaxCapacity": { "description": "The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128.", - "maximum": 128, - "minimum": 0.5, "type": "number" }, "MinCapacity": { "description": "The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.", - "maximum": 128, - "minimum": 0.5, "type": "number" } }, @@ -167,7 +163,10 @@ "rds:CreateDBCluster", "rds:CreateDBInstance", "rds:DescribeDBClusters", + "rds:DescribeDBClusterSnapshots", + "rds:DescribeDBSnapshots", "rds:DescribeEvents", + "rds:EnableHttpEndpoint", "rds:ModifyDBCluster", "rds:RestoreDBClusterFromSnapshot", "rds:RestoreDBClusterToPointInTime", @@ -206,6 +205,8 @@ "rds:DescribeDBSubnetGroups", "rds:DescribeEvents", "rds:DescribeGlobalClusters", + "rds:DisableHttpEndpoint", + "rds:EnableHttpEndpoint", "rds:ModifyDBCluster", "rds:ModifyDBInstance", "rds:RemoveFromGlobalCluster", @@ -326,13 +327,17 @@ "type": "boolean" }, "EnableHttpEndpoint": { - "description": "A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled.", + "description": "A value that indicates whether to enable the HTTP endpoint for DB cluster. By default, the HTTP endpoint is disabled.", "type": "boolean" }, "EnableIAMDatabaseAuthentication": { "description": "A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.", "type": "boolean" }, + "EnableLocalWriteForwarding": { + "description": "Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.", + "type": "boolean" + }, "Endpoint": { "$ref": "#/definitions/Endpoint" }, @@ -340,6 +345,10 @@ "description": "The name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql", "type": "string" }, + "EngineLifecycleSupport": { + "description": "The life cycle type of the DB cluster. You can use this setting to enroll your DB cluster into Amazon RDS Extended Support.", + "type": "string" + }, "EngineMode": { "description": "The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.", "type": "string" @@ -462,6 +471,10 @@ "description": "Indicates whether the DB instance is encrypted.\nIf you specify the DBClusterIdentifier, SnapshotIdentifier, or SourceDBInstanceIdentifier property, don't specify this property. The value is inherited from the cluster, snapshot, or source DB instance.", "type": "boolean" }, + "StorageThroughput": { + "description": "Specifies the storage throughput value for the DB cluster. This setting applies only to the gp3 storage type.", + "type": "integer" + }, "StorageType": { "description": "Specifies the storage type to be associated with the DB cluster.", "type": "string" @@ -493,7 +506,7 @@ "/properties/DBClusterIdentifier": "$lowercase(DBClusterIdentifier)", "/properties/DBClusterParameterGroupName": "$lowercase(DBClusterParameterGroupName)", "/properties/DBSubnetGroupName": "$lowercase(DBSubnetGroupName)", - "/properties/EnableHttpEndpoint": "$lowercase($string(EngineMode)) = 'serverless' ? EnableHttpEndpoint : false", + "/properties/EnableHttpEndpoint": "$lowercase($string(EngineMode)) = 'serverless' ? EnableHttpEndpoint : ($lowercase($string(Engine)) = 'aurora-postgresql' ? EnableHttpEndpoint : false )", "/properties/Engine": "$lowercase(Engine)", "/properties/EngineVersion": "$join([$string(EngineVersion), \".*\"])", "/properties/KmsKeyId": "$join([\"arn:(aws)[-]{0,1}[a-z]{0,2}[-]{0,1}[a-z]{0,3}:kms:[a-z]{2}[-]{1}[a-z]{3,10}[-]{0,1}[a-z]{0,10}[-]{1}[1-3]{1}:[0-9]{12}[:]{1}key\\/\", KmsKeyId])", @@ -513,7 +526,8 @@ "/properties/Endpoint/Port", "/properties/ReadEndpoint/Port", "/properties/ReadEndpoint/Address", - "/properties/MasterUserSecret/SecretArn" + "/properties/MasterUserSecret/SecretArn", + "/properties/StorageThroughput" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-rds", "typeName": "AWS::RDS::DBCluster", diff --git a/artifacts/types/AWS::RDS::DBClusterParameterGroup.json b/artifacts/types/AWS::RDS::DBClusterParameterGroup.json index d25c3046..ee5c181b 100644 --- a/artifacts/types/AWS::RDS::DBClusterParameterGroup.json +++ b/artifacts/types/AWS::RDS::DBClusterParameterGroup.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-RDS-DBClusterParameterGroup", "type": "AWS::RDS::DBClusterParameterGroup", - "time": "2023-12-18T10:44:36.609Z", + "time": "2024-06-21T11:54:29.345Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::RDS::DBInstance.json b/artifacts/types/AWS::RDS::DBInstance.json index 11a3ed30..67f1a34b 100644 --- a/artifacts/types/AWS::RDS::DBInstance.json +++ b/artifacts/types/AWS::RDS::DBInstance.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-RDS-DBInstance", "type": "AWS::RDS::DBInstance", - "time": "2023-12-18T10:26:07.107Z", + "time": "2024-06-21T12:02:29.008Z", "schema": { "additionalProperties": false, "conditionalCreateOnlyProperties": [ @@ -41,13 +41,14 @@ "definitions": { "CertificateDetails": { "additionalProperties": false, + "description": "Returns the details of the DB instance?s server certificate.\n For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the *Amazon RDS User Guide* and [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 User Guide*.", "properties": { "CAIdentifier": { "description": "The CA identifier of the CA certificate used for the DB instance's server certificate.", "type": "string" }, "ValidTill": { - "description": "The expiration date of the DB instance’s server certificate.", + "description": "The expiration date of the DB instance?s server certificate.", "format": "date-time", "type": "string" } @@ -56,9 +57,10 @@ }, "DBInstanceRole": { "additionalProperties": false, + "description": "Information about an AWS Identity and Access Management (IAM) role that is associated with a DB instance.", "properties": { "FeatureName": { - "description": "The name of the feature associated with the AWS Identity and Access Management (IAM) role. IAM roles that are associated with a DB instance grant permission for the DB instance to access other AWS services on your behalf.", + "description": "The name of the feature associated with the AWS Identity and Access Management (IAM) role. IAM roles that are associated with a DB instance grant permission for the DB instance to access other AWS services on your behalf. For the list of supported feature names, see the ``SupportedFeatureNames`` description in [DBEngineVersion](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DBEngineVersion.html) in the *Amazon RDS API Reference*.", "type": "string" }, "RoleArn": { @@ -74,6 +76,7 @@ }, "Endpoint": { "additionalProperties": false, + "description": "This data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a response element in the following actions:\n + ``CreateDBInstance`` \n + ``DescribeDBInstances`` \n + ``DeleteDBInstance`` \n \n For the data structure that represents Amazon Aurora DB cluster endpoints, see ``DBClusterEndpoint``.", "properties": { "Address": { "description": "Specifies the DNS address of the DB instance.", @@ -92,6 +95,7 @@ }, "MasterUserSecret": { "additionalProperties": false, + "description": "The ``MasterUserSecret`` return value specifies the secret managed by RDS in AWS Secrets Manager for the master user password.\n For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide* and [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) in the *Amazon Aurora User Guide.*", "properties": { "KmsKeyId": { "description": "The AWS KMS key identifier that is used to encrypt the secret.", @@ -106,9 +110,10 @@ }, "ProcessorFeature": { "additionalProperties": false, + "description": "The ``ProcessorFeature`` property type specifies the processor features of a DB instance class status.", "properties": { "Name": { - "description": "The name of the processor feature. Valid names are coreCount and threadsPerCore.", + "description": "The name of the processor feature. Valid names are ``coreCount`` and ``threadsPerCore``.", "enum": [ "coreCount", "threadsPerCore" @@ -124,16 +129,16 @@ }, "Tag": { "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", + "description": "Metadata assigned to an Amazon RDS resource consisting of a key-value pair.\n For more information, see [Tagging Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*.", "properties": { "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "description": "A 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}_.:/=+\\\\-@]*)$\").", "maxLength": 128, "minLength": 1, "type": "string" }, "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "description": "A 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}_.:/=+\\\\-@]*)$\").", "maxLength": 256, "minLength": 0, "type": "string" @@ -149,7 +154,7 @@ "/properties/TdeCredentialArn", "/properties/TdeCredentialPassword" ], - "description": "The AWS::RDS::DBInstance resource creates an Amazon RDS DB instance.", + "description": "The ``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 in an Aurora DB cluster.\n For more information about creating an RDS DB instance, see [Creating an Amazon RDS DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateDBInstance.html) in the *Amazon RDS User Guide*.\n For 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*.\n If you import an existing DB instance, and the template configuration doesn't match the actual configuration of the DB instance, AWS CloudFormation applies the changes in the template during the import operation.\n If a DB instance is deleted or replaced during an update, AWS CloudFormation deletes all automated snapshots. However, it retains manual DB snapshots. During an update that requires replacement, you can apply a stack policy to prevent DB instances from being replaced. For more information, see [Prevent Updates to Stack Resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html).\n *Updating DB instances* \n When properties labeled \"*Update requires:* [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\" are updated, AWS CloudFormation first creates a replacement DB instance, then changes references from other dependent resources to point to the replacement DB instance, and finally deletes the old DB instance.\n We highly recommend that you take a snapshot of the database before updating the stack. If you don't, you lose the data when AWS CloudFormation replaces your DB instance. To preserve your data, perform the following procedure:\n 1. Deactivate any applications that are using the DB instance so that there's no activity on the DB instance.\n 1. Create a snapshot of the DB instance. For more information, see [Creating a DB Snapshot](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateSnapshot.html).\n 1. If you want to restore your instance using a DB snapshot, modify the updated template with your DB instance changes and add the ``DBSnapshotIdentifier`` property with the ID of the DB snapshot that you want to use.\n After you restore a DB instance with a ``DBSnapshotIdentifier`` property, you can delete the ``DBSnapshotIdentifier`` property. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify the ``DBSnapshotIdentifier`` property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specified ``DBSnapshotIdentifier`` property, and the original DB instance is deleted.\n 1. Update the stack.\n \n For more information about updating other properties of this resource, see ``ModifyDBInstance``. For more information about updating stacks, see [CloudFormation Stacks Updates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html).\n *Deleting DB instances* \n For DB instances that are part of an Aurora DB cluster, you can set a deletion policy for your DB instance to control how AWS CloudFormation handles the DB instance when the stack is deleted. For Amazon RDS DB instances, you can choose to *retain* the DB instance, to *delete* the DB instance, or to *create a snapshot* of the DB instance. The default AWS CloudFormation behavior depends on the ``DBClusterIdentifier`` property:\n 1. For ``AWS::RDS::DBInstance`` resources that don't specify the ``DBClusterIdentifier`` property, AWS CloudFormation saves a snapshot of the DB instance.\n 1. For ``AWS::RDS::DBInstance`` resources that do specify the ``DBClusterIdentifier`` property, AWS CloudFormation deletes the DB instance.\n \n For more information, see [DeletionPolicy Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html).", "handlers": { "create": { "permissions": [ @@ -251,16 +256,16 @@ ], "properties": { "AllocatedStorage": { - "description": "The amount of storage (in gigabytes) to be initially allocated for the database instance.", + "description": "The amount of storage in gibibytes (GiB) to be initially allocated for the database instance.\n If any value is set in the ``Iops`` parameter, ``AllocatedStorage`` must be at least 100 GiB, which corresponds to the minimum Iops value of 1,000. If you increase the ``Iops`` value (in 1,000 IOPS increments), then you must also increase the ``AllocatedStorage`` value (in 100-GiB increments). \n *Amazon Aurora* \n Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.\n *Db2* \n Constraints 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 \n *MySQL* \n Constraints 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 \n *MariaDB* \n Constraints 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 \n *PostgreSQL* \n Constraints 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 \n *Oracle* \n Constraints 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 \n *SQL Server* \n Constraints to the amount of storage for each storage type are the following: \n + General Purpose (SSD) storage (gp2):\n + Enterprise and Standard editions: Must be an integer from 20 to 16384.\n + Web and Express editions: Must be an integer from 20 to 16384.\n \n + Provisioned IOPS storage (io1):\n + Enterprise and Standard editions: Must be an integer from 20 to 16384.\n + Web and Express editions: Must be an integer from 20 to 16384.\n \n + Magnetic storage (standard):\n + Enterprise and Standard editions: Must be an integer from 20 to 1024.\n + Web and Express editions: Must be an integer from 20 to 1024.", "pattern": "^[0-9]*$", "type": "string" }, "AllowMajorVersionUpgrade": { - "description": "A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.", + "description": "A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.\n Constraints: Major version upgrades must be allowed when specifying a value for the ``EngineVersion`` parameter that is a different major version than the DB instance's current version.", "type": "boolean" }, "AssociatedRoles": { - "description": "The AWS Identity and Access Management (IAM) roles associated with the DB instance.", + "description": "The IAMlong (IAM) roles associated with the DB instance. \n *Amazon Aurora* \n Not applicable. The associated roles are managed by the DB cluster.", "items": { "$ref": "#/definitions/DBInstanceRole" }, @@ -270,42 +275,46 @@ "description": "A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.", "type": "boolean" }, + "AutomaticBackupReplicationKmsKeyId": { + "description": "The AWS KMS key identifier for encryption of the replicated automated backups. The KMS key ID is the Amazon Resource Name (ARN) for the KMS encryption key in the destination AWS-Region, for example, ``arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE``.", + "type": "string" + }, "AutomaticBackupReplicationRegion": { - "description": "Enables replication of automated backups to a different Amazon Web Services Region.", + "description": "The destination region for the backup replication of the DB instance. For more info, see [Replicating automated backups to another Region](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReplicateBackups.html) in the *Amazon RDS User Guide*.", "type": "string" }, "AvailabilityZone": { - "description": "The Availability Zone (AZ) where the database will be created. For information on AWS Regions and Availability Zones.", + "description": "The Availability Zone (AZ) where the database will be created. For information on AWS-Regions and Availability Zones, see [Regions and Availability Zones](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html).\n For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one.\n Default: A random, system-chosen Availability Zone in the endpoint's AWS-Region.\n Constraints:\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.\n \n Example: ``us-east-1d``", "type": "string" }, "BackupRetentionPeriod": { "default": 1, - "description": "The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.", + "description": "The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.\n *Amazon Aurora* \n Not applicable. The retention period for automated backups is managed by the DB cluster.\n Default: 1\n Constraints:\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", "minimum": 0, "type": "integer" }, "CACertificateIdentifier": { - "description": "The identifier of the CA certificate for this DB instance.", + "description": "The identifier of the CA certificate for this DB instance.\n For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the *Amazon RDS User Guide* and [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 User Guide*.", "type": "string" }, "CertificateDetails": { "$ref": "#/definitions/CertificateDetails", - "description": "Returns the details of the DB instance's server certificate." + "description": "The details of the DB instance's server certificate." }, "CertificateRotationRestart": { - "description": "A value that indicates whether the DB instance is restarted when you rotate your SSL/TLS certificate.\nBy default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.\nIf you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate\nThis setting doesn't apply to RDS Custom.", + "description": "Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.\n By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.\n Set this parameter only if you are *not* using SSL/TLS to connect to the DB instance.\n If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate:\n + For more information about rotating your SSL/TLS certificate for RDS DB engines, see [Rotating Your SSL/TLS Certificate.](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon RDS User Guide.* \n + For more information about rotating your SSL/TLS certificate for Aurora DB engines, see [Rotating Your SSL/TLS Certificate](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon Aurora User Guide*.\n \n This setting doesn't apply to RDS Custom DB instances.", "type": "boolean" }, "CharacterSetName": { - "description": "For supported engines, indicates that the DB instance should be associated with the specified character set.", + "description": "For supported engines, indicates that the DB instance should be associated with the specified character set.\n *Amazon Aurora* \n Not applicable. The character set is managed by the DB cluster. For more information, see [AWS::RDS::DBCluster](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html).", "type": "string" }, "CopyTagsToSnapshot": { - "description": "A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.", + "description": "Specifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.\n This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.", "type": "boolean" }, "CustomIAMInstanceProfile": { - "description": "The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:\n * The profile must exist in your account.\n * The profile must have an IAM role that Amazon EC2 has permissions to assume.\n * The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom .\nFor the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide .\n\nThis setting is required for RDS Custom.", + "description": "The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.\n This setting is required for RDS Custom.\n Constraints:\n + The profile must exist in your account.\n + The profile must have an IAM role that Amazon EC2 has permissions to assume.\n + The instance profile name and the associated IAM role name must start with the prefix ``AWSRDSCustom``.\n \n For the list of permissions required for the IAM role, see [Configure IAM and your VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc) in the *Amazon RDS User Guide*.", "type": "string" }, "DBClusterIdentifier": { @@ -313,34 +322,34 @@ "type": "string" }, "DBClusterSnapshotIdentifier": { - "description": "The identifier for the RDS for MySQL Multi-AZ DB cluster snapshot to restore from. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide .\n\nConstraints:\n * Must match the identifier of an existing Multi-AZ DB cluster snapshot.\n * Can't be specified when DBSnapshotIdentifier is specified.\n * Must be specified when DBSnapshotIdentifier isn't specified.\n * If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the DBClusterSnapshotIdentifier must be the ARN of the shared snapshot.\n * Can't be the identifier of an Aurora DB cluster snapshot.\n * Can't be the identifier of an RDS for PostgreSQL Multi-AZ DB cluster snapshot.", + "description": "The identifier for the Multi-AZ DB cluster snapshot to restore from.\n For more information on Multi-AZ DB clusters, see [Multi-AZ DB cluster deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide*.\n Constraints:\n + Must match the identifier of an existing Multi-AZ DB cluster snapshot.\n + Can't be specified when ``DBSnapshotIdentifier`` is specified.\n + Must be specified when ``DBSnapshotIdentifier`` isn't specified.\n + If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the ``DBClusterSnapshotIdentifier`` must be the ARN of the shared snapshot.\n + Can't be the identifier of an Aurora DB cluster snapshot.", "type": "string" }, "DBInstanceArn": { - "description": "The Amazon Resource Name (ARN) for the DB instance.", + "description": "", "type": "string" }, "DBInstanceClass": { - "description": "The compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines.", + "description": "The compute and memory capacity of the DB instance, for example ``db.m5.large``. Not all DB instance classes are available in all AWS-Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see [DB instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide* or [Aurora DB instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.DBInstanceClass.html) in the *Amazon Aurora User Guide*.", "type": "string" }, "DBInstanceIdentifier": { - "description": "A name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance.", + "description": "A name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).\n For information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide*.\n If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.", "maxLength": 63, "minLength": 1, "pattern": "^$|^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$", "type": "string" }, "DBName": { - "description": "The meaning of this parameter differs according to the database engine you use.", + "description": "The meaning of this parameter differs according to the database engine you use.\n If you specify the ``DBSnapshotIdentifier`` property, this property only applies to RDS for Oracle.\n *Amazon Aurora* \n Not applicable. The database name is managed by the DB cluster.\n *Db2* \n The 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.\n Constraints:\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 \n *MySQL* \n The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.\n Constraints:\n + Must contain 1 to 64 letters or numbers.\n + Can't be a word reserved by the specified database engine\n \n *MariaDB* \n The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.\n Constraints:\n + Must contain 1 to 64 letters or numbers.\n + Can't be a word reserved by the specified database engine\n \n *PostgreSQL* \n The name of the database to create when the DB instance is created. If this parameter is not specified, the default ``postgres`` database is created in the DB instance.\n Constraints:\n + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).\n + Must contain 1 to 63 characters.\n + Can't be a word reserved by the specified database engine\n \n *Oracle* \n The Oracle System ID (SID) of the created DB instance. If you specify ``null``, the default value ``ORCL`` is used. You can't specify the string NULL, or any other reserved word, for ``DBName``. \n Default: ``ORCL`` \n Constraints:\n + Can't be longer than 8 characters\n \n *SQL Server* \n Not applicable. Must be null.", "type": "string" }, "DBParameterGroupName": { - "description": "The name of an existing DB parameter group or a reference to an AWS::RDS::DBParameterGroup resource created in the template.", + "description": "The name of an existing DB parameter group or a reference to an [AWS::RDS::DBParameterGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html) resource created in the template.\n To list all of the available DB parameter group names, use the following command:\n ``aws rds describe-db-parameter-groups --query \"DBParameterGroups[].DBParameterGroupName\" --output text`` \n If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot.\n If you don't specify a value for ``DBParameterGroupName`` property, the default DB parameter group for the specified engine and engine version is used.", "type": "string" }, "DBSecurityGroups": { - "description": "A list of the DB security groups to assign to the DB instance. The list can include both the name of existing DB security groups or references to AWS::RDS::DBSecurityGroup resources created in the template.", + "description": "A list of the DB security groups to assign to the DB instance. The list can include both the name of existing DB security groups or references to AWS::RDS::DBSecurityGroup resources created in the template.\n If you set DBSecurityGroups, you must not set VPCSecurityGroups, and vice versa. Also, note that the DBSecurityGroups property exists only for backwards compatibility with older regions and is no longer recommended for providing security information to an RDS DB instance. Instead, use VPCSecurityGroups.\n If you specify this property, AWS CloudFormation sends only the following properties (if specified) to Amazon RDS during create operations:\n + ``AllocatedStorage`` \n + ``AutoMinorVersionUpgrade`` \n + ``AvailabilityZone`` \n + ``BackupRetentionPeriod`` \n + ``CharacterSetName`` \n + ``DBInstanceClass`` \n + ``DBName`` \n + ``DBParameterGroupName`` \n + ``DBSecurityGroups`` \n + ``DBSubnetGroupName`` \n + ``Engine`` \n + ``EngineVersion`` \n + ``Iops`` \n + ``LicenseModel`` \n + ``MasterUsername`` \n + ``MasterUserPassword`` \n + ``MultiAZ`` \n + ``OptionGroupName`` \n + ``PreferredBackupWindow`` \n + ``PreferredMaintenanceWindow`` \n \n All other properties are ignored. Specify a virtual private cloud (VPC) security group if you want to submit other properties, such as ``StorageType``, ``StorageEncrypted``, or ``KmsKeyId``. If you're already using the ``DBSecurityGroups`` property, you can't use these other properties by updating your DB instance to use a VPC security group. You must recreate the DB instance.", "items": { "type": "string" }, @@ -348,19 +357,19 @@ "uniqueItems": true }, "DBSnapshotIdentifier": { - "description": "The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot.", + "description": "The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot.\n By specifying this property, you can create a DB instance from the specified DB snapshot. If the ``DBSnapshotIdentifier`` property is an empty string or the ``AWS::RDS::DBInstance`` declaration has no ``DBSnapshotIdentifier`` property, AWS CloudFormation creates a new database. If the property contains a value (other than an empty string), AWS CloudFormation creates a database from the specified snapshot. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack.\n Some DB instance properties aren't valid when you restore from a snapshot, such as the ``MasterUsername`` and ``MasterUserPassword`` properties. For information about the properties that you can specify, see the ``RestoreDBInstanceFromDBSnapshot`` action in the *Amazon RDS API Reference*.\n After you restore a DB instance with a ``DBSnapshotIdentifier`` property, you must specify the same ``DBSnapshotIdentifier`` property for any future updates to the DB instance. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify the ``DBSnapshotIdentifier`` property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specified ``DBSnapshotIdentifier`` property, and the original DB instance is deleted.\n If you specify the ``DBSnapshotIdentifier`` property to restore a DB instance (as opposed to specifying it for DB instance updates), then don't specify the following properties:\n + ``CharacterSetName`` \n + ``DBClusterIdentifier`` \n + ``DBName`` \n + ``DeleteAutomatedBackups`` \n + ``EnablePerformanceInsights`` \n + ``KmsKeyId`` \n + ``MasterUsername`` \n + ``MasterUserPassword`` \n + ``PerformanceInsightsKMSKeyId`` \n + ``PerformanceInsightsRetentionPeriod`` \n + ``PromotionTier`` \n + ``SourceDBInstanceIdentifier`` \n + ``SourceRegion`` \n + ``StorageEncrypted`` (for an encrypted snapshot)\n + ``Timezone`` \n \n *Amazon Aurora* \n Not applicable. Snapshot restore is managed by the DB cluster.", "type": "string" }, "DBSubnetGroupName": { - "description": "A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new VPC.", + "description": "A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new VPC. \n If there's no DB subnet group, then the DB instance isn't a VPC DB instance.\n For more information about using Amazon RDS in a VPC, see [Using Amazon RDS with Amazon Virtual Private Cloud (VPC)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html) in the *Amazon RDS User Guide*. \n *Amazon Aurora* \n Not applicable. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting.", "type": "string" }, "DBSystemId": { - "description": "The Oracle system ID (Oracle SID) for a container database (CDB). The Oracle SID is also the name of the CDB. This setting is valid for RDS Custom only.", + "description": "The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. In this context, the term \"Oracle database instance\" refers exclusively to the system global area (SGA) and Oracle background processes. If you don't specify a SID, the value defaults to ``RDSCDB``. The Oracle SID is also the name of your CDB.", "type": "string" }, "DbiResourceId": { - "description": "The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed.", + "description": "", "type": "string" }, "DedicatedLogVolume": { @@ -368,150 +377,154 @@ "type": "boolean" }, "DeleteAutomatedBackups": { - "description": "A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted.", + "description": "A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted.\n *Amazon Aurora* \n Not applicable. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the DB cluster are not deleted.", "type": "boolean" }, "DeletionProtection": { - "description": "A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.", + "description": "A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see [Deleting a DB Instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html). \n *Amazon Aurora* \n Not applicable. You can enable or disable deletion protection for the DB cluster. For more information, see ``CreateDBCluster``. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster.", "type": "boolean" }, "Domain": { - "description": "The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.", + "description": "The 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.\n For more information, see [Kerberos Authentication](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html) in the *Amazon RDS User Guide*.", "type": "string" }, "DomainAuthSecretArn": { - "description": "The ARN for the Secrets Manager secret with the credentials for the user joining the domain.", + "description": "The ARN for the Secrets Manager secret with the credentials for the user joining the domain.\n Example: ``arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456``", "type": "string" }, "DomainDnsIps": { - "description": "The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.", + "description": "The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.\n Constraints:\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.\n \n Example: ``123.124.125.126,234.235.236.237``", "items": { "type": "string" }, "type": "array" }, "DomainFqdn": { - "description": "The fully qualified domain name (FQDN) of an Active Directory domain.", + "description": "The fully qualified domain name (FQDN) of an Active Directory domain.\n Constraints:\n + Can't be longer than 64 characters.\n \n Example: ``mymanagedADtest.mymanagedAD.mydomain``", "type": "string" }, "DomainIAMRoleName": { - "description": "Specify the name of the IAM role to be used when making API calls to the Directory Service.", + "description": "The name of the IAM role to use when making API calls to the Directory Service.\n This setting doesn't apply to the following DB instances:\n + Amazon Aurora (The domain is managed by the DB cluster.)\n + RDS Custom", "type": "string" }, "DomainOu": { - "description": "The Active Directory organizational unit for your DB instance to join.", + "description": "The Active Directory organizational unit for your DB instance to join.\n Constraints:\n + Must be in the distinguished name format.\n + Can't be longer than 64 characters.\n \n Example: ``OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain``", "type": "string" }, "EnableCloudwatchLogsExports": { - "description": "The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used.", + "description": "The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see [Publishing Database Logs to Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the *Amazon Relational Database Service User Guide*.\n *Amazon Aurora* \n Not applicable. CloudWatch Logs exports are managed by the DB cluster. \n *Db2* \n Valid values: ``diag.log``, ``notify.log`` \n *MariaDB* \n Valid values: ``audit``, ``error``, ``general``, ``slowquery`` \n *Microsoft SQL Server* \n Valid values: ``agent``, ``error`` \n *MySQL* \n Valid values: ``audit``, ``error``, ``general``, ``slowquery`` \n *Oracle* \n Valid values: ``alert``, ``audit``, ``listener``, ``trace``, ``oemagent`` \n *PostgreSQL* \n Valid values: ``postgresql``, ``upgrade``", "items": { "type": "string" }, "type": "array" }, "EnableIAMDatabaseAuthentication": { - "description": "A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.", + "description": "A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.\n This property is supported for RDS for MariaDB, RDS for MySQL, and RDS for PostgreSQL. For more information, see [IAM Database Authentication for MariaDB, MySQL, and PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon RDS User Guide.* \n *Amazon Aurora* \n Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.", "type": "boolean" }, "EnablePerformanceInsights": { - "description": "A value that indicates whether to enable Performance Insights for the DB instance.", + "description": "Specifies whether to enable Performance Insights for the DB instance. For more information, see [Using Amazon Performance Insights](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) in the *Amazon RDS User Guide*.\n This setting doesn't apply to RDS Custom DB instances.", "type": "boolean" }, "Endpoint": { "$ref": "#/definitions/Endpoint", - "description": "Specifies the connection endpoint." + "description": "The connection endpoint for the DB instance.\n The endpoint might not be shown for instances with the status of ``creating``." }, "Engine": { - "description": "The name of the database engine that you want to use for this DB instance.", + "description": "The name of the database engine to use for this DB instance. Not every database engine is available in every AWS Region.\n This property is required when creating a DB instance.\n You can convert an Oracle database from the non-CDB architecture to the container database (CDB) architecture by updating the ``Engine`` value in your templates from ``oracle-ee`` to ``oracle-ee-cdb`` or from ``oracle-se2`` to ``oracle-se2-cdb``. Converting to the CDB architecture requires an interruption.\n Valid 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``", + "type": "string" + }, + "EngineLifecycleSupport": { + "description": "", "type": "string" }, "EngineVersion": { - "description": "The version number of the database engine to use.", + "description": "The version number of the database engine to use.\n For a list of valid engine versions, use the ``DescribeDBEngineVersions`` action.\n The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region.\n *Amazon Aurora* \n Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster.\n *Db2* \n See [Amazon RDS for Db2](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Db2.html#Db2.Concepts.VersionMgmt) in the *Amazon RDS User Guide.* \n *MariaDB* \n See [MariaDB on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt) in the *Amazon RDS User Guide.* \n *Microsoft SQL Server* \n See [Microsoft SQL Server Versions on Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport) in the *Amazon RDS User Guide.* \n *MySQL* \n See [MySQL on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt) in the *Amazon RDS User Guide.* \n *Oracle* \n See [Oracle Database Engine Release Notes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html) in the *Amazon RDS User Guide.* \n *PostgreSQL* \n See [Supported PostgreSQL Database Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts.General.DBVersions) in the *Amazon RDS User Guide.*", "type": "string" }, "Iops": { - "description": "The number of I/O operations per second (IOPS) that the database provisions.", + "description": "The number of I/O operations per second (IOPS) that the database provisions. The value must be equal to or greater than 1000. \n If you specify this property, you must follow the range of allowed ratios of your requested IOPS rate to the amount of storage that you allocate (IOPS to allocated storage). For example, you can provision an Oracle database instance with 1000 IOPS and 200 GiB of storage (a ratio of 5:1), or specify 2000 IOPS with 200 GiB of storage (a ratio of 10:1). For more information, see [Amazon RDS Provisioned IOPS Storage to Improve Performance](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/CHAP_Storage.html#USER_PIOPS) in the *Amazon RDS User Guide*.\n If you specify ``io1`` for the ``StorageType`` property, then you must also specify the ``Iops`` property.\n Constraints:\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.", "type": "integer" }, "KmsKeyId": { - "description": "The ARN of the AWS Key Management Service (AWS KMS) master key that's used to encrypt the DB instance.", + "description": "The ARN of the AWS KMS key that's used to encrypt the DB instance, such as ``arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef``. If you enable the StorageEncrypted property but don't specify this property, AWS CloudFormation uses the default KMS key. If you specify this property, you must set the StorageEncrypted property to true. \n If you specify the ``SourceDBInstanceIdentifier`` or ``SourceDbiResourceId`` property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specified ``KmsKeyId`` property is used. However, if the source DB instance is in a different AWS Region, you must specify a KMS key ID.\n If you specify the ``SourceDBInstanceAutomatedBackupsArn`` property, don't specify this property. The value is inherited from the source DB instance automated backup, and if the automated backup is encrypted, the specified ``KmsKeyId`` property is used.\n If you create an encrypted read replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the region that they're created in, and you can't use encryption keys from one region in another region.\n If you specify the ``DBSnapshotIdentifier`` property, don't specify this property. The ``StorageEncrypted`` property value is inherited from the snapshot. If the DB instance is encrypted, the specified ``KmsKeyId`` property is also inherited from the snapshot.\n If you specify ``DBSecurityGroups``, AWS CloudFormation ignores this property. To specify both a security group and this property, you must use a VPC security group. For more information about Amazon RDS and VPC, see [Using Amazon RDS with Amazon VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html) in the *Amazon RDS User Guide*.\n *Amazon Aurora* \n Not applicable. The KMS key identifier is managed by the DB cluster.", "type": "string" }, "LicenseModel": { - "description": "License model information for this DB instance.", + "description": "License model information for this DB instance.\n Valid 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 [](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-licensing.html) in the *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 \n If you've specified ``DBSecurityGroups`` and then you update the license model, AWS CloudFormation replaces the underlying DB instance. This will incur some interruptions to database availability.", "type": "string" }, "ManageMasterUserPassword": { - "description": "A value that indicates whether to manage the master user password with AWS Secrets Manager.", + "description": "Specifies whether to manage the master user password with AWS Secrets Manager.\n For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide.* \n Constraints:\n + Can't manage the master user password with AWS Secrets Manager if ``MasterUserPassword`` is specified.", "type": "boolean" }, "MasterUserPassword": { - "description": "The password for the master user.", + "description": "The password for the master user. The password can include any printable ASCII character except \"/\", \"\"\", or \"@\".\n *Amazon Aurora* \n Not applicable. The password for the master user is managed by the DB cluster.\n *RDS for Db2* \n Must contain from 8 to 255 characters.\n *RDS for MariaDB* \n Constraints: Must contain from 8 to 41 characters.\n *RDS for Microsoft SQL Server* \n Constraints: Must contain from 8 to 128 characters.\n *RDS for MySQL* \n Constraints: Must contain from 8 to 41 characters.\n *RDS for Oracle* \n Constraints: Must contain from 8 to 30 characters.\n *RDS for PostgreSQL* \n Constraints: Must contain from 8 to 128 characters.", "type": "string" }, "MasterUserSecret": { "$ref": "#/definitions/MasterUserSecret", - "description": "Contains the secret managed by RDS in AWS Secrets Manager for the master user password." + "description": "The secret managed by RDS in AWS Secrets Manager for the master user password.\n For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide.*" }, "MasterUsername": { - "description": "The master user name for the DB instance.", + "description": "The master user name for the DB instance.\n If you specify the ``SourceDBInstanceIdentifier`` or ``DBSnapshotIdentifier`` property, don't specify this property. The value is inherited from the source DB instance or snapshot.\n When 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* \n Not applicable. The name for the master user is managed by the DB cluster. \n *RDS for Db2* \n Constraints:\n + Must be 1 to 16 letters or numbers.\n + First character must be a letter.\n + Can't be a reserved word for the chosen database engine.\n \n *RDS for MariaDB* \n Constraints:\n + Must be 1 to 16 letters or numbers.\n + Can't be a reserved word for the chosen database engine.\n \n *RDS for Microsoft SQL Server* \n Constraints:\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 \n *RDS for MySQL* \n Constraints:\n + Must be 1 to 16 letters or numbers.\n + First character must be a letter.\n + Can't be a reserved word for the chosen database engine.\n \n *RDS for Oracle* \n Constraints:\n + Must be 1 to 30 letters or numbers.\n + First character must be a letter.\n + Can't be a reserved word for the chosen database engine.\n \n *RDS for PostgreSQL* \n Constraints:\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.", "maxLength": 128, "minLength": 1, "pattern": "^[a-zA-Z][a-zA-Z0-9_]{0,127}$", "type": "string" }, "MaxAllocatedStorage": { - "description": "The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.", + "description": "The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.\n For more information about this setting, including limitations that apply to it, see [Managing capacity automatically with Amazon RDS storage autoscaling](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling) in the *Amazon RDS User Guide*.\n This setting doesn't apply to the following DB instances:\n + Amazon Aurora (Storage is managed by the DB cluster.)\n + RDS Custom", "type": "integer" }, "MonitoringInterval": { "default": 0, - "description": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.", + "description": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0. The default is 0.\n If ``MonitoringRoleArn`` is specified, then you must set ``MonitoringInterval`` to a value other than 0.\n This setting doesn't apply to RDS Custom.\n Valid Values: ``0, 1, 5, 10, 15, 30, 60``", "type": "integer" }, "MonitoringRoleArn": { - "description": "The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs.", + "description": "The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, ``arn:aws:iam:123456789012:role/emaccess``. For information on creating a monitoring role, see [Setting Up and Enabling Enhanced Monitoring](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling) in the *Amazon RDS User Guide*.\n If ``MonitoringInterval`` is set to a value other than ``0``, then you must supply a ``MonitoringRoleArn`` value.\n This setting doesn't apply to RDS Custom DB instances.", "type": "string" }, "MultiAZ": { - "description": "Specifies whether the database instance is a multiple Availability Zone deployment.", + "description": "Specifies whether the database instance is a Multi-AZ DB instance deployment. You can't set the ``AvailabilityZone`` parameter if the ``MultiAZ`` parameter is set to true. \n For more information, see [Multi-AZ deployments for high availability](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.MultiAZ.html) in the *Amazon RDS User Guide*.\n *Amazon Aurora* \n Not applicable. Amazon Aurora storage is replicated across all of the Availability Zones and doesn't require the ``MultiAZ`` option to be set.", "type": "boolean" }, "NcharCharacterSetName": { - "description": "The name of the NCHAR character set for the Oracle DB instance. This parameter doesn't apply to RDS Custom.", + "description": "The name of the NCHAR character set for the Oracle DB instance.\n This setting doesn't apply to RDS Custom DB instances.", "type": "string" }, "NetworkType": { - "description": "The network type of the DB cluster.", + "description": "The network type of the DB instance.\n Valid values:\n + ``IPV4`` \n + ``DUAL`` \n \n The network type is determined by the ``DBSubnetGroup`` specified for the DB instance. A ``DBSubnetGroup`` can support only the IPv4 protocol or the IPv4 and IPv6 protocols (``DUAL``).\n For more information, see [Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the *Amazon RDS User Guide.*", "type": "string" }, "OptionGroupName": { - "description": "Indicates that the DB instance should be associated with the specified option group.", + "description": "Indicates that the DB instance should be associated with the specified option group.\n Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance.", "type": "string" }, "PerformanceInsightsKMSKeyId": { - "description": "The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.", + "description": "The AWS KMS key identifier for encryption of Performance Insights data.\n The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n If you do not specify a value for ``PerformanceInsightsKMSKeyId``, then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region.\n For 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).", "type": "string" }, "PerformanceInsightsRetentionPeriod": { - "description": "The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).", + "description": "The number of days to retain Performance Insights data.\n This setting doesn't apply to RDS Custom DB instances.\n Valid Values:\n + ``7`` \n + *month* * 31, where *month* is a number of months from 1-23. Examples: ``93`` (3 months * 31), ``341`` (11 months * 31), ``589`` (19 months * 31)\n + ``731`` \n \n Default: ``7`` days\n If you specify a retention period that isn't valid, such as ``94``, Amazon RDS returns an error.", "type": "integer" }, "Port": { - "description": "The port number on which the database accepts connections.", + "description": "The port number on which the database accepts connections.\n *Amazon Aurora* \n Not applicable. The port number is managed by the DB cluster.\n *Db2* \n Default value: ``50000``", "pattern": "^\\d*$", "type": "string" }, "PreferredBackupWindow": { - "description": "The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.", + "description": "The daily time range during which automated backups are created if automated backups are enabled, using the ``BackupRetentionPeriod`` parameter. For more information, see [Backup Window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow) in the *Amazon RDS User Guide.* \n Constraints:\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 \n *Amazon Aurora* \n Not applicable. The daily time range for creating automated backups is managed by the DB cluster.", "type": "string" }, "PreferredMaintenanceWindow": { - "description": "he weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).", + "description": "The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).\n Format: ``ddd:hh24:mi-ddd:hh24:mi`` \n The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see [Adjusting the Preferred DB Instance Maintenance Window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow) in the *Amazon RDS User Guide.* \n This property applies when AWS CloudFormation initially creates the DB instance. If you use AWS CloudFormation to update the DB instance, those updates are applied immediately.\n Constraints: Minimum 30-minute window.", "type": "string" }, "ProcessorFeatures": { - "description": "The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.", + "description": "The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.\n This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.", "items": { "$ref": "#/definitions/ProcessorFeature" }, @@ -519,33 +532,33 @@ }, "PromotionTier": { "default": 1, - "description": "A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance.", + "description": "The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see [Fault Tolerance for an Aurora DB Cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.AuroraHighAvailability.html#Aurora.Managing.FaultTolerance) in the *Amazon Aurora User Guide*.\n This setting doesn't apply to RDS Custom DB instances.\n Default: ``1`` \n Valid Values: ``0 - 15``", "minimum": 0, "type": "integer" }, "PubliclyAccessible": { - "description": "Indicates whether the DB instance is an internet-facing instance. If you specify true, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address.", + "description": "Indicates whether the DB instance is an internet-facing instance. If you specify true, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address. \n The default behavior value depends on your VPC setup and the database subnet group. For more information, see the ``PubliclyAccessible`` parameter in the [CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) in the *Amazon RDS API Reference*.", "type": "boolean" }, "ReplicaMode": { - "description": "The open mode of an Oracle read replica. The default is open-read-only.", + "description": "The open mode of an Oracle read replica. For more information, see [Working with Oracle Read Replicas for Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html) in the *Amazon RDS User Guide*.\n This setting is only supported in RDS for Oracle.\n Default: ``open-read-only`` \n Valid Values: ``open-read-only`` or ``mounted``", "type": "string" }, "RestoreTime": { - "description": "The date and time to restore from.", + "description": "The date and time to restore from.\n Constraints:\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.\n \n Example: ``2009-09-07T23:45:00Z``", "format": "date-time", "type": "string" }, "SourceDBClusterIdentifier": { - "description": "The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas.", + "description": "The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas.\n Constraints:\n + Must be the identifier of an existing Multi-AZ DB cluster.\n + Can't be specified if the ``SourceDBInstanceIdentifier`` parameter is also specified.\n + The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0.\n + The source DB cluster must be in the same AWS-Region as the read replica. Cross-Region replication isn't supported.", "type": "string" }, "SourceDBInstanceAutomatedBackupsArn": { - "description": "The Amazon Resource Name (ARN) of the replicated automated backups from which to restore.", + "description": "The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, ``arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE``.\n This setting doesn't apply to RDS Custom.", "type": "string" }, "SourceDBInstanceIdentifier": { - "description": "If you want to create a Read Replica DB instance, specify the ID of the source DB instance. Each DB instance can have a limited number of Read Replicas.", + "description": "If you want to create a read replica DB instance, specify the ID of the source DB instance. Each DB instance can have a limited number of read replicas. For more information, see [Working with Read Replicas](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/USER_ReadRepl.html) in the *Amazon RDS User Guide*.\n For information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide*.\n The ``SourceDBInstanceIdentifier`` property determines whether a DB instance is a read replica. If you remove the ``SourceDBInstanceIdentifier`` property from your template and then update your stack, AWS CloudFormation promotes the read replica to a standalone DB instance.\n If you specify the ``UseLatestRestorableTime`` or ``RestoreTime`` properties in conjunction with the ``SourceDBInstanceIdentifier`` property, RDS restores the DB instance to the requested point in time, thereby creating a new DB instance.\n + If you specify a source DB instance that uses VPC security groups, we recommend that you specify the ``VPCSecurityGroups`` property. If you don't specify the property, the read replica inherits the value of the ``VPCSecurityGroups`` property from the source DB when you create the replica. However, if you update the stack, AWS CloudFormation reverts the replica's ``VPCSecurityGroups`` property to the default value because it's not defined in the stack's template. This change might cause unexpected issues.\n + Read replicas don't support deletion policies. AWS CloudFormation ignores any deletion policy that's associated with a read replica.\n + If you specify ``SourceDBInstanceIdentifier``, don't specify the ``DBSnapshotIdentifier`` property. You can't create a read replica from a snapshot.\n + Don't set the ``BackupRetentionPeriod``, ``DBName``, ``MasterUsername``, ``MasterUserPassword``, and ``PreferredBackupWindow`` properties. The database attributes are inherited from the source DB instance, and backups are disabled for read replicas.\n + If the source DB instance is in a different region than the read replica, specify the source region in ``SourceRegion``, and specify an ARN for a valid DB instance in ``SourceDBInstanceIdentifier``. For more information, see [Constructing a Amazon RDS Amazon Resource Name (ARN)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html#USER_Tagging.ARN) in the *Amazon RDS User Guide*.\n + For DB instances in Amazon Aurora clusters, don't specify this property. Amazon RDS automatically assigns writer and reader DB instances.", "type": "string" }, "SourceDbiResourceId": { @@ -553,23 +566,23 @@ "type": "string" }, "SourceRegion": { - "description": "The ID of the region that contains the source DB instance for the Read Replica.", + "description": "The ID of the region that contains the source DB instance for the read replica.", "type": "string" }, "StorageEncrypted": { - "description": "A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.", + "description": "A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.\n If you specify the ``KmsKeyId`` property, then you must enable encryption.\n If you specify the ``SourceDBInstanceIdentifier`` or ``SourceDbiResourceId`` property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specified ``KmsKeyId`` property is used.\n If you specify the ``SourceDBInstanceAutomatedBackupsArn`` property, don't specify this property. The value is inherited from the source DB instance automated backup. \n If you specify ``DBSnapshotIdentifier`` property, don't specify this property. The value is inherited from the snapshot.\n *Amazon Aurora* \n Not applicable. The encryption for DB instances is managed by the DB cluster.", "type": "boolean" }, "StorageThroughput": { - "description": "Specifies the storage throughput for the DB instance.", + "description": "Specifies the storage throughput value for the DB instance. This setting applies only to the ``gp3`` storage type. \n This setting doesn't apply to RDS Custom or Amazon Aurora.", "type": "integer" }, "StorageType": { - "description": "Specifies the storage type to be associated with the DB instance.", + "description": "The storage type to associate with the DB instance.\n If you specify ``io1``, ``io2``, or ``gp3``, you must also include a value for the ``Iops`` parameter.\n This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster.\n Valid Values: ``gp2 | gp3 | io1 | io2 | standard`` \n Default: ``io1``, if the ``Iops`` parameter is specified. Otherwise, ``gp2``.", "type": "string" }, "Tags": { - "description": "Tags to assign to the DB instance.", + "description": "An optional array of key-value pairs to apply to this DB instance.", "insertionOrder": false, "items": { "$ref": "#/definitions/Tag" @@ -578,27 +591,27 @@ "uniqueItems": false }, "TdeCredentialArn": { - "description": "The ARN from the key store with which to associate the instance for TDE encryption.", + "description": "", "type": "string" }, "TdeCredentialPassword": { - "description": "The password for the given ARN from the key store in order to access the device.", + "description": "", "type": "string" }, "Timezone": { - "description": "The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.", + "description": "The time zone of the DB instance. The time zone parameter is currently supported only by [RDS for Db2](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-time-zone) and [RDS for SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone).", "type": "string" }, "UseDefaultProcessorFeatures": { - "description": "A value that indicates whether the DB instance class of the DB instance uses its default processor features.", + "description": "Specifies whether the DB instance class of the DB instance uses its default processor features.\n This setting doesn't apply to RDS Custom DB instances.", "type": "boolean" }, "UseLatestRestorableTime": { - "description": "A value that indicates whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time.", + "description": "Specifies whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time.\n Constraints:\n + Can't be specified if the ``RestoreTime`` parameter is provided.", "type": "boolean" }, "VPCSecurityGroups": { - "description": "A list of the VPC security group IDs to assign to the DB instance. The list can include both the physical IDs of existing VPC security groups and references to AWS::EC2::SecurityGroup resources created in the template.", + "description": "A list of the VPC security group IDs to assign to the DB instance. The list can include both the physical IDs of existing VPC security groups and references to [AWS::EC2::SecurityGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html) resources created in the template.\n If you plan to update the resource, don't specify VPC security groups in a shared VPC.\n If you set ``VPCSecurityGroups``, you must not set [DBSecurityGroups](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups), and vice versa.\n You can migrate a DB instance in your stack from an RDS DB security group to a VPC security group, but keep the following in mind:\n + You can't revert to using an RDS security group after you establish a VPC security group membership.\n + When you migrate your DB instance to VPC security groups, if your stack update rolls back because the DB instance update fails or because an update fails in another AWS CloudFormation resource, the rollback fails because it can't revert to an RDS security group.\n + To use the properties that are available when you use a VPC security group, you must recreate the DB instance. If you don't, AWS CloudFormation submits only the property values that are listed in the [DBSecurityGroups](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups) property.\n \n To avoid this situation, migrate your DB instance to using VPC security groups only when that is the only change in your stack template. \n *Amazon Aurora* \n Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. If specified, the setting must match the DB cluster setting.", "items": { "type": "string" }, @@ -641,6 +654,7 @@ "typeName": "AWS::RDS::DBInstance", "writeOnlyProperties": [ "/properties/AllowMajorVersionUpgrade", + "/properties/AutomaticBackupReplicationKmsKeyId", "/properties/CertificateRotationRestart", "/properties/DBSnapshotIdentifier", "/properties/DeleteAutomatedBackups", diff --git a/artifacts/types/AWS::RDS::DBParameterGroup.json b/artifacts/types/AWS::RDS::DBParameterGroup.json index b0ec6f0d..f593ff19 100644 --- a/artifacts/types/AWS::RDS::DBParameterGroup.json +++ b/artifacts/types/AWS::RDS::DBParameterGroup.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-RDS-DBParameterGroup", "type": "AWS::RDS::DBParameterGroup", - "time": "2023-12-18T10:42:02.519Z", + "time": "2024-06-21T12:06:11.824Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -12,16 +12,16 @@ "definitions": { "Tag": { "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", + "description": "Metadata assigned to an Amazon RDS resource consisting of a key-value pair.\n For more information, see [Tagging Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*.", "properties": { "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "description": "A 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}_.:/=+\\\\-@]*)$\").", "maxLength": 128, "minLength": 1, "type": "string" }, "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "description": "A 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}_.:/=+\\\\-@]*)$\").", "maxLength": 256, "minLength": 0, "type": "string" @@ -33,7 +33,7 @@ "type": "object" } }, - "description": "The AWS::RDS::DBParameterGroup resource creates a custom parameter group for an RDS database family", + "description": "The ``AWS::RDS::DBParameterGroup`` resource creates a custom parameter group for an RDS database family.\n This type can be declared in a template and referenced in the ``DBParameterGroupName`` property of an ``AWS::RDS::DBInstance`` resource.\n For information about configuring parameters for Amazon RDS DB instances, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the *Amazon RDS User Guide*.\n For information about configuring parameters for Amazon Aurora DB instances, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*.\n Applying a parameter group to a DB instance may require the DB instance to reboot, resulting in a database outage for the duration of the reboot.", "handlers": { "create": { "permissions": [ @@ -84,7 +84,7 @@ ], "properties": { "DBParameterGroupName": { - "description": "Specifies the name of the DB parameter group", + "description": "The name of the DB parameter group.\n Constraints:\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\n \n If you don't specify a value for ``DBParameterGroupName`` property, a name is automatically created for the DB parameter group.\n This value is stored as a lowercase string.", "pattern": "^[a-zA-Z]{1}(?:-?[a-zA-Z0-9])*$", "type": "string" }, @@ -93,15 +93,15 @@ "type": "string" }, "Family": { - "description": "The DB parameter group family name.", + "description": "The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a DB engine and engine version compatible with that DB parameter group family.\n The DB parameter group family can't be changed when updating a DB parameter group.\n To list all of the available parameter group families, use the following command:\n ``aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\"`` \n The output contains duplicates.\n For more information, see ``CreateDBParameterGroup``.", "type": "string" }, "Parameters": { - "description": "An array of parameter names and values for the parameter update.", + "description": "An array of parameter names and values for the parameter update. At least one parameter name and value must be supplied. Subsequent arguments are optional.\n RDS for Db2 requires you to bring your own Db2 license. You must enter your IBM customer ID (``rds.ibm_customer_id``) and site number (``rds.ibm_site_id``) before starting a Db2 instance.\n For more information about DB parameters and DB parameter groups for Amazon RDS DB engines, see [Working with DB Parameter Groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the *Amazon RDS User Guide*.\n For more information about DB cluster and DB instance parameters and parameter groups for Amazon Aurora DB engines, see [Working with DB Parameter Groups and DB Cluster Parameter Groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*.\n AWS CloudFormation doesn't support specifying an apply method for each individual parameter. The default apply method for each parameter is used.", "type": "object" }, "Tags": { - "description": "An array of key-value pairs to apply to this resource.", + "description": "An optional array of key-value pairs to apply to this DB parameter group.\n Currently, this is the only property that supports drift detection.", "insertionOrder": false, "items": { "$ref": "#/definitions/Tag" diff --git a/artifacts/types/AWS::RDS::DBProxy.json b/artifacts/types/AWS::RDS::DBProxy.json index cf75219b..0b423e63 100644 --- a/artifacts/types/AWS::RDS::DBProxy.json +++ b/artifacts/types/AWS::RDS::DBProxy.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-RDS-DBProxy", "type": "AWS::RDS::DBProxy", - "time": "2024-01-04T17:56:00.711Z", + "time": "2024-05-22T16:52:29.179Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::RDS::DBProxyEndpoint.json b/artifacts/types/AWS::RDS::DBProxyEndpoint.json index e71b1f6d..031723fa 100644 --- a/artifacts/types/AWS::RDS::DBProxyEndpoint.json +++ b/artifacts/types/AWS::RDS::DBProxyEndpoint.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-RDS-DBProxyEndpoint", "type": "AWS::RDS::DBProxyEndpoint", - "time": "2024-01-04T17:56:02.902Z", + "time": "2024-05-22T16:52:29.34Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::RDS::DBProxyTargetGroup.json b/artifacts/types/AWS::RDS::DBProxyTargetGroup.json index 511c7927..45e2cfe9 100644 --- a/artifacts/types/AWS::RDS::DBProxyTargetGroup.json +++ b/artifacts/types/AWS::RDS::DBProxyTargetGroup.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-RDS-DBProxyTargetGroup", "type": "AWS::RDS::DBProxyTargetGroup", - "time": "2024-01-04T17:56:04.919Z", + "time": "2024-05-22T16:52:25.611Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::RDS::DBSubnetGroup.json b/artifacts/types/AWS::RDS::DBSubnetGroup.json index 001b6b00..668abcf8 100644 --- a/artifacts/types/AWS::RDS::DBSubnetGroup.json +++ b/artifacts/types/AWS::RDS::DBSubnetGroup.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-RDS-DBSubnetGroup", "type": "AWS::RDS::DBSubnetGroup", - "time": "2023-12-18T10:32:10.886Z", + "time": "2024-06-21T12:07:14.411Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -10,16 +10,16 @@ "definitions": { "Tag": { "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", + "description": "Metadata assigned to an Amazon RDS resource consisting of a key-value pair.\n For more information, see [Tagging Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*.", "properties": { "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "description": "A 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}_.:/=+\\\\-@]*)$\").", "maxLength": 128, "minLength": 1, "type": "string" }, "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "description": "A 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}_.:/=+\\\\-@]*)$\").", "maxLength": 256, "minLength": 0, "type": "string" @@ -31,7 +31,7 @@ "type": "object" } }, - "description": "The AWS::RDS::DBSubnetGroup resource creates a database subnet group. Subnet groups must contain at least two subnets in two different Availability Zones in the same region.", + "description": "The ``AWS::RDS::DBSubnetGroup`` resource creates a database subnet group. Subnet groups must contain at least two subnets in two different Availability Zones in the same region. \n For 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*.", "handlers": { "create": { "permissions": [ @@ -76,13 +76,15 @@ ], "properties": { "DBSubnetGroupDescription": { + "description": "The description for the DB subnet group.", "type": "string" }, "DBSubnetGroupName": { - "pattern": "^(?!default$)[a-zA-Z]{1}[a-zA-Z0-9-_\\.\\s]{0,254}$", + "description": "The name for the DB subnet group. This value is stored as a lowercase string.\n Constraints: Must contain no more than 255 lowercase alphanumeric characters or hyphens. Must not be \"Default\".\n Example: ``mysubnetgroup``", "type": "string" }, "SubnetIds": { + "description": "The EC2 Subnet IDs for the DB subnet group.", "items": { "type": "string" }, @@ -90,7 +92,7 @@ "uniqueItems": false }, "Tags": { - "description": "An array of key-value pairs to apply to this resource.", + "description": "An optional array of key-value pairs to apply to this DB subnet group.", "insertionOrder": false, "items": { "$ref": "#/definitions/Tag" diff --git a/artifacts/types/AWS::RDS::EventSubscription.json b/artifacts/types/AWS::RDS::EventSubscription.json index 604736b6..70c0adf5 100644 --- a/artifacts/types/AWS::RDS::EventSubscription.json +++ b/artifacts/types/AWS::RDS::EventSubscription.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-RDS-EventSubscription", "type": "AWS::RDS::EventSubscription", - "time": "2023-12-18T10:34:53.521Z", + "time": "2024-06-21T12:05:04.545Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::RDS::GlobalCluster.json b/artifacts/types/AWS::RDS::GlobalCluster.json index 3dd01589..4cab0462 100644 --- a/artifacts/types/AWS::RDS::GlobalCluster.json +++ b/artifacts/types/AWS::RDS::GlobalCluster.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-RDS-GlobalCluster", "type": "AWS::RDS::GlobalCluster", - "time": "2023-12-21T16:45:29.194Z", + "time": "2024-06-20T15:13:13.379Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -73,6 +73,10 @@ ], "type": "string" }, + "EngineLifecycleSupport": { + "description": "The life cycle type of the global cluster. You can use this setting to enroll your global cluster into Amazon RDS Extended Support.", + "type": "string" + }, "EngineVersion": { "description": "The version number of the database engine to use. If you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the cluster.", "type": "string" diff --git a/artifacts/types/AWS::RDS::Integration.json b/artifacts/types/AWS::RDS::Integration.json new file mode 100644 index 00000000..158e72b8 --- /dev/null +++ b/artifacts/types/AWS::RDS::Integration.json @@ -0,0 +1,173 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-RDS-Integration", + "type": "AWS::RDS::Integration", + "time": "2024-05-20T19:35:08.581Z", + "schema": { + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/SourceArn", + "/properties/TargetArn", + "/properties/KMSKeyId", + "/properties/AdditionalEncryptionContext" + ], + "definitions": { + "EncryptionContextMap": { + "additionalProperties": false, + "description": "An optional set of non-secret key–value pairs that contains additional contextual information about the data.", + "patternProperties": { + "^[\\s\\S]*$": { + "maxLength": 131072, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key" + ], + "type": "object" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + } + }, + "description": "Creates a zero-ETL integration with Amazon Redshift.", + "handlers": { + "create": { + "permissions": [ + "rds:CreateIntegration", + "rds:DescribeIntegrations", + "rds:AddTagsToResource", + "kms:CreateGrant", + "kms:DescribeKey", + "redshift:CreateInboundIntegration" + ] + }, + "delete": { + "permissions": [ + "rds:DeleteIntegration", + "rds:DescribeIntegrations" + ] + }, + "list": { + "permissions": [ + "rds:DescribeIntegrations" + ] + }, + "read": { + "permissions": [ + "rds:DescribeIntegrations" + ] + }, + "update": { + "permissions": [ + "rds:DescribeIntegrations", + "rds:AddTagsToResource", + "rds:RemoveTagsFromResource", + "rds:ModifyIntegration" + ] + } + }, + "primaryIdentifier": [ + "/properties/IntegrationArn" + ], + "properties": { + "AdditionalEncryptionContext": { + "$ref": "#/definitions/EncryptionContextMap" + }, + "CreateTime": { + "type": "string" + }, + "DataFilter": { + "description": "The data filter for the integration.", + "maxLength": 25600, + "minLength": 1, + "pattern": "[a-zA-Z0-9_ \"\\\\\\-$,*.:?+\\/]*", + "type": "string" + }, + "Description": { + "description": "The description of the integration.", + "maxLength": 1000, + "minLength": 1, + "type": "string" + }, + "IntegrationArn": { + "description": "The ARN of the integration.", + "type": "string" + }, + "IntegrationName": { + "description": "The name of the integration.", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "KMSKeyId": { + "description": "An optional AWS Key Management System (AWS KMS) key ARN for the key used to to encrypt the integration. The resource accepts the key ID and the key ARN forms. The key ID form can be used if the KMS key is owned by te same account. If the KMS key belongs to a different account than the calling account, the full key ARN must be specified. Do not use the key alias or the key alias ARN as this will cause a false drift of the resource.", + "type": "string" + }, + "SourceArn": { + "description": "The Amazon Resource Name (ARN) of the Aurora DB cluster to use as the source for replication.", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 50, + "type": "array", + "uniqueItems": true + }, + "TargetArn": { + "description": "The ARN of the Redshift data warehouse to use as the target for replication.", + "type": "string" + } + }, + "propertyTransform": { + "/properties/KmsKeyId": "$join([\"arn:(aws)[-]{0,1}[a-z]{0,2}[-]{0,1}[a-z]{0,3}:kms:[a-z]{2}[-]{1}[a-z]{3,10}[-]{0,1}[a-z]{0,10}[-]{1}[1-3]{1}:[0-9]{12}[:]{1}key\\/\", KmsKeyId])", + "/properties/SourceArn": "$lowercase(SourceArn)" + }, + "readOnlyProperties": [ + "/properties/IntegrationArn", + "/properties/CreateTime" + ], + "required": [ + "SourceArn", + "TargetArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging": { + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::RDS::Integration" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::RDS::OptionGroup.json b/artifacts/types/AWS::RDS::OptionGroup.json index 392545cd..1dee34be 100644 --- a/artifacts/types/AWS::RDS::OptionGroup.json +++ b/artifacts/types/AWS::RDS::OptionGroup.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-RDS-OptionGroup", "type": "AWS::RDS::OptionGroup", - "time": "2023-12-18T10:39:16.835Z", + "time": "2024-06-21T12:07:26.484Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::RUM::AppMonitor.json b/artifacts/types/AWS::RUM::AppMonitor.json index e2762a9c..31c76019 100644 --- a/artifacts/types/AWS::RUM::AppMonitor.json +++ b/artifacts/types/AWS::RUM::AppMonitor.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-RUM-AppMonitor", "type": "AWS::RUM::AppMonitor", - "time": "2023-04-11T15:56:39.852Z", + "time": "2024-04-29T16:03:30.459Z", "schema": { "additionalIdentifiers": [ [ @@ -266,6 +266,7 @@ "handlers": { "create": { "permissions": [ + "rum:GetAppMonitor", "rum:CreateAppMonitor", "dynamodb:GetItem", "dynamodb:PutItem", @@ -282,15 +283,20 @@ "logs:DescribeLogGroups", "logs:PutRetentionPolicy", "rum:TagResource", + "rum:ListTagsForResource", "cognito-identity:DescribeIdentityPool", "iam:GetRole", "iam:CreateServiceLinkedRole", + "iam:PassRole", "rum:PutRumMetricsDestination", - "rum:BatchCreateRumMetricDefinitions" + "rum:BatchCreateRumMetricDefinitions", + "rum:ListRumMetricsDestinations", + "rum:BatchGetRumMetricDefinitions" ] }, "delete": { "permissions": [ + "rum:GetAppMonitor", "rum:DeleteAppMonitor", "dynamodb:DeleteItem", "dynamodb:Query", @@ -298,8 +304,11 @@ "s3:DeleteObject", "s3:DoesObjectExist", "rum:UntagResource", + "rum:ListTagsForResource", "rum:DeleteRumMetricsDestination", - "rum:BatchDeleteRumMetricDefinitions" + "rum:BatchDeleteRumMetricDefinitions", + "rum:ListRumMetricsDestinations", + "rum:BatchGetRumMetricDefinitions" ] }, "list": { @@ -331,6 +340,7 @@ }, "update": { "permissions": [ + "rum:GetAppMonitor", "rum:UpdateAppMonitor", "dynamodb:GetItem", "dynamodb:PutItem", @@ -353,6 +363,7 @@ "rum:ListTagsForResource", "iam:GetRole", "iam:CreateServiceLinkedRole", + "iam:PassRole", "rum:PutRumMetricsDestination", "rum:DeleteRumMetricsDestination", "rum:ListRumMetricsDestinations", @@ -410,7 +421,9 @@ "Domain" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "taggable": true, + "tagging": { + "taggable": true + }, "typeName": "AWS::RUM::AppMonitor" } } \ No newline at end of file diff --git a/artifacts/types/AWS::Redshift::Cluster.json b/artifacts/types/AWS::Redshift::Cluster.json index e0e7b19d..3025ad99 100644 --- a/artifacts/types/AWS::Redshift::Cluster.json +++ b/artifacts/types/AWS::Redshift::Cluster.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Redshift-Cluster", "type": "AWS::Redshift::Cluster", - "time": "2024-01-04T18:20:40.57Z", + "time": "2024-06-24T17:41:37.306Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -30,6 +30,10 @@ "additionalProperties": false, "properties": { "BucketName": { + "relationshipRef": { + "propertyPath": "/properties/BucketName", + "typeName": "AWS::S3::Bucket" + }, "type": "string" }, "S3KeyPrefix": { @@ -208,6 +212,20 @@ "description": "A list of security groups to be associated with this cluster.", "insertionOrder": false, "items": { + "anyOf": [ + { + "relationshipRef": { + "propertyPath": "/properties/Id", + "typeName": "AWS::EC2::SecurityGroup" + } + }, + { + "relationshipRef": { + "propertyPath": "/properties/Id", + "typeName": "AWS::Redshift::ClusterSecurityGroup" + } + } + ], "type": "string" }, "type": "array", @@ -280,12 +298,30 @@ "description": "A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 50 IAM roles in a single request", "insertionOrder": false, "items": { + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::IAM::Role" + }, "type": "string" }, "maxItems": 50, "type": "array" }, "KmsKeyId": { + "anyOf": [ + { + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::KMS::Key" + } + }, + { + "relationshipRef": { + "propertyPath": "/properties/KeyId", + "typeName": "AWS::KMS::Key" + } + } + ], "description": "The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.", "type": "string" }, @@ -309,6 +345,20 @@ "type": "string" }, "MasterPasswordSecretKmsKeyId": { + "anyOf": [ + { + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::KMS::Key" + } + }, + { + "relationshipRef": { + "propertyPath": "/properties/KeyId", + "typeName": "AWS::KMS::Key" + } + } + ], "description": "The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin user credentials secret.", "type": "string" }, @@ -399,6 +449,10 @@ "description": "A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.", "insertionOrder": false, "items": { + "relationshipRef": { + "propertyPath": "/properties/VpcId", + "typeName": "AWS::EC2::VPC" + }, "type": "string" }, "type": "array", diff --git a/artifacts/types/AWS::Redshift::ClusterParameterGroup.json b/artifacts/types/AWS::Redshift::ClusterParameterGroup.json index 051e5bae..d4b99b09 100644 --- a/artifacts/types/AWS::Redshift::ClusterParameterGroup.json +++ b/artifacts/types/AWS::Redshift::ClusterParameterGroup.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Redshift-ClusterParameterGroup", "type": "AWS::Redshift::ClusterParameterGroup", - "time": "2024-01-04T18:20:36.249Z", + "time": "2024-06-24T17:51:15.072Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Redshift::ClusterSubnetGroup.json b/artifacts/types/AWS::Redshift::ClusterSubnetGroup.json index a2fdfdf6..0bac65e0 100644 --- a/artifacts/types/AWS::Redshift::ClusterSubnetGroup.json +++ b/artifacts/types/AWS::Redshift::ClusterSubnetGroup.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Redshift-ClusterSubnetGroup", "type": "AWS::Redshift::ClusterSubnetGroup", - "time": "2024-01-04T16:27:09.791Z", + "time": "2024-06-24T17:51:39.705Z", "schema": { "additionalProperties": false, "definitions": { @@ -135,6 +135,10 @@ "description": "The list of VPC subnet IDs", "insertionOrder": false, "items": { + "relationshipRef": { + "propertyPath": "/properties/SubnetId", + "typeName": "AWS::EC2::Subnet" + }, "type": "string" }, "maxItems": 20, diff --git a/artifacts/types/AWS::Redshift::EndpointAccess.json b/artifacts/types/AWS::Redshift::EndpointAccess.json index 1f3774e1..b15fbb5c 100644 --- a/artifacts/types/AWS::Redshift::EndpointAccess.json +++ b/artifacts/types/AWS::Redshift::EndpointAccess.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Redshift-EndpointAccess", "type": "AWS::Redshift::EndpointAccess", - "time": "2024-01-04T18:20:43.318Z", + "time": "2024-06-24T18:38:03.971Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -21,14 +21,26 @@ }, "NetworkInterfaceId": { "description": "The network interface identifier.", + "relationshipRef": { + "propertyPath": "/properties/Id", + "typeName": "AWS::EC2::NetworkInterface" + }, "type": "string" }, "PrivateIpAddress": { "description": "The IPv4 address of the network interface within the subnet.", + "relationshipRef": { + "propertyPath": "/properties/PrivateIpAddress", + "typeName": "AWS::EC2::NetworkInterface" + }, "type": "string" }, "SubnetId": { "description": "The subnet identifier.", + "relationshipRef": { + "propertyPath": "/properties/SubnetId", + "typeName": "AWS::EC2::NetworkInterface" + }, "type": "string" } }, @@ -44,6 +56,10 @@ }, "VpcSecurityGroupId": { "description": "The identifier of the VPC security group.", + "relationshipRef": { + "propertyPath": "/properties/Id", + "typeName": "AWS::EC2::SecurityGroup" + }, "type": "string" } }, @@ -173,10 +189,18 @@ }, "VpcEndpointId": { "description": "The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.", + "relationshipRef": { + "propertyPath": "/properties/Id", + "typeName": "AWS::EC2::VPCEndpoint" + }, "type": "string" }, "VpcId": { "description": "The VPC identifier that the endpoint is associated.", + "relationshipRef": { + "propertyPath": "/properties/VpcId", + "typeName": "AWS::EC2::VPCEndpoint" + }, "type": "string" } }, diff --git a/artifacts/types/AWS::Redshift::EndpointAuthorization.json b/artifacts/types/AWS::Redshift::EndpointAuthorization.json index 82ab9a96..cb229424 100644 --- a/artifacts/types/AWS::Redshift::EndpointAuthorization.json +++ b/artifacts/types/AWS::Redshift::EndpointAuthorization.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Redshift-EndpointAuthorization", "type": "AWS::Redshift::EndpointAuthorization", - "time": "2024-01-04T18:20:37.712Z", + "time": "2024-06-24T17:55:36.635Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -15,6 +15,10 @@ }, "VpcId": { "pattern": "^vpc-[A-Za-z0-9]{1,17}$", + "relationshipRef": { + "propertyPath": "/properties/VpcId", + "typeName": "AWS::EC2::VPC" + }, "type": "string" } }, diff --git a/artifacts/types/AWS::Redshift::EventSubscription.json b/artifacts/types/AWS::Redshift::EventSubscription.json index 8c8aae52..1b53ec91 100644 --- a/artifacts/types/AWS::Redshift::EventSubscription.json +++ b/artifacts/types/AWS::Redshift::EventSubscription.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Redshift-EventSubscription", "type": "AWS::Redshift::EventSubscription", - "time": "2024-01-04T18:20:51.066Z", + "time": "2024-06-24T17:52:23.792Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -167,7 +167,7 @@ }, "SubscriptionName": { "description": "The name of the Amazon Redshift event notification subscription", - "pattern": "^(?=^[a-z][a-z0-9]*(-[a-z0-9]+)*$).{1,255}$", + "pattern": "^(?=^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$).{1,255}$", "type": "string" }, "Tags": { diff --git a/artifacts/types/AWS::Redshift::ScheduledAction.json b/artifacts/types/AWS::Redshift::ScheduledAction.json index b604babe..638f3a2f 100644 --- a/artifacts/types/AWS::Redshift::ScheduledAction.json +++ b/artifacts/types/AWS::Redshift::ScheduledAction.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Redshift-ScheduledAction", "type": "AWS::Redshift::ScheduledAction", - "time": "2024-01-04T18:20:40.228Z", + "time": "2024-06-24T17:51:17.126Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -13,6 +13,10 @@ "description": "Describes a pause cluster operation. For example, a scheduled action to run the `PauseCluster` API operation.", "properties": { "ClusterIdentifier": { + "relationshipRef": { + "propertyPath": "/properties/ClusterIdentifier", + "typeName": "AWS::Redshift::Cluster" + }, "type": "string" } }, @@ -29,15 +33,31 @@ "type": "boolean" }, "ClusterIdentifier": { + "relationshipRef": { + "propertyPath": "/properties/ClusterIdentifier", + "typeName": "AWS::Redshift::Cluster" + }, "type": "string" }, "ClusterType": { + "relationshipRef": { + "propertyPath": "/properties/ClusterType", + "typeName": "AWS::Redshift::Cluster" + }, "type": "string" }, "NodeType": { + "relationshipRef": { + "propertyPath": "/properties/NodeType", + "typeName": "AWS::Redshift::Cluster" + }, "type": "string" }, "NumberOfNodes": { + "relationshipRef": { + "propertyPath": "/properties/NumberOfNodes", + "typeName": "AWS::Redshift::Cluster" + }, "type": "integer" } }, @@ -51,6 +71,10 @@ "description": "Describes a resume cluster operation. For example, a scheduled action to run the `ResumeCluster` API operation.", "properties": { "ClusterIdentifier": { + "relationshipRef": { + "propertyPath": "/properties/ClusterIdentifier", + "typeName": "AWS::Redshift::Cluster" + }, "type": "string" } }, @@ -166,12 +190,10 @@ }, "ScheduledActionDescription": { "description": "The description of the scheduled action.", - "pattern": "^(?=^[\\x09\\x0a\\x0d\\x20-\\xff]*$).{1,255}$", "type": "string" }, "ScheduledActionName": { "description": "The name of the scheduled action. The name must be unique within an account.", - "pattern": "^(?=^[a-z][a-z0-9]*(-[a-z0-9]+)*$).{1,60}$", "type": "string" }, "StartTime": { diff --git a/artifacts/types/AWS::RedshiftServerless::Namespace.json b/artifacts/types/AWS::RedshiftServerless::Namespace.json index b687696b..d1211ddf 100644 --- a/artifacts/types/AWS::RedshiftServerless::Namespace.json +++ b/artifacts/types/AWS::RedshiftServerless::Namespace.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-RedshiftServerless-Namespace", "type": "AWS::RedshiftServerless::Namespace", - "time": "2023-02-18T05:38:00.507Z", + "time": "2024-06-20T22:58:24.808Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -20,6 +20,12 @@ "Namespace": { "additionalProperties": false, "properties": { + "AdminPasswordSecretArn": { + "type": "string" + }, + "AdminPasswordSecretKmsKeyId": { + "type": "string" + }, "AdminUsername": { "type": "string" }, @@ -80,6 +86,24 @@ ], "type": "string" }, + "SnapshotCopyConfiguration": { + "additionalProperties": false, + "properties": { + "DestinationKmsKeyId": { + "type": "string" + }, + "DestinationRegion": { + "type": "string" + }, + "SnapshotRetentionPeriod": { + "type": "integer" + } + }, + "required": [ + "DestinationRegion" + ], + "type": "object" + }, "Tag": { "additionalProperties": false, "properties": { @@ -113,18 +137,33 @@ "kms:Encrypt", "kms:Decrypt", "kms:DescribeKey", + "kms:GenerateDataKeyPair", + "kms:GenerateDataKey", "kms:CreateGrant", "kms:ListGrants", "kms:RevokeGrant", + "kms:RetireGrant", "redshift-serverless:CreateNamespace", - "redshift-serverless:GetNamespace" + "redshift-serverless:GetNamespace", + "redshift-serverless:ListSnapshotCopyConfigurations", + "redshift-serverless:CreateSnapshotCopyConfiguration", + "redshift:GetResourcePolicy", + "redshift:PutResourcePolicy", + "secretsmanager:CreateSecret", + "secretsmanager:TagResource", + "secretsmanager:RotateSecret", + "secretsmanager:DescribeSecret" ] }, "delete": { "permissions": [ "iam:PassRole", "redshift-serverless:DeleteNamespace", - "redshift-serverless:GetNamespace" + "redshift-serverless:GetNamespace", + "kms:RetireGrant", + "secretsmanager:DescribeSecret", + "secretsmanager:DeleteSecret", + "redshift:DeleteResourcePolicy" ] }, "list": { @@ -136,7 +175,9 @@ "read": { "permissions": [ "iam:PassRole", - "redshift-serverless:GetNamespace" + "redshift-serverless:GetNamespace", + "redshift:GetResourcePolicy", + "redshift-serverless:ListSnapshotCopyConfigurations" ] }, "update": { @@ -152,8 +193,24 @@ "kms:CreateGrant", "kms:ListGrants", "kms:RevokeGrant", + "kms:RetireGrant", + "kms:GenerateDataKeyPair", + "kms:GenerateDataKey", "redshift-serverless:UpdateNamespace", - "redshift-serverless:GetNamespace" + "redshift-serverless:GetNamespace", + "redshift-serverless:ListSnapshotCopyConfigurations", + "redshift-serverless:CreateSnapshotCopyConfiguration", + "redshift-serverless:UpdateSnapshotCopyConfiguration", + "redshift-serverless:DeleteSnapshotCopyConfiguration", + "redshift:GetResourcePolicy", + "redshift:PutResourcePolicy", + "redshift:DeleteResourcePolicy", + "secretsmanager:CreateSecret", + "secretsmanager:TagResource", + "secretsmanager:RotateSecret", + "secretsmanager:DescribeSecret", + "secretsmanager:UpdateSecret", + "secretsmanager:DeleteSecret" ] } }, @@ -161,8 +218,12 @@ "/properties/NamespaceName" ], "properties": { + "AdminPasswordSecretKmsKeyId": { + "description": "The 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.", + "type": "string" + }, "AdminUserPassword": { - "description": "The password associated with the admin user for the namespace that is being created. Password must be at least 8 characters in length, should be any printable ASCII character. Must contain at least one lowercase letter, one uppercase letter and one decimal digit.", + "description": "The password associated with the admin user for the namespace that is being created. Password must be at least 8 characters in length, should be any printable ASCII character. Must contain at least one lowercase letter, one uppercase letter and one decimal digit. You can't use adminUserPassword if manageAdminPassword is true.", "maxLength": 64, "minLength": 8, "pattern": "^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)[^\\x00-\\x20\\x22\\x27\\x2f\\x40\\x5c\\x7f-\\uffff]+", @@ -217,8 +278,13 @@ "minItems": 0, "type": "array" }, + "ManageAdminPassword": { + "description": "If 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.", + "type": "boolean" + }, "Namespace": { - "$ref": "#/definitions/Namespace" + "$ref": "#/definitions/Namespace", + "description": "Definition of Namespace resource." }, "NamespaceName": { "description": "A unique identifier for the namespace. You use this identifier to refer to the namespace for any subsequent namespace operations such as deleting or modifying. All alphabetical characters must be lower case. Namespace name should be unique for all namespaces within an AWS account.", @@ -227,6 +293,24 @@ "pattern": "^[a-z0-9-]+$", "type": "string" }, + "NamespaceResourcePolicy": { + "description": "The resource policy document that will be attached to the namespace.", + "type": "object" + }, + "RedshiftIdcApplicationArn": { + "description": "The ARN for the Redshift application that integrates with IAM Identity Center.", + "type": "string" + }, + "SnapshotCopyConfigurations": { + "description": "The snapshot copy configurations for the namespace.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/SnapshotCopyConfiguration" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + }, "Tags": { "description": "The list of tags for the namespace.", "insertionOrder": false, @@ -266,7 +350,9 @@ "/properties/FinalSnapshotRetentionPeriod", "/properties/Tags", "/properties/Tags/*/Key", - "/properties/Tags/*/Value" + "/properties/Tags/*/Value", + "/properties/ManageAdminPassword", + "/properties/RedshiftIdcApplicationArn" ] } } \ No newline at end of file diff --git a/artifacts/types/AWS::RedshiftServerless::Workgroup.json b/artifacts/types/AWS::RedshiftServerless::Workgroup.json index 918b1ebe..b5cac970 100644 --- a/artifacts/types/AWS::RedshiftServerless::Workgroup.json +++ b/artifacts/types/AWS::RedshiftServerless::Workgroup.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-RedshiftServerless-Workgroup", "type": "AWS::RedshiftServerless::Workgroup", - "time": "2023-02-18T07:56:31.408Z", + "time": "2024-06-20T22:26:22.844Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -124,6 +124,9 @@ "EnhancedVpcRouting": { "type": "boolean" }, + "MaxCapacity": { + "type": "integer" + }, "NamespaceName": { "maxLength": 64, "minLength": 3, @@ -192,7 +195,10 @@ "ec2:DescribeSubnets", "ec2:DescribeAccountAttributes", "ec2:DescribeAvailabilityZones", - "redshift-serverless:CreateWorkgroup" + "redshift-serverless:CreateNamespace", + "redshift-serverless:CreateWorkgroup", + "redshift-serverless:GetWorkgroup", + "redshift-serverless:GetNamespace" ] }, "delete": { @@ -204,6 +210,8 @@ "ec2:DescribeSubnets", "ec2:DescribeAccountAttributes", "ec2:DescribeAvailabilityZones", + "redshift-serverless:GetWorkgroup", + "redshift-serverless:GetNamespace", "redshift-serverless:DeleteWorkgroup" ] }, @@ -253,9 +261,11 @@ ], "properties": { "BaseCapacity": { + "description": "The base compute capacity of the workgroup in Redshift Processing Units (RPUs).", "type": "integer" }, "ConfigParameters": { + "description": "A list of parameters to set for finer control over a database. Available options are datestyle, enable_user_activity_logging, query_group, search_path, max_query_execution_time, and require_ssl.", "insertionOrder": false, "items": { "$ref": "#/definitions/ConfigParameter" @@ -266,22 +276,31 @@ }, "EnhancedVpcRouting": { "default": false, + "description": "The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.", "type": "boolean" }, + "MaxCapacity": { + "description": "The max compute capacity of the workgroup in Redshift Processing Units (RPUs).", + "type": "integer" + }, "NamespaceName": { + "description": "The namespace the workgroup is associated with.", "maxLength": 64, "minLength": 3, "pattern": "^(?=^[a-z0-9-]+$).{3,64}$", "type": "string" }, "Port": { + "description": "The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.", "type": "integer" }, "PubliclyAccessible": { "default": false, + "description": "A value that specifies whether the workgroup can be accessible from a public network.", "type": "boolean" }, "SecurityGroupIds": { + "description": "A list of security group IDs to associate with the workgroup.", "insertionOrder": false, "items": { "maxLength": 255, @@ -294,6 +313,7 @@ "type": "array" }, "SubnetIds": { + "description": "A list of subnet IDs the workgroup is associated with.", "insertionOrder": false, "items": { "maxLength": 255, @@ -306,6 +326,7 @@ "type": "array" }, "Tags": { + "description": "The map of the key-value pairs used to tag the workgroup.", "insertionOrder": false, "items": { "$ref": "#/definitions/Tag" @@ -315,9 +336,11 @@ "type": "array" }, "Workgroup": { - "$ref": "#/definitions/Workgroup" + "$ref": "#/definitions/Workgroup", + "description": "Definition for workgroup resource" }, "WorkgroupName": { + "description": "The name of the workgroup.", "maxLength": 64, "minLength": 3, "pattern": "^(?=^[a-z0-9-]+$).{3,64}$", @@ -331,6 +354,7 @@ "/properties/Workgroup/WorkgroupName", "/properties/Workgroup/NamespaceName", "/properties/Workgroup/BaseCapacity", + "/properties/Workgroup/MaxCapacity", "/properties/Workgroup/EnhancedVpcRouting", "/properties/Workgroup/ConfigParameters/*/ParameterKey", "/properties/Workgroup/ConfigParameters/*/ParameterValue", @@ -358,6 +382,7 @@ "typeName": "AWS::RedshiftServerless::Workgroup", "writeOnlyProperties": [ "/properties/BaseCapacity", + "/properties/MaxCapacity", "/properties/ConfigParameters", "/properties/SecurityGroupIds", "/properties/SubnetIds", diff --git a/artifacts/types/AWS::Rekognition::Collection.json b/artifacts/types/AWS::Rekognition::Collection.json index 833dda72..7dc4e5fd 100644 --- a/artifacts/types/AWS::Rekognition::Collection.json +++ b/artifacts/types/AWS::Rekognition::Collection.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Rekognition-Collection", "type": "AWS::Rekognition::Collection", - "time": "2023-09-11T15:19:23.28Z", + "time": "2024-06-10T16:04:27.394Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -50,7 +50,8 @@ "permissions": [ "rekognition:CreateCollection", "rekognition:DescribeCollection", - "rekognition:ListTagsForResource" + "rekognition:ListTagsForResource", + "rekognition:TagResource" ] }, "delete": { diff --git a/artifacts/types/AWS::Rekognition::Project.json b/artifacts/types/AWS::Rekognition::Project.json index bc62c5d3..bf3e69a4 100644 --- a/artifacts/types/AWS::Rekognition::Project.json +++ b/artifacts/types/AWS::Rekognition::Project.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Rekognition-Project", "type": "AWS::Rekognition::Project", - "time": "2024-01-02T23:13:10.985Z", + "time": "2024-06-11T04:05:18.08Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Rekognition::StreamProcessor.json b/artifacts/types/AWS::Rekognition::StreamProcessor.json index 21ff7fd3..79302ac2 100644 --- a/artifacts/types/AWS::Rekognition::StreamProcessor.json +++ b/artifacts/types/AWS::Rekognition::StreamProcessor.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Rekognition-StreamProcessor", "type": "AWS::Rekognition::StreamProcessor", - "time": "2023-12-12T18:00:15.676Z", + "time": "2024-05-29T15:47:08.739Z", "schema": { "$comment": "We explicitly specify the replacement strategy to be delete_then_create because we cannot create a new SP resource with the same name or same KVS input before deleting the old one", "additionalProperties": false, diff --git a/artifacts/types/AWS::ResilienceHub::App.json b/artifacts/types/AWS::ResilienceHub::App.json index 16d16ccf..a174e4a6 100644 --- a/artifacts/types/AWS::ResilienceHub::App.json +++ b/artifacts/types/AWS::ResilienceHub::App.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ResilienceHub-App", "type": "AWS::ResilienceHub::App", - "time": "2024-01-03T17:37:15.831Z", + "time": "2024-06-24T15:46:43.352Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -188,7 +188,8 @@ "resiliencehub:DescribeApp", "resiliencehub:DescribeAppVersionTemplate", "resiliencehub:ListAppVersionResourceMappings", - "resiliencehub:ListTagsForResource" + "resiliencehub:ListTagsForResource", + "resiliencehub:ListAppVersions" ] }, "update": { diff --git a/artifacts/types/AWS::ResilienceHub::ResiliencyPolicy.json b/artifacts/types/AWS::ResilienceHub::ResiliencyPolicy.json index b15d1e86..3160d2d4 100644 --- a/artifacts/types/AWS::ResilienceHub::ResiliencyPolicy.json +++ b/artifacts/types/AWS::ResilienceHub::ResiliencyPolicy.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ResilienceHub-ResiliencyPolicy", "type": "AWS::ResilienceHub::ResiliencyPolicy", - "time": "2024-01-03T16:57:42.331Z", + "time": "2024-06-24T15:22:31.96Z", "schema": { "additionalProperties": false, "definitions": { @@ -26,11 +26,25 @@ }, "PolicyMap": { "additionalProperties": false, - "patternProperties": { - ".*{1,8}": { + "properties": { + "AZ": { + "$ref": "#/definitions/FailurePolicy" + }, + "Hardware": { + "$ref": "#/definitions/FailurePolicy" + }, + "Region": { + "$ref": "#/definitions/FailurePolicy" + }, + "Software": { "$ref": "#/definitions/FailurePolicy" } }, + "required": [ + "AZ", + "Hardware", + "Software" + ], "type": "object" }, "TagMap": { diff --git a/artifacts/types/AWS::ResourceExplorer2::DefaultViewAssociation.json b/artifacts/types/AWS::ResourceExplorer2::DefaultViewAssociation.json index cd07435d..b9276f6f 100644 --- a/artifacts/types/AWS::ResourceExplorer2::DefaultViewAssociation.json +++ b/artifacts/types/AWS::ResourceExplorer2::DefaultViewAssociation.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ResourceExplorer2-DefaultViewAssociation", "type": "AWS::ResourceExplorer2::DefaultViewAssociation", - "time": "2024-01-04T01:56:58.96Z", + "time": "2024-06-04T14:21:40.775Z", "schema": { "additionalProperties": false, "description": "Definition of AWS::ResourceExplorer2::DefaultViewAssociation Resource Type", diff --git a/artifacts/types/AWS::ResourceExplorer2::Index.json b/artifacts/types/AWS::ResourceExplorer2::Index.json index 55b7d9d0..0509e375 100644 --- a/artifacts/types/AWS::ResourceExplorer2::Index.json +++ b/artifacts/types/AWS::ResourceExplorer2::Index.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ResourceExplorer2-Index", "type": "AWS::ResourceExplorer2::Index", - "time": "2024-01-03T14:44:07.532Z", + "time": "2024-06-11T16:13:17.967Z", "schema": { "additionalProperties": false, "definitions": { diff --git a/artifacts/types/AWS::ResourceExplorer2::View.json b/artifacts/types/AWS::ResourceExplorer2::View.json index dc66192e..4e9f3dfb 100644 --- a/artifacts/types/AWS::ResourceExplorer2::View.json +++ b/artifacts/types/AWS::ResourceExplorer2::View.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ResourceExplorer2-View", "type": "AWS::ResourceExplorer2::View", - "time": "2024-01-04T01:40:21.931Z", + "time": "2024-06-04T14:05:37.655Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::ResourceGroups::Group.json b/artifacts/types/AWS::ResourceGroups::Group.json index 66a44ad3..efddc6d2 100644 --- a/artifacts/types/AWS::ResourceGroups::Group.json +++ b/artifacts/types/AWS::ResourceGroups::Group.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ResourceGroups-Group", "type": "AWS::ResourceGroups::Group", - "time": "2023-12-28T11:47:41.91Z", + "time": "2024-06-20T11:02:08.952Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::RoboMaker::Fleet.json b/artifacts/types/AWS::RoboMaker::Fleet.json index 0743e327..757760a2 100644 --- a/artifacts/types/AWS::RoboMaker::Fleet.json +++ b/artifacts/types/AWS::RoboMaker::Fleet.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-RoboMaker-Fleet", "type": "AWS::RoboMaker::Fleet", - "time": "2023-05-11T18:20:32.452Z", + "time": "2024-02-20T16:45:49.041Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::RoboMaker::Robot.json b/artifacts/types/AWS::RoboMaker::Robot.json index 789aa8e9..2458f168 100644 --- a/artifacts/types/AWS::RoboMaker::Robot.json +++ b/artifacts/types/AWS::RoboMaker::Robot.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-RoboMaker-Robot", "type": "AWS::RoboMaker::Robot", - "time": "2023-05-11T18:20:32.098Z", + "time": "2024-02-20T16:46:40.054Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::RoboMaker::RobotApplication.json b/artifacts/types/AWS::RoboMaker::RobotApplication.json index 686621e2..39e01b8d 100644 --- a/artifacts/types/AWS::RoboMaker::RobotApplication.json +++ b/artifacts/types/AWS::RoboMaker::RobotApplication.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-RoboMaker-RobotApplication", "type": "AWS::RoboMaker::RobotApplication", - "time": "2023-06-20T15:38:04.35Z", + "time": "2024-02-20T16:55:35.89Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -88,11 +88,19 @@ "handlers": { "create": { "permissions": [ - "robomaker:CreateRobotApplication" + "robomaker:CreateRobotApplication", + "robomaker:TagResource", + "robomaker:UntagResource", + "ecr:BatchGetImage", + "ecr:GetAuthorizationToken", + "ecr:BatchCheckLayerAvailability", + "ecr-public:GetAuthorizationToken", + "sts:GetServiceBearerToken" ] }, "delete": { "permissions": [ + "robomaker:DescribeRobotApplication", "robomaker:DeleteRobotApplication" ] }, @@ -110,7 +118,11 @@ "permissions": [ "robomaker:TagResource", "robomaker:UntagResource", - "robomaker:UpdateRobotApplication" + "robomaker:UpdateRobotApplication", + "ecr:BatchGetImage", + "ecr:GetAuthorizationToken", + "ecr:BatchCheckLayerAvailability", + "ecr-public:GetAuthorizationToken" ] } }, diff --git a/artifacts/types/AWS::RoboMaker::SimulationApplication.json b/artifacts/types/AWS::RoboMaker::SimulationApplication.json index efdb37ba..8cb90cc5 100644 --- a/artifacts/types/AWS::RoboMaker::SimulationApplication.json +++ b/artifacts/types/AWS::RoboMaker::SimulationApplication.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-RoboMaker-SimulationApplication", "type": "AWS::RoboMaker::SimulationApplication", - "time": "2023-06-20T15:37:56.619Z", + "time": "2024-02-20T16:54:42.074Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -146,11 +146,19 @@ "handlers": { "create": { "permissions": [ - "robomaker:CreateSimulationApplication" + "robomaker:CreateSimulationApplication", + "robomaker:TagResource", + "robomaker:UntagResource", + "ecr:BatchGetImage", + "ecr:GetAuthorizationToken", + "ecr:BatchCheckLayerAvailability", + "ecr-public:GetAuthorizationToken", + "sts:GetServiceBearerToken" ] }, "delete": { "permissions": [ + "robomaker:DescribeSimulationApplication", "robomaker:DeleteSimulationApplication" ] }, @@ -168,7 +176,11 @@ "permissions": [ "robomaker:TagResource", "robomaker:UntagResource", - "robomaker:UpdateSimulationApplication" + "robomaker:UpdateSimulationApplication", + "ecr:BatchGetImage", + "ecr:GetAuthorizationToken", + "ecr:BatchCheckLayerAvailability", + "ecr-public:GetAuthorizationToken" ] } }, diff --git a/artifacts/types/AWS::RolesAnywhere::CRL.json b/artifacts/types/AWS::RolesAnywhere::CRL.json index e387186a..4e888682 100644 --- a/artifacts/types/AWS::RolesAnywhere::CRL.json +++ b/artifacts/types/AWS::RolesAnywhere::CRL.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-RolesAnywhere-CRL", "type": "AWS::RolesAnywhere::CRL", - "time": "2023-11-02T15:29:03.664Z", + "time": "2024-06-24T15:46:55.575Z", "schema": { "additionalProperties": false, "definitions": { diff --git a/artifacts/types/AWS::RolesAnywhere::Profile.json b/artifacts/types/AWS::RolesAnywhere::Profile.json index 7f87c12c..6b4a06ac 100644 --- a/artifacts/types/AWS::RolesAnywhere::Profile.json +++ b/artifacts/types/AWS::RolesAnywhere::Profile.json @@ -1,10 +1,49 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-RolesAnywhere-Profile", "type": "AWS::RolesAnywhere::Profile", - "time": "2023-11-02T15:25:55.311Z", + "time": "2024-06-24T15:44:59.008Z", "schema": { "additionalProperties": false, "definitions": { + "AttributeMapping": { + "additionalProperties": false, + "properties": { + "CertificateField": { + "$ref": "#/definitions/CertificateField" + }, + "MappingRules": { + "items": { + "$ref": "#/definitions/MappingRule" + }, + "type": "array" + } + }, + "required": [ + "CertificateField", + "MappingRules" + ], + "type": "object" + }, + "CertificateField": { + "enum": [ + "x509Subject", + "x509Issuer", + "x509SAN" + ], + "type": "string" + }, + "MappingRule": { + "additionalProperties": false, + "properties": { + "Specifier": { + "type": "string" + } + }, + "required": [ + "Specifier" + ], + "type": "object" + }, "Tag": { "additionalProperties": false, "properties": { @@ -35,7 +74,9 @@ "iam:PassRole", "rolesanywhere:CreateProfile", "rolesanywhere:TagResource", - "rolesanywhere:ListTagsForResource" + "rolesanywhere:ListTagsForResource", + "rolesanywhere:PutAttributeMapping", + "rolesanywhere:DeleteAttributeMapping" ] }, "delete": { @@ -60,12 +101,15 @@ "iam:GetRole", "iam:GetPolicy", "iam:PassRole", + "rolesanywhere:GetProfile", "rolesanywhere:UpdateProfile", "rolesanywhere:EnableProfile", "rolesanywhere:DisableProfile", "rolesanywhere:TagResource", "rolesanywhere:UntagResource", - "rolesanywhere:ListTagsForResource" + "rolesanywhere:ListTagsForResource", + "rolesanywhere:PutAttributeMapping", + "rolesanywhere:DeleteAttributeMapping" ] } }, @@ -73,6 +117,12 @@ "/properties/ProfileId" ], "properties": { + "AttributeMappings": { + "items": { + "$ref": "#/definitions/AttributeMapping" + }, + "type": "array" + }, "DurationSeconds": { "maximum": 43200, "minimum": 900, @@ -128,6 +178,13 @@ "Name", "RoleArns" ], + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, "typeName": "AWS::RolesAnywhere::Profile" } } \ No newline at end of file diff --git a/artifacts/types/AWS::RolesAnywhere::TrustAnchor.json b/artifacts/types/AWS::RolesAnywhere::TrustAnchor.json index 05276bca..c27cd753 100644 --- a/artifacts/types/AWS::RolesAnywhere::TrustAnchor.json +++ b/artifacts/types/AWS::RolesAnywhere::TrustAnchor.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-RolesAnywhere-TrustAnchor", "type": "AWS::RolesAnywhere::TrustAnchor", - "time": "2023-11-02T15:26:03.447Z", + "time": "2024-06-24T15:45:13.853Z", "schema": { "additionalProperties": false, "definitions": { diff --git a/artifacts/types/AWS::Route53::CidrCollection.json b/artifacts/types/AWS::Route53::CidrCollection.json index 4125dfbc..4884aa8c 100644 --- a/artifacts/types/AWS::Route53::CidrCollection.json +++ b/artifacts/types/AWS::Route53::CidrCollection.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Route53-CidrCollection", "type": "AWS::Route53::CidrCollection", - "time": "2023-06-08T15:38:07.608Z", + "time": "2024-04-02T17:36:45.195Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Route53::HealthCheck.json b/artifacts/types/AWS::Route53::HealthCheck.json index ae13bb15..1cc5605f 100644 --- a/artifacts/types/AWS::Route53::HealthCheck.json +++ b/artifacts/types/AWS::Route53::HealthCheck.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Route53-HealthCheck", "type": "AWS::Route53::HealthCheck", - "time": "2023-06-27T15:17:31.814Z", + "time": "2024-02-28T16:12:02.818Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Route53::HostedZone.json b/artifacts/types/AWS::Route53::HostedZone.json index 2b6fb262..ca5f7b47 100644 --- a/artifacts/types/AWS::Route53::HostedZone.json +++ b/artifacts/types/AWS::Route53::HostedZone.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Route53-HostedZone", "type": "AWS::Route53::HostedZone", - "time": "2023-10-20T00:12:49.462Z", + "time": "2024-06-18T18:07:13.969Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -10,7 +10,7 @@ "definitions": { "HostedZoneConfig": { "additionalProperties": false, - "description": "A complex type that contains an optional comment.\n\nIf you don't want to specify a comment, omit the HostedZoneConfig and Comment elements.", + "description": "A complex type that contains an optional comment about your hosted zone. If you don't want to specify a comment, omit both the ``HostedZoneConfig`` and ``Comment`` elements.", "properties": { "Comment": { "description": "Any comments that you want to include about the hosted zone.", @@ -25,12 +25,12 @@ "description": "A complex type that contains information about a tag that you want to add or edit for the specified health check or hosted zone.", "properties": { "Key": { - "description": "The key name of the tag.", + "description": "The value of ``Key`` depends on the operation that you want to perform:\n + *Add a tag to a health check or hosted zone*: ``Key`` is the name that you want to give the new tag.\n + *Edit a tag*: ``Key`` is the name of the tag that you want to change the ``Value`` for.\n + *Delete a key*: ``Key`` is the name of the tag you want to remove.\n + *Give a name to a health check*: Edit the default ``Name`` tag. In the Amazon Route 53 console, the list of your health checks includes a *Name* column that lets you see the name that you've given to each health check.", "maxLength": 128, "type": "string" }, "Value": { - "description": "The value for the tag.", + "description": "The value of ``Value`` depends on the operation that you want to perform:\n + *Add a tag to a health check or hosted zone*: ``Value`` is the value that you want to give the new tag.\n + *Edit a tag*: ``Value`` is the new value that you want to assign the tag.", "maxLength": 256, "type": "string" } @@ -47,6 +47,10 @@ "properties": { "CloudWatchLogsLogGroupArn": { "description": "The Amazon Resource Name (ARN) of the CloudWatch Logs log group that Amazon Route 53 is publishing logs to.", + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::Logs::LogGroup" + }, "type": "string" } }, @@ -57,14 +61,18 @@ }, "VPC": { "additionalProperties": false, - "description": "A complex type that contains information about an Amazon VPC. Route 53 Resolver uses the records in the private hosted zone to route traffic in that VPC.", + "description": "*Private hosted zones only:* A complex type that contains information about an Amazon VPC. Route 53 Resolver uses the records in the private hosted zone to route traffic in that VPC. \n For public hosted zones, omit ``VPCs``, ``VPCId``, and ``VPCRegion``.", "properties": { "VPCId": { - "description": "The ID of an Amazon VPC.", + "description": "*Private hosted zones only:* The ID of an Amazon VPC.\n For public hosted zones, omit ``VPCs``, ``VPCId``, and ``VPCRegion``.", + "relationshipRef": { + "propertyPath": "/properties/VpcId", + "typeName": "AWS::EC2::VPC" + }, "type": "string" }, "VPCRegion": { - "description": "The region that an Amazon VPC was created in. See https://docs.aws.amazon.com/general/latest/gr/rande.html for a list of up to date regions.", + "description": "*Private hosted zones only:* The region that an Amazon VPC was created in.\n For public hosted zones, omit ``VPCs``, ``VPCId``, and ``VPCRegion``.", "type": "string" } }, @@ -75,7 +83,7 @@ "type": "object" } }, - "description": "Resource schema for AWS::Route53::HostedZone.", + "description": "Creates a new public or private hosted zone. You create records in a public hosted zone to define how you want to route traffic on the internet for a domain, such as example.com, and its subdomains (apex.example.com, acme.example.com). You create records in a private hosted zone to define how you want to route traffic for a domain and its subdomains within one or more Amazon Virtual Private Clouds (Amazon VPCs). \n You can't convert a public hosted zone to a private hosted zone or vice versa. Instead, you must create a new hosted zone with the same name and create new resource record sets.\n For more information about charges for hosted zones, see [Amazon Route 53 Pricing](https://docs.aws.amazon.com/route53/pricing/).\n Note the following:\n + You can't create a hosted zone for a top-level domain (TLD) such as .com.\n + If your domain is registered with a registrar other than Route 53, you must update the name servers with your registrar to make Route 53 the DNS service for the domain. For more information, see [Migrating DNS Service for an Existing Domain to Amazon Route 53](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/MigratingDNS.html) in the *Amazon Route 53 Developer Guide*. \n \n When you submit a ``CreateHostedZone`` request, the initial status of the hosted zone is ``PENDING``. For public hosted zones, this means that the NS and SOA records are not yet available on all Route 53 DNS servers. When the NS and SOA records are available, the status of the zone changes to ``INSYNC``.\n The ``CreateHostedZone`` request requires the caller to have an ``ec2:DescribeVpcs`` permission.\n When creating private hosted zones, the Amazon VPC must belong to the same partition where the hosted zone is created. A partition is a group of AWS-Regions. Each AWS-account is scoped to one partition.\n The following are the supported partitions:\n + ``aws`` - AWS-Regions \n + ``aws-cn`` - China Regions\n + ``aws-us-gov`` - govcloud-us-region \n \n For more information, see [Access Management](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*.", "handlers": { "create": { "permissions": [ @@ -130,10 +138,11 @@ ], "properties": { "HostedZoneConfig": { - "$ref": "#/definitions/HostedZoneConfig" + "$ref": "#/definitions/HostedZoneConfig", + "description": "A complex type that contains an optional comment.\n If you don't want to specify a comment, omit the ``HostedZoneConfig`` and ``Comment`` elements." }, "HostedZoneTags": { - "description": "Adds, edits, or deletes tags for a health check or a hosted zone.\n\nFor information about using tags for cost allocation, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.", + "description": "Adds, edits, or deletes tags for a health check or a hosted zone.\n For information about using tags for cost allocation, see [Using Cost Allocation Tags](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) in the *User Guide*.", "insertionOrder": false, "items": { "$ref": "#/definitions/HostedZoneTag" @@ -142,14 +151,16 @@ "uniqueItems": true }, "Id": { + "description": "", "type": "string" }, "Name": { - "description": "The name of the domain. Specify a fully qualified domain name, for example, www.example.com. The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.\n\nIf you're creating a public hosted zone, this is the name you have registered with your DNS registrar. If your domain name is registered with a registrar other than Route 53, change the name servers for your domain to the set of NameServers that are returned by the Fn::GetAtt intrinsic function.", + "description": "The name of the domain. Specify a fully qualified domain name, for example, *www.example.com*. The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats *www.example.com* (without a trailing dot) and *www.example.com.* (with a trailing dot) as identical.\n If you're creating a public hosted zone, this is the name you have registered with your DNS registrar. If your domain name is registered with a registrar other than Route 53, change the name servers for your domain to the set of ``NameServers`` that are returned by the ``Fn::GetAtt`` intrinsic function.", "maxLength": 1024, "type": "string" }, "NameServers": { + "description": "", "items": { "type": "string" }, @@ -157,10 +168,11 @@ "uniqueItems": false }, "QueryLoggingConfig": { - "$ref": "#/definitions/QueryLoggingConfig" + "$ref": "#/definitions/QueryLoggingConfig", + "description": "Creates 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 DNS query logs contain information about the queries that Route 53 receives for a specified 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 ``ServFail`` \n \n + Log Group and Resource Policy Before you create a query logging configuration, perform the following operations. If you create a query logging configuration using the Route 53 console, Route 53 performs these operations automatically. Create a CloudWatch Logs log group, and make note of the ARN, which you specify when you create a query logging configuration. Note the following: You must create the log group in the us-east-1 region. You must use the same to create the log group and the hosted zone that you want to configure query logging for. When you create log groups for query logging, we recommend that you use a consistent prefix, for example: /aws/route53/hosted zone name In the next step, you'll create a resource policy, which controls access to one or more log groups and the associated resources, such as Route 53 hosted zones. There's a limit on the number of resource policies that you can create, so we recommend that you use a consistent prefix so you can use the same resource policy for all the log groups that you create for query logging. Create a CloudWatch Logs resource policy, and give it the permissions that Route 53 needs to create log streams and to send query logs to log streams. You must create the CloudWatch Logs resource policy in the us-east-1 region. For the value of Resource, specify the ARN for the log group that you created in the previous step. To use the same resource policy for all the CloudWatch Logs log groups that you created for query logging configurations, replace the hosted zone name with *, for example: arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/* To avoid the confused deputy problem, a security issue where an entity without a permission for an action can coerce a more-privileged entity to perform it, you can optionally limit the permissions that a service has to a resource in a resource-based policy by supplying the following values: For aws:SourceArn, supply the hosted zone ARN used in creating the query logging configuration. For example, aws:SourceArn: arn:aws:route53:::hostedzone/hosted zone ID. For aws:SourceAccount, supply the account ID for the account that creates the query logging configuration. For example, aws:SourceAccount:111111111111. For more information, see The confused deputy problem in the IAM User Guide. You can't use the CloudWatch console to create or edit a resource policy. You must use the CloudWatch API, one of the SDKs, or the . + Log Streams and Edge Locations When Route 53 finishes creating the configuration for DNS query logging, it does the following: Creates a log stream for an edge location the first time that the edge location responds to DNS queries for the specified hosted zone. That log stream is used to log all queries that Route 53 responds to for that edge location. Begins to send query logs to the applicable log stream. The name of each log stream is in the following format: hosted zone ID/edge location code The edge location code is a three-letter code and an arbitrarily assigned number, for example, DFW3. The three-letter code typically corresponds with the International Air Transport Association airport code for an airport near the edge location. (These abbreviations might change in the future.) For a list of edge locations, see \"The Route 53 Global Network\" on the Route 53 Product Details page. + Queries That Are Logged Query logs contain only the queries that DNS resolvers forward to Route 53. If a DNS resolver has already cached the response to a query (such as the IP address for a load balancer for example.com), the resolver will continue to return the cached response. It doesn't forward another query to Route 53 until the TTL for the corresponding resource record set expires. Depending on how many DNS queries are submitted for a resource record set, and depending on the TTL for that resource record set, query logs might contain information about only one query out of every several thousand queries that are submitted to DNS. For more information about how DNS works, see Routing Internet Traffic to Your Website or Web Application in the Amazon Route 53 Developer Guide. + Log File Format For a list of the values in each query log and the format of each value, see Logging DNS Queries in the Amazon Route 53 Developer Guide. + Pricing For information about charges for query logs, see Amazon CloudWatch Pricing. + How to Stop Logging If you want Route 53 to stop sending query logs to CloudWatch Logs, delete the query logging configuration. For more information, see DeleteQueryLoggingConfig." }, "VPCs": { - "description": "A complex type that contains information about the VPCs that are associated with the specified hosted zone.", + "description": "*Private hosted zones:* A complex type that contains information about the VPCs that are associated with the specified hosted zone.\n For public hosted zones, omit ``VPCs``, ``VPCId``, and ``VPCRegion``.", "insertionOrder": false, "items": { "$ref": "#/definitions/VPC" @@ -169,6 +181,9 @@ "uniqueItems": true } }, + "propertyTransform": { + "/properties/Name": "Name $OR $join([Name, \".\"])" + }, "readOnlyProperties": [ "/properties/Id", "/properties/NameServers" diff --git a/artifacts/types/AWS::Route53::KeySigningKey.json b/artifacts/types/AWS::Route53::KeySigningKey.json index 8c06c53c..4a493a92 100644 --- a/artifacts/types/AWS::Route53::KeySigningKey.json +++ b/artifacts/types/AWS::Route53::KeySigningKey.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Route53-KeySigningKey", "type": "AWS::Route53::KeySigningKey", - "time": "2024-01-04T17:26:55.671Z", + "time": "2024-06-14T00:38:11.216Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Route53Profiles::Profile.json b/artifacts/types/AWS::Route53Profiles::Profile.json new file mode 100644 index 00000000..01d9b039 --- /dev/null +++ b/artifacts/types/AWS::Route53Profiles::Profile.json @@ -0,0 +1,126 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Route53Profiles-Profile", + "type": "AWS::Route53Profiles::Profile", + "time": "2024-06-05T07:29:04.514Z", + "schema": { + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Route53Profiles::Profile", + "handlers": { + "create": { + "permissions": [ + "route53profiles:CreateProfile", + "route53profiles:GetProfile", + "route53profiles:TagResource", + "route53profiles:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "route53profiles:DeleteProfile", + "route53profiles:GetProfile", + "route53profiles:UntagResource" + ] + }, + "list": { + "permissions": [ + "route53profiles:ListProfiles", + "route53profiles:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "route53profiles:GetProfile", + "route53profiles:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "route53profiles:GetProfile", + "route53profiles:TagResource", + "route53profiles:UntagResource", + "route53profiles:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "description": "The Amazon Resource Name (ARN) of the resolver profile.", + "type": "string" + }, + "ClientToken": { + "description": "The id of the creator request", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "Id": { + "description": "The ID of the profile.", + "type": "string" + }, + "Name": { + "description": "The name of the profile.", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/Id", + "/properties/ClientToken" + ], + "required": [ + "Name" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Route53Profiles::Profile", + "writeOnlyProperties": [ + "/properties/Tags" + ] + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::Route53Profiles::ProfileAssociation.json b/artifacts/types/AWS::Route53Profiles::ProfileAssociation.json new file mode 100644 index 00000000..9e62806d --- /dev/null +++ b/artifacts/types/AWS::Route53Profiles::ProfileAssociation.json @@ -0,0 +1,129 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Route53Profiles-ProfileAssociation", + "type": "AWS::Route53Profiles::ProfileAssociation", + "time": "2024-06-05T08:36:12.484Z", + "schema": { + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/ResourceId", + "/properties/ProfileId" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Value", + "Key" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::Route53Profiles::ProfileAssociation", + "handlers": { + "create": { + "permissions": [ + "route53profiles:AssociateProfile", + "route53profiles:GetProfileAssociation", + "ec2:DescribeVpcs", + "route53profiles:TagResource" + ] + }, + "delete": { + "permissions": [ + "route53profiles:DisassociateProfile", + "route53profiles:GetProfileAssociation", + "route53profiles:UntagResource" + ] + }, + "list": { + "permissions": [ + "route53profiles:ListProfileAssociations", + "route53profiles:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "route53profiles:GetProfileAssociation", + "route53profiles:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "route53profiles:GetProfileAssociation", + "route53profiles:TagResource", + "route53profiles:UntagResource", + "route53profiles:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Arn": { + "description": "The Amazon Resource Name (ARN) of the profile association.", + "type": "string" + }, + "Id": { + "description": "Primary Identifier for Profile Association", + "type": "string" + }, + "Name": { + "description": "The name of an association between a Profile and a VPC.", + "type": "string" + }, + "ProfileId": { + "description": "The ID of the profile that you associated with the resource that is specified by ResourceId.", + "type": "string" + }, + "ResourceId": { + "description": "The resource that you associated the profile with.", + "type": "string" + }, + "Tags": { + "description": "An array of key-value pairs to apply to this resource.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Id" + ], + "required": [ + "ResourceId", + "ProfileId", + "Name" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Route53Profiles::ProfileAssociation", + "writeOnlyProperties": [ + "/properties/Arn", + "/properties/Tags" + ] + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::Route53Profiles::ProfileResourceAssociation.json b/artifacts/types/AWS::Route53Profiles::ProfileResourceAssociation.json new file mode 100644 index 00000000..dc93cd2d --- /dev/null +++ b/artifacts/types/AWS::Route53Profiles::ProfileResourceAssociation.json @@ -0,0 +1,110 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Route53Profiles-ProfileResourceAssociation", + "type": "AWS::Route53Profiles::ProfileResourceAssociation", + "time": "2024-06-05T08:01:21.171Z", + "schema": { + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/ProfileId", + "/properties/Name", + "/properties/ResourceArn" + ], + "description": "Resource Type definition for AWS::Route53Profiles::ProfileResourceAssociation", + "handlers": { + "create": { + "permissions": [ + "route53profiles:AssociateResourceToProfile", + "route53profiles:GetProfileResourceAssociation", + "route53resolver:*", + "route53:*" + ] + }, + "delete": { + "permissions": [ + "route53profiles:DisassociateResourceFromProfile", + "route53profiles:GetProfileResourceAssociation", + "route53resolver:*", + "route53:*" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "ProfileId": { + "$ref": "resource-schema.json#/properties/ProfileId" + } + }, + "required": [ + "ProfileId" + ] + }, + "permissions": [ + "route53profiles:ListProfileResourceAssociations", + "route53resolver:*", + "route53:*" + ] + }, + "read": { + "permissions": [ + "route53profiles:GetProfileResourceAssociation", + "route53resolver:*", + "route53:*" + ] + }, + "update": { + "permissions": [ + "route53profiles:UpdateProfileResourceAssociation", + "route53profiles:GetProfileResourceAssociation", + "route53resolver:*", + "route53:*" + ] + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "Id": { + "description": "Primary Identifier for Profile Resource Association", + "type": "string" + }, + "Name": { + "description": "The name of an association between the Profile and resource.", + "type": "string" + }, + "ProfileId": { + "description": "The ID of the profile that you associated the resource to that is specified by ResourceArn.", + "type": "string" + }, + "ResourceArn": { + "description": "The arn of the resource that you associated to the Profile.", + "type": "string" + }, + "ResourceProperties": { + "description": "A JSON-formatted string with key-value pairs specifying the properties of the associated resource.", + "type": "string" + }, + "ResourceType": { + "description": "The type of the resource associated to the Profile.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Id", + "/properties/ResourceType" + ], + "required": [ + "ProfileId", + "Name", + "ResourceArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-route53profiles", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, + "typeName": "AWS::Route53Profiles::ProfileResourceAssociation" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::Route53RecoveryControl::ControlPanel.json b/artifacts/types/AWS::Route53RecoveryControl::ControlPanel.json index e91b2d22..e9dda609 100644 --- a/artifacts/types/AWS::Route53RecoveryControl::ControlPanel.json +++ b/artifacts/types/AWS::Route53RecoveryControl::ControlPanel.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Route53RecoveryControl-ControlPanel", "type": "AWS::Route53RecoveryControl::ControlPanel", - "time": "2024-01-04T22:08:43.046Z", + "time": "2024-02-08T16:33:46.096Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Route53RecoveryControl::RoutingControl.json b/artifacts/types/AWS::Route53RecoveryControl::RoutingControl.json index 131be90d..62489959 100644 --- a/artifacts/types/AWS::Route53RecoveryControl::RoutingControl.json +++ b/artifacts/types/AWS::Route53RecoveryControl::RoutingControl.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Route53RecoveryControl-RoutingControl", "type": "AWS::Route53RecoveryControl::RoutingControl", - "time": "2024-01-04T22:09:26.943Z", + "time": "2024-02-08T16:33:51.717Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Route53RecoveryControl::SafetyRule.json b/artifacts/types/AWS::Route53RecoveryControl::SafetyRule.json index d47f46ae..bd747fd9 100644 --- a/artifacts/types/AWS::Route53RecoveryControl::SafetyRule.json +++ b/artifacts/types/AWS::Route53RecoveryControl::SafetyRule.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Route53RecoveryControl-SafetyRule", "type": "AWS::Route53RecoveryControl::SafetyRule", - "time": "2024-01-04T22:17:05.886Z", + "time": "2024-02-08T16:39:49.231Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Route53RecoveryReadiness::Cell.json b/artifacts/types/AWS::Route53RecoveryReadiness::Cell.json index d8349f8d..c75fa4d6 100644 --- a/artifacts/types/AWS::Route53RecoveryReadiness::Cell.json +++ b/artifacts/types/AWS::Route53RecoveryReadiness::Cell.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Route53RecoveryReadiness-Cell", "type": "AWS::Route53RecoveryReadiness::Cell", - "time": "2024-01-02T16:33:47.534Z", + "time": "2024-06-24T15:22:16.188Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Route53RecoveryReadiness::ReadinessCheck.json b/artifacts/types/AWS::Route53RecoveryReadiness::ReadinessCheck.json index 0a32ae6d..b632d5ca 100644 --- a/artifacts/types/AWS::Route53RecoveryReadiness::ReadinessCheck.json +++ b/artifacts/types/AWS::Route53RecoveryReadiness::ReadinessCheck.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Route53RecoveryReadiness-ReadinessCheck", "type": "AWS::Route53RecoveryReadiness::ReadinessCheck", - "time": "2024-01-02T16:33:07.149Z", + "time": "2024-06-24T15:22:16.606Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Route53RecoveryReadiness::RecoveryGroup.json b/artifacts/types/AWS::Route53RecoveryReadiness::RecoveryGroup.json index 375531ce..d327061c 100644 --- a/artifacts/types/AWS::Route53RecoveryReadiness::RecoveryGroup.json +++ b/artifacts/types/AWS::Route53RecoveryReadiness::RecoveryGroup.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Route53RecoveryReadiness-RecoveryGroup", "type": "AWS::Route53RecoveryReadiness::RecoveryGroup", - "time": "2024-01-02T16:33:29.464Z", + "time": "2024-06-24T15:22:17.44Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Route53RecoveryReadiness::ResourceSet.json b/artifacts/types/AWS::Route53RecoveryReadiness::ResourceSet.json index fd8379e1..8a154931 100644 --- a/artifacts/types/AWS::Route53RecoveryReadiness::ResourceSet.json +++ b/artifacts/types/AWS::Route53RecoveryReadiness::ResourceSet.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Route53RecoveryReadiness-ResourceSet", "type": "AWS::Route53RecoveryReadiness::ResourceSet", - "time": "2024-01-02T16:41:45.297Z", + "time": "2024-06-24T15:28:15.909Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Route53Resolver::FirewallDomainList.json b/artifacts/types/AWS::Route53Resolver::FirewallDomainList.json index de9676c4..08debfc5 100644 --- a/artifacts/types/AWS::Route53Resolver::FirewallDomainList.json +++ b/artifacts/types/AWS::Route53Resolver::FirewallDomainList.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Route53Resolver-FirewallDomainList", "type": "AWS::Route53Resolver::FirewallDomainList", - "time": "2023-12-16T03:37:54.832Z", + "time": "2024-05-02T14:37:19.075Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Route53Resolver::FirewallRuleGroup.json b/artifacts/types/AWS::Route53Resolver::FirewallRuleGroup.json index 6c752f29..a95ffdb4 100644 --- a/artifacts/types/AWS::Route53Resolver::FirewallRuleGroup.json +++ b/artifacts/types/AWS::Route53Resolver::FirewallRuleGroup.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Route53Resolver-FirewallRuleGroup", "type": "AWS::Route53Resolver::FirewallRuleGroup", - "time": "2023-12-16T03:38:46.454Z", + "time": "2024-05-02T14:37:00.433Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -55,9 +55,23 @@ "minLength": 1, "type": "string" }, + "FirewallDomainRedirectionAction": { + "description": "FirewallDomainRedirectionAction", + "enum": [ + "INSPECT_REDIRECTION_DOMAIN", + "TRUST_REDIRECTION_DOMAIN" + ], + "type": "string" + }, "Priority": { "description": "Rule Priority", "type": "integer" + }, + "Qtype": { + "description": "Qtype", + "maxLength": 16, + "minLength": 1, + "type": "string" } }, "required": [ diff --git a/artifacts/types/AWS::Route53Resolver::FirewallRuleGroupAssociation.json b/artifacts/types/AWS::Route53Resolver::FirewallRuleGroupAssociation.json index 8c7807ed..d9f041eb 100644 --- a/artifacts/types/AWS::Route53Resolver::FirewallRuleGroupAssociation.json +++ b/artifacts/types/AWS::Route53Resolver::FirewallRuleGroupAssociation.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Route53Resolver-FirewallRuleGroupAssociation", "type": "AWS::Route53Resolver::FirewallRuleGroupAssociation", - "time": "2023-12-18T13:47:32.975Z", + "time": "2024-05-02T15:01:44.026Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Route53Resolver::ResolverRule.json b/artifacts/types/AWS::Route53Resolver::ResolverRule.json index 1d764760..8c6daa70 100644 --- a/artifacts/types/AWS::Route53Resolver::ResolverRule.json +++ b/artifacts/types/AWS::Route53Resolver::ResolverRule.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Route53Resolver-ResolverRule", "type": "AWS::Route53Resolver::ResolverRule", - "time": "2023-12-07T18:03:40.273Z", + "time": "2024-04-30T18:42:27.679Z", "schema": { "additionalProperties": false, "conditionalCreateOnlyProperties": [ diff --git a/artifacts/types/AWS::S3::AccessGrant.json b/artifacts/types/AWS::S3::AccessGrant.json index a8d7f3c2..4a3eaf58 100644 --- a/artifacts/types/AWS::S3::AccessGrant.json +++ b/artifacts/types/AWS::S3::AccessGrant.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-S3-AccessGrant", "type": "AWS::S3::AccessGrant", - "time": "2023-12-13T17:12:19.455Z", + "time": "2024-03-25T16:10:23.477Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::S3::AccessGrantsInstance.json b/artifacts/types/AWS::S3::AccessGrantsInstance.json index 6c919060..7b3e13d2 100644 --- a/artifacts/types/AWS::S3::AccessGrantsInstance.json +++ b/artifacts/types/AWS::S3::AccessGrantsInstance.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-S3-AccessGrantsInstance", "type": "AWS::S3::AccessGrantsInstance", - "time": "2023-12-13T17:10:01.088Z", + "time": "2024-03-25T16:07:50.303Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::S3::AccessGrantsLocation.json b/artifacts/types/AWS::S3::AccessGrantsLocation.json index 4060c44e..9108f7f8 100644 --- a/artifacts/types/AWS::S3::AccessGrantsLocation.json +++ b/artifacts/types/AWS::S3::AccessGrantsLocation.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-S3-AccessGrantsLocation", "type": "AWS::S3::AccessGrantsLocation", - "time": "2023-12-13T17:11:34.109Z", + "time": "2024-03-25T16:09:31.836Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::S3::AccessPoint.json b/artifacts/types/AWS::S3::AccessPoint.json index 38a6f501..fb484634 100644 --- a/artifacts/types/AWS::S3::AccessPoint.json +++ b/artifacts/types/AWS::S3::AccessPoint.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-S3-AccessPoint", "type": "AWS::S3::AccessPoint", - "time": "2023-06-28T15:03:30.551Z", + "time": "2024-03-06T16:31:05.689Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -79,7 +79,9 @@ "permissions": [ "s3:PutAccessPointPolicy", "s3:PutAccessPointPublicAccessBlock", - "s3:DeleteAccessPointPolicy" + "s3:DeleteAccessPointPolicy", + "s3:GetAccessPoint", + "s3:GetAccessPointPolicy" ] } }, diff --git a/artifacts/types/AWS::S3::Bucket.json b/artifacts/types/AWS::S3::Bucket.json index 5ea98077..66cd8a48 100644 --- a/artifacts/types/AWS::S3::Bucket.json +++ b/artifacts/types/AWS::S3::Bucket.json @@ -1,20 +1,19 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-S3-Bucket", "type": "AWS::S3::Bucket", - "time": "2023-12-15T19:31:40.44Z", + "time": "2024-04-27T12:45:45.107Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ - "/properties/BucketName", - "/properties/ObjectLockEnabled" + "/properties/BucketName" ], "definitions": { "AbortIncompleteMultipartUpload": { "additionalProperties": false, - "description": "Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 will wait before permanently removing all parts of the upload.", + "description": "Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 will wait before permanently removing all parts of the upload. For more information, see [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 *Amazon S3 User Guide*.", "properties": { "DaysAfterInitiation": { - "description": "Specifies the number of days after which Amazon S3 aborts an incomplete multipart upload.", + "description": "Specifies the number of days after which Amazon S3 stops an incomplete multipart upload.", "minimum": 0, "type": "integer" } @@ -26,9 +25,10 @@ }, "AccelerateConfiguration": { "additionalProperties": false, + "description": "Configures the transfer acceleration state for an Amazon S3 bucket. For more information, see [Amazon S3 Transfer Acceleration](https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html) in the *Amazon S3 User Guide*.", "properties": { "AccelerationStatus": { - "description": "Configures the transfer acceleration state for an Amazon S3 bucket.", + "description": "Specifies the transfer acceleration status of the bucket.", "enum": [ "Enabled", "Suspended" @@ -43,10 +43,11 @@ }, "AccessControlTranslation": { "additionalProperties": false, - "description": "Specify this only in a cross-account scenario (where source and destination bucket owners are not the same), and you want to change replica ownership to the AWS account that owns the destination bucket. If this is not specified in the replication configuration, the replicas are owned by same AWS account that owns the source object.", + "description": "Specify this only in a cross-account scenario (where source and destination bucket owners are not the same), and you want to change replica ownership to the AWS-account that owns the destination bucket. If this is not specified in the replication configuration, the replicas are owned by same AWS-account that owns the source object.", "properties": { "Owner": { "const": "Destination", + "description": "Specifies the replica ownership. For default and valid values, see [PUT bucket replication](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTreplication.html) in the *Amazon S3 API Reference*.", "type": "string" } }, @@ -68,9 +69,11 @@ "type": "string" }, "StorageClassAnalysis": { - "$ref": "#/definitions/StorageClassAnalysis" + "$ref": "#/definitions/StorageClassAnalysis", + "description": "Contains data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes." }, "TagFilters": { + "description": "The tags to use when evaluating an analytics filter.\n The analytics only includes objects that meet the filter's criteria. If no filter is specified, all of the contents of the bucket are included in the analysis.", "insertionOrder": true, "items": { "$ref": "#/definitions/TagFilter" @@ -91,7 +94,7 @@ }, "BucketEncryption": { "additionalProperties": false, - "description": "Specifies default encryption for a bucket using server-side encryption with either Amazon S3-managed keys (SSE-S3) or AWS KMS-managed keys (SSE-KMS).", + "description": "Specifies default encryption for a bucket using server-side encryption with Amazon S3-managed keys (SSE-S3), AWS KMS-managed keys (SSE-KMS), or dual-layer server-side encryption with KMS-managed keys (DSSE-KMS). For information about the Amazon S3 default encryption feature, see [Amazon S3 Default Encryption for S3 Buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html) in the *Amazon S3 User Guide*.", "properties": { "ServerSideEncryptionConfiguration": { "description": "Specifies the default server-side-encryption configuration.", @@ -110,8 +113,10 @@ }, "CorsConfiguration": { "additionalProperties": false, + "description": "Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see [Enabling Cross-Origin Resource Sharing](https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) in the *Amazon S3 User Guide*.", "properties": { "CorsRules": { + "description": "A set of origins and methods (cross-origin access that you want to allow). You can add up to 100 rules to the configuration.", "insertionOrder": true, "items": { "$ref": "#/definitions/CorsRule", @@ -128,10 +133,10 @@ }, "CorsRule": { "additionalProperties": false, - "description": "A set of origins and methods (cross-origin access that you want to allow). You can add up to 100 rules to the configuration.", + "description": "Specifies a cross-origin access rule for an Amazon S3 bucket.", "properties": { "AllowedHeaders": { - "description": "Headers that are specified in the Access-Control-Request-Headers header.", + "description": "Headers that are specified in the ``Access-Control-Request-Headers`` header. These headers are allowed in a preflight OPTIONS request. In response to any preflight OPTIONS request, Amazon S3 returns any requested headers that are allowed.", "insertionOrder": true, "items": { "type": "string" @@ -140,7 +145,7 @@ "uniqueItems": true }, "AllowedMethods": { - "description": "An HTTP method that you allow the origin to execute.", + "description": "An HTTP method that you allow the origin to run.\n *Allowed values*: ``GET`` | ``PUT`` | ``HEAD`` | ``POST`` | ``DELETE``", "insertionOrder": true, "items": { "enum": [ @@ -165,7 +170,7 @@ "uniqueItems": true }, "ExposedHeaders": { - "description": "One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object).", + "description": "One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript ``XMLHttpRequest`` object).", "insertionOrder": true, "items": { "type": "string" @@ -174,7 +179,7 @@ "uniqueItems": true }, "Id": { - "description": "A unique identifier for this rule.", + "description": "A unique identifier for this rule. The value must be no more than 255 characters.", "maxLength": 255, "type": "string" }, @@ -195,11 +200,12 @@ "description": "Specifies how data related to the storage class analysis for an Amazon S3 bucket should be exported.", "properties": { "Destination": { - "$ref": "#/definitions/Destination" + "$ref": "#/definitions/Destination", + "description": "The place to store the data for an analysis." }, "OutputSchemaVersion": { "const": "V_1", - "description": "The version of the output schema to use when exporting data.", + "description": "The version of the output schema to use when exporting data. Must be ``V_1``.", "type": "string" } }, @@ -211,12 +217,14 @@ }, "DefaultRetention": { "additionalProperties": false, - "description": "The default retention period that you want to apply to new objects placed in the specified bucket.", + "description": "The container element for specifying the default Object Lock retention settings for new objects placed in the specified bucket.\n + The ``DefaultRetention`` settings require both a mode and a period.\n + The ``DefaultRetention`` period can be either ``Days`` or ``Years`` but you must select one. You cannot specify ``Days`` and ``Years`` at the same time.", "properties": { "Days": { + "description": "The number of days that you want to specify for the default retention period. If Object Lock is turned on, you must specify ``Mode`` and specify either ``Days`` or ``Years``.", "type": "integer" }, "Mode": { + "description": "The default Object Lock retention mode you want to apply to new objects placed in the specified bucket. If Object Lock is turned on, you must specify ``Mode`` and specify either ``Days`` or ``Years``.", "enum": [ "COMPLIANCE", "GOVERNANCE" @@ -224,6 +232,7 @@ "type": "string" }, "Years": { + "description": "The number of years that you want to specify for the default retention period. If Object Lock is turned on, you must specify ``Mode`` and specify either ``Days`` or ``Years``.", "type": "integer" } }, @@ -231,8 +240,10 @@ }, "DeleteMarkerReplication": { "additionalProperties": false, + "description": "Specifies whether Amazon S3 replicates delete markers. If you specify a ``Filter`` in your replication configuration, you must also include a ``DeleteMarkerReplication`` element. If your ``Filter`` includes a ``Tag`` element, the ``DeleteMarkerReplication`` ``Status`` must be set to Disabled, because Amazon S3 does not support replicating delete markers for tag-based rules. For an example configuration, see [Basic Rule Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-config-min-rule-config). \n For more information about delete marker replication, see [Basic Rule Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/delete-marker-replication.html). \n If you are using an earlier version of the replication configuration, Amazon S3 handles replication of delete markers differently. For more information, see [Backward Compatibility](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations).", "properties": { "Status": { + "description": "Indicates whether to replicate delete markers. Disabled by default.", "enum": [ "Disabled", "Enabled" @@ -244,10 +255,10 @@ }, "Destination": { "additionalProperties": false, - "description": "Specifies information about where to publish analysis or configuration results for an Amazon S3 bucket and S3 Replication Time Control (S3 RTC).", + "description": "Specifies information about where to publish analysis or configuration results for an Amazon S3 bucket.", "properties": { "BucketAccountId": { - "description": "The account ID that owns the destination S3 bucket. ", + "description": "The account ID that owns the destination S3 bucket. If no account ID is provided, the owner is not validated before exporting data.\n Although this value is optional, we strongly recommend that you set it to help prevent problems if the destination bucket ownership changes.", "type": "string" }, "BucketArn": { @@ -255,7 +266,7 @@ "type": "string" }, "Format": { - "description": "Specifies the file format used when exporting data to Amazon S3.", + "description": "Specifies the file format used when exporting data to Amazon S3.\n *Allowed values*: ``CSV`` | ``ORC`` | ``Parquet``", "enum": [ "CSV", "ORC", @@ -279,7 +290,7 @@ "description": "Specifies encryption-related information for an Amazon S3 bucket that is a destination for replicated objects.", "properties": { "ReplicaKmsKeyID": { - "description": "Specifies the ID (Key ARN or Alias ARN) of the customer managed customer master key (CMK) stored in AWS Key Management Service (KMS) for the destination bucket.", + "description": "Specifies the ID (Key ARN or Alias ARN) of the customer managed AWS KMS key stored in AWS Key Management Service (KMS) for the destination bucket. Amazon S3 uses this key to encrypt replica objects. Amazon S3 only supports symmetric encryption KMS keys. For more information, see [Asymmetric keys in KMS](https://docs.aws.amazon.com//kms/latest/developerguide/symmetric-asymmetric.html) in the *Key Management Service Developer Guide*.", "type": "string" } }, @@ -290,11 +301,11 @@ }, "EventBridgeConfiguration": { "additionalProperties": false, - "description": "Describes the Amazon EventBridge notification configuration for an Amazon S3 bucket.", + "description": "Amazon S3 can send events to Amazon EventBridge whenever certain events happen in your bucket, see [Using EventBridge](https://docs.aws.amazon.com/AmazonS3/latest/userguide/EventBridge.html) in the *Amazon S3 User Guide*.\n Unlike other destinations, delivery of events to EventBridge can be either enabled or disabled for a bucket. If enabled, all events will be sent to EventBridge and you can use EventBridge rules to route events to additional targets. For more information, see [What Is Amazon EventBridge](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-what-is.html) in the *Amazon EventBridge User Guide*", "properties": { "EventBridgeEnabled": { "default": "true", - "description": "Specifies whether to send notifications to Amazon EventBridge when events occur in an Amazon S3 bucket.", + "description": "Enables delivery of events to Amazon EventBridge.", "type": "boolean" } }, @@ -305,13 +316,15 @@ }, "FilterRule": { "additionalProperties": false, - "description": "Specifies the Amazon S3 object key name to filter on and whether to filter on the suffix or prefix of the key name.", + "description": "Specifies the Amazon S3 object key name to filter on. An object key name is the name assigned to an object in your Amazon S3 bucket. You specify whether to filter on the suffix or prefix of the object key name. A prefix is a specific string of characters at the beginning of an object key name, which you can use to organize objects. For example, you can start the key names of related objects with a prefix, such as ``2023-`` or ``engineering/``. Then, you can use ``FilterRule`` to find objects in a bucket with key names that have the same prefix. A suffix is similar to a prefix, but it is at the end of the object key name instead of at the beginning.", "properties": { "Name": { + "description": "The object key name prefix or suffix identifying one or more objects to which the filtering rule applies. The maximum length is 1,024 characters. Overlapping prefixes and suffixes are not supported. For more information, see [Configuring Event Notifications](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the *Amazon S3 User Guide*.", "maxLength": 1024, "type": "string" }, "Value": { + "description": "The value that the filter searches for in object key names.", "type": "string" } }, @@ -323,6 +336,7 @@ }, "IntelligentTieringConfiguration": { "additionalProperties": false, + "description": "Specifies the S3 Intelligent-Tiering configuration for an Amazon S3 bucket.\n For information about the S3 Intelligent-Tiering storage class, see [Storage class for automatically optimizing frequently and infrequently accessed objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access).", "properties": { "Id": { "description": "The ID used to identify the S3 Intelligent-Tiering configuration.", @@ -350,7 +364,7 @@ "uniqueItems": true }, "Tierings": { - "description": "Specifies a list of S3 Intelligent-Tiering storage class tiers in the configuration. At least one tier must be defined in the list. At most, you can specify two tiers in the list, one for each available AccessTier: ARCHIVE_ACCESS and DEEP_ARCHIVE_ACCESS.", + "description": "Specifies a list of S3 Intelligent-Tiering storage class tiers in the configuration. At least one tier must be defined in the list. At most, you can specify two tiers in the list, one for each available AccessTier: ``ARCHIVE_ACCESS`` and ``DEEP_ARCHIVE_ACCESS``.\n You only need Intelligent Tiering Configuration enabled on a bucket if you want to automatically move objects stored in the Intelligent-Tiering storage class to Archive Access or Deep Archive Access tiers.", "insertionOrder": true, "items": { "$ref": "#/definitions/Tiering" @@ -368,12 +382,14 @@ }, "InventoryConfiguration": { "additionalProperties": false, + "description": "Specifies the inventory configuration for an Amazon S3 bucket. For more information, see [GET Bucket inventory](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETInventoryConfig.html) in the *Amazon S3 API Reference*.", "properties": { "Destination": { - "$ref": "#/definitions/Destination" + "$ref": "#/definitions/Destination", + "description": "Contains information about where to publish the inventory results." }, "Enabled": { - "description": "Specifies whether the inventory is enabled or disabled.", + "description": "Specifies whether the inventory is enabled or disabled. If set to ``True``, an inventory list is generated. If set to ``False``, no inventory list is generated.", "type": "boolean" }, "Id": { @@ -381,7 +397,7 @@ "type": "string" }, "IncludedObjectVersions": { - "description": "Object versions to include in the inventory list.", + "description": "Object versions to include in the inventory list. If set to ``All``, the list includes all the object versions, which adds the version-related fields ``VersionId``, ``IsLatest``, and ``DeleteMarker`` to the list. If set to ``Current``, the list does not contain these version-related fields.", "enum": [ "All", "Current" @@ -415,7 +431,7 @@ "uniqueItems": true }, "Prefix": { - "description": "The prefix that is prepended to all inventory results.", + "description": "Specifies the inventory filter prefix.", "type": "string" }, "ScheduleFrequency": { @@ -438,18 +454,18 @@ }, "LambdaConfiguration": { "additionalProperties": false, - "description": "Describes the AWS Lambda functions to invoke and the events for which to invoke them.", + "description": "Describes the LAMlong functions to invoke and the events for which to invoke them.", "properties": { "Event": { - "description": "The Amazon S3 bucket event for which to invoke the AWS Lambda function.", + "description": "The Amazon S3 bucket event for which to invoke the LAMlong function. For more information, see [Supported Event Types](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the *Amazon S3 User Guide*.", "type": "string" }, "Filter": { "$ref": "#/definitions/NotificationFilter", - "description": "The filtering rules that determine which objects invoke the AWS Lambda function." + "description": "The filtering rules that determine which objects invoke the AWS Lambda function. For example, you can create a filter so that only image files with a ``.jpg`` extension invoke the function when they are added to the Amazon S3 bucket." }, "Function": { - "description": "The Amazon Resource Name (ARN) of the AWS Lambda function that Amazon S3 invokes when the specified event type occurs.", + "description": "The Amazon Resource Name (ARN) of the LAMlong function that Amazon S3 invokes when the specified event type occurs.", "type": "string" } }, @@ -461,6 +477,7 @@ }, "LifecycleConfiguration": { "additionalProperties": false, + "description": "Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more information, see [Object Lifecycle Management](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) in the *Amazon S3 User Guide*.", "properties": { "Rules": { "description": "A lifecycle rule for individual objects in an Amazon S3 bucket.", @@ -479,27 +496,33 @@ }, "LoggingConfiguration": { "additionalProperties": false, + "description": "Describes where logs are stored and the prefix that Amazon S3 assigns to all log object keys for a bucket. For examples and more information, see [PUT Bucket logging](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlogging.html) in the *Amazon S3 API Reference*.\n To successfully complete the ``AWS::S3::Bucket LoggingConfiguration`` request, you must have ``s3:PutObject`` and ``s3:PutObjectAcl`` in your IAM permissions.", "properties": { "DestinationBucketName": { - "description": "The name of an Amazon S3 bucket where Amazon S3 store server access log files. You can store log files in any bucket that you own. By default, logs are stored in the bucket where the LoggingConfiguration property is defined.", + "description": "The name of the bucket where Amazon S3 should store server access log files. You can store log files in any bucket that you own. By default, logs are stored in the bucket where the ``LoggingConfiguration`` property is defined.", "type": "string" }, "LogFilePrefix": { + "description": "A prefix for all log object keys. If you store log files from multiple Amazon S3 buckets in a single bucket, you can use a prefix to distinguish which log files came from which bucket.", "type": "string" }, "TargetObjectKeyFormat": { - "$ref": "#/definitions/TargetObjectKeyFormat" + "$ref": "#/definitions/TargetObjectKeyFormat", + "description": "Amazon S3 key format for log objects. Only one format, either PartitionedPrefix or SimplePrefix, is allowed." } }, "type": "object" }, "Metrics": { "additionalProperties": false, + "description": "A container specifying replication metrics-related settings enabling replication metrics and events.", "properties": { "EventThreshold": { - "$ref": "#/definitions/ReplicationTimeValue" + "$ref": "#/definitions/ReplicationTimeValue", + "description": "A container specifying the time threshold for emitting the ``s3:Replication:OperationMissedThreshold`` event." }, "Status": { + "description": "Specifies whether the replication metrics are enabled.", "enum": [ "Disabled", "Enabled" @@ -514,17 +537,22 @@ }, "MetricsConfiguration": { "additionalProperties": false, + "description": "Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you 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) in the *Amazon S3 API Reference*.", "properties": { "AccessPointArn": { + "description": "The access point that was used while performing operations on the object. The metrics configuration only includes objects that meet the filter's criteria.", "type": "string" }, "Id": { + "description": "The ID used to identify the metrics configuration. This can be any value you choose that helps you identify your metrics configuration.", "type": "string" }, "Prefix": { + "description": "The prefix that an object must have to be included in the metrics results.", "type": "string" }, "TagFilters": { + "description": "Specifies a list of tag filters to use as a metrics configuration filter. The metrics configuration includes only objects that meet the filter's criteria.", "insertionOrder": true, "items": { "$ref": "#/definitions/TagFilter" @@ -540,14 +568,14 @@ }, "NoncurrentVersionExpiration": { "additionalProperties": false, - "description": "Container for the expiration rule that describes when noncurrent objects are expired. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 expire noncurrent object versions at a specific period in the object's lifetime", + "description": "Specifies when noncurrent object versions expire. Upon expiration, S3 permanently deletes the noncurrent object versions. You set this lifecycle configuration action on a bucket that has versioning enabled (or suspended) to request that S3 delete noncurrent object versions at a specific period in the object's lifetime. 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).", "properties": { "NewerNoncurrentVersions": { - "description": "Specified the number of newer noncurrent and current versions that must exists before performing the associated action", + "description": "Specifies how many noncurrent versions S3 will retain. If there are this many more recent noncurrent versions, S3 will take the associated action. For more information about noncurrent versions, see [Lifecycle configuration elements](https://docs.aws.amazon.com/AmazonS3/latest/userguide/intro-lifecycle-rules.html) in the *Amazon S3 User Guide*.", "type": "integer" }, "NoncurrentDays": { - "description": "Specified the number of days an object is noncurrent before Amazon S3 can perform the associated action", + "description": "Specifies the number of days an object is noncurrent before S3 can perform the associated action. For information about the noncurrent days calculations, see [How Amazon 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 User Guide*.", "type": "integer" } }, @@ -558,10 +586,10 @@ }, "NoncurrentVersionTransition": { "additionalProperties": false, - "description": "Container for the transition rule that describes when noncurrent objects transition to the STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER_IR, GLACIER, or DEEP_ARCHIVE storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to the STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER_IR, GLACIER, or DEEP_ARCHIVE storage class at a specific period in the object's lifetime.", + "description": "Container for the transition rule that describes when noncurrent objects transition to the ``STANDARD_IA``, ``ONEZONE_IA``, ``INTELLIGENT_TIERING``, ``GLACIER_IR``, ``GLACIER``, or ``DEEP_ARCHIVE`` storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to the ``STANDARD_IA``, ``ONEZONE_IA``, ``INTELLIGENT_TIERING``, ``GLACIER_IR``, ``GLACIER``, or ``DEEP_ARCHIVE`` storage class at a specific period in the object's lifetime. If you specify this property, don't specify the ``NoncurrentVersionTransitions`` property.", "properties": { "NewerNoncurrentVersions": { - "description": "Specified the number of newer noncurrent and current versions that must exists before performing the associated action", + "description": "Specifies how many noncurrent versions S3 will retain. If there are this many more recent noncurrent versions, S3 will take the associated action. For more information about noncurrent versions, see [Lifecycle configuration elements](https://docs.aws.amazon.com/AmazonS3/latest/userguide/intro-lifecycle-rules.html) in the *Amazon S3 User Guide*.", "type": "integer" }, "StorageClass": { @@ -578,7 +606,7 @@ "type": "string" }, "TransitionInDays": { - "description": "Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action.", + "description": "Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see [How Amazon S3 Calculates How 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*.", "type": "integer" } }, @@ -590,12 +618,14 @@ }, "NotificationConfiguration": { "additionalProperties": false, - "description": "Describes the notification configuration for an Amazon S3 bucket.", + "description": "Describes the notification configuration for an Amazon S3 bucket.\n If you create the target resource and related permissions in the same template, you might have a circular dependency.\n For example, you might use the ``AWS::Lambda::Permission`` resource to grant the bucket permission to invoke an AWS Lambda function. However, AWS CloudFormation can't create the bucket until the bucket has permission to invoke the function (AWS CloudFormation checks whether the bucket can invoke the function). If you're using Refs to pass the bucket name, this leads to a circular dependency.\n To avoid this dependency, you can create all resources without specifying the notification configuration. Then, update the stack with a notification configuration.\n For 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 Destination](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html#grant-destinations-permissions-to-s3).", "properties": { "EventBridgeConfiguration": { - "$ref": "#/definitions/EventBridgeConfiguration" + "$ref": "#/definitions/EventBridgeConfiguration", + "description": "Enables delivery of events to Amazon EventBridge." }, "LambdaConfigurations": { + "description": "Describes the LAMlong functions to invoke and the events for which to invoke them.", "insertionOrder": true, "items": { "$ref": "#/definitions/LambdaConfiguration" @@ -604,6 +634,7 @@ "uniqueItems": true }, "QueueConfigurations": { + "description": "The Amazon Simple Queue Service queues to publish messages to and the events for which to publish messages.", "insertionOrder": true, "items": { "$ref": "#/definitions/QueueConfiguration" @@ -612,6 +643,7 @@ "uniqueItems": true }, "TopicConfigurations": { + "description": "The topic to which notifications are sent and the events for which notifications are generated.", "insertionOrder": true, "items": { "$ref": "#/definitions/TopicConfiguration" @@ -624,10 +656,11 @@ }, "NotificationFilter": { "additionalProperties": false, - "description": "Specifies object key name filtering rules.", + "description": "Specifies object key name filtering rules. For information about key name filtering, see [Configuring event notifications using object key name filtering](https://docs.aws.amazon.com/AmazonS3/latest/userguide/notification-how-to-filtering.html) in the *Amazon S3 User Guide*.", "properties": { "S3Key": { - "$ref": "#/definitions/S3KeyFilter" + "$ref": "#/definitions/S3KeyFilter", + "description": "A container for object key name prefix and suffix filtering rules." } }, "required": [ @@ -637,31 +670,37 @@ }, "ObjectLockConfiguration": { "additionalProperties": false, + "description": "Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see [Locking Objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html).", "properties": { "ObjectLockEnabled": { "const": "Enabled", + "description": "Indicates whether this bucket has an Object Lock configuration enabled. Enable ``ObjectLockEnabled`` when you apply ``ObjectLockConfiguration`` to a bucket.", "type": "string" }, "Rule": { - "$ref": "#/definitions/ObjectLockRule" + "$ref": "#/definitions/ObjectLockRule", + "description": "Specifies the Object Lock rule for the specified object. Enable this rule when you apply ``ObjectLockConfiguration`` to a bucket. If Object Lock is turned on, bucket settings require both ``Mode`` and a period of either ``Days`` or ``Years``. You cannot specify ``Days`` and ``Years`` at the same time. For more information, see [ObjectLockRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-objectlockrule.html) and [DefaultRetention](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-defaultretention.html)." } }, "type": "object" }, "ObjectLockRule": { "additionalProperties": false, - "description": "The Object Lock rule in place for the specified object.", + "description": "Specifies the Object Lock rule for the specified object. Enable the this rule when you apply ``ObjectLockConfiguration`` to a bucket.", "properties": { "DefaultRetention": { - "$ref": "#/definitions/DefaultRetention" + "$ref": "#/definitions/DefaultRetention", + "description": "The default Object Lock retention mode and period that you want to apply to new objects placed in the specified bucket. If Object Lock is turned on, bucket settings require both ``Mode`` and a period of either ``Days`` or ``Years``. You cannot specify ``Days`` and ``Years`` at the same time. For more information about allowable values for mode and period, see [DefaultRetention](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-defaultretention.html)." } }, "type": "object" }, "OwnershipControls": { "additionalProperties": false, + "description": "Specifies the container element for Object Ownership rules.\n S3 Object Ownership is an Amazon S3 bucket-level setting that you can use to disable access control lists (ACLs) and take ownership of every object in your bucket, simplifying access management for data stored in Amazon S3. For more information, see [Controlling ownership of objects and disabling ACLs](https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html) in the *Amazon S3 User Guide*.", "properties": { "Rules": { + "description": "Specifies the container element for Object Ownership rules.", "insertionOrder": true, "items": { "$ref": "#/definitions/OwnershipControlsRule" @@ -677,6 +716,7 @@ }, "OwnershipControlsRule": { "additionalProperties": false, + "description": "Specifies an Object Ownership rule.\n S3 Object Ownership is an Amazon S3 bucket-level setting that you can use to disable access control lists (ACLs) and take ownership of every object in your bucket, simplifying access management for data stored in Amazon S3. For more information, see [Controlling ownership of objects and disabling ACLs](https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html) in the *Amazon S3 User Guide*.", "properties": { "ObjectOwnership": { "description": "Specifies an object ownership rule.", @@ -692,10 +732,10 @@ }, "PartitionedPrefix": { "additionalProperties": false, - "description": "This format appends a time based prefix to the given log file prefix for delivering server access log file.", + "description": "Amazon 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]`` \n PartitionedPrefix defaults to EventTime delivery when server access logs are delivered.", "properties": { "PartitionDateSource": { - "description": "Date Source for creating a partitioned prefix. This can be event time or delivery time.", + "description": "Specifies the partition date source for the partitioned prefix. PartitionDateSource can be EventTime or DeliveryTime.", "enum": [ "EventTime", "DeliveryTime" @@ -707,22 +747,22 @@ }, "PublicAccessBlockConfiguration": { "additionalProperties": false, - "description": "Configuration that defines how Amazon S3 handles public access.", + "description": "The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see [The Meaning of \"Public\"](https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status) in the *Amazon S3 User Guide*.", "properties": { "BlockPublicAcls": { - "description": "Specifies whether Amazon S3 should block public access control lists (ACLs) for this bucket and objects in this bucket. Setting this element to TRUE causes the following behavior:\n- PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public.\n - PUT Object calls fail if the request includes a public ACL.\nEnabling this setting doesn't affect existing policies or ACLs.", + "description": "Specifies whether Amazon S3 should block public access control lists (ACLs) for this bucket and objects in this bucket. Setting this element to ``TRUE`` causes the following behavior:\n + PUT Bucket ACL and PUT Object ACL calls fail if the specified ACL is public.\n + PUT Object calls fail if the request includes a public ACL.\n + PUT Bucket calls fail if the request includes a public ACL.\n \n Enabling this setting doesn't affect existing policies or ACLs.", "type": "boolean" }, "BlockPublicPolicy": { - "description": "Specifies whether Amazon S3 should block public bucket policies for this bucket. Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access.\nEnabling this setting doesn't affect existing bucket policies.", + "description": "Specifies whether Amazon S3 should block public bucket policies for this bucket. Setting this element to ``TRUE`` causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access. \n Enabling this setting doesn't affect existing bucket policies.", "type": "boolean" }, "IgnorePublicAcls": { - "description": "Specifies whether Amazon S3 should ignore public ACLs for this bucket and objects in this bucket. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on this bucket and objects in this bucket.\nEnabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.", + "description": "Specifies whether Amazon S3 should ignore public ACLs for this bucket and objects in this bucket. Setting this element to ``TRUE`` causes Amazon S3 to ignore all public ACLs on this bucket and objects in this bucket.\n Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.", "type": "boolean" }, "RestrictPublicBuckets": { - "description": "Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting this element to TRUE restricts access to this bucket to only AWS services and authorized 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 cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked.", + "description": "Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting this element to ``TRUE`` restricts access to this bucket to only AWS-service principals and authorized users within this account if the bucket has a public policy.\n Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked.", "type": "boolean" } }, @@ -730,18 +770,18 @@ }, "QueueConfiguration": { "additionalProperties": false, - "description": "The Amazon Simple Queue Service queues to publish messages to and the events for which to publish messages.", + "description": "Specifies the configuration for publishing messages to an Amazon Simple Queue Service (Amazon SQS) queue when Amazon S3 detects specified events.", "properties": { "Event": { - "description": "The Amazon S3 bucket event about which you want to publish messages to Amazon SQS.", + "description": "The Amazon S3 bucket event about which you want to publish messages to Amazon SQS. For more information, see [Supported Event Types](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the *Amazon S3 User Guide*.", "type": "string" }, "Filter": { "$ref": "#/definitions/NotificationFilter", - "description": "The filtering rules that determine which objects trigger notifications." + "description": "The filtering rules that determine which objects trigger notifications. For example, you can create a filter so that Amazon S3 sends notifications only when image files with a ``.jpg`` extension are added to the bucket. For more information, see [Configuring event notifications using object key name filtering](https://docs.aws.amazon.com/AmazonS3/latest/user-guide/notification-how-to-filtering.html) in the *Amazon S3 User Guide*." }, "Queue": { - "description": "The Amazon Resource Name (ARN) of the Amazon SQS queue to which Amazon S3 publishes a message when it detects events of the specified type.", + "description": "The Amazon Resource Name (ARN) of the Amazon SQS queue to which Amazon S3 publishes a message when it detects events of the specified type. FIFO queues are not allowed when enabling an SQS queue as the event notification destination.", "type": "string" } }, @@ -794,11 +834,11 @@ "type": "string" }, "ReplaceKeyPrefixWith": { - "description": "The object key prefix to use in the redirect request.", + "description": "The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix ``docs/`` (objects in the ``docs/`` folder) to ``documents/``, you can set a condition block with ``KeyPrefixEquals`` set to ``docs/`` and in the Redirect set ``ReplaceKeyPrefixWith`` to ``/documents``. Not required if one of the siblings is present. Can be present only if ``ReplaceKeyWith`` is not provided.\n Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).", "type": "string" }, "ReplaceKeyWith": { - "description": "The specific object key to use in the redirect request.d", + "description": "The specific object key to use in the redirect request. For example, redirect request to ``error.html``. Not required if one of the siblings is present. Can be present only if ``ReplaceKeyPrefixWith`` is not provided.\n Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).", "type": "string" } }, @@ -806,9 +846,10 @@ }, "ReplicaModifications": { "additionalProperties": false, + "description": "A filter that you can specify for selection for modifications on replicas.", "properties": { "Status": { - "description": "Specifies whether Amazon S3 replicates modifications on replicas.", + "description": "Specifies whether Amazon S3 replicates modifications on replicas.\n *Allowed values*: ``Enabled`` | ``Disabled``", "enum": [ "Enabled", "Disabled" @@ -823,14 +864,14 @@ }, "ReplicationConfiguration": { "additionalProperties": false, - "description": "A container for replication rules. You can add up to 1,000 rules. The maximum size of a replication configuration is 2 MB.", + "description": "A container for replication rules. You can add up to 1,000 rules. The maximum size of a replication configuration is 2 MB. The latest version of the replication configuration XML is V2. For more information about XML V2 replication configurations, see [Replication configuration](https://docs.aws.amazon.com/AmazonS3/latest/userguide/replication-add-config.html) in the *Amazon S3 User Guide*.", "properties": { "Role": { - "description": "The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that Amazon S3 assumes when replicating objects.", + "description": "The Amazon Resource Name (ARN) of the IAMlong (IAM) role that Amazon S3 assumes when replicating objects. For more information, see [How to Set Up Replication](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-how-setup.html) in the *Amazon S3 User Guide*.", "type": "string" }, "Rules": { - "description": "A container for one or more replication rules.", + "description": "A container for one or more replication rules. A replication configuration must have at least one rule and can contain a maximum of 1,000 rules.", "insertionOrder": true, "items": { "$ref": "#/definitions/ReplicationRule", @@ -849,28 +890,34 @@ }, "ReplicationDestination": { "additionalProperties": false, - "description": "Specifies which Amazon S3 bucket to store replicated objects in and their storage class.", + "description": "A container for information about the replication destination and its configurations including enabling the S3 Replication Time Control (S3 RTC).", "properties": { "AccessControlTranslation": { - "$ref": "#/definitions/AccessControlTranslation" + "$ref": "#/definitions/AccessControlTranslation", + "description": "Specify this only in a cross-account scenario (where source and destination bucket owners are not the same), and you want to change replica ownership to the AWS-account that owns the destination bucket. If this is not specified in the replication configuration, the replicas are owned by same AWS-account that owns the source object." }, "Account": { + "description": "Destination bucket owner account ID. In a cross-account scenario, if you direct Amazon S3 to change replica ownership to the AWS-account that owns the destination bucket by specifying the ``AccessControlTranslation`` property, this is the account ID of the destination bucket owner. For more information, see [Cross-Region Replication Additional Configuration: Change Replica Owner](https://docs.aws.amazon.com/AmazonS3/latest/dev/crr-change-owner.html) in the *Amazon S3 User Guide*.\n If you specify the ``AccessControlTranslation`` property, the ``Account`` property is required.", "type": "string" }, "Bucket": { + "description": "The Amazon Resource Name (ARN) of the bucket where you want Amazon S3 to store the results.", "type": "string" }, "EncryptionConfiguration": { - "$ref": "#/definitions/EncryptionConfiguration" + "$ref": "#/definitions/EncryptionConfiguration", + "description": "Specifies encryption-related information." }, "Metrics": { - "$ref": "#/definitions/Metrics" + "$ref": "#/definitions/Metrics", + "description": "A container specifying replication metrics-related settings enabling replication metrics and events." }, "ReplicationTime": { - "$ref": "#/definitions/ReplicationTime" + "$ref": "#/definitions/ReplicationTime", + "description": "A container specifying S3 Replication Time Control (S3 RTC), including whether S3 RTC is enabled and the time when all objects and operations on objects must be replicated. Must be specified together with a ``Metrics`` block." }, "StorageClass": { - "description": "The storage class to use when replicating objects, such as S3 Standard or reduced redundancy.", + "description": "The storage class to use when replicating objects, such as S3 Standard or reduced redundancy. By default, Amazon S3 uses the storage class of the source object to create the object replica. \n For valid values, see the ``StorageClass`` element of the [PUT Bucket replication](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTreplication.html) action in the *Amazon S3 API Reference*.", "enum": [ "DEEP_ARCHIVE", "GLACIER", @@ -894,29 +941,34 @@ "description": "Specifies which Amazon S3 objects to replicate and where to store the replicas.", "properties": { "DeleteMarkerReplication": { - "$ref": "#/definitions/DeleteMarkerReplication" + "$ref": "#/definitions/DeleteMarkerReplication", + "description": "Specifies whether Amazon S3 replicates delete markers. If you specify a ``Filter`` in your replication configuration, you must also include a ``DeleteMarkerReplication`` element. If your ``Filter`` includes a ``Tag`` element, the ``DeleteMarkerReplication`` ``Status`` must be set to Disabled, because Amazon S3 does not support replicating delete markers for tag-based rules. For an example configuration, see [Basic Rule Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-config-min-rule-config). \n For more information about delete marker replication, see [Basic Rule Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/delete-marker-replication.html). \n If you are using an earlier version of the replication configuration, Amazon S3 handles replication of delete markers differently. For more information, see [Backward Compatibility](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations)." }, "Destination": { - "$ref": "#/definitions/ReplicationDestination" + "$ref": "#/definitions/ReplicationDestination", + "description": "A container for information about the replication destination and its configurations including enabling the S3 Replication Time Control (S3 RTC)." }, "Filter": { - "$ref": "#/definitions/ReplicationRuleFilter" + "$ref": "#/definitions/ReplicationRuleFilter", + "description": "A filter that identifies the subset of objects to which the replication rule applies. A ``Filter`` must specify exactly one ``Prefix``, ``TagFilter``, or an ``And`` child element. The use of the filter field indicates that this is a V2 replication configuration. This field isn't supported in a V1 replication configuration.\n V1 replication configuration only supports filtering by key prefix. To filter using a V1 replication configuration, add the ``Prefix`` directly as a child element of the ``Rule`` element." }, "Id": { - "description": "A unique identifier for the rule.", + "description": "A unique identifier for the rule. The maximum value is 255 characters. If you don't specify a value, AWS CloudFormation generates a random ID. When using a V2 replication configuration this property is capitalized as \"ID\".", "maxLength": 255, "type": "string" }, "Prefix": { - "description": "An object key name prefix that identifies the object or objects to which the rule applies.", + "description": "An object key name prefix that identifies the object or objects to which the rule applies. The maximum prefix length is 1,024 characters. To include all objects in a bucket, specify an empty string. To filter using a V1 replication configuration, add the ``Prefix`` directly as a child element of the ``Rule`` element.\n Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).", "maxLength": 1024, "type": "string" }, "Priority": { + "description": "The priority indicates which rule has precedence whenever two or more replication rules conflict. Amazon S3 will attempt to replicate objects according to all replication rules. However, if there are two or more rules with the same destination bucket, then objects will be replicated according to the rule with the highest priority. The higher the number, the higher the priority. \n For more information, see [Replication](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html) in the *Amazon S3 User Guide*.", "type": "integer" }, "SourceSelectionCriteria": { - "$ref": "#/definitions/SourceSelectionCriteria" + "$ref": "#/definitions/SourceSelectionCriteria", + "description": "A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects." }, "Status": { "description": "Specifies whether the rule is enabled.", @@ -935,11 +987,14 @@ }, "ReplicationRuleAndOperator": { "additionalProperties": false, + "description": "A container for specifying rule filters. The filters determine the subset of objects to which the rule applies. This element is required only if you specify more than one filter. \n For example:\n + If you specify both a ``Prefix`` and a ``TagFilter``, wrap these filters in an ``And`` tag. \n + If you specify a filter based on multiple tags, wrap the ``TagFilter`` elements in an ``And`` tag", "properties": { "Prefix": { + "description": "An object key name prefix that identifies the subset of objects to which the rule applies.", "type": "string" }, "TagFilters": { + "description": "An array of tags containing key and value pairs.", "insertionOrder": true, "items": { "$ref": "#/definitions/TagFilter" @@ -952,23 +1007,29 @@ }, "ReplicationRuleFilter": { "additionalProperties": false, + "description": "A filter that identifies the subset of objects to which the replication rule applies. A ``Filter`` must specify exactly one ``Prefix``, ``TagFilter``, or an ``And`` child element.", "properties": { "And": { - "$ref": "#/definitions/ReplicationRuleAndOperator" + "$ref": "#/definitions/ReplicationRuleAndOperator", + "description": "A container for specifying rule filters. The filters determine the subset of objects to which the rule applies. This element is required only if you specify more than one filter. For example: \n + If you specify both a ``Prefix`` and a ``TagFilter``, wrap these filters in an ``And`` tag.\n + If you specify a filter based on multiple tags, wrap the ``TagFilter`` elements in an ``And`` tag." }, "Prefix": { + "description": "An object key name prefix that identifies the subset of objects to which the rule applies.\n Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).", "type": "string" }, "TagFilter": { - "$ref": "#/definitions/TagFilter" + "$ref": "#/definitions/TagFilter", + "description": "A container for specifying a tag key and value. \n The rule applies only to objects that have the tag in their tag set." } }, "type": "object" }, "ReplicationTime": { "additionalProperties": false, + "description": "A container specifying S3 Replication Time Control (S3 RTC) related information, including whether S3 RTC is enabled and the time when all objects and operations on objects must be replicated. Must be specified together with a ``Metrics`` block.", "properties": { "Status": { + "description": "Specifies whether the replication time is enabled.", "enum": [ "Disabled", "Enabled" @@ -976,7 +1037,8 @@ "type": "string" }, "Time": { - "$ref": "#/definitions/ReplicationTimeValue" + "$ref": "#/definitions/ReplicationTimeValue", + "description": "A container specifying the time by which replication should be complete for all objects and operations on objects." } }, "required": [ @@ -987,8 +1049,10 @@ }, "ReplicationTimeValue": { "additionalProperties": false, + "description": "A container specifying the time value for S3 Replication Time Control (S3 RTC) and replication metrics ``EventThreshold``.", "properties": { "Minutes": { + "description": "Contains an integer specifying time in minutes. \n Valid value: 15", "type": "integer" } }, @@ -999,14 +1063,15 @@ }, "RoutingRule": { "additionalProperties": false, - "description": "Specifies the redirect behavior and when a redirect is applied.", + "description": "Specifies the redirect behavior and when a redirect is applied. For more information about routing rules, see [Configuring advanced conditional redirects](https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html#advanced-conditional-redirects) in the *Amazon S3 User Guide*.", "properties": { "RedirectRule": { "$ref": "#/definitions/RedirectRule", "description": "Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event of an error, you can specify a different error code to return." }, "RoutingRuleCondition": { - "$ref": "#/definitions/RoutingRuleCondition" + "$ref": "#/definitions/RoutingRuleCondition", + "description": "A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the ``/docs`` folder, redirect to the ``/documents`` folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error." } }, "required": [ @@ -1016,14 +1081,14 @@ }, "RoutingRuleCondition": { "additionalProperties": false, - "description": "A container for describing a condition that must be met for the specified redirect to apply.You must specify at least one of HttpErrorCodeReturnedEquals and KeyPrefixEquals", + "description": "A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the ``/docs`` folder, redirect to the ``/documents`` folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error.", "properties": { "HttpErrorCodeReturnedEquals": { - "description": "The HTTP error code when the redirect is applied. ", + "description": "The HTTP error code when the redirect is applied. In the event of an error, if the error code equals this value, then the specified redirect is applied.\n Required when parent element ``Condition`` is specified and sibling ``KeyPrefixEquals`` is not specified. If both are specified, then both must be true for the redirect to be applied.", "type": "string" }, "KeyPrefixEquals": { - "description": "The object key name prefix when the redirect is applied.", + "description": "The object key name prefix when the redirect is applied. For example, to redirect requests for ``ExamplePage.html``, the key prefix will be ``ExamplePage.html``. To redirect request for all pages with the prefix ``docs/``, the key prefix will be ``/docs``, which identifies all objects in the docs/ folder.\n Required when the parent element ``Condition`` is specified and sibling ``HttpErrorCodeReturnedEquals`` is not specified. If both conditions are specified, both must be true for the redirect to be applied.", "type": "string" } }, @@ -1031,34 +1096,43 @@ }, "Rule": { "additionalProperties": false, - "description": "You must specify at least one of the following properties: AbortIncompleteMultipartUpload, ExpirationDate, ExpirationInDays, NoncurrentVersionExpirationInDays, NoncurrentVersionTransition, NoncurrentVersionTransitions, Transition, or Transitions.", + "description": "Specifies lifecycle rules for an Amazon S3 bucket. For more information, see [Put Bucket Lifecycle Configuration](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlifecycle.html) in the *Amazon S3 API Reference*.\n You must specify at least one of the following properties: ``AbortIncompleteMultipartUpload``, ``ExpirationDate``, ``ExpirationInDays``, ``NoncurrentVersionExpirationInDays``, ``NoncurrentVersionTransition``, ``NoncurrentVersionTransitions``, ``Transition``, or ``Transitions``.", "properties": { "AbortIncompleteMultipartUpload": { - "$ref": "#/definitions/AbortIncompleteMultipartUpload" + "$ref": "#/definitions/AbortIncompleteMultipartUpload", + "description": "Specifies a lifecycle rule that stops incomplete multipart uploads to an Amazon S3 bucket." }, "ExpirationDate": { - "$ref": "#/definitions/iso8601UTC" + "$ref": "#/definitions/iso8601UTC", + "description": "Indicates when objects are deleted from Amazon S3 and Amazon S3 Glacier. The date value must be in ISO 8601 format. The time is always midnight UTC. If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time." }, "ExpirationInDays": { + "description": "Indicates the number of days after creation when objects are deleted from Amazon S3 and Amazon S3 Glacier. If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time.", "type": "integer" }, "ExpiredObjectDeleteMarker": { + "description": "Indicates whether Amazon S3 will remove a delete marker without any noncurrent versions. If set to true, the delete marker will be removed if there are no noncurrent versions. This cannot be specified with ``ExpirationInDays``, ``ExpirationDate``, or ``TagFilters``.", "type": "boolean" }, "Id": { + "description": "Unique identifier for the rule. The value can't be longer than 255 characters.", "maxLength": 255, "type": "string" }, "NoncurrentVersionExpiration": { - "$ref": "#/definitions/NoncurrentVersionExpiration" + "$ref": "#/definitions/NoncurrentVersionExpiration", + "description": "Specifies when noncurrent object versions expire. Upon expiration, S3 permanently deletes the noncurrent object versions. You set this lifecycle configuration action on a bucket that has versioning enabled (or suspended) to request that S3 delete noncurrent object versions at a specific period in the object's lifetime." }, "NoncurrentVersionExpirationInDays": { + "description": "(Deprecated.) For buckets with versioning enabled (or suspended), specifies the time, in days, between when a new version of the object is uploaded to the bucket and when old versions of the object expire. When object versions expire, Amazon S3 permanently deletes them. If you specify a transition and expiration time, the expiration time must be later than the transition time.", "type": "integer" }, "NoncurrentVersionTransition": { - "$ref": "#/definitions/NoncurrentVersionTransition" + "$ref": "#/definitions/NoncurrentVersionTransition", + "description": "(Deprecated.) For buckets with versioning enabled (or suspended), specifies when non-current objects transition to a specified storage class. If you specify a transition and expiration time, the expiration time must be later than the transition time. If you specify this property, don't specify the ``NoncurrentVersionTransitions`` property." }, "NoncurrentVersionTransitions": { + "description": "For buckets with versioning enabled (or suspended), one or more transition rules that specify when non-current objects transition to a specified storage class. If you specify a transition and expiration time, the expiration time must be later than the transition time. If you specify this property, don't specify the ``NoncurrentVersionTransition`` property.", "insertionOrder": true, "items": { "$ref": "#/definitions/NoncurrentVersionTransition" @@ -1067,19 +1141,23 @@ "uniqueItems": true }, "ObjectSizeGreaterThan": { + "description": "Specifies the minimum object size in bytes for this rule to apply to. Objects must be larger than this value in bytes. For more information about size based rules, see [Lifecycle configuration using size-based rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/lifecycle-configuration-examples.html#lc-size-rules) in the *Amazon S3 User Guide*.", "maxLength": 20, "pattern": "[0-9]+", "type": "string" }, "ObjectSizeLessThan": { + "description": "Specifies the maximum object size in bytes for this rule to apply to. Objects must be smaller than this value in bytes. For more information about sized based rules, see [Lifecycle configuration using size-based rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/lifecycle-configuration-examples.html#lc-size-rules) in the *Amazon S3 User Guide*.", "maxLength": 20, "pattern": "[0-9]+", "type": "string" }, "Prefix": { + "description": "Object key prefix that identifies one or more objects to which this rule applies.\n Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).", "type": "string" }, "Status": { + "description": "If ``Enabled``, the rule is currently being applied. If ``Disabled``, the rule is not currently being applied.", "enum": [ "Enabled", "Disabled" @@ -1087,6 +1165,7 @@ "type": "string" }, "TagFilters": { + "description": "Tags to use to identify a subset of objects to which the lifecycle rule applies.", "insertionOrder": true, "items": { "$ref": "#/definitions/TagFilter" @@ -1095,9 +1174,11 @@ "uniqueItems": true }, "Transition": { - "$ref": "#/definitions/Transition" + "$ref": "#/definitions/Transition", + "description": "(Deprecated.) Specifies when an object transitions to a specified storage class. If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time. If you specify this property, don't specify the ``Transitions`` property." }, "Transitions": { + "description": "One or more transition rules that specify when an object transitions to a specified storage class. If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time. If you specify this property, don't specify the ``Transition`` property.", "insertionOrder": true, "items": { "$ref": "#/definitions/Transition" @@ -1113,10 +1194,11 @@ }, "S3KeyFilter": { "additionalProperties": false, - "description": "A container for object key name prefix and suffix filtering rules.", + "description": "A container for object key name prefix and suffix filtering rules. For more information about object key name filtering, see [Configuring event notifications using object key name filtering](https://docs.aws.amazon.com/AmazonS3/latest/userguide/notification-how-to-filtering.html) in the *Amazon S3 User Guide*.\n The same type of filter rule cannot be used more than once. For example, you cannot specify two prefix rules.", "properties": { "Rules": { - "insertionOrder": true, + "description": "A list of containers for the key-value pair that defines the criteria for the filter rule.", + "insertionOrder": false, "items": { "$ref": "#/definitions/FilterRule" }, @@ -1131,13 +1213,34 @@ }, "ServerSideEncryptionByDefault": { "additionalProperties": false, - "description": "Specifies the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied.", + "description": "Describes the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied. If you don't specify a customer managed key at configuration, Amazon S3 automatically creates an AWS KMS key in your AWS account the first time that you add an object encrypted with SSE-KMS to a bucket. By default, Amazon S3 uses this KMS key for SSE-KMS. For more information, see [PUT Bucket encryption](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTencryption.html) in the *Amazon S3 API Reference*.", "properties": { "KMSMasterKeyID": { - "description": "\"KMSMasterKeyID\" can only be used when you set the value of SSEAlgorithm as aws:kms or aws:kms:dsse.", + "anyOf": [ + { + "relationshipRef": { + "propertyPath": "/properties/KeyId", + "typeName": "AWS::KMS::Key" + } + }, + { + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::KMS::Key" + } + }, + { + "relationshipRef": { + "propertyPath": "/properties/AliasName", + "typeName": "AWS::KMS::Alias" + } + } + ], + "description": "AWS Key Management Service (KMS) customer AWS KMS key ID to use for the default encryption. This parameter is allowed if and only if ``SSEAlgorithm`` is set to ``aws:kms`` or ``aws:kms:dsse``.\n You 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: ``arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`` \n + Key Alias: ``alias/alias-name`` \n \n If you use a key ID, you can run into a LogDestination undeliverable error when creating a VPC flow log. \n If you are using encryption with cross-account or AWS service operations you 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/dev/bucket-encryption.html#bucket-encryption-update-bucket-policy).\n Amazon S3 only supports symmetric encryption KMS keys. For more information, see [Asymmetric keys in KMS](https://docs.aws.amazon.com//kms/latest/developerguide/symmetric-asymmetric.html) in the *Key Management Service Developer Guide*.", "type": "string" }, "SSEAlgorithm": { + "description": "Server-side encryption algorithm to use for the default encryption.", "enum": [ "aws:kms", "AES256", @@ -1156,18 +1259,19 @@ "description": "Specifies the default server-side encryption configuration.", "properties": { "BucketKeyEnabled": { - "description": "Specifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS (SSE-KMS) for new objects in the bucket. Existing objects are not affected. Setting the BucketKeyEnabled element to true causes Amazon S3 to use an S3 Bucket Key. By default, S3 Bucket Key is not enabled.", + "description": "Specifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS (SSE-KMS) for new objects in the bucket. Existing objects are not affected. Setting the ``BucketKeyEnabled`` element to ``true`` causes Amazon S3 to use an S3 Bucket Key. By default, S3 Bucket Key is not enabled.\n For more information, see [Amazon S3 Bucket Keys](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html) in the *Amazon S3 User Guide*.", "type": "boolean" }, "ServerSideEncryptionByDefault": { - "$ref": "#/definitions/ServerSideEncryptionByDefault" + "$ref": "#/definitions/ServerSideEncryptionByDefault", + "description": "Specifies the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied." } }, "type": "object" }, "SourceSelectionCriteria": { "additionalProperties": false, - "description": "A container that describes additional filters for identifying the source objects that you want to replicate.", + "description": "A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects.", "properties": { "ReplicaModifications": { "$ref": "#/definitions/ReplicaModifications", @@ -1185,7 +1289,7 @@ "description": "A container for filter information for the selection of S3 objects encrypted with AWS KMS.", "properties": { "Status": { - "description": "Specifies whether Amazon S3 replicates objects created with server-side encryption using a customer master key (CMK) stored in AWS Key Management Service.", + "description": "Specifies whether Amazon S3 replicates objects created with server-side encryption using an AWS KMS key stored in AWS Key Management Service.", "enum": [ "Disabled", "Enabled" @@ -1203,20 +1307,24 @@ "description": "Specifies data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes for an Amazon S3 bucket.", "properties": { "DataExport": { - "$ref": "#/definitions/DataExport" + "$ref": "#/definitions/DataExport", + "description": "Specifies how data related to the storage class analysis for an Amazon S3 bucket should be exported." } }, "type": "object" }, "Tag": { "additionalProperties": false, + "description": "A container of a key value name pair.", "properties": { "Key": { + "description": "Name of the object key.", "maxLength": 128, "minLength": 1, "type": "string" }, "Value": { + "description": "Value of the tag.", "maxLength": 256, "type": "string" } @@ -1229,12 +1337,14 @@ }, "TagFilter": { "additionalProperties": false, - "description": "Tags to use to identify a subset of objects for an Amazon S3 bucket.", + "description": "Specifies tags to use to identify a subset of objects for an Amazon S3 bucket.", "properties": { "Key": { + "description": "The tag key.", "type": "string" }, "Value": { + "description": "The tag value.", "type": "string" } }, @@ -1276,9 +1386,10 @@ }, "Tiering": { "additionalProperties": false, + "description": "The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without additional operational overhead.", "properties": { "AccessTier": { - "description": "S3 Intelligent-Tiering access tier. See Storage class for automatically optimizing frequently and infrequently accessed objects for a list of access tiers in the S3 Intelligent-Tiering storage class.", + "description": "S3 Intelligent-Tiering access tier. See [Storage class for automatically 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 tiers in the S3 Intelligent-Tiering storage class.", "enum": [ "ARCHIVE_ACCESS", "DEEP_ARCHIVE_ACCESS" @@ -1298,15 +1409,15 @@ }, "TopicConfiguration": { "additionalProperties": false, - "description": "The topic to which notifications are sent and the events for which notifications are generated.", + "description": "A container for specifying the configuration for publication of messages to an Amazon Simple Notification Service (Amazon SNS) topic when Amazon S3 detects specified events.", "properties": { "Event": { - "description": "The Amazon S3 bucket event about which to send notifications.", + "description": "The 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 the *Amazon S3 User Guide*.", "type": "string" }, "Filter": { "$ref": "#/definitions/NotificationFilter", - "description": "The filtering rules that determine for which objects to send notifications." + "description": "The filtering rules that determine for which objects to send notifications. For example, you can create a filter so that Amazon S3 sends notifications only when image files with a ``.jpg`` extension are added to the bucket." }, "Topic": { "description": "The Amazon Resource Name (ARN) of the Amazon SNS topic to which Amazon S3 publishes a message when it detects events of the specified type.", @@ -1321,9 +1432,10 @@ }, "Transition": { "additionalProperties": false, - "description": "You must specify at least one of \"TransitionDate\" and \"TransitionInDays\"", + "description": "Specifies when an object transitions to a specified storage class. For more information about Amazon S3 lifecycle configuration rules, see [Transitioning Objects Using Amazon S3 Lifecycle](https://docs.aws.amazon.com/AmazonS3/latest/dev/lifecycle-transition-general-considerations.html) in the *Amazon S3 User Guide*.", "properties": { "StorageClass": { + "description": "The storage class to which you want the object to transition.", "enum": [ "DEEP_ARCHIVE", "GLACIER", @@ -1336,9 +1448,11 @@ "type": "string" }, "TransitionDate": { - "$ref": "#/definitions/iso8601UTC" + "$ref": "#/definitions/iso8601UTC", + "description": "Indicates when objects are transitioned to the specified storage class. The date value must be in ISO 8601 format. The time is always midnight UTC." }, "TransitionInDays": { + "description": "Indicates the number of days after creation when objects are transitioned to the specified storage class. The value must be a positive integer.", "type": "integer" } }, @@ -1349,7 +1463,7 @@ }, "VersioningConfiguration": { "additionalProperties": false, - "description": "Describes the versioning state of an Amazon S3 bucket.", + "description": "Describes the versioning state of an Amazon S3 bucket. For more information, see [PUT Bucket versioning](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTVersioningStatus.html) in the *Amazon S3 API Reference*.", "properties": { "Status": { "default": "Suspended", @@ -1379,9 +1493,11 @@ "type": "string" }, "RedirectAllRequestsTo": { - "$ref": "#/definitions/RedirectAllRequestsTo" + "$ref": "#/definitions/RedirectAllRequestsTo", + "description": "The redirect behavior for every request to this bucket's website endpoint.\n If you specify this property, you can't specify any other property." }, "RoutingRules": { + "description": "Rules that define when a redirect is applied and the redirect behavior.", "insertionOrder": true, "items": { "$ref": "#/definitions/RoutingRule" @@ -1397,7 +1513,7 @@ "type": "string" } }, - "description": "Resource Type definition for AWS::S3::Bucket", + "description": "The ``AWS::S3::Bucket`` resource creates an Amazon S3 bucket in the same AWS Region where you create the AWS CloudFormation stack.\n To 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 You can only delete empty buckets. Deletion fails for buckets that have contents.", "handlers": { "create": { "permissions": [ @@ -1502,10 +1618,10 @@ "properties": { "AccelerateConfiguration": { "$ref": "#/definitions/AccelerateConfiguration", - "description": "Configuration for the transfer acceleration state." + "description": "Configures the transfer acceleration state for an Amazon S3 bucket. For more information, see [Amazon S3 Transfer Acceleration](https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html) in the *Amazon S3 User Guide*." }, "AccessControl": { - "description": "A canned access control list (ACL) that grants predefined permissions to the bucket.", + "description": "This is a legacy property, and it is not recommended for most use cases. A majority of modern use cases in Amazon S3 no longer require the use of ACLs, and we recommend that you keep ACLs disabled. For more information, see [Controlling object ownership](https://docs.aws.amazon.com//AmazonS3/latest/userguide/about-object-ownership.html) in the *Amazon S3 User Guide*.\n A canned access control list (ACL) that grants predefined permissions to the bucket. For more information about canned ACLs, see [Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) in the *Amazon S3 User Guide*.\n S3 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 with any value other than Private. Use cases requiring ACLs are uncommon.\n The majority of access control configurations can be successfully and more easily achieved 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 Server Access Logs buckets and more, see [Bucket policy examples](https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html) in the *Amazon S3 User Guide*.", "enum": [ "AuthenticatedRead", "AwsExecRead", @@ -1519,7 +1635,7 @@ "type": "string" }, "AnalyticsConfigurations": { - "description": "The configuration and any analyses for the analytics filter of an Amazon S3 bucket.", + "description": "Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket.", "insertionOrder": true, "items": { "$ref": "#/definitions/AnalyticsConfiguration" @@ -1529,41 +1645,39 @@ }, "Arn": { "$ref": "#/definitions/Arn", - "description": "The Amazon Resource Name (ARN) of the specified bucket.", + "description": "", "examples": [ "arn:aws:s3:::mybucket" ] }, "BucketEncryption": { - "$ref": "#/definitions/BucketEncryption" + "$ref": "#/definitions/BucketEncryption", + "description": "Specifies default encryption for a bucket using server-side encryption with Amazon S3-managed keys (SSE-S3), AWS KMS-managed keys (SSE-KMS), or dual-layer server-side encryption with KMS-managed keys (DSSE-KMS). For information about the Amazon S3 default encryption feature, see [Amazon S3 Default Encryption for S3 Buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html) in the *Amazon S3 User Guide*." }, "BucketName": { - "description": "A name for the bucket. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name.", - "maxLength": 63, - "minLength": 3, - "pattern": "^[a-z0-9][a-z0-9//.//-]*[a-z0-9]$", + "description": "A name for the bucket. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the bucket name. The bucket name must contain only lowercase letters, numbers, periods (.), and dashes (-) and must follow [Amazon S3 bucket restrictions and limitations](https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html). For more information, see [Rules for naming Amazon S3 buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html#bucketnamingrules) in the *Amazon S3 User Guide*. \n If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you need to replace the resource, specify a new name.", "type": "string" }, "CorsConfiguration": { "$ref": "#/definitions/CorsConfiguration", - "description": "Rules that define cross-origin resource sharing of objects in this bucket." + "description": "Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see [Enabling Cross-Origin Resource Sharing](https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) in the *Amazon S3 User Guide*." }, "DomainName": { - "description": "The IPv4 DNS name of the specified bucket.", + "description": "", "examples": [ "mystack-mybucket-kdwwxmddtr2g.s3.amazonaws.com" ], "type": "string" }, "DualStackDomainName": { - "description": "The IPv6 DNS name of the specified bucket. For more information about dual-stack endpoints, see [Using Amazon S3 Dual-Stack Endpoints](https://docs.aws.amazon.com/AmazonS3/latest/dev/dual-stack-endpoints.html).", + "description": "", "examples": [ "mystack-mybucket-kdwwxmddtr2g.s3.dualstack.us-east-2.amazonaws.com" ], "type": "string" }, "IntelligentTieringConfigurations": { - "description": "Specifies the S3 Intelligent-Tiering configuration for an Amazon S3 bucket.", + "description": "Defines how Amazon S3 handles Intelligent-Tiering storage.", "insertionOrder": true, "items": { "$ref": "#/definitions/IntelligentTieringConfiguration" @@ -1572,7 +1686,7 @@ "uniqueItems": true }, "InventoryConfigurations": { - "description": "The inventory configuration for an Amazon S3 bucket.", + "description": "Specifies the inventory configuration for an Amazon S3 bucket. For more information, see [GET Bucket inventory](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETInventoryConfig.html) in the *Amazon S3 API Reference*.", "insertionOrder": true, "items": { "$ref": "#/definitions/InventoryConfiguration" @@ -1582,14 +1696,14 @@ }, "LifecycleConfiguration": { "$ref": "#/definitions/LifecycleConfiguration", - "description": "Rules that define how Amazon S3 manages objects during their lifetime." + "description": "Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more information, see [Object Lifecycle Management](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) in the *Amazon S3 User Guide*." }, "LoggingConfiguration": { "$ref": "#/definitions/LoggingConfiguration", "description": "Settings that define where logs are stored." }, "MetricsConfigurations": { - "description": "Settings that define a metrics configuration for the CloudWatch request metrics from the bucket.", + "description": "Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased. For more information, see [PutBucketMetricsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTMetricConfiguration.html).", "insertionOrder": true, "items": { "$ref": "#/definitions/MetricsConfiguration" @@ -1603,21 +1717,22 @@ }, "ObjectLockConfiguration": { "$ref": "#/definitions/ObjectLockConfiguration", - "description": "Places an Object Lock configuration on the specified bucket." + "description": "This operation is not supported by directory buckets.\n Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see [Locking Objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html). \n + The ``DefaultRetention`` settings require both a mode and a period.\n + The ``DefaultRetention`` period can be either ``Days`` or ``Years`` but you must select one. You cannot specify ``Days`` and ``Years`` at the same time.\n + You can enable Object Lock for new or existing buckets. For more information, see [Configuring Object Lock](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-configure.html)." }, "ObjectLockEnabled": { - "description": "Indicates whether this bucket has an Object Lock configuration enabled.", + "description": "Indicates whether this bucket has an Object Lock configuration enabled. Enable ``ObjectLockEnabled`` when you apply ``ObjectLockConfiguration`` to a bucket.", "type": "boolean" }, "OwnershipControls": { "$ref": "#/definitions/OwnershipControls", - "description": "Specifies the container element for object ownership rules." + "description": "Configuration that defines how Amazon S3 handles Object Ownership rules." }, "PublicAccessBlockConfiguration": { - "$ref": "#/definitions/PublicAccessBlockConfiguration" + "$ref": "#/definitions/PublicAccessBlockConfiguration", + "description": "Configuration that defines how Amazon S3 handles public access." }, "RegionalDomainName": { - "description": "Returns the regional domain name of the specified bucket.", + "description": "", "examples": [ "mystack-mybucket-kdwwxmddtr2g.s3.us-east-2.amazonaws.com" ], @@ -1625,7 +1740,7 @@ }, "ReplicationConfiguration": { "$ref": "#/definitions/ReplicationConfiguration", - "description": "Configuration for replicating objects in an S3 bucket." + "description": "Configuration for replicating objects in an S3 bucket. To enable replication, you must also enable versioning by using the ``VersioningConfiguration`` property.\n Amazon S3 can store replicated objects in a single destination bucket or multiple destination buckets. The destination bucket or buckets must already exist." }, "Tags": { "description": "An arbitrary set of tags (key-value pairs) for this S3 bucket.", @@ -1636,13 +1751,15 @@ "type": "array" }, "VersioningConfiguration": { - "$ref": "#/definitions/VersioningConfiguration" + "$ref": "#/definitions/VersioningConfiguration", + "description": "Enables multiple versions of all objects in this bucket. You might enable versioning to prevent objects from being deleted or overwritten by mistake or to archive objects so that you can retrieve previous versions of them." }, "WebsiteConfiguration": { - "$ref": "#/definitions/WebsiteConfiguration" + "$ref": "#/definitions/WebsiteConfiguration", + "description": "Information used to configure the bucket as a static website. For more information, see [Hosting Websites on Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html)." }, "WebsiteURL": { - "description": "The Amazon S3 website endpoint for the specified bucket.", + "description": "", "examples": [ "Example (IPv4): http://mystack-mybucket-kdwwxmddtr2g.s3-website-us-east-2.amazonaws.com/", "Example (IPv6): http://mystack-mybucket-kdwwxmddtr2g.s3.dualstack.us-east-2.amazonaws.com/" @@ -1651,6 +1768,11 @@ "type": "string" } }, + "propertyTransform": { + "/properties/NotificationConfiguration/LambdaConfigurations/*/Filter/S3Key/Rules/*/Name": "$replace(Name, \"prefix\", \"Prefix\") $OR $replace(Name, \"suffix\", \"Suffix\")", + "/properties/NotificationConfiguration/QueueConfigurations/*/Filter/S3Key/Rules/*/Name": "$replace(Name, \"prefix\", \"Prefix\") $OR $replace(Name, \"suffix\", \"Suffix\")", + "/properties/NotificationConfiguration/TopicConfigurations/*/Filter/S3Key/Rules/*/Name": "$replace(Name, \"prefix\", \"Prefix\") $OR $replace(Name, \"suffix\", \"Suffix\")" + }, "readOnlyProperties": [ "/properties/Arn", "/properties/DomainName", diff --git a/artifacts/types/AWS::S3::BucketPolicy.json b/artifacts/types/AWS::S3::BucketPolicy.json index dfce0da2..d26d6f7a 100644 --- a/artifacts/types/AWS::S3::BucketPolicy.json +++ b/artifacts/types/AWS::S3::BucketPolicy.json @@ -1,13 +1,13 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-S3-BucketPolicy", "type": "AWS::S3::BucketPolicy", - "time": "2023-11-14T01:03:00.082Z", + "time": "2024-04-16T07:14:42.328Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ "/properties/Bucket" ], - "description": "Resource Type definition for AWS::S3::BucketPolicy", + "description": "Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than the root user of the AWS-account that owns the bucket, the calling identity must have the ``PutBucketPolicy`` permissions on the specified bucket and belong to the bucket owner's account in order to use this operation.\n If you don't have ``PutBucketPolicy`` permissions, Amazon S3 returns a ``403 Access Denied`` error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a ``405 Method Not Allowed`` error.\n As a security precaution, the root user of the AWS-account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action. \n For more information, see [Bucket policy examples](https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html).\n The 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)", "handlers": { "create": { "permissions": [ @@ -48,7 +48,7 @@ "type": "string" }, "PolicyDocument": { - "description": "A policy document containing permissions to add to the specified 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.", + "description": "A policy document containing permissions to add to the specified 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. 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 Overview](https://docs.aws.amazon.com/AmazonS3/latest/dev/access-policy-language-overview.html) in the *Amazon S3 User Guide*.", "type": [ "object", "string" diff --git a/artifacts/types/AWS::S3::MultiRegionAccessPointPolicy.json b/artifacts/types/AWS::S3::MultiRegionAccessPointPolicy.json index 2e284893..96c950ce 100644 --- a/artifacts/types/AWS::S3::MultiRegionAccessPointPolicy.json +++ b/artifacts/types/AWS::S3::MultiRegionAccessPointPolicy.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-S3-MultiRegionAccessPointPolicy", "type": "AWS::S3::MultiRegionAccessPointPolicy", - "time": "2024-01-03T16:42:21.703Z", + "time": "2024-05-22T15:17:50.074Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::S3::StorageLens.json b/artifacts/types/AWS::S3::StorageLens.json index ab75a694..1cbae3b1 100644 --- a/artifacts/types/AWS::S3::StorageLens.json +++ b/artifacts/types/AWS::S3::StorageLens.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-S3-StorageLens", "type": "AWS::S3::StorageLens", - "time": "2023-11-10T19:08:16.062Z", + "time": "2024-04-08T15:53:00.409Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -243,6 +243,10 @@ }, "Arn": { "description": "The ARN of the bucket to which Amazon S3 Storage Lens exports will be placed.", + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::S3::Bucket" + }, "type": "string" }, "Encryption": { @@ -390,13 +394,13 @@ "Key": { "maxLength": 127, "minLength": 1, - "pattern": "^(?!aws:.*)[a-zA-Z0-9\\s\\_\\.\\/\\=\\+\\-]+$", + "pattern": "^(?!aws:.*)[a-zA-Z0-9\\s\\_\\.\\/\\=\\+\\-\\@\\:]+$", "type": "string" }, "Value": { "maxLength": 255, "minLength": 1, - "pattern": "^(?!aws:.*)[a-zA-Z0-9\\s\\_\\.\\/\\=\\+\\-\\@]+$", + "pattern": "^(?!aws:.*)[a-zA-Z0-9\\s\\_\\.\\/\\=\\+\\-\\@\\:]+$", "type": "string" } }, @@ -478,6 +482,13 @@ "StorageLensConfiguration" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-s3-storagelens", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, "typeName": "AWS::S3::StorageLens" } } \ No newline at end of file diff --git a/artifacts/types/AWS::S3::StorageLensGroup.json b/artifacts/types/AWS::S3::StorageLensGroup.json index 1e946f2a..90576805 100644 --- a/artifacts/types/AWS::S3::StorageLensGroup.json +++ b/artifacts/types/AWS::S3::StorageLensGroup.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-S3-StorageLensGroup", "type": "AWS::S3::StorageLensGroup", - "time": "2023-11-10T19:17:17.191Z", + "time": "2024-02-12T17:15:26.283Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::S3Express::BucketPolicy.json b/artifacts/types/AWS::S3Express::BucketPolicy.json index 26145294..5c2261f1 100644 --- a/artifacts/types/AWS::S3Express::BucketPolicy.json +++ b/artifacts/types/AWS::S3Express::BucketPolicy.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-S3Express-BucketPolicy", "type": "AWS::S3Express::BucketPolicy", - "time": "2023-12-07T17:40:20.513Z", + "time": "2024-03-21T17:51:40.301Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::S3ObjectLambda::AccessPoint.json b/artifacts/types/AWS::S3ObjectLambda::AccessPoint.json index f773ed3e..814b0e88 100644 --- a/artifacts/types/AWS::S3ObjectLambda::AccessPoint.json +++ b/artifacts/types/AWS::S3ObjectLambda::AccessPoint.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-S3ObjectLambda-AccessPoint", "type": "AWS::S3ObjectLambda::AccessPoint", - "time": "2024-01-04T10:11:17.544Z", + "time": "2024-04-23T09:08:16.733Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::S3ObjectLambda::AccessPointPolicy.json b/artifacts/types/AWS::S3ObjectLambda::AccessPointPolicy.json index 89bb2cdb..eb432882 100644 --- a/artifacts/types/AWS::S3ObjectLambda::AccessPointPolicy.json +++ b/artifacts/types/AWS::S3ObjectLambda::AccessPointPolicy.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-S3ObjectLambda-AccessPointPolicy", "type": "AWS::S3ObjectLambda::AccessPointPolicy", - "time": "2024-01-04T10:24:35.094Z", + "time": "2024-04-23T09:22:41.31Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::S3Outposts::AccessPoint.json b/artifacts/types/AWS::S3Outposts::AccessPoint.json index 7cf0017e..0a787e31 100644 --- a/artifacts/types/AWS::S3Outposts::AccessPoint.json +++ b/artifacts/types/AWS::S3Outposts::AccessPoint.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-S3Outposts-AccessPoint", "type": "AWS::S3Outposts::AccessPoint", - "time": "2023-12-04T15:17:14.263Z", + "time": "2024-05-22T14:28:23.776Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -102,7 +102,12 @@ "VpcConfiguration" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-s3outposts.git", - "taggable": false, + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, "typeName": "AWS::S3Outposts::AccessPoint" } } \ No newline at end of file diff --git a/artifacts/types/AWS::S3Outposts::Bucket.json b/artifacts/types/AWS::S3Outposts::Bucket.json index cddea750..8722a653 100644 --- a/artifacts/types/AWS::S3Outposts::Bucket.json +++ b/artifacts/types/AWS::S3Outposts::Bucket.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-S3Outposts-Bucket", "type": "AWS::S3Outposts::Bucket", - "time": "2023-12-04T15:17:14.51Z", + "time": "2024-05-22T14:28:23.492Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -227,6 +227,16 @@ ] }, "list": { + "handlerSchema": { + "properties": { + "OutpostId": { + "$ref": "resource-schema.json#/properties/OutpostId" + } + }, + "required": [ + "OutpostId" + ] + }, "permissions": [ "s3-outposts:ListRegionalBuckets" ] @@ -291,7 +301,13 @@ "OutpostId" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-s3outposts.git", - "taggable": true, + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, "typeName": "AWS::S3Outposts::Bucket" } } \ No newline at end of file diff --git a/artifacts/types/AWS::S3Outposts::BucketPolicy.json b/artifacts/types/AWS::S3Outposts::BucketPolicy.json index 14548cac..9d161605 100644 --- a/artifacts/types/AWS::S3Outposts::BucketPolicy.json +++ b/artifacts/types/AWS::S3Outposts::BucketPolicy.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-S3Outposts-BucketPolicy", "type": "AWS::S3Outposts::BucketPolicy", - "time": "2023-12-04T15:17:14.686Z", + "time": "2024-05-22T14:29:21.159Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -55,7 +55,12 @@ "PolicyDocument" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-s3outposts.git", - "taggable": false, + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, "typeName": "AWS::S3Outposts::BucketPolicy" } } \ No newline at end of file diff --git a/artifacts/types/AWS::SES::ConfigurationSet.json b/artifacts/types/AWS::SES::ConfigurationSet.json index 620fcaba..96f19d46 100644 --- a/artifacts/types/AWS::SES::ConfigurationSet.json +++ b/artifacts/types/AWS::SES::ConfigurationSet.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SES-ConfigurationSet", "type": "AWS::SES::ConfigurationSet", - "time": "2023-12-19T14:04:29.959Z", + "time": "2024-06-19T09:14:59.113Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::SES::ConfigurationSetEventDestination.json b/artifacts/types/AWS::SES::ConfigurationSetEventDestination.json index da761d03..ed73ccc3 100644 --- a/artifacts/types/AWS::SES::ConfigurationSetEventDestination.json +++ b/artifacts/types/AWS::SES::ConfigurationSetEventDestination.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SES-ConfigurationSetEventDestination", "type": "AWS::SES::ConfigurationSetEventDestination", - "time": "2023-12-19T14:04:22.763Z", + "time": "2024-06-19T09:16:50.295Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -54,6 +54,22 @@ ], "type": "object" }, + "EventBridgeDestination": { + "additionalProperties": false, + "description": "An object that contains Event bus ARN associated with the event bridge destination.", + "properties": { + "EventBusArn": { + "maxLength": 1024, + "minLength": 36, + "pattern": "^arn:aws[a-z0-9-]*:events:[a-z0-9-]+:\\d{12}:event-bus/[^:]+$", + "type": "string" + } + }, + "required": [ + "EventBusArn" + ], + "type": "object" + }, "EventDestination": { "additionalProperties": false, "properties": { @@ -65,6 +81,10 @@ "description": "Sets whether Amazon SES publishes events to this destination when you send an email with the associated configuration set. Set to true to enable publishing to this destination; set to false to prevent publishing to this destination. The default value is false. ", "type": "boolean" }, + "EventBridgeDestination": { + "$ref": "#/definitions/EventBridgeDestination", + "description": "An object that contains Event bus ARN associated with the event bridge destination." + }, "KinesisFirehoseDestination": { "$ref": "#/definitions/KinesisFirehoseDestination", "description": "An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination." diff --git a/artifacts/types/AWS::SES::ContactList.json b/artifacts/types/AWS::SES::ContactList.json index 86065db1..09d8cd59 100644 --- a/artifacts/types/AWS::SES::ContactList.json +++ b/artifacts/types/AWS::SES::ContactList.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SES-ContactList", "type": "AWS::SES::ContactList", - "time": "2023-12-19T14:04:29.817Z", + "time": "2024-06-19T09:15:19.344Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::SES::DedicatedIpPool.json b/artifacts/types/AWS::SES::DedicatedIpPool.json index fb0de1e2..1357d15a 100644 --- a/artifacts/types/AWS::SES::DedicatedIpPool.json +++ b/artifacts/types/AWS::SES::DedicatedIpPool.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SES-DedicatedIpPool", "type": "AWS::SES::DedicatedIpPool", - "time": "2023-12-19T14:22:53.545Z", + "time": "2024-06-19T09:23:23.229Z", "schema": { "additionalProperties": false, "conditionalCreateOnlyProperties": [ diff --git a/artifacts/types/AWS::SES::EmailIdentity.json b/artifacts/types/AWS::SES::EmailIdentity.json index 91a17c08..7e3278c3 100644 --- a/artifacts/types/AWS::SES::EmailIdentity.json +++ b/artifacts/types/AWS::SES::EmailIdentity.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SES-EmailIdentity", "type": "AWS::SES::EmailIdentity", - "time": "2023-12-19T14:04:22.533Z", + "time": "2024-06-19T09:52:36.393Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::SES::Template.json b/artifacts/types/AWS::SES::Template.json index 9e4f4178..af79b133 100644 --- a/artifacts/types/AWS::SES::Template.json +++ b/artifacts/types/AWS::SES::Template.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SES-Template", "type": "AWS::SES::Template", - "time": "2023-12-19T14:04:22.603Z", + "time": "2024-06-19T09:15:29.688Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::SES::VdmAttributes.json b/artifacts/types/AWS::SES::VdmAttributes.json index f41f423f..a8b8fd30 100644 --- a/artifacts/types/AWS::SES::VdmAttributes.json +++ b/artifacts/types/AWS::SES::VdmAttributes.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SES-VdmAttributes", "type": "AWS::SES::VdmAttributes", - "time": "2023-12-19T14:08:51.998Z", + "time": "2024-06-19T09:27:30.31Z", "schema": { "additionalProperties": false, "definitions": { diff --git a/artifacts/types/AWS::SNS::Topic.json b/artifacts/types/AWS::SNS::Topic.json index 1b0580bc..fe13cfbf 100644 --- a/artifacts/types/AWS::SNS::Topic.json +++ b/artifacts/types/AWS::SNS::Topic.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SNS-Topic", "type": "AWS::SNS::Topic", - "time": "2023-12-19T19:35:17.973Z", + "time": "2024-05-02T15:58:02.008Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -11,13 +11,14 @@ "definitions": { "LoggingConfig": { "additionalProperties": false, + "description": "", "properties": { "FailureFeedbackRoleArn": { - "description": "The IAM role ARN to be used when logging failed message deliveries in Amazon CloudWatch", + "description": "", "type": "string" }, "Protocol": { - "description": "Indicates one of the supported protocols for the SNS topic", + "description": "", "enum": [ "http/s", "sqs", @@ -28,11 +29,11 @@ "type": "string" }, "SuccessFeedbackRoleArn": { - "description": "The IAM role ARN to be used when logging successful message deliveries in Amazon CloudWatch", + "description": "", "type": "string" }, "SuccessFeedbackSampleRate": { - "description": "The percentage of successful message deliveries to be logged in Amazon CloudWatch. Valid percentage values range from 0 to 100", + "description": "", "type": "string" } }, @@ -43,11 +44,28 @@ }, "Subscription": { "additionalProperties": false, + "description": "``Subscription`` is an embedded property that describes the subscription endpoints of an SNS topic.\n For full control over subscription behavior (for example, delivery policy, filtering, raw 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.", "properties": { "Endpoint": { + "anyOf": [ + { + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::Lambda::Function" + } + }, + { + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::SQS::Queue" + } + } + ], + "description": "The endpoint that receives notifications from the SNS topic. The endpoint value depends on the protocol that you specify. For more information, see the ``Endpoint`` parameter of the ``Subscribe`` action in the *API Reference*.", "type": "string" }, "Protocol": { + "description": "The subscription's protocol. For more information, see the ``Protocol`` parameter of the ``Subscribe`` action in the *API Reference*.", "type": "string" } }, @@ -59,13 +77,14 @@ }, "Tag": { "additionalProperties": false, + "description": "The list of tags to be added to the specified topic.", "properties": { "Key": { - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, `_`, `.`, `/`, `=`, `+`, and `-`.", + "description": "The required key portion of the tag.", "type": "string" }, "Value": { - "description": "The value for the tag. You can specify a value that is 0 to 256 characters in length.", + "description": "The optional value portion of the tag.", "type": "string" } }, @@ -76,7 +95,7 @@ "type": "object" } }, - "description": "Resource Type definition for AWS::SNS::Topic", + "description": "The ``AWS::SNS::Topic`` resource creates a topic to which notifications can be published.\n One account can create a maximum of 100,000 standard topics and 1,000 FIFO topics. For more information, see [endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/sns.html) in the *General Reference*.\n The structure of ``AUTHPARAMS`` depends on the .signature of the API request. For more information, see [Examples of the complete Signature Version 4 signing process](https://docs.aws.amazon.com/general/latest/gr/sigv4-signed-request-examples.html) in the *General Reference*.", "handlers": { "create": { "permissions": [ @@ -130,19 +149,19 @@ ], "properties": { "ArchivePolicy": { - "description": "The archive policy determines the number of days Amazon SNS retains messages. You can set a retention period from 1 to 365 days.", + "description": "The archive policy determines the number of days SNS retains messages. You can set a retention period from 1 to 365 days.", "type": "object" }, "ContentBasedDeduplication": { - "description": "Enables content-based deduplication for FIFO topics. By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and this attribute is false, you must specify a value for the MessageDeduplicationId parameter for the Publish action.\n\nWhen you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).\n\n(Optional) To override the generated value, you can specify a value for the the MessageDeduplicationId parameter for the Publish action.\n\n", + "description": "Enables content-based deduplication for FIFO topics.\n + By default, ``ContentBasedDeduplication`` is set to ``false``. If you create a FIFO topic and this attribute is ``false``, you must specify a value for the ``MessageDeduplicationId`` parameter for the [Publish](https://docs.aws.amazon.com/sns/latest/api/API_Publish.html) action. \n + When you set ``ContentBasedDeduplication`` to ``true``, SNS uses a SHA-256 hash to generate the ``MessageDeduplicationId`` using the body of the message (but not the attributes of the message).\n (Optional) To override the generated value, you can specify a value for the the ``MessageDeduplicationId`` parameter for the ``Publish`` action.", "type": "boolean" }, "DataProtectionPolicy": { - "description": "The body of the policy document you want to use for this topic.\n\nYou can only add one policy per topic.\n\nThe policy must be in JSON string format.\n\nLength Constraints: Maximum length of 30720", + "description": "The body of the policy document you want to use for this topic.\n You can only add one policy per topic.\n The policy must be in JSON string format.\n Length Constraints: Maximum length of 30,720.", "type": "object" }, "DeliveryStatusLogging": { - "description": "Delivery status logging configuration for supported protocols for an Amazon SNS topic.", + "description": "", "insertionOrder": false, "items": { "$ref": "#/definitions/LoggingConfig" @@ -151,7 +170,7 @@ "uniqueItems": true }, "DisplayName": { - "description": "The display name to use for an Amazon SNS topic with SMS subscriptions.", + "description": "The display name to use for an SNS topic with SMS subscriptions. The display name must be maximum 100 characters long, including hyphens (-), underscores (_), spaces, and tabs.", "type": "string" }, "FifoTopic": { @@ -159,15 +178,35 @@ "type": "boolean" }, "KmsMasterKeyId": { - "description": "The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the AWS Key Management Service API Reference.\n\nThis property applies only to [server-side-encryption](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html).", + "anyOf": [ + { + "relationshipRef": { + "propertyPath": "/properties/Arn", + "typeName": "AWS::KMS::Key" + } + }, + { + "relationshipRef": { + "propertyPath": "/properties/KeyId", + "typeName": "AWS::KMS::Key" + } + }, + { + "relationshipRef": { + "propertyPath": "/properties/AliasName", + "typeName": "AWS::KMS::Alias" + } + } + ], + "description": "The ID of an AWS managed customer master key (CMK) for SNS or a custom CMK. For more information, see [Key terms](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms). For more examples, see ``KeyId`` in the *API Reference*.\n This property applies only to [server-side-encryption](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html).", "type": "string" }, "SignatureVersion": { - "description": "Version of the Amazon SNS signature used. If the SignatureVersion is 1, Signature is a Base64-encoded SHA1withRSA signature of the Message, MessageId, Type, Timestamp, and TopicArn values. If the SignatureVersion is 2, Signature is a Base64-encoded SHA256withRSA signature of the Message, MessageId, Type, Timestamp, and TopicArn values.", + "description": "The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By default, ``SignatureVersion`` is set to ``1``.", "type": "string" }, "Subscription": { - "description": "The SNS subscriptions (endpoints) for this topic.", + "description": "The SNS subscriptions (endpoints) for this topic.\n If you specify the ``Subscription`` property in the ``AWS::SNS::Topic`` resource and it creates an associated subscription resource, the associated subscription is not deleted when the ``AWS::SNS::Topic`` resource is deleted.", "insertionOrder": false, "items": { "$ref": "#/definitions/Subscription" @@ -176,6 +215,7 @@ "uniqueItems": false }, "Tags": { + "description": "The list of tags to add to a new topic.\n To be able to tag a topic on creation, you must have the ``sns:CreateTopic`` and ``sns:TagResource`` permissions.", "insertionOrder": false, "items": { "$ref": "#/definitions/Tag" @@ -184,14 +224,15 @@ "uniqueItems": false }, "TopicArn": { + "description": "", "type": "string" }, "TopicName": { - "description": "The name of the topic you want to create. Topic names must include only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. FIFO topic names must end with .fifo.\n\nIf you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the topic name. For more information, see Name Type.", + "description": "The name of the topic you want to create. Topic names must include only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. FIFO topic names must end with ``.fifo``.\n If you don't specify a name, CFN generates a unique physical ID and uses that ID for the topic name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).\n If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.", "type": "string" }, "TracingConfig": { - "description": "Tracing mode of an Amazon SNS topic. By default TracingConfig is set to PassThrough, and the topic passes through the tracing header it receives from an SNS publisher to its subscriptions. If set to Active, SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. Only supported on standard topics.", + "description": "Tracing mode of an SNS topic. By default ``TracingConfig`` is set to ``PassThrough``, and the topic passes through the tracing header it receives from an SNS publisher to its subscriptions. If set to ``Active``, SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true.", "type": "string" } }, diff --git a/artifacts/types/AWS::SNS::TopicInlinePolicy.json b/artifacts/types/AWS::SNS::TopicInlinePolicy.json index 3e8c3cc5..dcad6530 100644 --- a/artifacts/types/AWS::SNS::TopicInlinePolicy.json +++ b/artifacts/types/AWS::SNS::TopicInlinePolicy.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SNS-TopicInlinePolicy", "type": "AWS::SNS::TopicInlinePolicy", - "time": "2024-01-03T16:18:04.798Z", + "time": "2024-05-28T16:05:03.408Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::SQS::Queue.json b/artifacts/types/AWS::SQS::Queue.json index 44fd42f4..5d7c0a25 100644 --- a/artifacts/types/AWS::SQS::Queue.json +++ b/artifacts/types/AWS::SQS::Queue.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SQS-Queue", "type": "AWS::SQS::Queue", - "time": "2024-01-04T00:01:30.244Z", + "time": "2024-04-23T17:34:10.548Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -11,6 +11,7 @@ "definitions": { "Tag": { "additionalProperties": false, + "description": "", "properties": { "Key": { "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", @@ -28,7 +29,7 @@ "type": "object" } }, - "description": "Resource Type definition for AWS::SQS::Queue", + "description": "The ``AWS::SQS::Queue`` resource creates an SQS standard or FIFO queue.\n Keep the following caveats in mind:\n + If you don't specify the ``FifoQueue`` property, SQS creates a standard queue.\n You can't change the queue type after you create it and you can't convert an existing standard queue into a FIFO queue. You must either create a new FIFO queue for your application or delete your existing standard queue and recreate it as a FIFO queue. For more information, see [Moving from a standard queue to a FIFO queue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-moving.html) in the *Developer Guide*. \n + If you don't provide a value for a property, the queue is created with the default value for the property.\n + If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.\n + To successfully create a new queue, you must provide a queue name that adheres to the [limits related to queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/limits-queues.html) and is unique within the scope of your queues.\n \n For more information about creating FIFO (first-in-first-out) queues, see [Creating an queue ()](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/screate-queue-cloudformation.html) in the *Developer Guide*.", "handlers": { "create": { "permissions": [ @@ -71,77 +72,77 @@ ], "properties": { "Arn": { - "description": "Amazon Resource Name (ARN) of the queue.", + "description": "", "type": "string" }, "ContentBasedDeduplication": { - "description": "For first-in-first-out (FIFO) queues, specifies whether to enable content-based deduplication. During the deduplication interval, Amazon SQS treats messages that are sent with identical content as duplicates and delivers only one copy of the message.", + "description": "For first-in-first-out (FIFO) queues, specifies whether to enable content-based deduplication. During the deduplication interval, SQS treats messages that are sent with identical content as duplicates and delivers only one copy of the message. For more information, see the ``ContentBasedDeduplication`` attribute for the ``CreateQueue`` action in the *API Reference*.", "type": "boolean" }, "DeduplicationScope": { - "description": "Specifies whether message deduplication occurs at the message group or queue level. Valid values are messageGroup and queue.", + "description": "For high throughput for FIFO queues, specifies whether message deduplication occurs at the message group or queue level. Valid values are ``messageGroup`` and ``queue``.\n To enable high throughput for a FIFO queue, set this attribute to ``messageGroup`` *and* set the ``FifoThroughputLimit`` attribute to ``perMessageGroupId``. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see [High throughput for FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html) and [Quotas related to messages](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) in the *Developer Guide*.", "type": "string" }, "DelaySeconds": { - "description": "The time in seconds for which the delivery of all messages in the queue is delayed. You can specify an integer value of 0 to 900 (15 minutes). The default value is 0.", + "description": "The time in seconds for which the delivery of all messages in the queue is delayed. You can specify an integer value of ``0`` to ``900`` (15 minutes). The default value is ``0``.", "type": "integer" }, "FifoQueue": { - "description": "If set to true, creates a FIFO queue. If you don't specify this property, Amazon SQS creates a standard queue.", + "description": "If set to true, creates a FIFO queue. If you don't specify this property, SQS creates a standard queue. For more information, see [FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html) in the *Developer Guide*.", "type": "boolean" }, "FifoThroughputLimit": { - "description": "Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId. The perMessageGroupId value is allowed only when the value for DeduplicationScope is messageGroup.", + "description": "For high throughput for FIFO queues, specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are ``perQueue`` and ``perMessageGroupId``.\n To enable high throughput for a FIFO queue, set this attribute to ``perMessageGroupId`` *and* set the ``DeduplicationScope`` attribute to ``messageGroup``. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see [High throughput for FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html) and [Quotas related to messages](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) in the *Developer Guide*.", "type": "string" }, "KmsDataKeyReusePeriodSeconds": { - "description": "The length of time in seconds for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. The value must be an integer between 60 (1 minute) and 86,400 (24 hours). The default is 300 (5 minutes).", + "description": "The length of time in seconds for which SQS can reuse a data key to encrypt or decrypt messages before calling KMS again. The value must be an integer between 60 (1 minute) and 86,400 (24 hours). The default is 300 (5 minutes).\n A shorter time period provides better security, but results in more calls to 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 *Developer Guide*.", "type": "integer" }, "KmsMasterKeyId": { - "description": "The ID of an AWS managed customer master key (CMK) for Amazon SQS or a custom CMK. To use the AWS managed CMK for Amazon SQS, specify the (default) alias alias/aws/sqs.", + "description": "The ID of an AWS Key Management Service (KMS) for SQS, or a custom KMS. To use the AWS managed KMS for SQS, specify a (default) alias ARN, alias name (e.g. ``alias/aws/sqs``), key ARN, or key ID. For more information, see the following:\n + [Encryption at rest](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html) in the *Developer Guide* \n + [CreateQueue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html) in the *API Reference* \n + [Request Parameters](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters) in the *Key Management Service API Reference* \n + The Key Management Service (KMS) section of the [Best Practices](https://docs.aws.amazon.com/https://d0.awsstatic.com/whitepapers/aws-kms-best-practices.pdf) whitepaper", "type": "string" }, "MaximumMessageSize": { - "description": "The limit of how many bytes that a message can contain before Amazon SQS rejects it. You can specify an integer value from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). The default value is 262,144 (256 KiB).", + "description": "The limit of how many bytes that a message can contain before SQS rejects it. You can specify an integer value from ``1,024`` bytes (1 KiB) to ``262,144`` bytes (256 KiB). The default value is ``262,144`` (256 KiB).", "type": "integer" }, "MessageRetentionPeriod": { - "description": "The number of seconds that Amazon SQS retains a message. You can specify an integer value from 60 seconds (1 minute) to 1,209,600 seconds (14 days). The default value is 345,600 seconds (4 days).", + "description": "The number of seconds that SQS retains a message. You can specify an integer value from ``60`` seconds (1 minute) to ``1,209,600`` seconds (14 days). The default value is ``345,600`` seconds (4 days).", "type": "integer" }, "QueueName": { - "description": "A name for the queue. To create a FIFO queue, the name of your FIFO queue must end with the .fifo suffix.", + "description": "A name for the queue. To create a FIFO queue, the name of your FIFO queue must end with the ``.fifo`` suffix. For more information, see [FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html) in the *Developer Guide*.\n If you don't specify a name, CFN generates a unique physical ID and uses that ID for the queue name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) in the *User Guide*. \n If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.", "type": "string" }, "QueueUrl": { - "description": "URL of the source queue.", + "description": "", "type": "string" }, "ReceiveMessageWaitTimeSeconds": { - "description": "Specifies the duration, in seconds, that the ReceiveMessage action call waits until a message is in the queue in order to include it in the response, rather than returning an empty response if a message isn't yet available. You can specify an integer from 1 to 20. Short polling is used as the default or when you specify 0 for this property.", + "description": "Specifies the duration, in seconds, that the ReceiveMessage action call waits until a message is in the queue in order to include it in the response, rather than returning an empty response if a message isn't yet available. You can specify an integer from 1 to 20. Short polling is used as the default or when you specify 0 for this property. For more information, see [Consuming messages using long polling](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-short-and-long-polling.html#sqs-long-polling) in the *Developer Guide*.", "type": "integer" }, "RedriveAllowPolicy": { - "description": "The string that includes the parameters for the permissions for the dead-letter queue redrive permission and which source queues can specify dead-letter queues as a JSON object.", + "description": "The string that includes the parameters for the permissions for the dead-letter queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:\n + ``redrivePermission``: The permission type that defines which source queues can specify the current queue as the dead-letter queue. Valid values are:\n + ``allowAll``: (Default) Any source queues in this AWS account in the same Region can specify this queue as the dead-letter queue.\n + ``denyAll``: No source queues can specify this queue as the dead-letter queue.\n + ``byQueue``: Only queues specified by the ``sourceQueueArns`` parameter can specify this queue as the dead-letter queue.\n \n + ``sourceQueueArns``: The Amazon Resource Names (ARN)s of the source queues that can specify this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the ``redrivePermission`` parameter is set to ``byQueue``. You can specify up to 10 source queue ARNs. To allow more than 10 source queues to specify dead-letter queues, set the ``redrivePermission`` parameter to ``allowAll``.", "type": [ "object", "string" ] }, "RedrivePolicy": { - "description": "A string that includes the parameters for the dead-letter queue functionality (redrive policy) of the source queue.", + "description": "The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. The parameters are as follows:\n + ``deadLetterTargetArn``: The Amazon Resource Name (ARN) of the dead-letter queue to which SQS moves messages after the value of ``maxReceiveCount`` is exceeded.\n + ``maxReceiveCount``: The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the ``ReceiveCount`` for a message exceeds the ``maxReceiveCount`` for a queue, SQS moves the message to the dead-letter-queue.\n \n The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue.\n *JSON* \n ``{ \"deadLetterTargetArn\" : String, \"maxReceiveCount\" : Integer }`` \n *YAML* \n ``deadLetterTargetArn : String`` \n ``maxReceiveCount : Integer``", "type": [ "object", "string" ] }, "SqsManagedSseEnabled": { - "description": "Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (e.g. SSE-KMS or SSE-SQS ).", + "description": "Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (for example, [SSE-KMS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html) or [SSE-SQS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html)). When ``SqsManagedSseEnabled`` is not defined, ``SSE-SQS`` encryption is enabled by default.", "type": "boolean" }, "Tags": { - "description": "The tags that you attach to this queue.", + "description": "The tags that you attach to this queue. For more information, see [Resource tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) in the *User Guide*.", "insertionOrder": false, "items": { "$ref": "#/definitions/Tag" @@ -150,7 +151,7 @@ "uniqueItems": false }, "VisibilityTimeout": { - "description": "The length of time during which a message will be unavailable after a message is delivered from the queue. This blocks other components from receiving the same message and gives the initial component time to process and delete the message from the queue. Values 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.", + "description": "The length of time during which a message will be unavailable after a message is delivered from the queue. This blocks other components from receiving the same message and gives the initial component time to process and delete the message from the queue.\n Values 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.\n For more information about SQS queue visibility timeouts, see [Visibility timeout](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) in the *Developer Guide*.", "type": "integer" } }, diff --git a/artifacts/types/AWS::SQS::QueueInlinePolicy.json b/artifacts/types/AWS::SQS::QueueInlinePolicy.json index 6f5326c6..4aa0160c 100644 --- a/artifacts/types/AWS::SQS::QueueInlinePolicy.json +++ b/artifacts/types/AWS::SQS::QueueInlinePolicy.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SQS-QueueInlinePolicy", "type": "AWS::SQS::QueueInlinePolicy", - "time": "2023-07-27T15:40:52.8Z", + "time": "2024-06-11T16:58:49.154Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::SSM::Association.json b/artifacts/types/AWS::SSM::Association.json index ab274742..ffb6ea30 100644 --- a/artifacts/types/AWS::SSM::Association.json +++ b/artifacts/types/AWS::SSM::Association.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SSM-Association", "type": "AWS::SSM::Association", - "time": "2024-01-03T19:15:53.572Z", + "time": "2024-05-29T15:44:48.22Z", "schema": { "additionalProperties": false, "definitions": { @@ -23,6 +23,10 @@ "S3BucketName": { "maxLength": 63, "minLength": 3, + "relationshipRef": { + "propertyPath": "/properties/BucketName", + "typeName": "AWS::S3::Bucket" + }, "type": "string" }, "S3KeyPrefix": { @@ -58,6 +62,14 @@ }, "Values": { "items": { + "anyOf": [ + { + "relationshipRef": { + "propertyPath": "/properties/Id", + "typeName": "AWS::EC2::Instance" + } + } + ], "type": "string" }, "maxItems": 50, @@ -211,7 +223,7 @@ "additionalProperties": false, "description": "Parameter values that the SSM document uses at runtime.", "patternProperties": { - ".*{1,255}": { + ".{1,255}": { "$ref": "#/definitions/ParameterValues" } }, diff --git a/artifacts/types/AWS::SSM::Document.json b/artifacts/types/AWS::SSM::Document.json index 402b6e2c..3fec9639 100644 --- a/artifacts/types/AWS::SSM::Document.json +++ b/artifacts/types/AWS::SSM::Document.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SSM-Document", "type": "AWS::SSM::Document", - "time": "2023-11-09T18:25:52.918Z", + "time": "2024-06-20T16:53:33.783Z", "schema": { "additionalProperties": false, "conditionalCreateOnlyProperties": [ diff --git a/artifacts/types/AWS::SSM::Parameter.json b/artifacts/types/AWS::SSM::Parameter.json index 979b186d..6a962f3a 100644 --- a/artifacts/types/AWS::SSM::Parameter.json +++ b/artifacts/types/AWS::SSM::Parameter.json @@ -1,13 +1,13 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SSM-Parameter", "type": "AWS::SSM::Parameter", - "time": "2023-12-21T16:35:41.138Z", + "time": "2024-04-23T15:34:12.686Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ "/properties/Name" ], - "description": "Resource Type definition for AWS::SSM::Parameter", + "description": "The ``AWS::SSM::Parameter`` resource creates an SSM parameter in SYSlong Parameter Store.\n To create an SSM parameter, you must have the IAMlong (IAM) permissions ``ssm:PutParameter`` and ``ssm:AddTagsToResource``. On stack creation, CFNlong adds the following three tags to the parameter: ``aws:cloudformation:stack-name``, ``aws:cloudformation:logical-id``, and ``aws:cloudformation:stack-id``, in addition to any custom tags you specify.\n To add, update, or remove tags during stack update, you must have IAM permissions for both ``ssm:AddTagsToResource`` and ``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 *User Guide*.\n For 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 *User Guide* and [PutParameter](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_PutParameter.html) in the *API Reference*.", "handlers": { "create": { "permissions": [ @@ -47,11 +47,11 @@ ], "properties": { "AllowedPattern": { - "description": "The regular expression used to validate the parameter value.", + "description": "A regular expression used to validate the parameter value. For example, for ``String`` types with values restricted to numbers, you can specify the following: ``AllowedPattern=^\\d+$``", "type": "string" }, "DataType": { - "description": "The corresponding DataType of the parameter.", + "description": "The data type of the parameter, such as ``text`` or ``aws:ec2:image``. The default is ``text``.", "enum": [ "text", "aws:ec2:image" @@ -59,20 +59,20 @@ "type": "string" }, "Description": { - "description": "The information about the parameter.", + "description": "Information about the parameter.", "type": "string" }, "Name": { - "description": "The name of the parameter.", + "description": "The name of the parameter.\n The maximum length constraint listed below includes capacity for additional system attributes that aren't part of the name. The maximum length for a parameter name, including the full length of the parameter Amazon Resource Name (ARN), is 1011 characters. For example, the length of the following parameter name is 65 characters, not 20 characters: ``arn:aws:ssm:us-east-2:111222333444:parameter/ExampleParameterName``", "type": "string" }, "Policies": { - "description": "The policies attached to the parameter.", + "description": "Information about the policies assigned to a parameter.\n [Assigning parameter policies](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html) in the *User Guide*.", "type": "string" }, "Tags": { "additionalProperties": false, - "description": "A key-value pair to associate with a resource.", + "description": "Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs). Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a SYS parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter.", "patternProperties": { "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$": { "type": "string" @@ -81,7 +81,7 @@ "type": "object" }, "Tier": { - "description": "The corresponding tier of the parameter.", + "description": "The parameter tier.", "enum": [ "Standard", "Advanced", @@ -90,16 +90,15 @@ "type": "string" }, "Type": { - "description": "The type of the parameter.", + "description": "The type of parameter.", "enum": [ "String", - "StringList", - "SecureString" + "StringList" ], "type": "string" }, "Value": { - "description": "The value associated with the parameter.", + "description": "The parameter value.\n If type is ``StringList``, the system returns a comma-separated string with no spaces between commas in the ``Value`` field.", "type": "string" } }, diff --git a/artifacts/types/AWS::SSM::PatchBaseline.json b/artifacts/types/AWS::SSM::PatchBaseline.json index 5838c975..c057b8f8 100644 --- a/artifacts/types/AWS::SSM::PatchBaseline.json +++ b/artifacts/types/AWS::SSM::PatchBaseline.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SSM-PatchBaseline", "type": "AWS::SSM::PatchBaseline", - "time": "2024-01-03T18:56:10.916Z", + "time": "2024-06-24T16:26:35.228Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -299,7 +299,8 @@ "DEBIAN", "MACOS", "RASPBIAN", - "ROCKY_LINUX" + "ROCKY_LINUX", + "ALMA_LINUX" ], "type": "string" }, diff --git a/artifacts/types/AWS::SSM::ResourceDataSync.json b/artifacts/types/AWS::SSM::ResourceDataSync.json index d83778d0..a0eadb7c 100644 --- a/artifacts/types/AWS::SSM::ResourceDataSync.json +++ b/artifacts/types/AWS::SSM::ResourceDataSync.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SSM-ResourceDataSync", "type": "AWS::SSM::ResourceDataSync", - "time": "2023-11-18T00:07:28.701Z", + "time": "2024-05-14T15:11:39.912Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -184,6 +184,9 @@ "required": [ "SyncName" ], + "tagging": { + "taggable": false + }, "typeName": "AWS::SSM::ResourceDataSync" } } \ No newline at end of file diff --git a/artifacts/types/AWS::SSMContacts::Contact.json b/artifacts/types/AWS::SSMContacts::Contact.json index 7611e408..6f2ab4dc 100644 --- a/artifacts/types/AWS::SSMContacts::Contact.json +++ b/artifacts/types/AWS::SSMContacts::Contact.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SSMContacts-Contact", "type": "AWS::SSMContacts::Contact", - "time": "2023-08-03T19:54:39.542Z", + "time": "2024-03-12T15:59:22.786Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -178,8 +178,6 @@ "description": "Contact type, which specify type of contact. Currently supported values: ?PERSONAL?, ?SHARED?, ?OTHER?.", "enum": [ "PERSONAL", - "CUSTOM", - "SERVICE", "ESCALATION", "ONCALL_SCHEDULE" ], diff --git a/artifacts/types/AWS::SSMContacts::ContactChannel.json b/artifacts/types/AWS::SSMContacts::ContactChannel.json index 9f2c6631..b010c4a2 100644 --- a/artifacts/types/AWS::SSMContacts::ContactChannel.json +++ b/artifacts/types/AWS::SSMContacts::ContactChannel.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SSMContacts-ContactChannel", "type": "AWS::SSMContacts::ContactChannel", - "time": "2023-08-03T19:38:03.061Z", + "time": "2024-03-12T15:51:16.103Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::SSMContacts::Plan.json b/artifacts/types/AWS::SSMContacts::Plan.json index b09350e3..a621205c 100644 --- a/artifacts/types/AWS::SSMContacts::Plan.json +++ b/artifacts/types/AWS::SSMContacts::Plan.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SSMContacts-Plan", "type": "AWS::SSMContacts::Plan", - "time": "2023-08-03T19:44:41.095Z", + "time": "2024-03-12T15:54:19.819Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::SSMContacts::Rotation.json b/artifacts/types/AWS::SSMContacts::Rotation.json index 1ae329f0..3f190738 100644 --- a/artifacts/types/AWS::SSMContacts::Rotation.json +++ b/artifacts/types/AWS::SSMContacts::Rotation.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SSMContacts-Rotation", "type": "AWS::SSMContacts::Rotation", - "time": "2023-08-03T19:54:33.995Z", + "time": "2024-03-12T15:59:21.459Z", "schema": { "additionalProperties": false, "definitions": { diff --git a/artifacts/types/AWS::SSMIncidents::ReplicationSet.json b/artifacts/types/AWS::SSMIncidents::ReplicationSet.json index cf5c1d55..307ad1bb 100644 --- a/artifacts/types/AWS::SSMIncidents::ReplicationSet.json +++ b/artifacts/types/AWS::SSMIncidents::ReplicationSet.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SSMIncidents-ReplicationSet", "type": "AWS::SSMIncidents::ReplicationSet", - "time": "2024-01-04T02:15:41.866Z", + "time": "2024-06-19T23:18:29.786Z", "schema": { "additionalProperties": false, "definitions": { @@ -157,7 +157,13 @@ "Regions" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ssm-incidents.git", - "taggable": true, + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, "typeName": "AWS::SSMIncidents::ReplicationSet" } } \ No newline at end of file diff --git a/artifacts/types/AWS::SSMIncidents::ResponsePlan.json b/artifacts/types/AWS::SSMIncidents::ResponsePlan.json index 3256dc3d..73e0977a 100644 --- a/artifacts/types/AWS::SSMIncidents::ResponsePlan.json +++ b/artifacts/types/AWS::SSMIncidents::ResponsePlan.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SSMIncidents-ResponsePlan", "type": "AWS::SSMIncidents::ResponsePlan", - "time": "2024-01-03T23:01:22.646Z", + "time": "2024-06-19T23:23:30.892Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -332,7 +332,10 @@ "iam:PassRole", "secretsmanager:GetSecretValue", "kms:Decrypt", - "kms:GenerateDataKey*" + "kms:GenerateDataKey", + "kms:GenerateDataKeyPair", + "kms:GenerateDataKeyPairWithoutPlaintext", + "kms:GenerateDataKeyWithoutPlaintext" ] }, "delete": { @@ -362,7 +365,10 @@ "iam:PassRole", "secretsmanager:GetSecretValue", "kms:Decrypt", - "kms:GenerateDataKey*" + "kms:GenerateDataKey", + "kms:GenerateDataKeyPair", + "kms:GenerateDataKeyPairWithoutPlaintext", + "kms:GenerateDataKeyWithoutPlaintext" ] } }, @@ -448,7 +454,13 @@ "IncidentTemplate" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ssm-incidents.git", - "taggable": true, + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, "typeName": "AWS::SSMIncidents::ResponsePlan" } } \ No newline at end of file diff --git a/artifacts/types/AWS::SSO::Application.json b/artifacts/types/AWS::SSO::Application.json new file mode 100644 index 00000000..03ade5c7 --- /dev/null +++ b/artifacts/types/AWS::SSO::Application.json @@ -0,0 +1,205 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SSO-Application", + "type": "AWS::SSO::Application", + "time": "2024-05-03T12:37:47.023Z", + "schema": { + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/InstanceArn", + "/properties/ApplicationProviderArn" + ], + "definitions": { + "PortalOptionsConfiguration": { + "additionalProperties": false, + "description": "A structure that describes the options for the access portal associated with an application", + "properties": { + "SignInOptions": { + "$ref": "#/definitions/SignInOptions", + "description": "A structure that describes the sign-in options for the access portal" + }, + "Visibility": { + "description": "Indicates whether this application is visible in the access portal", + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + } + }, + "required": [], + "type": "object" + }, + "SignInOptions": { + "additionalProperties": false, + "description": "A structure that describes the sign-in options for an application portal", + "properties": { + "ApplicationUrl": { + "description": "The URL that accepts authentication requests for an application, this is a required parameter if the Origin parameter is APPLICATION", + "maxLength": 512, + "minLength": 1, + "pattern": "^http(s)?:\\/\\/[-a-zA-Z0-9+\u0026@#\\/%?=~_|!:,.;]*[-a-zA-Z0-9+\u0026bb@#\\/%?=~_|]$", + "type": "string" + }, + "Origin": { + "description": "This determines how IAM Identity Center navigates the user to the target application", + "enum": [ + "IDENTITY_CENTER", + "APPLICATION" + ], + "type": "string" + } + }, + "required": [ + "Origin" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "The metadata that you apply to the Identity Center (SSO) Application to help you categorize and organize them.", + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "pattern": "^[\\w+=,.@-]+$", + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "pattern": "^[\\w+=,.@-]+$", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for Identity Center (SSO) Application", + "handlers": { + "create": { + "permissions": [ + "sso:CreateApplication", + "sso:DescribeApplication", + "sso:TagResource" + ] + }, + "delete": { + "permissions": [ + "sso:DeleteApplication" + ] + }, + "list": { + "handlerSchema": { + "properties": { + "InstanceArn": { + "$ref": "resource-schema.json#/properties/InstanceArn" + } + }, + "required": [ + "InstanceArn" + ] + }, + "permissions": [ + "sso:ListApplications" + ] + }, + "read": { + "permissions": [ + "sso:DescribeApplication", + "sso:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "sso:UpdateApplication", + "sso:TagResource", + "sso:UntagResource", + "sso:ListTagsForResource", + "sso:DescribeApplication" + ] + } + }, + "primaryIdentifier": [ + "/properties/ApplicationArn" + ], + "properties": { + "ApplicationArn": { + "description": "The Application ARN that is returned upon creation of the Identity Center (SSO) Application", + "maxLength": 1224, + "minLength": 10, + "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}$", + "type": "string" + }, + "ApplicationProviderArn": { + "description": "The ARN of the application provider under which the operation will run", + "maxLength": 1224, + "minLength": 10, + "pattern": "^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::aws:applicationProvider/[a-zA-Z0-9-/]+$", + "type": "string" + }, + "Description": { + "description": "The description information for the Identity Center (SSO) Application", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "InstanceArn": { + "description": "The ARN of the instance of IAM Identity Center under which the operation will run", + "maxLength": 1224, + "minLength": 10, + "pattern": "^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}$", + "type": "string" + }, + "Name": { + "description": "The name you want to assign to this Identity Center (SSO) Application", + "maxLength": 255, + "minLength": 0, + "pattern": "^[\\w+=,.@-]+$", + "type": "string" + }, + "PortalOptions": { + "$ref": "#/definitions/PortalOptionsConfiguration", + "description": "A structure that describes the options for the portal associated with an application" + }, + "Status": { + "description": "Specifies whether the application is enabled or disabled", + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag", + "description": "Specifies tags to be attached to the application" + }, + "maxItems": 75, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/ApplicationArn" + ], + "required": [ + "Name", + "InstanceArn", + "ApplicationProviderArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-sso/aws-sso-application", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::SSO::Application" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::SSO::Instance.json b/artifacts/types/AWS::SSO::Instance.json new file mode 100644 index 00000000..f2d6221e --- /dev/null +++ b/artifacts/types/AWS::SSO::Instance.json @@ -0,0 +1,137 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SSO-Instance", + "type": "AWS::SSO::Instance", + "time": "2024-06-05T01:04:39.941Z", + "schema": { + "additionalProperties": false, + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "The metadata that you apply to the Identity Center (SSO) Instance to help you categorize and organize them.", + "properties": { + "Key": { + "maxLength": 128, + "minLength": 1, + "pattern": "[\\w+=,.@-]+", + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 0, + "pattern": "[\\w+=,.@-]+", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for Identity Center (SSO) Instance", + "handlers": { + "create": { + "permissions": [ + "sso:CreateInstance", + "sso:DescribeInstance", + "sso:TagResource", + "iam:CreateServiceLinkedRole", + "sso:TagInstance", + "sso:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "sso:DeleteInstance" + ] + }, + "list": { + "permissions": [ + "sso:ListInstances" + ] + }, + "read": { + "permissions": [ + "sso:DescribeInstance", + "sso:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "sso:UpdateInstance", + "sso:TagResource", + "sso:UntagResource", + "sso:ListTagsForResource", + "sso:TagInstance", + "sso:DescribeInstance" + ] + } + }, + "primaryIdentifier": [ + "/properties/InstanceArn" + ], + "properties": { + "IdentityStoreId": { + "description": "The ID of the identity store associated with the created Identity Center (SSO) Instance", + "maxLength": 64, + "minLength": 1, + "pattern": "^[a-zA-Z0-9-]*$", + "type": "string" + }, + "InstanceArn": { + "description": "The SSO Instance ARN that is returned upon creation of the Identity Center (SSO) Instance", + "maxLength": 1224, + "minLength": 10, + "pattern": "^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}$", + "type": "string" + }, + "Name": { + "description": "The name you want to assign to this Identity Center (SSO) Instance", + "maxLength": 32, + "minLength": 1, + "pattern": "^[\\w+=,.@-]+$", + "type": "string" + }, + "OwnerAccountId": { + "description": "The AWS accountId of the owner of the Identity Center (SSO) Instance", + "maxLength": 12, + "minLength": 12, + "pattern": "^\\d{12}?$", + "type": "string" + }, + "Status": { + "description": "The status of the Identity Center (SSO) Instance, create_in_progress/delete_in_progress/active", + "enum": [ + "CREATE_IN_PROGRESS", + "DELETE_IN_PROGRESS", + "ACTIVE" + ], + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 75, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/InstanceArn", + "/properties/OwnerAccountId", + "/properties/IdentityStoreId", + "/properties/Status" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-sso/aws-sso-instance", + "tagging": { + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::SSO::Instance" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::SSO::InstanceAccessControlAttributeConfiguration.json b/artifacts/types/AWS::SSO::InstanceAccessControlAttributeConfiguration.json index 19402cad..377b0e9d 100644 --- a/artifacts/types/AWS::SSO::InstanceAccessControlAttributeConfiguration.json +++ b/artifacts/types/AWS::SSO::InstanceAccessControlAttributeConfiguration.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SSO-InstanceAccessControlAttributeConfiguration", "type": "AWS::SSO::InstanceAccessControlAttributeConfiguration", - "time": "2024-01-04T19:40:54.545Z", + "time": "2024-05-09T18:34:07.262Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::SSO::PermissionSet.json b/artifacts/types/AWS::SSO::PermissionSet.json index fa38b934..c317b76d 100644 --- a/artifacts/types/AWS::SSO::PermissionSet.json +++ b/artifacts/types/AWS::SSO::PermissionSet.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SSO-PermissionSet", "type": "AWS::SSO::PermissionSet", - "time": "2024-01-04T19:47:08.51Z", + "time": "2024-05-09T18:38:21.309Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::SageMaker::AppImageConfig.json b/artifacts/types/AWS::SageMaker::AppImageConfig.json index 993d0e9c..92635353 100644 --- a/artifacts/types/AWS::SageMaker::AppImageConfig.json +++ b/artifacts/types/AWS::SageMaker::AppImageConfig.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SageMaker-AppImageConfig", "type": "AWS::SageMaker::AppImageConfig", - "time": "2023-12-12T01:15:41.353Z", + "time": "2024-06-24T15:23:49.679Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -9,6 +9,90 @@ "/properties/Tags" ], "definitions": { + "CodeEditorAppImageConfig": { + "additionalProperties": false, + "description": "The configuration for the kernels in a SageMaker image running as a CodeEditor app.", + "properties": { + "ContainerConfig": { + "$ref": "#/definitions/ContainerConfig", + "description": "The container configuration for a SageMaker image." + } + }, + "type": "object" + }, + "ContainerConfig": { + "additionalProperties": false, + "description": "The container configuration for a SageMaker image.", + "properties": { + "ContainerArguments": { + "description": "A list of arguments to apply to the container.", + "items": { + "$ref": "#/definitions/CustomImageContainerArguments" + }, + "maxItems": 50, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, + "ContainerEntrypoint": { + "description": "The custom entry point to use on container.", + "items": { + "$ref": "#/definitions/CustomImageContainerEntrypoint" + }, + "maxItems": 1, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, + "ContainerEnvironmentVariables": { + "description": "A list of variables to apply to the custom container.", + "items": { + "$ref": "#/definitions/CustomImageContainerEnvironmentVariable" + }, + "maxItems": 25, + "minItems": 0, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "CustomImageContainerArguments": { + "description": "The container image arguments", + "maxLength": 64, + "minLength": 1, + "pattern": "^(?!\\s*$).+", + "type": "string" + }, + "CustomImageContainerEntrypoint": { + "description": "The container entry point", + "maxLength": 256, + "minLength": 1, + "pattern": "^(?!\\s*$).+", + "type": "string" + }, + "CustomImageContainerEnvironmentVariable": { + "additionalProperties": false, + "properties": { + "Key": { + "maxLength": 256, + "minLength": 1, + "pattern": "^(?!\\s*$).+", + "type": "string" + }, + "Value": { + "maxLength": 256, + "minLength": 1, + "pattern": "^(?!\\s*$).+", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, "FileSystemConfig": { "additionalProperties": false, "description": "The Amazon Elastic File System (EFS) storage configuration for a SageMaker image.", @@ -35,6 +119,17 @@ }, "type": "object" }, + "JupyterLabAppImageConfig": { + "additionalProperties": false, + "description": "The configuration for the kernels in a SageMaker image running as a JupyterLab app.", + "properties": { + "ContainerConfig": { + "$ref": "#/definitions/ContainerConfig", + "description": "The container configuration for a SageMaker image." + } + }, + "type": "object" + }, "KernelGatewayImageConfig": { "additionalProperties": false, "description": "The configuration for the file system and kernels in a SageMaker image running as a KernelGateway app.", @@ -110,7 +205,8 @@ }, "delete": { "permissions": [ - "sagemaker:DeleteAppImageConfig" + "sagemaker:DeleteAppImageConfig", + "sagemaker:DescribeAppImageConfig" ] }, "list": { @@ -148,6 +244,14 @@ "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}", "type": "string" }, + "CodeEditorAppImageConfig": { + "$ref": "#/definitions/CodeEditorAppImageConfig", + "description": "The CodeEditorAppImageConfig." + }, + "JupyterLabAppImageConfig": { + "$ref": "#/definitions/JupyterLabAppImageConfig", + "description": "The JupyterLabAppImageConfig." + }, "KernelGatewayImageConfig": { "$ref": "#/definitions/KernelGatewayImageConfig", "description": "The KernelGatewayImageConfig." diff --git a/artifacts/types/AWS::SageMaker::Device.json b/artifacts/types/AWS::SageMaker::Device.json index fc3c2464..3be11bc6 100644 --- a/artifacts/types/AWS::SageMaker::Device.json +++ b/artifacts/types/AWS::SageMaker::Device.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SageMaker-Device", "type": "AWS::SageMaker::Device", - "time": "2023-10-31T19:00:21.113Z", + "time": "2024-06-14T20:45:07.331Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::SageMaker::DeviceFleet.json b/artifacts/types/AWS::SageMaker::DeviceFleet.json index 421bdfa2..8a7a52c4 100644 --- a/artifacts/types/AWS::SageMaker::DeviceFleet.json +++ b/artifacts/types/AWS::SageMaker::DeviceFleet.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SageMaker-DeviceFleet", "type": "AWS::SageMaker::DeviceFleet", - "time": "2023-10-31T19:00:12.377Z", + "time": "2024-06-14T20:44:38.982Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::SageMaker::Domain.json b/artifacts/types/AWS::SageMaker::Domain.json index e3c6073b..c11bd2ad 100644 --- a/artifacts/types/AWS::SageMaker::Domain.json +++ b/artifacts/types/AWS::SageMaker::Domain.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SageMaker-Domain", "type": "AWS::SageMaker::Domain", - "time": "2023-12-12T01:00:49.946Z", + "time": "2024-06-24T15:27:14.341Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -17,6 +17,16 @@ "additionalProperties": false, "description": "The CodeEditor app settings.", "properties": { + "CustomImages": { + "description": "A list of custom images for use for CodeEditor apps.", + "items": { + "$ref": "#/definitions/CustomImage" + }, + "maxItems": 30, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, "DefaultResourceSpec": { "$ref": "#/definitions/ResourceSpec", "description": "The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the CodeEditor app." @@ -129,6 +139,19 @@ "additionalProperties": false, "description": "A collection of settings that apply to spaces of Amazon SageMaker Studio. These settings are specified when the Create/Update Domain API is called.", "properties": { + "CustomFileSystemConfigs": { + "items": { + "$ref": "#/definitions/CustomFileSystemConfig" + }, + "maxItems": 2, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "CustomPosixUserConfig": { + "$ref": "#/definitions/CustomPosixUserConfig", + "description": "The Jupyter lab's custom posix user configurations." + }, "ExecutionRole": { "description": "The execution role for the space.", "maxLength": 2048, @@ -136,6 +159,10 @@ "pattern": "^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$", "type": "string" }, + "JupyterLabAppSettings": { + "$ref": "#/definitions/JupyterLabAppSettings", + "description": "The Jupyter lab's app settings." + }, "JupyterServerAppSettings": { "$ref": "#/definitions/JupyterServerAppSettings", "description": "The Jupyter server's app settings." @@ -156,6 +183,10 @@ "minItems": 0, "type": "array", "uniqueItems": false + }, + "SpaceStorageSettings": { + "$ref": "#/definitions/DefaultSpaceStorageSettings", + "description": "The Jupyter lab's space storage settings." } }, "required": [ @@ -173,10 +204,41 @@ }, "type": "object" }, + "DockerSettings": { + "additionalProperties": false, + "description": "A collection of settings that are required to start docker-proxy server.", + "properties": { + "EnableDockerAccess": { + "description": "The flag to enable/disable docker-proxy server", + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + }, + "VpcOnlyTrustedAccounts": { + "description": "A list of account id's that would be used to pull images from in VpcOnly mode", + "insertionOrder": false, + "items": { + "maxLength": 12, + "pattern": "^[0-9]$", + "type": "string" + }, + "maxItems": 10, + "minItems": 0, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, "DomainSettings": { "additionalProperties": false, "description": "A collection of Domain settings.", "properties": { + "DockerSettings": { + "$ref": "#/definitions/DockerSettings" + }, "RStudioServerProDomainSettings": { "$ref": "#/definitions/RStudioServerProDomainSettings" }, diff --git a/artifacts/types/AWS::SageMaker::FeatureGroup.json b/artifacts/types/AWS::SageMaker::FeatureGroup.json index d48fe85b..c1b8687a 100644 --- a/artifacts/types/AWS::SageMaker::FeatureGroup.json +++ b/artifacts/types/AWS::SageMaker::FeatureGroup.json @@ -1,14 +1,16 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SageMaker-FeatureGroup", "type": "AWS::SageMaker::FeatureGroup", - "time": "2024-01-04T17:23:36.612Z", + "time": "2024-04-16T16:00:53.438Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ "/properties/FeatureGroupName", "/properties/RecordIdentifierFeatureName", "/properties/EventTimeFeatureName", - "/properties/OnlineStoreConfig", + "/properties/OnlineStoreConfig/SecurityConfig", + "/properties/OnlineStoreConfig/EnableOnlineStore", + "/properties/OnlineStoreConfig/StorageType", "/properties/OfflineStoreConfig", "/properties/RoleArn", "/properties/Description", @@ -129,6 +131,62 @@ "Key" ], "type": "object" + }, + "ThroughputConfig": { + "additionalProperties": false, + "properties": { + "ProvisionedReadCapacityUnits": { + "description": "For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling.", + "type": "integer" + }, + "ProvisionedWriteCapacityUnits": { + "description": "For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling.", + "type": "integer" + }, + "ThroughputMode": { + "$ref": "#/definitions/ThroughputMode" + } + }, + "required": [ + "ThroughputMode" + ], + "type": "object" + }, + "ThroughputMode": { + "description": "Throughput mode configuration of the feature group", + "enum": [ + "OnDemand", + "Provisioned" + ], + "type": "string" + }, + "TtlDuration": { + "additionalProperties": false, + "description": "TTL configuration of the feature group", + "properties": { + "Unit": { + "$ref": "#/definitions/Unit" + }, + "Value": { + "$ref": "#/definitions/Value" + } + }, + "type": "object" + }, + "Unit": { + "description": "Unit of ttl configuration", + "enum": [ + "Seconds", + "Minutes", + "Hours", + "Days", + "Weeks" + ], + "type": "string" + }, + "Value": { + "description": "Value of ttl configuration", + "type": "integer" } }, "description": "Resource Type definition for AWS::SageMaker::FeatureGroup", @@ -249,6 +307,9 @@ }, "StorageType": { "$ref": "#/definitions/StorageType" + }, + "TtlDuration": { + "$ref": "#/definitions/TtlDuration" } }, "type": "object" @@ -276,6 +337,9 @@ "maxItems": 50, "type": "array", "uniqueItems": false + }, + "ThroughputConfig": { + "$ref": "#/definitions/ThroughputConfig" } }, "readOnlyProperties": [ diff --git a/artifacts/types/AWS::SageMaker::Image.json b/artifacts/types/AWS::SageMaker::Image.json index d73a59a2..d9080ebb 100644 --- a/artifacts/types/AWS::SageMaker::Image.json +++ b/artifacts/types/AWS::SageMaker::Image.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SageMaker-Image", "type": "AWS::SageMaker::Image", - "time": "2023-11-06T17:54:07.856Z", + "time": "2024-05-01T15:58:26.329Z", "schema": { "additionalIdentifiers": [ [ diff --git a/artifacts/types/AWS::SageMaker::ImageVersion.json b/artifacts/types/AWS::SageMaker::ImageVersion.json index face3b44..1b0c7768 100644 --- a/artifacts/types/AWS::SageMaker::ImageVersion.json +++ b/artifacts/types/AWS::SageMaker::ImageVersion.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SageMaker-ImageVersion", "type": "AWS::SageMaker::ImageVersion", - "time": "2023-11-06T17:54:29.547Z", + "time": "2024-05-01T16:17:04.49Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::SageMaker::InferenceComponent.json b/artifacts/types/AWS::SageMaker::InferenceComponent.json index 72046dda..29551466 100644 --- a/artifacts/types/AWS::SageMaker::InferenceComponent.json +++ b/artifacts/types/AWS::SageMaker::InferenceComponent.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SageMaker-InferenceComponent", "type": "AWS::SageMaker::InferenceComponent", - "time": "2023-11-29T19:40:55.847Z", + "time": "2024-04-24T18:17:06.972Z", "schema": { "additionalProperties": false, "definitions": { diff --git a/artifacts/types/AWS::SageMaker::InferenceExperiment.json b/artifacts/types/AWS::SageMaker::InferenceExperiment.json index 516e40c5..ba207067 100644 --- a/artifacts/types/AWS::SageMaker::InferenceExperiment.json +++ b/artifacts/types/AWS::SageMaker::InferenceExperiment.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SageMaker-InferenceExperiment", "type": "AWS::SageMaker::InferenceExperiment", - "time": "2024-01-02T17:19:45.915Z", + "time": "2024-06-04T16:11:38.161Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::SageMaker::ModelCard.json b/artifacts/types/AWS::SageMaker::ModelCard.json index dcc85f90..cb2a1b55 100644 --- a/artifacts/types/AWS::SageMaker::ModelCard.json +++ b/artifacts/types/AWS::SageMaker::ModelCard.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SageMaker-ModelCard", "type": "AWS::SageMaker::ModelCard", - "time": "2024-01-03T16:45:43.805Z", + "time": "2024-06-19T15:47:17.98Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -875,6 +875,7 @@ "create": { "permissions": [ "sagemaker:CreateModelCard", + "sagemaker:DescribeModel", "kms:DescribeKey", "kms:GenerateDataKey", "kms:CreateGrant", @@ -914,6 +915,7 @@ "permissions": [ "sagemaker:UpdateModelCard", "sagemaker:DescribeModelCard", + "sagemaker:DescribeModel", "kms:GenerateDataKey", "kms:Decrypt", "sagemaker:DescribeModelPackageGroup", diff --git a/artifacts/types/AWS::SageMaker::ModelPackage.json b/artifacts/types/AWS::SageMaker::ModelPackage.json index 72c8e28b..5abc4a6d 100644 --- a/artifacts/types/AWS::SageMaker::ModelPackage.json +++ b/artifacts/types/AWS::SageMaker::ModelPackage.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SageMaker-ModelPackage", "type": "AWS::SageMaker::ModelPackage", - "time": "2023-12-19T05:37:33.723Z", + "time": "2024-06-11T05:24:51.369Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::SageMaker::ModelPackageGroup.json b/artifacts/types/AWS::SageMaker::ModelPackageGroup.json index 6abb3165..65670734 100644 --- a/artifacts/types/AWS::SageMaker::ModelPackageGroup.json +++ b/artifacts/types/AWS::SageMaker::ModelPackageGroup.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SageMaker-ModelPackageGroup", "type": "AWS::SageMaker::ModelPackageGroup", - "time": "2023-12-19T04:25:20.22Z", + "time": "2024-06-11T04:21:16.143Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::SageMaker::MonitoringSchedule.json b/artifacts/types/AWS::SageMaker::MonitoringSchedule.json index fbe109a8..d60e275d 100644 --- a/artifacts/types/AWS::SageMaker::MonitoringSchedule.json +++ b/artifacts/types/AWS::SageMaker::MonitoringSchedule.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SageMaker-MonitoringSchedule", "type": "AWS::SageMaker::MonitoringSchedule", - "time": "2024-01-02T16:51:48.623Z", + "time": "2024-01-31T16:15:54.37Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::SageMaker::Pipeline.json b/artifacts/types/AWS::SageMaker::Pipeline.json index 5faf1499..516a4a8a 100644 --- a/artifacts/types/AWS::SageMaker::Pipeline.json +++ b/artifacts/types/AWS::SageMaker::Pipeline.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SageMaker-Pipeline", "type": "AWS::SageMaker::Pipeline", - "time": "2024-01-04T16:54:42.243Z", + "time": "2024-06-11T16:54:20.64Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::SageMaker::Project.json b/artifacts/types/AWS::SageMaker::Project.json index 05620cb7..98016cfc 100644 --- a/artifacts/types/AWS::SageMaker::Project.json +++ b/artifacts/types/AWS::SageMaker::Project.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SageMaker-Project", "type": "AWS::SageMaker::Project", - "time": "2023-12-19T05:45:48.343Z", + "time": "2024-06-11T05:31:22.387Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::SageMaker::Space.json b/artifacts/types/AWS::SageMaker::Space.json index c838203e..dcdaf72a 100644 --- a/artifacts/types/AWS::SageMaker::Space.json +++ b/artifacts/types/AWS::SageMaker::Space.json @@ -1,14 +1,61 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SageMaker-Space", "type": "AWS::SageMaker::Space", - "time": "2023-12-12T01:16:11.045Z", + "time": "2024-06-24T15:37:12.011Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ "/properties/DomainId", - "/properties/SpaceName" + "/properties/SpaceName", + "/properties/SpaceSharingSettings", + "/properties/OwnershipSettings" ], "definitions": { + "AppType": { + "enum": [ + "JupyterServer", + "KernelGateway", + "TensorBoard", + "RStudioServerPro", + "RSessionGateway", + "JupyterLab", + "CodeEditor" + ], + "type": "string" + }, + "CodeRepository": { + "additionalProperties": false, + "properties": { + "RepositoryUrl": { + "description": "A CodeRepository (valid URL) to be used within Jupyter's Git extension.", + "maxLength": 256, + "pattern": "^https://([.\\-_a-zA-Z0-9]+/?){3,1016}$", + "type": "string" + } + }, + "required": [ + "RepositoryUrl" + ], + "type": "object" + }, + "CustomFileSystem": { + "additionalProperties": false, + "properties": { + "EFSFileSystem": { + "$ref": "#/definitions/EFSFileSystem" + } + }, + "type": "object" + }, + "CustomFileSystems": { + "items": { + "$ref": "#/definitions/CustomFileSystem" + }, + "maxItems": 1, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, "CustomImage": { "additionalProperties": false, "description": "A custom SageMaker image.", @@ -37,6 +84,35 @@ ], "type": "object" }, + "EFSFileSystem": { + "additionalProperties": false, + "properties": { + "FileSystemId": { + "maxLength": 21, + "minLength": 11, + "pattern": "^(fs-[0-9a-f]{8,})$", + "type": "string" + } + }, + "required": [ + "FileSystemId" + ], + "type": "object" + }, + "EbsStorageSettings": { + "additionalProperties": false, + "description": "Properties related to the space's Amazon Elastic Block Store volume.", + "properties": { + "EbsVolumeSizeInGb": { + "$ref": "#/definitions/SpaceEbsVolumeSizeInGb", + "description": "Size of the Amazon EBS volume in Gb" + } + }, + "required": [ + "EbsVolumeSizeInGb" + ], + "type": "object" + }, "JupyterServerAppSettings": { "additionalProperties": false, "description": "The JupyterServer app settings.", @@ -68,6 +144,20 @@ }, "type": "object" }, + "OwnershipSettings": { + "additionalProperties": false, + "properties": { + "OwnerUserProfileName": { + "maxLength": 63, + "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}", + "type": "string" + } + }, + "required": [ + "OwnerUserProfileName" + ], + "type": "object" + }, "ResourceSpec": { "additionalProperties": false, "properties": { @@ -133,7 +223,10 @@ "ml.g5.48xlarge", "ml.p4d.24xlarge", "ml.p4de.24xlarge", - "ml.geospatial.interactive" + "ml.geospatial.interactive", + "ml.trn1.2xlarge", + "ml.trn1.32xlarge", + "ml.trn1n.32xlarge" ], "type": "string" }, @@ -152,10 +245,59 @@ }, "type": "object" }, + "SpaceCodeEditorAppSettings": { + "additionalProperties": false, + "description": "The CodeEditor app settings.", + "properties": { + "DefaultResourceSpec": { + "$ref": "#/definitions/ResourceSpec" + } + }, + "type": "object" + }, + "SpaceEbsVolumeSizeInGb": { + "maximum": 16384, + "minimum": 5, + "type": "integer" + }, + "SpaceJupyterLabAppSettings": { + "additionalProperties": false, + "description": "The JupyterServer app settings.", + "properties": { + "CodeRepositories": { + "description": "A list of CodeRepositories available for use with JupyterLab apps.", + "items": { + "$ref": "#/definitions/CodeRepository" + }, + "maxItems": 30, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, + "DefaultResourceSpec": { + "$ref": "#/definitions/ResourceSpec" + } + }, + "type": "object" + }, "SpaceSettings": { "additionalProperties": false, "description": "A collection of settings that apply to spaces of Amazon SageMaker Studio. These settings are specified when the CreateSpace API is called.", "properties": { + "AppType": { + "$ref": "#/definitions/AppType" + }, + "CodeEditorAppSettings": { + "$ref": "#/definitions/SpaceCodeEditorAppSettings", + "description": "The CodeEditor app settings." + }, + "CustomFileSystems": { + "$ref": "#/definitions/CustomFileSystems" + }, + "JupyterLabAppSettings": { + "$ref": "#/definitions/SpaceJupyterLabAppSettings", + "description": "The JupyterLab app settings." + }, "JupyterServerAppSettings": { "$ref": "#/definitions/JupyterServerAppSettings", "description": "The Jupyter server's app settings." @@ -163,6 +305,35 @@ "KernelGatewayAppSettings": { "$ref": "#/definitions/KernelGatewayAppSettings", "description": "The kernel gateway app settings." + }, + "SpaceStorageSettings": { + "$ref": "#/definitions/SpaceStorageSettings", + "description": "Default storage settings for a space." + } + }, + "type": "object" + }, + "SpaceSharingSettings": { + "additionalProperties": false, + "properties": { + "SharingType": { + "enum": [ + "Private", + "Shared" + ], + "type": "string" + } + }, + "required": [ + "SharingType" + ], + "type": "object" + }, + "SpaceStorageSettings": { + "additionalProperties": false, + "properties": { + "EbsStorageSettings": { + "$ref": "#/definitions/EbsStorageSettings" } }, "type": "object" @@ -230,12 +401,20 @@ "minLength": 1, "type": "string" }, + "OwnershipSettings": { + "$ref": "#/definitions/OwnershipSettings" + }, "SpaceArn": { "description": "The space Amazon Resource Name (ARN).", "maxLength": 256, "pattern": "arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:space/.*", "type": "string" }, + "SpaceDisplayName": { + "maxLength": 64, + "pattern": "^(?!\\s*$).+", + "type": "string" + }, "SpaceName": { "description": "A name for the Space.", "maxLength": 63, @@ -249,6 +428,9 @@ "minItems": 0, "uniqueItems": false }, + "SpaceSharingSettings": { + "$ref": "#/definitions/SpaceSharingSettings" + }, "Tags": { "description": "A list of tags to apply to the space.", "items": { @@ -258,10 +440,15 @@ "minItems": 0, "type": "array", "uniqueItems": false + }, + "Url": { + "maxLength": 1024, + "type": "string" } }, "readOnlyProperties": [ - "/properties/SpaceArn" + "/properties/SpaceArn", + "/properties/Url" ], "required": [ "DomainId", diff --git a/artifacts/types/AWS::SageMaker::UserProfile.json b/artifacts/types/AWS::SageMaker::UserProfile.json index be6ed482..ac688963 100644 --- a/artifacts/types/AWS::SageMaker::UserProfile.json +++ b/artifacts/types/AWS::SageMaker::UserProfile.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SageMaker-UserProfile", "type": "AWS::SageMaker::UserProfile", - "time": "2023-12-12T01:00:49.021Z", + "time": "2024-06-24T15:23:49.457Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -18,6 +18,16 @@ "additionalProperties": false, "description": "The CodeEditor app settings.", "properties": { + "CustomImages": { + "description": "A list of custom images for use for CodeEditor apps.", + "items": { + "$ref": "#/definitions/CustomImage" + }, + "maxItems": 30, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, "DefaultResourceSpec": { "$ref": "#/definitions/ResourceSpec", "description": "The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the CodeEditor app." diff --git a/artifacts/types/AWS::Scheduler::Schedule.json b/artifacts/types/AWS::Scheduler::Schedule.json index b9e535db..2f9e6d62 100644 --- a/artifacts/types/AWS::Scheduler::Schedule.json +++ b/artifacts/types/AWS::Scheduler::Schedule.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Scheduler-Schedule", "type": "AWS::Scheduler::Schedule", - "time": "2023-12-27T20:53:29.103Z", + "time": "2024-06-24T16:35:23.441Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Scheduler::ScheduleGroup.json b/artifacts/types/AWS::Scheduler::ScheduleGroup.json index 0c7a5b76..d0a8fca0 100644 --- a/artifacts/types/AWS::Scheduler::ScheduleGroup.json +++ b/artifacts/types/AWS::Scheduler::ScheduleGroup.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Scheduler-ScheduleGroup", "type": "AWS::Scheduler::ScheduleGroup", - "time": "2023-12-27T20:29:39.059Z", + "time": "2024-06-24T16:24:19.235Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::SecretsManager::Secret.json b/artifacts/types/AWS::SecretsManager::Secret.json index ba5e0183..25321560 100644 --- a/artifacts/types/AWS::SecretsManager::Secret.json +++ b/artifacts/types/AWS::SecretsManager::Secret.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SecretsManager-Secret", "type": "AWS::SecretsManager::Secret", - "time": "2023-12-26T16:43:50.906Z", + "time": "2024-06-24T15:56:04.138Z", "schema": { "$schema": "https://schema.cloudformation.us-east-1.amazonaws.com/provider.definition.schema.v1.json", "additionalProperties": false, @@ -11,45 +11,46 @@ "definitions": { "GenerateSecretString": { "additionalProperties": false, + "description": "Generates a random password. We recommend that you specify the maximum length and include every 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 in Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html).", "properties": { "ExcludeCharacters": { - "description": "A string that excludes characters in the generated password. By default, all characters from the included sets can be used. The string can be a minimum length of 0 characters and a maximum length of 7168 characters. ", + "description": "A string of the characters that you don't want in the password.", "type": "string" }, "ExcludeLowercase": { - "description": "Specifies the generated password should not include lowercase letters. By default, ecrets Manager disables this parameter, and the generated password can include lowercase False, and the generated password can include lowercase letters.", + "description": "Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.", "type": "boolean" }, "ExcludeNumbers": { - "description": "Specifies that the generated password should exclude digits. By default, Secrets Manager does not enable the parameter, False, and the generated password can include digits.", + "description": "Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers.", "type": "boolean" }, "ExcludePunctuation": { - "description": "Specifies that the generated password should not include punctuation characters. The default if you do not include this switch parameter is that punctuation characters can be included. ", + "description": "Specifies whether to exclude the following punctuation characters from the password: ``! \" # $ % \u0026 ' ( ) * + , - . / : ; \u003c = \u003e ? @ [ \\ ] ^ _ ` { | } ~``. If you don't include this switch, the password can contain punctuation.", "type": "boolean" }, "ExcludeUppercase": { - "description": "Specifies that the generated password should not include uppercase letters. The default behavior is False, and the generated password can include uppercase letters. ", + "description": "Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.", "type": "boolean" }, "GenerateStringKey": { - "description": "The JSON key name used to add the generated password to the JSON structure specified by the SecretStringTemplate parameter. If you specify this parameter, then you must also specify SecretStringTemplate. ", + "description": "The JSON key name for the key/value pair, where the value is the generated password. This pair is added to the JSON structure specified by the ``SecretStringTemplate`` parameter. If you specify this parameter, then you must also specify ``SecretStringTemplate``.", "type": "string" }, "IncludeSpace": { - "description": "Specifies that the generated password can include the space character. By default, Secrets Manager disables this parameter, and the generated password doesn't include space", + "description": "Specifies whether to include the space character. If you include this switch, the password can contain space characters.", "type": "boolean" }, "PasswordLength": { - "description": "The desired length of the generated password. The default value if you do not include this parameter is 32 characters. ", + "description": "The length of the password. If you don't include this parameter, the default length is 32 characters.", "type": "integer" }, "RequireEachIncludedType": { - "description": "Specifies whether the generated password must include at least one of every allowed character type. By default, Secrets Manager enables this parameter, and the generated password includes at least one of every character type.", + "description": "Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you don't include this switch, the password contains at least one of every character type.", "type": "boolean" }, "SecretStringTemplate": { - "description": "A properly structured JSON string that the generated password can be added to. If you specify this parameter, then you must also specify GenerateStringKey.", + "description": "A template that the generated string must match. When you make a change to this property, a new secret version is created.", "type": "string" } }, @@ -57,14 +58,14 @@ }, "ReplicaRegion": { "additionalProperties": false, - "description": "A custom type that specifies a Region and the KmsKeyId for a replica secret.", + "description": "Specifies a ``Region`` and the ``KmsKeyId`` for a replica secret.", "properties": { "KmsKeyId": { - "description": "The ARN, key ID, or alias of the KMS key to encrypt the secret. If you don't include this field, Secrets Manager uses aws/secretsmanager.", + "description": "The ARN, key ID, or alias of the KMS key to encrypt the secret. If you don't include this field, Secrets Manager uses ``aws/secretsmanager``.", "type": "string" }, "Region": { - "description": "(Optional) A string that represents a Region, for example \"us-east-1\".", + "description": "A string that represents a ``Region``, for example \"us-east-1\".", "type": "string" } }, @@ -75,14 +76,14 @@ }, "Tag": { "additionalProperties": false, - "description": "A list of tags to attach to the secret. Each tag is a key and value pair of strings in a JSON text string.", + "description": "A structure that contains information about a tag.", "properties": { "Key": { - "description": "The value for the tag. You can specify a value that's 1 to 256 characters in length.", + "description": "The key identifier, or name, of the tag.", "type": "string" }, "Value": { - "description": "The key name of the tag. You can specify a value that's 1 to 128 Unicode characters in length and can't be prefixed with aws.", + "description": "The string value associated with the key of the tag.", "type": "string" } }, @@ -93,14 +94,15 @@ "type": "object" } }, - "description": "Resource Type definition for AWS::SecretsManager::Secret", + "description": "Creates a new secret. A *secret* can be a password, a set of credentials such as a user name and password, an OAuth token, or other secret information that you store in an encrypted form in Secrets Manager.\n For RDS master user credentials, see [AWS::RDS::DBCluster MasterUserSecret](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-masterusersecret.html).\n To retrieve a secret in a CFNshort template, use a *dynamic reference*. For more information, see [Retrieve a secret in an resource](https://docs.aws.amazon.com/secretsmanager/latest/userguide/cfn-example_reference-secret.html).\n A common scenario is to first create a secret with ``GenerateSecretString``, which generates a password, and then use a dynamic reference to retrieve the username and password from the secret to use as credentials for a new database. See the example *Creating a Redshift cluster and a secret for the admin credentials*.\n For information about creating a secret in the console, see [Create a secret](https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_create-basic-secret.html). For information about creating a secret using the CLI or SDK, see [CreateSecret](https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_CreateSecret.html).\n For information about retrieving a secret in code, see [Retrieve secrets from Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieving-secrets.html).", "handlers": { "create": { "permissions": [ "secretsmanager:DescribeSecret", "secretsmanager:GetRandomPassword", "secretsmanager:CreateSecret", - "secretsmanager:TagResource" + "secretsmanager:TagResource", + "secretsmanager:ReplicateSecretToRegions" ] }, "delete": { @@ -138,27 +140,27 @@ ], "properties": { "Description": { - "description": "(Optional) Specifies a user-provided description of the secret.", + "description": "The description of the secret.", "type": "string" }, "GenerateSecretString": { "$ref": "#/definitions/GenerateSecretString", - "description": "(Optional) Specifies text data that you want to encrypt and store in this new version of the secret." + "description": "A structure that specifies how to generate a password to encrypt and store in the secret. To include a specific string in the secret, use ``SecretString`` instead. If you omit both ``GenerateSecretString`` and ``SecretString``, you create an empty secret. When you make a change to this property, a new secret version is created.\n We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support." }, "Id": { - "description": "secret Id, the Arn of the resource.", + "description": "", "type": "string" }, "KmsKeyId": { - "description": "(Optional) Specifies the ARN, Key ID, or alias of the AWS KMS customer master key (CMK) used to encrypt the SecretString.", + "description": "The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt the secret value in the secret. An alias is always prefixed by ``alias/``, for example ``alias/aws/secretsmanager``. For more information, see [About aliases](https://docs.aws.amazon.com/kms/latest/developerguide/alias-about.html).\n To use a KMS key in a different account, use the key ARN or the alias ARN.\n If you don't specify this value, then Secrets Manager uses the key ``aws/secretsmanager``. If that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value.\n If the secret is in a different AWS account from the credentials calling the API, then you can't use ``aws/secretsmanager`` to encrypt the secret, and you must create and use a customer managed KMS key.", "type": "string" }, "Name": { - "description": "The friendly name of the secret. You can use forward slashes in the name to represent a path hierarchy.", + "description": "The name of the new secret.\n The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@-\n Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN.", "type": "string" }, "ReplicaRegions": { - "description": "(Optional) A list of ReplicaRegion objects. The ReplicaRegion type consists of a Region (required) and the KmsKeyId which can be an ARN, Key ID, or Alias.", + "description": "A custom type that specifies a ``Region`` and the ``KmsKeyId`` for a replica secret.", "insertionOrder": false, "items": { "$ref": "#/definitions/ReplicaRegion" @@ -167,11 +169,11 @@ "uniqueItems": false }, "SecretString": { - "description": "(Optional) Specifies text data that you want to encrypt and store in this new version of the secret.", + "description": "The text to encrypt and store in the secret. We recommend you use a JSON structure of key/value pairs for your secret value. To generate a random password, use ``GenerateSecretString`` instead. If you omit both ``GenerateSecretString`` and ``SecretString``, you create an empty secret. When you make a change to this property, a new secret version is created.", "type": "string" }, "Tags": { - "description": "The list of user-defined tags associated with the secret. Use tags to manage your AWS resources. For additional information about tags, see TagResource.", + "description": "A list of tags to attach to the secret. Each tag is a key and value pair of strings in a JSON text string, for example:\n ``[{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]`` \n Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag from one with key \"abc\".\n Stack-level tags, tags you apply to the CloudFormation stack, are also attached to the secret. \n If you check tags in permissions policies as part of your security strategy, then adding or removing a tag can change permissions. If the completion of this operation would result in you losing your permissions for this secret, then Secrets Manager blocks the operation and returns an ``Access Denied`` error. For more information, see [Control access to secrets using tags](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#tag-secrets-abac) and [Limit access to identities with tags that match secrets' tags](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#auth-and-access_tags2).\n For information about how to format a JSON parameter for the various command line tool environments, see [Using JSON for Parameters](https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json). If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.\n The following restrictions apply to tags:\n + Maximum number of tags per secret: 50\n + Maximum key length: 127 Unicode characters in UTF-8\n + Maximum value length: 255 Unicode characters in UTF-8\n + Tag keys and values are case sensitive.\n + Do not use the ``aws:`` prefix in your tag names or values because AWS reserves it for AWS use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.\n + If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.", "insertionOrder": false, "items": { "$ref": "#/definitions/Tag" diff --git a/artifacts/types/AWS::SecurityHub::AutomationRule.json b/artifacts/types/AWS::SecurityHub::AutomationRule.json index 0b2c92d3..e5bb96c4 100644 --- a/artifacts/types/AWS::SecurityHub::AutomationRule.json +++ b/artifacts/types/AWS::SecurityHub::AutomationRule.json @@ -1,16 +1,19 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SecurityHub-AutomationRule", "type": "AWS::SecurityHub::AutomationRule", - "time": "2024-01-02T16:46:15.848Z", + "time": "2024-06-24T15:55:27.149Z", "schema": { "additionalProperties": false, "definitions": { "AutomationRulesAction": { + "description": "", "properties": { "FindingFieldsUpdate": { - "$ref": "#/definitions/AutomationRulesFindingFieldsUpdate" + "$ref": "#/definitions/AutomationRulesFindingFieldsUpdate", + "description": "" }, "Type": { + "description": "", "enum": [ "FINDING_FIELDS_UPDATE" ], @@ -24,19 +27,23 @@ "type": "object" }, "AutomationRulesFindingFieldsUpdate": { + "description": "The rule action will update the ``Note`` field of a finding.", "properties": { "Confidence": { - "$ref": "#/definitions/int100" + "$ref": "#/definitions/int100", + "description": "" }, "Criticality": { - "$ref": "#/definitions/int100" + "$ref": "#/definitions/int100", + "description": "" }, "Note": { "$ref": "#/definitions/NoteUpdate", - "description": "Note added to the finding", + "description": "The rule action will update the ``Note`` field of a finding.", "type": "object" }, "RelatedFindings": { + "description": "The rule action will update the ``RelatedFindings`` field of a finding.", "items": { "$ref": "#/definitions/RelatedFinding" }, @@ -46,10 +53,11 @@ }, "Severity": { "$ref": "#/definitions/SeverityUpdate", - "description": "Severity of the finding", + "description": "The rule action will update the ``Severity`` field of a finding.", "type": "object" }, "Types": { + "description": "", "items": { "pattern": "^([^/]+)(/[^/]+){0,2}$", "type": "string" @@ -59,9 +67,11 @@ "uniqueItems": true }, "UserDefinedFields": { - "$ref": "#/definitions/map" + "$ref": "#/definitions/map", + "description": "" }, "VerificationState": { + "description": "", "enum": [ "UNKNOWN", "TRUE_POSITIVE", @@ -72,7 +82,7 @@ }, "Workflow": { "$ref": "#/definitions/WorkflowUpdate", - "description": "Workflow status set for the finding", + "description": "The rule action will update the ``Workflow`` field of a finding.", "type": "object" } }, @@ -80,8 +90,10 @@ }, "AutomationRulesFindingFilters": { "additionalProperties": false, + "description": "", "properties": { "AwsAccountId": { + "description": "", "items": { "$ref": "#/definitions/StringFilter" }, @@ -89,6 +101,7 @@ "type": "array" }, "CompanyName": { + "description": "", "items": { "$ref": "#/definitions/StringFilter" }, @@ -96,6 +109,7 @@ "type": "array" }, "ComplianceAssociatedStandardsId": { + "description": "", "items": { "$ref": "#/definitions/StringFilter" }, @@ -103,6 +117,7 @@ "type": "array" }, "ComplianceSecurityControlId": { + "description": "", "items": { "$ref": "#/definitions/StringFilter" }, @@ -110,6 +125,7 @@ "type": "array" }, "ComplianceStatus": { + "description": "", "items": { "$ref": "#/definitions/StringFilter" }, @@ -117,6 +133,7 @@ "type": "array" }, "Confidence": { + "description": "", "items": { "$ref": "#/definitions/NumberFilter" }, @@ -124,6 +141,7 @@ "type": "array" }, "CreatedAt": { + "description": "", "items": { "$ref": "#/definitions/DateFilter" }, @@ -131,6 +149,7 @@ "type": "array" }, "Criticality": { + "description": "", "items": { "$ref": "#/definitions/NumberFilter" }, @@ -138,6 +157,7 @@ "type": "array" }, "Description": { + "description": "", "items": { "$ref": "#/definitions/StringFilter" }, @@ -145,6 +165,7 @@ "type": "array" }, "FirstObservedAt": { + "description": "", "items": { "$ref": "#/definitions/DateFilter" }, @@ -152,6 +173,7 @@ "type": "array" }, "GeneratorId": { + "description": "", "items": { "$ref": "#/definitions/StringFilter" }, @@ -159,6 +181,7 @@ "type": "array" }, "Id": { + "description": "", "items": { "$ref": "#/definitions/StringFilter" }, @@ -166,6 +189,7 @@ "type": "array" }, "LastObservedAt": { + "description": "", "items": { "$ref": "#/definitions/DateFilter" }, @@ -173,6 +197,7 @@ "type": "array" }, "NoteText": { + "description": "", "items": { "$ref": "#/definitions/StringFilter" }, @@ -180,6 +205,7 @@ "type": "array" }, "NoteUpdatedAt": { + "description": "", "items": { "$ref": "#/definitions/DateFilter" }, @@ -187,6 +213,7 @@ "type": "array" }, "NoteUpdatedBy": { + "description": "", "items": { "$ref": "#/definitions/StringFilter" }, @@ -194,6 +221,7 @@ "type": "array" }, "ProductArn": { + "description": "", "items": { "$ref": "#/definitions/StringFilter" }, @@ -201,6 +229,7 @@ "type": "array" }, "ProductName": { + "description": "", "items": { "$ref": "#/definitions/StringFilter" }, @@ -208,6 +237,7 @@ "type": "array" }, "RecordState": { + "description": "", "items": { "$ref": "#/definitions/StringFilter" }, @@ -215,6 +245,7 @@ "type": "array" }, "RelatedFindingsId": { + "description": "", "items": { "$ref": "#/definitions/StringFilter" }, @@ -222,6 +253,7 @@ "type": "array" }, "RelatedFindingsProductArn": { + "description": "", "items": { "$ref": "#/definitions/StringFilter" }, @@ -229,6 +261,7 @@ "type": "array" }, "ResourceDetailsOther": { + "description": "", "items": { "$ref": "#/definitions/MapFilter" }, @@ -236,6 +269,7 @@ "type": "array" }, "ResourceId": { + "description": "", "items": { "$ref": "#/definitions/StringFilter" }, @@ -243,6 +277,7 @@ "type": "array" }, "ResourcePartition": { + "description": "", "items": { "$ref": "#/definitions/StringFilter" }, @@ -250,6 +285,7 @@ "type": "array" }, "ResourceRegion": { + "description": "", "items": { "$ref": "#/definitions/StringFilter" }, @@ -257,6 +293,7 @@ "type": "array" }, "ResourceTags": { + "description": "", "items": { "$ref": "#/definitions/MapFilter" }, @@ -264,6 +301,7 @@ "type": "array" }, "ResourceType": { + "description": "", "items": { "$ref": "#/definitions/StringFilter" }, @@ -271,6 +309,7 @@ "type": "array" }, "SeverityLabel": { + "description": "", "items": { "$ref": "#/definitions/StringFilter" }, @@ -278,6 +317,7 @@ "type": "array" }, "SourceUrl": { + "description": "", "items": { "$ref": "#/definitions/StringFilter" }, @@ -285,6 +325,7 @@ "type": "array" }, "Title": { + "description": "", "items": { "$ref": "#/definitions/StringFilter" }, @@ -292,6 +333,7 @@ "type": "array" }, "Type": { + "description": "", "items": { "$ref": "#/definitions/StringFilter" }, @@ -299,6 +341,7 @@ "type": "array" }, "UpdatedAt": { + "description": "", "items": { "$ref": "#/definitions/DateFilter" }, @@ -306,6 +349,7 @@ "type": "array" }, "UserDefinedFields": { + "description": "", "items": { "$ref": "#/definitions/MapFilter" }, @@ -313,6 +357,7 @@ "type": "array" }, "VerificationState": { + "description": "", "items": { "$ref": "#/definitions/StringFilter" }, @@ -320,6 +365,7 @@ "type": "array" }, "WorkflowStatus": { + "description": "", "items": { "$ref": "#/definitions/StringFilter" }, @@ -331,8 +377,10 @@ }, "BooleanFilter": { "additionalProperties": false, + "description": "", "properties": { "Value": { + "description": "The value of the boolean.", "type": "boolean" } }, @@ -343,6 +391,7 @@ }, "DateFilter": { "additionalProperties": false, + "description": "", "oneOf": [ { "required": [ @@ -366,27 +415,33 @@ ], "properties": { "DateRange": { - "$ref": "#/definitions/DateRange" + "$ref": "#/definitions/DateRange", + "description": "" }, "End": { - "$ref": "#/definitions/ISO8601DateString" + "$ref": "#/definitions/ISO8601DateString", + "description": "" }, "Start": { - "$ref": "#/definitions/ISO8601DateString" + "$ref": "#/definitions/ISO8601DateString", + "description": "" } }, "type": "object" }, "DateRange": { "additionalProperties": false, + "description": "", "properties": { "Unit": { + "description": "", "enum": [ "DAYS" ], "type": "string" }, "Value": { + "description": "", "type": "number" } }, @@ -397,13 +452,16 @@ "type": "object" }, "ISO8601DateString": { + "description": "The date and time, in UTC and ISO 8601 format.", "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))?)$", "type": "string" }, "MapFilter": { "additionalProperties": false, + "description": "", "properties": { "Comparison": { + "description": "", "enum": [ "EQUALS", "NOT_EQUALS", @@ -413,9 +471,11 @@ "type": "string" }, "Key": { + "description": "", "type": "string" }, "Value": { + "description": "", "type": "string" } }, @@ -432,14 +492,17 @@ }, "NoteUpdate": { "additionalProperties": false, + "description": "", "properties": { "Text": { + "description": "", "maxLength": 512, "minLength": 1, "type": "string" }, "UpdatedBy": { - "$ref": "#/definitions/arnOrId" + "$ref": "#/definitions/arnOrId", + "description": "" } }, "required": [ @@ -450,6 +513,7 @@ }, "NumberFilter": { "additionalProperties": false, + "description": "", "oneOf": [ { "required": [ @@ -473,12 +537,15 @@ ], "properties": { "Eq": { + "description": "", "type": "number" }, "Gte": { + "description": "", "type": "number" }, "Lte": { + "description": "", "type": "number" } }, @@ -486,12 +553,15 @@ }, "RelatedFinding": { "additionalProperties": false, + "description": "Provides details about a list of findings that the current finding relates to.", "properties": { "Id": { - "$ref": "#/definitions/arnOrId" + "$ref": "#/definitions/arnOrId", + "description": "" }, "ProductArn": { - "$ref": "#/definitions/arn" + "$ref": "#/definitions/arn", + "description": "The Amazon Resource Name (ARN) for the product that generated a related finding." } }, "required": [ @@ -502,8 +572,10 @@ }, "SeverityUpdate": { "additionalProperties": false, + "description": "", "properties": { "Label": { + "description": "", "enum": [ "INFORMATIONAL", "LOW", @@ -514,9 +586,11 @@ "type": "string" }, "Normalized": { - "$ref": "#/definitions/int100" + "$ref": "#/definitions/int100", + "description": "" }, "Product": { + "description": "", "type": "number" } }, @@ -524,11 +598,14 @@ }, "StringFilter": { "additionalProperties": false, + "description": "", "properties": { "Comparison": { - "$ref": "#/definitions/StringFilterComparison" + "$ref": "#/definitions/StringFilterComparison", + "description": "" }, "Value": { + "description": "", "type": "string" } }, @@ -539,6 +616,7 @@ "type": "object" }, "StringFilterComparison": { + "description": "The condition to apply to a string value when filtering Security Hub findings.", "enum": [ "EQUALS", "PREFIX", @@ -564,8 +642,10 @@ }, "WorkflowUpdate": { "additionalProperties": false, + "description": "", "properties": { "Status": { + "description": "", "enum": [ "NEW", "NOTIFIED", @@ -581,6 +661,7 @@ "type": "object" }, "arn": { + "description": "The Amazon Resource Name (ARN) of the automation rule.", "maxLength": 2048, "minLength": 12, "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})?:.+$", @@ -596,19 +677,23 @@ { "$ref": "#/definitions/arn" } - ] + ], + "description": "The Amazon Resource Name (ARN) or Id of the automation rule." }, "int100": { + "description": "Integer from 0 to 100.", "maximum": 100, "minimum": 0, "type": "integer" }, "map": { "additionalProperties": false, + "description": "An object of user-defined name and value string pair added to a finding.", "maxProperties": 50, "minProperties": 1, "patternProperties": { "^[-_+=.:/@\\w\\s]{1,128}$": { + "description": "The value for the key in the map", "maxLength": 1024, "minLength": 0, "type": "string" @@ -622,7 +707,7 @@ "type": "string" } }, - "description": "The AWS::SecurityHub::AutomationRule resource represents the Automation Rule in your account. One rule resource is created for each Automation Rule in which you configure rule criteria and actions.\n\n", + "description": "The ``AWS::SecurityHub::AutomationRule`` resource specifies an automation rule based on input parameters. For more information, see [Automation rules](https://docs.aws.amazon.com/securityhub/latest/userguide/automation-rules.html) in the *User Guide*.", "handlers": { "create": { "permissions": [ @@ -664,6 +749,7 @@ ], "properties": { "Actions": { + "description": "", "items": { "$ref": "#/definitions/AutomationRulesAction" }, @@ -673,47 +759,47 @@ }, "CreatedAt": { "$ref": "#/definitions/ISO8601DateString", - "description": "The date and time when Automation Rule was created" + "description": "" }, "CreatedBy": { - "description": "The identifier by which created the rule", + "description": "", "maxLength": 256, "minLength": 1, "type": "string" }, "Criteria": { "$ref": "#/definitions/AutomationRulesFindingFilters", - "description": "The rule criteria for evaluating findings" + "description": "A set of [Security Finding Format (ASFF)](https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format.html) finding field attributes and corresponding expected values that ASH uses to filter findings. If a rule is enabled and a finding matches the criteria specified in this parameter, ASH applies the rule action to the finding." }, "Description": { - "description": "Rule description", + "description": "", "maxLength": 1024, "minLength": 1, "type": "string" }, "IsTerminal": { - "description": "If Rule is a terminal rule", + "description": "", "type": "boolean" }, "RuleArn": { - "description": "An Automation Rule Arn is automatically created", + "description": "", "pattern": "arn:aws\\S*:securityhub:\\S*", "type": "string" }, "RuleName": { - "description": "Rule name", + "description": "", "maxLength": 256, "minLength": 1, "type": "string" }, "RuleOrder": { - "description": "Rule order value", + "description": "", "maximum": 1000, "minimum": 1, "type": "integer" }, "RuleStatus": { - "description": "Status of the Rule upon creation", + "description": "Whether the rule is active after it is created. If this parameter is equal to ``ENABLED``, ASH applies the rule to findings and finding updates after the rule is created.", "enum": [ "ENABLED", "DISABLED" @@ -721,11 +807,12 @@ "type": "string" }, "Tags": { - "$ref": "#/definitions/Tags" + "$ref": "#/definitions/Tags", + "description": "" }, "UpdatedAt": { "$ref": "#/definitions/ISO8601DateString", - "description": "The date and time when Automation Rule was last updated" + "description": "" } }, "readOnlyProperties": [ @@ -736,7 +823,7 @@ ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-securityhub", "tagging": { - "cloudFormationSystemTags": true, + "cloudFormationSystemTags": false, "tagOnCreate": true, "tagProperty": "/properties/Tags", "tagUpdatable": true, diff --git a/artifacts/types/AWS::SecurityHub::ConfigurationPolicy.json b/artifacts/types/AWS::SecurityHub::ConfigurationPolicy.json new file mode 100644 index 00000000..295934cf --- /dev/null +++ b/artifacts/types/AWS::SecurityHub::ConfigurationPolicy.json @@ -0,0 +1,305 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SecurityHub-ConfigurationPolicy", + "type": "AWS::SecurityHub::ConfigurationPolicy", + "time": "2024-06-07T21:00:40.126Z", + "schema": { + "additionalProperties": false, + "definitions": { + "ParameterConfiguration": { + "additionalProperties": false, + "description": "An object that provides the current value of a security control parameter and identifies whether it has been customized.", + "properties": { + "Value": { + "$ref": "#/definitions/ParameterValue" + }, + "ValueType": { + "description": "Identifies whether a control parameter uses a custom user-defined value or subscribes to the default AWS Security Hub behavior.", + "enum": [ + "DEFAULT", + "CUSTOM" + ], + "type": "string" + } + }, + "required": [ + "ValueType" + ], + "type": "object" + }, + "ParameterValue": { + "additionalProperties": false, + "description": "An object that includes the data type of a security control parameter and its current value.", + "maxProperties": 1, + "minProperties": 1, + "properties": { + "Boolean": { + "description": "A control parameter that is a boolean.", + "type": "boolean" + }, + "Double": { + "description": "A control parameter that is a double.", + "type": "number" + }, + "Enum": { + "description": "A control parameter that is an enum.", + "maxLength": 2048, + "type": "string" + }, + "EnumList": { + "description": "A control parameter that is a list of enums.", + "insertionOrder": true, + "items": { + "maxLength": 2048, + "type": "string" + }, + "maxItems": 100, + "type": "array", + "uniqueItems": true + }, + "Integer": { + "description": "A control parameter that is an integer.", + "type": "integer" + }, + "IntegerList": { + "description": "A control parameter that is a list of integers.", + "insertionOrder": true, + "items": { + "type": "integer" + }, + "maxItems": 100, + "type": "array", + "uniqueItems": true + }, + "String": { + "description": "A control parameter that is a string.", + "maxLength": 2048, + "type": "string" + }, + "StringList": { + "description": "A control parameter that is a list of strings.", + "insertionOrder": true, + "items": { + "maxLength": 2048, + "type": "string" + }, + "maxItems": 100, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "Policy": { + "additionalProperties": false, + "description": "An object that defines how Security Hub is configured.", + "properties": { + "SecurityHub": { + "$ref": "#/definitions/SecurityHubPolicy" + } + }, + "type": "object" + }, + "SecurityControlCustomParameter": { + "additionalProperties": false, + "description": "An object of security control and control parameter value that are included in a configuration policy.", + "properties": { + "Parameters": { + "additionalProperties": false, + "description": "An object that specifies parameter values for a control in a configuration policy.", + "minProperties": 1, + "patternProperties": { + "^[-_+=.:/@\\w\\s]{1,128}$": { + "$ref": "#/definitions/ParameterConfiguration" + } + }, + "type": "object" + }, + "SecurityControlId": { + "description": "The ID of the security control.", + "maxLength": 2048, + "type": "string" + } + }, + "type": "object" + }, + "SecurityControlsConfiguration": { + "additionalProperties": false, + "description": "An object that defines which security controls are enabled in an AWS Security Hub configuration policy.", + "properties": { + "DisabledSecurityControlIdentifiers": { + "description": "A list of security controls that are disabled in the configuration policy", + "insertionOrder": true, + "items": { + "maxLength": 2048, + "type": "string" + }, + "maxItems": 1000, + "type": "array", + "uniqueItems": true + }, + "EnabledSecurityControlIdentifiers": { + "description": "A list of security controls that are enabled in the configuration policy.", + "insertionOrder": true, + "items": { + "maxLength": 2048, + "type": "string" + }, + "maxItems": 1000, + "type": "array", + "uniqueItems": true + }, + "SecurityControlCustomParameters": { + "description": "A list of security controls and control parameter values that are included in a configuration policy.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/SecurityControlCustomParameter" + }, + "maxItems": 1000, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "SecurityHubPolicy": { + "additionalProperties": false, + "description": "An object that defines how AWS Security Hub is configured.", + "properties": { + "EnabledStandardIdentifiers": { + "description": "A list that defines which security standards are enabled in the configuration policy.", + "insertionOrder": true, + "items": { + "maxLength": 2048, + "type": "string" + }, + "maxItems": 1000, + "type": "array", + "uniqueItems": true + }, + "SecurityControlsConfiguration": { + "$ref": "#/definitions/SecurityControlsConfiguration" + }, + "ServiceEnabled": { + "description": "Indicates whether Security Hub is enabled in the policy.", + "type": "boolean" + } + }, + "type": "object" + }, + "Tags": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "patternProperties": { + "^[a-zA-Z0-9]{1,128}$": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + } + }, + "description": "The AWS::SecurityHub::ConfigurationPolicy resource represents the Central Configuration Policy in your account.", + "handlers": { + "create": { + "permissions": [ + "securityhub:CreateConfigurationPolicy", + "securityhub:TagResource", + "securityhub:ListTagsForResource" + ] + }, + "delete": { + "permissions": [ + "securityhub:GetConfigurationPolicy", + "securityhub:DeleteConfigurationPolicy" + ] + }, + "list": { + "permissions": [ + "securityhub:ListConfigurationPolicies", + "securityhub:ListTagsForResource" + ] + }, + "read": { + "permissions": [ + "securityhub:GetConfigurationPolicy", + "securityhub:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "securityhub:UpdateConfigurationPolicy", + "securityhub:TagResource", + "securityhub:UntagResource", + "securityhub:ListTagsForResource" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "The Amazon Resource Name (ARN) of the configuration policy.", + "pattern": "^arn:aws\\S*:securityhub:[a-z0-9-]+:[0-9]{12}:configuration-policy/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", + "type": "string" + }, + "ConfigurationPolicy": { + "$ref": "#/definitions/Policy" + }, + "CreatedAt": { + "description": "The date and time, in UTC and ISO 8601 format.", + "type": "string" + }, + "Description": { + "description": "The description of the configuration policy.", + "maxLength": 512, + "minLength": 0, + "type": "string" + }, + "Id": { + "description": "The universally unique identifier (UUID) of the configuration policy.", + "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", + "type": "string" + }, + "Name": { + "description": "The name of the configuration policy.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "ServiceEnabled": { + "description": "Indicates whether the service that the configuration policy applies to is enabled in the policy.", + "type": "boolean" + }, + "Tags": { + "$ref": "#/definitions/Tags" + }, + "UpdatedAt": { + "description": "The date and time, in UTC and ISO 8601 format.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/Id", + "/properties/CreatedAt", + "/properties/UpdatedAt", + "/properties/ServiceEnabled" + ], + "required": [ + "ConfigurationPolicy", + "Name" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-securityhub", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::SecurityHub::ConfigurationPolicy" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::SecurityHub::FindingAggregator.json b/artifacts/types/AWS::SecurityHub::FindingAggregator.json new file mode 100644 index 00000000..83a3fbac --- /dev/null +++ b/artifacts/types/AWS::SecurityHub::FindingAggregator.json @@ -0,0 +1,88 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SecurityHub-FindingAggregator", + "type": "AWS::SecurityHub::FindingAggregator", + "time": "2024-06-24T15:48:28.794Z", + "schema": { + "additionalProperties": false, + "definitions": { + "Region": { + "pattern": "^[a-zA-Z0-9-]{1,32}$", + "type": "string" + } + }, + "description": "The AWS::SecurityHub::FindingAggregator resource represents the AWS Security Hub Finding Aggregator in your account. One finding aggregator resource is created for each account in non opt-in region in which you configure region linking mode.", + "handlers": { + "create": { + "permissions": [ + "securityhub:CreateFindingAggregator" + ] + }, + "delete": { + "permissions": [ + "securityhub:DeleteFindingAggregator" + ] + }, + "list": { + "permissions": [ + "securityhub:ListFindingAggregators" + ] + }, + "read": { + "permissions": [ + "securityhub:GetFindingAggregator" + ] + }, + "update": { + "permissions": [ + "securityhub:UpdateFindingAggregator" + ] + } + }, + "primaryIdentifier": [ + "/properties/FindingAggregatorArn" + ], + "properties": { + "FindingAggregationRegion": { + "$ref": "#/definitions/Region", + "description": "The aggregation Region of the FindingAggregator" + }, + "FindingAggregatorArn": { + "description": "The ARN of the FindingAggregator being created and assigned as the unique identifier", + "pattern": "arn:aws\\S*:securityhub:\\S*", + "type": "string" + }, + "RegionLinkingMode": { + "description": "Indicates whether to link all Regions, all Regions except for a list of excluded Regions, or a list of included Regions", + "enum": [ + "ALL_REGIONS", + "ALL_REGIONS_EXCEPT_SPECIFIED", + "SPECIFIED_REGIONS" + ], + "type": "string" + }, + "Regions": { + "description": "The list of excluded Regions or included Regions", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Region" + }, + "maxItems": 50, + "minItems": 1, + "type": "array", + "uniqueItems": true + } + }, + "readOnlyProperties": [ + "/properties/FindingAggregatorArn", + "/properties/FindingAggregationRegion" + ], + "required": [ + "RegionLinkingMode" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-securityhub", + "tagging": { + "taggable": false + }, + "typeName": "AWS::SecurityHub::FindingAggregator" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::SecurityHub::Hub.json b/artifacts/types/AWS::SecurityHub::Hub.json index 9fd14c35..6e9e66b5 100644 --- a/artifacts/types/AWS::SecurityHub::Hub.json +++ b/artifacts/types/AWS::SecurityHub::Hub.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SecurityHub-Hub", "type": "AWS::SecurityHub::Hub", - "time": "2023-12-13T19:21:10.279Z", + "time": "2024-05-21T15:39:28.041Z", "schema": { "additionalProperties": false, "definitions": { diff --git a/artifacts/types/AWS::SecurityHub::Insight.json b/artifacts/types/AWS::SecurityHub::Insight.json new file mode 100644 index 00000000..04fb82e8 --- /dev/null +++ b/artifacts/types/AWS::SecurityHub::Insight.json @@ -0,0 +1,1292 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SecurityHub-Insight", + "type": "AWS::SecurityHub::Insight", + "time": "2024-06-24T15:44:29.057Z", + "schema": { + "additionalProperties": false, + "definitions": { + "AwsSecurityFindingFilters": { + "additionalProperties": false, + "description": "A collection of filters that are applied to all active findings aggregated by AWS Security Hub.", + "properties": { + "AwsAccountId": { + "description": "The AWS account ID in which a finding is generated.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "AwsAccountName": { + "description": "The name of the AWS account in which a finding is generated.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "CompanyName": { + "description": "The name of the findings provider (company) that owns the solution (product) that generates findings.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ComplianceAssociatedStandardsId": { + "description": "The unique identifier of a standard in which a control is enabled.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ComplianceSecurityControlId": { + "description": "The unique identifier of a control across standards.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ComplianceSecurityControlParametersName": { + "description": "The name of a security control parameter.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ComplianceSecurityControlParametersValue": { + "description": "The current value of a security control parameter.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ComplianceStatus": { + "description": "Exclusive to findings that are generated as the result of a check run against a specific rule in a supported standard.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "Confidence": { + "description": "A finding's confidence.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/NumberFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "CreatedAt": { + "description": "An ISO8601-formatted timestamp that indicates when the security findings provider captured the potential security issue that a finding captured.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/DateFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "Criticality": { + "description": "The level of importance assigned to the resources associated with the finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/NumberFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "Description": { + "description": "A finding's description.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "FindingProviderFieldsConfidence": { + "description": "The finding provider value for the finding confidence.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/NumberFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "FindingProviderFieldsCriticality": { + "description": "The finding provider value for the level of importance assigned to the resources associated with the findings.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/NumberFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "FindingProviderFieldsRelatedFindingsId": { + "description": "The finding identifier of a related finding that is identified by the finding provider.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "FindingProviderFieldsRelatedFindingsProductArn": { + "description": "The ARN of the solution that generated a related finding that is identified by the finding provider.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "FindingProviderFieldsSeverityLabel": { + "description": "The finding provider value for the severity label.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "FindingProviderFieldsSeverityOriginal": { + "description": "The finding provider's original value for the severity.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "FindingProviderFieldsTypes": { + "description": "One or more finding types that the finding provider assigned to the finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "FirstObservedAt": { + "description": "An ISO8601-formatted timestamp that indicates when the security findings provider first observed the potential security issue that a finding captured.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/DateFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "GeneratorId": { + "description": "The identifier for the solution-specific component (a discrete unit of logic) that generated a finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "Id": { + "description": "The security findings provider-specific identifier for a finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "Keyword": { + "description": "A keyword for a finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/KeywordFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "LastObservedAt": { + "description": "An ISO8601-formatted timestamp that indicates when the security findings provider most recently observed the potential security issue that a finding captured.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/DateFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "MalwareName": { + "description": "The name of the malware that was observed.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "MalwarePath": { + "description": "The filesystem path of the malware that was observed.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "MalwareState": { + "description": "The state of the malware that was observed.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "MalwareType": { + "description": "The type of the malware that was observed.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "NetworkDestinationDomain": { + "description": "The destination domain of network-related information about a finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "NetworkDestinationIpV4": { + "description": "The destination IPv4 address of network-related information about a finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/IpFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "NetworkDestinationIpV6": { + "description": "The destination IPv6 address of network-related information about a finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/IpFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "NetworkDestinationPort": { + "description": "The destination port of network-related information about a finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/NumberFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "NetworkDirection": { + "description": "Indicates the direction of network traffic associated with a finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "NetworkProtocol": { + "description": "The protocol of network-related information about a finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "NetworkSourceDomain": { + "description": "The source domain of network-related information about a finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "NetworkSourceIpV4": { + "description": "The source IPv4 address of network-related information about a finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/IpFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "NetworkSourceIpV6": { + "description": "The source IPv6 address of network-related information about a finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/IpFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "NetworkSourceMac": { + "description": "The source media access control (MAC) address of network-related information about a finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "NetworkSourcePort": { + "description": "The source port of network-related information about a finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/NumberFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "NoteText": { + "description": "The text of a note.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "NoteUpdatedAt": { + "description": "The timestamp of when the note was updated.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/DateFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "NoteUpdatedBy": { + "description": "The principal that created a note.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ProcessLaunchedAt": { + "description": "A timestamp that identifies when the process was launched.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/DateFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ProcessName": { + "description": "The name of the process.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ProcessParentPid": { + "description": "The parent process ID.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/NumberFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ProcessPath": { + "description": "The path to the process executable.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ProcessPid": { + "description": "The process ID.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/NumberFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ProcessTerminatedAt": { + "description": "A timestamp that identifies when the process was terminated.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/DateFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ProductArn": { + "description": "The ARN generated by Security Hub that uniquely identifies a third-party company (security findings provider) after this provider's product (solution that generates findings) is registered with Security Hub.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ProductFields": { + "description": "A data type where security findings providers can include additional solution-specific details that aren't part of the defined AwsSecurityFinding format.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/MapFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ProductName": { + "description": "The name of the solution (product) that generates findings.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "RecommendationText": { + "description": "The recommendation of what to do about the issue described in a finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "RecordState": { + "description": "The updated record state for the finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "Region": { + "description": "The Region from which the finding was generated.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "RelatedFindingsId": { + "description": "The solution-generated identifier for a related finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "RelatedFindingsProductArn": { + "description": "The ARN of the solution that generated a related finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ResourceApplicationArn": { + "description": "The ARN of the application that is related to a finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ResourceApplicationName": { + "description": "The name of the application that is related to a finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ResourceAwsEc2InstanceIamInstanceProfileArn": { + "description": "The IAM profile ARN of the instance.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ResourceAwsEc2InstanceImageId": { + "description": "The Amazon Machine Image (AMI) ID of the instance.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ResourceAwsEc2InstanceIpV4Addresses": { + "description": "The IPv4 addresses associated with the instance.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/IpFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ResourceAwsEc2InstanceIpV6Addresses": { + "description": "The IPv6 addresses associated with the instance.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/IpFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ResourceAwsEc2InstanceKeyName": { + "description": "The key name associated with the instance.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ResourceAwsEc2InstanceLaunchedAt": { + "description": "The date and time the instance was launched.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/DateFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ResourceAwsEc2InstanceSubnetId": { + "description": "The identifier of the subnet that the instance was launched in.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ResourceAwsEc2InstanceType": { + "description": "The instance type of the instance.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ResourceAwsEc2InstanceVpcId": { + "description": "The identifier of the VPC that the instance was launched in.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ResourceAwsIamAccessKeyCreatedAt": { + "description": "The creation date/time of the IAM access key related to a finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/DateFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ResourceAwsIamAccessKeyPrincipalName": { + "description": "The name of the principal that is associated with an IAM access key.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ResourceAwsIamAccessKeyStatus": { + "description": "The status of the IAM access key related to a finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ResourceAwsIamAccessKeyUserName": { + "description": "The user associated with the IAM access key related to a finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ResourceAwsIamUserUserName": { + "description": "The name of an IAM user.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ResourceAwsS3BucketOwnerId": { + "description": "The canonical user ID of the owner of the S3 bucket.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ResourceAwsS3BucketOwnerName": { + "description": "The display name of the owner of the S3 bucket.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ResourceContainerImageId": { + "description": "The identifier of the image related to a finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ResourceContainerImageName": { + "description": "The name of the image related to a finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ResourceContainerLaunchedAt": { + "description": "A timestamp that identifies when the container was started.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/DateFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ResourceContainerName": { + "description": "The name of the container related to a finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ResourceDetailsOther": { + "description": "The details of a resource that doesn't have a specific subfield for the resource type defined.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/MapFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ResourceId": { + "description": "The canonical identifier for the given resource type.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ResourcePartition": { + "description": "The canonical AWS partition name that the Region is assigned to.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ResourceRegion": { + "description": "The canonical AWS external Region name where this resource is located.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ResourceTags": { + "description": "A list of AWS tags associated with a resource at the time the finding was processed.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/MapFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ResourceType": { + "description": "Specifies the type of the resource that details are provided for.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "Sample": { + "description": "Indicates whether or not sample findings are included in the filter results.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/BooleanFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "SeverityLabel": { + "description": "The label of a finding's severity.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "SeverityNormalized": { + "description": "The normalized severity of a finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/NumberFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "SeverityProduct": { + "description": "The native severity as defined by the security findings provider's solution that generated the finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/NumberFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "SourceUrl": { + "description": "A URL that links to a page about the current finding in the security findings provider's solution.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ThreatIntelIndicatorCategory": { + "description": "The category of a threat intelligence indicator.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ThreatIntelIndicatorLastObservedAt": { + "description": "A timestamp that identifies the last observation of a threat intelligence indicator.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/DateFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ThreatIntelIndicatorSource": { + "description": "The source of the threat intelligence.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ThreatIntelIndicatorSourceUrl": { + "description": "The URL for more details from the source of the threat intelligence.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ThreatIntelIndicatorType": { + "description": "The type of a threat intelligence indicator.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "ThreatIntelIndicatorValue": { + "description": "The value of a threat intelligence indicator.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "Title": { + "description": "A finding's title.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "Type": { + "description": "A finding type in the format of namespace/category/classifier that classifies a finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "UpdatedAt": { + "description": "An ISO8601-formatted timestamp that indicates when the security findings provider last updated the finding record.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/DateFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "UserDefinedFields": { + "description": "A list of name/value string pairs associated with the finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/MapFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "VerificationState": { + "description": "The veracity of a finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "VulnerabilitiesExploitAvailable": { + "description": "Indicates whether a software vulnerability in your environment has a known exploit.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "VulnerabilitiesFixAvailable": { + "description": "Indicates whether a vulnerability is fixed in a newer version of the affected software packages.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "WorkflowState": { + "description": "The workflow state of a finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + }, + "WorkflowStatus": { + "description": "The status of the investigation into a finding.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/StringFilter" + }, + "maxItems": 20, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "BooleanFilter": { + "additionalProperties": false, + "description": "Boolean filter for querying findings.", + "properties": { + "Value": { + "description": "The value of the boolean.", + "type": "boolean" + } + }, + "required": [ + "Value" + ], + "type": "object" + }, + "DateFilter": { + "additionalProperties": false, + "description": "A date filter for querying findings.", + "properties": { + "DateRange": { + "$ref": "#/definitions/DateRange" + }, + "End": { + "$ref": "#/definitions/ISO8601DateString" + }, + "Start": { + "$ref": "#/definitions/ISO8601DateString" + } + }, + "type": "object" + }, + "DateRange": { + "additionalProperties": false, + "description": "A date range for the date filter.", + "properties": { + "Unit": { + "description": "A date range unit for the date filter.", + "enum": [ + "DAYS" + ], + "type": "string" + }, + "Value": { + "description": "A date range value for the date filter.", + "type": "number" + } + }, + "required": [ + "Unit", + "Value" + ], + "type": "object" + }, + "ISO8601DateString": { + "description": "The date and time, in UTC and ISO 8601 format.", + "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)?)?)?)?$", + "type": "string" + }, + "IpFilter": { + "additionalProperties": false, + "description": "The IP filter for querying findings.", + "properties": { + "Cidr": { + "$ref": "#/definitions/NonEmptyString", + "description": "A finding's CIDR value." + } + }, + "required": [ + "Cidr" + ], + "type": "object" + }, + "KeywordFilter": { + "additionalProperties": false, + "description": "A keyword filter for querying findings.", + "properties": { + "Value": { + "$ref": "#/definitions/NonEmptyString", + "description": "A value for the keyword." + } + }, + "required": [ + "Value" + ], + "type": "object" + }, + "MapFilter": { + "additionalProperties": false, + "description": "A map filter for filtering AWS Security Hub findings.", + "properties": { + "Comparison": { + "description": "The condition to apply to the key value when filtering Security Hub findings with a map filter.", + "enum": [ + "EQUALS", + "NOT_EQUALS" + ], + "type": "string" + }, + "Key": { + "$ref": "#/definitions/NonEmptyString" + }, + "Value": { + "$ref": "#/definitions/NonEmptyString" + } + }, + "required": [ + "Comparison", + "Key", + "Value" + ], + "type": "object" + }, + "NonEmptyString": { + "description": "Non-empty string definition.", + "minLength": 1, + "type": "string" + }, + "NumberFilter": { + "additionalProperties": false, + "description": "A number filter for querying findings.", + "properties": { + "Eq": { + "description": "The equal-to condition to be applied to a single field when querying for findings.", + "type": "number" + }, + "Gte": { + "description": "The greater-than-equal condition to be applied to a single field when querying for findings.", + "type": "number" + }, + "Lte": { + "description": "The less-than-equal condition to be applied to a single field when querying for findings.", + "type": "number" + } + }, + "type": "object" + }, + "StringFilter": { + "additionalProperties": false, + "description": "A string filter for filtering AWS Security Hub findings.", + "properties": { + "Comparison": { + "$ref": "#/definitions/StringFilterComparison" + }, + "Value": { + "$ref": "#/definitions/NonEmptyString" + } + }, + "required": [ + "Comparison", + "Value" + ], + "type": "object" + }, + "StringFilterComparison": { + "description": "The condition to apply to a string value when filtering Security Hub findings.", + "enum": [ + "EQUALS", + "PREFIX", + "NOT_EQUALS", + "PREFIX_NOT_EQUALS" + ], + "type": "string" + } + }, + "deprecatedProperties": [ + "/properties/Filters/Keyword", + "/properties/Filters/ResourceAwsIamAccessKeyUserName", + "/properties/Filters/SeverityNormalized", + "/properties/Filters/SeverityProduct" + ], + "description": "The AWS::SecurityHub::Insight resource represents the AWS Security Hub Insight in your account. An AWS Security Hub insight is a collection of related findings.", + "handlers": { + "create": { + "permissions": [ + "securityhub:CreateInsight" + ] + }, + "delete": { + "permissions": [ + "securityhub:GetInsights", + "securityhub:DeleteInsight" + ] + }, + "list": { + "permissions": [ + "securityhub:GetInsights" + ] + }, + "read": { + "permissions": [ + "securityhub:GetInsights" + ] + }, + "update": { + "permissions": [ + "securityhub:UpdateInsight" + ] + } + }, + "primaryIdentifier": [ + "/properties/InsightArn" + ], + "properties": { + "Filters": { + "$ref": "#/definitions/AwsSecurityFindingFilters", + "description": "One or more attributes used to filter the findings included in the insight", + "maxProperties": 10 + }, + "GroupByAttribute": { + "$ref": "#/definitions/NonEmptyString", + "description": "The grouping attribute for the insight's findings" + }, + "InsightArn": { + "description": "The ARN of a Security Hub insight", + "pattern": "arn:aws\\S*:securityhub:\\S*", + "type": "string" + }, + "Name": { + "description": "The name of a Security Hub insight", + "maxLength": 128, + "minLength": 1, + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/InsightArn" + ], + "required": [ + "Filters", + "Name", + "GroupByAttribute" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-securityhub", + "tagging": { + "taggable": false + }, + "typeName": "AWS::SecurityHub::Insight" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::SecurityHub::OrganizationConfiguration.json b/artifacts/types/AWS::SecurityHub::OrganizationConfiguration.json new file mode 100644 index 00000000..83654bf0 --- /dev/null +++ b/artifacts/types/AWS::SecurityHub::OrganizationConfiguration.json @@ -0,0 +1,104 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SecurityHub-OrganizationConfiguration", + "type": "AWS::SecurityHub::OrganizationConfiguration", + "time": "2024-06-11T15:37:53.757Z", + "schema": { + "additionalProperties": false, + "description": "The AWS::SecurityHub::OrganizationConfiguration resource represents the configuration of your organization in Security Hub. Only the Security Hub administrator account can create Organization Configuration resource in each region and can opt-in to Central Configuration only in the aggregation region of FindingAggregator.", + "handlers": { + "create": { + "permissions": [ + "securityhub:UpdateOrganizationConfiguration", + "securityhub:DescribeOrganizationConfiguration", + "organizations:DescribeOrganization" + ] + }, + "delete": { + "permissions": [ + "securityhub:UpdateOrganizationConfiguration", + "securityhub:DescribeOrganizationConfiguration", + "securityhub:ListFindingAggregators", + "organizations:DescribeOrganization" + ] + }, + "list": { + "permissions": [ + "securityhub:DescribeOrganizationConfiguration" + ] + }, + "read": { + "permissions": [ + "securityhub:DescribeOrganizationConfiguration" + ] + }, + "update": { + "permissions": [ + "securityhub:UpdateOrganizationConfiguration", + "securityhub:DescribeOrganizationConfiguration", + "organizations:DescribeOrganization" + ] + } + }, + "primaryIdentifier": [ + "/properties/OrganizationConfigurationIdentifier" + ], + "properties": { + "AutoEnable": { + "description": "Whether to automatically enable Security Hub in new member accounts when they join the organization.", + "type": "boolean" + }, + "AutoEnableStandards": { + "description": "Whether to automatically enable Security Hub default standards in new member accounts when they join the organization.", + "enum": [ + "DEFAULT", + "NONE" + ], + "type": "string" + }, + "ConfigurationType": { + "description": "Indicates whether the organization uses local or central configuration.", + "enum": [ + "CENTRAL", + "LOCAL" + ], + "type": "string" + }, + "MemberAccountLimitReached": { + "description": "Whether the maximum number of allowed member accounts are already associated with the Security Hub administrator account.", + "type": "boolean" + }, + "OrganizationConfigurationIdentifier": { + "description": "The identifier of the OrganizationConfiguration being created and assigned as the unique identifier.", + "pattern": "^[0-9]{12}/[a-zA-Z0-9-]{1,32}/securityhub-organization-configuration$", + "type": "string" + }, + "Status": { + "description": "Describes whether central configuration could be enabled as the ConfigurationType for the organization.", + "enum": [ + "PENDING", + "ENABLED", + "FAILED" + ], + "type": "string" + }, + "StatusMessage": { + "description": "Provides an explanation if the value of Status is equal to FAILED when ConfigurationType is equal to CENTRAL.", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/OrganizationConfigurationIdentifier", + "/properties/Status", + "/properties/StatusMessage", + "/properties/MemberAccountLimitReached" + ], + "required": [ + "AutoEnable" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-securityhub", + "tagging": { + "taggable": false + }, + "typeName": "AWS::SecurityHub::OrganizationConfiguration" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::SecurityHub::PolicyAssociation.json b/artifacts/types/AWS::SecurityHub::PolicyAssociation.json new file mode 100644 index 00000000..d97c3b3f --- /dev/null +++ b/artifacts/types/AWS::SecurityHub::PolicyAssociation.json @@ -0,0 +1,113 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SecurityHub-PolicyAssociation", + "type": "AWS::SecurityHub::PolicyAssociation", + "time": "2024-06-07T21:02:40.649Z", + "schema": { + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/TargetId", + "/properties/TargetType" + ], + "description": "The AWS::SecurityHub::PolicyAssociation resource represents the AWS Security Hub Central Configuration Policy associations in your Target. Only the AWS Security Hub delegated administrator can create the resouce from the home region.", + "handlers": { + "create": { + "permissions": [ + "securityhub:StartConfigurationPolicyAssociation", + "securityhub:GetConfigurationPolicyAssociation" + ] + }, + "delete": { + "permissions": [ + "securityhub:StartConfigurationPolicyDisassociation", + "securityhub:GetConfigurationPolicyAssociation" + ] + }, + "list": { + "permissions": [ + "securityhub:ListConfigurationPolicyAssociations" + ] + }, + "read": { + "permissions": [ + "securityhub:GetConfigurationPolicyAssociation", + "securityhub:GetConfigurationPolicyAssociation" + ] + }, + "update": { + "permissions": [ + "securityhub:StartConfigurationPolicyAssociation", + "securityhub:GetConfigurationPolicyAssociation" + ] + } + }, + "primaryIdentifier": [ + "/properties/AssociationIdentifier" + ], + "properties": { + "AssociationIdentifier": { + "description": "A unique identifier to indicates if the target has an association", + "type": "string" + }, + "AssociationStatus": { + "description": "The current status of the association between the specified target and the configuration", + "enum": [ + "SUCCESS", + "PENDING", + "FAILED" + ], + "type": "string" + }, + "AssociationStatusMessage": { + "description": "An explanation for a FAILED value for AssociationStatus", + "type": "string" + }, + "AssociationType": { + "description": "Indicates whether the association between the specified target and the configuration was directly applied by the Security Hub delegated administrator or inherited from a parent", + "enum": [ + "APPLIED", + "INHERITED" + ], + "type": "string" + }, + "ConfigurationPolicyId": { + "description": "The universally unique identifier (UUID) of the configuration policy or a value of SELF_MANAGED_SECURITY_HUB for a self-managed configuration", + "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^SELF_MANAGED_SECURITY_HUB$", + "type": "string" + }, + "TargetId": { + "description": "The identifier of the target account, organizational unit, or the root", + "type": "string" + }, + "TargetType": { + "description": "Indicates whether the target is an AWS account, organizational unit, or the organization root", + "enum": [ + "ACCOUNT", + "ORGANIZATIONAL_UNIT", + "ROOT" + ], + "type": "string" + }, + "UpdatedAt": { + "description": "The date and time, in UTC and ISO 8601 format, that the configuration policy association was last updated", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/AssociationStatus", + "/properties/AssociationType", + "/properties/AssociationStatusMessage", + "/properties/UpdatedAt", + "/properties/AssociationIdentifier" + ], + "required": [ + "TargetId", + "TargetType", + "ConfigurationPolicyId" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-securityhub", + "tagging": { + "taggable": false + }, + "typeName": "AWS::SecurityHub::PolicyAssociation" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::SecurityHub::SecurityControl.json b/artifacts/types/AWS::SecurityHub::SecurityControl.json new file mode 100644 index 00000000..e7921601 --- /dev/null +++ b/artifacts/types/AWS::SecurityHub::SecurityControl.json @@ -0,0 +1,224 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SecurityHub-SecurityControl", + "type": "AWS::SecurityHub::SecurityControl", + "time": "2024-06-24T16:11:02.128Z", + "schema": { + "additionalIdentifiers": [ + [ + "/properties/SecurityControlArn" + ] + ], + "additionalProperties": false, + "anyOf": [ + { + "required": [ + "SecurityControlId" + ] + }, + { + "required": [ + "SecurityControlArn" + ] + } + ], + "definitions": { + "IntegerList": { + "items": { + "type": "integer" + }, + "type": "array" + }, + "NonEmptyString": { + "pattern": ".*\\S.*", + "type": "string" + }, + "NonEmptyStringList": { + "items": { + "$ref": "#/definitions/NonEmptyString" + }, + "type": "array" + }, + "ParameterConfiguration": { + "additionalProperties": false, + "properties": { + "Value": { + "$ref": "#/definitions/ParameterValue" + }, + "ValueType": { + "enum": [ + "DEFAULT", + "CUSTOM" + ], + "type": "string" + } + }, + "required": [ + "ValueType" + ], + "type": "object" + }, + "ParameterValue": { + "additionalProperties": false, + "oneOf": [ + { + "required": [ + "Boolean" + ] + }, + { + "required": [ + "Double" + ] + }, + { + "required": [ + "Enum" + ] + }, + { + "required": [ + "EnumList" + ] + }, + { + "required": [ + "Integer" + ] + }, + { + "required": [ + "IntegerList" + ] + }, + { + "required": [ + "String" + ] + }, + { + "required": [ + "StringList" + ] + } + ], + "properties": { + "Boolean": { + "description": "A control parameter that is a boolean.", + "type": "boolean" + }, + "Double": { + "description": "A control parameter that is a double.", + "type": "number" + }, + "Enum": { + "$ref": "#/definitions/NonEmptyString", + "description": "A control parameter that is a enum." + }, + "EnumList": { + "$ref": "#/definitions/NonEmptyStringList", + "description": "A control parameter that is a list of enums." + }, + "Integer": { + "description": "A control parameter that is a integer.", + "type": "integer" + }, + "IntegerList": { + "$ref": "#/definitions/IntegerList", + "description": "A control parameter that is a list of integers." + }, + "String": { + "$ref": "#/definitions/NonEmptyString", + "description": "A control parameter that is a string." + }, + "StringList": { + "$ref": "#/definitions/NonEmptyStringList", + "description": "A control parameter that is a list of strings." + } + }, + "type": "object" + }, + "Parameters": { + "additionalProperties": false, + "patternProperties": { + ".*\\S.*": { + "$ref": "#/definitions/ParameterConfiguration" + } + }, + "type": "object" + } + }, + "description": "A security control in Security Hub describes a security best practice related to a specific resource.", + "handlers": { + "create": { + "permissions": [ + "securityhub:BatchGetSecurityControls", + "securityhub:DescribeStandardsControls", + "securityhub:UpdateSecurityControl", + "securityhub:UpdateStandardsControl" + ], + "timeoutInMinutes": 2160 + }, + "delete": { + "permissions": [ + "securityhub:BatchGetSecurityControls", + "securityhub:DescribeStandardsControls", + "securityhub:UpdateSecurityControl", + "securityhub:UpdateStandardsControl" + ], + "timeoutInMinutes": 2160 + }, + "list": { + "permissions": [ + "securityhub:BatchGetSecurityControls", + "securityhub:DescribeStandardsControls", + "securityhub:ListSecurityControlDefinitions" + ] + }, + "read": { + "permissions": [ + "securityhub:BatchGetSecurityControls", + "securityhub:DescribeStandardsControls" + ] + }, + "update": { + "permissions": [ + "securityhub:BatchGetSecurityControls", + "securityhub:DescribeStandardsControls", + "securityhub:UpdateSecurityControl", + "securityhub:UpdateStandardsControl" + ], + "timeoutInMinutes": 2160 + } + }, + "primaryIdentifier": [ + "/properties/SecurityControlId" + ], + "properties": { + "LastUpdateReason": { + "description": "The most recent reason for updating the customizable properties of a security control. This differs from the UpdateReason field of the BatchUpdateStandardsControlAssociations API, which tracks the reason for updating the enablement status of a control. This field accepts alphanumeric characters in addition to white spaces, dashes, and underscores.", + "pattern": "^([^\u0000-]|[-_ a-zA-Z0-9])+$", + "type": "string" + }, + "Parameters": { + "$ref": "#/definitions/Parameters", + "description": "An object that identifies the name of a control parameter, its current value, and whether it has been customized." + }, + "SecurityControlArn": { + "$ref": "#/definitions/NonEmptyString", + "description": "The Amazon Resource Name (ARN) for a security control across standards, such as `arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1`. This parameter doesn't mention a specific standard." + }, + "SecurityControlId": { + "$ref": "#/definitions/NonEmptyString", + "description": "The unique identifier of a security control across standards. Values for this field typically consist of an AWS service name and a number, such as APIGateway.3." + } + }, + "required": [ + "Parameters" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-securityhub", + "tagging": { + "taggable": false + }, + "typeName": "AWS::SecurityHub::SecurityControl" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::SecurityHub::Standard.json b/artifacts/types/AWS::SecurityHub::Standard.json index 58581b23..6903a7ea 100644 --- a/artifacts/types/AWS::SecurityHub::Standard.json +++ b/artifacts/types/AWS::SecurityHub::Standard.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SecurityHub-Standard", "type": "AWS::SecurityHub::Standard", - "time": "2024-01-02T17:01:50.909Z", + "time": "2024-06-24T16:07:17.551Z", "schema": { "additionalIdentifiers": [ [ @@ -15,14 +15,14 @@ "definitions": { "StandardsControl": { "additionalProperties": false, - "description": "An individual StandardsControl within the Standard.", + "description": "Provides details about an individual security control. For a list of ASH controls, see [controls reference](https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-controls-reference.html) in the *User Guide*.", "properties": { "Reason": { - "description": "the reason the standard control is disabled", + "description": "A user-defined reason for changing a control's enablement status in a specified standard. If you are disabling a control, then this property is required.", "type": "string" }, "StandardsControlArn": { - "description": "the Arn for the standard control.", + "description": "The Amazon Resource Name (ARN) of the control.", "pattern": "arn:aws\\S*:securityhub:\\S*", "type": "string" } @@ -33,7 +33,7 @@ "type": "object" } }, - "description": "The AWS::SecurityHub::Standard resource represents the implementation of an individual AWS Security Hub Standard in your account. It requires you have SecurityHub enabled before you can enable the Standard.", + "description": "The ``AWS::SecurityHub::Standard`` resource specifies the enablement of a security standard. The standard is identified by the ``StandardsArn`` property. To view a list of ASH standards and their Amazon Resource Names (ARNs), use the [DescribeStandards](https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_DescribeStandards.html) API operation.\n You must create a separate ``AWS::SecurityHub::Standard`` resource for each standard that you want to enable.\n For more information about ASH standards, see [standards reference](https://docs.aws.amazon.com/securityhub/latest/userguide/standards-reference.html) in the *User Guide*.", "handlers": { "create": { "permissions": [ @@ -71,7 +71,7 @@ ], "properties": { "DisabledStandardsControls": { - "description": "StandardsControls to disable from this Standard.", + "description": "Specifies which controls are to be disabled in a standard. \n *Maximum*: ``100``", "insertionOrder": true, "items": { "$ref": "#/definitions/StandardsControl" @@ -82,12 +82,12 @@ "uniqueItems": true }, "StandardsArn": { - "description": "The ARN of the Standard being enabled", + "description": "The ARN of the standard that you want to enable. To view a list of available ASH standards and their ARNs, use the [DescribeStandards](https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_DescribeStandards.html) API operation.", "pattern": "arn:aws\\S*:securityhub:\\S", "type": "string" }, "StandardsSubscriptionArn": { - "description": "The ARN of the StandardsSubscription for the account ID, region, and Standard.", + "description": "", "pattern": "arn:aws\\S*:securityhub:\\S*", "type": "string" } diff --git a/artifacts/types/AWS::SecurityLake::AwsLogSource.json b/artifacts/types/AWS::SecurityLake::AwsLogSource.json new file mode 100644 index 00000000..7e39407b --- /dev/null +++ b/artifacts/types/AWS::SecurityLake::AwsLogSource.json @@ -0,0 +1,101 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SecurityLake-AwsLogSource", + "type": "AWS::SecurityLake::AwsLogSource", + "time": "2024-06-20T23:44:11.415Z", + "schema": { + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DataLakeArn", + "/properties/SourceName", + "/properties/SourceVersion" + ], + "description": "Resource Type definition for AWS::SecurityLake::AwsLogSource", + "handlers": { + "create": { + "permissions": [ + "glue:CreateDatabase", + "glue:CreateTable", + "glue:GetDatabase", + "glue:GetTable", + "iam:CreateServiceLinkedRole", + "kms:CreateGrant", + "kms:DescribeKey", + "securitylake:CreateDataLake", + "securitylake:CreateAwsLogSource", + "securitylake:ListLogSources" + ] + }, + "delete": { + "permissions": [ + "securitylake:DeleteAwsLogSource", + "securitylake:ListLogSources" + ] + }, + "list": { + "permissions": [ + "securitylake:ListLogSources" + ] + }, + "read": { + "permissions": [ + "securitylake:ListLogSources" + ] + }, + "update": { + "permissions": [ + "securitylake:CreateAwsLogSource", + "securitylake:DeleteAwsLogSource", + "glue:CreateDatabase", + "glue:CreateTable", + "glue:GetDatabase", + "glue:GetTable", + "iam:CreateServiceLinkedRole", + "kms:CreateGrant", + "kms:DescribeKey" + ] + } + }, + "primaryIdentifier": [ + "/properties/SourceName", + "/properties/SourceVersion" + ], + "properties": { + "Accounts": { + "description": "AWS account where you want to collect logs from.", + "insertionOrder": false, + "items": { + "pattern": "^[0-9]{12}$", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "DataLakeArn": { + "description": "The ARN for the data lake.", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "SourceName": { + "description": "The name for a AWS source. This must be a Regionally unique value.", + "type": "string" + }, + "SourceVersion": { + "description": "The version for a AWS source. This must be a Regionally unique value.", + "pattern": "^(latest|[0-9]\\.[0-9])$", + "type": "string" + } + }, + "replacementStrategy": "delete_then_create", + "required": [ + "DataLakeArn", + "SourceVersion", + "SourceName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-securitylake.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::SecurityLake::AwsLogSource" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::SecurityLake::DataLake.json b/artifacts/types/AWS::SecurityLake::DataLake.json new file mode 100644 index 00000000..832d4ae1 --- /dev/null +++ b/artifacts/types/AWS::SecurityLake::DataLake.json @@ -0,0 +1,230 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SecurityLake-DataLake", + "type": "AWS::SecurityLake::DataLake", + "time": "2024-05-30T00:28:44.482Z", + "schema": { + "additionalProperties": false, + "definitions": { + "Days": { + "description": "Number of days before data expires in the Amazon Security Lake object.", + "minimum": 1, + "type": "integer" + }, + "EncryptionConfiguration": { + "additionalProperties": false, + "description": "Provides encryption details of Amazon Security Lake object.", + "properties": { + "KmsKeyId": { + "description": "The id of KMS encryption key used by Amazon Security Lake to encrypt the Security Lake object.", + "type": "string" + } + }, + "type": "object" + }, + "Expiration": { + "additionalProperties": false, + "description": "Provides data expiration details of Amazon Security Lake object.", + "properties": { + "Days": { + "$ref": "#/definitions/Days" + } + }, + "type": "object" + }, + "LifecycleConfiguration": { + "additionalProperties": false, + "description": "Provides lifecycle details of Amazon Security Lake object.", + "properties": { + "Expiration": { + "$ref": "#/definitions/Expiration" + }, + "Transitions": { + "description": "Provides data storage transition details of Amazon Security Lake object.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Transitions" + }, + "type": "array", + "uniqueItems": false + } + }, + "type": "object" + }, + "Regions": { + "description": "Replication enables automatic, asynchronous copying of objects across Amazon S3 buckets. Amazon 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 AWS Regions or within the same Region as the source bucket.", + "insertionOrder": false, + "items": { + "pattern": "^(af|ap|ca|eu|me|sa|us)-(central|north|(north(?:east|west))|south|south(?:east|west)|east|west)-\\d+$", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "ReplicationConfiguration": { + "additionalProperties": false, + "description": "Provides replication details of Amazon Security Lake object.", + "properties": { + "Regions": { + "$ref": "#/definitions/Regions" + }, + "RoleArn": { + "description": "Replication 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.", + "pattern": "^arn:.*$", + "type": "string" + } + }, + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, `_`, `.`, `/`, `=`, `+`, and `-`.", + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 characters in length.", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "Transitions": { + "additionalProperties": false, + "properties": { + "Days": { + "description": "Number of days before data transitions to a different S3 Storage Class in the Amazon Security Lake object.", + "minimum": 1, + "type": "integer" + }, + "StorageClass": { + "description": "The range of storage classes that you can choose from based on the data access, resiliency, and cost requirements of your workloads.", + "type": "string" + } + }, + "type": "object" + } + }, + "description": "Resource Type definition for AWS::SecurityLake::DataLake", + "handlers": { + "create": { + "permissions": [ + "events:*", + "iam:CreateServiceLinkedRole", + "iam:GetRole", + "iam:ListAttachedRolePolicies", + "iam:PutRolePolicy", + "iam:PassRole", + "glue:*", + "organizations:*", + "kms:DescribeKey", + "kms:CreateGrant", + "lakeformation:*", + "lambda:*", + "s3:*", + "securitylake:CreateDataLake", + "securitylake:TagResource", + "securitylake:List*", + "sqs:*" + ] + }, + "delete": { + "permissions": [ + "organizations:*", + "securitylake:DeleteDataLake", + "securitylake:List*" + ] + }, + "list": { + "permissions": [ + "securitylake:List*" + ] + }, + "read": { + "permissions": [ + "securitylake:List*" + ] + }, + "update": { + "permissions": [ + "events:*", + "iam:CreateServiceLinkedRole", + "iam:DeleteRolePolicy", + "iam:GetRole", + "iam:PassRole", + "iam:PutRolePolicy", + "kms:DescribeKey", + "kms:CreateGrant", + "lakeformation:*", + "lambda:*", + "organizations:*", + "s3:*", + "securitylake:List*", + "securitylake:TagResource", + "securitylake:UntagResource", + "securitylake:UpdateDataLake", + "sqs:*" + ] + } + }, + "primaryIdentifier": [ + "/properties/Arn" + ], + "properties": { + "Arn": { + "description": "The Amazon Resource Name (ARN) created by you to provide to the subscriber.", + "maxLength": 1011, + "minLength": 1, + "type": "string" + }, + "EncryptionConfiguration": { + "$ref": "#/definitions/EncryptionConfiguration" + }, + "LifecycleConfiguration": { + "$ref": "#/definitions/LifecycleConfiguration" + }, + "MetaStoreManagerRoleArn": { + "description": "The Amazon Resource Name (ARN) used to index AWS Glue table partitions that are generated by the ingestion and normalization of AWS log sources and custom sources.", + "pattern": "^arn:.*$", + "type": "string" + }, + "ReplicationConfiguration": { + "$ref": "#/definitions/ReplicationConfiguration" + }, + "S3BucketArn": { + "description": "The ARN for the Amazon Security Lake Amazon S3 bucket.", + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + } + }, + "readOnlyProperties": [ + "/properties/Arn", + "/properties/S3BucketArn" + ], + "replacementStrategy": "delete_then_create", + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-securitylake.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::SecurityLake::DataLake", + "writeOnlyProperties": [ + "/properties/MetaStoreManagerRoleArn" + ] + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::SecurityLake::Subscriber.json b/artifacts/types/AWS::SecurityLake::Subscriber.json new file mode 100644 index 00000000..d26c789f --- /dev/null +++ b/artifacts/types/AWS::SecurityLake::Subscriber.json @@ -0,0 +1,312 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SecurityLake-Subscriber", + "type": "AWS::SecurityLake::Subscriber", + "time": "2024-06-20T23:44:16.573Z", + "schema": { + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/DataLakeArn" + ], + "definitions": { + "AccessTypes": { + "description": "The Amazon S3 or AWS Lake Formation access type.", + "insertionOrder": true, + "items": { + "enum": [ + "LAKEFORMATION", + "S3" + ], + "type": "string" + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "AwsLogSource": { + "additionalProperties": false, + "description": "Amazon Security Lake supports log and event collection for natively supported AWS services.", + "properties": { + "SourceName": { + "description": "The name for a AWS source. This must be a Regionally unique value.", + "type": "string" + }, + "SourceVersion": { + "description": "The version for a AWS source. This must be a Regionally unique value.", + "pattern": "^(latest|[0-9]\\.[0-9])$", + "type": "string" + } + }, + "type": "object" + }, + "CustomLogSource": { + "additionalProperties": false, + "properties": { + "SourceName": { + "description": "The name for a third-party custom source. This must be a Regionally unique value.", + "maxLength": 64, + "minLength": 1, + "pattern": "^[\\\\\\w\\-_:/.]*$", + "type": "string" + }, + "SourceVersion": { + "description": "The version for a third-party custom source. This must be a Regionally unique value.", + "maxLength": 32, + "minLength": 1, + "pattern": "^[A-Za-z0-9\\-\\.\\_]*$", + "type": "string" + } + }, + "type": "object" + }, + "Source": { + "additionalProperties": false, + "oneOf": [ + { + "required": [ + "AwsLogSource" + ] + }, + { + "required": [ + "CustomLogSource" + ] + } + ], + "properties": { + "AwsLogSource": { + "$ref": "#/definitions/AwsLogSource" + }, + "CustomLogSource": { + "$ref": "#/definitions/CustomLogSource" + } + } + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "description": "The name of the tag. This is a general label that acts as a category for a more specific tag value (value).", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value that is associated with the specified tag key (key). This value acts as a descriptor for the tag key. A tag value cannot be null, but it can be an empty string.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + }, + "description": "Resource Type definition for AWS::SecurityLake::Subscriber", + "handlers": { + "create": { + "permissions": [ + "securitylake:CreateSubscriber", + "securitylake:CreateCustomLogSource", + "securitylake:CreateDataLake", + "securitylake:TagResource", + "securitylake:GetSubscriber", + "securitylake:ListTagsForResource", + "iam:GetRole", + "iam:GetRolePolicy", + "iam:PutRolePolicy", + "iam:CreateRole", + "iam:CreateServiceLinkedRole", + "glue:GetDatabase", + "glue:GetTable", + "lakeformation:RegisterResource", + "lakeformation:GrantPermissions", + "lakeformation:RevokePermissions", + "lakeformation:ListPermissions", + "ram:GetResourceShareAssociations", + "ram:CreateResourceShare", + "ram:UpdateResourceShare", + "ram:GetResourceShares" + ] + }, + "delete": { + "permissions": [ + "securitylake:DeleteSubscriber", + "iam:GetRole", + "iam:ListRolePolicies", + "iam:DeleteRole", + "iam:DeleteRolePolicy", + "glue:GetTable", + "lakeformation:RevokePermissions", + "lakeformation:ListPermissions", + "ram:GetResourceShares", + "ram:DeleteResourceShare", + "events:DeleteApiDestination", + "events:DeleteConnection", + "events:DeleteRule", + "events:ListApiDestinations", + "events:ListTargetsByRule", + "events:DescribeRule", + "events:RemoveTargets", + "sqs:DeleteQueue", + "sqs:GetQueueUrl" + ] + }, + "list": { + "permissions": [ + "securitylake:ListSubscribers" + ] + }, + "read": { + "permissions": [ + "securitylake:GetSubscriber", + "securitylake:ListTagsForResource" + ] + }, + "update": { + "permissions": [ + "securitylake:UpdateSubscriber", + "securitylake:GetSubscriber", + "securitylake:TagResource", + "securitylake:UntagResource", + "securitylake:ListTagsForResource", + "glue:GetDatabase", + "glue:GetTable", + "lakeformation:ListPermissions", + "lakeformation:GrantPermissions", + "lakeformation:RevokePermissions", + "ram:CreateResourceShare", + "ram:GetResourceShares", + "ram:GetResourceShareAssociations", + "ram:UpdateResourceShare", + "ram:DeleteResourceShare", + "iam:CreateRole", + "iam:GetRole", + "iam:DeleteRole", + "iam:PutRolePolicy", + "iam:DeleteRolePolicy", + "iam:ListRolePolicies", + "events:CreateApiDestination", + "events:CreateConnection", + "events:ListApiDestinations", + "events:ListConnections", + "events:PutRule", + "events:UpdateApiDestination", + "events:UpdateConnection", + "events:DeleteApiDestination", + "events:DeleteConnection", + "events:DeleteRule", + "events:RemoveTargets", + "events:ListTargetsByRule", + "events:DescribeRule", + "events:PutTargets" + ] + } + }, + "primaryIdentifier": [ + "/properties/SubscriberArn" + ], + "properties": { + "AccessTypes": { + "$ref": "#/definitions/AccessTypes" + }, + "DataLakeArn": { + "description": "The ARN for the data lake.", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "ResourceShareArn": { + "type": "string" + }, + "ResourceShareName": { + "type": "string" + }, + "S3BucketArn": { + "type": "string" + }, + "Sources": { + "description": "The supported AWS services from which logs and events are collected.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/Source" + }, + "type": "array" + }, + "SubscriberArn": { + "type": "string" + }, + "SubscriberDescription": { + "description": "The description for your subscriber account in Security Lake.", + "type": "string" + }, + "SubscriberIdentity": { + "additionalProperties": false, + "description": "The AWS identity used to access your data.", + "properties": { + "ExternalId": { + "description": "The external ID used to establish trust relationship with the AWS identity.", + "maxLength": 1224, + "minLength": 2, + "pattern": "^[\\w+=,.@:/-]*$", + "type": "string" + }, + "Principal": { + "description": "The AWS identity principal.", + "pattern": "^([0-9]{12}|[a-z0-9\\.\\-]*\\.(amazonaws|amazon)\\.com)$", + "type": "string" + } + }, + "required": [ + "ExternalId", + "Principal" + ], + "type": "object" + }, + "SubscriberName": { + "description": "The name of your Security Lake subscriber account.", + "maxLength": 64, + "minLength": 1, + "pattern": "^[\\\\\\w\\s\\-_:/,.@=+]*$", + "type": "string" + }, + "SubscriberRoleArn": { + "type": "string" + }, + "Tags": { + "description": "An array of objects, one for each tag to associate with the subscriber. For each tag, you must specify both a tag key and a tag value. A tag value cannot be null, but it can be an empty string.", + "insertionOrder": true, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/SubscriberArn", + "/properties/S3BucketArn", + "/properties/SubscriberRoleArn", + "/properties/ResourceShareArn", + "/properties/ResourceShareName" + ], + "replacementStrategy": "delete_then_create", + "required": [ + "AccessTypes", + "DataLakeArn", + "Sources", + "SubscriberIdentity", + "SubscriberName" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-securitylake.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::SecurityLake::Subscriber" + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::SecurityLake::SubscriberNotification.json b/artifacts/types/AWS::SecurityLake::SubscriberNotification.json new file mode 100644 index 00000000..8c2c7b5b --- /dev/null +++ b/artifacts/types/AWS::SecurityLake::SubscriberNotification.json @@ -0,0 +1,211 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SecurityLake-SubscriberNotification", + "type": "AWS::SecurityLake::SubscriberNotification", + "time": "2024-06-21T00:19:15.485Z", + "schema": { + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/SubscriberArn" + ], + "definitions": { + "HttpsNotificationConfiguration": { + "additionalProperties": false, + "description": "The configuration for HTTPS subscriber notification.", + "properties": { + "AuthorizationApiKeyName": { + "description": "The key name for the notification subscription.", + "type": "string" + }, + "AuthorizationApiKeyValue": { + "description": "The key value for the notification subscription.", + "type": "string" + }, + "Endpoint": { + "description": "The subscription endpoint in Security Lake.", + "pattern": "^https?://.+$", + "type": "string" + }, + "HttpMethod": { + "description": "The HTTPS method used for the notification subscription.", + "enum": [ + "POST", + "PUT" + ], + "type": "string" + }, + "TargetRoleArn": { + "description": "The Amazon Resource Name (ARN) of the EventBridge API destinations IAM role that you created.", + "pattern": "^arn:.*$", + "type": "string" + } + }, + "required": [ + "Endpoint", + "TargetRoleArn" + ], + "type": "object" + }, + "NotificationConfiguration": { + "additionalProperties": false, + "oneOf": [ + { + "required": [ + "HttpsNotificationConfiguration" + ] + }, + { + "required": [ + "SqsNotificationConfiguration" + ] + } + ], + "properties": { + "HttpsNotificationConfiguration": { + "$ref": "#/definitions/HttpsNotificationConfiguration" + }, + "SqsNotificationConfiguration": { + "$ref": "#/definitions/SqsNotificationConfiguration" + } + }, + "type": "object" + }, + "SqsNotificationConfiguration": { + "description": "The configurations for SQS subscriber notification. The members of this structure are context-dependent.", + "type": "object" + } + }, + "description": "Resource Type definition for AWS::SecurityLake::SubscriberNotification", + "handlers": { + "create": { + "permissions": [ + "securitylake:CreateDataLake", + "securitylake:CreateSubscriber", + "securitylake:CreateSubscriberNotification", + "securitylake:GetSubscriber", + "iam:CreateServiceLinkedRole", + "iam:PutRolePolicy", + "iam:DeleteRolePolicy", + "iam:PassRole", + "s3:PutBucketNotification", + "s3:GetBucketNotification", + "events:CreateApiDestination", + "events:CreateConnection", + "events:CreateRule", + "events:UpdateConnection", + "events:DeleteConnection", + "events:UpdateApiDestination", + "events:DeleteApiDestination", + "events:ListApiDestinations", + "events:ListConnections", + "events:PutRule", + "events:DescribeRule", + "events:DeleteRule", + "events:PutTargets", + "events:RemoveTargets", + "events:ListTargetsByRule", + "secretsmanager:CreateSecret", + "sqs:CreateQueue", + "sqs:GetQueueAttributes", + "sqs:GetQueueUrl", + "sqs:SetQueueAttributes" + ] + }, + "delete": { + "permissions": [ + "securitylake:DeleteSubscriberNotification", + "securitylake:GetSubscriber", + "iam:DeleteRole", + "iam:DeleteRolePolicy", + "events:DeleteApiDestination", + "events:DeleteConnection", + "events:DeleteRule", + "events:ListTargetsByRule", + "events:DescribeRule", + "events:RemoveTargets", + "sqs:DeleteQueue" + ] + }, + "list": { + "permissions": [ + "securitylake:ListSubscribers" + ] + }, + "read": { + "permissions": [ + "securitylake:GetSubscriber" + ] + }, + "update": { + "permissions": [ + "securitylake:UpdateSubscriberNotification", + "securitylake:GetSubscriber", + "iam:CreateServiceLinkedRole", + "iam:PutRolePolicy", + "iam:DeleteRolePolicy", + "iam:PassRole", + "events:CreateApiDestination", + "events:CreateConnection", + "events:UpdateConnection", + "events:DeleteConnection", + "events:UpdateApiDestination", + "events:DeleteApiDestination", + "events:DeleteRule", + "events:ListApiDestinations", + "events:ListConnections", + "events:PutRule", + "events:DescribeRule", + "events:DeleteRule", + "events:PutTargets", + "events:RemoveTargets", + "events:ListTargetsByRule", + "secretsmanager:CreateSecret", + "s3:GetBucketNotificationConfiguration", + "s3:PutBucketNotificationConfiguration", + "s3:PutBucketNotification", + "s3:GetBucketNotification", + "sqs:CreateQueue", + "sqs:DeleteQueue", + "sqs:GetQueueAttributes", + "sqs:SetQueueAttributes" + ] + } + }, + "primaryIdentifier": [ + "/properties/SubscriberArn" + ], + "properties": { + "NotificationConfiguration": { + "$ref": "#/definitions/NotificationConfiguration" + }, + "SubscriberArn": { + "description": "The ARN for the subscriber", + "pattern": "^arn:.*$", + "type": "string" + }, + "SubscriberEndpoint": { + "description": "The endpoint the subscriber should listen to for notifications", + "type": "string" + } + }, + "readOnlyProperties": [ + "/properties/SubscriberEndpoint" + ], + "replacementStrategy": "delete_then_create", + "required": [ + "SubscriberArn", + "NotificationConfiguration" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-securitylake.git", + "tagging": { + "taggable": false + }, + "typeName": "AWS::SecurityLake::SubscriberNotification", + "writeOnlyProperties": [ + "/properties/NotificationConfiguration/HttpsNotificationConfiguration/AuthorizationApiKeyName", + "/properties/NotificationConfiguration/HttpsNotificationConfiguration/AuthorizationApiKeyValue", + "/properties/NotificationConfiguration/HttpsNotificationConfiguration/Endpoint", + "/properties/NotificationConfiguration/HttpsNotificationConfiguration/HttpMethod", + "/properties/NotificationConfiguration/HttpsNotificationConfiguration/TargetRoleArn" + ] + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::ServiceCatalog::CloudFormationProvisionedProduct.json b/artifacts/types/AWS::ServiceCatalog::CloudFormationProvisionedProduct.json index 4a986f04..bf6f5155 100644 --- a/artifacts/types/AWS::ServiceCatalog::CloudFormationProvisionedProduct.json +++ b/artifacts/types/AWS::ServiceCatalog::CloudFormationProvisionedProduct.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ServiceCatalog-CloudFormationProvisionedProduct", "type": "AWS::ServiceCatalog::CloudFormationProvisionedProduct", - "time": "2023-12-19T17:21:13.02Z", + "time": "2024-02-06T18:51:37.129Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::ServiceCatalog::ServiceAction.json b/artifacts/types/AWS::ServiceCatalog::ServiceAction.json index 00b07b1a..89a1bf4d 100644 --- a/artifacts/types/AWS::ServiceCatalog::ServiceAction.json +++ b/artifacts/types/AWS::ServiceCatalog::ServiceAction.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ServiceCatalog-ServiceAction", "type": "AWS::ServiceCatalog::ServiceAction", - "time": "2024-01-04T16:57:20.138Z", + "time": "2024-06-06T16:24:13.063Z", "schema": { "additionalProperties": false, "definitions": { diff --git a/artifacts/types/AWS::ServiceCatalogAppRegistry::Application.json b/artifacts/types/AWS::ServiceCatalogAppRegistry::Application.json index 4f266943..6de366fb 100644 --- a/artifacts/types/AWS::ServiceCatalogAppRegistry::Application.json +++ b/artifacts/types/AWS::ServiceCatalogAppRegistry::Application.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ServiceCatalogAppRegistry-Application", "type": "AWS::ServiceCatalogAppRegistry::Application", - "time": "2024-01-03T17:05:10.683Z", + "time": "2024-06-18T15:31:42.933Z", "schema": { "additionalIdentifiers": [ [ diff --git a/artifacts/types/AWS::ServiceCatalogAppRegistry::AttributeGroup.json b/artifacts/types/AWS::ServiceCatalogAppRegistry::AttributeGroup.json index d9160d2f..24f034ce 100644 --- a/artifacts/types/AWS::ServiceCatalogAppRegistry::AttributeGroup.json +++ b/artifacts/types/AWS::ServiceCatalogAppRegistry::AttributeGroup.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-ServiceCatalogAppRegistry-AttributeGroup", "type": "AWS::ServiceCatalogAppRegistry::AttributeGroup", - "time": "2024-01-03T17:05:16.425Z", + "time": "2024-06-18T15:31:11.934Z", "schema": { "additionalIdentifiers": [ [ diff --git a/artifacts/types/AWS::Shield::DRTAccess.json b/artifacts/types/AWS::Shield::DRTAccess.json index ed02e3c5..e3fc8e9e 100644 --- a/artifacts/types/AWS::Shield::DRTAccess.json +++ b/artifacts/types/AWS::Shield::DRTAccess.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Shield-DRTAccess", "type": "AWS::Shield::DRTAccess", - "time": "2023-12-11T16:26:44.264Z", + "time": "2024-06-12T15:38:43.39Z", "schema": { "additionalProperties": false, "description": "Config the role and list of Amazon S3 log buckets used by the Shield Response Team (SRT) to access your AWS account while assisting with attack mitigation.", @@ -32,7 +32,9 @@ ] }, "list": { - "permissions": [] + "permissions": [ + "shield:DescribeDRTAccess" + ] }, "read": { "permissions": [ diff --git a/artifacts/types/AWS::Shield::ProactiveEngagement.json b/artifacts/types/AWS::Shield::ProactiveEngagement.json index c9d8c937..0fddfd82 100644 --- a/artifacts/types/AWS::Shield::ProactiveEngagement.json +++ b/artifacts/types/AWS::Shield::ProactiveEngagement.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Shield-ProactiveEngagement", "type": "AWS::Shield::ProactiveEngagement", - "time": "2023-12-11T16:25:48.765Z", + "time": "2024-06-12T15:38:43.332Z", "schema": { "additionalProperties": false, "definitions": { diff --git a/artifacts/types/AWS::Shield::Protection.json b/artifacts/types/AWS::Shield::Protection.json index 99ab19b0..5cbe0921 100644 --- a/artifacts/types/AWS::Shield::Protection.json +++ b/artifacts/types/AWS::Shield::Protection.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Shield-Protection", "type": "AWS::Shield::Protection", - "time": "2023-12-11T16:36:39.541Z", + "time": "2024-06-12T15:44:37.811Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Shield::ProtectionGroup.json b/artifacts/types/AWS::Shield::ProtectionGroup.json index b74726db..f1e394e6 100644 --- a/artifacts/types/AWS::Shield::ProtectionGroup.json +++ b/artifacts/types/AWS::Shield::ProtectionGroup.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Shield-ProtectionGroup", "type": "AWS::Shield::ProtectionGroup", - "time": "2023-12-11T16:37:50.652Z", + "time": "2024-06-12T15:43:37.345Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Signer::SigningProfile.json b/artifacts/types/AWS::Signer::SigningProfile.json index 72056c7f..b6660e97 100644 --- a/artifacts/types/AWS::Signer::SigningProfile.json +++ b/artifacts/types/AWS::Signer::SigningProfile.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Signer-SigningProfile", "type": "AWS::Signer::SigningProfile", - "time": "2023-12-07T16:31:56.259Z", + "time": "2024-06-18T15:53:17.81Z", "schema": { "additionalIdentifiers": [ [ @@ -13,6 +13,7 @@ ], "additionalProperties": false, "createOnlyProperties": [ + "/properties/ProfileName", "/properties/PlatformId", "/properties/SignatureValidityPeriod" ], @@ -28,6 +29,12 @@ ], "type": "string" }, + "ProfileName": { + "maxLength": 64, + "minLength": 2, + "pattern": "^[0-9a-zA-Z_]$", + "type": "string" + }, "ProfileVersion": { "pattern": "^[0-9a-zA-Z]{10}$", "type": "string" @@ -112,8 +119,8 @@ "description": "The ID of the target signing platform." }, "ProfileName": { - "description": "A name for the signing profile. AWS CloudFormation generates a unique physical ID and uses that ID for the signing profile name. ", - "type": "string" + "$ref": "#/definitions/ProfileName", + "description": "A name for the signing profile. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the signing profile name. " }, "ProfileVersion": { "$ref": "#/definitions/ProfileVersion", diff --git a/artifacts/types/AWS::SimSpaceWeaver::Simulation.json b/artifacts/types/AWS::SimSpaceWeaver::Simulation.json index d914c360..a9547a78 100644 --- a/artifacts/types/AWS::SimSpaceWeaver::Simulation.json +++ b/artifacts/types/AWS::SimSpaceWeaver::Simulation.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SimSpaceWeaver-Simulation", "type": "AWS::SimSpaceWeaver::Simulation", - "time": "2023-12-04T22:15:23.552Z", + "time": "2024-06-18T19:05:57.369Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::StepFunctions::Activity.json b/artifacts/types/AWS::StepFunctions::Activity.json index 559398b4..f8d409d3 100644 --- a/artifacts/types/AWS::StepFunctions::Activity.json +++ b/artifacts/types/AWS::StepFunctions::Activity.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-StepFunctions-Activity", "type": "AWS::StepFunctions::Activity", - "time": "2024-01-04T10:48:16.18Z", + "time": "2024-06-20T17:21:59.901Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -33,14 +33,21 @@ "handlers": { "create": { "permissions": [ - "states:CreateActivity" + "states:CreateActivity", + "states:TagResource" ] }, "delete": { "permissions": [ + "states:DescribeActivity", "states:DeleteActivity" ] }, + "list": { + "permissions": [ + "states:ListActivities" + ] + }, "read": { "permissions": [ "states:DescribeActivity", diff --git a/artifacts/types/AWS::StepFunctions::StateMachine.json b/artifacts/types/AWS::StepFunctions::StateMachine.json index 9e8216e4..539c2d63 100644 --- a/artifacts/types/AWS::StepFunctions::StateMachine.json +++ b/artifacts/types/AWS::StepFunctions::StateMachine.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-StepFunctions-StateMachine", "type": "AWS::StepFunctions::StateMachine", - "time": "2024-01-02T21:14:24.26Z", + "time": "2024-06-20T16:57:51.941Z", "schema": { "additionalIdentifiers": [ [ diff --git a/artifacts/types/AWS::StepFunctions::StateMachineAlias.json b/artifacts/types/AWS::StepFunctions::StateMachineAlias.json index b94398c4..a41ece89 100644 --- a/artifacts/types/AWS::StepFunctions::StateMachineAlias.json +++ b/artifacts/types/AWS::StepFunctions::StateMachineAlias.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-StepFunctions-StateMachineAlias", "type": "AWS::StepFunctions::StateMachineAlias", - "time": "2024-01-04T11:50:12.379Z", + "time": "2024-06-20T17:33:28.996Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -131,7 +131,8 @@ "cloudwatch:DescribeAlarms", "states:UpdateStateMachineAlias", "states:DescribeStateMachineAlias" - ] + ], + "timeoutInMinutes": 2160 } }, "oneOf": [ diff --git a/artifacts/types/AWS::SupportApp::AccountAlias.json b/artifacts/types/AWS::SupportApp::AccountAlias.json index d5555f51..c600f88d 100644 --- a/artifacts/types/AWS::SupportApp::AccountAlias.json +++ b/artifacts/types/AWS::SupportApp::AccountAlias.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SupportApp-AccountAlias", "type": "AWS::SupportApp::AccountAlias", - "time": "2024-01-04T16:56:44.47Z", + "time": "2024-06-12T15:25:28.49Z", "schema": { "additionalProperties": false, "description": "An AWS Support App resource that creates, updates, reads, and deletes a customer's account alias.", diff --git a/artifacts/types/AWS::SupportApp::SlackChannelConfiguration.json b/artifacts/types/AWS::SupportApp::SlackChannelConfiguration.json index b7e2203a..fe3ab2c2 100644 --- a/artifacts/types/AWS::SupportApp::SlackChannelConfiguration.json +++ b/artifacts/types/AWS::SupportApp::SlackChannelConfiguration.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SupportApp-SlackChannelConfiguration", "type": "AWS::SupportApp::SlackChannelConfiguration", - "time": "2024-01-04T16:57:43.237Z", + "time": "2024-06-12T15:24:09.792Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::SupportApp::SlackWorkspaceConfiguration.json b/artifacts/types/AWS::SupportApp::SlackWorkspaceConfiguration.json index 544fb845..364c7b12 100644 --- a/artifacts/types/AWS::SupportApp::SlackWorkspaceConfiguration.json +++ b/artifacts/types/AWS::SupportApp::SlackWorkspaceConfiguration.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-SupportApp-SlackWorkspaceConfiguration", "type": "AWS::SupportApp::SlackWorkspaceConfiguration", - "time": "2024-01-04T16:56:41.034Z", + "time": "2024-06-12T15:23:46.586Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Synthetics::Canary.json b/artifacts/types/AWS::Synthetics::Canary.json index c1e9a5ba..fd514a94 100644 --- a/artifacts/types/AWS::Synthetics::Canary.json +++ b/artifacts/types/AWS::Synthetics::Canary.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Synthetics-Canary", "type": "AWS::Synthetics::Canary", - "time": "2023-05-10T17:21:22.253Z", + "time": "2024-06-13T22:59:48.555Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -213,11 +213,14 @@ "permissions": [ "synthetics:CreateCanary", "synthetics:StartCanary", + "synthetics:GetCanary", + "synthetics:TagResource", "s3:CreateBucket", "s3:GetObject", "s3:GetObjectVersion", "s3:PutBucketEncryption", "s3:PutEncryptionConfiguration", + "s3:GetBucketLocation", "lambda:CreateFunction", "lambda:AddPermission", "lambda:PublishVersion", @@ -258,8 +261,22 @@ "synthetics:UpdateCanary", "synthetics:StartCanary", "synthetics:StopCanary", + "synthetics:GetCanary", "synthetics:TagResource", - "synthetics:UntagResource" + "synthetics:UntagResource", + "s3:GetObject", + "s3:GetObjectVersion", + "s3:PutBucketEncryption", + "s3:PutEncryptionConfiguration", + "s3:GetBucketLocation", + "lambda:AddPermission", + "lambda:PublishVersion", + "lambda:UpdateFunctionConfiguration", + "lambda:GetFunctionConfiguration", + "lambda:GetLayerVersionByArn", + "lambda:GetLayerVersion", + "lambda:PublishLayerVersion", + "iam:PassRole" ] } }, @@ -355,6 +372,9 @@ "RuntimeVersion" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-synthetics", + "tagging": { + "taggable": true + }, "typeName": "AWS::Synthetics::Canary", "writeOnlyProperties": [ "/properties/Code/S3Bucket", diff --git a/artifacts/types/AWS::Synthetics::Group.json b/artifacts/types/AWS::Synthetics::Group.json index 15f60762..714c9c08 100644 --- a/artifacts/types/AWS::Synthetics::Group.json +++ b/artifacts/types/AWS::Synthetics::Group.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Synthetics-Group", "type": "AWS::Synthetics::Group", - "time": "2023-05-10T17:09:36.01Z", + "time": "2024-06-13T22:44:35.225Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -115,6 +115,9 @@ "Name" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-synthetics", + "tagging": { + "taggable": true + }, "typeName": "AWS::Synthetics::Group" } } \ No newline at end of file diff --git a/artifacts/types/AWS::Timestream::Database.json b/artifacts/types/AWS::Timestream::Database.json index 4a601499..611c8b01 100644 --- a/artifacts/types/AWS::Timestream::Database.json +++ b/artifacts/types/AWS::Timestream::Database.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Timestream-Database", "type": "AWS::Timestream::Database", - "time": "2023-11-13T16:27:15.343Z", + "time": "2024-06-10T15:23:44.428Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Timestream::InfluxDBInstance.json b/artifacts/types/AWS::Timestream::InfluxDBInstance.json new file mode 100644 index 00000000..b63de127 --- /dev/null +++ b/artifacts/types/AWS::Timestream::InfluxDBInstance.json @@ -0,0 +1,319 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Timestream-InfluxDBInstance", + "type": "AWS::Timestream::InfluxDBInstance", + "time": "2024-06-10T19:31:48.464Z", + "schema": { + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/Name", + "/properties/Username", + "/properties/Password", + "/properties/Organization", + "/properties/Bucket", + "/properties/DbInstanceType", + "/properties/VpcSubnetIds", + "/properties/VpcSecurityGroupIds", + "/properties/PubliclyAccessible", + "/properties/DbStorageType", + "/properties/AllocatedStorage", + "/properties/DeploymentType" + ], + "definitions": { + "Tag": { + "additionalProperties": false, + "description": "A key-value pair to associate with a resource.", + "properties": { + "Key": { + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "Value": { + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "Key" + ], + "type": "object" + } + }, + "description": "The AWS::Timestream::InfluxDBInstance resource creates an InfluxDB instance.", + "handlers": { + "create": { + "permissions": [ + "s3:ListBucket", + "s3:GetBucketPolicy", + "timestream-influxdb:GetDbInstance", + "timestream-influxdb:ListDbInstances", + "timestream-influxdb:CreateDbInstance", + "timestream-influxdb:TagResource", + "timestream-influxdb:ListTagsForResource", + "ec2:DescribeSubnets", + "ec2:DescribeVpcs", + "ec2:DescribeNetworkInterfaces", + "ec2:DescribeSecurityGroups", + "ec2:CreateNetworkInterface", + "iam:CreateServiceLinkedRole" + ], + "timeoutInMinutes": 2160 + }, + "delete": { + "permissions": [ + "timestream-influxdb:GetDbInstance", + "timestream-influxdb:ListDbInstances", + "timestream-influxdb:DeleteDbInstance" + ], + "timeoutInMinutes": 2160 + }, + "list": { + "permissions": [ + "timestream-influxdb:ListDbInstances" + ], + "timeoutInMinutes": 2160 + }, + "read": { + "permissions": [ + "timestream-influxdb:GetDbInstance", + "timestream-influxdb:ListTagsForResource" + ], + "timeoutInMinutes": 2160 + }, + "update": { + "permissions": [ + "s3:ListBucket", + "s3:GetBucketPolicy", + "timestream-influxdb:GetDbInstance", + "timestream-influxdb:ListDbInstances", + "timestream-influxdb:UpdateDbInstance", + "timestream-influxdb:TagResource", + "timestream-influxdb:UntagResource", + "timestream-influxdb:ListTagsForResource" + ], + "timeoutInMinutes": 2160 + } + }, + "primaryIdentifier": [ + "/properties/Id" + ], + "properties": { + "AllocatedStorage": { + "description": "The allocated storage for the InfluxDB instance.", + "maximum": 16384, + "minimum": 20, + "type": "integer" + }, + "Arn": { + "description": "The Amazon Resource Name (ARN) that is associated with the InfluxDB instance.", + "maxLength": 1011, + "minLength": 1, + "pattern": "^arn:aws[a-z\\-]*:timestream\\-influxdb:[a-z0-9\\-]+:[0-9]{12}:(db\\-instance)/[a-zA-Z0-9]{3,64}$", + "type": "string" + }, + "AvailabilityZone": { + "description": "The Availability Zone (AZ) where the InfluxDB instance is created.", + "type": "string" + }, + "Bucket": { + "description": "The bucket for the InfluxDB instance.", + "maxLength": 64, + "minLength": 2, + "pattern": "^[^_][^\"]*$", + "type": "string" + }, + "DbInstanceType": { + "description": "The compute instance of the InfluxDB instance.", + "enum": [ + "db.influx.medium", + "db.influx.large", + "db.influx.xlarge", + "db.influx.2xlarge", + "db.influx.4xlarge", + "db.influx.8xlarge", + "db.influx.12xlarge", + "db.influx.16xlarge" + ], + "type": "string" + }, + "DbParameterGroupIdentifier": { + "description": "The name of an existing InfluxDB parameter group.", + "maxLength": 64, + "minLength": 3, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "DbStorageType": { + "description": "The storage type of the InfluxDB instance.", + "enum": [ + "InfluxIOIncludedT1", + "InfluxIOIncludedT2", + "InfluxIOIncludedT3" + ], + "type": "string" + }, + "DeploymentType": { + "description": "Deployment type of the InfluxDB Instance.", + "enum": [ + "SINGLE_AZ", + "WITH_MULTIAZ_STANDBY" + ], + "type": "string" + }, + "Endpoint": { + "description": "The connection endpoint for the InfluxDB instance.", + "type": "string" + }, + "Id": { + "description": "The service generated unique identifier for InfluxDB instance.", + "maxLength": 64, + "minLength": 3, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "InfluxAuthParametersSecretArn": { + "description": "The Auth parameters secret Amazon Resource name (ARN) that is associated with the InfluxDB instance.", + "pattern": "^arn:[a-z]*:secretsmanager:[a-z\\-0-9]*:[0-9]*:secret:[a-zA-Z0-9\\-]*", + "type": "string" + }, + "LogDeliveryConfiguration": { + "additionalProperties": false, + "description": "Configuration for sending logs to customer account from the InfluxDB instance.", + "properties": { + "S3Configuration": { + "additionalProperties": false, + "description": "S3 configuration for sending logs to customer account from the InfluxDB instance.", + "properties": { + "BucketName": { + "description": "The bucket name for logs to be sent from the InfluxDB instance", + "maxLength": 63, + "minLength": 3, + "pattern": "^[0-9a-z]+[0-9a-z\\.\\-]*[0-9a-z]+$", + "type": "string" + }, + "Enabled": { + "description": "Specifies whether logging to customer specified bucket is enabled.", + "type": "boolean" + } + }, + "required": [ + "Enabled", + "BucketName" + ], + "type": "object" + } + }, + "required": [ + "S3Configuration" + ], + "type": "object" + }, + "Name": { + "description": "The unique name that is associated with the InfluxDB instance.", + "maxLength": 40, + "minLength": 3, + "pattern": "^[a-zA-z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$", + "type": "string" + }, + "Organization": { + "description": "The organization for the InfluxDB instance.", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "Password": { + "description": "The password for the InfluxDB instance.", + "maxLength": 64, + "minLength": 8, + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "PubliclyAccessible": { + "default": false, + "description": "Attach a public IP to the customer ENI.", + "type": "boolean" + }, + "SecondaryAvailabilityZone": { + "description": "The Secondary Availability Zone (AZ) where the InfluxDB instance is created, if DeploymentType is set as WITH_MULTIAZ_STANDBY.", + "type": "string" + }, + "Status": { + "description": "Status of the InfluxDB Instance.", + "enum": [ + "CREATING", + "AVAILABLE", + "DELETING", + "MODIFYING", + "UPDATING", + "DELETED", + "FAILED" + ], + "type": "string" + }, + "Tags": { + "description": "An arbitrary set of tags (key-value pairs) for this DB instance.", + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "maxItems": 200, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "Username": { + "description": "The username for the InfluxDB instance.", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "VpcSecurityGroupIds": { + "description": "A list of Amazon EC2 VPC security groups to associate with this InfluxDB instance.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "maxItems": 5, + "minItems": 1, + "type": "array" + }, + "VpcSubnetIds": { + "description": "A list of EC2 subnet IDs for this InfluxDB instance.", + "insertionOrder": false, + "items": { + "type": "string" + }, + "maxItems": 3, + "minItems": 1, + "type": "array" + } + }, + "readOnlyProperties": [ + "/properties/Status", + "/properties/Arn", + "/properties/Id", + "/properties/AvailabilityZone", + "/properties/Endpoint", + "/properties/SecondaryAvailabilityZone", + "/properties/InfluxAuthParametersSecretArn" + ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-timestream.git", + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, + "typeName": "AWS::Timestream::InfluxDBInstance", + "writeOnlyProperties": [ + "/properties/Username", + "/properties/Password", + "/properties/Organization", + "/properties/Bucket" + ] + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::Timestream::ScheduledQuery.json b/artifacts/types/AWS::Timestream::ScheduledQuery.json index f5ec16c1..d2419e12 100644 --- a/artifacts/types/AWS::Timestream::ScheduledQuery.json +++ b/artifacts/types/AWS::Timestream::ScheduledQuery.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Timestream-ScheduledQuery", "type": "AWS::Timestream::ScheduledQuery", - "time": "2023-11-13T16:27:15.748Z", + "time": "2024-06-10T15:13:52.395Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Timestream::Table.json b/artifacts/types/AWS::Timestream::Table.json index a0a5d822..fab404ad 100644 --- a/artifacts/types/AWS::Timestream::Table.json +++ b/artifacts/types/AWS::Timestream::Table.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Timestream-Table", "type": "AWS::Timestream::Table", - "time": "2023-11-13T16:29:08.712Z", + "time": "2024-06-10T15:24:03.237Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::Transfer::Agreement.json b/artifacts/types/AWS::Transfer::Agreement.json index 0cfd8734..3a5a85c8 100644 --- a/artifacts/types/AWS::Transfer::Agreement.json +++ b/artifacts/types/AWS::Transfer::Agreement.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Transfer-Agreement", "type": "AWS::Transfer::Agreement", - "time": "2024-01-03T14:21:15.468Z", + "time": "2024-06-10T21:13:32.914Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -104,14 +104,14 @@ "BaseDirectory": { "description": "Specifies the base directory for the agreement.", "maxLength": 1024, - "pattern": "^$|/.*", + "pattern": "^(|/.*)$", "type": "string" }, "Description": { "description": "A textual description for the agreement.", "maxLength": 200, "minLength": 1, - "pattern": "^[\\w\\- ]*$", + "pattern": "^[\\u0021-\\u007E]+$", "type": "string" }, "LocalProfileId": { diff --git a/artifacts/types/AWS::Transfer::Certificate.json b/artifacts/types/AWS::Transfer::Certificate.json index 562ae311..896fa476 100644 --- a/artifacts/types/AWS::Transfer::Certificate.json +++ b/artifacts/types/AWS::Transfer::Certificate.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Transfer-Certificate", "type": "AWS::Transfer::Certificate", - "time": "2024-01-03T14:25:17.86Z", + "time": "2024-06-10T18:43:29.046Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -84,14 +84,14 @@ "description": "Specifies the certificate body to be imported.", "maxLength": 16384, "minLength": 1, - "pattern": "^[\t\n\r -ÿ]*", + "pattern": "^[\\t\\n\\r\\u0020-\\u00FF]+$", "type": "string" }, "CertificateChain": { "description": "Specifies the certificate chain to be imported.", "maxLength": 2097152, "minLength": 1, - "pattern": "^[\t\n\r -ÿ]*", + "pattern": "^[\\t\\n\\r\\u0020-\\u00FF]+$", "type": "string" }, "CertificateId": { @@ -105,7 +105,7 @@ "description": "A textual description for the certificate.", "maxLength": 200, "minLength": 1, - "pattern": "^[\\w\\- ]*$", + "pattern": "^[\\u0021-\\u007E]+$", "type": "string" }, "InactiveDate": { @@ -124,14 +124,14 @@ "description": "Specifies the private key for the certificate.", "maxLength": 16384, "minLength": 1, - "pattern": "^[\t\n\r -ÿ]*", + "pattern": "^[\\t\\n\\r\\u0020-\\u00FF]+$", "type": "string" }, "Serial": { "description": "Specifies Certificate's serial.", "maxLength": 48, "minLength": 0, - "pattern": "^[\\p{XDigit}{2}:?]*", + "pattern": "^[0-9a-fA-F{}:?]*$", "type": "string" }, "Status": { @@ -165,7 +165,8 @@ "description": "Specifies the usage type for the certificate.", "enum": [ "SIGNING", - "ENCRYPTION" + "ENCRYPTION", + "TLS" ], "type": "string" } diff --git a/artifacts/types/AWS::Transfer::Connector.json b/artifacts/types/AWS::Transfer::Connector.json index 34b5805d..14c25096 100644 --- a/artifacts/types/AWS::Transfer::Connector.json +++ b/artifacts/types/AWS::Transfer::Connector.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Transfer-Connector", "type": "AWS::Transfer::Connector", - "time": "2024-01-03T14:21:15.317Z", + "time": "2024-06-10T19:17:15.928Z", "schema": { "additionalProperties": false, "definitions": { @@ -110,7 +110,8 @@ "AES128_CBC", "AES192_CBC", "AES256_CBC", - "NONE" + "NONE", + "DES_EDE3_CBC" ], "type": "string" }, @@ -145,7 +146,7 @@ "description": "The message subject for this AS2 connector configuration.", "maxLength": 1024, "minLength": 1, - "pattern": "^[\\p{Print}\\p{Blank}]+", + "pattern": "^[\\u0020-\\u007E\\t]+$", "type": "string" }, "PartnerProfileId": { @@ -183,6 +184,21 @@ "pattern": "arn:.*role/.*", "type": "string" }, + "SecurityPolicyName": { + "description": "Security policy for SFTP Connector", + "maxLength": 50, + "pattern": "TransferSFTPConnectorSecurityPolicy-[A-Za-z0-9-]+", + "type": "string" + }, + "ServiceManagedEgressIpAddresses": { + "description": "The list of egress IP addresses of this connector. These IP addresses are assigned automatically when you create the connector.", + "insertionOrder": false, + "items": { + "pattern": "^\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}$", + "type": "string" + }, + "type": "array" + }, "SftpConfig": { "additionalProperties": false, "description": "Configuration for an SFTP connector.", @@ -224,7 +240,8 @@ }, "readOnlyProperties": [ "/properties/Arn", - "/properties/ConnectorId" + "/properties/ConnectorId", + "/properties/ServiceManagedEgressIpAddresses" ], "required": [ "AccessRole", diff --git a/artifacts/types/AWS::Transfer::Profile.json b/artifacts/types/AWS::Transfer::Profile.json index 474b5507..96ddebc4 100644 --- a/artifacts/types/AWS::Transfer::Profile.json +++ b/artifacts/types/AWS::Transfer::Profile.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Transfer-Profile", "type": "AWS::Transfer::Profile", - "time": "2024-01-03T14:25:29.042Z", + "time": "2024-06-10T18:58:38.661Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -85,6 +85,7 @@ "description": "AS2 identifier agreed with a trading partner.", "maxLength": 128, "minLength": 1, + "pattern": "^[\\u0020-\\u007E\\s]*$", "type": "string" }, "CertificateIds": { diff --git a/artifacts/types/AWS::Transfer::Workflow.json b/artifacts/types/AWS::Transfer::Workflow.json index ce4801b8..5bf35abe 100644 --- a/artifacts/types/AWS::Transfer::Workflow.json +++ b/artifacts/types/AWS::Transfer::Workflow.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Transfer-Workflow", "type": "AWS::Transfer::Workflow", - "time": "2024-01-03T14:21:15.396Z", + "time": "2024-06-10T18:43:27.176Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -228,6 +228,10 @@ "type": "string" } }, + "required": [ + "DestinationFileLocation", + "Type" + ], "type": "object" }, "DeleteStepDetails": { @@ -389,7 +393,13 @@ "required": [ "Steps" ], - "taggable": true, + "tagging": { + "cloudFormationSystemTags": true, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": true, + "taggable": true + }, "typeName": "AWS::Transfer::Workflow" } } \ No newline at end of file diff --git a/artifacts/types/AWS::VerifiedPermissions::IdentitySource.json b/artifacts/types/AWS::VerifiedPermissions::IdentitySource.json index 2abeb997..1f5e4868 100644 --- a/artifacts/types/AWS::VerifiedPermissions::IdentitySource.json +++ b/artifacts/types/AWS::VerifiedPermissions::IdentitySource.json @@ -1,13 +1,28 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-VerifiedPermissions-IdentitySource", "type": "AWS::VerifiedPermissions::IdentitySource", - "time": "2023-12-19T16:28:50.269Z", + "time": "2024-06-24T13:32:26.471Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ "/properties/PolicyStoreId" ], "definitions": { + "CognitoGroupConfiguration": { + "additionalProperties": false, + "properties": { + "GroupEntityType": { + "maxLength": 200, + "minLength": 1, + "pattern": "^([_a-zA-Z][_a-zA-Z0-9]*::)*[_a-zA-Z][_a-zA-Z0-9]*$", + "type": "string" + } + }, + "required": [ + "GroupEntityType" + ], + "type": "object" + }, "CognitoUserPoolConfiguration": { "additionalProperties": false, "properties": { @@ -23,6 +38,9 @@ "minItems": 0, "type": "array" }, + "GroupConfiguration": { + "$ref": "#/definitions/CognitoGroupConfiguration" + }, "UserPoolArn": { "maxLength": 255, "minLength": 1, @@ -36,17 +54,34 @@ "type": "object" }, "IdentitySourceConfiguration": { - "additionalProperties": false, - "properties": { - "CognitoUserPoolConfiguration": { - "$ref": "#/definitions/CognitoUserPoolConfiguration" + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "CognitoUserPoolConfiguration": { + "$ref": "#/definitions/CognitoUserPoolConfiguration" + } + }, + "required": [ + "CognitoUserPoolConfiguration" + ], + "title": "CognitoUserPoolConfiguration", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "OpenIdConnectConfiguration": { + "$ref": "#/definitions/OpenIdConnectConfiguration" + } + }, + "required": [ + "OpenIdConnectConfiguration" + ], + "title": "OpenIdConnectConfiguration", + "type": "object" } - }, - "required": [ - "CognitoUserPoolConfiguration" - ], - "title": "CognitoUserPoolConfiguration", - "type": "object" + ] }, "IdentitySourceDetails": { "additionalProperties": false, @@ -81,6 +116,128 @@ }, "type": "object" }, + "OpenIdConnectAccessTokenConfiguration": { + "additionalProperties": false, + "properties": { + "Audiences": { + "insertionOrder": false, + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 255, + "minItems": 1, + "type": "array" + }, + "PrincipalIdClaim": { + "default": "sub", + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "OpenIdConnectConfiguration": { + "additionalProperties": false, + "properties": { + "EntityIdPrefix": { + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "GroupConfiguration": { + "$ref": "#/definitions/OpenIdConnectGroupConfiguration" + }, + "Issuer": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^https://.*$", + "type": "string" + }, + "TokenSelection": { + "$ref": "#/definitions/OpenIdConnectTokenSelection" + } + }, + "required": [ + "Issuer", + "TokenSelection" + ], + "type": "object" + }, + "OpenIdConnectGroupConfiguration": { + "additionalProperties": false, + "properties": { + "GroupClaim": { + "minLength": 1, + "type": "string" + }, + "GroupEntityType": { + "maxLength": 200, + "minLength": 1, + "pattern": "^([_a-zA-Z][_a-zA-Z0-9]*::)*[_a-zA-Z][_a-zA-Z0-9]*$", + "type": "string" + } + }, + "required": [ + "GroupClaim", + "GroupEntityType" + ], + "type": "object" + }, + "OpenIdConnectIdentityTokenConfiguration": { + "additionalProperties": false, + "properties": { + "ClientIds": { + "insertionOrder": false, + "items": { + "maxLength": 255, + "minLength": 1, + "pattern": "^.*$", + "type": "string" + }, + "maxItems": 1000, + "minItems": 0, + "type": "array" + }, + "PrincipalIdClaim": { + "default": "sub", + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "OpenIdConnectTokenSelection": { + "oneOf": [ + { + "additionalProperties": false, + "properties": { + "AccessTokenOnly": { + "$ref": "#/definitions/OpenIdConnectAccessTokenConfiguration" + } + }, + "required": [ + "AccessTokenOnly" + ], + "title": "AccessTokenOnly", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "IdentityTokenOnly": { + "$ref": "#/definitions/OpenIdConnectIdentityTokenConfiguration" + } + }, + "required": [ + "IdentityTokenOnly" + ], + "title": "IdentityTokenOnly", + "type": "object" + } + ] + }, "OpenIdIssuer": { "enum": [ "COGNITO" @@ -88,26 +245,23 @@ "type": "string" } }, + "deprecatedProperties": [ + "/properties/Details" + ], "description": "Definition of AWS::VerifiedPermissions::IdentitySource Resource Type", "handlers": { "create": { "permissions": [ "verifiedpermissions:CreateIdentitySource", "verifiedpermissions:GetIdentitySource", - "verifiedpermissions:UpdateIdentitySource", - "verifiedpermissions:DeleteIdentitySource", - "verifiedpermissions:ListIdentitySources", "cognito-idp:DescribeUserPool", "cognito-idp:ListUserPoolClients" ] }, "delete": { "permissions": [ - "verifiedpermissions:CreateIdentitySource", - "verifiedpermissions:GetIdentitySource", - "verifiedpermissions:UpdateIdentitySource", "verifiedpermissions:DeleteIdentitySource", - "verifiedpermissions:ListIdentitySources", + "verifiedpermissions:GetIdentitySource", "cognito-idp:DescribeUserPool", "cognito-idp:ListUserPoolClients" ] @@ -124,33 +278,23 @@ ] }, "permissions": [ - "verifiedpermissions:CreateIdentitySource", - "verifiedpermissions:GetIdentitySource", - "verifiedpermissions:UpdateIdentitySource", - "verifiedpermissions:DeleteIdentitySource", "verifiedpermissions:ListIdentitySources", + "verifiedpermissions:GetIdentitySource", "cognito-idp:DescribeUserPool", "cognito-idp:ListUserPoolClients" ] }, "read": { "permissions": [ - "verifiedpermissions:CreateIdentitySource", "verifiedpermissions:GetIdentitySource", - "verifiedpermissions:UpdateIdentitySource", - "verifiedpermissions:DeleteIdentitySource", - "verifiedpermissions:ListIdentitySources", "cognito-idp:DescribeUserPool", "cognito-idp:ListUserPoolClients" ] }, "update": { "permissions": [ - "verifiedpermissions:CreateIdentitySource", - "verifiedpermissions:GetIdentitySource", "verifiedpermissions:UpdateIdentitySource", - "verifiedpermissions:DeleteIdentitySource", - "verifiedpermissions:ListIdentitySources", + "verifiedpermissions:GetIdentitySource", "cognito-idp:DescribeUserPool", "cognito-idp:ListUserPoolClients" ] @@ -191,7 +335,8 @@ "/properties/IdentitySourceId" ], "required": [ - "Configuration" + "Configuration", + "PolicyStoreId" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-avp", "tagging": { diff --git a/artifacts/types/AWS::VerifiedPermissions::Policy.json b/artifacts/types/AWS::VerifiedPermissions::Policy.json index 146d3ec5..3a9d4fb6 100644 --- a/artifacts/types/AWS::VerifiedPermissions::Policy.json +++ b/artifacts/types/AWS::VerifiedPermissions::Policy.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-VerifiedPermissions-Policy", "type": "AWS::VerifiedPermissions::Policy", - "time": "2023-12-19T16:34:56.301Z", + "time": "2024-06-24T13:31:22.028Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -113,17 +113,13 @@ "create": { "permissions": [ "verifiedpermissions:CreatePolicy", - "verifiedpermissions:GetPolicy", - "verifiedpermissions:UpdatePolicy", - "verifiedpermissions:DeletePolicy" + "verifiedpermissions:GetPolicy" ] }, "delete": { "permissions": [ - "verifiedpermissions:CreatePolicy", - "verifiedpermissions:GetPolicy", - "verifiedpermissions:UpdatePolicy", - "verifiedpermissions:DeletePolicy" + "verifiedpermissions:DeletePolicy", + "verifiedpermissions:GetPolicy" ] }, "list": { @@ -138,26 +134,19 @@ ] }, "permissions": [ - "verifiedpermissions:CreatePolicy", - "verifiedpermissions:GetPolicy", - "verifiedpermissions:UpdatePolicy", - "verifiedpermissions:DeletePolicy" + "verifiedpermissions:ListPolicies", + "verifiedpermissions:GetPolicy" ] }, "read": { "permissions": [ - "verifiedpermissions:CreatePolicy", - "verifiedpermissions:GetPolicy", - "verifiedpermissions:UpdatePolicy", - "verifiedpermissions:DeletePolicy" + "verifiedpermissions:GetPolicy" ] }, "update": { "permissions": [ - "verifiedpermissions:CreatePolicy", - "verifiedpermissions:GetPolicy", "verifiedpermissions:UpdatePolicy", - "verifiedpermissions:DeletePolicy" + "verifiedpermissions:GetPolicy" ] } }, @@ -190,7 +179,8 @@ "/properties/PolicyType" ], "required": [ - "Definition" + "Definition", + "PolicyStoreId" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-avp", "tagging": { diff --git a/artifacts/types/AWS::VerifiedPermissions::PolicyStore.json b/artifacts/types/AWS::VerifiedPermissions::PolicyStore.json index 02e17090..296fc526 100644 --- a/artifacts/types/AWS::VerifiedPermissions::PolicyStore.json +++ b/artifacts/types/AWS::VerifiedPermissions::PolicyStore.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-VerifiedPermissions-PolicyStore", "type": "AWS::VerifiedPermissions::PolicyStore", - "time": "2023-12-19T16:26:05.457Z", + "time": "2024-06-24T13:25:48.564Z", "schema": { "additionalProperties": false, "definitions": { @@ -37,50 +37,38 @@ "type": "object" } }, - "description": "Definition of AWS::VerifiedPermissions::PolicyStore Resource Type", + "description": "Represents a policy store that you can place schema, policies, and policy templates in to validate authorization requests", "handlers": { "create": { "permissions": [ "verifiedpermissions:CreatePolicyStore", "verifiedpermissions:GetPolicyStore", - "verifiedpermissions:UpdatePolicyStore", - "verifiedpermissions:DeletePolicyStore", "verifiedpermissions:PutSchema" ] }, "delete": { "permissions": [ - "verifiedpermissions:CreatePolicyStore", - "verifiedpermissions:GetPolicyStore", - "verifiedpermissions:UpdatePolicyStore", - "verifiedpermissions:DeletePolicyStore" + "verifiedpermissions:DeletePolicyStore", + "verifiedpermissions:GetPolicyStore" ] }, "list": { "permissions": [ - "verifiedpermissions:CreatePolicyStore", - "verifiedpermissions:GetPolicyStore", - "verifiedpermissions:UpdatePolicyStore", - "verifiedpermissions:DeletePolicyStore", "verifiedpermissions:ListPolicyStores", + "verifiedpermissions:GetPolicyStore", "verifiedpermissions:GetSchema" ] }, "read": { "permissions": [ - "verifiedpermissions:CreatePolicyStore", "verifiedpermissions:GetPolicyStore", - "verifiedpermissions:UpdatePolicyStore", - "verifiedpermissions:DeletePolicyStore", "verifiedpermissions:GetSchema" ] }, "update": { "permissions": [ - "verifiedpermissions:CreatePolicyStore", - "verifiedpermissions:GetPolicyStore", "verifiedpermissions:UpdatePolicyStore", - "verifiedpermissions:DeletePolicyStore", + "verifiedpermissions:GetPolicyStore", "verifiedpermissions:GetSchema", "verifiedpermissions:PutSchema" ] @@ -96,6 +84,11 @@ "pattern": "^arn:[^:]*:[^:]*:[^:]*:[^:]*:.*$", "type": "string" }, + "Description": { + "maxLength": 150, + "minLength": 0, + "type": "string" + }, "PolicyStoreId": { "maxLength": 200, "minLength": 1, @@ -119,6 +112,7 @@ "required": [ "ValidationSettings" ], + "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-avp", "tagging": { "cloudFormationSystemTags": false, "tagOnCreate": false, diff --git a/artifacts/types/AWS::VerifiedPermissions::PolicyTemplate.json b/artifacts/types/AWS::VerifiedPermissions::PolicyTemplate.json index 5727e28c..810228f5 100644 --- a/artifacts/types/AWS::VerifiedPermissions::PolicyTemplate.json +++ b/artifacts/types/AWS::VerifiedPermissions::PolicyTemplate.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-VerifiedPermissions-PolicyTemplate", "type": "AWS::VerifiedPermissions::PolicyTemplate", - "time": "2023-12-19T16:28:51.305Z", + "time": "2024-06-24T13:28:20.719Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -12,17 +12,13 @@ "create": { "permissions": [ "verifiedpermissions:CreatePolicyTemplate", - "verifiedpermissions:GetPolicyTemplate", - "verifiedpermissions:UpdatePolicyTemplate", - "verifiedpermissions:DeletePolicyTemplate" + "verifiedpermissions:GetPolicyTemplate" ] }, "delete": { "permissions": [ - "verifiedpermissions:CreatePolicyTemplate", - "verifiedpermissions:GetPolicyTemplate", - "verifiedpermissions:UpdatePolicyTemplate", - "verifiedpermissions:DeletePolicyTemplate" + "verifiedpermissions:DeletePolicyTemplate", + "verifiedpermissions:GetPolicyTemplate" ] }, "list": { @@ -37,27 +33,19 @@ ] }, "permissions": [ - "verifiedpermissions:CreatePolicyTemplate", - "verifiedpermissions:GetPolicyTemplate", - "verifiedpermissions:UpdatePolicyTemplate", - "verifiedpermissions:DeletePolicyTemplate", - "verifiedpermissions:ListPolicyTemplates" + "verifiedpermissions:ListPolicyTemplates", + "verifiedpermissions:GetPolicyTemplate" ] }, "read": { "permissions": [ - "verifiedpermissions:CreatePolicyTemplate", - "verifiedpermissions:GetPolicyTemplate", - "verifiedpermissions:UpdatePolicyTemplate", - "verifiedpermissions:DeletePolicyTemplate" + "verifiedpermissions:GetPolicyTemplate" ] }, "update": { "permissions": [ - "verifiedpermissions:CreatePolicyTemplate", - "verifiedpermissions:GetPolicyTemplate", "verifiedpermissions:UpdatePolicyTemplate", - "verifiedpermissions:DeletePolicyTemplate" + "verifiedpermissions:GetPolicyTemplate" ] } }, @@ -93,7 +81,8 @@ "/properties/PolicyTemplateId" ], "required": [ - "Statement" + "Statement", + "PolicyStoreId" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-avp", "tagging": { diff --git a/artifacts/types/AWS::VoiceID::Domain.json b/artifacts/types/AWS::VoiceID::Domain.json index b864b039..860e32c6 100644 --- a/artifacts/types/AWS::VoiceID::Domain.json +++ b/artifacts/types/AWS::VoiceID::Domain.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-VoiceID-Domain", "type": "AWS::VoiceID::Domain", - "time": "2024-01-03T16:41:26.804Z", + "time": "2024-06-19T15:46:15.943Z", "schema": { "additionalProperties": false, "definitions": { @@ -46,27 +46,45 @@ "handlers": { "create": { "permissions": [ - "voiceid:CreateDomain" + "voiceid:CreateDomain", + "voiceid:DescribeDomain", + "voiceid:TagResource", + "voiceid:ListTagsForResource", + "kms:CreateGrant", + "kms:DescribeKey", + "kms:Decrypt" ] }, "delete": { "permissions": [ - "voiceid:DeleteDomain" + "voiceid:DeleteDomain", + "voiceid:DescribeDomain", + "kms:Decrypt" ] }, "list": { "permissions": [ - "voiceid:ListDomains" + "voiceid:ListDomains", + "kms:Decrypt" ] }, "read": { "permissions": [ - "voiceid:DescribeDomain" + "voiceid:DescribeDomain", + "voiceid:ListTagsForResource", + "kms:Decrypt" ] }, "update": { "permissions": [ - "voiceid:UpdateDomain" + "voiceid:DescribeDomain", + "voiceid:UpdateDomain", + "voiceid:TagResource", + "voiceid:UntagResource", + "voiceid:ListTagsForResource", + "kms:CreateGrant", + "kms:Decrypt", + "kms:DescribeKey" ] } }, diff --git a/artifacts/types/AWS::VpcLattice::AccessLogSubscription.json b/artifacts/types/AWS::VpcLattice::AccessLogSubscription.json index b936be4b..dd85f390 100644 --- a/artifacts/types/AWS::VpcLattice::AccessLogSubscription.json +++ b/artifacts/types/AWS::VpcLattice::AccessLogSubscription.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-VpcLattice-AccessLogSubscription", "type": "AWS::VpcLattice::AccessLogSubscription", - "time": "2023-08-30T16:54:26.809Z", + "time": "2024-05-09T17:41:02.777Z", "schema": { "additionalIdentifiers": [ [ diff --git a/artifacts/types/AWS::VpcLattice::AuthPolicy.json b/artifacts/types/AWS::VpcLattice::AuthPolicy.json index d5c1b25a..9dc84c4a 100644 --- a/artifacts/types/AWS::VpcLattice::AuthPolicy.json +++ b/artifacts/types/AWS::VpcLattice::AuthPolicy.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-VpcLattice-AuthPolicy", "type": "AWS::VpcLattice::AuthPolicy", - "time": "2023-08-30T16:47:47.056Z", + "time": "2024-05-09T17:40:17.606Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::VpcLattice::Listener.json b/artifacts/types/AWS::VpcLattice::Listener.json index 22f8b2f2..984bf196 100644 --- a/artifacts/types/AWS::VpcLattice::Listener.json +++ b/artifacts/types/AWS::VpcLattice::Listener.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-VpcLattice-Listener", "type": "AWS::VpcLattice::Listener", - "time": "2023-08-30T17:18:22.614Z", + "time": "2024-05-09T17:50:59.383Z", "schema": { "additionalIdentifiers": [ [ @@ -53,7 +53,7 @@ "items": { "$ref": "#/definitions/WeightedTargetGroup" }, - "maxItems": 2, + "maxItems": 10, "minItems": 1, "type": "array" } @@ -186,7 +186,8 @@ "Protocol": { "enum": [ "HTTP", - "HTTPS" + "HTTPS", + "TLS_PASSTHROUGH" ], "type": "string" }, diff --git a/artifacts/types/AWS::VpcLattice::ResourcePolicy.json b/artifacts/types/AWS::VpcLattice::ResourcePolicy.json index 5a20a297..58b7c0f5 100644 --- a/artifacts/types/AWS::VpcLattice::ResourcePolicy.json +++ b/artifacts/types/AWS::VpcLattice::ResourcePolicy.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-VpcLattice-ResourcePolicy", "type": "AWS::VpcLattice::ResourcePolicy", - "time": "2023-08-30T16:47:53.321Z", + "time": "2024-05-09T17:39:30.731Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::VpcLattice::Rule.json b/artifacts/types/AWS::VpcLattice::Rule.json index 59108cec..55e2fde2 100644 --- a/artifacts/types/AWS::VpcLattice::Rule.json +++ b/artifacts/types/AWS::VpcLattice::Rule.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-VpcLattice-Rule", "type": "AWS::VpcLattice::Rule", - "time": "2023-08-30T17:41:21.824Z", + "time": "2024-05-09T18:07:50.904Z", "schema": { "additionalIdentifiers": [ [ @@ -53,7 +53,7 @@ "items": { "$ref": "#/definitions/WeightedTargetGroup" }, - "maxItems": 2, + "maxItems": 10, "minItems": 1, "type": "array" } diff --git a/artifacts/types/AWS::VpcLattice::Service.json b/artifacts/types/AWS::VpcLattice::Service.json index 508c2e35..d8873c78 100644 --- a/artifacts/types/AWS::VpcLattice::Service.json +++ b/artifacts/types/AWS::VpcLattice::Service.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-VpcLattice-Service", "type": "AWS::VpcLattice::Service", - "time": "2023-08-30T16:31:21.27Z", + "time": "2024-05-09T17:24:12.953Z", "schema": { "additionalIdentifiers": [ [ diff --git a/artifacts/types/AWS::VpcLattice::ServiceNetwork.json b/artifacts/types/AWS::VpcLattice::ServiceNetwork.json index 36610ca1..ec4ac8a8 100644 --- a/artifacts/types/AWS::VpcLattice::ServiceNetwork.json +++ b/artifacts/types/AWS::VpcLattice::ServiceNetwork.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-VpcLattice-ServiceNetwork", "type": "AWS::VpcLattice::ServiceNetwork", - "time": "2023-08-30T16:31:22.968Z", + "time": "2024-05-09T17:20:47.65Z", "schema": { "additionalIdentifiers": [ [ diff --git a/artifacts/types/AWS::VpcLattice::ServiceNetworkServiceAssociation.json b/artifacts/types/AWS::VpcLattice::ServiceNetworkServiceAssociation.json index 8353b387..a5933c18 100644 --- a/artifacts/types/AWS::VpcLattice::ServiceNetworkServiceAssociation.json +++ b/artifacts/types/AWS::VpcLattice::ServiceNetworkServiceAssociation.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-VpcLattice-ServiceNetworkServiceAssociation", "type": "AWS::VpcLattice::ServiceNetworkServiceAssociation", - "time": "2023-08-30T17:04:56.175Z", + "time": "2024-05-09T17:42:01.37Z", "schema": { "additionalIdentifiers": [ [ diff --git a/artifacts/types/AWS::VpcLattice::ServiceNetworkVpcAssociation.json b/artifacts/types/AWS::VpcLattice::ServiceNetworkVpcAssociation.json index 273578c7..ba4da55a 100644 --- a/artifacts/types/AWS::VpcLattice::ServiceNetworkVpcAssociation.json +++ b/artifacts/types/AWS::VpcLattice::ServiceNetworkVpcAssociation.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-VpcLattice-ServiceNetworkVpcAssociation", "type": "AWS::VpcLattice::ServiceNetworkVpcAssociation", - "time": "2023-08-30T17:18:11.759Z", + "time": "2024-05-09T17:55:27.749Z", "schema": { "additionalIdentifiers": [ [ diff --git a/artifacts/types/AWS::VpcLattice::TargetGroup.json b/artifacts/types/AWS::VpcLattice::TargetGroup.json index a8c73947..682bb62b 100644 --- a/artifacts/types/AWS::VpcLattice::TargetGroup.json +++ b/artifacts/types/AWS::VpcLattice::TargetGroup.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-VpcLattice-TargetGroup", "type": "AWS::VpcLattice::TargetGroup", - "time": "2023-08-30T16:55:15.308Z", + "time": "2024-05-09T17:34:14.062Z", "schema": { "additionalIdentifiers": [ [ @@ -68,8 +68,7 @@ "ProtocolVersion": { "enum": [ "HTTP1", - "HTTP2", - "GRPC" + "HTTP2" ], "type": "string" }, @@ -162,7 +161,8 @@ "Protocol": { "enum": [ "HTTP", - "HTTPS" + "HTTPS", + "TCP" ], "type": "string" }, diff --git a/artifacts/types/AWS::WAFv2::IPSet.json b/artifacts/types/AWS::WAFv2::IPSet.json index f6c05b5d..2e3f851d 100644 --- a/artifacts/types/AWS::WAFv2::IPSet.json +++ b/artifacts/types/AWS::WAFv2::IPSet.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-WAFv2-IPSet", "type": "AWS::WAFv2::IPSet", - "time": "2023-10-12T22:11:11.126Z", + "time": "2024-03-18T16:04:19.673Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -160,6 +160,12 @@ "Scope" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-wafv2.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, "typeName": "AWS::WAFv2::IPSet" } } \ No newline at end of file diff --git a/artifacts/types/AWS::WAFv2::LoggingConfiguration.json b/artifacts/types/AWS::WAFv2::LoggingConfiguration.json index 01c04014..d9188be5 100644 --- a/artifacts/types/AWS::WAFv2::LoggingConfiguration.json +++ b/artifacts/types/AWS::WAFv2::LoggingConfiguration.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-WAFv2-LoggingConfiguration", "type": "AWS::WAFv2::LoggingConfiguration", - "time": "2023-10-12T22:19:39.191Z", + "time": "2024-03-18T17:42:14.577Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -54,55 +54,6 @@ "additionalProperties": false, "description": "A key-value pair to associate with a resource.", "properties": { - "JsonBody": { - "additionalProperties": false, - "description": "Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. ", - "properties": { - "InvalidFallbackBehavior": { - "description": "What AWS WAF should do if it fails to completely parse the JSON body.", - "enum": [ - "MATCH", - "NO_MATCH", - "EVALUATE_AS_STRING" - ], - "type": "string" - }, - "MatchPattern": { - "additionalProperties": false, - "description": "The patterns to look for in the JSON body. AWS WAF inspects the results of these pattern matches against the rule inspection criteria. ", - "properties": { - "All": { - "description": "Match all of the elements. See also MatchScope in JsonBody. You must specify either this setting or the IncludedPaths setting, but not both.", - "type": "object" - }, - "IncludedPaths": { - "description": "Match only the specified include paths. See also MatchScope in JsonBody.", - "items": { - "pattern": "^[\\/]+([^~]*(~[01])*)*{1,512}$", - "type": "string" - }, - "minItems": 1, - "type": "array" - } - }, - "type": "object" - }, - "MatchScope": { - "description": "The parts of the JSON to match against using the MatchPattern. If you specify All, AWS WAF matches against keys and values. ", - "enum": [ - "ALL", - "KEY", - "VALUE" - ], - "type": "string" - } - }, - "required": [ - "MatchPattern", - "MatchScope" - ], - "type": "object" - }, "Method": { "description": "Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform. ", "type": "object" @@ -281,6 +232,12 @@ "LogDestinationConfigs" ], "sourceUrl": "https://github.com/advaj/aws-cloudformation-resource-providers-wafv2.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, "typeName": "AWS::WAFv2::LoggingConfiguration" } } \ No newline at end of file diff --git a/artifacts/types/AWS::WAFv2::RegexPatternSet.json b/artifacts/types/AWS::WAFv2::RegexPatternSet.json index 9c793f8e..89d3b7f7 100644 --- a/artifacts/types/AWS::WAFv2::RegexPatternSet.json +++ b/artifacts/types/AWS::WAFv2::RegexPatternSet.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-WAFv2-RegexPatternSet", "type": "AWS::WAFv2::RegexPatternSet", - "time": "2023-10-12T22:11:17.927Z", + "time": "2024-03-18T16:04:20.867Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -126,6 +126,12 @@ "RegularExpressionList" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-wafv2.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, "typeName": "AWS::WAFv2::RegexPatternSet" } } \ No newline at end of file diff --git a/artifacts/types/AWS::WAFv2::RuleGroup.json b/artifacts/types/AWS::WAFv2::RuleGroup.json index fbafebba..4de84380 100644 --- a/artifacts/types/AWS::WAFv2::RuleGroup.json +++ b/artifacts/types/AWS::WAFv2::RuleGroup.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-WAFv2-RuleGroup", "type": "AWS::WAFv2::RuleGroup", - "time": "2023-10-12T22:48:21.964Z", + "time": "2024-03-18T16:35:02.748Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -166,7 +166,7 @@ }, "Cookies": { "additionalProperties": false, - "description": "Includes headers of a web request.", + "description": "Includes cookies of a web request.", "properties": { "MatchPattern": { "$ref": "#/definitions/CookieMatchPattern" @@ -311,6 +311,15 @@ "pattern": "^[0-9A-Za-z_-]{1,128}$", "type": "string" }, + "EvaluationWindowSec": { + "enum": [ + 60, + 120, + 300, + 600 + ], + "type": "integer" + }, "FieldToMatch": { "additionalProperties": false, "description": "Field of the request to match.", @@ -328,6 +337,9 @@ "Headers": { "$ref": "#/definitions/Headers" }, + "JA3Fingerprint": { + "$ref": "#/definitions/JA3Fingerprint" + }, "JsonBody": { "$ref": "#/definitions/JsonBody" }, @@ -522,6 +534,23 @@ ], "type": "object" }, + "JA3Fingerprint": { + "additionalProperties": false, + "description": "Includes the JA3 fingerprint of a web request.", + "properties": { + "FallbackBehavior": { + "enum": [ + "MATCH", + "NO_MATCH" + ], + "type": "string" + } + }, + "required": [ + "FallbackBehavior" + ], + "type": "object" + }, "JsonBody": { "additionalProperties": false, "description": "Inspect the request body as JSON. The request body immediately follows the request headers.", @@ -690,9 +719,9 @@ "properties": { "AggregateKeyType": { "enum": [ - "CONSTANT", "IP", "FORWARDED_IP", + "CONSTANT", "CUSTOM_KEYS" ], "type": "string" @@ -705,6 +734,9 @@ "maxItems": 5, "type": "array" }, + "EvaluationWindowSec": { + "$ref": "#/definitions/EvaluationWindowSec" + }, "ForwardedIPConfig": { "$ref": "#/definitions/ForwardedIPConfiguration" }, @@ -1426,6 +1458,12 @@ "VisibilityConfig" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-wafv2.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, "typeName": "AWS::WAFv2::RuleGroup" } } \ No newline at end of file diff --git a/artifacts/types/AWS::WAFv2::WebACL.json b/artifacts/types/AWS::WAFv2::WebACL.json index fef0fc02..41660a06 100644 --- a/artifacts/types/AWS::WAFv2::WebACL.json +++ b/artifacts/types/AWS::WAFv2::WebACL.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-WAFv2-WebACL", "type": "AWS::WAFv2::WebACL", - "time": "2023-10-12T23:12:58.478Z", + "time": "2024-03-18T17:23:44.959Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -248,7 +248,7 @@ }, "Cookies": { "additionalProperties": false, - "description": "Includes headers of a web request.", + "description": "Includes cookies of a web request.", "properties": { "MatchPattern": { "$ref": "#/definitions/CookieMatchPattern" @@ -406,6 +406,15 @@ "pattern": "^[0-9A-Za-z_-]{1,128}$", "type": "string" }, + "EvaluationWindowSec": { + "enum": [ + 60, + 120, + 300, + 600 + ], + "type": "integer" + }, "ExcludedRule": { "additionalProperties": false, "description": "Excluded Rule in the RuleGroup or ManagedRuleGroup will not be evaluated.", @@ -457,6 +466,9 @@ "Headers": { "$ref": "#/definitions/Headers" }, + "JA3Fingerprint": { + "$ref": "#/definitions/JA3Fingerprint" + }, "JsonBody": { "$ref": "#/definitions/JsonBody" }, @@ -651,6 +663,23 @@ ], "type": "object" }, + "JA3Fingerprint": { + "additionalProperties": false, + "description": "Includes the JA3 fingerprint of a web request.", + "properties": { + "FallbackBehavior": { + "enum": [ + "MATCH", + "NO_MATCH" + ], + "type": "string" + } + }, + "required": [ + "FallbackBehavior" + ], + "type": "object" + }, "JsonBody": { "additionalProperties": false, "description": "Inspect the request body as JSON. The request body immediately follows the request headers.", @@ -927,6 +956,9 @@ "maxItems": 5, "type": "array" }, + "EvaluationWindowSec": { + "$ref": "#/definitions/EvaluationWindowSec" + }, "ForwardedIPConfig": { "$ref": "#/definitions/ForwardedIPConfiguration" }, @@ -1165,7 +1197,7 @@ "additionalProperties": false, "description": "Map of AssociatedResourceType and RequestBodyAssociatedResourceTypeConfig", "patternProperties": { - "^(CLOUDFRONT)$": { + "^(CLOUDFRONT|API_GATEWAY|COGNITO_USER_POOL|APP_RUNNER_SERVICE|VERIFIED_ACCESS_INSTANCE)$": { "$ref": "#/definitions/RequestBodyAssociatedResourceTypeConfig" } }, @@ -1964,6 +1996,12 @@ "VisibilityConfig" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-wafv2.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, "typeName": "AWS::WAFv2::WebACL" } } \ No newline at end of file diff --git a/artifacts/types/AWS::WAFv2::WebACLAssociation.json b/artifacts/types/AWS::WAFv2::WebACLAssociation.json index 9a14a6d6..e081307b 100644 --- a/artifacts/types/AWS::WAFv2::WebACLAssociation.json +++ b/artifacts/types/AWS::WAFv2::WebACLAssociation.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-WAFv2-WebACLAssociation", "type": "AWS::WAFv2::WebACLAssociation", - "time": "2023-10-12T22:14:48.11Z", + "time": "2024-03-18T17:43:12.098Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -119,6 +119,12 @@ "WebACLArn" ], "sourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-wafv2.git", + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": false, + "tagUpdatable": false, + "taggable": false + }, "typeName": "AWS::WAFv2::WebACLAssociation" } } \ No newline at end of file diff --git a/artifacts/types/AWS::Wisdom::Assistant.json b/artifacts/types/AWS::Wisdom::Assistant.json index f0dd790a..9589b16d 100644 --- a/artifacts/types/AWS::Wisdom::Assistant.json +++ b/artifacts/types/AWS::Wisdom::Assistant.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Wisdom-Assistant", "type": "AWS::Wisdom::Assistant", - "time": "2024-01-03T19:11:57.438Z", + "time": "2024-06-20T16:17:38.941Z", "schema": { "additionalIdentifiers": [ [ @@ -82,7 +82,9 @@ ] }, "update": { - "permissions": [] + "permissions": [ + "wisdom:GetAssistant" + ] } }, "primaryIdentifier": [ diff --git a/artifacts/types/AWS::Wisdom::AssistantAssociation.json b/artifacts/types/AWS::Wisdom::AssistantAssociation.json index 6b00e216..95a7e873 100644 --- a/artifacts/types/AWS::Wisdom::AssistantAssociation.json +++ b/artifacts/types/AWS::Wisdom::AssistantAssociation.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Wisdom-AssistantAssociation", "type": "AWS::Wisdom::AssistantAssociation", - "time": "2024-01-03T19:12:02.732Z", + "time": "2024-06-20T16:32:53.907Z", "schema": { "additionalIdentifiers": [ [ @@ -92,7 +92,9 @@ ] }, "update": { - "permissions": [] + "permissions": [ + "wisdom:GetAssistantAssociation" + ] } }, "primaryIdentifier": [ diff --git a/artifacts/types/AWS::Wisdom::KnowledgeBase.json b/artifacts/types/AWS::Wisdom::KnowledgeBase.json index 165419a1..68f04d53 100644 --- a/artifacts/types/AWS::Wisdom::KnowledgeBase.json +++ b/artifacts/types/AWS::Wisdom::KnowledgeBase.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-Wisdom-KnowledgeBase", "type": "AWS::Wisdom::KnowledgeBase", - "time": "2024-01-03T19:12:14.9Z", + "time": "2024-06-20T16:19:07.309Z", "schema": { "additionalIdentifiers": [ [ @@ -148,7 +148,9 @@ ] }, "update": { - "permissions": [] + "permissions": [ + "wisdom:GetKnowledgeBase" + ] } }, "primaryIdentifier": [ diff --git a/artifacts/types/AWS::WorkSpaces::WorkspacesPool.json b/artifacts/types/AWS::WorkSpaces::WorkspacesPool.json new file mode 100644 index 00000000..51675c54 --- /dev/null +++ b/artifacts/types/AWS::WorkSpaces::WorkspacesPool.json @@ -0,0 +1,198 @@ +{ + "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-WorkSpaces-WorkspacesPool", + "type": "AWS::WorkSpaces::WorkspacesPool", + "time": "2024-06-23T01:30:20.951Z", + "schema": { + "additionalProperties": false, + "createOnlyProperties": [ + "/properties/PoolName" + ], + "definitions": { + "ApplicationSettings": { + "additionalProperties": false, + "properties": { + "SettingsGroup": { + "maxLength": 100, + "pattern": "^[A-Za-z0-9_./()!*'-]+$", + "type": "string" + }, + "Status": { + "$ref": "#/definitions/ApplicationSettingsStatus" + } + }, + "required": [ + "Status" + ], + "type": "object" + }, + "ApplicationSettingsStatus": { + "enum": [ + "DISABLED", + "ENABLED" + ], + "type": "string" + }, + "Capacity": { + "additionalProperties": false, + "properties": { + "DesiredUserSessions": { + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "DesiredUserSessions" + ], + "type": "object" + }, + "Tag": { + "additionalProperties": false, + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + }, + "TimeoutSettings": { + "additionalProperties": false, + "properties": { + "DisconnectTimeoutInSeconds": { + "maximum": 36000, + "minimum": 60, + "type": "integer" + }, + "IdleDisconnectTimeoutInSeconds": { + "maximum": 36000, + "minimum": 0, + "type": "integer" + }, + "MaxUserDurationInSeconds": { + "maximum": 432000, + "minimum": 600, + "type": "integer" + } + }, + "required": [], + "type": "object" + } + }, + "deprecatedProperties": [ + "/properties/Tags/TagKey", + "/properties/Tags/TagValue" + ], + "description": "Resource Type definition for AWS::WorkSpaces::WorkspacesPool", + "handlers": { + "create": { + "permissions": [ + "workspaces:CreateWorkspacesPool", + "workspaces:DescribeWorkspacesPools", + "workspaces:CreateTags" + ] + }, + "delete": { + "permissions": [ + "workspaces:DescribeWorkspacesPools", + "workspaces:TerminateWorkspacesPool" + ] + }, + "list": { + "permissions": [ + "workspaces:DescribeWorkspacesPools" + ] + }, + "read": { + "permissions": [ + "workspaces:DescribeWorkspacesPools" + ] + }, + "update": { + "permissions": [ + "workspaces:UpdateWorkspacesPool" + ] + } + }, + "primaryIdentifier": [ + "/properties/PoolId" + ], + "properties": { + "ApplicationSettings": { + "$ref": "#/definitions/ApplicationSettings" + }, + "BundleId": { + "pattern": "^wsb-[0-9a-z]{8,63}$", + "type": "string" + }, + "Capacity": { + "$ref": "#/definitions/Capacity" + }, + "CreatedAt": { + "type": "string" + }, + "Description": { + "maxLength": 255, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_./() -]+$", + "type": "string" + }, + "DirectoryId": { + "maxLength": 65, + "minLength": 10, + "pattern": "^wsd-[0-9a-z]{8,63}$", + "type": "string" + }, + "PoolArn": { + "pattern": "^arn:aws[a-z-]{0,7}:[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,127}$", + "type": "string" + }, + "PoolId": { + "pattern": "^wspool-[0-9a-z]{9}$", + "type": "string" + }, + "PoolName": { + "pattern": "^[A-Za-z0-9][A-Za-z0-9_.-]{0,63}$", + "type": "string" + }, + "Tags": { + "insertionOrder": false, + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array", + "uniqueItems": false + }, + "TimeoutSettings": { + "$ref": "#/definitions/TimeoutSettings" + } + }, + "readOnlyProperties": [ + "/properties/PoolId", + "/properties/PoolArn", + "/properties/CreatedAt" + ], + "required": [ + "PoolName", + "BundleId", + "DirectoryId", + "Capacity" + ], + "tagging": { + "cloudFormationSystemTags": false, + "tagOnCreate": true, + "tagProperty": "/properties/Tags", + "tagUpdatable": false, + "taggable": true + }, + "typeName": "AWS::WorkSpaces::WorkspacesPool", + "writeOnlyProperties": [ + "/properties/Tags" + ] + } +} \ No newline at end of file diff --git a/artifacts/types/AWS::WorkSpacesThinClient::Environment.json b/artifacts/types/AWS::WorkSpacesThinClient::Environment.json index e1a4080d..69119c84 100644 --- a/artifacts/types/AWS::WorkSpacesThinClient::Environment.json +++ b/artifacts/types/AWS::WorkSpacesThinClient::Environment.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-WorkSpacesThinClient-Environment", "type": "AWS::WorkSpacesThinClient::Environment", - "time": "2024-01-04T10:24:13.827Z", + "time": "2024-06-21T01:26:40.228Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -119,16 +119,16 @@ "workspaces-web:GetPortal", "workspaces-web:GetUserSettings", "kms:DescribeKey", - "kms:Encrypt", - "kms:Decrypt", - "kms:CreateGrant" + "kms:CreateGrant", + "kms:GenerateDataKey", + "kms:Decrypt" ] }, "delete": { "permissions": [ "thinclient:DeleteEnvironment", "thinclient:UntagResource", - "kms:DescribeKey", + "kms:Decrypt", "kms:RetireGrant" ] }, @@ -136,8 +136,6 @@ "permissions": [ "thinclient:ListEnvironment", "thinclient:ListTagsForResource", - "kms:DescribeKey", - "kms:Encrypt", "kms:Decrypt" ] }, @@ -145,8 +143,6 @@ "permissions": [ "thinclient:GetEnvironment", "thinclient:ListTagsForResource", - "kms:DescribeKey", - "kms:Encrypt", "kms:Decrypt" ] }, @@ -157,15 +153,11 @@ "workspaces-web:GetPortal", "workspaces-web:GetUserSettings", "thinclient:UpdateEnvironment", - "thinclient:GetEnvironment", + "thinclient:ListTagsForResource", "thinclient:TagResource", "thinclient:UntagResource", - "thinclient:ListTagsForResource", - "kms:DescribeKey", - "kms:Encrypt", "kms:Decrypt", - "kms:CreateGrant", - "kms:RetireGrant" + "kms:GenerateDataKey" ] } }, @@ -285,7 +277,7 @@ "items": { "$ref": "#/definitions/Tag" }, - "maxItems": 20, + "maxItems": 50, "type": "array", "uniqueItems": true }, diff --git a/artifacts/types/AWS::WorkSpacesWeb::BrowserSettings.json b/artifacts/types/AWS::WorkSpacesWeb::BrowserSettings.json index e719b2ef..4e983d90 100644 --- a/artifacts/types/AWS::WorkSpacesWeb::BrowserSettings.json +++ b/artifacts/types/AWS::WorkSpacesWeb::BrowserSettings.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-WorkSpacesWeb-BrowserSettings", "type": "AWS::WorkSpacesWeb::BrowserSettings", - "time": "2024-01-03T16:39:53.233Z", + "time": "2024-05-16T15:35:26.077Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -155,10 +155,6 @@ "tagUpdatable": true, "taggable": true }, - "typeName": "AWS::WorkSpacesWeb::BrowserSettings", - "writeOnlyProperties": [ - "/properties/AdditionalEncryptionContext", - "/properties/CustomerManagedKey" - ] + "typeName": "AWS::WorkSpacesWeb::BrowserSettings" } } \ No newline at end of file diff --git a/artifacts/types/AWS::WorkSpacesWeb::IdentityProvider.json b/artifacts/types/AWS::WorkSpacesWeb::IdentityProvider.json index a2cbf3e7..d634e26c 100644 --- a/artifacts/types/AWS::WorkSpacesWeb::IdentityProvider.json +++ b/artifacts/types/AWS::WorkSpacesWeb::IdentityProvider.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-WorkSpacesWeb-IdentityProvider", "type": "AWS::WorkSpacesWeb::IdentityProvider", - "time": "2024-01-03T17:40:41.951Z", + "time": "2024-05-16T16:37:10.933Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::WorkSpacesWeb::IpAccessSettings.json b/artifacts/types/AWS::WorkSpacesWeb::IpAccessSettings.json index 87c88499..05ec7fc5 100644 --- a/artifacts/types/AWS::WorkSpacesWeb::IpAccessSettings.json +++ b/artifacts/types/AWS::WorkSpacesWeb::IpAccessSettings.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-WorkSpacesWeb-IpAccessSettings", "type": "AWS::WorkSpacesWeb::IpAccessSettings", - "time": "2024-01-03T16:39:44.459Z", + "time": "2024-05-16T15:34:58.404Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -200,10 +200,6 @@ "tagUpdatable": true, "taggable": true }, - "typeName": "AWS::WorkSpacesWeb::IpAccessSettings", - "writeOnlyProperties": [ - "/properties/AdditionalEncryptionContext", - "/properties/CustomerManagedKey" - ] + "typeName": "AWS::WorkSpacesWeb::IpAccessSettings" } } \ No newline at end of file diff --git a/artifacts/types/AWS::WorkSpacesWeb::NetworkSettings.json b/artifacts/types/AWS::WorkSpacesWeb::NetworkSettings.json index e3c0f8e5..aa783469 100644 --- a/artifacts/types/AWS::WorkSpacesWeb::NetworkSettings.json +++ b/artifacts/types/AWS::WorkSpacesWeb::NetworkSettings.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-WorkSpacesWeb-NetworkSettings", "type": "AWS::WorkSpacesWeb::NetworkSettings", - "time": "2024-01-03T16:36:56.458Z", + "time": "2024-05-16T15:34:00.33Z", "schema": { "additionalProperties": false, "definitions": { diff --git a/artifacts/types/AWS::WorkSpacesWeb::Portal.json b/artifacts/types/AWS::WorkSpacesWeb::Portal.json index 2abde067..bd097f8f 100644 --- a/artifacts/types/AWS::WorkSpacesWeb::Portal.json +++ b/artifacts/types/AWS::WorkSpacesWeb::Portal.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-WorkSpacesWeb-Portal", "type": "AWS::WorkSpacesWeb::Portal", - "time": "2024-01-03T17:21:12.754Z", + "time": "2024-05-16T16:19:31.912Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -34,6 +34,14 @@ }, "type": "object" }, + "InstanceType": { + "enum": [ + "standard.regular", + "standard.large", + "standard.xlarge" + ], + "type": "string" + }, "PortalStatus": { "enum": [ "Incomplete", @@ -204,12 +212,20 @@ "pattern": "^.+$", "type": "string" }, + "InstanceType": { + "$ref": "#/definitions/InstanceType" + }, "IpAccessSettingsArn": { "maxLength": 2048, "minLength": 20, "pattern": "^arn:[\\w+=\\/,.@-]+:[a-zA-Z0-9\\-]+:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\\/[a-fA-F0-9\\-]{36})+$", "type": "string" }, + "MaxConcurrentSessions": { + "maximum": 5000, + "minimum": 1, + "type": "number" + }, "NetworkSettingsArn": { "maxLength": 2048, "minLength": 20, @@ -291,10 +307,6 @@ "tagUpdatable": true, "taggable": true }, - "typeName": "AWS::WorkSpacesWeb::Portal", - "writeOnlyProperties": [ - "/properties/AdditionalEncryptionContext", - "/properties/CustomerManagedKey" - ] + "typeName": "AWS::WorkSpacesWeb::Portal" } } \ No newline at end of file diff --git a/artifacts/types/AWS::WorkSpacesWeb::TrustStore.json b/artifacts/types/AWS::WorkSpacesWeb::TrustStore.json index 1b1ce1a0..7116022e 100644 --- a/artifacts/types/AWS::WorkSpacesWeb::TrustStore.json +++ b/artifacts/types/AWS::WorkSpacesWeb::TrustStore.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-WorkSpacesWeb-TrustStore", "type": "AWS::WorkSpacesWeb::TrustStore", - "time": "2024-01-03T16:36:10.128Z", + "time": "2024-05-16T15:34:04.199Z", "schema": { "additionalProperties": false, "definitions": { diff --git a/artifacts/types/AWS::WorkSpacesWeb::UserAccessLoggingSettings.json b/artifacts/types/AWS::WorkSpacesWeb::UserAccessLoggingSettings.json index 7fe7b337..f01f425c 100644 --- a/artifacts/types/AWS::WorkSpacesWeb::UserAccessLoggingSettings.json +++ b/artifacts/types/AWS::WorkSpacesWeb::UserAccessLoggingSettings.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-WorkSpacesWeb-UserAccessLoggingSettings", "type": "AWS::WorkSpacesWeb::UserAccessLoggingSettings", - "time": "2024-01-03T16:36:53.137Z", + "time": "2024-05-16T15:34:16.982Z", "schema": { "additionalProperties": false, "definitions": { diff --git a/artifacts/types/AWS::WorkSpacesWeb::UserSettings.json b/artifacts/types/AWS::WorkSpacesWeb::UserSettings.json index 67e372c5..c3df63fa 100644 --- a/artifacts/types/AWS::WorkSpacesWeb::UserSettings.json +++ b/artifacts/types/AWS::WorkSpacesWeb::UserSettings.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-WorkSpacesWeb-UserSettings", "type": "AWS::WorkSpacesWeb::UserSettings", - "time": "2024-01-03T16:36:13.718Z", + "time": "2024-05-16T15:48:58.785Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ @@ -248,10 +248,6 @@ "tagUpdatable": true, "taggable": true }, - "typeName": "AWS::WorkSpacesWeb::UserSettings", - "writeOnlyProperties": [ - "/properties/AdditionalEncryptionContext", - "/properties/CustomerManagedKey" - ] + "typeName": "AWS::WorkSpacesWeb::UserSettings" } } \ No newline at end of file diff --git a/artifacts/types/AWS::XRay::Group.json b/artifacts/types/AWS::XRay::Group.json index a1709f4e..501499b8 100644 --- a/artifacts/types/AWS::XRay::Group.json +++ b/artifacts/types/AWS::XRay::Group.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-XRay-Group", "type": "AWS::XRay::Group", - "time": "2023-11-14T19:30:46.366Z", + "time": "2024-06-05T21:12:29.117Z", "schema": { "additionalProperties": false, "definitions": { diff --git a/artifacts/types/AWS::XRay::ResourcePolicy.json b/artifacts/types/AWS::XRay::ResourcePolicy.json index 7a89b0ef..ab079028 100644 --- a/artifacts/types/AWS::XRay::ResourcePolicy.json +++ b/artifacts/types/AWS::XRay::ResourcePolicy.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-XRay-ResourcePolicy", "type": "AWS::XRay::ResourcePolicy", - "time": "2023-11-14T19:30:44.764Z", + "time": "2024-06-05T21:13:51.863Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/artifacts/types/AWS::XRay::SamplingRule.json b/artifacts/types/AWS::XRay::SamplingRule.json index 89322c06..11ad845f 100644 --- a/artifacts/types/AWS::XRay::SamplingRule.json +++ b/artifacts/types/AWS::XRay::SamplingRule.json @@ -1,7 +1,7 @@ { "arn": "arn:aws:cloudformation:us-west-2::type/resource/AWS-XRay-SamplingRule", "type": "AWS::XRay::SamplingRule", - "time": "2023-11-14T19:30:45.365Z", + "time": "2024-06-05T21:12:55.859Z", "schema": { "additionalProperties": false, "createOnlyProperties": [ diff --git a/bicep-types b/bicep-types new file mode 160000 index 00000000..14e01fbe --- /dev/null +++ b/bicep-types @@ -0,0 +1 @@ +Subproject commit 14e01fbe5c704893cdade39c8a29e585f3d54acb diff --git a/src/aws-type-downloader/go.mod b/src/aws-type-downloader/go.mod index 95c2ee72..637aff65 100644 --- a/src/aws-type-downloader/go.mod +++ b/src/aws-type-downloader/go.mod @@ -3,24 +3,25 @@ module github.com/radius-project/bicep-types-aws/src/aws-type-downloader go 1.19 require ( - github.com/aws/aws-sdk-go-v2 v1.17.1 - github.com/aws/aws-sdk-go-v2/config v1.18.3 + github.com/aws/aws-sdk-go-v2 v1.25.3 + github.com/aws/aws-sdk-go-v2/config v1.27.7 github.com/aws/aws-sdk-go-v2/service/cloudcontrol v1.10.19 - github.com/aws/aws-sdk-go-v2/service/cloudformation v1.24.1 - github.com/spf13/cobra v1.6.1 + github.com/aws/aws-sdk-go-v2/service/cloudformation v1.47.2 + github.com/spf13/cobra v1.8.0 ) require ( - github.com/aws/aws-sdk-go-v2/credentials v1.13.3 // indirect - github.com/aws/aws-sdk-go-v2/feature/ec2/imds v1.12.19 // indirect - github.com/aws/aws-sdk-go-v2/internal/configsources v1.1.25 // indirect - github.com/aws/aws-sdk-go-v2/internal/endpoints/v2 v2.4.19 // indirect - github.com/aws/aws-sdk-go-v2/internal/ini v1.3.26 // indirect - github.com/aws/aws-sdk-go-v2/service/internal/presigned-url v1.9.19 // indirect - github.com/aws/aws-sdk-go-v2/service/sso v1.11.25 // indirect - github.com/aws/aws-sdk-go-v2/service/ssooidc v1.13.8 // indirect - github.com/aws/aws-sdk-go-v2/service/sts v1.17.5 // indirect - github.com/aws/smithy-go v1.13.4 // indirect + github.com/aws/aws-sdk-go-v2/credentials v1.17.7 // indirect + github.com/aws/aws-sdk-go-v2/feature/ec2/imds v1.15.3 // indirect + github.com/aws/aws-sdk-go-v2/internal/configsources v1.3.3 // indirect + github.com/aws/aws-sdk-go-v2/internal/endpoints/v2 v2.6.3 // indirect + github.com/aws/aws-sdk-go-v2/internal/ini v1.8.0 // indirect + github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding v1.11.1 // indirect + github.com/aws/aws-sdk-go-v2/service/internal/presigned-url v1.11.5 // indirect + github.com/aws/aws-sdk-go-v2/service/sso v1.20.2 // indirect + github.com/aws/aws-sdk-go-v2/service/ssooidc v1.23.2 // indirect + github.com/aws/aws-sdk-go-v2/service/sts v1.28.4 // indirect + github.com/aws/smithy-go v1.20.1 // indirect github.com/inconshreveable/mousetrap v1.1.0 // indirect github.com/jmespath/go-jmespath v0.4.0 // indirect github.com/spf13/pflag v1.0.5 // indirect diff --git a/src/aws-type-downloader/go.sum b/src/aws-type-downloader/go.sum index 12122a60..a65398c3 100644 --- a/src/aws-type-downloader/go.sum +++ b/src/aws-type-downloader/go.sum @@ -1,37 +1,41 @@ -github.com/aws/aws-sdk-go-v2 v1.17.1 h1:02c72fDJr87N8RAC2s3Qu0YuvMRZKNZJ9F+lAehCazk= github.com/aws/aws-sdk-go-v2 v1.17.1/go.mod h1:JLnGeGONAyi2lWXI1p0PCIOIy333JMVK1U7Hf0aRFLw= -github.com/aws/aws-sdk-go-v2/config v1.18.3 h1:3kfBKcX3votFX84dm00U8RGA1sCCh3eRMOGzg5dCWfU= -github.com/aws/aws-sdk-go-v2/config v1.18.3/go.mod h1:BYdrbeCse3ZnOD5+2/VE/nATOK8fEUpBtmPMdKSyhMU= -github.com/aws/aws-sdk-go-v2/credentials v1.13.3 h1:ur+FHdp4NbVIv/49bUjBW+FE7e57HOo03ELodttmagk= -github.com/aws/aws-sdk-go-v2/credentials v1.13.3/go.mod h1:/rOMmqYBcFfNbRPU0iN9IgGqD5+V2yp3iWNmIlz0wI4= -github.com/aws/aws-sdk-go-v2/feature/ec2/imds v1.12.19 h1:E3PXZSI3F2bzyj6XxUXdTIfvp425HHhwKsFvmzBwHgs= -github.com/aws/aws-sdk-go-v2/feature/ec2/imds v1.12.19/go.mod h1:VihW95zQpeKQWVPGkwT+2+WJNQV8UXFfMTWdU6VErL8= -github.com/aws/aws-sdk-go-v2/internal/configsources v1.1.25 h1:nBO/RFxeq/IS5G9Of+ZrgucRciie2qpLy++3UGZ+q2E= +github.com/aws/aws-sdk-go-v2 v1.25.3 h1:xYiLpZTQs1mzvz5PaI6uR0Wh57ippuEthxS4iK5v0n0= +github.com/aws/aws-sdk-go-v2 v1.25.3/go.mod h1:35hUlJVYd+M++iLI3ALmVwMOyRYMmRqUXpTtRGW+K9I= +github.com/aws/aws-sdk-go-v2/config v1.27.7 h1:JSfb5nOQF01iOgxFI5OIKWwDiEXWTyTgg1Mm1mHi0A4= +github.com/aws/aws-sdk-go-v2/config v1.27.7/go.mod h1:PH0/cNpoMO+B04qET699o5W92Ca79fVtbUnvMIZro4I= +github.com/aws/aws-sdk-go-v2/credentials v1.17.7 h1:WJd+ubWKoBeRh7A5iNMnxEOs982SyVKOJD+K8HIezu4= +github.com/aws/aws-sdk-go-v2/credentials v1.17.7/go.mod h1:UQi7LMR0Vhvs+44w5ec8Q+VS+cd10cjwgHwiVkE0YGU= +github.com/aws/aws-sdk-go-v2/feature/ec2/imds v1.15.3 h1:p+y7FvkK2dxS+FEwRIDHDe//ZX+jDhP8HHE50ppj4iI= +github.com/aws/aws-sdk-go-v2/feature/ec2/imds v1.15.3/go.mod h1:/fYB+FZbDlwlAiynK9KDXlzZl3ANI9JkD0Uhz5FjNT4= github.com/aws/aws-sdk-go-v2/internal/configsources v1.1.25/go.mod h1:Zb29PYkf42vVYQY6pvSyJCJcFHlPIiY+YKdPtwnvMkY= -github.com/aws/aws-sdk-go-v2/internal/endpoints/v2 v2.4.19 h1:oRHDrwCTVT8ZXi4sr9Ld+EXk7N/KGssOr2ygNeojEhw= +github.com/aws/aws-sdk-go-v2/internal/configsources v1.3.3 h1:ifbIbHZyGl1alsAhPIYsHOg5MuApgqOvVeI8wIugXfs= +github.com/aws/aws-sdk-go-v2/internal/configsources v1.3.3/go.mod h1:oQZXg3c6SNeY6OZrDY+xHcF4VGIEoNotX2B4PrDeoJI= github.com/aws/aws-sdk-go-v2/internal/endpoints/v2 v2.4.19/go.mod h1:6Q0546uHDp421okhmmGfbxzq2hBqbXFNpi4k+Q1JnQA= -github.com/aws/aws-sdk-go-v2/internal/ini v1.3.26 h1:Mza+vlnZr+fPKFKRq/lKGVvM6B/8ZZmNdEopOwSQLms= -github.com/aws/aws-sdk-go-v2/internal/ini v1.3.26/go.mod h1:Y2OJ+P+MC1u1VKnavT+PshiEuGPyh/7DqxoDNij4/bg= +github.com/aws/aws-sdk-go-v2/internal/endpoints/v2 v2.6.3 h1:Qvodo9gHG9F3E8SfYOspPeBt0bjSbsevK8WhRAUHcoY= +github.com/aws/aws-sdk-go-v2/internal/endpoints/v2 v2.6.3/go.mod h1:vCKrdLXtybdf/uQd/YfVR2r5pcbNuEYKzMQpcxmeSJw= +github.com/aws/aws-sdk-go-v2/internal/ini v1.8.0 h1:hT8rVHwugYE2lEfdFE0QWVo81lF7jMrYJVDWI+f+VxU= +github.com/aws/aws-sdk-go-v2/internal/ini v1.8.0/go.mod h1:8tu/lYfQfFe6IGnaOdrpVgEL2IrrDOf6/m9RQum4NkY= github.com/aws/aws-sdk-go-v2/service/cloudcontrol v1.10.19 h1:CqkR3MZ3y5V7E0yy5FjoGZRV5xuUoa93M02TKoyrvd8= github.com/aws/aws-sdk-go-v2/service/cloudcontrol v1.10.19/go.mod h1:6vkpJjJPiLqUFFbON9I6xLkrk4Jil8vAuLhNnxGtaAQ= -github.com/aws/aws-sdk-go-v2/service/cloudformation v1.24.1 h1:k8/rAveUOcZV8Ex6WiCmvdtTcDtyf0QgvMmVFA9PRJ8= -github.com/aws/aws-sdk-go-v2/service/cloudformation v1.24.1/go.mod h1:AyrrIfauUrYfHqLrnroijTBBegQow3QIZTaLbQsauNk= -github.com/aws/aws-sdk-go-v2/service/internal/presigned-url v1.9.19 h1:GE25AWCdNUPh9AOJzI9KIJnja7IwUc1WyUqz/JTyJ/I= -github.com/aws/aws-sdk-go-v2/service/internal/presigned-url v1.9.19/go.mod h1:02CP6iuYP+IVnBX5HULVdSAku/85eHB2Y9EsFhrkEwU= -github.com/aws/aws-sdk-go-v2/service/sso v1.11.25 h1:GFZitO48N/7EsFDt8fMa5iYdmWqkUDDB3Eje6z3kbG0= -github.com/aws/aws-sdk-go-v2/service/sso v1.11.25/go.mod h1:IARHuzTXmj1C0KS35vboR0FeJ89OkEy1M9mWbK2ifCI= -github.com/aws/aws-sdk-go-v2/service/ssooidc v1.13.8 h1:jcw6kKZrtNfBPJkaHrscDOZoe5gvi9wjudnxvozYFJo= -github.com/aws/aws-sdk-go-v2/service/ssooidc v1.13.8/go.mod h1:er2JHN+kBY6FcMfcBBKNGCT3CarImmdFzishsqBmSRI= -github.com/aws/aws-sdk-go-v2/service/sts v1.17.5 h1:60SJ4lhvn///8ygCzYy2l53bFW/Q15bVfyjyAWo6zuw= -github.com/aws/aws-sdk-go-v2/service/sts v1.17.5/go.mod h1:bXcN3koeVYiJcdDU89n3kCYILob7Y34AeLopUbZgLT4= -github.com/aws/smithy-go v1.13.4 h1:/RN2z1txIJWeXeOkzX+Hk/4Uuvv7dWtCjbmVJcrskyk= +github.com/aws/aws-sdk-go-v2/service/cloudformation v1.47.2 h1:CcIbHg7dQRdIXU4sMM1S8hy16RqTg0rq156cAhbg82c= +github.com/aws/aws-sdk-go-v2/service/cloudformation v1.47.2/go.mod h1:M1MzxSL622D8loHtyq/5TWqJvnYU+Oth0Wa6/U9NjNU= +github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding v1.11.1 h1:EyBZibRTVAs6ECHZOw5/wlylS9OcTzwyjeQMudmREjE= +github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding v1.11.1/go.mod h1:JKpmtYhhPs7D97NL/ltqz7yCkERFW5dOlHyVl66ZYF8= +github.com/aws/aws-sdk-go-v2/service/internal/presigned-url v1.11.5 h1:K/NXvIftOlX+oGgWGIa3jDyYLDNsdVhsjHmsBH2GLAQ= +github.com/aws/aws-sdk-go-v2/service/internal/presigned-url v1.11.5/go.mod h1:cl9HGLV66EnCmMNzq4sYOti+/xo8w34CsgzVtm2GgsY= +github.com/aws/aws-sdk-go-v2/service/sso v1.20.2 h1:XOPfar83RIRPEzfihnp+U6udOveKZJvPQ76SKWrLRHc= +github.com/aws/aws-sdk-go-v2/service/sso v1.20.2/go.mod h1:Vv9Xyk1KMHXrR3vNQe8W5LMFdTjSeWk0gBZBzvf3Qa0= +github.com/aws/aws-sdk-go-v2/service/ssooidc v1.23.2 h1:pi0Skl6mNl2w8qWZXcdOyg197Zsf4G97U7Sso9JXGZE= +github.com/aws/aws-sdk-go-v2/service/ssooidc v1.23.2/go.mod h1:JYzLoEVeLXk+L4tn1+rrkfhkxl6mLDEVaDSvGq9og90= +github.com/aws/aws-sdk-go-v2/service/sts v1.28.4 h1:Ppup1nVNAOWbBOrcoOxaxPeEnSFB2RnnQdguhXpmeQk= +github.com/aws/aws-sdk-go-v2/service/sts v1.28.4/go.mod h1:+K1rNPVyGxkRuv9NNiaZ4YhBFuyw2MMA9SlIJ1Zlpz8= github.com/aws/smithy-go v1.13.4/go.mod h1:Tg+OJXh4MB2R/uN61Ko2f6hTZwB/ZYGOtib8J3gBHzA= -github.com/cpuguy83/go-md2man/v2 v2.0.2/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o= +github.com/aws/smithy-go v1.20.1 h1:4SZlSlMr36UEqC7XOyRVb27XMeZubNcBNN+9IgEPIQw= +github.com/aws/smithy-go v1.20.1/go.mod h1:krry+ya/rV9RDcV/Q16kpu6ypI4K2czasz0NC3qS14E= +github.com/cpuguy83/go-md2man/v2 v2.0.3/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o= github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8= github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= -github.com/google/go-cmp v0.5.8 h1:e6P7q2lk1O+qJJb4BtCQXlK8vWEO8V1ZeuEdJNOqZyg= github.com/google/go-cmp v0.5.8/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY= -github.com/inconshreveable/mousetrap v1.0.1/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw= github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8= github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw= github.com/jmespath/go-jmespath v0.4.0 h1:BEgLn5cpjn8UN1mAw4NjwDrS35OdebyEtFe+9YPoQUg= @@ -41,8 +45,8 @@ github.com/jmespath/go-jmespath/internal/testify v1.5.1/go.mod h1:L3OGu8Wl2/fWfC github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM= -github.com/spf13/cobra v1.6.1 h1:o94oiPyS4KD1mPy2fmcYYHHfCxLqYjJOhGsCHFZtEzA= -github.com/spf13/cobra v1.6.1/go.mod h1:IOw/AERYS7UzyrGinqmz6HLUo219MORXGxhbaJUqzrY= +github.com/spf13/cobra v1.8.0 h1:7aJaZx1B85qltLMc546zn58BxxfZdR/W22ej9CFoEf0= +github.com/spf13/cobra v1.8.0/go.mod h1:WXLWApfZ71AjXPya3WOlMsY9yMs7YeiHhFVlvLyhcho= github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA= github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg= github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= diff --git a/src/aws-type-generator/package-lock.json b/src/aws-type-generator/package-lock.json index cd906e98..9f223467 100644 --- a/src/aws-type-generator/package-lock.json +++ b/src/aws-type-generator/package-lock.json @@ -17,11 +17,33 @@ "@types/jest": "^29.0.0", "@types/lodash": "^4.14.182", "@types/node": "^18.6.4", + "async": "^3.2.3", + "bicep-types": "file:../../bicep-types/src/bicep-types", + "colors": "^1.4.0", "jest": "^28.1.3", "ts-jest": "^28.0.8", "typescript": "^4.7.4" } }, + "../../bicep-types/src/bicep-types": { + "version": "0.0.0-placeholder", + "dev": true, + "license": "MIT", + "devDependencies": { + "@types/jest": "^29.0.3", + "@types/node": "^20.1.0", + "@typescript-eslint/eslint-plugin": "^7.0.2", + "@typescript-eslint/parser": "^7.0.2", + "eslint": "^8.23.1", + "eslint-plugin-header": "^3.1.1", + "eslint-plugin-jest": "^27.0.4", + "jest": "^29.0.3", + "nerdbank-gitversioning": "^3.5.113", + "ts-jest": "^29.0.1", + "ts-node": "^10.9.1", + "typescript": "^5.0.2" + } + }, "node_modules/@ampproject/remapping": { "version": "2.2.0", "resolved": "https://registry.npmjs.org/@ampproject/remapping/-/remapping-2.2.0.tgz", @@ -1308,6 +1330,12 @@ "sprintf-js": "~1.0.2" } }, + "node_modules/async": { + "version": "3.2.5", + "resolved": "https://registry.npmjs.org/async/-/async-3.2.5.tgz", + "integrity": "sha512-baNZyqaaLhyLVKm/DlvdW051MSgO6b8eVfIezl9E5PqWxFgzLm/wQntEW4zOytVburDEr0JlALEpdOFwvErLsg==", + "dev": true + }, "node_modules/babel-jest": { "version": "28.1.3", "resolved": "https://registry.npmjs.org/babel-jest/-/babel-jest-28.1.3.tgz", @@ -1405,6 +1433,10 @@ "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==", "dev": true }, + "node_modules/bicep-types": { + "resolved": "../../bicep-types/src/bicep-types", + "link": true + }, "node_modules/brace-expansion": { "version": "1.1.11", "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", @@ -1595,6 +1627,15 @@ "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==" }, + "node_modules/colors": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/colors/-/colors-1.4.0.tgz", + "integrity": "sha512-a+UqTh4kgZg/SlGvfbzDHpgRu7AAQOmmqRHJnxhRZICKFUT91brVhNNt58CMWU9PsBbv3PDCZUHbVxuDiH2mtA==", + "dev": true, + "engines": { + "node": ">=0.1.90" + } + }, "node_modules/concat-map": { "version": "0.0.1", "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", @@ -4724,6 +4765,12 @@ "sprintf-js": "~1.0.2" } }, + "async": { + "version": "3.2.5", + "resolved": "https://registry.npmjs.org/async/-/async-3.2.5.tgz", + "integrity": "sha512-baNZyqaaLhyLVKm/DlvdW051MSgO6b8eVfIezl9E5PqWxFgzLm/wQntEW4zOytVburDEr0JlALEpdOFwvErLsg==", + "dev": true + }, "babel-jest": { "version": "28.1.3", "resolved": "https://registry.npmjs.org/babel-jest/-/babel-jest-28.1.3.tgz", @@ -4800,6 +4847,23 @@ "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==", "dev": true }, + "bicep-types": { + "version": "file:../../bicep-types/src/bicep-types", + "requires": { + "@types/jest": "^29.0.3", + "@types/node": "^20.1.0", + "@typescript-eslint/eslint-plugin": "^7.0.2", + "@typescript-eslint/parser": "^7.0.2", + "eslint": "^8.23.1", + "eslint-plugin-header": "^3.1.1", + "eslint-plugin-jest": "^27.0.4", + "jest": "^29.0.3", + "nerdbank-gitversioning": "^3.5.113", + "ts-jest": "^29.0.1", + "ts-node": "^10.9.1", + "typescript": "^5.0.2" + } + }, "brace-expansion": { "version": "1.1.11", "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", @@ -4936,6 +5000,12 @@ "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==" }, + "colors": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/colors/-/colors-1.4.0.tgz", + "integrity": "sha512-a+UqTh4kgZg/SlGvfbzDHpgRu7AAQOmmqRHJnxhRZICKFUT91brVhNNt58CMWU9PsBbv3PDCZUHbVxuDiH2mtA==", + "dev": true + }, "concat-map": { "version": "0.0.1", "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", diff --git a/src/aws-type-generator/package.json b/src/aws-type-generator/package.json index 05a17537..5c9cf5f9 100644 --- a/src/aws-type-generator/package.json +++ b/src/aws-type-generator/package.json @@ -15,9 +15,12 @@ "@types/jest": "^29.0.0", "@types/lodash": "^4.14.182", "@types/node": "^18.6.4", + "bicep-types": "file:../../bicep-types/src/bicep-types", "jest": "^28.1.3", "ts-jest": "^28.0.8", - "typescript": "^4.7.4" + "typescript": "^4.7.4", + "async": "^3.2.3", + "colors": "^1.4.0" }, "dependencies": { "@types/yargs": "^17.0.11", diff --git a/src/aws-type-generator/src/convert.test.ts b/src/aws-type-generator/src/convert.test.ts index c90aeafd..0d7ff3f6 100644 --- a/src/aws-type-generator/src/convert.test.ts +++ b/src/aws-type-generator/src/convert.test.ts @@ -3,7 +3,7 @@ import path from "path"; import { describe, expect, test } from '@jest/globals'; import { convertSchemaRecordToTypes } from './convert' import { SchemaRecord } from "./schemarecord"; -import { ArrayType, BuiltInType, BuiltInTypeKind, ObjectProperty, ObjectPropertyFlags, ObjectType, ResourceType, ScopeType, StringLiteralType, TypeBase, TypeReference } from "./lib/types"; +import { ArrayType, IntegerType, ObjectTypePropertyFlags, ObjectType, ResourceType, ScopeType, BicepType, TypeReference, ResourceFlags, TypeBaseKind, StringType, BooleanType, ObjectTypeProperty } from "bicep-types"; describe('convert', () => { test('AWS::Kinesis::Stream', () => { @@ -13,102 +13,123 @@ describe('convert', () => { const types = convertSchemaRecordToTypes([schemaRecord]); const resourceType = lookupResourceType(types, "AWS.Kinesis/Stream@default"); - expect(resourceType).toStrictEqual(new ResourceType( - "AWS.Kinesis/Stream@default", - ScopeType.Unknown, - new TypeReference(lookupObjectTypeIndex(types, "AWS.Kinesis/Stream")))); + expect(resourceType).toStrictEqual({ + type: TypeBaseKind.ResourceType, + name: "AWS.Kinesis/Stream@default", + scopeType: ScopeType.Unknown, + readOnlyScopes: undefined, + body: new TypeReference(lookupObjectTypeIndex(types, "AWS.Kinesis/Stream")), + flags: ResourceFlags.None, + functions: undefined, + }); const bodyType = lookupObjectType(types, "AWS.Kinesis/Stream"); - expect(bodyType).toStrictEqual(new ObjectType( - "AWS.Kinesis/Stream", - { - "name": new ObjectProperty( - new TypeReference(lookupBuiltInTypeIndex(types, BuiltInTypeKind.String)), - ObjectPropertyFlags.None, - "the resource name"), - - "alias": new ObjectProperty( - new TypeReference(lookupBuiltInTypeIndex(types, BuiltInTypeKind.String)), - ObjectPropertyFlags.Required, - "the resource alias"), - - "properties": new ObjectProperty( - new TypeReference(lookupObjectTypeIndex(types, "AWS.Kinesis/StreamProperties")), - ObjectPropertyFlags.None, - "properties of the resource") - })); + expect(bodyType).toStrictEqual({ + type: TypeBaseKind.ObjectType, + name: "AWS.Kinesis/Stream", + properties: { + "name": { + type: new TypeReference(lookupStringType(types)), + flags: ObjectTypePropertyFlags.None, + description: "the resource name"} as ObjectTypeProperty, + + "alias": { + type: new TypeReference(lookupStringType(types)), + flags: ObjectTypePropertyFlags.Required | ObjectTypePropertyFlags.Identifier, + description: "the resource alias"} as ObjectTypeProperty, + + "properties": { + type: new TypeReference(lookupObjectTypeIndex(types, "AWS.Kinesis/StreamProperties")), + flags: ObjectTypePropertyFlags.None | ObjectTypePropertyFlags.Identifier, + description: "properties of the resource"} as ObjectTypeProperty + }, + additionalProperties: undefined, + sensitive: undefined, + }); const propertiesType = lookupObjectType(types, "AWS.Kinesis/StreamProperties"); - expect(propertiesType).toStrictEqual(new ObjectType( - "AWS.Kinesis/StreamProperties", - { - "Arn": new ObjectProperty( - new TypeReference(lookupBuiltInTypeIndex(types, BuiltInTypeKind.String)), - ObjectPropertyFlags.ReadOnly, - "The Amazon resource name (ARN) of the Kinesis stream"), - "Name": new ObjectProperty( - new TypeReference(lookupBuiltInTypeIndex(types, BuiltInTypeKind.String)), - ObjectPropertyFlags.Identifier, - "The name of the Kinesis stream."), - "RetentionPeriodHours": new ObjectProperty( - new TypeReference(lookupBuiltInTypeIndex(types, BuiltInTypeKind.Int)), - ObjectPropertyFlags.None, - "The number of hours for the data records that are stored in shards to remain accessible."), - "ShardCount": new ObjectProperty( - new TypeReference(lookupBuiltInTypeIndex(types, BuiltInTypeKind.Int)), - ObjectPropertyFlags.None, - "The number of shards that the stream uses. Required when StreamMode = PROVISIONED is passed."), - "StreamEncryption": new ObjectProperty( - new TypeReference(lookupObjectTypeIndex(types, "StreamEncryption")), - ObjectPropertyFlags.None, - "When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream."), - "StreamModeDetails": new ObjectProperty( - new TypeReference(lookupObjectTypeIndex(types, "StreamModeDetails")), - ObjectPropertyFlags.None, - "The mode in which the stream is running."), - "Tags": new ObjectProperty( - new TypeReference(lookupArrayTypeIndex(types, new TypeReference(lookupObjectTypeIndex(types, "Tag")))), - ObjectPropertyFlags.None, - "An arbitrary set of tags (key–value pairs) to associate with the Kinesis stream."), - })); + expect(propertiesType).toStrictEqual({ + type: TypeBaseKind.ObjectType, + name: "AWS.Kinesis/StreamProperties", + properties: { + "Arn": { + type: new TypeReference(lookupStringType(types)), + flags: ObjectTypePropertyFlags.ReadOnly, + description: "The Amazon resource name (ARN) of the Kinesis stream"} as ObjectTypeProperty, + "Name": { + type: new TypeReference(lookupStringType(types)), + flags: ObjectTypePropertyFlags.Identifier, + description: "The name of the Kinesis stream."} as ObjectTypeProperty, + "RetentionPeriodHours": { + type: new TypeReference(lookupIntegerTypeIndex(types)), + flags: ObjectTypePropertyFlags.None, + description: "The number of hours for the data records that are stored in shards to remain accessible."} as ObjectTypeProperty, + "ShardCount": { + type: new TypeReference(lookupIntegerTypeIndex(types)), + flags: ObjectTypePropertyFlags.None, + description: "The number of shards that the stream uses. Required when StreamMode = PROVISIONED is passed."} as ObjectTypeProperty, + "StreamEncryption": { + type: new TypeReference(lookupObjectTypeIndex(types, "StreamEncryption")), + flags: ObjectTypePropertyFlags.None, + description: "When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream."} as ObjectTypeProperty, + "StreamModeDetails": { + type: new TypeReference(lookupObjectTypeIndex(types, "StreamModeDetails")), + flags: ObjectTypePropertyFlags.None, + description: "The mode in which the stream is running."} as ObjectTypeProperty, + "Tags": { + type: new TypeReference(lookupArrayTypeIndex(types, new TypeReference(lookupObjectTypeIndex(types, "Tag")))), + flags: ObjectTypePropertyFlags.None, + description: "An arbitrary set of tags (key–value pairs) to associate with the Kinesis stream."} as ObjectTypeProperty, + }, + additionalProperties: undefined, + sensitive: undefined}); const streamEncryptionType = lookupObjectType(types, "StreamEncryption"); - expect(streamEncryptionType).toStrictEqual(new ObjectType( - "StreamEncryption", - { - "EncryptionType": new ObjectProperty( - new TypeReference(lookupBuiltInTypeIndex(types, BuiltInTypeKind.String)), - ObjectPropertyFlags.Required, - "The encryption type to use. The only valid value is KMS. "), - "KeyId": new ObjectProperty( - new TypeReference(lookupBuiltInTypeIndex(types, BuiltInTypeKind.String)), - ObjectPropertyFlags.Required, - "The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified Amazon Resource Name (ARN) to either an alias or a key, or an alias name prefixed by \"alias/\".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis."), - })); + expect(streamEncryptionType).toStrictEqual({ + type: TypeBaseKind.ObjectType, + name: "StreamEncryption", + properties: { + "EncryptionType": { + type: new TypeReference(lookupStringType(types)), + flags: ObjectTypePropertyFlags.Required, + description: "The encryption type to use. The only valid value is KMS. "}, + "KeyId": { + type: new TypeReference(lookupStringType(types)), + flags: ObjectTypePropertyFlags.Required, + description: "The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified Amazon Resource Name (ARN) to either an alias or a key, or an alias name prefixed by \"alias/\".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis."}, + }, + additionalProperties: undefined, + sensitive: undefined}); const streamModeDetailsType = lookupObjectType(types, "StreamModeDetails"); - expect(streamModeDetailsType).toStrictEqual(new ObjectType( - "StreamModeDetails", - { - "StreamMode": new ObjectProperty( - new TypeReference(lookupBuiltInTypeIndex(types, BuiltInTypeKind.String)), - ObjectPropertyFlags.Required, - "The mode of the stream"), - })); + expect(streamModeDetailsType).toStrictEqual({ + type: TypeBaseKind.ObjectType, + name: "StreamModeDetails", + properties: { + "StreamMode": { + type: new TypeReference(lookupStringType(types)), + flags: ObjectTypePropertyFlags.Required, + description: "The mode of the stream"} as ObjectTypeProperty, + }, + additionalProperties: undefined, + sensitive: undefined}); const tagType = lookupObjectType(types, "Tag"); - expect(tagType).toStrictEqual(new ObjectType( - "Tag", - { - "Key": new ObjectProperty( - new TypeReference(lookupBuiltInTypeIndex(types, BuiltInTypeKind.String)), - ObjectPropertyFlags.Required, - "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."), - "Value": new ObjectProperty( - new TypeReference(lookupBuiltInTypeIndex(types, BuiltInTypeKind.String)), - ObjectPropertyFlags.Required, - "The value for the tag. You can specify a value that is 0 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."), - })); + expect(tagType).toStrictEqual({ + type: TypeBaseKind.ObjectType, + name: "Tag", + properties: { + "Key": { + type: new TypeReference(lookupStringType(types)), + flags: ObjectTypePropertyFlags.Required, + description: "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."} as ObjectTypeProperty, + "Value": { + type: new TypeReference(lookupStringType(types)), + flags: ObjectTypePropertyFlags.Required, + description: "The value for the tag. You can specify a value that is 0 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."} as ObjectTypeProperty, + }, + additionalProperties: undefined, + sensitive: undefined}); }); test('AWS::Redshift::ScheduledAction', () => { @@ -118,95 +139,109 @@ describe('convert', () => { const types = convertSchemaRecordToTypes([schemaRecord]); const resourceType = lookupResourceType(types, "AWS.Redshift/ScheduledAction@default"); - expect(resourceType).toStrictEqual(new ResourceType( - "AWS.Redshift/ScheduledAction@default", - ScopeType.Unknown, - new TypeReference(lookupObjectTypeIndex(types, "AWS.Redshift/ScheduledAction")))); + expect(resourceType).toStrictEqual({ + type: TypeBaseKind.ResourceType, + name: "AWS.Redshift/ScheduledAction@default", + scopeType: ScopeType.Unknown, + readOnlyScopes: undefined, + body: new TypeReference(lookupObjectTypeIndex(types, "AWS.Redshift/ScheduledAction")), + flags: ResourceFlags.None, + functions: undefined, + }); const bodyType = lookupObjectType(types, "AWS.Redshift/ScheduledAction"); - expect(bodyType).toStrictEqual(new ObjectType( - "AWS.Redshift/ScheduledAction", - { - "name": new ObjectProperty( - new TypeReference(lookupBuiltInTypeIndex(types, BuiltInTypeKind.String)), - ObjectPropertyFlags.None, - "the resource name"), - - "alias": new ObjectProperty( - new TypeReference(lookupBuiltInTypeIndex(types, BuiltInTypeKind.String)), - ObjectPropertyFlags.Required, - "the resource alias"), - - "properties": new ObjectProperty( - new TypeReference(lookupObjectTypeIndex(types, "AWS.Redshift/ScheduledActionProperties")), - ObjectPropertyFlags.Required, - "properties of the resource") - })); + expect(bodyType).toStrictEqual({ + type: TypeBaseKind.ObjectType, + name: "AWS.Redshift/ScheduledAction", + properties: { + "name": { + type: new TypeReference(lookupStringType(types)), + flags: ObjectTypePropertyFlags.None, + description: "the resource name"} as ObjectTypeProperty, + + "alias": { + type: new TypeReference(lookupStringType(types)), + flags: ObjectTypePropertyFlags.Required | ObjectTypePropertyFlags.Identifier, + description: "the resource alias"} as ObjectTypeProperty, + + "properties": { + type: new TypeReference(lookupObjectTypeIndex(types, "AWS.Redshift/ScheduledActionProperties")), + flags: ObjectTypePropertyFlags.Required | ObjectTypePropertyFlags.Identifier, + description: "properties of the resource"} as ObjectTypeProperty + }, + additionalProperties: undefined, + sensitive: undefined}); const propertiesType = lookupObjectType(types, "AWS.Redshift/ScheduledActionProperties"); - - expect(propertiesType).toStrictEqual(new ObjectType( - "AWS.Redshift/ScheduledActionProperties", - { - "Enable": new ObjectProperty( - new TypeReference(lookupBuiltInTypeIndex(types, BuiltInTypeKind.Bool)), - ObjectPropertyFlags.None, - "If true, the schedule is enabled. If false, the scheduled action does not trigger."), - "EndTime": new ObjectProperty( - new TypeReference(lookupBuiltInTypeIndex(types, BuiltInTypeKind.String)), - ObjectPropertyFlags.None, - "The end time in UTC of the scheduled action. After this time, the scheduled action does not trigger."), - "IamRole": new ObjectProperty( - new TypeReference(lookupBuiltInTypeIndex(types, BuiltInTypeKind.String)), - ObjectPropertyFlags.None, - "The IAM role to assume to run the target action."), - "NextInvocations": new ObjectProperty( - new TypeReference(lookupArrayTypeIndex(types, new TypeReference(lookupBuiltInTypeIndex(types, BuiltInTypeKind.String)))), - ObjectPropertyFlags.ReadOnly, - "List of times when the scheduled action will run."), - "Schedule": new ObjectProperty( - new TypeReference(lookupBuiltInTypeIndex(types, BuiltInTypeKind.String)), - ObjectPropertyFlags.None, - "The schedule in `at( )` or `cron( )` format."), - "ScheduledActionDescription": new ObjectProperty( - new TypeReference(lookupBuiltInTypeIndex(types, BuiltInTypeKind.String)), - ObjectPropertyFlags.None, - "The description of the scheduled action."), - "ScheduledActionName": new ObjectProperty( - new TypeReference(lookupBuiltInTypeIndex(types, BuiltInTypeKind.String)), - ObjectPropertyFlags.Required | ObjectPropertyFlags.Identifier, - "The name of the scheduled action. The name must be unique within an account."), - "StartTime": new ObjectProperty( - new TypeReference(lookupBuiltInTypeIndex(types, BuiltInTypeKind.String)), - ObjectPropertyFlags.None, - "The start time in UTC of the scheduled action. Before this time, the scheduled action does not trigger."), - "State": new ObjectProperty( - new TypeReference(lookupBuiltInTypeIndex(types, BuiltInTypeKind.String)), - ObjectPropertyFlags.ReadOnly, - "The state of the scheduled action."), - "TargetAction": new ObjectProperty( - new TypeReference(lookupObjectTypeIndex(types, "ScheduledActionType")), - ObjectPropertyFlags.None, - "A JSON format string of the Amazon Redshift API operation with input parameters."), - })); + expect(propertiesType).toStrictEqual({ + type: TypeBaseKind.ObjectType, + name: "AWS.Redshift/ScheduledActionProperties", + properties: { + "Enable": { + type: new TypeReference(lookupBooleanTypeIndex(types)), + flags: ObjectTypePropertyFlags.None, + description: "If true, the schedule is enabled. If false, the scheduled action does not trigger."} as ObjectTypeProperty, + "EndTime": { + type: new TypeReference(lookupStringType(types)), + flags: ObjectTypePropertyFlags.None, + description: "The end time in UTC of the scheduled action. After this time, the scheduled action does not trigger."} as ObjectTypeProperty, + "IamRole": { + type: new TypeReference(lookupStringType(types)), + flags: ObjectTypePropertyFlags.None, + description: "The IAM role to assume to run the target action."} as ObjectTypeProperty, + "NextInvocations": { + type: new TypeReference(lookupArrayTypeIndex(types, new TypeReference(lookupStringType(types)))), + flags: ObjectTypePropertyFlags.ReadOnly, + description: "List of times when the scheduled action will run."} as ObjectTypeProperty, + "Schedule": { + type: new TypeReference(lookupStringType(types)), + flags: ObjectTypePropertyFlags.None, + description: "The schedule in `at( )` or `cron( )` format."} as ObjectTypeProperty, + "ScheduledActionDescription":{ + type: new TypeReference(lookupStringType(types)), + flags: ObjectTypePropertyFlags.None, + description: "The description of the scheduled action."} as ObjectTypeProperty, + "ScheduledActionName": { + type: new TypeReference(lookupStringType(types)), + flags: ObjectTypePropertyFlags.Required | ObjectTypePropertyFlags.Identifier, + description: "The name of the scheduled action. The name must be unique within an account."} as ObjectTypeProperty, + "StartTime": { + type: new TypeReference(lookupStringType(types)), + flags: ObjectTypePropertyFlags.None, + description: "The start time in UTC of the scheduled action. Before this time, the scheduled action does not trigger."} as ObjectTypeProperty, + "State": { + type: new TypeReference(lookupStringType(types)), + flags: ObjectTypePropertyFlags.ReadOnly, + description: "The state of the scheduled action."} as ObjectTypeProperty, + "TargetAction": { + type: new TypeReference(lookupObjectTypeIndex(types, "ScheduledActionType")), + flags: ObjectTypePropertyFlags.None, + description: "A JSON format string of the Amazon Redshift API operation with input parameters."} as ObjectTypeProperty, + }, + additionalProperties: undefined, + sensitive: undefined}); const scheduledActionType = lookupObjectType(types, "ScheduledActionType"); - expect(scheduledActionType).toStrictEqual(new ObjectType( - "ScheduledActionType", - { - "ResizeCluster": new ObjectProperty( - new TypeReference(lookupObjectTypeIndex(types, "ResizeClusterMessage")), - ObjectPropertyFlags.None, - undefined), - "PauseCluster": new ObjectProperty( - new TypeReference(lookupObjectTypeIndex(types, "PauseClusterMessage")), - ObjectPropertyFlags.None, - undefined), - "ResumeCluster": new ObjectProperty( - new TypeReference(lookupObjectTypeIndex(types, "ResumeClusterMessage")), - ObjectPropertyFlags.None, - undefined), - })); + expect(scheduledActionType).toStrictEqual({ + type: TypeBaseKind.ObjectType, + name: "ScheduledActionType", + properties: { + "ResizeCluster": { + type: new TypeReference(lookupObjectTypeIndex(types, "ResizeClusterMessage")), + flags: ObjectTypePropertyFlags.None, + description: undefined} as ObjectTypeProperty, + "PauseCluster": { + type: new TypeReference(lookupObjectTypeIndex(types, "PauseClusterMessage")), + flags: ObjectTypePropertyFlags.None, + description: undefined} as ObjectTypeProperty, + "ResumeCluster": { + type: new TypeReference(lookupObjectTypeIndex(types, "ResumeClusterMessage")), + flags: ObjectTypePropertyFlags.None, + description: undefined} as ObjectTypeProperty, + }, + additionalProperties: undefined, + sensitive: undefined + }); }); test('AWS::Evidently::Experiment', () => { @@ -216,111 +251,128 @@ describe('convert', () => { const types = convertSchemaRecordToTypes([schemaRecord]); const resourceType = lookupResourceType(types, "AWS.Evidently/Experiment@default"); - expect(resourceType).toStrictEqual(new ResourceType( - "AWS.Evidently/Experiment@default", - ScopeType.Unknown, - new TypeReference(lookupObjectTypeIndex(types, "AWS.Evidently/Experiment")))); + expect(resourceType).toStrictEqual({ + type: TypeBaseKind.ResourceType, + name: "AWS.Evidently/Experiment@default", + scopeType: ScopeType.Unknown, + readOnlyScopes: undefined, + body: new TypeReference(lookupObjectTypeIndex(types, "AWS.Evidently/Experiment")), + flags: ResourceFlags.None, + functions: undefined, + }); const bodyType = lookupObjectType(types, "AWS.Evidently/Experiment"); - expect(bodyType).toStrictEqual(new ObjectType( - "AWS.Evidently/Experiment", - { - "name": new ObjectProperty( - new TypeReference(lookupBuiltInTypeIndex(types, BuiltInTypeKind.String)), - ObjectPropertyFlags.None, - "the resource name"), - - "alias": new ObjectProperty( - new TypeReference(lookupBuiltInTypeIndex(types, BuiltInTypeKind.String)), - ObjectPropertyFlags.Required, - "the resource alias"), - - "properties": new ObjectProperty( - new TypeReference(lookupObjectTypeIndex(types, "AWS.Evidently/ExperimentProperties")), - ObjectPropertyFlags.Required, - "properties of the resource") - })); + expect(bodyType).toStrictEqual({ + type: TypeBaseKind.ObjectType, + name: "AWS.Evidently/Experiment", + properties: { + "name": { + type: new TypeReference(lookupStringType(types)), + flags: ObjectTypePropertyFlags.None, + description: "the resource name"} as ObjectTypeProperty, + + "alias": { + type: new TypeReference(lookupStringType(types)), + flags: ObjectTypePropertyFlags.Required | ObjectTypePropertyFlags.Identifier, + description: "the resource alias"} as ObjectTypeProperty, + + "properties": { + type: new TypeReference(lookupObjectTypeIndex(types, "AWS.Evidently/ExperimentProperties")), + flags: ObjectTypePropertyFlags.Required | ObjectTypePropertyFlags.Identifier, + description: "properties of the resource"} as ObjectTypeProperty + }, + additionalProperties: undefined, + sensitive: undefined, + }); const propertiesType = lookupObjectType(types, "AWS.Evidently/ExperimentProperties"); - expect(propertiesType).toStrictEqual(new ObjectType( - "AWS.Evidently/ExperimentProperties", - { - "Arn": new ObjectProperty( - new TypeReference(lookupBuiltInTypeIndex(types, BuiltInTypeKind.String)), - ObjectPropertyFlags.ReadOnly | ObjectPropertyFlags.Identifier, - undefined), - "Description": new ObjectProperty( - new TypeReference(lookupBuiltInTypeIndex(types, BuiltInTypeKind.String)), - ObjectPropertyFlags.None, - undefined), - "MetricGoals": new ObjectProperty( - new TypeReference(lookupArrayTypeIndex(types, new TypeReference(lookupObjectTypeIndex(types, "MetricGoalObject")))), - ObjectPropertyFlags.Required, - undefined), - "Name": new ObjectProperty( - new TypeReference(lookupBuiltInTypeIndex(types, BuiltInTypeKind.String)), - ObjectPropertyFlags.Required, - undefined), - "OnlineAbConfig": new ObjectProperty( - new TypeReference(lookupObjectTypeIndex(types, "OnlineAbConfigObject")), - ObjectPropertyFlags.Required, - undefined), - "Project": new ObjectProperty( - new TypeReference(lookupBuiltInTypeIndex(types, BuiltInTypeKind.String)), - ObjectPropertyFlags.Required, - undefined), - "RandomizationSalt": new ObjectProperty( - new TypeReference(lookupBuiltInTypeIndex(types, BuiltInTypeKind.String)), - ObjectPropertyFlags.None, - undefined), - "RemoveSegment": new ObjectProperty( - new TypeReference(lookupBuiltInTypeIndex(types, BuiltInTypeKind.Bool)), - ObjectPropertyFlags.None, - undefined), - "RunningStatus": new ObjectProperty( - new TypeReference(lookupObjectTypeIndex(types, "RunningStatusObject")), - ObjectPropertyFlags.None, - "Start Experiment. Default is False"), - "SamplingRate": new ObjectProperty( - new TypeReference(lookupBuiltInTypeIndex(types, BuiltInTypeKind.Int)), - ObjectPropertyFlags.None, - undefined), - "Segment": new ObjectProperty( - new TypeReference(lookupBuiltInTypeIndex(types, BuiltInTypeKind.String)), - ObjectPropertyFlags.None, - undefined), - "Tags": new ObjectProperty( - new TypeReference(lookupArrayTypeIndex(types, new TypeReference(lookupObjectTypeIndex(types, "Tag")))), - ObjectPropertyFlags.None, - "An array of key-value pairs to apply to this resource."), - "Treatments": new ObjectProperty( - new TypeReference(lookupArrayTypeIndex(types, new TypeReference(lookupObjectTypeIndex(types, "TreatmentObject")))), - ObjectPropertyFlags.Required, - undefined), - })); + expect(propertiesType).toStrictEqual({ + type: TypeBaseKind.ObjectType, + name: "AWS.Evidently/ExperimentProperties", + properties: { + "Arn": { + type: new TypeReference(lookupStringType(types)), + flags: ObjectTypePropertyFlags.ReadOnly | ObjectTypePropertyFlags.Identifier, + description: undefined} as ObjectTypeProperty, + "Description": { + type: new TypeReference(lookupStringType(types)), + flags: ObjectTypePropertyFlags.None, + description: undefined} as ObjectTypeProperty, + "MetricGoals": { + type: new TypeReference(lookupArrayTypeIndex(types, new TypeReference(lookupObjectTypeIndex(types, "MetricGoalObject")))), + flags: ObjectTypePropertyFlags.Required, + description: undefined} as ObjectTypeProperty, + "Name": { + type: new TypeReference(lookupStringType(types)), + flags: ObjectTypePropertyFlags.Required, + description: undefined} as ObjectTypeProperty, + "OnlineAbConfig": { + type: new TypeReference(lookupObjectTypeIndex(types, "OnlineAbConfigObject")), + flags: ObjectTypePropertyFlags.Required, + description: undefined} as ObjectTypeProperty, + "Project": { + type: new TypeReference(lookupStringType(types)), + flags: ObjectTypePropertyFlags.Required, + description: undefined} as ObjectTypeProperty, + "RandomizationSalt": { + type: new TypeReference(lookupStringType(types)), + flags: ObjectTypePropertyFlags.None, + description: undefined} as ObjectTypeProperty, + "RemoveSegment": { + type: new TypeReference(lookupBooleanTypeIndex(types)), + flags: ObjectTypePropertyFlags.None, + description: undefined} as ObjectTypeProperty, + "RunningStatus": { + type: new TypeReference(lookupObjectTypeIndex(types, "RunningStatusObject")), + flags: ObjectTypePropertyFlags.None, + description: "Start Experiment. Default is False"} as ObjectTypeProperty, + "SamplingRate": { + type: new TypeReference(lookupIntegerTypeIndex(types)), + flags: ObjectTypePropertyFlags.None, + description: undefined} as ObjectTypeProperty, + "Segment": { + type: new TypeReference(lookupStringType(types)), + flags: ObjectTypePropertyFlags.None, + description: undefined} as ObjectTypeProperty, + "Tags": { + type: new TypeReference(lookupArrayTypeIndex(types, new TypeReference(lookupObjectTypeIndex(types, "Tag")))), + flags: ObjectTypePropertyFlags.None, + description: "An array of key-value pairs to apply to this resource."} as ObjectTypeProperty, + "Treatments": { + type: new TypeReference(lookupArrayTypeIndex(types, new TypeReference(lookupObjectTypeIndex(types, "TreatmentObject")))), + flags: ObjectTypePropertyFlags.Required, + description: undefined} as ObjectTypeProperty, + }, + additionalProperties: undefined, + sensitive: undefined + }); const runningStatusObject = lookupObjectType(types, "RunningStatusObject"); - expect(runningStatusObject).toStrictEqual(new ObjectType( - "RunningStatusObject", - { - "Status": new ObjectProperty( - new TypeReference(lookupBuiltInTypeIndex(types, BuiltInTypeKind.String)), - ObjectPropertyFlags.Required, - "Provide START or STOP action to apply on an experiment"), - "AnalysisCompleteTime": new ObjectProperty( - new TypeReference(lookupBuiltInTypeIndex(types, BuiltInTypeKind.String)), - ObjectPropertyFlags.None, - "Provide the analysis Completion time for an experiment"), - "Reason": new ObjectProperty( - new TypeReference(lookupBuiltInTypeIndex(types, BuiltInTypeKind.String)), - ObjectPropertyFlags.None, - "Reason is a required input for stopping the experiment"), - "DesiredState": new ObjectProperty( - new TypeReference(lookupBuiltInTypeIndex(types, BuiltInTypeKind.String)), - ObjectPropertyFlags.None, - "Provide CANCELLED or COMPLETED desired state when stopping an experiment"), - })); + expect(runningStatusObject).toStrictEqual({ + type: TypeBaseKind.ObjectType, + name: "RunningStatusObject", + properties: { + "Status": { + type: new TypeReference(lookupStringType(types)), + flags: ObjectTypePropertyFlags.Required, + description: "Provide START or STOP action to apply on an experiment"} as ObjectTypeProperty, + "AnalysisCompleteTime": { + type: new TypeReference(lookupStringType(types)), + flags: ObjectTypePropertyFlags.None, + description: "Provide the analysis Completion time for an experiment"} as ObjectTypeProperty, + "Reason": { + type: new TypeReference(lookupStringType(types)), + flags: ObjectTypePropertyFlags.None, + description: "Reason is a required input for stopping the experiment"} as ObjectTypeProperty, + "DesiredState": { + type: new TypeReference(lookupStringType(types)), + flags: ObjectTypePropertyFlags.None, + description: "Provide CANCELLED or COMPLETED desired state when stopping an experiment"} as ObjectTypeProperty, + }, + additionalProperties: undefined, + sensitive: undefined + }); }); test('AWS::Route53RecoveryControl::SafetyRule', () => { @@ -330,69 +382,82 @@ describe('convert', () => { const types = convertSchemaRecordToTypes([schemaRecord]); const resourceType = lookupResourceType(types, "AWS.Route53RecoveryControl/SafetyRule@default"); - expect(resourceType).toStrictEqual(new ResourceType( - "AWS.Route53RecoveryControl/SafetyRule@default", - ScopeType.Unknown, - new TypeReference(lookupObjectTypeIndex(types, "AWS.Route53RecoveryControl/SafetyRule")))); + expect(resourceType).toStrictEqual({ + type: TypeBaseKind.ResourceType, + name: "AWS.Route53RecoveryControl/SafetyRule@default", + scopeType: ScopeType.Unknown, + readOnlyScopes: undefined, + body: new TypeReference(lookupObjectTypeIndex(types, "AWS.Route53RecoveryControl/SafetyRule")), + flags: ResourceFlags.None, + functions: undefined, + }); const bodyType = lookupObjectType(types, "AWS.Route53RecoveryControl/SafetyRule"); - expect(bodyType).toStrictEqual(new ObjectType( - "AWS.Route53RecoveryControl/SafetyRule", - { - "name": new ObjectProperty( - new TypeReference(lookupBuiltInTypeIndex(types, BuiltInTypeKind.String)), - ObjectPropertyFlags.None, - "the resource name"), - - "alias": new ObjectProperty( - new TypeReference(lookupBuiltInTypeIndex(types, BuiltInTypeKind.String)), - ObjectPropertyFlags.Required, - "the resource alias"), - - "properties": new ObjectProperty( - new TypeReference(lookupObjectTypeIndex(types, "AWS.Route53RecoveryControl/SafetyRuleProperties")), - ObjectPropertyFlags.Required, - "properties of the resource") - })); + expect(bodyType).toStrictEqual({ + type: TypeBaseKind.ObjectType, + name: "AWS.Route53RecoveryControl/SafetyRule", + properties: { + "name": { + type: new TypeReference(lookupStringType(types)), + flags: ObjectTypePropertyFlags.None, + description: "the resource name"} as ObjectTypeProperty, + + "alias": { + type: new TypeReference(lookupStringType(types)), + flags: ObjectTypePropertyFlags.Required | ObjectTypePropertyFlags.Identifier, + description: "the resource alias"} as ObjectTypeProperty, + + "properties": { + type: new TypeReference(lookupObjectTypeIndex(types, "AWS.Route53RecoveryControl/SafetyRuleProperties")), + flags: ObjectTypePropertyFlags.Required | ObjectTypePropertyFlags.Identifier, + description: "properties of the resource"} as ObjectTypeProperty + }, + additionalProperties: undefined, + sensitive: undefined, + }); const propertiesType = lookupObjectType(types, "AWS.Route53RecoveryControl/SafetyRuleProperties"); - expect(propertiesType).toStrictEqual(new ObjectType( - "AWS.Route53RecoveryControl/SafetyRuleProperties", - { - "AssertionRule": new ObjectProperty( - new TypeReference(lookupObjectTypeIndex(types, "AssertionRule")), - ObjectPropertyFlags.None, - undefined), - "ControlPanelArn": new ObjectProperty( - new TypeReference(lookupBuiltInTypeIndex(types, BuiltInTypeKind.String)), - ObjectPropertyFlags.Required, - "The Amazon Resource Name (ARN) of the control panel."), - "GatingRule": new ObjectProperty( - new TypeReference(lookupObjectTypeIndex(types, "GatingRule")), - ObjectPropertyFlags.None, - undefined), - "Name": new ObjectProperty( - new TypeReference(lookupBuiltInTypeIndex(types, BuiltInTypeKind.String)), - ObjectPropertyFlags.Required, - undefined), - "RuleConfig": new ObjectProperty( - new TypeReference(lookupObjectTypeIndex(types, "RuleConfig")), - ObjectPropertyFlags.Required, - undefined), - "SafetyRuleArn": new ObjectProperty( - new TypeReference(lookupBuiltInTypeIndex(types, BuiltInTypeKind.String)), - ObjectPropertyFlags.ReadOnly | ObjectPropertyFlags.Identifier, - "The Amazon Resource Name (ARN) of the safety rule."), - "Status": new ObjectProperty( - new TypeReference(lookupBuiltInTypeIndex(types, BuiltInTypeKind.String)), - ObjectPropertyFlags.ReadOnly, - "The deployment status of the routing control. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION."), - "Tags": new ObjectProperty( - new TypeReference(lookupArrayTypeIndex(types, new TypeReference(lookupObjectTypeIndex(types, "Tag")))), - ObjectPropertyFlags.WriteOnly, - "A collection of tags associated with a resource"), - })); + expect(propertiesType).toStrictEqual({ + type: TypeBaseKind.ObjectType, + name: "AWS.Route53RecoveryControl/SafetyRuleProperties", + properties: { + "AssertionRule": { + type: new TypeReference(lookupObjectTypeIndex(types, "AssertionRule")), + flags: ObjectTypePropertyFlags.None, + description: undefined} as ObjectTypeProperty, + "ControlPanelArn":{ + type: new TypeReference(lookupStringType(types)), + flags: ObjectTypePropertyFlags.Required, + description: "The Amazon Resource Name (ARN) of the control panel."} as ObjectTypeProperty, + "GatingRule": { + type: new TypeReference(lookupObjectTypeIndex(types, "GatingRule")), + flags: ObjectTypePropertyFlags.None, + description: undefined} as ObjectTypeProperty, + "Name": { + type: new TypeReference(lookupStringType(types)), + flags: ObjectTypePropertyFlags.Required, + description: undefined} as ObjectTypeProperty, + "RuleConfig": { + type: new TypeReference(lookupObjectTypeIndex(types, "RuleConfig")), + flags: ObjectTypePropertyFlags.Required, + description: undefined} as ObjectTypeProperty, + "SafetyRuleArn": { + type: new TypeReference(lookupStringType(types)), + flags: ObjectTypePropertyFlags.ReadOnly | ObjectTypePropertyFlags.Identifier, + description: "The Amazon Resource Name (ARN) of the safety rule."} as ObjectTypeProperty, + "Status": { + type: new TypeReference(lookupStringType(types)), + flags: ObjectTypePropertyFlags.ReadOnly, + description: "The deployment status of the routing control. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION."} as ObjectTypeProperty, + "Tags": { + type: new TypeReference(lookupArrayTypeIndex(types, new TypeReference(lookupObjectTypeIndex(types, "Tag")))), + flags: ObjectTypePropertyFlags.WriteOnly, + description: "A collection of tags associated with a resource"} as ObjectTypeProperty, + }, + additionalProperties: undefined, + sensitive: undefined + }); }); test('Regression for radius-project/radius#3688', () => { @@ -403,9 +468,9 @@ describe('convert', () => { const propertiesType = lookupObjectType(types, "AWS.MemoryDB/ACLProperties"); expect(propertiesType).not.toBeUndefined(); - const aclNameProperty = propertiesType?.Properties["ACLName"] + const aclNameProperty = propertiesType?.properties["ACLName"] expect(aclNameProperty).not.toBeUndefined(); - expect(aclNameProperty?.Flags).toEqual(ObjectPropertyFlags.Required|ObjectPropertyFlags.Identifier); + expect(aclNameProperty?.flags).toEqual(ObjectTypePropertyFlags.Required|ObjectTypePropertyFlags.Identifier); }); test('Can convert string definitions properly (radius-project/radius#4823)', () => { @@ -420,30 +485,38 @@ describe('convert', () => { // is of type 'AwsAccount', which is a string with some special // regex constraints. Here we assert that the type generator // converts this to a string type instead. - const accountProperty = propertiesType?.Properties["Account"] + const accountProperty = propertiesType?.properties["Account"] expect(accountProperty).not.toBeUndefined(); - const accountPropertyType = accountProperty?.Type - const stringPropertyType = new TypeReference(lookupBuiltInTypeIndex(types, BuiltInTypeKind.String)); + const accountPropertyType = accountProperty?.type + const stringPropertyType = new TypeReference(lookupStringType(types)); expect(accountPropertyType).toStrictEqual(stringPropertyType) }); }); -function lookupBuiltInTypeIndex(types: TypeBase[], kind: BuiltInTypeKind): number { - return types.findIndex(t => t instanceof BuiltInType && (t as BuiltInType).Kind === kind); +function lookupObjectType(types: BicepType[], name: string): ObjectType | undefined { + return types.find(t => (t as ObjectType).type === TypeBaseKind.ObjectType && (t as ObjectType).name === name) as ObjectType; +} + +function lookupStringType(types: BicepType[]): number { + return types.findIndex(t => (t as StringType).type === TypeBaseKind.StringType); +} + +function lookupObjectTypeIndex(types: BicepType[], name: string): number { + return types.findIndex(t => (t as ObjectType).type === TypeBaseKind.ObjectType && (t as ObjectType).name === name); } -function lookupObjectType(types: TypeBase[], name: string): ObjectType | undefined { - return types.find(t => t instanceof ObjectType && t.Name === name) as ObjectType; +function lookupArrayTypeIndex(types: BicepType[], itemType: TypeReference): number { + return types.findIndex(t => (t as ArrayType).type === TypeBaseKind.ArrayType && (t as ArrayType).itemType.index === itemType.index); } -function lookupObjectTypeIndex(types: TypeBase[], name: string): number { - return types.findIndex(t => t instanceof ObjectType && t.Name === name); +function lookupIntegerTypeIndex(types: BicepType[]): number { + return types.findIndex(t => (t as IntegerType).type === TypeBaseKind.IntegerType); } -function lookupArrayTypeIndex(types: TypeBase[], itemType: TypeReference): number { - return types.findIndex(t => t instanceof ArrayType && (t as ArrayType).ItemType.Index === itemType.Index); +function lookupBooleanTypeIndex(types: BicepType[]): number { + return types.findIndex(t => (t as BooleanType).type === TypeBaseKind.BooleanType); } -function lookupResourceType(types: TypeBase[], name: string): ResourceType | undefined { - return types.find(t => t instanceof ResourceType && t.Name === name) as ResourceType; +function lookupResourceType(types: BicepType[], name: string): ResourceType | undefined { + return types.find(t => (t as ResourceType).type === TypeBaseKind.ResourceType && (t as ResourceType).name === name) as ResourceType; } diff --git a/src/aws-type-generator/src/convert.ts b/src/aws-type-generator/src/convert.ts index 53c40191..acbac50c 100644 --- a/src/aws-type-generator/src/convert.ts +++ b/src/aws-type-generator/src/convert.ts @@ -1,16 +1,15 @@ -import { Dictionary, property } from "lodash"; +import { Dictionary } from "lodash"; import { boolean } from "yargs"; import { Context, SchemaDefinition, SchemaRecord } from "./schemarecord"; -import { ArrayType, BuiltInType, BuiltInTypeKind, DiscriminatedObjectType, ObjectProperty, ObjectPropertyFlags, ObjectType, ResourceType, ScopeType, TypeBase, TypeFactory, TypeReference, UnionType } from "./lib/types"; -import { type } from "os"; -import { json } from "stream/consumers"; +import { TypeBaseKind, TypeFactory, ObjectTypeProperty, ObjectTypePropertyFlags, ObjectType, ResourceType, ScopeType, BicepType, TypeReference, ResourceFlags } from "bicep-types"; -export function convertSchemaRecordToTypes(records: SchemaRecord[]): TypeBase[] { +export function convertSchemaRecordToTypes(records: SchemaRecord[]): BicepType[] { const factory = new TypeFactory() records.forEach(record => { visitSchemaRecord(factory, record) }) - return factory.getTypes() + + return factory.types } function visitSchemaRecord(factory: TypeFactory, record: SchemaRecord): ResourceType { @@ -18,11 +17,11 @@ function visitSchemaRecord(factory: TypeFactory, record: SchemaRecord): Resource parts.splice(0, 2, `${parts[0]}.${parts[1]}`) const typeName = parts.join("/") - const context = new Context(parts.slice(1)) + const context = new Context(parts.slice(1), {}) visitDefinitions(context, factory, record) - factory.declareType(`${typeName}Properties`) + factory.addStringLiteralType(`${typeName}Properties`) const properties = visitSchema(context, factory, record, `${typeName}Properties`, record.schema) // Because createOnlyProperties and readOnlyProperties can be nested, we need to traverse the type @@ -32,25 +31,28 @@ function visitSchemaRecord(factory: TypeFactory, record: SchemaRecord): Resource const parts = p.split('/').filter(s => s.length > 0) parts.shift() - let property: ObjectProperty | undefined + let property: ObjectTypeProperty | undefined let current = factory.lookupType(properties) as ObjectType parts.forEach(part => { - if (!current.Properties) { - console.warn(`could not resolve property ${p}`) - return + if (current.type !== TypeBaseKind.ObjectType) { + return; + } + if (!current.properties) { + console.warn(`could not resolve property ${p}`); + return; } - property = current.Properties[part] + property = current.properties[part]; if (!property) { - console.warn(`could not resolve property ${p}`) - return + console.warn(`could not resolve property ${p}`); + return; } - current = factory.lookupType(property.Type) as ObjectType + current = factory.lookupType(property.type) as ObjectType; }) if (property) { - property.Flags |= ObjectPropertyFlags.ReadOnly + property.flags |= ObjectTypePropertyFlags.ReadOnly } }) } @@ -59,25 +61,28 @@ function visitSchemaRecord(factory: TypeFactory, record: SchemaRecord): Resource const parts = p.split('/').filter(s => s.length > 0) parts.shift() - let property: ObjectProperty | undefined + let property: ObjectTypeProperty | undefined let current = factory.lookupType(properties) as ObjectType parts.forEach(part => { - if (!current.Properties) { + if (current.type !== TypeBaseKind.ObjectType) { + return; + } + if (!current.properties) { console.warn(`could not resolve property ${p}`) return } - property = current.Properties[part] + property = current.properties[part] if (!property) { console.warn(`could not resolve property ${p}`) return } - current = factory.lookupType(property.Type) as ObjectType + current = factory.lookupType(property.type) as ObjectType }) if (property) { - property.Flags |= ObjectPropertyFlags.WriteOnly + property.flags |= ObjectTypePropertyFlags.WriteOnly } }) } @@ -88,27 +93,27 @@ function visitSchemaRecord(factory: TypeFactory, record: SchemaRecord): Resource } // properties is required if anything inside it is required - let propertiesFlags = ObjectPropertyFlags.None - const propertiesType = factory.lookupType(properties) - Object.entries(propertiesType.Properties).forEach(([name, property]) => { - if ((property.Flags & ObjectPropertyFlags.Required) != 0) { - propertiesFlags |= ObjectPropertyFlags.Required - } + let propertiesFlags = ObjectTypePropertyFlags.None + const propertiesType = factory.lookupType(properties) as ObjectType + Object.entries(propertiesType).forEach(([name, property]) => { + Object.entries(propertiesType.properties).forEach(([_, property]) => { + if ((property.flags & ObjectTypePropertyFlags.Required) != 0) { + propertiesFlags |= ObjectTypePropertyFlags.Required + } + }); }) - const body = factory.addType(new ObjectType( + const body = factory.addObjectType( typeName, { - name: new ObjectProperty(factory.lookupBuiltInType(BuiltInTypeKind.String), ObjectPropertyFlags.None, "the resource name"), - alias: new ObjectProperty(factory.lookupBuiltInType(BuiltInTypeKind.String), ObjectPropertyFlags.Required, "the resource alias"), - properties: new ObjectProperty(properties, propertiesFlags, "properties of the resource") + name: {type: factory.addStringType(), flags: ObjectTypePropertyFlags.None, description: "the resource name"}, + alias: {type: factory.addStringType(), flags: ObjectTypePropertyFlags.Required | ObjectTypePropertyFlags.Identifier, description: "the resource alias"}, + properties: {type: properties, flags: propertiesFlags | ObjectTypePropertyFlags.Identifier, description: "properties of the resource"} as ObjectTypeProperty }, - undefined)) + undefined) - const resourceType = new ResourceType(`${typeName}@default`, ScopeType.Unknown, body) - factory.addType(resourceType) - - return resourceType + factory.addResourceType(`${typeName}@default`, ScopeType.Unknown, undefined, body, ResourceFlags.None) + return {type: TypeBaseKind.ResourceType, name: `${typeName}@default`, scopeType: ScopeType.Unknown, readOnlyScopes: undefined, body: body, flags: ResourceFlags.None} } function convertOneOfPropertiesToUnion(context: Context, factory: TypeFactory, record: SchemaRecord, properties: TypeReference, typeName: string, oneofInDefinitions: boolean) { @@ -142,19 +147,22 @@ function convertOneOfPropertiesToUnion(context: Context, factory: TypeFactory, r // Lookup each property in the intersection and if it is, mark it as required // Else clear the required flag on the property for (const [_, key] of oneOfObj.required.entries()) { - let property: ObjectProperty | undefined + let property: ObjectTypeProperty | undefined let current = factory.lookupType(properties) as ObjectType - property = current.Properties[key] + if (current.properties != undefined) { + property = current.properties[key] + } // Mark all other properties as not required if (property) { if (intersection.includes(key)) { - property.Flags |= ObjectPropertyFlags.Required; + property.flags |= ObjectTypePropertyFlags.Required; } else { - property.Flags &= ~ObjectPropertyFlags.Required; + property.flags &= ~ObjectTypePropertyFlags.Required; } } } } else { + // TODO: check cases for "allOf" and "anyOf" console.error("Found a new case of oneOf which is not handled!!") } } @@ -175,9 +183,10 @@ function visitDefinitions(context: Context, factory: TypeFactory, record: Schema return } - Object.entries(record.schema.definitions).forEach(([name, _]) => { + Object.entries(record.schema.definitions).forEach(([name]) => { // Predeclare types so we can support circular references - factory.declareType(name) + const reference = factory.addObjectType(name, {}) + context.definitions[name] = {index: reference.index, TypeReference: reference} }) Object.entries(record.schema.definitions).forEach(([name, schema]) => { @@ -191,9 +200,9 @@ function visitDefinitions(context: Context, factory: TypeFactory, record: Schema // Merge all oneOf properties into the schema and move it one level up for (const oneOfObj of schema.oneOf) { if (oneOfObj.required) { - let typeName = factory.getNamedType(name) + let typeName = context.definitions[name] if (typeName) { - convertOneOfPropertiesToUnion(context, factory, record, typeName, name, true) + convertOneOfPropertiesToUnion(context, factory, record, typeName.TypeReference, name, true) } break } @@ -233,12 +242,11 @@ function visitSchema(context: Context, factory: TypeFactory, record: SchemaRecor if (!schema.additionalProperties && !schema.items && !schema.properties && !schema.required && !schema.type) { // Object type is already defined if (definition.type === 'object') { - const reference = factory.getNamedType(parts[0]) - if (!reference) { + const existing = context.definitions[parts[0]] + if (!existing) { throw new Error(`type ${parts[0]} is missing`) } - - return reference + return existing.TypeReference } } @@ -266,50 +274,62 @@ function visitSchema(context: Context, factory: TypeFactory, record: SchemaRecor const createType = function (type: string): TypeReference { if (type === 'boolean') { - return factory.lookupBuiltInType(BuiltInTypeKind.Bool) + return factory.addBooleanType() } else if (type === 'number' || type === 'integer') { - return factory.lookupBuiltInType(BuiltInTypeKind.Int) + return factory.addIntegerType() } else if (type === 'string') { - return factory.lookupBuiltInType(BuiltInTypeKind.String) + return factory.addStringType() } else if (type === 'null') { - return factory.lookupBuiltInType(BuiltInTypeKind.Null) + return factory.addNullType() } else if (type === 'array') { if (schema.items) { const itemType = visitSchema(context, factory, record, undefined, schema.items) - return factory.addType(new ArrayType(itemType)) + return factory.addArrayType(itemType) } - return factory.addType(new ArrayType(factory.lookupBuiltInType(BuiltInTypeKind.Any))) + return factory.addArrayType(factory.addAnyType()) } else if (type === 'object') { - const properties: Dictionary = {} + const properties: Dictionary = {} if (schema.properties) { Object.entries(schema.properties).forEach(([name, propertySchema], _) => { const type = visitSchema(context.push(name), factory, record, undefined, propertySchema) - let flags = ObjectPropertyFlags.None + let flags = ObjectTypePropertyFlags.None if (schema.required && schema.required.includes(name)) { - flags |= ObjectPropertyFlags.Required + flags |= ObjectTypePropertyFlags.Required } let primaryIdentifiers = record.schema.primaryIdentifier if (primaryIdentifiers && primaryIdentifiers.includes(`/properties/${name}`)) { - flags |= ObjectPropertyFlags.Identifier + flags |= ObjectTypePropertyFlags.Identifier } - properties[name] = new ObjectProperty(type, flags, propertySchema.description) + properties[name] = {type: type, flags: flags, description: propertySchema.description} }) } if (typeName) { - return factory.defineType(typeName, new ObjectType( + const existing = context.definitions[typeName] + if (existing) { + const type: ObjectType = { + type: TypeBaseKind.ObjectType, + name: typeName, + properties: properties, + additionalProperties: visitAdditionalProperties(context, factory, record, schema), + sensitive: undefined, + } + factory.types[existing.index]= type as ObjectType + return existing.TypeReference + } + return factory.addObjectType( typeName, properties, - visitAdditionalProperties(context, factory, record, schema))) + visitAdditionalProperties(context, factory, record, schema)) } else { - return factory.addType(new ObjectType( + return factory.addObjectType( context.toString(), properties, - visitAdditionalProperties(context, factory, record, schema))) + visitAdditionalProperties(context, factory, record, schema)) } } else { throw new Error(`unknown type ${type} ${context}`) @@ -320,7 +340,7 @@ function visitSchema(context: Context, factory: TypeFactory, record: SchemaRecor return createType(schema.type as string) } else if (schema.type instanceof Array) { const types = schema.type.map(createType) - return factory.addType(new UnionType(types)) + return factory.addUnionType(types) } else { throw new Error(`unknown type ${schema.type} ${context}`) } @@ -328,7 +348,7 @@ function visitSchema(context: Context, factory: TypeFactory, record: SchemaRecor function visitAdditionalProperties(context: Context, factory: TypeFactory, record: SchemaRecord, schema: SchemaDefinition): TypeReference | undefined { if (schema.additionalProperties instanceof boolean && schema.additionalProperties) { - return factory.lookupBuiltInType(BuiltInTypeKind.Any) + return factory.addAnyType() } else if (schema.additionalProperties instanceof boolean) { return undefined } else if (schema.additionalProperties instanceof Object) { diff --git a/src/aws-type-generator/src/lib/README.md b/src/aws-type-generator/src/lib/README.md deleted file mode 100644 index 5320a5ae..00000000 --- a/src/aws-type-generator/src/lib/README.md +++ /dev/null @@ -1,3 +0,0 @@ -# Lib - -The code in this folder was copied from azure/bicep-types-az and should be converted to shared code eventually. We don't need to maintain a separate copy, and once an NPM package is available we will consume it. \ No newline at end of file diff --git a/src/aws-type-generator/src/lib/index.ts b/src/aws-type-generator/src/lib/index.ts deleted file mode 100644 index 3362c8ad..00000000 --- a/src/aws-type-generator/src/lib/index.ts +++ /dev/null @@ -1,125 +0,0 @@ -import os from 'os'; -import path from 'path'; -import { readdir, stat, rmdir, mkdir, rm, writeFile, readFile, copyFile } from 'fs/promises'; -import { groupBy, keys, orderBy, sortBy, Dictionary } from 'lodash'; -import { TypeBaseKind } from './types'; - -interface TypeIndex { - Resources: Dictionary; - } - - interface TypeIndexEntry { - RelativePath: string; - Index: number; - } - -export async function buildTypeIndex(baseDir: string) { - const indexContent = await buildIndex(baseDir); - - await writeFile( - `${baseDir}/index.json`, - JSON.stringify(indexContent, null, 0)); - - await writeFile( - `${baseDir}/index.md`, - generateIndexMarkdown(indexContent)); -} - -function generateIndexMarkdown(index: TypeIndex) { - let markdown = '# Bicep Types\n'; - - const byProvider = groupBy(keys(index.Resources), x => x.split('/')[0].toLowerCase()); - for (const namespace of sortBy(keys(byProvider), x => x.toLowerCase())) { - markdown += `## ${namespace}\n`; - - const byResourceType = groupBy(byProvider[namespace], x => x.split('@')[0].toLowerCase()); - for (const resourceType of sortBy(keys(byResourceType), x => x.toLowerCase())) { - markdown += `### ${resourceType}\n`; - - for (const typeString of sortBy(byResourceType[resourceType], x => x.toLowerCase())) { - const version = typeString.split('@')[1]; - const jsonPath = index.Resources[typeString].RelativePath; - const anchor = `resource-${typeString.replace(/[^a-zA-Z0-9-]/g, '').toLowerCase()}` - - markdown += `* [${version}](${path.dirname(jsonPath)}/types.md#${anchor})\n`; - } - - markdown += '\n'; - } - } - - return markdown; - } - -async function buildIndex(baseDir: string): Promise { - const typeFiles = await findRecursive(baseDir, filePath => { - return path.basename(filePath) === 'types.json'; - }); - - const resourceTypes = new Set(); - const typeDictionary: Dictionary = {}; - - // Use a consistent sort order so that file system differences don't generate changes - for (const typeFilePath of orderBy(typeFiles, f => f.toLowerCase(), 'asc')) { - const content = await readFile(typeFilePath, { encoding: 'utf8' }); - - const types = JSON.parse(content) as any[]; - for (const type of types) { - const resource = type[TypeBaseKind.ResourceType]; - if (!resource) { - continue; - } - - if (resourceTypes.has(resource.Name.toLowerCase())) { - console.warn(`WARNING: Found duplicate type \"${resource.Name}\"`); - continue; - } - resourceTypes.add(resource.Name.toLowerCase()); - - typeDictionary[resource.Name] = { - RelativePath: path.relative(baseDir, typeFilePath), - Index: types.indexOf(type), - }; - } - } - - return { - Resources: typeDictionary, - } -} - -async function copyRecursive(sourceBasePath: string, destinationBasePath: string): Promise { - for (const filePath of await findRecursive(sourceBasePath, _ => true)) { - const destinationPath = path.join(destinationBasePath, path.relative(sourceBasePath, filePath)); - - await mkdir(path.dirname(destinationPath), { recursive: true }); - await copyFile(filePath, destinationPath); - } - } - - async function findRecursive(basePath: string, filter: (name: string) => boolean): Promise { - let results: string[] = []; - - for (const subPathName of await readdir(basePath)) { - const subPath = path.resolve(`${basePath}/${subPathName}`); - - const fileStat = await stat(subPath); - if (fileStat.isDirectory()) { - const pathResults = await findRecursive(subPath, filter); - results = results.concat(pathResults); - continue; - } - - if (!fileStat.isFile()) { - continue; - } - - if (!filter(subPath)) { - continue; - } - - results.push(subPath); - } - - return results; - } \ No newline at end of file diff --git a/src/aws-type-generator/src/lib/types.ts b/src/aws-type-generator/src/lib/types.ts deleted file mode 100644 index 088e982c..00000000 --- a/src/aws-type-generator/src/lib/types.ts +++ /dev/null @@ -1,274 +0,0 @@ -import { Dictionary } from "lodash"; - -export enum BuiltInTypeKind { - Any = 1, - Null = 2, - Bool = 3, - Int = 4, - String = 5, - Object = 6, - Array = 7, - ResourceRef = 8, -} - -const BuiltInTypeKindLabel = new Map([ - [BuiltInTypeKind.Any, 'Any'], - [BuiltInTypeKind.Null, 'Null'], - [BuiltInTypeKind.Bool, 'Bool'], - [BuiltInTypeKind.Int, 'Int'], - [BuiltInTypeKind.String, 'String'], - [BuiltInTypeKind.Object, 'Object'], - [BuiltInTypeKind.Array, 'Array'], - [BuiltInTypeKind.ResourceRef, 'ResourceRef'], -]); - -export function getBuiltInTypeKindLabel(input: BuiltInTypeKind) { - return BuiltInTypeKindLabel.get(input) ?? ''; -} - -export enum ScopeType { - Unknown = 0, - Tenant = 1 << 0, - ManagementGroup = 1 << 1, - Subscription = 1 << 2, - ResourceGroup = 1 << 3, - Extension = 1 << 4, -} - -const ScopeTypeLabel = new Map([ - [ScopeType.Tenant, 'Tenant'], - [ScopeType.ManagementGroup, 'ManagementGroup'], - [ScopeType.Subscription, 'Subscription'], - [ScopeType.ResourceGroup, 'ResourceGroup'], - [ScopeType.Extension, 'Extension'], -]); - -export function getScopeTypeLabels(input: ScopeType) { - const types = []; - for (const [key, value] of ScopeTypeLabel) { - if ((key & input) === key) { - types.push(value); - } - } - - return types -} - -export enum ObjectPropertyFlags { - None = 0, - Required = 1 << 0, - ReadOnly = 1 << 1, - WriteOnly = 1 << 2, - DeployTimeConstant = 1 << 3, - Identifier = 1 << 4, -} - -const ObjectPropertyFlagsLabel = new Map([ - [ObjectPropertyFlags.Required, 'Required'], - [ObjectPropertyFlags.ReadOnly, 'ReadOnly'], - [ObjectPropertyFlags.WriteOnly, 'WriteOnly'], - [ObjectPropertyFlags.DeployTimeConstant, 'DeployTimeConstant'], - [ObjectPropertyFlags.Identifier, 'Identifier'] -]); - -export function getObjectPropertyFlagsLabels(input: ObjectPropertyFlags) { - const types = []; - for (const [key, value] of ObjectPropertyFlagsLabel) { - if ((key & input) === key) { - types.push(value); - } - } - - return types; -} - -export enum TypeBaseKind { - BuiltInType = 1, - ObjectType = 2, - ArrayType = 3, - ResourceType = 4, - UnionType = 5, - StringLiteralType = 6, - DiscriminatedObjectType = 7, -} - -const TypeBaseKindLabel = new Map([ - [TypeBaseKind.BuiltInType, 'BuiltInType'], - [TypeBaseKind.ObjectType, 'ObjectType'], - [TypeBaseKind.ArrayType, 'ArrayType'], - [TypeBaseKind.ResourceType, 'ResourceType'], - [TypeBaseKind.UnionType, 'UnionType'], - [TypeBaseKind.StringLiteralType, 'StringLiteralType'], - [TypeBaseKind.DiscriminatedObjectType, 'DiscriminatedObjectType'], -]); - -export function getTypeBaseKindLabel(input: TypeBaseKind) { - return TypeBaseKindLabel.get(input) ?? ''; -} - -export abstract class TypeBase { - constructor(type: TypeBaseKind) { - this.Type = type; - } - readonly Type: TypeBaseKind; -} - -export class TypeReference { - constructor(index: number) { - this.Index = index; - } - readonly Index: number; -} - -export class BuiltInType extends TypeBase { - constructor(kind: BuiltInTypeKind) { - super(TypeBaseKind.BuiltInType); - this.Kind = kind; - } - readonly Kind: BuiltInTypeKind; -} - -export class UnionType extends TypeBase { - constructor(elements: TypeReference[]) { - super(TypeBaseKind.UnionType); - this.Elements = elements; - } - readonly Elements: TypeReference[]; -} - -export class StringLiteralType extends TypeBase { - constructor(value: string) { - super(TypeBaseKind.StringLiteralType); - this.Value = value; - } - readonly Value: string; -} - -export class ResourceType extends TypeBase { - constructor(name: string, scopeType: ScopeType, body: TypeReference) { - super(TypeBaseKind.ResourceType); - this.Name = name; - this.ScopeType = scopeType; - this.Body = body; - } - readonly Name: string; - readonly ScopeType: ScopeType; - readonly Body: TypeReference; -} - -export class ObjectType extends TypeBase { - constructor(name: string, properties: Dictionary, additionalProperties?: TypeReference) { - super(TypeBaseKind.ObjectType); - this.Name = name; - this.Properties = properties; - this.AdditionalProperties = additionalProperties; - } - readonly Name: string; - readonly Properties: Dictionary; - readonly AdditionalProperties?: TypeReference; -} - -export class DiscriminatedObjectType extends TypeBase { - constructor(name: string, discriminator: string, baseProperties: Dictionary, elements: Dictionary) { - super(TypeBaseKind.DiscriminatedObjectType); - this.Name = name; - this.Discriminator = discriminator; - this.BaseProperties = baseProperties; - this.Elements = elements; - } - readonly Name: string; - readonly Discriminator: string; - readonly BaseProperties: Dictionary; - readonly Elements: Dictionary; -} - -export class ArrayType extends TypeBase { - constructor(itemType: TypeReference) { - super(TypeBaseKind.ArrayType); - this.ItemType = itemType; - } - readonly ItemType: TypeReference; -} - -export class ObjectProperty { - constructor(type: TypeReference, flags: ObjectPropertyFlags, description?: string) { - if (!type) { - throw new Error("error") - } - this.Type = type; - this.Flags = flags; - this.Description = description; - } - readonly Type: TypeReference; - Flags: ObjectPropertyFlags; - readonly Description?: string; -} - -export class LazyType extends TypeBase { - constructor(name: string) { - super(TypeBaseKind.ObjectType) - this.Name = name - } - - readonly Name: string -} - -export class TypeFactory { - private readonly types: TypeBase[]; - private readonly namedTypes: { [key: string]: TypeReference } - private readonly builtInTypes: Record; - - constructor() { - this.types = []; - this.namedTypes = {}; - this.builtInTypes = { - [BuiltInTypeKind.Any]: this.addType(new BuiltInType(BuiltInTypeKind.Any)), - [BuiltInTypeKind.Null]: this.addType(new BuiltInType(BuiltInTypeKind.Null)), - [BuiltInTypeKind.Bool]: this.addType(new BuiltInType(BuiltInTypeKind.Bool)), - [BuiltInTypeKind.Int]: this.addType(new BuiltInType(BuiltInTypeKind.Int)), - [BuiltInTypeKind.String]: this.addType(new BuiltInType(BuiltInTypeKind.String)), - [BuiltInTypeKind.Object]: this.addType(new BuiltInType(BuiltInTypeKind.Object)), - [BuiltInTypeKind.Array]: this.addType(new BuiltInType(BuiltInTypeKind.Array)), - [BuiltInTypeKind.ResourceRef]: this.addType(new BuiltInType(BuiltInTypeKind.ResourceRef)), - }; - } - - public getTypes(): TypeBase[] { - return this.types.map(v => v); // Defensive copy - } - - public getNamedType(name: string): TypeReference | undefined { - return this.namedTypes[name]; - } - - public addType(type: TType): TypeReference { - const index = this.types.length; - this.types[index] = type; - - return new TypeReference(index); - } - - public declareType(name: string): TypeReference { - const reference = this.addType(new LazyType(name)) - this.namedTypes[name] = reference - return reference - } - - public defineType(name: string, type: TType): TypeReference { - const reference = this.namedTypes[name] - if (!reference) { - throw new Error(`could not find named type ${name}`) - } - - this.types[reference.Index] = type - return reference - } - - public lookupType(reference: TypeReference): TType { - return this.types[reference.Index] as TType; - } - - public lookupBuiltInType(kind: BuiltInTypeKind): TypeReference { - return this.builtInTypes[kind]; - } -} \ No newline at end of file diff --git a/src/aws-type-generator/src/lib/writers/json.ts b/src/aws-type-generator/src/lib/writers/json.ts deleted file mode 100644 index d6756618..00000000 --- a/src/aws-type-generator/src/lib/writers/json.ts +++ /dev/null @@ -1,21 +0,0 @@ -import { TypeBase, TypeReference } from '../types'; - -export function writeJson(types: TypeBase[]) { - return JSON.stringify(types, replacer, 0); -} - -function replacer(this: any, key: string, value: any) { - if (value instanceof TypeReference) { - return value.Index; - } - - if (value instanceof TypeBase) { - const { Type, ...rest } = value; - - return { - [Type]: rest, - }; - } - - return value; -} \ No newline at end of file diff --git a/src/aws-type-generator/src/lib/writers/markdown.ts b/src/aws-type-generator/src/lib/writers/markdown.ts deleted file mode 100644 index e33ec566..00000000 --- a/src/aws-type-generator/src/lib/writers/markdown.ts +++ /dev/null @@ -1,176 +0,0 @@ -import { Dictionary, keys, orderBy } from 'lodash'; -import { ArrayType, BuiltInType, DiscriminatedObjectType, getBuiltInTypeKindLabel, getObjectPropertyFlagsLabels, getScopeTypeLabels, ObjectProperty, ObjectType, ResourceType, StringLiteralType, TypeBase, TypeBaseKind, TypeReference, UnionType } from '../types'; - -export function writeMarkdown(provider: string, apiVersion: string, types: TypeBase[]) { - let output = ''; - - function getTypeName(types: TypeBase[], typeReference: TypeReference): string { - const type = types[typeReference.Index]; - switch (type.Type) { - case TypeBaseKind.BuiltInType: - return getBuiltInTypeKindLabel((type as BuiltInType).Kind).toLowerCase(); - case TypeBaseKind.ObjectType: - return generateAnchorLink((type as ObjectType).Name); - case TypeBaseKind.ArrayType: - return `${getTypeName(types, (type as ArrayType).ItemType)}[]`; - case TypeBaseKind.ResourceType: - return (type as ResourceType).Name; - case TypeBaseKind.UnionType: - const elements = (type as UnionType).Elements.map(x => getTypeName(types, x)); - return elements.sort().join(' | '); - case TypeBaseKind.StringLiteralType: - return `'${(type as StringLiteralType).Value}'`; - case TypeBaseKind.DiscriminatedObjectType: - return generateAnchorLink((type as DiscriminatedObjectType).Name); - default: - throw `Unrecognized type`; - } - } - - function generateAnchorLink(name: string) { - return `[${name}](#${name.replace(/[^a-zA-Z0-9-]/g, '').toLowerCase()})`; - } - - function writeTypeProperty(types: TypeBase[], name: string, property: ObjectProperty) { - const flagsString = property.Flags ? ` (${getObjectPropertyFlagsLabels(property.Flags).join(', ')})` : ''; - const descriptionString = property.Description ? `: ${property.Description}` : ''; - writeBullet(name, `${getTypeName(types, property.Type)}${flagsString}${descriptionString}`); - } - - function writeHeading(nesting: number, message: string) { - output += `${'#'.repeat(nesting)} ${message}`; - writeNewLine(); - } - - function writeBullet(key: string, value: string) { - output += `* **${key}**: ${value}`; - writeNewLine(); - } - - function writeNewLine() { - output += '\n'; - } - - function findTypesToWrite(types: TypeBase[], typesToWrite: TypeBase[], typeReference: TypeReference) { - function processTypeLinks(typeReference: TypeReference, skipParent: boolean) { - // this is needed to avoid circular type references causing stack overflows - if (typesToWrite.indexOf(types[typeReference.Index]) === -1) { - if (!skipParent) { - typesToWrite.push(types[typeReference.Index]); - } - - findTypesToWrite(types, typesToWrite, typeReference); - } - } - - const type = types[typeReference.Index]; - switch (type.Type) { - case TypeBaseKind.ArrayType: - const arrayType = type as ArrayType; - processTypeLinks(arrayType.ItemType, false); - - return; - case TypeBaseKind.ObjectType: - const objectType = type as ObjectType; - - for (const key of sortedKeys(objectType.Properties)) { - processTypeLinks(objectType.Properties[key].Type, false); - } - - if (objectType.AdditionalProperties) { - processTypeLinks(objectType.AdditionalProperties, false); - } - - return; - case TypeBaseKind.DiscriminatedObjectType: - const discriminatedObjectType = type as DiscriminatedObjectType; - - for (const key of sortedKeys(discriminatedObjectType.BaseProperties)) { - processTypeLinks(discriminatedObjectType.BaseProperties[key].Type, false); - } - - for (const key of sortedKeys(discriminatedObjectType.Elements)) { - const element = discriminatedObjectType.Elements[key]; - // Don't display discriminated object elements as individual types - processTypeLinks(element, true); - } - - return; - } - } - - function sortedKeys(dictionary: Dictionary) { - return orderBy(keys(dictionary), k => k.toLowerCase(), 'asc'); - } - - function writeComplexType(types: TypeBase[], type: TypeBase, nesting: number, includeHeader: boolean) { - switch (type.Type) { - case TypeBaseKind.ResourceType: - const resourceType = type as ResourceType; - writeHeading(nesting, `Resource ${resourceType.Name}`); - writeBullet("Valid Scope(s)", `${getScopeTypeLabels(resourceType.ScopeType).join(', ') || 'Unknown'}`); - writeComplexType(types, types[resourceType.Body.Index], nesting, false); - - return; - case TypeBaseKind.ObjectType: - const objectType = type as ObjectType; - if (includeHeader) { - writeHeading(nesting, objectType.Name); - } - - writeHeading(nesting + 1, "Properties"); - for (const key of sortedKeys(objectType.Properties)) { - writeTypeProperty(types, key, objectType.Properties[key]); - } - - if (objectType.AdditionalProperties) { - writeHeading(nesting + 1, "Additional Properties"); - writeBullet("Additional Properties Type", getTypeName(types, objectType.AdditionalProperties)); - } - - writeNewLine(); - return; - case TypeBaseKind.DiscriminatedObjectType: - const discriminatedObjectType = type as DiscriminatedObjectType; - if (includeHeader) { - writeHeading(nesting, discriminatedObjectType.Name); - } - - writeBullet("Discriminator", discriminatedObjectType.Discriminator); - writeNewLine(); - - writeHeading(nesting + 1, "Base Properties"); - for (const propertyName of sortedKeys(discriminatedObjectType.BaseProperties)) { - writeTypeProperty(types, propertyName, discriminatedObjectType.BaseProperties[propertyName]); - } - - for (const key of sortedKeys(discriminatedObjectType.Elements)) { - const element = discriminatedObjectType.Elements[key]; - writeComplexType(types, types[element.Index], nesting + 1, true); - } - - writeNewLine(); - return; - } - } - - function generateMarkdown(provider: string, apiVersion: string, types: TypeBase[]) { - writeHeading(1, `${provider} @ ${apiVersion}`); - writeNewLine(); - - const resourceTypes = orderBy(types.filter(t => t instanceof ResourceType) as ResourceType[], x => x.Name.split('@')[0].toLowerCase()); - const typesToWrite = [...resourceTypes]; - - for (const resourceType of resourceTypes) { - findTypesToWrite(types, typesToWrite, resourceType.Body); - } - - for (const type of typesToWrite) { - writeComplexType(types, type, 2, true); - } - - return output; - } - - return generateMarkdown(provider, apiVersion, types); -} \ No newline at end of file diff --git a/src/aws-type-generator/src/main.ts b/src/aws-type-generator/src/main.ts index e6bfb430..e555ac94 100644 --- a/src/aws-type-generator/src/main.ts +++ b/src/aws-type-generator/src/main.ts @@ -1,20 +1,24 @@ import yargs from 'yargs/yargs'; import path from "path"; import fs from "fs"; -import { writeJson } from "./lib/writers/json"; -import { writeMarkdown } from "./lib/writers/markdown"; +import { writeTypesJson } from "bicep-types"; +import { writeMarkdown } from "bicep-types"; import { SchemaRecord } from "./schemarecord"; import { convertSchemaRecordToTypes } from "./convert"; -import { buildTypeIndex } from "./lib"; +import { logOut, ILogger, defaultLogger, findRecursive } from './utils'; +import { writeFile, readFile } from 'fs/promises'; +import { TypeFile, buildIndex, readTypesJson, writeIndexJson, writeIndexMarkdown, TypeSettings } from 'bicep-types'; const parser = yargs(process.argv.slice(2)).options({ input: { type: 'string', demandOption: true }, output: { type: 'string', demandOption: true }, + releaseVersion: { type: 'string', default: 'latest' } }).argv; interface Args { input: string output: string + releaseVersion: string } async function main() { @@ -50,13 +54,13 @@ async function main() { fs.mkdirSync(outFolder, { recursive: true }) // write types.json - fs.writeFileSync(`${outFolder}/types.json`, writeJson(definition.types)) + fs.writeFileSync(`${outFolder}/types.json`, writeTypesJson(definition.types)) // writer types.md - fs.writeFileSync(`${outFolder}/types.md`, writeMarkdown(definition.namespace, definition.apiVersion, definition.types)) + fs.writeFileSync(`${outFolder}/types.md`, writeMarkdown(definition.types, `${definition.namespace} @ ${definition.apiVersion}`)) }) - await buildTypeIndex(argv.output) + await buildTypeIndex(defaultLogger, argv.output, argv.releaseVersion) console.info(`generator took ${Date.now() - start}ms`); } catch (err) { @@ -73,4 +77,23 @@ const groupBy = (list: T[], getKey: (item: T) => K, g return previous; }, {} as Record); +async function buildTypeIndex(logger: ILogger, baseDir: string, version: string) { + const typesPaths = await findRecursive(baseDir, filePath => { + return path.basename(filePath) === 'types.json'; + }); + + const typeFiles: TypeFile[] = []; + for (const typePath of typesPaths) { + const content = await readFile(typePath, { encoding: 'utf8' }); + typeFiles.push({ + relativePath: path.relative(baseDir, typePath), + types: readTypesJson(content), + }); + } + const indexContent = await buildIndex(typeFiles, log => logOut(logger, log), {name: "AWS", version: (version == "edge" ? "latest" : version), isSingleton: false} as TypeSettings); + + await writeFile(`${baseDir}/index.json`, writeIndexJson(indexContent)); + await writeFile(`${baseDir}/index.md`, writeIndexMarkdown(indexContent)); +} + main() \ No newline at end of file diff --git a/src/aws-type-generator/src/schemarecord.ts b/src/aws-type-generator/src/schemarecord.ts index d1c24b6b..7e6743cf 100644 --- a/src/aws-type-generator/src/schemarecord.ts +++ b/src/aws-type-generator/src/schemarecord.ts @@ -1,3 +1,5 @@ +import { TypeReference } from "bicep-types" + // Based on: https://github.com/aws-cloudformation/cloudformation-cli/blob/master/src/rpdk/core/data/schema/provider.definition.schema.v1.json export interface SchemaRecord { arn: string @@ -35,24 +37,31 @@ export interface SchemaDefinition { export type TypeName = 'boolean' | 'number' | 'integer' | 'string' | 'object' | 'array' | 'null' +export interface IndexReference { + index: number + TypeReference: TypeReference +} + export class Context { parts: string[] + definitions: {[name: string] : IndexReference} readonly base: string[] - constructor(base: string[]) { + constructor(base: string[], definitions: {[name: string] : IndexReference}) { this.parts = base.slice() this.base = base.slice() + this.definitions = definitions } public push(part: string): Context { - const c = new Context(this.base) + const c = new Context(this.base, this.definitions) c.parts = this.parts.slice() c.parts.push(part) return c } public create(part: string): Context { - const c = new Context(this.base) + const c = new Context(this.base, this.definitions) c.parts.push(part) return c } diff --git a/src/aws-type-generator/src/utils.ts b/src/aws-type-generator/src/utils.ts new file mode 100644 index 00000000..2314bcb7 --- /dev/null +++ b/src/aws-type-generator/src/utils.ts @@ -0,0 +1,55 @@ +// ------------------------------------------------------------- +// Copyright 2023 The Radius Authors. +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// http://www.apache.org/licenses/LICENSE-2.0 +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// ------------------------------------------------------------. +import path from 'path'; +import { readdir, stat } from 'fs/promises'; + +export interface ILogger { + out: (data: string) => void; + err: (data: string) => void; +} + +export const defaultLogger: ILogger = { + out: data => process.stdout.write(data), + err: data => process.stderr.write(data), +} + +export async function findRecursive(basePath: string, filter: (name: string) => boolean): Promise { + let results: string[] = []; + + for (const subPathName of await readdir(basePath)) { + const subPath = path.resolve(`${basePath}/${subPathName}`); + + const fileStat = await stat(subPath); + if (fileStat.isDirectory()) { + const pathResults = await findRecursive(subPath, filter); + results = results.concat(pathResults); + continue; + } + + if (!fileStat.isFile()) { + continue; + } + + if (!filter(subPath)) { + continue; + } + + results.push(subPath); + } + + return results; +} + +export function logOut(logger: ILogger, line: string) { + logger.out(`${line}\n`); +} \ No newline at end of file